hm.h

Last change on this file was 106061, checked in by vboxsync, 2 months ago
Copyright year updates by scm.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 14.3 KB

Line
1	/** @file
2	* HM - Intel/AMD VM Hardware Assisted Virtualization Manager (VMM)
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_hm_h
37	#define VBOX_INCLUDED_vmm_hm_h
38	#ifndef RT_WITHOUT_PRAGMA_ONCE
39	# pragma once
40	#endif
41
42	#include <VBox/vmm/pgm.h>
43	#include <VBox/vmm/cpum.h>
44	#include <VBox/vmm/vmm.h>
45	#include <VBox/vmm/hm_svm.h>
46	#include <VBox/vmm/hm_vmx.h>
47	#include <VBox/vmm/trpm.h>
48	#include <iprt/mp.h>
49
50
51	/** @defgroup grp_hm The Hardware Assisted Virtualization Manager API
52	* @ingroup grp_vmm
53	* @{
54	*/
55
56	RT_C_DECLS_BEGIN
57
58	/**
59	* Checks whether HM (VT-x/AMD-V) is being used by this VM.
60	*
61	* @retval true if used.
62	* @retval false if software virtualization (raw-mode) or NEM is used.
63	*
64	* @param a_pVM The cross context VM structure.
65	* @deprecated Please use VM_IS_RAW_MODE_ENABLED, VM_IS_HM_OR_NEM_ENABLED, or
66	* VM_IS_HM_ENABLED instead.
67	* @internal
68	*/
69	#if defined(VBOX_STRICT) && defined(IN_RING3)
70	# define HMIsEnabled(a_pVM) HMIsEnabledNotMacro(a_pVM)
71	#else
72	# define HMIsEnabled(a_pVM) ((a_pVM)->fHMEnabled)
73	#endif
74
75	/**
76	* Checks whether raw-mode context is required for HM purposes
77	*
78	* @retval true if required by HM for doing switching the cpu to 64-bit mode.
79	* @retval false if not required by HM.
80	*
81	* @param a_pVM The cross context VM structure.
82	* @internal
83	*/
84	#if HC_ARCH_BITS == 64
85	# define HMIsRawModeCtxNeeded(a_pVM) (false)
86	#else
87	# define HMIsRawModeCtxNeeded(a_pVM) ((a_pVM)->fHMNeedRawModeCtx)
88	#endif
89
90	/**
91	* Checks whether we're in the special hardware virtualization context.
92	* @returns true / false.
93	* @param a_pVCpu The caller's cross context virtual CPU structure.
94	* @thread EMT
95	*/
96	#ifdef IN_RING0
97	# define HMIsInHwVirtCtx(a_pVCpu) (VMCPU_GET_STATE(a_pVCpu) == VMCPUSTATE_STARTED_HM)
98	#else
99	# define HMIsInHwVirtCtx(a_pVCpu) (false)
100	#endif
101
102	/**
103	* Checks whether we're in the special hardware virtualization context and we
104	* cannot perform long jump without guru meditating and possibly messing up the
105	* host and/or guest state.
106	*
107	* This is after we've turned interrupts off and such.
108	*
109	* @returns true / false.
110	* @param a_pVCpu The caller's cross context virtual CPU structure.
111	* @thread EMT
112	*/
113	#ifdef IN_RING0
114	# define HMIsInHwVirtNoLongJmpCtx(a_pVCpu) (VMCPU_GET_STATE(a_pVCpu) == VMCPUSTATE_STARTED_EXEC)
115	#else
116	# define HMIsInHwVirtNoLongJmpCtx(a_pVCpu) (false)
117	#endif
118
119	/** @name All-context HM API.
120	* @{ */
121	VMMDECL(bool) HMIsEnabledNotMacro(PVM pVM);
122	VMMDECL(bool) HMCanExecuteGuest(PVMCC pVM, PVMCPUCC pVCpu, PCCPUMCTX pCtx);
123	VMM_INT_DECL(int) HMInvalidatePage(PVMCPUCC pVCpu, RTGCPTR GCVirt);
124	VMM_INT_DECL(bool) HMHasPendingIrq(PVMCC pVM);
125	VMM_INT_DECL(bool) HMSetSingleInstruction(PVMCC pVM, PVMCPUCC pVCpu, bool fEnable);
126	VMM_INT_DECL(bool) HMIsSvmActive(PVM pVM);
127	VMM_INT_DECL(bool) HMIsVmxActive(PVM pVM);
128	VMM_INT_DECL(const char *) HMGetVmxDiagDesc(VMXVDIAG enmDiag);
129	VMM_INT_DECL(const char *) HMGetVmxExitName(uint32_t uExit);
130	VMM_INT_DECL(const char *) HMGetSvmExitName(uint32_t uExit);
131	VMM_INT_DECL(void) HMDumpHwvirtVmxState(PVMCPU pVCpu);
132	VMM_INT_DECL(void) HMHCChangedPagingMode(PVM pVM, PVMCPUCC pVCpu, PGMMODE enmShadowMode, PGMMODE enmGuestMode);
133	VMM_INT_DECL(void) HMGetVmxMsrsFromHwvirtMsrs(PCSUPHWVIRTMSRS pMsrs, PVMXMSRS pVmxMsrs);
134	VMM_INT_DECL(void) HMGetSvmMsrsFromHwvirtMsrs(PCSUPHWVIRTMSRS pMsrs, PSVMMSRS pSvmMsrs);
135	/** @} */
136
137	/** @name All-context VMX helpers.
138	*
139	* These are hardware-assisted VMX functions (used by IEM/REM/CPUM and HM). Helpers
140	* based purely on the Intel VT-x specification (used by IEM/REM and HM) can be
141	* found in CPUM.
142	* @{ */
143	#if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
144	VMM_INT_DECL(bool) HMIsSubjectToVmxPreemptTimerErratum(void);
145	#endif
146	VMM_INT_DECL(bool) HMCanExecuteVmxGuest(PVMCC pVM, PVMCPUCC pVCpu, PCCPUMCTX pCtx);
147	VMM_INT_DECL(TRPMEVENT) HMVmxEventTypeToTrpmEventType(uint32_t uIntInfo);
148	VMM_INT_DECL(uint32_t) HMTrpmEventTypeToVmxEventType(uint8_t uVector, TRPMEVENT enmTrpmEvent, bool fIcebp);
149	/** @} */
150
151	/** @name All-context SVM helpers.
152	*
153	* These are hardware-assisted SVM functions (used by IEM/REM/CPUM and HM). Helpers
154	* based purely on the AMD SVM specification (used by IEM/REM and HM) can be found
155	* in CPUM.
156	* @{ */
157	VMM_INT_DECL(TRPMEVENT) HMSvmEventToTrpmEventType(PCSVMEVENT pSvmEvent, uint8_t uVector);
158	/** @} */
159
160	#ifndef IN_RC
161
162	/** @name R0, R3 HM (VMX/SVM agnostic) handlers.
163	* @{ */
164	VMM_INT_DECL(int) HMFlushTlb(PVMCPU pVCpu);
165	VMM_INT_DECL(int) HMFlushTlbOnAllVCpus(PVMCC pVM);
166	VMM_INT_DECL(int) HMInvalidatePageOnAllVCpus(PVMCC pVM, RTGCPTR GCVirt);
167	VMM_INT_DECL(int) HMInvalidatePhysPage(PVMCC pVM, RTGCPHYS GCPhys);
168	VMM_INT_DECL(bool) HMAreNestedPagingAndFullGuestExecEnabled(PVMCC pVM);
169	VMM_INT_DECL(bool) HMIsLongModeAllowed(PVMCC pVM);
170	VMM_INT_DECL(bool) HMIsNestedPagingActive(PVMCC pVM);
171	VMM_INT_DECL(bool) HMIsMsrBitmapActive(PVM pVM);
172	# ifdef VBOX_WITH_NESTED_HWVIRT_VMX
173	VMM_INT_DECL(void) HMNotifyVmxNstGstVmexit(PVMCPU pVCpu);
174	VMM_INT_DECL(void) HMNotifyVmxNstGstCurrentVmcsChanged(PVMCPU pVCpu);
175	# endif
176	/** @} */
177
178	/** @name R0, R3 SVM handlers.
179	* @{ */
180	VMM_INT_DECL(bool) HMIsSvmVGifActive(PCVMCC pVM);
181	# ifdef VBOX_WITH_NESTED_HWVIRT_SVM
182	VMM_INT_DECL(void) HMNotifySvmNstGstVmexit(PVMCPUCC pVCpu, PCPUMCTX pCtx);
183	# endif
184	# if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
185	VMM_INT_DECL(int) HMIsSubjectToSvmErratum170(uint32_t pu32Family, uint32_t pu32Model, uint32_t *pu32Stepping);
186	# endif
187	VMM_INT_DECL(int) HMHCMaybeMovTprSvmHypercall(PVMCC pVM, PVMCPUCC pVCpu);
188	/** @} */
189
190	#else /* Nops in RC: */
191
192	/** @name RC HM (VMX/SVM agnostic) handlers.
193	* @{ */
194	# define HMFlushTlb(pVCpu) do { } while (0)
195	# define HMFlushTlbOnAllVCpus(pVM) do { } while (0)
196	# define HMInvalidatePageOnAllVCpus(pVM, GCVirt) do { } while (0)
197	# define HMInvalidatePhysPage(pVM, GCVirt) do { } while (0)
198	# define HMAreNestedPagingAndFullGuestExecEnabled(pVM) false
199	# define HMIsLongModeAllowed(pVM) false
200	# define HMIsNestedPagingActive(pVM) false
201	# define HMIsMsrBitmapsActive(pVM) false
202	/** @} */
203
204	/** @name RC SVM handlers.
205	* @{ */
206	# define HMIsSvmVGifActive(pVM) false
207	# define HMNotifySvmNstGstVmexit(pVCpu, pCtx) do { } while (0)
208	# if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
209	# define HMIsSubjectToSvmErratum170(puFamily, puModel, puStepping) false
210	# endif
211	# define HMHCMaybeMovTprSvmHypercall(pVM, pVCpu) do { } while (0)
212	/** @} */
213
214	#endif
215
216	/** @name HMVMX_READ_XXX - Flags for reading auxiliary VM-exit VMCS fields.
217	*
218	* These flags allow reading VMCS fields that are not necessarily part of the
219	* guest-CPU state but are needed while handling VM-exits.
220	*
221	* @note If you add any fields here, make sure to update VMXR0GetExitAuxInfo.
222	*
223	* @{
224	*/
225	#define HMVMX_READ_IDT_VECTORING_INFO RT_BIT_32(0)
226	#define HMVMX_READ_IDT_VECTORING_ERROR_CODE RT_BIT_32(1)
227	#define HMVMX_READ_EXIT_QUALIFICATION RT_BIT_32(2)
228	#define HMVMX_READ_EXIT_INSTR_LEN RT_BIT_32(3)
229	#define HMVMX_READ_EXIT_INTERRUPTION_INFO RT_BIT_32(4)
230	#define HMVMX_READ_EXIT_INTERRUPTION_ERROR_CODE RT_BIT_32(5)
231	#define HMVMX_READ_EXIT_INSTR_INFO RT_BIT_32(6)
232	#define HMVMX_READ_GUEST_LINEAR_ADDR RT_BIT_32(7)
233	#define HMVMX_READ_GUEST_PHYSICAL_ADDR RT_BIT_32(8)
234	#define HMVMX_READ_GUEST_PENDING_DBG_XCPTS RT_BIT_32(9)
235
236	/** All the VMCS fields required for processing of exception/NMI VM-exits. */
237	#define HMVMX_READ_XCPT_INFO ( HMVMX_READ_EXIT_INTERRUPTION_INFO \
238	\| HMVMX_READ_EXIT_INTERRUPTION_ERROR_CODE \
239	\| HMVMX_READ_EXIT_INSTR_LEN \
240	\| HMVMX_READ_IDT_VECTORING_INFO \
241	\| HMVMX_READ_IDT_VECTORING_ERROR_CODE)
242
243	/** Mask of all valid HMVMX_READ_XXX flags. */
244	#define HMVMX_READ_VALID_MASK ( HMVMX_READ_IDT_VECTORING_INFO \
245	\| HMVMX_READ_IDT_VECTORING_ERROR_CODE \
246	\| HMVMX_READ_EXIT_QUALIFICATION \
247	\| HMVMX_READ_EXIT_INSTR_LEN \
248	\| HMVMX_READ_EXIT_INTERRUPTION_INFO \
249	\| HMVMX_READ_EXIT_INTERRUPTION_ERROR_CODE \
250	\| HMVMX_READ_EXIT_INSTR_INFO \
251	\| HMVMX_READ_GUEST_LINEAR_ADDR \
252	\| HMVMX_READ_GUEST_PHYSICAL_ADDR \
253	\| HMVMX_READ_GUEST_PENDING_DBG_XCPTS)
254	/** @} */
255
256	#ifdef IN_RING0
257	/** @defgroup grp_hm_r0 The HM ring-0 Context API
258	* @{
259	*/
260	/**
261	* HM VM-exit auxiliary info.
262	*/
263	typedef union
264	{
265	/** VMX VM-exit auxiliary info. */
266	VMXEXITAUX Vmx;
267	/** SVM \#VMEXIT auxiliary info. */
268	SVMEXITAUX Svm;
269	} HMEXITAUX;
270	/** Pointer to HM-exit auxiliary info union. */
271	typedef HMEXITAUX *PHMEXITAUX;
272	/** Pointer to a const HM-exit auxiliary info union. */
273	typedef const HMEXITAUX *PCHMEXITAUX;
274
275	VMMR0_INT_DECL(int) HMR0Init(void);
276	VMMR0_INT_DECL(int) HMR0Term(void);
277	VMMR0_INT_DECL(int) HMR0InitVM(PVMCC pVM);
278	VMMR0_INT_DECL(int) HMR0TermVM(PVMCC pVM);
279	VMMR0_INT_DECL(int) HMR0EnableAllCpus(PVMCC pVM);
280	# ifdef VBOX_WITH_RAW_MODE
281	VMMR0_INT_DECL(int) HMR0EnterSwitcher(PVMCC pVM, VMMSWITCHER enmSwitcher, bool *pfVTxDisabled);
282	VMMR0_INT_DECL(void) HMR0LeaveSwitcher(PVMCC pVM, bool fVTxDisabled);
283	# endif
284
285	VMMR0_INT_DECL(int) HMR0SetupVM(PVMCC pVM);
286	VMMR0_INT_DECL(int) HMR0RunGuestCode(PVMCC pVM, PVMCPUCC pVCpu);
287	VMMR0_INT_DECL(int) HMR0Enter(PVMCPUCC pVCpu);
288	VMMR0_INT_DECL(int) HMR0LeaveCpu(PVMCPUCC pVCpu);
289	VMMR0_INT_DECL(void) HMR0ThreadCtxCallback(RTTHREADCTXEVENT enmEvent, void *pvUser);
290	VMMR0_INT_DECL(void) HMR0NotifyCpumUnloadedGuestFpuState(PVMCPUCC VCpu);
291	VMMR0_INT_DECL(void) HMR0NotifyCpumModifiedHostCr0(PVMCPUCC VCpu);
292	VMMR0_INT_DECL(bool) HMR0SuspendPending(void);
293	VMMR0_INT_DECL(int) HMR0InvalidatePage(PVMCPUCC pVCpu, RTGCPTR GCVirt);
294	VMMR0_INT_DECL(int) HMR0ImportStateOnDemand(PVMCPUCC pVCpu, uint64_t fWhat);
295	VMMR0_INT_DECL(int) HMR0GetExitAuxInfo(PVMCPUCC pVCpu, PHMEXITAUX pHmExitAux, uint32_t fWhat);
296	/** @} */
297	#endif /* IN_RING0 */
298
299
300	#ifdef IN_RING3
301	/** @defgroup grp_hm_r3 The HM ring-3 Context API
302	* @{
303	*/
304	VMMR3DECL(bool) HMR3IsEnabled(PUVM pUVM);
305	VMMR3DECL(bool) HMR3IsNestedPagingActive(PUVM pUVM);
306	VMMR3DECL(bool) HMR3AreVirtApicRegsEnabled(PUVM pUVM);
307	VMMR3DECL(bool) HMR3IsPostedIntrsEnabled(PUVM pUVM);
308	VMMR3DECL(bool) HMR3IsVpidActive(PUVM pUVM);
309	VMMR3DECL(bool) HMR3IsUXActive(PUVM pUVM);
310	VMMR3DECL(bool) HMR3IsSvmEnabled(PUVM pUVM);
311	VMMR3DECL(bool) HMR3IsVmxEnabled(PUVM pUVM);
312
313	VMMR3_INT_DECL(int) HMR3Init(PVM pVM);
314	VMMR3_INT_DECL(int) HMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
315	VMMR3_INT_DECL(void) HMR3Relocate(PVM pVM);
316	VMMR3_INT_DECL(int) HMR3Term(PVM pVM);
317	VMMR3_INT_DECL(void) HMR3Reset(PVM pVM);
318	VMMR3_INT_DECL(void) HMR3ResetCpu(PVMCPU pVCpu);
319	VMMR3_INT_DECL(void) HMR3CheckError(PVM pVM, int iStatusCode);
320	VMMR3_INT_DECL(void) HMR3NotifyDebugEventChanged(PVM pVM);
321	VMMR3_INT_DECL(void) HMR3NotifyDebugEventChangedPerCpu(PVM pVM, PVMCPU pVCpu);
322	# if 0 /* evil */
323	VMMR3_INT_DECL(bool) HMR3IsActive(PCVMCPU pVCpu);
324	# endif
325	VMMR3_INT_DECL(int) HMR3EnablePatching(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
326	VMMR3_INT_DECL(int) HMR3DisablePatching(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
327	VMMR3_INT_DECL(int) HMR3PatchTprInstr(PVM pVM, PVMCPU pVCpu);
328	VMMR3_INT_DECL(bool) HMR3IsRescheduleRequired(PVM pVM, PCCPUMCTX pCtx);
329	VMMR3_INT_DECL(bool) HMR3IsVmxPreemptionTimerUsed(PVM pVM);
330	/** @} */
331	#endif /* IN_RING3 */
332
333	/** @} */
334	RT_C_DECLS_END
335
336
337	#endif /* !VBOX_INCLUDED_vmm_hm_h */
338

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

source: vbox/trunk/include/VBox/vmm/hm.h

Download in other formats: