VMInternal.h@ 31026

Last change on this file since 31026 was 30473, checked in by vboxsync, 14 years ago
VMM: First shot at the fatal error misbehavior (PAE).
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 16.0 KB

Line
1	/* $Id: VMInternal.h 30473 2010-06-28 15:45:22Z vboxsync $ */
2	/** @file
3	* VM - Internal header file.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 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 ___VMInternal_h
19	#define ___VMInternal_h
20
21	#include <VBox/cdefs.h>
22	#include <VBox/vmapi.h>
23	#include <iprt/assert.h>
24	#include <iprt/critsect.h>
25	#include <setjmp.h>
26
27
28
29	/** @defgroup grp_vm_int Internals
30	* @ingroup grp_vm
31	* @internal
32	* @{
33	*/
34
35
36	/**
37	* VM state change callback.
38	*/
39	typedef struct VMATSTATE
40	{
41	/** Pointer to the next one. */
42	struct VMATSTATE *pNext;
43	/** Pointer to the callback. */
44	PFNVMATSTATE pfnAtState;
45	/** The user argument. */
46	void *pvUser;
47	} VMATSTATE;
48	/** Pointer to a VM state change callback. */
49	typedef VMATSTATE *PVMATSTATE;
50
51
52	/**
53	* VM error callback.
54	*/
55	typedef struct VMATERROR
56	{
57	/** Pointer to the next one. */
58	struct VMATERROR *pNext;
59	/** Pointer to the callback. */
60	PFNVMATERROR pfnAtError;
61	/** The user argument. */
62	void *pvUser;
63	} VMATERROR;
64	/** Pointer to a VM error callback. */
65	typedef VMATERROR *PVMATERROR;
66
67
68	/**
69	* Chunk of memory allocated off the hypervisor heap in which
70	* we copy the error details.
71	*/
72	typedef struct VMERROR
73	{
74	/** The size of the chunk. */
75	uint32_t cbAllocated;
76	/** The current offset into the chunk.
77	* We start by putting the filename and function immediatly
78	* after the end of the buffer. */
79	uint32_t off;
80	/** Offset from the start of this structure to the file name. */
81	uint32_t offFile;
82	/** The line number. */
83	uint32_t iLine;
84	/** Offset from the start of this structure to the function name. */
85	uint32_t offFunction;
86	/** Offset from the start of this structure to the formatted message text. */
87	uint32_t offMessage;
88	/** The VBox status code. */
89	int32_t rc;
90	} VMERROR, *PVMERROR;
91
92
93	/**
94	* VM runtime error callback.
95	*/
96	typedef struct VMATRUNTIMEERROR
97	{
98	/** Pointer to the next one. */
99	struct VMATRUNTIMEERROR *pNext;
100	/** Pointer to the callback. */
101	PFNVMATRUNTIMEERROR pfnAtRuntimeError;
102	/** The user argument. */
103	void *pvUser;
104	} VMATRUNTIMEERROR;
105	/** Pointer to a VM error callback. */
106	typedef VMATRUNTIMEERROR *PVMATRUNTIMEERROR;
107
108
109	/**
110	* Chunk of memory allocated off the hypervisor heap in which
111	* we copy the runtime error details.
112	*/
113	typedef struct VMRUNTIMEERROR
114	{
115	/** The size of the chunk. */
116	uint32_t cbAllocated;
117	/** The current offset into the chunk.
118	* We start by putting the error ID immediatly
119	* after the end of the buffer. */
120	uint32_t off;
121	/** Offset from the start of this structure to the error ID. */
122	uint32_t offErrorId;
123	/** Offset from the start of this structure to the formatted message text. */
124	uint32_t offMessage;
125	/** Error flags. */
126	uint32_t fFlags;
127	} VMRUNTIMEERROR, *PVMRUNTIMEERROR;
128
129	/** The halt method. */
130	typedef enum
131	{
132	/** The usual invalid value. */
133	VMHALTMETHOD_INVALID = 0,
134	/** Use the method used during bootstrapping. */
135	VMHALTMETHOD_BOOTSTRAP,
136	/** Use the default method. */
137	VMHALTMETHOD_DEFAULT,
138	/** The old spin/yield/block method. */
139	VMHALTMETHOD_OLD,
140	/** The first go at a block/spin method. */
141	VMHALTMETHOD_1,
142	/** The first go at a more global approach. */
143	VMHALTMETHOD_GLOBAL_1,
144	/** The end of valid methods. (not inclusive of course) */
145	VMHALTMETHOD_END,
146	/** The usual 32-bit max value. */
147	VMHALTMETHOD_32BIT_HACK = 0x7fffffff
148	} VMHALTMETHOD;
149
150
151	/**
152	* VM Internal Data (part of the VM structure).
153	*
154	* @todo Move this and all related things to VMM. The VM component was, to some
155	* extent at least, a bad ad hoc design which should all have been put in
156	* VMM. @see pg_vm.
157	*/
158	typedef struct VMINT
159	{
160	/** VM Error Message. */
161	R3PTRTYPE(PVMERROR) pErrorR3;
162	/** VM Runtime Error Message. */
163	R3PTRTYPE(PVMRUNTIMEERROR) pRuntimeErrorR3;
164	/** The VM was/is-being teleported and has not yet been fully resumed. */
165	bool fTeleportedAndNotFullyResumedYet;
166	} VMINT;
167	/** Pointer to the VM Internal Data (part of the VM structure). */
168	typedef VMINT *PVMINT;
169
170
171	/**
172	* VM internal data kept in the UVM.
173	*/
174	typedef struct VMINTUSERPERVM
175	{
176	/** Head of the request queue. Atomic. */
177	volatile PVMREQ pReqs;
178	/** The last index used during alloc/free. */
179	volatile uint32_t iReqFree;
180	/** Number of free request packets. */
181	volatile uint32_t cReqFree;
182	/** Array of pointers to lists of free request packets. Atomic. */
183	volatile PVMREQ apReqFree[9];
184
185	#ifdef VBOX_WITH_STATISTICS
186	/** Number of VMR3ReqAlloc returning a new packet. */
187	STAMCOUNTER StatReqAllocNew;
188	/** Number of VMR3ReqAlloc causing races. */
189	STAMCOUNTER StatReqAllocRaces;
190	/** Number of VMR3ReqAlloc returning a recycled packet. */
191	STAMCOUNTER StatReqAllocRecycled;
192	/** Number of VMR3ReqFree calls. */
193	STAMCOUNTER StatReqFree;
194	/** Number of times the request was actually freed. */
195	STAMCOUNTER StatReqFreeOverflow;
196	/** Number of requests served. */
197	STAMCOUNTER StatReqProcessed;
198	/** Number of times there are more than one request and the others needed to be
199	* pushed back onto the list. */
200	STAMCOUNTER StatReqMoreThan1;
201	/** Number of times we've raced someone when pushing the other requests back
202	* onto the list. */
203	STAMCOUNTER StatReqPushBackRaces;
204	#endif
205
206	/** Pointer to the support library session.
207	* Mainly for creation and destruction. */
208	PSUPDRVSESSION pSession;
209
210	/** Force EMT to terminate. */
211	bool volatile fTerminateEMT;
212
213	/** Critical section for pAtState and enmPrevVMState. */
214	RTCRITSECT AtStateCritSect;
215	/** List of registered state change callbacks. */
216	PVMATSTATE pAtState;
217	/** List of registered state change callbacks. */
218	PVMATSTATE *ppAtStateNext;
219	/** The previous VM state.
220	* This is mainly used for the 'Resetting' state, but may come in handy later
221	* and when debugging. */
222	VMSTATE enmPrevVMState;
223
224	/** Critical section for pAtError and pAtRuntimeError. */
225	RTCRITSECT AtErrorCritSect;
226
227	/** List of registered error callbacks. */
228	PVMATERROR pAtError;
229	/** List of registered error callbacks. */
230	PVMATERROR *ppAtErrorNext;
231	/** The error message count.
232	* This is incremented every time an error is raised. */
233	uint32_t volatile cErrors;
234
235	/** The runtime error message count.
236	* This is incremented every time a runtime error is raised. */
237	uint32_t volatile cRuntimeErrors;
238	/** List of registered error callbacks. */
239	PVMATRUNTIMEERROR pAtRuntimeError;
240	/** List of registered error callbacks. */
241	PVMATRUNTIMEERROR *ppAtRuntimeErrorNext;
242
243	/** @name Generic Halt data
244	* @{
245	*/
246	/** The current halt method.
247	* Can be selected by CFGM option 'VM/HaltMethod'. */
248	VMHALTMETHOD enmHaltMethod;
249	/** The index into g_aHaltMethods of the current halt method. */
250	uint32_t volatile iHaltMethod;
251	/** @} */
252
253	/** @todo Do NOT add new members here or resue the current, we need to store the config for
254	* each halt method seperately because we're racing on SMP guest rigs. */
255	union
256	{
257	/**
258	* Method 1 & 2 - Block whenever possible, and when lagging behind
259	* switch to spinning with regular blocking every 5-200ms (defaults)
260	* depending on the accumulated lag. The blocking interval is adjusted
261	* with the average oversleeping of the last 64 times.
262	*
263	* The difference between 1 and 2 is that we use native absolute
264	* time APIs for the blocking instead of the millisecond based IPRT
265	* interface.
266	*/
267	struct
268	{
269	/** The max interval without blocking (when spinning). */
270	uint32_t u32MinBlockIntervalCfg;
271	/** The minimum interval between blocking (when spinning). */
272	uint32_t u32MaxBlockIntervalCfg;
273	/** The value to divide the current lag by to get the raw blocking interval (when spinning). */
274	uint32_t u32LagBlockIntervalDivisorCfg;
275	/** When to start spinning (lag / nano secs). */
276	uint32_t u32StartSpinningCfg;
277	/** When to stop spinning (lag / nano secs). */
278	uint32_t u32StopSpinningCfg;
279	} Method12;
280	} Halt;
281
282	/** Pointer to the DBGC instance data. */
283	void *pvDBGC;
284
285	/** TLS index for the VMINTUSERPERVMCPU pointer. */
286	RTTLS idxTLS;
287	} VMINTUSERPERVM;
288
289	/** Pointer to the VM internal data kept in the UVM. */
290	typedef VMINTUSERPERVM *PVMINTUSERPERVM;
291
292
293	/**
294	* VMCPU internal data kept in the UVM.
295	*
296	* Almost a copy of VMINTUSERPERVM. Separate data properly later on.
297	*/
298	typedef struct VMINTUSERPERVMCPU
299	{
300	/** Head of the request queue. Atomic. */
301	volatile PVMREQ pReqs;
302
303	/** The handle to the EMT thread. */
304	RTTHREAD ThreadEMT;
305	/** The native of the EMT thread. */
306	RTNATIVETHREAD NativeThreadEMT;
307	/** Wait event semaphore. */
308	RTSEMEVENT EventSemWait;
309	/** Wait/Idle indicator. */
310	bool volatile fWait;
311	/** Align the next bit. */
312	bool afAlignment[7];
313
314	/** @name Generic Halt data
315	* @{
316	*/
317	/** The average time (ns) between two halts in the last second. (updated once per second) */
318	uint32_t HaltInterval;
319	/** The average halt frequency for the last second. (updated once per second) */
320	uint32_t HaltFrequency;
321	/** The number of halts in the current period. */
322	uint32_t cHalts;
323	uint32_t padding; /*< alignment padding. /
324	/** When we started counting halts in cHalts (RTTimeNanoTS). */
325	uint64_t u64HaltsStartTS;
326	/** @} */
327
328	/** Union containing data and config for the different halt algorithms. */
329	union
330	{
331	/**
332	* Method 1 & 2 - Block whenever possible, and when lagging behind
333	* switch to spinning with regular blocking every 5-200ms (defaults)
334	* depending on the accumulated lag. The blocking interval is adjusted
335	* with the average oversleeping of the last 64 times.
336	*
337	* The difference between 1 and 2 is that we use native absolute
338	* time APIs for the blocking instead of the millisecond based IPRT
339	* interface.
340	*/
341	struct
342	{
343	/** How many times we've blocked while cBlockedNS and cBlockedTooLongNS has been accumulating. */
344	uint32_t cBlocks;
345	/** Align the next member. */
346	uint32_t u32Alignment;
347	/** Avg. time spend oversleeping when blocking. (Re-calculated every so often.) */
348	uint64_t cNSBlockedTooLongAvg;
349	/** Total time spend oversleeping when blocking. */
350	uint64_t cNSBlockedTooLong;
351	/** Total time spent blocking. */
352	uint64_t cNSBlocked;
353	/** The timestamp (RTTimeNanoTS) of the last block. */
354	uint64_t u64LastBlockTS;
355
356	/** When we started spinning relentlessly in order to catch up some of the oversleeping.
357	* This is 0 when we're not spinning. */
358	uint64_t u64StartSpinTS;
359	} Method12;
360
361	#if 0
362	/**
363	* Method 3 & 4 - Same as method 1 & 2 respectivly, except that we
364	* sprinkle it with yields.
365	*/
366	struct
367	{
368	/** How many times we've blocked while cBlockedNS and cBlockedTooLongNS has been accumulating. */
369	uint32_t cBlocks;
370	/** Avg. time spend oversleeping when blocking. (Re-calculated every so often.) */
371	uint64_t cBlockedTooLongNSAvg;
372	/** Total time spend oversleeping when blocking. */
373	uint64_t cBlockedTooLongNS;
374	/** Total time spent blocking. */
375	uint64_t cBlockedNS;
376	/** The timestamp (RTTimeNanoTS) of the last block. */
377	uint64_t u64LastBlockTS;
378
379	/** How many times we've yielded while cBlockedNS and cBlockedTooLongNS has been accumulating. */
380	uint32_t cYields;
381	/** Avg. time spend oversleeping when yielding. */
382	uint32_t cYieldTooLongNSAvg;
383	/** Total time spend oversleeping when yielding. */
384	uint64_t cYieldTooLongNS;
385	/** Total time spent yielding. */
386	uint64_t cYieldedNS;
387	/** The timestamp (RTTimeNanoTS) of the last block. */
388	uint64_t u64LastYieldTS;
389
390	/** When we started spinning relentlessly in order to catch up some of the oversleeping. */
391	uint64_t u64StartSpinTS;
392	} Method34;
393	#endif
394	} Halt;
395
396	/** Profiling the halted state; yielding vs blocking.
397	* @{ */
398	STAMPROFILE StatHaltYield;
399	STAMPROFILE StatHaltBlock;
400	STAMPROFILE StatHaltTimers;
401	STAMPROFILE StatHaltPoll;
402	/** @} */
403	} VMINTUSERPERVMCPU;
404	#ifdef IN_RING3
405	AssertCompileMemberAlignment(VMINTUSERPERVMCPU, u64HaltsStartTS, 8);
406	AssertCompileMemberAlignment(VMINTUSERPERVMCPU, Halt.Method12.cNSBlockedTooLongAvg, 8);
407	AssertCompileMemberAlignment(VMINTUSERPERVMCPU, StatHaltYield, 8);
408	#endif
409
410	/** Pointer to the VM internal data kept in the UVM. */
411	typedef VMINTUSERPERVMCPU *PVMINTUSERPERVMCPU;
412
413	RT_C_DECLS_BEGIN
414
415	DECLCALLBACK(int) vmR3EmulationThread(RTTHREAD ThreadSelf, void *pvArg);
416	int vmR3SetHaltMethodU(PUVM pUVM, VMHALTMETHOD enmHaltMethod);
417	DECLCALLBACK(int) vmR3Destroy(PVM pVM);
418	DECLCALLBACK(void) vmR3SetErrorUV(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char pszFormat, va_list args);
419	void vmSetErrorCopy(PVM pVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list args);
420	DECLCALLBACK(int) vmR3SetRuntimeError(PVM pVM, uint32_t fFlags, const char pszErrorId, char pszMessage);
421	DECLCALLBACK(int) vmR3SetRuntimeErrorV(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list *pVa);
422	void vmSetRuntimeErrorCopy(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va);
423	void vmR3SetGuruMeditation(PVM pVM);
424	void vmR3SetTerminated(PVM pVM);
425
426	RT_C_DECLS_END
427
428
429	/** @} */
430
431	#endif
432

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

source: vbox/trunk/src/VBox/VMM/VMInternal.h@ 31026

Download in other formats: