ConsoleImpl.cpp@ 104713

Last change on this file since 104713 was 104713, checked in by vboxsync, 7 months ago
Recording/Main: Do not alter the settings (the global recording enabled/disabled bit) when Console::i_recordingStop() is being called. This led the VM to have disabled recording on the next run even if recording actually was intended to stay enabled (via settings).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 414.8 KB

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

Download in other formats: