VM.cpp@ 64115

Last change on this file since 64115 was 63648, checked in by vboxsync, 8 years ago
VMM/GIM/HyperV: Add partial support for synthetic interrupt controller (still disabled, i.e. not exposed to guest).
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 168.7 KB

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

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

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

Download in other formats: