VM.cpp@ 66651

Last change on this file since 66651 was 66096, checked in by vboxsync, 8 years ago
VMM: EMT(0) must wait on any other EMTs before destroying the VM or we may get errors from the wait code (vmR3HaltGlobal1Wait).
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 169.2 KB

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

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

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

Download in other formats: