NEMR3Native-win.cpp@ 107200

Last change on this file since 107200 was 107194, checked in by vboxsync, 2 months ago
VMM: More adjustments for VBOX_WITH_ONLY_PGM_NEM_MODE, VBOX_WITH_MINIMAL_R0, VBOX_WITH_HWVIRT and such. jiraref:VBP-1466
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 153.2 KB

Line
1	/* $Id: NEMR3Native-win.cpp 107194 2024-11-29 14:47:06Z vboxsync $ */
2	/** @file
3	* NEM - Native execution manager, native ring-3 Windows backend.
4	*
5	* Log group 2: Exit logging.
6	* Log group 3: Log context on exit.
7	* Log group 5: Ring-3 memory management
8	* Log group 6: Ring-0 memory management
9	* Log group 12: API intercepts.
10	*/
11
12	/*
13	* Copyright (C) 2018-2024 Oracle and/or its affiliates.
14	*
15	* This file is part of VirtualBox base platform packages, as
16	* available from https://www.virtualbox.org.
17	*
18	* This program is free software; you can redistribute it and/or
19	* modify it under the terms of the GNU General Public License
20	* as published by the Free Software Foundation, in version 3 of the
21	* License.
22	*
23	* This program is distributed in the hope that it will be useful, but
24	* WITHOUT ANY WARRANTY; without even the implied warranty of
25	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26	* General Public License for more details.
27	*
28	* You should have received a copy of the GNU General Public License
29	* along with this program; if not, see <https://www.gnu.org/licenses>.
30	*
31	* SPDX-License-Identifier: GPL-3.0-only
32	*/
33
34
35	/*********************************************************************************************************************************
36	* Header Files *
37	*********************************************************************************************************************************/
38	#define LOG_GROUP LOG_GROUP_NEM
39	#define VMCPU_INCL_CPUM_GST_CTX
40	#include <iprt/nt/nt-and-windows.h>
41	#include <iprt/nt/hyperv.h>
42	#include <iprt/nt/vid.h>
43	#include <WinHvPlatform.h>
44
45	#ifndef _WIN32_WINNT_WIN10
46	# error "Missing _WIN32_WINNT_WIN10"
47	#endif
48	#ifndef _WIN32_WINNT_WIN10_RS1 /* Missing define, causing trouble for us. */
49	# define _WIN32_WINNT_WIN10_RS1 (_WIN32_WINNT_WIN10 + 1)
50	#endif
51	#include <sysinfoapi.h>
52	#include <debugapi.h>
53	#include <errhandlingapi.h>
54	#include <fileapi.h>
55	#include <winerror.h> /* no api header for this. */
56
57	#include <VBox/vmm/nem.h>
58	#include <VBox/vmm/iem.h>
59	#include <VBox/vmm/em.h>
60	#include <VBox/vmm/pdmapic.h>
61	#include <VBox/vmm/pdm.h>
62	#include <VBox/vmm/dbgftrace.h>
63	#include "NEMInternal.h"
64	#include <VBox/vmm/vmcc.h>
65
66	#include <iprt/ldr.h>
67	#include <iprt/path.h>
68	#include <iprt/string.h>
69	#include <iprt/system.h>
70	#include <iprt/utf16.h>
71
72	#ifndef NTDDI_WIN10_VB /* Present in W10 2004 SDK, quite possibly earlier. */
73	HRESULT WINAPI WHvQueryGpaRangeDirtyBitmap(WHV_PARTITION_HANDLE, WHV_GUEST_PHYSICAL_ADDRESS, UINT64, UINT64 *, UINT32);
74	# define WHvMapGpaRangeFlagTrackDirtyPages ((WHV_MAP_GPA_RANGE_FLAGS)0x00000008)
75	#endif
76
77
78	/*********************************************************************************************************************************
79	* Defined Constants And Macros *
80	*********************************************************************************************************************************/
81	#ifdef LOG_ENABLED
82	# define NEM_WIN_INTERCEPT_NT_IO_CTLS
83	#endif
84
85	/** VID I/O control detection: Fake partition handle input. */
86	#define NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE ((HANDLE)(uintptr_t)38479125)
87	/** VID I/O control detection: Fake partition ID return. */
88	#define NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_ID UINT64_C(0xfa1e000042424242)
89	/** VID I/O control detection: The property we get via VidGetPartitionProperty. */
90	#define NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_CODE HvPartitionPropertyProcessorVendor
91	/** VID I/O control detection: Fake property value return. */
92	#define NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_VALUE UINT64_C(0xf00dface01020304)
93	/** VID I/O control detection: Fake CPU index input. */
94	#define NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX UINT32_C(42)
95	/** VID I/O control detection: Fake timeout input. */
96	#define NEM_WIN_IOCTL_DETECTOR_FAKE_TIMEOUT UINT32_C(0x00080286)
97
98
99	/*********************************************************************************************************************************
100	* Global Variables *
101	*********************************************************************************************************************************/
102	/** @name APIs imported from WinHvPlatform.dll
103	* @{ */
104	static decltype(WHvGetCapability) * g_pfnWHvGetCapability;
105	static decltype(WHvCreatePartition) * g_pfnWHvCreatePartition;
106	static decltype(WHvSetupPartition) * g_pfnWHvSetupPartition;
107	static decltype(WHvDeletePartition) * g_pfnWHvDeletePartition;
108	static decltype(WHvGetPartitionProperty) * g_pfnWHvGetPartitionProperty;
109	static decltype(WHvSetPartitionProperty) * g_pfnWHvSetPartitionProperty;
110	static decltype(WHvMapGpaRange) * g_pfnWHvMapGpaRange;
111	static decltype(WHvUnmapGpaRange) * g_pfnWHvUnmapGpaRange;
112	static decltype(WHvTranslateGva) * g_pfnWHvTranslateGva;
113	static decltype(WHvQueryGpaRangeDirtyBitmap) * g_pfnWHvQueryGpaRangeDirtyBitmap;
114	static decltype(WHvCreateVirtualProcessor) * g_pfnWHvCreateVirtualProcessor;
115	static decltype(WHvDeleteVirtualProcessor) * g_pfnWHvDeleteVirtualProcessor;
116	static decltype(WHvRunVirtualProcessor) * g_pfnWHvRunVirtualProcessor;
117	static decltype(WHvCancelRunVirtualProcessor) * g_pfnWHvCancelRunVirtualProcessor;
118	static decltype(WHvGetVirtualProcessorRegisters) * g_pfnWHvGetVirtualProcessorRegisters;
119	static decltype(WHvSetVirtualProcessorRegisters) * g_pfnWHvSetVirtualProcessorRegisters;
120	/** @} */
121
122	/** @name APIs imported from Vid.dll
123	* @{ */
124	static decltype(VidGetHvPartitionId) *g_pfnVidGetHvPartitionId;
125	static decltype(VidGetPartitionProperty) *g_pfnVidGetPartitionProperty;
126	#ifdef LOG_ENABLED
127	static decltype(VidStartVirtualProcessor) *g_pfnVidStartVirtualProcessor;
128	static decltype(VidStopVirtualProcessor) *g_pfnVidStopVirtualProcessor;
129	static decltype(VidMessageSlotMap) *g_pfnVidMessageSlotMap;
130	static decltype(VidMessageSlotHandleAndGetNext) *g_pfnVidMessageSlotHandleAndGetNext;
131	static decltype(VidGetVirtualProcessorState) *g_pfnVidGetVirtualProcessorState;
132	static decltype(VidSetVirtualProcessorState) *g_pfnVidSetVirtualProcessorState;
133	static decltype(VidGetVirtualProcessorRunningStatus) *g_pfnVidGetVirtualProcessorRunningStatus;
134	#endif
135	/** @} */
136
137	/** The Windows build number. */
138	static uint32_t g_uBuildNo = 17134;
139
140
141
142	/**
143	* Import instructions.
144	*/
145	static const struct
146	{
147	uint8_t idxDll; /*< 0 for WinHvPlatform.dll, 1 for vid.dll. /
148	bool fOptional; /*< Set if import is optional. /
149	PFNRT ppfn; /< The function pointer variable. /
150	const char pszName; /< The function name. /
151	} g_aImports[] =
152	{
153	#define NEM_WIN_IMPORT(a_idxDll, a_fOptional, a_Name) { (a_idxDll), (a_fOptional), (PFNRT *)&RT_CONCAT(g_pfn,a_Name), #a_Name }
154	NEM_WIN_IMPORT(0, false, WHvGetCapability),
155	NEM_WIN_IMPORT(0, false, WHvCreatePartition),
156	NEM_WIN_IMPORT(0, false, WHvSetupPartition),
157	NEM_WIN_IMPORT(0, false, WHvDeletePartition),
158	NEM_WIN_IMPORT(0, false, WHvGetPartitionProperty),
159	NEM_WIN_IMPORT(0, false, WHvSetPartitionProperty),
160	NEM_WIN_IMPORT(0, false, WHvMapGpaRange),
161	NEM_WIN_IMPORT(0, false, WHvUnmapGpaRange),
162	NEM_WIN_IMPORT(0, false, WHvTranslateGva),
163	NEM_WIN_IMPORT(0, true, WHvQueryGpaRangeDirtyBitmap),
164	NEM_WIN_IMPORT(0, false, WHvCreateVirtualProcessor),
165	NEM_WIN_IMPORT(0, false, WHvDeleteVirtualProcessor),
166	NEM_WIN_IMPORT(0, false, WHvRunVirtualProcessor),
167	NEM_WIN_IMPORT(0, false, WHvCancelRunVirtualProcessor),
168	NEM_WIN_IMPORT(0, false, WHvGetVirtualProcessorRegisters),
169	NEM_WIN_IMPORT(0, false, WHvSetVirtualProcessorRegisters),
170
171	NEM_WIN_IMPORT(1, true, VidGetHvPartitionId),
172	NEM_WIN_IMPORT(1, true, VidGetPartitionProperty),
173	#ifdef LOG_ENABLED
174	NEM_WIN_IMPORT(1, false, VidMessageSlotMap),
175	NEM_WIN_IMPORT(1, false, VidMessageSlotHandleAndGetNext),
176	NEM_WIN_IMPORT(1, false, VidStartVirtualProcessor),
177	NEM_WIN_IMPORT(1, false, VidStopVirtualProcessor),
178	NEM_WIN_IMPORT(1, false, VidGetVirtualProcessorState),
179	NEM_WIN_IMPORT(1, false, VidSetVirtualProcessorState),
180	NEM_WIN_IMPORT(1, false, VidGetVirtualProcessorRunningStatus),
181	#endif
182	#undef NEM_WIN_IMPORT
183	};
184
185
186	/** The real NtDeviceIoControlFile API in NTDLL. */
187	static decltype(NtDeviceIoControlFile) *g_pfnNtDeviceIoControlFile;
188	/** Pointer to the NtDeviceIoControlFile import table entry. */
189	static decltype(NtDeviceIoControlFile) **g_ppfnVidNtDeviceIoControlFile;
190	#ifdef LOG_ENABLED
191	/** Info about the VidGetHvPartitionId I/O control interface. */
192	static NEMWINIOCTL g_IoCtlGetHvPartitionId;
193	/** Info about the VidGetPartitionProperty I/O control interface. */
194	static NEMWINIOCTL g_IoCtlGetPartitionProperty;
195	/** Info about the VidStartVirtualProcessor I/O control interface. */
196	static NEMWINIOCTL g_IoCtlStartVirtualProcessor;
197	/** Info about the VidStopVirtualProcessor I/O control interface. */
198	static NEMWINIOCTL g_IoCtlStopVirtualProcessor;
199	/** Info about the VidMessageSlotHandleAndGetNext I/O control interface. */
200	static NEMWINIOCTL g_IoCtlMessageSlotHandleAndGetNext;
201	/** Info about the VidMessageSlotMap I/O control interface - for logging. */
202	static NEMWINIOCTL g_IoCtlMessageSlotMap;
203	/** Info about the VidGetVirtualProcessorState I/O control interface - for logging. */
204	static NEMWINIOCTL g_IoCtlGetVirtualProcessorState;
205	/** Info about the VidSetVirtualProcessorState I/O control interface - for logging. */
206	static NEMWINIOCTL g_IoCtlSetVirtualProcessorState;
207	/** Pointer to what nemR3WinIoctlDetector_ForLogging should fill in. */
208	static NEMWINIOCTL *g_pIoCtlDetectForLogging;
209	#endif
210
211	#ifdef NEM_WIN_INTERCEPT_NT_IO_CTLS
212	/** Mapping slot for CPU #0.
213	* @{ */
214	static VID_MESSAGE_MAPPING_HEADER *g_pMsgSlotMapping = NULL;
215	static const HV_MESSAGE_HEADER *g_pHvMsgHdr;
216	static const HV_X64_INTERCEPT_MESSAGE_HEADER *g_pX64MsgHdr;
217	/** @} */
218	#endif
219
220
221	/*
222	* Let the preprocessor alias the APIs to import variables for better autocompletion.
223	*/
224	#ifndef IN_SLICKEDIT
225	# define WHvGetCapability g_pfnWHvGetCapability
226	# define WHvCreatePartition g_pfnWHvCreatePartition
227	# define WHvSetupPartition g_pfnWHvSetupPartition
228	# define WHvDeletePartition g_pfnWHvDeletePartition
229	# define WHvGetPartitionProperty g_pfnWHvGetPartitionProperty
230	# define WHvSetPartitionProperty g_pfnWHvSetPartitionProperty
231	# define WHvMapGpaRange g_pfnWHvMapGpaRange
232	# define WHvUnmapGpaRange g_pfnWHvUnmapGpaRange
233	# define WHvTranslateGva g_pfnWHvTranslateGva
234	# define WHvQueryGpaRangeDirtyBitmap g_pfnWHvQueryGpaRangeDirtyBitmap
235	# define WHvCreateVirtualProcessor g_pfnWHvCreateVirtualProcessor
236	# define WHvDeleteVirtualProcessor g_pfnWHvDeleteVirtualProcessor
237	# define WHvRunVirtualProcessor g_pfnWHvRunVirtualProcessor
238	# define WHvGetRunExitContextSize g_pfnWHvGetRunExitContextSize
239	# define WHvCancelRunVirtualProcessor g_pfnWHvCancelRunVirtualProcessor
240	# define WHvGetVirtualProcessorRegisters g_pfnWHvGetVirtualProcessorRegisters
241	# define WHvSetVirtualProcessorRegisters g_pfnWHvSetVirtualProcessorRegisters
242
243	# define VidMessageSlotHandleAndGetNext g_pfnVidMessageSlotHandleAndGetNext
244	# define VidStartVirtualProcessor g_pfnVidStartVirtualProcessor
245	# define VidStopVirtualProcessor g_pfnVidStopVirtualProcessor
246
247	#endif
248
249	#if 0 /* unused */
250	/** WHV_MEMORY_ACCESS_TYPE names */
251	static const char * const g_apszWHvMemAccesstypes[4] = { "read", "write", "exec", "!undefined!" };
252	#endif
253
254
255	/*********************************************************************************************************************************
256	* Internal Functions *
257	*********************************************************************************************************************************/
258	DECLINLINE(int) nemR3NativeGCPhys2R3PtrReadOnly(PVM pVM, RTGCPHYS GCPhys, const void **ppv);
259	DECLINLINE(int) nemR3NativeGCPhys2R3PtrWriteable(PVM pVM, RTGCPHYS GCPhys, void **ppv);
260
261	/*
262	* Instantate the code we used to share with ring-0.
263	*/
264	#include "../VMMAll/NEMAllNativeTemplate-win.cpp.h"
265
266
267
268	#ifdef NEM_WIN_INTERCEPT_NT_IO_CTLS
269	/**
270	* Wrapper that logs the call from VID.DLL.
271	*
272	* This is very handy for figuring out why an API call fails.
273	*/
274	static NTSTATUS WINAPI
275	nemR3WinLogWrapper_NtDeviceIoControlFile(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
276	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
277	PVOID pvOutput, ULONG cbOutput)
278	{
279
280	char szFunction[32];
281	const char *pszFunction;
282	if (uFunction == g_IoCtlMessageSlotHandleAndGetNext.uFunction)
283	pszFunction = "VidMessageSlotHandleAndGetNext";
284	else if (uFunction == g_IoCtlStartVirtualProcessor.uFunction)
285	pszFunction = "VidStartVirtualProcessor";
286	else if (uFunction == g_IoCtlStopVirtualProcessor.uFunction)
287	pszFunction = "VidStopVirtualProcessor";
288	else if (uFunction == g_IoCtlMessageSlotMap.uFunction)
289	pszFunction = "VidMessageSlotMap";
290	else if (uFunction == g_IoCtlGetVirtualProcessorState.uFunction)
291	pszFunction = "VidGetVirtualProcessorState";
292	else if (uFunction == g_IoCtlSetVirtualProcessorState.uFunction)
293	pszFunction = "VidSetVirtualProcessorState";
294	else
295	{
296	RTStrPrintf(szFunction, sizeof(szFunction), "%#x", uFunction);
297	pszFunction = szFunction;
298	}
299
300	if (cbInput > 0 && pvInput)
301	Log12(("VID!NtDeviceIoControlFile: %s/input: %.*Rhxs\n", pszFunction, RT_MIN(cbInput, 32), pvInput));
302	NTSTATUS rcNt = g_pfnNtDeviceIoControlFile(hFile, hEvt, pfnApcCallback, pvApcCtx, pIos, uFunction,
303	pvInput, cbInput, pvOutput, cbOutput);
304	if (!hEvt && !pfnApcCallback && !pvApcCtx)
305	Log12(("VID!NtDeviceIoControlFile: hFile=%#zx pIos=%p->{s:%#x, i:%#zx} uFunction=%s Input=%p LB %#x Output=%p LB %#x) -> %#x; Caller=%p\n",
306	hFile, pIos, pIos->Status, pIos->Information, pszFunction, pvInput, cbInput, pvOutput, cbOutput, rcNt, ASMReturnAddress()));
307	else
308	Log12(("VID!NtDeviceIoControlFile: hFile=%#zx hEvt=%#zx Apc=%p/%p pIos=%p->{s:%#x, i:%#zx} uFunction=%s Input=%p LB %#x Output=%p LB %#x) -> %#x; Caller=%p\n",
309	hFile, hEvt, RT_CB_LOG_CAST(pfnApcCallback), pvApcCtx, pIos, pIos->Status, pIos->Information, pszFunction,
310	pvInput, cbInput, pvOutput, cbOutput, rcNt, ASMReturnAddress()));
311	if (cbOutput > 0 && pvOutput)
312	{
313	Log12(("VID!NtDeviceIoControlFile: %s/output: %.*Rhxs\n", pszFunction, RT_MIN(cbOutput, 32), pvOutput));
314	if (uFunction == 0x2210cc && g_pMsgSlotMapping == NULL && cbOutput >= sizeof(void *))
315	{
316	g_pMsgSlotMapping = (VID_MESSAGE_MAPPING_HEADER *)pvOutput;
317	g_pHvMsgHdr = (const HV_MESSAGE_HEADER *)(g_pMsgSlotMapping + 1);
318	g_pX64MsgHdr = (const HV_X64_INTERCEPT_MESSAGE_HEADER *)(g_pHvMsgHdr + 1);
319	Log12(("VID!NtDeviceIoControlFile: Message slot mapping: %p\n", g_pMsgSlotMapping));
320	}
321	}
322	if ( g_pMsgSlotMapping
323	&& ( uFunction == g_IoCtlMessageSlotHandleAndGetNext.uFunction
324	\|\| uFunction == g_IoCtlStopVirtualProcessor.uFunction
325	\|\| uFunction == g_IoCtlMessageSlotMap.uFunction
326	))
327	Log12(("VID!NtDeviceIoControlFile: enmVidMsgType=%#x cb=%#x msg=%#x payload=%u cs:rip=%04x:%08RX64 (%s)\n",
328	g_pMsgSlotMapping->enmVidMsgType, g_pMsgSlotMapping->cbMessage,
329	g_pHvMsgHdr->MessageType, g_pHvMsgHdr->PayloadSize,
330	g_pX64MsgHdr->CsSegment.Selector, g_pX64MsgHdr->Rip, pszFunction));
331
332	return rcNt;
333	}
334	#endif /* NEM_WIN_INTERCEPT_NT_IO_CTLS */
335
336
337	/**
338	* Patches the call table of VID.DLL so we can intercept NtDeviceIoControlFile.
339	*
340	* This is for used to figure out the I/O control codes and in logging builds
341	* for logging API calls that WinHvPlatform.dll does.
342	*
343	* @returns VBox status code.
344	* @param hLdrModVid The VID module handle.
345	* @param pErrInfo Where to return additional error information.
346	*/
347	static int nemR3WinInitVidIntercepts(RTLDRMOD hLdrModVid, PRTERRINFO pErrInfo)
348	{
349	/*
350	* Locate the real API.
351	*/
352	g_pfnNtDeviceIoControlFile = (decltype(NtDeviceIoControlFile) *)RTLdrGetSystemSymbol("NTDLL.DLL", "NtDeviceIoControlFile");
353	AssertReturn(g_pfnNtDeviceIoControlFile != NULL,
354	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Failed to resolve NtDeviceIoControlFile from NTDLL.DLL"));
355
356	/*
357	* Locate the PE header and get what we need from it.
358	*/
359	uint8_t const pbImage = (uint8_t const )RTLdrGetNativeHandle(hLdrModVid);
360	IMAGE_DOS_HEADER const pMzHdr = (IMAGE_DOS_HEADER const )pbImage;
361	AssertReturn(pMzHdr->e_magic == IMAGE_DOS_SIGNATURE,
362	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL mapping doesn't start with MZ signature: %#x", pMzHdr->e_magic));
363	IMAGE_NT_HEADERS const pNtHdrs = (IMAGE_NT_HEADERS const )&pbImage[pMzHdr->e_lfanew];
364	AssertReturn(pNtHdrs->Signature == IMAGE_NT_SIGNATURE,
365	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL has invalid PE signaturre: %#x @%#x",
366	pNtHdrs->Signature, pMzHdr->e_lfanew));
367
368	uint32_t const cbImage = pNtHdrs->OptionalHeader.SizeOfImage;
369	IMAGE_DATA_DIRECTORY const ImportDir = pNtHdrs->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT];
370
371	/*
372	* Walk the import descriptor table looking for NTDLL.DLL.
373	*/
374	AssertReturn( ImportDir.Size > 0
375	&& ImportDir.Size < cbImage,
376	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad import directory size: %#x", ImportDir.Size));
377	AssertReturn( ImportDir.VirtualAddress > 0
378	&& ImportDir.VirtualAddress <= cbImage - ImportDir.Size,
379	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad import directory RVA: %#x", ImportDir.VirtualAddress));
380
381	for (PIMAGE_IMPORT_DESCRIPTOR pImps = (PIMAGE_IMPORT_DESCRIPTOR)&pbImage[ImportDir.VirtualAddress];
382	pImps->Name != 0 && pImps->FirstThunk != 0;
383	pImps++)
384	{
385	AssertReturn(pImps->Name < cbImage,
386	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad import directory entry name: %#x", pImps->Name));
387	const char pszModName = (const char )&pbImage[pImps->Name];
388	if (RTStrICmpAscii(pszModName, "ntdll.dll"))
389	continue;
390	AssertReturn(pImps->FirstThunk < cbImage,
391	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad FirstThunk: %#x", pImps->FirstThunk));
392	AssertReturn(pImps->OriginalFirstThunk < cbImage,
393	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad FirstThunk: %#x", pImps->FirstThunk));
394
395	/*
396	* Walk the thunks table(s) looking for NtDeviceIoControlFile.
397	*/
398	uintptr_t puFirstThunk = (uintptr_t )&pbImage[pImps->FirstThunk]; /* update this. */
399	if ( pImps->OriginalFirstThunk != 0
400	&& pImps->OriginalFirstThunk != pImps->FirstThunk)
401	{
402	uintptr_t const puOrgThunk = (uintptr_t const )&pbImage[pImps->OriginalFirstThunk]; /* read from this. */
403	uintptr_t cLeft = (cbImage - (RT_MAX(pImps->FirstThunk, pImps->OriginalFirstThunk)))
404	/ sizeof(*puFirstThunk);
405	while (cLeft-- > 0 && *puOrgThunk != 0)
406	{
407	if (!(puOrgThunk & IMAGE_ORDINAL_FLAG64)) / ASSUMES 64-bit */
408	{
409	AssertReturn(puOrgThunk > 0 && puOrgThunk < cbImage,
410	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad thunk entry: %#x", *puOrgThunk));
411
412	const char pszSymbol = (const char )&pbImage[*puOrgThunk + 2];
413	if (strcmp(pszSymbol, "NtDeviceIoControlFile") == 0)
414	g_ppfnVidNtDeviceIoControlFile = (decltype(NtDeviceIoControlFile) **)puFirstThunk;
415	}
416
417	puOrgThunk++;
418	puFirstThunk++;
419	}
420	}
421	else
422	{
423	/* No original thunk table, so scan the resolved symbols for a match
424	with the NtDeviceIoControlFile address. */
425	uintptr_t const uNeedle = (uintptr_t)g_pfnNtDeviceIoControlFile;
426	uintptr_t cLeft = (cbImage - pImps->FirstThunk) / sizeof(*puFirstThunk);
427	while (cLeft-- > 0 && *puFirstThunk != 0)
428	{
429	if (*puFirstThunk == uNeedle)
430	g_ppfnVidNtDeviceIoControlFile = (decltype(NtDeviceIoControlFile) **)puFirstThunk;
431	puFirstThunk++;
432	}
433	}
434	}
435
436	if (g_ppfnVidNtDeviceIoControlFile != NULL)
437	{
438	/* Make the thunk writable we can freely modify it. */
439	DWORD fOldProt = PAGE_READONLY;
440	VirtualProtect((void *)(uintptr_t)g_ppfnVidNtDeviceIoControlFile, sizeof(uintptr_t), PAGE_EXECUTE_READWRITE, &fOldProt);
441
442	#ifdef NEM_WIN_INTERCEPT_NT_IO_CTLS
443	*g_ppfnVidNtDeviceIoControlFile = nemR3WinLogWrapper_NtDeviceIoControlFile;
444	#endif
445	return VINF_SUCCESS;
446	}
447	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Failed to patch NtDeviceIoControlFile import in VID.DLL!");
448	}
449
450
451	/**
452	* Worker for nemR3NativeInit that probes and load the native API.
453	*
454	* @returns VBox status code.
455	* @param fForced Whether the HMForced flag is set and we should
456	* fail if we cannot initialize.
457	* @param pErrInfo Where to always return error info.
458	*/
459	static int nemR3WinInitProbeAndLoad(bool fForced, PRTERRINFO pErrInfo)
460	{
461	/*
462	* Check that the DLL files we need are present, but without loading them.
463	* We'd like to avoid loading them unnecessarily.
464	*/
465	WCHAR wszPath[MAX_PATH + 64];
466	UINT cwcPath = GetSystemDirectoryW(wszPath, MAX_PATH);
467	if (cwcPath >= MAX_PATH \|\| cwcPath < 2)
468	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "GetSystemDirectoryW failed (%#x / %u)", cwcPath, GetLastError());
469
470	if (wszPath[cwcPath - 1] != '\\' \|\| wszPath[cwcPath - 1] != '/')
471	wszPath[cwcPath++] = '\\';
472	RTUtf16CopyAscii(&wszPath[cwcPath], RT_ELEMENTS(wszPath) - cwcPath, "WinHvPlatform.dll");
473	if (GetFileAttributesW(wszPath) == INVALID_FILE_ATTRIBUTES)
474	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "The native API dll was not found (%ls)", wszPath);
475
476	/*
477	* Check that we're in a VM and that the hypervisor identifies itself as Hyper-V.
478	*/
479	if (!ASMHasCpuId())
480	return RTErrInfoSet(pErrInfo, VERR_NEM_NOT_AVAILABLE, "No CPUID support");
481	if (!RTX86IsValidStdRange(ASMCpuId_EAX(0)))
482	return RTErrInfoSet(pErrInfo, VERR_NEM_NOT_AVAILABLE, "No CPUID leaf #1");
483	if (!(ASMCpuId_ECX(1) & X86_CPUID_FEATURE_ECX_HVP))
484	return RTErrInfoSet(pErrInfo, VERR_NEM_NOT_AVAILABLE, "Not in a hypervisor partition (HVP=0)");
485
486	uint32_t cMaxHyperLeaf = 0;
487	uint32_t uEbx = 0;
488	uint32_t uEcx = 0;
489	uint32_t uEdx = 0;
490	ASMCpuIdExSlow(0x40000000, 0, 0, 0, &cMaxHyperLeaf, &uEbx, &uEcx, &uEdx);
491	if (!RTX86IsValidHypervisorRange(cMaxHyperLeaf))
492	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "Invalid hypervisor CPUID range (%#x %#x %#x %#x)",
493	cMaxHyperLeaf, uEbx, uEcx, uEdx);
494	if ( uEbx != UINT32_C(0x7263694d) /* Micr */
495	\|\| uEcx != UINT32_C(0x666f736f) /* osof */
496	\|\| uEdx != UINT32_C(0x76482074) /* t Hv */)
497	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE,
498	"Not Hyper-V CPUID signature: %#x %#x %#x (expected %#x %#x %#x)",
499	uEbx, uEcx, uEdx, UINT32_C(0x7263694d), UINT32_C(0x666f736f), UINT32_C(0x76482074));
500	if (cMaxHyperLeaf < UINT32_C(0x40000005))
501	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "Too narrow hypervisor CPUID range (%#x)", cMaxHyperLeaf);
502
503	/** @todo would be great if we could recognize a root partition from the
504	* CPUID info, but I currently don't dare do that. */
505
506	/*
507	* Now try load the DLLs and resolve the APIs.
508	*/
509	static const char * const s_apszDllNames[2] = { "WinHvPlatform.dll", "vid.dll" };
510	RTLDRMOD ahMods[2] = { NIL_RTLDRMOD, NIL_RTLDRMOD };
511	int rc = VINF_SUCCESS;
512	for (unsigned i = 0; i < RT_ELEMENTS(s_apszDllNames); i++)
513	{
514	int rc2 = RTLdrLoadSystem(s_apszDllNames[i], true /fNoUnload/, &ahMods[i]);
515	if (RT_FAILURE(rc2))
516	{
517	if (!RTErrInfoIsSet(pErrInfo))
518	RTErrInfoSetF(pErrInfo, rc2, "Failed to load API DLL: %s: %Rrc", s_apszDllNames[i], rc2);
519	else
520	RTErrInfoAddF(pErrInfo, rc2, "; %s: %Rrc", s_apszDllNames[i], rc2);
521	ahMods[i] = NIL_RTLDRMOD;
522	rc = VERR_NEM_INIT_FAILED;
523	}
524	}
525	if (RT_SUCCESS(rc))
526	rc = nemR3WinInitVidIntercepts(ahMods[1], pErrInfo);
527	if (RT_SUCCESS(rc))
528	{
529	for (unsigned i = 0; i < RT_ELEMENTS(g_aImports); i++)
530	{
531	int rc2 = RTLdrGetSymbol(ahMods[g_aImports[i].idxDll], g_aImports[i].pszName, (void **)g_aImports[i].ppfn);
532	if (RT_SUCCESS(rc2))
533	{
534	if (g_aImports[i].fOptional)
535	LogRel(("NEM: info: Found optional import %s!%s.\n",
536	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName));
537	}
538	else
539	{
540	*g_aImports[i].ppfn = NULL;
541
542	LogRel(("NEM: %s: Failed to import %s!%s: %Rrc",
543	g_aImports[i].fOptional ? "info" : fForced ? "fatal" : "error",
544	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName, rc2));
545	if (!g_aImports[i].fOptional)
546	{
547	if (RTErrInfoIsSet(pErrInfo))
548	RTErrInfoAddF(pErrInfo, rc2, ", %s!%s",
549	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName);
550	else
551	rc = RTErrInfoSetF(pErrInfo, rc2, "Failed to import: %s!%s",
552	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName);
553	Assert(RT_FAILURE(rc));
554	}
555	}
556	}
557	if (RT_SUCCESS(rc))
558	{
559	Assert(!RTErrInfoIsSet(pErrInfo));
560	}
561	}
562
563	for (unsigned i = 0; i < RT_ELEMENTS(ahMods); i++)
564	RTLdrClose(ahMods[i]);
565	return rc;
566	}
567
568
569	/**
570	* Wrapper for different WHvGetCapability signatures.
571	*/
572	DECLINLINE(HRESULT) WHvGetCapabilityWrapper(WHV_CAPABILITY_CODE enmCap, WHV_CAPABILITY *pOutput, uint32_t cbOutput)
573	{
574	return g_pfnWHvGetCapability(enmCap, pOutput, cbOutput, NULL);
575	}
576
577
578	/**
579	* Worker for nemR3NativeInit that gets the hypervisor capabilities.
580	*
581	* @returns VBox status code.
582	* @param pVM The cross context VM structure.
583	* @param pErrInfo Where to always return error info.
584	*/
585	static int nemR3WinInitCheckCapabilities(PVM pVM, PRTERRINFO pErrInfo)
586	{
587	#define NEM_LOG_REL_CAP_EX(a_szField, a_szFmt, a_Value) LogRel(("NEM: %-38s= " a_szFmt "\n", a_szField, a_Value))
588	#define NEM_LOG_REL_CAP_SUB_EX(a_szField, a_szFmt, a_Value) LogRel(("NEM: %36s: " a_szFmt "\n", a_szField, a_Value))
589	#define NEM_LOG_REL_CAP_SUB(a_szField, a_Value) NEM_LOG_REL_CAP_SUB_EX(a_szField, "%d", a_Value)
590
591	/*
592	* Is the hypervisor present with the desired capability?
593	*
594	* In build 17083 this translates into:
595	* - CPUID[0x00000001].HVP is set
596	* - CPUID[0x40000000] == "Microsoft Hv"
597	* - CPUID[0x40000001].eax == "Hv#1"
598	* - CPUID[0x40000003].ebx[12] is set.
599	* - VidGetExoPartitionProperty(INVALID_HANDLE_VALUE, 0x60000, &Ignored) returns
600	* a non-zero value.
601	*/
602	/**
603	* @todo Someone at Microsoft please explain weird API design:
604	* 1. Pointless CapabilityCode duplication int the output;
605	* 2. No output size.
606	*/
607	WHV_CAPABILITY Caps;
608	RT_ZERO(Caps);
609	SetLastError(0);
610	HRESULT hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeHypervisorPresent, &Caps, sizeof(Caps));
611	DWORD rcWin = GetLastError();
612	if (FAILED(hrc))
613	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
614	"WHvGetCapability/WHvCapabilityCodeHypervisorPresent failed: %Rhrc (Last=%#x/%u)",
615	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
616	if (!Caps.HypervisorPresent)
617	{
618	if (!RTPathExists(RTPATH_NT_PASSTHRU_PREFIX "Device\\VidExo"))
619	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE,
620	"WHvCapabilityCodeHypervisorPresent is FALSE! Make sure you have enabled the 'Windows Hypervisor Platform' feature.");
621	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "WHvCapabilityCodeHypervisorPresent is FALSE! (%u)", rcWin);
622	}
623	LogRel(("NEM: WHvCapabilityCodeHypervisorPresent is TRUE, so this might work...\n"));
624
625
626	/*
627	* Check what extended VM exits are supported.
628	*/
629	RT_ZERO(Caps);
630	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeExtendedVmExits, &Caps, sizeof(Caps));
631	if (FAILED(hrc))
632	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
633	"WHvGetCapability/WHvCapabilityCodeExtendedVmExits failed: %Rhrc (Last=%#x/%u)",
634	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
635	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeExtendedVmExits", "%'#018RX64", Caps.ExtendedVmExits.AsUINT64);
636	pVM->nem.s.fExtendedMsrExit = RT_BOOL(Caps.ExtendedVmExits.X64MsrExit);
637	pVM->nem.s.fExtendedCpuIdExit = RT_BOOL(Caps.ExtendedVmExits.X64CpuidExit);
638	pVM->nem.s.fExtendedXcptExit = RT_BOOL(Caps.ExtendedVmExits.ExceptionExit);
639	NEM_LOG_REL_CAP_SUB("fExtendedMsrExit", pVM->nem.s.fExtendedMsrExit);
640	NEM_LOG_REL_CAP_SUB("fExtendedCpuIdExit", pVM->nem.s.fExtendedCpuIdExit);
641	NEM_LOG_REL_CAP_SUB("fExtendedXcptExit", pVM->nem.s.fExtendedXcptExit);
642	if (Caps.ExtendedVmExits.AsUINT64 & ~(uint64_t)7)
643	LogRel(("NEM: Warning! Unknown VM exit definitions: %#RX64\n", Caps.ExtendedVmExits.AsUINT64));
644	/** @todo RECHECK: WHV_EXTENDED_VM_EXITS typedef. */
645
646	/*
647	* Check features in case they end up defining any.
648	*/
649	RT_ZERO(Caps);
650	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeFeatures, &Caps, sizeof(Caps));
651	if (FAILED(hrc))
652	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
653	"WHvGetCapability/WHvCapabilityCodeFeatures failed: %Rhrc (Last=%#x/%u)",
654	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
655	if (Caps.Features.AsUINT64 & ~(uint64_t)0)
656	LogRel(("NEM: Warning! Unknown feature definitions: %#RX64\n", Caps.Features.AsUINT64));
657	/** @todo RECHECK: WHV_CAPABILITY_FEATURES typedef. */
658
659	/*
660	* Check supported exception exit bitmap bits.
661	* We don't currently require this, so we just log failure.
662	*/
663	RT_ZERO(Caps);
664	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeExceptionExitBitmap, &Caps, sizeof(Caps));
665	if (SUCCEEDED(hrc))
666	LogRel(("NEM: Supported exception exit bitmap: %#RX64\n", Caps.ExceptionExitBitmap));
667	else
668	LogRel(("NEM: Warning! WHvGetCapability/WHvCapabilityCodeExceptionExitBitmap failed: %Rhrc (Last=%#x/%u)",
669	hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
670
671	/*
672	* Check that the CPU vendor is supported.
673	*/
674	RT_ZERO(Caps);
675	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeProcessorVendor, &Caps, sizeof(Caps));
676	if (FAILED(hrc))
677	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
678	"WHvGetCapability/WHvCapabilityCodeProcessorVendor failed: %Rhrc (Last=%#x/%u)",
679	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
680	switch (Caps.ProcessorVendor)
681	{
682	/** @todo RECHECK: WHV_PROCESSOR_VENDOR typedef. */
683	case WHvProcessorVendorIntel:
684	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorVendor", "%d - Intel", Caps.ProcessorVendor);
685	pVM->nem.s.enmCpuVendor = CPUMCPUVENDOR_INTEL;
686	break;
687	case WHvProcessorVendorAmd:
688	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorVendor", "%d - AMD", Caps.ProcessorVendor);
689	pVM->nem.s.enmCpuVendor = CPUMCPUVENDOR_AMD;
690	break;
691	default:
692	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorVendor", "%d", Caps.ProcessorVendor);
693	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Unknown processor vendor: %d", Caps.ProcessorVendor);
694	}
695
696	/*
697	* CPU features, guessing these are virtual CPU features?
698	*/
699	RT_ZERO(Caps);
700	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeProcessorFeatures, &Caps, sizeof(Caps));
701	if (FAILED(hrc))
702	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
703	"WHvGetCapability/WHvCapabilityCodeProcessorFeatures failed: %Rhrc (Last=%#x/%u)",
704	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
705	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorFeatures", "%'#018RX64", Caps.ProcessorFeatures.AsUINT64);
706	#define NEM_LOG_REL_CPU_FEATURE(a_Field) NEM_LOG_REL_CAP_SUB(#a_Field, Caps.ProcessorFeatures.a_Field)
707	NEM_LOG_REL_CPU_FEATURE(Sse3Support);
708	NEM_LOG_REL_CPU_FEATURE(LahfSahfSupport);
709	NEM_LOG_REL_CPU_FEATURE(Ssse3Support);
710	NEM_LOG_REL_CPU_FEATURE(Sse4_1Support);
711	NEM_LOG_REL_CPU_FEATURE(Sse4_2Support);
712	NEM_LOG_REL_CPU_FEATURE(Sse4aSupport);
713	NEM_LOG_REL_CPU_FEATURE(XopSupport);
714	NEM_LOG_REL_CPU_FEATURE(PopCntSupport);
715	NEM_LOG_REL_CPU_FEATURE(Cmpxchg16bSupport);
716	NEM_LOG_REL_CPU_FEATURE(Altmovcr8Support);
717	NEM_LOG_REL_CPU_FEATURE(LzcntSupport);
718	NEM_LOG_REL_CPU_FEATURE(MisAlignSseSupport);
719	NEM_LOG_REL_CPU_FEATURE(MmxExtSupport);
720	NEM_LOG_REL_CPU_FEATURE(Amd3DNowSupport);
721	NEM_LOG_REL_CPU_FEATURE(ExtendedAmd3DNowSupport);
722	NEM_LOG_REL_CPU_FEATURE(Page1GbSupport);
723	NEM_LOG_REL_CPU_FEATURE(AesSupport);
724	NEM_LOG_REL_CPU_FEATURE(PclmulqdqSupport);
725	NEM_LOG_REL_CPU_FEATURE(PcidSupport);
726	NEM_LOG_REL_CPU_FEATURE(Fma4Support);
727	NEM_LOG_REL_CPU_FEATURE(F16CSupport);
728	NEM_LOG_REL_CPU_FEATURE(RdRandSupport);
729	NEM_LOG_REL_CPU_FEATURE(RdWrFsGsSupport);
730	NEM_LOG_REL_CPU_FEATURE(SmepSupport);
731	NEM_LOG_REL_CPU_FEATURE(EnhancedFastStringSupport);
732	NEM_LOG_REL_CPU_FEATURE(Bmi1Support);
733	NEM_LOG_REL_CPU_FEATURE(Bmi2Support);
734	/* two reserved bits here, see below */
735	NEM_LOG_REL_CPU_FEATURE(MovbeSupport);
736	NEM_LOG_REL_CPU_FEATURE(Npiep1Support);
737	NEM_LOG_REL_CPU_FEATURE(DepX87FPUSaveSupport);
738	NEM_LOG_REL_CPU_FEATURE(RdSeedSupport);
739	NEM_LOG_REL_CPU_FEATURE(AdxSupport);
740	NEM_LOG_REL_CPU_FEATURE(IntelPrefetchSupport);
741	NEM_LOG_REL_CPU_FEATURE(SmapSupport);
742	NEM_LOG_REL_CPU_FEATURE(HleSupport);
743	NEM_LOG_REL_CPU_FEATURE(RtmSupport);
744	NEM_LOG_REL_CPU_FEATURE(RdtscpSupport);
745	NEM_LOG_REL_CPU_FEATURE(ClflushoptSupport);
746	NEM_LOG_REL_CPU_FEATURE(ClwbSupport);
747	NEM_LOG_REL_CPU_FEATURE(ShaSupport);
748	NEM_LOG_REL_CPU_FEATURE(X87PointersSavedSupport);
749	#undef NEM_LOG_REL_CPU_FEATURE
750	if (Caps.ProcessorFeatures.AsUINT64 & (~(RT_BIT_64(43) - 1) \| RT_BIT_64(27) \| RT_BIT_64(28)))
751	LogRel(("NEM: Warning! Unknown CPU features: %#RX64\n", Caps.ProcessorFeatures.AsUINT64));
752	pVM->nem.s.uCpuFeatures.u64 = Caps.ProcessorFeatures.AsUINT64;
753	/** @todo RECHECK: WHV_PROCESSOR_FEATURES typedef. */
754
755	/*
756	* The cache line flush size.
757	*/
758	RT_ZERO(Caps);
759	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeProcessorClFlushSize, &Caps, sizeof(Caps));
760	if (FAILED(hrc))
761	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
762	"WHvGetCapability/WHvCapabilityCodeProcessorClFlushSize failed: %Rhrc (Last=%#x/%u)",
763	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
764	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorClFlushSize", "2^%u", Caps.ProcessorClFlushSize);
765	if (Caps.ProcessorClFlushSize < 8 && Caps.ProcessorClFlushSize > 9)
766	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Unsupported cache line flush size: %u", Caps.ProcessorClFlushSize);
767	pVM->nem.s.cCacheLineFlushShift = Caps.ProcessorClFlushSize;
768
769	/*
770	* See if they've added more properties that we're not aware of.
771	*/
772	/** @todo RECHECK: WHV_CAPABILITY_CODE typedef. */
773	if (!IsDebuggerPresent()) /* Too noisy when in debugger, so skip. */
774	{
775	static const struct
776	{
777	uint32_t iMin, iMax; } s_aUnknowns[] =
778	{
779	{ 0x0004, 0x000f },
780	{ 0x1003, 0x100f },
781	{ 0x2000, 0x200f },
782	{ 0x3000, 0x300f },
783	{ 0x4000, 0x400f },
784	};
785	for (uint32_t j = 0; j < RT_ELEMENTS(s_aUnknowns); j++)
786	for (uint32_t i = s_aUnknowns[j].iMin; i <= s_aUnknowns[j].iMax; i++)
787	{
788	RT_ZERO(Caps);
789	hrc = WHvGetCapabilityWrapper((WHV_CAPABILITY_CODE)i, &Caps, sizeof(Caps));
790	if (SUCCEEDED(hrc))
791	LogRel(("NEM: Warning! Unknown capability %#x returning: %.*Rhxs\n", i, sizeof(Caps), &Caps));
792	}
793	}
794
795	/*
796	* For proper operation, we require CPUID exits.
797	*/
798	if (!pVM->nem.s.fExtendedCpuIdExit)
799	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Missing required extended CPUID exit support");
800	if (!pVM->nem.s.fExtendedMsrExit)
801	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Missing required extended MSR exit support");
802	if (!pVM->nem.s.fExtendedXcptExit)
803	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Missing required extended exception exit support");
804
805	#undef NEM_LOG_REL_CAP_EX
806	#undef NEM_LOG_REL_CAP_SUB_EX
807	#undef NEM_LOG_REL_CAP_SUB
808	return VINF_SUCCESS;
809	}
810
811	#ifdef LOG_ENABLED
812
813	/**
814	* Used to fill in g_IoCtlGetHvPartitionId.
815	*/
816	static NTSTATUS WINAPI
817	nemR3WinIoctlDetector_GetHvPartitionId(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
818	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
819	PVOID pvOutput, ULONG cbOutput)
820	{
821	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
822	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
823	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
824	AssertLogRelMsgReturn(cbInput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
825	RT_NOREF(pvInput);
826
827	AssertLogRelMsgReturn(RT_VALID_PTR(pvOutput), ("pvOutput=%p\n", pvOutput), STATUS_INVALID_PARAMETER_9);
828	AssertLogRelMsgReturn(cbOutput == sizeof(HV_PARTITION_ID), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
829	(HV_PARTITION_ID )pvOutput = NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_ID;
830
831	g_IoCtlGetHvPartitionId.cbInput = cbInput;
832	g_IoCtlGetHvPartitionId.cbOutput = cbOutput;
833	g_IoCtlGetHvPartitionId.uFunction = uFunction;
834
835	return STATUS_SUCCESS;
836	}
837
838
839	/**
840	* Used to fill in g_IoCtlGetHvPartitionId.
841	*/
842	static NTSTATUS WINAPI
843	nemR3WinIoctlDetector_GetPartitionProperty(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
844	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
845	PVOID pvOutput, ULONG cbOutput)
846	{
847	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
848	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
849	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
850	AssertLogRelMsgReturn(cbInput == sizeof(VID_PARTITION_PROPERTY_CODE), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
851	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
852	AssertLogRelMsgReturn((VID_PARTITION_PROPERTY_CODE )pvInput == NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_CODE,
853	("pvInput=%#x, expected %#x\n", (HV_PARTITION_PROPERTY_CODE *)pvInput,
854	NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_CODE), STATUS_INVALID_PARAMETER_9);
855	AssertLogRelMsgReturn(RT_VALID_PTR(pvOutput), ("pvOutput=%p\n", pvOutput), STATUS_INVALID_PARAMETER_9);
856	AssertLogRelMsgReturn(cbOutput == sizeof(HV_PARTITION_PROPERTY), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
857	(HV_PARTITION_PROPERTY )pvOutput = NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_VALUE;
858
859	g_IoCtlGetPartitionProperty.cbInput = cbInput;
860	g_IoCtlGetPartitionProperty.cbOutput = cbOutput;
861	g_IoCtlGetPartitionProperty.uFunction = uFunction;
862
863	return STATUS_SUCCESS;
864	}
865
866
867	/**
868	* Used to fill in g_IoCtlStartVirtualProcessor.
869	*/
870	static NTSTATUS WINAPI
871	nemR3WinIoctlDetector_StartVirtualProcessor(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
872	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
873	PVOID pvOutput, ULONG cbOutput)
874	{
875	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
876	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
877	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
878	AssertLogRelMsgReturn(cbInput == sizeof(HV_VP_INDEX), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
879	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
880	AssertLogRelMsgReturn((HV_VP_INDEX )pvInput == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
881	("piCpu=%u\n", (HV_VP_INDEX *)pvInput), STATUS_INVALID_PARAMETER_9);
882	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
883	RT_NOREF(pvOutput);
884
885	g_IoCtlStartVirtualProcessor.cbInput = cbInput;
886	g_IoCtlStartVirtualProcessor.cbOutput = cbOutput;
887	g_IoCtlStartVirtualProcessor.uFunction = uFunction;
888
889	return STATUS_SUCCESS;
890	}
891
892
893	/**
894	* Used to fill in g_IoCtlStartVirtualProcessor.
895	*/
896	static NTSTATUS WINAPI
897	nemR3WinIoctlDetector_StopVirtualProcessor(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
898	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
899	PVOID pvOutput, ULONG cbOutput)
900	{
901	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
902	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
903	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
904	AssertLogRelMsgReturn(cbInput == sizeof(HV_VP_INDEX), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
905	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
906	AssertLogRelMsgReturn((HV_VP_INDEX )pvInput == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
907	("piCpu=%u\n", (HV_VP_INDEX *)pvInput), STATUS_INVALID_PARAMETER_9);
908	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
909	RT_NOREF(pvOutput);
910
911	g_IoCtlStopVirtualProcessor.cbInput = cbInput;
912	g_IoCtlStopVirtualProcessor.cbOutput = cbOutput;
913	g_IoCtlStopVirtualProcessor.uFunction = uFunction;
914
915	return STATUS_SUCCESS;
916	}
917
918
919	/**
920	* Used to fill in g_IoCtlMessageSlotHandleAndGetNext
921	*/
922	static NTSTATUS WINAPI
923	nemR3WinIoctlDetector_MessageSlotHandleAndGetNext(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
924	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
925	PVOID pvOutput, ULONG cbOutput)
926	{
927	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
928	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
929	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
930
931	if (g_uBuildNo >= 17758)
932	{
933	/* No timeout since about build 17758, it's now always an infinite wait. So, a somewhat compatible change. */
934	AssertLogRelMsgReturn(cbInput == RT_UOFFSETOF(VID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT, cMillies),
935	("cbInput=%#x\n", cbInput),
936	STATUS_INVALID_PARAMETER_8);
937	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
938	PCVID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT pVidIn = (PCVID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT)pvInput;
939	AssertLogRelMsgReturn( pVidIn->iCpu == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX
940	&& pVidIn->fFlags == VID_MSHAGN_F_HANDLE_MESSAGE,
941	("iCpu=%u fFlags=%#x cMillies=%#x\n", pVidIn->iCpu, pVidIn->fFlags, pVidIn->cMillies),
942	STATUS_INVALID_PARAMETER_9);
943	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
944	}
945	else
946	{
947	AssertLogRelMsgReturn(cbInput == sizeof(VID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT), ("cbInput=%#x\n", cbInput),
948	STATUS_INVALID_PARAMETER_8);
949	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
950	PCVID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT pVidIn = (PCVID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT)pvInput;
951	AssertLogRelMsgReturn( pVidIn->iCpu == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX
952	&& pVidIn->fFlags == VID_MSHAGN_F_HANDLE_MESSAGE
953	&& pVidIn->cMillies == NEM_WIN_IOCTL_DETECTOR_FAKE_TIMEOUT,
954	("iCpu=%u fFlags=%#x cMillies=%#x\n", pVidIn->iCpu, pVidIn->fFlags, pVidIn->cMillies),
955	STATUS_INVALID_PARAMETER_9);
956	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
957	RT_NOREF(pvOutput);
958	}
959
960	g_IoCtlMessageSlotHandleAndGetNext.cbInput = cbInput;
961	g_IoCtlMessageSlotHandleAndGetNext.cbOutput = cbOutput;
962	g_IoCtlMessageSlotHandleAndGetNext.uFunction = uFunction;
963
964	return STATUS_SUCCESS;
965	}
966
967	/**
968	* Used to fill in what g_pIoCtlDetectForLogging points to.
969	*/
970	static NTSTATUS WINAPI nemR3WinIoctlDetector_ForLogging(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
971	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
972	PVOID pvOutput, ULONG cbOutput)
973	{
974	RT_NOREF(hFile, hEvt, pfnApcCallback, pvApcCtx, pIos, pvInput, pvOutput);
975
976	g_pIoCtlDetectForLogging->cbInput = cbInput;
977	g_pIoCtlDetectForLogging->cbOutput = cbOutput;
978	g_pIoCtlDetectForLogging->uFunction = uFunction;
979
980	return STATUS_SUCCESS;
981	}
982
983	#endif /* LOG_ENABLED */
984
985	/**
986	* Worker for nemR3NativeInit that detect I/O control function numbers for VID.
987	*
988	* We use the function numbers directly in ring-0 and to name functions when
989	* logging NtDeviceIoControlFile calls.
990	*
991	* @note We could alternatively do this by disassembling the respective
992	* functions, but hooking NtDeviceIoControlFile and making fake calls
993	* more easily provides the desired information.
994	*
995	* @returns VBox status code.
996	* @param pVM The cross context VM structure. Will set I/O
997	* control info members.
998	* @param pErrInfo Where to always return error info.
999	*/
1000	static int nemR3WinInitDiscoverIoControlProperties(PVM pVM, PRTERRINFO pErrInfo)
1001	{
1002	RT_NOREF(pVM, pErrInfo);
1003
1004	/*
1005	* Probe the I/O control information for select VID APIs so we can use
1006	* them directly from ring-0 and better log them.
1007	*
1008	*/
1009	#ifdef LOG_ENABLED
1010	decltype(NtDeviceIoControlFile) * const pfnOrg = *g_ppfnVidNtDeviceIoControlFile;
1011
1012	/* VidGetHvPartitionId - must work due to our memory management. */
1013	BOOL fRet;
1014	if (g_pfnVidGetHvPartitionId)
1015	{
1016	HV_PARTITION_ID idHvPartition = HV_PARTITION_ID_INVALID;
1017	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_GetHvPartitionId;
1018	fRet = g_pfnVidGetHvPartitionId(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, &idHvPartition);
1019	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1020	AssertReturn(fRet && idHvPartition == NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_ID && g_IoCtlGetHvPartitionId.uFunction != 0,
1021	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
1022	"Problem figuring out VidGetHvPartitionId: fRet=%u idHvPartition=%#x dwErr=%u",
1023	fRet, idHvPartition, GetLastError()) );
1024	LogRel(("NEM: VidGetHvPartitionId -> fun:%#x in:%#x out:%#x\n",
1025	g_IoCtlGetHvPartitionId.uFunction, g_IoCtlGetHvPartitionId.cbInput, g_IoCtlGetHvPartitionId.cbOutput));
1026	}
1027
1028	/* VidGetPartitionProperty - must work as it's fallback for VidGetHvPartitionId. */
1029	if (g_ppfnVidNtDeviceIoControlFile)
1030	{
1031	HV_PARTITION_PROPERTY uPropValue = ~NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_VALUE;
1032	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_GetPartitionProperty;
1033	fRet = g_pfnVidGetPartitionProperty(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_CODE,
1034	&uPropValue);
1035	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1036	AssertReturn( fRet
1037	&& uPropValue == NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_PROPERTY_VALUE
1038	&& g_IoCtlGetHvPartitionId.uFunction != 0,
1039	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
1040	"Problem figuring out VidGetPartitionProperty: fRet=%u uPropValue=%#x dwErr=%u",
1041	fRet, uPropValue, GetLastError()) );
1042	LogRel(("NEM: VidGetPartitionProperty -> fun:%#x in:%#x out:%#x\n",
1043	g_IoCtlGetPartitionProperty.uFunction, g_IoCtlGetPartitionProperty.cbInput, g_IoCtlGetPartitionProperty.cbOutput));
1044	}
1045
1046	/* VidStartVirtualProcessor */
1047	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_StartVirtualProcessor;
1048	fRet = g_pfnVidStartVirtualProcessor(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX);
1049	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1050	AssertStmt(fRet && g_IoCtlStartVirtualProcessor.uFunction != 0,
1051	RTERRINFO_LOG_REL_SET_F(pErrInfo, VERR_NEM_RING3_ONLY,
1052	"Problem figuring out VidStartVirtualProcessor: fRet=%u dwErr=%u", fRet, GetLastError()) );
1053	LogRel(("NEM: VidStartVirtualProcessor -> fun:%#x in:%#x out:%#x\n", g_IoCtlStartVirtualProcessor.uFunction,
1054	g_IoCtlStartVirtualProcessor.cbInput, g_IoCtlStartVirtualProcessor.cbOutput));
1055
1056	/* VidStopVirtualProcessor */
1057	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_StopVirtualProcessor;
1058	fRet = g_pfnVidStopVirtualProcessor(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX);
1059	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1060	AssertStmt(fRet && g_IoCtlStopVirtualProcessor.uFunction != 0,
1061	RTERRINFO_LOG_REL_SET_F(pErrInfo, VERR_NEM_RING3_ONLY,
1062	"Problem figuring out VidStopVirtualProcessor: fRet=%u dwErr=%u", fRet, GetLastError()) );
1063	LogRel(("NEM: VidStopVirtualProcessor -> fun:%#x in:%#x out:%#x\n", g_IoCtlStopVirtualProcessor.uFunction,
1064	g_IoCtlStopVirtualProcessor.cbInput, g_IoCtlStopVirtualProcessor.cbOutput));
1065
1066	/* VidMessageSlotHandleAndGetNext */
1067	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_MessageSlotHandleAndGetNext;
1068	fRet = g_pfnVidMessageSlotHandleAndGetNext(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE,
1069	NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX, VID_MSHAGN_F_HANDLE_MESSAGE,
1070	NEM_WIN_IOCTL_DETECTOR_FAKE_TIMEOUT);
1071	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1072	AssertStmt(fRet && g_IoCtlMessageSlotHandleAndGetNext.uFunction != 0,
1073	RTERRINFO_LOG_REL_SET_F(pErrInfo, VERR_NEM_RING3_ONLY,
1074	"Problem figuring out VidMessageSlotHandleAndGetNext: fRet=%u dwErr=%u",
1075	fRet, GetLastError()) );
1076	LogRel(("NEM: VidMessageSlotHandleAndGetNext -> fun:%#x in:%#x out:%#x\n",
1077	g_IoCtlMessageSlotHandleAndGetNext.uFunction, g_IoCtlMessageSlotHandleAndGetNext.cbInput,
1078	g_IoCtlMessageSlotHandleAndGetNext.cbOutput));
1079
1080	/* The following are only for logging: */
1081	union
1082	{
1083	VID_MAPPED_MESSAGE_SLOT MapSlot;
1084	HV_REGISTER_NAME Name;
1085	HV_REGISTER_VALUE Value;
1086	} uBuf;
1087
1088	/* VidMessageSlotMap */
1089	g_pIoCtlDetectForLogging = &g_IoCtlMessageSlotMap;
1090	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_ForLogging;
1091	fRet = g_pfnVidMessageSlotMap(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, &uBuf.MapSlot, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX);
1092	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1093	Assert(fRet);
1094	LogRel(("NEM: VidMessageSlotMap -> fun:%#x in:%#x out:%#x\n", g_pIoCtlDetectForLogging->uFunction,
1095	g_pIoCtlDetectForLogging->cbInput, g_pIoCtlDetectForLogging->cbOutput));
1096
1097	/* VidGetVirtualProcessorState */
1098	uBuf.Name = HvRegisterExplicitSuspend;
1099	g_pIoCtlDetectForLogging = &g_IoCtlGetVirtualProcessorState;
1100	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_ForLogging;
1101	fRet = g_pfnVidGetVirtualProcessorState(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
1102	&uBuf.Name, 1, &uBuf.Value);
1103	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1104	Assert(fRet);
1105	LogRel(("NEM: VidGetVirtualProcessorState -> fun:%#x in:%#x out:%#x\n", g_pIoCtlDetectForLogging->uFunction,
1106	g_pIoCtlDetectForLogging->cbInput, g_pIoCtlDetectForLogging->cbOutput));
1107
1108	/* VidSetVirtualProcessorState */
1109	uBuf.Name = HvRegisterExplicitSuspend;
1110	g_pIoCtlDetectForLogging = &g_IoCtlSetVirtualProcessorState;
1111	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_ForLogging;
1112	fRet = g_pfnVidSetVirtualProcessorState(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
1113	&uBuf.Name, 1, &uBuf.Value);
1114	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
1115	Assert(fRet);
1116	LogRel(("NEM: VidSetVirtualProcessorState -> fun:%#x in:%#x out:%#x\n", g_pIoCtlDetectForLogging->uFunction,
1117	g_pIoCtlDetectForLogging->cbInput, g_pIoCtlDetectForLogging->cbOutput));
1118
1119	g_pIoCtlDetectForLogging = NULL;
1120	#endif /* LOG_ENABLED */
1121
1122	return VINF_SUCCESS;
1123	}
1124
1125
1126	/**
1127	* Creates and sets up a Hyper-V (exo) partition.
1128	*
1129	* @returns VBox status code.
1130	* @param pVM The cross context VM structure.
1131	* @param pErrInfo Where to always return error info.
1132	*/
1133	static int nemR3WinInitCreatePartition(PVM pVM, PRTERRINFO pErrInfo)
1134	{
1135	AssertReturn(!pVM->nem.s.hPartition, RTErrInfoSet(pErrInfo, VERR_WRONG_ORDER, "Wrong initalization order"));
1136	AssertReturn(!pVM->nem.s.hPartitionDevice, RTErrInfoSet(pErrInfo, VERR_WRONG_ORDER, "Wrong initalization order"));
1137
1138	/*
1139	* Create the partition.
1140	*/
1141	WHV_PARTITION_HANDLE hPartition;
1142	HRESULT hrc = WHvCreatePartition(&hPartition);
1143	if (FAILED(hrc))
1144	return RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED, "WHvCreatePartition failed with %Rhrc (Last=%#x/%u)",
1145	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1146
1147	int rc;
1148
1149	/*
1150	* Set partition properties, most importantly the CPU count.
1151	*/
1152	/**
1153	* @todo Someone at Microsoft please explain another weird API:
1154	* - Why this API doesn't take the WHV_PARTITION_PROPERTY_CODE value as an
1155	* argument rather than as part of the struct. That is so weird if you've
1156	* used any other NT or windows API, including WHvGetCapability().
1157	* - Why use PVOID when WHV_PARTITION_PROPERTY is what's expected. We
1158	* technically only need 9 bytes for setting/getting
1159	* WHVPartitionPropertyCodeProcessorClFlushSize, but the API insists on 16. */
1160	WHV_PARTITION_PROPERTY Property;
1161	RT_ZERO(Property);
1162	Property.ProcessorCount = pVM->cCpus;
1163	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorCount, &Property, sizeof(Property));
1164	if (SUCCEEDED(hrc))
1165	{
1166	RT_ZERO(Property);
1167	Property.ExtendedVmExits.X64CpuidExit = pVM->nem.s.fExtendedCpuIdExit; /** @todo Register fixed results and restrict cpuid exits */
1168	Property.ExtendedVmExits.X64MsrExit = pVM->nem.s.fExtendedMsrExit;
1169	Property.ExtendedVmExits.ExceptionExit = pVM->nem.s.fExtendedXcptExit;
1170	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeExtendedVmExits, &Property, sizeof(Property));
1171	if (SUCCEEDED(hrc))
1172	{
1173	/*
1174	* We'll continue setup in nemR3NativeInitAfterCPUM.
1175	*/
1176	pVM->nem.s.fCreatedEmts = false;
1177	pVM->nem.s.hPartition = hPartition;
1178	LogRel(("NEM: Created partition %p.\n", hPartition));
1179	return VINF_SUCCESS;
1180	}
1181
1182	rc = RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED,
1183	"Failed setting WHvPartitionPropertyCodeExtendedVmExits to %'#RX64: %Rhrc",
1184	Property.ExtendedVmExits.AsUINT64, hrc);
1185	}
1186	else
1187	rc = RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED,
1188	"Failed setting WHvPartitionPropertyCodeProcessorCount to %u: %Rhrc (Last=%#x/%u)",
1189	pVM->cCpus, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1190	WHvDeletePartition(hPartition);
1191
1192	Assert(!pVM->nem.s.hPartitionDevice);
1193	Assert(!pVM->nem.s.hPartition);
1194	return rc;
1195	}
1196
1197
1198	/**
1199	* Makes sure APIC and firmware will not allow X2APIC mode.
1200	*
1201	* This is rather ugly.
1202	*
1203	* @returns VBox status code
1204	* @param pVM The cross context VM structure.
1205	*/
1206	static int nemR3WinDisableX2Apic(PVM pVM)
1207	{
1208	/*
1209	* First make sure the 'Mode' config value of the APIC isn't set to X2APIC.
1210	* This defaults to APIC, so no need to change unless it's X2APIC.
1211	*/
1212	PCFGMNODE pCfg = CFGMR3GetChild(CFGMR3GetRoot(pVM), "/Devices/apic/0/Config");
1213	if (pCfg)
1214	{
1215	uint8_t bMode = 0;
1216	int rc = CFGMR3QueryU8(pCfg, "Mode", &bMode);
1217	AssertLogRelMsgReturn(RT_SUCCESS(rc) \|\| rc == VERR_CFGM_VALUE_NOT_FOUND, ("%Rrc\n", rc), rc);
1218	if (RT_SUCCESS(rc) && bMode == PDMAPICMODE_X2APIC)
1219	{
1220	LogRel(("NEM: Adjusting APIC configuration from X2APIC to APIC max mode. X2APIC is not supported by the WinHvPlatform API!\n"));
1221	LogRel(("NEM: Disable Hyper-V if you need X2APIC for your guests!\n"));
1222	rc = CFGMR3RemoveValue(pCfg, "Mode");
1223	rc = CFGMR3InsertInteger(pCfg, "Mode", PDMAPICMODE_APIC);
1224	AssertLogRelRCReturn(rc, rc);
1225	}
1226	}
1227
1228	/*
1229	* Now the firmwares.
1230	* These also defaults to APIC and only needs adjusting if configured to X2APIC (2).
1231	*/
1232	static const char * const s_apszFirmwareConfigs[] =
1233	{
1234	"/Devices/efi/0/Config",
1235	"/Devices/pcbios/0/Config",
1236	};
1237	for (unsigned i = 0; i < RT_ELEMENTS(s_apszFirmwareConfigs); i++)
1238	{
1239	pCfg = CFGMR3GetChild(CFGMR3GetRoot(pVM), "/Devices/APIC/0/Config");
1240	if (pCfg)
1241	{
1242	uint8_t bMode = 0;
1243	int rc = CFGMR3QueryU8(pCfg, "APIC", &bMode);
1244	AssertLogRelMsgReturn(RT_SUCCESS(rc) \|\| rc == VERR_CFGM_VALUE_NOT_FOUND, ("%Rrc\n", rc), rc);
1245	if (RT_SUCCESS(rc) && bMode == 2)
1246	{
1247	LogRel(("NEM: Adjusting %s/Mode from 2 (X2APIC) to 1 (APIC).\n", s_apszFirmwareConfigs[i]));
1248	rc = CFGMR3RemoveValue(pCfg, "APIC");
1249	rc = CFGMR3InsertInteger(pCfg, "APIC", 1);
1250	AssertLogRelRCReturn(rc, rc);
1251	}
1252	}
1253	}
1254
1255	return VINF_SUCCESS;
1256	}
1257
1258
1259	/**
1260	* Try initialize the native API.
1261	*
1262	* This may only do part of the job, more can be done in
1263	* nemR3NativeInitAfterCPUM() and nemR3NativeInitCompleted().
1264	*
1265	* @returns VBox status code.
1266	* @param pVM The cross context VM structure.
1267	* @param fFallback Whether we're in fallback mode or use-NEM mode. In
1268	* the latter we'll fail if we cannot initialize.
1269	* @param fForced Whether the HMForced flag is set and we should
1270	* fail if we cannot initialize.
1271	*/
1272	int nemR3NativeInit(PVM pVM, bool fFallback, bool fForced)
1273	{
1274	g_uBuildNo = RTSystemGetNtBuildNo();
1275
1276	/*
1277	* Some state init.
1278	*/
1279	#ifdef NEM_WIN_WITH_A20
1280	pVM->nem.s.fA20Enabled = true;
1281	#endif
1282	#if 0
1283	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1284	{
1285	PNEMCPU pNemCpu = &pVM->apCpusR3[idCpu]->nem.s;
1286	}
1287	#endif
1288
1289	/*
1290	* Error state.
1291	* The error message will be non-empty on failure and 'rc' will be set too.
1292	*/
1293	RTERRINFOSTATIC ErrInfo;
1294	PRTERRINFO pErrInfo = RTErrInfoInitStatic(&ErrInfo);
1295	int rc = nemR3WinInitProbeAndLoad(fForced, pErrInfo);
1296	if (RT_SUCCESS(rc))
1297	{
1298	/*
1299	* Check the capabilties of the hypervisor, starting with whether it's present.
1300	*/
1301	rc = nemR3WinInitCheckCapabilities(pVM, pErrInfo);
1302	if (RT_SUCCESS(rc))
1303	{
1304	/*
1305	* Discover the VID I/O control function numbers we need (for interception
1306	* only these days).
1307	*/
1308	rc = nemR3WinInitDiscoverIoControlProperties(pVM, pErrInfo);
1309	if (RT_SUCCESS(rc))
1310	{
1311	/*
1312	* Create and initialize a partition.
1313	*/
1314	rc = nemR3WinInitCreatePartition(pVM, pErrInfo);
1315	if (RT_SUCCESS(rc))
1316	{
1317	/*
1318	* Set ourselves as the execution engine and make config adjustments.
1319	*/
1320	VM_SET_MAIN_EXECUTION_ENGINE(pVM, VM_EXEC_ENGINE_NATIVE_API);
1321	Log(("NEM: Marked active!\n"));
1322	nemR3WinDisableX2Apic(pVM);
1323	nemR3DisableCpuIsaExt(pVM, "MONITOR"); /* MONITOR is not supported by Hyper-V (MWAIT is sometimes). */
1324	PGMR3EnableNemMode(pVM);
1325
1326	/*
1327	* Register release statistics
1328	*/
1329	STAMR3Register(pVM, (void *)&pVM->nem.s.cMappedPages, STAMTYPE_U32, STAMVISIBILITY_ALWAYS,
1330	"/NEM/PagesCurrentlyMapped", STAMUNIT_PAGES, "Number guest pages currently mapped by the VM");
1331	STAMR3Register(pVM, (void *)&pVM->nem.s.StatMapPage, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1332	"/NEM/PagesMapCalls", STAMUNIT_PAGES, "Calls to WHvMapGpaRange/HvCallMapGpaPages");
1333	STAMR3Register(pVM, (void *)&pVM->nem.s.StatMapPageFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1334	"/NEM/PagesMapFails", STAMUNIT_PAGES, "Calls to WHvMapGpaRange/HvCallMapGpaPages that failed");
1335	STAMR3Register(pVM, (void *)&pVM->nem.s.StatUnmapPage, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1336	"/NEM/PagesUnmapCalls", STAMUNIT_PAGES, "Calls to WHvUnmapGpaRange/HvCallUnmapGpaPages");
1337	STAMR3Register(pVM, (void *)&pVM->nem.s.StatUnmapPageFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS,
1338	"/NEM/PagesUnmapFails", STAMUNIT_PAGES, "Calls to WHvUnmapGpaRange/HvCallUnmapGpaPages that failed");
1339	STAMR3Register(pVM, &pVM->nem.s.StatProfMapGpaRange, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS,
1340	"/NEM/PagesMapGpaRange", STAMUNIT_TICKS_PER_CALL, "Profiling calls to WHvMapGpaRange for bigger stuff");
1341	STAMR3Register(pVM, &pVM->nem.s.StatProfUnmapGpaRange, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS,
1342	"/NEM/PagesUnmapGpaRange", STAMUNIT_TICKS_PER_CALL, "Profiling calls to WHvUnmapGpaRange for bigger stuff");
1343	STAMR3Register(pVM, &pVM->nem.s.StatProfMapGpaRangePage, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS,
1344	"/NEM/PagesMapGpaRangePage", STAMUNIT_TICKS_PER_CALL, "Profiling calls to WHvMapGpaRange for single pages");
1345	STAMR3Register(pVM, &pVM->nem.s.StatProfUnmapGpaRangePage, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS,
1346	"/NEM/PagesUnmapGpaRangePage", STAMUNIT_TICKS_PER_CALL, "Profiling calls to WHvUnmapGpaRange for single pages");
1347
1348	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1349	{
1350	PNEMCPU pNemCpu = &pVM->apCpusR3[idCpu]->nem.s;
1351	STAMR3RegisterF(pVM, &pNemCpu->StatExitPortIo, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of port I/O exits", "/NEM/CPU%u/ExitPortIo", idCpu);
1352	STAMR3RegisterF(pVM, &pNemCpu->StatExitMemUnmapped, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of unmapped memory exits", "/NEM/CPU%u/ExitMemUnmapped", idCpu);
1353	STAMR3RegisterF(pVM, &pNemCpu->StatExitMemIntercept, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of intercepted memory exits", "/NEM/CPU%u/ExitMemIntercept", idCpu);
1354	STAMR3RegisterF(pVM, &pNemCpu->StatExitHalt, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of HLT exits", "/NEM/CPU%u/ExitHalt", idCpu);
1355	STAMR3RegisterF(pVM, &pNemCpu->StatExitInterruptWindow, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of interrupt window exits", "/NEM/CPU%u/ExitInterruptWindow", idCpu);
1356	STAMR3RegisterF(pVM, &pNemCpu->StatExitCpuId, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of CPUID exits", "/NEM/CPU%u/ExitCpuId", idCpu);
1357	STAMR3RegisterF(pVM, &pNemCpu->StatExitMsr, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of MSR access exits", "/NEM/CPU%u/ExitMsr", idCpu);
1358	STAMR3RegisterF(pVM, &pNemCpu->StatExitException, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of exception exits", "/NEM/CPU%u/ExitException", idCpu);
1359	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionBp, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #BP exits", "/NEM/CPU%u/ExitExceptionBp", idCpu);
1360	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionDb, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #DB exits", "/NEM/CPU%u/ExitExceptionDb", idCpu);
1361	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionGp, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #GP exits", "/NEM/CPU%u/ExitExceptionGp", idCpu);
1362	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionGpMesa, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #GP exits from mesa driver", "/NEM/CPU%u/ExitExceptionGpMesa", idCpu);
1363	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionUd, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #UD exits", "/NEM/CPU%u/ExitExceptionUd", idCpu);
1364	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionUdHandled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of handled #UD exits", "/NEM/CPU%u/ExitExceptionUdHandled", idCpu);
1365	STAMR3RegisterF(pVM, &pNemCpu->StatExitUnrecoverable, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of unrecoverable exits", "/NEM/CPU%u/ExitUnrecoverable", idCpu);
1366	STAMR3RegisterF(pVM, &pNemCpu->StatGetMsgTimeout, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of get message timeouts/alerts", "/NEM/CPU%u/GetMsgTimeout", idCpu);
1367	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuSuccess, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of successful CPU stops", "/NEM/CPU%u/StopCpuSuccess", idCpu);
1368	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuPending, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pending CPU stops", "/NEM/CPU%u/StopCpuPending", idCpu);
1369	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuPendingAlerts,STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pending CPU stop alerts", "/NEM/CPU%u/StopCpuPendingAlerts", idCpu);
1370	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuPendingOdd, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of odd pending CPU stops (see code)", "/NEM/CPU%u/StopCpuPendingOdd", idCpu);
1371	STAMR3RegisterF(pVM, &pNemCpu->StatCancelChangedState, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel changed state", "/NEM/CPU%u/CancelChangedState", idCpu);
1372	STAMR3RegisterF(pVM, &pNemCpu->StatCancelAlertedThread, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel alerted EMT", "/NEM/CPU%u/CancelAlertedEMT", idCpu);
1373	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnFFPre, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pre execution FF breaks", "/NEM/CPU%u/BreakOnFFPre", idCpu);
1374	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnFFPost, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of post execution FF breaks", "/NEM/CPU%u/BreakOnFFPost", idCpu);
1375	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnCancel, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel execution breaks", "/NEM/CPU%u/BreakOnCancel", idCpu);
1376	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnStatus, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of status code breaks", "/NEM/CPU%u/BreakOnStatus", idCpu);
1377	STAMR3RegisterF(pVM, &pNemCpu->StatImportOnDemand, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of on-demand state imports", "/NEM/CPU%u/ImportOnDemand", idCpu);
1378	STAMR3RegisterF(pVM, &pNemCpu->StatImportOnReturn, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of state imports on loop return", "/NEM/CPU%u/ImportOnReturn", idCpu);
1379	STAMR3RegisterF(pVM, &pNemCpu->StatImportOnReturnSkipped, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of skipped state imports on loop return", "/NEM/CPU%u/ImportOnReturnSkipped", idCpu);
1380	STAMR3RegisterF(pVM, &pNemCpu->StatQueryCpuTick, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of TSC queries", "/NEM/CPU%u/QueryCpuTick", idCpu);
1381	}
1382
1383	#if defined(VBOX_WITH_R0_MODULES) && !defined(VBOX_WITH_MINIMAL_R0)
1384	if (!SUPR3IsDriverless())
1385	{
1386	PUVM pUVM = pVM->pUVM;
1387	STAMR3RegisterRefresh(pUVM, &pVM->nem.s.R0Stats.cPagesAvailable, STAMTYPE_U64, STAMVISIBILITY_ALWAYS,
1388	STAMUNIT_PAGES, STAM_REFRESH_GRP_NEM, "Free pages available to the hypervisor",
1389	"/NEM/R0Stats/cPagesAvailable");
1390	STAMR3RegisterRefresh(pUVM, &pVM->nem.s.R0Stats.cPagesInUse, STAMTYPE_U64, STAMVISIBILITY_ALWAYS,
1391	STAMUNIT_PAGES, STAM_REFRESH_GRP_NEM, "Pages in use by hypervisor",
1392	"/NEM/R0Stats/cPagesInUse");
1393	}
1394	#endif /* VBOX_WITH_R0_MODULES && !VBOX_WITH_MINIMAL_R0 */
1395
1396	}
1397	}
1398	}
1399	}
1400
1401	/*
1402	* We only fail if in forced mode, otherwise just log the complaint and return.
1403	*/
1404	Assert(pVM->bMainExecutionEngine == VM_EXEC_ENGINE_NATIVE_API \|\| RTErrInfoIsSet(pErrInfo));
1405	if ( (fForced \|\| !fFallback)
1406	&& pVM->bMainExecutionEngine != VM_EXEC_ENGINE_NATIVE_API)
1407	return VMSetError(pVM, RT_SUCCESS_NP(rc) ? VERR_NEM_NOT_AVAILABLE : rc, RT_SRC_POS, "%s", pErrInfo->pszMsg);
1408
1409	if (RTErrInfoIsSet(pErrInfo))
1410	LogRel(("NEM: Not available: %s\n", pErrInfo->pszMsg));
1411	return VINF_SUCCESS;
1412	}
1413
1414
1415	/**
1416	* This is called after CPUMR3Init is done.
1417	*
1418	* @returns VBox status code.
1419	* @param pVM The VM handle..
1420	*/
1421	int nemR3NativeInitAfterCPUM(PVM pVM)
1422	{
1423	/*
1424	* Validate sanity.
1425	*/
1426	WHV_PARTITION_HANDLE hPartition = pVM->nem.s.hPartition;
1427	AssertReturn(hPartition != NULL, VERR_WRONG_ORDER);
1428	AssertReturn(!pVM->nem.s.hPartitionDevice, VERR_WRONG_ORDER);
1429	AssertReturn(!pVM->nem.s.fCreatedEmts, VERR_WRONG_ORDER);
1430	AssertReturn(pVM->bMainExecutionEngine == VM_EXEC_ENGINE_NATIVE_API, VERR_WRONG_ORDER);
1431
1432	/*
1433	* Continue setting up the partition now that we've got most of the CPUID feature stuff.
1434	*/
1435	WHV_PARTITION_PROPERTY Property;
1436	HRESULT hrc;
1437
1438	#if 0
1439	/* Not sure if we really need to set the vendor.
1440	Update: Apparently we don't. WHvPartitionPropertyCodeProcessorVendor was removed in 17110. */
1441	RT_ZERO(Property);
1442	Property.ProcessorVendor = pVM->nem.s.enmCpuVendor == CPUMCPUVENDOR_AMD ? WHvProcessorVendorAmd
1443	: WHvProcessorVendorIntel;
1444	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorVendor, &Property, sizeof(Property));
1445	if (FAILED(hrc))
1446	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1447	"Failed to set WHvPartitionPropertyCodeProcessorVendor to %u: %Rhrc (Last=%#x/%u)",
1448	Property.ProcessorVendor, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1449	#endif
1450
1451	/* Not sure if we really need to set the cache line flush size. */
1452	RT_ZERO(Property);
1453	Property.ProcessorClFlushSize = pVM->nem.s.cCacheLineFlushShift;
1454	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorClFlushSize, &Property, sizeof(Property));
1455	if (FAILED(hrc))
1456	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1457	"Failed to set WHvPartitionPropertyCodeProcessorClFlushSize to %u: %Rhrc (Last=%#x/%u)",
1458	pVM->nem.s.cCacheLineFlushShift, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1459
1460	/* Intercept #DB, #BP and #UD exceptions. */
1461	RT_ZERO(Property);
1462	Property.ExceptionExitBitmap = RT_BIT_64(WHvX64ExceptionTypeDebugTrapOrFault)
1463	\| RT_BIT_64(WHvX64ExceptionTypeBreakpointTrap)
1464	\| RT_BIT_64(WHvX64ExceptionTypeInvalidOpcodeFault);
1465
1466	/* Intercept #GP to workaround the buggy mesa vmwgfx driver. */
1467	PVMCPU pVCpu = pVM->apCpusR3[0]; /** @todo In theory per vCPU, in practice same for all. */
1468	if (pVCpu->nem.s.fTrapXcptGpForLovelyMesaDrv)
1469	Property.ExceptionExitBitmap \|= RT_BIT_64(WHvX64ExceptionTypeGeneralProtectionFault);
1470
1471	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeExceptionExitBitmap, &Property, sizeof(Property));
1472	if (FAILED(hrc))
1473	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1474	"Failed to set WHvPartitionPropertyCodeExceptionExitBitmap to %#RX64: %Rhrc (Last=%#x/%u)",
1475	Property.ExceptionExitBitmap, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1476
1477
1478	/*
1479	* Sync CPU features with CPUM.
1480	*/
1481	/** @todo sync CPU features with CPUM. */
1482
1483	/* Set the partition property. */
1484	RT_ZERO(Property);
1485	Property.ProcessorFeatures.AsUINT64 = pVM->nem.s.uCpuFeatures.u64;
1486	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorFeatures, &Property, sizeof(Property));
1487	if (FAILED(hrc))
1488	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1489	"Failed to set WHvPartitionPropertyCodeProcessorFeatures to %'#RX64: %Rhrc (Last=%#x/%u)",
1490	pVM->nem.s.uCpuFeatures.u64, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1491
1492	/*
1493	* Set up the partition.
1494	*
1495	* Seems like this is where the partition is actually instantiated and we get
1496	* a handle to it.
1497	*/
1498	hrc = WHvSetupPartition(hPartition);
1499	if (FAILED(hrc))
1500	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1501	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)",
1502	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1503
1504	/*
1505	* Hysterical raisins: Get the handle (could also fish this out via VID.DLL NtDeviceIoControlFile intercepting).
1506	*/
1507	HANDLE hPartitionDevice;
1508	__try
1509	{
1510	hPartitionDevice = ((HANDLE *)hPartition)[1];
1511	if (!hPartitionDevice)
1512	hPartitionDevice = INVALID_HANDLE_VALUE;
1513	}
1514	__except(EXCEPTION_EXECUTE_HANDLER)
1515	{
1516	hrc = GetExceptionCode();
1517	hPartitionDevice = INVALID_HANDLE_VALUE;
1518	}
1519
1520	/* Test the handle. */
1521	HV_PARTITION_PROPERTY uValue = 0;
1522	if ( g_pfnVidGetPartitionProperty
1523	&& hPartitionDevice != INVALID_HANDLE_VALUE
1524	&& !g_pfnVidGetPartitionProperty(hPartitionDevice, HvPartitionPropertyProcessorVendor, &uValue))
1525	hPartitionDevice = INVALID_HANDLE_VALUE;
1526	LogRel(("NEM: HvPartitionPropertyProcessorVendor=%#llx (%lld)\n", uValue, uValue));
1527
1528	/*
1529	* More hysterical rasins: Get the partition ID if we can.
1530	*/
1531	HV_PARTITION_ID idHvPartition = HV_PARTITION_ID_INVALID;
1532	if ( g_pfnVidGetHvPartitionId
1533	&& hPartitionDevice != INVALID_HANDLE_VALUE
1534	&& !g_pfnVidGetHvPartitionId(hPartitionDevice, &idHvPartition))
1535	{
1536	idHvPartition = HV_PARTITION_ID_INVALID;
1537	Log(("NEM: VidGetHvPartitionId failed: %#x\n", GetLastError()));
1538	}
1539	pVM->nem.s.hPartitionDevice = hPartitionDevice;
1540
1541	/*
1542	* Setup the EMTs.
1543	*/
1544	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1545	{
1546	pVCpu = pVM->apCpusR3[idCpu];
1547
1548	hrc = WHvCreateVirtualProcessor(hPartition, idCpu, 0 /fFlags/);
1549	if (FAILED(hrc))
1550	{
1551	NTSTATUS const rcNtLast = RTNtLastStatusValue();
1552	DWORD const dwErrLast = RTNtLastErrorValue();
1553	while (idCpu-- > 0)
1554	{
1555	HRESULT hrc2 = WHvDeleteVirtualProcessor(hPartition, idCpu);
1556	AssertLogRelMsg(SUCCEEDED(hrc2), ("WHvDeleteVirtualProcessor(%p, %u) -> %Rhrc (Last=%#x/%u)\n",
1557	hPartition, idCpu, hrc2, RTNtLastStatusValue(),
1558	RTNtLastErrorValue()));
1559	}
1560	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1561	"Call to WHvCreateVirtualProcessor failed: %Rhrc (Last=%#x/%u)", hrc, rcNtLast, dwErrLast);
1562	}
1563	}
1564	pVM->nem.s.fCreatedEmts = true;
1565
1566	LogRel(("NEM: Successfully set up partition (device handle %p, partition ID %#llx)\n", hPartitionDevice, idHvPartition));
1567
1568	/*
1569	* Any hyper-v statistics we can get at now? HvCallMapStatsPage isn't accessible any more.
1570	*/
1571	/** @todo stats */
1572
1573	/*
1574	* Adjust features.
1575	*
1576	* Note! We've already disabled X2APIC and MONITOR/MWAIT via CFGM during
1577	* the first init call.
1578	*/
1579
1580	return VINF_SUCCESS;
1581	}
1582
1583
1584	int nemR3NativeInitCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
1585	{
1586	//BOOL fRet = SetThreadPriority(GetCurrentThread(), 0);
1587	//AssertLogRel(fRet);
1588
1589	NOREF(pVM); NOREF(enmWhat);
1590	return VINF_SUCCESS;
1591	}
1592
1593
1594	int nemR3NativeTerm(PVM pVM)
1595	{
1596	/*
1597	* Delete the partition.
1598	*/
1599	WHV_PARTITION_HANDLE hPartition = pVM->nem.s.hPartition;
1600	pVM->nem.s.hPartition = NULL;
1601	pVM->nem.s.hPartitionDevice = NULL;
1602	if (hPartition != NULL)
1603	{
1604	VMCPUID idCpu = pVM->nem.s.fCreatedEmts ? pVM->cCpus : 0;
1605	LogRel(("NEM: Destroying partition %p with its %u VCpus...\n", hPartition, idCpu));
1606	while (idCpu-- > 0)
1607	{
1608	PVMCPU pVCpu = pVM->apCpusR3[idCpu];
1609	pVCpu->nem.s.pvMsgSlotMapping = NULL;
1610	HRESULT hrc = WHvDeleteVirtualProcessor(hPartition, idCpu);
1611	AssertLogRelMsg(SUCCEEDED(hrc), ("WHvDeleteVirtualProcessor(%p, %u) -> %Rhrc (Last=%#x/%u)\n",
1612	hPartition, idCpu, hrc, RTNtLastStatusValue(),
1613	RTNtLastErrorValue()));
1614	}
1615	WHvDeletePartition(hPartition);
1616	}
1617	pVM->nem.s.fCreatedEmts = false;
1618	return VINF_SUCCESS;
1619	}
1620
1621
1622	/**
1623	* VM reset notification.
1624	*
1625	* @param pVM The cross context VM structure.
1626	*/
1627	void nemR3NativeReset(PVM pVM)
1628	{
1629	#if 0
1630	/* Unfix the A20 gate. */
1631	pVM->nem.s.fA20Fixed = false;
1632	#else
1633	RT_NOREF(pVM);
1634	#endif
1635	}
1636
1637
1638	/**
1639	* Reset CPU due to INIT IPI or hot (un)plugging.
1640	*
1641	* @param pVCpu The cross context virtual CPU structure of the CPU being
1642	* reset.
1643	* @param fInitIpi Whether this is the INIT IPI or hot (un)plugging case.
1644	*/
1645	void nemR3NativeResetCpu(PVMCPU pVCpu, bool fInitIpi)
1646	{
1647	#ifdef NEM_WIN_WITH_A20
1648	/* Lock the A20 gate if INIT IPI, make sure it's enabled. */
1649	if (fInitIpi && pVCpu->idCpu > 0)
1650	{
1651	PVM pVM = pVCpu->CTX_SUFF(pVM);
1652	if (!pVM->nem.s.fA20Enabled)
1653	nemR3NativeNotifySetA20(pVCpu, true);
1654	pVM->nem.s.fA20Enabled = true;
1655	pVM->nem.s.fA20Fixed = true;
1656	}
1657	#else
1658	RT_NOREF(pVCpu, fInitIpi);
1659	#endif
1660	}
1661
1662
1663	VBOXSTRICTRC nemR3NativeRunGC(PVM pVM, PVMCPU pVCpu)
1664	{
1665	return nemHCWinRunGC(pVM, pVCpu);
1666	}
1667
1668
1669	VMMR3_INT_DECL(bool) NEMR3CanExecuteGuest(PVM pVM, PVMCPU pVCpu)
1670	{
1671	Assert(VM_IS_NEM_ENABLED(pVM));
1672
1673	#ifndef NEM_WIN_WITH_A20
1674	/*
1675	* Only execute when the A20 gate is enabled because this lovely Hyper-V
1676	* blackbox does not seem to have any way to enable or disable A20.
1677	*/
1678	RT_NOREF(pVM);
1679	return PGMPhysIsA20Enabled(pVCpu);
1680	#else
1681	RT_NOREF(pVM, pVCpu);
1682	return true;
1683	#endif
1684	}
1685
1686
1687	bool nemR3NativeSetSingleInstruction(PVM pVM, PVMCPU pVCpu, bool fEnable)
1688	{
1689	NOREF(pVM); NOREF(pVCpu); NOREF(fEnable);
1690	return false;
1691	}
1692
1693
1694	void nemR3NativeNotifyFF(PVM pVM, PVMCPU pVCpu, uint32_t fFlags)
1695	{
1696	Log8(("nemR3NativeNotifyFF: canceling %u\n", pVCpu->idCpu));
1697	HRESULT hrc = WHvCancelRunVirtualProcessor(pVM->nem.s.hPartition, pVCpu->idCpu, 0);
1698	AssertMsg(SUCCEEDED(hrc), ("WHvCancelRunVirtualProcessor -> hrc=%Rhrc\n", hrc));
1699	RT_NOREF_PV(hrc);
1700	RT_NOREF_PV(fFlags);
1701	}
1702
1703
1704	DECLHIDDEN(bool) nemR3NativeNotifyDebugEventChanged(PVM pVM, bool fUseDebugLoop)
1705	{
1706	RT_NOREF(pVM, fUseDebugLoop);
1707	return false;
1708	}
1709
1710
1711	DECLHIDDEN(bool) nemR3NativeNotifyDebugEventChangedPerCpu(PVM pVM, PVMCPU pVCpu, bool fUseDebugLoop)
1712	{
1713	RT_NOREF(pVM, pVCpu, fUseDebugLoop);
1714	return false;
1715	}
1716
1717
1718	DECLINLINE(int) nemR3NativeGCPhys2R3PtrReadOnly(PVM pVM, RTGCPHYS GCPhys, const void **ppv)
1719	{
1720	PGMPAGEMAPLOCK Lock;
1721	int rc = PGMPhysGCPhys2CCPtrReadOnly(pVM, GCPhys, ppv, &Lock);
1722	if (RT_SUCCESS(rc))
1723	PGMPhysReleasePageMappingLock(pVM, &Lock);
1724	return rc;
1725	}
1726
1727
1728	DECLINLINE(int) nemR3NativeGCPhys2R3PtrWriteable(PVM pVM, RTGCPHYS GCPhys, void **ppv)
1729	{
1730	PGMPAGEMAPLOCK Lock;
1731	int rc = PGMPhysGCPhys2CCPtr(pVM, GCPhys, ppv, &Lock);
1732	if (RT_SUCCESS(rc))
1733	PGMPhysReleasePageMappingLock(pVM, &Lock);
1734	return rc;
1735	}
1736
1737
1738	VMMR3_INT_DECL(int) NEMR3NotifyPhysRamRegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, void *pvR3,
1739	uint8_t pu2State, uint32_t puNemRange)
1740	{
1741	Log5(("NEMR3NotifyPhysRamRegister: %RGp LB %RGp, pvR3=%p pu2State=%p (%d) puNemRange=%p (%d)\n",
1742	GCPhys, cb, pvR3, pu2State, pu2State, puNemRange, *puNemRange));
1743
1744	*pu2State = UINT8_MAX;
1745	RT_NOREF(puNemRange);
1746
1747	if (pvR3)
1748	{
1749	STAM_REL_PROFILE_START(&pVM->nem.s.StatProfMapGpaRange, a);
1750	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, pvR3, GCPhys, cb,
1751	WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagWrite \| WHvMapGpaRangeFlagExecute);
1752	STAM_REL_PROFILE_STOP(&pVM->nem.s.StatProfMapGpaRange, a);
1753	if (SUCCEEDED(hrc))
1754	*pu2State = NEM_WIN_PAGE_STATE_WRITABLE;
1755	else
1756	{
1757	LogRel(("NEMR3NotifyPhysRamRegister: GCPhys=%RGp LB %RGp pvR3=%p hrc=%Rhrc (%#x) Last=%#x/%u\n",
1758	GCPhys, cb, pvR3, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1759	STAM_REL_COUNTER_INC(&pVM->nem.s.StatMapPageFailed);
1760	return VERR_NEM_MAP_PAGES_FAILED;
1761	}
1762	}
1763	return VINF_SUCCESS;
1764	}
1765
1766
1767	VMMR3_INT_DECL(bool) NEMR3IsMmio2DirtyPageTrackingSupported(PVM pVM)
1768	{
1769	RT_NOREF(pVM);
1770	return g_pfnWHvQueryGpaRangeDirtyBitmap != NULL;
1771	}
1772
1773
1774	VMMR3_INT_DECL(int) NEMR3NotifyPhysMmioExMapEarly(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags,
1775	void pvRam, void pvMmio2, uint8_t pu2State, uint32_t puNemRange)
1776	{
1777	Log5(("NEMR3NotifyPhysMmioExMapEarly: %RGp LB %RGp fFlags=%#x pvRam=%p pvMmio2=%p pu2State=%p (%d) puNemRange=%p (%#x)\n",
1778	GCPhys, cb, fFlags, pvRam, pvMmio2, pu2State, pu2State, puNemRange, puNemRange ? puNemRange : UINT32_MAX));
1779	RT_NOREF(puNemRange);
1780
1781	/*
1782	* Unmap the RAM we're replacing.
1783	*/
1784	if (fFlags & NEM_NOTIFY_PHYS_MMIO_EX_F_REPLACE)
1785	{
1786	STAM_REL_PROFILE_START(&pVM->nem.s.StatProfUnmapGpaRange, a);
1787	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, cb);
1788	STAM_REL_PROFILE_STOP(&pVM->nem.s.StatProfUnmapGpaRange, a);
1789	if (SUCCEEDED(hrc))
1790	{ /* likely */ }
1791	else if (pvMmio2)
1792	LogRel(("NEMR3NotifyPhysMmioExMapEarly: GCPhys=%RGp LB %RGp fFlags=%#x: Unmap -> hrc=%Rhrc (%#x) Last=%#x/%u (ignored)\n",
1793	GCPhys, cb, fFlags, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1794	else
1795	{
1796	LogRel(("NEMR3NotifyPhysMmioExMapEarly: GCPhys=%RGp LB %RGp fFlags=%#x: Unmap -> hrc=%Rhrc (%#x) Last=%#x/%u\n",
1797	GCPhys, cb, fFlags, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1798	STAM_REL_COUNTER_INC(&pVM->nem.s.StatUnmapPageFailed);
1799	return VERR_NEM_UNMAP_PAGES_FAILED;
1800	}
1801	}
1802
1803	/*
1804	* Map MMIO2 if any.
1805	*/
1806	if (pvMmio2)
1807	{
1808	Assert(fFlags & NEM_NOTIFY_PHYS_MMIO_EX_F_MMIO2);
1809	WHV_MAP_GPA_RANGE_FLAGS fWHvFlags = WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagWrite \| WHvMapGpaRangeFlagExecute;
1810	if ((fFlags & NEM_NOTIFY_PHYS_MMIO_EX_F_TRACK_DIRTY_PAGES) && g_pfnWHvQueryGpaRangeDirtyBitmap)
1811	fWHvFlags \|= WHvMapGpaRangeFlagTrackDirtyPages;
1812	STAM_REL_PROFILE_START(&pVM->nem.s.StatProfMapGpaRange, a);
1813	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, pvMmio2, GCPhys, cb, fWHvFlags);
1814	STAM_REL_PROFILE_STOP(&pVM->nem.s.StatProfMapGpaRange, a);
1815	if (SUCCEEDED(hrc))
1816	*pu2State = NEM_WIN_PAGE_STATE_WRITABLE;
1817	else
1818	{
1819	LogRel(("NEMR3NotifyPhysMmioExMapEarly: GCPhys=%RGp LB %RGp fFlags=%#x pvMmio2=%p fWHvFlags=%#x: Map -> hrc=%Rhrc (%#x) Last=%#x/%u\n",
1820	GCPhys, cb, fFlags, pvMmio2, fWHvFlags, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1821	STAM_REL_COUNTER_INC(&pVM->nem.s.StatMapPageFailed);
1822	return VERR_NEM_MAP_PAGES_FAILED;
1823	}
1824	}
1825	else
1826	{
1827	Assert(!(fFlags & NEM_NOTIFY_PHYS_MMIO_EX_F_MMIO2));
1828	*pu2State = NEM_WIN_PAGE_STATE_UNMAPPED;
1829	}
1830	RT_NOREF(pvRam);
1831	return VINF_SUCCESS;
1832	}
1833
1834
1835	VMMR3_INT_DECL(int) NEMR3NotifyPhysMmioExMapLate(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags,
1836	void pvRam, void pvMmio2, uint32_t *puNemRange)
1837	{
1838	RT_NOREF(pVM, GCPhys, cb, fFlags, pvRam, pvMmio2, puNemRange);
1839	return VINF_SUCCESS;
1840	}
1841
1842
1843	VMMR3_INT_DECL(int) NEMR3NotifyPhysMmioExUnmap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags, void *pvRam,
1844	void pvMmio2, uint8_t pu2State, uint32_t *puNemRange)
1845	{
1846	int rc = VINF_SUCCESS;
1847	Log5(("NEMR3NotifyPhysMmioExUnmap: %RGp LB %RGp fFlags=%#x pvRam=%p pvMmio2=%p pu2State=%p uNemRange=%#x (%#x)\n",
1848	GCPhys, cb, fFlags, pvRam, pvMmio2, pu2State, puNemRange, *puNemRange));
1849
1850	/*
1851	* Unmap the MMIO2 pages.
1852	*/
1853	/** @todo If we implement aliasing (MMIO2 page aliased into MMIO range),
1854	* we may have more stuff to unmap even in case of pure MMIO... */
1855	if (fFlags & NEM_NOTIFY_PHYS_MMIO_EX_F_MMIO2)
1856	{
1857	STAM_REL_PROFILE_START(&pVM->nem.s.StatProfUnmapGpaRange, a);
1858	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, cb);
1859	STAM_REL_PROFILE_STOP(&pVM->nem.s.StatProfUnmapGpaRange, a);
1860	if (FAILED(hrc))
1861	{
1862	LogRel2(("NEMR3NotifyPhysMmioExUnmap: GCPhys=%RGp LB %RGp fFlags=%#x: Unmap -> hrc=%Rhrc (%#x) Last=%#x/%u (ignored)\n",
1863	GCPhys, cb, fFlags, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1864	rc = VERR_NEM_UNMAP_PAGES_FAILED;
1865	STAM_REL_COUNTER_INC(&pVM->nem.s.StatUnmapPageFailed);
1866	}
1867	}
1868
1869	/*
1870	* Restore the RAM we replaced.
1871	*/
1872	if (fFlags & NEM_NOTIFY_PHYS_MMIO_EX_F_REPLACE)
1873	{
1874	AssertPtr(pvRam);
1875	STAM_REL_PROFILE_START(&pVM->nem.s.StatProfMapGpaRange, a);
1876	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, pvRam, GCPhys, cb,
1877	WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagWrite \| WHvMapGpaRangeFlagExecute);
1878	STAM_REL_PROFILE_STOP(&pVM->nem.s.StatProfMapGpaRange, a);
1879	if (SUCCEEDED(hrc))
1880	{ /* likely */ }
1881	else
1882	{
1883	LogRel(("NEMR3NotifyPhysMmioExUnmap: GCPhys=%RGp LB %RGp pvMmio2=%p hrc=%Rhrc (%#x) Last=%#x/%u\n",
1884	GCPhys, cb, pvMmio2, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1885	rc = VERR_NEM_MAP_PAGES_FAILED;
1886	STAM_REL_COUNTER_INC(&pVM->nem.s.StatMapPageFailed);
1887	}
1888	if (pu2State)
1889	*pu2State = NEM_WIN_PAGE_STATE_WRITABLE;
1890	}
1891	/* Mark the pages as unmapped if relevant. */
1892	else if (pu2State)
1893	*pu2State = NEM_WIN_PAGE_STATE_UNMAPPED;
1894
1895	RT_NOREF(pvMmio2, puNemRange);
1896	return rc;
1897	}
1898
1899
1900	VMMR3_INT_DECL(int) NEMR3PhysMmio2QueryAndResetDirtyBitmap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t uNemRange,
1901	void *pvBitmap, size_t cbBitmap)
1902	{
1903	Assert(VM_IS_NEM_ENABLED(pVM));
1904	AssertReturn(g_pfnWHvQueryGpaRangeDirtyBitmap, VERR_INTERNAL_ERROR_2);
1905	Assert(cbBitmap == (uint32_t)cbBitmap);
1906	RT_NOREF(uNemRange);
1907
1908	/* This is being profiled by PGM, see /PGM/Mmio2QueryAndResetDirtyBitmap. */
1909	HRESULT hrc = WHvQueryGpaRangeDirtyBitmap(pVM->nem.s.hPartition, GCPhys, cb, (UINT64 *)pvBitmap, (uint32_t)cbBitmap);
1910	if (SUCCEEDED(hrc))
1911	return VINF_SUCCESS;
1912
1913	AssertLogRelMsgFailed(("GCPhys=%RGp LB %RGp pvBitmap=%p LB %#zx hrc=%Rhrc (%#x) Last=%#x/%u\n",
1914	GCPhys, cb, pvBitmap, cbBitmap, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1915	return VERR_NEM_QUERY_DIRTY_BITMAP_FAILED;
1916	}
1917
1918
1919	VMMR3_INT_DECL(int) NEMR3NotifyPhysRomRegisterEarly(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, void *pvPages, uint32_t fFlags,
1920	uint8_t pu2State, uint32_t puNemRange)
1921	{
1922	Log5(("nemR3NativeNotifyPhysRomRegisterEarly: %RGp LB %RGp pvPages=%p fFlags=%#x\n", GCPhys, cb, pvPages, fFlags));
1923	*pu2State = UINT8_MAX;
1924	*puNemRange = 0;
1925
1926	#if 0 /* Let's not do this after all. We'll protection change notifications for each page and if not we'll map them lazily. */
1927	RTGCPHYS const cPages = cb >> X86_PAGE_SHIFT;
1928	for (RTGCPHYS iPage = 0; iPage < cPages; iPage++, GCPhys += X86_PAGE_SIZE)
1929	{
1930	const void *pvPage;
1931	int rc = nemR3NativeGCPhys2R3PtrReadOnly(pVM, GCPhys, &pvPage);
1932	if (RT_SUCCESS(rc))
1933	{
1934	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, (void *)pvPage, GCPhys, X86_PAGE_SIZE,
1935	WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagExecute);
1936	if (SUCCEEDED(hrc))
1937	{ /* likely */ }
1938	else
1939	{
1940	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp hrc=%Rhrc (%#x) Last=%#x/%u\n",
1941	GCPhys, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1942	return VERR_NEM_INIT_FAILED;
1943	}
1944	}
1945	else
1946	{
1947	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp rc=%Rrc\n", GCPhys, rc));
1948	return rc;
1949	}
1950	}
1951	RT_NOREF_PV(fFlags);
1952	#else
1953	RT_NOREF(pVM, GCPhys, cb, pvPages, fFlags);
1954	#endif
1955	return VINF_SUCCESS;
1956	}
1957
1958
1959	VMMR3_INT_DECL(int) NEMR3NotifyPhysRomRegisterLate(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, void *pvPages,
1960	uint32_t fFlags, uint8_t pu2State, uint32_t puNemRange)
1961	{
1962	Log5(("nemR3NativeNotifyPhysRomRegisterLate: %RGp LB %RGp pvPages=%p fFlags=%#x pu2State=%p (%d) puNemRange=%p (%#x)\n",
1963	GCPhys, cb, pvPages, fFlags, pu2State, pu2State, puNemRange, puNemRange));
1964	*pu2State = UINT8_MAX;
1965
1966	/*
1967	* (Re-)map readonly.
1968	*/
1969	AssertPtrReturn(pvPages, VERR_INVALID_POINTER);
1970	STAM_REL_PROFILE_START(&pVM->nem.s.StatProfMapGpaRange, a);
1971	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, pvPages, GCPhys, cb, WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagExecute);
1972	STAM_REL_PROFILE_STOP(&pVM->nem.s.StatProfMapGpaRange, a);
1973	if (SUCCEEDED(hrc))
1974	*pu2State = NEM_WIN_PAGE_STATE_READABLE;
1975	else
1976	{
1977	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp LB %RGp pvPages=%p fFlags=%#x hrc=%Rhrc (%#x) Last=%#x/%u\n",
1978	GCPhys, cb, pvPages, fFlags, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
1979	STAM_REL_COUNTER_INC(&pVM->nem.s.StatMapPageFailed);
1980	return VERR_NEM_MAP_PAGES_FAILED;
1981	}
1982	RT_NOREF(fFlags, puNemRange);
1983	return VINF_SUCCESS;
1984	}
1985
1986	#ifdef NEM_WIN_WITH_A20
1987
1988	/**
1989	* @callback_method_impl{FNPGMPHYSNEMCHECKPAGE}
1990	*/
1991	static DECLCALLBACK(int) nemR3WinUnsetForA20CheckerCallback(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys,
1992	PPGMPHYSNEMPAGEINFO pInfo, void *pvUser)
1993	{
1994	/* We'll just unmap the memory. */
1995	if (pInfo->u2NemState > NEM_WIN_PAGE_STATE_UNMAPPED)
1996	{
1997	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, X86_PAGE_SIZE);
1998	if (SUCCEEDED(hrc))
1999	{
2000	STAM_REL_COUNTER_INC(&pVM->nem.s.StatUnmapPage);
2001	uint32_t cMappedPages = ASMAtomicDecU32(&pVM->nem.s.cMappedPages); NOREF(cMappedPages);
2002	Log5(("NEM GPA unmapped/A20: %RGp (was %s, cMappedPages=%u)\n", GCPhys, g_apszPageStates[pInfo->u2NemState], cMappedPages));
2003	pInfo->u2NemState = NEM_WIN_PAGE_STATE_UNMAPPED;
2004	}
2005	else
2006	{
2007	STAM_REL_COUNTER_INC(&pVM->nem.s.StatUnmapPageFailed);
2008	LogRel(("nemR3WinUnsetForA20CheckerCallback/unmap: GCPhys=%RGp hrc=%Rhrc (%#x) Last=%#x/%u\n",
2009	GCPhys, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
2010	return VERR_INTERNAL_ERROR_2;
2011	}
2012	}
2013	RT_NOREF(pVCpu, pvUser);
2014	return VINF_SUCCESS;
2015	}
2016
2017
2018	/**
2019	* Unmaps a page from Hyper-V for the purpose of emulating A20 gate behavior.
2020	*
2021	* @returns The PGMPhysNemQueryPageInfo result.
2022	* @param pVM The cross context VM structure.
2023	* @param pVCpu The cross context virtual CPU structure.
2024	* @param GCPhys The page to unmap.
2025	*/
2026	static int nemR3WinUnmapPageForA20Gate(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys)
2027	{
2028	PGMPHYSNEMPAGEINFO Info;
2029	return PGMPhysNemPageInfoChecker(pVM, pVCpu, GCPhys, false /fMakeWritable/, &Info,
2030	nemR3WinUnsetForA20CheckerCallback, NULL);
2031	}
2032
2033	#endif /* NEM_WIN_WITH_A20 */
2034
2035	VMMR3_INT_DECL(void) NEMR3NotifySetA20(PVMCPU pVCpu, bool fEnabled)
2036	{
2037	Log(("nemR3NativeNotifySetA20: fEnabled=%RTbool\n", fEnabled));
2038	Assert(VM_IS_NEM_ENABLED(pVCpu->CTX_SUFF(pVM)));
2039	#ifdef NEM_WIN_WITH_A20
2040	PVM pVM = pVCpu->CTX_SUFF(pVM);
2041	if (!pVM->nem.s.fA20Fixed)
2042	{
2043	pVM->nem.s.fA20Enabled = fEnabled;
2044	for (RTGCPHYS GCPhys = _1M; GCPhys < _1M + _64K; GCPhys += X86_PAGE_SIZE)
2045	nemR3WinUnmapPageForA20Gate(pVM, pVCpu, GCPhys);
2046	}
2047	#else
2048	RT_NOREF(pVCpu, fEnabled);
2049	#endif
2050	}
2051
2052
2053	/** @page pg_nem_win NEM/win - Native Execution Manager, Windows.
2054	*
2055	* On Windows the Hyper-V root partition (dom0 in zen terminology) does not have
2056	* nested VT-x or AMD-V capabilities. Early on raw-mode worked inside it, but
2057	* for a while now we've been getting \#GPs when trying to modify CR4 in the
2058	* world switcher. So, when Hyper-V is active on Windows we have little choice
2059	* but to use Hyper-V to run our VMs.
2060	*
2061	*
2062	* @section sub_nem_win_whv The WinHvPlatform API
2063	*
2064	* Since Windows 10 build 17083 there is a documented API for managing Hyper-V
2065	* VMs: header file WinHvPlatform.h and implementation in WinHvPlatform.dll.
2066	* This interface is a wrapper around the undocumented Virtualization
2067	* Infrastructure Driver (VID) API - VID.DLL and VID.SYS. The wrapper is
2068	* written in C++, namespaced, early versions (at least) was using standard C++
2069	* container templates in several places.
2070	*
2071	* When creating a VM using WHvCreatePartition, it will only create the
2072	* WinHvPlatform structures for it, to which you get an abstract pointer. The
2073	* VID API that actually creates the partition is first engaged when you call
2074	* WHvSetupPartition after first setting a lot of properties using
2075	* WHvSetPartitionProperty. Since the VID API is just a very thin wrapper
2076	* around CreateFile and NtDeviceIoControlFile, it returns an actual HANDLE for
2077	* the partition to WinHvPlatform. We fish this HANDLE out of the WinHvPlatform
2078	* partition structures because we need to talk directly to VID for reasons
2079	* we'll get to in a bit. (Btw. we could also intercept the CreateFileW or
2080	* NtDeviceIoControlFile calls from VID.DLL to get the HANDLE should fishing in
2081	* the partition structures become difficult.)
2082	*
2083	* The WinHvPlatform API requires us to both set the number of guest CPUs before
2084	* setting up the partition and call WHvCreateVirtualProcessor for each of them.
2085	* The CPU creation function boils down to a VidMessageSlotMap call that sets up
2086	* and maps a message buffer into ring-3 for async communication with hyper-V
2087	* and/or the VID.SYS thread actually running the CPU thru
2088	* WinHvRunVpDispatchLoop(). When for instance a VMEXIT is encountered, hyper-V
2089	* sends a message that the WHvRunVirtualProcessor API retrieves (and later
2090	* acknowledges) via VidMessageSlotHandleAndGetNext. Since or about build
2091	* 17757 a register page is also mapped into user space when creating the
2092	* virtual CPU. It should be noteded that WHvDeleteVirtualProcessor doesn't do
2093	* much as there seems to be no partner function VidMessagesSlotMap that
2094	* reverses what it did.
2095	*
2096	* Memory is managed thru calls to WHvMapGpaRange and WHvUnmapGpaRange (GPA does
2097	* not mean grade point average here, but rather guest physical addressspace),
2098	* which corresponds to VidCreateVaGpaRangeSpecifyUserVa and VidDestroyGpaRange
2099	* respectively. As 'UserVa' indicates, the functions works on user process
2100	* memory. The mappings are also subject to quota restrictions, so the number
2101	* of ranges are limited and probably their total size as well. Obviously
2102	* VID.SYS keeps track of the ranges, but so does WinHvPlatform, which means
2103	* there is a bit of overhead involved and quota restrctions makes sense.
2104	*
2105	* Running guest code is done through the WHvRunVirtualProcessor function. It
2106	* asynchronously starts or resumes hyper-V CPU execution and then waits for an
2107	* VMEXIT message. Hyper-V / VID.SYS will return information about the message
2108	* in the message buffer mapping, and WHvRunVirtualProcessor will convert that
2109	* finto it's own WHV_RUN_VP_EXIT_CONTEXT format.
2110	*
2111	* Other threads can interrupt the execution by using WHvCancelVirtualProcessor,
2112	* which since or about build 17757 uses VidMessageSlotHandleAndGetNext to do
2113	* the work (earlier builds would open the waiting thread, do a dummy
2114	* QueueUserAPC on it, and let it upon return use VidStopVirtualProcessor to
2115	* do the actual stopping). While there is certainly a race between cancelation
2116	* and the CPU causing a natural VMEXIT, it is not known whether this still
2117	* causes extra work on subsequent WHvRunVirtualProcessor calls (it did in and
2118	* earlier than 17134).
2119	*
2120	* Registers are retrieved and set via WHvGetVirtualProcessorRegisters and
2121	* WHvSetVirtualProcessorRegisters. In addition, several VMEXITs include
2122	* essential register state in the exit context information, potentially making
2123	* it possible to emulate the instruction causing the exit without involving
2124	* WHvGetVirtualProcessorRegisters.
2125	*
2126	*
2127	* @subsection subsec_nem_win_whv_cons Issues & Feedback
2128	*
2129	* Here are some observations (mostly against build 17101):
2130	*
2131	* - The VMEXIT performance is dismal (build 17134).
2132	*
2133	* Our proof of concept implementation with a kernel runloop (i.e. not using
2134	* WHvRunVirtualProcessor and friends, but calling VID.SYS fast I/O control
2135	* entry point directly) delivers 9-10% of the port I/O performance and only
2136	* 6-7% of the MMIO performance that we have with our own hypervisor.
2137	*
2138	* When using the offical WinHvPlatform API, the numbers are %3 for port I/O
2139	* and 5% for MMIO.
2140	*
2141	* While the tests we've done are using tight tight loops only doing port I/O
2142	* and MMIO, the problem is clearly visible when running regular guest OSes.
2143	* Anything that hammers the VGA device would be suffering, for example:
2144	*
2145	* - Windows 2000 boot screen animation overloads us with MMIO exits
2146	* and won't even boot because all the time is spent in interrupt
2147	* handlers and redrawin the screen.
2148	*
2149	* - DSL 4.4 and its bootmenu logo is slower than molasses in january.
2150	*
2151	* We have not found a workaround for this yet.
2152	*
2153	* Something that might improve the issue a little is to detect blocks with
2154	* excessive MMIO and port I/O exits and emulate instructions to cover
2155	* multiple exits before letting Hyper-V have a go at the guest execution
2156	* again. This will only improve the situation under some circumstances,
2157	* since emulating instructions without recompilation can be expensive, so
2158	* there will only be real gains if the exitting instructions are tightly
2159	* packed.
2160	*
2161	* Update: Security fixes during the summer of 2018 caused the performance to
2162	* dropped even more.
2163	*
2164	* Update [build 17757]: Some performance improvements here, but they don't
2165	* yet make up for what was lost this summer.
2166	*
2167	*
2168	* - We need a way to directly modify the TSC offset (or bias if you like).
2169	*
2170	* The current approach of setting the WHvX64RegisterTsc register one by one
2171	* on each virtual CPU in sequence will introduce random inaccuracies,
2172	* especially if the thread doing the job is reschduled at a bad time.
2173	*
2174	*
2175	* - Unable to access WHvX64RegisterMsrMtrrCap (build 17134).
2176	*
2177	*
2178	* - On AMD Ryzen grub/debian 9.0 ends up with a unrecoverable exception
2179	* when IA32_MTRR_PHYSMASK0 is written.
2180	*
2181	*
2182	* - The IA32_APIC_BASE register does not work right:
2183	*
2184	* - Attempts by the guest to clear bit 11 (EN) are ignored, both the
2185	* guest and the VMM reads back the old value.
2186	*
2187	* - Attempts to modify the base address (bits NN:12) seems to be ignored
2188	* in the same way.
2189	*
2190	* - The VMM can modify both the base address as well as the the EN and
2191	* BSP bits, however this is useless if we cannot intercept the WRMSR.
2192	*
2193	* - Attempts by the guest to set the EXTD bit (X2APIC) result in \#GP(0),
2194	* while the VMM ends up with with ERROR_HV_INVALID_PARAMETER. Seems
2195	* there is no way to support X2APIC.
2196	*
2197	*
2198	* - Not sure if this is a thing, but WHvCancelVirtualProcessor seems to cause
2199	* cause a lot more spurious WHvRunVirtualProcessor returns that what we get
2200	* with the replacement code. By spurious returns we mean that the
2201	* subsequent call to WHvRunVirtualProcessor would return immediately.
2202	*
2203	* Update [build 17757]: New cancelation code might have addressed this, but
2204	* haven't had time to test it yet.
2205	*
2206	*
2207	* - There is no API for modifying protection of a page within a GPA range.
2208	*
2209	* From what we can tell, the only way to modify the protection (like readonly
2210	* -> writable, or vice versa) is to first unmap the range and then remap it
2211	* with the new protection.
2212	*
2213	* We are for instance doing this quite a bit in order to track dirty VRAM
2214	* pages. VRAM pages starts out as readonly, when the guest writes to a page
2215	* we take an exit, notes down which page it is, makes it writable and restart
2216	* the instruction. After refreshing the display, we reset all the writable
2217	* pages to readonly again, bulk fashion.
2218	*
2219	* Now to work around this issue, we do page sized GPA ranges. In addition to
2220	* add a lot of tracking overhead to WinHvPlatform and VID.SYS, this also
2221	* causes us to exceed our quota before we've even mapped a default sized
2222	* (128MB) VRAM page-by-page. So, to work around this quota issue we have to
2223	* lazily map pages and actively restrict the number of mappings.
2224	*
2225	* Our best workaround thus far is bypassing WinHvPlatform and VID entirely
2226	* when in comes to guest memory management and instead use the underlying
2227	* hypercalls (HvCallMapGpaPages, HvCallUnmapGpaPages) to do it ourselves.
2228	* (This also maps a whole lot better into our own guest page management
2229	* infrastructure.)
2230	*
2231	* Update [build 17757]: Introduces a KVM like dirty logging API which could
2232	* help tracking dirty VGA pages, while being useless for shadow ROM and
2233	* devices trying catch the guest updating descriptors and such.
2234	*
2235	*
2236	* - Observed problems doing WHvUnmapGpaRange immediately followed by
2237	* WHvMapGpaRange.
2238	*
2239	* As mentioned above, we've been forced to use this sequence when modifying
2240	* page protection. However, when transitioning from readonly to writable,
2241	* we've ended up looping forever with the same write to readonly memory
2242	* VMEXIT. We're wondering if this issue might be related to the lazy mapping
2243	* logic in WinHvPlatform.
2244	*
2245	* Workaround: Insert a WHvRunVirtualProcessor call and make sure to get a GPA
2246	* unmapped exit between the two calls. Not entirely great performance wise
2247	* (or the santity of our code).
2248	*
2249	*
2250	* - Implementing A20 gate behavior is tedious, where as correctly emulating the
2251	* A20M# pin (present on 486 and later) is near impossible for SMP setups
2252	* (e.g. possiblity of two CPUs with different A20 status).
2253	*
2254	* Workaround #1 (obsolete): Only do A20 on CPU 0, restricting the emulation
2255	* to HMA. We unmap all pages related to HMA (0x100000..0x10ffff) when the A20
2256	* state changes, lazily syncing the right pages back when accessed.
2257	*
2258	* Workaround #2 (used): Use IEM when the A20 gate is disabled.
2259	*
2260	*
2261	* - WHVRunVirtualProcessor wastes time converting VID/Hyper-V messages to its
2262	* own format (WHV_RUN_VP_EXIT_CONTEXT).
2263	*
2264	* We understand this might be because Microsoft wishes to remain free to
2265	* modify the VID/Hyper-V messages, but it's still rather silly and does slow
2266	* things down a little. We'd much rather just process the messages directly.
2267	*
2268	*
2269	* - WHVRunVirtualProcessor would've benefited from using a callback interface:
2270	*
2271	* - The potential size changes of the exit context structure wouldn't be
2272	* an issue, since the function could manage that itself.
2273	*
2274	* - State handling could probably be simplified (like cancelation).
2275	*
2276	*
2277	* - WHvGetVirtualProcessorRegisters and WHvSetVirtualProcessorRegisters
2278	* internally converts register names, probably using temporary heap buffers.
2279	*
2280	* From the looks of things, they are converting from WHV_REGISTER_NAME to
2281	* HV_REGISTER_NAME from in the "Virtual Processor Register Names" section in
2282	* the "Hypervisor Top-Level Functional Specification" document. This feels
2283	* like an awful waste of time.
2284	*
2285	* We simply cannot understand why HV_REGISTER_NAME isn't used directly here,
2286	* or at least the same values, making any conversion reduntant. Restricting
2287	* access to certain registers could easily be implement by scanning the
2288	* inputs.
2289	*
2290	* To avoid the heap + conversion overhead, we're currently using the
2291	* HvCallGetVpRegisters and HvCallSetVpRegisters calls directly, at least for
2292	* the ring-0 code.
2293	*
2294	* Update [build 17757]: Register translation has been very cleverly
2295	* optimized and made table driven (2 top level tables, 4 + 1 leaf tables).
2296	* Register information consists of the 32-bit HV register name, register page
2297	* offset, and flags (giving valid offset, size and more). Register
2298	* getting/settings seems to be done by hoping that the register page provides
2299	* it all, and falling back on the VidSetVirtualProcessorState if one or more
2300	* registers are not available there.
2301	*
2302	* Note! We have currently not updated our ring-0 code to take the register
2303	* page into account, so it's suffering a little compared to the ring-3 code
2304	* that now uses the offical APIs for registers.
2305	*
2306	*
2307	* - The YMM and XCR0 registers are not yet named (17083). This probably
2308	* wouldn't be a problem if HV_REGISTER_NAME was used, see previous point.
2309	*
2310	* Update [build 17757]: XCR0 is added. YMM register values seems to be put
2311	* into a yet undocumented XsaveState interface. Approach is a little bulky,
2312	* but saves number of enums and dispenses with register transation. Also,
2313	* the underlying Vid setter API duplicates the input buffer on the heap,
2314	* adding a 16 byte header.
2315	*
2316	*
2317	* - Why does VID.SYS only query/set 32 registers at the time thru the
2318	* HvCallGetVpRegisters and HvCallSetVpRegisters hypercalls?
2319	*
2320	* We've not trouble getting/setting all the registers defined by
2321	* WHV_REGISTER_NAME in one hypercall (around 80). Some kind of stack
2322	* buffering or similar?
2323	*
2324	*
2325	* - To handle the VMMCALL / VMCALL instructions, it seems we need to intercept
2326	* \#UD exceptions and inspect the opcodes. A dedicated exit for hypercalls
2327	* would be more efficient, esp. for guests using \#UD for other purposes..
2328	*
2329	*
2330	* - Wrong instruction length in the VpContext with unmapped GPA memory exit
2331	* contexts on 17115/AMD.
2332	*
2333	* One byte "PUSH CS" was reported as 2 bytes, while a two byte
2334	* "MOV [EBX],EAX" was reported with a 1 byte instruction length. Problem
2335	* naturally present in untranslated hyper-v messages.
2336	*
2337	*
2338	* - The I/O port exit context information seems to be missing the address size
2339	* information needed for correct string I/O emulation.
2340	*
2341	* VT-x provides this information in bits 7:9 in the instruction information
2342	* field on newer CPUs. AMD-V in bits 7:9 in the EXITINFO1 field in the VMCB.
2343	*
2344	* We can probably work around this by scanning the instruction bytes for
2345	* address size prefixes. Haven't investigated it any further yet.
2346	*
2347	*
2348	* - Querying WHvCapabilityCodeExceptionExitBitmap returns zero even when
2349	* intercepts demonstrably works (17134).
2350	*
2351	*
2352	* - Querying HvPartitionPropertyDebugChannelId via HvCallGetPartitionProperty
2353	* (hypercall) hangs the host (17134).
2354	*
2355	* - CommonUtilities::GuidToString needs a 'static' before the hex digit array,
2356	* looks pointless to re-init a stack copy it for each call (novice mistake).
2357	*
2358	*
2359	* Old concerns that have been addressed:
2360	*
2361	* - The WHvCancelVirtualProcessor API schedules a dummy usermode APC callback
2362	* in order to cancel any current or future alertable wait in VID.SYS during
2363	* the VidMessageSlotHandleAndGetNext call.
2364	*
2365	* IIRC this will make the kernel schedule the specified callback thru
2366	* NTDLL!KiUserApcDispatcher by modifying the thread context and quite
2367	* possibly the userland thread stack. When the APC callback returns to
2368	* KiUserApcDispatcher, it will call NtContinue to restore the old thread
2369	* context and resume execution from there. This naturally adds up to some
2370	* CPU cycles, ring transitions aren't for free, especially after Spectre &
2371	* Meltdown mitigations.
2372	*
2373	* Using NtAltertThread call could do the same without the thread context
2374	* modifications and the extra kernel call.
2375	*
2376	* Update: All concerns have addressed in or about build 17757.
2377	*
2378	* The WHvCancelVirtualProcessor API is now implemented using a new
2379	* VidMessageSlotHandleAndGetNext() flag (4). Codepath is slightly longer
2380	* than NtAlertThread, but has the added benefit that spurious wakeups can be
2381	* more easily reduced.
2382	*
2383	*
2384	* - When WHvRunVirtualProcessor returns without a message, or on a terse
2385	* VID message like HLT, it will make a kernel call to get some registers.
2386	* This is potentially inefficient if the caller decides he needs more
2387	* register state.
2388	*
2389	* It would be better to just return what's available and let the caller fetch
2390	* what is missing from his point of view in a single kernel call.
2391	*
2392	* Update: All concerns have been addressed in or about build 17757. Selected
2393	* registers are now available via shared memory and thus HLT should (not
2394	* verified) no longer require a system call to compose the exit context data.
2395	*
2396	*
2397	* - The WHvRunVirtualProcessor implementation does lazy GPA range mappings when
2398	* a unmapped GPA message is received from hyper-V.
2399	*
2400	* Since MMIO is currently realized as unmapped GPA, this will slow down all
2401	* MMIO accesses a tiny little bit as WHvRunVirtualProcessor looks up the
2402	* guest physical address to check if it is a pending lazy mapping.
2403	*
2404	* The lazy mapping feature makes no sense to us. We as API user have all the
2405	* information and can do lazy mapping ourselves if we want/have to (see next
2406	* point).
2407	*
2408	* Update: All concerns have been addressed in or about build 17757.
2409	*
2410	*
2411	* - The WHvGetCapability function has a weird design:
2412	* - The CapabilityCode parameter is pointlessly duplicated in the output
2413	* structure (WHV_CAPABILITY).
2414	*
2415	* - API takes void pointer, but everyone will probably be using
2416	* WHV_CAPABILITY due to WHV_CAPABILITY::CapabilityCode making it
2417	* impractical to use anything else.
2418	*
2419	* - No output size.
2420	*
2421	* - See GetFileAttributesEx, GetFileInformationByHandleEx,
2422	* FindFirstFileEx, and others for typical pattern for generic
2423	* information getters.
2424	*
2425	* Update: All concerns have been addressed in build 17110.
2426	*
2427	*
2428	* - The WHvGetPartitionProperty function uses the same weird design as
2429	* WHvGetCapability, see above.
2430	*
2431	* Update: All concerns have been addressed in build 17110.
2432	*
2433	*
2434	* - The WHvSetPartitionProperty function has a totally weird design too:
2435	* - In contrast to its partner WHvGetPartitionProperty, the property code
2436	* is not a separate input parameter here but part of the input
2437	* structure.
2438	*
2439	* - The input structure is a void pointer rather than a pointer to
2440	* WHV_PARTITION_PROPERTY which everyone probably will be using because
2441	* of the WHV_PARTITION_PROPERTY::PropertyCode field.
2442	*
2443	* - Really, why use PVOID for the input when the function isn't accepting
2444	* minimal sizes. E.g. WHVPartitionPropertyCodeProcessorClFlushSize only
2445	* requires a 9 byte input, but the function insists on 16 bytes (17083).
2446	*
2447	* - See GetFileAttributesEx, SetFileInformationByHandle, FindFirstFileEx,
2448	* and others for typical pattern for generic information setters and
2449	* getters.
2450	*
2451	* Update: All concerns have been addressed in build 17110.
2452	*
2453	*
2454	* @section sec_nem_win_large_pages Large Pages
2455	*
2456	* We've got a standalone memory allocation and access testcase bs3-memalloc-1
2457	* which was run with 48GiB of guest RAM configured on a NUC 11 box running
2458	* Windows 11 GA. In the simplified NEM memory mode no exits should be
2459	* generated while the access tests are running.
2460	*
2461	* The bs3-memalloc-1 results kind of hints at some tiny speed-up if the guest
2462	* RAM is allocated using the MEM_LARGE_PAGES flag, but only in the 3rd access
2463	* check (typical 350 000 MiB/s w/o and around 400 000 MiB/s). The result for
2464	* the 2nd access varies a lot, perhaps hinting at some table optimizations
2465	* going on.
2466	*
2467	* The initial access where the memory is locked/whatever has absolutely horrid
2468	* results regardless of whether large pages are enabled or not. Typically
2469	* bobbing close to 500 MiB/s, non-large pages a little faster.
2470	*
2471	* NEM w/ simplified memory and MEM_LARGE_PAGES:
2472	* @verbatim
2473	bs3-memalloc-1: TESTING...
2474	bs3-memalloc-1: #0/0x0: 0x0000000000000000 LB 0x000000000009fc00 USABLE (1)
2475	bs3-memalloc-1: #1/0x1: 0x000000000009fc00 LB 0x0000000000000400 RESERVED (2)
2476	bs3-memalloc-1: #2/0x2: 0x00000000000f0000 LB 0x0000000000010000 RESERVED (2)
2477	bs3-memalloc-1: #3/0x3: 0x0000000000100000 LB 0x00000000dfef0000 USABLE (1)
2478	bs3-memalloc-1: #4/0x4: 0x00000000dfff0000 LB 0x0000000000010000 ACPI_RECLAIMABLE (3)
2479	bs3-memalloc-1: #5/0x5: 0x00000000fec00000 LB 0x0000000000001000 RESERVED (2)
2480	bs3-memalloc-1: #6/0x6: 0x00000000fee00000 LB 0x0000000000001000 RESERVED (2)
2481	bs3-memalloc-1: #7/0x7: 0x00000000fffc0000 LB 0x0000000000040000 RESERVED (2)
2482	bs3-memalloc-1: #8/0x9: 0x0000000100000000 LB 0x0000000b20000000 USABLE (1)
2483	bs3-memalloc-1: Found 1 interesting entries covering 0xb20000000 bytes (44 GB).
2484	bs3-memalloc-1: From 0x100000000 to 0xc20000000
2485	bs3-memalloc-1: INT15h/E820 : PASSED
2486	bs3-memalloc-1: Mapping memory above 4GB : PASSED
2487	bs3-memalloc-1: Pages : 11 665 408 pages
2488	bs3-memalloc-1: MiBs : 45 568 MB
2489	bs3-memalloc-1: Alloc elapsed : 90 925 263 996 ns
2490	bs3-memalloc-1: Alloc elapsed in ticks : 272 340 387 336 ticks
2491	bs3-memalloc-1: Page alloc time : 7 794 ns/page
2492	bs3-memalloc-1: Page alloc time in ticks : 23 345 ticks/page
2493	bs3-memalloc-1: Alloc thruput : 128 296 pages/s
2494	bs3-memalloc-1: Alloc thruput in MiBs : 501 MB/s
2495	bs3-memalloc-1: Allocation speed : PASSED
2496	bs3-memalloc-1: Access elapsed : 85 074 483 467 ns
2497	bs3-memalloc-1: Access elapsed in ticks : 254 816 088 412 ticks
2498	bs3-memalloc-1: Page access time : 7 292 ns/page
2499	bs3-memalloc-1: Page access time in ticks : 21 843 ticks/page
2500	bs3-memalloc-1: Access thruput : 137 119 pages/s
2501	bs3-memalloc-1: Access thruput in MiBs : 535 MB/s
2502	bs3-memalloc-1: 2nd access : PASSED
2503	bs3-memalloc-1: Access elapsed : 112 963 925 ns
2504	bs3-memalloc-1: Access elapsed in ticks : 338 284 436 ticks
2505	bs3-memalloc-1: Page access time : 9 ns/page
2506	bs3-memalloc-1: Page access time in ticks : 28 ticks/page
2507	bs3-memalloc-1: Access thruput : 103 266 666 pages/s
2508	bs3-memalloc-1: Access thruput in MiBs : 403 385 MB/s
2509	bs3-memalloc-1: 3rd access : PASSED
2510	bs3-memalloc-1: SUCCESS
2511	* @endverbatim
2512	*
2513	* NEM w/ simplified memory and but no MEM_LARGE_PAGES:
2514	* @verbatim
2515	bs3-memalloc-1: From 0x100000000 to 0xc20000000
2516	bs3-memalloc-1: Pages : 11 665 408 pages
2517	bs3-memalloc-1: MiBs : 45 568 MB
2518	bs3-memalloc-1: Alloc elapsed : 90 062 027 900 ns
2519	bs3-memalloc-1: Alloc elapsed in ticks : 269 754 826 466 ticks
2520	bs3-memalloc-1: Page alloc time : 7 720 ns/page
2521	bs3-memalloc-1: Page alloc time in ticks : 23 124 ticks/page
2522	bs3-memalloc-1: Alloc thruput : 129 526 pages/s
2523	bs3-memalloc-1: Alloc thruput in MiBs : 505 MB/s
2524	bs3-memalloc-1: Allocation speed : PASSED
2525	bs3-memalloc-1: Access elapsed : 3 596 017 220 ns
2526	bs3-memalloc-1: Access elapsed in ticks : 10 770 732 620 ticks
2527	bs3-memalloc-1: Page access time : 308 ns/page
2528	bs3-memalloc-1: Page access time in ticks : 923 ticks/page
2529	bs3-memalloc-1: Access thruput : 3 243 980 pages/s
2530	bs3-memalloc-1: Access thruput in MiBs : 12 671 MB/s
2531	bs3-memalloc-1: 2nd access : PASSED
2532	bs3-memalloc-1: Access elapsed : 133 060 160 ns
2533	bs3-memalloc-1: Access elapsed in ticks : 398 459 884 ticks
2534	bs3-memalloc-1: Page access time : 11 ns/page
2535	bs3-memalloc-1: Page access time in ticks : 34 ticks/page
2536	bs3-memalloc-1: Access thruput : 87 670 178 pages/s
2537	bs3-memalloc-1: Access thruput in MiBs : 342 461 MB/s
2538	bs3-memalloc-1: 3rd access : PASSED
2539	* @endverbatim
2540	*
2541	* Same everything but native VT-x and VBox (stripped output a little):
2542	* @verbatim
2543	bs3-memalloc-1: From 0x100000000 to 0xc20000000
2544	bs3-memalloc-1: Pages : 11 665 408 pages
2545	bs3-memalloc-1: MiBs : 45 568 MB
2546	bs3-memalloc-1: Alloc elapsed : 776 111 427 ns
2547	bs3-memalloc-1: Alloc elapsed in ticks : 2 323 267 035 ticks
2548	bs3-memalloc-1: Page alloc time : 66 ns/page
2549	bs3-memalloc-1: Page alloc time in ticks : 199 ticks/page
2550	bs3-memalloc-1: Alloc thruput : 15 030 584 pages/s
2551	bs3-memalloc-1: Alloc thruput in MiBs : 58 713 MB/s
2552	bs3-memalloc-1: Allocation speed : PASSED
2553	bs3-memalloc-1: Access elapsed : 112 141 904 ns
2554	bs3-memalloc-1: Access elapsed in ticks : 335 751 077 ticks
2555	bs3-memalloc-1: Page access time : 9 ns/page
2556	bs3-memalloc-1: Page access time in ticks : 28 ticks/page
2557	bs3-memalloc-1: Access thruput : 104 023 630 pages/s
2558	bs3-memalloc-1: Access thruput in MiBs : 406 342 MB/s
2559	bs3-memalloc-1: 2nd access : PASSED
2560	bs3-memalloc-1: Access elapsed : 112 023 049 ns
2561	bs3-memalloc-1: Access elapsed in ticks : 335 418 343 ticks
2562	bs3-memalloc-1: Page access time : 9 ns/page
2563	bs3-memalloc-1: Page access time in ticks : 28 ticks/page
2564	bs3-memalloc-1: Access thruput : 104 133 998 pages/s
2565	bs3-memalloc-1: Access thruput in MiBs : 406 773 MB/s
2566	bs3-memalloc-1: 3rd access : PASSED
2567	* @endverbatim
2568	*
2569	* VBox with large pages disabled:
2570	* @verbatim
2571	bs3-memalloc-1: From 0x100000000 to 0xc20000000
2572	bs3-memalloc-1: Pages : 11 665 408 pages
2573	bs3-memalloc-1: MiBs : 45 568 MB
2574	bs3-memalloc-1: Alloc elapsed : 50 986 588 028 ns
2575	bs3-memalloc-1: Alloc elapsed in ticks : 152 714 862 044 ticks
2576	bs3-memalloc-1: Page alloc time : 4 370 ns/page
2577	bs3-memalloc-1: Page alloc time in ticks : 13 091 ticks/page
2578	bs3-memalloc-1: Alloc thruput : 228 793 pages/s
2579	bs3-memalloc-1: Alloc thruput in MiBs : 893 MB/s
2580	bs3-memalloc-1: Allocation speed : PASSED
2581	bs3-memalloc-1: Access elapsed : 2 849 641 741 ns
2582	bs3-memalloc-1: Access elapsed in ticks : 8 535 372 249 ticks
2583	bs3-memalloc-1: Page access time : 244 ns/page
2584	bs3-memalloc-1: Page access time in ticks : 731 ticks/page
2585	bs3-memalloc-1: Access thruput : 4 093 640 pages/s
2586	bs3-memalloc-1: Access thruput in MiBs : 15 990 MB/s
2587	bs3-memalloc-1: 2nd access : PASSED
2588	bs3-memalloc-1: Access elapsed : 2 866 960 770 ns
2589	bs3-memalloc-1: Access elapsed in ticks : 8 587 097 799 ticks
2590	bs3-memalloc-1: Page access time : 245 ns/page
2591	bs3-memalloc-1: Page access time in ticks : 736 ticks/page
2592	bs3-memalloc-1: Access thruput : 4 068 910 pages/s
2593	bs3-memalloc-1: Access thruput in MiBs : 15 894 MB/s
2594	bs3-memalloc-1: 3rd access : PASSED
2595	* @endverbatim
2596	*
2597	* Comparing large pages, therer is an allocation speed difference of two order
2598	* of magnitude. When disabling large pages in VBox the allocation numbers are
2599	* closer, and the is clear from the 2nd and 3rd access tests that VBox doesn't
2600	* spend enough memory on nested page tables as Hyper-V does. The similar 2nd
2601	* and 3rd access numbers the two large page testruns seems to hint strongly at
2602	* Hyper-V eventually getting the large pages in place too, only that it sucks
2603	* hundredfold in the setting up phase.
2604	*
2605	*
2606	*
2607	* @section sec_nem_win_impl Our implementation.
2608	*
2609	* We set out with the goal of wanting to run as much as possible in ring-0,
2610	* reasoning that this would give use the best performance.
2611	*
2612	* This goal was approached gradually, starting out with a pure WinHvPlatform
2613	* implementation, gradually replacing parts: register access, guest memory
2614	* handling, running virtual processors. Then finally moving it all into
2615	* ring-0, while keeping most of it configurable so that we could make
2616	* comparisons (see NEMInternal.h and nemR3NativeRunGC()).
2617	*
2618	*
2619	* @subsection subsect_nem_win_impl_ioctl VID.SYS I/O control calls
2620	*
2621	* To run things in ring-0 we need to talk directly to VID.SYS thru its I/O
2622	* control interface. Looking at changes between like build 17083 and 17101 (if
2623	* memory serves) a set of the VID I/O control numbers shifted a little, which
2624	* means we need to determin them dynamically. We currently do this by hooking
2625	* the NtDeviceIoControlFile API call from VID.DLL and snooping up the
2626	* parameters when making dummy calls to relevant APIs. (We could also
2627	* disassemble the relevant APIs and try fish out the information from that, but
2628	* this is way simpler.)
2629	*
2630	* Issuing I/O control calls from ring-0 is facing a small challenge with
2631	* respect to direct buffering. When using direct buffering the device will
2632	* typically check that the buffer is actually in the user address space range
2633	* and reject kernel addresses. Fortunately, we've got the cross context VM
2634	* structure that is mapped into both kernel and user space, it's also locked
2635	* and safe to access from kernel space. So, we place the I/O control buffers
2636	* in the per-CPU part of it (NEMCPU::uIoCtlBuf) and give the driver the user
2637	* address if direct access buffering or kernel address if not.
2638	*
2639	* The I/O control calls are 'abstracted' in the support driver, see
2640	* SUPR0IoCtlSetupForHandle(), SUPR0IoCtlPerform() and SUPR0IoCtlCleanup().
2641	*
2642	*
2643	* @subsection subsect_nem_win_impl_cpumctx CPUMCTX
2644	*
2645	* Since the CPU state needs to live in Hyper-V when executing, we probably
2646	* should not transfer more than necessary when handling VMEXITs. To help us
2647	* manage this CPUMCTX got a new field CPUMCTX::fExtrn that to indicate which
2648	* part of the state is currently externalized (== in Hyper-V).
2649	*
2650	*
2651	* @subsection sec_nem_win_benchmarks Benchmarks.
2652	*
2653	* @subsubsection subsect_nem_win_benchmarks_bs2t1 17134/2018-06-22: Bootsector2-test1
2654	*
2655	* This is ValidationKit/bootsectors/bootsector2-test1.asm as of 2018-06-22
2656	* (internal r123172) running a the release build of VirtualBox from the same
2657	* source, though with exit optimizations disabled. Host is AMD Threadripper 1950X
2658	* running out an up to date 64-bit Windows 10 build 17134.
2659	*
2660	* The base line column is using the official WinHv API for everything but physical
2661	* memory mapping. The 2nd column is the default NEM/win configuration where we
2662	* put the main execution loop in ring-0, using hypercalls when we can and VID for
2663	* managing execution. The 3rd column is regular VirtualBox using AMD-V directly,
2664	* hyper-V is disabled, main execution loop in ring-0.
2665	*
2666	* @verbatim
2667	TESTING... WinHv API Hypercalls + VID VirtualBox AMD-V
2668	32-bit paged protected mode, CPUID : 108 874 ins/sec 113% / 123 602 1198% / 1 305 113
2669	32-bit pae protected mode, CPUID : 106 722 ins/sec 115% / 122 740 1232% / 1 315 201
2670	64-bit long mode, CPUID : 106 798 ins/sec 114% / 122 111 1198% / 1 280 404
2671	16-bit unpaged protected mode, CPUID : 106 835 ins/sec 114% / 121 994 1216% / 1 299 665
2672	32-bit unpaged protected mode, CPUID : 105 257 ins/sec 115% / 121 772 1235% / 1 300 860
2673	real mode, CPUID : 104 507 ins/sec 116% / 121 800 1228% / 1 283 848
2674	CPUID EAX=1 : PASSED
2675	32-bit paged protected mode, RDTSC : 99 581 834 ins/sec 100% / 100 323 307 93% / 93 473 299
2676	32-bit pae protected mode, RDTSC : 99 620 585 ins/sec 100% / 99 960 952 84% / 83 968 839
2677	64-bit long mode, RDTSC : 100 540 009 ins/sec 100% / 100 946 372 93% / 93 652 826
2678	16-bit unpaged protected mode, RDTSC : 99 688 473 ins/sec 100% / 100 097 751 76% / 76 281 287
2679	32-bit unpaged protected mode, RDTSC : 98 385 857 ins/sec 102% / 100 510 404 94% / 93 379 536
2680	real mode, RDTSC : 100 087 967 ins/sec 101% / 101 386 138 93% / 93 234 999
2681	RDTSC : PASSED
2682	32-bit paged protected mode, Read CR4 : 2 156 102 ins/sec 98% / 2 121 967 17114% / 369 009 009
2683	32-bit pae protected mode, Read CR4 : 2 163 820 ins/sec 98% / 2 133 804 17469% / 377 999 261
2684	64-bit long mode, Read CR4 : 2 164 822 ins/sec 98% / 2 128 698 18875% / 408 619 313
2685	16-bit unpaged protected mode, Read CR4 : 2 162 367 ins/sec 100% / 2 168 508 17132% / 370 477 568
2686	32-bit unpaged protected mode, Read CR4 : 2 163 189 ins/sec 100% / 2 169 808 16768% / 362 734 679
2687	real mode, Read CR4 : 2 162 436 ins/sec 100% / 2 164 914 15551% / 336 288 998
2688	Read CR4 : PASSED
2689	real mode, 32-bit IN : 104 649 ins/sec 118% / 123 513 1028% / 1 075 831
2690	real mode, 32-bit OUT : 107 102 ins/sec 115% / 123 660 982% / 1 052 259
2691	real mode, 32-bit IN-to-ring-3 : 105 697 ins/sec 98% / 104 471 201% / 213 216
2692	real mode, 32-bit OUT-to-ring-3 : 105 830 ins/sec 98% / 104 598 198% / 210 495
2693	16-bit unpaged protected mode, 32-bit IN : 104 855 ins/sec 117% / 123 174 1029% / 1 079 591
2694	16-bit unpaged protected mode, 32-bit OUT : 107 529 ins/sec 115% / 124 250 992% / 1 067 053
2695	16-bit unpaged protected mode, 32-bit IN-to-ring-3 : 106 337 ins/sec 103% / 109 565 196% / 209 367
2696	16-bit unpaged protected mode, 32-bit OUT-to-ring-3 : 107 558 ins/sec 100% / 108 237 191% / 206 387
2697	32-bit unpaged protected mode, 32-bit IN : 106 351 ins/sec 116% / 123 584 1016% / 1 081 325
2698	32-bit unpaged protected mode, 32-bit OUT : 106 424 ins/sec 116% / 124 252 995% / 1 059 408
2699	32-bit unpaged protected mode, 32-bit IN-to-ring-3 : 104 035 ins/sec 101% / 105 305 202% / 210 750
2700	32-bit unpaged protected mode, 32-bit OUT-to-ring-3 : 103 831 ins/sec 102% / 106 919 205% / 213 198
2701	32-bit paged protected mode, 32-bit IN : 103 356 ins/sec 119% / 123 870 1041% / 1 076 463
2702	32-bit paged protected mode, 32-bit OUT : 107 177 ins/sec 115% / 124 302 998% / 1 069 655
2703	32-bit paged protected mode, 32-bit IN-to-ring-3 : 104 491 ins/sec 100% / 104 744 200% / 209 264
2704	32-bit paged protected mode, 32-bit OUT-to-ring-3 : 106 603 ins/sec 97% / 103 849 197% / 210 219
2705	32-bit pae protected mode, 32-bit IN : 105 923 ins/sec 115% / 122 759 1041% / 1 103 261
2706	32-bit pae protected mode, 32-bit OUT : 107 083 ins/sec 117% / 126 057 1024% / 1 096 667
2707	32-bit pae protected mode, 32-bit IN-to-ring-3 : 106 114 ins/sec 97% / 103 496 199% / 211 312
2708	32-bit pae protected mode, 32-bit OUT-to-ring-3 : 105 675 ins/sec 96% / 102 096 198% / 209 890
2709	64-bit long mode, 32-bit IN : 105 800 ins/sec 113% / 120 006 1013% / 1 072 116
2710	64-bit long mode, 32-bit OUT : 105 635 ins/sec 113% / 120 375 997% / 1 053 655
2711	64-bit long mode, 32-bit IN-to-ring-3 : 105 274 ins/sec 95% / 100 763 197% / 208 026
2712	64-bit long mode, 32-bit OUT-to-ring-3 : 106 262 ins/sec 94% / 100 749 196% / 209 288
2713	NOP I/O Port Access : PASSED
2714	32-bit paged protected mode, 32-bit read : 57 687 ins/sec 119% / 69 136 1197% / 690 548
2715	32-bit paged protected mode, 32-bit write : 57 957 ins/sec 118% / 68 935 1183% / 685 930
2716	32-bit paged protected mode, 32-bit read-to-ring-3 : 57 958 ins/sec 95% / 55 432 276% / 160 505
2717	32-bit paged protected mode, 32-bit write-to-ring-3 : 57 922 ins/sec 100% / 58 340 304% / 176 464
2718	32-bit pae protected mode, 32-bit read : 57 478 ins/sec 119% / 68 453 1141% / 656 159
2719	32-bit pae protected mode, 32-bit write : 57 226 ins/sec 118% / 68 097 1157% / 662 504
2720	32-bit pae protected mode, 32-bit read-to-ring-3 : 57 582 ins/sec 94% / 54 651 268% / 154 867
2721	32-bit pae protected mode, 32-bit write-to-ring-3 : 57 697 ins/sec 100% / 57 750 299% / 173 030
2722	64-bit long mode, 32-bit read : 57 128 ins/sec 118% / 67 779 1071% / 611 949
2723	64-bit long mode, 32-bit write : 57 127 ins/sec 118% / 67 632 1084% / 619 395
2724	64-bit long mode, 32-bit read-to-ring-3 : 57 181 ins/sec 94% / 54 123 265% / 151 937
2725	64-bit long mode, 32-bit write-to-ring-3 : 57 297 ins/sec 99% / 57 286 294% / 168 694
2726	16-bit unpaged protected mode, 32-bit read : 58 827 ins/sec 118% / 69 545 1185% / 697 602
2727	16-bit unpaged protected mode, 32-bit write : 58 678 ins/sec 118% / 69 442 1183% / 694 387
2728	16-bit unpaged protected mode, 32-bit read-to-ring-3 : 57 841 ins/sec 96% / 55 730 275% / 159 163
2729	16-bit unpaged protected mode, 32-bit write-to-ring-3 : 57 855 ins/sec 101% / 58 834 304% / 176 169
2730	32-bit unpaged protected mode, 32-bit read : 58 063 ins/sec 120% / 69 690 1233% / 716 444
2731	32-bit unpaged protected mode, 32-bit write : 57 936 ins/sec 120% / 69 633 1199% / 694 753
2732	32-bit unpaged protected mode, 32-bit read-to-ring-3 : 58 451 ins/sec 96% / 56 183 273% / 159 972
2733	32-bit unpaged protected mode, 32-bit write-to-ring-3 : 58 962 ins/sec 99% / 58 955 298% / 175 936
2734	real mode, 32-bit read : 58 571 ins/sec 118% / 69 478 1160% / 679 917
2735	real mode, 32-bit write : 58 418 ins/sec 118% / 69 320 1185% / 692 513
2736	real mode, 32-bit read-to-ring-3 : 58 072 ins/sec 96% / 55 751 274% / 159 145
2737	real mode, 32-bit write-to-ring-3 : 57 870 ins/sec 101% / 58 755 307% / 178 042
2738	NOP MMIO Access : PASSED
2739	SUCCESS
2740	* @endverbatim
2741	*
2742	* What we see here is:
2743	*
2744	* - The WinHv API approach is 10 to 12 times slower for exits we can
2745	* handle directly in ring-0 in the VBox AMD-V code.
2746	*
2747	* - The WinHv API approach is 2 to 3 times slower for exits we have to
2748	* go to ring-3 to handle with the VBox AMD-V code.
2749	*
2750	* - By using hypercalls and VID.SYS from ring-0 we gain between
2751	* 13% and 20% over the WinHv API on exits handled in ring-0.
2752	*
2753	* - For exits requiring ring-3 handling are between 6% slower and 3% faster
2754	* than the WinHv API.
2755	*
2756	*
2757	* As a side note, it looks like Hyper-V doesn't let the guest read CR4 but
2758	* triggers exits all the time. This isn't all that important these days since
2759	* OSes like Linux cache the CR4 value specifically to avoid these kinds of exits.
2760	*
2761	*
2762	* @subsubsection subsect_nem_win_benchmarks_bs2t1u1 17134/2018-10-02: Bootsector2-test1
2763	*
2764	* Update on 17134. While expectantly testing a couple of newer builds (17758,
2765	* 17763) hoping for some increases in performance, the numbers turned out
2766	* altogether worse than the June test run. So, we went back to the 1803
2767	* (17134) installation, made sure it was fully up to date (as per 2018-10-02)
2768	* and re-tested.
2769	*
2770	* The numbers had somehow turned significantly worse over the last 3-4 months,
2771	* dropping around 70% for the WinHv API test, more for Hypercalls + VID.
2772	*
2773	* @verbatim
2774	TESTING... WinHv API Hypercalls + VID VirtualBox AMD-V *
2775	32-bit paged protected mode, CPUID : 33 270 ins/sec 33 154
2776	real mode, CPUID : 33 534 ins/sec 32 711
2777	[snip]
2778	32-bit paged protected mode, RDTSC : 102 216 011 ins/sec 98 225 419
2779	real mode, RDTSC : 102 492 243 ins/sec 98 225 419
2780	[snip]
2781	32-bit paged protected mode, Read CR4 : 2 096 165 ins/sec 2 123 815
2782	real mode, Read CR4 : 2 081 047 ins/sec 2 075 151
2783	[snip]
2784	32-bit paged protected mode, 32-bit IN : 32 739 ins/sec 33 655
2785	32-bit paged protected mode, 32-bit OUT : 32 702 ins/sec 33 777
2786	32-bit paged protected mode, 32-bit IN-to-ring-3 : 32 579 ins/sec 29 985
2787	32-bit paged protected mode, 32-bit OUT-to-ring-3 : 32 750 ins/sec 29 757
2788	[snip]
2789	32-bit paged protected mode, 32-bit read : 20 042 ins/sec 21 489
2790	32-bit paged protected mode, 32-bit write : 20 036 ins/sec 21 493
2791	32-bit paged protected mode, 32-bit read-to-ring-3 : 19 985 ins/sec 19 143
2792	32-bit paged protected mode, 32-bit write-to-ring-3 : 19 972 ins/sec 19 595
2793
2794	* @endverbatim
2795	*
2796	* Suspects are security updates and/or microcode updates installed since then.
2797	* Given that the RDTSC and CR4 numbers are reasonably unchanges, it seems that
2798	* the Hyper-V core loop (in hvax64.exe) aren't affected. Our ring-0 runloop
2799	* is equally affected as the ring-3 based runloop, so it cannot be ring
2800	* switching as such (unless the ring-0 loop is borked and we didn't notice yet).
2801	*
2802	* The issue is probably in the thread / process switching area, could be
2803	* something special for hyper-V interrupt delivery or worker thread switching.
2804	*
2805	* Really wish this thread ping-pong going on in VID.SYS could be eliminated!
2806	*
2807	*
2808	* @subsubsection subsect_nem_win_benchmarks_bs2t1u2 17763: Bootsector2-test1
2809	*
2810	* Some preliminary numbers for build 17763 on the 3.4 GHz AMD 1950X, the second
2811	* column will improve we get time to have a look the register page.
2812	*
2813	* There is a 50% performance loss here compared to the June numbers with
2814	* build 17134. The RDTSC numbers hits that it isn't in the Hyper-V core
2815	* (hvax64.exe), but something on the NT side.
2816	*
2817	* Clearing bit 20 in nt!KiSpeculationFeatures speeds things up (i.e. changing
2818	* the dword from 0x00300065 to 0x00200065 in windbg). This is checked by
2819	* nt!KePrepareToDispatchVirtualProcessor, making it a no-op if the flag is
2820	* clear. winhvr!WinHvpVpDispatchLoop call that function before making
2821	* hypercall 0xc2, which presumably does the heavy VCpu lifting in hvcax64.exe.
2822	*
2823	* @verbatim
2824	TESTING... WinHv API Hypercalls + VID clr(bit-20) + WinHv API
2825	32-bit paged protected mode, CPUID : 54 145 ins/sec 51 436 130 076
2826	real mode, CPUID : 54 178 ins/sec 51 713 130 449
2827	[snip]
2828	32-bit paged protected mode, RDTSC : 98 927 639 ins/sec 100 254 552 100 549 882
2829	real mode, RDTSC : 99 601 206 ins/sec 100 886 699 100 470 957
2830	[snip]
2831	32-bit paged protected mode, 32-bit IN : 54 621 ins/sec 51 524 128 294
2832	32-bit paged protected mode, 32-bit OUT : 54 870 ins/sec 51 671 129 397
2833	32-bit paged protected mode, 32-bit IN-to-ring-3 : 54 624 ins/sec 43 964 127 874
2834	32-bit paged protected mode, 32-bit OUT-to-ring-3 : 54 803 ins/sec 44 087 129 443
2835	[snip]
2836	32-bit paged protected mode, 32-bit read : 28 230 ins/sec 34 042 48 113
2837	32-bit paged protected mode, 32-bit write : 27 962 ins/sec 34 050 48 069
2838	32-bit paged protected mode, 32-bit read-to-ring-3 : 27 841 ins/sec 28 397 48 146
2839	32-bit paged protected mode, 32-bit write-to-ring-3 : 27 896 ins/sec 29 455 47 970
2840	* @endverbatim
2841	*
2842	*
2843	* @subsubsection subsect_nem_win_benchmarks_w2k 17134/2018-06-22: Windows 2000 Boot & Shutdown
2844	*
2845	* Timing the startup and automatic shutdown of a Windows 2000 SP4 guest serves
2846	* as a real world benchmark and example of why exit performance is import. When
2847	* Windows 2000 boots up is doing a lot of VGA redrawing of the boot animation,
2848	* which is very costly. Not having installed guest additions leaves it in a VGA
2849	* mode after the bootup sequence is done, keep up the screen access expenses,
2850	* though the graphics driver more economical than the bootvid code.
2851	*
2852	* The VM was configured to automatically logon. A startup script was installed
2853	* to perform the automatic shuting down and powering off the VM (thru
2854	* vts_shutdown.exe -f -p). An offline snapshot of the VM was taken an restored
2855	* before each test run. The test time run time is calculated from the monotonic
2856	* VBox.log timestamps, starting with the state change to 'RUNNING' and stopping
2857	* at 'POWERING_OFF'.
2858	*
2859	* The host OS and VirtualBox build is the same as for the bootsector2-test1
2860	* scenario.
2861	*
2862	* Results:
2863	*
2864	* - WinHv API for all but physical page mappings:
2865	* 32 min 12.19 seconds
2866	*
2867	* - The default NEM/win configuration where we put the main execution loop
2868	* in ring-0, using hypercalls when we can and VID for managing execution:
2869	* 3 min 23.18 seconds
2870	*
2871	* - Regular VirtualBox using AMD-V directly, hyper-V is disabled, main
2872	* execution loop in ring-0:
2873	* 58.09 seconds
2874	*
2875	* - WinHv API with exit history based optimizations:
2876	* 58.66 seconds
2877	*
2878	* - Hypercall + VID.SYS with exit history base optimizations:
2879	* 58.94 seconds
2880	*
2881	* With a well above average machine needing over half an hour for booting a
2882	* nearly 20 year old guest kind of says it all. The 13%-20% exit performance
2883	* increase we get by using hypercalls and VID.SYS directly pays off a lot here.
2884	* The 3m23s is almost acceptable in comparison to the half an hour.
2885	*
2886	* The similarity between the last three results strongly hits at windows 2000
2887	* doing a lot of waiting during boot and shutdown and isn't the best testcase
2888	* once a basic performance level is reached.
2889	*
2890	*
2891	* @subsubsection subsection_iem_win_benchmarks_deb9_nat Debian 9 NAT performance
2892	*
2893	* This benchmark is about network performance over NAT from a 64-bit Debian 9
2894	* VM with a single CPU. For network performance measurements, we use our own
2895	* NetPerf tool (ValidationKit/utils/network/NetPerf.cpp) to measure latency
2896	* and throughput.
2897	*
2898	* The setups, builds and configurations are as in the previous benchmarks
2899	* (release r123172 on 1950X running 64-bit W10/17134 (2016-06-xx). Please note
2900	* that the exit optimizations hasn't yet been in tuned with NetPerf in mind.
2901	*
2902	* The NAT network setup was selected here since it's the default one and the
2903	* slowest one. There is quite a bit of IPC with worker threads and packet
2904	* processing involved.
2905	*
2906	* Latency test is first up. This is a classic back and forth between the two
2907	* NetPerf instances, where the key measurement is the roundrip latency. The
2908	* values here are the lowest result over 3-6 runs.
2909	*
2910	* Against host system:
2911	* - 152 258 ns/roundtrip - 100% - regular VirtualBox SVM
2912	* - 271 059 ns/roundtrip - 178% - Hypercalls + VID.SYS in ring-0 with exit optimizations.
2913	* - 280 149 ns/roundtrip - 184% - Hypercalls + VID.SYS in ring-0
2914	* - 317 735 ns/roundtrip - 209% - Win HV API with exit optimizations.
2915	* - 342 440 ns/roundtrip - 225% - Win HV API
2916	*
2917	* Against a remote Windows 10 system over a 10Gbps link:
2918	* - 243 969 ns/roundtrip - 100% - regular VirtualBox SVM
2919	* - 384 427 ns/roundtrip - 158% - Win HV API with exit optimizations.
2920	* - 402 411 ns/roundtrip - 165% - Hypercalls + VID.SYS in ring-0
2921	* - 406 313 ns/roundtrip - 167% - Win HV API
2922	* - 413 160 ns/roundtrip - 169% - Hypercalls + VID.SYS in ring-0 with exit optimizations.
2923	*
2924	* What we see here is:
2925	*
2926	* - Consistent and signficant latency increase using Hyper-V compared
2927	* to directly harnessing AMD-V ourselves.
2928	*
2929	* - When talking to the host, it's clear that the hypercalls + VID.SYS
2930	* in ring-0 method pays off.
2931	*
2932	* - When talking to a different host, the numbers are closer and it
2933	* is not longer clear which Hyper-V execution method is better.
2934	*
2935	*
2936	* Throughput benchmarks are performed by one side pushing data full throttle
2937	* for 10 seconds (minus a 1 second at each end of the test), then reversing
2938	* the roles and measuring it in the other direction. The tests ran 3-5 times
2939	* and below are the highest and lowest results in each direction.
2940	*
2941	* Receiving from host system:
2942	* - Regular VirtualBox SVM:
2943	* Max: 96 907 549 bytes/s - 100%
2944	* Min: 86 912 095 bytes/s - 100%
2945	* - Hypercalls + VID.SYS in ring-0:
2946	* Max: 84 036 544 bytes/s - 87%
2947	* Min: 64 978 112 bytes/s - 75%
2948	* - Hypercalls + VID.SYS in ring-0 with exit optimizations:
2949	* Max: 77 760 699 bytes/s - 80%
2950	* Min: 72 677 171 bytes/s - 84%
2951	* - Win HV API with exit optimizations:
2952	* Max: 64 465 905 bytes/s - 67%
2953	* Min: 62 286 369 bytes/s - 72%
2954	* - Win HV API:
2955	* Max: 62 466 631 bytes/s - 64%
2956	* Min: 61 362 782 bytes/s - 70%
2957	*
2958	* Sending to the host system:
2959	* - Regular VirtualBox SVM:
2960	* Max: 87 728 652 bytes/s - 100%
2961	* Min: 86 923 198 bytes/s - 100%
2962	* - Hypercalls + VID.SYS in ring-0:
2963	* Max: 84 280 749 bytes/s - 96%
2964	* Min: 78 369 842 bytes/s - 90%
2965	* - Hypercalls + VID.SYS in ring-0 with exit optimizations:
2966	* Max: 84 119 932 bytes/s - 96%
2967	* Min: 77 396 811 bytes/s - 89%
2968	* - Win HV API:
2969	* Max: 81 714 377 bytes/s - 93%
2970	* Min: 78 697 419 bytes/s - 91%
2971	* - Win HV API with exit optimizations:
2972	* Max: 80 502 488 bytes/s - 91%
2973	* Min: 71 164 978 bytes/s - 82%
2974	*
2975	* Receiving from a remote Windows 10 system over a 10Gbps link:
2976	* - Hypercalls + VID.SYS in ring-0:
2977	* Max: 115 346 922 bytes/s - 136%
2978	* Min: 112 912 035 bytes/s - 137%
2979	* - Regular VirtualBox SVM:
2980	* Max: 84 517 504 bytes/s - 100%
2981	* Min: 82 597 049 bytes/s - 100%
2982	* - Hypercalls + VID.SYS in ring-0 with exit optimizations:
2983	* Max: 77 736 251 bytes/s - 92%
2984	* Min: 73 813 784 bytes/s - 89%
2985	* - Win HV API with exit optimizations:
2986	* Max: 63 035 587 bytes/s - 75%
2987	* Min: 57 538 380 bytes/s - 70%
2988	* - Win HV API:
2989	* Max: 62 279 185 bytes/s - 74%
2990	* Min: 56 813 866 bytes/s - 69%
2991	*
2992	* Sending to a remote Windows 10 system over a 10Gbps link:
2993	* - Win HV API with exit optimizations:
2994	* Max: 116 502 357 bytes/s - 103%
2995	* Min: 49 046 550 bytes/s - 59%
2996	* - Regular VirtualBox SVM:
2997	* Max: 113 030 991 bytes/s - 100%
2998	* Min: 83 059 511 bytes/s - 100%
2999	* - Hypercalls + VID.SYS in ring-0:
3000	* Max: 106 435 031 bytes/s - 94%
3001	* Min: 47 253 510 bytes/s - 57%
3002	* - Hypercalls + VID.SYS in ring-0 with exit optimizations:
3003	* Max: 94 842 287 bytes/s - 84%
3004	* Min: 68 362 172 bytes/s - 82%
3005	* - Win HV API:
3006	* Max: 65 165 225 bytes/s - 58%
3007	* Min: 47 246 573 bytes/s - 57%
3008	*
3009	* What we see here is:
3010	*
3011	* - Again consistent numbers when talking to the host. Showing that the
3012	* ring-0 approach is preferable to the ring-3 one.
3013	*
3014	* - Again when talking to a remote host, things get more difficult to
3015	* make sense of. The spread is larger and direct AMD-V gets beaten by
3016	* a different the Hyper-V approaches in each direction.
3017	*
3018	* - However, if we treat the first entry (remote host) as weird spikes, the
3019	* other entries are consistently worse compared to direct AMD-V. For the
3020	* send case we get really bad results for WinHV.
3021	*
3022	*/
3023

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

source: vbox/trunk/src/VBox/VMM/VMMR3/NEMR3Native-win.cpp@ 107200

Download in other formats: