VirtualBox

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

Last change on this file since 53615 was 53615, checked in by vboxsync, 10 years ago

doxygen fixes.

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