cpum-x86-amd64.h

Last change on this file was 107650, checked in by vboxsync, 5 weeks ago
VMM/CPUM,++: Made the HostFeatures match the host when targeting x86 guests on arm64 hosts. Merged and deduplicated code targeting x86 & amd64. jiraref:VBP-1470
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 90.2 KB

Line
1	/** @file
2	* CPUM - CPU Monitor(/ Manager).
3	*/
4
5	/*
6	* Copyright (C) 2006-2024 Oracle and/or its affiliates.
7	*
8	* This file is part of VirtualBox base platform packages, as
9	* available from https://www.virtualbox.org.
10	*
11	* This program is free software; you can redistribute it and/or
12	* modify it under the terms of the GNU General Public License
13	* as published by the Free Software Foundation, in version 3 of the
14	* License.
15	*
16	* This program is distributed in the hope that it will be useful, but
17	* WITHOUT ANY WARRANTY; without even the implied warranty of
18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19	* General Public License for more details.
20	*
21	* You should have received a copy of the GNU General Public License
22	* along with this program; if not, see <https://www.gnu.org/licenses>.
23	*
24	* The contents of this file may alternatively be used under the terms
25	* of the Common Development and Distribution License Version 1.0
26	* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27	* in the VirtualBox distribution, in which case the provisions of the
28	* CDDL are applicable instead of those of the GPL.
29	*
30	* You may elect to license modified versions of this file under the
31	* terms and conditions of either the GPL or the CDDL or both.
32	*
33	* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34	*/
35
36	#ifndef VBOX_INCLUDED_vmm_cpum_x86_amd64_h
37	#define VBOX_INCLUDED_vmm_cpum_x86_amd64_h
38	#ifndef RT_WITHOUT_PRAGMA_ONCE
39	# pragma once
40	#endif
41
42	#include <iprt/x86.h>
43	#include <VBox/vmm/hm_svm.h>
44	#include <VBox/vmm/hm_vmx.h>
45
46	RT_C_DECLS_BEGIN
47
48	/** @defgroup grp_cpum The CPU Monitor / Manager API
49	* @ingroup grp_vmm
50	* @{
51	*/
52
53	/**
54	* CPUID feature to set or clear.
55	*/
56	typedef enum CPUMCPUIDFEATURE
57	{
58	CPUMCPUIDFEATURE_INVALID = 0,
59	/** The APIC feature bit. (Std+Ext)
60	* Note! There is a per-cpu flag for masking this CPUID feature bit when the
61	* APICBASE.ENABLED bit is zero. So, this feature is only set/cleared
62	* at VM construction time like all the others. This didn't used to be
63	* that way, this is new with 5.1. */
64	CPUMCPUIDFEATURE_APIC,
65	/** The sysenter/sysexit feature bit. (Std) */
66	CPUMCPUIDFEATURE_SEP,
67	/** The SYSCALL/SYSEXIT feature bit (64 bits mode only for Intel CPUs). (Ext) */
68	CPUMCPUIDFEATURE_SYSCALL,
69	/** The PAE feature bit. (Std+Ext) */
70	CPUMCPUIDFEATURE_PAE,
71	/** The NX feature bit. (Ext) */
72	CPUMCPUIDFEATURE_NX,
73	/** The LAHF/SAHF feature bit (64 bits mode only). (Ext) */
74	CPUMCPUIDFEATURE_LAHF,
75	/** The LONG MODE feature bit. (Ext) */
76	CPUMCPUIDFEATURE_LONG_MODE,
77	/** The x2APIC feature bit. (Std) */
78	CPUMCPUIDFEATURE_X2APIC,
79	/** The RDTSCP feature bit. (Ext) */
80	CPUMCPUIDFEATURE_RDTSCP,
81	/** The Hypervisor Present bit. (Std) */
82	CPUMCPUIDFEATURE_HVP,
83	/** The speculation control feature bits. (StExt) */
84	CPUMCPUIDFEATURE_SPEC_CTRL,
85	/** 32bit hackishness. */
86	CPUMCPUIDFEATURE_32BIT_HACK = 0x7fffffff
87	} CPUMCPUIDFEATURE;
88
89
90	/**
91	* CPUID leaf.
92	*
93	* @remarks This structure is used by the patch manager and is therefore
94	* more or less set in stone.
95	*/
96	typedef struct CPUMCPUIDLEAF
97	{
98	/** The leaf number. */
99	uint32_t uLeaf;
100	/** The sub-leaf number. */
101	uint32_t uSubLeaf;
102	/** Sub-leaf mask. This is 0 when sub-leaves aren't used. */
103	uint32_t fSubLeafMask;
104
105	/** The EAX value. */
106	uint32_t uEax;
107	/** The EBX value. */
108	uint32_t uEbx;
109	/** The ECX value. */
110	uint32_t uEcx;
111	/** The EDX value. */
112	uint32_t uEdx;
113
114	/** Flags. */
115	uint32_t fFlags;
116	} CPUMCPUIDLEAF;
117	#ifndef VBOX_FOR_DTRACE_LIB
118	AssertCompileSize(CPUMCPUIDLEAF, 32);
119	#endif
120	/** Pointer to a CPUID leaf. */
121	typedef CPUMCPUIDLEAF *PCPUMCPUIDLEAF;
122	/** Pointer to a const CPUID leaf. */
123	typedef CPUMCPUIDLEAF const *PCCPUMCPUIDLEAF;
124
125	/** @name CPUMCPUIDLEAF::fFlags
126	* @{ */
127	/** Indicates working intel leaf 0xb where the lower 8 ECX bits are not modified
128	* and EDX containing the extended APIC ID. */
129	#define CPUMCPUIDLEAF_F_INTEL_TOPOLOGY_SUBLEAVES RT_BIT_32(0)
130	/** The leaf contains an APIC ID that needs changing to that of the current CPU. */
131	#define CPUMCPUIDLEAF_F_CONTAINS_APIC_ID RT_BIT_32(1)
132	/** The leaf contains an OSXSAVE which needs individual handling on each CPU. */
133	#define CPUMCPUIDLEAF_F_CONTAINS_OSXSAVE RT_BIT_32(2)
134	/** The leaf contains an APIC feature bit which is tied to APICBASE.EN. */
135	#define CPUMCPUIDLEAF_F_CONTAINS_APIC RT_BIT_32(3)
136	/** Mask of the valid flags. */
137	#define CPUMCPUIDLEAF_F_VALID_MASK UINT32_C(0xf)
138	/** @} */
139
140	/**
141	* Method used to deal with unknown CPUID leaves.
142	* @remarks Used in patch code.
143	*/
144	typedef enum CPUMUNKNOWNCPUID
145	{
146	/** Invalid zero value. */
147	CPUMUNKNOWNCPUID_INVALID = 0,
148	/** Use given default values (DefCpuId). */
149	CPUMUNKNOWNCPUID_DEFAULTS,
150	/** Return the last standard leaf.
151	* Intel Sandy Bridge has been observed doing this. */
152	CPUMUNKNOWNCPUID_LAST_STD_LEAF,
153	/** Return the last standard leaf, with ecx observed.
154	* Intel Sandy Bridge has been observed doing this. */
155	CPUMUNKNOWNCPUID_LAST_STD_LEAF_WITH_ECX,
156	/** The register values are passed thru unmodified. */
157	CPUMUNKNOWNCPUID_PASSTHRU,
158	/** End of valid value. */
159	CPUMUNKNOWNCPUID_END,
160	/** Ensure 32-bit type. */
161	CPUMUNKNOWNCPUID_32BIT_HACK = 0x7fffffff
162	} CPUMUNKNOWNCPUID;
163	/** Pointer to unknown CPUID leaf method. */
164	typedef CPUMUNKNOWNCPUID *PCPUMUNKNOWNCPUID;
165
166
167	/**
168	* The register set returned by a CPUID operation.
169	*/
170	typedef struct CPUMCPUID
171	{
172	uint32_t uEax;
173	uint32_t uEbx;
174	uint32_t uEcx;
175	uint32_t uEdx;
176	} CPUMCPUID;
177	/** Pointer to a CPUID leaf. */
178	typedef CPUMCPUID *PCPUMCPUID;
179	/** Pointer to a const CPUID leaf. */
180	typedef const CPUMCPUID *PCCPUMCPUID;
181
182
183	/**
184	* MSR read functions.
185	*/
186	typedef enum CPUMMSRRDFN
187	{
188	/** Invalid zero value. */
189	kCpumMsrRdFn_Invalid = 0,
190	/** Return the CPUMMSRRANGE::uValue. */
191	kCpumMsrRdFn_FixedValue,
192	/** Alias to the MSR range starting at the MSR given by
193	* CPUMMSRRANGE::uValue. Must be used in pair with
194	* kCpumMsrWrFn_MsrAlias. */
195	kCpumMsrRdFn_MsrAlias,
196	/** Write only register, GP all read attempts. */
197	kCpumMsrRdFn_WriteOnly,
198
199	kCpumMsrRdFn_Ia32P5McAddr,
200	kCpumMsrRdFn_Ia32P5McType,
201	kCpumMsrRdFn_Ia32TimestampCounter,
202	kCpumMsrRdFn_Ia32PlatformId, /*< Takes real CPU value for reference. /
203	kCpumMsrRdFn_Ia32ApicBase,
204	kCpumMsrRdFn_Ia32FeatureControl,
205	kCpumMsrRdFn_Ia32BiosSignId, /*< Range value returned. /
206	kCpumMsrRdFn_Ia32SmmMonitorCtl,
207	kCpumMsrRdFn_Ia32PmcN,
208	kCpumMsrRdFn_Ia32MonitorFilterLineSize,
209	kCpumMsrRdFn_Ia32MPerf,
210	kCpumMsrRdFn_Ia32APerf,
211	kCpumMsrRdFn_Ia32MtrrCap, /*< Takes real CPU value for reference. /
212	kCpumMsrRdFn_Ia32MtrrPhysBaseN, /*< Takes register number. /
213	kCpumMsrRdFn_Ia32MtrrPhysMaskN, /*< Takes register number. /
214	kCpumMsrRdFn_Ia32MtrrFixed, /*< Takes CPUMCPU offset. /
215	kCpumMsrRdFn_Ia32MtrrDefType,
216	kCpumMsrRdFn_Ia32Pat,
217	kCpumMsrRdFn_Ia32SysEnterCs,
218	kCpumMsrRdFn_Ia32SysEnterEsp,
219	kCpumMsrRdFn_Ia32SysEnterEip,
220	kCpumMsrRdFn_Ia32McgCap,
221	kCpumMsrRdFn_Ia32McgStatus,
222	kCpumMsrRdFn_Ia32McgCtl,
223	kCpumMsrRdFn_Ia32DebugCtl,
224	kCpumMsrRdFn_Ia32SmrrPhysBase,
225	kCpumMsrRdFn_Ia32SmrrPhysMask,
226	kCpumMsrRdFn_Ia32PlatformDcaCap,
227	kCpumMsrRdFn_Ia32CpuDcaCap,
228	kCpumMsrRdFn_Ia32Dca0Cap,
229	kCpumMsrRdFn_Ia32PerfEvtSelN, /*< Range value indicates the register number. /
230	kCpumMsrRdFn_Ia32PerfStatus, /*< Range value returned. /
231	kCpumMsrRdFn_Ia32PerfCtl, /*< Range value returned. /
232	kCpumMsrRdFn_Ia32FixedCtrN, /*< Takes register number of start of range. /
233	kCpumMsrRdFn_Ia32PerfCapabilities, /*< Takes reference value. /
234	kCpumMsrRdFn_Ia32FixedCtrCtrl,
235	kCpumMsrRdFn_Ia32PerfGlobalStatus, /*< Takes reference value. /
236	kCpumMsrRdFn_Ia32PerfGlobalCtrl,
237	kCpumMsrRdFn_Ia32PerfGlobalOvfCtrl,
238	kCpumMsrRdFn_Ia32PebsEnable,
239	kCpumMsrRdFn_Ia32ClockModulation, /*< Range value returned. /
240	kCpumMsrRdFn_Ia32ThermInterrupt, /*< Range value returned. /
241	kCpumMsrRdFn_Ia32ThermStatus, /*< Range value returned. /
242	kCpumMsrRdFn_Ia32Therm2Ctl, /*< Range value returned. /
243	kCpumMsrRdFn_Ia32MiscEnable, /*< Range value returned. /
244	kCpumMsrRdFn_Ia32McCtlStatusAddrMiscN, /*< Takes bank number. /
245	kCpumMsrRdFn_Ia32McNCtl2, /*< Takes register number of start of range. /
246	kCpumMsrRdFn_Ia32DsArea,
247	kCpumMsrRdFn_Ia32TscDeadline,
248	kCpumMsrRdFn_Ia32X2ApicN,
249	kCpumMsrRdFn_Ia32DebugInterface,
250	kCpumMsrRdFn_Ia32VmxBasic, /*< Takes real value as reference. /
251	kCpumMsrRdFn_Ia32VmxPinbasedCtls, /*< Takes real value as reference. /
252	kCpumMsrRdFn_Ia32VmxProcbasedCtls, /*< Takes real value as reference. /
253	kCpumMsrRdFn_Ia32VmxExitCtls, /*< Takes real value as reference. /
254	kCpumMsrRdFn_Ia32VmxEntryCtls, /*< Takes real value as reference. /
255	kCpumMsrRdFn_Ia32VmxMisc, /*< Takes real value as reference. /
256	kCpumMsrRdFn_Ia32VmxCr0Fixed0, /*< Takes real value as reference. /
257	kCpumMsrRdFn_Ia32VmxCr0Fixed1, /*< Takes real value as reference. /
258	kCpumMsrRdFn_Ia32VmxCr4Fixed0, /*< Takes real value as reference. /
259	kCpumMsrRdFn_Ia32VmxCr4Fixed1, /*< Takes real value as reference. /
260	kCpumMsrRdFn_Ia32VmxVmcsEnum, /*< Takes real value as reference. /
261	kCpumMsrRdFn_Ia32VmxProcBasedCtls2, /*< Takes real value as reference. /
262	kCpumMsrRdFn_Ia32VmxEptVpidCap, /*< Takes real value as reference. /
263	kCpumMsrRdFn_Ia32VmxTruePinbasedCtls, /*< Takes real value as reference. /
264	kCpumMsrRdFn_Ia32VmxTrueProcbasedCtls, /*< Takes real value as reference. /
265	kCpumMsrRdFn_Ia32VmxTrueExitCtls, /*< Takes real value as reference. /
266	kCpumMsrRdFn_Ia32VmxTrueEntryCtls, /*< Takes real value as reference. /
267	kCpumMsrRdFn_Ia32VmxVmFunc, /*< Takes real value as reference. /
268	kCpumMsrRdFn_Ia32SpecCtrl,
269	kCpumMsrRdFn_Ia32ArchCapabilities,
270
271	kCpumMsrRdFn_Amd64Efer,
272	kCpumMsrRdFn_Amd64SyscallTarget,
273	kCpumMsrRdFn_Amd64LongSyscallTarget,
274	kCpumMsrRdFn_Amd64CompSyscallTarget,
275	kCpumMsrRdFn_Amd64SyscallFlagMask,
276	kCpumMsrRdFn_Amd64FsBase,
277	kCpumMsrRdFn_Amd64GsBase,
278	kCpumMsrRdFn_Amd64KernelGsBase,
279	kCpumMsrRdFn_Amd64TscAux,
280
281	kCpumMsrRdFn_IntelEblCrPowerOn,
282	kCpumMsrRdFn_IntelI7CoreThreadCount,
283	kCpumMsrRdFn_IntelP4EbcHardPowerOn,
284	kCpumMsrRdFn_IntelP4EbcSoftPowerOn,
285	kCpumMsrRdFn_IntelP4EbcFrequencyId,
286	kCpumMsrRdFn_IntelP6FsbFrequency, /*< Takes real value as reference. /
287	kCpumMsrRdFn_IntelPlatformInfo,
288	kCpumMsrRdFn_IntelFlexRatio, /*< Takes real value as reference. /
289	kCpumMsrRdFn_IntelPkgCStConfigControl,
290	kCpumMsrRdFn_IntelPmgIoCaptureBase,
291	kCpumMsrRdFn_IntelLastBranchFromToN,
292	kCpumMsrRdFn_IntelLastBranchFromN,
293	kCpumMsrRdFn_IntelLastBranchToN,
294	kCpumMsrRdFn_IntelLastBranchTos,
295	kCpumMsrRdFn_IntelBblCrCtl,
296	kCpumMsrRdFn_IntelBblCrCtl3,
297	kCpumMsrRdFn_IntelI7TemperatureTarget, /*< Range value returned. /
298	kCpumMsrRdFn_IntelI7MsrOffCoreResponseN,/*< Takes register number. /
299	kCpumMsrRdFn_IntelI7MiscPwrMgmt,
300	kCpumMsrRdFn_IntelP6CrN,
301	kCpumMsrRdFn_IntelCpuId1FeatureMaskEcdx,
302	kCpumMsrRdFn_IntelCpuId1FeatureMaskEax,
303	kCpumMsrRdFn_IntelCpuId80000001FeatureMaskEcdx,
304	kCpumMsrRdFn_IntelI7SandyAesNiCtl,
305	kCpumMsrRdFn_IntelI7TurboRatioLimit, /*< Returns range value. /
306	kCpumMsrRdFn_IntelI7LbrSelect,
307	kCpumMsrRdFn_IntelI7SandyErrorControl,
308	kCpumMsrRdFn_IntelI7VirtualLegacyWireCap,/*< Returns range value. /
309	kCpumMsrRdFn_IntelI7PowerCtl,
310	kCpumMsrRdFn_IntelI7SandyPebsNumAlt,
311	kCpumMsrRdFn_IntelI7PebsLdLat,
312	kCpumMsrRdFn_IntelI7PkgCnResidencyN, /*< Takes C-state number. /
313	kCpumMsrRdFn_IntelI7CoreCnResidencyN, /*< Takes C-state number. /
314	kCpumMsrRdFn_IntelI7SandyVrCurrentConfig,/*< Takes real value as reference. /
315	kCpumMsrRdFn_IntelI7SandyVrMiscConfig, /*< Takes real value as reference. /
316	kCpumMsrRdFn_IntelI7SandyRaplPowerUnit, /*< Takes real value as reference. /
317	kCpumMsrRdFn_IntelI7SandyPkgCnIrtlN, /*< Takes real value as reference. /
318	kCpumMsrRdFn_IntelI7SandyPkgC2Residency, /*< Takes real value as reference. /
319	kCpumMsrRdFn_IntelI7RaplPkgPowerLimit, /*< Takes real value as reference. /
320	kCpumMsrRdFn_IntelI7RaplPkgEnergyStatus, /*< Takes real value as reference. /
321	kCpumMsrRdFn_IntelI7RaplPkgPerfStatus, /*< Takes real value as reference. /
322	kCpumMsrRdFn_IntelI7RaplPkgPowerInfo, /*< Takes real value as reference. /
323	kCpumMsrRdFn_IntelI7RaplDramPowerLimit, /*< Takes real value as reference. /
324	kCpumMsrRdFn_IntelI7RaplDramEnergyStatus,/*< Takes real value as reference. /
325	kCpumMsrRdFn_IntelI7RaplDramPerfStatus, /*< Takes real value as reference. /
326	kCpumMsrRdFn_IntelI7RaplDramPowerInfo, /*< Takes real value as reference. /
327	kCpumMsrRdFn_IntelI7RaplPp0PowerLimit, /*< Takes real value as reference. /
328	kCpumMsrRdFn_IntelI7RaplPp0EnergyStatus, /*< Takes real value as reference. /
329	kCpumMsrRdFn_IntelI7RaplPp0Policy, /*< Takes real value as reference. /
330	kCpumMsrRdFn_IntelI7RaplPp0PerfStatus, /*< Takes real value as reference. /
331	kCpumMsrRdFn_IntelI7RaplPp1PowerLimit, /*< Takes real value as reference. /
332	kCpumMsrRdFn_IntelI7RaplPp1EnergyStatus, /*< Takes real value as reference. /
333	kCpumMsrRdFn_IntelI7RaplPp1Policy, /*< Takes real value as reference. /
334	kCpumMsrRdFn_IntelI7IvyConfigTdpNominal, /*< Takes real value as reference. /
335	kCpumMsrRdFn_IntelI7IvyConfigTdpLevel1, /*< Takes real value as reference. /
336	kCpumMsrRdFn_IntelI7IvyConfigTdpLevel2, /*< Takes real value as reference. /
337	kCpumMsrRdFn_IntelI7IvyConfigTdpControl,
338	kCpumMsrRdFn_IntelI7IvyTurboActivationRatio,
339	kCpumMsrRdFn_IntelI7UncPerfGlobalCtrl,
340	kCpumMsrRdFn_IntelI7UncPerfGlobalStatus,
341	kCpumMsrRdFn_IntelI7UncPerfGlobalOvfCtrl,
342	kCpumMsrRdFn_IntelI7UncPerfFixedCtrCtrl,
343	kCpumMsrRdFn_IntelI7UncPerfFixedCtr,
344	kCpumMsrRdFn_IntelI7UncCBoxConfig,
345	kCpumMsrRdFn_IntelI7UncArbPerfCtrN,
346	kCpumMsrRdFn_IntelI7UncArbPerfEvtSelN,
347	kCpumMsrRdFn_IntelI7SmiCount,
348	kCpumMsrRdFn_IntelCore2EmttmCrTablesN, /*< Range value returned. /
349	kCpumMsrRdFn_IntelCore2SmmCStMiscInfo,
350	kCpumMsrRdFn_IntelCore1ExtConfig,
351	kCpumMsrRdFn_IntelCore1DtsCalControl,
352	kCpumMsrRdFn_IntelCore2PeciControl,
353	kCpumMsrRdFn_IntelAtSilvCoreC1Recidency,
354
355	kCpumMsrRdFn_P6LastBranchFromIp,
356	kCpumMsrRdFn_P6LastBranchToIp,
357	kCpumMsrRdFn_P6LastIntFromIp,
358	kCpumMsrRdFn_P6LastIntToIp,
359
360	kCpumMsrRdFn_AmdFam15hTscRate,
361	kCpumMsrRdFn_AmdFam15hLwpCfg,
362	kCpumMsrRdFn_AmdFam15hLwpCbAddr,
363	kCpumMsrRdFn_AmdFam10hMc4MiscN,
364	kCpumMsrRdFn_AmdK8PerfCtlN,
365	kCpumMsrRdFn_AmdK8PerfCtrN,
366	kCpumMsrRdFn_AmdK8SysCfg, /*< Range value returned. /
367	kCpumMsrRdFn_AmdK8HwCr,
368	kCpumMsrRdFn_AmdK8IorrBaseN,
369	kCpumMsrRdFn_AmdK8IorrMaskN,
370	kCpumMsrRdFn_AmdK8TopOfMemN,
371	kCpumMsrRdFn_AmdK8NbCfg1,
372	kCpumMsrRdFn_AmdK8McXcptRedir,
373	kCpumMsrRdFn_AmdK8CpuNameN,
374	kCpumMsrRdFn_AmdK8HwThermalCtrl, /*< Range value returned. /
375	kCpumMsrRdFn_AmdK8SwThermalCtrl,
376	kCpumMsrRdFn_AmdK8FidVidControl, /*< Range value returned. /
377	kCpumMsrRdFn_AmdK8FidVidStatus, /*< Range value returned. /
378	kCpumMsrRdFn_AmdK8McCtlMaskN,
379	kCpumMsrRdFn_AmdK8SmiOnIoTrapN,
380	kCpumMsrRdFn_AmdK8SmiOnIoTrapCtlSts,
381	kCpumMsrRdFn_AmdK8IntPendingMessage,
382	kCpumMsrRdFn_AmdK8SmiTriggerIoCycle,
383	kCpumMsrRdFn_AmdFam10hMmioCfgBaseAddr,
384	kCpumMsrRdFn_AmdFam10hTrapCtlMaybe,
385	kCpumMsrRdFn_AmdFam10hPStateCurLimit, /*< Returns range value. /
386	kCpumMsrRdFn_AmdFam10hPStateControl, /*< Returns range value. /
387	kCpumMsrRdFn_AmdFam10hPStateStatus, /*< Returns range value. /
388	kCpumMsrRdFn_AmdFam10hPStateN, /*< Returns range value. This isn't an register index! /
389	kCpumMsrRdFn_AmdFam10hCofVidControl, /*< Returns range value. /
390	kCpumMsrRdFn_AmdFam10hCofVidStatus, /*< Returns range value. /
391	kCpumMsrRdFn_AmdFam10hCStateIoBaseAddr,
392	kCpumMsrRdFn_AmdFam10hCpuWatchdogTimer,
393	kCpumMsrRdFn_AmdK8SmmBase,
394	kCpumMsrRdFn_AmdK8SmmAddr,
395	kCpumMsrRdFn_AmdK8SmmMask,
396	kCpumMsrRdFn_AmdK8VmCr,
397	kCpumMsrRdFn_AmdK8IgnNe,
398	kCpumMsrRdFn_AmdK8SmmCtl,
399	kCpumMsrRdFn_AmdK8VmHSavePa,
400	kCpumMsrRdFn_AmdFam10hVmLockKey,
401	kCpumMsrRdFn_AmdFam10hSmmLockKey,
402	kCpumMsrRdFn_AmdFam10hLocalSmiStatus,
403	kCpumMsrRdFn_AmdFam10hOsVisWrkIdLength,
404	kCpumMsrRdFn_AmdFam10hOsVisWrkStatus,
405	kCpumMsrRdFn_AmdFam16hL2IPerfCtlN,
406	kCpumMsrRdFn_AmdFam16hL2IPerfCtrN,
407	kCpumMsrRdFn_AmdFam15hNorthbridgePerfCtlN,
408	kCpumMsrRdFn_AmdFam15hNorthbridgePerfCtrN,
409	kCpumMsrRdFn_AmdK7MicrocodeCtl, /*< Returns range value. /
410	kCpumMsrRdFn_AmdK7ClusterIdMaybe, /*< Returns range value. /
411	kCpumMsrRdFn_AmdK8CpuIdCtlStd07hEbax,
412	kCpumMsrRdFn_AmdK8CpuIdCtlStd06hEcx,
413	kCpumMsrRdFn_AmdK8CpuIdCtlStd01hEdcx,
414	kCpumMsrRdFn_AmdK8CpuIdCtlExt01hEdcx,
415	kCpumMsrRdFn_AmdK8PatchLevel, /*< Returns range value. /
416	kCpumMsrRdFn_AmdK7DebugStatusMaybe,
417	kCpumMsrRdFn_AmdK7BHTraceBaseMaybe,
418	kCpumMsrRdFn_AmdK7BHTracePtrMaybe,
419	kCpumMsrRdFn_AmdK7BHTraceLimitMaybe,
420	kCpumMsrRdFn_AmdK7HardwareDebugToolCfgMaybe,
421	kCpumMsrRdFn_AmdK7FastFlushCountMaybe,
422	kCpumMsrRdFn_AmdK7NodeId,
423	kCpumMsrRdFn_AmdK7DrXAddrMaskN, /*< Takes register index. /
424	kCpumMsrRdFn_AmdK7Dr0DataMatchMaybe,
425	kCpumMsrRdFn_AmdK7Dr0DataMaskMaybe,
426	kCpumMsrRdFn_AmdK7LoadStoreCfg,
427	kCpumMsrRdFn_AmdK7InstrCacheCfg,
428	kCpumMsrRdFn_AmdK7DataCacheCfg,
429	kCpumMsrRdFn_AmdK7BusUnitCfg,
430	kCpumMsrRdFn_AmdK7DebugCtl2Maybe,
431	kCpumMsrRdFn_AmdFam15hFpuCfg,
432	kCpumMsrRdFn_AmdFam15hDecoderCfg,
433	kCpumMsrRdFn_AmdFam10hBusUnitCfg2,
434	kCpumMsrRdFn_AmdFam15hCombUnitCfg,
435	kCpumMsrRdFn_AmdFam15hCombUnitCfg2,
436	kCpumMsrRdFn_AmdFam15hCombUnitCfg3,
437	kCpumMsrRdFn_AmdFam15hExecUnitCfg,
438	kCpumMsrRdFn_AmdFam15hLoadStoreCfg2,
439	kCpumMsrRdFn_AmdFam10hIbsFetchCtl,
440	kCpumMsrRdFn_AmdFam10hIbsFetchLinAddr,
441	kCpumMsrRdFn_AmdFam10hIbsFetchPhysAddr,
442	kCpumMsrRdFn_AmdFam10hIbsOpExecCtl,
443	kCpumMsrRdFn_AmdFam10hIbsOpRip,
444	kCpumMsrRdFn_AmdFam10hIbsOpData,
445	kCpumMsrRdFn_AmdFam10hIbsOpData2,
446	kCpumMsrRdFn_AmdFam10hIbsOpData3,
447	kCpumMsrRdFn_AmdFam10hIbsDcLinAddr,
448	kCpumMsrRdFn_AmdFam10hIbsDcPhysAddr,
449	kCpumMsrRdFn_AmdFam10hIbsCtl,
450	kCpumMsrRdFn_AmdFam14hIbsBrTarget,
451
452	kCpumMsrRdFn_Gim,
453
454	/** End of valid MSR read function indexes. */
455	kCpumMsrRdFn_End
456	} CPUMMSRRDFN;
457
458	/**
459	* MSR write functions.
460	*/
461	typedef enum CPUMMSRWRFN
462	{
463	/** Invalid zero value. */
464	kCpumMsrWrFn_Invalid = 0,
465	/** Writes are ignored, the fWrGpMask is observed though. */
466	kCpumMsrWrFn_IgnoreWrite,
467	/** Writes cause GP(0) to be raised, the fWrGpMask should be UINT64_MAX. */
468	kCpumMsrWrFn_ReadOnly,
469	/** Alias to the MSR range starting at the MSR given by
470	* CPUMMSRRANGE::uValue. Must be used in pair with
471	* kCpumMsrRdFn_MsrAlias. */
472	kCpumMsrWrFn_MsrAlias,
473
474	kCpumMsrWrFn_Ia32P5McAddr,
475	kCpumMsrWrFn_Ia32P5McType,
476	kCpumMsrWrFn_Ia32TimestampCounter,
477	kCpumMsrWrFn_Ia32ApicBase,
478	kCpumMsrWrFn_Ia32FeatureControl,
479	kCpumMsrWrFn_Ia32BiosSignId,
480	kCpumMsrWrFn_Ia32BiosUpdateTrigger,
481	kCpumMsrWrFn_Ia32SmmMonitorCtl,
482	kCpumMsrWrFn_Ia32PmcN,
483	kCpumMsrWrFn_Ia32MonitorFilterLineSize,
484	kCpumMsrWrFn_Ia32MPerf,
485	kCpumMsrWrFn_Ia32APerf,
486	kCpumMsrWrFn_Ia32MtrrPhysBaseN, /*< Takes register number. /
487	kCpumMsrWrFn_Ia32MtrrPhysMaskN, /*< Takes register number. /
488	kCpumMsrWrFn_Ia32MtrrFixed, /*< Takes CPUMCPU offset. /
489	kCpumMsrWrFn_Ia32MtrrDefType,
490	kCpumMsrWrFn_Ia32Pat,
491	kCpumMsrWrFn_Ia32SysEnterCs,
492	kCpumMsrWrFn_Ia32SysEnterEsp,
493	kCpumMsrWrFn_Ia32SysEnterEip,
494	kCpumMsrWrFn_Ia32McgStatus,
495	kCpumMsrWrFn_Ia32McgCtl,
496	kCpumMsrWrFn_Ia32DebugCtl,
497	kCpumMsrWrFn_Ia32SmrrPhysBase,
498	kCpumMsrWrFn_Ia32SmrrPhysMask,
499	kCpumMsrWrFn_Ia32PlatformDcaCap,
500	kCpumMsrWrFn_Ia32Dca0Cap,
501	kCpumMsrWrFn_Ia32PerfEvtSelN, /*< Range value indicates the register number. /
502	kCpumMsrWrFn_Ia32PerfStatus,
503	kCpumMsrWrFn_Ia32PerfCtl,
504	kCpumMsrWrFn_Ia32FixedCtrN, /*< Takes register number of start of range. /
505	kCpumMsrWrFn_Ia32PerfCapabilities,
506	kCpumMsrWrFn_Ia32FixedCtrCtrl,
507	kCpumMsrWrFn_Ia32PerfGlobalStatus,
508	kCpumMsrWrFn_Ia32PerfGlobalCtrl,
509	kCpumMsrWrFn_Ia32PerfGlobalOvfCtrl,
510	kCpumMsrWrFn_Ia32PebsEnable,
511	kCpumMsrWrFn_Ia32ClockModulation,
512	kCpumMsrWrFn_Ia32ThermInterrupt,
513	kCpumMsrWrFn_Ia32ThermStatus,
514	kCpumMsrWrFn_Ia32Therm2Ctl,
515	kCpumMsrWrFn_Ia32MiscEnable,
516	kCpumMsrWrFn_Ia32McCtlStatusAddrMiscN, /*< Takes bank number. /
517	kCpumMsrWrFn_Ia32McNCtl2, /*< Takes register number of start of range. /
518	kCpumMsrWrFn_Ia32DsArea,
519	kCpumMsrWrFn_Ia32TscDeadline,
520	kCpumMsrWrFn_Ia32X2ApicN,
521	kCpumMsrWrFn_Ia32DebugInterface,
522	kCpumMsrWrFn_Ia32SpecCtrl,
523	kCpumMsrWrFn_Ia32PredCmd,
524	kCpumMsrWrFn_Ia32FlushCmd,
525
526	kCpumMsrWrFn_Amd64Efer,
527	kCpumMsrWrFn_Amd64SyscallTarget,
528	kCpumMsrWrFn_Amd64LongSyscallTarget,
529	kCpumMsrWrFn_Amd64CompSyscallTarget,
530	kCpumMsrWrFn_Amd64SyscallFlagMask,
531	kCpumMsrWrFn_Amd64FsBase,
532	kCpumMsrWrFn_Amd64GsBase,
533	kCpumMsrWrFn_Amd64KernelGsBase,
534	kCpumMsrWrFn_Amd64TscAux,
535	kCpumMsrWrFn_IntelEblCrPowerOn,
536	kCpumMsrWrFn_IntelP4EbcHardPowerOn,
537	kCpumMsrWrFn_IntelP4EbcSoftPowerOn,
538	kCpumMsrWrFn_IntelP4EbcFrequencyId,
539	kCpumMsrWrFn_IntelFlexRatio,
540	kCpumMsrWrFn_IntelPkgCStConfigControl,
541	kCpumMsrWrFn_IntelPmgIoCaptureBase,
542	kCpumMsrWrFn_IntelLastBranchFromToN,
543	kCpumMsrWrFn_IntelLastBranchFromN,
544	kCpumMsrWrFn_IntelLastBranchToN,
545	kCpumMsrWrFn_IntelLastBranchTos,
546	kCpumMsrWrFn_IntelBblCrCtl,
547	kCpumMsrWrFn_IntelBblCrCtl3,
548	kCpumMsrWrFn_IntelI7TemperatureTarget,
549	kCpumMsrWrFn_IntelI7MsrOffCoreResponseN, /*< Takes register number. /
550	kCpumMsrWrFn_IntelI7MiscPwrMgmt,
551	kCpumMsrWrFn_IntelP6CrN,
552	kCpumMsrWrFn_IntelCpuId1FeatureMaskEcdx,
553	kCpumMsrWrFn_IntelCpuId1FeatureMaskEax,
554	kCpumMsrWrFn_IntelCpuId80000001FeatureMaskEcdx,
555	kCpumMsrWrFn_IntelI7SandyAesNiCtl,
556	kCpumMsrWrFn_IntelI7TurboRatioLimit,
557	kCpumMsrWrFn_IntelI7LbrSelect,
558	kCpumMsrWrFn_IntelI7SandyErrorControl,
559	kCpumMsrWrFn_IntelI7PowerCtl,
560	kCpumMsrWrFn_IntelI7SandyPebsNumAlt,
561	kCpumMsrWrFn_IntelI7PebsLdLat,
562	kCpumMsrWrFn_IntelI7SandyVrCurrentConfig,
563	kCpumMsrWrFn_IntelI7SandyVrMiscConfig,
564	kCpumMsrWrFn_IntelI7SandyRaplPowerUnit, /*< R/O but found writable bits on a Silvermont CPU here. /
565	kCpumMsrWrFn_IntelI7SandyPkgCnIrtlN,
566	kCpumMsrWrFn_IntelI7SandyPkgC2Residency, /*< R/O but found writable bits on a Silvermont CPU here. /
567	kCpumMsrWrFn_IntelI7RaplPkgPowerLimit,
568	kCpumMsrWrFn_IntelI7RaplDramPowerLimit,
569	kCpumMsrWrFn_IntelI7RaplPp0PowerLimit,
570	kCpumMsrWrFn_IntelI7RaplPp0Policy,
571	kCpumMsrWrFn_IntelI7RaplPp1PowerLimit,
572	kCpumMsrWrFn_IntelI7RaplPp1Policy,
573	kCpumMsrWrFn_IntelI7IvyConfigTdpControl,
574	kCpumMsrWrFn_IntelI7IvyTurboActivationRatio,
575	kCpumMsrWrFn_IntelI7UncPerfGlobalCtrl,
576	kCpumMsrWrFn_IntelI7UncPerfGlobalStatus,
577	kCpumMsrWrFn_IntelI7UncPerfGlobalOvfCtrl,
578	kCpumMsrWrFn_IntelI7UncPerfFixedCtrCtrl,
579	kCpumMsrWrFn_IntelI7UncPerfFixedCtr,
580	kCpumMsrWrFn_IntelI7UncArbPerfCtrN,
581	kCpumMsrWrFn_IntelI7UncArbPerfEvtSelN,
582	kCpumMsrWrFn_IntelCore2EmttmCrTablesN,
583	kCpumMsrWrFn_IntelCore2SmmCStMiscInfo,
584	kCpumMsrWrFn_IntelCore1ExtConfig,
585	kCpumMsrWrFn_IntelCore1DtsCalControl,
586	kCpumMsrWrFn_IntelCore2PeciControl,
587
588	kCpumMsrWrFn_P6LastIntFromIp,
589	kCpumMsrWrFn_P6LastIntToIp,
590
591	kCpumMsrWrFn_AmdFam15hTscRate,
592	kCpumMsrWrFn_AmdFam15hLwpCfg,
593	kCpumMsrWrFn_AmdFam15hLwpCbAddr,
594	kCpumMsrWrFn_AmdFam10hMc4MiscN,
595	kCpumMsrWrFn_AmdK8PerfCtlN,
596	kCpumMsrWrFn_AmdK8PerfCtrN,
597	kCpumMsrWrFn_AmdK8SysCfg,
598	kCpumMsrWrFn_AmdK8HwCr,
599	kCpumMsrWrFn_AmdK8IorrBaseN,
600	kCpumMsrWrFn_AmdK8IorrMaskN,
601	kCpumMsrWrFn_AmdK8TopOfMemN,
602	kCpumMsrWrFn_AmdK8NbCfg1,
603	kCpumMsrWrFn_AmdK8McXcptRedir,
604	kCpumMsrWrFn_AmdK8CpuNameN,
605	kCpumMsrWrFn_AmdK8HwThermalCtrl,
606	kCpumMsrWrFn_AmdK8SwThermalCtrl,
607	kCpumMsrWrFn_AmdK8FidVidControl,
608	kCpumMsrWrFn_AmdK8McCtlMaskN,
609	kCpumMsrWrFn_AmdK8SmiOnIoTrapN,
610	kCpumMsrWrFn_AmdK8SmiOnIoTrapCtlSts,
611	kCpumMsrWrFn_AmdK8IntPendingMessage,
612	kCpumMsrWrFn_AmdK8SmiTriggerIoCycle,
613	kCpumMsrWrFn_AmdFam10hMmioCfgBaseAddr,
614	kCpumMsrWrFn_AmdFam10hTrapCtlMaybe,
615	kCpumMsrWrFn_AmdFam10hPStateControl,
616	kCpumMsrWrFn_AmdFam10hPStateStatus,
617	kCpumMsrWrFn_AmdFam10hPStateN,
618	kCpumMsrWrFn_AmdFam10hCofVidControl,
619	kCpumMsrWrFn_AmdFam10hCofVidStatus,
620	kCpumMsrWrFn_AmdFam10hCStateIoBaseAddr,
621	kCpumMsrWrFn_AmdFam10hCpuWatchdogTimer,
622	kCpumMsrWrFn_AmdK8SmmBase,
623	kCpumMsrWrFn_AmdK8SmmAddr,
624	kCpumMsrWrFn_AmdK8SmmMask,
625	kCpumMsrWrFn_AmdK8VmCr,
626	kCpumMsrWrFn_AmdK8IgnNe,
627	kCpumMsrWrFn_AmdK8SmmCtl,
628	kCpumMsrWrFn_AmdK8VmHSavePa,
629	kCpumMsrWrFn_AmdFam10hVmLockKey,
630	kCpumMsrWrFn_AmdFam10hSmmLockKey,
631	kCpumMsrWrFn_AmdFam10hLocalSmiStatus,
632	kCpumMsrWrFn_AmdFam10hOsVisWrkIdLength,
633	kCpumMsrWrFn_AmdFam10hOsVisWrkStatus,
634	kCpumMsrWrFn_AmdFam16hL2IPerfCtlN,
635	kCpumMsrWrFn_AmdFam16hL2IPerfCtrN,
636	kCpumMsrWrFn_AmdFam15hNorthbridgePerfCtlN,
637	kCpumMsrWrFn_AmdFam15hNorthbridgePerfCtrN,
638	kCpumMsrWrFn_AmdK7MicrocodeCtl,
639	kCpumMsrWrFn_AmdK7ClusterIdMaybe,
640	kCpumMsrWrFn_AmdK8CpuIdCtlStd07hEbax,
641	kCpumMsrWrFn_AmdK8CpuIdCtlStd06hEcx,
642	kCpumMsrWrFn_AmdK8CpuIdCtlStd01hEdcx,
643	kCpumMsrWrFn_AmdK8CpuIdCtlExt01hEdcx,
644	kCpumMsrWrFn_AmdK8PatchLoader,
645	kCpumMsrWrFn_AmdK7DebugStatusMaybe,
646	kCpumMsrWrFn_AmdK7BHTraceBaseMaybe,
647	kCpumMsrWrFn_AmdK7BHTracePtrMaybe,
648	kCpumMsrWrFn_AmdK7BHTraceLimitMaybe,
649	kCpumMsrWrFn_AmdK7HardwareDebugToolCfgMaybe,
650	kCpumMsrWrFn_AmdK7FastFlushCountMaybe,
651	kCpumMsrWrFn_AmdK7NodeId,
652	kCpumMsrWrFn_AmdK7DrXAddrMaskN, /*< Takes register index. /
653	kCpumMsrWrFn_AmdK7Dr0DataMatchMaybe,
654	kCpumMsrWrFn_AmdK7Dr0DataMaskMaybe,
655	kCpumMsrWrFn_AmdK7LoadStoreCfg,
656	kCpumMsrWrFn_AmdK7InstrCacheCfg,
657	kCpumMsrWrFn_AmdK7DataCacheCfg,
658	kCpumMsrWrFn_AmdK7BusUnitCfg,
659	kCpumMsrWrFn_AmdK7DebugCtl2Maybe,
660	kCpumMsrWrFn_AmdFam15hFpuCfg,
661	kCpumMsrWrFn_AmdFam15hDecoderCfg,
662	kCpumMsrWrFn_AmdFam10hBusUnitCfg2,
663	kCpumMsrWrFn_AmdFam15hCombUnitCfg,
664	kCpumMsrWrFn_AmdFam15hCombUnitCfg2,
665	kCpumMsrWrFn_AmdFam15hCombUnitCfg3,
666	kCpumMsrWrFn_AmdFam15hExecUnitCfg,
667	kCpumMsrWrFn_AmdFam15hLoadStoreCfg2,
668	kCpumMsrWrFn_AmdFam10hIbsFetchCtl,
669	kCpumMsrWrFn_AmdFam10hIbsFetchLinAddr,
670	kCpumMsrWrFn_AmdFam10hIbsFetchPhysAddr,
671	kCpumMsrWrFn_AmdFam10hIbsOpExecCtl,
672	kCpumMsrWrFn_AmdFam10hIbsOpRip,
673	kCpumMsrWrFn_AmdFam10hIbsOpData,
674	kCpumMsrWrFn_AmdFam10hIbsOpData2,
675	kCpumMsrWrFn_AmdFam10hIbsOpData3,
676	kCpumMsrWrFn_AmdFam10hIbsDcLinAddr,
677	kCpumMsrWrFn_AmdFam10hIbsDcPhysAddr,
678	kCpumMsrWrFn_AmdFam10hIbsCtl,
679	kCpumMsrWrFn_AmdFam14hIbsBrTarget,
680
681	kCpumMsrWrFn_Gim,
682
683	/** End of valid MSR write function indexes. */
684	kCpumMsrWrFn_End
685	} CPUMMSRWRFN;
686
687	/**
688	* MSR range.
689	*/
690	typedef struct CPUMMSRRANGE
691	{
692	/** The first MSR. [0] */
693	uint32_t uFirst;
694	/** The last MSR. [4] */
695	uint32_t uLast;
696	/** The read function (CPUMMSRRDFN). [8] */
697	uint16_t enmRdFn;
698	/** The write function (CPUMMSRWRFN). [10] */
699	uint16_t enmWrFn;
700	/** The offset of the 64-bit MSR value relative to the start of CPUMCPU.
701	* UINT16_MAX if not used by the read and write functions. [12] */
702	uint32_t offCpumCpu : 24;
703	/** Reserved for future hacks. [15] */
704	uint32_t fReserved : 8;
705	/** The init/read value. [16]
706	* When enmRdFn is kCpumMsrRdFn_INIT_VALUE, this is the value returned on RDMSR.
707	* offCpumCpu must be UINT16_MAX in that case, otherwise it must be a valid
708	* offset into CPUM. */
709	uint64_t uValue;
710	/** The bits to ignore when writing. [24] */
711	uint64_t fWrIgnMask;
712	/** The bits that will cause a GP(0) when writing. [32]
713	* This is always checked prior to calling the write function. Using
714	* UINT64_MAX effectively marks the MSR as read-only. */
715	uint64_t fWrGpMask;
716	/** The register name, if applicable. [40] */
717	char szName[56];
718
719	/** The number of reads. */
720	STAMCOUNTER cReads;
721	/** The number of writes. */
722	STAMCOUNTER cWrites;
723	/** The number of times ignored bits were written. */
724	STAMCOUNTER cIgnoredBits;
725	/** The number of GPs generated. */
726	STAMCOUNTER cGps;
727	} CPUMMSRRANGE;
728	#ifndef VBOX_FOR_DTRACE_LIB
729	AssertCompileSize(CPUMMSRRANGE, 128);
730	#endif
731	/** Pointer to an MSR range. */
732	typedef CPUMMSRRANGE *PCPUMMSRRANGE;
733	/** Pointer to a const MSR range. */
734	typedef CPUMMSRRANGE const *PCCPUMMSRRANGE;
735
736
737	/**
738	* MSRs which are required while exploding features.
739	*/
740	typedef struct CPUMMSRS
741	{
742	union
743	{
744	VMXMSRS vmx;
745	SVMMSRS svm;
746	} hwvirt;
747	} CPUMMSRS;
748	/** Pointer to an CPUMMSRS struct. */
749	typedef CPUMMSRS *PCPUMMSRS;
750	/** Pointer to a const CPUMMSRS struct. */
751	typedef CPUMMSRS const *PCCPUMMSRS;
752
753
754	/**
755	* CPU database entry.
756	*/
757	typedef struct CPUMDBENTRY
758	{
759	/** The CPU name. */
760	const char *pszName;
761	/** The full CPU name. */
762	const char *pszFullName;
763	/** The CPU vendor (CPUMCPUVENDOR). */
764	uint8_t enmVendor;
765	/** The CPU family. */
766	uint8_t uFamily;
767	/** The CPU model. */
768	uint8_t uModel;
769	/** The CPU stepping. */
770	uint8_t uStepping;
771	/** The microarchitecture. */
772	CPUMMICROARCH enmMicroarch;
773	/** Scalable bus frequency used for reporting other frequencies. */
774	uint64_t uScalableBusFreq;
775	/** Flags - CPUMDB_F_XXX. */
776	uint32_t fFlags;
777	/** The maximum physical address with of the CPU. This should correspond to
778	* the value in CPUID leaf 0x80000008 when present. */
779	uint8_t cMaxPhysAddrWidth;
780	/** The MXCSR mask. */
781	uint32_t fMxCsrMask;
782	/** Pointer to an array of CPUID leaves. */
783	PCCPUMCPUIDLEAF paCpuIdLeaves;
784	/** The number of CPUID leaves in the array paCpuIdLeaves points to. */
785	uint32_t cCpuIdLeaves;
786	/** The method used to deal with unknown CPUID leaves. */
787	CPUMUNKNOWNCPUID enmUnknownCpuId;
788	/** The default unknown CPUID value. */
789	CPUMCPUID DefUnknownCpuId;
790
791	/** MSR mask. Several microarchitectures ignore the higher bits of ECX in
792	* the RDMSR and WRMSR instructions. */
793	uint32_t fMsrMask;
794
795	/** The number of ranges in the table pointed to b paMsrRanges. */
796	uint32_t cMsrRanges;
797	/** MSR ranges for this CPU. */
798	PCCPUMMSRRANGE paMsrRanges;
799	} CPUMDBENTRY;
800	/** Pointer to a const CPU database entry. */
801	typedef CPUMDBENTRY const *PCCPUMDBENTRY;
802
803	/** @name CPUMDB_F_XXX - CPUDBENTRY::fFlags
804	* @{ */
805	/** Should execute all in IEM.
806	* @todo Implement this - currently done in Main... */
807	#define CPUMDB_F_EXECUTE_ALL_IN_IEM RT_BIT_32(0)
808	/** @} */
809
810
811
812	#ifndef VBOX_FOR_DTRACE_LIB
813
814	VMM_INT_DECL(bool) CPUMAssertGuestRFlagsCookie(PVM pVM, PVMCPU pVCpu);
815
816
817	/** @name Guest Register Getters.
818	* @{ */
819	VMMDECL(void) CPUMGetGuestGDTR(PCVMCPU pVCpu, PVBOXGDTR pGDTR);
820	VMMDECL(RTGCPTR) CPUMGetGuestIDTR(PCVMCPU pVCpu, uint16_t *pcbLimit);
821	VMMDECL(RTSEL) CPUMGetGuestTR(PCVMCPU pVCpu, PCPUMSELREGHID pHidden);
822	VMMDECL(RTSEL) CPUMGetGuestLDTR(PCVMCPU pVCpu);
823	VMMDECL(RTSEL) CPUMGetGuestLdtrEx(PCVMCPU pVCpu, uint64_t pGCPtrBase, uint32_t pcbLimit);
824	VMMDECL(uint64_t) CPUMGetGuestCR0(PCVMCPU pVCpu);
825	VMMDECL(uint64_t) CPUMGetGuestCR2(PCVMCPU pVCpu);
826	VMMDECL(uint64_t) CPUMGetGuestCR3(PCVMCPU pVCpu);
827	VMMDECL(uint64_t) CPUMGetGuestCR4(PCVMCPU pVCpu);
828	VMMDECL(uint64_t) CPUMGetGuestCR8(PCVMCPUCC pVCpu);
829	VMMDECL(int) CPUMGetGuestCRx(PCVMCPUCC pVCpu, unsigned iReg, uint64_t *pValue);
830	VMMDECL(uint32_t) CPUMGetGuestEFlags(PCVMCPU pVCpu);
831	VMMDECL(uint32_t) CPUMGetGuestEIP(PCVMCPU pVCpu);
832	VMMDECL(uint64_t) CPUMGetGuestRIP(PCVMCPU pVCpu);
833	VMMDECL(uint32_t) CPUMGetGuestEAX(PCVMCPU pVCpu);
834	VMMDECL(uint32_t) CPUMGetGuestEBX(PCVMCPU pVCpu);
835	VMMDECL(uint32_t) CPUMGetGuestECX(PCVMCPU pVCpu);
836	VMMDECL(uint32_t) CPUMGetGuestEDX(PCVMCPU pVCpu);
837	VMMDECL(uint32_t) CPUMGetGuestESI(PCVMCPU pVCpu);
838	VMMDECL(uint32_t) CPUMGetGuestEDI(PCVMCPU pVCpu);
839	VMMDECL(uint32_t) CPUMGetGuestESP(PCVMCPU pVCpu);
840	VMMDECL(uint32_t) CPUMGetGuestEBP(PCVMCPU pVCpu);
841	VMMDECL(RTSEL) CPUMGetGuestCS(PCVMCPU pVCpu);
842	VMMDECL(RTSEL) CPUMGetGuestDS(PCVMCPU pVCpu);
843	VMMDECL(RTSEL) CPUMGetGuestES(PCVMCPU pVCpu);
844	VMMDECL(RTSEL) CPUMGetGuestFS(PCVMCPU pVCpu);
845	VMMDECL(RTSEL) CPUMGetGuestGS(PCVMCPU pVCpu);
846	VMMDECL(RTSEL) CPUMGetGuestSS(PCVMCPU pVCpu);
847	VMMDECL(uint64_t) CPUMGetGuestDR0(PCVMCPU pVCpu);
848	VMMDECL(uint64_t) CPUMGetGuestDR1(PCVMCPU pVCpu);
849	VMMDECL(uint64_t) CPUMGetGuestDR2(PCVMCPU pVCpu);
850	VMMDECL(uint64_t) CPUMGetGuestDR3(PCVMCPU pVCpu);
851	VMMDECL(uint64_t) CPUMGetGuestDR6(PCVMCPU pVCpu);
852	VMMDECL(uint64_t) CPUMGetGuestDR7(PCVMCPU pVCpu);
853	VMMDECL(int) CPUMGetGuestDRx(PCVMCPU pVCpu, uint32_t iReg, uint64_t *pValue);
854	VMMDECL(void) CPUMGetGuestCpuId(PVMCPUCC pVCpu, uint32_t iLeaf, uint32_t iSubLeaf, int f64BitMode,
855	uint32_t pEax, uint32_t pEbx, uint32_t pEcx, uint32_t pEdx);
856	VMMDECL(uint64_t) CPUMGetGuestEFER(PCVMCPU pVCpu);
857	VMM_INT_DECL(uint64_t) CPUMGetGuestIa32FeatCtrl(PCVMCPUCC pVCpu);
858	VMM_INT_DECL(uint64_t) CPUMGetGuestIa32MtrrCap(PCVMCPUCC pVCpu);
859	VMM_INT_DECL(uint64_t) CPUMGetGuestIa32SmmMonitorCtl(PCVMCPUCC pVCpu);
860	VMM_INT_DECL(uint64_t) CPUMGetGuestIa32VmxEptVpidCap(PCVMCPUCC pVCpu);
861	VMMDECL(VBOXSTRICTRC) CPUMQueryGuestMsr(PVMCPUCC pVCpu, uint32_t idMsr, uint64_t *puValue);
862	VMMDECL(VBOXSTRICTRC) CPUMSetGuestMsr(PVMCPUCC pVCpu, uint32_t idMsr, uint64_t uValue);
863	/** @} */
864
865	/** @name Guest Register Setters.
866	* @{ */
867	VMMDECL(int) CPUMSetGuestGDTR(PVMCPU pVCpu, uint64_t GCPtrBase, uint16_t cbLimit);
868	VMMDECL(int) CPUMSetGuestIDTR(PVMCPU pVCpu, uint64_t GCPtrBase, uint16_t cbLimit);
869	VMMDECL(int) CPUMSetGuestTR(PVMCPU pVCpu, uint16_t tr);
870	VMMDECL(int) CPUMSetGuestLDTR(PVMCPU pVCpu, uint16_t ldtr);
871	VMMDECL(int) CPUMSetGuestCR0(PVMCPUCC pVCpu, uint64_t cr0);
872	VMMDECL(int) CPUMSetGuestCR2(PVMCPU pVCpu, uint64_t cr2);
873	VMMDECL(int) CPUMSetGuestCR3(PVMCPU pVCpu, uint64_t cr3);
874	VMMDECL(int) CPUMSetGuestCR4(PVMCPU pVCpu, uint64_t cr4);
875	VMMDECL(int) CPUMSetGuestDR0(PVMCPUCC pVCpu, uint64_t uDr0);
876	VMMDECL(int) CPUMSetGuestDR1(PVMCPUCC pVCpu, uint64_t uDr1);
877	VMMDECL(int) CPUMSetGuestDR2(PVMCPUCC pVCpu, uint64_t uDr2);
878	VMMDECL(int) CPUMSetGuestDR3(PVMCPUCC pVCpu, uint64_t uDr3);
879	VMMDECL(int) CPUMSetGuestDR6(PVMCPU pVCpu, uint64_t uDr6);
880	VMMDECL(int) CPUMSetGuestDR7(PVMCPUCC pVCpu, uint64_t uDr7);
881	VMMDECL(int) CPUMSetGuestDRx(PVMCPUCC pVCpu, uint32_t iReg, uint64_t Value);
882	VMM_INT_DECL(int) CPUMSetGuestXcr0(PVMCPUCC pVCpu, uint64_t uNewValue);
883	VMMDECL(int) CPUMSetGuestEFlags(PVMCPU pVCpu, uint32_t eflags);
884	VMMDECL(int) CPUMSetGuestEIP(PVMCPU pVCpu, uint32_t eip);
885	VMMDECL(int) CPUMSetGuestEAX(PVMCPU pVCpu, uint32_t eax);
886	VMMDECL(int) CPUMSetGuestEBX(PVMCPU pVCpu, uint32_t ebx);
887	VMMDECL(int) CPUMSetGuestECX(PVMCPU pVCpu, uint32_t ecx);
888	VMMDECL(int) CPUMSetGuestEDX(PVMCPU pVCpu, uint32_t edx);
889	VMMDECL(int) CPUMSetGuestESI(PVMCPU pVCpu, uint32_t esi);
890	VMMDECL(int) CPUMSetGuestEDI(PVMCPU pVCpu, uint32_t edi);
891	VMMDECL(int) CPUMSetGuestESP(PVMCPU pVCpu, uint32_t esp);
892	VMMDECL(int) CPUMSetGuestEBP(PVMCPU pVCpu, uint32_t ebp);
893	VMMDECL(int) CPUMSetGuestCS(PVMCPU pVCpu, uint16_t cs);
894	VMMDECL(int) CPUMSetGuestDS(PVMCPU pVCpu, uint16_t ds);
895	VMMDECL(int) CPUMSetGuestES(PVMCPU pVCpu, uint16_t es);
896	VMMDECL(int) CPUMSetGuestFS(PVMCPU pVCpu, uint16_t fs);
897	VMMDECL(int) CPUMSetGuestGS(PVMCPU pVCpu, uint16_t gs);
898	VMMDECL(int) CPUMSetGuestSS(PVMCPU pVCpu, uint16_t ss);
899	VMMDECL(void) CPUMSetGuestEFER(PVMCPU pVCpu, uint64_t val);
900	VMMR3_INT_DECL(void) CPUMR3SetGuestCpuIdFeature(PVM pVM, CPUMCPUIDFEATURE enmFeature);
901	VMMR3_INT_DECL(void) CPUMR3ClearGuestCpuIdFeature(PVM pVM, CPUMCPUIDFEATURE enmFeature);
902	VMMR3_INT_DECL(bool) CPUMR3GetGuestCpuIdFeature(PVM pVM, CPUMCPUIDFEATURE enmFeature);
903	VMMDECL(bool) CPUMSetGuestCpuIdPerCpuApicFeature(PVMCPU pVCpu, bool fVisible);
904	VMMDECL(void) CPUMSetGuestCtx(PVMCPU pVCpu, const PCPUMCTX pCtx);
905	VMM_INT_DECL(void) CPUMSetGuestTscAux(PVMCPUCC pVCpu, uint64_t uValue);
906	VMM_INT_DECL(uint64_t) CPUMGetGuestTscAux(PVMCPUCC pVCpu);
907	VMM_INT_DECL(void) CPUMSetGuestSpecCtrl(PVMCPUCC pVCpu, uint64_t uValue);
908	VMM_INT_DECL(uint64_t) CPUMGetGuestSpecCtrl(PVMCPUCC pVCpu);
909	VMM_INT_DECL(uint64_t) CPUMGetGuestCR4ValidMask(PVM pVM);
910	VMM_INT_DECL(void) CPUMSetGuestPaePdpes(PVMCPU pVCpu, PCX86PDPE paPaePdpes);
911	VMM_INT_DECL(void) CPUMGetGuestPaePdpes(PVMCPU pVCpu, PX86PDPE paPaePdpes);
912	/** @} */
913
914
915	/** @name Misc Guest Predicate Functions.
916	* @{ */
917	VMMDECL(bool) CPUMIsGuestNXEnabled(PCVMCPU pVCpu);
918	VMMDECL(bool) CPUMIsGuestPageSizeExtEnabled(PCVMCPU pVCpu);
919	VMMDECL(bool) CPUMIsGuestPagingEnabled(PCVMCPU pVCpu);
920	VMMDECL(bool) CPUMIsGuestR0WriteProtEnabled(PCVMCPU pVCpu);
921	VMMDECL(bool) CPUMIsGuestInRealMode(PCVMCPU pVCpu);
922	VMMDECL(bool) CPUMIsGuestInRealOrV86Mode(PCVMCPU pVCpu);
923	VMMDECL(bool) CPUMIsGuestInProtectedMode(PCVMCPU pVCpu);
924	VMMDECL(bool) CPUMIsGuestInPagedProtectedMode(PCVMCPU pVCpu);
925	VMMDECL(bool) CPUMIsGuestInLongMode(PCVMCPU pVCpu);
926	VMMDECL(bool) CPUMIsGuestInPAEMode(PCVMCPU pVCpu);
927	/** @} */
928
929	/** @name Nested Hardware-Virtualization Helpers.
930	* @{ */
931	VMM_INT_DECL(bool) CPUMIsGuestPhysIntrEnabled(PVMCPU pVCpu);
932	VMM_INT_DECL(bool) CPUMIsGuestVirtIntrEnabled(PVMCPU pVCpu);
933	VMM_INT_DECL(uint64_t) CPUMApplyNestedGuestTscOffset(PCVMCPU pVCpu, uint64_t uTscValue);
934	VMM_INT_DECL(uint64_t) CPUMRemoveNestedGuestTscOffset(PCVMCPU pVCpu, uint64_t uTscValue);
935
936	/* SVM helpers. */
937	VMM_INT_DECL(bool) CPUMIsGuestSvmPhysIntrEnabled(PCVMCPU pVCpu, PCCPUMCTX pCtx);
938	VMM_INT_DECL(bool) CPUMIsGuestSvmVirtIntrEnabled(PCVMCPU pVCpu, PCCPUMCTX pCtx);
939	VMM_INT_DECL(uint8_t) CPUMGetGuestSvmVirtIntrVector(PCCPUMCTX pCtx);
940	VMM_INT_DECL(void) CPUMSvmVmExitRestoreHostState(PVMCPUCC pVCpu, PCPUMCTX pCtx);
941	VMM_INT_DECL(void) CPUMSvmVmRunSaveHostState(PCPUMCTX pCtx, uint8_t cbInstr);
942	VMM_INT_DECL(bool) CPUMIsSvmIoInterceptSet(void *pvIoBitmap, uint16_t u16Port, SVMIOIOTYPE enmIoType, uint8_t cbReg,
943	uint8_t cAddrSizeBits, uint8_t iEffSeg, bool fRep, bool fStrIo,
944	PSVMIOIOEXITINFO pIoExitInfo);
945	VMM_INT_DECL(int) CPUMGetSvmMsrpmOffsetAndBit(uint32_t idMsr, uint16_t pbOffMsrpm, uint8_t puMsrpmBit);
946
947	/* VMX helpers. */
948	VMM_INT_DECL(bool) CPUMIsGuestVmxVmcsFieldValid(PVMCC pVM, uint64_t u64VmcsField);
949	VMM_INT_DECL(bool) CPUMIsGuestVmxIoInterceptSet(PCVMCPU pVCpu, uint16_t u16Port, uint8_t cbAccess);
950	VMM_INT_DECL(bool) CPUMIsGuestVmxMovToCr3InterceptSet(PVMCPU pVCpu, uint64_t uNewCr3);
951	VMM_INT_DECL(bool) CPUMIsGuestVmxVmreadVmwriteInterceptSet(PCVMCPU pVCpu, uint32_t uExitReason, uint64_t u64FieldEnc);
952	VMM_INT_DECL(int) CPUMStartGuestVmxPremptTimer(PVMCPUCC pVCpu, uint32_t uTimer, uint8_t cShift, uint64_t *pu64EntryTick);
953	VMM_INT_DECL(int) CPUMStopGuestVmxPremptTimer(PVMCPUCC pVCpu);
954	VMM_INT_DECL(uint32_t) CPUMGetVmxMsrPermission(void const *pvMsrBitmap, uint32_t idMsr);
955	VMM_INT_DECL(bool) CPUMIsGuestVmxEptPagingEnabled(PCVMCPUCC pVCpu);
956	VMM_INT_DECL(bool) CPUMIsGuestVmxEptPaePagingEnabled(PCVMCPUCC pVCpu);
957	VMM_INT_DECL(uint64_t) CPUMGetGuestVmxApicAccessPageAddr(PCVMCPUCC pVCpu);
958	/** @} */
959
960	#if !defined(IPRT_WITHOUT_NAMED_UNIONS_AND_STRUCTS) \|\| defined(DOXYGEN_RUNNING)
961	/** @name Inlined Guest Getters and predicates Functions.
962	* @{ */
963
964	/**
965	* Gets valid CR0 bits for the guest.
966	*
967	* @returns Valid CR0 bits.
968	*/
969	DECLINLINE(uint64_t) CPUMGetGuestCR0ValidMask(void)
970	{
971	return ( X86_CR0_PE \| X86_CR0_MP \| X86_CR0_EM \| X86_CR0_TS
972	\| X86_CR0_ET \| X86_CR0_NE \| X86_CR0_WP \| X86_CR0_AM
973	\| X86_CR0_NW \| X86_CR0_CD \| X86_CR0_PG);
974	}
975
976	/**
977	* Tests if the guest is running in real mode or not.
978	*
979	* @returns true if in real mode, otherwise false.
980	* @param pCtx Current CPU context.
981	*/
982	DECLINLINE(bool) CPUMIsGuestInRealModeEx(PCCPUMCTX pCtx)
983	{
984	return !(pCtx->cr0 & X86_CR0_PE);
985	}
986
987	/**
988	* Tests if the guest is running in real or virtual 8086 mode.
989	*
990	* @returns @c true if it is, @c false if not.
991	* @param pCtx Current CPU context.
992	*/
993	DECLINLINE(bool) CPUMIsGuestInRealOrV86ModeEx(PCCPUMCTX pCtx)
994	{
995	return !(pCtx->cr0 & X86_CR0_PE)
996	\|\| pCtx->eflags.Bits.u1VM; /* Cannot be set in long mode. Intel spec 2.3.1 "System Flags and Fields in IA-32e Mode". */
997	}
998
999	/**
1000	* Tests if the guest is running in virtual 8086 mode.
1001	*
1002	* @returns @c true if it is, @c false if not.
1003	* @param pCtx Current CPU context.
1004	*/
1005	DECLINLINE(bool) CPUMIsGuestInV86ModeEx(PCCPUMCTX pCtx)
1006	{
1007	return (pCtx->eflags.Bits.u1VM == 1);
1008	}
1009
1010	/**
1011	* Tests if the guest is running in paged protected or not.
1012	*
1013	* @returns true if in paged protected mode, otherwise false.
1014	* @param pCtx Current CPU context.
1015	*/
1016	DECLINLINE(bool) CPUMIsGuestInPagedProtectedModeEx(PCPUMCTX pCtx)
1017	{
1018	return (pCtx->cr0 & (X86_CR0_PE \| X86_CR0_PG)) == (X86_CR0_PE \| X86_CR0_PG);
1019	}
1020
1021	/**
1022	* Tests if the guest is running in long mode or not.
1023	*
1024	* @returns true if in long mode, otherwise false.
1025	* @param pCtx Current CPU context.
1026	*/
1027	DECLINLINE(bool) CPUMIsGuestInLongModeEx(PCCPUMCTX pCtx)
1028	{
1029	return (pCtx->msrEFER & MSR_K6_EFER_LMA) == MSR_K6_EFER_LMA;
1030	}
1031
1032	VMM_INT_DECL(bool) CPUMIsGuestIn64BitCodeSlow(PCCPUMCTX pCtx);
1033
1034	/**
1035	* Tests if the guest is running in 64 bits mode or not.
1036	*
1037	* @returns true if in 64 bits protected mode, otherwise false.
1038	* @param pCtx Current CPU context.
1039	*/
1040	DECLINLINE(bool) CPUMIsGuestIn64BitCodeEx(PCCPUMCTX pCtx)
1041	{
1042	if (!(pCtx->msrEFER & MSR_K6_EFER_LMA))
1043	return false;
1044	if (!CPUMSELREG_ARE_HIDDEN_PARTS_VALID(NULL, &pCtx->cs))
1045	return CPUMIsGuestIn64BitCodeSlow(pCtx);
1046	return pCtx->cs.Attr.n.u1Long;
1047	}
1048
1049	/**
1050	* Tests if the guest has paging enabled or not.
1051	*
1052	* @returns true if paging is enabled, otherwise false.
1053	* @param pCtx Current CPU context.
1054	*/
1055	DECLINLINE(bool) CPUMIsGuestPagingEnabledEx(PCCPUMCTX pCtx)
1056	{
1057	return !!(pCtx->cr0 & X86_CR0_PG);
1058	}
1059
1060	/**
1061	* Tests if PAE paging is enabled given the relevant control registers.
1062	*
1063	* @returns @c true if in PAE mode, @c false otherwise.
1064	* @param uCr0 The CR0 value.
1065	* @param uCr4 The CR4 value.
1066	* @param uEferMsr The EFER value.
1067	*/
1068	DECLINLINE(bool) CPUMIsPaePagingEnabled(uint64_t uCr0, uint64_t uCr4, uint64_t uEferMsr)
1069	{
1070	/* Intel mentions EFER.LMA and EFER.LME in different parts of their spec. We shall use EFER.LMA rather
1071	than EFER.LME as it reflects if the CPU has entered paging with EFER.LME set. */
1072	return ( (uCr4 & X86_CR4_PAE)
1073	&& (uCr0 & X86_CR0_PG)
1074	&& !(uEferMsr & MSR_K6_EFER_LMA));
1075	}
1076
1077	/**
1078	* Tests if the guest is running in PAE mode or not.
1079	*
1080	* @returns @c true if in PAE mode, @c false otherwise.
1081	* @param pCtx Current CPU context.
1082	*/
1083	DECLINLINE(bool) CPUMIsGuestInPAEModeEx(PCCPUMCTX pCtx)
1084	{
1085	return CPUMIsPaePagingEnabled(pCtx->cr0, pCtx->cr4, pCtx->msrEFER);
1086	}
1087
1088	/**
1089	* Tests if the guest has AMD SVM enabled or not.
1090	*
1091	* @returns true if SMV is enabled, otherwise false.
1092	* @param pCtx Current CPU context.
1093	*/
1094	DECLINLINE(bool) CPUMIsGuestSvmEnabled(PCCPUMCTX pCtx)
1095	{
1096	return RT_BOOL(pCtx->msrEFER & MSR_K6_EFER_SVME);
1097	}
1098
1099	/**
1100	* Tests if the guest has Intel VT-x enabled or not.
1101	*
1102	* @returns true if VMX is enabled, otherwise false.
1103	* @param pCtx Current CPU context.
1104	*/
1105	DECLINLINE(bool) CPUMIsGuestVmxEnabled(PCCPUMCTX pCtx)
1106	{
1107	return RT_BOOL(pCtx->cr4 & X86_CR4_VMXE);
1108	}
1109
1110	/**
1111	* Returns the guest's global-interrupt (GIF) flag.
1112	*
1113	* @returns true when global-interrupts are enabled, otherwise false.
1114	* @param pCtx Current CPU context.
1115	*/
1116	DECLINLINE(bool) CPUMGetGuestGif(PCCPUMCTX pCtx)
1117	{
1118	return pCtx->hwvirt.fGif;
1119	}
1120
1121	/**
1122	* Sets the guest's global-interrupt flag (GIF).
1123	*
1124	* @param pCtx Current CPU context.
1125	* @param fGif The value to set.
1126	*/
1127	DECLINLINE(void) CPUMSetGuestGif(PCPUMCTX pCtx, bool fGif)
1128	{
1129	pCtx->hwvirt.fGif = fGif;
1130	}
1131
1132	/**
1133	* Checks if we're in an "interrupt shadow", i.e. after a STI, POP SS or MOV SS.
1134	*
1135	* This also inhibit NMIs, except perhaps for nested guests.
1136	*
1137	* @returns true if interrupts are inhibited by interrupt shadow, false if not.
1138	* @param pCtx Current guest CPU context.
1139	* @note Requires pCtx->rip to be up to date.
1140	* @note Does NOT clear CPUMCTX_INHIBIT_SHADOW when CPUMCTX::uRipInhibitInt
1141	* differs from CPUMCTX::rip.
1142	*/
1143	DECLINLINE(bool) CPUMIsInInterruptShadow(PCCPUMCTX pCtx)
1144	{
1145	if (!(pCtx->eflags.uBoth & CPUMCTX_INHIBIT_SHADOW))
1146	return false;
1147
1148	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1149	return pCtx->uRipInhibitInt == pCtx->rip;
1150	}
1151
1152	/**
1153	* Checks if we're in an "interrupt shadow", i.e. after a STI, POP SS or MOV SS,
1154	* updating the state if stale.
1155	*
1156	* This also inhibit NMIs, except perhaps for nested guests.
1157	*
1158	* @retval true if interrupts are inhibited by interrupt shadow.
1159	* @retval false if not.
1160	* @param pCtx Current guest CPU context.
1161	* @note Requires pCtx->rip to be up to date.
1162	*/
1163	DECLINLINE(bool) CPUMIsInInterruptShadowWithUpdate(PCPUMCTX pCtx)
1164	{
1165	if (!(pCtx->eflags.uBoth & CPUMCTX_INHIBIT_SHADOW))
1166	return false;
1167
1168	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1169	if (pCtx->uRipInhibitInt == pCtx->rip)
1170	return true;
1171
1172	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_SHADOW;
1173	return false;
1174	}
1175
1176	/**
1177	* Checks if we're in an "interrupt shadow", i.e. after a STI, POP SS or MOV SS,
1178	* updating the state if stale while also returning the reason for the interrupt
1179	* inhibition.
1180	*
1181	* This also inhibit NMIs, except perhaps for nested guests.
1182	*
1183	* @retval true if interrupts are inhibited by interrupt shadow.
1184	* @retval false if not.
1185	* @param pCtx Current guest CPU context.
1186	* @param pfInhibitShw Where to store which type of interrupt inhibition was
1187	* active (see CPUMCTX_INHIBIT_XXX).
1188	* @note Requires pCtx->rip to be up to date.
1189	*/
1190	DECLINLINE(bool) CPUMIsInInterruptShadowWithUpdateEx(PCPUMCTX pCtx, uint32_t *pfInhibitShw)
1191	{
1192	Assert(pfInhibitShw);
1193	*pfInhibitShw = pCtx->eflags.uBoth & CPUMCTX_INHIBIT_SHADOW;
1194	return CPUMIsInInterruptShadowWithUpdate(pCtx);
1195	}
1196
1197	/**
1198	* Checks if we're in an "interrupt shadow" due to a POP SS or MOV SS
1199	* instruction.
1200	*
1201	* This also inhibit NMIs, except perhaps for nested guests.
1202	*
1203	* @retval true if interrupts are inhibited due to POP/MOV SS.
1204	* @retval false if not.
1205	* @param pCtx Current guest CPU context.
1206	* @note Requires pCtx->rip to be up to date.
1207	* @note Does NOT clear CPUMCTX_INHIBIT_SHADOW when CPUMCTX::uRipInhibitInt
1208	* differs from CPUMCTX::rip.
1209	* @note Both CPUMIsInInterruptShadowAfterSti() and this function may return
1210	* true depending on the execution engine being used.
1211	*/
1212	DECLINLINE(bool) CPUMIsInInterruptShadowAfterSs(PCCPUMCTX pCtx)
1213	{
1214	if (!(pCtx->eflags.uBoth & CPUMCTX_INHIBIT_SHADOW_SS))
1215	return false;
1216
1217	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1218	return pCtx->uRipInhibitInt == pCtx->rip;
1219	}
1220
1221	/**
1222	* Checks if we're in an "interrupt shadow" due to an STI instruction.
1223	*
1224	* This also inhibit NMIs, except perhaps for nested guests.
1225	*
1226	* @retval true if interrupts are inhibited due to STI.
1227	* @retval false if not.
1228	* @param pCtx Current guest CPU context.
1229	* @note Requires pCtx->rip to be up to date.
1230	* @note Does NOT clear CPUMCTX_INHIBIT_SHADOW when CPUMCTX::uRipInhibitInt
1231	* differs from CPUMCTX::rip.
1232	* @note Both CPUMIsInInterruptShadowAfterSs() and this function may return
1233	* true depending on the execution engine being used.
1234	*/
1235	DECLINLINE(bool) CPUMIsInInterruptShadowAfterSti(PCCPUMCTX pCtx)
1236	{
1237	if (!(pCtx->eflags.uBoth & CPUMCTX_INHIBIT_SHADOW_STI))
1238	return false;
1239
1240	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1241	return pCtx->uRipInhibitInt == pCtx->rip;
1242	}
1243
1244	/**
1245	* Sets the "interrupt shadow" flag, after a STI, POP SS or MOV SS instruction.
1246	*
1247	* @param pCtx Current guest CPU context.
1248	* @note Requires pCtx->rip to be up to date.
1249	*/
1250	DECLINLINE(void) CPUMSetInInterruptShadow(PCPUMCTX pCtx)
1251	{
1252	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1253	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_SHADOW;
1254	pCtx->uRipInhibitInt = pCtx->rip;
1255	}
1256
1257	/**
1258	* Sets the "interrupt shadow" flag, after a STI, POP SS or MOV SS instruction,
1259	* extended version.
1260	*
1261	* @param pCtx Current guest CPU context.
1262	* @param rip The RIP for which it is inhibited.
1263	*/
1264	DECLINLINE(void) CPUMSetInInterruptShadowEx(PCPUMCTX pCtx, uint64_t rip)
1265	{
1266	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_SHADOW;
1267	pCtx->uRipInhibitInt = rip;
1268	}
1269
1270	/**
1271	* Sets the "interrupt shadow" flag after a POP SS or MOV SS instruction.
1272	*
1273	* @param pCtx Current guest CPU context.
1274	* @note Requires pCtx->rip to be up to date.
1275	*/
1276	DECLINLINE(void) CPUMSetInInterruptShadowSs(PCPUMCTX pCtx)
1277	{
1278	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1279	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_SHADOW_SS;
1280	pCtx->uRipInhibitInt = pCtx->rip;
1281	}
1282
1283	/**
1284	* Sets the "interrupt shadow" flag after an STI instruction.
1285	*
1286	* @param pCtx Current guest CPU context.
1287	* @note Requires pCtx->rip to be up to date.
1288	*/
1289	DECLINLINE(void) CPUMSetInInterruptShadowSti(PCPUMCTX pCtx)
1290	{
1291	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1292	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_SHADOW_STI;
1293	pCtx->uRipInhibitInt = pCtx->rip;
1294	}
1295
1296	/**
1297	* Clears the "interrupt shadow" flag.
1298	*
1299	* @param pCtx Current guest CPU context.
1300	*/
1301	DECLINLINE(void) CPUMClearInterruptShadow(PCPUMCTX pCtx)
1302	{
1303	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_SHADOW;
1304	}
1305
1306	/**
1307	* Update the "interrupt shadow" flag.
1308	*
1309	* @param pCtx Current guest CPU context.
1310	* @param fInhibited The new state.
1311	* @note Requires pCtx->rip to be up to date.
1312	*/
1313	DECLINLINE(void) CPUMUpdateInterruptShadow(PCPUMCTX pCtx, bool fInhibited)
1314	{
1315	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RIP);
1316	if (!fInhibited)
1317	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_SHADOW;
1318	else
1319	{
1320	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_SHADOW;
1321	pCtx->uRipInhibitInt = pCtx->rip;
1322	}
1323	}
1324
1325	/**
1326	* Update the "interrupt shadow" flag, extended version.
1327	*
1328	* @returns fInhibited.
1329	* @param pCtx Current guest CPU context.
1330	* @param fInhibited The new state.
1331	* @param rip The RIP for which it is inhibited.
1332	*/
1333	DECLINLINE(bool) CPUMUpdateInterruptShadowEx(PCPUMCTX pCtx, bool fInhibited, uint64_t rip)
1334	{
1335	if (!fInhibited)
1336	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_SHADOW;
1337	else
1338	{
1339	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_SHADOW;
1340	pCtx->uRipInhibitInt = rip;
1341	}
1342	return fInhibited;
1343	}
1344
1345	/**
1346	* Update the two "interrupt shadow" flags separately, extended version.
1347	*
1348	* @param pCtx Current guest CPU context.
1349	* @param fInhibitedBySs The new state for the MOV SS & POP SS aspect.
1350	* @param fInhibitedBySti The new state for the STI aspect.
1351	* @param rip The RIP for which it is inhibited.
1352	*/
1353	DECLINLINE(void) CPUMUpdateInterruptShadowSsStiEx(PCPUMCTX pCtx, bool fInhibitedBySs, bool fInhibitedBySti, uint64_t rip)
1354	{
1355	if (!(fInhibitedBySs \| fInhibitedBySti))
1356	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_SHADOW;
1357	else
1358	{
1359	pCtx->eflags.uBoth \|= (fInhibitedBySs ? CPUMCTX_INHIBIT_SHADOW_SS : UINT32_C(0))
1360	\| (fInhibitedBySti ? CPUMCTX_INHIBIT_SHADOW_STI : UINT32_C(0));
1361	pCtx->uRipInhibitInt = rip;
1362	}
1363	}
1364
1365	/* VMX forward declarations used by extended function versions: */
1366	DECLINLINE(bool) CPUMIsGuestInVmxNonRootMode(PCCPUMCTX pCtx);
1367	DECLINLINE(bool) CPUMIsGuestVmxPinCtlsSet(PCCPUMCTX pCtx, uint32_t uPinCtls);
1368	DECLINLINE(bool) CPUMIsGuestVmxVirtNmiBlocking(PCCPUMCTX pCtx);
1369	DECLINLINE(void) CPUMSetGuestVmxVirtNmiBlocking(PCPUMCTX pCtx, bool fBlocking);
1370
1371	/**
1372	* Checks whether interrupts, include NMIs, are inhibited by pending NMI
1373	* delivery.
1374	*
1375	* This only checks the inhibit mask.
1376	*
1377	* @retval true if interrupts are inhibited by NMI handling.
1378	* @retval false if interrupts are not inhibited by NMI handling.
1379	* @param pCtx Current guest CPU context.
1380	*/
1381	DECLINLINE(bool) CPUMAreInterruptsInhibitedByNmi(PCCPUMCTX pCtx)
1382	{
1383	return (pCtx->eflags.uBoth & CPUMCTX_INHIBIT_NMI) != 0;
1384	}
1385
1386	/**
1387	* Extended version of CPUMAreInterruptsInhibitedByNmi() that takes VMX non-root
1388	* mode into account when check whether interrupts are inhibited by NMI.
1389	*
1390	* @retval true if interrupts are inhibited by NMI handling.
1391	* @retval false if interrupts are not inhibited by NMI handling.
1392	* @param pCtx Current guest CPU context.
1393	*/
1394	DECLINLINE(bool) CPUMAreInterruptsInhibitedByNmiEx(PCCPUMCTX pCtx)
1395	{
1396	/* See CPUMUpdateInterruptInhibitingByNmiEx for comments. */
1397	if ( !CPUMIsGuestInVmxNonRootMode(pCtx)
1398	\|\| !CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_VIRT_NMI))
1399	return CPUMAreInterruptsInhibitedByNmi(pCtx);
1400	return CPUMIsGuestVmxVirtNmiBlocking(pCtx);
1401	}
1402
1403	/**
1404	* Marks interrupts, include NMIs, as inhibited by pending NMI delivery.
1405	*
1406	* @param pCtx Current guest CPU context.
1407	*/
1408	DECLINLINE(void) CPUMSetInterruptInhibitingByNmi(PCPUMCTX pCtx)
1409	{
1410	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_NMI;
1411	}
1412
1413	/**
1414	* Extended version of CPUMSetInterruptInhibitingByNmi() that takes VMX non-root
1415	* mode into account when marking interrupts as inhibited by NMI.
1416	*
1417	* @param pCtx Current guest CPU context.
1418	*/
1419	DECLINLINE(void) CPUMSetInterruptInhibitingByNmiEx(PCPUMCTX pCtx)
1420	{
1421	/* See CPUMUpdateInterruptInhibitingByNmiEx for comments. */
1422	if ( !CPUMIsGuestInVmxNonRootMode(pCtx)
1423	\|\| !CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_VIRT_NMI))
1424	CPUMSetInterruptInhibitingByNmi(pCtx);
1425	else
1426	CPUMSetGuestVmxVirtNmiBlocking(pCtx, true);
1427	}
1428
1429	/**
1430	* Marks interrupts, include NMIs, as no longer inhibited by pending NMI
1431	* delivery.
1432	*
1433	* @param pCtx Current guest CPU context.
1434	*/
1435	DECLINLINE(void) CPUMClearInterruptInhibitingByNmi(PCPUMCTX pCtx)
1436	{
1437	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_NMI;
1438	}
1439
1440	/**
1441	* Extended version of CPUMClearInterruptInhibitingByNmi() that takes VMX
1442	* non-root mode into account when doing the updating.
1443	*
1444	* @param pCtx Current guest CPU context.
1445	*/
1446	DECLINLINE(void) CPUMClearInterruptInhibitingByNmiEx(PCPUMCTX pCtx)
1447	{
1448	/* See CPUMUpdateInterruptInhibitingByNmiEx for comments. */
1449	if ( !CPUMIsGuestInVmxNonRootMode(pCtx)
1450	\|\| !CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_VIRT_NMI))
1451	CPUMClearInterruptInhibitingByNmi(pCtx);
1452	else
1453	CPUMSetGuestVmxVirtNmiBlocking(pCtx, false);
1454	}
1455
1456	/**
1457	* Update whether interrupts, include NMIs, are inhibited by pending NMI
1458	* delivery.
1459	*
1460	* @param pCtx Current guest CPU context.
1461	* @param fInhibited The new state.
1462	*/
1463	DECLINLINE(void) CPUMUpdateInterruptInhibitingByNmi(PCPUMCTX pCtx, bool fInhibited)
1464	{
1465	if (!fInhibited)
1466	pCtx->eflags.uBoth &= ~CPUMCTX_INHIBIT_NMI;
1467	else
1468	pCtx->eflags.uBoth \|= CPUMCTX_INHIBIT_NMI;
1469	}
1470
1471	/**
1472	* Extended version of CPUMUpdateInterruptInhibitingByNmi() that takes VMX
1473	* non-root mode into account when doing the updating.
1474	*
1475	* @param pCtx Current guest CPU context.
1476	* @param fInhibited The new state.
1477	*/
1478	DECLINLINE(void) CPUMUpdateInterruptInhibitingByNmiEx(PCPUMCTX pCtx, bool fInhibited)
1479	{
1480	/*
1481	* Set the state of guest-NMI blocking in any of the following cases:
1482	* - We're not executing a nested-guest.
1483	* - We're executing an SVM nested-guest[1].
1484	* - We're executing a VMX nested-guest without virtual-NMIs enabled.
1485	*
1486	* [1] -- SVM does not support virtual-NMIs or virtual-NMI blocking.
1487	* SVM hypervisors must track NMI blocking themselves by intercepting
1488	* the IRET instruction after injection of an NMI.
1489	*/
1490	if ( !CPUMIsGuestInVmxNonRootMode(pCtx)
1491	\|\| !CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_VIRT_NMI))
1492	CPUMUpdateInterruptInhibitingByNmi(pCtx, fInhibited);
1493	/*
1494	* Set the state of virtual-NMI blocking, if we are executing a
1495	* VMX nested-guest with virtual-NMIs enabled.
1496	*/
1497	else
1498	CPUMSetGuestVmxVirtNmiBlocking(pCtx, fInhibited);
1499	}
1500
1501
1502	/**
1503	* Checks if we are executing inside an SVM nested hardware-virtualized guest.
1504	*
1505	* @returns @c true if in SVM nested-guest mode, @c false otherwise.
1506	* @param pCtx Current CPU context.
1507	*/
1508	DECLINLINE(bool) CPUMIsGuestInSvmNestedHwVirtMode(PCCPUMCTX pCtx)
1509	{
1510	/*
1511	* With AMD-V, the VMRUN intercept is a pre-requisite to entering SVM guest-mode.
1512	* See AMD spec. 15.5 "VMRUN instruction" subsection "Canonicalization and Consistency Checks".
1513	*/
1514	#ifndef IN_RC
1515	if ( pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM
1516	\|\| !(pCtx->hwvirt.svm.Vmcb.ctrl.u64InterceptCtrl & SVM_CTRL_INTERCEPT_VMRUN))
1517	return false;
1518	return true;
1519	#else
1520	NOREF(pCtx);
1521	return false;
1522	#endif
1523	}
1524
1525	/**
1526	* Checks if the guest is in VMX non-root operation.
1527	*
1528	* @returns @c true if in VMX non-root operation, @c false otherwise.
1529	* @param pCtx Current CPU context.
1530	*/
1531	DECLINLINE(bool) CPUMIsGuestInVmxNonRootMode(PCCPUMCTX pCtx)
1532	{
1533	#ifndef IN_RC
1534	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_VMX)
1535	return false;
1536	Assert(!pCtx->hwvirt.vmx.fInVmxNonRootMode \|\| pCtx->hwvirt.vmx.fInVmxRootMode);
1537	return pCtx->hwvirt.vmx.fInVmxNonRootMode;
1538	#else
1539	NOREF(pCtx);
1540	return false;
1541	#endif
1542	}
1543
1544	/**
1545	* Checks if we are executing inside an SVM or VMX nested hardware-virtualized
1546	* guest.
1547	*
1548	* @returns @c true if in nested-guest mode, @c false otherwise.
1549	* @param pCtx Current CPU context.
1550	*/
1551	DECLINLINE(bool) CPUMIsGuestInNestedHwvirtMode(PCCPUMCTX pCtx)
1552	{
1553	#if 0
1554	return CPUMIsGuestInVmxNonRootMode(pCtx) \|\| CPUMIsGuestInSvmNestedHwVirtMode(pCtx);
1555	#else
1556	if (pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_NONE)
1557	return false;
1558	if (pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_VMX)
1559	{
1560	Assert(!pCtx->hwvirt.vmx.fInVmxNonRootMode \|\| pCtx->hwvirt.vmx.fInVmxRootMode);
1561	return pCtx->hwvirt.vmx.fInVmxNonRootMode;
1562	}
1563	Assert(pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_SVM);
1564	return RT_BOOL(pCtx->hwvirt.svm.Vmcb.ctrl.u64InterceptCtrl & SVM_CTRL_INTERCEPT_VMRUN);
1565	#endif
1566	}
1567
1568	/**
1569	* Checks if we are executing inside an SVM or VMX nested hardware-virtualized
1570	* guest.
1571	*
1572	* @retval CPUMHWVIRT_NONE if not in SVM or VMX non-root mode.
1573	* @retval CPUMHWVIRT_VMX if in VMX non-root mode.
1574	* @retval CPUMHWVIRT_SVM if in SVM non-root mode.
1575	* @param pCtx Current CPU context.
1576	*/
1577	DECLINLINE(CPUMHWVIRT) CPUMGetGuestInNestedHwvirtMode(PCCPUMCTX pCtx)
1578	{
1579	if (pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_NONE)
1580	return CPUMHWVIRT_NONE;
1581	if (pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_VMX)
1582	{
1583	Assert(!pCtx->hwvirt.vmx.fInVmxNonRootMode \|\| pCtx->hwvirt.vmx.fInVmxRootMode);
1584	return pCtx->hwvirt.vmx.fInVmxNonRootMode ? CPUMHWVIRT_VMX : CPUMHWVIRT_NONE;
1585	}
1586	Assert(pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_SVM);
1587	return pCtx->hwvirt.svm.Vmcb.ctrl.u64InterceptCtrl & SVM_CTRL_INTERCEPT_VMRUN ? CPUMHWVIRT_SVM : CPUMHWVIRT_NONE;
1588	}
1589
1590	/**
1591	* Checks if the guest is in VMX root operation.
1592	*
1593	* @returns @c true if in VMX root operation, @c false otherwise.
1594	* @param pCtx Current CPU context.
1595	*/
1596	DECLINLINE(bool) CPUMIsGuestInVmxRootMode(PCCPUMCTX pCtx)
1597	{
1598	#ifndef IN_RC
1599	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_VMX)
1600	return false;
1601	return pCtx->hwvirt.vmx.fInVmxRootMode;
1602	#else
1603	NOREF(pCtx);
1604	return false;
1605	#endif
1606	}
1607
1608	# ifndef IN_RC
1609
1610	/**
1611	* Checks if the nested-guest VMCB has the specified ctrl/instruction intercept
1612	* active.
1613	*
1614	* @returns @c true if in intercept is set, @c false otherwise.
1615	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1616	* @param pCtx Current CPU context.
1617	* @param fIntercept The SVM control/instruction intercept, see
1618	* SVM_CTRL_INTERCEPT_*.
1619	*/
1620	DECLINLINE(bool) CPUMIsGuestSvmCtrlInterceptSet(PCVMCPU pVCpu, PCCPUMCTX pCtx, uint64_t fIntercept)
1621	{
1622	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1623	return false;
1624	uint64_t u64Intercepts;
1625	if (!HMGetGuestSvmCtrlIntercepts(pVCpu, &u64Intercepts))
1626	u64Intercepts = pCtx->hwvirt.svm.Vmcb.ctrl.u64InterceptCtrl;
1627	return RT_BOOL(u64Intercepts & fIntercept);
1628	}
1629
1630	/**
1631	* Checks if the nested-guest VMCB has the specified CR read intercept active.
1632	*
1633	* @returns @c true if in intercept is set, @c false otherwise.
1634	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1635	* @param pCtx Current CPU context.
1636	* @param uCr The CR register number (0 to 15).
1637	*/
1638	DECLINLINE(bool) CPUMIsGuestSvmReadCRxInterceptSet(PCVMCPU pVCpu, PCCPUMCTX pCtx, uint8_t uCr)
1639	{
1640	Assert(uCr < 16);
1641	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1642	return false;
1643	uint16_t u16Intercepts;
1644	if (!HMGetGuestSvmReadCRxIntercepts(pVCpu, &u16Intercepts))
1645	u16Intercepts = pCtx->hwvirt.svm.Vmcb.ctrl.u16InterceptRdCRx;
1646	return RT_BOOL(u16Intercepts & (UINT16_C(1) << uCr));
1647	}
1648
1649	/**
1650	* Checks if the nested-guest VMCB has the specified CR write intercept active.
1651	*
1652	* @returns @c true if in intercept is set, @c false otherwise.
1653	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1654	* @param pCtx Current CPU context.
1655	* @param uCr The CR register number (0 to 15).
1656	*/
1657	DECLINLINE(bool) CPUMIsGuestSvmWriteCRxInterceptSet(PCVMCPU pVCpu, PCCPUMCTX pCtx, uint8_t uCr)
1658	{
1659	Assert(uCr < 16);
1660	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1661	return false;
1662	uint16_t u16Intercepts;
1663	if (!HMGetGuestSvmWriteCRxIntercepts(pVCpu, &u16Intercepts))
1664	u16Intercepts = pCtx->hwvirt.svm.Vmcb.ctrl.u16InterceptWrCRx;
1665	return RT_BOOL(u16Intercepts & (UINT16_C(1) << uCr));
1666	}
1667
1668	/**
1669	* Checks if the nested-guest VMCB has the specified DR read intercept active.
1670	*
1671	* @returns @c true if in intercept is set, @c false otherwise.
1672	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1673	* @param pCtx Current CPU context.
1674	* @param uDr The DR register number (0 to 15).
1675	*/
1676	DECLINLINE(bool) CPUMIsGuestSvmReadDRxInterceptSet(PCVMCPU pVCpu, PCCPUMCTX pCtx, uint8_t uDr)
1677	{
1678	Assert(uDr < 16);
1679	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1680	return false;
1681	uint16_t u16Intercepts;
1682	if (!HMGetGuestSvmReadDRxIntercepts(pVCpu, &u16Intercepts))
1683	u16Intercepts = pCtx->hwvirt.svm.Vmcb.ctrl.u16InterceptRdDRx;
1684	return RT_BOOL(u16Intercepts & (UINT16_C(1) << uDr));
1685	}
1686
1687	/**
1688	* Checks if the nested-guest VMCB has the specified DR write intercept active.
1689	*
1690	* @returns @c true if in intercept is set, @c false otherwise.
1691	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1692	* @param pCtx Current CPU context.
1693	* @param uDr The DR register number (0 to 15).
1694	*/
1695	DECLINLINE(bool) CPUMIsGuestSvmWriteDRxInterceptSet(PCVMCPU pVCpu, PCCPUMCTX pCtx, uint8_t uDr)
1696	{
1697	Assert(uDr < 16);
1698	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1699	return false;
1700	uint16_t u16Intercepts;
1701	if (!HMGetGuestSvmWriteDRxIntercepts(pVCpu, &u16Intercepts))
1702	u16Intercepts = pCtx->hwvirt.svm.Vmcb.ctrl.u16InterceptWrDRx;
1703	return RT_BOOL(u16Intercepts & (UINT16_C(1) << uDr));
1704	}
1705
1706	/**
1707	* Checks if the nested-guest VMCB has the specified exception intercept active.
1708	*
1709	* @returns @c true if in intercept is active, @c false otherwise.
1710	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1711	* @param pCtx Current CPU context.
1712	* @param uVector The exception / interrupt vector.
1713	*/
1714	DECLINLINE(bool) CPUMIsGuestSvmXcptInterceptSet(PCVMCPU pVCpu, PCCPUMCTX pCtx, uint8_t uVector)
1715	{
1716	Assert(uVector <= X86_XCPT_LAST);
1717	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1718	return false;
1719	uint32_t u32Intercepts;
1720	if (!HMGetGuestSvmXcptIntercepts(pVCpu, &u32Intercepts))
1721	u32Intercepts = pCtx->hwvirt.svm.Vmcb.ctrl.u32InterceptXcpt;
1722	return RT_BOOL(u32Intercepts & RT_BIT(uVector));
1723	}
1724
1725	/**
1726	* Checks if the nested-guest VMCB has virtual-interrupt masking enabled.
1727	*
1728	* @returns @c true if virtual-interrupts are masked, @c false otherwise.
1729	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1730	* @param pCtx Current CPU context.
1731	*
1732	* @remarks Should only be called when SVM feature is exposed to the guest.
1733	*/
1734	DECLINLINE(bool) CPUMIsGuestSvmVirtIntrMasking(PCVMCPU pVCpu, PCCPUMCTX pCtx)
1735	{
1736	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1737	return false;
1738	bool fVIntrMasking;
1739	if (!HMGetGuestSvmVirtIntrMasking(pVCpu, &fVIntrMasking))
1740	fVIntrMasking = pCtx->hwvirt.svm.Vmcb.ctrl.IntCtrl.n.u1VIntrMasking;
1741	return fVIntrMasking;
1742	}
1743
1744	/**
1745	* Checks if the nested-guest VMCB has nested-paging enabled.
1746	*
1747	* @returns @c true if nested-paging is enabled, @c false otherwise.
1748	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1749	* @param pCtx Current CPU context.
1750	*
1751	* @remarks Should only be called when SVM feature is exposed to the guest.
1752	*/
1753	DECLINLINE(bool) CPUMIsGuestSvmNestedPagingEnabled(PCVMCPU pVCpu, PCCPUMCTX pCtx)
1754	{
1755	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1756	return false;
1757	bool fNestedPaging;
1758	if (!HMGetGuestSvmNestedPaging(pVCpu, &fNestedPaging))
1759	fNestedPaging = pCtx->hwvirt.svm.Vmcb.ctrl.NestedPagingCtrl.n.u1NestedPaging;
1760	return fNestedPaging;
1761	}
1762
1763	/**
1764	* Gets the nested-guest VMCB pause-filter count.
1765	*
1766	* @returns The pause-filter count.
1767	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1768	* @param pCtx Current CPU context.
1769	*
1770	* @remarks Should only be called when SVM feature is exposed to the guest.
1771	*/
1772	DECLINLINE(uint16_t) CPUMGetGuestSvmPauseFilterCount(PCVMCPU pVCpu, PCCPUMCTX pCtx)
1773	{
1774	if (pCtx->hwvirt.enmHwvirt != CPUMHWVIRT_SVM)
1775	return false;
1776	uint16_t u16PauseFilterCount;
1777	if (!HMGetGuestSvmPauseFilterCount(pVCpu, &u16PauseFilterCount))
1778	u16PauseFilterCount = pCtx->hwvirt.svm.Vmcb.ctrl.u16PauseFilterCount;
1779	return u16PauseFilterCount;
1780	}
1781
1782	/**
1783	* Updates the NextRIP (NRIP) field in the nested-guest VMCB.
1784	*
1785	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
1786	* @param pCtx Current CPU context.
1787	* @param cbInstr The length of the current instruction in bytes.
1788	*
1789	* @remarks Should only be called when SVM feature is exposed to the guest.
1790	*/
1791	DECLINLINE(void) CPUMGuestSvmUpdateNRip(PVMCPU pVCpu, PCPUMCTX pCtx, uint8_t cbInstr)
1792	{
1793	RT_NOREF(pVCpu);
1794	Assert(pCtx->hwvirt.enmHwvirt == CPUMHWVIRT_SVM);
1795	pCtx->hwvirt.svm.Vmcb.ctrl.u64NextRIP = pCtx->rip + cbInstr;
1796	}
1797
1798	/**
1799	* Checks whether one of the given Pin-based VM-execution controls are set when
1800	* executing a nested-guest.
1801	*
1802	* @returns @c true if set, @c false otherwise.
1803	* @param pCtx Current CPU context.
1804	* @param uPinCtls The Pin-based VM-execution controls to check.
1805	*
1806	* @remarks This does not check if all given controls are set if more than one
1807	* control is passed in @a uPinCtl.
1808	*/
1809	DECLINLINE(bool) CPUMIsGuestVmxPinCtlsSet(PCCPUMCTX pCtx, uint32_t uPinCtls)
1810	{
1811	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1812	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u32PinCtls & uPinCtls);
1813	}
1814
1815	/**
1816	* Checks whether one of the given Processor-based VM-execution controls are set
1817	* when executing a nested-guest.
1818	*
1819	* @returns @c true if set, @c false otherwise.
1820	* @param pCtx Current CPU context.
1821	* @param uProcCtls The Processor-based VM-execution controls to check.
1822	*
1823	* @remarks This does not check if all given controls are set if more than one
1824	* control is passed in @a uProcCtls.
1825	*/
1826	DECLINLINE(bool) CPUMIsGuestVmxProcCtlsSet(PCCPUMCTX pCtx, uint32_t uProcCtls)
1827	{
1828	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1829	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u32ProcCtls & uProcCtls);
1830	}
1831
1832	/**
1833	* Checks whether one of the given Secondary Processor-based VM-execution controls
1834	* are set when executing a nested-guest.
1835	*
1836	* @returns @c true if set, @c false otherwise.
1837	* @param pCtx Current CPU context.
1838	* @param uProcCtls2 The Secondary Processor-based VM-execution controls to
1839	* check.
1840	*
1841	* @remarks This does not check if all given controls are set if more than one
1842	* control is passed in @a uProcCtls2.
1843	*/
1844	DECLINLINE(bool) CPUMIsGuestVmxProcCtls2Set(PCCPUMCTX pCtx, uint32_t uProcCtls2)
1845	{
1846	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1847	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u32ProcCtls2 & uProcCtls2);
1848	}
1849
1850	/**
1851	* Checks whether one of the given Tertiary Processor-based VM-execution controls
1852	* are set when executing a nested-guest.
1853	*
1854	* @returns @c true if set, @c false otherwise.
1855	* @param pCtx Current CPU context.
1856	* @param uProcCtls3 The Tertiary Processor-based VM-execution controls to
1857	* check.
1858	*
1859	* @remarks This does not check if all given controls are set if more than one
1860	* control is passed in @a uProcCtls3.
1861	*/
1862	DECLINLINE(bool) CPUMIsGuestVmxProcCtls3Set(PCCPUMCTX pCtx, uint64_t uProcCtls3)
1863	{
1864	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1865	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u64ProcCtls3.u & uProcCtls3);
1866	}
1867
1868	/**
1869	* Checks whether one of the given VM-exit controls are set when executing a
1870	* nested-guest.
1871	*
1872	* @returns @c true if set, @c false otherwise.
1873	* @param pCtx Current CPU context.
1874	* @param uExitCtls The VM-exit controls to check.
1875	*
1876	* @remarks This does not check if all given controls are set if more than one
1877	* control is passed in @a uExitCtls.
1878	*/
1879	DECLINLINE(bool) CPUMIsGuestVmxExitCtlsSet(PCCPUMCTX pCtx, uint32_t uExitCtls)
1880	{
1881	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1882	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u32ExitCtls & uExitCtls);
1883	}
1884
1885	/**
1886	* Checks whether one of the given VM-entry controls are set when executing a
1887	* nested-guest.
1888	*
1889	* @returns @c true if set, @c false otherwise.
1890	* @param pCtx Current CPU context.
1891	* @param uEntryCtls The VM-entry controls to check.
1892	*
1893	* @remarks This does not check if all given controls are set if more than one
1894	* control is passed in @a uEntryCtls.
1895	*/
1896	DECLINLINE(bool) CPUMIsGuestVmxEntryCtlsSet(PCCPUMCTX pCtx, uint32_t uEntryCtls)
1897	{
1898	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1899	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u32EntryCtls & uEntryCtls);
1900	}
1901
1902	/**
1903	* Checks whether events injected in the nested-guest are subject to VM-exit checks.
1904	*
1905	* @returns @c true if set, @c false otherwise.
1906	* @param pCtx Current CPU context.
1907	*/
1908	DECLINLINE(bool) CPUMIsGuestVmxInterceptEvents(PCCPUMCTX pCtx)
1909	{
1910	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1911	return pCtx->hwvirt.vmx.fInterceptEvents;
1912	}
1913
1914	/**
1915	* Sets whether events injected in the nested-guest are subject to VM-exit checks.
1916	*
1917	* @param pCtx Current CPU context.
1918	* @param fIntercept Whether to subject injected events to VM-exits or not.
1919	*/
1920	DECLINLINE(void) CPUMSetGuestVmxInterceptEvents(PCPUMCTX pCtx, bool fInterceptEvents)
1921	{
1922	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1923	pCtx->hwvirt.vmx.fInterceptEvents = fInterceptEvents;
1924	}
1925
1926	/**
1927	* Checks whether the given exception causes a VM-exit.
1928	*
1929	* The exception type include hardware exceptions, software exceptions (#BP, #OF)
1930	* and privileged software exceptions (#DB generated by INT1/ICEBP).
1931	*
1932	* Software interrupts do -not- cause VM-exits and hence must not be used with this
1933	* function.
1934	*
1935	* @returns @c true if the exception causes a VM-exit, @c false otherwise.
1936	* @param pCtx Current CPU context.
1937	* @param uVector The exception vector.
1938	* @param uErrCode The error code associated with the exception. Pass 0 if not
1939	* applicable.
1940	*/
1941	DECLINLINE(bool) CPUMIsGuestVmxXcptInterceptSet(PCCPUMCTX pCtx, uint8_t uVector, uint32_t uErrCode)
1942	{
1943	Assert(uVector <= X86_XCPT_LAST);
1944
1945	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
1946
1947	/* NMIs have a dedicated VM-execution control for causing VM-exits. */
1948	if (uVector == X86_XCPT_NMI)
1949	return RT_BOOL(pCtx->hwvirt.vmx.Vmcs.u32PinCtls & VMX_PIN_CTLS_NMI_EXIT);
1950
1951	/* Page-faults are subject to masking using its error code. */
1952	uint32_t fXcptBitmap = pCtx->hwvirt.vmx.Vmcs.u32XcptBitmap;
1953	if (uVector == X86_XCPT_PF)
1954	{
1955	uint32_t const fXcptPFMask = pCtx->hwvirt.vmx.Vmcs.u32XcptPFMask;
1956	uint32_t const fXcptPFMatch = pCtx->hwvirt.vmx.Vmcs.u32XcptPFMatch;
1957	if ((uErrCode & fXcptPFMask) != fXcptPFMatch)
1958	fXcptBitmap ^= RT_BIT(X86_XCPT_PF);
1959	}
1960
1961	/* Consult the exception bitmap for all other exceptions. */
1962	if (fXcptBitmap & RT_BIT(uVector))
1963	return true;
1964	return false;
1965	}
1966
1967
1968	/**
1969	* Checks whether the guest is in VMX non-root mode and using EPT paging.
1970	*
1971	* @returns @c true if in VMX non-root operation with EPT, @c false otherwise.
1972	* @param pCtx Current CPU context.
1973	*/
1974	DECLINLINE(bool) CPUMIsGuestVmxEptPagingEnabledEx(PCCPUMCTX pCtx)
1975	{
1976	return CPUMIsGuestInVmxNonRootMode(pCtx)
1977	&& CPUMIsGuestVmxProcCtls2Set(pCtx, VMX_PROC_CTLS2_EPT);
1978	}
1979
1980
1981	/**
1982	* Implements VMSucceed for VMX instruction success.
1983	*
1984	* @param pCtx Current CPU context.
1985	*/
1986	DECLINLINE(void) CPUMSetGuestVmxVmSucceed(PCPUMCTX pCtx)
1987	{
1988	pCtx->eflags.uBoth &= ~(X86_EFL_CF \| X86_EFL_PF \| X86_EFL_AF \| X86_EFL_ZF \| X86_EFL_SF \| X86_EFL_OF);
1989	}
1990
1991	/**
1992	* Implements VMFailInvalid for VMX instruction failure.
1993	*
1994	* @param pCtx Current CPU context.
1995	*/
1996	DECLINLINE(void) CPUMSetGuestVmxVmFailInvalid(PCPUMCTX pCtx)
1997	{
1998	pCtx->eflags.uBoth &= ~(X86_EFL_PF \| X86_EFL_AF \| X86_EFL_ZF \| X86_EFL_SF \| X86_EFL_OF);
1999	pCtx->eflags.uBoth \|= X86_EFL_CF;
2000	}
2001
2002	/**
2003	* Implements VMFailValid for VMX instruction failure.
2004	*
2005	* @param pCtx Current CPU context.
2006	* @param enmInsErr The VM instruction error.
2007	*/
2008	DECLINLINE(void) CPUMSetGuestVmxVmFailValid(PCPUMCTX pCtx, VMXINSTRERR enmInsErr)
2009	{
2010	pCtx->eflags.uBoth &= ~(X86_EFL_CF \| X86_EFL_PF \| X86_EFL_AF \| X86_EFL_ZF \| X86_EFL_SF \| X86_EFL_OF);
2011	pCtx->eflags.uBoth \|= X86_EFL_ZF;
2012	pCtx->hwvirt.vmx.Vmcs.u32RoVmInstrError = enmInsErr;
2013	}
2014
2015	/**
2016	* Implements VMFail for VMX instruction failure.
2017	*
2018	* @param pCtx Current CPU context.
2019	* @param enmInsErr The VM instruction error.
2020	*/
2021	DECLINLINE(void) CPUMSetGuestVmxVmFail(PCPUMCTX pCtx, VMXINSTRERR enmInsErr)
2022	{
2023	if (pCtx->hwvirt.vmx.GCPhysVmcs != NIL_RTGCPHYS)
2024	CPUMSetGuestVmxVmFailValid(pCtx, enmInsErr);
2025	else
2026	CPUMSetGuestVmxVmFailInvalid(pCtx);
2027	}
2028
2029	/**
2030	* Returns the guest-physical address of the APIC-access page when executing a
2031	* nested-guest.
2032	*
2033	* @returns The APIC-access page guest-physical address.
2034	* @param pCtx Current CPU context.
2035	*/
2036	DECLINLINE(uint64_t) CPUMGetGuestVmxApicAccessPageAddrEx(PCCPUMCTX pCtx)
2037	{
2038	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2039	return pCtx->hwvirt.vmx.Vmcs.u64AddrApicAccess.u;
2040	}
2041
2042	/**
2043	* Gets the nested-guest CR0 subject to the guest/host mask and the read-shadow.
2044	*
2045	* @returns The nested-guest CR0.
2046	* @param pCtx Current CPU context.
2047	* @param fGstHostMask The CR0 guest/host mask to use.
2048	*/
2049	DECLINLINE(uint64_t) CPUMGetGuestVmxMaskedCr0(PCCPUMCTX pCtx, uint64_t fGstHostMask)
2050	{
2051	/*
2052	* For each CR0 bit owned by the host, the corresponding bit from the
2053	* CR0 read shadow is loaded. For each CR0 bit that is not owned by the host,
2054	* the corresponding bit from the guest CR0 is loaded.
2055	*
2056	* See Intel Spec. 25.3 "Changes To Instruction Behavior In VMX Non-root Operation".
2057	*/
2058	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2059	uint64_t const uGstCr0 = pCtx->cr0;
2060	uint64_t const fReadShadow = pCtx->hwvirt.vmx.Vmcs.u64Cr0ReadShadow.u;
2061	return (fReadShadow & fGstHostMask) \| (uGstCr0 & ~fGstHostMask);
2062	}
2063
2064	/**
2065	* Gets the nested-guest CR4 subject to the guest/host mask and the read-shadow.
2066	*
2067	* @returns The nested-guest CR4.
2068	* @param pCtx Current CPU context.
2069	* @param fGstHostMask The CR4 guest/host mask to use.
2070	*/
2071	DECLINLINE(uint64_t) CPUMGetGuestVmxMaskedCr4(PCCPUMCTX pCtx, uint64_t fGstHostMask)
2072	{
2073	/*
2074	* For each CR4 bit owned by the host, the corresponding bit from the
2075	* CR4 read shadow is loaded. For each CR4 bit that is not owned by the host,
2076	* the corresponding bit from the guest CR4 is loaded.
2077	*
2078	* See Intel Spec. 25.3 "Changes To Instruction Behavior In VMX Non-root Operation".
2079	*/
2080	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2081	uint64_t const uGstCr4 = pCtx->cr4;
2082	uint64_t const fReadShadow = pCtx->hwvirt.vmx.Vmcs.u64Cr4ReadShadow.u;
2083	return (fReadShadow & fGstHostMask) \| (uGstCr4 & ~fGstHostMask);
2084	}
2085
2086	/**
2087	* Checks whether the LMSW access causes a VM-exit or not.
2088	*
2089	* @returns @c true if the LMSW access causes a VM-exit, @c false otherwise.
2090	* @param pCtx Current CPU context.
2091	* @param uNewMsw The LMSW source operand (the Machine Status Word).
2092	*/
2093	DECLINLINE(bool) CPUMIsGuestVmxLmswInterceptSet(PCCPUMCTX pCtx, uint16_t uNewMsw)
2094	{
2095	/*
2096	* LMSW VM-exits are subject to the CR0 guest/host mask and the CR0 read shadow.
2097	*
2098	* See Intel spec. 24.6.6 "Guest/Host Masks and Read Shadows for CR0 and CR4".
2099	* See Intel spec. 25.1.3 "Instructions That Cause VM Exits Conditionally".
2100	*/
2101	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2102
2103	uint32_t const fGstHostMask = (uint32_t)pCtx->hwvirt.vmx.Vmcs.u64Cr0Mask.u;
2104	uint32_t const fReadShadow = (uint32_t)pCtx->hwvirt.vmx.Vmcs.u64Cr0ReadShadow.u;
2105
2106	/*
2107	* LMSW can never clear CR0.PE but it may set it. Hence, we handle the
2108	* CR0.PE case first, before the rest of the bits in the MSW.
2109	*
2110	* If CR0.PE is owned by the host and CR0.PE differs between the
2111	* MSW (source operand) and the read-shadow, we must cause a VM-exit.
2112	*/
2113	if ( (fGstHostMask & X86_CR0_PE)
2114	&& (uNewMsw & X86_CR0_PE)
2115	&& !(fReadShadow & X86_CR0_PE))
2116	return true;
2117
2118	/*
2119	* If CR0.MP, CR0.EM or CR0.TS is owned by the host, and the corresponding
2120	* bits differ between the MSW (source operand) and the read-shadow, we must
2121	* cause a VM-exit.
2122	*/
2123	uint32_t const fGstHostLmswMask = fGstHostMask & (X86_CR0_MP \| X86_CR0_EM \| X86_CR0_TS);
2124	if ((fReadShadow & fGstHostLmswMask) != (uNewMsw & fGstHostLmswMask))
2125	return true;
2126
2127	return false;
2128	}
2129
2130	/**
2131	* Checks whether the Mov-to-CR0/CR4 access causes a VM-exit or not.
2132	*
2133	* @returns @c true if the Mov CRX access causes a VM-exit, @c false otherwise.
2134	* @param pCtx Current CPU context.
2135	* @param iCrReg The control register number (must be 0 or 4).
2136	* @param uNewCrX The CR0/CR4 value being written.
2137	*/
2138	DECLINLINE(bool) CPUMIsGuestVmxMovToCr0Cr4InterceptSet(PCCPUMCTX pCtx, uint8_t iCrReg, uint64_t uNewCrX)
2139	{
2140	/*
2141	* For any CR0/CR4 bit owned by the host (in the CR0/CR4 guest/host mask), if the
2142	* corresponding bits differ between the source operand and the read-shadow,
2143	* we must cause a VM-exit.
2144	*
2145	* See Intel spec. 25.1.3 "Instructions That Cause VM Exits Conditionally".
2146	*/
2147	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2148	Assert(iCrReg == 0 \|\| iCrReg == 4);
2149
2150	uint64_t fGstHostMask;
2151	uint64_t fReadShadow;
2152	if (iCrReg == 0)
2153	{
2154	fGstHostMask = pCtx->hwvirt.vmx.Vmcs.u64Cr0Mask.u;
2155	fReadShadow = pCtx->hwvirt.vmx.Vmcs.u64Cr0ReadShadow.u;
2156	}
2157	else
2158	{
2159	fGstHostMask = pCtx->hwvirt.vmx.Vmcs.u64Cr4Mask.u;
2160	fReadShadow = pCtx->hwvirt.vmx.Vmcs.u64Cr4ReadShadow.u;
2161	}
2162
2163	if ((fReadShadow & fGstHostMask) != (uNewCrX & fGstHostMask))
2164	{
2165	Assert(fGstHostMask != 0);
2166	return true;
2167	}
2168
2169	return false;
2170	}
2171
2172	/**
2173	* Returns whether the guest has an active, current VMCS.
2174	*
2175	* @returns @c true if the guest has an active, current VMCS, @c false otherwise.
2176	* @param pCtx Current CPU context.
2177	*/
2178	DECLINLINE(bool) CPUMIsGuestVmxCurrentVmcsValid(PCCPUMCTX pCtx)
2179	{
2180	return pCtx->hwvirt.vmx.GCPhysVmcs != NIL_RTGCPHYS;
2181	}
2182
2183	# endif /* !IN_RC */
2184
2185	/**
2186	* Checks whether the VMX nested-guest is in a state to receive physical (APIC)
2187	* interrupts.
2188	*
2189	* @returns @c true if it's ready, @c false otherwise.
2190	* @param pCtx The guest-CPU context.
2191	*/
2192	DECLINLINE(bool) CPUMIsGuestVmxPhysIntrEnabled(PCCPUMCTX pCtx)
2193	{
2194	#ifdef IN_RC
2195	AssertReleaseFailedReturn(false);
2196	#else
2197	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2198	if (CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_EXT_INT_EXIT))
2199	return true;
2200	CPUMCTX_ASSERT_NOT_EXTRN(pCtx, CPUMCTX_EXTRN_RFLAGS);
2201	return RT_BOOL(pCtx->eflags.u & X86_EFL_IF);
2202	#endif
2203	}
2204
2205	/**
2206	* Checks whether the VMX nested-guest is blocking virtual-NMIs.
2207	*
2208	* @returns @c true if it's blocked, @c false otherwise.
2209	* @param pCtx The guest-CPU context.
2210	*/
2211	DECLINLINE(bool) CPUMIsGuestVmxVirtNmiBlocking(PCCPUMCTX pCtx)
2212	{
2213	#ifdef IN_RC
2214	RT_NOREF(pCtx);
2215	AssertReleaseFailedReturn(false);
2216	#else
2217	/*
2218	* Return the state of virtual-NMI blocking, if we are executing a
2219	* VMX nested-guest with virtual-NMIs enabled.
2220	*/
2221	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2222	Assert(CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_VIRT_NMI));
2223	return pCtx->hwvirt.vmx.fVirtNmiBlocking;
2224	#endif
2225	}
2226
2227	/**
2228	* Sets or clears VMX nested-guest virtual-NMI blocking.
2229	*
2230	* @param pCtx The guest-CPU context.
2231	* @param fBlocking Whether virtual-NMI blocking is in effect or not.
2232	*/
2233	DECLINLINE(void) CPUMSetGuestVmxVirtNmiBlocking(PCPUMCTX pCtx, bool fBlocking)
2234	{
2235	#ifdef IN_RC
2236	RT_NOREF2(pCtx, fBlocking);
2237	AssertReleaseFailedReturnVoid();
2238	#else
2239	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2240	Assert(CPUMIsGuestVmxPinCtlsSet(pCtx, VMX_PIN_CTLS_VIRT_NMI));
2241	pCtx->hwvirt.vmx.fVirtNmiBlocking = fBlocking;
2242	#endif
2243	}
2244
2245	/**
2246	* Checks whether the VMX nested-guest is in a state to receive virtual interrupts
2247	* (those injected with the "virtual-interrupt delivery" feature).
2248	*
2249	* @returns @c true if it's ready, @c false otherwise.
2250	* @param pCtx The guest-CPU context.
2251	*/
2252	DECLINLINE(bool) CPUMIsGuestVmxVirtIntrEnabled(PCCPUMCTX pCtx)
2253	{
2254	#ifdef IN_RC
2255	RT_NOREF2(pCtx);
2256	AssertReleaseFailedReturn(false);
2257	#else
2258	Assert(CPUMIsGuestInVmxNonRootMode(pCtx));
2259	return RT_BOOL(pCtx->eflags.u & X86_EFL_IF);
2260	#endif
2261	}
2262
2263	/** @} */
2264	#endif /* !IPRT_WITHOUT_NAMED_UNIONS_AND_STRUCTS \|\| DOXYGEN_RUNNING */
2265
2266
2267
2268	/** @name Hypervisor Register Getters.
2269	* @{ */
2270	VMMDECL(RTGCUINTREG) CPUMGetHyperDR0(PVMCPU pVCpu);
2271	VMMDECL(RTGCUINTREG) CPUMGetHyperDR1(PVMCPU pVCpu);
2272	VMMDECL(RTGCUINTREG) CPUMGetHyperDR2(PVMCPU pVCpu);
2273	VMMDECL(RTGCUINTREG) CPUMGetHyperDR3(PVMCPU pVCpu);
2274	VMMDECL(RTGCUINTREG) CPUMGetHyperDR6(PVMCPU pVCpu);
2275	VMMDECL(RTGCUINTREG) CPUMGetHyperDR7(PVMCPU pVCpu);
2276	VMMDECL(uint32_t) CPUMGetHyperCR3(PVMCPU pVCpu);
2277	/** @} */
2278
2279	/** @name Hypervisor Register Setters.
2280	* @{ */
2281	VMMDECL(void) CPUMSetHyperCR3(PVMCPU pVCpu, uint32_t cr3);
2282	VMMDECL(void) CPUMSetHyperDR6(PVMCPU pVCpu, RTGCUINTREG uDr6);
2283	VMMDECL(void) CPUMSetHyperDR7(PVMCPU pVCpu, RTGCUINTREG uDr7);
2284	VMMDECL(int) CPUMRecalcHyperDRx(PVMCPUCC pVCpu, uint8_t iGstReg);
2285	/** @} */
2286
2287	#ifdef VBOX_INCLUDED_vmm_cpumctx_h
2288	VMM_INT_DECL(PCPUMCTXMSRS) CPUMQueryGuestCtxMsrsPtr(PVMCPU pVCpu);
2289	#endif
2290
2291	/** @name Changed flags.
2292	* These flags are used to keep track of which important register that
2293	* have been changed since last they were reset. The only one allowed
2294	* to clear them is REM!
2295	*
2296	* @todo This is obsolete, but remains as it will be refactored for coordinating
2297	* IEM and NEM/HM later. Probably.
2298	* @{
2299	*/
2300	#define CPUM_CHANGED_FPU_REM RT_BIT(0)
2301	#define CPUM_CHANGED_CR0 RT_BIT(1)
2302	#define CPUM_CHANGED_CR4 RT_BIT(2)
2303	#define CPUM_CHANGED_GLOBAL_TLB_FLUSH RT_BIT(3)
2304	#define CPUM_CHANGED_CR3 RT_BIT(4)
2305	#define CPUM_CHANGED_GDTR RT_BIT(5)
2306	#define CPUM_CHANGED_IDTR RT_BIT(6)
2307	#define CPUM_CHANGED_LDTR RT_BIT(7)
2308	#define CPUM_CHANGED_TR RT_BIT(8) /*@< Currently unused. /
2309	#define CPUM_CHANGED_SYSENTER_MSR RT_BIT(9)
2310	#define CPUM_CHANGED_HIDDEN_SEL_REGS RT_BIT(10) /*@< Currently unused. /
2311	#define CPUM_CHANGED_CPUID RT_BIT(11)
2312	#define CPUM_CHANGED_ALL ( CPUM_CHANGED_FPU_REM \
2313	\| CPUM_CHANGED_CR0 \
2314	\| CPUM_CHANGED_CR4 \
2315	\| CPUM_CHANGED_GLOBAL_TLB_FLUSH \
2316	\| CPUM_CHANGED_CR3 \
2317	\| CPUM_CHANGED_GDTR \
2318	\| CPUM_CHANGED_IDTR \
2319	\| CPUM_CHANGED_LDTR \
2320	\| CPUM_CHANGED_TR \
2321	\| CPUM_CHANGED_SYSENTER_MSR \
2322	\| CPUM_CHANGED_HIDDEN_SEL_REGS \
2323	\| CPUM_CHANGED_CPUID )
2324	/** @} */
2325
2326	VMMDECL(bool) CPUMIsHostUsingSysEnter(PVM pVM);
2327	VMMDECL(bool) CPUMIsHostUsingSysCall(PVM pVM);
2328	VMMDECL(bool) CPUMIsGuestFPUStateActive(PVMCPU pVCpu);
2329	VMMDECL(bool) CPUMIsGuestFPUStateLoaded(PVMCPU pVCpu);
2330	VMMDECL(bool) CPUMIsHostFPUStateSaved(PVMCPU pVCpu);
2331	VMMDECL(bool) CPUMIsGuestDebugStateActive(PVMCPU pVCpu);
2332	VMMDECL(void) CPUMDeactivateGuestDebugState(PVMCPU pVCpu);
2333	VMMDECL(bool) CPUMIsHyperDebugStateActive(PVMCPU pVCpu);
2334	VMMDECL(uint32_t) CPUMGetGuestCPL(PVMCPU pVCpu);
2335	VMMDECL(uint32_t) CPUMGetGuestMxCsrMask(PVM pVM);
2336	VMMDECL(uint64_t) CPUMGetGuestScalableBusFrequency(PVM pVM);
2337	VMMDECL(uint64_t) CPUMGetGuestEferMsrValidMask(PVM pVM);
2338	VMMDECL(int) CPUMIsGuestEferMsrWriteValid(PVM pVM, uint64_t uCr0, uint64_t uOldEfer, uint64_t uNewEfer,
2339	uint64_t *puValidEfer);
2340	VMMDECL(void) CPUMSetGuestEferMsrNoChecks(PVMCPUCC pVCpu, uint64_t uOldEfer, uint64_t uValidEfer);
2341	VMMDECL(bool) CPUMIsPatMsrValid(uint64_t uValue);
2342
2343
2344	/** Guest CPU interruptibility level, see CPUMGetGuestInterruptibility(). */
2345	typedef enum CPUMINTERRUPTIBILITY
2346	{
2347	CPUMINTERRUPTIBILITY_INVALID = 0,
2348	CPUMINTERRUPTIBILITY_UNRESTRAINED,
2349	CPUMINTERRUPTIBILITY_VIRT_INT_DISABLED,
2350	CPUMINTERRUPTIBILITY_INT_DISABLED,
2351	CPUMINTERRUPTIBILITY_INT_INHIBITED, /*< @todo rename as it inhibits NMIs too. /
2352	CPUMINTERRUPTIBILITY_NMI_INHIBIT,
2353	CPUMINTERRUPTIBILITY_GLOBAL_INHIBIT,
2354	CPUMINTERRUPTIBILITY_END,
2355	CPUMINTERRUPTIBILITY_32BIT_HACK = 0x7fffffff
2356	} CPUMINTERRUPTIBILITY;
2357
2358	VMM_INT_DECL(CPUMINTERRUPTIBILITY) CPUMGetGuestInterruptibility(PVMCPU pVCpu);
2359
2360	/** @name Typical scalable bus frequency values.
2361	* @{ */
2362	/** Special internal value indicating that we don't know the frequency.
2363	* @internal */
2364	#define CPUM_SBUSFREQ_UNKNOWN UINT64_C(1)
2365	#define CPUM_SBUSFREQ_100MHZ UINT64_C(100000000)
2366	#define CPUM_SBUSFREQ_133MHZ UINT64_C(133333333)
2367	#define CPUM_SBUSFREQ_167MHZ UINT64_C(166666666)
2368	#define CPUM_SBUSFREQ_200MHZ UINT64_C(200000000)
2369	#define CPUM_SBUSFREQ_267MHZ UINT64_C(266666666)
2370	#define CPUM_SBUSFREQ_333MHZ UINT64_C(333333333)
2371	#define CPUM_SBUSFREQ_400MHZ UINT64_C(400000000)
2372	/** @} */
2373
2374
2375	#ifdef IN_RING3
2376	/** @defgroup grp_cpum_r3 The CPUM ring-3 API
2377	* @{
2378	*/
2379	VMMR3DECL(int) CPUMR3CpuIdInsert(PVM pVM, PCPUMCPUIDLEAF pNewLeaf);
2380	VMMR3DECL(int) CPUMR3CpuIdGetLeaf(PVM pVM, PCPUMCPUIDLEAF pLeaf, uint32_t uLeaf, uint32_t uSubLeaf);
2381	VMMR3_INT_DECL(PCCPUMCPUIDLEAF) CPUMR3CpuIdGetPtr(PVM pVM, uint32_t *pcLeaves);
2382	VMMDECL(CPUMMICROARCH) CPUMCpuIdDetermineX86MicroarchEx(CPUMCPUVENDOR enmVendor, uint8_t bFamily,
2383	uint8_t bModel, uint8_t bStepping);
2384	VMMR3DECL(int) CPUMR3CpuIdDetectUnknownLeafMethod(PCPUMUNKNOWNCPUID penmUnknownMethod, PCPUMCPUID pDefUnknown);
2385	VMMR3DECL(const char *) CPUMR3CpuIdUnknownLeafMethodName(CPUMUNKNOWNCPUID enmUnknownMethod);
2386	#if defined(RT_ARCH_X86) \|\| defined(RT_ARCH_AMD64)
2387	VMMR3DECL(uint32_t) CPUMR3DeterminHostMxCsrMask(void);
2388	#endif
2389
2390	VMMR3DECL(int) CPUMR3MsrRangesInsert(PVM pVM, PCCPUMMSRRANGE pNewRange);
2391
2392	VMMR3_INT_DECL(void) CPUMR3NemActivateGuestDebugState(PVMCPUCC pVCpu);
2393	VMMR3_INT_DECL(void) CPUMR3NemActivateHyperDebugState(PVMCPUCC pVCpu);
2394	/** @} */
2395	#endif /* IN_RING3 */
2396
2397	#ifdef IN_RING0
2398	/** @defgroup grp_cpum_r0 The CPUM ring-0 API
2399	* @{
2400	*/
2401	VMMR0_INT_DECL(int) CPUMR0ModuleInit(void);
2402	VMMR0_INT_DECL(int) CPUMR0ModuleTerm(void);
2403	VMMR0_INT_DECL(void) CPUMR0InitPerVMData(PGVM pGVM);
2404	VMMR0_INT_DECL(int) CPUMR0InitVM(PVMCC pVM);
2405	DECLASM(void) CPUMR0RegisterVCpuThread(PVMCPUCC pVCpu);
2406	DECLASM(void) CPUMR0TouchHostFpu(void);
2407	VMMR0_INT_DECL(int) CPUMR0Trap07Handler(PVMCC pVM, PVMCPUCC pVCpu);
2408	VMMR0_INT_DECL(int) CPUMR0LoadGuestFPU(PVMCC pVM, PVMCPUCC pVCpu);
2409	VMMR0_INT_DECL(bool) CPUMR0FpuStateMaybeSaveGuestAndRestoreHost(PVMCPUCC pVCpu);
2410	VMMR0_INT_DECL(int) CPUMR0SaveHostDebugState(PVMCC pVM, PVMCPUCC pVCpu);
2411	VMMR0_INT_DECL(bool) CPUMR0DebugStateMaybeSaveGuestAndRestoreHost(PVMCPUCC pVCpu, bool fDr6);
2412	VMMR0_INT_DECL(bool) CPUMR0DebugStateMaybeSaveGuest(PVMCPUCC pVCpu, bool fDr6);
2413
2414	VMMR0_INT_DECL(void) CPUMR0LoadGuestDebugState(PVMCPUCC pVCpu, bool fDr6);
2415	VMMR0_INT_DECL(void) CPUMR0LoadHyperDebugState(PVMCPUCC pVCpu, bool fDr6);
2416	/** @} */
2417	#endif /* IN_RING0 */
2418
2419	/** @defgroup grp_cpum_rz The CPUM raw-mode and ring-0 context API
2420	* @{
2421	*/
2422	VMMRZ_INT_DECL(void) CPUMRZFpuStatePrepareHostCpuForUse(PVMCPUCC pVCpu);
2423	VMMRZ_INT_DECL(void) CPUMRZFpuStateActualizeForRead(PVMCPUCC pVCpu);
2424	VMMRZ_INT_DECL(void) CPUMRZFpuStateActualizeForChange(PVMCPUCC pVCpu);
2425	VMMRZ_INT_DECL(void) CPUMRZFpuStateActualizeSseForRead(PVMCPUCC pVCpu);
2426	VMMRZ_INT_DECL(void) CPUMRZFpuStateActualizeAvxForRead(PVMCPUCC pVCpu);
2427	/** @} */
2428
2429
2430	#endif /* !VBOX_FOR_DTRACE_LIB */
2431	/** @} */
2432	RT_C_DECLS_END
2433
2434
2435	#endif /* !VBOX_INCLUDED_vmm_cpum_x86_amd64_h */
2436

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/vmm/cpum-x86-amd64.h

Download in other formats: