VM.cpp@ 24002

Last change on this file since 24002 was 23917, checked in by vboxsync, 16 years ago
VM: Set it VMINT::fTeleportedAndNotFullyResumedYet in VMR3Load....
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 136.7 KB

Line
1	/* $Id: VM.cpp 23917 2009-10-20 17:24:52Z vboxsync $ */
2	/** @file
3	* VM - Virtual Machine
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22	/** @page pg_vm VM API
23	*
24	* This is the encapsulating bit. It provides the APIs that Main and VBoxBFE
25	* use to create a VMM instance for running a guest in. It also provides
26	* facilities for queuing request for execution in EMT (serialization purposes
27	* mostly) and for reporting error back to the VMM user (Main/VBoxBFE).
28	*
29	*
30	* @section sec_vm_design Design Critique / Things To Do
31	*
32	* In hindsight this component is a big design mistake, all this stuff really
33	* belongs in the VMM component. It just seemed like a kind of ok idea at a
34	* time when the VMM bit was a kind of vague. 'VM' also happend to be the name
35	* of the per-VM instance structure (see vm.h), so it kind of made sense.
36	* However as it turned out, VMM(.cpp) is almost empty all it provides in ring-3
37	* is some minor functionally and some "routing" services.
38	*
39	* Fixing this is just a matter of some more or less straight forward
40	* refactoring, the question is just when someone will get to it. Moving the EMT
41	* would be a good start.
42	*
43	*/
44
45	/*******************************************************************************
46	* Header Files *
47	*******************************************************************************/
48	#define LOG_GROUP LOG_GROUP_VM
49	#include <VBox/cfgm.h>
50	#include <VBox/vmm.h>
51	#include <VBox/gvmm.h>
52	#include <VBox/mm.h>
53	#include <VBox/cpum.h>
54	#include <VBox/selm.h>
55	#include <VBox/trpm.h>
56	#include <VBox/dbgf.h>
57	#include <VBox/pgm.h>
58	#include <VBox/pdmapi.h>
59	#include <VBox/pdmcritsect.h>
60	#include <VBox/em.h>
61	#include <VBox/rem.h>
62	#include <VBox/tm.h>
63	#include <VBox/stam.h>
64	#include <VBox/patm.h>
65	#ifdef VBOX_WITH_VMI
66	# include <VBox/parav.h>
67	#endif
68	#include <VBox/csam.h>
69	#include <VBox/iom.h>
70	#include <VBox/ssm.h>
71	#include <VBox/hwaccm.h>
72	#include "VMInternal.h"
73	#include <VBox/vm.h>
74	#include <VBox/uvm.h>
75
76	#include <VBox/sup.h>
77	#include <VBox/dbg.h>
78	#include <VBox/err.h>
79	#include <VBox/param.h>
80	#include <VBox/log.h>
81	#include <iprt/assert.h>
82	#include <iprt/alloc.h>
83	#include <iprt/asm.h>
84	#include <iprt/env.h>
85	#include <iprt/string.h>
86	#include <iprt/time.h>
87	#include <iprt/semaphore.h>
88	#include <iprt/thread.h>
89
90
91	/*******************************************************************************
92	* Structures and Typedefs *
93	*******************************************************************************/
94	/**
95	* VM destruction callback registration record.
96	*/
97	typedef struct VMATDTOR
98	{
99	/** Pointer to the next record in the list. */
100	struct VMATDTOR *pNext;
101	/** Pointer to the callback function. */
102	PFNVMATDTOR pfnAtDtor;
103	/** The user argument. */
104	void *pvUser;
105	} VMATDTOR;
106	/** Pointer to a VM destruction callback registration record. */
107	typedef VMATDTOR *PVMATDTOR;
108
109
110	/*******************************************************************************
111	* Global Variables *
112	*******************************************************************************/
113	/** Pointer to the list of VMs. */
114	static PUVM g_pUVMsHead = NULL;
115
116	/** Pointer to the list of at VM destruction callbacks. */
117	static PVMATDTOR g_pVMAtDtorHead = NULL;
118	/** Lock the g_pVMAtDtorHead list. */
119	#define VM_ATDTOR_LOCK() do { } while (0)
120	/** Unlock the g_pVMAtDtorHead list. */
121	#define VM_ATDTOR_UNLOCK() do { } while (0)
122
123
124	/*******************************************************************************
125	* Internal Functions *
126	*******************************************************************************/
127	static int vmR3CreateUVM(uint32_t cCpus, PUVM *ppUVM);
128	static int vmR3CreateU(PUVM pUVM, uint32_t cCpus, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUserCFGM);
129	static int vmR3InitRing3(PVM pVM, PUVM pUVM);
130	static int vmR3InitVMCpu(PVM pVM);
131	static int vmR3InitRing0(PVM pVM);
132	static int vmR3InitGC(PVM pVM);
133	static int vmR3InitDoCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
134	static DECLCALLBACK(size_t) vmR3LogPrefixCallback(PRTLOGGER pLogger, char pchBuf, size_t cchBuf, void pvUser);
135	static void vmR3DestroyUVM(PUVM pUVM, uint32_t cMilliesEMTWait);
136	static void vmR3AtDtor(PVM pVM);
137	static bool vmR3ValidateStateTransition(VMSTATE enmStateOld, VMSTATE enmStateNew);
138	static void vmR3DoAtState(PVM pVM, PUVM pUVM, VMSTATE enmStateNew, VMSTATE enmStateOld);
139	static int vmR3TrySetState(PVM pVM, const char *pszWho, unsigned cTransitions, ...);
140	static void vmR3SetStateLocked(PVM pVM, PUVM pUVM, VMSTATE enmStateNew, VMSTATE enmStateOld);
141	static void vmR3SetState(PVM pVM, VMSTATE enmStateNew, VMSTATE enmStateOld);
142	static int vmR3SetErrorU(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
143
144
145	/**
146	* Do global VMM init.
147	*
148	* @returns VBox status code.
149	*/
150	VMMR3DECL(int) VMR3GlobalInit(void)
151	{
152	/*
153	* Only once.
154	*/
155	static bool volatile s_fDone = false;
156	if (s_fDone)
157	return VINF_SUCCESS;
158
159	/*
160	* We're done.
161	*/
162	s_fDone = true;
163	return VINF_SUCCESS;
164	}
165
166
167
168	/**
169	* Creates a virtual machine by calling the supplied configuration constructor.
170	*
171	* On successful returned the VM is powered, i.e. VMR3PowerOn() should be
172	* called to start the execution.
173	*
174	* @returns 0 on success.
175	* @returns VBox error code on failure.
176	* @param cCpus Number of virtual CPUs for the new VM.
177	* @param pfnVMAtError Pointer to callback function for setting VM
178	* errors. This was added as an implicit call to
179	* VMR3AtErrorRegister() since there is no way the
180	* caller can get to the VM handle early enough to
181	* do this on its own.
182	* This is called in the context of an EMT.
183	* @param pvUserVM The user argument passed to pfnVMAtError.
184	* @param pfnCFGMConstructor Pointer to callback function for constructing the VM configuration tree.
185	* This is called in the context of an EMT0.
186	* @param pvUserCFGM The user argument passed to pfnCFGMConstructor.
187	* @param ppVM Where to store the 'handle' of the created VM.
188	*/
189	VMMR3DECL(int) VMR3Create(uint32_t cCpus, PFNVMATERROR pfnVMAtError, void pvUserVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void pvUserCFGM, PVM *ppVM)
190	{
191	LogFlow(("VMR3Create: cCpus=%RU32 pfnVMAtError=%p pvUserVM=%p pfnCFGMConstructor=%p pvUserCFGM=%p ppVM=%p\n",
192	cCpus, pfnVMAtError, pvUserVM, pfnCFGMConstructor, pvUserCFGM, ppVM));
193
194	/*
195	* Because of the current hackiness of the applications
196	* we'll have to initialize global stuff from here.
197	* Later the applications will take care of this in a proper way.
198	*/
199	static bool fGlobalInitDone = false;
200	if (!fGlobalInitDone)
201	{
202	int rc = VMR3GlobalInit();
203	if (RT_FAILURE(rc))
204	return rc;
205	fGlobalInitDone = true;
206	}
207
208	/*
209	* Validate input.
210	*/
211	AssertLogRelMsgReturn(cCpus > 0 && cCpus <= VMM_MAX_CPU_COUNT, ("%RU32\n", cCpus), VERR_TOO_MANY_CPUS);
212
213	/*
214	* Create the UVM so we can register the at-error callback
215	* and consoliate a bit of cleanup code.
216	*/
217	PUVM pUVM = NULL; /* shuts up gcc */
218	int rc = vmR3CreateUVM(cCpus, &pUVM);
219	if (RT_FAILURE(rc))
220	return rc;
221	if (pfnVMAtError)
222	rc = VMR3AtErrorRegisterU(pUVM, pfnVMAtError, pvUserVM);
223	if (RT_SUCCESS(rc))
224	{
225	/*
226	* Initialize the support library creating the session for this VM.
227	*/
228	rc = SUPR3Init(&pUVM->vm.s.pSession);
229	if (RT_SUCCESS(rc))
230	{
231	/*
232	* Call vmR3CreateU in the EMT thread and wait for it to finish.
233	*
234	* Note! VMCPUID_ANY is used here because VMR3ReqQueueU would have trouble
235	* submitting a request to a specific VCPU without a pVM. So, to make
236	* sure init is running on EMT(0), vmR3EmulationThreadWithId makes sure
237	* that only EMT(0) is servicing VMCPUID_ANY requests when pVM is NULL.
238	*/
239	PVMREQ pReq;
240	rc = VMR3ReqCallU(pUVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT, VMREQFLAGS_VBOX_STATUS,
241	(PFNRT)vmR3CreateU, 4, pUVM, cCpus, pfnCFGMConstructor, pvUserCFGM);
242	if (RT_SUCCESS(rc))
243	{
244	rc = pReq->iStatus;
245	VMR3ReqFree(pReq);
246	if (RT_SUCCESS(rc))
247	{
248	/*
249	* Success!
250	*/
251	*ppVM = pUVM->pVM;
252	LogFlow(("VMR3Create: returns VINF_SUCCESS ppVM=%p\n", ppVM));
253	return VINF_SUCCESS;
254	}
255	}
256	else
257	AssertMsgFailed(("VMR3ReqCallU failed rc=%Rrc\n", rc));
258
259	/*
260	* An error occurred during VM creation. Set the error message directly
261	* using the initial callback, as the callback list doesn't exist yet.
262	*/
263	const char *pszError = NULL;
264	switch (rc)
265	{
266	case VERR_VMX_IN_VMX_ROOT_MODE:
267	#ifdef RT_OS_LINUX
268	pszError = N_("VirtualBox can't operate in VMX root mode. "
269	"Please disable the KVM kernel extension, recompile your kernel and reboot");
270	#else
271	pszError = N_("VirtualBox can't operate in VMX root mode. Please close all other virtualization programs.");
272	#endif
273	break;
274
275	case VERR_VERSION_MISMATCH:
276	pszError = N_("VMMR0 driver version mismatch. Please terminate all VMs, make sure that "
277	"VBoxNetDHCP is not running and try again. If you still get this error, "
278	"re-install VirtualBox");
279	break;
280
281	#ifdef RT_OS_LINUX
282	case VERR_SUPDRV_COMPONENT_NOT_FOUND:
283	pszError = N_("One of the kernel modules was not successfully loaded. Make sure "
284	"that no kernel modules from an older version of VirtualBox exist. "
285	"Then try to recompile and reload the kernel modules by executing "
286	"'/etc/init.d/vboxdrv setup' as root");
287	break;
288	#endif
289
290	case VERR_RAW_MODE_INVALID_SMP:
291	pszError = N_("VT-x/AMD-V is either not available on your host or disabled. "
292	"VirtualBox requires this hardware extension to emulate more than one "
293	"guest CPU");
294	break;
295
296	case VERR_SUPDRV_KERNEL_TOO_OLD_FOR_VTX:
297	#ifdef RT_OS_LINUX
298	pszError = N_("Because the host kernel is too old, VirtualBox cannot enable the VT-x "
299	"extension. Either upgrade your kernel to Linux 2.6.13 or later or disable "
300	"the VT-x extension in the VM settings. Note that without VT-x you have "
301	"to reduce the number of guest CPUs to one");
302	#else
303	pszError = N_("Because the host kernel is too old, VirtualBox cannot enable the VT-x "
304	"extension. Either upgrade your kernel or disable the VT-x extension in the "
305	"VM settings. Note that without VT-x you have to reduce the number of guest "
306	"CPUs to one");
307	#endif
308	break;
309
310	default:
311	pszError = N_("Unknown error creating VM");
312	break;
313	}
314	vmR3SetErrorU(pUVM, rc, RT_SRC_POS, pszError, rc);
315	}
316	else
317	{
318	/*
319	* An error occurred at support library initialization time (before the
320	* VM could be created). Set the error message directly using the
321	* initial callback, as the callback list doesn't exist yet.
322	*/
323	const char *pszError;
324	switch (rc)
325	{
326	case VERR_VM_DRIVER_LOAD_ERROR:
327	#ifdef RT_OS_LINUX
328	pszError = N_("VirtualBox kernel driver not loaded. The vboxdrv kernel module "
329	"was either not loaded or /dev/vboxdrv is not set up properly. "
330	"Re-setup the kernel module by executing "
331	"'/etc/init.d/vboxdrv setup' as root");
332	#else
333	pszError = N_("VirtualBox kernel driver not loaded");
334	#endif
335	break;
336	case VERR_VM_DRIVER_OPEN_ERROR:
337	pszError = N_("VirtualBox kernel driver cannot be opened");
338	break;
339	case VERR_VM_DRIVER_NOT_ACCESSIBLE:
340	#ifdef VBOX_WITH_HARDENING
341	/* This should only happen if the executable wasn't hardened - bad code/build. */
342	pszError = N_("VirtualBox kernel driver not accessible, permission problem. "
343	"Re-install VirtualBox. If you are building it yourself, you "
344	"should make sure it installed correctly and that the setuid "
345	"bit is set on the executables calling VMR3Create.");
346	#else
347	/* This should only happen when mixing builds or with the usual /dev/vboxdrv access issues. */
348	# if defined(RT_OS_DARWIN)
349	pszError = N_("VirtualBox KEXT is not accessible, permission problem. "
350	"If you have built VirtualBox yourself, make sure that you do not "
351	"have the vboxdrv KEXT from a different build or installation loaded.");
352	# elif defined(RT_OS_LINUX)
353	pszError = N_("VirtualBox kernel driver is not accessible, permission problem. "
354	"If you have built VirtualBox yourself, make sure that you do "
355	"not have the vboxdrv kernel module from a different build or "
356	"installation loaded. Also, make sure the vboxdrv udev rule gives "
357	"you the permission you need to access the device.");
358	# elif defined(RT_OS_WINDOWS)
359	pszError = N_("VirtualBox kernel driver is not accessible, permission problem.");
360	# else /* solaris, freebsd, ++. */
361	pszError = N_("VirtualBox kernel module is not accessible, permission problem. "
362	"If you have built VirtualBox yourself, make sure that you do "
363	"not have the vboxdrv kernel module from a different install loaded.");
364	# endif
365	#endif
366	break;
367	case VERR_INVALID_HANDLE: /** @todo track down and fix this error. */
368	case VERR_VM_DRIVER_NOT_INSTALLED:
369	#ifdef RT_OS_LINUX
370	pszError = N_("VirtualBox kernel driver not installed. The vboxdrv kernel module "
371	"was either not loaded or /dev/vboxdrv was not created for some "
372	"reason. Re-setup the kernel module by executing "
373	"'/etc/init.d/vboxdrv setup' as root");
374	#else
375	pszError = N_("VirtualBox kernel driver not installed");
376	#endif
377	break;
378	case VERR_NO_MEMORY:
379	pszError = N_("VirtualBox support library out of memory");
380	break;
381	case VERR_VERSION_MISMATCH:
382	case VERR_VM_DRIVER_VERSION_MISMATCH:
383	pszError = N_("The VirtualBox support driver which is running is from a different "
384	"version of VirtualBox. You can correct this by stopping all "
385	"running instances of VirtualBox and reinstalling the software.");
386	break;
387	default:
388	pszError = N_("Unknown error initializing kernel driver");
389	AssertMsgFailed(("Add error message for rc=%d (%Rrc)\n", rc, rc));
390	}
391	vmR3SetErrorU(pUVM, rc, RT_SRC_POS, pszError, rc);
392	}
393	}
394
395	/* cleanup */
396	vmR3DestroyUVM(pUVM, 2000);
397	LogFlow(("VMR3Create: returns %Rrc\n", rc));
398	return rc;
399	}
400
401
402	/**
403	* Creates the UVM.
404	*
405	* This will not initialize the support library even if vmR3DestroyUVM
406	* will terminate that.
407	*
408	* @returns VBox status code.
409	* @param cCpus Number of virtual CPUs
410	* @param ppUVM Where to store the UVM pointer.
411	*/
412	static int vmR3CreateUVM(uint32_t cCpus, PUVM *ppUVM)
413	{
414	uint32_t i;
415
416	/*
417	* Create and initialize the UVM.
418	*/
419	PUVM pUVM = (PUVM)RTMemPageAllocZ(RT_OFFSETOF(UVM, aCpus[cCpus]));
420	AssertReturn(pUVM, VERR_NO_MEMORY);
421	pUVM->u32Magic = UVM_MAGIC;
422	pUVM->cCpus = cCpus;
423
424	AssertCompile(sizeof(pUVM->vm.s) <= sizeof(pUVM->vm.padding));
425
426	pUVM->vm.s.ppAtStateNext = &pUVM->vm.s.pAtState;
427	pUVM->vm.s.ppAtErrorNext = &pUVM->vm.s.pAtError;
428	pUVM->vm.s.ppAtRuntimeErrorNext = &pUVM->vm.s.pAtRuntimeError;
429
430	pUVM->vm.s.enmHaltMethod = VMHALTMETHOD_BOOTSTRAP;
431
432	/* Initialize the VMCPU array in the UVM. */
433	for (i = 0; i < cCpus; i++)
434	{
435	pUVM->aCpus[i].pUVM = pUVM;
436	pUVM->aCpus[i].idCpu = i;
437	}
438
439	/* Allocate a TLS entry to store the VMINTUSERPERVMCPU pointer. */
440	int rc = RTTlsAllocEx(&pUVM->vm.s.idxTLS, NULL);
441	AssertRC(rc);
442	if (RT_SUCCESS(rc))
443	{
444	/* Allocate a halt method event semaphore for each VCPU. */
445	for (i = 0; i < cCpus; i++)
446	pUVM->aCpus[i].vm.s.EventSemWait = NIL_RTSEMEVENT;
447	for (i = 0; i < cCpus; i++)
448	{
449	rc = RTSemEventCreate(&pUVM->aCpus[i].vm.s.EventSemWait);
450	if (RT_FAILURE(rc))
451	break;
452	}
453	if (RT_SUCCESS(rc))
454	{
455	rc = RTCritSectInit(&pUVM->vm.s.AtStateCritSect);
456	if (RT_SUCCESS(rc))
457	{
458	rc = RTCritSectInit(&pUVM->vm.s.AtErrorCritSect);
459	if (RT_SUCCESS(rc))
460	{
461	/*
462	* Init fundamental (sub-)components - STAM, MMR3Heap and PDMLdr.
463	*/
464	rc = STAMR3InitUVM(pUVM);
465	if (RT_SUCCESS(rc))
466	{
467	rc = MMR3InitUVM(pUVM);
468	if (RT_SUCCESS(rc))
469	{
470	rc = PDMR3InitUVM(pUVM);
471	if (RT_SUCCESS(rc))
472	{
473	/*
474	* Start the emulation threads for all VMCPUs.
475	*/
476	for (i = 0; i < cCpus; i++)
477	{
478	rc = RTThreadCreateF(&pUVM->aCpus[i].vm.s.ThreadEMT, vmR3EmulationThread, &pUVM->aCpus[i], _1M,
479	RTTHREADTYPE_EMULATION, RTTHREADFLAGS_WAITABLE,
480	cCpus > 1 ? "EMT-%u" : "EMT", i);
481	if (RT_FAILURE(rc))
482	break;
483
484	pUVM->aCpus[i].vm.s.NativeThreadEMT = RTThreadGetNative(pUVM->aCpus[i].vm.s.ThreadEMT);
485	}
486
487	if (RT_SUCCESS(rc))
488	{
489	*ppUVM = pUVM;
490	return VINF_SUCCESS;
491	}
492
493	/* bail out. */
494	while (i-- > 0)
495	{
496	/** @todo rainy day: terminate the EMTs. */
497	}
498	PDMR3TermUVM(pUVM);
499	}
500	MMR3TermUVM(pUVM);
501	}
502	STAMR3TermUVM(pUVM);
503	}
504	RTCritSectDelete(&pUVM->vm.s.AtErrorCritSect);
505	}
506	RTCritSectDelete(&pUVM->vm.s.AtStateCritSect);
507	}
508	}
509	for (i = 0; i < cCpus; i++)
510	{
511	RTSemEventDestroy(pUVM->aCpus[i].vm.s.EventSemWait);
512	pUVM->aCpus[i].vm.s.EventSemWait = NIL_RTSEMEVENT;
513	}
514	RTTlsFree(pUVM->vm.s.idxTLS);
515	}
516	RTMemPageFree(pUVM);
517	return rc;
518	}
519
520
521	/**
522	* Creates and initializes the VM.
523	*
524	* @thread EMT
525	*/
526	static int vmR3CreateU(PUVM pUVM, uint32_t cCpus, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUserCFGM)
527	{
528	int rc = VINF_SUCCESS;
529
530	/*
531	* Load the VMMR0.r0 module so that we can call GVMMR0CreateVM.
532	*/
533	rc = PDMR3LdrLoadVMMR0U(pUVM);
534	if (RT_FAILURE(rc))
535	{
536	/** @todo we need a cleaner solution for this (VERR_VMX_IN_VMX_ROOT_MODE).
537	* bird: what about moving the message down here? Main picks the first message, right? */
538	if (rc == VERR_VMX_IN_VMX_ROOT_MODE)
539	return rc; /* proper error message set later on */
540	return vmR3SetErrorU(pUVM, rc, RT_SRC_POS, N_("Failed to load VMMR0.r0"));
541	}
542
543	/*
544	* Request GVMM to create a new VM for us.
545	*/
546	GVMMCREATEVMREQ CreateVMReq;
547	CreateVMReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
548	CreateVMReq.Hdr.cbReq = sizeof(CreateVMReq);
549	CreateVMReq.pSession = pUVM->vm.s.pSession;
550	CreateVMReq.pVMR0 = NIL_RTR0PTR;
551	CreateVMReq.pVMR3 = NULL;
552	CreateVMReq.cCpus = cCpus;
553	rc = SUPR3CallVMMR0Ex(NIL_RTR0PTR, NIL_VMCPUID, VMMR0_DO_GVMM_CREATE_VM, 0, &CreateVMReq.Hdr);
554	if (RT_SUCCESS(rc))
555	{
556	PVM pVM = pUVM->pVM = CreateVMReq.pVMR3;
557	AssertRelease(VALID_PTR(pVM));
558	AssertRelease(pVM->pVMR0 == CreateVMReq.pVMR0);
559	AssertRelease(pVM->pSession == pUVM->vm.s.pSession);
560	AssertRelease(pVM->cCpus == cCpus);
561	AssertRelease(pVM->offVMCPU == RT_UOFFSETOF(VM, aCpus));
562
563	Log(("VMR3Create: Created pUVM=%p pVM=%p pVMR0=%p hSelf=%#x cCpus=%RU32\n",
564	pUVM, pVM, pVM->pVMR0, pVM->hSelf, pVM->cCpus));
565
566	/*
567	* Initialize the VM structure and our internal data (VMINT).
568	*/
569	pVM->pUVM = pUVM;
570
571	for (VMCPUID i = 0; i < pVM->cCpus; i++)
572	{
573	pVM->aCpus[i].pUVCpu = &pUVM->aCpus[i];
574	pVM->aCpus[i].idCpu = i;
575	pVM->aCpus[i].hNativeThread = pUVM->aCpus[i].vm.s.NativeThreadEMT;
576	Assert(pVM->aCpus[i].hNativeThread != NIL_RTNATIVETHREAD);
577
578	pUVM->aCpus[i].pVCpu = &pVM->aCpus[i];
579	pUVM->aCpus[i].pVM = pVM;
580	}
581
582
583	/*
584	* Init the configuration.
585	*/
586	rc = CFGMR3Init(pVM, pfnCFGMConstructor, pvUserCFGM);
587	if (RT_SUCCESS(rc))
588	{
589	rc = CFGMR3QueryBoolDef(CFGMR3GetRoot(pVM), "HwVirtExtForced", &pVM->fHwVirtExtForced, false);
590	if (RT_SUCCESS(rc) && pVM->fHwVirtExtForced)
591	pVM->fHWACCMEnabled = true;
592
593	/*
594	* If executing in fake suplib mode disable RR3 and RR0 in the config.
595	*/
596	const char *psz = RTEnvGet("VBOX_SUPLIB_FAKE");
597	if (psz && !strcmp(psz, "fake"))
598	{
599	CFGMR3RemoveValue(CFGMR3GetRoot(pVM), "RawR3Enabled");
600	CFGMR3InsertInteger(CFGMR3GetRoot(pVM), "RawR3Enabled", 0);
601	CFGMR3RemoveValue(CFGMR3GetRoot(pVM), "RawR0Enabled");
602	CFGMR3InsertInteger(CFGMR3GetRoot(pVM), "RawR0Enabled", 0);
603	}
604
605	/*
606	* Make sure the CPU count in the config data matches.
607	*/
608	if (RT_SUCCESS(rc))
609	{
610	uint32_t cCPUsCfg;
611	rc = CFGMR3QueryU32Def(CFGMR3GetRoot(pVM), "NumCPUs", &cCPUsCfg, 1);
612	AssertLogRelMsgRC(rc, ("Configuration error: Querying \"NumCPUs\" as integer failed, rc=%Rrc\n", rc));
613	if (RT_SUCCESS(rc) && cCPUsCfg != cCpus)
614	{
615	AssertLogRelMsgFailed(("Configuration error: \"NumCPUs\"=%RU32 and VMR3CreateVM::cCpus=%RU32 does not match!\n",
616	cCPUsCfg, cCpus));
617	rc = VERR_INVALID_PARAMETER;
618	}
619	}
620	if (RT_SUCCESS(rc))
621	{
622	/*
623	* Init the ring-3 components and ring-3 per cpu data, finishing it off
624	* by a relocation round (intermediate context finalization will do this).
625	*/
626	rc = vmR3InitRing3(pVM, pUVM);
627	if (RT_SUCCESS(rc))
628	{
629	rc = vmR3InitVMCpu(pVM);
630	if (RT_SUCCESS(rc))
631	rc = PGMR3FinalizeMappings(pVM);
632	if (RT_SUCCESS(rc))
633	{
634
635	LogFlow(("Ring-3 init succeeded\n"));
636
637	/*
638	* Init the Ring-0 components.
639	*/
640	rc = vmR3InitRing0(pVM);
641	if (RT_SUCCESS(rc))
642	{
643	/* Relocate again, because some switcher fixups depends on R0 init results. */
644	VMR3Relocate(pVM, 0);
645
646	#ifdef VBOX_WITH_DEBUGGER
647	/*
648	* Init the tcp debugger console if we're building
649	* with debugger support.
650	*/
651	void *pvUser = NULL;
652	rc = DBGCTcpCreate(pVM, &pvUser);
653	if ( RT_SUCCESS(rc)
654	\|\| rc == VERR_NET_ADDRESS_IN_USE)
655	{
656	pUVM->vm.s.pvDBGC = pvUser;
657	#endif
658	/*
659	* Init the Guest Context components.
660	*/
661	rc = vmR3InitGC(pVM);
662	if (RT_SUCCESS(rc))
663	{
664	/*
665	* Now we can safely set the VM halt method to default.
666	*/
667	rc = vmR3SetHaltMethodU(pUVM, VMHALTMETHOD_DEFAULT);
668	if (RT_SUCCESS(rc))
669	{
670	/*
671	* Set the state and link into the global list.
672	*/
673	vmR3SetState(pVM, VMSTATE_CREATED, VMSTATE_CREATING);
674	pUVM->pNext = g_pUVMsHead;
675	g_pUVMsHead = pUVM;
676
677	#ifdef LOG_ENABLED
678	RTLogSetCustomPrefixCallback(NULL, vmR3LogPrefixCallback, pUVM);
679	#endif
680	return VINF_SUCCESS;
681	}
682	}
683	#ifdef VBOX_WITH_DEBUGGER
684	DBGCTcpTerminate(pVM, pUVM->vm.s.pvDBGC);
685	pUVM->vm.s.pvDBGC = NULL;
686	}
687	#endif
688	//..
689	}
690	}
691	vmR3Destroy(pVM);
692	}
693	}
694	//..
695
696	/* Clean CFGM. */
697	int rc2 = CFGMR3Term(pVM);
698	AssertRC(rc2);
699	}
700
701	/*
702	* Drop all references to VM and the VMCPU structures, then
703	* tell GVMM to destroy the VM.
704	*/
705	pUVM->pVM = NULL;
706	for (VMCPUID i = 0; i < pUVM->cCpus; i++)
707	{
708	pUVM->aCpus[i].pVM = NULL;
709	pUVM->aCpus[i].pVCpu = NULL;
710	}
711	Assert(pUVM->vm.s.enmHaltMethod == VMHALTMETHOD_BOOTSTRAP);
712
713	if (pUVM->cCpus > 1)
714	{
715	/* Poke the other EMTs since they may have stale pVM and pVCpu references
716	on the stack (see VMR3WaitU for instance) if they've been awakened after
717	VM creation. */
718	for (VMCPUID i = 1; i < pUVM->cCpus; i++)
719	VMR3NotifyCpuFFU(&pUVM->aCpus[i], 0);
720	RTThreadSleep(RT_MIN(100 + 25 (pUVM->cCpus - 1), 500)); / very sophisticated */
721	}
722
723	int rc2 = SUPR3CallVMMR0Ex(CreateVMReq.pVMR0, 0 /idCpu/, VMMR0_DO_GVMM_DESTROY_VM, 0, NULL);
724	AssertRC(rc2);
725	}
726	else
727	vmR3SetErrorU(pUVM, rc, RT_SRC_POS, N_("VM creation failed (GVMM)"));
728
729	LogFlow(("vmR3CreateU: returns %Rrc\n", rc));
730	return rc;
731	}
732
733
734	/**
735	* Register the calling EMT with GVM.
736	*
737	* @returns VBox status code.
738	* @param pVM The VM handle.
739	* @param idCpu The Virtual CPU ID.
740	*/
741	static DECLCALLBACK(int) vmR3RegisterEMT(PVM pVM, VMCPUID idCpu)
742	{
743	Assert(VMMGetCpuId(pVM) == idCpu);
744	int rc = SUPR3CallVMMR0Ex(pVM->pVMR0, idCpu, VMMR0_DO_GVMM_REGISTER_VMCPU, 0, NULL);
745	if (RT_FAILURE(rc))
746	LogRel(("idCpu=%u rc=%Rrc\n", idCpu, rc));
747	return rc;
748	}
749
750
751	/**
752	* Initializes all R3 components of the VM
753	*/
754	static int vmR3InitRing3(PVM pVM, PUVM pUVM)
755	{
756	int rc;
757
758	/*
759	* Register the other EMTs with GVM.
760	*/
761	for (VMCPUID idCpu = 1; idCpu < pVM->cCpus; idCpu++)
762	{
763	rc = VMR3ReqCallWaitU(pUVM, idCpu, (PFNRT)vmR3RegisterEMT, 2, pVM, idCpu);
764	if (RT_FAILURE(rc))
765	return rc;
766	}
767
768	/*
769	* Init all R3 components, the order here might be important.
770	*/
771	rc = MMR3Init(pVM);
772	if (RT_SUCCESS(rc))
773	{
774	STAM_REG(pVM, &pVM->StatTotalInGC, STAMTYPE_PROFILE_ADV, "/PROF/VM/InGC", STAMUNIT_TICKS_PER_CALL, "Profiling the total time spent in GC.");
775	STAM_REG(pVM, &pVM->StatSwitcherToGC, STAMTYPE_PROFILE_ADV, "/PROF/VM/SwitchToGC", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
776	STAM_REG(pVM, &pVM->StatSwitcherToHC, STAMTYPE_PROFILE_ADV, "/PROF/VM/SwitchToHC", STAMUNIT_TICKS_PER_CALL, "Profiling switching to HC.");
777	STAM_REG(pVM, &pVM->StatSwitcherSaveRegs, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/SaveRegs", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
778	STAM_REG(pVM, &pVM->StatSwitcherSysEnter, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/SysEnter", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
779	STAM_REG(pVM, &pVM->StatSwitcherDebug, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Debug", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
780	STAM_REG(pVM, &pVM->StatSwitcherCR0, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/CR0", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
781	STAM_REG(pVM, &pVM->StatSwitcherCR4, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/CR4", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
782	STAM_REG(pVM, &pVM->StatSwitcherLgdt, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Lgdt", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
783	STAM_REG(pVM, &pVM->StatSwitcherLidt, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Lidt", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
784	STAM_REG(pVM, &pVM->StatSwitcherLldt, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/Lldt", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
785	STAM_REG(pVM, &pVM->StatSwitcherTSS, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/TSS", STAMUNIT_TICKS_PER_CALL, "Profiling switching to GC.");
786	STAM_REG(pVM, &pVM->StatSwitcherJmpCR3, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/JmpCR3", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
787	STAM_REG(pVM, &pVM->StatSwitcherRstrRegs, STAMTYPE_PROFILE_ADV, "/VM/Switcher/ToGC/RstrRegs", STAMUNIT_TICKS_PER_CALL,"Profiling switching to GC.");
788
789	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
790	{
791	rc = STAMR3RegisterF(pVM, &pUVM->aCpus[idCpu].vm.s.StatHaltYield, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling halted state yielding.", "/PROF/VM/CPU%d/Halt/Yield", idCpu);
792	AssertRC(rc);
793	rc = STAMR3RegisterF(pVM, &pUVM->aCpus[idCpu].vm.s.StatHaltBlock, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling halted state blocking.", "/PROF/VM/CPU%d/Halt/Block", idCpu);
794	AssertRC(rc);
795	rc = STAMR3RegisterF(pVM, &pUVM->aCpus[idCpu].vm.s.StatHaltTimers, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling halted state timer tasks.", "/PROF/VM/CPU%d/Halt/Timers", idCpu);
796	AssertRC(rc);
797	}
798
799	STAM_REG(pVM, &pUVM->vm.s.StatReqAllocNew, STAMTYPE_COUNTER, "/VM/Req/AllocNew", STAMUNIT_OCCURENCES, "Number of VMR3ReqAlloc returning a new packet.");
800	STAM_REG(pVM, &pUVM->vm.s.StatReqAllocRaces, STAMTYPE_COUNTER, "/VM/Req/AllocRaces", STAMUNIT_OCCURENCES, "Number of VMR3ReqAlloc causing races.");
801	STAM_REG(pVM, &pUVM->vm.s.StatReqAllocRecycled, STAMTYPE_COUNTER, "/VM/Req/AllocRecycled", STAMUNIT_OCCURENCES, "Number of VMR3ReqAlloc returning a recycled packet.");
802	STAM_REG(pVM, &pUVM->vm.s.StatReqFree, STAMTYPE_COUNTER, "/VM/Req/Free", STAMUNIT_OCCURENCES, "Number of VMR3ReqFree calls.");
803	STAM_REG(pVM, &pUVM->vm.s.StatReqFreeOverflow, STAMTYPE_COUNTER, "/VM/Req/FreeOverflow", STAMUNIT_OCCURENCES, "Number of times the request was actually freed.");
804
805	rc = CPUMR3Init(pVM);
806	if (RT_SUCCESS(rc))
807	{
808	rc = HWACCMR3Init(pVM);
809	if (RT_SUCCESS(rc))
810	{
811	rc = PGMR3Init(pVM);
812	if (RT_SUCCESS(rc))
813	{
814	rc = REMR3Init(pVM);
815	if (RT_SUCCESS(rc))
816	{
817	rc = MMR3InitPaging(pVM);
818	if (RT_SUCCESS(rc))
819	rc = TMR3Init(pVM);
820	if (RT_SUCCESS(rc))
821	{
822	rc = VMMR3Init(pVM);
823	if (RT_SUCCESS(rc))
824	{
825	rc = SELMR3Init(pVM);
826	if (RT_SUCCESS(rc))
827	{
828	rc = TRPMR3Init(pVM);
829	if (RT_SUCCESS(rc))
830	{
831	rc = CSAMR3Init(pVM);
832	if (RT_SUCCESS(rc))
833	{
834	rc = PATMR3Init(pVM);
835	if (RT_SUCCESS(rc))
836	{
837	#ifdef VBOX_WITH_VMI
838	rc = PARAVR3Init(pVM);
839	if (RT_SUCCESS(rc))
840	{
841	#endif
842	rc = IOMR3Init(pVM);
843	if (RT_SUCCESS(rc))
844	{
845	rc = EMR3Init(pVM);
846	if (RT_SUCCESS(rc))
847	{
848	rc = DBGFR3Init(pVM);
849	if (RT_SUCCESS(rc))
850	{
851	rc = PDMR3Init(pVM);
852	if (RT_SUCCESS(rc))
853	{
854	rc = PGMR3InitDynMap(pVM);
855	if (RT_SUCCESS(rc))
856	rc = MMR3HyperInitFinalize(pVM);
857	if (RT_SUCCESS(rc))
858	rc = PATMR3InitFinalize(pVM);
859	if (RT_SUCCESS(rc))
860	rc = PGMR3InitFinalize(pVM);
861	if (RT_SUCCESS(rc))
862	rc = SELMR3InitFinalize(pVM);
863	if (RT_SUCCESS(rc))
864	rc = TMR3InitFinalize(pVM);
865	if (RT_SUCCESS(rc))
866	rc = VMMR3InitFinalize(pVM);
867	if (RT_SUCCESS(rc))
868	rc = REMR3InitFinalize(pVM);
869	if (RT_SUCCESS(rc))
870	rc = vmR3InitDoCompleted(pVM, VMINITCOMPLETED_RING3);
871	if (RT_SUCCESS(rc))
872	{
873	LogFlow(("vmR3InitRing3: returns %Rrc\n", VINF_SUCCESS));
874	return VINF_SUCCESS;
875	}
876	int rc2 = PDMR3Term(pVM);
877	AssertRC(rc2);
878	}
879	int rc2 = DBGFR3Term(pVM);
880	AssertRC(rc2);
881	}
882	int rc2 = EMR3Term(pVM);
883	AssertRC(rc2);
884	}
885	int rc2 = IOMR3Term(pVM);
886	AssertRC(rc2);
887	}
888	#ifdef VBOX_WITH_VMI
889	int rc2 = PARAVR3Term(pVM);
890	AssertRC(rc2);
891	}
892	#endif
893	int rc2 = PATMR3Term(pVM);
894	AssertRC(rc2);
895	}
896	int rc2 = CSAMR3Term(pVM);
897	AssertRC(rc2);
898	}
899	int rc2 = TRPMR3Term(pVM);
900	AssertRC(rc2);
901	}
902	int rc2 = SELMR3Term(pVM);
903	AssertRC(rc2);
904	}
905	int rc2 = VMMR3Term(pVM);
906	AssertRC(rc2);
907	}
908	int rc2 = TMR3Term(pVM);
909	AssertRC(rc2);
910	}
911	int rc2 = REMR3Term(pVM);
912	AssertRC(rc2);
913	}
914	int rc2 = PGMR3Term(pVM);
915	AssertRC(rc2);
916	}
917	int rc2 = HWACCMR3Term(pVM);
918	AssertRC(rc2);
919	}
920	//int rc2 = CPUMR3Term(pVM);
921	//AssertRC(rc2);
922	}
923	/* MMR3Term is not called here because it'll kill the heap. */
924	}
925
926	LogFlow(("vmR3InitRing3: returns %Rrc\n", rc));
927	return rc;
928	}
929
930
931	/**
932	* Initializes all VM CPU components of the VM
933	*/
934	static int vmR3InitVMCpu(PVM pVM)
935	{
936	int rc = VINF_SUCCESS;
937	int rc2;
938
939	rc = CPUMR3InitCPU(pVM);
940	if (RT_SUCCESS(rc))
941	{
942	rc = HWACCMR3InitCPU(pVM);
943	if (RT_SUCCESS(rc))
944	{
945	rc = PGMR3InitCPU(pVM);
946	if (RT_SUCCESS(rc))
947	{
948	rc = TMR3InitCPU(pVM);
949	if (RT_SUCCESS(rc))
950	{
951	rc = VMMR3InitCPU(pVM);
952	if (RT_SUCCESS(rc))
953	{
954	rc = EMR3InitCPU(pVM);
955	if (RT_SUCCESS(rc))
956	{
957	LogFlow(("vmR3InitVMCpu: returns %Rrc\n", VINF_SUCCESS));
958	return VINF_SUCCESS;
959	}
960
961	rc2 = VMMR3TermCPU(pVM);
962	AssertRC(rc2);
963	}
964	rc2 = TMR3TermCPU(pVM);
965	AssertRC(rc2);
966	}
967	rc2 = PGMR3TermCPU(pVM);
968	AssertRC(rc2);
969	}
970	rc2 = HWACCMR3TermCPU(pVM);
971	AssertRC(rc2);
972	}
973	rc2 = CPUMR3TermCPU(pVM);
974	AssertRC(rc2);
975	}
976	LogFlow(("vmR3InitVMCpu: returns %Rrc\n", rc));
977	return rc;
978	}
979
980
981	/**
982	* Initializes all R0 components of the VM
983	*/
984	static int vmR3InitRing0(PVM pVM)
985	{
986	LogFlow(("vmR3InitRing0:\n"));
987
988	/*
989	* Check for FAKE suplib mode.
990	*/
991	int rc = VINF_SUCCESS;
992	const char *psz = RTEnvGet("VBOX_SUPLIB_FAKE");
993	if (!psz \|\| strcmp(psz, "fake"))
994	{
995	/*
996	* Call the VMMR0 component and let it do the init.
997	*/
998	rc = VMMR3InitR0(pVM);
999	}
1000	else
1001	Log(("vmR3InitRing0: skipping because of VBOX_SUPLIB_FAKE=fake\n"));
1002
1003	/*
1004	* Do notifications and return.
1005	*/
1006	if (RT_SUCCESS(rc))
1007	rc = vmR3InitDoCompleted(pVM, VMINITCOMPLETED_RING0);
1008
1009	/** todo: move this to the VMINITCOMPLETED_RING0 notification handler once implemented */
1010	if (RT_SUCCESS(rc))
1011	rc = HWACCMR3InitFinalizeR0(pVM);
1012
1013	LogFlow(("vmR3InitRing0: returns %Rrc\n", rc));
1014	return rc;
1015	}
1016
1017
1018	/**
1019	* Initializes all GC components of the VM
1020	*/
1021	static int vmR3InitGC(PVM pVM)
1022	{
1023	LogFlow(("vmR3InitGC:\n"));
1024
1025	/*
1026	* Check for FAKE suplib mode.
1027	*/
1028	int rc = VINF_SUCCESS;
1029	const char *psz = RTEnvGet("VBOX_SUPLIB_FAKE");
1030	if (!psz \|\| strcmp(psz, "fake"))
1031	{
1032	/*
1033	* Call the VMMR0 component and let it do the init.
1034	*/
1035	rc = VMMR3InitRC(pVM);
1036	}
1037	else
1038	Log(("vmR3InitGC: skipping because of VBOX_SUPLIB_FAKE=fake\n"));
1039
1040	/*
1041	* Do notifications and return.
1042	*/
1043	if (RT_SUCCESS(rc))
1044	rc = vmR3InitDoCompleted(pVM, VMINITCOMPLETED_GC);
1045	LogFlow(("vmR3InitGC: returns %Rrc\n", rc));
1046	return rc;
1047	}
1048
1049
1050	/**
1051	* Do init completed notifications.
1052	* This notifications can fail.
1053	*
1054	* @param pVM The VM handle.
1055	* @param enmWhat What's completed.
1056	*/
1057	static int vmR3InitDoCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
1058	{
1059	return VINF_SUCCESS;
1060	}
1061
1062
1063	/**
1064	* Logger callback for inserting a custom prefix.
1065	*
1066	* @returns Number of chars written.
1067	* @param pLogger The logger.
1068	* @param pchBuf The output buffer.
1069	* @param cchBuf The output buffer size.
1070	* @param pvUser Pointer to the UVM structure.
1071	*/
1072	static DECLCALLBACK(size_t) vmR3LogPrefixCallback(PRTLOGGER pLogger, char pchBuf, size_t cchBuf, void pvUser)
1073	{
1074	AssertReturn(cchBuf >= 2, 0);
1075	PUVM pUVM = (PUVM)pvUser;
1076	PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pUVM->vm.s.idxTLS);
1077	if (pUVCpu)
1078	{
1079	static const char s_szHex[17] = "0123456789abcdef";
1080	VMCPUID const idCpu = pUVCpu->idCpu;
1081	pchBuf[1] = s_szHex[ idCpu & 15];
1082	pchBuf[0] = s_szHex[(idCpu >> 4) & 15];
1083	}
1084	else
1085	{
1086	pchBuf[0] = 'x';
1087	pchBuf[1] = 'y';
1088	}
1089
1090	return 2;
1091	}
1092
1093
1094	/**
1095	* Calls the relocation functions for all VMM components so they can update
1096	* any GC pointers. When this function is called all the basic VM members
1097	* have been updated and the actual memory relocation have been done
1098	* by the PGM/MM.
1099	*
1100	* This is used both on init and on runtime relocations.
1101	*
1102	* @param pVM VM handle.
1103	* @param offDelta Relocation delta relative to old location.
1104	*/
1105	VMMR3DECL(void) VMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
1106	{
1107	LogFlow(("VMR3Relocate: offDelta=%RGv\n", offDelta));
1108
1109	/*
1110	* The order here is very important!
1111	*/
1112	PGMR3Relocate(pVM, offDelta);
1113	PDMR3LdrRelocateU(pVM->pUVM, offDelta);
1114	PGMR3Relocate(pVM, 0); /* Repeat after PDM relocation. */
1115	CPUMR3Relocate(pVM);
1116	HWACCMR3Relocate(pVM);
1117	SELMR3Relocate(pVM);
1118	VMMR3Relocate(pVM, offDelta);
1119	SELMR3Relocate(pVM); /* !hack! fix stack! */
1120	TRPMR3Relocate(pVM, offDelta);
1121	PATMR3Relocate(pVM);
1122	CSAMR3Relocate(pVM, offDelta);
1123	IOMR3Relocate(pVM, offDelta);
1124	EMR3Relocate(pVM);
1125	TMR3Relocate(pVM, offDelta);
1126	DBGFR3Relocate(pVM, offDelta);
1127	PDMR3Relocate(pVM, offDelta);
1128	}
1129
1130
1131	/**
1132	* EMT rendezvous worker for VMR3PowerOn.
1133	*
1134	* @returns VERR_VM_INVALID_VM_STATE or VINF_SUCCESS. (This is a strict return
1135	* code, see FNVMMEMTRENDEZVOUS.)
1136	*
1137	* @param pVM The VM handle.
1138	* @param pVCpu The VMCPU handle of the EMT.
1139	* @param pvUser Ignored.
1140	*/
1141	static DECLCALLBACK(VBOXSTRICTRC) vmR3PowerOn(PVM pVM, PVMCPU pVCpu, void *pvUser)
1142	{
1143	LogFlow(("vmR3PowerOn: pVM=%p pVCpu=%p/#%u\n", pVM, pVCpu, pVCpu->idCpu));
1144	Assert(!pvUser); NOREF(pvUser);
1145
1146	/*
1147	* The first thread thru here tries to change the state. We shouldn't be
1148	* called again if this fails.
1149	*/
1150	if (pVCpu->idCpu == pVM->cCpus - 1)
1151	{
1152	int rc = vmR3TrySetState(pVM, "VMR3PowerOn", 1, VMSTATE_POWERING_ON, VMSTATE_CREATED);
1153	if (RT_FAILURE(rc))
1154	return rc;
1155	}
1156
1157	VMSTATE enmVMState = VMR3GetState(pVM);
1158	AssertMsgReturn(enmVMState == VMSTATE_POWERING_ON,
1159	("%s\n", VMR3GetStateName(enmVMState)),
1160	VERR_INTERNAL_ERROR_4);
1161
1162	/*
1163	* All EMTs changes their state to started.
1164	*/
1165	VMCPU_SET_STATE(pVCpu, VMCPUSTATE_STARTED);
1166
1167	/*
1168	* EMT(0) is last thru here and it will make the notification calls
1169	* and advance the state.
1170	*/
1171	if (pVCpu->idCpu == 0)
1172	{
1173	PDMR3PowerOn(pVM);
1174	vmR3SetState(pVM, VMSTATE_RUNNING, VMSTATE_POWERING_ON);
1175	}
1176
1177	return VINF_SUCCESS;
1178	}
1179
1180
1181	/**
1182	* Powers on the virtual machine.
1183	*
1184	* @returns VBox status code.
1185	*
1186	* @param pVM The VM to power on.
1187	*
1188	* @thread Any thread.
1189	* @vmstate Created
1190	* @vmstateto PoweringOn+Running
1191	*/
1192	VMMR3DECL(int) VMR3PowerOn(PVM pVM)
1193	{
1194	LogFlow(("VMR3PowerOn: pVM=%p\n", pVM));
1195	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1196
1197	/*
1198	* Gather all the EMTs to reduce the init TSC drift and keep
1199	* the state changing APIs a bit uniform.
1200	*/
1201	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING \| VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR,
1202	vmR3PowerOn, NULL);
1203	LogFlow(("VMR3Suspend: returns %Rrc\n", rc));
1204	return rc;
1205	}
1206
1207
1208	/**
1209	* Does the suspend notifications.
1210	*
1211	* @param pVM The VM handle.
1212	* @thread EMT(0)
1213	*/
1214	static void vmR3SuspendDoWork(PVM pVM)
1215	{
1216	PDMR3Suspend(pVM);
1217	}
1218
1219
1220	/**
1221	* EMT rendezvous worker for VMR3Suspend.
1222	*
1223	* @returns VERR_VM_INVALID_VM_STATE or VINF_EM_SUSPEND. (This is a strict
1224	* return code, see FNVMMEMTRENDEZVOUS.)
1225	*
1226	* @param pVM The VM handle.
1227	* @param pVCpu The VMCPU handle of the EMT.
1228	* @param pvUser Ignored.
1229	*/
1230	static DECLCALLBACK(VBOXSTRICTRC) vmR3Suspend(PVM pVM, PVMCPU pVCpu, void *pvUser)
1231	{
1232	LogFlow(("vmR3Suspend: pVM=%p pVCpu=%p/#%u\n", pVM, pVCpu, pVCpu->idCpu));
1233	Assert(!pvUser); NOREF(pvUser);
1234
1235	/*
1236	* The first EMT switches the state to suspending. If this fails because
1237	* something was racing us in one way or the other, there will be no more
1238	* calls and thus the state assertion below is not going to annoy anyone.
1239	*/
1240	if (pVCpu->idCpu == pVM->cCpus - 1)
1241	{
1242	int rc = vmR3TrySetState(pVM, "VMR3Suspend", 2,
1243	VMSTATE_SUSPENDING, VMSTATE_RUNNING,
1244	VMSTATE_SUSPENDING_EXT_LS, VMSTATE_RUNNING_LS);
1245	if (RT_FAILURE(rc))
1246	return rc;
1247	}
1248
1249	VMSTATE enmVMState = VMR3GetState(pVM);
1250	AssertMsgReturn( enmVMState == VMSTATE_SUSPENDING
1251	\|\| enmVMState == VMSTATE_SUSPENDING_EXT_LS,
1252	("%s\n", VMR3GetStateName(enmVMState)),
1253	VERR_INTERNAL_ERROR_4);
1254
1255	/*
1256	* EMT(0) does the actually suspending after all the other CPUs have
1257	* been thru here.
1258	*/
1259	if (pVCpu->idCpu == 0)
1260	{
1261	vmR3SuspendDoWork(pVM);
1262
1263	int rc = vmR3TrySetState(pVM, "VMR3Suspend", 2,
1264	VMSTATE_SUSPENDED, VMSTATE_SUSPENDING,
1265	VMSTATE_SUSPENDED_EXT_LS, VMSTATE_SUSPENDING_EXT_LS);
1266	if (RT_FAILURE(rc))
1267	return VERR_INTERNAL_ERROR_3;
1268	}
1269
1270	return VINF_EM_SUSPEND;
1271	}
1272
1273
1274	/**
1275	* Suspends a running VM.
1276	*
1277	* @returns VBox status code. When called on EMT, this will be a strict status
1278	* code that has to be propagated up the call stack.
1279	*
1280	* @param pVM The VM to suspend.
1281	*
1282	* @thread Any thread.
1283	* @vmstate Running or RunningLS
1284	* @vmstateto Suspending + Suspended or SuspendingExtLS + SuspendedExtLS
1285	*/
1286	VMMR3DECL(int) VMR3Suspend(PVM pVM)
1287	{
1288	LogFlow(("VMR3Suspend: pVM=%p\n", pVM));
1289	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1290
1291	/*
1292	* Gather all the EMTs to make sure there are no races before
1293	* changing the VM state.
1294	*/
1295	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING \| VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR,
1296	vmR3Suspend, NULL);
1297	LogFlow(("VMR3Suspend: returns %Rrc\n", rc));
1298	return rc;
1299	}
1300
1301
1302	/**
1303	* EMT rendezvous worker for VMR3Resume.
1304	*
1305	* @returns VERR_VM_INVALID_VM_STATE or VINF_EM_RESUME. (This is a strict
1306	* return code, see FNVMMEMTRENDEZVOUS.)
1307	*
1308	* @param pVM The VM handle.
1309	* @param pVCpu The VMCPU handle of the EMT.
1310	* @param pvUser Ignored.
1311	*/
1312	static DECLCALLBACK(VBOXSTRICTRC) vmR3Resume(PVM pVM, PVMCPU pVCpu, void *pvUser)
1313	{
1314	LogFlow(("vmR3Resume: pVM=%p pVCpu=%p/#%u\n", pVM, pVCpu, pVCpu->idCpu));
1315	Assert(!pvUser); NOREF(pvUser);
1316
1317	/*
1318	* The first thread thru here tries to change the state. We shouldn't be
1319	* called again if this fails.
1320	*/
1321	if (pVCpu->idCpu == pVM->cCpus - 1)
1322	{
1323	int rc = vmR3TrySetState(pVM, "VMR3Resume", 1, VMSTATE_RESUMING, VMSTATE_SUSPENDED);
1324	if (RT_FAILURE(rc))
1325	return rc;
1326	}
1327
1328	VMSTATE enmVMState = VMR3GetState(pVM);
1329	AssertMsgReturn(enmVMState == VMSTATE_RESUMING,
1330	("%s\n", VMR3GetStateName(enmVMState)),
1331	VERR_INTERNAL_ERROR_4);
1332
1333	#if 0
1334	/*
1335	* All EMTs changes their state to started.
1336	*/
1337	VMCPU_SET_STATE(pVCpu, VMCPUSTATE_STARTED);
1338	#endif
1339
1340	/*
1341	* EMT(0) is last thru here and it will make the notification calls
1342	* and advance the state.
1343	*/
1344	if (pVCpu->idCpu == 0)
1345	{
1346	PDMR3Resume(pVM);
1347	vmR3SetState(pVM, VMSTATE_RUNNING, VMSTATE_RESUMING);
1348	pVM->vm.s.fTeleportedAndNotFullyResumedYet = false;
1349	}
1350
1351	return VINF_EM_RESUME;
1352	}
1353
1354
1355	/**
1356	* Resume VM execution.
1357	*
1358	* @returns VBox status code. When called on EMT, this will be a strict status
1359	* code that has to be propagated up the call stack.
1360	*
1361	* @param pVM The VM to resume.
1362	*
1363	* @thread Any thread.
1364	* @vmstate Suspended
1365	* @vmstateto Running
1366	*/
1367	VMMR3DECL(int) VMR3Resume(PVM pVM)
1368	{
1369	LogFlow(("VMR3Resume: pVM=%p\n", pVM));
1370	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1371
1372	/*
1373	* Gather all the EMTs to make sure there are no races before
1374	* changing the VM state.
1375	*/
1376	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING \| VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR,
1377	vmR3Resume, NULL);
1378	LogFlow(("VMR3Resume: returns %Rrc\n", rc));
1379	return rc;
1380	}
1381
1382
1383	/**
1384	* EMT rendezvous worker for VMR3Save and VMR3Teleport that suspends the VM
1385	* after the live step has been completed.
1386	*
1387	* @returns VERR_VM_INVALID_VM_STATE or VINF_EM_RESUME. (This is a strict
1388	* return code, see FNVMMEMTRENDEZVOUS.)
1389	*
1390	* @param pVM The VM handle.
1391	* @param pVCpu The VMCPU handle of the EMT.
1392	* @param pvUser Ignored.
1393	*/
1394	static DECLCALLBACK(VBOXSTRICTRC) vmR3LiveDoSuspend(PVM pVM, PVMCPU pVCpu, void *pvUser)
1395	{
1396	LogFlow(("vmR3LiveDoSuspend: pVM=%p pVCpu=%p/#%u\n", pVM, pVCpu, pVCpu->idCpu));
1397	Assert(!pvUser); NOREF(pvUser);
1398
1399	/*
1400	* The first thread thru here tries to change the state. We shouldn't be
1401	* called again if this fails.
1402	*/
1403	if (pVCpu->idCpu == pVM->cCpus - 1U)
1404	{
1405	PUVM pUVM = pVM->pUVM;
1406	int rc;
1407
1408	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
1409	VMSTATE enmVMState = pVM->enmVMState;
1410	switch (enmVMState)
1411	{
1412	case VMSTATE_RUNNING_LS:
1413	vmR3SetStateLocked(pVM, pUVM, VMSTATE_SUSPENDING_LS, VMSTATE_RUNNING_LS);
1414	rc = VINF_SUCCESS;
1415	break;
1416
1417	case VMSTATE_SUSPENDED_EXT_LS:
1418	case VMSTATE_SUSPENDED_LS: /* (via reset) */
1419	rc = VINF_SUCCESS;
1420	break;
1421
1422	case VMSTATE_DEBUGGING_LS:
1423	rc = VERR_TRY_AGAIN;
1424	break;
1425
1426	case VMSTATE_OFF_LS:
1427	vmR3SetStateLocked(pVM, pUVM, VMSTATE_OFF, VMSTATE_OFF_LS);
1428	rc = VERR_SSM_LIVE_POWERED_OFF;
1429	break;
1430
1431	case VMSTATE_FATAL_ERROR_LS:
1432	vmR3SetStateLocked(pVM, pUVM, VMSTATE_FATAL_ERROR, VMSTATE_FATAL_ERROR_LS);
1433	rc = VERR_SSM_LIVE_FATAL_ERROR;
1434	break;
1435
1436	case VMSTATE_GURU_MEDITATION_LS:
1437	vmR3SetStateLocked(pVM, pUVM, VMSTATE_GURU_MEDITATION, VMSTATE_GURU_MEDITATION_LS);
1438	rc = VERR_SSM_LIVE_GURU_MEDITATION;
1439	break;
1440
1441	case VMSTATE_POWERING_OFF_LS:
1442	case VMSTATE_SUSPENDING_EXT_LS:
1443	case VMSTATE_RESETTING_LS:
1444	default:
1445	AssertMsgFailed(("%s\n", VMR3GetStateName(enmVMState)));
1446	rc = VERR_INTERNAL_ERROR_3;
1447	break;
1448	}
1449	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
1450	if (RT_FAILURE(rc))
1451	{
1452	LogFlow(("vmR3LiveDoSuspend: returns %Rrc (state was %s)\n", rc, VMR3GetStateName(enmVMState)));
1453	return rc;
1454	}
1455	}
1456
1457	VMSTATE enmVMState = VMR3GetState(pVM);
1458	AssertMsgReturn(enmVMState == VMSTATE_SUSPENDING_LS,
1459	("%s\n", VMR3GetStateName(enmVMState)),
1460	VERR_INTERNAL_ERROR_4);
1461
1462	/*
1463	* Only EMT(0) have work to do since it's last thru here.
1464	*/
1465	if (pVCpu->idCpu == 0)
1466	{
1467	vmR3SuspendDoWork(pVM);
1468	int rc = vmR3TrySetState(pVM, "VMR3Suspend", 1,
1469	VMSTATE_SUSPENDED_LS, VMSTATE_SUSPENDING_LS);
1470	if (RT_FAILURE(rc))
1471	return VERR_INTERNAL_ERROR_3;
1472	}
1473
1474	return VINF_EM_SUSPEND;
1475	}
1476
1477
1478	/**
1479	* EMT rendezvous worker that VMR3Save and VMR3Teleport uses to clean up a
1480	* SSMR3LiveDoStep1 failure.
1481	*
1482	* Doing this as a rendezvous operation avoids all annoying transition
1483	* states.
1484	*
1485	* @returns VERR_VM_INVALID_VM_STATE, VINF_SUCCESS or some specific VERR_SSM_*
1486	* status code. (This is a strict return code, see FNVMMEMTRENDEZVOUS.)
1487	*
1488	* @param pVM The VM handle.
1489	* @param pVCpu The VMCPU handle of the EMT.
1490	* @param pvUser Ignored.
1491	*/
1492	static DECLCALLBACK(VBOXSTRICTRC) vmR3LiveDoStep1Cleanup(PVM pVM, PVMCPU pVCpu, void *pvUser)
1493	{
1494	LogFlow(("vmR3LiveDoStep1Cleanup: pVM=%p pVCpu=%p/#%u\n", pVM, pVCpu, pVCpu->idCpu));
1495	NOREF(pvUser); NOREF(pVCpu);
1496
1497	int rc = vmR3TrySetState(pVM, "vmR3LiveDoStep1Cleanup", 8,
1498	VMSTATE_OFF, VMSTATE_OFF_LS,
1499	VMSTATE_FATAL_ERROR, VMSTATE_FATAL_ERROR_LS,
1500	VMSTATE_GURU_MEDITATION, VMSTATE_GURU_MEDITATION_LS,
1501	VMSTATE_RUNNING, VMSTATE_RUNNING_LS,
1502	VMSTATE_SUSPENDED, VMSTATE_SUSPENDED_EXT_LS,
1503	VMSTATE_DEBUGGING, VMSTATE_DEBUGGING_LS);
1504	if (rc == 1)
1505	rc = VERR_SSM_LIVE_POWERED_OFF;
1506	else if (rc == 2)
1507	rc = VERR_SSM_LIVE_FATAL_ERROR;
1508	else if (rc == 3)
1509	rc = VERR_SSM_LIVE_GURU_MEDITATION;
1510	else if (rc > 0)
1511	rc = VINF_SUCCESS;
1512	return rc;
1513	}
1514
1515
1516	/**
1517	* EMT(0) worker for VMR3Save and VMR3Teleport that completes the live save.
1518	*
1519	* @returns VBox status code.
1520	* @retval VINF_SSM_LIVE_SUSPENDED if VMR3Suspend was called.
1521	*
1522	* @param pVM The VM handle.
1523	* @param pSSM The handle of saved state operation.
1524	*
1525	* @thread EMT(0)
1526	*/
1527	static DECLCALLBACK(int) vmR3LiveDoStep2(PVM pVM, PSSMHANDLE pSSM)
1528	{
1529	LogFlow(("vmR3LiveDoStep2: pVM=%p pSSM=%p\n", pVM, pSSM));
1530	VM_ASSERT_EMT0(pVM);
1531
1532	/*
1533	* Advance the state and mark if VMR3Suspend was called.
1534	*/
1535	int rc = VINF_SUCCESS;
1536	VMSTATE enmVMState = VMR3GetState(pVM);
1537	if (enmVMState == VMSTATE_SUSPENDED_LS)
1538	vmR3SetState(pVM, VMSTATE_SAVING, VMSTATE_SUSPENDED_LS);
1539	else
1540	{
1541	if (enmVMState != VMSTATE_SAVING)
1542	vmR3SetState(pVM, VMSTATE_SAVING, VMSTATE_SUSPENDED_EXT_LS);
1543	rc = VINF_SSM_LIVE_SUSPENDED;
1544	}
1545
1546	/*
1547	* Finish up and release the handle. Careful with the status codes.
1548	*/
1549	int rc2 = SSMR3LiveDoStep2(pSSM);
1550	if (rc == VINF_SUCCESS \|\| (RT_FAILURE(rc2) && RT_SUCCESS(rc)))
1551	rc = rc2;
1552
1553	rc2 = SSMR3LiveDone(pSSM);
1554	if (rc == VINF_SUCCESS \|\| (RT_FAILURE(rc2) && RT_SUCCESS(rc)))
1555	rc = rc2;
1556
1557	/*
1558	* Advance to the final state and return.
1559	*/
1560	vmR3SetState(pVM, VMSTATE_SUSPENDED, VMSTATE_SAVING);
1561	Assert(rc > VINF_EM_LAST \|\| rc < VINF_EM_FIRST);
1562	return rc;
1563	}
1564
1565
1566	/**
1567	* Worker for vmR3SaveTeleport that validates the state and calls SSMR3Save or
1568	* SSMR3LiveSave.
1569	*
1570	* @returns VBox status code.
1571	*
1572	* @param pVM The VM handle.
1573	* @param pszFilename The name of the file. NULL if pStreamOps is used.
1574	* @param pStreamOps The stream methods. NULL if pszFilename is used.
1575	* @param pvStreamOpsUser The user argument to the stream methods.
1576	* @param enmAfter What to do afterwards.
1577	* @param pfnProgress Progress callback. Optional.
1578	* @param pvProgressUser User argument for the progress callback.
1579	* @param ppSSM Where to return the saved state handle in case of a
1580	* live snapshot scenario.
1581	* @thread EMT
1582	*/
1583	static DECLCALLBACK(int) vmR3Save(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser,
1584	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void pvProgressUser, PSSMHANDLE ppSSM)
1585	{
1586	LogFlow(("vmR3Save: pVM=%p pszFilename=%p:{%s} pStreamOps=%p pvStreamOpsUser=%p enmAfter=%d pfnProgress=%p pvProgressUser=%p ppSSM=%p\n",
1587	pVM, pszFilename, pszFilename, pStreamOps, pvStreamOpsUser, enmAfter, pfnProgress, pvProgressUser, ppSSM));
1588
1589	/*
1590	* Validate input.
1591	*/
1592	AssertPtrNull(pszFilename);
1593	AssertPtrNull(pStreamOps);
1594	AssertPtr(pVM);
1595	Assert( enmAfter == SSMAFTER_DESTROY
1596	\|\| enmAfter == SSMAFTER_CONTINUE
1597	\|\| enmAfter == SSMAFTER_TELEPORT);
1598	AssertPtr(ppSSM);
1599	*ppSSM = NULL;
1600
1601	/*
1602	* Change the state and perform/start the saving.
1603	*/
1604	int rc = vmR3TrySetState(pVM, "VMR3Save", 2,
1605	VMSTATE_SAVING, VMSTATE_SUSPENDED,
1606	VMSTATE_RUNNING_LS, VMSTATE_RUNNING);
1607	if (rc == 1 && enmAfter != SSMAFTER_TELEPORT)
1608	{
1609	Assert(!pStreamOps);
1610	rc = SSMR3Save(pVM, pszFilename, enmAfter, pfnProgress, pvProgressUser);
1611	vmR3SetState(pVM, VMSTATE_SUSPENDED, VMSTATE_SAVING);
1612	}
1613	else if (rc == 2 \|\| enmAfter == SSMAFTER_TELEPORT)
1614	{
1615	if (enmAfter == SSMAFTER_TELEPORT)
1616	pVM->vm.s.fTeleportedAndNotFullyResumedYet = true;
1617	rc = SSMR3LiveSave(pVM, pszFilename, pStreamOps, pvStreamOpsUser,
1618	enmAfter, pfnProgress, pvProgressUser, ppSSM);
1619	/* (We're not subject to cancellation just yet.) */
1620	}
1621	else
1622	Assert(RT_FAILURE(rc));
1623	return rc;
1624	}
1625
1626
1627	/**
1628	* Commmon worker for VMR3Save and VMR3Teleport.
1629	*
1630	* @returns VBox status code.
1631	*
1632	* @param pVM The VM handle.
1633	* @param pszFilename The name of the file. NULL if pStreamOps is used.
1634	* @param pStreamOps The stream methods. NULL if pszFilename is used.
1635	* @param pvStreamOpsUser The user argument to the stream methods.
1636	* @param enmAfter What to do afterwards.
1637	* @param pfnProgress Progress callback. Optional.
1638	* @param pvProgressUser User argument for the progress callback.
1639	*
1640	* @thread Non-EMT
1641	*/
1642	static int vmR3SaveTeleport(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser,
1643	SSMAFTER enmAfter, PFNVMPROGRESS pfnProgress, void *pvProgressUser)
1644	{
1645	/*
1646	* Request the operation in EMT(0).
1647	*/
1648	PSSMHANDLE pSSM;
1649	int rc = VMR3ReqCallWaitU(pVM->pUVM, 0 /idDstCpu/,
1650	(PFNRT)vmR3Save, 8, pVM, pszFilename, pStreamOps, pvStreamOpsUser,
1651	enmAfter, pfnProgress, pvProgressUser, &pSSM);
1652	if ( RT_SUCCESS(rc)
1653	&& pSSM)
1654	{
1655	/*
1656	* Live snapshot.
1657	*
1658	* The state handling here is kind of tricky, doing it on EMT(0) helps
1659	* a bit. See the VMSTATE diagram for details.
1660	*/
1661	rc = SSMR3LiveDoStep1(pSSM);
1662	if (RT_SUCCESS(rc))
1663	{
1664	if (VMR3GetState(pVM) != VMSTATE_SAVING)
1665	for (;;)
1666	{
1667	/* Try suspend the VM. */
1668	rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING \| VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR,
1669	vmR3LiveDoSuspend, NULL);
1670	if (rc != VERR_TRY_AGAIN)
1671	break;
1672
1673	/* Wait for the state to change. */
1674	RTThreadSleep(250); /** @todo LS: fix this polling wait by some smart use of multiple release event semaphores.. */
1675	}
1676	if (RT_SUCCESS(rc))
1677	rc = VMR3ReqCallWaitU(pVM->pUVM, 0 /idDstCpu/, (PFNRT)vmR3LiveDoStep2, 2, pVM, pSSM);
1678	else
1679	SSMR3LiveDone(pSSM);
1680	}
1681	else
1682	{
1683	int rc2 = SSMR3LiveDone(pSSM);
1684	AssertMsg(rc2 == rc, ("%Rrc != %Rrc\n", rc2, rc));
1685
1686	rc2 = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, vmR3LiveDoStep1Cleanup, NULL);
1687	if (RT_FAILURE(rc2) && rc == VERR_SSM_CANCELLED)
1688	rc = rc2;
1689	}
1690	}
1691
1692	return rc;
1693	}
1694
1695
1696	/**
1697	* Save current VM state.
1698	*
1699	* Can be used for both saving the state and creating snapshots.
1700	*
1701	* When called for a VM in the Running state, the saved state is created live
1702	* and the VM is only suspended when the final part of the saving is preformed.
1703	* The VM state will not be restored to Running in this case and it's up to the
1704	* caller to call VMR3Resume if this is desirable. (The rational is that the
1705	* caller probably wish to reconfigure the disks before resuming the VM.)
1706	*
1707	* @returns VBox status code.
1708	*
1709	* @param pVM The VM which state should be saved.
1710	* @param pszFilename The name of the save state file.
1711	* @param fContinueAfterwards Whether continue execution afterwards or not.
1712	* When in doubt, set this to true.
1713	* @param pfnProgress Progress callback. Optional.
1714	* @param pvUser User argument for the progress callback.
1715	*
1716	* @thread Non-EMT.
1717	* @vmstate Suspended or Running
1718	* @vmstateto Saving+Suspended or
1719	* RunningLS+SuspeningLS+SuspendedLS+Saving+Suspended.
1720	*/
1721	VMMR3DECL(int) VMR3Save(PVM pVM, const char pszFilename, bool fContinueAfterwards, PFNVMPROGRESS pfnProgress, void pvUser)
1722	{
1723	LogFlow(("VMR3Save: pVM=%p pszFilename=%p:{%s} fContinueAfterwards=%RTbool pfnProgress=%p pvUser=%p\n",
1724	pVM, pszFilename, pszFilename, fContinueAfterwards, pfnProgress, pvUser));
1725
1726	/*
1727	* Validate input.
1728	*/
1729	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1730	VM_ASSERT_OTHER_THREAD(pVM);
1731	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1732	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
1733	AssertPtrNullReturn(pfnProgress, VERR_INVALID_POINTER);
1734
1735	/*
1736	* Join paths with VMR3Teleport.
1737	*/
1738	SSMAFTER enmAfter = fContinueAfterwards ? SSMAFTER_CONTINUE : SSMAFTER_DESTROY;
1739	int rc = vmR3SaveTeleport(pVM, pszFilename, NULL /pStreamOps/, NULL /pvStreamOpsUser/,
1740	enmAfter, pfnProgress, pvUser);
1741	LogFlow(("VMR3Save: returns %Rrc\n", rc));
1742	return rc;
1743	}
1744
1745
1746	/**
1747	* Teleport the VM (aka live migration).
1748	*
1749	* @returns VBox status code.
1750	*
1751	* @param pVM The VM which state should be saved.
1752	* @param pStreamOps The stream methods.
1753	* @param pvStreamOpsUser The user argument to the stream methods.
1754	* @param pfnProgress Progress callback. Optional.
1755	* @param pvProgressUser User argument for the progress callback.
1756	*
1757	* @thread Non-EMT.
1758	* @vmstate Suspended or Running
1759	* @vmstateto Saving+Suspended or
1760	* RunningLS+SuspeningLS+SuspendedLS+Saving+Suspended.
1761	*/
1762	VMMR3DECL(int) VMR3Teleport(PVM pVM, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser, PFNVMPROGRESS pfnProgress, void pvProgressUser)
1763	{
1764	LogFlow(("VMR3Teleport: pVM=%p pStreamOps=%p pvStreamOps=%p pfnProgress=%p pvProgressUser=%p\n",
1765	pVM, pStreamOps, pvStreamOpsUser, pfnProgress, pvProgressUser));
1766
1767	/*
1768	* Validate input.
1769	*/
1770	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1771	VM_ASSERT_OTHER_THREAD(pVM);
1772	AssertPtrReturn(pStreamOps, VERR_INVALID_POINTER);
1773	AssertPtrNullReturn(pfnProgress, VERR_INVALID_POINTER);
1774
1775	/*
1776	* Join paths with VMR3Save.
1777	*/
1778	int rc = vmR3SaveTeleport(pVM, NULL /pszFilename/, pStreamOps, pvStreamOpsUser,
1779	SSMAFTER_TELEPORT, pfnProgress, pvProgressUser);
1780	LogFlow(("VMR3Teleport: returns %Rrc\n", rc));
1781	return rc;
1782	}
1783
1784
1785
1786	/**
1787	* EMT(0) worker for VMR3LoadFromFile and VMR3LoadFromStream.
1788	*
1789	* @returns VBox status code.
1790	*
1791	* @param pVM The VM handle.
1792	* @param pszFilename The name of the file. NULL if pStreamOps is used.
1793	* @param pStreamOps The stream methods. NULL if pszFilename is used.
1794	* @param pvStreamOpsUser The user argument to the stream methods.
1795	* @param pfnProgress Progress callback. Optional.
1796	* @param pvUser User argument for the progress callback.
1797	* @param fTeleporting Indicates whether we're teleporting or not.
1798	*
1799	* @thread EMT.
1800	*/
1801	static DECLCALLBACK(int) vmR3Load(PVM pVM, const char pszFilename, PCSSMSTRMOPS pStreamOps, void pvStreamOpsUser,
1802	PFNVMPROGRESS pfnProgress, void *pvProgressUser, bool fTeleporting)
1803	{
1804	LogFlow(("vmR3Load: pVM=%p pszFilename=%p:{%s} pStreamOps=%p pvStreamOpsUser=%p pfnProgress=%p pvProgressUser=%p fTeleporting=%RTbool\n",
1805	pVM, pszFilename, pszFilename, pStreamOps, pvStreamOpsUser, pfnProgress, pvProgressUser, fTeleporting));
1806
1807	/*
1808	* Validate input (paranoia).
1809	*/
1810	AssertPtr(pVM);
1811	AssertPtrNull(pszFilename);
1812	AssertPtrNull(pStreamOps);
1813	AssertPtrNull(pfnProgress);
1814
1815	/*
1816	* Change the state and perform the load.
1817	*
1818	* Always perform a relocation round afterwards to make sure hypervisor
1819	* selectors and such are correct.
1820	*/
1821	int rc = vmR3TrySetState(pVM, "VMR3Load", 2,
1822	VMSTATE_LOADING, VMSTATE_CREATED,
1823	VMSTATE_LOADING, VMSTATE_SUSPENDED);
1824	if (RT_FAILURE(rc))
1825	return rc;
1826	pVM->vm.s.fTeleportedAndNotFullyResumedYet = fTeleporting;
1827
1828	rc = SSMR3Load(pVM, pszFilename, pStreamOps, pvStreamOpsUser, SSMAFTER_RESUME, pfnProgress, pvProgressUser);
1829	if (RT_SUCCESS(rc))
1830	{
1831	VMR3Relocate(pVM, 0 /offDelta/);
1832	vmR3SetState(pVM, VMSTATE_SUSPENDED, VMSTATE_LOADING);
1833	}
1834	else
1835	{
1836	pVM->vm.s.fTeleportedAndNotFullyResumedYet = false;
1837	vmR3SetState(pVM, VMSTATE_LOAD_FAILURE, VMSTATE_LOADING);
1838	rc = VMSetError(pVM, rc, RT_SRC_POS,
1839	N_("Unable to restore the virtual machine's saved state from '%s'. It may be damaged or from an older version of VirtualBox. Please discard the saved state before starting the virtual machine"),
1840	pszFilename);
1841	}
1842
1843	return rc;
1844	}
1845
1846
1847	/**
1848	* Loads a VM state into a newly created VM or a one that is suspended.
1849	*
1850	* To restore a saved state on VM startup, call this function and then resume
1851	* the VM instead of powering it on.
1852	*
1853	* @returns VBox status code.
1854	*
1855	* @param pVM The VM handle.
1856	* @param pszFilename The name of the save state file.
1857	* @param pfnProgress Progress callback. Optional.
1858	* @param pvUser User argument for the progress callback.
1859	*
1860	* @thread Any thread.
1861	* @vmstate Created, Suspended
1862	* @vmstateto Loading+Suspended
1863	*/
1864	VMMR3DECL(int) VMR3LoadFromFile(PVM pVM, const char pszFilename, PFNVMPROGRESS pfnProgress, void pvUser)
1865	{
1866	LogFlow(("VMR3LoadFromFile: pVM=%p pszFilename=%p:{%s} pfnProgress=%p pvUser=%p\n",
1867	pVM, pszFilename, pszFilename, pfnProgress, pvUser));
1868
1869	/*
1870	* Validate input.
1871	*/
1872	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1873	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1874
1875	/*
1876	* Forward the request to EMT(0). No need to setup a rendezvous here
1877	* since there is no execution taking place when this call is allowed.
1878	*/
1879	int rc = VMR3ReqCallWaitU(pVM->pUVM, 0 /idDstCpu/, (PFNRT)vmR3Load, 7,
1880	pVM, pszFilename, NULL /pStreamOps/, NULL /pvStreamOpsUser/, pfnProgress, pvUser,
1881	false /fTeleporting/);
1882	LogFlow(("VMR3LoadFromFile: returns %Rrc\n", rc));
1883	return rc;
1884	}
1885
1886
1887	/**
1888	* VMR3LoadFromFile for arbritrary file streams.
1889	*
1890	* @returns VBox status code.
1891	*
1892	* @param pVM The VM handle.
1893	* @param pStreamOps The stream methods.
1894	* @param pvStreamOpsUser The user argument to the stream methods.
1895	* @param pfnProgress Progress callback. Optional.
1896	* @param pvProgressUser User argument for the progress callback.
1897	*
1898	* @thread Any thread.
1899	* @vmstate Created, Suspended
1900	* @vmstateto Loading+Suspended
1901	*/
1902	VMMR3DECL(int) VMR3LoadFromStream(PVM pVM, PCSSMSTRMOPS pStreamOps, void *pvStreamOpsUser,
1903	PFNVMPROGRESS pfnProgress, void *pvProgressUser)
1904	{
1905	LogFlow(("VMR3LoadFromStream: pVM=%p pStreamOps=%p pvStreamOpsUser=%p pfnProgress=%p pvProgressUser=%p\n",
1906	pVM, pStreamOps, pvStreamOpsUser, pfnProgress, pvProgressUser));
1907
1908	/*
1909	* Validate input.
1910	*/
1911	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1912	AssertPtrReturn(pStreamOps, VERR_INVALID_POINTER);
1913
1914	/*
1915	* Forward the request to EMT(0). No need to setup a rendezvous here
1916	* since there is no execution taking place when this call is allowed.
1917	*/
1918	int rc = VMR3ReqCallWaitU(pVM->pUVM, 0 /idDstCpu/, (PFNRT)vmR3Load, 7,
1919	pVM, NULL /pszFilename/, pStreamOps, pvStreamOpsUser, pfnProgress, pvProgressUser,
1920	true /fTeleporting/);
1921	LogFlow(("VMR3LoadFromStream: returns %Rrc\n", rc));
1922	return rc;
1923	}
1924
1925
1926	/**
1927	* EMT rendezvous worker for VMR3PowerOff.
1928	*
1929	* @returns VERR_VM_INVALID_VM_STATE or VINF_EM_OFF. (This is a strict
1930	* return code, see FNVMMEMTRENDEZVOUS.)
1931	*
1932	* @param pVM The VM handle.
1933	* @param pVCpu The VMCPU handle of the EMT.
1934	* @param pvUser Ignored.
1935	*/
1936	static DECLCALLBACK(VBOXSTRICTRC) vmR3PowerOff(PVM pVM, PVMCPU pVCpu, void *pvUser)
1937	{
1938	LogFlow(("vmR3PowerOff: pVM=%p pVCpu=%p/#%u\n", pVM, pVCpu, pVCpu->idCpu));
1939	Assert(!pvUser); NOREF(pvUser);
1940
1941	/*
1942	* The first EMT thru here will change the state to PoweringOff.
1943	*/
1944	if (pVCpu->idCpu == pVM->cCpus - 1)
1945	{
1946	int rc = vmR3TrySetState(pVM, "VMR3PowerOff", 10,
1947	VMSTATE_POWERING_OFF, VMSTATE_RUNNING,
1948	VMSTATE_POWERING_OFF, VMSTATE_SUSPENDED,
1949	VMSTATE_POWERING_OFF, VMSTATE_DEBUGGING,
1950	VMSTATE_POWERING_OFF, VMSTATE_LOAD_FAILURE,
1951	VMSTATE_POWERING_OFF, VMSTATE_GURU_MEDITATION,
1952	VMSTATE_POWERING_OFF, VMSTATE_FATAL_ERROR,
1953	VMSTATE_POWERING_OFF, VMSTATE_CREATED, /** @todo update the diagram! */
1954	VMSTATE_POWERING_OFF_LS, VMSTATE_RUNNING_LS,
1955	VMSTATE_POWERING_OFF_LS, VMSTATE_DEBUGGING_LS,
1956	VMSTATE_POWERING_OFF_LS, VMSTATE_GURU_MEDITATION_LS,
1957	VMSTATE_POWERING_OFF_LS, VMSTATE_FATAL_ERROR_LS);
1958	if (RT_FAILURE(rc))
1959	return rc;
1960	if (rc >= 7)
1961	SSMR3Cancel(pVM);
1962	}
1963
1964	/*
1965	* Check the state.
1966	*/
1967	VMSTATE enmVMState = VMR3GetState(pVM);
1968	AssertMsgReturn( enmVMState == VMSTATE_POWERING_OFF
1969	\|\| enmVMState == VMSTATE_POWERING_OFF_LS,
1970	("%s\n", VMR3GetStateName(enmVMState)),
1971	VERR_VM_INVALID_VM_STATE);
1972
1973	/*
1974	* EMT(0) does the actual power off work here after all the other EMTs
1975	* have been thru and entered the STOPPED state.
1976	*/
1977	VMCPU_SET_STATE(pVCpu, VMCPUSTATE_STOPPED);
1978	if (pVCpu->idCpu == 0)
1979	{
1980	/*
1981	* For debugging purposes, we will log a summary of the guest state at this point.
1982	*/
1983	if (enmVMState != VMSTATE_GURU_MEDITATION)
1984	{
1985	/** @todo SMP support? */
1986	PVMCPU pVCpu = VMMGetCpu(pVM);
1987
1988	/** @todo make the state dumping at VMR3PowerOff optional. */
1989	RTLogRelPrintf("**************** Guest state at power off ****************\n");
1990	DBGFR3Info(pVM, "cpumguest", "verbose", DBGFR3InfoLogRelHlp());
1991	RTLogRelPrintf("***\n");
1992	DBGFR3Info(pVM, "mode", NULL, DBGFR3InfoLogRelHlp());
1993	RTLogRelPrintf("***\n");
1994	DBGFR3Info(pVM, "activetimers", NULL, DBGFR3InfoLogRelHlp());
1995	RTLogRelPrintf("***\n");
1996	DBGFR3Info(pVM, "gdt", NULL, DBGFR3InfoLogRelHlp());
1997	/** @todo dump guest call stack. */
1998	#if 1 // "temporary" while debugging #1589
1999	RTLogRelPrintf("***\n");
2000	uint32_t esp = CPUMGetGuestESP(pVCpu);
2001	if ( CPUMGetGuestSS(pVCpu) == 0
2002	&& esp < _64K)
2003	{
2004	uint8_t abBuf[PAGE_SIZE];
2005	RTLogRelPrintf("***\n"
2006	"ss:sp=0000:%04x ", esp);
2007	uint32_t Start = esp & ~(uint32_t)63;
2008	int rc = PGMPhysSimpleReadGCPhys(pVM, abBuf, Start, 0x100);
2009	if (RT_SUCCESS(rc))
2010	RTLogRelPrintf("0000:%04x TO 0000:%04x:\n"
2011	"%.*Rhxd\n",
2012	Start, Start + 0x100 - 1,
2013	0x100, abBuf);
2014	else
2015	RTLogRelPrintf("rc=%Rrc\n", rc);
2016
2017	/* grub ... */
2018	if (esp < 0x2000 && esp > 0x1fc0)
2019	{
2020	rc = PGMPhysSimpleReadGCPhys(pVM, abBuf, 0x8000, 0x800);
2021	if (RT_SUCCESS(rc))
2022	RTLogRelPrintf("0000:8000 TO 0000:87ff:\n"
2023	"%.*Rhxd\n",
2024	0x800, abBuf);
2025	}
2026	/* microsoft cdrom hang ... */
2027	if (true)
2028	{
2029	rc = PGMPhysSimpleReadGCPhys(pVM, abBuf, 0x8000, 0x200);
2030	if (RT_SUCCESS(rc))
2031	RTLogRelPrintf("2000:0000 TO 2000:01ff:\n"
2032	"%.*Rhxd\n",
2033	0x200, abBuf);
2034	}
2035	}
2036	#endif
2037	RTLogRelPrintf("************ End of Guest state at power off *************\n");
2038	}
2039
2040	/*
2041	* Perform the power off notifications and advance the state to
2042	* Off or OffLS.
2043	*/
2044	PDMR3PowerOff(pVM);
2045
2046	PUVM pUVM = pVM->pUVM;
2047	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
2048	enmVMState = pVM->enmVMState;
2049	if (enmVMState == VMSTATE_POWERING_OFF_LS)
2050	vmR3SetStateLocked(pVM, pUVM, VMSTATE_OFF_LS, VMSTATE_POWERING_OFF_LS);
2051	else
2052	vmR3SetStateLocked(pVM, pUVM, VMSTATE_OFF, VMSTATE_POWERING_OFF);
2053	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
2054	}
2055	return VINF_EM_OFF;
2056	}
2057
2058
2059	/**
2060	* Power off the VM.
2061	*
2062	* @returns VBox status code. When called on EMT, this will be a strict status
2063	* code that has to be propagated up the call stack.
2064	*
2065	* @param pVM The handle of the VM to be powered off.
2066	*
2067	* @thread Any thread.
2068	* @vmstate Suspended, Running, Guru Meditation, Load Failure
2069	* @vmstateto Off or OffLS
2070	*/
2071	VMMR3DECL(int) VMR3PowerOff(PVM pVM)
2072	{
2073	LogFlow(("VMR3PowerOff: pVM=%p\n", pVM));
2074	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2075
2076	/*
2077	* Gather all the EMTs to make sure there are no races before
2078	* changing the VM state.
2079	*/
2080	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING \| VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR,
2081	vmR3PowerOff, NULL);
2082	LogFlow(("VMR3PowerOff: returns %Rrc\n", rc));
2083	return rc;
2084	}
2085
2086
2087	/**
2088	* Destroys the VM.
2089	*
2090	* The VM must be powered off (or never really powered on) to call this
2091	* function. The VM handle is destroyed and can no longer be used up successful
2092	* return.
2093	*
2094	* @returns VBox status code.
2095	*
2096	* @param pVM The handle of the VM which should be destroyed.
2097	*
2098	* @thread EMT(0) or any none emulation thread.
2099	* @vmstate Off, Created
2100	* @vmstateto N/A
2101	*/
2102	VMMR3DECL(int) VMR3Destroy(PVM pVM)
2103	{
2104	LogFlow(("VMR3Destroy: pVM=%p\n", pVM));
2105
2106	/*
2107	* Validate input.
2108	*/
2109	if (!pVM)
2110	return VERR_INVALID_PARAMETER;
2111	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2112	Assert(VMMGetCpuId(pVM) == 0 \|\| VMMGetCpuId(pVM) == NIL_VMCPUID);
2113
2114	/*
2115	* Change VM state to destroying and unlink the VM.
2116	*/
2117	int rc = vmR3TrySetState(pVM, "VMR3Destroy", 1, VMSTATE_DESTROYING, VMSTATE_OFF);
2118	if (RT_FAILURE(rc))
2119	return rc;
2120
2121	/** @todo lock this when we start having multiple machines in a process... */
2122	PUVM pUVM = pVM->pUVM; AssertPtr(pUVM);
2123	if (g_pUVMsHead == pUVM)
2124	g_pUVMsHead = pUVM->pNext;
2125	else
2126	{
2127	PUVM pPrev = g_pUVMsHead;
2128	while (pPrev && pPrev->pNext != pUVM)
2129	pPrev = pPrev->pNext;
2130	AssertMsgReturn(pPrev, ("pUVM=%p / pVM=%p is INVALID!\n", pUVM, pVM), VERR_INVALID_PARAMETER);
2131
2132	pPrev->pNext = pUVM->pNext;
2133	}
2134	pUVM->pNext = NULL;
2135
2136	/*
2137	* Notify registered at destruction listeners.
2138	*/
2139	vmR3AtDtor(pVM);
2140
2141	/*
2142	* EMT(0) does the final cleanup, so if we're it calling VMR3Destroy then
2143	* we'll have to postpone parts of it till later. Otherwise, call
2144	* vmR3Destroy on each of the EMTs in ending with EMT(0) doing the bulk
2145	* of the cleanup.
2146	*/
2147	if (VMMGetCpuId(pVM) == 0)
2148	{
2149	pUVM->vm.s.fEMTDoesTheCleanup = true;
2150	pUVM->vm.s.fTerminateEMT = true;
2151	VM_FF_SET(pVM, VM_FF_TERMINATE);
2152
2153	/* Terminate the other EMTs. */
2154	for (VMCPUID idCpu = 1; idCpu < pVM->cCpus; idCpu++)
2155	{
2156	int rc = VMR3ReqCallWaitU(pUVM, idCpu, (PFNRT)vmR3Destroy, 1, pVM);
2157	AssertLogRelRC(rc);
2158	}
2159	}
2160	else
2161	{
2162	/* vmR3Destroy on all EMTs, ending with EMT(0). */
2163	int rc = VMR3ReqCallWaitU(pUVM, VMCPUID_ALL_REVERSE, (PFNRT)vmR3Destroy, 1, pVM);
2164	AssertLogRelRC(rc);
2165
2166	/* Wait for EMTs and destroy the UVM. */
2167	vmR3DestroyUVM(pUVM, 30000);
2168	}
2169
2170	LogFlow(("VMR3Destroy: returns VINF_SUCCESS\n"));
2171	return VINF_SUCCESS;
2172	}
2173
2174
2175	/**
2176	* Internal destruction worker.
2177	*
2178	* This is either called from VMR3Destroy via VMR3ReqCallU or from
2179	* vmR3EmulationThreadWithId when EMT(0) terminates after having called
2180	* VMR3Destroy().
2181	*
2182	* When called on EMT(0), it will performed the great bulk of the destruction.
2183	* When called on the other EMTs, they will do nothing and the whole purpose is
2184	* to return VINF_EM_TERMINATE so they break out of their run loops.
2185	*
2186	* @returns VINF_EM_TERMINATE.
2187	* @param pVM The VM handle.
2188	*/
2189	DECLCALLBACK(int) vmR3Destroy(PVM pVM)
2190	{
2191	PUVM pUVM = pVM->pUVM;
2192	PVMCPU pVCpu = VMMGetCpu(pVM);
2193	Assert(pVCpu);
2194	LogFlow(("vmR3Destroy: pVM=%p pUVM=%p pVCpu=%p idCpu=%u\n", pVM, pUVM, pVCpu, pVCpu->idCpu));
2195
2196	/*
2197	* Only VCPU 0 does the full cleanup.
2198	*/
2199	if (pVCpu->idCpu == 0)
2200	{
2201
2202	/*
2203	* Dump statistics to the log.
2204	*/
2205	#if defined(VBOX_WITH_STATISTICS) \|\| defined(LOG_ENABLED)
2206	RTLogFlags(NULL, "nodisabled nobuffered");
2207	#endif
2208	#ifdef VBOX_WITH_STATISTICS
2209	STAMR3Dump(pVM, "*");
2210	#else
2211	LogRel(("*********************** Statistics ***********************\n"));
2212	STAMR3DumpToReleaseLog(pVM, "*");
2213	LogRel(("******************* End of statistics ********************\n"));
2214	#endif
2215
2216	/*
2217	* Destroy the VM components.
2218	*/
2219	int rc = TMR3Term(pVM);
2220	AssertRC(rc);
2221	#ifdef VBOX_WITH_DEBUGGER
2222	rc = DBGCTcpTerminate(pVM, pUVM->vm.s.pvDBGC);
2223	pUVM->vm.s.pvDBGC = NULL;
2224	#endif
2225	AssertRC(rc);
2226	rc = DBGFR3Term(pVM);
2227	AssertRC(rc);
2228	rc = PDMR3Term(pVM);
2229	AssertRC(rc);
2230	rc = EMR3Term(pVM);
2231	AssertRC(rc);
2232	rc = IOMR3Term(pVM);
2233	AssertRC(rc);
2234	rc = CSAMR3Term(pVM);
2235	AssertRC(rc);
2236	rc = PATMR3Term(pVM);
2237	AssertRC(rc);
2238	rc = TRPMR3Term(pVM);
2239	AssertRC(rc);
2240	rc = SELMR3Term(pVM);
2241	AssertRC(rc);
2242	rc = REMR3Term(pVM);
2243	AssertRC(rc);
2244	rc = HWACCMR3Term(pVM);
2245	AssertRC(rc);
2246	rc = PGMR3Term(pVM);
2247	AssertRC(rc);
2248	rc = VMMR3Term(pVM); /* Terminates the ring-0 code! */
2249	AssertRC(rc);
2250	rc = CPUMR3Term(pVM);
2251	AssertRC(rc);
2252	SSMR3Term(pVM);
2253	rc = PDMR3CritSectTerm(pVM);
2254	AssertRC(rc);
2255	rc = MMR3Term(pVM);
2256	AssertRC(rc);
2257
2258	/*
2259	* We're done in this thread (EMT).
2260	*/
2261	ASMAtomicUoWriteBool(&pUVM->vm.s.fTerminateEMT, true);
2262	ASMAtomicWriteU32(&pVM->fGlobalForcedActions, VM_FF_TERMINATE);
2263	LogFlow(("vmR3Destroy: returning %Rrc\n", VINF_EM_TERMINATE));
2264	}
2265	return VINF_EM_TERMINATE;
2266	}
2267
2268
2269	/**
2270	* Called at the end of the EMT procedure to take care of the final cleanup.
2271	*
2272	* Currently only EMT(0) will do work here. It will destroy the shared VM
2273	* structure if it is still around. If EMT(0) was the caller of VMR3Destroy it
2274	* will destroy UVM and nothing will be left behind upon exit. But if some
2275	* other thread is calling VMR3Destroy, they will clean up UVM after all EMTs
2276	* has exitted.
2277	*
2278	* @param pUVM The UVM handle.
2279	* @param idCpu The virtual CPU id.
2280	*/
2281	void vmR3DestroyFinalBitFromEMT(PUVM pUVM, VMCPUID idCpu)
2282	{
2283	/*
2284	* Only EMT(0) has work to do here.
2285	*/
2286	if (idCpu != 0)
2287	return;
2288	Assert( !pUVM->pVM
2289	\|\| VMMGetCpuId(pUVM->pVM) == 0);
2290
2291	/*
2292	* If we have a shared VM structure, change its state to Terminated and
2293	* tell GVMM to destroy it.
2294	*/
2295	if (pUVM->pVM)
2296	{
2297	vmR3SetState(pUVM->pVM, VMSTATE_TERMINATED, VMSTATE_DESTROYING);
2298	int rc = SUPR3CallVMMR0Ex(pUVM->pVM->pVMR0, 0 /idCpu/, VMMR0_DO_GVMM_DESTROY_VM, 0, NULL);
2299	AssertLogRelRC(rc);
2300	pUVM->pVM = NULL;
2301	}
2302
2303	/*
2304	* If EMT(0) called VMR3Destroy, then it will destroy UVM as well.
2305	*/
2306	if (pUVM->vm.s.fEMTDoesTheCleanup)
2307	vmR3DestroyUVM(pUVM, 30000);
2308	}
2309
2310
2311	/**
2312	* Destroys the UVM portion.
2313	*
2314	* This is called as the final step in the VM destruction or as the cleanup
2315	* in case of a creation failure. If EMT(0) called VMR3Destroy, meaning
2316	* VMINTUSERPERVM::fEMTDoesTheCleanup is true, it will call this as
2317	* vmR3DestroyFinalBitFromEMT completes.
2318	*
2319	* @param pVM VM Handle.
2320	* @param cMilliesEMTWait The number of milliseconds to wait for the emulation
2321	* threads.
2322	*/
2323	static void vmR3DestroyUVM(PUVM pUVM, uint32_t cMilliesEMTWait)
2324	{
2325	/*
2326	* Signal termination of each the emulation threads and
2327	* wait for them to complete.
2328	*/
2329	/* Signal them. */
2330	ASMAtomicUoWriteBool(&pUVM->vm.s.fTerminateEMT, true);
2331	for (VMCPUID i = 0; i < pUVM->cCpus; i++)
2332	{
2333	ASMAtomicUoWriteBool(&pUVM->aCpus[i].vm.s.fTerminateEMT, true);
2334	if (pUVM->pVM)
2335	VM_FF_SET(pUVM->pVM, VM_FF_TERMINATE);
2336	VMR3NotifyGlobalFFU(pUVM, VMNOTIFYFF_FLAGS_DONE_REM);
2337	RTSemEventSignal(pUVM->aCpus[i].vm.s.EventSemWait);
2338	}
2339
2340	/* Wait for them. */
2341	uint64_t NanoTS = RTTimeNanoTS();
2342	RTTHREAD hSelf = RTThreadSelf();
2343	ASMAtomicUoWriteBool(&pUVM->vm.s.fTerminateEMT, true);
2344	for (VMCPUID i = 0; i < pUVM->cCpus; i++)
2345	{
2346	RTTHREAD hThread = pUVM->aCpus[i].vm.s.ThreadEMT;
2347	if ( hThread != NIL_RTTHREAD
2348	&& hThread != hSelf)
2349	{
2350	uint64_t cMilliesElapsed = (RTTimeNanoTS() - NanoTS) / 1000000;
2351	int rc2 = RTThreadWait(hThread,
2352	cMilliesElapsed < cMilliesEMTWait
2353	? RT_MAX(cMilliesEMTWait - cMilliesElapsed, 2000)
2354	: 2000,
2355	NULL);
2356	if (rc2 == VERR_TIMEOUT) /* avoid the assertion when debugging. */
2357	rc2 = RTThreadWait(hThread, 1000, NULL);
2358	AssertLogRelMsgRC(rc2, ("i=%u rc=%Rrc\n", i, rc2));
2359	if (RT_SUCCESS(rc2))
2360	pUVM->aCpus[0].vm.s.ThreadEMT = NIL_RTTHREAD;
2361	}
2362	}
2363
2364	/* Cleanup the semaphores. */
2365	for (VMCPUID i = 0; i < pUVM->cCpus; i++)
2366	{
2367	RTSemEventDestroy(pUVM->aCpus[i].vm.s.EventSemWait);
2368	pUVM->aCpus[i].vm.s.EventSemWait = NIL_RTSEMEVENT;
2369	}
2370
2371	/*
2372	* Free the event semaphores associated with the request packets.
2373	*/
2374	unsigned cReqs = 0;
2375	for (unsigned i = 0; i < RT_ELEMENTS(pUVM->vm.s.apReqFree); i++)
2376	{
2377	PVMREQ pReq = pUVM->vm.s.apReqFree[i];
2378	pUVM->vm.s.apReqFree[i] = NULL;
2379	for (; pReq; pReq = pReq->pNext, cReqs++)
2380	{
2381	pReq->enmState = VMREQSTATE_INVALID;
2382	RTSemEventDestroy(pReq->EventSem);
2383	}
2384	}
2385	Assert(cReqs == pUVM->vm.s.cReqFree); NOREF(cReqs);
2386
2387	/*
2388	* Kill all queued requests. (There really shouldn't be any!)
2389	*/
2390	for (unsigned i = 0; i < 10; i++)
2391	{
2392	PVMREQ pReqHead = (PVMREQ)ASMAtomicXchgPtr((void volatile )&pUVM->vm.s.pReqs, NULL);
2393	AssertMsg(!pReqHead, ("This isn't supposed to happen! VMR3Destroy caller has to serialize this.\n"));
2394	if (!pReqHead)
2395	break;
2396	for (PVMREQ pReq = pReqHead; pReq; pReq = pReq->pNext)
2397	{
2398	ASMAtomicUoWriteSize(&pReq->iStatus, VERR_INTERNAL_ERROR);
2399	ASMAtomicWriteSize(&pReq->enmState, VMREQSTATE_INVALID);
2400	RTSemEventSignal(pReq->EventSem);
2401	RTThreadSleep(2);
2402	RTSemEventDestroy(pReq->EventSem);
2403	}
2404	/* give them a chance to respond before we free the request memory. */
2405	RTThreadSleep(32);
2406	}
2407
2408	/*
2409	* Now all queued VCPU requests (again, there shouldn't be any).
2410	*/
2411	for (VMCPUID i = 0; i < pUVM->cCpus; i++)
2412	{
2413	PUVMCPU pUVCpu = &pUVM->aCpus[i];
2414
2415	for (unsigned i = 0; i < 10; i++)
2416	{
2417	PVMREQ pReqHead = (PVMREQ)ASMAtomicXchgPtr((void volatile )&pUVCpu->vm.s.pReqs, NULL);
2418	AssertMsg(!pReqHead, ("This isn't supposed to happen! VMR3Destroy caller has to serialize this.\n"));
2419	if (!pReqHead)
2420	break;
2421	for (PVMREQ pReq = pReqHead; pReq; pReq = pReq->pNext)
2422	{
2423	ASMAtomicUoWriteSize(&pReq->iStatus, VERR_INTERNAL_ERROR);
2424	ASMAtomicWriteSize(&pReq->enmState, VMREQSTATE_INVALID);
2425	RTSemEventSignal(pReq->EventSem);
2426	RTThreadSleep(2);
2427	RTSemEventDestroy(pReq->EventSem);
2428	}
2429	/* give them a chance to respond before we free the request memory. */
2430	RTThreadSleep(32);
2431	}
2432	}
2433
2434	/*
2435	* Make sure the VMMR0.r0 module and whatever else is unloaded.
2436	*/
2437	PDMR3TermUVM(pUVM);
2438
2439	/*
2440	* Terminate the support library if initialized.
2441	*/
2442	if (pUVM->vm.s.pSession)
2443	{
2444	int rc = SUPR3Term(false /fForced/);
2445	AssertRC(rc);
2446	pUVM->vm.s.pSession = NIL_RTR0PTR;
2447	}
2448
2449	/*
2450	* Destroy the MM heap and free the UVM structure.
2451	*/
2452	MMR3TermUVM(pUVM);
2453	STAMR3TermUVM(pUVM);
2454
2455	#ifdef LOG_ENABLED
2456	RTLogSetCustomPrefixCallback(NULL, NULL, NULL);
2457	#endif
2458	RTTlsFree(pUVM->vm.s.idxTLS);
2459
2460	ASMAtomicUoWriteU32(&pUVM->u32Magic, UINT32_MAX);
2461	RTMemPageFree(pUVM);
2462
2463	RTLogFlush(NULL);
2464	}
2465
2466
2467	/**
2468	* Enumerates the VMs in this process.
2469	*
2470	* @returns Pointer to the next VM.
2471	* @returns NULL when no more VMs.
2472	* @param pVMPrev The previous VM
2473	* Use NULL to start the enumeration.
2474	*/
2475	VMMR3DECL(PVM) VMR3EnumVMs(PVM pVMPrev)
2476	{
2477	/*
2478	* This is quick and dirty. It has issues with VM being
2479	* destroyed during the enumeration.
2480	*/
2481	PUVM pNext;
2482	if (pVMPrev)
2483	pNext = pVMPrev->pUVM->pNext;
2484	else
2485	pNext = g_pUVMsHead;
2486	return pNext ? pNext->pVM : NULL;
2487	}
2488
2489
2490	/**
2491	* Registers an at VM destruction callback.
2492	*
2493	* @returns VBox status code.
2494	* @param pfnAtDtor Pointer to callback.
2495	* @param pvUser User argument.
2496	*/
2497	VMMR3DECL(int) VMR3AtDtorRegister(PFNVMATDTOR pfnAtDtor, void *pvUser)
2498	{
2499	/*
2500	* Check if already registered.
2501	*/
2502	VM_ATDTOR_LOCK();
2503	PVMATDTOR pCur = g_pVMAtDtorHead;
2504	while (pCur)
2505	{
2506	if (pfnAtDtor == pCur->pfnAtDtor)
2507	{
2508	VM_ATDTOR_UNLOCK();
2509	AssertMsgFailed(("Already registered at destruction callback %p!\n", pfnAtDtor));
2510	return VERR_INVALID_PARAMETER;
2511	}
2512
2513	/* next */
2514	pCur = pCur->pNext;
2515	}
2516	VM_ATDTOR_UNLOCK();
2517
2518	/*
2519	* Allocate new entry.
2520	*/
2521	PVMATDTOR pVMAtDtor = (PVMATDTOR)RTMemAlloc(sizeof(*pVMAtDtor));
2522	if (!pVMAtDtor)
2523	return VERR_NO_MEMORY;
2524
2525	VM_ATDTOR_LOCK();
2526	pVMAtDtor->pfnAtDtor = pfnAtDtor;
2527	pVMAtDtor->pvUser = pvUser;
2528	pVMAtDtor->pNext = g_pVMAtDtorHead;
2529	g_pVMAtDtorHead = pVMAtDtor;
2530	VM_ATDTOR_UNLOCK();
2531
2532	return VINF_SUCCESS;
2533	}
2534
2535
2536	/**
2537	* Deregisters an at VM destruction callback.
2538	*
2539	* @returns VBox status code.
2540	* @param pfnAtDtor Pointer to callback.
2541	*/
2542	VMMR3DECL(int) VMR3AtDtorDeregister(PFNVMATDTOR pfnAtDtor)
2543	{
2544	/*
2545	* Find it, unlink it and free it.
2546	*/
2547	VM_ATDTOR_LOCK();
2548	PVMATDTOR pPrev = NULL;
2549	PVMATDTOR pCur = g_pVMAtDtorHead;
2550	while (pCur)
2551	{
2552	if (pfnAtDtor == pCur->pfnAtDtor)
2553	{
2554	if (pPrev)
2555	pPrev->pNext = pCur->pNext;
2556	else
2557	g_pVMAtDtorHead = pCur->pNext;
2558	pCur->pNext = NULL;
2559	VM_ATDTOR_UNLOCK();
2560
2561	RTMemFree(pCur);
2562	return VINF_SUCCESS;
2563	}
2564
2565	/* next */
2566	pPrev = pCur;
2567	pCur = pCur->pNext;
2568	}
2569	VM_ATDTOR_UNLOCK();
2570
2571	return VERR_INVALID_PARAMETER;
2572	}
2573
2574
2575	/**
2576	* Walks the list of at VM destructor callbacks.
2577	* @param pVM The VM which is about to be destroyed.
2578	*/
2579	static void vmR3AtDtor(PVM pVM)
2580	{
2581	/*
2582	* Find it, unlink it and free it.
2583	*/
2584	VM_ATDTOR_LOCK();
2585	for (PVMATDTOR pCur = g_pVMAtDtorHead; pCur; pCur = pCur->pNext)
2586	pCur->pfnAtDtor(pVM, pCur->pvUser);
2587	VM_ATDTOR_UNLOCK();
2588	}
2589
2590
2591	/**
2592	* Worker which checks integrity of some internal structures.
2593	* This is yet another attempt to track down that AVL tree crash.
2594	*/
2595	static void vmR3CheckIntegrity(PVM pVM)
2596	{
2597	#ifdef VBOX_STRICT
2598	int rc = PGMR3CheckIntegrity(pVM);
2599	AssertReleaseRC(rc);
2600	#endif
2601	}
2602
2603
2604	/**
2605	* EMT rendezvous worker for VMR3Reset.
2606	*
2607	* This is called by the emulation threads as a response to the reset request
2608	* issued by VMR3Reset().
2609	*
2610	* @returns VERR_VM_INVALID_VM_STATE, VINF_EM_RESET or VINF_EM_SUSPEND. (This
2611	* is a strict return code, see FNVMMEMTRENDEZVOUS.)
2612	*
2613	* @param pVM The VM handle.
2614	* @param pVCpu The VMCPU handle of the EMT.
2615	* @param pvUser Ignored.
2616	*/
2617	static DECLCALLBACK(VBOXSTRICTRC) vmR3Reset(PVM pVM, PVMCPU pVCpu, void *pvUser)
2618	{
2619	Assert(!pvUser); NOREF(pvUser);
2620
2621	/*
2622	* The first EMT will try change the state to resetting. If this fails,
2623	* we won't get called for the other EMTs.
2624	*/
2625	if (pVCpu->idCpu == pVM->cCpus - 1)
2626	{
2627	int rc = vmR3TrySetState(pVM, "VMR3Reset", 3,
2628	VMSTATE_RESETTING, VMSTATE_RUNNING,
2629	VMSTATE_RESETTING, VMSTATE_SUSPENDED,
2630	VMSTATE_RESETTING_LS, VMSTATE_RUNNING_LS);
2631	if (RT_FAILURE(rc))
2632	return rc;
2633	}
2634
2635	/*
2636	* Check the state.
2637	*/
2638	VMSTATE enmVMState = VMR3GetState(pVM);
2639	AssertLogRelMsgReturn( enmVMState == VMSTATE_RESETTING
2640	\|\| enmVMState == VMSTATE_RESETTING_LS,
2641	("%s\n", VMR3GetStateName(enmVMState)),
2642	VERR_INTERNAL_ERROR_4);
2643
2644	/*
2645	* EMT(0) does the full cleanup after all the other EMTs has been
2646	* thru here and been told to enter the EMSTATE_WAIT_SIPI state.
2647	*
2648	* Because there are per-cpu reset routines and order may/is important,
2649	* the following sequence looks a bit ugly...
2650	*/
2651	if (pVCpu->idCpu == 0)
2652	vmR3CheckIntegrity(pVM);
2653
2654	/* Reset the VCpu state. */
2655	VMCPU_ASSERT_STATE(pVCpu, VMCPUSTATE_STARTED);
2656
2657	/* Clear all pending forced actions. */
2658	VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_ALL_MASK & ~VMCPU_FF_REQUEST);
2659
2660	/*
2661	* Reset the VM components.
2662	*/
2663	if (pVCpu->idCpu == 0)
2664	{
2665	PATMR3Reset(pVM);
2666	CSAMR3Reset(pVM);
2667	PGMR3Reset(pVM); /* We clear VM RAM in PGMR3Reset. It's vital PDMR3Reset is executed
2668	* _afterwards_. E.g. ACPI sets up RAM tables during init/reset. */
2669	MMR3Reset(pVM);
2670	PDMR3Reset(pVM);
2671	SELMR3Reset(pVM);
2672	TRPMR3Reset(pVM);
2673	REMR3Reset(pVM);
2674	IOMR3Reset(pVM);
2675	CPUMR3Reset(pVM);
2676	}
2677	CPUMR3ResetCpu(pVCpu);
2678	if (pVCpu->idCpu == 0)
2679	{
2680	TMR3Reset(pVM);
2681	EMR3Reset(pVM);
2682	HWACCMR3Reset(pVM); /* This must come after PATM, CSAM, CPUM, SELM and TRPM. */
2683
2684	#ifdef LOG_ENABLED
2685	/*
2686	* Debug logging.
2687	*/
2688	RTLogPrintf("\n\nThe VM was reset:\n");
2689	DBGFR3Info(pVM, "cpum", "verbose", NULL);
2690	#endif
2691
2692	/*
2693	* Since EMT(0) is the last to go thru here, it will advance the state.
2694	* When a live save is active, we will move on to SuspendingLS but
2695	* leave it for VMR3Reset to do the actual suspending due to deadlock risks.
2696	*/
2697	PUVM pUVM = pVM->pUVM;
2698	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
2699	enmVMState = pVM->enmVMState;
2700	if (enmVMState == VMSTATE_RESETTING)
2701	{
2702	if (pUVM->vm.s.enmPrevVMState == VMSTATE_SUSPENDED)
2703	vmR3SetStateLocked(pVM, pUVM, VMSTATE_SUSPENDED, VMSTATE_RESETTING);
2704	else
2705	vmR3SetStateLocked(pVM, pUVM, VMSTATE_RUNNING, VMSTATE_RESETTING);
2706	}
2707	else
2708	vmR3SetStateLocked(pVM, pUVM, VMSTATE_SUSPENDING_LS, VMSTATE_RESETTING_LS);
2709	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
2710
2711	vmR3CheckIntegrity(pVM);
2712
2713	/*
2714	* Do the suspend bit as well.
2715	* It only requires some EMT(0) work at present.
2716	*/
2717	if (enmVMState != VMSTATE_RESETTING)
2718	{
2719	vmR3SuspendDoWork(pVM);
2720	vmR3SetState(pVM, VMSTATE_SUSPENDED_LS, VMSTATE_SUSPENDING_LS);
2721	}
2722	}
2723
2724	return enmVMState == VMSTATE_RESETTING
2725	? VINF_EM_RESET
2726	: 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. */
2727	}
2728
2729
2730	/**
2731	* Reset the current VM.
2732	*
2733	* @returns VBox status code.
2734	* @param pVM VM to reset.
2735	*/
2736	VMMR3DECL(int) VMR3Reset(PVM pVM)
2737	{
2738	LogFlow(("VMR3Reset:\n"));
2739	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2740
2741	/*
2742	* Gather all the EMTs to make sure there are no races before
2743	* changing the VM state.
2744	*/
2745	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING \| VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR,
2746	vmR3Reset, NULL);
2747	LogFlow(("VMR3Reset: returns %Rrc\n", rc));
2748	return rc;
2749	}
2750
2751
2752	/**
2753	* Gets the current VM state.
2754	*
2755	* @returns The current VM state.
2756	* @param pVM VM handle.
2757	* @thread Any
2758	*/
2759	VMMR3DECL(VMSTATE) VMR3GetState(PVM pVM)
2760	{
2761	return pVM->enmVMState;
2762	}
2763
2764
2765	/**
2766	* Gets the state name string for a VM state.
2767	*
2768	* @returns Pointer to the state name. (readonly)
2769	* @param enmState The state.
2770	*/
2771	VMMR3DECL(const char *) VMR3GetStateName(VMSTATE enmState)
2772	{
2773	switch (enmState)
2774	{
2775	case VMSTATE_CREATING: return "CREATING";
2776	case VMSTATE_CREATED: return "CREATED";
2777	case VMSTATE_LOADING: return "LOADING";
2778	case VMSTATE_POWERING_ON: return "POWERING_ON";
2779	case VMSTATE_RESUMING: return "RESUMING";
2780	case VMSTATE_RUNNING: return "RUNNING";
2781	case VMSTATE_RUNNING_LS: return "RUNNING_LS";
2782	case VMSTATE_RESETTING: return "RESETTING";
2783	case VMSTATE_RESETTING_LS: return "RESETTING_LS";
2784	case VMSTATE_SUSPENDED: return "SUSPENDED";
2785	case VMSTATE_SUSPENDED_LS: return "SUSPENDED_LS";
2786	case VMSTATE_SUSPENDED_EXT_LS: return "SUSPENDED_EXT_LS";
2787	case VMSTATE_SUSPENDING: return "SUSPENDING";
2788	case VMSTATE_SUSPENDING_LS: return "SUSPENDING_LS";
2789	case VMSTATE_SUSPENDING_EXT_LS: return "SUSPENDING_EXT_LS";
2790	case VMSTATE_SAVING: return "SAVING";
2791	case VMSTATE_DEBUGGING: return "DEBUGGING";
2792	case VMSTATE_DEBUGGING_LS: return "DEBUGGING_LS";
2793	case VMSTATE_POWERING_OFF: return "POWERING_OFF";
2794	case VMSTATE_POWERING_OFF_LS: return "POWERING_OFF_LS";
2795	case VMSTATE_FATAL_ERROR: return "FATAL_ERROR";
2796	case VMSTATE_FATAL_ERROR_LS: return "FATAL_ERROR_LS";
2797	case VMSTATE_GURU_MEDITATION: return "GURU_MEDITATION";
2798	case VMSTATE_GURU_MEDITATION_LS:return "GURU_MEDITATION_LS";
2799	case VMSTATE_LOAD_FAILURE: return "LOAD_FAILURE";
2800	case VMSTATE_OFF: return "OFF";
2801	case VMSTATE_DESTROYING: return "DESTROYING";
2802	case VMSTATE_TERMINATED: return "TERMINATED";
2803
2804	default:
2805	AssertMsgFailed(("Unknown state %d\n", enmState));
2806	return "Unknown!\n";
2807	}
2808	}
2809
2810
2811	/**
2812	* Validates the state transition in strict builds.
2813	*
2814	* @returns true if valid, false if not.
2815	*
2816	* @param enmStateOld The old (current) state.
2817	* @param enmStateNew The proposed new state.
2818	*
2819	* @remarks The reference for this is found in doc/vp/VMM.vpp, the VMSTATE
2820	* diagram (under State Machine Diagram).
2821	*/
2822	static bool vmR3ValidateStateTransition(VMSTATE enmStateOld, VMSTATE enmStateNew)
2823	{
2824	#ifdef VBOX_STRICT
2825	switch (enmStateOld)
2826	{
2827	case VMSTATE_CREATING:
2828	AssertMsgReturn(enmStateNew == VMSTATE_CREATED, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2829	break;
2830
2831	case VMSTATE_CREATED:
2832	AssertMsgReturn( enmStateNew == VMSTATE_LOADING
2833	\|\| enmStateNew == VMSTATE_POWERING_ON
2834	\|\| enmStateNew == VMSTATE_POWERING_OFF
2835	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2836	break;
2837
2838	case VMSTATE_LOADING:
2839	AssertMsgReturn( enmStateNew == VMSTATE_SUSPENDED
2840	\|\| enmStateNew == VMSTATE_LOAD_FAILURE
2841	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2842	break;
2843
2844	case VMSTATE_POWERING_ON:
2845	AssertMsgReturn( enmStateNew == VMSTATE_RUNNING
2846	/\|\| enmStateNew == VMSTATE_FATAL_ERROR ?/
2847	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2848	break;
2849
2850	case VMSTATE_RESUMING:
2851	AssertMsgReturn( enmStateNew == VMSTATE_RUNNING
2852	/\|\| enmStateNew == VMSTATE_FATAL_ERROR ?/
2853	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2854	break;
2855
2856	case VMSTATE_RUNNING:
2857	AssertMsgReturn( enmStateNew == VMSTATE_POWERING_OFF
2858	\|\| enmStateNew == VMSTATE_SUSPENDING
2859	\|\| enmStateNew == VMSTATE_RESETTING
2860	\|\| enmStateNew == VMSTATE_RUNNING_LS
2861	\|\| enmStateNew == VMSTATE_DEBUGGING
2862	\|\| enmStateNew == VMSTATE_FATAL_ERROR
2863	\|\| enmStateNew == VMSTATE_GURU_MEDITATION
2864	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2865	break;
2866
2867	case VMSTATE_RUNNING_LS:
2868	AssertMsgReturn( enmStateNew == VMSTATE_POWERING_OFF_LS
2869	\|\| enmStateNew == VMSTATE_SUSPENDING_LS
2870	\|\| enmStateNew == VMSTATE_SUSPENDING_EXT_LS
2871	\|\| enmStateNew == VMSTATE_RESETTING_LS
2872	\|\| enmStateNew == VMSTATE_RUNNING
2873	\|\| enmStateNew == VMSTATE_DEBUGGING_LS
2874	\|\| enmStateNew == VMSTATE_FATAL_ERROR_LS
2875	\|\| enmStateNew == VMSTATE_GURU_MEDITATION_LS
2876	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2877	break;
2878
2879	case VMSTATE_RESETTING:
2880	AssertMsgReturn(enmStateNew == VMSTATE_RUNNING, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2881	break;
2882
2883	case VMSTATE_RESETTING_LS:
2884	AssertMsgReturn( enmStateNew == VMSTATE_SUSPENDING_LS
2885	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2886	break;
2887
2888	case VMSTATE_SUSPENDING:
2889	AssertMsgReturn(enmStateNew == VMSTATE_SUSPENDED, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2890	break;
2891
2892	case VMSTATE_SUSPENDING_LS:
2893	AssertMsgReturn( enmStateNew == VMSTATE_SUSPENDING
2894	\|\| enmStateNew == VMSTATE_SUSPENDED_LS
2895	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2896	break;
2897
2898	case VMSTATE_SUSPENDING_EXT_LS:
2899	AssertMsgReturn( enmStateNew == VMSTATE_SUSPENDING
2900	\|\| enmStateNew == VMSTATE_SUSPENDED_EXT_LS
2901	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2902	break;
2903
2904	case VMSTATE_SUSPENDED:
2905	AssertMsgReturn( enmStateNew == VMSTATE_POWERING_OFF
2906	\|\| enmStateNew == VMSTATE_SAVING
2907	\|\| enmStateNew == VMSTATE_RESETTING
2908	\|\| enmStateNew == VMSTATE_RESUMING
2909	\|\| enmStateNew == VMSTATE_LOADING
2910	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2911	break;
2912
2913	case VMSTATE_SUSPENDED_LS:
2914	AssertMsgReturn( enmStateNew == VMSTATE_SUSPENDED
2915	\|\| enmStateNew == VMSTATE_SAVING
2916	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2917	break;
2918
2919	case VMSTATE_SUSPENDED_EXT_LS:
2920	AssertMsgReturn( enmStateNew == VMSTATE_SUSPENDED
2921	\|\| enmStateNew == VMSTATE_SAVING
2922	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2923	break;
2924
2925	case VMSTATE_SAVING:
2926	AssertMsgReturn(enmStateNew == VMSTATE_SUSPENDED, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2927	break;
2928
2929	case VMSTATE_DEBUGGING:
2930	AssertMsgReturn( enmStateNew == VMSTATE_RUNNING
2931	\|\| enmStateNew == VMSTATE_POWERING_OFF
2932	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2933	break;
2934
2935	case VMSTATE_DEBUGGING_LS:
2936	AssertMsgReturn( enmStateNew == VMSTATE_DEBUGGING
2937	\|\| enmStateNew == VMSTATE_RUNNING_LS
2938	\|\| enmStateNew == VMSTATE_POWERING_OFF_LS
2939	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2940	break;
2941
2942	case VMSTATE_POWERING_OFF:
2943	AssertMsgReturn(enmStateNew == VMSTATE_OFF, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2944	break;
2945
2946	case VMSTATE_POWERING_OFF_LS:
2947	AssertMsgReturn( enmStateNew == VMSTATE_POWERING_OFF
2948	\|\| enmStateNew == VMSTATE_OFF_LS
2949	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2950	break;
2951
2952	case VMSTATE_OFF:
2953	AssertMsgReturn(enmStateNew == VMSTATE_DESTROYING, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2954	break;
2955
2956	case VMSTATE_OFF_LS:
2957	AssertMsgReturn(enmStateNew == VMSTATE_OFF, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2958	break;
2959
2960	case VMSTATE_FATAL_ERROR:
2961	AssertMsgReturn(enmStateNew == VMSTATE_POWERING_OFF, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2962	break;
2963
2964	case VMSTATE_FATAL_ERROR_LS:
2965	AssertMsgReturn( enmStateNew == VMSTATE_FATAL_ERROR
2966	\|\| enmStateNew == VMSTATE_POWERING_OFF_LS
2967	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2968	break;
2969
2970	case VMSTATE_GURU_MEDITATION:
2971	AssertMsgReturn( enmStateNew == VMSTATE_DEBUGGING
2972	\|\| enmStateNew == VMSTATE_POWERING_OFF
2973	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2974	break;
2975
2976	case VMSTATE_GURU_MEDITATION_LS:
2977	AssertMsgReturn( enmStateNew == VMSTATE_GURU_MEDITATION
2978	\|\| enmStateNew == VMSTATE_DEBUGGING_LS
2979	\|\| enmStateNew == VMSTATE_POWERING_OFF_LS
2980	, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2981	break;
2982
2983	case VMSTATE_LOAD_FAILURE:
2984	AssertMsgReturn(enmStateNew == VMSTATE_POWERING_OFF, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2985	break;
2986
2987	case VMSTATE_DESTROYING:
2988	AssertMsgReturn(enmStateNew == VMSTATE_TERMINATED, ("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2989	break;
2990
2991	case VMSTATE_TERMINATED:
2992	default:
2993	AssertMsgFailedReturn(("%s -> %s\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)), false);
2994	break;
2995	}
2996	#endif /* VBOX_STRICT */
2997	return true;
2998	}
2999
3000
3001	/**
3002	* Does the state change callouts.
3003	*
3004	* The caller owns the AtStateCritSect.
3005	*
3006	* @param pVM The VM handle.
3007	* @param pUVM The UVM handle.
3008	* @param enmStateNew The New state.
3009	* @param enmStateOld The old state.
3010	*/
3011	static void vmR3DoAtState(PVM pVM, PUVM pUVM, VMSTATE enmStateNew, VMSTATE enmStateOld)
3012	{
3013	LogRel(("Changing the VM state from '%s' to '%s'.\n", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)));
3014
3015	for (PVMATSTATE pCur = pUVM->vm.s.pAtState; pCur; pCur = pCur->pNext)
3016	{
3017	pCur->pfnAtState(pVM, enmStateNew, enmStateOld, pCur->pvUser);
3018	if ( enmStateNew != VMSTATE_DESTROYING
3019	&& pVM->enmVMState == VMSTATE_DESTROYING)
3020	break;
3021	AssertMsg(pVM->enmVMState == enmStateNew,
3022	("You are not allowed to change the state while in the change callback, except "
3023	"from destroying the VM. There are restrictions in the way the state changes "
3024	"are propagated up to the EM execution loop and it makes the program flow very "
3025	"difficult to follow. (%s, expected %s, old %s)\n",
3026	VMR3GetStateName(pVM->enmVMState), VMR3GetStateName(enmStateNew),
3027	VMR3GetStateName(enmStateOld)));
3028	}
3029	}
3030
3031
3032	/**
3033	* Sets the current VM state, with the AtStatCritSect already entered.
3034	*
3035	* @param pVM The VM handle.
3036	* @param pUVM The UVM handle.
3037	* @param enmStateNew The new state.
3038	* @param enmStateOld The old state.
3039	*/
3040	static void vmR3SetStateLocked(PVM pVM, PUVM pUVM, VMSTATE enmStateNew, VMSTATE enmStateOld)
3041	{
3042	vmR3ValidateStateTransition(enmStateOld, enmStateNew);
3043
3044	AssertMsg(pVM->enmVMState == enmStateOld,
3045	("%s != %s\n", VMR3GetStateName(pVM->enmVMState), VMR3GetStateName(enmStateOld)));
3046	pUVM->vm.s.enmPrevVMState = enmStateOld;
3047	pVM->enmVMState = enmStateNew;
3048
3049	vmR3DoAtState(pVM, pUVM, enmStateNew, enmStateOld);
3050	}
3051
3052
3053	/**
3054	* Sets the current VM state.
3055	*
3056	* @param pVM VM handle.
3057	* @param enmStateNew The new state.
3058	* @param enmStateOld The old state (for asserting only).
3059	*/
3060	static void vmR3SetState(PVM pVM, VMSTATE enmStateNew, VMSTATE enmStateOld)
3061	{
3062	PUVM pUVM = pVM->pUVM;
3063	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
3064
3065	AssertMsg(pVM->enmVMState == enmStateOld,
3066	("%s != %s\n", VMR3GetStateName(pVM->enmVMState), VMR3GetStateName(enmStateOld)));
3067	vmR3SetStateLocked(pVM, pUVM, enmStateNew, pVM->enmVMState);
3068
3069	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
3070	}
3071
3072
3073	/**
3074	* Tries to perform a state transition.
3075	*
3076	* @returns The 1-based ordinal of the succeeding transition.
3077	* VERR_VM_INVALID_VM_STATE and Assert+LogRel on failure.
3078	*
3079	* @param pVM The VM handle.
3080	* @param pszWho Who is trying to change it.
3081	* @param cTransitions The number of transitions in the ellipsis.
3082	* @param ... Transition pairs; new, old.
3083	*/
3084	static int vmR3TrySetState(PVM pVM, const char *pszWho, unsigned cTransitions, ...)
3085	{
3086	va_list va;
3087	VMSTATE enmStateNew = VMSTATE_CREATED;
3088	VMSTATE enmStateOld = VMSTATE_CREATED;
3089
3090	#ifdef VBOX_STRICT
3091	/*
3092	* Validate the input first.
3093	*/
3094	va_start(va, cTransitions);
3095	for (unsigned i = 0; i < cTransitions; i++)
3096	{
3097	enmStateNew = (VMSTATE)va_arg(va, /VMSTATE/int);
3098	enmStateOld = (VMSTATE)va_arg(va, /VMSTATE/int);
3099	vmR3ValidateStateTransition(enmStateOld, enmStateNew);
3100	}
3101	va_end(va);
3102	#endif
3103
3104	/*
3105	* Grab the lock and see if any of the proposed transisions works out.
3106	*/
3107	va_start(va, cTransitions);
3108	int rc = VERR_VM_INVALID_VM_STATE;
3109	PUVM pUVM = pVM->pUVM;
3110	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
3111
3112	VMSTATE enmStateCur = pVM->enmVMState;
3113
3114	for (unsigned i = 0; i < cTransitions; i++)
3115	{
3116	enmStateNew = (VMSTATE)va_arg(va, /VMSTATE/int);
3117	enmStateOld = (VMSTATE)va_arg(va, /VMSTATE/int);
3118	if (enmStateCur == enmStateOld)
3119	{
3120	vmR3SetStateLocked(pVM, pUVM, enmStateNew, enmStateOld);
3121	rc = i + 1;
3122	break;
3123	}
3124	}
3125
3126	if (RT_FAILURE(rc))
3127	{
3128	/*
3129	* Complain about it.
3130	*/
3131	if (cTransitions == 1)
3132	LogRel(("%s: %s -> %s failed, because the VM state is actually %s\n",
3133	pszWho, VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew), VMR3GetStateName(enmStateCur)));
3134	else
3135	{
3136	va_end(va);
3137	va_start(va, cTransitions);
3138	LogRel(("%s:\n", pszWho));
3139	for (unsigned i = 0; i < cTransitions; i++)
3140	{
3141	enmStateNew = (VMSTATE)va_arg(va, /VMSTATE/int);
3142	enmStateOld = (VMSTATE)va_arg(va, /VMSTATE/int);
3143	LogRel(("%s%s -> %s",
3144	i ? ", " : " ", VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew)));
3145	}
3146	LogRel((" failed, because the VM state is actually %s\n", VMR3GetStateName(enmStateCur)));
3147	}
3148
3149	VMSetError(pVM, VERR_VM_INVALID_VM_STATE, RT_SRC_POS,
3150	N_("%s failed because the VM state is %s instead of %s"),
3151	VMR3GetStateName(enmStateCur), VMR3GetStateName(enmStateOld));
3152	AssertMsgFailed(("%s: %s -> %s failed, state is actually %s\n",
3153	pszWho, VMR3GetStateName(enmStateOld), VMR3GetStateName(enmStateNew), VMR3GetStateName(enmStateCur)));
3154	}
3155
3156	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
3157	va_end(va);
3158	Assert(rc > 0 \|\| rc < 0);
3159	return rc;
3160	}
3161
3162
3163	/**
3164	* Flag a guru meditation ... a hack.
3165	*
3166	* @param pVM The VM handle
3167	*
3168	* @todo Rewrite this part. The guru meditation should be flagged
3169	* immediately by the VMM and not by VMEmt.cpp when it's all over.
3170	*/
3171	void vmR3SetGuruMeditation(PVM pVM)
3172	{
3173	PUVM pUVM = pVM->pUVM;
3174	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
3175
3176	VMSTATE enmStateCur = pVM->enmVMState;
3177	if (enmStateCur == VMSTATE_RUNNING)
3178	vmR3SetStateLocked(pVM, pUVM, VMSTATE_GURU_MEDITATION, VMSTATE_RUNNING);
3179	else if (enmStateCur == VMSTATE_RUNNING_LS)
3180	{
3181	vmR3SetStateLocked(pVM, pUVM, VMSTATE_GURU_MEDITATION_LS, VMSTATE_RUNNING_LS);
3182	SSMR3Cancel(pVM);
3183	}
3184
3185	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
3186	}
3187
3188
3189	/**
3190	* Checks if the VM was teleported and hasn't been fully resumed yet.
3191	*
3192	* This applies to both sides of the teleportation since we may leave a working
3193	* clone behind and the user is allowed to resume this...
3194	*
3195	* @returns true / false.
3196	* @param pVM The VM handle.
3197	* @thread Any thread.
3198	*/
3199	VMMR3DECL(bool) VMR3TeleportedAndNotFullyResumedYet(PVM pVM)
3200	{
3201	VM_ASSERT_VALID_EXT_RETURN(pVM, false);
3202	return pVM->vm.s.fTeleportedAndNotFullyResumedYet;
3203	}
3204
3205
3206	/**
3207	* Registers a VM state change callback.
3208	*
3209	* You are not allowed to call any function which changes the VM state from a
3210	* state callback, except VMR3Destroy().
3211	*
3212	* @returns VBox status code.
3213	* @param pVM VM handle.
3214	* @param pfnAtState Pointer to callback.
3215	* @param pvUser User argument.
3216	* @thread Any.
3217	*/
3218	VMMR3DECL(int) VMR3AtStateRegister(PVM pVM, PFNVMATSTATE pfnAtState, void *pvUser)
3219	{
3220	LogFlow(("VMR3AtStateRegister: pfnAtState=%p pvUser=%p\n", pfnAtState, pvUser));
3221
3222	/*
3223	* Validate input.
3224	*/
3225	AssertPtrReturn(pfnAtState, VERR_INVALID_PARAMETER);
3226	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3227
3228	/*
3229	* Allocate a new record.
3230	*/
3231	PUVM pUVM = pVM->pUVM;
3232	PVMATSTATE pNew = (PVMATSTATE)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
3233	if (!pNew)
3234	return VERR_NO_MEMORY;
3235
3236	/* fill */
3237	pNew->pfnAtState = pfnAtState;
3238	pNew->pvUser = pvUser;
3239
3240	/* insert */
3241	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
3242	pNew->pNext = *pUVM->vm.s.ppAtStateNext;
3243	*pUVM->vm.s.ppAtStateNext = pNew;
3244	pUVM->vm.s.ppAtStateNext = &pNew->pNext;
3245	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
3246
3247	return VINF_SUCCESS;
3248	}
3249
3250
3251	/**
3252	* Deregisters a VM state change callback.
3253	*
3254	* @returns VBox status code.
3255	* @param pVM VM handle.
3256	* @param pfnAtState Pointer to callback.
3257	* @param pvUser User argument.
3258	* @thread Any.
3259	*/
3260	VMMR3DECL(int) VMR3AtStateDeregister(PVM pVM, PFNVMATSTATE pfnAtState, void *pvUser)
3261	{
3262	LogFlow(("VMR3AtStateDeregister: pfnAtState=%p pvUser=%p\n", pfnAtState, pvUser));
3263
3264	/*
3265	* Validate input.
3266	*/
3267	AssertPtrReturn(pfnAtState, VERR_INVALID_PARAMETER);
3268	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3269
3270	PUVM pUVM = pVM->pUVM;
3271	RTCritSectEnter(&pUVM->vm.s.AtStateCritSect);
3272
3273	/*
3274	* Search the list for the entry.
3275	*/
3276	PVMATSTATE pPrev = NULL;
3277	PVMATSTATE pCur = pUVM->vm.s.pAtState;
3278	while ( pCur
3279	&& ( pCur->pfnAtState != pfnAtState
3280	\|\| pCur->pvUser != pvUser))
3281	{
3282	pPrev = pCur;
3283	pCur = pCur->pNext;
3284	}
3285	if (!pCur)
3286	{
3287	AssertMsgFailed(("pfnAtState=%p was not found\n", pfnAtState));
3288	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
3289	return VERR_FILE_NOT_FOUND;
3290	}
3291
3292	/*
3293	* Unlink it.
3294	*/
3295	if (pPrev)
3296	{
3297	pPrev->pNext = pCur->pNext;
3298	if (!pCur->pNext)
3299	pUVM->vm.s.ppAtStateNext = &pPrev->pNext;
3300	}
3301	else
3302	{
3303	pUVM->vm.s.pAtState = pCur->pNext;
3304	if (!pCur->pNext)
3305	pUVM->vm.s.ppAtStateNext = &pUVM->vm.s.pAtState;
3306	}
3307
3308	RTCritSectLeave(&pUVM->vm.s.AtStateCritSect);
3309
3310	/*
3311	* Free it.
3312	*/
3313	pCur->pfnAtState = NULL;
3314	pCur->pNext = NULL;
3315	MMR3HeapFree(pCur);
3316
3317	return VINF_SUCCESS;
3318	}
3319
3320
3321	/**
3322	* Registers a VM error callback.
3323	*
3324	* @returns VBox status code.
3325	* @param pVM The VM handle.
3326	* @param pfnAtError Pointer to callback.
3327	* @param pvUser User argument.
3328	* @thread Any.
3329	*/
3330	VMMR3DECL(int) VMR3AtErrorRegister(PVM pVM, PFNVMATERROR pfnAtError, void *pvUser)
3331	{
3332	return VMR3AtErrorRegisterU(pVM->pUVM, pfnAtError, pvUser);
3333	}
3334
3335
3336	/**
3337	* Registers a VM error callback.
3338	*
3339	* @returns VBox status code.
3340	* @param pUVM The VM handle.
3341	* @param pfnAtError Pointer to callback.
3342	* @param pvUser User argument.
3343	* @thread Any.
3344	*/
3345	VMMR3DECL(int) VMR3AtErrorRegisterU(PUVM pUVM, PFNVMATERROR pfnAtError, void *pvUser)
3346	{
3347	LogFlow(("VMR3AtErrorRegister: pfnAtError=%p pvUser=%p\n", pfnAtError, pvUser));
3348
3349	/*
3350	* Validate input.
3351	*/
3352	AssertPtrReturn(pfnAtError, VERR_INVALID_PARAMETER);
3353	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
3354
3355	/*
3356	* Allocate a new record.
3357	*/
3358	PVMATERROR pNew = (PVMATERROR)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
3359	if (!pNew)
3360	return VERR_NO_MEMORY;
3361
3362	/* fill */
3363	pNew->pfnAtError = pfnAtError;
3364	pNew->pvUser = pvUser;
3365
3366	/* insert */
3367	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3368	pNew->pNext = *pUVM->vm.s.ppAtErrorNext;
3369	*pUVM->vm.s.ppAtErrorNext = pNew;
3370	pUVM->vm.s.ppAtErrorNext = &pNew->pNext;
3371	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3372
3373	return VINF_SUCCESS;
3374	}
3375
3376
3377	/**
3378	* Deregisters a VM error callback.
3379	*
3380	* @returns VBox status code.
3381	* @param pVM The VM handle.
3382	* @param pfnAtError Pointer to callback.
3383	* @param pvUser User argument.
3384	* @thread Any.
3385	*/
3386	VMMR3DECL(int) VMR3AtErrorDeregister(PVM pVM, PFNVMATERROR pfnAtError, void *pvUser)
3387	{
3388	LogFlow(("VMR3AtErrorDeregister: pfnAtError=%p pvUser=%p\n", pfnAtError, pvUser));
3389
3390	/*
3391	* Validate input.
3392	*/
3393	AssertPtrReturn(pfnAtError, VERR_INVALID_PARAMETER);
3394	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3395
3396	PUVM pUVM = pVM->pUVM;
3397	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3398
3399	/*
3400	* Search the list for the entry.
3401	*/
3402	PVMATERROR pPrev = NULL;
3403	PVMATERROR pCur = pUVM->vm.s.pAtError;
3404	while ( pCur
3405	&& ( pCur->pfnAtError != pfnAtError
3406	\|\| pCur->pvUser != pvUser))
3407	{
3408	pPrev = pCur;
3409	pCur = pCur->pNext;
3410	}
3411	if (!pCur)
3412	{
3413	AssertMsgFailed(("pfnAtError=%p was not found\n", pfnAtError));
3414	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3415	return VERR_FILE_NOT_FOUND;
3416	}
3417
3418	/*
3419	* Unlink it.
3420	*/
3421	if (pPrev)
3422	{
3423	pPrev->pNext = pCur->pNext;
3424	if (!pCur->pNext)
3425	pUVM->vm.s.ppAtErrorNext = &pPrev->pNext;
3426	}
3427	else
3428	{
3429	pUVM->vm.s.pAtError = pCur->pNext;
3430	if (!pCur->pNext)
3431	pUVM->vm.s.ppAtErrorNext = &pUVM->vm.s.pAtError;
3432	}
3433
3434	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3435
3436	/*
3437	* Free it.
3438	*/
3439	pCur->pfnAtError = NULL;
3440	pCur->pNext = NULL;
3441	MMR3HeapFree(pCur);
3442
3443	return VINF_SUCCESS;
3444	}
3445
3446
3447	/**
3448	* Ellipsis to va_list wrapper for calling pfnAtError.
3449	*/
3450	static void vmR3SetErrorWorkerDoCall(PVM pVM, PVMATERROR pCur, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
3451	{
3452	va_list va;
3453	va_start(va, pszFormat);
3454	pCur->pfnAtError(pVM, pCur->pvUser, rc, RT_SRC_POS_ARGS, pszFormat, va);
3455	va_end(va);
3456	}
3457
3458
3459	/**
3460	* This is a worker function for GC and Ring-0 calls to VMSetError and VMSetErrorV.
3461	* The message is found in VMINT.
3462	*
3463	* @param pVM The VM handle.
3464	* @thread EMT.
3465	*/
3466	VMMR3DECL(void) VMR3SetErrorWorker(PVM pVM)
3467	{
3468	VM_ASSERT_EMT(pVM);
3469	AssertReleaseMsgFailed(("And we have a winner! You get to implement Ring-0 and GC VMSetErrorV! Contrats!\n"));
3470
3471	/*
3472	* Unpack the error (if we managed to format one).
3473	*/
3474	PVMERROR pErr = pVM->vm.s.pErrorR3;
3475	const char *pszFile = NULL;
3476	const char *pszFunction = NULL;
3477	uint32_t iLine = 0;
3478	const char *pszMessage;
3479	int32_t rc = VERR_MM_HYPER_NO_MEMORY;
3480	if (pErr)
3481	{
3482	AssertCompile(sizeof(const char) == sizeof(uint8_t));
3483	if (pErr->offFile)
3484	pszFile = (const char *)pErr + pErr->offFile;
3485	iLine = pErr->iLine;
3486	if (pErr->offFunction)
3487	pszFunction = (const char *)pErr + pErr->offFunction;
3488	if (pErr->offMessage)
3489	pszMessage = (const char *)pErr + pErr->offMessage;
3490	else
3491	pszMessage = "No message!";
3492	}
3493	else
3494	pszMessage = "No message! (Failed to allocate memory to put the error message in!)";
3495
3496	/*
3497	* Call the at error callbacks.
3498	*/
3499	PUVM pUVM = pVM->pUVM;
3500	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3501	for (PVMATERROR pCur = pUVM->vm.s.pAtError; pCur; pCur = pCur->pNext)
3502	vmR3SetErrorWorkerDoCall(pVM, pCur, rc, RT_SRC_POS_ARGS, "%s", pszMessage);
3503	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3504	}
3505
3506
3507	/**
3508	* Creation time wrapper for vmR3SetErrorUV.
3509	*
3510	* @returns rc.
3511	* @param pUVM Pointer to the user mode VM structure.
3512	* @param rc The VBox status code.
3513	* @param RT_SRC_POS_DECL The source position of this error.
3514	* @param pszFormat Format string.
3515	* @param ... The arguments.
3516	* @thread Any thread.
3517	*/
3518	static int vmR3SetErrorU(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
3519	{
3520	va_list va;
3521	va_start(va, pszFormat);
3522	vmR3SetErrorUV(pUVM, rc, pszFile, iLine, pszFunction, pszFormat, &va);
3523	va_end(va);
3524	return rc;
3525	}
3526
3527
3528	/**
3529	* Worker which calls everyone listening to the VM error messages.
3530	*
3531	* @param pUVM Pointer to the user mode VM structure.
3532	* @param rc The VBox status code.
3533	* @param RT_SRC_POS_DECL The source position of this error.
3534	* @param pszFormat Format string.
3535	* @param pArgs Pointer to the format arguments.
3536	* @thread EMT
3537	*/
3538	DECLCALLBACK(void) vmR3SetErrorUV(PUVM pUVM, int rc, RT_SRC_POS_DECL, const char pszFormat, va_list pArgs)
3539	{
3540	#ifdef LOG_ENABLED
3541	/*
3542	* Log the error.
3543	*/
3544	RTLogPrintf("VMSetError: %s(%d) %s\n", pszFile, iLine, pszFunction);
3545	va_list va3;
3546	va_copy(va3, *pArgs);
3547	RTLogPrintfV(pszFormat, va3);
3548	va_end(va3);
3549	RTLogPrintf("\n");
3550	#endif
3551
3552	/*
3553	* Make a copy of the message.
3554	*/
3555	if (pUVM->pVM)
3556	vmSetErrorCopy(pUVM->pVM, rc, RT_SRC_POS_ARGS, pszFormat, *pArgs);
3557
3558	/*
3559	* Call the at error callbacks.
3560	*/
3561	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3562	for (PVMATERROR pCur = pUVM->vm.s.pAtError; pCur; pCur = pCur->pNext)
3563	{
3564	va_list va2;
3565	va_copy(va2, *pArgs);
3566	pCur->pfnAtError(pUVM->pVM, pCur->pvUser, rc, RT_SRC_POS_ARGS, pszFormat, va2);
3567	va_end(va2);
3568	}
3569	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3570	}
3571
3572
3573	/**
3574	* Registers a VM runtime error callback.
3575	*
3576	* @returns VBox status code.
3577	* @param pVM The VM handle.
3578	* @param pfnAtRuntimeError Pointer to callback.
3579	* @param pvUser User argument.
3580	* @thread Any.
3581	*/
3582	VMMR3DECL(int) VMR3AtRuntimeErrorRegister(PVM pVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser)
3583	{
3584	LogFlow(("VMR3AtRuntimeErrorRegister: pfnAtRuntimeError=%p pvUser=%p\n", pfnAtRuntimeError, pvUser));
3585
3586	/*
3587	* Validate input.
3588	*/
3589	AssertPtrReturn(pfnAtRuntimeError, VERR_INVALID_PARAMETER);
3590	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3591
3592	/*
3593	* Allocate a new record.
3594	*/
3595	PUVM pUVM = pVM->pUVM;
3596	PVMATRUNTIMEERROR pNew = (PVMATRUNTIMEERROR)MMR3HeapAllocU(pUVM, MM_TAG_VM, sizeof(*pNew));
3597	if (!pNew)
3598	return VERR_NO_MEMORY;
3599
3600	/* fill */
3601	pNew->pfnAtRuntimeError = pfnAtRuntimeError;
3602	pNew->pvUser = pvUser;
3603
3604	/* insert */
3605	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3606	pNew->pNext = *pUVM->vm.s.ppAtRuntimeErrorNext;
3607	*pUVM->vm.s.ppAtRuntimeErrorNext = pNew;
3608	pUVM->vm.s.ppAtRuntimeErrorNext = &pNew->pNext;
3609	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3610
3611	return VINF_SUCCESS;
3612	}
3613
3614
3615	/**
3616	* Deregisters a VM runtime error callback.
3617	*
3618	* @returns VBox status code.
3619	* @param pVM The VM handle.
3620	* @param pfnAtRuntimeError Pointer to callback.
3621	* @param pvUser User argument.
3622	* @thread Any.
3623	*/
3624	VMMR3DECL(int) VMR3AtRuntimeErrorDeregister(PVM pVM, PFNVMATRUNTIMEERROR pfnAtRuntimeError, void *pvUser)
3625	{
3626	LogFlow(("VMR3AtRuntimeErrorDeregister: pfnAtRuntimeError=%p pvUser=%p\n", pfnAtRuntimeError, pvUser));
3627
3628	/*
3629	* Validate input.
3630	*/
3631	AssertPtrReturn(pfnAtRuntimeError, VERR_INVALID_PARAMETER);
3632	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3633
3634	PUVM pUVM = pVM->pUVM;
3635	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3636
3637	/*
3638	* Search the list for the entry.
3639	*/
3640	PVMATRUNTIMEERROR pPrev = NULL;
3641	PVMATRUNTIMEERROR pCur = pUVM->vm.s.pAtRuntimeError;
3642	while ( pCur
3643	&& ( pCur->pfnAtRuntimeError != pfnAtRuntimeError
3644	\|\| pCur->pvUser != pvUser))
3645	{
3646	pPrev = pCur;
3647	pCur = pCur->pNext;
3648	}
3649	if (!pCur)
3650	{
3651	AssertMsgFailed(("pfnAtRuntimeError=%p was not found\n", pfnAtRuntimeError));
3652	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3653	return VERR_FILE_NOT_FOUND;
3654	}
3655
3656	/*
3657	* Unlink it.
3658	*/
3659	if (pPrev)
3660	{
3661	pPrev->pNext = pCur->pNext;
3662	if (!pCur->pNext)
3663	pUVM->vm.s.ppAtRuntimeErrorNext = &pPrev->pNext;
3664	}
3665	else
3666	{
3667	pUVM->vm.s.pAtRuntimeError = pCur->pNext;
3668	if (!pCur->pNext)
3669	pUVM->vm.s.ppAtRuntimeErrorNext = &pUVM->vm.s.pAtRuntimeError;
3670	}
3671
3672	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3673
3674	/*
3675	* Free it.
3676	*/
3677	pCur->pfnAtRuntimeError = NULL;
3678	pCur->pNext = NULL;
3679	MMR3HeapFree(pCur);
3680
3681	return VINF_SUCCESS;
3682	}
3683
3684
3685	/**
3686	* EMT rendezvous worker that vmR3SetRuntimeErrorCommon uses to safely change
3687	* the state to FatalError(LS).
3688	*
3689	* @returns VERR_VM_INVALID_VM_STATE or VINF_SUCCESS. (This is a strict return
3690	* code, see FNVMMEMTRENDEZVOUS.)
3691	*
3692	* @param pVM The VM handle.
3693	* @param pVCpu The VMCPU handle of the EMT.
3694	* @param pvUser Ignored.
3695	*/
3696	static DECLCALLBACK(VBOXSTRICTRC) vmR3SetRuntimeErrorChangeState(PVM pVM, PVMCPU pVCpu, void *pvUser)
3697	{
3698	NOREF(pVCpu);
3699	Assert(!pvUser); NOREF(pvUser);
3700
3701	int rc = vmR3TrySetState(pVM, "VMSetRuntimeError", 2,
3702	VMSTATE_FATAL_ERROR, VMSTATE_RUNNING,
3703	VMSTATE_FATAL_ERROR_LS, VMSTATE_RUNNING_LS);
3704	if (rc == 2)
3705	SSMR3Cancel(pVM);
3706	return RT_SUCCESS(rc) ? VINF_SUCCESS : rc;
3707	}
3708
3709
3710	/**
3711	* Worker for VMR3SetRuntimeErrorWorker and vmR3SetRuntimeErrorV.
3712	*
3713	* This does the common parts after the error has been saved / retrieved.
3714	*
3715	* @returns VBox status code with modifications, see VMSetRuntimeErrorV.
3716	*
3717	* @param pVM The VM handle.
3718	* @param fFlags The error flags.
3719	* @param pszErrorId Error ID string.
3720	* @param pszFormat Format string.
3721	* @param pVa Pointer to the format arguments.
3722	*/
3723	static int vmR3SetRuntimeErrorCommon(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list *pVa)
3724	{
3725	LogRel(("VM: Raising runtime error '%s' (fFlags=%#x)\n", pszErrorId, fFlags));
3726
3727	/*
3728	* Take actions before the call.
3729	*/
3730	int rc;
3731	if (fFlags & VMSETRTERR_FLAGS_FATAL)
3732	rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, vmR3SetRuntimeErrorChangeState, NULL);
3733	else if (fFlags & VMSETRTERR_FLAGS_SUSPEND)
3734	rc = VMR3Suspend(pVM);
3735	else
3736	rc = VINF_SUCCESS;
3737
3738	/*
3739	* Do the callback round.
3740	*/
3741	PUVM pUVM = pVM->pUVM;
3742	RTCritSectEnter(&pUVM->vm.s.AtErrorCritSect);
3743	for (PVMATRUNTIMEERROR pCur = pUVM->vm.s.pAtRuntimeError; pCur; pCur = pCur->pNext)
3744	{
3745	va_list va;
3746	va_copy(va, *pVa);
3747	pCur->pfnAtRuntimeError(pVM, pCur->pvUser, fFlags, pszErrorId, pszFormat, va);
3748	va_end(va);
3749	}
3750	RTCritSectLeave(&pUVM->vm.s.AtErrorCritSect);
3751
3752	return rc;
3753	}
3754
3755
3756	/**
3757	* Ellipsis to va_list wrapper for calling vmR3SetRuntimeErrorCommon.
3758	*/
3759	static int vmR3SetRuntimeErrorCommonF(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
3760	{
3761	va_list va;
3762	va_start(va, pszFormat);
3763	int rc = vmR3SetRuntimeErrorCommon(pVM, fFlags, pszErrorId, pszFormat, &va);
3764	va_end(va);
3765	return rc;
3766	}
3767
3768
3769	/**
3770	* This is a worker function for RC and Ring-0 calls to VMSetError and
3771	* VMSetErrorV.
3772	*
3773	* The message is found in VMINT.
3774	*
3775	* @returns VBox status code, see VMSetRuntimeError.
3776	* @param pVM The VM handle.
3777	* @thread EMT.
3778	*/
3779	VMMR3DECL(int) VMR3SetRuntimeErrorWorker(PVM pVM)
3780	{
3781	VM_ASSERT_EMT(pVM);
3782	AssertReleaseMsgFailed(("And we have a winner! You get to implement Ring-0 and GC VMSetRuntimeErrorV! Congrats!\n"));
3783
3784	/*
3785	* Unpack the error (if we managed to format one).
3786	*/
3787	const char *pszErrorId = "SetRuntimeError";
3788	const char *pszMessage = "No message!";
3789	uint32_t fFlags = VMSETRTERR_FLAGS_FATAL;
3790	PVMRUNTIMEERROR pErr = pVM->vm.s.pRuntimeErrorR3;
3791	if (pErr)
3792	{
3793	AssertCompile(sizeof(const char) == sizeof(uint8_t));
3794	if (pErr->offErrorId)
3795	pszErrorId = (const char *)pErr + pErr->offErrorId;
3796	if (pErr->offMessage)
3797	pszMessage = (const char *)pErr + pErr->offMessage;
3798	fFlags = pErr->fFlags;
3799	}
3800
3801	/*
3802	* Join cause with vmR3SetRuntimeErrorV.
3803	*/
3804	return vmR3SetRuntimeErrorCommonF(pVM, fFlags, pszErrorId, "%s", pszMessage);
3805	}
3806
3807
3808	/**
3809	* Worker for VMSetRuntimeErrorV for doing the job on EMT in ring-3.
3810	*
3811	* @returns VBox status code with modifications, see VMSetRuntimeErrorV.
3812	*
3813	* @param pVM The VM handle.
3814	* @param fFlags The error flags.
3815	* @param pszErrorId Error ID string.
3816	* @param pszMessage The error message residing the MM heap.
3817	*
3818	* @thread EMT
3819	*/
3820	DECLCALLBACK(int) vmR3SetRuntimeError(PVM pVM, uint32_t fFlags, const char pszErrorId, char pszMessage)
3821	{
3822	#if 0 /** @todo make copy of the error msg. */
3823	/*
3824	* Make a copy of the message.
3825	*/
3826	va_list va2;
3827	va_copy(va2, *pVa);
3828	vmSetRuntimeErrorCopy(pVM, fFlags, pszErrorId, pszFormat, va2);
3829	va_end(va2);
3830	#endif
3831
3832	/*
3833	* Join paths with VMR3SetRuntimeErrorWorker.
3834	*/
3835	int rc = vmR3SetRuntimeErrorCommonF(pVM, fFlags, pszErrorId, "%s", pszMessage);
3836	MMR3HeapFree(pszMessage);
3837	return rc;
3838	}
3839
3840
3841	/**
3842	* Worker for VMSetRuntimeErrorV for doing the job on EMT in ring-3.
3843	*
3844	* @returns VBox status code with modifications, see VMSetRuntimeErrorV.
3845	*
3846	* @param pVM The VM handle.
3847	* @param fFlags The error flags.
3848	* @param pszErrorId Error ID string.
3849	* @param pszFormat Format string.
3850	* @param pVa Pointer to the format arguments.
3851	*
3852	* @thread EMT
3853	*/
3854	DECLCALLBACK(int) vmR3SetRuntimeErrorV(PVM pVM, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list *pVa)
3855	{
3856	/*
3857	* Make a copy of the message.
3858	*/
3859	va_list va2;
3860	va_copy(va2, *pVa);
3861	vmSetRuntimeErrorCopy(pVM, fFlags, pszErrorId, pszFormat, va2);
3862	va_end(va2);
3863
3864	/*
3865	* Join paths with VMR3SetRuntimeErrorWorker.
3866	*/
3867	return vmR3SetRuntimeErrorCommon(pVM, fFlags, pszErrorId, pszFormat, pVa);
3868	}
3869
3870
3871	/**
3872	* Gets the ID virtual of the virtual CPU assoicated with the calling thread.
3873	*
3874	* @returns The CPU ID. NIL_VMCPUID if the thread isn't an EMT.
3875	*
3876	* @param pVM The VM handle.
3877	*/
3878	VMMR3DECL(RTCPUID) VMR3GetVMCPUId(PVM pVM)
3879	{
3880	PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pVM->pUVM->vm.s.idxTLS);
3881	return pUVCpu
3882	? pUVCpu->idCpu
3883	: NIL_VMCPUID;
3884	}
3885
3886
3887	/**
3888	* Returns the native handle of the current EMT VMCPU thread.
3889	*
3890	* @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3891	* @param pVM The VM handle.
3892	* @thread EMT
3893	*/
3894	VMMR3DECL(RTNATIVETHREAD) VMR3GetVMCPUNativeThread(PVM pVM)
3895	{
3896	PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pVM->pUVM->vm.s.idxTLS);
3897
3898	if (!pUVCpu)
3899	return NIL_RTNATIVETHREAD;
3900
3901	return pUVCpu->vm.s.NativeThreadEMT;
3902	}
3903
3904
3905	/**
3906	* Returns the native handle of the current EMT VMCPU thread.
3907	*
3908	* @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3909	* @param pVM The VM handle.
3910	* @thread EMT
3911	*/
3912	VMMR3DECL(RTNATIVETHREAD) VMR3GetVMCPUNativeThreadU(PUVM pUVM)
3913	{
3914	PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pUVM->vm.s.idxTLS);
3915
3916	if (!pUVCpu)
3917	return NIL_RTNATIVETHREAD;
3918
3919	return pUVCpu->vm.s.NativeThreadEMT;
3920	}
3921
3922
3923	/**
3924	* Returns the handle of the current EMT VMCPU thread.
3925	*
3926	* @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3927	* @param pVM The VM handle.
3928	* @thread EMT
3929	*/
3930	VMMR3DECL(RTTHREAD) VMR3GetVMCPUThread(PVM pVM)
3931	{
3932	PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pVM->pUVM->vm.s.idxTLS);
3933
3934	if (!pUVCpu)
3935	return NIL_RTTHREAD;
3936
3937	return pUVCpu->vm.s.ThreadEMT;
3938	}
3939
3940
3941	/**
3942	* Returns the handle of the current EMT VMCPU thread.
3943	*
3944	* @returns Handle if this is an EMT thread; NIL_RTNATIVETHREAD otherwise
3945	* @param pVM The VM handle.
3946	* @thread EMT
3947	*/
3948	VMMR3DECL(RTTHREAD) VMR3GetVMCPUThreadU(PUVM pUVM)
3949	{
3950	PUVMCPU pUVCpu = (PUVMCPU)RTTlsGet(pUVM->vm.s.idxTLS);
3951
3952	if (!pUVCpu)
3953	return NIL_RTTHREAD;
3954
3955	return pUVCpu->vm.s.ThreadEMT;
3956	}
3957

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

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

Download in other formats: