1 | /** @file
|
---|
2 | * EM - Execution Monitor.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2017 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___VBox_vmm_em_h
|
---|
27 | #define ___VBox_vmm_em_h
|
---|
28 |
|
---|
29 | #include <VBox/types.h>
|
---|
30 | #include <VBox/vmm/trpm.h>
|
---|
31 |
|
---|
32 |
|
---|
33 | RT_C_DECLS_BEGIN
|
---|
34 |
|
---|
35 | /** @defgroup grp_em The Execution Monitor / Manager API
|
---|
36 | * @ingroup grp_vmm
|
---|
37 | * @{
|
---|
38 | */
|
---|
39 |
|
---|
40 | /** Enable to allow V86 code to run in raw mode. */
|
---|
41 | #define VBOX_RAW_V86
|
---|
42 |
|
---|
43 | /**
|
---|
44 | * The Execution Manager State.
|
---|
45 | *
|
---|
46 | * @remarks This is used in the saved state!
|
---|
47 | */
|
---|
48 | typedef enum EMSTATE
|
---|
49 | {
|
---|
50 | /** Not yet started. */
|
---|
51 | EMSTATE_NONE = 1,
|
---|
52 | /** Raw-mode execution. */
|
---|
53 | EMSTATE_RAW,
|
---|
54 | /** Hardware accelerated raw-mode execution. */
|
---|
55 | EMSTATE_HM,
|
---|
56 | /** Executing in IEM. */
|
---|
57 | EMSTATE_IEM,
|
---|
58 | /** Recompiled mode execution. */
|
---|
59 | EMSTATE_REM,
|
---|
60 | /** Execution is halted. (waiting for interrupt) */
|
---|
61 | EMSTATE_HALTED,
|
---|
62 | /** Application processor execution is halted. (waiting for startup IPI (SIPI)) */
|
---|
63 | EMSTATE_WAIT_SIPI,
|
---|
64 | /** Execution is suspended. */
|
---|
65 | EMSTATE_SUSPENDED,
|
---|
66 | /** The VM is terminating. */
|
---|
67 | EMSTATE_TERMINATING,
|
---|
68 | /** Guest debug event from raw-mode is being processed. */
|
---|
69 | EMSTATE_DEBUG_GUEST_RAW,
|
---|
70 | /** Guest debug event from hardware accelerated mode is being processed. */
|
---|
71 | EMSTATE_DEBUG_GUEST_HM,
|
---|
72 | /** Guest debug event from interpreted execution mode is being processed. */
|
---|
73 | EMSTATE_DEBUG_GUEST_IEM,
|
---|
74 | /** Guest debug event from recompiled-mode is being processed. */
|
---|
75 | EMSTATE_DEBUG_GUEST_REM,
|
---|
76 | /** Hypervisor debug event being processed. */
|
---|
77 | EMSTATE_DEBUG_HYPER,
|
---|
78 | /** The VM has encountered a fatal error. (And everyone is panicing....) */
|
---|
79 | EMSTATE_GURU_MEDITATION,
|
---|
80 | /** Executing in IEM, falling back on REM if we cannot switch back to HM or
|
---|
81 | * RAW after a short while. */
|
---|
82 | EMSTATE_IEM_THEN_REM,
|
---|
83 | /** Executing in native (API) execution monitor. */
|
---|
84 | EMSTATE_NEM,
|
---|
85 | /** Guest debug event from NEM mode is being processed. */
|
---|
86 | EMSTATE_DEBUG_GUEST_NEM,
|
---|
87 | /** Just a hack to ensure that we get a 32-bit integer. */
|
---|
88 | EMSTATE_MAKE_32BIT_HACK = 0x7fffffff
|
---|
89 | } EMSTATE;
|
---|
90 |
|
---|
91 |
|
---|
92 | /**
|
---|
93 | * EMInterpretInstructionCPU execution modes.
|
---|
94 | */
|
---|
95 | typedef enum
|
---|
96 | {
|
---|
97 | /** Only supervisor code (CPL=0). */
|
---|
98 | EMCODETYPE_SUPERVISOR,
|
---|
99 | /** User-level code only. */
|
---|
100 | EMCODETYPE_USER,
|
---|
101 | /** Supervisor and user-level code (use with great care!). */
|
---|
102 | EMCODETYPE_ALL,
|
---|
103 | /** Just a hack to ensure that we get a 32-bit integer. */
|
---|
104 | EMCODETYPE_32BIT_HACK = 0x7fffffff
|
---|
105 | } EMCODETYPE;
|
---|
106 |
|
---|
107 | VMM_INT_DECL(EMSTATE) EMGetState(PVMCPU pVCpu);
|
---|
108 | VMM_INT_DECL(void) EMSetState(PVMCPU pVCpu, EMSTATE enmNewState);
|
---|
109 |
|
---|
110 | /** @name Callback handlers for instruction emulation functions.
|
---|
111 | * These are placed here because IOM wants to use them as well.
|
---|
112 | * @{
|
---|
113 | */
|
---|
114 | typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM2UINT32(void *pvParam1, uint64_t val2);
|
---|
115 | typedef FNEMULATEPARAM2UINT32 *PFNEMULATEPARAM2UINT32;
|
---|
116 | typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM2(void *pvParam1, size_t val2);
|
---|
117 | typedef FNEMULATEPARAM2 *PFNEMULATEPARAM2;
|
---|
118 | typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM3(void *pvParam1, uint64_t val2, size_t val3);
|
---|
119 | typedef FNEMULATEPARAM3 *PFNEMULATEPARAM3;
|
---|
120 | typedef DECLCALLBACK(int) FNEMULATELOCKPARAM2(void *pvParam1, uint64_t val2, RTGCUINTREG32 *pf);
|
---|
121 | typedef FNEMULATELOCKPARAM2 *PFNEMULATELOCKPARAM2;
|
---|
122 | typedef DECLCALLBACK(int) FNEMULATELOCKPARAM3(void *pvParam1, uint64_t val2, size_t cb, RTGCUINTREG32 *pf);
|
---|
123 | typedef FNEMULATELOCKPARAM3 *PFNEMULATELOCKPARAM3;
|
---|
124 | /** @} */
|
---|
125 |
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * Checks if raw ring-3 execute mode is enabled.
|
---|
129 | *
|
---|
130 | * @returns true if enabled.
|
---|
131 | * @returns false if disabled.
|
---|
132 | * @param pVM The cross context VM structure.
|
---|
133 | */
|
---|
134 | #define EMIsRawRing3Enabled(pVM) (!(pVM)->fRecompileUser)
|
---|
135 |
|
---|
136 | /**
|
---|
137 | * Checks if raw ring-0 execute mode is enabled.
|
---|
138 | *
|
---|
139 | * @returns true if enabled.
|
---|
140 | * @returns false if disabled.
|
---|
141 | * @param pVM The cross context VM structure.
|
---|
142 | */
|
---|
143 | #define EMIsRawRing0Enabled(pVM) (!(pVM)->fRecompileSupervisor)
|
---|
144 |
|
---|
145 | #ifdef VBOX_WITH_RAW_RING1
|
---|
146 | /**
|
---|
147 | * Checks if raw ring-1 execute mode is enabled.
|
---|
148 | *
|
---|
149 | * @returns true if enabled.
|
---|
150 | * @returns false if disabled.
|
---|
151 | * @param pVM The cross context VM structure.
|
---|
152 | */
|
---|
153 | # define EMIsRawRing1Enabled(pVM) ((pVM)->fRawRing1Enabled)
|
---|
154 | #else
|
---|
155 | # define EMIsRawRing1Enabled(pVM) false
|
---|
156 | #endif
|
---|
157 |
|
---|
158 | /**
|
---|
159 | * Checks if execution with hardware assisted virtualization is enabled.
|
---|
160 | *
|
---|
161 | * @returns true if enabled.
|
---|
162 | * @returns false if disabled.
|
---|
163 | * @param pVM The cross context VM structure.
|
---|
164 | */
|
---|
165 | #define EMIsHwVirtExecutionEnabled(pVM) (!(pVM)->fRecompileSupervisor && !(pVM)->fRecompileUser)
|
---|
166 |
|
---|
167 | /**
|
---|
168 | * Checks if execution of supervisor code should be done in the
|
---|
169 | * recompiler or not.
|
---|
170 | *
|
---|
171 | * @returns true if enabled.
|
---|
172 | * @returns false if disabled.
|
---|
173 | * @param pVM The cross context VM structure.
|
---|
174 | */
|
---|
175 | #define EMIsSupervisorCodeRecompiled(pVM) ((pVM)->fRecompileSupervisor)
|
---|
176 |
|
---|
177 | VMMDECL(void) EMSetInhibitInterruptsPC(PVMCPU pVCpu, RTGCUINTPTR PC);
|
---|
178 | VMMDECL(RTGCUINTPTR) EMGetInhibitInterruptsPC(PVMCPU pVCpu);
|
---|
179 | VMMDECL(void) EMSetHypercallInstructionsEnabled(PVMCPU pVCpu, bool fEnabled);
|
---|
180 | VMMDECL(bool) EMAreHypercallInstructionsEnabled(PVMCPU pVCpu);
|
---|
181 |
|
---|
182 | VMM_INT_DECL(int) EMInterpretDisasCurrent(PVM pVM, PVMCPU pVCpu, PDISCPUSTATE pCpu, unsigned *pcbInstr);
|
---|
183 | VMM_INT_DECL(int) EMInterpretDisasOneEx(PVM pVM, PVMCPU pVCpu, RTGCUINTPTR GCPtrInstr, PCCPUMCTXCORE pCtxCore,
|
---|
184 | PDISCPUSTATE pDISState, unsigned *pcbInstr);
|
---|
185 | VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstruction(PVMCPU pVCpu, PCPUMCTXCORE pCoreCtx, RTGCPTR pvFault);
|
---|
186 | VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstructionEx(PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault, uint32_t *pcbWritten);
|
---|
187 | VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstructionDisasState(PVMCPU pVCpu, PDISCPUSTATE pDis, PCPUMCTXCORE pCoreCtx,
|
---|
188 | RTGCPTR pvFault, EMCODETYPE enmCodeType);
|
---|
189 |
|
---|
190 | #ifdef IN_RC
|
---|
191 | VMM_INT_DECL(int) EMInterpretIretV86ForPatm(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
192 | #endif
|
---|
193 |
|
---|
194 | VMM_INT_DECL(int) EMInterpretCpuId(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
195 | VMM_INT_DECL(int) EMInterpretRdtsc(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
196 | VMM_INT_DECL(int) EMInterpretRdpmc(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
197 | VMM_INT_DECL(int) EMInterpretRdtscp(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
|
---|
198 | VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInvlpg(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pAddrGC);
|
---|
199 | VMM_INT_DECL(VBOXSTRICTRC) EMInterpretMWait(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
200 | VMM_INT_DECL(int) EMInterpretMonitor(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
201 | VMM_INT_DECL(int) EMInterpretDRxWrite(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegDrx, uint32_t SrcRegGen);
|
---|
202 | VMM_INT_DECL(int) EMInterpretDRxRead(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegGen, uint32_t SrcRegDrx);
|
---|
203 | VMM_INT_DECL(int) EMInterpretRdmsr(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
204 | VMM_INT_DECL(int) EMInterpretWrmsr(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
|
---|
205 | VMM_INT_DECL(bool) EMShouldContinueAfterHalt(PVMCPU pVCpu, PCPUMCTX pCtx);
|
---|
206 | VMM_INT_DECL(bool) EMMonitorWaitShouldContinue(PVMCPU pVCpu, PCPUMCTX pCtx);
|
---|
207 | VMM_INT_DECL(int) EMMonitorWaitPrepare(PVMCPU pVCpu, uint64_t rax, uint64_t rcx, uint64_t rdx, RTGCPHYS GCPhys);
|
---|
208 | VMM_INT_DECL(bool) EMMonitorIsArmed(PVMCPU pVCpu);
|
---|
209 | VMM_INT_DECL(int) EMMonitorWaitPerform(PVMCPU pVCpu, uint64_t rax, uint64_t rcx);
|
---|
210 | VMM_INT_DECL(int) EMUnhaltAndWakeUp(PVM pVM, PVMCPU pVCpuDst);
|
---|
211 | VMMRZ_INT_DECL(VBOXSTRICTRC) EMRZSetPendingIoPortWrite(PVMCPU pVCpu, RTIOPORT uPort, uint8_t cbInstr, uint8_t cbValue, uint32_t uValue);
|
---|
212 | VMMRZ_INT_DECL(VBOXSTRICTRC) EMRZSetPendingIoPortRead(PVMCPU pVCpu, RTIOPORT uPort, uint8_t cbInstr, uint8_t cbValue);
|
---|
213 |
|
---|
214 | /** @name Assembly routines
|
---|
215 | * @{ */
|
---|
216 | VMMDECL(uint32_t) EMEmulateCmp(uint32_t u32Param1, uint64_t u64Param2, size_t cb);
|
---|
217 | VMMDECL(uint32_t) EMEmulateAnd(void *pvParam1, uint64_t u64Param2, size_t cb);
|
---|
218 | VMMDECL(uint32_t) EMEmulateInc(void *pvParam1, size_t cb);
|
---|
219 | VMMDECL(uint32_t) EMEmulateDec(void *pvParam1, size_t cb);
|
---|
220 | VMMDECL(uint32_t) EMEmulateOr(void *pvParam1, uint64_t u64Param2, size_t cb);
|
---|
221 | VMMDECL(int) EMEmulateLockOr(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
|
---|
222 | VMMDECL(uint32_t) EMEmulateXor(void *pvParam1, uint64_t u64Param2, size_t cb);
|
---|
223 | VMMDECL(int) EMEmulateLockXor(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
|
---|
224 | VMMDECL(uint32_t) EMEmulateAdd(void *pvParam1, uint64_t u64Param2, size_t cb);
|
---|
225 | VMMDECL(int) EMEmulateLockAnd(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
|
---|
226 | VMMDECL(uint32_t) EMEmulateSub(void *pvParam1, uint64_t u64Param2, size_t cb);
|
---|
227 | VMMDECL(uint32_t) EMEmulateAdcWithCarrySet(void *pvParam1, uint64_t u64Param2, size_t cb);
|
---|
228 | VMMDECL(uint32_t) EMEmulateBtr(void *pvParam1, uint64_t u64Param2);
|
---|
229 | VMMDECL(int) EMEmulateLockBtr(void *pvParam1, uint64_t u64Param2, RTGCUINTREG32 *pf);
|
---|
230 | VMMDECL(uint32_t) EMEmulateBts(void *pvParam1, uint64_t u64Param2);
|
---|
231 | VMMDECL(uint32_t) EMEmulateBtc(void *pvParam1, uint64_t u64Param2);
|
---|
232 | VMMDECL(uint32_t) EMEmulateCmpXchg(void *pvParam1, uint64_t *pu32Param2, uint64_t u32Param3, size_t cbSize);
|
---|
233 | VMMDECL(uint32_t) EMEmulateLockCmpXchg(void *pvParam1, uint64_t *pu64Param2, uint64_t u64Param3, size_t cbSize);
|
---|
234 | VMMDECL(uint32_t) EMEmulateCmpXchg8b(void *pu32Param1, uint32_t *pEAX, uint32_t *pEDX, uint32_t uEBX, uint32_t uECX);
|
---|
235 | VMMDECL(uint32_t) EMEmulateLockCmpXchg8b(void *pu32Param1, uint32_t *pEAX, uint32_t *pEDX, uint32_t uEBX, uint32_t uECX);
|
---|
236 | VMMDECL(uint32_t) EMEmulateXAdd(void *pvParam1, void *pvParam2, size_t cbOp);
|
---|
237 | VMMDECL(uint32_t) EMEmulateLockXAdd(void *pvParam1, void *pvParam2, size_t cbOp);
|
---|
238 | /** @} */
|
---|
239 |
|
---|
240 | /** @name REM locking routines
|
---|
241 | * @{ */
|
---|
242 | VMMDECL(void) EMRemUnlock(PVM pVM);
|
---|
243 | VMMDECL(void) EMRemLock(PVM pVM);
|
---|
244 | VMMDECL(bool) EMRemIsLockOwner(PVM pVM);
|
---|
245 | VMM_INT_DECL(int) EMRemTryLock(PVM pVM);
|
---|
246 | /** @} */
|
---|
247 |
|
---|
248 |
|
---|
249 | /** @name EM_ONE_INS_FLAGS_XXX - flags for EMR3HmSingleInstruction (et al).
|
---|
250 | * @{ */
|
---|
251 | /** Return when CS:RIP changes or some other important event happens.
|
---|
252 | * This means running whole REP and LOOP $ sequences for instance. */
|
---|
253 | #define EM_ONE_INS_FLAGS_RIP_CHANGE RT_BIT_32(0)
|
---|
254 | /** Mask of valid flags. */
|
---|
255 | #define EM_ONE_INS_FLAGS_MASK UINT32_C(0x00000001)
|
---|
256 | /** @} */
|
---|
257 |
|
---|
258 |
|
---|
259 | #ifdef IN_RING3
|
---|
260 | /** @defgroup grp_em_r3 The EM Host Context Ring-3 API
|
---|
261 | * @{
|
---|
262 | */
|
---|
263 |
|
---|
264 | /**
|
---|
265 | * Command argument for EMR3RawSetMode().
|
---|
266 | *
|
---|
267 | * It's possible to extend this interface to change several
|
---|
268 | * execution modes at once should the need arise.
|
---|
269 | */
|
---|
270 | typedef enum EMEXECPOLICY
|
---|
271 | {
|
---|
272 | /** The customary invalid zero entry. */
|
---|
273 | EMEXECPOLICY_INVALID = 0,
|
---|
274 | /** Whether to recompile ring-0 code or execute it in raw/hm. */
|
---|
275 | EMEXECPOLICY_RECOMPILE_RING0,
|
---|
276 | /** Whether to recompile ring-3 code or execute it in raw/hm. */
|
---|
277 | EMEXECPOLICY_RECOMPILE_RING3,
|
---|
278 | /** Whether to only use IEM for execution. */
|
---|
279 | EMEXECPOLICY_IEM_ALL,
|
---|
280 | /** End of valid value (not included). */
|
---|
281 | EMEXECPOLICY_END,
|
---|
282 | /** The customary 32-bit type blowup. */
|
---|
283 | EMEXECPOLICY_32BIT_HACK = 0x7fffffff
|
---|
284 | } EMEXECPOLICY;
|
---|
285 | VMMR3DECL(int) EMR3SetExecutionPolicy(PUVM pUVM, EMEXECPOLICY enmPolicy, bool fEnforce);
|
---|
286 | VMMR3DECL(int) EMR3QueryExecutionPolicy(PUVM pUVM, EMEXECPOLICY enmPolicy, bool *pfEnforced);
|
---|
287 | VMMR3DECL(int) EMR3QueryMainExecutionEngine(PUVM pUVM, uint8_t *pbMainExecutionEngine);
|
---|
288 |
|
---|
289 | VMMR3_INT_DECL(int) EMR3Init(PVM pVM);
|
---|
290 | VMMR3_INT_DECL(void) EMR3Relocate(PVM pVM);
|
---|
291 | VMMR3_INT_DECL(void) EMR3ResetCpu(PVMCPU pVCpu);
|
---|
292 | VMMR3_INT_DECL(void) EMR3Reset(PVM pVM);
|
---|
293 | VMMR3_INT_DECL(int) EMR3Term(PVM pVM);
|
---|
294 | VMMR3DECL(DECLNORETURN(void)) EMR3FatalError(PVMCPU pVCpu, int rc);
|
---|
295 | VMMR3_INT_DECL(int) EMR3ExecuteVM(PVM pVM, PVMCPU pVCpu);
|
---|
296 | VMMR3_INT_DECL(int) EMR3CheckRawForcedActions(PVM pVM, PVMCPU pVCpu);
|
---|
297 | VMMR3_INT_DECL(int) EMR3NotifyResume(PVM pVM);
|
---|
298 | VMMR3_INT_DECL(int) EMR3NotifySuspend(PVM pVM);
|
---|
299 | VMMR3_INT_DECL(VBOXSTRICTRC) EMR3HmSingleInstruction(PVM pVM, PVMCPU pVCpu, uint32_t fFlags);
|
---|
300 |
|
---|
301 | /** @} */
|
---|
302 | #endif /* IN_RING3 */
|
---|
303 |
|
---|
304 | /** @} */
|
---|
305 |
|
---|
306 | RT_C_DECLS_END
|
---|
307 |
|
---|
308 | #endif
|
---|
309 |
|
---|