VirtualBox

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

Last change on this file since 552 was 271, checked in by vboxsync, 18 years ago

More stats
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 15.5 KB
Line 
1/* $Id: VMMInternal.h 271 2007-01-24 13:42:58Z vboxsync $ */
2/** @file
3 * VMM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2006 InnoTek Systemberatung 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 * If you received this file as part of a commercial VirtualBox
18 * distribution, then only the terms of your commercial VirtualBox
19 * license agreement apply instead of the previous paragraph.
20 */
21
22#ifndef __VMMInternal_h__
23#define __VMMInternal_h__
24
25#include <VBox/cdefs.h>
26#include <x86context.h>
27#include <VBox/stam.h>
28#include <VBox/log.h>
29#include <iprt/critsect.h>
30
31
32#if !defined(IN_VMM_R3) && !defined(IN_VMM_R0) && !defined(IN_VMM_GC)
33# error "Not in VMM! This is an internal header!"
34#endif
35
36
37/** @defgroup grp_vmm_int Internals
38 * @ingroup grp_vmm
39 * @internal
40 * @{
41 */
42
43/** @def VBOX_WITH_GC_AND_R0_RELEASE_LOG
44 * Enabled GC and R0 release logging (the latter is not implemented yet). */
45#define VBOX_WITH_GC_AND_R0_RELEASE_LOG
46
47
48/**
49 * Converts a VMM pointer into a VM pointer.
50 * @returns Pointer to the VM structure the VMM is part of.
51 * @param pVMM Pointer to VMM instance data.
52 */
53#define VMM2VM(pVMM) ( (PVM)((char*)pVMM - pVMM->offVM) )
54
55
56/**
57 * Switcher function, HC to GC.
58 *
59 * @param pVM The VM handle.
60 * @returns Return code indicating the action to take.
61 */
62typedef DECLASMTYPE(int) FNVMMSWITCHERHC(PVM pVM);
63/** Pointer to switcher function. */
64typedef FNVMMSWITCHERHC *PFNVMMSWITCHERHC;
65
66/**
67 * Switcher function, GC to HC.
68 *
69 * @param rc VBox status code.
70 */
71typedef DECLASMTYPE(void) FNVMMSWITCHERGC(int rc);
72/** Pointer to switcher function. */
73typedef FNVMMSWITCHERGC *PFNVMMSWITCHERGC;
74
75
76/**
77 * The ring-0 logger instance.
78 * We need to be able to find the VM handle from the logger instance.
79 */
80typedef struct VMMR0LOGGER
81{
82 /** Pointer to the VM handle. */
83 PVM pVM;
84 /** Size of the allocated logger instance (Logger). */
85 uint32_t cbLogger;
86 /** Flag indicating whether we've create the logger Ring-0 instance yet. */
87 bool fCreated;
88#if HC_ARCH_BITS == 32
89 uint32_t u32Alignment;
90#endif
91 /** The ring-0 logger instance. This extends beyon the size.*/
92 RTLOGGER Logger;
93} VMMR0LOGGER, *PVMMR0LOGGER;
94
95
96/**
97 * Jump buffer for the setjmp/longjmp like constructs used to
98 * quickly 'call' back into Ring-3.
99 */
100typedef struct VMMR0JMPBUF
101{
102 /** Tranditional jmp_buf stuff
103 * @{ */
104#if HC_ARCH_BITS == 32
105 uint32_t ebx;
106 uint32_t esi;
107 uint32_t edi;
108 uint32_t ebp;
109 uint32_t esp;
110 uint32_t eip;
111 uint32_t u32Padding;
112#endif
113#if HC_ARCH_BITS == 64
114 uint64_t rbx;
115# ifdef __WIN__
116 uint64_t rsi;
117 uint64_t rdi;
118# endif
119 uint64_t rbp;
120 uint64_t r12;
121 uint64_t r13;
122 uint64_t r14;
123 uint64_t r15;
124 uint64_t rsp;
125 uint64_t rip;
126#endif
127 /** @} */
128
129 /** Flag that indicates that we've done a ring-3 call. */
130 bool fInRing3Call;
131 /** The number of bytes we've saved. */
132 uint32_t cbSavedStack;
133 /** Pointer to the buffer used to save the stack.
134 * This is assumed to be 8KB. */
135 RTR0PTR pvSavedStack;
136 /** Esp we we match against esp on resume to make sure the stack wasn't relocated. */
137 RTHCUINTREG SpCheck;
138 /** The esp we should resume execution with after the restore. */
139 RTHCUINTREG SpResume;
140} VMMR0JMPBUF, *PVMMR0JMPBUF;
141
142
143/**
144 * VMM Data (part of VMM)
145 */
146typedef struct VMM
147{
148 /** Offset to the VM structure.
149 * See VMM2VM(). */
150 RTINT offVM;
151
152 /** Size of the core code. */
153 RTUINT cbCoreCode;
154 /** Physical address of core code. */
155 RTHCPHYS HCPhysCoreCode;
156/** @todo pvHCCoreCodeR3 -> pvCoreCodeR3, pvHCCoreCodeR0 -> pvCoreCodeR0 */
157 /** Pointer to core code ring-3 mapping - contiguous memory.
158 * At present this only means the context switcher code. */
159 RTHCPTR pvHCCoreCodeR3;
160 /** Pointer to core code ring-0 mapping - contiguous memory.
161 * At present this only means the context switcher code. */
162 RTHCPTR pvHCCoreCodeR0;
163 /** Pointer to core code guest context mapping. */
164 RTGCPTR pvGCCoreCode;
165#ifdef VBOX_WITH_NMI
166 /** The guest context address of the APIC (host) mapping. */
167 RTGCPTR GCPtrApicBase;
168 RTGCPTR pGCPadding0; /**< Alignment padding */
169#endif
170 /** The current switcher.
171 * This will be set before the VMM is fully initialized. */
172 VMMSWITCHER enmSwitcher;
173 /** Array of offsets to the different switchers within the core code. */
174 RTUINT aoffSwitchers[VMMSWITCHER_MAX];
175 /** Flag to disable the switcher permanently (VMX) (boolean) */
176 bool fSwitcherDisabled;
177
178 /** Host to guest switcher entry point. */
179 R0PTRTYPE(PFNVMMSWITCHERHC) pfnR0HostToGuest;
180 /** Guest to host switcher entry point. */
181 GCPTRTYPE(PFNVMMSWITCHERGC) pfnGCGuestToHost;
182 /** Call Trampoline. See vmmGCCallTrampoline(). */
183 RTGCPTR pfnGCCallTrampoline;
184
185 /** Resume Guest Execution. See CPUMGCResumeGuest(). */
186 RTGCPTR pfnCPUMGCResumeGuest;
187 /** Resume Guest Execution in V86 mode. See CPUMGCResumeGuestV86(). */
188 RTGCPTR pfnCPUMGCResumeGuestV86;
189 /** The last GC return code. */
190 RTINT iLastGCRc;
191#if HC_ARCH_BITS == 64 && GC_ARCH_BITS == 32
192 uint32_t u32Padding0; /**< Alignment padding. */
193#endif
194
195 /** VMM stack, pointer to the top of the stack in HC.
196 * Stack is allocated from the hypervisor heap and is page aligned
197 * and always writable in GC. */
198 HCPTRTYPE(uint8_t *) pbHCStack;
199 /** Pointer to the bottom of the stack - needed for doing relocations. */
200 GCPTRTYPE(uint8_t *) pbGCStack;
201 /** Pointer to the bottom of the stack - needed for doing relocations. */
202 GCPTRTYPE(uint8_t *) pbGCStackBottom;
203
204 /** Pointer to the GC logger instance - GC Ptr.
205 * This is NULL if logging is disabled. */
206 GCPTRTYPE(PRTLOGGERGC) pLoggerGC;
207 /** Size of the allocated logger instance (pLoggerGC/pLoggerHC). */
208 RTUINT cbLoggerGC;
209 /** Pointer to the GC logger instance - HC Ptr.
210 * This is NULL if logging is disabled. */
211 HCPTRTYPE(PRTLOGGERGC) pLoggerHC;
212
213 /** Pointer to the R0 logger instance.
214 * This is NULL if logging is disabled. */
215 HCPTRTYPE(PVMMR0LOGGER) pR0Logger;
216
217#ifdef VBOX_WITH_GC_AND_R0_RELEASE_LOG
218 /** Pointer to the GC release logger instance - GC Ptr. */
219 GCPTRTYPE(PRTLOGGERGC) pRelLoggerGC;
220 /** Size of the allocated release logger instance (pRelLoggerGC/pRelLoggerHC).
221 * This may differ from cbLoggerGC. */
222 RTUINT cbRelLoggerGC;
223 /** Pointer to the GC release logger instance - HC Ptr. */
224 HCPTRTYPE(PRTLOGGERGC) pRelLoggerHC;
225#endif /* VBOX_WITH_GC_AND_R0_RELEASE_LOG */
226
227 /** Global VM critical section. */
228 RTCRITSECT CritSectVMLock;
229
230 /** The EMT yield timer. */
231 PTMTIMERHC pYieldTimer;
232 /** The period to the next timeout when suspended or stopped.
233 * This is 0 when running. */
234 uint32_t cYieldResumeMillies;
235 /** The EMT yield timer interval (milliseconds). */
236 uint32_t cYieldEveryMillies;
237#if HC_ARCH_BITS == 32
238 uint32_t u32Padding0; /**< Alignment padding. */
239#endif
240
241 /** @name CallHost
242 * @{ */
243 /** The pending operation. */
244 VMMCALLHOST enmCallHostOperation;
245 /** The result of the last operation. */
246 int32_t rcCallHost;
247 /** The argument to the operation. */
248 uint64_t u64CallHostArg;
249 /** The Ring-0 jmp buffer. */
250 VMMR0JMPBUF CallHostR0JmpBuf;
251 /** @} */
252
253 /** Number of VMMR0_DO_RUN_GC calls. */
254 STAMCOUNTER StatRunGC;
255 /** Statistics for each of the GC return codes.
256 * @{ */
257 STAMCOUNTER StatGCRetNormal;
258 STAMCOUNTER StatGCRetInterrupt;
259 STAMCOUNTER StatGCRetInterruptHyper;
260 STAMCOUNTER StatGCRetGuestTrap;
261 STAMCOUNTER StatGCRetRingSwitch;
262 STAMCOUNTER StatGCRetRingSwitchInt;
263 STAMCOUNTER StatGCRetExceptionPrivilege;
264 STAMCOUNTER StatGCRetStaleSelector;
265 STAMCOUNTER StatGCRetIRETTrap;
266 STAMCOUNTER StatGCRetEmulate;
267 STAMCOUNTER StatGCRetPatchEmulate;
268 STAMCOUNTER StatGCRetIORead;
269 STAMCOUNTER StatGCRetIOWrite;
270 STAMCOUNTER StatGCRetIOReadWrite;
271 STAMCOUNTER StatGCRetMMIORead;
272 STAMCOUNTER StatGCRetMMIOWrite;
273 STAMCOUNTER StatGCRetMMIOPatchRead;
274 STAMCOUNTER StatGCRetMMIOPatchWrite;
275 STAMCOUNTER StatGCRetMMIOReadWrite;
276 STAMCOUNTER StatGCRetLDTFault;
277 STAMCOUNTER StatGCRetGDTFault;
278 STAMCOUNTER StatGCRetIDTFault;
279 STAMCOUNTER StatGCRetTSSFault;
280 STAMCOUNTER StatGCRetPDFault;
281 STAMCOUNTER StatGCRetCSAMTask;
282 STAMCOUNTER StatGCRetSyncCR3;
283 STAMCOUNTER StatGCRetMisc;
284 STAMCOUNTER StatGCRetPatchInt3;
285 STAMCOUNTER StatGCRetPatchPF;
286 STAMCOUNTER StatGCRetPatchGP;
287 STAMCOUNTER StatGCRetPatchIretIRQ;
288 STAMCOUNTER StatGCRetPageOverflow;
289 STAMCOUNTER StatGCRetRescheduleREM;
290 STAMCOUNTER StatGCRetToR3;
291 STAMCOUNTER StatGCRetTimerPending;
292 STAMCOUNTER StatGCRetInterruptPending;
293 STAMCOUNTER StatGCRetCallHost;
294 STAMCOUNTER StatGCRetPATMDuplicateFn;
295 STAMCOUNTER StatGCRetPGMChangeMode;
296 STAMCOUNTER StatGCRetEmulHlt;
297 STAMCOUNTER StatGCRetPendingRequest;
298 STAMCOUNTER StatGCRetPGMGrowRAM;
299 STAMCOUNTER StatGCRetPDMLock;
300 STAMCOUNTER StatGCRetLogFlush;
301 STAMCOUNTER StatGCRetPDMQueueFlush;
302 STAMCOUNTER StatGCRetPGMPoolGrow;
303 STAMCOUNTER StatGCRetRemReplay;
304 STAMCOUNTER StatGCRetVMSetError;
305 STAMCOUNTER StatGCRetVMSetRuntimeError;
306 STAMCOUNTER StatGCRetPGMLock;
307
308 /** @} */
309
310
311} VMM, *PVMM;
312
313
314/**
315 * The VMMGCEntry() codes.
316 */
317typedef enum VMMGCOPERATION
318{
319 /** Do GC module init. */
320 VMMGC_DO_VMMGC_INIT = 1,
321
322 /** The first Trap testcase. */
323 VMMGC_DO_TESTCASE_TRAP_FIRST = 0x0dead000,
324 /** Trap 0 testcases, uArg selects the variation. */
325 VMMGC_DO_TESTCASE_TRAP_0 = VMMGC_DO_TESTCASE_TRAP_FIRST,
326 /** Trap 1 testcases, uArg selects the variation. */
327 VMMGC_DO_TESTCASE_TRAP_1,
328 /** Trap 2 testcases, uArg selects the variation. */
329 VMMGC_DO_TESTCASE_TRAP_2,
330 /** Trap 3 testcases, uArg selects the variation. */
331 VMMGC_DO_TESTCASE_TRAP_3,
332 /** Trap 4 testcases, uArg selects the variation. */
333 VMMGC_DO_TESTCASE_TRAP_4,
334 /** Trap 5 testcases, uArg selects the variation. */
335 VMMGC_DO_TESTCASE_TRAP_5,
336 /** Trap 6 testcases, uArg selects the variation. */
337 VMMGC_DO_TESTCASE_TRAP_6,
338 /** Trap 7 testcases, uArg selects the variation. */
339 VMMGC_DO_TESTCASE_TRAP_7,
340 /** Trap 8 testcases, uArg selects the variation. */
341 VMMGC_DO_TESTCASE_TRAP_8,
342 /** Trap 9 testcases, uArg selects the variation. */
343 VMMGC_DO_TESTCASE_TRAP_9,
344 /** Trap 0a testcases, uArg selects the variation. */
345 VMMGC_DO_TESTCASE_TRAP_0A,
346 /** Trap 0b testcases, uArg selects the variation. */
347 VMMGC_DO_TESTCASE_TRAP_0B,
348 /** Trap 0c testcases, uArg selects the variation. */
349 VMMGC_DO_TESTCASE_TRAP_0C,
350 /** Trap 0d testcases, uArg selects the variation. */
351 VMMGC_DO_TESTCASE_TRAP_0D,
352 /** Trap 0e testcases, uArg selects the variation. */
353 VMMGC_DO_TESTCASE_TRAP_0E,
354 /** The last trap testcase (exclusive). */
355 VMMGC_DO_TESTCASE_TRAP_LAST,
356 /** Testcase for checking interrupt forwarding. */
357 VMMGC_DO_TESTCASE_HYPER_INTERRUPT,
358 /** Switching testing and profiling stub. */
359 VMMGC_DO_TESTCASE_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
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);
459/** @} */
460
461#endif /* IN_GC */
462
463__END_DECLS
464
465/** @} */
466
467#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