VirtualBox

source: vbox/trunk/src/VBox/VMM/VM.cpp@ 22122

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

VMM: gcc warnings and a todo.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 110.3 KB
Line 
1/* $Id: VM.cpp 22122 2009-08-10 09:55:05Z vboxsync $ */
2/** @file
3 * VM - Virtual Machine
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/** @page pg_vm VM API
23 *
24 * This is the encapsulating bit. It provides the APIs that Main and VBoxBFE
25 * use to create a VMM instance for running a guest in. It also provides
26 * facilities for queuing request for execution in EMT (serialization purposes
27 * mostly) and for reporting error back to the VMM user (Main/VBoxBFE).
28 *
29 *
30 * @section sec_vm_design Design Critique / Things To Do
31 *
32 * In hindsight this component is a big design mistake, all this stuff really
33 * belongs in the VMM component. It just seemed like a kind of ok idea at a
34 * time when the VMM bit was a bit vague. 'VM' also happend to be the name of
35 * the per-VM instance structure (see vm.h), so it kind of made sense. However
36 * as it turned out, VMM(.cpp) is almost empty all it provides in ring-3 is some
37 * minor functionally and some "routing" services.
38 *
39 * Fixing this is just a matter of some more or less straight forward
40 * refactoring, the question is just when someone will get to it.
41 *
42 */
43
44/*******************************************************************************
45* Header Files *
46*******************************************************************************/
47#define LOG_GROUP LOG_GROUP_VM
48#include <VBox/cfgm.h>
49#include <VBox/vmm.h>
50#include <VBox/gvmm.h>
51#include <VBox/mm.h>
52#include <VBox/cpum.h>
53#include <VBox/selm.h>
54#include <VBox/trpm.h>
55#include <VBox/dbgf.h>
56#include <VBox/pgm.h>
57#include <VBox/pdmapi.h>
58#include <VBox/pdmcritsect.h>
59#include <VBox/em.h>
60#include <VBox/rem.h>
61#include <VBox/tm.h>
62#include <VBox/stam.h>
63#include <VBox/patm.h>
64#ifdef VBOX_WITH_VMI
65# include <VBox/parav.h>
66#endif
67#include <VBox/csam.h>
68#include <VBox/iom.h>
69#include <VBox/ssm.h>
70#include <VBox/hwaccm.h>
71#include "VMInternal.h"
72#include <VBox/vm.h>
73#include <VBox/uvm.h>
74
75#include <VBox/sup.h>
76#include <VBox/dbg.h>
77#include <VBox/err.h>
78#include <VBox/param.h>
79#include <VBox/log.h>
80#include <iprt/assert.h>
81#include <iprt/alloc.h>
82#include <iprt/asm.h>
83#include <iprt/env.h>
84#include <iprt/string.h>
85#include <iprt/time.h>
86#include <iprt/semaphore.h>
87#include <iprt/thread.h>
88
89
90/*******************************************************************************
91* Structures and Typedefs *
92*******************************************************************************/
93/**
94 * VM destruction callback registration record.
95 */
96typedef struct VMATDTOR
97{
98 /** Pointer to the next record in the list. */
99 struct VMATDTOR *pNext;
100 /** Pointer to the callback function. */
101 PFNVMATDTOR pfnAtDtor;
102 /** The user argument. */
103 void *pvUser;
104} VMATDTOR;
105/** Pointer to a VM destruction callback registration record. */
106typedef VMATDTOR *PVMATDTOR;
107
108
109/*******************************************************************************
110* Global Variables *
111*******************************************************************************/
112/** Pointer to the list of VMs. */
113static PUVM g_pUVMsHead = NULL;
114
115/** Pointer to the list of at VM destruction callbacks. */
116static PVMATDTOR g_pVMAtDtorHead = NULL;
117/** Lock the g_pVMAtDtorHead list. */
118#define VM_ATDTOR_LOCK() do { } while (0)
119/** Unlock the g_pVMAtDtorHead list. */
120#define VM_ATDTOR_UNLOCK() do { } while (0)
121
122
123/*******************************************************************************
124* Internal Functions *
125*******************************************************************************/
126static int vmR3CreateUVM(uint32_t cCPUs, PUVM *ppUVM);
127static int vmR3CreateU(PUVM pUVM, uint32_t cCPUs, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUserCFGM);
128static int vmR3InitRing3(PVM pVM, PUVM pUVM);
129static int vmR3InitVMCpu(PVM pVM);
130static int vmR3InitRing0(PVM pVM);
131static int vmR3InitGC(PVM pVM);
132static int vmR3InitDoCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
133static DECLCALLBACK(size_t) vmR3LogPrefixCallback(PRTLOGGER pLogger, char *pchBuf, size_t cchBuf, void *pvUser);
134static DECLCALLBACK(int) vmR3PowerOn(PVM pVM);
135static DECLCALLBACK(int) vmR3Suspend(PVM pVM);
136static DECLCALLBACK(int) vmR3Resume(PVM pVM);
137static DECLCALLBACK(int) vmR3Save(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser);
138static DECLCALLBACK(int) vmR3Load(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser);
139static DECLCALLBACK(int) vmR3PowerOff(PVM pVM);
140static void vmR3DestroyUVM(PUVM pUVM, uint32_t cMilliesEMTWait);
141static void vmR3AtDtor(PVM pVM);
142static int vmR3AtResetU(PUVM pUVM);
143static DECLCALLBACK(int) vmR3Reset(PVM pVM);
144static DECLCALLBACK(int) vmR3AtStateRegisterU(PUVM pUVM, PFNVMATSTATE pfnAtState, void *pvUser);
145static DECLCALLBACK(int) vmR3AtStateDeregisterU(PUVM pUVM, PFNVMATSTATE pfnAtState, void *pvUser);
146static DECLCALLBACK(int) vmR3AtErrorRegisterU(PUVM pUVM, PFNVMATERROR pfnAtError, void *pvUser);
147static DECLCALLBACK(int) vmR3AtErrorDeregisterU(PUVM pUVM, PFNVMATERROR pfnAtError, void *pvUser);
148static int vmR3SetErrorU(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
149static DECLCALLBACK(int) vmR3AtRuntimeErrorRegisterU(PUVM pUVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser);
150static DECLCALLBACK(int) vmR3AtRuntimeErrorDeregisterU(PUVM pUVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser);
151
152
153/**
154 * Do global VMM init.
155 *
156 * @returns VBox status code.
157 */
158VMMR3DECL(int) VMR3GlobalInit(void)
159{
160 /*
161 * Only once.
162 */
163 static bool volatile s_fDone = false;
164 if (s_fDone)
165 return VINF_SUCCESS;
166
167 /*
168 * We're done.
169 */
170 s_fDone = true;
171 return VINF_SUCCESS;
172}
173
174
175
176/**
177 * Creates a virtual machine by calling the supplied configuration constructor.
178 *
179 * On successful returned the VM is powered, i.e. VMR3PowerOn() should be
180 * called to start the execution.
181 *
182 * @returns 0 on success.
183 * @returns VBox error code on failure.
184 * @param cCPUs Number of virtual CPUs for the new VM.
185 * @param pfnVMAtError Pointer to callback function for setting VM
186 * errors. This was added as an implicit call to
187 * VMR3AtErrorRegister() since there is no way the
188 * caller can get to the VM handle early enough to
189 * do this on its own.
190 * This is called in the context of an EMT.
191 * @param pvUserVM The user argument passed to pfnVMAtError.
192 * @param pfnCFGMConstructor Pointer to callback function for constructing the VM configuration tree.
193 * This is called in the context of an EMT0.
194 * @param pvUserCFGM The user argument passed to pfnCFGMConstructor.
195 * @param ppVM Where to store the 'handle' of the created VM.
196 */
197VMMR3DECL(int) VMR3Create(uint32_t cCPUs, PFNVMATERROR pfnVMAtError, void *pvUserVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUserCFGM, PVM *ppVM)
198{
199 LogFlow(("VMR3Create: cCPUs=%RU32 pfnVMAtError=%p pvUserVM=%p pfnCFGMConstructor=%p pvUserCFGM=%p ppVM=%p\n", cCPUs, pfnVMAtError, pvUserVM, pfnCFGMConstructor, pvUserCFGM, ppVM));
200
201 /*
202 * Because of the current hackiness of the applications
203 * we'll have to initialize global stuff from here.
204 * Later the applications will take care of this in a proper way.
205 */
206 static bool fGlobalInitDone = false;
207 if (!fGlobalInitDone)
208 {
209 int rc = VMR3GlobalInit();
210 if (RT_FAILURE(rc))
211 return rc;
212 fGlobalInitDone = true;
213 }
214
215 /*
216 * Validate input.
217 */
218 AssertLogRelMsgReturn(cCPUs > 0 && cCPUs <= VMM_MAX_CPU_COUNT, ("%RU32\n", cCPUs), VERR_TOO_MANY_CPUS);
219
220 /*
221 * Create the UVM so we can register the at-error callback
222 * and consoliate a bit of cleanup code.
223 */
224 PUVM pUVM = NULL; /* shuts up gcc */
225 int rc = vmR3CreateUVM(cCPUs, &pUVM);
226 if (RT_FAILURE(rc))
227 return rc;
228 if (pfnVMAtError)
229 rc = VMR3AtErrorRegisterU(pUVM, pfnVMAtError, pvUserVM);
230 if (RT_SUCCESS(rc))
231 {
232 /*
233 * Initialize the support library creating the session for this VM.
234 */
235 rc = SUPR3Init(&pUVM->vm.s.pSession);
236 if (RT_SUCCESS(rc))
237 {
238 /*
239 * Call vmR3CreateU in the EMT thread and wait for it to finish.
240 *
241 * Note! VMCPUID_ANY is used here because VMR3ReqQueueU would have trouble
242 * submitting a request to a specific VCPU without a pVM. So, to make
243 * sure init is running on EMT(0), vmR3EmulationThreadWithId makes sure
244 * that only EMT(0) is servicing VMCPUID_ANY requests when pVM is NULL.
245 */
246 PVMREQ pReq;
247 rc = VMR3ReqCallU(pUVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, 0, (PFNRT)vmR3CreateU, 4,
248 pUVM, cCPUs, pfnCFGMConstructor, pvUserCFGM);
249 if (RT_SUCCESS(rc))
250 {
251 rc = pReq->iStatus;
252 VMR3ReqFree(pReq);
253 if (RT_SUCCESS(rc))
254 {
255 /*
256 * Success!
257 */
258 *ppVM = pUVM->pVM;
259 LogFlow(("VMR3Create: returns VINF_SUCCESS *ppVM=%p\n", *ppVM));
260 return VINF_SUCCESS;
261 }
262 }
263 else
264 AssertMsgFailed(("VMR3ReqCall failed rc=%Rrc\n", rc));
265
266 /*
267 * An error occurred during VM creation. Set the error message directly
268 * using the initial callback, as the callback list doesn't exist yet.
269 */
270 const char *pszError = NULL;
271 switch (rc)
272 {
273 case VERR_VMX_IN_VMX_ROOT_MODE:
274#ifdef RT_OS_LINUX
275 pszError = N_("VirtualBox can't operate in VMX root mode. "
276 "Please disable the KVM kernel extension, recompile your kernel and reboot");
277#else
278 pszError = N_("VirtualBox can't operate in VMX root mode. Please close all other virtualization programs.");
279#endif
280 break;
281
282 case VERR_VERSION_MISMATCH:
283 pszError = N_("VMMR0 driver version mismatch. Please terminate all VMs, make sure that "
284 "VBoxNetDHCP is not running and try again. If you still get this error, "
285 "re-install VirtualBox");
286 break;
287
288#ifdef RT_OS_LINUX
289 case VERR_SUPDRV_COMPONENT_NOT_FOUND:
290 pszError = N_("One of the kernel modules was not successfully loaded. Make sure "
291 "that no kernel modules from an older version of VirtualBox exist. "
292 "Then try to recompile and reload the kernel modules by executing "
293 "'/etc/init.d/vboxdrv setup' as root");
294 break;
295#endif
296
297 default:
298 pszError = N_("Unknown error creating VM");
299 break;
300 }
301 vmR3SetErrorU(pUVM, rc, RT_SRC_POS, pszError, rc);
302 }
303 else
304 {
305 /*
306 * An error occurred at support library initialization time (before the
307 * VM could be created). Set the error message directly using the
308 * initial callback, as the callback list doesn't exist yet.
309 */
310 const char *pszError;
311 switch (rc)
312 {
313 case VERR_VM_DRIVER_LOAD_ERROR:
314#ifdef RT_OS_LINUX
315 pszError = N_("VirtualBox kernel driver not loaded. The vboxdrv kernel module "
316 "was either not loaded or /dev/vboxdrv is not set up properly. "
317 "Re-setup the kernel module by executing "
318 "'/etc/init.d/vboxdrv setup' as root");
319#else
320 pszError = N_("VirtualBox kernel driver not loaded");
321#endif
322 break;
323 case VERR_VM_DRIVER_OPEN_ERROR:
324 pszError = N_("VirtualBox kernel driver cannot be opened");
325 break;
326 case VERR_VM_DRIVER_NOT_ACCESSIBLE:
327#ifdef VBOX_WITH_HARDENING
328 /* This should only happen if the executable wasn't hardened - bad code/build. */
329 pszError = N_("VirtualBox kernel driver not accessible, permission problem. "
330 "Re-install VirtualBox. If you are building it yourself, you "
331 "should make sure it installed correctly and that the setuid "
332 "bit is set on the executables calling VMR3Create.");
333#else
334 /* This should only happen when mixing builds or with the usual /dev/vboxdrv access issues. */
335# if defined(RT_OS_DARWIN)
336 pszError = N_("VirtualBox KEXT is not accessible, permission problem. "
337 "If you have built VirtualBox yourself, make sure that you do not "
338 "have the vboxdrv KEXT from a different build or installation loaded.");
339# elif defined(RT_OS_LINUX)
340 pszError = N_("VirtualBox kernel driver is not accessible, permission problem. "
341 "If you have built VirtualBox yourself, make sure that you do "
342 "not have the vboxdrv kernel module from a different build or "
343 "installation loaded. Also, make sure the vboxdrv udev rule gives "
344 "you the permission you need to access the device.");
345# elif defined(RT_OS_WINDOWS)
346 pszError = N_("VirtualBox kernel driver is not accessible, permission problem.");
347# else /* solaris, freebsd, ++. */
348 pszError = N_("VirtualBox kernel module is not accessible, permission problem. "
349 "If you have built VirtualBox yourself, make sure that you do "
350 "not have the vboxdrv kernel module from a different install loaded.");
351# endif
352#endif
353 break;
354 case VERR_INVALID_HANDLE: /** @todo track down and fix this error. */
355 case VERR_VM_DRIVER_NOT_INSTALLED:
356#ifdef RT_OS_LINUX
357 pszError = N_("VirtualBox kernel driver not installed. The vboxdrv kernel module "
358 "was either not loaded or /dev/vboxdrv was not created for some "
359 "reason. Re-setup the kernel module by executing "
360 "'/etc/init.d/vboxdrv setup' as root");
361#else
362 pszError = N_("VirtualBox kernel driver not installed");
363#endif
364 break;
365 case VERR_NO_MEMORY:
366 pszError = N_("VirtualBox support library out of memory");
367 break;
368 case VERR_VERSION_MISMATCH:
369 case VERR_VM_DRIVER_VERSION_MISMATCH:
370 pszError = N_("The VirtualBox support driver which is running is from a different "
371 "version of VirtualBox. You can correct this by stopping all "
372 "running instances of VirtualBox and reinstalling the software.");
373 break;
374 default:
375 pszError = N_("Unknown error initializing kernel driver");
376 AssertMsgFailed(("Add error message for rc=%d (%Rrc)\n", rc, rc));
377 }
378 vmR3SetErrorU(pUVM, rc, RT_SRC_POS, pszError, rc);
379 }
380 }
381
382 /* cleanup */
383 vmR3DestroyUVM(pUVM, 2000);
384 LogFlow(("VMR3Create: returns %Rrc\n", rc));
385 return rc;
386}
387
388
389/**
390 * Creates the UVM.
391 *
392 * This will not initialize the support library even if vmR3DestroyUVM
393 * will terminate that.
394 *
395 * @returns VBox status code.
396 * @param cCpus Number of virtual CPUs
397 * @param ppUVM Where to store the UVM pointer.
398 */
399static int vmR3CreateUVM(uint32_t cCpus, PUVM *ppUVM)
400{
401 uint32_t i;
402
403 /*
404 * Create and initialize the UVM.
405 */
406 PUVM pUVM = (PUVM)RTMemAllocZ(RT_OFFSETOF(UVM, aCpus[cCpus]));
407 AssertReturn(pUVM, VERR_NO_MEMORY);
408 pUVM->u32Magic = UVM_MAGIC;
409 pUVM->cCpus = cCpus;
410
411 AssertCompile(sizeof(pUVM->vm.s) <= sizeof(pUVM->vm.padding));
412
413 pUVM->vm.s.ppAtResetNext = &pUVM->vm.s.pAtReset;
414 pUVM->vm.s.ppAtStateNext = &pUVM->vm.s.pAtState;
415 pUVM->vm.s.ppAtErrorNext = &pUVM->vm.s.pAtError;
416 pUVM->vm.s.ppAtRuntimeErrorNext = &pUVM->vm.s.pAtRuntimeError;
417
418 pUVM->vm.s.enmHaltMethod = VMHALTMETHOD_BOOTSTRAP;
419
420 /* Initialize the VMCPU array in the UVM. */
421 for (i = 0; i < cCpus; i++)
422 {
423 pUVM->aCpus[i].pUVM = pUVM;
424 pUVM->aCpus[i].idCpu = i;
425 }
426
427 /* Allocate a TLS entry to store the VMINTUSERPERVMCPU pointer. */
428 int rc = RTTlsAllocEx(&pUVM->vm.s.idxTLS, NULL);
429 AssertRC(rc);
430 if (RT_SUCCESS(rc))
431 {
432 /* Allocate a halt method event semaphore for each VCPU. */
433 for (i = 0; i < cCpus; i++)
434 {
435 rc = RTSemEventCreate(&pUVM->aCpus[i].vm.s.EventSemWait);
436 if (RT_FAILURE(rc))
437 break;
438 }
439
440 if (RT_SUCCESS(rc))
441 {
442 /*
443 * Init fundamental (sub-)components - STAM, MMR3Heap and PDMLdr.
444 */
445 rc = STAMR3InitUVM(pUVM);
446 if (RT_SUCCESS(rc))
447 {
448 rc = MMR3InitUVM(pUVM);
449 if (RT_SUCCESS(rc))
450 {
451 rc = PDMR3InitUVM(pUVM);
452 if (RT_SUCCESS(rc))
453 {
454 /*
455 * Start the emulation threads for all VMCPUs.
456 */
457 for (i = 0; i < cCpus; i++)
458 {
459 rc = RTThreadCreateF(&pUVM->aCpus[i].vm.s.ThreadEMT, vmR3EmulationThread, &pUVM->aCpus[i], _1M,
460 RTTHREADTYPE_EMULATION, RTTHREADFLAGS_WAITABLE,
461 cCpus > 1 ? "EMT-%u" : "EMT", i);
462 if (RT_FAILURE(rc))
463 break;
464
465 pUVM->aCpus[i].vm.s.NativeThreadEMT = RTThreadGetNative(pUVM->aCpus[i].vm.s.ThreadEMT);
466 }
467
468 if (RT_SUCCESS(rc))
469 {
470 *ppUVM = pUVM;
471 return VINF_SUCCESS;
472 }
473
474 /* bail out. */
475 while (i-- > 0)
476 {
477 /** @todo rainy day: terminate the EMTs. */
478 }
479 PDMR3TermUVM(pUVM);
480 }
481 MMR3TermUVM(pUVM);
482 }
483 STAMR3TermUVM(pUVM);
484 }
485 for (i = 0; i < cCpus; i++)
486 {
487 RTSemEventDestroy(pUVM->aCpus[i].vm.s.EventSemWait);
488 pUVM->aCpus[i].vm.s.EventSemWait = NIL_RTSEMEVENT;
489 }
490 }
491 RTTlsFree(pUVM->vm.s.idxTLS);
492 }
493 RTMemFree(pUVM);
494 return rc;
495}
496
497
498/**
499 * Creates and initializes the VM.
500 *
501 * @thread EMT
502 */
503static int vmR3CreateU(PUVM pUVM, uint32_t cCpus, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUserCFGM)
504{
505 int rc = VINF_SUCCESS;
506
507 /*
508 * Load the VMMR0.r0 module so that we can call GVMMR0CreateVM.
509 */
510 rc = PDMR3LdrLoadVMMR0U(pUVM);
511 if (RT_FAILURE(rc))
512 {
513 /** @todo we need a cleaner solution for this (VERR_VMX_IN_VMX_ROOT_MODE).
514 * bird: what about moving the message down here? Main picks the first message, right? */
515 if (rc == VERR_VMX_IN_VMX_ROOT_MODE)
516 return rc; /* proper error message set later on */
517 return vmR3SetErrorU(pUVM, rc, RT_SRC_POS, N_("Failed to load VMMR0.r0"));
518 }
519
520 /*
521 * Request GVMM to create a new VM for us.
522 */
523 GVMMCREATEVMREQ CreateVMReq;
524 CreateVMReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
525 CreateVMReq.Hdr.cbReq = sizeof(CreateVMReq);
526 CreateVMReq.pSession = pUVM->vm.s.pSession;
527 CreateVMReq.pVMR0 = NIL_RTR0PTR;
528 CreateVMReq.pVMR3 = NULL;
529 CreateVMReq.cCpus = cCpus;
530 rc = SUPR3CallVMMR0Ex(NIL_RTR0PTR, NIL_VMCPUID, VMMR0_DO_GVMM_CREATE_VM, 0, &CreateVMReq.Hdr);
531 if (RT_SUCCESS(rc))
532 {
533 PVM pVM = pUVM->pVM = CreateVMReq.pVMR3;
534 AssertRelease(VALID_PTR(pVM));
535 AssertRelease(pVM->pVMR0 == CreateVMReq.pVMR0);
536 AssertRelease(pVM->pSession == pUVM->vm.s.pSession);
537 AssertRelease(pVM->cCPUs == cCpus);
538 AssertRelease(pVM->offVMCPU == RT_UOFFSETOF(VM, aCpus));
539
540 Log(("VMR3Create: Created pUVM=%p pVM=%p pVMR0=%p hSelf=%#x cCPUs=%RU32\n",
541 pUVM, pVM, pVM->pVMR0, pVM->hSelf, pVM->cCPUs));
542
543 /*
544 * Initialize the VM structure and our internal data (VMINT).
545 */
546 pVM->pUVM = pUVM;
547
548 for (uint32_t i = 0; i < pVM->cCPUs; i++)
549 {
550 pVM->aCpus[i].pUVCpu = &pUVM->aCpus[i];
551 pVM->aCpus[i].idCpu = i;
552 pVM->aCpus[i].hNativeThread = pUVM->aCpus[i].vm.s.NativeThreadEMT;
553 Assert(pVM->aCpus[i].hNativeThread != NIL_RTNATIVETHREAD);
554
555 pUVM->aCpus[i].pVCpu = &pVM->aCpus[i];
556 pUVM->aCpus[i].pVM = pVM;
557 }
558
559
560 /*
561 * Init the configuration.
562 */
563 rc = CFGMR3Init(pVM, pfnCFGMConstructor, pvUserCFGM);
564 if (RT_SUCCESS(rc))
565 {
566 rc = CFGMR3QueryBoolDef(CFGMR3GetRoot(pVM), "HwVirtExtForced", &pVM->fHwVirtExtForced, false);
567 if (RT_SUCCESS(rc) && pVM->fHwVirtExtForced)
568 pVM->fHWACCMEnabled = true;
569
570 /*
571 * If executing in fake suplib mode disable RR3 and RR0 in the config.
572 */
573 const char *psz = RTEnvGet("VBOX_SUPLIB_FAKE");
574 if (psz && !strcmp(psz, "fake"))
575 {
576 CFGMR3RemoveValue(CFGMR3GetRoot(pVM), "RawR3Enabled");
577 CFGMR3InsertInteger(CFGMR3GetRoot(pVM), "RawR3Enabled", 0);
578 CFGMR3RemoveValue(CFGMR3GetRoot(pVM), "RawR0Enabled");
579 CFGMR3InsertInteger(CFGMR3GetRoot(pVM), "RawR0Enabled", 0);
580 }
581
582 /*
583 * Make sure the CPU count in the config data matches.
584 */
585 if (RT_SUCCESS(rc))
586 {
587 uint32_t cCPUsCfg;
588 rc = CFGMR3QueryU32Def(CFGMR3GetRoot(pVM), "NumCPUs", &cCPUsCfg, 1);
589 AssertLogRelMsgRC(rc, ("Configuration error: Querying \"NumCPUs\" as integer failed, rc=%Rrc\n", rc));
590 if (RT_SUCCESS(rc) && cCPUsCfg != cCpus)
591 {
592 AssertLogRelMsgFailed(("Configuration error: \"NumCPUs\"=%RU32 and VMR3CreateVM::cCPUs=%RU32 does not match!\n",
593 cCPUsCfg, cCpus));
594 rc = VERR_INVALID_PARAMETER;
595 }
596 }
597 if (RT_SUCCESS(rc))
598 {
599 /*
600 * Init the ring-3 components and ring-3 per cpu data, finishing it off
601 * by a relocation round (intermediate context finalization will do this).
602 */
603 rc = vmR3InitRing3(pVM, pUVM);
604 if (RT_SUCCESS(rc))
605 {
606 rc = vmR3InitVMCpu(pVM);
607 if (RT_SUCCESS(rc))
608 rc = PGMR3FinalizeMappings(pVM);
609 if (RT_SUCCESS(rc))
610 {
611
612 LogFlow(("Ring-3 init succeeded\n"));
613
614 /*
615 * Init the Ring-0 components.
616 */
617 rc = vmR3InitRing0(pVM);
618 if (RT_SUCCESS(rc))
619 {
620 /* Relocate again, because some switcher fixups depends on R0 init results. */
621 VMR3Relocate(pVM, 0);
622
623#ifdef VBOX_WITH_DEBUGGER
624 /*
625 * Init the tcp debugger console if we're building
626 * with debugger support.
627 */
628 void *pvUser = NULL;
629 rc = DBGCTcpCreate(pVM, &pvUser);
630 if ( RT_SUCCESS(rc)
631 || rc == VERR_NET_ADDRESS_IN_USE)
632 {
633 pUVM->vm.s.pvDBGC = pvUser;
634#endif
635 /*
636 * Init the Guest Context components.
637 */
638 rc = vmR3InitGC(pVM);
639 if (RT_SUCCESS(rc))
640 {
641 /*
642 * Now we can safely set the VM halt method to default.
643 */
644 rc = vmR3SetHaltMethodU(pUVM, VMHALTMETHOD_DEFAULT);
645 if (RT_SUCCESS(rc))
646 {
647 /*
648 * Set the state and link into the global list.
649 */
650 vmR3SetState(pVM, VMSTATE_CREATED);
651 pUVM->pNext = g_pUVMsHead;
652 g_pUVMsHead = pUVM;
653
654#ifdef LOG_ENABLED
655 RTLogSetCustomPrefixCallback(NULL, vmR3LogPrefixCallback, pUVM);
656#endif
657 return VINF_SUCCESS;
658 }
659 }
660#ifdef VBOX_WITH_DEBUGGER
661 DBGCTcpTerminate(pVM, pUVM->vm.s.pvDBGC);
662 pUVM->vm.s.pvDBGC = NULL;
663 }
664#endif
665 //..
666 }
667 }
668 vmR3Destroy(pVM);
669 }
670 }
671 //..
672
673 /* Clean CFGM. */
674 int rc2 = CFGMR3Term(pVM);
675 AssertRC(rc2);
676 }
677
678 /*
679 * Drop all references to VM and the VMCPU structures, then
680 * tell GVMM to destroy the VM.
681 */
682 pUVM->pVM = NULL;
683 for (VMCPUID i = 0; i < pUVM->cCpus; i++)
684 {
685 pUVM->aCpus[i].pVM = NULL;
686 pUVM->aCpus[i].pVCpu = NULL;
687 }
688 Assert(pUVM->vm.s.enmHaltMethod == VMHALTMETHOD_BOOTSTRAP);
689
690 if (pUVM->cCpus > 1)
691 {
692 /* Poke the other EMTs since they may have stale pVM and pVCpu references
693 on the stack (see VMR3WaitU for instance) if they've been awakened after
694 VM creation. */
695 for (VMCPUID i = 1; i < pUVM->cCpus; i++)
696 VMR3NotifyCpuFFU(&pUVM->aCpus[i], 0);
697 RTThreadSleep(RT_MIN(100 + 25 *(pUVM->cCpus - 1), 500)); /* very sophisticated */
698 }
699
700 int rc2 = SUPR3CallVMMR0Ex(CreateVMReq.pVMR0, 0 /*idCpu*/, VMMR0_DO_GVMM_DESTROY_VM, 0, NULL);
701 AssertRC(rc2);
702 }
703 else
704 vmR3SetErrorU(pUVM, rc, RT_SRC_POS, N_("VM creation failed (GVMM)"));
705
706 LogFlow(("vmR3CreateU: returns %Rrc\n", rc));
707 return rc;
708}
709
710
711/**
712 * Register the calling EMT with GVM.
713 *
714 * @returns VBox status code.
715 * @param pVM The VM handle.
716 * @param idCpu The Virtual CPU ID.
717 */
718static DECLCALLBACK(int) vmR3RegisterEMT(PVM pVM, VMCPUID idCpu)
719{
720 Assert(VMMGetCpuId(pVM) == idCpu);
721 int rc = SUPR3CallVMMR0Ex(pVM->pVMR0, idCpu, VMMR0_DO_GVMM_REGISTER_VMCPU, 0, NULL);
722 if (RT_FAILURE(rc))
723 LogRel(("idCpu=%u rc=%Rrc\n", idCpu, rc));
724 return rc;
725}
726
727
728/**
729 * Initializes all R3 components of the VM
730 */
731static int vmR3InitRing3(PVM pVM, PUVM pUVM)
732{
733 int rc;
734
735 /*
736 * Register the other EMTs with GVM.
737 */
738 for (VMCPUID idCpu = 1; idCpu < pVM->cCPUs; idCpu++)
739 {
740 PVMREQ pReq;
741 rc = VMR3ReqCallU(pUVM, idCpu, &pReq, RT_INDEFINITE_WAIT, 0 /*fFlags*/,
742 (PFNRT)vmR3RegisterEMT, 2, pVM, idCpu);
743 if (RT_SUCCESS(rc))
744 rc = pReq->iStatus;
745 VMR3ReqFree(pReq);
746 if (RT_FAILURE(rc))
747 return rc;
748 }
749
750 /*
751 * Init all R3 components, the order here might be important.
752 */
753 rc = MMR3Init(pVM);
754 if (RT_SUCCESS(rc))
755 {
756 STAM_REG(pVM, &pVM->StatTotalInGC, STAMTYPE_PROFILE_ADV, "/PROF/VM/InGC", STAMUNIT_TICKS_PER_CALL, "Profiling the total time spent in GC.");
757 STAM_REG(pVM, &pVM->StatSwitcherToGC, STAMTYPE_PROFILE_ADV, "/PROF/VM/SwitchToGC", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
758 STAM_REG(pVM, &pVM->StatSwitcherToHC, STAMTYPE_PROFILE_ADV, "/PROF/VM/SwitchToHC", STAMUNIT_TICKS_PER_CALL, "Profiling switching to HC.");
759 STAM_REG(pVM, &pVM->StatSwitcherSaveRegs, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/SaveRegs", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
760 STAM_REG(pVM, &pVM->StatSwitcherSysEnter, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/SysEnter", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
761 STAM_REG(pVM, &pVM->StatSwitcherDebug, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Debug", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
762 STAM_REG(pVM, &pVM->StatSwitcherCR0, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/CR0", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
763 STAM_REG(pVM, &pVM->StatSwitcherCR4, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/CR4", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
764 STAM_REG(pVM, &pVM->StatSwitcherLgdt, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Lgdt", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
765 STAM_REG(pVM, &pVM->StatSwitcherLidt, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Lidt", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
766 STAM_REG(pVM, &pVM->StatSwitcherLldt, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Lldt", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
767 STAM_REG(pVM, &pVM->StatSwitcherTSS, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/TSS", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
768 STAM_REG(pVM, &pVM->StatSwitcherJmpCR3, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/JmpCR3", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
769 STAM_REG(pVM, &pVM->StatSwitcherRstrRegs, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/RstrRegs", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
770
771 for (unsigned iCpu=0;iCpu<pVM->cCPUs;iCpu++)
772 {
773 rc = STAMR3RegisterF(pVM, &pUVM->aCpus[iCpu].vm.s.StatHaltYield, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling halted state yielding.", "/PROF/VM/CPU%d/Halt/Yield", iCpu);
774 AssertRC(rc);
775 rc = STAMR3RegisterF(pVM, &pUVM->aCpus[iCpu].vm.s.StatHaltBlock, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling halted state blocking.", "/PROF/VM/CPU%d/Halt/Block", iCpu);
776 AssertRC(rc);
777 rc = STAMR3RegisterF(pVM, &pUVM->aCpus[iCpu].vm.s.StatHaltTimers, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling halted state timer tasks.", "/PROF/VM/CPU%d/Halt/Timers", iCpu);
778 AssertRC(rc);
779 }
780
781 STAM_REG(pVM, &pUVM->vm.s.StatReqAllocNew, STAMTYPE_COUNTER, "/VM/Req/AllocNew", STAMUNIT_OCCURENCES, "Number of VMR3ReqAlloc returning a new packet.");
782 STAM_REG(pVM, &pUVM->vm.s.StatReqAllocRaces, STAMTYPE_COUNTER, "/VM/Req/AllocRaces", STAMUNIT_OCCURENCES, "Number of VMR3ReqAlloc causing races.");
783 STAM_REG(pVM, &pUVM->vm.s.StatReqAllocRecycled, STAMTYPE_COUNTER, "/VM/Req/AllocRecycled", STAMUNIT_OCCURENCES, "Number of VMR3ReqAlloc returning a recycled packet.");
784 STAM_REG(pVM, &pUVM->vm.s.StatReqFree, STAMTYPE_COUNTER, "/VM/Req/Free", STAMUNIT_OCCURENCES, "Number of VMR3ReqFree calls.");
785 STAM_REG(pVM, &pUVM->vm.s.StatReqFreeOverflow, STAMTYPE_COUNTER, "/VM/Req/FreeOverflow", STAMUNIT_OCCURENCES, "Number of times the request was actually freed.");
786
787 rc = CPUMR3Init(pVM);
788 if (RT_SUCCESS(rc))
789 {
790 rc = HWACCMR3Init(pVM);
791 if (RT_SUCCESS(rc))
792 {
793 rc = PGMR3Init(pVM);
794 if (RT_SUCCESS(rc))
795 {
796 rc = REMR3Init(pVM);
797 if (RT_SUCCESS(rc))
798 {
799 rc = MMR3InitPaging(pVM);
800 if (RT_SUCCESS(rc))
801 rc = TMR3Init(pVM);
802 if (RT_SUCCESS(rc))
803 {
804 rc = VMMR3Init(pVM);
805 if (RT_SUCCESS(rc))
806 {
807 rc = SELMR3Init(pVM);
808 if (RT_SUCCESS(rc))
809 {
810 rc = TRPMR3Init(pVM);
811 if (RT_SUCCESS(rc))
812 {
813 rc = CSAMR3Init(pVM);
814 if (RT_SUCCESS(rc))
815 {
816 rc = PATMR3Init(pVM);
817 if (RT_SUCCESS(rc))
818 {
819#ifdef VBOX_WITH_VMI
820 rc = PARAVR3Init(pVM);
821 if (RT_SUCCESS(rc))
822 {
823#endif
824 rc = IOMR3Init(pVM);
825 if (RT_SUCCESS(rc))
826 {
827 rc = EMR3Init(pVM);
828 if (RT_SUCCESS(rc))
829 {
830 rc = DBGFR3Init(pVM);
831 if (RT_SUCCESS(rc))
832 {
833 rc = PDMR3Init(pVM);
834 if (RT_SUCCESS(rc))
835 {
836 rc = PGMR3InitDynMap(pVM);
837 if (RT_SUCCESS(rc))
838 rc = MMR3HyperInitFinalize(pVM);
839 if (RT_SUCCESS(rc))
840 rc = PATMR3InitFinalize(pVM);
841 if (RT_SUCCESS(rc))
842 rc = PGMR3InitFinalize(pVM);
843 if (RT_SUCCESS(rc))
844 rc = SELMR3InitFinalize(pVM);
845 if (RT_SUCCESS(rc))
846 rc = TMR3InitFinalize(pVM);
847 if (RT_SUCCESS(rc))
848 rc = VMMR3InitFinalize(pVM);
849 if (RT_SUCCESS(rc))
850 rc = REMR3InitFinalize(pVM);
851 if (RT_SUCCESS(rc))
852 rc = vmR3InitDoCompleted(pVM, VMINITCOMPLETED_RING3);
853 if (RT_SUCCESS(rc))
854 {
855 LogFlow(("vmR3InitRing3: returns %Rrc\n", VINF_SUCCESS));
856 return VINF_SUCCESS;
857 }
858 int rc2 = PDMR3Term(pVM);
859 AssertRC(rc2);
860 }
861 int rc2 = DBGFR3Term(pVM);
862 AssertRC(rc2);
863 }
864 int rc2 = EMR3Term(pVM);
865 AssertRC(rc2);
866 }
867 int rc2 = IOMR3Term(pVM);
868 AssertRC(rc2);
869 }
870#ifdef VBOX_WITH_VMI
871 int rc2 = PARAVR3Term(pVM);
872 AssertRC(rc2);
873 }
874#endif
875 int rc2 = PATMR3Term(pVM);
876 AssertRC(rc2);
877 }
878 int rc2 = CSAMR3Term(pVM);
879 AssertRC(rc2);
880 }
881 int rc2 = TRPMR3Term(pVM);
882 AssertRC(rc2);
883 }
884 int rc2 = SELMR3Term(pVM);
885 AssertRC(rc2);
886 }
887 int rc2 = VMMR3Term(pVM);
888 AssertRC(rc2);
889 }
890 int rc2 = TMR3Term(pVM);
891 AssertRC(rc2);
892 }
893 int rc2 = REMR3Term(pVM);
894 AssertRC(rc2);
895 }
896 int rc2 = PGMR3Term(pVM);
897 AssertRC(rc2);
898 }
899 int rc2 = HWACCMR3Term(pVM);
900 AssertRC(rc2);
901 }
902 //int rc2 = CPUMR3Term(pVM);
903 //AssertRC(rc2);
904 }
905 /* MMR3Term is not called here because it'll kill the heap. */
906 }
907
908 LogFlow(("vmR3InitRing3: returns %Rrc\n", rc));
909 return rc;
910}
911
912
913/**
914 * Initializes all VM CPU components of the VM
915 */
916static int vmR3InitVMCpu(PVM pVM)
917{
918 int rc = VINF_SUCCESS;
919 int rc2;
920
921 rc = CPUMR3InitCPU(pVM);
922 if (RT_SUCCESS(rc))
923 {
924 rc = HWACCMR3InitCPU(pVM);
925 if (RT_SUCCESS(rc))
926 {
927 rc = PGMR3InitCPU(pVM);
928 if (RT_SUCCESS(rc))
929 {
930 rc = TMR3InitCPU(pVM);
931 if (RT_SUCCESS(rc))
932 {
933 rc = VMMR3InitCPU(pVM);
934 if (RT_SUCCESS(rc))
935 {
936 rc = EMR3InitCPU(pVM);
937 if (RT_SUCCESS(rc))
938 {
939 LogFlow(("vmR3InitVMCpu: returns %Rrc\n", VINF_SUCCESS));
940 return VINF_SUCCESS;
941 }
942
943 rc2 = VMMR3TermCPU(pVM);
944 AssertRC(rc2);
945 }
946 rc2 = TMR3TermCPU(pVM);
947 AssertRC(rc2);
948 }
949 rc2 = PGMR3TermCPU(pVM);
950 AssertRC(rc2);
951 }
952 rc2 = HWACCMR3TermCPU(pVM);
953 AssertRC(rc2);
954 }
955 rc2 = CPUMR3TermCPU(pVM);
956 AssertRC(rc2);
957 }
958 LogFlow(("vmR3InitVMCpu: returns %Rrc\n", rc));
959 return rc;
960}
961
962
963/**
964 * Initializes all R0 components of the VM
965 */
966static int vmR3InitRing0(PVM pVM)
967{
968 LogFlow(("vmR3InitRing0:\n"));
969
970 /*
971 * Check for FAKE suplib mode.
972 */
973 int rc = VINF_SUCCESS;
974 const char *psz = RTEnvGet("VBOX_SUPLIB_FAKE");
975 if (!psz || strcmp(psz, "fake"))
976 {
977 /*
978 * Call the VMMR0 component and let it do the init.
979 */
980 rc = VMMR3InitR0(pVM);
981 }
982 else
983 Log(("vmR3InitRing0: skipping because of VBOX_SUPLIB_FAKE=fake\n"));
984
985 /*
986 * Do notifications and return.
987 */
988 if (RT_SUCCESS(rc))
989 rc = vmR3InitDoCompleted(pVM, VMINITCOMPLETED_RING0);
990
991 /** todo: move this to the VMINITCOMPLETED_RING0 notification handler once implemented */
992 if (RT_SUCCESS(rc))
993 rc = HWACCMR3InitFinalizeR0(pVM);
994
995 LogFlow(("vmR3InitRing0: returns %Rrc\n", rc));
996 return rc;
997}
998
999
1000/**
1001 * Initializes all GC components of the VM
1002 */
1003static int vmR3InitGC(PVM pVM)
1004{
1005 LogFlow(("vmR3InitGC:\n"));
1006
1007 /*
1008 * Check for FAKE suplib mode.
1009 */
1010 int rc = VINF_SUCCESS;
1011 const char *psz = RTEnvGet("VBOX_SUPLIB_FAKE");
1012 if (!psz || strcmp(psz, "fake"))
1013 {
1014 /*
1015 * Call the VMMR0 component and let it do the init.
1016 */
1017 rc = VMMR3InitRC(pVM);
1018 }
1019 else
1020 Log(("vmR3InitGC: skipping because of VBOX_SUPLIB_FAKE=fake\n"));
1021
1022 /*
1023 * Do notifications and return.
1024 */
1025 if (RT_SUCCESS(rc))
1026 rc = vmR3InitDoCompleted(pVM, VMINITCOMPLETED_GC);
1027 LogFlow(("vmR3InitGC: returns %Rrc\n", rc));
1028 return rc;
1029}
1030
1031
1032/**
1033 * Do init completed notifications.
1034 * This notifications can fail.
1035 *
1036 * @param pVM The VM handle.
1037 * @param enmWhat What's completed.
1038 */
1039static int vmR3InitDoCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
1040{
1041 return VINF_SUCCESS;
1042}
1043
1044
1045/**
1046 * Logger callback for inserting a custom prefix.
1047 *
1048 * @returns Number of chars written.
1049 * @param pLogger The logger.
1050 * @param pchBuf The output buffer.
1051 * @param cchBuf The output buffer size.
1052 * @param pvUser Pointer to the UVM structure.
1053 */
1054static DECLCALLBACK(size_t) vmR3LogPrefixCallback(PRTLOGGER pLogger, char *pchBuf, size_t cchBuf, void *pvUser)
1055{
1056 AssertReturn(cchBuf >= 2, 0);
1057 PUVM pUVM = (PUVM)pvUser;
1058 PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pUVM->vm.s.idxTLS);
1059 if (pUVCpu)
1060 {
1061 static const char s_szHex[17] = "0123456789abcdef";
1062 VMCPUID const idCpu = pUVCpu->idCpu;
1063 pchBuf[1] = s_szHex[ idCpu & 15];
1064 pchBuf[0] = s_szHex[(idCpu >> 4) & 15];
1065 }
1066 else
1067 {
1068 pchBuf[0] = 'x';
1069 pchBuf[1] = 'y';
1070 }
1071
1072 return 2;
1073}
1074
1075
1076/**
1077 * Calls the relocation functions for all VMM components so they can update
1078 * any GC pointers. When this function is called all the basic VM members
1079 * have been updated and the actual memory relocation have been done
1080 * by the PGM/MM.
1081 *
1082 * This is used both on init and on runtime relocations.
1083 *
1084 * @param pVM VM handle.
1085 * @param offDelta Relocation delta relative to old location.
1086 */
1087VMMR3DECL(void) VMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
1088{
1089 LogFlow(("VMR3Relocate: offDelta=%RGv\n", offDelta));
1090
1091 /*
1092 * The order here is very important!
1093 */
1094 PGMR3Relocate(pVM, offDelta);
1095 PDMR3LdrRelocateU(pVM->pUVM, offDelta);
1096 PGMR3Relocate(pVM, 0); /* Repeat after PDM relocation. */
1097 CPUMR3Relocate(pVM);
1098 HWACCMR3Relocate(pVM);
1099 SELMR3Relocate(pVM);
1100 VMMR3Relocate(pVM, offDelta);
1101 SELMR3Relocate(pVM); /* !hack! fix stack! */
1102 TRPMR3Relocate(pVM, offDelta);
1103 PATMR3Relocate(pVM);
1104 CSAMR3Relocate(pVM, offDelta);
1105 IOMR3Relocate(pVM, offDelta);
1106 EMR3Relocate(pVM);
1107 TMR3Relocate(pVM, offDelta);
1108 DBGFR3Relocate(pVM, offDelta);
1109 PDMR3Relocate(pVM, offDelta);
1110}
1111
1112
1113/**
1114 * Power on the virtual machine.
1115 *
1116 * @returns 0 on success.
1117 * @returns VBox error code on failure.
1118 * @param pVM VM to power on.
1119 * @thread Any thread.
1120 * @vmstate Created
1121 * @vmstateto Running
1122 */
1123VMMR3DECL(int) VMR3PowerOn(PVM pVM)
1124{
1125 LogFlow(("VMR3PowerOn: pVM=%p\n", pVM));
1126
1127 /*
1128 * Validate input.
1129 */
1130 if (!pVM)
1131 {
1132 AssertMsgFailed(("Invalid VM pointer\n"));
1133 return VERR_INVALID_PARAMETER;
1134 }
1135
1136 /*
1137 * Request the operation in EMT (in order as VCPU 0 does all the work)
1138 */
1139 PVMREQ pReq;
1140 int rc = VMR3ReqCall(pVM, VMCPUID_ALL, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3PowerOn, 1, pVM);
1141 if (RT_SUCCESS(rc))
1142 {
1143 rc = pReq->iStatus;
1144 VMR3ReqFree(pReq);
1145 }
1146
1147 LogFlow(("VMR3PowerOn: returns %Rrc\n", rc));
1148 return rc;
1149}
1150
1151
1152/**
1153 * Power on the virtual machine.
1154 *
1155 * @returns 0 on success.
1156 * @returns VBox error code on failure.
1157 * @param pVM VM to power on.
1158 * @thread EMT
1159 */
1160static DECLCALLBACK(int) vmR3PowerOn(PVM pVM)
1161{
1162 LogFlow(("vmR3PowerOn: pVM=%p\n", pVM));
1163
1164 /*
1165 * EMT(0) does the actual power on work *before* the other EMTs
1166 * get here, they just need to set their state to STARTED so they
1167 * get out of the EMT loop and into EM.
1168 */
1169 PVMCPU pVCpu = VMMGetCpu(pVM);
1170 VMCPU_SET_STATE(pVCpu, VMCPUSTATE_STARTED);
1171 if (pVCpu->idCpu != 0)
1172 return VINF_SUCCESS;
1173
1174 /*
1175 * Validate input.
1176 */
1177 if (pVM->enmVMState != VMSTATE_CREATED)
1178 {
1179 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
1180 return VERR_VM_INVALID_VM_STATE;
1181 }
1182
1183 /*
1184 * Change the state, notify the components and resume the execution.
1185 */
1186 vmR3SetState(pVM, VMSTATE_RUNNING);
1187 PDMR3PowerOn(pVM);
1188
1189 return VINF_SUCCESS;
1190}
1191
1192
1193/**
1194 * Suspends a running VM.
1195 *
1196 * @returns 0 on success.
1197 * @returns VBox error code on failure.
1198 * @param pVM VM to suspend.
1199 * @thread Any thread.
1200 * @vmstate Running
1201 * @vmstateto Suspended
1202 */
1203VMMR3DECL(int) VMR3Suspend(PVM pVM)
1204{
1205 LogFlow(("VMR3Suspend: pVM=%p\n", pVM));
1206
1207 /*
1208 * Validate input.
1209 */
1210 if (!pVM)
1211 {
1212 AssertMsgFailed(("Invalid VM pointer\n"));
1213 return VERR_INVALID_PARAMETER;
1214 }
1215
1216 /*
1217 * Request the operation in EMT. (in reverse order as VCPU 0 does the actual work)
1218 */
1219 PVMREQ pReq = NULL;
1220 int rc = VMR3ReqCall(pVM, VMCPUID_ALL_REVERSE, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3Suspend, 1, pVM);
1221 if (RT_SUCCESS(rc))
1222 {
1223 rc = pReq->iStatus;
1224 VMR3ReqFree(pReq);
1225 }
1226 else
1227 Assert(pReq == NULL);
1228
1229 LogFlow(("VMR3Suspend: returns %Rrc\n", rc));
1230 return rc;
1231}
1232
1233
1234/**
1235 * Suspends a running VM and prevent state saving until the VM is resumed or stopped.
1236 *
1237 * @returns 0 on success.
1238 * @returns VBox error code on failure.
1239 * @param pVM VM to suspend.
1240 * @thread Any thread.
1241 * @vmstate Running
1242 * @vmstateto Suspended
1243 */
1244VMMR3DECL(int) VMR3SuspendNoSave(PVM pVM)
1245{
1246 pVM->vm.s.fPreventSaveState = true;
1247 return VMR3Suspend(pVM);
1248}
1249
1250
1251/**
1252 * Suspends a running VM.
1253 *
1254 * @returns 0 on success.
1255 * @returns VBox error code on failure.
1256 * @param pVM VM to suspend.
1257 * @thread EMT
1258 */
1259static DECLCALLBACK(int) vmR3Suspend(PVM pVM)
1260{
1261 LogFlow(("vmR3Suspend: pVM=%p\n", pVM));
1262
1263 /*
1264 * Validate input.
1265 */
1266 if (pVM->enmVMState != VMSTATE_RUNNING)
1267 {
1268 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
1269 return VERR_VM_INVALID_VM_STATE;
1270 }
1271
1272 PVMCPU pVCpu = VMMGetCpu(pVM);
1273 /* Only VCPU 0 does the actual work (*after* all the other CPUs has been here). */
1274 if (pVCpu->idCpu != 0)
1275 return VINF_EM_SUSPEND;
1276
1277 /*
1278 * Change the state, notify the components and resume the execution.
1279 */
1280 vmR3SetState(pVM, VMSTATE_SUSPENDED);
1281 PDMR3Suspend(pVM);
1282
1283 return VINF_EM_SUSPEND;
1284}
1285
1286
1287/**
1288 * Resume VM execution.
1289 *
1290 * @returns 0 on success.
1291 * @returns VBox error code on failure.
1292 * @param pVM The VM to resume.
1293 * @thread Any thread.
1294 * @vmstate Suspended
1295 * @vmstateto Running
1296 */
1297VMMR3DECL(int) VMR3Resume(PVM pVM)
1298{
1299 LogFlow(("VMR3Resume: pVM=%p\n", pVM));
1300
1301 /*
1302 * Validate input.
1303 */
1304 if (!pVM)
1305 {
1306 AssertMsgFailed(("Invalid VM pointer\n"));
1307 return VERR_INVALID_PARAMETER;
1308 }
1309
1310 /*
1311 * Request the operation in EMT. (in VCPU order as VCPU 0 does the actual work)
1312 */
1313 PVMREQ pReq = NULL;
1314 int rc = VMR3ReqCall(pVM, VMCPUID_ALL, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3Resume, 1, pVM);
1315 if (RT_SUCCESS(rc))
1316 {
1317 rc = pReq->iStatus;
1318 VMR3ReqFree(pReq);
1319 }
1320 else
1321 Assert(pReq == NULL);
1322
1323 LogFlow(("VMR3Resume: returns %Rrc\n", rc));
1324 return rc;
1325}
1326
1327
1328/**
1329 * Resume VM execution.
1330 *
1331 * @returns 0 on success.
1332 * @returns VBox error code on failure.
1333 * @param pVM The VM to resume.
1334 * @thread EMT
1335 */
1336static DECLCALLBACK(int) vmR3Resume(PVM pVM)
1337{
1338 LogFlow(("vmR3Resume: pVM=%p\n", pVM));
1339
1340 PVMCPU pVCpu = VMMGetCpu(pVM);
1341 /* Only VCPU 0 does the actual work (*before* the others wake up). */
1342 if (pVCpu->idCpu != 0)
1343 return VINF_EM_RESUME;
1344
1345 /*
1346 * Validate input.
1347 */
1348 if (pVM->enmVMState != VMSTATE_SUSPENDED)
1349 {
1350 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
1351 return VERR_VM_INVALID_VM_STATE;
1352 }
1353
1354 /*
1355 * Change the state, notify the components and resume the execution.
1356 */
1357 pVM->vm.s.fPreventSaveState = false;
1358 vmR3SetState(pVM, VMSTATE_RUNNING);
1359 PDMR3Resume(pVM);
1360
1361 return VINF_EM_RESUME;
1362}
1363
1364
1365/**
1366 * Save current VM state.
1367 *
1368 * To save and terminate the VM, the VM must be suspended before the call.
1369 *
1370 * @returns 0 on success.
1371 * @returns VBox error code on failure.
1372 * @param pVM VM which state should be saved.
1373 * @param pszFilename Name of the save state file.
1374 * @param pfnProgress Progress callback. Optional.
1375 * @param pvUser User argument for the progress callback.
1376 * @thread Any thread.
1377 * @vmstate Suspended
1378 * @vmstateto Unchanged state.
1379 */
1380VMMR3DECL(int) VMR3Save(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser)
1381{
1382 LogFlow(("VMR3Save: pVM=%p pszFilename=%p:{%s} pfnProgress=%p pvUser=%p\n", pVM, pszFilename, pszFilename, pfnProgress, pvUser));
1383
1384 /*
1385 * Validate input.
1386 */
1387 if (!pVM)
1388 {
1389 AssertMsgFailed(("Invalid VM pointer\n"));
1390 return VERR_INVALID_PARAMETER;
1391 }
1392 if (!pszFilename)
1393 {
1394 AssertMsgFailed(("Must specify a filename to save the state to, wise guy!\n"));
1395 return VERR_INVALID_PARAMETER;
1396 }
1397
1398 /*
1399 * Request the operation in EMT.
1400 */
1401 PVMREQ pReq;
1402 int rc = VMR3ReqCall(pVM, 0 /* VCPU 0 */, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3Save, 4, pVM, pszFilename, pfnProgress, pvUser);
1403 if (RT_SUCCESS(rc))
1404 {
1405 rc = pReq->iStatus;
1406 VMR3ReqFree(pReq);
1407 }
1408
1409 LogFlow(("VMR3Save: returns %Rrc\n", rc));
1410 return rc;
1411}
1412
1413
1414/**
1415 * Save current VM state.
1416 *
1417 * To save and terminate the VM, the VM must be suspended before the call.
1418 *
1419 * @returns 0 on success.
1420 * @returns VBox error code on failure.
1421 * @param pVM VM which state should be saved.
1422 * @param pszFilename Name of the save state file.
1423 * @param pfnProgress Progress callback. Optional.
1424 * @param pvUser User argument for the progress callback.
1425 * @thread EMT
1426 */
1427static DECLCALLBACK(int) vmR3Save(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser)
1428{
1429 LogFlow(("vmR3Save: pVM=%p pszFilename=%p:{%s} pfnProgress=%p pvUser=%p\n", pVM, pszFilename, pszFilename, pfnProgress, pvUser));
1430
1431 /*
1432 * Validate input.
1433 */
1434 if (pVM->enmVMState != VMSTATE_SUSPENDED)
1435 {
1436 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
1437 return VERR_VM_INVALID_VM_STATE;
1438 }
1439
1440 /* If we are in an inconsistent state, then we don't allow state saving. */
1441 if (pVM->vm.s.fPreventSaveState)
1442 {
1443 LogRel(("VMM: vmR3Save: saving the VM state is not allowed at this moment\n"));
1444 return VERR_VM_SAVE_STATE_NOT_ALLOWED;
1445 }
1446
1447 /*
1448 * Change the state and perform the save.
1449 */
1450 vmR3SetState(pVM, VMSTATE_SAVING);
1451 int rc = SSMR3Save(pVM, pszFilename, SSMAFTER_CONTINUE, pfnProgress, pvUser);
1452 vmR3SetState(pVM, VMSTATE_SUSPENDED);
1453
1454 return rc;
1455}
1456
1457
1458/**
1459 * Loads a new VM state.
1460 *
1461 * To restore a saved state on VM startup, call this function and then
1462 * resume the VM instead of powering it on.
1463 *
1464 * @returns 0 on success.
1465 * @returns VBox error code on failure.
1466 * @param pVM VM which state should be saved.
1467 * @param pszFilename Name of the save state file.
1468 * @param pfnProgress Progress callback. Optional.
1469 * @param pvUser User argument for the progress callback.
1470 * @thread Any thread.
1471 * @vmstate Created, Suspended
1472 * @vmstateto Suspended
1473 */
1474VMMR3DECL(int) VMR3Load(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser)
1475{
1476 LogFlow(("VMR3Load: pVM=%p pszFilename=%p:{%s} pfnProgress=%p pvUser=%p\n", pVM, pszFilename, pszFilename, pfnProgress, pvUser));
1477
1478 /*
1479 * Validate input.
1480 */
1481 if (!pVM)
1482 {
1483 AssertMsgFailed(("Invalid VM pointer\n"));
1484 return VERR_INVALID_PARAMETER;
1485 }
1486 if (!pszFilename)
1487 {
1488 AssertMsgFailed(("Must specify a filename to load the state from, wise guy!\n"));
1489 return VERR_INVALID_PARAMETER;
1490 }
1491
1492 /*
1493 * Request the operation in EMT.
1494 */
1495 PVMREQ pReq;
1496 int rc = VMR3ReqCall(pVM, 0 /* VCPU 0 */, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3Load, 4, pVM, pszFilename, pfnProgress, pvUser);
1497 if (RT_SUCCESS(rc))
1498 {
1499 rc = pReq->iStatus;
1500 VMR3ReqFree(pReq);
1501 }
1502
1503 LogFlow(("VMR3Load: returns %Rrc\n", rc));
1504 return rc;
1505}
1506
1507
1508/**
1509 * Loads a new VM state.
1510 *
1511 * To restore a saved state on VM startup, call this function and then
1512 * resume the VM instead of powering it on.
1513 *
1514 * @returns 0 on success.
1515 * @returns VBox error code on failure.
1516 * @param pVM VM which state should be saved.
1517 * @param pszFilename Name of the save state file.
1518 * @param pfnProgress Progress callback. Optional.
1519 * @param pvUser User argument for the progress callback.
1520 * @thread EMT.
1521 */
1522static DECLCALLBACK(int) vmR3Load(PVM pVM, const char *pszFilename, PFNVMPROGRESS pfnProgress, void *pvUser)
1523{
1524 LogFlow(("vmR3Load: pVM=%p pszFilename=%p:{%s} pfnProgress=%p pvUser=%p\n", pVM, pszFilename, pszFilename, pfnProgress, pvUser));
1525
1526 /*
1527 * Validate input.
1528 */
1529 if ( pVM->enmVMState != VMSTATE_SUSPENDED
1530 && pVM->enmVMState != VMSTATE_CREATED)
1531 {
1532 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
1533 return VMSetError(pVM, VERR_VM_INVALID_VM_STATE, RT_SRC_POS, N_("Invalid VM state (%s) for restoring state from '%s'"),
1534 VMR3GetStateName(pVM->enmVMState), pszFilename);
1535 }
1536
1537 /*
1538 * Change the state and perform the load.
1539 */
1540 vmR3SetState(pVM, VMSTATE_LOADING);
1541 int rc = SSMR3Load(pVM, pszFilename, SSMAFTER_RESUME, pfnProgress, pvUser);
1542 if (RT_SUCCESS(rc))
1543 {
1544 /* Not paranoia anymore; the saved guest might use different hypervisor selectors. We must call VMR3Relocate. */
1545 VMR3Relocate(pVM, 0);
1546 vmR3SetState(pVM, VMSTATE_SUSPENDED);
1547 }
1548 else
1549 {
1550 vmR3SetState(pVM, VMSTATE_LOAD_FAILURE);
1551 rc = VMSetError(pVM, rc, RT_SRC_POS, N_("Unable to restore the virtual machine's saved state from '%s'. It may be damaged or from an older version of VirtualBox. Please discard the saved state before starting the virtual machine"), pszFilename);
1552 }
1553
1554 return rc;
1555}
1556
1557
1558/**
1559 * Power Off the VM.
1560 *
1561 * @returns 0 on success.
1562 * @returns VBox error code on failure.
1563 * @param pVM VM which should be destroyed.
1564 * @thread Any thread.
1565 * @vmstate Suspended, Running, Guru Meditation, Load Failure
1566 * @vmstateto Off
1567 */
1568VMMR3DECL(int) VMR3PowerOff(PVM pVM)
1569{
1570 LogFlow(("VMR3PowerOff: pVM=%p\n", pVM));
1571
1572 /*
1573 * Validate input.
1574 */
1575 if (!pVM)
1576 {
1577 AssertMsgFailed(("Invalid VM pointer\n"));
1578 return VERR_INVALID_PARAMETER;
1579 }
1580
1581 /*
1582 * Request the operation in EMT. (in reverse order as VCPU 0 does the actual work)
1583 */
1584 PVMREQ pReq = NULL;
1585 int rc = VMR3ReqCall(pVM, VMCPUID_ALL_REVERSE, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3PowerOff, 1, pVM);
1586 if (RT_SUCCESS(rc))
1587 {
1588 rc = pReq->iStatus;
1589 VMR3ReqFree(pReq);
1590 }
1591 else
1592 Assert(pReq == NULL);
1593
1594 LogFlow(("VMR3PowerOff: returns %Rrc\n", rc));
1595 return rc;
1596}
1597
1598
1599/**
1600 * Power Off the VM.
1601 *
1602 * @returns 0 on success.
1603 * @returns VBox error code on failure.
1604 * @param pVM VM which should be destroyed.
1605 * @thread EMT.
1606 */
1607static DECLCALLBACK(int) vmR3PowerOff(PVM pVM)
1608{
1609 LogFlow(("vmR3PowerOff: pVM=%p\n", pVM));
1610
1611 /*
1612 * Validate input.
1613 */
1614 if ( pVM->enmVMState != VMSTATE_RUNNING
1615 && pVM->enmVMState != VMSTATE_SUSPENDED
1616 && pVM->enmVMState != VMSTATE_LOAD_FAILURE
1617 && pVM->enmVMState != VMSTATE_GURU_MEDITATION)
1618 {
1619 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
1620 return VERR_VM_INVALID_VM_STATE;
1621 }
1622
1623 /*
1624 * EMT(0) does the actual power off work here *after* all the other EMTs
1625 * have been thru and entered the STOPPED state.
1626 */
1627 PVMCPU pVCpu = VMMGetCpu(pVM);
1628 VMCPU_SET_STATE(pVCpu, VMCPUSTATE_STOPPED);
1629 if (pVCpu->idCpu != 0)
1630 return VINF_EM_OFF;
1631
1632 /*
1633 * For debugging purposes, we will log a summary of the guest state at this point.
1634 */
1635 if (pVM->enmVMState != VMSTATE_GURU_MEDITATION)
1636 {
1637 /* @todo SMP support? */
1638 PVMCPU pVCpu = VMMGetCpu(pVM);
1639
1640 /** @todo make the state dumping at VMR3PowerOff optional. */
1641 RTLogRelPrintf("****************** Guest state at power off ******************\n");
1642 DBGFR3Info(pVM, "cpumguest", "verbose", DBGFR3InfoLogRelHlp());
1643 RTLogRelPrintf("***\n");
1644 DBGFR3Info(pVM, "mode", NULL, DBGFR3InfoLogRelHlp());
1645 RTLogRelPrintf("***\n");
1646 DBGFR3Info(pVM, "activetimers", NULL, DBGFR3InfoLogRelHlp());
1647 RTLogRelPrintf("***\n");
1648 DBGFR3Info(pVM, "gdt", NULL, DBGFR3InfoLogRelHlp());
1649 /** @todo dump guest call stack. */
1650#if 1 // temporary while debugging #1589
1651 RTLogRelPrintf("***\n");
1652 uint32_t esp = CPUMGetGuestESP(pVCpu);
1653 if ( CPUMGetGuestSS(pVCpu) == 0
1654 && esp < _64K)
1655 {
1656 uint8_t abBuf[PAGE_SIZE];
1657 RTLogRelPrintf("***\n"
1658 "ss:sp=0000:%04x ", esp);
1659 uint32_t Start = esp & ~(uint32_t)63;
1660 int rc = PGMPhysSimpleReadGCPhys(pVM, abBuf, Start, 0x100);
1661 if (RT_SUCCESS(rc))
1662 RTLogRelPrintf("0000:%04x TO 0000:%04x:\n"
1663 "%.*Rhxd\n",
1664 Start, Start + 0x100 - 1,
1665 0x100, abBuf);
1666 else
1667 RTLogRelPrintf("rc=%Rrc\n", rc);
1668
1669 /* grub ... */
1670 if (esp < 0x2000 && esp > 0x1fc0)
1671 {
1672 rc = PGMPhysSimpleReadGCPhys(pVM, abBuf, 0x8000, 0x800);
1673 if (RT_SUCCESS(rc))
1674 RTLogRelPrintf("0000:8000 TO 0000:87ff:\n"
1675 "%.*Rhxd\n",
1676 0x800, abBuf);
1677 }
1678 /* microsoft cdrom hang ... */
1679 if (true)
1680 {
1681 rc = PGMPhysSimpleReadGCPhys(pVM, abBuf, 0x8000, 0x200);
1682 if (RT_SUCCESS(rc))
1683 RTLogRelPrintf("2000:0000 TO 2000:01ff:\n"
1684 "%.*Rhxd\n",
1685 0x200, abBuf);
1686 }
1687 }
1688#endif
1689 RTLogRelPrintf("************** End of Guest state at power off ***************\n");
1690 }
1691
1692 /*
1693 * Change the state to OFF and notify the components.
1694 */
1695 vmR3SetState(pVM, VMSTATE_OFF);
1696 PDMR3PowerOff(pVM);
1697
1698 return VINF_EM_OFF;
1699}
1700
1701
1702/**
1703 * Destroys the VM.
1704 * The VM must be powered off (or never really powered on) to call this function.
1705 * The VM handle is destroyed and can no longer be used up successful return.
1706 *
1707 * @returns VBox status code.
1708 * @param pVM VM which should be destroyed.
1709 * @thread Any thread but the emulation thread.
1710 * @vmstate Off, Created
1711 * @vmstateto N/A
1712 */
1713VMMR3DECL(int) VMR3Destroy(PVM pVM)
1714{
1715 LogFlow(("VMR3Destroy: pVM=%p\n", pVM));
1716
1717 /*
1718 * Validate input.
1719 */
1720 if (!pVM)
1721 return VERR_INVALID_PARAMETER;
1722 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
1723 AssertMsgReturn( pVM->enmVMState == VMSTATE_OFF
1724 || pVM->enmVMState == VMSTATE_CREATED,
1725 ("Invalid VM state %d\n", pVM->enmVMState),
1726 VERR_VM_INVALID_VM_STATE);
1727
1728 /*
1729 * Change VM state to destroying and unlink the VM.
1730 */
1731 vmR3SetState(pVM, VMSTATE_DESTROYING);
1732
1733 /** @todo lock this when we start having multiple machines in a process... */
1734 PUVM pUVM = pVM->pUVM; AssertPtr(pUVM);
1735 if (g_pUVMsHead == pUVM)
1736 g_pUVMsHead = pUVM->pNext;
1737 else
1738 {
1739 PUVM pPrev = g_pUVMsHead;
1740 while (pPrev && pPrev->pNext != pUVM)
1741 pPrev = pPrev->pNext;
1742 AssertMsgReturn(pPrev, ("pUVM=%p / pVM=%p is INVALID!\n", pUVM, pVM), VERR_INVALID_PARAMETER);
1743
1744 pPrev->pNext = pUVM->pNext;
1745 }
1746 pUVM->pNext = NULL;
1747
1748 /*
1749 * Notify registered at destruction listeners.
1750 * (That's the debugger console.)
1751 */
1752 vmR3AtDtor(pVM);
1753
1754 /*
1755 * If we are the EMT of VCPU 0, then we'll delay the cleanup till later.
1756 */
1757 if (VMMGetCpuId(pVM) == 0)
1758 {
1759 pUVM->vm.s.fEMTDoesTheCleanup = true;
1760 pUVM->vm.s.fTerminateEMT = true;
1761 VM_FF_SET(pVM, VM_FF_TERMINATE);
1762
1763 /* Inform all other VCPUs too. */
1764 for (VMCPUID idCpu = 1; idCpu < pVM->cCPUs; idCpu++)
1765 {
1766 /*
1767 * Request EMT to do the larger part of the destruction.
1768 */
1769 PVMREQ pReq = NULL;
1770 int rc = VMR3ReqCallU(pUVM, idCpu, &pReq, RT_INDEFINITE_WAIT, 0, (PFNRT)vmR3Destroy, 1, pVM);
1771 if (RT_SUCCESS(rc))
1772 rc = pReq->iStatus;
1773 AssertRC(rc);
1774 VMR3ReqFree(pReq);
1775 }
1776 }
1777 else
1778 {
1779 /*
1780 * Request EMT to do the larger part of the destruction. (in reverse order as VCPU 0 does the real cleanup)
1781 */
1782 PVMREQ pReq = NULL;
1783 int rc = VMR3ReqCallU(pUVM, VMCPUID_ALL_REVERSE, &pReq, RT_INDEFINITE_WAIT, 0, (PFNRT)vmR3Destroy, 1, pVM);
1784 if (RT_SUCCESS(rc))
1785 rc = pReq->iStatus;
1786 AssertRC(rc);
1787 VMR3ReqFree(pReq);
1788
1789 /*
1790 * Now do the final bit where the heap and VM structures are freed up.
1791 * This will also wait 30 secs for the emulation threads to terminate.
1792 */
1793 vmR3DestroyUVM(pUVM, 30000);
1794 }
1795
1796 LogFlow(("VMR3Destroy: returns VINF_SUCCESS\n"));
1797 return VINF_SUCCESS;
1798}
1799
1800
1801/**
1802 * Internal destruction worker.
1803 *
1804 * This will do nearly all of the job, including sacking the EMT.
1805 *
1806 * @returns VBox status.
1807 * @param pVM VM handle.
1808 */
1809DECLCALLBACK(int) vmR3Destroy(PVM pVM)
1810{
1811 PUVM pUVM = pVM->pUVM;
1812 PVMCPU pVCpu = VMMGetCpu(pVM);
1813
1814 NOREF(pUVM);
1815 LogFlow(("vmR3Destroy: pVM=%p pUVM=%p\n", pVM, pUVM));
1816 VM_ASSERT_EMT(pVM);
1817
1818 /* Only VCPU 0 does the full cleanup. */
1819 if (pVCpu->idCpu != 0)
1820 return VINF_EM_TERMINATE;
1821
1822 /*
1823 * Dump statistics to the log.
1824 */
1825#if defined(VBOX_WITH_STATISTICS) || defined(LOG_ENABLED)
1826 RTLogFlags(NULL, "nodisabled nobuffered");
1827#endif
1828#ifdef VBOX_WITH_STATISTICS
1829 STAMR3Dump(pVM, "*");
1830#else
1831 LogRel(("************************* Statistics *************************\n"));
1832 STAMR3DumpToReleaseLog(pVM, "*");
1833 LogRel(("********************* End of statistics **********************\n"));
1834#endif
1835
1836 /*
1837 * Destroy the VM components.
1838 */
1839 int rc = TMR3Term(pVM);
1840 AssertRC(rc);
1841#ifdef VBOX_WITH_DEBUGGER
1842 rc = DBGCTcpTerminate(pVM, pUVM->vm.s.pvDBGC);
1843 pVM->pUVM->vm.s.pvDBGC = NULL;
1844#endif
1845 AssertRC(rc);
1846 rc = DBGFR3Term(pVM);
1847 AssertRC(rc);
1848 rc = PDMR3Term(pVM);
1849 AssertRC(rc);
1850 rc = EMR3Term(pVM);
1851 AssertRC(rc);
1852 rc = IOMR3Term(pVM);
1853 AssertRC(rc);
1854 rc = CSAMR3Term(pVM);
1855 AssertRC(rc);
1856 rc = PATMR3Term(pVM);
1857 AssertRC(rc);
1858 rc = TRPMR3Term(pVM);
1859 AssertRC(rc);
1860 rc = SELMR3Term(pVM);
1861 AssertRC(rc);
1862 rc = REMR3Term(pVM);
1863 AssertRC(rc);
1864 rc = HWACCMR3Term(pVM);
1865 AssertRC(rc);
1866 rc = PGMR3Term(pVM);
1867 AssertRC(rc);
1868 rc = VMMR3Term(pVM); /* Terminates the ring-0 code! */
1869 AssertRC(rc);
1870 rc = CPUMR3Term(pVM);
1871 AssertRC(rc);
1872 rc = PDMR3CritSectTerm(pVM);
1873 AssertRC(rc);
1874 rc = MMR3Term(pVM);
1875 AssertRC(rc);
1876
1877 /*
1878 * We're done in this thread (EMT).
1879 */
1880 ASMAtomicUoWriteBool(&pVM->pUVM->vm.s.fTerminateEMT, true);
1881 ASMAtomicWriteU32(&pVM->fGlobalForcedActions, VM_FF_TERMINATE);
1882 LogFlow(("vmR3Destroy: returning %Rrc\n", VINF_EM_TERMINATE));
1883 return VINF_EM_TERMINATE;
1884}
1885
1886
1887/**
1888 * Destroys the shared VM structure, leaving only UVM behind.
1889 *
1890 * This is called by EMT right before terminating.
1891 *
1892 * @param pUVM The UVM handle.
1893 */
1894void vmR3DestroyFinalBitFromEMT(PUVM pUVM)
1895{
1896 if (pUVM->pVM)
1897 {
1898 PVMCPU pVCpu = VMMGetCpu(pUVM->pVM);
1899
1900 /* VCPU 0 does all the cleanup work. */
1901 if (pVCpu->idCpu != 0)
1902 return;
1903
1904 /*
1905 * Modify state and then terminate MM.
1906 * (MM must be delayed until this point so we don't destroy the callbacks and the request packet.)
1907 */
1908 vmR3SetState(pUVM->pVM, VMSTATE_TERMINATED);
1909
1910 /*
1911 * Tell GVMM to destroy the VM and free its resources.
1912 */
1913 int rc = SUPR3CallVMMR0Ex(pUVM->pVM->pVMR0, 0 /*idCpu*/, VMMR0_DO_GVMM_DESTROY_VM, 0, NULL);
1914 AssertRC(rc);
1915 pUVM->pVM = NULL;
1916 }
1917
1918 /*
1919 * Did an EMT call VMR3Destroy and end up having to do all the work?
1920 */
1921 if (pUVM->vm.s.fEMTDoesTheCleanup)
1922 vmR3DestroyUVM(pUVM, 30000);
1923}
1924
1925
1926/**
1927 * Destroys the UVM portion.
1928 *
1929 * This is called as the final step in the VM destruction or as the cleanup
1930 * in case of a creation failure. If EMT called VMR3Destroy, meaning
1931 * VMINTUSERPERVM::fEMTDoesTheCleanup is true, it will call this as
1932 * vmR3DestroyFinalBitFromEMT completes.
1933 *
1934 * @param pVM VM Handle.
1935 * @param cMilliesEMTWait The number of milliseconds to wait for the emulation
1936 * threads.
1937 */
1938static void vmR3DestroyUVM(PUVM pUVM, uint32_t cMilliesEMTWait)
1939{
1940 /*
1941 * Signal termination of each the emulation threads and
1942 * wait for them to complete.
1943 */
1944 /* Signal them. */
1945 ASMAtomicUoWriteBool(&pUVM->vm.s.fTerminateEMT, true);
1946 for (VMCPUID i = 0; i < pUVM->cCpus; i++)
1947 {
1948 ASMAtomicUoWriteBool(&pUVM->aCpus[i].vm.s.fTerminateEMT, true);
1949 if (pUVM->pVM)
1950 VM_FF_SET(pUVM->pVM, VM_FF_TERMINATE);
1951 VMR3NotifyGlobalFFU(pUVM, VMNOTIFYFF_FLAGS_DONE_REM);
1952 RTSemEventSignal(pUVM->aCpus[i].vm.s.EventSemWait);
1953 }
1954
1955 /* Wait for them. */
1956 uint64_t NanoTS = RTTimeNanoTS();
1957 RTTHREAD hSelf = RTThreadSelf();
1958 ASMAtomicUoWriteBool(&pUVM->vm.s.fTerminateEMT, true);
1959 for (VMCPUID i = 0; i < pUVM->cCpus; i++)
1960 {
1961 RTTHREAD hThread = pUVM->aCpus[i].vm.s.ThreadEMT;
1962 if ( hThread != NIL_RTTHREAD
1963 && hThread != hSelf)
1964 {
1965 uint64_t cMilliesElapsed = (RTTimeNanoTS() - NanoTS) / 1000000;
1966 int rc2 = RTThreadWait(hThread,
1967 cMilliesElapsed < cMilliesEMTWait
1968 ? RT_MAX(cMilliesEMTWait - cMilliesElapsed, 2000)
1969 : 2000,
1970 NULL);
1971 if (rc2 == VERR_TIMEOUT) /* avoid the assertion when debugging. */
1972 rc2 = RTThreadWait(hThread, 1000, NULL);
1973 AssertLogRelMsgRC(rc2, ("i=%u rc=%Rrc\n", i, rc2));
1974 if (RT_SUCCESS(rc2))
1975 pUVM->aCpus[0].vm.s.ThreadEMT = NIL_RTTHREAD;
1976 }
1977 }
1978
1979 /* Cleanup the semaphores. */
1980 for (VMCPUID i = 0; i < pUVM->cCpus; i++)
1981 {
1982 RTSemEventDestroy(pUVM->aCpus[i].vm.s.EventSemWait);
1983 pUVM->aCpus[i].vm.s.EventSemWait = NIL_RTSEMEVENT;
1984 }
1985
1986 /*
1987 * Free the event semaphores associated with the request packets.
1988 */
1989 unsigned cReqs = 0;
1990 for (unsigned i = 0; i < RT_ELEMENTS(pUVM->vm.s.apReqFree); i++)
1991 {
1992 PVMREQ pReq = pUVM->vm.s.apReqFree[i];
1993 pUVM->vm.s.apReqFree[i] = NULL;
1994 for (; pReq; pReq = pReq->pNext, cReqs++)
1995 {
1996 pReq->enmState = VMREQSTATE_INVALID;
1997 RTSemEventDestroy(pReq->EventSem);
1998 }
1999 }
2000 Assert(cReqs == pUVM->vm.s.cReqFree); NOREF(cReqs);
2001
2002 /*
2003 * Kill all queued requests. (There really shouldn't be any!)
2004 */
2005 for (unsigned i = 0; i < 10; i++)
2006 {
2007 PVMREQ pReqHead = (PVMREQ)ASMAtomicXchgPtr((void *volatile *)&pUVM->vm.s.pReqs, NULL);
2008 AssertMsg(!pReqHead, ("This isn't supposed to happen! VMR3Destroy caller has to serialize this.\n"));
2009 if (!pReqHead)
2010 break;
2011 for (PVMREQ pReq = pReqHead; pReq; pReq = pReq->pNext)
2012 {
2013 ASMAtomicUoWriteSize(&pReq->iStatus, VERR_INTERNAL_ERROR);
2014 ASMAtomicWriteSize(&pReq->enmState, VMREQSTATE_INVALID);
2015 RTSemEventSignal(pReq->EventSem);
2016 RTThreadSleep(2);
2017 RTSemEventDestroy(pReq->EventSem);
2018 }
2019 /* give them a chance to respond before we free the request memory. */
2020 RTThreadSleep(32);
2021 }
2022
2023 /*
2024 * Now all queued VCPU requests (again, there shouldn't be any).
2025 */
2026 for (VMCPUID i = 0; i < pUVM->cCpus; i++)
2027 {
2028 PUVMCPU pUVCpu = &pUVM->aCpus[i];
2029
2030 for (unsigned i = 0; i < 10; i++)
2031 {
2032 PVMREQ pReqHead = (PVMREQ)ASMAtomicXchgPtr((void *volatile *)&pUVCpu->vm.s.pReqs, NULL);
2033 AssertMsg(!pReqHead, ("This isn't supposed to happen! VMR3Destroy caller has to serialize this.\n"));
2034 if (!pReqHead)
2035 break;
2036 for (PVMREQ pReq = pReqHead; pReq; pReq = pReq->pNext)
2037 {
2038 ASMAtomicUoWriteSize(&pReq->iStatus, VERR_INTERNAL_ERROR);
2039 ASMAtomicWriteSize(&pReq->enmState, VMREQSTATE_INVALID);
2040 RTSemEventSignal(pReq->EventSem);
2041 RTThreadSleep(2);
2042 RTSemEventDestroy(pReq->EventSem);
2043 }
2044 /* give them a chance to respond before we free the request memory. */
2045 RTThreadSleep(32);
2046 }
2047 }
2048
2049 /*
2050 * Make sure the VMMR0.r0 module and whatever else is unloaded.
2051 */
2052 PDMR3TermUVM(pUVM);
2053
2054 /*
2055 * Terminate the support library if initialized.
2056 */
2057 if (pUVM->vm.s.pSession)
2058 {
2059 int rc = SUPR3Term(false /*fForced*/);
2060 AssertRC(rc);
2061 pUVM->vm.s.pSession = NIL_RTR0PTR;
2062 }
2063
2064 /*
2065 * Destroy the MM heap and free the UVM structure.
2066 */
2067 MMR3TermUVM(pUVM);
2068 STAMR3TermUVM(pUVM);
2069
2070#ifdef LOG_ENABLED
2071 RTLogSetCustomPrefixCallback(NULL, NULL, NULL);
2072#endif
2073 RTTlsFree(pUVM->vm.s.idxTLS);
2074
2075 ASMAtomicUoWriteU32(&pUVM->u32Magic, UINT32_MAX);
2076 RTMemFree(pUVM);
2077
2078 RTLogFlush(NULL);
2079}
2080
2081
2082/**
2083 * Enumerates the VMs in this process.
2084 *
2085 * @returns Pointer to the next VM.
2086 * @returns NULL when no more VMs.
2087 * @param pVMPrev The previous VM
2088 * Use NULL to start the enumeration.
2089 */
2090VMMR3DECL(PVM) VMR3EnumVMs(PVM pVMPrev)
2091{
2092 /*
2093 * This is quick and dirty. It has issues with VM being
2094 * destroyed during the enumeration.
2095 */
2096 PUVM pNext;
2097 if (pVMPrev)
2098 pNext = pVMPrev->pUVM->pNext;
2099 else
2100 pNext = g_pUVMsHead;
2101 return pNext ? pNext->pVM : NULL;
2102}
2103
2104
2105/**
2106 * Registers an at VM destruction callback.
2107 *
2108 * @returns VBox status code.
2109 * @param pfnAtDtor Pointer to callback.
2110 * @param pvUser User argument.
2111 */
2112VMMR3DECL(int) VMR3AtDtorRegister(PFNVMATDTOR pfnAtDtor, void *pvUser)
2113{
2114 /*
2115 * Check if already registered.
2116 */
2117 VM_ATDTOR_LOCK();
2118 PVMATDTOR pCur = g_pVMAtDtorHead;
2119 while (pCur)
2120 {
2121 if (pfnAtDtor == pCur->pfnAtDtor)
2122 {
2123 VM_ATDTOR_UNLOCK();
2124 AssertMsgFailed(("Already registered at destruction callback %p!\n", pfnAtDtor));
2125 return VERR_INVALID_PARAMETER;
2126 }
2127
2128 /* next */
2129 pCur = pCur->pNext;
2130 }
2131 VM_ATDTOR_UNLOCK();
2132
2133 /*
2134 * Allocate new entry.
2135 */
2136 PVMATDTOR pVMAtDtor = (PVMATDTOR)RTMemAlloc(sizeof(*pVMAtDtor));
2137 if (!pVMAtDtor)
2138 return VERR_NO_MEMORY;
2139
2140 VM_ATDTOR_LOCK();
2141 pVMAtDtor->pfnAtDtor = pfnAtDtor;
2142 pVMAtDtor->pvUser = pvUser;
2143 pVMAtDtor->pNext = g_pVMAtDtorHead;
2144 g_pVMAtDtorHead = pVMAtDtor;
2145 VM_ATDTOR_UNLOCK();
2146
2147 return VINF_SUCCESS;
2148}
2149
2150
2151/**
2152 * Deregisters an at VM destruction callback.
2153 *
2154 * @returns VBox status code.
2155 * @param pfnAtDtor Pointer to callback.
2156 */
2157VMMR3DECL(int) VMR3AtDtorDeregister(PFNVMATDTOR pfnAtDtor)
2158{
2159 /*
2160 * Find it, unlink it and free it.
2161 */
2162 VM_ATDTOR_LOCK();
2163 PVMATDTOR pPrev = NULL;
2164 PVMATDTOR pCur = g_pVMAtDtorHead;
2165 while (pCur)
2166 {
2167 if (pfnAtDtor == pCur->pfnAtDtor)
2168 {
2169 if (pPrev)
2170 pPrev->pNext = pCur->pNext;
2171 else
2172 g_pVMAtDtorHead = pCur->pNext;
2173 pCur->pNext = NULL;
2174 VM_ATDTOR_UNLOCK();
2175
2176 RTMemFree(pCur);
2177 return VINF_SUCCESS;
2178 }
2179
2180 /* next */
2181 pPrev = pCur;
2182 pCur = pCur->pNext;
2183 }
2184 VM_ATDTOR_UNLOCK();
2185
2186 return VERR_INVALID_PARAMETER;
2187}
2188
2189
2190/**
2191 * Walks the list of at VM destructor callbacks.
2192 * @param pVM The VM which is about to be destroyed.
2193 */
2194static void vmR3AtDtor(PVM pVM)
2195{
2196 /*
2197 * Find it, unlink it and free it.
2198 */
2199 VM_ATDTOR_LOCK();
2200 for (PVMATDTOR pCur = g_pVMAtDtorHead; pCur; pCur = pCur->pNext)
2201 pCur->pfnAtDtor(pVM, pCur->pvUser);
2202 VM_ATDTOR_UNLOCK();
2203}
2204
2205
2206/**
2207 * Reset the current VM.
2208 *
2209 * @returns VBox status code.
2210 * @param pVM VM to reset.
2211 */
2212VMMR3DECL(int) VMR3Reset(PVM pVM)
2213{
2214 int rc = VINF_SUCCESS;
2215
2216 /*
2217 * Check the state.
2218 */
2219 if (!pVM)
2220 return VERR_INVALID_PARAMETER;
2221 if ( pVM->enmVMState != VMSTATE_RUNNING
2222 && pVM->enmVMState != VMSTATE_SUSPENDED)
2223 {
2224 AssertMsgFailed(("Invalid VM state %d\n", pVM->enmVMState));
2225 return VERR_VM_INVALID_VM_STATE;
2226 }
2227
2228 /*
2229 * Queue reset request to the emulation thread
2230 * and wait for it to be processed. (in reverse order as VCPU 0 does the real cleanup)
2231 */
2232 PVMREQ pReq = NULL;
2233 rc = VMR3ReqCall(pVM, VMCPUID_ALL_REVERSE, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3Reset, 1, pVM);
2234 if (RT_SUCCESS(rc))
2235 rc = pReq->iStatus;
2236 AssertRC(rc);
2237 VMR3ReqFree(pReq);
2238
2239 return rc;
2240}
2241
2242
2243/**
2244 * Worker which checks integrity of some internal structures.
2245 * This is yet another attempt to track down that AVL tree crash.
2246 */
2247static void vmR3CheckIntegrity(PVM pVM)
2248{
2249#ifdef VBOX_STRICT
2250 int rc = PGMR3CheckIntegrity(pVM);
2251 AssertReleaseRC(rc);
2252#endif
2253}
2254
2255
2256/**
2257 * Reset request processor.
2258 *
2259 * This is called by the emulation threads as a response to the
2260 * reset request issued by VMR3Reset().
2261 *
2262 * @returns VBox status code.
2263 * @param pVM VM to reset.
2264 */
2265static DECLCALLBACK(int) vmR3Reset(PVM pVM)
2266{
2267 PVMCPU pVCpu = VMMGetCpu(pVM);
2268
2269 /*
2270 * EMT(0) does the full cleanup *after* all the other EMTs has been
2271 * thru here and been told to enter the EMSTATE_WAIT_SIPI state.
2272 */
2273 VMCPU_ASSERT_STATE(pVCpu, VMCPUSTATE_STARTED);
2274
2275 /* Clear all pending forced actions. */
2276 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_ALL_MASK & ~VMCPU_FF_REQUEST);
2277
2278 if (pVCpu->idCpu != 0)
2279 {
2280 CPUMR3ResetCpu(pVCpu);
2281 return VINF_EM_RESET;
2282 }
2283
2284 /*
2285 * As a safety precaution we temporarily change the state while resetting.
2286 * (If VMR3Reset was not called from EMT we might have change state... let's ignore that fact for now.)
2287 */
2288 VMSTATE enmVMState = pVM->enmVMState;
2289 Assert(enmVMState == VMSTATE_SUSPENDED || enmVMState == VMSTATE_RUNNING);
2290 vmR3SetState(pVM, VMSTATE_RESETTING);
2291 vmR3CheckIntegrity(pVM);
2292
2293
2294 /*
2295 * Reset the VM components.
2296 */
2297 PATMR3Reset(pVM);
2298 CSAMR3Reset(pVM);
2299 PGMR3Reset(pVM); /* We clear VM RAM in PGMR3Reset. It's vital PDMR3Reset is executed
2300 * _afterwards_. E.g. ACPI sets up RAM tables during init/reset. */
2301 MMR3Reset(pVM);
2302 PDMR3Reset(pVM);
2303 SELMR3Reset(pVM);
2304 TRPMR3Reset(pVM);
2305 vmR3AtResetU(pVM->pUVM);
2306 REMR3Reset(pVM);
2307 IOMR3Reset(pVM);
2308 CPUMR3Reset(pVM);
2309 TMR3Reset(pVM);
2310 EMR3Reset(pVM);
2311 HWACCMR3Reset(pVM); /* This must come *after* PATM, CSAM, CPUM, SELM and TRPM. */
2312
2313#ifdef LOG_ENABLED
2314 /*
2315 * Debug logging.
2316 */
2317 RTLogPrintf("\n\nThe VM was reset:\n");
2318 DBGFR3Info(pVM, "cpum", "verbose", NULL);
2319#endif
2320
2321 /*
2322 * Restore the state.
2323 */
2324 vmR3CheckIntegrity(pVM);
2325 Assert(pVM->enmVMState == VMSTATE_RESETTING);
2326 vmR3SetState(pVM, enmVMState);
2327
2328 return VINF_EM_RESET;
2329}
2330
2331
2332/**
2333 * Walks the list of at VM reset callbacks and calls them
2334 *
2335 * @returns VBox status code.
2336 * Any failure is fatal.
2337 * @param pUVM Pointe to the user mode VM structure.
2338 */
2339static int vmR3AtResetU(PUVM pUVM)
2340{
2341 /*
2342 * Walk the list and call them all.
2343 */
2344 int rc = VINF_SUCCESS;
2345 for (PVMATRESET pCur = pUVM->vm.s.pAtReset; pCur; pCur = pCur->pNext)
2346 {
2347 /* do the call */
2348 switch (pCur->enmType)
2349 {
2350 case VMATRESETTYPE_DEV:
2351 rc = pCur->u.Dev.pfnCallback(pCur->u.Dev.pDevIns, pCur->pvUser);
2352 break;
2353 case VMATRESETTYPE_INTERNAL:
2354 rc = pCur->u.Internal.pfnCallback(pUVM->pVM, pCur->pvUser);
2355 break;
2356 case VMATRESETTYPE_EXTERNAL:
2357 pCur->u.External.pfnCallback(pCur->pvUser);
2358 break;
2359 default:
2360 AssertMsgFailed(("Invalid at-reset type %d!\n", pCur->enmType));
2361 return VERR_INTERNAL_ERROR;
2362 }
2363
2364 if (RT_FAILURE(rc))
2365 {
2366 AssertMsgFailed(("At-reset handler %s failed with rc=%d\n", pCur->pszDesc, rc));
2367 return rc;
2368 }
2369 }
2370
2371 return VINF_SUCCESS;
2372}
2373
2374
2375/**
2376 * Internal registration function
2377 */
2378static int vmr3AtResetRegisterU(PUVM pUVM, void *pvUser, const char *pszDesc, PVMATRESET *ppNew)
2379{
2380 /*
2381 * Allocate restration structure.
2382 */
2383 PVMATRESET pNew = (PVMATRESET)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
2384 if (pNew)
2385 {
2386 /* fill data. */
2387 pNew->pszDesc = pszDesc;
2388 pNew->pvUser = pvUser;
2389
2390 /* insert */
2391 pNew->pNext = *pUVM->vm.s.ppAtResetNext;
2392 *pUVM->vm.s.ppAtResetNext = pNew;
2393 pUVM->vm.s.ppAtResetNext = &pNew->pNext;
2394
2395 *ppNew = pNew;
2396 return VINF_SUCCESS;
2397 }
2398 return VERR_NO_MEMORY;
2399}
2400
2401
2402/**
2403 * Registers an at VM reset callback.
2404 *
2405 * @returns VBox status code.
2406 * @param pVM The VM.
2407 * @param pDevInst Device instance.
2408 * @param pfnCallback Callback function.
2409 * @param pvUser User argument.
2410 * @param pszDesc Description (optional).
2411 */
2412VMMR3DECL(int) VMR3AtResetRegister(PVM pVM, PPDMDEVINS pDevInst, PFNVMATRESET pfnCallback, void *pvUser, const char *pszDesc)
2413{
2414 /*
2415 * Validate.
2416 */
2417 if (!pDevInst)
2418 {
2419 AssertMsgFailed(("pDevIns is NULL!\n"));
2420 return VERR_INVALID_PARAMETER;
2421 }
2422
2423 /*
2424 * Create the new entry.
2425 */
2426 PVMATRESET pNew;
2427 int rc = vmr3AtResetRegisterU(pVM->pUVM, pvUser, pszDesc, &pNew);
2428 if (RT_SUCCESS(rc))
2429 {
2430 /*
2431 * Fill in type data.
2432 */
2433 pNew->enmType = VMATRESETTYPE_DEV;
2434 pNew->u.Dev.pfnCallback = pfnCallback;
2435 pNew->u.Dev.pDevIns = pDevInst;
2436 }
2437
2438 return rc;
2439}
2440
2441
2442/**
2443 * Registers an at VM reset internal callback.
2444 *
2445 * @returns VBox status code.
2446 * @param pVM The VM.
2447 * @param pfnCallback Callback function.
2448 * @param pvUser User argument.
2449 * @param pszDesc Description (optional).
2450 */
2451VMMR3DECL(int) VMR3AtResetRegisterInternal(PVM pVM, PFNVMATRESETINT pfnCallback, void *pvUser, const char *pszDesc)
2452{
2453 /*
2454 * Validate.
2455 */
2456 if (!pfnCallback)
2457 {
2458 AssertMsgFailed(("pfnCallback is NULL!\n"));
2459 return VERR_INVALID_PARAMETER;
2460 }
2461
2462 /*
2463 * Create the new entry.
2464 */
2465 PVMATRESET pNew;
2466 int rc = vmr3AtResetRegisterU(pVM->pUVM, pvUser, pszDesc, &pNew);
2467 if (RT_SUCCESS(rc))
2468 {
2469 /*
2470 * Fill in type data.
2471 */
2472 pNew->enmType = VMATRESETTYPE_INTERNAL;
2473 pNew->u.Internal.pfnCallback = pfnCallback;
2474 }
2475
2476 return rc;
2477}
2478
2479
2480/**
2481 * Registers an at VM reset external callback.
2482 *
2483 * @returns VBox status code.
2484 * @param pVM The VM.
2485 * @param pfnCallback Callback function.
2486 * @param pvUser User argument.
2487 * @param pszDesc Description (optional).
2488 */
2489VMMR3DECL(int) VMR3AtResetRegisterExternal(PVM pVM, PFNVMATRESETEXT pfnCallback, void *pvUser, const char *pszDesc)
2490{
2491 /*
2492 * Validate.
2493 */
2494 if (!pfnCallback)
2495 {
2496 AssertMsgFailed(("pfnCallback is NULL!\n"));
2497 return VERR_INVALID_PARAMETER;
2498 }
2499
2500 /*
2501 * Create the new entry.
2502 */
2503 PVMATRESET pNew;
2504 int rc = vmr3AtResetRegisterU(pVM->pUVM, pvUser, pszDesc, &pNew);
2505 if (RT_SUCCESS(rc))
2506 {
2507 /*
2508 * Fill in type data.
2509 */
2510 pNew->enmType = VMATRESETTYPE_EXTERNAL;
2511 pNew->u.External.pfnCallback = pfnCallback;
2512 }
2513
2514 return rc;
2515}
2516
2517
2518/**
2519 * Unlinks and frees a callback.
2520 *
2521 * @returns Pointer to the next callback structure.
2522 * @param pUVM Pointer to the user mode VM structure.
2523 * @param pCur The one to free.
2524 * @param pPrev The one before pCur.
2525 */
2526static PVMATRESET vmr3AtResetFreeU(PUVM pUVM, PVMATRESET pCur, PVMATRESET pPrev)
2527{
2528 /*
2529 * Unlink it.
2530 */
2531 PVMATRESET pNext = pCur->pNext;
2532 if (pPrev)
2533 {
2534 pPrev->pNext = pNext;
2535 if (!pNext)
2536 pUVM->vm.s.ppAtResetNext = &pPrev->pNext;
2537 }
2538 else
2539 {
2540 pUVM->vm.s.pAtReset = pNext;
2541 if (!pNext)
2542 pUVM->vm.s.ppAtResetNext = &pUVM->vm.s.pAtReset;
2543 }
2544
2545 /*
2546 * Free it.
2547 */
2548 MMR3HeapFree(pCur);
2549
2550 return pNext;
2551}
2552
2553
2554/**
2555 * Deregisters an at VM reset callback.
2556 *
2557 * @returns VBox status code.
2558 * @param pVM The VM.
2559 * @param pDevIns Device instance.
2560 * @param pfnCallback Callback function.
2561 */
2562VMMR3DECL(int) VMR3AtResetDeregister(PVM pVM, PPDMDEVINS pDevIns, PFNVMATRESET pfnCallback)
2563{
2564 int rc = VERR_VM_ATRESET_NOT_FOUND;
2565 PVMATRESET pPrev = NULL;
2566 PVMATRESET pCur = pVM->pUVM->vm.s.pAtReset;
2567 while (pCur)
2568 {
2569 if ( pCur->enmType == VMATRESETTYPE_DEV
2570 && pCur->u.Dev.pDevIns == pDevIns
2571 && ( !pfnCallback
2572 || pCur->u.Dev.pfnCallback == pfnCallback))
2573 {
2574 pCur = vmr3AtResetFreeU(pVM->pUVM, pCur, pPrev);
2575 rc = VINF_SUCCESS;
2576 }
2577 else
2578 {
2579 pPrev = pCur;
2580 pCur = pCur->pNext;
2581 }
2582 }
2583
2584 AssertRC(rc);
2585 return rc;
2586}
2587
2588
2589/**
2590 * Deregisters an at VM reset internal callback.
2591 *
2592 * @returns VBox status code.
2593 * @param pVM The VM.
2594 * @param pfnCallback Callback function.
2595 */
2596VMMR3DECL(int) VMR3AtResetDeregisterInternal(PVM pVM, PFNVMATRESETINT pfnCallback)
2597{
2598 int rc = VERR_VM_ATRESET_NOT_FOUND;
2599 PVMATRESET pPrev = NULL;
2600 PVMATRESET pCur = pVM->pUVM->vm.s.pAtReset;
2601 while (pCur)
2602 {
2603 if ( pCur->enmType == VMATRESETTYPE_INTERNAL
2604 && pCur->u.Internal.pfnCallback == pfnCallback)
2605 {
2606 pCur = vmr3AtResetFreeU(pVM->pUVM, pCur, pPrev);
2607 rc = VINF_SUCCESS;
2608 }
2609 else
2610 {
2611 pPrev = pCur;
2612 pCur = pCur->pNext;
2613 }
2614 }
2615
2616 AssertRC(rc);
2617 return rc;
2618}
2619
2620
2621/**
2622 * Deregisters an at VM reset external callback.
2623 *
2624 * @returns VBox status code.
2625 * @param pVM The VM.
2626 * @param pfnCallback Callback function.
2627 */
2628VMMR3DECL(int) VMR3AtResetDeregisterExternal(PVM pVM, PFNVMATRESETEXT pfnCallback)
2629{
2630 int rc = VERR_VM_ATRESET_NOT_FOUND;
2631 PVMATRESET pPrev = NULL;
2632 PVMATRESET pCur = pVM->pUVM->vm.s.pAtReset;
2633 while (pCur)
2634 {
2635 if ( pCur->enmType == VMATRESETTYPE_INTERNAL
2636 && pCur->u.External.pfnCallback == pfnCallback)
2637 {
2638 pCur = vmr3AtResetFreeU(pVM->pUVM, pCur, pPrev);
2639 rc = VINF_SUCCESS;
2640 }
2641 else
2642 {
2643 pPrev = pCur;
2644 pCur = pCur->pNext;
2645 }
2646 }
2647
2648 AssertRC(rc);
2649 return rc;
2650}
2651
2652
2653/**
2654 * Gets the current VM state.
2655 *
2656 * @returns The current VM state.
2657 * @param pVM VM handle.
2658 * @thread Any
2659 */
2660VMMR3DECL(VMSTATE) VMR3GetState(PVM pVM)
2661{
2662 return pVM->enmVMState;
2663}
2664
2665
2666/**
2667 * Gets the state name string for a VM state.
2668 *
2669 * @returns Pointer to the state name. (readonly)
2670 * @param enmState The state.
2671 */
2672VMMR3DECL(const char *) VMR3GetStateName(VMSTATE enmState)
2673{
2674 switch (enmState)
2675 {
2676 case VMSTATE_CREATING: return "CREATING";
2677 case VMSTATE_CREATED: return "CREATED";
2678 case VMSTATE_RUNNING: return "RUNNING";
2679 case VMSTATE_LOADING: return "LOADING";
2680 case VMSTATE_LOAD_FAILURE: return "LOAD_FAILURE";
2681 case VMSTATE_SAVING: return "SAVING";
2682 case VMSTATE_SUSPENDED: return "SUSPENDED";
2683 case VMSTATE_RESETTING: return "RESETTING";
2684 case VMSTATE_GURU_MEDITATION: return "GURU_MEDITATION";
2685 case VMSTATE_OFF: return "OFF";
2686 case VMSTATE_DESTROYING: return "DESTROYING";
2687 case VMSTATE_TERMINATED: return "TERMINATED";
2688 default:
2689 AssertMsgFailed(("Unknown state %d\n", enmState));
2690 return "Unknown!\n";
2691 }
2692}
2693
2694
2695/**
2696 * Sets the current VM state.
2697 *
2698 * @returns The current VM state.
2699 * @param pVM VM handle.
2700 * @param enmStateNew The new state.
2701 */
2702void vmR3SetState(PVM pVM, VMSTATE enmStateNew)
2703{
2704 /*
2705 * Validate state machine transitions before doing the actual change.
2706 */
2707 VMSTATE enmStateOld = pVM->enmVMState;
2708 switch (enmStateOld)
2709 {
2710 case VMSTATE_OFF:
2711 Assert(enmStateNew != VMSTATE_GURU_MEDITATION);
2712 break;
2713
2714 default:
2715 /** @todo full validation. */
2716 break;
2717 }
2718
2719 pVM->enmVMState = enmStateNew;
2720 LogRel(("Changing the VM state from '%s' to '%s'.\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)));
2721
2722 /*
2723 * Call the at state change callbacks.
2724 */
2725 for (PVMATSTATE pCur = pVM->pUVM->vm.s.pAtState; pCur; pCur = pCur->pNext)
2726 {
2727 pCur->pfnAtState(pVM, enmStateNew, enmStateOld, pCur->pvUser);
2728 if ( pVM->enmVMState != enmStateNew
2729 && pVM->enmVMState == VMSTATE_DESTROYING)
2730 break;
2731 AssertMsg(pVM->enmVMState == enmStateNew,
2732 ("You are not allowed to change the state while in the change callback, except "
2733 "from destroying the VM. There are restrictions in the way the state changes "
2734 "are propagated up to the EM execution loop and it makes the program flow very "
2735 "difficult to follow.\n"));
2736 }
2737}
2738
2739
2740/**
2741 * Registers a VM state change callback.
2742 *
2743 * You are not allowed to call any function which changes the VM state from a
2744 * state callback, except VMR3Destroy().
2745 *
2746 * @returns VBox status code.
2747 * @param pVM VM handle.
2748 * @param pfnAtState Pointer to callback.
2749 * @param pvUser User argument.
2750 * @thread Any.
2751 */
2752VMMR3DECL(int) VMR3AtStateRegister(PVM pVM, PFNVMATSTATE pfnAtState, void *pvUser)
2753{
2754 LogFlow(("VMR3AtStateRegister: pfnAtState=%p pvUser=%p\n", pfnAtState, pvUser));
2755
2756 /*
2757 * Validate input.
2758 */
2759 if (!pfnAtState)
2760 {
2761 AssertMsgFailed(("callback is required\n"));
2762 return VERR_INVALID_PARAMETER;
2763 }
2764
2765 /*
2766 * Make sure we're in EMT (to avoid the logging).
2767 */
2768 PVMREQ pReq;
2769 int rc = VMR3ReqCall(pVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3AtStateRegisterU, 3, pVM->pUVM, pfnAtState, pvUser);
2770 if (RT_FAILURE(rc))
2771 return rc;
2772 rc = pReq->iStatus;
2773 VMR3ReqFree(pReq);
2774
2775 LogFlow(("VMR3AtStateRegister: returns %Rrc\n", rc));
2776 return rc;
2777}
2778
2779
2780/**
2781 * Registers a VM state change callback.
2782 *
2783 * @returns VBox status code.
2784 * @param pUVM Pointer to the user mode VM structure.
2785 * @param pfnAtState Pointer to callback.
2786 * @param pvUser User argument.
2787 * @thread EMT
2788 */
2789static DECLCALLBACK(int) vmR3AtStateRegisterU(PUVM pUVM, PFNVMATSTATE pfnAtState, void *pvUser)
2790{
2791 /*
2792 * Allocate a new record.
2793 */
2794
2795 PVMATSTATE pNew = (PVMATSTATE)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
2796 if (!pNew)
2797 return VERR_NO_MEMORY;
2798
2799 /* fill */
2800 pNew->pfnAtState = pfnAtState;
2801 pNew->pvUser = pvUser;
2802
2803 /* insert */
2804 pNew->pNext = *pUVM->vm.s.ppAtStateNext;
2805 *pUVM->vm.s.ppAtStateNext = pNew;
2806 pUVM->vm.s.ppAtStateNext = &pNew->pNext;
2807
2808 return VINF_SUCCESS;
2809}
2810
2811
2812/**
2813 * Deregisters a VM state change callback.
2814 *
2815 * @returns VBox status code.
2816 * @param pVM VM handle.
2817 * @param pfnAtState Pointer to callback.
2818 * @param pvUser User argument.
2819 * @thread Any.
2820 */
2821VMMR3DECL(int) VMR3AtStateDeregister(PVM pVM, PFNVMATSTATE pfnAtState, void *pvUser)
2822{
2823 LogFlow(("VMR3AtStateDeregister: pfnAtState=%p pvUser=%p\n", pfnAtState, pvUser));
2824
2825 /*
2826 * Validate input.
2827 */
2828 if (!pfnAtState)
2829 {
2830 AssertMsgFailed(("callback is required\n"));
2831 return VERR_INVALID_PARAMETER;
2832 }
2833
2834 /*
2835 * Make sure we're in EMT (to avoid the logging).
2836 */
2837 PVMREQ pReq;
2838 int rc = VMR3ReqCall(pVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3AtStateDeregisterU, 3, pVM->pUVM, pfnAtState, pvUser);
2839 if (RT_FAILURE(rc))
2840 return rc;
2841 rc = pReq->iStatus;
2842 VMR3ReqFree(pReq);
2843
2844 LogFlow(("VMR3AtStateDeregister: returns %Rrc\n", rc));
2845 return rc;
2846}
2847
2848
2849/**
2850 * Deregisters a VM state change callback.
2851 *
2852 * @returns VBox status code.
2853 * @param pUVM Pointer to the user mode VM structure.
2854 * @param pfnAtState Pointer to callback.
2855 * @param pvUser User argument.
2856 * @thread EMT
2857 */
2858static DECLCALLBACK(int) vmR3AtStateDeregisterU(PUVM pUVM, PFNVMATSTATE pfnAtState, void *pvUser)
2859{
2860 LogFlow(("vmR3AtStateDeregisterU: pfnAtState=%p pvUser=%p\n", pfnAtState, pvUser));
2861
2862 /*
2863 * Search the list for the entry.
2864 */
2865 PVMATSTATE pPrev = NULL;
2866 PVMATSTATE pCur = pUVM->vm.s.pAtState;
2867 while ( pCur
2868 && ( pCur->pfnAtState != pfnAtState
2869 || pCur->pvUser != pvUser))
2870 {
2871 pPrev = pCur;
2872 pCur = pCur->pNext;
2873 }
2874 if (!pCur)
2875 {
2876 AssertMsgFailed(("pfnAtState=%p was not found\n", pfnAtState));
2877 return VERR_FILE_NOT_FOUND;
2878 }
2879
2880 /*
2881 * Unlink it.
2882 */
2883 if (pPrev)
2884 {
2885 pPrev->pNext = pCur->pNext;
2886 if (!pCur->pNext)
2887 pUVM->vm.s.ppAtStateNext = &pPrev->pNext;
2888 }
2889 else
2890 {
2891 pUVM->vm.s.pAtState = pCur->pNext;
2892 if (!pCur->pNext)
2893 pUVM->vm.s.ppAtStateNext = &pUVM->vm.s.pAtState;
2894 }
2895
2896 /*
2897 * Free it.
2898 */
2899 pCur->pfnAtState = NULL;
2900 pCur->pNext = NULL;
2901 MMR3HeapFree(pCur);
2902
2903 return VINF_SUCCESS;
2904}
2905
2906
2907/**
2908 * Registers a VM error callback.
2909 *
2910 * @returns VBox status code.
2911 * @param pVM The VM handle.
2912 * @param pfnAtError Pointer to callback.
2913 * @param pvUser User argument.
2914 * @thread Any.
2915 */
2916VMMR3DECL(int) VMR3AtErrorRegister(PVM pVM, PFNVMATERROR pfnAtError, void *pvUser)
2917{
2918 return VMR3AtErrorRegisterU(pVM->pUVM, pfnAtError, pvUser);
2919}
2920
2921
2922/**
2923 * Registers a VM error callback.
2924 *
2925 * @returns VBox status code.
2926 * @param pUVM The VM handle.
2927 * @param pfnAtError Pointer to callback.
2928 * @param pvUser User argument.
2929 * @thread Any.
2930 */
2931VMMR3DECL(int) VMR3AtErrorRegisterU(PUVM pUVM, PFNVMATERROR pfnAtError, void *pvUser)
2932{
2933 LogFlow(("VMR3AtErrorRegister: pfnAtError=%p pvUser=%p\n", pfnAtError, pvUser));
2934 AssertPtrReturn(pfnAtError, VERR_INVALID_PARAMETER);
2935
2936 /*
2937 * Make sure we're in EMT (to avoid the logging).
2938 */
2939 PVMREQ pReq;
2940 int rc = VMR3ReqCallU(pUVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, 0, (PFNRT)vmR3AtErrorRegisterU, 3, pUVM, pfnAtError, pvUser);
2941 if (RT_FAILURE(rc))
2942 return rc;
2943 rc = pReq->iStatus;
2944 VMR3ReqFree(pReq);
2945
2946 LogFlow(("VMR3AtErrorRegister: returns %Rrc\n", rc));
2947 return rc;
2948}
2949
2950
2951/**
2952 * Registers a VM error callback.
2953 *
2954 * @returns VBox status code.
2955 * @param pUVM Pointer to the user mode VM structure.
2956 * @param pfnAtError Pointer to callback.
2957 * @param pvUser User argument.
2958 * @thread EMT
2959 */
2960static DECLCALLBACK(int) vmR3AtErrorRegisterU(PUVM pUVM, PFNVMATERROR pfnAtError, void *pvUser)
2961{
2962 /*
2963 * Allocate a new record.
2964 */
2965
2966 PVMATERROR pNew = (PVMATERROR)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
2967 if (!pNew)
2968 return VERR_NO_MEMORY;
2969
2970 /* fill */
2971 pNew->pfnAtError = pfnAtError;
2972 pNew->pvUser = pvUser;
2973
2974 /* insert */
2975 pNew->pNext = *pUVM->vm.s.ppAtErrorNext;
2976 *pUVM->vm.s.ppAtErrorNext = pNew;
2977 pUVM->vm.s.ppAtErrorNext = &pNew->pNext;
2978
2979 return VINF_SUCCESS;
2980}
2981
2982
2983/**
2984 * Deregisters a VM error callback.
2985 *
2986 * @returns VBox status code.
2987 * @param pVM The VM handle.
2988 * @param pfnAtError Pointer to callback.
2989 * @param pvUser User argument.
2990 * @thread Any.
2991 */
2992VMMR3DECL(int) VMR3AtErrorDeregister(PVM pVM, PFNVMATERROR pfnAtError, void *pvUser)
2993{
2994 LogFlow(("VMR3AtErrorDeregister: pfnAtError=%p pvUser=%p\n", pfnAtError, pvUser));
2995
2996 /*
2997 * Validate input.
2998 */
2999 if (!pfnAtError)
3000 {
3001 AssertMsgFailed(("callback is required\n"));
3002 return VERR_INVALID_PARAMETER;
3003 }
3004
3005 /*
3006 * Make sure we're in EMT (to avoid the logging).
3007 */
3008 PVMREQ pReq;
3009 int rc = VMR3ReqCall(pVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3AtErrorDeregisterU, 3, pVM->pUVM, pfnAtError, pvUser);
3010 if (RT_FAILURE(rc))
3011 return rc;
3012 rc = pReq->iStatus;
3013 VMR3ReqFree(pReq);
3014
3015 LogFlow(("VMR3AtErrorDeregister: returns %Rrc\n", rc));
3016 return rc;
3017}
3018
3019
3020/**
3021 * Deregisters a VM error callback.
3022 *
3023 * @returns VBox status code.
3024 * @param pUVM Pointer to the user mode VM structure.
3025 * @param pfnAtError Pointer to callback.
3026 * @param pvUser User argument.
3027 * @thread EMT
3028 */
3029static DECLCALLBACK(int) vmR3AtErrorDeregisterU(PUVM pUVM, PFNVMATERROR pfnAtError, void *pvUser)
3030{
3031 LogFlow(("vmR3AtErrorDeregisterU: pfnAtError=%p pvUser=%p\n", pfnAtError, pvUser));
3032
3033 /*
3034 * Search the list for the entry.
3035 */
3036 PVMATERROR pPrev = NULL;
3037 PVMATERROR pCur = pUVM->vm.s.pAtError;
3038 while ( pCur
3039 && ( pCur->pfnAtError != pfnAtError
3040 || pCur->pvUser != pvUser))
3041 {
3042 pPrev = pCur;
3043 pCur = pCur->pNext;
3044 }
3045 if (!pCur)
3046 {
3047 AssertMsgFailed(("pfnAtError=%p was not found\n", pfnAtError));
3048 return VERR_FILE_NOT_FOUND;
3049 }
3050
3051 /*
3052 * Unlink it.
3053 */
3054 if (pPrev)
3055 {
3056 pPrev->pNext = pCur->pNext;
3057 if (!pCur->pNext)
3058 pUVM->vm.s.ppAtErrorNext = &pPrev->pNext;
3059 }
3060 else
3061 {
3062 pUVM->vm.s.pAtError = pCur->pNext;
3063 if (!pCur->pNext)
3064 pUVM->vm.s.ppAtErrorNext = &pUVM->vm.s.pAtError;
3065 }
3066
3067 /*
3068 * Free it.
3069 */
3070 pCur->pfnAtError = NULL;
3071 pCur->pNext = NULL;
3072 MMR3HeapFree(pCur);
3073
3074 return VINF_SUCCESS;
3075}
3076
3077
3078/**
3079 * Ellipsis to va_list wrapper for calling pfnAtError.
3080 */
3081static void vmR3SetErrorWorkerDoCall(PVM pVM, PVMATERROR pCur, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
3082{
3083 va_list va;
3084 va_start(va, pszFormat);
3085 pCur->pfnAtError(pVM, pCur->pvUser, rc, RT_SRC_POS_ARGS, pszFormat, va);
3086 va_end(va);
3087}
3088
3089
3090/**
3091 * This is a worker function for GC and Ring-0 calls to VMSetError and VMSetErrorV.
3092 * The message is found in VMINT.
3093 *
3094 * @param pVM The VM handle.
3095 * @thread EMT.
3096 */
3097VMMR3DECL(void) VMR3SetErrorWorker(PVM pVM)
3098{
3099 VM_ASSERT_EMT(pVM);
3100 AssertReleaseMsgFailed(("And we have a winner! You get to implement Ring-0 and GC VMSetErrorV! Contrats!\n"));
3101
3102 /*
3103 * Unpack the error (if we managed to format one).
3104 */
3105 PVMERROR pErr = pVM->vm.s.pErrorR3;
3106 const char *pszFile = NULL;
3107 const char *pszFunction = NULL;
3108 uint32_t iLine = 0;
3109 const char *pszMessage;
3110 int32_t rc = VERR_MM_HYPER_NO_MEMORY;
3111 if (pErr)
3112 {
3113 AssertCompile(sizeof(const char) == sizeof(uint8_t));
3114 if (pErr->offFile)
3115 pszFile = (const char *)pErr + pErr->offFile;
3116 iLine = pErr->iLine;
3117 if (pErr->offFunction)
3118 pszFunction = (const char *)pErr + pErr->offFunction;
3119 if (pErr->offMessage)
3120 pszMessage = (const char *)pErr + pErr->offMessage;
3121 else
3122 pszMessage = "No message!";
3123 }
3124 else
3125 pszMessage = "No message! (Failed to allocate memory to put the error message in!)";
3126
3127 /*
3128 * Call the at error callbacks.
3129 */
3130 for (PVMATERROR pCur = pVM->pUVM->vm.s.pAtError; pCur; pCur = pCur->pNext)
3131 vmR3SetErrorWorkerDoCall(pVM, pCur, rc, RT_SRC_POS_ARGS, "%s", pszMessage);
3132}
3133
3134
3135/**
3136 * Creation time wrapper for vmR3SetErrorUV.
3137 *
3138 * @returns rc.
3139 * @param pUVM Pointer to the user mode VM structure.
3140 * @param rc The VBox status code.
3141 * @param RT_SRC_POS_DECL The source position of this error.
3142 * @param pszFormat Format string.
3143 * @param ... The arguments.
3144 * @thread Any thread.
3145 */
3146static int vmR3SetErrorU(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
3147{
3148 va_list va;
3149 va_start(va, pszFormat);
3150 vmR3SetErrorUV(pUVM, rc, pszFile, iLine, pszFunction, pszFormat, &va);
3151 va_end(va);
3152 return rc;
3153}
3154
3155
3156/**
3157 * Worker which calls everyone listening to the VM error messages.
3158 *
3159 * @param pUVM Pointer to the user mode VM structure.
3160 * @param rc The VBox status code.
3161 * @param RT_SRC_POS_DECL The source position of this error.
3162 * @param pszFormat Format string.
3163 * @param pArgs Pointer to the format arguments.
3164 * @thread EMT
3165 */
3166DECLCALLBACK(void) vmR3SetErrorUV(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list *pArgs)
3167{
3168#ifdef LOG_ENABLED
3169 /*
3170 * Log the error.
3171 */
3172 RTLogPrintf("VMSetError: %s(%d) %s\n", pszFile, iLine, pszFunction);
3173 va_list va3;
3174 va_copy(va3, *pArgs);
3175 RTLogPrintfV(pszFormat, va3);
3176 va_end(va3);
3177 RTLogPrintf("\n");
3178#endif
3179
3180 /*
3181 * Make a copy of the message.
3182 */
3183 if (pUVM->pVM)
3184 vmSetErrorCopy(pUVM->pVM, rc, RT_SRC_POS_ARGS, pszFormat, *pArgs);
3185
3186 /*
3187 * Call the at error callbacks.
3188 */
3189 for (PVMATERROR pCur = pUVM->vm.s.pAtError; pCur; pCur = pCur->pNext)
3190 {
3191 va_list va2;
3192 va_copy(va2, *pArgs);
3193 pCur->pfnAtError(pUVM->pVM, pCur->pvUser, rc, RT_SRC_POS_ARGS, pszFormat, va2);
3194 va_end(va2);
3195 }
3196}
3197
3198
3199/**
3200 * Registers a VM runtime error callback.
3201 *
3202 * @returns VBox status code.
3203 * @param pVM The VM handle.
3204 * @param pfnAtRuntimeError Pointer to callback.
3205 * @param pvUser User argument.
3206 * @thread Any.
3207 */
3208VMMR3DECL(int) VMR3AtRuntimeErrorRegister(PVM pVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser)
3209{
3210 LogFlow(("VMR3AtRuntimeErrorRegister: pfnAtRuntimeError=%p pvUser=%p\n", pfnAtRuntimeError, pvUser));
3211
3212 /*
3213 * Validate input.
3214 */
3215 if (!pfnAtRuntimeError)
3216 {
3217 AssertMsgFailed(("callback is required\n"));
3218 return VERR_INVALID_PARAMETER;
3219 }
3220
3221 /*
3222 * Make sure we're in EMT (to avoid the logging).
3223 */
3224 PVMREQ pReq;
3225 int rc = VMR3ReqCall(pVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3AtRuntimeErrorRegisterU, 3, pVM->pUVM, pfnAtRuntimeError, pvUser);
3226 if (RT_FAILURE(rc))
3227 return rc;
3228 rc = pReq->iStatus;
3229 VMR3ReqFree(pReq);
3230
3231 LogFlow(("VMR3AtRuntimeErrorRegister: returns %Rrc\n", rc));
3232 return rc;
3233}
3234
3235
3236/**
3237 * Registers a VM runtime error callback.
3238 *
3239 * @returns VBox status code.
3240 * @param pUVM Pointer to the user mode VM structure.
3241 * @param pfnAtRuntimeError Pointer to callback.
3242 * @param pvUser User argument.
3243 * @thread EMT
3244 */
3245static DECLCALLBACK(int) vmR3AtRuntimeErrorRegisterU(PUVM pUVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser)
3246{
3247 /*
3248 * Allocate a new record.
3249 */
3250
3251 PVMATRUNTIMEERROR pNew = (PVMATRUNTIMEERROR)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
3252 if (!pNew)
3253 return VERR_NO_MEMORY;
3254
3255 /* fill */
3256 pNew->pfnAtRuntimeError = pfnAtRuntimeError;
3257 pNew->pvUser = pvUser;
3258
3259 /* insert */
3260 pNew->pNext = *pUVM->vm.s.ppAtRuntimeErrorNext;
3261 *pUVM->vm.s.ppAtRuntimeErrorNext = pNew;
3262 pUVM->vm.s.ppAtRuntimeErrorNext = &pNew->pNext;
3263
3264 return VINF_SUCCESS;
3265}
3266
3267
3268/**
3269 * Deregisters a VM runtime error callback.
3270 *
3271 * @returns VBox status code.
3272 * @param pVM The VM handle.
3273 * @param pfnAtRuntimeError Pointer to callback.
3274 * @param pvUser User argument.
3275 * @thread Any.
3276 */
3277VMMR3DECL(int) VMR3AtRuntimeErrorDeregister(PVM pVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser)
3278{
3279 LogFlow(("VMR3AtRuntimeErrorDeregister: pfnAtRuntimeError=%p pvUser=%p\n", pfnAtRuntimeError, pvUser));
3280
3281 /*
3282 * Validate input.
3283 */
3284 if (!pfnAtRuntimeError)
3285 {
3286 AssertMsgFailed(("callback is required\n"));
3287 return VERR_INVALID_PARAMETER;
3288 }
3289
3290 /*
3291 * Make sure we're in EMT (to avoid the logging).
3292 */
3293 PVMREQ pReq;
3294 int rc = VMR3ReqCall(pVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, (PFNRT)vmR3AtRuntimeErrorDeregisterU, 3, pVM->pUVM, pfnAtRuntimeError, pvUser);
3295 if (RT_FAILURE(rc))
3296 return rc;
3297 rc = pReq->iStatus;
3298 VMR3ReqFree(pReq);
3299
3300 LogFlow(("VMR3AtRuntimeErrorDeregister: returns %Rrc\n", rc));
3301 return rc;
3302}
3303
3304
3305/**
3306 * Deregisters a VM runtime error callback.
3307 *
3308 * @returns VBox status code.
3309 * @param pUVM Pointer to the user mode VM structure.
3310 * @param pfnAtRuntimeError Pointer to callback.
3311 * @param pvUser User argument.
3312 * @thread EMT
3313 */
3314static DECLCALLBACK(int) vmR3AtRuntimeErrorDeregisterU(PUVM pUVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser)
3315{
3316 LogFlow(("vmR3AtRuntimeErrorDeregisterU: pfnAtRuntimeError=%p pvUser=%p\n", pfnAtRuntimeError, pvUser));
3317
3318 /*
3319 * Search the list for the entry.
3320 */
3321 PVMATRUNTIMEERROR pPrev = NULL;
3322 PVMATRUNTIMEERROR pCur = pUVM->vm.s.pAtRuntimeError;
3323 while ( pCur
3324 && ( pCur->pfnAtRuntimeError != pfnAtRuntimeError
3325 || pCur->pvUser != pvUser))
3326 {
3327 pPrev = pCur;
3328 pCur = pCur->pNext;
3329 }
3330 if (!pCur)
3331 {
3332 AssertMsgFailed(("pfnAtRuntimeError=%p was not found\n", pfnAtRuntimeError));
3333 return VERR_FILE_NOT_FOUND;
3334 }
3335
3336 /*
3337 * Unlink it.
3338 */
3339 if (pPrev)
3340 {
3341 pPrev->pNext = pCur->pNext;
3342 if (!pCur->pNext)
3343 pUVM->vm.s.ppAtRuntimeErrorNext = &pPrev->pNext;
3344 }
3345 else
3346 {
3347 pUVM->vm.s.pAtRuntimeError = pCur->pNext;
3348 if (!pCur->pNext)
3349 pUVM->vm.s.ppAtRuntimeErrorNext = &pUVM->vm.s.pAtRuntimeError;
3350 }
3351
3352 /*
3353 * Free it.
3354 */
3355 pCur->pfnAtRuntimeError = NULL;
3356 pCur->pNext = NULL;
3357 MMR3HeapFree(pCur);
3358
3359 return VINF_SUCCESS;
3360}
3361
3362
3363/**
3364 * Worker for VMR3SetRuntimeErrorWorker and vmR3SetRuntimeErrorV.
3365 *
3366 * This does the common parts after the error has been saved / retrieved.
3367 *
3368 * @returns VBox status code with modifications, see VMSetRuntimeErrorV.
3369 *
3370 * @param pVM The VM handle.
3371 * @param fFlags The error flags.
3372 * @param pszErrorId Error ID string.
3373 * @param pszFormat Format string.
3374 * @param pVa Pointer to the format arguments.
3375 */
3376static int vmR3SetRuntimeErrorCommon(PVM pVM, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list *pVa)
3377{
3378 LogRel(("VM: Raising runtime error '%s' (fFlags=%#x)\n", pszErrorId, fFlags));
3379
3380 /*
3381 * Take actions before the call.
3382 */
3383 int rc = VINF_SUCCESS;
3384 if (fFlags & VMSETRTERR_FLAGS_FATAL)
3385 /** @todo Add some special VM state for the FATAL variant that isn't resumable.
3386 * It's too risky for 2.2.0, do after branching. */
3387 rc = VMR3SuspendNoSave(pVM);
3388 else if (fFlags & VMSETRTERR_FLAGS_SUSPEND)
3389 rc = VMR3Suspend(pVM);
3390
3391 /*
3392 * Do the callback round.
3393 */
3394 for (PVMATRUNTIMEERROR pCur = pVM->pUVM->vm.s.pAtRuntimeError; pCur; pCur = pCur->pNext)
3395 {
3396 va_list va;
3397 va_copy(va, *pVa);
3398 pCur->pfnAtRuntimeError(pVM, pCur->pvUser, fFlags, pszErrorId, pszFormat, va);
3399 va_end(va);
3400 }
3401
3402 return rc;
3403}
3404
3405
3406/**
3407 * Ellipsis to va_list wrapper for calling vmR3SetRuntimeErrorCommon.
3408 */
3409static int vmR3SetRuntimeErrorCommonF(PVM pVM, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, ...)
3410{
3411 va_list va;
3412 va_start(va, pszFormat);
3413 int rc = vmR3SetRuntimeErrorCommon(pVM, fFlags, pszErrorId, pszFormat, &va);
3414 va_end(va);
3415 return rc;
3416}
3417
3418
3419/**
3420 * This is a worker function for RC and Ring-0 calls to VMSetError and
3421 * VMSetErrorV.
3422 *
3423 * The message is found in VMINT.
3424 *
3425 * @returns VBox status code, see VMSetRuntimeError.
3426 * @param pVM The VM handle.
3427 * @thread EMT.
3428 */
3429VMMR3DECL(int) VMR3SetRuntimeErrorWorker(PVM pVM)
3430{
3431 VM_ASSERT_EMT(pVM);
3432 AssertReleaseMsgFailed(("And we have a winner! You get to implement Ring-0 and GC VMSetRuntimeErrorV! Congrats!\n"));
3433
3434 /*
3435 * Unpack the error (if we managed to format one).
3436 */
3437 const char *pszErrorId = "SetRuntimeError";
3438 const char *pszMessage = "No message!";
3439 uint32_t fFlags = VMSETRTERR_FLAGS_FATAL;
3440 PVMRUNTIMEERROR pErr = pVM->vm.s.pRuntimeErrorR3;
3441 if (pErr)
3442 {
3443 AssertCompile(sizeof(const char) == sizeof(uint8_t));
3444 if (pErr->offErrorId)
3445 pszErrorId = (const char *)pErr + pErr->offErrorId;
3446 if (pErr->offMessage)
3447 pszMessage = (const char *)pErr + pErr->offMessage;
3448 fFlags = pErr->fFlags;
3449 }
3450
3451 /*
3452 * Join cause with vmR3SetRuntimeErrorV.
3453 */
3454 return vmR3SetRuntimeErrorCommonF(pVM, fFlags, pszErrorId, "%s", pszMessage);
3455}
3456
3457
3458/**
3459 * Worker for VMSetRuntimeErrorV for doing the job on EMT in ring-3.
3460 *
3461 * @returns VBox status code with modifications, see VMSetRuntimeErrorV.
3462 *
3463 * @param pVM The VM handle.
3464 * @param fFlags The error flags.
3465 * @param pszErrorId Error ID string.
3466 * @param pszFormat Format string.
3467 * @param pVa Pointer to the format arguments.
3468 *
3469 * @thread EMT
3470 */
3471DECLCALLBACK(int) vmR3SetRuntimeErrorV(PVM pVM, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list *pVa)
3472{
3473 /*
3474 * Make a copy of the message.
3475 */
3476 va_list va2;
3477 va_copy(va2, *pVa);
3478 vmSetRuntimeErrorCopy(pVM, fFlags, pszErrorId, pszFormat, va2);
3479 va_end(va2);
3480
3481 /*
3482 * Join paths with VMR3SetRuntimeErrorWorker.
3483 */
3484 return vmR3SetRuntimeErrorCommon(pVM, fFlags, pszErrorId, pszFormat, pVa);
3485}
3486
3487
3488/**
3489 * Gets the ID virtual of the virtual CPU assoicated with the calling thread.
3490 *
3491 * @returns The CPU ID. NIL_VMCPUID if the thread isn't an EMT.
3492 *
3493 * @param pVM The VM handle.
3494 */
3495VMMR3DECL(RTCPUID) VMR3GetVMCPUId(PVM pVM)
3496{
3497 PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pVM->pUVM->vm.s.idxTLS);
3498 return pUVCpu
3499 ? pUVCpu->idCpu
3500 : NIL_VMCPUID;
3501}
3502
3503
3504/**
3505 * Returns the native handle of the current EMT VMCPU thread.
3506 *
3507 * @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3508 * @param pVM The VM handle.
3509 * @thread EMT
3510 */
3511VMMR3DECL(RTNATIVETHREAD) VMR3GetVMCPUNativeThread(PVM pVM)
3512{
3513 PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pVM->pUVM->vm.s.idxTLS);
3514
3515 if (!pUVCpu)
3516 return NIL_RTNATIVETHREAD;
3517
3518 return pUVCpu->vm.s.NativeThreadEMT;
3519}
3520
3521
3522/**
3523 * Returns the native handle of the current EMT VMCPU thread.
3524 *
3525 * @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3526 * @param pVM The VM handle.
3527 * @thread EMT
3528 */
3529VMMR3DECL(RTNATIVETHREAD) VMR3GetVMCPUNativeThreadU(PUVM pUVM)
3530{
3531 PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pUVM->vm.s.idxTLS);
3532
3533 if (!pUVCpu)
3534 return NIL_RTNATIVETHREAD;
3535
3536 return pUVCpu->vm.s.NativeThreadEMT;
3537}
3538
3539
3540/**
3541 * Returns the handle of the current EMT VMCPU thread.
3542 *
3543 * @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3544 * @param pVM The VM handle.
3545 * @thread EMT
3546 */
3547VMMR3DECL(RTTHREAD) VMR3GetVMCPUThread(PVM pVM)
3548{
3549 PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pVM->pUVM->vm.s.idxTLS);
3550
3551 if (!pUVCpu)
3552 return NIL_RTTHREAD;
3553
3554 return pUVCpu->vm.s.ThreadEMT;
3555}
3556
3557
3558/**
3559 * Returns the handle of the current EMT VMCPU thread.
3560 *
3561 * @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3562 * @param pVM The VM handle.
3563 * @thread EMT
3564 */
3565VMMR3DECL(RTTHREAD) VMR3GetVMCPUThreadU(PUVM pUVM)
3566{
3567 PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pUVM->vm.s.idxTLS);
3568
3569 if (!pUVCpu)
3570 return NIL_RTTHREAD;
3571
3572 return pUVCpu->vm.s.ThreadEMT;
3573}
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