ConsoleImpl.cpp@ 57595

Last change on this file since 57595 was 57595, checked in by vboxsync, 9 years ago
NVMe: Fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 340.8 KB

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

Download in other formats: