VM.cpp@ 24744

Last change on this file since 24744 was 24738, checked in by vboxsync, 16 years ago
VMReq.cpp: Made VMR3ReqProcessU re-entrant.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 139.4 KB

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

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: