VirtualBox

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

Last change on this file since 91688 was 91688, checked in by vboxsync, 3 years ago

VMM/NEM: Added some more #ifdef'ing to reduce the amount of ioctl probing to what we actually need. bugref:10118
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.4 KB
Line 
1/* $Id: NEMInternal.h 91688 2021-10-12 12:21:10Z vboxsync $ */
2/** @file
3 * NEM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2018-2020 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 VidGetPartitionProperty I/O control interface. */
198 NEMWINIOCTL IoCtlGetPartitionProperty;
199# ifdef NEM_WIN_WITH_RING0_RUNLOOP
200 /** Info about the VidStartVirtualProcessor I/O control interface. */
201 NEMWINIOCTL IoCtlStartVirtualProcessor;
202 /** Info about the VidStopVirtualProcessor I/O control interface. */
203 NEMWINIOCTL IoCtlStopVirtualProcessor;
204 /** Info about the VidStopVirtualProcessor I/O control interface. */
205 NEMWINIOCTL IoCtlMessageSlotHandleAndGetNext;
206# endif
207
208 /** Statistics updated by NEMR0UpdateStatistics. */
209 struct
210 {
211 uint64_t cPagesAvailable;
212 uint64_t cPagesInUse;
213 } R0Stats;
214#endif /* RT_OS_WINDOWS */
215} NEM;
216/** Pointer to NEM VM instance data. */
217typedef NEM *PNEM;
218
219/** NEM::u32Magic value. */
220#define NEM_MAGIC UINT32_C(0x004d454e)
221/** NEM::u32Magic value after termination. */
222#define NEM_MAGIC_DEAD UINT32_C(0xdead1111)
223
224
225/**
226 * NEM VMCPU Instance data.
227 */
228typedef struct NEMCPU
229{
230 /** NEMCPU_MAGIC. */
231 uint32_t u32Magic;
232 /** Whether \#UD needs to be intercepted and presented to GIM. */
233 bool fGIMTrapXcptUD : 1;
234 /** Whether \#GP needs to be intercept for mesa driver workaround. */
235 bool fTrapXcptGpForLovelyMesaDrv: 1;
236#ifdef RT_OS_WINDOWS
237 /** The current state of the interrupt windows (NEM_WIN_INTW_F_XXX). */
238 uint8_t fCurrentInterruptWindows;
239 /** The desired state of the interrupt windows (NEM_WIN_INTW_F_XXX). */
240 uint8_t fDesiredInterruptWindows;
241 /** Last copy of HV_X64_VP_EXECUTION_STATE::InterruptShadow. */
242 bool fLastInterruptShadow : 1;
243# ifdef NEM_WIN_WITH_RING0_RUNLOOP
244 /** Pending VINF_NEM_FLUSH_TLB. */
245 int32_t rcPending;
246# else
247 uint32_t uPadding;
248# endif
249 /** The VID_MSHAGN_F_XXX flags.
250 * Either VID_MSHAGN_F_HANDLE_MESSAGE | VID_MSHAGN_F_GET_NEXT_MESSAGE or zero. */
251 uint32_t fHandleAndGetFlags;
252 /** What VidMessageSlotMap returns and is used for passing exit info. */
253 RTR3PTR pvMsgSlotMapping;
254 /** The windows thread handle. */
255 RTR3PTR hNativeThreadHandle;
256 /** Parameters for making Hyper-V hypercalls. */
257 union
258 {
259 uint8_t ab[64];
260 /** Arguments for NEMR0MapPages (HvCallMapGpaPages). */
261 struct
262 {
263 RTGCPHYS GCPhysSrc;
264 RTGCPHYS GCPhysDst; /**< Same as GCPhysSrc except maybe when the A20 gate is disabled. */
265 uint32_t cPages;
266 HV_MAP_GPA_FLAGS fFlags;
267 } MapPages;
268 /** Arguments for NEMR0UnmapPages (HvCallUnmapGpaPages). */
269 struct
270 {
271 RTGCPHYS GCPhys;
272 uint32_t cPages;
273 } UnmapPages;
274 /** Result from NEMR0QueryCpuTick. */
275 struct
276 {
277 uint64_t cTicks;
278 uint32_t uAux;
279 } QueryCpuTick;
280 /** Input and output for NEMR0DoExperiment. */
281 struct
282 {
283 uint32_t uItem;
284 bool fSuccess;
285 uint64_t uStatus;
286 uint64_t uLoValue;
287 uint64_t uHiValue;
288 } Experiment;
289 } Hypercall;
290 /** I/O control buffer, we always use this for I/O controls. */
291 union
292 {
293 uint8_t ab[64];
294 HV_PARTITION_ID idPartition;
295 HV_VP_INDEX idCpu;
296 struct
297 {
298 uint64_t enmProperty;
299 uint64_t uValue;
300 } GetProp;
301# ifdef VID_MSHAGN_F_GET_NEXT_MESSAGE
302 VID_IOCTL_INPUT_MESSAGE_SLOT_HANDLE_AND_GET_NEXT MsgSlotHandleAndGetNext;
303# endif
304 } uIoCtlBuf;
305
306 /** @name Statistics
307 * @{ */
308 STAMCOUNTER StatExitPortIo;
309 STAMCOUNTER StatExitMemUnmapped;
310 STAMCOUNTER StatExitMemIntercept;
311 STAMCOUNTER StatExitHalt;
312 STAMCOUNTER StatExitInterruptWindow;
313 STAMCOUNTER StatExitCpuId;
314 STAMCOUNTER StatExitMsr;
315 STAMCOUNTER StatExitException;
316 STAMCOUNTER StatExitExceptionBp;
317 STAMCOUNTER StatExitExceptionDb;
318 STAMCOUNTER StatExitExceptionGp;
319 STAMCOUNTER StatExitExceptionGpMesa;
320 STAMCOUNTER StatExitExceptionUd;
321 STAMCOUNTER StatExitExceptionUdHandled;
322 STAMCOUNTER StatExitUnrecoverable;
323 STAMCOUNTER StatGetMsgTimeout;
324 STAMCOUNTER StatStopCpuSuccess;
325 STAMCOUNTER StatStopCpuPending;
326 STAMCOUNTER StatStopCpuPendingAlerts;
327 STAMCOUNTER StatStopCpuPendingOdd;
328 STAMCOUNTER StatCancelChangedState;
329 STAMCOUNTER StatCancelAlertedThread;
330 STAMCOUNTER StatBreakOnCancel;
331 STAMCOUNTER StatBreakOnFFPre;
332 STAMCOUNTER StatBreakOnFFPost;
333 STAMCOUNTER StatBreakOnStatus;
334 STAMCOUNTER StatImportOnDemand;
335 STAMCOUNTER StatImportOnReturn;
336 STAMCOUNTER StatImportOnReturnSkipped;
337 STAMCOUNTER StatQueryCpuTick;
338 /** @} */
339#endif /* RT_OS_WINDOWS */
340} NEMCPU;
341/** Pointer to NEM VMCPU instance data. */
342typedef NEMCPU *PNEMCPU;
343
344/** NEMCPU::u32Magic value. */
345#define NEMCPU_MAGIC UINT32_C(0x4d454e20)
346/** NEMCPU::u32Magic value after termination. */
347#define NEMCPU_MAGIC_DEAD UINT32_C(0xdead2222)
348
349
350#ifdef IN_RING0
351# ifdef RT_OS_WINDOWS
352/**
353 * Windows: Hypercall input/ouput page info.
354 */
355typedef struct NEMR0HYPERCALLDATA
356{
357 /** Host physical address of the hypercall input/output page. */
358 RTHCPHYS HCPhysPage;
359 /** Pointer to the hypercall input/output page. */
360 uint8_t *pbPage;
361 /** Handle to the memory object of the hypercall input/output page. */
362 RTR0MEMOBJ hMemObj;
363} NEMR0HYPERCALLDATA;
364/** Pointer to a Windows hypercall input/output page info. */
365typedef NEMR0HYPERCALLDATA *PNEMR0HYPERCALLDATA;
366# endif /* RT_OS_WINDOWS */
367
368/**
369 * NEM GVMCPU instance data.
370 */
371typedef struct NEMR0PERVCPU
372{
373# ifdef RT_OS_WINDOWS
374 /** Hypercall input/ouput page. */
375 NEMR0HYPERCALLDATA HypercallData;
376 /** Delta to add to convert a ring-0 pointer to a ring-3 one. */
377 uintptr_t offRing3ConversionDelta;
378# else
379 uint32_t uDummy;
380# endif
381} NEMR0PERVCPU;
382
383/**
384 * NEM GVM instance data.
385 */
386typedef struct NEMR0PERVM
387{
388# ifdef RT_OS_WINDOWS
389 /** The partition ID. */
390 uint64_t idHvPartition;
391 /** I/O control context. */
392 PSUPR0IOCTLCTX pIoCtlCtx;
393 /** Info about the VidGetHvPartitionId I/O control interface. */
394 NEMWINIOCTL IoCtlGetHvPartitionId;
395 /** Info about the VidGetPartitionProperty I/O control interface. */
396 NEMWINIOCTL IoCtlGetPartitionProperty;
397# ifdef NEM_WIN_WITH_RING0_RUNLOOP
398 /** Info about the VidStartVirtualProcessor I/O control interface. */
399 NEMWINIOCTL IoCtlStartVirtualProcessor;
400 /** Info about the VidStopVirtualProcessor I/O control interface. */
401 NEMWINIOCTL IoCtlStopVirtualProcessor;
402 /** Info about the VidStopVirtualProcessor I/O control interface. */
403 NEMWINIOCTL IoCtlMessageSlotHandleAndGetNext;
404 /** Whether we may use the ring-0 runloop or not. */
405 bool fMayUseRing0Runloop;
406# endif
407
408 /** Hypercall input/ouput page for non-EMT. */
409 NEMR0HYPERCALLDATA HypercallData;
410 /** Critical section protecting use of HypercallData. */
411 RTCRITSECT HypercallDataCritSect;
412
413# else
414 uint32_t uDummy;
415# endif
416} NEMR0PERVM;
417
418#endif /* IN_RING*/
419
420
421#ifdef IN_RING3
422int nemR3NativeInit(PVM pVM, bool fFallback, bool fForced);
423int nemR3NativeInitAfterCPUM(PVM pVM);
424int nemR3NativeInitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
425int nemR3NativeTerm(PVM pVM);
426void nemR3NativeReset(PVM pVM);
427void nemR3NativeResetCpu(PVMCPU pVCpu, bool fInitIpi);
428VBOXSTRICTRC nemR3NativeRunGC(PVM pVM, PVMCPU pVCpu);
429bool nemR3NativeCanExecuteGuest(PVM pVM, PVMCPU pVCpu);
430bool nemR3NativeSetSingleInstruction(PVM pVM, PVMCPU pVCpu, bool fEnable);
431void nemR3NativeNotifyFF(PVM pVM, PVMCPU pVCpu, uint32_t fFlags);
432
433int nemR3NativeNotifyPhysRamRegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb);
434int nemR3NativeNotifyPhysMmioExMap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags, void *pvMmio2);
435int nemR3NativeNotifyPhysMmioExUnmap(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags);
436int nemR3NativeNotifyPhysRomRegisterEarly(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags);
437int nemR3NativeNotifyPhysRomRegisterLate(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, uint32_t fFlags);
438void nemR3NativeNotifySetA20(PVMCPU pVCpu, bool fEnabled);
439#endif
440
441void nemHCNativeNotifyHandlerPhysicalRegister(PVMCC pVM, PGMPHYSHANDLERKIND enmKind, RTGCPHYS GCPhys, RTGCPHYS cb);
442void nemHCNativeNotifyHandlerPhysicalDeregister(PVMCC pVM, PGMPHYSHANDLERKIND enmKind, RTGCPHYS GCPhys, RTGCPHYS cb,
443 int fRestoreAsRAM, bool fRestoreAsRAM2);
444void nemHCNativeNotifyHandlerPhysicalModify(PVMCC pVM, PGMPHYSHANDLERKIND enmKind, RTGCPHYS GCPhysOld,
445 RTGCPHYS GCPhysNew, RTGCPHYS cb, bool fRestoreAsRAM);
446int nemHCNativeNotifyPhysPageAllocated(PVMCC pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhys, uint32_t fPageProt,
447 PGMPAGETYPE enmType, uint8_t *pu2State);
448void nemHCNativeNotifyPhysPageProtChanged(PVMCC pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhys, uint32_t fPageProt,
449 PGMPAGETYPE enmType, uint8_t *pu2State);
450void nemHCNativeNotifyPhysPageChanged(PVMCC pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhysPrev, RTHCPHYS HCPhysNew, uint32_t fPageProt,
451 PGMPAGETYPE enmType, uint8_t *pu2State);
452
453
454#ifdef RT_OS_WINDOWS
455/** Maximum number of pages we can map in a single NEMR0MapPages call. */
456# define NEM_MAX_MAP_PAGES ((PAGE_SIZE - RT_UOFFSETOF(HV_INPUT_MAP_GPA_PAGES, PageList)) / sizeof(HV_SPA_PAGE_NUMBER))
457/** Maximum number of pages we can unmap in a single NEMR0UnmapPages call. */
458# define NEM_MAX_UNMAP_PAGES 4095
459
460#endif
461/** @} */
462
463RT_C_DECLS_END
464
465#endif /* !VMM_INCLUDED_SRC_include_NEMInternal_h */
466
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