NEMR3Native-win.cpp@ 72415

Last change on this file since 72415 was 72415, checked in by vboxsync, 7 years ago
NEM/win: More MSR work. Document IA32_APIC_BASE issues (no X2APIC, ++). bugref:9044
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 121.8 KB

Line
1	/* $Id: NEMR3Native-win.cpp 72415 2018-06-01 20:29:34Z 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 Oracle Corporation
14	*
15	* This file is part of VirtualBox Open Source Edition (OSE), as
16	* available from http://www.virtualbox.org. This file is free software;
17	* you can redistribute it and/or modify it under the terms of the GNU
18	* General Public License (GPL) as published by the Free Software
19	* Foundation, in version 2 as it comes in the "COPYING" file of the
20	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
21	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
22	*/
23
24
25	/*********************************************************************************************************************************
26	* Header Files *
27	*********************************************************************************************************************************/
28	#define LOG_GROUP LOG_GROUP_NEM
29	#include <iprt/nt/nt-and-windows.h>
30	#include <iprt/nt/hyperv.h>
31	#include <iprt/nt/vid.h>
32	#include <WinHvPlatform.h>
33
34	#ifndef _WIN32_WINNT_WIN10
35	# error "Missing _WIN32_WINNT_WIN10"
36	#endif
37	#ifndef _WIN32_WINNT_WIN10_RS1 /* Missing define, causing trouble for us. */
38	# define _WIN32_WINNT_WIN10_RS1 (_WIN32_WINNT_WIN10 + 1)
39	#endif
40	#include <sysinfoapi.h>
41	#include <debugapi.h>
42	#include <errhandlingapi.h>
43	#include <fileapi.h>
44	#include <winerror.h> /* no api header for this. */
45
46	#include <VBox/vmm/nem.h>
47	#include <VBox/vmm/iem.h>
48	#include <VBox/vmm/em.h>
49	#include <VBox/vmm/apic.h>
50	#include <VBox/vmm/pdm.h>
51	#include "NEMInternal.h"
52	#include <VBox/vmm/vm.h>
53
54	#include <iprt/ldr.h>
55	#include <iprt/path.h>
56	#include <iprt/string.h>
57	#include <iprt/system.h>
58
59
60	/*********************************************************************************************************************************
61	* Defined Constants And Macros *
62	*********************************************************************************************************************************/
63	#ifdef LOG_ENABLED
64	# define NEM_WIN_INTERCEPT_NT_IO_CTLS
65	#endif
66
67	/** VID I/O control detection: Fake partition handle input. */
68	#define NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE ((HANDLE)(uintptr_t)38479125)
69	/** VID I/O control detection: Fake partition ID return. */
70	#define NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_ID UINT64_C(0xfa1e000042424242)
71	/** VID I/O control detection: Fake CPU index input. */
72	#define NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX UINT32_C(42)
73	/** VID I/O control detection: Fake timeout input. */
74	#define NEM_WIN_IOCTL_DETECTOR_FAKE_TIMEOUT UINT32_C(0x00080286)
75
76
77	/*********************************************************************************************************************************
78	* Global Variables *
79	*********************************************************************************************************************************/
80	/** @name APIs imported from WinHvPlatform.dll
81	* @{ */
82	static decltype(WHvGetCapability) * g_pfnWHvGetCapability;
83	static decltype(WHvCreatePartition) * g_pfnWHvCreatePartition;
84	static decltype(WHvSetupPartition) * g_pfnWHvSetupPartition;
85	static decltype(WHvDeletePartition) * g_pfnWHvDeletePartition;
86	static decltype(WHvGetPartitionProperty) * g_pfnWHvGetPartitionProperty;
87	static decltype(WHvSetPartitionProperty) * g_pfnWHvSetPartitionProperty;
88	static decltype(WHvMapGpaRange) * g_pfnWHvMapGpaRange;
89	static decltype(WHvUnmapGpaRange) * g_pfnWHvUnmapGpaRange;
90	static decltype(WHvTranslateGva) * g_pfnWHvTranslateGva;
91	#ifndef NEM_WIN_USE_OUR_OWN_RUN_API
92	static decltype(WHvCreateVirtualProcessor) * g_pfnWHvCreateVirtualProcessor;
93	static decltype(WHvDeleteVirtualProcessor) * g_pfnWHvDeleteVirtualProcessor;
94	static decltype(WHvRunVirtualProcessor) * g_pfnWHvRunVirtualProcessor;
95	static decltype(WHvCancelRunVirtualProcessor) * g_pfnWHvCancelRunVirtualProcessor;
96	static decltype(WHvGetVirtualProcessorRegisters) * g_pfnWHvGetVirtualProcessorRegisters;
97	static decltype(WHvSetVirtualProcessorRegisters) * g_pfnWHvSetVirtualProcessorRegisters;
98	#endif
99	/** @} */
100
101	/** @name APIs imported from Vid.dll
102	* @{ */
103	static decltype(VidGetHvPartitionId) *g_pfnVidGetHvPartitionId;
104	static decltype(VidStartVirtualProcessor) *g_pfnVidStartVirtualProcessor;
105	static decltype(VidStopVirtualProcessor) *g_pfnVidStopVirtualProcessor;
106	static decltype(VidMessageSlotMap) *g_pfnVidMessageSlotMap;
107	static decltype(VidMessageSlotHandleAndGetNext) *g_pfnVidMessageSlotHandleAndGetNext;
108	#ifdef LOG_ENABLED
109	static decltype(VidGetVirtualProcessorState) *g_pfnVidGetVirtualProcessorState;
110	static decltype(VidSetVirtualProcessorState) *g_pfnVidSetVirtualProcessorState;
111	static decltype(VidGetVirtualProcessorRunningStatus) *g_pfnVidGetVirtualProcessorRunningStatus;
112	#endif
113	/** @} */
114
115	/** The Windows build number. */
116	static uint32_t g_uBuildNo = 17134;
117
118
119
120	/**
121	* Import instructions.
122	*/
123	static const struct
124	{
125	uint8_t idxDll; /*< 0 for WinHvPlatform.dll, 1 for vid.dll. /
126	bool fOptional; /*< Set if import is optional. /
127	PFNRT ppfn; /< The function pointer variable. /
128	const char pszName; /< The function name. /
129	} g_aImports[] =
130	{
131	#define NEM_WIN_IMPORT(a_idxDll, a_fOptional, a_Name) { (a_idxDll), (a_fOptional), (PFNRT *)&RT_CONCAT(g_pfn,a_Name), #a_Name }
132	NEM_WIN_IMPORT(0, false, WHvGetCapability),
133	NEM_WIN_IMPORT(0, false, WHvCreatePartition),
134	NEM_WIN_IMPORT(0, false, WHvSetupPartition),
135	NEM_WIN_IMPORT(0, false, WHvDeletePartition),
136	NEM_WIN_IMPORT(0, false, WHvGetPartitionProperty),
137	NEM_WIN_IMPORT(0, false, WHvSetPartitionProperty),
138	NEM_WIN_IMPORT(0, false, WHvMapGpaRange),
139	NEM_WIN_IMPORT(0, false, WHvUnmapGpaRange),
140	NEM_WIN_IMPORT(0, false, WHvTranslateGva),
141	#ifndef NEM_WIN_USE_OUR_OWN_RUN_API
142	NEM_WIN_IMPORT(0, false, WHvCreateVirtualProcessor),
143	NEM_WIN_IMPORT(0, false, WHvDeleteVirtualProcessor),
144	NEM_WIN_IMPORT(0, false, WHvRunVirtualProcessor),
145	NEM_WIN_IMPORT(0, false, WHvCancelRunVirtualProcessor),
146	NEM_WIN_IMPORT(0, false, WHvGetVirtualProcessorRegisters),
147	NEM_WIN_IMPORT(0, false, WHvSetVirtualProcessorRegisters),
148	#endif
149	NEM_WIN_IMPORT(1, false, VidGetHvPartitionId),
150	NEM_WIN_IMPORT(1, false, VidMessageSlotMap),
151	NEM_WIN_IMPORT(1, false, VidMessageSlotHandleAndGetNext),
152	NEM_WIN_IMPORT(1, false, VidStartVirtualProcessor),
153	NEM_WIN_IMPORT(1, false, VidStopVirtualProcessor),
154	#ifdef LOG_ENABLED
155	NEM_WIN_IMPORT(1, false, VidGetVirtualProcessorState),
156	NEM_WIN_IMPORT(1, false, VidSetVirtualProcessorState),
157	NEM_WIN_IMPORT(1, false, VidGetVirtualProcessorRunningStatus),
158	#endif
159	#undef NEM_WIN_IMPORT
160	};
161
162
163	/** The real NtDeviceIoControlFile API in NTDLL. */
164	static decltype(NtDeviceIoControlFile) *g_pfnNtDeviceIoControlFile;
165	/** Pointer to the NtDeviceIoControlFile import table entry. */
166	static decltype(NtDeviceIoControlFile) **g_ppfnVidNtDeviceIoControlFile;
167	/** Info about the VidGetHvPartitionId I/O control interface. */
168	static NEMWINIOCTL g_IoCtlGetHvPartitionId;
169	/** Info about the VidStartVirtualProcessor I/O control interface. */
170	static NEMWINIOCTL g_IoCtlStartVirtualProcessor;
171	/** Info about the VidStopVirtualProcessor I/O control interface. */
172	static NEMWINIOCTL g_IoCtlStopVirtualProcessor;
173	/** Info about the VidMessageSlotHandleAndGetNext I/O control interface. */
174	static NEMWINIOCTL g_IoCtlMessageSlotHandleAndGetNext;
175	#ifdef LOG_ENABLED
176	/** Info about the VidMessageSlotMap I/O control interface - for logging. */
177	static NEMWINIOCTL g_IoCtlMessageSlotMap;
178	/* Info about the VidGetVirtualProcessorState I/O control interface - for logging. */
179	static NEMWINIOCTL g_IoCtlGetVirtualProcessorState;
180	/* Info about the VidSetVirtualProcessorState I/O control interface - for logging. */
181	static NEMWINIOCTL g_IoCtlSetVirtualProcessorState;
182	/** Pointer to what nemR3WinIoctlDetector_ForLogging should fill in. */
183	static NEMWINIOCTL *g_pIoCtlDetectForLogging;
184	#endif
185
186	#ifdef NEM_WIN_INTERCEPT_NT_IO_CTLS
187	/** Mapping slot for CPU #0.
188	* @{ */
189	static VID_MESSAGE_MAPPING_HEADER *g_pMsgSlotMapping = NULL;
190	static const HV_MESSAGE_HEADER *g_pHvMsgHdr;
191	static const HV_X64_INTERCEPT_MESSAGE_HEADER *g_pX64MsgHdr;
192	/** @} */
193	#endif
194
195
196	/*
197	* Let the preprocessor alias the APIs to import variables for better autocompletion.
198	*/
199	#ifndef IN_SLICKEDIT
200	# define WHvGetCapability g_pfnWHvGetCapability
201	# define WHvCreatePartition g_pfnWHvCreatePartition
202	# define WHvSetupPartition g_pfnWHvSetupPartition
203	# define WHvDeletePartition g_pfnWHvDeletePartition
204	# define WHvGetPartitionProperty g_pfnWHvGetPartitionProperty
205	# define WHvSetPartitionProperty g_pfnWHvSetPartitionProperty
206	# define WHvMapGpaRange g_pfnWHvMapGpaRange
207	# define WHvUnmapGpaRange g_pfnWHvUnmapGpaRange
208	# define WHvTranslateGva g_pfnWHvTranslateGva
209	# define WHvCreateVirtualProcessor g_pfnWHvCreateVirtualProcessor
210	# define WHvDeleteVirtualProcessor g_pfnWHvDeleteVirtualProcessor
211	# define WHvRunVirtualProcessor g_pfnWHvRunVirtualProcessor
212	# define WHvGetRunExitContextSize g_pfnWHvGetRunExitContextSize
213	# define WHvCancelRunVirtualProcessor g_pfnWHvCancelRunVirtualProcessor
214	# define WHvGetVirtualProcessorRegisters g_pfnWHvGetVirtualProcessorRegisters
215	# define WHvSetVirtualProcessorRegisters g_pfnWHvSetVirtualProcessorRegisters
216
217	# define VidMessageSlotHandleAndGetNext g_pfnVidMessageSlotHandleAndGetNext
218	# define VidStartVirtualProcessor g_pfnVidStartVirtualProcessor
219	# define VidStopVirtualProcessor g_pfnVidStopVirtualProcessor
220
221	#endif
222
223	/** WHV_MEMORY_ACCESS_TYPE names */
224	static const char * const g_apszWHvMemAccesstypes[4] = { "read", "write", "exec", "!undefined!" };
225
226
227	/*********************************************************************************************************************************
228	* Internal Functions *
229	*********************************************************************************************************************************/
230
231	/*
232	* Instantate the code we share with ring-0.
233	*/
234	#include "../VMMAll/NEMAllNativeTemplate-win.cpp.h"
235
236
237
238	#ifdef NEM_WIN_INTERCEPT_NT_IO_CTLS
239	/**
240	* Wrapper that logs the call from VID.DLL.
241	*
242	* This is very handy for figuring out why an API call fails.
243	*/
244	static NTSTATUS WINAPI
245	nemR3WinLogWrapper_NtDeviceIoControlFile(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
246	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
247	PVOID pvOutput, ULONG cbOutput)
248	{
249
250	char szFunction[32];
251	const char *pszFunction;
252	if (uFunction == g_IoCtlMessageSlotHandleAndGetNext.uFunction)
253	pszFunction = "VidMessageSlotHandleAndGetNext";
254	else if (uFunction == g_IoCtlStartVirtualProcessor.uFunction)
255	pszFunction = "VidStartVirtualProcessor";
256	else if (uFunction == g_IoCtlStopVirtualProcessor.uFunction)
257	pszFunction = "VidStopVirtualProcessor";
258	else if (uFunction == g_IoCtlMessageSlotMap.uFunction)
259	pszFunction = "VidMessageSlotMap";
260	else if (uFunction == g_IoCtlGetVirtualProcessorState.uFunction)
261	pszFunction = "VidGetVirtualProcessorState";
262	else if (uFunction == g_IoCtlSetVirtualProcessorState.uFunction)
263	pszFunction = "VidSetVirtualProcessorState";
264	else
265	{
266	RTStrPrintf(szFunction, sizeof(szFunction), "%#x", uFunction);
267	pszFunction = szFunction;
268	}
269
270	if (cbInput > 0 && pvInput)
271	Log12(("VID!NtDeviceIoControlFile: %s/input: %.*Rhxs\n", pszFunction, RT_MIN(cbInput, 32), pvInput));
272	NTSTATUS rcNt = g_pfnNtDeviceIoControlFile(hFile, hEvt, pfnApcCallback, pvApcCtx, pIos, uFunction,
273	pvInput, cbInput, pvOutput, cbOutput);
274	if (!hEvt && !pfnApcCallback && !pvApcCtx)
275	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",
276	hFile, pIos, pIos->Status, pIos->Information, pszFunction, pvInput, cbInput, pvOutput, cbOutput, rcNt, ASMReturnAddress()));
277	else
278	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",
279	hFile, hEvt, pfnApcCallback, pvApcCtx, pIos, pIos->Status, pIos->Information, pszFunction,
280	pvInput, cbInput, pvOutput, cbOutput, rcNt, ASMReturnAddress()));
281	if (cbOutput > 0 && pvOutput)
282	{
283	Log12(("VID!NtDeviceIoControlFile: %s/output: %.*Rhxs\n", pszFunction, RT_MIN(cbOutput, 32), pvOutput));
284	if (uFunction == 0x2210cc && g_pMsgSlotMapping == NULL && cbOutput >= sizeof(void *))
285	{
286	g_pMsgSlotMapping = (VID_MESSAGE_MAPPING_HEADER *)pvOutput;
287	g_pHvMsgHdr = (const HV_MESSAGE_HEADER *)(g_pMsgSlotMapping + 1);
288	g_pX64MsgHdr = (const HV_X64_INTERCEPT_MESSAGE_HEADER *)(g_pHvMsgHdr + 1);
289	Log12(("VID!NtDeviceIoControlFile: Message slot mapping: %p\n", g_pMsgSlotMapping));
290	}
291	}
292	if ( g_pMsgSlotMapping
293	&& ( uFunction == g_IoCtlMessageSlotHandleAndGetNext.uFunction
294	\|\| uFunction == g_IoCtlStopVirtualProcessor.uFunction
295	\|\| uFunction == g_IoCtlMessageSlotMap.uFunction
296	))
297	Log12(("VID!NtDeviceIoControlFile: enmVidMsgType=%#x cb=%#x msg=%#x payload=%u cs:rip=%04x:%08RX64 (%s)\n",
298	g_pMsgSlotMapping->enmVidMsgType, g_pMsgSlotMapping->cbMessage,
299	g_pHvMsgHdr->MessageType, g_pHvMsgHdr->PayloadSize,
300	g_pX64MsgHdr->CsSegment.Selector, g_pX64MsgHdr->Rip, pszFunction));
301
302	return rcNt;
303	}
304	#endif /* NEM_WIN_INTERCEPT_NT_IO_CTLS */
305
306
307	/**
308	* Patches the call table of VID.DLL so we can intercept NtDeviceIoControlFile.
309	*
310	* This is for used to figure out the I/O control codes and in logging builds
311	* for logging API calls that WinHvPlatform.dll does.
312	*
313	* @returns VBox status code.
314	* @param hLdrModVid The VID module handle.
315	* @param pErrInfo Where to return additional error information.
316	*/
317	static int nemR3WinInitVidIntercepts(RTLDRMOD hLdrModVid, PRTERRINFO pErrInfo)
318	{
319	/*
320	* Locate the real API.
321	*/
322	g_pfnNtDeviceIoControlFile = (decltype(NtDeviceIoControlFile) *)RTLdrGetSystemSymbol("NTDLL.DLL", "NtDeviceIoControlFile");
323	AssertReturn(g_pfnNtDeviceIoControlFile != NULL,
324	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Failed to resolve NtDeviceIoControlFile from NTDLL.DLL"));
325
326	/*
327	* Locate the PE header and get what we need from it.
328	*/
329	uint8_t const pbImage = (uint8_t const )RTLdrGetNativeHandle(hLdrModVid);
330	IMAGE_DOS_HEADER const pMzHdr = (IMAGE_DOS_HEADER const )pbImage;
331	AssertReturn(pMzHdr->e_magic == IMAGE_DOS_SIGNATURE,
332	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL mapping doesn't start with MZ signature: %#x", pMzHdr->e_magic));
333	IMAGE_NT_HEADERS const pNtHdrs = (IMAGE_NT_HEADERS const )&pbImage[pMzHdr->e_lfanew];
334	AssertReturn(pNtHdrs->Signature == IMAGE_NT_SIGNATURE,
335	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL has invalid PE signaturre: %#x @%#x",
336	pNtHdrs->Signature, pMzHdr->e_lfanew));
337
338	uint32_t const cbImage = pNtHdrs->OptionalHeader.SizeOfImage;
339	IMAGE_DATA_DIRECTORY const ImportDir = pNtHdrs->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT];
340
341	/*
342	* Walk the import descriptor table looking for NTDLL.DLL.
343	*/
344	AssertReturn( ImportDir.Size > 0
345	&& ImportDir.Size < cbImage,
346	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad import directory size: %#x", ImportDir.Size));
347	AssertReturn( ImportDir.VirtualAddress > 0
348	&& ImportDir.VirtualAddress <= cbImage - ImportDir.Size,
349	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad import directory RVA: %#x", ImportDir.VirtualAddress));
350
351	for (PIMAGE_IMPORT_DESCRIPTOR pImps = (PIMAGE_IMPORT_DESCRIPTOR)&pbImage[ImportDir.VirtualAddress];
352	pImps->Name != 0 && pImps->FirstThunk != 0;
353	pImps++)
354	{
355	AssertReturn(pImps->Name < cbImage,
356	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad import directory entry name: %#x", pImps->Name));
357	const char pszModName = (const char )&pbImage[pImps->Name];
358	if (RTStrICmpAscii(pszModName, "ntdll.dll"))
359	continue;
360	AssertReturn(pImps->FirstThunk < cbImage,
361	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad FirstThunk: %#x", pImps->FirstThunk));
362	AssertReturn(pImps->OriginalFirstThunk < cbImage,
363	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad FirstThunk: %#x", pImps->FirstThunk));
364
365	/*
366	* Walk the thunks table(s) looking for NtDeviceIoControlFile.
367	*/
368	PIMAGE_THUNK_DATA pFirstThunk = (PIMAGE_THUNK_DATA)&pbImage[pImps->FirstThunk]; /* update this. */
369	PIMAGE_THUNK_DATA pThunk = pImps->OriginalFirstThunk == 0 /* read from this. */
370	? (PIMAGE_THUNK_DATA)&pbImage[pImps->FirstThunk]
371	: (PIMAGE_THUNK_DATA)&pbImage[pImps->OriginalFirstThunk];
372	while (pThunk->u1.Ordinal != 0)
373	{
374	if (!(pThunk->u1.Ordinal & IMAGE_ORDINAL_FLAG32))
375	{
376	AssertReturn(pThunk->u1.Ordinal > 0 && pThunk->u1.Ordinal < cbImage,
377	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "VID.DLL bad FirstThunk: %#x", pImps->FirstThunk));
378
379	const char pszSymbol = (const char )&pbImage[(uintptr_t)pThunk->u1.AddressOfData + 2];
380	if (strcmp(pszSymbol, "NtDeviceIoControlFile") == 0)
381	{
382	DWORD fOldProt = PAGE_READONLY;
383	VirtualProtect(&pFirstThunk->u1.Function, sizeof(uintptr_t), PAGE_EXECUTE_READWRITE, &fOldProt);
384	g_ppfnVidNtDeviceIoControlFile = (decltype(NtDeviceIoControlFile) **)&pFirstThunk->u1.Function;
385	/* Don't restore the protection here, so we modify the NtDeviceIoControlFile pointer later. */
386	}
387	}
388
389	pThunk++;
390	pFirstThunk++;
391	}
392	}
393
394	if (*g_ppfnVidNtDeviceIoControlFile)
395	{
396	#ifdef NEM_WIN_INTERCEPT_NT_IO_CTLS
397	*g_ppfnVidNtDeviceIoControlFile = nemR3WinLogWrapper_NtDeviceIoControlFile;
398	#endif
399	return VINF_SUCCESS;
400	}
401	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Failed to patch NtDeviceIoControlFile import in VID.DLL!");
402	}
403
404
405	/**
406	* Worker for nemR3NativeInit that probes and load the native API.
407	*
408	* @returns VBox status code.
409	* @param fForced Whether the HMForced flag is set and we should
410	* fail if we cannot initialize.
411	* @param pErrInfo Where to always return error info.
412	*/
413	static int nemR3WinInitProbeAndLoad(bool fForced, PRTERRINFO pErrInfo)
414	{
415	/*
416	* Check that the DLL files we need are present, but without loading them.
417	* We'd like to avoid loading them unnecessarily.
418	*/
419	WCHAR wszPath[MAX_PATH + 64];
420	UINT cwcPath = GetSystemDirectoryW(wszPath, MAX_PATH);
421	if (cwcPath >= MAX_PATH \|\| cwcPath < 2)
422	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "GetSystemDirectoryW failed (%#x / %u)", cwcPath, GetLastError());
423
424	if (wszPath[cwcPath - 1] != '\\' \|\| wszPath[cwcPath - 1] != '/')
425	wszPath[cwcPath++] = '\\';
426	RTUtf16CopyAscii(&wszPath[cwcPath], RT_ELEMENTS(wszPath) - cwcPath, "WinHvPlatform.dll");
427	if (GetFileAttributesW(wszPath) == INVALID_FILE_ATTRIBUTES)
428	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "The native API dll was not found (%ls)", wszPath);
429
430	/*
431	* Check that we're in a VM and that the hypervisor identifies itself as Hyper-V.
432	*/
433	if (!ASMHasCpuId())
434	return RTErrInfoSet(pErrInfo, VERR_NEM_NOT_AVAILABLE, "No CPUID support");
435	if (!ASMIsValidStdRange(ASMCpuId_EAX(0)))
436	return RTErrInfoSet(pErrInfo, VERR_NEM_NOT_AVAILABLE, "No CPUID leaf #1");
437	if (!(ASMCpuId_ECX(1) & X86_CPUID_FEATURE_ECX_HVP))
438	return RTErrInfoSet(pErrInfo, VERR_NEM_NOT_AVAILABLE, "Not in a hypervisor partition (HVP=0)");
439
440	uint32_t cMaxHyperLeaf = 0;
441	uint32_t uEbx = 0;
442	uint32_t uEcx = 0;
443	uint32_t uEdx = 0;
444	ASMCpuIdExSlow(0x40000000, 0, 0, 0, &cMaxHyperLeaf, &uEbx, &uEcx, &uEdx);
445	if (!ASMIsValidHypervisorRange(cMaxHyperLeaf))
446	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "Invalid hypervisor CPUID range (%#x %#x %#x %#x)",
447	cMaxHyperLeaf, uEbx, uEcx, uEdx);
448	if ( uEbx != UINT32_C(0x7263694d) /* Micr */
449	\|\| uEcx != UINT32_C(0x666f736f) /* osof */
450	\|\| uEdx != UINT32_C(0x76482074) /* t Hv */)
451	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE,
452	"Not Hyper-V CPUID signature: %#x %#x %#x (expected %#x %#x %#x)",
453	uEbx, uEcx, uEdx, UINT32_C(0x7263694d), UINT32_C(0x666f736f), UINT32_C(0x76482074));
454	if (cMaxHyperLeaf < UINT32_C(0x40000005))
455	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "Too narrow hypervisor CPUID range (%#x)", cMaxHyperLeaf);
456
457	/** @todo would be great if we could recognize a root partition from the
458	* CPUID info, but I currently don't dare do that. */
459
460	/*
461	* Now try load the DLLs and resolve the APIs.
462	*/
463	static const char * const s_apszDllNames[2] = { "WinHvPlatform.dll", "vid.dll" };
464	RTLDRMOD ahMods[2] = { NIL_RTLDRMOD, NIL_RTLDRMOD };
465	int rc = VINF_SUCCESS;
466	for (unsigned i = 0; i < RT_ELEMENTS(s_apszDllNames); i++)
467	{
468	int rc2 = RTLdrLoadSystem(s_apszDllNames[i], true /fNoUnload/, &ahMods[i]);
469	if (RT_FAILURE(rc2))
470	{
471	if (!RTErrInfoIsSet(pErrInfo))
472	RTErrInfoSetF(pErrInfo, rc2, "Failed to load API DLL: %s: %Rrc", s_apszDllNames[i], rc2);
473	else
474	RTErrInfoAddF(pErrInfo, rc2, "; %s: %Rrc", s_apszDllNames[i], rc2);
475	ahMods[i] = NIL_RTLDRMOD;
476	rc = VERR_NEM_INIT_FAILED;
477	}
478	}
479	if (RT_SUCCESS(rc))
480	rc = nemR3WinInitVidIntercepts(ahMods[1], pErrInfo);
481	if (RT_SUCCESS(rc))
482	{
483	for (unsigned i = 0; i < RT_ELEMENTS(g_aImports); i++)
484	{
485	int rc2 = RTLdrGetSymbol(ahMods[g_aImports[i].idxDll], g_aImports[i].pszName, (void **)g_aImports[i].ppfn);
486	if (RT_FAILURE(rc2))
487	{
488	*g_aImports[i].ppfn = NULL;
489
490	LogRel(("NEM: %s: Failed to import %s!%s: %Rrc",
491	g_aImports[i].fOptional ? "info" : fForced ? "fatal" : "error",
492	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName, rc2));
493	if (!g_aImports[i].fOptional)
494	{
495	if (RTErrInfoIsSet(pErrInfo))
496	RTErrInfoAddF(pErrInfo, rc2, ", %s!%s",
497	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName);
498	else
499	rc = RTErrInfoSetF(pErrInfo, rc2, "Failed to import: %s!%s",
500	s_apszDllNames[g_aImports[i].idxDll], g_aImports[i].pszName);
501	Assert(RT_FAILURE(rc));
502	}
503	}
504	}
505	if (RT_SUCCESS(rc))
506	{
507	Assert(!RTErrInfoIsSet(pErrInfo));
508	}
509	}
510
511	for (unsigned i = 0; i < RT_ELEMENTS(ahMods); i++)
512	RTLdrClose(ahMods[i]);
513	return rc;
514	}
515
516
517	/**
518	* Wrapper for different WHvGetCapability signatures.
519	*/
520	DECLINLINE(HRESULT) WHvGetCapabilityWrapper(WHV_CAPABILITY_CODE enmCap, WHV_CAPABILITY *pOutput, uint32_t cbOutput)
521	{
522	return g_pfnWHvGetCapability(enmCap, pOutput, cbOutput, NULL);
523	}
524
525
526	/**
527	* Worker for nemR3NativeInit that gets the hypervisor capabilities.
528	*
529	* @returns VBox status code.
530	* @param pVM The cross context VM structure.
531	* @param pErrInfo Where to always return error info.
532	*/
533	static int nemR3WinInitCheckCapabilities(PVM pVM, PRTERRINFO pErrInfo)
534	{
535	#define NEM_LOG_REL_CAP_EX(a_szField, a_szFmt, a_Value) LogRel(("NEM: %-38s= " a_szFmt "\n", a_szField, a_Value))
536	#define NEM_LOG_REL_CAP_SUB_EX(a_szField, a_szFmt, a_Value) LogRel(("NEM: %36s: " a_szFmt "\n", a_szField, a_Value))
537	#define NEM_LOG_REL_CAP_SUB(a_szField, a_Value) NEM_LOG_REL_CAP_SUB_EX(a_szField, "%d", a_Value)
538
539	/*
540	* Is the hypervisor present with the desired capability?
541	*
542	* In build 17083 this translates into:
543	* - CPUID[0x00000001].HVP is set
544	* - CPUID[0x40000000] == "Microsoft Hv"
545	* - CPUID[0x40000001].eax == "Hv#1"
546	* - CPUID[0x40000003].ebx[12] is set.
547	* - VidGetExoPartitionProperty(INVALID_HANDLE_VALUE, 0x60000, &Ignored) returns
548	* a non-zero value.
549	*/
550	/**
551	* @todo Someone at Microsoft please explain weird API design:
552	* 1. Pointless CapabilityCode duplication int the output;
553	* 2. No output size.
554	*/
555	WHV_CAPABILITY Caps;
556	RT_ZERO(Caps);
557	SetLastError(0);
558	HRESULT hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeHypervisorPresent, &Caps, sizeof(Caps));
559	DWORD rcWin = GetLastError();
560	if (FAILED(hrc))
561	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
562	"WHvGetCapability/WHvCapabilityCodeHypervisorPresent failed: %Rhrc (Last=%#x/%u)",
563	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
564	if (!Caps.HypervisorPresent)
565	{
566	if (!RTPathExists(RTPATH_NT_PASSTHRU_PREFIX "Device\\VidExo"))
567	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE,
568	"WHvCapabilityCodeHypervisorPresent is FALSE! Make sure you have enabled the 'Windows Hypervisor Platform' feature.");
569	return RTErrInfoSetF(pErrInfo, VERR_NEM_NOT_AVAILABLE, "WHvCapabilityCodeHypervisorPresent is FALSE! (%u)", rcWin);
570	}
571	LogRel(("NEM: WHvCapabilityCodeHypervisorPresent is TRUE, so this might work...\n"));
572
573
574	/*
575	* Check what extended VM exits are supported.
576	*/
577	RT_ZERO(Caps);
578	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeExtendedVmExits, &Caps, sizeof(Caps));
579	if (FAILED(hrc))
580	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
581	"WHvGetCapability/WHvCapabilityCodeExtendedVmExits failed: %Rhrc (Last=%#x/%u)",
582	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
583	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeExtendedVmExits", "%'#018RX64", Caps.ExtendedVmExits.AsUINT64);
584	pVM->nem.s.fExtendedMsrExit = RT_BOOL(Caps.ExtendedVmExits.X64MsrExit);
585	pVM->nem.s.fExtendedCpuIdExit = RT_BOOL(Caps.ExtendedVmExits.X64CpuidExit);
586	pVM->nem.s.fExtendedXcptExit = RT_BOOL(Caps.ExtendedVmExits.ExceptionExit);
587	NEM_LOG_REL_CAP_SUB("fExtendedMsrExit", pVM->nem.s.fExtendedMsrExit);
588	NEM_LOG_REL_CAP_SUB("fExtendedCpuIdExit", pVM->nem.s.fExtendedCpuIdExit);
589	NEM_LOG_REL_CAP_SUB("fExtendedXcptExit", pVM->nem.s.fExtendedXcptExit);
590	if (Caps.ExtendedVmExits.AsUINT64 & ~(uint64_t)7)
591	LogRel(("NEM: Warning! Unknown VM exit definitions: %#RX64\n", Caps.ExtendedVmExits.AsUINT64));
592	/** @todo RECHECK: WHV_EXTENDED_VM_EXITS typedef. */
593
594	/*
595	* Check features in case they end up defining any.
596	*/
597	RT_ZERO(Caps);
598	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeFeatures, &Caps, sizeof(Caps));
599	if (FAILED(hrc))
600	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
601	"WHvGetCapability/WHvCapabilityCodeFeatures failed: %Rhrc (Last=%#x/%u)",
602	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
603	if (Caps.Features.AsUINT64 & ~(uint64_t)0)
604	LogRel(("NEM: Warning! Unknown feature definitions: %#RX64\n", Caps.Features.AsUINT64));
605	/** @todo RECHECK: WHV_CAPABILITY_FEATURES typedef. */
606
607	/*
608	* Check supported exception exit bitmap bits.
609	* We don't currently require this, so we just log failure.
610	*/
611	RT_ZERO(Caps);
612	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeExceptionExitBitmap, &Caps, sizeof(Caps));
613	if (SUCCEEDED(hrc))
614	LogRel(("NEM: Warning! Supported exception exit bitmap: %#RX64\n", Caps.Features.AsUINT64));
615	else
616	LogRel(("NEM: Warning! WHvGetCapability/WHvCapabilityCodeExceptionExitBitmap failed: %Rhrc (Last=%#x/%u)",
617	hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
618
619	/*
620	* Check that the CPU vendor is supported.
621	*/
622	RT_ZERO(Caps);
623	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeProcessorVendor, &Caps, sizeof(Caps));
624	if (FAILED(hrc))
625	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
626	"WHvGetCapability/WHvCapabilityCodeProcessorVendor failed: %Rhrc (Last=%#x/%u)",
627	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
628	switch (Caps.ProcessorVendor)
629	{
630	/** @todo RECHECK: WHV_PROCESSOR_VENDOR typedef. */
631	case WHvProcessorVendorIntel:
632	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorVendor", "%d - Intel", Caps.ProcessorVendor);
633	pVM->nem.s.enmCpuVendor = CPUMCPUVENDOR_INTEL;
634	break;
635	case WHvProcessorVendorAmd:
636	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorVendor", "%d - AMD", Caps.ProcessorVendor);
637	pVM->nem.s.enmCpuVendor = CPUMCPUVENDOR_AMD;
638	break;
639	default:
640	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorVendor", "%d", Caps.ProcessorVendor);
641	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Unknown processor vendor: %d", Caps.ProcessorVendor);
642	}
643
644	/*
645	* CPU features, guessing these are virtual CPU features?
646	*/
647	RT_ZERO(Caps);
648	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeProcessorFeatures, &Caps, sizeof(Caps));
649	if (FAILED(hrc))
650	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
651	"WHvGetCapability/WHvCapabilityCodeProcessorFeatures failed: %Rhrc (Last=%#x/%u)",
652	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
653	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorFeatures", "%'#018RX64", Caps.ProcessorFeatures.AsUINT64);
654	#define NEM_LOG_REL_CPU_FEATURE(a_Field) NEM_LOG_REL_CAP_SUB(#a_Field, Caps.ProcessorFeatures.a_Field)
655	NEM_LOG_REL_CPU_FEATURE(Sse3Support);
656	NEM_LOG_REL_CPU_FEATURE(LahfSahfSupport);
657	NEM_LOG_REL_CPU_FEATURE(Ssse3Support);
658	NEM_LOG_REL_CPU_FEATURE(Sse4_1Support);
659	NEM_LOG_REL_CPU_FEATURE(Sse4_2Support);
660	NEM_LOG_REL_CPU_FEATURE(Sse4aSupport);
661	NEM_LOG_REL_CPU_FEATURE(XopSupport);
662	NEM_LOG_REL_CPU_FEATURE(PopCntSupport);
663	NEM_LOG_REL_CPU_FEATURE(Cmpxchg16bSupport);
664	NEM_LOG_REL_CPU_FEATURE(Altmovcr8Support);
665	NEM_LOG_REL_CPU_FEATURE(LzcntSupport);
666	NEM_LOG_REL_CPU_FEATURE(MisAlignSseSupport);
667	NEM_LOG_REL_CPU_FEATURE(MmxExtSupport);
668	NEM_LOG_REL_CPU_FEATURE(Amd3DNowSupport);
669	NEM_LOG_REL_CPU_FEATURE(ExtendedAmd3DNowSupport);
670	NEM_LOG_REL_CPU_FEATURE(Page1GbSupport);
671	NEM_LOG_REL_CPU_FEATURE(AesSupport);
672	NEM_LOG_REL_CPU_FEATURE(PclmulqdqSupport);
673	NEM_LOG_REL_CPU_FEATURE(PcidSupport);
674	NEM_LOG_REL_CPU_FEATURE(Fma4Support);
675	NEM_LOG_REL_CPU_FEATURE(F16CSupport);
676	NEM_LOG_REL_CPU_FEATURE(RdRandSupport);
677	NEM_LOG_REL_CPU_FEATURE(RdWrFsGsSupport);
678	NEM_LOG_REL_CPU_FEATURE(SmepSupport);
679	NEM_LOG_REL_CPU_FEATURE(EnhancedFastStringSupport);
680	NEM_LOG_REL_CPU_FEATURE(Bmi1Support);
681	NEM_LOG_REL_CPU_FEATURE(Bmi2Support);
682	/* two reserved bits here, see below */
683	NEM_LOG_REL_CPU_FEATURE(MovbeSupport);
684	NEM_LOG_REL_CPU_FEATURE(Npiep1Support);
685	NEM_LOG_REL_CPU_FEATURE(DepX87FPUSaveSupport);
686	NEM_LOG_REL_CPU_FEATURE(RdSeedSupport);
687	NEM_LOG_REL_CPU_FEATURE(AdxSupport);
688	NEM_LOG_REL_CPU_FEATURE(IntelPrefetchSupport);
689	NEM_LOG_REL_CPU_FEATURE(SmapSupport);
690	NEM_LOG_REL_CPU_FEATURE(HleSupport);
691	NEM_LOG_REL_CPU_FEATURE(RtmSupport);
692	NEM_LOG_REL_CPU_FEATURE(RdtscpSupport);
693	NEM_LOG_REL_CPU_FEATURE(ClflushoptSupport);
694	NEM_LOG_REL_CPU_FEATURE(ClwbSupport);
695	NEM_LOG_REL_CPU_FEATURE(ShaSupport);
696	NEM_LOG_REL_CPU_FEATURE(X87PointersSavedSupport);
697	#undef NEM_LOG_REL_CPU_FEATURE
698	if (Caps.ProcessorFeatures.AsUINT64 & (~(RT_BIT_64(43) - 1) \| RT_BIT_64(27) \| RT_BIT_64(28)))
699	LogRel(("NEM: Warning! Unknown CPU features: %#RX64\n", Caps.ProcessorFeatures.AsUINT64));
700	pVM->nem.s.uCpuFeatures.u64 = Caps.ProcessorFeatures.AsUINT64;
701	/** @todo RECHECK: WHV_PROCESSOR_FEATURES typedef. */
702
703	/*
704	* The cache line flush size.
705	*/
706	RT_ZERO(Caps);
707	hrc = WHvGetCapabilityWrapper(WHvCapabilityCodeProcessorClFlushSize, &Caps, sizeof(Caps));
708	if (FAILED(hrc))
709	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
710	"WHvGetCapability/WHvCapabilityCodeProcessorClFlushSize failed: %Rhrc (Last=%#x/%u)",
711	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
712	NEM_LOG_REL_CAP_EX("WHvCapabilityCodeProcessorClFlushSize", "2^%u", Caps.ProcessorClFlushSize);
713	if (Caps.ProcessorClFlushSize < 8 && Caps.ProcessorClFlushSize > 9)
714	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Unsupported cache line flush size: %u", Caps.ProcessorClFlushSize);
715	pVM->nem.s.cCacheLineFlushShift = Caps.ProcessorClFlushSize;
716
717	/*
718	* See if they've added more properties that we're not aware of.
719	*/
720	/** @todo RECHECK: WHV_CAPABILITY_CODE typedef. */
721	if (!IsDebuggerPresent()) /* Too noisy when in debugger, so skip. */
722	{
723	static const struct
724	{
725	uint32_t iMin, iMax; } s_aUnknowns[] =
726	{
727	{ 0x0004, 0x000f },
728	{ 0x1003, 0x100f },
729	{ 0x2000, 0x200f },
730	{ 0x3000, 0x300f },
731	{ 0x4000, 0x400f },
732	};
733	for (uint32_t j = 0; j < RT_ELEMENTS(s_aUnknowns); j++)
734	for (uint32_t i = s_aUnknowns[j].iMin; i <= s_aUnknowns[j].iMax; i++)
735	{
736	RT_ZERO(Caps);
737	hrc = WHvGetCapabilityWrapper((WHV_CAPABILITY_CODE)i, &Caps, sizeof(Caps));
738	if (SUCCEEDED(hrc))
739	LogRel(("NEM: Warning! Unknown capability %#x returning: %.*Rhxs\n", i, sizeof(Caps), &Caps));
740	}
741	}
742
743	/*
744	* For proper operation, we require CPUID exits.
745	*/
746	if (!pVM->nem.s.fExtendedCpuIdExit)
747	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Missing required extended CPUID exit support");
748	if (!pVM->nem.s.fExtendedMsrExit)
749	return RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED, "Missing required extended MSR exit support");
750
751	#undef NEM_LOG_REL_CAP_EX
752	#undef NEM_LOG_REL_CAP_SUB_EX
753	#undef NEM_LOG_REL_CAP_SUB
754	return VINF_SUCCESS;
755	}
756
757
758	/**
759	* Used to fill in g_IoCtlGetHvPartitionId.
760	*/
761	static NTSTATUS WINAPI
762	nemR3WinIoctlDetector_GetHvPartitionId(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
763	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
764	PVOID pvOutput, ULONG cbOutput)
765	{
766	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
767	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
768	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
769	AssertLogRelMsgReturn(cbInput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
770	RT_NOREF(pvInput);
771
772	AssertLogRelMsgReturn(RT_VALID_PTR(pvOutput), ("pvOutput=%p\n", pvOutput), STATUS_INVALID_PARAMETER_9);
773	AssertLogRelMsgReturn(cbOutput == sizeof(HV_PARTITION_ID), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
774	(HV_PARTITION_ID )pvOutput = NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_ID;
775
776	g_IoCtlGetHvPartitionId.cbInput = cbInput;
777	g_IoCtlGetHvPartitionId.cbOutput = cbOutput;
778	g_IoCtlGetHvPartitionId.uFunction = uFunction;
779
780	return STATUS_SUCCESS;
781	}
782
783
784	/**
785	* Used to fill in g_IoCtlStartVirtualProcessor.
786	*/
787	static NTSTATUS WINAPI
788	nemR3WinIoctlDetector_StartVirtualProcessor(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
789	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
790	PVOID pvOutput, ULONG cbOutput)
791	{
792	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
793	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
794	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
795	AssertLogRelMsgReturn(cbInput == sizeof(HV_VP_INDEX), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
796	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
797	AssertLogRelMsgReturn((HV_VP_INDEX )pvInput == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
798	("piCpu=%u\n", (HV_VP_INDEX *)pvInput), STATUS_INVALID_PARAMETER_9);
799	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
800	RT_NOREF(pvOutput);
801
802	g_IoCtlStartVirtualProcessor.cbInput = cbInput;
803	g_IoCtlStartVirtualProcessor.cbOutput = cbOutput;
804	g_IoCtlStartVirtualProcessor.uFunction = uFunction;
805
806	return STATUS_SUCCESS;
807	}
808
809
810	/**
811	* Used to fill in g_IoCtlStartVirtualProcessor.
812	*/
813	static NTSTATUS WINAPI
814	nemR3WinIoctlDetector_StopVirtualProcessor(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
815	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
816	PVOID pvOutput, ULONG cbOutput)
817	{
818	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
819	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
820	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
821	AssertLogRelMsgReturn(cbInput == sizeof(HV_VP_INDEX), ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_8);
822	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
823	AssertLogRelMsgReturn((HV_VP_INDEX )pvInput == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
824	("piCpu=%u\n", (HV_VP_INDEX *)pvInput), STATUS_INVALID_PARAMETER_9);
825	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
826	RT_NOREF(pvOutput);
827
828	g_IoCtlStopVirtualProcessor.cbInput = cbInput;
829	g_IoCtlStopVirtualProcessor.cbOutput = cbOutput;
830	g_IoCtlStopVirtualProcessor.uFunction = uFunction;
831
832	return STATUS_SUCCESS;
833	}
834
835
836	/**
837	* Used to fill in g_IoCtlMessageSlotHandleAndGetNext
838	*/
839	static NTSTATUS WINAPI
840	nemR3WinIoctlDetector_MessageSlotHandleAndGetNext(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
841	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
842	PVOID pvOutput, ULONG cbOutput)
843	{
844	AssertLogRelMsgReturn(hFile == NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, ("hFile=%p\n", hFile), STATUS_INVALID_PARAMETER_1);
845	RT_NOREF(hEvt); RT_NOREF(pfnApcCallback); RT_NOREF(pvApcCtx);
846	AssertLogRelMsgReturn(RT_VALID_PTR(pIos), ("pIos=%p\n", pIos), STATUS_INVALID_PARAMETER_5);
847
848	AssertLogRelMsgReturn(cbInput == sizeof(VID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT), ("cbInput=%#x\n", cbInput),
849	STATUS_INVALID_PARAMETER_8);
850	AssertLogRelMsgReturn(RT_VALID_PTR(pvInput), ("pvInput=%p\n", pvInput), STATUS_INVALID_PARAMETER_9);
851	PCVID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT pVidIn = (PCVID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT)pvInput;
852	AssertLogRelMsgReturn( pVidIn->iCpu == NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX
853	&& pVidIn->fFlags == VID_MSHAGN_F_HANDLE_MESSAGE
854	&& pVidIn->cMillies == NEM_WIN_IOCTL_DETECTOR_FAKE_TIMEOUT,
855	("iCpu=%u fFlags=%#x cMillies=%#x\n", pVidIn->iCpu, pVidIn->fFlags, pVidIn->cMillies),
856	STATUS_INVALID_PARAMETER_9);
857	AssertLogRelMsgReturn(cbOutput == 0, ("cbInput=%#x\n", cbInput), STATUS_INVALID_PARAMETER_10);
858	RT_NOREF(pvOutput);
859
860	g_IoCtlMessageSlotHandleAndGetNext.cbInput = cbInput;
861	g_IoCtlMessageSlotHandleAndGetNext.cbOutput = cbOutput;
862	g_IoCtlMessageSlotHandleAndGetNext.uFunction = uFunction;
863
864	return STATUS_SUCCESS;
865	}
866
867
868	#ifdef LOG_ENABLED
869	/**
870	* Used to fill in what g_pIoCtlDetectForLogging points to.
871	*/
872	static NTSTATUS WINAPI nemR3WinIoctlDetector_ForLogging(HANDLE hFile, HANDLE hEvt, PIO_APC_ROUTINE pfnApcCallback, PVOID pvApcCtx,
873	PIO_STATUS_BLOCK pIos, ULONG uFunction, PVOID pvInput, ULONG cbInput,
874	PVOID pvOutput, ULONG cbOutput)
875	{
876	RT_NOREF(hFile, hEvt, pfnApcCallback, pvApcCtx, pIos, pvInput, pvOutput);
877
878	g_pIoCtlDetectForLogging->cbInput = cbInput;
879	g_pIoCtlDetectForLogging->cbOutput = cbOutput;
880	g_pIoCtlDetectForLogging->uFunction = uFunction;
881
882	return STATUS_SUCCESS;
883	}
884	#endif
885
886
887	/**
888	* Worker for nemR3NativeInit that detect I/O control function numbers for VID.
889	*
890	* We use the function numbers directly in ring-0 and to name functions when
891	* logging NtDeviceIoControlFile calls.
892	*
893	* @note We could alternatively do this by disassembling the respective
894	* functions, but hooking NtDeviceIoControlFile and making fake calls
895	* more easily provides the desired information.
896	*
897	* @returns VBox status code.
898	* @param pVM The cross context VM structure. Will set I/O
899	* control info members.
900	* @param pErrInfo Where to always return error info.
901	*/
902	static int nemR3WinInitDiscoverIoControlProperties(PVM pVM, PRTERRINFO pErrInfo)
903	{
904	/*
905	* Probe the I/O control information for select VID APIs so we can use
906	* them directly from ring-0 and better log them.
907	*
908	*/
909	decltype(NtDeviceIoControlFile) * const pfnOrg = *g_ppfnVidNtDeviceIoControlFile;
910
911	/* VidGetHvPartitionId */
912	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_GetHvPartitionId;
913	HV_PARTITION_ID idHvPartition = HV_PARTITION_ID_INVALID;
914	BOOL fRet = g_pfnVidGetHvPartitionId(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, &idHvPartition);
915	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
916	AssertReturn(fRet && idHvPartition == NEM_WIN_IOCTL_DETECTOR_FAKE_PARTITION_ID && g_IoCtlGetHvPartitionId.uFunction != 0,
917	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
918	"Problem figuring out VidGetHvPartitionId: fRet=%u idHvPartition=%#x dwErr=%u",
919	fRet, idHvPartition, GetLastError()) );
920	LogRel(("NEM: VidGetHvPartitionId -> fun:%#x in:%#x out:%#x\n",
921	g_IoCtlGetHvPartitionId.uFunction, g_IoCtlGetHvPartitionId.cbInput, g_IoCtlGetHvPartitionId.cbOutput));
922
923	/* VidStartVirtualProcessor */
924	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_StartVirtualProcessor;
925	fRet = g_pfnVidStartVirtualProcessor(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX);
926	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
927	AssertReturn(fRet && g_IoCtlStartVirtualProcessor.uFunction != 0,
928	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
929	"Problem figuring out VidStartVirtualProcessor: fRet=%u dwErr=%u",
930	fRet, GetLastError()) );
931	LogRel(("NEM: VidStartVirtualProcessor -> fun:%#x in:%#x out:%#x\n", g_IoCtlStartVirtualProcessor.uFunction,
932	g_IoCtlStartVirtualProcessor.cbInput, g_IoCtlStartVirtualProcessor.cbOutput));
933
934	/* VidStopVirtualProcessor */
935	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_StopVirtualProcessor;
936	fRet = g_pfnVidStopVirtualProcessor(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX);
937	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
938	AssertReturn(fRet && g_IoCtlStopVirtualProcessor.uFunction != 0,
939	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
940	"Problem figuring out VidStopVirtualProcessor: fRet=%u dwErr=%u",
941	fRet, GetLastError()) );
942	LogRel(("NEM: VidStopVirtualProcessor -> fun:%#x in:%#x out:%#x\n", g_IoCtlStopVirtualProcessor.uFunction,
943	g_IoCtlStopVirtualProcessor.cbInput, g_IoCtlStopVirtualProcessor.cbOutput));
944
945	/* VidMessageSlotHandleAndGetNext */
946	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_MessageSlotHandleAndGetNext;
947	fRet = g_pfnVidMessageSlotHandleAndGetNext(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE,
948	NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX, VID_MSHAGN_F_HANDLE_MESSAGE,
949	NEM_WIN_IOCTL_DETECTOR_FAKE_TIMEOUT);
950	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
951	AssertReturn(fRet && g_IoCtlMessageSlotHandleAndGetNext.uFunction != 0,
952	RTErrInfoSetF(pErrInfo, VERR_NEM_INIT_FAILED,
953	"Problem figuring out VidMessageSlotHandleAndGetNext: fRet=%u dwErr=%u",
954	fRet, GetLastError()) );
955	LogRel(("NEM: VidMessageSlotHandleAndGetNext -> fun:%#x in:%#x out:%#x\n",
956	g_IoCtlMessageSlotHandleAndGetNext.uFunction, g_IoCtlMessageSlotHandleAndGetNext.cbInput,
957	g_IoCtlMessageSlotHandleAndGetNext.cbOutput));
958
959	#ifdef LOG_ENABLED
960	/* The following are only for logging: */
961	union
962	{
963	VID_MAPPED_MESSAGE_SLOT MapSlot;
964	HV_REGISTER_NAME Name;
965	HV_REGISTER_VALUE Value;
966	} uBuf;
967
968	/* VidMessageSlotMap */
969	g_pIoCtlDetectForLogging = &g_IoCtlMessageSlotMap;
970	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_ForLogging;
971	fRet = g_pfnVidMessageSlotMap(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, &uBuf.MapSlot, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX);
972	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
973	Assert(fRet);
974	LogRel(("NEM: VidMessageSlotMap -> fun:%#x in:%#x out:%#x\n", g_pIoCtlDetectForLogging->uFunction,
975	g_pIoCtlDetectForLogging->cbInput, g_pIoCtlDetectForLogging->cbOutput));
976
977	/* VidGetVirtualProcessorState */
978	uBuf.Name = HvRegisterExplicitSuspend;
979	g_pIoCtlDetectForLogging = &g_IoCtlGetVirtualProcessorState;
980	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_ForLogging;
981	fRet = g_pfnVidGetVirtualProcessorState(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
982	&uBuf.Name, 1, &uBuf.Value);
983	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
984	Assert(fRet);
985	LogRel(("NEM: VidGetVirtualProcessorState -> fun:%#x in:%#x out:%#x\n", g_pIoCtlDetectForLogging->uFunction,
986	g_pIoCtlDetectForLogging->cbInput, g_pIoCtlDetectForLogging->cbOutput));
987
988	/* VidSetVirtualProcessorState */
989	uBuf.Name = HvRegisterExplicitSuspend;
990	g_pIoCtlDetectForLogging = &g_IoCtlSetVirtualProcessorState;
991	*g_ppfnVidNtDeviceIoControlFile = nemR3WinIoctlDetector_ForLogging;
992	fRet = g_pfnVidSetVirtualProcessorState(NEM_WIN_IOCTL_DETECTOR_FAKE_HANDLE, NEM_WIN_IOCTL_DETECTOR_FAKE_VP_INDEX,
993	&uBuf.Name, 1, &uBuf.Value);
994	*g_ppfnVidNtDeviceIoControlFile = pfnOrg;
995	Assert(fRet);
996	LogRel(("NEM: VidSetVirtualProcessorState -> fun:%#x in:%#x out:%#x\n", g_pIoCtlDetectForLogging->uFunction,
997	g_pIoCtlDetectForLogging->cbInput, g_pIoCtlDetectForLogging->cbOutput));
998
999	g_pIoCtlDetectForLogging = NULL;
1000	#endif
1001
1002	/* Done. */
1003	pVM->nem.s.IoCtlGetHvPartitionId = g_IoCtlGetHvPartitionId;
1004	pVM->nem.s.IoCtlStartVirtualProcessor = g_IoCtlStartVirtualProcessor;
1005	pVM->nem.s.IoCtlStopVirtualProcessor = g_IoCtlStopVirtualProcessor;
1006	pVM->nem.s.IoCtlMessageSlotHandleAndGetNext = g_IoCtlMessageSlotHandleAndGetNext;
1007	return VINF_SUCCESS;
1008	}
1009
1010
1011	/**
1012	* Creates and sets up a Hyper-V (exo) partition.
1013	*
1014	* @returns VBox status code.
1015	* @param pVM The cross context VM structure.
1016	* @param pErrInfo Where to always return error info.
1017	*/
1018	static int nemR3WinInitCreatePartition(PVM pVM, PRTERRINFO pErrInfo)
1019	{
1020	AssertReturn(!pVM->nem.s.hPartition, RTErrInfoSet(pErrInfo, VERR_WRONG_ORDER, "Wrong initalization order"));
1021	AssertReturn(!pVM->nem.s.hPartitionDevice, RTErrInfoSet(pErrInfo, VERR_WRONG_ORDER, "Wrong initalization order"));
1022
1023	/*
1024	* Create the partition.
1025	*/
1026	WHV_PARTITION_HANDLE hPartition;
1027	HRESULT hrc = WHvCreatePartition(&hPartition);
1028	if (FAILED(hrc))
1029	return RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED, "WHvCreatePartition failed with %Rhrc (Last=%#x/%u)",
1030	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1031
1032	int rc;
1033
1034	/*
1035	* Set partition properties, most importantly the CPU count.
1036	*/
1037	/**
1038	* @todo Someone at Microsoft please explain another weird API:
1039	* - Why this API doesn't take the WHV_PARTITION_PROPERTY_CODE value as an
1040	* argument rather than as part of the struct. That is so weird if you've
1041	* used any other NT or windows API, including WHvGetCapability().
1042	* - Why use PVOID when WHV_PARTITION_PROPERTY is what's expected. We
1043	* technically only need 9 bytes for setting/getting
1044	* WHVPartitionPropertyCodeProcessorClFlushSize, but the API insists on 16. */
1045	WHV_PARTITION_PROPERTY Property;
1046	RT_ZERO(Property);
1047	Property.ProcessorCount = pVM->cCpus;
1048	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorCount, &Property, sizeof(Property));
1049	if (SUCCEEDED(hrc))
1050	{
1051	RT_ZERO(Property);
1052	Property.ExtendedVmExits.X64CpuidExit = pVM->nem.s.fExtendedCpuIdExit; /** @todo Register fixed results and restrict cpuid exits */
1053	Property.ExtendedVmExits.X64MsrExit = pVM->nem.s.fExtendedMsrExit;
1054	#if 0 /** @todo handle some MSRs too. */
1055	Property.ExtendedVmExits.ExceptionExit = pVM->nem.s.fExtendedXcptExit;
1056	#endif
1057	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeExtendedVmExits, &Property, sizeof(Property));
1058	if (SUCCEEDED(hrc))
1059	{
1060	/*
1061	* We'll continue setup in nemR3NativeInitAfterCPUM.
1062	*/
1063	pVM->nem.s.fCreatedEmts = false;
1064	pVM->nem.s.hPartition = hPartition;
1065	LogRel(("NEM: Created partition %p.\n", hPartition));
1066	return VINF_SUCCESS;
1067	}
1068
1069	rc = RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED,
1070	"Failed setting WHvPartitionPropertyCodeExtendedVmExits to %'#RX64: %Rhrc",
1071	Property.ExtendedVmExits.AsUINT64, hrc);
1072	}
1073	else
1074	rc = RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED,
1075	"Failed setting WHvPartitionPropertyCodeProcessorCount to %u: %Rhrc (Last=%#x/%u)",
1076	pVM->cCpus, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1077	WHvDeletePartition(hPartition);
1078
1079	Assert(!pVM->nem.s.hPartitionDevice);
1080	Assert(!pVM->nem.s.hPartition);
1081	return rc;
1082	}
1083
1084
1085	/**
1086	* Try initialize the native API.
1087	*
1088	* This may only do part of the job, more can be done in
1089	* nemR3NativeInitAfterCPUM() and nemR3NativeInitCompleted().
1090	*
1091	* @returns VBox status code.
1092	* @param pVM The cross context VM structure.
1093	* @param fFallback Whether we're in fallback mode or use-NEM mode. In
1094	* the latter we'll fail if we cannot initialize.
1095	* @param fForced Whether the HMForced flag is set and we should
1096	* fail if we cannot initialize.
1097	*/
1098	int nemR3NativeInit(PVM pVM, bool fFallback, bool fForced)
1099	{
1100	g_uBuildNo = RTSystemGetNtBuildNo();
1101
1102	/*
1103	* Some state init.
1104	*/
1105	for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1106	{
1107	PNEMCPU pNemCpu = &pVM->aCpus[iCpu].nem.s;
1108	pNemCpu->uPendingApicBase = UINT64_MAX;
1109	}
1110
1111	/*
1112	* Error state.
1113	* The error message will be non-empty on failure and 'rc' will be set too.
1114	*/
1115	RTERRINFOSTATIC ErrInfo;
1116	PRTERRINFO pErrInfo = RTErrInfoInitStatic(&ErrInfo);
1117	int rc = nemR3WinInitProbeAndLoad(fForced, pErrInfo);
1118	if (RT_SUCCESS(rc))
1119	{
1120	/*
1121	* Check the capabilties of the hypervisor, starting with whether it's present.
1122	*/
1123	rc = nemR3WinInitCheckCapabilities(pVM, pErrInfo);
1124	if (RT_SUCCESS(rc))
1125	{
1126	/*
1127	* Discover the VID I/O control function numbers we need.
1128	*/
1129	rc = nemR3WinInitDiscoverIoControlProperties(pVM, pErrInfo);
1130	if (RT_SUCCESS(rc))
1131	{
1132	/*
1133	* Check out our ring-0 capabilities.
1134	*/
1135	rc = SUPR3CallVMMR0Ex(pVM->pVMR0, 0 /idCpu/, VMMR0_DO_NEM_INIT_VM, 0, NULL);
1136	if (RT_SUCCESS(rc))
1137	{
1138	/*
1139	* Create and initialize a partition.
1140	*/
1141	rc = nemR3WinInitCreatePartition(pVM, pErrInfo);
1142	if (RT_SUCCESS(rc))
1143	{
1144	VM_SET_MAIN_EXECUTION_ENGINE(pVM, VM_EXEC_ENGINE_NATIVE_API);
1145	Log(("NEM: Marked active!\n"));
1146
1147	/* Register release statistics */
1148	for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1149	{
1150	PNEMCPU pNemCpu = &pVM->aCpus[iCpu].nem.s;
1151	STAMR3RegisterF(pVM, &pNemCpu->StatExitPortIo, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of port I/O exits", "/NEM/CPU%u/ExitPortIo", iCpu);
1152	STAMR3RegisterF(pVM, &pNemCpu->StatExitMemUnmapped, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of unmapped memory exits", "/NEM/CPU%u/ExitMemUnmapped", iCpu);
1153	STAMR3RegisterF(pVM, &pNemCpu->StatExitMemIntercept, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of intercepted memory exits", "/NEM/CPU%u/ExitMemIntercept", iCpu);
1154	STAMR3RegisterF(pVM, &pNemCpu->StatExitHalt, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of HLT exits", "/NEM/CPU%u/ExitHalt", iCpu);
1155	STAMR3RegisterF(pVM, &pNemCpu->StatExitInterruptWindow, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of HLT exits", "/NEM/CPU%u/ExitInterruptWindow", iCpu);
1156	STAMR3RegisterF(pVM, &pNemCpu->StatExitCpuId, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of CPUID exits", "/NEM/CPU%u/ExitCpuId", iCpu);
1157	STAMR3RegisterF(pVM, &pNemCpu->StatExitMsr, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of MSR access exits", "/NEM/CPU%u/ExitMsr", iCpu);
1158	STAMR3RegisterF(pVM, &pNemCpu->StatExitUnrecoverable, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of unrecoverable exits", "/NEM/CPU%u/ExitUnrecoverable", iCpu);
1159	STAMR3RegisterF(pVM, &pNemCpu->StatGetMsgTimeout, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of get message timeouts/alerts", "/NEM/CPU%u/GetMsgTimeout", iCpu);
1160	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuSuccess, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of successful CPU stops", "/NEM/CPU%u/StopCpuSuccess", iCpu);
1161	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuPending, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pending CPU stops", "/NEM/CPU%u/StopCpuPending", iCpu);
1162	STAMR3RegisterF(pVM, &pNemCpu->StatCancelChangedState, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel changed state", "/NEM/CPU%u/CancelChangedState", iCpu);
1163	STAMR3RegisterF(pVM, &pNemCpu->StatCancelAlertedThread, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel alerted EMT", "/NEM/CPU%u/CancelAlertedEMT", iCpu);
1164	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnFFPre, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pre execution FF breaks", "/NEM/CPU%u/BreakOnFFPre", iCpu);
1165	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnFFPost, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of post execution FF breaks", "/NEM/CPU%u/BreakOnFFPost", iCpu);
1166	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnCancel, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel execution breaks", "/NEM/CPU%u/BreakOnCancel", iCpu);
1167	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnStatus, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of status code breaks", "/NEM/CPU%u/BreakOnStatus", iCpu);
1168	}
1169
1170	PUVM pUVM = pVM->pUVM;
1171	STAMR3RegisterRefresh(pUVM, &pVM->nem.s.R0Stats.cPagesAvailable, STAMTYPE_U64, STAMVISIBILITY_ALWAYS,
1172	STAMUNIT_PAGES, STAM_REFRESH_GRP_NEM, "Free pages available to the hypervisor",
1173	"/NEM/R0Stats/cPagesAvailable");
1174	STAMR3RegisterRefresh(pUVM, &pVM->nem.s.R0Stats.cPagesInUse, STAMTYPE_U64, STAMVISIBILITY_ALWAYS,
1175	STAMUNIT_PAGES, STAM_REFRESH_GRP_NEM, "Pages in use by hypervisor",
1176	"/NEM/R0Stats/cPagesInUse");
1177	}
1178	}
1179	}
1180	}
1181	}
1182
1183	/*
1184	* We only fail if in forced mode, otherwise just log the complaint and return.
1185	*/
1186	Assert(pVM->bMainExecutionEngine == VM_EXEC_ENGINE_NATIVE_API \|\| RTErrInfoIsSet(pErrInfo));
1187	if ( (fForced \|\| !fFallback)
1188	&& pVM->bMainExecutionEngine != VM_EXEC_ENGINE_NATIVE_API)
1189	return VMSetError(pVM, RT_SUCCESS_NP(rc) ? VERR_NEM_NOT_AVAILABLE : rc, RT_SRC_POS, "%s", pErrInfo->pszMsg);
1190
1191	if (RTErrInfoIsSet(pErrInfo))
1192	LogRel(("NEM: Not available: %s\n", pErrInfo->pszMsg));
1193	return VINF_SUCCESS;
1194	}
1195
1196
1197	/**
1198	* This is called after CPUMR3Init is done.
1199	*
1200	* @returns VBox status code.
1201	* @param pVM The VM handle..
1202	*/
1203	int nemR3NativeInitAfterCPUM(PVM pVM)
1204	{
1205	/*
1206	* Validate sanity.
1207	*/
1208	WHV_PARTITION_HANDLE hPartition = pVM->nem.s.hPartition;
1209	AssertReturn(hPartition != NULL, VERR_WRONG_ORDER);
1210	AssertReturn(!pVM->nem.s.hPartitionDevice, VERR_WRONG_ORDER);
1211	AssertReturn(!pVM->nem.s.fCreatedEmts, VERR_WRONG_ORDER);
1212	AssertReturn(pVM->bMainExecutionEngine == VM_EXEC_ENGINE_NATIVE_API, VERR_WRONG_ORDER);
1213
1214	/*
1215	* Continue setting up the partition now that we've got most of the CPUID feature stuff.
1216	*/
1217	WHV_PARTITION_PROPERTY Property;
1218	HRESULT hrc;
1219
1220	#if 0
1221	/* Not sure if we really need to set the vendor.
1222	Update: Apparently we don't. WHvPartitionPropertyCodeProcessorVendor was removed in 17110. */
1223	RT_ZERO(Property);
1224	Property.ProcessorVendor = pVM->nem.s.enmCpuVendor == CPUMCPUVENDOR_AMD ? WHvProcessorVendorAmd
1225	: WHvProcessorVendorIntel;
1226	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorVendor, &Property, sizeof(Property));
1227	if (FAILED(hrc))
1228	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1229	"Failed to set WHvPartitionPropertyCodeProcessorVendor to %u: %Rhrc (Last=%#x/%u)",
1230	Property.ProcessorVendor, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1231	#endif
1232
1233	/* Not sure if we really need to set the cache line flush size. */
1234	RT_ZERO(Property);
1235	Property.ProcessorClFlushSize = pVM->nem.s.cCacheLineFlushShift;
1236	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorClFlushSize, &Property, sizeof(Property));
1237	if (FAILED(hrc))
1238	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1239	"Failed to set WHvPartitionPropertyCodeProcessorClFlushSize to %u: %Rhrc (Last=%#x/%u)",
1240	pVM->nem.s.cCacheLineFlushShift, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1241
1242	/*
1243	* Sync CPU features with CPUM.
1244	*/
1245	/** @todo sync CPU features with CPUM. */
1246
1247	/* Set the partition property. */
1248	RT_ZERO(Property);
1249	Property.ProcessorFeatures.AsUINT64 = pVM->nem.s.uCpuFeatures.u64;
1250	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorFeatures, &Property, sizeof(Property));
1251	if (FAILED(hrc))
1252	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1253	"Failed to set WHvPartitionPropertyCodeProcessorFeatures to %'#RX64: %Rhrc (Last=%#x/%u)",
1254	pVM->nem.s.uCpuFeatures.u64, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1255
1256	/*
1257	* Set up the partition and create EMTs.
1258	*
1259	* Seems like this is where the partition is actually instantiated and we get
1260	* a handle to it.
1261	*/
1262	hrc = WHvSetupPartition(hPartition);
1263	if (FAILED(hrc))
1264	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1265	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)",
1266	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1267
1268	/* Get the handle. */
1269	HANDLE hPartitionDevice;
1270	__try
1271	{
1272	hPartitionDevice = ((HANDLE *)hPartition)[1];
1273	}
1274	__except(EXCEPTION_EXECUTE_HANDLER)
1275	{
1276	hrc = GetExceptionCode();
1277	hPartitionDevice = NULL;
1278	}
1279	if ( hPartitionDevice == NULL
1280	\|\| hPartitionDevice == (HANDLE)(intptr_t)-1)
1281	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1282	"Failed to get device handle for partition %p: %Rhrc", hPartition, hrc);
1283
1284	HV_PARTITION_ID idHvPartition = HV_PARTITION_ID_INVALID;
1285	if (!g_pfnVidGetHvPartitionId(hPartitionDevice, &idHvPartition))
1286	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1287	"Failed to get device handle and/or partition ID for %p (hPartitionDevice=%p, Last=%#x/%u)",
1288	hPartition, hPartitionDevice, RTNtLastStatusValue(), RTNtLastErrorValue());
1289	pVM->nem.s.hPartitionDevice = hPartitionDevice;
1290	pVM->nem.s.idHvPartition = idHvPartition;
1291
1292	/*
1293	* Setup the EMTs.
1294	*/
1295	VMCPUID iCpu;
1296	for (iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1297	{
1298	PVMCPU pVCpu = &pVM->aCpus[iCpu];
1299
1300	pVCpu->nem.s.hNativeThreadHandle = (RTR3PTR)RTThreadGetNativeHandle(VMR3GetThreadHandle(pVCpu->pUVCpu));
1301	Assert((HANDLE)pVCpu->nem.s.hNativeThreadHandle != INVALID_HANDLE_VALUE);
1302
1303	#ifdef NEM_WIN_USE_OUR_OWN_RUN_API
1304	VID_MAPPED_MESSAGE_SLOT MappedMsgSlot = { NULL, UINT32_MAX, UINT32_MAX };
1305	if (g_pfnVidMessageSlotMap(hPartitionDevice, &MappedMsgSlot, iCpu))
1306	{
1307	AssertLogRelMsg(MappedMsgSlot.iCpu == iCpu && MappedMsgSlot.uParentAdvisory == UINT32_MAX,
1308	("%#x %#x (iCpu=%#x)\n", MappedMsgSlot.iCpu, MappedMsgSlot.uParentAdvisory, iCpu));
1309	pVCpu->nem.s.pvMsgSlotMapping = MappedMsgSlot.pMsgBlock;
1310	}
1311	else
1312	{
1313	NTSTATUS const rcNtLast = RTNtLastStatusValue();
1314	DWORD const dwErrLast = RTNtLastErrorValue();
1315	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1316	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)", hrc, rcNtLast, dwErrLast);
1317	}
1318	#else
1319	hrc = WHvCreateVirtualProcessor(hPartition, iCpu, 0 /fFlags/);
1320	if (FAILED(hrc))
1321	{
1322	NTSTATUS const rcNtLast = RTNtLastStatusValue();
1323	DWORD const dwErrLast = RTNtLastErrorValue();
1324	while (iCpu-- > 0)
1325	{
1326	HRESULT hrc2 = WHvDeleteVirtualProcessor(hPartition, iCpu);
1327	AssertLogRelMsg(SUCCEEDED(hrc2), ("WHvDeleteVirtualProcessor(%p, %u) -> %Rhrc (Last=%#x/%u)\n",
1328	hPartition, iCpu, hrc2, RTNtLastStatusValue(),
1329	RTNtLastErrorValue()));
1330	}
1331	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1332	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)", hrc, rcNtLast, dwErrLast);
1333	}
1334	#endif /* !NEM_WIN_USE_OUR_OWN_RUN_API */
1335	}
1336	pVM->nem.s.fCreatedEmts = true;
1337
1338	/*
1339	* Do some more ring-0 initialization now that we've got the partition handle.
1340	*/
1341	int rc = VMMR3CallR0Emt(pVM, &pVM->aCpus[0], VMMR0_DO_NEM_INIT_VM_PART_2, 0, NULL);
1342	if (RT_SUCCESS(rc))
1343	{
1344	LogRel(("NEM: Successfully set up partition (device handle %p, partition ID %#llx)\n", hPartitionDevice, idHvPartition));
1345
1346	#if 1
1347	VMMR3CallR0Emt(pVM, &pVM->aCpus[0], VMMR0_DO_NEM_UPDATE_STATISTICS, 0, NULL);
1348	LogRel(("NEM: Memory balance: %#RX64 out of %#RX64 pages in use\n",
1349	pVM->nem.s.R0Stats.cPagesInUse, pVM->nem.s.R0Stats.cPagesAvailable));
1350	#endif
1351
1352	/*
1353	* Register statistics on shared pages.
1354	*/
1355	/** @todo HvCallMapStatsPage */
1356
1357	/*
1358	* Adjust features.
1359	*/
1360	/** @todo Figure out how to get X2APIC working on AMD (and possible
1361	* intel), but first figure how to disable it dynamically. */
1362	/CPUMR3ClearGuestCpuIdFeature(pVM, CPUMCPUIDFEATURE_X2APIC);/
1363
1364	return VINF_SUCCESS;
1365	}
1366	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS, "Call to NEMR0InitVMPart2 failed: %Rrc", rc);
1367	}
1368
1369
1370	int nemR3NativeInitCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
1371	{
1372	//BOOL fRet = SetThreadPriority(GetCurrentThread(), 0);
1373	//AssertLogRel(fRet);
1374
1375	NOREF(pVM); NOREF(enmWhat);
1376	return VINF_SUCCESS;
1377	}
1378
1379
1380	int nemR3NativeTerm(PVM pVM)
1381	{
1382	/*
1383	* Delete the partition.
1384	*/
1385	WHV_PARTITION_HANDLE hPartition = pVM->nem.s.hPartition;
1386	pVM->nem.s.hPartition = NULL;
1387	pVM->nem.s.hPartitionDevice = NULL;
1388	if (hPartition != NULL)
1389	{
1390	VMCPUID iCpu = pVM->nem.s.fCreatedEmts ? pVM->cCpus : 0;
1391	LogRel(("NEM: Destroying partition %p with its %u VCpus...\n", hPartition, iCpu));
1392	while (iCpu-- > 0)
1393	{
1394	#ifdef NEM_WIN_USE_OUR_OWN_RUN_API
1395	pVM->aCpus[iCpu].nem.s.pvMsgSlotMapping = NULL;
1396	#else
1397	HRESULT hrc = WHvDeleteVirtualProcessor(hPartition, iCpu);
1398	AssertLogRelMsg(SUCCEEDED(hrc), ("WHvDeleteVirtualProcessor(%p, %u) -> %Rhrc (Last=%#x/%u)\n",
1399	hPartition, iCpu, hrc, RTNtLastStatusValue(),
1400	RTNtLastErrorValue()));
1401	#endif
1402	}
1403	WHvDeletePartition(hPartition);
1404	}
1405	pVM->nem.s.fCreatedEmts = false;
1406	return VINF_SUCCESS;
1407	}
1408
1409
1410	/**
1411	* VM reset notification.
1412	*
1413	* @param pVM The cross context VM structure.
1414	*/
1415	void nemR3NativeReset(PVM pVM)
1416	{
1417	/* Unfix the A20 gate. */
1418	pVM->nem.s.fA20Fixed = false;
1419	}
1420
1421
1422	/**
1423	* Reset CPU due to INIT IPI or hot (un)plugging.
1424	*
1425	* @param pVCpu The cross context virtual CPU structure of the CPU being
1426	* reset.
1427	* @param fInitIpi Whether this is the INIT IPI or hot (un)plugging case.
1428	*/
1429	void nemR3NativeResetCpu(PVMCPU pVCpu, bool fInitIpi)
1430	{
1431	/* Lock the A20 gate if INIT IPI, make sure it's enabled. */
1432	if (fInitIpi && pVCpu->idCpu > 0)
1433	{
1434	PVM pVM = pVCpu->CTX_SUFF(pVM);
1435	if (!pVM->nem.s.fA20Enabled)
1436	nemR3NativeNotifySetA20(pVCpu, true);
1437	pVM->nem.s.fA20Enabled = true;
1438	pVM->nem.s.fA20Fixed = true;
1439	}
1440	}
1441
1442	#if 0 //ndef NEM_WIN_USE_OUR_OWN_RUN_API - migrating to NEMAllNativeTemplate-win.cpp.h */
1443
1444	# ifdef LOG_ENABLED
1445	/**
1446	* Log the full details of an exit reason.
1447	*
1448	* @param pExitReason The exit reason to log.
1449	*/
1450	static void nemR3WinLogWHvExitReason(WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1451	{
1452	bool fExitCtx = false;
1453	bool fExitInstr = false;
1454	switch (pExitReason->ExitReason)
1455	{
1456	case WHvRunVpExitReasonMemoryAccess:
1457	Log2(("Exit: Memory access: GCPhys=%RGp GCVirt=%RGv %s %s %s\n",
1458	pExitReason->MemoryAccess.Gpa, pExitReason->MemoryAccess.Gva,
1459	g_apszWHvMemAccesstypes[pExitReason->MemoryAccess.AccessInfo.AccessType],
1460	pExitReason->MemoryAccess.AccessInfo.GpaUnmapped ? "unmapped" : "mapped",
1461	pExitReason->MemoryAccess.AccessInfo.GvaValid ? "" : "invalid-gc-virt"));
1462	AssertMsg(!(pExitReason->MemoryAccess.AccessInfo.AsUINT32 & ~UINT32_C(0xf)),
1463	("MemoryAccess.AccessInfo=%#x\n", pExitReason->MemoryAccess.AccessInfo.AsUINT32));
1464	fExitCtx = fExitInstr = true;
1465	break;
1466
1467	case WHvRunVpExitReasonX64IoPortAccess:
1468	Log2(("Exit: I/O port access: IoPort=%#x LB %u %s%s%s rax=%#RX64 rcx=%#RX64 rsi=%#RX64 rdi=%#RX64\n",
1469	pExitReason->IoPortAccess.PortNumber,
1470	pExitReason->IoPortAccess.AccessInfo.AccessSize,
1471	pExitReason->IoPortAccess.AccessInfo.IsWrite ? "out" : "in",
1472	pExitReason->IoPortAccess.AccessInfo.StringOp ? " string" : "",
1473	pExitReason->IoPortAccess.AccessInfo.RepPrefix ? " rep" : "",
1474	pExitReason->IoPortAccess.Rax,
1475	pExitReason->IoPortAccess.Rcx,
1476	pExitReason->IoPortAccess.Rsi,
1477	pExitReason->IoPortAccess.Rdi));
1478	Log2(("Exit: + ds=%#x:{%#RX64 LB %#RX32, %#x} es=%#x:{%#RX64 LB %#RX32, %#x}\n",
1479	pExitReason->IoPortAccess.Ds.Selector,
1480	pExitReason->IoPortAccess.Ds.Base,
1481	pExitReason->IoPortAccess.Ds.Limit,
1482	pExitReason->IoPortAccess.Ds.Attributes,
1483	pExitReason->IoPortAccess.Es.Selector,
1484	pExitReason->IoPortAccess.Es.Base,
1485	pExitReason->IoPortAccess.Es.Limit,
1486	pExitReason->IoPortAccess.Es.Attributes ));
1487
1488	AssertMsg( pExitReason->IoPortAccess.AccessInfo.AccessSize == 1
1489	\|\| pExitReason->IoPortAccess.AccessInfo.AccessSize == 2
1490	\|\| pExitReason->IoPortAccess.AccessInfo.AccessSize == 4,
1491	("IoPortAccess.AccessInfo.AccessSize=%d\n", pExitReason->IoPortAccess.AccessInfo.AccessSize));
1492	AssertMsg(!(pExitReason->IoPortAccess.AccessInfo.AsUINT32 & ~UINT32_C(0x3f)),
1493	("IoPortAccess.AccessInfo=%#x\n", pExitReason->IoPortAccess.AccessInfo.AsUINT32));
1494	fExitCtx = fExitInstr = true;
1495	break;
1496
1497	# if 0
1498	case WHvRunVpExitReasonUnrecoverableException:
1499	case WHvRunVpExitReasonInvalidVpRegisterValue:
1500	case WHvRunVpExitReasonUnsupportedFeature:
1501	case WHvRunVpExitReasonX64InterruptWindow:
1502	case WHvRunVpExitReasonX64Halt:
1503	case WHvRunVpExitReasonX64MsrAccess:
1504	case WHvRunVpExitReasonX64Cpuid:
1505	case WHvRunVpExitReasonException:
1506	case WHvRunVpExitReasonCanceled:
1507	case WHvRunVpExitReasonAlerted:
1508	WHV_X64_MSR_ACCESS_CONTEXT MsrAccess;
1509	WHV_X64_CPUID_ACCESS_CONTEXT CpuidAccess;
1510	WHV_VP_EXCEPTION_CONTEXT VpException;
1511	WHV_X64_INTERRUPTION_DELIVERABLE_CONTEXT InterruptWindow;
1512	WHV_UNRECOVERABLE_EXCEPTION_CONTEXT UnrecoverableException;
1513	WHV_X64_UNSUPPORTED_FEATURE_CONTEXT UnsupportedFeature;
1514	WHV_RUN_VP_CANCELED_CONTEXT CancelReason;
1515	# endif
1516
1517	case WHvRunVpExitReasonNone:
1518	Log2(("Exit: No reason\n"));
1519	AssertFailed();
1520	break;
1521
1522	default:
1523	Log(("Exit: %#x\n", pExitReason->ExitReason));
1524	break;
1525	}
1526
1527	/*
1528	* Context and maybe instruction details.
1529	*/
1530	if (fExitCtx)
1531	{
1532	const WHV_VP_EXIT_CONTEXT *pVpCtx = &pExitReason->VpContext;
1533	Log2(("Exit: + CS:RIP=%04x:%08RX64 RFLAGS=%06RX64 cbInstr=%u CS={%RX64 L %#RX32, %#x}\n",
1534	pVpCtx->Cs.Selector,
1535	pVpCtx->Rip,
1536	pVpCtx->Rflags,
1537	pVpCtx->InstructionLength,
1538	pVpCtx->Cs.Base, pVpCtx->Cs.Limit, pVpCtx->Cs.Attributes));
1539	Log2(("Exit: + cpl=%d CR0.PE=%d CR0.AM=%d EFER.LMA=%d DebugActive=%d InterruptionPending=%d InterruptShadow=%d\n",
1540	pVpCtx->ExecutionState.Cpl,
1541	pVpCtx->ExecutionState.Cr0Pe,
1542	pVpCtx->ExecutionState.Cr0Am,
1543	pVpCtx->ExecutionState.EferLma,
1544	pVpCtx->ExecutionState.DebugActive,
1545	pVpCtx->ExecutionState.InterruptionPending,
1546	pVpCtx->ExecutionState.InterruptShadow));
1547	AssertMsg(!(pVpCtx->ExecutionState.AsUINT16 & ~UINT16_C(0x107f)),
1548	("ExecutionState.AsUINT16=%#x\n", pVpCtx->ExecutionState.AsUINT16));
1549
1550	/** @todo Someone at Microsoft please explain why the InstructionBytes fields
1551	* are 16 bytes long, when 15 would've been sufficent and saved 3-7 bytes of
1552	* alignment padding? Intel max length is 15, so is this sSome ARM stuff?
1553	* Aren't ARM
1554	* instructions max 32-bit wide? Confused. */
1555	if (fExitInstr && pExitReason->IoPortAccess.InstructionByteCount > 0)
1556	Log2(("Exit: + Instruction %.*Rhxs\n",
1557	pExitReason->IoPortAccess.InstructionByteCount, &pExitReason->IoPortAccess.InstructionBytes[0]));
1558	}
1559	}
1560	# endif /* LOG_ENABLED */
1561
1562
1563	static VBOXSTRICTRC nemR3WinWHvHandleHalt(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx)
1564	{
1565	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx);
1566	LogFlow(("nemR3WinWHvHandleHalt\n"));
1567	return VINF_EM_HALT;
1568	}
1569
1570
1571	# ifndef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
1572	/**
1573	* @callback_method_impl{FNPGMPHYSNEMENUMCALLBACK,
1574	* Hack to unmap all pages when/before we run into quota (WHv only).}
1575	*/
1576	static DECLCALLBACK(int) nemR3WinWHvUnmapOnePageCallback(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys, uint8_t pu2NemState, void pvUser)
1577	{
1578	RT_NOREF_PV(pvUser);
1579	RT_NOREF_PV(pVCpu);
1580	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, X86_PAGE_SIZE);
1581	if (SUCCEEDED(hrc))
1582	{
1583	Log5(("NEM GPA unmap all: %RGp (cMappedPages=%u)\n", GCPhys, pVM->nem.s.cMappedPages - 1));
1584	*pu2NemState = NEM_WIN_PAGE_STATE_UNMAPPED;
1585	}
1586	else
1587	{
1588	LogRel(("nemR3WinWHvUnmapOnePageCallback: GCPhys=%RGp %s hrc=%Rhrc (%#x) Last=%#x/%u (cMappedPages=%u)\n",
1589	GCPhys, g_apszPageStates[*pu2NemState], hrc, hrc, RTNtLastStatusValue(),
1590	RTNtLastErrorValue(), pVM->nem.s.cMappedPages));
1591	*pu2NemState = NEM_WIN_PAGE_STATE_NOT_SET;
1592	}
1593	if (pVM->nem.s.cMappedPages > 0)
1594	ASMAtomicDecU32(&pVM->nem.s.cMappedPages);
1595	return VINF_SUCCESS;
1596	}
1597	# endif /* !NEM_WIN_USE_HYPERCALLS_FOR_PAGES */
1598
1599
1600	/**
1601	* Handles an memory access VMEXIT.
1602	*
1603	* This can be triggered by a number of things.
1604	*
1605	* @returns Strict VBox status code.
1606	* @param pVM The cross context VM structure.
1607	* @param pVCpu The cross context virtual CPU structure.
1608	* @param pCtx The CPU context to update.
1609	* @param pMemCtx The exit reason information.
1610	* @param pVpContext The processor context info associated with the exit.
1611	*/
1612	static VBOXSTRICTRC nemR3WinWHvHandleMemoryAccess(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_MEMORY_ACCESS_CONTEXT const *pMemCtx,
1613	WHV_VP_EXIT_CONTEXT const *pVpContext)
1614	{
1615	/*
1616	* Ask PGM for information about the given GCPhys. We need to check if we're
1617	* out of sync first.
1618	*/
1619	NEMHCWINHMACPCCSTATE State = { pMemCtx->AccessInfo.AccessType == WHvMemoryAccessWrite, false, false };
1620	PGMPHYSNEMPAGEINFO Info;
1621	int rc = PGMPhysNemPageInfoChecker(pVM, pVCpu, pMemCtx->Gpa, State.fWriteAccess, &Info,
1622	nemHCWinHandleMemoryAccessPageCheckerCallback, &State);
1623	if (RT_SUCCESS(rc))
1624	{
1625	if (Info.fNemProt & (pMemCtx->AccessInfo.AccessType == WHvMemoryAccessWrite ? NEM_PAGE_PROT_WRITE : NEM_PAGE_PROT_READ))
1626	{
1627	if (State.fCanResume)
1628	{
1629	Log4(("MemExit: %RGp (=>%RHp) %s fProt=%u%s%s%s; restarting (%s)\n",
1630	pMemCtx->Gpa, Info.HCPhys, g_apszPageStates[Info.u2NemState], Info.fNemProt,
1631	Info.fHasHandlers ? " handlers" : "", Info.fZeroPage ? " zero-pg" : "",
1632	State.fDidSomething ? "" : " no-change", g_apszWHvMemAccesstypes[pMemCtx->AccessInfo.AccessType]));
1633	return VINF_SUCCESS;
1634	}
1635	}
1636	Log4(("MemExit: %RGp (=>%RHp) %s fProt=%u%s%s%s; emulating (%s)\n",
1637	pMemCtx->Gpa, Info.HCPhys, g_apszPageStates[Info.u2NemState], Info.fNemProt,
1638	Info.fHasHandlers ? " handlers" : "", Info.fZeroPage ? " zero-pg" : "",
1639	State.fDidSomething ? "" : " no-change", g_apszWHvMemAccesstypes[pMemCtx->AccessInfo.AccessType]));
1640	}
1641	else
1642	Log4(("MemExit: %RGp rc=%Rrc%s; emulating (%s)\n", pMemCtx->Gpa, rc,
1643	State.fDidSomething ? " modified-backing" : "", g_apszWHvMemAccesstypes[pMemCtx->AccessInfo.AccessType]));
1644
1645	/*
1646	* Emulate the memory access, either access handler or special memory.
1647	*/
1648	rc = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM);
1649	AssertRCReturn(rc, rc);
1650
1651	VBOXSTRICTRC rcStrict;
1652	if (pMemCtx->InstructionByteCount > 0)
1653	rcStrict = IEMExecOneWithPrefetchedByPC(pVCpu, CPUMCTX2CORE(pCtx), pVpContext->Rip,
1654	&pMemCtx->InstructionBytes[0], pMemCtx->InstructionByteCount);
1655	else
1656	rcStrict = IEMExecOne(pVCpu);
1657	/** @todo do we need to do anything wrt debugging here? */
1658	return rcStrict;
1659	}
1660
1661
1662	/**
1663	* Handles an I/O port access VMEXIT.
1664	*
1665	* We ASSUME that the hypervisor has don't I/O port access control.
1666	*
1667	* @returns Strict VBox status code.
1668	* @param pVM The cross context VM structure.
1669	* @param pVCpu The cross context virtual CPU structure.
1670	* @param pCtx The CPU context to update.
1671	* @param pIoPortCtx The exit reason information.
1672	* @param pVpContext The processor context info associated with the exit.
1673	*/
1674	static VBOXSTRICTRC
1675	nemR3WinWHvHandleIoPortAccess(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_X64_IO_PORT_ACCESS_CONTEXT const *pIoPortCtx,
1676	WHV_VP_EXIT_CONTEXT const *pVpContext)
1677	{
1678	Assert( pIoPortCtx->AccessInfo.AccessSize == 1
1679	\|\| pIoPortCtx->AccessInfo.AccessSize == 2
1680	\|\| pIoPortCtx->AccessInfo.AccessSize == 4);
1681
1682	VBOXSTRICTRC rcStrict;
1683	if (!pIoPortCtx->AccessInfo.StringOp)
1684	{
1685	/*
1686	* Simple port I/O.
1687	*/
1688	//Assert(pCtx->rax == pIoPortCtx->Rax); - sledgehammer
1689
1690	static uint32_t const s_fAndMask[8] =
1691	{ UINT32_MAX, UINT32_C(0xff), UINT32_C(0xffff), UINT32_MAX, UINT32_MAX, UINT32_MAX, UINT32_MAX, UINT32_MAX };
1692	uint32_t const fAndMask = s_fAndMask[pIoPortCtx->AccessInfo.AccessSize];
1693	if (pIoPortCtx->AccessInfo.IsWrite)
1694	{
1695	rcStrict = IOMIOPortWrite(pVM, pVCpu, pIoPortCtx->PortNumber, (uint32_t)pIoPortCtx->Rax & fAndMask,
1696	pIoPortCtx->AccessInfo.AccessSize);
1697	if (IOM_SUCCESS(rcStrict))
1698	nemR3WinAdvanceGuestRipAndClearRF(pVCpu, pCtx, pVpContext);
1699	}
1700	else
1701	{
1702	uint32_t uValue = 0;
1703	rcStrict = IOMIOPortRead(pVM, pVCpu, pIoPortCtx->PortNumber, &uValue,
1704	pIoPortCtx->AccessInfo.AccessSize);
1705	if (IOM_SUCCESS(rcStrict))
1706	{
1707	pCtx->eax = (pCtx->eax & ~fAndMask) \| (uValue & fAndMask);
1708	nemR3WinAdvanceGuestRipAndClearRF(pVCpu, pCtx, pVpContext);
1709	}
1710	}
1711	}
1712	else
1713	{
1714	/*
1715	* String port I/O.
1716	*/
1717	/** @todo Someone at Microsoft please explain how we can get the address mode
1718	* from the IoPortAccess.VpContext. CS.Attributes is only sufficient for
1719	* getting the default mode, it can always be overridden by a prefix. This
1720	* forces us to interpret the instruction from opcodes, which is suboptimal.
1721	* Both AMD-V and VT-x includes the address size in the exit info, at least on
1722	* CPUs that are reasonably new. */
1723	# if 0 // requires sledgehammer
1724	Assert( pIoPortCtx->Ds.Base == pCtx->ds.u64Base
1725	&& pIoPortCtx->Ds.Limit == pCtx->ds.u32Limit
1726	&& pIoPortCtx->Ds.Selector == pCtx->ds.Sel);
1727	Assert( pIoPortCtx->Es.Base == pCtx->es.u64Base
1728	&& pIoPortCtx->Es.Limit == pCtx->es.u32Limit
1729	&& pIoPortCtx->Es.Selector == pCtx->es.Sel);
1730	Assert(pIoPortCtx->Rdi == pCtx->rdi);
1731	Assert(pIoPortCtx->Rsi == pCtx->rsi);
1732	Assert(pIoPortCtx->Rcx == pCtx->rcx);
1733	Assert(pIoPortCtx->Rcx == pCtx->rcx);
1734	# endif
1735
1736	int rc = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM);
1737	AssertRCReturn(rc, rc);
1738
1739	rcStrict = IEMExecOne(pVCpu);
1740	}
1741	if (IOM_SUCCESS(rcStrict))
1742	{
1743	/*
1744	* Do debug checks.
1745	*/
1746	if ( pVpContext->ExecutionState.DebugActive /** @todo Microsoft: Does DebugActive this only reflext DR7? */
1747	\|\| (pVpContext->Rflags & X86_EFL_TF)
1748	\|\| DBGFBpIsHwIoArmed(pVM) )
1749	{
1750	/** @todo Debugging. */
1751	}
1752	}
1753	return rcStrict;
1754	}
1755
1756
1757	static VBOXSTRICTRC nemR3WinWHvHandleInterruptWindow(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1758	{
1759	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1760	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1761	}
1762
1763
1764	static VBOXSTRICTRC nemR3WinWHvHandleMsrAccess(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1765	{
1766	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1767	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1768	}
1769
1770
1771	static VBOXSTRICTRC nemR3WinWHvHandleCpuId(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1772	{
1773	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1774	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1775	}
1776
1777
1778	static VBOXSTRICTRC nemR3WinWHvHandleException(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1779	{
1780	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1781	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1782	}
1783
1784
1785	static VBOXSTRICTRC nemR3WinWHvHandleUD(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1786	{
1787	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1788	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1789	}
1790
1791
1792	static VBOXSTRICTRC nemR3WinWHvHandleTripleFault(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1793	{
1794	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1795	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1796	}
1797
1798
1799	static VBOXSTRICTRC nemR3WinWHvHandleInvalidState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1800	{
1801	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1802	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1803	}
1804
1805
1806	VBOXSTRICTRC nemR3WinWHvRunGC(PVM pVM, PVMCPU pVCpu)
1807	{
1808	# ifdef LOG_ENABLED
1809	if (LogIs3Enabled())
1810	{
1811	Log3(("nemR3NativeRunGC: Entering #%u\n", pVCpu->idCpu));
1812	nemHCWinLogState(pVM, pVCpu);
1813	}
1814	# endif
1815
1816	/*
1817	* The run loop.
1818	*/
1819	PCPUMCTX pCtx = CPUMQueryGuestCtxPtr(pVCpu);
1820	const bool fSingleStepping = false; /** @todo get this from somewhere. */
1821	VBOXSTRICTRC rcStrict = VINF_SUCCESS;
1822	for (unsigned iLoop = 0;;iLoop++)
1823	{
1824	/*
1825	* Copy the state.
1826	*/
1827	int rc2 = nemHCWinCopyStateToHyperV(pVM, pVCpu, pCtx);
1828	AssertRCBreakStmt(rc2, rcStrict = rc2);
1829
1830	/*
1831	* Run a bit.
1832	*/
1833	WHV_RUN_VP_EXIT_CONTEXT ExitReason;
1834	RT_ZERO(ExitReason);
1835	if ( !VM_FF_IS_PENDING(pVM, VM_FF_EMT_RENDEZVOUS \| VM_FF_TM_VIRTUAL_SYNC)
1836	&& !VMCPU_FF_IS_PENDING(pVCpu, VMCPU_FF_HM_TO_R3_MASK))
1837	{
1838	Log8(("Calling WHvRunVirtualProcessor\n"));
1839	VMCPU_CMPXCHG_STATE(pVCpu, VMCPUSTATE_STARTED_EXEC_NEM, VMCPUSTATE_STARTED);
1840	HRESULT hrc = WHvRunVirtualProcessor(pVM->nem.s.hPartition, pVCpu->idCpu, &ExitReason, sizeof(ExitReason));
1841	VMCPU_CMPXCHG_STATE(pVCpu, VMCPUSTATE_STARTED, VMCPUSTATE_STARTED_EXEC_NEM);
1842	AssertLogRelMsgBreakStmt(SUCCEEDED(hrc),
1843	("WHvRunVirtualProcessor(%p, %u,,) -> %Rhrc (Last=%#x/%u)\n", pVM->nem.s.hPartition, pVCpu->idCpu,
1844	hrc, RTNtLastStatusValue(), RTNtLastErrorValue()),
1845	rcStrict = VERR_INTERNAL_ERROR);
1846	Log2(("WHvRunVirtualProcessor -> %#x; exit code %#x (%d) (cpu status %u)\n",
1847	hrc, ExitReason.ExitReason, ExitReason.ExitReason, nemHCWinCpuGetRunningStatus(pVCpu) ));
1848	}
1849	else
1850	{
1851	LogFlow(("nemR3NativeRunGC: returning: pending FF (pre exec)\n"));
1852	break;
1853	}
1854
1855	# if 0 /* sledgehammer approach */
1856	/*
1857	* Copy back the state.
1858	*/
1859	rc2 = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, UINT64_MAX);
1860	AssertRCBreakStmt(rc2, rcStrict = rc2);
1861	# endif
1862
1863	# ifdef LOG_ENABLED
1864	/*
1865	* Do some logging.
1866	*/
1867	if (LogIs2Enabled())
1868	nemR3WinLogWHvExitReason(&ExitReason);
1869	if (LogIs3Enabled())
1870	nemHCWinLogState(pVM, pVCpu);
1871	# endif
1872
1873	# if 0 //def VBOX_STRICT - requires sledgehammer
1874	/* Assert that the VpContext field makes sense. */
1875	switch (ExitReason.ExitReason)
1876	{
1877	case WHvRunVpExitReasonMemoryAccess:
1878	case WHvRunVpExitReasonX64IoPortAccess:
1879	case WHvRunVpExitReasonX64MsrAccess:
1880	case WHvRunVpExitReasonX64Cpuid:
1881	case WHvRunVpExitReasonException:
1882	case WHvRunVpExitReasonUnrecoverableException:
1883	Assert( ExitReason.IoPortAccess.VpContext.InstructionLength > 0
1884	\|\| ( ExitReason.ExitReason == WHvRunVpExitReasonMemoryAccess
1885	&& ExitReason.MemoryAccess.AccessInfo.AccessType == WHvMemoryAccessExecute));
1886	Assert(ExitReason.IoPortAccess.VpContext.InstructionLength < 16);
1887	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Cpl == CPUMGetGuestCPL(pVCpu));
1888	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Cr0Pe == RT_BOOL(pCtx->cr0 & X86_CR0_PE));
1889	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Cr0Am == RT_BOOL(pCtx->cr0 & X86_CR0_AM));
1890	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.EferLma == RT_BOOL(pCtx->msrEFER & MSR_K6_EFER_LMA));
1891	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.DebugActive == RT_BOOL(pCtx->dr[7] & X86_DR7_ENABLED_MASK));
1892	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Reserved0 == 0);
1893	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Reserved1 == 0);
1894	Assert(ExitReason.IoPortAccess.VpContext.Rip == pCtx->rip);
1895	Assert(ExitReason.IoPortAccess.VpContext.Rflags == pCtx->rflags.u);
1896	Assert( ExitReason.IoPortAccess.VpContext.Cs.Base == pCtx->cs.u64Base
1897	&& ExitReason.IoPortAccess.VpContext.Cs.Limit == pCtx->cs.u32Limit
1898	&& ExitReason.IoPortAccess.VpContext.Cs.Selector == pCtx->cs.Sel);
1899	break;
1900	default: break; /* shut up compiler. */
1901	}
1902	# endif
1903
1904	/*
1905	* Deal with the exit.
1906	*/
1907	switch (ExitReason.ExitReason)
1908	{
1909	/* Frequent exits: */
1910	case WHvRunVpExitReasonCanceled:
1911	//case WHvRunVpExitReasonAlerted:
1912	rcStrict = VINF_SUCCESS;
1913	break;
1914
1915	case WHvRunVpExitReasonX64Halt:
1916	rcStrict = nemR3WinWHvHandleHalt(pVM, pVCpu, pCtx);
1917	break;
1918
1919	case WHvRunVpExitReasonMemoryAccess:
1920	rcStrict = nemR3WinWHvHandleMemoryAccess(pVM, pVCpu, pCtx, &ExitReason.MemoryAccess, &ExitReason.VpContext);
1921	break;
1922
1923	case WHvRunVpExitReasonX64IoPortAccess:
1924	rcStrict = nemR3WinWHvHandleIoPortAccess(pVM, pVCpu, pCtx, &ExitReason.IoPortAccess, &ExitReason.VpContext);
1925	break;
1926
1927	case WHvRunVpExitReasonX64InterruptWindow:
1928	rcStrict = nemR3WinWHvHandleInterruptWindow(pVM, pVCpu, pCtx, &ExitReason);
1929	break;
1930
1931	case WHvRunVpExitReasonX64MsrAccess: /* needs configuring */
1932	rcStrict = nemR3WinWHvHandleMsrAccess(pVM, pVCpu, pCtx, &ExitReason);
1933	break;
1934
1935	case WHvRunVpExitReasonX64Cpuid: /* needs configuring */
1936	rcStrict = nemR3WinWHvHandleCpuId(pVM, pVCpu, pCtx, &ExitReason);
1937	break;
1938
1939	case WHvRunVpExitReasonException: /* needs configuring */
1940	rcStrict = nemR3WinWHvHandleException(pVM, pVCpu, pCtx, &ExitReason);
1941	break;
1942
1943	/* Unlikely exits: */
1944	case WHvRunVpExitReasonUnsupportedFeature:
1945	rcStrict = nemR3WinWHvHandleUD(pVM, pVCpu, pCtx, &ExitReason);
1946	break;
1947
1948	case WHvRunVpExitReasonUnrecoverableException:
1949	rcStrict = nemR3WinWHvHandleTripleFault(pVM, pVCpu, pCtx, &ExitReason);
1950	break;
1951
1952	case WHvRunVpExitReasonInvalidVpRegisterValue:
1953	rcStrict = nemR3WinWHvHandleInvalidState(pVM, pVCpu, pCtx, &ExitReason);
1954	break;
1955
1956	/* Undesired exits: */
1957	case WHvRunVpExitReasonNone:
1958	default:
1959	AssertLogRelMsgFailed(("Unknown ExitReason: %#x\n", ExitReason.ExitReason));
1960	rcStrict = VERR_INTERNAL_ERROR_3;
1961	break;
1962	}
1963	if (rcStrict != VINF_SUCCESS)
1964	{
1965	LogFlow(("nemR3NativeRunGC: returning: %Rrc\n", VBOXSTRICTRC_VAL(rcStrict)));
1966	break;
1967	}
1968
1969	# ifndef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
1970	/* Hack alert! */
1971	uint32_t const cMappedPages = pVM->nem.s.cMappedPages;
1972	if (cMappedPages < 4000)
1973	{ /* likely */ }
1974	else
1975	{
1976	PGMPhysNemEnumPagesByState(pVM, pVCpu, NEM_WIN_PAGE_STATE_READABLE, nemR3WinWHvUnmapOnePageCallback, NULL);
1977	Log(("nemR3NativeRunGC: Unmapped all; cMappedPages=%u -> %u\n", cMappedPages, pVM->nem.s.cMappedPages));
1978	}
1979	# endif
1980
1981	/* If any FF is pending, return to the EM loops. That's okay for the
1982	current sledgehammer approach. */
1983	if ( VM_FF_IS_PENDING( pVM, !fSingleStepping ? VM_FF_HP_R0_PRE_HM_MASK : VM_FF_HP_R0_PRE_HM_STEP_MASK)
1984	\|\| VMCPU_FF_IS_PENDING(pVCpu, !fSingleStepping ? VMCPU_FF_HP_R0_PRE_HM_MASK : VMCPU_FF_HP_R0_PRE_HM_STEP_MASK) )
1985	{
1986	LogFlow(("nemR3NativeRunGC: returning: pending FF (%#x / %#x)\n", pVM->fGlobalForcedActions, pVCpu->fLocalForcedActions));
1987	break;
1988	}
1989	}
1990
1991
1992	/*
1993	* Copy back the state before returning.
1994	*/
1995	if (pCtx->fExtrn & (CPUMCTX_EXTRN_ALL \| (CPUMCTX_EXTRN_NEM_WIN_MASK & ~CPUMCTX_EXTRN_NEM_WIN_EVENT_INJECT)))
1996	{
1997	int rc2 = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, CPUMCTX_EXTRN_ALL \| CPUMCTX_EXTRN_NEM_WIN_MASK);
1998	if (RT_SUCCESS(rc2))
1999	pCtx->fExtrn = 0;
2000	else if (RT_SUCCESS(rcStrict))
2001	rcStrict = rc2;
2002	}
2003	else
2004	pCtx->fExtrn = 0;
2005
2006	return rcStrict;
2007	}
2008
2009	#endif /* !NEM_WIN_USE_OUR_OWN_RUN_API - migrating to NEMAllNativeTemplate-win.cpp.h*/
2010
2011
2012	VBOXSTRICTRC nemR3NativeRunGC(PVM pVM, PVMCPU pVCpu)
2013	{
2014	#if !defined(NEM_WIN_USE_OUR_OWN_RUN_API) \|\| 0
2015	return nemHCWinRunGC(pVM, pVCpu, NULL /pGVM/, NULL /pGVCpu/);
2016	#else
2017	for (;;)
2018	{
2019	VBOXSTRICTRC rcStrict = VMMR3CallR0EmtFast(pVM, pVCpu, VMMR0_DO_NEM_RUN);
2020	if (RT_SUCCESS(rcStrict))
2021	{
2022	/*
2023	* We deal with VINF_NEM_CHANGE_PGM_MODE, VINF_NEM_FLUSH_TLB and
2024	* VINF_NEM_UPDATE_APIC_BASE here, since we're running the risk of
2025	* getting these while we already got another RC (I/O ports).
2026	*
2027	* The APIC base update and a PGM update can happen at the same time, so
2028	* we don't depend on the status code for that and always checks it first.
2029	*/
2030	/* APIC base: */
2031	if (pVCpu->nem.s.uPendingApicBase != UINT64_MAX)
2032	{
2033	LogFlow(("nemR3NativeRunGC: calling APICSetBaseMsr(,%RX64)...\n", pVCpu->nem.s.uPendingApicBase));
2034	VBOXSTRICTRC rc2 = APICSetBaseMsr(pVCpu, pVCpu->nem.s.uPendingApicBase);
2035	AssertLogRelMsg(rc2 == VINF_SUCCESS, ("rc2=%Rrc [%#RX64]\n", VBOXSTRICTRC_VAL(rc2), pVCpu->nem.s.uPendingApicBase));
2036	pVCpu->nem.s.uPendingApicBase = UINT64_MAX;
2037	}
2038
2039	/* Status codes: */
2040	VBOXSTRICTRC rcPending = pVCpu->nem.s.rcPending;
2041	pVCpu->nem.s.rcPending = VINF_SUCCESS;
2042	if ( rcStrict == VINF_NEM_CHANGE_PGM_MODE
2043	\|\| rcStrict == VINF_PGM_CHANGE_MODE
2044	\|\| rcPending == VINF_NEM_CHANGE_PGM_MODE )
2045	{
2046	LogFlow(("nemR3NativeRunGC: calling PGMChangeMode...\n"));
2047	int rc = PGMChangeMode(pVCpu, CPUMGetGuestCR0(pVCpu), CPUMGetGuestCR4(pVCpu), CPUMGetGuestEFER(pVCpu));
2048	AssertRCReturn(rc, rc);
2049	if (rcStrict == VINF_NEM_CHANGE_PGM_MODE \|\| rcStrict == VINF_NEM_FLUSH_TLB)
2050	{
2051	if ( !VM_FF_IS_PENDING(pVM, VM_FF_HIGH_PRIORITY_POST_MASK \| VM_FF_HP_R0_PRE_HM_MASK)
2052	&& !VMCPU_FF_IS_PENDING(pVCpu, (VMCPU_FF_HIGH_PRIORITY_POST_MASK \| VMCPU_FF_HP_R0_PRE_HM_MASK)
2053	& ~VMCPU_FF_RESUME_GUEST_MASK))
2054	{
2055	VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_RESUME_GUEST_MASK);
2056	continue;
2057	}
2058	rcStrict = VINF_SUCCESS;
2059	}
2060	}
2061	else if (rcStrict == VINF_NEM_FLUSH_TLB \|\| rcPending == VINF_NEM_FLUSH_TLB)
2062	{
2063	LogFlow(("nemR3NativeRunGC: calling PGMFlushTLB...\n"));
2064	int rc = PGMFlushTLB(pVCpu, CPUMGetGuestCR3(pVCpu), true);
2065	AssertRCReturn(rc, rc);
2066	if (rcStrict == VINF_NEM_FLUSH_TLB \|\| rcStrict == VINF_NEM_CHANGE_PGM_MODE)
2067	{
2068	if ( !VM_FF_IS_PENDING(pVM, VM_FF_HIGH_PRIORITY_POST_MASK \| VM_FF_HP_R0_PRE_HM_MASK)
2069	&& !VMCPU_FF_IS_PENDING(pVCpu, (VMCPU_FF_HIGH_PRIORITY_POST_MASK \| VMCPU_FF_HP_R0_PRE_HM_MASK)
2070	& ~VMCPU_FF_RESUME_GUEST_MASK))
2071	{
2072	VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_RESUME_GUEST_MASK);
2073	continue;
2074	}
2075	rcStrict = VINF_SUCCESS;
2076	}
2077	}
2078	else if (rcStrict == VINF_NEM_UPDATE_APIC_BASE \|\| rcPending == VERR_NEM_UPDATE_APIC_BASE)
2079	continue;
2080	else
2081	AssertMsg(rcPending == VINF_SUCCESS, ("rcPending=%Rrc\n", VBOXSTRICTRC_VAL(rcPending) ));
2082	}
2083	LogFlow(("nemR3NativeRunGC: returns %Rrc\n", VBOXSTRICTRC_VAL(rcStrict) ));
2084	return rcStrict;
2085	}
2086	#endif
2087	}
2088
2089
2090	bool nemR3NativeCanExecuteGuest(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx)
2091	{
2092	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx);
2093	return true;
2094	}
2095
2096
2097	bool nemR3NativeSetSingleInstruction(PVM pVM, PVMCPU pVCpu, bool fEnable)
2098	{
2099	NOREF(pVM); NOREF(pVCpu); NOREF(fEnable);
2100	return false;
2101	}
2102
2103
2104	/**
2105	* Forced flag notification call from VMEmt.h.
2106	*
2107	* This is only called when pVCpu is in the VMCPUSTATE_STARTED_EXEC_NEM state.
2108	*
2109	* @param pVM The cross context VM structure.
2110	* @param pVCpu The cross context virtual CPU structure of the CPU
2111	* to be notified.
2112	* @param fFlags Notification flags, VMNOTIFYFF_FLAGS_XXX.
2113	*/
2114	void nemR3NativeNotifyFF(PVM pVM, PVMCPU pVCpu, uint32_t fFlags)
2115	{
2116	#ifdef NEM_WIN_USE_OUR_OWN_RUN_API
2117	nemHCWinCancelRunVirtualProcessor(pVM, pVCpu);
2118	#else
2119	Log8(("nemR3NativeNotifyFF: canceling %u\n", pVCpu->idCpu));
2120	HRESULT hrc = WHvCancelRunVirtualProcessor(pVM->nem.s.hPartition, pVCpu->idCpu, 0);
2121	AssertMsg(SUCCEEDED(hrc), ("WHvCancelRunVirtualProcessor -> hrc=%Rhrc\n", hrc));
2122	RT_NOREF_PV(hrc);
2123	#endif
2124	RT_NOREF_PV(fFlags);
2125	}
2126
2127
2128	DECLINLINE(int) nemR3NativeGCPhys2R3PtrReadOnly(PVM pVM, RTGCPHYS GCPhys, const void **ppv)
2129	{
2130	PGMPAGEMAPLOCK Lock;
2131	int rc = PGMPhysGCPhys2CCPtrReadOnly(pVM, GCPhys, ppv, &Lock);
2132	if (RT_SUCCESS(rc))
2133	PGMPhysReleasePageMappingLock(pVM, &Lock);
2134	return rc;
2135	}
2136
2137
2138	DECLINLINE(int) nemR3NativeGCPhys2R3PtrWriteable(PVM pVM, RTGCPHYS GCPhys, void **ppv)
2139	{
2140	PGMPAGEMAPLOCK Lock;
2141	int rc = PGMPhysGCPhys2CCPtr(pVM, GCPhys, ppv, &Lock);
2142	if (RT_SUCCESS(rc))
2143	PGMPhysReleasePageMappingLock(pVM, &Lock);
2144	return rc;
2145	}
2146
2147
2148	int nemR3NativeNotifyPhysRamRegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb)
2149	{
2150	Log5(("nemR3NativeNotifyPhysRamRegister: %RGp LB %RGp\n", GCPhys, cb));
2151	NOREF(pVM); NOREF(GCPhys); NOREF(cb);
2152	return VINF_SUCCESS;
2153	}
2154
2155
2156	int nemR3NativeNotifyPhysMmioExMap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags, void *pvMmio2)
2157	{
2158	Log5(("nemR3NativeNotifyPhysMmioExMap: %RGp LB %RGp fFlags=%#x pvMmio2=%p\n", GCPhys, cb, fFlags, pvMmio2));
2159	NOREF(pVM); NOREF(GCPhys); NOREF(cb); NOREF(fFlags); NOREF(pvMmio2);
2160	return VINF_SUCCESS;
2161	}
2162
2163
2164	int nemR3NativeNotifyPhysMmioExUnmap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags)
2165	{
2166	Log5(("nemR3NativeNotifyPhysMmioExUnmap: %RGp LB %RGp fFlags=%#x\n", GCPhys, cb, fFlags));
2167	NOREF(pVM); NOREF(GCPhys); NOREF(cb); NOREF(fFlags);
2168	return VINF_SUCCESS;
2169	}
2170
2171
2172	/**
2173	* Called early during ROM registration, right after the pages have been
2174	* allocated and the RAM range updated.
2175	*
2176	* This will be succeeded by a number of NEMHCNotifyPhysPageProtChanged() calls
2177	* and finally a NEMR3NotifyPhysRomRegisterEarly().
2178	*
2179	* @returns VBox status code
2180	* @param pVM The cross context VM structure.
2181	* @param GCPhys The ROM address (page aligned).
2182	* @param cb The size (page aligned).
2183	* @param fFlags NEM_NOTIFY_PHYS_ROM_F_XXX.
2184	*/
2185	int nemR3NativeNotifyPhysRomRegisterEarly(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags)
2186	{
2187	Log5(("nemR3NativeNotifyPhysRomRegisterEarly: %RGp LB %RGp fFlags=%#x\n", GCPhys, cb, fFlags));
2188	#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. */
2189	RTGCPHYS const cPages = cb >> X86_PAGE_SHIFT;
2190	for (RTGCPHYS iPage = 0; iPage < cPages; iPage++, GCPhys += X86_PAGE_SIZE)
2191	{
2192	const void *pvPage;
2193	int rc = nemR3NativeGCPhys2R3PtrReadOnly(pVM, GCPhys, &pvPage);
2194	if (RT_SUCCESS(rc))
2195	{
2196	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, (void *)pvPage, GCPhys, X86_PAGE_SIZE,
2197	WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagExecute);
2198	if (SUCCEEDED(hrc))
2199	{ /* likely */ }
2200	else
2201	{
2202	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp hrc=%Rhrc (%#x) Last=%#x/%u\n",
2203	GCPhys, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
2204	return VERR_NEM_INIT_FAILED;
2205	}
2206	}
2207	else
2208	{
2209	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp rc=%Rrc\n", GCPhys, rc));
2210	return rc;
2211	}
2212	}
2213	#else
2214	NOREF(pVM); NOREF(GCPhys); NOREF(cb);
2215	#endif
2216	RT_NOREF_PV(fFlags);
2217	return VINF_SUCCESS;
2218	}
2219
2220
2221	/**
2222	* Called after the ROM range has been fully completed.
2223	*
2224	* This will be preceeded by a NEMR3NotifyPhysRomRegisterEarly() call as well a
2225	* number of NEMHCNotifyPhysPageProtChanged calls.
2226	*
2227	* @returns VBox status code
2228	* @param pVM The cross context VM structure.
2229	* @param GCPhys The ROM address (page aligned).
2230	* @param cb The size (page aligned).
2231	* @param fFlags NEM_NOTIFY_PHYS_ROM_F_XXX.
2232	*/
2233	int nemR3NativeNotifyPhysRomRegisterLate(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags)
2234	{
2235	Log5(("nemR3NativeNotifyPhysRomRegisterLate: %RGp LB %RGp fFlags=%#x\n", GCPhys, cb, fFlags));
2236	NOREF(pVM); NOREF(GCPhys); NOREF(cb); NOREF(fFlags);
2237	return VINF_SUCCESS;
2238	}
2239
2240
2241	/**
2242	* @callback_method_impl{FNPGMPHYSNEMCHECKPAGE}
2243	*/
2244	static DECLCALLBACK(int) nemR3WinUnsetForA20CheckerCallback(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys,
2245	PPGMPHYSNEMPAGEINFO pInfo, void *pvUser)
2246	{
2247	/* We'll just unmap the memory. */
2248	if (pInfo->u2NemState > NEM_WIN_PAGE_STATE_UNMAPPED)
2249	{
2250	#ifdef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
2251	int rc = nemHCWinHypercallUnmapPage(pVM, pVCpu, GCPhys);
2252	AssertRC(rc);
2253	if (RT_SUCCESS(rc))
2254	#else
2255	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, X86_PAGE_SIZE);
2256	if (SUCCEEDED(hrc))
2257	#endif
2258	{
2259	uint32_t cMappedPages = ASMAtomicDecU32(&pVM->nem.s.cMappedPages); NOREF(cMappedPages);
2260	Log5(("NEM GPA unmapped/A20: %RGp (was %s, cMappedPages=%u)\n", GCPhys, g_apszPageStates[pInfo->u2NemState], cMappedPages));
2261	pInfo->u2NemState = NEM_WIN_PAGE_STATE_UNMAPPED;
2262	}
2263	else
2264	{
2265	#ifdef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
2266	LogRel(("nemR3WinUnsetForA20CheckerCallback/unmap: GCPhys=%RGp rc=%Rrc\n", GCPhys, rc));
2267	return rc;
2268	#else
2269	LogRel(("nemR3WinUnsetForA20CheckerCallback/unmap: GCPhys=%RGp hrc=%Rhrc (%#x) Last=%#x/%u\n",
2270	GCPhys, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
2271	return VERR_INTERNAL_ERROR_2;
2272	#endif
2273	}
2274	}
2275	RT_NOREF(pVCpu, pvUser);
2276	return VINF_SUCCESS;
2277	}
2278
2279
2280	/**
2281	* Unmaps a page from Hyper-V for the purpose of emulating A20 gate behavior.
2282	*
2283	* @returns The PGMPhysNemQueryPageInfo result.
2284	* @param pVM The cross context VM structure.
2285	* @param pVCpu The cross context virtual CPU structure.
2286	* @param GCPhys The page to unmap.
2287	*/
2288	static int nemR3WinUnmapPageForA20Gate(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys)
2289	{
2290	PGMPHYSNEMPAGEINFO Info;
2291	return PGMPhysNemPageInfoChecker(pVM, pVCpu, GCPhys, false /fMakeWritable/, &Info,
2292	nemR3WinUnsetForA20CheckerCallback, NULL);
2293	}
2294
2295
2296	/**
2297	* Called when the A20 state changes.
2298	*
2299	* Hyper-V doesn't seem to offer a simple way of implementing the A20 line
2300	* features of PCs. So, we do a very minimal emulation of the HMA to make DOS
2301	* happy.
2302	*
2303	* @param pVCpu The CPU the A20 state changed on.
2304	* @param fEnabled Whether it was enabled (true) or disabled.
2305	*/
2306	void nemR3NativeNotifySetA20(PVMCPU pVCpu, bool fEnabled)
2307	{
2308	Log(("nemR3NativeNotifySetA20: fEnabled=%RTbool\n", fEnabled));
2309	PVM pVM = pVCpu->CTX_SUFF(pVM);
2310	if (!pVM->nem.s.fA20Fixed)
2311	{
2312	pVM->nem.s.fA20Enabled = fEnabled;
2313	for (RTGCPHYS GCPhys = _1M; GCPhys < _1M + _64K; GCPhys += X86_PAGE_SIZE)
2314	nemR3WinUnmapPageForA20Gate(pVM, pVCpu, GCPhys);
2315	}
2316	}
2317
2318
2319	/** @page pg_nem_win NEM/win - Native Execution Manager, Windows.
2320	*
2321	* On Windows the Hyper-V root partition (dom0 in zen terminology) does not have
2322	* nested VT-x or AMD-V capabilities. For a while raw-mode worked inside it,
2323	* but for a while now we've been getting \#GP when trying to modify CR4 in the
2324	* world switcher. So, when Hyper-V is active on Windows we have little choice
2325	* but to use Hyper-V to run our VMs.
2326	*
2327	*
2328	* @section sub_nem_win_whv The WinHvPlatform API
2329	*
2330	* Since Windows 10 build 17083 there is a documented API for managing Hyper-V
2331	* VMs, header file WinHvPlatform.h and implementation in WinHvPlatform.dll.
2332	* This interface is a wrapper around the undocumented Virtualization
2333	* Infrastructure Driver (VID) API - VID.DLL and VID.SYS. The wrapper is
2334	* written in C++, namespaced, early versions (at least) was using standard C++
2335	* container templates in several places.
2336	*
2337	* When creating a VM using WHvCreatePartition, it will only create the
2338	* WinHvPlatform structures for it, to which you get an abstract pointer. The
2339	* VID API that actually creates the partition is first engaged when you call
2340	* WHvSetupPartition after first setting a lot of properties using
2341	* WHvSetPartitionProperty. Since the VID API is just a very thin wrapper
2342	* around CreateFile and NtDeviceIoControlFile, it returns an actual HANDLE for
2343	* the partition WinHvPlatform. We fish this HANDLE out of the WinHvPlatform
2344	* partition structures because we need to talk directly to VID for reasons
2345	* we'll get to in a bit. (Btw. we could also intercept the CreateFileW or
2346	* NtDeviceIoControlFile calls from VID.DLL to get the HANDLE should fishing in
2347	* the partition structures become difficult.)
2348	*
2349	* The WinHvPlatform API requires us to both set the number of guest CPUs before
2350	* setting up the partition and call WHvCreateVirtualProcessor for each of them.
2351	* The CPU creation function boils down to a VidMessageSlotMap call that sets up
2352	* and maps a message buffer into ring-3 for async communication with hyper-V
2353	* and/or the VID.SYS thread actually running the CPU thru
2354	* WinHvRunVpDispatchLoop(). When for instance a VMEXIT is encountered, hyper-V
2355	* sends a message that the WHvRunVirtualProcessor API retrieves (and later
2356	* acknowledges) via VidMessageSlotHandleAndGetNext. It should be noteded that
2357	* WHvDeleteVirtualProcessor doesn't do much as there seems to be no partner
2358	* function VidMessagesSlotMap that reverses what it did.
2359	*
2360	* Memory is managed thru calls to WHvMapGpaRange and WHvUnmapGpaRange (GPA does
2361	* not mean grade point average here, but rather guest physical addressspace),
2362	* which corresponds to VidCreateVaGpaRangeSpecifyUserVa and VidDestroyGpaRange
2363	* respectively. As 'UserVa' indicates, the functions works on user process
2364	* memory. The mappings are also subject to quota restrictions, so the number
2365	* of ranges are limited and probably their total size as well. Obviously
2366	* VID.SYS keeps track of the ranges, but so does WinHvPlatform, which means
2367	* there is a bit of overhead involved and quota restrctions makes sense. For
2368	* some reason though, regions are lazily mapped on VMEXIT/memory by
2369	* WHvRunVirtualProcessor.
2370	*
2371	* Running guest code is done thru the WHvRunVirtualProcessor function. It
2372	* asynchronously starts or resumes hyper-V CPU execution and then waits for an
2373	* VMEXIT message. Hyper-V / VID.SYS will return information about the message
2374	* in the message buffer mapping, and WHvRunVirtualProcessor will convert that
2375	* finto it's own WHV_RUN_VP_EXIT_CONTEXT format.
2376	*
2377	* Other threads can interrupt the execution by using WHvCancelVirtualProcessor,
2378	* which which case the thread in WHvRunVirtualProcessor is woken up via a dummy
2379	* QueueUserAPC and will call VidStopVirtualProcessor to asynchronously end
2380	* execution. The stop CPU call not immediately succeed if the CPU encountered
2381	* a VMEXIT before the stop was processed, in which case the VMEXIT needs to be
2382	* processed first, and the pending stop will be processed in a subsequent call
2383	* to WHvRunVirtualProcessor.
2384	*
2385	* Registers are retrieved and set via WHvGetVirtualProcessorRegisters and
2386	* WHvSetVirtualProcessorRegisters. In addition, several VMEXITs include
2387	* essential register state in the exit context information, potentially making
2388	* it possible to emulate the instruction causing the exit without involving
2389	* WHvGetVirtualProcessorRegisters.
2390	*
2391	*
2392	* @subsection subsec_nem_win_whv_cons Issues & Feedback
2393	*
2394	* Here are some observations (mostly against build 17101):
2395	*
2396	* - The VMEXIT performance is dismal (build 17134).
2397	*
2398	* Our proof of concept implementation with a kernel runloop (i.e. not using
2399	* WHvRunVirtualProcessor and friends, but calling VID.SYS fast I/O control
2400	* entry point directly) delivers 9-10% of the port I/O performance and only
2401	* 6-7% of the MMIO performance that we have with our own hypervisor.
2402	*
2403	* When using the offical WinHvPlatform API, the numbers are %3 for port I/O
2404	* and 5% for MMIO.
2405	*
2406	* While the tests we've done are using tight tight loops only doing port I/O
2407	* and MMIO, the problem is clearly visible when running regular guest OSes.
2408	* Anything that hammers the VGA device would be suffering, for example:
2409	*
2410	* - Windows 2000 boot screen animation overloads us with MMIO exits
2411	* and won't even boot because all the time is spent in interrupt
2412	* handlers and redrawin the screen.
2413	*
2414	* - DSL 4.4 and its bootmenu logo is slower than molasses in january.
2415	*
2416	* We have not found a workaround for this yet.
2417	*
2418	* Something that might improve the issue a little is to detect blocks with
2419	* excessive MMIO and port I/O exits and emulate instructions to cover
2420	* multiple exits before letting Hyper-V have a go at the guest execution
2421	* again. This will only improve the situation under some circumstances,
2422	* since emulating instructions without recompilation can be expensive, so
2423	* there will only be real gains if the exitting instructions are tightly
2424	* packed.
2425	*
2426	*
2427	* - Unable to access WHvX64RegisterMsrMtrrCap on AMD Ryzen (build 17134).
2428	*
2429	*
2430	* - On AMD Ryzen grub/debian 9.0 ends up with a unrecoverable exception
2431	* when IA32_MTRR_PHYSMASK0 is written.
2432	*
2433	*
2434	* - The IA32_APIC_BASE register does not work right:
2435	*
2436	* - Attempts by the guest to clear bit 11 (EN) are ignored, both the
2437	* guest and the VMM reads back the old value.
2438	*
2439	* - Attempts to modify the base address (bits NN:12) seems to be ignored
2440	* in the same way.
2441	*
2442	* - The VMM can modify both the base address as well as the the EN and
2443	* BSP bits, however this is useless if we cannot intercept the WRMSR.
2444	*
2445	* - Attempts by the guest to set the EXTD bit (X2APIC) result in #GP(0),
2446	* while the VMM ends up with with ERROR_HV_INVALID_PARAMETER. Seems
2447	* there is no way to support X2APIC.
2448	*
2449	*
2450	* - The WHvCancelVirtualProcessor API schedules a dummy usermode APC callback
2451	* in order to cancel any current or future alertable wait in VID.SYS during
2452	* the VidMessageSlotHandleAndGetNext call.
2453	*
2454	* IIRC this will make the kernel schedule the specified callback thru
2455	* NTDLL!KiUserApcDispatcher by modifying the thread context and quite
2456	* possibly the userland thread stack. When the APC callback returns to
2457	* KiUserApcDispatcher, it will call NtContinue to restore the old thread
2458	* context and resume execution from there. This naturally adds up to some
2459	* CPU cycles, ring transitions aren't for free, especially after Spectre &
2460	* Meltdown mitigations.
2461	*
2462	* Using NtAltertThread call could do the same without the thread context
2463	* modifications and the extra kernel call.
2464	*
2465	*
2466	* - Not sure if this is a thing, but WHvCancelVirtualProcessor seems to cause
2467	* cause a lot more spurious WHvRunVirtualProcessor returns that what we get
2468	* with the replacement code. By spurious returns we mean that the
2469	* subsequent call to WHvRunVirtualProcessor would return immediately.
2470	*
2471	*
2472	* - When WHvRunVirtualProcessor returns without a message, or on a terse
2473	* VID message like HLT, it will make a kernel call to get some registers.
2474	* This is potentially inefficient if the caller decides he needs more
2475	* register state.
2476	*
2477	* It would be better to just return what's available and let the caller fetch
2478	* what is missing from his point of view in a single kernel call.
2479	*
2480	*
2481	* - The WHvRunVirtualProcessor implementation does lazy GPA range mappings when
2482	* a unmapped GPA message is received from hyper-V.
2483	*
2484	* Since MMIO is currently realized as unmapped GPA, this will slow down all
2485	* MMIO accesses a tiny little bit as WHvRunVirtualProcessor looks up the
2486	* guest physical address to check if it is a pending lazy mapping.
2487	*
2488	* The lazy mapping feature makes no sense to us. We as API user have all the
2489	* information and can do lazy mapping ourselves if we want/have to (see next
2490	* point).
2491	*
2492	*
2493	* - There is no API for modifying protection of a page within a GPA range.
2494	*
2495	* From what we can tell, the only way to modify the protection (like readonly
2496	* -> writable, or vice versa) is to first unmap the range and then remap it
2497	* with the new protection.
2498	*
2499	* We are for instance doing this quite a bit in order to track dirty VRAM
2500	* pages. VRAM pages starts out as readonly, when the guest writes to a page
2501	* we take an exit, notes down which page it is, makes it writable and restart
2502	* the instruction. After refreshing the display, we reset all the writable
2503	* pages to readonly again, bulk fashion.
2504	*
2505	* Now to work around this issue, we do page sized GPA ranges. In addition to
2506	* add a lot of tracking overhead to WinHvPlatform and VID.SYS, this also
2507	* causes us to exceed our quota before we've even mapped a default sized
2508	* (128MB) VRAM page-by-page. So, to work around this quota issue we have to
2509	* lazily map pages and actively restrict the number of mappings.
2510	*
2511	* Our best workaround thus far is bypassing WinHvPlatform and VID entirely
2512	* when in comes to guest memory management and instead use the underlying
2513	* hypercalls (HvCallMapGpaPages, HvCallUnmapGpaPages) to do it ourselves.
2514	* (This also maps a whole lot better into our own guest page management
2515	* infrastructure.)
2516	*
2517	*
2518	* - Observed problems doing WHvUnmapGpaRange immediately followed by
2519	* WHvMapGpaRange.
2520	*
2521	* As mentioned above, we've been forced to use this sequence when modifying
2522	* page protection. However, when transitioning from readonly to writable,
2523	* we've ended up looping forever with the same write to readonly memory
2524	* VMEXIT. We're wondering if this issue might be related to the lazy mapping
2525	* logic in WinHvPlatform.
2526	*
2527	* Workaround: Insert a WHvRunVirtualProcessor call and make sure to get a GPA
2528	* unmapped exit between the two calls. Not entirely great performance wise
2529	* (or the santity of our code).
2530	*
2531	*
2532	* - Implementing A20 gate behavior is tedious, where as correctly emulating the
2533	* A20M# pin (present on 486 and later) is near impossible for SMP setups
2534	* (e.g. possiblity of two CPUs with different A20 status).
2535	*
2536	* Workaround: Only do A20 on CPU 0, restricting the emulation to HMA. We
2537	* unmap all pages related to HMA (0x100000..0x10ffff) when the A20 state
2538	* changes, lazily syncing the right pages back when accessed.
2539	*
2540	*
2541	* - WHVRunVirtualProcessor wastes time converting VID/Hyper-V messages to its
2542	* own format (WHV_RUN_VP_EXIT_CONTEXT).
2543	*
2544	* We understand this might be because Microsoft wishes to remain free to
2545	* modify the VID/Hyper-V messages, but it's still rather silly and does slow
2546	* things down a little. We'd much rather just process the messages directly.
2547	*
2548	*
2549	* - WHVRunVirtualProcessor would've benefited from using a callback interface:
2550	*
2551	* - The potential size changes of the exit context structure wouldn't be
2552	* an issue, since the function could manage that itself.
2553	*
2554	* - State handling could probably be simplified (like cancelation).
2555	*
2556	*
2557	* - WHvGetVirtualProcessorRegisters and WHvSetVirtualProcessorRegisters
2558	* internally converts register names, probably using temporary heap buffers.
2559	*
2560	* From the looks of things, they are converting from WHV_REGISTER_NAME to
2561	* HV_REGISTER_NAME from in the "Virtual Processor Register Names" section in
2562	* the "Hypervisor Top-Level Functional Specification" document. This feels
2563	* like an awful waste of time.
2564	*
2565	* We simply cannot understand why HV_REGISTER_NAME isn't used directly here,
2566	* or at least the same values, making any conversion reduntant. Restricting
2567	* access to certain registers could easily be implement by scanning the
2568	* inputs.
2569	*
2570	* To avoid the heap + conversion overhead, we're currently using the
2571	* HvCallGetVpRegisters and HvCallSetVpRegisters calls directly.
2572	*
2573	*
2574	* - The YMM and XCR0 registers are not yet named (17083). This probably
2575	* wouldn't be a problem if HV_REGISTER_NAME was used, see previous point.
2576	*
2577	*
2578	* - Why does VID.SYS only query/set 32 registers at the time thru the
2579	* HvCallGetVpRegisters and HvCallSetVpRegisters hypercalls?
2580	*
2581	* We've not trouble getting/setting all the registers defined by
2582	* WHV_REGISTER_NAME in one hypercall (around 80). Some kind of stack
2583	* buffering or similar?
2584	*
2585	*
2586	* - Wrong instruction length in the VpContext with unmapped GPA memory exit
2587	* contexts on 17115/AMD.
2588	*
2589	* One byte "PUSH CS" was reported as 2 bytes, while a two byte
2590	* "MOV [EBX],EAX" was reported with a 1 byte instruction length. Problem
2591	* naturally present in untranslated hyper-v messages.
2592	*
2593	*
2594	* - The I/O port exit context information seems to be missing the address size
2595	* information needed for correct string I/O emulation.
2596	*
2597	* VT-x provides this information in bits 7:9 in the instruction information
2598	* field on newer CPUs. AMD-V in bits 7:9 in the EXITINFO1 field in the VMCB.
2599	*
2600	* We can probably work around this by scanning the instruction bytes for
2601	* address size prefixes. Haven't investigated it any further yet.
2602	*
2603	*
2604	* - The WHvGetCapability function has a weird design:
2605	* - The CapabilityCode parameter is pointlessly duplicated in the output
2606	* structure (WHV_CAPABILITY).
2607	*
2608	* - API takes void pointer, but everyone will probably be using
2609	* WHV_CAPABILITY due to WHV_CAPABILITY::CapabilityCode making it
2610	* impractical to use anything else.
2611	*
2612	* - No output size.
2613	*
2614	* - See GetFileAttributesEx, GetFileInformationByHandleEx,
2615	* FindFirstFileEx, and others for typical pattern for generic
2616	* information getters.
2617	*
2618	* Update: All concerns have been addressed in build 17110.
2619	*
2620	*
2621	* - The WHvGetPartitionProperty function uses the same weird design as
2622	* WHvGetCapability, see above.
2623	*
2624	* Update: All concerns have been addressed in build 17110.
2625	*
2626	*
2627	* - The WHvSetPartitionProperty function has a totally weird design too:
2628	* - In contrast to its partner WHvGetPartitionProperty, the property code
2629	* is not a separate input parameter here but part of the input
2630	* structure.
2631	*
2632	* - The input structure is a void pointer rather than a pointer to
2633	* WHV_PARTITION_PROPERTY which everyone probably will be using because
2634	* of the WHV_PARTITION_PROPERTY::PropertyCode field.
2635	*
2636	* - Really, why use PVOID for the input when the function isn't accepting
2637	* minimal sizes. E.g. WHVPartitionPropertyCodeProcessorClFlushSize only
2638	* requires a 9 byte input, but the function insists on 16 bytes (17083).
2639	*
2640	* - See GetFileAttributesEx, SetFileInformationByHandle, FindFirstFileEx,
2641	* and others for typical pattern for generic information setters and
2642	* getters.
2643	*
2644	* Update: All concerns have been addressed in build 17110.
2645	*
2646	*
2647	*
2648	* @section sec_nem_win_impl Our implementation.
2649	*
2650	* We set out with the goal of wanting to run as much as possible in ring-0,
2651	* reasoning that this would give use the best performance.
2652	*
2653	* This goal was approached gradually, starting out with a pure WinHvPlatform
2654	* implementation, gradually replacing parts: register access, guest memory
2655	* handling, running virtual processors. Then finally moving it all into
2656	* ring-0, while keeping most of it configurable so that we could make
2657	* comparisons (see NEMInternal.h and nemR3NativeRunGC()).
2658	*
2659	*
2660	* @subsection subsect_nem_win_impl_ioctl VID.SYS I/O control calls
2661	*
2662	* To run things in ring-0 we need to talk directly to VID.SYS thru its I/O
2663	* control interface. Looking at changes between like build 17083 and 17101 (if
2664	* memory serves) a set of the VID I/O control numbers shifted a little, which
2665	* means we need to determin them dynamically. We currently do this by hooking
2666	* the NtDeviceIoControlFile API call from VID.DLL and snooping up the
2667	* parameters when making dummy calls to relevant APIs. (We could also
2668	* disassemble the relevant APIs and try fish out the information from that, but
2669	* this is way simpler.)
2670	*
2671	* Issuing I/O control calls from ring-0 is facing a small challenge with
2672	* respect to direct buffering. When using direct buffering the device will
2673	* typically check that the buffer is actually in the user address space range
2674	* and reject kernel addresses. Fortunately, we've got the cross context VM
2675	* structure that is mapped into both kernel and user space, it's also locked
2676	* and safe to access from kernel space. So, we place the I/O control buffers
2677	* in the per-CPU part of it (NEMCPU::uIoCtlBuf) and give the driver the user
2678	* address if direct access buffering or kernel address if not.
2679	*
2680	* The I/O control calls are 'abstracted' in the support driver, see
2681	* SUPR0IoCtlSetupForHandle(), SUPR0IoCtlPerform() and SUPR0IoCtlCleanup().
2682	*
2683	*
2684	* @subsection subsect_nem_win_impl_cpumctx CPUMCTX
2685	*
2686	* Since the CPU state needs to live in Hyper-V when executing, we probably
2687	* should not transfer more than necessary when handling VMEXITs. To help us
2688	* manage this CPUMCTX got a new field CPUMCTX::fExtrn that to indicate which
2689	* part of the state is currently externalized (== in Hyper-V).
2690	*
2691	*
2692	*/
2693

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

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

Download in other formats: