VMInternal.h@ 45855

Last change on this file since 45855 was 44528, checked in by vboxsync, 12 years ago
header (C) fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 17.1 KB

Line
1	/* $Id: VMInternal.h 44528 2013-02-04 14:27:54Z vboxsync $ */
2	/** @file
3	* VM - Internal header file.
4	*/
5
6	/*
7	* Copyright (C) 2006-2011 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/vmm/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 immediately
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 immediately
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	#ifdef IN_RING3
172
173	/**
174	* VM internal data kept in the UVM.
175	*/
176	typedef struct VMINTUSERPERVM
177	{
178	/** Head of the standard request queue. Atomic. */
179	volatile PVMREQ pNormalReqs;
180	/** Head of the priority request queue. Atomic. */
181	volatile PVMREQ pPriorityReqs;
182	/** The last index used during alloc/free. */
183	volatile uint32_t iReqFree;
184	/** Number of free request packets. */
185	volatile uint32_t cReqFree;
186	/** Array of pointers to lists of free request packets. Atomic. */
187	volatile PVMREQ apReqFree[16 - (HC_ARCH_BITS == 32 ? 5 : 4)];
188
189	/** The reference count of the UVM handle. */
190	volatile uint32_t cUvmRefs;
191
192	# ifdef VBOX_WITH_STATISTICS
193	/** Number of VMR3ReqAlloc returning a new packet. */
194	STAMCOUNTER StatReqAllocNew;
195	/** Number of VMR3ReqAlloc causing races. */
196	STAMCOUNTER StatReqAllocRaces;
197	/** Number of VMR3ReqAlloc returning a recycled packet. */
198	STAMCOUNTER StatReqAllocRecycled;
199	/** Number of VMR3ReqFree calls. */
200	STAMCOUNTER StatReqFree;
201	/** Number of times the request was actually freed. */
202	STAMCOUNTER StatReqFreeOverflow;
203	/** Number of requests served. */
204	STAMCOUNTER StatReqProcessed;
205	/** Number of times there are more than one request and the others needed to be
206	* pushed back onto the list. */
207	STAMCOUNTER StatReqMoreThan1;
208	/** Number of times we've raced someone when pushing the other requests back
209	* onto the list. */
210	STAMCOUNTER StatReqPushBackRaces;
211	# endif
212
213	/** Pointer to the support library session.
214	* Mainly for creation and destruction. */
215	PSUPDRVSESSION pSession;
216
217	/** Force EMT to terminate. */
218	bool volatile fTerminateEMT;
219
220	/** Critical section for pAtState and enmPrevVMState. */
221	RTCRITSECT AtStateCritSect;
222	/** List of registered state change callbacks. */
223	PVMATSTATE pAtState;
224	/** List of registered state change callbacks. */
225	PVMATSTATE *ppAtStateNext;
226	/** The previous VM state.
227	* This is mainly used for the 'Resetting' state, but may come in handy later
228	* and when debugging. */
229	VMSTATE enmPrevVMState;
230
231	/** Critical section for pAtError and pAtRuntimeError. */
232	RTCRITSECT AtErrorCritSect;
233
234	/** List of registered error callbacks. */
235	PVMATERROR pAtError;
236	/** List of registered error callbacks. */
237	PVMATERROR *ppAtErrorNext;
238	/** The error message count.
239	* This is incremented every time an error is raised. */
240	uint32_t volatile cErrors;
241
242	/** The runtime error message count.
243	* This is incremented every time a runtime error is raised. */
244	uint32_t volatile cRuntimeErrors;
245	/** List of registered error callbacks. */
246	PVMATRUNTIMEERROR pAtRuntimeError;
247	/** List of registered error callbacks. */
248	PVMATRUNTIMEERROR *ppAtRuntimeErrorNext;
249
250	/** @name Generic Halt data
251	* @{
252	*/
253	/** The current halt method.
254	* Can be selected by CFGM option 'VM/HaltMethod'. */
255	VMHALTMETHOD enmHaltMethod;
256	/** The index into g_aHaltMethods of the current halt method. */
257	uint32_t volatile iHaltMethod;
258	/** @} */
259
260	/** @todo Do NOT add new members here or reuse the current, we need to store the config for
261	* each halt method separately because we're racing on SMP guest rigs. */
262	union
263	{
264	/**
265	* Method 1 & 2 - Block whenever possible, and when lagging behind
266	* switch to spinning with regular blocking every 5-200ms (defaults)
267	* depending on the accumulated lag. The blocking interval is adjusted
268	* with the average oversleeping of the last 64 times.
269	*
270	* The difference between 1 and 2 is that we use native absolute
271	* time APIs for the blocking instead of the millisecond based IPRT
272	* interface.
273	*/
274	struct
275	{
276	/** The max interval without blocking (when spinning). */
277	uint32_t u32MinBlockIntervalCfg;
278	/** The minimum interval between blocking (when spinning). */
279	uint32_t u32MaxBlockIntervalCfg;
280	/** The value to divide the current lag by to get the raw blocking interval (when spinning). */
281	uint32_t u32LagBlockIntervalDivisorCfg;
282	/** When to start spinning (lag / nano secs). */
283	uint32_t u32StartSpinningCfg;
284	/** When to stop spinning (lag / nano secs). */
285	uint32_t u32StopSpinningCfg;
286	} Method12;
287
288	/**
289	* The GVMM manages halted and waiting EMTs.
290	*/
291	struct
292	{
293	/** The threshold between spinning and blocking. */
294	uint32_t cNsSpinBlockThresholdCfg;
295	} Global1;
296	} Halt;
297
298	/** Pointer to the DBGC instance data. */
299	void *pvDBGC;
300
301	/** TLS index for the VMINTUSERPERVMCPU pointer. */
302	RTTLS idxTLS;
303
304	/** The VM name. (Set after the config constructure has been called.) */
305	char *pszName;
306	/** The VM UUID. (Set after the config constructure has been called.) */
307	RTUUID Uuid;
308	} VMINTUSERPERVM;
309	# ifdef VBOX_WITH_STATISTICS
310	AssertCompileMemberAlignment(VMINTUSERPERVM, StatReqAllocNew, 8);
311	# endif
312
313	/** Pointer to the VM internal data kept in the UVM. */
314	typedef VMINTUSERPERVM *PVMINTUSERPERVM;
315
316
317	/**
318	* VMCPU internal data kept in the UVM.
319	*
320	* Almost a copy of VMINTUSERPERVM. Separate data properly later on.
321	*/
322	typedef struct VMINTUSERPERVMCPU
323	{
324	/** Head of the normal request queue. Atomic. */
325	volatile PVMREQ pNormalReqs;
326	/** Head of the priority request queue. Atomic. */
327	volatile PVMREQ pPriorityReqs;
328
329	/** The handle to the EMT thread. */
330	RTTHREAD ThreadEMT;
331	/** The native of the EMT thread. */
332	RTNATIVETHREAD NativeThreadEMT;
333	/** Wait event semaphore. */
334	RTSEMEVENT EventSemWait;
335	/** Wait/Idle indicator. */
336	bool volatile fWait;
337	/** Align the next bit. */
338	bool afAlignment[HC_ARCH_BITS == 32 ? 3 : 7];
339
340	/** @name Generic Halt data
341	* @{
342	*/
343	/** The average time (ns) between two halts in the last second. (updated once per second) */
344	uint32_t HaltInterval;
345	/** The average halt frequency for the last second. (updated once per second) */
346	uint32_t HaltFrequency;
347	/** The number of halts in the current period. */
348	uint32_t cHalts;
349	uint32_t padding; /*< alignment padding. /
350	/** When we started counting halts in cHalts (RTTimeNanoTS). */
351	uint64_t u64HaltsStartTS;
352	/** @} */
353
354	/** Union containing data and config for the different halt algorithms. */
355	union
356	{
357	/**
358	* Method 1 & 2 - Block whenever possible, and when lagging behind
359	* switch to spinning with regular blocking every 5-200ms (defaults)
360	* depending on the accumulated lag. The blocking interval is adjusted
361	* with the average oversleeping of the last 64 times.
362	*
363	* The difference between 1 and 2 is that we use native absolute
364	* time APIs for the blocking instead of the millisecond based IPRT
365	* interface.
366	*/
367	struct
368	{
369	/** How many times we've blocked while cBlockedNS and cBlockedTooLongNS has been accumulating. */
370	uint32_t cBlocks;
371	/** Align the next member. */
372	uint32_t u32Alignment;
373	/** Avg. time spend oversleeping when blocking. (Re-calculated every so often.) */
374	uint64_t cNSBlockedTooLongAvg;
375	/** Total time spend oversleeping when blocking. */
376	uint64_t cNSBlockedTooLong;
377	/** Total time spent blocking. */
378	uint64_t cNSBlocked;
379	/** The timestamp (RTTimeNanoTS) of the last block. */
380	uint64_t u64LastBlockTS;
381
382	/** When we started spinning relentlessly in order to catch up some of the oversleeping.
383	* This is 0 when we're not spinning. */
384	uint64_t u64StartSpinTS;
385	} Method12;
386
387	# if 0
388	/**
389	* Method 3 & 4 - Same as method 1 & 2 respectivly, except that we
390	* sprinkle it with yields.
391	*/
392	struct
393	{
394	/** How many times we've blocked while cBlockedNS and cBlockedTooLongNS has been accumulating. */
395	uint32_t cBlocks;
396	/** Avg. time spend oversleeping when blocking. (Re-calculated every so often.) */
397	uint64_t cBlockedTooLongNSAvg;
398	/** Total time spend oversleeping when blocking. */
399	uint64_t cBlockedTooLongNS;
400	/** Total time spent blocking. */
401	uint64_t cBlockedNS;
402	/** The timestamp (RTTimeNanoTS) of the last block. */
403	uint64_t u64LastBlockTS;
404
405	/** How many times we've yielded while cBlockedNS and cBlockedTooLongNS has been accumulating. */
406	uint32_t cYields;
407	/** Avg. time spend oversleeping when yielding. */
408	uint32_t cYieldTooLongNSAvg;
409	/** Total time spend oversleeping when yielding. */
410	uint64_t cYieldTooLongNS;
411	/** Total time spent yielding. */
412	uint64_t cYieldedNS;
413	/** The timestamp (RTTimeNanoTS) of the last block. */
414	uint64_t u64LastYieldTS;
415
416	/** When we started spinning relentlessly in order to catch up some of the oversleeping. */
417	uint64_t u64StartSpinTS;
418	} Method34;
419	# endif
420	} Halt;
421
422	/** Profiling the halted state; yielding vs blocking.
423	* @{ */
424	STAMPROFILE StatHaltYield;
425	STAMPROFILE StatHaltBlock;
426	STAMPROFILE StatHaltBlockOverslept;
427	STAMPROFILE StatHaltBlockInsomnia;
428	STAMPROFILE StatHaltBlockOnTime;
429	STAMPROFILE StatHaltTimers;
430	STAMPROFILE StatHaltPoll;
431	/** @} */
432	} VMINTUSERPERVMCPU;
433	AssertCompileMemberAlignment(VMINTUSERPERVMCPU, u64HaltsStartTS, 8);
434	AssertCompileMemberAlignment(VMINTUSERPERVMCPU, Halt.Method12.cNSBlockedTooLongAvg, 8);
435	AssertCompileMemberAlignment(VMINTUSERPERVMCPU, StatHaltYield, 8);
436
437	/** Pointer to the VM internal data kept in the UVM. */
438	typedef VMINTUSERPERVMCPU *PVMINTUSERPERVMCPU;
439
440	#endif /* IN_RING3 */
441
442	RT_C_DECLS_BEGIN
443
444	DECLCALLBACK(int) vmR3EmulationThread(RTTHREAD ThreadSelf, void *pvArg);
445	int vmR3SetHaltMethodU(PUVM pUVM, VMHALTMETHOD enmHaltMethod);
446	DECLCALLBACK(int) vmR3Destroy(PVM pVM);
447	DECLCALLBACK(void) vmR3SetErrorUV(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char pszFormat, va_list args);
448	void vmSetErrorCopy(PVM pVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list args);
449	DECLCALLBACK(int) vmR3SetRuntimeError(PVM pVM, uint32_t fFlags, const char pszErrorId, char pszMessage);
450	DECLCALLBACK(int) vmR3SetRuntimeErrorV(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list *pVa);
451	void vmSetRuntimeErrorCopy(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va);
452	void vmR3SetGuruMeditation(PVM pVM);
453	void vmR3SetTerminated(PVM pVM);
454
455	RT_C_DECLS_END
456
457
458	/** @} */
459
460	#endif
461

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

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

Download in other formats: