VirtualBox

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

Last change on this file since 19430 was 19366, checked in by vboxsync, 16 years ago

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