VM.cpp@ 23495

Last change on this file since 23495 was 23153, checked in by vboxsync, 15 years ago
VMM: live snapshot bugfix.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 130.5 KB

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

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

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

Download in other formats: