ConsoleImpl.cpp@ 52104

Last change on this file since 52104 was 52104, checked in by vboxsync, 11 years ago
Console: secret keys require non pageable memory too
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 350.9 KB

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

Download in other formats: