VirtualBox

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

Last change on this file since 2291 was 870, checked in by vboxsync, 18 years ago

Added VMR3SuspendNoSave.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 9.1 KB
Line 
1/* $Id: VMInternal.h 870 2007-02-13 13:31:48Z vboxsync $ */
2/** @file
3 * VM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2006 InnoTek Systemberatung 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 as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * If you received this file as part of a commercial VirtualBox
18 * distribution, then only the terms of your commercial VirtualBox
19 * license agreement apply instead of the previous paragraph.
20 */
21
22#ifndef __VMInternal_h__
23#define __VMInternal_h__
24
25#include <VBox/cdefs.h>
26#include <VBox/vmapi.h>
27#include <setjmp.h>
28
29#if !defined(IN_VM_R3) && !defined(IN_VM_R0) && !defined(IN_VM_GC)
30# error "Not in VM! This is an internal header!"
31#endif
32
33
34/** @defgroup grp_vm_int Internals
35 * @ingroup grp_vm
36 * @internal
37 * @{
38 */
39
40
41/**
42 * At-reset callback type.
43 */
44typedef enum VMATRESETTYPE
45{
46 /** Device callback. */
47 VMATRESETTYPE_DEV = 1,
48 /** Internal callback . */
49 VMATRESETTYPE_INTERNAL,
50 /** External callback. */
51 VMATRESETTYPE_EXTERNAL
52} VMATRESETTYPE;
53
54
55/** Pointer to at-reset callback. */
56typedef struct VMATRESET *PVMATRESET;
57
58/**
59 * At reset callback.
60 */
61typedef struct VMATRESET
62{
63 /** Pointer to the next one in the list. */
64 PVMATRESET pNext;
65 /** Callback type. */
66 VMATRESETTYPE enmType;
67 /** User argument for the callback. */
68 void *pvUser;
69 /** Description. */
70 const char *pszDesc;
71 /** Type specific data. */
72 union
73 {
74 /** VMATRESETTYPE_DEV. */
75 struct
76 {
77 /** Callback. */
78 PFNVMATRESET pfnCallback;
79 /** Device instance. */
80 PPDMDEVINS pDevIns;
81 } Dev;
82
83 /** VMATRESETTYPE_INTERNAL. */
84 struct
85 {
86 /** Callback. */
87 PFNVMATRESETINT pfnCallback;
88 } Internal;
89
90 /** VMATRESETTYPE_EXTERNAL. */
91 struct
92 {
93 /** Callback. */
94 PFNVMATRESETEXT pfnCallback;
95 } External;
96 } u;
97} VMATRESET;
98
99
100/**
101 * VM state change callback.
102 */
103typedef struct VMATSTATE
104{
105 /** Pointer to the next one. */
106 struct VMATSTATE *pNext;
107 /** Pointer to the callback. */
108 PFNVMATSTATE pfnAtState;
109 /** The user argument. */
110 void *pvUser;
111} VMATSTATE;
112/** Pointer to a VM state change callback. */
113typedef VMATSTATE *PVMATSTATE;
114
115
116/**
117 * VM error callback.
118 */
119typedef struct VMATERROR
120{
121 /** Pointer to the next one. */
122 struct VMATERROR *pNext;
123 /** Pointer to the callback. */
124 PFNVMATERROR pfnAtError;
125 /** The user argument. */
126 void *pvUser;
127} VMATERROR;
128/** Pointer to a VM error callback. */
129typedef VMATERROR *PVMATERROR;
130
131
132/**
133 * Chunk of memory allocated off the hypervisor heap in which
134 * we copy the error details.
135 */
136typedef struct VMERROR
137{
138 /** The size of the chunk. */
139 uint32_t cbAllocated;
140 /** The current offset into the chunk.
141 * We start by putting the filename and function immediatly
142 * after the end of the buffer. */
143 uint32_t off;
144 /** Offset from the start of this structure to the file name. */
145 uint32_t offFile;
146 /** The line number. */
147 uint32_t iLine;
148 /** Offset from the start of this structure to the function name. */
149 uint32_t offFunction;
150 /** Offset from the start of this structure to the formatted message text. */
151 uint32_t offMessage;
152 /** The VBox status code. */
153 int32_t rc;
154} VMERROR, *PVMERROR;
155
156
157/**
158 * VM runtime error callback.
159 */
160typedef struct VMATRUNTIMEERROR
161{
162 /** Pointer to the next one. */
163 struct VMATRUNTIMEERROR *pNext;
164 /** Pointer to the callback. */
165 PFNVMATRUNTIMEERROR pfnAtRuntimeError;
166 /** The user argument. */
167 void *pvUser;
168} VMATRUNTIMEERROR;
169/** Pointer to a VM error callback. */
170typedef VMATRUNTIMEERROR *PVMATRUNTIMEERROR;
171
172
173/**
174 * Chunk of memory allocated off the hypervisor heap in which
175 * we copy the runtime error details.
176 */
177typedef struct VMRUNTIMEERROR
178{
179 /** The size of the chunk. */
180 uint32_t cbAllocated;
181 /** The current offset into the chunk.
182 * We start by putting the error ID immediatly
183 * after the end of the buffer. */
184 uint32_t off;
185 /** Offset from the start of this structure to the error ID. */
186 uint32_t offErrorID;
187 /** Offset from the start of this structure to the formatted message text. */
188 uint32_t offMessage;
189 /** Whether the error is fatal or not */
190 bool fFatal;
191} VMRUNTIMEERROR, *PVMRUNTIMEERROR;
192
193
194/**
195 * Converts a VMM pointer into a VM pointer.
196 * @returns Pointer to the VM structure the VMM is part of.
197 * @param pVMM Pointer to VMM instance data.
198 */
199#define VMINT2VM(pVMM) ( (PVM)((char*)pVMM - pVMM->offVM) )
200
201
202/**
203 * VM Internal Data (part of VM)
204 */
205typedef struct VMINT
206{
207 /** Offset to the VM structure.
208 * See VMINT2VM(). */
209 RTINT offVM;
210
211 /** List of registered reset callbacks. */
212 HCPTRTYPE(PVMATRESET) pAtReset;
213 /** List of registered reset callbacks. */
214 HCPTRTYPE(PVMATRESET *) ppAtResetNext;
215
216 /** List of registered state change callbacks. */
217 HCPTRTYPE(PVMATSTATE) pAtState;
218 /** List of registered state change callbacks. */
219 HCPTRTYPE(PVMATSTATE *) ppAtStateNext;
220
221 /** List of registered error callbacks. */
222 HCPTRTYPE(PVMATERROR) pAtError;
223 /** List of registered error callbacks. */
224 HCPTRTYPE(PVMATERROR *) ppAtErrorNext;
225
226 /** List of registered error callbacks. */
227 HCPTRTYPE(PVMATRUNTIMEERROR) pAtRuntimeError;
228 /** List of registered error callbacks. */
229 HCPTRTYPE(PVMATRUNTIMEERROR *) ppAtRuntimeErrorNext;
230
231 /** Head of the request queue. Atomic. */
232 volatile HCPTRTYPE(PVMREQ) pReqs;
233 /** The last index used during alloc/free. */
234 volatile uint32_t iReqFree;
235 /** Array of pointers to lists of free request packets. Atomic. */
236 volatile HCPTRTYPE(PVMREQ) apReqFree[9];
237 /** Number of free request packets. */
238 volatile uint32_t cReqFree;
239
240 /** Wait/Idle indicator. */
241 volatile uint32_t fWait;
242 /** Wait event semaphore. */
243 HCPTRTYPE(RTSEMEVENT) EventSemWait;
244
245 /** VM Error Message. */
246 R3PTRTYPE(PVMERROR) pErrorR3;
247
248 /** VM Runtime Error Message. */
249 R3PTRTYPE(PVMRUNTIMEERROR) pRuntimeErrorR3;
250
251 /** Pointer to the DBGC instance data. */
252 HCPTRTYPE(void *) pvDBGC;
253
254 /** If set the EMT does the final VM cleanup when it exits.
255 * If clear the VMR3Destroy() caller does so. */
256 bool fEMTDoesTheCleanup;
257
258 /** Set by VMR3SuspendNoSave; cleared by VMR3Resume; signals the VM is in an inconsistent state and saving is not allowed. */
259 bool fPreventSaveState;
260
261 /** vmR3EmulationThread longjmp buffer
262 * @todo r=bird: requires union with padding. See EMInternal.h. */
263 jmp_buf emtJumpEnv;
264
265 /** Number of VMR3ReqAlloc returning a new packet. */
266 STAMCOUNTER StatReqAllocNew;
267 /** Number of VMR3ReqAlloc causing races. */
268 STAMCOUNTER StatReqAllocRaces;
269 /** Number of VMR3ReqAlloc returning a recycled packet. */
270 STAMCOUNTER StatReqAllocRecycled;
271 /** Number of VMR3ReqFree calls. */
272 STAMCOUNTER StatReqFree;
273 /** Number of times the request was actually freed. */
274 STAMCOUNTER StatReqFreeOverflow;
275
276 /** Profiling the halted state; yielding vs blocking. */
277 STAMPROFILEADV StatHaltYield;
278 STAMPROFILEADV StatHaltBlock;
279 STAMPROFILEADV StatHaltTimers;
280 STAMPROFILEADV StatHaltPoll;
281} VMINT, *PVMINT;
282
283
284/**
285 * Emulation thread arguments.
286 */
287typedef struct VMEMULATIONTHREADARGS
288{
289 /** Pointer to the VM structure. */
290 PVM pVM;
291} VMEMULATIONTHREADARGS;
292/** Pointer to the emulation thread arguments. */
293typedef VMEMULATIONTHREADARGS *PVMEMULATIONTHREADARGS;
294
295DECLCALLBACK(int) vmR3EmulationThread(RTTHREAD ThreadSelf, void *pvArg);
296DECLCALLBACK(int) vmR3Destroy(PVM pVM);
297DECLCALLBACK(void) vmR3SetErrorV(PVM pVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list *args);
298void vmSetErrorCopy(PVM pVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list args);
299DECLCALLBACK(void) vmR3SetRuntimeErrorV(PVM pVM, bool fFatal, const char *pszErrorID, const char *pszFormat, va_list *args);
300void vmSetRuntimeErrorCopy(PVM pVM, bool fFatal, const char *pszErrorID, const char *pszFormat, va_list args);
301void vmR3DestroyFinalBit(PVM pVM);
302
303
304/** @} */
305
306#endif
307
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