VirtualBox

source: vbox/trunk/include/VBox/vmapi.h@ 18677

Last change on this file since 18677 was 18649, checked in by vboxsync, 16 years ago

VMSetRuntimeError: clearification, status codes *must* be propagated, there are no FFs mopping them up.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.3 KB
Line 
1/** @file
2 * VM - The Virtual Machine, API.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___VBox_vmapi_h
31#define ___VBox_vmapi_h
32
33#include <VBox/cdefs.h>
34#include <VBox/types.h>
35#include <VBox/stam.h>
36#include <VBox/cfgm.h>
37
38#include <iprt/stdarg.h>
39
40__BEGIN_DECLS
41
42/** @defgroup grp_vmm_apis VM All Contexts API
43 * @ingroup grp_vm
44 * @{ */
45
46/** @def VM_RC_ADDR
47 * Converts a current context address of data within the VM structure to the equivalent
48 * raw-mode address.
49 *
50 * @returns raw-mode virtual address.
51 * @param pVM Pointer to the VM.
52 * @param pvInVM CC Pointer within the VM.
53 */
54#ifdef IN_RING3
55# define VM_RC_ADDR(pVM, pvInVM) ( (RTRCPTR)((RTRCUINTPTR)pVM->pVMRC + (uint32_t)((uintptr_t)(pvInVM) - (uintptr_t)pVM->pVMR3)) )
56#elif defined(IN_RING0)
57# define VM_RC_ADDR(pVM, pvInVM) ( (RTRCPTR)((RTRCUINTPTR)pVM->pVMRC + (uint32_t)((uintptr_t)(pvInVM) - (uintptr_t)pVM->pVMR0)) )
58#else
59# define VM_RC_ADDR(pVM, pvInVM) ( (RTRCPTR)(pvInVM) )
60#endif
61
62/** @def VM_R3_ADDR
63 * Converts a current context address of data within the VM structure to the equivalent
64 * ring-3 host address.
65 *
66 * @returns host virtual address.
67 * @param pVM Pointer to the VM.
68 * @param pvInVM CC pointer within the VM.
69 */
70#ifdef IN_RC
71# define VM_R3_ADDR(pVM, pvInVM) ( (RTR3PTR)((RTR3UINTPTR)pVM->pVMR3 + (uint32_t)((uintptr_t)(pvInVM) - (uintptr_t)pVM->pVMRC)) )
72#elif defined(IN_RING0)
73# define VM_R3_ADDR(pVM, pvInVM) ( (RTR3PTR)((RTR3UINTPTR)pVM->pVMR3 + (uint32_t)((uintptr_t)(pvInVM) - (uintptr_t)pVM->pVMR0)) )
74#else
75# define VM_R3_ADDR(pVM, pvInVM) ( (RTR3PTR)(pvInVM) )
76#endif
77
78
79/** @def VM_R0_ADDR
80 * Converts a current context address of data within the VM structure to the equivalent
81 * ring-0 host address.
82 *
83 * @returns host virtual address.
84 * @param pVM Pointer to the VM.
85 * @param pvInVM CC pointer within the VM.
86 */
87#ifdef IN_RC
88# define VM_R0_ADDR(pVM, pvInVM) ( (RTR0PTR)((RTR0UINTPTR)pVM->pVMR0 + (uint32_t)((uintptr_t)(pvInVM) - (uintptr_t)pVM->pVMRC)) )
89#elif defined(IN_RING3)
90# define VM_R0_ADDR(pVM, pvInVM) ( (RTR0PTR)((RTR0UINTPTR)pVM->pVMR0 + (uint32_t)((uintptr_t)(pvInVM) - (uintptr_t)pVM->pVMR3)) )
91#else
92# define VM_R0_ADDR(pVM, pvInVM) ( (RTR0PTR)(pvInVM) )
93#endif
94
95
96
97/**
98 * VM error callback function.
99 *
100 * @param pVM The VM handle. Can be NULL if an error occurred before
101 * successfully creating a VM.
102 * @param pvUser The user argument.
103 * @param rc VBox status code.
104 * @param RT_SRC_POS_DECL The source position arguments. See RT_SRC_POS and RT_SRC_POS_ARGS.
105 * @param pszFormat Error message format string.
106 * @param args Error message arguments.
107 */
108typedef DECLCALLBACK(void) FNVMATERROR(PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL, const char *pszError, va_list args);
109/** Pointer to a VM error callback. */
110typedef FNVMATERROR *PFNVMATERROR;
111
112VMMDECL(int) VMSetError(PVM pVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
113VMMDECL(int) VMSetErrorV(PVM pVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list args);
114
115/** @def VM_SET_ERROR
116 * Macro for setting a simple VM error message.
117 * Don't use '%' in the message!
118 *
119 * @returns rc. Meaning you can do:
120 * @code
121 * return VM_SET_ERROR(pVM, VERR_OF_YOUR_CHOICE, "descriptive message");
122 * @endcode
123 * @param pVM VM handle.
124 * @param rc VBox status code.
125 * @param pszMessage Error message string.
126 * @thread Any
127 */
128#define VM_SET_ERROR(pVM, rc, pszMessage) (VMSetError(pVM, rc, RT_SRC_POS, pszMessage))
129
130
131/**
132 * VM runtime error callback function.
133 *
134 * See VMSetRuntimeError for the detailed description of parameters.
135 *
136 * @param pVM The VM handle.
137 * @param pvUser The user argument.
138 * @param fFlags The error flags.
139 * @param pszErrorId Error ID string.
140 * @param pszFormat Error message format string.
141 * @param va Error message arguments.
142 */
143typedef DECLCALLBACK(void) FNVMATRUNTIMEERROR(PVM pVM, void *pvUser, uint32_t fFlags, const char *pszErrorId,
144 const char *pszFormat, va_list va);
145/** Pointer to a VM runtime error callback. */
146typedef FNVMATRUNTIMEERROR *PFNVMATRUNTIMEERROR;
147
148VMMDECL(int) VMSetRuntimeError(PVM pVM, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, ...);
149VMMDECL(int) VMSetRuntimeErrorV(PVM pVM, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list args);
150
151/** @name VMSetRuntimeError fFlags
152 * When no flags are given the VM will continue running and it's up to the front
153 * end to take action on the error condition.
154 *
155 * @{ */
156/** The error is fatal.
157 * The VM is not in a state where it can be saved and will enter a state
158 * where it can no longer execute code. The caller <b>must</b> propagate status
159 * codes. */
160#define VMSETRTERR_FLAGS_FATAL RT_BIT_32(0)
161/** Suspend the VM after, or if possible before, raising the error on EMT. The
162 * caller <b>must</b> propagate status codes. */
163#define VMSETRTERR_FLAGS_SUSPEND RT_BIT_32(1)
164/** Don't wait for the EMT to handle the request.
165 * Only valid when on a worker thread and there is a high risk of a dead
166 * lock. Be careful not to flood the user with errors. */
167#define VMSETRTERR_FLAGS_NO_WAIT RT_BIT_32(2)
168/** @} */
169
170
171/**
172 * VM reset callback.
173 *
174 * @returns VBox status code.
175 * @param pDevInst Device instance of the device which registered the callback.
176 * @param pvUser User argument.
177 */
178typedef DECLCALLBACK(int) FNVMATRESET(PPDMDEVINS pDevInst, void *pvUser);
179/** VM reset callback. */
180typedef FNVMATRESET *PFNVMATRESET;
181
182/**
183 * VM reset internal callback.
184 *
185 * @returns VBox status code.
186 * @param pVM The VM which is begin reset.
187 * @param pvUser User argument.
188 */
189typedef DECLCALLBACK(int) FNVMATRESETINT(PVM pVM, void *pvUser);
190/** VM reset internal callback. */
191typedef FNVMATRESETINT *PFNVMATRESETINT;
192
193/**
194 * VM reset external callback.
195 *
196 * @param pvUser User argument.
197 */
198typedef DECLCALLBACK(void) FNVMATRESETEXT(void *pvUser);
199/** VM reset external callback. */
200typedef FNVMATRESETEXT *PFNVMATRESETEXT;
201
202
203/**
204 * VM state callback function.
205 *
206 * You are not allowed to call any function which changes the VM state from a
207 * state callback, except VMR3Destroy().
208 *
209 * @param pVM The VM handle.
210 * @param enmState The new state.
211 * @param enmOldState The old state.
212 * @param pvUser The user argument.
213 */
214typedef DECLCALLBACK(void) FNVMATSTATE(PVM pVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser);
215/** Pointer to a VM state callback. */
216typedef FNVMATSTATE *PFNVMATSTATE;
217
218VMMDECL(const char *) VMGetStateName(VMSTATE enmState);
219
220
221/**
222 * Request type.
223 */
224typedef enum VMREQTYPE
225{
226 /** Invalid request. */
227 VMREQTYPE_INVALID = 0,
228 /** VM: Internal. */
229 VMREQTYPE_INTERNAL,
230 /** Maximum request type (exclusive). Used for validation. */
231 VMREQTYPE_MAX
232} VMREQTYPE;
233
234/**
235 * Request state.
236 */
237typedef enum VMREQSTATE
238{
239 /** The state is invalid. */
240 VMREQSTATE_INVALID = 0,
241 /** The request have been allocated and is in the process of being filed. */
242 VMREQSTATE_ALLOCATED,
243 /** The request is queued by the requester. */
244 VMREQSTATE_QUEUED,
245 /** The request is begin processed. */
246 VMREQSTATE_PROCESSING,
247 /** The request is completed, the requester is begin notified. */
248 VMREQSTATE_COMPLETED,
249 /** The request packet is in the free chain. (The requester */
250 VMREQSTATE_FREE
251} VMREQSTATE;
252
253/**
254 * Request flags.
255 */
256typedef enum VMREQFLAGS
257{
258 /** The request returns a VBox status code. */
259 VMREQFLAGS_VBOX_STATUS = 0,
260 /** The request is a void request and have no status code. */
261 VMREQFLAGS_VOID = 1,
262 /** Return type mask. */
263 VMREQFLAGS_RETURN_MASK = 1,
264 /** Caller does not wait on the packet, EMT will free it. */
265 VMREQFLAGS_NO_WAIT = 2
266} VMREQFLAGS;
267
268/**
269 * Request destination
270 */
271typedef enum VMREQDEST
272{
273 /** Request packet for VCPU 0. */
274 VMREQDEST_CPU0 = 0,
275
276 /** Request packet for all VMCPU threads. */
277 VMREQDEST_BROADCAST = 0x1000,
278
279 /** Request packet for any VMCPU thread. */
280 VMREQDEST_ANY = 0x1001
281} VMREQDEST;
282
283/**
284 * VM Request packet.
285 *
286 * This is used to request an action in the EMT. Usually the requester is
287 * another thread, but EMT can also end up being the requester in which case
288 * it's carried out synchronously.
289 */
290typedef struct VMREQ
291{
292 /** Pointer to the next request in the chain. */
293 struct VMREQ * volatile pNext;
294 /** Pointer to ring-3 VM structure which this request belongs to. */
295 PUVM pUVM;
296 /** Request state. */
297 volatile VMREQSTATE enmState;
298 /** VBox status code for the completed request. */
299 volatile int iStatus;
300 /** Requester event sem.
301 * The request can use this event semaphore to wait/poll for completion
302 * of the request.
303 */
304 RTSEMEVENT EventSem;
305 /** Set if the event semaphore is clear. */
306 volatile bool fEventSemClear;
307 /** Flags, VMR3REQ_FLAGS_*. */
308 unsigned fFlags;
309 /** Request type. */
310 VMREQTYPE enmType;
311 /** Request destination. */
312 VMREQDEST enmDest;
313 /** Request specific data. */
314 union VMREQ_U
315 {
316 /** VMREQTYPE_INTERNAL. */
317 struct
318 {
319 /** Pointer to the function to be called. */
320 PFNRT pfn;
321 /** Number of arguments. */
322 unsigned cArgs;
323 /** Array of arguments. */
324 uintptr_t aArgs[64];
325 } Internal;
326 } u;
327} VMREQ;
328/** Pointer to a VM request packet. */
329typedef VMREQ *PVMREQ;
330
331/** @} */
332
333
334#ifndef IN_RC
335/** @defgroup grp_vmm_apis_hc VM Host Context API
336 * @ingroup grp_vm
337 * @{ */
338
339/** @} */
340#endif
341
342
343#ifdef IN_RING3
344/** @defgroup grp_vmm_apis_r3 VM Host Context Ring 3 API
345 * This interface is a _draft_!
346 * @ingroup grp_vm
347 * @{ */
348
349/**
350 * Completion notification codes.
351 */
352typedef enum VMINITCOMPLETED
353{
354 /** The Ring3 init is completed. */
355 VMINITCOMPLETED_RING3 = 1,
356 /** The Ring0 init is completed. */
357 VMINITCOMPLETED_RING0,
358 /** The GC init is completed. */
359 VMINITCOMPLETED_GC
360} VMINITCOMPLETED;
361
362
363VMMR3DECL(int) VMR3Create(uint32_t cCPUs, PFNVMATERROR pfnVMAtError, void *pvUserVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUserCFGM, PVM *ppVM);
364VMMR3DECL(int) VMR3PowerOn(PVM pVM);
365VMMR3DECL(int) VMR3Suspend(PVM pVM);
366VMMR3DECL(int) VMR3SuspendNoSave(PVM pVM);
367VMMR3DECL(int) VMR3Resume(PVM pVM);
368VMMR3DECL(int) VMR3Reset(PVM pVM);
369
370/**
371 * Progress callback.
372 * This will report the completion percentage of an operation.
373 *
374 * @returns VINF_SUCCESS.
375 * @returns Error code to cancel the operation with.
376 * @param pVM The VM handle.
377 * @param uPercent Completetion precentage (0-100).
378 * @param pvUser User specified argument.
379 */
380typedef DECLCALLBACK(int) FNVMPROGRESS(PVM pVM, unsigned uPercent, void *pvUser);
381/** Pointer to a FNVMPROGRESS function. */
382typedef FNVMPROGRESS *PFNVMPROGRESS;
383
384VMMR3DECL(int) VMR3Save(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser);
385VMMR3DECL(int) VMR3Load(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser);
386VMMR3DECL(int) VMR3PowerOff(PVM pVM);
387VMMR3DECL(int) VMR3Destroy(PVM pVM);
388VMMR3DECL(void) VMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
389VMMR3DECL(PVM) VMR3EnumVMs(PVM pVMPrev);
390VMMR3DECL(int) VMR3WaitForResume(PVM pVM);
391
392/**
393 * VM destruction callback.
394 * @param pVM The VM which is about to be destroyed.
395 * @param pvUser The user parameter specified at registration.
396 */
397typedef DECLCALLBACK(void) FNVMATDTOR(PVM pVM, void *pvUser);
398/** Pointer to a VM destruction callback. */
399typedef FNVMATDTOR *PFNVMATDTOR;
400
401VMMR3DECL(int) VMR3AtDtorRegister(PFNVMATDTOR pfnAtDtor, void *pvUser);
402VMMR3DECL(int) VMR3AtDtorDeregister(PFNVMATDTOR pfnAtDtor);
403VMMR3DECL(int) VMR3AtResetRegister(PVM pVM, PPDMDEVINS pDevInst, PFNVMATRESET pfnCallback, void *pvUser, const char *pszDesc);
404VMMR3DECL(int) VMR3AtResetRegisterInternal(PVM pVM, PFNVMATRESETINT pfnCallback, void *pvUser, const char *pszDesc);
405VMMR3DECL(int) VMR3AtResetRegisterExternal(PVM pVM, PFNVMATRESETEXT pfnCallback, void *pvUser, const char *pszDesc);
406VMMR3DECL(int) VMR3AtResetDeregister(PVM pVM, PPDMDEVINS pDevInst, PFNVMATRESET pfnCallback);
407VMMR3DECL(int) VMR3AtResetDeregisterInternal(PVM pVM, PFNVMATRESETINT pfnCallback);
408VMMR3DECL(int) VMR3AtResetDeregisterExternal(PVM pVM, PFNVMATRESETEXT pfnCallback);
409VMMR3DECL(int) VMR3AtStateRegister(PVM pVM, PFNVMATSTATE pfnAtState, void *pvUser);
410VMMR3DECL(int) VMR3AtStateDeregister(PVM pVM, PFNVMATSTATE pfnAtState, void *pvUser);
411VMMR3DECL(VMSTATE) VMR3GetState(PVM pVM);
412VMMR3DECL(const char *) VMR3GetStateName(VMSTATE enmState);
413VMMR3DECL(int) VMR3AtErrorRegister(PVM pVM, PFNVMATERROR pfnAtError, void *pvUser);
414VMMR3DECL(int) VMR3AtErrorRegisterU(PUVM pVM, PFNVMATERROR pfnAtError, void *pvUser);
415VMMR3DECL(int) VMR3AtErrorDeregister(PVM pVM, PFNVMATERROR pfnAtError, void *pvUser);
416VMMR3DECL(void) VMR3SetErrorWorker(PVM pVM);
417VMMR3DECL(int) VMR3AtRuntimeErrorRegister(PVM pVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser);
418VMMR3DECL(int) VMR3AtRuntimeErrorDeregister(PVM pVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser);
419VMMR3DECL(int) VMR3SetRuntimeErrorWorker(PVM pVM);
420VMMR3DECL(int) VMR3ReqCall(PVM pVM, VMREQDEST enmDest, PVMREQ *ppReq, unsigned cMillies, PFNRT pfnFunction, unsigned cArgs, ...);
421VMMR3DECL(int) VMR3ReqCallVoidU(PUVM pUVM, VMREQDEST enmDest, PVMREQ *ppReq, unsigned cMillies, PFNRT pfnFunction, unsigned cArgs, ...);
422VMMR3DECL(int) VMR3ReqCallVoid(PVM pVM, VMREQDEST enmDest, PVMREQ *ppReq, unsigned cMillies, PFNRT pfnFunction, unsigned cArgs, ...);
423VMMR3DECL(int) VMR3ReqCallEx(PVM pVM, VMREQDEST enmDest, PVMREQ *ppReq, unsigned cMillies, unsigned fFlags, PFNRT pfnFunction, unsigned cArgs, ...);
424VMMR3DECL(int) VMR3ReqCallU(PUVM pUVM, VMREQDEST enmDest, PVMREQ *ppReq, unsigned cMillies, unsigned fFlags, PFNRT pfnFunction, unsigned cArgs, ...);
425VMMR3DECL(int) VMR3ReqCallVU(PUVM pUVM, VMREQDEST enmDest, PVMREQ *ppReq, unsigned cMillies, unsigned fFlags, PFNRT pfnFunction, unsigned cArgs, va_list Args);
426VMMR3DECL(int) VMR3ReqAlloc(PVM pVM, PVMREQ *ppReq, VMREQTYPE enmType, VMREQDEST enmDest);
427VMMR3DECL(int) VMR3ReqAllocU(PUVM pUVM, PVMREQ *ppReq, VMREQTYPE enmType, VMREQDEST enmDest);
428VMMR3DECL(int) VMR3ReqFree(PVMREQ pReq);
429VMMR3DECL(int) VMR3ReqQueue(PVMREQ pReq, unsigned cMillies);
430VMMR3DECL(int) VMR3ReqWait(PVMREQ pReq, unsigned cMillies);
431VMMR3DECL(int) VMR3ReqProcessU(PUVM pUVM, VMREQDEST enmDest);
432VMMR3DECL(void) VMR3NotifyFF(PVM pVM, bool fNotifiedREM);
433VMMR3DECL(void) VMR3NotifyFFU(PUVM pUVM, bool fNotifiedREM);
434VMMR3DECL(int) VMR3WaitHalted(PVM pVM, bool fIgnoreInterrupts);
435VMMR3DECL(int) VMR3WaitU(PUVM pUVM);
436VMMR3DECL(RTCPUID) VMR3GetVMCPUId(PVM pVM);
437VMMR3DECL(RTTHREAD) VMR3GetVMCPUThread(PVM pVM);
438VMMR3DECL(RTTHREAD) VMR3GetVMCPUThreadU(PUVM pUVM);
439VMMR3DECL(RTNATIVETHREAD) VMR3GetVMCPUNativeThread(PVM pVM);
440VMMR3DECL(RTNATIVETHREAD) VMR3GetVMCPUNativeThreadU(PUVM pUVM);
441
442/** @} */
443#endif /* IN_RING3 */
444
445
446#ifdef IN_RC
447/** @defgroup grp_vmm_apis_gc VM Guest Context APIs
448 * @ingroup grp_vm
449 * @{ */
450
451/** @} */
452#endif
453
454__END_DECLS
455
456/** @} */
457
458#endif
459
460
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