VMMInternal.h@ 73092

Last change on this file since 73092 was 72778, checked in by vboxsync, 7 years ago

VMM,SUPDrv,IPRT: Redirect ring-0 release logging on EMTs to VBox.log.

VMM: Added release ring-0 logging on EMTs that writes to VBox.log.
IPRT: Made 'msprog' and 'timeprog' work for ring-0 logging on EMTs.
IPRT: Removed RTLogSetCustomPrefixCallbackForR0.
VMM: Removed vmmR0LoggerPrefix that was assoicated with the above API.
IPRT Fixed missing log prefix on the first log line.
SUPDrv: Turns out we require actual code for SUPR0GetDefaultLogRelInstanceEx and SUPR0GetDefaultLogInstanceEx.

Note! Requires updating the support driver.

Property svn:eol-style set to native
Property svn:keywords set to Id Revision

File size: 27.0 KB

Line
1	/* $Id: VMMInternal.h 72778 2018-06-29 20:02:35Z vboxsync $ */
2	/** @file
3	* VMM - Internal header file.
4	*/
5
6	/*
7	* Copyright (C) 2006-2017 Oracle Corporation
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
18	#ifndef ___VMMInternal_h
19	#define ___VMMInternal_h
20
21	#include <VBox/cdefs.h>
22	#include <VBox/sup.h>
23	#include <VBox/vmm/stam.h>
24	#include <VBox/vmm/vmm.h>
25	#include <VBox/log.h>
26	#include <iprt/critsect.h>
27
28	#if !defined(IN_VMM_R3) && !defined(IN_VMM_R0) && !defined(IN_VMM_RC)
29	# error "Not in VMM! This is an internal header!"
30	#endif
31	#if defined(RT_OS_DARWIN) && HC_ARCH_BITS == 32
32	# error "32-bit darwin is no longer supported. Go back to 4.3 or earlier!"
33	#endif
34
35
36
37	/** @defgroup grp_vmm_int Internals
38	* @ingroup grp_vmm
39	* @internal
40	* @{
41	*/
42
43	/** @def VBOX_WITH_RC_RELEASE_LOGGING
44	* Enables RC release logging. */
45	#define VBOX_WITH_RC_RELEASE_LOGGING
46
47	/** @def VBOX_WITH_R0_LOGGING
48	* Enables Ring-0 logging (non-release).
49	*
50	* Ring-0 logging isn't 100% safe yet (thread id reuse / process exit cleanup),
51	* so you have to sign up here by adding your defined(DEBUG_<userid>) to the
52	* \#if, or by adding VBOX_WITH_R0_LOGGING to your LocalConfig.kmk.
53	*/
54	#if defined(DEBUG_sandervl) \|\| defined(DEBUG_frank) \|\| defined(DEBUG_ramshankar) \|\| defined(DOXYGEN_RUNNING)
55	# define VBOX_WITH_R0_LOGGING
56	#endif
57
58	/** @def VBOX_STRICT_VMM_STACK
59	* Enables VMM stack guard pages to catch stack over- and underruns. */
60	#if defined(VBOX_STRICT) \|\| defined(DOXYGEN_RUNNING)
61	# define VBOX_STRICT_VMM_STACK
62	#endif
63
64
65	/**
66	* Converts a VMM pointer into a VM pointer.
67	* @returns Pointer to the VM structure the VMM is part of.
68	* @param pVMM Pointer to VMM instance data.
69	*/
70	#define VMM2VM(pVMM) ( (PVM)((char*)pVMM - pVMM->offVM) )
71
72
73	/**
74	* Switcher function, HC to RC.
75	*
76	* @param pVM The cross context VM structure.
77	* @returns Return code indicating the action to take.
78	*/
79	typedef DECLASMTYPE(int) FNVMMSWITCHERHC(PVM pVM);
80	/** Pointer to switcher function. */
81	typedef FNVMMSWITCHERHC *PFNVMMSWITCHERHC;
82
83	/**
84	* Switcher function, RC to HC.
85	*
86	* @param rc VBox status code.
87	*/
88	typedef DECLASMTYPE(void) FNVMMSWITCHERRC(int rc);
89	/** Pointer to switcher function. */
90	typedef FNVMMSWITCHERRC *PFNVMMSWITCHERRC;
91
92
93	/**
94	* The ring-0 logger instance wrapper.
95	*
96	* We need to be able to find the VM handle from the logger instance, so we wrap
97	* it in this structure.
98	*/
99	typedef struct VMMR0LOGGER
100	{
101	/** Pointer to Pointer to the VM. */
102	R0PTRTYPE(PVM) pVM;
103	/** Size of the allocated logger instance (Logger). */
104	uint32_t cbLogger;
105	/** Flag indicating whether we've create the logger Ring-0 instance yet. */
106	bool fCreated;
107	/** Flag indicating whether we've disabled flushing (world switch) or not. */
108	bool fFlushingDisabled;
109	/** Flag indicating whether we've registered the instance already. */
110	bool fRegistered;
111	bool a8Alignment;
112	/** The CPU ID. */
113	VMCPUID idCpu;
114	#if HC_ARCH_BITS == 64
115	uint32_t u32Alignment;
116	#endif
117	/** The ring-0 logger instance. This extends beyond the size. */
118	RTLOGGER Logger;
119	} VMMR0LOGGER;
120	/** Pointer to a ring-0 logger instance wrapper. */
121	typedef VMMR0LOGGER *PVMMR0LOGGER;
122
123
124	/**
125	* Jump buffer for the setjmp/longjmp like constructs used to
126	* quickly 'call' back into Ring-3.
127	*/
128	typedef struct VMMR0JMPBUF
129	{
130	/** Traditional jmp_buf stuff
131	* @{ */
132	#if HC_ARCH_BITS == 32
133	uint32_t ebx;
134	uint32_t esi;
135	uint32_t edi;
136	uint32_t ebp;
137	uint32_t esp;
138	uint32_t eip;
139	uint32_t eflags;
140	#endif
141	#if HC_ARCH_BITS == 64
142	uint64_t rbx;
143	# ifdef RT_OS_WINDOWS
144	uint64_t rsi;
145	uint64_t rdi;
146	# endif
147	uint64_t rbp;
148	uint64_t r12;
149	uint64_t r13;
150	uint64_t r14;
151	uint64_t r15;
152	uint64_t rsp;
153	uint64_t rip;
154	# ifdef RT_OS_WINDOWS
155	uint128_t xmm6;
156	uint128_t xmm7;
157	uint128_t xmm8;
158	uint128_t xmm9;
159	uint128_t xmm10;
160	uint128_t xmm11;
161	uint128_t xmm12;
162	uint128_t xmm13;
163	uint128_t xmm14;
164	uint128_t xmm15;
165	# endif
166	uint64_t rflags;
167	#endif
168	/** @} */
169
170	/** Flag that indicates that we've done a ring-3 call. */
171	bool fInRing3Call;
172	/** The number of bytes we've saved. */
173	uint32_t cbSavedStack;
174	/** Pointer to the buffer used to save the stack.
175	* This is assumed to be 8KB. */
176	RTR0PTR pvSavedStack;
177	/** Esp we we match against esp on resume to make sure the stack wasn't relocated. */
178	RTHCUINTREG SpCheck;
179	/** The esp we should resume execution with after the restore. */
180	RTHCUINTREG SpResume;
181	/** ESP/RSP at the time of the jump to ring 3. */
182	RTHCUINTREG SavedEsp;
183	/** EBP/RBP at the time of the jump to ring 3. */
184	RTHCUINTREG SavedEbp;
185
186	/** Stats: Max amount of stack used. */
187	uint32_t cbUsedMax;
188	/** Stats: Average stack usage. (Avg = cbUsedTotal / cUsedTotal) */
189	uint32_t cbUsedAvg;
190	/** Stats: Total amount of stack used. */
191	uint64_t cbUsedTotal;
192	/** Stats: Number of stack usages. */
193	uint64_t cUsedTotal;
194	} VMMR0JMPBUF;
195	/** Pointer to a ring-0 jump buffer. */
196	typedef VMMR0JMPBUF *PVMMR0JMPBUF;
197
198
199	/**
200	* VMM Data (part of VM)
201	*/
202	typedef struct VMM
203	{
204	/** Offset to the VM structure.
205	* See VMM2VM(). */
206	RTINT offVM;
207
208	/** @name World Switcher and Related
209	* @{
210	*/
211	/** Size of the core code. */
212	RTUINT cbCoreCode;
213	/** Physical address of core code. */
214	RTHCPHYS HCPhysCoreCode;
215	/** Pointer to core code ring-3 mapping - contiguous memory.
216	* At present this only means the context switcher code. */
217	RTR3PTR pvCoreCodeR3;
218	/** Pointer to core code ring-0 mapping - contiguous memory.
219	* At present this only means the context switcher code. */
220	RTR0PTR pvCoreCodeR0;
221	/** Pointer to core code guest context mapping. */
222	RTRCPTR pvCoreCodeRC;
223	RTRCPTR pRCPadding0; /*< Alignment padding. /
224	#ifdef VBOX_WITH_NMI
225	/** The guest context address of the APIC (host) mapping. */
226	RTRCPTR GCPtrApicBase;
227	RTRCPTR pRCPadding1; /*< Alignment padding. /
228	#endif
229	/** The current switcher.
230	* This will be set before the VMM is fully initialized. */
231	VMMSWITCHER enmSwitcher;
232	/** Array of offsets to the different switchers within the core code. */
233	uint32_t aoffSwitchers[VMMSWITCHER_MAX];
234	uint32_t u32Padding2; /*< Alignment padding. /
235
236	/** Resume Guest Execution. See CPUMGCResumeGuest(). */
237	RTRCPTR pfnCPUMRCResumeGuest;
238	/** Resume Guest Execution in V86 mode. See CPUMGCResumeGuestV86(). */
239	RTRCPTR pfnCPUMRCResumeGuestV86;
240	/** Call Trampoline. See vmmGCCallTrampoline(). */
241	RTRCPTR pfnCallTrampolineRC;
242	/** Guest to host switcher entry point. */
243	RCPTRTYPE(PFNVMMSWITCHERRC) pfnRCToHost;
244	/** Host to guest switcher entry point. */
245	R0PTRTYPE(PFNVMMSWITCHERHC) pfnR0ToRawMode;
246	/** @} */
247
248	/** @name Logging
249	* @{
250	*/
251	/** Size of the allocated logger instance (pRCLoggerRC/pRCLoggerR3). */
252	uint32_t cbRCLogger;
253	/** Pointer to the RC logger instance - RC Ptr.
254	* This is NULL if logging is disabled. */
255	RCPTRTYPE(PRTLOGGERRC) pRCLoggerRC;
256	/** Pointer to the GC logger instance - R3 Ptr.
257	* This is NULL if logging is disabled. */
258	R3PTRTYPE(PRTLOGGERRC) pRCLoggerR3;
259	/** Pointer to the GC release logger instance - R3 Ptr. */
260	R3PTRTYPE(PRTLOGGERRC) pRCRelLoggerR3;
261	/** Pointer to the GC release logger instance - RC Ptr. */
262	RCPTRTYPE(PRTLOGGERRC) pRCRelLoggerRC;
263	/** Size of the allocated release logger instance (pRCRelLoggerRC/pRCRelLoggerR3).
264	* This may differ from cbRCLogger. */
265	uint32_t cbRCRelLogger;
266	/** Whether log flushing has been disabled or not. */
267	bool fRCLoggerFlushingDisabled;
268	bool afAlignment1[5]; /*< Alignment padding. /
269	/** @} */
270
271	/** Whether the stack guard pages have been stationed or not. */
272	bool fStackGuardsStationed;
273	/** Whether we should use the periodic preemption timers. */
274	bool fUsePeriodicPreemptionTimers;
275
276	/** The EMT yield timer. */
277	PTMTIMERR3 pYieldTimer;
278	/** The period to the next timeout when suspended or stopped.
279	* This is 0 when running. */
280	uint32_t cYieldResumeMillies;
281	/** The EMT yield timer interval (milliseconds). */
282	uint32_t cYieldEveryMillies;
283	/** The timestamp of the previous yield. (nano) */
284	uint64_t u64LastYield;
285
286	/** @name EMT Rendezvous
287	* @{ */
288	/** Semaphore to wait on upon entering ordered execution. */
289	R3PTRTYPE(PRTSEMEVENT) pahEvtRendezvousEnterOrdered;
290	/** Semaphore to wait on upon entering for one-by-one execution. */
291	RTSEMEVENT hEvtRendezvousEnterOneByOne;
292	/** Semaphore to wait on upon entering for all-at-once execution. */
293	RTSEMEVENTMULTI hEvtMulRendezvousEnterAllAtOnce;
294	/** Semaphore to wait on when done. */
295	RTSEMEVENTMULTI hEvtMulRendezvousDone;
296	/** Semaphore the VMMR3EmtRendezvous caller waits on at the end. */
297	RTSEMEVENT hEvtRendezvousDoneCaller;
298	/** Semaphore to wait on upon recursing. */
299	RTSEMEVENTMULTI hEvtMulRendezvousRecursionPush;
300	/** Semaphore to wait on after done with recursion (caller restoring state). */
301	RTSEMEVENTMULTI hEvtMulRendezvousRecursionPop;
302	/** Semaphore the initiator waits on while the EMTs are getting into position
303	* on hEvtMulRendezvousRecursionPush. */
304	RTSEMEVENT hEvtRendezvousRecursionPushCaller;
305	/** Semaphore the initiator waits on while the EMTs sitting on
306	* hEvtMulRendezvousRecursionPop wakes up and leave. */
307	RTSEMEVENT hEvtRendezvousRecursionPopCaller;
308	/** Callback. */
309	R3PTRTYPE(PFNVMMEMTRENDEZVOUS) volatile pfnRendezvous;
310	/** The user argument for the callback. */
311	RTR3PTR volatile pvRendezvousUser;
312	/** Flags. */
313	volatile uint32_t fRendezvousFlags;
314	/** The number of EMTs that has entered. */
315	volatile uint32_t cRendezvousEmtsEntered;
316	/** The number of EMTs that has done their job. */
317	volatile uint32_t cRendezvousEmtsDone;
318	/** The number of EMTs that has returned. */
319	volatile uint32_t cRendezvousEmtsReturned;
320	/** The status code. */
321	volatile int32_t i32RendezvousStatus;
322	/** Spin lock. */
323	volatile uint32_t u32RendezvousLock;
324	/** The recursion depth. */
325	volatile uint32_t cRendezvousRecursions;
326	/** The number of EMTs that have entered the recursion routine. */
327	volatile uint32_t cRendezvousEmtsRecursingPush;
328	/** The number of EMTs that have leaft the recursion routine. */
329	volatile uint32_t cRendezvousEmtsRecursingPop;
330	/** Triggers rendezvous recursion in the other threads. */
331	volatile bool fRendezvousRecursion;
332
333	/** @} */
334
335	/** RTThreadPreemptIsPendingTrusty() result, set by vmmR0InitVM() for
336	* release logging purposes. */
337	bool fIsPreemptPendingApiTrusty : 1;
338	/** The RTThreadPreemptIsPossible() result, set by vmmR0InitVM() for
339	* release logging purposes. */
340	bool fIsPreemptPossible : 1;
341
342	bool afAlignment2[HC_ARCH_BITS == 32 ? 6 : 2]; /*< Alignment padding. /
343
344	/** Buffer for storing the standard assertion message for a ring-0 assertion.
345	* Used for saving the assertion message text for the release log and guru
346	* meditation dump. */
347	char szRing0AssertMsg1[512];
348	/** Buffer for storing the custom message for a ring-0 assertion. */
349	char szRing0AssertMsg2[256];
350
351	/** Number of VMMR0_DO_RUN_GC calls. */
352	STAMCOUNTER StatRunRC;
353
354	/** Statistics for each of the RC/R0 return codes.
355	* @{ */
356	STAMCOUNTER StatRZRetNormal;
357	STAMCOUNTER StatRZRetInterrupt;
358	STAMCOUNTER StatRZRetInterruptHyper;
359	STAMCOUNTER StatRZRetGuestTrap;
360	STAMCOUNTER StatRZRetRingSwitch;
361	STAMCOUNTER StatRZRetRingSwitchInt;
362	STAMCOUNTER StatRZRetStaleSelector;
363	STAMCOUNTER StatRZRetIRETTrap;
364	STAMCOUNTER StatRZRetEmulate;
365	STAMCOUNTER StatRZRetIOBlockEmulate;
366	STAMCOUNTER StatRZRetPatchEmulate;
367	STAMCOUNTER StatRZRetIORead;
368	STAMCOUNTER StatRZRetIOWrite;
369	STAMCOUNTER StatRZRetIOCommitWrite;
370	STAMCOUNTER StatRZRetMMIORead;
371	STAMCOUNTER StatRZRetMMIOWrite;
372	STAMCOUNTER StatRZRetMMIOCommitWrite;
373	STAMCOUNTER StatRZRetMMIOPatchRead;
374	STAMCOUNTER StatRZRetMMIOPatchWrite;
375	STAMCOUNTER StatRZRetMMIOReadWrite;
376	STAMCOUNTER StatRZRetMSRRead;
377	STAMCOUNTER StatRZRetMSRWrite;
378	STAMCOUNTER StatRZRetLDTFault;
379	STAMCOUNTER StatRZRetGDTFault;
380	STAMCOUNTER StatRZRetIDTFault;
381	STAMCOUNTER StatRZRetTSSFault;
382	STAMCOUNTER StatRZRetCSAMTask;
383	STAMCOUNTER StatRZRetSyncCR3;
384	STAMCOUNTER StatRZRetMisc;
385	STAMCOUNTER StatRZRetPatchInt3;
386	STAMCOUNTER StatRZRetPatchPF;
387	STAMCOUNTER StatRZRetPatchGP;
388	STAMCOUNTER StatRZRetPatchIretIRQ;
389	STAMCOUNTER StatRZRetRescheduleREM;
390	STAMCOUNTER StatRZRetToR3Total;
391	STAMCOUNTER StatRZRetToR3FF;
392	STAMCOUNTER StatRZRetToR3Unknown;
393	STAMCOUNTER StatRZRetToR3TMVirt;
394	STAMCOUNTER StatRZRetToR3HandyPages;
395	STAMCOUNTER StatRZRetToR3PDMQueues;
396	STAMCOUNTER StatRZRetToR3Rendezvous;
397	STAMCOUNTER StatRZRetToR3Timer;
398	STAMCOUNTER StatRZRetToR3DMA;
399	STAMCOUNTER StatRZRetToR3CritSect;
400	STAMCOUNTER StatRZRetToR3Iem;
401	STAMCOUNTER StatRZRetToR3Iom;
402	STAMCOUNTER StatRZRetTimerPending;
403	STAMCOUNTER StatRZRetInterruptPending;
404	STAMCOUNTER StatRZRetCallRing3;
405	STAMCOUNTER StatRZRetPATMDuplicateFn;
406	STAMCOUNTER StatRZRetPGMChangeMode;
407	STAMCOUNTER StatRZRetPendingRequest;
408	STAMCOUNTER StatRZRetPGMFlushPending;
409	STAMCOUNTER StatRZRetPatchTPR;
410	STAMCOUNTER StatRZCallPDMCritSectEnter;
411	STAMCOUNTER StatRZCallPDMLock;
412	STAMCOUNTER StatRZCallLogFlush;
413	STAMCOUNTER StatRZCallPGMPoolGrow;
414	STAMCOUNTER StatRZCallPGMMapChunk;
415	STAMCOUNTER StatRZCallPGMAllocHandy;
416	STAMCOUNTER StatRZCallRemReplay;
417	STAMCOUNTER StatRZCallVMSetError;
418	STAMCOUNTER StatRZCallVMSetRuntimeError;
419	STAMCOUNTER StatRZCallPGMLock;
420	/** @} */
421	} VMM;
422	/** Pointer to VMM. */
423	typedef VMM *PVMM;
424
425
426	/**
427	* VMMCPU Data (part of VMCPU)
428	*/
429	typedef struct VMMCPU
430	{
431	/** Offset to the VMCPU structure.
432	* See VMM2VMCPU(). */
433	int32_t offVMCPU;
434
435	/** The last RC/R0 return code. */
436	int32_t iLastGZRc;
437
438	/** VMM stack, pointer to the top of the stack in R3.
439	* Stack is allocated from the hypervisor heap and is page aligned
440	* and always writable in RC. */
441	R3PTRTYPE(uint8_t *) pbEMTStackR3;
442	/** Pointer to the bottom of the stack - needed for doing relocations. */
443	RCPTRTYPE(uint8_t *) pbEMTStackRC;
444	/** Pointer to the bottom of the stack - needed for doing relocations. */
445	RCPTRTYPE(uint8_t *) pbEMTStackBottomRC;
446
447	/** Pointer to the R0 logger instance - R3 Ptr.
448	* This is NULL if logging is disabled. */
449	R3PTRTYPE(PVMMR0LOGGER) pR0LoggerR3;
450	/** Pointer to the R0 logger instance - R0 Ptr.
451	* This is NULL if logging is disabled. */
452	R0PTRTYPE(PVMMR0LOGGER) pR0LoggerR0;
453
454	/** Pointer to the R0 release logger instance - R3 Ptr.
455	* This is NULL if logging is disabled. */
456	R3PTRTYPE(PVMMR0LOGGER) pR0RelLoggerR3;
457	/** Pointer to the R0 release instance - R0 Ptr.
458	* This is NULL if logging is disabled. */
459	R0PTRTYPE(PVMMR0LOGGER) pR0RelLoggerR0;
460
461	/** Thread context switching hook (ring-0). */
462	RTTHREADCTXHOOK hCtxHook;
463
464	/** @name Rendezvous
465	* @{ */
466	/** Whether the EMT is executing a rendezvous right now. For detecting
467	* attempts at recursive rendezvous. */
468	bool volatile fInRendezvous;
469	bool afPadding[HC_ARCH_BITS == 32 ? 3+4 : 7+8];
470	/** @} */
471
472	/** @name Raw-mode context tracing data.
473	* @{ */
474	SUPDRVTRACERUSRCTX TracerCtx;
475	/** @} */
476
477	/** Alignment padding, making sure u64CallRing3Arg is nicely aligned. */
478	uint32_t au32Padding1[3];
479
480	/** @name Call Ring-3
481	* Formerly known as host calls.
482	* @{ */
483	/** The disable counter. */
484	uint32_t cCallRing3Disabled;
485	/** The pending operation. */
486	VMMCALLRING3 enmCallRing3Operation;
487	/** The result of the last operation. */
488	int32_t rcCallRing3;
489	/** The argument to the operation. */
490	uint64_t u64CallRing3Arg;
491	/** The Ring-0 notification callback. */
492	R0PTRTYPE(PFNVMMR0CALLRING3NOTIFICATION) pfnCallRing3CallbackR0;
493	/** The Ring-0 notification callback user argument. */
494	R0PTRTYPE(void *) pvCallRing3CallbackUserR0;
495	/** The Ring-0 jmp buffer.
496	* @remarks The size of this type isn't stable in assembly, so don't put
497	* anything that needs to be accessed from assembly after it. */
498	VMMR0JMPBUF CallRing3JmpBufR0;
499	/** @} */
500	} VMMCPU;
501	AssertCompileMemberAlignment(VMMCPU, TracerCtx, 8);
502	/** Pointer to VMMCPU. */
503	typedef VMMCPU *PVMMCPU;
504
505
506	/**
507	* The VMMRCEntry() codes.
508	*/
509	typedef enum VMMRCOPERATION
510	{
511	/** Do GC module init. */
512	VMMRC_DO_VMMRC_INIT = 1,
513
514	/** The first Trap testcase. */
515	VMMRC_DO_TESTCASE_TRAP_FIRST = 0x0dead000,
516	/** Trap 0 testcases, uArg selects the variation. */
517	VMMRC_DO_TESTCASE_TRAP_0 = VMMRC_DO_TESTCASE_TRAP_FIRST,
518	/** Trap 1 testcases, uArg selects the variation. */
519	VMMRC_DO_TESTCASE_TRAP_1,
520	/** Trap 2 testcases, uArg selects the variation. */
521	VMMRC_DO_TESTCASE_TRAP_2,
522	/** Trap 3 testcases, uArg selects the variation. */
523	VMMRC_DO_TESTCASE_TRAP_3,
524	/** Trap 4 testcases, uArg selects the variation. */
525	VMMRC_DO_TESTCASE_TRAP_4,
526	/** Trap 5 testcases, uArg selects the variation. */
527	VMMRC_DO_TESTCASE_TRAP_5,
528	/** Trap 6 testcases, uArg selects the variation. */
529	VMMRC_DO_TESTCASE_TRAP_6,
530	/** Trap 7 testcases, uArg selects the variation. */
531	VMMRC_DO_TESTCASE_TRAP_7,
532	/** Trap 8 testcases, uArg selects the variation. */
533	VMMRC_DO_TESTCASE_TRAP_8,
534	/** Trap 9 testcases, uArg selects the variation. */
535	VMMRC_DO_TESTCASE_TRAP_9,
536	/** Trap 0a testcases, uArg selects the variation. */
537	VMMRC_DO_TESTCASE_TRAP_0A,
538	/** Trap 0b testcases, uArg selects the variation. */
539	VMMRC_DO_TESTCASE_TRAP_0B,
540	/** Trap 0c testcases, uArg selects the variation. */
541	VMMRC_DO_TESTCASE_TRAP_0C,
542	/** Trap 0d testcases, uArg selects the variation. */
543	VMMRC_DO_TESTCASE_TRAP_0D,
544	/** Trap 0e testcases, uArg selects the variation. */
545	VMMRC_DO_TESTCASE_TRAP_0E,
546	/** The last trap testcase (exclusive). */
547	VMMRC_DO_TESTCASE_TRAP_LAST,
548	/** Testcase for checking interrupt forwarding. */
549	VMMRC_DO_TESTCASE_HYPER_INTERRUPT,
550	/** Switching testing and profiling stub. */
551	VMMRC_DO_TESTCASE_NOP,
552	/** Testcase for checking interrupt masking. */
553	VMMRC_DO_TESTCASE_INTERRUPT_MASKING,
554	/** Switching testing and profiling stub. */
555	VMMRC_DO_TESTCASE_HM_NOP,
556
557	/** The usual 32-bit hack. */
558	VMMRC_DO_32_BIT_HACK = 0x7fffffff
559	} VMMRCOPERATION;
560
561
562
563	/**
564	* MSR test result entry.
565	*/
566	typedef struct VMMTESTMSRENTRY
567	{
568	/** The MSR number, including padding.
569	* Set to UINT64_MAX if invalid MSR. */
570	uint64_t uMsr;
571	/** The register value. */
572	uint64_t uValue;
573	} VMMTESTMSRENTRY;
574	/** Pointer to an MSR test result entry. */
575	typedef VMMTESTMSRENTRY *PVMMTESTMSRENTRY;
576
577
578
579	RT_C_DECLS_BEGIN
580
581	int vmmInitFormatTypes(void);
582	void vmmTermFormatTypes(void);
583	uint32_t vmmGetBuildType(void);
584
585	#ifdef IN_RING3
586	int vmmR3SwitcherInit(PVM pVM);
587	void vmmR3SwitcherRelocate(PVM pVM, RTGCINTPTR offDelta);
588	#endif /* IN_RING3 */
589
590	#ifdef IN_RING0
591	/**
592	* World switcher assembly routine.
593	* It will call VMMRCEntry().
594	*
595	* @returns return code from VMMRCEntry().
596	* @param pVM The cross context VM structure.
597	* @param uArg See VMMRCEntry().
598	* @internal
599	*/
600	DECLASM(int) vmmR0WorldSwitch(PVM pVM, unsigned uArg);
601
602	/**
603	* Callback function for vmmR0CallRing3SetJmp.
604	*
605	* @returns VBox status code.
606	* @param pVM The cross context VM structure.
607	*/
608	typedef DECLCALLBACK(int) FNVMMR0SETJMP(PVM pVM, PVMCPU pVCpu);
609	/** Pointer to FNVMMR0SETJMP(). */
610	typedef FNVMMR0SETJMP *PFNVMMR0SETJMP;
611
612	/**
613	* The setjmp variant used for calling Ring-3.
614	*
615	* This differs from the normal setjmp in that it will resume VMMRZCallRing3 if we're
616	* in the middle of a ring-3 call. Another differences is the function pointer and
617	* argument. This has to do with resuming code and the stack frame of the caller.
618	*
619	* @returns VINF_SUCCESS on success or whatever is passed to vmmR0CallRing3LongJmp.
620	* @param pJmpBuf The jmp_buf to set.
621	* @param pfn The function to be called when not resuming.
622	* @param pVM The cross context VM structure.
623	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
624	*/
625	DECLASM(int) vmmR0CallRing3SetJmp(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMP pfn, PVM pVM, PVMCPU pVCpu);
626
627
628	/**
629	* Callback function for vmmR0CallRing3SetJmp2.
630	*
631	* @returns VBox status code.
632	* @param pvUser The user argument.
633	*/
634	typedef DECLCALLBACK(int) FNVMMR0SETJMP2(PGVM pGVM, VMCPUID idCpu);
635	/** Pointer to FNVMMR0SETJMP2(). */
636	typedef FNVMMR0SETJMP2 *PFNVMMR0SETJMP2;
637
638	/**
639	* Same as vmmR0CallRing3SetJmp except for the function signature.
640	*
641	* @returns VINF_SUCCESS on success or whatever is passed to vmmR0CallRing3LongJmp.
642	* @param pJmpBuf The jmp_buf to set.
643	* @param pfn The function to be called when not resuming.
644	* @param pGVM The ring-0 VM structure.
645	* @param idCpu The ID of the calling EMT.
646	*/
647	DECLASM(int) vmmR0CallRing3SetJmp2(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMP2 pfn, PGVM pGVM, VMCPUID idCpu);
648
649
650	/**
651	* Callback function for vmmR0CallRing3SetJmpEx.
652	*
653	* @returns VBox status code.
654	* @param pvUser The user argument.
655	*/
656	typedef DECLCALLBACK(int) FNVMMR0SETJMPEX(void *pvUser);
657	/** Pointer to FNVMMR0SETJMPEX(). */
658	typedef FNVMMR0SETJMPEX *PFNVMMR0SETJMPEX;
659
660	/**
661	* Same as vmmR0CallRing3SetJmp except for the function signature.
662	*
663	* @returns VINF_SUCCESS on success or whatever is passed to vmmR0CallRing3LongJmp.
664	* @param pJmpBuf The jmp_buf to set.
665	* @param pfn The function to be called when not resuming.
666	* @param pvUser The argument of that function.
667	*/
668	DECLASM(int) vmmR0CallRing3SetJmpEx(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMPEX pfn, void *pvUser);
669
670
671	/**
672	* Worker for VMMRZCallRing3.
673	* This will save the stack and registers.
674	*
675	* @returns rc.
676	* @param pJmpBuf Pointer to the jump buffer.
677	* @param rc The return code.
678	*/
679	DECLASM(int) vmmR0CallRing3LongJmp(PVMMR0JMPBUF pJmpBuf, int rc);
680
681	/**
682	* Internal R0 logger worker: Logger wrapper.
683	*/
684	VMMR0DECL(void) vmmR0LoggerWrapper(const char *pszFormat, ...);
685
686	/**
687	* Internal R0 logger worker: Flush logger.
688	*
689	* @param pLogger The logger instance to flush.
690	* @remark This function must be exported!
691	*/
692	VMMR0DECL(void) vmmR0LoggerFlush(PRTLOGGER pLogger);
693
694	/**
695	* Internal R0 logger worker: Custom prefix.
696	*
697	* @returns Number of chars written.
698	*
699	* @param pLogger The logger instance.
700	* @param pchBuf The output buffer.
701	* @param cchBuf The size of the buffer.
702	* @param pvUser User argument (ignored).
703	*/
704	VMMR0DECL(size_t) vmmR0LoggerPrefix(PRTLOGGER pLogger, char pchBuf, size_t cchBuf, void pvUser);
705
706	# ifdef VBOX_WITH_TRIPLE_FAULT_HACK
707	int vmmR0TripleFaultHackInit(void);
708	void vmmR0TripleFaultHackTerm(void);
709	# endif
710
711	#endif /* IN_RING0 */
712	#ifdef IN_RC
713
714	/**
715	* Internal GC logger worker: Logger wrapper.
716	*/
717	VMMRCDECL(void) vmmGCLoggerWrapper(const char *pszFormat, ...);
718
719	/**
720	* Internal GC release logger worker: Logger wrapper.
721	*/
722	VMMRCDECL(void) vmmGCRelLoggerWrapper(const char *pszFormat, ...);
723
724	/**
725	* Internal GC logger worker: Flush logger.
726	*
727	* @returns VINF_SUCCESS.
728	* @param pLogger The logger instance to flush.
729	* @remark This function must be exported!
730	*/
731	VMMRCDECL(int) vmmGCLoggerFlush(PRTLOGGERRC pLogger);
732
733	/** @name Trap testcases and related labels.
734	* @{ */
735	DECLASM(void) vmmGCEnableWP(void);
736	DECLASM(void) vmmGCDisableWP(void);
737	DECLASM(int) vmmGCTestTrap3(void);
738	DECLASM(int) vmmGCTestTrap8(void);
739	DECLASM(int) vmmGCTestTrap0d(void);
740	DECLASM(int) vmmGCTestTrap0e(void);
741	DECLASM(int) vmmGCTestTrap0e_FaultEIP(void); /*< a label /
742	DECLASM(int) vmmGCTestTrap0e_ResumeEIP(void); /*< a label /
743	/** @} */
744
745	#endif /* IN_RC */
746
747	RT_C_DECLS_END
748
749	/** @} */
750
751	#endif

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: