VM.cpp@ 59083

Last change on this file since 59083 was 58126, checked in by vboxsync, 9 years ago
VMM: Fixed almost all the Doxygen warnings.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 162.4 KB

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

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

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

Download in other formats: