VirtualBox

source: vbox/trunk/src/VBox/VMM/include/EMInternal.h@ 93554

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

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.1 KB
Line 
1/* $Id: EMInternal.h 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * EM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2022 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_EMInternal_h
19#define VMM_INCLUDED_SRC_include_EMInternal_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/em.h>
27#include <VBox/vmm/stam.h>
28#include <VBox/dis.h>
29#include <VBox/vmm/pdmcritsect.h>
30#include <iprt/avl.h>
31#include <setjmp.h>
32
33RT_C_DECLS_BEGIN
34
35
36/** @defgroup grp_em_int Internal
37 * @ingroup grp_em
38 * @internal
39 * @{
40 */
41
42/** The saved state version. */
43#define EM_SAVED_STATE_VERSION 5
44#define EM_SAVED_STATE_VERSION_PRE_IEM 4
45#define EM_SAVED_STATE_VERSION_PRE_MWAIT 3
46#define EM_SAVED_STATE_VERSION_PRE_SMP 2
47
48
49/** @name MWait state flags.
50 * @{
51 */
52/** MWait activated. */
53#define EMMWAIT_FLAG_ACTIVE RT_BIT(0)
54/** MWait will continue when an interrupt is pending even when IF=0. */
55#define EMMWAIT_FLAG_BREAKIRQIF0 RT_BIT(1)
56/** Monitor instruction was executed previously. */
57#define EMMWAIT_FLAG_MONITOR_ACTIVE RT_BIT(2)
58/** @} */
59
60/** EM time slice in ms; used for capping execution time. */
61#define EM_TIME_SLICE 100
62
63/**
64 * Cli node structure
65 */
66typedef struct CLISTAT
67{
68 /** The key is the cli address. */
69 AVLGCPTRNODECORE Core;
70#if HC_ARCH_BITS == 32 && !defined(RT_OS_WINDOWS)
71 /** Padding. */
72 uint32_t u32Padding;
73#endif
74 /** Occurrences. */
75 STAMCOUNTER Counter;
76} CLISTAT, *PCLISTAT;
77#ifdef IN_RING3
78AssertCompileMemberAlignment(CLISTAT, Counter, 8);
79#endif
80
81
82/**
83 * Exit history entry.
84 *
85 * @remarks We could perhaps trim this down a little bit by assuming uFlatPC
86 * only needs 48 bits (currently true but will change) and stuffing
87 * the flags+type in the available 16 bits made available. The
88 * timestamp could likewise be shortened to accomodate the index, or
89 * we might skip the index entirely. However, since we will have to
90 * deal with 56-bit wide PC address before long, there's not point.
91 *
92 * On the upside, there are unused bits in both uFlagsAndType and the
93 * idxSlot fields if needed for anything.
94 */
95typedef struct EMEXITENTRY
96{
97 /** The flat PC (CS:EIP/RIP) address of the exit.
98 * UINT64_MAX if not available. */
99 uint64_t uFlatPC;
100 /** The EMEXIT_MAKE_FLAGS_AND_TYPE */
101 uint32_t uFlagsAndType;
102 /** The index into the exit slot hash table.
103 * UINT32_MAX if too many collisions and not entered into it. */
104 uint32_t idxSlot;
105 /** The TSC timestamp of the exit.
106 * This is 0 if not timestamped. */
107 uint64_t uTimestamp;
108} EMEXITENTRY;
109/** Pointer to an exit history entry. */
110typedef EMEXITENTRY *PEMEXITENTRY;
111/** Pointer to a const exit history entry. */
112typedef EMEXITENTRY const *PCEMEXITENTRY;
113
114
115/**
116 * EM VM Instance data.
117 */
118typedef struct EM
119{
120 /** Whether IEM executes everything. */
121 bool fIemExecutesAll;
122 /** Whether a triple fault triggers a guru. */
123 bool fGuruOnTripleFault;
124 /** Alignment padding. */
125 bool afPadding[2];
126
127 /** Id of the VCPU that last executed code in the recompiler. */
128 VMCPUID idLastRemCpu;
129} EM;
130/** Pointer to EM VM instance data. */
131typedef EM *PEM;
132
133
134/**
135 * EM VMCPU Instance data.
136 */
137typedef struct EMCPU
138{
139 /** Execution Manager State. */
140 EMSTATE volatile enmState;
141
142 /** The state prior to the suspending of the VM. */
143 EMSTATE enmPrevState;
144
145 /** Set if hypercall instruction VMMCALL (AMD) & VMCALL (Intel) are enabled.
146 * GIM sets this and the execution managers queries it. Not saved, as GIM
147 * takes care of that bit too. */
148 bool fHypercallEnabled;
149
150 /** Explicit padding. */
151 uint8_t abPadding0[3];
152
153 /** The number of instructions we've executed in IEM since switching to the
154 * EMSTATE_IEM_THEN_REM state. */
155 uint32_t cIemThenRemInstructions;
156
157 /** Inhibit interrupts for this instruction. Valid only when VM_FF_INHIBIT_INTERRUPTS is set. */
158 RTGCUINTPTR GCPtrInhibitInterrupts;
159
160 /** Start of the current time slice in ms. */
161 uint64_t u64TimeSliceStart;
162 /** Start of the current time slice in thread execution time (ms). */
163 uint64_t u64TimeSliceStartExec;
164 /** Current time slice value. */
165 uint64_t u64TimeSliceExec;
166
167 /** Pending ring-3 I/O port access (VINF_EM_PENDING_R3_IOPORT_READ / VINF_EM_PENDING_R3_IOPORT_WRITE). */
168 struct
169 {
170 RTIOPORT uPort; /**< The I/O port number.*/
171 uint8_t cbValue; /**< The value size in bytes. Zero when not pending. */
172 uint8_t cbInstr; /**< The instruction length. */
173 uint32_t uValue; /**< The value to write. */
174 } PendingIoPortAccess;
175
176 /** MWait halt state. */
177 struct
178 {
179 uint32_t fWait; /**< Type of mwait; see EMMWAIT_FLAG_*. */
180 uint32_t u32Padding;
181 RTGCPTR uMWaitRAX; /**< MWAIT hints. */
182 RTGCPTR uMWaitRCX; /**< MWAIT extensions. */
183 RTGCPTR uMonitorRAX; /**< Monitored address. */
184 RTGCPTR uMonitorRCX; /**< Monitor extension. */
185 RTGCPTR uMonitorRDX; /**< Monitor hint. */
186 } MWait;
187
188 /** Make sure the jmp_buf is at a 32-byte boundrary. */
189 uint64_t au64Padding1[3];
190 union
191 {
192 /** Padding used in the other rings.
193 * This must be larger than jmp_buf on any supported platform. */
194 char achPaddingFatalLongJump[256];
195#ifdef IN_RING3
196 /** Long buffer jump for fatal VM errors.
197 * It will jump to before the outer EM loop is entered. */
198 jmp_buf FatalLongJump;
199#endif
200 } u;
201
202 /** For saving stack space, the disassembler state is allocated here instead of
203 * on the stack. */
204 DISCPUSTATE DisState;
205
206 /** @name Execution profiling.
207 * @{ */
208 STAMPROFILE StatForcedActions;
209 STAMPROFILE StatHalted;
210 STAMPROFILEADV StatCapped;
211 STAMPROFILEADV StatHMEntry;
212 STAMPROFILE StatHMExec;
213 STAMPROFILE StatIEMEmu;
214 STAMPROFILE StatIEMThenREM;
215 STAMPROFILEADV StatNEMEntry;
216 STAMPROFILE StatNEMExec;
217 STAMPROFILE StatREMEmu;
218 STAMPROFILE StatREMExec;
219 STAMPROFILE StatREMSync;
220 STAMPROFILEADV StatREMTotal;
221 STAMPROFILE StatRAWExec;
222 STAMPROFILEADV StatRAWEntry;
223 STAMPROFILEADV StatRAWTail;
224 STAMPROFILEADV StatRAWTotal;
225 STAMPROFILEADV StatTotal;
226 /** @} */
227
228 /** R3: Profiling of emR3RawExecuteIOInstruction. */
229 STAMPROFILE StatIOEmu;
230 STAMCOUNTER StatIoRestarted;
231 STAMCOUNTER StatIoIem;
232 /** R3: Profiling of emR3RawPrivileged. */
233 STAMPROFILE StatPrivEmu;
234 /** R3: Number of times emR3HmExecute is called. */
235 STAMCOUNTER StatHMExecuteCalled;
236 /** R3: Number of times emR3NEMExecute is called. */
237 STAMCOUNTER StatNEMExecuteCalled;
238
239 /** Align the next member at a 32-byte boundrary. */
240 uint64_t au64Padding2[1+2];
241
242 /** Exit history table (6KB). */
243 EMEXITENTRY aExitHistory[256];
244 /** Where to store the next exit history entry.
245 * Since aExitHistory is 256 items longs, we'll just increment this and
246 * mask it when using it. That help the readers detect whether we've
247 * wrapped around or not. */
248 uint64_t iNextExit;
249
250 /** Index into aExitRecords set by EMHistoryExec when returning to ring-3.
251 * This is UINT16_MAX if not armed. */
252 uint16_t volatile idxContinueExitRec;
253 /** Whether exit optimizations are enabled or not (in general). */
254 bool fExitOptimizationEnabled : 1;
255 /** Whether exit optimizations are enabled for ring-0 (in general). */
256 bool fExitOptimizationEnabledR0 : 1;
257 /** Whether exit optimizations are enabled for ring-0 when preemption is disabled. */
258 bool fExitOptimizationEnabledR0PreemptDisabled : 1;
259 /** Explicit padding. */
260 bool fPadding2;
261 /** Max number of instructions to execute. */
262 uint16_t cHistoryExecMaxInstructions;
263 /** Min number of instructions to execute while probing. */
264 uint16_t cHistoryProbeMinInstructions;
265 /** Max number of instructions to execute without an exit before giving up probe. */
266 uint16_t cHistoryProbeMaxInstructionsWithoutExit;
267 uint16_t uPadding3;
268 /** Number of exit records in use. */
269 uint32_t cExitRecordUsed;
270 /** Profiling the EMHistoryExec when executing (not probing). */
271 STAMPROFILE StatHistoryExec;
272 /** Number of saved exits. */
273 STAMCOUNTER StatHistoryExecSavedExits;
274 /** Number of instructions executed by EMHistoryExec. */
275 STAMCOUNTER StatHistoryExecInstructions;
276 uint64_t uPadding4;
277 /** Number of instructions executed by EMHistoryExec when probing. */
278 STAMCOUNTER StatHistoryProbeInstructions;
279 /** Number of times probing resulted in EMEXITACTION_NORMAL_PROBED. */
280 STAMCOUNTER StatHistoryProbedNormal;
281 /** Number of times probing resulted in EMEXITACTION_EXEC_WITH_MAX. */
282 STAMCOUNTER StatHistoryProbedExecWithMax;
283 /** Number of times probing resulted in ring-3 continuation. */
284 STAMCOUNTER StatHistoryProbedToRing3;
285 /** Profiling the EMHistoryExec when probing.*/
286 STAMPROFILE StatHistoryProbe;
287 /** Hit statistics for each lookup step. */
288 STAMCOUNTER aStatHistoryRecHits[16];
289 /** Type change statistics for each lookup step. */
290 STAMCOUNTER aStatHistoryRecTypeChanged[16];
291 /** Replacement statistics for each lookup step. */
292 STAMCOUNTER aStatHistoryRecReplaced[16];
293 /** New record statistics for each lookup step. */
294 STAMCOUNTER aStatHistoryRecNew[16];
295
296 /** Exit records (32KB). (Aligned on 32 byte boundrary.) */
297 EMEXITREC aExitRecords[1024];
298} EMCPU;
299/** Pointer to EM VM instance data. */
300typedef EMCPU *PEMCPU;
301
302/** @} */
303
304int emR3InitDbg(PVM pVM);
305
306int emR3HmExecute(PVM pVM, PVMCPU pVCpu, bool *pfFFDone);
307VBOXSTRICTRC emR3NemExecute(PVM pVM, PVMCPU pVCpu, bool *pfFFDone);
308int emR3RawExecute(PVM pVM, PVMCPU pVCpu, bool *pfFFDone);
309
310EMSTATE emR3Reschedule(PVM pVM, PVMCPU pVCpu);
311int emR3ForcedActions(PVM pVM, PVMCPU pVCpu, int rc);
312VBOXSTRICTRC emR3HighPriorityPostForcedActions(PVM pVM, PVMCPU pVCpu, VBOXSTRICTRC rc);
313
314int emR3RawResumeHyper(PVM pVM, PVMCPU pVCpu);
315int emR3RawStep(PVM pVM, PVMCPU pVCpu);
316
317VBOXSTRICTRC emR3NemSingleInstruction(PVM pVM, PVMCPU pVCpu, uint32_t fFlags);
318
319int emR3SingleStepExecRem(PVM pVM, PVMCPU pVCpu, uint32_t cIterations);
320
321bool emR3IsExecutionAllowed(PVM pVM, PVMCPU pVCpu);
322
323VBOXSTRICTRC emR3ExecutePendingIoPortWrite(PVM pVM, PVMCPU pVCpu);
324VBOXSTRICTRC emR3ExecutePendingIoPortRead(PVM pVM, PVMCPU pVCpu);
325VBOXSTRICTRC emR3ExecuteSplitLockInstruction(PVM pVM, PVMCPU pVCpu);
326
327RT_C_DECLS_END
328
329#endif /* !VMM_INCLUDED_SRC_include_EMInternal_h */
330
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