VM.cpp@ 48565

Last change on this file since 48565 was 48528, checked in by vboxsync, 11 years ago
Change implementation for turning a reset into a power off to prevent the VM from executing while the power down thread is not running
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 159.5 KB

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

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

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

Download in other formats: