VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMInternal.h@ 4672

Last change on this file since 4672 was 4071, checked in by vboxsync, 17 years ago

Biggest check-in ever. New source code headers for all (C) innotek files.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 15.6 KB
Line 
1/* $Id: VMMInternal.h 4071 2007-08-07 17:07:59Z vboxsync $ */
2/** @file
3 * VMM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
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 as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef ___VMMInternal_h
19#define ___VMMInternal_h
20
21#include <VBox/cdefs.h>
22#include <VBox/stam.h>
23#include <VBox/log.h>
24#include <iprt/critsect.h>
25
26
27#if !defined(IN_VMM_R3) && !defined(IN_VMM_R0) && !defined(IN_VMM_GC)
28# error "Not in VMM! This is an internal header!"
29#endif
30
31
32/** @defgroup grp_vmm_int Internals
33 * @ingroup grp_vmm
34 * @internal
35 * @{
36 */
37
38/** @def VBOX_WITH_GC_AND_R0_RELEASE_LOG
39 * Enabled GC and R0 release logging (the latter is not implemented yet). */
40#define VBOX_WITH_GC_AND_R0_RELEASE_LOG
41
42
43/**
44 * Converts a VMM pointer into a VM pointer.
45 * @returns Pointer to the VM structure the VMM is part of.
46 * @param pVMM Pointer to VMM instance data.
47 */
48#define VMM2VM(pVMM) ( (PVM)((char*)pVMM - pVMM->offVM) )
49
50
51/**
52 * Switcher function, HC to GC.
53 *
54 * @param pVM The VM handle.
55 * @returns Return code indicating the action to take.
56 */
57typedef DECLASMTYPE(int) FNVMMSWITCHERHC(PVM pVM);
58/** Pointer to switcher function. */
59typedef FNVMMSWITCHERHC *PFNVMMSWITCHERHC;
60
61/**
62 * Switcher function, GC to HC.
63 *
64 * @param rc VBox status code.
65 */
66typedef DECLASMTYPE(void) FNVMMSWITCHERGC(int rc);
67/** Pointer to switcher function. */
68typedef FNVMMSWITCHERGC *PFNVMMSWITCHERGC;
69
70
71/**
72 * The ring-0 logger instance.
73 * We need to be able to find the VM handle from the logger instance.
74 */
75typedef struct VMMR0LOGGER
76{
77 /** Pointer to the VM handle. */
78 PVM pVM;
79 /** Size of the allocated logger instance (Logger). */
80 uint32_t cbLogger;
81 /** Flag indicating whether we've create the logger Ring-0 instance yet. */
82 bool fCreated;
83#if HC_ARCH_BITS == 32
84 uint32_t u32Alignment;
85#endif
86 /** The ring-0 logger instance. This extends beyon the size.*/
87 RTLOGGER Logger;
88} VMMR0LOGGER, *PVMMR0LOGGER;
89
90
91/**
92 * Jump buffer for the setjmp/longjmp like constructs used to
93 * quickly 'call' back into Ring-3.
94 */
95typedef struct VMMR0JMPBUF
96{
97 /** Tranditional jmp_buf stuff
98 * @{ */
99#if HC_ARCH_BITS == 32
100 uint32_t ebx;
101 uint32_t esi;
102 uint32_t edi;
103 uint32_t ebp;
104 uint32_t esp;
105 uint32_t eip;
106 uint32_t u32Padding;
107#endif
108#if HC_ARCH_BITS == 64
109 uint64_t rbx;
110# ifdef RT_OS_WINDOWS
111 uint64_t rsi;
112 uint64_t rdi;
113# endif
114 uint64_t rbp;
115 uint64_t r12;
116 uint64_t r13;
117 uint64_t r14;
118 uint64_t r15;
119 uint64_t rsp;
120 uint64_t rip;
121#endif
122 /** @} */
123
124 /** Flag that indicates that we've done a ring-3 call. */
125 bool fInRing3Call;
126 /** The number of bytes we've saved. */
127 uint32_t cbSavedStack;
128 /** Pointer to the buffer used to save the stack.
129 * This is assumed to be 8KB. */
130 RTR0PTR pvSavedStack;
131 /** Esp we we match against esp on resume to make sure the stack wasn't relocated. */
132 RTHCUINTREG SpCheck;
133 /** The esp we should resume execution with after the restore. */
134 RTHCUINTREG SpResume;
135} VMMR0JMPBUF, *PVMMR0JMPBUF;
136
137
138/**
139 * VMM Data (part of VMM)
140 */
141typedef struct VMM
142{
143 /** Offset to the VM structure.
144 * See VMM2VM(). */
145 RTINT offVM;
146
147 /** Size of the core code. */
148 RTUINT cbCoreCode;
149 /** Physical address of core code. */
150 RTHCPHYS HCPhysCoreCode;
151/** @todo pvHCCoreCodeR3 -> pvCoreCodeR3, pvHCCoreCodeR0 -> pvCoreCodeR0 */
152 /** Pointer to core code ring-3 mapping - contiguous memory.
153 * At present this only means the context switcher code. */
154 RTR3PTR pvHCCoreCodeR3;
155 /** Pointer to core code ring-0 mapping - contiguous memory.
156 * At present this only means the context switcher code. */
157 RTR0PTR pvHCCoreCodeR0;
158 /** Pointer to core code guest context mapping. */
159 RTGCPTR pvGCCoreCode;
160#ifdef VBOX_WITH_NMI
161 /** The guest context address of the APIC (host) mapping. */
162 RTGCPTR GCPtrApicBase;
163 RTGCPTR pGCPadding0; /**< Alignment padding */
164#endif
165 /** The current switcher.
166 * This will be set before the VMM is fully initialized. */
167 VMMSWITCHER enmSwitcher;
168 /** Array of offsets to the different switchers within the core code. */
169 RTUINT aoffSwitchers[VMMSWITCHER_MAX];
170 /** Flag to disable the switcher permanently (VMX) (boolean) */
171 bool fSwitcherDisabled;
172
173 /** Host to guest switcher entry point. */
174 R0PTRTYPE(PFNVMMSWITCHERHC) pfnR0HostToGuest;
175 /** Guest to host switcher entry point. */
176 GCPTRTYPE(PFNVMMSWITCHERGC) pfnGCGuestToHost;
177 /** Call Trampoline. See vmmGCCallTrampoline(). */
178 RTGCPTR pfnGCCallTrampoline;
179
180 /** Resume Guest Execution. See CPUMGCResumeGuest(). */
181 RTGCPTR pfnCPUMGCResumeGuest;
182 /** Resume Guest Execution in V86 mode. See CPUMGCResumeGuestV86(). */
183 RTGCPTR pfnCPUMGCResumeGuestV86;
184 /** The last GC return code. */
185 RTINT iLastGCRc;
186#if HC_ARCH_BITS == 64 && GC_ARCH_BITS == 32
187 uint32_t u32Padding0; /**< Alignment padding. */
188#endif
189
190 /** VMM stack, pointer to the top of the stack in HC.
191 * Stack is allocated from the hypervisor heap and is page aligned
192 * and always writable in GC. */
193 HCPTRTYPE(uint8_t *) pbHCStack;
194 /** Pointer to the bottom of the stack - needed for doing relocations. */
195 GCPTRTYPE(uint8_t *) pbGCStack;
196 /** Pointer to the bottom of the stack - needed for doing relocations. */
197 GCPTRTYPE(uint8_t *) pbGCStackBottom;
198
199 /** Pointer to the GC logger instance - GC Ptr.
200 * This is NULL if logging is disabled. */
201 GCPTRTYPE(PRTLOGGERGC) pLoggerGC;
202 /** Size of the allocated logger instance (pLoggerGC/pLoggerHC). */
203 RTUINT cbLoggerGC;
204 /** Pointer to the GC logger instance - HC Ptr.
205 * This is NULL if logging is disabled. */
206 HCPTRTYPE(PRTLOGGERGC) pLoggerHC;
207
208 /** Pointer to the R0 logger instance.
209 * This is NULL if logging is disabled. */
210 HCPTRTYPE(PVMMR0LOGGER) pR0Logger;
211
212#ifdef VBOX_WITH_GC_AND_R0_RELEASE_LOG
213 /** Pointer to the GC release logger instance - GC Ptr. */
214 GCPTRTYPE(PRTLOGGERGC) pRelLoggerGC;
215 /** Size of the allocated release logger instance (pRelLoggerGC/pRelLoggerHC).
216 * This may differ from cbLoggerGC. */
217 RTUINT cbRelLoggerGC;
218 /** Pointer to the GC release logger instance - HC Ptr. */
219 HCPTRTYPE(PRTLOGGERGC) pRelLoggerHC;
220#endif /* VBOX_WITH_GC_AND_R0_RELEASE_LOG */
221
222 /** Global VM critical section. */
223 RTCRITSECT CritSectVMLock;
224
225 /** The EMT yield timer. */
226 PTMTIMERHC pYieldTimer;
227 /** The period to the next timeout when suspended or stopped.
228 * This is 0 when running. */
229 uint32_t cYieldResumeMillies;
230 /** The EMT yield timer interval (milliseconds). */
231 uint32_t cYieldEveryMillies;
232#if HC_ARCH_BITS == 32
233 uint32_t u32Padding0; /**< Alignment padding. */
234#endif
235 /** The timestamp of the previous yield. (nano) */
236 uint64_t u64LastYield;
237
238 /** @name CallHost
239 * @{ */
240 /** The pending operation. */
241 VMMCALLHOST enmCallHostOperation;
242 /** The result of the last operation. */
243 int32_t rcCallHost;
244 /** The argument to the operation. */
245 uint64_t u64CallHostArg;
246 /** The Ring-0 jmp buffer. */
247 VMMR0JMPBUF CallHostR0JmpBuf;
248 /** @} */
249
250 /** Number of VMMR0_DO_RUN_GC calls. */
251 STAMCOUNTER StatRunGC;
252 /** Statistics for each of the GC return codes.
253 * @{ */
254 STAMCOUNTER StatGCRetNormal;
255 STAMCOUNTER StatGCRetInterrupt;
256 STAMCOUNTER StatGCRetInterruptHyper;
257 STAMCOUNTER StatGCRetGuestTrap;
258 STAMCOUNTER StatGCRetRingSwitch;
259 STAMCOUNTER StatGCRetRingSwitchInt;
260 STAMCOUNTER StatGCRetExceptionPrivilege;
261 STAMCOUNTER StatGCRetStaleSelector;
262 STAMCOUNTER StatGCRetIRETTrap;
263 STAMCOUNTER StatGCRetEmulate;
264 STAMCOUNTER StatGCRetPatchEmulate;
265 STAMCOUNTER StatGCRetIORead;
266 STAMCOUNTER StatGCRetIOWrite;
267 STAMCOUNTER StatGCRetMMIORead;
268 STAMCOUNTER StatGCRetMMIOWrite;
269 STAMCOUNTER StatGCRetMMIOPatchRead;
270 STAMCOUNTER StatGCRetMMIOPatchWrite;
271 STAMCOUNTER StatGCRetMMIOReadWrite;
272 STAMCOUNTER StatGCRetLDTFault;
273 STAMCOUNTER StatGCRetGDTFault;
274 STAMCOUNTER StatGCRetIDTFault;
275 STAMCOUNTER StatGCRetTSSFault;
276 STAMCOUNTER StatGCRetPDFault;
277 STAMCOUNTER StatGCRetCSAMTask;
278 STAMCOUNTER StatGCRetSyncCR3;
279 STAMCOUNTER StatGCRetMisc;
280 STAMCOUNTER StatGCRetPatchInt3;
281 STAMCOUNTER StatGCRetPatchPF;
282 STAMCOUNTER StatGCRetPatchGP;
283 STAMCOUNTER StatGCRetPatchIretIRQ;
284 STAMCOUNTER StatGCRetPageOverflow;
285 STAMCOUNTER StatGCRetRescheduleREM;
286 STAMCOUNTER StatGCRetToR3;
287 STAMCOUNTER StatGCRetTimerPending;
288 STAMCOUNTER StatGCRetInterruptPending;
289 STAMCOUNTER StatGCRetCallHost;
290 STAMCOUNTER StatGCRetPATMDuplicateFn;
291 STAMCOUNTER StatGCRetPGMChangeMode;
292 STAMCOUNTER StatGCRetEmulHlt;
293 STAMCOUNTER StatGCRetPendingRequest;
294 STAMCOUNTER StatGCRetPGMGrowRAM;
295 STAMCOUNTER StatGCRetPDMLock;
296 STAMCOUNTER StatGCRetLogFlush;
297 STAMCOUNTER StatGCRetPDMQueueFlush;
298 STAMCOUNTER StatGCRetPGMPoolGrow;
299 STAMCOUNTER StatGCRetRemReplay;
300 STAMCOUNTER StatGCRetVMSetError;
301 STAMCOUNTER StatGCRetVMSetRuntimeError;
302 STAMCOUNTER StatGCRetPGMLock;
303
304 /** @} */
305
306
307} VMM, *PVMM;
308
309
310/**
311 * The VMMGCEntry() codes.
312 */
313typedef enum VMMGCOPERATION
314{
315 /** Do GC module init. */
316 VMMGC_DO_VMMGC_INIT = 1,
317
318 /** The first Trap testcase. */
319 VMMGC_DO_TESTCASE_TRAP_FIRST = 0x0dead000,
320 /** Trap 0 testcases, uArg selects the variation. */
321 VMMGC_DO_TESTCASE_TRAP_0 = VMMGC_DO_TESTCASE_TRAP_FIRST,
322 /** Trap 1 testcases, uArg selects the variation. */
323 VMMGC_DO_TESTCASE_TRAP_1,
324 /** Trap 2 testcases, uArg selects the variation. */
325 VMMGC_DO_TESTCASE_TRAP_2,
326 /** Trap 3 testcases, uArg selects the variation. */
327 VMMGC_DO_TESTCASE_TRAP_3,
328 /** Trap 4 testcases, uArg selects the variation. */
329 VMMGC_DO_TESTCASE_TRAP_4,
330 /** Trap 5 testcases, uArg selects the variation. */
331 VMMGC_DO_TESTCASE_TRAP_5,
332 /** Trap 6 testcases, uArg selects the variation. */
333 VMMGC_DO_TESTCASE_TRAP_6,
334 /** Trap 7 testcases, uArg selects the variation. */
335 VMMGC_DO_TESTCASE_TRAP_7,
336 /** Trap 8 testcases, uArg selects the variation. */
337 VMMGC_DO_TESTCASE_TRAP_8,
338 /** Trap 9 testcases, uArg selects the variation. */
339 VMMGC_DO_TESTCASE_TRAP_9,
340 /** Trap 0a testcases, uArg selects the variation. */
341 VMMGC_DO_TESTCASE_TRAP_0A,
342 /** Trap 0b testcases, uArg selects the variation. */
343 VMMGC_DO_TESTCASE_TRAP_0B,
344 /** Trap 0c testcases, uArg selects the variation. */
345 VMMGC_DO_TESTCASE_TRAP_0C,
346 /** Trap 0d testcases, uArg selects the variation. */
347 VMMGC_DO_TESTCASE_TRAP_0D,
348 /** Trap 0e testcases, uArg selects the variation. */
349 VMMGC_DO_TESTCASE_TRAP_0E,
350 /** The last trap testcase (exclusive). */
351 VMMGC_DO_TESTCASE_TRAP_LAST,
352 /** Testcase for checking interrupt forwarding. */
353 VMMGC_DO_TESTCASE_HYPER_INTERRUPT,
354 /** Switching testing and profiling stub. */
355 VMMGC_DO_TESTCASE_NOP,
356 /** Testcase for checking interrupt masking.. */
357 VMMGC_DO_TESTCASE_INTERRUPT_MASKING,
358 /** Switching testing and profiling stub. */
359 VMMGC_DO_TESTCASE_HWACCM_NOP,
360
361 /** The usual 32-bit hack. */
362 VMMGC_DO_32_BIT_HACK = 0x7fffffff
363} VMMGCOPERATION;
364
365
366__BEGIN_DECLS
367
368
369#ifdef IN_RING0
370/**
371 * World switcher assembly routine.
372 * It will call VMMGCEntry().
373 *
374 * @returns return code from VMMGCEntry().
375 * @param pVM The VM in question.
376 * @param uArg See VMMGCEntry().
377 * @internal
378 */
379DECLASM(int) vmmR0WorldSwitch(PVM pVM, unsigned uArg);
380
381/**
382 * Callback function for vmmR0CallHostSetJmp.
383 *
384 * @returns VBox status code.
385 * @param pVM The VM handle.
386 */
387typedef DECLCALLBACK(int) FNVMMR0SETJMP(PVM pVM);
388/** Pointer to FNVMMR0SETJMP(). */
389typedef FNVMMR0SETJMP *PFNVMMR0SETJMP;
390
391/**
392 * The setjmp variant used for calling Ring-3.
393 *
394 * This differs from the normal setjmp in that it will resume VMMR0CallHost if we're
395 * in the middle of a ring-3 call. Another differences is the function pointer and
396 * argument. This has to do with resuming code and the stack frame of the caller.
397 *
398 * @returns VINF_SUCCESS on success or whatever is passed to vmmR0CallHostLongJmp.
399 * @param pJmpBuf The jmp_buf to set.
400 * @param pfn The function to be called when not resuming..
401 * @param pVM The argument of that function.
402 */
403DECLASM(int) vmmR0CallHostSetJmp(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMP pfn, PVM pVM);
404
405/**
406 * Worker for VMMR0CallHost.
407 * This will save the stack and registers.
408 *
409 * @returns rc.
410 * @param pJmpBuf Pointer to the jump buffer.
411 * @param rc The return code.
412 */
413DECLASM(int) vmmR0CallHostLongJmp(PVMMR0JMPBUF pJmpBuf, int rc);
414
415/**
416 * Internal R0 logger worker: Logger wrapper.
417 */
418VMMR0DECL(void) vmmR0LoggerWrapper(const char *pszFormat, ...);
419
420/**
421 * Internal R0 logger worker: Flush logger.
422 *
423 * @param pLogger The logger instance to flush.
424 * @remark This function must be exported!
425 */
426VMMR0DECL(void) vmmR0LoggerFlush(PRTLOGGER pLogger);
427
428#endif /* IN_RING0 */
429
430
431#ifdef IN_GC
432/**
433 * Internal GC logger worker: Logger wrapper.
434 */
435VMMGCDECL(void) vmmGCLoggerWrapper(const char *pszFormat, ...);
436
437/**
438 * Internal GC release logger worker: Logger wrapper.
439 */
440VMMGCDECL(void) vmmGCRelLoggerWrapper(const char *pszFormat, ...);
441
442/**
443 * Internal GC logger worker: Flush logger.
444 *
445 * @returns VINF_SUCCESS.
446 * @param pLogger The logger instance to flush.
447 * @remark This function must be exported!
448 */
449VMMGCDECL(int) vmmGCLoggerFlush(PRTLOGGERGC pLogger);
450
451/** @name Trap testcases and related labels.
452 * @{ */
453DECLASM(void) vmmGCEnableWP(void);
454DECLASM(void) vmmGCDisableWP(void);
455DECLASM(int) vmmGCTestTrap3(void);
456DECLASM(int) vmmGCTestTrap8(void);
457DECLASM(int) vmmGCTestTrap0d(void);
458DECLASM(int) vmmGCTestTrap0e(void);
459DECLASM(int) vmmGCTestTrap0e_FaultEIP(void); /**< a label */
460DECLASM(int) vmmGCTestTrap0e_ResumeEIP(void); /**< a label */
461/** @} */
462
463#endif /* IN_GC */
464
465__END_DECLS
466
467/** @} */
468
469#endif
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