VirtualBox

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

Last change on this file since 97018 was 97018, checked in by vboxsync, 2 years ago

VMM/IEMAllCImplVmxInstr.cpp: Converted all VMVEXITINFO initialization to use initializers (via macros) and not call memset/RT_ZERO. Code size reduced a bit in this file.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 237.5 KB
Line 
1/** @file
2 * HM - VMX Structures and Definitions. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2022 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef VBOX_INCLUDED_vmm_hm_vmx_h
37#define VBOX_INCLUDED_vmm_hm_vmx_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <VBox/types.h>
43#include <iprt/x86.h>
44#include <iprt/assertcompile.h>
45
46
47/** @defgroup grp_hm_vmx VMX Types and Definitions
48 * @ingroup grp_hm
49 * @{
50 */
51
52/** @name Host-state MSR lazy-restoration flags.
53 * @{
54 */
55/** The host MSRs have been saved. */
56#define VMX_LAZY_MSRS_SAVED_HOST RT_BIT(0)
57/** The guest MSRs are loaded and in effect. */
58#define VMX_LAZY_MSRS_LOADED_GUEST RT_BIT(1)
59/** @} */
60
61/** @name VMX HM-error codes for VERR_HM_UNSUPPORTED_CPU_FEATURE_COMBO.
62 * UFC = Unsupported Feature Combination.
63 * @{
64 */
65/** Unsupported pin-based VM-execution controls combo. */
66#define VMX_UFC_CTRL_PIN_EXEC 1
67/** Unsupported processor-based VM-execution controls combo. */
68#define VMX_UFC_CTRL_PROC_EXEC 2
69/** Unsupported move debug register VM-exit combo. */
70#define VMX_UFC_CTRL_PROC_MOV_DRX_EXIT 3
71/** Unsupported VM-entry controls combo. */
72#define VMX_UFC_CTRL_ENTRY 4
73/** Unsupported VM-exit controls combo. */
74#define VMX_UFC_CTRL_EXIT 5
75/** MSR storage capacity of the VMCS autoload/store area is not sufficient
76 * for storing host MSRs. */
77#define VMX_UFC_INSUFFICIENT_HOST_MSR_STORAGE 6
78/** MSR storage capacity of the VMCS autoload/store area is not sufficient
79 * for storing guest MSRs. */
80#define VMX_UFC_INSUFFICIENT_GUEST_MSR_STORAGE 7
81/** Invalid VMCS size. */
82#define VMX_UFC_INVALID_VMCS_SIZE 8
83/** Unsupported secondary processor-based VM-execution controls combo. */
84#define VMX_UFC_CTRL_PROC_EXEC2 9
85/** Invalid unrestricted-guest execution controls combo. */
86#define VMX_UFC_INVALID_UX_COMBO 10
87/** EPT flush type not supported. */
88#define VMX_UFC_EPT_FLUSH_TYPE_UNSUPPORTED 11
89/** EPT paging structure memory type is not write-back. */
90#define VMX_UFC_EPT_MEM_TYPE_NOT_WB 12
91/** EPT requires INVEPT instr. support but it's not available. */
92#define VMX_UFC_EPT_INVEPT_UNAVAILABLE 13
93/** EPT requires page-walk length of 4. */
94#define VMX_UFC_EPT_PAGE_WALK_LENGTH_UNSUPPORTED 14
95/** VMX VMWRITE all feature exposed to the guest but not supported on host. */
96#define VMX_UFC_GST_HOST_VMWRITE_ALL 15
97/** LBR stack size cannot be determined for the current CPU. */
98#define VMX_UFC_LBR_STACK_SIZE_UNKNOWN 16
99/** LBR stack size of the CPU exceeds our buffer size. */
100#define VMX_UFC_LBR_STACK_SIZE_OVERFLOW 17
101/** @} */
102
103/** @name VMX HM-error codes for VERR_VMX_VMCS_FIELD_CACHE_INVALID.
104 * VCI = VMCS-field Cache Invalid.
105 * @{
106 */
107/** Cache of VM-entry controls invalid. */
108#define VMX_VCI_CTRL_ENTRY 300
109/** Cache of VM-exit controls invalid. */
110#define VMX_VCI_CTRL_EXIT 301
111/** Cache of pin-based VM-execution controls invalid. */
112#define VMX_VCI_CTRL_PIN_EXEC 302
113/** Cache of processor-based VM-execution controls invalid. */
114#define VMX_VCI_CTRL_PROC_EXEC 303
115/** Cache of secondary processor-based VM-execution controls invalid. */
116#define VMX_VCI_CTRL_PROC_EXEC2 304
117/** Cache of exception bitmap invalid. */
118#define VMX_VCI_CTRL_XCPT_BITMAP 305
119/** Cache of TSC offset invalid. */
120#define VMX_VCI_CTRL_TSC_OFFSET 306
121/** Cache of tertiary processor-based VM-execution controls invalid. */
122#define VMX_VCI_CTRL_PROC_EXEC3 307
123/** @} */
124
125/** @name VMX HM-error codes for VERR_VMX_INVALID_GUEST_STATE.
126 * IGS = Invalid Guest State.
127 * @{
128 */
129/** An error occurred while checking invalid-guest-state. */
130#define VMX_IGS_ERROR 500
131/** The invalid guest-state checks did not find any reason why. */
132#define VMX_IGS_REASON_NOT_FOUND 501
133/** CR0 fixed1 bits invalid. */
134#define VMX_IGS_CR0_FIXED1 502
135/** CR0 fixed0 bits invalid. */
136#define VMX_IGS_CR0_FIXED0 503
137/** CR0.PE and CR0.PE invalid VT-x/host combination. */
138#define VMX_IGS_CR0_PG_PE_COMBO 504
139/** CR4 fixed1 bits invalid. */
140#define VMX_IGS_CR4_FIXED1 505
141/** CR4 fixed0 bits invalid. */
142#define VMX_IGS_CR4_FIXED0 506
143/** Reserved bits in VMCS' DEBUGCTL MSR field not set to 0 when
144 * VMX_VMCS_CTRL_ENTRY_LOAD_DEBUG is used. */
145#define VMX_IGS_DEBUGCTL_MSR_RESERVED 507
146/** CR0.PG not set for long-mode when not using unrestricted guest. */
147#define VMX_IGS_CR0_PG_LONGMODE 508
148/** CR4.PAE not set for long-mode guest when not using unrestricted guest. */
149#define VMX_IGS_CR4_PAE_LONGMODE 509
150/** CR4.PCIDE set for 32-bit guest. */
151#define VMX_IGS_CR4_PCIDE 510
152/** VMCS' DR7 reserved bits not set to 0. */
153#define VMX_IGS_DR7_RESERVED 511
154/** VMCS' PERF_GLOBAL MSR reserved bits not set to 0. */
155#define VMX_IGS_PERF_GLOBAL_MSR_RESERVED 512
156/** VMCS' EFER MSR reserved bits not set to 0. */
157#define VMX_IGS_EFER_MSR_RESERVED 513
158/** VMCS' EFER MSR.LMA does not match the IA32e mode guest control. */
159#define VMX_IGS_EFER_LMA_GUEST_MODE_MISMATCH 514
160/** VMCS' EFER MSR.LMA does not match EFER.LME of the guest when using paging
161 * without unrestricted guest. */
162#define VMX_IGS_EFER_LMA_LME_MISMATCH 515
163/** CS.Attr.P bit invalid. */
164#define VMX_IGS_CS_ATTR_P_INVALID 516
165/** CS.Attr reserved bits not set to 0. */
166#define VMX_IGS_CS_ATTR_RESERVED 517
167/** CS.Attr.G bit invalid. */
168#define VMX_IGS_CS_ATTR_G_INVALID 518
169/** CS is unusable. */
170#define VMX_IGS_CS_ATTR_UNUSABLE 519
171/** CS and SS DPL unequal. */
172#define VMX_IGS_CS_SS_ATTR_DPL_UNEQUAL 520
173/** CS and SS DPL mismatch. */
174#define VMX_IGS_CS_SS_ATTR_DPL_MISMATCH 521
175/** CS Attr.Type invalid. */
176#define VMX_IGS_CS_ATTR_TYPE_INVALID 522
177/** CS and SS RPL unequal. */
178#define VMX_IGS_SS_CS_RPL_UNEQUAL 523
179/** SS.Attr.DPL and SS RPL unequal. */
180#define VMX_IGS_SS_ATTR_DPL_RPL_UNEQUAL 524
181/** SS.Attr.DPL invalid for segment type. */
182#define VMX_IGS_SS_ATTR_DPL_INVALID 525
183/** SS.Attr.Type invalid. */
184#define VMX_IGS_SS_ATTR_TYPE_INVALID 526
185/** SS.Attr.P bit invalid. */
186#define VMX_IGS_SS_ATTR_P_INVALID 527
187/** SS.Attr reserved bits not set to 0. */
188#define VMX_IGS_SS_ATTR_RESERVED 528
189/** SS.Attr.G bit invalid. */
190#define VMX_IGS_SS_ATTR_G_INVALID 529
191/** DS.Attr.A bit invalid. */
192#define VMX_IGS_DS_ATTR_A_INVALID 530
193/** DS.Attr.P bit invalid. */
194#define VMX_IGS_DS_ATTR_P_INVALID 531
195/** DS.Attr.DPL and DS RPL unequal. */
196#define VMX_IGS_DS_ATTR_DPL_RPL_UNEQUAL 532
197/** DS.Attr reserved bits not set to 0. */
198#define VMX_IGS_DS_ATTR_RESERVED 533
199/** DS.Attr.G bit invalid. */
200#define VMX_IGS_DS_ATTR_G_INVALID 534
201/** DS.Attr.Type invalid. */
202#define VMX_IGS_DS_ATTR_TYPE_INVALID 535
203/** ES.Attr.A bit invalid. */
204#define VMX_IGS_ES_ATTR_A_INVALID 536
205/** ES.Attr.P bit invalid. */
206#define VMX_IGS_ES_ATTR_P_INVALID 537
207/** ES.Attr.DPL and DS RPL unequal. */
208#define VMX_IGS_ES_ATTR_DPL_RPL_UNEQUAL 538
209/** ES.Attr reserved bits not set to 0. */
210#define VMX_IGS_ES_ATTR_RESERVED 539
211/** ES.Attr.G bit invalid. */
212#define VMX_IGS_ES_ATTR_G_INVALID 540
213/** ES.Attr.Type invalid. */
214#define VMX_IGS_ES_ATTR_TYPE_INVALID 541
215/** FS.Attr.A bit invalid. */
216#define VMX_IGS_FS_ATTR_A_INVALID 542
217/** FS.Attr.P bit invalid. */
218#define VMX_IGS_FS_ATTR_P_INVALID 543
219/** FS.Attr.DPL and DS RPL unequal. */
220#define VMX_IGS_FS_ATTR_DPL_RPL_UNEQUAL 544
221/** FS.Attr reserved bits not set to 0. */
222#define VMX_IGS_FS_ATTR_RESERVED 545
223/** FS.Attr.G bit invalid. */
224#define VMX_IGS_FS_ATTR_G_INVALID 546
225/** FS.Attr.Type invalid. */
226#define VMX_IGS_FS_ATTR_TYPE_INVALID 547
227/** GS.Attr.A bit invalid. */
228#define VMX_IGS_GS_ATTR_A_INVALID 548
229/** GS.Attr.P bit invalid. */
230#define VMX_IGS_GS_ATTR_P_INVALID 549
231/** GS.Attr.DPL and DS RPL unequal. */
232#define VMX_IGS_GS_ATTR_DPL_RPL_UNEQUAL 550
233/** GS.Attr reserved bits not set to 0. */
234#define VMX_IGS_GS_ATTR_RESERVED 551
235/** GS.Attr.G bit invalid. */
236#define VMX_IGS_GS_ATTR_G_INVALID 552
237/** GS.Attr.Type invalid. */
238#define VMX_IGS_GS_ATTR_TYPE_INVALID 553
239/** V86 mode CS.Base invalid. */
240#define VMX_IGS_V86_CS_BASE_INVALID 554
241/** V86 mode CS.Limit invalid. */
242#define VMX_IGS_V86_CS_LIMIT_INVALID 555
243/** V86 mode CS.Attr invalid. */
244#define VMX_IGS_V86_CS_ATTR_INVALID 556
245/** V86 mode SS.Base invalid. */
246#define VMX_IGS_V86_SS_BASE_INVALID 557
247/** V86 mode SS.Limit invalid. */
248#define VMX_IGS_V86_SS_LIMIT_INVALID 558
249/** V86 mode SS.Attr invalid. */
250#define VMX_IGS_V86_SS_ATTR_INVALID 559
251/** V86 mode DS.Base invalid. */
252#define VMX_IGS_V86_DS_BASE_INVALID 560
253/** V86 mode DS.Limit invalid. */
254#define VMX_IGS_V86_DS_LIMIT_INVALID 561
255/** V86 mode DS.Attr invalid. */
256#define VMX_IGS_V86_DS_ATTR_INVALID 562
257/** V86 mode ES.Base invalid. */
258#define VMX_IGS_V86_ES_BASE_INVALID 563
259/** V86 mode ES.Limit invalid. */
260#define VMX_IGS_V86_ES_LIMIT_INVALID 564
261/** V86 mode ES.Attr invalid. */
262#define VMX_IGS_V86_ES_ATTR_INVALID 565
263/** V86 mode FS.Base invalid. */
264#define VMX_IGS_V86_FS_BASE_INVALID 566
265/** V86 mode FS.Limit invalid. */
266#define VMX_IGS_V86_FS_LIMIT_INVALID 567
267/** V86 mode FS.Attr invalid. */
268#define VMX_IGS_V86_FS_ATTR_INVALID 568
269/** V86 mode GS.Base invalid. */
270#define VMX_IGS_V86_GS_BASE_INVALID 569
271/** V86 mode GS.Limit invalid. */
272#define VMX_IGS_V86_GS_LIMIT_INVALID 570
273/** V86 mode GS.Attr invalid. */
274#define VMX_IGS_V86_GS_ATTR_INVALID 571
275/** Longmode CS.Base invalid. */
276#define VMX_IGS_LONGMODE_CS_BASE_INVALID 572
277/** Longmode SS.Base invalid. */
278#define VMX_IGS_LONGMODE_SS_BASE_INVALID 573
279/** Longmode DS.Base invalid. */
280#define VMX_IGS_LONGMODE_DS_BASE_INVALID 574
281/** Longmode ES.Base invalid. */
282#define VMX_IGS_LONGMODE_ES_BASE_INVALID 575
283/** SYSENTER ESP is not canonical. */
284#define VMX_IGS_SYSENTER_ESP_NOT_CANONICAL 576
285/** SYSENTER EIP is not canonical. */
286#define VMX_IGS_SYSENTER_EIP_NOT_CANONICAL 577
287/** PAT MSR invalid. */
288#define VMX_IGS_PAT_MSR_INVALID 578
289/** PAT MSR reserved bits not set to 0. */
290#define VMX_IGS_PAT_MSR_RESERVED 579
291/** GDTR.Base is not canonical. */
292#define VMX_IGS_GDTR_BASE_NOT_CANONICAL 580
293/** IDTR.Base is not canonical. */
294#define VMX_IGS_IDTR_BASE_NOT_CANONICAL 581
295/** GDTR.Limit invalid. */
296#define VMX_IGS_GDTR_LIMIT_INVALID 582
297/** IDTR.Limit invalid. */
298#define VMX_IGS_IDTR_LIMIT_INVALID 583
299/** Longmode RIP is invalid. */
300#define VMX_IGS_LONGMODE_RIP_INVALID 584
301/** RFLAGS reserved bits not set to 0. */
302#define VMX_IGS_RFLAGS_RESERVED 585
303/** RFLAGS RA1 reserved bits not set to 1. */
304#define VMX_IGS_RFLAGS_RESERVED1 586
305/** RFLAGS.VM (V86 mode) invalid. */
306#define VMX_IGS_RFLAGS_VM_INVALID 587
307/** RFLAGS.IF invalid. */
308#define VMX_IGS_RFLAGS_IF_INVALID 588
309/** Activity state invalid. */
310#define VMX_IGS_ACTIVITY_STATE_INVALID 589
311/** Activity state HLT invalid when SS.Attr.DPL is not zero. */
312#define VMX_IGS_ACTIVITY_STATE_HLT_INVALID 590
313/** Activity state ACTIVE invalid when block-by-STI or MOV SS. */
314#define VMX_IGS_ACTIVITY_STATE_ACTIVE_INVALID 591
315/** Activity state SIPI WAIT invalid. */
316#define VMX_IGS_ACTIVITY_STATE_SIPI_WAIT_INVALID 592
317/** Interruptibility state reserved bits not set to 0. */
318#define VMX_IGS_INTERRUPTIBILITY_STATE_RESERVED 593
319/** Interruptibility state cannot be block-by-STI -and- MOV SS. */
320#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_MOVSS_INVALID 594
321/** Interruptibility state block-by-STI invalid for EFLAGS. */
322#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_EFL_INVALID 595
323/** Interruptibility state invalid while trying to deliver external
324 * interrupt. */
325#define VMX_IGS_INTERRUPTIBILITY_STATE_EXT_INT_INVALID 596
326/** Interruptibility state block-by-MOVSS invalid while trying to deliver an
327 * NMI. */
328#define VMX_IGS_INTERRUPTIBILITY_STATE_MOVSS_INVALID 597
329/** Interruptibility state block-by-SMI invalid when CPU is not in SMM. */
330#define VMX_IGS_INTERRUPTIBILITY_STATE_SMI_INVALID 598
331/** Interruptibility state block-by-SMI invalid when trying to enter SMM. */
332#define VMX_IGS_INTERRUPTIBILITY_STATE_SMI_SMM_INVALID 599
333/** Interruptibility state block-by-STI (maybe) invalid when trying to
334 * deliver an NMI. */
335#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_INVALID 600
336/** Interruptibility state block-by-NMI invalid when virtual-NMIs control is
337 * active. */
338#define VMX_IGS_INTERRUPTIBILITY_STATE_NMI_INVALID 601
339/** Pending debug exceptions reserved bits not set to 0. */
340#define VMX_IGS_PENDING_DEBUG_RESERVED 602
341/** Longmode pending debug exceptions reserved bits not set to 0. */
342#define VMX_IGS_LONGMODE_PENDING_DEBUG_RESERVED 603
343/** Pending debug exceptions.BS bit is not set when it should be. */
344#define VMX_IGS_PENDING_DEBUG_XCPT_BS_NOT_SET 604
345/** Pending debug exceptions.BS bit is not clear when it should be. */
346#define VMX_IGS_PENDING_DEBUG_XCPT_BS_NOT_CLEAR 605
347/** VMCS link pointer reserved bits not set to 0. */
348#define VMX_IGS_VMCS_LINK_PTR_RESERVED 606
349/** TR cannot index into LDT, TI bit MBZ. */
350#define VMX_IGS_TR_TI_INVALID 607
351/** LDTR cannot index into LDT. TI bit MBZ. */
352#define VMX_IGS_LDTR_TI_INVALID 608
353/** TR.Base is not canonical. */
354#define VMX_IGS_TR_BASE_NOT_CANONICAL 609
355/** FS.Base is not canonical. */
356#define VMX_IGS_FS_BASE_NOT_CANONICAL 610
357/** GS.Base is not canonical. */
358#define VMX_IGS_GS_BASE_NOT_CANONICAL 611
359/** LDTR.Base is not canonical. */
360#define VMX_IGS_LDTR_BASE_NOT_CANONICAL 612
361/** TR is unusable. */
362#define VMX_IGS_TR_ATTR_UNUSABLE 613
363/** TR.Attr.S bit invalid. */
364#define VMX_IGS_TR_ATTR_S_INVALID 614
365/** TR is not present. */
366#define VMX_IGS_TR_ATTR_P_INVALID 615
367/** TR.Attr reserved bits not set to 0. */
368#define VMX_IGS_TR_ATTR_RESERVED 616
369/** TR.Attr.G bit invalid. */
370#define VMX_IGS_TR_ATTR_G_INVALID 617
371/** Longmode TR.Attr.Type invalid. */
372#define VMX_IGS_LONGMODE_TR_ATTR_TYPE_INVALID 618
373/** TR.Attr.Type invalid. */
374#define VMX_IGS_TR_ATTR_TYPE_INVALID 619
375/** CS.Attr.S invalid. */
376#define VMX_IGS_CS_ATTR_S_INVALID 620
377/** CS.Attr.DPL invalid. */
378#define VMX_IGS_CS_ATTR_DPL_INVALID 621
379/** PAE PDPTE reserved bits not set to 0. */
380#define VMX_IGS_PAE_PDPTE_RESERVED 623
381/** VMCS link pointer does not point to a shadow VMCS. */
382#define VMX_IGS_VMCS_LINK_PTR_NOT_SHADOW 624
383/** VMCS link pointer to a shadow VMCS with invalid VMCS revision identifer. */
384#define VMX_IGS_VMCS_LINK_PTR_SHADOW_VMCS_ID_INVALID 625
385/** @} */
386
387/** @name VMX VMCS-Read cache indices.
388 * @{
389 */
390#define VMX_VMCS_GUEST_ES_BASE_CACHE_IDX 0
391#define VMX_VMCS_GUEST_CS_BASE_CACHE_IDX 1
392#define VMX_VMCS_GUEST_SS_BASE_CACHE_IDX 2
393#define VMX_VMCS_GUEST_DS_BASE_CACHE_IDX 3
394#define VMX_VMCS_GUEST_FS_BASE_CACHE_IDX 4
395#define VMX_VMCS_GUEST_GS_BASE_CACHE_IDX 5
396#define VMX_VMCS_GUEST_LDTR_BASE_CACHE_IDX 6
397#define VMX_VMCS_GUEST_TR_BASE_CACHE_IDX 7
398#define VMX_VMCS_GUEST_GDTR_BASE_CACHE_IDX 8
399#define VMX_VMCS_GUEST_IDTR_BASE_CACHE_IDX 9
400#define VMX_VMCS_GUEST_RSP_CACHE_IDX 10
401#define VMX_VMCS_GUEST_RIP_CACHE_IDX 11
402#define VMX_VMCS_GUEST_SYSENTER_ESP_CACHE_IDX 12
403#define VMX_VMCS_GUEST_SYSENTER_EIP_CACHE_IDX 13
404#define VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX 14
405#define VMX_VMCS_RO_GUEST_LINEAR_ADDR_CACHE_IDX 15
406#define VMX_VMCS_MAX_CACHE_IDX (VMX_VMCS_RO_GUEST_LINEAR_ADDR_CACHE_IDX + 1)
407#define VMX_VMCS_GUEST_CR3_CACHE_IDX 16
408#define VMX_VMCS_MAX_NESTED_PAGING_CACHE_IDX (VMX_VMCS_GUEST_CR3_CACHE_IDX + 1)
409/** @} */
410
411
412/** @name VMX Extended Page Tables (EPT) Common Bits.
413 * @{ */
414/** Bit 0 - Readable (we often think of it as present). */
415#define EPT_E_BIT_READ 0
416#define EPT_E_READ RT_BIT_64(EPT_E_BIT_READ) /**< @see EPT_E_BIT_READ */
417/** Bit 1 - Writable. */
418#define EPT_E_BIT_WRITE 1
419#define EPT_E_WRITE RT_BIT_64(EPT_E_BIT_WRITE) /**< @see EPT_E_BIT_WRITE */
420/** Bit 2 - Executable.
421 * @note This controls supervisor instruction fetching if mode-based
422 * execution control is enabled. */
423#define EPT_E_BIT_EXECUTE 2
424#define EPT_E_EXECUTE RT_BIT_64(EPT_E_BIT_EXECUTE) /**< @see EPT_E_BIT_EXECUTE */
425/** Bits 3-5 - Memory type mask (leaf only, MBZ).
426 * The memory type is only applicable for leaf entries and MBZ for
427 * non-leaf (causes miconfiguration exit). */
428#define EPT_E_MEMTYPE_MASK UINT64_C(0x0038)
429/** Bits 3-5 - Memory type shifted mask. */
430#define EPT_E_MEMTYPE_SMASK UINT64_C(0x0007)
431/** Bits 3-5 - Memory type shift count. */
432#define EPT_E_MEMTYPE_SHIFT 3
433/** Bits 3-5 - Memory type: UC (Uncacheable). */
434#define EPT_E_MEMTYPE_UC (UINT64_C(0) << EPT_E_MEMTYPE_SHIFT)
435/** Bits 3-5 - Memory type: WC (Write Combining). */
436#define EPT_E_MEMTYPE_WC (UINT64_C(1) << EPT_E_MEMTYPE_SHIFT)
437/** Bits 3-5 - Memory type: Invalid (2). */
438#define EPT_E_MEMTYPE_INVALID_2 (UINT64_C(2) << EPT_E_MEMTYPE_SHIFT)
439/** Bits 3-5 - Memory type: Invalid (3). */
440#define EPT_E_MEMTYPE_INVALID_3 (UINT64_C(3) << EPT_E_MEMTYPE_SHIFT)
441/** Bits 3-5 - Memory type: WT (Write Through). */
442#define EPT_E_MEMTYPE_WT (UINT64_C(4) << EPT_E_MEMTYPE_SHIFT)
443/** Bits 3-5 - Memory type: WP (Write Protected). */
444#define EPT_E_MEMTYPE_WP (UINT64_C(5) << EPT_E_MEMTYPE_SHIFT)
445/** Bits 3-5 - Memory type: WB (Write Back). */
446#define EPT_E_MEMTYPE_WB (UINT64_C(6) << EPT_E_MEMTYPE_SHIFT)
447/** Bits 3-5 - Memory type: Invalid (7). */
448#define EPT_E_MEMTYPE_INVALID_7 (UINT64_C(7) << EPT_E_MEMTYPE_SHIFT)
449/** Bit 6 - Ignore page attribute table (leaf, MBZ). */
450#define EPT_E_BIT_IGNORE_PAT 6
451#define EPT_E_IGNORE_PAT RT_BIT_64(EPT_E_BIT_IGNORE_PAT) /**< @see EPT_E_BIT_IGNORE_PAT */
452/** Bit 7 - Leaf entry (MBZ in PML4, ignored in PT). */
453#define EPT_E_BIT_LEAF 7
454#define EPT_E_LEAF RT_BIT_64(EPT_E_BIT_LEAF) /**< @see EPT_E_BIT_LEAF */
455/** Bit 8 - Accessed (all levels).
456 * @note Ignored and not written when EPTP bit 6 is 0. */
457#define EPT_E_BIT_ACCESSED 8
458#define EPT_E_ACCESSED RT_BIT_64(EPT_E_BIT_ACCESSED) /**< @see EPT_E_BIT_ACCESSED */
459/** Bit 9 - Dirty (leaf only).
460 * @note Ignored and not written when EPTP bit 6 is 0. */
461#define EPT_E_BIT_DIRTY 9
462#define EPT_E_DIRTY RT_BIT_64(EPT_E_BIT_DIRTY) /**< @see EPT_E_BIT_DIRTY */
463/** Bit 10 - Executable for usermode.
464 * @note This ignored if mode-based execution control is disabled. */
465#define EPT_E_BIT_USER_EXECUTE 10
466#define EPT_E_USER_EXECUTE RT_BIT_64(EPT_E_BIT_USER_EXECUTE) /**< @see EPT_E_BIT_USER_EXECUTE */
467/* Bit 11 is always ignored. */
468/** Bits 12-51 - Physical Page number of the next level. */
469#define EPT_E_PG_MASK UINT64_C(0x000ffffffffff000)
470/** Bit 58 - Page-write access (leaf only, ignored).
471 * @note Ignored if EPT page-write control is disabled. */
472#define EPT_E_BIT_PAGING_WRITE 58
473#define EPT_E_PAGING_WRITE RT_BIT_64(EPT_E_BIT_PAGING_WRITE) /**< @see EPT_E_BIT_PAGING_WRITE*/
474/* Bit 59 is always ignored. */
475/** Bit 60 - Supervisor shadow stack (leaf only, ignored).
476 * @note Ignored if EPT bit 7 is 0. */
477#define EPT_E_BIT_SUPER_SHW_STACK 60
478#define EPT_E_SUPER_SHW_STACK RT_BIT_64(EPT_E_BIT_SUPER_SHW_STACK) /**< @see EPT_E_BIT_SUPER_SHW_STACK */
479/** Bit 61 - Sub-page write permission (leaf only, ignored).
480 * @note Ignored if sub-page write permission for EPT is disabled. */
481#define EPT_E_BIT_SUBPAGE_WRITE_PERM 61
482#define EPT_E_SUBPAGE_WRITE_PERM RT_BIT_64(EPT_E_BIT_SUBPAGE_WRITE_PERM) /**< @see EPT_E_BIT_SUBPAGE_WRITE_PERM*/
483/* Bit 62 is always ignored. */
484/** Bit 63 - Suppress \#VE (leaf only, ignored).
485 * @note Ignored if EPT violation to \#VE conversion is disabled. */
486#define EPT_E_BIT_SUPPRESS_VE 63
487#define EPT_E_SUPPRESS_VE RT_BIT_64(EPT_E_BIT_SUPPRESS_VE) /**< @see EPT_E_BIT_SUPPRESS_VE */
488/** @} */
489
490
491/**@name Bit fields for common EPT attributes.
492 @{ */
493/** Read access. */
494#define VMX_BF_EPT_PT_READ_SHIFT 0
495#define VMX_BF_EPT_PT_READ_MASK UINT64_C(0x0000000000000001)
496/** Write access. */
497#define VMX_BF_EPT_PT_WRITE_SHIFT 1
498#define VMX_BF_EPT_PT_WRITE_MASK UINT64_C(0x0000000000000002)
499/** Execute access or execute access for supervisor-mode linear-addresses. */
500#define VMX_BF_EPT_PT_EXECUTE_SHIFT 2
501#define VMX_BF_EPT_PT_EXECUTE_MASK UINT64_C(0x0000000000000004)
502/** EPT memory type. */
503#define VMX_BF_EPT_PT_MEMTYPE_SHIFT 3
504#define VMX_BF_EPT_PT_MEMTYPE_MASK UINT64_C(0x0000000000000038)
505/** Ignore PAT. */
506#define VMX_BF_EPT_PT_IGNORE_PAT_SHIFT 6
507#define VMX_BF_EPT_PT_IGNORE_PAT_MASK UINT64_C(0x0000000000000040)
508/** Ignored (bit 7). */
509#define VMX_BF_EPT_PT_IGN_7_SHIFT 7
510#define VMX_BF_EPT_PT_IGN_7_MASK UINT64_C(0x0000000000000080)
511/** Accessed flag. */
512#define VMX_BF_EPT_PT_ACCESSED_SHIFT 8
513#define VMX_BF_EPT_PT_ACCESSED_MASK UINT64_C(0x0000000000000100)
514/** Dirty flag. */
515#define VMX_BF_EPT_PT_DIRTY_SHIFT 9
516#define VMX_BF_EPT_PT_DIRTY_MASK UINT64_C(0x0000000000000200)
517/** Execute access for user-mode linear addresses. */
518#define VMX_BF_EPT_PT_EXECUTE_USER_SHIFT 10
519#define VMX_BF_EPT_PT_EXECUTE_USER_MASK UINT64_C(0x0000000000000400)
520/** Ignored (bit 59:11). */
521#define VMX_BF_EPT_PT_IGN_59_11_SHIFT 11
522#define VMX_BF_EPT_PT_IGN_59_11_MASK UINT64_C(0x0ffffffffffff800)
523/** Supervisor shadow stack. */
524#define VMX_BF_EPT_PT_SUPER_SHW_STACK_SHIFT 60
525#define VMX_BF_EPT_PT_SUPER_SHW_STACK_MASK UINT64_C(0x1000000000000000)
526/** Ignored (bits 62:61). */
527#define VMX_BF_EPT_PT_IGN_62_61_SHIFT 61
528#define VMX_BF_EPT_PT_IGN_62_61_MASK UINT64_C(0x6000000000000000)
529/** Suppress \#VE. */
530#define VMX_BF_EPT_PT_SUPPRESS_VE_SHIFT 63
531#define VMX_BF_EPT_PT_SUPPRESS_VE_MASK UINT64_C(0x8000000000000000)
532RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EPT_PT_, UINT64_C(0), UINT64_MAX,
533 (READ, WRITE, EXECUTE, MEMTYPE, IGNORE_PAT, IGN_7, ACCESSED, DIRTY, EXECUTE_USER, IGN_59_11,
534 SUPER_SHW_STACK, IGN_62_61, SUPPRESS_VE));
535/** @} */
536
537
538/** @name VMX Extended Page Tables (EPT) Structures
539 * @{
540 */
541
542/**
543 * Number of page table entries in the EPT. (PDPTE/PDE/PTE)
544 */
545#define EPT_PG_ENTRIES X86_PG_PAE_ENTRIES
546
547/**
548 * EPT present mask.
549 * These are ONLY the common bits in all EPT page-table entries which does
550 * not rely on any CPU feature. It isn't necessarily the complete mask (e.g. when
551 * mode-based excute control is active).
552 */
553#define EPT_PRESENT_MASK (EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE)
554
555/**
556 * EPT Page Directory Pointer Entry. Bit view.
557 * In accordance with the VT-x spec.
558 *
559 * @todo uint64_t isn't safe for bitfields (gcc pedantic warnings, and IIRC,
560 * this did cause trouble with one compiler/version).
561 */
562typedef struct EPTPML4EBITS
563{
564 /** Present bit. */
565 RT_GCC_EXTENSION uint64_t u1Present : 1;
566 /** Writable bit. */
567 RT_GCC_EXTENSION uint64_t u1Write : 1;
568 /** Executable bit. */
569 RT_GCC_EXTENSION uint64_t u1Execute : 1;
570 /** Reserved (must be 0). */
571 RT_GCC_EXTENSION uint64_t u5Reserved : 5;
572 /** Available for software. */
573 RT_GCC_EXTENSION uint64_t u4Available : 4;
574 /** Physical address of the next level (PD). Restricted by maximum physical address width of the cpu. */
575 RT_GCC_EXTENSION uint64_t u40PhysAddr : 40;
576 /** Available for software. */
577 RT_GCC_EXTENSION uint64_t u12Available : 12;
578} EPTPML4EBITS;
579AssertCompileSize(EPTPML4EBITS, 8);
580
581/** Bits 12-51 - - EPT - Physical Page number of the next level. */
582#define EPT_PML4E_PG_MASK X86_PML4E_PG_MASK
583/** The page shift to get the PML4 index. */
584#define EPT_PML4_SHIFT X86_PML4_SHIFT
585/** The PML4 index mask (apply to a shifted page address). */
586#define EPT_PML4_MASK X86_PML4_MASK
587/** Bits - - EPT - PML4 MBZ mask. */
588#define EPT_PML4E_MBZ_MASK UINT64_C(0x00000000000000f8)
589/** Mask of all possible EPT PML4E attribute bits. */
590#define EPT_PML4E_ATTR_MASK (EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE | EPT_E_ACCESSED | EPT_E_USER_EXECUTE)
591
592/**
593 * EPT PML4E.
594 * In accordance with the VT-x spec.
595 */
596typedef union EPTPML4E
597{
598#ifndef VBOX_WITHOUT_PAGING_BIT_FIELDS
599 /** Normal view. */
600 EPTPML4EBITS n;
601#endif
602 /** Unsigned integer view. */
603 X86PGPAEUINT u;
604 /** 64 bit unsigned integer view. */
605 uint64_t au64[1];
606 /** 32 bit unsigned integer view. */
607 uint32_t au32[2];
608} EPTPML4E;
609AssertCompileSize(EPTPML4E, 8);
610/** Pointer to a PML4 table entry. */
611typedef EPTPML4E *PEPTPML4E;
612/** Pointer to a const PML4 table entry. */
613typedef const EPTPML4E *PCEPTPML4E;
614
615/**
616 * EPT PML4 Table.
617 * In accordance with the VT-x spec.
618 */
619typedef struct EPTPML4
620{
621 EPTPML4E a[EPT_PG_ENTRIES];
622} EPTPML4;
623AssertCompileSize(EPTPML4, 0x1000);
624/** Pointer to an EPT PML4 Table. */
625typedef EPTPML4 *PEPTPML4;
626/** Pointer to a const EPT PML4 Table. */
627typedef const EPTPML4 *PCEPTPML4;
628
629
630/**
631 * EPT Page Directory Pointer Entry. Bit view.
632 * In accordance with the VT-x spec.
633 */
634typedef struct EPTPDPTEBITS
635{
636 /** Present bit. */
637 RT_GCC_EXTENSION uint64_t u1Present : 1;
638 /** Writable bit. */
639 RT_GCC_EXTENSION uint64_t u1Write : 1;
640 /** Executable bit. */
641 RT_GCC_EXTENSION uint64_t u1Execute : 1;
642 /** Reserved (must be 0). */
643 RT_GCC_EXTENSION uint64_t u5Reserved : 5;
644 /** Available for software. */
645 RT_GCC_EXTENSION uint64_t u4Available : 4;
646 /** Physical address of the next level (PD). Restricted by maximum physical address width of the cpu. */
647 RT_GCC_EXTENSION uint64_t u40PhysAddr : 40;
648 /** Available for software. */
649 RT_GCC_EXTENSION uint64_t u12Available : 12;
650} EPTPDPTEBITS;
651AssertCompileSize(EPTPDPTEBITS, 8);
652
653/** Bit 7 - - EPT - PDPTE maps a 1GB page. */
654#define EPT_PDPTE1G_SIZE_MASK RT_BIT_64(7)
655/** Bits 12-51 - - EPT - Physical Page number of the next level. */
656#define EPT_PDPTE_PG_MASK X86_PDPE_PG_MASK
657/** Bits 30-51 - - EPT - Physical Page number of the 1G large page. */
658#define EPT_PDPTE1G_PG_MASK X86_PDPE1G_PG_MASK
659
660/** The page shift to get the PDPT index. */
661#define EPT_PDPT_SHIFT X86_PDPT_SHIFT
662/** The PDPT index mask (apply to a shifted page address). */
663#define EPT_PDPT_MASK X86_PDPT_MASK_AMD64
664/** Bits 3-7 - - EPT - PDPTE MBZ Mask. */
665#define EPT_PDPTE_MBZ_MASK UINT64_C(0x00000000000000f8)
666/** Bits 12-29 - - EPT - 1GB PDPTE MBZ Mask. */
667#define EPT_PDPTE1G_MBZ_MASK UINT64_C(0x000000003ffff000)
668/** Mask of all possible EPT PDPTE (1GB) attribute bits. */
669#define EPT_PDPTE1G_ATTR_MASK ( EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE | EPT_E_MEMTYPE_MASK | EPT_E_IGNORE_PAT \
670 | EPT_E_ACCESSED | EPT_E_DIRTY | EPT_E_USER_EXECUTE)
671/** Mask of all possible EPT PDPTE attribute bits. */
672#define EPT_PDPTE_ATTR_MASK (EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE | EPT_E_ACCESSED | EPT_E_USER_EXECUTE)
673/** */
674
675/**
676 * EPT Page Directory Pointer.
677 * In accordance with the VT-x spec.
678 */
679typedef union EPTPDPTE
680{
681#ifndef VBOX_WITHOUT_PAGING_BIT_FIELDS
682 /** Normal view. */
683 EPTPDPTEBITS n;
684#endif
685 /** Unsigned integer view. */
686 X86PGPAEUINT u;
687 /** 64 bit unsigned integer view. */
688 uint64_t au64[1];
689 /** 32 bit unsigned integer view. */
690 uint32_t au32[2];
691} EPTPDPTE;
692AssertCompileSize(EPTPDPTE, 8);
693/** Pointer to an EPT Page Directory Pointer Entry. */
694typedef EPTPDPTE *PEPTPDPTE;
695/** Pointer to a const EPT Page Directory Pointer Entry. */
696typedef const EPTPDPTE *PCEPTPDPTE;
697
698/**
699 * EPT Page Directory Pointer Table.
700 * In accordance with the VT-x spec.
701 */
702typedef struct EPTPDPT
703{
704 EPTPDPTE a[EPT_PG_ENTRIES];
705} EPTPDPT;
706AssertCompileSize(EPTPDPT, 0x1000);
707/** Pointer to an EPT Page Directory Pointer Table. */
708typedef EPTPDPT *PEPTPDPT;
709/** Pointer to a const EPT Page Directory Pointer Table. */
710typedef const EPTPDPT *PCEPTPDPT;
711
712
713/**
714 * EPT Page Directory Table Entry. Bit view.
715 * In accordance with the VT-x spec.
716 */
717typedef struct EPTPDEBITS
718{
719 /** Present bit. */
720 RT_GCC_EXTENSION uint64_t u1Present : 1;
721 /** Writable bit. */
722 RT_GCC_EXTENSION uint64_t u1Write : 1;
723 /** Executable bit. */
724 RT_GCC_EXTENSION uint64_t u1Execute : 1;
725 /** Reserved (must be 0). */
726 RT_GCC_EXTENSION uint64_t u4Reserved : 4;
727 /** Big page (must be 0 here). */
728 RT_GCC_EXTENSION uint64_t u1Size : 1;
729 /** Available for software. */
730 RT_GCC_EXTENSION uint64_t u4Available : 4;
731 /** Physical address of page table. Restricted by maximum physical address width of the cpu. */
732 RT_GCC_EXTENSION uint64_t u40PhysAddr : 40;
733 /** Available for software. */
734 RT_GCC_EXTENSION uint64_t u12Available : 12;
735} EPTPDEBITS;
736AssertCompileSize(EPTPDEBITS, 8);
737
738/** Bits 12-51 - - EPT - Physical Page number of the next level. */
739#define EPT_PDE_PG_MASK X86_PDE_PAE_PG_MASK
740/** The page shift to get the PD index. */
741#define EPT_PD_SHIFT X86_PD_PAE_SHIFT
742/** The PD index mask (apply to a shifted page address). */
743#define EPT_PD_MASK X86_PD_PAE_MASK
744/** Bits 3-7 - EPT - PDE MBZ Mask. */
745#define EPT_PDE_MBZ_MASK UINT64_C(0x00000000000000f8)
746/** Mask of all possible EPT PDE (2M) attribute bits. */
747#define EPT_PDE2M_ATTR_MASK ( EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE | EPT_E_MEMTYPE_MASK | EPT_E_IGNORE_PAT \
748 | EPT_E_ACCESSED | EPT_E_DIRTY | EPT_E_USER_EXECUTE)
749/** Mask of all possible EPT PDE attribute bits. */
750#define EPT_PDE_ATTR_MASK (EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE | EPT_E_ACCESSED | EPT_E_USER_EXECUTE)
751
752
753/**
754 * EPT 2MB Page Directory Table Entry. Bit view.
755 * In accordance with the VT-x spec.
756 */
757typedef struct EPTPDE2MBITS
758{
759 /** Present bit. */
760 RT_GCC_EXTENSION uint64_t u1Present : 1;
761 /** Writable bit. */
762 RT_GCC_EXTENSION uint64_t u1Write : 1;
763 /** Executable bit. */
764 RT_GCC_EXTENSION uint64_t u1Execute : 1;
765 /** EPT Table Memory Type. MBZ for non-leaf nodes. */
766 RT_GCC_EXTENSION uint64_t u3EMT : 3;
767 /** Ignore PAT memory type */
768 RT_GCC_EXTENSION uint64_t u1IgnorePAT : 1;
769 /** Big page (must be 1 here). */
770 RT_GCC_EXTENSION uint64_t u1Size : 1;
771 /** Available for software. */
772 RT_GCC_EXTENSION uint64_t u4Available : 4;
773 /** Reserved (must be 0). */
774 RT_GCC_EXTENSION uint64_t u9Reserved : 9;
775 /** Physical address of the 2MB page. Restricted by maximum physical address width of the cpu. */
776 RT_GCC_EXTENSION uint64_t u31PhysAddr : 31;
777 /** Available for software. */
778 RT_GCC_EXTENSION uint64_t u12Available : 12;
779} EPTPDE2MBITS;
780AssertCompileSize(EPTPDE2MBITS, 8);
781
782/** Bits 21-51 - - EPT - Physical Page number of the next level. */
783#define EPT_PDE2M_PG_MASK X86_PDE2M_PAE_PG_MASK
784/** Bits 20-12 - - EPT - PDE 2M MBZ Mask. */
785#define EPT_PDE2M_MBZ_MASK UINT64_C(0x00000000001ff000)
786
787
788/**
789 * EPT Page Directory Table Entry.
790 * In accordance with the VT-x spec.
791 */
792typedef union EPTPDE
793{
794#ifndef VBOX_WITHOUT_PAGING_BIT_FIELDS
795 /** Normal view. */
796 EPTPDEBITS n;
797 /** 2MB view (big). */
798 EPTPDE2MBITS b;
799#endif
800 /** Unsigned integer view. */
801 X86PGPAEUINT u;
802 /** 64 bit unsigned integer view. */
803 uint64_t au64[1];
804 /** 32 bit unsigned integer view. */
805 uint32_t au32[2];
806} EPTPDE;
807AssertCompileSize(EPTPDE, 8);
808/** Pointer to an EPT Page Directory Table Entry. */
809typedef EPTPDE *PEPTPDE;
810/** Pointer to a const EPT Page Directory Table Entry. */
811typedef const EPTPDE *PCEPTPDE;
812
813/**
814 * EPT Page Directory Table.
815 * In accordance with the VT-x spec.
816 */
817typedef struct EPTPD
818{
819 EPTPDE a[EPT_PG_ENTRIES];
820} EPTPD;
821AssertCompileSize(EPTPD, 0x1000);
822/** Pointer to an EPT Page Directory Table. */
823typedef EPTPD *PEPTPD;
824/** Pointer to a const EPT Page Directory Table. */
825typedef const EPTPD *PCEPTPD;
826
827/**
828 * EPT Page Table Entry. Bit view.
829 * In accordance with the VT-x spec.
830 */
831typedef struct EPTPTEBITS
832{
833 /** 0 - Present bit.
834 * @remarks This is a convenience "misnomer". The bit actually indicates read access
835 * and the CPU will consider an entry with any of the first three bits set
836 * as present. Since all our valid entries will have this bit set, it can
837 * be used as a present indicator and allow some code sharing. */
838 RT_GCC_EXTENSION uint64_t u1Present : 1;
839 /** 1 - Writable bit. */
840 RT_GCC_EXTENSION uint64_t u1Write : 1;
841 /** 2 - Executable bit. */
842 RT_GCC_EXTENSION uint64_t u1Execute : 1;
843 /** 5:3 - EPT Memory Type. MBZ for non-leaf nodes. */
844 RT_GCC_EXTENSION uint64_t u3EMT : 3;
845 /** 6 - Ignore PAT memory type */
846 RT_GCC_EXTENSION uint64_t u1IgnorePAT : 1;
847 /** 11:7 - Available for software. */
848 RT_GCC_EXTENSION uint64_t u5Available : 5;
849 /** 51:12 - Physical address of page. Restricted by maximum physical
850 * address width of the cpu. */
851 RT_GCC_EXTENSION uint64_t u40PhysAddr : 40;
852 /** 63:52 - Available for software. */
853 RT_GCC_EXTENSION uint64_t u12Available : 12;
854} EPTPTEBITS;
855AssertCompileSize(EPTPTEBITS, 8);
856
857/** Bits 12-51 - - EPT - Physical Page number of the next level. */
858#define EPT_PTE_PG_MASK X86_PTE_PAE_PG_MASK
859/** The page shift to get the EPT PTE index. */
860#define EPT_PT_SHIFT X86_PT_PAE_SHIFT
861/** The EPT PT index mask (apply to a shifted page address). */
862#define EPT_PT_MASK X86_PT_PAE_MASK
863/** No bits - - EPT - PTE MBZ bits. */
864#define EPT_PTE_MBZ_MASK UINT64_C(0x0000000000000000)
865/** Mask of all possible EPT PTE attribute bits. */
866#define EPT_PTE_ATTR_MASK ( EPT_E_READ | EPT_E_WRITE | EPT_E_EXECUTE | EPT_E_MEMTYPE_MASK | EPT_E_IGNORE_PAT \
867 | EPT_E_ACCESSED | EPT_E_USER_EXECUTE)
868
869
870/**
871 * EPT Page Table Entry.
872 * In accordance with the VT-x spec.
873 */
874typedef union EPTPTE
875{
876#ifndef VBOX_WITHOUT_PAGING_BIT_FIELDS
877 /** Normal view. */
878 EPTPTEBITS n;
879#endif
880 /** Unsigned integer view. */
881 X86PGPAEUINT u;
882 /** 64 bit unsigned integer view. */
883 uint64_t au64[1];
884 /** 32 bit unsigned integer view. */
885 uint32_t au32[2];
886} EPTPTE;
887AssertCompileSize(EPTPTE, 8);
888/** Pointer to an EPT Page Directory Table Entry. */
889typedef EPTPTE *PEPTPTE;
890/** Pointer to a const EPT Page Directory Table Entry. */
891typedef const EPTPTE *PCEPTPTE;
892
893/**
894 * EPT Page Table.
895 * In accordance with the VT-x spec.
896 */
897typedef struct EPTPT
898{
899 EPTPTE a[EPT_PG_ENTRIES];
900} EPTPT;
901AssertCompileSize(EPTPT, 0x1000);
902/** Pointer to an extended page table. */
903typedef EPTPT *PEPTPT;
904/** Pointer to a const extended table. */
905typedef const EPTPT *PCEPTPT;
906
907/** EPTP page mask for the EPT PML4 table. */
908#define EPT_EPTP_PG_MASK X86_CR3_AMD64_PAGE_MASK
909/** @} */
910
911/**
912 * VMX VPID flush types.
913 * Valid enum members are in accordance with the VT-x spec.
914 */
915typedef enum
916{
917 /** Invalidate a specific page. */
918 VMXTLBFLUSHVPID_INDIV_ADDR = 0,
919 /** Invalidate one context (specific VPID). */
920 VMXTLBFLUSHVPID_SINGLE_CONTEXT = 1,
921 /** Invalidate all contexts (all VPIDs). */
922 VMXTLBFLUSHVPID_ALL_CONTEXTS = 2,
923 /** Invalidate a single VPID context retaining global mappings. */
924 VMXTLBFLUSHVPID_SINGLE_CONTEXT_RETAIN_GLOBALS = 3,
925 /** Unsupported by VirtualBox. */
926 VMXTLBFLUSHVPID_NOT_SUPPORTED = 0xbad0,
927 /** Unsupported by CPU. */
928 VMXTLBFLUSHVPID_NONE = 0xbad1
929} VMXTLBFLUSHVPID;
930AssertCompileSize(VMXTLBFLUSHVPID, 4);
931/** Mask of all valid INVVPID flush types. */
932#define VMX_INVVPID_VALID_MASK ( VMXTLBFLUSHVPID_INDIV_ADDR \
933 | VMXTLBFLUSHVPID_SINGLE_CONTEXT \
934 | VMXTLBFLUSHVPID_ALL_CONTEXTS \
935 | VMXTLBFLUSHVPID_SINGLE_CONTEXT_RETAIN_GLOBALS)
936
937/**
938 * VMX EPT flush types.
939 * @note Valid enums values are in accordance with the VT-x spec.
940 */
941typedef enum
942{
943 /** Invalidate one context (specific EPT). */
944 VMXTLBFLUSHEPT_SINGLE_CONTEXT = 1,
945 /* Invalidate all contexts (all EPTs) */
946 VMXTLBFLUSHEPT_ALL_CONTEXTS = 2,
947 /** Unsupported by VirtualBox. */
948 VMXTLBFLUSHEPT_NOT_SUPPORTED = 0xbad0,
949 /** Unsupported by CPU. */
950 VMXTLBFLUSHEPT_NONE = 0xbad1
951} VMXTLBFLUSHEPT;
952AssertCompileSize(VMXTLBFLUSHEPT, 4);
953/** Mask of all valid INVEPT flush types. */
954#define VMX_INVEPT_VALID_MASK ( VMXTLBFLUSHEPT_SINGLE_CONTEXT \
955 | VMXTLBFLUSHEPT_ALL_CONTEXTS)
956
957/**
958 * VMX Posted Interrupt Descriptor.
959 * In accordance with the VT-x spec.
960 */
961typedef struct VMXPOSTEDINTRDESC
962{
963 uint32_t aVectorBitmap[8];
964 uint32_t fOutstandingNotification : 1;
965 uint32_t uReserved0 : 31;
966 uint8_t au8Reserved0[28];
967} VMXPOSTEDINTRDESC;
968AssertCompileMemberSize(VMXPOSTEDINTRDESC, aVectorBitmap, 32);
969AssertCompileSize(VMXPOSTEDINTRDESC, 64);
970/** Pointer to a posted interrupt descriptor. */
971typedef VMXPOSTEDINTRDESC *PVMXPOSTEDINTRDESC;
972/** Pointer to a const posted interrupt descriptor. */
973typedef const VMXPOSTEDINTRDESC *PCVMXPOSTEDINTRDESC;
974
975/**
976 * VMX VMCS revision identifier.
977 * In accordance with the VT-x spec.
978 */
979typedef union
980{
981 struct
982 {
983 /** Revision identifier. */
984 uint32_t u31RevisionId : 31;
985 /** Whether this is a shadow VMCS. */
986 uint32_t fIsShadowVmcs : 1;
987 } n;
988 /* The unsigned integer view. */
989 uint32_t u;
990} VMXVMCSREVID;
991AssertCompileSize(VMXVMCSREVID, 4);
992/** Pointer to the VMXVMCSREVID union. */
993typedef VMXVMCSREVID *PVMXVMCSREVID;
994/** Pointer to a const VMXVMCSREVID union. */
995typedef const VMXVMCSREVID *PCVMXVMCSREVID;
996
997/**
998 * VMX VM-exit instruction information.
999 * In accordance with the VT-x spec.
1000 */
1001typedef union
1002{
1003 /** Plain unsigned int representation. */
1004 uint32_t u;
1005
1006 /** INS and OUTS information. */
1007 struct
1008 {
1009 uint32_t u7Reserved0 : 7;
1010 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1011 uint32_t u3AddrSize : 3;
1012 uint32_t u5Reserved1 : 5;
1013 /** The segment register (X86_SREG_XXX). */
1014 uint32_t iSegReg : 3;
1015 uint32_t uReserved2 : 14;
1016 } StrIo;
1017
1018 /** INVEPT, INVPCID, INVVPID information. */
1019 struct
1020 {
1021 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1022 uint32_t u2Scaling : 2;
1023 uint32_t u5Undef0 : 5;
1024 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1025 uint32_t u3AddrSize : 3;
1026 /** Cleared to 0. */
1027 uint32_t u1Cleared0 : 1;
1028 uint32_t u4Undef0 : 4;
1029 /** The segment register (X86_SREG_XXX). */
1030 uint32_t iSegReg : 3;
1031 /** The index register (X86_GREG_XXX). */
1032 uint32_t iIdxReg : 4;
1033 /** Set if index register is invalid. */
1034 uint32_t fIdxRegInvalid : 1;
1035 /** The base register (X86_GREG_XXX). */
1036 uint32_t iBaseReg : 4;
1037 /** Set if base register is invalid. */
1038 uint32_t fBaseRegInvalid : 1;
1039 /** Register 2 (X86_GREG_XXX). */
1040 uint32_t iReg2 : 4;
1041 } Inv;
1042
1043 /** VMCLEAR, VMPTRLD, VMPTRST, VMXON, XRSTORS, XSAVES information. */
1044 struct
1045 {
1046 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1047 uint32_t u2Scaling : 2;
1048 uint32_t u5Reserved0 : 5;
1049 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1050 uint32_t u3AddrSize : 3;
1051 /** Cleared to 0. */
1052 uint32_t u1Cleared0 : 1;
1053 uint32_t u4Reserved0 : 4;
1054 /** The segment register (X86_SREG_XXX). */
1055 uint32_t iSegReg : 3;
1056 /** The index register (X86_GREG_XXX). */
1057 uint32_t iIdxReg : 4;
1058 /** Set if index register is invalid. */
1059 uint32_t fIdxRegInvalid : 1;
1060 /** The base register (X86_GREG_XXX). */
1061 uint32_t iBaseReg : 4;
1062 /** Set if base register is invalid. */
1063 uint32_t fBaseRegInvalid : 1;
1064 /** Register 2 (X86_GREG_XXX). */
1065 uint32_t iReg2 : 4;
1066 } VmxXsave;
1067
1068 /** LIDT, LGDT, SIDT, SGDT information. */
1069 struct
1070 {
1071 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1072 uint32_t u2Scaling : 2;
1073 uint32_t u5Undef0 : 5;
1074 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1075 uint32_t u3AddrSize : 3;
1076 /** Always cleared to 0. */
1077 uint32_t u1Cleared0 : 1;
1078 /** Operand size; 0=16-bit, 1=32-bit, undefined for 64-bit. */
1079 uint32_t uOperandSize : 1;
1080 uint32_t u3Undef0 : 3;
1081 /** The segment register (X86_SREG_XXX). */
1082 uint32_t iSegReg : 3;
1083 /** The index register (X86_GREG_XXX). */
1084 uint32_t iIdxReg : 4;
1085 /** Set if index register is invalid. */
1086 uint32_t fIdxRegInvalid : 1;
1087 /** The base register (X86_GREG_XXX). */
1088 uint32_t iBaseReg : 4;
1089 /** Set if base register is invalid. */
1090 uint32_t fBaseRegInvalid : 1;
1091 /** Instruction identity (VMX_INSTR_ID_XXX). */
1092 uint32_t u2InstrId : 2;
1093 uint32_t u2Undef0 : 2;
1094 } GdtIdt;
1095
1096 /** LLDT, LTR, SLDT, STR information. */
1097 struct
1098 {
1099 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1100 uint32_t u2Scaling : 2;
1101 uint32_t u1Undef0 : 1;
1102 /** Register 1 (X86_GREG_XXX). */
1103 uint32_t iReg1 : 4;
1104 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1105 uint32_t u3AddrSize : 3;
1106 /** Memory/Register - Always cleared to 0 to indicate memory operand. */
1107 uint32_t fIsRegOperand : 1;
1108 uint32_t u4Undef0 : 4;
1109 /** The segment register (X86_SREG_XXX). */
1110 uint32_t iSegReg : 3;
1111 /** The index register (X86_GREG_XXX). */
1112 uint32_t iIdxReg : 4;
1113 /** Set if index register is invalid. */
1114 uint32_t fIdxRegInvalid : 1;
1115 /** The base register (X86_GREG_XXX). */
1116 uint32_t iBaseReg : 4;
1117 /** Set if base register is invalid. */
1118 uint32_t fBaseRegInvalid : 1;
1119 /** Instruction identity (VMX_INSTR_ID_XXX). */
1120 uint32_t u2InstrId : 2;
1121 uint32_t u2Undef0 : 2;
1122 } LdtTr;
1123
1124 /** RDRAND, RDSEED information. */
1125 struct
1126 {
1127 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1128 uint32_t u2Undef0 : 2;
1129 /** Destination register (X86_GREG_XXX). */
1130 uint32_t iReg1 : 4;
1131 uint32_t u4Undef0 : 4;
1132 /** Operand size; 0=16-bit, 1=32-bit, 2=64-bit, 3=unused. */
1133 uint32_t u2OperandSize : 2;
1134 uint32_t u19Def0 : 20;
1135 } RdrandRdseed;
1136
1137 /** VMREAD, VMWRITE information. */
1138 struct
1139 {
1140 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1141 uint32_t u2Scaling : 2;
1142 uint32_t u1Undef0 : 1;
1143 /** Register 1 (X86_GREG_XXX). */
1144 uint32_t iReg1 : 4;
1145 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1146 uint32_t u3AddrSize : 3;
1147 /** Memory or register operand. */
1148 uint32_t fIsRegOperand : 1;
1149 /** Operand size; 0=16-bit, 1=32-bit, 2=64-bit, 3=unused. */
1150 uint32_t u4Undef0 : 4;
1151 /** The segment register (X86_SREG_XXX). */
1152 uint32_t iSegReg : 3;
1153 /** The index register (X86_GREG_XXX). */
1154 uint32_t iIdxReg : 4;
1155 /** Set if index register is invalid. */
1156 uint32_t fIdxRegInvalid : 1;
1157 /** The base register (X86_GREG_XXX). */
1158 uint32_t iBaseReg : 4;
1159 /** Set if base register is invalid. */
1160 uint32_t fBaseRegInvalid : 1;
1161 /** Register 2 (X86_GREG_XXX). */
1162 uint32_t iReg2 : 4;
1163 } VmreadVmwrite;
1164
1165 struct
1166 {
1167 uint32_t u2Undef0 : 3;
1168 /** First XMM register operand. */
1169 uint32_t u4XmmReg1 : 4;
1170 uint32_t u23Undef1 : 21;
1171 /** Second XMM register operand. */
1172 uint32_t u4XmmReg2 : 4;
1173 } LoadIwkey;
1174
1175 /** This is a combination field of all instruction information. Note! Not all field
1176 * combinations are valid (e.g., iReg1 is undefined for memory operands) and
1177 * specialized fields are overwritten by their generic counterparts (e.g. no
1178 * instruction identity field). */
1179 struct
1180 {
1181 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1182 uint32_t u2Scaling : 2;
1183 uint32_t u1Undef0 : 1;
1184 /** Register 1 (X86_GREG_XXX). */
1185 uint32_t iReg1 : 4;
1186 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1187 uint32_t u3AddrSize : 3;
1188 /** Memory/Register - Always cleared to 0 to indicate memory operand. */
1189 uint32_t fIsRegOperand : 1;
1190 /** Operand size; 0=16-bit, 1=32-bit, 2=64-bit, 3=unused. */
1191 uint32_t uOperandSize : 2;
1192 uint32_t u2Undef0 : 2;
1193 /** The segment register (X86_SREG_XXX). */
1194 uint32_t iSegReg : 3;
1195 /** The index register (X86_GREG_XXX). */
1196 uint32_t iIdxReg : 4;
1197 /** Set if index register is invalid. */
1198 uint32_t fIdxRegInvalid : 1;
1199 /** The base register (X86_GREG_XXX). */
1200 uint32_t iBaseReg : 4;
1201 /** Set if base register is invalid. */
1202 uint32_t fBaseRegInvalid : 1;
1203 /** Register 2 (X86_GREG_XXX) or instruction identity. */
1204 uint32_t iReg2 : 4;
1205 } All;
1206} VMXEXITINSTRINFO;
1207AssertCompileSize(VMXEXITINSTRINFO, 4);
1208/** Pointer to a VMX VM-exit instruction info. struct. */
1209typedef VMXEXITINSTRINFO *PVMXEXITINSTRINFO;
1210/** Pointer to a const VMX VM-exit instruction info. struct. */
1211typedef const VMXEXITINSTRINFO *PCVMXEXITINSTRINFO;
1212
1213
1214/** @name VM-entry failure reported in Exit qualification.
1215 * See Intel spec. 26.7 "VM-entry failures during or after loading guest-state".
1216 * @{
1217 */
1218/** No errors during VM-entry. */
1219#define VMX_ENTRY_FAIL_QUAL_NO_ERROR (0)
1220/** Not used. */
1221#define VMX_ENTRY_FAIL_QUAL_NOT_USED (1)
1222/** Error while loading PDPTEs. */
1223#define VMX_ENTRY_FAIL_QUAL_PDPTE (2)
1224/** NMI injection when blocking-by-STI is set. */
1225#define VMX_ENTRY_FAIL_QUAL_NMI_INJECT (3)
1226/** Invalid VMCS link pointer. */
1227#define VMX_ENTRY_FAIL_QUAL_VMCS_LINK_PTR (4)
1228/** @} */
1229
1230
1231/** @name VMXMSRPM_XXX - VMX MSR-bitmap permissions.
1232 * These are -not- specified by Intel but used internally by VirtualBox.
1233 * @{ */
1234/** Guest software reads of this MSR must not cause a VM-exit. */
1235#define VMXMSRPM_ALLOW_RD RT_BIT(0)
1236/** Guest software reads of this MSR must cause a VM-exit. */
1237#define VMXMSRPM_EXIT_RD RT_BIT(1)
1238/** Guest software writes to this MSR must not cause a VM-exit. */
1239#define VMXMSRPM_ALLOW_WR RT_BIT(2)
1240/** Guest software writes to this MSR must cause a VM-exit. */
1241#define VMXMSRPM_EXIT_WR RT_BIT(3)
1242/** Guest software reads or writes of this MSR must not cause a VM-exit. */
1243#define VMXMSRPM_ALLOW_RD_WR (VMXMSRPM_ALLOW_RD | VMXMSRPM_ALLOW_WR)
1244/** Guest software reads or writes of this MSR must cause a VM-exit. */
1245#define VMXMSRPM_EXIT_RD_WR (VMXMSRPM_EXIT_RD | VMXMSRPM_EXIT_WR)
1246/** Mask of valid MSR read permissions. */
1247#define VMXMSRPM_RD_MASK (VMXMSRPM_ALLOW_RD | VMXMSRPM_EXIT_RD)
1248/** Mask of valid MSR write permissions. */
1249#define VMXMSRPM_WR_MASK (VMXMSRPM_ALLOW_WR | VMXMSRPM_EXIT_WR)
1250/** Mask of valid MSR permissions. */
1251#define VMXMSRPM_MASK (VMXMSRPM_RD_MASK | VMXMSRPM_WR_MASK)
1252/** */
1253/** Gets whether the MSR permission is valid or not. */
1254#define VMXMSRPM_IS_FLAG_VALID(a_Msrpm) ( (a_Msrpm) != 0 \
1255 && ((a_Msrpm) & ~VMXMSRPM_MASK) == 0 \
1256 && ((a_Msrpm) & VMXMSRPM_RD_MASK) != VMXMSRPM_RD_MASK \
1257 && ((a_Msrpm) & VMXMSRPM_WR_MASK) != VMXMSRPM_WR_MASK)
1258/** @} */
1259
1260/**
1261 * VMX MSR autoload/store slot.
1262 * In accordance with the VT-x spec.
1263 */
1264typedef struct VMXAUTOMSR
1265{
1266 /** The MSR Id. */
1267 uint32_t u32Msr;
1268 /** Reserved (MBZ). */
1269 uint32_t u32Reserved;
1270 /** The MSR value. */
1271 uint64_t u64Value;
1272} VMXAUTOMSR;
1273AssertCompileSize(VMXAUTOMSR, 16);
1274/** Pointer to an MSR load/store element. */
1275typedef VMXAUTOMSR *PVMXAUTOMSR;
1276/** Pointer to a const MSR load/store element. */
1277typedef const VMXAUTOMSR *PCVMXAUTOMSR;
1278
1279/** VMX auto load-store MSR (VMXAUTOMSR) offset mask. */
1280#define VMX_AUTOMSR_OFFSET_MASK 0xf
1281
1282/**
1283 * VMX tagged-TLB flush types.
1284 */
1285typedef enum
1286{
1287 VMXTLBFLUSHTYPE_EPT,
1288 VMXTLBFLUSHTYPE_VPID,
1289 VMXTLBFLUSHTYPE_EPT_VPID,
1290 VMXTLBFLUSHTYPE_NONE
1291} VMXTLBFLUSHTYPE;
1292/** Pointer to a VMXTLBFLUSHTYPE enum. */
1293typedef VMXTLBFLUSHTYPE *PVMXTLBFLUSHTYPE;
1294/** Pointer to a const VMXTLBFLUSHTYPE enum. */
1295typedef const VMXTLBFLUSHTYPE *PCVMXTLBFLUSHTYPE;
1296
1297/**
1298 * VMX controls MSR.
1299 * In accordance with the VT-x spec.
1300 */
1301typedef union
1302{
1303 struct
1304 {
1305 /** Bits set here -must- be set in the corresponding VM-execution controls. */
1306 uint32_t allowed0;
1307 /** Bits cleared here -must- be cleared in the corresponding VM-execution
1308 * controls. */
1309 uint32_t allowed1;
1310 } n;
1311 uint64_t u;
1312} VMXCTLSMSR;
1313AssertCompileSize(VMXCTLSMSR, 8);
1314/** Pointer to a VMXCTLSMSR union. */
1315typedef VMXCTLSMSR *PVMXCTLSMSR;
1316/** Pointer to a const VMXCTLSMSR union. */
1317typedef const VMXCTLSMSR *PCVMXCTLSMSR;
1318
1319/**
1320 * VMX MSRs.
1321 */
1322typedef struct VMXMSRS
1323{
1324 /** Basic information. */
1325 uint64_t u64Basic;
1326 /** Pin-based VM-execution controls. */
1327 VMXCTLSMSR PinCtls;
1328 /** Processor-based VM-execution controls. */
1329 VMXCTLSMSR ProcCtls;
1330 /** Secondary processor-based VM-execution controls. */
1331 VMXCTLSMSR ProcCtls2;
1332 /** VM-exit controls. */
1333 VMXCTLSMSR ExitCtls;
1334 /** VM-entry controls. */
1335 VMXCTLSMSR EntryCtls;
1336 /** True pin-based VM-execution controls. */
1337 VMXCTLSMSR TruePinCtls;
1338 /** True processor-based VM-execution controls. */
1339 VMXCTLSMSR TrueProcCtls;
1340 /** True VM-entry controls. */
1341 VMXCTLSMSR TrueEntryCtls;
1342 /** True VM-exit controls. */
1343 VMXCTLSMSR TrueExitCtls;
1344 /** Miscellaneous data. */
1345 uint64_t u64Misc;
1346 /** CR0 fixed-0 - bits set here must be set in VMX operation. */
1347 uint64_t u64Cr0Fixed0;
1348 /** CR0 fixed-1 - bits clear here must be clear in VMX operation. */
1349 uint64_t u64Cr0Fixed1;
1350 /** CR4 fixed-0 - bits set here must be set in VMX operation. */
1351 uint64_t u64Cr4Fixed0;
1352 /** CR4 fixed-1 - bits clear here must be clear in VMX operation. */
1353 uint64_t u64Cr4Fixed1;
1354 /** VMCS enumeration. */
1355 uint64_t u64VmcsEnum;
1356 /** VM Functions. */
1357 uint64_t u64VmFunc;
1358 /** EPT, VPID capabilities. */
1359 uint64_t u64EptVpidCaps;
1360 /** Tertiary processor-based VM-execution controls. */
1361 uint64_t u64ProcCtls3;
1362 /** Reserved for future. */
1363 uint64_t a_u64Reserved[9];
1364} VMXMSRS;
1365AssertCompileSizeAlignment(VMXMSRS, 8);
1366AssertCompileSize(VMXMSRS, 224);
1367/** Pointer to a VMXMSRS struct. */
1368typedef VMXMSRS *PVMXMSRS;
1369/** Pointer to a const VMXMSRS struct. */
1370typedef const VMXMSRS *PCVMXMSRS;
1371
1372
1373/**
1374 * LBR MSRs.
1375 */
1376typedef struct LBRMSRS
1377{
1378 /** List of LastBranch-From-IP MSRs. */
1379 uint64_t au64BranchFromIpMsr[32];
1380 /** List of LastBranch-To-IP MSRs. */
1381 uint64_t au64BranchToIpMsr[32];
1382 /** The MSR containing the index to the most recent branch record. */
1383 uint64_t uBranchTosMsr;
1384} LBRMSRS;
1385AssertCompileSizeAlignment(LBRMSRS, 8);
1386/** Pointer to a VMXMSRS struct. */
1387typedef LBRMSRS *PLBRMSRS;
1388/** Pointer to a const VMXMSRS struct. */
1389typedef const LBRMSRS *PCLBRMSRS;
1390
1391
1392/** @name VMX Basic Exit Reasons.
1393 * In accordance with the VT-x spec.
1394 * Update g_aVMExitHandlers if new VM-exit reasons are added.
1395 * @{
1396 */
1397/** Invalid exit code */
1398#define VMX_EXIT_INVALID (-1)
1399/** Exception or non-maskable interrupt (NMI). */
1400#define VMX_EXIT_XCPT_OR_NMI 0
1401/** External interrupt. */
1402#define VMX_EXIT_EXT_INT 1
1403/** Triple fault. */
1404#define VMX_EXIT_TRIPLE_FAULT 2
1405/** INIT signal. */
1406#define VMX_EXIT_INIT_SIGNAL 3
1407/** Start-up IPI (SIPI). */
1408#define VMX_EXIT_SIPI 4
1409/** I/O system-management interrupt (SMI). */
1410#define VMX_EXIT_IO_SMI 5
1411/** Other SMI. */
1412#define VMX_EXIT_SMI 6
1413/** Interrupt window exiting. */
1414#define VMX_EXIT_INT_WINDOW 7
1415/** NMI window exiting. */
1416#define VMX_EXIT_NMI_WINDOW 8
1417/** Task switch. */
1418#define VMX_EXIT_TASK_SWITCH 9
1419/** CPUID. */
1420#define VMX_EXIT_CPUID 10
1421/** GETSEC. */
1422#define VMX_EXIT_GETSEC 11
1423/** HLT. */
1424#define VMX_EXIT_HLT 12
1425/** INVD. */
1426#define VMX_EXIT_INVD 13
1427/** INVLPG. */
1428#define VMX_EXIT_INVLPG 14
1429/** RDPMC. */
1430#define VMX_EXIT_RDPMC 15
1431/** RDTSC. */
1432#define VMX_EXIT_RDTSC 16
1433/** RSM in SMM. */
1434#define VMX_EXIT_RSM 17
1435/** VMCALL. */
1436#define VMX_EXIT_VMCALL 18
1437/** VMCLEAR. */
1438#define VMX_EXIT_VMCLEAR 19
1439/** VMLAUNCH. */
1440#define VMX_EXIT_VMLAUNCH 20
1441/** VMPTRLD. */
1442#define VMX_EXIT_VMPTRLD 21
1443/** VMPTRST. */
1444#define VMX_EXIT_VMPTRST 22
1445/** VMREAD. */
1446#define VMX_EXIT_VMREAD 23
1447/** VMRESUME. */
1448#define VMX_EXIT_VMRESUME 24
1449/** VMWRITE. */
1450#define VMX_EXIT_VMWRITE 25
1451/** VMXOFF. */
1452#define VMX_EXIT_VMXOFF 26
1453/** VMXON. */
1454#define VMX_EXIT_VMXON 27
1455/** Control-register accesses. */
1456#define VMX_EXIT_MOV_CRX 28
1457/** Debug-register accesses. */
1458#define VMX_EXIT_MOV_DRX 29
1459/** I/O instruction. */
1460#define VMX_EXIT_IO_INSTR 30
1461/** RDMSR. */
1462#define VMX_EXIT_RDMSR 31
1463/** WRMSR. */
1464#define VMX_EXIT_WRMSR 32
1465/** VM-entry failure due to invalid guest state. */
1466#define VMX_EXIT_ERR_INVALID_GUEST_STATE 33
1467/** VM-entry failure due to MSR loading. */
1468#define VMX_EXIT_ERR_MSR_LOAD 34
1469/** MWAIT. */
1470#define VMX_EXIT_MWAIT 36
1471/** VM-exit due to monitor trap flag. */
1472#define VMX_EXIT_MTF 37
1473/** MONITOR. */
1474#define VMX_EXIT_MONITOR 39
1475/** PAUSE. */
1476#define VMX_EXIT_PAUSE 40
1477/** VM-entry failure due to machine-check. */
1478#define VMX_EXIT_ERR_MACHINE_CHECK 41
1479/** TPR below threshold. Guest software executed MOV to CR8. */
1480#define VMX_EXIT_TPR_BELOW_THRESHOLD 43
1481/** VM-exit due to guest accessing physical address in the APIC-access page. */
1482#define VMX_EXIT_APIC_ACCESS 44
1483/** VM-exit due to EOI virtualization. */
1484#define VMX_EXIT_VIRTUALIZED_EOI 45
1485/** Access to GDTR/IDTR using LGDT, LIDT, SGDT or SIDT. */
1486#define VMX_EXIT_GDTR_IDTR_ACCESS 46
1487/** Access to LDTR/TR due to LLDT, LTR, SLDT, or STR. */
1488#define VMX_EXIT_LDTR_TR_ACCESS 47
1489/** EPT violation. */
1490#define VMX_EXIT_EPT_VIOLATION 48
1491/** EPT misconfiguration. */
1492#define VMX_EXIT_EPT_MISCONFIG 49
1493/** INVEPT. */
1494#define VMX_EXIT_INVEPT 50
1495/** RDTSCP. */
1496#define VMX_EXIT_RDTSCP 51
1497/** VMX-preemption timer expired. */
1498#define VMX_EXIT_PREEMPT_TIMER 52
1499/** INVVPID. */
1500#define VMX_EXIT_INVVPID 53
1501/** WBINVD. */
1502#define VMX_EXIT_WBINVD 54
1503/** XSETBV. */
1504#define VMX_EXIT_XSETBV 55
1505/** Guest completed write to virtual-APIC. */
1506#define VMX_EXIT_APIC_WRITE 56
1507/** RDRAND. */
1508#define VMX_EXIT_RDRAND 57
1509/** INVPCID. */
1510#define VMX_EXIT_INVPCID 58
1511/** VMFUNC. */
1512#define VMX_EXIT_VMFUNC 59
1513/** ENCLS. */
1514#define VMX_EXIT_ENCLS 60
1515/** RDSEED. */
1516#define VMX_EXIT_RDSEED 61
1517/** Page-modification log full. */
1518#define VMX_EXIT_PML_FULL 62
1519/** XSAVES. */
1520#define VMX_EXIT_XSAVES 63
1521/** XRSTORS. */
1522#define VMX_EXIT_XRSTORS 64
1523/** SPP-related event (SPP miss or misconfiguration). */
1524#define VMX_EXIT_SPP_EVENT 66
1525/* UMWAIT. */
1526#define VMX_EXIT_UMWAIT 67
1527/** TPAUSE. */
1528#define VMX_EXIT_TPAUSE 68
1529/** LOADIWKEY. */
1530#define VMX_EXIT_LOADIWKEY 69
1531/** The maximum VM-exit value (inclusive). */
1532#define VMX_EXIT_MAX (VMX_EXIT_LOADIWKEY)
1533/** @} */
1534
1535
1536/** @name VM Instruction Errors.
1537 * In accordance with the VT-x spec.
1538 * See Intel spec. "30.4 VM Instruction Error Numbers"
1539 * @{
1540 */
1541typedef enum
1542{
1543 /** VMCALL executed in VMX root operation. */
1544 VMXINSTRERR_VMCALL_VMXROOTMODE = 1,
1545 /** VMCLEAR with invalid physical address. */
1546 VMXINSTRERR_VMCLEAR_INVALID_PHYSADDR = 2,
1547 /** VMCLEAR with VMXON pointer. */
1548 VMXINSTRERR_VMCLEAR_VMXON_PTR = 3,
1549 /** VMLAUNCH with non-clear VMCS. */
1550 VMXINSTRERR_VMLAUNCH_NON_CLEAR_VMCS = 4,
1551 /** VMRESUME with non-launched VMCS. */
1552 VMXINSTRERR_VMRESUME_NON_LAUNCHED_VMCS = 5,
1553 /** VMRESUME after VMXOFF (VMXOFF and VMXON between VMLAUNCH and VMRESUME). */
1554 VMXINSTRERR_VMRESUME_AFTER_VMXOFF = 6,
1555 /** VM-entry with invalid control field(s). */
1556 VMXINSTRERR_VMENTRY_INVALID_CTLS = 7,
1557 /** VM-entry with invalid host-state field(s). */
1558 VMXINSTRERR_VMENTRY_INVALID_HOST_STATE = 8,
1559 /** VMPTRLD with invalid physical address. */
1560 VMXINSTRERR_VMPTRLD_INVALID_PHYSADDR = 9,
1561 /** VMPTRLD with VMXON pointer. */
1562 VMXINSTRERR_VMPTRLD_VMXON_PTR = 10,
1563 /** VMPTRLD with incorrect VMCS revision identifier. */
1564 VMXINSTRERR_VMPTRLD_INCORRECT_VMCS_REV = 11,
1565 /** VMREAD from unsupported VMCS component. */
1566 VMXINSTRERR_VMREAD_INVALID_COMPONENT = 12,
1567 /** VMWRITE to unsupported VMCS component. */
1568 VMXINSTRERR_VMWRITE_INVALID_COMPONENT = 12,
1569 /** VMWRITE to read-only VMCS component. */
1570 VMXINSTRERR_VMWRITE_RO_COMPONENT = 13,
1571 /** VMXON executed in VMX root operation. */
1572 VMXINSTRERR_VMXON_IN_VMXROOTMODE = 15,
1573 /** VM-entry with invalid executive-VMCS pointer. */
1574 VMXINSTRERR_VMENTRY_EXEC_VMCS_INVALID_PTR = 16,
1575 /** VM-entry with non-launched executive VMCS. */
1576 VMXINSTRERR_VMENTRY_EXEC_VMCS_NON_LAUNCHED = 17,
1577 /** VM-entry with executive-VMCS pointer not VMXON pointer. */
1578 VMXINSTRERR_VMENTRY_EXEC_VMCS_PTR = 18,
1579 /** VMCALL with non-clear VMCS. */
1580 VMXINSTRERR_VMCALL_NON_CLEAR_VMCS = 19,
1581 /** VMCALL with invalid VM-exit control fields. */
1582 VMXINSTRERR_VMCALL_INVALID_EXITCTLS = 20,
1583 /** VMCALL with incorrect MSEG revision identifier. */
1584 VMXINSTRERR_VMCALL_INVALID_MSEG_ID = 22,
1585 /** VMXOFF under dual-monitor treatment of SMIs and SMM. */
1586 VMXINSTRERR_VMXOFF_DUAL_MON = 23,
1587 /** VMCALL with invalid SMM-monitor features. */
1588 VMXINSTRERR_VMCALL_INVALID_SMMCTLS = 24,
1589 /** VM-entry with invalid VM-execution control fields in executive VMCS. */
1590 VMXINSTRERR_VMENTRY_EXEC_VMCS_INVALID_CTLS = 25,
1591 /** VM-entry with events blocked by MOV SS. */
1592 VMXINSTRERR_VMENTRY_BLOCK_MOVSS = 26,
1593 /** Invalid operand to INVEPT/INVVPID. */
1594 VMXINSTRERR_INVEPT_INVVPID_INVALID_OPERAND = 28
1595} VMXINSTRERR;
1596/** @} */
1597
1598
1599/** @name VMX abort reasons.
1600 * In accordance with the VT-x spec.
1601 * See Intel spec. "27.7 VMX Aborts".
1602 * Update HMGetVmxAbortDesc() if new reasons are added.
1603 * @{
1604 */
1605typedef enum
1606{
1607 /** None - don't use this / uninitialized value. */
1608 VMXABORT_NONE = 0,
1609 /** VMX abort caused during saving of guest MSRs. */
1610 VMXABORT_SAVE_GUEST_MSRS = 1,
1611 /** VMX abort caused during host PDPTE checks. */
1612 VMXBOART_HOST_PDPTE = 2,
1613 /** VMX abort caused due to current VMCS being corrupted. */
1614 VMXABORT_CURRENT_VMCS_CORRUPT = 3,
1615 /** VMX abort caused during loading of host MSRs. */
1616 VMXABORT_LOAD_HOST_MSR = 4,
1617 /** VMX abort caused due to a machine-check exception during VM-exit. */
1618 VMXABORT_MACHINE_CHECK_XCPT = 5,
1619 /** VMX abort caused due to invalid return from long mode. */
1620 VMXABORT_HOST_NOT_IN_LONG_MODE = 6,
1621 /* Type size hack. */
1622 VMXABORT_32BIT_HACK = 0x7fffffff
1623} VMXABORT;
1624AssertCompileSize(VMXABORT, 4);
1625/** @} */
1626
1627
1628/** @name VMX MSR - Basic VMX information.
1629 * @{
1630 */
1631/** VMCS (and related regions) memory type - Uncacheable. */
1632#define VMX_BASIC_MEM_TYPE_UC 0
1633/** VMCS (and related regions) memory type - Write back. */
1634#define VMX_BASIC_MEM_TYPE_WB 6
1635/** Width of physical addresses used for VMCS and associated memory regions
1636 * (1=32-bit, 0=processor's physical address width). */
1637#define VMX_BASIC_PHYSADDR_WIDTH_32BIT RT_BIT_64(48)
1638
1639/** Bit fields for MSR_IA32_VMX_BASIC. */
1640/** VMCS revision identifier used by the processor. */
1641#define VMX_BF_BASIC_VMCS_ID_SHIFT 0
1642#define VMX_BF_BASIC_VMCS_ID_MASK UINT64_C(0x000000007fffffff)
1643/** Bit 31 is reserved and RAZ. */
1644#define VMX_BF_BASIC_RSVD_32_SHIFT 31
1645#define VMX_BF_BASIC_RSVD_32_MASK UINT64_C(0x0000000080000000)
1646/** VMCS size in bytes. */
1647#define VMX_BF_BASIC_VMCS_SIZE_SHIFT 32
1648#define VMX_BF_BASIC_VMCS_SIZE_MASK UINT64_C(0x00001fff00000000)
1649/** Bits 45:47 are reserved. */
1650#define VMX_BF_BASIC_RSVD_45_47_SHIFT 45
1651#define VMX_BF_BASIC_RSVD_45_47_MASK UINT64_C(0x0000e00000000000)
1652/** Width of physical addresses used for the VMCS and associated memory regions
1653 * (always 0 on CPUs that support Intel 64 architecture). */
1654#define VMX_BF_BASIC_PHYSADDR_WIDTH_SHIFT 48
1655#define VMX_BF_BASIC_PHYSADDR_WIDTH_MASK UINT64_C(0x0001000000000000)
1656/** Dual-monitor treatment of SMI and SMM supported. */
1657#define VMX_BF_BASIC_DUAL_MON_SHIFT 49
1658#define VMX_BF_BASIC_DUAL_MON_MASK UINT64_C(0x0002000000000000)
1659/** Memory type that must be used for the VMCS and associated memory regions. */
1660#define VMX_BF_BASIC_VMCS_MEM_TYPE_SHIFT 50
1661#define VMX_BF_BASIC_VMCS_MEM_TYPE_MASK UINT64_C(0x003c000000000000)
1662/** VM-exit instruction information for INS/OUTS. */
1663#define VMX_BF_BASIC_VMCS_INS_OUTS_SHIFT 54
1664#define VMX_BF_BASIC_VMCS_INS_OUTS_MASK UINT64_C(0x0040000000000000)
1665/** Whether 'true' VMX controls MSRs are supported for handling of default1 class
1666 * bits in VMX control MSRs. */
1667#define VMX_BF_BASIC_TRUE_CTLS_SHIFT 55
1668#define VMX_BF_BASIC_TRUE_CTLS_MASK UINT64_C(0x0080000000000000)
1669/** Whether VM-entry can delivery error code for all hardware exception vectors. */
1670#define VMX_BF_BASIC_XCPT_ERRCODE_SHIFT 56
1671#define VMX_BF_BASIC_XCPT_ERRCODE_MASK UINT64_C(0x0100000000000000)
1672/** Bits 57:63 are reserved and RAZ. */
1673#define VMX_BF_BASIC_RSVD_56_63_SHIFT 57
1674#define VMX_BF_BASIC_RSVD_56_63_MASK UINT64_C(0xfe00000000000000)
1675RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_BASIC_, UINT64_C(0), UINT64_MAX,
1676 (VMCS_ID, RSVD_32, VMCS_SIZE, RSVD_45_47, PHYSADDR_WIDTH, DUAL_MON, VMCS_MEM_TYPE,
1677 VMCS_INS_OUTS, TRUE_CTLS, XCPT_ERRCODE, RSVD_56_63));
1678/** @} */
1679
1680
1681/** @name VMX MSR - Miscellaneous data.
1682 * @{
1683 */
1684/** Whether VM-exit stores EFER.LMA into the "IA32e mode guest" field. */
1685#define VMX_MISC_EXIT_SAVE_EFER_LMA RT_BIT(5)
1686/** Whether Intel PT is supported in VMX operation. */
1687#define VMX_MISC_INTEL_PT RT_BIT(14)
1688/** Whether VMWRITE to any valid VMCS field incl. read-only fields, otherwise
1689 * VMWRITE cannot modify read-only VM-exit information fields. */
1690#define VMX_MISC_VMWRITE_ALL RT_BIT(29)
1691/** Whether VM-entry can inject software interrupts, INT1 (ICEBP) with 0-length
1692 * instructions. */
1693#define VMX_MISC_ENTRY_INJECT_SOFT_INT RT_BIT(30)
1694/** Maximum number of MSRs in the auto-load/store MSR areas, (n+1) * 512. */
1695#define VMX_MISC_MAX_MSRS(a_MiscMsr) (512 * (RT_BF_GET((a_MiscMsr), VMX_BF_MISC_MAX_MSRS) + 1))
1696/** Maximum CR3-target count supported by the CPU. */
1697#define VMX_MISC_CR3_TARGET_COUNT(a_MiscMsr) (((a) >> 16) & 0xff)
1698
1699/** Bit fields for MSR_IA32_VMX_MISC. */
1700/** Relationship between the preemption timer and tsc. */
1701#define VMX_BF_MISC_PREEMPT_TIMER_TSC_SHIFT 0
1702#define VMX_BF_MISC_PREEMPT_TIMER_TSC_MASK UINT64_C(0x000000000000001f)
1703/** Whether VM-exit stores EFER.LMA into the "IA32e mode guest" field. */
1704#define VMX_BF_MISC_EXIT_SAVE_EFER_LMA_SHIFT 5
1705#define VMX_BF_MISC_EXIT_SAVE_EFER_LMA_MASK UINT64_C(0x0000000000000020)
1706/** Activity states supported by the implementation. */
1707#define VMX_BF_MISC_ACTIVITY_STATES_SHIFT 6
1708#define VMX_BF_MISC_ACTIVITY_STATES_MASK UINT64_C(0x00000000000001c0)
1709/** Bits 9:13 is reserved and RAZ. */
1710#define VMX_BF_MISC_RSVD_9_13_SHIFT 9
1711#define VMX_BF_MISC_RSVD_9_13_MASK UINT64_C(0x0000000000003e00)
1712/** Whether Intel PT (Processor Trace) can be used in VMX operation. */
1713#define VMX_BF_MISC_INTEL_PT_SHIFT 14
1714#define VMX_BF_MISC_INTEL_PT_MASK UINT64_C(0x0000000000004000)
1715/** Whether RDMSR can be used to read IA32_SMBASE MSR in SMM. */
1716#define VMX_BF_MISC_SMM_READ_SMBASE_MSR_SHIFT 15
1717#define VMX_BF_MISC_SMM_READ_SMBASE_MSR_MASK UINT64_C(0x0000000000008000)
1718/** Number of CR3 target values supported by the processor. (0-256) */
1719#define VMX_BF_MISC_CR3_TARGET_SHIFT 16
1720#define VMX_BF_MISC_CR3_TARGET_MASK UINT64_C(0x0000000001ff0000)
1721/** Maximum number of MSRs in the VMCS. */
1722#define VMX_BF_MISC_MAX_MSRS_SHIFT 25
1723#define VMX_BF_MISC_MAX_MSRS_MASK UINT64_C(0x000000000e000000)
1724/** Whether IA32_SMM_MONITOR_CTL MSR can be modified to allow VMXOFF to block
1725 * SMIs. */
1726#define VMX_BF_MISC_VMXOFF_BLOCK_SMI_SHIFT 28
1727#define VMX_BF_MISC_VMXOFF_BLOCK_SMI_MASK UINT64_C(0x0000000010000000)
1728/** Whether VMWRITE to any valid VMCS field incl. read-only fields, otherwise
1729 * VMWRITE cannot modify read-only VM-exit information fields. */
1730#define VMX_BF_MISC_VMWRITE_ALL_SHIFT 29
1731#define VMX_BF_MISC_VMWRITE_ALL_MASK UINT64_C(0x0000000020000000)
1732/** Whether VM-entry can inject software interrupts, INT1 (ICEBP) with 0-length
1733 * instructions. */
1734#define VMX_BF_MISC_ENTRY_INJECT_SOFT_INT_SHIFT 30
1735#define VMX_BF_MISC_ENTRY_INJECT_SOFT_INT_MASK UINT64_C(0x0000000040000000)
1736/** Bit 31 is reserved and RAZ. */
1737#define VMX_BF_MISC_RSVD_31_SHIFT 31
1738#define VMX_BF_MISC_RSVD_31_MASK UINT64_C(0x0000000080000000)
1739/** 32-bit MSEG revision ID used by the processor. */
1740#define VMX_BF_MISC_MSEG_ID_SHIFT 32
1741#define VMX_BF_MISC_MSEG_ID_MASK UINT64_C(0xffffffff00000000)
1742RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_MISC_, UINT64_C(0), UINT64_MAX,
1743 (PREEMPT_TIMER_TSC, EXIT_SAVE_EFER_LMA, ACTIVITY_STATES, RSVD_9_13, INTEL_PT, SMM_READ_SMBASE_MSR,
1744 CR3_TARGET, MAX_MSRS, VMXOFF_BLOCK_SMI, VMWRITE_ALL, ENTRY_INJECT_SOFT_INT, RSVD_31, MSEG_ID));
1745/** @} */
1746
1747/** @name VMX MSR - VMCS enumeration.
1748 * Bit fields for MSR_IA32_VMX_VMCS_ENUM.
1749 * @{
1750 */
1751/** Bit 0 is reserved and RAZ. */
1752#define VMX_BF_VMCS_ENUM_RSVD_0_SHIFT 0
1753#define VMX_BF_VMCS_ENUM_RSVD_0_MASK UINT64_C(0x0000000000000001)
1754/** Highest index value used in VMCS field encoding. */
1755#define VMX_BF_VMCS_ENUM_HIGHEST_IDX_SHIFT 1
1756#define VMX_BF_VMCS_ENUM_HIGHEST_IDX_MASK UINT64_C(0x00000000000003fe)
1757/** Bit 10:63 is reserved and RAZ. */
1758#define VMX_BF_VMCS_ENUM_RSVD_10_63_SHIFT 10
1759#define VMX_BF_VMCS_ENUM_RSVD_10_63_MASK UINT64_C(0xfffffffffffffc00)
1760RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMCS_ENUM_, UINT64_C(0), UINT64_MAX,
1761 (RSVD_0, HIGHEST_IDX, RSVD_10_63));
1762/** @} */
1763
1764
1765/** @name VMX MSR - VM Functions.
1766 * Bit fields for MSR_IA32_VMX_VMFUNC.
1767 * @{
1768 */
1769/** EPTP-switching function changes the value of the EPTP to one chosen from the EPTP list. */
1770#define VMX_BF_VMFUNC_EPTP_SWITCHING_SHIFT 0
1771#define VMX_BF_VMFUNC_EPTP_SWITCHING_MASK UINT64_C(0x0000000000000001)
1772/** Bits 1:63 are reserved and RAZ. */
1773#define VMX_BF_VMFUNC_RSVD_1_63_SHIFT 1
1774#define VMX_BF_VMFUNC_RSVD_1_63_MASK UINT64_C(0xfffffffffffffffe)
1775RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMFUNC_, UINT64_C(0), UINT64_MAX,
1776 (EPTP_SWITCHING, RSVD_1_63));
1777/** @} */
1778
1779
1780/** @name VMX MSR - EPT/VPID capabilities.
1781 * @{
1782 */
1783/** Supports execute-only translations by EPT. */
1784#define MSR_IA32_VMX_EPT_VPID_CAP_RWX_X_ONLY RT_BIT_64(0)
1785/** Supports page-walk length of 4. */
1786#define MSR_IA32_VMX_EPT_VPID_CAP_PAGE_WALK_LENGTH_4 RT_BIT_64(6)
1787/** Supports page-walk length of 5. */
1788#define MSR_IA32_VMX_EPT_VPID_CAP_PAGE_WALK_LENGTH_5 RT_BIT_64(7)
1789/** Supports EPT paging-structure memory type to be uncacheable. */
1790#define MSR_IA32_VMX_EPT_VPID_CAP_MEMTYPE_UC RT_BIT_64(8)
1791/** Supports EPT paging structure memory type to be write-back. */
1792#define MSR_IA32_VMX_EPT_VPID_CAP_MEMTYPE_WB RT_BIT_64(14)
1793/** Supports EPT PDE to map a 2 MB page. */
1794#define MSR_IA32_VMX_EPT_VPID_CAP_PDE_2M RT_BIT_64(16)
1795/** Supports EPT PDPTE to map a 1 GB page. */
1796#define MSR_IA32_VMX_EPT_VPID_CAP_PDPTE_1G RT_BIT_64(17)
1797/** Supports INVEPT instruction. */
1798#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT RT_BIT_64(20)
1799/** Supports accessed and dirty flags for EPT. */
1800#define MSR_IA32_VMX_EPT_VPID_CAP_ACCESS_DIRTY RT_BIT_64(21)
1801/** Supports advanced VM-exit info. for EPT violations. */
1802#define MSR_IA32_VMX_EPT_VPID_CAP_ADVEXITINFO_EPT_VIOLATION RT_BIT_64(22)
1803/** Supports supervisor shadow-stack control. */
1804#define MSR_IA32_VMX_EPT_VPID_CAP_SUPER_SHW_STACK RT_BIT_64(23)
1805/** Supports single-context INVEPT type. */
1806#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT_SINGLE_CONTEXT RT_BIT_64(25)
1807/** Supports all-context INVEPT type. */
1808#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT_ALL_CONTEXTS RT_BIT_64(26)
1809/** Supports INVVPID instruction. */
1810#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID RT_BIT_64(32)
1811/** Supports individual-address INVVPID type. */
1812#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_INDIV_ADDR RT_BIT_64(40)
1813/** Supports single-context INVVPID type. */
1814#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT RT_BIT_64(41)
1815/** Supports all-context INVVPID type. */
1816#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_ALL_CONTEXTS RT_BIT_64(42)
1817/** Supports singe-context-retaining-globals INVVPID type. */
1818#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT_RETAIN_GLOBALS RT_BIT_64(43)
1819
1820/** Bit fields for MSR_IA32_VMX_EPT_VPID_CAP. */
1821#define VMX_BF_EPT_VPID_CAP_EXEC_ONLY_SHIFT 0
1822#define VMX_BF_EPT_VPID_CAP_EXEC_ONLY_MASK UINT64_C(0x0000000000000001)
1823#define VMX_BF_EPT_VPID_CAP_RSVD_1_5_SHIFT 1
1824#define VMX_BF_EPT_VPID_CAP_RSVD_1_5_MASK UINT64_C(0x000000000000003e)
1825#define VMX_BF_EPT_VPID_CAP_PAGE_WALK_LENGTH_4_SHIFT 6
1826#define VMX_BF_EPT_VPID_CAP_PAGE_WALK_LENGTH_4_MASK UINT64_C(0x0000000000000040)
1827#define VMX_BF_EPT_VPID_CAP_RSVD_7_SHIFT 7
1828#define VMX_BF_EPT_VPID_CAP_RSVD_7_MASK UINT64_C(0x0000000000000080)
1829#define VMX_BF_EPT_VPID_CAP_MEMTYPE_UC_SHIFT 8
1830#define VMX_BF_EPT_VPID_CAP_MEMTYPE_UC_MASK UINT64_C(0x0000000000000100)
1831#define VMX_BF_EPT_VPID_CAP_RSVD_9_13_SHIFT 9
1832#define VMX_BF_EPT_VPID_CAP_RSVD_9_13_MASK UINT64_C(0x0000000000003e00)
1833#define VMX_BF_EPT_VPID_CAP_MEMTYPE_WB_SHIFT 14
1834#define VMX_BF_EPT_VPID_CAP_MEMTYPE_WB_MASK UINT64_C(0x0000000000004000)
1835#define VMX_BF_EPT_VPID_CAP_RSVD_15_SHIFT 15
1836#define VMX_BF_EPT_VPID_CAP_RSVD_15_MASK UINT64_C(0x0000000000008000)
1837#define VMX_BF_EPT_VPID_CAP_PDE_2M_SHIFT 16
1838#define VMX_BF_EPT_VPID_CAP_PDE_2M_MASK UINT64_C(0x0000000000010000)
1839#define VMX_BF_EPT_VPID_CAP_PDPTE_1G_SHIFT 17
1840#define VMX_BF_EPT_VPID_CAP_PDPTE_1G_MASK UINT64_C(0x0000000000020000)
1841#define VMX_BF_EPT_VPID_CAP_RSVD_18_19_SHIFT 18
1842#define VMX_BF_EPT_VPID_CAP_RSVD_18_19_MASK UINT64_C(0x00000000000c0000)
1843#define VMX_BF_EPT_VPID_CAP_INVEPT_SHIFT 20
1844#define VMX_BF_EPT_VPID_CAP_INVEPT_MASK UINT64_C(0x0000000000100000)
1845#define VMX_BF_EPT_VPID_CAP_ACCESS_DIRTY_SHIFT 21
1846#define VMX_BF_EPT_VPID_CAP_ACCESS_DIRTY_MASK UINT64_C(0x0000000000200000)
1847#define VMX_BF_EPT_VPID_CAP_ADVEXITINFO_EPT_VIOLATION_SHIFT 22
1848#define VMX_BF_EPT_VPID_CAP_ADVEXITINFO_EPT_VIOLATION_MASK UINT64_C(0x0000000000400000)
1849#define VMX_BF_EPT_VPID_CAP_SUPER_SHW_STACK_SHIFT 23
1850#define VMX_BF_EPT_VPID_CAP_SUPER_SHW_STACK_MASK UINT64_C(0x0000000000800000)
1851#define VMX_BF_EPT_VPID_CAP_RSVD_24_SHIFT 24
1852#define VMX_BF_EPT_VPID_CAP_RSVD_24_MASK UINT64_C(0x0000000001000000)
1853#define VMX_BF_EPT_VPID_CAP_INVEPT_SINGLE_CTX_SHIFT 25
1854#define VMX_BF_EPT_VPID_CAP_INVEPT_SINGLE_CTX_MASK UINT64_C(0x0000000002000000)
1855#define VMX_BF_EPT_VPID_CAP_INVEPT_ALL_CTX_SHIFT 26
1856#define VMX_BF_EPT_VPID_CAP_INVEPT_ALL_CTX_MASK UINT64_C(0x0000000004000000)
1857#define VMX_BF_EPT_VPID_CAP_RSVD_27_31_SHIFT 27
1858#define VMX_BF_EPT_VPID_CAP_RSVD_27_31_MASK UINT64_C(0x00000000f8000000)
1859#define VMX_BF_EPT_VPID_CAP_INVVPID_SHIFT 32
1860#define VMX_BF_EPT_VPID_CAP_INVVPID_MASK UINT64_C(0x0000000100000000)
1861#define VMX_BF_EPT_VPID_CAP_RSVD_33_39_SHIFT 33
1862#define VMX_BF_EPT_VPID_CAP_RSVD_33_39_MASK UINT64_C(0x000000fe00000000)
1863#define VMX_BF_EPT_VPID_CAP_INVVPID_INDIV_ADDR_SHIFT 40
1864#define VMX_BF_EPT_VPID_CAP_INVVPID_INDIV_ADDR_MASK UINT64_C(0x0000010000000000)
1865#define VMX_BF_EPT_VPID_CAP_INVVPID_SINGLE_CTX_SHIFT 41
1866#define VMX_BF_EPT_VPID_CAP_INVVPID_SINGLE_CTX_MASK UINT64_C(0x0000020000000000)
1867#define VMX_BF_EPT_VPID_CAP_INVVPID_ALL_CTX_SHIFT 42
1868#define VMX_BF_EPT_VPID_CAP_INVVPID_ALL_CTX_MASK UINT64_C(0x0000040000000000)
1869#define VMX_BF_EPT_VPID_CAP_INVVPID_SINGLE_CTX_RETAIN_GLOBALS_SHIFT 43
1870#define VMX_BF_EPT_VPID_CAP_INVVPID_SINGLE_CTX_RETAIN_GLOBALS_MASK UINT64_C(0x0000080000000000)
1871#define VMX_BF_EPT_VPID_CAP_RSVD_44_63_SHIFT 44
1872#define VMX_BF_EPT_VPID_CAP_RSVD_44_63_MASK UINT64_C(0xfffff00000000000)
1873RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EPT_VPID_CAP_, UINT64_C(0), UINT64_MAX,
1874 (EXEC_ONLY, RSVD_1_5, PAGE_WALK_LENGTH_4, RSVD_7, MEMTYPE_UC, RSVD_9_13, MEMTYPE_WB, RSVD_15, PDE_2M,
1875 PDPTE_1G, RSVD_18_19, INVEPT, ACCESS_DIRTY, ADVEXITINFO_EPT_VIOLATION, SUPER_SHW_STACK, RSVD_24,
1876 INVEPT_SINGLE_CTX, INVEPT_ALL_CTX, RSVD_27_31, INVVPID, RSVD_33_39, INVVPID_INDIV_ADDR,
1877 INVVPID_SINGLE_CTX, INVVPID_ALL_CTX, INVVPID_SINGLE_CTX_RETAIN_GLOBALS, RSVD_44_63));
1878/** @} */
1879
1880
1881/** @name Extended Page Table Pointer (EPTP)
1882 * In accordance with the VT-x spec.
1883 * See Intel spec. 23.6.11 "Extended-Page-Table Pointer (EPTP)".
1884 * @{
1885 */
1886/** EPTP memory type: Uncachable. */
1887#define VMX_EPTP_MEMTYPE_UC 0
1888/** EPTP memory type: Write Back. */
1889#define VMX_EPTP_MEMTYPE_WB 6
1890/** Page-walk length for PML4 (4-level paging). */
1891#define VMX_EPTP_PAGE_WALK_LENGTH_4 3
1892
1893/** Bit fields for EPTP. */
1894#define VMX_BF_EPTP_MEMTYPE_SHIFT 0
1895#define VMX_BF_EPTP_MEMTYPE_MASK UINT64_C(0x0000000000000007)
1896#define VMX_BF_EPTP_PAGE_WALK_LENGTH_SHIFT 3
1897#define VMX_BF_EPTP_PAGE_WALK_LENGTH_MASK UINT64_C(0x0000000000000038)
1898#define VMX_BF_EPTP_ACCESS_DIRTY_SHIFT 6
1899#define VMX_BF_EPTP_ACCESS_DIRTY_MASK UINT64_C(0x0000000000000040)
1900#define VMX_BF_EPTP_SUPER_SHW_STACK_SHIFT 7
1901#define VMX_BF_EPTP_SUPER_SHW_STACK_MASK UINT64_C(0x0000000000000080)
1902#define VMX_BF_EPTP_RSVD_8_11_SHIFT 8
1903#define VMX_BF_EPTP_RSVD_8_11_MASK UINT64_C(0x0000000000000f00)
1904#define VMX_BF_EPTP_PML4_TABLE_ADDR_SHIFT 12
1905#define VMX_BF_EPTP_PML4_TABLE_ADDR_MASK UINT64_C(0xfffffffffffff000)
1906RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EPTP_, UINT64_C(0), UINT64_MAX,
1907 (MEMTYPE, PAGE_WALK_LENGTH, ACCESS_DIRTY, SUPER_SHW_STACK, RSVD_8_11, PML4_TABLE_ADDR));
1908
1909/* Mask of valid EPTP bits sans physically non-addressable bits. */
1910#define VMX_EPTP_VALID_MASK ( VMX_BF_EPTP_MEMTYPE_MASK \
1911 | VMX_BF_EPTP_PAGE_WALK_LENGTH_MASK \
1912 | VMX_BF_EPTP_ACCESS_DIRTY_MASK \
1913 | VMX_BF_EPTP_SUPER_SHW_STACK_MASK \
1914 | VMX_BF_EPTP_PML4_TABLE_ADDR_MASK)
1915/** @} */
1916
1917
1918/** @name VMCS fields and encoding.
1919 *
1920 * When adding a new field:
1921 * - Always add it to g_aVmcsFields.
1922 * - Consider if it needs to be added to VMXVVMCS.
1923 * @{
1924 */
1925/** 16-bit control fields. */
1926#define VMX_VMCS16_VPID 0x0000
1927#define VMX_VMCS16_POSTED_INT_NOTIFY_VECTOR 0x0002
1928#define VMX_VMCS16_EPTP_INDEX 0x0004
1929
1930/** 16-bit guest-state fields. */
1931#define VMX_VMCS16_GUEST_ES_SEL 0x0800
1932#define VMX_VMCS16_GUEST_CS_SEL 0x0802
1933#define VMX_VMCS16_GUEST_SS_SEL 0x0804
1934#define VMX_VMCS16_GUEST_DS_SEL 0x0806
1935#define VMX_VMCS16_GUEST_FS_SEL 0x0808
1936#define VMX_VMCS16_GUEST_GS_SEL 0x080a
1937#define VMX_VMCS16_GUEST_LDTR_SEL 0x080c
1938#define VMX_VMCS16_GUEST_TR_SEL 0x080e
1939#define VMX_VMCS16_GUEST_INTR_STATUS 0x0810
1940#define VMX_VMCS16_GUEST_PML_INDEX 0x0812
1941
1942/** 16-bits host-state fields. */
1943#define VMX_VMCS16_HOST_ES_SEL 0x0c00
1944#define VMX_VMCS16_HOST_CS_SEL 0x0c02
1945#define VMX_VMCS16_HOST_SS_SEL 0x0c04
1946#define VMX_VMCS16_HOST_DS_SEL 0x0c06
1947#define VMX_VMCS16_HOST_FS_SEL 0x0c08
1948#define VMX_VMCS16_HOST_GS_SEL 0x0c0a
1949#define VMX_VMCS16_HOST_TR_SEL 0x0c0c
1950
1951/** 64-bit control fields. */
1952#define VMX_VMCS64_CTRL_IO_BITMAP_A_FULL 0x2000
1953#define VMX_VMCS64_CTRL_IO_BITMAP_A_HIGH 0x2001
1954#define VMX_VMCS64_CTRL_IO_BITMAP_B_FULL 0x2002
1955#define VMX_VMCS64_CTRL_IO_BITMAP_B_HIGH 0x2003
1956#define VMX_VMCS64_CTRL_MSR_BITMAP_FULL 0x2004
1957#define VMX_VMCS64_CTRL_MSR_BITMAP_HIGH 0x2005
1958#define VMX_VMCS64_CTRL_EXIT_MSR_STORE_FULL 0x2006
1959#define VMX_VMCS64_CTRL_EXIT_MSR_STORE_HIGH 0x2007
1960#define VMX_VMCS64_CTRL_EXIT_MSR_LOAD_FULL 0x2008
1961#define VMX_VMCS64_CTRL_EXIT_MSR_LOAD_HIGH 0x2009
1962#define VMX_VMCS64_CTRL_ENTRY_MSR_LOAD_FULL 0x200a
1963#define VMX_VMCS64_CTRL_ENTRY_MSR_LOAD_HIGH 0x200b
1964#define VMX_VMCS64_CTRL_EXEC_VMCS_PTR_FULL 0x200c
1965#define VMX_VMCS64_CTRL_EXEC_VMCS_PTR_HIGH 0x200d
1966#define VMX_VMCS64_CTRL_EXEC_PML_ADDR_FULL 0x200e
1967#define VMX_VMCS64_CTRL_EXEC_PML_ADDR_HIGH 0x200f
1968#define VMX_VMCS64_CTRL_TSC_OFFSET_FULL 0x2010
1969#define VMX_VMCS64_CTRL_TSC_OFFSET_HIGH 0x2011
1970#define VMX_VMCS64_CTRL_VIRT_APIC_PAGEADDR_FULL 0x2012
1971#define VMX_VMCS64_CTRL_VIRT_APIC_PAGEADDR_HIGH 0x2013
1972#define VMX_VMCS64_CTRL_APIC_ACCESSADDR_FULL 0x2014
1973#define VMX_VMCS64_CTRL_APIC_ACCESSADDR_HIGH 0x2015
1974#define VMX_VMCS64_CTRL_POSTED_INTR_DESC_FULL 0x2016
1975#define VMX_VMCS64_CTRL_POSTED_INTR_DESC_HIGH 0x2017
1976#define VMX_VMCS64_CTRL_VMFUNC_CTRLS_FULL 0x2018
1977#define VMX_VMCS64_CTRL_VMFUNC_CTRLS_HIGH 0x2019
1978#define VMX_VMCS64_CTRL_EPTP_FULL 0x201a
1979#define VMX_VMCS64_CTRL_EPTP_HIGH 0x201b
1980#define VMX_VMCS64_CTRL_EOI_BITMAP_0_FULL 0x201c
1981#define VMX_VMCS64_CTRL_EOI_BITMAP_0_HIGH 0x201d
1982#define VMX_VMCS64_CTRL_EOI_BITMAP_1_FULL 0x201e
1983#define VMX_VMCS64_CTRL_EOI_BITMAP_1_HIGH 0x201f
1984#define VMX_VMCS64_CTRL_EOI_BITMAP_2_FULL 0x2020
1985#define VMX_VMCS64_CTRL_EOI_BITMAP_2_HIGH 0x2021
1986#define VMX_VMCS64_CTRL_EOI_BITMAP_3_FULL 0x2022
1987#define VMX_VMCS64_CTRL_EOI_BITMAP_3_HIGH 0x2023
1988#define VMX_VMCS64_CTRL_EPTP_LIST_FULL 0x2024
1989#define VMX_VMCS64_CTRL_EPTP_LIST_HIGH 0x2025
1990#define VMX_VMCS64_CTRL_VMREAD_BITMAP_FULL 0x2026
1991#define VMX_VMCS64_CTRL_VMREAD_BITMAP_HIGH 0x2027
1992#define VMX_VMCS64_CTRL_VMWRITE_BITMAP_FULL 0x2028
1993#define VMX_VMCS64_CTRL_VMWRITE_BITMAP_HIGH 0x2029
1994#define VMX_VMCS64_CTRL_VE_XCPT_INFO_ADDR_FULL 0x202a
1995#define VMX_VMCS64_CTRL_VE_XCPT_INFO_ADDR_HIGH 0x202b
1996#define VMX_VMCS64_CTRL_XSS_EXITING_BITMAP_FULL 0x202c
1997#define VMX_VMCS64_CTRL_XSS_EXITING_BITMAP_HIGH 0x202d
1998#define VMX_VMCS64_CTRL_ENCLS_EXITING_BITMAP_FULL 0x202e
1999#define VMX_VMCS64_CTRL_ENCLS_EXITING_BITMAP_HIGH 0x202f
2000#define VMX_VMCS64_CTRL_SPPTP_FULL 0x2030
2001#define VMX_VMCS64_CTRL_SPPTP_HIGH 0x2031
2002#define VMX_VMCS64_CTRL_TSC_MULTIPLIER_FULL 0x2032
2003#define VMX_VMCS64_CTRL_TSC_MULTIPLIER_HIGH 0x2033
2004#define VMX_VMCS64_CTRL_PROC_EXEC3_FULL 0x2034
2005#define VMX_VMCS64_CTRL_PROC_EXEC3_HIGH 0x2035
2006#define VMX_VMCS64_CTRL_ENCLV_EXITING_BITMAP_FULL 0x2036
2007#define VMX_VMCS64_CTRL_ENCLV_EXITING_BITMAP_HIGH 0x2037
2008
2009/** 64-bit read-only data fields. */
2010#define VMX_VMCS64_RO_GUEST_PHYS_ADDR_FULL 0x2400
2011#define VMX_VMCS64_RO_GUEST_PHYS_ADDR_HIGH 0x2401
2012
2013/** 64-bit guest-state fields. */
2014#define VMX_VMCS64_GUEST_VMCS_LINK_PTR_FULL 0x2800
2015#define VMX_VMCS64_GUEST_VMCS_LINK_PTR_HIGH 0x2801
2016#define VMX_VMCS64_GUEST_DEBUGCTL_FULL 0x2802
2017#define VMX_VMCS64_GUEST_DEBUGCTL_HIGH 0x2803
2018#define VMX_VMCS64_GUEST_PAT_FULL 0x2804
2019#define VMX_VMCS64_GUEST_PAT_HIGH 0x2805
2020#define VMX_VMCS64_GUEST_EFER_FULL 0x2806
2021#define VMX_VMCS64_GUEST_EFER_HIGH 0x2807
2022#define VMX_VMCS64_GUEST_PERF_GLOBAL_CTRL_FULL 0x2808
2023#define VMX_VMCS64_GUEST_PERF_GLOBAL_CTRL_HIGH 0x2809
2024#define VMX_VMCS64_GUEST_PDPTE0_FULL 0x280a
2025#define VMX_VMCS64_GUEST_PDPTE0_HIGH 0x280b
2026#define VMX_VMCS64_GUEST_PDPTE1_FULL 0x280c
2027#define VMX_VMCS64_GUEST_PDPTE1_HIGH 0x280d
2028#define VMX_VMCS64_GUEST_PDPTE2_FULL 0x280e
2029#define VMX_VMCS64_GUEST_PDPTE2_HIGH 0x280f
2030#define VMX_VMCS64_GUEST_PDPTE3_FULL 0x2810
2031#define VMX_VMCS64_GUEST_PDPTE3_HIGH 0x2811
2032#define VMX_VMCS64_GUEST_BNDCFGS_FULL 0x2812
2033#define VMX_VMCS64_GUEST_BNDCFGS_HIGH 0x2813
2034#define VMX_VMCS64_GUEST_RTIT_CTL_FULL 0x2814
2035#define VMX_VMCS64_GUEST_RTIT_CTL_HIGH 0x2815
2036#define VMX_VMCS64_GUEST_PKRS_FULL 0x2818
2037#define VMX_VMCS64_GUEST_PKRS_HIGH 0x2819
2038
2039/** 64-bit host-state fields. */
2040#define VMX_VMCS64_HOST_PAT_FULL 0x2c00
2041#define VMX_VMCS64_HOST_PAT_HIGH 0x2c01
2042#define VMX_VMCS64_HOST_EFER_FULL 0x2c02
2043#define VMX_VMCS64_HOST_EFER_HIGH 0x2c03
2044#define VMX_VMCS64_HOST_PERF_GLOBAL_CTRL_FULL 0x2c04
2045#define VMX_VMCS64_HOST_PERF_GLOBAL_CTRL_HIGH 0x2c05
2046#define VMX_VMCS64_HOST_PKRS_FULL 0x2c06
2047#define VMX_VMCS64_HOST_PKRS_HIGH 0x2c07
2048
2049/** 32-bit control fields. */
2050#define VMX_VMCS32_CTRL_PIN_EXEC 0x4000
2051#define VMX_VMCS32_CTRL_PROC_EXEC 0x4002
2052#define VMX_VMCS32_CTRL_EXCEPTION_BITMAP 0x4004
2053#define VMX_VMCS32_CTRL_PAGEFAULT_ERROR_MASK 0x4006
2054#define VMX_VMCS32_CTRL_PAGEFAULT_ERROR_MATCH 0x4008
2055#define VMX_VMCS32_CTRL_CR3_TARGET_COUNT 0x400a
2056#define VMX_VMCS32_CTRL_EXIT 0x400c
2057#define VMX_VMCS32_CTRL_EXIT_MSR_STORE_COUNT 0x400e
2058#define VMX_VMCS32_CTRL_EXIT_MSR_LOAD_COUNT 0x4010
2059#define VMX_VMCS32_CTRL_ENTRY 0x4012
2060#define VMX_VMCS32_CTRL_ENTRY_MSR_LOAD_COUNT 0x4014
2061#define VMX_VMCS32_CTRL_ENTRY_INTERRUPTION_INFO 0x4016
2062#define VMX_VMCS32_CTRL_ENTRY_EXCEPTION_ERRCODE 0x4018
2063#define VMX_VMCS32_CTRL_ENTRY_INSTR_LENGTH 0x401a
2064#define VMX_VMCS32_CTRL_TPR_THRESHOLD 0x401c
2065#define VMX_VMCS32_CTRL_PROC_EXEC2 0x401e
2066#define VMX_VMCS32_CTRL_PLE_GAP 0x4020
2067#define VMX_VMCS32_CTRL_PLE_WINDOW 0x4022
2068
2069/** 32-bits read-only fields. */
2070#define VMX_VMCS32_RO_VM_INSTR_ERROR 0x4400
2071#define VMX_VMCS32_RO_EXIT_REASON 0x4402
2072#define VMX_VMCS32_RO_EXIT_INTERRUPTION_INFO 0x4404
2073#define VMX_VMCS32_RO_EXIT_INTERRUPTION_ERROR_CODE 0x4406
2074#define VMX_VMCS32_RO_IDT_VECTORING_INFO 0x4408
2075#define VMX_VMCS32_RO_IDT_VECTORING_ERROR_CODE 0x440a
2076#define VMX_VMCS32_RO_EXIT_INSTR_LENGTH 0x440c
2077#define VMX_VMCS32_RO_EXIT_INSTR_INFO 0x440e
2078
2079/** 32-bit guest-state fields. */
2080#define VMX_VMCS32_GUEST_ES_LIMIT 0x4800
2081#define VMX_VMCS32_GUEST_CS_LIMIT 0x4802
2082#define VMX_VMCS32_GUEST_SS_LIMIT 0x4804
2083#define VMX_VMCS32_GUEST_DS_LIMIT 0x4806
2084#define VMX_VMCS32_GUEST_FS_LIMIT 0x4808
2085#define VMX_VMCS32_GUEST_GS_LIMIT 0x480a
2086#define VMX_VMCS32_GUEST_LDTR_LIMIT 0x480c
2087#define VMX_VMCS32_GUEST_TR_LIMIT 0x480e
2088#define VMX_VMCS32_GUEST_GDTR_LIMIT 0x4810
2089#define VMX_VMCS32_GUEST_IDTR_LIMIT 0x4812
2090#define VMX_VMCS32_GUEST_ES_ACCESS_RIGHTS 0x4814
2091#define VMX_VMCS32_GUEST_CS_ACCESS_RIGHTS 0x4816
2092#define VMX_VMCS32_GUEST_SS_ACCESS_RIGHTS 0x4818
2093#define VMX_VMCS32_GUEST_DS_ACCESS_RIGHTS 0x481a
2094#define VMX_VMCS32_GUEST_FS_ACCESS_RIGHTS 0x481c
2095#define VMX_VMCS32_GUEST_GS_ACCESS_RIGHTS 0x481e
2096#define VMX_VMCS32_GUEST_LDTR_ACCESS_RIGHTS 0x4820
2097#define VMX_VMCS32_GUEST_TR_ACCESS_RIGHTS 0x4822
2098#define VMX_VMCS32_GUEST_INT_STATE 0x4824
2099#define VMX_VMCS32_GUEST_ACTIVITY_STATE 0x4826
2100#define VMX_VMCS32_GUEST_SMBASE 0x4828
2101#define VMX_VMCS32_GUEST_SYSENTER_CS 0x482a
2102#define VMX_VMCS32_PREEMPT_TIMER_VALUE 0x482e
2103
2104/** 32-bit host-state fields. */
2105#define VMX_VMCS32_HOST_SYSENTER_CS 0x4C00
2106
2107/** Natural-width control fields. */
2108#define VMX_VMCS_CTRL_CR0_MASK 0x6000
2109#define VMX_VMCS_CTRL_CR4_MASK 0x6002
2110#define VMX_VMCS_CTRL_CR0_READ_SHADOW 0x6004
2111#define VMX_VMCS_CTRL_CR4_READ_SHADOW 0x6006
2112#define VMX_VMCS_CTRL_CR3_TARGET_VAL0 0x6008
2113#define VMX_VMCS_CTRL_CR3_TARGET_VAL1 0x600a
2114#define VMX_VMCS_CTRL_CR3_TARGET_VAL2 0x600c
2115#define VMX_VMCS_CTRL_CR3_TARGET_VAL3 0x600e
2116
2117/** Natural-width read-only data fields. */
2118#define VMX_VMCS_RO_EXIT_QUALIFICATION 0x6400
2119#define VMX_VMCS_RO_IO_RCX 0x6402
2120#define VMX_VMCS_RO_IO_RSI 0x6404
2121#define VMX_VMCS_RO_IO_RDI 0x6406
2122#define VMX_VMCS_RO_IO_RIP 0x6408
2123#define VMX_VMCS_RO_GUEST_LINEAR_ADDR 0x640a
2124
2125/** Natural-width guest-state fields. */
2126#define VMX_VMCS_GUEST_CR0 0x6800
2127#define VMX_VMCS_GUEST_CR3 0x6802
2128#define VMX_VMCS_GUEST_CR4 0x6804
2129#define VMX_VMCS_GUEST_ES_BASE 0x6806
2130#define VMX_VMCS_GUEST_CS_BASE 0x6808
2131#define VMX_VMCS_GUEST_SS_BASE 0x680a
2132#define VMX_VMCS_GUEST_DS_BASE 0x680c
2133#define VMX_VMCS_GUEST_FS_BASE 0x680e
2134#define VMX_VMCS_GUEST_GS_BASE 0x6810
2135#define VMX_VMCS_GUEST_LDTR_BASE 0x6812
2136#define VMX_VMCS_GUEST_TR_BASE 0x6814
2137#define VMX_VMCS_GUEST_GDTR_BASE 0x6816
2138#define VMX_VMCS_GUEST_IDTR_BASE 0x6818
2139#define VMX_VMCS_GUEST_DR7 0x681a
2140#define VMX_VMCS_GUEST_RSP 0x681c
2141#define VMX_VMCS_GUEST_RIP 0x681e
2142#define VMX_VMCS_GUEST_RFLAGS 0x6820
2143#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPTS 0x6822
2144#define VMX_VMCS_GUEST_SYSENTER_ESP 0x6824
2145#define VMX_VMCS_GUEST_SYSENTER_EIP 0x6826
2146#define VMX_VMCS_GUEST_S_CET 0x6828
2147#define VMX_VMCS_GUEST_SSP 0x682a
2148#define VMX_VMCS_GUEST_INTR_SSP_TABLE_ADDR 0x682c
2149
2150/** Natural-width host-state fields. */
2151#define VMX_VMCS_HOST_CR0 0x6c00
2152#define VMX_VMCS_HOST_CR3 0x6c02
2153#define VMX_VMCS_HOST_CR4 0x6c04
2154#define VMX_VMCS_HOST_FS_BASE 0x6c06
2155#define VMX_VMCS_HOST_GS_BASE 0x6c08
2156#define VMX_VMCS_HOST_TR_BASE 0x6c0a
2157#define VMX_VMCS_HOST_GDTR_BASE 0x6c0c
2158#define VMX_VMCS_HOST_IDTR_BASE 0x6c0e
2159#define VMX_VMCS_HOST_SYSENTER_ESP 0x6c10
2160#define VMX_VMCS_HOST_SYSENTER_EIP 0x6c12
2161#define VMX_VMCS_HOST_RSP 0x6c14
2162#define VMX_VMCS_HOST_RIP 0x6c16
2163#define VMX_VMCS_HOST_S_CET 0x6c18
2164#define VMX_VMCS_HOST_SSP 0x6c1a
2165#define VMX_VMCS_HOST_INTR_SSP_TABLE_ADDR 0x6c1c
2166
2167#define VMX_VMCS16_GUEST_SEG_SEL(a_iSegReg) (VMX_VMCS16_GUEST_ES_SEL + (a_iSegReg) * 2)
2168#define VMX_VMCS_GUEST_SEG_BASE(a_iSegReg) (VMX_VMCS_GUEST_ES_BASE + (a_iSegReg) * 2)
2169#define VMX_VMCS32_GUEST_SEG_LIMIT(a_iSegReg) (VMX_VMCS32_GUEST_ES_LIMIT + (a_iSegReg) * 2)
2170#define VMX_VMCS32_GUEST_SEG_ACCESS_RIGHTS(a_iSegReg) (VMX_VMCS32_GUEST_ES_ACCESS_RIGHTS + (a_iSegReg) * 2)
2171
2172/**
2173 * VMCS field.
2174 * In accordance with the VT-x spec.
2175 */
2176typedef union
2177{
2178 struct
2179 {
2180 /** The access type; 0=full, 1=high of 64-bit fields. */
2181 uint32_t fAccessType : 1;
2182 /** The index. */
2183 uint32_t u8Index : 8;
2184 /** The type; 0=control, 1=VM-exit info, 2=guest-state, 3=host-state. */
2185 uint32_t u2Type : 2;
2186 /** Reserved (MBZ). */
2187 uint32_t u1Reserved0 : 1;
2188 /** The width; 0=16-bit, 1=64-bit, 2=32-bit, 3=natural-width. */
2189 uint32_t u2Width : 2;
2190 /** Reserved (MBZ). */
2191 uint32_t u18Reserved0 : 18;
2192 } n;
2193
2194 /* The unsigned integer view. */
2195 uint32_t u;
2196} VMXVMCSFIELD;
2197AssertCompileSize(VMXVMCSFIELD, 4);
2198/** Pointer to a VMCS field. */
2199typedef VMXVMCSFIELD *PVMXVMCSFIELD;
2200/** Pointer to a const VMCS field. */
2201typedef const VMXVMCSFIELD *PCVMXVMCSFIELD;
2202
2203/** VMCS field: Mask of reserved bits (bits 63:15 MBZ), bit 12 is not included! */
2204#define VMX_VMCSFIELD_RSVD_MASK UINT64_C(0xffffffffffff8000)
2205
2206/** Bits fields for a VMCS field. */
2207#define VMX_BF_VMCSFIELD_ACCESS_TYPE_SHIFT 0
2208#define VMX_BF_VMCSFIELD_ACCESS_TYPE_MASK UINT32_C(0x00000001)
2209#define VMX_BF_VMCSFIELD_INDEX_SHIFT 1
2210#define VMX_BF_VMCSFIELD_INDEX_MASK UINT32_C(0x000003fe)
2211#define VMX_BF_VMCSFIELD_TYPE_SHIFT 10
2212#define VMX_BF_VMCSFIELD_TYPE_MASK UINT32_C(0x00000c00)
2213#define VMX_BF_VMCSFIELD_RSVD_12_SHIFT 12
2214#define VMX_BF_VMCSFIELD_RSVD_12_MASK UINT32_C(0x00001000)
2215#define VMX_BF_VMCSFIELD_WIDTH_SHIFT 13
2216#define VMX_BF_VMCSFIELD_WIDTH_MASK UINT32_C(0x00006000)
2217#define VMX_BF_VMCSFIELD_RSVD_15_31_SHIFT 15
2218#define VMX_BF_VMCSFIELD_RSVD_15_31_MASK UINT32_C(0xffff8000)
2219RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMCSFIELD_, UINT32_C(0), UINT32_MAX,
2220 (ACCESS_TYPE, INDEX, TYPE, RSVD_12, WIDTH, RSVD_15_31));
2221
2222/**
2223 * VMCS field encoding: Access type.
2224 * In accordance with the VT-x spec.
2225 */
2226typedef enum
2227{
2228 VMXVMCSFIELDACCESS_FULL = 0,
2229 VMXVMCSFIELDACCESS_HIGH
2230} VMXVMCSFIELDACCESS;
2231AssertCompileSize(VMXVMCSFIELDACCESS, 4);
2232/** VMCS field encoding type: Full. */
2233#define VMX_VMCSFIELD_ACCESS_FULL 0
2234/** VMCS field encoding type: High. */
2235#define VMX_VMCSFIELD_ACCESS_HIGH 1
2236
2237/**
2238 * VMCS field encoding: Type.
2239 * In accordance with the VT-x spec.
2240 */
2241typedef enum
2242{
2243 VMXVMCSFIELDTYPE_CONTROL = 0,
2244 VMXVMCSFIELDTYPE_VMEXIT_INFO,
2245 VMXVMCSFIELDTYPE_GUEST_STATE,
2246 VMXVMCSFIELDTYPE_HOST_STATE
2247} VMXVMCSFIELDTYPE;
2248AssertCompileSize(VMXVMCSFIELDTYPE, 4);
2249/** VMCS field encoding type: Control. */
2250#define VMX_VMCSFIELD_TYPE_CONTROL 0
2251/** VMCS field encoding type: VM-exit information / read-only fields. */
2252#define VMX_VMCSFIELD_TYPE_VMEXIT_INFO 1
2253/** VMCS field encoding type: Guest-state. */
2254#define VMX_VMCSFIELD_TYPE_GUEST_STATE 2
2255/** VMCS field encoding type: Host-state. */
2256#define VMX_VMCSFIELD_TYPE_HOST_STATE 3
2257
2258/**
2259 * VMCS field encoding: Width.
2260 * In accordance with the VT-x spec.
2261 */
2262typedef enum
2263{
2264 VMXVMCSFIELDWIDTH_16BIT = 0,
2265 VMXVMCSFIELDWIDTH_64BIT,
2266 VMXVMCSFIELDWIDTH_32BIT,
2267 VMXVMCSFIELDWIDTH_NATURAL
2268} VMXVMCSFIELDWIDTH;
2269AssertCompileSize(VMXVMCSFIELDWIDTH, 4);
2270/** VMCS field encoding width: 16-bit. */
2271#define VMX_VMCSFIELD_WIDTH_16BIT 0
2272/** VMCS field encoding width: 64-bit. */
2273#define VMX_VMCSFIELD_WIDTH_64BIT 1
2274/** VMCS field encoding width: 32-bit. */
2275#define VMX_VMCSFIELD_WIDTH_32BIT 2
2276/** VMCS field encoding width: Natural width. */
2277#define VMX_VMCSFIELD_WIDTH_NATURAL 3
2278/** @} */
2279
2280
2281/** @name VM-entry instruction length.
2282 * @{ */
2283/** The maximum valid value for VM-entry instruction length while injecting a
2284 * software interrupt, software exception or privileged software exception. */
2285#define VMX_ENTRY_INSTR_LEN_MAX 15
2286/** @} */
2287
2288
2289/** @name VM-entry register masks.
2290 * @{ */
2291/** CR0 bits ignored on VM-entry while loading guest CR0 (ET, CD, NW, bits 6:15,
2292 * bit 17 and bits 19:28). */
2293#define VMX_ENTRY_GUEST_CR0_IGNORE_MASK UINT64_C(0x7ffaffd0)
2294/** DR7 bits set here are always cleared on VM-entry while loading guest DR7 (bit
2295 * 12, bits 14:15). */
2296#define VMX_ENTRY_GUEST_DR7_MBZ_MASK UINT64_C(0xd000)
2297/** DR7 bits set here are always set on VM-entry while loading guest DR7 (bit
2298 * 10). */
2299#define VMX_ENTRY_GUEST_DR7_MB1_MASK UINT64_C(0x400)
2300/** @} */
2301
2302
2303/** @name VM-exit register masks.
2304 * @{ */
2305/** CR0 bits ignored on VM-exit while loading host CR0 (ET, CD, NW, bits 6:15,
2306 * bit 17, bits 19:28 and bits 32:63). */
2307#define VMX_EXIT_HOST_CR0_IGNORE_MASK UINT64_C(0xffffffff7ffaffd0)
2308/** @} */
2309
2310
2311/** @name Pin-based VM-execution controls.
2312 * @{
2313 */
2314/** External interrupt exiting. */
2315#define VMX_PIN_CTLS_EXT_INT_EXIT RT_BIT(0)
2316/** NMI exiting. */
2317#define VMX_PIN_CTLS_NMI_EXIT RT_BIT(3)
2318/** Virtual NMIs. */
2319#define VMX_PIN_CTLS_VIRT_NMI RT_BIT(5)
2320/** Activate VMX preemption timer. */
2321#define VMX_PIN_CTLS_PREEMPT_TIMER RT_BIT(6)
2322/** Process interrupts with the posted-interrupt notification vector. */
2323#define VMX_PIN_CTLS_POSTED_INT RT_BIT(7)
2324/** Default1 class when true capability MSRs are not supported. */
2325#define VMX_PIN_CTLS_DEFAULT1 UINT32_C(0x00000016)
2326
2327/** Bit fields for MSR_IA32_VMX_PINBASED_CTLS and Pin-based VM-execution
2328 * controls field in the VMCS. */
2329#define VMX_BF_PIN_CTLS_EXT_INT_EXIT_SHIFT 0
2330#define VMX_BF_PIN_CTLS_EXT_INT_EXIT_MASK UINT32_C(0x00000001)
2331#define VMX_BF_PIN_CTLS_RSVD_1_2_SHIFT 1
2332#define VMX_BF_PIN_CTLS_RSVD_1_2_MASK UINT32_C(0x00000006)
2333#define VMX_BF_PIN_CTLS_NMI_EXIT_SHIFT 3
2334#define VMX_BF_PIN_CTLS_NMI_EXIT_MASK UINT32_C(0x00000008)
2335#define VMX_BF_PIN_CTLS_RSVD_4_SHIFT 4
2336#define VMX_BF_PIN_CTLS_RSVD_4_MASK UINT32_C(0x00000010)
2337#define VMX_BF_PIN_CTLS_VIRT_NMI_SHIFT 5
2338#define VMX_BF_PIN_CTLS_VIRT_NMI_MASK UINT32_C(0x00000020)
2339#define VMX_BF_PIN_CTLS_PREEMPT_TIMER_SHIFT 6
2340#define VMX_BF_PIN_CTLS_PREEMPT_TIMER_MASK UINT32_C(0x00000040)
2341#define VMX_BF_PIN_CTLS_POSTED_INT_SHIFT 7
2342#define VMX_BF_PIN_CTLS_POSTED_INT_MASK UINT32_C(0x00000080)
2343#define VMX_BF_PIN_CTLS_RSVD_8_31_SHIFT 8
2344#define VMX_BF_PIN_CTLS_RSVD_8_31_MASK UINT32_C(0xffffff00)
2345RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PIN_CTLS_, UINT32_C(0), UINT32_MAX,
2346 (EXT_INT_EXIT, RSVD_1_2, NMI_EXIT, RSVD_4, VIRT_NMI, PREEMPT_TIMER, POSTED_INT, RSVD_8_31));
2347/** @} */
2348
2349
2350/** @name Processor-based VM-execution controls.
2351 * @{
2352 */
2353/** VM-exit as soon as RFLAGS.IF=1 and no blocking is active. */
2354#define VMX_PROC_CTLS_INT_WINDOW_EXIT RT_BIT(2)
2355/** Use timestamp counter offset. */
2356#define VMX_PROC_CTLS_USE_TSC_OFFSETTING RT_BIT(3)
2357/** VM-exit when executing the HLT instruction. */
2358#define VMX_PROC_CTLS_HLT_EXIT RT_BIT(7)
2359/** VM-exit when executing the INVLPG instruction. */
2360#define VMX_PROC_CTLS_INVLPG_EXIT RT_BIT(9)
2361/** VM-exit when executing the MWAIT instruction. */
2362#define VMX_PROC_CTLS_MWAIT_EXIT RT_BIT(10)
2363/** VM-exit when executing the RDPMC instruction. */
2364#define VMX_PROC_CTLS_RDPMC_EXIT RT_BIT(11)
2365/** VM-exit when executing the RDTSC/RDTSCP instruction. */
2366#define VMX_PROC_CTLS_RDTSC_EXIT RT_BIT(12)
2367/** VM-exit when executing the MOV to CR3 instruction. (forced to 1 on the
2368 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
2369#define VMX_PROC_CTLS_CR3_LOAD_EXIT RT_BIT(15)
2370/** VM-exit when executing the MOV from CR3 instruction. (forced to 1 on the
2371 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
2372#define VMX_PROC_CTLS_CR3_STORE_EXIT RT_BIT(16)
2373/** Whether the secondary processor based VM-execution controls are used. */
2374#define VMX_PROC_CTLS_USE_TERTIARY_CTLS RT_BIT(17)
2375/** VM-exit on CR8 loads. */
2376#define VMX_PROC_CTLS_CR8_LOAD_EXIT RT_BIT(19)
2377/** VM-exit on CR8 stores. */
2378#define VMX_PROC_CTLS_CR8_STORE_EXIT RT_BIT(20)
2379/** Use TPR shadow. */
2380#define VMX_PROC_CTLS_USE_TPR_SHADOW RT_BIT(21)
2381/** VM-exit when virtual NMI blocking is disabled. */
2382#define VMX_PROC_CTLS_NMI_WINDOW_EXIT RT_BIT(22)
2383/** VM-exit when executing a MOV DRx instruction. */
2384#define VMX_PROC_CTLS_MOV_DR_EXIT RT_BIT(23)
2385/** VM-exit when executing IO instructions. */
2386#define VMX_PROC_CTLS_UNCOND_IO_EXIT RT_BIT(24)
2387/** Use IO bitmaps. */
2388#define VMX_PROC_CTLS_USE_IO_BITMAPS RT_BIT(25)
2389/** Monitor trap flag. */
2390#define VMX_PROC_CTLS_MONITOR_TRAP_FLAG RT_BIT(27)
2391/** Use MSR bitmaps. */
2392#define VMX_PROC_CTLS_USE_MSR_BITMAPS RT_BIT(28)
2393/** VM-exit when executing the MONITOR instruction. */
2394#define VMX_PROC_CTLS_MONITOR_EXIT RT_BIT(29)
2395/** VM-exit when executing the PAUSE instruction. */
2396#define VMX_PROC_CTLS_PAUSE_EXIT RT_BIT(30)
2397/** Whether the secondary processor based VM-execution controls are used. */
2398#define VMX_PROC_CTLS_USE_SECONDARY_CTLS RT_BIT(31)
2399/** Default1 class when true-capability MSRs are not supported. */
2400#define VMX_PROC_CTLS_DEFAULT1 UINT32_C(0x0401e172)
2401
2402/** Bit fields for MSR_IA32_VMX_PROCBASED_CTLS and Processor-based VM-execution
2403 * controls field in the VMCS. */
2404#define VMX_BF_PROC_CTLS_RSVD_0_1_SHIFT 0
2405#define VMX_BF_PROC_CTLS_RSVD_0_1_MASK UINT32_C(0x00000003)
2406#define VMX_BF_PROC_CTLS_INT_WINDOW_EXIT_SHIFT 2
2407#define VMX_BF_PROC_CTLS_INT_WINDOW_EXIT_MASK UINT32_C(0x00000004)
2408#define VMX_BF_PROC_CTLS_USE_TSC_OFFSETTING_SHIFT 3
2409#define VMX_BF_PROC_CTLS_USE_TSC_OFFSETTING_MASK UINT32_C(0x00000008)
2410#define VMX_BF_PROC_CTLS_RSVD_4_6_SHIFT 4
2411#define VMX_BF_PROC_CTLS_RSVD_4_6_MASK UINT32_C(0x00000070)
2412#define VMX_BF_PROC_CTLS_HLT_EXIT_SHIFT 7
2413#define VMX_BF_PROC_CTLS_HLT_EXIT_MASK UINT32_C(0x00000080)
2414#define VMX_BF_PROC_CTLS_RSVD_8_SHIFT 8
2415#define VMX_BF_PROC_CTLS_RSVD_8_MASK UINT32_C(0x00000100)
2416#define VMX_BF_PROC_CTLS_INVLPG_EXIT_SHIFT 9
2417#define VMX_BF_PROC_CTLS_INVLPG_EXIT_MASK UINT32_C(0x00000200)
2418#define VMX_BF_PROC_CTLS_MWAIT_EXIT_SHIFT 10
2419#define VMX_BF_PROC_CTLS_MWAIT_EXIT_MASK UINT32_C(0x00000400)
2420#define VMX_BF_PROC_CTLS_RDPMC_EXIT_SHIFT 11
2421#define VMX_BF_PROC_CTLS_RDPMC_EXIT_MASK UINT32_C(0x00000800)
2422#define VMX_BF_PROC_CTLS_RDTSC_EXIT_SHIFT 12
2423#define VMX_BF_PROC_CTLS_RDTSC_EXIT_MASK UINT32_C(0x00001000)
2424#define VMX_BF_PROC_CTLS_RSVD_13_14_SHIFT 13
2425#define VMX_BF_PROC_CTLS_RSVD_13_14_MASK UINT32_C(0x00006000)
2426#define VMX_BF_PROC_CTLS_CR3_LOAD_EXIT_SHIFT 15
2427#define VMX_BF_PROC_CTLS_CR3_LOAD_EXIT_MASK UINT32_C(0x00008000)
2428#define VMX_BF_PROC_CTLS_CR3_STORE_EXIT_SHIFT 16
2429#define VMX_BF_PROC_CTLS_CR3_STORE_EXIT_MASK UINT32_C(0x00010000)
2430#define VMX_BF_PROC_CTLS_USE_TERTIARY_CTLS_SHIFT 17
2431#define VMX_BF_PROC_CTLS_USE_TERTIARY_CTLS_MASK UINT32_C(0x00020000)
2432#define VMX_BF_PROC_CTLS_RSVD_18_SHIFT 18
2433#define VMX_BF_PROC_CTLS_RSVD_18_MASK UINT32_C(0x00040000)
2434#define VMX_BF_PROC_CTLS_CR8_LOAD_EXIT_SHIFT 19
2435#define VMX_BF_PROC_CTLS_CR8_LOAD_EXIT_MASK UINT32_C(0x00080000)
2436#define VMX_BF_PROC_CTLS_CR8_STORE_EXIT_SHIFT 20
2437#define VMX_BF_PROC_CTLS_CR8_STORE_EXIT_MASK UINT32_C(0x00100000)
2438#define VMX_BF_PROC_CTLS_USE_TPR_SHADOW_SHIFT 21
2439#define VMX_BF_PROC_CTLS_USE_TPR_SHADOW_MASK UINT32_C(0x00200000)
2440#define VMX_BF_PROC_CTLS_NMI_WINDOW_EXIT_SHIFT 22
2441#define VMX_BF_PROC_CTLS_NMI_WINDOW_EXIT_MASK UINT32_C(0x00400000)
2442#define VMX_BF_PROC_CTLS_MOV_DR_EXIT_SHIFT 23
2443#define VMX_BF_PROC_CTLS_MOV_DR_EXIT_MASK UINT32_C(0x00800000)
2444#define VMX_BF_PROC_CTLS_UNCOND_IO_EXIT_SHIFT 24
2445#define VMX_BF_PROC_CTLS_UNCOND_IO_EXIT_MASK UINT32_C(0x01000000)
2446#define VMX_BF_PROC_CTLS_USE_IO_BITMAPS_SHIFT 25
2447#define VMX_BF_PROC_CTLS_USE_IO_BITMAPS_MASK UINT32_C(0x02000000)
2448#define VMX_BF_PROC_CTLS_RSVD_26_SHIFT 26
2449#define VMX_BF_PROC_CTLS_RSVD_26_MASK UINT32_C(0x4000000)
2450#define VMX_BF_PROC_CTLS_MONITOR_TRAP_FLAG_SHIFT 27
2451#define VMX_BF_PROC_CTLS_MONITOR_TRAP_FLAG_MASK UINT32_C(0x08000000)
2452#define VMX_BF_PROC_CTLS_USE_MSR_BITMAPS_SHIFT 28
2453#define VMX_BF_PROC_CTLS_USE_MSR_BITMAPS_MASK UINT32_C(0x10000000)
2454#define VMX_BF_PROC_CTLS_MONITOR_EXIT_SHIFT 29
2455#define VMX_BF_PROC_CTLS_MONITOR_EXIT_MASK UINT32_C(0x20000000)
2456#define VMX_BF_PROC_CTLS_PAUSE_EXIT_SHIFT 30
2457#define VMX_BF_PROC_CTLS_PAUSE_EXIT_MASK UINT32_C(0x40000000)
2458#define VMX_BF_PROC_CTLS_USE_SECONDARY_CTLS_SHIFT 31
2459#define VMX_BF_PROC_CTLS_USE_SECONDARY_CTLS_MASK UINT32_C(0x80000000)
2460RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PROC_CTLS_, UINT32_C(0), UINT32_MAX,
2461 (RSVD_0_1, INT_WINDOW_EXIT, USE_TSC_OFFSETTING, RSVD_4_6, HLT_EXIT, RSVD_8, INVLPG_EXIT,
2462 MWAIT_EXIT, RDPMC_EXIT, RDTSC_EXIT, RSVD_13_14, CR3_LOAD_EXIT, CR3_STORE_EXIT, USE_TERTIARY_CTLS,
2463 RSVD_18, CR8_LOAD_EXIT, CR8_STORE_EXIT, USE_TPR_SHADOW, NMI_WINDOW_EXIT, MOV_DR_EXIT, UNCOND_IO_EXIT,
2464 USE_IO_BITMAPS, RSVD_26, MONITOR_TRAP_FLAG, USE_MSR_BITMAPS, MONITOR_EXIT, PAUSE_EXIT,
2465 USE_SECONDARY_CTLS));
2466/** @} */
2467
2468
2469/** @name Secondary Processor-based VM-execution controls.
2470 * @{
2471 */
2472/** Virtualize APIC accesses. */
2473#define VMX_PROC_CTLS2_VIRT_APIC_ACCESS RT_BIT(0)
2474/** EPT supported/enabled. */
2475#define VMX_PROC_CTLS2_EPT RT_BIT(1)
2476/** Descriptor table instructions cause VM-exits. */
2477#define VMX_PROC_CTLS2_DESC_TABLE_EXIT RT_BIT(2)
2478/** RDTSCP supported/enabled. */
2479#define VMX_PROC_CTLS2_RDTSCP RT_BIT(3)
2480/** Virtualize x2APIC mode. */
2481#define VMX_PROC_CTLS2_VIRT_X2APIC_MODE RT_BIT(4)
2482/** VPID supported/enabled. */
2483#define VMX_PROC_CTLS2_VPID RT_BIT(5)
2484/** VM-exit when executing the WBINVD instruction. */
2485#define VMX_PROC_CTLS2_WBINVD_EXIT RT_BIT(6)
2486/** Unrestricted guest execution. */
2487#define VMX_PROC_CTLS2_UNRESTRICTED_GUEST RT_BIT(7)
2488/** APIC register virtualization. */
2489#define VMX_PROC_CTLS2_APIC_REG_VIRT RT_BIT(8)
2490/** Virtual-interrupt delivery. */
2491#define VMX_PROC_CTLS2_VIRT_INT_DELIVERY RT_BIT(9)
2492/** A specified number of pause loops cause a VM-exit. */
2493#define VMX_PROC_CTLS2_PAUSE_LOOP_EXIT RT_BIT(10)
2494/** VM-exit when executing RDRAND instructions. */
2495#define VMX_PROC_CTLS2_RDRAND_EXIT RT_BIT(11)
2496/** Enables INVPCID instructions. */
2497#define VMX_PROC_CTLS2_INVPCID RT_BIT(12)
2498/** Enables VMFUNC instructions. */
2499#define VMX_PROC_CTLS2_VMFUNC RT_BIT(13)
2500/** Enables VMCS shadowing. */
2501#define VMX_PROC_CTLS2_VMCS_SHADOWING RT_BIT(14)
2502/** Enables ENCLS VM-exits. */
2503#define VMX_PROC_CTLS2_ENCLS_EXIT RT_BIT(15)
2504/** VM-exit when executing RDSEED. */
2505#define VMX_PROC_CTLS2_RDSEED_EXIT RT_BIT(16)
2506/** Enables page-modification logging. */
2507#define VMX_PROC_CTLS2_PML RT_BIT(17)
2508/** Controls whether EPT-violations may cause \#VE instead of exits. */
2509#define VMX_PROC_CTLS2_EPT_XCPT_VE RT_BIT(18)
2510/** Conceal VMX non-root operation from Intel processor trace (PT). */
2511#define VMX_PROC_CTLS2_CONCEAL_VMX_FROM_PT RT_BIT(19)
2512/** Enables XSAVES/XRSTORS instructions. */
2513#define VMX_PROC_CTLS2_XSAVES_XRSTORS RT_BIT(20)
2514/** Enables supervisor/user mode based EPT execute permission for linear
2515 * addresses. */
2516#define VMX_PROC_CTLS2_MODE_BASED_EPT_PERM RT_BIT(22)
2517/** Enables EPT write permissions to be specified at granularity of 128 bytes. */
2518#define VMX_PROC_CTLS2_SPP_EPT RT_BIT(23)
2519/** Intel PT output addresses are treated as guest-physical addresses and
2520 * translated using EPT. */
2521#define VMX_PROC_CTLS2_PT_EPT RT_BIT(24)
2522/** Use TSC scaling. */
2523#define VMX_PROC_CTLS2_TSC_SCALING RT_BIT(25)
2524/** Enables TPAUSE, UMONITOR and UMWAIT instructions. */
2525#define VMX_PROC_CTLS2_USER_WAIT_PAUSE RT_BIT(26)
2526/** Enables consulting ENCLV-exiting bitmap when executing ENCLV. */
2527#define VMX_PROC_CTLS2_ENCLV_EXIT RT_BIT(28)
2528
2529/** Bit fields for MSR_IA32_VMX_PROCBASED_CTLS2 and Secondary processor-based
2530 * VM-execution controls field in the VMCS. */
2531#define VMX_BF_PROC_CTLS2_VIRT_APIC_ACCESS_SHIFT 0
2532#define VMX_BF_PROC_CTLS2_VIRT_APIC_ACCESS_MASK UINT32_C(0x00000001)
2533#define VMX_BF_PROC_CTLS2_EPT_SHIFT 1
2534#define VMX_BF_PROC_CTLS2_EPT_MASK UINT32_C(0x00000002)
2535#define VMX_BF_PROC_CTLS2_DESC_TABLE_EXIT_SHIFT 2
2536#define VMX_BF_PROC_CTLS2_DESC_TABLE_EXIT_MASK UINT32_C(0x00000004)
2537#define VMX_BF_PROC_CTLS2_RDTSCP_SHIFT 3
2538#define VMX_BF_PROC_CTLS2_RDTSCP_MASK UINT32_C(0x00000008)
2539#define VMX_BF_PROC_CTLS2_VIRT_X2APIC_MODE_SHIFT 4
2540#define VMX_BF_PROC_CTLS2_VIRT_X2APIC_MODE_MASK UINT32_C(0x00000010)
2541#define VMX_BF_PROC_CTLS2_VPID_SHIFT 5
2542#define VMX_BF_PROC_CTLS2_VPID_MASK UINT32_C(0x00000020)
2543#define VMX_BF_PROC_CTLS2_WBINVD_EXIT_SHIFT 6
2544#define VMX_BF_PROC_CTLS2_WBINVD_EXIT_MASK UINT32_C(0x00000040)
2545#define VMX_BF_PROC_CTLS2_UNRESTRICTED_GUEST_SHIFT 7
2546#define VMX_BF_PROC_CTLS2_UNRESTRICTED_GUEST_MASK UINT32_C(0x00000080)
2547#define VMX_BF_PROC_CTLS2_APIC_REG_VIRT_SHIFT 8
2548#define VMX_BF_PROC_CTLS2_APIC_REG_VIRT_MASK UINT32_C(0x00000100)
2549#define VMX_BF_PROC_CTLS2_VIRT_INT_DELIVERY_SHIFT 9
2550#define VMX_BF_PROC_CTLS2_VIRT_INT_DELIVERY_MASK UINT32_C(0x00000200)
2551#define VMX_BF_PROC_CTLS2_PAUSE_LOOP_EXIT_SHIFT 10
2552#define VMX_BF_PROC_CTLS2_PAUSE_LOOP_EXIT_MASK UINT32_C(0x00000400)
2553#define VMX_BF_PROC_CTLS2_RDRAND_EXIT_SHIFT 11
2554#define VMX_BF_PROC_CTLS2_RDRAND_EXIT_MASK UINT32_C(0x00000800)
2555#define VMX_BF_PROC_CTLS2_INVPCID_SHIFT 12
2556#define VMX_BF_PROC_CTLS2_INVPCID_MASK UINT32_C(0x00001000)
2557#define VMX_BF_PROC_CTLS2_VMFUNC_SHIFT 13
2558#define VMX_BF_PROC_CTLS2_VMFUNC_MASK UINT32_C(0x00002000)
2559#define VMX_BF_PROC_CTLS2_VMCS_SHADOWING_SHIFT 14
2560#define VMX_BF_PROC_CTLS2_VMCS_SHADOWING_MASK UINT32_C(0x00004000)
2561#define VMX_BF_PROC_CTLS2_ENCLS_EXIT_SHIFT 15
2562#define VMX_BF_PROC_CTLS2_ENCLS_EXIT_MASK UINT32_C(0x00008000)
2563#define VMX_BF_PROC_CTLS2_RDSEED_EXIT_SHIFT 16
2564#define VMX_BF_PROC_CTLS2_RDSEED_EXIT_MASK UINT32_C(0x00010000)
2565#define VMX_BF_PROC_CTLS2_PML_SHIFT 17
2566#define VMX_BF_PROC_CTLS2_PML_MASK UINT32_C(0x00020000)
2567#define VMX_BF_PROC_CTLS2_EPT_VE_SHIFT 18
2568#define VMX_BF_PROC_CTLS2_EPT_VE_MASK UINT32_C(0x00040000)
2569#define VMX_BF_PROC_CTLS2_CONCEAL_VMX_FROM_PT_SHIFT 19
2570#define VMX_BF_PROC_CTLS2_CONCEAL_VMX_FROM_PT_MASK UINT32_C(0x00080000)
2571#define VMX_BF_PROC_CTLS2_XSAVES_XRSTORS_SHIFT 20
2572#define VMX_BF_PROC_CTLS2_XSAVES_XRSTORS_MASK UINT32_C(0x00100000)
2573#define VMX_BF_PROC_CTLS2_RSVD_21_SHIFT 21
2574#define VMX_BF_PROC_CTLS2_RSVD_21_MASK UINT32_C(0x00200000)
2575#define VMX_BF_PROC_CTLS2_MODE_BASED_EPT_PERM_SHIFT 22
2576#define VMX_BF_PROC_CTLS2_MODE_BASED_EPT_PERM_MASK UINT32_C(0x00400000)
2577#define VMX_BF_PROC_CTLS2_SPP_EPT_SHIFT 23
2578#define VMX_BF_PROC_CTLS2_SPP_EPT_MASK UINT32_C(0x00800000)
2579#define VMX_BF_PROC_CTLS2_PT_EPT_SHIFT 24
2580#define VMX_BF_PROC_CTLS2_PT_EPT_MASK UINT32_C(0x01000000)
2581#define VMX_BF_PROC_CTLS2_TSC_SCALING_SHIFT 25
2582#define VMX_BF_PROC_CTLS2_TSC_SCALING_MASK UINT32_C(0x02000000)
2583#define VMX_BF_PROC_CTLS2_USER_WAIT_PAUSE_SHIFT 26
2584#define VMX_BF_PROC_CTLS2_USER_WAIT_PAUSE_MASK UINT32_C(0x04000000)
2585#define VMX_BF_PROC_CTLS2_RSVD_27_SHIFT 27
2586#define VMX_BF_PROC_CTLS2_RSVD_27_MASK UINT32_C(0x08000000)
2587#define VMX_BF_PROC_CTLS2_ENCLV_EXIT_SHIFT 28
2588#define VMX_BF_PROC_CTLS2_ENCLV_EXIT_MASK UINT32_C(0x10000000)
2589#define VMX_BF_PROC_CTLS2_RSVD_29_31_SHIFT 29
2590#define VMX_BF_PROC_CTLS2_RSVD_29_31_MASK UINT32_C(0xe0000000)
2591
2592RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PROC_CTLS2_, UINT32_C(0), UINT32_MAX,
2593 (VIRT_APIC_ACCESS, EPT, DESC_TABLE_EXIT, RDTSCP, VIRT_X2APIC_MODE, VPID, WBINVD_EXIT,
2594 UNRESTRICTED_GUEST, APIC_REG_VIRT, VIRT_INT_DELIVERY, PAUSE_LOOP_EXIT, RDRAND_EXIT, INVPCID, VMFUNC,
2595 VMCS_SHADOWING, ENCLS_EXIT, RDSEED_EXIT, PML, EPT_VE, CONCEAL_VMX_FROM_PT, XSAVES_XRSTORS, RSVD_21,
2596 MODE_BASED_EPT_PERM, SPP_EPT, PT_EPT, TSC_SCALING, USER_WAIT_PAUSE, RSVD_27, ENCLV_EXIT,
2597 RSVD_29_31));
2598/** @} */
2599
2600
2601/** @name Tertiary Processor-based VM-execution controls.
2602 * @{
2603 */
2604/** VM-exit when executing LOADIWKEY. */
2605#define VMX_PROC_CTLS3_LOADIWKEY_EXIT RT_BIT_64(0)
2606
2607/** Bit fields for Tertiary processor-based VM-execution controls field in the VMCS. */
2608#define VMX_BF_PROC_CTLS3_LOADIWKEY_EXIT_SHIFT 0
2609#define VMX_BF_PROC_CTLS3_LOADIWKEY_EXIT_MASK UINT64_C(0x0000000000000001)
2610#define VMX_BF_PROC_CTLS3_RSVD_1_63_SHIFT 1
2611#define VMX_BF_PROC_CTLS3_RSVD_1_63_MASK UINT64_C(0xfffffffffffffffe)
2612
2613RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PROC_CTLS3_, UINT64_C(0), UINT64_MAX,
2614 (LOADIWKEY_EXIT, RSVD_1_63));
2615/** @} */
2616
2617
2618/** @name VM-entry controls.
2619 * @{
2620 */
2621/** Load guest debug controls (dr7 & IA32_DEBUGCTL_MSR) (forced to 1 on the
2622 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
2623#define VMX_ENTRY_CTLS_LOAD_DEBUG RT_BIT(2)
2624/** 64-bit guest mode. Must be 0 for CPUs that don't support AMD64. */
2625#define VMX_ENTRY_CTLS_IA32E_MODE_GUEST RT_BIT(9)
2626/** In SMM mode after VM-entry. */
2627#define VMX_ENTRY_CTLS_ENTRY_TO_SMM RT_BIT(10)
2628/** Disable dual treatment of SMI and SMM; must be zero for VM-entry outside of SMM. */
2629#define VMX_ENTRY_CTLS_DEACTIVATE_DUAL_MON RT_BIT(11)
2630/** Whether the guest IA32_PERF_GLOBAL_CTRL MSR is loaded on VM-entry. */
2631#define VMX_ENTRY_CTLS_LOAD_PERF_MSR RT_BIT(13)
2632/** Whether the guest IA32_PAT MSR is loaded on VM-entry. */
2633#define VMX_ENTRY_CTLS_LOAD_PAT_MSR RT_BIT(14)
2634/** Whether the guest IA32_EFER MSR is loaded on VM-entry. */
2635#define VMX_ENTRY_CTLS_LOAD_EFER_MSR RT_BIT(15)
2636/** Whether the guest IA32_BNDCFGS MSR is loaded on VM-entry. */
2637#define VMX_ENTRY_CTLS_LOAD_BNDCFGS_MSR RT_BIT(16)
2638/** Whether to conceal VMX from Intel PT (Processor Trace). */
2639#define VMX_ENTRY_CTLS_CONCEAL_VMX_FROM_PT RT_BIT(17)
2640/** Whether the guest IA32_RTIT MSR is loaded on VM-entry. */
2641#define VMX_ENTRY_CTLS_LOAD_RTIT_CTL_MSR RT_BIT(18)
2642/** Whether the guest CET-related MSRs and SPP are loaded on VM-entry. */
2643#define VMX_ENTRY_CTLS_LOAD_CET_STATE RT_BIT(20)
2644/** Whether the guest IA32_PKRS MSR is loaded on VM-entry. */
2645#define VMX_ENTRY_CTLS_LOAD_PKRS_MSR RT_BIT(22)
2646/** Default1 class when true-capability MSRs are not supported. */
2647#define VMX_ENTRY_CTLS_DEFAULT1 UINT32_C(0x000011ff)
2648
2649/** Bit fields for MSR_IA32_VMX_ENTRY_CTLS and VM-entry controls field in the
2650 * VMCS. */
2651#define VMX_BF_ENTRY_CTLS_RSVD_0_1_SHIFT 0
2652#define VMX_BF_ENTRY_CTLS_RSVD_0_1_MASK UINT32_C(0x00000003)
2653#define VMX_BF_ENTRY_CTLS_LOAD_DEBUG_SHIFT 2
2654#define VMX_BF_ENTRY_CTLS_LOAD_DEBUG_MASK UINT32_C(0x00000004)
2655#define VMX_BF_ENTRY_CTLS_RSVD_3_8_SHIFT 3
2656#define VMX_BF_ENTRY_CTLS_RSVD_3_8_MASK UINT32_C(0x000001f8)
2657#define VMX_BF_ENTRY_CTLS_IA32E_MODE_GUEST_SHIFT 9
2658#define VMX_BF_ENTRY_CTLS_IA32E_MODE_GUEST_MASK UINT32_C(0x00000200)
2659#define VMX_BF_ENTRY_CTLS_ENTRY_SMM_SHIFT 10
2660#define VMX_BF_ENTRY_CTLS_ENTRY_SMM_MASK UINT32_C(0x00000400)
2661#define VMX_BF_ENTRY_CTLS_DEACTIVATE_DUAL_MON_SHIFT 11
2662#define VMX_BF_ENTRY_CTLS_DEACTIVATE_DUAL_MON_MASK UINT32_C(0x00000800)
2663#define VMX_BF_ENTRY_CTLS_RSVD_12_SHIFT 12
2664#define VMX_BF_ENTRY_CTLS_RSVD_12_MASK UINT32_C(0x00001000)
2665#define VMX_BF_ENTRY_CTLS_LOAD_PERF_MSR_SHIFT 13
2666#define VMX_BF_ENTRY_CTLS_LOAD_PERF_MSR_MASK UINT32_C(0x00002000)
2667#define VMX_BF_ENTRY_CTLS_LOAD_PAT_MSR_SHIFT 14
2668#define VMX_BF_ENTRY_CTLS_LOAD_PAT_MSR_MASK UINT32_C(0x00004000)
2669#define VMX_BF_ENTRY_CTLS_LOAD_EFER_MSR_SHIFT 15
2670#define VMX_BF_ENTRY_CTLS_LOAD_EFER_MSR_MASK UINT32_C(0x00008000)
2671#define VMX_BF_ENTRY_CTLS_LOAD_BNDCFGS_MSR_SHIFT 16
2672#define VMX_BF_ENTRY_CTLS_LOAD_BNDCFGS_MSR_MASK UINT32_C(0x00010000)
2673#define VMX_BF_ENTRY_CTLS_CONCEAL_VMX_FROM_PT_SHIFT 17
2674#define VMX_BF_ENTRY_CTLS_CONCEAL_VMX_FROM_PT_MASK UINT32_C(0x00020000)
2675#define VMX_BF_ENTRY_CTLS_LOAD_RTIT_CTL_MSR_SHIFT 18
2676#define VMX_BF_ENTRY_CTLS_LOAD_RTIT_CTL_MSR_MASK UINT32_C(0x00040000)
2677#define VMX_BF_ENTRY_CTLS_RSVD_19_SHIFT 19
2678#define VMX_BF_ENTRY_CTLS_RSVD_19_MASK UINT32_C(0x00080000)
2679#define VMX_BF_ENTRY_CTLS_LOAD_CET_SHIFT 20
2680#define VMX_BF_ENTRY_CTLS_LOAD_CET_MASK UINT32_C(0x00100000)
2681#define VMX_BF_ENTRY_CTLS_RSVD_21_SHIFT 21
2682#define VMX_BF_ENTRY_CTLS_RSVD_21_MASK UINT32_C(0x00200000)
2683#define VMX_BF_ENTRY_CTLS_LOAD_PKRS_MSR_SHIFT 22
2684#define VMX_BF_ENTRY_CTLS_LOAD_PKRS_MSR_MASK UINT32_C(0x00400000)
2685#define VMX_BF_ENTRY_CTLS_RSVD_23_31_SHIFT 23
2686#define VMX_BF_ENTRY_CTLS_RSVD_23_31_MASK UINT32_C(0xff800000)
2687
2688RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_ENTRY_CTLS_, UINT32_C(0), UINT32_MAX,
2689 (RSVD_0_1, LOAD_DEBUG, RSVD_3_8, IA32E_MODE_GUEST, ENTRY_SMM, DEACTIVATE_DUAL_MON, RSVD_12,
2690 LOAD_PERF_MSR, LOAD_PAT_MSR, LOAD_EFER_MSR, LOAD_BNDCFGS_MSR, CONCEAL_VMX_FROM_PT,
2691 LOAD_RTIT_CTL_MSR, RSVD_19, LOAD_CET, RSVD_21, LOAD_PKRS_MSR, RSVD_23_31));
2692/** @} */
2693
2694
2695/** @name VM-exit controls.
2696 * @{
2697 */
2698/** Save guest debug controls (dr7 & IA32_DEBUGCTL_MSR) (forced to 1 on the
2699 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
2700#define VMX_EXIT_CTLS_SAVE_DEBUG RT_BIT(2)
2701/** Return to long mode after a VM-exit. */
2702#define VMX_EXIT_CTLS_HOST_ADDR_SPACE_SIZE RT_BIT(9)
2703/** Whether the host IA32_PERF_GLOBAL_CTRL MSR is loaded on VM-exit. */
2704#define VMX_EXIT_CTLS_LOAD_PERF_MSR RT_BIT(12)
2705/** Acknowledge external interrupts with the irq controller if one caused a VM-exit. */
2706#define VMX_EXIT_CTLS_ACK_EXT_INT RT_BIT(15)
2707/** Whether the guest IA32_PAT MSR is saved on VM-exit. */
2708#define VMX_EXIT_CTLS_SAVE_PAT_MSR RT_BIT(18)
2709/** Whether the host IA32_PAT MSR is loaded on VM-exit. */
2710#define VMX_EXIT_CTLS_LOAD_PAT_MSR RT_BIT(19)
2711/** Whether the guest IA32_EFER MSR is saved on VM-exit. */
2712#define VMX_EXIT_CTLS_SAVE_EFER_MSR RT_BIT(20)
2713/** Whether the host IA32_EFER MSR is loaded on VM-exit. */
2714#define VMX_EXIT_CTLS_LOAD_EFER_MSR RT_BIT(21)
2715/** Whether the value of the VMX preemption timer is saved on every VM-exit. */
2716#define VMX_EXIT_CTLS_SAVE_PREEMPT_TIMER RT_BIT(22)
2717/** Whether IA32_BNDCFGS MSR is cleared on VM-exit. */
2718#define VMX_EXIT_CTLS_CLEAR_BNDCFGS_MSR RT_BIT(23)
2719/** Whether to conceal VMX from Intel PT. */
2720#define VMX_EXIT_CTLS_CONCEAL_VMX_FROM_PT RT_BIT(24)
2721/** Whether IA32_RTIT_CTL MSR is cleared on VM-exit. */
2722#define VMX_EXIT_CTLS_CLEAR_RTIT_CTL_MSR RT_BIT(25)
2723/** Whether CET-related MSRs and SPP are loaded on VM-exit. */
2724#define VMX_EXIT_CTLS_LOAD_CET_STATE RT_BIT(28)
2725/** Whether the host IA32_PKRS MSR is loaded on VM-exit. */
2726#define VMX_EXIT_CTLS_LOAD_PKRS_MSR RT_BIT(29)
2727/** Default1 class when true-capability MSRs are not supported. */
2728#define VMX_EXIT_CTLS_DEFAULT1 UINT32_C(0x00036dff)
2729
2730/** Bit fields for MSR_IA32_VMX_EXIT_CTLS and VM-exit controls field in the
2731 * VMCS. */
2732#define VMX_BF_EXIT_CTLS_RSVD_0_1_SHIFT 0
2733#define VMX_BF_EXIT_CTLS_RSVD_0_1_MASK UINT32_C(0x00000003)
2734#define VMX_BF_EXIT_CTLS_SAVE_DEBUG_SHIFT 2
2735#define VMX_BF_EXIT_CTLS_SAVE_DEBUG_MASK UINT32_C(0x00000004)
2736#define VMX_BF_EXIT_CTLS_RSVD_3_8_SHIFT 3
2737#define VMX_BF_EXIT_CTLS_RSVD_3_8_MASK UINT32_C(0x000001f8)
2738#define VMX_BF_EXIT_CTLS_HOST_ADDR_SPACE_SIZE_SHIFT 9
2739#define VMX_BF_EXIT_CTLS_HOST_ADDR_SPACE_SIZE_MASK UINT32_C(0x00000200)
2740#define VMX_BF_EXIT_CTLS_RSVD_10_11_SHIFT 10
2741#define VMX_BF_EXIT_CTLS_RSVD_10_11_MASK UINT32_C(0x00000c00)
2742#define VMX_BF_EXIT_CTLS_LOAD_PERF_MSR_SHIFT 12
2743#define VMX_BF_EXIT_CTLS_LOAD_PERF_MSR_MASK UINT32_C(0x00001000)
2744#define VMX_BF_EXIT_CTLS_RSVD_13_14_SHIFT 13
2745#define VMX_BF_EXIT_CTLS_RSVD_13_14_MASK UINT32_C(0x00006000)
2746#define VMX_BF_EXIT_CTLS_ACK_EXT_INT_SHIFT 15
2747#define VMX_BF_EXIT_CTLS_ACK_EXT_INT_MASK UINT32_C(0x00008000)
2748#define VMX_BF_EXIT_CTLS_RSVD_16_17_SHIFT 16
2749#define VMX_BF_EXIT_CTLS_RSVD_16_17_MASK UINT32_C(0x00030000)
2750#define VMX_BF_EXIT_CTLS_SAVE_PAT_MSR_SHIFT 18
2751#define VMX_BF_EXIT_CTLS_SAVE_PAT_MSR_MASK UINT32_C(0x00040000)
2752#define VMX_BF_EXIT_CTLS_LOAD_PAT_MSR_SHIFT 19
2753#define VMX_BF_EXIT_CTLS_LOAD_PAT_MSR_MASK UINT32_C(0x00080000)
2754#define VMX_BF_EXIT_CTLS_SAVE_EFER_MSR_SHIFT 20
2755#define VMX_BF_EXIT_CTLS_SAVE_EFER_MSR_MASK UINT32_C(0x00100000)
2756#define VMX_BF_EXIT_CTLS_LOAD_EFER_MSR_SHIFT 21
2757#define VMX_BF_EXIT_CTLS_LOAD_EFER_MSR_MASK UINT32_C(0x00200000)
2758#define VMX_BF_EXIT_CTLS_SAVE_PREEMPT_TIMER_SHIFT 22
2759#define VMX_BF_EXIT_CTLS_SAVE_PREEMPT_TIMER_MASK UINT32_C(0x00400000)
2760#define VMX_BF_EXIT_CTLS_CLEAR_BNDCFGS_MSR_SHIFT 23
2761#define VMX_BF_EXIT_CTLS_CLEAR_BNDCFGS_MSR_MASK UINT32_C(0x00800000)
2762#define VMX_BF_EXIT_CTLS_CONCEAL_VMX_FROM_PT_SHIFT 24
2763#define VMX_BF_EXIT_CTLS_CONCEAL_VMX_FROM_PT_MASK UINT32_C(0x01000000)
2764#define VMX_BF_EXIT_CTLS_CLEAR_RTIT_CTL_MSR_SHIFT 25
2765#define VMX_BF_EXIT_CTLS_CLEAR_RTIT_CTL_MSR_MASK UINT32_C(0x02000000)
2766#define VMX_BF_EXIT_CTLS_RSVD_26_27_SHIFT 26
2767#define VMX_BF_EXIT_CTLS_RSVD_26_27_MASK UINT32_C(0x0c000000)
2768#define VMX_BF_EXIT_CTLS_LOAD_CET_SHIFT 28
2769#define VMX_BF_EXIT_CTLS_LOAD_CET_MASK UINT32_C(0x10000000)
2770#define VMX_BF_EXIT_CTLS_LOAD_PKRS_MSR_SHIFT 29
2771#define VMX_BF_EXIT_CTLS_LOAD_PKRS_MSR_MASK UINT32_C(0x20000000)
2772#define VMX_BF_EXIT_CTLS_RSVD_30_31_SHIFT 30
2773#define VMX_BF_EXIT_CTLS_RSVD_30_31_MASK UINT32_C(0xc0000000)
2774RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_CTLS_, UINT32_C(0), UINT32_MAX,
2775 (RSVD_0_1, SAVE_DEBUG, RSVD_3_8, HOST_ADDR_SPACE_SIZE, RSVD_10_11, LOAD_PERF_MSR, RSVD_13_14,
2776 ACK_EXT_INT, RSVD_16_17, SAVE_PAT_MSR, LOAD_PAT_MSR, SAVE_EFER_MSR, LOAD_EFER_MSR,
2777 SAVE_PREEMPT_TIMER, CLEAR_BNDCFGS_MSR, CONCEAL_VMX_FROM_PT, CLEAR_RTIT_CTL_MSR, RSVD_26_27,
2778 LOAD_CET, LOAD_PKRS_MSR, RSVD_30_31));
2779/** @} */
2780
2781
2782/** @name VM-exit reason.
2783 * @{
2784 */
2785#define VMX_EXIT_REASON_BASIC(a) ((a) & 0xffff)
2786#define VMX_EXIT_REASON_HAS_ENTRY_FAILED(a) (((a) >> 31) & 1)
2787#define VMX_EXIT_REASON_ENTRY_FAILED RT_BIT(31)
2788
2789/** Bit fields for VM-exit reason. */
2790/** The exit reason. */
2791#define VMX_BF_EXIT_REASON_BASIC_SHIFT 0
2792#define VMX_BF_EXIT_REASON_BASIC_MASK UINT32_C(0x0000ffff)
2793/** Bits 16:26 are reseved and MBZ. */
2794#define VMX_BF_EXIT_REASON_RSVD_16_26_SHIFT 16
2795#define VMX_BF_EXIT_REASON_RSVD_16_26_MASK UINT32_C(0x07ff0000)
2796/** Whether the VM-exit was incident to enclave mode. */
2797#define VMX_BF_EXIT_REASON_ENCLAVE_MODE_SHIFT 27
2798#define VMX_BF_EXIT_REASON_ENCLAVE_MODE_MASK UINT32_C(0x08000000)
2799/** Pending MTF (Monitor Trap Flag) during VM-exit (only applicable in SMM mode). */
2800#define VMX_BF_EXIT_REASON_SMM_PENDING_MTF_SHIFT 28
2801#define VMX_BF_EXIT_REASON_SMM_PENDING_MTF_MASK UINT32_C(0x10000000)
2802/** VM-exit from VMX root operation (only possible with SMM). */
2803#define VMX_BF_EXIT_REASON_VMX_ROOT_MODE_SHIFT 29
2804#define VMX_BF_EXIT_REASON_VMX_ROOT_MODE_MASK UINT32_C(0x20000000)
2805/** Bit 30 is reserved and MBZ. */
2806#define VMX_BF_EXIT_REASON_RSVD_30_SHIFT 30
2807#define VMX_BF_EXIT_REASON_RSVD_30_MASK UINT32_C(0x40000000)
2808/** Whether VM-entry failed (currently only happens during loading guest-state
2809 * or MSRs or machine check exceptions). */
2810#define VMX_BF_EXIT_REASON_ENTRY_FAILED_SHIFT 31
2811#define VMX_BF_EXIT_REASON_ENTRY_FAILED_MASK UINT32_C(0x80000000)
2812RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_REASON_, UINT32_C(0), UINT32_MAX,
2813 (BASIC, RSVD_16_26, ENCLAVE_MODE, SMM_PENDING_MTF, VMX_ROOT_MODE, RSVD_30, ENTRY_FAILED));
2814/** @} */
2815
2816
2817/** @name VM-entry interruption information.
2818 * @{
2819 */
2820#define VMX_ENTRY_INT_INFO_IS_VALID(a) (((a) >> 31) & 1)
2821#define VMX_ENTRY_INT_INFO_VECTOR(a) ((a) & 0xff)
2822#define VMX_ENTRY_INT_INFO_TYPE_SHIFT 8
2823#define VMX_ENTRY_INT_INFO_TYPE(a) (((a) >> 8) & 7)
2824#define VMX_ENTRY_INT_INFO_ERROR_CODE_VALID RT_BIT(11)
2825#define VMX_ENTRY_INT_INFO_IS_ERROR_CODE_VALID(a) (((a) >> 11) & 1)
2826#define VMX_ENTRY_INT_INFO_NMI_UNBLOCK_IRET 12
2827#define VMX_ENTRY_INT_INFO_IS_NMI_UNBLOCK_IRET(a) (((a) >> 12) & 1)
2828#define VMX_ENTRY_INT_INFO_VALID RT_BIT(31)
2829#define VMX_ENTRY_INT_INFO_IS_VALID(a) (((a) >> 31) & 1)
2830/** Construct an VM-entry interruption information field from a VM-exit interruption
2831 * info value (same except that bit 12 is reserved). */
2832#define VMX_ENTRY_INT_INFO_FROM_EXIT_INT_INFO(a) ((a) & ~RT_BIT(12))
2833/** Construct a VM-entry interruption information field from an IDT-vectoring
2834 * information field (same except that bit 12 is reserved). */
2835#define VMX_ENTRY_INT_INFO_FROM_EXIT_IDT_INFO(a) ((a) & ~RT_BIT(12))
2836/** If the VM-entry interruption information field indicates a page-fault. */
2837#define VMX_ENTRY_INT_INFO_IS_XCPT_PF(a) (((a) & ( VMX_BF_ENTRY_INT_INFO_VALID_MASK \
2838 | VMX_BF_ENTRY_INT_INFO_TYPE_MASK \
2839 | VMX_BF_ENTRY_INT_INFO_VECTOR_MASK)) \
2840 == ( RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_VALID, 1) \
2841 | RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_TYPE, VMX_ENTRY_INT_INFO_TYPE_HW_XCPT) \
2842 | RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_VECTOR, X86_XCPT_PF)))
2843/** If the VM-entry interruption information field indicates an external
2844 * interrupt. */
2845#define VMX_ENTRY_INT_INFO_IS_EXT_INT(a) (((a) & ( VMX_BF_ENTRY_INT_INFO_VALID_MASK \
2846 | VMX_BF_ENTRY_INT_INFO_TYPE_MASK)) \
2847 == ( RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_VALID, 1) \
2848 | RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_TYPE, VMX_ENTRY_INT_INFO_TYPE_EXT_INT)))
2849/** If the VM-entry interruption information field indicates an NMI. */
2850#define VMX_ENTRY_INT_INFO_IS_XCPT_NMI(a) (((a) & ( VMX_BF_ENTRY_INT_INFO_VALID_MASK \
2851 | VMX_BF_ENTRY_INT_INFO_TYPE_MASK \
2852 | VMX_BF_ENTRY_INT_INFO_VECTOR_MASK)) \
2853 == ( RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_VALID, 1) \
2854 | RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_TYPE, VMX_ENTRY_INT_INFO_TYPE_NMI) \
2855 | RT_BF_MAKE(VMX_BF_ENTRY_INT_INFO_VECTOR, X86_XCPT_NMI)))
2856
2857/** Bit fields for VM-entry interruption information. */
2858/** The VM-entry interruption vector. */
2859#define VMX_BF_ENTRY_INT_INFO_VECTOR_SHIFT 0
2860#define VMX_BF_ENTRY_INT_INFO_VECTOR_MASK UINT32_C(0x000000ff)
2861/** The VM-entry interruption type (see VMX_ENTRY_INT_INFO_TYPE_XXX). */
2862#define VMX_BF_ENTRY_INT_INFO_TYPE_SHIFT 8
2863#define VMX_BF_ENTRY_INT_INFO_TYPE_MASK UINT32_C(0x00000700)
2864/** Whether this event has an error code. */
2865#define VMX_BF_ENTRY_INT_INFO_ERR_CODE_VALID_SHIFT 11
2866#define VMX_BF_ENTRY_INT_INFO_ERR_CODE_VALID_MASK UINT32_C(0x00000800)
2867/** Bits 12:30 are reserved and MBZ. */
2868#define VMX_BF_ENTRY_INT_INFO_RSVD_12_30_SHIFT 12
2869#define VMX_BF_ENTRY_INT_INFO_RSVD_12_30_MASK UINT32_C(0x7ffff000)
2870/** Whether this VM-entry interruption info is valid. */
2871#define VMX_BF_ENTRY_INT_INFO_VALID_SHIFT 31
2872#define VMX_BF_ENTRY_INT_INFO_VALID_MASK UINT32_C(0x80000000)
2873RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_ENTRY_INT_INFO_, UINT32_C(0), UINT32_MAX,
2874 (VECTOR, TYPE, ERR_CODE_VALID, RSVD_12_30, VALID));
2875/** @} */
2876
2877
2878/** @name VM-entry exception error code.
2879 * @{ */
2880/** Error code valid mask. */
2881/** @todo r=ramshankar: Intel spec. 26.2.1.3 "VM-Entry Control Fields" states that
2882 * bits 31:15 MBZ. However, Intel spec. 6.13 "Error Code" states "To keep the
2883 * stack aligned for doubleword pushes, the upper half of the error code is
2884 * reserved" which implies bits 31:16 MBZ (and not 31:15) which is what we
2885 * use below. */
2886#define VMX_ENTRY_INT_XCPT_ERR_CODE_VALID_MASK UINT32_C(0xffff)
2887/** @} */
2888
2889/** @name VM-entry interruption information types.
2890 * @{
2891 */
2892#define VMX_ENTRY_INT_INFO_TYPE_EXT_INT 0
2893#define VMX_ENTRY_INT_INFO_TYPE_RSVD 1
2894#define VMX_ENTRY_INT_INFO_TYPE_NMI 2
2895#define VMX_ENTRY_INT_INFO_TYPE_HW_XCPT 3
2896#define VMX_ENTRY_INT_INFO_TYPE_SW_INT 4
2897#define VMX_ENTRY_INT_INFO_TYPE_PRIV_SW_XCPT 5
2898#define VMX_ENTRY_INT_INFO_TYPE_SW_XCPT 6
2899#define VMX_ENTRY_INT_INFO_TYPE_OTHER_EVENT 7
2900/** @} */
2901
2902
2903/** @name VM-entry interruption information vector types for
2904 * VMX_ENTRY_INT_INFO_TYPE_OTHER_EVENT.
2905 * @{ */
2906#define VMX_ENTRY_INT_INFO_VECTOR_MTF 0
2907/** @} */
2908
2909
2910/** @name VM-exit interruption information.
2911 * @{
2912 */
2913#define VMX_EXIT_INT_INFO_VECTOR(a) ((a) & 0xff)
2914#define VMX_EXIT_INT_INFO_TYPE_SHIFT 8
2915#define VMX_EXIT_INT_INFO_TYPE(a) (((a) >> 8) & 7)
2916#define VMX_EXIT_INT_INFO_ERROR_CODE_VALID RT_BIT(11)
2917#define VMX_EXIT_INT_INFO_IS_ERROR_CODE_VALID(a) (((a) >> 11) & 1)
2918#define VMX_EXIT_INT_INFO_NMI_UNBLOCK_IRET 12
2919#define VMX_EXIT_INT_INFO_IS_NMI_UNBLOCK_IRET(a) (((a) >> 12) & 1)
2920#define VMX_EXIT_INT_INFO_VALID RT_BIT(31)
2921#define VMX_EXIT_INT_INFO_IS_VALID(a) (((a) >> 31) & 1)
2922
2923/** If the VM-exit interruption information field indicates an page-fault. */
2924#define VMX_EXIT_INT_INFO_IS_XCPT_PF(a) (((a) & ( VMX_BF_EXIT_INT_INFO_VALID_MASK \
2925 | VMX_BF_EXIT_INT_INFO_TYPE_MASK \
2926 | VMX_BF_EXIT_INT_INFO_VECTOR_MASK)) \
2927 == ( RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_VALID, 1) \
2928 | RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_TYPE, VMX_EXIT_INT_INFO_TYPE_HW_XCPT) \
2929 | RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_VECTOR, X86_XCPT_PF)))
2930/** If the VM-exit interruption information field indicates an double-fault. */
2931#define VMX_EXIT_INT_INFO_IS_XCPT_DF(a) (((a) & ( VMX_BF_EXIT_INT_INFO_VALID_MASK \
2932 | VMX_BF_EXIT_INT_INFO_TYPE_MASK \
2933 | VMX_BF_EXIT_INT_INFO_VECTOR_MASK)) \
2934 == ( RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_VALID, 1) \
2935 | RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_TYPE, VMX_EXIT_INT_INFO_TYPE_HW_XCPT) \
2936 | RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_VECTOR, X86_XCPT_DF)))
2937/** If the VM-exit interruption information field indicates an NMI. */
2938#define VMX_EXIT_INT_INFO_IS_XCPT_NMI(a) (((a) & ( VMX_BF_EXIT_INT_INFO_VALID_MASK \
2939 | VMX_BF_EXIT_INT_INFO_TYPE_MASK \
2940 | VMX_BF_EXIT_INT_INFO_VECTOR_MASK)) \
2941 == ( RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_VALID, 1) \
2942 | RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_TYPE, VMX_EXIT_INT_INFO_TYPE_NMI) \
2943 | RT_BF_MAKE(VMX_BF_EXIT_INT_INFO_VECTOR, X86_XCPT_NMI)))
2944
2945
2946/** Bit fields for VM-exit interruption infomration. */
2947/** The VM-exit interruption vector. */
2948#define VMX_BF_EXIT_INT_INFO_VECTOR_SHIFT 0
2949#define VMX_BF_EXIT_INT_INFO_VECTOR_MASK UINT32_C(0x000000ff)
2950/** The VM-exit interruption type (see VMX_EXIT_INT_INFO_TYPE_XXX). */
2951#define VMX_BF_EXIT_INT_INFO_TYPE_SHIFT 8
2952#define VMX_BF_EXIT_INT_INFO_TYPE_MASK UINT32_C(0x00000700)
2953/** Whether this event has an error code. */
2954#define VMX_BF_EXIT_INT_INFO_ERR_CODE_VALID_SHIFT 11
2955#define VMX_BF_EXIT_INT_INFO_ERR_CODE_VALID_MASK UINT32_C(0x00000800)
2956/** Whether NMI-unblocking due to IRET is active. */
2957#define VMX_BF_EXIT_INT_INFO_NMI_UNBLOCK_IRET_SHIFT 12
2958#define VMX_BF_EXIT_INT_INFO_NMI_UNBLOCK_IRET_MASK UINT32_C(0x00001000)
2959/** Bits 13:30 is reserved (MBZ). */
2960#define VMX_BF_EXIT_INT_INFO_RSVD_13_30_SHIFT 13
2961#define VMX_BF_EXIT_INT_INFO_RSVD_13_30_MASK UINT32_C(0x7fffe000)
2962/** Whether this VM-exit interruption info is valid. */
2963#define VMX_BF_EXIT_INT_INFO_VALID_SHIFT 31
2964#define VMX_BF_EXIT_INT_INFO_VALID_MASK UINT32_C(0x80000000)
2965RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_INT_INFO_, UINT32_C(0), UINT32_MAX,
2966 (VECTOR, TYPE, ERR_CODE_VALID, NMI_UNBLOCK_IRET, RSVD_13_30, VALID));
2967/** @} */
2968
2969
2970/** @name VM-exit interruption information types.
2971 * @{
2972 */
2973#define VMX_EXIT_INT_INFO_TYPE_EXT_INT 0
2974#define VMX_EXIT_INT_INFO_TYPE_NMI 2
2975#define VMX_EXIT_INT_INFO_TYPE_HW_XCPT 3
2976#define VMX_EXIT_INT_INFO_TYPE_SW_INT 4
2977#define VMX_EXIT_INT_INFO_TYPE_PRIV_SW_XCPT 5
2978#define VMX_EXIT_INT_INFO_TYPE_SW_XCPT 6
2979#define VMX_EXIT_INT_INFO_TYPE_UNUSED 7
2980/** @} */
2981
2982
2983/** @name VM-exit instruction identity.
2984 *
2985 * These are found in VM-exit instruction information fields for certain
2986 * instructions.
2987 * @{ */
2988typedef uint32_t VMXINSTRID;
2989/** Whether the instruction ID field is valid. */
2990#define VMXINSTRID_VALID RT_BIT_32(31)
2991/** Whether the instruction's primary operand in the Mod R/M byte (bits 0:3) is a
2992 * read or write. */
2993#define VMXINSTRID_MODRM_PRIMARY_OP_W RT_BIT_32(30)
2994/** Gets whether the instruction ID is valid or not. */
2995#define VMXINSTRID_IS_VALID(a) (((a) >> 31) & 1)
2996#define VMXINSTRID_IS_MODRM_PRIMARY_OP_W(a) (((a) >> 30) & 1)
2997/** Gets the instruction ID. */
2998#define VMXINSTRID_GET_ID(a) ((a) & ~(VMXINSTRID_VALID | VMXINSTRID_MODRM_PRIMARY_OP_W))
2999/** No instruction ID info. */
3000#define VMXINSTRID_NONE 0
3001
3002/** The OR'd rvalues are from the VT-x spec (valid bit is VBox specific): */
3003#define VMXINSTRID_SGDT (0x0 | VMXINSTRID_VALID | VMXINSTRID_MODRM_PRIMARY_OP_W)
3004#define VMXINSTRID_SIDT (0x1 | VMXINSTRID_VALID | VMXINSTRID_MODRM_PRIMARY_OP_W)
3005#define VMXINSTRID_LGDT (0x2 | VMXINSTRID_VALID)
3006#define VMXINSTRID_LIDT (0x3 | VMXINSTRID_VALID)
3007
3008#define VMXINSTRID_SLDT (0x0 | VMXINSTRID_VALID | VMXINSTRID_MODRM_PRIMARY_OP_W)
3009#define VMXINSTRID_STR (0x1 | VMXINSTRID_VALID | VMXINSTRID_MODRM_PRIMARY_OP_W)
3010#define VMXINSTRID_LLDT (0x2 | VMXINSTRID_VALID)
3011#define VMXINSTRID_LTR (0x3 | VMXINSTRID_VALID)
3012
3013/** The following IDs are used internally (some for logging, others for conveying
3014 * the ModR/M primary operand write bit): */
3015#define VMXINSTRID_VMLAUNCH (0x10 | VMXINSTRID_VALID)
3016#define VMXINSTRID_VMRESUME (0x11 | VMXINSTRID_VALID)
3017#define VMXINSTRID_VMREAD (0x12 | VMXINSTRID_VALID)
3018#define VMXINSTRID_VMWRITE (0x13 | VMXINSTRID_VALID | VMXINSTRID_MODRM_PRIMARY_OP_W)
3019#define VMXINSTRID_IO_IN (0x14 | VMXINSTRID_VALID)
3020#define VMXINSTRID_IO_INS (0x15 | VMXINSTRID_VALID)
3021#define VMXINSTRID_IO_OUT (0x16 | VMXINSTRID_VALID)
3022#define VMXINSTRID_IO_OUTS (0x17 | VMXINSTRID_VALID)
3023#define VMXINSTRID_MOV_TO_DRX (0x18 | VMXINSTRID_VALID)
3024#define VMXINSTRID_MOV_FROM_DRX (0x19 | VMXINSTRID_VALID)
3025/** @} */
3026
3027
3028/** @name IDT-vectoring information.
3029 * @{
3030 */
3031#define VMX_IDT_VECTORING_INFO_VECTOR(a) ((a) & 0xff)
3032#define VMX_IDT_VECTORING_INFO_TYPE_SHIFT 8
3033#define VMX_IDT_VECTORING_INFO_TYPE(a) (((a) >> 8) & 7)
3034#define VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID RT_BIT(11)
3035#define VMX_IDT_VECTORING_INFO_IS_ERROR_CODE_VALID(a) (((a) >> 11) & 1)
3036#define VMX_IDT_VECTORING_INFO_IS_VALID(a) (((a) >> 31) & 1)
3037#define VMX_IDT_VECTORING_INFO_VALID RT_BIT(31)
3038
3039/** Construct an IDT-vectoring information field from an VM-entry interruption
3040 * information field (same except that bit 12 is reserved). */
3041#define VMX_IDT_VECTORING_INFO_FROM_ENTRY_INT_INFO(a) ((a) & ~RT_BIT(12))
3042/** If the IDT-vectoring information field indicates a page-fault. */
3043#define VMX_IDT_VECTORING_INFO_IS_XCPT_PF(a) (((a) & ( VMX_BF_IDT_VECTORING_INFO_VALID_MASK \
3044 | VMX_BF_IDT_VECTORING_INFO_TYPE_MASK \
3045 | VMX_BF_IDT_VECTORING_INFO_VECTOR_MASK)) \
3046 == ( RT_BF_MAKE(VMX_BF_IDT_VECTORING_INFO_VALID, 1) \
3047 | RT_BF_MAKE(VMX_BF_IDT_VECTORING_INFO_TYPE, VMX_IDT_VECTORING_INFO_TYPE_HW_XCPT) \
3048 | RT_BF_MAKE(VMX_BF_IDT_VECTORING_INFO_VECTOR, X86_XCPT_PF)))
3049/** If the IDT-vectoring information field indicates an NMI. */
3050#define VMX_IDT_VECTORING_INFO_IS_XCPT_NMI(a) (((a) & ( VMX_BF_IDT_VECTORING_INFO_VALID_MASK \
3051 | VMX_BF_IDT_VECTORING_INFO_TYPE_MASK \
3052 | VMX_BF_IDT_VECTORING_INFO_VECTOR_MASK)) \
3053 == ( RT_BF_MAKE(VMX_BF_IDT_VECTORING_INFO_VALID, 1) \
3054 | RT_BF_MAKE(VMX_BF_IDT_VECTORING_INFO_TYPE, VMX_IDT_VECTORING_INFO_TYPE_NMI) \
3055 | RT_BF_MAKE(VMX_BF_IDT_VECTORING_INFO_VECTOR, X86_XCPT_NMI)))
3056
3057
3058/** Bit fields for IDT-vectoring information. */
3059/** The IDT-vectoring info vector. */
3060#define VMX_BF_IDT_VECTORING_INFO_VECTOR_SHIFT 0
3061#define VMX_BF_IDT_VECTORING_INFO_VECTOR_MASK UINT32_C(0x000000ff)
3062/** The IDT-vectoring info type (see VMX_IDT_VECTORING_INFO_TYPE_XXX). */
3063#define VMX_BF_IDT_VECTORING_INFO_TYPE_SHIFT 8
3064#define VMX_BF_IDT_VECTORING_INFO_TYPE_MASK UINT32_C(0x00000700)
3065/** Whether the event has an error code. */
3066#define VMX_BF_IDT_VECTORING_INFO_ERR_CODE_VALID_SHIFT 11
3067#define VMX_BF_IDT_VECTORING_INFO_ERR_CODE_VALID_MASK UINT32_C(0x00000800)
3068/** Bit 12 is undefined. */
3069#define VMX_BF_IDT_VECTORING_INFO_UNDEF_12_SHIFT 12
3070#define VMX_BF_IDT_VECTORING_INFO_UNDEF_12_MASK UINT32_C(0x00001000)
3071/** Bits 13:30 is reserved (MBZ). */
3072#define VMX_BF_IDT_VECTORING_INFO_RSVD_13_30_SHIFT 13
3073#define VMX_BF_IDT_VECTORING_INFO_RSVD_13_30_MASK UINT32_C(0x7fffe000)
3074/** Whether this IDT-vectoring info is valid. */
3075#define VMX_BF_IDT_VECTORING_INFO_VALID_SHIFT 31
3076#define VMX_BF_IDT_VECTORING_INFO_VALID_MASK UINT32_C(0x80000000)
3077RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_IDT_VECTORING_INFO_, UINT32_C(0), UINT32_MAX,
3078 (VECTOR, TYPE, ERR_CODE_VALID, UNDEF_12, RSVD_13_30, VALID));
3079/** @} */
3080
3081
3082/** @name IDT-vectoring information vector types.
3083 * @{
3084 */
3085#define VMX_IDT_VECTORING_INFO_TYPE_EXT_INT 0
3086#define VMX_IDT_VECTORING_INFO_TYPE_NMI 2
3087#define VMX_IDT_VECTORING_INFO_TYPE_HW_XCPT 3
3088#define VMX_IDT_VECTORING_INFO_TYPE_SW_INT 4
3089#define VMX_IDT_VECTORING_INFO_TYPE_PRIV_SW_XCPT 5
3090#define VMX_IDT_VECTORING_INFO_TYPE_SW_XCPT 6
3091#define VMX_IDT_VECTORING_INFO_TYPE_UNUSED 7
3092/** @} */
3093
3094
3095/** @name TPR threshold.
3096 * @{ */
3097/** Mask of the TPR threshold field (bits 31:4 MBZ). */
3098#define VMX_TPR_THRESHOLD_MASK UINT32_C(0xf)
3099
3100/** Bit fields for TPR threshold. */
3101#define VMX_BF_TPR_THRESHOLD_TPR_SHIFT 0
3102#define VMX_BF_TPR_THRESHOLD_TPR_MASK UINT32_C(0x0000000f)
3103#define VMX_BF_TPR_THRESHOLD_RSVD_4_31_SHIFT 4
3104#define VMX_BF_TPR_THRESHOLD_RSVD_4_31_MASK UINT32_C(0xfffffff0)
3105RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_TPR_THRESHOLD_, UINT32_C(0), UINT32_MAX,
3106 (TPR, RSVD_4_31));
3107/** @} */
3108
3109
3110/** @name Guest-activity states.
3111 * @{
3112 */
3113/** The logical processor is active. */
3114#define VMX_VMCS_GUEST_ACTIVITY_ACTIVE 0x0
3115/** The logical processor is inactive, because it executed a HLT instruction. */
3116#define VMX_VMCS_GUEST_ACTIVITY_HLT 0x1
3117/** The logical processor is inactive, because of a triple fault or other serious error. */
3118#define VMX_VMCS_GUEST_ACTIVITY_SHUTDOWN 0x2
3119/** The logical processor is inactive, because it's waiting for a startup-IPI */
3120#define VMX_VMCS_GUEST_ACTIVITY_SIPI_WAIT 0x3
3121/** @} */
3122
3123
3124/** @name Guest-interruptibility states.
3125 * @{
3126 */
3127#define VMX_VMCS_GUEST_INT_STATE_BLOCK_STI RT_BIT(0)
3128#define VMX_VMCS_GUEST_INT_STATE_BLOCK_MOVSS RT_BIT(1)
3129#define VMX_VMCS_GUEST_INT_STATE_BLOCK_SMI RT_BIT(2)
3130#define VMX_VMCS_GUEST_INT_STATE_BLOCK_NMI RT_BIT(3)
3131#define VMX_VMCS_GUEST_INT_STATE_ENCLAVE RT_BIT(4)
3132
3133/** Mask of the guest-interruptibility state field (bits 31:5 MBZ). */
3134#define VMX_VMCS_GUEST_INT_STATE_MASK UINT32_C(0x1f)
3135/** @} */
3136
3137
3138/** @name Exit qualification for debug exceptions.
3139 * @{
3140 */
3141/** Hardware breakpoint 0 was met. */
3142#define VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP0 RT_BIT_64(0)
3143/** Hardware breakpoint 1 was met. */
3144#define VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP1 RT_BIT_64(1)
3145/** Hardware breakpoint 2 was met. */
3146#define VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP2 RT_BIT_64(2)
3147/** Hardware breakpoint 3 was met. */
3148#define VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP3 RT_BIT_64(3)
3149/** Debug register access detected. */
3150#define VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BD RT_BIT_64(13)
3151/** A debug exception would have been triggered by single-step execution mode. */
3152#define VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BS RT_BIT_64(14)
3153/** Mask of all valid bits. */
3154#define VMX_VMCS_EXIT_QUAL_VALID_MASK ( VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP0 \
3155 | VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP1 \
3156 | VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP2 \
3157 | VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BP3 \
3158 | VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BD \
3159 | VMX_VMCS_EXIT_QUAL_DEBUG_XCPT_BS)
3160
3161/** Bit fields for Exit qualifications due to debug exceptions. */
3162#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP0_SHIFT 0
3163#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP0_MASK UINT64_C(0x0000000000000001)
3164#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP1_SHIFT 1
3165#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP1_MASK UINT64_C(0x0000000000000002)
3166#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP2_SHIFT 2
3167#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP2_MASK UINT64_C(0x0000000000000004)
3168#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP3_SHIFT 3
3169#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BP3_MASK UINT64_C(0x0000000000000008)
3170#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_RSVD_4_12_SHIFT 4
3171#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_RSVD_4_12_MASK UINT64_C(0x0000000000001ff0)
3172#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BD_SHIFT 13
3173#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BD_MASK UINT64_C(0x0000000000002000)
3174#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BS_SHIFT 14
3175#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_BS_MASK UINT64_C(0x0000000000004000)
3176#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_RSVD_15_63_SHIFT 15
3177#define VMX_BF_EXIT_QUAL_DEBUG_XCPT_RSVD_15_63_MASK UINT64_C(0xffffffffffff8000)
3178RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_DEBUG_XCPT_, UINT64_C(0), UINT64_MAX,
3179 (BP0, BP1, BP2, BP3, RSVD_4_12, BD, BS, RSVD_15_63));
3180/** @} */
3181
3182/** @name Exit qualification for Mov DRx.
3183 * @{
3184 */
3185/** 0-2: Debug register number */
3186#define VMX_EXIT_QUAL_DRX_REGISTER(a) ((a) & 7)
3187/** 3: Reserved; cleared to 0. */
3188#define VMX_EXIT_QUAL_DRX_RES1(a) (((a) >> 3) & 1)
3189/** 4: Direction of move (0 = write, 1 = read) */
3190#define VMX_EXIT_QUAL_DRX_DIRECTION(a) (((a) >> 4) & 1)
3191/** 5-7: Reserved; cleared to 0. */
3192#define VMX_EXIT_QUAL_DRX_RES2(a) (((a) >> 5) & 7)
3193/** 8-11: General purpose register number. */
3194#define VMX_EXIT_QUAL_DRX_GENREG(a) (((a) >> 8) & 0xf)
3195
3196/** Bit fields for Exit qualification due to Mov DRx. */
3197#define VMX_BF_EXIT_QUAL_DRX_REGISTER_SHIFT 0
3198#define VMX_BF_EXIT_QUAL_DRX_REGISTER_MASK UINT64_C(0x0000000000000007)
3199#define VMX_BF_EXIT_QUAL_DRX_RSVD_1_SHIFT 3
3200#define VMX_BF_EXIT_QUAL_DRX_RSVD_1_MASK UINT64_C(0x0000000000000008)
3201#define VMX_BF_EXIT_QUAL_DRX_DIRECTION_SHIFT 4
3202#define VMX_BF_EXIT_QUAL_DRX_DIRECTION_MASK UINT64_C(0x0000000000000010)
3203#define VMX_BF_EXIT_QUAL_DRX_RSVD_5_7_SHIFT 5
3204#define VMX_BF_EXIT_QUAL_DRX_RSVD_5_7_MASK UINT64_C(0x00000000000000e0)
3205#define VMX_BF_EXIT_QUAL_DRX_GENREG_SHIFT 8
3206#define VMX_BF_EXIT_QUAL_DRX_GENREG_MASK UINT64_C(0x0000000000000f00)
3207#define VMX_BF_EXIT_QUAL_DRX_RSVD_12_63_SHIFT 12
3208#define VMX_BF_EXIT_QUAL_DRX_RSVD_12_63_MASK UINT64_C(0xfffffffffffff000)
3209RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_DRX_, UINT64_C(0), UINT64_MAX,
3210 (REGISTER, RSVD_1, DIRECTION, RSVD_5_7, GENREG, RSVD_12_63));
3211/** @} */
3212
3213
3214/** @name Exit qualification for debug exceptions types.
3215 * @{
3216 */
3217#define VMX_EXIT_QUAL_DRX_DIRECTION_WRITE 0
3218#define VMX_EXIT_QUAL_DRX_DIRECTION_READ 1
3219/** @} */
3220
3221
3222/** @name Exit qualification for control-register accesses.
3223 * @{
3224 */
3225/** 0-3: Control register number (0 for CLTS & LMSW) */
3226#define VMX_EXIT_QUAL_CRX_REGISTER(a) ((a) & 0xf)
3227/** 4-5: Access type. */
3228#define VMX_EXIT_QUAL_CRX_ACCESS(a) (((a) >> 4) & 3)
3229/** 6: LMSW operand type memory (1 for memory, 0 for register). */
3230#define VMX_EXIT_QUAL_CRX_LMSW_OP_MEM(a) (((a) >> 6) & 1)
3231/** 7: Reserved; cleared to 0. */
3232#define VMX_EXIT_QUAL_CRX_RES1(a) (((a) >> 7) & 1)
3233/** 8-11: General purpose register number (0 for CLTS & LMSW). */
3234#define VMX_EXIT_QUAL_CRX_GENREG(a) (((a) >> 8) & 0xf)
3235/** 12-15: Reserved; cleared to 0. */
3236#define VMX_EXIT_QUAL_CRX_RES2(a) (((a) >> 12) & 0xf)
3237/** 16-31: LMSW source data (else 0). */
3238#define VMX_EXIT_QUAL_CRX_LMSW_DATA(a) (((a) >> 16) & 0xffff)
3239
3240/** Bit fields for Exit qualification for control-register accesses. */
3241#define VMX_BF_EXIT_QUAL_CRX_REGISTER_SHIFT 0
3242#define VMX_BF_EXIT_QUAL_CRX_REGISTER_MASK UINT64_C(0x000000000000000f)
3243#define VMX_BF_EXIT_QUAL_CRX_ACCESS_SHIFT 4
3244#define VMX_BF_EXIT_QUAL_CRX_ACCESS_MASK UINT64_C(0x0000000000000030)
3245#define VMX_BF_EXIT_QUAL_CRX_LMSW_OP_SHIFT 6
3246#define VMX_BF_EXIT_QUAL_CRX_LMSW_OP_MASK UINT64_C(0x0000000000000040)
3247#define VMX_BF_EXIT_QUAL_CRX_RSVD_7_SHIFT 7
3248#define VMX_BF_EXIT_QUAL_CRX_RSVD_7_MASK UINT64_C(0x0000000000000080)
3249#define VMX_BF_EXIT_QUAL_CRX_GENREG_SHIFT 8
3250#define VMX_BF_EXIT_QUAL_CRX_GENREG_MASK UINT64_C(0x0000000000000f00)
3251#define VMX_BF_EXIT_QUAL_CRX_RSVD_12_15_SHIFT 12
3252#define VMX_BF_EXIT_QUAL_CRX_RSVD_12_15_MASK UINT64_C(0x000000000000f000)
3253#define VMX_BF_EXIT_QUAL_CRX_LMSW_DATA_SHIFT 16
3254#define VMX_BF_EXIT_QUAL_CRX_LMSW_DATA_MASK UINT64_C(0x00000000ffff0000)
3255#define VMX_BF_EXIT_QUAL_CRX_RSVD_32_63_SHIFT 32
3256#define VMX_BF_EXIT_QUAL_CRX_RSVD_32_63_MASK UINT64_C(0xffffffff00000000)
3257RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_CRX_, UINT64_C(0), UINT64_MAX,
3258 (REGISTER, ACCESS, LMSW_OP, RSVD_7, GENREG, RSVD_12_15, LMSW_DATA, RSVD_32_63));
3259/** @} */
3260
3261
3262/** @name Exit qualification for control-register access types.
3263 * @{
3264 */
3265#define VMX_EXIT_QUAL_CRX_ACCESS_WRITE 0
3266#define VMX_EXIT_QUAL_CRX_ACCESS_READ 1
3267#define VMX_EXIT_QUAL_CRX_ACCESS_CLTS 2
3268#define VMX_EXIT_QUAL_CRX_ACCESS_LMSW 3
3269/** @} */
3270
3271
3272/** @name Exit qualification for task switch.
3273 * @{
3274 */
3275#define VMX_EXIT_QUAL_TASK_SWITCH_SELECTOR(a) ((a) & 0xffff)
3276#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE(a) (((a) >> 30) & 0x3)
3277/** Task switch caused by a call instruction. */
3278#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_CALL 0
3279/** Task switch caused by an iret instruction. */
3280#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_IRET 1
3281/** Task switch caused by a jmp instruction. */
3282#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_JMP 2
3283/** Task switch caused by an interrupt gate. */
3284#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_IDT 3
3285
3286/** Bit fields for Exit qualification for task switches. */
3287#define VMX_BF_EXIT_QUAL_TASK_SWITCH_NEW_TSS_SHIFT 0
3288#define VMX_BF_EXIT_QUAL_TASK_SWITCH_NEW_TSS_MASK UINT64_C(0x000000000000ffff)
3289#define VMX_BF_EXIT_QUAL_TASK_SWITCH_RSVD_16_29_SHIFT 16
3290#define VMX_BF_EXIT_QUAL_TASK_SWITCH_RSVD_16_29_MASK UINT64_C(0x000000003fff0000)
3291#define VMX_BF_EXIT_QUAL_TASK_SWITCH_SOURCE_SHIFT 30
3292#define VMX_BF_EXIT_QUAL_TASK_SWITCH_SOURCE_MASK UINT64_C(0x00000000c0000000)
3293#define VMX_BF_EXIT_QUAL_TASK_SWITCH_RSVD_32_63_SHIFT 32
3294#define VMX_BF_EXIT_QUAL_TASK_SWITCH_RSVD_32_63_MASK UINT64_C(0xffffffff00000000)
3295RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_TASK_SWITCH_, UINT64_C(0), UINT64_MAX,
3296 (NEW_TSS, RSVD_16_29, SOURCE, RSVD_32_63));
3297/** @} */
3298
3299
3300/** @name Exit qualification for EPT violations.
3301 * @{
3302 */
3303/** Set if acess causing the violation was a data read. */
3304#define VMX_EXIT_QUAL_EPT_ACCESS_READ RT_BIT_64(0)
3305/** Set if acess causing the violation was a data write. */
3306#define VMX_EXIT_QUAL_EPT_ACCESS_WRITE RT_BIT_64(1)
3307/** Set if the violation was caused by an instruction fetch. */
3308#define VMX_EXIT_QUAL_EPT_ACCESS_INSTR_FETCH RT_BIT_64(2)
3309/** AND of the read bit of all EPT structures. */
3310#define VMX_EXIT_QUAL_EPT_ENTRY_READ RT_BIT_64(3)
3311/** AND of the write bit of all EPT structures. */
3312#define VMX_EXIT_QUAL_EPT_ENTRY_WRITE RT_BIT_64(4)
3313/** AND of the execute bit of all EPT structures. */
3314#define VMX_EXIT_QUAL_EPT_ENTRY_EXECUTE RT_BIT_64(5)
3315/** And of the execute bit of all EPT structures for user-mode addresses
3316 * (requires mode-based execute control). */
3317#define VMX_EXIT_QUAL_EPT_ENTRY_EXECUTE_USER RT_BIT_64(6)
3318/** Set if the guest linear address field is valid. */
3319#define VMX_EXIT_QUAL_EPT_LINEAR_ADDR_VALID RT_BIT_64(7)
3320/** If bit 7 is one: (reserved otherwise)
3321 * 1 - violation due to physical address access.
3322 * 0 - violation caused by page walk or access/dirty bit updates.
3323 */
3324#define VMX_EXIT_QUAL_EPT_LINEAR_TO_PHYS_ADDR RT_BIT_64(8)
3325/** If bit 7, 8 and advanced VM-exit info. for EPT is one: (reserved otherwise)
3326 * 1 - linear address is user-mode address.
3327 * 0 - linear address is supervisor-mode address.
3328 */
3329#define VMX_EXIT_QUAL_EPT_LINEAR_ADDR_USER RT_BIT_64(9)
3330/** If bit 7, 8 and advanced VM-exit info. for EPT is one: (reserved otherwise)
3331 * 1 - linear address translates to read-only page.
3332 * 0 - linear address translates to read-write page.
3333 */
3334#define VMX_EXIT_QUAL_EPT_LINEAR_ADDR_RO RT_BIT_64(10)
3335/** If bit 7, 8 and advanced VM-exit info. for EPT is one: (reserved otherwise)
3336 * 1 - linear address translates to executable-disabled page.
3337 * 0 - linear address translates to executable page.
3338 */
3339#define VMX_EXIT_QUAL_EPT_LINEAR_ADDR_XD RT_BIT_64(11)
3340/** NMI unblocking due to IRET. */
3341#define VMX_EXIT_QUAL_EPT_NMI_UNBLOCK_IRET RT_BIT_64(12)
3342/** Set if acess causing the violation was a shadow-stack access. */
3343#define VMX_EXIT_QUAL_EPT_ACCESS_SHW_STACK RT_BIT_64(13)
3344/** If supervisor-shadow stack is enabled: (reserved otherwise)
3345 * 1 - supervisor shadow-stack access allowed.
3346 * 0 - supervisor shadow-stack access disallowed.
3347 */
3348#define VMX_EXIT_QUAL_EPT_ENTRY_SHW_STACK_SUPER RT_BIT_64(14)
3349/** Set if access is related to trace output by Intel PT (reserved otherwise). */
3350#define VMX_EXIT_QUAL_EPT_ACCESS_PT_TRACE RT_BIT_64(16)
3351
3352/** Checks whether NMI unblocking due to IRET. */
3353#define VMX_EXIT_QUAL_EPT_IS_NMI_UNBLOCK_IRET(a) (((a) >> 12) & 1)
3354
3355/** Bit fields for Exit qualification for EPT violations. */
3356#define VMX_BF_EXIT_QUAL_EPT_ACCESS_READ_SHIFT 0
3357#define VMX_BF_EXIT_QUAL_EPT_ACCESS_READ_MASK UINT64_C(0x0000000000000001)
3358#define VMX_BF_EXIT_QUAL_EPT_ACCESS_WRITE_SHIFT 1
3359#define VMX_BF_EXIT_QUAL_EPT_ACCESS_WRITE_MASK UINT64_C(0x0000000000000002)
3360#define VMX_BF_EXIT_QUAL_EPT_ACCESS_INSTR_FETCH_SHIFT 2
3361#define VMX_BF_EXIT_QUAL_EPT_ACCESS_INSTR_FETCH_MASK UINT64_C(0x0000000000000004)
3362#define VMX_BF_EXIT_QUAL_EPT_ENTRY_READ_SHIFT 3
3363#define VMX_BF_EXIT_QUAL_EPT_ENTRY_READ_MASK UINT64_C(0x0000000000000008)
3364#define VMX_BF_EXIT_QUAL_EPT_ENTRY_WRITE_SHIFT 4
3365#define VMX_BF_EXIT_QUAL_EPT_ENTRY_WRITE_MASK UINT64_C(0x0000000000000010)
3366#define VMX_BF_EXIT_QUAL_EPT_ENTRY_EXECUTE_SHIFT 5
3367#define VMX_BF_EXIT_QUAL_EPT_ENTRY_EXECUTE_MASK UINT64_C(0x0000000000000020)
3368#define VMX_BF_EXIT_QUAL_EPT_ENTRY_EXECUTE_USER_SHIFT 6
3369#define VMX_BF_EXIT_QUAL_EPT_ENTRY_EXECUTE_USER_MASK UINT64_C(0x0000000000000040)
3370#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_VALID_SHIFT 7
3371#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_VALID_MASK UINT64_C(0x0000000000000080)
3372#define VMX_BF_EXIT_QUAL_EPT_LINEAR_TO_PHYS_ADDR_SHIFT 8
3373#define VMX_BF_EXIT_QUAL_EPT_LINEAR_TO_PHYS_ADDR_MASK UINT64_C(0x0000000000000100)
3374#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_USER_SHIFT 9
3375#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_USER_MASK UINT64_C(0x0000000000000200)
3376#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_RO_SHIFT 10
3377#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_RO_MASK UINT64_C(0x0000000000000400)
3378#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_XD_SHIFT 11
3379#define VMX_BF_EXIT_QUAL_EPT_LINEAR_ADDR_XD_MASK UINT64_C(0x0000000000000800)
3380#define VMX_BF_EXIT_QUAL_EPT_NMI_UNBLOCK_IRET_SHIFT 12
3381#define VMX_BF_EXIT_QUAL_EPT_NMI_UNBLOCK_IRET_MASK UINT64_C(0x0000000000001000)
3382#define VMX_BF_EXIT_QUAL_EPT_ACCESS_SHW_STACK_SHIFT 13
3383#define VMX_BF_EXIT_QUAL_EPT_ACCESS_SHW_STACK_MASK UINT64_C(0x0000000000002000)
3384#define VMX_BF_EXIT_QUAL_EPT_ENTRY_SHW_STACK_SUPER_SHIFT 14
3385#define VMX_BF_EXIT_QUAL_EPT_ENTRY_SHW_STACK_SUPER_MASK UINT64_C(0x0000000000004000)
3386#define VMX_BF_EXIT_QUAL_EPT_RSVD_15_SHIFT 15
3387#define VMX_BF_EXIT_QUAL_EPT_RSVD_15_MASK UINT64_C(0x0000000000008000)
3388#define VMX_BF_EXIT_QUAL_EPT_ACCESS_PT_TRACE_SHIFT 16
3389#define VMX_BF_EXIT_QUAL_EPT_ACCESS_PT_TRACE_MASK UINT64_C(0x0000000000010000)
3390#define VMX_BF_EXIT_QUAL_EPT_RSVD_17_63_SHIFT 17
3391#define VMX_BF_EXIT_QUAL_EPT_RSVD_17_63_MASK UINT64_C(0xfffffffffffe0000)
3392RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_EPT_, UINT64_C(0), UINT64_MAX,
3393 (ACCESS_READ, ACCESS_WRITE, ACCESS_INSTR_FETCH, ENTRY_READ, ENTRY_WRITE, ENTRY_EXECUTE,
3394 ENTRY_EXECUTE_USER, LINEAR_ADDR_VALID, LINEAR_TO_PHYS_ADDR, LINEAR_ADDR_USER, LINEAR_ADDR_RO,
3395 LINEAR_ADDR_XD, NMI_UNBLOCK_IRET, ACCESS_SHW_STACK, ENTRY_SHW_STACK_SUPER, RSVD_15,
3396 ACCESS_PT_TRACE, RSVD_17_63));
3397/** @} */
3398
3399
3400/** @name Exit qualification for I/O instructions.
3401 * @{
3402 */
3403/** 0-2: IO operation size 0(=1 byte), 1(=2 bytes) and 3(=4 bytes). */
3404#define VMX_EXIT_QUAL_IO_SIZE(a) ((a) & 7)
3405/** 3: IO operation direction. */
3406#define VMX_EXIT_QUAL_IO_DIRECTION(a) (((a) >> 3) & 1)
3407/** 4: String IO operation (INS / OUTS). */
3408#define VMX_EXIT_QUAL_IO_IS_STRING(a) (((a) >> 4) & 1)
3409/** 5: Repeated IO operation. */
3410#define VMX_EXIT_QUAL_IO_IS_REP(a) (((a) >> 5) & 1)
3411/** 6: Operand encoding. */
3412#define VMX_EXIT_QUAL_IO_ENCODING(a) (((a) >> 6) & 1)
3413/** 16-31: IO Port (0-0xffff). */
3414#define VMX_EXIT_QUAL_IO_PORT(a) (((a) >> 16) & 0xffff)
3415
3416/** Bit fields for Exit qualification for I/O instructions. */
3417#define VMX_BF_EXIT_QUAL_IO_WIDTH_SHIFT 0
3418#define VMX_BF_EXIT_QUAL_IO_WIDTH_MASK UINT64_C(0x0000000000000007)
3419#define VMX_BF_EXIT_QUAL_IO_DIRECTION_SHIFT 3
3420#define VMX_BF_EXIT_QUAL_IO_DIRECTION_MASK UINT64_C(0x0000000000000008)
3421#define VMX_BF_EXIT_QUAL_IO_IS_STRING_SHIFT 4
3422#define VMX_BF_EXIT_QUAL_IO_IS_STRING_MASK UINT64_C(0x0000000000000010)
3423#define VMX_BF_EXIT_QUAL_IO_IS_REP_SHIFT 5
3424#define VMX_BF_EXIT_QUAL_IO_IS_REP_MASK UINT64_C(0x0000000000000020)
3425#define VMX_BF_EXIT_QUAL_IO_ENCODING_SHIFT 6
3426#define VMX_BF_EXIT_QUAL_IO_ENCODING_MASK UINT64_C(0x0000000000000040)
3427#define VMX_BF_EXIT_QUAL_IO_RSVD_7_15_SHIFT 7
3428#define VMX_BF_EXIT_QUAL_IO_RSVD_7_15_MASK UINT64_C(0x000000000000ff80)
3429#define VMX_BF_EXIT_QUAL_IO_PORT_SHIFT 16
3430#define VMX_BF_EXIT_QUAL_IO_PORT_MASK UINT64_C(0x00000000ffff0000)
3431#define VMX_BF_EXIT_QUAL_IO_RSVD_32_63_SHIFT 32
3432#define VMX_BF_EXIT_QUAL_IO_RSVD_32_63_MASK UINT64_C(0xffffffff00000000)
3433RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_IO_, UINT64_C(0), UINT64_MAX,
3434 (WIDTH, DIRECTION, IS_STRING, IS_REP, ENCODING, RSVD_7_15, PORT, RSVD_32_63));
3435/** @} */
3436
3437
3438/** @name Exit qualification for I/O instruction types.
3439 * @{
3440 */
3441#define VMX_EXIT_QUAL_IO_DIRECTION_OUT 0
3442#define VMX_EXIT_QUAL_IO_DIRECTION_IN 1
3443/** @} */
3444
3445
3446/** @name Exit qualification for I/O instruction encoding.
3447 * @{
3448 */
3449#define VMX_EXIT_QUAL_IO_ENCODING_DX 0
3450#define VMX_EXIT_QUAL_IO_ENCODING_IMM 1
3451/** @} */
3452
3453
3454/** @name Exit qualification for APIC-access VM-exits from linear and
3455 * guest-physical accesses.
3456 * @{
3457 */
3458/** 0-11: If the APIC-access VM-exit is due to a linear access, the offset of
3459 * access within the APIC page. */
3460#define VMX_EXIT_QUAL_APIC_ACCESS_OFFSET(a) ((a) & 0xfff)
3461/** 12-15: Access type. */
3462#define VMX_EXIT_QUAL_APIC_ACCESS_TYPE(a) (((a) & 0xf000) >> 12)
3463/* Rest reserved. */
3464
3465/** Bit fields for Exit qualification for APIC-access VM-exits. */
3466#define VMX_BF_EXIT_QUAL_APIC_ACCESS_OFFSET_SHIFT 0
3467#define VMX_BF_EXIT_QUAL_APIC_ACCESS_OFFSET_MASK UINT64_C(0x0000000000000fff)
3468#define VMX_BF_EXIT_QUAL_APIC_ACCESS_TYPE_SHIFT 12
3469#define VMX_BF_EXIT_QUAL_APIC_ACCESS_TYPE_MASK UINT64_C(0x000000000000f000)
3470#define VMX_BF_EXIT_QUAL_APIC_ACCESS_RSVD_16_63_SHIFT 16
3471#define VMX_BF_EXIT_QUAL_APIC_ACCESS_RSVD_16_63_MASK UINT64_C(0xffffffffffff0000)
3472RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_QUAL_APIC_ACCESS_, UINT64_C(0), UINT64_MAX,
3473 (OFFSET, TYPE, RSVD_16_63));
3474/** @} */
3475
3476
3477/** @name Exit qualification for linear address APIC-access types.
3478 * @{
3479 */
3480/** Linear access for a data read during instruction execution. */
3481#define VMX_APIC_ACCESS_TYPE_LINEAR_READ 0
3482/** Linear access for a data write during instruction execution. */
3483#define VMX_APIC_ACCESS_TYPE_LINEAR_WRITE 1
3484/** Linear access for an instruction fetch. */
3485#define VMX_APIC_ACCESS_TYPE_LINEAR_INSTR_FETCH 2
3486/** Linear read/write access during event delivery. */
3487#define VMX_APIC_ACCESS_TYPE_LINEAR_EVENT_DELIVERY 3
3488/** Physical read/write access during event delivery. */
3489#define VMX_APIC_ACCESS_TYPE_PHYSICAL_EVENT_DELIVERY 10
3490/** Physical access for an instruction fetch or during instruction execution. */
3491#define VMX_APIC_ACCESS_TYPE_PHYSICAL_INSTR 15
3492
3493/**
3494 * APIC-access type.
3495 * In accordance with the VT-x spec.
3496 */
3497typedef enum
3498{
3499 VMXAPICACCESS_LINEAR_READ = VMX_APIC_ACCESS_TYPE_LINEAR_READ,
3500 VMXAPICACCESS_LINEAR_WRITE = VMX_APIC_ACCESS_TYPE_LINEAR_WRITE,
3501 VMXAPICACCESS_LINEAR_INSTR_FETCH = VMX_APIC_ACCESS_TYPE_LINEAR_INSTR_FETCH,
3502 VMXAPICACCESS_LINEAR_EVENT_DELIVERY = VMX_APIC_ACCESS_TYPE_LINEAR_EVENT_DELIVERY,
3503 VMXAPICACCESS_PHYSICAL_EVENT_DELIVERY = VMX_APIC_ACCESS_TYPE_PHYSICAL_EVENT_DELIVERY,
3504 VMXAPICACCESS_PHYSICAL_INSTR = VMX_APIC_ACCESS_TYPE_PHYSICAL_INSTR
3505} VMXAPICACCESS;
3506AssertCompileSize(VMXAPICACCESS, 4);
3507/** @} */
3508
3509
3510/** @name VMX_BF_XXTR_INSINFO_XXX - VMX_EXIT_XDTR_ACCESS instruction information.
3511 * Found in VMX_VMCS32_RO_EXIT_INSTR_INFO.
3512 * @{
3513 */
3514/** Address calculation scaling field (powers of two). */
3515#define VMX_BF_XDTR_INSINFO_SCALE_SHIFT 0
3516#define VMX_BF_XDTR_INSINFO_SCALE_MASK UINT32_C(0x00000003)
3517/** Bits 2 thru 6 are undefined. */
3518#define VMX_BF_XDTR_INSINFO_UNDEF_2_6_SHIFT 2
3519#define VMX_BF_XDTR_INSINFO_UNDEF_2_6_MASK UINT32_C(0x0000007c)
3520/** Address size, only 0(=16), 1(=32) and 2(=64) are defined.
3521 * @remarks anyone's guess why this is a 3 bit field... */
3522#define VMX_BF_XDTR_INSINFO_ADDR_SIZE_SHIFT 7
3523#define VMX_BF_XDTR_INSINFO_ADDR_SIZE_MASK UINT32_C(0x00000380)
3524/** Bit 10 is defined as zero. */
3525#define VMX_BF_XDTR_INSINFO_ZERO_10_SHIFT 10
3526#define VMX_BF_XDTR_INSINFO_ZERO_10_MASK UINT32_C(0x00000400)
3527/** Operand size, either (1=)32-bit or (0=)16-bit, but get this, it's undefined
3528 * for exits from 64-bit code as the operand size there is fixed. */
3529#define VMX_BF_XDTR_INSINFO_OP_SIZE_SHIFT 11
3530#define VMX_BF_XDTR_INSINFO_OP_SIZE_MASK UINT32_C(0x00000800)
3531/** Bits 12 thru 14 are undefined. */
3532#define VMX_BF_XDTR_INSINFO_UNDEF_12_14_SHIFT 12
3533#define VMX_BF_XDTR_INSINFO_UNDEF_12_14_MASK UINT32_C(0x00007000)
3534/** Applicable segment register (X86_SREG_XXX values). */
3535#define VMX_BF_XDTR_INSINFO_SREG_SHIFT 15
3536#define VMX_BF_XDTR_INSINFO_SREG_MASK UINT32_C(0x00038000)
3537/** Index register (X86_GREG_XXX values). Undefined if HAS_INDEX_REG is clear. */
3538#define VMX_BF_XDTR_INSINFO_INDEX_REG_SHIFT 18
3539#define VMX_BF_XDTR_INSINFO_INDEX_REG_MASK UINT32_C(0x003c0000)
3540/** Is VMX_BF_XDTR_INSINFO_INDEX_REG_XXX valid (=1) or not (=0). */
3541#define VMX_BF_XDTR_INSINFO_HAS_INDEX_REG_SHIFT 22
3542#define VMX_BF_XDTR_INSINFO_HAS_INDEX_REG_MASK UINT32_C(0x00400000)
3543/** Base register (X86_GREG_XXX values). Undefined if HAS_BASE_REG is clear. */
3544#define VMX_BF_XDTR_INSINFO_BASE_REG_SHIFT 23
3545#define VMX_BF_XDTR_INSINFO_BASE_REG_MASK UINT32_C(0x07800000)
3546/** Is VMX_XDTR_INSINFO_BASE_REG_XXX valid (=1) or not (=0). */
3547#define VMX_BF_XDTR_INSINFO_HAS_BASE_REG_SHIFT 27
3548#define VMX_BF_XDTR_INSINFO_HAS_BASE_REG_MASK UINT32_C(0x08000000)
3549/** The instruction identity (VMX_XDTR_INSINFO_II_XXX values). */
3550#define VMX_BF_XDTR_INSINFO_INSTR_ID_SHIFT 28
3551#define VMX_BF_XDTR_INSINFO_INSTR_ID_MASK UINT32_C(0x30000000)
3552#define VMX_XDTR_INSINFO_II_SGDT 0 /**< Instruction ID: SGDT */
3553#define VMX_XDTR_INSINFO_II_SIDT 1 /**< Instruction ID: SIDT */
3554#define VMX_XDTR_INSINFO_II_LGDT 2 /**< Instruction ID: LGDT */
3555#define VMX_XDTR_INSINFO_II_LIDT 3 /**< Instruction ID: LIDT */
3556/** Bits 30 & 31 are undefined. */
3557#define VMX_BF_XDTR_INSINFO_UNDEF_30_31_SHIFT 30
3558#define VMX_BF_XDTR_INSINFO_UNDEF_30_31_MASK UINT32_C(0xc0000000)
3559RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_XDTR_INSINFO_, UINT32_C(0), UINT32_MAX,
3560 (SCALE, UNDEF_2_6, ADDR_SIZE, ZERO_10, OP_SIZE, UNDEF_12_14, SREG, INDEX_REG, HAS_INDEX_REG,
3561 BASE_REG, HAS_BASE_REG, INSTR_ID, UNDEF_30_31));
3562/** @} */
3563
3564
3565/** @name VMX_BF_YYTR_INSINFO_XXX - VMX_EXIT_TR_ACCESS instruction information.
3566 * Found in VMX_VMCS32_RO_EXIT_INSTR_INFO.
3567 * This is similar to VMX_BF_XDTR_INSINFO_XXX.
3568 * @{
3569 */
3570/** Address calculation scaling field (powers of two). */
3571#define VMX_BF_YYTR_INSINFO_SCALE_SHIFT 0
3572#define VMX_BF_YYTR_INSINFO_SCALE_MASK UINT32_C(0x00000003)
3573/** Bit 2 is undefined. */
3574#define VMX_BF_YYTR_INSINFO_UNDEF_2_SHIFT 2
3575#define VMX_BF_YYTR_INSINFO_UNDEF_2_MASK UINT32_C(0x00000004)
3576/** Register operand 1. Undefined if VMX_YYTR_INSINFO_HAS_REG1 is clear. */
3577#define VMX_BF_YYTR_INSINFO_REG1_SHIFT 3
3578#define VMX_BF_YYTR_INSINFO_REG1_MASK UINT32_C(0x00000078)
3579/** Address size, only 0(=16), 1(=32) and 2(=64) are defined.
3580 * @remarks anyone's guess why this is a 3 bit field... */
3581#define VMX_BF_YYTR_INSINFO_ADDR_SIZE_SHIFT 7
3582#define VMX_BF_YYTR_INSINFO_ADDR_SIZE_MASK UINT32_C(0x00000380)
3583/** Is VMX_YYTR_INSINFO_REG1_XXX valid (=1) or not (=0). */
3584#define VMX_BF_YYTR_INSINFO_HAS_REG1_SHIFT 10
3585#define VMX_BF_YYTR_INSINFO_HAS_REG1_MASK UINT32_C(0x00000400)
3586/** Bits 11 thru 14 are undefined. */
3587#define VMX_BF_YYTR_INSINFO_UNDEF_11_14_SHIFT 11
3588#define VMX_BF_YYTR_INSINFO_UNDEF_11_14_MASK UINT32_C(0x00007800)
3589/** Applicable segment register (X86_SREG_XXX values). */
3590#define VMX_BF_YYTR_INSINFO_SREG_SHIFT 15
3591#define VMX_BF_YYTR_INSINFO_SREG_MASK UINT32_C(0x00038000)
3592/** Index register (X86_GREG_XXX values). Undefined if HAS_INDEX_REG is clear. */
3593#define VMX_BF_YYTR_INSINFO_INDEX_REG_SHIFT 18
3594#define VMX_BF_YYTR_INSINFO_INDEX_REG_MASK UINT32_C(0x003c0000)
3595/** Is VMX_YYTR_INSINFO_INDEX_REG_XXX valid (=1) or not (=0). */
3596#define VMX_BF_YYTR_INSINFO_HAS_INDEX_REG_SHIFT 22
3597#define VMX_BF_YYTR_INSINFO_HAS_INDEX_REG_MASK UINT32_C(0x00400000)
3598/** Base register (X86_GREG_XXX values). Undefined if HAS_BASE_REG is clear. */
3599#define VMX_BF_YYTR_INSINFO_BASE_REG_SHIFT 23
3600#define VMX_BF_YYTR_INSINFO_BASE_REG_MASK UINT32_C(0x07800000)
3601/** Is VMX_YYTR_INSINFO_BASE_REG_XXX valid (=1) or not (=0). */
3602#define VMX_BF_YYTR_INSINFO_HAS_BASE_REG_SHIFT 27
3603#define VMX_BF_YYTR_INSINFO_HAS_BASE_REG_MASK UINT32_C(0x08000000)
3604/** The instruction identity (VMX_YYTR_INSINFO_II_XXX values) */
3605#define VMX_BF_YYTR_INSINFO_INSTR_ID_SHIFT 28
3606#define VMX_BF_YYTR_INSINFO_INSTR_ID_MASK UINT32_C(0x30000000)
3607#define VMX_YYTR_INSINFO_II_SLDT 0 /**< Instruction ID: SLDT */
3608#define VMX_YYTR_INSINFO_II_STR 1 /**< Instruction ID: STR */
3609#define VMX_YYTR_INSINFO_II_LLDT 2 /**< Instruction ID: LLDT */
3610#define VMX_YYTR_INSINFO_II_LTR 3 /**< Instruction ID: LTR */
3611/** Bits 30 & 31 are undefined. */
3612#define VMX_BF_YYTR_INSINFO_UNDEF_30_31_SHIFT 30
3613#define VMX_BF_YYTR_INSINFO_UNDEF_30_31_MASK UINT32_C(0xc0000000)
3614RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_YYTR_INSINFO_, UINT32_C(0), UINT32_MAX,
3615 (SCALE, UNDEF_2, REG1, ADDR_SIZE, HAS_REG1, UNDEF_11_14, SREG, INDEX_REG, HAS_INDEX_REG,
3616 BASE_REG, HAS_BASE_REG, INSTR_ID, UNDEF_30_31));
3617/** @} */
3618
3619
3620/** @name Format of Pending-Debug-Exceptions.
3621 * Bits 4-11, 13, 15 and 17-63 are reserved.
3622 * Similar to DR6 except bit 12 (breakpoint enabled) and bit 16 (RTM) are both
3623 * possibly valid here but not in DR6.
3624 * @{
3625 */
3626/** Hardware breakpoint 0 was met. */
3627#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP0 RT_BIT_64(0)
3628/** Hardware breakpoint 1 was met. */
3629#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP1 RT_BIT_64(1)
3630/** Hardware breakpoint 2 was met. */
3631#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP2 RT_BIT_64(2)
3632/** Hardware breakpoint 3 was met. */
3633#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP3 RT_BIT_64(3)
3634/** At least one data or IO breakpoint was hit. */
3635#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_EN_BP RT_BIT_64(12)
3636/** A debug exception would have been triggered by single-step execution mode. */
3637#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BS RT_BIT_64(14)
3638/** A debug exception occurred inside an RTM region. */
3639#define VMX_VMCS_GUEST_PENDING_DEBUG_RTM RT_BIT_64(16)
3640/** Mask of valid bits. */
3641#define VMX_VMCS_GUEST_PENDING_DEBUG_VALID_MASK ( VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP0 \
3642 | VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP1 \
3643 | VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP2 \
3644 | VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP3 \
3645 | VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_EN_BP \
3646 | VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BS \
3647 | VMX_VMCS_GUEST_PENDING_DEBUG_RTM)
3648#define VMX_VMCS_GUEST_PENDING_DEBUG_RTM_MASK ( VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_EN_BP \
3649 | VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BS \
3650 | VMX_VMCS_GUEST_PENDING_DEBUG_RTM)
3651/** Bit fields for Pending debug exceptions. */
3652#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP0_SHIFT 0
3653#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP0_MASK UINT64_C(0x0000000000000001)
3654#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP1_SHIFT 1
3655#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP1_MASK UINT64_C(0x0000000000000002)
3656#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP2_SHIFT 2
3657#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP2_MASK UINT64_C(0x0000000000000004)
3658#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP3_SHIFT 3
3659#define VMX_BF_VMCS_PENDING_DBG_XCPT_BP3_MASK UINT64_C(0x0000000000000008)
3660#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_4_11_SHIFT 4
3661#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_4_11_MASK UINT64_C(0x0000000000000ff0)
3662#define VMX_BF_VMCS_PENDING_DBG_XCPT_EN_BP_SHIFT 12
3663#define VMX_BF_VMCS_PENDING_DBG_XCPT_EN_BP_MASK UINT64_C(0x0000000000001000)
3664#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_13_SHIFT 13
3665#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_13_MASK UINT64_C(0x0000000000002000)
3666#define VMX_BF_VMCS_PENDING_DBG_XCPT_BS_SHIFT 14
3667#define VMX_BF_VMCS_PENDING_DBG_XCPT_BS_MASK UINT64_C(0x0000000000004000)
3668#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_15_SHIFT 15
3669#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_15_MASK UINT64_C(0x0000000000008000)
3670#define VMX_BF_VMCS_PENDING_DBG_XCPT_RTM_SHIFT 16
3671#define VMX_BF_VMCS_PENDING_DBG_XCPT_RTM_MASK UINT64_C(0x0000000000010000)
3672#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_17_63_SHIFT 17
3673#define VMX_BF_VMCS_PENDING_DBG_XCPT_RSVD_17_63_MASK UINT64_C(0xfffffffffffe0000)
3674RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMCS_PENDING_DBG_XCPT_, UINT64_C(0), UINT64_MAX,
3675 (BP0, BP1, BP2, BP3, RSVD_4_11, EN_BP, RSVD_13, BS, RSVD_15, RTM, RSVD_17_63));
3676/** @} */
3677
3678
3679/**
3680 * VM-exit auxiliary information.
3681 *
3682 * This includes information that isn't necessarily stored in the guest-CPU
3683 * context but provided as part of VM-exits.
3684 */
3685typedef struct
3686{
3687 /** The VM-exit reason. */
3688 uint32_t uReason;
3689 /** The Exit qualification field. */
3690 uint64_t u64Qual;
3691 /** The Guest-linear address field. */
3692 uint64_t u64GuestLinearAddr;
3693 /** The Guest-physical address field. */
3694 uint64_t u64GuestPhysAddr;
3695 /** The guest pending-debug exceptions. */
3696 uint64_t u64GuestPendingDbgXcpts;
3697 /** The VM-exit instruction length. */
3698 uint32_t cbInstr;
3699 /** The VM-exit instruction information. */
3700 VMXEXITINSTRINFO InstrInfo;
3701 /** VM-exit interruption information. */
3702 uint32_t uExitIntInfo;
3703 /** VM-exit interruption error code. */
3704 uint32_t uExitIntErrCode;
3705 /** IDT-vectoring information. */
3706 uint32_t uIdtVectoringInfo;
3707 /** IDT-vectoring error code. */
3708 uint32_t uIdtVectoringErrCode;
3709} VMXEXITAUX;
3710/** Pointer to a VMXEXITAUX struct. */
3711typedef VMXEXITAUX *PVMXEXITAUX;
3712/** Pointer to a const VMXEXITAUX struct. */
3713typedef const VMXEXITAUX *PCVMXEXITAUX;
3714
3715
3716/** @defgroup grp_hm_vmx_virt VMX virtualization.
3717 * @{
3718 */
3719
3720/** @name Virtual VMX MSR - Miscellaneous data.
3721 * @{ */
3722/** Number of CR3-target values supported. */
3723#define VMX_V_CR3_TARGET_COUNT 4
3724/** Activity states supported. */
3725#define VMX_V_GUEST_ACTIVITY_STATE_MASK (VMX_VMCS_GUEST_ACTIVITY_HLT | VMX_VMCS_GUEST_ACTIVITY_SHUTDOWN)
3726/** VMX preemption-timer shift (Core i7-2600 taken as reference). */
3727#define VMX_V_PREEMPT_TIMER_SHIFT 5
3728/** Maximum number of MSRs in the auto-load/store MSR areas, (n+1) * 512. */
3729#define VMX_V_AUTOMSR_COUNT_MAX 0
3730/** SMM MSEG revision ID. */
3731#define VMX_V_MSEG_REV_ID 0
3732/** @} */
3733
3734/** @name VMX_V_VMCS_STATE_XXX - Virtual VMCS launch state.
3735 * @{ */
3736/** VMCS launch state clear. */
3737#define VMX_V_VMCS_LAUNCH_STATE_CLEAR RT_BIT(0)
3738/** VMCS launch state active. */
3739#define VMX_V_VMCS_LAUNCH_STATE_ACTIVE RT_BIT(1)
3740/** VMCS launch state current. */
3741#define VMX_V_VMCS_LAUNCH_STATE_CURRENT RT_BIT(2)
3742/** VMCS launch state launched. */
3743#define VMX_V_VMCS_LAUNCH_STATE_LAUNCHED RT_BIT(3)
3744/** The mask of valid VMCS launch states. */
3745#define VMX_V_VMCS_LAUNCH_STATE_MASK ( VMX_V_VMCS_LAUNCH_STATE_CLEAR \
3746 | VMX_V_VMCS_LAUNCH_STATE_ACTIVE \
3747 | VMX_V_VMCS_LAUNCH_STATE_CURRENT \
3748 | VMX_V_VMCS_LAUNCH_STATE_LAUNCHED)
3749/** @} */
3750
3751/** CR0 bits set here must always be set when in VMX operation. */
3752#define VMX_V_CR0_FIXED0 (X86_CR0_PE | X86_CR0_NE | X86_CR0_PG)
3753/** CR0 bits set here must always be set when in VMX non-root operation with
3754 * unrestricted-guest control enabled. */
3755#define VMX_V_CR0_FIXED0_UX (X86_CR0_NE)
3756/** CR0 bits cleared here must always be cleared when in VMX operation. */
3757#define VMX_V_CR0_FIXED1 UINT32_C(0xffffffff)
3758/** CR4 bits set here must always be set when in VMX operation. */
3759#define VMX_V_CR4_FIXED0 (X86_CR4_VMXE)
3760
3761/** Virtual VMCS revision ID. Bump this arbitarily chosen identifier if incompatible
3762 * changes to the layout of VMXVVMCS is done. Bit 31 MBZ. */
3763#define VMX_V_VMCS_REVISION_ID UINT32_C(0x40000001)
3764AssertCompile(!(VMX_V_VMCS_REVISION_ID & RT_BIT(31)));
3765
3766/** The size of the virtual VMCS region (we use the maximum allowed size to avoid
3767 * complications when teleporation may be implemented). */
3768#define VMX_V_VMCS_SIZE X86_PAGE_4K_SIZE
3769/** The size of the virtual VMCS region (in pages). */
3770#define VMX_V_VMCS_PAGES 1
3771
3772/** The size of the virtual shadow VMCS region. */
3773#define VMX_V_SHADOW_VMCS_SIZE VMX_V_VMCS_SIZE
3774/** The size of the virtual shadow VMCS region (in pages). */
3775#define VMX_V_SHADOW_VMCS_PAGES VMX_V_VMCS_PAGES
3776
3777/** The size of the Virtual-APIC page (in bytes). */
3778#define VMX_V_VIRT_APIC_SIZE X86_PAGE_4K_SIZE
3779/** The size of the Virtual-APIC page (in pages). */
3780#define VMX_V_VIRT_APIC_PAGES 1
3781
3782/** The size of the VMREAD/VMWRITE bitmap (in bytes). */
3783#define VMX_V_VMREAD_VMWRITE_BITMAP_SIZE X86_PAGE_4K_SIZE
3784/** The size of the VMREAD/VMWRITE-bitmap (in pages). */
3785#define VMX_V_VMREAD_VMWRITE_BITMAP_PAGES 1
3786
3787/** The size of the MSR bitmap (in bytes). */
3788#define VMX_V_MSR_BITMAP_SIZE X86_PAGE_4K_SIZE
3789/** The size of the MSR bitmap (in pages). */
3790#define VMX_V_MSR_BITMAP_PAGES 1
3791
3792/** The size of I/O bitmap A (in bytes). */
3793#define VMX_V_IO_BITMAP_A_SIZE X86_PAGE_4K_SIZE
3794/** The size of I/O bitmap A (in pages). */
3795#define VMX_V_IO_BITMAP_A_PAGES 1
3796
3797/** The size of I/O bitmap B (in bytes). */
3798#define VMX_V_IO_BITMAP_B_SIZE X86_PAGE_4K_SIZE
3799/** The size of I/O bitmap B (in pages). */
3800#define VMX_V_IO_BITMAP_B_PAGES 1
3801
3802/** The size of the auto-load/store MSR area (in bytes). */
3803#define VMX_V_AUTOMSR_AREA_SIZE ((512 * (VMX_V_AUTOMSR_COUNT_MAX + 1)) * sizeof(VMXAUTOMSR))
3804/* Assert that the size is page aligned or adjust the VMX_V_AUTOMSR_AREA_PAGES macro below. */
3805AssertCompile(RT_ALIGN_Z(VMX_V_AUTOMSR_AREA_SIZE, X86_PAGE_4K_SIZE) == VMX_V_AUTOMSR_AREA_SIZE);
3806/** The size of the auto-load/store MSR area (in pages). */
3807#define VMX_V_AUTOMSR_AREA_PAGES ((VMX_V_AUTOMSR_AREA_SIZE) >> X86_PAGE_4K_SHIFT)
3808
3809/** The highest index value used for supported virtual VMCS field encoding. */
3810#define VMX_V_VMCS_MAX_INDEX RT_BF_GET(VMX_VMCS64_CTRL_ENCLV_EXITING_BITMAP_HIGH, VMX_BF_VMCSFIELD_INDEX)
3811
3812/**
3813 * Virtual VM-exit information.
3814 *
3815 * This is a convenience structure that bundles some VM-exit information related
3816 * fields together.
3817 */
3818typedef struct
3819{
3820 /** The VM-exit reason. */
3821 uint32_t uReason;
3822 /** The VM-exit instruction length. */
3823 uint32_t cbInstr;
3824 /** The VM-exit instruction information. */
3825 VMXEXITINSTRINFO InstrInfo;
3826 /** The VM-exit instruction ID. */
3827 VMXINSTRID uInstrId;
3828
3829 /** The Exit qualification field. */
3830 uint64_t u64Qual;
3831 /** The Guest-linear address field. */
3832 uint64_t u64GuestLinearAddr;
3833 /** The Guest-physical address field. */
3834 uint64_t u64GuestPhysAddr;
3835 /** The guest pending-debug exceptions. */
3836 uint64_t u64GuestPendingDbgXcpts;
3837 /** The effective guest-linear address if @a InstrInfo indicates a memory-based
3838 * instruction VM-exit. */
3839 RTGCPTR GCPtrEffAddr;
3840} VMXVEXITINFO;
3841/** Pointer to the VMXVEXITINFO struct. */
3842typedef VMXVEXITINFO *PVMXVEXITINFO;
3843/** Pointer to a const VMXVEXITINFO struct. */
3844typedef const VMXVEXITINFO *PCVMXVEXITINFO;
3845AssertCompileMemberAlignment(VMXVEXITINFO, u64Qual, 8);
3846
3847/** Initialize a VMXVEXITINFO structure from only an exit reason. */
3848#define VMXVEXITINFO_INIT_ONLY_REASON(a_uReason) \
3849 { (a_uReason), 0, { 0 }, VMXINSTRID_NONE, 0, 0, 0, 0, 0 }
3850
3851/** Initialize a VMXVEXITINFO structure from exit reason and instruction length (no info). */
3852#define VMXVEXITINFO_INIT_WITH_INSTR_LEN(a_uReason, a_cbInstr) \
3853 { (a_uReason), (a_cbInstr), { 0 }, VMXINSTRID_NONE, 0, 0, 0, 0, 0 }
3854
3855/** Initialize a VMXVEXITINFO structure from exit reason and exit qualifier. */
3856#define VMXVEXITINFO_INIT_WITH_QUALIFIER(a_uReason, a_uQualifier) \
3857 { (a_uReason), 0, { 0 }, VMXINSTRID_NONE, (a_uQualifier), 0, 0, 0, 0 }
3858
3859/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier,
3860 * instruction info and length. */
3861#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_INFO(a_uReason, a_uQualifier, a_uInstrInfo, a_cbInstr) \
3862 { (a_uReason), (a_cbInstr), { a_uInstrInfo }, VMXINSTRID_NONE, (a_uQualifier), 0, 0, 0, 0 }
3863
3864/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier,
3865 * instruction info and length all copied from a VMXTRANSIENT structure. */
3866#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_INFO_FROM_TRANSIENT(a_pVmxTransient) \
3867 VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_INFO((a_pVmxTransient)->uExitReason, \
3868 (a_pVmxTransient)->uExitQual, \
3869 (a_pVmxTransient)->ExitInstrInfo.u, \
3870 (a_pVmxTransient)->cbExitInstr)
3871
3872/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier,
3873 * instruction length (no info). */
3874#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_LEN(a_uReason, a_uQualifier, a_cbInstr) \
3875 { (a_uReason), (a_cbInstr), { 0 }, VMXINSTRID_NONE, (a_uQualifier), 0, 0, 0, 0 }
3876
3877/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier and
3878 * instruction length (no info) all copied from a VMXTRANSIENT structure. */
3879#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_LEN_FROM_TRANSIENT(a_pVmxTransient) \
3880 VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_LEN((a_pVmxTransient)->uExitReason, \
3881 (a_pVmxTransient)->uExitQual, \
3882 (a_pVmxTransient)->cbExitInstr)
3883
3884/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier,
3885 * instruction info, instruction length and guest linear address. */
3886#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_INFO_AND_LIN_ADDR(a_uReason, a_uQualifier, a_uInstrInfo, \
3887 a_cbInstr, a_uGstLinAddr) \
3888 { (a_uReason), (a_cbInstr), { (a_uInstrInfo) }, VMXINSTRID_NONE, (a_uQualifier), (a_uGstLinAddr), 0, 0, 0 }
3889
3890/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier,
3891 * instruction info, instruction length and guest linear address all copied
3892 * from a VMXTRANSIENT structure. */
3893#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_INFO_AND_LIN_ADDR_FROM_TRANSIENT(a_pVmxTransient) \
3894 VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_INFO_AND_LIN_ADDR((a_pVmxTransient)->uExitReason, \
3895 (a_pVmxTransient)->uExitQual, \
3896 (a_pVmxTransient)->ExitInstrInfo.u, \
3897 (a_pVmxTransient)->cbExitInstr, \
3898 (a_pVmxTransient)->uGuestLinearAddr)
3899
3900/** Initialize a VMXVEXITINFO structure from exit reason and pending debug
3901 * exceptions. */
3902#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_DBG_XCPTS(a_uReason, a_uPendingDbgXcpts) \
3903 { (a_uReason), 0, { 0 }, VMXINSTRID_NONE, 0, 0, 0, (a_uPendingDbgXcpts), 0 }
3904
3905/** Initialize a VMXVEXITINFO structure from exit reason and pending debug
3906 * exceptions both copied from a VMXTRANSIENT structure. */
3907#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_DBG_XCPTS_FROM_TRANSIENT(a_pVmxTransient) \
3908 VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_DBG_XCPTS((a_pVmxTransient)->uExitReason, (a_pVmxTransient)->uGuestPendingDbgXcpts)
3909
3910
3911/** Initialize a VMXVEXITINFO structure from exit reason, exit qualifier,
3912 * instruction length, guest linear address and guest physical address. */
3913#define VMXVEXITINFO_INIT_WITH_QUALIFIER_AND_INSTR_LEN_AND_GST_ADDRESSES(a_uReason, a_uQualifier, a_cbInstr, \
3914 a_uGstLinAddr, a_uGstPhysAddr) \
3915 { (a_uReason), (a_cbInstr), { 0 }, VMXINSTRID_NONE, (a_uQualifier), (a_uGstLinAddr), (a_uGstPhysAddr), 0, 0 }
3916
3917
3918/**
3919 * Virtual VM-exit information for events.
3920 *
3921 * This is a convenience structure that bundles some event-based VM-exit information
3922 * related fields together that are not included in VMXVEXITINFO.
3923 *
3924 * This is kept as a separate structure and not included in VMXVEXITINFO, to make it
3925 * easier to distinguish that IEM VM-exit handlers will set one or more of the
3926 * following fields in the virtual VMCS. Including it in the VMXVEXITINFO will not
3927 * make it ovbious which fields may get set (or cleared).
3928 */
3929typedef struct
3930{
3931 /** VM-exit interruption information. */
3932 uint32_t uExitIntInfo;
3933 /** VM-exit interruption error code. */
3934 uint32_t uExitIntErrCode;
3935 /** IDT-vectoring information. */
3936 uint32_t uIdtVectoringInfo;
3937 /** IDT-vectoring error code. */
3938 uint32_t uIdtVectoringErrCode;
3939} VMXVEXITEVENTINFO;
3940/** Pointer to the VMXVEXITEVENTINFO struct. */
3941typedef VMXVEXITEVENTINFO *PVMXVEXITEVENTINFO;
3942/** Pointer to a const VMXVEXITEVENTINFO struct. */
3943typedef const VMXVEXITEVENTINFO *PCVMXVEXITEVENTINFO;
3944
3945/**
3946 * Virtual VMCS.
3947 *
3948 * This is our custom format. Relevant fields from this VMCS will be merged into the
3949 * actual/shadow VMCS when we execute nested-guest code using hardware-assisted
3950 * VMX.
3951 *
3952 * The first 8 bytes must be in accordance with the Intel VT-x spec.
3953 * See Intel spec. 24.2 "Format of the VMCS Region".
3954 *
3955 * The offset and size of the VMCS state field (@a fVmcsState) is also fixed (not by
3956 * the Intel spec. but for our own requirements) as we use it to offset into guest
3957 * memory.
3958 *
3959 * Although the guest is supposed to access the VMCS only through the execution of
3960 * VMX instructions (VMREAD, VMWRITE etc.), since the VMCS may reside in guest
3961 * memory (e.g, active but not current VMCS), for saved-states compatibility, and
3962 * for teleportation purposes, any newly added fields should be added to the
3963 * appropriate reserved sections or at the end of the structure.
3964 *
3965 * We always treat natural-width fields as 64-bit in our implementation since
3966 * it's easier, allows for teleporation in the future and does not affect guest
3967 * software.
3968 *
3969 * @note Any fields that are added or modified here, make sure to update the
3970 * corresponding fields in IEM (g_aoffVmcsMap), the corresponding saved
3971 * state structure in CPUM (g_aVmxHwvirtVmcs) and bump the SSM version.
3972 * Also consider updating CPUMIsGuestVmxVmcsFieldValid and cpumR3InfoVmxVmcs.
3973 */
3974#pragma pack(1)
3975typedef struct
3976{
3977 /** @name Header.
3978 * @{
3979 */
3980 VMXVMCSREVID u32VmcsRevId; /**< 0x000 - VMX VMCS revision identifier. */
3981 VMXABORT enmVmxAbort; /**< 0x004 - VMX-abort indicator. */
3982 uint8_t fVmcsState; /**< 0x008 - VMCS launch state, see VMX_V_VMCS_LAUNCH_STATE_XXX. */
3983 uint8_t au8Padding0[3]; /**< 0x009 - Reserved for future. */
3984 uint32_t au32Reserved0[12]; /**< 0x00c - Reserved for future. */
3985 /** @} */
3986
3987 /** @name Read-only fields.
3988 * @{ */
3989 /** 16-bit fields. */
3990 uint16_t u16Reserved0[14]; /**< 0x03c - Reserved for future. */
3991
3992 /** 32-bit fields. */
3993 uint32_t u32RoVmInstrError; /**< 0x058 - VM-instruction error. */
3994 uint32_t u32RoExitReason; /**< 0x05c - VM-exit reason. */
3995 uint32_t u32RoExitIntInfo; /**< 0x060 - VM-exit interruption information. */
3996 uint32_t u32RoExitIntErrCode; /**< 0x064 - VM-exit interruption error code. */
3997 uint32_t u32RoIdtVectoringInfo; /**< 0x068 - IDT-vectoring information. */
3998 uint32_t u32RoIdtVectoringErrCode; /**< 0x06c - IDT-vectoring error code. */
3999 uint32_t u32RoExitInstrLen; /**< 0x070 - VM-exit instruction length. */
4000 uint32_t u32RoExitInstrInfo; /**< 0x074 - VM-exit instruction information. */
4001 uint32_t au32RoReserved2[16]; /**< 0x078 - Reserved for future. */
4002
4003 /** 64-bit fields. */
4004 RTUINT64U u64RoGuestPhysAddr; /**< 0x0b8 - Guest-physical address. */
4005 RTUINT64U au64Reserved1[8]; /**< 0x0c0 - Reserved for future. */
4006
4007 /** Natural-width fields. */
4008 RTUINT64U u64RoExitQual; /**< 0x100 - Exit qualification. */
4009 RTUINT64U u64RoIoRcx; /**< 0x108 - I/O RCX. */
4010 RTUINT64U u64RoIoRsi; /**< 0x110 - I/O RSI. */
4011 RTUINT64U u64RoIoRdi; /**< 0x118 - I/O RDI. */
4012 RTUINT64U u64RoIoRip; /**< 0x120 - I/O RIP. */
4013 RTUINT64U u64RoGuestLinearAddr; /**< 0x128 - Guest-linear address. */
4014 RTUINT64U au64Reserved5[16]; /**< 0x130 - Reserved for future. */
4015 /** @} */
4016
4017 /** @name Control fields.
4018 * @{ */
4019 /** 16-bit fields. */
4020 uint16_t u16Vpid; /**< 0x1b0 - Virtual processor ID. */
4021 uint16_t u16PostIntNotifyVector; /**< 0x1b2 - Posted interrupt notify vector. */
4022 uint16_t u16EptpIndex; /**< 0x1b4 - EPTP index. */
4023 uint16_t au16Reserved0[13]; /**< 0x1b6 - Reserved for future. */
4024
4025 /** 32-bit fields. */
4026 uint32_t u32PinCtls; /**< 0x1d0 - Pin-based VM-execution controls. */
4027 uint32_t u32ProcCtls; /**< 0x1d4 - Processor-based VM-execution controls. */
4028 uint32_t u32XcptBitmap; /**< 0x1d8 - Exception bitmap. */
4029 uint32_t u32XcptPFMask; /**< 0x1dc - Page-fault exception error mask. */
4030 uint32_t u32XcptPFMatch; /**< 0x1e0 - Page-fault exception error match. */
4031 uint32_t u32Cr3TargetCount; /**< 0x1e4 - CR3-target count. */
4032 uint32_t u32ExitCtls; /**< 0x1e8 - VM-exit controls. */
4033 uint32_t u32ExitMsrStoreCount; /**< 0x1ec - VM-exit MSR store count. */
4034 uint32_t u32ExitMsrLoadCount; /**< 0x1f0 - VM-exit MSR load count. */
4035 uint32_t u32EntryCtls; /**< 0x1f4 - VM-entry controls. */
4036 uint32_t u32EntryMsrLoadCount; /**< 0x1f8 - VM-entry MSR load count. */
4037 uint32_t u32EntryIntInfo; /**< 0x1fc - VM-entry interruption information. */
4038 uint32_t u32EntryXcptErrCode; /**< 0x200 - VM-entry exception error code. */
4039 uint32_t u32EntryInstrLen; /**< 0x204 - VM-entry instruction length. */
4040 uint32_t u32TprThreshold; /**< 0x208 - TPR-threshold. */
4041 uint32_t u32ProcCtls2; /**< 0x20c - Secondary-processor based VM-execution controls. */
4042 uint32_t u32PleGap; /**< 0x210 - Pause-loop exiting Gap. */
4043 uint32_t u32PleWindow; /**< 0x214 - Pause-loop exiting Window. */
4044 uint32_t au32Reserved1[16]; /**< 0x218 - Reserved for future. */
4045
4046 /** 64-bit fields. */
4047 RTUINT64U u64AddrIoBitmapA; /**< 0x258 - I/O bitmap A address. */
4048 RTUINT64U u64AddrIoBitmapB; /**< 0x260 - I/O bitmap B address. */
4049 RTUINT64U u64AddrMsrBitmap; /**< 0x268 - MSR bitmap address. */
4050 RTUINT64U u64AddrExitMsrStore; /**< 0x270 - VM-exit MSR-store area address. */
4051 RTUINT64U u64AddrExitMsrLoad; /**< 0x278 - VM-exit MSR-load area address. */
4052 RTUINT64U u64AddrEntryMsrLoad; /**< 0x280 - VM-entry MSR-load area address. */
4053 RTUINT64U u64ExecVmcsPtr; /**< 0x288 - Executive-VMCS pointer. */
4054 RTUINT64U u64AddrPml; /**< 0x290 - Page-modification log address (PML). */
4055 RTUINT64U u64TscOffset; /**< 0x298 - TSC offset. */
4056 RTUINT64U u64AddrVirtApic; /**< 0x2a0 - Virtual-APIC address. */
4057 RTUINT64U u64AddrApicAccess; /**< 0x2a8 - APIC-access address. */
4058 RTUINT64U u64AddrPostedIntDesc; /**< 0x2b0 - Posted-interrupt descriptor address. */
4059 RTUINT64U u64VmFuncCtls; /**< 0x2b8 - VM-functions control. */
4060 RTUINT64U u64EptPtr; /**< 0x2c0 - EPT pointer. */
4061 RTUINT64U u64EoiExitBitmap0; /**< 0x2c8 - EOI-exit bitmap 0. */
4062 RTUINT64U u64EoiExitBitmap1; /**< 0x2d0 - EOI-exit bitmap 1. */
4063 RTUINT64U u64EoiExitBitmap2; /**< 0x2d8 - EOI-exit bitmap 2. */
4064 RTUINT64U u64EoiExitBitmap3; /**< 0x2e0 - EOI-exit bitmap 3. */
4065 RTUINT64U u64AddrEptpList; /**< 0x2e8 - EPTP-list address. */
4066 RTUINT64U u64AddrVmreadBitmap; /**< 0x2f0 - VMREAD-bitmap address. */
4067 RTUINT64U u64AddrVmwriteBitmap; /**< 0x2f8 - VMWRITE-bitmap address. */
4068 RTUINT64U u64AddrXcptVeInfo; /**< 0x300 - Virtualization-exception information address. */
4069 RTUINT64U u64XssExitBitmap; /**< 0x308 - XSS-exiting bitmap. */
4070 RTUINT64U u64EnclsExitBitmap; /**< 0x310 - ENCLS-exiting bitmap address. */
4071 RTUINT64U u64SppTablePtr; /**< 0x318 - Sub-page-permission-table pointer (SPPTP). */
4072 RTUINT64U u64TscMultiplier; /**< 0x320 - TSC multiplier. */
4073 RTUINT64U u64ProcCtls3; /**< 0x328 - Tertiary-Processor based VM-execution controls. */
4074 RTUINT64U u64EnclvExitBitmap; /**< 0x330 - ENCLV-exiting bitmap. */
4075 RTUINT64U au64Reserved0[13]; /**< 0x338 - Reserved for future. */
4076
4077 /** Natural-width fields. */
4078 RTUINT64U u64Cr0Mask; /**< 0x3a0 - CR0 guest/host Mask. */
4079 RTUINT64U u64Cr4Mask; /**< 0x3a8 - CR4 guest/host Mask. */
4080 RTUINT64U u64Cr0ReadShadow; /**< 0x3b0 - CR0 read shadow. */
4081 RTUINT64U u64Cr4ReadShadow; /**< 0x3b8 - CR4 read shadow. */
4082 RTUINT64U u64Cr3Target0; /**< 0x3c0 - CR3-target value 0. */
4083 RTUINT64U u64Cr3Target1; /**< 0x3c8 - CR3-target value 1. */
4084 RTUINT64U u64Cr3Target2; /**< 0x3d0 - CR3-target value 2. */
4085 RTUINT64U u64Cr3Target3; /**< 0x3d8 - CR3-target value 3. */
4086 RTUINT64U au64Reserved4[32]; /**< 0x3e0 - Reserved for future. */
4087 /** @} */
4088
4089 /** @name Host-state fields.
4090 * @{ */
4091 /** 16-bit fields. */
4092 /* Order of [Es..Gs] fields below must match [X86_SREG_ES..X86_SREG_GS]. */
4093 RTSEL HostEs; /**< 0x4e0 - Host ES selector. */
4094 RTSEL HostCs; /**< 0x4e2 - Host CS selector. */
4095 RTSEL HostSs; /**< 0x4e4 - Host SS selector. */
4096 RTSEL HostDs; /**< 0x4e6 - Host DS selector. */
4097 RTSEL HostFs; /**< 0x4e8 - Host FS selector. */
4098 RTSEL HostGs; /**< 0x4ea - Host GS selector. */
4099 RTSEL HostTr; /**< 0x4ec - Host TR selector. */
4100 uint16_t au16Reserved2[13]; /**< 0x4ee - Reserved for future. */
4101
4102 /** 32-bit fields. */
4103 uint32_t u32HostSysenterCs; /**< 0x508 - Host SYSENTER CS. */
4104 uint32_t au32Reserved4[11]; /**< 0x50c - Reserved for future. */
4105
4106 /** 64-bit fields. */
4107 RTUINT64U u64HostPatMsr; /**< 0x538 - Host PAT MSR. */
4108 RTUINT64U u64HostEferMsr; /**< 0x540 - Host EFER MSR. */
4109 RTUINT64U u64HostPerfGlobalCtlMsr; /**< 0x548 - Host global performance-control MSR. */
4110 RTUINT64U u64HostPkrsMsr; /**< 0x550 - Host PKRS MSR. */
4111 RTUINT64U au64Reserved3[15]; /**< 0x558 - Reserved for future. */
4112
4113 /** Natural-width fields. */
4114 RTUINT64U u64HostCr0; /**< 0x5d0 - Host CR0. */
4115 RTUINT64U u64HostCr3; /**< 0x5d8 - Host CR3. */
4116 RTUINT64U u64HostCr4; /**< 0x5e0 - Host CR4. */
4117 RTUINT64U u64HostFsBase; /**< 0x5e8 - Host FS base. */
4118 RTUINT64U u64HostGsBase; /**< 0x5f0 - Host GS base. */
4119 RTUINT64U u64HostTrBase; /**< 0x5f8 - Host TR base. */
4120 RTUINT64U u64HostGdtrBase; /**< 0x600 - Host GDTR base. */
4121 RTUINT64U u64HostIdtrBase; /**< 0x608 - Host IDTR base. */
4122 RTUINT64U u64HostSysenterEsp; /**< 0x610 - Host SYSENTER ESP base. */
4123 RTUINT64U u64HostSysenterEip; /**< 0x618 - Host SYSENTER ESP base. */
4124 RTUINT64U u64HostRsp; /**< 0x620 - Host RSP. */
4125 RTUINT64U u64HostRip; /**< 0x628 - Host RIP. */
4126 RTUINT64U u64HostSCetMsr; /**< 0x630 - Host S_CET MSR. */
4127 RTUINT64U u64HostSsp; /**< 0x638 - Host SSP. */
4128 RTUINT64U u64HostIntrSspTableAddrMsr; /**< 0x640 - Host Interrupt SSP table address MSR. */
4129 RTUINT64U au64Reserved7[29]; /**< 0x648 - Reserved for future. */
4130 /** @} */
4131
4132 /** @name Guest-state fields.
4133 * @{ */
4134 /** 16-bit fields. */
4135 /* Order of [Es..Gs] fields below must match [X86_SREG_ES..X86_SREG_GS]. */
4136 RTSEL GuestEs; /**< 0x730 - Guest ES selector. */
4137 RTSEL GuestCs; /**< 0x732 - Guest ES selector. */
4138 RTSEL GuestSs; /**< 0x734 - Guest ES selector. */
4139 RTSEL GuestDs; /**< 0x736 - Guest ES selector. */
4140 RTSEL GuestFs; /**< 0x738 - Guest ES selector. */
4141 RTSEL GuestGs; /**< 0x73a - Guest ES selector. */
4142 RTSEL GuestLdtr; /**< 0x73c - Guest LDTR selector. */
4143 RTSEL GuestTr; /**< 0x73e - Guest TR selector. */
4144 uint16_t u16GuestIntStatus; /**< 0x740 - Guest interrupt status (virtual-interrupt delivery). */
4145 uint16_t u16PmlIndex; /**< 0x742 - PML index. */
4146 uint16_t au16Reserved1[14]; /**< 0x744 - Reserved for future. */
4147
4148 /** 32-bit fields. */
4149 /* Order of [Es..Gs] fields below must match [X86_SREG_ES..X86_SREG_GS]. */
4150 uint32_t u32GuestEsLimit; /**< 0x760 - Guest ES limit. */
4151 uint32_t u32GuestCsLimit; /**< 0x764 - Guest CS limit. */
4152 uint32_t u32GuestSsLimit; /**< 0x768 - Guest SS limit. */
4153 uint32_t u32GuestDsLimit; /**< 0x76c - Guest DS limit. */
4154 uint32_t u32GuestFsLimit; /**< 0x770 - Guest FS limit. */
4155 uint32_t u32GuestGsLimit; /**< 0x774 - Guest GS limit. */
4156 uint32_t u32GuestLdtrLimit; /**< 0x778 - Guest LDTR limit. */
4157 uint32_t u32GuestTrLimit; /**< 0x77c - Guest TR limit. */
4158 uint32_t u32GuestGdtrLimit; /**< 0x780 - Guest GDTR limit. */
4159 uint32_t u32GuestIdtrLimit; /**< 0x784 - Guest IDTR limit. */
4160 uint32_t u32GuestEsAttr; /**< 0x788 - Guest ES attributes. */
4161 uint32_t u32GuestCsAttr; /**< 0x78c - Guest CS attributes. */
4162 uint32_t u32GuestSsAttr; /**< 0x790 - Guest SS attributes. */
4163 uint32_t u32GuestDsAttr; /**< 0x794 - Guest DS attributes. */
4164 uint32_t u32GuestFsAttr; /**< 0x798 - Guest FS attributes. */
4165 uint32_t u32GuestGsAttr; /**< 0x79c - Guest GS attributes. */
4166 uint32_t u32GuestLdtrAttr; /**< 0x7a0 - Guest LDTR attributes. */
4167 uint32_t u32GuestTrAttr; /**< 0x7a4 - Guest TR attributes. */
4168 uint32_t u32GuestIntrState; /**< 0x7a8 - Guest interruptibility state. */
4169 uint32_t u32GuestActivityState; /**< 0x7ac - Guest activity state. */
4170 uint32_t u32GuestSmBase; /**< 0x7b0 - Guest SMBASE. */
4171 uint32_t u32GuestSysenterCS; /**< 0x7b4 - Guest SYSENTER CS. */
4172 uint32_t u32PreemptTimer; /**< 0x7b8 - Preemption timer value. */
4173 uint32_t au32Reserved3[11]; /**< 0x7bc - Reserved for future. */
4174
4175 /** 64-bit fields. */
4176 RTUINT64U u64VmcsLinkPtr; /**< 0x7e8 - VMCS link pointer. */
4177 RTUINT64U u64GuestDebugCtlMsr; /**< 0x7f0 - Guest debug-control MSR. */
4178 RTUINT64U u64GuestPatMsr; /**< 0x7f8 - Guest PAT MSR. */
4179 RTUINT64U u64GuestEferMsr; /**< 0x800 - Guest EFER MSR. */
4180 RTUINT64U u64GuestPerfGlobalCtlMsr; /**< 0x808 - Guest global performance-control MSR. */
4181 RTUINT64U u64GuestPdpte0; /**< 0x810 - Guest PDPTE 0. */
4182 RTUINT64U u64GuestPdpte1; /**< 0x818 - Guest PDPTE 0. */
4183 RTUINT64U u64GuestPdpte2; /**< 0x820 - Guest PDPTE 1. */
4184 RTUINT64U u64GuestPdpte3; /**< 0x828 - Guest PDPTE 2. */
4185 RTUINT64U u64GuestBndcfgsMsr; /**< 0x830 - Guest Bounds config MPX MSR (Intel Memory Protection Extensions). */
4186 RTUINT64U u64GuestRtitCtlMsr; /**< 0x838 - Guest RTIT control MSR (Intel Real Time Instruction Trace). */
4187 RTUINT64U u64GuestPkrsMsr; /**< 0x840 - Guest PKRS MSR. */
4188 RTUINT64U au64Reserved2[31]; /**< 0x848 - Reserved for future. */
4189
4190 /** Natural-width fields. */
4191 RTUINT64U u64GuestCr0; /**< 0x940 - Guest CR0. */
4192 RTUINT64U u64GuestCr3; /**< 0x948 - Guest CR3. */
4193 RTUINT64U u64GuestCr4; /**< 0x950 - Guest CR4. */
4194 RTUINT64U u64GuestEsBase; /**< 0x958 - Guest ES base. */
4195 RTUINT64U u64GuestCsBase; /**< 0x960 - Guest CS base. */
4196 RTUINT64U u64GuestSsBase; /**< 0x968 - Guest SS base. */
4197 RTUINT64U u64GuestDsBase; /**< 0x970 - Guest DS base. */
4198 RTUINT64U u64GuestFsBase; /**< 0x978 - Guest FS base. */
4199 RTUINT64U u64GuestGsBase; /**< 0x980 - Guest GS base. */
4200 RTUINT64U u64GuestLdtrBase; /**< 0x988 - Guest LDTR base. */
4201 RTUINT64U u64GuestTrBase; /**< 0x990 - Guest TR base. */
4202 RTUINT64U u64GuestGdtrBase; /**< 0x998 - Guest GDTR base. */
4203 RTUINT64U u64GuestIdtrBase; /**< 0x9a0 - Guest IDTR base. */
4204 RTUINT64U u64GuestDr7; /**< 0x9a8 - Guest DR7. */
4205 RTUINT64U u64GuestRsp; /**< 0x9b0 - Guest RSP. */
4206 RTUINT64U u64GuestRip; /**< 0x9b8 - Guest RIP. */
4207 RTUINT64U u64GuestRFlags; /**< 0x9c0 - Guest RFLAGS. */
4208 RTUINT64U u64GuestPendingDbgXcpts; /**< 0x9c8 - Guest pending debug exceptions. */
4209 RTUINT64U u64GuestSysenterEsp; /**< 0x9d0 - Guest SYSENTER ESP. */
4210 RTUINT64U u64GuestSysenterEip; /**< 0x9d8 - Guest SYSENTER EIP. */
4211 RTUINT64U u64GuestSCetMsr; /**< 0x9e0 - Guest S_CET MSR. */
4212 RTUINT64U u64GuestSsp; /**< 0x9e8 - Guest SSP. */
4213 RTUINT64U u64GuestIntrSspTableAddrMsr; /**< 0x9f0 - Guest Interrupt SSP table address MSR. */
4214 RTUINT64U au64Reserved6[29]; /**< 0x9f8 - Reserved for future. */
4215 /** @} */
4216
4217 /** 0xae0 - Padding / reserved for future use. */
4218 uint8_t abPadding[X86_PAGE_4K_SIZE - 0xae0];
4219} VMXVVMCS;
4220#pragma pack()
4221/** Pointer to the VMXVVMCS struct. */
4222typedef VMXVVMCS *PVMXVVMCS;
4223/** Pointer to a const VMXVVMCS struct. */
4224typedef const VMXVVMCS *PCVMXVVMCS;
4225AssertCompileSize(VMXVVMCS, X86_PAGE_4K_SIZE);
4226AssertCompileMemberSize(VMXVVMCS, fVmcsState, sizeof(uint8_t));
4227AssertCompileMemberOffset(VMXVVMCS, enmVmxAbort, 0x004);
4228AssertCompileMemberOffset(VMXVVMCS, fVmcsState, 0x008);
4229AssertCompileMemberOffset(VMXVVMCS, u32RoVmInstrError, 0x058);
4230AssertCompileMemberOffset(VMXVVMCS, u64RoGuestPhysAddr, 0x0b8);
4231AssertCompileMemberOffset(VMXVVMCS, u64RoExitQual, 0x100);
4232AssertCompileMemberOffset(VMXVVMCS, u16Vpid, 0x1b0);
4233AssertCompileMemberOffset(VMXVVMCS, u32PinCtls, 0x1d0);
4234AssertCompileMemberOffset(VMXVVMCS, u64AddrIoBitmapA, 0x258);
4235AssertCompileMemberOffset(VMXVVMCS, u64Cr0Mask, 0x3a0);
4236AssertCompileMemberOffset(VMXVVMCS, HostEs, 0x4e0);
4237AssertCompileMemberOffset(VMXVVMCS, u32HostSysenterCs, 0x508);
4238AssertCompileMemberOffset(VMXVVMCS, u64HostPatMsr, 0x538);
4239AssertCompileMemberOffset(VMXVVMCS, u64HostCr0, 0x5d0);
4240AssertCompileMemberOffset(VMXVVMCS, GuestEs, 0x730);
4241AssertCompileMemberOffset(VMXVVMCS, u32GuestEsLimit, 0x760);
4242AssertCompileMemberOffset(VMXVVMCS, u64VmcsLinkPtr, 0x7e8);
4243AssertCompileMemberOffset(VMXVVMCS, u64GuestCr0, 0x940);
4244
4245/**
4246 * Virtual VMX-instruction and VM-exit diagnostics.
4247 *
4248 * These are not the same as VM instruction errors that are enumerated in the Intel
4249 * spec. These are purely internal, fine-grained definitions used for diagnostic
4250 * purposes and are not reported to guest software under the VM-instruction error
4251 * field in its VMCS.
4252 *
4253 * @note Members of this enum are used as array indices, so no gaps are allowed.
4254 * Please update g_apszVmxVDiagDesc when you add new fields to this enum.
4255 */
4256typedef enum
4257{
4258 /* Internal processing errors. */
4259 kVmxVDiag_None = 0,
4260 kVmxVDiag_Ipe_1,
4261 kVmxVDiag_Ipe_2,
4262 kVmxVDiag_Ipe_3,
4263 kVmxVDiag_Ipe_4,
4264 kVmxVDiag_Ipe_5,
4265 kVmxVDiag_Ipe_6,
4266 kVmxVDiag_Ipe_7,
4267 kVmxVDiag_Ipe_8,
4268 kVmxVDiag_Ipe_9,
4269 kVmxVDiag_Ipe_10,
4270 kVmxVDiag_Ipe_11,
4271 kVmxVDiag_Ipe_12,
4272 kVmxVDiag_Ipe_13,
4273 kVmxVDiag_Ipe_14,
4274 kVmxVDiag_Ipe_15,
4275 kVmxVDiag_Ipe_16,
4276 /* VMXON. */
4277 kVmxVDiag_Vmxon_A20M,
4278 kVmxVDiag_Vmxon_Cpl,
4279 kVmxVDiag_Vmxon_Cr0Fixed0,
4280 kVmxVDiag_Vmxon_Cr0Fixed1,
4281 kVmxVDiag_Vmxon_Cr4Fixed0,
4282 kVmxVDiag_Vmxon_Cr4Fixed1,
4283 kVmxVDiag_Vmxon_Intercept,
4284 kVmxVDiag_Vmxon_LongModeCS,
4285 kVmxVDiag_Vmxon_MsrFeatCtl,
4286 kVmxVDiag_Vmxon_PtrAbnormal,
4287 kVmxVDiag_Vmxon_PtrAlign,
4288 kVmxVDiag_Vmxon_PtrMap,
4289 kVmxVDiag_Vmxon_PtrReadPhys,
4290 kVmxVDiag_Vmxon_PtrWidth,
4291 kVmxVDiag_Vmxon_RealOrV86Mode,
4292 kVmxVDiag_Vmxon_ShadowVmcs,
4293 kVmxVDiag_Vmxon_VmxAlreadyRoot,
4294 kVmxVDiag_Vmxon_Vmxe,
4295 kVmxVDiag_Vmxon_VmcsRevId,
4296 kVmxVDiag_Vmxon_VmxRootCpl,
4297 /* VMXOFF. */
4298 kVmxVDiag_Vmxoff_Cpl,
4299 kVmxVDiag_Vmxoff_Intercept,
4300 kVmxVDiag_Vmxoff_LongModeCS,
4301 kVmxVDiag_Vmxoff_RealOrV86Mode,
4302 kVmxVDiag_Vmxoff_Vmxe,
4303 kVmxVDiag_Vmxoff_VmxRoot,
4304 /* VMPTRLD. */
4305 kVmxVDiag_Vmptrld_Cpl,
4306 kVmxVDiag_Vmptrld_LongModeCS,
4307 kVmxVDiag_Vmptrld_PtrAbnormal,
4308 kVmxVDiag_Vmptrld_PtrAlign,
4309 kVmxVDiag_Vmptrld_PtrMap,
4310 kVmxVDiag_Vmptrld_PtrReadPhys,
4311 kVmxVDiag_Vmptrld_PtrVmxon,
4312 kVmxVDiag_Vmptrld_PtrWidth,
4313 kVmxVDiag_Vmptrld_RealOrV86Mode,
4314 kVmxVDiag_Vmptrld_RevPtrReadPhys,
4315 kVmxVDiag_Vmptrld_ShadowVmcs,
4316 kVmxVDiag_Vmptrld_VmcsRevId,
4317 kVmxVDiag_Vmptrld_VmxRoot,
4318 /* VMPTRST. */
4319 kVmxVDiag_Vmptrst_Cpl,
4320 kVmxVDiag_Vmptrst_LongModeCS,
4321 kVmxVDiag_Vmptrst_PtrMap,
4322 kVmxVDiag_Vmptrst_RealOrV86Mode,
4323 kVmxVDiag_Vmptrst_VmxRoot,
4324 /* VMCLEAR. */
4325 kVmxVDiag_Vmclear_Cpl,
4326 kVmxVDiag_Vmclear_LongModeCS,
4327 kVmxVDiag_Vmclear_PtrAbnormal,
4328 kVmxVDiag_Vmclear_PtrAlign,
4329 kVmxVDiag_Vmclear_PtrMap,
4330 kVmxVDiag_Vmclear_PtrReadPhys,
4331 kVmxVDiag_Vmclear_PtrVmxon,
4332 kVmxVDiag_Vmclear_PtrWidth,
4333 kVmxVDiag_Vmclear_RealOrV86Mode,
4334 kVmxVDiag_Vmclear_VmxRoot,
4335 /* VMWRITE. */
4336 kVmxVDiag_Vmwrite_Cpl,
4337 kVmxVDiag_Vmwrite_FieldInvalid,
4338 kVmxVDiag_Vmwrite_FieldRo,
4339 kVmxVDiag_Vmwrite_LinkPtrInvalid,
4340 kVmxVDiag_Vmwrite_LongModeCS,
4341 kVmxVDiag_Vmwrite_PtrInvalid,
4342 kVmxVDiag_Vmwrite_PtrMap,
4343 kVmxVDiag_Vmwrite_RealOrV86Mode,
4344 kVmxVDiag_Vmwrite_VmxRoot,
4345 /* VMREAD. */
4346 kVmxVDiag_Vmread_Cpl,
4347 kVmxVDiag_Vmread_FieldInvalid,
4348 kVmxVDiag_Vmread_LinkPtrInvalid,
4349 kVmxVDiag_Vmread_LongModeCS,
4350 kVmxVDiag_Vmread_PtrInvalid,
4351 kVmxVDiag_Vmread_PtrMap,
4352 kVmxVDiag_Vmread_RealOrV86Mode,
4353 kVmxVDiag_Vmread_VmxRoot,
4354 /* INVVPID. */
4355 kVmxVDiag_Invvpid_Cpl,
4356 kVmxVDiag_Invvpid_DescRsvd,
4357 kVmxVDiag_Invvpid_LongModeCS,
4358 kVmxVDiag_Invvpid_RealOrV86Mode,
4359 kVmxVDiag_Invvpid_TypeInvalid,
4360 kVmxVDiag_Invvpid_Type0InvalidAddr,
4361 kVmxVDiag_Invvpid_Type0InvalidVpid,
4362 kVmxVDiag_Invvpid_Type1InvalidVpid,
4363 kVmxVDiag_Invvpid_Type3InvalidVpid,
4364 kVmxVDiag_Invvpid_VmxRoot,
4365 /* INVEPT. */
4366 kVmxVDiag_Invept_Cpl,
4367 kVmxVDiag_Invept_DescRsvd,
4368 kVmxVDiag_Invept_EptpInvalid,
4369 kVmxVDiag_Invept_LongModeCS,
4370 kVmxVDiag_Invept_RealOrV86Mode,
4371 kVmxVDiag_Invept_TypeInvalid,
4372 kVmxVDiag_Invept_VmxRoot,
4373 /* VMLAUNCH/VMRESUME. */
4374 kVmxVDiag_Vmentry_AddrApicAccess,
4375 kVmxVDiag_Vmentry_AddrApicAccessEqVirtApic,
4376 kVmxVDiag_Vmentry_AddrApicAccessHandlerReg,
4377 kVmxVDiag_Vmentry_AddrEntryMsrLoad,
4378 kVmxVDiag_Vmentry_AddrExitMsrLoad,
4379 kVmxVDiag_Vmentry_AddrExitMsrStore,
4380 kVmxVDiag_Vmentry_AddrIoBitmapA,
4381 kVmxVDiag_Vmentry_AddrIoBitmapB,
4382 kVmxVDiag_Vmentry_AddrMsrBitmap,
4383 kVmxVDiag_Vmentry_AddrVirtApicPage,
4384 kVmxVDiag_Vmentry_AddrVmcsLinkPtr,
4385 kVmxVDiag_Vmentry_AddrVmreadBitmap,
4386 kVmxVDiag_Vmentry_AddrVmwriteBitmap,
4387 kVmxVDiag_Vmentry_ApicRegVirt,
4388 kVmxVDiag_Vmentry_BlocKMovSS,
4389 kVmxVDiag_Vmentry_Cpl,
4390 kVmxVDiag_Vmentry_Cr3TargetCount,
4391 kVmxVDiag_Vmentry_EntryCtlsAllowed1,
4392 kVmxVDiag_Vmentry_EntryCtlsDisallowed0,
4393 kVmxVDiag_Vmentry_EntryInstrLen,
4394 kVmxVDiag_Vmentry_EntryInstrLenZero,
4395 kVmxVDiag_Vmentry_EntryIntInfoErrCodePe,
4396 kVmxVDiag_Vmentry_EntryIntInfoErrCodeVec,
4397 kVmxVDiag_Vmentry_EntryIntInfoTypeVecRsvd,
4398 kVmxVDiag_Vmentry_EntryXcptErrCodeRsvd,
4399 kVmxVDiag_Vmentry_EptpAccessDirty,
4400 kVmxVDiag_Vmentry_EptpPageWalkLength,
4401 kVmxVDiag_Vmentry_EptpMemType,
4402 kVmxVDiag_Vmentry_EptpRsvd,
4403 kVmxVDiag_Vmentry_ExitCtlsAllowed1,
4404 kVmxVDiag_Vmentry_ExitCtlsDisallowed0,
4405 kVmxVDiag_Vmentry_GuestActStateHlt,
4406 kVmxVDiag_Vmentry_GuestActStateRsvd,
4407 kVmxVDiag_Vmentry_GuestActStateShutdown,
4408 kVmxVDiag_Vmentry_GuestActStateSsDpl,
4409 kVmxVDiag_Vmentry_GuestActStateStiMovSs,
4410 kVmxVDiag_Vmentry_GuestCr0Fixed0,
4411 kVmxVDiag_Vmentry_GuestCr0Fixed1,
4412 kVmxVDiag_Vmentry_GuestCr0PgPe,
4413 kVmxVDiag_Vmentry_GuestCr3,
4414 kVmxVDiag_Vmentry_GuestCr4Fixed0,
4415 kVmxVDiag_Vmentry_GuestCr4Fixed1,
4416 kVmxVDiag_Vmentry_GuestDebugCtl,
4417 kVmxVDiag_Vmentry_GuestDr7,
4418 kVmxVDiag_Vmentry_GuestEferMsr,
4419 kVmxVDiag_Vmentry_GuestEferMsrRsvd,
4420 kVmxVDiag_Vmentry_GuestGdtrBase,
4421 kVmxVDiag_Vmentry_GuestGdtrLimit,
4422 kVmxVDiag_Vmentry_GuestIdtrBase,
4423 kVmxVDiag_Vmentry_GuestIdtrLimit,
4424 kVmxVDiag_Vmentry_GuestIntStateEnclave,
4425 kVmxVDiag_Vmentry_GuestIntStateExtInt,
4426 kVmxVDiag_Vmentry_GuestIntStateNmi,
4427 kVmxVDiag_Vmentry_GuestIntStateRFlagsSti,
4428 kVmxVDiag_Vmentry_GuestIntStateRsvd,
4429 kVmxVDiag_Vmentry_GuestIntStateSmi,
4430 kVmxVDiag_Vmentry_GuestIntStateStiMovSs,
4431 kVmxVDiag_Vmentry_GuestIntStateVirtNmi,
4432 kVmxVDiag_Vmentry_GuestPae,
4433 kVmxVDiag_Vmentry_GuestPatMsr,
4434 kVmxVDiag_Vmentry_GuestPcide,
4435 kVmxVDiag_Vmentry_GuestPdpte,
4436 kVmxVDiag_Vmentry_GuestPndDbgXcptBsNoTf,
4437 kVmxVDiag_Vmentry_GuestPndDbgXcptBsTf,
4438 kVmxVDiag_Vmentry_GuestPndDbgXcptRsvd,
4439 kVmxVDiag_Vmentry_GuestPndDbgXcptRtm,
4440 kVmxVDiag_Vmentry_GuestRip,
4441 kVmxVDiag_Vmentry_GuestRipRsvd,
4442 kVmxVDiag_Vmentry_GuestRFlagsIf,
4443 kVmxVDiag_Vmentry_GuestRFlagsRsvd,
4444 kVmxVDiag_Vmentry_GuestRFlagsVm,
4445 kVmxVDiag_Vmentry_GuestSegAttrCsDefBig,
4446 kVmxVDiag_Vmentry_GuestSegAttrCsDplEqSs,
4447 kVmxVDiag_Vmentry_GuestSegAttrCsDplLtSs,
4448 kVmxVDiag_Vmentry_GuestSegAttrCsDplZero,
4449 kVmxVDiag_Vmentry_GuestSegAttrCsType,
4450 kVmxVDiag_Vmentry_GuestSegAttrCsTypeRead,
4451 kVmxVDiag_Vmentry_GuestSegAttrDescTypeCs,
4452 kVmxVDiag_Vmentry_GuestSegAttrDescTypeDs,
4453 kVmxVDiag_Vmentry_GuestSegAttrDescTypeEs,
4454 kVmxVDiag_Vmentry_GuestSegAttrDescTypeFs,
4455 kVmxVDiag_Vmentry_GuestSegAttrDescTypeGs,
4456 kVmxVDiag_Vmentry_GuestSegAttrDescTypeSs,
4457 kVmxVDiag_Vmentry_GuestSegAttrDplRplCs,
4458 kVmxVDiag_Vmentry_GuestSegAttrDplRplDs,
4459 kVmxVDiag_Vmentry_GuestSegAttrDplRplEs,
4460 kVmxVDiag_Vmentry_GuestSegAttrDplRplFs,
4461 kVmxVDiag_Vmentry_GuestSegAttrDplRplGs,
4462 kVmxVDiag_Vmentry_GuestSegAttrDplRplSs,
4463 kVmxVDiag_Vmentry_GuestSegAttrGranCs,
4464 kVmxVDiag_Vmentry_GuestSegAttrGranDs,
4465 kVmxVDiag_Vmentry_GuestSegAttrGranEs,
4466 kVmxVDiag_Vmentry_GuestSegAttrGranFs,
4467 kVmxVDiag_Vmentry_GuestSegAttrGranGs,
4468 kVmxVDiag_Vmentry_GuestSegAttrGranSs,
4469 kVmxVDiag_Vmentry_GuestSegAttrLdtrDescType,
4470 kVmxVDiag_Vmentry_GuestSegAttrLdtrGran,
4471 kVmxVDiag_Vmentry_GuestSegAttrLdtrPresent,
4472 kVmxVDiag_Vmentry_GuestSegAttrLdtrRsvd,
4473 kVmxVDiag_Vmentry_GuestSegAttrLdtrType,
4474 kVmxVDiag_Vmentry_GuestSegAttrPresentCs,
4475 kVmxVDiag_Vmentry_GuestSegAttrPresentDs,
4476 kVmxVDiag_Vmentry_GuestSegAttrPresentEs,
4477 kVmxVDiag_Vmentry_GuestSegAttrPresentFs,
4478 kVmxVDiag_Vmentry_GuestSegAttrPresentGs,
4479 kVmxVDiag_Vmentry_GuestSegAttrPresentSs,
4480 kVmxVDiag_Vmentry_GuestSegAttrRsvdCs,
4481 kVmxVDiag_Vmentry_GuestSegAttrRsvdDs,
4482 kVmxVDiag_Vmentry_GuestSegAttrRsvdEs,
4483 kVmxVDiag_Vmentry_GuestSegAttrRsvdFs,
4484 kVmxVDiag_Vmentry_GuestSegAttrRsvdGs,
4485 kVmxVDiag_Vmentry_GuestSegAttrRsvdSs,
4486 kVmxVDiag_Vmentry_GuestSegAttrSsDplEqRpl,
4487 kVmxVDiag_Vmentry_GuestSegAttrSsDplZero,
4488 kVmxVDiag_Vmentry_GuestSegAttrSsType,
4489 kVmxVDiag_Vmentry_GuestSegAttrTrDescType,
4490 kVmxVDiag_Vmentry_GuestSegAttrTrGran,
4491 kVmxVDiag_Vmentry_GuestSegAttrTrPresent,
4492 kVmxVDiag_Vmentry_GuestSegAttrTrRsvd,
4493 kVmxVDiag_Vmentry_GuestSegAttrTrType,
4494 kVmxVDiag_Vmentry_GuestSegAttrTrUnusable,
4495 kVmxVDiag_Vmentry_GuestSegAttrTypeAccCs,
4496 kVmxVDiag_Vmentry_GuestSegAttrTypeAccDs,
4497 kVmxVDiag_Vmentry_GuestSegAttrTypeAccEs,
4498 kVmxVDiag_Vmentry_GuestSegAttrTypeAccFs,
4499 kVmxVDiag_Vmentry_GuestSegAttrTypeAccGs,
4500 kVmxVDiag_Vmentry_GuestSegAttrTypeAccSs,
4501 kVmxVDiag_Vmentry_GuestSegAttrV86Cs,
4502 kVmxVDiag_Vmentry_GuestSegAttrV86Ds,
4503 kVmxVDiag_Vmentry_GuestSegAttrV86Es,
4504 kVmxVDiag_Vmentry_GuestSegAttrV86Fs,
4505 kVmxVDiag_Vmentry_GuestSegAttrV86Gs,
4506 kVmxVDiag_Vmentry_GuestSegAttrV86Ss,
4507 kVmxVDiag_Vmentry_GuestSegBaseCs,
4508 kVmxVDiag_Vmentry_GuestSegBaseDs,
4509 kVmxVDiag_Vmentry_GuestSegBaseEs,
4510 kVmxVDiag_Vmentry_GuestSegBaseFs,
4511 kVmxVDiag_Vmentry_GuestSegBaseGs,
4512 kVmxVDiag_Vmentry_GuestSegBaseLdtr,
4513 kVmxVDiag_Vmentry_GuestSegBaseSs,
4514 kVmxVDiag_Vmentry_GuestSegBaseTr,
4515 kVmxVDiag_Vmentry_GuestSegBaseV86Cs,
4516 kVmxVDiag_Vmentry_GuestSegBaseV86Ds,
4517 kVmxVDiag_Vmentry_GuestSegBaseV86Es,
4518 kVmxVDiag_Vmentry_GuestSegBaseV86Fs,
4519 kVmxVDiag_Vmentry_GuestSegBaseV86Gs,
4520 kVmxVDiag_Vmentry_GuestSegBaseV86Ss,
4521 kVmxVDiag_Vmentry_GuestSegLimitV86Cs,
4522 kVmxVDiag_Vmentry_GuestSegLimitV86Ds,
4523 kVmxVDiag_Vmentry_GuestSegLimitV86Es,
4524 kVmxVDiag_Vmentry_GuestSegLimitV86Fs,
4525 kVmxVDiag_Vmentry_GuestSegLimitV86Gs,
4526 kVmxVDiag_Vmentry_GuestSegLimitV86Ss,
4527 kVmxVDiag_Vmentry_GuestSegSelCsSsRpl,
4528 kVmxVDiag_Vmentry_GuestSegSelLdtr,
4529 kVmxVDiag_Vmentry_GuestSegSelTr,
4530 kVmxVDiag_Vmentry_GuestSysenterEspEip,
4531 kVmxVDiag_Vmentry_VmcsLinkPtrCurVmcs,
4532 kVmxVDiag_Vmentry_VmcsLinkPtrReadPhys,
4533 kVmxVDiag_Vmentry_VmcsLinkPtrRevId,
4534 kVmxVDiag_Vmentry_VmcsLinkPtrShadow,
4535 kVmxVDiag_Vmentry_HostCr0Fixed0,
4536 kVmxVDiag_Vmentry_HostCr0Fixed1,
4537 kVmxVDiag_Vmentry_HostCr3,
4538 kVmxVDiag_Vmentry_HostCr4Fixed0,
4539 kVmxVDiag_Vmentry_HostCr4Fixed1,
4540 kVmxVDiag_Vmentry_HostCr4Pae,
4541 kVmxVDiag_Vmentry_HostCr4Pcide,
4542 kVmxVDiag_Vmentry_HostCsTr,
4543 kVmxVDiag_Vmentry_HostEferMsr,
4544 kVmxVDiag_Vmentry_HostEferMsrRsvd,
4545 kVmxVDiag_Vmentry_HostGuestLongMode,
4546 kVmxVDiag_Vmentry_HostGuestLongModeNoCpu,
4547 kVmxVDiag_Vmentry_HostLongMode,
4548 kVmxVDiag_Vmentry_HostPatMsr,
4549 kVmxVDiag_Vmentry_HostRip,
4550 kVmxVDiag_Vmentry_HostRipRsvd,
4551 kVmxVDiag_Vmentry_HostSel,
4552 kVmxVDiag_Vmentry_HostSegBase,
4553 kVmxVDiag_Vmentry_HostSs,
4554 kVmxVDiag_Vmentry_HostSysenterEspEip,
4555 kVmxVDiag_Vmentry_IoBitmapAPtrReadPhys,
4556 kVmxVDiag_Vmentry_IoBitmapBPtrReadPhys,
4557 kVmxVDiag_Vmentry_LongModeCS,
4558 kVmxVDiag_Vmentry_MsrBitmapPtrReadPhys,
4559 kVmxVDiag_Vmentry_MsrLoad,
4560 kVmxVDiag_Vmentry_MsrLoadCount,
4561 kVmxVDiag_Vmentry_MsrLoadPtrReadPhys,
4562 kVmxVDiag_Vmentry_MsrLoadRing3,
4563 kVmxVDiag_Vmentry_MsrLoadRsvd,
4564 kVmxVDiag_Vmentry_NmiWindowExit,
4565 kVmxVDiag_Vmentry_PinCtlsAllowed1,
4566 kVmxVDiag_Vmentry_PinCtlsDisallowed0,
4567 kVmxVDiag_Vmentry_ProcCtlsAllowed1,
4568 kVmxVDiag_Vmentry_ProcCtlsDisallowed0,
4569 kVmxVDiag_Vmentry_ProcCtls2Allowed1,
4570 kVmxVDiag_Vmentry_ProcCtls2Disallowed0,
4571 kVmxVDiag_Vmentry_PtrInvalid,
4572 kVmxVDiag_Vmentry_PtrShadowVmcs,
4573 kVmxVDiag_Vmentry_RealOrV86Mode,
4574 kVmxVDiag_Vmentry_SavePreemptTimer,
4575 kVmxVDiag_Vmentry_TprThresholdRsvd,
4576 kVmxVDiag_Vmentry_TprThresholdVTpr,
4577 kVmxVDiag_Vmentry_VirtApicPagePtrReadPhys,
4578 kVmxVDiag_Vmentry_VirtIntDelivery,
4579 kVmxVDiag_Vmentry_VirtNmi,
4580 kVmxVDiag_Vmentry_VirtX2ApicTprShadow,
4581 kVmxVDiag_Vmentry_VirtX2ApicVirtApic,
4582 kVmxVDiag_Vmentry_VmcsClear,
4583 kVmxVDiag_Vmentry_VmcsLaunch,
4584 kVmxVDiag_Vmentry_VmreadBitmapPtrReadPhys,
4585 kVmxVDiag_Vmentry_VmwriteBitmapPtrReadPhys,
4586 kVmxVDiag_Vmentry_VmxRoot,
4587 kVmxVDiag_Vmentry_Vpid,
4588 kVmxVDiag_Vmexit_HostPdpte,
4589 kVmxVDiag_Vmexit_MsrLoad,
4590 kVmxVDiag_Vmexit_MsrLoadCount,
4591 kVmxVDiag_Vmexit_MsrLoadPtrReadPhys,
4592 kVmxVDiag_Vmexit_MsrLoadRing3,
4593 kVmxVDiag_Vmexit_MsrLoadRsvd,
4594 kVmxVDiag_Vmexit_MsrStore,
4595 kVmxVDiag_Vmexit_MsrStoreCount,
4596 kVmxVDiag_Vmexit_MsrStorePtrReadPhys,
4597 kVmxVDiag_Vmexit_MsrStorePtrWritePhys,
4598 kVmxVDiag_Vmexit_MsrStoreRing3,
4599 kVmxVDiag_Vmexit_MsrStoreRsvd,
4600 kVmxVDiag_Vmexit_VirtApicPagePtrWritePhys,
4601 /* Last member for determining array index limit. */
4602 kVmxVDiag_End
4603} VMXVDIAG;
4604AssertCompileSize(VMXVDIAG, 4);
4605
4606/** @} */
4607
4608/** @} */
4609
4610#endif /* !VBOX_INCLUDED_vmm_hm_vmx_h */
4611
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