VirtualBox

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

Last change on this file since 23794 was 23009, checked in by vboxsync, 15 years ago

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