VMInternal.h@ 6796

Last change on this file since 6796 was 6796, checked in by vboxsync, 17 years ago
Fixed init problems wrt. VM ownership by implementing the UVM structure (U = user mode) and moving problematic ring-3 stuff over there (emt+reqs, r3heap, stam, loader[VMMR0.r0]). Big change, but it works fine here... :-)
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 14.6 KB

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

Download in other formats: