VM.cpp@ 73281

Last change on this file since 73281 was 73097, checked in by vboxsync, 6 years ago
*: Made RT_UOFFSETOF, RT_OFFSETOF, RT_UOFFSETOF_ADD and RT_OFFSETOF_ADD work like builtin_offsetof() and require compile time resolvable requests, adding RT_UOFFSETOF_DYN for the dynamic questions that can only be answered at runtime.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 170.5 KB

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

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

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

Download in other formats: