VirtualBox

source: vbox/trunk/src/VBox/VMM/include/NEMInternal.h@ 77481

Last change on this file since 77481 was 76585, checked in by vboxsync, 6 years ago

*: scm --fix-header-guard-endif
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.7 KB
Line 
1/* $Id: NEMInternal.h 76585 2019-01-01 06:31:29Z vboxsync $ */
2/** @file
3 * NEM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2018-2019 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef VMM_INCLUDED_SRC_include_NEMInternal_h
19#define VMM_INCLUDED_SRC_include_NEMInternal_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include <VBox/cdefs.h>
25#include <VBox/types.h>
26#include <VBox/vmm/nem.h>
27#include <VBox/vmm/cpum.h> /* For CPUMCPUVENDOR. */
28#include <VBox/vmm/stam.h>
29#include <VBox/vmm/vmapi.h>
30#ifdef RT_OS_WINDOWS
31#include <iprt/nt/hyperv.h>
32#include <iprt/critsect.h>
33#endif
34
35RT_C_DECLS_BEGIN
36
37
38/** @defgroup grp_nem_int Internal
39 * @ingroup grp_nem
40 * @internal
41 * @{
42 */
43
44
45#ifdef RT_OS_WINDOWS
46/*
47 * Windows: Code configuration.
48 */
49# define NEM_WIN_USE_HYPERCALLS_FOR_PAGES
50//# define NEM_WIN_USE_HYPERCALLS_FOR_REGISTERS /**< Applies to ring-3 code only. Useful for testing VID API. */
51//# define NEM_WIN_USE_OUR_OWN_RUN_API /**< Applies to ring-3 code only. Useful for testing VID API. */
52# define NEM_WIN_WITH_RING0_RUNLOOP /**< Enables the ring-0 runloop. */
53# define NEM_WIN_USE_RING0_RUNLOOP_BY_DEFAULT /**< For quickly testing ring-3 API without messing with CFGM. */
54# if defined(NEM_WIN_USE_OUR_OWN_RUN_API) && !defined(NEM_WIN_USE_HYPERCALLS_FOR_REGISTERS)
55# error "NEM_WIN_USE_OUR_OWN_RUN_API requires NEM_WIN_USE_HYPERCALLS_FOR_REGISTERS"
56# endif
57# if defined(NEM_WIN_USE_OUR_OWN_RUN_API) && !defined(NEM_WIN_USE_HYPERCALLS_FOR_PAGES)
58# error "NEM_WIN_USE_OUR_OWN_RUN_API requires NEM_WIN_USE_HYPERCALLS_FOR_PAGES"
59# endif
60# if defined(NEM_WIN_WITH_RING0_RUNLOOP) && !defined(NEM_WIN_USE_HYPERCALLS_FOR_PAGES)
61# error "NEM_WIN_WITH_RING0_RUNLOOP requires NEM_WIN_USE_HYPERCALLS_FOR_PAGES"
62# endif
63
64/**
65 * Windows VID I/O control information.
66 */
67typedef struct NEMWINIOCTL
68{
69 /** The I/O control function number. */
70 uint32_t uFunction;
71 uint32_t cbInput;
72 uint32_t cbOutput;
73} NEMWINIOCTL;
74
75/** @name Windows: Our two-bit physical page state for PGMPAGE
76 * @{ */
77# define NEM_WIN_PAGE_STATE_NOT_SET 0
78# define NEM_WIN_PAGE_STATE_UNMAPPED 1
79# define NEM_WIN_PAGE_STATE_READABLE 2
80# define NEM_WIN_PAGE_STATE_WRITABLE 3
81/** @} */
82
83/** Windows: Checks if a_GCPhys is subject to the limited A20 gate emulation. */
84# define NEM_WIN_IS_SUBJECT_TO_A20(a_GCPhys) ((RTGCPHYS)((a_GCPhys) - _1M) < (RTGCPHYS)_64K)
85/** Windows: Checks if a_GCPhys is relevant to the limited A20 gate emulation. */
86# define NEM_WIN_IS_RELEVANT_TO_A20(a_GCPhys) \
87 ( ((RTGCPHYS)((a_GCPhys) - _1M) < (RTGCPHYS)_64K) || ((RTGCPHYS)(a_GCPhys) < (RTGCPHYS)_64K) )
88
89/** The CPUMCTX_EXTRN_XXX mask for IEM. */
90# define NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM ( IEM_CPUMCTX_EXTRN_MUST_MASK | CPUMCTX_EXTRN_NEM_WIN_INHIBIT_INT \
91 | CPUMCTX_EXTRN_NEM_WIN_INHIBIT_NMI )
92/** The CPUMCTX_EXTRN_XXX mask for IEM when raising exceptions. */
93# define NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM_XCPT (IEM_CPUMCTX_EXTRN_XCPT_MASK | NEM_WIN_CPUMCTX_EXTRN_MASK_FOR_IEM)
94
95/** @name Windows: Interrupt window flags (NEM_WIN_INTW_F_XXX).
96 * @{ */
97# define NEM_WIN_INTW_F_NMI UINT8_C(0x01)
98# define NEM_WIN_INTW_F_REGULAR UINT8_C(0x02)
99# define NEM_WIN_INTW_F_PRIO_MASK UINT8_C(0x3c)
100# define NEM_WIN_INTW_F_PRIO_SHIFT 2
101/** @} */
102
103#endif /* RT_OS_WINDOWS */
104
105
106/** Trick to make slickedit see the static functions in the template. */
107#ifndef IN_SLICKEDIT
108# define NEM_TMPL_STATIC static
109#else
110# define NEM_TMPL_STATIC
111#endif
112
113
114/**
115 * Generic NEM exit type enumeration for use with EMHistoryAddExit.
116 *
117 * On windows we've got two different set of exit types and they are both jumping
118 * around the place value wise, so EM can use their values.
119 *
120 * @note We only have exit types for exits not covered by EM here.
121 */
122typedef enum NEMEXITTYPE
123{
124 /* windows: */
125 NEMEXITTYPE_UNRECOVERABLE_EXCEPTION = 1,
126 NEMEXITTYPE_INVALID_VP_REGISTER_VALUE,
127 NEMEXITTYPE_INTTERRUPT_WINDOW,
128 NEMEXITTYPE_HALT,
129 NEMEXITTYPE_XCPT_UD,
130 NEMEXITTYPE_XCPT_DB,
131 NEMEXITTYPE_XCPT_BP,
132 NEMEXITTYPE_CANCELED,
133 NEMEXITTYPE_MEMORY_ACCESS
134} NEMEXITTYPE;
135
136
137/**
138 * NEM VM Instance data.
139 */
140typedef struct NEM
141{
142 /** NEM_MAGIC. */
143 uint32_t u32Magic;
144
145 /** Set if enabled. */
146 bool fEnabled;
147 /** Set if long mode guests are allowed. */
148 bool fAllow64BitGuests;
149#ifdef RT_OS_WINDOWS
150 /** Set if we've created the EMTs. */
151 bool fCreatedEmts : 1;
152 /** WHvRunVpExitReasonX64Cpuid is supported. */
153 bool fExtendedMsrExit : 1;
154 /** WHvRunVpExitReasonX64MsrAccess is supported. */
155 bool fExtendedCpuIdExit : 1;
156 /** WHvRunVpExitReasonException is supported. */
157 bool fExtendedXcptExit : 1;
158 /** Set if we're using the ring-0 API to do the work. */
159 bool fUseRing0Runloop : 1;
160 /** Set if we've started more than one CPU and cannot mess with A20. */
161 bool fA20Fixed : 1;
162 /** Set if A20 is enabled. */
163 bool fA20Enabled : 1;
164 /** The reported CPU vendor. */
165 CPUMCPUVENDOR enmCpuVendor;
166 /** Cache line flush size as a power of two. */
167 uint8_t cCacheLineFlushShift;
168 /** The result of WHvCapabilityCodeProcessorFeatures. */
169 union
170 {
171 /** 64-bit view. */
172 uint64_t u64;
173# ifdef _WINHVAPIDEFS_H_
174 /** Interpreed features. */
175 WHV_PROCESSOR_FEATURES u;
176# endif
177 } uCpuFeatures;
178
179 /** The partition handle. */
180# ifdef _WINHVAPIDEFS_H_
181 WHV_PARTITION_HANDLE
182# else
183 RTHCUINTPTR
184# endif
185 hPartition;
186 /** The device handle for the partition, for use with Vid APIs or direct I/O
187 * controls. */
188 RTR3PTR hPartitionDevice;
189 /** The Hyper-V partition ID. */
190 uint64_t idHvPartition;
191
192 /** Number of currently mapped pages. */
193 uint32_t volatile cMappedPages;
194
195 /** Info about the VidGetHvPartitionId I/O control interface. */
196 NEMWINIOCTL IoCtlGetHvPartitionId;
197 /** Info about the VidStartVirtualProcessor I/O control interface. */
198 NEMWINIOCTL IoCtlStartVirtualProcessor;
199 /** Info about the VidStopVirtualProcessor I/O control interface. */
200 NEMWINIOCTL IoCtlStopVirtualProcessor;
201 /** Info about the VidStopVirtualProcessor I/O control interface. */
202 NEMWINIOCTL IoCtlMessageSlotHandleAndGetNext;
203
204 /** Statistics updated by NEMR0UpdateStatistics. */
205 struct
206 {
207 uint64_t cPagesAvailable;
208 uint64_t cPagesInUse;
209 } R0Stats;
210#endif /* RT_OS_WINDOWS */
211} NEM;
212/** Pointer to NEM VM instance data. */
213typedef NEM *PNEM;
214
215/** NEM::u32Magic value. */
216#define NEM_MAGIC UINT32_C(0x004d454e)
217/** NEM::u32Magic value after termination. */
218#define NEM_MAGIC_DEAD UINT32_C(0xdead1111)
219
220
221/**
222 * NEM VMCPU Instance data.
223 */
224typedef struct NEMCPU
225{
226 /** NEMCPU_MAGIC. */
227 uint32_t u32Magic;
228 /** Whether \#UD needs to be intercepted and presented to GIM. */
229 bool fGIMTrapXcptUD : 1;
230#ifdef RT_OS_WINDOWS
231 /** The current state of the interrupt windows (NEM_WIN_INTW_F_XXX). */
232 uint8_t fCurrentInterruptWindows;
233 /** The desired state of the interrupt windows (NEM_WIN_INTW_F_XXX). */
234 uint8_t fDesiredInterruptWindows;
235 /** Last copy of HV_X64_VP_EXECUTION_STATE::InterruptShadow. */
236 bool fLastInterruptShadow : 1;
237# ifdef NEM_WIN_WITH_RING0_RUNLOOP
238 /** Pending VINF_NEM_FLUSH_TLB. */
239 int32_t rcPending;
240# else
241 uint32_t uPadding;
242# endif
243 /** The VID_MSHAGN_F_XXX flags.
244 * Either VID_MSHAGN_F_HANDLE_MESSAGE | VID_MSHAGN_F_GET_NEXT_MESSAGE or zero. */
245 uint32_t fHandleAndGetFlags;
246 /** What VidMessageSlotMap returns and is used for passing exit info. */
247 RTR3PTR pvMsgSlotMapping;
248 /** The windows thread handle. */
249 RTR3PTR hNativeThreadHandle;
250 /** Parameters for making Hyper-V hypercalls. */
251 union
252 {
253 uint8_t ab[64];
254 /** Arguments for NEMR0MapPages (HvCallMapGpaPages). */
255 struct
256 {
257 RTGCPHYS GCPhysSrc;
258 RTGCPHYS GCPhysDst; /**< Same as GCPhysSrc except maybe when the A20 gate is disabled. */
259 uint32_t cPages;
260 HV_MAP_GPA_FLAGS fFlags;
261 } MapPages;
262 /** Arguments for NEMR0UnmapPages (HvCallUnmapGpaPages). */
263 struct
264 {
265 RTGCPHYS GCPhys;
266 uint32_t cPages;
267 } UnmapPages;
268 /** Result from NEMR0QueryCpuTick. */
269 struct
270 {
271 uint64_t cTicks;
272 uint32_t uAux;
273 } QueryCpuTick;
274 /** Input and output for NEMR0DoExperiment. */
275 struct
276 {
277 uint32_t uItem;
278 bool fSuccess;
279 uint64_t uStatus;
280 uint64_t uLoValue;
281 uint64_t uHiValue;
282 } Experiment;
283 } Hypercall;
284 /** I/O control buffer, we always use this for I/O controls. */
285 union
286 {
287 uint8_t ab[64];
288 HV_PARTITION_ID idPartition;
289 HV_VP_INDEX idCpu;
290# ifdef VID_MSHAGN_F_GET_NEXT_MESSAGE
291 VID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT MsgSlotHandleAndGetNext;
292# endif
293 } uIoCtlBuf;
294
295 /** @name Statistics
296 * @{ */
297 STAMCOUNTER StatExitPortIo;
298 STAMCOUNTER StatExitMemUnmapped;
299 STAMCOUNTER StatExitMemIntercept;
300 STAMCOUNTER StatExitHalt;
301 STAMCOUNTER StatExitInterruptWindow;
302 STAMCOUNTER StatExitCpuId;
303 STAMCOUNTER StatExitMsr;
304 STAMCOUNTER StatExitException;
305 STAMCOUNTER StatExitExceptionBp;
306 STAMCOUNTER StatExitExceptionDb;
307 STAMCOUNTER StatExitExceptionUd;
308 STAMCOUNTER StatExitExceptionUdHandled;
309 STAMCOUNTER StatExitUnrecoverable;
310 STAMCOUNTER StatGetMsgTimeout;
311 STAMCOUNTER StatStopCpuSuccess;
312 STAMCOUNTER StatStopCpuPending;
313 STAMCOUNTER StatStopCpuPendingAlerts;
314 STAMCOUNTER StatStopCpuPendingOdd;
315 STAMCOUNTER StatCancelChangedState;
316 STAMCOUNTER StatCancelAlertedThread;
317 STAMCOUNTER StatBreakOnCancel;
318 STAMCOUNTER StatBreakOnFFPre;
319 STAMCOUNTER StatBreakOnFFPost;
320 STAMCOUNTER StatBreakOnStatus;
321 STAMCOUNTER StatImportOnDemand;
322 STAMCOUNTER StatImportOnReturn;
323 STAMCOUNTER StatImportOnReturnSkipped;
324 STAMCOUNTER StatQueryCpuTick;
325 /** @} */
326#endif /* RT_OS_WINDOWS */
327} NEMCPU;
328/** Pointer to NEM VMCPU instance data. */
329typedef NEMCPU *PNEMCPU;
330
331/** NEMCPU::u32Magic value. */
332#define NEMCPU_MAGIC UINT32_C(0x4d454e20)
333/** NEMCPU::u32Magic value after termination. */
334#define NEMCPU_MAGIC_DEAD UINT32_C(0xdead2222)
335
336
337#ifdef IN_RING0
338# ifdef RT_OS_WINDOWS
339/**
340 * Windows: Hypercall input/ouput page info.
341 */
342typedef struct NEMR0HYPERCALLDATA
343{
344 /** Host physical address of the hypercall input/output page. */
345 RTHCPHYS HCPhysPage;
346 /** Pointer to the hypercall input/output page. */
347 uint8_t *pbPage;
348 /** Handle to the memory object of the hypercall input/output page. */
349 RTR0MEMOBJ hMemObj;
350} NEMR0HYPERCALLDATA;
351/** Pointer to a Windows hypercall input/output page info. */
352typedef NEMR0HYPERCALLDATA *PNEMR0HYPERCALLDATA;
353# endif /* RT_OS_WINDOWS */
354
355/**
356 * NEM GVMCPU instance data.
357 */
358typedef struct NEMR0PERVCPU
359{
360# ifdef RT_OS_WINDOWS
361 /** Hypercall input/ouput page. */
362 NEMR0HYPERCALLDATA HypercallData;
363# else
364 uint32_t uDummy;
365# endif
366} NEMR0PERVCPU;
367
368/**
369 * NEM GVM instance data.
370 */
371typedef struct NEMR0PERVM
372{
373# ifdef RT_OS_WINDOWS
374 /** The partition ID. */
375 uint64_t idHvPartition;
376 /** I/O control context. */
377 PSUPR0IOCTLCTX pIoCtlCtx;
378 /** Delta to add to convert a ring-0 pointer to a ring-3 one. */
379 uintptr_t offRing3ConversionDelta;
380 /** Info about the VidGetHvPartitionId I/O control interface. */
381 NEMWINIOCTL IoCtlGetHvPartitionId;
382 /** Info about the VidStartVirtualProcessor I/O control interface. */
383 NEMWINIOCTL IoCtlStartVirtualProcessor;
384 /** Info about the VidStopVirtualProcessor I/O control interface. */
385 NEMWINIOCTL IoCtlStopVirtualProcessor;
386 /** Info about the VidStopVirtualProcessor I/O control interface. */
387 NEMWINIOCTL IoCtlMessageSlotHandleAndGetNext;
388 /** Whether we may use the ring-0 runloop or not. */
389 bool fMayUseRing0Runloop;
390
391 /** Hypercall input/ouput page for non-EMT. */
392 NEMR0HYPERCALLDATA HypercallData;
393 /** Critical section protecting use of HypercallData. */
394 RTCRITSECT HypercallDataCritSect;
395
396# else
397 uint32_t uDummy;
398# endif
399} NEMR0PERVM;
400
401#endif /* IN_RING*/
402
403
404#ifdef IN_RING3
405int nemR3NativeInit(PVM pVM, bool fFallback, bool fForced);
406int nemR3NativeInitAfterCPUM(PVM pVM);
407int nemR3NativeInitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
408int nemR3NativeTerm(PVM pVM);
409void nemR3NativeReset(PVM pVM);
410void nemR3NativeResetCpu(PVMCPU pVCpu, bool fInitIpi);
411VBOXSTRICTRC nemR3NativeRunGC(PVM pVM, PVMCPU pVCpu);
412bool nemR3NativeCanExecuteGuest(PVM pVM, PVMCPU pVCpu);
413bool nemR3NativeSetSingleInstruction(PVM pVM, PVMCPU pVCpu, bool fEnable);
414void nemR3NativeNotifyFF(PVM pVM, PVMCPU pVCpu, uint32_t fFlags);
415
416int nemR3NativeNotifyPhysRamRegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb);
417int nemR3NativeNotifyPhysMmioExMap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags, void *pvMmio2);
418int nemR3NativeNotifyPhysMmioExUnmap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags);
419int nemR3NativeNotifyPhysRomRegisterEarly(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags);
420int nemR3NativeNotifyPhysRomRegisterLate(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags);
421void nemR3NativeNotifySetA20(PVMCPU pVCpu, bool fEnabled);
422#endif
423
424void nemHCNativeNotifyHandlerPhysicalRegister(PVM pVM, PGMPHYSHANDLERKIND enmKind, RTGCPHYS GCPhys, RTGCPHYS cb);
425void nemHCNativeNotifyHandlerPhysicalDeregister(PVM pVM, PGMPHYSHANDLERKIND enmKind, RTGCPHYS GCPhys, RTGCPHYS cb,
426 int fRestoreAsRAM, bool fRestoreAsRAM2);
427void nemHCNativeNotifyHandlerPhysicalModify(PVM pVM, PGMPHYSHANDLERKIND enmKind, RTGCPHYS GCPhysOld,
428 RTGCPHYS GCPhysNew, RTGCPHYS cb, bool fRestoreAsRAM);
429int nemHCNativeNotifyPhysPageAllocated(PVM pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhys, uint32_t fPageProt,
430 PGMPAGETYPE enmType, uint8_t *pu2State);
431void nemHCNativeNotifyPhysPageProtChanged(PVM pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhys, uint32_t fPageProt,
432 PGMPAGETYPE enmType, uint8_t *pu2State);
433void nemHCNativeNotifyPhysPageChanged(PVM pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhysPrev, RTHCPHYS HCPhysNew, uint32_t fPageProt,
434 PGMPAGETYPE enmType, uint8_t *pu2State);
435
436
437#ifdef RT_OS_WINDOWS
438/** Maximum number of pages we can map in a single NEMR0MapPages call. */
439# define NEM_MAX_MAP_PAGES ((PAGE_SIZE - RT_UOFFSETOF(HV_INPUT_MAP_GPA_PAGES, PageList)) / sizeof(HV_SPA_PAGE_NUMBER))
440/** Maximum number of pages we can unmap in a single NEMR0UnmapPages call. */
441# define NEM_MAX_UNMAP_PAGES 4095
442
443#endif
444/** @} */
445
446RT_C_DECLS_END
447
448#endif /* !VMM_INCLUDED_SRC_include_NEMInternal_h */
449
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette