VM.cpp@ 60682

Last change on this file since 60682 was 60406, checked in by vboxsync, 9 years ago
VMM: doxygen fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 169.0 KB

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

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

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

Download in other formats: