ConsoleImpl.cpp@ 52019

Last change on this file since 52019 was 52019, checked in by vboxsync, 11 years ago
Main/Console: Switch to RTMemSafer* for key backings
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 350.4 KB

Line
1	/* $Id: ConsoleImpl.cpp 52019 2014-07-14 20:01:03Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class implementation
4	*/
5
6	/*
7	* Copyright (C) 2005-2014 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.215389.xyz. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/** @todo Move the TAP mess back into the driver! */
19	#if defined(RT_OS_WINDOWS)
20	#elif defined(RT_OS_LINUX)
21	# include <errno.h>
22	# include <sys/ioctl.h>
23	# include <sys/poll.h>
24	# include <sys/fcntl.h>
25	# include <sys/types.h>
26	# include <sys/wait.h>
27	# include <net/if.h>
28	# include <linux/if_tun.h>
29	# include <stdio.h>
30	# include <stdlib.h>
31	# include <string.h>
32	#elif defined(RT_OS_FREEBSD)
33	# include <errno.h>
34	# include <sys/ioctl.h>
35	# include <sys/poll.h>
36	# include <sys/fcntl.h>
37	# include <sys/types.h>
38	# include <sys/wait.h>
39	# include <stdio.h>
40	# include <stdlib.h>
41	# include <string.h>
42	#elif defined(RT_OS_SOLARIS)
43	# include <iprt/coredumper.h>
44	#endif
45
46	#include "ConsoleImpl.h"
47
48	#include "Global.h"
49	#include "VirtualBoxErrorInfoImpl.h"
50	#include "GuestImpl.h"
51	#include "KeyboardImpl.h"
52	#include "MouseImpl.h"
53	#include "DisplayImpl.h"
54	#include "MachineDebuggerImpl.h"
55	#include "USBDeviceImpl.h"
56	#include "RemoteUSBDeviceImpl.h"
57	#include "SharedFolderImpl.h"
58	#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
59	#include "DrvAudioVRDE.h"
60	#else
61	#include "AudioSnifferInterface.h"
62	#endif
63	#include "Nvram.h"
64	#ifdef VBOX_WITH_USB_CARDREADER
65	# include "UsbCardReader.h"
66	#endif
67	#include "ProgressImpl.h"
68	#include "ConsoleVRDPServer.h"
69	#include "VMMDev.h"
70	#ifdef VBOX_WITH_EXTPACK
71	# include "ExtPackManagerImpl.h"
72	#endif
73	#include "BusAssignmentManager.h"
74	#include "EmulatedUSBImpl.h"
75
76	#include "VBoxEvents.h"
77	#include "AutoCaller.h"
78	#include "Logging.h"
79
80	#include <VBox/com/array.h>
81	#include "VBox/com/ErrorInfo.h"
82	#include <VBox/com/listeners.h>
83
84	#include <iprt/asm.h>
85	#include <iprt/buildconfig.h>
86	#include <iprt/cpp/utils.h>
87	#include <iprt/dir.h>
88	#include <iprt/file.h>
89	#include <iprt/ldr.h>
90	#include <iprt/path.h>
91	#include <iprt/process.h>
92	#include <iprt/string.h>
93	#include <iprt/system.h>
94	#include <iprt/base64.h>
95	#include <iprt/memsafer.h>
96
97	#include <VBox/vmm/vmapi.h>
98	#include <VBox/vmm/vmm.h>
99	#include <VBox/vmm/pdmapi.h>
100	#include <VBox/vmm/pdmasynccompletion.h>
101	#include <VBox/vmm/pdmnetifs.h>
102	#ifdef VBOX_WITH_USB
103	# include <VBox/vmm/pdmusb.h>
104	#endif
105	#ifdef VBOX_WITH_NETSHAPER
106	# include <VBox/vmm/pdmnetshaper.h>
107	#endif /* VBOX_WITH_NETSHAPER */
108	#include <VBox/vmm/mm.h>
109	#include <VBox/vmm/ftm.h>
110	#include <VBox/vmm/ssm.h>
111	#include <VBox/err.h>
112	#include <VBox/param.h>
113	#include <VBox/vusb.h>
114
115	#include <VBox/VMMDev.h>
116
117	#include <VBox/HostServices/VBoxClipboardSvc.h>
118	#include <VBox/HostServices/DragAndDropSvc.h>
119	#ifdef VBOX_WITH_GUEST_PROPS
120	# include <VBox/HostServices/GuestPropertySvc.h>
121	# include <VBox/com/array.h>
122	#endif
123
124	#ifdef VBOX_OPENSSL_FIPS
125	# include <openssl/crypto.h>
126	#endif
127
128	#include <set>
129	#include <algorithm>
130	#include <memory> // for auto_ptr
131	#include <vector>
132
133
134	// VMTask and friends
135	////////////////////////////////////////////////////////////////////////////////
136
137	/**
138	* Task structure for asynchronous VM operations.
139	*
140	* Once created, the task structure adds itself as a Console caller. This means:
141	*
142	* 1. The user must check for #rc() before using the created structure
143	* (e.g. passing it as a thread function argument). If #rc() returns a
144	* failure, the Console object may not be used by the task (see
145	* Console::addCaller() for more details).
146	* 2. On successful initialization, the structure keeps the Console caller
147	* until destruction (to ensure Console remains in the Ready state and won't
148	* be accidentally uninitialized). Forgetting to delete the created task
149	* will lead to Console::uninit() stuck waiting for releasing all added
150	* callers.
151	*
152	* If \a aUsesVMPtr parameter is true, the task structure will also add itself
153	* as a Console::mpUVM caller with the same meaning as above. See
154	* Console::addVMCaller() for more info.
155	*/
156	struct VMTask
157	{
158	VMTask(Console *aConsole,
159	Progress *aProgress,
160	const ComPtr<IProgress> &aServerProgress,
161	bool aUsesVMPtr)
162	: mConsole(aConsole),
163	mConsoleCaller(aConsole),
164	mProgress(aProgress),
165	mServerProgress(aServerProgress),
166	mpUVM(NULL),
167	mRC(E_FAIL),
168	mpSafeVMPtr(NULL)
169	{
170	AssertReturnVoid(aConsole);
171	mRC = mConsoleCaller.rc();
172	if (FAILED(mRC))
173	return;
174	if (aUsesVMPtr)
175	{
176	mpSafeVMPtr = new Console::SafeVMPtr(aConsole);
177	if (mpSafeVMPtr->isOk())
178	mpUVM = mpSafeVMPtr->rawUVM();
179	else
180	mRC = mpSafeVMPtr->rc();
181	}
182	}
183
184	~VMTask()
185	{
186	releaseVMCaller();
187	}
188
189	HRESULT rc() const { return mRC; }
190	bool isOk() const { return SUCCEEDED(rc()); }
191
192	/** Releases the VM caller before destruction. Not normally necessary. */
193	void releaseVMCaller()
194	{
195	if (mpSafeVMPtr)
196	{
197	delete mpSafeVMPtr;
198	mpSafeVMPtr = NULL;
199	}
200	}
201
202	const ComObjPtr<Console> mConsole;
203	AutoCaller mConsoleCaller;
204	const ComObjPtr<Progress> mProgress;
205	Utf8Str mErrorMsg;
206	const ComPtr<IProgress> mServerProgress;
207	PUVM mpUVM;
208
209	private:
210	HRESULT mRC;
211	Console::SafeVMPtr *mpSafeVMPtr;
212	};
213
214	struct VMTakeSnapshotTask : public VMTask
215	{
216	VMTakeSnapshotTask(Console *aConsole,
217	Progress *aProgress,
218	IN_BSTR aName,
219	IN_BSTR aDescription)
220	: VMTask(aConsole, aProgress, NULL /* aServerProgress */,
221	false /* aUsesVMPtr */),
222	bstrName(aName),
223	bstrDescription(aDescription),
224	lastMachineState(MachineState_Null)
225	{}
226
227	Bstr bstrName,
228	bstrDescription;
229	Bstr bstrSavedStateFile; // received from BeginTakeSnapshot()
230	MachineState_T lastMachineState;
231	bool fTakingSnapshotOnline;
232	ULONG ulMemSize;
233	};
234
235	struct VMPowerUpTask : public VMTask
236	{
237	VMPowerUpTask(Console *aConsole,
238	Progress *aProgress)
239	: VMTask(aConsole, aProgress, NULL /* aServerProgress */,
240	false /* aUsesVMPtr */),
241	mConfigConstructor(NULL),
242	mStartPaused(false),
243	mTeleporterEnabled(FALSE),
244	mEnmFaultToleranceState(FaultToleranceState_Inactive)
245	{}
246
247	PFNCFGMCONSTRUCTOR mConfigConstructor;
248	Utf8Str mSavedStateFile;
249	Console::SharedFolderDataMap mSharedFolders;
250	bool mStartPaused;
251	BOOL mTeleporterEnabled;
252	FaultToleranceState_T mEnmFaultToleranceState;
253
254	/* array of progress objects for hard disk reset operations */
255	typedef std::list<ComPtr<IProgress> > ProgressList;
256	ProgressList hardDiskProgresses;
257	};
258
259	struct VMPowerDownTask : public VMTask
260	{
261	VMPowerDownTask(Console *aConsole,
262	const ComPtr<IProgress> &aServerProgress)
263	: VMTask(aConsole, NULL /* aProgress */, aServerProgress,
264	true /* aUsesVMPtr */)
265	{}
266	};
267
268	struct VMSaveTask : public VMTask
269	{
270	VMSaveTask(Console *aConsole,
271	const ComPtr<IProgress> &aServerProgress,
272	const Utf8Str &aSavedStateFile,
273	MachineState_T aMachineStateBefore,
274	Reason_T aReason)
275	: VMTask(aConsole, NULL /* aProgress */, aServerProgress,
276	true /* aUsesVMPtr */),
277	mSavedStateFile(aSavedStateFile),
278	mMachineStateBefore(aMachineStateBefore),
279	mReason(aReason)
280	{}
281
282	Utf8Str mSavedStateFile;
283	/* The local machine state we had before. Required if something fails */
284	MachineState_T mMachineStateBefore;
285	/* The reason for saving state */
286	Reason_T mReason;
287	};
288
289	// Handler for global events
290	////////////////////////////////////////////////////////////////////////////////
291	inline static const char *networkAdapterTypeToName(NetworkAdapterType_T adapterType);
292
293	class VmEventListener {
294	public:
295	VmEventListener()
296	{}
297
298
299	HRESULT init(Console *aConsole)
300	{
301	mConsole = aConsole;
302	return S_OK;
303	}
304
305	void uninit()
306	{
307	}
308
309	virtual ~VmEventListener()
310	{
311	}
312
313	STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent * aEvent)
314	{
315	switch(aType)
316	{
317	case VBoxEventType_OnNATRedirect:
318	{
319	Bstr id;
320	ComPtr<IMachine> pMachine = mConsole->i_machine();
321	ComPtr<INATRedirectEvent> pNREv = aEvent;
322	HRESULT rc = E_FAIL;
323	Assert(pNREv);
324
325	Bstr interestedId;
326	rc = pMachine->COMGETTER(Id)(interestedId.asOutParam());
327	AssertComRC(rc);
328	rc = pNREv->COMGETTER(MachineId)(id.asOutParam());
329	AssertComRC(rc);
330	if (id != interestedId)
331	break;
332	/* now we can operate with redirects */
333	NATProtocol_T proto;
334	pNREv->COMGETTER(Proto)(&proto);
335	BOOL fRemove;
336	pNREv->COMGETTER(Remove)(&fRemove);
337	bool fUdp = (proto == NATProtocol_UDP);
338	Bstr hostIp, guestIp;
339	LONG hostPort, guestPort;
340	pNREv->COMGETTER(HostIP)(hostIp.asOutParam());
341	pNREv->COMGETTER(HostPort)(&hostPort);
342	pNREv->COMGETTER(GuestIP)(guestIp.asOutParam());
343	pNREv->COMGETTER(GuestPort)(&guestPort);
344	ULONG ulSlot;
345	rc = pNREv->COMGETTER(Slot)(&ulSlot);
346	AssertComRC(rc);
347	if (FAILED(rc))
348	break;
349	mConsole->i_onNATRedirectRuleChange(ulSlot, fRemove, proto, hostIp.raw(), hostPort, guestIp.raw(), guestPort);
350	}
351	break;
352
353	case VBoxEventType_OnHostPCIDevicePlug:
354	{
355	// handle if needed
356	break;
357	}
358
359	case VBoxEventType_OnExtraDataChanged:
360	{
361	ComPtr<IExtraDataChangedEvent> pEDCEv = aEvent;
362	Bstr strMachineId;
363	Bstr strKey;
364	Bstr strVal;
365	HRESULT hrc = S_OK;
366
367	hrc = pEDCEv->COMGETTER(MachineId)(strMachineId.asOutParam());
368	if (FAILED(hrc)) break;
369
370	hrc = pEDCEv->COMGETTER(Key)(strKey.asOutParam());
371	if (FAILED(hrc)) break;
372
373	hrc = pEDCEv->COMGETTER(Value)(strVal.asOutParam());
374	if (FAILED(hrc)) break;
375
376	mConsole->i_onExtraDataChange(strMachineId.raw(), strKey.raw(), strVal.raw());
377	break;
378	}
379
380	default:
381	AssertFailed();
382	}
383	return S_OK;
384	}
385	private:
386	ComObjPtr<Console> mConsole;
387	};
388
389	typedef ListenerImpl<VmEventListener, Console*> VmEventListenerImpl;
390
391
392	VBOX_LISTENER_DECLARE(VmEventListenerImpl)
393
394
395	// constructor / destructor
396	/////////////////////////////////////////////////////////////////////////////
397
398	Console::Console()
399	: mSavedStateDataLoaded(false)
400	, mConsoleVRDPServer(NULL)
401	, mfVRDEChangeInProcess(false)
402	, mfVRDEChangePending(false)
403	, mpUVM(NULL)
404	, mVMCallers(0)
405	, mVMZeroCallersSem(NIL_RTSEMEVENT)
406	, mVMDestroying(false)
407	, mVMPoweredOff(false)
408	, mVMIsAlreadyPoweringOff(false)
409	, mfSnapshotFolderSizeWarningShown(false)
410	, mfSnapshotFolderExt4WarningShown(false)
411	, mfSnapshotFolderDiskTypeShown(false)
412	, mfVMHasUsbController(false)
413	, mfPowerOffCausedByReset(false)
414	, mpVmm2UserMethods(NULL)
415	, m_pVMMDev(NULL)
416	#ifndef VBOX_WITH_PDM_AUDIO_DRIVER
417	, mAudioSniffer(NULL)
418	#endif
419	, mNvram(NULL)
420	#ifdef VBOX_WITH_USB_CARDREADER
421	, mUsbCardReader(NULL)
422	#endif
423	, mBusMgr(NULL)
424	, mpIfSecKey(NULL)
425	, mVMStateChangeCallbackDisabled(false)
426	, mfUseHostClipboard(true)
427	, mMachineState(MachineState_PoweredOff)
428	{
429	}
430
431	Console::~Console()
432	{}
433
434	HRESULT Console::FinalConstruct()
435	{
436	LogFlowThisFunc(("\n"));
437
438	RT_ZERO(mapStorageLeds);
439	RT_ZERO(mapNetworkLeds);
440	RT_ZERO(mapUSBLed);
441	RT_ZERO(mapSharedFolderLed);
442	RT_ZERO(mapCrOglLed);
443
444	for (unsigned i = 0; i < RT_ELEMENTS(maStorageDevType); ++i)
445	maStorageDevType[i] = DeviceType_Null;
446
447	MYVMM2USERMETHODS pVmm2UserMethods = (MYVMM2USERMETHODS )RTMemAllocZ(sizeof(mpVmm2UserMethods) + sizeof(Console ));
448	if (!pVmm2UserMethods)
449	return E_OUTOFMEMORY;
450	pVmm2UserMethods->u32Magic = VMM2USERMETHODS_MAGIC;
451	pVmm2UserMethods->u32Version = VMM2USERMETHODS_VERSION;
452	pVmm2UserMethods->pfnSaveState = Console::i_vmm2User_SaveState;
453	pVmm2UserMethods->pfnNotifyEmtInit = Console::i_vmm2User_NotifyEmtInit;
454	pVmm2UserMethods->pfnNotifyEmtTerm = Console::i_vmm2User_NotifyEmtTerm;
455	pVmm2UserMethods->pfnNotifyPdmtInit = Console::i_vmm2User_NotifyPdmtInit;
456	pVmm2UserMethods->pfnNotifyPdmtTerm = Console::i_vmm2User_NotifyPdmtTerm;
457	pVmm2UserMethods->pfnNotifyResetTurnedIntoPowerOff = Console::i_vmm2User_NotifyResetTurnedIntoPowerOff;
458	pVmm2UserMethods->u32EndMagic = VMM2USERMETHODS_MAGIC;
459	pVmm2UserMethods->pConsole = this;
460	mpVmm2UserMethods = pVmm2UserMethods;
461
462	MYPDMISECKEY pIfSecKey = (MYPDMISECKEY )RTMemAllocZ(sizeof(mpIfSecKey) + sizeof(Console ));
463	if (!pIfSecKey)
464	return E_OUTOFMEMORY;
465	pIfSecKey->pfnKeyRetain = Console::i_pdmIfSecKey_KeyRetain;
466	pIfSecKey->pfnKeyRelease = Console::i_pdmIfSecKey_KeyRelease;
467	pIfSecKey->pConsole = this;
468	mpIfSecKey = pIfSecKey;
469
470	return BaseFinalConstruct();
471	}
472
473	void Console::FinalRelease()
474	{
475	LogFlowThisFunc(("\n"));
476
477	uninit();
478
479	BaseFinalRelease();
480	}
481
482	// public initializer/uninitializer for internal purposes only
483	/////////////////////////////////////////////////////////////////////////////
484
485	HRESULT Console::init(IMachine aMachine, IInternalMachineControl aControl, LockType_T aLockType)
486	{
487	AssertReturn(aMachine && aControl, E_INVALIDARG);
488
489	/* Enclose the state transition NotReady->InInit->Ready */
490	AutoInitSpan autoInitSpan(this);
491	AssertReturn(autoInitSpan.isOk(), E_FAIL);
492
493	LogFlowThisFuncEnter();
494	LogFlowThisFunc(("aMachine=%p, aControl=%p\n", aMachine, aControl));
495
496	HRESULT rc = E_FAIL;
497
498	unconst(mMachine) = aMachine;
499	unconst(mControl) = aControl;
500
501	/* Cache essential properties and objects, and create child objects */
502
503	rc = mMachine->COMGETTER(State)(&mMachineState);
504	AssertComRCReturnRC(rc);
505
506	#ifdef VBOX_WITH_EXTPACK
507	unconst(mptrExtPackManager).createObject();
508	rc = mptrExtPackManager->initExtPackManager(NULL, VBOXEXTPACKCTX_VM_PROCESS);
509	AssertComRCReturnRC(rc);
510	#endif
511
512	// Event source may be needed by other children
513	unconst(mEventSource).createObject();
514	rc = mEventSource->init();
515	AssertComRCReturnRC(rc);
516
517	mcAudioRefs = 0;
518	mcVRDPClients = 0;
519	mu32SingleRDPClientId = 0;
520	mcGuestCredentialsProvided = false;
521
522	/* Now the VM specific parts */
523	if (aLockType == LockType_VM)
524	{
525	rc = mMachine->COMGETTER(VRDEServer)(unconst(mVRDEServer).asOutParam());
526	AssertComRCReturnRC(rc);
527
528	unconst(mGuest).createObject();
529	rc = mGuest->init(this);
530	AssertComRCReturnRC(rc);
531
532	unconst(mKeyboard).createObject();
533	rc = mKeyboard->init(this);
534	AssertComRCReturnRC(rc);
535
536	unconst(mMouse).createObject();
537	rc = mMouse->init(this);
538	AssertComRCReturnRC(rc);
539
540	unconst(mDisplay).createObject();
541	rc = mDisplay->init(this);
542	AssertComRCReturnRC(rc);
543
544	unconst(mVRDEServerInfo).createObject();
545	rc = mVRDEServerInfo->init(this);
546	AssertComRCReturnRC(rc);
547
548	unconst(mEmulatedUSB).createObject();
549	rc = mEmulatedUSB->init(this);
550	AssertComRCReturnRC(rc);
551
552	/* Grab global and machine shared folder lists */
553
554	rc = i_fetchSharedFolders(true /* aGlobal */);
555	AssertComRCReturnRC(rc);
556	rc = i_fetchSharedFolders(false /* aGlobal */);
557	AssertComRCReturnRC(rc);
558
559	/* Create other child objects */
560
561	unconst(mConsoleVRDPServer) = new ConsoleVRDPServer(this);
562	AssertReturn(mConsoleVRDPServer, E_FAIL);
563
564	/* Figure out size of meAttachmentType vector */
565	ComPtr<IVirtualBox> pVirtualBox;
566	rc = aMachine->COMGETTER(Parent)(pVirtualBox.asOutParam());
567	AssertComRC(rc);
568	ComPtr<ISystemProperties> pSystemProperties;
569	if (pVirtualBox)
570	pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
571	ChipsetType_T chipsetType = ChipsetType_PIIX3;
572	aMachine->COMGETTER(ChipsetType)(&chipsetType);
573	ULONG maxNetworkAdapters = 0;
574	if (pSystemProperties)
575	pSystemProperties->GetMaxNetworkAdapters(chipsetType, &maxNetworkAdapters);
576	meAttachmentType.resize(maxNetworkAdapters);
577	for (ULONG slot = 0; slot < maxNetworkAdapters; ++slot)
578	meAttachmentType[slot] = NetworkAttachmentType_Null;
579
580	// VirtualBox 4.0: We no longer initialize the VMMDev instance here,
581	// which starts the HGCM thread. Instead, this is now done in the
582	// power-up thread when a VM is actually being powered up to avoid
583	// having HGCM threads all over the place every time a session is
584	// opened, even if that session will not run a VM.
585	// unconst(m_pVMMDev) = new VMMDev(this);
586	// AssertReturn(mVMMDev, E_FAIL);
587
588	#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
589	unconst(mAudioVRDE) = new AudioVRDE(this);
590	AssertComRCReturnRC(rc);
591	#else
592	unconst(mAudioSniffer) = new AudioSniffer(this);
593	AssertReturn(mAudioSniffer, E_FAIL);
594	#endif
595
596	FirmwareType_T enmFirmwareType;
597	mMachine->COMGETTER(FirmwareType)(&enmFirmwareType);
598	if ( enmFirmwareType == FirmwareType_EFI
599	\|\| enmFirmwareType == FirmwareType_EFI32
600	\|\| enmFirmwareType == FirmwareType_EFI64
601	\|\| enmFirmwareType == FirmwareType_EFIDUAL)
602	{
603	unconst(mNvram) = new Nvram(this);
604	AssertReturn(mNvram, E_FAIL);
605	}
606
607	#ifdef VBOX_WITH_USB_CARDREADER
608	unconst(mUsbCardReader) = new UsbCardReader(this);
609	AssertReturn(mUsbCardReader, E_FAIL);
610	#endif
611
612	/* VirtualBox events registration. */
613	{
614	ComPtr<IEventSource> pES;
615	rc = pVirtualBox->COMGETTER(EventSource)(pES.asOutParam());
616	AssertComRC(rc);
617	ComObjPtr<VmEventListenerImpl> aVmListener;
618	aVmListener.createObject();
619	aVmListener->init(new VmEventListener(), this);
620	mVmListener = aVmListener;
621	com::SafeArray<VBoxEventType_T> eventTypes;
622	eventTypes.push_back(VBoxEventType_OnNATRedirect);
623	eventTypes.push_back(VBoxEventType_OnHostPCIDevicePlug);
624	eventTypes.push_back(VBoxEventType_OnExtraDataChanged);
625	rc = pES->RegisterListener(aVmListener, ComSafeArrayAsInParam(eventTypes), true);
626	AssertComRC(rc);
627	}
628	}
629
630	/* Confirm a successful initialization when it's the case */
631	autoInitSpan.setSucceeded();
632
633	#ifdef VBOX_WITH_EXTPACK
634	/* Let the extension packs have a go at things (hold no locks). */
635	if (SUCCEEDED(rc))
636	mptrExtPackManager->i_callAllConsoleReadyHooks(this);
637	#endif
638
639	LogFlowThisFuncLeave();
640
641	return S_OK;
642	}
643
644	/**
645	* Uninitializes the Console object.
646	*/
647	void Console::uninit()
648	{
649	LogFlowThisFuncEnter();
650
651	/* Enclose the state transition Ready->InUninit->NotReady */
652	AutoUninitSpan autoUninitSpan(this);
653	if (autoUninitSpan.uninitDone())
654	{
655	LogFlowThisFunc(("Already uninitialized.\n"));
656	LogFlowThisFuncLeave();
657	return;
658	}
659
660	LogFlowThisFunc(("initFailed()=%d\n", autoUninitSpan.initFailed()));
661	if (mVmListener)
662	{
663	ComPtr<IEventSource> pES;
664	ComPtr<IVirtualBox> pVirtualBox;
665	HRESULT rc = mMachine->COMGETTER(Parent)(pVirtualBox.asOutParam());
666	AssertComRC(rc);
667	if (SUCCEEDED(rc) && !pVirtualBox.isNull())
668	{
669	rc = pVirtualBox->COMGETTER(EventSource)(pES.asOutParam());
670	AssertComRC(rc);
671	if (!pES.isNull())
672	{
673	rc = pES->UnregisterListener(mVmListener);
674	AssertComRC(rc);
675	}
676	}
677	mVmListener.setNull();
678	}
679
680	/* power down the VM if necessary */
681	if (mpUVM)
682	{
683	i_powerDown();
684	Assert(mpUVM == NULL);
685	}
686
687	if (mVMZeroCallersSem != NIL_RTSEMEVENT)
688	{
689	RTSemEventDestroy(mVMZeroCallersSem);
690	mVMZeroCallersSem = NIL_RTSEMEVENT;
691	}
692
693	if (mpVmm2UserMethods)
694	{
695	RTMemFree((void *)mpVmm2UserMethods);
696	mpVmm2UserMethods = NULL;
697	}
698
699	if (mpIfSecKey)
700	{
701	RTMemFree((void *)mpIfSecKey);
702	mpIfSecKey = NULL;
703	}
704
705	if (mNvram)
706	{
707	delete mNvram;
708	unconst(mNvram) = NULL;
709	}
710
711	#ifdef VBOX_WITH_USB_CARDREADER
712	if (mUsbCardReader)
713	{
714	delete mUsbCardReader;
715	unconst(mUsbCardReader) = NULL;
716	}
717	#endif
718	#ifndef VBOX_WITH_PDM_AUDIO_DRIVER
719	if (mAudioSniffer)
720	{
721	delete mAudioSniffer;
722	unconst(mAudioSniffer) = NULL;
723	}
724	#endif
725
726	// if the VM had a VMMDev with an HGCM thread, then remove that here
727	if (m_pVMMDev)
728	{
729	delete m_pVMMDev;
730	unconst(m_pVMMDev) = NULL;
731	}
732
733	if (mBusMgr)
734	{
735	mBusMgr->Release();
736	mBusMgr = NULL;
737	}
738
739	m_mapGlobalSharedFolders.clear();
740	m_mapMachineSharedFolders.clear();
741	m_mapSharedFolders.clear(); // console instances
742
743	mRemoteUSBDevices.clear();
744	mUSBDevices.clear();
745
746	for (SecretKeyMap::iterator it = m_mapSecretKeys.begin();
747	it != m_mapSecretKeys.end();
748	it++)
749	delete it->second;
750	m_mapSecretKeys.clear();
751
752	if (mVRDEServerInfo)
753	{
754	mVRDEServerInfo->uninit();
755	unconst(mVRDEServerInfo).setNull();
756	}
757
758	if (mEmulatedUSB)
759	{
760	mEmulatedUSB->uninit();
761	unconst(mEmulatedUSB).setNull();
762	}
763
764	if (mDebugger)
765	{
766	mDebugger->uninit();
767	unconst(mDebugger).setNull();
768	}
769
770	if (mDisplay)
771	{
772	mDisplay->uninit();
773	unconst(mDisplay).setNull();
774	}
775
776	if (mMouse)
777	{
778	mMouse->uninit();
779	unconst(mMouse).setNull();
780	}
781
782	if (mKeyboard)
783	{
784	mKeyboard->uninit();
785	unconst(mKeyboard).setNull();
786	}
787
788	if (mGuest)
789	{
790	mGuest->uninit();
791	unconst(mGuest).setNull();
792	}
793
794	if (mConsoleVRDPServer)
795	{
796	delete mConsoleVRDPServer;
797	unconst(mConsoleVRDPServer) = NULL;
798	}
799
800	unconst(mVRDEServer).setNull();
801
802	unconst(mControl).setNull();
803	unconst(mMachine).setNull();
804
805	// we don't perform uninit() as it's possible that some pending event refers to this source
806	unconst(mEventSource).setNull();
807
808	#ifdef CONSOLE_WITH_EVENT_CACHE
809	mCallbackData.clear();
810	#endif
811
812	LogFlowThisFuncLeave();
813	}
814
815	#ifdef VBOX_WITH_GUEST_PROPS
816
817	/**
818	* Handles guest properties on a VM reset.
819	*
820	* We must delete properties that are flagged TRANSRESET.
821	*
822	* @todo r=bird: Would be more efficient if we added a request to the HGCM
823	* service to do this instead of detouring thru VBoxSVC.
824	* (IMachine::SetGuestProperty ends up in VBoxSVC, which in turns calls
825	* back into the VM process and the HGCM service.)
826	*/
827	void Console::i_guestPropertiesHandleVMReset(void)
828	{
829	com::SafeArray<BSTR> arrNames;
830	com::SafeArray<BSTR> arrValues;
831	com::SafeArray<LONG64> arrTimestamps;
832	com::SafeArray<BSTR> arrFlags;
833	HRESULT hrc = i_enumerateGuestProperties(Bstr("*").raw(),
834	ComSafeArrayAsOutParam(arrNames),
835	ComSafeArrayAsOutParam(arrValues),
836	ComSafeArrayAsOutParam(arrTimestamps),
837	ComSafeArrayAsOutParam(arrFlags));
838	if (SUCCEEDED(hrc))
839	{
840	for (size_t i = 0; i < arrFlags.size(); i++)
841	{
842	/* Delete all properties which have the flag "TRANSRESET". */
843	if (Utf8Str(arrFlags[i]).contains("TRANSRESET", Utf8Str::CaseInsensitive))
844	{
845	hrc = mMachine->DeleteGuestProperty(arrNames[i]);
846	if (FAILED(hrc))
847	LogRel(("RESET: Could not delete transient property \"%ls\", rc=%Rhrc\n",
848	arrNames[i], hrc));
849	}
850	}
851	}
852	else
853	LogRel(("RESET: Unable to enumerate guest properties, rc=%Rhrc\n", hrc));
854	}
855
856	bool Console::i_guestPropertiesVRDPEnabled(void)
857	{
858	Bstr value;
859	HRESULT hrc = mMachine->GetExtraData(Bstr("VBoxInternal2/EnableGuestPropertiesVRDP").raw(),
860	value.asOutParam());
861	if ( hrc == S_OK
862	&& value == "1")
863	return true;
864	return false;
865	}
866
867	void Console::i_guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char pszUser, const char pszDomain)
868	{
869	if (!i_guestPropertiesVRDPEnabled())
870	return;
871
872	LogFlowFunc(("\n"));
873
874	char szPropNm[256];
875	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
876
877	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Name", u32ClientId);
878	Bstr clientName;
879	mVRDEServerInfo->COMGETTER(ClientName)(clientName.asOutParam());
880
881	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
882	clientName.raw(),
883	bstrReadOnlyGuest.raw());
884
885	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/User", u32ClientId);
886	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
887	Bstr(pszUser).raw(),
888	bstrReadOnlyGuest.raw());
889
890	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Domain", u32ClientId);
891	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
892	Bstr(pszDomain).raw(),
893	bstrReadOnlyGuest.raw());
894
895	char szClientId[64];
896	RTStrPrintf(szClientId, sizeof(szClientId), "%u", u32ClientId);
897	mMachine->SetGuestProperty(Bstr("/VirtualBox/HostInfo/VRDP/LastConnectedClient").raw(),
898	Bstr(szClientId).raw(),
899	bstrReadOnlyGuest.raw());
900
901	return;
902	}
903
904	void Console::i_guestPropertiesVRDPUpdateActiveClient(uint32_t u32ClientId)
905	{
906	if (!i_guestPropertiesVRDPEnabled())
907	return;
908
909	LogFlowFunc(("%d\n", u32ClientId));
910
911	Bstr bstrFlags(L"RDONLYGUEST,TRANSIENT");
912
913	char szClientId[64];
914	RTStrPrintf(szClientId, sizeof(szClientId), "%u", u32ClientId);
915
916	mMachine->SetGuestProperty(Bstr("/VirtualBox/HostInfo/VRDP/ActiveClient").raw(),
917	Bstr(szClientId).raw(),
918	bstrFlags.raw());
919
920	return;
921	}
922
923	void Console::i_guestPropertiesVRDPUpdateNameChange(uint32_t u32ClientId, const char *pszName)
924	{
925	if (!i_guestPropertiesVRDPEnabled())
926	return;
927
928	LogFlowFunc(("\n"));
929
930	char szPropNm[256];
931	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
932
933	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Name", u32ClientId);
934	Bstr clientName(pszName);
935
936	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
937	clientName.raw(),
938	bstrReadOnlyGuest.raw());
939
940	}
941
942	void Console::i_guestPropertiesVRDPUpdateIPAddrChange(uint32_t u32ClientId, const char *pszIPAddr)
943	{
944	if (!i_guestPropertiesVRDPEnabled())
945	return;
946
947	LogFlowFunc(("\n"));
948
949	char szPropNm[256];
950	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
951
952	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/IPAddr", u32ClientId);
953	Bstr clientIPAddr(pszIPAddr);
954
955	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
956	clientIPAddr.raw(),
957	bstrReadOnlyGuest.raw());
958
959	}
960
961	void Console::i_guestPropertiesVRDPUpdateLocationChange(uint32_t u32ClientId, const char *pszLocation)
962	{
963	if (!i_guestPropertiesVRDPEnabled())
964	return;
965
966	LogFlowFunc(("\n"));
967
968	char szPropNm[256];
969	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
970
971	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Location", u32ClientId);
972	Bstr clientLocation(pszLocation);
973
974	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
975	clientLocation.raw(),
976	bstrReadOnlyGuest.raw());
977
978	}
979
980	void Console::i_guestPropertiesVRDPUpdateOtherInfoChange(uint32_t u32ClientId, const char *pszOtherInfo)
981	{
982	if (!i_guestPropertiesVRDPEnabled())
983	return;
984
985	LogFlowFunc(("\n"));
986
987	char szPropNm[256];
988	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
989
990	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/OtherInfo", u32ClientId);
991	Bstr clientOtherInfo(pszOtherInfo);
992
993	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
994	clientOtherInfo.raw(),
995	bstrReadOnlyGuest.raw());
996
997	}
998
999	void Console::i_guestPropertiesVRDPUpdateClientAttach(uint32_t u32ClientId, bool fAttached)
1000	{
1001	if (!i_guestPropertiesVRDPEnabled())
1002	return;
1003
1004	LogFlowFunc(("\n"));
1005
1006	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
1007
1008	char szPropNm[256];
1009	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Attach", u32ClientId);
1010
1011	Bstr bstrValue = fAttached? "1": "0";
1012
1013	mMachine->SetGuestProperty(Bstr(szPropNm).raw(),
1014	bstrValue.raw(),
1015	bstrReadOnlyGuest.raw());
1016	}
1017
1018	void Console::i_guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId)
1019	{
1020	if (!i_guestPropertiesVRDPEnabled())
1021	return;
1022
1023	LogFlowFunc(("\n"));
1024
1025	Bstr bstrReadOnlyGuest(L"RDONLYGUEST");
1026
1027	char szPropNm[256];
1028	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Name", u32ClientId);
1029	mMachine->SetGuestProperty(Bstr(szPropNm).raw(), NULL,
1030	bstrReadOnlyGuest.raw());
1031
1032	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/User", u32ClientId);
1033	mMachine->SetGuestProperty(Bstr(szPropNm).raw(), NULL,
1034	bstrReadOnlyGuest.raw());
1035
1036	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Domain", u32ClientId);
1037	mMachine->SetGuestProperty(Bstr(szPropNm).raw(), NULL,
1038	bstrReadOnlyGuest.raw());
1039
1040	RTStrPrintf(szPropNm, sizeof(szPropNm), "/VirtualBox/HostInfo/VRDP/Client/%u/Attach", u32ClientId);
1041	mMachine->SetGuestProperty(Bstr(szPropNm).raw(), NULL,
1042	bstrReadOnlyGuest.raw());
1043
1044	char szClientId[64];
1045	RTStrPrintf(szClientId, sizeof(szClientId), "%d", u32ClientId);
1046	mMachine->SetGuestProperty(Bstr("/VirtualBox/HostInfo/VRDP/LastDisconnectedClient").raw(),
1047	Bstr(szClientId).raw(),
1048	bstrReadOnlyGuest.raw());
1049
1050	return;
1051	}
1052
1053	#endif /* VBOX_WITH_GUEST_PROPS */
1054
1055	bool Console::i_isResetTurnedIntoPowerOff(void)
1056	{
1057	Bstr value;
1058	HRESULT hrc = mMachine->GetExtraData(Bstr("VBoxInternal2/TurnResetIntoPowerOff").raw(),
1059	value.asOutParam());
1060	if ( hrc == S_OK
1061	&& value == "1")
1062	return true;
1063	return false;
1064	}
1065
1066	#ifdef VBOX_WITH_EXTPACK
1067	/**
1068	* Used by VRDEServer and others to talke to the extension pack manager.
1069	*
1070	* @returns The extension pack manager.
1071	*/
1072	ExtPackManager *Console::i_getExtPackManager()
1073	{
1074	return mptrExtPackManager;
1075	}
1076	#endif
1077
1078
1079	int Console::i_VRDPClientLogon(uint32_t u32ClientId, const char pszUser, const char pszPassword, const char *pszDomain)
1080	{
1081	LogFlowFuncEnter();
1082	LogFlowFunc(("%d, %s, %s, %s\n", u32ClientId, pszUser, pszPassword, pszDomain));
1083
1084	AutoCaller autoCaller(this);
1085	if (!autoCaller.isOk())
1086	{
1087	/* Console has been already uninitialized, deny request */
1088	LogRel(("AUTH: Access denied (Console uninitialized).\n"));
1089	LogFlowFuncLeave();
1090	return VERR_ACCESS_DENIED;
1091	}
1092
1093	Bstr id;
1094	HRESULT hrc = mMachine->COMGETTER(Id)(id.asOutParam());
1095	Guid uuid = Guid(id);
1096
1097	AssertComRCReturn(hrc, VERR_ACCESS_DENIED);
1098
1099	AuthType_T authType = AuthType_Null;
1100	hrc = mVRDEServer->COMGETTER(AuthType)(&authType);
1101	AssertComRCReturn(hrc, VERR_ACCESS_DENIED);
1102
1103	ULONG authTimeout = 0;
1104	hrc = mVRDEServer->COMGETTER(AuthTimeout)(&authTimeout);
1105	AssertComRCReturn(hrc, VERR_ACCESS_DENIED);
1106
1107	AuthResult result = AuthResultAccessDenied;
1108	AuthGuestJudgement guestJudgement = AuthGuestNotAsked;
1109
1110	LogFlowFunc(("Auth type %d\n", authType));
1111
1112	LogRel(("AUTH: User: [%s]. Domain: [%s]. Authentication type: [%s]\n",
1113	pszUser, pszDomain,
1114	authType == AuthType_Null?
1115	"Null":
1116	(authType == AuthType_External?
1117	"External":
1118	(authType == AuthType_Guest?
1119	"Guest":
1120	"INVALID"
1121	)
1122	)
1123	));
1124
1125	switch (authType)
1126	{
1127	case AuthType_Null:
1128	{
1129	result = AuthResultAccessGranted;
1130	break;
1131	}
1132
1133	case AuthType_External:
1134	{
1135	/* Call the external library. */
1136	result = mConsoleVRDPServer->Authenticate(uuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId);
1137
1138	if (result != AuthResultDelegateToGuest)
1139	{
1140	break;
1141	}
1142
1143	LogRel(("AUTH: Delegated to guest.\n"));
1144
1145	LogFlowFunc(("External auth asked for guest judgement\n"));
1146	} /* pass through */
1147
1148	case AuthType_Guest:
1149	{
1150	guestJudgement = AuthGuestNotReacted;
1151
1152	// @todo r=dj locking required here for m_pVMMDev?
1153	PPDMIVMMDEVPORT pDevPort;
1154	if ( (m_pVMMDev)
1155	&& ((pDevPort = m_pVMMDev->getVMMDevPort()))
1156	)
1157	{
1158	/* Issue the request to guest. Assume that the call does not require EMT. It should not. */
1159
1160	/* Ask the guest to judge these credentials. */
1161	uint32_t u32GuestFlags = VMMDEV_SETCREDENTIALS_JUDGE;
1162
1163	int rc = pDevPort->pfnSetCredentials(pDevPort, pszUser, pszPassword, pszDomain, u32GuestFlags);
1164
1165	if (RT_SUCCESS(rc))
1166	{
1167	/* Wait for guest. */
1168	rc = m_pVMMDev->WaitCredentialsJudgement(authTimeout, &u32GuestFlags);
1169
1170	if (RT_SUCCESS(rc))
1171	{
1172	switch (u32GuestFlags & (VMMDEV_CREDENTIALS_JUDGE_OK \| VMMDEV_CREDENTIALS_JUDGE_DENY \|
1173	VMMDEV_CREDENTIALS_JUDGE_NOJUDGEMENT))
1174	{
1175	case VMMDEV_CREDENTIALS_JUDGE_DENY: guestJudgement = AuthGuestAccessDenied; break;
1176	case VMMDEV_CREDENTIALS_JUDGE_NOJUDGEMENT: guestJudgement = AuthGuestNoJudgement; break;
1177	case VMMDEV_CREDENTIALS_JUDGE_OK: guestJudgement = AuthGuestAccessGranted; break;
1178	default:
1179	LogFlowFunc(("Invalid guest flags %08X!!!\n", u32GuestFlags)); break;
1180	}
1181	}
1182	else
1183	{
1184	LogFlowFunc(("Wait for credentials judgement rc = %Rrc!!!\n", rc));
1185	}
1186
1187	LogFlowFunc(("Guest judgement %d\n", guestJudgement));
1188	}
1189	else
1190	{
1191	LogFlowFunc(("Could not set credentials rc = %Rrc!!!\n", rc));
1192	}
1193	}
1194
1195	if (authType == AuthType_External)
1196	{
1197	LogRel(("AUTH: Guest judgement %d.\n", guestJudgement));
1198	LogFlowFunc(("External auth called again with guest judgement = %d\n", guestJudgement));
1199	result = mConsoleVRDPServer->Authenticate(uuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId);
1200	}
1201	else
1202	{
1203	switch (guestJudgement)
1204	{
1205	case AuthGuestAccessGranted:
1206	result = AuthResultAccessGranted;
1207	break;
1208	default:
1209	result = AuthResultAccessDenied;
1210	break;
1211	}
1212	}
1213	} break;
1214
1215	default:
1216	AssertFailed();
1217	}
1218
1219	LogFlowFunc(("Result = %d\n", result));
1220	LogFlowFuncLeave();
1221
1222	if (result != AuthResultAccessGranted)
1223	{
1224	/* Reject. */
1225	LogRel(("AUTH: Access denied.\n"));
1226	return VERR_ACCESS_DENIED;
1227	}
1228
1229	LogRel(("AUTH: Access granted.\n"));
1230
1231	/* Multiconnection check must be made after authentication, so bad clients would not interfere with a good one. */
1232	BOOL allowMultiConnection = FALSE;
1233	hrc = mVRDEServer->COMGETTER(AllowMultiConnection)(&allowMultiConnection);
1234	AssertComRCReturn(hrc, VERR_ACCESS_DENIED);
1235
1236	BOOL reuseSingleConnection = FALSE;
1237	hrc = mVRDEServer->COMGETTER(ReuseSingleConnection)(&reuseSingleConnection);
1238	AssertComRCReturn(hrc, VERR_ACCESS_DENIED);
1239
1240	LogFlowFunc(("allowMultiConnection %d, reuseSingleConnection = %d, mcVRDPClients = %d, mu32SingleRDPClientId = %d\n",
1241	allowMultiConnection, reuseSingleConnection, mcVRDPClients, mu32SingleRDPClientId));
1242
1243	if (allowMultiConnection == FALSE)
1244	{
1245	/* Note: the 'mcVRDPClients' variable is incremented in ClientConnect callback, which is called when the client
1246	* is successfully connected, that is after the ClientLogon callback. Therefore the mcVRDPClients
1247	* value is 0 for first client.
1248	*/
1249	if (mcVRDPClients != 0)
1250	{
1251	Assert(mcVRDPClients == 1);
1252	/* There is a client already.
1253	* If required drop the existing client connection and let the connecting one in.
1254	*/
1255	if (reuseSingleConnection)
1256	{
1257	LogRel(("AUTH: Multiple connections are not enabled. Disconnecting existing client.\n"));
1258	mConsoleVRDPServer->DisconnectClient(mu32SingleRDPClientId, false);
1259	}
1260	else
1261	{
1262	/* Reject. */
1263	LogRel(("AUTH: Multiple connections are not enabled. Access denied.\n"));
1264	return VERR_ACCESS_DENIED;
1265	}
1266	}
1267
1268	/* Save the connected client id. From now on it will be necessary to disconnect this one. */
1269	mu32SingleRDPClientId = u32ClientId;
1270	}
1271
1272	#ifdef VBOX_WITH_GUEST_PROPS
1273	i_guestPropertiesVRDPUpdateLogon(u32ClientId, pszUser, pszDomain);
1274	#endif /* VBOX_WITH_GUEST_PROPS */
1275
1276	/* Check if the successfully verified credentials are to be sent to the guest. */
1277	BOOL fProvideGuestCredentials = FALSE;
1278
1279	Bstr value;
1280	hrc = mMachine->GetExtraData(Bstr("VRDP/ProvideGuestCredentials").raw(),
1281	value.asOutParam());
1282	if (SUCCEEDED(hrc) && value == "1")
1283	{
1284	/* Provide credentials only if there are no logged in users. */
1285	Bstr noLoggedInUsersValue;
1286	LONG64 ul64Timestamp = 0;
1287	Bstr flags;
1288
1289	hrc = i_getGuestProperty(Bstr("/VirtualBox/GuestInfo/OS/NoLoggedInUsers").raw(),
1290	noLoggedInUsersValue.asOutParam(), &ul64Timestamp, flags.asOutParam());
1291
1292	if (SUCCEEDED(hrc) && noLoggedInUsersValue != Bstr("false"))
1293	{
1294	/* And only if there are no connected clients. */
1295	if (ASMAtomicCmpXchgBool(&mcGuestCredentialsProvided, true, false))
1296	{
1297	fProvideGuestCredentials = TRUE;
1298	}
1299	}
1300	}
1301
1302	// @todo r=dj locking required here for m_pVMMDev?
1303	if ( fProvideGuestCredentials
1304	&& m_pVMMDev)
1305	{
1306	uint32_t u32GuestFlags = VMMDEV_SETCREDENTIALS_GUESTLOGON;
1307
1308	PPDMIVMMDEVPORT pDevPort = m_pVMMDev->getVMMDevPort();
1309	if (pDevPort)
1310	{
1311	int rc = pDevPort->pfnSetCredentials(m_pVMMDev->getVMMDevPort(),
1312	pszUser, pszPassword, pszDomain, u32GuestFlags);
1313	AssertRC(rc);
1314	}
1315	}
1316
1317	return VINF_SUCCESS;
1318	}
1319
1320	void Console::i_VRDPClientStatusChange(uint32_t u32ClientId, const char *pszStatus)
1321	{
1322	LogFlowFuncEnter();
1323
1324	AutoCaller autoCaller(this);
1325	AssertComRCReturnVoid(autoCaller.rc());
1326
1327	LogFlowFunc(("%s\n", pszStatus));
1328
1329	#ifdef VBOX_WITH_GUEST_PROPS
1330	/* Parse the status string. */
1331	if (RTStrICmp(pszStatus, "ATTACH") == 0)
1332	{
1333	i_guestPropertiesVRDPUpdateClientAttach(u32ClientId, true);
1334	}
1335	else if (RTStrICmp(pszStatus, "DETACH") == 0)
1336	{
1337	i_guestPropertiesVRDPUpdateClientAttach(u32ClientId, false);
1338	}
1339	else if (RTStrNICmp(pszStatus, "NAME=", strlen("NAME=")) == 0)
1340	{
1341	i_guestPropertiesVRDPUpdateNameChange(u32ClientId, pszStatus + strlen("NAME="));
1342	}
1343	else if (RTStrNICmp(pszStatus, "CIPA=", strlen("CIPA=")) == 0)
1344	{
1345	i_guestPropertiesVRDPUpdateIPAddrChange(u32ClientId, pszStatus + strlen("CIPA="));
1346	}
1347	else if (RTStrNICmp(pszStatus, "CLOCATION=", strlen("CLOCATION=")) == 0)
1348	{
1349	i_guestPropertiesVRDPUpdateLocationChange(u32ClientId, pszStatus + strlen("CLOCATION="));
1350	}
1351	else if (RTStrNICmp(pszStatus, "COINFO=", strlen("COINFO=")) == 0)
1352	{
1353	i_guestPropertiesVRDPUpdateOtherInfoChange(u32ClientId, pszStatus + strlen("COINFO="));
1354	}
1355	#endif
1356
1357	LogFlowFuncLeave();
1358	}
1359
1360	void Console::i_VRDPClientConnect(uint32_t u32ClientId)
1361	{
1362	LogFlowFuncEnter();
1363
1364	AutoCaller autoCaller(this);
1365	AssertComRCReturnVoid(autoCaller.rc());
1366
1367	uint32_t u32Clients = ASMAtomicIncU32(&mcVRDPClients);
1368	VMMDev *pDev;
1369	PPDMIVMMDEVPORT pPort;
1370	if ( (u32Clients == 1)
1371	&& ((pDev = i_getVMMDev()))
1372	&& ((pPort = pDev->getVMMDevPort()))
1373	)
1374	{
1375	pPort->pfnVRDPChange(pPort,
1376	true,
1377	VRDP_EXPERIENCE_LEVEL_FULL); // @todo configurable
1378	}
1379
1380	NOREF(u32ClientId);
1381	mDisplay->VideoAccelVRDP(true);
1382
1383	#ifdef VBOX_WITH_GUEST_PROPS
1384	i_guestPropertiesVRDPUpdateActiveClient(u32ClientId);
1385	#endif /* VBOX_WITH_GUEST_PROPS */
1386
1387	LogFlowFuncLeave();
1388	return;
1389	}
1390
1391	void Console::i_VRDPClientDisconnect(uint32_t u32ClientId,
1392	uint32_t fu32Intercepted)
1393	{
1394	LogFlowFuncEnter();
1395
1396	AutoCaller autoCaller(this);
1397	AssertComRCReturnVoid(autoCaller.rc());
1398
1399	AssertReturnVoid(mConsoleVRDPServer);
1400
1401	uint32_t u32Clients = ASMAtomicDecU32(&mcVRDPClients);
1402	VMMDev *pDev;
1403	PPDMIVMMDEVPORT pPort;
1404
1405	if ( (u32Clients == 0)
1406	&& ((pDev = i_getVMMDev()))
1407	&& ((pPort = pDev->getVMMDevPort()))
1408	)
1409	{
1410	pPort->pfnVRDPChange(pPort,
1411	false,
1412	0);
1413	}
1414
1415	mDisplay->VideoAccelVRDP(false);
1416
1417	if (fu32Intercepted & VRDE_CLIENT_INTERCEPT_USB)
1418	{
1419	mConsoleVRDPServer->USBBackendDelete(u32ClientId);
1420	}
1421
1422	if (fu32Intercepted & VRDE_CLIENT_INTERCEPT_CLIPBOARD)
1423	{
1424	mConsoleVRDPServer->ClipboardDelete(u32ClientId);
1425	}
1426
1427	if (fu32Intercepted & VRDE_CLIENT_INTERCEPT_AUDIO)
1428	{
1429	mcAudioRefs--;
1430
1431	if (mcAudioRefs <= 0)
1432	{
1433	#ifndef VBOX_WITH_PDM_AUDIO_DRIVER
1434	if (mAudioSniffer)
1435	{
1436	PPDMIAUDIOSNIFFERPORT port = mAudioSniffer->getAudioSnifferPort();
1437	if (port)
1438	{
1439	port->pfnSetup(port, false, false);
1440	}
1441	}
1442	#endif
1443	}
1444	}
1445
1446	Bstr uuid;
1447	HRESULT hrc = mMachine->COMGETTER(Id)(uuid.asOutParam());
1448	AssertComRC(hrc);
1449
1450	AuthType_T authType = AuthType_Null;
1451	hrc = mVRDEServer->COMGETTER(AuthType)(&authType);
1452	AssertComRC(hrc);
1453
1454	if (authType == AuthType_External)
1455	mConsoleVRDPServer->AuthDisconnect(uuid, u32ClientId);
1456
1457	#ifdef VBOX_WITH_GUEST_PROPS
1458	i_guestPropertiesVRDPUpdateDisconnect(u32ClientId);
1459	if (u32Clients == 0)
1460	i_guestPropertiesVRDPUpdateActiveClient(0);
1461	#endif /* VBOX_WITH_GUEST_PROPS */
1462
1463	if (u32Clients == 0)
1464	mcGuestCredentialsProvided = false;
1465
1466	LogFlowFuncLeave();
1467	return;
1468	}
1469
1470	void Console::i_VRDPInterceptAudio(uint32_t u32ClientId)
1471	{
1472	LogFlowFuncEnter();
1473
1474	AutoCaller autoCaller(this);
1475	AssertComRCReturnVoid(autoCaller.rc());
1476	#ifndef VBOX_WITH_PDM_AUDIO_DRIVER
1477	LogFlowFunc(("mAudioSniffer %p, u32ClientId %d.\n",
1478	mAudioSniffer, u32ClientId));
1479	NOREF(u32ClientId);
1480	#endif
1481
1482	++mcAudioRefs;
1483
1484	if (mcAudioRefs == 1)
1485	{
1486	#ifndef VBOX_WITH_PDM_AUDIO_DRIVER
1487	if (mAudioSniffer)
1488	{
1489	PPDMIAUDIOSNIFFERPORT port = mAudioSniffer->getAudioSnifferPort();
1490	if (port)
1491	{
1492	port->pfnSetup(port, true, true);
1493	}
1494	}
1495	#endif
1496	}
1497
1498	LogFlowFuncLeave();
1499	return;
1500	}
1501
1502	void Console::i_VRDPInterceptUSB(uint32_t u32ClientId, void **ppvIntercept)
1503	{
1504	LogFlowFuncEnter();
1505
1506	AutoCaller autoCaller(this);
1507	AssertComRCReturnVoid(autoCaller.rc());
1508
1509	AssertReturnVoid(mConsoleVRDPServer);
1510
1511	mConsoleVRDPServer->USBBackendCreate(u32ClientId, ppvIntercept);
1512
1513	LogFlowFuncLeave();
1514	return;
1515	}
1516
1517	void Console::i_VRDPInterceptClipboard(uint32_t u32ClientId)
1518	{
1519	LogFlowFuncEnter();
1520
1521	AutoCaller autoCaller(this);
1522	AssertComRCReturnVoid(autoCaller.rc());
1523
1524	AssertReturnVoid(mConsoleVRDPServer);
1525
1526	mConsoleVRDPServer->ClipboardCreate(u32ClientId);
1527
1528	LogFlowFuncLeave();
1529	return;
1530	}
1531
1532
1533	//static
1534	const char *Console::sSSMConsoleUnit = "ConsoleData";
1535	//static
1536	uint32_t Console::sSSMConsoleVer = 0x00010001;
1537
1538	inline static const char *networkAdapterTypeToName(NetworkAdapterType_T adapterType)
1539	{
1540	switch (adapterType)
1541	{
1542	case NetworkAdapterType_Am79C970A:
1543	case NetworkAdapterType_Am79C973:
1544	return "pcnet";
1545	#ifdef VBOX_WITH_E1000
1546	case NetworkAdapterType_I82540EM:
1547	case NetworkAdapterType_I82543GC:
1548	case NetworkAdapterType_I82545EM:
1549	return "e1000";
1550	#endif
1551	#ifdef VBOX_WITH_VIRTIO
1552	case NetworkAdapterType_Virtio:
1553	return "virtio-net";
1554	#endif
1555	default:
1556	AssertFailed();
1557	return "unknown";
1558	}
1559	return NULL;
1560	}
1561
1562	/**
1563	* Loads various console data stored in the saved state file.
1564	* This method does validation of the state file and returns an error info
1565	* when appropriate.
1566	*
1567	* The method does nothing if the machine is not in the Saved file or if
1568	* console data from it has already been loaded.
1569	*
1570	* @note The caller must lock this object for writing.
1571	*/
1572	HRESULT Console::i_loadDataFromSavedState()
1573	{
1574	if (mMachineState != MachineState_Saved \|\| mSavedStateDataLoaded)
1575	return S_OK;
1576
1577	Bstr savedStateFile;
1578	HRESULT rc = mMachine->COMGETTER(StateFilePath)(savedStateFile.asOutParam());
1579	if (FAILED(rc))
1580	return rc;
1581
1582	PSSMHANDLE ssm;
1583	int vrc = SSMR3Open(Utf8Str(savedStateFile).c_str(), 0, &ssm);
1584	if (RT_SUCCESS(vrc))
1585	{
1586	uint32_t version = 0;
1587	vrc = SSMR3Seek(ssm, sSSMConsoleUnit, 0 /* iInstance */, &version);
1588	if (SSM_VERSION_MAJOR(version) == SSM_VERSION_MAJOR(sSSMConsoleVer))
1589	{
1590	if (RT_SUCCESS(vrc))
1591	vrc = i_loadStateFileExecInternal(ssm, version);
1592	else if (vrc == VERR_SSM_UNIT_NOT_FOUND)
1593	vrc = VINF_SUCCESS;
1594	}
1595	else
1596	vrc = VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1597
1598	SSMR3Close(ssm);
1599	}
1600
1601	if (RT_FAILURE(vrc))
1602	rc = setError(VBOX_E_FILE_ERROR,
1603	tr("The saved state file '%ls' is invalid (%Rrc). Delete the saved state and try again"),
1604	savedStateFile.raw(), vrc);
1605
1606	mSavedStateDataLoaded = true;
1607
1608	return rc;
1609	}
1610
1611	/**
1612	* Callback handler to save various console data to the state file,
1613	* called when the user saves the VM state.
1614	*
1615	* @param pvUser pointer to Console
1616	*
1617	* @note Locks the Console object for reading.
1618	*/
1619	//static
1620	DECLCALLBACK(void) Console::i_saveStateFileExec(PSSMHANDLE pSSM, void *pvUser)
1621	{
1622	LogFlowFunc(("\n"));
1623
1624	Console that = static_cast<Console >(pvUser);
1625	AssertReturnVoid(that);
1626
1627	AutoCaller autoCaller(that);
1628	AssertComRCReturnVoid(autoCaller.rc());
1629
1630	AutoReadLock alock(that COMMA_LOCKVAL_SRC_POS);
1631
1632	int vrc = SSMR3PutU32(pSSM, (uint32_t)that->m_mapSharedFolders.size());
1633	AssertRC(vrc);
1634
1635	for (SharedFolderMap::const_iterator it = that->m_mapSharedFolders.begin();
1636	it != that->m_mapSharedFolders.end();
1637	++it)
1638	{
1639	SharedFolder pSF = (it).second;
1640	AutoCaller sfCaller(pSF);
1641	AutoReadLock sfLock(pSF COMMA_LOCKVAL_SRC_POS);
1642
1643	Utf8Str name = pSF->i_getName();
1644	vrc = SSMR3PutU32(pSSM, (uint32_t)name.length() + 1 /* term. 0 */);
1645	AssertRC(vrc);
1646	vrc = SSMR3PutStrZ(pSSM, name.c_str());
1647	AssertRC(vrc);
1648
1649	Utf8Str hostPath = pSF->i_getHostPath();
1650	vrc = SSMR3PutU32(pSSM, (uint32_t)hostPath.length() + 1 /* term. 0 */);
1651	AssertRC(vrc);
1652	vrc = SSMR3PutStrZ(pSSM, hostPath.c_str());
1653	AssertRC(vrc);
1654
1655	vrc = SSMR3PutBool(pSSM, !!pSF->i_isWritable());
1656	AssertRC(vrc);
1657
1658	vrc = SSMR3PutBool(pSSM, !!pSF->i_isAutoMounted());
1659	AssertRC(vrc);
1660	}
1661
1662	return;
1663	}
1664
1665	/**
1666	* Callback handler to load various console data from the state file.
1667	* Called when the VM is being restored from the saved state.
1668	*
1669	* @param pvUser pointer to Console
1670	* @param uVersion Console unit version.
1671	* Should match sSSMConsoleVer.
1672	* @param uPass The data pass.
1673	*
1674	* @note Should locks the Console object for writing, if necessary.
1675	*/
1676	//static
1677	DECLCALLBACK(int)
1678	Console::i_loadStateFileExec(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass)
1679	{
1680	LogFlowFunc(("\n"));
1681
1682	if (SSM_VERSION_MAJOR_CHANGED(uVersion, sSSMConsoleVer))
1683	return VERR_VERSION_MISMATCH;
1684	Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
1685
1686	Console that = static_cast<Console >(pvUser);
1687	AssertReturn(that, VERR_INVALID_PARAMETER);
1688
1689	/* Currently, nothing to do when we've been called from VMR3Load. /
1690	return SSMR3SkipToEndOfUnit(pSSM);
1691	}
1692
1693	/**
1694	* Method to load various console data from the state file.
1695	* Called from #loadDataFromSavedState.
1696	*
1697	* @param pvUser pointer to Console
1698	* @param u32Version Console unit version.
1699	* Should match sSSMConsoleVer.
1700	*
1701	* @note Locks the Console object for writing.
1702	*/
1703	int Console::i_loadStateFileExecInternal(PSSMHANDLE pSSM, uint32_t u32Version)
1704	{
1705	AutoCaller autoCaller(this);
1706	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
1707
1708	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1709
1710	AssertReturn(m_mapSharedFolders.size() == 0, VERR_INTERNAL_ERROR);
1711
1712	uint32_t size = 0;
1713	int vrc = SSMR3GetU32(pSSM, &size);
1714	AssertRCReturn(vrc, vrc);
1715
1716	for (uint32_t i = 0; i < size; ++i)
1717	{
1718	Utf8Str strName;
1719	Utf8Str strHostPath;
1720	bool writable = true;
1721	bool autoMount = false;
1722
1723	uint32_t szBuf = 0;
1724	char *buf = NULL;
1725
1726	vrc = SSMR3GetU32(pSSM, &szBuf);
1727	AssertRCReturn(vrc, vrc);
1728	buf = new char[szBuf];
1729	vrc = SSMR3GetStrZ(pSSM, buf, szBuf);
1730	AssertRC(vrc);
1731	strName = buf;
1732	delete[] buf;
1733
1734	vrc = SSMR3GetU32(pSSM, &szBuf);
1735	AssertRCReturn(vrc, vrc);
1736	buf = new char[szBuf];
1737	vrc = SSMR3GetStrZ(pSSM, buf, szBuf);
1738	AssertRC(vrc);
1739	strHostPath = buf;
1740	delete[] buf;
1741
1742	if (u32Version > 0x00010000)
1743	SSMR3GetBool(pSSM, &writable);
1744
1745	if (u32Version > 0x00010000) // ???
1746	SSMR3GetBool(pSSM, &autoMount);
1747
1748	ComObjPtr<SharedFolder> pSharedFolder;
1749	pSharedFolder.createObject();
1750	HRESULT rc = pSharedFolder->init(this,
1751	strName,
1752	strHostPath,
1753	writable,
1754	autoMount,
1755	false /* fFailOnError */);
1756	AssertComRCReturn(rc, VERR_INTERNAL_ERROR);
1757
1758	m_mapSharedFolders.insert(std::make_pair(strName, pSharedFolder));
1759	}
1760
1761	return VINF_SUCCESS;
1762	}
1763
1764	#ifdef VBOX_WITH_GUEST_PROPS
1765
1766	// static
1767	DECLCALLBACK(int) Console::i_doGuestPropNotification(void *pvExtension,
1768	uint32_t u32Function,
1769	void *pvParms,
1770	uint32_t cbParms)
1771	{
1772	using namespace guestProp;
1773
1774	Assert(u32Function == 0); NOREF(u32Function);
1775
1776	/*
1777	* No locking, as this is purely a notification which does not make any
1778	* changes to the object state.
1779	*/
1780	PHOSTCALLBACKDATA pCBData = reinterpret_cast<PHOSTCALLBACKDATA>(pvParms);
1781	AssertReturn(sizeof(HOSTCALLBACKDATA) == cbParms, VERR_INVALID_PARAMETER);
1782	AssertReturn(HOSTCALLBACKMAGIC == pCBData->u32Magic, VERR_INVALID_PARAMETER);
1783	LogFlow(("Console::doGuestPropNotification: pCBData={.pcszName=%s, .pcszValue=%s, .pcszFlags=%s}\n",
1784	pCBData->pcszName, pCBData->pcszValue, pCBData->pcszFlags));
1785
1786	int rc;
1787	Bstr name(pCBData->pcszName);
1788	Bstr value(pCBData->pcszValue);
1789	Bstr flags(pCBData->pcszFlags);
1790	ComObjPtr<Console> pConsole = reinterpret_cast<Console *>(pvExtension);
1791	HRESULT hrc = pConsole->mControl->PushGuestProperty(name.raw(),
1792	value.raw(),
1793	pCBData->u64Timestamp,
1794	flags.raw());
1795	if (SUCCEEDED(hrc))
1796	rc = VINF_SUCCESS;
1797	else
1798	{
1799	LogFlow(("Console::doGuestPropNotification: hrc=%Rhrc pCBData={.pcszName=%s, .pcszValue=%s, .pcszFlags=%s}\n",
1800	hrc, pCBData->pcszName, pCBData->pcszValue, pCBData->pcszFlags));
1801	rc = Global::vboxStatusCodeFromCOM(hrc);
1802	}
1803	return rc;
1804	}
1805
1806	HRESULT Console::i_doEnumerateGuestProperties(CBSTR aPatterns,
1807	ComSafeArrayOut(BSTR, aNames),
1808	ComSafeArrayOut(BSTR, aValues),
1809	ComSafeArrayOut(LONG64, aTimestamps),
1810	ComSafeArrayOut(BSTR, aFlags))
1811	{
1812	AssertReturn(m_pVMMDev, E_FAIL);
1813
1814	using namespace guestProp;
1815
1816	VBOXHGCMSVCPARM parm[3];
1817
1818	Utf8Str utf8Patterns(aPatterns);
1819	parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
1820	parm[0].u.pointer.addr = (void*)utf8Patterns.c_str();
1821	parm[0].u.pointer.size = (uint32_t)utf8Patterns.length() + 1;
1822
1823	/*
1824	* Now things get slightly complicated. Due to a race with the guest adding
1825	* properties, there is no good way to know how much to enlarge a buffer for
1826	* the service to enumerate into. We choose a decent starting size and loop a
1827	* few times, each time retrying with the size suggested by the service plus
1828	* one Kb.
1829	*/
1830	size_t cchBuf = 4096;
1831	Utf8Str Utf8Buf;
1832	int vrc = VERR_BUFFER_OVERFLOW;
1833	for (unsigned i = 0; i < 10 && (VERR_BUFFER_OVERFLOW == vrc); ++i)
1834	{
1835	try
1836	{
1837	Utf8Buf.reserve(cchBuf + 1024);
1838	}
1839	catch(...)
1840	{
1841	return E_OUTOFMEMORY;
1842	}
1843	parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
1844	parm[1].u.pointer.addr = Utf8Buf.mutableRaw();
1845	parm[1].u.pointer.size = (uint32_t)cchBuf + 1024;
1846	vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", ENUM_PROPS_HOST, 3,
1847	&parm[0]);
1848	Utf8Buf.jolt();
1849	if (parm[2].type != VBOX_HGCM_SVC_PARM_32BIT)
1850	return setError(E_FAIL, tr("Internal application error"));
1851	cchBuf = parm[2].u.uint32;
1852	}
1853	if (VERR_BUFFER_OVERFLOW == vrc)
1854	return setError(E_UNEXPECTED,
1855	tr("Temporary failure due to guest activity, please retry"));
1856
1857	/*
1858	* Finally we have to unpack the data returned by the service into the safe
1859	* arrays supplied by the caller. We start by counting the number of entries.
1860	*/
1861	const char *pszBuf
1862	= reinterpret_cast<const char *>(parm[1].u.pointer.addr);
1863	unsigned cEntries = 0;
1864	/* The list is terminated by a zero-length string at the end of a set
1865	* of four strings. */
1866	for (size_t i = 0; strlen(pszBuf + i) != 0; )
1867	{
1868	/* We are counting sets of four strings. */
1869	for (unsigned j = 0; j < 4; ++j)
1870	i += strlen(pszBuf + i) + 1;
1871	++cEntries;
1872	}
1873
1874	/*
1875	* And now we create the COM safe arrays and fill them in.
1876	*/
1877	com::SafeArray<BSTR> names(cEntries);
1878	com::SafeArray<BSTR> values(cEntries);
1879	com::SafeArray<LONG64> timestamps(cEntries);
1880	com::SafeArray<BSTR> flags(cEntries);
1881	size_t iBuf = 0;
1882	/* Rely on the service to have formated the data correctly. */
1883	for (unsigned i = 0; i < cEntries; ++i)
1884	{
1885	size_t cchName = strlen(pszBuf + iBuf);
1886	Bstr(pszBuf + iBuf).detachTo(&names[i]);
1887	iBuf += cchName + 1;
1888	size_t cchValue = strlen(pszBuf + iBuf);
1889	Bstr(pszBuf + iBuf).detachTo(&values[i]);
1890	iBuf += cchValue + 1;
1891	size_t cchTimestamp = strlen(pszBuf + iBuf);
1892	timestamps[i] = RTStrToUInt64(pszBuf + iBuf);
1893	iBuf += cchTimestamp + 1;
1894	size_t cchFlags = strlen(pszBuf + iBuf);
1895	Bstr(pszBuf + iBuf).detachTo(&flags[i]);
1896	iBuf += cchFlags + 1;
1897	}
1898	names.detachTo(ComSafeArrayOutArg(aNames));
1899	values.detachTo(ComSafeArrayOutArg(aValues));
1900	timestamps.detachTo(ComSafeArrayOutArg(aTimestamps));
1901	flags.detachTo(ComSafeArrayOutArg(aFlags));
1902	return S_OK;
1903	}
1904
1905	#endif /* VBOX_WITH_GUEST_PROPS */
1906
1907
1908	// IConsole properties
1909	/////////////////////////////////////////////////////////////////////////////
1910	HRESULT Console::getMachine(ComPtr<IMachine> &aMachine)
1911	{
1912	/* mMachine is constant during life time, no need to lock */
1913	mMachine.queryInterfaceTo(aMachine.asOutParam());
1914
1915	/* callers expect to get a valid reference, better fail than crash them */
1916	if (mMachine.isNull())
1917	return E_FAIL;
1918
1919	return S_OK;
1920	}
1921
1922	HRESULT Console::getState(MachineState_T *aState)
1923	{
1924	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1925
1926	/* we return our local state (since it's always the same as on the server) */
1927	*aState = mMachineState;
1928
1929	return S_OK;
1930	}
1931
1932	HRESULT Console::getGuest(ComPtr<IGuest> &aGuest)
1933	{
1934	/* mGuest is constant during life time, no need to lock */
1935	mGuest.queryInterfaceTo(aGuest.asOutParam());
1936
1937	return S_OK;
1938	}
1939
1940	HRESULT Console::getKeyboard(ComPtr<IKeyboard> &aKeyboard)
1941	{
1942	/* mKeyboard is constant during life time, no need to lock */
1943	mKeyboard.queryInterfaceTo(aKeyboard.asOutParam());
1944
1945	return S_OK;
1946	}
1947
1948	HRESULT Console::getMouse(ComPtr<IMouse> &aMouse)
1949	{
1950	/* mMouse is constant during life time, no need to lock */
1951	mMouse.queryInterfaceTo(aMouse.asOutParam());
1952
1953	return S_OK;
1954	}
1955
1956	HRESULT Console::getDisplay(ComPtr<IDisplay> &aDisplay)
1957	{
1958	/* mDisplay is constant during life time, no need to lock */
1959	mDisplay.queryInterfaceTo(aDisplay.asOutParam());
1960
1961	return S_OK;
1962	}
1963
1964	HRESULT Console::getDebugger(ComPtr<IMachineDebugger> &aDebugger)
1965	{
1966	/* we need a write lock because of the lazy mDebugger initialization*/
1967	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1968
1969	/* check if we have to create the debugger object */
1970	if (!mDebugger)
1971	{
1972	unconst(mDebugger).createObject();
1973	mDebugger->init(this);
1974	}
1975
1976	mDebugger.queryInterfaceTo(aDebugger.asOutParam());
1977
1978	return S_OK;
1979	}
1980
1981	HRESULT Console::getUSBDevices(std::vector<ComPtr<IUSBDevice> > &aUSBDevices)
1982	{
1983	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1984
1985	size_t i = 0;
1986	aUSBDevices.resize(mUSBDevices.size());
1987	for (USBDeviceList::const_iterator it = mUSBDevices.begin(); it != mUSBDevices.end(); ++i, ++it)
1988	(*it).queryInterfaceTo(aUSBDevices[i].asOutParam());
1989
1990	return S_OK;
1991	}
1992
1993
1994	HRESULT Console::getRemoteUSBDevices(std::vector<ComPtr<IHostUSBDevice> > &aRemoteUSBDevices)
1995	{
1996	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1997
1998	size_t i = 0;
1999	aRemoteUSBDevices.resize(mRemoteUSBDevices.size());
2000	for (RemoteUSBDeviceList::const_iterator it = mRemoteUSBDevices.begin(); it != mRemoteUSBDevices.end(); ++i, ++it)
2001	(*it).queryInterfaceTo(aRemoteUSBDevices[i].asOutParam());
2002
2003	return S_OK;
2004	}
2005
2006	HRESULT Console::getVRDEServerInfo(ComPtr<IVRDEServerInfo> &aVRDEServerInfo)
2007	{
2008	/* mVRDEServerInfo is constant during life time, no need to lock */
2009	mVRDEServerInfo.queryInterfaceTo(aVRDEServerInfo.asOutParam());
2010
2011	return S_OK;
2012	}
2013
2014	HRESULT Console::getEmulatedUSB(ComPtr<IEmulatedUSB> &aEmulatedUSB)
2015	{
2016	/* mEmulatedUSB is constant during life time, no need to lock */
2017	mEmulatedUSB.queryInterfaceTo(aEmulatedUSB.asOutParam());
2018
2019	return S_OK;
2020	}
2021
2022	HRESULT Console::getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders)
2023	{
2024	/* loadDataFromSavedState() needs a write lock */
2025	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2026
2027	/* Read console data stored in the saved state file (if not yet done) */
2028	HRESULT rc = i_loadDataFromSavedState();
2029	if (FAILED(rc)) return rc;
2030
2031	size_t i = 0;
2032	aSharedFolders.resize(m_mapSharedFolders.size());
2033	for (SharedFolderMap::const_iterator it = m_mapSharedFolders.begin(); it != m_mapSharedFolders.end(); ++i, ++it)
2034	(it)->second.queryInterfaceTo(aSharedFolders[i].asOutParam());
2035
2036	return S_OK;
2037	}
2038
2039	HRESULT Console::getEventSource(ComPtr<IEventSource> &aEventSource)
2040	{
2041	// no need to lock - lifetime constant
2042	mEventSource.queryInterfaceTo(aEventSource.asOutParam());
2043
2044	return S_OK;
2045	}
2046
2047	HRESULT Console::getAttachedPCIDevices(std::vector<ComPtr<IPCIDeviceAttachment> > &aAttachedPCIDevices)
2048	{
2049	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2050
2051	if (mBusMgr)
2052	mBusMgr->listAttachedPCIDevices(aAttachedPCIDevices);
2053	else
2054	aAttachedPCIDevices.resize(0);
2055
2056	return S_OK;
2057	}
2058
2059	HRESULT Console::getUseHostClipboard(BOOL *aUseHostClipboard)
2060	{
2061	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2062
2063	*aUseHostClipboard = mfUseHostClipboard;
2064
2065	return S_OK;
2066	}
2067
2068	HRESULT Console::setUseHostClipboard(BOOL aUseHostClipboard)
2069	{
2070	mfUseHostClipboard = !!aUseHostClipboard;
2071
2072	return S_OK;
2073	}
2074
2075	// IConsole methods
2076	/////////////////////////////////////////////////////////////////////////////
2077
2078	HRESULT Console::powerUp(ComPtr<IProgress> &aProgress)
2079	{
2080	ComObjPtr<IProgress> pProgress;
2081	i_powerUp(pProgress.asOutParam(), false /* aPaused */);
2082	pProgress.queryInterfaceTo(aProgress.asOutParam());
2083	return S_OK;
2084	}
2085
2086	HRESULT Console::powerUpPaused(ComPtr<IProgress> &aProgress)
2087	{
2088	ComObjPtr<IProgress> pProgress;
2089	i_powerUp(pProgress.asOutParam(), true /* aPaused */);
2090	pProgress.queryInterfaceTo(aProgress.asOutParam());
2091	return S_OK;
2092	}
2093
2094	HRESULT Console::powerDown(ComPtr<IProgress> &aProgress)
2095	{
2096	LogFlowThisFuncEnter();
2097
2098	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2099
2100	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
2101	switch (mMachineState)
2102	{
2103	case MachineState_Running:
2104	case MachineState_Paused:
2105	case MachineState_Stuck:
2106	break;
2107
2108	/* Try cancel the teleportation. */
2109	case MachineState_Teleporting:
2110	case MachineState_TeleportingPausedVM:
2111	if (!mptrCancelableProgress.isNull())
2112	{
2113	HRESULT hrc = mptrCancelableProgress->Cancel();
2114	if (SUCCEEDED(hrc))
2115	break;
2116	}
2117	return setError(VBOX_E_INVALID_VM_STATE, tr("Cannot power down at this point in a teleportation"));
2118
2119	/* Try cancel the live snapshot. */
2120	case MachineState_LiveSnapshotting:
2121	if (!mptrCancelableProgress.isNull())
2122	{
2123	HRESULT hrc = mptrCancelableProgress->Cancel();
2124	if (SUCCEEDED(hrc))
2125	break;
2126	}
2127	return setError(VBOX_E_INVALID_VM_STATE, tr("Cannot power down at this point in a live snapshot"));
2128
2129	/* Try cancel the FT sync. */
2130	case MachineState_FaultTolerantSyncing:
2131	if (!mptrCancelableProgress.isNull())
2132	{
2133	HRESULT hrc = mptrCancelableProgress->Cancel();
2134	if (SUCCEEDED(hrc))
2135	break;
2136	}
2137	return setError(VBOX_E_INVALID_VM_STATE, tr("Cannot power down at this point in a fault tolerant sync"));
2138
2139	/* extra nice error message for a common case */
2140	case MachineState_Saved:
2141	return setError(VBOX_E_INVALID_VM_STATE, tr("Cannot power down a saved virtual machine"));
2142	case MachineState_Stopping:
2143	return setError(VBOX_E_INVALID_VM_STATE, tr("The virtual machine is being powered down"));
2144	default:
2145	return setError(VBOX_E_INVALID_VM_STATE,
2146	tr("Invalid machine state: %s (must be Running, Paused or Stuck)"),
2147	Global::stringifyMachineState(mMachineState));
2148	}
2149
2150	LogFlowThisFunc(("Initiating SHUTDOWN request...\n"));
2151
2152	/* memorize the current machine state */
2153	MachineState_T lastMachineState = mMachineState;
2154
2155	HRESULT rc = S_OK;
2156	bool fBeganPowerDown = false;
2157
2158	do
2159	{
2160	ComPtr<IProgress> pProgress;
2161
2162	#ifdef VBOX_WITH_GUEST_PROPS
2163	alock.release();
2164
2165	if (i_isResetTurnedIntoPowerOff())
2166	{
2167	mMachine->DeleteGuestProperty(Bstr("/VirtualBox/HostInfo/VMPowerOffReason").raw());
2168	mMachine->SetGuestProperty(Bstr("/VirtualBox/HostInfo/VMPowerOffReason").raw(),
2169	Bstr("PowerOff").raw(), Bstr("RDONLYGUEST").raw());
2170	mMachine->SaveSettings();
2171	}
2172
2173	alock.acquire();
2174	#endif
2175
2176	/*
2177	* request a progress object from the server
2178	* (this will set the machine state to Stopping on the server to block
2179	* others from accessing this machine)
2180	*/
2181	rc = mControl->BeginPoweringDown(pProgress.asOutParam());
2182	if (FAILED(rc))
2183	break;
2184
2185	fBeganPowerDown = true;
2186
2187	/* sync the state with the server */
2188	i_setMachineStateLocally(MachineState_Stopping);
2189
2190	/* setup task object and thread to carry out the operation asynchronously */
2191	std::auto_ptr<VMPowerDownTask> task(new VMPowerDownTask(this, pProgress));
2192	AssertBreakStmt(task->isOk(), rc = E_FAIL);
2193
2194	int vrc = RTThreadCreate(NULL, Console::i_powerDownThread,
2195	(void *) task.get(), 0,
2196	RTTHREADTYPE_MAIN_WORKER, 0,
2197	"VMPwrDwn");
2198	if (RT_FAILURE(vrc))
2199	{
2200	rc = setError(E_FAIL, "Could not create VMPowerDown thread (%Rrc)", vrc);
2201	break;
2202	}
2203
2204	/* task is now owned by powerDownThread(), so release it */
2205	task.release();
2206
2207	/* pass the progress to the caller */
2208	pProgress.queryInterfaceTo(aProgress.asOutParam());
2209	}
2210	while (0);
2211
2212	if (FAILED(rc))
2213	{
2214	/* preserve existing error info */
2215	ErrorInfoKeeper eik;
2216
2217	if (fBeganPowerDown)
2218	{
2219	/*
2220	* cancel the requested power down procedure.
2221	* This will reset the machine state to the state it had right
2222	* before calling mControl->BeginPoweringDown().
2223	*/
2224	mControl->EndPoweringDown(eik.getResultCode(), eik.getText().raw()); }
2225
2226	i_setMachineStateLocally(lastMachineState);
2227	}
2228
2229	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2230	LogFlowThisFuncLeave();
2231
2232	return rc;
2233	}
2234
2235	HRESULT Console::reset()
2236	{
2237	LogFlowThisFuncEnter();
2238
2239	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2240
2241	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
2242	if ( mMachineState != MachineState_Running
2243	&& mMachineState != MachineState_Teleporting
2244	&& mMachineState != MachineState_LiveSnapshotting
2245	/** @todo r=bird: This should be allowed on paused VMs as well. Later. */
2246	)
2247	return i_setInvalidMachineStateError();
2248
2249	/* protect mpUVM */
2250	SafeVMPtr ptrVM(this);
2251	if (!ptrVM.isOk())
2252	return ptrVM.rc();
2253
2254	/* release the lock before a VMR3* call (EMT will call us back)! */
2255	alock.release();
2256
2257	int vrc = VMR3Reset(ptrVM.rawUVM());
2258
2259	HRESULT rc = RT_SUCCESS(vrc) ? S_OK :
2260	setError(VBOX_E_VM_ERROR,
2261	tr("Could not reset the machine (%Rrc)"),
2262	vrc);
2263
2264	LogFlowThisFunc(("mMachineState=%d, rc=%Rhrc\n", mMachineState, rc));
2265	LogFlowThisFuncLeave();
2266	return rc;
2267	}
2268
2269	/static/ DECLCALLBACK(int) Console::i_unplugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu)
2270	{
2271	LogFlowFunc(("pThis=%p pVM=%p idCpu=%u\n", pThis, pUVM, idCpu));
2272
2273	AssertReturn(pThis, VERR_INVALID_PARAMETER);
2274
2275	int vrc = PDMR3DeviceDetach(pUVM, "acpi", 0, idCpu, 0);
2276	Log(("UnplugCpu: rc=%Rrc\n", vrc));
2277
2278	return vrc;
2279	}
2280
2281	HRESULT Console::i_doCPURemove(ULONG aCpu, PUVM pUVM)
2282	{
2283	HRESULT rc = S_OK;
2284
2285	LogFlowThisFuncEnter();
2286
2287	AutoCaller autoCaller(this);
2288	if (FAILED(autoCaller.rc())) return autoCaller.rc();
2289
2290	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2291
2292	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
2293	AssertReturn(m_pVMMDev, E_FAIL);
2294	PPDMIVMMDEVPORT pVmmDevPort = m_pVMMDev->getVMMDevPort();
2295	AssertReturn(pVmmDevPort, E_FAIL);
2296
2297	if ( mMachineState != MachineState_Running
2298	&& mMachineState != MachineState_Teleporting
2299	&& mMachineState != MachineState_LiveSnapshotting
2300	)
2301	return i_setInvalidMachineStateError();
2302
2303	/* Check if the CPU is present */
2304	BOOL fCpuAttached;
2305	rc = mMachine->GetCPUStatus(aCpu, &fCpuAttached);
2306	if (FAILED(rc))
2307	return rc;
2308	if (!fCpuAttached)
2309	return setError(E_FAIL, tr("CPU %d is not attached"), aCpu);
2310
2311	/* Leave the lock before any EMT/VMMDev call. */
2312	alock.release();
2313	bool fLocked = true;
2314
2315	/* Check if the CPU is unlocked */
2316	PPDMIBASE pBase;
2317	int vrc = PDMR3QueryDeviceLun(pUVM, "acpi", 0, aCpu, &pBase);
2318	if (RT_SUCCESS(vrc))
2319	{
2320	Assert(pBase);
2321	PPDMIACPIPORT pApicPort = PDMIBASE_QUERY_INTERFACE(pBase, PDMIACPIPORT);
2322
2323	/* Notify the guest if possible. */
2324	uint32_t idCpuCore, idCpuPackage;
2325	vrc = VMR3GetCpuCoreAndPackageIdFromCpuId(pUVM, aCpu, &idCpuCore, &idCpuPackage); AssertRC(vrc);
2326	if (RT_SUCCESS(vrc))
2327	vrc = pVmmDevPort->pfnCpuHotUnplug(pVmmDevPort, idCpuCore, idCpuPackage);
2328	if (RT_SUCCESS(vrc))
2329	{
2330	unsigned cTries = 100;
2331	do
2332	{
2333	/* It will take some time until the event is processed in the guest. Wait... */
2334	vrc = pApicPort ? pApicPort->pfnGetCpuStatus(pApicPort, aCpu, &fLocked) : VERR_INVALID_POINTER;
2335	if (RT_SUCCESS(vrc) && !fLocked)
2336	break;
2337
2338	/* Sleep a bit */
2339	RTThreadSleep(100);
2340	} while (cTries-- > 0);
2341	}
2342	else if (vrc == VERR_CPU_HOTPLUG_NOT_MONITORED_BY_GUEST)
2343	{
2344	/* Query one time. It is possible that the user ejected the CPU. */
2345	vrc = pApicPort ? pApicPort->pfnGetCpuStatus(pApicPort, aCpu, &fLocked) : VERR_INVALID_POINTER;
2346	}
2347	}
2348
2349	/* If the CPU was unlocked we can detach it now. */
2350	if (RT_SUCCESS(vrc) && !fLocked)
2351	{
2352	/*
2353	* Call worker in EMT, that's faster and safer than doing everything
2354	* using VMR3ReqCall.
2355	*/
2356	PVMREQ pReq;
2357	vrc = VMR3ReqCallU(pUVM, 0, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
2358	(PFNRT)i_unplugCpu, 3,
2359	this, pUVM, (VMCPUID)aCpu);
2360	if (vrc == VERR_TIMEOUT \|\| RT_SUCCESS(vrc))
2361	{
2362	vrc = VMR3ReqWait(pReq, RT_INDEFINITE_WAIT);
2363	AssertRC(vrc);
2364	if (RT_SUCCESS(vrc))
2365	vrc = pReq->iStatus;
2366	}
2367	VMR3ReqFree(pReq);
2368
2369	if (RT_SUCCESS(vrc))
2370	{
2371	/* Detach it from the VM */
2372	vrc = VMR3HotUnplugCpu(pUVM, aCpu);
2373	AssertRC(vrc);
2374	}
2375	else
2376	rc = setError(VBOX_E_VM_ERROR,
2377	tr("Hot-Remove failed (rc=%Rrc)"), vrc);
2378	}
2379	else
2380	rc = setError(VBOX_E_VM_ERROR,
2381	tr("Hot-Remove was aborted because the CPU may still be used by the guest"), VERR_RESOURCE_BUSY);
2382
2383	LogFlowThisFunc(("mMachineState=%d, rc=%Rhrc\n", mMachineState, rc));
2384	LogFlowThisFuncLeave();
2385	return rc;
2386	}
2387
2388	/static/ DECLCALLBACK(int) Console::i_plugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu)
2389	{
2390	LogFlowFunc(("pThis=%p uCpu=%u\n", pThis, idCpu));
2391
2392	AssertReturn(pThis, VERR_INVALID_PARAMETER);
2393
2394	int rc = VMR3HotPlugCpu(pUVM, idCpu);
2395	AssertRC(rc);
2396
2397	PCFGMNODE pInst = CFGMR3GetChild(CFGMR3GetRootU(pUVM), "Devices/acpi/0/");
2398	AssertRelease(pInst);
2399	/* nuke anything which might have been left behind. */
2400	CFGMR3RemoveNode(CFGMR3GetChildF(pInst, "LUN#%u", idCpu));
2401
2402	#define RC_CHECK() do { if (RT_FAILURE(rc)) { AssertReleaseRC(rc); break; } } while (0)
2403
2404	PCFGMNODE pLunL0;
2405	PCFGMNODE pCfg;
2406	rc = CFGMR3InsertNodeF(pInst, &pLunL0, "LUN#%u", idCpu); RC_CHECK();
2407	rc = CFGMR3InsertString(pLunL0, "Driver", "ACPICpu"); RC_CHECK();
2408	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
2409
2410	/*
2411	* Attach the driver.
2412	*/
2413	PPDMIBASE pBase;
2414	rc = PDMR3DeviceAttach(pUVM, "acpi", 0, idCpu, 0, &pBase); RC_CHECK();
2415
2416	Log(("PlugCpu: rc=%Rrc\n", rc));
2417
2418	CFGMR3Dump(pInst);
2419
2420	#undef RC_CHECK
2421
2422	return VINF_SUCCESS;
2423	}
2424
2425	HRESULT Console::i_doCPUAdd(ULONG aCpu, PUVM pUVM)
2426	{
2427	HRESULT rc = S_OK;
2428
2429	LogFlowThisFuncEnter();
2430
2431	AutoCaller autoCaller(this);
2432	if (FAILED(autoCaller.rc())) return autoCaller.rc();
2433
2434	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2435
2436	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
2437	if ( mMachineState != MachineState_Running
2438	&& mMachineState != MachineState_Teleporting
2439	&& mMachineState != MachineState_LiveSnapshotting
2440	/** @todo r=bird: This should be allowed on paused VMs as well. Later. */
2441	)
2442	return i_setInvalidMachineStateError();
2443
2444	AssertReturn(m_pVMMDev, E_FAIL);
2445	PPDMIVMMDEVPORT pDevPort = m_pVMMDev->getVMMDevPort();
2446	AssertReturn(pDevPort, E_FAIL);
2447
2448	/* Check if the CPU is present */
2449	BOOL fCpuAttached;
2450	rc = mMachine->GetCPUStatus(aCpu, &fCpuAttached);
2451	if (FAILED(rc)) return rc;
2452
2453	if (fCpuAttached)
2454	return setError(E_FAIL,
2455	tr("CPU %d is already attached"), aCpu);
2456
2457	/*
2458	* Call worker in EMT, that's faster and safer than doing everything
2459	* using VMR3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
2460	* here to make requests from under the lock in order to serialize them.
2461	*/
2462	PVMREQ pReq;
2463	int vrc = VMR3ReqCallU(pUVM, 0, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
2464	(PFNRT)i_plugCpu, 3,
2465	this, pUVM, aCpu);
2466
2467	/* release the lock before a VMR3* call (EMT will call us back)! */
2468	alock.release();
2469
2470	if (vrc == VERR_TIMEOUT \|\| RT_SUCCESS(vrc))
2471	{
2472	vrc = VMR3ReqWait(pReq, RT_INDEFINITE_WAIT);
2473	AssertRC(vrc);
2474	if (RT_SUCCESS(vrc))
2475	vrc = pReq->iStatus;
2476	}
2477	VMR3ReqFree(pReq);
2478
2479	rc = RT_SUCCESS(vrc) ? S_OK :
2480	setError(VBOX_E_VM_ERROR,
2481	tr("Could not add CPU to the machine (%Rrc)"),
2482	vrc);
2483
2484	if (RT_SUCCESS(vrc))
2485	{
2486	/* Notify the guest if possible. */
2487	uint32_t idCpuCore, idCpuPackage;
2488	vrc = VMR3GetCpuCoreAndPackageIdFromCpuId(pUVM, aCpu, &idCpuCore, &idCpuPackage); AssertRC(vrc);
2489	if (RT_SUCCESS(vrc))
2490	vrc = pDevPort->pfnCpuHotPlug(pDevPort, idCpuCore, idCpuPackage);
2491	/** @todo warning if the guest doesn't support it */
2492	}
2493
2494	LogFlowThisFunc(("mMachineState=%d, rc=%Rhrc\n", mMachineState, rc));
2495	LogFlowThisFuncLeave();
2496	return rc;
2497	}
2498
2499	HRESULT Console::pause()
2500	{
2501	LogFlowThisFuncEnter();
2502
2503	HRESULT rc = i_pause(Reason_Unspecified);
2504
2505	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2506	LogFlowThisFuncLeave();
2507	return rc;
2508	}
2509
2510	HRESULT Console::resume()
2511	{
2512	LogFlowThisFuncEnter();
2513
2514	HRESULT rc = i_resume(Reason_Unspecified);
2515
2516	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2517	LogFlowThisFuncLeave();
2518	return rc;
2519	}
2520
2521	HRESULT Console::powerButton()
2522	{
2523	LogFlowThisFuncEnter();
2524
2525	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2526
2527	if ( mMachineState != MachineState_Running
2528	&& mMachineState != MachineState_Teleporting
2529	&& mMachineState != MachineState_LiveSnapshotting
2530	)
2531	return i_setInvalidMachineStateError();
2532
2533	/* get the VM handle. */
2534	SafeVMPtr ptrVM(this);
2535	if (!ptrVM.isOk())
2536	return ptrVM.rc();
2537
2538	// no need to release lock, as there are no cross-thread callbacks
2539
2540	/* get the acpi device interface and press the button. */
2541	PPDMIBASE pBase;
2542	int vrc = PDMR3QueryDeviceLun(ptrVM.rawUVM(), "acpi", 0, 0, &pBase);
2543	if (RT_SUCCESS(vrc))
2544	{
2545	Assert(pBase);
2546	PPDMIACPIPORT pPort = PDMIBASE_QUERY_INTERFACE(pBase, PDMIACPIPORT);
2547	if (pPort)
2548	vrc = pPort->pfnPowerButtonPress(pPort);
2549	else
2550	vrc = VERR_PDM_MISSING_INTERFACE;
2551	}
2552
2553	HRESULT rc = RT_SUCCESS(vrc) ? S_OK :
2554	setError(VBOX_E_PDM_ERROR,
2555	tr("Controlled power off failed (%Rrc)"),
2556	vrc);
2557
2558	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2559	LogFlowThisFuncLeave();
2560	return rc;
2561	}
2562
2563	HRESULT Console::getPowerButtonHandled(BOOL *aHandled)
2564	{
2565	LogFlowThisFuncEnter();
2566
2567	*aHandled = FALSE;
2568
2569	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2570
2571	if ( mMachineState != MachineState_Running
2572	&& mMachineState != MachineState_Teleporting
2573	&& mMachineState != MachineState_LiveSnapshotting
2574	)
2575	return i_setInvalidMachineStateError();
2576
2577	/* get the VM handle. */
2578	SafeVMPtr ptrVM(this);
2579	if (!ptrVM.isOk())
2580	return ptrVM.rc();
2581
2582	// no need to release lock, as there are no cross-thread callbacks
2583
2584	/* get the acpi device interface and check if the button press was handled. */
2585	PPDMIBASE pBase;
2586	int vrc = PDMR3QueryDeviceLun(ptrVM.rawUVM(), "acpi", 0, 0, &pBase);
2587	if (RT_SUCCESS(vrc))
2588	{
2589	Assert(pBase);
2590	PPDMIACPIPORT pPort = PDMIBASE_QUERY_INTERFACE(pBase, PDMIACPIPORT);
2591	if (pPort)
2592	{
2593	bool fHandled = false;
2594	vrc = pPort->pfnGetPowerButtonHandled(pPort, &fHandled);
2595	if (RT_SUCCESS(vrc))
2596	*aHandled = fHandled;
2597	}
2598	else
2599	vrc = VERR_PDM_MISSING_INTERFACE;
2600	}
2601
2602	HRESULT rc = RT_SUCCESS(vrc) ? S_OK :
2603	setError(VBOX_E_PDM_ERROR,
2604	tr("Checking if the ACPI Power Button event was handled by the guest OS failed (%Rrc)"),
2605	vrc);
2606
2607	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2608	LogFlowThisFuncLeave();
2609	return rc;
2610	}
2611
2612	HRESULT Console::getGuestEnteredACPIMode(BOOL *aEntered)
2613	{
2614	LogFlowThisFuncEnter();
2615
2616	*aEntered = FALSE;
2617
2618	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2619
2620	if ( mMachineState != MachineState_Running
2621	&& mMachineState != MachineState_Teleporting
2622	&& mMachineState != MachineState_LiveSnapshotting
2623	)
2624	return setError(VBOX_E_INVALID_VM_STATE,
2625	tr("Invalid machine state %s when checking if the guest entered the ACPI mode)"),
2626	Global::stringifyMachineState(mMachineState));
2627
2628	/* get the VM handle. */
2629	SafeVMPtr ptrVM(this);
2630	if (!ptrVM.isOk())
2631	return ptrVM.rc();
2632
2633	// no need to release lock, as there are no cross-thread callbacks
2634
2635	/* get the acpi device interface and query the information. */
2636	PPDMIBASE pBase;
2637	int vrc = PDMR3QueryDeviceLun(ptrVM.rawUVM(), "acpi", 0, 0, &pBase);
2638	if (RT_SUCCESS(vrc))
2639	{
2640	Assert(pBase);
2641	PPDMIACPIPORT pPort = PDMIBASE_QUERY_INTERFACE(pBase, PDMIACPIPORT);
2642	if (pPort)
2643	{
2644	bool fEntered = false;
2645	vrc = pPort->pfnGetGuestEnteredACPIMode(pPort, &fEntered);
2646	if (RT_SUCCESS(vrc))
2647	*aEntered = fEntered;
2648	}
2649	else
2650	vrc = VERR_PDM_MISSING_INTERFACE;
2651	}
2652
2653	LogFlowThisFuncLeave();
2654	return S_OK;
2655	}
2656
2657	HRESULT Console::sleepButton()
2658	{
2659	LogFlowThisFuncEnter();
2660
2661	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2662
2663	if ( mMachineState != MachineState_Running
2664	&& mMachineState != MachineState_Teleporting
2665	&& mMachineState != MachineState_LiveSnapshotting)
2666	return i_setInvalidMachineStateError();
2667
2668	/* get the VM handle. */
2669	SafeVMPtr ptrVM(this);
2670	if (!ptrVM.isOk())
2671	return ptrVM.rc();
2672
2673	// no need to release lock, as there are no cross-thread callbacks
2674
2675	/* get the acpi device interface and press the sleep button. */
2676	PPDMIBASE pBase;
2677	int vrc = PDMR3QueryDeviceLun(ptrVM.rawUVM(), "acpi", 0, 0, &pBase);
2678	if (RT_SUCCESS(vrc))
2679	{
2680	Assert(pBase);
2681	PPDMIACPIPORT pPort = PDMIBASE_QUERY_INTERFACE(pBase, PDMIACPIPORT);
2682	if (pPort)
2683	vrc = pPort->pfnSleepButtonPress(pPort);
2684	else
2685	vrc = VERR_PDM_MISSING_INTERFACE;
2686	}
2687
2688	HRESULT rc = RT_SUCCESS(vrc) ? S_OK :
2689	setError(VBOX_E_PDM_ERROR,
2690	tr("Sending sleep button event failed (%Rrc)"),
2691	vrc);
2692
2693	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2694	LogFlowThisFuncLeave();
2695	return rc;
2696	}
2697
2698	HRESULT Console::saveState(ComPtr<IProgress> &aProgress)
2699	{
2700	LogFlowThisFuncEnter();
2701	ComObjPtr<IProgress> pProgress;
2702
2703	HRESULT rc = i_saveState(Reason_Unspecified, pProgress.asOutParam());
2704	pProgress.queryInterfaceTo(aProgress.asOutParam());
2705
2706	LogFlowThisFunc(("rc=%Rhrc\n", rc));
2707	LogFlowThisFuncLeave();
2708	return rc;
2709	}
2710
2711	HRESULT Console::adoptSavedState(const com::Utf8Str &aSavedStateFile)
2712	{
2713	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2714
2715	if ( mMachineState != MachineState_PoweredOff
2716	&& mMachineState != MachineState_Teleported
2717	&& mMachineState != MachineState_Aborted
2718	)
2719	return setError(VBOX_E_INVALID_VM_STATE,
2720	tr("Cannot adopt the saved machine state as the machine is not in Powered Off, Teleported or Aborted state (machine state: %s)"),
2721	Global::stringifyMachineState(mMachineState));
2722
2723	return mControl->AdoptSavedState(Bstr(aSavedStateFile.c_str()).raw());
2724	}
2725
2726	HRESULT Console::discardSavedState(BOOL aFRemoveFile)
2727	{
2728	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2729
2730	if (mMachineState != MachineState_Saved)
2731	return setError(VBOX_E_INVALID_VM_STATE,
2732	tr("Cannot delete the machine state as the machine is not in the saved state (machine state: %s)"),
2733	Global::stringifyMachineState(mMachineState));
2734
2735	HRESULT rc = mControl->SetRemoveSavedStateFile(aFRemoveFile);
2736	if (FAILED(rc)) return rc;
2737
2738	/*
2739	* Saved -> PoweredOff transition will be detected in the SessionMachine
2740	* and properly handled.
2741	*/
2742	rc = i_setMachineState(MachineState_PoweredOff);
2743
2744	return rc;
2745	}
2746
2747	/** read the value of a LED. */
2748	inline uint32_t readAndClearLed(PPDMLED pLed)
2749	{
2750	if (!pLed)
2751	return 0;
2752	uint32_t u32 = pLed->Actual.u32 \| pLed->Asserted.u32;
2753	pLed->Asserted.u32 = 0;
2754	return u32;
2755	}
2756
2757	HRESULT Console::getDeviceActivity(DeviceType_T aType,
2758	DeviceActivity_T *aActivity)
2759	{
2760	/*
2761	* Note: we don't lock the console object here because
2762	* readAndClearLed() should be thread safe.
2763	*/
2764
2765	/* Get LED array to read */
2766	PDMLEDCORE SumLed = {0};
2767	switch (aType)
2768	{
2769	case DeviceType_Floppy:
2770	case DeviceType_DVD:
2771	case DeviceType_HardDisk:
2772	{
2773	for (unsigned i = 0; i < RT_ELEMENTS(mapStorageLeds); ++i)
2774	if (maStorageDevType[i] == aType)
2775	SumLed.u32 \|= readAndClearLed(mapStorageLeds[i]);
2776	break;
2777	}
2778
2779	case DeviceType_Network:
2780	{
2781	for (unsigned i = 0; i < RT_ELEMENTS(mapNetworkLeds); ++i)
2782	SumLed.u32 \|= readAndClearLed(mapNetworkLeds[i]);
2783	break;
2784	}
2785
2786	case DeviceType_USB:
2787	{
2788	for (unsigned i = 0; i < RT_ELEMENTS(mapUSBLed); ++i)
2789	SumLed.u32 \|= readAndClearLed(mapUSBLed[i]);
2790	break;
2791	}
2792
2793	case DeviceType_SharedFolder:
2794	{
2795	SumLed.u32 \|= readAndClearLed(mapSharedFolderLed);
2796	break;
2797	}
2798
2799	case DeviceType_Graphics3D:
2800	{
2801	SumLed.u32 \|= readAndClearLed(mapCrOglLed);
2802	break;
2803	}
2804
2805	default:
2806	return setError(E_INVALIDARG,
2807	tr("Invalid device type: %d"),
2808	aType);
2809	}
2810
2811	/* Compose the result */
2812	switch (SumLed.u32 & (PDMLED_READING \| PDMLED_WRITING))
2813	{
2814	case 0:
2815	*aActivity = DeviceActivity_Idle;
2816	break;
2817	case PDMLED_READING:
2818	*aActivity = DeviceActivity_Reading;
2819	break;
2820	case PDMLED_WRITING:
2821	case PDMLED_READING \| PDMLED_WRITING:
2822	*aActivity = DeviceActivity_Writing;
2823	break;
2824	}
2825
2826	return S_OK;
2827	}
2828
2829	HRESULT Console::attachUSBDevice(const com::Guid &aId)
2830	{
2831	#ifdef VBOX_WITH_USB
2832	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2833
2834	if ( mMachineState != MachineState_Running
2835	&& mMachineState != MachineState_Paused)
2836	return setError(VBOX_E_INVALID_VM_STATE,
2837	tr("Cannot attach a USB device to the machine which is not running or paused (machine state: %s)"),
2838	Global::stringifyMachineState(mMachineState));
2839
2840	/* Get the VM handle. */
2841	SafeVMPtr ptrVM(this);
2842	if (!ptrVM.isOk())
2843	return ptrVM.rc();
2844
2845	/* Don't proceed unless we have a USB controller. */
2846	if (!mfVMHasUsbController)
2847	return setError(VBOX_E_PDM_ERROR,
2848	tr("The virtual machine does not have a USB controller"));
2849
2850	/* release the lock because the USB Proxy service may call us back
2851	* (via onUSBDeviceAttach()) */
2852	alock.release();
2853
2854	/* Request the device capture */
2855	return mControl->CaptureUSBDevice(Bstr(aId.toString()).raw());
2856
2857	#else /* !VBOX_WITH_USB */
2858	return setError(VBOX_E_PDM_ERROR,
2859	tr("The virtual machine does not have a USB controller"));
2860	#endif /* !VBOX_WITH_USB */
2861	}
2862
2863	HRESULT Console::detachUSBDevice(const com::Guid &aId, ComPtr<IUSBDevice> &aDevice)
2864	{
2865	#ifdef VBOX_WITH_USB
2866
2867	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2868
2869	/* Find it. */
2870	ComObjPtr<OUSBDevice> pUSBDevice;
2871	USBDeviceList::iterator it = mUSBDevices.begin();
2872	while (it != mUSBDevices.end())
2873	{
2874	if ((*it)->i_id() == aId)
2875	{
2876	pUSBDevice = *it;
2877	break;
2878	}
2879	++it;
2880	}
2881
2882	if (!pUSBDevice)
2883	return setError(E_INVALIDARG,
2884	tr("USB device with UUID {%RTuuid} is not attached to this machine"),
2885	aId.raw());
2886
2887	/* Remove the device from the collection, it is re-added below for failures */
2888	mUSBDevices.erase(it);
2889
2890	/*
2891	* Inform the USB device and USB proxy about what's cooking.
2892	*/
2893	alock.release();
2894	HRESULT rc = mControl->DetachUSBDevice(Bstr(aId.toString()).raw(), false /* aDone */);
2895	if (FAILED(rc))
2896	{
2897	/* Re-add the device to the collection */
2898	alock.acquire();
2899	mUSBDevices.push_back(pUSBDevice);
2900	return rc;
2901	}
2902
2903	/* Request the PDM to detach the USB device. */
2904	rc = i_detachUSBDevice(pUSBDevice);
2905	if (SUCCEEDED(rc))
2906	{
2907	/* Request the device release. Even if it fails, the device will
2908	* remain as held by proxy, which is OK for us (the VM process). */
2909	rc = mControl->DetachUSBDevice(Bstr(aId.toString()).raw(), true /* aDone */);
2910	}
2911	else
2912	{
2913	/* Re-add the device to the collection */
2914	alock.acquire();
2915	mUSBDevices.push_back(pUSBDevice);
2916	}
2917
2918	return rc;
2919
2920
2921	#else /* !VBOX_WITH_USB */
2922	return setError(VBOX_E_PDM_ERROR,
2923	tr("The virtual machine does not have a USB controller"));
2924	#endif /* !VBOX_WITH_USB */
2925	}
2926
2927
2928	HRESULT Console::findUSBDeviceByAddress(const com::Utf8Str &aName, ComPtr<IUSBDevice> &aDevice)
2929	{
2930	#ifdef VBOX_WITH_USB
2931
2932	aDevice = NULL;
2933
2934	SafeIfaceArray<IUSBDevice> devsvec;
2935	HRESULT rc = COMGETTER(USBDevices)(ComSafeArrayAsOutParam(devsvec));
2936	if (FAILED(rc)) return rc;
2937
2938	for (size_t i = 0; i < devsvec.size(); ++i)
2939	{
2940	Bstr address;
2941	rc = devsvec[i]->COMGETTER(Address)(address.asOutParam());
2942	if (FAILED(rc)) return rc;
2943	if (address == Bstr(aName))
2944	{
2945	ComObjPtr<OUSBDevice> pUSBDevice;
2946	pUSBDevice.createObject();
2947	pUSBDevice->init(devsvec[i]);
2948	return pUSBDevice.queryInterfaceTo(aDevice.asOutParam());
2949	}
2950	}
2951
2952	return setErrorNoLog(VBOX_E_OBJECT_NOT_FOUND,
2953	tr("Could not find a USB device with address '%s'"),
2954	aName.c_str());
2955
2956	#else /* !VBOX_WITH_USB */
2957	return E_NOTIMPL;
2958	#endif /* !VBOX_WITH_USB */
2959	}
2960
2961	HRESULT Console::findUSBDeviceById(const com::Guid &aId, ComPtr<IUSBDevice> &aDevice)
2962	{
2963	#ifdef VBOX_WITH_USB
2964
2965	aDevice = NULL;
2966
2967	SafeIfaceArray<IUSBDevice> devsvec;
2968	HRESULT rc = COMGETTER(USBDevices)(ComSafeArrayAsOutParam(devsvec));
2969	if (FAILED(rc)) return rc;
2970
2971	for (size_t i = 0; i < devsvec.size(); ++i)
2972	{
2973	Bstr id;
2974	rc = devsvec[i]->COMGETTER(Id)(id.asOutParam());
2975	if (FAILED(rc)) return rc;
2976	if (Utf8Str(id) == aId.toString())
2977	{
2978	ComObjPtr<OUSBDevice> pUSBDevice;
2979	pUSBDevice.createObject();
2980	pUSBDevice->init(devsvec[i]);
2981	ComObjPtr<IUSBDevice> iUSBDevice = static_cast <ComObjPtr<IUSBDevice> > (pUSBDevice);
2982	return iUSBDevice.queryInterfaceTo(aDevice.asOutParam());
2983	}
2984	}
2985
2986	return setErrorNoLog(VBOX_E_OBJECT_NOT_FOUND,
2987	tr("Could not find a USB device with uuid {%RTuuid}"),
2988	Guid(aId).raw());
2989
2990	#else /* !VBOX_WITH_USB */
2991	return E_NOTIMPL;
2992	#endif /* !VBOX_WITH_USB */
2993	}
2994
2995	HRESULT Console::createSharedFolder(const com::Utf8Str &aName, const com::Utf8Str &aHostPath, BOOL aWritable, BOOL aAutomount)
2996	{
2997	LogFlowThisFunc(("Entering for '%s' -> '%s'\n", aName.c_str(), aHostPath.c_str()));
2998
2999	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3000
3001	/// @todo see @todo in AttachUSBDevice() about the Paused state
3002	if (mMachineState == MachineState_Saved)
3003	return setError(VBOX_E_INVALID_VM_STATE,
3004	tr("Cannot create a transient shared folder on the machine in the saved state"));
3005	if ( mMachineState != MachineState_PoweredOff
3006	&& mMachineState != MachineState_Teleported
3007	&& mMachineState != MachineState_Aborted
3008	&& mMachineState != MachineState_Running
3009	&& mMachineState != MachineState_Paused
3010	)
3011	return setError(VBOX_E_INVALID_VM_STATE,
3012	tr("Cannot create a transient shared folder on the machine while it is changing the state (machine state: %s)"),
3013	Global::stringifyMachineState(mMachineState));
3014
3015	ComObjPtr<SharedFolder> pSharedFolder;
3016	HRESULT rc = i_findSharedFolder(aName, pSharedFolder, false /* aSetError */);
3017	if (SUCCEEDED(rc))
3018	return setError(VBOX_E_FILE_ERROR,
3019	tr("Shared folder named '%s' already exists"),
3020	aName.c_str());
3021
3022	pSharedFolder.createObject();
3023	rc = pSharedFolder->init(this,
3024	aName,
3025	aHostPath,
3026	!!aWritable,
3027	!!aAutomount,
3028	true /* fFailOnError */);
3029	if (FAILED(rc)) return rc;
3030
3031	/* If the VM is online and supports shared folders, share this folder
3032	* under the specified name. (Ignore any failure to obtain the VM handle.) */
3033	SafeVMPtrQuiet ptrVM(this);
3034	if ( ptrVM.isOk()
3035	&& m_pVMMDev
3036	&& m_pVMMDev->isShFlActive()
3037	)
3038	{
3039	/* first, remove the machine or the global folder if there is any */
3040	SharedFolderDataMap::const_iterator it;
3041	if (i_findOtherSharedFolder(aName, it))
3042	{
3043	rc = removeSharedFolder(aName);
3044	if (FAILED(rc))
3045	return rc;
3046	}
3047
3048	/* second, create the given folder */
3049	rc = i_createSharedFolder(aName, SharedFolderData(aHostPath, !!aWritable, !!aAutomount));
3050	if (FAILED(rc))
3051	return rc;
3052	}
3053
3054	m_mapSharedFolders.insert(std::make_pair(aName, pSharedFolder));
3055
3056	/* Notify console callbacks after the folder is added to the list. */
3057	alock.release();
3058	fireSharedFolderChangedEvent(mEventSource, Scope_Session);
3059
3060	LogFlowThisFunc(("Leaving for '%s' -> '%s'\n", aName.c_str(), aHostPath.c_str()));
3061
3062	return rc;
3063	}
3064
3065	HRESULT Console::removeSharedFolder(const com::Utf8Str &aName)
3066	{
3067	LogFlowThisFunc(("Entering for '%s'\n", aName.c_str()));
3068
3069	Utf8Str strName(aName);
3070
3071	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3072
3073	/// @todo see @todo in AttachUSBDevice() about the Paused state
3074	if (mMachineState == MachineState_Saved)
3075	return setError(VBOX_E_INVALID_VM_STATE,
3076	tr("Cannot remove a transient shared folder from the machine in the saved state"));
3077	if ( mMachineState != MachineState_PoweredOff
3078	&& mMachineState != MachineState_Teleported
3079	&& mMachineState != MachineState_Aborted
3080	&& mMachineState != MachineState_Running
3081	&& mMachineState != MachineState_Paused
3082	)
3083	return setError(VBOX_E_INVALID_VM_STATE,
3084	tr("Cannot remove a transient shared folder from the machine while it is changing the state (machine state: %s)"),
3085	Global::stringifyMachineState(mMachineState));
3086
3087	ComObjPtr<SharedFolder> pSharedFolder;
3088	HRESULT rc = i_findSharedFolder(aName, pSharedFolder, true /* aSetError */);
3089	if (FAILED(rc)) return rc;
3090
3091	/* protect the VM handle (if not NULL) */
3092	SafeVMPtrQuiet ptrVM(this);
3093	if ( ptrVM.isOk()
3094	&& m_pVMMDev
3095	&& m_pVMMDev->isShFlActive()
3096	)
3097	{
3098	/* if the VM is online and supports shared folders, UNshare this
3099	* folder. */
3100
3101	/* first, remove the given folder */
3102	rc = removeSharedFolder(strName);
3103	if (FAILED(rc)) return rc;
3104
3105	/* first, remove the machine or the global folder if there is any */
3106	SharedFolderDataMap::const_iterator it;
3107	if (i_findOtherSharedFolder(strName, it))
3108	{
3109	rc = i_createSharedFolder(strName, it->second);
3110	/* don't check rc here because we need to remove the console
3111	* folder from the collection even on failure */
3112	}
3113	}
3114
3115	m_mapSharedFolders.erase(strName);
3116
3117	/* Notify console callbacks after the folder is removed from the list. */
3118	alock.release();
3119	fireSharedFolderChangedEvent(mEventSource, Scope_Session);
3120
3121	LogFlowThisFunc(("Leaving for '%s'\n", aName.c_str()));
3122
3123	return rc;
3124	}
3125
3126	HRESULT Console::takeSnapshot(const com::Utf8Str &aName,
3127	const com::Utf8Str &aDescription,
3128	ComPtr<IProgress> &aProgress)
3129	{
3130	LogFlowThisFuncEnter();
3131
3132	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3133	LogFlowThisFunc(("aName='%s' mMachineState=%d\n", aName.c_str(), mMachineState));
3134
3135	if (Global::IsTransient(mMachineState))
3136	return setError(VBOX_E_INVALID_VM_STATE,
3137	tr("Cannot take a snapshot of the machine while it is changing the state (machine state: %s)"),
3138	Global::stringifyMachineState(mMachineState));
3139
3140	HRESULT rc = S_OK;
3141
3142	/* prepare the progress object:
3143	a) count the no. of hard disk attachments to get a matching no. of progress sub-operations */
3144	ULONG cOperations = 2; // always at least setting up + finishing up
3145	ULONG ulTotalOperationsWeight = 2; // one each for setting up + finishing up
3146	SafeIfaceArray<IMediumAttachment> aMediumAttachments;
3147	rc = mMachine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(aMediumAttachments));
3148	if (FAILED(rc))
3149	return setError(rc, tr("Cannot get medium attachments of the machine"));
3150
3151	ULONG ulMemSize;
3152	rc = mMachine->COMGETTER(MemorySize)(&ulMemSize);
3153	if (FAILED(rc))
3154	return rc;
3155
3156	for (size_t i = 0;
3157	i < aMediumAttachments.size();
3158	++i)
3159	{
3160	DeviceType_T type;
3161	rc = aMediumAttachments[i]->COMGETTER(Type)(&type);
3162	if (FAILED(rc))
3163	return rc;
3164
3165	if (type == DeviceType_HardDisk)
3166	{
3167	++cOperations;
3168
3169	// assume that creating a diff image takes as long as saving a 1MB state
3170	// (note, the same value must be used in SessionMachine::BeginTakingSnapshot() on the server!)
3171	ulTotalOperationsWeight += 1;
3172	}
3173	}
3174
3175	// b) one extra sub-operations for online snapshots OR offline snapshots that have a saved state (needs to be copied)
3176	bool const fTakingSnapshotOnline = Global::IsOnline(mMachineState);
3177
3178	LogFlowFunc(("fTakingSnapshotOnline = %d, mMachineState = %d\n", fTakingSnapshotOnline, mMachineState));
3179
3180	if (fTakingSnapshotOnline)
3181	{
3182	++cOperations;
3183	ulTotalOperationsWeight += ulMemSize;
3184	}
3185
3186	// finally, create the progress object
3187	ComObjPtr<Progress> pProgress;
3188	pProgress.createObject();
3189	rc = pProgress->init(static_cast<IConsole *>(this),
3190	Bstr(tr("Taking a snapshot of the virtual machine")).raw(),
3191	(mMachineState >= MachineState_FirstOnline)
3192	&& (mMachineState <= MachineState_LastOnline) /* aCancelable */,
3193	cOperations,
3194	ulTotalOperationsWeight,
3195	Bstr(tr("Setting up snapshot operation")).raw(), // first sub-op description
3196	1); // ulFirstOperationWeight
3197
3198	if (FAILED(rc))
3199	return rc;
3200
3201	VMTakeSnapshotTask *pTask;
3202	if (!(pTask = new VMTakeSnapshotTask(this, pProgress, Bstr(aName).raw(), Bstr(aDescription).raw())))
3203	return E_OUTOFMEMORY;
3204
3205	Assert(pTask->mProgress);
3206
3207	try
3208	{
3209	mptrCancelableProgress = pProgress;
3210
3211	/*
3212	* If we fail here it means a PowerDown() call happened on another
3213	* thread while we were doing Pause() (which releases the Console lock).
3214	* We assign PowerDown() a higher precedence than TakeSnapshot(),
3215	* therefore just return the error to the caller.
3216	*/
3217	rc = pTask->rc();
3218	if (FAILED(rc)) throw rc;
3219
3220	pTask->ulMemSize = ulMemSize;
3221
3222	/* memorize the current machine state */
3223	pTask->lastMachineState = mMachineState;
3224	pTask->fTakingSnapshotOnline = fTakingSnapshotOnline;
3225
3226	int vrc = RTThreadCreate(NULL,
3227	Console::i_fntTakeSnapshotWorker,
3228	(void *)pTask,
3229	0,
3230	RTTHREADTYPE_MAIN_WORKER,
3231	0,
3232	"TakeSnap");
3233	if (FAILED(vrc))
3234	throw setError(E_FAIL,
3235	tr("Could not create VMTakeSnap thread (%Rrc)"),
3236	vrc);
3237
3238	pTask->mProgress.queryInterfaceTo(aProgress.asOutParam());
3239	}
3240	catch (HRESULT erc)
3241	{
3242	delete pTask;
3243	rc = erc;
3244	mptrCancelableProgress.setNull();
3245	}
3246
3247	LogFlowThisFunc(("rc=%Rhrc\n", rc));
3248	LogFlowThisFuncLeave();
3249	return rc;
3250	}
3251
3252	HRESULT Console::deleteSnapshot(const com::Guid &aId, ComPtr<IProgress> &aProgress)
3253	{
3254	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3255
3256	if (Global::IsTransient(mMachineState))
3257	return setError(VBOX_E_INVALID_VM_STATE,
3258	tr("Cannot delete a snapshot of the machine while it is changing the state (machine state: %s)"),
3259	Global::stringifyMachineState(mMachineState));
3260	ComObjPtr<IProgress> iProgress;
3261	MachineState_T machineState = MachineState_Null;
3262	HRESULT rc = mControl->DeleteSnapshot((IConsole )this, Bstr(aId.toString()).raw(), Bstr(aId.toString()).raw(), FALSE / fDeleteAllChildren */, &machineState, iProgress.asOutParam());
3263	if (FAILED(rc)) return rc;
3264	iProgress.queryInterfaceTo(aProgress.asOutParam());
3265
3266	i_setMachineStateLocally(machineState);
3267	return S_OK;
3268	}
3269
3270	HRESULT Console::deleteSnapshotAndAllChildren(const com::Guid &aId, ComPtr<IProgress> &aProgress)
3271
3272	{
3273	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3274
3275	if (Global::IsTransient(mMachineState))
3276	return setError(VBOX_E_INVALID_VM_STATE,
3277	tr("Cannot delete a snapshot of the machine while it is changing the state (machine state: %s)"),
3278	Global::stringifyMachineState(mMachineState));
3279
3280	ComObjPtr<IProgress> iProgress;
3281	MachineState_T machineState = MachineState_Null;
3282	HRESULT rc = mControl->DeleteSnapshot((IConsole )this, Bstr(aId.toString()).raw(), Bstr(aId.toString()).raw(), TRUE / fDeleteAllChildren */, &machineState, iProgress.asOutParam());
3283	if (FAILED(rc)) return rc;
3284	iProgress.queryInterfaceTo(aProgress.asOutParam());
3285
3286	i_setMachineStateLocally(machineState);
3287	return S_OK;
3288	}
3289
3290	HRESULT Console::deleteSnapshotRange(const com::Guid &aStartId, const com::Guid &aEndId, ComPtr<IProgress> &aProgress)
3291	{
3292	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3293
3294	if (Global::IsTransient(mMachineState))
3295	return setError(VBOX_E_INVALID_VM_STATE,
3296	tr("Cannot delete a snapshot of the machine while it is changing the state (machine state: %s)"),
3297	Global::stringifyMachineState(mMachineState));
3298
3299	ComObjPtr<IProgress> iProgress;
3300	MachineState_T machineState = MachineState_Null;
3301	HRESULT rc = mControl->DeleteSnapshot((IConsole )this, Bstr(aStartId.toString()).raw(), Bstr(aEndId.toString()).raw(), FALSE / fDeleteAllChildren */, &machineState, iProgress.asOutParam());
3302	if (FAILED(rc)) return rc;
3303	iProgress.queryInterfaceTo(aProgress.asOutParam());
3304
3305	i_setMachineStateLocally(machineState);
3306	return S_OK;
3307	}
3308
3309	HRESULT Console::restoreSnapshot(const ComPtr<ISnapshot> &aSnapshot, ComPtr<IProgress> &aProgress)
3310	{
3311	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3312
3313	if (Global::IsOnlineOrTransient(mMachineState))
3314	return setError(VBOX_E_INVALID_VM_STATE,
3315	tr("Cannot delete the current state of the running machine (machine state: %s)"),
3316	Global::stringifyMachineState(mMachineState));
3317
3318	ISnapshot* iSnapshot = aSnapshot;
3319	ComObjPtr<IProgress> iProgress;
3320	MachineState_T machineState = MachineState_Null;
3321	HRESULT rc = mControl->RestoreSnapshot((IConsole*)this, iSnapshot, &machineState, iProgress.asOutParam());
3322	if (FAILED(rc)) return rc;
3323	iProgress.queryInterfaceTo(aProgress.asOutParam());
3324
3325	i_setMachineStateLocally(machineState);
3326	return S_OK;
3327	}
3328
3329	// Non-interface public methods
3330	/////////////////////////////////////////////////////////////////////////////
3331
3332	/static/
3333	HRESULT Console::i_setErrorStatic(HRESULT aResultCode, const char *pcsz, ...)
3334	{
3335	va_list args;
3336	va_start(args, pcsz);
3337	HRESULT rc = setErrorInternal(aResultCode,
3338	getStaticClassIID(),
3339	getStaticComponentName(),
3340	Utf8Str(pcsz, args),
3341	false /* aWarning */,
3342	true /* aLogIt */);
3343	va_end(args);
3344	return rc;
3345	}
3346
3347	HRESULT Console::i_setInvalidMachineStateError()
3348	{
3349	return setError(VBOX_E_INVALID_VM_STATE,
3350	tr("Invalid machine state: %s"),
3351	Global::stringifyMachineState(mMachineState));
3352	}
3353
3354
3355	/* static */
3356	const char *Console::i_convertControllerTypeToDev(StorageControllerType_T enmCtrlType)
3357	{
3358	switch (enmCtrlType)
3359	{
3360	case StorageControllerType_LsiLogic:
3361	return "lsilogicscsi";
3362	case StorageControllerType_BusLogic:
3363	return "buslogic";
3364	case StorageControllerType_LsiLogicSas:
3365	return "lsilogicsas";
3366	case StorageControllerType_IntelAhci:
3367	return "ahci";
3368	case StorageControllerType_PIIX3:
3369	case StorageControllerType_PIIX4:
3370	case StorageControllerType_ICH6:
3371	return "piix3ide";
3372	case StorageControllerType_I82078:
3373	return "i82078";
3374	case StorageControllerType_USB:
3375	return "Msd";
3376	default:
3377	return NULL;
3378	}
3379	}
3380
3381	HRESULT Console::i_convertBusPortDeviceToLun(StorageBus_T enmBus, LONG port, LONG device, unsigned &uLun)
3382	{
3383	switch (enmBus)
3384	{
3385	case StorageBus_IDE:
3386	case StorageBus_Floppy:
3387	{
3388	AssertMsgReturn(port < 2 && port >= 0, ("%d\n", port), E_INVALIDARG);
3389	AssertMsgReturn(device < 2 && device >= 0, ("%d\n", device), E_INVALIDARG);
3390	uLun = 2 * port + device;
3391	return S_OK;
3392	}
3393	case StorageBus_SATA:
3394	case StorageBus_SCSI:
3395	case StorageBus_SAS:
3396	{
3397	uLun = port;
3398	return S_OK;
3399	}
3400	case StorageBus_USB:
3401	{
3402	/*
3403	* It is always the first lun, the port denotes the device instance
3404	* for the Msd device.
3405	*/
3406	uLun = 0;
3407	return S_OK;
3408	}
3409	default:
3410	uLun = 0;
3411	AssertMsgFailedReturn(("%d\n", enmBus), E_INVALIDARG);
3412	}
3413	}
3414
3415	// private methods
3416	/////////////////////////////////////////////////////////////////////////////
3417
3418	/**
3419	* Suspend the VM before we do any medium or network attachment change.
3420	*
3421	* @param pUVM Safe VM handle.
3422	* @param pAlock The automatic lock instance. This is for when we have
3423	* to leave it in order to avoid deadlocks.
3424	* @param pfSuspend where to store the information if we need to resume
3425	* afterwards.
3426	*/
3427	HRESULT Console::i_suspendBeforeConfigChange(PUVM pUVM, AutoWriteLock pAlock, bool pfResume)
3428	{
3429	*pfResume = false;
3430	VMSTATE enmVMState = VMR3GetStateU(pUVM);
3431	switch (enmVMState)
3432	{
3433	case VMSTATE_RESETTING:
3434	case VMSTATE_RUNNING:
3435	{
3436	LogFlowFunc(("Suspending the VM...\n"));
3437	/* disable the callback to prevent Console-level state change */
3438	mVMStateChangeCallbackDisabled = true;
3439	if (pAlock)
3440	pAlock->release();
3441	int rc = VMR3Suspend(pUVM, VMSUSPENDREASON_RECONFIG);
3442	if (pAlock)
3443	pAlock->acquire();
3444	mVMStateChangeCallbackDisabled = false;
3445	if (RT_FAILURE(rc))
3446	return setErrorInternal(VBOX_E_INVALID_VM_STATE,
3447	COM_IIDOF(IConsole),
3448	getStaticComponentName(),
3449	Utf8StrFmt("Could suspend VM for medium change (%Rrc)", rc),
3450	false /aWarning/,
3451	true /aLogIt/);
3452	*pfResume = true;
3453	break;
3454	}
3455	case VMSTATE_SUSPENDED:
3456	break;
3457	default:
3458	return setErrorInternal(VBOX_E_INVALID_VM_STATE,
3459	COM_IIDOF(IConsole),
3460	getStaticComponentName(),
3461	Utf8StrFmt("Invalid state '%s' for changing medium",
3462	VMR3GetStateName(enmVMState)),
3463	false /aWarning/,
3464	true /aLogIt/);
3465	}
3466
3467	return S_OK;
3468	}
3469
3470	/**
3471	* Resume the VM after we did any medium or network attachment change.
3472	* This is the counterpart to Console::suspendBeforeConfigChange().
3473	*
3474	* @param pUVM Safe VM handle.
3475	*/
3476	void Console::i_resumeAfterConfigChange(PUVM pUVM)
3477	{
3478	LogFlowFunc(("Resuming the VM...\n"));
3479	/* disable the callback to prevent Console-level state change */
3480	mVMStateChangeCallbackDisabled = true;
3481	int rc = VMR3Resume(pUVM, VMRESUMEREASON_RECONFIG);
3482	mVMStateChangeCallbackDisabled = false;
3483	AssertRC(rc);
3484	if (RT_FAILURE(rc))
3485	{
3486	VMSTATE enmVMState = VMR3GetStateU(pUVM);
3487	if (enmVMState == VMSTATE_SUSPENDED)
3488	{
3489	/* too bad, we failed. try to sync the console state with the VMM state */
3490	i_vmstateChangeCallback(pUVM, VMSTATE_SUSPENDED, enmVMState, this);
3491	}
3492	}
3493	}
3494
3495	/**
3496	* Process a medium change.
3497	*
3498	* @param aMediumAttachment The medium attachment with the new medium state.
3499	* @param fForce Force medium chance, if it is locked or not.
3500	* @param pUVM Safe VM handle.
3501	*
3502	* @note Locks this object for writing.
3503	*/
3504	HRESULT Console::i_doMediumChange(IMediumAttachment *aMediumAttachment, bool fForce, PUVM pUVM)
3505	{
3506	AutoCaller autoCaller(this);
3507	AssertComRCReturnRC(autoCaller.rc());
3508
3509	/* We will need to release the write lock before calling EMT */
3510	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3511
3512	HRESULT rc = S_OK;
3513	const char *pszDevice = NULL;
3514
3515	SafeIfaceArray<IStorageController> ctrls;
3516	rc = mMachine->COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(ctrls));
3517	AssertComRC(rc);
3518	IMedium *pMedium;
3519	rc = aMediumAttachment->COMGETTER(Medium)(&pMedium);
3520	AssertComRC(rc);
3521	Bstr mediumLocation;
3522	if (pMedium)
3523	{
3524	rc = pMedium->COMGETTER(Location)(mediumLocation.asOutParam());
3525	AssertComRC(rc);
3526	}
3527
3528	Bstr attCtrlName;
3529	rc = aMediumAttachment->COMGETTER(Controller)(attCtrlName.asOutParam());
3530	AssertComRC(rc);
3531	ComPtr<IStorageController> pStorageController;
3532	for (size_t i = 0; i < ctrls.size(); ++i)
3533	{
3534	Bstr ctrlName;
3535	rc = ctrls[i]->COMGETTER(Name)(ctrlName.asOutParam());
3536	AssertComRC(rc);
3537	if (attCtrlName == ctrlName)
3538	{
3539	pStorageController = ctrls[i];
3540	break;
3541	}
3542	}
3543	if (pStorageController.isNull())
3544	return setError(E_FAIL,
3545	tr("Could not find storage controller '%ls'"), attCtrlName.raw());
3546
3547	StorageControllerType_T enmCtrlType;
3548	rc = pStorageController->COMGETTER(ControllerType)(&enmCtrlType);
3549	AssertComRC(rc);
3550	pszDevice = i_convertControllerTypeToDev(enmCtrlType);
3551
3552	StorageBus_T enmBus;
3553	rc = pStorageController->COMGETTER(Bus)(&enmBus);
3554	AssertComRC(rc);
3555	ULONG uInstance;
3556	rc = pStorageController->COMGETTER(Instance)(&uInstance);
3557	AssertComRC(rc);
3558	BOOL fUseHostIOCache;
3559	rc = pStorageController->COMGETTER(UseHostIOCache)(&fUseHostIOCache);
3560	AssertComRC(rc);
3561
3562	/*
3563	* Suspend the VM first. The VM must not be running since it might have
3564	* pending I/O to the drive which is being changed.
3565	*/
3566	bool fResume = false;
3567	rc = i_suspendBeforeConfigChange(pUVM, &alock, &fResume);
3568	if (FAILED(rc))
3569	return rc;
3570
3571	/*
3572	* Call worker in EMT, that's faster and safer than doing everything
3573	* using VMR3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
3574	* here to make requests from under the lock in order to serialize them.
3575	*/
3576	PVMREQ pReq;
3577	int vrc = VMR3ReqCallU(pUVM, VMCPUID_ANY, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
3578	(PFNRT)i_changeRemovableMedium, 8,
3579	this, pUVM, pszDevice, uInstance, enmBus, fUseHostIOCache, aMediumAttachment, fForce);
3580
3581	/* release the lock before waiting for a result (EMT will call us back!) */
3582	alock.release();
3583
3584	if (vrc == VERR_TIMEOUT \|\| RT_SUCCESS(vrc))
3585	{
3586	vrc = VMR3ReqWait(pReq, RT_INDEFINITE_WAIT);
3587	AssertRC(vrc);
3588	if (RT_SUCCESS(vrc))
3589	vrc = pReq->iStatus;
3590	}
3591	VMR3ReqFree(pReq);
3592
3593	if (fResume)
3594	i_resumeAfterConfigChange(pUVM);
3595
3596	if (RT_SUCCESS(vrc))
3597	{
3598	LogFlowThisFunc(("Returns S_OK\n"));
3599	return S_OK;
3600	}
3601
3602	if (pMedium)
3603	return setError(E_FAIL,
3604	tr("Could not mount the media/drive '%ls' (%Rrc)"),
3605	mediumLocation.raw(), vrc);
3606
3607	return setError(E_FAIL,
3608	tr("Could not unmount the currently mounted media/drive (%Rrc)"),
3609	vrc);
3610	}
3611
3612	/**
3613	* Performs the medium change in EMT.
3614	*
3615	* @returns VBox status code.
3616	*
3617	* @param pThis Pointer to the Console object.
3618	* @param pUVM The VM handle.
3619	* @param pcszDevice The PDM device name.
3620	* @param uInstance The PDM device instance.
3621	* @param uLun The PDM LUN number of the drive.
3622	* @param fHostDrive True if this is a host drive attachment.
3623	* @param pszPath The path to the media / drive which is now being mounted / captured.
3624	* If NULL no media or drive is attached and the LUN will be configured with
3625	* the default block driver with no media. This will also be the state if
3626	* mounting / capturing the specified media / drive fails.
3627	* @param pszFormat Medium format string, usually "RAW".
3628	* @param fPassthrough Enables using passthrough mode of the host DVD drive if applicable.
3629	*
3630	* @thread EMT
3631	* @note The VM must not be running since it might have pending I/O to the drive which is being changed.
3632	*/
3633	DECLCALLBACK(int) Console::i_changeRemovableMedium(Console *pThis,
3634	PUVM pUVM,
3635	const char *pcszDevice,
3636	unsigned uInstance,
3637	StorageBus_T enmBus,
3638	bool fUseHostIOCache,
3639	IMediumAttachment *aMediumAtt,
3640	bool fForce)
3641	{
3642	LogFlowFunc(("pThis=%p uInstance=%u pszDevice=%p:{%s} enmBus=%u, aMediumAtt=%p, fForce=%d\n",
3643	pThis, uInstance, pcszDevice, pcszDevice, enmBus, aMediumAtt, fForce));
3644
3645	AssertReturn(pThis, VERR_INVALID_PARAMETER);
3646
3647	AutoCaller autoCaller(pThis);
3648	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
3649
3650	/*
3651	* Check the VM for correct state.
3652	*/
3653	VMSTATE enmVMState = VMR3GetStateU(pUVM);
3654	AssertReturn(enmVMState == VMSTATE_SUSPENDED, VERR_INVALID_STATE);
3655
3656	/* Determine the base path for the device instance. */
3657	PCFGMNODE pCtlInst;
3658	if (strcmp(pcszDevice, "Msd"))
3659	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%u/", pcszDevice, uInstance);
3660	else
3661	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "USB/%s/", pcszDevice, uInstance);
3662	AssertReturn(pCtlInst, VERR_INTERNAL_ERROR);
3663
3664	PCFGMNODE pLunL0 = NULL;
3665	int rc = pThis->i_configMediumAttachment(pCtlInst,
3666	pcszDevice,
3667	uInstance,
3668	enmBus,
3669	fUseHostIOCache,
3670	false /* fSetupMerge */,
3671	false /* fBuiltinIOCache */,
3672	0 /* uMergeSource */,
3673	0 /* uMergeTarget */,
3674	aMediumAtt,
3675	pThis->mMachineState,
3676	NULL /* phrc */,
3677	true /* fAttachDetach */,
3678	fForce /* fForceUnmount */,
3679	false /* fHotplug */,
3680	pUVM,
3681	NULL /* paLedDevType */,
3682	&pLunL0);
3683	/* Dump the changed LUN if possible, dump the complete device otherwise */
3684	CFGMR3Dump(pLunL0 ? pLunL0 : pCtlInst);
3685
3686	LogFlowFunc(("Returning %Rrc\n", rc));
3687	return rc;
3688	}
3689
3690
3691	/**
3692	* Attach a new storage device to the VM.
3693	*
3694	* @param aMediumAttachment The medium attachment which is added.
3695	* @param pUVM Safe VM handle.
3696	* @param fSilent Flag whether to notify the guest about the attached device.
3697	*
3698	* @note Locks this object for writing.
3699	*/
3700	HRESULT Console::i_doStorageDeviceAttach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent)
3701	{
3702	AutoCaller autoCaller(this);
3703	AssertComRCReturnRC(autoCaller.rc());
3704
3705	/* We will need to release the write lock before calling EMT */
3706	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3707
3708	HRESULT rc = S_OK;
3709	const char *pszDevice = NULL;
3710
3711	SafeIfaceArray<IStorageController> ctrls;
3712	rc = mMachine->COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(ctrls));
3713	AssertComRC(rc);
3714	IMedium *pMedium;
3715	rc = aMediumAttachment->COMGETTER(Medium)(&pMedium);
3716	AssertComRC(rc);
3717	Bstr mediumLocation;
3718	if (pMedium)
3719	{
3720	rc = pMedium->COMGETTER(Location)(mediumLocation.asOutParam());
3721	AssertComRC(rc);
3722	}
3723
3724	Bstr attCtrlName;
3725	rc = aMediumAttachment->COMGETTER(Controller)(attCtrlName.asOutParam());
3726	AssertComRC(rc);
3727	ComPtr<IStorageController> pStorageController;
3728	for (size_t i = 0; i < ctrls.size(); ++i)
3729	{
3730	Bstr ctrlName;
3731	rc = ctrls[i]->COMGETTER(Name)(ctrlName.asOutParam());
3732	AssertComRC(rc);
3733	if (attCtrlName == ctrlName)
3734	{
3735	pStorageController = ctrls[i];
3736	break;
3737	}
3738	}
3739	if (pStorageController.isNull())
3740	return setError(E_FAIL,
3741	tr("Could not find storage controller '%ls'"), attCtrlName.raw());
3742
3743	StorageControllerType_T enmCtrlType;
3744	rc = pStorageController->COMGETTER(ControllerType)(&enmCtrlType);
3745	AssertComRC(rc);
3746	pszDevice = i_convertControllerTypeToDev(enmCtrlType);
3747
3748	StorageBus_T enmBus;
3749	rc = pStorageController->COMGETTER(Bus)(&enmBus);
3750	AssertComRC(rc);
3751	ULONG uInstance;
3752	rc = pStorageController->COMGETTER(Instance)(&uInstance);
3753	AssertComRC(rc);
3754	BOOL fUseHostIOCache;
3755	rc = pStorageController->COMGETTER(UseHostIOCache)(&fUseHostIOCache);
3756	AssertComRC(rc);
3757
3758	/*
3759	* Suspend the VM first. The VM must not be running since it might have
3760	* pending I/O to the drive which is being changed.
3761	*/
3762	bool fResume = false;
3763	rc = i_suspendBeforeConfigChange(pUVM, &alock, &fResume);
3764	if (FAILED(rc))
3765	return rc;
3766
3767	/*
3768	* Call worker in EMT, that's faster and safer than doing everything
3769	* using VMR3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
3770	* here to make requests from under the lock in order to serialize them.
3771	*/
3772	PVMREQ pReq;
3773	int vrc = VMR3ReqCallU(pUVM, VMCPUID_ANY, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
3774	(PFNRT)i_attachStorageDevice, 8,
3775	this, pUVM, pszDevice, uInstance, enmBus, fUseHostIOCache, aMediumAttachment, fSilent);
3776
3777	/* release the lock before waiting for a result (EMT will call us back!) */
3778	alock.release();
3779
3780	if (vrc == VERR_TIMEOUT \|\| RT_SUCCESS(vrc))
3781	{
3782	vrc = VMR3ReqWait(pReq, RT_INDEFINITE_WAIT);
3783	AssertRC(vrc);
3784	if (RT_SUCCESS(vrc))
3785	vrc = pReq->iStatus;
3786	}
3787	VMR3ReqFree(pReq);
3788
3789	if (fResume)
3790	i_resumeAfterConfigChange(pUVM);
3791
3792	if (RT_SUCCESS(vrc))
3793	{
3794	LogFlowThisFunc(("Returns S_OK\n"));
3795	return S_OK;
3796	}
3797
3798	if (!pMedium)
3799	return setError(E_FAIL,
3800	tr("Could not mount the media/drive '%ls' (%Rrc)"),
3801	mediumLocation.raw(), vrc);
3802
3803	return setError(E_FAIL,
3804	tr("Could not unmount the currently mounted media/drive (%Rrc)"),
3805	vrc);
3806	}
3807
3808
3809	/**
3810	* Performs the storage attach operation in EMT.
3811	*
3812	* @returns VBox status code.
3813	*
3814	* @param pThis Pointer to the Console object.
3815	* @param pUVM The VM handle.
3816	* @param pcszDevice The PDM device name.
3817	* @param uInstance The PDM device instance.
3818	* @param fSilent Flag whether to inform the guest about the attached device.
3819	*
3820	* @thread EMT
3821	* @note The VM must not be running since it might have pending I/O to the drive which is being changed.
3822	*/
3823	DECLCALLBACK(int) Console::i_attachStorageDevice(Console *pThis,
3824	PUVM pUVM,
3825	const char *pcszDevice,
3826	unsigned uInstance,
3827	StorageBus_T enmBus,
3828	bool fUseHostIOCache,
3829	IMediumAttachment *aMediumAtt,
3830	bool fSilent)
3831	{
3832	LogFlowFunc(("pThis=%p uInstance=%u pszDevice=%p:{%s} enmBus=%u, aMediumAtt=%p\n",
3833	pThis, uInstance, pcszDevice, pcszDevice, enmBus, aMediumAtt));
3834
3835	AssertReturn(pThis, VERR_INVALID_PARAMETER);
3836
3837	AutoCaller autoCaller(pThis);
3838	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
3839
3840	/*
3841	* Check the VM for correct state.
3842	*/
3843	VMSTATE enmVMState = VMR3GetStateU(pUVM);
3844	AssertReturn(enmVMState == VMSTATE_SUSPENDED, VERR_INVALID_STATE);
3845
3846	/*
3847	* Determine the base path for the device instance. USB Msd devices are handled different
3848	* because the PDM USB API requires a differnet CFGM tree when attaching a new USB device.
3849	*/
3850	PCFGMNODE pCtlInst;
3851
3852	if (enmBus == StorageBus_USB)
3853	pCtlInst = CFGMR3CreateTree(pUVM);
3854	else
3855	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%u/", pcszDevice, uInstance);
3856
3857	AssertReturn(pCtlInst, VERR_INTERNAL_ERROR);
3858
3859	PCFGMNODE pLunL0 = NULL;
3860	int rc = pThis->i_configMediumAttachment(pCtlInst,
3861	pcszDevice,
3862	uInstance,
3863	enmBus,
3864	fUseHostIOCache,
3865	false /* fSetupMerge */,
3866	false /* fBuiltinIOCache */,
3867	0 /* uMergeSource */,
3868	0 /* uMergeTarget */,
3869	aMediumAtt,
3870	pThis->mMachineState,
3871	NULL /* phrc */,
3872	true /* fAttachDetach */,
3873	false /* fForceUnmount */,
3874	!fSilent /* fHotplug */,
3875	pUVM,
3876	NULL /* paLedDevType */,
3877	&pLunL0);
3878	/* Dump the changed LUN if possible, dump the complete device otherwise */
3879	if (enmBus != StorageBus_USB)
3880	CFGMR3Dump(pLunL0 ? pLunL0 : pCtlInst);
3881
3882	LogFlowFunc(("Returning %Rrc\n", rc));
3883	return rc;
3884	}
3885
3886	/**
3887	* Attach a new storage device to the VM.
3888	*
3889	* @param aMediumAttachment The medium attachment which is added.
3890	* @param pUVM Safe VM handle.
3891	* @param fSilent Flag whether to notify the guest about the detached device.
3892	*
3893	* @note Locks this object for writing.
3894	*/
3895	HRESULT Console::i_doStorageDeviceDetach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent)
3896	{
3897	AutoCaller autoCaller(this);
3898	AssertComRCReturnRC(autoCaller.rc());
3899
3900	/* We will need to release the write lock before calling EMT */
3901	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3902
3903	HRESULT rc = S_OK;
3904	const char *pszDevice = NULL;
3905
3906	SafeIfaceArray<IStorageController> ctrls;
3907	rc = mMachine->COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(ctrls));
3908	AssertComRC(rc);
3909	IMedium *pMedium;
3910	rc = aMediumAttachment->COMGETTER(Medium)(&pMedium);
3911	AssertComRC(rc);
3912	Bstr mediumLocation;
3913	if (pMedium)
3914	{
3915	rc = pMedium->COMGETTER(Location)(mediumLocation.asOutParam());
3916	AssertComRC(rc);
3917	}
3918
3919	Bstr attCtrlName;
3920	rc = aMediumAttachment->COMGETTER(Controller)(attCtrlName.asOutParam());
3921	AssertComRC(rc);
3922	ComPtr<IStorageController> pStorageController;
3923	for (size_t i = 0; i < ctrls.size(); ++i)
3924	{
3925	Bstr ctrlName;
3926	rc = ctrls[i]->COMGETTER(Name)(ctrlName.asOutParam());
3927	AssertComRC(rc);
3928	if (attCtrlName == ctrlName)
3929	{
3930	pStorageController = ctrls[i];
3931	break;
3932	}
3933	}
3934	if (pStorageController.isNull())
3935	return setError(E_FAIL,
3936	tr("Could not find storage controller '%ls'"), attCtrlName.raw());
3937
3938	StorageControllerType_T enmCtrlType;
3939	rc = pStorageController->COMGETTER(ControllerType)(&enmCtrlType);
3940	AssertComRC(rc);
3941	pszDevice = i_convertControllerTypeToDev(enmCtrlType);
3942
3943	StorageBus_T enmBus;
3944	rc = pStorageController->COMGETTER(Bus)(&enmBus);
3945	AssertComRC(rc);
3946	ULONG uInstance;
3947	rc = pStorageController->COMGETTER(Instance)(&uInstance);
3948	AssertComRC(rc);
3949
3950	/*
3951	* Suspend the VM first. The VM must not be running since it might have
3952	* pending I/O to the drive which is being changed.
3953	*/
3954	bool fResume = false;
3955	rc = i_suspendBeforeConfigChange(pUVM, &alock, &fResume);
3956	if (FAILED(rc))
3957	return rc;
3958
3959	/*
3960	* Call worker in EMT, that's faster and safer than doing everything
3961	* using VMR3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
3962	* here to make requests from under the lock in order to serialize them.
3963	*/
3964	PVMREQ pReq;
3965	int vrc = VMR3ReqCallU(pUVM, VMCPUID_ANY, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
3966	(PFNRT)i_detachStorageDevice, 7,
3967	this, pUVM, pszDevice, uInstance, enmBus, aMediumAttachment, fSilent);
3968
3969	/* release the lock before waiting for a result (EMT will call us back!) */
3970	alock.release();
3971
3972	if (vrc == VERR_TIMEOUT \|\| RT_SUCCESS(vrc))
3973	{
3974	vrc = VMR3ReqWait(pReq, RT_INDEFINITE_WAIT);
3975	AssertRC(vrc);
3976	if (RT_SUCCESS(vrc))
3977	vrc = pReq->iStatus;
3978	}
3979	VMR3ReqFree(pReq);
3980
3981	if (fResume)
3982	i_resumeAfterConfigChange(pUVM);
3983
3984	if (RT_SUCCESS(vrc))
3985	{
3986	LogFlowThisFunc(("Returns S_OK\n"));
3987	return S_OK;
3988	}
3989
3990	if (!pMedium)
3991	return setError(E_FAIL,
3992	tr("Could not mount the media/drive '%ls' (%Rrc)"),
3993	mediumLocation.raw(), vrc);
3994
3995	return setError(E_FAIL,
3996	tr("Could not unmount the currently mounted media/drive (%Rrc)"),
3997	vrc);
3998	}
3999
4000	/**
4001	* Performs the storage detach operation in EMT.
4002	*
4003	* @returns VBox status code.
4004	*
4005	* @param pThis Pointer to the Console object.
4006	* @param pUVM The VM handle.
4007	* @param pcszDevice The PDM device name.
4008	* @param uInstance The PDM device instance.
4009	* @param fSilent Flag whether to notify the guest about the detached device.
4010	*
4011	* @thread EMT
4012	* @note The VM must not be running since it might have pending I/O to the drive which is being changed.
4013	*/
4014	DECLCALLBACK(int) Console::i_detachStorageDevice(Console *pThis,
4015	PUVM pUVM,
4016	const char *pcszDevice,
4017	unsigned uInstance,
4018	StorageBus_T enmBus,
4019	IMediumAttachment *pMediumAtt,
4020	bool fSilent)
4021	{
4022	LogFlowFunc(("pThis=%p uInstance=%u pszDevice=%p:{%s} enmBus=%u, pMediumAtt=%p\n",
4023	pThis, uInstance, pcszDevice, pcszDevice, enmBus, pMediumAtt));
4024
4025	AssertReturn(pThis, VERR_INVALID_PARAMETER);
4026
4027	AutoCaller autoCaller(pThis);
4028	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
4029
4030	/*
4031	* Check the VM for correct state.
4032	*/
4033	VMSTATE enmVMState = VMR3GetStateU(pUVM);
4034	AssertReturn(enmVMState == VMSTATE_SUSPENDED, VERR_INVALID_STATE);
4035
4036	/* Determine the base path for the device instance. */
4037	PCFGMNODE pCtlInst;
4038	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%u/", pcszDevice, uInstance);
4039	AssertReturn(pCtlInst \|\| enmBus == StorageBus_USB, VERR_INTERNAL_ERROR);
4040
4041	#define H() AssertMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_GENERAL_FAILURE)
4042
4043	HRESULT hrc;
4044	int rc = VINF_SUCCESS;
4045	int rcRet = VINF_SUCCESS;
4046	unsigned uLUN;
4047	LONG lDev;
4048	LONG lPort;
4049	DeviceType_T lType;
4050	PCFGMNODE pLunL0 = NULL;
4051	PCFGMNODE pCfg = NULL;
4052
4053	hrc = pMediumAtt->COMGETTER(Device)(&lDev); H();
4054	hrc = pMediumAtt->COMGETTER(Port)(&lPort); H();
4055	hrc = pMediumAtt->COMGETTER(Type)(&lType); H();
4056	hrc = Console::i_convertBusPortDeviceToLun(enmBus, lPort, lDev, uLUN); H();
4057
4058	#undef H
4059
4060	if (enmBus != StorageBus_USB)
4061	{
4062	/* First check if the LUN really exists. */
4063	pLunL0 = CFGMR3GetChildF(pCtlInst, "LUN#%u", uLUN);
4064	if (pLunL0)
4065	{
4066	uint32_t fFlags = 0;
4067
4068	if (fSilent)
4069	fFlags \|= PDM_TACH_FLAGS_NOT_HOT_PLUG;
4070
4071	rc = PDMR3DeviceDetach(pUVM, pcszDevice, uInstance, uLUN, fFlags);
4072	if (rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
4073	rc = VINF_SUCCESS;
4074	AssertRCReturn(rc, rc);
4075	CFGMR3RemoveNode(pLunL0);
4076
4077	Utf8Str devicePath = Utf8StrFmt("%s/%u/LUN#%u", pcszDevice, uInstance, uLUN);
4078	pThis->mapMediumAttachments.erase(devicePath);
4079
4080	}
4081	else
4082	AssertFailedReturn(VERR_INTERNAL_ERROR);
4083
4084	CFGMR3Dump(pCtlInst);
4085	}
4086	else
4087	{
4088	/* Find the correct USB device in the list. */
4089	USBStorageDeviceList::iterator it;
4090	for (it = pThis->mUSBStorageDevices.begin(); it != pThis->mUSBStorageDevices.end(); it++)
4091	{
4092	if (it->iPort == lPort)
4093	break;
4094	}
4095
4096	AssertReturn(it != pThis->mUSBStorageDevices.end(), VERR_INTERNAL_ERROR);
4097	rc = PDMR3UsbDetachDevice(pUVM, &it->mUuid);
4098	AssertRCReturn(rc, rc);
4099	pThis->mUSBStorageDevices.erase(it);
4100	}
4101
4102	LogFlowFunc(("Returning %Rrc\n", rcRet));
4103	return rcRet;
4104	}
4105
4106	/**
4107	* Called by IInternalSessionControl::OnNetworkAdapterChange().
4108	*
4109	* @note Locks this object for writing.
4110	*/
4111	HRESULT Console::i_onNetworkAdapterChange(INetworkAdapter *aNetworkAdapter, BOOL changeAdapter)
4112	{
4113	LogFlowThisFunc(("\n"));
4114
4115	AutoCaller autoCaller(this);
4116	AssertComRCReturnRC(autoCaller.rc());
4117
4118	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4119
4120	HRESULT rc = S_OK;
4121
4122	/* don't trigger network changes if the VM isn't running */
4123	SafeVMPtrQuiet ptrVM(this);
4124	if (ptrVM.isOk())
4125	{
4126	/* Get the properties we need from the adapter */
4127	BOOL fCableConnected, fTraceEnabled;
4128	rc = aNetworkAdapter->COMGETTER(CableConnected)(&fCableConnected);
4129	AssertComRC(rc);
4130	if (SUCCEEDED(rc))
4131	{
4132	rc = aNetworkAdapter->COMGETTER(TraceEnabled)(&fTraceEnabled);
4133	AssertComRC(rc);
4134	}
4135	if (SUCCEEDED(rc))
4136	{
4137	ULONG ulInstance;
4138	rc = aNetworkAdapter->COMGETTER(Slot)(&ulInstance);
4139	AssertComRC(rc);
4140	if (SUCCEEDED(rc))
4141	{
4142	/*
4143	* Find the adapter instance, get the config interface and update
4144	* the link state.
4145	*/
4146	NetworkAdapterType_T adapterType;
4147	rc = aNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
4148	AssertComRC(rc);
4149	const char *pszAdapterName = networkAdapterTypeToName(adapterType);
4150
4151	// prevent cross-thread deadlocks, don't need the lock any more
4152	alock.release();
4153
4154	PPDMIBASE pBase;
4155	int vrc = PDMR3QueryDeviceLun(ptrVM.rawUVM(), pszAdapterName, ulInstance, 0, &pBase);
4156	if (RT_SUCCESS(vrc))
4157	{
4158	Assert(pBase);
4159	PPDMINETWORKCONFIG pINetCfg;
4160	pINetCfg = PDMIBASE_QUERY_INTERFACE(pBase, PDMINETWORKCONFIG);
4161	if (pINetCfg)
4162	{
4163	Log(("Console::onNetworkAdapterChange: setting link state to %d\n",
4164	fCableConnected));
4165	vrc = pINetCfg->pfnSetLinkState(pINetCfg,
4166	fCableConnected ? PDMNETWORKLINKSTATE_UP
4167	: PDMNETWORKLINKSTATE_DOWN);
4168	ComAssertRC(vrc);
4169	}
4170	if (RT_SUCCESS(vrc) && changeAdapter)
4171	{
4172	VMSTATE enmVMState = VMR3GetStateU(ptrVM.rawUVM());
4173	if ( enmVMState == VMSTATE_RUNNING /** @todo LiveMigration: Forbid or deal
4174	correctly with the _LS variants */
4175	\|\| enmVMState == VMSTATE_SUSPENDED)
4176	{
4177	if (fTraceEnabled && fCableConnected && pINetCfg)
4178	{
4179	vrc = pINetCfg->pfnSetLinkState(pINetCfg, PDMNETWORKLINKSTATE_DOWN);
4180	ComAssertRC(vrc);
4181	}
4182
4183	rc = i_doNetworkAdapterChange(ptrVM.rawUVM(), pszAdapterName, ulInstance, 0, aNetworkAdapter);
4184
4185	if (fTraceEnabled && fCableConnected && pINetCfg)
4186	{
4187	vrc = pINetCfg->pfnSetLinkState(pINetCfg, PDMNETWORKLINKSTATE_UP);
4188	ComAssertRC(vrc);
4189	}
4190	}
4191	}
4192	}
4193	else if (vrc == VERR_PDM_DEVICE_INSTANCE_NOT_FOUND)
4194	return setError(E_FAIL,
4195	tr("The network adapter #%u is not enabled"), ulInstance);
4196	else
4197	ComAssertRC(vrc);
4198
4199	if (RT_FAILURE(vrc))
4200	rc = E_FAIL;
4201
4202	alock.acquire();
4203	}
4204	}
4205	ptrVM.release();
4206	}
4207
4208	// definitely don't need the lock any more
4209	alock.release();
4210
4211	/* notify console callbacks on success */
4212	if (SUCCEEDED(rc))
4213	fireNetworkAdapterChangedEvent(mEventSource, aNetworkAdapter);
4214
4215	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
4216	return rc;
4217	}
4218
4219	/**
4220	* Called by IInternalSessionControl::OnNATEngineChange().
4221	*
4222	* @note Locks this object for writing.
4223	*/
4224	HRESULT Console::i_onNATRedirectRuleChange(ULONG ulInstance, BOOL aNatRuleRemove,
4225	NATProtocol_T aProto, IN_BSTR aHostIP,
4226	LONG aHostPort, IN_BSTR aGuestIP,
4227	LONG aGuestPort)
4228	{
4229	LogFlowThisFunc(("\n"));
4230
4231	AutoCaller autoCaller(this);
4232	AssertComRCReturnRC(autoCaller.rc());
4233
4234	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4235
4236	HRESULT rc = S_OK;
4237
4238	/* don't trigger NAT engine changes if the VM isn't running */
4239	SafeVMPtrQuiet ptrVM(this);
4240	if (ptrVM.isOk())
4241	{
4242	do
4243	{
4244	ComPtr<INetworkAdapter> pNetworkAdapter;
4245	rc = i_machine()->GetNetworkAdapter(ulInstance, pNetworkAdapter.asOutParam());
4246	if ( FAILED(rc)
4247	\|\| pNetworkAdapter.isNull())
4248	break;
4249
4250	/*
4251	* Find the adapter instance, get the config interface and update
4252	* the link state.
4253	*/
4254	NetworkAdapterType_T adapterType;
4255	rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
4256	if (FAILED(rc))
4257	{
4258	AssertComRC(rc);
4259	rc = E_FAIL;
4260	break;
4261	}
4262
4263	const char *pszAdapterName = networkAdapterTypeToName(adapterType);
4264	PPDMIBASE pBase;
4265	int vrc = PDMR3QueryLun(ptrVM.rawUVM(), pszAdapterName, ulInstance, 0, &pBase);
4266	if (RT_FAILURE(vrc))
4267	{
4268	ComAssertRC(vrc);
4269	rc = E_FAIL;
4270	break;
4271	}
4272
4273	NetworkAttachmentType_T attachmentType;
4274	rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);
4275	if ( FAILED(rc)
4276	\|\| attachmentType != NetworkAttachmentType_NAT)
4277	{
4278	rc = E_FAIL;
4279	break;
4280	}
4281
4282	/* look down for PDMINETWORKNATCONFIG interface */
4283	PPDMINETWORKNATCONFIG pNetNatCfg = NULL;
4284	while (pBase)
4285	{
4286	pNetNatCfg = (PPDMINETWORKNATCONFIG)pBase->pfnQueryInterface(pBase, PDMINETWORKNATCONFIG_IID);
4287	if (pNetNatCfg)
4288	break;
4289	/** @todo r=bird: This stinks! */
4290	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pBase);
4291	pBase = pDrvIns->pDownBase;
4292	}
4293	if (!pNetNatCfg)
4294	break;
4295
4296	bool fUdp = aProto == NATProtocol_UDP;
4297	vrc = pNetNatCfg->pfnRedirectRuleCommand(pNetNatCfg, !!aNatRuleRemove, fUdp,
4298	Utf8Str(aHostIP).c_str(), (uint16_t)aHostPort, Utf8Str(aGuestIP).c_str(),
4299	(uint16_t)aGuestPort);
4300	if (RT_FAILURE(vrc))
4301	rc = E_FAIL;
4302	} while (0); /* break loop */
4303	ptrVM.release();
4304	}
4305
4306	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
4307	return rc;
4308	}
4309
4310	VMMDevMouseInterface *Console::i_getVMMDevMouseInterface()
4311	{
4312	return m_pVMMDev;
4313	}
4314
4315	DisplayMouseInterface *Console::i_getDisplayMouseInterface()
4316	{
4317	return mDisplay;
4318	}
4319
4320	/**
4321	* Parses one key value pair.
4322	*
4323	* @returns VBox status code.
4324	* @param psz Configuration string.
4325	* @param ppszEnd Where to store the pointer to the string following the key value pair.
4326	* @param ppszKey Where to store the key on success.
4327	* @param ppszVal Where to store the value on success.
4328	*/
4329	int Console::i_consoleParseKeyValue(const char psz, const char *ppszEnd,
4330	char ppszKey, char ppszVal)
4331	{
4332	int rc = VINF_SUCCESS;
4333	const char *pszKeyStart = psz;
4334	const char *pszValStart = NULL;
4335	size_t cchKey = 0;
4336	size_t cchVal = 0;
4337
4338	while ( *psz != '='
4339	&& *psz)
4340	psz++;
4341
4342	/* End of string at this point is invalid. */
4343	if (*psz == '\0')
4344	return VERR_INVALID_PARAMETER;
4345
4346	cchKey = psz - pszKeyStart;
4347	psz++; /* Skip = character */
4348	pszValStart = psz;
4349
4350	while ( *psz != ','
4351	&& *psz != '\n'
4352	&& *psz != '\r'
4353	&& *psz)
4354	psz++;
4355
4356	cchVal = psz - pszValStart;
4357
4358	if (cchKey && cchVal)
4359	{
4360	*ppszKey = RTStrDupN(pszKeyStart, cchKey);
4361	if (*ppszKey)
4362	{
4363	*ppszVal = RTStrDupN(pszValStart, cchVal);
4364	if (!*ppszVal)
4365	{
4366	RTStrFree(*ppszKey);
4367	rc = VERR_NO_MEMORY;
4368	}
4369	}
4370	else
4371	rc = VERR_NO_MEMORY;
4372	}
4373	else
4374	rc = VERR_INVALID_PARAMETER;
4375
4376	if (RT_SUCCESS(rc))
4377	*ppszEnd = psz;
4378
4379	return rc;
4380	}
4381
4382	/**
4383	* Removes the key interfaces from all disk attachments, useful when
4384	* changing the key store or dropping it.
4385	*/
4386	HRESULT Console::i_clearDiskEncryptionKeysOnAllAttachments(void)
4387	{
4388	HRESULT hrc = S_OK;
4389	SafeIfaceArray<IMediumAttachment> sfaAttachments;
4390
4391	AutoCaller autoCaller(this);
4392	AssertComRCReturnRC(autoCaller.rc());
4393
4394	/* Get the VM - must be done before the read-locking. */
4395	SafeVMPtr ptrVM(this);
4396	if (!ptrVM.isOk())
4397	return ptrVM.rc();
4398
4399	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4400
4401	hrc = mMachine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));
4402	AssertComRCReturnRC(hrc);
4403
4404	/* Find the correct attachment. */
4405	for (unsigned i = 0; i < sfaAttachments.size(); i++)
4406	{
4407	const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[i];
4408
4409	/*
4410	* Query storage controller, port and device
4411	* to identify the correct driver.
4412	*/
4413	ComPtr<IStorageController> pStorageCtrl;
4414	Bstr storageCtrlName;
4415	LONG lPort, lDev;
4416	ULONG ulStorageCtrlInst;
4417
4418	hrc = pAtt->COMGETTER(Controller)(storageCtrlName.asOutParam());
4419	AssertComRC(hrc);
4420
4421	hrc = pAtt->COMGETTER(Port)(&lPort);
4422	AssertComRC(hrc);
4423
4424	hrc = pAtt->COMGETTER(Device)(&lDev);
4425	AssertComRC(hrc);
4426
4427	hrc = mMachine->GetStorageControllerByName(storageCtrlName.raw(), pStorageCtrl.asOutParam());
4428	AssertComRC(hrc);
4429
4430	hrc = pStorageCtrl->COMGETTER(Instance)(&ulStorageCtrlInst);
4431	AssertComRC(hrc);
4432
4433	StorageControllerType_T enmCtrlType;
4434	hrc = pStorageCtrl->COMGETTER(ControllerType)(&enmCtrlType);
4435	AssertComRC(hrc);
4436	const char *pcszDevice = i_convertControllerTypeToDev(enmCtrlType);
4437
4438	StorageBus_T enmBus;
4439	hrc = pStorageCtrl->COMGETTER(Bus)(&enmBus);
4440	AssertComRC(hrc);
4441
4442	unsigned uLUN;
4443	hrc = Console::i_convertBusPortDeviceToLun(enmBus, lPort, lDev, uLUN);
4444	AssertComRC(hrc);
4445
4446	PPDMIBASE pIBase = NULL;
4447	PPDMIMEDIA pIMedium = NULL;
4448	int rc = PDMR3QueryDriverOnLun(ptrVM.rawUVM(), pcszDevice, ulStorageCtrlInst, uLUN, "VD", &pIBase);
4449	if (RT_SUCCESS(rc))
4450	{
4451	if (pIBase)
4452	{
4453	pIMedium = (PPDMIMEDIA)pIBase->pfnQueryInterface(pIBase, PDMIMEDIA_IID);
4454	if (pIMedium)
4455	{
4456	rc = pIMedium->pfnSetSecKeyIf(pIMedium, NULL);
4457	Assert(RT_SUCCESS(rc) \|\| rc == VERR_NOT_SUPPORTED);
4458	}
4459	}
4460	}
4461	}
4462
4463	return hrc;
4464	}
4465
4466	/**
4467	* Configures the encryption support for the disk identified by the gien UUID with
4468	* the given key.
4469	*
4470	* @returns COM status code.
4471	* @param pszUuid The UUID of the disk to configure encryption for.
4472	*/
4473	HRESULT Console::i_configureEncryptionForDisk(const char *pszUuid)
4474	{
4475	HRESULT hrc = S_OK;
4476	SafeIfaceArray<IMediumAttachment> sfaAttachments;
4477
4478	AutoCaller autoCaller(this);
4479	AssertComRCReturnRC(autoCaller.rc());
4480
4481	/* Get the VM - must be done before the read-locking. */
4482	SafeVMPtr ptrVM(this);
4483	if (!ptrVM.isOk())
4484	return ptrVM.rc();
4485
4486	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4487
4488	hrc = mMachine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));
4489	if (FAILED(hrc))
4490	return hrc;
4491
4492	/* Find the correct attachment. */
4493	for (unsigned i = 0; i < sfaAttachments.size(); i++)
4494	{
4495	const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[i];
4496	ComPtr<IMedium> pMedium;
4497	ComPtr<IMedium> pBase;
4498	Bstr uuid;
4499
4500	hrc = pAtt->COMGETTER(Medium)(pMedium.asOutParam());
4501	if (FAILED(hrc))
4502	break;
4503
4504	/* Skip non hard disk attachments. */
4505	if (pMedium.isNull())
4506	continue;
4507
4508	/* Get the UUID of the base medium and compare. */
4509	hrc = pMedium->COMGETTER(Base)(pBase.asOutParam());
4510	if (FAILED(hrc))
4511	break;
4512
4513	hrc = pBase->COMGETTER(Id)(uuid.asOutParam());
4514	if (FAILED(hrc))
4515	break;
4516
4517	if (!RTUuidCompare2Strs(Utf8Str(uuid).c_str(), pszUuid))
4518	{
4519	/*
4520	* Found the matching medium, query storage controller, port and device
4521	* to identify the correct driver.
4522	*/
4523	ComPtr<IStorageController> pStorageCtrl;
4524	Bstr storageCtrlName;
4525	LONG lPort, lDev;
4526	ULONG ulStorageCtrlInst;
4527
4528	hrc = pAtt->COMGETTER(Controller)(storageCtrlName.asOutParam());
4529	if (FAILED(hrc))
4530	break;
4531
4532	hrc = pAtt->COMGETTER(Port)(&lPort);
4533	if (FAILED(hrc))
4534	break;
4535
4536	hrc = pAtt->COMGETTER(Device)(&lDev);
4537	if (FAILED(hrc))
4538	break;
4539
4540	hrc = mMachine->GetStorageControllerByName(storageCtrlName.raw(), pStorageCtrl.asOutParam());
4541	if (FAILED(hrc))
4542	break;
4543
4544	hrc = pStorageCtrl->COMGETTER(Instance)(&ulStorageCtrlInst);
4545	if (FAILED(hrc))
4546	break;
4547
4548	StorageControllerType_T enmCtrlType;
4549	hrc = pStorageCtrl->COMGETTER(ControllerType)(&enmCtrlType);
4550	AssertComRC(hrc);
4551	const char *pcszDevice = i_convertControllerTypeToDev(enmCtrlType);
4552
4553	StorageBus_T enmBus;
4554	hrc = pStorageCtrl->COMGETTER(Bus)(&enmBus);
4555	AssertComRC(hrc);
4556
4557	unsigned uLUN;
4558	hrc = Console::i_convertBusPortDeviceToLun(enmBus, lPort, lDev, uLUN);
4559	AssertComRCReturnRC(hrc);
4560
4561	PPDMIBASE pIBase = NULL;
4562	PPDMIMEDIA pIMedium = NULL;
4563	int rc = PDMR3QueryDriverOnLun(ptrVM.rawUVM(), pcszDevice, ulStorageCtrlInst, uLUN, "VD", &pIBase);
4564	if (RT_SUCCESS(rc))
4565	{
4566	if (pIBase)
4567	{
4568	pIMedium = (PPDMIMEDIA)pIBase->pfnQueryInterface(pIBase, PDMIMEDIA_IID);
4569	if (!pIMedium)
4570	return setError(E_FAIL, tr("could not query medium interface of controller"));
4571	else
4572	{
4573	rc = pIMedium->pfnSetSecKeyIf(pIMedium, mpIfSecKey);
4574	if (RT_FAILURE(rc))
4575	return setError(E_FAIL, tr("Failed to set the encryption key (%Rrc)"), rc);
4576	}
4577	}
4578	else
4579	return setError(E_FAIL, tr("could not query base interface of controller"));
4580	}
4581	}
4582	}
4583
4584	return hrc;
4585	}
4586
4587	/**
4588	* Parses the encryption configuration for one disk.
4589	*
4590	* @returns Pointer to the string following encryption configuration.
4591	* @param psz Pointer to the configuration for the encryption of one disk.
4592	*/
4593	HRESULT Console::i_consoleParseDiskEncryption(const char psz, const char *ppszEnd)
4594	{
4595	char *pszUuid = NULL;
4596	char *pszKeyEnc = NULL;
4597	int rc = VINF_SUCCESS;
4598	HRESULT hrc = S_OK;
4599
4600	while ( *psz
4601	&& RT_SUCCESS(rc))
4602	{
4603	char *pszKey = NULL;
4604	char *pszVal = NULL;
4605	const char *pszEnd = NULL;
4606
4607	rc = i_consoleParseKeyValue(psz, &pszEnd, &pszKey, &pszVal);
4608	if (RT_SUCCESS(rc))
4609	{
4610	if (!RTStrCmp(pszKey, "uuid"))
4611	pszUuid = pszVal;
4612	else if (!RTStrCmp(pszKey, "dek"))
4613	pszKeyEnc = pszVal;
4614	else
4615	rc = VERR_INVALID_PARAMETER;
4616
4617	RTStrFree(pszKey);
4618
4619	if (*pszEnd == ',')
4620	psz = pszEnd + 1;
4621	else
4622	{
4623	/*
4624	* End of the configuration for the current disk, skip linefeed and
4625	* carriage returns.
4626	*/
4627	while ( *pszEnd == '\n'
4628	\|\| *pszEnd == '\r')
4629	pszEnd++;
4630
4631	psz = pszEnd;
4632	break; /* Stop parsing */
4633	}
4634
4635	}
4636	}
4637
4638	if ( RT_SUCCESS(rc)
4639	&& pszUuid
4640	&& pszKeyEnc)
4641	{
4642	ssize_t cbKey = 0;
4643
4644	/* Decode the key. */
4645	cbKey = RTBase64DecodedSize(pszKeyEnc, NULL);
4646	if (cbKey != -1)
4647	{
4648	uint8_t pbKey = (uint8_t )RTMemSaferAllocZ(cbKey);
4649	if (pbKey)
4650	{
4651	rc = RTBase64Decode(pszKeyEnc, pbKey, cbKey, NULL, NULL);
4652	if (RT_SUCCESS(rc))
4653	{
4654	SecretKey *pKey = new SecretKey(pbKey, cbKey);
4655	/* Add the key to the map */
4656	m_mapSecretKeys.insert(std::make_pair(Utf8Str(pszUuid), pKey));
4657	hrc = i_configureEncryptionForDisk(pszUuid);
4658	}
4659	else
4660	hrc = setError(E_FAIL,
4661	tr("Failed to decode the key (%Rrc)"),
4662	rc);
4663	}
4664	else
4665	hrc = setError(E_FAIL,
4666	tr("Failed to allocate secure memory for the key"));
4667	}
4668	else
4669	hrc = setError(E_FAIL,
4670	tr("The base64 encoding of the passed key is incorrect"));
4671	}
4672	else if (RT_SUCCESS(rc))
4673	hrc = setError(E_FAIL,
4674	tr("The encryption configuration is incomplete"));
4675
4676	if (pszUuid)
4677	RTStrFree(pszUuid);
4678	if (pszKeyEnc)
4679	{
4680	RTMemWipeThoroughly(pszKeyEnc, strlen(pszKeyEnc), 10 /* cMinPasses */);
4681	RTStrFree(pszKeyEnc);
4682	}
4683
4684	if (ppszEnd)
4685	*ppszEnd = psz;
4686
4687	return hrc;
4688	}
4689
4690	HRESULT Console::i_setDiskEncryptionKeys(const Utf8Str &strCfg)
4691	{
4692	HRESULT hrc = S_OK;
4693	const char *pszCfg = strCfg.c_str();
4694
4695	while ( *pszCfg
4696	&& SUCCEEDED(hrc))
4697	{
4698	const char *pszNext = NULL;
4699	hrc = i_consoleParseDiskEncryption(pszCfg, &pszNext);
4700	pszCfg = pszNext;
4701	}
4702
4703	return hrc;
4704	}
4705
4706	/**
4707	* Process a network adaptor change.
4708	*
4709	* @returns COM status code.
4710	*
4711	* @parma pUVM The VM handle (caller hold this safely).
4712	* @param pszDevice The PDM device name.
4713	* @param uInstance The PDM device instance.
4714	* @param uLun The PDM LUN number of the drive.
4715	* @param aNetworkAdapter The network adapter whose attachment needs to be changed
4716	*/
4717	HRESULT Console::i_doNetworkAdapterChange(PUVM pUVM,
4718	const char *pszDevice,
4719	unsigned uInstance,
4720	unsigned uLun,
4721	INetworkAdapter *aNetworkAdapter)
4722	{
4723	LogFlowThisFunc(("pszDevice=%p:{%s} uInstance=%u uLun=%u aNetworkAdapter=%p\n",
4724	pszDevice, pszDevice, uInstance, uLun, aNetworkAdapter));
4725
4726	AutoCaller autoCaller(this);
4727	AssertComRCReturnRC(autoCaller.rc());
4728
4729	/*
4730	* Suspend the VM first.
4731	*/
4732	bool fResume = false;
4733	int rc = i_suspendBeforeConfigChange(pUVM, NULL, &fResume);
4734	if (FAILED(rc))
4735	return rc;
4736
4737	/*
4738	* Call worker in EMT, that's faster and safer than doing everything
4739	* using VM3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
4740	* here to make requests from under the lock in order to serialize them.
4741	*/
4742	PVMREQ pReq;
4743	int vrc = VMR3ReqCallU(pUVM, 0 /idDstCpu/, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
4744	(PFNRT)i_changeNetworkAttachment, 6,
4745	this, pUVM, pszDevice, uInstance, uLun, aNetworkAdapter);
4746
4747	if (vrc == VERR_TIMEOUT \|\| RT_SUCCESS(vrc))
4748	{
4749	vrc = VMR3ReqWait(pReq, RT_INDEFINITE_WAIT);
4750	AssertRC(vrc);
4751	if (RT_SUCCESS(vrc))
4752	vrc = pReq->iStatus;
4753	}
4754	VMR3ReqFree(pReq);
4755
4756	if (fResume)
4757	i_resumeAfterConfigChange(pUVM);
4758
4759	if (RT_SUCCESS(vrc))
4760	{
4761	LogFlowThisFunc(("Returns S_OK\n"));
4762	return S_OK;
4763	}
4764
4765	return setError(E_FAIL,
4766	tr("Could not change the network adaptor attachement type (%Rrc)"),
4767	vrc);
4768	}
4769
4770
4771	/**
4772	* Performs the Network Adaptor change in EMT.
4773	*
4774	* @returns VBox status code.
4775	*
4776	* @param pThis Pointer to the Console object.
4777	* @param pUVM The VM handle.
4778	* @param pszDevice The PDM device name.
4779	* @param uInstance The PDM device instance.
4780	* @param uLun The PDM LUN number of the drive.
4781	* @param aNetworkAdapter The network adapter whose attachment needs to be changed
4782	*
4783	* @thread EMT
4784	* @note Locks the Console object for writing.
4785	* @note The VM must not be running.
4786	*/
4787	DECLCALLBACK(int) Console::i_changeNetworkAttachment(Console *pThis,
4788	PUVM pUVM,
4789	const char *pszDevice,
4790	unsigned uInstance,
4791	unsigned uLun,
4792	INetworkAdapter *aNetworkAdapter)
4793	{
4794	LogFlowFunc(("pThis=%p pszDevice=%p:{%s} uInstance=%u uLun=%u aNetworkAdapter=%p\n",
4795	pThis, pszDevice, pszDevice, uInstance, uLun, aNetworkAdapter));
4796
4797	AssertReturn(pThis, VERR_INVALID_PARAMETER);
4798
4799	AutoCaller autoCaller(pThis);
4800	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
4801
4802	ComPtr<IVirtualBox> pVirtualBox;
4803	pThis->mMachine->COMGETTER(Parent)(pVirtualBox.asOutParam());
4804	ComPtr<ISystemProperties> pSystemProperties;
4805	if (pVirtualBox)
4806	pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
4807	ChipsetType_T chipsetType = ChipsetType_PIIX3;
4808	pThis->mMachine->COMGETTER(ChipsetType)(&chipsetType);
4809	ULONG maxNetworkAdapters = 0;
4810	if (pSystemProperties)
4811	pSystemProperties->GetMaxNetworkAdapters(chipsetType, &maxNetworkAdapters);
4812	AssertMsg( ( !strcmp(pszDevice, "pcnet")
4813	\|\| !strcmp(pszDevice, "e1000")
4814	\|\| !strcmp(pszDevice, "virtio-net"))
4815	&& uLun == 0
4816	&& uInstance < maxNetworkAdapters,
4817	("pszDevice=%s uLun=%d uInstance=%d\n", pszDevice, uLun, uInstance));
4818	Log(("pszDevice=%s uLun=%d uInstance=%d\n", pszDevice, uLun, uInstance));
4819
4820	/*
4821	* Check the VM for correct state.
4822	*/
4823	VMSTATE enmVMState = VMR3GetStateU(pUVM);
4824	AssertReturn(enmVMState == VMSTATE_SUSPENDED, VERR_INVALID_STATE);
4825
4826	PCFGMNODE pCfg = NULL; /* /Devices/Dev/.../Config/ */
4827	PCFGMNODE pLunL0 = NULL; /* /Devices/Dev/0/LUN#0/ */
4828	PCFGMNODE pInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%d/", pszDevice, uInstance);
4829	AssertRelease(pInst);
4830
4831	int rc = pThis->i_configNetwork(pszDevice, uInstance, uLun, aNetworkAdapter, pCfg, pLunL0, pInst,
4832	true /fAttachDetach/, false /fIgnoreConnectFailure/);
4833
4834	LogFlowFunc(("Returning %Rrc\n", rc));
4835	return rc;
4836	}
4837
4838
4839	/**
4840	* Called by IInternalSessionControl::OnSerialPortChange().
4841	*/
4842	HRESULT Console::i_onSerialPortChange(ISerialPort *aSerialPort)
4843	{
4844	LogFlowThisFunc(("\n"));
4845
4846	AutoCaller autoCaller(this);
4847	AssertComRCReturnRC(autoCaller.rc());
4848
4849	fireSerialPortChangedEvent(mEventSource, aSerialPort);
4850
4851	LogFlowThisFunc(("Leaving rc=%#x\n", S_OK));
4852	return S_OK;
4853	}
4854
4855	/**
4856	* Called by IInternalSessionControl::OnParallelPortChange().
4857	*/
4858	HRESULT Console::i_onParallelPortChange(IParallelPort *aParallelPort)
4859	{
4860	LogFlowThisFunc(("\n"));
4861
4862	AutoCaller autoCaller(this);
4863	AssertComRCReturnRC(autoCaller.rc());
4864
4865	fireParallelPortChangedEvent(mEventSource, aParallelPort);
4866
4867	LogFlowThisFunc(("Leaving rc=%#x\n", S_OK));
4868	return S_OK;
4869	}
4870
4871	/**
4872	* Called by IInternalSessionControl::OnStorageControllerChange().
4873	*/
4874	HRESULT Console::i_onStorageControllerChange()
4875	{
4876	LogFlowThisFunc(("\n"));
4877
4878	AutoCaller autoCaller(this);
4879	AssertComRCReturnRC(autoCaller.rc());
4880
4881	fireStorageControllerChangedEvent(mEventSource);
4882
4883	LogFlowThisFunc(("Leaving rc=%#x\n", S_OK));
4884	return S_OK;
4885	}
4886
4887	/**
4888	* Called by IInternalSessionControl::OnMediumChange().
4889	*/
4890	HRESULT Console::i_onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce)
4891	{
4892	LogFlowThisFunc(("\n"));
4893
4894	AutoCaller autoCaller(this);
4895	AssertComRCReturnRC(autoCaller.rc());
4896
4897	HRESULT rc = S_OK;
4898
4899	/* don't trigger medium changes if the VM isn't running */
4900	SafeVMPtrQuiet ptrVM(this);
4901	if (ptrVM.isOk())
4902	{
4903	rc = i_doMediumChange(aMediumAttachment, !!aForce, ptrVM.rawUVM());
4904	ptrVM.release();
4905	}
4906
4907	/* notify console callbacks on success */
4908	if (SUCCEEDED(rc))
4909	fireMediumChangedEvent(mEventSource, aMediumAttachment);
4910
4911	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
4912	return rc;
4913	}
4914
4915	/**
4916	* Called by IInternalSessionControl::OnCPUChange().
4917	*
4918	* @note Locks this object for writing.
4919	*/
4920	HRESULT Console::i_onCPUChange(ULONG aCPU, BOOL aRemove)
4921	{
4922	LogFlowThisFunc(("\n"));
4923
4924	AutoCaller autoCaller(this);
4925	AssertComRCReturnRC(autoCaller.rc());
4926
4927	HRESULT rc = S_OK;
4928
4929	/* don't trigger CPU changes if the VM isn't running */
4930	SafeVMPtrQuiet ptrVM(this);
4931	if (ptrVM.isOk())
4932	{
4933	if (aRemove)
4934	rc = i_doCPURemove(aCPU, ptrVM.rawUVM());
4935	else
4936	rc = i_doCPUAdd(aCPU, ptrVM.rawUVM());
4937	ptrVM.release();
4938	}
4939
4940	/* notify console callbacks on success */
4941	if (SUCCEEDED(rc))
4942	fireCPUChangedEvent(mEventSource, aCPU, aRemove);
4943
4944	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
4945	return rc;
4946	}
4947
4948	/**
4949	* Called by IInternalSessionControl::OnCpuExecutionCapChange().
4950	*
4951	* @note Locks this object for writing.
4952	*/
4953	HRESULT Console::i_onCPUExecutionCapChange(ULONG aExecutionCap)
4954	{
4955	LogFlowThisFunc(("\n"));
4956
4957	AutoCaller autoCaller(this);
4958	AssertComRCReturnRC(autoCaller.rc());
4959
4960	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4961
4962	HRESULT rc = S_OK;
4963
4964	/* don't trigger the CPU priority change if the VM isn't running */
4965	SafeVMPtrQuiet ptrVM(this);
4966	if (ptrVM.isOk())
4967	{
4968	if ( mMachineState == MachineState_Running
4969	\|\| mMachineState == MachineState_Teleporting
4970	\|\| mMachineState == MachineState_LiveSnapshotting
4971	)
4972	{
4973	/* No need to call in the EMT thread. */
4974	rc = VMR3SetCpuExecutionCap(ptrVM.rawUVM(), aExecutionCap);
4975	}
4976	else
4977	rc = i_setInvalidMachineStateError();
4978	ptrVM.release();
4979	}
4980
4981	/* notify console callbacks on success */
4982	if (SUCCEEDED(rc))
4983	{
4984	alock.release();
4985	fireCPUExecutionCapChangedEvent(mEventSource, aExecutionCap);
4986	}
4987
4988	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
4989	return rc;
4990	}
4991
4992	/**
4993	* Called by IInternalSessionControl::OnClipboardModeChange().
4994	*
4995	* @note Locks this object for writing.
4996	*/
4997	HRESULT Console::i_onClipboardModeChange(ClipboardMode_T aClipboardMode)
4998	{
4999	LogFlowThisFunc(("\n"));
5000
5001	AutoCaller autoCaller(this);
5002	AssertComRCReturnRC(autoCaller.rc());
5003
5004	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5005
5006	HRESULT rc = S_OK;
5007
5008	/* don't trigger the clipboard mode change if the VM isn't running */
5009	SafeVMPtrQuiet ptrVM(this);
5010	if (ptrVM.isOk())
5011	{
5012	if ( mMachineState == MachineState_Running
5013	\|\| mMachineState == MachineState_Teleporting
5014	\|\| mMachineState == MachineState_LiveSnapshotting)
5015	i_changeClipboardMode(aClipboardMode);
5016	else
5017	rc = i_setInvalidMachineStateError();
5018	ptrVM.release();
5019	}
5020
5021	/* notify console callbacks on success */
5022	if (SUCCEEDED(rc))
5023	{
5024	alock.release();
5025	fireClipboardModeChangedEvent(mEventSource, aClipboardMode);
5026	}
5027
5028	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
5029	return rc;
5030	}
5031
5032	/**
5033	* Called by IInternalSessionControl::OnDnDModeChange().
5034	*
5035	* @note Locks this object for writing.
5036	*/
5037	HRESULT Console::i_onDnDModeChange(DnDMode_T aDnDMode)
5038	{
5039	LogFlowThisFunc(("\n"));
5040
5041	AutoCaller autoCaller(this);
5042	AssertComRCReturnRC(autoCaller.rc());
5043
5044	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5045
5046	HRESULT rc = S_OK;
5047
5048	/* don't trigger the drag'n'drop mode change if the VM isn't running */
5049	SafeVMPtrQuiet ptrVM(this);
5050	if (ptrVM.isOk())
5051	{
5052	if ( mMachineState == MachineState_Running
5053	\|\| mMachineState == MachineState_Teleporting
5054	\|\| mMachineState == MachineState_LiveSnapshotting)
5055	i_changeDnDMode(aDnDMode);
5056	else
5057	rc = i_setInvalidMachineStateError();
5058	ptrVM.release();
5059	}
5060
5061	/* notify console callbacks on success */
5062	if (SUCCEEDED(rc))
5063	{
5064	alock.release();
5065	fireDnDModeChangedEvent(mEventSource, aDnDMode);
5066	}
5067
5068	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
5069	return rc;
5070	}
5071
5072	/**
5073	* Called by IInternalSessionControl::OnVRDEServerChange().
5074	*
5075	* @note Locks this object for writing.
5076	*/
5077	HRESULT Console::i_onVRDEServerChange(BOOL aRestart)
5078	{
5079	AutoCaller autoCaller(this);
5080	AssertComRCReturnRC(autoCaller.rc());
5081
5082	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5083
5084	HRESULT rc = S_OK;
5085
5086	/* don't trigger VRDE server changes if the VM isn't running */
5087	SafeVMPtrQuiet ptrVM(this);
5088	if (ptrVM.isOk())
5089	{
5090	/* Serialize. */
5091	if (mfVRDEChangeInProcess)
5092	mfVRDEChangePending = true;
5093	else
5094	{
5095	do {
5096	mfVRDEChangeInProcess = true;
5097	mfVRDEChangePending = false;
5098
5099	if ( mVRDEServer
5100	&& ( mMachineState == MachineState_Running
5101	\|\| mMachineState == MachineState_Teleporting
5102	\|\| mMachineState == MachineState_LiveSnapshotting
5103	\|\| mMachineState == MachineState_Paused
5104	)
5105	)
5106	{
5107	BOOL vrdpEnabled = FALSE;
5108
5109	rc = mVRDEServer->COMGETTER(Enabled)(&vrdpEnabled);
5110	ComAssertComRCRetRC(rc);
5111
5112	if (aRestart)
5113	{
5114	/* VRDP server may call this Console object back from other threads (VRDP INPUT or OUTPUT). */
5115	alock.release();
5116
5117	if (vrdpEnabled)
5118	{
5119	// If there was no VRDP server started the 'stop' will do nothing.
5120	// However if a server was started and this notification was called,
5121	// we have to restart the server.
5122	mConsoleVRDPServer->Stop();
5123
5124	if (RT_FAILURE(mConsoleVRDPServer->Launch()))
5125	rc = E_FAIL;
5126	else
5127	mConsoleVRDPServer->EnableConnections();
5128	}
5129	else
5130	mConsoleVRDPServer->Stop();
5131
5132	alock.acquire();
5133	}
5134	}
5135	else
5136	rc = i_setInvalidMachineStateError();
5137
5138	mfVRDEChangeInProcess = false;
5139	} while (mfVRDEChangePending && SUCCEEDED(rc));
5140	}
5141
5142	ptrVM.release();
5143	}
5144
5145	/* notify console callbacks on success */
5146	if (SUCCEEDED(rc))
5147	{
5148	alock.release();
5149	fireVRDEServerChangedEvent(mEventSource);
5150	}
5151
5152	return rc;
5153	}
5154
5155	void Console::i_onVRDEServerInfoChange()
5156	{
5157	AutoCaller autoCaller(this);
5158	AssertComRCReturnVoid(autoCaller.rc());
5159
5160	fireVRDEServerInfoChangedEvent(mEventSource);
5161	}
5162
5163	HRESULT Console::i_onVideoCaptureChange()
5164	{
5165	AutoCaller autoCaller(this);
5166	AssertComRCReturnRC(autoCaller.rc());
5167
5168	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5169
5170	HRESULT rc = S_OK;
5171
5172	/* don't trigger video capture changes if the VM isn't running */
5173	SafeVMPtrQuiet ptrVM(this);
5174	if (ptrVM.isOk())
5175	{
5176	BOOL fEnabled;
5177	rc = mMachine->COMGETTER(VideoCaptureEnabled)(&fEnabled);
5178	SafeArray<BOOL> screens;
5179	if (SUCCEEDED(rc))
5180	rc = mMachine->COMGETTER(VideoCaptureScreens)(ComSafeArrayAsOutParam(screens));
5181	if (mDisplay)
5182	{
5183	int vrc = VINF_SUCCESS;
5184	if (SUCCEEDED(rc))
5185	vrc = mDisplay->VideoCaptureEnableScreens(ComSafeArrayAsInParam(screens));
5186	if (RT_SUCCESS(vrc))
5187	{
5188	if (fEnabled)
5189	{
5190	vrc = mDisplay->VideoCaptureStart();
5191	if (RT_FAILURE(vrc))
5192	rc = setError(E_FAIL, tr("Unable to start video capturing (%Rrc)"), vrc);
5193	}
5194	else
5195	mDisplay->VideoCaptureStop();
5196	}
5197	else
5198	rc = setError(E_FAIL, tr("Unable to set screens for capturing (%Rrc)"), vrc);
5199	}
5200	ptrVM.release();
5201	}
5202
5203	/* notify console callbacks on success */
5204	if (SUCCEEDED(rc))
5205	{
5206	alock.release();
5207	fireVideoCaptureChangedEvent(mEventSource);
5208	}
5209
5210	return rc;
5211	}
5212
5213	/**
5214	* Called by IInternalSessionControl::OnUSBControllerChange().
5215	*/
5216	HRESULT Console::i_onUSBControllerChange()
5217	{
5218	LogFlowThisFunc(("\n"));
5219
5220	AutoCaller autoCaller(this);
5221	AssertComRCReturnRC(autoCaller.rc());
5222
5223	fireUSBControllerChangedEvent(mEventSource);
5224
5225	return S_OK;
5226	}
5227
5228	/**
5229	* Called by IInternalSessionControl::OnSharedFolderChange().
5230	*
5231	* @note Locks this object for writing.
5232	*/
5233	HRESULT Console::i_onSharedFolderChange(BOOL aGlobal)
5234	{
5235	LogFlowThisFunc(("aGlobal=%RTbool\n", aGlobal));
5236
5237	AutoCaller autoCaller(this);
5238	AssertComRCReturnRC(autoCaller.rc());
5239
5240	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5241
5242	HRESULT rc = i_fetchSharedFolders(aGlobal);
5243
5244	/* notify console callbacks on success */
5245	if (SUCCEEDED(rc))
5246	{
5247	alock.release();
5248	fireSharedFolderChangedEvent(mEventSource, aGlobal ? (Scope_T)Scope_Global : (Scope_T)Scope_Machine);
5249	}
5250
5251	return rc;
5252	}
5253
5254	/**
5255	* Called by IInternalSessionControl::OnUSBDeviceAttach() or locally by
5256	* processRemoteUSBDevices() after IInternalMachineControl::RunUSBDeviceFilters()
5257	* returns TRUE for a given remote USB device.
5258	*
5259	* @return S_OK if the device was attached to the VM.
5260	* @return failure if not attached.
5261	*
5262	* @param aDevice
5263	* The device in question.
5264	* @param aMaskedIfs
5265	* The interfaces to hide from the guest.
5266	*
5267	* @note Locks this object for writing.
5268	*/
5269	HRESULT Console::i_onUSBDeviceAttach(IUSBDevice aDevice, IVirtualBoxErrorInfo aError, ULONG aMaskedIfs)
5270	{
5271	#ifdef VBOX_WITH_USB
5272	LogFlowThisFunc(("aDevice=%p aError=%p\n", aDevice, aError));
5273
5274	AutoCaller autoCaller(this);
5275	ComAssertComRCRetRC(autoCaller.rc());
5276
5277	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5278
5279	/* Get the VM pointer (we don't need error info, since it's a callback). */
5280	SafeVMPtrQuiet ptrVM(this);
5281	if (!ptrVM.isOk())
5282	{
5283	/* The VM may be no more operational when this message arrives
5284	* (e.g. it may be Saving or Stopping or just PoweredOff) --
5285	* autoVMCaller.rc() will return a failure in this case. */
5286	LogFlowThisFunc(("Attach request ignored (mMachineState=%d).\n",
5287	mMachineState));
5288	return ptrVM.rc();
5289	}
5290
5291	if (aError != NULL)
5292	{
5293	/* notify callbacks about the error */
5294	alock.release();
5295	i_onUSBDeviceStateChange(aDevice, true /* aAttached */, aError);
5296	return S_OK;
5297	}
5298
5299	/* Don't proceed unless there's at least one USB hub. */
5300	if (!PDMR3UsbHasHub(ptrVM.rawUVM()))
5301	{
5302	LogFlowThisFunc(("Attach request ignored (no USB controller).\n"));
5303	return E_FAIL;
5304	}
5305
5306	alock.release();
5307	HRESULT rc = i_attachUSBDevice(aDevice, aMaskedIfs);
5308	if (FAILED(rc))
5309	{
5310	/* take the current error info */
5311	com::ErrorInfoKeeper eik;
5312	/* the error must be a VirtualBoxErrorInfo instance */
5313	ComPtr<IVirtualBoxErrorInfo> pError = eik.takeError();
5314	Assert(!pError.isNull());
5315	if (!pError.isNull())
5316	{
5317	/* notify callbacks about the error */
5318	i_onUSBDeviceStateChange(aDevice, true /* aAttached */, pError);
5319	}
5320	}
5321
5322	return rc;
5323
5324	#else /* !VBOX_WITH_USB */
5325	return E_FAIL;
5326	#endif /* !VBOX_WITH_USB */
5327	}
5328
5329	/**
5330	* Called by IInternalSessionControl::OnUSBDeviceDetach() and locally by
5331	* processRemoteUSBDevices().
5332	*
5333	* @note Locks this object for writing.
5334	*/
5335	HRESULT Console::i_onUSBDeviceDetach(IN_BSTR aId,
5336	IVirtualBoxErrorInfo *aError)
5337	{
5338	#ifdef VBOX_WITH_USB
5339	Guid Uuid(aId);
5340	LogFlowThisFunc(("aId={%RTuuid} aError=%p\n", Uuid.raw(), aError));
5341
5342	AutoCaller autoCaller(this);
5343	AssertComRCReturnRC(autoCaller.rc());
5344
5345	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5346
5347	/* Find the device. */
5348	ComObjPtr<OUSBDevice> pUSBDevice;
5349	USBDeviceList::iterator it = mUSBDevices.begin();
5350	while (it != mUSBDevices.end())
5351	{
5352	LogFlowThisFunc(("it={%RTuuid}\n", (*it)->i_id().raw()));
5353	if ((*it)->i_id() == Uuid)
5354	{
5355	pUSBDevice = *it;
5356	break;
5357	}
5358	++it;
5359	}
5360
5361
5362	if (pUSBDevice.isNull())
5363	{
5364	LogFlowThisFunc(("USB device not found.\n"));
5365
5366	/* The VM may be no more operational when this message arrives
5367	* (e.g. it may be Saving or Stopping or just PoweredOff). Use
5368	* AutoVMCaller to detect it -- AutoVMCaller::rc() will return a
5369	* failure in this case. */
5370
5371	AutoVMCallerQuiet autoVMCaller(this);
5372	if (FAILED(autoVMCaller.rc()))
5373	{
5374	LogFlowThisFunc(("Detach request ignored (mMachineState=%d).\n",
5375	mMachineState));
5376	return autoVMCaller.rc();
5377	}
5378
5379	/* the device must be in the list otherwise */
5380	AssertFailedReturn(E_FAIL);
5381	}
5382
5383	if (aError != NULL)
5384	{
5385	/* notify callback about an error */
5386	alock.release();
5387	i_onUSBDeviceStateChange(pUSBDevice, false /* aAttached */, aError);
5388	return S_OK;
5389	}
5390
5391	/* Remove the device from the collection, it is re-added below for failures */
5392	mUSBDevices.erase(it);
5393
5394	alock.release();
5395	HRESULT rc = i_detachUSBDevice(pUSBDevice);
5396	if (FAILED(rc))
5397	{
5398	/* Re-add the device to the collection */
5399	alock.acquire();
5400	mUSBDevices.push_back(pUSBDevice);
5401	alock.release();
5402	/* take the current error info */
5403	com::ErrorInfoKeeper eik;
5404	/* the error must be a VirtualBoxErrorInfo instance */
5405	ComPtr<IVirtualBoxErrorInfo> pError = eik.takeError();
5406	Assert(!pError.isNull());
5407	if (!pError.isNull())
5408	{
5409	/* notify callbacks about the error */
5410	i_onUSBDeviceStateChange(pUSBDevice, false /* aAttached */, pError);
5411	}
5412	}
5413
5414	return rc;
5415
5416	#else /* !VBOX_WITH_USB */
5417	return E_FAIL;
5418	#endif /* !VBOX_WITH_USB */
5419	}
5420
5421	/**
5422	* Called by IInternalSessionControl::OnBandwidthGroupChange().
5423	*
5424	* @note Locks this object for writing.
5425	*/
5426	HRESULT Console::i_onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup)
5427	{
5428	LogFlowThisFunc(("\n"));
5429
5430	AutoCaller autoCaller(this);
5431	AssertComRCReturnRC(autoCaller.rc());
5432
5433	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5434
5435	HRESULT rc = S_OK;
5436
5437	/* don't trigger bandwidth group changes if the VM isn't running */
5438	SafeVMPtrQuiet ptrVM(this);
5439	if (ptrVM.isOk())
5440	{
5441	if ( mMachineState == MachineState_Running
5442	\|\| mMachineState == MachineState_Teleporting
5443	\|\| mMachineState == MachineState_LiveSnapshotting
5444	)
5445	{
5446	/* No need to call in the EMT thread. */
5447	LONG64 cMax;
5448	Bstr strName;
5449	BandwidthGroupType_T enmType;
5450	rc = aBandwidthGroup->COMGETTER(Name)(strName.asOutParam());
5451	if (SUCCEEDED(rc))
5452	rc = aBandwidthGroup->COMGETTER(MaxBytesPerSec)(&cMax);
5453	if (SUCCEEDED(rc))
5454	rc = aBandwidthGroup->COMGETTER(Type)(&enmType);
5455
5456	if (SUCCEEDED(rc))
5457	{
5458	int vrc = VINF_SUCCESS;
5459	if (enmType == BandwidthGroupType_Disk)
5460	vrc = PDMR3AsyncCompletionBwMgrSetMaxForFile(ptrVM.rawUVM(), Utf8Str(strName).c_str(), (uint32_t)cMax);
5461	#ifdef VBOX_WITH_NETSHAPER
5462	else if (enmType == BandwidthGroupType_Network)
5463	vrc = PDMR3NsBwGroupSetLimit(ptrVM.rawUVM(), Utf8Str(strName).c_str(), cMax);
5464	else
5465	rc = E_NOTIMPL;
5466	#endif /* VBOX_WITH_NETSHAPER */
5467	AssertRC(vrc);
5468	}
5469	}
5470	else
5471	rc = i_setInvalidMachineStateError();
5472	ptrVM.release();
5473	}
5474
5475	/* notify console callbacks on success */
5476	if (SUCCEEDED(rc))
5477	{
5478	alock.release();
5479	fireBandwidthGroupChangedEvent(mEventSource, aBandwidthGroup);
5480	}
5481
5482	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
5483	return rc;
5484	}
5485
5486	/**
5487	* Called by IInternalSessionControl::OnStorageDeviceChange().
5488	*
5489	* @note Locks this object for writing.
5490	*/
5491	HRESULT Console::i_onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove, BOOL aSilent)
5492	{
5493	LogFlowThisFunc(("\n"));
5494
5495	AutoCaller autoCaller(this);
5496	AssertComRCReturnRC(autoCaller.rc());
5497
5498	HRESULT rc = S_OK;
5499
5500	/* don't trigger medium changes if the VM isn't running */
5501	SafeVMPtrQuiet ptrVM(this);
5502	if (ptrVM.isOk())
5503	{
5504	if (aRemove)
5505	rc = i_doStorageDeviceDetach(aMediumAttachment, ptrVM.rawUVM(), RT_BOOL(aSilent));
5506	else
5507	rc = i_doStorageDeviceAttach(aMediumAttachment, ptrVM.rawUVM(), RT_BOOL(aSilent));
5508	ptrVM.release();
5509	}
5510
5511	/* notify console callbacks on success */
5512	if (SUCCEEDED(rc))
5513	fireStorageDeviceChangedEvent(mEventSource, aMediumAttachment, aRemove, aSilent);
5514
5515	LogFlowThisFunc(("Leaving rc=%#x\n", rc));
5516	return rc;
5517	}
5518
5519	HRESULT Console::i_onExtraDataChange(IN_BSTR aMachineId, IN_BSTR aKey, IN_BSTR aVal)
5520	{
5521	LogFlowThisFunc(("\n"));
5522
5523	AutoCaller autoCaller(this);
5524	if (FAILED(autoCaller.rc()))
5525	return autoCaller.rc();
5526
5527	if (!aMachineId)
5528	return S_OK;
5529
5530	HRESULT hrc = S_OK;
5531	Bstr idMachine(aMachineId);
5532	Bstr idSelf;
5533	hrc = mMachine->COMGETTER(Id)(idSelf.asOutParam());
5534	if ( FAILED(hrc)
5535	\|\| idMachine != idSelf)
5536	return hrc;
5537
5538	/* don't do anything if the VM isn't running */
5539	SafeVMPtrQuiet ptrVM(this);
5540	if (ptrVM.isOk())
5541	{
5542	Bstr strKey(aKey);
5543	Bstr strVal(aVal);
5544
5545	if (strKey == "VBoxInternal2/TurnResetIntoPowerOff")
5546	{
5547	int vrc = VMR3SetPowerOffInsteadOfReset(ptrVM.rawUVM(), strVal == "1");
5548	AssertRC(vrc);
5549	}
5550
5551	ptrVM.release();
5552	}
5553
5554	/* notify console callbacks on success */
5555	if (SUCCEEDED(hrc))
5556	fireExtraDataChangedEvent(mEventSource, aMachineId, aKey, aVal);
5557
5558	LogFlowThisFunc(("Leaving hrc=%#x\n", hrc));
5559	return hrc;
5560	}
5561
5562	/**
5563	* @note Temporarily locks this object for writing.
5564	*/
5565	HRESULT Console::i_getGuestProperty(IN_BSTR aName, BSTR aValue, LONG64 aTimestamp, BSTR *aFlags)
5566	{
5567	#ifndef VBOX_WITH_GUEST_PROPS
5568	ReturnComNotImplemented();
5569	#else /* VBOX_WITH_GUEST_PROPS */
5570	if (!VALID_PTR(aName))
5571	return E_INVALIDARG;
5572	if (!VALID_PTR(aValue))
5573	return E_POINTER;
5574	if ((aTimestamp != NULL) && !VALID_PTR(aTimestamp))
5575	return E_POINTER;
5576	if ((aFlags != NULL) && !VALID_PTR(aFlags))
5577	return E_POINTER;
5578
5579	AutoCaller autoCaller(this);
5580	AssertComRCReturnRC(autoCaller.rc());
5581
5582	/* protect mpUVM (if not NULL) */
5583	SafeVMPtrQuiet ptrVM(this);
5584	if (FAILED(ptrVM.rc()))
5585	return ptrVM.rc();
5586
5587	/* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
5588	* ptrVM, so there is no need to hold a lock of this */
5589
5590	HRESULT rc = E_UNEXPECTED;
5591	using namespace guestProp;
5592
5593	try
5594	{
5595	VBOXHGCMSVCPARM parm[4];
5596	Utf8Str Utf8Name = aName;
5597	char szBuffer[MAX_VALUE_LEN + MAX_FLAGS_LEN];
5598
5599	parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
5600	parm[0].u.pointer.addr = (void*)Utf8Name.c_str();
5601	/* The + 1 is the null terminator */
5602	parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
5603	parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
5604	parm[1].u.pointer.addr = szBuffer;
5605	parm[1].u.pointer.size = sizeof(szBuffer);
5606	int vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", GET_PROP_HOST,
5607	4, &parm[0]);
5608	/* The returned string should never be able to be greater than our buffer */
5609	AssertLogRel(vrc != VERR_BUFFER_OVERFLOW);
5610	AssertLogRel(RT_FAILURE(vrc) \|\| VBOX_HGCM_SVC_PARM_64BIT == parm[2].type);
5611	if (RT_SUCCESS(vrc) \|\| (VERR_NOT_FOUND == vrc))
5612	{
5613	rc = S_OK;
5614	if (vrc != VERR_NOT_FOUND)
5615	{
5616	Utf8Str strBuffer(szBuffer);
5617	strBuffer.cloneTo(aValue);
5618
5619	if (aTimestamp)
5620	*aTimestamp = parm[2].u.uint64;
5621
5622	if (aFlags)
5623	{
5624	size_t iFlags = strBuffer.length() + 1;
5625	Utf8Str(szBuffer + iFlags).cloneTo(aFlags);
5626	}
5627	}
5628	else
5629	aValue = NULL;
5630	}
5631	else
5632	rc = setError(E_UNEXPECTED,
5633	tr("The service call failed with the error %Rrc"),
5634	vrc);
5635	}
5636	catch(std::bad_alloc & /e/)
5637	{
5638	rc = E_OUTOFMEMORY;
5639	}
5640	return rc;
5641	#endif /* VBOX_WITH_GUEST_PROPS */
5642	}
5643
5644	/**
5645	* @note Temporarily locks this object for writing.
5646	*/
5647	HRESULT Console::i_setGuestProperty(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
5648	{
5649	#ifndef VBOX_WITH_GUEST_PROPS
5650	ReturnComNotImplemented();
5651	#else /* VBOX_WITH_GUEST_PROPS */
5652	if (!RT_VALID_PTR(aName))
5653	return setError(E_INVALIDARG, tr("Name cannot be NULL or an invalid pointer"));
5654	if (aValue != NULL && !RT_VALID_PTR(aValue))
5655	return setError(E_INVALIDARG, tr("Invalid value pointer"));
5656	if (aFlags != NULL && !RT_VALID_PTR(aFlags))
5657	return setError(E_INVALIDARG, tr("Invalid flags pointer"));
5658
5659	AutoCaller autoCaller(this);
5660	AssertComRCReturnRC(autoCaller.rc());
5661
5662	/* protect mpUVM (if not NULL) */
5663	SafeVMPtrQuiet ptrVM(this);
5664	if (FAILED(ptrVM.rc()))
5665	return ptrVM.rc();
5666
5667	/* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
5668	* ptrVM, so there is no need to hold a lock of this */
5669
5670	using namespace guestProp;
5671
5672	VBOXHGCMSVCPARM parm[3];
5673
5674	Utf8Str Utf8Name = aName;
5675	parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
5676	parm[0].u.pointer.addr = (void*)Utf8Name.c_str();
5677	/* The + 1 is the null terminator */
5678	parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
5679
5680	Utf8Str Utf8Value;
5681	if (aValue != NULL)
5682	{
5683	Utf8Value = aValue;
5684	parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
5685	parm[1].u.pointer.addr = (void *)Utf8Value.c_str();
5686	/* The + 1 is the null terminator */
5687	parm[1].u.pointer.size = (uint32_t)Utf8Value.length() + 1;
5688	}
5689
5690	Utf8Str Utf8Flags;
5691	if (aFlags != NULL)
5692	{
5693	Utf8Flags = aFlags;
5694	parm[2].type = VBOX_HGCM_SVC_PARM_PTR;
5695	parm[2].u.pointer.addr = (void*)Utf8Flags.c_str();
5696	/* The + 1 is the null terminator */
5697	parm[2].u.pointer.size = (uint32_t)Utf8Flags.length() + 1;
5698	}
5699
5700	int vrc;
5701	if (aValue != NULL && aFlags != NULL)
5702	vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", SET_PROP_HOST,
5703	3, &parm[0]);
5704	else if (aValue != NULL)
5705	vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", SET_PROP_VALUE_HOST,
5706	2, &parm[0]);
5707	else
5708	vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", DEL_PROP_HOST,
5709	1, &parm[0]);
5710	HRESULT hrc;
5711	if (RT_SUCCESS(vrc))
5712	hrc = S_OK;
5713	else
5714	hrc = setError(E_UNEXPECTED, tr("The service call failed with the error %Rrc"), vrc);
5715	return hrc;
5716	#endif /* VBOX_WITH_GUEST_PROPS */
5717	}
5718
5719
5720	/**
5721	* @note Temporarily locks this object for writing.
5722	*/
5723	HRESULT Console::i_enumerateGuestProperties(IN_BSTR aPatterns,
5724	ComSafeArrayOut(BSTR, aNames),
5725	ComSafeArrayOut(BSTR, aValues),
5726	ComSafeArrayOut(LONG64, aTimestamps),
5727	ComSafeArrayOut(BSTR, aFlags))
5728	{
5729	#ifndef VBOX_WITH_GUEST_PROPS
5730	ReturnComNotImplemented();
5731	#else /* VBOX_WITH_GUEST_PROPS */
5732	if (!VALID_PTR(aPatterns) && (aPatterns != NULL))
5733	return E_POINTER;
5734	if (ComSafeArrayOutIsNull(aNames))
5735	return E_POINTER;
5736	if (ComSafeArrayOutIsNull(aValues))
5737	return E_POINTER;
5738	if (ComSafeArrayOutIsNull(aTimestamps))
5739	return E_POINTER;
5740	if (ComSafeArrayOutIsNull(aFlags))
5741	return E_POINTER;
5742
5743	AutoCaller autoCaller(this);
5744	AssertComRCReturnRC(autoCaller.rc());
5745
5746	/* protect mpUVM (if not NULL) */
5747	AutoVMCallerWeak autoVMCaller(this);
5748	if (FAILED(autoVMCaller.rc()))
5749	return autoVMCaller.rc();
5750
5751	/* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
5752	* autoVMCaller, so there is no need to hold a lock of this */
5753
5754	return i_doEnumerateGuestProperties(aPatterns, ComSafeArrayOutArg(aNames),
5755	ComSafeArrayOutArg(aValues),
5756	ComSafeArrayOutArg(aTimestamps),
5757	ComSafeArrayOutArg(aFlags));
5758	#endif /* VBOX_WITH_GUEST_PROPS */
5759	}
5760
5761
5762	/*
5763	* Internal: helper function for connecting progress reporting
5764	*/
5765	static int onlineMergeMediumProgress(void *pvUser, unsigned uPercentage)
5766	{
5767	HRESULT rc = S_OK;
5768	IProgress pProgress = static_cast<IProgress >(pvUser);
5769	if (pProgress)
5770	rc = pProgress->SetCurrentOperationProgress(uPercentage);
5771	return SUCCEEDED(rc) ? VINF_SUCCESS : VERR_GENERAL_FAILURE;
5772	}
5773
5774	/**
5775	* @note Temporarily locks this object for writing. bird: And/or reading?
5776	*/
5777	HRESULT Console::i_onlineMergeMedium(IMediumAttachment *aMediumAttachment,
5778	ULONG aSourceIdx, ULONG aTargetIdx,
5779	IProgress *aProgress)
5780	{
5781	AutoCaller autoCaller(this);
5782	AssertComRCReturnRC(autoCaller.rc());
5783
5784	HRESULT rc = S_OK;
5785	int vrc = VINF_SUCCESS;
5786
5787	/* Get the VM - must be done before the read-locking. */
5788	SafeVMPtr ptrVM(this);
5789	if (!ptrVM.isOk())
5790	return ptrVM.rc();
5791
5792	/* We will need to release the lock before doing the actual merge */
5793	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5794
5795	/* paranoia - we don't want merges to happen while teleporting etc. */
5796	switch (mMachineState)
5797	{
5798	case MachineState_DeletingSnapshotOnline:
5799	case MachineState_DeletingSnapshotPaused:
5800	break;
5801
5802	default:
5803	return i_setInvalidMachineStateError();
5804	}
5805
5806	/** @todo AssertComRC -> AssertComRCReturn! Could potentially end up
5807	* using uninitialized variables here. */
5808	BOOL fBuiltinIOCache;
5809	rc = mMachine->COMGETTER(IOCacheEnabled)(&fBuiltinIOCache);
5810	AssertComRC(rc);
5811	SafeIfaceArray<IStorageController> ctrls;
5812	rc = mMachine->COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(ctrls));
5813	AssertComRC(rc);
5814	LONG lDev;
5815	rc = aMediumAttachment->COMGETTER(Device)(&lDev);
5816	AssertComRC(rc);
5817	LONG lPort;
5818	rc = aMediumAttachment->COMGETTER(Port)(&lPort);
5819	AssertComRC(rc);
5820	IMedium *pMedium;
5821	rc = aMediumAttachment->COMGETTER(Medium)(&pMedium);
5822	AssertComRC(rc);
5823	Bstr mediumLocation;
5824	if (pMedium)
5825	{
5826	rc = pMedium->COMGETTER(Location)(mediumLocation.asOutParam());
5827	AssertComRC(rc);
5828	}
5829
5830	Bstr attCtrlName;
5831	rc = aMediumAttachment->COMGETTER(Controller)(attCtrlName.asOutParam());
5832	AssertComRC(rc);
5833	ComPtr<IStorageController> pStorageController;
5834	for (size_t i = 0; i < ctrls.size(); ++i)
5835	{
5836	Bstr ctrlName;
5837	rc = ctrls[i]->COMGETTER(Name)(ctrlName.asOutParam());
5838	AssertComRC(rc);
5839	if (attCtrlName == ctrlName)
5840	{
5841	pStorageController = ctrls[i];
5842	break;
5843	}
5844	}
5845	if (pStorageController.isNull())
5846	return setError(E_FAIL,
5847	tr("Could not find storage controller '%ls'"),
5848	attCtrlName.raw());
5849
5850	StorageControllerType_T enmCtrlType;
5851	rc = pStorageController->COMGETTER(ControllerType)(&enmCtrlType);
5852	AssertComRC(rc);
5853	const char *pcszDevice = i_convertControllerTypeToDev(enmCtrlType);
5854
5855	StorageBus_T enmBus;
5856	rc = pStorageController->COMGETTER(Bus)(&enmBus);
5857	AssertComRC(rc);
5858	ULONG uInstance;
5859	rc = pStorageController->COMGETTER(Instance)(&uInstance);
5860	AssertComRC(rc);
5861	BOOL fUseHostIOCache;
5862	rc = pStorageController->COMGETTER(UseHostIOCache)(&fUseHostIOCache);
5863	AssertComRC(rc);
5864
5865	unsigned uLUN;
5866	rc = Console::i_convertBusPortDeviceToLun(enmBus, lPort, lDev, uLUN);
5867	AssertComRCReturnRC(rc);
5868
5869	alock.release();
5870
5871	/* Pause the VM, as it might have pending IO on this drive */
5872	VMSTATE enmVMState = VMR3GetStateU(ptrVM.rawUVM());
5873	if (mMachineState == MachineState_DeletingSnapshotOnline)
5874	{
5875	LogFlowFunc(("Suspending the VM...\n"));
5876	/* disable the callback to prevent Console-level state change */
5877	mVMStateChangeCallbackDisabled = true;
5878	int vrc2 = VMR3Suspend(ptrVM.rawUVM(), VMSUSPENDREASON_RECONFIG);
5879	mVMStateChangeCallbackDisabled = false;
5880	AssertRCReturn(vrc2, E_FAIL);
5881	}
5882
5883	vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY,
5884	(PFNRT)i_reconfigureMediumAttachment, 13,
5885	this, ptrVM.rawUVM(), pcszDevice, uInstance, enmBus, fUseHostIOCache,
5886	fBuiltinIOCache, true /* fSetupMerge */, aSourceIdx, aTargetIdx,
5887	aMediumAttachment, mMachineState, &rc);
5888	/* error handling is after resuming the VM */
5889
5890	if (mMachineState == MachineState_DeletingSnapshotOnline)
5891	{
5892	LogFlowFunc(("Resuming the VM...\n"));
5893	/* disable the callback to prevent Console-level state change */
5894	mVMStateChangeCallbackDisabled = true;
5895	int vrc2 = VMR3Resume(ptrVM.rawUVM(), VMRESUMEREASON_RECONFIG);
5896	mVMStateChangeCallbackDisabled = false;
5897	if (RT_FAILURE(vrc2))
5898	{
5899	/* too bad, we failed. try to sync the console state with the VMM state */
5900	AssertLogRelRC(vrc2);
5901	i_vmstateChangeCallback(ptrVM.rawUVM(), VMSTATE_SUSPENDED, enmVMState, this);
5902	}
5903	}
5904
5905	if (RT_FAILURE(vrc))
5906	return setError(E_FAIL, tr("%Rrc"), vrc);
5907	if (FAILED(rc))
5908	return rc;
5909
5910	PPDMIBASE pIBase = NULL;
5911	PPDMIMEDIA pIMedium = NULL;
5912	vrc = PDMR3QueryDriverOnLun(ptrVM.rawUVM(), pcszDevice, uInstance, uLUN, "VD", &pIBase);
5913	if (RT_SUCCESS(vrc))
5914	{
5915	if (pIBase)
5916	{
5917	pIMedium = (PPDMIMEDIA)pIBase->pfnQueryInterface(pIBase, PDMIMEDIA_IID);
5918	if (!pIMedium)
5919	return setError(E_FAIL, tr("could not query medium interface of controller"));
5920	}
5921	else
5922	return setError(E_FAIL, tr("could not query base interface of controller"));
5923	}
5924
5925	/* Finally trigger the merge. */
5926	vrc = pIMedium->pfnMerge(pIMedium, onlineMergeMediumProgress, aProgress);
5927	if (RT_FAILURE(vrc))
5928	return setError(E_FAIL, tr("Failed to perform an online medium merge (%Rrc)"), vrc);
5929
5930	/* Pause the VM, as it might have pending IO on this drive */
5931	enmVMState = VMR3GetStateU(ptrVM.rawUVM());
5932	if (mMachineState == MachineState_DeletingSnapshotOnline)
5933	{
5934	LogFlowFunc(("Suspending the VM...\n"));
5935	/* disable the callback to prevent Console-level state change */
5936	mVMStateChangeCallbackDisabled = true;
5937	int vrc2 = VMR3Suspend(ptrVM.rawUVM(), VMSUSPENDREASON_RECONFIG);
5938	mVMStateChangeCallbackDisabled = false;
5939	AssertRCReturn(vrc2, E_FAIL);
5940	}
5941
5942	/* Update medium chain and state now, so that the VM can continue. */
5943	rc = mControl->FinishOnlineMergeMedium();
5944
5945	vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY,
5946	(PFNRT)i_reconfigureMediumAttachment, 13,
5947	this, ptrVM.rawUVM(), pcszDevice, uInstance, enmBus, fUseHostIOCache,
5948	fBuiltinIOCache, false /* fSetupMerge /, 0 / uMergeSource */,
5949	0 /* uMergeTarget */, aMediumAttachment, mMachineState, &rc);
5950	/* error handling is after resuming the VM */
5951
5952	if (mMachineState == MachineState_DeletingSnapshotOnline)
5953	{
5954	LogFlowFunc(("Resuming the VM...\n"));
5955	/* disable the callback to prevent Console-level state change */
5956	mVMStateChangeCallbackDisabled = true;
5957	int vrc2 = VMR3Resume(ptrVM.rawUVM(), VMRESUMEREASON_RECONFIG);
5958	mVMStateChangeCallbackDisabled = false;
5959	AssertRC(vrc2);
5960	if (RT_FAILURE(vrc2))
5961	{
5962	/* too bad, we failed. try to sync the console state with the VMM state */
5963	i_vmstateChangeCallback(ptrVM.rawUVM(), VMSTATE_SUSPENDED, enmVMState, this);
5964	}
5965	}
5966
5967	if (RT_FAILURE(vrc))
5968	return setError(E_FAIL, tr("%Rrc"), vrc);
5969	if (FAILED(rc))
5970	return rc;
5971
5972	return rc;
5973	}
5974
5975
5976	/**
5977	* Load an HGCM service.
5978	*
5979	* Main purpose of this method is to allow extension packs to load HGCM
5980	* service modules, which they can't, because the HGCM functionality lives
5981	* in module VBoxC (and ConsoleImpl.cpp is part of it and thus can call it).
5982	* Extension modules must not link directly against VBoxC, (XP)COM is
5983	* handling this.
5984	*/
5985	int Console::i_hgcmLoadService(const char pszServiceLibrary, const char pszServiceName)
5986	{
5987	/* Everyone seems to delegate all HGCM calls to VMMDev, so stick to this
5988	* convention. Adds one level of indirection for no obvious reason. */
5989	AssertPtrReturn(m_pVMMDev, VERR_INVALID_STATE);
5990	return m_pVMMDev->hgcmLoadService(pszServiceLibrary, pszServiceName);
5991	}
5992
5993	/**
5994	* Merely passes the call to Guest::enableVMMStatistics().
5995	*/
5996	void Console::i_enableVMMStatistics(BOOL aEnable)
5997	{
5998	if (mGuest)
5999	mGuest->enableVMMStatistics(aEnable);
6000	}
6001
6002	/**
6003	* Worker for Console::Pause and internal entry point for pausing a VM for
6004	* a specific reason.
6005	*/
6006	HRESULT Console::i_pause(Reason_T aReason)
6007	{
6008	LogFlowThisFuncEnter();
6009
6010	AutoCaller autoCaller(this);
6011	if (FAILED(autoCaller.rc())) return autoCaller.rc();
6012
6013	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6014
6015	switch (mMachineState)
6016	{
6017	case MachineState_Running:
6018	case MachineState_Teleporting:
6019	case MachineState_LiveSnapshotting:
6020	break;
6021
6022	case MachineState_Paused:
6023	case MachineState_TeleportingPausedVM:
6024	case MachineState_Saving:
6025	return setError(VBOX_E_INVALID_VM_STATE, tr("Already paused"));
6026
6027	default:
6028	return i_setInvalidMachineStateError();
6029	}
6030
6031	/* get the VM handle. */
6032	SafeVMPtr ptrVM(this);
6033	if (!ptrVM.isOk())
6034	return ptrVM.rc();
6035
6036	/* release the lock before a VMR3* call (EMT will call us back)! */
6037	alock.release();
6038
6039	LogFlowThisFunc(("Sending PAUSE request...\n"));
6040	if (aReason != Reason_Unspecified)
6041	LogRel(("Pausing VM execution, reason \"%s\"\n", Global::stringifyReason(aReason)));
6042
6043	/** @todo r=klaus make use of aReason */
6044	VMSUSPENDREASON enmReason = VMSUSPENDREASON_USER;
6045	if (aReason == Reason_HostSuspend)
6046	enmReason = VMSUSPENDREASON_HOST_SUSPEND;
6047	else if (aReason == Reason_HostBatteryLow)
6048	enmReason = VMSUSPENDREASON_HOST_BATTERY_LOW;
6049	int vrc = VMR3Suspend(ptrVM.rawUVM(), enmReason);
6050
6051	HRESULT hrc = S_OK;
6052	if (RT_FAILURE(vrc))
6053	hrc = setError(VBOX_E_VM_ERROR, tr("Could not suspend the machine execution (%Rrc)"), vrc);
6054	else
6055	{
6056	/* Unconfigure disk encryption from all attachments. */
6057	i_clearDiskEncryptionKeysOnAllAttachments();
6058
6059	/* Clear any keys we have stored. */
6060	for (SecretKeyMap::iterator it = m_mapSecretKeys.begin();
6061	it != m_mapSecretKeys.end();
6062	it++)
6063	delete it->second;
6064	m_mapSecretKeys.clear();
6065	}
6066
6067	LogFlowThisFunc(("hrc=%Rhrc\n", hrc));
6068	LogFlowThisFuncLeave();
6069	return hrc;
6070	}
6071
6072	/**
6073	* Worker for Console::Resume and internal entry point for resuming a VM for
6074	* a specific reason.
6075	*/
6076	HRESULT Console::i_resume(Reason_T aReason)
6077	{
6078	LogFlowThisFuncEnter();
6079
6080	AutoCaller autoCaller(this);
6081	if (FAILED(autoCaller.rc())) return autoCaller.rc();
6082
6083	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6084
6085	if (mMachineState != MachineState_Paused)
6086	return setError(VBOX_E_INVALID_VM_STATE,
6087	tr("Cannot resume the machine as it is not paused (machine state: %s)"),
6088	Global::stringifyMachineState(mMachineState));
6089
6090	/* get the VM handle. */
6091	SafeVMPtr ptrVM(this);
6092	if (!ptrVM.isOk())
6093	return ptrVM.rc();
6094
6095	/* release the lock before a VMR3* call (EMT will call us back)! */
6096	alock.release();
6097
6098	LogFlowThisFunc(("Sending RESUME request...\n"));
6099	if (aReason != Reason_Unspecified)
6100	LogRel(("Resuming VM execution, reason \"%s\"\n", Global::stringifyReason(aReason)));
6101
6102	int vrc;
6103	if (VMR3GetStateU(ptrVM.rawUVM()) == VMSTATE_CREATED)
6104	{
6105	#ifdef VBOX_WITH_EXTPACK
6106	vrc = mptrExtPackManager->i_callAllVmPowerOnHooks(this, VMR3GetVM(ptrVM.rawUVM()));
6107	#else
6108	vrc = VINF_SUCCESS;
6109	#endif
6110	if (RT_SUCCESS(vrc))
6111	vrc = VMR3PowerOn(ptrVM.rawUVM()); /* (PowerUpPaused) */
6112	}
6113	else
6114	{
6115	VMRESUMEREASON enmReason = VMRESUMEREASON_USER;
6116	if (aReason == Reason_HostResume)
6117	enmReason = VMRESUMEREASON_HOST_RESUME;
6118	vrc = VMR3Resume(ptrVM.rawUVM(), enmReason);
6119	}
6120
6121	HRESULT rc = RT_SUCCESS(vrc) ? S_OK :
6122	setError(VBOX_E_VM_ERROR,
6123	tr("Could not resume the machine execution (%Rrc)"),
6124	vrc);
6125
6126	LogFlowThisFunc(("rc=%Rhrc\n", rc));
6127	LogFlowThisFuncLeave();
6128	return rc;
6129	}
6130
6131	/**
6132	* Worker for Console::SaveState and internal entry point for saving state of
6133	* a VM for a specific reason.
6134	*/
6135	HRESULT Console::i_saveState(Reason_T aReason, IProgress **aProgress)
6136	{
6137	LogFlowThisFuncEnter();
6138
6139	CheckComArgOutPointerValid(aProgress);
6140
6141	AutoCaller autoCaller(this);
6142	if (FAILED(autoCaller.rc())) return autoCaller.rc();
6143
6144	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6145
6146	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
6147	if ( mMachineState != MachineState_Running
6148	&& mMachineState != MachineState_Paused)
6149	{
6150	return setError(VBOX_E_INVALID_VM_STATE,
6151	tr("Cannot save the execution state as the machine is not running or paused (machine state: %s)"),
6152	Global::stringifyMachineState(mMachineState));
6153	}
6154
6155	if (aReason != Reason_Unspecified)
6156	LogRel(("Saving state of VM, reason \"%s\"\n", Global::stringifyReason(aReason)));
6157
6158	/* memorize the current machine state */
6159	MachineState_T lastMachineState = mMachineState;
6160
6161	if (mMachineState == MachineState_Running)
6162	{
6163	/* get the VM handle. */
6164	SafeVMPtr ptrVM(this);
6165	if (!ptrVM.isOk())
6166	return ptrVM.rc();
6167
6168	/* release the lock before a VMR3* call (EMT will call us back)! */
6169	alock.release();
6170	VMSUSPENDREASON enmReason = VMSUSPENDREASON_USER;
6171	if (aReason == Reason_HostSuspend)
6172	enmReason = VMSUSPENDREASON_HOST_SUSPEND;
6173	else if (aReason == Reason_HostBatteryLow)
6174	enmReason = VMSUSPENDREASON_HOST_BATTERY_LOW;
6175	int vrc = VMR3Suspend(ptrVM.rawUVM(), enmReason);
6176	alock.acquire();
6177
6178	HRESULT hrc = S_OK;
6179	if (RT_FAILURE(vrc))
6180	hrc = setError(VBOX_E_VM_ERROR, tr("Could not suspend the machine execution (%Rrc)"), vrc);
6181	if (FAILED(hrc))
6182	return hrc;
6183	}
6184
6185	HRESULT rc = S_OK;
6186	bool fBeganSavingState = false;
6187	bool fTaskCreationFailed = false;
6188
6189	do
6190	{
6191	ComPtr<IProgress> pProgress;
6192	Bstr stateFilePath;
6193
6194	/*
6195	* request a saved state file path from the server
6196	* (this will set the machine state to Saving on the server to block
6197	* others from accessing this machine)
6198	*/
6199	rc = mControl->BeginSavingState(pProgress.asOutParam(),
6200	stateFilePath.asOutParam());
6201	if (FAILED(rc))
6202	break;
6203
6204	fBeganSavingState = true;
6205
6206	/* sync the state with the server */
6207	i_setMachineStateLocally(MachineState_Saving);
6208
6209	/* ensure the directory for the saved state file exists */
6210	{
6211	Utf8Str dir = stateFilePath;
6212	dir.stripFilename();
6213	if (!RTDirExists(dir.c_str()))
6214	{
6215	int vrc = RTDirCreateFullPath(dir.c_str(), 0700);
6216	if (RT_FAILURE(vrc))
6217	{
6218	rc = setError(VBOX_E_FILE_ERROR,
6219	tr("Could not create a directory '%s' to save the state to (%Rrc)"),
6220	dir.c_str(), vrc);
6221	break;
6222	}
6223	}
6224	}
6225
6226	/* Create a task object early to ensure mpUVM protection is successful. */
6227	std::auto_ptr<VMSaveTask> task(new VMSaveTask(this, pProgress,
6228	stateFilePath,
6229	lastMachineState,
6230	aReason));
6231	rc = task->rc();
6232	/*
6233	* If we fail here it means a PowerDown() call happened on another
6234	* thread while we were doing Pause() (which releases the Console lock).
6235	* We assign PowerDown() a higher precedence than SaveState(),
6236	* therefore just return the error to the caller.
6237	*/
6238	if (FAILED(rc))
6239	{
6240	fTaskCreationFailed = true;
6241	break;
6242	}
6243
6244	/* create a thread to wait until the VM state is saved */
6245	int vrc = RTThreadCreate(NULL, Console::i_saveStateThread, (void *)task.get(),
6246	0, RTTHREADTYPE_MAIN_WORKER, 0, "VMSave");
6247	if (RT_FAILURE(vrc))
6248	{
6249	rc = setError(E_FAIL, "Could not create VMSave thread (%Rrc)", vrc);
6250	break;
6251	}
6252
6253	/* task is now owned by saveStateThread(), so release it */
6254	task.release();
6255
6256	/* return the progress to the caller */
6257	pProgress.queryInterfaceTo(aProgress);
6258	} while (0);
6259
6260	if (FAILED(rc) && !fTaskCreationFailed)
6261	{
6262	/* preserve existing error info */
6263	ErrorInfoKeeper eik;
6264
6265	if (fBeganSavingState)
6266	{
6267	/*
6268	* cancel the requested save state procedure.
6269	* This will reset the machine state to the state it had right
6270	* before calling mControl->BeginSavingState().
6271	*/
6272	mControl->EndSavingState(eik.getResultCode(), eik.getText().raw());
6273	}
6274
6275	if (lastMachineState == MachineState_Running)
6276	{
6277	/* restore the paused state if appropriate */
6278	i_setMachineStateLocally(MachineState_Paused);
6279	/* restore the running state if appropriate */
6280	SafeVMPtr ptrVM(this);
6281	if (ptrVM.isOk())
6282	{
6283	alock.release();
6284	VMR3Resume(ptrVM.rawUVM(), VMRESUMEREASON_STATE_RESTORED);
6285	alock.acquire();
6286	}
6287	}
6288	else
6289	i_setMachineStateLocally(lastMachineState);
6290	}
6291
6292	LogFlowThisFunc(("rc=%Rhrc\n", rc));
6293	LogFlowThisFuncLeave();
6294	return rc;
6295	}
6296
6297	/**
6298	* Gets called by Session::UpdateMachineState()
6299	* (IInternalSessionControl::updateMachineState()).
6300	*
6301	* Must be called only in certain cases (see the implementation).
6302	*
6303	* @note Locks this object for writing.
6304	*/
6305	HRESULT Console::i_updateMachineState(MachineState_T aMachineState)
6306	{
6307	AutoCaller autoCaller(this);
6308	AssertComRCReturnRC(autoCaller.rc());
6309
6310	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6311
6312	AssertReturn( mMachineState == MachineState_Saving
6313	\|\| mMachineState == MachineState_LiveSnapshotting
6314	\|\| mMachineState == MachineState_RestoringSnapshot
6315	\|\| mMachineState == MachineState_DeletingSnapshot
6316	\|\| mMachineState == MachineState_DeletingSnapshotOnline
6317	\|\| mMachineState == MachineState_DeletingSnapshotPaused
6318	, E_FAIL);
6319
6320	return i_setMachineStateLocally(aMachineState);
6321	}
6322
6323	#ifdef CONSOLE_WITH_EVENT_CACHE
6324	/**
6325	* @note Locks this object for writing.
6326	*/
6327	#endif
6328	void Console::i_onMousePointerShapeChange(bool fVisible, bool fAlpha,
6329	uint32_t xHot, uint32_t yHot,
6330	uint32_t width, uint32_t height,
6331	ComSafeArrayIn(BYTE,pShape))
6332	{
6333	#if 0
6334	LogFlowThisFuncEnter();
6335	LogFlowThisFunc(("fVisible=%d, fAlpha=%d, xHot = %d, yHot = %d, width=%d, height=%d, shape=%p\n",
6336	fVisible, fAlpha, xHot, yHot, width, height, pShape));
6337	#endif
6338
6339	AutoCaller autoCaller(this);
6340	AssertComRCReturnVoid(autoCaller.rc());
6341
6342	#ifdef CONSOLE_WITH_EVENT_CACHE
6343	{
6344	/* We need a write lock because we alter the cached callback data */
6345	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6346
6347	/* Save the callback arguments */
6348	mCallbackData.mpsc.visible = fVisible;
6349	mCallbackData.mpsc.alpha = fAlpha;
6350	mCallbackData.mpsc.xHot = xHot;
6351	mCallbackData.mpsc.yHot = yHot;
6352	mCallbackData.mpsc.width = width;
6353	mCallbackData.mpsc.height = height;
6354
6355	/* start with not valid */
6356	bool wasValid = mCallbackData.mpsc.valid;
6357	mCallbackData.mpsc.valid = false;
6358
6359	com::SafeArray<BYTE> aShape(ComSafeArrayInArg(pShape));
6360	if (aShape.size() != 0)
6361	mCallbackData.mpsc.shape.initFrom(aShape);
6362	else
6363	mCallbackData.mpsc.shape.resize(0);
6364	mCallbackData.mpsc.valid = true;
6365	}
6366	#endif
6367
6368	fireMousePointerShapeChangedEvent(mEventSource, fVisible, fAlpha, xHot, yHot, width, height, ComSafeArrayInArg(pShape));
6369
6370	#if 0
6371	LogFlowThisFuncLeave();
6372	#endif
6373	}
6374
6375	#ifdef CONSOLE_WITH_EVENT_CACHE
6376	/**
6377	* @note Locks this object for writing.
6378	*/
6379	#endif
6380	void Console::i_onMouseCapabilityChange(BOOL supportsAbsolute, BOOL supportsRelative,
6381	BOOL supportsMT, BOOL needsHostCursor)
6382	{
6383	LogFlowThisFunc(("supportsAbsolute=%d supportsRelative=%d needsHostCursor=%d\n",
6384	supportsAbsolute, supportsRelative, needsHostCursor));
6385
6386	AutoCaller autoCaller(this);
6387	AssertComRCReturnVoid(autoCaller.rc());
6388
6389	#ifdef CONSOLE_WITH_EVENT_CACHE
6390	{
6391	/* We need a write lock because we alter the cached callback data */
6392	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6393
6394	/* save the callback arguments */
6395	mCallbackData.mcc.supportsAbsolute = supportsAbsolute;
6396	mCallbackData.mcc.supportsRelative = supportsRelative;
6397	mCallbackData.mcc.needsHostCursor = needsHostCursor;
6398	mCallbackData.mcc.valid = true;
6399	}
6400	#endif
6401
6402	fireMouseCapabilityChangedEvent(mEventSource, supportsAbsolute, supportsRelative, supportsMT, needsHostCursor);
6403	}
6404
6405	void Console::i_onStateChange(MachineState_T machineState)
6406	{
6407	AutoCaller autoCaller(this);
6408	AssertComRCReturnVoid(autoCaller.rc());
6409	fireStateChangedEvent(mEventSource, machineState);
6410	}
6411
6412	void Console::i_onAdditionsStateChange()
6413	{
6414	AutoCaller autoCaller(this);
6415	AssertComRCReturnVoid(autoCaller.rc());
6416
6417	fireAdditionsStateChangedEvent(mEventSource);
6418	}
6419
6420	/**
6421	* @remarks This notification only is for reporting an incompatible
6422	* Guest Additions interface, not the Guest Additions version!
6423	*
6424	* The user will be notified inside the guest if new Guest
6425	* Additions are available (via VBoxTray/VBoxClient).
6426	*/
6427	void Console::i_onAdditionsOutdated()
6428	{
6429	AutoCaller autoCaller(this);
6430	AssertComRCReturnVoid(autoCaller.rc());
6431
6432	/** @todo implement this */
6433	}
6434
6435	#ifdef CONSOLE_WITH_EVENT_CACHE
6436	/**
6437	* @note Locks this object for writing.
6438	*/
6439	#endif
6440	void Console::i_onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock)
6441	{
6442	AutoCaller autoCaller(this);
6443	AssertComRCReturnVoid(autoCaller.rc());
6444
6445	#ifdef CONSOLE_WITH_EVENT_CACHE
6446	{
6447	/* We need a write lock because we alter the cached callback data */
6448	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6449
6450	/* save the callback arguments */
6451	mCallbackData.klc.numLock = fNumLock;
6452	mCallbackData.klc.capsLock = fCapsLock;
6453	mCallbackData.klc.scrollLock = fScrollLock;
6454	mCallbackData.klc.valid = true;
6455	}
6456	#endif
6457
6458	fireKeyboardLedsChangedEvent(mEventSource, fNumLock, fCapsLock, fScrollLock);
6459	}
6460
6461	void Console::i_onUSBDeviceStateChange(IUSBDevice *aDevice, bool aAttached,
6462	IVirtualBoxErrorInfo *aError)
6463	{
6464	AutoCaller autoCaller(this);
6465	AssertComRCReturnVoid(autoCaller.rc());
6466
6467	fireUSBDeviceStateChangedEvent(mEventSource, aDevice, aAttached, aError);
6468	}
6469
6470	void Console::i_onRuntimeError(BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage)
6471	{
6472	AutoCaller autoCaller(this);
6473	AssertComRCReturnVoid(autoCaller.rc());
6474
6475	fireRuntimeErrorEvent(mEventSource, aFatal, aErrorID, aMessage);
6476	}
6477
6478	HRESULT Console::i_onShowWindow(BOOL aCheck, BOOL aCanShow, LONG64 aWinId)
6479	{
6480	AssertReturn(aCanShow, E_POINTER);
6481	AssertReturn(aWinId, E_POINTER);
6482
6483	*aCanShow = FALSE;
6484	*aWinId = 0;
6485
6486	AutoCaller autoCaller(this);
6487	AssertComRCReturnRC(autoCaller.rc());
6488
6489	VBoxEventDesc evDesc;
6490	if (aCheck)
6491	{
6492	evDesc.init(mEventSource, VBoxEventType_OnCanShowWindow);
6493	BOOL fDelivered = evDesc.fire(5000); /* Wait up to 5 secs for delivery */
6494	//Assert(fDelivered);
6495	if (fDelivered)
6496	{
6497	ComPtr<IEvent> pEvent;
6498	evDesc.getEvent(pEvent.asOutParam());
6499	// bit clumsy
6500	ComPtr<ICanShowWindowEvent> pCanShowEvent = pEvent;
6501	if (pCanShowEvent)
6502	{
6503	BOOL fVetoed = FALSE;
6504	pCanShowEvent->IsVetoed(&fVetoed);
6505	*aCanShow = !fVetoed;
6506	}
6507	else
6508	{
6509	AssertFailed();
6510	*aCanShow = TRUE;
6511	}
6512	}
6513	else
6514	*aCanShow = TRUE;
6515	}
6516	else
6517	{
6518	evDesc.init(mEventSource, VBoxEventType_OnShowWindow, INT64_C(0));
6519	BOOL fDelivered = evDesc.fire(5000); /* Wait up to 5 secs for delivery */
6520	//Assert(fDelivered);
6521	if (fDelivered)
6522	{
6523	ComPtr<IEvent> pEvent;
6524	evDesc.getEvent(pEvent.asOutParam());
6525	ComPtr<IShowWindowEvent> pShowEvent = pEvent;
6526	if (pShowEvent)
6527	{
6528	LONG64 iEvWinId = 0;
6529	pShowEvent->COMGETTER(WinId)(&iEvWinId);
6530	if (iEvWinId != 0 && *aWinId == 0)
6531	*aWinId = iEvWinId;
6532	}
6533	else
6534	AssertFailed();
6535	}
6536	}
6537
6538	return S_OK;
6539	}
6540
6541	// private methods
6542	////////////////////////////////////////////////////////////////////////////////
6543
6544	/**
6545	* Increases the usage counter of the mpUVM pointer.
6546	*
6547	* Guarantees that VMR3Destroy() will not be called on it at least until
6548	* releaseVMCaller() is called.
6549	*
6550	* If this method returns a failure, the caller is not allowed to use mpUVM and
6551	* may return the failed result code to the upper level. This method sets the
6552	* extended error info on failure if \a aQuiet is false.
6553	*
6554	* Setting \a aQuiet to true is useful for methods that don't want to return
6555	* the failed result code to the caller when this method fails (e.g. need to
6556	* silently check for the mpUVM availability).
6557	*
6558	* When mpUVM is NULL but \a aAllowNullVM is true, a corresponding error will be
6559	* returned instead of asserting. Having it false is intended as a sanity check
6560	* for methods that have checked mMachineState and expect mpUVM NOT to be
6561	* NULL.
6562	*
6563	* @param aQuiet true to suppress setting error info
6564	* @param aAllowNullVM true to accept mpUVM being NULL and return a failure
6565	* (otherwise this method will assert if mpUVM is NULL)
6566	*
6567	* @note Locks this object for writing.
6568	*/
6569	HRESULT Console::i_addVMCaller(bool aQuiet /* = false */,
6570	bool aAllowNullVM /* = false */)
6571	{
6572	AutoCaller autoCaller(this);
6573	/** @todo Fix race during console/VM reference destruction, refer @bugref{6318}
6574	* comment 25. */
6575	if (FAILED(autoCaller.rc()))
6576	return autoCaller.rc();
6577
6578	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6579
6580	if (mVMDestroying)
6581	{
6582	/* powerDown() is waiting for all callers to finish */
6583	return aQuiet ? E_ACCESSDENIED : setError(E_ACCESSDENIED,
6584	tr("The virtual machine is being powered down"));
6585	}
6586
6587	if (mpUVM == NULL)
6588	{
6589	Assert(aAllowNullVM == true);
6590
6591	/* The machine is not powered up */
6592	return aQuiet ? E_ACCESSDENIED : setError(E_ACCESSDENIED,
6593	tr("The virtual machine is not powered up"));
6594	}
6595
6596	++mVMCallers;
6597
6598	return S_OK;
6599	}
6600
6601	/**
6602	* Decreases the usage counter of the mpUVM pointer.
6603	*
6604	* Must always complete the addVMCaller() call after the mpUVM pointer is no
6605	* more necessary.
6606	*
6607	* @note Locks this object for writing.
6608	*/
6609	void Console::i_releaseVMCaller()
6610	{
6611	AutoCaller autoCaller(this);
6612	AssertComRCReturnVoid(autoCaller.rc());
6613
6614	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6615
6616	AssertReturnVoid(mpUVM != NULL);
6617
6618	Assert(mVMCallers > 0);
6619	--mVMCallers;
6620
6621	if (mVMCallers == 0 && mVMDestroying)
6622	{
6623	/* inform powerDown() there are no more callers */
6624	RTSemEventSignal(mVMZeroCallersSem);
6625	}
6626	}
6627
6628
6629	HRESULT Console::i_safeVMPtrRetainer(PUVM *a_ppUVM, bool a_Quiet)
6630	{
6631	*a_ppUVM = NULL;
6632
6633	AutoCaller autoCaller(this);
6634	AssertComRCReturnRC(autoCaller.rc());
6635	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6636
6637	/*
6638	* Repeat the checks done by addVMCaller.
6639	*/
6640	if (mVMDestroying) /* powerDown() is waiting for all callers to finish */
6641	return a_Quiet
6642	? E_ACCESSDENIED
6643	: setError(E_ACCESSDENIED, tr("The virtual machine is being powered down"));
6644	PUVM pUVM = mpUVM;
6645	if (!pUVM)
6646	return a_Quiet
6647	? E_ACCESSDENIED
6648	: setError(E_ACCESSDENIED, tr("The virtual machine is powered off"));
6649
6650	/*
6651	* Retain a reference to the user mode VM handle and get the global handle.
6652	*/
6653	uint32_t cRefs = VMR3RetainUVM(pUVM);
6654	if (cRefs == UINT32_MAX)
6655	return a_Quiet
6656	? E_ACCESSDENIED
6657	: setError(E_ACCESSDENIED, tr("The virtual machine is powered off"));
6658
6659	/* done */
6660	*a_ppUVM = pUVM;
6661	return S_OK;
6662	}
6663
6664	void Console::i_safeVMPtrReleaser(PUVM *a_ppUVM)
6665	{
6666	if (*a_ppUVM)
6667	VMR3ReleaseUVM(*a_ppUVM);
6668	*a_ppUVM = NULL;
6669	}
6670
6671
6672	/**
6673	* Initialize the release logging facility. In case something
6674	* goes wrong, there will be no release logging. Maybe in the future
6675	* we can add some logic to use different file names in this case.
6676	* Note that the logic must be in sync with Machine::DeleteSettings().
6677	*/
6678	HRESULT Console::i_consoleInitReleaseLog(const ComPtr<IMachine> aMachine)
6679	{
6680	HRESULT hrc = S_OK;
6681
6682	Bstr logFolder;
6683	hrc = aMachine->COMGETTER(LogFolder)(logFolder.asOutParam());
6684	if (FAILED(hrc))
6685	return hrc;
6686
6687	Utf8Str logDir = logFolder;
6688
6689	/* make sure the Logs folder exists */
6690	Assert(logDir.length());
6691	if (!RTDirExists(logDir.c_str()))
6692	RTDirCreateFullPath(logDir.c_str(), 0700);
6693
6694	Utf8Str logFile = Utf8StrFmt("%s%cVBox.log",
6695	logDir.c_str(), RTPATH_DELIMITER);
6696	Utf8Str pngFile = Utf8StrFmt("%s%cVBox.png",
6697	logDir.c_str(), RTPATH_DELIMITER);
6698
6699	/*
6700	* Age the old log files
6701	* Rename .(n-1) to .(n), .(n-2) to .(n-1), ..., and the last log file to .1
6702	* Overwrite target files in case they exist.
6703	*/
6704	ComPtr<IVirtualBox> pVirtualBox;
6705	aMachine->COMGETTER(Parent)(pVirtualBox.asOutParam());
6706	ComPtr<ISystemProperties> pSystemProperties;
6707	pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
6708	ULONG cHistoryFiles = 3;
6709	pSystemProperties->COMGETTER(LogHistoryCount)(&cHistoryFiles);
6710	if (cHistoryFiles)
6711	{
6712	for (int i = cHistoryFiles-1; i >= 0; i--)
6713	{
6714	Utf8Str *files[] = { &logFile, &pngFile };
6715	Utf8Str oldName, newName;
6716
6717	for (unsigned int j = 0; j < RT_ELEMENTS(files); ++j)
6718	{
6719	if (i > 0)
6720	oldName = Utf8StrFmt("%s.%d", files[j]->c_str(), i);
6721	else
6722	oldName = *files[j];
6723	newName = Utf8StrFmt("%s.%d", files[j]->c_str(), i + 1);
6724	/* If the old file doesn't exist, delete the new file (if it
6725	* exists) to provide correct rotation even if the sequence is
6726	* broken */
6727	if ( RTFileRename(oldName.c_str(), newName.c_str(), RTFILEMOVE_FLAGS_REPLACE)
6728	== VERR_FILE_NOT_FOUND)
6729	RTFileDelete(newName.c_str());
6730	}
6731	}
6732	}
6733
6734	char szError[RTPATH_MAX + 128];
6735	int vrc = com::VBoxLogRelCreate("VM", logFile.c_str(),
6736	RTLOGFLAGS_PREFIX_TIME_PROG \| RTLOGFLAGS_RESTRICT_GROUPS,
6737	"all all.restrict -default.restrict",
6738	"VBOX_RELEASE_LOG", RTLOGDEST_FILE,
6739	32768 /* cMaxEntriesPerGroup */,
6740	0 /* cHistory /, 0 / uHistoryFileTime */,
6741	0 /* uHistoryFileSize */, szError, sizeof(szError));
6742	if (RT_FAILURE(vrc))
6743	hrc = setError(E_FAIL, tr("Failed to open release log (%s, %Rrc)"),
6744	szError, vrc);
6745
6746	/* If we've made any directory changes, flush the directory to increase
6747	the likelihood that the log file will be usable after a system panic.
6748
6749	Tip: Try 'export VBOX_RELEASE_LOG_FLAGS=flush' if the last bits of the log
6750	is missing. Just don't have too high hopes for this to help. */
6751	if (SUCCEEDED(hrc) \|\| cHistoryFiles)
6752	RTDirFlush(logDir.c_str());
6753
6754	return hrc;
6755	}
6756
6757	/**
6758	* Common worker for PowerUp and PowerUpPaused.
6759	*
6760	* @returns COM status code.
6761	*
6762	* @param aProgress Where to return the progress object.
6763	* @param aPaused true if PowerUpPaused called.
6764	*/
6765	HRESULT Console::i_powerUp(IProgress **aProgress, bool aPaused)
6766	{
6767
6768	LogFlowThisFuncEnter();
6769
6770	CheckComArgOutPointerValid(aProgress);
6771
6772	AutoCaller autoCaller(this);
6773	if (FAILED(autoCaller.rc())) return autoCaller.rc();
6774
6775	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6776
6777	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
6778	HRESULT rc = S_OK;
6779	ComObjPtr<Progress> pPowerupProgress;
6780	bool fBeganPoweringUp = false;
6781
6782	LONG cOperations = 1;
6783	LONG ulTotalOperationsWeight = 1;
6784
6785	try
6786	{
6787
6788	if (Global::IsOnlineOrTransient(mMachineState))
6789	throw setError(VBOX_E_INVALID_VM_STATE,
6790	tr("The virtual machine is already running or busy (machine state: %s)"),
6791	Global::stringifyMachineState(mMachineState));
6792
6793	/* Set up release logging as early as possible after the check if
6794	* there is already a running VM which we shouldn't disturb. */
6795	rc = i_consoleInitReleaseLog(mMachine);
6796	if (FAILED(rc))
6797	throw rc;
6798
6799	#ifdef VBOX_OPENSSL_FIPS
6800	LogRel(("crypto: FIPS mode %s\n", FIPS_mode() ? "enabled" : "FAILED"));
6801	#endif
6802
6803	/* test and clear the TeleporterEnabled property */
6804	BOOL fTeleporterEnabled;
6805	rc = mMachine->COMGETTER(TeleporterEnabled)(&fTeleporterEnabled);
6806	if (FAILED(rc))
6807	throw rc;
6808
6809	#if 0 /** @todo we should save it afterwards, but that isn't necessarily a good idea. Find a better place for this (VBoxSVC). */
6810	if (fTeleporterEnabled)
6811	{
6812	rc = mMachine->COMSETTER(TeleporterEnabled)(FALSE);
6813	if (FAILED(rc))
6814	throw rc;
6815	}
6816	#endif
6817
6818	/* test the FaultToleranceState property */
6819	FaultToleranceState_T enmFaultToleranceState;
6820	rc = mMachine->COMGETTER(FaultToleranceState)(&enmFaultToleranceState);
6821	if (FAILED(rc))
6822	throw rc;
6823	BOOL fFaultToleranceSyncEnabled = (enmFaultToleranceState == FaultToleranceState_Standby);
6824
6825	/* Create a progress object to track progress of this operation. Must
6826	* be done as early as possible (together with BeginPowerUp()) as this
6827	* is vital for communicating as much as possible early powerup
6828	* failure information to the API caller */
6829	pPowerupProgress.createObject();
6830	Bstr progressDesc;
6831	if (mMachineState == MachineState_Saved)
6832	progressDesc = tr("Restoring virtual machine");
6833	else if (fTeleporterEnabled)
6834	progressDesc = tr("Teleporting virtual machine");
6835	else if (fFaultToleranceSyncEnabled)
6836	progressDesc = tr("Fault Tolerance syncing of remote virtual machine");
6837	else
6838	progressDesc = tr("Starting virtual machine");
6839
6840	Bstr savedStateFile;
6841
6842	/*
6843	* Saved VMs will have to prove that their saved states seem kosher.
6844	*/
6845	if (mMachineState == MachineState_Saved)
6846	{
6847	rc = mMachine->COMGETTER(StateFilePath)(savedStateFile.asOutParam());
6848	if (FAILED(rc))
6849	throw rc;
6850	ComAssertRet(!savedStateFile.isEmpty(), E_FAIL);
6851	int vrc = SSMR3ValidateFile(Utf8Str(savedStateFile).c_str(), false /* fChecksumIt */);
6852	if (RT_FAILURE(vrc))
6853	throw setError(VBOX_E_FILE_ERROR,
6854	tr("VM cannot start because the saved state file '%ls' is invalid (%Rrc). Delete the saved state prior to starting the VM"),
6855	savedStateFile.raw(), vrc);
6856	}
6857
6858	/* Read console data, including console shared folders, stored in the
6859	* saved state file (if not yet done).
6860	*/
6861	rc = i_loadDataFromSavedState();
6862	if (FAILED(rc))
6863	throw rc;
6864
6865	/* Check all types of shared folders and compose a single list */
6866	SharedFolderDataMap sharedFolders;
6867	{
6868	/* first, insert global folders */
6869	for (SharedFolderDataMap::const_iterator it = m_mapGlobalSharedFolders.begin();
6870	it != m_mapGlobalSharedFolders.end();
6871	++it)
6872	{
6873	const SharedFolderData &d = it->second;
6874	sharedFolders[it->first] = d;
6875	}
6876
6877	/* second, insert machine folders */
6878	for (SharedFolderDataMap::const_iterator it = m_mapMachineSharedFolders.begin();
6879	it != m_mapMachineSharedFolders.end();
6880	++it)
6881	{
6882	const SharedFolderData &d = it->second;
6883	sharedFolders[it->first] = d;
6884	}
6885
6886	/* third, insert console folders */
6887	for (SharedFolderMap::const_iterator it = m_mapSharedFolders.begin();
6888	it != m_mapSharedFolders.end();
6889	++it)
6890	{
6891	SharedFolder *pSF = it->second;
6892	AutoCaller sfCaller(pSF);
6893	AutoReadLock sfLock(pSF COMMA_LOCKVAL_SRC_POS);
6894	sharedFolders[it->first] = SharedFolderData(pSF->i_getHostPath(),
6895	pSF->i_isWritable(),
6896	pSF->i_isAutoMounted());
6897	}
6898	}
6899
6900	/* Setup task object and thread to carry out the operaton
6901	* Asycnhronously */
6902	std::auto_ptr<VMPowerUpTask> task(new VMPowerUpTask(this, pPowerupProgress));
6903	ComAssertComRCRetRC(task->rc());
6904
6905	task->mConfigConstructor = i_configConstructor;
6906	task->mSharedFolders = sharedFolders;
6907	task->mStartPaused = aPaused;
6908	if (mMachineState == MachineState_Saved)
6909	task->mSavedStateFile = savedStateFile;
6910	task->mTeleporterEnabled = fTeleporterEnabled;
6911	task->mEnmFaultToleranceState = enmFaultToleranceState;
6912
6913	/* Reset differencing hard disks for which autoReset is true,
6914	* but only if the machine has no snapshots OR the current snapshot
6915	* is an OFFLINE snapshot; otherwise we would reset the current
6916	* differencing image of an ONLINE snapshot which contains the disk
6917	* state of the machine while it was previously running, but without
6918	* the corresponding machine state, which is equivalent to powering
6919	* off a running machine and not good idea
6920	*/
6921	ComPtr<ISnapshot> pCurrentSnapshot;
6922	rc = mMachine->COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam());
6923	if (FAILED(rc))
6924	throw rc;
6925
6926	BOOL fCurrentSnapshotIsOnline = false;
6927	if (pCurrentSnapshot)
6928	{
6929	rc = pCurrentSnapshot->COMGETTER(Online)(&fCurrentSnapshotIsOnline);
6930	if (FAILED(rc))
6931	throw rc;
6932	}
6933
6934	if (!fCurrentSnapshotIsOnline)
6935	{
6936	LogFlowThisFunc(("Looking for immutable images to reset\n"));
6937
6938	com::SafeIfaceArray<IMediumAttachment> atts;
6939	rc = mMachine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(atts));
6940	if (FAILED(rc))
6941	throw rc;
6942
6943	for (size_t i = 0;
6944	i < atts.size();
6945	++i)
6946	{
6947	DeviceType_T devType;
6948	rc = atts[i]->COMGETTER(Type)(&devType);
6949	/** @todo later applies to floppies as well */
6950	if (devType == DeviceType_HardDisk)
6951	{
6952	ComPtr<IMedium> pMedium;
6953	rc = atts[i]->COMGETTER(Medium)(pMedium.asOutParam());
6954	if (FAILED(rc))
6955	throw rc;
6956
6957	/* needs autoreset? */
6958	BOOL autoReset = FALSE;
6959	rc = pMedium->COMGETTER(AutoReset)(&autoReset);
6960	if (FAILED(rc))
6961	throw rc;
6962
6963	if (autoReset)
6964	{
6965	ComPtr<IProgress> pResetProgress;
6966	rc = pMedium->Reset(pResetProgress.asOutParam());
6967	if (FAILED(rc))
6968	throw rc;
6969
6970	/* save for later use on the powerup thread */
6971	task->hardDiskProgresses.push_back(pResetProgress);
6972	}
6973	}
6974	}
6975	}
6976	else
6977	LogFlowThisFunc(("Machine has a current snapshot which is online, skipping immutable images reset\n"));
6978
6979	/* setup task object and thread to carry out the operation
6980	* asynchronously */
6981
6982	#ifdef VBOX_WITH_EXTPACK
6983	mptrExtPackManager->i_dumpAllToReleaseLog();
6984	#endif
6985
6986	#ifdef RT_OS_SOLARIS
6987	/* setup host core dumper for the VM */
6988	Bstr value;
6989	HRESULT hrc = mMachine->GetExtraData(Bstr("VBoxInternal2/CoreDumpEnabled").raw(), value.asOutParam());
6990	if (SUCCEEDED(hrc) && value == "1")
6991	{
6992	Bstr coreDumpDir, coreDumpReplaceSys, coreDumpLive;
6993	mMachine->GetExtraData(Bstr("VBoxInternal2/CoreDumpDir").raw(), coreDumpDir.asOutParam());
6994	mMachine->GetExtraData(Bstr("VBoxInternal2/CoreDumpReplaceSystemDump").raw(), coreDumpReplaceSys.asOutParam());
6995	mMachine->GetExtraData(Bstr("VBoxInternal2/CoreDumpLive").raw(), coreDumpLive.asOutParam());
6996
6997	uint32_t fCoreFlags = 0;
6998	if ( coreDumpReplaceSys.isEmpty() == false
6999	&& Utf8Str(coreDumpReplaceSys).toUInt32() == 1)
7000	fCoreFlags \|= RTCOREDUMPER_FLAGS_REPLACE_SYSTEM_DUMP;
7001
7002	if ( coreDumpLive.isEmpty() == false
7003	&& Utf8Str(coreDumpLive).toUInt32() == 1)
7004	fCoreFlags \|= RTCOREDUMPER_FLAGS_LIVE_CORE;
7005
7006	Utf8Str strDumpDir(coreDumpDir);
7007	const char *pszDumpDir = strDumpDir.c_str();
7008	if ( pszDumpDir
7009	&& *pszDumpDir == '\0')
7010	pszDumpDir = NULL;
7011
7012	int vrc;
7013	if ( pszDumpDir
7014	&& !RTDirExists(pszDumpDir))
7015	{
7016	/*
7017	* Try create the directory.
7018	*/
7019	vrc = RTDirCreateFullPath(pszDumpDir, 0700);
7020	if (RT_FAILURE(vrc))
7021	throw setError(E_FAIL, "Failed to setup CoreDumper. Couldn't create dump directory '%s' (%Rrc)\n",
7022	pszDumpDir, vrc);
7023	}
7024
7025	vrc = RTCoreDumperSetup(pszDumpDir, fCoreFlags);
7026	if (RT_FAILURE(vrc))
7027	throw setError(E_FAIL, "Failed to setup CoreDumper (%Rrc)", vrc);
7028	else
7029	LogRel(("CoreDumper setup successful. pszDumpDir=%s fFlags=%#x\n", pszDumpDir ? pszDumpDir : ".", fCoreFlags));
7030	}
7031	#endif
7032
7033
7034	// If there is immutable drive the process that.
7035	VMPowerUpTask::ProgressList progresses(task->hardDiskProgresses);
7036	if (aProgress && progresses.size() > 0){
7037
7038	for (VMPowerUpTask::ProgressList::const_iterator it = progresses.begin(); it != progresses.end(); ++it)
7039	{
7040	++cOperations;
7041	ulTotalOperationsWeight += 1;
7042	}
7043	rc = pPowerupProgress->init(static_cast<IConsole *>(this),
7044	progressDesc.raw(),
7045	TRUE, // Cancelable
7046	cOperations,
7047	ulTotalOperationsWeight,
7048	Bstr(tr("Starting Hard Disk operations")).raw(),
7049	1);
7050	AssertComRCReturnRC(rc);
7051	}
7052	else if ( mMachineState == MachineState_Saved
7053	\|\| (!fTeleporterEnabled && !fFaultToleranceSyncEnabled))
7054	{
7055	rc = pPowerupProgress->init(static_cast<IConsole *>(this),
7056	progressDesc.raw(),
7057	FALSE /* aCancelable */);
7058	}
7059	else if (fTeleporterEnabled)
7060	{
7061	rc = pPowerupProgress->init(static_cast<IConsole *>(this),
7062	progressDesc.raw(),
7063	TRUE /* aCancelable */,
7064	3 /* cOperations */,
7065	10 /* ulTotalOperationsWeight */,
7066	Bstr(tr("Teleporting virtual machine")).raw(),
7067	1 /* ulFirstOperationWeight */);
7068	}
7069	else if (fFaultToleranceSyncEnabled)
7070	{
7071	rc = pPowerupProgress->init(static_cast<IConsole *>(this),
7072	progressDesc.raw(),
7073	TRUE /* aCancelable */,
7074	3 /* cOperations */,
7075	10 /* ulTotalOperationsWeight */,
7076	Bstr(tr("Fault Tolerance syncing of remote virtual machine")).raw(),
7077	1 /* ulFirstOperationWeight */);
7078	}
7079
7080	if (FAILED(rc))
7081	throw rc;
7082
7083	/* Tell VBoxSVC and Machine about the progress object so they can
7084	combine/proxy it to any openRemoteSession caller. */
7085	LogFlowThisFunc(("Calling BeginPowerUp...\n"));
7086	rc = mControl->BeginPowerUp(pPowerupProgress);
7087	if (FAILED(rc))
7088	{
7089	LogFlowThisFunc(("BeginPowerUp failed\n"));
7090	throw rc;
7091	}
7092	fBeganPoweringUp = true;
7093
7094	LogFlowThisFunc(("Checking if canceled...\n"));
7095	BOOL fCanceled;
7096	rc = pPowerupProgress->COMGETTER(Canceled)(&fCanceled);
7097	if (FAILED(rc))
7098	throw rc;
7099
7100	if (fCanceled)
7101	{
7102	LogFlowThisFunc(("Canceled in BeginPowerUp\n"));
7103	throw setError(E_FAIL, tr("Powerup was canceled"));
7104	}
7105	LogFlowThisFunc(("Not canceled yet.\n"));
7106
7107	/** @todo this code prevents starting a VM with unavailable bridged
7108	* networking interface. The only benefit is a slightly better error
7109	* message, which should be moved to the driver code. This is the
7110	* only reason why I left the code in for now. The driver allows
7111	* unavailable bridged networking interfaces in certain circumstances,
7112	* and this is sabotaged by this check. The VM will initially have no
7113	* network connectivity, but the user can fix this at runtime. */
7114	#if 0
7115	/* the network cards will undergo a quick consistency check */
7116	for (ULONG slot = 0;
7117	slot < maxNetworkAdapters;
7118	++slot)
7119	{
7120	ComPtr<INetworkAdapter> pNetworkAdapter;
7121	mMachine->GetNetworkAdapter(slot, pNetworkAdapter.asOutParam());
7122	BOOL enabled = FALSE;
7123	pNetworkAdapter->COMGETTER(Enabled)(&enabled);
7124	if (!enabled)
7125	continue;
7126
7127	NetworkAttachmentType_T netattach;
7128	pNetworkAdapter->COMGETTER(AttachmentType)(&netattach);
7129	switch (netattach)
7130	{
7131	case NetworkAttachmentType_Bridged:
7132	{
7133	/* a valid host interface must have been set */
7134	Bstr hostif;
7135	pNetworkAdapter->COMGETTER(HostInterface)(hostif.asOutParam());
7136	if (hostif.isEmpty())
7137	{
7138	throw setError(VBOX_E_HOST_ERROR,
7139	tr("VM cannot start because host interface networking requires a host interface name to be set"));
7140	}
7141	ComPtr<IVirtualBox> pVirtualBox;
7142	mMachine->COMGETTER(Parent)(pVirtualBox.asOutParam());
7143	ComPtr<IHost> pHost;
7144	pVirtualBox->COMGETTER(Host)(pHost.asOutParam());
7145	ComPtr<IHostNetworkInterface> pHostInterface;
7146	if (!SUCCEEDED(pHost->FindHostNetworkInterfaceByName(hostif.raw(),
7147	pHostInterface.asOutParam())))
7148	{
7149	throw setError(VBOX_E_HOST_ERROR,
7150	tr("VM cannot start because the host interface '%ls' does not exist"),
7151	hostif.raw());
7152	}
7153	break;
7154	}
7155	default:
7156	break;
7157	}
7158	}
7159	#endif // 0
7160
7161	/* setup task object and thread to carry out the operation
7162	* asynchronously */
7163	if (aProgress){
7164	rc = pPowerupProgress.queryInterfaceTo(aProgress);
7165	AssertComRCReturnRC(rc);
7166	}
7167
7168	int vrc = RTThreadCreate(NULL, Console::i_powerUpThread,
7169	(void *)task.get(), 0,
7170	RTTHREADTYPE_MAIN_WORKER, 0, "VMPwrUp");
7171	if (RT_FAILURE(vrc))
7172	throw setError(E_FAIL, "Could not create VMPowerUp thread (%Rrc)", vrc);
7173
7174	/* task is now owned by powerUpThread(), so release it */
7175	task.release();
7176
7177	/* finally, set the state: no right to fail in this method afterwards
7178	* since we've already started the thread and it is now responsible for
7179	* any error reporting and appropriate state change! */
7180	if (mMachineState == MachineState_Saved)
7181	i_setMachineState(MachineState_Restoring);
7182	else if (fTeleporterEnabled)
7183	i_setMachineState(MachineState_TeleportingIn);
7184	else if (enmFaultToleranceState == FaultToleranceState_Standby)
7185	i_setMachineState(MachineState_FaultTolerantSyncing);
7186	else
7187	i_setMachineState(MachineState_Starting);
7188	}
7189	catch (HRESULT aRC) { rc = aRC; }
7190
7191	if (FAILED(rc) && fBeganPoweringUp)
7192	{
7193
7194	/* The progress object will fetch the current error info */
7195	if (!pPowerupProgress.isNull())
7196	pPowerupProgress->i_notifyComplete(rc);
7197
7198	/* Save the error info across the IPC below. Can't be done before the
7199	* progress notification above, as saving the error info deletes it
7200	* from the current context, and thus the progress object wouldn't be
7201	* updated correctly. */
7202	ErrorInfoKeeper eik;
7203
7204	/* signal end of operation */
7205	mControl->EndPowerUp(rc);
7206	}
7207
7208	LogFlowThisFunc(("mMachineState=%d, rc=%Rhrc\n", mMachineState, rc));
7209	LogFlowThisFuncLeave();
7210	return rc;
7211	}
7212
7213	/**
7214	* Internal power off worker routine.
7215	*
7216	* This method may be called only at certain places with the following meaning
7217	* as shown below:
7218	*
7219	* - if the machine state is either Running or Paused, a normal
7220	* Console-initiated powerdown takes place (e.g. PowerDown());
7221	* - if the machine state is Saving, saveStateThread() has successfully done its
7222	* job;
7223	* - if the machine state is Starting or Restoring, powerUpThread() has failed
7224	* to start/load the VM;
7225	* - if the machine state is Stopping, the VM has powered itself off (i.e. not
7226	* as a result of the powerDown() call).
7227	*
7228	* Calling it in situations other than the above will cause unexpected behavior.
7229	*
7230	* Note that this method should be the only one that destroys mpUVM and sets it
7231	* to NULL.
7232	*
7233	* @param aProgress Progress object to run (may be NULL).
7234	*
7235	* @note Locks this object for writing.
7236	*
7237	* @note Never call this method from a thread that called addVMCaller() or
7238	* instantiated an AutoVMCaller object; first call releaseVMCaller() or
7239	* release(). Otherwise it will deadlock.
7240	*/
7241	HRESULT Console::i_powerDown(IProgress aProgress /= NULL*/)
7242	{
7243	LogFlowThisFuncEnter();
7244
7245	AutoCaller autoCaller(this);
7246	AssertComRCReturnRC(autoCaller.rc());
7247
7248	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7249
7250	/* Total # of steps for the progress object. Must correspond to the
7251	* number of "advance percent count" comments in this method! */
7252	enum { StepCount = 7 };
7253	/* current step */
7254	ULONG step = 0;
7255
7256	HRESULT rc = S_OK;
7257	int vrc = VINF_SUCCESS;
7258
7259	/* sanity */
7260	Assert(mVMDestroying == false);
7261
7262	PUVM pUVM = mpUVM; Assert(pUVM != NULL);
7263	uint32_t cRefs = VMR3RetainUVM(pUVM); Assert(cRefs != UINT32_MAX);
7264
7265	AssertMsg( mMachineState == MachineState_Running
7266	\|\| mMachineState == MachineState_Paused
7267	\|\| mMachineState == MachineState_Stuck
7268	\|\| mMachineState == MachineState_Starting
7269	\|\| mMachineState == MachineState_Stopping
7270	\|\| mMachineState == MachineState_Saving
7271	\|\| mMachineState == MachineState_Restoring
7272	\|\| mMachineState == MachineState_TeleportingPausedVM
7273	\|\| mMachineState == MachineState_FaultTolerantSyncing
7274	\|\| mMachineState == MachineState_TeleportingIn
7275	, ("Invalid machine state: %s\n", Global::stringifyMachineState(mMachineState)));
7276
7277	LogRel(("Console::powerDown(): A request to power off the VM has been issued (mMachineState=%s, InUninit=%d)\n",
7278	Global::stringifyMachineState(mMachineState), getObjectState().getState() == ObjectState::InUninit));
7279
7280	/* Check if we need to power off the VM. In case of mVMPoweredOff=true, the
7281	* VM has already powered itself off in vmstateChangeCallback() and is just
7282	* notifying Console about that. In case of Starting or Restoring,
7283	* powerUpThread() is calling us on failure, so the VM is already off at
7284	* that point. */
7285	if ( !mVMPoweredOff
7286	&& ( mMachineState == MachineState_Starting
7287	\|\| mMachineState == MachineState_Restoring
7288	\|\| mMachineState == MachineState_FaultTolerantSyncing
7289	\|\| mMachineState == MachineState_TeleportingIn)
7290	)
7291	mVMPoweredOff = true;
7292
7293	/*
7294	* Go to Stopping state if not already there.
7295	*
7296	* Note that we don't go from Saving/Restoring to Stopping because
7297	* vmstateChangeCallback() needs it to set the state to Saved on
7298	* VMSTATE_TERMINATED. In terms of protecting from inappropriate operations
7299	* while leaving the lock below, Saving or Restoring should be fine too.
7300	* Ditto for TeleportingPausedVM -> Teleported.
7301	*/
7302	if ( mMachineState != MachineState_Saving
7303	&& mMachineState != MachineState_Restoring
7304	&& mMachineState != MachineState_Stopping
7305	&& mMachineState != MachineState_TeleportingIn
7306	&& mMachineState != MachineState_TeleportingPausedVM
7307	&& mMachineState != MachineState_FaultTolerantSyncing
7308	)
7309	i_setMachineState(MachineState_Stopping);
7310
7311	/* ----------------------------------------------------------------------
7312	* DONE with necessary state changes, perform the power down actions (it's
7313	* safe to release the object lock now if needed)
7314	* ---------------------------------------------------------------------- */
7315
7316	if (mDisplay)
7317	{
7318	alock.release();
7319
7320	mDisplay->notifyPowerDown();
7321
7322	alock.acquire();
7323	}
7324
7325	/* Stop the VRDP server to prevent new clients connection while VM is being
7326	* powered off. */
7327	if (mConsoleVRDPServer)
7328	{
7329	LogFlowThisFunc(("Stopping VRDP server...\n"));
7330
7331	/* Leave the lock since EMT could call us back as addVMCaller() */
7332	alock.release();
7333
7334	mConsoleVRDPServer->Stop();
7335
7336	alock.acquire();
7337	}
7338
7339	/* advance percent count */
7340	if (aProgress)
7341	aProgress->SetCurrentOperationProgress(99 * (++step) / StepCount );
7342
7343
7344	/* ----------------------------------------------------------------------
7345	* Now, wait for all mpUVM callers to finish their work if there are still
7346	* some on other threads. NO methods that need mpUVM (or initiate other calls
7347	* that need it) may be called after this point
7348	* ---------------------------------------------------------------------- */
7349
7350	/* go to the destroying state to prevent from adding new callers */
7351	mVMDestroying = true;
7352
7353	if (mVMCallers > 0)
7354	{
7355	/* lazy creation */
7356	if (mVMZeroCallersSem == NIL_RTSEMEVENT)
7357	RTSemEventCreate(&mVMZeroCallersSem);
7358
7359	LogFlowThisFunc(("Waiting for mpUVM callers (%d) to drop to zero...\n", mVMCallers));
7360
7361	alock.release();
7362
7363	RTSemEventWait(mVMZeroCallersSem, RT_INDEFINITE_WAIT);
7364
7365	alock.acquire();
7366	}
7367
7368	/* advance percent count */
7369	if (aProgress)
7370	aProgress->SetCurrentOperationProgress(99 * (++step) / StepCount );
7371
7372	vrc = VINF_SUCCESS;
7373
7374	/*
7375	* Power off the VM if not already done that.
7376	* Leave the lock since EMT will call vmstateChangeCallback.
7377	*
7378	* Note that VMR3PowerOff() may fail here (invalid VMSTATE) if the
7379	* VM-(guest-)initiated power off happened in parallel a ms before this
7380	* call. So far, we let this error pop up on the user's side.
7381	*/
7382	if (!mVMPoweredOff)
7383	{
7384	LogFlowThisFunc(("Powering off the VM...\n"));
7385	alock.release();
7386	vrc = VMR3PowerOff(pUVM);
7387	#ifdef VBOX_WITH_EXTPACK
7388	mptrExtPackManager->i_callAllVmPowerOffHooks(this, VMR3GetVM(pUVM));
7389	#endif
7390	alock.acquire();
7391	}
7392
7393	/* advance percent count */
7394	if (aProgress)
7395	aProgress->SetCurrentOperationProgress(99 * (++step) / StepCount );
7396
7397	#ifdef VBOX_WITH_HGCM
7398	/* Shutdown HGCM services before destroying the VM. */
7399	if (m_pVMMDev)
7400	{
7401	LogFlowThisFunc(("Shutdown HGCM...\n"));
7402
7403	/* Leave the lock since EMT will call us back as addVMCaller() */
7404	alock.release();
7405
7406	m_pVMMDev->hgcmShutdown();
7407
7408	alock.acquire();
7409	}
7410
7411	/* advance percent count */
7412	if (aProgress)
7413	aProgress->SetCurrentOperationProgress(99 * (++step) / StepCount);
7414
7415	#endif /* VBOX_WITH_HGCM */
7416
7417	LogFlowThisFunc(("Ready for VM destruction.\n"));
7418
7419	/* If we are called from Console::uninit(), then try to destroy the VM even
7420	* on failure (this will most likely fail too, but what to do?..) */
7421	if (RT_SUCCESS(vrc) \|\| getObjectState().getState() == ObjectState::InUninit)
7422	{
7423	/* If the machine has a USB controller, release all USB devices
7424	* (symmetric to the code in captureUSBDevices()) */
7425	if (mfVMHasUsbController)
7426	{
7427	alock.release();
7428	i_detachAllUSBDevices(false /* aDone */);
7429	alock.acquire();
7430	}
7431
7432	/* Now we've got to destroy the VM as well. (mpUVM is not valid beyond
7433	* this point). We release the lock before calling VMR3Destroy() because
7434	* it will result into calling destructors of drivers associated with
7435	* Console children which may in turn try to lock Console (e.g. by
7436	* instantiating SafeVMPtr to access mpUVM). It's safe here because
7437	* mVMDestroying is set which should prevent any activity. */
7438
7439	/* Set mpUVM to NULL early just in case if some old code is not using
7440	* addVMCaller()/releaseVMCaller(). (We have our own ref on pUVM.) */
7441	VMR3ReleaseUVM(mpUVM);
7442	mpUVM = NULL;
7443
7444	LogFlowThisFunc(("Destroying the VM...\n"));
7445
7446	alock.release();
7447
7448	vrc = VMR3Destroy(pUVM);
7449
7450	/* take the lock again */
7451	alock.acquire();
7452
7453	/* advance percent count */
7454	if (aProgress)
7455	aProgress->SetCurrentOperationProgress(99 * (++step) / StepCount);
7456
7457	if (RT_SUCCESS(vrc))
7458	{
7459	LogFlowThisFunc(("Machine has been destroyed (mMachineState=%d)\n",
7460	mMachineState));
7461	/* Note: the Console-level machine state change happens on the
7462	* VMSTATE_TERMINATE state change in vmstateChangeCallback(). If
7463	* powerDown() is called from EMT (i.e. from vmstateChangeCallback()
7464	* on receiving VM-initiated VMSTATE_OFF), VMSTATE_TERMINATE hasn't
7465	* occurred yet. This is okay, because mMachineState is already
7466	* Stopping in this case, so any other attempt to call PowerDown()
7467	* will be rejected. */
7468	}
7469	else
7470	{
7471	/* bad bad bad, but what to do? (Give Console our UVM ref.) */
7472	mpUVM = pUVM;
7473	pUVM = NULL;
7474	rc = setError(VBOX_E_VM_ERROR,
7475	tr("Could not destroy the machine. (Error: %Rrc)"),
7476	vrc);
7477	}
7478
7479	/* Complete the detaching of the USB devices. */
7480	if (mfVMHasUsbController)
7481	{
7482	alock.release();
7483	i_detachAllUSBDevices(true /* aDone */);
7484	alock.acquire();
7485	}
7486
7487	/* advance percent count */
7488	if (aProgress)
7489	aProgress->SetCurrentOperationProgress(99 * (++step) / StepCount);
7490	}
7491	else
7492	{
7493	rc = setError(VBOX_E_VM_ERROR,
7494	tr("Could not power off the machine. (Error: %Rrc)"),
7495	vrc);
7496	}
7497
7498	/*
7499	* Finished with the destruction.
7500	*
7501	* Note that if something impossible happened and we've failed to destroy
7502	* the VM, mVMDestroying will remain true and mMachineState will be
7503	* something like Stopping, so most Console methods will return an error
7504	* to the caller.
7505	*/
7506	if (pUVM != NULL)
7507	VMR3ReleaseUVM(pUVM);
7508	else
7509	mVMDestroying = false;
7510
7511	#ifdef CONSOLE_WITH_EVENT_CACHE
7512	if (SUCCEEDED(rc))
7513	mCallbackData.clear();
7514	#endif
7515
7516	LogFlowThisFuncLeave();
7517	return rc;
7518	}
7519
7520	/**
7521	* @note Locks this object for writing.
7522	*/
7523	HRESULT Console::i_setMachineState(MachineState_T aMachineState,
7524	bool aUpdateServer /* = true */)
7525	{
7526	AutoCaller autoCaller(this);
7527	AssertComRCReturnRC(autoCaller.rc());
7528
7529	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7530
7531	HRESULT rc = S_OK;
7532
7533	if (mMachineState != aMachineState)
7534	{
7535	LogThisFunc(("machineState=%s -> %s aUpdateServer=%RTbool\n",
7536	Global::stringifyMachineState(mMachineState), Global::stringifyMachineState(aMachineState), aUpdateServer));
7537	mMachineState = aMachineState;
7538
7539	/// @todo (dmik)
7540	// possibly, we need to redo onStateChange() using the dedicated
7541	// Event thread, like it is done in VirtualBox. This will make it
7542	// much safer (no deadlocks possible if someone tries to use the
7543	// console from the callback), however, listeners will lose the
7544	// ability to synchronously react to state changes (is it really
7545	// necessary??)
7546	LogFlowThisFunc(("Doing onStateChange()...\n"));
7547	i_onStateChange(aMachineState);
7548	LogFlowThisFunc(("Done onStateChange()\n"));
7549
7550	if (aUpdateServer)
7551	{
7552	/* Server notification MUST be done from under the lock; otherwise
7553	* the machine state here and on the server might go out of sync
7554	* which can lead to various unexpected results (like the machine
7555	* state being >= MachineState_Running on the server, while the
7556	* session state is already SessionState_Unlocked at the same time
7557	* there).
7558	*
7559	* Cross-lock conditions should be carefully watched out: calling
7560	* UpdateState we will require Machine and SessionMachine locks
7561	* (remember that here we're holding the Console lock here, and also
7562	* all locks that have been acquire by the thread before calling
7563	* this method).
7564	*/
7565	LogFlowThisFunc(("Doing mControl->UpdateState()...\n"));
7566	rc = mControl->UpdateState(aMachineState);
7567	LogFlowThisFunc(("mControl->UpdateState()=%Rhrc\n", rc));
7568	}
7569	}
7570
7571	return rc;
7572	}
7573
7574	/**
7575	* Searches for a shared folder with the given logical name
7576	* in the collection of shared folders.
7577	*
7578	* @param aName logical name of the shared folder
7579	* @param aSharedFolder where to return the found object
7580	* @param aSetError whether to set the error info if the folder is
7581	* not found
7582	* @return
7583	* S_OK when found or E_INVALIDARG when not found
7584	*
7585	* @note The caller must lock this object for writing.
7586	*/
7587	HRESULT Console::i_findSharedFolder(const Utf8Str &strName,
7588	ComObjPtr<SharedFolder> &aSharedFolder,
7589	bool aSetError /* = false */)
7590	{
7591	/* sanity check */
7592	AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
7593
7594	SharedFolderMap::const_iterator it = m_mapSharedFolders.find(strName);
7595	if (it != m_mapSharedFolders.end())
7596	{
7597	aSharedFolder = it->second;
7598	return S_OK;
7599	}
7600
7601	if (aSetError)
7602	setError(VBOX_E_FILE_ERROR,
7603	tr("Could not find a shared folder named '%s'."),
7604	strName.c_str());
7605
7606	return VBOX_E_FILE_ERROR;
7607	}
7608
7609	/**
7610	* Fetches the list of global or machine shared folders from the server.
7611	*
7612	* @param aGlobal true to fetch global folders.
7613	*
7614	* @note The caller must lock this object for writing.
7615	*/
7616	HRESULT Console::i_fetchSharedFolders(BOOL aGlobal)
7617	{
7618	/* sanity check */
7619	AssertReturn( getObjectState().getState() == ObjectState::InInit
7620	\|\| isWriteLockOnCurrentThread(), E_FAIL);
7621
7622	LogFlowThisFunc(("Entering\n"));
7623
7624	/* Check if we're online and keep it that way. */
7625	SafeVMPtrQuiet ptrVM(this);
7626	AutoVMCallerQuietWeak autoVMCaller(this);
7627	bool const online = ptrVM.isOk()
7628	&& m_pVMMDev
7629	&& m_pVMMDev->isShFlActive();
7630
7631	HRESULT rc = S_OK;
7632
7633	try
7634	{
7635	if (aGlobal)
7636	{
7637	/// @todo grab & process global folders when they are done
7638	}
7639	else
7640	{
7641	SharedFolderDataMap oldFolders;
7642	if (online)
7643	oldFolders = m_mapMachineSharedFolders;
7644
7645	m_mapMachineSharedFolders.clear();
7646
7647	SafeIfaceArray<ISharedFolder> folders;
7648	rc = mMachine->COMGETTER(SharedFolders)(ComSafeArrayAsOutParam(folders));
7649	if (FAILED(rc)) throw rc;
7650
7651	for (size_t i = 0; i < folders.size(); ++i)
7652	{
7653	ComPtr<ISharedFolder> pSharedFolder = folders[i];
7654
7655	Bstr bstrName;
7656	Bstr bstrHostPath;
7657	BOOL writable;
7658	BOOL autoMount;
7659
7660	rc = pSharedFolder->COMGETTER(Name)(bstrName.asOutParam());
7661	if (FAILED(rc)) throw rc;
7662	Utf8Str strName(bstrName);
7663
7664	rc = pSharedFolder->COMGETTER(HostPath)(bstrHostPath.asOutParam());
7665	if (FAILED(rc)) throw rc;
7666	Utf8Str strHostPath(bstrHostPath);
7667
7668	rc = pSharedFolder->COMGETTER(Writable)(&writable);
7669	if (FAILED(rc)) throw rc;
7670
7671	rc = pSharedFolder->COMGETTER(AutoMount)(&autoMount);
7672	if (FAILED(rc)) throw rc;
7673
7674	m_mapMachineSharedFolders.insert(std::make_pair(strName,
7675	SharedFolderData(strHostPath, !!writable, !!autoMount)));
7676
7677	/* send changes to HGCM if the VM is running */
7678	if (online)
7679	{
7680	SharedFolderDataMap::iterator it = oldFolders.find(strName);
7681	if ( it == oldFolders.end()
7682	\|\| it->second.m_strHostPath != strHostPath)
7683	{
7684	/* a new machine folder is added or
7685	* the existing machine folder is changed */
7686	if (m_mapSharedFolders.find(strName) != m_mapSharedFolders.end())
7687	; /* the console folder exists, nothing to do */
7688	else
7689	{
7690	/* remove the old machine folder (when changed)
7691	* or the global folder if any (when new) */
7692	if ( it != oldFolders.end()
7693	\|\| m_mapGlobalSharedFolders.find(strName) != m_mapGlobalSharedFolders.end()
7694	)
7695	{
7696	rc = removeSharedFolder(strName);
7697	if (FAILED(rc)) throw rc;
7698	}
7699
7700	/* create the new machine folder */
7701	rc = i_createSharedFolder(strName,
7702	SharedFolderData(strHostPath, !!writable, !!autoMount));
7703	if (FAILED(rc)) throw rc;
7704	}
7705	}
7706	/* forget the processed (or identical) folder */
7707	if (it != oldFolders.end())
7708	oldFolders.erase(it);
7709	}
7710	}
7711
7712	/* process outdated (removed) folders */
7713	if (online)
7714	{
7715	for (SharedFolderDataMap::const_iterator it = oldFolders.begin();
7716	it != oldFolders.end(); ++it)
7717	{
7718	if (m_mapSharedFolders.find(it->first) != m_mapSharedFolders.end())
7719	; /* the console folder exists, nothing to do */
7720	else
7721	{
7722	/* remove the outdated machine folder */
7723	rc = removeSharedFolder(it->first);
7724	if (FAILED(rc)) throw rc;
7725
7726	/* create the global folder if there is any */
7727	SharedFolderDataMap::const_iterator git =
7728	m_mapGlobalSharedFolders.find(it->first);
7729	if (git != m_mapGlobalSharedFolders.end())
7730	{
7731	rc = i_createSharedFolder(git->first, git->second);
7732	if (FAILED(rc)) throw rc;
7733	}
7734	}
7735	}
7736	}
7737	}
7738	}
7739	catch (HRESULT rc2)
7740	{
7741	rc = rc2;
7742	if (online)
7743	i_setVMRuntimeErrorCallbackF(0, "BrokenSharedFolder",
7744	N_("Broken shared folder!"));
7745	}
7746
7747	LogFlowThisFunc(("Leaving\n"));
7748
7749	return rc;
7750	}
7751
7752	/**
7753	* Searches for a shared folder with the given name in the list of machine
7754	* shared folders and then in the list of the global shared folders.
7755	*
7756	* @param aName Name of the folder to search for.
7757	* @param aIt Where to store the pointer to the found folder.
7758	* @return @c true if the folder was found and @c false otherwise.
7759	*
7760	* @note The caller must lock this object for reading.
7761	*/
7762	bool Console::i_findOtherSharedFolder(const Utf8Str &strName,
7763	SharedFolderDataMap::const_iterator &aIt)
7764	{
7765	/* sanity check */
7766	AssertReturn(isWriteLockOnCurrentThread(), false);
7767
7768	/* first, search machine folders */
7769	aIt = m_mapMachineSharedFolders.find(strName);
7770	if (aIt != m_mapMachineSharedFolders.end())
7771	return true;
7772
7773	/* second, search machine folders */
7774	aIt = m_mapGlobalSharedFolders.find(strName);
7775	if (aIt != m_mapGlobalSharedFolders.end())
7776	return true;
7777
7778	return false;
7779	}
7780
7781	/**
7782	* Calls the HGCM service to add a shared folder definition.
7783	*
7784	* @param aName Shared folder name.
7785	* @param aHostPath Shared folder path.
7786	*
7787	* @note Must be called from under AutoVMCaller and when mpUVM != NULL!
7788	* @note Doesn't lock anything.
7789	*/
7790	HRESULT Console::i_createSharedFolder(const Utf8Str &strName, const SharedFolderData &aData)
7791	{
7792	ComAssertRet(strName.isNotEmpty(), E_FAIL);
7793	ComAssertRet(aData.m_strHostPath.isNotEmpty(), E_FAIL);
7794
7795	/* sanity checks */
7796	AssertReturn(mpUVM, E_FAIL);
7797	AssertReturn(m_pVMMDev && m_pVMMDev->isShFlActive(), E_FAIL);
7798
7799	VBOXHGCMSVCPARM parms[SHFL_CPARMS_ADD_MAPPING];
7800	SHFLSTRING pFolderName, pMapName;
7801	size_t cbString;
7802
7803	Bstr value;
7804	HRESULT hrc = mMachine->GetExtraData(BstrFmt("VBoxInternal2/SharedFoldersEnableSymlinksCreate/%s",
7805	strName.c_str()).raw(),
7806	value.asOutParam());
7807	bool fSymlinksCreate = hrc == S_OK && value == "1";
7808
7809	Log(("Adding shared folder '%s' -> '%s'\n", strName.c_str(), aData.m_strHostPath.c_str()));
7810
7811	// check whether the path is valid and exists
7812	char hostPathFull[RTPATH_MAX];
7813	int vrc = RTPathAbsEx(NULL,
7814	aData.m_strHostPath.c_str(),
7815	hostPathFull,
7816	sizeof(hostPathFull));
7817
7818	bool fMissing = false;
7819	if (RT_FAILURE(vrc))
7820	return setError(E_INVALIDARG,
7821	tr("Invalid shared folder path: '%s' (%Rrc)"),
7822	aData.m_strHostPath.c_str(), vrc);
7823	if (!RTPathExists(hostPathFull))
7824	fMissing = true;
7825
7826	/* Check whether the path is full (absolute) */
7827	if (RTPathCompare(aData.m_strHostPath.c_str(), hostPathFull) != 0)
7828	return setError(E_INVALIDARG,
7829	tr("Shared folder path '%s' is not absolute"),
7830	aData.m_strHostPath.c_str());
7831
7832	// now that we know the path is good, give it to HGCM
7833
7834	Bstr bstrName(strName);
7835	Bstr bstrHostPath(aData.m_strHostPath);
7836
7837	cbString = (bstrHostPath.length() + 1) * sizeof(RTUTF16);
7838	if (cbString >= UINT16_MAX)
7839	return setError(E_INVALIDARG, tr("The name is too long"));
7840	pFolderName = (SHFLSTRING*)RTMemAllocZ(SHFLSTRING_HEADER_SIZE + cbString);
7841	Assert(pFolderName);
7842	memcpy(pFolderName->String.ucs2, bstrHostPath.raw(), cbString);
7843
7844	pFolderName->u16Size = (uint16_t)cbString;
7845	pFolderName->u16Length = (uint16_t)cbString - sizeof(RTUTF16);
7846
7847	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
7848	parms[0].u.pointer.addr = pFolderName;
7849	parms[0].u.pointer.size = ShflStringSizeOfBuffer(pFolderName);
7850
7851	cbString = (bstrName.length() + 1) * sizeof(RTUTF16);
7852	if (cbString >= UINT16_MAX)
7853	{
7854	RTMemFree(pFolderName);
7855	return setError(E_INVALIDARG, tr("The host path is too long"));
7856	}
7857	pMapName = (SHFLSTRING*)RTMemAllocZ(SHFLSTRING_HEADER_SIZE + cbString);
7858	Assert(pMapName);
7859	memcpy(pMapName->String.ucs2, bstrName.raw(), cbString);
7860
7861	pMapName->u16Size = (uint16_t)cbString;
7862	pMapName->u16Length = (uint16_t)cbString - sizeof(RTUTF16);
7863
7864	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
7865	parms[1].u.pointer.addr = pMapName;
7866	parms[1].u.pointer.size = ShflStringSizeOfBuffer(pMapName);
7867
7868	parms[2].type = VBOX_HGCM_SVC_PARM_32BIT;
7869	parms[2].u.uint32 = (aData.m_fWritable ? SHFL_ADD_MAPPING_F_WRITABLE : 0)
7870	\| (aData.m_fAutoMount ? SHFL_ADD_MAPPING_F_AUTOMOUNT : 0)
7871	\| (fSymlinksCreate ? SHFL_ADD_MAPPING_F_CREATE_SYMLINKS : 0)
7872	\| (fMissing ? SHFL_ADD_MAPPING_F_MISSING : 0)
7873	;
7874
7875	vrc = m_pVMMDev->hgcmHostCall("VBoxSharedFolders",
7876	SHFL_FN_ADD_MAPPING,
7877	SHFL_CPARMS_ADD_MAPPING, &parms[0]);
7878	RTMemFree(pFolderName);
7879	RTMemFree(pMapName);
7880
7881	if (RT_FAILURE(vrc))
7882	return setError(E_FAIL,
7883	tr("Could not create a shared folder '%s' mapped to '%s' (%Rrc)"),
7884	strName.c_str(), aData.m_strHostPath.c_str(), vrc);
7885
7886	if (fMissing)
7887	return setError(E_INVALIDARG,
7888	tr("Shared folder path '%s' does not exist on the host"),
7889	aData.m_strHostPath.c_str());
7890
7891	return S_OK;
7892	}
7893
7894	/**
7895	* Calls the HGCM service to remove the shared folder definition.
7896	*
7897	* @param aName Shared folder name.
7898	*
7899	* @note Must be called from under AutoVMCaller and when mpUVM != NULL!
7900	* @note Doesn't lock anything.
7901	*/
7902	HRESULT Console::i_removeSharedFolder(const Utf8Str &strName)
7903	{
7904	ComAssertRet(strName.isNotEmpty(), E_FAIL);
7905
7906	/* sanity checks */
7907	AssertReturn(mpUVM, E_FAIL);
7908	AssertReturn(m_pVMMDev && m_pVMMDev->isShFlActive(), E_FAIL);
7909
7910	VBOXHGCMSVCPARM parms;
7911	SHFLSTRING *pMapName;
7912	size_t cbString;
7913
7914	Log(("Removing shared folder '%s'\n", strName.c_str()));
7915
7916	Bstr bstrName(strName);
7917	cbString = (bstrName.length() + 1) * sizeof(RTUTF16);
7918	if (cbString >= UINT16_MAX)
7919	return setError(E_INVALIDARG, tr("The name is too long"));
7920	pMapName = (SHFLSTRING *) RTMemAllocZ(SHFLSTRING_HEADER_SIZE + cbString);
7921	Assert(pMapName);
7922	memcpy(pMapName->String.ucs2, bstrName.raw(), cbString);
7923
7924	pMapName->u16Size = (uint16_t)cbString;
7925	pMapName->u16Length = (uint16_t)cbString - sizeof(RTUTF16);
7926
7927	parms.type = VBOX_HGCM_SVC_PARM_PTR;
7928	parms.u.pointer.addr = pMapName;
7929	parms.u.pointer.size = ShflStringSizeOfBuffer(pMapName);
7930
7931	int vrc = m_pVMMDev->hgcmHostCall("VBoxSharedFolders",
7932	SHFL_FN_REMOVE_MAPPING,
7933	1, &parms);
7934	RTMemFree(pMapName);
7935	if (RT_FAILURE(vrc))
7936	return setError(E_FAIL,
7937	tr("Could not remove the shared folder '%s' (%Rrc)"),
7938	strName.c_str(), vrc);
7939
7940	return S_OK;
7941	}
7942
7943	/** @callback_method_impl{FNVMATSTATE}
7944	*
7945	* @note Locks the Console object for writing.
7946	* @remarks The @a pUVM parameter can be NULL in one case where powerUpThread()
7947	* calls after the VM was destroyed.
7948	*/
7949	DECLCALLBACK(void) Console::i_vmstateChangeCallback(PUVM pUVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser)
7950	{
7951	LogFlowFunc(("Changing state from %s to %s (pUVM=%p)\n",
7952	VMR3GetStateName(enmOldState), VMR3GetStateName(enmState), pUVM));
7953
7954	Console that = static_cast<Console >(pvUser);
7955	AssertReturnVoid(that);
7956
7957	AutoCaller autoCaller(that);
7958
7959	/* Note that we must let this method proceed even if Console::uninit() has
7960	* been already called. In such case this VMSTATE change is a result of:
7961	* 1) powerDown() called from uninit() itself, or
7962	* 2) VM-(guest-)initiated power off. */
7963	AssertReturnVoid( autoCaller.isOk()
7964	\|\| that->getObjectState().getState() == ObjectState::InUninit);
7965
7966	switch (enmState)
7967	{
7968	/*
7969	* The VM has terminated
7970	*/
7971	case VMSTATE_OFF:
7972	{
7973	#ifdef VBOX_WITH_GUEST_PROPS
7974	if (that->i_isResetTurnedIntoPowerOff())
7975	{
7976	Bstr strPowerOffReason;
7977
7978	if (that->mfPowerOffCausedByReset)
7979	strPowerOffReason = Bstr("Reset");
7980	else
7981	strPowerOffReason = Bstr("PowerOff");
7982
7983	that->mMachine->DeleteGuestProperty(Bstr("/VirtualBox/HostInfo/VMPowerOffReason").raw());
7984	that->mMachine->SetGuestProperty(Bstr("/VirtualBox/HostInfo/VMPowerOffReason").raw(),
7985	strPowerOffReason.raw(), Bstr("RDONLYGUEST").raw());
7986	that->mMachine->SaveSettings();
7987	}
7988	#endif
7989
7990	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
7991
7992	if (that->mVMStateChangeCallbackDisabled)
7993	return;
7994
7995	/* Do we still think that it is running? It may happen if this is a
7996	* VM-(guest-)initiated shutdown/poweroff.
7997	*/
7998	if ( that->mMachineState != MachineState_Stopping
7999	&& that->mMachineState != MachineState_Saving
8000	&& that->mMachineState != MachineState_Restoring
8001	&& that->mMachineState != MachineState_TeleportingIn
8002	&& that->mMachineState != MachineState_FaultTolerantSyncing
8003	&& that->mMachineState != MachineState_TeleportingPausedVM
8004	&& !that->mVMIsAlreadyPoweringOff
8005	)
8006	{
8007	LogFlowFunc(("VM has powered itself off but Console still thinks it is running. Notifying.\n"));
8008
8009	/*
8010	* Prevent powerDown() from calling VMR3PowerOff() again if this was called from
8011	* the power off state change.
8012	* When called from the Reset state make sure to call VMR3PowerOff() first.
8013	*/
8014	Assert(that->mVMPoweredOff == false);
8015	that->mVMPoweredOff = true;
8016
8017	/*
8018	* request a progress object from the server
8019	* (this will set the machine state to Stopping on the server
8020	* to block others from accessing this machine)
8021	*/
8022	ComPtr<IProgress> pProgress;
8023	HRESULT rc = that->mControl->BeginPoweringDown(pProgress.asOutParam());
8024	AssertComRC(rc);
8025
8026	/* sync the state with the server */
8027	that->i_setMachineStateLocally(MachineState_Stopping);
8028
8029	/* Setup task object and thread to carry out the operation
8030	* asynchronously (if we call powerDown() right here but there
8031	* is one or more mpUVM callers (added with addVMCaller()) we'll
8032	* deadlock).
8033	*/
8034	std::auto_ptr<VMPowerDownTask> task(new VMPowerDownTask(that, pProgress));
8035
8036	/* If creating a task failed, this can currently mean one of
8037	* two: either Console::uninit() has been called just a ms
8038	* before (so a powerDown() call is already on the way), or
8039	* powerDown() itself is being already executed. Just do
8040	* nothing.
8041	*/
8042	if (!task->isOk())
8043	{
8044	LogFlowFunc(("Console is already being uninitialized.\n"));
8045	return;
8046	}
8047
8048	int vrc = RTThreadCreate(NULL, Console::i_powerDownThread,
8049	(void *)task.get(), 0,
8050	RTTHREADTYPE_MAIN_WORKER, 0,
8051	"VMPwrDwn");
8052	AssertMsgRCReturnVoid(vrc, ("Could not create VMPowerDown thread (%Rrc)\n", vrc));
8053
8054	/* task is now owned by powerDownThread(), so release it */
8055	task.release();
8056	}
8057	break;
8058	}
8059
8060	/* The VM has been completely destroyed.
8061	*
8062	* Note: This state change can happen at two points:
8063	* 1) At the end of VMR3Destroy() if it was not called from EMT.
8064	* 2) At the end of vmR3EmulationThread if VMR3Destroy() was
8065	* called by EMT.
8066	*/
8067	case VMSTATE_TERMINATED:
8068	{
8069	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
8070
8071	if (that->mVMStateChangeCallbackDisabled)
8072	break;
8073
8074	/* Terminate host interface networking. If pUVM is NULL, we've been
8075	* manually called from powerUpThread() either before calling
8076	* VMR3Create() or after VMR3Create() failed, so no need to touch
8077	* networking.
8078	*/
8079	if (pUVM)
8080	that->i_powerDownHostInterfaces();
8081
8082	/* From now on the machine is officially powered down or remains in
8083	* the Saved state.
8084	*/
8085	switch (that->mMachineState)
8086	{
8087	default:
8088	AssertFailed();
8089	/* fall through */
8090	case MachineState_Stopping:
8091	/* successfully powered down */
8092	that->i_setMachineState(MachineState_PoweredOff);
8093	break;
8094	case MachineState_Saving:
8095	/* successfully saved */
8096	that->i_setMachineState(MachineState_Saved);
8097	break;
8098	case MachineState_Starting:
8099	/* failed to start, but be patient: set back to PoweredOff
8100	* (for similarity with the below) */
8101	that->i_setMachineState(MachineState_PoweredOff);
8102	break;
8103	case MachineState_Restoring:
8104	/* failed to load the saved state file, but be patient: set
8105	* back to Saved (to preserve the saved state file) */
8106	that->i_setMachineState(MachineState_Saved);
8107	break;
8108	case MachineState_TeleportingIn:
8109	/* Teleportation failed or was canceled. Back to powered off. */
8110	that->i_setMachineState(MachineState_PoweredOff);
8111	break;
8112	case MachineState_TeleportingPausedVM:
8113	/* Successfully teleported the VM. */
8114	that->i_setMachineState(MachineState_Teleported);
8115	break;
8116	case MachineState_FaultTolerantSyncing:
8117	/* Fault tolerant sync failed or was canceled. Back to powered off. */
8118	that->i_setMachineState(MachineState_PoweredOff);
8119	break;
8120	}
8121	break;
8122	}
8123
8124	case VMSTATE_RESETTING:
8125	{
8126	#ifdef VBOX_WITH_GUEST_PROPS
8127	/* Do not take any read/write locks here! */
8128	that->i_guestPropertiesHandleVMReset();
8129	#endif
8130	break;
8131	}
8132
8133	case VMSTATE_SUSPENDED:
8134	{
8135	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
8136
8137	if (that->mVMStateChangeCallbackDisabled)
8138	break;
8139
8140	switch (that->mMachineState)
8141	{
8142	case MachineState_Teleporting:
8143	that->i_setMachineState(MachineState_TeleportingPausedVM);
8144	break;
8145
8146	case MachineState_LiveSnapshotting:
8147	that->i_setMachineState(MachineState_Saving);
8148	break;
8149
8150	case MachineState_TeleportingPausedVM:
8151	case MachineState_Saving:
8152	case MachineState_Restoring:
8153	case MachineState_Stopping:
8154	case MachineState_TeleportingIn:
8155	case MachineState_FaultTolerantSyncing:
8156	/* The worker thread handles the transition. */
8157	break;
8158
8159	default:
8160	AssertMsgFailed(("%s\n", Global::stringifyMachineState(that->mMachineState)));
8161	case MachineState_Running:
8162	that->i_setMachineState(MachineState_Paused);
8163	break;
8164
8165	case MachineState_Paused:
8166	/* Nothing to do. */
8167	break;
8168	}
8169	break;
8170	}
8171
8172	case VMSTATE_SUSPENDED_LS:
8173	case VMSTATE_SUSPENDED_EXT_LS:
8174	{
8175	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
8176	if (that->mVMStateChangeCallbackDisabled)
8177	break;
8178	switch (that->mMachineState)
8179	{
8180	case MachineState_Teleporting:
8181	that->i_setMachineState(MachineState_TeleportingPausedVM);
8182	break;
8183
8184	case MachineState_LiveSnapshotting:
8185	that->i_setMachineState(MachineState_Saving);
8186	break;
8187
8188	case MachineState_TeleportingPausedVM:
8189	case MachineState_Saving:
8190	/* ignore */
8191	break;
8192
8193	default:
8194	AssertMsgFailed(("%s/%s -> %s\n", Global::stringifyMachineState(that->mMachineState),
8195	VMR3GetStateName(enmOldState), VMR3GetStateName(enmState) ));
8196	that->i_setMachineState(MachineState_Paused);
8197	break;
8198	}
8199	break;
8200	}
8201
8202	case VMSTATE_RUNNING:
8203	{
8204	if ( enmOldState == VMSTATE_POWERING_ON
8205	\|\| enmOldState == VMSTATE_RESUMING
8206	\|\| enmOldState == VMSTATE_RUNNING_FT)
8207	{
8208	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
8209
8210	if (that->mVMStateChangeCallbackDisabled)
8211	break;
8212
8213	Assert( ( ( that->mMachineState == MachineState_Starting
8214	\|\| that->mMachineState == MachineState_Paused)
8215	&& enmOldState == VMSTATE_POWERING_ON)
8216	\|\| ( ( that->mMachineState == MachineState_Restoring
8217	\|\| that->mMachineState == MachineState_TeleportingIn
8218	\|\| that->mMachineState == MachineState_Paused
8219	\|\| that->mMachineState == MachineState_Saving
8220	)
8221	&& enmOldState == VMSTATE_RESUMING)
8222	\|\| ( that->mMachineState == MachineState_FaultTolerantSyncing
8223	&& enmOldState == VMSTATE_RUNNING_FT));
8224
8225	that->i_setMachineState(MachineState_Running);
8226	}
8227
8228	break;
8229	}
8230
8231	case VMSTATE_RUNNING_LS:
8232	AssertMsg( that->mMachineState == MachineState_LiveSnapshotting
8233	\|\| that->mMachineState == MachineState_Teleporting,
8234	("%s/%s -> %s\n", Global::stringifyMachineState(that->mMachineState),
8235	VMR3GetStateName(enmOldState), VMR3GetStateName(enmState) ));
8236	break;
8237
8238	case VMSTATE_RUNNING_FT:
8239	AssertMsg(that->mMachineState == MachineState_FaultTolerantSyncing,
8240	("%s/%s -> %s\n", Global::stringifyMachineState(that->mMachineState),
8241	VMR3GetStateName(enmOldState), VMR3GetStateName(enmState) ));
8242	break;
8243
8244	case VMSTATE_FATAL_ERROR:
8245	{
8246	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
8247
8248	if (that->mVMStateChangeCallbackDisabled)
8249	break;
8250
8251	/* Fatal errors are only for running VMs. */
8252	Assert(Global::IsOnline(that->mMachineState));
8253
8254	/* Note! 'Pause' is used here in want of something better. There
8255	* are currently only two places where fatal errors might be
8256	* raised, so it is not worth adding a new externally
8257	* visible state for this yet. */
8258	that->i_setMachineState(MachineState_Paused);
8259	break;
8260	}
8261
8262	case VMSTATE_GURU_MEDITATION:
8263	{
8264	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
8265
8266	if (that->mVMStateChangeCallbackDisabled)
8267	break;
8268
8269	/* Guru are only for running VMs */
8270	Assert(Global::IsOnline(that->mMachineState));
8271
8272	that->i_setMachineState(MachineState_Stuck);
8273	break;
8274	}
8275
8276	default: /* shut up gcc */
8277	break;
8278	}
8279	}
8280
8281	/**
8282	* Changes the clipboard mode.
8283	*
8284	* @param aClipboardMode new clipboard mode.
8285	*/
8286	void Console::i_changeClipboardMode(ClipboardMode_T aClipboardMode)
8287	{
8288	VMMDev *pVMMDev = m_pVMMDev;
8289	Assert(pVMMDev);
8290
8291	VBOXHGCMSVCPARM parm;
8292	parm.type = VBOX_HGCM_SVC_PARM_32BIT;
8293
8294	switch (aClipboardMode)
8295	{
8296	default:
8297	case ClipboardMode_Disabled:
8298	LogRel(("Shared clipboard mode: Off\n"));
8299	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_OFF;
8300	break;
8301	case ClipboardMode_GuestToHost:
8302	LogRel(("Shared clipboard mode: Guest to Host\n"));
8303	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_GUEST_TO_HOST;
8304	break;
8305	case ClipboardMode_HostToGuest:
8306	LogRel(("Shared clipboard mode: Host to Guest\n"));
8307	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_HOST_TO_GUEST;
8308	break;
8309	case ClipboardMode_Bidirectional:
8310	LogRel(("Shared clipboard mode: Bidirectional\n"));
8311	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_BIDIRECTIONAL;
8312	break;
8313	}
8314
8315	pVMMDev->hgcmHostCall("VBoxSharedClipboard", VBOX_SHARED_CLIPBOARD_HOST_FN_SET_MODE, 1, &parm);
8316	}
8317
8318	/**
8319	* Changes the drag'n_drop mode.
8320	*
8321	* @param aDnDMode new drag'n'drop mode.
8322	*/
8323	int Console::i_changeDnDMode(DnDMode_T aDnDMode)
8324	{
8325	VMMDev *pVMMDev = m_pVMMDev;
8326	AssertPtrReturn(pVMMDev, VERR_INVALID_POINTER);
8327
8328	VBOXHGCMSVCPARM parm;
8329	RT_ZERO(parm);
8330	parm.type = VBOX_HGCM_SVC_PARM_32BIT;
8331
8332	switch (aDnDMode)
8333	{
8334	default:
8335	case DnDMode_Disabled:
8336	LogRel(("Changed drag'n drop mode to: Off\n"));
8337	parm.u.uint32 = VBOX_DRAG_AND_DROP_MODE_OFF;
8338	break;
8339	case DnDMode_GuestToHost:
8340	LogRel(("Changed drag'n drop mode to: Guest to Host\n"));
8341	parm.u.uint32 = VBOX_DRAG_AND_DROP_MODE_GUEST_TO_HOST;
8342	break;
8343	case DnDMode_HostToGuest:
8344	LogRel(("Changed drag'n drop mode to: Host to Guest\n"));
8345	parm.u.uint32 = VBOX_DRAG_AND_DROP_MODE_HOST_TO_GUEST;
8346	break;
8347	case DnDMode_Bidirectional:
8348	LogRel(("Changed drag'n drop mode to: Bidirectional\n"));
8349	parm.u.uint32 = VBOX_DRAG_AND_DROP_MODE_BIDIRECTIONAL;
8350	break;
8351	}
8352
8353	int rc = pVMMDev->hgcmHostCall("VBoxDragAndDropSvc",
8354	DragAndDropSvc::HOST_DND_SET_MODE, 1, &parm);
8355	LogFlowFunc(("rc=%Rrc\n", rc));
8356	return rc;
8357	}
8358
8359	#ifdef VBOX_WITH_USB
8360	/**
8361	* Sends a request to VMM to attach the given host device.
8362	* After this method succeeds, the attached device will appear in the
8363	* mUSBDevices collection.
8364	*
8365	* @param aHostDevice device to attach
8366	*
8367	* @note Synchronously calls EMT.
8368	*/
8369	HRESULT Console::i_attachUSBDevice(IUSBDevice *aHostDevice, ULONG aMaskedIfs)
8370	{
8371	AssertReturn(aHostDevice, E_FAIL);
8372	AssertReturn(!isWriteLockOnCurrentThread(), E_FAIL);
8373
8374	HRESULT hrc;
8375
8376	/*
8377	* Get the address and the Uuid, and call the pfnCreateProxyDevice roothub
8378	* method in EMT (using usbAttachCallback()).
8379	*/
8380	Bstr BstrAddress;
8381	hrc = aHostDevice->COMGETTER(Address)(BstrAddress.asOutParam());
8382	ComAssertComRCRetRC(hrc);
8383
8384	Utf8Str Address(BstrAddress);
8385
8386	Bstr id;
8387	hrc = aHostDevice->COMGETTER(Id)(id.asOutParam());
8388	ComAssertComRCRetRC(hrc);
8389	Guid uuid(id);
8390
8391	BOOL fRemote = FALSE;
8392	hrc = aHostDevice->COMGETTER(Remote)(&fRemote);
8393	ComAssertComRCRetRC(hrc);
8394
8395	/* Get the VM handle. */
8396	SafeVMPtr ptrVM(this);
8397	if (!ptrVM.isOk())
8398	return ptrVM.rc();
8399
8400	LogFlowThisFunc(("Proxying USB device '%s' {%RTuuid}...\n",
8401	Address.c_str(), uuid.raw()));
8402
8403	void *pvRemoteBackend = NULL;
8404	if (fRemote)
8405	{
8406	RemoteUSBDevice pRemoteUSBDevice = static_cast<RemoteUSBDevice >(aHostDevice);
8407	pvRemoteBackend = i_consoleVRDPServer()->USBBackendRequestPointer(pRemoteUSBDevice->clientId(), &uuid);
8408	if (!pvRemoteBackend)
8409	return E_INVALIDARG; /* The clientId is invalid then. */
8410	}
8411
8412	USHORT portVersion = 1;
8413	hrc = aHostDevice->COMGETTER(PortVersion)(&portVersion);
8414	AssertComRCReturnRC(hrc);
8415	Assert(portVersion == 1 \|\| portVersion == 2);
8416
8417	int vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), 0 /* idDstCpu (saved state, see #6232) */,
8418	(PFNRT)i_usbAttachCallback, 9,
8419	this, ptrVM.rawUVM(), aHostDevice, uuid.raw(), fRemote,
8420	Address.c_str(), pvRemoteBackend, portVersion, aMaskedIfs);
8421	if (RT_SUCCESS(vrc))
8422	{
8423	/* Create a OUSBDevice and add it to the device list */
8424	ComObjPtr<OUSBDevice> pUSBDevice;
8425	pUSBDevice.createObject();
8426	hrc = pUSBDevice->init(aHostDevice);
8427	AssertComRC(hrc);
8428
8429	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8430	mUSBDevices.push_back(pUSBDevice);
8431	LogFlowFunc(("Attached device {%RTuuid}\n", pUSBDevice->i_id().raw()));
8432
8433	/* notify callbacks */
8434	alock.release();
8435	i_onUSBDeviceStateChange(pUSBDevice, true /* aAttached */, NULL);
8436	}
8437	else
8438	{
8439	LogWarningThisFunc(("Failed to create proxy device for '%s' {%RTuuid} (%Rrc)\n",
8440	Address.c_str(), uuid.raw(), vrc));
8441
8442	switch (vrc)
8443	{
8444	case VERR_VUSB_NO_PORTS:
8445	hrc = setError(E_FAIL, tr("Failed to attach the USB device. (No available ports on the USB controller)."));
8446	break;
8447	case VERR_VUSB_USBFS_PERMISSION:
8448	hrc = setError(E_FAIL, tr("Not permitted to open the USB device, check usbfs options"));
8449	break;
8450	default:
8451	hrc = setError(E_FAIL, tr("Failed to create a proxy device for the USB device. (Error: %Rrc)"), vrc);
8452	break;
8453	}
8454	}
8455
8456	return hrc;
8457	}
8458
8459	/**
8460	* USB device attach callback used by AttachUSBDevice().
8461	* Note that AttachUSBDevice() doesn't return until this callback is executed,
8462	* so we don't use AutoCaller and don't care about reference counters of
8463	* interface pointers passed in.
8464	*
8465	* @thread EMT
8466	* @note Locks the console object for writing.
8467	*/
8468	//static
8469	DECLCALLBACK(int)
8470	Console::i_usbAttachCallback(Console that, PUVM pUVM, IUSBDevice aHostDevice, PCRTUUID aUuid, bool aRemote,
8471	const char aAddress, void pvRemoteBackend, USHORT aPortVersion, ULONG aMaskedIfs)
8472	{
8473	LogFlowFuncEnter();
8474	LogFlowFunc(("that={%p} aUuid={%RTuuid}\n", that, aUuid));
8475
8476	AssertReturn(that && aUuid, VERR_INVALID_PARAMETER);
8477	AssertReturn(!that->isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
8478
8479	int vrc = PDMR3UsbCreateProxyDevice(pUVM, aUuid, aRemote, aAddress, pvRemoteBackend,
8480	aPortVersion == 1 ? VUSB_STDVER_11 : VUSB_STDVER_20, aMaskedIfs);
8481	LogFlowFunc(("vrc=%Rrc\n", vrc));
8482	LogFlowFuncLeave();
8483	return vrc;
8484	}
8485
8486	/**
8487	* Sends a request to VMM to detach the given host device. After this method
8488	* succeeds, the detached device will disappear from the mUSBDevices
8489	* collection.
8490	*
8491	* @param aHostDevice device to attach
8492	*
8493	* @note Synchronously calls EMT.
8494	*/
8495	HRESULT Console::i_detachUSBDevice(const ComObjPtr<OUSBDevice> &aHostDevice)
8496	{
8497	AssertReturn(!isWriteLockOnCurrentThread(), E_FAIL);
8498
8499	/* Get the VM handle. */
8500	SafeVMPtr ptrVM(this);
8501	if (!ptrVM.isOk())
8502	return ptrVM.rc();
8503
8504	/* if the device is attached, then there must at least one USB hub. */
8505	AssertReturn(PDMR3UsbHasHub(ptrVM.rawUVM()), E_FAIL);
8506
8507	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8508	LogFlowThisFunc(("Detaching USB proxy device {%RTuuid}...\n",
8509	aHostDevice->i_id().raw()));
8510
8511	/*
8512	* If this was a remote device, release the backend pointer.
8513	* The pointer was requested in usbAttachCallback.
8514	*/
8515	BOOL fRemote = FALSE;
8516
8517	HRESULT hrc2 = aHostDevice->COMGETTER(Remote)(&fRemote);
8518	if (FAILED(hrc2))
8519	i_setErrorStatic(hrc2, "GetRemote() failed");
8520
8521	PCRTUUID pUuid = aHostDevice->i_id().raw();
8522	if (fRemote)
8523	{
8524	Guid guid(*pUuid);
8525	i_consoleVRDPServer()->USBBackendReleasePointer(&guid);
8526	}
8527
8528	alock.release();
8529	int vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), 0 /* idDstCpu (saved state, see #6232) */,
8530	(PFNRT)i_usbDetachCallback, 5,
8531	this, ptrVM.rawUVM(), pUuid);
8532	if (RT_SUCCESS(vrc))
8533	{
8534	LogFlowFunc(("Detached device {%RTuuid}\n", pUuid));
8535
8536	/* notify callbacks */
8537	i_onUSBDeviceStateChange(aHostDevice, false /* aAttached */, NULL);
8538	}
8539
8540	ComAssertRCRet(vrc, E_FAIL);
8541
8542	return S_OK;
8543	}
8544
8545	/**
8546	* USB device detach callback used by DetachUSBDevice().
8547	*
8548	* Note that DetachUSBDevice() doesn't return until this callback is executed,
8549	* so we don't use AutoCaller and don't care about reference counters of
8550	* interface pointers passed in.
8551	*
8552	* @thread EMT
8553	*/
8554	//static
8555	DECLCALLBACK(int)
8556	Console::i_usbDetachCallback(Console *that, PUVM pUVM, PCRTUUID aUuid)
8557	{
8558	LogFlowFuncEnter();
8559	LogFlowFunc(("that={%p} aUuid={%RTuuid}\n", that, aUuid));
8560
8561	AssertReturn(that && aUuid, VERR_INVALID_PARAMETER);
8562	AssertReturn(!that->isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
8563
8564	int vrc = PDMR3UsbDetachDevice(pUVM, aUuid);
8565
8566	LogFlowFunc(("vrc=%Rrc\n", vrc));
8567	LogFlowFuncLeave();
8568	return vrc;
8569	}
8570	#endif /* VBOX_WITH_USB */
8571
8572	/* Note: FreeBSD needs this whether netflt is used or not. */
8573	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
8574	/**
8575	* Helper function to handle host interface device creation and attachment.
8576	*
8577	* @param networkAdapter the network adapter which attachment should be reset
8578	* @return COM status code
8579	*
8580	* @note The caller must lock this object for writing.
8581	*
8582	* @todo Move this back into the driver!
8583	*/
8584	HRESULT Console::i_attachToTapInterface(INetworkAdapter *networkAdapter)
8585	{
8586	LogFlowThisFunc(("\n"));
8587	/* sanity check */
8588	AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
8589
8590	# ifdef VBOX_STRICT
8591	/* paranoia */
8592	NetworkAttachmentType_T attachment;
8593	networkAdapter->COMGETTER(AttachmentType)(&attachment);
8594	Assert(attachment == NetworkAttachmentType_Bridged);
8595	# endif /* VBOX_STRICT */
8596
8597	HRESULT rc = S_OK;
8598
8599	ULONG slot = 0;
8600	rc = networkAdapter->COMGETTER(Slot)(&slot);
8601	AssertComRC(rc);
8602
8603	# ifdef RT_OS_LINUX
8604	/*
8605	* Allocate a host interface device
8606	*/
8607	int rcVBox = RTFileOpen(&maTapFD[slot], "/dev/net/tun",
8608	RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE \| RTFILE_O_INHERIT);
8609	if (RT_SUCCESS(rcVBox))
8610	{
8611	/*
8612	* Set/obtain the tap interface.
8613	*/
8614	struct ifreq IfReq;
8615	RT_ZERO(IfReq);
8616	/* The name of the TAP interface we are using */
8617	Bstr tapDeviceName;
8618	rc = networkAdapter->COMGETTER(BridgedInterface)(tapDeviceName.asOutParam());
8619	if (FAILED(rc))
8620	tapDeviceName.setNull(); /* Is this necessary? */
8621	if (tapDeviceName.isEmpty())
8622	{
8623	LogRel(("No TAP device name was supplied.\n"));
8624	rc = setError(E_FAIL, tr("No TAP device name was supplied for the host networking interface"));
8625	}
8626
8627	if (SUCCEEDED(rc))
8628	{
8629	/* If we are using a static TAP device then try to open it. */
8630	Utf8Str str(tapDeviceName);
8631	RTStrCopy(IfReq.ifr_name, sizeof(IfReq.ifr_name), str.c_str()); /** @todo bitch about names which are too long... */
8632	IfReq.ifr_flags = IFF_TAP \| IFF_NO_PI;
8633	rcVBox = ioctl(RTFileToNative(maTapFD[slot]), TUNSETIFF, &IfReq);
8634	if (rcVBox != 0)
8635	{
8636	LogRel(("Failed to open the host network interface %ls\n", tapDeviceName.raw()));
8637	rc = setError(E_FAIL,
8638	tr("Failed to open the host network interface %ls"),
8639	tapDeviceName.raw());
8640	}
8641	}
8642	if (SUCCEEDED(rc))
8643	{
8644	/*
8645	* Make it pollable.
8646	*/
8647	if (fcntl(RTFileToNative(maTapFD[slot]), F_SETFL, O_NONBLOCK) != -1)
8648	{
8649	Log(("i_attachToTapInterface: %RTfile %ls\n", maTapFD[slot], tapDeviceName.raw()));
8650	/*
8651	* Here is the right place to communicate the TAP file descriptor and
8652	* the host interface name to the server if/when it becomes really
8653	* necessary.
8654	*/
8655	maTAPDeviceName[slot] = tapDeviceName;
8656	rcVBox = VINF_SUCCESS;
8657	}
8658	else
8659	{
8660	int iErr = errno;
8661
8662	LogRel(("Configuration error: Failed to configure /dev/net/tun non blocking. Error: %s\n", strerror(iErr)));
8663	rcVBox = VERR_HOSTIF_BLOCKING;
8664	rc = setError(E_FAIL,
8665	tr("could not set up the host networking device for non blocking access: %s"),
8666	strerror(errno));
8667	}
8668	}
8669	}
8670	else
8671	{
8672	LogRel(("Configuration error: Failed to open /dev/net/tun rc=%Rrc\n", rcVBox));
8673	switch (rcVBox)
8674	{
8675	case VERR_ACCESS_DENIED:
8676	/* will be handled by our caller */
8677	rc = rcVBox;
8678	break;
8679	default:
8680	rc = setError(E_FAIL,
8681	tr("Could not set up the host networking device: %Rrc"),
8682	rcVBox);
8683	break;
8684	}
8685	}
8686
8687	# elif defined(RT_OS_FREEBSD)
8688	/*
8689	* Set/obtain the tap interface.
8690	*/
8691	/* The name of the TAP interface we are using */
8692	Bstr tapDeviceName;
8693	rc = networkAdapter->COMGETTER(BridgedInterface)(tapDeviceName.asOutParam());
8694	if (FAILED(rc))
8695	tapDeviceName.setNull(); /* Is this necessary? */
8696	if (tapDeviceName.isEmpty())
8697	{
8698	LogRel(("No TAP device name was supplied.\n"));
8699	rc = setError(E_FAIL, tr("No TAP device name was supplied for the host networking interface"));
8700	}
8701	char szTapdev[1024] = "/dev/";
8702	/* If we are using a static TAP device then try to open it. */
8703	Utf8Str str(tapDeviceName);
8704	if (str.length() + strlen(szTapdev) <= sizeof(szTapdev))
8705	strcat(szTapdev, str.c_str());
8706	else
8707	memcpy(szTapdev + strlen(szTapdev), str.c_str(),
8708	sizeof(szTapdev) - strlen(szTapdev) - 1); /** @todo bitch about names which are too long... */
8709	int rcVBox = RTFileOpen(&maTapFD[slot], szTapdev,
8710	RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE \| RTFILE_O_INHERIT \| RTFILE_O_NON_BLOCK);
8711
8712	if (RT_SUCCESS(rcVBox))
8713	maTAPDeviceName[slot] = tapDeviceName;
8714	else
8715	{
8716	switch (rcVBox)
8717	{
8718	case VERR_ACCESS_DENIED:
8719	/* will be handled by our caller */
8720	rc = rcVBox;
8721	break;
8722	default:
8723	rc = setError(E_FAIL,
8724	tr("Failed to open the host network interface %ls"),
8725	tapDeviceName.raw());
8726	break;
8727	}
8728	}
8729	# else
8730	# error "huh?"
8731	# endif
8732	/* in case of failure, cleanup. */
8733	if (RT_FAILURE(rcVBox) && SUCCEEDED(rc))
8734	{
8735	LogRel(("General failure attaching to host interface\n"));
8736	rc = setError(E_FAIL,
8737	tr("General failure attaching to host interface"));
8738	}
8739	LogFlowThisFunc(("rc=%d\n", rc));
8740	return rc;
8741	}
8742
8743
8744	/**
8745	* Helper function to handle detachment from a host interface
8746	*
8747	* @param networkAdapter the network adapter which attachment should be reset
8748	* @return COM status code
8749	*
8750	* @note The caller must lock this object for writing.
8751	*
8752	* @todo Move this back into the driver!
8753	*/
8754	HRESULT Console::i_detachFromTapInterface(INetworkAdapter *networkAdapter)
8755	{
8756	/* sanity check */
8757	LogFlowThisFunc(("\n"));
8758	AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
8759
8760	HRESULT rc = S_OK;
8761	# ifdef VBOX_STRICT
8762	/* paranoia */
8763	NetworkAttachmentType_T attachment;
8764	networkAdapter->COMGETTER(AttachmentType)(&attachment);
8765	Assert(attachment == NetworkAttachmentType_Bridged);
8766	# endif /* VBOX_STRICT */
8767
8768	ULONG slot = 0;
8769	rc = networkAdapter->COMGETTER(Slot)(&slot);
8770	AssertComRC(rc);
8771
8772	/* is there an open TAP device? */
8773	if (maTapFD[slot] != NIL_RTFILE)
8774	{
8775	/*
8776	* Close the file handle.
8777	*/
8778	Bstr tapDeviceName, tapTerminateApplication;
8779	bool isStatic = true;
8780	rc = networkAdapter->COMGETTER(BridgedInterface)(tapDeviceName.asOutParam());
8781	if (FAILED(rc) \|\| tapDeviceName.isEmpty())
8782	{
8783	/* If the name is empty, this is a dynamic TAP device, so close it now,
8784	so that the termination script can remove the interface. Otherwise we still
8785	need the FD to pass to the termination script. */
8786	isStatic = false;
8787	int rcVBox = RTFileClose(maTapFD[slot]);
8788	AssertRC(rcVBox);
8789	maTapFD[slot] = NIL_RTFILE;
8790	}
8791	if (isStatic)
8792	{
8793	/* If we are using a static TAP device, we close it now, after having called the
8794	termination script. */
8795	int rcVBox = RTFileClose(maTapFD[slot]);
8796	AssertRC(rcVBox);
8797	}
8798	/* the TAP device name and handle are no longer valid */
8799	maTapFD[slot] = NIL_RTFILE;
8800	maTAPDeviceName[slot] = "";
8801	}
8802	LogFlowThisFunc(("returning %d\n", rc));
8803	return rc;
8804	}
8805	#endif /* (RT_OS_LINUX \|\| RT_OS_FREEBSD) && !VBOX_WITH_NETFLT */
8806
8807	/**
8808	* Called at power down to terminate host interface networking.
8809	*
8810	* @note The caller must lock this object for writing.
8811	*/
8812	HRESULT Console::i_powerDownHostInterfaces()
8813	{
8814	LogFlowThisFunc(("\n"));
8815
8816	/* sanity check */
8817	AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
8818
8819	/*
8820	* host interface termination handling
8821	*/
8822	HRESULT rc = S_OK;
8823	ComPtr<IVirtualBox> pVirtualBox;
8824	mMachine->COMGETTER(Parent)(pVirtualBox.asOutParam());
8825	ComPtr<ISystemProperties> pSystemProperties;
8826	if (pVirtualBox)
8827	pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
8828	ChipsetType_T chipsetType = ChipsetType_PIIX3;
8829	mMachine->COMGETTER(ChipsetType)(&chipsetType);
8830	ULONG maxNetworkAdapters = 0;
8831	if (pSystemProperties)
8832	pSystemProperties->GetMaxNetworkAdapters(chipsetType, &maxNetworkAdapters);
8833
8834	for (ULONG slot = 0; slot < maxNetworkAdapters; slot++)
8835	{
8836	ComPtr<INetworkAdapter> pNetworkAdapter;
8837	rc = mMachine->GetNetworkAdapter(slot, pNetworkAdapter.asOutParam());
8838	if (FAILED(rc)) break;
8839
8840	BOOL enabled = FALSE;
8841	pNetworkAdapter->COMGETTER(Enabled)(&enabled);
8842	if (!enabled)
8843	continue;
8844
8845	NetworkAttachmentType_T attachment;
8846	pNetworkAdapter->COMGETTER(AttachmentType)(&attachment);
8847	if (attachment == NetworkAttachmentType_Bridged)
8848	{
8849	#if ((defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD)) && !defined(VBOX_WITH_NETFLT))
8850	HRESULT rc2 = i_detachFromTapInterface(pNetworkAdapter);
8851	if (FAILED(rc2) && SUCCEEDED(rc))
8852	rc = rc2;
8853	#endif /* (RT_OS_LINUX \|\| RT_OS_FREEBSD) && !VBOX_WITH_NETFLT */
8854	}
8855	}
8856
8857	return rc;
8858	}
8859
8860
8861	/**
8862	* Process callback handler for VMR3LoadFromFile, VMR3LoadFromStream, VMR3Save
8863	* and VMR3Teleport.
8864	*
8865	* @param pUVM The user mode VM handle.
8866	* @param uPercent Completion percentage (0-100).
8867	* @param pvUser Pointer to an IProgress instance.
8868	* @return VINF_SUCCESS.
8869	*/
8870	/static/
8871	DECLCALLBACK(int) Console::i_stateProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser)
8872	{
8873	IProgress pProgress = static_cast<IProgress >(pvUser);
8874
8875	/* update the progress object */
8876	if (pProgress)
8877	pProgress->SetCurrentOperationProgress(uPercent);
8878
8879	NOREF(pUVM);
8880	return VINF_SUCCESS;
8881	}
8882
8883	/**
8884	* @copydoc FNVMATERROR
8885	*
8886	* @remarks Might be some tiny serialization concerns with access to the string
8887	* object here...
8888	*/
8889	/static/ DECLCALLBACK(void)
8890	Console::i_genericVMSetErrorCallback(PUVM pUVM, void *pvUser, int rc, RT_SRC_POS_DECL,
8891	const char *pszErrorFmt, va_list va)
8892	{
8893	Utf8Str pErrorText = (Utf8Str )pvUser;
8894	AssertPtr(pErrorText);
8895
8896	/* We ignore RT_SRC_POS_DECL arguments to avoid confusion of end-users. */
8897	va_list va2;
8898	va_copy(va2, va);
8899
8900	/* Append to any the existing error message. */
8901	if (pErrorText->length())
8902	*pErrorText = Utf8StrFmt("%s.\n%N (%Rrc)", pErrorText->c_str(),
8903	pszErrorFmt, &va2, rc, rc);
8904	else
8905	*pErrorText = Utf8StrFmt("%N (%Rrc)", pszErrorFmt, &va2, rc, rc);
8906
8907	va_end(va2);
8908
8909	NOREF(pUVM);
8910	}
8911
8912	/**
8913	* VM runtime error callback function.
8914	* See VMSetRuntimeError for the detailed description of parameters.
8915	*
8916	* @param pUVM The user mode VM handle. Ignored, so passing NULL
8917	* is fine.
8918	* @param pvUser The user argument, pointer to the Console instance.
8919	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
8920	* @param pszErrorId Error ID string.
8921	* @param pszFormat Error message format string.
8922	* @param va Error message arguments.
8923	* @thread EMT.
8924	*/
8925	/* static */ DECLCALLBACK(void)
8926	Console::i_setVMRuntimeErrorCallback(PUVM pUVM, void *pvUser, uint32_t fFlags,
8927	const char *pszErrorId,
8928	const char *pszFormat, va_list va)
8929	{
8930	bool const fFatal = !!(fFlags & VMSETRTERR_FLAGS_FATAL);
8931	LogFlowFuncEnter();
8932
8933	Console that = static_cast<Console >(pvUser);
8934	AssertReturnVoid(that);
8935
8936	Utf8Str message(pszFormat, va);
8937
8938	LogRel(("Console: VM runtime error: fatal=%RTbool, errorID=%s message=\"%s\"\n",
8939	fFatal, pszErrorId, message.c_str()));
8940
8941	/* Set guest property if the reason of the error is a missing DEK for a disk. */
8942	if (!RTStrCmp(pszErrorId, "DrvVD_DEKMISSING"))
8943	{
8944	that->mMachine->DeleteGuestProperty(Bstr("/VirtualBox/HostInfo/DekMissing").raw());
8945	that->mMachine->SetGuestProperty(Bstr("/VirtualBox/HostInfo/DekMissing").raw(),
8946	Bstr("1").raw(), Bstr("RDONLYGUEST").raw());
8947	that->mMachine->SaveSettings();
8948	}
8949
8950
8951	that->i_onRuntimeError(BOOL(fFatal), Bstr(pszErrorId).raw(), Bstr(message).raw());
8952
8953	LogFlowFuncLeave(); NOREF(pUVM);
8954	}
8955
8956	/**
8957	* Captures USB devices that match filters of the VM.
8958	* Called at VM startup.
8959	*
8960	* @param pUVM The VM handle.
8961	*/
8962	HRESULT Console::i_captureUSBDevices(PUVM pUVM)
8963	{
8964	LogFlowThisFunc(("\n"));
8965
8966	/* sanity check */
8967	AssertReturn(!isWriteLockOnCurrentThread(), E_FAIL);
8968	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8969
8970	/* If the machine has a USB controller, ask the USB proxy service to
8971	* capture devices */
8972	if (mfVMHasUsbController)
8973	{
8974	/* release the lock before calling Host in VBoxSVC since Host may call
8975	* us back from under its lock (e.g. onUSBDeviceAttach()) which would
8976	* produce an inter-process dead-lock otherwise. */
8977	alock.release();
8978
8979	HRESULT hrc = mControl->AutoCaptureUSBDevices();
8980	ComAssertComRCRetRC(hrc);
8981	}
8982
8983	return S_OK;
8984	}
8985
8986
8987	/**
8988	* Detach all USB device which are attached to the VM for the
8989	* purpose of clean up and such like.
8990	*/
8991	void Console::i_detachAllUSBDevices(bool aDone)
8992	{
8993	LogFlowThisFunc(("aDone=%RTbool\n", aDone));
8994
8995	/* sanity check */
8996	AssertReturnVoid(!isWriteLockOnCurrentThread());
8997	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8998
8999	mUSBDevices.clear();
9000
9001	/* release the lock before calling Host in VBoxSVC since Host may call
9002	* us back from under its lock (e.g. onUSBDeviceAttach()) which would
9003	* produce an inter-process dead-lock otherwise. */
9004	alock.release();
9005
9006	mControl->DetachAllUSBDevices(aDone);
9007	}
9008
9009	/**
9010	* @note Locks this object for writing.
9011	*/
9012	void Console::i_processRemoteUSBDevices(uint32_t u32ClientId, VRDEUSBDEVICEDESC *pDevList, uint32_t cbDevList, bool fDescExt)
9013	{
9014	LogFlowThisFuncEnter();
9015	LogFlowThisFunc(("u32ClientId = %d, pDevList=%p, cbDevList = %d, fDescExt = %d\n",
9016	u32ClientId, pDevList, cbDevList, fDescExt));
9017
9018	AutoCaller autoCaller(this);
9019	if (!autoCaller.isOk())
9020	{
9021	/* Console has been already uninitialized, deny request */
9022	AssertMsgFailed(("Console is already uninitialized\n"));
9023	LogFlowThisFunc(("Console is already uninitialized\n"));
9024	LogFlowThisFuncLeave();
9025	return;
9026	}
9027
9028	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
9029
9030	/*
9031	* Mark all existing remote USB devices as dirty.
9032	*/
9033	for (RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
9034	it != mRemoteUSBDevices.end();
9035	++it)
9036	{
9037	(*it)->dirty(true);
9038	}
9039
9040	/*
9041	* Process the pDevList and add devices those are not already in the mRemoteUSBDevices list.
9042	*/
9043	/** @todo (sunlover) REMOTE_USB Strict validation of the pDevList. */
9044	VRDEUSBDEVICEDESC *e = pDevList;
9045
9046	/* The cbDevList condition must be checked first, because the function can
9047	* receive pDevList = NULL and cbDevList = 0 on client disconnect.
9048	*/
9049	while (cbDevList >= 2 && e->oNext)
9050	{
9051	/* Sanitize incoming strings in case they aren't valid UTF-8. */
9052	if (e->oManufacturer)
9053	RTStrPurgeEncoding((char *)e + e->oManufacturer);
9054	if (e->oProduct)
9055	RTStrPurgeEncoding((char *)e + e->oProduct);
9056	if (e->oSerialNumber)
9057	RTStrPurgeEncoding((char *)e + e->oSerialNumber);
9058
9059	LogFlowThisFunc(("vendor %04X, product %04X, name = %s\n",
9060	e->idVendor, e->idProduct,
9061	e->oProduct? (char *)e + e->oProduct: ""));
9062
9063	bool fNewDevice = true;
9064
9065	for (RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
9066	it != mRemoteUSBDevices.end();
9067	++it)
9068	{
9069	if ((*it)->devId() == e->id
9070	&& (*it)->clientId() == u32ClientId)
9071	{
9072	/* The device is already in the list. */
9073	(*it)->dirty(false);
9074	fNewDevice = false;
9075	break;
9076	}
9077	}
9078
9079	if (fNewDevice)
9080	{
9081	LogRel(("Remote USB: ++++ Vendor %04X. Product %04X. Name = [%s].\n",
9082	e->idVendor, e->idProduct, e->oProduct? (char *)e + e->oProduct: ""));
9083
9084	/* Create the device object and add the new device to list. */
9085	ComObjPtr<RemoteUSBDevice> pUSBDevice;
9086	pUSBDevice.createObject();
9087	pUSBDevice->init(u32ClientId, e, fDescExt);
9088
9089	mRemoteUSBDevices.push_back(pUSBDevice);
9090
9091	/* Check if the device is ok for current USB filters. */
9092	BOOL fMatched = FALSE;
9093	ULONG fMaskedIfs = 0;
9094
9095	HRESULT hrc = mControl->RunUSBDeviceFilters(pUSBDevice, &fMatched, &fMaskedIfs);
9096
9097	AssertComRC(hrc);
9098
9099	LogFlowThisFunc(("USB filters return %d %#x\n", fMatched, fMaskedIfs));
9100
9101	if (fMatched)
9102	{
9103	alock.release();
9104	hrc = i_onUSBDeviceAttach(pUSBDevice, NULL, fMaskedIfs);
9105	alock.acquire();
9106
9107	/// @todo (r=dmik) warning reporting subsystem
9108
9109	if (hrc == S_OK)
9110	{
9111	LogFlowThisFunc(("Device attached\n"));
9112	pUSBDevice->captured(true);
9113	}
9114	}
9115	}
9116
9117	if (cbDevList < e->oNext)
9118	{
9119	LogWarningThisFunc(("cbDevList %d > oNext %d\n",
9120	cbDevList, e->oNext));
9121	break;
9122	}
9123
9124	cbDevList -= e->oNext;
9125
9126	e = (VRDEUSBDEVICEDESC )((uint8_t )e + e->oNext);
9127	}
9128
9129	/*
9130	* Remove dirty devices, that is those which are not reported by the server anymore.
9131	*/
9132	for (;;)
9133	{
9134	ComObjPtr<RemoteUSBDevice> pUSBDevice;
9135
9136	RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
9137	while (it != mRemoteUSBDevices.end())
9138	{
9139	if ((*it)->dirty())
9140	{
9141	pUSBDevice = *it;
9142	break;
9143	}
9144
9145	++it;
9146	}
9147
9148	if (!pUSBDevice)
9149	{
9150	break;
9151	}
9152
9153	USHORT vendorId = 0;
9154	pUSBDevice->COMGETTER(VendorId)(&vendorId);
9155
9156	USHORT productId = 0;
9157	pUSBDevice->COMGETTER(ProductId)(&productId);
9158
9159	Bstr product;
9160	pUSBDevice->COMGETTER(Product)(product.asOutParam());
9161
9162	LogRel(("Remote USB: ---- Vendor %04X. Product %04X. Name = [%ls].\n",
9163	vendorId, productId, product.raw()));
9164
9165	/* Detach the device from VM. */
9166	if (pUSBDevice->captured())
9167	{
9168	Bstr uuid;
9169	pUSBDevice->COMGETTER(Id)(uuid.asOutParam());
9170	alock.release();
9171	i_onUSBDeviceDetach(uuid.raw(), NULL);
9172	alock.acquire();
9173	}
9174
9175	/* And remove it from the list. */
9176	mRemoteUSBDevices.erase(it);
9177	}
9178
9179	LogFlowThisFuncLeave();
9180	}
9181
9182	/**
9183	* Progress cancelation callback for fault tolerance VM poweron
9184	*/
9185	static void faultToleranceProgressCancelCallback(void *pvUser)
9186	{
9187	PUVM pUVM = (PUVM)pvUser;
9188
9189	if (pUVM)
9190	FTMR3CancelStandby(pUVM);
9191	}
9192
9193	/**
9194	* Thread function which starts the VM (also from saved state) and
9195	* track progress.
9196	*
9197	* @param Thread The thread id.
9198	* @param pvUser Pointer to a VMPowerUpTask structure.
9199	* @return VINF_SUCCESS (ignored).
9200	*
9201	* @note Locks the Console object for writing.
9202	*/
9203	/static/
9204	DECLCALLBACK(int) Console::i_powerUpThread(RTTHREAD Thread, void *pvUser)
9205	{
9206	LogFlowFuncEnter();
9207
9208	std::auto_ptr<VMPowerUpTask> task(static_cast<VMPowerUpTask *>(pvUser));
9209	AssertReturn(task.get(), VERR_INVALID_PARAMETER);
9210
9211	AssertReturn(!task->mConsole.isNull(), VERR_INVALID_PARAMETER);
9212	AssertReturn(!task->mProgress.isNull(), VERR_INVALID_PARAMETER);
9213
9214	VirtualBoxBase::initializeComForThread();
9215
9216	HRESULT rc = S_OK;
9217	int vrc = VINF_SUCCESS;
9218
9219	/* Set up a build identifier so that it can be seen from core dumps what
9220	* exact build was used to produce the core. */
9221	static char saBuildID[40];
9222	RTStrPrintf(saBuildID, sizeof(saBuildID), "%s%s%s%s VirtualBox %s r%u %s%s%s%s",
9223	"BU", "IL", "DI", "D", RTBldCfgVersion(), RTBldCfgRevision(), "BU", "IL", "DI", "D");
9224
9225	ComObjPtr<Console> pConsole = task->mConsole;
9226
9227	/* Note: no need to use addCaller() because VMPowerUpTask does that */
9228
9229	/* The lock is also used as a signal from the task initiator (which
9230	* releases it only after RTThreadCreate()) that we can start the job */
9231	AutoWriteLock alock(pConsole COMMA_LOCKVAL_SRC_POS);
9232
9233	/* sanity */
9234	Assert(pConsole->mpUVM == NULL);
9235
9236	try
9237	{
9238	// Create the VMM device object, which starts the HGCM thread; do this only
9239	// once for the console, for the pathological case that the same console
9240	// object is used to power up a VM twice. VirtualBox 4.0: we now do that
9241	// here instead of the Console constructor (see Console::init())
9242	if (!pConsole->m_pVMMDev)
9243	{
9244	pConsole->m_pVMMDev = new VMMDev(pConsole);
9245	AssertReturn(pConsole->m_pVMMDev, E_FAIL);
9246	}
9247
9248	/* wait for auto reset ops to complete so that we can successfully lock
9249	* the attached hard disks by calling LockMedia() below */
9250	for (VMPowerUpTask::ProgressList::const_iterator
9251	it = task->hardDiskProgresses.begin();
9252	it != task->hardDiskProgresses.end(); ++it)
9253	{
9254	HRESULT rc2 = (*it)->WaitForCompletion(-1);
9255	AssertComRC(rc2);
9256
9257	rc = task->mProgress->SetNextOperation(BstrFmt(tr("Disk Image Reset Operation - Immutable Image")).raw(), 1);
9258	AssertComRCReturnRC(rc);
9259	}
9260
9261	/*
9262	* Lock attached media. This method will also check their accessibility.
9263	* If we're a teleporter, we'll have to postpone this action so we can
9264	* migrate between local processes.
9265	*
9266	* Note! The media will be unlocked automatically by
9267	* SessionMachine::i_setMachineState() when the VM is powered down.
9268	*/
9269	if ( !task->mTeleporterEnabled
9270	&& task->mEnmFaultToleranceState != FaultToleranceState_Standby)
9271	{
9272	rc = pConsole->mControl->LockMedia();
9273	if (FAILED(rc)) throw rc;
9274	}
9275
9276	/* Create the VRDP server. In case of headless operation, this will
9277	* also create the framebuffer, required at VM creation.
9278	*/
9279	ConsoleVRDPServer *server = pConsole->i_consoleVRDPServer();
9280	Assert(server);
9281
9282	/* Does VRDP server call Console from the other thread?
9283	* Not sure (and can change), so release the lock just in case.
9284	*/
9285	alock.release();
9286	vrc = server->Launch();
9287	alock.acquire();
9288
9289	if (vrc == VERR_NET_ADDRESS_IN_USE)
9290	{
9291	Utf8Str errMsg;
9292	Bstr bstr;
9293	pConsole->mVRDEServer->GetVRDEProperty(Bstr("TCP/Ports").raw(), bstr.asOutParam());
9294	Utf8Str ports = bstr;
9295	errMsg = Utf8StrFmt(tr("VirtualBox Remote Desktop Extension server can't bind to the port: %s"),
9296	ports.c_str());
9297	LogRel(("VRDE: Warning: failed to launch VRDE server (%Rrc): '%s'\n",
9298	vrc, errMsg.c_str()));
9299	}
9300	else if (vrc == VINF_NOT_SUPPORTED)
9301	{
9302	/* This means that the VRDE is not installed. */
9303	LogRel(("VRDE: VirtualBox Remote Desktop Extension is not available.\n"));
9304	}
9305	else if (RT_FAILURE(vrc))
9306	{
9307	/* Fail, if the server is installed but can't start. */
9308	Utf8Str errMsg;
9309	switch (vrc)
9310	{
9311	case VERR_FILE_NOT_FOUND:
9312	{
9313	/* VRDE library file is missing. */
9314	errMsg = Utf8StrFmt(tr("Could not find the VirtualBox Remote Desktop Extension library."));
9315	break;
9316	}
9317	default:
9318	errMsg = Utf8StrFmt(tr("Failed to launch Remote Desktop Extension server (%Rrc)"),
9319	vrc);
9320	}
9321	LogRel(("VRDE: Failed: (%Rrc), error message: '%s'\n",
9322	vrc, errMsg.c_str()));
9323	throw i_setErrorStatic(E_FAIL, errMsg.c_str());
9324	}
9325
9326	ComPtr<IMachine> pMachine = pConsole->i_machine();
9327	ULONG cCpus = 1;
9328	pMachine->COMGETTER(CPUCount)(&cCpus);
9329
9330	/*
9331	* Create the VM
9332	*
9333	* Note! Release the lock since EMT will call Console. It's safe because
9334	* mMachineState is either Starting or Restoring state here.
9335	*/
9336	alock.release();
9337
9338	PVM pVM;
9339	vrc = VMR3Create(cCpus,
9340	pConsole->mpVmm2UserMethods,
9341	Console::i_genericVMSetErrorCallback,
9342	&task->mErrorMsg,
9343	task->mConfigConstructor,
9344	static_cast<Console *>(pConsole),
9345	&pVM, NULL);
9346
9347	alock.acquire();
9348
9349	/* Enable client connections to the server. */
9350	pConsole->i_consoleVRDPServer()->EnableConnections();
9351
9352	if (RT_SUCCESS(vrc))
9353	{
9354	do
9355	{
9356	/*
9357	* Register our load/save state file handlers
9358	*/
9359	vrc = SSMR3RegisterExternal(pConsole->mpUVM, sSSMConsoleUnit, 0 /iInstance/, sSSMConsoleVer, 0 /* cbGuess */,
9360	NULL, NULL, NULL,
9361	NULL, i_saveStateFileExec, NULL,
9362	NULL, i_loadStateFileExec, NULL,
9363	static_cast<Console *>(pConsole));
9364	AssertRCBreak(vrc);
9365
9366	vrc = static_cast<Console *>(pConsole)->i_getDisplay()->registerSSM(pConsole->mpUVM);
9367	AssertRC(vrc);
9368	if (RT_FAILURE(vrc))
9369	break;
9370
9371	/*
9372	* Synchronize debugger settings
9373	*/
9374	MachineDebugger *machineDebugger = pConsole->i_getMachineDebugger();
9375	if (machineDebugger)
9376	machineDebugger->i_flushQueuedSettings();
9377
9378	/*
9379	* Shared Folders
9380	*/
9381	if (pConsole->m_pVMMDev->isShFlActive())
9382	{
9383	/* Does the code below call Console from the other thread?
9384	* Not sure, so release the lock just in case. */
9385	alock.release();
9386
9387	for (SharedFolderDataMap::const_iterator it = task->mSharedFolders.begin();
9388	it != task->mSharedFolders.end();
9389	++it)
9390	{
9391	const SharedFolderData &d = it->second;
9392	rc = pConsole->i_createSharedFolder(it->first, d);
9393	if (FAILED(rc))
9394	{
9395	ErrorInfoKeeper eik;
9396	pConsole->i_setVMRuntimeErrorCallbackF(0, "BrokenSharedFolder",
9397	N_("The shared folder '%s' could not be set up: %ls.\n"
9398	"The shared folder setup will not be complete. It is recommended to power down the virtual "
9399	"machine and fix the shared folder settings while the machine is not running"),
9400	it->first.c_str(), eik.getText().raw());
9401	}
9402	}
9403	if (FAILED(rc))
9404	rc = S_OK; // do not fail with broken shared folders
9405
9406	/* acquire the lock again */
9407	alock.acquire();
9408	}
9409
9410	/* release the lock before a lengthy operation */
9411	alock.release();
9412
9413	/*
9414	* Capture USB devices.
9415	*/
9416	rc = pConsole->i_captureUSBDevices(pConsole->mpUVM);
9417	if (FAILED(rc))
9418	break;
9419
9420	/* Load saved state? */
9421	if (task->mSavedStateFile.length())
9422	{
9423	LogFlowFunc(("Restoring saved state from '%s'...\n",
9424	task->mSavedStateFile.c_str()));
9425
9426	vrc = VMR3LoadFromFile(pConsole->mpUVM,
9427	task->mSavedStateFile.c_str(),
9428	Console::i_stateProgressCallback,
9429	static_cast<IProgress *>(task->mProgress));
9430
9431	if (RT_SUCCESS(vrc))
9432	{
9433	if (task->mStartPaused)
9434	/* done */
9435	pConsole->i_setMachineState(MachineState_Paused);
9436	else
9437	{
9438	/* Start/Resume the VM execution */
9439	#ifdef VBOX_WITH_EXTPACK
9440	vrc = pConsole->mptrExtPackManager->i_callAllVmPowerOnHooks(pConsole, pVM);
9441	#endif
9442	if (RT_SUCCESS(vrc))
9443	vrc = VMR3Resume(pConsole->mpUVM, VMRESUMEREASON_STATE_RESTORED);
9444	AssertLogRelRC(vrc);
9445	}
9446	}
9447
9448	/* Power off in case we failed loading or resuming the VM */
9449	if (RT_FAILURE(vrc))
9450	{
9451	int vrc2 = VMR3PowerOff(pConsole->mpUVM); AssertLogRelRC(vrc2);
9452	#ifdef VBOX_WITH_EXTPACK
9453	pConsole->mptrExtPackManager->i_callAllVmPowerOffHooks(pConsole, pVM);
9454	#endif
9455	}
9456	}
9457	else if (task->mTeleporterEnabled)
9458	{
9459	/* -> ConsoleImplTeleporter.cpp */
9460	bool fPowerOffOnFailure;
9461	rc = pConsole->i_teleporterTrg(pConsole->mpUVM, pMachine, &task->mErrorMsg, task->mStartPaused,
9462	task->mProgress, &fPowerOffOnFailure);
9463	if (FAILED(rc) && fPowerOffOnFailure)
9464	{
9465	ErrorInfoKeeper eik;
9466	int vrc2 = VMR3PowerOff(pConsole->mpUVM); AssertLogRelRC(vrc2);
9467	#ifdef VBOX_WITH_EXTPACK
9468	pConsole->mptrExtPackManager->i_callAllVmPowerOffHooks(pConsole, pVM);
9469	#endif
9470	}
9471	}
9472	else if (task->mEnmFaultToleranceState != FaultToleranceState_Inactive)
9473	{
9474	/*
9475	* Get the config.
9476	*/
9477	ULONG uPort;
9478	ULONG uInterval;
9479	Bstr bstrAddress, bstrPassword;
9480
9481	rc = pMachine->COMGETTER(FaultTolerancePort)(&uPort);
9482	if (SUCCEEDED(rc))
9483	{
9484	rc = pMachine->COMGETTER(FaultToleranceSyncInterval)(&uInterval);
9485	if (SUCCEEDED(rc))
9486	rc = pMachine->COMGETTER(FaultToleranceAddress)(bstrAddress.asOutParam());
9487	if (SUCCEEDED(rc))
9488	rc = pMachine->COMGETTER(FaultTolerancePassword)(bstrPassword.asOutParam());
9489	}
9490	if (task->mProgress->i_setCancelCallback(faultToleranceProgressCancelCallback, pConsole->mpUVM))
9491	{
9492	if (SUCCEEDED(rc))
9493	{
9494	Utf8Str strAddress(bstrAddress);
9495	const char *pszAddress = strAddress.isEmpty() ? NULL : strAddress.c_str();
9496	Utf8Str strPassword(bstrPassword);
9497	const char *pszPassword = strPassword.isEmpty() ? NULL : strPassword.c_str();
9498
9499	/* Power on the FT enabled VM. */
9500	#ifdef VBOX_WITH_EXTPACK
9501	vrc = pConsole->mptrExtPackManager->i_callAllVmPowerOnHooks(pConsole, pVM);
9502	#endif
9503	if (RT_SUCCESS(vrc))
9504	vrc = FTMR3PowerOn(pConsole->mpUVM,
9505	task->mEnmFaultToleranceState == FaultToleranceState_Master /* fMaster */,
9506	uInterval,
9507	pszAddress,
9508	uPort,
9509	pszPassword);
9510	AssertLogRelRC(vrc);
9511	}
9512	task->mProgress->i_setCancelCallback(NULL, NULL);
9513	}
9514	else
9515	rc = E_FAIL;
9516	}
9517	else if (task->mStartPaused)
9518	/* done */
9519	pConsole->i_setMachineState(MachineState_Paused);
9520	else
9521	{
9522	/* Power on the VM (i.e. start executing) */
9523	#ifdef VBOX_WITH_EXTPACK
9524	vrc = pConsole->mptrExtPackManager->i_callAllVmPowerOnHooks(pConsole, pVM);
9525	#endif
9526	if (RT_SUCCESS(vrc))
9527	vrc = VMR3PowerOn(pConsole->mpUVM);
9528	AssertLogRelRC(vrc);
9529	}
9530
9531	/* acquire the lock again */
9532	alock.acquire();
9533	}
9534	while (0);
9535
9536	/* On failure, destroy the VM */
9537	if (FAILED(rc) \|\| RT_FAILURE(vrc))
9538	{
9539	/* preserve existing error info */
9540	ErrorInfoKeeper eik;
9541
9542	/* powerDown() will call VMR3Destroy() and do all necessary
9543	* cleanup (VRDP, USB devices) */
9544	alock.release();
9545	HRESULT rc2 = pConsole->i_powerDown();
9546	alock.acquire();
9547	AssertComRC(rc2);
9548	}
9549	else
9550	{
9551	/*
9552	* Deregister the VMSetError callback. This is necessary as the
9553	* pfnVMAtError() function passed to VMR3Create() is supposed to
9554	* be sticky but our error callback isn't.
9555	*/
9556	alock.release();
9557	VMR3AtErrorDeregister(pConsole->mpUVM, Console::i_genericVMSetErrorCallback, &task->mErrorMsg);
9558	/** @todo register another VMSetError callback? */
9559	alock.acquire();
9560	}
9561	}
9562	else
9563	{
9564	/*
9565	* If VMR3Create() failed it has released the VM memory.
9566	*/
9567	VMR3ReleaseUVM(pConsole->mpUVM);
9568	pConsole->mpUVM = NULL;
9569	}
9570
9571	if (SUCCEEDED(rc) && RT_FAILURE(vrc))
9572	{
9573	/* If VMR3Create() or one of the other calls in this function fail,
9574	* an appropriate error message has been set in task->mErrorMsg.
9575	* However since that happens via a callback, the rc status code in
9576	* this function is not updated.
9577	*/
9578	if (!task->mErrorMsg.length())
9579	{
9580	/* If the error message is not set but we've got a failure,
9581	* convert the VBox status code into a meaningful error message.
9582	* This becomes unused once all the sources of errors set the
9583	* appropriate error message themselves.
9584	*/
9585	AssertMsgFailed(("Missing error message during powerup for status code %Rrc\n", vrc));
9586	task->mErrorMsg = Utf8StrFmt(tr("Failed to start VM execution (%Rrc)"),
9587	vrc);
9588	}
9589
9590	/* Set the error message as the COM error.
9591	* Progress::notifyComplete() will pick it up later. */
9592	throw i_setErrorStatic(E_FAIL, task->mErrorMsg.c_str());
9593	}
9594	}
9595	catch (HRESULT aRC) { rc = aRC; }
9596
9597	if ( pConsole->mMachineState == MachineState_Starting
9598	\|\| pConsole->mMachineState == MachineState_Restoring
9599	\|\| pConsole->mMachineState == MachineState_TeleportingIn
9600	)
9601	{
9602	/* We are still in the Starting/Restoring state. This means one of:
9603	*
9604	* 1) we failed before VMR3Create() was called;
9605	* 2) VMR3Create() failed.
9606	*
9607	* In both cases, there is no need to call powerDown(), but we still
9608	* need to go back to the PoweredOff/Saved state. Reuse
9609	* vmstateChangeCallback() for that purpose.
9610	*/
9611
9612	/* preserve existing error info */
9613	ErrorInfoKeeper eik;
9614
9615	Assert(pConsole->mpUVM == NULL);
9616	i_vmstateChangeCallback(NULL, VMSTATE_TERMINATED, VMSTATE_CREATING, pConsole);
9617	}
9618
9619	/*
9620	* Evaluate the final result. Note that the appropriate mMachineState value
9621	* is already set by vmstateChangeCallback() in all cases.
9622	*/
9623
9624	/* release the lock, don't need it any more */
9625	alock.release();
9626
9627	if (SUCCEEDED(rc))
9628	{
9629	/* Notify the progress object of the success */
9630	task->mProgress->i_notifyComplete(S_OK);
9631	}
9632	else
9633	{
9634	/* The progress object will fetch the current error info */
9635	task->mProgress->i_notifyComplete(rc);
9636	LogRel(("Power up failed (vrc=%Rrc, rc=%Rhrc (%#08X))\n", vrc, rc, rc));
9637	}
9638
9639	/* Notify VBoxSVC and any waiting openRemoteSession progress object. */
9640	pConsole->mControl->EndPowerUp(rc);
9641
9642	#if defined(RT_OS_WINDOWS)
9643	/* uninitialize COM */
9644	CoUninitialize();
9645	#endif
9646
9647	LogFlowFuncLeave();
9648
9649	return VINF_SUCCESS;
9650	}
9651
9652
9653	/**
9654	* Reconfigures a medium attachment (part of taking or deleting an online snapshot).
9655	*
9656	* @param pThis Reference to the console object.
9657	* @param pUVM The VM handle.
9658	* @param lInstance The instance of the controller.
9659	* @param pcszDevice The name of the controller type.
9660	* @param enmBus The storage bus type of the controller.
9661	* @param fSetupMerge Whether to set up a medium merge
9662	* @param uMergeSource Merge source image index
9663	* @param uMergeTarget Merge target image index
9664	* @param aMediumAtt The medium attachment.
9665	* @param aMachineState The current machine state.
9666	* @param phrc Where to store com error - only valid if we return VERR_GENERAL_FAILURE.
9667	* @return VBox status code.
9668	*/
9669	/* static */
9670	DECLCALLBACK(int) Console::i_reconfigureMediumAttachment(Console *pThis,
9671	PUVM pUVM,
9672	const char *pcszDevice,
9673	unsigned uInstance,
9674	StorageBus_T enmBus,
9675	bool fUseHostIOCache,
9676	bool fBuiltinIOCache,
9677	bool fSetupMerge,
9678	unsigned uMergeSource,
9679	unsigned uMergeTarget,
9680	IMediumAttachment *aMediumAtt,
9681	MachineState_T aMachineState,
9682	HRESULT *phrc)
9683	{
9684	LogFlowFunc(("pUVM=%p aMediumAtt=%p phrc=%p\n", pUVM, aMediumAtt, phrc));
9685
9686	HRESULT hrc;
9687	Bstr bstr;
9688	*phrc = S_OK;
9689	#define H() do { if (FAILED(hrc)) { AssertMsgFailed(("hrc=%Rhrc (%#x)\n", hrc, hrc)); *phrc = hrc; return VERR_GENERAL_FAILURE; } } while (0)
9690
9691	/* Ignore attachments other than hard disks, since at the moment they are
9692	* not subject to snapshotting in general. */
9693	DeviceType_T lType;
9694	hrc = aMediumAtt->COMGETTER(Type)(&lType); H();
9695	if (lType != DeviceType_HardDisk)
9696	return VINF_SUCCESS;
9697
9698	/* Determine the base path for the device instance. */
9699	PCFGMNODE pCtlInst;
9700
9701	if (enmBus == StorageBus_USB)
9702	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "USB/%s/", pcszDevice);
9703	else
9704	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%u/", pcszDevice, uInstance);
9705
9706	AssertReturn(pCtlInst, VERR_INTERNAL_ERROR);
9707
9708	/* Update the device instance configuration. */
9709	PCFGMNODE pLunL0 = NULL;
9710	int rc = pThis->i_configMediumAttachment(pCtlInst,
9711	pcszDevice,
9712	uInstance,
9713	enmBus,
9714	fUseHostIOCache,
9715	fBuiltinIOCache,
9716	fSetupMerge,
9717	uMergeSource,
9718	uMergeTarget,
9719	aMediumAtt,
9720	aMachineState,
9721	phrc,
9722	true /* fAttachDetach */,
9723	false /* fForceUnmount */,
9724	false /* fHotplug */,
9725	pUVM,
9726	NULL /* paLedDevType */,
9727	&pLunL0);
9728	/* Dump the changed LUN if possible, dump the complete device otherwise */
9729	CFGMR3Dump(pLunL0 ? pLunL0 : pCtlInst);
9730	if (RT_FAILURE(rc))
9731	{
9732	AssertMsgFailed(("rc=%Rrc\n", rc));
9733	return rc;
9734	}
9735
9736	#undef H
9737
9738	LogFlowFunc(("Returns success\n"));
9739	return VINF_SUCCESS;
9740	}
9741
9742	/**
9743	* Progress cancelation callback employed by Console::fntTakeSnapshotWorker.
9744	*/
9745	static void takesnapshotProgressCancelCallback(void *pvUser)
9746	{
9747	PUVM pUVM = (PUVM)pvUser;
9748	SSMR3Cancel(pUVM);
9749	}
9750
9751	/**
9752	* Worker thread created by Console::TakeSnapshot.
9753	* @param Thread The current thread (ignored).
9754	* @param pvUser The task.
9755	* @return VINF_SUCCESS (ignored).
9756	*/
9757	/static/
9758	DECLCALLBACK(int) Console::i_fntTakeSnapshotWorker(RTTHREAD Thread, void *pvUser)
9759	{
9760	VMTakeSnapshotTask pTask = (VMTakeSnapshotTask)pvUser;
9761
9762	// taking a snapshot consists of the following:
9763
9764	// 1) creating a diff image for each virtual hard disk, into which write operations go after
9765	// the snapshot has been created (done in VBoxSVC, in SessionMachine::BeginTakingSnapshot)
9766	// 2) creating a Snapshot object with the state of the machine (hardware + storage,
9767	// done in VBoxSVC, also in SessionMachine::BeginTakingSnapshot)
9768	// 3) saving the state of the virtual machine (here, in the VM process, if the machine is online)
9769
9770	Console *that = pTask->mConsole;
9771	bool fBeganTakingSnapshot = false;
9772	bool fSuspenededBySave = false;
9773
9774	AutoCaller autoCaller(that);
9775	if (FAILED(autoCaller.rc()))
9776	{
9777	that->mptrCancelableProgress.setNull();
9778	return autoCaller.rc();
9779	}
9780
9781	AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
9782
9783	HRESULT rc = S_OK;
9784
9785	try
9786	{
9787	/* STEP 1 + 2:
9788	* request creating the diff images on the server and create the snapshot object
9789	* (this will set the machine state to Saving on the server to block
9790	* others from accessing this machine)
9791	*/
9792	rc = that->mControl->BeginTakingSnapshot(that,
9793	pTask->bstrName.raw(),
9794	pTask->bstrDescription.raw(),
9795	pTask->mProgress,
9796	pTask->fTakingSnapshotOnline,
9797	pTask->bstrSavedStateFile.asOutParam());
9798	if (FAILED(rc))
9799	throw rc;
9800
9801	fBeganTakingSnapshot = true;
9802
9803	/* Check sanity: for offline snapshots there must not be a saved state
9804	* file name. All other combinations are valid (even though online
9805	* snapshots without saved state file seems inconsistent - there are
9806	* some exotic use cases, which need to be explicitly enabled, see the
9807	* code of SessionMachine::BeginTakingSnapshot. */
9808	if ( !pTask->fTakingSnapshotOnline
9809	&& !pTask->bstrSavedStateFile.isEmpty())
9810	throw i_setErrorStatic(E_FAIL, "Invalid state of saved state file");
9811
9812	/* sync the state with the server */
9813	if (pTask->lastMachineState == MachineState_Running)
9814	that->i_setMachineStateLocally(MachineState_LiveSnapshotting);
9815	else
9816	that->i_setMachineStateLocally(MachineState_Saving);
9817
9818	// STEP 3: save the VM state (if online)
9819	if (pTask->fTakingSnapshotOnline)
9820	{
9821	int vrc;
9822	SafeVMPtr ptrVM(that);
9823	if (!ptrVM.isOk())
9824	throw ptrVM.rc();
9825
9826	pTask->mProgress->SetNextOperation(Bstr(tr("Saving the machine state")).raw(),
9827	pTask->ulMemSize); // operation weight, same as computed
9828	// when setting up progress object
9829	if (!pTask->bstrSavedStateFile.isEmpty())
9830	{
9831	Utf8Str strSavedStateFile(pTask->bstrSavedStateFile);
9832
9833	pTask->mProgress->i_setCancelCallback(takesnapshotProgressCancelCallback, ptrVM.rawUVM());
9834
9835	alock.release();
9836	LogFlowFunc(("VMR3Save...\n"));
9837	vrc = VMR3Save(ptrVM.rawUVM(),
9838	strSavedStateFile.c_str(),
9839	true /fContinueAfterwards/,
9840	Console::i_stateProgressCallback,
9841	static_cast<IProgress *>(pTask->mProgress),
9842	&fSuspenededBySave);
9843	alock.acquire();
9844	if (RT_FAILURE(vrc))
9845	throw i_setErrorStatic(E_FAIL,
9846	tr("Failed to save the machine state to '%s' (%Rrc)"),
9847	strSavedStateFile.c_str(), vrc);
9848
9849	pTask->mProgress->i_setCancelCallback(NULL, NULL);
9850	}
9851	else
9852	LogRel(("Console: skipped saving state as part of online snapshot\n"));
9853
9854	if (!pTask->mProgress->i_notifyPointOfNoReturn())
9855	throw i_setErrorStatic(E_FAIL, tr("Canceled"));
9856	that->mptrCancelableProgress.setNull();
9857
9858	// STEP 4: reattach hard disks
9859	LogFlowFunc(("Reattaching new differencing hard disks...\n"));
9860
9861	pTask->mProgress->SetNextOperation(Bstr(tr("Reconfiguring medium attachments")).raw(),
9862	1); // operation weight, same as computed when setting up progress object
9863
9864	com::SafeIfaceArray<IMediumAttachment> atts;
9865	rc = that->mMachine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(atts));
9866	if (FAILED(rc))
9867	throw rc;
9868
9869	for (size_t i = 0;
9870	i < atts.size();
9871	++i)
9872	{
9873	ComPtr<IStorageController> pStorageController;
9874	Bstr controllerName;
9875	ULONG lInstance;
9876	StorageControllerType_T enmController;
9877	StorageBus_T enmBus;
9878	BOOL fUseHostIOCache;
9879
9880	/*
9881	* We can't pass a storage controller object directly
9882	* (g++ complains about not being able to pass non POD types through '...')
9883	* so we have to query needed values here and pass them.
9884	*/
9885	rc = atts[i]->COMGETTER(Controller)(controllerName.asOutParam());
9886	if (FAILED(rc))
9887	throw rc;
9888
9889	rc = that->mMachine->GetStorageControllerByName(controllerName.raw(),
9890	pStorageController.asOutParam());
9891	if (FAILED(rc))
9892	throw rc;
9893
9894	rc = pStorageController->COMGETTER(ControllerType)(&enmController);
9895	if (FAILED(rc))
9896	throw rc;
9897	rc = pStorageController->COMGETTER(Instance)(&lInstance);
9898	if (FAILED(rc))
9899	throw rc;
9900	rc = pStorageController->COMGETTER(Bus)(&enmBus);
9901	if (FAILED(rc))
9902	throw rc;
9903	rc = pStorageController->COMGETTER(UseHostIOCache)(&fUseHostIOCache);
9904	if (FAILED(rc))
9905	throw rc;
9906
9907	const char *pcszDevice = Console::i_convertControllerTypeToDev(enmController);
9908
9909	BOOL fBuiltinIOCache;
9910	rc = that->mMachine->COMGETTER(IOCacheEnabled)(&fBuiltinIOCache);
9911	if (FAILED(rc))
9912	throw rc;
9913
9914	/*
9915	* don't release the lock since reconfigureMediumAttachment
9916	* isn't going to need the Console lock.
9917	*/
9918	vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY,
9919	(PFNRT)i_reconfigureMediumAttachment, 13,
9920	that, ptrVM.rawUVM(), pcszDevice, lInstance, enmBus, fUseHostIOCache,
9921	fBuiltinIOCache, false /* fSetupMerge /, 0 / uMergeSource */,
9922	0 /* uMergeTarget */, atts[i], that->mMachineState, &rc);
9923	if (RT_FAILURE(vrc))
9924	throw i_setErrorStatic(E_FAIL, Console::tr("%Rrc"), vrc);
9925	if (FAILED(rc))
9926	throw rc;
9927	}
9928	}
9929
9930	/*
9931	* finalize the requested snapshot object.
9932	* This will reset the machine state to the state it had right
9933	* before calling mControl->BeginTakingSnapshot().
9934	*/
9935	rc = that->mControl->EndTakingSnapshot(TRUE /aSuccess/);
9936	// do not throw rc here because we can't call EndTakingSnapshot() twice
9937	LogFlowFunc(("EndTakingSnapshot -> %Rhrc [mMachineState=%s]\n", rc, Global::stringifyMachineState(that->mMachineState)));
9938	}
9939	catch (HRESULT rcThrown)
9940	{
9941	/* preserve existing error info */
9942	ErrorInfoKeeper eik;
9943
9944	if (fBeganTakingSnapshot)
9945	that->mControl->EndTakingSnapshot(FALSE /aSuccess/);
9946
9947	rc = rcThrown;
9948	LogFunc(("Caught %Rhrc [mMachineState=%s]\n", rc, Global::stringifyMachineState(that->mMachineState)));
9949	}
9950	Assert(alock.isWriteLockOnCurrentThread());
9951
9952	if (FAILED(rc)) /* Must come before calling setMachineState. */
9953	pTask->mProgress->i_notifyComplete(rc);
9954
9955	/*
9956	* Fix up the machine state.
9957	*
9958	* For live snapshots we do all the work, for the two other variations we
9959	* just update the local copy.
9960	*/
9961	MachineState_T enmMachineState;
9962	that->mMachine->COMGETTER(State)(&enmMachineState);
9963	if ( that->mMachineState == MachineState_LiveSnapshotting
9964	\|\| that->mMachineState == MachineState_Saving)
9965	{
9966
9967	if (!pTask->fTakingSnapshotOnline)
9968	that->i_setMachineStateLocally(pTask->lastMachineState);
9969	else if (SUCCEEDED(rc))
9970	{
9971	Assert( pTask->lastMachineState == MachineState_Running
9972	\|\| pTask->lastMachineState == MachineState_Paused);
9973	Assert(that->mMachineState == MachineState_Saving);
9974	if (pTask->lastMachineState == MachineState_Running)
9975	{
9976	LogFlowFunc(("VMR3Resume...\n"));
9977	SafeVMPtr ptrVM(that);
9978	alock.release();
9979	int vrc = VMR3Resume(ptrVM.rawUVM(), VMRESUMEREASON_STATE_SAVED);
9980	alock.acquire();
9981	if (RT_FAILURE(vrc))
9982	{
9983	rc = i_setErrorStatic(VBOX_E_VM_ERROR, tr("Could not resume the machine execution (%Rrc)"), vrc);
9984	pTask->mProgress->i_notifyComplete(rc);
9985	if (that->mMachineState == MachineState_Saving)
9986	that->i_setMachineStateLocally(MachineState_Paused);
9987	}
9988	}
9989	else
9990	that->i_setMachineStateLocally(MachineState_Paused);
9991	}
9992	else
9993	{
9994	/** @todo this could probably be made more generic and reused elsewhere. */
9995	/* paranoid cleanup on for a failed online snapshot. */
9996	VMSTATE enmVMState = VMR3GetStateU(that->mpUVM);
9997	switch (enmVMState)
9998	{
9999	case VMSTATE_RUNNING:
10000	case VMSTATE_RUNNING_LS:
10001	case VMSTATE_DEBUGGING:
10002	case VMSTATE_DEBUGGING_LS:
10003	case VMSTATE_POWERING_OFF:
10004	case VMSTATE_POWERING_OFF_LS:
10005	case VMSTATE_RESETTING:
10006	case VMSTATE_RESETTING_LS:
10007	Assert(!fSuspenededBySave);
10008	that->i_setMachineState(MachineState_Running);
10009	break;
10010
10011	case VMSTATE_GURU_MEDITATION:
10012	case VMSTATE_GURU_MEDITATION_LS:
10013	that->i_setMachineState(MachineState_Stuck);
10014	break;
10015
10016	case VMSTATE_FATAL_ERROR:
10017	case VMSTATE_FATAL_ERROR_LS:
10018	if (pTask->lastMachineState == MachineState_Paused)
10019	that->i_setMachineStateLocally(pTask->lastMachineState);
10020	else
10021	that->i_setMachineState(MachineState_Paused);
10022	break;
10023
10024	default:
10025	AssertMsgFailed(("%s\n", VMR3GetStateName(enmVMState)));
10026	case VMSTATE_SUSPENDED:
10027	case VMSTATE_SUSPENDED_LS:
10028	case VMSTATE_SUSPENDING:
10029	case VMSTATE_SUSPENDING_LS:
10030	case VMSTATE_SUSPENDING_EXT_LS:
10031	if (fSuspenededBySave)
10032	{
10033	Assert(pTask->lastMachineState == MachineState_Running);
10034	LogFlowFunc(("VMR3Resume (on failure)...\n"));
10035	SafeVMPtr ptrVM(that);
10036	alock.release();
10037	int vrc = VMR3Resume(ptrVM.rawUVM(), VMRESUMEREASON_STATE_SAVED); AssertLogRelRC(vrc);
10038	alock.acquire();
10039	if (RT_FAILURE(vrc))
10040	that->i_setMachineState(MachineState_Paused);
10041	}
10042	else if (pTask->lastMachineState == MachineState_Paused)
10043	that->i_setMachineStateLocally(pTask->lastMachineState);
10044	else
10045	that->i_setMachineState(MachineState_Paused);
10046	break;
10047	}
10048
10049	}
10050	}
10051	/else: somebody else has change the state... Leave it. /
10052
10053	/* check the remote state to see that we got it right. */
10054	that->mMachine->COMGETTER(State)(&enmMachineState);
10055	AssertLogRelMsg(that->mMachineState == enmMachineState,
10056	("mMachineState=%s enmMachineState=%s\n", Global::stringifyMachineState(that->mMachineState),
10057	Global::stringifyMachineState(enmMachineState) ));
10058
10059
10060	if (SUCCEEDED(rc)) /* The failure cases are handled above. */
10061	pTask->mProgress->i_notifyComplete(rc);
10062
10063	delete pTask;
10064
10065	LogFlowFuncLeave();
10066	return VINF_SUCCESS;
10067	}
10068
10069	/**
10070	* Thread for executing the saved state operation.
10071	*
10072	* @param Thread The thread handle.
10073	* @param pvUser Pointer to a VMSaveTask structure.
10074	* @return VINF_SUCCESS (ignored).
10075	*
10076	* @note Locks the Console object for writing.
10077	*/
10078	/static/
10079	DECLCALLBACK(int) Console::i_saveStateThread(RTTHREAD Thread, void *pvUser)
10080	{
10081	LogFlowFuncEnter();
10082
10083	std::auto_ptr<VMSaveTask> task(static_cast<VMSaveTask*>(pvUser));
10084	AssertReturn(task.get(), VERR_INVALID_PARAMETER);
10085
10086	Assert(task->mSavedStateFile.length());
10087	Assert(task->mProgress.isNull());
10088	Assert(!task->mServerProgress.isNull());
10089
10090	const ComObjPtr<Console> &that = task->mConsole;
10091	Utf8Str errMsg;
10092	HRESULT rc = S_OK;
10093
10094	LogFlowFunc(("Saving the state to '%s'...\n", task->mSavedStateFile.c_str()));
10095
10096	bool fSuspenededBySave;
10097	int vrc = VMR3Save(task->mpUVM,
10098	task->mSavedStateFile.c_str(),
10099	false, /fContinueAfterwards/
10100	Console::i_stateProgressCallback,
10101	static_cast<IProgress *>(task->mServerProgress),
10102	&fSuspenededBySave);
10103	if (RT_FAILURE(vrc))
10104	{
10105	errMsg = Utf8StrFmt(Console::tr("Failed to save the machine state to '%s' (%Rrc)"),
10106	task->mSavedStateFile.c_str(), vrc);
10107	rc = E_FAIL;
10108	}
10109	Assert(!fSuspenededBySave);
10110
10111	/* lock the console once we're going to access it */
10112	AutoWriteLock thatLock(that COMMA_LOCKVAL_SRC_POS);
10113
10114	/* synchronize the state with the server */
10115	if (SUCCEEDED(rc))
10116	{
10117	/*
10118	* The machine has been successfully saved, so power it down
10119	* (vmstateChangeCallback() will set state to Saved on success).
10120	* Note: we release the task's VM caller, otherwise it will
10121	* deadlock.
10122	*/
10123	task->releaseVMCaller();
10124	thatLock.release();
10125	rc = that->i_powerDown();
10126	thatLock.acquire();
10127	}
10128
10129	/*
10130	* If we failed, reset the local machine state.
10131	*/
10132	if (FAILED(rc))
10133	that->i_setMachineStateLocally(task->mMachineStateBefore);
10134
10135	/*
10136	* Finalize the requested save state procedure. In case of failure it will
10137	* reset the machine state to the state it had right before calling
10138	* mControl->BeginSavingState(). This must be the last thing because it
10139	* will set the progress to completed, and that means that the frontend
10140	* can immediately uninit the associated console object.
10141	*/
10142	that->mControl->EndSavingState(rc, Bstr(errMsg).raw());
10143
10144	LogFlowFuncLeave();
10145	return VINF_SUCCESS;
10146	}
10147
10148	/**
10149	* Thread for powering down the Console.
10150	*
10151	* @param Thread The thread handle.
10152	* @param pvUser Pointer to the VMTask structure.
10153	* @return VINF_SUCCESS (ignored).
10154	*
10155	* @note Locks the Console object for writing.
10156	*/
10157	/static/
10158	DECLCALLBACK(int) Console::i_powerDownThread(RTTHREAD Thread, void *pvUser)
10159	{
10160	LogFlowFuncEnter();
10161
10162	std::auto_ptr<VMPowerDownTask> task(static_cast<VMPowerDownTask *>(pvUser));
10163	AssertReturn(task.get(), VERR_INVALID_PARAMETER);
10164
10165	AssertReturn(task->isOk(), VERR_GENERAL_FAILURE);
10166
10167	Assert(task->mProgress.isNull());
10168
10169	const ComObjPtr<Console> &that = task->mConsole;
10170
10171	/* Note: no need to use addCaller() to protect Console because VMTask does
10172	* that */
10173
10174	/* wait until the method tat started us returns */
10175	AutoWriteLock thatLock(that COMMA_LOCKVAL_SRC_POS);
10176
10177	/* release VM caller to avoid the powerDown() deadlock */
10178	task->releaseVMCaller();
10179
10180	thatLock.release();
10181
10182	that->i_powerDown(task->mServerProgress);
10183
10184	/* complete the operation */
10185	that->mControl->EndPoweringDown(S_OK, Bstr().raw());
10186
10187	LogFlowFuncLeave();
10188	return VINF_SUCCESS;
10189	}
10190
10191
10192	/**
10193	* @interface_method_impl{VMM2USERMETHODS,pfnSaveState}
10194	*/
10195	/static/ DECLCALLBACK(int)
10196	Console::i_vmm2User_SaveState(PCVMM2USERMETHODS pThis, PUVM pUVM)
10197	{
10198	Console pConsole = ((MYVMM2USERMETHODS )pThis)->pConsole;
10199	NOREF(pUVM);
10200
10201	/*
10202	* For now, just call SaveState. We should probably try notify the GUI so
10203	* it can pop up a progress object and stuff.
10204	*/
10205	HRESULT hrc = pConsole->SaveState(NULL);
10206	return SUCCEEDED(hrc) ? VINF_SUCCESS : Global::vboxStatusCodeFromCOM(hrc);
10207	}
10208
10209	/**
10210	* @interface_method_impl{VMM2USERMETHODS,pfnNotifyEmtInit}
10211	*/
10212	/static/ DECLCALLBACK(void)
10213	Console::i_vmm2User_NotifyEmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu)
10214	{
10215	NOREF(pThis); NOREF(pUVM); NOREF(pUVCpu);
10216	VirtualBoxBase::initializeComForThread();
10217	}
10218
10219	/**
10220	* @interface_method_impl{VMM2USERMETHODS,pfnNotifyEmtTerm}
10221	*/
10222	/static/ DECLCALLBACK(void)
10223	Console::i_vmm2User_NotifyEmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu)
10224	{
10225	NOREF(pThis); NOREF(pUVM); NOREF(pUVCpu);
10226	VirtualBoxBase::uninitializeComForThread();
10227	}
10228
10229	/**
10230	* @interface_method_impl{VMM2USERMETHODS,pfnNotifyPdmtInit}
10231	*/
10232	/static/ DECLCALLBACK(void)
10233	Console::i_vmm2User_NotifyPdmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM)
10234	{
10235	NOREF(pThis); NOREF(pUVM);
10236	VirtualBoxBase::initializeComForThread();
10237	}
10238
10239	/**
10240	* @interface_method_impl{VMM2USERMETHODS,pfnNotifyPdmtTerm}
10241	*/
10242	/static/ DECLCALLBACK(void)
10243	Console::i_vmm2User_NotifyPdmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM)
10244	{
10245	NOREF(pThis); NOREF(pUVM);
10246	VirtualBoxBase::uninitializeComForThread();
10247	}
10248
10249	/**
10250	* @interface_method_impl{VMM2USERMETHODS,pfnNotifyResetTurnedIntoPowerOff}
10251	*/
10252	/static/ DECLCALLBACK(void)
10253	Console::i_vmm2User_NotifyResetTurnedIntoPowerOff(PCVMM2USERMETHODS pThis, PUVM pUVM)
10254	{
10255	Console pConsole = ((MYVMM2USERMETHODS )pThis)->pConsole;
10256	NOREF(pUVM);
10257
10258	pConsole->mfPowerOffCausedByReset = true;
10259	}
10260
10261
10262
10263
10264	/**
10265	* @interface_method_impl{PDMISECKEY,pfnKeyRetain}
10266	*/
10267	/static/ DECLCALLBACK(int)
10268	Console::i_pdmIfSecKey_KeyRetain(PPDMISECKEY pInterface, const char pszId, const uint8_t *ppbKey,
10269	size_t *pcbKey)
10270	{
10271	Console pConsole = ((MYPDMISECKEY )pInterface)->pConsole;
10272
10273	SecretKeyMap::const_iterator it = pConsole->m_mapSecretKeys.find(Utf8Str(pszId));
10274	if (it != pConsole->m_mapSecretKeys.end())
10275	{
10276	SecretKey pKey = (it).second;
10277
10278	ASMAtomicIncU32(&pKey->m_cRefs);
10279	*ppbKey = pKey->m_pbKey;
10280	*pcbKey = pKey->m_cbKey;
10281	return VINF_SUCCESS;
10282	}
10283
10284	return VERR_NOT_FOUND;
10285	}
10286
10287	/**
10288	* @interface_method_impl{PDMISECKEY,pfnKeyRelease}
10289	*/
10290	/static/ DECLCALLBACK(int)
10291	Console::i_pdmIfSecKey_KeyRelease(PPDMISECKEY pInterface, const char *pszId)
10292	{
10293	Console pConsole = ((MYPDMISECKEY )pInterface)->pConsole;
10294	SecretKeyMap::const_iterator it = pConsole->m_mapSecretKeys.find(Utf8Str(pszId));
10295	if (it != pConsole->m_mapSecretKeys.end())
10296	{
10297	SecretKey pKey = (it).second;
10298	ASMAtomicDecU32(&pKey->m_cRefs);
10299	return VINF_SUCCESS;
10300	}
10301
10302	return VERR_NOT_FOUND;
10303	}
10304
10305
10306
10307
10308	/**
10309	* The Main status driver instance data.
10310	*/
10311	typedef struct DRVMAINSTATUS
10312	{
10313	/** The LED connectors. */
10314	PDMILEDCONNECTORS ILedConnectors;
10315	/** Pointer to the LED ports interface above us. */
10316	PPDMILEDPORTS pLedPorts;
10317	/** Pointer to the array of LED pointers. */
10318	PPDMLED *papLeds;
10319	/** The unit number corresponding to the first entry in the LED array. */
10320	RTUINT iFirstLUN;
10321	/** The unit number corresponding to the last entry in the LED array.
10322	* (The size of the LED array is iLastLUN - iFirstLUN + 1.) */
10323	RTUINT iLastLUN;
10324	/** Pointer to the driver instance. */
10325	PPDMDRVINS pDrvIns;
10326	/** The Media Notify interface. */
10327	PDMIMEDIANOTIFY IMediaNotify;
10328	/** Map for translating PDM storage controller/LUN information to
10329	* IMediumAttachment references. */
10330	Console::MediumAttachmentMap *pmapMediumAttachments;
10331	/** Device name+instance for mapping */
10332	char *pszDeviceInstance;
10333	/** Pointer to the Console object, for driver triggered activities. */
10334	Console *pConsole;
10335	} DRVMAINSTATUS, *PDRVMAINSTATUS;
10336
10337
10338	/**
10339	* Notification about a unit which have been changed.
10340	*
10341	* The driver must discard any pointers to data owned by
10342	* the unit and requery it.
10343	*
10344	* @param pInterface Pointer to the interface structure containing the called function pointer.
10345	* @param iLUN The unit number.
10346	*/
10347	DECLCALLBACK(void) Console::i_drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN)
10348	{
10349	PDRVMAINSTATUS pThis = RT_FROM_MEMBER(pInterface, DRVMAINSTATUS, ILedConnectors);
10350	if (iLUN >= pThis->iFirstLUN && iLUN <= pThis->iLastLUN)
10351	{
10352	PPDMLED pLed;
10353	int rc = pThis->pLedPorts->pfnQueryStatusLed(pThis->pLedPorts, iLUN, &pLed);
10354	if (RT_FAILURE(rc))
10355	pLed = NULL;
10356	ASMAtomicWritePtr(&pThis->papLeds[iLUN - pThis->iFirstLUN], pLed);
10357	Log(("drvStatus_UnitChanged: iLUN=%d pLed=%p\n", iLUN, pLed));
10358	}
10359	}
10360
10361
10362	/**
10363	* Notification about a medium eject.
10364	*
10365	* @returns VBox status.
10366	* @param pInterface Pointer to the interface structure containing the called function pointer.
10367	* @param uLUN The unit number.
10368	*/
10369	DECLCALLBACK(int) Console::i_drvStatus_MediumEjected(PPDMIMEDIANOTIFY pInterface, unsigned uLUN)
10370	{
10371	PDRVMAINSTATUS pThis = RT_FROM_MEMBER(pInterface, DRVMAINSTATUS, IMediaNotify);
10372	PPDMDRVINS pDrvIns = pThis->pDrvIns;
10373	LogFunc(("uLUN=%d\n", uLUN));
10374	if (pThis->pmapMediumAttachments)
10375	{
10376	AutoWriteLock alock(pThis->pConsole COMMA_LOCKVAL_SRC_POS);
10377
10378	ComPtr<IMediumAttachment> pMediumAtt;
10379	Utf8Str devicePath = Utf8StrFmt("%s/LUN#%u", pThis->pszDeviceInstance, uLUN);
10380	Console::MediumAttachmentMap::const_iterator end = pThis->pmapMediumAttachments->end();
10381	Console::MediumAttachmentMap::const_iterator it = pThis->pmapMediumAttachments->find(devicePath);
10382	if (it != end)
10383	pMediumAtt = it->second;
10384	Assert(!pMediumAtt.isNull());
10385	if (!pMediumAtt.isNull())
10386	{
10387	IMedium *pMedium = NULL;
10388	HRESULT rc = pMediumAtt->COMGETTER(Medium)(&pMedium);
10389	AssertComRC(rc);
10390	if (SUCCEEDED(rc) && pMedium)
10391	{
10392	BOOL fHostDrive = FALSE;
10393	rc = pMedium->COMGETTER(HostDrive)(&fHostDrive);
10394	AssertComRC(rc);
10395	if (!fHostDrive)
10396	{
10397	alock.release();
10398
10399	ComPtr<IMediumAttachment> pNewMediumAtt;
10400	rc = pThis->pConsole->mControl->EjectMedium(pMediumAtt, pNewMediumAtt.asOutParam());
10401	if (SUCCEEDED(rc))
10402	fireMediumChangedEvent(pThis->pConsole->mEventSource, pNewMediumAtt);
10403
10404	alock.acquire();
10405	if (pNewMediumAtt != pMediumAtt)
10406	{
10407	pThis->pmapMediumAttachments->erase(devicePath);
10408	pThis->pmapMediumAttachments->insert(std::make_pair(devicePath, pNewMediumAtt));
10409	}
10410	}
10411	}
10412	}
10413	}
10414	return VINF_SUCCESS;
10415	}
10416
10417
10418	/**
10419	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
10420	*/
10421	DECLCALLBACK(void ) Console::i_drvStatus_QueryInterface(PPDMIBASE pInterface, const char pszIID)
10422	{
10423	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
10424	PDRVMAINSTATUS pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
10425	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
10426	PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDCONNECTORS, &pThis->ILedConnectors);
10427	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIANOTIFY, &pThis->IMediaNotify);
10428	return NULL;
10429	}
10430
10431
10432	/**
10433	* Destruct a status driver instance.
10434	*
10435	* @returns VBox status.
10436	* @param pDrvIns The driver instance data.
10437	*/
10438	DECLCALLBACK(void) Console::i_drvStatus_Destruct(PPDMDRVINS pDrvIns)
10439	{
10440	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
10441	PDRVMAINSTATUS pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
10442	LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
10443
10444	if (pThis->papLeds)
10445	{
10446	unsigned iLed = pThis->iLastLUN - pThis->iFirstLUN + 1;
10447	while (iLed-- > 0)
10448	ASMAtomicWriteNullPtr(&pThis->papLeds[iLed]);
10449	}
10450	}
10451
10452
10453	/**
10454	* Construct a status driver instance.
10455	*
10456	* @copydoc FNPDMDRVCONSTRUCT
10457	*/
10458	DECLCALLBACK(int) Console::i_drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
10459	{
10460	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
10461	PDRVMAINSTATUS pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
10462	LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
10463
10464	/*
10465	* Validate configuration.
10466	*/
10467	if (!CFGMR3AreValuesValid(pCfg, "papLeds\0pmapMediumAttachments\0DeviceInstance\0pConsole\0First\0Last\0"))
10468	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
10469	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
10470	("Configuration error: Not possible to attach anything to this driver!\n"),
10471	VERR_PDM_DRVINS_NO_ATTACH);
10472
10473	/*
10474	* Data.
10475	*/
10476	pDrvIns->IBase.pfnQueryInterface = Console::i_drvStatus_QueryInterface;
10477	pThis->ILedConnectors.pfnUnitChanged = Console::i_drvStatus_UnitChanged;
10478	pThis->IMediaNotify.pfnEjected = Console::i_drvStatus_MediumEjected;
10479	pThis->pDrvIns = pDrvIns;
10480	pThis->pszDeviceInstance = NULL;
10481
10482	/*
10483	* Read config.
10484	*/
10485	int rc = CFGMR3QueryPtr(pCfg, "papLeds", (void **)&pThis->papLeds);
10486	if (RT_FAILURE(rc))
10487	{
10488	AssertMsgFailed(("Configuration error: Failed to query the \"papLeds\" value! rc=%Rrc\n", rc));
10489	return rc;
10490	}
10491
10492	rc = CFGMR3QueryPtrDef(pCfg, "pmapMediumAttachments", (void **)&pThis->pmapMediumAttachments, NULL);
10493	if (RT_FAILURE(rc))
10494	{
10495	AssertMsgFailed(("Configuration error: Failed to query the \"pmapMediumAttachments\" value! rc=%Rrc\n", rc));
10496	return rc;
10497	}
10498	if (pThis->pmapMediumAttachments)
10499	{
10500	rc = CFGMR3QueryStringAlloc(pCfg, "DeviceInstance", &pThis->pszDeviceInstance);
10501	if (RT_FAILURE(rc))
10502	{
10503	AssertMsgFailed(("Configuration error: Failed to query the \"DeviceInstance\" value! rc=%Rrc\n", rc));
10504	return rc;
10505	}
10506	rc = CFGMR3QueryPtr(pCfg, "pConsole", (void **)&pThis->pConsole);
10507	if (RT_FAILURE(rc))
10508	{
10509	AssertMsgFailed(("Configuration error: Failed to query the \"pConsole\" value! rc=%Rrc\n", rc));
10510	return rc;
10511	}
10512	}
10513
10514	rc = CFGMR3QueryU32(pCfg, "First", &pThis->iFirstLUN);
10515	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
10516	pThis->iFirstLUN = 0;
10517	else if (RT_FAILURE(rc))
10518	{
10519	AssertMsgFailed(("Configuration error: Failed to query the \"First\" value! rc=%Rrc\n", rc));
10520	return rc;
10521	}
10522
10523	rc = CFGMR3QueryU32(pCfg, "Last", &pThis->iLastLUN);
10524	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
10525	pThis->iLastLUN = 0;
10526	else if (RT_FAILURE(rc))
10527	{
10528	AssertMsgFailed(("Configuration error: Failed to query the \"Last\" value! rc=%Rrc\n", rc));
10529	return rc;
10530	}
10531	if (pThis->iFirstLUN > pThis->iLastLUN)
10532	{
10533	AssertMsgFailed(("Configuration error: Invalid unit range %u-%u\n", pThis->iFirstLUN, pThis->iLastLUN));
10534	return VERR_GENERAL_FAILURE;
10535	}
10536
10537	/*
10538	* Get the ILedPorts interface of the above driver/device and
10539	* query the LEDs we want.
10540	*/
10541	pThis->pLedPorts = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMILEDPORTS);
10542	AssertMsgReturn(pThis->pLedPorts, ("Configuration error: No led ports interface above!\n"),
10543	VERR_PDM_MISSING_INTERFACE_ABOVE);
10544
10545	for (unsigned i = pThis->iFirstLUN; i <= pThis->iLastLUN; ++i)
10546	Console::i_drvStatus_UnitChanged(&pThis->ILedConnectors, i);
10547
10548	return VINF_SUCCESS;
10549	}
10550
10551
10552	/**
10553	* Console status driver (LED) registration record.
10554	*/
10555	const PDMDRVREG Console::DrvStatusReg =
10556	{
10557	/* u32Version */
10558	PDM_DRVREG_VERSION,
10559	/* szName */
10560	"MainStatus",
10561	/* szRCMod */
10562	"",
10563	/* szR0Mod */
10564	"",
10565	/* pszDescription */
10566	"Main status driver (Main as in the API).",
10567	/* fFlags */
10568	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
10569	/* fClass. */
10570	PDM_DRVREG_CLASS_STATUS,
10571	/* cMaxInstances */
10572	~0U,
10573	/* cbInstance */
10574	sizeof(DRVMAINSTATUS),
10575	/* pfnConstruct */
10576	Console::i_drvStatus_Construct,
10577	/* pfnDestruct */
10578	Console::i_drvStatus_Destruct,
10579	/* pfnRelocate */
10580	NULL,
10581	/* pfnIOCtl */
10582	NULL,
10583	/* pfnPowerOn */
10584	NULL,
10585	/* pfnReset */
10586	NULL,
10587	/* pfnSuspend */
10588	NULL,
10589	/* pfnResume */
10590	NULL,
10591	/* pfnAttach */
10592	NULL,
10593	/* pfnDetach */
10594	NULL,
10595	/* pfnPowerOff */
10596	NULL,
10597	/* pfnSoftReset */
10598	NULL,
10599	/* u32EndVersion */
10600	PDM_DRVREG_VERSION
10601	};
10602
10603
10604
10605	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

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

source: vbox/trunk/src/VBox/Main/src-client/ConsoleImpl.cpp@ 52019

Download in other formats: