ConsoleImpl.cpp@ 53624

最後變更在這個檔案從53624是 53560,由 vboxsync 提交於 10 年前
Main: Fixes for disk encryption, delete the key again if configuring disk encryption fails. Correctly set disk properties for all media and not just the first one
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Author Date Id Revision`
檔案大小: 351.7 KB

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

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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

以其他格式下載: