VirtualBox

source: vbox/trunk/include/VBox/vmm/em.h@ 70979

Last change on this file since 70979 was 70979, checked in by vboxsync, 7 years ago

NEM: Working on the EM loops. bugref:9044

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.8 KB
Line 
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
33RT_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 */
48typedef 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 */
95typedef 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
107VMM_INT_DECL(EMSTATE) EMGetState(PVMCPU pVCpu);
108VMM_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 */
114typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM2UINT32(void *pvParam1, uint64_t val2);
115typedef FNEMULATEPARAM2UINT32 *PFNEMULATEPARAM2UINT32;
116typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM2(void *pvParam1, size_t val2);
117typedef FNEMULATEPARAM2 *PFNEMULATEPARAM2;
118typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM3(void *pvParam1, uint64_t val2, size_t val3);
119typedef FNEMULATEPARAM3 *PFNEMULATEPARAM3;
120typedef DECLCALLBACK(int) FNEMULATELOCKPARAM2(void *pvParam1, uint64_t val2, RTGCUINTREG32 *pf);
121typedef FNEMULATELOCKPARAM2 *PFNEMULATELOCKPARAM2;
122typedef DECLCALLBACK(int) FNEMULATELOCKPARAM3(void *pvParam1, uint64_t val2, size_t cb, RTGCUINTREG32 *pf);
123typedef 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
177VMMDECL(void) EMSetInhibitInterruptsPC(PVMCPU pVCpu, RTGCUINTPTR PC);
178VMMDECL(RTGCUINTPTR) EMGetInhibitInterruptsPC(PVMCPU pVCpu);
179VMM_INT_DECL(int) EMInterpretDisasCurrent(PVM pVM, PVMCPU pVCpu, PDISCPUSTATE pCpu, unsigned *pcbInstr);
180VMM_INT_DECL(int) EMInterpretDisasOneEx(PVM pVM, PVMCPU pVCpu, RTGCUINTPTR GCPtrInstr, PCCPUMCTXCORE pCtxCore,
181 PDISCPUSTATE pDISState, unsigned *pcbInstr);
182VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstruction(PVMCPU pVCpu, PCPUMCTXCORE pCoreCtx, RTGCPTR pvFault);
183VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstructionEx(PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault, uint32_t *pcbWritten);
184VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstructionDisasState(PVMCPU pVCpu, PDISCPUSTATE pDis, PCPUMCTXCORE pCoreCtx,
185 RTGCPTR pvFault, EMCODETYPE enmCodeType);
186
187#ifdef IN_RC
188VMM_INT_DECL(int) EMInterpretIretV86ForPatm(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
189#endif
190
191VMM_INT_DECL(int) EMInterpretCpuId(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
192VMM_INT_DECL(int) EMInterpretRdtsc(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
193VMM_INT_DECL(int) EMInterpretRdpmc(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
194VMM_INT_DECL(int) EMInterpretRdtscp(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
195VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInvlpg(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pAddrGC);
196VMM_INT_DECL(VBOXSTRICTRC) EMInterpretMWait(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
197VMM_INT_DECL(int) EMInterpretMonitor(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
198VMM_INT_DECL(int) EMInterpretDRxWrite(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegDrx, uint32_t SrcRegGen);
199VMM_INT_DECL(int) EMInterpretDRxRead(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegGen, uint32_t SrcRegDrx);
200VMM_INT_DECL(int) EMInterpretRdmsr(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
201VMM_INT_DECL(int) EMInterpretWrmsr(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
202VMM_INT_DECL(bool) EMShouldContinueAfterHalt(PVMCPU pVCpu, PCPUMCTX pCtx);
203VMM_INT_DECL(bool) EMMonitorWaitShouldContinue(PVMCPU pVCpu, PCPUMCTX pCtx);
204VMM_INT_DECL(int) EMMonitorWaitPrepare(PVMCPU pVCpu, uint64_t rax, uint64_t rcx, uint64_t rdx, RTGCPHYS GCPhys);
205VMM_INT_DECL(bool) EMMonitorIsArmed(PVMCPU pVCpu);
206VMM_INT_DECL(int) EMMonitorWaitPerform(PVMCPU pVCpu, uint64_t rax, uint64_t rcx);
207VMM_INT_DECL(int) EMUnhaltAndWakeUp(PVM pVM, PVMCPU pVCpuDst);
208
209/** @name Assembly routines
210 * @{ */
211VMMDECL(uint32_t) EMEmulateCmp(uint32_t u32Param1, uint64_t u64Param2, size_t cb);
212VMMDECL(uint32_t) EMEmulateAnd(void *pvParam1, uint64_t u64Param2, size_t cb);
213VMMDECL(uint32_t) EMEmulateInc(void *pvParam1, size_t cb);
214VMMDECL(uint32_t) EMEmulateDec(void *pvParam1, size_t cb);
215VMMDECL(uint32_t) EMEmulateOr(void *pvParam1, uint64_t u64Param2, size_t cb);
216VMMDECL(int) EMEmulateLockOr(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
217VMMDECL(uint32_t) EMEmulateXor(void *pvParam1, uint64_t u64Param2, size_t cb);
218VMMDECL(int) EMEmulateLockXor(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
219VMMDECL(uint32_t) EMEmulateAdd(void *pvParam1, uint64_t u64Param2, size_t cb);
220VMMDECL(int) EMEmulateLockAnd(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
221VMMDECL(uint32_t) EMEmulateSub(void *pvParam1, uint64_t u64Param2, size_t cb);
222VMMDECL(uint32_t) EMEmulateAdcWithCarrySet(void *pvParam1, uint64_t u64Param2, size_t cb);
223VMMDECL(uint32_t) EMEmulateBtr(void *pvParam1, uint64_t u64Param2);
224VMMDECL(int) EMEmulateLockBtr(void *pvParam1, uint64_t u64Param2, RTGCUINTREG32 *pf);
225VMMDECL(uint32_t) EMEmulateBts(void *pvParam1, uint64_t u64Param2);
226VMMDECL(uint32_t) EMEmulateBtc(void *pvParam1, uint64_t u64Param2);
227VMMDECL(uint32_t) EMEmulateCmpXchg(void *pvParam1, uint64_t *pu32Param2, uint64_t u32Param3, size_t cbSize);
228VMMDECL(uint32_t) EMEmulateLockCmpXchg(void *pvParam1, uint64_t *pu64Param2, uint64_t u64Param3, size_t cbSize);
229VMMDECL(uint32_t) EMEmulateCmpXchg8b(void *pu32Param1, uint32_t *pEAX, uint32_t *pEDX, uint32_t uEBX, uint32_t uECX);
230VMMDECL(uint32_t) EMEmulateLockCmpXchg8b(void *pu32Param1, uint32_t *pEAX, uint32_t *pEDX, uint32_t uEBX, uint32_t uECX);
231VMMDECL(uint32_t) EMEmulateXAdd(void *pvParam1, void *pvParam2, size_t cbOp);
232VMMDECL(uint32_t) EMEmulateLockXAdd(void *pvParam1, void *pvParam2, size_t cbOp);
233/** @} */
234
235/** @name REM locking routines
236 * @{ */
237VMMDECL(void) EMRemUnlock(PVM pVM);
238VMMDECL(void) EMRemLock(PVM pVM);
239VMMDECL(bool) EMRemIsLockOwner(PVM pVM);
240VMM_INT_DECL(int) EMRemTryLock(PVM pVM);
241/** @} */
242
243
244/** @name EM_ONE_INS_FLAGS_XXX - flags for EMR3HmSingleInstruction (et al).
245 * @{ */
246/** Return when CS:RIP changes or some other important event happens.
247 * This means running whole REP and LOOP $ sequences for instance. */
248#define EM_ONE_INS_FLAGS_RIP_CHANGE RT_BIT_32(0)
249/** Mask of valid flags. */
250#define EM_ONE_INS_FLAGS_MASK UINT32_C(0x00000001)
251/** @} */
252
253
254#ifdef IN_RING3
255/** @defgroup grp_em_r3 The EM Host Context Ring-3 API
256 * @{
257 */
258
259/**
260 * Command argument for EMR3RawSetMode().
261 *
262 * It's possible to extend this interface to change several
263 * execution modes at once should the need arise.
264 */
265typedef enum EMEXECPOLICY
266{
267 /** The customary invalid zero entry. */
268 EMEXECPOLICY_INVALID = 0,
269 /** Whether to recompile ring-0 code or execute it in raw/hm. */
270 EMEXECPOLICY_RECOMPILE_RING0,
271 /** Whether to recompile ring-3 code or execute it in raw/hm. */
272 EMEXECPOLICY_RECOMPILE_RING3,
273 /** Whether to only use IEM for execution. */
274 EMEXECPOLICY_IEM_ALL,
275 /** End of valid value (not included). */
276 EMEXECPOLICY_END,
277 /** The customary 32-bit type blowup. */
278 EMEXECPOLICY_32BIT_HACK = 0x7fffffff
279} EMEXECPOLICY;
280VMMR3DECL(int) EMR3SetExecutionPolicy(PUVM pUVM, EMEXECPOLICY enmPolicy, bool fEnforce);
281VMMR3DECL(int) EMR3QueryExecutionPolicy(PUVM pUVM, EMEXECPOLICY enmPolicy, bool *pfEnforced);
282
283VMMR3_INT_DECL(int) EMR3Init(PVM pVM);
284VMMR3_INT_DECL(void) EMR3Relocate(PVM pVM);
285VMMR3_INT_DECL(void) EMR3ResetCpu(PVMCPU pVCpu);
286VMMR3_INT_DECL(void) EMR3Reset(PVM pVM);
287VMMR3_INT_DECL(int) EMR3Term(PVM pVM);
288VMMR3DECL(DECLNORETURN(void)) EMR3FatalError(PVMCPU pVCpu, int rc);
289VMMR3_INT_DECL(int) EMR3ExecuteVM(PVM pVM, PVMCPU pVCpu);
290VMMR3_INT_DECL(int) EMR3CheckRawForcedActions(PVM pVM, PVMCPU pVCpu);
291VMMR3_INT_DECL(int) EMR3NotifyResume(PVM pVM);
292VMMR3_INT_DECL(int) EMR3NotifySuspend(PVM pVM);
293VMMR3_INT_DECL(VBOXSTRICTRC) EMR3HmSingleInstruction(PVM pVM, PVMCPU pVCpu, uint32_t fFlags);
294
295/** @} */
296#endif /* IN_RING3 */
297
298/** @} */
299
300RT_C_DECLS_END
301
302#endif
303
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