VM.cpp@ 94794

Last change on this file since 94794 was 94794, checked in by vboxsync, 3 years ago
Main,VMM: Implemented most of the functionality for encrypted VMs (encrypting log files is still missing), bugref:9955 [build fix]
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 158.1 KB

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

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

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

Download in other formats: