VM.cpp@ 80074

Last change on this file since 80074 was 80074, checked in by vboxsync, 6 years ago
VMM,Main,++: Retired the unfinished FTM component.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 159.4 KB

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

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

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

Download in other formats: