VirtualBox

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

Last change on this file since 14672 was 14176, checked in by vboxsync, 16 years ago

sigh.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 18.6 KB
Line 
1/* $Id: VMMInternal.h 14176 2008-11-13 13:35:36Z vboxsync $ */
2/** @file
3 * VMM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22#ifndef ___VMMInternal_h
23#define ___VMMInternal_h
24
25#include <VBox/cdefs.h>
26#include <VBox/stam.h>
27#include <VBox/log.h>
28#include <iprt/critsect.h>
29
30
31#if !defined(IN_VMM_R3) && !defined(IN_VMM_R0) && !defined(IN_VMM_RC)
32# error "Not in VMM! This is an internal header!"
33#endif
34
35
36/** @defgroup grp_vmm_int Internals
37 * @ingroup grp_vmm
38 * @internal
39 * @{
40 */
41
42/** @def VBOX_WITH_RC_RELEASE_LOGGING
43 * Enables RC release logging. */
44#define VBOX_WITH_RC_RELEASE_LOGGING
45
46/** @def VBOX_WITH_R0_LOGGING
47 * Enables Ring-0 logging (non-release).
48 *
49 * Ring-0 logging isn't 100% safe yet (thread id reuse / process exit cleanup),
50 * so you have to sign up here by adding your defined(DEBUG_<userid>) to the
51 * #if, or by adding VBOX_WITH_R0_LOGGING to your LocalConfig.kmk.
52 *
53 * You might also wish to enable the AssertMsg1/2 overrides in VMMR0.cpp when
54 * enabling this.
55 */
56#if defined(DEBUG_sandervl) || defined(DEBUG_frank) || defined(DOXYGEN_RUNNING)
57# define VBOX_WITH_R0_LOGGING
58#endif
59
60
61/**
62 * Converts a VMM pointer into a VM pointer.
63 * @returns Pointer to the VM structure the VMM is part of.
64 * @param pVMM Pointer to VMM instance data.
65 */
66#define VMM2VM(pVMM) ( (PVM)((char*)pVMM - pVMM->offVM) )
67
68
69/**
70 * Switcher function, HC to RC.
71 *
72 * @param pVM The VM handle.
73 * @returns Return code indicating the action to take.
74 */
75typedef DECLASMTYPE(int) FNVMMSWITCHERHC(PVM pVM);
76/** Pointer to switcher function. */
77typedef FNVMMSWITCHERHC *PFNVMMSWITCHERHC;
78
79/**
80 * Switcher function, RC to HC.
81 *
82 * @param rc VBox status code.
83 */
84typedef DECLASMTYPE(void) FNVMMSWITCHERRC(int rc);
85/** Pointer to switcher function. */
86typedef FNVMMSWITCHERRC *PFNVMMSWITCHERRC;
87
88
89/**
90 * The ring-0 logger instance wrapper.
91 *
92 * We need to be able to find the VM handle from the logger instance, so we wrap
93 * it in this structure.
94 */
95typedef struct VMMR0LOGGER
96{
97 /** Pointer to the VM handle. */
98 R0PTRTYPE(PVM) pVM;
99 /** Size of the allocated logger instance (Logger). */
100 uint32_t cbLogger;
101 /** Flag indicating whether we've create the logger Ring-0 instance yet. */
102 bool fCreated;
103#if HC_ARCH_BITS == 32
104 uint32_t u32Alignment;
105#endif
106 /** The ring-0 logger instance. This extends beyond the size. */
107 RTLOGGER Logger;
108} VMMR0LOGGER;
109/** Pointer to a ring-0 logger instance wrapper. */
110typedef VMMR0LOGGER *PVMMR0LOGGER;
111
112
113/**
114 * Jump buffer for the setjmp/longjmp like constructs used to
115 * quickly 'call' back into Ring-3.
116 */
117typedef struct VMMR0JMPBUF
118{
119 /** Traditional jmp_buf stuff
120 * @{ */
121#if HC_ARCH_BITS == 32
122 uint32_t ebx;
123 uint32_t esi;
124 uint32_t edi;
125 uint32_t ebp;
126 uint32_t esp;
127 uint32_t eip;
128 uint32_t u32Padding;
129#endif
130#if HC_ARCH_BITS == 64
131 uint64_t rbx;
132# ifdef RT_OS_WINDOWS
133 uint64_t rsi;
134 uint64_t rdi;
135# endif
136 uint64_t rbp;
137 uint64_t r12;
138 uint64_t r13;
139 uint64_t r14;
140 uint64_t r15;
141 uint64_t rsp;
142 uint64_t rip;
143#endif
144 /** @} */
145
146 /** Flag that indicates that we've done a ring-3 call. */
147 bool fInRing3Call;
148 /** The number of bytes we've saved. */
149 uint32_t cbSavedStack;
150 /** Pointer to the buffer used to save the stack.
151 * This is assumed to be 8KB. */
152 RTR0PTR pvSavedStack;
153 /** Esp we we match against esp on resume to make sure the stack wasn't relocated. */
154 RTHCUINTREG SpCheck;
155 /** The esp we should resume execution with after the restore. */
156 RTHCUINTREG SpResume;
157} VMMR0JMPBUF;
158/** Pointer to a ring-0 jump buffer. */
159typedef VMMR0JMPBUF *PVMMR0JMPBUF;
160
161
162/**
163 * VMM Data (part of VM)
164 */
165typedef struct VMM
166{
167 /** Offset to the VM structure.
168 * See VMM2VM(). */
169 RTINT offVM;
170
171 /** @name World Switcher and Related
172 * @{
173 */
174 /** Size of the core code. */
175 RTUINT cbCoreCode;
176 /** Physical address of core code. */
177 RTHCPHYS HCPhysCoreCode;
178 /** Pointer to core code ring-3 mapping - contiguous memory.
179 * At present this only means the context switcher code. */
180 RTR3PTR pvCoreCodeR3;
181 /** Pointer to core code ring-0 mapping - contiguous memory.
182 * At present this only means the context switcher code. */
183 RTR0PTR pvCoreCodeR0;
184 /** Pointer to core code guest context mapping. */
185 RTRCPTR pvCoreCodeRC;
186 RTRCPTR pRCPadding0; /**< Alignment padding */
187#ifdef VBOX_WITH_NMI
188 /** The guest context address of the APIC (host) mapping. */
189 RTRCPTR GCPtrApicBase;
190 RTRCPTR pRCPadding1; /**< Alignment padding */
191#endif
192 /** The current switcher.
193 * This will be set before the VMM is fully initialized. */
194 VMMSWITCHER enmSwitcher;
195 /** Flag to disable the switcher permanently (VMX) (boolean) */
196 bool fSwitcherDisabled;
197 /** Array of offsets to the different switchers within the core code. */
198 RTUINT aoffSwitchers[VMMSWITCHER_MAX];
199 uint32_t u32Padding0; /**< Alignment padding. */
200
201 /** The last RC/R0 return code. */
202 RTINT iLastGZRc;
203 /** Resume Guest Execution. See CPUMGCResumeGuest(). */
204 RTRCPTR pfnCPUMRCResumeGuest;
205 /** Resume Guest Execution in V86 mode. See CPUMGCResumeGuestV86(). */
206 RTRCPTR pfnCPUMRCResumeGuestV86;
207 /** Call Trampoline. See vmmGCCallTrampoline(). */
208 RTRCPTR pfnCallTrampolineRC;
209 /** Guest to host switcher entry point. */
210 RCPTRTYPE(PFNVMMSWITCHERRC) pfnGuestToHostRC;
211 /** Host to guest switcher entry point. */
212 R0PTRTYPE(PFNVMMSWITCHERHC) pfnHostToGuestR0;
213 /** @} */
214
215 /** VMM stack, pointer to the top of the stack in R3.
216 * Stack is allocated from the hypervisor heap and is page aligned
217 * and always writable in RC. */
218 R3PTRTYPE(uint8_t *) pbEMTStackR3;
219 /** Pointer to the bottom of the stack - needed for doing relocations. */
220 RCPTRTYPE(uint8_t *) pbEMTStackRC;
221 /** Pointer to the bottom of the stack - needed for doing relocations. */
222 RCPTRTYPE(uint8_t *) pbEMTStackBottomRC;
223
224 /** @name Logging
225 * @{
226 */
227 /** Size of the allocated logger instance (pRCLoggerRC/pRCLoggerR3). */
228 uint32_t cbRCLogger;
229 /** Pointer to the RC logger instance - RC Ptr.
230 * This is NULL if logging is disabled. */
231 RCPTRTYPE(PRTLOGGERRC) pRCLoggerRC;
232 /** Pointer to the GC logger instance - R3 Ptr.
233 * This is NULL if logging is disabled. */
234 R3PTRTYPE(PRTLOGGERRC) pRCLoggerR3;
235 /** Pointer to the R0 logger instance - R3 Ptr.
236 * This is NULL if logging is disabled. */
237 R3PTRTYPE(PVMMR0LOGGER) pR0LoggerR3;
238 /** Pointer to the R0 logger instance - R0 Ptr.
239 * This is NULL if logging is disabled. */
240 R0PTRTYPE(PVMMR0LOGGER) pR0LoggerR0;
241 /** Pointer to the GC release logger instance - R3 Ptr. */
242 R3PTRTYPE(PRTLOGGERRC) pRCRelLoggerR3;
243 /** Pointer to the GC release logger instance - RC Ptr. */
244 RCPTRTYPE(PRTLOGGERRC) pRCRelLoggerRC;
245 /** Size of the allocated release logger instance (pRCRelLoggerRC/pRCRelLoggerR3).
246 * This may differ from cbRCLogger. */
247 uint32_t cbRCRelLogger;
248 /** @} */
249
250
251 /** Global VM critical section. */
252 RTCRITSECT CritSectVMLock;
253
254 /** The EMT yield timer. */
255 PTMTIMERR3 pYieldTimer;
256 /** The period to the next timeout when suspended or stopped.
257 * This is 0 when running. */
258 uint32_t cYieldResumeMillies;
259 /** The EMT yield timer interval (milliseconds). */
260 uint32_t cYieldEveryMillies;
261#if HC_ARCH_BITS == 32
262 RTR3PTR pR3Padding1; /**< Alignment padding. */
263#endif
264 /** The timestamp of the previous yield. (nano) */
265 uint64_t u64LastYield;
266
267 /** @name CallHost
268 * @todo SMP: per vCPU
269 * @{ */
270 /** The pending operation. */
271 VMMCALLHOST enmCallHostOperation;
272 /** The result of the last operation. */
273 int32_t rcCallHost;
274 /** The argument to the operation. */
275 uint64_t u64CallHostArg;
276 /** The Ring-0 jmp buffer. */
277 VMMR0JMPBUF CallHostR0JmpBuf;
278 /** @} */
279
280 /** Buffer for storing the standard assertion message for a ring-0 assertion.
281 * Used for saving the assertion message text for the release log and guru
282 * meditation dump. */
283 char szRing0AssertMsg1[256];
284 /** Buffer for storing the custom message for a ring-0 assertion. */
285 char szRing0AssertMsg2[256];
286
287 /** Number of VMMR0_DO_RUN_GC calls. */
288 STAMCOUNTER StatRunRC;
289
290 /** Statistics for each of the RC/R0 return codes.
291 * @{ */
292 STAMCOUNTER StatRZRetNormal;
293 STAMCOUNTER StatRZRetInterrupt;
294 STAMCOUNTER StatRZRetInterruptHyper;
295 STAMCOUNTER StatRZRetGuestTrap;
296 STAMCOUNTER StatRZRetRingSwitch;
297 STAMCOUNTER StatRZRetRingSwitchInt;
298 STAMCOUNTER StatRZRetExceptionPrivilege;
299 STAMCOUNTER StatRZRetStaleSelector;
300 STAMCOUNTER StatRZRetIRETTrap;
301 STAMCOUNTER StatRZRetEmulate;
302 STAMCOUNTER StatRZRetPatchEmulate;
303 STAMCOUNTER StatRZRetIORead;
304 STAMCOUNTER StatRZRetIOWrite;
305 STAMCOUNTER StatRZRetMMIORead;
306 STAMCOUNTER StatRZRetMMIOWrite;
307 STAMCOUNTER StatRZRetMMIOPatchRead;
308 STAMCOUNTER StatRZRetMMIOPatchWrite;
309 STAMCOUNTER StatRZRetMMIOReadWrite;
310 STAMCOUNTER StatRZRetLDTFault;
311 STAMCOUNTER StatRZRetGDTFault;
312 STAMCOUNTER StatRZRetIDTFault;
313 STAMCOUNTER StatRZRetTSSFault;
314 STAMCOUNTER StatRZRetPDFault;
315 STAMCOUNTER StatRZRetCSAMTask;
316 STAMCOUNTER StatRZRetSyncCR3;
317 STAMCOUNTER StatRZRetMisc;
318 STAMCOUNTER StatRZRetPatchInt3;
319 STAMCOUNTER StatRZRetPatchPF;
320 STAMCOUNTER StatRZRetPatchGP;
321 STAMCOUNTER StatRZRetPatchIretIRQ;
322 STAMCOUNTER StatRZRetPageOverflow;
323 STAMCOUNTER StatRZRetRescheduleREM;
324 STAMCOUNTER StatRZRetToR3;
325 STAMCOUNTER StatRZRetTimerPending;
326 STAMCOUNTER StatRZRetInterruptPending;
327 STAMCOUNTER StatRZRetCallHost;
328 STAMCOUNTER StatRZRetPATMDuplicateFn;
329 STAMCOUNTER StatRZRetPGMChangeMode;
330 STAMCOUNTER StatRZRetEmulHlt;
331 STAMCOUNTER StatRZRetPendingRequest;
332#ifndef VBOX_WITH_NEW_PHYS_CODE
333 STAMCOUNTER StatRZCallPGMGrowRAM;
334#endif
335 STAMCOUNTER StatRZCallPDMLock;
336 STAMCOUNTER StatRZCallLogFlush;
337 STAMCOUNTER StatRZCallPDMQueueFlush;
338 STAMCOUNTER StatRZCallPGMPoolGrow;
339 STAMCOUNTER StatRZCallPGMMapChunk;
340 STAMCOUNTER StatRZCallPGMAllocHandy;
341 STAMCOUNTER StatRZCallRemReplay;
342 STAMCOUNTER StatRZCallVMSetError;
343 STAMCOUNTER StatRZCallVMSetRuntimeError;
344 STAMCOUNTER StatRZCallPGMLock;
345 /** @} */
346} VMM;
347/** Pointer to VMM. */
348typedef VMM *PVMM;
349
350
351/**
352 * VMMCPU Data (part of VMCPU)
353 */
354typedef struct VMMCPU
355{
356 /** Offset to the VMCPU structure.
357 * See VMM2VMCPU(). */
358 RTINT offVMCPU;
359} VMMCPU;
360/** Pointer to VMMCPU. */
361typedef VMMCPU *PVMMCPU;
362
363
364/**
365 * The VMMGCEntry() codes.
366 */
367typedef enum VMMGCOPERATION
368{
369 /** Do GC module init. */
370 VMMGC_DO_VMMGC_INIT = 1,
371
372 /** The first Trap testcase. */
373 VMMGC_DO_TESTCASE_TRAP_FIRST = 0x0dead000,
374 /** Trap 0 testcases, uArg selects the variation. */
375 VMMGC_DO_TESTCASE_TRAP_0 = VMMGC_DO_TESTCASE_TRAP_FIRST,
376 /** Trap 1 testcases, uArg selects the variation. */
377 VMMGC_DO_TESTCASE_TRAP_1,
378 /** Trap 2 testcases, uArg selects the variation. */
379 VMMGC_DO_TESTCASE_TRAP_2,
380 /** Trap 3 testcases, uArg selects the variation. */
381 VMMGC_DO_TESTCASE_TRAP_3,
382 /** Trap 4 testcases, uArg selects the variation. */
383 VMMGC_DO_TESTCASE_TRAP_4,
384 /** Trap 5 testcases, uArg selects the variation. */
385 VMMGC_DO_TESTCASE_TRAP_5,
386 /** Trap 6 testcases, uArg selects the variation. */
387 VMMGC_DO_TESTCASE_TRAP_6,
388 /** Trap 7 testcases, uArg selects the variation. */
389 VMMGC_DO_TESTCASE_TRAP_7,
390 /** Trap 8 testcases, uArg selects the variation. */
391 VMMGC_DO_TESTCASE_TRAP_8,
392 /** Trap 9 testcases, uArg selects the variation. */
393 VMMGC_DO_TESTCASE_TRAP_9,
394 /** Trap 0a testcases, uArg selects the variation. */
395 VMMGC_DO_TESTCASE_TRAP_0A,
396 /** Trap 0b testcases, uArg selects the variation. */
397 VMMGC_DO_TESTCASE_TRAP_0B,
398 /** Trap 0c testcases, uArg selects the variation. */
399 VMMGC_DO_TESTCASE_TRAP_0C,
400 /** Trap 0d testcases, uArg selects the variation. */
401 VMMGC_DO_TESTCASE_TRAP_0D,
402 /** Trap 0e testcases, uArg selects the variation. */
403 VMMGC_DO_TESTCASE_TRAP_0E,
404 /** The last trap testcase (exclusive). */
405 VMMGC_DO_TESTCASE_TRAP_LAST,
406 /** Testcase for checking interrupt forwarding. */
407 VMMGC_DO_TESTCASE_HYPER_INTERRUPT,
408 /** Switching testing and profiling stub. */
409 VMMGC_DO_TESTCASE_NOP,
410 /** Testcase for checking interrupt masking.. */
411 VMMGC_DO_TESTCASE_INTERRUPT_MASKING,
412 /** Switching testing and profiling stub. */
413 VMMGC_DO_TESTCASE_HWACCM_NOP,
414
415 /** The usual 32-bit hack. */
416 VMMGC_DO_32_BIT_HACK = 0x7fffffff
417} VMMGCOPERATION;
418
419
420__BEGIN_DECLS
421
422#ifdef IN_RING3
423int vmmR3SwitcherInit(PVM pVM);
424void vmmR3SwitcherRelocate(PVM pVM, RTGCINTPTR offDelta);
425#endif /* IN_RING3 */
426
427#ifdef IN_RING0
428/**
429 * World switcher assembly routine.
430 * It will call VMMGCEntry().
431 *
432 * @returns return code from VMMGCEntry().
433 * @param pVM The VM in question.
434 * @param uArg See VMMGCEntry().
435 * @internal
436 */
437DECLASM(int) vmmR0WorldSwitch(PVM pVM, unsigned uArg);
438
439/**
440 * Callback function for vmmR0CallHostSetJmp.
441 *
442 * @returns VBox status code.
443 * @param pVM The VM handle.
444 */
445typedef DECLCALLBACK(int) FNVMMR0SETJMP(PVM pVM, PVMCPU pVCpu);
446/** Pointer to FNVMMR0SETJMP(). */
447typedef FNVMMR0SETJMP *PFNVMMR0SETJMP;
448
449/**
450 * The setjmp variant used for calling Ring-3.
451 *
452 * This differs from the normal setjmp in that it will resume VMMR0CallHost if we're
453 * in the middle of a ring-3 call. Another differences is the function pointer and
454 * argument. This has to do with resuming code and the stack frame of the caller.
455 *
456 * @returns VINF_SUCCESS on success or whatever is passed to vmmR0CallHostLongJmp.
457 * @param pJmpBuf The jmp_buf to set.
458 * @param pfn The function to be called when not resuming..
459 * @param pVM The argument of that function.
460 */
461DECLASM(int) vmmR0CallHostSetJmp(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMP pfn, PVM pVM, PVMCPU pVCpu);
462
463/**
464 * Callback function for vmmR0CallHostSetJmpEx.
465 *
466 * @returns VBox status code.
467 * @param pvUser The user argument.
468 */
469typedef DECLCALLBACK(int) FNVMMR0SETJMPEX(void *pvUser);
470/** Pointer to FNVMMR0SETJMP(). */
471typedef FNVMMR0SETJMPEX *PFNVMMR0SETJMPEX;
472
473/**
474 * Same as vmmR0CallHostSetJmp except for the function signature.
475 *
476 * @returns VINF_SUCCESS on success or whatever is passed to vmmR0CallHostLongJmp.
477 * @param pJmpBuf The jmp_buf to set.
478 * @param pfn The function to be called when not resuming..
479 * @param pvUser The argument of that function.
480 */
481DECLASM(int) vmmR0CallHostSetJmpEx(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMPEX pfn, void *pvUser);
482
483
484/**
485 * Worker for VMMR0CallHost.
486 * This will save the stack and registers.
487 *
488 * @returns rc.
489 * @param pJmpBuf Pointer to the jump buffer.
490 * @param rc The return code.
491 */
492DECLASM(int) vmmR0CallHostLongJmp(PVMMR0JMPBUF pJmpBuf, int rc);
493
494/**
495 * Internal R0 logger worker: Logger wrapper.
496 */
497VMMR0DECL(void) vmmR0LoggerWrapper(const char *pszFormat, ...);
498
499/**
500 * Internal R0 logger worker: Flush logger.
501 *
502 * @param pLogger The logger instance to flush.
503 * @remark This function must be exported!
504 */
505VMMR0DECL(void) vmmR0LoggerFlush(PRTLOGGER pLogger);
506
507#endif /* IN_RING0 */
508#ifdef IN_RC
509
510/**
511 * Internal GC logger worker: Logger wrapper.
512 */
513VMMRCDECL(void) vmmGCLoggerWrapper(const char *pszFormat, ...);
514
515/**
516 * Internal GC release logger worker: Logger wrapper.
517 */
518VMMRCDECL(void) vmmGCRelLoggerWrapper(const char *pszFormat, ...);
519
520/**
521 * Internal GC logger worker: Flush logger.
522 *
523 * @returns VINF_SUCCESS.
524 * @param pLogger The logger instance to flush.
525 * @remark This function must be exported!
526 */
527VMMRCDECL(int) vmmGCLoggerFlush(PRTLOGGERRC pLogger);
528
529/** @name Trap testcases and related labels.
530 * @{ */
531DECLASM(void) vmmGCEnableWP(void);
532DECLASM(void) vmmGCDisableWP(void);
533DECLASM(int) vmmGCTestTrap3(void);
534DECLASM(int) vmmGCTestTrap8(void);
535DECLASM(int) vmmGCTestTrap0d(void);
536DECLASM(int) vmmGCTestTrap0e(void);
537DECLASM(int) vmmGCTestTrap0e_FaultEIP(void); /**< a label */
538DECLASM(int) vmmGCTestTrap0e_ResumeEIP(void); /**< a label */
539/** @} */
540
541#endif /* IN_RC */
542
543__END_DECLS
544
545/** @} */
546
547#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