ConsoleImpl.cpp@ 106028

Last change on this file since 106028 was 106028, checked in by vboxsync, 2 months ago
Main/ConsoleImpl.cpp: i_powerDownHostInterfaces doesn't need to do anything unless VBOX_WITH_NETFLT isn't defined (non-standard config) and we're on linux or freebsd, so expanded the #if to cover most of the code.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 419.5 KB

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

Download in other formats: