VirtualBox

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

Last change on this file since 47671 was 47671, checked in by vboxsync, 11 years ago

VMM: More debugging related stuff.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.7 KB
Line 
1/** @file
2 * EM - Execution Monitor.
3 */
4
5/*
6 * Copyright (C) 2006-2013 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 * @{
37 */
38
39/** Enable to allow V86 code to run in raw mode. */
40#define VBOX_RAW_V86
41
42/**
43 * The Execution Manager State.
44 *
45 * @remarks This is used in the saved state!
46 */
47typedef enum EMSTATE
48{
49 /** Not yet started. */
50 EMSTATE_NONE = 1,
51 /** Raw-mode execution. */
52 EMSTATE_RAW,
53 /** Hardware accelerated raw-mode execution. */
54 EMSTATE_HM,
55 /** Executing in IEM. */
56 EMSTATE_IEM,
57 /** Recompiled mode execution. */
58 EMSTATE_REM,
59 /** Execution is halted. (waiting for interrupt) */
60 EMSTATE_HALTED,
61 /** Application processor execution is halted. (waiting for startup IPI (SIPI)) */
62 EMSTATE_WAIT_SIPI,
63 /** Execution is suspended. */
64 EMSTATE_SUSPENDED,
65 /** The VM is terminating. */
66 EMSTATE_TERMINATING,
67 /** Guest debug event from raw-mode is being processed. */
68 EMSTATE_DEBUG_GUEST_RAW,
69 /** Guest debug event from hardware accelerated mode is being processed. */
70 EMSTATE_DEBUG_GUEST_HM,
71 /** Guest debug event from interpreted execution mode is being processed. */
72 EMSTATE_DEBUG_GUEST_IEM,
73 /** Guest debug event from recompiled-mode is being processed. */
74 EMSTATE_DEBUG_GUEST_REM,
75 /** Hypervisor debug event being processed. */
76 EMSTATE_DEBUG_HYPER,
77 /** The VM has encountered a fatal error. (And everyone is panicing....) */
78 EMSTATE_GURU_MEDITATION,
79 /** Just a hack to ensure that we get a 32-bit integer. */
80 EMSTATE_MAKE_32BIT_HACK = 0x7fffffff
81} EMSTATE;
82
83
84/**
85 * EMInterpretInstructionCPU execution modes.
86 */
87typedef enum
88{
89 /** Only supervisor code (CPL=0). */
90 EMCODETYPE_SUPERVISOR,
91 /** User-level code only. */
92 EMCODETYPE_USER,
93 /** Supervisor and user-level code (use with great care!). */
94 EMCODETYPE_ALL,
95 /** Just a hack to ensure that we get a 32-bit integer. */
96 EMCODETYPE_32BIT_HACK = 0x7fffffff
97} EMCODETYPE;
98
99VMM_INT_DECL(EMSTATE) EMGetState(PVMCPU pVCpu);
100VMM_INT_DECL(void) EMSetState(PVMCPU pVCpu, EMSTATE enmNewState);
101
102/** @name Callback handlers for instruction emulation functions.
103 * These are placed here because IOM wants to use them as well.
104 * @{
105 */
106typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM2UINT32(void *pvParam1, uint64_t val2);
107typedef FNEMULATEPARAM2UINT32 *PFNEMULATEPARAM2UINT32;
108typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM2(void *pvParam1, size_t val2);
109typedef FNEMULATEPARAM2 *PFNEMULATEPARAM2;
110typedef DECLCALLBACK(uint32_t) FNEMULATEPARAM3(void *pvParam1, uint64_t val2, size_t val3);
111typedef FNEMULATEPARAM3 *PFNEMULATEPARAM3;
112typedef DECLCALLBACK(int) FNEMULATELOCKPARAM2(void *pvParam1, uint64_t val2, RTGCUINTREG32 *pf);
113typedef FNEMULATELOCKPARAM2 *PFNEMULATELOCKPARAM2;
114typedef DECLCALLBACK(int) FNEMULATELOCKPARAM3(void *pvParam1, uint64_t val2, size_t cb, RTGCUINTREG32 *pf);
115typedef FNEMULATELOCKPARAM3 *PFNEMULATELOCKPARAM3;
116/** @} */
117
118
119/**
120 * Checks if raw ring-3 execute mode is enabled.
121 *
122 * @returns true if enabled.
123 * @returns false if disabled.
124 * @param pVM The VM to operate on.
125 */
126#define EMIsRawRing3Enabled(pVM) (!(pVM)->fRecompileUser)
127
128/**
129 * Checks if raw ring-0 execute mode is enabled.
130 *
131 * @returns true if enabled.
132 * @returns false if disabled.
133 * @param pVM The VM to operate on.
134 */
135#define EMIsRawRing0Enabled(pVM) (!(pVM)->fRecompileSupervisor)
136
137#ifdef VBOX_WITH_RAW_RING1
138/**
139 * Checks if raw ring-1 execute mode is enabled.
140 *
141 * @returns true if enabled.
142 * @returns false if disabled.
143 * @param pVM The VM to operate on.
144 */
145# define EMIsRawRing1Enabled(pVM) ((pVM)->fRawRing1Enabled)
146#else
147# define EMIsRawRing1Enabled(pVM) false
148#endif
149
150/**
151 * Checks if execution with hardware assisted virtualization is enabled.
152 *
153 * @returns true if enabled.
154 * @returns false if disabled.
155 * @param pVM The VM to operate on.
156 */
157#define EMIsHwVirtExecutionEnabled(pVM) (!(pVM)->fRecompileSupervisor && !(pVM)->fRecompileUser)
158
159/**
160 * Checks if execution of supervisor code should be done in the
161 * recompiler or not.
162 *
163 * @returns true if enabled.
164 * @returns false if disabled.
165 * @param pVM The VM to operate on.
166 */
167#define EMIsSupervisorCodeRecompiled(pVM) ((pVM)->fRecompileSupervisor)
168
169VMMDECL(void) EMSetInhibitInterruptsPC(PVMCPU pVCpu, RTGCUINTPTR PC);
170VMMDECL(RTGCUINTPTR) EMGetInhibitInterruptsPC(PVMCPU pVCpu);
171VMM_INT_DECL(int) EMInterpretDisasCurrent(PVM pVM, PVMCPU pVCpu, PDISCPUSTATE pCpu, unsigned *pcbInstr);
172VMM_INT_DECL(int) EMInterpretDisasOneEx(PVM pVM, PVMCPU pVCpu, RTGCUINTPTR GCPtrInstr, PCCPUMCTXCORE pCtxCore,
173 PDISCPUSTATE pDISState, unsigned *pcbInstr);
174VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstruction(PVMCPU pVCpu, PCPUMCTXCORE pCoreCtx, RTGCPTR pvFault);
175VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstructionEx(PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault, uint32_t *pcbWritten);
176VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInstructionDisasState(PVMCPU pVCpu, PDISCPUSTATE pDis, PCPUMCTXCORE pCoreCtx,
177 RTGCPTR pvFault, EMCODETYPE enmCodeType);
178
179#ifdef IN_RC
180VMM_INT_DECL(int) EMInterpretIretV86ForPatm(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
181#endif
182
183VMM_INT_DECL(int) EMInterpretCpuId(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
184VMM_INT_DECL(int) EMInterpretRdtsc(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
185VMM_INT_DECL(int) EMInterpretRdpmc(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
186VMM_INT_DECL(int) EMInterpretRdtscp(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
187VMM_INT_DECL(VBOXSTRICTRC) EMInterpretInvlpg(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pAddrGC);
188VMM_INT_DECL(VBOXSTRICTRC) EMInterpretMWait(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
189VMM_INT_DECL(int) EMInterpretMonitor(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
190VMM_INT_DECL(int) EMInterpretDRxWrite(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegDrx, uint32_t SrcRegGen);
191VMM_INT_DECL(int) EMInterpretDRxRead(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegGen, uint32_t SrcRegDrx);
192VMM_INT_DECL(int) EMInterpretCRxWrite(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegCrx, uint32_t SrcRegGen);
193VMM_INT_DECL(int) EMInterpretCRxRead(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t DestRegGen, uint32_t SrcRegCrx);
194VMM_INT_DECL(int) EMInterpretLMSW(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint16_t u16Data);
195VMM_INT_DECL(int) EMInterpretCLTS(PVM pVM, PVMCPU pVCpu);
196VMM_INT_DECL(int) EMInterpretRdmsr(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
197VMM_INT_DECL(int) EMInterpretWrmsr(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
198VMM_INT_DECL(bool) EMShouldContinueAfterHalt(PVMCPU pVCpu, PCPUMCTX pCtx);
199VMM_INT_DECL(int) EMMonitorWaitPrepare(PVMCPU pVCpu, uint64_t rax, uint64_t rcx, uint64_t rdx, RTGCPHYS GCPhys);
200VMM_INT_DECL(int) EMMonitorWaitPerform(PVMCPU pVCpu, uint64_t rax, uint64_t rcx);
201
202/** @name Assembly routines
203 * @{ */
204VMMDECL(uint32_t) EMEmulateCmp(uint32_t u32Param1, uint64_t u64Param2, size_t cb);
205VMMDECL(uint32_t) EMEmulateAnd(void *pvParam1, uint64_t u64Param2, size_t cb);
206VMMDECL(uint32_t) EMEmulateInc(void *pvParam1, size_t cb);
207VMMDECL(uint32_t) EMEmulateDec(void *pvParam1, size_t cb);
208VMMDECL(uint32_t) EMEmulateOr(void *pvParam1, uint64_t u64Param2, size_t cb);
209VMMDECL(int) EMEmulateLockOr(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
210VMMDECL(uint32_t) EMEmulateXor(void *pvParam1, uint64_t u64Param2, size_t cb);
211VMMDECL(int) EMEmulateLockXor(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
212VMMDECL(uint32_t) EMEmulateAdd(void *pvParam1, uint64_t u64Param2, size_t cb);
213VMMDECL(int) EMEmulateLockAnd(void *pvParam1, uint64_t u64Param2, size_t cbSize, RTGCUINTREG32 *pf);
214VMMDECL(uint32_t) EMEmulateSub(void *pvParam1, uint64_t u64Param2, size_t cb);
215VMMDECL(uint32_t) EMEmulateAdcWithCarrySet(void *pvParam1, uint64_t u64Param2, size_t cb);
216VMMDECL(uint32_t) EMEmulateBtr(void *pvParam1, uint64_t u64Param2);
217VMMDECL(int) EMEmulateLockBtr(void *pvParam1, uint64_t u64Param2, RTGCUINTREG32 *pf);
218VMMDECL(uint32_t) EMEmulateBts(void *pvParam1, uint64_t u64Param2);
219VMMDECL(uint32_t) EMEmulateBtc(void *pvParam1, uint64_t u64Param2);
220VMMDECL(uint32_t) EMEmulateCmpXchg(void *pvParam1, uint64_t *pu32Param2, uint64_t u32Param3, size_t cbSize);
221VMMDECL(uint32_t) EMEmulateLockCmpXchg(void *pvParam1, uint64_t *pu64Param2, uint64_t u64Param3, size_t cbSize);
222VMMDECL(uint32_t) EMEmulateCmpXchg8b(void *pu32Param1, uint32_t *pEAX, uint32_t *pEDX, uint32_t uEBX, uint32_t uECX);
223VMMDECL(uint32_t) EMEmulateLockCmpXchg8b(void *pu32Param1, uint32_t *pEAX, uint32_t *pEDX, uint32_t uEBX, uint32_t uECX);
224VMMDECL(uint32_t) EMEmulateXAdd(void *pvParam1, void *pvParam2, size_t cbOp);
225VMMDECL(uint32_t) EMEmulateLockXAdd(void *pvParam1, void *pvParam2, size_t cbOp);
226/** @} */
227
228/** @name REM locking routines
229 * @{ */
230VMMDECL(void) EMRemUnlock(PVM pVM);
231VMMDECL(void) EMRemLock(PVM pVM);
232VMMDECL(bool) EMRemIsLockOwner(PVM pVM);
233VMM_INT_DECL(int) EMRemTryLock(PVM pVM);
234/** @} */
235
236
237/** @name EM_ONE_INS_FLAGS_XXX - flags for EMR3HmSingleInstruction (et al).
238 * @{ */
239/** Return when CS:RIP changes or some other important event happens.
240 * This means running whole REP and LOOP $ sequences for instance. */
241#define EM_ONE_INS_FLAGS_RIP_CHANGE RT_BIT_32(0)
242/** Mask of valid flags. */
243#define EM_ONE_INS_FLAGS_MASK UINT32_C(0x00000001)
244/** @} */
245
246
247#ifdef IN_RING3
248/** @defgroup grp_em_r3 The EM Host Context Ring-3 API
249 * @ingroup grp_em
250 * @{
251 */
252
253/**
254 * Command argument for EMR3RawSetMode().
255 *
256 * It's possible to extend this interface to change several
257 * execution modes at once should the need arise.
258 */
259typedef enum EMEXECPOLICY
260{
261 /** The customary invalid zero entry. */
262 EMEXECPOLICY_INVALID = 0,
263 /** Whether to recompile ring-0 code or execute it in raw/hm. */
264 EMEXECPOLICY_RECOMPILE_RING0,
265 /** Whether to recompile ring-3 code or execute it in raw/hm. */
266 EMEXECPOLICY_RECOMPILE_RING3,
267 /** Whether to only use IEM for execution. */
268 EMEXECPOLICY_IEM_ALL,
269 /** End of valid value (not included). */
270 EMEXECPOLICY_END,
271 /** The customary 32-bit type blowup. */
272 EMEXECPOLICY_32BIT_HACK = 0x7fffffff
273} EMEXECPOLICY;
274VMMR3DECL(int) EMR3SetExecutionPolicy(PUVM pUVM, EMEXECPOLICY enmPolicy, bool fEnforce);
275VMMR3DECL(int) EMR3QueryExecutionPolicy(PUVM pUVM, EMEXECPOLICY enmPolicy, bool *pfEnforced);
276
277VMMR3_INT_DECL(int) EMR3Init(PVM pVM);
278VMMR3_INT_DECL(void) EMR3Relocate(PVM pVM);
279VMMR3_INT_DECL(void) EMR3ResetCpu(PVMCPU pVCpu);
280VMMR3_INT_DECL(void) EMR3Reset(PVM pVM);
281VMMR3_INT_DECL(int) EMR3Term(PVM pVM);
282VMMR3DECL(DECLNORETURN(void)) EMR3FatalError(PVMCPU pVCpu, int rc);
283VMMR3_INT_DECL(int) EMR3ExecuteVM(PVM pVM, PVMCPU pVCpu);
284VMMR3_INT_DECL(int) EMR3CheckRawForcedActions(PVM pVM, PVMCPU pVCpu);
285VMMR3_INT_DECL(int) EMR3NotifyResume(PVM pVM);
286VMMR3_INT_DECL(int) EMR3NotifySuspend(PVM pVM);
287VMMR3_INT_DECL(VBOXSTRICTRC) EMR3HmSingleInstruction(PVM pVM, PVMCPU pVCpu, uint32_t fFlags);
288
289/** @} */
290#endif /* IN_RING3 */
291
292/** @} */
293
294RT_C_DECLS_END
295
296#endif
297
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