NEMR3Native-win.cpp@ 72463

Last change on this file since 72463 was 72463, checked in by vboxsync, 6 years ago
NEM: More hypercall work. bugref:9044
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 125.9 KB

Line
1	/* $Id: NEMR3Native-win.cpp 72463 2018-06-06 14:45:54Z 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: Supported exception exit bitmap: %#RX64\n", Caps.ExceptionExitBitmap));
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	Property.ExtendedVmExits.ExceptionExit = pVM->nem.s.fExtendedXcptExit;
1055	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeExtendedVmExits, &Property, sizeof(Property));
1056	if (SUCCEEDED(hrc))
1057	{
1058	/*
1059	* We'll continue setup in nemR3NativeInitAfterCPUM.
1060	*/
1061	pVM->nem.s.fCreatedEmts = false;
1062	pVM->nem.s.hPartition = hPartition;
1063	LogRel(("NEM: Created partition %p.\n", hPartition));
1064	return VINF_SUCCESS;
1065	}
1066
1067	rc = RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED,
1068	"Failed setting WHvPartitionPropertyCodeExtendedVmExits to %'#RX64: %Rhrc",
1069	Property.ExtendedVmExits.AsUINT64, hrc);
1070	}
1071	else
1072	rc = RTErrInfoSetF(pErrInfo, VERR_NEM_VM_CREATE_FAILED,
1073	"Failed setting WHvPartitionPropertyCodeProcessorCount to %u: %Rhrc (Last=%#x/%u)",
1074	pVM->cCpus, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1075	WHvDeletePartition(hPartition);
1076
1077	Assert(!pVM->nem.s.hPartitionDevice);
1078	Assert(!pVM->nem.s.hPartition);
1079	return rc;
1080	}
1081
1082
1083	/**
1084	* Makes sure APIC and firmware will not allow X2APIC mode.
1085	*
1086	* This is rather ugly.
1087	*
1088	* @returns VBox status code
1089	* @param pVM The cross context VM structure.
1090	*/
1091	static int nemR3WinDisableX2Apic(PVM pVM)
1092	{
1093	/*
1094	* First make sure the 'Mode' config value of the APIC isn't set to X2APIC.
1095	* This defaults to APIC, so no need to change unless it's X2APIC.
1096	*/
1097	PCFGMNODE pCfg = CFGMR3GetChild(CFGMR3GetRoot(pVM), "/Devices/apic/0/Config");
1098	if (pCfg)
1099	{
1100	uint8_t bMode = 0;
1101	int rc = CFGMR3QueryU8(pCfg, "Mode", &bMode);
1102	AssertLogRelMsgReturn(RT_SUCCESS(rc) \|\| rc == VERR_CFGM_VALUE_NOT_FOUND, ("%Rrc\n", rc), rc);
1103	if (RT_SUCCESS(rc) && bMode == PDMAPICMODE_X2APIC)
1104	{
1105	LogRel(("NEM: Adjusting APIC configuration from X2APIC to APIC max mode. X2APIC is not supported by the WinHvPlatform API!\n"));
1106	LogRel(("NEM: Disable Hyper-V if you need X2APIC for your guests!\n"));
1107	rc = CFGMR3RemoveValue(pCfg, "Mode");
1108	rc = CFGMR3InsertInteger(pCfg, "Mode", PDMAPICMODE_APIC);
1109	AssertLogRelRCReturn(rc, rc);
1110	}
1111	}
1112
1113	/*
1114	* Now the firmwares.
1115	* These also defaults to APIC and only needs adjusting if configured to X2APIC (2).
1116	*/
1117	static const char * const s_apszFirmwareConfigs[] =
1118	{
1119	"/Devices/efi/0/Config",
1120	"/Devices/pcbios/0/Config",
1121	};
1122	for (unsigned i = 0; i < RT_ELEMENTS(s_apszFirmwareConfigs); i++)
1123	{
1124	pCfg = CFGMR3GetChild(CFGMR3GetRoot(pVM), "/Devices/APIC/0/Config");
1125	if (pCfg)
1126	{
1127	uint8_t bMode = 0;
1128	int rc = CFGMR3QueryU8(pCfg, "APIC", &bMode);
1129	AssertLogRelMsgReturn(RT_SUCCESS(rc) \|\| rc == VERR_CFGM_VALUE_NOT_FOUND, ("%Rrc\n", rc), rc);
1130	if (RT_SUCCESS(rc) && bMode == 2)
1131	{
1132	LogRel(("NEM: Adjusting %s/Mode from 2 (X2APIC) to 1 (APIC).\n", s_apszFirmwareConfigs[i]));
1133	rc = CFGMR3RemoveValue(pCfg, "APIC");
1134	rc = CFGMR3InsertInteger(pCfg, "APIC", 1);
1135	AssertLogRelRCReturn(rc, rc);
1136	}
1137	}
1138	}
1139
1140	return VINF_SUCCESS;
1141	}
1142
1143
1144	/**
1145	* Try initialize the native API.
1146	*
1147	* This may only do part of the job, more can be done in
1148	* nemR3NativeInitAfterCPUM() and nemR3NativeInitCompleted().
1149	*
1150	* @returns VBox status code.
1151	* @param pVM The cross context VM structure.
1152	* @param fFallback Whether we're in fallback mode or use-NEM mode. In
1153	* the latter we'll fail if we cannot initialize.
1154	* @param fForced Whether the HMForced flag is set and we should
1155	* fail if we cannot initialize.
1156	*/
1157	int nemR3NativeInit(PVM pVM, bool fFallback, bool fForced)
1158	{
1159	g_uBuildNo = RTSystemGetNtBuildNo();
1160
1161	/*
1162	* Some state init.
1163	*/
1164	for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1165	{
1166	PNEMCPU pNemCpu = &pVM->aCpus[iCpu].nem.s;
1167	pNemCpu->uPendingApicBase = UINT64_MAX;
1168	}
1169
1170	/*
1171	* Error state.
1172	* The error message will be non-empty on failure and 'rc' will be set too.
1173	*/
1174	RTERRINFOSTATIC ErrInfo;
1175	PRTERRINFO pErrInfo = RTErrInfoInitStatic(&ErrInfo);
1176	int rc = nemR3WinInitProbeAndLoad(fForced, pErrInfo);
1177	if (RT_SUCCESS(rc))
1178	{
1179	/*
1180	* Check the capabilties of the hypervisor, starting with whether it's present.
1181	*/
1182	rc = nemR3WinInitCheckCapabilities(pVM, pErrInfo);
1183	if (RT_SUCCESS(rc))
1184	{
1185	/*
1186	* Discover the VID I/O control function numbers we need.
1187	*/
1188	rc = nemR3WinInitDiscoverIoControlProperties(pVM, pErrInfo);
1189	if (RT_SUCCESS(rc))
1190	{
1191	/*
1192	* Check out our ring-0 capabilities.
1193	*/
1194	rc = SUPR3CallVMMR0Ex(pVM->pVMR0, 0 /idCpu/, VMMR0_DO_NEM_INIT_VM, 0, NULL);
1195	if (RT_SUCCESS(rc))
1196	{
1197	/*
1198	* Create and initialize a partition.
1199	*/
1200	rc = nemR3WinInitCreatePartition(pVM, pErrInfo);
1201	if (RT_SUCCESS(rc))
1202	{
1203	VM_SET_MAIN_EXECUTION_ENGINE(pVM, VM_EXEC_ENGINE_NATIVE_API);
1204	Log(("NEM: Marked active!\n"));
1205	nemR3WinDisableX2Apic(pVM);
1206
1207	/* Register release statistics */
1208	for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1209	{
1210	PNEMCPU pNemCpu = &pVM->aCpus[iCpu].nem.s;
1211	STAMR3RegisterF(pVM, &pNemCpu->StatExitPortIo, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of port I/O exits", "/NEM/CPU%u/ExitPortIo", iCpu);
1212	STAMR3RegisterF(pVM, &pNemCpu->StatExitMemUnmapped, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of unmapped memory exits", "/NEM/CPU%u/ExitMemUnmapped", iCpu);
1213	STAMR3RegisterF(pVM, &pNemCpu->StatExitMemIntercept, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of intercepted memory exits", "/NEM/CPU%u/ExitMemIntercept", iCpu);
1214	STAMR3RegisterF(pVM, &pNemCpu->StatExitHalt, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of HLT exits", "/NEM/CPU%u/ExitHalt", iCpu);
1215	STAMR3RegisterF(pVM, &pNemCpu->StatExitInterruptWindow, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of HLT exits", "/NEM/CPU%u/ExitInterruptWindow", iCpu);
1216	STAMR3RegisterF(pVM, &pNemCpu->StatExitCpuId, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of CPUID exits", "/NEM/CPU%u/ExitCpuId", iCpu);
1217	STAMR3RegisterF(pVM, &pNemCpu->StatExitMsr, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of MSR access exits", "/NEM/CPU%u/ExitMsr", iCpu);
1218	STAMR3RegisterF(pVM, &pNemCpu->StatExitException, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of exception exits", "/NEM/CPU%u/ExitException", iCpu);
1219	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionBp, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #BP exits", "/NEM/CPU%u/ExitExceptionBp", iCpu);
1220	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionDb, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #DB exits", "/NEM/CPU%u/ExitExceptionDb", iCpu);
1221	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionUd, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of #UD exits", "/NEM/CPU%u/ExitExceptionUd", iCpu);
1222	STAMR3RegisterF(pVM, &pNemCpu->StatExitExceptionUdHandled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of handled #UD exits", "/NEM/CPU%u/ExitExceptionUdHandled", iCpu);
1223	STAMR3RegisterF(pVM, &pNemCpu->StatExitUnrecoverable, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of unrecoverable exits", "/NEM/CPU%u/ExitUnrecoverable", iCpu);
1224	STAMR3RegisterF(pVM, &pNemCpu->StatGetMsgTimeout, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of get message timeouts/alerts", "/NEM/CPU%u/GetMsgTimeout", iCpu);
1225	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuSuccess, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of successful CPU stops", "/NEM/CPU%u/StopCpuSuccess", iCpu);
1226	STAMR3RegisterF(pVM, &pNemCpu->StatStopCpuPending, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pending CPU stops", "/NEM/CPU%u/StopCpuPending", iCpu);
1227	STAMR3RegisterF(pVM, &pNemCpu->StatCancelChangedState, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel changed state", "/NEM/CPU%u/CancelChangedState", iCpu);
1228	STAMR3RegisterF(pVM, &pNemCpu->StatCancelAlertedThread, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel alerted EMT", "/NEM/CPU%u/CancelAlertedEMT", iCpu);
1229	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnFFPre, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of pre execution FF breaks", "/NEM/CPU%u/BreakOnFFPre", iCpu);
1230	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnFFPost, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of post execution FF breaks", "/NEM/CPU%u/BreakOnFFPost", iCpu);
1231	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnCancel, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of cancel execution breaks", "/NEM/CPU%u/BreakOnCancel", iCpu);
1232	STAMR3RegisterF(pVM, &pNemCpu->StatBreakOnStatus, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of status code breaks", "/NEM/CPU%u/BreakOnStatus", iCpu);
1233	}
1234
1235	PUVM pUVM = pVM->pUVM;
1236	STAMR3RegisterRefresh(pUVM, &pVM->nem.s.R0Stats.cPagesAvailable, STAMTYPE_U64, STAMVISIBILITY_ALWAYS,
1237	STAMUNIT_PAGES, STAM_REFRESH_GRP_NEM, "Free pages available to the hypervisor",
1238	"/NEM/R0Stats/cPagesAvailable");
1239	STAMR3RegisterRefresh(pUVM, &pVM->nem.s.R0Stats.cPagesInUse, STAMTYPE_U64, STAMVISIBILITY_ALWAYS,
1240	STAMUNIT_PAGES, STAM_REFRESH_GRP_NEM, "Pages in use by hypervisor",
1241	"/NEM/R0Stats/cPagesInUse");
1242	}
1243	}
1244	}
1245	}
1246	}
1247
1248	/*
1249	* We only fail if in forced mode, otherwise just log the complaint and return.
1250	*/
1251	Assert(pVM->bMainExecutionEngine == VM_EXEC_ENGINE_NATIVE_API \|\| RTErrInfoIsSet(pErrInfo));
1252	if ( (fForced \|\| !fFallback)
1253	&& pVM->bMainExecutionEngine != VM_EXEC_ENGINE_NATIVE_API)
1254	return VMSetError(pVM, RT_SUCCESS_NP(rc) ? VERR_NEM_NOT_AVAILABLE : rc, RT_SRC_POS, "%s", pErrInfo->pszMsg);
1255
1256	if (RTErrInfoIsSet(pErrInfo))
1257	LogRel(("NEM: Not available: %s\n", pErrInfo->pszMsg));
1258	return VINF_SUCCESS;
1259	}
1260
1261
1262	/**
1263	* This is called after CPUMR3Init is done.
1264	*
1265	* @returns VBox status code.
1266	* @param pVM The VM handle..
1267	*/
1268	int nemR3NativeInitAfterCPUM(PVM pVM)
1269	{
1270	/*
1271	* Validate sanity.
1272	*/
1273	WHV_PARTITION_HANDLE hPartition = pVM->nem.s.hPartition;
1274	AssertReturn(hPartition != NULL, VERR_WRONG_ORDER);
1275	AssertReturn(!pVM->nem.s.hPartitionDevice, VERR_WRONG_ORDER);
1276	AssertReturn(!pVM->nem.s.fCreatedEmts, VERR_WRONG_ORDER);
1277	AssertReturn(pVM->bMainExecutionEngine == VM_EXEC_ENGINE_NATIVE_API, VERR_WRONG_ORDER);
1278
1279	/*
1280	* Continue setting up the partition now that we've got most of the CPUID feature stuff.
1281	*/
1282	WHV_PARTITION_PROPERTY Property;
1283	HRESULT hrc;
1284
1285	#if 0
1286	/* Not sure if we really need to set the vendor.
1287	Update: Apparently we don't. WHvPartitionPropertyCodeProcessorVendor was removed in 17110. */
1288	RT_ZERO(Property);
1289	Property.ProcessorVendor = pVM->nem.s.enmCpuVendor == CPUMCPUVENDOR_AMD ? WHvProcessorVendorAmd
1290	: WHvProcessorVendorIntel;
1291	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorVendor, &Property, sizeof(Property));
1292	if (FAILED(hrc))
1293	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1294	"Failed to set WHvPartitionPropertyCodeProcessorVendor to %u: %Rhrc (Last=%#x/%u)",
1295	Property.ProcessorVendor, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1296	#endif
1297
1298	/* Not sure if we really need to set the cache line flush size. */
1299	RT_ZERO(Property);
1300	Property.ProcessorClFlushSize = pVM->nem.s.cCacheLineFlushShift;
1301	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorClFlushSize, &Property, sizeof(Property));
1302	if (FAILED(hrc))
1303	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1304	"Failed to set WHvPartitionPropertyCodeProcessorClFlushSize to %u: %Rhrc (Last=%#x/%u)",
1305	pVM->nem.s.cCacheLineFlushShift, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1306
1307	/* Intercept #DB, #BP and #UD exceptions. */
1308	RT_ZERO(Property);
1309	Property.ExceptionExitBitmap = RT_BIT_64(WHvX64ExceptionTypeDivideErrorFault)
1310	\| RT_BIT_64(WHvX64ExceptionTypeBreakpointTrap)
1311	\| RT_BIT_64(WHvX64ExceptionTypeInvalidOpcodeFault);
1312	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeExceptionExitBitmap, &Property, sizeof(Property));
1313	if (FAILED(hrc))
1314	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1315	"Failed to set WHvPartitionPropertyCodeExceptionExitBitmap to %#RX64: %Rhrc (Last=%#x/%u)",
1316	Property.ExceptionExitBitmap, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1317
1318
1319	/*
1320	* Sync CPU features with CPUM.
1321	*/
1322	/** @todo sync CPU features with CPUM. */
1323
1324	/* Set the partition property. */
1325	RT_ZERO(Property);
1326	Property.ProcessorFeatures.AsUINT64 = pVM->nem.s.uCpuFeatures.u64;
1327	hrc = WHvSetPartitionProperty(hPartition, WHvPartitionPropertyCodeProcessorFeatures, &Property, sizeof(Property));
1328	if (FAILED(hrc))
1329	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1330	"Failed to set WHvPartitionPropertyCodeProcessorFeatures to %'#RX64: %Rhrc (Last=%#x/%u)",
1331	pVM->nem.s.uCpuFeatures.u64, hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1332
1333	/*
1334	* Set up the partition and create EMTs.
1335	*
1336	* Seems like this is where the partition is actually instantiated and we get
1337	* a handle to it.
1338	*/
1339	hrc = WHvSetupPartition(hPartition);
1340	if (FAILED(hrc))
1341	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1342	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)",
1343	hrc, RTNtLastStatusValue(), RTNtLastErrorValue());
1344
1345	/* Get the handle. */
1346	HANDLE hPartitionDevice;
1347	__try
1348	{
1349	hPartitionDevice = ((HANDLE *)hPartition)[1];
1350	}
1351	__except(EXCEPTION_EXECUTE_HANDLER)
1352	{
1353	hrc = GetExceptionCode();
1354	hPartitionDevice = NULL;
1355	}
1356	if ( hPartitionDevice == NULL
1357	\|\| hPartitionDevice == (HANDLE)(intptr_t)-1)
1358	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1359	"Failed to get device handle for partition %p: %Rhrc", hPartition, hrc);
1360
1361	HV_PARTITION_ID idHvPartition = HV_PARTITION_ID_INVALID;
1362	if (!g_pfnVidGetHvPartitionId(hPartitionDevice, &idHvPartition))
1363	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1364	"Failed to get device handle and/or partition ID for %p (hPartitionDevice=%p, Last=%#x/%u)",
1365	hPartition, hPartitionDevice, RTNtLastStatusValue(), RTNtLastErrorValue());
1366	pVM->nem.s.hPartitionDevice = hPartitionDevice;
1367	pVM->nem.s.idHvPartition = idHvPartition;
1368
1369	/*
1370	* Setup the EMTs.
1371	*/
1372	VMCPUID iCpu;
1373	for (iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1374	{
1375	PVMCPU pVCpu = &pVM->aCpus[iCpu];
1376
1377	pVCpu->nem.s.hNativeThreadHandle = (RTR3PTR)RTThreadGetNativeHandle(VMR3GetThreadHandle(pVCpu->pUVCpu));
1378	Assert((HANDLE)pVCpu->nem.s.hNativeThreadHandle != INVALID_HANDLE_VALUE);
1379
1380	#ifdef NEM_WIN_USE_OUR_OWN_RUN_API
1381	VID_MAPPED_MESSAGE_SLOT MappedMsgSlot = { NULL, UINT32_MAX, UINT32_MAX };
1382	if (g_pfnVidMessageSlotMap(hPartitionDevice, &MappedMsgSlot, iCpu))
1383	{
1384	AssertLogRelMsg(MappedMsgSlot.iCpu == iCpu && MappedMsgSlot.uParentAdvisory == UINT32_MAX,
1385	("%#x %#x (iCpu=%#x)\n", MappedMsgSlot.iCpu, MappedMsgSlot.uParentAdvisory, iCpu));
1386	pVCpu->nem.s.pvMsgSlotMapping = MappedMsgSlot.pMsgBlock;
1387	}
1388	else
1389	{
1390	NTSTATUS const rcNtLast = RTNtLastStatusValue();
1391	DWORD const dwErrLast = RTNtLastErrorValue();
1392	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1393	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)", hrc, rcNtLast, dwErrLast);
1394	}
1395	#else
1396	hrc = WHvCreateVirtualProcessor(hPartition, iCpu, 0 /fFlags/);
1397	if (FAILED(hrc))
1398	{
1399	NTSTATUS const rcNtLast = RTNtLastStatusValue();
1400	DWORD const dwErrLast = RTNtLastErrorValue();
1401	while (iCpu-- > 0)
1402	{
1403	HRESULT hrc2 = WHvDeleteVirtualProcessor(hPartition, iCpu);
1404	AssertLogRelMsg(SUCCEEDED(hrc2), ("WHvDeleteVirtualProcessor(%p, %u) -> %Rhrc (Last=%#x/%u)\n",
1405	hPartition, iCpu, hrc2, RTNtLastStatusValue(),
1406	RTNtLastErrorValue()));
1407	}
1408	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS,
1409	"Call to WHvSetupPartition failed: %Rhrc (Last=%#x/%u)", hrc, rcNtLast, dwErrLast);
1410	}
1411	#endif /* !NEM_WIN_USE_OUR_OWN_RUN_API */
1412	}
1413	pVM->nem.s.fCreatedEmts = true;
1414
1415	/*
1416	* Do some more ring-0 initialization now that we've got the partition handle.
1417	*/
1418	int rc = VMMR3CallR0Emt(pVM, &pVM->aCpus[0], VMMR0_DO_NEM_INIT_VM_PART_2, 0, NULL);
1419	if (RT_SUCCESS(rc))
1420	{
1421	LogRel(("NEM: Successfully set up partition (device handle %p, partition ID %#llx)\n", hPartitionDevice, idHvPartition));
1422
1423	#if 1
1424	VMMR3CallR0Emt(pVM, &pVM->aCpus[0], VMMR0_DO_NEM_UPDATE_STATISTICS, 0, NULL);
1425	LogRel(("NEM: Memory balance: %#RX64 out of %#RX64 pages in use\n",
1426	pVM->nem.s.R0Stats.cPagesInUse, pVM->nem.s.R0Stats.cPagesAvailable));
1427	#endif
1428
1429	/*
1430	* Register statistics on shared pages.
1431	*/
1432	/** @todo HvCallMapStatsPage */
1433
1434	/*
1435	* Adjust features.
1436	* Note! We've already disabled X2APIC via CFGM during the first init call.
1437	*/
1438	return VINF_SUCCESS;
1439	}
1440	return VMSetError(pVM, VERR_NEM_VM_CREATE_FAILED, RT_SRC_POS, "Call to NEMR0InitVMPart2 failed: %Rrc", rc);
1441	}
1442
1443
1444	int nemR3NativeInitCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
1445	{
1446	//BOOL fRet = SetThreadPriority(GetCurrentThread(), 0);
1447	//AssertLogRel(fRet);
1448
1449	NOREF(pVM); NOREF(enmWhat);
1450	return VINF_SUCCESS;
1451	}
1452
1453
1454	int nemR3NativeTerm(PVM pVM)
1455	{
1456	/*
1457	* Delete the partition.
1458	*/
1459	WHV_PARTITION_HANDLE hPartition = pVM->nem.s.hPartition;
1460	pVM->nem.s.hPartition = NULL;
1461	pVM->nem.s.hPartitionDevice = NULL;
1462	if (hPartition != NULL)
1463	{
1464	VMCPUID iCpu = pVM->nem.s.fCreatedEmts ? pVM->cCpus : 0;
1465	LogRel(("NEM: Destroying partition %p with its %u VCpus...\n", hPartition, iCpu));
1466	while (iCpu-- > 0)
1467	{
1468	#ifdef NEM_WIN_USE_OUR_OWN_RUN_API
1469	pVM->aCpus[iCpu].nem.s.pvMsgSlotMapping = NULL;
1470	#else
1471	HRESULT hrc = WHvDeleteVirtualProcessor(hPartition, iCpu);
1472	AssertLogRelMsg(SUCCEEDED(hrc), ("WHvDeleteVirtualProcessor(%p, %u) -> %Rhrc (Last=%#x/%u)\n",
1473	hPartition, iCpu, hrc, RTNtLastStatusValue(),
1474	RTNtLastErrorValue()));
1475	#endif
1476	}
1477	WHvDeletePartition(hPartition);
1478	}
1479	pVM->nem.s.fCreatedEmts = false;
1480	return VINF_SUCCESS;
1481	}
1482
1483
1484	/**
1485	* VM reset notification.
1486	*
1487	* @param pVM The cross context VM structure.
1488	*/
1489	void nemR3NativeReset(PVM pVM)
1490	{
1491	/* Unfix the A20 gate. */
1492	pVM->nem.s.fA20Fixed = false;
1493	}
1494
1495
1496	/**
1497	* Reset CPU due to INIT IPI or hot (un)plugging.
1498	*
1499	* @param pVCpu The cross context virtual CPU structure of the CPU being
1500	* reset.
1501	* @param fInitIpi Whether this is the INIT IPI or hot (un)plugging case.
1502	*/
1503	void nemR3NativeResetCpu(PVMCPU pVCpu, bool fInitIpi)
1504	{
1505	/* Lock the A20 gate if INIT IPI, make sure it's enabled. */
1506	if (fInitIpi && pVCpu->idCpu > 0)
1507	{
1508	PVM pVM = pVCpu->CTX_SUFF(pVM);
1509	if (!pVM->nem.s.fA20Enabled)
1510	nemR3NativeNotifySetA20(pVCpu, true);
1511	pVM->nem.s.fA20Enabled = true;
1512	pVM->nem.s.fA20Fixed = true;
1513	}
1514	}
1515
1516	#if 0 //ndef NEM_WIN_USE_OUR_OWN_RUN_API - migrating to NEMAllNativeTemplate-win.cpp.h */
1517
1518	# ifdef LOG_ENABLED
1519	/**
1520	* Log the full details of an exit reason.
1521	*
1522	* @param pExitReason The exit reason to log.
1523	*/
1524	static void nemR3WinLogWHvExitReason(WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1525	{
1526	bool fExitCtx = false;
1527	bool fExitInstr = false;
1528	switch (pExitReason->ExitReason)
1529	{
1530	case WHvRunVpExitReasonMemoryAccess:
1531	Log2(("Exit: Memory access: GCPhys=%RGp GCVirt=%RGv %s %s %s\n",
1532	pExitReason->MemoryAccess.Gpa, pExitReason->MemoryAccess.Gva,
1533	g_apszWHvMemAccesstypes[pExitReason->MemoryAccess.AccessInfo.AccessType],
1534	pExitReason->MemoryAccess.AccessInfo.GpaUnmapped ? "unmapped" : "mapped",
1535	pExitReason->MemoryAccess.AccessInfo.GvaValid ? "" : "invalid-gc-virt"));
1536	AssertMsg(!(pExitReason->MemoryAccess.AccessInfo.AsUINT32 & ~UINT32_C(0xf)),
1537	("MemoryAccess.AccessInfo=%#x\n", pExitReason->MemoryAccess.AccessInfo.AsUINT32));
1538	fExitCtx = fExitInstr = true;
1539	break;
1540
1541	case WHvRunVpExitReasonX64IoPortAccess:
1542	Log2(("Exit: I/O port access: IoPort=%#x LB %u %s%s%s rax=%#RX64 rcx=%#RX64 rsi=%#RX64 rdi=%#RX64\n",
1543	pExitReason->IoPortAccess.PortNumber,
1544	pExitReason->IoPortAccess.AccessInfo.AccessSize,
1545	pExitReason->IoPortAccess.AccessInfo.IsWrite ? "out" : "in",
1546	pExitReason->IoPortAccess.AccessInfo.StringOp ? " string" : "",
1547	pExitReason->IoPortAccess.AccessInfo.RepPrefix ? " rep" : "",
1548	pExitReason->IoPortAccess.Rax,
1549	pExitReason->IoPortAccess.Rcx,
1550	pExitReason->IoPortAccess.Rsi,
1551	pExitReason->IoPortAccess.Rdi));
1552	Log2(("Exit: + ds=%#x:{%#RX64 LB %#RX32, %#x} es=%#x:{%#RX64 LB %#RX32, %#x}\n",
1553	pExitReason->IoPortAccess.Ds.Selector,
1554	pExitReason->IoPortAccess.Ds.Base,
1555	pExitReason->IoPortAccess.Ds.Limit,
1556	pExitReason->IoPortAccess.Ds.Attributes,
1557	pExitReason->IoPortAccess.Es.Selector,
1558	pExitReason->IoPortAccess.Es.Base,
1559	pExitReason->IoPortAccess.Es.Limit,
1560	pExitReason->IoPortAccess.Es.Attributes ));
1561
1562	AssertMsg( pExitReason->IoPortAccess.AccessInfo.AccessSize == 1
1563	\|\| pExitReason->IoPortAccess.AccessInfo.AccessSize == 2
1564	\|\| pExitReason->IoPortAccess.AccessInfo.AccessSize == 4,
1565	("IoPortAccess.AccessInfo.AccessSize=%d\n", pExitReason->IoPortAccess.AccessInfo.AccessSize));
1566	AssertMsg(!(pExitReason->IoPortAccess.AccessInfo.AsUINT32 & ~UINT32_C(0x3f)),
1567	("IoPortAccess.AccessInfo=%#x\n", pExitReason->IoPortAccess.AccessInfo.AsUINT32));
1568	fExitCtx = fExitInstr = true;
1569	break;
1570
1571	# if 0
1572	case WHvRunVpExitReasonUnrecoverableException:
1573	case WHvRunVpExitReasonInvalidVpRegisterValue:
1574	case WHvRunVpExitReasonUnsupportedFeature:
1575	case WHvRunVpExitReasonX64InterruptWindow:
1576	case WHvRunVpExitReasonX64Halt:
1577	case WHvRunVpExitReasonX64MsrAccess:
1578	case WHvRunVpExitReasonX64Cpuid:
1579	case WHvRunVpExitReasonException:
1580	case WHvRunVpExitReasonCanceled:
1581	case WHvRunVpExitReasonAlerted:
1582	WHV_X64_MSR_ACCESS_CONTEXT MsrAccess;
1583	WHV_X64_CPUID_ACCESS_CONTEXT CpuidAccess;
1584	WHV_VP_EXCEPTION_CONTEXT VpException;
1585	WHV_X64_INTERRUPTION_DELIVERABLE_CONTEXT InterruptWindow;
1586	WHV_UNRECOVERABLE_EXCEPTION_CONTEXT UnrecoverableException;
1587	WHV_X64_UNSUPPORTED_FEATURE_CONTEXT UnsupportedFeature;
1588	WHV_RUN_VP_CANCELED_CONTEXT CancelReason;
1589	# endif
1590
1591	case WHvRunVpExitReasonNone:
1592	Log2(("Exit: No reason\n"));
1593	AssertFailed();
1594	break;
1595
1596	default:
1597	Log(("Exit: %#x\n", pExitReason->ExitReason));
1598	break;
1599	}
1600
1601	/*
1602	* Context and maybe instruction details.
1603	*/
1604	if (fExitCtx)
1605	{
1606	const WHV_VP_EXIT_CONTEXT *pVpCtx = &pExitReason->VpContext;
1607	Log2(("Exit: + CS:RIP=%04x:%08RX64 RFLAGS=%06RX64 cbInstr=%u CS={%RX64 L %#RX32, %#x}\n",
1608	pVpCtx->Cs.Selector,
1609	pVpCtx->Rip,
1610	pVpCtx->Rflags,
1611	pVpCtx->InstructionLength,
1612	pVpCtx->Cs.Base, pVpCtx->Cs.Limit, pVpCtx->Cs.Attributes));
1613	Log2(("Exit: + cpl=%d CR0.PE=%d CR0.AM=%d EFER.LMA=%d DebugActive=%d InterruptionPending=%d InterruptShadow=%d\n",
1614	pVpCtx->ExecutionState.Cpl,
1615	pVpCtx->ExecutionState.Cr0Pe,
1616	pVpCtx->ExecutionState.Cr0Am,
1617	pVpCtx->ExecutionState.EferLma,
1618	pVpCtx->ExecutionState.DebugActive,
1619	pVpCtx->ExecutionState.InterruptionPending,
1620	pVpCtx->ExecutionState.InterruptShadow));
1621	AssertMsg(!(pVpCtx->ExecutionState.AsUINT16 & ~UINT16_C(0x107f)),
1622	("ExecutionState.AsUINT16=%#x\n", pVpCtx->ExecutionState.AsUINT16));
1623
1624	/** @todo Someone at Microsoft please explain why the InstructionBytes fields
1625	* are 16 bytes long, when 15 would've been sufficent and saved 3-7 bytes of
1626	* alignment padding? Intel max length is 15, so is this sSome ARM stuff?
1627	* Aren't ARM
1628	* instructions max 32-bit wide? Confused. */
1629	if (fExitInstr && pExitReason->IoPortAccess.InstructionByteCount > 0)
1630	Log2(("Exit: + Instruction %.*Rhxs\n",
1631	pExitReason->IoPortAccess.InstructionByteCount, &pExitReason->IoPortAccess.InstructionBytes[0]));
1632	}
1633	}
1634	# endif /* LOG_ENABLED */
1635
1636
1637	static VBOXSTRICTRC nemR3WinWHvHandleHalt(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx)
1638	{
1639	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx);
1640	LogFlow(("nemR3WinWHvHandleHalt\n"));
1641	return VINF_EM_HALT;
1642	}
1643
1644
1645	# ifndef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
1646	/**
1647	* @callback_method_impl{FNPGMPHYSNEMENUMCALLBACK,
1648	* Hack to unmap all pages when/before we run into quota (WHv only).}
1649	*/
1650	static DECLCALLBACK(int) nemR3WinWHvUnmapOnePageCallback(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys, uint8_t pu2NemState, void pvUser)
1651	{
1652	RT_NOREF_PV(pvUser);
1653	RT_NOREF_PV(pVCpu);
1654	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, X86_PAGE_SIZE);
1655	if (SUCCEEDED(hrc))
1656	{
1657	Log5(("NEM GPA unmap all: %RGp (cMappedPages=%u)\n", GCPhys, pVM->nem.s.cMappedPages - 1));
1658	*pu2NemState = NEM_WIN_PAGE_STATE_UNMAPPED;
1659	}
1660	else
1661	{
1662	LogRel(("nemR3WinWHvUnmapOnePageCallback: GCPhys=%RGp %s hrc=%Rhrc (%#x) Last=%#x/%u (cMappedPages=%u)\n",
1663	GCPhys, g_apszPageStates[*pu2NemState], hrc, hrc, RTNtLastStatusValue(),
1664	RTNtLastErrorValue(), pVM->nem.s.cMappedPages));
1665	*pu2NemState = NEM_WIN_PAGE_STATE_NOT_SET;
1666	}
1667	if (pVM->nem.s.cMappedPages > 0)
1668	ASMAtomicDecU32(&pVM->nem.s.cMappedPages);
1669	return VINF_SUCCESS;
1670	}
1671	# endif /* !NEM_WIN_USE_HYPERCALLS_FOR_PAGES */
1672
1673
1674	/**
1675	* Handles an memory access VMEXIT.
1676	*
1677	* This can be triggered by a number of things.
1678	*
1679	* @returns Strict VBox status code.
1680	* @param pVM The cross context VM structure.
1681	* @param pVCpu The cross context virtual CPU structure.
1682	* @param pCtx The CPU context to update.
1683	* @param pMemCtx The exit reason information.
1684	* @param pVpContext The processor context info associated with the exit.
1685	*/
1686	static VBOXSTRICTRC nemR3WinWHvHandleMemoryAccess(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_MEMORY_ACCESS_CONTEXT const *pMemCtx,
1687	WHV_VP_EXIT_CONTEXT const *pVpContext)
1688	{
1689	/*
1690	* Ask PGM for information about the given GCPhys. We need to check if we're
1691	* out of sync first.
1692	*/
1693	NEMHCWINHMACPCCSTATE State = { pMemCtx->AccessInfo.AccessType == WHvMemoryAccessWrite, false, false };
1694	PGMPHYSNEMPAGEINFO Info;
1695	int rc = PGMPhysNemPageInfoChecker(pVM, pVCpu, pMemCtx->Gpa, State.fWriteAccess, &Info,
1696	nemHCWinHandleMemoryAccessPageCheckerCallback, &State);
1697	if (RT_SUCCESS(rc))
1698	{
1699	if (Info.fNemProt & (pMemCtx->AccessInfo.AccessType == WHvMemoryAccessWrite ? NEM_PAGE_PROT_WRITE : NEM_PAGE_PROT_READ))
1700	{
1701	if (State.fCanResume)
1702	{
1703	Log4(("MemExit: %RGp (=>%RHp) %s fProt=%u%s%s%s; restarting (%s)\n",
1704	pMemCtx->Gpa, Info.HCPhys, g_apszPageStates[Info.u2NemState], Info.fNemProt,
1705	Info.fHasHandlers ? " handlers" : "", Info.fZeroPage ? " zero-pg" : "",
1706	State.fDidSomething ? "" : " no-change", g_apszWHvMemAccesstypes[pMemCtx->AccessInfo.AccessType]));
1707	return VINF_SUCCESS;
1708	}
1709	}
1710	Log4(("MemExit: %RGp (=>%RHp) %s fProt=%u%s%s%s; emulating (%s)\n",
1711	pMemCtx->Gpa, Info.HCPhys, g_apszPageStates[Info.u2NemState], Info.fNemProt,
1712	Info.fHasHandlers ? " handlers" : "", Info.fZeroPage ? " zero-pg" : "",
1713	State.fDidSomething ? "" : " no-change", g_apszWHvMemAccesstypes[pMemCtx->AccessInfo.AccessType]));
1714	}
1715	else
1716	Log4(("MemExit: %RGp rc=%Rrc%s; emulating (%s)\n", pMemCtx->Gpa, rc,
1717	State.fDidSomething ? " modified-backing" : "", g_apszWHvMemAccesstypes[pMemCtx->AccessInfo.AccessType]));
1718
1719	/*
1720	* Emulate the memory access, either access handler or special memory.
1721	*/
1722	rc = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM);
1723	AssertRCReturn(rc, rc);
1724
1725	VBOXSTRICTRC rcStrict;
1726	if (pMemCtx->InstructionByteCount > 0)
1727	rcStrict = IEMExecOneWithPrefetchedByPC(pVCpu, CPUMCTX2CORE(pCtx), pVpContext->Rip,
1728	&pMemCtx->InstructionBytes[0], pMemCtx->InstructionByteCount);
1729	else
1730	rcStrict = IEMExecOne(pVCpu);
1731	/** @todo do we need to do anything wrt debugging here? */
1732	return rcStrict;
1733	}
1734
1735
1736	/**
1737	* Handles an I/O port access VMEXIT.
1738	*
1739	* We ASSUME that the hypervisor has don't I/O port access control.
1740	*
1741	* @returns Strict VBox status code.
1742	* @param pVM The cross context VM structure.
1743	* @param pVCpu The cross context virtual CPU structure.
1744	* @param pCtx The CPU context to update.
1745	* @param pIoPortCtx The exit reason information.
1746	* @param pVpContext The processor context info associated with the exit.
1747	*/
1748	static VBOXSTRICTRC
1749	nemR3WinWHvHandleIoPortAccess(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_X64_IO_PORT_ACCESS_CONTEXT const *pIoPortCtx,
1750	WHV_VP_EXIT_CONTEXT const *pVpContext)
1751	{
1752	Assert( pIoPortCtx->AccessInfo.AccessSize == 1
1753	\|\| pIoPortCtx->AccessInfo.AccessSize == 2
1754	\|\| pIoPortCtx->AccessInfo.AccessSize == 4);
1755
1756	VBOXSTRICTRC rcStrict;
1757	if (!pIoPortCtx->AccessInfo.StringOp)
1758	{
1759	/*
1760	* Simple port I/O.
1761	*/
1762	//Assert(pCtx->rax == pIoPortCtx->Rax); - sledgehammer
1763
1764	static uint32_t const s_fAndMask[8] =
1765	{ UINT32_MAX, UINT32_C(0xff), UINT32_C(0xffff), UINT32_MAX, UINT32_MAX, UINT32_MAX, UINT32_MAX, UINT32_MAX };
1766	uint32_t const fAndMask = s_fAndMask[pIoPortCtx->AccessInfo.AccessSize];
1767	if (pIoPortCtx->AccessInfo.IsWrite)
1768	{
1769	rcStrict = IOMIOPortWrite(pVM, pVCpu, pIoPortCtx->PortNumber, (uint32_t)pIoPortCtx->Rax & fAndMask,
1770	pIoPortCtx->AccessInfo.AccessSize);
1771	if (IOM_SUCCESS(rcStrict))
1772	nemR3WinAdvanceGuestRipAndClearRF(pVCpu, pCtx, pVpContext);
1773	}
1774	else
1775	{
1776	uint32_t uValue = 0;
1777	rcStrict = IOMIOPortRead(pVM, pVCpu, pIoPortCtx->PortNumber, &uValue,
1778	pIoPortCtx->AccessInfo.AccessSize);
1779	if (IOM_SUCCESS(rcStrict))
1780	{
1781	pCtx->eax = (pCtx->eax & ~fAndMask) \| (uValue & fAndMask);
1782	nemR3WinAdvanceGuestRipAndClearRF(pVCpu, pCtx, pVpContext);
1783	}
1784	}
1785	}
1786	else
1787	{
1788	/*
1789	* String port I/O.
1790	*/
1791	/** @todo Someone at Microsoft please explain how we can get the address mode
1792	* from the IoPortAccess.VpContext. CS.Attributes is only sufficient for
1793	* getting the default mode, it can always be overridden by a prefix. This
1794	* forces us to interpret the instruction from opcodes, which is suboptimal.
1795	* Both AMD-V and VT-x includes the address size in the exit info, at least on
1796	* CPUs that are reasonably new. */
1797	# if 0 // requires sledgehammer
1798	Assert( pIoPortCtx->Ds.Base == pCtx->ds.u64Base
1799	&& pIoPortCtx->Ds.Limit == pCtx->ds.u32Limit
1800	&& pIoPortCtx->Ds.Selector == pCtx->ds.Sel);
1801	Assert( pIoPortCtx->Es.Base == pCtx->es.u64Base
1802	&& pIoPortCtx->Es.Limit == pCtx->es.u32Limit
1803	&& pIoPortCtx->Es.Selector == pCtx->es.Sel);
1804	Assert(pIoPortCtx->Rdi == pCtx->rdi);
1805	Assert(pIoPortCtx->Rsi == pCtx->rsi);
1806	Assert(pIoPortCtx->Rcx == pCtx->rcx);
1807	Assert(pIoPortCtx->Rcx == pCtx->rcx);
1808	# endif
1809
1810	int rc = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM);
1811	AssertRCReturn(rc, rc);
1812
1813	rcStrict = IEMExecOne(pVCpu);
1814	}
1815	if (IOM_SUCCESS(rcStrict))
1816	{
1817	/*
1818	* Do debug checks.
1819	*/
1820	if ( pVpContext->ExecutionState.DebugActive /** @todo Microsoft: Does DebugActive this only reflext DR7? */
1821	\|\| (pVpContext->Rflags & X86_EFL_TF)
1822	\|\| DBGFBpIsHwIoArmed(pVM) )
1823	{
1824	/** @todo Debugging. */
1825	}
1826	}
1827	return rcStrict;
1828	}
1829
1830
1831	static VBOXSTRICTRC nemR3WinWHvHandleInterruptWindow(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1832	{
1833	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1834	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1835	}
1836
1837
1838	static VBOXSTRICTRC nemR3WinWHvHandleMsrAccess(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1839	{
1840	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1841	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1842	}
1843
1844
1845	static VBOXSTRICTRC nemR3WinWHvHandleCpuId(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1846	{
1847	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1848	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1849	}
1850
1851
1852	static VBOXSTRICTRC nemR3WinWHvHandleException(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1853	{
1854	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1855	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1856	}
1857
1858
1859	static VBOXSTRICTRC nemR3WinWHvHandleUD(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1860	{
1861	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1862	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1863	}
1864
1865
1866	static VBOXSTRICTRC nemR3WinWHvHandleTripleFault(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1867	{
1868	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1869	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1870	}
1871
1872
1873	static VBOXSTRICTRC nemR3WinWHvHandleInvalidState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, WHV_RUN_VP_EXIT_CONTEXT const *pExitReason)
1874	{
1875	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx); NOREF(pExitReason);
1876	AssertLogRelFailedReturn(VERR_NOT_IMPLEMENTED);
1877	}
1878
1879
1880	VBOXSTRICTRC nemR3WinWHvRunGC(PVM pVM, PVMCPU pVCpu)
1881	{
1882	# ifdef LOG_ENABLED
1883	if (LogIs3Enabled())
1884	{
1885	Log3(("nemR3NativeRunGC: Entering #%u\n", pVCpu->idCpu));
1886	nemHCWinLogState(pVM, pVCpu);
1887	}
1888	# endif
1889
1890	/*
1891	* The run loop.
1892	*/
1893	PCPUMCTX pCtx = CPUMQueryGuestCtxPtr(pVCpu);
1894	const bool fSingleStepping = false; /** @todo get this from somewhere. */
1895	VBOXSTRICTRC rcStrict = VINF_SUCCESS;
1896	for (unsigned iLoop = 0;;iLoop++)
1897	{
1898	/*
1899	* Copy the state.
1900	*/
1901	int rc2 = nemHCWinCopyStateToHyperV(pVM, pVCpu, pCtx);
1902	AssertRCBreakStmt(rc2, rcStrict = rc2);
1903
1904	/*
1905	* Run a bit.
1906	*/
1907	WHV_RUN_VP_EXIT_CONTEXT ExitReason;
1908	RT_ZERO(ExitReason);
1909	if ( !VM_FF_IS_PENDING(pVM, VM_FF_EMT_RENDEZVOUS \| VM_FF_TM_VIRTUAL_SYNC)
1910	&& !VMCPU_FF_IS_PENDING(pVCpu, VMCPU_FF_HM_TO_R3_MASK))
1911	{
1912	Log8(("Calling WHvRunVirtualProcessor\n"));
1913	VMCPU_CMPXCHG_STATE(pVCpu, VMCPUSTATE_STARTED_EXEC_NEM, VMCPUSTATE_STARTED);
1914	HRESULT hrc = WHvRunVirtualProcessor(pVM->nem.s.hPartition, pVCpu->idCpu, &ExitReason, sizeof(ExitReason));
1915	VMCPU_CMPXCHG_STATE(pVCpu, VMCPUSTATE_STARTED, VMCPUSTATE_STARTED_EXEC_NEM);
1916	AssertLogRelMsgBreakStmt(SUCCEEDED(hrc),
1917	("WHvRunVirtualProcessor(%p, %u,,) -> %Rhrc (Last=%#x/%u)\n", pVM->nem.s.hPartition, pVCpu->idCpu,
1918	hrc, RTNtLastStatusValue(), RTNtLastErrorValue()),
1919	rcStrict = VERR_INTERNAL_ERROR);
1920	Log2(("WHvRunVirtualProcessor -> %#x; exit code %#x (%d) (cpu status %u)\n",
1921	hrc, ExitReason.ExitReason, ExitReason.ExitReason, nemHCWinCpuGetRunningStatus(pVCpu) ));
1922	}
1923	else
1924	{
1925	LogFlow(("nemR3NativeRunGC: returning: pending FF (pre exec)\n"));
1926	break;
1927	}
1928
1929	# if 0 /* sledgehammer approach */
1930	/*
1931	* Copy back the state.
1932	*/
1933	rc2 = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, UINT64_MAX);
1934	AssertRCBreakStmt(rc2, rcStrict = rc2);
1935	# endif
1936
1937	# ifdef LOG_ENABLED
1938	/*
1939	* Do some logging.
1940	*/
1941	if (LogIs2Enabled())
1942	nemR3WinLogWHvExitReason(&ExitReason);
1943	if (LogIs3Enabled())
1944	nemHCWinLogState(pVM, pVCpu);
1945	# endif
1946
1947	# if 0 //def VBOX_STRICT - requires sledgehammer
1948	/* Assert that the VpContext field makes sense. */
1949	switch (ExitReason.ExitReason)
1950	{
1951	case WHvRunVpExitReasonMemoryAccess:
1952	case WHvRunVpExitReasonX64IoPortAccess:
1953	case WHvRunVpExitReasonX64MsrAccess:
1954	case WHvRunVpExitReasonX64Cpuid:
1955	case WHvRunVpExitReasonException:
1956	case WHvRunVpExitReasonUnrecoverableException:
1957	Assert( ExitReason.IoPortAccess.VpContext.InstructionLength > 0
1958	\|\| ( ExitReason.ExitReason == WHvRunVpExitReasonMemoryAccess
1959	&& ExitReason.MemoryAccess.AccessInfo.AccessType == WHvMemoryAccessExecute));
1960	Assert(ExitReason.IoPortAccess.VpContext.InstructionLength < 16);
1961	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Cpl == CPUMGetGuestCPL(pVCpu));
1962	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Cr0Pe == RT_BOOL(pCtx->cr0 & X86_CR0_PE));
1963	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Cr0Am == RT_BOOL(pCtx->cr0 & X86_CR0_AM));
1964	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.EferLma == RT_BOOL(pCtx->msrEFER & MSR_K6_EFER_LMA));
1965	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.DebugActive == RT_BOOL(pCtx->dr[7] & X86_DR7_ENABLED_MASK));
1966	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Reserved0 == 0);
1967	Assert(ExitReason.IoPortAccess.VpContext.ExecutionState.Reserved1 == 0);
1968	Assert(ExitReason.IoPortAccess.VpContext.Rip == pCtx->rip);
1969	Assert(ExitReason.IoPortAccess.VpContext.Rflags == pCtx->rflags.u);
1970	Assert( ExitReason.IoPortAccess.VpContext.Cs.Base == pCtx->cs.u64Base
1971	&& ExitReason.IoPortAccess.VpContext.Cs.Limit == pCtx->cs.u32Limit
1972	&& ExitReason.IoPortAccess.VpContext.Cs.Selector == pCtx->cs.Sel);
1973	break;
1974	default: break; /* shut up compiler. */
1975	}
1976	# endif
1977
1978	/*
1979	* Deal with the exit.
1980	*/
1981	switch (ExitReason.ExitReason)
1982	{
1983	/* Frequent exits: */
1984	case WHvRunVpExitReasonCanceled:
1985	//case WHvRunVpExitReasonAlerted:
1986	rcStrict = VINF_SUCCESS;
1987	break;
1988
1989	case WHvRunVpExitReasonX64Halt:
1990	rcStrict = nemR3WinWHvHandleHalt(pVM, pVCpu, pCtx);
1991	break;
1992
1993	case WHvRunVpExitReasonMemoryAccess:
1994	rcStrict = nemR3WinWHvHandleMemoryAccess(pVM, pVCpu, pCtx, &ExitReason.MemoryAccess, &ExitReason.VpContext);
1995	break;
1996
1997	case WHvRunVpExitReasonX64IoPortAccess:
1998	rcStrict = nemR3WinWHvHandleIoPortAccess(pVM, pVCpu, pCtx, &ExitReason.IoPortAccess, &ExitReason.VpContext);
1999	break;
2000
2001	case WHvRunVpExitReasonX64InterruptWindow:
2002	rcStrict = nemR3WinWHvHandleInterruptWindow(pVM, pVCpu, pCtx, &ExitReason);
2003	break;
2004
2005	case WHvRunVpExitReasonX64MsrAccess: /* needs configuring */
2006	rcStrict = nemR3WinWHvHandleMsrAccess(pVM, pVCpu, pCtx, &ExitReason);
2007	break;
2008
2009	case WHvRunVpExitReasonX64Cpuid: /* needs configuring */
2010	rcStrict = nemR3WinWHvHandleCpuId(pVM, pVCpu, pCtx, &ExitReason);
2011	break;
2012
2013	case WHvRunVpExitReasonException: /* needs configuring */
2014	rcStrict = nemR3WinWHvHandleException(pVM, pVCpu, pCtx, &ExitReason);
2015	break;
2016
2017	/* Unlikely exits: */
2018	case WHvRunVpExitReasonUnsupportedFeature:
2019	rcStrict = nemR3WinWHvHandleUD(pVM, pVCpu, pCtx, &ExitReason);
2020	break;
2021
2022	case WHvRunVpExitReasonUnrecoverableException:
2023	rcStrict = nemR3WinWHvHandleTripleFault(pVM, pVCpu, pCtx, &ExitReason);
2024	break;
2025
2026	case WHvRunVpExitReasonInvalidVpRegisterValue:
2027	rcStrict = nemR3WinWHvHandleInvalidState(pVM, pVCpu, pCtx, &ExitReason);
2028	break;
2029
2030	/* Undesired exits: */
2031	case WHvRunVpExitReasonNone:
2032	default:
2033	AssertLogRelMsgFailed(("Unknown ExitReason: %#x\n", ExitReason.ExitReason));
2034	rcStrict = VERR_INTERNAL_ERROR_3;
2035	break;
2036	}
2037	if (rcStrict != VINF_SUCCESS)
2038	{
2039	LogFlow(("nemR3NativeRunGC: returning: %Rrc\n", VBOXSTRICTRC_VAL(rcStrict)));
2040	break;
2041	}
2042
2043	# ifndef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
2044	/* Hack alert! */
2045	uint32_t const cMappedPages = pVM->nem.s.cMappedPages;
2046	if (cMappedPages < 4000)
2047	{ /* likely */ }
2048	else
2049	{
2050	PGMPhysNemEnumPagesByState(pVM, pVCpu, NEM_WIN_PAGE_STATE_READABLE, nemR3WinWHvUnmapOnePageCallback, NULL);
2051	Log(("nemR3NativeRunGC: Unmapped all; cMappedPages=%u -> %u\n", cMappedPages, pVM->nem.s.cMappedPages));
2052	}
2053	# endif
2054
2055	/* If any FF is pending, return to the EM loops. That's okay for the
2056	current sledgehammer approach. */
2057	if ( VM_FF_IS_PENDING( pVM, !fSingleStepping ? VM_FF_HP_R0_PRE_HM_MASK : VM_FF_HP_R0_PRE_HM_STEP_MASK)
2058	\|\| VMCPU_FF_IS_PENDING(pVCpu, !fSingleStepping ? VMCPU_FF_HP_R0_PRE_HM_MASK : VMCPU_FF_HP_R0_PRE_HM_STEP_MASK) )
2059	{
2060	LogFlow(("nemR3NativeRunGC: returning: pending FF (%#x / %#x)\n", pVM->fGlobalForcedActions, pVCpu->fLocalForcedActions));
2061	break;
2062	}
2063	}
2064
2065
2066	/*
2067	* Copy back the state before returning.
2068	*/
2069	if (pCtx->fExtrn & (CPUMCTX_EXTRN_ALL \| (CPUMCTX_EXTRN_NEM_WIN_MASK & ~CPUMCTX_EXTRN_NEM_WIN_EVENT_INJECT)))
2070	{
2071	int rc2 = nemHCWinCopyStateFromHyperV(pVM, pVCpu, pCtx, CPUMCTX_EXTRN_ALL \| CPUMCTX_EXTRN_NEM_WIN_MASK);
2072	if (RT_SUCCESS(rc2))
2073	pCtx->fExtrn = 0;
2074	else if (RT_SUCCESS(rcStrict))
2075	rcStrict = rc2;
2076	}
2077	else
2078	pCtx->fExtrn = 0;
2079
2080	return rcStrict;
2081	}
2082
2083	#endif /* !NEM_WIN_USE_OUR_OWN_RUN_API - migrating to NEMAllNativeTemplate-win.cpp.h*/
2084
2085
2086	VBOXSTRICTRC nemR3NativeRunGC(PVM pVM, PVMCPU pVCpu)
2087	{
2088	#if !defined(NEM_WIN_USE_OUR_OWN_RUN_API) \|\| 0
2089	return nemHCWinRunGC(pVM, pVCpu, NULL /pGVM/, NULL /pGVCpu/);
2090	#else
2091	for (;;)
2092	{
2093	VBOXSTRICTRC rcStrict = VMMR3CallR0EmtFast(pVM, pVCpu, VMMR0_DO_NEM_RUN);
2094	if (RT_SUCCESS(rcStrict))
2095	{
2096	/*
2097	* We deal with VINF_NEM_CHANGE_PGM_MODE, VINF_NEM_FLUSH_TLB and
2098	* VINF_NEM_UPDATE_APIC_BASE here, since we're running the risk of
2099	* getting these while we already got another RC (I/O ports).
2100	*
2101	* The APIC base update and a PGM update can happen at the same time, so
2102	* we don't depend on the status code for that and always checks it first.
2103	*/
2104	/* APIC base: */
2105	if (pVCpu->nem.s.uPendingApicBase != UINT64_MAX)
2106	{
2107	LogFlow(("nemR3NativeRunGC: calling APICSetBaseMsr(,%RX64)...\n", pVCpu->nem.s.uPendingApicBase));
2108	VBOXSTRICTRC rc2 = APICSetBaseMsr(pVCpu, pVCpu->nem.s.uPendingApicBase);
2109	AssertLogRelMsg(rc2 == VINF_SUCCESS, ("rc2=%Rrc [%#RX64]\n", VBOXSTRICTRC_VAL(rc2), pVCpu->nem.s.uPendingApicBase));
2110	pVCpu->nem.s.uPendingApicBase = UINT64_MAX;
2111	}
2112
2113	/* Status codes: */
2114	VBOXSTRICTRC rcPending = pVCpu->nem.s.rcPending;
2115	pVCpu->nem.s.rcPending = VINF_SUCCESS;
2116	if ( rcStrict == VINF_NEM_CHANGE_PGM_MODE
2117	\|\| rcStrict == VINF_PGM_CHANGE_MODE
2118	\|\| rcPending == VINF_NEM_CHANGE_PGM_MODE )
2119	{
2120	LogFlow(("nemR3NativeRunGC: calling PGMChangeMode...\n"));
2121	int rc = PGMChangeMode(pVCpu, CPUMGetGuestCR0(pVCpu), CPUMGetGuestCR4(pVCpu), CPUMGetGuestEFER(pVCpu));
2122	AssertRCReturn(rc, rc);
2123	if (rcStrict == VINF_NEM_CHANGE_PGM_MODE \|\| rcStrict == VINF_NEM_FLUSH_TLB)
2124	{
2125	if ( !VM_FF_IS_PENDING(pVM, VM_FF_HIGH_PRIORITY_POST_MASK \| VM_FF_HP_R0_PRE_HM_MASK)
2126	&& !VMCPU_FF_IS_PENDING(pVCpu, (VMCPU_FF_HIGH_PRIORITY_POST_MASK \| VMCPU_FF_HP_R0_PRE_HM_MASK)
2127	& ~VMCPU_FF_RESUME_GUEST_MASK))
2128	{
2129	VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_RESUME_GUEST_MASK);
2130	continue;
2131	}
2132	rcStrict = VINF_SUCCESS;
2133	}
2134	}
2135	else if (rcStrict == VINF_NEM_FLUSH_TLB \|\| rcPending == VINF_NEM_FLUSH_TLB)
2136	{
2137	LogFlow(("nemR3NativeRunGC: calling PGMFlushTLB...\n"));
2138	int rc = PGMFlushTLB(pVCpu, CPUMGetGuestCR3(pVCpu), true);
2139	AssertRCReturn(rc, rc);
2140	if (rcStrict == VINF_NEM_FLUSH_TLB \|\| rcStrict == VINF_NEM_CHANGE_PGM_MODE)
2141	{
2142	if ( !VM_FF_IS_PENDING(pVM, VM_FF_HIGH_PRIORITY_POST_MASK \| VM_FF_HP_R0_PRE_HM_MASK)
2143	&& !VMCPU_FF_IS_PENDING(pVCpu, (VMCPU_FF_HIGH_PRIORITY_POST_MASK \| VMCPU_FF_HP_R0_PRE_HM_MASK)
2144	& ~VMCPU_FF_RESUME_GUEST_MASK))
2145	{
2146	VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_RESUME_GUEST_MASK);
2147	continue;
2148	}
2149	rcStrict = VINF_SUCCESS;
2150	}
2151	}
2152	else if (rcStrict == VINF_NEM_UPDATE_APIC_BASE \|\| rcPending == VERR_NEM_UPDATE_APIC_BASE)
2153	continue;
2154	else
2155	AssertMsg(rcPending == VINF_SUCCESS, ("rcPending=%Rrc\n", VBOXSTRICTRC_VAL(rcPending) ));
2156	}
2157	LogFlow(("nemR3NativeRunGC: returns %Rrc\n", VBOXSTRICTRC_VAL(rcStrict) ));
2158	return rcStrict;
2159	}
2160	#endif
2161	}
2162
2163
2164	bool nemR3NativeCanExecuteGuest(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx)
2165	{
2166	NOREF(pVM); NOREF(pVCpu); NOREF(pCtx);
2167	return true;
2168	}
2169
2170
2171	bool nemR3NativeSetSingleInstruction(PVM pVM, PVMCPU pVCpu, bool fEnable)
2172	{
2173	NOREF(pVM); NOREF(pVCpu); NOREF(fEnable);
2174	return false;
2175	}
2176
2177
2178	/**
2179	* Forced flag notification call from VMEmt.h.
2180	*
2181	* This is only called when pVCpu is in the VMCPUSTATE_STARTED_EXEC_NEM state.
2182	*
2183	* @param pVM The cross context VM structure.
2184	* @param pVCpu The cross context virtual CPU structure of the CPU
2185	* to be notified.
2186	* @param fFlags Notification flags, VMNOTIFYFF_FLAGS_XXX.
2187	*/
2188	void nemR3NativeNotifyFF(PVM pVM, PVMCPU pVCpu, uint32_t fFlags)
2189	{
2190	#ifdef NEM_WIN_USE_OUR_OWN_RUN_API
2191	nemHCWinCancelRunVirtualProcessor(pVM, pVCpu);
2192	#else
2193	Log8(("nemR3NativeNotifyFF: canceling %u\n", pVCpu->idCpu));
2194	HRESULT hrc = WHvCancelRunVirtualProcessor(pVM->nem.s.hPartition, pVCpu->idCpu, 0);
2195	AssertMsg(SUCCEEDED(hrc), ("WHvCancelRunVirtualProcessor -> hrc=%Rhrc\n", hrc));
2196	RT_NOREF_PV(hrc);
2197	#endif
2198	RT_NOREF_PV(fFlags);
2199	}
2200
2201
2202	DECLINLINE(int) nemR3NativeGCPhys2R3PtrReadOnly(PVM pVM, RTGCPHYS GCPhys, const void **ppv)
2203	{
2204	PGMPAGEMAPLOCK Lock;
2205	int rc = PGMPhysGCPhys2CCPtrReadOnly(pVM, GCPhys, ppv, &Lock);
2206	if (RT_SUCCESS(rc))
2207	PGMPhysReleasePageMappingLock(pVM, &Lock);
2208	return rc;
2209	}
2210
2211
2212	DECLINLINE(int) nemR3NativeGCPhys2R3PtrWriteable(PVM pVM, RTGCPHYS GCPhys, void **ppv)
2213	{
2214	PGMPAGEMAPLOCK Lock;
2215	int rc = PGMPhysGCPhys2CCPtr(pVM, GCPhys, ppv, &Lock);
2216	if (RT_SUCCESS(rc))
2217	PGMPhysReleasePageMappingLock(pVM, &Lock);
2218	return rc;
2219	}
2220
2221
2222	int nemR3NativeNotifyPhysRamRegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb)
2223	{
2224	Log5(("nemR3NativeNotifyPhysRamRegister: %RGp LB %RGp\n", GCPhys, cb));
2225	NOREF(pVM); NOREF(GCPhys); NOREF(cb);
2226	return VINF_SUCCESS;
2227	}
2228
2229
2230	int nemR3NativeNotifyPhysMmioExMap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags, void *pvMmio2)
2231	{
2232	Log5(("nemR3NativeNotifyPhysMmioExMap: %RGp LB %RGp fFlags=%#x pvMmio2=%p\n", GCPhys, cb, fFlags, pvMmio2));
2233	NOREF(pVM); NOREF(GCPhys); NOREF(cb); NOREF(fFlags); NOREF(pvMmio2);
2234	return VINF_SUCCESS;
2235	}
2236
2237
2238	int nemR3NativeNotifyPhysMmioExUnmap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags)
2239	{
2240	Log5(("nemR3NativeNotifyPhysMmioExUnmap: %RGp LB %RGp fFlags=%#x\n", GCPhys, cb, fFlags));
2241	NOREF(pVM); NOREF(GCPhys); NOREF(cb); NOREF(fFlags);
2242	return VINF_SUCCESS;
2243	}
2244
2245
2246	/**
2247	* Called early during ROM registration, right after the pages have been
2248	* allocated and the RAM range updated.
2249	*
2250	* This will be succeeded by a number of NEMHCNotifyPhysPageProtChanged() calls
2251	* and finally a NEMR3NotifyPhysRomRegisterEarly().
2252	*
2253	* @returns VBox status code
2254	* @param pVM The cross context VM structure.
2255	* @param GCPhys The ROM address (page aligned).
2256	* @param cb The size (page aligned).
2257	* @param fFlags NEM_NOTIFY_PHYS_ROM_F_XXX.
2258	*/
2259	int nemR3NativeNotifyPhysRomRegisterEarly(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags)
2260	{
2261	Log5(("nemR3NativeNotifyPhysRomRegisterEarly: %RGp LB %RGp fFlags=%#x\n", GCPhys, cb, fFlags));
2262	#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. */
2263	RTGCPHYS const cPages = cb >> X86_PAGE_SHIFT;
2264	for (RTGCPHYS iPage = 0; iPage < cPages; iPage++, GCPhys += X86_PAGE_SIZE)
2265	{
2266	const void *pvPage;
2267	int rc = nemR3NativeGCPhys2R3PtrReadOnly(pVM, GCPhys, &pvPage);
2268	if (RT_SUCCESS(rc))
2269	{
2270	HRESULT hrc = WHvMapGpaRange(pVM->nem.s.hPartition, (void *)pvPage, GCPhys, X86_PAGE_SIZE,
2271	WHvMapGpaRangeFlagRead \| WHvMapGpaRangeFlagExecute);
2272	if (SUCCEEDED(hrc))
2273	{ /* likely */ }
2274	else
2275	{
2276	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp hrc=%Rhrc (%#x) Last=%#x/%u\n",
2277	GCPhys, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
2278	return VERR_NEM_INIT_FAILED;
2279	}
2280	}
2281	else
2282	{
2283	LogRel(("nemR3NativeNotifyPhysRomRegisterEarly: GCPhys=%RGp rc=%Rrc\n", GCPhys, rc));
2284	return rc;
2285	}
2286	}
2287	#else
2288	NOREF(pVM); NOREF(GCPhys); NOREF(cb);
2289	#endif
2290	RT_NOREF_PV(fFlags);
2291	return VINF_SUCCESS;
2292	}
2293
2294
2295	/**
2296	* Called after the ROM range has been fully completed.
2297	*
2298	* This will be preceeded by a NEMR3NotifyPhysRomRegisterEarly() call as well a
2299	* number of NEMHCNotifyPhysPageProtChanged calls.
2300	*
2301	* @returns VBox status code
2302	* @param pVM The cross context VM structure.
2303	* @param GCPhys The ROM address (page aligned).
2304	* @param cb The size (page aligned).
2305	* @param fFlags NEM_NOTIFY_PHYS_ROM_F_XXX.
2306	*/
2307	int nemR3NativeNotifyPhysRomRegisterLate(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags)
2308	{
2309	Log5(("nemR3NativeNotifyPhysRomRegisterLate: %RGp LB %RGp fFlags=%#x\n", GCPhys, cb, fFlags));
2310	NOREF(pVM); NOREF(GCPhys); NOREF(cb); NOREF(fFlags);
2311	return VINF_SUCCESS;
2312	}
2313
2314
2315	/**
2316	* @callback_method_impl{FNPGMPHYSNEMCHECKPAGE}
2317	*/
2318	static DECLCALLBACK(int) nemR3WinUnsetForA20CheckerCallback(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys,
2319	PPGMPHYSNEMPAGEINFO pInfo, void *pvUser)
2320	{
2321	/* We'll just unmap the memory. */
2322	if (pInfo->u2NemState > NEM_WIN_PAGE_STATE_UNMAPPED)
2323	{
2324	#ifdef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
2325	int rc = nemHCWinHypercallUnmapPage(pVM, pVCpu, GCPhys);
2326	AssertRC(rc);
2327	if (RT_SUCCESS(rc))
2328	#else
2329	HRESULT hrc = WHvUnmapGpaRange(pVM->nem.s.hPartition, GCPhys, X86_PAGE_SIZE);
2330	if (SUCCEEDED(hrc))
2331	#endif
2332	{
2333	uint32_t cMappedPages = ASMAtomicDecU32(&pVM->nem.s.cMappedPages); NOREF(cMappedPages);
2334	Log5(("NEM GPA unmapped/A20: %RGp (was %s, cMappedPages=%u)\n", GCPhys, g_apszPageStates[pInfo->u2NemState], cMappedPages));
2335	pInfo->u2NemState = NEM_WIN_PAGE_STATE_UNMAPPED;
2336	}
2337	else
2338	{
2339	#ifdef NEM_WIN_USE_HYPERCALLS_FOR_PAGES
2340	LogRel(("nemR3WinUnsetForA20CheckerCallback/unmap: GCPhys=%RGp rc=%Rrc\n", GCPhys, rc));
2341	return rc;
2342	#else
2343	LogRel(("nemR3WinUnsetForA20CheckerCallback/unmap: GCPhys=%RGp hrc=%Rhrc (%#x) Last=%#x/%u\n",
2344	GCPhys, hrc, hrc, RTNtLastStatusValue(), RTNtLastErrorValue()));
2345	return VERR_INTERNAL_ERROR_2;
2346	#endif
2347	}
2348	}
2349	RT_NOREF(pVCpu, pvUser);
2350	return VINF_SUCCESS;
2351	}
2352
2353
2354	/**
2355	* Unmaps a page from Hyper-V for the purpose of emulating A20 gate behavior.
2356	*
2357	* @returns The PGMPhysNemQueryPageInfo result.
2358	* @param pVM The cross context VM structure.
2359	* @param pVCpu The cross context virtual CPU structure.
2360	* @param GCPhys The page to unmap.
2361	*/
2362	static int nemR3WinUnmapPageForA20Gate(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys)
2363	{
2364	PGMPHYSNEMPAGEINFO Info;
2365	return PGMPhysNemPageInfoChecker(pVM, pVCpu, GCPhys, false /fMakeWritable/, &Info,
2366	nemR3WinUnsetForA20CheckerCallback, NULL);
2367	}
2368
2369
2370	/**
2371	* Called when the A20 state changes.
2372	*
2373	* Hyper-V doesn't seem to offer a simple way of implementing the A20 line
2374	* features of PCs. So, we do a very minimal emulation of the HMA to make DOS
2375	* happy.
2376	*
2377	* @param pVCpu The CPU the A20 state changed on.
2378	* @param fEnabled Whether it was enabled (true) or disabled.
2379	*/
2380	void nemR3NativeNotifySetA20(PVMCPU pVCpu, bool fEnabled)
2381	{
2382	Log(("nemR3NativeNotifySetA20: fEnabled=%RTbool\n", fEnabled));
2383	PVM pVM = pVCpu->CTX_SUFF(pVM);
2384	if (!pVM->nem.s.fA20Fixed)
2385	{
2386	pVM->nem.s.fA20Enabled = fEnabled;
2387	for (RTGCPHYS GCPhys = _1M; GCPhys < _1M + _64K; GCPhys += X86_PAGE_SIZE)
2388	nemR3WinUnmapPageForA20Gate(pVM, pVCpu, GCPhys);
2389	}
2390	}
2391
2392
2393	/** @page pg_nem_win NEM/win - Native Execution Manager, Windows.
2394	*
2395	* On Windows the Hyper-V root partition (dom0 in zen terminology) does not have
2396	* nested VT-x or AMD-V capabilities. For a while raw-mode worked inside it,
2397	* but for a while now we've been getting \#GP when trying to modify CR4 in the
2398	* world switcher. So, when Hyper-V is active on Windows we have little choice
2399	* but to use Hyper-V to run our VMs.
2400	*
2401	*
2402	* @section sub_nem_win_whv The WinHvPlatform API
2403	*
2404	* Since Windows 10 build 17083 there is a documented API for managing Hyper-V
2405	* VMs, header file WinHvPlatform.h and implementation in WinHvPlatform.dll.
2406	* This interface is a wrapper around the undocumented Virtualization
2407	* Infrastructure Driver (VID) API - VID.DLL and VID.SYS. The wrapper is
2408	* written in C++, namespaced, early versions (at least) was using standard C++
2409	* container templates in several places.
2410	*
2411	* When creating a VM using WHvCreatePartition, it will only create the
2412	* WinHvPlatform structures for it, to which you get an abstract pointer. The
2413	* VID API that actually creates the partition is first engaged when you call
2414	* WHvSetupPartition after first setting a lot of properties using
2415	* WHvSetPartitionProperty. Since the VID API is just a very thin wrapper
2416	* around CreateFile and NtDeviceIoControlFile, it returns an actual HANDLE for
2417	* the partition WinHvPlatform. We fish this HANDLE out of the WinHvPlatform
2418	* partition structures because we need to talk directly to VID for reasons
2419	* we'll get to in a bit. (Btw. we could also intercept the CreateFileW or
2420	* NtDeviceIoControlFile calls from VID.DLL to get the HANDLE should fishing in
2421	* the partition structures become difficult.)
2422	*
2423	* The WinHvPlatform API requires us to both set the number of guest CPUs before
2424	* setting up the partition and call WHvCreateVirtualProcessor for each of them.
2425	* The CPU creation function boils down to a VidMessageSlotMap call that sets up
2426	* and maps a message buffer into ring-3 for async communication with hyper-V
2427	* and/or the VID.SYS thread actually running the CPU thru
2428	* WinHvRunVpDispatchLoop(). When for instance a VMEXIT is encountered, hyper-V
2429	* sends a message that the WHvRunVirtualProcessor API retrieves (and later
2430	* acknowledges) via VidMessageSlotHandleAndGetNext. It should be noteded that
2431	* WHvDeleteVirtualProcessor doesn't do much as there seems to be no partner
2432	* function VidMessagesSlotMap that reverses what it did.
2433	*
2434	* Memory is managed thru calls to WHvMapGpaRange and WHvUnmapGpaRange (GPA does
2435	* not mean grade point average here, but rather guest physical addressspace),
2436	* which corresponds to VidCreateVaGpaRangeSpecifyUserVa and VidDestroyGpaRange
2437	* respectively. As 'UserVa' indicates, the functions works on user process
2438	* memory. The mappings are also subject to quota restrictions, so the number
2439	* of ranges are limited and probably their total size as well. Obviously
2440	* VID.SYS keeps track of the ranges, but so does WinHvPlatform, which means
2441	* there is a bit of overhead involved and quota restrctions makes sense. For
2442	* some reason though, regions are lazily mapped on VMEXIT/memory by
2443	* WHvRunVirtualProcessor.
2444	*
2445	* Running guest code is done thru the WHvRunVirtualProcessor function. It
2446	* asynchronously starts or resumes hyper-V CPU execution and then waits for an
2447	* VMEXIT message. Hyper-V / VID.SYS will return information about the message
2448	* in the message buffer mapping, and WHvRunVirtualProcessor will convert that
2449	* finto it's own WHV_RUN_VP_EXIT_CONTEXT format.
2450	*
2451	* Other threads can interrupt the execution by using WHvCancelVirtualProcessor,
2452	* which which case the thread in WHvRunVirtualProcessor is woken up via a dummy
2453	* QueueUserAPC and will call VidStopVirtualProcessor to asynchronously end
2454	* execution. The stop CPU call not immediately succeed if the CPU encountered
2455	* a VMEXIT before the stop was processed, in which case the VMEXIT needs to be
2456	* processed first, and the pending stop will be processed in a subsequent call
2457	* to WHvRunVirtualProcessor.
2458	*
2459	* Registers are retrieved and set via WHvGetVirtualProcessorRegisters and
2460	* WHvSetVirtualProcessorRegisters. In addition, several VMEXITs include
2461	* essential register state in the exit context information, potentially making
2462	* it possible to emulate the instruction causing the exit without involving
2463	* WHvGetVirtualProcessorRegisters.
2464	*
2465	*
2466	* @subsection subsec_nem_win_whv_cons Issues & Feedback
2467	*
2468	* Here are some observations (mostly against build 17101):
2469	*
2470	* - The VMEXIT performance is dismal (build 17134).
2471	*
2472	* Our proof of concept implementation with a kernel runloop (i.e. not using
2473	* WHvRunVirtualProcessor and friends, but calling VID.SYS fast I/O control
2474	* entry point directly) delivers 9-10% of the port I/O performance and only
2475	* 6-7% of the MMIO performance that we have with our own hypervisor.
2476	*
2477	* When using the offical WinHvPlatform API, the numbers are %3 for port I/O
2478	* and 5% for MMIO.
2479	*
2480	* While the tests we've done are using tight tight loops only doing port I/O
2481	* and MMIO, the problem is clearly visible when running regular guest OSes.
2482	* Anything that hammers the VGA device would be suffering, for example:
2483	*
2484	* - Windows 2000 boot screen animation overloads us with MMIO exits
2485	* and won't even boot because all the time is spent in interrupt
2486	* handlers and redrawin the screen.
2487	*
2488	* - DSL 4.4 and its bootmenu logo is slower than molasses in january.
2489	*
2490	* We have not found a workaround for this yet.
2491	*
2492	* Something that might improve the issue a little is to detect blocks with
2493	* excessive MMIO and port I/O exits and emulate instructions to cover
2494	* multiple exits before letting Hyper-V have a go at the guest execution
2495	* again. This will only improve the situation under some circumstances,
2496	* since emulating instructions without recompilation can be expensive, so
2497	* there will only be real gains if the exitting instructions are tightly
2498	* packed.
2499	*
2500	*
2501	* - Unable to access WHvX64RegisterMsrMtrrCap on AMD Ryzen (build 17134).
2502	*
2503	*
2504	* - On AMD Ryzen grub/debian 9.0 ends up with a unrecoverable exception
2505	* when IA32_MTRR_PHYSMASK0 is written.
2506	*
2507	*
2508	* - The IA32_APIC_BASE register does not work right:
2509	*
2510	* - Attempts by the guest to clear bit 11 (EN) are ignored, both the
2511	* guest and the VMM reads back the old value.
2512	*
2513	* - Attempts to modify the base address (bits NN:12) seems to be ignored
2514	* in the same way.
2515	*
2516	* - The VMM can modify both the base address as well as the the EN and
2517	* BSP bits, however this is useless if we cannot intercept the WRMSR.
2518	*
2519	* - Attempts by the guest to set the EXTD bit (X2APIC) result in \#GP(0),
2520	* while the VMM ends up with with ERROR_HV_INVALID_PARAMETER. Seems
2521	* there is no way to support X2APIC.
2522	*
2523	*
2524	* - The WHvCancelVirtualProcessor API schedules a dummy usermode APC callback
2525	* in order to cancel any current or future alertable wait in VID.SYS during
2526	* the VidMessageSlotHandleAndGetNext call.
2527	*
2528	* IIRC this will make the kernel schedule the specified callback thru
2529	* NTDLL!KiUserApcDispatcher by modifying the thread context and quite
2530	* possibly the userland thread stack. When the APC callback returns to
2531	* KiUserApcDispatcher, it will call NtContinue to restore the old thread
2532	* context and resume execution from there. This naturally adds up to some
2533	* CPU cycles, ring transitions aren't for free, especially after Spectre &
2534	* Meltdown mitigations.
2535	*
2536	* Using NtAltertThread call could do the same without the thread context
2537	* modifications and the extra kernel call.
2538	*
2539	*
2540	* - Not sure if this is a thing, but WHvCancelVirtualProcessor seems to cause
2541	* cause a lot more spurious WHvRunVirtualProcessor returns that what we get
2542	* with the replacement code. By spurious returns we mean that the
2543	* subsequent call to WHvRunVirtualProcessor would return immediately.
2544	*
2545	*
2546	* - When WHvRunVirtualProcessor returns without a message, or on a terse
2547	* VID message like HLT, it will make a kernel call to get some registers.
2548	* This is potentially inefficient if the caller decides he needs more
2549	* register state.
2550	*
2551	* It would be better to just return what's available and let the caller fetch
2552	* what is missing from his point of view in a single kernel call.
2553	*
2554	*
2555	* - The WHvRunVirtualProcessor implementation does lazy GPA range mappings when
2556	* a unmapped GPA message is received from hyper-V.
2557	*
2558	* Since MMIO is currently realized as unmapped GPA, this will slow down all
2559	* MMIO accesses a tiny little bit as WHvRunVirtualProcessor looks up the
2560	* guest physical address to check if it is a pending lazy mapping.
2561	*
2562	* The lazy mapping feature makes no sense to us. We as API user have all the
2563	* information and can do lazy mapping ourselves if we want/have to (see next
2564	* point).
2565	*
2566	*
2567	* - There is no API for modifying protection of a page within a GPA range.
2568	*
2569	* From what we can tell, the only way to modify the protection (like readonly
2570	* -> writable, or vice versa) is to first unmap the range and then remap it
2571	* with the new protection.
2572	*
2573	* We are for instance doing this quite a bit in order to track dirty VRAM
2574	* pages. VRAM pages starts out as readonly, when the guest writes to a page
2575	* we take an exit, notes down which page it is, makes it writable and restart
2576	* the instruction. After refreshing the display, we reset all the writable
2577	* pages to readonly again, bulk fashion.
2578	*
2579	* Now to work around this issue, we do page sized GPA ranges. In addition to
2580	* add a lot of tracking overhead to WinHvPlatform and VID.SYS, this also
2581	* causes us to exceed our quota before we've even mapped a default sized
2582	* (128MB) VRAM page-by-page. So, to work around this quota issue we have to
2583	* lazily map pages and actively restrict the number of mappings.
2584	*
2585	* Our best workaround thus far is bypassing WinHvPlatform and VID entirely
2586	* when in comes to guest memory management and instead use the underlying
2587	* hypercalls (HvCallMapGpaPages, HvCallUnmapGpaPages) to do it ourselves.
2588	* (This also maps a whole lot better into our own guest page management
2589	* infrastructure.)
2590	*
2591	*
2592	* - Observed problems doing WHvUnmapGpaRange immediately followed by
2593	* WHvMapGpaRange.
2594	*
2595	* As mentioned above, we've been forced to use this sequence when modifying
2596	* page protection. However, when transitioning from readonly to writable,
2597	* we've ended up looping forever with the same write to readonly memory
2598	* VMEXIT. We're wondering if this issue might be related to the lazy mapping
2599	* logic in WinHvPlatform.
2600	*
2601	* Workaround: Insert a WHvRunVirtualProcessor call and make sure to get a GPA
2602	* unmapped exit between the two calls. Not entirely great performance wise
2603	* (or the santity of our code).
2604	*
2605	*
2606	* - Implementing A20 gate behavior is tedious, where as correctly emulating the
2607	* A20M# pin (present on 486 and later) is near impossible for SMP setups
2608	* (e.g. possiblity of two CPUs with different A20 status).
2609	*
2610	* Workaround: Only do A20 on CPU 0, restricting the emulation to HMA. We
2611	* unmap all pages related to HMA (0x100000..0x10ffff) when the A20 state
2612	* changes, lazily syncing the right pages back when accessed.
2613	*
2614	*
2615	* - WHVRunVirtualProcessor wastes time converting VID/Hyper-V messages to its
2616	* own format (WHV_RUN_VP_EXIT_CONTEXT).
2617	*
2618	* We understand this might be because Microsoft wishes to remain free to
2619	* modify the VID/Hyper-V messages, but it's still rather silly and does slow
2620	* things down a little. We'd much rather just process the messages directly.
2621	*
2622	*
2623	* - WHVRunVirtualProcessor would've benefited from using a callback interface:
2624	*
2625	* - The potential size changes of the exit context structure wouldn't be
2626	* an issue, since the function could manage that itself.
2627	*
2628	* - State handling could probably be simplified (like cancelation).
2629	*
2630	*
2631	* - WHvGetVirtualProcessorRegisters and WHvSetVirtualProcessorRegisters
2632	* internally converts register names, probably using temporary heap buffers.
2633	*
2634	* From the looks of things, they are converting from WHV_REGISTER_NAME to
2635	* HV_REGISTER_NAME from in the "Virtual Processor Register Names" section in
2636	* the "Hypervisor Top-Level Functional Specification" document. This feels
2637	* like an awful waste of time.
2638	*
2639	* We simply cannot understand why HV_REGISTER_NAME isn't used directly here,
2640	* or at least the same values, making any conversion reduntant. Restricting
2641	* access to certain registers could easily be implement by scanning the
2642	* inputs.
2643	*
2644	* To avoid the heap + conversion overhead, we're currently using the
2645	* HvCallGetVpRegisters and HvCallSetVpRegisters calls directly.
2646	*
2647	*
2648	* - The YMM and XCR0 registers are not yet named (17083). This probably
2649	* wouldn't be a problem if HV_REGISTER_NAME was used, see previous point.
2650	*
2651	*
2652	* - Why does VID.SYS only query/set 32 registers at the time thru the
2653	* HvCallGetVpRegisters and HvCallSetVpRegisters hypercalls?
2654	*
2655	* We've not trouble getting/setting all the registers defined by
2656	* WHV_REGISTER_NAME in one hypercall (around 80). Some kind of stack
2657	* buffering or similar?
2658	*
2659	*
2660	* - To handle the VMMCALL / VMCALL instructions, it seems we need to intercept
2661	* \#UD exceptions and inspect the opcodes. A dedicated exit for hypercalls
2662	* would be more efficient, esp. for guests using \#UD for other purposes..
2663	*
2664	*
2665	* - Wrong instruction length in the VpContext with unmapped GPA memory exit
2666	* contexts on 17115/AMD.
2667	*
2668	* One byte "PUSH CS" was reported as 2 bytes, while a two byte
2669	* "MOV [EBX],EAX" was reported with a 1 byte instruction length. Problem
2670	* naturally present in untranslated hyper-v messages.
2671	*
2672	*
2673	* - The I/O port exit context information seems to be missing the address size
2674	* information needed for correct string I/O emulation.
2675	*
2676	* VT-x provides this information in bits 7:9 in the instruction information
2677	* field on newer CPUs. AMD-V in bits 7:9 in the EXITINFO1 field in the VMCB.
2678	*
2679	* We can probably work around this by scanning the instruction bytes for
2680	* address size prefixes. Haven't investigated it any further yet.
2681	*
2682	*
2683	* - The WHvGetCapability function has a weird design:
2684	* - The CapabilityCode parameter is pointlessly duplicated in the output
2685	* structure (WHV_CAPABILITY).
2686	*
2687	* - API takes void pointer, but everyone will probably be using
2688	* WHV_CAPABILITY due to WHV_CAPABILITY::CapabilityCode making it
2689	* impractical to use anything else.
2690	*
2691	* - No output size.
2692	*
2693	* - See GetFileAttributesEx, GetFileInformationByHandleEx,
2694	* FindFirstFileEx, and others for typical pattern for generic
2695	* information getters.
2696	*
2697	* Update: All concerns have been addressed in build 17110.
2698	*
2699	*
2700	* - The WHvGetPartitionProperty function uses the same weird design as
2701	* WHvGetCapability, see above.
2702	*
2703	* Update: All concerns have been addressed in build 17110.
2704	*
2705	*
2706	* - The WHvSetPartitionProperty function has a totally weird design too:
2707	* - In contrast to its partner WHvGetPartitionProperty, the property code
2708	* is not a separate input parameter here but part of the input
2709	* structure.
2710	*
2711	* - The input structure is a void pointer rather than a pointer to
2712	* WHV_PARTITION_PROPERTY which everyone probably will be using because
2713	* of the WHV_PARTITION_PROPERTY::PropertyCode field.
2714	*
2715	* - Really, why use PVOID for the input when the function isn't accepting
2716	* minimal sizes. E.g. WHVPartitionPropertyCodeProcessorClFlushSize only
2717	* requires a 9 byte input, but the function insists on 16 bytes (17083).
2718	*
2719	* - See GetFileAttributesEx, SetFileInformationByHandle, FindFirstFileEx,
2720	* and others for typical pattern for generic information setters and
2721	* getters.
2722	*
2723	* Update: All concerns have been addressed in build 17110.
2724	*
2725	*
2726	*
2727	* @section sec_nem_win_impl Our implementation.
2728	*
2729	* We set out with the goal of wanting to run as much as possible in ring-0,
2730	* reasoning that this would give use the best performance.
2731	*
2732	* This goal was approached gradually, starting out with a pure WinHvPlatform
2733	* implementation, gradually replacing parts: register access, guest memory
2734	* handling, running virtual processors. Then finally moving it all into
2735	* ring-0, while keeping most of it configurable so that we could make
2736	* comparisons (see NEMInternal.h and nemR3NativeRunGC()).
2737	*
2738	*
2739	* @subsection subsect_nem_win_impl_ioctl VID.SYS I/O control calls
2740	*
2741	* To run things in ring-0 we need to talk directly to VID.SYS thru its I/O
2742	* control interface. Looking at changes between like build 17083 and 17101 (if
2743	* memory serves) a set of the VID I/O control numbers shifted a little, which
2744	* means we need to determin them dynamically. We currently do this by hooking
2745	* the NtDeviceIoControlFile API call from VID.DLL and snooping up the
2746	* parameters when making dummy calls to relevant APIs. (We could also
2747	* disassemble the relevant APIs and try fish out the information from that, but
2748	* this is way simpler.)
2749	*
2750	* Issuing I/O control calls from ring-0 is facing a small challenge with
2751	* respect to direct buffering. When using direct buffering the device will
2752	* typically check that the buffer is actually in the user address space range
2753	* and reject kernel addresses. Fortunately, we've got the cross context VM
2754	* structure that is mapped into both kernel and user space, it's also locked
2755	* and safe to access from kernel space. So, we place the I/O control buffers
2756	* in the per-CPU part of it (NEMCPU::uIoCtlBuf) and give the driver the user
2757	* address if direct access buffering or kernel address if not.
2758	*
2759	* The I/O control calls are 'abstracted' in the support driver, see
2760	* SUPR0IoCtlSetupForHandle(), SUPR0IoCtlPerform() and SUPR0IoCtlCleanup().
2761	*
2762	*
2763	* @subsection subsect_nem_win_impl_cpumctx CPUMCTX
2764	*
2765	* Since the CPU state needs to live in Hyper-V when executing, we probably
2766	* should not transfer more than necessary when handling VMEXITs. To help us
2767	* manage this CPUMCTX got a new field CPUMCTX::fExtrn that to indicate which
2768	* part of the state is currently externalized (== in Hyper-V).
2769	*
2770	*
2771	*/
2772

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

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

Download in other formats: