VirtualBox

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

Last change on this file since 74073 was 74073, checked in by vboxsync, 6 years ago

VMM/IEM, HM: Nested VMX: bugref:9180 vmlaunch/vmresume bits.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 177.6 KB
Line 
1/** @file
2 * HM - VMX Structures and Definitions. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2017 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vmm_vmx_h
27#define ___VBox_vmm_vmx_h
28
29#include <VBox/types.h>
30#include <VBox/err.h>
31#include <iprt/x86.h>
32#include <iprt/assert.h>
33
34/* In Visual C++ versions prior to 2012, the vmx intrinsics are only available
35 when targeting AMD64. */
36#if RT_INLINE_ASM_USES_INTRIN >= 16 && defined(RT_ARCH_AMD64)
37# pragma warning(push)
38# pragma warning(disable:4668) /* Several incorrect __cplusplus uses. */
39# pragma warning(disable:4255) /* Incorrect __slwpcb prototype. */
40# include <intrin.h>
41# pragma warning(pop)
42/* We always want them as intrinsics, no functions. */
43# pragma intrinsic(__vmx_on)
44# pragma intrinsic(__vmx_off)
45# pragma intrinsic(__vmx_vmclear)
46# pragma intrinsic(__vmx_vmptrld)
47# pragma intrinsic(__vmx_vmread)
48# pragma intrinsic(__vmx_vmwrite)
49# define VMX_USE_MSC_INTRINSICS 1
50#else
51# define VMX_USE_MSC_INTRINSICS 0
52#endif
53
54
55/** @defgroup grp_hm_vmx VMX Types and Definitions
56 * @ingroup grp_hm
57 * @{
58 */
59
60/** @name Host-state restoration flags.
61 * @note If you change these values don't forget to update the assembly
62 * defines as well!
63 * @{
64 */
65#define VMX_RESTORE_HOST_SEL_DS RT_BIT(0)
66#define VMX_RESTORE_HOST_SEL_ES RT_BIT(1)
67#define VMX_RESTORE_HOST_SEL_FS RT_BIT(2)
68#define VMX_RESTORE_HOST_SEL_GS RT_BIT(3)
69#define VMX_RESTORE_HOST_SEL_TR RT_BIT(4)
70#define VMX_RESTORE_HOST_GDTR RT_BIT(5)
71#define VMX_RESTORE_HOST_IDTR RT_BIT(6)
72#define VMX_RESTORE_HOST_GDT_READ_ONLY RT_BIT(7)
73#define VMX_RESTORE_HOST_REQUIRED RT_BIT(8)
74#define VMX_RESTORE_HOST_GDT_NEED_WRITABLE RT_BIT(9)
75/** @} */
76
77/**
78 * Host-state restoration structure.
79 * This holds host-state fields that require manual restoration.
80 * Assembly version found in hm_vmx.mac (should be automatically verified).
81 */
82typedef struct VMXRESTOREHOST
83{
84 RTSEL uHostSelDS; /* 0x00 */
85 RTSEL uHostSelES; /* 0x02 */
86 RTSEL uHostSelFS; /* 0x04 */
87 RTSEL uHostSelGS; /* 0x06 */
88 RTSEL uHostSelTR; /* 0x08 */
89 uint8_t abPadding0[4];
90 X86XDTR64 HostGdtr; /**< 0x0e - should be aligned by it's 64-bit member. */
91 uint8_t abPadding1[6];
92 X86XDTR64 HostGdtrRw; /**< 0x1e - should be aligned by it's 64-bit member. */
93 uint8_t abPadding2[6];
94 X86XDTR64 HostIdtr; /**< 0x2e - should be aligned by it's 64-bit member. */
95 uint64_t uHostFSBase; /* 0x38 */
96 uint64_t uHostGSBase; /* 0x40 */
97} VMXRESTOREHOST;
98/** Pointer to VMXRESTOREHOST. */
99typedef VMXRESTOREHOST *PVMXRESTOREHOST;
100AssertCompileSize(X86XDTR64, 10);
101AssertCompileMemberOffset(VMXRESTOREHOST, HostGdtr.uAddr, 16);
102AssertCompileMemberOffset(VMXRESTOREHOST, HostGdtrRw.uAddr, 32);
103AssertCompileMemberOffset(VMXRESTOREHOST, HostIdtr.uAddr, 48);
104AssertCompileMemberOffset(VMXRESTOREHOST, uHostFSBase, 56);
105AssertCompileSize(VMXRESTOREHOST, 72);
106AssertCompileSizeAlignment(VMXRESTOREHOST, 8);
107
108/** @name Host-state MSR lazy-restoration flags.
109 * @{
110 */
111/** The host MSRs have been saved. */
112#define VMX_LAZY_MSRS_SAVED_HOST RT_BIT(0)
113/** The guest MSRs are loaded and in effect. */
114#define VMX_LAZY_MSRS_LOADED_GUEST RT_BIT(1)
115/** @} */
116
117/** @name VMX HM-error codes for VERR_HM_UNSUPPORTED_CPU_FEATURE_COMBO.
118 * UFC = Unsupported Feature Combination.
119 * @{
120 */
121/** Unsupported pin-based VM-execution controls combo. */
122#define VMX_UFC_CTRL_PIN_EXEC 1
123/** Unsupported processor-based VM-execution controls combo. */
124#define VMX_UFC_CTRL_PROC_EXEC 2
125/** Unsupported move debug register VM-exit combo. */
126#define VMX_UFC_CTRL_PROC_MOV_DRX_EXIT 3
127/** Unsupported VM-entry controls combo. */
128#define VMX_UFC_CTRL_ENTRY 4
129/** Unsupported VM-exit controls combo. */
130#define VMX_UFC_CTRL_EXIT 5
131/** MSR storage capacity of the VMCS autoload/store area is not sufficient
132 * for storing host MSRs. */
133#define VMX_UFC_INSUFFICIENT_HOST_MSR_STORAGE 6
134/** MSR storage capacity of the VMCS autoload/store area is not sufficient
135 * for storing guest MSRs. */
136#define VMX_UFC_INSUFFICIENT_GUEST_MSR_STORAGE 7
137/** Invalid VMCS size. */
138#define VMX_UFC_INVALID_VMCS_SIZE 8
139/** Unsupported secondary processor-based VM-execution controls combo. */
140#define VMX_UFC_CTRL_PROC_EXEC2 9
141/** Invalid unrestricted-guest execution controls combo. */
142#define VMX_UFC_INVALID_UX_COMBO 10
143/** EPT flush type not supported. */
144#define VMX_UFC_EPT_FLUSH_TYPE_UNSUPPORTED 11
145/** EPT paging structure memory type is not write-back. */
146#define VMX_UFC_EPT_MEM_TYPE_NOT_WB 12
147/** EPT requires INVEPT instr. support but it's not available. */
148#define VMX_UFC_EPT_INVEPT_UNAVAILABLE 13
149/** EPT requires page-walk length of 4. */
150#define VMX_UFC_EPT_PAGE_WALK_LENGTH_UNSUPPORTED 14
151/** @} */
152
153/** @name VMX HM-error codes for VERR_VMX_VMCS_FIELD_CACHE_INVALID.
154 * VCI = VMCS-field Cache Invalid.
155 * @{
156 */
157/** Cache of VM-entry controls invalid. */
158#define VMX_VCI_CTRL_ENTRY 300
159/** Cache of VM-exit controls invalid. */
160#define VMX_VCI_CTRL_EXIT 301
161/** Cache of pin-based VM-execution controls invalid. */
162#define VMX_VCI_CTRL_PIN_EXEC 302
163/** Cache of processor-based VM-execution controls invalid. */
164#define VMX_VCI_CTRL_PROC_EXEC 303
165/** Cache of secondary processor-based VM-execution controls invalid. */
166#define VMX_VCI_CTRL_PROC_EXEC2 304
167/** Cache of exception bitmap invalid. */
168#define VMX_VCI_CTRL_XCPT_BITMAP 305
169/** Cache of TSC offset invalid. */
170#define VMX_VCI_CTRL_TSC_OFFSET 306
171/** @} */
172
173/** @name VMX HM-error codes for VERR_VMX_INVALID_GUEST_STATE.
174 * IGS = Invalid Guest State.
175 * @{
176 */
177/** An error occurred while checking invalid-guest-state. */
178#define VMX_IGS_ERROR 500
179/** The invalid guest-state checks did not find any reason why. */
180#define VMX_IGS_REASON_NOT_FOUND 501
181/** CR0 fixed1 bits invalid. */
182#define VMX_IGS_CR0_FIXED1 502
183/** CR0 fixed0 bits invalid. */
184#define VMX_IGS_CR0_FIXED0 503
185/** CR0.PE and CR0.PE invalid VT-x/host combination. */
186#define VMX_IGS_CR0_PG_PE_COMBO 504
187/** CR4 fixed1 bits invalid. */
188#define VMX_IGS_CR4_FIXED1 505
189/** CR4 fixed0 bits invalid. */
190#define VMX_IGS_CR4_FIXED0 506
191/** Reserved bits in VMCS' DEBUGCTL MSR field not set to 0 when
192 * VMX_VMCS_CTRL_ENTRY_LOAD_DEBUG is used. */
193#define VMX_IGS_DEBUGCTL_MSR_RESERVED 507
194/** CR0.PG not set for long-mode when not using unrestricted guest. */
195#define VMX_IGS_CR0_PG_LONGMODE 508
196/** CR4.PAE not set for long-mode guest when not using unrestricted guest. */
197#define VMX_IGS_CR4_PAE_LONGMODE 509
198/** CR4.PCIDE set for 32-bit guest. */
199#define VMX_IGS_CR4_PCIDE 510
200/** VMCS' DR7 reserved bits not set to 0. */
201#define VMX_IGS_DR7_RESERVED 511
202/** VMCS' PERF_GLOBAL MSR reserved bits not set to 0. */
203#define VMX_IGS_PERF_GLOBAL_MSR_RESERVED 512
204/** VMCS' EFER MSR reserved bits not set to 0. */
205#define VMX_IGS_EFER_MSR_RESERVED 513
206/** VMCS' EFER MSR.LMA does not match the IA32e mode guest control. */
207#define VMX_IGS_EFER_LMA_GUEST_MODE_MISMATCH 514
208/** VMCS' EFER MSR.LMA does not match EFER.LME of the guest when using paging
209 * without unrestricted guest. */
210#define VMX_IGS_EFER_LMA_LME_MISMATCH 515
211/** CS.Attr.P bit invalid. */
212#define VMX_IGS_CS_ATTR_P_INVALID 516
213/** CS.Attr reserved bits not set to 0. */
214#define VMX_IGS_CS_ATTR_RESERVED 517
215/** CS.Attr.G bit invalid. */
216#define VMX_IGS_CS_ATTR_G_INVALID 518
217/** CS is unusable. */
218#define VMX_IGS_CS_ATTR_UNUSABLE 519
219/** CS and SS DPL unequal. */
220#define VMX_IGS_CS_SS_ATTR_DPL_UNEQUAL 520
221/** CS and SS DPL mismatch. */
222#define VMX_IGS_CS_SS_ATTR_DPL_MISMATCH 521
223/** CS Attr.Type invalid. */
224#define VMX_IGS_CS_ATTR_TYPE_INVALID 522
225/** CS and SS RPL unequal. */
226#define VMX_IGS_SS_CS_RPL_UNEQUAL 523
227/** SS.Attr.DPL and SS RPL unequal. */
228#define VMX_IGS_SS_ATTR_DPL_RPL_UNEQUAL 524
229/** SS.Attr.DPL invalid for segment type. */
230#define VMX_IGS_SS_ATTR_DPL_INVALID 525
231/** SS.Attr.Type invalid. */
232#define VMX_IGS_SS_ATTR_TYPE_INVALID 526
233/** SS.Attr.P bit invalid. */
234#define VMX_IGS_SS_ATTR_P_INVALID 527
235/** SS.Attr reserved bits not set to 0. */
236#define VMX_IGS_SS_ATTR_RESERVED 528
237/** SS.Attr.G bit invalid. */
238#define VMX_IGS_SS_ATTR_G_INVALID 529
239/** DS.Attr.A bit invalid. */
240#define VMX_IGS_DS_ATTR_A_INVALID 530
241/** DS.Attr.P bit invalid. */
242#define VMX_IGS_DS_ATTR_P_INVALID 531
243/** DS.Attr.DPL and DS RPL unequal. */
244#define VMX_IGS_DS_ATTR_DPL_RPL_UNEQUAL 532
245/** DS.Attr reserved bits not set to 0. */
246#define VMX_IGS_DS_ATTR_RESERVED 533
247/** DS.Attr.G bit invalid. */
248#define VMX_IGS_DS_ATTR_G_INVALID 534
249/** DS.Attr.Type invalid. */
250#define VMX_IGS_DS_ATTR_TYPE_INVALID 535
251/** ES.Attr.A bit invalid. */
252#define VMX_IGS_ES_ATTR_A_INVALID 536
253/** ES.Attr.P bit invalid. */
254#define VMX_IGS_ES_ATTR_P_INVALID 537
255/** ES.Attr.DPL and DS RPL unequal. */
256#define VMX_IGS_ES_ATTR_DPL_RPL_UNEQUAL 538
257/** ES.Attr reserved bits not set to 0. */
258#define VMX_IGS_ES_ATTR_RESERVED 539
259/** ES.Attr.G bit invalid. */
260#define VMX_IGS_ES_ATTR_G_INVALID 540
261/** ES.Attr.Type invalid. */
262#define VMX_IGS_ES_ATTR_TYPE_INVALID 541
263/** FS.Attr.A bit invalid. */
264#define VMX_IGS_FS_ATTR_A_INVALID 542
265/** FS.Attr.P bit invalid. */
266#define VMX_IGS_FS_ATTR_P_INVALID 543
267/** FS.Attr.DPL and DS RPL unequal. */
268#define VMX_IGS_FS_ATTR_DPL_RPL_UNEQUAL 544
269/** FS.Attr reserved bits not set to 0. */
270#define VMX_IGS_FS_ATTR_RESERVED 545
271/** FS.Attr.G bit invalid. */
272#define VMX_IGS_FS_ATTR_G_INVALID 546
273/** FS.Attr.Type invalid. */
274#define VMX_IGS_FS_ATTR_TYPE_INVALID 547
275/** GS.Attr.A bit invalid. */
276#define VMX_IGS_GS_ATTR_A_INVALID 548
277/** GS.Attr.P bit invalid. */
278#define VMX_IGS_GS_ATTR_P_INVALID 549
279/** GS.Attr.DPL and DS RPL unequal. */
280#define VMX_IGS_GS_ATTR_DPL_RPL_UNEQUAL 550
281/** GS.Attr reserved bits not set to 0. */
282#define VMX_IGS_GS_ATTR_RESERVED 551
283/** GS.Attr.G bit invalid. */
284#define VMX_IGS_GS_ATTR_G_INVALID 552
285/** GS.Attr.Type invalid. */
286#define VMX_IGS_GS_ATTR_TYPE_INVALID 553
287/** V86 mode CS.Base invalid. */
288#define VMX_IGS_V86_CS_BASE_INVALID 554
289/** V86 mode CS.Limit invalid. */
290#define VMX_IGS_V86_CS_LIMIT_INVALID 555
291/** V86 mode CS.Attr invalid. */
292#define VMX_IGS_V86_CS_ATTR_INVALID 556
293/** V86 mode SS.Base invalid. */
294#define VMX_IGS_V86_SS_BASE_INVALID 557
295/** V86 mode SS.Limit invalid. */
296#define VMX_IGS_V86_SS_LIMIT_INVALID 558
297/** V86 mode SS.Attr invalid. */
298#define VMX_IGS_V86_SS_ATTR_INVALID 559
299/** V86 mode DS.Base invalid. */
300#define VMX_IGS_V86_DS_BASE_INVALID 560
301/** V86 mode DS.Limit invalid. */
302#define VMX_IGS_V86_DS_LIMIT_INVALID 561
303/** V86 mode DS.Attr invalid. */
304#define VMX_IGS_V86_DS_ATTR_INVALID 562
305/** V86 mode ES.Base invalid. */
306#define VMX_IGS_V86_ES_BASE_INVALID 563
307/** V86 mode ES.Limit invalid. */
308#define VMX_IGS_V86_ES_LIMIT_INVALID 564
309/** V86 mode ES.Attr invalid. */
310#define VMX_IGS_V86_ES_ATTR_INVALID 565
311/** V86 mode FS.Base invalid. */
312#define VMX_IGS_V86_FS_BASE_INVALID 566
313/** V86 mode FS.Limit invalid. */
314#define VMX_IGS_V86_FS_LIMIT_INVALID 567
315/** V86 mode FS.Attr invalid. */
316#define VMX_IGS_V86_FS_ATTR_INVALID 568
317/** V86 mode GS.Base invalid. */
318#define VMX_IGS_V86_GS_BASE_INVALID 569
319/** V86 mode GS.Limit invalid. */
320#define VMX_IGS_V86_GS_LIMIT_INVALID 570
321/** V86 mode GS.Attr invalid. */
322#define VMX_IGS_V86_GS_ATTR_INVALID 571
323/** Longmode CS.Base invalid. */
324#define VMX_IGS_LONGMODE_CS_BASE_INVALID 572
325/** Longmode SS.Base invalid. */
326#define VMX_IGS_LONGMODE_SS_BASE_INVALID 573
327/** Longmode DS.Base invalid. */
328#define VMX_IGS_LONGMODE_DS_BASE_INVALID 574
329/** Longmode ES.Base invalid. */
330#define VMX_IGS_LONGMODE_ES_BASE_INVALID 575
331/** SYSENTER ESP is not canonical. */
332#define VMX_IGS_SYSENTER_ESP_NOT_CANONICAL 576
333/** SYSENTER EIP is not canonical. */
334#define VMX_IGS_SYSENTER_EIP_NOT_CANONICAL 577
335/** PAT MSR invalid. */
336#define VMX_IGS_PAT_MSR_INVALID 578
337/** PAT MSR reserved bits not set to 0. */
338#define VMX_IGS_PAT_MSR_RESERVED 579
339/** GDTR.Base is not canonical. */
340#define VMX_IGS_GDTR_BASE_NOT_CANONICAL 580
341/** IDTR.Base is not canonical. */
342#define VMX_IGS_IDTR_BASE_NOT_CANONICAL 581
343/** GDTR.Limit invalid. */
344#define VMX_IGS_GDTR_LIMIT_INVALID 582
345/** IDTR.Limit invalid. */
346#define VMX_IGS_IDTR_LIMIT_INVALID 583
347/** Longmode RIP is invalid. */
348#define VMX_IGS_LONGMODE_RIP_INVALID 584
349/** RFLAGS reserved bits not set to 0. */
350#define VMX_IGS_RFLAGS_RESERVED 585
351/** RFLAGS RA1 reserved bits not set to 1. */
352#define VMX_IGS_RFLAGS_RESERVED1 586
353/** RFLAGS.VM (V86 mode) invalid. */
354#define VMX_IGS_RFLAGS_VM_INVALID 587
355/** RFLAGS.IF invalid. */
356#define VMX_IGS_RFLAGS_IF_INVALID 588
357/** Activity state invalid. */
358#define VMX_IGS_ACTIVITY_STATE_INVALID 589
359/** Activity state HLT invalid when SS.Attr.DPL is not zero. */
360#define VMX_IGS_ACTIVITY_STATE_HLT_INVALID 590
361/** Activity state ACTIVE invalid when block-by-STI or MOV SS. */
362#define VMX_IGS_ACTIVITY_STATE_ACTIVE_INVALID 591
363/** Activity state SIPI WAIT invalid. */
364#define VMX_IGS_ACTIVITY_STATE_SIPI_WAIT_INVALID 592
365/** Interruptibility state reserved bits not set to 0. */
366#define VMX_IGS_INTERRUPTIBILITY_STATE_RESERVED 593
367/** Interruptibility state cannot be block-by-STI -and- MOV SS. */
368#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_MOVSS_INVALID 594
369/** Interruptibility state block-by-STI invalid for EFLAGS. */
370#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_EFL_INVALID 595
371/** Interruptibility state invalid while trying to deliver external
372 * interrupt. */
373#define VMX_IGS_INTERRUPTIBILITY_STATE_EXT_INT_INVALID 596
374/** Interruptibility state block-by-MOVSS invalid while trying to deliver an
375 * NMI. */
376#define VMX_IGS_INTERRUPTIBILITY_STATE_MOVSS_INVALID 597
377/** Interruptibility state block-by-SMI invalid when CPU is not in SMM. */
378#define VMX_IGS_INTERRUPTIBILITY_STATE_SMI_INVALID 598
379/** Interruptibility state block-by-SMI invalid when trying to enter SMM. */
380#define VMX_IGS_INTERRUPTIBILITY_STATE_SMI_SMM_INVALID 599
381/** Interruptibility state block-by-STI (maybe) invalid when trying to
382 * deliver an NMI. */
383#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_INVALID 600
384/** Interruptibility state block-by-NMI invalid when virtual-NMIs control is
385 * active. */
386#define VMX_IGS_INTERRUPTIBILITY_STATE_NMI_INVALID 601
387/** Pending debug exceptions reserved bits not set to 0. */
388#define VMX_IGS_PENDING_DEBUG_RESERVED 602
389/** Longmode pending debug exceptions reserved bits not set to 0. */
390#define VMX_IGS_LONGMODE_PENDING_DEBUG_RESERVED 603
391/** Pending debug exceptions.BS bit is not set when it should be. */
392#define VMX_IGS_PENDING_DEBUG_XCPT_BS_NOT_SET 604
393/** Pending debug exceptions.BS bit is not clear when it should be. */
394#define VMX_IGS_PENDING_DEBUG_XCPT_BS_NOT_CLEAR 605
395/** VMCS link pointer reserved bits not set to 0. */
396#define VMX_IGS_VMCS_LINK_PTR_RESERVED 606
397/** TR cannot index into LDT, TI bit MBZ. */
398#define VMX_IGS_TR_TI_INVALID 607
399/** LDTR cannot index into LDT. TI bit MBZ. */
400#define VMX_IGS_LDTR_TI_INVALID 608
401/** TR.Base is not canonical. */
402#define VMX_IGS_TR_BASE_NOT_CANONICAL 609
403/** FS.Base is not canonical. */
404#define VMX_IGS_FS_BASE_NOT_CANONICAL 610
405/** GS.Base is not canonical. */
406#define VMX_IGS_GS_BASE_NOT_CANONICAL 611
407/** LDTR.Base is not canonical. */
408#define VMX_IGS_LDTR_BASE_NOT_CANONICAL 612
409/** TR is unusable. */
410#define VMX_IGS_TR_ATTR_UNUSABLE 613
411/** TR.Attr.S bit invalid. */
412#define VMX_IGS_TR_ATTR_S_INVALID 614
413/** TR is not present. */
414#define VMX_IGS_TR_ATTR_P_INVALID 615
415/** TR.Attr reserved bits not set to 0. */
416#define VMX_IGS_TR_ATTR_RESERVED 616
417/** TR.Attr.G bit invalid. */
418#define VMX_IGS_TR_ATTR_G_INVALID 617
419/** Longmode TR.Attr.Type invalid. */
420#define VMX_IGS_LONGMODE_TR_ATTR_TYPE_INVALID 618
421/** TR.Attr.Type invalid. */
422#define VMX_IGS_TR_ATTR_TYPE_INVALID 619
423/** CS.Attr.S invalid. */
424#define VMX_IGS_CS_ATTR_S_INVALID 620
425/** CS.Attr.DPL invalid. */
426#define VMX_IGS_CS_ATTR_DPL_INVALID 621
427/** PAE PDPTE reserved bits not set to 0. */
428#define VMX_IGS_PAE_PDPTE_RESERVED 623
429/** @} */
430
431/** @name VMX VMCS-Read cache indices.
432 * @{
433 */
434#define VMX_VMCS_GUEST_ES_BASE_CACHE_IDX 0
435#define VMX_VMCS_GUEST_CS_BASE_CACHE_IDX 1
436#define VMX_VMCS_GUEST_SS_BASE_CACHE_IDX 2
437#define VMX_VMCS_GUEST_DS_BASE_CACHE_IDX 3
438#define VMX_VMCS_GUEST_FS_BASE_CACHE_IDX 4
439#define VMX_VMCS_GUEST_GS_BASE_CACHE_IDX 5
440#define VMX_VMCS_GUEST_LDTR_BASE_CACHE_IDX 6
441#define VMX_VMCS_GUEST_TR_BASE_CACHE_IDX 7
442#define VMX_VMCS_GUEST_GDTR_BASE_CACHE_IDX 8
443#define VMX_VMCS_GUEST_IDTR_BASE_CACHE_IDX 9
444#define VMX_VMCS_GUEST_RSP_CACHE_IDX 10
445#define VMX_VMCS_GUEST_RIP_CACHE_IDX 11
446#define VMX_VMCS_GUEST_SYSENTER_ESP_CACHE_IDX 12
447#define VMX_VMCS_GUEST_SYSENTER_EIP_CACHE_IDX 13
448#define VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX 14
449#define VMX_VMCS_MAX_CACHE_IDX (VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX + 1)
450#define VMX_VMCS_GUEST_CR3_CACHE_IDX 15
451#define VMX_VMCS_MAX_NESTED_PAGING_CACHE_IDX (VMX_VMCS_GUEST_CR3_CACHE_IDX + 1)
452/** @} */
453
454/** @name VMX EPT paging structures
455 * @{
456 */
457
458/**
459 * Number of page table entries in the EPT. (PDPTE/PDE/PTE)
460 */
461#define EPT_PG_ENTRIES X86_PG_PAE_ENTRIES
462
463/**
464 * EPT Page Directory Pointer Entry. Bit view.
465 * @todo uint64_t isn't safe for bitfields (gcc pedantic warnings, and IIRC,
466 * this did cause trouble with one compiler/version).
467 */
468typedef struct EPTPML4EBITS
469{
470 /** Present bit. */
471 uint64_t u1Present : 1;
472 /** Writable bit. */
473 uint64_t u1Write : 1;
474 /** Executable bit. */
475 uint64_t u1Execute : 1;
476 /** Reserved (must be 0). */
477 uint64_t u5Reserved : 5;
478 /** Available for software. */
479 uint64_t u4Available : 4;
480 /** Physical address of the next level (PD). Restricted by maximum physical address width of the cpu. */
481 uint64_t u40PhysAddr : 40;
482 /** Available for software. */
483 uint64_t u12Available : 12;
484} EPTPML4EBITS;
485AssertCompileSize(EPTPML4EBITS, 8);
486
487/** Bits 12-51 - - EPT - Physical Page number of the next level. */
488#define EPT_PML4E_PG_MASK X86_PML4E_PG_MASK
489/** The page shift to get the PML4 index. */
490#define EPT_PML4_SHIFT X86_PML4_SHIFT
491/** The PML4 index mask (apply to a shifted page address). */
492#define EPT_PML4_MASK X86_PML4_MASK
493
494/**
495 * EPT PML4E.
496 */
497typedef union EPTPML4E
498{
499 /** Normal view. */
500 EPTPML4EBITS n;
501 /** Unsigned integer view. */
502 X86PGPAEUINT u;
503 /** 64 bit unsigned integer view. */
504 uint64_t au64[1];
505 /** 32 bit unsigned integer view. */
506 uint32_t au32[2];
507} EPTPML4E;
508AssertCompileSize(EPTPML4E, 8);
509/** Pointer to a PML4 table entry. */
510typedef EPTPML4E *PEPTPML4E;
511/** Pointer to a const PML4 table entry. */
512typedef const EPTPML4E *PCEPTPML4E;
513
514/**
515 * EPT PML4 Table.
516 */
517typedef struct EPTPML4
518{
519 EPTPML4E a[EPT_PG_ENTRIES];
520} EPTPML4;
521AssertCompileSize(EPTPML4, 0x1000);
522/** Pointer to an EPT PML4 Table. */
523typedef EPTPML4 *PEPTPML4;
524/** Pointer to a const EPT PML4 Table. */
525typedef const EPTPML4 *PCEPTPML4;
526
527/**
528 * EPT Page Directory Pointer Entry. Bit view.
529 */
530typedef struct EPTPDPTEBITS
531{
532 /** Present bit. */
533 uint64_t u1Present : 1;
534 /** Writable bit. */
535 uint64_t u1Write : 1;
536 /** Executable bit. */
537 uint64_t u1Execute : 1;
538 /** Reserved (must be 0). */
539 uint64_t u5Reserved : 5;
540 /** Available for software. */
541 uint64_t u4Available : 4;
542 /** Physical address of the next level (PD). Restricted by maximum physical address width of the cpu. */
543 uint64_t u40PhysAddr : 40;
544 /** Available for software. */
545 uint64_t u12Available : 12;
546} EPTPDPTEBITS;
547AssertCompileSize(EPTPDPTEBITS, 8);
548
549/** Bits 12-51 - - EPT - Physical Page number of the next level. */
550#define EPT_PDPTE_PG_MASK X86_PDPE_PG_MASK
551/** The page shift to get the PDPT index. */
552#define EPT_PDPT_SHIFT X86_PDPT_SHIFT
553/** The PDPT index mask (apply to a shifted page address). */
554#define EPT_PDPT_MASK X86_PDPT_MASK_AMD64
555
556/**
557 * EPT Page Directory Pointer.
558 */
559typedef union EPTPDPTE
560{
561 /** Normal view. */
562 EPTPDPTEBITS n;
563 /** Unsigned integer view. */
564 X86PGPAEUINT u;
565 /** 64 bit unsigned integer view. */
566 uint64_t au64[1];
567 /** 32 bit unsigned integer view. */
568 uint32_t au32[2];
569} EPTPDPTE;
570AssertCompileSize(EPTPDPTE, 8);
571/** Pointer to an EPT Page Directory Pointer Entry. */
572typedef EPTPDPTE *PEPTPDPTE;
573/** Pointer to a const EPT Page Directory Pointer Entry. */
574typedef const EPTPDPTE *PCEPTPDPTE;
575
576/**
577 * EPT Page Directory Pointer Table.
578 */
579typedef struct EPTPDPT
580{
581 EPTPDPTE a[EPT_PG_ENTRIES];
582} EPTPDPT;
583AssertCompileSize(EPTPDPT, 0x1000);
584/** Pointer to an EPT Page Directory Pointer Table. */
585typedef EPTPDPT *PEPTPDPT;
586/** Pointer to a const EPT Page Directory Pointer Table. */
587typedef const EPTPDPT *PCEPTPDPT;
588
589/**
590 * EPT Page Directory Table Entry. Bit view.
591 */
592typedef struct EPTPDEBITS
593{
594 /** Present bit. */
595 uint64_t u1Present : 1;
596 /** Writable bit. */
597 uint64_t u1Write : 1;
598 /** Executable bit. */
599 uint64_t u1Execute : 1;
600 /** Reserved (must be 0). */
601 uint64_t u4Reserved : 4;
602 /** Big page (must be 0 here). */
603 uint64_t u1Size : 1;
604 /** Available for software. */
605 uint64_t u4Available : 4;
606 /** Physical address of page table. Restricted by maximum physical address width of the cpu. */
607 uint64_t u40PhysAddr : 40;
608 /** Available for software. */
609 uint64_t u12Available : 12;
610} EPTPDEBITS;
611AssertCompileSize(EPTPDEBITS, 8);
612
613/** Bits 12-51 - - EPT - Physical Page number of the next level. */
614#define EPT_PDE_PG_MASK X86_PDE_PAE_PG_MASK
615/** The page shift to get the PD index. */
616#define EPT_PD_SHIFT X86_PD_PAE_SHIFT
617/** The PD index mask (apply to a shifted page address). */
618#define EPT_PD_MASK X86_PD_PAE_MASK
619
620/**
621 * EPT 2MB Page Directory Table Entry. Bit view.
622 */
623typedef struct EPTPDE2MBITS
624{
625 /** Present bit. */
626 uint64_t u1Present : 1;
627 /** Writable bit. */
628 uint64_t u1Write : 1;
629 /** Executable bit. */
630 uint64_t u1Execute : 1;
631 /** EPT Table Memory Type. MBZ for non-leaf nodes. */
632 uint64_t u3EMT : 3;
633 /** Ignore PAT memory type */
634 uint64_t u1IgnorePAT : 1;
635 /** Big page (must be 1 here). */
636 uint64_t u1Size : 1;
637 /** Available for software. */
638 uint64_t u4Available : 4;
639 /** Reserved (must be 0). */
640 uint64_t u9Reserved : 9;
641 /** Physical address of the 2MB page. Restricted by maximum physical address width of the cpu. */
642 uint64_t u31PhysAddr : 31;
643 /** Available for software. */
644 uint64_t u12Available : 12;
645} EPTPDE2MBITS;
646AssertCompileSize(EPTPDE2MBITS, 8);
647
648/** Bits 21-51 - - EPT - Physical Page number of the next level. */
649#define EPT_PDE2M_PG_MASK X86_PDE2M_PAE_PG_MASK
650
651/**
652 * EPT Page Directory Table Entry.
653 */
654typedef union EPTPDE
655{
656 /** Normal view. */
657 EPTPDEBITS n;
658 /** 2MB view (big). */
659 EPTPDE2MBITS b;
660 /** Unsigned integer view. */
661 X86PGPAEUINT u;
662 /** 64 bit unsigned integer view. */
663 uint64_t au64[1];
664 /** 32 bit unsigned integer view. */
665 uint32_t au32[2];
666} EPTPDE;
667AssertCompileSize(EPTPDE, 8);
668/** Pointer to an EPT Page Directory Table Entry. */
669typedef EPTPDE *PEPTPDE;
670/** Pointer to a const EPT Page Directory Table Entry. */
671typedef const EPTPDE *PCEPTPDE;
672
673/**
674 * EPT Page Directory Table.
675 */
676typedef struct EPTPD
677{
678 EPTPDE a[EPT_PG_ENTRIES];
679} EPTPD;
680AssertCompileSize(EPTPD, 0x1000);
681/** Pointer to an EPT Page Directory Table. */
682typedef EPTPD *PEPTPD;
683/** Pointer to a const EPT Page Directory Table. */
684typedef const EPTPD *PCEPTPD;
685
686/**
687 * EPT Page Table Entry. Bit view.
688 */
689typedef struct EPTPTEBITS
690{
691 /** 0 - Present bit.
692 * @remarks This is a convenience "misnomer". The bit actually indicates read access
693 * and the CPU will consider an entry with any of the first three bits set
694 * as present. Since all our valid entries will have this bit set, it can
695 * be used as a present indicator and allow some code sharing. */
696 uint64_t u1Present : 1;
697 /** 1 - Writable bit. */
698 uint64_t u1Write : 1;
699 /** 2 - Executable bit. */
700 uint64_t u1Execute : 1;
701 /** 5:3 - EPT Memory Type. MBZ for non-leaf nodes. */
702 uint64_t u3EMT : 3;
703 /** 6 - Ignore PAT memory type */
704 uint64_t u1IgnorePAT : 1;
705 /** 11:7 - Available for software. */
706 uint64_t u5Available : 5;
707 /** 51:12 - Physical address of page. Restricted by maximum physical
708 * address width of the cpu. */
709 uint64_t u40PhysAddr : 40;
710 /** 63:52 - Available for software. */
711 uint64_t u12Available : 12;
712} EPTPTEBITS;
713AssertCompileSize(EPTPTEBITS, 8);
714
715/** Bits 12-51 - - EPT - Physical Page number of the next level. */
716#define EPT_PTE_PG_MASK X86_PTE_PAE_PG_MASK
717/** The page shift to get the EPT PTE index. */
718#define EPT_PT_SHIFT X86_PT_PAE_SHIFT
719/** The EPT PT index mask (apply to a shifted page address). */
720#define EPT_PT_MASK X86_PT_PAE_MASK
721
722/**
723 * EPT Page Table Entry.
724 */
725typedef union EPTPTE
726{
727 /** Normal view. */
728 EPTPTEBITS n;
729 /** Unsigned integer view. */
730 X86PGPAEUINT u;
731 /** 64 bit unsigned integer view. */
732 uint64_t au64[1];
733 /** 32 bit unsigned integer view. */
734 uint32_t au32[2];
735} EPTPTE;
736AssertCompileSize(EPTPTE, 8);
737/** Pointer to an EPT Page Directory Table Entry. */
738typedef EPTPTE *PEPTPTE;
739/** Pointer to a const EPT Page Directory Table Entry. */
740typedef const EPTPTE *PCEPTPTE;
741
742/**
743 * EPT Page Table.
744 */
745typedef struct EPTPT
746{
747 EPTPTE a[EPT_PG_ENTRIES];
748} EPTPT;
749AssertCompileSize(EPTPT, 0x1000);
750/** Pointer to an extended page table. */
751typedef EPTPT *PEPTPT;
752/** Pointer to a const extended table. */
753typedef const EPTPT *PCEPTPT;
754
755/** @} */
756
757/**
758 * VMX VPID flush types.
759 * @note Valid enum members are in accordance to the VT-x spec.
760 */
761typedef enum
762{
763 /** Invalidate a specific page. */
764 VMXTLBFLUSHVPID_INDIV_ADDR = 0,
765 /** Invalidate one context (specific VPID). */
766 VMXTLBFLUSHVPID_SINGLE_CONTEXT = 1,
767 /** Invalidate all contexts (all VPIDs). */
768 VMXTLBFLUSHVPID_ALL_CONTEXTS = 2,
769 /** Invalidate a single VPID context retaining global mappings. */
770 VMXTLBFLUSHVPID_SINGLE_CONTEXT_RETAIN_GLOBALS = 3,
771 /** Unsupported by VirtualBox. */
772 VMXTLBFLUSHVPID_NOT_SUPPORTED = 0xbad0,
773 /** Unsupported by CPU. */
774 VMXTLBFLUSHVPID_NONE = 0xbad1
775} VMXTLBFLUSHVPID;
776AssertCompileSize(VMXTLBFLUSHVPID, 4);
777
778/**
779 * VMX EPT flush types.
780 * @note Valid enums values are in accordance to the VT-x spec.
781 */
782typedef enum
783{
784 /** Invalidate one context (specific EPT). */
785 VMXTLBFLUSHEPT_SINGLE_CONTEXT = 1,
786 /* Invalidate all contexts (all EPTs) */
787 VMXTLBFLUSHEPT_ALL_CONTEXTS = 2,
788 /** Unsupported by VirtualBox. */
789 VMXTLBFLUSHEPT_NOT_SUPPORTED = 0xbad0,
790 /** Unsupported by CPU. */
791 VMXTLBFLUSHEPT_NONE = 0xbad1
792} VMXTLBFLUSHEPT;
793AssertCompileSize(VMXTLBFLUSHEPT, 4);
794
795/**
796 * VMX Posted Interrupt Descriptor.
797 * In accordance to the VT-x spec.
798 */
799typedef struct VMXPOSTEDINTRDESC
800{
801 uint32_t aVectorBitmap[8];
802 uint32_t fOutstandingNotification : 1;
803 uint32_t uReserved0 : 31;
804 uint8_t au8Reserved0[28];
805} VMXPOSTEDINTRDESC;
806AssertCompileMemberSize(VMXPOSTEDINTRDESC, aVectorBitmap, 32);
807AssertCompileSize(VMXPOSTEDINTRDESC, 64);
808/** Pointer to a posted interrupt descriptor. */
809typedef VMXPOSTEDINTRDESC *PVMXPOSTEDINTRDESC;
810/** Pointer to a const posted interrupt descriptor. */
811typedef const VMXPOSTEDINTRDESC *PCVMXPOSTEDINTRDESC;
812
813/**
814 * VMX VMCS revision identifier.
815 */
816typedef union
817{
818 struct
819 {
820 /** Revision identifier. */
821 uint32_t u31RevisionId : 31;
822 /** Whether this is a shadow VMCS. */
823 uint32_t fIsShadowVmcs : 1;
824 } n;
825 /* The unsigned integer view. */
826 uint32_t u;
827} VMXVMCSREVID;
828AssertCompileSize(VMXVMCSREVID, 4);
829/** Pointer to the VMXVMCSREVID union. */
830typedef VMXVMCSREVID *PVMXVMCSREVID;
831/** Pointer to a const VMXVVMCSREVID union. */
832typedef const VMXVMCSREVID *PCVMXVMCSREVID;
833
834/**
835 * VMX VM-exit instruction information.
836 */
837typedef union
838{
839 /** Plain unsigned int representation. */
840 uint32_t u;
841
842 /** INS and OUTS information. */
843 struct
844 {
845 uint32_t u7Reserved0 : 7;
846 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
847 uint32_t u3AddrSize : 3;
848 uint32_t u5Reserved1 : 5;
849 /** The segment register (X86_SREG_XXX). */
850 uint32_t iSegReg : 3;
851 uint32_t uReserved2 : 14;
852 } StrIo;
853
854 struct
855 {
856 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
857 uint32_t u2Scaling : 2;
858 uint32_t u5Undef0 : 5;
859 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
860 uint32_t u3AddrSize : 3;
861 /** Cleared to 0. */
862 uint32_t u1Cleared0 : 1;
863 uint32_t u4Undef0 : 4;
864 /** The segment register (X86_SREG_XXX). */
865 uint32_t iSegReg : 3;
866 /** The index register (X86_GREG_XXX). */
867 uint32_t iIdxReg : 4;
868 /** Set if index register is invalid. */
869 uint32_t fIdxRegInvalid : 1;
870 /** The base register (X86_GREG_XXX). */
871 uint32_t iBaseReg : 4;
872 /** Set if base register is invalid. */
873 uint32_t fBaseRegInvalid : 1;
874 /** Register 2 (X86_GREG_XXX). */
875 uint32_t iReg2 : 4;
876 } Inv;
877
878 /** VMCLEAR, VMPTRLD, VMPTRST, VMXON, XRSTORS, XSAVES information. */
879 struct
880 {
881 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
882 uint32_t u2Scaling : 2;
883 uint32_t u5Reserved0 : 5;
884 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
885 uint32_t u3AddrSize : 3;
886 /** Cleared to 0. */
887 uint32_t u1Cleared0 : 1;
888 uint32_t u4Reserved0 : 4;
889 /** The segment register (X86_SREG_XXX). */
890 uint32_t iSegReg : 3;
891 /** The index register (X86_GREG_XXX). */
892 uint32_t iIdxReg : 4;
893 /** Set if index register is invalid. */
894 uint32_t fIdxRegInvalid : 1;
895 /** The base register (X86_GREG_XXX). */
896 uint32_t iBaseReg : 4;
897 /** Set if base register is invalid. */
898 uint32_t fBaseRegInvalid : 1;
899 /** Register 2 (X86_GREG_XXX). */
900 uint32_t iReg2 : 4;
901 } VmxXsave;
902
903 /** LIDT, LGDT, SIDT, SGDT information. */
904 struct
905 {
906 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
907 uint32_t u2Scaling : 2;
908 uint32_t u5Undef0 : 5;
909 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
910 uint32_t u3AddrSize : 3;
911 /** Always cleared to 0. */
912 uint32_t u1Cleared0 : 1;
913 /** Operand size; 0=16-bit, 1=32-bit, undefined for 64-bit. */
914 uint32_t uOperandSize : 1;
915 uint32_t u3Undef0 : 3;
916 /** The segment register (X86_SREG_XXX). */
917 uint32_t iSegReg : 3;
918 /** The index register (X86_GREG_XXX). */
919 uint32_t iIdxReg : 4;
920 /** Set if index register is invalid. */
921 uint32_t fIdxRegInvalid : 1;
922 /** The base register (X86_GREG_XXX). */
923 uint32_t iBaseReg : 4;
924 /** Set if base register is invalid. */
925 uint32_t fBaseRegInvalid : 1;
926 /** Instruction identity (VMX_INSTR_ID_XXX). */
927 uint32_t u2InstrId : 2;
928 uint32_t u2Undef0 : 2;
929 } GdtIdt;
930
931 /** LLDT, LTR, SLDT, STR information. */
932 struct
933 {
934 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
935 uint32_t u2Scaling : 2;
936 uint32_t u1Undef0 : 1;
937 /** Register 1 (X86_GREG_XXX). */
938 uint32_t iReg1 : 4;
939 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
940 uint32_t u3AddrSize : 3;
941 /** Memory/Register - Always cleared to 0 to indicate memory operand. */
942 uint32_t fIsRegOperand : 1;
943 uint32_t u4Undef0 : 4;
944 /** The segment register (X86_SREG_XXX). */
945 uint32_t iSegReg : 3;
946 /** The index register (X86_GREG_XXX). */
947 uint32_t iIdxReg : 4;
948 /** Set if index register is invalid. */
949 uint32_t fIdxRegInvalid : 1;
950 /** The base register (X86_GREG_XXX). */
951 uint32_t iBaseReg : 4;
952 /** Set if base register is invalid. */
953 uint32_t fBaseRegInvalid : 1;
954 /** Instruction identity (VMX_INSTR_ID_XXX). */
955 uint32_t u2InstrId : 2;
956 uint32_t u2Undef0 : 2;
957 } LdtTr;
958
959 /** RDRAND, RDSEED information. */
960 struct
961 {
962 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
963 uint32_t u2Undef0 : 2;
964 /** Destination register (X86_GREG_XXX). */
965 uint32_t iReg1 : 4;
966 uint32_t u4Undef0 : 4;
967 /** Operand size; 0=16-bit, 1=32-bit, 2=64-bit, 3=unused. */
968 uint32_t u2OperandSize : 2;
969 uint32_t u19Def0 : 20;
970 } RdrandRdseed;
971
972 struct
973 {
974 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
975 uint32_t u2Scaling : 2;
976 uint32_t u1Undef0 : 1;
977 /** Register 1 (X86_GREG_XXX). */
978 uint32_t iReg1 : 4;
979 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
980 uint32_t u3AddrSize : 3;
981 /** Memory or register operand. */
982 uint32_t fIsRegOperand : 1;
983 /** Operand size; 0=16-bit, 1=32-bit, 2=64-bit, 3=unused. */
984 uint32_t u4Undef0 : 4;
985 /** The segment register (X86_SREG_XXX). */
986 uint32_t iSegReg : 3;
987 /** The index register (X86_GREG_XXX). */
988 uint32_t iIdxReg : 4;
989 /** Set if index register is invalid. */
990 uint32_t fIdxRegInvalid : 1;
991 /** The base register (X86_GREG_XXX). */
992 uint32_t iBaseReg : 4;
993 /** Set if base register is invalid. */
994 uint32_t fBaseRegInvalid : 1;
995 /** Register 2 (X86_GREG_XXX). */
996 uint32_t iReg2 : 4;
997 } VmreadVmwrite;
998
999 /** This is a combination field of all instruction information. Note! Not all field
1000 * combinations are valid (e.g., iReg1 is undefined for memory operands) and
1001 * specialized fields are overwritten by their generic counterparts (e.g. no
1002 * instruction identity field). */
1003 struct
1004 {
1005 /** Scaling; 0=no scaling, 1=scale-by-2, 2=scale-by-4, 3=scale-by-8. */
1006 uint32_t u2Scaling : 2;
1007 uint32_t u1Undef0 : 1;
1008 /** Register 1 (X86_GREG_XXX). */
1009 uint32_t iReg1 : 4;
1010 /** The address size; 0=16-bit, 1=32-bit, 2=64-bit, rest undefined. */
1011 uint32_t u3AddrSize : 3;
1012 /** Memory/Register - Always cleared to 0 to indicate memory operand. */
1013 uint32_t fIsRegOperand : 1;
1014 /** Operand size; 0=16-bit, 1=32-bit, 2=64-bit, 3=unused. */
1015 uint32_t uOperandSize : 2;
1016 uint32_t u2Undef0 : 2;
1017 /** The segment register (X86_SREG_XXX). */
1018 uint32_t iSegReg : 3;
1019 /** The index register (X86_GREG_XXX). */
1020 uint32_t iIdxReg : 4;
1021 /** Set if index register is invalid. */
1022 uint32_t fIdxRegInvalid : 1;
1023 /** The base register (X86_GREG_XXX). */
1024 uint32_t iBaseReg : 4;
1025 /** Set if base register is invalid. */
1026 uint32_t fBaseRegInvalid : 1;
1027 /** Register 2 (X86_GREG_XXX) or instruction identity. */
1028 uint32_t iReg2 : 4;
1029 } All;
1030} VMXEXITINSTRINFO;
1031AssertCompileSize(VMXEXITINSTRINFO, 4);
1032/** Pointer to a VMX VM-exit instruction info. struct. */
1033typedef VMXEXITINSTRINFO *PVMXEXITINSTRINFO;
1034/** Pointer to a const VMX VM-exit instruction info. struct. */
1035typedef const VMXEXITINSTRINFO *PCVMXEXITINSTRINFO;
1036
1037/**
1038 * VMX MSR autoload/store element.
1039 * In accordance to the VT-x spec.
1040 */
1041typedef struct VMXAUTOMSR
1042{
1043 /** The MSR Id. */
1044 uint32_t u32Msr;
1045 /** Reserved (MBZ). */
1046 uint32_t u32Reserved;
1047 /** The MSR value. */
1048 uint64_t u64Value;
1049} VMXAUTOMSR;
1050AssertCompileSize(VMXAUTOMSR, 16);
1051/** Pointer to an MSR load/store element. */
1052typedef VMXAUTOMSR *PVMXAUTOMSR;
1053/** Pointer to a const MSR load/store element. */
1054typedef const VMXAUTOMSR *PCVMXAUTOMSR;
1055
1056/** VMX auto load-store MSR (VMXAUTOMSR) offset mask. */
1057#define VMX_AUTOMSR_OFFSET_MASK 0xf
1058
1059/**
1060 * VMX tagged-TLB flush types.
1061 */
1062typedef enum
1063{
1064 VMXTLBFLUSHTYPE_EPT,
1065 VMXTLBFLUSHTYPE_VPID,
1066 VMXTLBFLUSHTYPE_EPT_VPID,
1067 VMXTLBFLUSHTYPE_NONE
1068} VMXTLBFLUSHTYPE;
1069/** Pointer to a VMXTLBFLUSHTYPE enum. */
1070typedef VMXTLBFLUSHTYPE *PVMXTLBFLUSHTYPE;
1071/** Pointer to a const VMXTLBFLUSHTYPE enum. */
1072typedef const VMXTLBFLUSHTYPE *PCVMXTLBFLUSHTYPE;
1073
1074/**
1075 * VMX controls MSR.
1076 */
1077typedef union
1078{
1079 struct
1080 {
1081 /** Bits set here -must- be set in the corresponding VM-execution controls. */
1082 uint32_t disallowed0;
1083 /** Bits cleared here -must- be cleared in the corresponding VM-execution
1084 * controls. */
1085 uint32_t allowed1;
1086 } n;
1087 uint64_t u;
1088} VMXCTLSMSR;
1089AssertCompileSize(VMXCTLSMSR, 8);
1090/** Pointer to a VMXCTLSMSR union. */
1091typedef VMXCTLSMSR *PVMXCTLSMSR;
1092/** Pointer to a const VMXCTLSMSR union. */
1093typedef const VMXCTLSMSR *PCVMXCTLSMSR;
1094
1095/**
1096 * VMX MSRs.
1097 * @remarks Although treated as a plain-old data (POD) in several places, please
1098 * update HMVmxGetHostMsr() if new MSRs are added here.
1099 */
1100typedef struct VMXMSRS
1101{
1102 uint64_t u64FeatCtrl;
1103 uint64_t u64Basic;
1104 VMXCTLSMSR PinCtls;
1105 VMXCTLSMSR ProcCtls;
1106 VMXCTLSMSR ProcCtls2;
1107 VMXCTLSMSR ExitCtls;
1108 VMXCTLSMSR EntryCtls;
1109 VMXCTLSMSR TruePinCtls;
1110 VMXCTLSMSR TrueProcCtls;
1111 VMXCTLSMSR TrueEntryCtls;
1112 VMXCTLSMSR TrueExitCtls;
1113 uint64_t u64Misc;
1114 uint64_t u64Cr0Fixed0;
1115 uint64_t u64Cr0Fixed1;
1116 uint64_t u64Cr4Fixed0;
1117 uint64_t u64Cr4Fixed1;
1118 uint64_t u64VmcsEnum;
1119 uint64_t u64VmFunc;
1120 uint64_t u64EptVpidCaps;
1121 uint64_t a_u64Reserved[2];
1122} VMXMSRS;
1123AssertCompileSizeAlignment(VMXMSRS, 8);
1124AssertCompileSize(VMXMSRS, 168);
1125/** Pointer to a VMXMSRS struct. */
1126typedef VMXMSRS *PVMXMSRS;
1127/** Pointer to a const VMXMSRS struct. */
1128typedef const VMXMSRS *PCVMXMSRS;
1129
1130
1131/** @name VMX Basic Exit Reasons.
1132 * @{
1133 */
1134/** -1 Invalid exit code */
1135#define VMX_EXIT_INVALID (-1)
1136/** 0 Exception or non-maskable interrupt (NMI). */
1137#define VMX_EXIT_XCPT_OR_NMI 0
1138/** 1 External interrupt. */
1139#define VMX_EXIT_EXT_INT 1
1140/** 2 Triple fault. */
1141#define VMX_EXIT_TRIPLE_FAULT 2
1142/** 3 INIT signal. */
1143#define VMX_EXIT_INIT_SIGNAL 3
1144/** 4 Start-up IPI (SIPI). */
1145#define VMX_EXIT_SIPI 4
1146/** 5 I/O system-management interrupt (SMI). */
1147#define VMX_EXIT_IO_SMI 5
1148/** 6 Other SMI. */
1149#define VMX_EXIT_SMI 6
1150/** 7 Interrupt window exiting. */
1151#define VMX_EXIT_INT_WINDOW 7
1152/** 8 NMI window exiting. */
1153#define VMX_EXIT_NMI_WINDOW 8
1154/** 9 Task switch. */
1155#define VMX_EXIT_TASK_SWITCH 9
1156/** 10 Guest software attempted to execute CPUID. */
1157#define VMX_EXIT_CPUID 10
1158/** 11 Guest software attempted to execute GETSEC. */
1159#define VMX_EXIT_GETSEC 11
1160/** 12 Guest software attempted to execute HLT. */
1161#define VMX_EXIT_HLT 12
1162/** 13 Guest software attempted to execute INVD. */
1163#define VMX_EXIT_INVD 13
1164/** 14 Guest software attempted to execute INVLPG. */
1165#define VMX_EXIT_INVLPG 14
1166/** 15 Guest software attempted to execute RDPMC. */
1167#define VMX_EXIT_RDPMC 15
1168/** 16 Guest software attempted to execute RDTSC. */
1169#define VMX_EXIT_RDTSC 16
1170/** 17 Guest software attempted to execute RSM in SMM. */
1171#define VMX_EXIT_RSM 17
1172/** 18 Guest software executed VMCALL. */
1173#define VMX_EXIT_VMCALL 18
1174/** 19 Guest software executed VMCLEAR. */
1175#define VMX_EXIT_VMCLEAR 19
1176/** 20 Guest software executed VMLAUNCH. */
1177#define VMX_EXIT_VMLAUNCH 20
1178/** 21 Guest software executed VMPTRLD. */
1179#define VMX_EXIT_VMPTRLD 21
1180/** 22 Guest software executed VMPTRST. */
1181#define VMX_EXIT_VMPTRST 22
1182/** 23 Guest software executed VMREAD. */
1183#define VMX_EXIT_VMREAD 23
1184/** 24 Guest software executed VMRESUME. */
1185#define VMX_EXIT_VMRESUME 24
1186/** 25 Guest software executed VMWRITE. */
1187#define VMX_EXIT_VMWRITE 25
1188/** 26 Guest software executed VMXOFF. */
1189#define VMX_EXIT_VMXOFF 26
1190/** 27 Guest software executed VMXON. */
1191#define VMX_EXIT_VMXON 27
1192/** 28 Control-register accesses. */
1193#define VMX_EXIT_MOV_CRX 28
1194/** 29 Debug-register accesses. */
1195#define VMX_EXIT_MOV_DRX 29
1196/** 30 I/O instruction. */
1197#define VMX_EXIT_IO_INSTR 30
1198/** 31 RDMSR. Guest software attempted to execute RDMSR. */
1199#define VMX_EXIT_RDMSR 31
1200/** 32 WRMSR. Guest software attempted to execute WRMSR. */
1201#define VMX_EXIT_WRMSR 32
1202/** 33 VM-entry failure due to invalid guest state. */
1203#define VMX_EXIT_ERR_INVALID_GUEST_STATE 33
1204/** 34 VM-entry failure due to MSR loading. */
1205#define VMX_EXIT_ERR_MSR_LOAD 34
1206/** 36 Guest software executed MWAIT. */
1207#define VMX_EXIT_MWAIT 36
1208/** 37 VM-exit due to monitor trap flag. */
1209#define VMX_EXIT_MTF 37
1210/** 39 Guest software attempted to execute MONITOR. */
1211#define VMX_EXIT_MONITOR 39
1212/** 40 Guest software attempted to execute PAUSE. */
1213#define VMX_EXIT_PAUSE 40
1214/** 41 VM-entry failure due to machine-check. */
1215#define VMX_EXIT_ERR_MACHINE_CHECK 41
1216/** 43 TPR below threshold. Guest software executed MOV to CR8. */
1217#define VMX_EXIT_TPR_BELOW_THRESHOLD 43
1218/** 44 APIC access. Guest software attempted to access memory at a physical
1219 * address on the APIC-access page. */
1220#define VMX_EXIT_APIC_ACCESS 44
1221/** 45 Virtualized EOI. EOI virtualization was performed for a virtual
1222 * interrupt whose vector indexed a bit set in the EOI-exit bitmap. */
1223#define VMX_EXIT_VIRTUALIZED_EOI 45
1224/** 46 Access to GDTR or IDTR. Guest software attempted to execute LGDT, LIDT,
1225 * SGDT, or SIDT. */
1226#define VMX_EXIT_GDTR_IDTR_ACCESS 46
1227/** 47 Access to LDTR or TR. Guest software attempted to execute LLDT, LTR,
1228 * SLDT, or STR. */
1229#define VMX_EXIT_LDTR_TR_ACCESS 47
1230/** 48 EPT violation. An attempt to access memory with a guest-physical address
1231 * was disallowed by the configuration of the EPT paging structures. */
1232#define VMX_EXIT_EPT_VIOLATION 48
1233/** 49 EPT misconfiguration. An attempt to access memory with a guest-physical
1234 * address encountered a misconfigured EPT paging-structure entry. */
1235#define VMX_EXIT_EPT_MISCONFIG 49
1236/** 50 INVEPT. Guest software attempted to execute INVEPT. */
1237#define VMX_EXIT_INVEPT 50
1238/** 51 RDTSCP. Guest software attempted to execute RDTSCP. */
1239#define VMX_EXIT_RDTSCP 51
1240/** 52 VMX-preemption timer expired. The preemption timer counted down to zero. */
1241#define VMX_EXIT_PREEMPT_TIMER 52
1242/** 53 INVVPID. Guest software attempted to execute INVVPID. */
1243#define VMX_EXIT_INVVPID 53
1244/** 54 WBINVD. Guest software attempted to execute WBINVD. */
1245#define VMX_EXIT_WBINVD 54
1246/** 55 XSETBV. Guest software attempted to execute XSETBV. */
1247#define VMX_EXIT_XSETBV 55
1248/** 56 APIC write. Guest completed write to virtual-APIC. */
1249#define VMX_EXIT_APIC_WRITE 56
1250/** 57 RDRAND. Guest software attempted to execute RDRAND. */
1251#define VMX_EXIT_RDRAND 57
1252/** 58 INVPCID. Guest software attempted to execute INVPCID. */
1253#define VMX_EXIT_INVPCID 58
1254/** 59 VMFUNC. Guest software attempted to execute VMFUNC. */
1255#define VMX_EXIT_VMFUNC 59
1256/** 60 ENCLS. Guest software attempted to execute ENCLS. */
1257#define VMX_EXIT_ENCLS 60
1258/** 61 - RDSEED - Guest software attempted to executed RDSEED and exiting was
1259 * enabled. */
1260#define VMX_EXIT_RDSEED 61
1261/** 62 - Page-modification log full. */
1262#define VMX_EXIT_PML_FULL 62
1263/** 63 - XSAVES - Guest software attempted to executed XSAVES and exiting was
1264 * enabled (XSAVES/XRSTORS was enabled too, of course). */
1265#define VMX_EXIT_XSAVES 63
1266/** 63 - XRSTORS - Guest software attempted to executed XRSTORS and exiting
1267 * was enabled (XSAVES/XRSTORS was enabled too, of course). */
1268#define VMX_EXIT_XRSTORS 64
1269/** The maximum exit value (inclusive). */
1270#define VMX_EXIT_MAX (VMX_EXIT_XRSTORS)
1271/** @} */
1272
1273
1274/** @name VM Instruction Errors.
1275 * See Intel spec. "30.4 VM Instruction Error Numbers"
1276 * @{
1277 */
1278typedef enum
1279{
1280 /** VMCALL executed in VMX root operation. */
1281 VMXINSTRERR_VMCALL_VMXROOTMODE = 1,
1282 /** VMCLEAR with invalid physical address. */
1283 VMXINSTRERR_VMCLEAR_INVALID_PHYSADDR = 2,
1284 /** VMCLEAR with VMXON pointer. */
1285 VMXINSTRERR_VMCLEAR_VMXON_PTR = 3,
1286 /** VMLAUNCH with non-clear VMCS. */
1287 VMXINSTRERR_VMLAUNCH_NON_CLEAR_VMCS = 4,
1288 /** VMRESUME with non-launched VMCS. */
1289 VMXINSTRERR_VMRESUME_NON_LAUNCHED_VMCS = 5,
1290 /** VMRESUME after VMXOFF (VMXOFF and VMXON between VMLAUNCH and VMRESUME). */
1291 VMXINSTRERR_VMRESUME_AFTER_VMXOFF = 6,
1292 /** VM-entry with invalid control field(s). */
1293 VMXINSTRERR_VMENTRY_INVALID_CTLS = 7,
1294 /** VM-entry with invalid host-state field(s). */
1295 VMXINSTRERR_VMENTRY_INVALID_HOST_STATE = 8,
1296 /** VMPTRLD with invalid physical address. */
1297 VMXINSTRERR_VMPTRLD_INVALID_PHYSADDR = 9,
1298 /** VMPTRLD with VMXON pointer. */
1299 VMXINSTRERR_VMPTRLD_VMXON_PTR = 10,
1300 /** VMPTRLD with incorrect VMCS revision identifier. */
1301 VMXINSTRERR_VMPTRLD_INCORRECT_VMCS_REV = 11,
1302 /** VMREAD from unsupported VMCS component. */
1303 VMXINSTRERR_VMREAD_INVALID_COMPONENT = 12,
1304 /** VMWRITE to unsupported VMCS component. */
1305 VMXINSTRERR_VMWRITE_INVALID_COMPONENT = 12,
1306 /** VMWRITE to read-only VMCS component. */
1307 VMXINSTRERR_VMWRITE_RO_COMPONENT = 13,
1308 /** VMXON executed in VMX root operation. */
1309 VMXINSTRERR_VMXON_IN_VMXROOTMODE = 15,
1310 /** VM-entry with invalid executive-VMCS pointer. */
1311 VMXINSTRERR_VMENTRY_EXEC_VMCS_INVALID_PTR = 16,
1312 /** VM-entry with non-launched executive VMCS. */
1313 VMXINSTRERR_VMENTRY_EXEC_VMCS_NON_LAUNCHED = 17,
1314 /** VM-entry with executive-VMCS pointer not VMXON pointer. */
1315 VMXINSTRERR_VMENTRY_EXEC_VMCS_PTR = 18,
1316 /** VMCALL with non-clear VMCS. */
1317 VMXINSTRERR_VMCALL_NON_CLEAR_VMCS = 19,
1318 /** VMCALL with invalid VM-exit control fields. */
1319 VMXINSTRERR_VMCALL_INVALID_EXITCTLS = 20,
1320 /** VMCALL with incorrect MSEG revision identifier. */
1321 VMXINSTRERR_VMCALL_INVALID_MSEG_ID = 22,
1322 /** VMXOFF under dual-monitor treatment of SMIs and SMM. */
1323 VMXINSTRERR_VMXOFF_DUAL_MON = 23,
1324 /** VMCALL with invalid SMM-monitor features. */
1325 VMXINSTRERR_VMCALL_INVALID_SMMCTLS = 24,
1326 /** VM-entry with invalid VM-execution control fields in executive VMCS. */
1327 VMXINSTRERR_VMENTRY_EXEC_VMCS_INVALID_CTLS = 25,
1328 /** VM-entry with events blocked by MOV SS. */
1329 VMXINSTRERR_VMENTRY_BLOCK_MOVSS = 26,
1330 /** Invalid operand to INVEPT/INVVPID. */
1331 VMXINSTRERR_INVEPT_INVVPID_INVALID_OPERAND = 28
1332} VMXINSTRERR;
1333/** @} */
1334
1335
1336/** @name VMX MSR - Basic VMX information.
1337 * @{
1338 */
1339/** VMCS (and related regions) memory type - Uncacheable. */
1340#define VMX_BASIC_MEM_TYPE_UC 0
1341/** VMCS (and related regions) memory type - Write back. */
1342#define VMX_BASIC_MEM_TYPE_WB 6
1343
1344/** Bit fields for MSR_IA32_VMX_BASIC. */
1345/** VMCS revision identifier used by the processor. */
1346#define VMX_BF_BASIC_VMCS_ID_SHIFT 0
1347#define VMX_BF_BASIC_VMCS_ID_MASK UINT64_C(0x000000007fffffff)
1348/** Bit 31 is reserved and RAZ. */
1349#define VMX_BF_BASIC_RSVD_32_SHIFT 31
1350#define VMX_BF_BASIC_RSVD_32_MASK UINT64_C(0x0000000080000000)
1351/** VMCS size in bytes. */
1352#define VMX_BF_BASIC_VMCS_SIZE_SHIFT 32
1353#define VMX_BF_BASIC_VMCS_SIZE_MASK UINT64_C(0x00001fff00000000)
1354/** Bits 45:47 are reserved. */
1355#define VMX_BF_BASIC_RSVD_45_47_SHIFT 45
1356#define VMX_BF_BASIC_RSVD_45_47_MASK UINT64_C(0x0000e00000000000)
1357/** Width of physical addresses used for the VMCS and associated memory regions
1358 * (always 0 on CPUs that support Intel 64 architecture). */
1359#define VMX_BF_BASIC_PHYSADDR_WIDTH_SHIFT 48
1360#define VMX_BF_BASIC_PHYSADDR_WIDTH_MASK UINT64_C(0x0001000000000000)
1361/** Dual-monitor treatment of SMI and SMM supported. */
1362#define VMX_BF_BASIC_DUAL_MON_SHIFT 49
1363#define VMX_BF_BASIC_DUAL_MON_MASK UINT64_C(0x0002000000000000)
1364/** Memory type that must be used for the VMCS and associated memory regions. */
1365#define VMX_BF_BASIC_VMCS_MEM_TYPE_SHIFT 50
1366#define VMX_BF_BASIC_VMCS_MEM_TYPE_MASK UINT64_C(0x003c000000000000)
1367/** VM-exit instruction information for INS/OUTS. */
1368#define VMX_BF_BASIC_VMCS_INS_OUTS_SHIFT 54
1369#define VMX_BF_BASIC_VMCS_INS_OUTS_MASK UINT64_C(0x0040000000000000)
1370/** Whether 'true' VMX controls MSRs are supported for handling of default1 class
1371 * bits in VMX control MSRs. */
1372#define VMX_BF_BASIC_TRUE_CTLS_SHIFT 55
1373#define VMX_BF_BASIC_TRUE_CTLS_MASK UINT64_C(0x0080000000000000)
1374/** Bits 56:63 are reserved and RAZ. */
1375#define VMX_BF_BASIC_RSVD_56_63_SHIFT 56
1376#define VMX_BF_BASIC_RSVD_56_63_MASK UINT64_C(0xff00000000000000)
1377RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_BASIC_, UINT64_C(0), UINT64_MAX,
1378 (VMCS_ID, RSVD_32, VMCS_SIZE, RSVD_45_47, PHYSADDR_WIDTH, DUAL_MON, VMCS_MEM_TYPE,
1379 VMCS_INS_OUTS, TRUE_CTLS, RSVD_56_63));
1380/** @} */
1381
1382
1383/** @name VMX MSR - Miscellaneous data.
1384 * Bit fields for MSR_IA32_VMX_MISC.
1385 * @{
1386 */
1387/** Whether VM-exit stores EFER.LMA into the "IA32e mode guest" field. */
1388#define VMX_MISC_EXIT_STORE_EFER_LMA RT_BIT(5)
1389/** Whether VMWRITE to any valid VMCS field incl. read-only fields, otherwise
1390 * VMWRITE cannot modify read-only VM-exit information fields. */
1391#define VMX_MISC_VMWRITE_ALL RT_BIT(29)
1392/** Whether VM-entry can inject software interrupts, INT1 (ICEBP) with 0-length
1393 * instructions. */
1394#define VMX_MISC_ENTRY_INJECT_SOFT_INT RT_BIT(30)
1395/** Maximum number of MSRs in the auto-load/store MSR areas, (n+1) * 512. */
1396#define VMX_MISC_MAX_MSRS(a_MiscMsr) (512 * (RT_BF_GET((a_MiscMsr), VMX_BF_MISC_MAX_MSRS) + 1))
1397/** Maximum CR3-target count supported by the CPU. */
1398#define VMX_MISC_CR3_TARGET_COUNT(a_MiscMsr) (((a) >> 16) & 0xff)
1399/** Relationship between the preemption timer and tsc. */
1400#define VMX_BF_MISC_PREEMPT_TIMER_TSC_SHIFT 0
1401#define VMX_BF_MISC_PREEMPT_TIMER_TSC_MASK UINT64_C(0x000000000000001f)
1402/** Whether VM-exit stores EFER.LMA into the "IA32e mode guest" field. */
1403#define VMX_BF_MISC_EXIT_STORE_EFER_LMA_SHIFT 5
1404#define VMX_BF_MISC_EXIT_STORE_EFER_LMA_MASK UINT64_C(0x0000000000000020)
1405/** Activity states supported by the implementation. */
1406#define VMX_BF_MISC_ACTIVITY_STATES_SHIFT 6
1407#define VMX_BF_MISC_ACTIVITY_STATES_MASK UINT64_C(0x00000000000001c0)
1408/** Bits 9:13 is reserved and RAZ. */
1409#define VMX_BF_MISC_RSVD_9_13_SHIFT 9
1410#define VMX_BF_MISC_RSVD_9_13_MASK UINT64_C(0x0000000000003e00)
1411/** Whether Intel PT (Processor Trace) can be used in VMX operation. */
1412#define VMX_BF_MISC_PT_SHIFT 14
1413#define VMX_BF_MISC_PT_MASK UINT64_C(0x0000000000004000)
1414/** Whether RDMSR can be used to read IA32_SMBASE MSR in SMM. */
1415#define VMX_BF_MISC_SMM_READ_SMBASE_MSR_SHIFT 15
1416#define VMX_BF_MISC_SMM_READ_SMBASE_MSR_MASK UINT64_C(0x0000000000008000)
1417/** Number of CR3 target values supported by the processor. (0-256) */
1418#define VMX_BF_MISC_CR3_TARGET_SHIFT 16
1419#define VMX_BF_MISC_CR3_TARGET_MASK UINT64_C(0x0000000001ff0000)
1420/** Maximum number of MSRs in the VMCS. */
1421#define VMX_BF_MISC_MAX_MSRS_SHIFT 25
1422#define VMX_BF_MISC_MAX_MSRS_MASK UINT64_C(0x000000000e000000)
1423/** Whether IA32_SMM_MONITOR_CTL MSR can be modified to allow VMXOFF to block
1424 * SMIs. */
1425#define VMX_BF_MISC_VMXOFF_BLOCK_SMI_SHIFT 28
1426#define VMX_BF_MISC_VMXOFF_BLOCK_SMI_MASK UINT64_C(0x0000000010000000)
1427/** Whether VMWRITE to any valid VMCS field incl. read-only fields, otherwise
1428 * VMWRITE cannot modify read-only VM-exit information fields. */
1429#define VMX_BF_MISC_VMWRITE_ALL_SHIFT 29
1430#define VMX_BF_MISC_VMWRITE_ALL_MASK UINT64_C(0x0000000020000000)
1431/** Whether VM-entry can inject software interrupts, INT1 (ICEBP) with 0-length
1432 * instructions. */
1433#define VMX_BF_MISC_ENTRY_INJECT_SOFT_INT_SHIFT 30
1434#define VMX_BF_MISC_ENTRY_INJECT_SOFT_INT_MASK UINT64_C(0x0000000040000000)
1435/** Bit 31 is reserved and RAZ. */
1436#define VMX_BF_MISC_RSVD_31_SHIFT 31
1437#define VMX_BF_MISC_RSVD_31_MASK UINT64_C(0x0000000080000000)
1438/** 32-bit MSEG revision ID used by the processor. */
1439#define VMX_BF_MISC_MSEG_ID_SHIFT 32
1440#define VMX_BF_MISC_MSEG_ID_MASK UINT64_C(0xffffffff00000000)
1441RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_MISC_, UINT64_C(0), UINT64_MAX,
1442 (PREEMPT_TIMER_TSC, EXIT_STORE_EFER_LMA, ACTIVITY_STATES, RSVD_9_13, PT, SMM_READ_SMBASE_MSR,
1443 CR3_TARGET, MAX_MSRS, VMXOFF_BLOCK_SMI, VMWRITE_ALL, ENTRY_INJECT_SOFT_INT, RSVD_31, MSEG_ID));
1444/** @} */
1445
1446/** @name VMX MSR - VMCS enumeration.
1447 * Bit fields for MSR_IA32_VMX_VMCS_ENUM.
1448 * @{
1449 */
1450/** Bit 0 is reserved and RAZ. */
1451#define VMX_BF_VMCS_ENUM_RSVD_0_SHIFT 0
1452#define VMX_BF_VMCS_ENUM_RSVD_0_MASK UINT64_C(0x0000000000000001)
1453/** Highest index value used in VMCS field encoding. */
1454#define VMX_BF_VMCS_ENUM_HIGHEST_IDX_SHIFT 1
1455#define VMX_BF_VMCS_ENUM_HIGHEST_IDX_MASK UINT64_C(0x00000000000003fe)
1456/** Bit 10:63 is reserved and RAZ. */
1457#define VMX_BF_VMCS_ENUM_RSVD_10_63_SHIFT 10
1458#define VMX_BF_VMCS_ENUM_RSVD_10_63_MASK UINT64_C(0xfffffffffffffc00)
1459RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMCS_ENUM_, UINT64_C(0), UINT64_MAX,
1460 (RSVD_0, HIGHEST_IDX, RSVD_10_63));
1461/** @} */
1462
1463
1464/** @name VMX MSR - VM Functions.
1465 * Bit fields for MSR_IA32_VMX_VMFUNC.
1466 * @{
1467 */
1468/** EPTP-switching function changes the value of the EPTP to one chosen from the EPTP list. */
1469#define VMX_BF_VMFUNC_EPTP_SWITCHING_SHIFT 0
1470#define VMX_BF_VMFUNC_EPTP_SWITCHING_MASK UINT64_C(0x0000000000000001)
1471/** Bits 1:63 are reserved and RAZ. */
1472#define VMX_BF_VMFUNC_RSVD_1_63_SHIFT 1
1473#define VMX_BF_VMFUNC_RSVD_1_63_MASK UINT64_C(0xfffffffffffffffe)
1474RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMFUNC_, UINT64_C(0), UINT64_MAX,
1475 (EPTP_SWITCHING, RSVD_1_63));
1476/** @} */
1477
1478
1479/** @name VMX MSR - EPT/VPID capabilities.
1480 * @{
1481 */
1482#define MSR_IA32_VMX_EPT_VPID_CAP_RWX_X_ONLY RT_BIT_64(0)
1483#define MSR_IA32_VMX_EPT_VPID_CAP_PAGE_WALK_LENGTH_4 RT_BIT_64(6)
1484#define MSR_IA32_VMX_EPT_VPID_CAP_EMT_UC RT_BIT_64(8)
1485#define MSR_IA32_VMX_EPT_VPID_CAP_EMT_WB RT_BIT_64(14)
1486#define MSR_IA32_VMX_EPT_VPID_CAP_PDE_2M RT_BIT_64(16)
1487#define MSR_IA32_VMX_EPT_VPID_CAP_PDPTE_1G RT_BIT_64(17)
1488#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT RT_BIT_64(20)
1489#define MSR_IA32_VMX_EPT_VPID_CAP_EPT_ACCESS_DIRTY RT_BIT_64(21)
1490#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT_SINGLE_CONTEXT RT_BIT_64(25)
1491#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT_ALL_CONTEXTS RT_BIT_64(26)
1492#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID RT_BIT_64(32)
1493#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_INDIV_ADDR RT_BIT_64(40)
1494#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT RT_BIT_64(41)
1495#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_ALL_CONTEXTS RT_BIT_64(42)
1496#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT_RETAIN_GLOBALS RT_BIT_64(43)
1497/** @} */
1498
1499
1500/** @name Extended Page Table Pointer (EPTP)
1501 * @{
1502 */
1503/** Uncachable EPT paging structure memory type. */
1504#define VMX_EPT_MEMTYPE_UC 0
1505/** Write-back EPT paging structure memory type. */
1506#define VMX_EPT_MEMTYPE_WB 6
1507/** Shift value to get the EPT page walk length (bits 5-3) */
1508#define VMX_EPT_PAGE_WALK_LENGTH_SHIFT 3
1509/** Mask value to get the EPT page walk length (bits 5-3) */
1510#define VMX_EPT_PAGE_WALK_LENGTH_MASK 7
1511/** Default EPT page-walk length (1 less than the actual EPT page-walk
1512 * length) */
1513#define VMX_EPT_PAGE_WALK_LENGTH_DEFAULT 3
1514/** @} */
1515
1516
1517/** @name VMCS field encoding: 16-bit guest fields.
1518 * @{
1519 */
1520#define VMX_VMCS16_VPID 0x0000
1521#define VMX_VMCS16_POSTED_INT_NOTIFY_VECTOR 0x0002
1522#define VMX_VMCS16_EPTP_INDEX 0x0004
1523#define VMX_VMCS16_GUEST_ES_SEL 0x0800
1524#define VMX_VMCS16_GUEST_CS_SEL 0x0802
1525#define VMX_VMCS16_GUEST_SS_SEL 0x0804
1526#define VMX_VMCS16_GUEST_DS_SEL 0x0806
1527#define VMX_VMCS16_GUEST_FS_SEL 0x0808
1528#define VMX_VMCS16_GUEST_GS_SEL 0x080a
1529#define VMX_VMCS16_GUEST_LDTR_SEL 0x080c
1530#define VMX_VMCS16_GUEST_TR_SEL 0x080e
1531#define VMX_VMCS16_GUEST_INTR_STATUS 0x0810
1532#define VMX_VMCS16_GUEST_PML_INDEX 0x0812
1533/** @} */
1534
1535
1536/** @name VMCS field encoding: 16-bits host fields.
1537 * @{
1538 */
1539#define VMX_VMCS16_HOST_ES_SEL 0x0c00
1540#define VMX_VMCS16_HOST_CS_SEL 0x0c02
1541#define VMX_VMCS16_HOST_SS_SEL 0x0c04
1542#define VMX_VMCS16_HOST_DS_SEL 0x0c06
1543#define VMX_VMCS16_HOST_FS_SEL 0x0c08
1544#define VMX_VMCS16_HOST_GS_SEL 0x0c0a
1545#define VMX_VMCS16_HOST_TR_SEL 0x0c0c
1546/** @} */
1547
1548
1549/** @name VMCS field encoding: 64-bit control fields.
1550 * @{
1551 */
1552#define VMX_VMCS64_CTRL_IO_BITMAP_A_FULL 0x2000
1553#define VMX_VMCS64_CTRL_IO_BITMAP_A_HIGH 0x2001
1554#define VMX_VMCS64_CTRL_IO_BITMAP_B_FULL 0x2002
1555#define VMX_VMCS64_CTRL_IO_BITMAP_B_HIGH 0x2003
1556#define VMX_VMCS64_CTRL_MSR_BITMAP_FULL 0x2004
1557#define VMX_VMCS64_CTRL_MSR_BITMAP_HIGH 0x2005
1558#define VMX_VMCS64_CTRL_EXIT_MSR_STORE_FULL 0x2006
1559#define VMX_VMCS64_CTRL_EXIT_MSR_STORE_HIGH 0x2007
1560#define VMX_VMCS64_CTRL_EXIT_MSR_LOAD_FULL 0x2008
1561#define VMX_VMCS64_CTRL_EXIT_MSR_LOAD_HIGH 0x2009
1562#define VMX_VMCS64_CTRL_ENTRY_MSR_LOAD_FULL 0x200a
1563#define VMX_VMCS64_CTRL_ENTRY_MSR_LOAD_HIGH 0x200b
1564#define VMX_VMCS64_CTRL_EXEC_VMCS_PTR_FULL 0x200c
1565#define VMX_VMCS64_CTRL_EXEC_VMCS_PTR_HIGH 0x200d
1566#define VMX_VMCS64_CTRL_EXEC_PML_ADDR_FULL 0x200e
1567#define VMX_VMCS64_CTRL_EXEC_PML_ADDR_HIGH 0x200f
1568#define VMX_VMCS64_CTRL_TSC_OFFSET_FULL 0x2010
1569#define VMX_VMCS64_CTRL_TSC_OFFSET_HIGH 0x2011
1570#define VMX_VMCS64_CTRL_VIRT_APIC_PAGEADDR_FULL 0x2012
1571#define VMX_VMCS64_CTRL_VIRT_APIC_PAGEADDR_HIGH 0x2013
1572#define VMX_VMCS64_CTRL_APIC_ACCESSADDR_FULL 0x2014
1573#define VMX_VMCS64_CTRL_APIC_ACCESSADDR_HIGH 0x2015
1574#define VMX_VMCS64_CTRL_POSTED_INTR_DESC_FULL 0x2016
1575#define VMX_VMCS64_CTRL_POSTED_INTR_DESC_HIGH 0x2017
1576#define VMX_VMCS64_CTRL_VMFUNC_CTRLS_FULL 0x2018
1577#define VMX_VMCS64_CTRL_VMFUNC_CTRLS_HIGH 0x2019
1578#define VMX_VMCS64_CTRL_EPTP_FULL 0x201a
1579#define VMX_VMCS64_CTRL_EPTP_HIGH 0x201b
1580#define VMX_VMCS64_CTRL_EOI_BITMAP_0_FULL 0x201c
1581#define VMX_VMCS64_CTRL_EOI_BITMAP_0_HIGH 0x201d
1582#define VMX_VMCS64_CTRL_EOI_BITMAP_1_FULL 0x201e
1583#define VMX_VMCS64_CTRL_EOI_BITMAP_1_HIGH 0x201f
1584#define VMX_VMCS64_CTRL_EOI_BITMAP_2_FULL 0x2020
1585#define VMX_VMCS64_CTRL_EOI_BITMAP_2_HIGH 0x2021
1586#define VMX_VMCS64_CTRL_EOI_BITMAP_3_FULL 0x2022
1587#define VMX_VMCS64_CTRL_EOI_BITMAP_3_HIGH 0x2023
1588#define VMX_VMCS64_CTRL_EPTP_LIST_FULL 0x2024
1589#define VMX_VMCS64_CTRL_EPTP_LIST_HIGH 0x2025
1590#define VMX_VMCS64_CTRL_VMREAD_BITMAP_FULL 0x2026
1591#define VMX_VMCS64_CTRL_VMREAD_BITMAP_HIGH 0x2027
1592#define VMX_VMCS64_CTRL_VMWRITE_BITMAP_FULL 0x2028
1593#define VMX_VMCS64_CTRL_VMWRITE_BITMAP_HIGH 0x2029
1594#define VMX_VMCS64_CTRL_VIRTXCPT_INFO_ADDR_FULL 0x202a
1595#define VMX_VMCS64_CTRL_VIRTXCPT_INFO_ADDR_HIGH 0x202b
1596#define VMX_VMCS64_CTRL_XSS_EXITING_BITMAP_FULL 0x202c
1597#define VMX_VMCS64_CTRL_XSS_EXITING_BITMAP_HIGH 0x202d
1598#define VMX_VMCS64_CTRL_ENCLS_EXITING_BITMAP_FULL 0x202e
1599#define VMX_VMCS64_CTRL_ENCLS_EXITING_BITMAP_HIGH 0x202f
1600#define VMX_VMCS64_CTRL_TSC_MULTIPLIER_FULL 0x2032
1601#define VMX_VMCS64_CTRL_TSC_MULTIPLIER_HIGH 0x2033
1602/** @} */
1603
1604
1605/** @name VMCS field encoding: 64-bit read-only data fields.
1606 * @{
1607 */
1608#define VMX_VMCS64_RO_GUEST_PHYS_ADDR_FULL 0x2400
1609#define VMX_VMCS64_RO_GUEST_PHYS_ADDR_HIGH 0x2401
1610/** @} */
1611
1612
1613/** @name VMCS field encoding: 64-bit guest fields.
1614 * @{
1615 */
1616#define VMX_VMCS64_GUEST_VMCS_LINK_PTR_FULL 0x2800
1617#define VMX_VMCS64_GUEST_VMCS_LINK_PTR_HIGH 0x2801
1618#define VMX_VMCS64_GUEST_DEBUGCTL_FULL 0x2802
1619#define VMX_VMCS64_GUEST_DEBUGCTL_HIGH 0x2803
1620#define VMX_VMCS64_GUEST_PAT_FULL 0x2804
1621#define VMX_VMCS64_GUEST_PAT_HIGH 0x2805
1622#define VMX_VMCS64_GUEST_EFER_FULL 0x2806
1623#define VMX_VMCS64_GUEST_EFER_HIGH 0x2807
1624#define VMX_VMCS64_GUEST_PERF_GLOBAL_CTRL_FULL 0x2808
1625#define VMX_VMCS64_GUEST_PERF_GLOBAL_CTRL_HIGH 0x2809
1626#define VMX_VMCS64_GUEST_PDPTE0_FULL 0x280a
1627#define VMX_VMCS64_GUEST_PDPTE0_HIGH 0x280b
1628#define VMX_VMCS64_GUEST_PDPTE1_FULL 0x280c
1629#define VMX_VMCS64_GUEST_PDPTE1_HIGH 0x280d
1630#define VMX_VMCS64_GUEST_PDPTE2_FULL 0x280e
1631#define VMX_VMCS64_GUEST_PDPTE2_HIGH 0x280f
1632#define VMX_VMCS64_GUEST_PDPTE3_FULL 0x2810
1633#define VMX_VMCS64_GUEST_PDPTE3_HIGH 0x2811
1634#define VMX_VMCS64_GUEST_BNDCFGS_FULL 0x2812
1635#define VMX_VMCS64_GUEST_BNDCFGS_HIGH 0x2813
1636/** @} */
1637
1638
1639/** @name VMCS field encoding: 64-bit host fields.
1640 * @{
1641 */
1642#define VMX_VMCS64_HOST_PAT_FULL 0x2c00
1643#define VMX_VMCS64_HOST_PAT_HIGH 0x2c01
1644#define VMX_VMCS64_HOST_EFER_FULL 0x2c02
1645#define VMX_VMCS64_HOST_EFER_HIGH 0x2c03
1646#define VMX_VMCS64_HOST_PERF_GLOBAL_CTRL_FULL 0x2c04
1647#define VMX_VMCS64_HOST_PERF_GLOBAL_CTRL_HIGH 0x2c05
1648/** @} */
1649
1650
1651/** @name VMCS field encoding: 32-bit control fields.
1652 * @{
1653 */
1654#define VMX_VMCS32_CTRL_PIN_EXEC 0x4000
1655#define VMX_VMCS32_CTRL_PROC_EXEC 0x4002
1656#define VMX_VMCS32_CTRL_EXCEPTION_BITMAP 0x4004
1657#define VMX_VMCS32_CTRL_PAGEFAULT_ERROR_MASK 0x4006
1658#define VMX_VMCS32_CTRL_PAGEFAULT_ERROR_MATCH 0x4008
1659#define VMX_VMCS32_CTRL_CR3_TARGET_COUNT 0x400a
1660#define VMX_VMCS32_CTRL_EXIT 0x400c
1661#define VMX_VMCS32_CTRL_EXIT_MSR_STORE_COUNT 0x400e
1662#define VMX_VMCS32_CTRL_EXIT_MSR_LOAD_COUNT 0x4010
1663#define VMX_VMCS32_CTRL_ENTRY 0x4012
1664#define VMX_VMCS32_CTRL_ENTRY_MSR_LOAD_COUNT 0x4014
1665#define VMX_VMCS32_CTRL_ENTRY_INTERRUPTION_INFO 0x4016
1666#define VMX_VMCS32_CTRL_ENTRY_EXCEPTION_ERRCODE 0x4018
1667#define VMX_VMCS32_CTRL_ENTRY_INSTR_LENGTH 0x401a
1668#define VMX_VMCS32_CTRL_TPR_THRESHOLD 0x401c
1669#define VMX_VMCS32_CTRL_PROC_EXEC2 0x401e
1670#define VMX_VMCS32_CTRL_PLE_GAP 0x4020
1671#define VMX_VMCS32_CTRL_PLE_WINDOW 0x4022
1672/** @} */
1673
1674
1675/** @name VMCS field encoding: 32-bits read-only fields.
1676 * @{
1677 */
1678#define VMX_VMCS32_RO_VM_INSTR_ERROR 0x4400
1679#define VMX_VMCS32_RO_EXIT_REASON 0x4402
1680#define VMX_VMCS32_RO_EXIT_INTERRUPTION_INFO 0x4404
1681#define VMX_VMCS32_RO_EXIT_INTERRUPTION_ERROR_CODE 0x4406
1682#define VMX_VMCS32_RO_IDT_VECTORING_INFO 0x4408
1683#define VMX_VMCS32_RO_IDT_VECTORING_ERROR_CODE 0x440a
1684#define VMX_VMCS32_RO_EXIT_INSTR_LENGTH 0x440c
1685#define VMX_VMCS32_RO_EXIT_INSTR_INFO 0x440e
1686/** @} */
1687
1688
1689/** @name VMCS field encoding: 32-bit guest-state fields.
1690 * @{
1691 */
1692#define VMX_VMCS32_GUEST_ES_LIMIT 0x4800
1693#define VMX_VMCS32_GUEST_CS_LIMIT 0x4802
1694#define VMX_VMCS32_GUEST_SS_LIMIT 0x4804
1695#define VMX_VMCS32_GUEST_DS_LIMIT 0x4806
1696#define VMX_VMCS32_GUEST_FS_LIMIT 0x4808
1697#define VMX_VMCS32_GUEST_GS_LIMIT 0x480a
1698#define VMX_VMCS32_GUEST_LDTR_LIMIT 0x480c
1699#define VMX_VMCS32_GUEST_TR_LIMIT 0x480e
1700#define VMX_VMCS32_GUEST_GDTR_LIMIT 0x4810
1701#define VMX_VMCS32_GUEST_IDTR_LIMIT 0x4812
1702#define VMX_VMCS32_GUEST_ES_ACCESS_RIGHTS 0x4814
1703#define VMX_VMCS32_GUEST_CS_ACCESS_RIGHTS 0x4816
1704#define VMX_VMCS32_GUEST_SS_ACCESS_RIGHTS 0x4818
1705#define VMX_VMCS32_GUEST_DS_ACCESS_RIGHTS 0x481a
1706#define VMX_VMCS32_GUEST_FS_ACCESS_RIGHTS 0x481c
1707#define VMX_VMCS32_GUEST_GS_ACCESS_RIGHTS 0x481e
1708#define VMX_VMCS32_GUEST_LDTR_ACCESS_RIGHTS 0x4820
1709#define VMX_VMCS32_GUEST_TR_ACCESS_RIGHTS 0x4822
1710#define VMX_VMCS32_GUEST_INT_STATE 0x4824
1711#define VMX_VMCS32_GUEST_ACTIVITY_STATE 0x4826
1712#define VMX_VMCS32_GUEST_SMBASE 0x4828
1713#define VMX_VMCS32_GUEST_SYSENTER_CS 0x482a
1714#define VMX_VMCS32_PREEMPT_TIMER_VALUE 0x482e
1715/** @} */
1716
1717
1718/** @name VMCS field encoding: 32-bit host-state fields.
1719 * @{
1720 */
1721#define VMX_VMCS32_HOST_SYSENTER_CS 0x4C00
1722/** @} */
1723
1724
1725/** @name Natural width control fields.
1726 * @{
1727 */
1728#define VMX_VMCS_CTRL_CR0_MASK 0x6000
1729#define VMX_VMCS_CTRL_CR4_MASK 0x6002
1730#define VMX_VMCS_CTRL_CR0_READ_SHADOW 0x6004
1731#define VMX_VMCS_CTRL_CR4_READ_SHADOW 0x6006
1732#define VMX_VMCS_CTRL_CR3_TARGET_VAL0 0x6008
1733#define VMX_VMCS_CTRL_CR3_TARGET_VAL1 0x600a
1734#define VMX_VMCS_CTRL_CR3_TARGET_VAL2 0x600c
1735#define VMX_VMCS_CTRL_CR3_TARGET_VAL3 0x600e
1736/** @} */
1737
1738
1739/** @name Natural width read-only data fields.
1740 * @{
1741 */
1742#define VMX_VMCS_RO_EXIT_QUALIFICATION 0x6400
1743#define VMX_VMCS_RO_IO_RCX 0x6402
1744#define VMX_VMCS_RO_IO_RSX 0x6404
1745#define VMX_VMCS_RO_IO_RDI 0x6406
1746#define VMX_VMCS_RO_IO_RIP 0x6408
1747#define VMX_VMCS_RO_EXIT_GUEST_LINEAR_ADDR 0x640a
1748/** @} */
1749
1750
1751/** @name VMCS field encoding: Natural width guest-state fields.
1752 * @{
1753 */
1754#define VMX_VMCS_GUEST_CR0 0x6800
1755#define VMX_VMCS_GUEST_CR3 0x6802
1756#define VMX_VMCS_GUEST_CR4 0x6804
1757#define VMX_VMCS_GUEST_ES_BASE 0x6806
1758#define VMX_VMCS_GUEST_CS_BASE 0x6808
1759#define VMX_VMCS_GUEST_SS_BASE 0x680a
1760#define VMX_VMCS_GUEST_DS_BASE 0x680c
1761#define VMX_VMCS_GUEST_FS_BASE 0x680e
1762#define VMX_VMCS_GUEST_GS_BASE 0x6810
1763#define VMX_VMCS_GUEST_LDTR_BASE 0x6812
1764#define VMX_VMCS_GUEST_TR_BASE 0x6814
1765#define VMX_VMCS_GUEST_GDTR_BASE 0x6816
1766#define VMX_VMCS_GUEST_IDTR_BASE 0x6818
1767#define VMX_VMCS_GUEST_DR7 0x681a
1768#define VMX_VMCS_GUEST_RSP 0x681c
1769#define VMX_VMCS_GUEST_RIP 0x681e
1770#define VMX_VMCS_GUEST_RFLAGS 0x6820
1771#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPTS 0x6822
1772#define VMX_VMCS_GUEST_SYSENTER_ESP 0x6824
1773#define VMX_VMCS_GUEST_SYSENTER_EIP 0x6826
1774/** @} */
1775
1776
1777/** @name VMCS field encoding: Natural width host-state fields.
1778 * @{
1779 */
1780#define VMX_VMCS_HOST_CR0 0x6c00
1781#define VMX_VMCS_HOST_CR3 0x6c02
1782#define VMX_VMCS_HOST_CR4 0x6c04
1783#define VMX_VMCS_HOST_FS_BASE 0x6c06
1784#define VMX_VMCS_HOST_GS_BASE 0x6c08
1785#define VMX_VMCS_HOST_TR_BASE 0x6c0a
1786#define VMX_VMCS_HOST_GDTR_BASE 0x6c0c
1787#define VMX_VMCS_HOST_IDTR_BASE 0x6c0e
1788#define VMX_VMCS_HOST_SYSENTER_ESP 0x6c10
1789#define VMX_VMCS_HOST_SYSENTER_EIP 0x6c12
1790#define VMX_VMCS_HOST_RSP 0x6c14
1791#define VMX_VMCS_HOST_RIP 0x6c16
1792/** @} */
1793
1794
1795/** @name VMCS field encoding: Access.
1796 * @{ */
1797typedef enum
1798{
1799 VMXVMCSFIELDACCESS_FULL = 0,
1800 VMXVMCSFIELDACCESS_HIGH
1801} VMXVMCSFIELDACCESS;
1802AssertCompileSize(VMXVMCSFIELDACCESS, 4);
1803/** @} */
1804
1805
1806/** @name VMCS field encoding: Type.
1807 * @{ */
1808typedef enum
1809{
1810 VMXVMCSFIELDTYPE_CONTROL = 0,
1811 VMXVMCSFIELDTYPE_VMEXIT_INFO,
1812 VMXVMCSFIELDTYPE_GUEST_STATE,
1813 VMXVMCSFIELDTYPE_HOST_STATE
1814} VMXVMCSFIELDTYPE;
1815AssertCompileSize(VMXVMCSFIELDTYPE, 4);
1816/** @} */
1817
1818
1819/** @name VMCS field encoding: Width.
1820 * @{ */
1821typedef enum
1822{
1823 VMXVMCSFIELDWIDTH_16BIT = 0,
1824 VMXVMCSFIELDWIDTH_64BIT,
1825 VMXVMCSFIELDWIDTH_32BIT,
1826 VMXVMCSFIELDWIDTH_NATURAL
1827} VMXVMCSFIELDWIDTH;
1828AssertCompileSize(VMXVMCSFIELDWIDTH, 4);
1829/** @} */
1830
1831/** @name VM-entry instruction length.
1832 * @{ */
1833/** The maximum valid value for VM-entry instruction length while injecting a
1834 * software interrupt, software exception or privileged software exception. */
1835#define VMX_ENTRY_INSTR_LEN_MAX 15
1836/** @} */
1837
1838/** @name Pin-based VM-execution controls.
1839 * @{
1840 */
1841/** External interrupt exiting. */
1842#define VMX_PIN_CTLS_EXT_INT_EXIT RT_BIT(0)
1843/** NMI exiting. */
1844#define VMX_PIN_CTLS_NMI_EXIT RT_BIT(3)
1845/** Virtual NMIs. */
1846#define VMX_PIN_CTLS_VIRT_NMI RT_BIT(5)
1847/** Activate VMX preemption timer. */
1848#define VMX_PIN_CTLS_PREEMPT_TIMER RT_BIT(6)
1849/** Process interrupts with the posted-interrupt notification vector. */
1850#define VMX_PIN_CTLS_POSTED_INT RT_BIT(7)
1851/** Default1 class when true capability MSRs are not supported. */
1852#define VMX_PIN_CTLS_DEFAULT1 UINT32_C(0x00000016)
1853
1854/** Bit fields for MSR_IA32_VMX_PINBASED_CTLS and Pin-based VM-execution
1855 * controls field in the VMCS. */
1856#define VMX_BF_PIN_CTLS_EXT_INT_EXIT_SHIFT 0
1857#define VMX_BF_PIN_CTLS_EXT_INT_EXIT_MASK UINT32_C(0x00000001)
1858#define VMX_BF_PIN_CTLS_UNDEF_1_2_SHIFT 1
1859#define VMX_BF_PIN_CTLS_UNDEF_1_2_MASK UINT32_C(0x00000006)
1860#define VMX_BF_PIN_CTLS_NMI_EXIT_SHIFT 3
1861#define VMX_BF_PIN_CTLS_NMI_EXIT_MASK UINT32_C(0x00000008)
1862#define VMX_BF_PIN_CTLS_UNDEF_4_SHIFT 4
1863#define VMX_BF_PIN_CTLS_UNDEF_4_MASK UINT32_C(0x00000010)
1864#define VMX_BF_PIN_CTLS_VIRT_NMI_SHIFT 5
1865#define VMX_BF_PIN_CTLS_VIRT_NMI_MASK UINT32_C(0x00000020)
1866#define VMX_BF_PIN_CTLS_PREEMPT_TIMER_SHIFT 6
1867#define VMX_BF_PIN_CTLS_PREEMPT_TIMER_MASK UINT32_C(0x00000040)
1868#define VMX_BF_PIN_CTLS_POSTED_INT_SHIFT 7
1869#define VMX_BF_PIN_CTLS_POSTED_INT_MASK UINT32_C(0x00000080)
1870#define VMX_BF_PIN_CTLS_UNDEF_8_31_SHIFT 8
1871#define VMX_BF_PIN_CTLS_UNDEF_8_31_MASK UINT32_C(0xffffff00)
1872RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PIN_CTLS_, UINT32_C(0), UINT32_MAX,
1873 (EXT_INT_EXIT, UNDEF_1_2, NMI_EXIT, UNDEF_4, VIRT_NMI, PREEMPT_TIMER, POSTED_INT, UNDEF_8_31));
1874/** @} */
1875
1876
1877/** @name Processor-based VM-execution controls.
1878 * @{
1879 */
1880/** VM-exit as soon as RFLAGS.IF=1 and no blocking is active. */
1881#define VMX_PROC_CTLS_INT_WINDOW_EXIT RT_BIT(2)
1882/** Use timestamp counter offset. */
1883#define VMX_PROC_CTLS_USE_TSC_OFFSETTING RT_BIT(3)
1884/** VM-exit when executing the HLT instruction. */
1885#define VMX_PROC_CTLS_HLT_EXIT RT_BIT(7)
1886/** VM-exit when executing the INVLPG instruction. */
1887#define VMX_PROC_CTLS_INVLPG_EXIT RT_BIT(9)
1888/** VM-exit when executing the MWAIT instruction. */
1889#define VMX_PROC_CTLS_MWAIT_EXIT RT_BIT(10)
1890/** VM-exit when executing the RDPMC instruction. */
1891#define VMX_PROC_CTLS_RDPMC_EXIT RT_BIT(11)
1892/** VM-exit when executing the RDTSC/RDTSCP instruction. */
1893#define VMX_PROC_CTLS_RDTSC_EXIT RT_BIT(12)
1894/** VM-exit when executing the MOV to CR3 instruction. (forced to 1 on the
1895 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
1896#define VMX_PROC_CTLS_CR3_LOAD_EXIT RT_BIT(15)
1897/** VM-exit when executing the MOV from CR3 instruction. (forced to 1 on the
1898 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
1899#define VMX_PROC_CTLS_CR3_STORE_EXIT RT_BIT(16)
1900/** VM-exit on CR8 loads. */
1901#define VMX_PROC_CTLS_CR8_LOAD_EXIT RT_BIT(19)
1902/** VM-exit on CR8 stores. */
1903#define VMX_PROC_CTLS_CR8_STORE_EXIT RT_BIT(20)
1904/** Use TPR shadow. */
1905#define VMX_PROC_CTLS_USE_TPR_SHADOW RT_BIT(21)
1906/** VM-exit when virtual NMI blocking is disabled. */
1907#define VMX_PROC_CTLS_NMI_WINDOW_EXIT RT_BIT(22)
1908/** VM-exit when executing a MOV DRx instruction. */
1909#define VMX_PROC_CTLS_MOV_DR_EXIT RT_BIT(23)
1910/** VM-exit when executing IO instructions. */
1911#define VMX_PROC_CTLS_UNCOND_IO_EXIT RT_BIT(24)
1912/** Use IO bitmaps. */
1913#define VMX_PROC_CTLS_USE_IO_BITMAPS RT_BIT(25)
1914/** Monitor trap flag. */
1915#define VMX_PROC_CTLS_MONITOR_TRAP_FLAG RT_BIT(27)
1916/** Use MSR bitmaps. */
1917#define VMX_PROC_CTLS_USE_MSR_BITMAPS RT_BIT(28)
1918/** VM-exit when executing the MONITOR instruction. */
1919#define VMX_PROC_CTLS_MONITOR_EXIT RT_BIT(29)
1920/** VM-exit when executing the PAUSE instruction. */
1921#define VMX_PROC_CTLS_PAUSE_EXIT RT_BIT(30)
1922/** Whether the secondary processor based VM-execution controls are used. */
1923#define VMX_PROC_CTLS_USE_SECONDARY_CTLS RT_BIT(31)
1924/** Default1 class when true-capability MSRs are not supported. */
1925#define VMX_PROC_CTLS_DEFAULT1 UINT32_C(0x0401e172)
1926
1927/** Bit fields for MSR_IA32_VMX_PROCBASED_CTLS and Processor-based VM-execution
1928 * controls field in the VMCS. */
1929#define VMX_BF_PROC_CTLS_UNDEF_0_1_SHIFT 0
1930#define VMX_BF_PROC_CTLS_UNDEF_0_1_MASK UINT32_C(0x00000003)
1931#define VMX_BF_PROC_CTLS_INT_WINDOW_EXIT_SHIFT 2
1932#define VMX_BF_PROC_CTLS_INT_WINDOW_EXIT_MASK UINT32_C(0x00000004)
1933#define VMX_BF_PROC_CTLS_USE_TSC_OFFSETTING_SHIFT 3
1934#define VMX_BF_PROC_CTLS_USE_TSC_OFFSETTING_MASK UINT32_C(0x00000008)
1935#define VMX_BF_PROC_CTLS_UNDEF_4_6_SHIFT 4
1936#define VMX_BF_PROC_CTLS_UNDEF_4_6_MASK UINT32_C(0x00000070)
1937#define VMX_BF_PROC_CTLS_HLT_EXIT_SHIFT 7
1938#define VMX_BF_PROC_CTLS_HLT_EXIT_MASK UINT32_C(0x00000080)
1939#define VMX_BF_PROC_CTLS_UNDEF_8_SHIFT 8
1940#define VMX_BF_PROC_CTLS_UNDEF_8_MASK UINT32_C(0x00000100)
1941#define VMX_BF_PROC_CTLS_INVLPG_EXIT_SHIFT 9
1942#define VMX_BF_PROC_CTLS_INVLPG_EXIT_MASK UINT32_C(0x00000200)
1943#define VMX_BF_PROC_CTLS_MWAIT_EXIT_SHIFT 10
1944#define VMX_BF_PROC_CTLS_MWAIT_EXIT_MASK UINT32_C(0x00000400)
1945#define VMX_BF_PROC_CTLS_RDPMC_EXIT_SHIFT 11
1946#define VMX_BF_PROC_CTLS_RDPMC_EXIT_MASK UINT32_C(0x00000800)
1947#define VMX_BF_PROC_CTLS_RDTSC_EXIT_SHIFT 12
1948#define VMX_BF_PROC_CTLS_RDTSC_EXIT_MASK UINT32_C(0x00001000)
1949#define VMX_BF_PROC_CTLS_UNDEF_13_14_SHIFT 13
1950#define VMX_BF_PROC_CTLS_UNDEF_13_14_MASK UINT32_C(0x00006000)
1951#define VMX_BF_PROC_CTLS_CR3_LOAD_EXIT_SHIFT 15
1952#define VMX_BF_PROC_CTLS_CR3_LOAD_EXIT_MASK UINT32_C(0x00008000)
1953#define VMX_BF_PROC_CTLS_CR3_STORE_EXIT_SHIFT 16
1954#define VMX_BF_PROC_CTLS_CR3_STORE_EXIT_MASK UINT32_C(0x00010000)
1955#define VMX_BF_PROC_CTLS_UNDEF_17_18_SHIFT 17
1956#define VMX_BF_PROC_CTLS_UNDEF_17_18_MASK UINT32_C(0x00060000)
1957#define VMX_BF_PROC_CTLS_CR8_LOAD_EXIT_SHIFT 19
1958#define VMX_BF_PROC_CTLS_CR8_LOAD_EXIT_MASK UINT32_C(0x00080000)
1959#define VMX_BF_PROC_CTLS_CR8_STORE_EXIT_SHIFT 20
1960#define VMX_BF_PROC_CTLS_CR8_STORE_EXIT_MASK UINT32_C(0x00100000)
1961#define VMX_BF_PROC_CTLS_USE_TPR_SHADOW_SHIFT 21
1962#define VMX_BF_PROC_CTLS_USE_TPR_SHADOW_MASK UINT32_C(0x00200000)
1963#define VMX_BF_PROC_CTLS_NMI_WINDOW_EXIT_SHIFT 22
1964#define VMX_BF_PROC_CTLS_NMI_WINDOW_EXIT_MASK UINT32_C(0x00400000)
1965#define VMX_BF_PROC_CTLS_MOV_DR_EXIT_SHIFT 23
1966#define VMX_BF_PROC_CTLS_MOV_DR_EXIT_MASK UINT32_C(0x00800000)
1967#define VMX_BF_PROC_CTLS_UNCOND_IO_EXIT_SHIFT 24
1968#define VMX_BF_PROC_CTLS_UNCOND_IO_EXIT_MASK UINT32_C(0x01000000)
1969#define VMX_BF_PROC_CTLS_USE_IO_BITMAPS_SHIFT 25
1970#define VMX_BF_PROC_CTLS_USE_IO_BITMAPS_MASK UINT32_C(0x02000000)
1971#define VMX_BF_PROC_CTLS_UNDEF_26_SHIFT 26
1972#define VMX_BF_PROC_CTLS_UNDEF_26_MASK UINT32_C(0x4000000)
1973#define VMX_BF_PROC_CTLS_MONITOR_TRAP_FLAG_SHIFT 27
1974#define VMX_BF_PROC_CTLS_MONITOR_TRAP_FLAG_MASK UINT32_C(0x08000000)
1975#define VMX_BF_PROC_CTLS_USE_MSR_BITMAPS_SHIFT 28
1976#define VMX_BF_PROC_CTLS_USE_MSR_BITMAPS_MASK UINT32_C(0x10000000)
1977#define VMX_BF_PROC_CTLS_MONITOR_EXIT_SHIFT 29
1978#define VMX_BF_PROC_CTLS_MONITOR_EXIT_MASK UINT32_C(0x20000000)
1979#define VMX_BF_PROC_CTLS_PAUSE_EXIT_SHIFT 30
1980#define VMX_BF_PROC_CTLS_PAUSE_EXIT_MASK UINT32_C(0x40000000)
1981#define VMX_BF_PROC_CTLS_USE_SECONDARY_CTLS_SHIFT 31
1982#define VMX_BF_PROC_CTLS_USE_SECONDARY_CTLS_MASK UINT32_C(0x80000000)
1983RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PROC_CTLS_, UINT32_C(0), UINT32_MAX,
1984 (UNDEF_0_1, INT_WINDOW_EXIT, USE_TSC_OFFSETTING, UNDEF_4_6, HLT_EXIT, UNDEF_8, INVLPG_EXIT,
1985 MWAIT_EXIT, RDPMC_EXIT, RDTSC_EXIT, UNDEF_13_14, CR3_LOAD_EXIT, CR3_STORE_EXIT, UNDEF_17_18,
1986 CR8_LOAD_EXIT, CR8_STORE_EXIT, USE_TPR_SHADOW, NMI_WINDOW_EXIT, MOV_DR_EXIT, UNCOND_IO_EXIT,
1987 USE_IO_BITMAPS, UNDEF_26, MONITOR_TRAP_FLAG, USE_MSR_BITMAPS, MONITOR_EXIT, PAUSE_EXIT,
1988 USE_SECONDARY_CTLS));
1989/** @} */
1990
1991
1992/** @name Secondary Processor-based VM-execution controls.
1993 * @{
1994 */
1995/** Virtualize APIC access. */
1996#define VMX_PROC_CTLS2_VIRT_APIC_ACCESS RT_BIT(0)
1997/** EPT supported/enabled. */
1998#define VMX_PROC_CTLS2_EPT RT_BIT(1)
1999/** Descriptor table instructions cause VM-exits. */
2000#define VMX_PROC_CTLS2_DESC_TABLE_EXIT RT_BIT(2)
2001/** RDTSCP supported/enabled. */
2002#define VMX_PROC_CTLS2_RDTSCP RT_BIT(3)
2003/** Virtualize x2APIC mode. */
2004#define VMX_PROC_CTLS2_VIRT_X2APIC_MODE RT_BIT(4)
2005/** VPID supported/enabled. */
2006#define VMX_PROC_CTLS2_VPID RT_BIT(5)
2007/** VM-exit when executing the WBINVD instruction. */
2008#define VMX_PROC_CTLS2_WBINVD_EXIT RT_BIT(6)
2009/** Unrestricted guest execution. */
2010#define VMX_PROC_CTLS2_UNRESTRICTED_GUEST RT_BIT(7)
2011/** APIC register virtualization. */
2012#define VMX_PROC_CTLS2_APIC_REG_VIRT RT_BIT(8)
2013/** Virtual-interrupt delivery. */
2014#define VMX_PROC_CTLS2_VIRT_INT_DELIVERY RT_BIT(9)
2015/** A specified number of pause loops cause a VM-exit. */
2016#define VMX_PROC_CTLS2_PAUSE_LOOP_EXIT RT_BIT(10)
2017/** VM-exit when executing RDRAND instructions. */
2018#define VMX_PROC_CTLS2_RDRAND_EXIT RT_BIT(11)
2019/** Enables INVPCID instructions. */
2020#define VMX_PROC_CTLS2_INVPCID RT_BIT(12)
2021/** Enables VMFUNC instructions. */
2022#define VMX_PROC_CTLS2_VMFUNC RT_BIT(13)
2023/** Enables VMCS shadowing. */
2024#define VMX_PROC_CTLS2_VMCS_SHADOWING RT_BIT(14)
2025/** Enables ENCLS VM-exits. */
2026#define VMX_PROC_CTLS2_ENCLS_EXIT RT_BIT(15)
2027/** VM-exit when executing RDSEED. */
2028#define VMX_PROC_CTLS2_RDSEED_EXIT RT_BIT(16)
2029/** Enables page-modification logging. */
2030#define VMX_PROC_CTLS2_PML RT_BIT(17)
2031/** Controls whether EPT-violations may cause \#VE instead of exits. */
2032#define VMX_PROC_CTLS2_EPT_VE RT_BIT(18)
2033/** Conceal VMX non-root operation from Intel processor trace (PT). */
2034#define VMX_PROC_CTLS2_CONCEAL_FROM_PT RT_BIT(19)
2035/** Enables XSAVES/XRSTORS instructions. */
2036#define VMX_PROC_CTLS2_XSAVES_XRSTORS RT_BIT(20)
2037/** Use TSC scaling. */
2038#define VMX_PROC_CTLS2_TSC_SCALING RT_BIT(25)
2039
2040/** Bit fields for MSR_IA32_VMX_PROCBASED_CTLS2 and Secondary processor-based
2041 * VM-execution controls field in the VMCS. */
2042#define VMX_BF_PROC_CTLS2_VIRT_APIC_ACCESS_SHIFT 0
2043#define VMX_BF_PROC_CTLS2_VIRT_APIC_ACCESS_MASK UINT32_C(0x00000001)
2044#define VMX_BF_PROC_CTLS2_EPT_SHIFT 1
2045#define VMX_BF_PROC_CTLS2_EPT_MASK UINT32_C(0x00000002)
2046#define VMX_BF_PROC_CTLS2_DESC_TABLE_EXIT_SHIFT 2
2047#define VMX_BF_PROC_CTLS2_DESC_TABLE_EXIT_MASK UINT32_C(0x00000004)
2048#define VMX_BF_PROC_CTLS2_RDTSCP_SHIFT 3
2049#define VMX_BF_PROC_CTLS2_RDTSCP_MASK UINT32_C(0x00000008)
2050#define VMX_BF_PROC_CTLS2_VIRT_X2APIC_MODE_SHIFT 4
2051#define VMX_BF_PROC_CTLS2_VIRT_X2APIC_MODE_MASK UINT32_C(0x00000010)
2052#define VMX_BF_PROC_CTLS2_VPID_SHIFT 5
2053#define VMX_BF_PROC_CTLS2_VPID_MASK UINT32_C(0x00000020)
2054#define VMX_BF_PROC_CTLS2_WBINVD_EXIT_SHIFT 6
2055#define VMX_BF_PROC_CTLS2_WBINVD_EXIT_MASK UINT32_C(0x00000040)
2056#define VMX_BF_PROC_CTLS2_UNRESTRICTED_GUEST_SHIFT 7
2057#define VMX_BF_PROC_CTLS2_UNRESTRICTED_GUEST_MASK UINT32_C(0x00000080)
2058#define VMX_BF_PROC_CTLS2_APIC_REG_VIRT_SHIFT 8
2059#define VMX_BF_PROC_CTLS2_APIC_REG_VIRT_MASK UINT32_C(0x00000100)
2060#define VMX_BF_PROC_CTLS2_VIRT_INT_DELIVERY_SHIFT 9
2061#define VMX_BF_PROC_CTLS2_VIRT_INT_DELIVERY_MASK UINT32_C(0x00000200)
2062#define VMX_BF_PROC_CTLS2_PAUSE_LOOP_EXIT_SHIFT 10
2063#define VMX_BF_PROC_CTLS2_PAUSE_LOOP_EXIT_MASK UINT32_C(0x00000400)
2064#define VMX_BF_PROC_CTLS2_RDRAND_EXIT_SHIFT 11
2065#define VMX_BF_PROC_CTLS2_RDRAND_EXIT_MASK UINT32_C(0x00000800)
2066#define VMX_BF_PROC_CTLS2_INVPCID_SHIFT 12
2067#define VMX_BF_PROC_CTLS2_INVPCID_MASK UINT32_C(0x00001000)
2068#define VMX_BF_PROC_CTLS2_VMFUNC_SHIFT 13
2069#define VMX_BF_PROC_CTLS2_VMFUNC_MASK UINT32_C(0x00002000)
2070#define VMX_BF_PROC_CTLS2_VMCS_SHADOWING_SHIFT 14
2071#define VMX_BF_PROC_CTLS2_VMCS_SHADOWING_MASK UINT32_C(0x00004000)
2072#define VMX_BF_PROC_CTLS2_ENCLS_EXIT_SHIFT 15
2073#define VMX_BF_PROC_CTLS2_ENCLS_EXIT_MASK UINT32_C(0x00008000)
2074#define VMX_BF_PROC_CTLS2_RDSEED_EXIT_SHIFT 16
2075#define VMX_BF_PROC_CTLS2_RDSEED_EXIT_MASK UINT32_C(0x00010000)
2076#define VMX_BF_PROC_CTLS2_PML_SHIFT 17
2077#define VMX_BF_PROC_CTLS2_PML_MASK UINT32_C(0x00020000)
2078#define VMX_BF_PROC_CTLS2_EPT_VE_SHIFT 18
2079#define VMX_BF_PROC_CTLS2_EPT_VE_MASK UINT32_C(0x00040000)
2080#define VMX_BF_PROC_CTLS2_CONCEAL_FROM_PT_SHIFT 19
2081#define VMX_BF_PROC_CTLS2_CONCEAL_FROM_PT_MASK UINT32_C(0x00080000)
2082#define VMX_BF_PROC_CTLS2_XSAVES_XRSTORS_SHIFT 20
2083#define VMX_BF_PROC_CTLS2_XSAVES_XRSTORS_MASK UINT32_C(0x00100000)
2084#define VMX_BF_PROC_CTLS2_UNDEF_21_24_SHIFT 21
2085#define VMX_BF_PROC_CTLS2_UNDEF_21_24_MASK UINT32_C(0x01e00000)
2086#define VMX_BF_PROC_CTLS2_TSC_SCALING_SHIFT 25
2087#define VMX_BF_PROC_CTLS2_TSC_SCALING_MASK UINT32_C(0x02000000)
2088#define VMX_BF_PROC_CTLS2_UNDEF_26_31_SHIFT 26
2089#define VMX_BF_PROC_CTLS2_UNDEF_26_31_MASK UINT32_C(0xfc000000)
2090RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_PROC_CTLS2_, UINT32_C(0), UINT32_MAX,
2091 (VIRT_APIC_ACCESS, EPT, DESC_TABLE_EXIT, RDTSCP, VIRT_X2APIC_MODE, VPID, WBINVD_EXIT,
2092 UNRESTRICTED_GUEST, APIC_REG_VIRT, VIRT_INT_DELIVERY, PAUSE_LOOP_EXIT, RDRAND_EXIT, INVPCID, VMFUNC,
2093 VMCS_SHADOWING, ENCLS_EXIT, RDSEED_EXIT, PML, EPT_VE, CONCEAL_FROM_PT, XSAVES_XRSTORS, UNDEF_21_24,
2094 TSC_SCALING, UNDEF_26_31));
2095/** @} */
2096
2097
2098/** @name VM-entry controls.
2099 * @{
2100 */
2101/** Load guest debug controls (dr7 & IA32_DEBUGCTL_MSR) (forced to 1 on the
2102 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
2103#define VMX_ENTRY_CTLS_LOAD_DEBUG RT_BIT(2)
2104/** 64-bit guest mode. Must be 0 for CPUs that don't support AMD64. */
2105#define VMX_ENTRY_CTLS_IA32E_MODE_GUEST RT_BIT(9)
2106/** In SMM mode after VM-entry. */
2107#define VMX_ENTRY_CTLS_ENTRY_TO_SMM RT_BIT(10)
2108/** Disable dual treatment of SMI and SMM; must be zero for VM-entry outside of SMM. */
2109#define VMX_ENTRY_CTLS_DEACTIVATE_DUAL_MON RT_BIT(11)
2110/** Whether the guest IA32_PERF_GLOBAL_CTRL MSR is loaded on VM-entry. */
2111#define VMX_ENTRY_CTLS_LOAD_PERF_MSR RT_BIT(13)
2112/** Whether the guest IA32_PAT MSR is loaded on VM-entry. */
2113#define VMX_ENTRY_CTLS_LOAD_PAT_MSR RT_BIT(14)
2114/** Whether the guest IA32_EFER MSR is loaded on VM-entry. */
2115#define VMX_ENTRY_CTLS_LOAD_EFER_MSR RT_BIT(15)
2116/** Default1 class when true-capability MSRs are not supported. */
2117#define VMX_ENTRY_CTLS_DEFAULT1 UINT32_C(0x000011ff)
2118
2119/** Bit fields for MSR_IA32_VMX_ENTRY_CTLS and VM-entry controls field in the
2120 * VMCS. */
2121#define VMX_BF_ENTRY_CTLS_UNDEF_0_1_SHIFT 0
2122#define VMX_BF_ENTRY_CTLS_UNDEF_0_1_MASK UINT32_C(0x00000003)
2123#define VMX_BF_ENTRY_CTLS_LOAD_DEBUG_SHIFT 2
2124#define VMX_BF_ENTRY_CTLS_LOAD_DEBUG_MASK UINT32_C(0x00000004)
2125#define VMX_BF_ENTRY_CTLS_UNDEF_3_8_SHIFT 3
2126#define VMX_BF_ENTRY_CTLS_UNDEF_3_8_MASK UINT32_C(0x000001f8)
2127#define VMX_BF_ENTRY_CTLS_IA32E_MODE_GUEST_SHIFT 9
2128#define VMX_BF_ENTRY_CTLS_IA32E_MODE_GUEST_MASK UINT32_C(0x00000200)
2129#define VMX_BF_ENTRY_CTLS_ENTRY_SMM_SHIFT 10
2130#define VMX_BF_ENTRY_CTLS_ENTRY_SMM_MASK UINT32_C(0x00000400)
2131#define VMX_BF_ENTRY_CTLS_DEACTIVATE_DUAL_MON_SHIFT 11
2132#define VMX_BF_ENTRY_CTLS_DEACTIVATE_DUAL_MON_MASK UINT32_C(0x00000800)
2133#define VMX_BF_ENTRY_CTLS_UNDEF_12_SHIFT 12
2134#define VMX_BF_ENTRY_CTLS_UNDEF_12_MASK UINT32_C(0x00001000)
2135#define VMX_BF_ENTRY_CTLS_LOAD_PERF_MSR_SHIFT 13
2136#define VMX_BF_ENTRY_CTLS_LOAD_PERF_MSR_MASK UINT32_C(0x00002000)
2137#define VMX_BF_ENTRY_CTLS_LOAD_PAT_MSR_SHIFT 14
2138#define VMX_BF_ENTRY_CTLS_LOAD_PAT_MSR_MASK UINT32_C(0x00004000)
2139#define VMX_BF_ENTRY_CTLS_LOAD_EFER_MSR_SHIFT 15
2140#define VMX_BF_ENTRY_CTLS_LOAD_EFER_MSR_MASK UINT32_C(0x00008000)
2141#define VMX_BF_ENTRY_CTLS_UNDEF_16_31_SHIFT 16
2142#define VMX_BF_ENTRY_CTLS_UNDEF_16_31_MASK UINT32_C(0xffff0000)
2143RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_ENTRY_CTLS_, UINT32_C(0), UINT32_MAX,
2144 (UNDEF_0_1, LOAD_DEBUG, UNDEF_3_8, IA32E_MODE_GUEST, ENTRY_SMM, DEACTIVATE_DUAL_MON, UNDEF_12,
2145 LOAD_PERF_MSR, LOAD_PAT_MSR, LOAD_EFER_MSR, UNDEF_16_31));
2146/** @} */
2147
2148
2149/** @name VM-exit controls.
2150 * @{
2151 */
2152/** Save guest debug controls (dr7 & IA32_DEBUGCTL_MSR) (forced to 1 on the
2153 * 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
2154#define VMX_EXIT_CTLS_SAVE_DEBUG RT_BIT(2)
2155/** Return to long mode after a VM-exit. */
2156#define VMX_EXIT_CTLS_HOST_ADDR_SPACE_SIZE RT_BIT(9)
2157/** Whether the guest IA32_PERF_GLOBAL_CTRL MSR is loaded on VM-exit. */
2158#define VMX_EXIT_CTLS_LOAD_PERF_MSR RT_BIT(12)
2159/** Acknowledge external interrupts with the irq controller if one caused a VM-exit. */
2160#define VMX_EXIT_CTLS_ACK_EXT_INT RT_BIT(15)
2161/** Whether the guest IA32_PAT MSR is saved on VM-exit. */
2162#define VMX_EXIT_CTLS_SAVE_PAT_MSR RT_BIT(18)
2163/** Whether the host IA32_PAT MSR is loaded on VM-exit. */
2164#define VMX_EXIT_CTLS_LOAD_PAT_MSR RT_BIT(19)
2165/** Whether the guest IA32_EFER MSR is saved on VM-exit. */
2166#define VMX_EXIT_CTLS_SAVE_EFER_MSR RT_BIT(20)
2167/** Whether the host IA32_EFER MSR is loaded on VM-exit. */
2168#define VMX_EXIT_CTLS_LOAD_EFER_MSR RT_BIT(21)
2169/** Whether the value of the VMX preemption timer is saved on every VM-exit. */
2170#define VMX_EXIT_CTLS_SAVE_PREEMPT_TIMER RT_BIT(22)
2171/** Default1 class when true-capability MSRs are not supported. */
2172#define VMX_EXIT_CTLS_DEFAULT1 UINT32_C(0x00036dff)
2173
2174/** Bit fields for MSR_IA32_VMX_EXIT_CTLS and VM-exit controls field in the
2175 * VMCS. */
2176#define VMX_BF_EXIT_CTLS_UNDEF_0_1_SHIFT 0
2177#define VMX_BF_EXIT_CTLS_UNDEF_0_1_MASK UINT32_C(0x00000003)
2178#define VMX_BF_EXIT_CTLS_SAVE_DEBUG_SHIFT 2
2179#define VMX_BF_EXIT_CTLS_SAVE_DEBUG_MASK UINT32_C(0x00000004)
2180#define VMX_BF_EXIT_CTLS_UNDEF_3_8_SHIFT 3
2181#define VMX_BF_EXIT_CTLS_UNDEF_3_8_MASK UINT32_C(0x000001f8)
2182#define VMX_BF_EXIT_CTLS_HOST_ADDR_SPACE_SIZE_SHIFT 9
2183#define VMX_BF_EXIT_CTLS_HOST_ADDR_SPACE_SIZE_MASK UINT32_C(0x00000200)
2184#define VMX_BF_EXIT_CTLS_UNDEF_10_11_SHIFT 10
2185#define VMX_BF_EXIT_CTLS_UNDEF_10_11_MASK UINT32_C(0x00000c00)
2186#define VMX_BF_EXIT_CTLS_LOAD_PERF_MSR_SHIFT 12
2187#define VMX_BF_EXIT_CTLS_LOAD_PERF_MSR_MASK UINT32_C(0x00001000)
2188#define VMX_BF_EXIT_CTLS_UNDEF_13_14_SHIFT 13
2189#define VMX_BF_EXIT_CTLS_UNDEF_13_14_MASK UINT32_C(0x00006000)
2190#define VMX_BF_EXIT_CTLS_ACK_EXT_INT_SHIFT 15
2191#define VMX_BF_EXIT_CTLS_ACK_EXT_INT_MASK UINT32_C(0x00008000)
2192#define VMX_BF_EXIT_CTLS_UNDEF_16_17_SHIFT 16
2193#define VMX_BF_EXIT_CTLS_UNDEF_16_17_MASK UINT32_C(0x00030000)
2194#define VMX_BF_EXIT_CTLS_SAVE_PAT_MSR_SHIFT 18
2195#define VMX_BF_EXIT_CTLS_SAVE_PAT_MSR_MASK UINT32_C(0x00040000)
2196#define VMX_BF_EXIT_CTLS_LOAD_PAT_MSR_SHIFT 19
2197#define VMX_BF_EXIT_CTLS_LOAD_PAT_MSR_MASK UINT32_C(0x00080000)
2198#define VMX_BF_EXIT_CTLS_SAVE_EFER_MSR_SHIFT 20
2199#define VMX_BF_EXIT_CTLS_SAVE_EFER_MSR_MASK UINT32_C(0x00100000)
2200#define VMX_BF_EXIT_CTLS_LOAD_EFER_MSR_SHIFT 21
2201#define VMX_BF_EXIT_CTLS_LOAD_EFER_MSR_MASK UINT32_C(0x00200000)
2202#define VMX_BF_EXIT_CTLS_SAVE_PREEMPT_TIMER_SHIFT 22
2203#define VMX_BF_EXIT_CTLS_SAVE_PREEMPT_TIMER_MASK UINT32_C(0x00400000)
2204#define VMX_BF_EXIT_CTLS_UNDEF_23_31_SHIFT 23
2205#define VMX_BF_EXIT_CTLS_UNDEF_23_31_MASK UINT32_C(0xff800000)
2206RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_CTLS_, UINT32_C(0), UINT32_MAX,
2207 (UNDEF_0_1, SAVE_DEBUG, UNDEF_3_8, HOST_ADDR_SPACE_SIZE, UNDEF_10_11, LOAD_PERF_MSR, UNDEF_13_14,
2208 ACK_EXT_INT, UNDEF_16_17, SAVE_PAT_MSR, LOAD_PAT_MSR, SAVE_EFER_MSR, LOAD_EFER_MSR,
2209 SAVE_PREEMPT_TIMER, UNDEF_23_31));
2210/** @} */
2211
2212
2213/** @name VM-exit reason.
2214 * @{
2215 */
2216#define VMX_EXIT_REASON_BASIC(a) ((a) & 0xffff)
2217/** @} */
2218
2219
2220/** @name VM-entry interruption information.
2221 * @{
2222 */
2223#define VMX_ENTRY_INT_INFO_IS_VALID(a) (((a) >> 31) & 1)
2224#define VMX_ENTRY_INT_INFO_TYPE_SHIFT 8
2225#define VMX_ENTRY_INT_INFO_TYPE(a) (((a) >> 8) & 7)
2226/** @} */
2227
2228
2229/** @name VM-entry interruption information.
2230 * @{ */
2231#define VMX_ENTRY_INT_INFO_VECTOR(a) ((a) & 0xff)
2232#define VMX_ENTRY_INT_INFO_TYPE_SHIFT 8
2233#define VMX_ENTRY_INT_INFO_TYPE(a) (((a) >> 8) & 7)
2234#define VMX_ENTRY_INT_INFO_ERROR_CODE_VALID RT_BIT(11)
2235#define VMX_ENTRY_INT_INFO_IS_ERROR_CODE_VALID(a) (((a) >> 11) & 1)
2236#define VMX_ENTRY_INT_INFO_NMI_UNBLOCK_IRET 12
2237#define VMX_ENTRY_INT_INFO_IS_NMI_UNBLOCK_IRET(a) (((a) >> 12) & 1)
2238#define VMX_ENTRY_INT_INFO_VALID RT_BIT(31)
2239#define VMX_ENTRY_INT_INFO_IS_VALID(a) (((a) >> 31) & 1)
2240/** Construct an VM-entry interruption information field from a VM-exit interruption
2241 * info value (same except that bit 12 is reserved). */
2242#define VMX_ENTRY_INT_INFO_FROM_EXIT_INT_INFO(a) ((a) & ~RT_BIT(12))
2243/** Construct a VM-entry interruption information field from an IDT-vectoring
2244 * information field (same except that bit 12 is reserved). */
2245#define VMX_ENTRY_INT_INFO_FROM_EXIT_IDT_INFO(a) ((a) & ~RT_BIT(12))
2246
2247/** Bit fields for VM-entry interruption information. */
2248#define VMX_BF_ENTRY_INT_INFO_VECTOR_SHIFT 0
2249#define VMX_BF_ENTRY_INT_INFO_VECTOR_MASK UINT32_C(0x000000ff)
2250#define VMX_BF_ENTRY_INT_INFO_TYPE_SHIFT 8
2251#define VMX_BF_ENTRY_INT_INFO_TYPE_MASK UINT32_C(0x00000700)
2252#define VMX_BF_ENTRY_INT_INFO_ERR_CODE_VALID_SHIFT 11
2253#define VMX_BF_ENTRY_INT_INFO_ERR_CODE_VALID_MASK UINT32_C(0x00000800)
2254#define VMX_BF_ENTRY_INT_INFO_RSVD_12_30_SHIFT 12
2255#define VMX_BF_ENTRY_INT_INFO_RSVD_12_30_MASK UINT32_C(0x7ffff000)
2256#define VMX_BF_ENTRY_INT_INFO_VALID_SHIFT 31
2257#define VMX_BF_ENTRY_INT_INFO_VALID_MASK UINT32_C(0x80000000)
2258RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_ENTRY_INT_INFO_, UINT32_C(0), UINT32_MAX,
2259 (VECTOR, TYPE, ERR_CODE_VALID, RSVD_12_30, VALID));
2260/** @} */
2261
2262/** @name VM-entry exception error code.
2263 * @{ */
2264/** Error code valid mask. */
2265/** @todo r=ramshankar: Intel spec. 26.2.1.3 "VM-Entry Control Fields" states that
2266 * bits 31:15 MBZ. However, Intel spec. 6.13 "Error Code" states "To keep the
2267 * stack aligned for doubleword pushes, the upper half of the error code is
2268 * reserved" which implies bits 31:16 MBZ (and not 31:15) which is what we
2269 * use below. */
2270#define VMX_ENTRY_INT_XCPT_ERR_CODE_VALID_MASK UINT32_C(0xffff)
2271/** @} */
2272
2273/** @name VM-entry interruption information types.
2274 * @{
2275 */
2276#define VMX_ENTRY_INT_INFO_TYPE_EXT_INT 0
2277#define VMX_ENTRY_INT_INFO_TYPE_NMI 2
2278#define VMX_ENTRY_INT_INFO_TYPE_HW_XCPT 3
2279#define VMX_ENTRY_INT_INFO_TYPE_SW_INT 4
2280#define VMX_ENTRY_INT_INFO_TYPE_PRIV_SW_XCPT 5
2281#define VMX_ENTRY_INT_INFO_TYPE_SW_XCPT 6
2282#define VMX_ENTRY_INT_INFO_TYPE_OTHER_EVENT 7
2283/** @} */
2284
2285
2286/** @name VM-exit interruption information.
2287 * @{
2288 */
2289#define VMX_EXIT_INT_INFO_VECTOR(a) ((a) & 0xff)
2290#define VMX_EXIT_INT_INFO_TYPE_SHIFT 8
2291#define VMX_EXIT_INT_INFO_TYPE(a) (((a) >> 8) & 7)
2292#define VMX_EXIT_INT_INFO_ERROR_CODE_VALID RT_BIT(11)
2293#define VMX_EXIT_INT_INFO_IS_ERROR_CODE_VALID(a) (((a) >> 11) & 1)
2294#define VMX_EXIT_INT_INFO_NMI_UNBLOCK_IRET 12
2295#define VMX_EXIT_INT_INFO_IS_NMI_UNBLOCK_IRET(a) (((a) >> 12) & 1)
2296#define VMX_EXIT_INT_INFO_VALID RT_BIT(31)
2297#define VMX_EXIT_INT_INFO_IS_VALID(a) (((a) >> 31) & 1)
2298
2299/** Bit fields for VM-exit interruption infomration. */
2300#define VMX_BF_EXIT_INT_INFO_VECTOR_SHIFT 0
2301#define VMX_BF_EXIT_INT_INFO_VECTOR_MASK UINT32_C(0x000000ff)
2302#define VMX_BF_EXIT_INT_INFO_TYPE_SHIFT 8
2303#define VMX_BF_EXIT_INT_INFO_TYPE_MASK UINT32_C(0x00000700)
2304#define VMX_BF_EXIT_INT_INFO_ERR_CODE_VALID_SHIFT 11
2305#define VMX_BF_EXIT_INT_INFO_ERR_CODE_VALID_MASK UINT32_C(0x00000800)
2306#define VMX_BF_EXIT_INT_INFO_NMI_UNBLOCK_IRET_SHIFT 12
2307#define VMX_BF_EXIT_INT_INFO_NMI_UNBLOCK_IRET_MASK UINT32_C(0x00001000)
2308#define VMX_BF_EXIT_INT_INFO_RSVD_13_30_SHIFT 13
2309#define VMX_BF_EXIT_INT_INFO_RSVD_13_30_MASK UINT32_C(0x7fffe000)
2310#define VMX_BF_EXIT_INT_INFO_VALID_SHIFT 31
2311#define VMX_BF_EXIT_INT_INFO_VALID_MASK UINT32_C(0x80000000)
2312RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_EXIT_INT_INFO_, UINT32_C(0), UINT32_MAX,
2313 (VECTOR, TYPE, ERR_CODE_VALID, NMI_UNBLOCK_IRET, RSVD_13_30, VALID));
2314/** @} */
2315
2316
2317/** @name VM-exit interruption information types.
2318 * @{
2319 */
2320#define VMX_EXIT_INT_INFO_TYPE_EXT_INT 0
2321#define VMX_EXIT_INT_INFO_TYPE_NMI 2
2322#define VMX_EXIT_INT_INFO_TYPE_HW_XCPT 3
2323#define VMX_EXIT_INT_INFO_TYPE_SW_INT 4
2324#define VMX_EXIT_INT_INFO_TYPE_PRIV_SW_XCPT 5
2325#define VMX_EXIT_INT_INFO_TYPE_SW_XCPT 6
2326#define VMX_EXIT_INT_INFO_TYPE_UNUSED 7
2327/** @} */
2328
2329
2330/** @name VM-exit instruction identity.
2331 *
2332 * These are found in VM-exit instruction information fields for certain
2333 * instructions.
2334 * @{ */
2335typedef uint8_t VMXINSTRID;
2336#define VMXINSTRID_VALID RT_BIT(7)
2337#define VMXINSTRID_IS_VALID(a) (((a) >> 7) & 1)
2338#define VMXINSTRID_GET_ID(a) ((a) & ~VMXINSTRID_VALID)
2339#define VMXINSTRID_NONE 0
2340/** The OR'd rvalues are from the VT-x spec (valid bit is VBox specific): */
2341#define VMXINSTRID_SGDT ((VMXINSTRID_VALID) | 0)
2342#define VMXINSTRID_SIDT ((VMXINSTRID_VALID) | 1)
2343#define VMXINSTRID_LGDT ((VMXINSTRID_VALID) | 2)
2344#define VMXINSTRID_LIDT ((VMXINSTRID_VALID) | 3)
2345
2346#define VMXINSTRID_SLDT ((VMXINSTRID_VALID) | 0)
2347#define VMXINSTRID_STR ((VMXINSTRID_VALID) | 1)
2348#define VMXINSTRID_LLDT ((VMXINSTRID_VALID) | 2)
2349#define VMXINSTRID_LTR ((VMXINSTRID_VALID) | 3)
2350
2351/** The following are used internally and are not based on the VT-x spec: */
2352#define VMXINSTRID_VMLAUNCH ((VMXINSTRID_VALID) | 50)
2353#define VMXINSTRID_VMRESUME ((VMXINSTRID_VALID) | 51)
2354/** @} */
2355
2356
2357/** @name IDT-vectoring information.
2358 * @{
2359 */
2360#define VMX_IDT_VECTORING_INFO_VECTOR(a) ((a) & 0xff)
2361#define VMX_IDT_VECTORING_INFO_TYPE(a) (((a) >> 8) & 7)
2362#define VMX_IDT_VECTORING_INFO_IS_ERROR_CODE_VALID(a) (((a) >> 11) & 1)
2363#define VMX_IDT_VECTORING_INFO_IS_VALID(a) (((a) >> 31) & 1)
2364
2365/** Bit fields for IDT-vectoring information. */
2366#define VMX_BF_IDT_VECTORING_INFO_VECTOR_SHIFT 0
2367#define VMX_BF_IDT_VECTORING_INFO_VECTOR_MASK UINT32_C(0x000000ff)
2368#define VMX_BF_IDT_VECTORING_INFO_TYPE_SHIFT 8
2369#define VMX_BF_IDT_VECTORING_INFO_TYPE_MASK UINT32_C(0x00000700)
2370#define VMX_BF_IDT_VECTORING_INFO_ERR_CODE_VALID_SHIFT 11
2371#define VMX_BF_IDT_VECTORING_INFO_ERR_CODE_VALID_MASK UINT32_C(0x00000800)
2372#define VMX_BF_IDT_VECTORING_INFO_UNDEF_12_SHIFT 12
2373#define VMX_BF_IDT_VECTORING_INFO_UNDEF_12_MASK UINT32_C(0x00001000)
2374#define VMX_BF_IDT_VECTORING_INFO_RSVD_13_30_SHIFT 13
2375#define VMX_BF_IDT_VECTORING_INFO_RSVD_13_30_MASK UINT32_C(0x7fffe000)
2376#define VMX_BF_IDT_VECTORING_INFO_VALID_SHIFT 31
2377#define VMX_BF_IDT_VECTORING_INFO_VALID_MASK UINT32_C(0x80000000)
2378RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_IDT_VECTORING_INFO_, UINT32_C(0), UINT32_MAX,
2379 (VECTOR, TYPE, ERR_CODE_VALID, UNDEF_12, RSVD_13_30, VALID));
2380/** @} */
2381
2382
2383/** @name IDT-vectoring information vector types.
2384 * @{
2385 */
2386#define VMX_IDT_VECTORING_INFO_TYPE_EXT_INT 0
2387#define VMX_IDT_VECTORING_INFO_TYPE_NMI 2
2388#define VMX_IDT_VECTORING_INFO_TYPE_HW_XCPT 3
2389#define VMX_IDT_VECTORING_INFO_TYPE_SW_INT 4
2390#define VMX_IDT_VECTORING_INFO_TYPE_PRIV_SW_XCPT 5
2391#define VMX_IDT_VECTORING_INFO_TYPE_SW_XCPT 6
2392#define VMX_IDT_VECTORING_INFO_TYPE_SW_UNUSED 7
2393/** @} */
2394
2395
2396/** @name TPR threshold.
2397 * @{ */
2398/** Mask of the TPR threshold field (bits 31:4 MBZ). */
2399#define VMX_TPR_THRESHOLD_MASK UINT32_C(0xf)
2400
2401/** Bit fields for TPR threshold. */
2402#define VMX_BF_TPR_THRESHOLD_TPR_SHIFT 0
2403#define VMX_BF_TPR_THRESHOLD_TPR_MASK UINT32_C(0x0000000f)
2404#define VMX_BF_TPR_THRESHOLD_RSVD_4_31_SHIFT 4
2405#define VMX_BF_TPR_THRESHOLD_RSVD_4_31_MASK UINT32_C(0xfffffff0)
2406RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_TPR_THRESHOLD_, UINT32_C(0), UINT32_MAX,
2407 (TPR, RSVD_4_31));
2408/** @} */
2409
2410
2411/** @name Guest-activity states.
2412 * @{
2413 */
2414/** The logical processor is active. */
2415#define VMX_VMCS_GUEST_ACTIVITY_ACTIVE 0x0
2416/** The logical processor is inactive, because executed a HLT instruction. */
2417#define VMX_VMCS_GUEST_ACTIVITY_HLT 0x1
2418/** The logical processor is inactive, because of a triple fault or other serious error. */
2419#define VMX_VMCS_GUEST_ACTIVITY_SHUTDOWN 0x2
2420/** The logical processor is inactive, because it's waiting for a startup-IPI */
2421#define VMX_VMCS_GUEST_ACTIVITY_SIPI_WAIT 0x3
2422/** @} */
2423
2424
2425/** @name Guest-interruptibility states.
2426 * @{
2427 */
2428#define VMX_VMCS_GUEST_INT_STATE_BLOCK_STI RT_BIT(0)
2429#define VMX_VMCS_GUEST_INT_STATE_BLOCK_MOVSS RT_BIT(1)
2430#define VMX_VMCS_GUEST_INT_STATE_BLOCK_SMI RT_BIT(2)
2431#define VMX_VMCS_GUEST_INT_STATE_BLOCK_NMI RT_BIT(3)
2432/** @} */
2433
2434
2435/** @name Exit qualification for Mov DRx.
2436 * @{
2437 */
2438/** 0-2: Debug register number */
2439#define VMX_EXIT_QUAL_DRX_REGISTER(a) ((a) & 7)
2440/** 3: Reserved; cleared to 0. */
2441#define VMX_EXIT_QUAL_DRX_RES1(a) (((a) >> 3) & 1)
2442/** 4: Direction of move (0 = write, 1 = read) */
2443#define VMX_EXIT_QUAL_DRX_DIRECTION(a) (((a) >> 4) & 1)
2444/** 5-7: Reserved; cleared to 0. */
2445#define VMX_EXIT_QUAL_DRX_RES2(a) (((a) >> 5) & 7)
2446/** 8-11: General purpose register number. */
2447#define VMX_EXIT_QUAL_DRX_GENREG(a) (((a) >> 8) & 0xf)
2448/** Rest: reserved. */
2449/** @} */
2450
2451
2452/** @name Exit qualification for debug exceptions types.
2453 * @{
2454 */
2455#define VMX_EXIT_QUAL_DRX_DIRECTION_WRITE 0
2456#define VMX_EXIT_QUAL_DRX_DIRECTION_READ 1
2457/** @} */
2458
2459
2460/** @name Exit qualification for control-register accesses.
2461 * @{
2462 */
2463/** 0-3: Control register number (0 for CLTS & LMSW) */
2464#define VMX_EXIT_QUAL_CRX_REGISTER(a) ((a) & 0xf)
2465/** 4-5: Access type. */
2466#define VMX_EXIT_QUAL_CRX_ACCESS(a) (((a) >> 4) & 3)
2467/** 6: LMSW operand type */
2468#define VMX_EXIT_QUAL_CRX_LMSW_OP(a) (((a) >> 6) & 1)
2469/** 7: Reserved; cleared to 0. */
2470#define VMX_EXIT_QUAL_CRX_RES1(a) (((a) >> 7) & 1)
2471/** 8-11: General purpose register number (0 for CLTS & LMSW). */
2472#define VMX_EXIT_QUAL_CRX_GENREG(a) (((a) >> 8) & 0xf)
2473/** 12-15: Reserved; cleared to 0. */
2474#define VMX_EXIT_QUAL_CRX_RES2(a) (((a) >> 12) & 0xf)
2475/** 16-31: LMSW source data (else 0). */
2476#define VMX_EXIT_QUAL_CRX_LMSW_DATA(a) (((a) >> 16) & 0xffff)
2477/* Rest: reserved. */
2478/** @} */
2479
2480
2481/** @name Exit qualification for control-register access types.
2482 * @{
2483 */
2484#define VMX_EXIT_QUAL_CRX_ACCESS_WRITE 0
2485#define VMX_EXIT_QUAL_CRX_ACCESS_READ 1
2486#define VMX_EXIT_QUAL_CRX_ACCESS_CLTS 2
2487#define VMX_EXIT_QUAL_CRX_ACCESS_LMSW 3
2488/** @} */
2489
2490
2491/** @name Exit qualification for task switch.
2492 * @{
2493 */
2494#define VMX_EXIT_QUAL_TASK_SWITCH_SELECTOR(a) ((a) & 0xffff)
2495#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE(a) (((a) >> 30) & 0x3)
2496/** Task switch caused by a call instruction. */
2497#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_CALL 0
2498/** Task switch caused by an iret instruction. */
2499#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_IRET 1
2500/** Task switch caused by a jmp instruction. */
2501#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_JMP 2
2502/** Task switch caused by an interrupt gate. */
2503#define VMX_EXIT_QUAL_TASK_SWITCH_TYPE_IDT 3
2504/** @} */
2505
2506
2507/** @name Exit qualification for EPT violations.
2508 * @{
2509 */
2510/** Set if the violation was caused by a data read. */
2511#define VMX_EXIT_QUAL_EPT_DATA_READ RT_BIT(0)
2512/** Set if the violation was caused by a data write. */
2513#define VMX_EXIT_QUAL_EPT_DATA_WRITE RT_BIT(1)
2514/** Set if the violation was caused by an instruction fetch. */
2515#define VMX_EXIT_QUAL_EPT_INSTR_FETCH RT_BIT(2)
2516/** AND of the present bit of all EPT structures. */
2517#define VMX_EXIT_QUAL_EPT_ENTRY_PRESENT RT_BIT(3)
2518/** AND of the write bit of all EPT structures. */
2519#define VMX_EXIT_QUAL_EPT_ENTRY_WRITE RT_BIT(4)
2520/** AND of the execute bit of all EPT structures. */
2521#define VMX_EXIT_QUAL_EPT_ENTRY_EXECUTE RT_BIT(5)
2522/** Set if the guest linear address field contains the faulting address. */
2523#define VMX_EXIT_QUAL_EPT_GUEST_ADDR_VALID RT_BIT(7)
2524/** If bit 7 is one: (reserved otherwise)
2525 * 1 - violation due to physical address access.
2526 * 0 - violation caused by page walk or access/dirty bit updates
2527 */
2528#define VMX_EXIT_QUAL_EPT_TRANSLATED_ACCESS RT_BIT(8)
2529/** @} */
2530
2531
2532/** @name Exit qualification for I/O instructions.
2533 * @{
2534 */
2535/** 0-2: IO operation width. */
2536#define VMX_EXIT_QUAL_IO_WIDTH(a) ((a) & 7)
2537/** 3: IO operation direction. */
2538#define VMX_EXIT_QUAL_IO_DIRECTION(a) (((a) >> 3) & 1)
2539/** 4: String IO operation (INS / OUTS). */
2540#define VMX_EXIT_QUAL_IO_IS_STRING(a) (((a) >> 4) & 1)
2541/** 5: Repeated IO operation. */
2542#define VMX_EXIT_QUAL_IO_IS_REP(a) (((a) >> 5) & 1)
2543/** 6: Operand encoding. */
2544#define VMX_EXIT_QUAL_IO_ENCODING(a) (((a) >> 6) & 1)
2545/** 16-31: IO Port (0-0xffff). */
2546#define VMX_EXIT_QUAL_IO_PORT(a) (((a) >> 16) & 0xffff)
2547/* Rest reserved. */
2548/** @} */
2549
2550
2551/** @name Exit qualification for I/O instruction types.
2552 * @{
2553 */
2554#define VMX_EXIT_QUAL_IO_DIRECTION_OUT 0
2555#define VMX_EXIT_QUAL_IO_DIRECTION_IN 1
2556/** @} */
2557
2558
2559/** @name Exit qualification for I/O instruction encoding.
2560 * @{
2561 */
2562#define VMX_EXIT_QUAL_IO_ENCODING_DX 0
2563#define VMX_EXIT_QUAL_IO_ENCODING_IMM 1
2564/** @} */
2565
2566
2567/** @name Exit qualification for APIC-access VM-exits from linear and
2568 * guest-physical accesses.
2569 * @{
2570 */
2571/** 0-11: If the APIC-access VM-exit is due to a linear access, the offset of
2572 * access within the APIC page. */
2573#define VMX_EXIT_QUAL_APIC_ACCESS_OFFSET(a) ((a) & 0xfff)
2574/** 12-15: Access type. */
2575#define VMX_EXIT_QUAL_APIC_ACCESS_TYPE(a) (((a) & 0xf000) >> 12)
2576/* Rest reserved. */
2577/** @} */
2578
2579
2580/** @name Exit qualification for linear address APIC-access types.
2581 * @{
2582 */
2583/** Linear read access. */
2584#define VMX_APIC_ACCESS_TYPE_LINEAR_READ 0
2585/** Linear write access. */
2586#define VMX_APIC_ACCESS_TYPE_LINEAR_WRITE 1
2587/** Linear instruction fetch access. */
2588#define VMX_APIC_ACCESS_TYPE_LINEAR_INSTR_FETCH 2
2589/** Linear read/write access during event delivery. */
2590#define VMX_APIC_ACCESS_TYPE_LINEAR_EVENT_DELIVERY 3
2591/** Physical read/write access during event delivery. */
2592#define VMX_APIC_ACCESS_TYPE_PHYSICAL_EVENT_DELIVERY 10
2593/** Physical access for an instruction fetch or during instruction execution. */
2594#define VMX_APIC_ACCESS_TYPE_PHYSICAL_INSTR 15
2595/** @} */
2596
2597
2598/** @name VMX_BF_XXTR_INSINFO_XXX - VMX_EXIT_XDTR_ACCESS instruction information.
2599 * Found in VMX_VMCS32_RO_EXIT_INSTR_INFO.
2600 * @{
2601 */
2602/** Address calculation scaling field (powers of two). */
2603#define VMX_BF_XDTR_INSINFO_SCALE_SHIFT 0
2604#define VMX_BF_XDTR_INSINFO_SCALE_MASK UINT32_C(0x00000003)
2605/** Bits 2 thru 6 are undefined. */
2606#define VMX_BF_XDTR_INSINFO_UNDEF_2_6_SHIFT 2
2607#define VMX_BF_XDTR_INSINFO_UNDEF_2_6_MASK UINT32_C(0x0000007c)
2608/** Address size, only 0(=16), 1(=32) and 2(=64) are defined.
2609 * @remarks anyone's guess why this is a 3 bit field... */
2610#define VMX_BF_XDTR_INSINFO_ADDR_SIZE_SHIFT 7
2611#define VMX_BF_XDTR_INSINFO_ADDR_SIZE_MASK UINT32_C(0x00000380)
2612/** Bit 10 is defined as zero. */
2613#define VMX_BF_XDTR_INSINFO_ZERO_10_SHIFT 10
2614#define VMX_BF_XDTR_INSINFO_ZERO_10_MASK UINT32_C(0x00000400)
2615/** Operand size, either (1=)32-bit or (0=)16-bit, but get this, it's undefined
2616 * for exits from 64-bit code as the operand size there is fixed. */
2617#define VMX_BF_XDTR_INSINFO_OP_SIZE_SHIFT 11
2618#define VMX_BF_XDTR_INSINFO_OP_SIZE_MASK UINT32_C(0x00000800)
2619/** Bits 12 thru 14 are undefined. */
2620#define VMX_BF_XDTR_INSINFO_UNDEF_12_14_SHIFT 12
2621#define VMX_BF_XDTR_INSINFO_UNDEF_12_14_MASK UINT32_C(0x00007000)
2622/** Applicable segment register (X86_SREG_XXX values). */
2623#define VMX_BF_XDTR_INSINFO_SREG_SHIFT 15
2624#define VMX_BF_XDTR_INSINFO_SREG_MASK UINT32_C(0x00038000)
2625/** Index register (X86_GREG_XXX values). Undefined if HAS_INDEX_REG is clear. */
2626#define VMX_BF_XDTR_INSINFO_INDEX_REG_SHIFT 18
2627#define VMX_BF_XDTR_INSINFO_INDEX_REG_MASK UINT32_C(0x003c0000)
2628/** Is VMX_BF_XDTR_INSINFO_INDEX_REG_XXX valid (=1) or not (=0). */
2629#define VMX_BF_XDTR_INSINFO_HAS_INDEX_REG_SHIFT 22
2630#define VMX_BF_XDTR_INSINFO_HAS_INDEX_REG_MASK UINT32_C(0x00400000)
2631/** Base register (X86_GREG_XXX values). Undefined if HAS_BASE_REG is clear. */
2632#define VMX_BF_XDTR_INSINFO_BASE_REG_SHIFT 23
2633#define VMX_BF_XDTR_INSINFO_BASE_REG_MASK UINT32_C(0x07800000)
2634/** Is VMX_XDTR_INSINFO_BASE_REG_XXX valid (=1) or not (=0). */
2635#define VMX_BF_XDTR_INSINFO_HAS_BASE_REG_SHIFT 27
2636#define VMX_BF_XDTR_INSINFO_HAS_BASE_REG_MASK UINT32_C(0x08000000)
2637/** The instruction identity (VMX_XDTR_INSINFO_II_XXX values). */
2638#define VMX_BF_XDTR_INSINFO_INSTR_ID_SHIFT 28
2639#define VMX_BF_XDTR_INSINFO_INSTR_ID_MASK UINT32_C(0x30000000)
2640#define VMX_XDTR_INSINFO_II_SGDT 0 /**< Instruction ID: SGDT */
2641#define VMX_XDTR_INSINFO_II_SIDT 1 /**< Instruction ID: SIDT */
2642#define VMX_XDTR_INSINFO_II_LGDT 2 /**< Instruction ID: LGDT */
2643#define VMX_XDTR_INSINFO_II_LIDT 3 /**< Instruction ID: LIDT */
2644/** Bits 30 & 31 are undefined. */
2645#define VMX_BF_XDTR_INSINFO_UNDEF_30_31_SHIFT 30
2646#define VMX_BF_XDTR_INSINFO_UNDEF_30_31_MASK UINT32_C(0xc0000000)
2647RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_XDTR_INSINFO_, UINT32_C(0), UINT32_MAX,
2648 (SCALE, UNDEF_2_6, ADDR_SIZE, ZERO_10, OP_SIZE, UNDEF_12_14, SREG, INDEX_REG, HAS_INDEX_REG,
2649 BASE_REG, HAS_BASE_REG, INSTR_ID, UNDEF_30_31));
2650/** @} */
2651
2652
2653/** @name VMX_BF_YYTR_INSINFO_XXX - VMX_EXIT_TR_ACCESS instruction information.
2654 * Found in VMX_VMCS32_RO_EXIT_INSTR_INFO.
2655 * This is similar to VMX_BF_XDTR_INSINFO_XXX.
2656 * @{
2657 */
2658/** Address calculation scaling field (powers of two). */
2659#define VMX_BF_YYTR_INSINFO_SCALE_SHIFT 0
2660#define VMX_BF_YYTR_INSINFO_SCALE_MASK UINT32_C(0x00000003)
2661/** Bit 2 is undefined. */
2662#define VMX_BF_YYTR_INSINFO_UNDEF_2_SHIFT 2
2663#define VMX_BF_YYTR_INSINFO_UNDEF_2_MASK UINT32_C(0x00000004)
2664/** Register operand 1. Undefined if VMX_YYTR_INSINFO_HAS_REG1 is clear. */
2665#define VMX_BF_YYTR_INSINFO_REG1_SHIFT 3
2666#define VMX_BF_YYTR_INSINFO_REG1_MASK UINT32_C(0x00000078)
2667/** Address size, only 0(=16), 1(=32) and 2(=64) are defined.
2668 * @remarks anyone's guess why this is a 3 bit field... */
2669#define VMX_BF_YYTR_INSINFO_ADDR_SIZE_SHIFT 7
2670#define VMX_BF_YYTR_INSINFO_ADDR_SIZE_MASK UINT32_C(0x00000380)
2671/** Is VMX_YYTR_INSINFO_REG1_XXX valid (=1) or not (=0). */
2672#define VMX_BF_YYTR_INSINFO_HAS_REG1_SHIFT 10
2673#define VMX_BF_YYTR_INSINFO_HAS_REG1_MASK UINT32_C(0x00000400)
2674/** Bits 11 thru 14 are undefined. */
2675#define VMX_BF_YYTR_INSINFO_UNDEF_11_14_SHIFT 11
2676#define VMX_BF_YYTR_INSINFO_UNDEF_11_14_MASK UINT32_C(0x00007800)
2677/** Applicable segment register (X86_SREG_XXX values). */
2678#define VMX_BF_YYTR_INSINFO_SREG_SHIFT 15
2679#define VMX_BF_YYTR_INSINFO_SREG_MASK UINT32_C(0x00038000)
2680/** Index register (X86_GREG_XXX values). Undefined if HAS_INDEX_REG is clear. */
2681#define VMX_BF_YYTR_INSINFO_INDEX_REG_SHIFT 18
2682#define VMX_BF_YYTR_INSINFO_INDEX_REG_MASK UINT32_C(0x003c0000)
2683/** Is VMX_YYTR_INSINFO_INDEX_REG_XXX valid (=1) or not (=0). */
2684#define VMX_BF_YYTR_INSINFO_HAS_INDEX_REG_SHIFT 22
2685#define VMX_BF_YYTR_INSINFO_HAS_INDEX_REG_MASK UINT32_C(0x00400000)
2686/** Base register (X86_GREG_XXX values). Undefined if HAS_BASE_REG is clear. */
2687#define VMX_BF_YYTR_INSINFO_BASE_REG_SHIFT 23
2688#define VMX_BF_YYTR_INSINFO_BASE_REG_MASK UINT32_C(0x07800000)
2689/** Is VMX_YYTR_INSINFO_BASE_REG_XXX valid (=1) or not (=0). */
2690#define VMX_BF_YYTR_INSINFO_HAS_BASE_REG_SHIFT 27
2691#define VMX_BF_YYTR_INSINFO_HAS_BASE_REG_MASK UINT32_C(0x08000000)
2692/** The instruction identity (VMX_YYTR_INSINFO_II_XXX values) */
2693#define VMX_BF_YYTR_INSINFO_INSTR_ID_SHIFT 28
2694#define VMX_BF_YYTR_INSINFO_INSTR_ID_MASK UINT32_C(0x30000000)
2695#define VMX_YYTR_INSINFO_II_SLDT 0 /**< Instruction ID: SLDT */
2696#define VMX_YYTR_INSINFO_II_STR 1 /**< Instruction ID: STR */
2697#define VMX_YYTR_INSINFO_II_LLDT 2 /**< Instruction ID: LLDT */
2698#define VMX_YYTR_INSINFO_II_LTR 3 /**< Instruction ID: LTR */
2699/** Bits 30 & 31 are undefined. */
2700#define VMX_BF_YYTR_INSINFO_UNDEF_30_31_SHIFT 30
2701#define VMX_BF_YYTR_INSINFO_UNDEF_30_31_MASK UINT32_C(0xc0000000)
2702RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_YYTR_INSINFO_, UINT32_C(0), UINT32_MAX,
2703 (SCALE, UNDEF_2, REG1, ADDR_SIZE, HAS_REG1, UNDEF_11_14, SREG, INDEX_REG, HAS_INDEX_REG,
2704 BASE_REG, HAS_BASE_REG, INSTR_ID, UNDEF_30_31));
2705/** @} */
2706
2707
2708/** @name Format of Pending-Debug-Exceptions.
2709 * Bits 4-11, 13, 15 and 17-63 are reserved.
2710 * @{
2711 */
2712/** Hardware breakpoint 0 was met. */
2713#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP0 RT_BIT(0)
2714/** Hardware breakpoint 1 was met. */
2715#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP1 RT_BIT(1)
2716/** Hardware breakpoint 2 was met. */
2717#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP2 RT_BIT(2)
2718/** Hardware breakpoint 3 was met. */
2719#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BP3 RT_BIT(3)
2720/** At least one data or IO breakpoint was hit. */
2721#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_EN_BP RT_BIT(12)
2722/** A debug exception would have been triggered by single-step execution mode. */
2723#define VMX_VMCS_GUEST_PENDING_DEBUG_XCPT_BS RT_BIT(14)
2724/** A debug exception occurred inside an RTM region. */
2725#define VMX_VMCS_GUEST_PENDING_DEBUG_RTM RT_BIT(16)
2726/** @} */
2727
2728
2729/** @name VMCS field encoding.
2730 * @{ */
2731typedef union
2732{
2733 struct
2734 {
2735 /** The access type; 0=full, 1=high of 64-bit fields. */
2736 uint32_t fAccessType : 1;
2737 /** The index. */
2738 uint32_t u8Index : 8;
2739 /** The type; 0=control, 1=VM-exit info, 2=guest-state, 3=host-state. */
2740 uint32_t u2Type : 2;
2741 /** Reserved (MBZ). */
2742 uint32_t u1Reserved0 : 1;
2743 /** The width; 0=16-bit, 1=64-bit, 2=32-bit, 3=natural-width. */
2744 uint32_t u2Width : 2;
2745 /** Reserved (MBZ). */
2746 uint32_t u18Reserved0 : 18;
2747 } n;
2748 /* The unsigned integer view. */
2749 uint32_t u;
2750} VMXVMCSFIELDENC;
2751AssertCompileSize(VMXVMCSFIELDENC, 4);
2752/** Pointer to a VMCS field encoding. */
2753typedef VMXVMCSFIELDENC *PVMXVMCSFIELDENC;
2754/** Pointer to a const VMCS field encoding. */
2755typedef const VMXVMCSFIELDENC *PCVMXVMCSFIELDENC;
2756
2757/** VMCS field encoding type: Full. */
2758#define VMX_VMCS_ENC_ACCESS_TYPE_FULL 0
2759/** VMCS field encoding type: High. */
2760#define VMX_VMCS_ENC_ACCESS_TYPE_HIGH 1
2761
2762/** VMCS field encoding type: Control. */
2763#define VMX_VMCS_ENC_TYPE_CONTROL 0
2764/** VMCS field encoding type: VM-exit information / read-only fields. */
2765#define VMX_VMCS_ENC_TYPE_VMEXIT_INFO 1
2766/** VMCS field encoding type: Guest-state. */
2767#define VMX_VMCS_ENC_TYPE_GUEST_STATE 2
2768/** VMCS field encoding type: Host-state. */
2769#define VMX_VMCS_ENC_TYPE_HOST_STATE 3
2770
2771/** VMCS field encoding width: 16-bit. */
2772#define VMX_VMCS_ENC_WIDTH_16BIT 0
2773/** VMCS field encoding width: 64-bit. */
2774#define VMX_VMCS_ENC_WIDTH_64BIT 1
2775/** VMCS field encoding width: 32-bit. */
2776#define VMX_VMCS_ENC_WIDTH_32BIT 2
2777/** VMCS field encoding width: Natural width. */
2778#define VMX_VMCS_ENC_WIDTH_NATURAL 3
2779
2780/** Bits fields for VMCS field encoding. */
2781#define VMX_BF_VMCS_ENC_ACCESS_TYPE_SHIFT 0
2782#define VMX_BF_VMCS_ENC_ACCESS_TYPE_MASK UINT32_C(0x00000001)
2783#define VMX_BF_VMCS_ENC_INDEX_SHIFT 1
2784#define VMX_BF_VMCS_ENC_INDEX_MASK UINT32_C(0x000003fe)
2785#define VMX_BF_VMCS_ENC_TYPE_SHIFT 10
2786#define VMX_BF_VMCS_ENC_TYPE_MASK UINT32_C(0x00000c00)
2787#define VMX_BF_VMCS_ENC_RSVD_12_SHIFT 12
2788#define VMX_BF_VMCS_ENC_RSVD_12_MASK UINT32_C(0x00001000)
2789#define VMX_BF_VMCS_ENC_WIDTH_SHIFT 13
2790#define VMX_BF_VMCS_ENC_WIDTH_MASK UINT32_C(0x00006000)
2791#define VMX_BF_VMCS_ENC_RSVD_15_31_SHIFT 15
2792#define VMX_BF_VMCS_ENC_RSVD_15_31_MASK UINT32_C(0xffff8000)
2793RT_BF_ASSERT_COMPILE_CHECKS(VMX_BF_VMCS_ENC_, UINT32_C(0), UINT32_MAX,
2794 (ACCESS_TYPE, INDEX, TYPE, RSVD_12, WIDTH, RSVD_15_31));
2795/** @} */
2796
2797
2798/** @defgroup grp_hm_vmx_virt VMX virtualization.
2799 * @{
2800 */
2801
2802/** CR0 bits set here must always be set when in VMX operation. */
2803#define VMX_V_CR0_FIXED0 (X86_CR0_PE | X86_CR0_NE | X86_CR0_PG)
2804/** VMX_V_CR0_FIXED0 when unrestricted-guest execution is supported for the guest. */
2805#define VMX_V_CR0_FIXED0_UX (VMX_V_CR0_FIXED0 & ~(X86_CR0_PE | X86_CR0_PG))
2806/** CR4 bits set here must always be set when in VMX operation. */
2807#define VMX_V_CR4_FIXED0 (X86_CR4_VMXE)
2808
2809/** Virtual VMCS revision ID. Bump this arbitarily chosen identifier if incompatible
2810 * changes to the layout of VMXVVMCS is done. Bit 31 MBZ. */
2811#define VMX_V_VMCS_REVISION_ID UINT32_C(0x1d000001)
2812AssertCompile(!(VMX_V_VMCS_REVISION_ID & RT_BIT(31)));
2813
2814/** The size of the virtual VMCS region (we use the maximum allowed size to avoid
2815 * complications when teleporation may be implemented). */
2816#define VMX_V_VMCS_SIZE X86_PAGE_4K_SIZE
2817/** The size of the virtual VMCS region (in pages). */
2818#define VMX_V_VMCS_PAGES 1
2819
2820/** The size of the Virtual-APIC page (in bytes). */
2821#define VMX_V_VIRT_APIC_SIZE X86_PAGE_4K_SIZE
2822/** The size of the Virtual-APIC page (in pages). */
2823#define VMX_V_VIRT_APIC_PAGES 1
2824
2825/** The size of the VMREAD/VMWRITE bitmap (in bytes). */
2826#define VMX_V_VMREAD_VMWRITE_BITMAP_SIZE X86_PAGE_4K_SIZE
2827/** The size of the VMREAD/VMWRITE-bitmap (in pages). */
2828#define VMX_V_VMREAD_VMWRITE_BITMAP_PAGES 1
2829
2830/** The highest index value used for supported virtual VMCS field encoding. */
2831#define VMX_V_VMCS_MAX_INDEX RT_BF_GET(VMX_VMCS64_CTRL_TSC_MULTIPLIER_HIGH, VMX_BF_VMCS_ENC_INDEX)
2832
2833/** Whether physical addresses of VMXON and VMCS related structures (I/O bitmap
2834 * etc.) are limited to 32-bits (4G). Always 0 on 64-bit CPUs. */
2835#define VMX_V_VMCS_PHYSADDR_4G_LIMIT 0
2836
2837/** @name Virtual VMX MSR - Miscellaneous data.
2838 * @{ */
2839/** Number of CR3-target values supported. */
2840#define VMX_V_CR3_TARGET_COUNT 4
2841/** Activity states supported. */
2842#define VMX_V_GUEST_ACTIVITY_STATE_MASK (VMX_VMCS_GUEST_ACTIVITY_HLT)
2843/** VMX preemption-timer shift (Core i7-2600 taken as reference). */
2844#define VMX_V_PREEMPT_TIMER_SHIFT 5
2845/** Maximum number of MSRs in the auto-load/store MSR areas, (n+1) * 512. */
2846#define VMX_V_MAX_MSRS 0
2847/** SMM MSEG revision ID. */
2848#define VMX_V_MSEG_REV_ID 0
2849/** @} */
2850
2851/** @name VMX_V_VMCS_STATE_XXX - Virtual VMCS state.
2852 * @{ */
2853/** VMCS state clear. */
2854#define VMX_V_VMCS_STATE_CLEAR RT_BIT(1)
2855/** VMCS state launched. */
2856#define VMX_V_VMCS_STATE_LAUNCHED RT_BIT(2)
2857/** @} */
2858
2859/**
2860 * Virtual VM-Exit information.
2861 *
2862 * This is a convenience structure that bundles some VM-exit information related
2863 * fields together.
2864 */
2865typedef struct
2866{
2867 /** The VM-exit reason. */
2868 uint32_t uReason;
2869 /** The VM-exit instruction length. */
2870 uint32_t cbInstr;
2871 /** The VM-exit instruction information. */
2872 VMXEXITINSTRINFO InstrInfo;
2873 /** Padding. */
2874 uint32_t u32Padding0;
2875
2876 /** The VM-exit qualification field. */
2877 uint64_t u64Qual;
2878 /** The guest-linear address field. */
2879 uint64_t u64GuestLinearAddr;
2880 /** The effective guest-linear address if @a InstrInfo indicates a memory-based
2881 * instruction VM-exit. */
2882 RTGCPTR GCPtrEffAddr;
2883
2884 /** The VM-exit instruction ID. */
2885 VMXINSTRID uInstrId;
2886} VMXVEXITINFO;
2887/** Pointer to the VMXVEXITINFO struct. */
2888typedef VMXVEXITINFO *PVMXVEXITINFO;
2889/** Pointer to a const VMXVEXITINFO struct. */
2890typedef const VMXVEXITINFO *PCVMXVEXITINFO;
2891
2892/**
2893 * Virtual VMCS.
2894 * This is our custom format and merged into the actual VMCS (/shadow) when we
2895 * execute nested-guest code using hardware-assisted VMX.
2896 *
2897 * The first 8 bytes are as per Intel spec. 24.2 "Format of the VMCS Region".
2898 *
2899 * The offset and size of the VMCS state field (fVmcsState) is also fixed (not by
2900 * Intel but for our own requirements) as we use it to offset into guest memory.
2901 *
2902 * We always treat natural-width fields as 64-bit in our implementation since
2903 * it's easier, allows for teleporation in the future and does not affect guest
2904 * software.
2905 *
2906 * Although the guest is supposed to access the VMCS only through the execution of
2907 * VMX instructions (VMREAD, VMWRITE etc.), since the VMCS may reside in guest
2908 * memory (e.g, active but not current VMCS), for saved-states compatibility, and
2909 * for teleportation (when implemented) any newly added fields should be added to
2910 * the appropriate reserved sections or at the end of the structure.
2911 */
2912#pragma pack(1)
2913typedef struct
2914{
2915 /** 0x0 - VMX VMCS revision identifier. */
2916 VMXVMCSREVID u32VmcsRevId;
2917 /** 0x4 - VMX-abort indicator. */
2918 uint32_t u32VmxAbortId;
2919 /** 0x8 - VMCS state, see VMX_V_VMCS_STATE_XXX. */
2920 uint8_t fVmcsState;
2921 /** 0x9 - Reserved for future. */
2922 uint8_t au8Padding0[3];
2923 /** 0xc - Reserved for future. */
2924 uint32_t au32Reserved0[7];
2925
2926 /** @name 16-bit control fields.
2927 * @{ */
2928 /** 0x28 - Virtual processor ID. */
2929 uint16_t u16Vpid;
2930 /** 0x2a - Posted interrupt notify vector. */
2931 uint16_t u16PostIntNotifyVector;
2932 /** 0x2c - EPTP index. */
2933 uint16_t u16EptpIndex;
2934 /** 0x2e - Reserved for future. */
2935 uint16_t au16Reserved0[8];
2936 /** @} */
2937
2938 /** @name 16-bit Guest-state fields.
2939 * @{ */
2940 /** 0x3e - Guest ES selector. */
2941 RTSEL GuestEs;
2942 /** 0x40 - Guest ES selector. */
2943 RTSEL GuestCs;
2944 /** 0x42 - Guest ES selector. */
2945 RTSEL GuestSs;
2946 /** 0x44 - Guest ES selector. */
2947 RTSEL GuestDs;
2948 /** 0x46 - Guest ES selector. */
2949 RTSEL GuestFs;
2950 /** 0x48 - Guest ES selector. */
2951 RTSEL GuestGs;
2952 /** 0x4a - Guest LDTR selector. */
2953 RTSEL GuestLdtr;
2954 /** 0x4c - Guest TR selector. */
2955 RTSEL GuestTr;
2956 /** 0x4e - Guest interrupt status (virtual-interrupt delivery). */
2957 uint16_t u16GuestIntStatus;
2958 /** 0x50 - PML index. */
2959 uint16_t u16PmlIndex;
2960 /** 0x52 - Reserved for future. */
2961 uint16_t au16Reserved1[8];
2962 /** @} */
2963
2964 /** name 16-bit Host-state fields.
2965 * @{ */
2966 /** 0x62 - Host ES selector. */
2967 RTSEL HostEs;
2968 /** 0x64 - Host CS selector. */
2969 RTSEL HostCs;
2970 /** 0x66 - Host SS selector. */
2971 RTSEL HostSs;
2972 /** 0x68 - Host DS selector. */
2973 RTSEL HostDs;
2974 /** 0x6a - Host FS selector. */
2975 RTSEL HostFs;
2976 /** 0x6c - Host GS selector. */
2977 RTSEL HostGs;
2978 /** 0x6e - Host TR selector. */
2979 RTSEL HostTr;
2980 /** 0x70 - Reserved for future. */
2981 uint16_t au16Reserved2[10];
2982 /** @} */
2983
2984 /** @name 32-bit Control fields.
2985 * @{ */
2986 /** 0x84 - Pin-based VM-execution controls. */
2987 uint32_t u32PinCtls;
2988 /** 0x88 - Processor-based VM-execution controls. */
2989 uint32_t u32ProcCtls;
2990 /** 0x8c - Exception bitmap. */
2991 uint32_t u32XcptBitmap;
2992 /** 0x90 - Page-fault exception error mask. */
2993 uint32_t u32XcptPFMask;
2994 /** 0x94 - Page-fault exception error match. */
2995 uint32_t u32XcptPFMatch;
2996 /** 0x98 - CR3-target count. */
2997 uint32_t u32Cr3TargetCount;
2998 /** 0x9c - VM-exit controls. */
2999 uint32_t u32ExitCtls;
3000 /** 0xa0 - VM-exit MSR store count. */
3001 uint32_t u32ExitMsrStoreCount;
3002 /** 0xa4 - VM-exit MSR load count. */
3003 uint32_t u32ExitMsrLoadCount;
3004 /** 0xa8 - VM-entry controls. */
3005 uint32_t u32EntryCtls;
3006 /** 0xac - VM-entry MSR load count. */
3007 uint32_t u32EntryMsrLoadCount;
3008 /** 0xb0 - VM-entry interruption information. */
3009 uint32_t u32EntryIntInfo;
3010 /** 0xb4 - VM-entry exception error code. */
3011 uint32_t u32EntryXcptErrCode;
3012 /** 0xb8 - VM-entry instruction length. */
3013 uint32_t u32EntryInstrLen;
3014 /** 0xbc - TPR-threshold. */
3015 uint32_t u32TprThreshold;
3016 /** 0xc0 - Secondary-processor based VM-execution controls. */
3017 uint32_t u32ProcCtls2;
3018 /** 0xc4 - Pause-loop exiting Gap. */
3019 uint32_t u32PleGap;
3020 /** 0xc8 - Pause-loop exiting Window. */
3021 uint32_t u32PleWindow;
3022 /** 0xcc - Reserved for future. */
3023 uint32_t au32Reserved1[8];
3024 /** @} */
3025
3026 /** @name 32-bit Read-only Data fields.
3027 * @{ */
3028 /** 0xec - VM-instruction error. */
3029 uint32_t u32RoVmInstrError;
3030 /** 0xf0 - VM-exit reason. */
3031 uint32_t u32RoExitReason;
3032 /** 0xf4 - VM-exit interruption information. */
3033 uint32_t u32RoExitIntInfo;
3034 /** 0xf8 - VM-exit interruption error code. */
3035 uint32_t u32RoExitErrCode;
3036 /** 0xfc - IDT-vectoring information. */
3037 uint32_t u32RoIdtVectoringInfo;
3038 /** 0x100 - IDT-vectoring error code. */
3039 uint32_t u32RoIdtVectoringErrCode;
3040 /** 0x104 - VM-exit instruction length. */
3041 uint32_t u32RoExitInstrLen;
3042 /** 0x108 - VM-exit instruction information. */
3043 uint32_t u32RoExitInstrInfo;
3044 /** 0x10c - Reserved for future. */
3045 uint32_t au32RoReserved2[8];
3046 /** @} */
3047
3048 /** @name 32-bit Guest-state fields.
3049 * @{ */
3050 /** 0x12c - Guest ES limit. */
3051 uint32_t u32GuestEsLimit;
3052 /** 0x130 - Guest CS limit. */
3053 uint32_t u32GuestCsLimit;
3054 /** 0x134 - Guest SS limit. */
3055 uint32_t u32GuestSsLimit;
3056 /** 0x138 - Guest DS limit. */
3057 uint32_t u32GuestDsLimit;
3058 /** 0x13c - Guest FS limit. */
3059 uint32_t u32GuestFsLimit;
3060 /** 0x140 - Guest GS limit. */
3061 uint32_t u32GuestGsLimit;
3062 /** 0x144 - Guest LDTR limit. */
3063 uint32_t u32GuestLdtrLimit;
3064 /** 0x148 - Guest TR limit. */
3065 uint32_t u32GuestTrLimit;
3066 /** 0x14c - Guest GDTR limit. */
3067 uint32_t u32GuestGdtrLimit;
3068 /** 0x150 - Guest IDTR limit. */
3069 uint32_t u32GuestIdtrLimit;
3070 /** 0x154 - Guest ES attributes. */
3071 uint32_t u32GuestEsAttr;
3072 /** 0x158 - Guest CS attributes. */
3073 uint32_t u32GuestCsAttr;
3074 /** 0x15c - Guest SS attributes. */
3075 uint32_t u32GuestSsAttr;
3076 /** 0x160 - Guest DS attributes. */
3077 uint32_t u32GuestDsAttr;
3078 /** 0x164 - Guest FS attributes. */
3079 uint32_t u32GuestFsAttr;
3080 /** 0x168 - Guest GS attributes. */
3081 uint32_t u32GuestGsAttr;
3082 /** 0x16c - Guest LDTR attributes. */
3083 uint32_t u32GuestLdtrAttr;
3084 /** 0x170 - Guest TR attributes. */
3085 uint32_t u32GuestTrAttr;
3086 /** 0x174 - Guest interruptibility state. */
3087 uint32_t u32GuestIntrState;
3088 /** 0x178 - Guest activity state. */
3089 uint32_t u32GuestActivityState;
3090 /** 0x17c - Guest SMBASE. */
3091 uint32_t u32GuestSmBase;
3092 /** 0x180 - Guest SYSENTER CS. */
3093 uint32_t u32GuestSysenterCS;
3094 /** 0x184 - Preemption timer value. */
3095 uint32_t u32PreemptTimer;
3096 /** 0x188 - Reserved for future. */
3097 uint32_t au32Reserved3[8];
3098 /** @} */
3099
3100 /** @name 32-bit Host-state fields.
3101 * @{ */
3102 /** 0x1a8 - Host SYSENTER CS. */
3103 uint32_t u32HostSysenterCs;
3104 /** 0x1ac - Reserved for future. */
3105 uint32_t au32Reserved4[11];
3106 /** @} */
3107
3108 /** @name 64-bit Control fields.
3109 * @{ */
3110 /** 0x1d8 - I/O bitmap A address. */
3111 RTUINT64U u64AddrIoBitmapA;
3112 /** 0x1e0 - I/O bitmap B address. */
3113 RTUINT64U u64AddrIoBitmapB;
3114 /** 0x1e8 - MSR bitmap address. */
3115 RTUINT64U u64AddrMsrBitmap;
3116 /** 0x1f0 - VM-exit MSR-store area address. */
3117 RTUINT64U u64AddrExitMsrStore;
3118 /** 0x1f8 - VM-exit MSR-load area address. */
3119 RTUINT64U u64AddrExitMsrLoad;
3120 /** 0x200 - VM-entry MSR-load area address. */
3121 RTUINT64U u64AddrEntryMsrLoad;
3122 /** 0x208 - Executive-VMCS pointer. */
3123 RTUINT64U u64ExecVmcsPtr;
3124 /** 0x210 - PML address. */
3125 RTUINT64U u64AddrPml;
3126 /** 0x218 - TSC offset. */
3127 RTUINT64U u64TscOffset;
3128 /** 0x220 - Virtual-APIC address. */
3129 RTUINT64U u64AddrVirtApic;
3130 /** 0x228 - APIC-access address. */
3131 RTUINT64U u64AddrApicAccess;
3132 /** 0x230 - Posted-interrupt descriptor address. */
3133 RTUINT64U u64AddrPostedIntDesc;
3134 /** 0x238 - VM-functions control. */
3135 RTUINT64U u64VmFuncCtls;
3136 /** 0x240 - EPTP pointer. */
3137 RTUINT64U u64EptpPtr;
3138 /** 0x248 - EOI-exit bitmap 0. */
3139 RTUINT64U u64EoiExitBitmap0;
3140 /** 0x250 - EOI-exit bitmap 1. */
3141 RTUINT64U u64EoiExitBitmap1;
3142 /** 0x258 - EOI-exit bitmap 2. */
3143 RTUINT64U u64EoiExitBitmap2;
3144 /** 0x260 - EOI-exit bitmap 3. */
3145 RTUINT64U u64EoiExitBitmap3;
3146 /** 0x268 - EPTP-list address. */
3147 RTUINT64U u64AddrEptpList;
3148 /** 0x270 - VMREAD-bitmap address. */
3149 RTUINT64U u64AddrVmreadBitmap;
3150 /** 0x278 - VMWRITE-bitmap address. */
3151 RTUINT64U u64AddrVmwriteBitmap;
3152 /** 0x280 - Virtualization-exception information address. */
3153 RTUINT64U u64AddrXcptVeInfo;
3154 /** 0x288 - XSS-exiting bitmap address. */
3155 RTUINT64U u64AddrXssBitmap;
3156 /** 0x290 - ENCLS-exiting bitmap address. */
3157 RTUINT64U u64AddrEnclsBitmap;
3158 /** 0x298 - TSC multiplier. */
3159 RTUINT64U u64TscMultiplier;
3160 /** 0x2a0 - Reserved for future. */
3161 RTUINT64U au64Reserved0[16];
3162 /** @} */
3163
3164 /** @name 64-bit Read-only Data fields.
3165 * @{ */
3166 /** 0x320 - Guest-physical address. */
3167 RTUINT64U u64GuestPhysAddr;
3168 /** 0x328 - Reserved for future. */
3169 RTUINT64U au64Reserved1[8];
3170 /** @} */
3171
3172 /** @name 64-bit Guest-state fields.
3173 * @{ */
3174 /** 0x368 - VMCS link pointer. */
3175 RTUINT64U u64VmcsLinkPtr;
3176 /** 0x370 - Guest debug-control MSR. */
3177 RTUINT64U u64GuestDebugCtlMsr;
3178 /** 0x378 - Guest PAT MSR. */
3179 RTUINT64U u64GuestPatMsr;
3180 /** 0x380 - Guest EFER MSR. */
3181 RTUINT64U u64GuestEferMsr;
3182 /** 0x388 - Guest global performance-control MSR. */
3183 RTUINT64U u64GuestPerfGlobalCtlMsr;
3184 /** 0x390 - Guest PDPTE 0. */
3185 RTUINT64U u64GuestPdpte0;
3186 /** 0x398 - Guest PDPTE 0. */
3187 RTUINT64U u64GuestPdpte1;
3188 /** 0x3a0 - Guest PDPTE 1. */
3189 RTUINT64U u64GuestPdpte2;
3190 /** 0x3a8 - Guest PDPTE 2. */
3191 RTUINT64U u64GuestPdpte3;
3192 /** 0x3b0 - Guest Bounds-config MSR (Intel MPX - Memory Protection Extensions). */
3193 RTUINT64U u64GuestBndcfgsMsr;
3194 /** 0x3b8 - Reserved for future. */
3195 RTUINT64U au64Reserved2[16];
3196 /** @} */
3197
3198 /** @name 64-bit Host-state Fields.
3199 * @{ */
3200 /** 0x438 - Host PAT MSR. */
3201 RTUINT64U u64HostPatMsr;
3202 /** 0x440 - Host EFER MSR. */
3203 RTUINT64U u64HostEferMsr;
3204 /** 0x448 - Host global performance-control MSR. */
3205 RTUINT64U u64HostPerfGlobalCtlMsr;
3206 /** 0x450 - Reserved for future. */
3207 RTUINT64U au64Reserved3[16];
3208 /** @} */
3209
3210 /** @name Natural-width Control fields.
3211 * @{ */
3212 /** 0x4d0 - CR0 guest/host Mask. */
3213 RTUINT64U u64Cr0Mask;
3214 /** 0x4d8 - CR4 guest/host Mask. */
3215 RTUINT64U u64Cr4Mask;
3216 /** 0x4e0 - CR0 read shadow. */
3217 RTUINT64U u64Cr0ReadShadow;
3218 /** 0x4e8 - CR4 read shadow. */
3219 RTUINT64U u64Cr4ReadShadow;
3220 /** 0x4f0 - CR3-target value 0. */
3221 RTUINT64U u64Cr3Target0;
3222 /** 0x4f8 - CR3-target value 1. */
3223 RTUINT64U u64Cr3Target1;
3224 /** 0x500 - CR3-target value 2. */
3225 RTUINT64U u64Cr3Target2;
3226 /** 0x508 - CR3-target value 3. */
3227 RTUINT64U u64Cr3Target3;
3228 /** 0x510 - Reserved for future. */
3229 RTUINT64U au64Reserved4[32];
3230 /** @} */
3231
3232 /** @name Natural-width Read-only Data fields. */
3233 /** 0x610 - Exit qualification. */
3234 RTUINT64U u64ExitQual;
3235 /** 0x618 - I/O RCX. */
3236 RTUINT64U u64IoRcx;
3237 /** 0x620 - I/O RSI. */
3238 RTUINT64U u64IoRsi;
3239 /** 0x628 - I/O RDI. */
3240 RTUINT64U u64IoRdi;
3241 /** 0x630 - I/O RIP. */
3242 RTUINT64U u64IoRip;
3243 /** 0x638 - Guest-linear address. */
3244 RTUINT64U u64GuestLinearAddr;
3245 /** 0x640 - Reserved for future. */
3246 RTUINT64U au64Reserved5[16];
3247 /** @} */
3248
3249 /** @name Natural-width Guest-state Fields.
3250 * @{ */
3251 /** 0x6c0 - Guest CR0. */
3252 RTUINT64U u64GuestCr0;
3253 /** 0x6c8 - Guest CR3. */
3254 RTUINT64U u64GuestCr3;
3255 /** 0x6d0 - Guest CR4. */
3256 RTUINT64U u64GuestCr4;
3257 /** 0x6d8 - Guest ES base. */
3258 RTUINT64U u64GuestEsBase;
3259 /** 0x6e0 - Guest CS base. */
3260 RTUINT64U u64GuestCsBase;
3261 /** 0x6e8 - Guest SS base. */
3262 RTUINT64U u64GuestSsBase;
3263 /** 0x6f0 - Guest DS base. */
3264 RTUINT64U u64GuestDsBase;
3265 /** 0x6f8 - Guest FS base. */
3266 RTUINT64U u64GuestFsBase;
3267 /** 0x700 - Guest GS base. */
3268 RTUINT64U u64GuestGsBase;
3269 /** 0x708 - Guest LDTR base. */
3270 RTUINT64U u64GuestLdtrBase;
3271 /** 0x710 - Guest TR base. */
3272 RTUINT64U u64GuestTrBase;
3273 /** 0x718 - Guest GDTR base. */
3274 RTUINT64U u64GuestGdtrBase;
3275 /** 0x720 - Guest IDTR base. */
3276 RTUINT64U u64GuestIdtrBase;
3277 /** 0x728 - Guest DR7. */
3278 RTUINT64U u64GuestDr7;
3279 /** 0x730 - Guest RSP. */
3280 RTUINT64U u64GuestRsp;
3281 /** 0x738 - Guest RIP. */
3282 RTUINT64U u64GuestRip;
3283 /** 0x740 - Guest RFLAGS. */
3284 RTUINT64U u64GuestRFlags;
3285 /** 0x748 - Guest pending debug exception. */
3286 RTUINT64U u64GuestPendingDbgXcpt;
3287 /** 0x750 - Guest SYSENTER ESP. */
3288 RTUINT64U u64GuestSysenterEsp;
3289 /** 0x758 - Guest SYSENTER EIP. */
3290 RTUINT64U u64GuestSysenterEip;
3291 /** 0x760 - Reserved for future. */
3292 RTUINT64U au64Reserved6[32];
3293 /** @} */
3294
3295 /** @name Natural-width Host-state fields.
3296 * @{ */
3297 /** 0x860 - Host CR0. */
3298 RTUINT64U u64HostCr0;
3299 /** 0x868 - Host CR3. */
3300 RTUINT64U u64HostCr3;
3301 /** 0x870 - Host CR4. */
3302 RTUINT64U u64HostCr4;
3303 /** 0x878 - Host FS base. */
3304 RTUINT64U u64HostFsBase;
3305 /** 0x880 - Host GS base. */
3306 RTUINT64U u64HostGsBase;
3307 /** 0x888 - Host TR base. */
3308 RTUINT64U u64HostTrBase;
3309 /** 0x890 - Host GDTR base. */
3310 RTUINT64U u64HostGdtrBase;
3311 /** 0x898 - Host IDTR base. */
3312 RTUINT64U u64HostIdtrBase;
3313 /** 0x8a0 - Host SYSENTER ESP base. */
3314 RTUINT64U u64HostSysenterEsp;
3315 /** 0x8a8 - Host SYSENTER ESP base. */
3316 RTUINT64U u64HostSysenterEip;
3317 /** 0x8b0 - Host RSP. */
3318 RTUINT64U u64HostRsp;
3319 /** 0x8b8 - Host RIP. */
3320 RTUINT64U u64HostRip;
3321 /** 0x8c0 - Reserved for future. */
3322 RTUINT64U au64Reserved7[32];
3323 /** @} */
3324
3325 /** 0x9c0 - Padding. */
3326 uint8_t abPadding[X86_PAGE_4K_SIZE - 0x9c0];
3327} VMXVVMCS;
3328#pragma pack()
3329/** Pointer to the VMXVVMCS struct. */
3330typedef VMXVVMCS *PVMXVVMCS;
3331/** Pointer to a const VMXVVMCS struct. */
3332typedef const VMXVVMCS *PCVMXVVMCS;
3333AssertCompileSize(VMXVVMCS, X86_PAGE_4K_SIZE);
3334AssertCompileMemberSize(VMXVVMCS, fVmcsState, sizeof(uint8_t));
3335AssertCompileMemberOffset(VMXVVMCS, u32VmxAbortId, 0x004);
3336AssertCompileMemberOffset(VMXVVMCS, fVmcsState, 0x008);
3337AssertCompileMemberOffset(VMXVVMCS, u16Vpid, 0x028);
3338AssertCompileMemberOffset(VMXVVMCS, GuestEs, 0x03e);
3339AssertCompileMemberOffset(VMXVVMCS, HostEs, 0x062);
3340AssertCompileMemberOffset(VMXVVMCS, u32PinCtls, 0x084);
3341AssertCompileMemberOffset(VMXVVMCS, u32RoVmInstrError, 0x0ec);
3342AssertCompileMemberOffset(VMXVVMCS, u32GuestEsLimit, 0x12c);
3343AssertCompileMemberOffset(VMXVVMCS, u32HostSysenterCs, 0x1a8);
3344AssertCompileMemberOffset(VMXVVMCS, u64AddrIoBitmapA, 0x1d8);
3345AssertCompileMemberOffset(VMXVVMCS, u64GuestPhysAddr, 0x320);
3346AssertCompileMemberOffset(VMXVVMCS, u64VmcsLinkPtr, 0x368);
3347AssertCompileMemberOffset(VMXVVMCS, u64HostPatMsr, 0x438);
3348AssertCompileMemberOffset(VMXVVMCS, u64Cr0Mask, 0x4d0);
3349AssertCompileMemberOffset(VMXVVMCS, u64ExitQual, 0x610);
3350AssertCompileMemberOffset(VMXVVMCS, u64GuestCr0, 0x6c0);
3351AssertCompileMemberOffset(VMXVVMCS, u64HostCr0, 0x860);
3352/** @} */
3353
3354/**
3355 * Virtual VMX-instruction diagnostics.
3356 *
3357 * These are not the same as VM instruction errors that are enumerated in the Intel
3358 * spec. These are purely internal, fine-grained definitions used for diagnostic
3359 * purposes and are not reported to guest software under the VM-instruction error
3360 * field in its VMCS.
3361 *
3362 * @note Members of this enum are used as array indices, so no gaps are allowed.
3363 * Please update g_apszVmxInstrDiagDesc when you add new fields to this
3364 * enum.
3365 */
3366typedef enum
3367{
3368 /* Internal processing errors. */
3369 kVmxVInstrDiag_Ipe_1 = 0,
3370 kVmxVInstrDiag_Ipe_2,
3371 kVmxVInstrDiag_Ipe_3,
3372 kVmxVInstrDiag_Ipe_4,
3373 kVmxVInstrDiag_Ipe_5,
3374 kVmxVInstrDiag_Ipe_6,
3375 kVmxVInstrDiag_Ipe_7,
3376 kVmxVInstrDiag_Ipe_8,
3377 kVmxVInstrDiag_Ipe_9,
3378 /* VMXON. */
3379 kVmxVInstrDiag_Vmxon_A20M,
3380 kVmxVInstrDiag_Vmxon_Cpl,
3381 kVmxVInstrDiag_Vmxon_Cr0Fixed0,
3382 kVmxVInstrDiag_Vmxon_Cr4Fixed0,
3383 kVmxVInstrDiag_Vmxon_Intercept,
3384 kVmxVInstrDiag_Vmxon_LongModeCS,
3385 kVmxVInstrDiag_Vmxon_MsrFeatCtl,
3386 kVmxVInstrDiag_Vmxon_PtrAbnormal,
3387 kVmxVInstrDiag_Vmxon_PtrAlign,
3388 kVmxVInstrDiag_Vmxon_PtrMap,
3389 kVmxVInstrDiag_Vmxon_PtrReadPhys,
3390 kVmxVInstrDiag_Vmxon_PtrWidth,
3391 kVmxVInstrDiag_Vmxon_RealOrV86Mode,
3392 kVmxVInstrDiag_Vmxon_ShadowVmcs,
3393 kVmxVInstrDiag_Vmxon_Success,
3394 kVmxVInstrDiag_Vmxon_VmxAlreadyRoot,
3395 kVmxVInstrDiag_Vmxon_Vmxe,
3396 kVmxVInstrDiag_Vmxon_VmcsRevId,
3397 kVmxVInstrDiag_Vmxon_VmxRootCpl,
3398 /* VMXOFF. */
3399 kVmxVInstrDiag_Vmxoff_Cpl,
3400 kVmxVInstrDiag_Vmxoff_Intercept,
3401 kVmxVInstrDiag_Vmxoff_LongModeCS,
3402 kVmxVInstrDiag_Vmxoff_RealOrV86Mode,
3403 kVmxVInstrDiag_Vmxoff_Success,
3404 kVmxVInstrDiag_Vmxoff_Vmxe,
3405 kVmxVInstrDiag_Vmxoff_VmxRoot,
3406 /* VMPTRLD. */
3407 kVmxVInstrDiag_Vmptrld_Cpl,
3408 kVmxVInstrDiag_Vmptrld_LongModeCS,
3409 kVmxVInstrDiag_Vmptrld_PtrAbnormal,
3410 kVmxVInstrDiag_Vmptrld_PtrAlign,
3411 kVmxVInstrDiag_Vmptrld_PtrMap,
3412 kVmxVInstrDiag_Vmptrld_PtrReadPhys,
3413 kVmxVInstrDiag_Vmptrld_PtrVmxon,
3414 kVmxVInstrDiag_Vmptrld_PtrWidth,
3415 kVmxVInstrDiag_Vmptrld_RealOrV86Mode,
3416 kVmxVInstrDiag_Vmptrld_ShadowVmcs,
3417 kVmxVInstrDiag_Vmptrld_Success,
3418 kVmxVInstrDiag_Vmptrld_VmcsRevId,
3419 kVmxVInstrDiag_Vmptrld_VmxRoot,
3420 /* VMPTRST. */
3421 kVmxVInstrDiag_Vmptrst_Cpl,
3422 kVmxVInstrDiag_Vmptrst_LongModeCS,
3423 kVmxVInstrDiag_Vmptrst_PtrMap,
3424 kVmxVInstrDiag_Vmptrst_RealOrV86Mode,
3425 kVmxVInstrDiag_Vmptrst_Success,
3426 kVmxVInstrDiag_Vmptrst_VmxRoot,
3427 /* VMCLEAR. */
3428 kVmxVInstrDiag_Vmclear_Cpl,
3429 kVmxVInstrDiag_Vmclear_LongModeCS,
3430 kVmxVInstrDiag_Vmclear_PtrAbnormal,
3431 kVmxVInstrDiag_Vmclear_PtrAlign,
3432 kVmxVInstrDiag_Vmclear_PtrMap,
3433 kVmxVInstrDiag_Vmclear_PtrReadPhys,
3434 kVmxVInstrDiag_Vmclear_PtrVmxon,
3435 kVmxVInstrDiag_Vmclear_PtrWidth,
3436 kVmxVInstrDiag_Vmclear_RealOrV86Mode,
3437 kVmxVInstrDiag_Vmclear_Success,
3438 kVmxVInstrDiag_Vmclear_VmxRoot,
3439 /* VMWRITE. */
3440 kVmxVInstrDiag_Vmwrite_Cpl,
3441 kVmxVInstrDiag_Vmwrite_FieldInvalid,
3442 kVmxVInstrDiag_Vmwrite_FieldRo,
3443 kVmxVInstrDiag_Vmwrite_LinkPtrInvalid,
3444 kVmxVInstrDiag_Vmwrite_LongModeCS,
3445 kVmxVInstrDiag_Vmwrite_PtrInvalid,
3446 kVmxVInstrDiag_Vmwrite_PtrMap,
3447 kVmxVInstrDiag_Vmwrite_RealOrV86Mode,
3448 kVmxVInstrDiag_Vmwrite_Success,
3449 kVmxVInstrDiag_Vmwrite_VmxRoot,
3450 /* VMREAD. */
3451 kVmxVInstrDiag_Vmread_Cpl,
3452 kVmxVInstrDiag_Vmread_FieldInvalid,
3453 kVmxVInstrDiag_Vmread_LinkPtrInvalid,
3454 kVmxVInstrDiag_Vmread_LongModeCS,
3455 kVmxVInstrDiag_Vmread_PtrInvalid,
3456 kVmxVInstrDiag_Vmread_PtrMap,
3457 kVmxVInstrDiag_Vmread_RealOrV86Mode,
3458 kVmxVInstrDiag_Vmread_Success,
3459 kVmxVInstrDiag_Vmread_VmxRoot,
3460 /* VMLAUNCH/VMRESUME. */
3461 kVmxVInstrDiag_Vmentry_AddrApicAccess,
3462 kVmxVInstrDiag_Vmentry_AddrEntryMsrLoad,
3463 kVmxVInstrDiag_Vmentry_AddrExitMsrLoad,
3464 kVmxVInstrDiag_Vmentry_AddrExitMsrStore,
3465 kVmxVInstrDiag_Vmentry_AddrIoBitmapA,
3466 kVmxVInstrDiag_Vmentry_AddrIoBitmapB,
3467 kVmxVInstrDiag_Vmentry_AddrMsrBitmap,
3468 kVmxVInstrDiag_Vmentry_AddrVirtApicPage,
3469 kVmxVInstrDiag_Vmentry_AddrVmreadBitmap,
3470 kVmxVInstrDiag_Vmentry_AddrVmwriteBitmap,
3471 kVmxVInstrDiag_Vmentry_ApicRegVirt,
3472 kVmxVInstrDiag_Vmentry_BlocKMovSS,
3473 kVmxVInstrDiag_Vmentry_Cpl,
3474 kVmxVInstrDiag_Vmentry_Cr3TargetCount,
3475 kVmxVInstrDiag_Vmentry_EntryCtlsAllowed1,
3476 kVmxVInstrDiag_Vmentry_EntryCtlsDisallowed0,
3477 kVmxVInstrDiag_Vmentry_EntryInstrLen,
3478 kVmxVInstrDiag_Vmentry_EntryInstrLenZero,
3479 kVmxVInstrDiag_Vmentry_EntryIntInfoErrCodePe,
3480 kVmxVInstrDiag_Vmentry_EntryIntInfoErrCodeVec,
3481 kVmxVInstrDiag_Vmentry_EntryIntInfoTypeVecRsvd,
3482 kVmxVInstrDiag_Vmentry_EntryXcptErrCodeRsvd,
3483 kVmxVInstrDiag_Vmentry_ExitCtlsAllowed1,
3484 kVmxVInstrDiag_Vmentry_ExitCtlsDisallowed0,
3485 kVmxVInstrDiag_Vmentry_LongModeCS,
3486 kVmxVInstrDiag_Vmentry_NmiWindowExit,
3487 kVmxVInstrDiag_Vmentry_PinCtlsAllowed1,
3488 kVmxVInstrDiag_Vmentry_PinCtlsDisallowed0,
3489 kVmxVInstrDiag_Vmentry_ProcCtlsDisallowed0,
3490 kVmxVInstrDiag_Vmentry_ProcCtlsAllowed1,
3491 kVmxVInstrDiag_Vmentry_ProcCtls2Disallowed0,
3492 kVmxVInstrDiag_Vmentry_ProcCtls2Allowed1,
3493 kVmxVInstrDiag_Vmentry_PtrInvalid,
3494 kVmxVInstrDiag_Vmentry_PtrReadPhys,
3495 kVmxVInstrDiag_Vmentry_RealOrV86Mode,
3496 kVmxVInstrDiag_Vmentry_SavePreemptTimer,
3497 kVmxVInstrDiag_Vmentry_Success,
3498 kVmxVInstrDiag_Vmentry_TprThreshold,
3499 kVmxVInstrDiag_Vmentry_TprThresholdVTpr,
3500 kVmxVInstrDiag_Vmentry_VirtApicPagePtrReadPhys,
3501 kVmxVInstrDiag_Vmentry_VirtIntDelivery,
3502 kVmxVInstrDiag_Vmentry_VirtNmi,
3503 kVmxVInstrDiag_Vmentry_VirtX2ApicTprShadow,
3504 kVmxVInstrDiag_Vmentry_VirtX2ApicVirtApic,
3505 kVmxVInstrDiag_Vmentry_VmcsClear,
3506 kVmxVInstrDiag_Vmentry_VmcsLaunch,
3507 kVmxVInstrDiag_Vmentry_VmreadBitmapPtrReadPhys,
3508 kVmxVInstrDiag_Vmentry_VmwriteBitmapPtrReadPhys,
3509 kVmxVInstrDiag_Vmentry_VmxRoot,
3510 kVmxVInstrDiag_Vmentry_Vpid,
3511 /* Last member for determining array index limit. */
3512 kVmxVInstrDiag_Last
3513} VMXVINSTRDIAG;
3514AssertCompileSize(VMXVINSTRDIAG, 4);
3515
3516
3517/** @defgroup grp_hm_vmx_inline VMX Inline Helpers
3518 * @{
3519 */
3520/**
3521 * Gets the effective width of a VMCS field given it's encoding adjusted for
3522 * HIGH/FULL access for 64-bit fields.
3523 *
3524 * @returns The effective VMCS field width.
3525 * @param uFieldEnc The VMCS field encoding.
3526 *
3527 * @remarks Warning! This function does not verify the encoding is for a valid and
3528 * supported VMCS field.
3529 */
3530DECLINLINE(uint8_t) HMVmxGetVmcsFieldWidthEff(uint32_t uFieldEnc)
3531{
3532 /* Only the "HIGH" parts of all 64-bit fields have bit 0 set. */
3533 if (uFieldEnc & RT_BIT(0))
3534 return VMXVMCSFIELDWIDTH_32BIT;
3535
3536 /* Bits 13:14 contains the width of the VMCS field, see VMXVMCSFIELDWIDTH_XXX. */
3537 return (uFieldEnc >> 13) & 0x3;
3538}
3539
3540/**
3541 * Returns whether the given VMCS field is a read-only VMCS field or not.
3542 *
3543 * @returns @c true if it's a read-only field, @c false otherwise.
3544 * @param uFieldEnc The VMCS field encoding.
3545 *
3546 * @remarks Warning! This function does not verify the encoding is for a valid and
3547 * supported VMCS field.
3548 */
3549DECLINLINE(bool) HMVmxIsVmcsFieldReadOnly(uint32_t uFieldEnc)
3550{
3551 /* See Intel spec. B.4.2 "Natural-Width Read-Only Data Fields". */
3552 return (RT_BF_GET(uFieldEnc, VMX_BF_VMCS_ENC_TYPE) == VMXVMCSFIELDTYPE_VMEXIT_INFO);
3553}
3554
3555/**
3556 * Returns whether the given VM-entry interruption-information type is valid or not.
3557 *
3558 * @returns @c true if it's a valid type, @c false otherwise.
3559 * @param fSupportsMtf Whether the monitor-trap flag CPU feature is supported.
3560 * @param uType The VM-entry interruption-information type.
3561 */
3562DECLINLINE(bool) HMVmxIsEntryIntInfoTypeValid(bool fSupportsMtf, uint8_t uType)
3563{
3564 /* See Intel spec. 26.2.1.3 "VM-Entry Control Fields". */
3565 switch (uType)
3566 {
3567 case VMX_ENTRY_INT_INFO_TYPE_EXT_INT:
3568 case VMX_ENTRY_INT_INFO_TYPE_NMI:
3569 case VMX_ENTRY_INT_INFO_TYPE_HW_XCPT:
3570 case VMX_ENTRY_INT_INFO_TYPE_SW_INT:
3571 case VMX_ENTRY_INT_INFO_TYPE_PRIV_SW_XCPT:
3572 case VMX_ENTRY_INT_INFO_TYPE_SW_XCPT: return true;
3573 case VMX_ENTRY_INT_INFO_TYPE_OTHER_EVENT: return fSupportsMtf;
3574 default:
3575 return false;
3576 }
3577}
3578
3579/**
3580 * Returns whether the given VM-entry interruption-information vector and type
3581 * combination is valid or not.
3582 *
3583 * @returns @c true if it's a valid vector/type combination, @c false otherwise.
3584 * @param uVector The VM-entry interruption-information vector.
3585 * @param uType The VM-entry interruption-information type.
3586 *
3587 * @remarks Warning! This function does not validate the type field individually.
3588 * Use it after verifying type is valid using HMVmxIsEntryIntInfoTypeValid.
3589 */
3590DECLINLINE(bool) HMVmxIsEntryIntInfoVectorValid(uint8_t uVector, uint8_t uType)
3591{
3592 /* See Intel spec. 26.2.1.3 "VM-Entry Control Fields". */
3593 if ( uType == VMX_ENTRY_INT_INFO_TYPE_NMI
3594 && uVector != X86_XCPT_NMI)
3595 return false;
3596 if ( uType == VMX_ENTRY_INT_INFO_TYPE_HW_XCPT
3597 && uVector > X86_XCPT_LAST)
3598 return false;
3599 if ( uType == VMX_ENTRY_INT_INFO_TYPE_OTHER_EVENT
3600 && uVector != 0)
3601 return false;
3602 return true;
3603}
3604/** @} */
3605
3606
3607/** @defgroup grp_hm_vmx_asm VMX Assembly Helpers
3608 * @{
3609 */
3610
3611/**
3612 * Restores some host-state fields that need not be done on every VM-exit.
3613 *
3614 * @returns VBox status code.
3615 * @param fRestoreHostFlags Flags of which host registers needs to be
3616 * restored.
3617 * @param pRestoreHost Pointer to the host-restore structure.
3618 */
3619DECLASM(int) VMXRestoreHostState(uint32_t fRestoreHostFlags, PVMXRESTOREHOST pRestoreHost);
3620
3621
3622/**
3623 * Dispatches an NMI to the host.
3624 */
3625DECLASM(int) VMXDispatchHostNmi(void);
3626
3627
3628/**
3629 * Executes VMXON.
3630 *
3631 * @returns VBox status code.
3632 * @param HCPhysVmxOn Physical address of VMXON structure.
3633 */
3634#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
3635DECLASM(int) VMXEnable(RTHCPHYS HCPhysVmxOn);
3636#else
3637DECLINLINE(int) VMXEnable(RTHCPHYS HCPhysVmxOn)
3638{
3639# if RT_INLINE_ASM_GNU_STYLE
3640 int rc = VINF_SUCCESS;
3641 __asm__ __volatile__ (
3642 "push %3 \n\t"
3643 "push %2 \n\t"
3644 ".byte 0xf3, 0x0f, 0xc7, 0x34, 0x24 # VMXON [esp] \n\t"
3645 "ja 2f \n\t"
3646 "je 1f \n\t"
3647 "movl $" RT_XSTR(VERR_VMX_INVALID_VMXON_PTR)", %0 \n\t"
3648 "jmp 2f \n\t"
3649 "1: \n\t"
3650 "movl $" RT_XSTR(VERR_VMX_VMXON_FAILED)", %0 \n\t"
3651 "2: \n\t"
3652 "add $8, %%esp \n\t"
3653 :"=rm"(rc)
3654 :"0"(VINF_SUCCESS),
3655 "ir"((uint32_t)HCPhysVmxOn), /* don't allow direct memory reference here, */
3656 "ir"((uint32_t)(HCPhysVmxOn >> 32)) /* this would not work with -fomit-frame-pointer */
3657 :"memory"
3658 );
3659 return rc;
3660
3661# elif VMX_USE_MSC_INTRINSICS
3662 unsigned char rcMsc = __vmx_on(&HCPhysVmxOn);
3663 if (RT_LIKELY(rcMsc == 0))
3664 return VINF_SUCCESS;
3665 return rcMsc == 2 ? VERR_VMX_INVALID_VMXON_PTR : VERR_VMX_VMXON_FAILED;
3666
3667# else
3668 int rc = VINF_SUCCESS;
3669 __asm
3670 {
3671 push dword ptr [HCPhysVmxOn + 4]
3672 push dword ptr [HCPhysVmxOn]
3673 _emit 0xf3
3674 _emit 0x0f
3675 _emit 0xc7
3676 _emit 0x34
3677 _emit 0x24 /* VMXON [esp] */
3678 jnc vmxon_good
3679 mov dword ptr [rc], VERR_VMX_INVALID_VMXON_PTR
3680 jmp the_end
3681
3682vmxon_good:
3683 jnz the_end
3684 mov dword ptr [rc], VERR_VMX_VMXON_FAILED
3685the_end:
3686 add esp, 8
3687 }
3688 return rc;
3689# endif
3690}
3691#endif
3692
3693
3694/**
3695 * Executes VMXOFF.
3696 */
3697#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
3698DECLASM(void) VMXDisable(void);
3699#else
3700DECLINLINE(void) VMXDisable(void)
3701{
3702# if RT_INLINE_ASM_GNU_STYLE
3703 __asm__ __volatile__ (
3704 ".byte 0x0f, 0x01, 0xc4 # VMXOFF \n\t"
3705 );
3706
3707# elif VMX_USE_MSC_INTRINSICS
3708 __vmx_off();
3709
3710# else
3711 __asm
3712 {
3713 _emit 0x0f
3714 _emit 0x01
3715 _emit 0xc4 /* VMXOFF */
3716 }
3717# endif
3718}
3719#endif
3720
3721
3722/**
3723 * Executes VMCLEAR.
3724 *
3725 * @returns VBox status code.
3726 * @param HCPhysVmcs Physical address of VM control structure.
3727 */
3728#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
3729DECLASM(int) VMXClearVmcs(RTHCPHYS HCPhysVmcs);
3730#else
3731DECLINLINE(int) VMXClearVmcs(RTHCPHYS HCPhysVmcs)
3732{
3733# if RT_INLINE_ASM_GNU_STYLE
3734 int rc = VINF_SUCCESS;
3735 __asm__ __volatile__ (
3736 "push %3 \n\t"
3737 "push %2 \n\t"
3738 ".byte 0x66, 0x0f, 0xc7, 0x34, 0x24 # VMCLEAR [esp] \n\t"
3739 "jnc 1f \n\t"
3740 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
3741 "1: \n\t"
3742 "add $8, %%esp \n\t"
3743 :"=rm"(rc)
3744 :"0"(VINF_SUCCESS),
3745 "ir"((uint32_t)HCPhysVmcs), /* don't allow direct memory reference here, */
3746 "ir"((uint32_t)(HCPhysVmcs >> 32)) /* this would not work with -fomit-frame-pointer */
3747 :"memory"
3748 );
3749 return rc;
3750
3751# elif VMX_USE_MSC_INTRINSICS
3752 unsigned char rcMsc = __vmx_vmclear(&HCPhysVmcs);
3753 if (RT_LIKELY(rcMsc == 0))
3754 return VINF_SUCCESS;
3755 return VERR_VMX_INVALID_VMCS_PTR;
3756
3757# else
3758 int rc = VINF_SUCCESS;
3759 __asm
3760 {
3761 push dword ptr [HCPhysVmcs + 4]
3762 push dword ptr [HCPhysVmcs]
3763 _emit 0x66
3764 _emit 0x0f
3765 _emit 0xc7
3766 _emit 0x34
3767 _emit 0x24 /* VMCLEAR [esp] */
3768 jnc success
3769 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
3770success:
3771 add esp, 8
3772 }
3773 return rc;
3774# endif
3775}
3776#endif
3777
3778
3779/**
3780 * Executes VMPTRLD.
3781 *
3782 * @returns VBox status code.
3783 * @param HCPhysVmcs Physical address of VMCS structure.
3784 */
3785#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
3786DECLASM(int) VMXActivateVmcs(RTHCPHYS HCPhysVmcs);
3787#else
3788DECLINLINE(int) VMXActivateVmcs(RTHCPHYS HCPhysVmcs)
3789{
3790# if RT_INLINE_ASM_GNU_STYLE
3791 int rc = VINF_SUCCESS;
3792 __asm__ __volatile__ (
3793 "push %3 \n\t"
3794 "push %2 \n\t"
3795 ".byte 0x0f, 0xc7, 0x34, 0x24 # VMPTRLD [esp] \n\t"
3796 "jnc 1f \n\t"
3797 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
3798 "1: \n\t"
3799 "add $8, %%esp \n\t"
3800 :"=rm"(rc)
3801 :"0"(VINF_SUCCESS),
3802 "ir"((uint32_t)HCPhysVmcs), /* don't allow direct memory reference here, */
3803 "ir"((uint32_t)(HCPhysVmcs >> 32)) /* this will not work with -fomit-frame-pointer */
3804 );
3805 return rc;
3806
3807# elif VMX_USE_MSC_INTRINSICS
3808 unsigned char rcMsc = __vmx_vmptrld(&HCPhysVmcs);
3809 if (RT_LIKELY(rcMsc == 0))
3810 return VINF_SUCCESS;
3811 return VERR_VMX_INVALID_VMCS_PTR;
3812
3813# else
3814 int rc = VINF_SUCCESS;
3815 __asm
3816 {
3817 push dword ptr [HCPhysVmcs + 4]
3818 push dword ptr [HCPhysVmcs]
3819 _emit 0x0f
3820 _emit 0xc7
3821 _emit 0x34
3822 _emit 0x24 /* VMPTRLD [esp] */
3823 jnc success
3824 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
3825
3826success:
3827 add esp, 8
3828 }
3829 return rc;
3830# endif
3831}
3832#endif
3833
3834
3835/**
3836 * Executes VMPTRST.
3837 *
3838 * @returns VBox status code.
3839 * @param pHCPhysVmcs Where to store the physical address of the current
3840 * VMCS.
3841 */
3842DECLASM(int) VMXGetActivatedVmcs(RTHCPHYS *pHCPhysVmcs);
3843
3844
3845/**
3846 * Executes VMWRITE.
3847 *
3848 * @returns VBox status code.
3849 * @retval VINF_SUCCESS.
3850 * @retval VERR_VMX_INVALID_VMCS_PTR.
3851 * @retval VERR_VMX_INVALID_VMCS_FIELD.
3852 *
3853 * @param uFieldEnc VMCS field encoding.
3854 * @param u32Val The 32-bit value to set.
3855 *
3856 * @remarks The values of the two status codes can be OR'ed together, the result
3857 * will be VERR_VMX_INVALID_VMCS_PTR.
3858 */
3859#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
3860DECLASM(int) VMXWriteVmcs32(uint32_t uFieldEnc, uint32_t u32Val);
3861#else
3862DECLINLINE(int) VMXWriteVmcs32(uint32_t uFieldEnc, uint32_t u32Val)
3863{
3864# if RT_INLINE_ASM_GNU_STYLE
3865 int rc = VINF_SUCCESS;
3866 __asm__ __volatile__ (
3867 ".byte 0x0f, 0x79, 0xc2 # VMWRITE eax, edx \n\t"
3868 "ja 2f \n\t"
3869 "je 1f \n\t"
3870 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
3871 "jmp 2f \n\t"
3872 "1: \n\t"
3873 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_FIELD)", %0 \n\t"
3874 "2: \n\t"
3875 :"=rm"(rc)
3876 :"0"(VINF_SUCCESS),
3877 "a"(uFieldEnc),
3878 "d"(u32Val)
3879 );
3880 return rc;
3881
3882# elif VMX_USE_MSC_INTRINSICS
3883 unsigned char rcMsc = __vmx_vmwrite(uFieldEnc, u32Val);
3884 if (RT_LIKELY(rcMsc == 0))
3885 return VINF_SUCCESS;
3886 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
3887
3888#else
3889 int rc = VINF_SUCCESS;
3890 __asm
3891 {
3892 push dword ptr [u32Val]
3893 mov eax, [uFieldEnc]
3894 _emit 0x0f
3895 _emit 0x79
3896 _emit 0x04
3897 _emit 0x24 /* VMWRITE eax, [esp] */
3898 jnc valid_vmcs
3899 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
3900 jmp the_end
3901
3902valid_vmcs:
3903 jnz the_end
3904 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_FIELD
3905the_end:
3906 add esp, 4
3907 }
3908 return rc;
3909# endif
3910}
3911#endif
3912
3913/**
3914 * Executes VMWRITE.
3915 *
3916 * @returns VBox status code.
3917 * @retval VINF_SUCCESS.
3918 * @retval VERR_VMX_INVALID_VMCS_PTR.
3919 * @retval VERR_VMX_INVALID_VMCS_FIELD.
3920 *
3921 * @param uFieldEnc The VMCS field encoding.
3922 * @param u64Val The 16, 32 or 64-bit value to set.
3923 *
3924 * @remarks The values of the two status codes can be OR'ed together, the result
3925 * will be VERR_VMX_INVALID_VMCS_PTR.
3926 */
3927#if !defined(RT_ARCH_X86)
3928# if !VMX_USE_MSC_INTRINSICS || ARCH_BITS != 64
3929DECLASM(int) VMXWriteVmcs64(uint32_t uFieldEnc, uint64_t u64Val);
3930# else /* VMX_USE_MSC_INTRINSICS */
3931DECLINLINE(int) VMXWriteVmcs64(uint32_t uFieldEnc, uint64_t u64Val)
3932{
3933 unsigned char rcMsc = __vmx_vmwrite(uFieldEnc, u64Val);
3934 if (RT_LIKELY(rcMsc == 0))
3935 return VINF_SUCCESS;
3936 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
3937}
3938# endif /* VMX_USE_MSC_INTRINSICS */
3939#else
3940# define VMXWriteVmcs64(uFieldEnc, u64Val) VMXWriteVmcs64Ex(pVCpu, uFieldEnc, u64Val) /** @todo dead ugly, picking up pVCpu like this */
3941VMMR0DECL(int) VMXWriteVmcs64Ex(PVMCPU pVCpu, uint32_t uFieldEnc, uint64_t u64Val);
3942#endif
3943
3944#if ARCH_BITS == 32
3945# define VMXWriteVmcsHstN VMXWriteVmcs32
3946# define VMXWriteVmcsGstN(uFieldEnc, u64Val) VMXWriteVmcs64Ex(pVCpu, uFieldEnc, u64Val)
3947#else /* ARCH_BITS == 64 */
3948# define VMXWriteVmcsHstN VMXWriteVmcs64
3949# define VMXWriteVmcsGstN VMXWriteVmcs64
3950#endif
3951
3952
3953/**
3954 * Invalidate a page using INVEPT.
3955 *
3956 * @returns VBox status code.
3957 * @param enmFlush Type of flush.
3958 * @param pDescriptor Pointer to the descriptor.
3959 */
3960DECLASM(int) VMXR0InvEPT(VMXTLBFLUSHEPT enmFlush, uint64_t *pDescriptor);
3961
3962
3963/**
3964 * Invalidate a page using INVVPID.
3965 *
3966 * @returns VBox status code.
3967 * @param enmFlush Type of flush.
3968 * @param pDescriptor Pointer to the descriptor.
3969 */
3970DECLASM(int) VMXR0InvVPID(VMXTLBFLUSHVPID enmFlush, uint64_t *pDescriptor);
3971
3972
3973/**
3974 * Executes VMREAD for a 32-bit field.
3975 *
3976 * @returns VBox status code.
3977 * @retval VINF_SUCCESS.
3978 * @retval VERR_VMX_INVALID_VMCS_PTR.
3979 * @retval VERR_VMX_INVALID_VMCS_FIELD.
3980 *
3981 * @param uFieldEnc The VMCS field encoding.
3982 * @param pData Where to store VMCS field value.
3983 *
3984 * @remarks The values of the two status codes can be OR'ed together, the result
3985 * will be VERR_VMX_INVALID_VMCS_PTR.
3986 */
3987#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
3988DECLASM(int) VMXReadVmcs32(uint32_t uFieldEnc, uint32_t *pData);
3989#else
3990DECLINLINE(int) VMXReadVmcs32(uint32_t uFieldEnc, uint32_t *pData)
3991{
3992# if RT_INLINE_ASM_GNU_STYLE
3993 int rc = VINF_SUCCESS;
3994 __asm__ __volatile__ (
3995 "movl $" RT_XSTR(VINF_SUCCESS)", %0 \n\t"
3996 ".byte 0x0f, 0x78, 0xc2 # VMREAD eax, edx \n\t"
3997 "ja 2f \n\t"
3998 "je 1f \n\t"
3999 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
4000 "jmp 2f \n\t"
4001 "1: \n\t"
4002 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_FIELD)", %0 \n\t"
4003 "2: \n\t"
4004 :"=&r"(rc),
4005 "=d"(*pData)
4006 :"a"(uFieldEnc),
4007 "d"(0)
4008 );
4009 return rc;
4010
4011# elif VMX_USE_MSC_INTRINSICS
4012 unsigned char rcMsc;
4013# if ARCH_BITS == 32
4014 rcMsc = __vmx_vmread(uFieldEnc, pData);
4015# else
4016 uint64_t u64Tmp;
4017 rcMsc = __vmx_vmread(uFieldEnc, &u64Tmp);
4018 *pData = (uint32_t)u64Tmp;
4019# endif
4020 if (RT_LIKELY(rcMsc == 0))
4021 return VINF_SUCCESS;
4022 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
4023
4024#else
4025 int rc = VINF_SUCCESS;
4026 __asm
4027 {
4028 sub esp, 4
4029 mov dword ptr [esp], 0
4030 mov eax, [uFieldEnc]
4031 _emit 0x0f
4032 _emit 0x78
4033 _emit 0x04
4034 _emit 0x24 /* VMREAD eax, [esp] */
4035 mov edx, pData
4036 pop dword ptr [edx]
4037 jnc valid_vmcs
4038 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
4039 jmp the_end
4040
4041valid_vmcs:
4042 jnz the_end
4043 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_FIELD
4044the_end:
4045 }
4046 return rc;
4047# endif
4048}
4049#endif
4050
4051/**
4052 * Executes VMREAD for a 64-bit field.
4053 *
4054 * @returns VBox status code.
4055 * @retval VINF_SUCCESS.
4056 * @retval VERR_VMX_INVALID_VMCS_PTR.
4057 * @retval VERR_VMX_INVALID_VMCS_FIELD.
4058 *
4059 * @param uFieldEnc The VMCS field encoding.
4060 * @param pData Where to store VMCS field value.
4061 *
4062 * @remarks The values of the two status codes can be OR'ed together, the result
4063 * will be VERR_VMX_INVALID_VMCS_PTR.
4064 */
4065#if (!defined(RT_ARCH_X86) && !VMX_USE_MSC_INTRINSICS)
4066DECLASM(int) VMXReadVmcs64(uint32_t uFieldEnc, uint64_t *pData);
4067#else
4068DECLINLINE(int) VMXReadVmcs64(uint32_t uFieldEnc, uint64_t *pData)
4069{
4070# if VMX_USE_MSC_INTRINSICS
4071 unsigned char rcMsc;
4072# if ARCH_BITS == 32
4073 size_t uLow;
4074 size_t uHigh;
4075 rcMsc = __vmx_vmread(uFieldEnc, &uLow);
4076 rcMsc |= __vmx_vmread(uFieldEnc + 1, &uHigh);
4077 *pData = RT_MAKE_U64(uLow, uHigh);
4078# else
4079 rcMsc = __vmx_vmread(uFieldEnc, pData);
4080# endif
4081 if (RT_LIKELY(rcMsc == 0))
4082 return VINF_SUCCESS;
4083 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
4084
4085# elif ARCH_BITS == 32
4086 int rc;
4087 uint32_t val_hi, val;
4088 rc = VMXReadVmcs32(uFieldEnc, &val);
4089 rc |= VMXReadVmcs32(uFieldEnc + 1, &val_hi);
4090 AssertRC(rc);
4091 *pData = RT_MAKE_U64(val, val_hi);
4092 return rc;
4093
4094# else
4095# error "Shouldn't be here..."
4096# endif
4097}
4098#endif
4099
4100
4101/**
4102 * Gets the last instruction error value from the current VMCS.
4103 *
4104 * @returns VBox status code.
4105 */
4106DECLINLINE(uint32_t) VMXGetLastError(void)
4107{
4108#if ARCH_BITS == 64
4109 uint64_t uLastError = 0;
4110 int rc = VMXReadVmcs64(VMX_VMCS32_RO_VM_INSTR_ERROR, &uLastError);
4111 AssertRC(rc);
4112 return (uint32_t)uLastError;
4113
4114#else /* 32-bit host: */
4115 uint32_t uLastError = 0;
4116 int rc = VMXReadVmcs32(VMX_VMCS32_RO_VM_INSTR_ERROR, &uLastError);
4117 AssertRC(rc);
4118 return uLastError;
4119#endif
4120}
4121
4122/** @} */
4123
4124/** @} */
4125
4126#endif
4127
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