VirtualBox

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

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

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