ConsoleImpl.cpp@ 3037

Last change on this file since 3037 was 3037, checked in by vboxsync, 18 years ago
Main: More exact state check on getting an USB detached notification.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 254.4 KB

Line
1	/** @file
2	*
3	* VBox Console COM Class implementation
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 innotek GmbH
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License as published by the Free Software Foundation,
13	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14	* distribution. VirtualBox OSE is distributed in the hope that it will
15	* be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* If you received this file as part of a commercial VirtualBox
18	* distribution, then only the terms of your commercial VirtualBox
19	* license agreement apply instead of the previous paragraph.
20	*/
21
22	#if defined(__WIN__)
23	#elif defined(__LINUX__)
24	# include <errno.h>
25	# include <sys/ioctl.h>
26	# include <sys/poll.h>
27	# include <sys/fcntl.h>
28	# include <sys/types.h>
29	# include <sys/wait.h>
30	# include <net/if.h>
31	# include <linux/if_tun.h>
32	# include <stdio.h>
33	# include <stdlib.h>
34	# include <string.h>
35	#endif
36
37	#include "ConsoleImpl.h"
38	#include "GuestImpl.h"
39	#include "KeyboardImpl.h"
40	#include "MouseImpl.h"
41	#include "DisplayImpl.h"
42	#include "MachineDebuggerImpl.h"
43	#include "USBDeviceImpl.h"
44	#include "RemoteUSBDeviceImpl.h"
45	#include "SharedFolderImpl.h"
46	#include "AudioSnifferInterface.h"
47	#include "ConsoleVRDPServer.h"
48	#include "VMMDev.h"
49
50	// generated header
51	#include "SchemaDefs.h"
52
53	#include "Logging.h"
54
55	#include <iprt/string.h>
56	#include <iprt/asm.h>
57	#include <iprt/file.h>
58	#include <iprt/path.h>
59	#include <iprt/dir.h>
60	#include <iprt/process.h>
61	#include <iprt/ldr.h>
62	#include <iprt/cpputils.h>
63
64	#include <VBox/vmapi.h>
65	#include <VBox/err.h>
66	#include <VBox/param.h>
67	#include <VBox/vusb.h>
68	#include <VBox/mm.h>
69	#include <VBox/ssm.h>
70	#include <VBox/version.h>
71
72	#include <VBox/VBoxDev.h>
73
74	#include <VBox/HostServices/VBoxClipboardSvc.h>
75
76	#include <set>
77	#include <algorithm>
78	#include <memory> // for auto_ptr
79
80
81	// VMTask and friends
82	////////////////////////////////////////////////////////////////////////////////
83
84	/**
85	* Task structure for asynchronous VM operations.
86	*
87	* Once created, the task structure adds itself as a Console caller.
88	* This means:
89	*
90	* 1. The user must check for #rc() before using the created structure
91	* (e.g. passing it as a thread function argument). If #rc() returns a
92	* failure, the Console object may not be used by the task (see
93	Console::addCaller() for more details).
94	* 2. On successful initialization, the structure keeps the Console caller
95	* until destruction (to ensure Console remains in the Ready state and won't
96	* be accidentially uninitialized). Forgetting to delete the created task
97	* will lead to Console::uninit() stuck waiting for releasing all added
98	* callers.
99	*
100	* If \a aUsesVMPtr parameter is true, the task structure will also add itself
101	* as a Console::mpVM caller with the same meaning as above. See
102	* Console::addVMCaller() for more info.
103	*/
104	struct VMTask
105	{
106	VMTask (Console *aConsole, bool aUsesVMPtr)
107	: mConsole (aConsole), mCallerAdded (false), mVMCallerAdded (false)
108	{
109	AssertReturnVoid (aConsole);
110	mRC = aConsole->addCaller();
111	if (SUCCEEDED (mRC))
112	{
113	mCallerAdded = true;
114	if (aUsesVMPtr)
115	{
116	mRC = aConsole->addVMCaller();
117	if (SUCCEEDED (mRC))
118	mVMCallerAdded = true;
119	}
120	}
121	}
122
123	~VMTask()
124	{
125	if (mVMCallerAdded)
126	mConsole->releaseVMCaller();
127	if (mCallerAdded)
128	mConsole->releaseCaller();
129	}
130
131	HRESULT rc() const { return mRC; }
132	bool isOk() const { return SUCCEEDED (rc()); }
133
134	/** Releases the Console caller before destruction. Not normally necessary. */
135	void releaseCaller()
136	{
137	AssertReturnVoid (mCallerAdded);
138	mConsole->releaseCaller();
139	mCallerAdded = false;
140	}
141
142	/** Releases the VM caller before destruction. Not normally necessary. */
143	void releaseVMCaller()
144	{
145	AssertReturnVoid (mVMCallerAdded);
146	mConsole->releaseVMCaller();
147	mVMCallerAdded = false;
148	}
149
150	const ComObjPtr <Console> mConsole;
151
152	private:
153
154	HRESULT mRC;
155	bool mCallerAdded : 1;
156	bool mVMCallerAdded : 1;
157	};
158
159	struct VMProgressTask : public VMTask
160	{
161	VMProgressTask (Console aConsole, Progress aProgress, bool aUsesVMPtr)
162	: VMTask (aConsole, aUsesVMPtr), mProgress (aProgress) {}
163
164	const ComObjPtr <Progress> mProgress;
165	};
166
167	struct VMPowerUpTask : public VMProgressTask
168	{
169	VMPowerUpTask (Console aConsole, Progress aProgress)
170	: VMProgressTask (aConsole, aProgress, false /* aUsesVMPtr */)
171	, mSetVMErrorCallback (NULL), mConfigConstructor (NULL) {}
172
173	PFNVMATERROR mSetVMErrorCallback;
174	PFNCFGMCONSTRUCTOR mConfigConstructor;
175	Utf8Str mSavedStateFile;
176	std::map <Bstr, ComPtr <ISharedFolder> > mSharedFolders;
177	};
178
179	struct VMSaveTask : public VMProgressTask
180	{
181	VMSaveTask (Console aConsole, Progress aProgress)
182	: VMProgressTask (aConsole, aProgress, true /* aUsesVMPtr */)
183	, mIsSnapshot (false)
184	, mLastMachineState (MachineState_InvalidMachineState) {}
185
186	bool mIsSnapshot;
187	Utf8Str mSavedStateFile;
188	MachineState_T mLastMachineState;
189	ComPtr <IProgress> mServerProgress;
190	};
191
192
193	// constructor / desctructor
194	/////////////////////////////////////////////////////////////////////////////
195
196	Console::Console()
197	: mSavedStateDataLoaded (false)
198	, mConsoleVRDPServer (NULL)
199	, mpVM (NULL)
200	, mVMCallers (0)
201	, mVMZeroCallersSem (NIL_RTSEMEVENT)
202	, mVMDestroying (false)
203	, meDVDState (DriveState_NotMounted)
204	, meFloppyState (DriveState_NotMounted)
205	, mVMMDev (NULL)
206	, mAudioSniffer (NULL)
207	, mVMStateChangeCallbackDisabled (false)
208	, mMachineState (MachineState_PoweredOff)
209	{}
210
211	Console::~Console()
212	{}
213
214	HRESULT Console::FinalConstruct()
215	{
216	LogFlowThisFunc (("\n"));
217
218	memset(mapFDLeds, 0, sizeof(mapFDLeds));
219	memset(mapIDELeds, 0, sizeof(mapIDELeds));
220	memset(mapNetworkLeds, 0, sizeof(mapNetworkLeds));
221
222	#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
223	Assert(ELEMENTS(maTapFD) == ELEMENTS(maTAPDeviceName));
224	Assert(ELEMENTS(maTapFD) >= SchemaDefs::NetworkAdapterCount);
225	for (unsigned i = 0; i < ELEMENTS(maTapFD); i++)
226	{
227	maTapFD[i] = NIL_RTFILE;
228	maTAPDeviceName[i] = "";
229	}
230	#endif
231
232	return S_OK;
233	}
234
235	void Console::FinalRelease()
236	{
237	LogFlowThisFunc (("\n"));
238
239	uninit();
240	}
241
242	// public initializer/uninitializer for internal purposes only
243	/////////////////////////////////////////////////////////////////////////////
244
245	HRESULT Console::init (IMachine aMachine, IInternalMachineControl aControl)
246	{
247	AssertReturn (aMachine && aControl, E_INVALIDARG);
248
249	/* Enclose the state transition NotReady->InInit->Ready */
250	AutoInitSpan autoInitSpan (this);
251	AssertReturn (autoInitSpan.isOk(), E_UNEXPECTED);
252
253	LogFlowThisFuncEnter();
254	LogFlowThisFunc(("aMachine=%p, aControl=%p\n", aMachine, aControl));
255
256	HRESULT rc = E_FAIL;
257
258	unconst (mMachine) = aMachine;
259	unconst (mControl) = aControl;
260
261	/* Cache essential properties and objects */
262
263	rc = mMachine->COMGETTER(State) (&mMachineState);
264	AssertComRCReturn (rc, rc);
265
266	#ifdef VBOX_VRDP
267	rc = mMachine->COMGETTER(VRDPServer) (unconst (mVRDPServer).asOutParam());
268	AssertComRCReturn (rc, rc);
269	#endif
270
271	rc = mMachine->COMGETTER(DVDDrive) (unconst (mDVDDrive).asOutParam());
272	AssertComRCReturn (rc, rc);
273
274	rc = mMachine->COMGETTER(FloppyDrive) (unconst (mFloppyDrive).asOutParam());
275	AssertComRCReturn (rc, rc);
276
277	/* Create associated child COM objects */
278
279	unconst (mGuest).createObject();
280	rc = mGuest->init (this);
281	AssertComRCReturn (rc, rc);
282
283	unconst (mKeyboard).createObject();
284	rc = mKeyboard->init (this);
285	AssertComRCReturn (rc, rc);
286
287	unconst (mMouse).createObject();
288	rc = mMouse->init (this);
289	AssertComRCReturn (rc, rc);
290
291	unconst (mDisplay).createObject();
292	rc = mDisplay->init (this);
293	AssertComRCReturn (rc, rc);
294
295	unconst (mRemoteDisplayInfo).createObject();
296	rc = mRemoteDisplayInfo->init (this);
297	AssertComRCReturn (rc, rc);
298
299	/* Create other child objects */
300
301	unconst (mConsoleVRDPServer) = new ConsoleVRDPServer (this);
302	AssertReturn (mConsoleVRDPServer, E_FAIL);
303
304	#ifdef VRDP_MC
305	mcAudioRefs = 0;
306	mcVRDPClients = 0;
307	#endif /* VRDP_MC */
308
309	unconst (mVMMDev) = new VMMDev(this);
310	AssertReturn (mVMMDev, E_FAIL);
311
312	unconst (mAudioSniffer) = new AudioSniffer(this);
313	AssertReturn (mAudioSniffer, E_FAIL);
314
315	memset (&mCallbackData, 0, sizeof (mCallbackData));
316
317	/* Confirm a successful initialization when it's the case */
318	autoInitSpan.setSucceeded();
319
320	LogFlowThisFuncLeave();
321
322	return S_OK;
323	}
324
325	/**
326	* Uninitializes the Console object.
327	*/
328	void Console::uninit()
329	{
330	LogFlowThisFuncEnter();
331
332	/* Enclose the state transition Ready->InUninit->NotReady */
333	AutoUninitSpan autoUninitSpan (this);
334	if (autoUninitSpan.uninitDone())
335	{
336	LogFlowThisFunc (("Already uninitialized.\n"));
337	LogFlowThisFuncLeave();
338	return;
339	}
340
341	LogFlowThisFunc (("initFailed()=%d\n", autoUninitSpan.initFailed()));
342
343	/*
344	* Uninit all children that ise addDependentChild()/removeDependentChild()
345	* in their init()/uninit() methods.
346	*/
347	uninitDependentChildren();
348
349	/* This should be the first, since this may cause detaching remote USB devices. */
350	if (mConsoleVRDPServer)
351	{
352	delete mConsoleVRDPServer;
353	unconst (mConsoleVRDPServer) = NULL;
354	}
355
356	/* power down the VM if necessary */
357	if (mpVM)
358	{
359	powerDown();
360	Assert (mpVM == NULL);
361	}
362
363	if (mVMZeroCallersSem != NIL_RTSEMEVENT)
364	{
365	RTSemEventDestroy (mVMZeroCallersSem);
366	mVMZeroCallersSem = NIL_RTSEMEVENT;
367	}
368
369	if (mAudioSniffer)
370	{
371	delete mAudioSniffer;
372	unconst (mAudioSniffer) = NULL;
373	}
374
375	if (mVMMDev)
376	{
377	delete mVMMDev;
378	unconst (mVMMDev) = NULL;
379	}
380
381	mSharedFolders.clear();
382	mRemoteUSBDevices.clear();
383	mUSBDevices.clear();
384
385	if (mRemoteDisplayInfo)
386	{
387	mRemoteDisplayInfo->uninit();
388	unconst (mRemoteDisplayInfo).setNull();;
389	}
390
391	if (mDebugger)
392	{
393	mDebugger->uninit();
394	unconst (mDebugger).setNull();
395	}
396
397	if (mDisplay)
398	{
399	mDisplay->uninit();
400	unconst (mDisplay).setNull();
401	}
402
403	if (mMouse)
404	{
405	mMouse->uninit();
406	unconst (mMouse).setNull();
407	}
408
409	if (mKeyboard)
410	{
411	mKeyboard->uninit();
412	unconst (mKeyboard).setNull();;
413	}
414
415	if (mGuest)
416	{
417	mGuest->uninit();
418	unconst (mGuest).setNull();;
419	}
420
421	unconst (mFloppyDrive).setNull();
422	unconst (mDVDDrive).setNull();
423	#ifdef VBOX_VRDP
424	unconst (mVRDPServer).setNull();
425	#endif
426
427	unconst (mControl).setNull();
428	unconst (mMachine).setNull();
429
430	/* Release all callbacks. Do this after uninitializing the components,
431	* as some of them are well-behaved and unregister their callbacks.
432	* These would trigger error messages complaining about trying to
433	* unregister a non-registered callback. */
434	mCallbacks.clear();
435
436	/* dynamically allocated members of mCallbackData are uninitialized
437	* at the end of powerDown() */
438	Assert (!mCallbackData.mpsc.valid && mCallbackData.mpsc.shape == NULL);
439	Assert (!mCallbackData.mcc.valid);
440	Assert (!mCallbackData.klc.valid);
441
442	LogFlowThisFuncLeave();
443	}
444
445	#ifdef VRDP_MC
446	DECLCALLBACK(int) Console::vrdp_ClientLogon (void *pvUser,
447	uint32_t u32ClientId,
448	const char *pszUser,
449	const char *pszPassword,
450	const char *pszDomain)
451	#else
452	DECLCALLBACK(int) Console::vrdp_ClientLogon (void pvUser, const char pszUser,
453	const char *pszPassword,
454	const char *pszDomain)
455	#endif /* VRDP_MC */
456	{
457	LogFlowFuncEnter();
458	#ifdef VRDP_MC
459	LogFlowFunc (("%d, %s, %s, %s\n", u32ClientId, pszUser, pszPassword, pszDomain));
460	#else
461	uint32_t u32ClientId = 0;
462	LogFlowFunc (("%s, %s, %s\n", pszUser, pszPassword, pszDomain));
463	#endif /* VRDP_MC */
464
465	Console console = static_cast <Console > (pvUser);
466	AssertReturn (console, VERR_INVALID_POINTER);
467
468	AutoCaller autoCaller (console);
469	if (!autoCaller.isOk())
470	{
471	/* Console has been already uninitialized, deny request */
472	LogRel(("VRDPAUTH: Access denied (Console uninitialized).\n"));
473	LogFlowFuncLeave();
474	return VERR_ACCESS_DENIED;
475	}
476
477	Guid uuid;
478	HRESULT hrc = console->mMachine->COMGETTER (Id) (uuid.asOutParam());
479	AssertComRCReturn (hrc, VERR_ACCESS_DENIED);
480
481	VRDPAuthType_T authType = VRDPAuthType_VRDPAuthNull;
482	hrc = console->mVRDPServer->COMGETTER(AuthType) (&authType);
483	AssertComRCReturn (hrc, VERR_ACCESS_DENIED);
484
485	ULONG authTimeout = 0;
486	hrc = console->mVRDPServer->COMGETTER(AuthTimeout) (&authTimeout);
487	AssertComRCReturn (hrc, VERR_ACCESS_DENIED);
488
489	VRDPAuthResult result = VRDPAuthAccessDenied;
490	VRDPAuthGuestJudgement guestJudgement = VRDPAuthGuestNotAsked;
491
492	LogFlowFunc(("Auth type %d\n", authType));
493
494	LogRel (("VRDPAUTH: User: [%s]. Domain: [%s]. Authentication type: [%s]\n",
495	pszUser, pszDomain,
496	authType == VRDPAuthType_VRDPAuthNull?
497	"null":
498	(authType == VRDPAuthType_VRDPAuthExternal?
499	"external":
500	(authType == VRDPAuthType_VRDPAuthGuest?
501	"guest":
502	"INVALID"
503	)
504	)
505	));
506
507	/* Multiconnection check. */
508	BOOL allowMultiConnection = FALSE;
509	hrc = console->mVRDPServer->COMGETTER(AllowMultiConnection) (&allowMultiConnection);
510	AssertComRCReturn (hrc, VERR_ACCESS_DENIED);
511
512	LogFlowFunc(("allowMultiConnection %d, console->mcVRDPClients = %d\n", allowMultiConnection, console->mcVRDPClients));
513
514	if (allowMultiConnection == FALSE)
515	{
516	/* Note: the variable is incremented in ClientConnect callback, which is called when the client
517	* is successfully connected, that is after the ClientLogon callback. Therefore the mcVRDPClients
518	* value is 0 for first client.
519	*/
520	if (console->mcVRDPClients > 0)
521	{
522	/* Reject. */
523	LogRel(("VRDPAUTH: Multiple connections are not enabled. Access denied.\n"));
524	return VERR_ACCESS_DENIED;
525	}
526	}
527
528	switch (authType)
529	{
530	case VRDPAuthType_VRDPAuthNull:
531	{
532	result = VRDPAuthAccessGranted;
533	break;
534	}
535
536	case VRDPAuthType_VRDPAuthExternal:
537	{
538	/* Call the external library. */
539	result = console->mConsoleVRDPServer->Authenticate (uuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId);
540
541	if (result != VRDPAuthDelegateToGuest)
542	{
543	break;
544	}
545
546	LogRel(("VRDPAUTH: Delegated to guest.\n"));
547
548	LogFlowFunc (("External auth asked for guest judgement\n"));
549	} /* pass through */
550
551	case VRDPAuthType_VRDPAuthGuest:
552	{
553	guestJudgement = VRDPAuthGuestNotReacted;
554
555	if (console->mVMMDev)
556	{
557	/* Issue the request to guest. Assume that the call does not require EMT. It should not. */
558
559	/* Ask the guest to judge these credentials. */
560	uint32_t u32GuestFlags = VMMDEV_SETCREDENTIALS_JUDGE;
561
562	int rc = console->mVMMDev->getVMMDevPort()->pfnSetCredentials (console->mVMMDev->getVMMDevPort(),
563	pszUser, pszPassword, pszDomain, u32GuestFlags);
564
565	if (VBOX_SUCCESS (rc))
566	{
567	/* Wait for guest. */
568	rc = console->mVMMDev->WaitCredentialsJudgement (authTimeout, &u32GuestFlags);
569
570	if (VBOX_SUCCESS (rc))
571	{
572	switch (u32GuestFlags & (VMMDEV_CREDENTIALS_JUDGE_OK \| VMMDEV_CREDENTIALS_JUDGE_DENY \| VMMDEV_CREDENTIALS_JUDGE_NOJUDGEMENT))
573	{
574	case VMMDEV_CREDENTIALS_JUDGE_DENY: guestJudgement = VRDPAuthGuestAccessDenied; break;
575	case VMMDEV_CREDENTIALS_JUDGE_NOJUDGEMENT: guestJudgement = VRDPAuthGuestNoJudgement; break;
576	case VMMDEV_CREDENTIALS_JUDGE_OK: guestJudgement = VRDPAuthGuestAccessGranted; break;
577	default:
578	LogFlowFunc (("Invalid guest flags %08X!!!\n", u32GuestFlags)); break;
579	}
580	}
581	else
582	{
583	LogFlowFunc (("Wait for credentials judgement rc = %Vrc!!!\n", rc));
584	}
585
586	LogFlowFunc (("Guest judgement %d\n", guestJudgement));
587	}
588	else
589	{
590	LogFlowFunc (("Could not set credentials rc = %Vrc!!!\n", rc));
591	}
592	}
593
594	if (authType == VRDPAuthType_VRDPAuthExternal)
595	{
596	LogRel(("VRDPAUTH: Guest judgement %d.\n", guestJudgement));
597	LogFlowFunc (("External auth called again with guest judgement = %d\n", guestJudgement));
598	result = console->mConsoleVRDPServer->Authenticate (uuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId);
599	}
600	else
601	{
602	switch (guestJudgement)
603	{
604	case VRDPAuthGuestAccessGranted:
605	result = VRDPAuthAccessGranted;
606	break;
607	default:
608	result = VRDPAuthAccessDenied;
609	break;
610	}
611	}
612	} break;
613
614	default:
615	AssertFailed();
616	}
617
618	LogFlowFunc (("Result = %d\n", result));
619	LogFlowFuncLeave();
620
621	if (result == VRDPAuthAccessGranted)
622	{
623	LogRel(("VRDPAUTH: Access granted.\n"));
624	return VINF_SUCCESS;
625	}
626
627	/* Reject. */
628	LogRel(("VRDPAUTH: Access denied.\n"));
629	return VERR_ACCESS_DENIED;
630	}
631
632	#ifdef VRDP_MC
633	DECLCALLBACK(void) Console::vrdp_ClientConnect (void *pvUser,
634	uint32_t u32ClientId)
635	#else
636	DECLCALLBACK(void) Console::vrdp_ClientConnect (void *pvUser,
637	uint32_t fu32SupportedOrders)
638	#endif /* VRDP_MC */
639	{
640	LogFlowFuncEnter();
641
642	Console console = static_cast <Console > (pvUser);
643	AssertReturnVoid (console);
644
645	AutoCaller autoCaller (console);
646	AssertComRCReturnVoid (autoCaller.rc());
647
648	#ifdef VBOX_VRDP
649	#ifdef VRDP_MC
650	ASMAtomicIncU32(&console->mcVRDPClients);
651
652	NOREF(u32ClientId);
653	console->mDisplay->VideoAccelVRDP (true);
654	#else
655	console->mDisplay->VideoAccelVRDP (true, fu32SupportedOrders);
656	#endif /* VRDP_MC */
657	#endif /* VBOX_VRDP */
658
659	LogFlowFuncLeave();
660	return;
661	}
662
663	#ifdef VRDP_MC
664	DECLCALLBACK(void) Console::vrdp_ClientDisconnect (void *pvUser,
665	uint32_t u32ClientId,
666	uint32_t fu32Intercepted)
667	#else
668	DECLCALLBACK(void) Console::vrdp_ClientDisconnect (void *pvUser)
669	#endif /* VRDP_MC */
670	{
671	LogFlowFuncEnter();
672
673	Console console = static_cast <Console > (pvUser);
674	AssertReturnVoid (console);
675
676	AutoCaller autoCaller (console);
677	AssertComRCReturnVoid (autoCaller.rc());
678
679	AssertReturnVoid (console->mConsoleVRDPServer);
680
681	#ifdef VBOX_VRDP
682	#ifdef VRDP_MC
683	ASMAtomicDecU32(&console->mcVRDPClients);
684
685	console->mDisplay->VideoAccelVRDP (false);
686	#else
687	u32ClientId = 0;
688	console->mDisplay->VideoAccelVRDP (false, 0);
689	#endif /* VRDP_MC */
690	#endif /* VBOX_VRDP */
691
692	#ifdef VRDP_MC
693	if (fu32Intercepted & VRDP_CLIENT_INTERCEPT_USB)
694	{
695	console->mConsoleVRDPServer->USBBackendDelete (u32ClientId);
696	}
697	#else
698	console->mConsoleVRDPServer->DeleteUSBBackend ();
699	#endif /* VRDP_MC */
700
701	#ifdef VBOX_VRDP
702	#ifdef VRDP_MC
703	if (fu32Intercepted & VRDP_CLIENT_INTERCEPT_CLIPBOARD)
704	{
705	console->mConsoleVRDPServer->ClipboardDelete (u32ClientId);
706	}
707
708	if (fu32Intercepted & VRDP_CLIENT_INTERCEPT_AUDIO)
709	{
710	console->mcAudioRefs--;
711
712	if (console->mcAudioRefs <= 0)
713	{
714	if (console->mAudioSniffer)
715	{
716	PPDMIAUDIOSNIFFERPORT port = console->mAudioSniffer->getAudioSnifferPort();
717	if (port)
718	{
719	port->pfnSetup (port, false, false);
720	}
721	}
722	}
723	}
724	#else
725	if (console->mAudioSniffer)
726	{
727	PPDMIAUDIOSNIFFERPORT port = console->mAudioSniffer->getAudioSnifferPort();
728	if (port)
729	{
730	port->pfnSetup (port, false, false);
731	}
732	}
733	#endif /* VRDP_MC */
734	#endif /* VBOX_VRDP */
735
736	Guid uuid;
737	HRESULT hrc = console->mMachine->COMGETTER (Id) (uuid.asOutParam());
738	AssertComRC (hrc);
739
740	VRDPAuthType_T authType = VRDPAuthType_VRDPAuthNull;
741	hrc = console->mVRDPServer->COMGETTER(AuthType) (&authType);
742	AssertComRC (hrc);
743
744	if (authType == VRDPAuthType_VRDPAuthExternal)
745	console->mConsoleVRDPServer->AuthDisconnect (uuid, u32ClientId);
746
747	LogFlowFuncLeave();
748	return;
749	}
750
751	#ifdef VRDP_MC
752	DECLCALLBACK(void) Console::vrdp_InterceptAudio (void *pvUser,
753	uint32_t u32ClientId)
754	#else
755	DECLCALLBACK(void) Console::vrdp_InterceptAudio (void *pvUser, bool fKeepHostAudio)
756	#endif /* VRDP_MC */
757	{
758	LogFlowFuncEnter();
759
760	Console console = static_cast <Console > (pvUser);
761	AssertReturnVoid (console);
762
763	AutoCaller autoCaller (console);
764	AssertComRCReturnVoid (autoCaller.rc());
765
766	#ifdef VRDP_MC
767	LogFlowFunc (("mAudioSniffer %p, u32ClientId %d.\n",
768	console->mAudioSniffer, u32ClientId));
769	NOREF(u32ClientId);
770	#else
771	LogFlowFunc (("mAudioSniffer %p, keepHostAudio %d.\n",
772	console->mAudioSniffer, fKeepHostAudio));
773	#endif /* VRDP_MC */
774
775	#ifdef VBOX_VRDP
776	#ifdef VRDP_MC
777	console->mcAudioRefs++;
778
779	if (console->mcAudioRefs == 1)
780	{
781	if (console->mAudioSniffer)
782	{
783	PPDMIAUDIOSNIFFERPORT port = console->mAudioSniffer->getAudioSnifferPort();
784	if (port)
785	{
786	port->pfnSetup (port, true, true);
787	}
788	}
789	}
790	#else
791	if (console->mAudioSniffer)
792	{
793	PPDMIAUDIOSNIFFERPORT port = console->mAudioSniffer->getAudioSnifferPort();
794	if (port)
795	{
796	port->pfnSetup (port, true, !!fKeepHostAudio);
797	}
798	}
799	#endif /* VRDP_MC */
800	#endif
801
802	LogFlowFuncLeave();
803	return;
804	}
805
806	#ifdef VRDP_MC
807	DECLCALLBACK(void) Console::vrdp_InterceptUSB (void *pvUser,
808	uint32_t u32ClientId,
809	PFNVRDPUSBCALLBACK *ppfn,
810	void **ppv)
811	#else
812	DECLCALLBACK(void) Console::vrdp_InterceptUSB (void pvUser, PFNVRDPUSBCALLBACK ppfn, void **ppv)
813	#endif /* VRDP_MC */
814	{
815	LogFlowFuncEnter();
816
817	Console console = static_cast <Console > (pvUser);
818	AssertReturnVoid (console);
819
820	AutoCaller autoCaller (console);
821	AssertComRCReturnVoid (autoCaller.rc());
822
823	AssertReturnVoid (console->mConsoleVRDPServer);
824
825	#ifdef VRDP_MC
826	console->mConsoleVRDPServer->USBBackendCreate (u32ClientId, ppfn, ppv);
827	#else
828	console->mConsoleVRDPServer->CreateUSBBackend (ppfn, ppv);
829	#endif /* VRDP_MC */
830
831	LogFlowFuncLeave();
832	return;
833	}
834
835	#ifdef VRDP_MC
836	DECLCALLBACK(void) Console::vrdp_InterceptClipboard (void *pvUser,
837	uint32_t u32ClientId,
838	PFNVRDPCLIPBOARDCALLBACK *ppfn,
839	void **ppv)
840	{
841	LogFlowFuncEnter();
842
843	Console console = static_cast <Console > (pvUser);
844	AssertReturnVoid (console);
845
846	AutoCaller autoCaller (console);
847	AssertComRCReturnVoid (autoCaller.rc());
848
849	AssertReturnVoid (console->mConsoleVRDPServer);
850
851	#ifdef VBOX_VRDP
852	console->mConsoleVRDPServer->ClipboardCreate (u32ClientId, ppfn, ppv);
853	#endif /* VBOX_VRDP */
854
855	LogFlowFuncLeave();
856	return;
857	}
858	#else
859	DECLCALLBACK(void) Console::vrdp_InterceptClipboard (void *pvUser,
860	PFNVRDPCLIPBOARDCALLBACK *ppfn,
861	void **ppv)
862	{
863	/* Obsolete. */
864	return;
865	}
866	#endif /* VRDP_MC */
867
868
869	// static
870	VRDPSERVERCALLBACK Console::sVrdpServerCallback =
871	{
872	vrdp_ClientLogon,
873	vrdp_ClientConnect,
874	vrdp_ClientDisconnect,
875	vrdp_InterceptAudio,
876	vrdp_InterceptUSB,
877	vrdp_InterceptClipboard
878	};
879
880	//static
881	const char *Console::sSSMConsoleUnit = "ConsoleData";
882	//static
883	uint32_t Console::sSSMConsoleVer = 0x00010000;
884
885	/**
886	* Loads various console data stored in the saved state file.
887	* This method does validation of the state file and returns an error info
888	* when appropriate.
889	*
890	* The method does nothing if the machine is not in the Saved file or if
891	* console data from it has already been loaded.
892	*
893	* @note The caller must lock this object for writing.
894	*/
895	HRESULT Console::loadDataFromSavedState()
896	{
897	if (mMachineState != MachineState_Saved \|\| mSavedStateDataLoaded)
898	return S_OK;
899
900	Bstr savedStateFile;
901	HRESULT rc = mMachine->COMGETTER(StateFilePath) (savedStateFile.asOutParam());
902	if (FAILED (rc))
903	return rc;
904
905	PSSMHANDLE ssm;
906	int vrc = SSMR3Open (Utf8Str(savedStateFile), 0, &ssm);
907	if (VBOX_SUCCESS (vrc))
908	{
909	uint32_t version = 0;
910	vrc = SSMR3Seek (ssm, sSSMConsoleUnit, 0 /* iInstance */, &version);
911	if (version == sSSMConsoleVer)
912	{
913	if (VBOX_SUCCESS (vrc))
914	vrc = loadStateFileExec (ssm, this, 0);
915	else if (vrc == VERR_SSM_UNIT_NOT_FOUND)
916	vrc = VINF_SUCCESS;
917	}
918	else
919	vrc = VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
920
921	SSMR3Close (ssm);
922	}
923
924	if (VBOX_FAILURE (vrc))
925	rc = setError (E_FAIL,
926	tr ("The saved state file '%ls' is invalid (%Vrc). "
927	"Discard the saved state and try again"),
928	savedStateFile.raw(), vrc);
929
930	mSavedStateDataLoaded = true;
931
932	return rc;
933	}
934
935	/**
936	* Callback handler to save various console data to the state file,
937	* called when the user saves the VM state.
938	*
939	* @param pvUser pointer to Console
940	*
941	* @note Locks the Console object for reading.
942	*/
943	//static
944	DECLCALLBACK(void)
945	Console::saveStateFileExec (PSSMHANDLE pSSM, void *pvUser)
946	{
947	LogFlowFunc (("\n"));
948
949	Console that = static_cast <Console > (pvUser);
950	AssertReturnVoid (that);
951
952	AutoCaller autoCaller (that);
953	AssertComRCReturnVoid (autoCaller.rc());
954
955	AutoReaderLock alock (that);
956
957	int vrc = SSMR3PutU32 (pSSM, that->mSharedFolders.size());
958	AssertRC (vrc);
959
960	for (SharedFolderList::const_iterator it = that->mSharedFolders.begin();
961	it != that->mSharedFolders.end();
962	++ it)
963	{
964	ComObjPtr <SharedFolder> folder = (*it);
965	AutoLock folderLock (folder);
966
967	Utf8Str name = folder->name();
968	vrc = SSMR3PutU32 (pSSM, name.length() + 1 /* term. 0 */);
969	AssertRC (vrc);
970	vrc = SSMR3PutStrZ (pSSM, name);
971	AssertRC (vrc);
972
973	Utf8Str hostPath = folder->hostPath();
974	vrc = SSMR3PutU32 (pSSM, hostPath.length() + 1 /* term. 0 */);
975	AssertRC (vrc);
976	vrc = SSMR3PutStrZ (pSSM, hostPath);
977	AssertRC (vrc);
978	}
979
980	return;
981	}
982
983	/**
984	* Callback handler to load various console data from the state file.
985	* When \a u32Version is 0, this method is called from #loadDataFromSavedState,
986	* otherwise it is called when the VM is being restored from the saved state.
987	*
988	* @param pvUser pointer to Console
989	* @param u32Version Console unit version.
990	* When not 0, should match sSSMConsoleVer.
991	*
992	* @note Locks the Console object for writing.
993	*/
994	//static
995	DECLCALLBACK(int)
996	Console::loadStateFileExec (PSSMHANDLE pSSM, void *pvUser, uint32_t u32Version)
997	{
998	LogFlowFunc (("\n"));
999
1000	if (u32Version != 0 && u32Version != sSSMConsoleVer)
1001	return VERR_VERSION_MISMATCH;
1002
1003	if (u32Version != 0)
1004	{
1005	/* currently, nothing to do when we've been called from VMR3Load */
1006	return VINF_SUCCESS;
1007	}
1008
1009	Console that = static_cast <Console > (pvUser);
1010	AssertReturn (that, VERR_INVALID_PARAMETER);
1011
1012	AutoCaller autoCaller (that);
1013	AssertComRCReturn (autoCaller.rc(), VERR_ACCESS_DENIED);
1014
1015	AutoLock alock (that);
1016
1017	AssertReturn (that->mSharedFolders.size() == 0, VERR_INTERNAL_ERROR);
1018
1019	uint32_t size = 0;
1020	int vrc = SSMR3GetU32 (pSSM, &size);
1021	AssertRCReturn (vrc, vrc);
1022
1023	for (uint32_t i = 0; i < size; ++ i)
1024	{
1025	Bstr name;
1026	Bstr hostPath;
1027
1028	uint32_t szBuf = 0;
1029	char *buf = NULL;
1030
1031	vrc = SSMR3GetU32 (pSSM, &szBuf);
1032	AssertRCReturn (vrc, vrc);
1033	buf = new char [szBuf];
1034	vrc = SSMR3GetStrZ (pSSM, buf, szBuf);
1035	AssertRC (vrc);
1036	name = buf;
1037	delete[] buf;
1038
1039	vrc = SSMR3GetU32 (pSSM, &szBuf);
1040	AssertRCReturn (vrc, vrc);
1041	buf = new char [szBuf];
1042	vrc = SSMR3GetStrZ (pSSM, buf, szBuf);
1043	AssertRC (vrc);
1044	hostPath = buf;
1045	delete[] buf;
1046
1047	ComObjPtr <SharedFolder> sharedFolder;
1048	sharedFolder.createObject();
1049	HRESULT rc = sharedFolder->init (that, name, hostPath);
1050	AssertComRCReturn (rc, VERR_INTERNAL_ERROR);
1051	if (FAILED (rc))
1052	return rc;
1053
1054	that->mSharedFolders.push_back (sharedFolder);
1055	}
1056
1057	return VINF_SUCCESS;
1058	}
1059
1060	// IConsole properties
1061	/////////////////////////////////////////////////////////////////////////////
1062
1063	STDMETHODIMP Console::COMGETTER(Machine) (IMachine **aMachine)
1064	{
1065	if (!aMachine)
1066	return E_POINTER;
1067
1068	AutoCaller autoCaller (this);
1069	CheckComRCReturnRC (autoCaller.rc());
1070
1071	/* mMachine is constant during life time, no need to lock */
1072	mMachine.queryInterfaceTo (aMachine);
1073
1074	return S_OK;
1075	}
1076
1077	STDMETHODIMP Console::COMGETTER(State) (MachineState_T *aMachineState)
1078	{
1079	if (!aMachineState)
1080	return E_POINTER;
1081
1082	AutoCaller autoCaller (this);
1083	CheckComRCReturnRC (autoCaller.rc());
1084
1085	AutoReaderLock alock (this);
1086
1087	/* we return our local state (since it's always the same as on the server) */
1088	*aMachineState = mMachineState;
1089
1090	return S_OK;
1091	}
1092
1093	STDMETHODIMP Console::COMGETTER(Guest) (IGuest **aGuest)
1094	{
1095	if (!aGuest)
1096	return E_POINTER;
1097
1098	AutoCaller autoCaller (this);
1099	CheckComRCReturnRC (autoCaller.rc());
1100
1101	/* mGuest is constant during life time, no need to lock */
1102	mGuest.queryInterfaceTo (aGuest);
1103
1104	return S_OK;
1105	}
1106
1107	STDMETHODIMP Console::COMGETTER(Keyboard) (IKeyboard **aKeyboard)
1108	{
1109	if (!aKeyboard)
1110	return E_POINTER;
1111
1112	AutoCaller autoCaller (this);
1113	CheckComRCReturnRC (autoCaller.rc());
1114
1115	/* mKeyboard is constant during life time, no need to lock */
1116	mKeyboard.queryInterfaceTo (aKeyboard);
1117
1118	return S_OK;
1119	}
1120
1121	STDMETHODIMP Console::COMGETTER(Mouse) (IMouse **aMouse)
1122	{
1123	if (!aMouse)
1124	return E_POINTER;
1125
1126	AutoCaller autoCaller (this);
1127	CheckComRCReturnRC (autoCaller.rc());
1128
1129	/* mMouse is constant during life time, no need to lock */
1130	mMouse.queryInterfaceTo (aMouse);
1131
1132	return S_OK;
1133	}
1134
1135	STDMETHODIMP Console::COMGETTER(Display) (IDisplay **aDisplay)
1136	{
1137	if (!aDisplay)
1138	return E_POINTER;
1139
1140	AutoCaller autoCaller (this);
1141	CheckComRCReturnRC (autoCaller.rc());
1142
1143	/* mDisplay is constant during life time, no need to lock */
1144	mDisplay.queryInterfaceTo (aDisplay);
1145
1146	return S_OK;
1147	}
1148
1149	STDMETHODIMP Console::COMGETTER(Debugger) (IMachineDebugger **aDebugger)
1150	{
1151	if (!aDebugger)
1152	return E_POINTER;
1153
1154	AutoCaller autoCaller (this);
1155	CheckComRCReturnRC (autoCaller.rc());
1156
1157	/* we need a write lock because of the lazy mDebugger initialization*/
1158	AutoLock alock (this);
1159
1160	/* check if we have to create the debugger object */
1161	if (!mDebugger)
1162	{
1163	unconst (mDebugger).createObject();
1164	mDebugger->init (this);
1165	}
1166
1167	mDebugger.queryInterfaceTo (aDebugger);
1168
1169	return S_OK;
1170	}
1171
1172	STDMETHODIMP Console::COMGETTER(USBDevices) (IUSBDeviceCollection **aUSBDevices)
1173	{
1174	if (!aUSBDevices)
1175	return E_POINTER;
1176
1177	AutoCaller autoCaller (this);
1178	CheckComRCReturnRC (autoCaller.rc());
1179
1180	AutoReaderLock alock (this);
1181
1182	ComObjPtr <OUSBDeviceCollection> collection;
1183	collection.createObject();
1184	collection->init (mUSBDevices);
1185	collection.queryInterfaceTo (aUSBDevices);
1186
1187	return S_OK;
1188	}
1189
1190	STDMETHODIMP Console::COMGETTER(RemoteUSBDevices) (IHostUSBDeviceCollection **aRemoteUSBDevices)
1191	{
1192	if (!aRemoteUSBDevices)
1193	return E_POINTER;
1194
1195	AutoCaller autoCaller (this);
1196	CheckComRCReturnRC (autoCaller.rc());
1197
1198	AutoReaderLock alock (this);
1199
1200	ComObjPtr <RemoteUSBDeviceCollection> collection;
1201	collection.createObject();
1202	collection->init (mRemoteUSBDevices);
1203	collection.queryInterfaceTo (aRemoteUSBDevices);
1204
1205	return S_OK;
1206	}
1207
1208	STDMETHODIMP Console::COMGETTER(RemoteDisplayInfo) (IRemoteDisplayInfo **aRemoteDisplayInfo)
1209	{
1210	if (!aRemoteDisplayInfo)
1211	return E_POINTER;
1212
1213	AutoCaller autoCaller (this);
1214	CheckComRCReturnRC (autoCaller.rc());
1215
1216	/* mDisplay is constant during life time, no need to lock */
1217	mRemoteDisplayInfo.queryInterfaceTo (aRemoteDisplayInfo);
1218
1219	return S_OK;
1220	}
1221
1222	STDMETHODIMP
1223	Console::COMGETTER(SharedFolders) (ISharedFolderCollection **aSharedFolders)
1224	{
1225	if (!aSharedFolders)
1226	return E_POINTER;
1227
1228	AutoCaller autoCaller (this);
1229	CheckComRCReturnRC (autoCaller.rc());
1230
1231	/* loadDataFromSavedState() needs a write lock */
1232	AutoLock alock (this);
1233
1234	/* Read console data stored in the saved state file (if not yet done) */
1235	HRESULT rc = loadDataFromSavedState();
1236	CheckComRCReturnRC (rc);
1237
1238	ComObjPtr <SharedFolderCollection> coll;
1239	coll.createObject();
1240	coll->init (mSharedFolders);
1241	coll.queryInterfaceTo (aSharedFolders);
1242
1243	return S_OK;
1244	}
1245
1246	// IConsole methods
1247	/////////////////////////////////////////////////////////////////////////////
1248
1249	STDMETHODIMP Console::PowerUp (IProgress **aProgress)
1250	{
1251	LogFlowThisFuncEnter();
1252	LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
1253
1254	AutoCaller autoCaller (this);
1255	CheckComRCReturnRC (autoCaller.rc());
1256
1257	AutoLock alock (this);
1258
1259	if (mMachineState >= MachineState_Running)
1260	return setError(E_FAIL, tr ("Cannot power up the machine as it is already running. (Machine state: %d)"), mMachineState);
1261
1262	/*
1263	* First check whether all disks are accessible. This is not a 100%
1264	* bulletproof approach (race condition, it might become inaccessible
1265	* right after the check) but it's convenient as it will cover 99.9%
1266	* of the cases and here, we're able to provide meaningful error
1267	* information.
1268	*/
1269	ComPtr<IHardDiskAttachmentCollection> coll;
1270	mMachine->COMGETTER(HardDiskAttachments)(coll.asOutParam());
1271	ComPtr<IHardDiskAttachmentEnumerator> enumerator;
1272	coll->Enumerate(enumerator.asOutParam());
1273	BOOL fHasMore;
1274	while (SUCCEEDED(enumerator->HasMore(&fHasMore)) && fHasMore)
1275	{
1276	ComPtr<IHardDiskAttachment> attach;
1277	enumerator->GetNext(attach.asOutParam());
1278	ComPtr<IHardDisk> hdd;
1279	attach->COMGETTER(HardDisk)(hdd.asOutParam());
1280	Assert(hdd);
1281	BOOL fAccessible;
1282	HRESULT rc = hdd->COMGETTER(AllAccessible)(&fAccessible);
1283	CheckComRCReturnRC (rc);
1284	if (!fAccessible)
1285	{
1286	Bstr loc;
1287	hdd->COMGETTER(Location) (loc.asOutParam());
1288	Bstr errMsg;
1289	hdd->COMGETTER(LastAccessError) (errMsg.asOutParam());
1290	return setError (E_FAIL,
1291	tr ("VM cannot start because the hard disk '%ls' is not accessible "
1292	"(%ls)"),
1293	loc.raw(), errMsg.raw());
1294	}
1295	}
1296
1297	/* now perform the same check if a ISO is mounted */
1298	ComPtr<IDVDDrive> dvdDrive;
1299	mMachine->COMGETTER(DVDDrive)(dvdDrive.asOutParam());
1300	ComPtr<IDVDImage> dvdImage;
1301	dvdDrive->GetImage(dvdImage.asOutParam());
1302	if (dvdImage)
1303	{
1304	BOOL fAccessible;
1305	HRESULT rc = dvdImage->COMGETTER(Accessible)(&fAccessible);
1306	CheckComRCReturnRC (rc);
1307	if (!fAccessible)
1308	{
1309	Bstr filePath;
1310	dvdImage->COMGETTER(FilePath)(filePath.asOutParam());
1311	/// @todo (r=dmik) grab the last access error once
1312	// IDVDImage::lastAccessError is there
1313	return setError (E_FAIL,
1314	tr ("VM cannot start because the DVD image '%ls' is not accessible"),
1315	filePath.raw());
1316	}
1317	}
1318
1319	/* now perform the same check if a floppy is mounted */
1320	ComPtr<IFloppyDrive> floppyDrive;
1321	mMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
1322	ComPtr<IFloppyImage> floppyImage;
1323	floppyDrive->GetImage(floppyImage.asOutParam());
1324	if (floppyImage)
1325	{
1326	BOOL fAccessible;
1327	HRESULT rc = floppyImage->COMGETTER(Accessible)(&fAccessible);
1328	CheckComRCReturnRC (rc);
1329	if (!fAccessible)
1330	{
1331	Bstr filePath;
1332	floppyImage->COMGETTER(FilePath)(filePath.asOutParam());
1333	/// @todo (r=dmik) grab the last access error once
1334	// IDVDImage::lastAccessError is there
1335	return setError (E_FAIL,
1336	tr ("VM cannot start because the floppy image '%ls' is not accessible"),
1337	filePath.raw());
1338	}
1339	}
1340
1341	/* now the network cards will undergo a quick consistency check */
1342	for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
1343	{
1344	ComPtr<INetworkAdapter> adapter;
1345	mMachine->GetNetworkAdapter (slot, adapter.asOutParam());
1346	BOOL enabled = FALSE;
1347	adapter->COMGETTER(Enabled) (&enabled);
1348	if (!enabled)
1349	continue;
1350
1351	NetworkAttachmentType_T netattach;
1352	adapter->COMGETTER(AttachmentType)(&netattach);
1353	switch (netattach)
1354	{
1355	case NetworkAttachmentType_HostInterfaceNetworkAttachment:
1356	{
1357	#ifdef __WIN__
1358	/* a valid host interface must have been set */
1359	Bstr hostif;
1360	adapter->COMGETTER(HostInterface)(hostif.asOutParam());
1361	if (!hostif)
1362	{
1363	return setError (E_FAIL,
1364	tr ("VM cannot start because host interface networking "
1365	"requires a host interface name to be set"));
1366	}
1367	ComPtr<IVirtualBox> virtualBox;
1368	mMachine->COMGETTER(Parent)(virtualBox.asOutParam());
1369	ComPtr<IHost> host;
1370	virtualBox->COMGETTER(Host)(host.asOutParam());
1371	ComPtr<IHostNetworkInterfaceCollection> coll;
1372	host->COMGETTER(NetworkInterfaces)(coll.asOutParam());
1373	ComPtr<IHostNetworkInterface> hostInterface;
1374	if (!SUCCEEDED(coll->FindByName(hostif, hostInterface.asOutParam())))
1375	{
1376	return setError (E_FAIL,
1377	tr ("VM cannot start because the host interface '%ls' "
1378	"does not exist"),
1379	hostif.raw());
1380	}
1381	#endif /* __WIN__ */
1382	break;
1383	}
1384	default:
1385	break;
1386	}
1387	}
1388
1389	/* Read console data stored in the saved state file (if not yet done) */
1390	{
1391	HRESULT rc = loadDataFromSavedState();
1392	CheckComRCReturnRC (rc);
1393	}
1394
1395	/* Check all types of shared folders and compose a single list */
1396	std::map <Bstr, ComPtr <ISharedFolder> > sharedFolders;
1397	{
1398	/// @todo (dmik) check and add globally shared folders when they are
1399	// done
1400
1401	ComPtr <ISharedFolderCollection> coll;
1402	HRESULT rc = mMachine->COMGETTER(SharedFolders) (coll.asOutParam());
1403	CheckComRCReturnRC (rc);
1404	ComPtr <ISharedFolderEnumerator> en;
1405	rc = coll->Enumerate (en.asOutParam());
1406	CheckComRCReturnRC (rc);
1407
1408	BOOL hasMore = FALSE;
1409	while (SUCCEEDED (en->HasMore (&hasMore)) && hasMore)
1410	{
1411	ComPtr <ISharedFolder> folder;
1412	en->GetNext (folder.asOutParam());
1413
1414	Bstr name;
1415	rc = folder->COMGETTER(Name) (name.asOutParam());
1416	CheckComRCReturnRC (rc);
1417
1418	BOOL accessible = FALSE;
1419	rc = folder->COMGETTER(Accessible) (&accessible);
1420	CheckComRCReturnRC (rc);
1421
1422	if (!accessible)
1423	{
1424	Bstr hostPath;
1425	folder->COMGETTER(HostPath) (hostPath.asOutParam());
1426	return setError (E_FAIL,
1427	tr ("Host path '%ls' of the shared folder '%ls' is not accessible"),
1428	hostPath.raw(), name.raw());
1429	}
1430
1431	sharedFolders.insert (std::make_pair (name, folder));
1432	/// @todo (dmik) later, do this:
1433	// if (!sharedFolders.insert (std::pair <name, folder>).second)
1434	// return setError (E_FAIL,
1435	// tr ("Could not accept a permanently shared folder named '%ls' "
1436	// "because a globally shared folder with the same name "
1437	// "already exists"),
1438	// name.raw());
1439	}
1440
1441	for (SharedFolderList::const_iterator it = mSharedFolders.begin();
1442	it != mSharedFolders.end(); ++ it)
1443	{
1444	ComPtr <ISharedFolder> folder = static_cast <SharedFolder > (it);
1445
1446	if (!sharedFolders.insert (std::make_pair ((*it)->name(), folder)).second)
1447	return setError (E_FAIL,
1448	tr ("Could not create a transient shared folder named '%ls' "
1449	"because a global or a permanent shared folder with "
1450	"the same name already exists"),
1451	(*it)->name().raw());
1452	}
1453	}
1454
1455	Bstr savedStateFile;
1456
1457	/*
1458	* Saved VMs will have to prove that their saved states are kosher.
1459	*/
1460	if (mMachineState == MachineState_Saved)
1461	{
1462	HRESULT rc = mMachine->COMGETTER(StateFilePath) (savedStateFile.asOutParam());
1463	CheckComRCReturnRC (rc);
1464	ComAssertRet (!!savedStateFile, E_FAIL);
1465	int vrc = SSMR3ValidateFile (Utf8Str (savedStateFile));
1466	if (VBOX_FAILURE (vrc))
1467	return setError (E_FAIL,
1468	tr ("VM cannot start because the saved state file '%ls' is invalid (%Vrc). "
1469	"Discard the saved state prior to starting the VM"),
1470	savedStateFile.raw(), vrc);
1471	}
1472
1473	/* create an IProgress object to track progress of this operation */
1474	ComObjPtr <Progress> progress;
1475	progress.createObject();
1476	Bstr progressDesc;
1477	if (mMachineState == MachineState_Saved)
1478	progressDesc = tr ("Restoring the virtual machine");
1479	else
1480	progressDesc = tr ("Starting the virtual machine");
1481	progress->init ((IConsole ) this, progressDesc, FALSE / aCancelable */);
1482
1483	/* pass reference to caller if requested */
1484	if (aProgress)
1485	progress.queryInterfaceTo (aProgress);
1486
1487	/* setup task object and thread to carry out the operation asynchronously */
1488	std::auto_ptr <VMPowerUpTask> task (new VMPowerUpTask (this, progress));
1489	ComAssertComRCRetRC (task->rc());
1490
1491	task->mSetVMErrorCallback = setVMErrorCallback;
1492	task->mConfigConstructor = configConstructor;
1493	task->mSharedFolders = sharedFolders;
1494	if (mMachineState == MachineState_Saved)
1495	task->mSavedStateFile = savedStateFile;
1496
1497	int vrc = RTThreadCreate (NULL, Console::powerUpThread, (void *) task.get(),
1498	0, RTTHREADTYPE_MAIN_WORKER, 0, "VMPowerUp");
1499
1500	ComAssertMsgRCRet (vrc, ("Could not create VMPowerUp thread (%Vrc)\n", vrc),
1501	E_FAIL);
1502
1503	/* task is now owned by powerUpThread(), so release it */
1504	task.release();
1505
1506	if (mMachineState == MachineState_Saved)
1507	setMachineState (MachineState_Restoring);
1508	else
1509	setMachineState (MachineState_Starting);
1510
1511	LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
1512	LogFlowThisFuncLeave();
1513	return S_OK;
1514	}
1515
1516	STDMETHODIMP Console::PowerDown()
1517	{
1518	LogFlowThisFuncEnter();
1519	LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
1520
1521	AutoCaller autoCaller (this);
1522	CheckComRCReturnRC (autoCaller.rc());
1523
1524	AutoLock alock (this);
1525
1526	if (mMachineState != MachineState_Running &&
1527	mMachineState != MachineState_Paused)
1528	{
1529	/* extra nice error message for a common case */
1530	if (mMachineState == MachineState_Saved)
1531	return setError(E_FAIL, tr ("Cannot power off a saved machine"));
1532	else
1533	return setError(E_FAIL, tr ("Cannot power off the machine as it is not running or paused. (Machine state: %d)"), mMachineState);
1534	}
1535
1536	LogFlowThisFunc (("Sending SHUTDOWN request...\n"));
1537
1538	HRESULT rc = powerDown();
1539
1540	LogFlowThisFunc (("mMachineState=%d, rc=%08X\n", mMachineState, rc));
1541	LogFlowThisFuncLeave();
1542	return rc;
1543	}
1544
1545	STDMETHODIMP Console::Reset()
1546	{
1547	LogFlowThisFuncEnter();
1548	LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
1549
1550	AutoCaller autoCaller (this);
1551	CheckComRCReturnRC (autoCaller.rc());
1552
1553	AutoLock alock (this);
1554
1555	if (mMachineState != MachineState_Running)
1556	return setError(E_FAIL, tr ("Cannot reset the machine as it is not running. (Machine state: %d)"), mMachineState);
1557
1558	/* protect mpVM */
1559	AutoVMCaller autoVMCaller (this);
1560	CheckComRCReturnRC (autoVMCaller.rc());
1561
1562	/* leave the lock before a VMR3* call (EMT will call us back)! */
1563	alock.leave();
1564
1565	int vrc = VMR3Reset (mpVM);
1566
1567	HRESULT rc = VBOX_SUCCESS (vrc) ? S_OK :
1568	setError (E_FAIL, tr ("Could not reset the machine. (Error: %Vrc)"), vrc);
1569
1570	LogFlowThisFunc (("mMachineState=%d, rc=%08X\n", mMachineState, rc));
1571	LogFlowThisFuncLeave();
1572	return rc;
1573	}
1574
1575	STDMETHODIMP Console::Pause()
1576	{
1577	LogFlowThisFuncEnter();
1578
1579	AutoCaller autoCaller (this);
1580	CheckComRCReturnRC (autoCaller.rc());
1581
1582	AutoLock alock (this);
1583
1584	if (mMachineState != MachineState_Running)
1585	return setError (E_FAIL, tr ("Cannot pause the machine as it is not running. (Machine state: %d)"), mMachineState);
1586
1587	/* protect mpVM */
1588	AutoVMCaller autoVMCaller (this);
1589	CheckComRCReturnRC (autoVMCaller.rc());
1590
1591	LogFlowThisFunc (("Sending PAUSE request...\n"));
1592
1593	/* leave the lock before a VMR3* call (EMT will call us back)! */
1594	alock.leave();
1595
1596	int vrc = VMR3Suspend (mpVM);
1597
1598	HRESULT rc = VBOX_SUCCESS (vrc) ? S_OK :
1599	setError (E_FAIL,
1600	tr ("Could not suspend the machine execution. (Error: %Vrc)"), vrc);
1601
1602	LogFlowThisFunc (("rc=%08X\n", rc));
1603	LogFlowThisFuncLeave();
1604	return rc;
1605	}
1606
1607	STDMETHODIMP Console::Resume()
1608	{
1609	LogFlowThisFuncEnter();
1610
1611	AutoCaller autoCaller (this);
1612	CheckComRCReturnRC (autoCaller.rc());
1613
1614	AutoLock alock (this);
1615
1616	if (mMachineState != MachineState_Paused)
1617	return setError (E_FAIL, tr ("Cannot resume the machine as it is not paused. (Machine state: %d)"), mMachineState);
1618
1619	/* protect mpVM */
1620	AutoVMCaller autoVMCaller (this);
1621	CheckComRCReturnRC (autoVMCaller.rc());
1622
1623	LogFlowThisFunc (("Sending RESUME request...\n"));
1624
1625	/* leave the lock before a VMR3* call (EMT will call us back)! */
1626	alock.leave();
1627
1628	int vrc = VMR3Resume (mpVM);
1629
1630	HRESULT rc = VBOX_SUCCESS (vrc) ? S_OK :
1631	setError (E_FAIL,
1632	tr ("Could not resume the machine execution. (Error: %Vrc)"), vrc);
1633
1634	LogFlowThisFunc (("rc=%08X\n", rc));
1635	LogFlowThisFuncLeave();
1636	return rc;
1637	}
1638
1639	STDMETHODIMP Console::PowerButton()
1640	{
1641	LogFlowThisFuncEnter();
1642
1643	AutoCaller autoCaller (this);
1644	CheckComRCReturnRC (autoCaller.rc());
1645
1646	AutoLock lock (this);
1647
1648	if (mMachineState != MachineState_Running)
1649	return setError (E_FAIL, tr ("Cannot power off the machine as it is not running. (Machine state: %d)"), mMachineState);
1650
1651	/* protect mpVM */
1652	AutoVMCaller autoVMCaller (this);
1653	CheckComRCReturnRC (autoVMCaller.rc());
1654
1655	PPDMIBASE pBase;
1656	int vrc = PDMR3QueryDeviceLun (mpVM, "acpi", 0, 0, &pBase);
1657	if (VBOX_SUCCESS (vrc))
1658	{
1659	Assert (pBase);
1660	PPDMIACPIPORT pPort =
1661	(PPDMIACPIPORT) pBase->pfnQueryInterface(pBase, PDMINTERFACE_ACPI_PORT);
1662	vrc = pPort ? pPort->pfnPowerButtonPress(pPort) : VERR_INVALID_POINTER;
1663	}
1664
1665	HRESULT rc = VBOX_SUCCESS (vrc) ? S_OK :
1666	setError (E_FAIL,
1667	tr ("Controlled power off failed. (Error: %Vrc)"), vrc);
1668
1669	LogFlowThisFunc (("rc=%08X\n", rc));
1670	LogFlowThisFuncLeave();
1671	return rc;
1672	}
1673
1674	STDMETHODIMP Console::SaveState (IProgress **aProgress)
1675	{
1676	LogFlowThisFuncEnter();
1677	LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
1678
1679	if (!aProgress)
1680	return E_POINTER;
1681
1682	AutoCaller autoCaller (this);
1683	CheckComRCReturnRC (autoCaller.rc());
1684
1685	AutoLock alock (this);
1686
1687	if (mMachineState != MachineState_Running &&
1688	mMachineState != MachineState_Paused)
1689	{
1690	return setError (E_FAIL,
1691	tr ("Cannot save the execution state as the machine "
1692	"is not running (machine state: %d)"), mMachineState);
1693	}
1694
1695	/* memorize the current machine state */
1696	MachineState_T lastMachineState = mMachineState;
1697
1698	if (mMachineState == MachineState_Running)
1699	{
1700	HRESULT rc = Pause();
1701	CheckComRCReturnRC (rc);
1702	}
1703
1704	HRESULT rc = S_OK;
1705
1706	/* create a progress object to track operation completion */
1707	ComObjPtr <Progress> progress;
1708	progress.createObject();
1709	progress->init ((IConsole *) this,
1710	Bstr (tr ("Saving the execution state of the virtual machine")),
1711	FALSE /* aCancelable */);
1712
1713	bool beganSavingState = false;
1714	bool taskCreationFailed = false;
1715
1716	do
1717	{
1718	/* create a task object early to ensure mpVM protection is successful */
1719	std::auto_ptr <VMSaveTask> task (new VMSaveTask (this, progress));
1720	rc = task->rc();
1721	/*
1722	* If we fail here it means a PowerDown() call happened on another
1723	* thread while we were doing Pause() (which leaves the Console lock).
1724	* We assign PowerDown() a higher precendence than SaveState(),
1725	* therefore just return the error to the caller.
1726	*/
1727	if (FAILED (rc))
1728	{
1729	taskCreationFailed = true;
1730	break;
1731	}
1732
1733	Bstr stateFilePath;
1734
1735	/*
1736	* request a saved state file path from the server
1737	* (this will set the machine state to Saving on the server to block
1738	* others from accessing this machine)
1739	*/
1740	rc = mControl->BeginSavingState (progress, stateFilePath.asOutParam());
1741	CheckComRCBreakRC (rc);
1742
1743	beganSavingState = true;
1744
1745	/* sync the state with the server */
1746	setMachineStateLocally (MachineState_Saving);
1747
1748	/* ensure the directory for the saved state file exists */
1749	{
1750	Utf8Str dir = stateFilePath;
1751	RTPathStripFilename (dir.mutableRaw());
1752	if (!RTDirExists (dir))
1753	{
1754	int vrc = RTDirCreateFullPath (dir, 0777);
1755	if (VBOX_FAILURE (vrc))
1756	{
1757	rc = setError (E_FAIL,
1758	tr ("Could not create a directory '%s' to save the state to. (Error: %Vrc)"),
1759	dir.raw(), vrc);
1760	break;
1761	}
1762	}
1763	}
1764
1765	/* setup task object and thread to carry out the operation asynchronously */
1766	task->mIsSnapshot = false;
1767	task->mSavedStateFile = stateFilePath;
1768	/* set the state the operation thread will restore when it is finished */
1769	task->mLastMachineState = lastMachineState;
1770
1771	/* create a thread to wait until the VM state is saved */
1772	int vrc = RTThreadCreate (NULL, Console::saveStateThread, (void *) task.get(),
1773	0, RTTHREADTYPE_MAIN_WORKER, 0, "VMSave");
1774
1775	ComAssertMsgRCBreak (vrc, ("Could not create VMSave thread (%Vrc)\n", vrc),
1776	rc = E_FAIL);
1777
1778	/* task is now owned by saveStateThread(), so release it */
1779	task.release();
1780
1781	/* return the progress to the caller */
1782	progress.queryInterfaceTo (aProgress);
1783	}
1784	while (0);
1785
1786	if (FAILED (rc) && !taskCreationFailed)
1787	{
1788	/* preserve existing error info */
1789	ErrorInfoKeeper eik;
1790
1791	if (beganSavingState)
1792	{
1793	/*
1794	* cancel the requested save state procedure.
1795	* This will reset the machine state to the state it had right
1796	* before calling mControl->BeginSavingState().
1797	*/
1798	mControl->EndSavingState (FALSE);
1799	}
1800
1801	if (lastMachineState == MachineState_Running)
1802	{
1803	/* restore the paused state if appropriate */
1804	setMachineStateLocally (MachineState_Paused);
1805	/* restore the running state if appropriate */
1806	Resume();
1807	}
1808	else
1809	setMachineStateLocally (lastMachineState);
1810	}
1811
1812	LogFlowThisFunc (("rc=%08X\n", rc));
1813	LogFlowThisFuncLeave();
1814	return rc;
1815	}
1816
1817	STDMETHODIMP Console::DiscardSavedState()
1818	{
1819	AutoCaller autoCaller (this);
1820	CheckComRCReturnRC (autoCaller.rc());
1821
1822	AutoLock alock (this);
1823
1824	if (mMachineState != MachineState_Saved)
1825	return setError (E_FAIL,
1826	tr ("Cannot discard the machine state as the machine is not in the saved state. (Machine state: %d"), mMachineState);
1827
1828	/*
1829	* Saved -> PoweredOff transition will be detected in the SessionMachine
1830	* and properly handled.
1831	*/
1832	setMachineState (MachineState_PoweredOff);
1833
1834	return S_OK;
1835	}
1836
1837	/** read the value of a LEd. */
1838	inline uint32_t readAndClearLed(PPDMLED pLed)
1839	{
1840	if (!pLed)
1841	return 0;
1842	uint32_t u32 = pLed->Actual.u32 \| pLed->Asserted.u32;
1843	pLed->Asserted.u32 = 0;
1844	return u32;
1845	}
1846
1847	STDMETHODIMP Console::GetDeviceActivity (DeviceType_T aDeviceType,
1848	DeviceActivity_T *aDeviceActivity)
1849	{
1850	if (!aDeviceActivity)
1851	return E_INVALIDARG;
1852
1853	AutoCaller autoCaller (this);
1854	CheckComRCReturnRC (autoCaller.rc());
1855
1856	/*
1857	* Note: we don't lock the console object here because
1858	* readAndClearLed() should be thread safe.
1859	*/
1860
1861	/* Get LED array to read */
1862	PDMLEDCORE SumLed = {0};
1863	switch (aDeviceType)
1864	{
1865	case DeviceType_FloppyDevice:
1866	{
1867	for (unsigned i = 0; i < ELEMENTS(mapFDLeds); i++)
1868	SumLed.u32 \|= readAndClearLed(mapFDLeds[i]);
1869	break;
1870	}
1871
1872	case DeviceType_DVDDevice:
1873	{
1874	SumLed.u32 \|= readAndClearLed(mapIDELeds[2]);
1875	break;
1876	}
1877
1878	case DeviceType_HardDiskDevice:
1879	{
1880	SumLed.u32 \|= readAndClearLed(mapIDELeds[0]);
1881	SumLed.u32 \|= readAndClearLed(mapIDELeds[1]);
1882	SumLed.u32 \|= readAndClearLed(mapIDELeds[3]);
1883	break;
1884	}
1885
1886	case DeviceType_NetworkDevice:
1887	{
1888	for (unsigned i = 0; i < ELEMENTS(mapNetworkLeds); i++)
1889	SumLed.u32 \|= readAndClearLed(mapNetworkLeds[i]);
1890	break;
1891	}
1892
1893	case DeviceType_USBDevice:
1894	{
1895	/// @todo (r=dmik)
1896	// USB_DEVICE_ACTIVITY
1897	break;
1898	}
1899
1900	default:
1901	return setError (E_INVALIDARG,
1902	tr ("Invalid device type: %d"), aDeviceType);
1903	}
1904
1905	/* Compose the result */
1906	switch (SumLed.u32 & (PDMLED_READING \| PDMLED_WRITING))
1907	{
1908	case 0:
1909	*aDeviceActivity = DeviceActivity_DeviceIdle;
1910	break;
1911	case PDMLED_READING:
1912	*aDeviceActivity = DeviceActivity_DeviceReading;
1913	break;
1914	case PDMLED_WRITING:
1915	case PDMLED_READING \| PDMLED_WRITING:
1916	*aDeviceActivity = DeviceActivity_DeviceWriting;
1917	break;
1918	}
1919
1920	return S_OK;
1921	}
1922
1923	STDMETHODIMP Console::AttachUSBDevice (INPTR GUIDPARAM aId)
1924	{
1925	AutoCaller autoCaller (this);
1926	CheckComRCReturnRC (autoCaller.rc());
1927
1928	AutoLock alock (this);
1929
1930	/// @todo (r=dmik) is it legal to attach USB devices when the machine is
1931	// Paused, Starting, Saving, Stopping, etc? if not, we should make a
1932	// stricter check (mMachineState != MachineState_Running).
1933	if (mMachineState < MachineState_Running)
1934	return setError (E_FAIL,
1935	tr ("Cannot attach a USB device to a machine which is not running "
1936	"(machine state: %d)"), mMachineState);
1937
1938	/* protect mpVM */
1939	AutoVMCaller autoVMCaller (this);
1940	CheckComRCReturnRC (autoVMCaller.rc());
1941
1942	/* Don't proceed unless we've found the usb controller. */
1943	PPDMIBASE pBase = NULL;
1944	int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
1945	if (VBOX_FAILURE (vrc))
1946	return setError (E_FAIL,
1947	tr ("The virtual machine does not have a USB controller"));
1948
1949	/* leave the lock because the USB Proxy service may call us back
1950	* (via onUSBDeviceAttach()) */
1951	alock.leave();
1952
1953	/* Request the device capture */
1954	HRESULT rc = mControl->CaptureUSBDevice (aId);
1955	CheckComRCReturnRC (rc);
1956
1957	return rc;
1958	}
1959
1960	STDMETHODIMP Console::DetachUSBDevice (INPTR GUIDPARAM aId, IUSBDevice **aDevice)
1961	{
1962	if (!aDevice)
1963	return E_POINTER;
1964
1965	AutoCaller autoCaller (this);
1966	CheckComRCReturnRC (autoCaller.rc());
1967
1968	AutoLock alock (this);
1969
1970	/* Find it. */
1971	ComObjPtr <OUSBDevice> device;
1972	USBDeviceList::iterator it = mUSBDevices.begin();
1973	while (it != mUSBDevices.end())
1974	{
1975	if ((*it)->id() == aId)
1976	{
1977	device = *it;
1978	break;
1979	}
1980	++ it;
1981	}
1982
1983	if (!device)
1984	return setError (E_INVALIDARG,
1985	tr ("USB device with UUID {%Vuuid} is not attached to this machine"),
1986	Guid (aId).raw());
1987
1988	/* First, request VMM to detach the device */
1989	HRESULT rc = detachUSBDevice (it);
1990
1991	if (SUCCEEDED (rc))
1992	{
1993	/* leave the lock since we don't need it any more (note though that
1994	* the USB Proxy service must not call us back here) */
1995	alock.leave();
1996
1997	/* Request the device release. Even if it fails, the device will
1998	* remain as held by proxy, which is OK for us (the VM process). */
1999	rc = mControl->ReleaseUSBDevice (aId);
2000	}
2001
2002	return rc;
2003	}
2004
2005	STDMETHODIMP
2006	Console::CreateSharedFolder (INPTR BSTR aName, INPTR BSTR aHostPath)
2007	{
2008	if (!aName \|\| !aHostPath)
2009	return E_INVALIDARG;
2010
2011	AutoCaller autoCaller (this);
2012	CheckComRCReturnRC (autoCaller.rc());
2013
2014	AutoLock alock (this);
2015
2016	if (mMachineState == MachineState_Saved)
2017	return setError (E_FAIL,
2018	tr ("Cannot create a transient shared folder on a "
2019	"machine in the saved state."));
2020
2021	/// @todo (dmik) check globally shared folders when they are done
2022
2023	/* check machine's shared folders */
2024	{
2025	ComPtr <ISharedFolderCollection> coll;
2026	HRESULT rc = mMachine->COMGETTER(SharedFolders) (coll.asOutParam());
2027	if (FAILED (rc))
2028	return rc;
2029
2030	ComPtr <ISharedFolder> machineSharedFolder;
2031	rc = coll->FindByName (aName, machineSharedFolder.asOutParam());
2032	if (SUCCEEDED (rc))
2033	return setError (E_FAIL,
2034	tr ("A permanent shared folder named '%ls' already "
2035	"exists."), aName);
2036	}
2037
2038	ComObjPtr <SharedFolder> sharedFolder;
2039	HRESULT rc = findSharedFolder (aName, sharedFolder, false /* aSetError */);
2040	if (SUCCEEDED (rc))
2041	return setError (E_FAIL,
2042	tr ("A shared folder named '%ls' already exists."), aName);
2043
2044	sharedFolder.createObject();
2045	rc = sharedFolder->init (this, aName, aHostPath);
2046	CheckComRCReturnRC (rc);
2047
2048	BOOL accessible = FALSE;
2049	rc = sharedFolder->COMGETTER(Accessible) (&accessible);
2050	CheckComRCReturnRC (rc);
2051
2052	if (!accessible)
2053	return setError (E_FAIL,
2054	tr ("The shared folder path '%ls' on the host is not accessible."), aHostPath);
2055
2056	/// @todo (r=sander?) should move this into the shared folder class */
2057	if (mpVM && mVMMDev->isShFlActive())
2058	{
2059	/*
2060	* if the VM is online and supports shared folders, share this folder
2061	* under the specified name. On error, return it to the caller.
2062	*/
2063
2064	/* protect mpVM */
2065	AutoVMCaller autoVMCaller (this);
2066	CheckComRCReturnRC (autoVMCaller.rc());
2067
2068	VBOXHGCMSVCPARM parms[2];
2069	SHFLSTRING pFolderName, pMapName;
2070	int cbString;
2071
2072	Log(("Add shared folder %ls -> %ls\n", aName, aHostPath));
2073
2074	cbString = (RTStrUcs2Len(aHostPath) + 1) * sizeof(RTUCS2);
2075	pFolderName = (SHFLSTRING *)RTMemAllocZ(sizeof(SHFLSTRING) + cbString);
2076	Assert(pFolderName);
2077	memcpy(pFolderName->String.ucs2, aHostPath, cbString);
2078
2079	pFolderName->u16Size = cbString;
2080	pFolderName->u16Length = cbString - sizeof(RTUCS2);
2081
2082	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2083	parms[0].u.pointer.addr = pFolderName;
2084	parms[0].u.pointer.size = sizeof(SHFLSTRING) + cbString;
2085
2086	cbString = (RTStrUcs2Len(aName) + 1) * sizeof(RTUCS2);
2087	pMapName = (SHFLSTRING *)RTMemAllocZ(sizeof(SHFLSTRING) + cbString);
2088	Assert(pMapName);
2089	memcpy(pMapName->String.ucs2, aName, cbString);
2090
2091	pMapName->u16Size = cbString;
2092	pMapName->u16Length = cbString - sizeof(RTUCS2);
2093
2094	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
2095	parms[1].u.pointer.addr = pMapName;
2096	parms[1].u.pointer.size = sizeof(SHFLSTRING) + cbString;
2097
2098	rc = mVMMDev->hgcmHostCall("VBoxSharedFolders", SHFL_FN_ADD_MAPPING, 2, &parms[0]);
2099	RTMemFree(pFolderName);
2100	RTMemFree(pMapName);
2101	if (rc != VINF_SUCCESS)
2102	return setError (E_FAIL, tr ("Unable to add mapping %ls to %ls."), aHostPath, aName);
2103	}
2104
2105	mSharedFolders.push_back (sharedFolder);
2106	return S_OK;
2107	}
2108
2109	STDMETHODIMP Console::RemoveSharedFolder (INPTR BSTR aName)
2110	{
2111	if (!aName)
2112	return E_INVALIDARG;
2113
2114	AutoCaller autoCaller (this);
2115	CheckComRCReturnRC (autoCaller.rc());
2116
2117	AutoLock alock (this);
2118
2119	if (mMachineState == MachineState_Saved)
2120	return setError (E_FAIL,
2121	tr ("Cannot remove a transient shared folder when the "
2122	"machine is in the saved state."));
2123
2124	ComObjPtr <SharedFolder> sharedFolder;
2125	HRESULT rc = findSharedFolder (aName, sharedFolder, true /* aSetError */);
2126	CheckComRCReturnRC (rc);
2127
2128	/* protect mpVM */
2129	AutoVMCaller autoVMCaller (this);
2130	CheckComRCReturnRC (autoVMCaller.rc());
2131
2132	if (mpVM && mVMMDev->isShFlActive())
2133	{
2134	/*
2135	* if the VM is online and supports shared folders, UNshare this folder.
2136	* On error, return it to the caller.
2137	*/
2138	VBOXHGCMSVCPARM parms;
2139	SHFLSTRING *pMapName;
2140	int cbString;
2141
2142	cbString = (RTStrUcs2Len(aName) + 1) * sizeof(RTUCS2);
2143	pMapName = (SHFLSTRING *)RTMemAllocZ(sizeof(SHFLSTRING) + cbString);
2144	Assert(pMapName);
2145	memcpy(pMapName->String.ucs2, aName, cbString);
2146
2147	pMapName->u16Size = cbString;
2148	pMapName->u16Length = cbString - sizeof(RTUCS2);
2149
2150	parms.type = VBOX_HGCM_SVC_PARM_PTR;
2151	parms.u.pointer.addr = pMapName;
2152	parms.u.pointer.size = sizeof(SHFLSTRING) + cbString;
2153
2154	rc = mVMMDev->hgcmHostCall("VBoxSharedFolders", SHFL_FN_REMOVE_MAPPING, 1, &parms);
2155	RTMemFree(pMapName);
2156	if (rc != VINF_SUCCESS)
2157	rc = setError (E_FAIL, tr ("Unable to remove the mapping %ls."), aName);
2158	}
2159
2160	mSharedFolders.remove (sharedFolder);
2161	return rc;
2162	}
2163
2164	STDMETHODIMP Console::TakeSnapshot (INPTR BSTR aName, INPTR BSTR aDescription,
2165	IProgress **aProgress)
2166	{
2167	LogFlowThisFuncEnter();
2168	LogFlowThisFunc (("aName='%ls' mMachineState=%08X\n", aName, mMachineState));
2169
2170	if (!aName)
2171	return E_INVALIDARG;
2172	if (!aProgress)
2173	return E_POINTER;
2174
2175	AutoCaller autoCaller (this);
2176	CheckComRCReturnRC (autoCaller.rc());
2177
2178	AutoLock alock (this);
2179
2180	if (mMachineState > MachineState_Running &&
2181	mMachineState != MachineState_Paused)
2182	{
2183	return setError (E_FAIL,
2184	tr ("Cannot take a snapshot of a machine while it is changing state. (Machine state: %d)"), mMachineState);
2185	}
2186
2187	/* memorize the current machine state */
2188	MachineState_T lastMachineState = mMachineState;
2189
2190	if (mMachineState == MachineState_Running)
2191	{
2192	HRESULT rc = Pause();
2193	CheckComRCReturnRC (rc);
2194	}
2195
2196	HRESULT rc = S_OK;
2197
2198	bool takingSnapshotOnline = mMachineState == MachineState_Paused;
2199
2200	/*
2201	* create a descriptionless VM-side progress object
2202	* (only when creating a snapshot online)
2203	*/
2204	ComObjPtr <Progress> saveProgress;
2205	if (takingSnapshotOnline)
2206	{
2207	saveProgress.createObject();
2208	rc = saveProgress->init (FALSE, 1, Bstr (tr ("Saving the execution state")));
2209	AssertComRCReturn (rc, rc);
2210	}
2211
2212	bool beganTakingSnapshot = false;
2213	bool taskCreationFailed = false;
2214
2215	do
2216	{
2217	/* create a task object early to ensure mpVM protection is successful */
2218	std::auto_ptr <VMSaveTask> task;
2219	if (takingSnapshotOnline)
2220	{
2221	task.reset (new VMSaveTask (this, saveProgress));
2222	rc = task->rc();
2223	/*
2224	* If we fail here it means a PowerDown() call happened on another
2225	* thread while we were doing Pause() (which leaves the Console lock).
2226	* We assign PowerDown() a higher precendence than TakeSnapshot(),
2227	* therefore just return the error to the caller.
2228	*/
2229	if (FAILED (rc))
2230	{
2231	taskCreationFailed = true;
2232	break;
2233	}
2234	}
2235
2236	Bstr stateFilePath;
2237	ComPtr <IProgress> serverProgress;
2238
2239	/*
2240	* request taking a new snapshot object on the server
2241	* (this will set the machine state to Saving on the server to block
2242	* others from accessing this machine)
2243	*/
2244	rc = mControl->BeginTakingSnapshot (this, aName, aDescription,
2245	saveProgress, stateFilePath.asOutParam(),
2246	serverProgress.asOutParam());
2247	if (FAILED (rc))
2248	break;
2249
2250	/*
2251	* state file is non-null only when the VM is paused
2252	* (i.e. createing a snapshot online)
2253	*/
2254	ComAssertBreak (
2255	(!stateFilePath.isNull() && takingSnapshotOnline) \|\|
2256	(stateFilePath.isNull() && !takingSnapshotOnline),
2257	rc = E_FAIL);
2258
2259	beganTakingSnapshot = true;
2260
2261	/* sync the state with the server */
2262	setMachineStateLocally (MachineState_Saving);
2263
2264	/*
2265	* create a combined VM-side progress object and start the save task
2266	* (only when creating a snapshot online)
2267	*/
2268	ComObjPtr <CombinedProgress> combinedProgress;
2269	if (takingSnapshotOnline)
2270	{
2271	combinedProgress.createObject();
2272	rc = combinedProgress->init ((IConsole *) this,
2273	Bstr (tr ("Taking snapshot of virtual machine")),
2274	serverProgress, saveProgress);
2275	AssertComRCBreakRC (rc);
2276
2277	/* setup task object and thread to carry out the operation asynchronously */
2278	task->mIsSnapshot = true;
2279	task->mSavedStateFile = stateFilePath;
2280	task->mServerProgress = serverProgress;
2281	/* set the state the operation thread will restore when it is finished */
2282	task->mLastMachineState = lastMachineState;
2283
2284	/* create a thread to wait until the VM state is saved */
2285	int vrc = RTThreadCreate (NULL, Console::saveStateThread, (void *) task.get(),
2286	0, RTTHREADTYPE_MAIN_WORKER, 0, "VMTakeSnap");
2287
2288	ComAssertMsgRCBreak (vrc, ("Could not create VMTakeSnap thread (%Vrc)\n", vrc),
2289	rc = E_FAIL);
2290
2291	/* task is now owned by saveStateThread(), so release it */
2292	task.release();
2293	}
2294
2295	if (SUCCEEDED (rc))
2296	{
2297	/* return the correct progress to the caller */
2298	if (combinedProgress)
2299	combinedProgress.queryInterfaceTo (aProgress);
2300	else
2301	serverProgress.queryInterfaceTo (aProgress);
2302	}
2303	}
2304	while (0);
2305
2306	if (FAILED (rc) && !taskCreationFailed)
2307	{
2308	/* preserve existing error info */
2309	ErrorInfoKeeper eik;
2310
2311	if (beganTakingSnapshot && takingSnapshotOnline)
2312	{
2313	/*
2314	* cancel the requested snapshot (only when creating a snapshot
2315	* online, otherwise the server will cancel the snapshot itself).
2316	* This will reset the machine state to the state it had right
2317	* before calling mControl->BeginTakingSnapshot().
2318	*/
2319	mControl->EndTakingSnapshot (FALSE);
2320	}
2321
2322	if (lastMachineState == MachineState_Running)
2323	{
2324	/* restore the paused state if appropriate */
2325	setMachineStateLocally (MachineState_Paused);
2326	/* restore the running state if appropriate */
2327	Resume();
2328	}
2329	else
2330	setMachineStateLocally (lastMachineState);
2331	}
2332
2333	LogFlowThisFunc (("rc=%08X\n", rc));
2334	LogFlowThisFuncLeave();
2335	return rc;
2336	}
2337
2338	STDMETHODIMP Console::DiscardSnapshot (INPTR GUIDPARAM aId, IProgress **aProgress)
2339	{
2340	if (Guid (aId).isEmpty())
2341	return E_INVALIDARG;
2342	if (!aProgress)
2343	return E_POINTER;
2344
2345	AutoCaller autoCaller (this);
2346	CheckComRCReturnRC (autoCaller.rc());
2347
2348	AutoLock alock (this);
2349
2350	if (mMachineState >= MachineState_Running)
2351	return setError (E_FAIL,
2352	tr ("Cannot discard a snapshot on a running machine (Machine state: %d)"), mMachineState);
2353
2354	MachineState_T machineState = MachineState_InvalidMachineState;
2355	HRESULT rc = mControl->DiscardSnapshot (this, aId, &machineState, aProgress);
2356	CheckComRCReturnRC (rc);
2357
2358	setMachineStateLocally (machineState);
2359	return S_OK;
2360	}
2361
2362	STDMETHODIMP Console::DiscardCurrentState (IProgress **aProgress)
2363	{
2364	AutoCaller autoCaller (this);
2365	CheckComRCReturnRC (autoCaller.rc());
2366
2367	AutoLock alock (this);
2368
2369	if (mMachineState >= MachineState_Running)
2370	return setError (E_FAIL,
2371	tr ("Cannot discard the current state of a running machine. (Machine state: %d)"), mMachineState);
2372
2373	MachineState_T machineState = MachineState_InvalidMachineState;
2374	HRESULT rc = mControl->DiscardCurrentState (this, &machineState, aProgress);
2375	CheckComRCReturnRC (rc);
2376
2377	setMachineStateLocally (machineState);
2378	return S_OK;
2379	}
2380
2381	STDMETHODIMP Console::DiscardCurrentSnapshotAndState (IProgress **aProgress)
2382	{
2383	AutoCaller autoCaller (this);
2384	CheckComRCReturnRC (autoCaller.rc());
2385
2386	AutoLock alock (this);
2387
2388	if (mMachineState >= MachineState_Running)
2389	return setError (E_FAIL,
2390	tr ("Cannot discard the current snapshot and state on a running machine. (Machine state: %d)"), mMachineState);
2391
2392	MachineState_T machineState = MachineState_InvalidMachineState;
2393	HRESULT rc =
2394	mControl->DiscardCurrentSnapshotAndState (this, &machineState, aProgress);
2395	CheckComRCReturnRC (rc);
2396
2397	setMachineStateLocally (machineState);
2398	return S_OK;
2399	}
2400
2401	STDMETHODIMP Console::RegisterCallback (IConsoleCallback *aCallback)
2402	{
2403	if (!aCallback)
2404	return E_INVALIDARG;
2405
2406	AutoCaller autoCaller (this);
2407	CheckComRCReturnRC (autoCaller.rc());
2408
2409	AutoLock alock (this);
2410
2411	mCallbacks.push_back (CallbackList::value_type (aCallback));
2412
2413	/* Inform the callback about the current status (for example, the new
2414	* callback must know the current mouse capabilities and the pointer
2415	* shape in order to properly integrate the mouse pointer). */
2416
2417	if (mCallbackData.mpsc.valid)
2418	aCallback->OnMousePointerShapeChange (mCallbackData.mpsc.visible,
2419	mCallbackData.mpsc.alpha,
2420	mCallbackData.mpsc.xHot,
2421	mCallbackData.mpsc.yHot,
2422	mCallbackData.mpsc.width,
2423	mCallbackData.mpsc.height,
2424	mCallbackData.mpsc.shape);
2425	if (mCallbackData.mcc.valid)
2426	aCallback->OnMouseCapabilityChange (mCallbackData.mcc.supportsAbsolute,
2427	mCallbackData.mcc.needsHostCursor);
2428
2429	aCallback->OnAdditionsStateChange();
2430
2431	if (mCallbackData.klc.valid)
2432	aCallback->OnKeyboardLedsChange (mCallbackData.klc.numLock,
2433	mCallbackData.klc.capsLock,
2434	mCallbackData.klc.scrollLock);
2435
2436	/* Note: we don't call OnStateChange for new callbacks because the
2437	* machine state is a) not actually changed on callback registration
2438	* and b) can be always queried from Console. */
2439
2440	return S_OK;
2441	}
2442
2443	STDMETHODIMP Console::UnregisterCallback (IConsoleCallback *aCallback)
2444	{
2445	if (!aCallback)
2446	return E_INVALIDARG;
2447
2448	AutoCaller autoCaller (this);
2449	CheckComRCReturnRC (autoCaller.rc());
2450
2451	AutoLock alock (this);
2452
2453	CallbackList::iterator it;
2454	it = std::find (mCallbacks.begin(),
2455	mCallbacks.end(),
2456	CallbackList::value_type (aCallback));
2457	if (it == mCallbacks.end())
2458	return setError (E_INVALIDARG,
2459	tr ("The given callback handler is not registered"));
2460
2461	mCallbacks.erase (it);
2462	return S_OK;
2463	}
2464
2465	// Non-interface public methods
2466	/////////////////////////////////////////////////////////////////////////////
2467
2468	/**
2469	* Called by IInternalSessionControl::OnDVDDriveChange().
2470	*
2471	* @note Locks this object for reading.
2472	*/
2473	HRESULT Console::onDVDDriveChange()
2474	{
2475	LogFlowThisFunc (("\n"));
2476
2477	AutoCaller autoCaller (this);
2478	AssertComRCReturnRC (autoCaller.rc());
2479
2480	AutoReaderLock alock (this);
2481
2482	/* Ignore callbacks when there's no VM around */
2483	if (!mpVM)
2484	return S_OK;
2485
2486	/* protect mpVM */
2487	AutoVMCaller autoVMCaller (this);
2488	CheckComRCReturnRC (autoVMCaller.rc());
2489
2490	/* Get the current DVD state */
2491	HRESULT rc;
2492	DriveState_T eState;
2493
2494	rc = mDVDDrive->COMGETTER (State) (&eState);
2495	ComAssertComRCRetRC (rc);
2496
2497	/* Paranoia */
2498	if ( eState == DriveState_NotMounted
2499	&& meDVDState == DriveState_NotMounted)
2500	{
2501	LogFlowThisFunc (("Returns (NotMounted -> NotMounted)\n"));
2502	return S_OK;
2503	}
2504
2505	/* Get the path string and other relevant properties */
2506	Bstr Path;
2507	bool fPassthrough = false;
2508	switch (eState)
2509	{
2510	case DriveState_ImageMounted:
2511	{
2512	ComPtr <IDVDImage> ImagePtr;
2513	rc = mDVDDrive->GetImage (ImagePtr.asOutParam());
2514	if (SUCCEEDED (rc))
2515	rc = ImagePtr->COMGETTER(FilePath) (Path.asOutParam());
2516	break;
2517	}
2518
2519	case DriveState_HostDriveCaptured:
2520	{
2521	ComPtr <IHostDVDDrive> DrivePtr;
2522	BOOL enabled;
2523	rc = mDVDDrive->GetHostDrive (DrivePtr.asOutParam());
2524	if (SUCCEEDED (rc))
2525	rc = DrivePtr->COMGETTER (Name) (Path.asOutParam());
2526	if (SUCCEEDED (rc))
2527	rc = mDVDDrive->COMGETTER (Passthrough) (&enabled);
2528	if (SUCCEEDED (rc))
2529	fPassthrough = !!enabled;
2530	break;
2531	}
2532
2533	case DriveState_NotMounted:
2534	break;
2535
2536	default:
2537	AssertMsgFailed (("Invalid DriveState: %d\n", eState));
2538	rc = E_FAIL;
2539	break;
2540	}
2541
2542	AssertComRC (rc);
2543	if (FAILED (rc))
2544	{
2545	LogFlowThisFunc (("Returns %#x\n", rc));
2546	return rc;
2547	}
2548
2549	return doDriveChange ("piix3ide", 0, 2, eState, &meDVDState,
2550	Utf8Str (Path).raw(), fPassthrough);
2551	}
2552
2553
2554	/**
2555	* Called by IInternalSessionControl::OnFloppyDriveChange().
2556	*
2557	* @note Locks this object for reading.
2558	*/
2559	HRESULT Console::onFloppyDriveChange()
2560	{
2561	LogFlowThisFunc (("\n"));
2562
2563	AutoCaller autoCaller (this);
2564	AssertComRCReturnRC (autoCaller.rc());
2565
2566	AutoReaderLock alock (this);
2567
2568	/* Ignore callbacks when there's no VM around */
2569	if (!mpVM)
2570	return S_OK;
2571
2572	/* protect mpVM */
2573	AutoVMCaller autoVMCaller (this);
2574	CheckComRCReturnRC (autoVMCaller.rc());
2575
2576	/* Get the current floppy state */
2577	HRESULT rc;
2578	DriveState_T eState;
2579
2580	/* If the floppy drive is disabled, we're not interested */
2581	BOOL fEnabled;
2582	rc = mFloppyDrive->COMGETTER (Enabled) (&fEnabled);
2583	ComAssertComRCRetRC (rc);
2584
2585	if (!fEnabled)
2586	return S_OK;
2587
2588	rc = mFloppyDrive->COMGETTER (State) (&eState);
2589	ComAssertComRCRetRC (rc);
2590
2591	Log2 (("onFloppyDriveChange: eState=%d meFloppyState=%d\n", eState, meFloppyState));
2592
2593
2594	/* Paranoia */
2595	if ( eState == DriveState_NotMounted
2596	&& meFloppyState == DriveState_NotMounted)
2597	{
2598	LogFlowThisFunc (("Returns (NotMounted -> NotMounted)\n"));
2599	return S_OK;
2600	}
2601
2602	/* Get the path string and other relevant properties */
2603	Bstr Path;
2604	switch (eState)
2605	{
2606	case DriveState_ImageMounted:
2607	{
2608	ComPtr <IFloppyImage> ImagePtr;
2609	rc = mFloppyDrive->GetImage (ImagePtr.asOutParam());
2610	if (SUCCEEDED (rc))
2611	rc = ImagePtr->COMGETTER(FilePath) (Path.asOutParam());
2612	break;
2613	}
2614
2615	case DriveState_HostDriveCaptured:
2616	{
2617	ComPtr <IHostFloppyDrive> DrivePtr;
2618	rc = mFloppyDrive->GetHostDrive (DrivePtr.asOutParam());
2619	if (SUCCEEDED (rc))
2620	rc = DrivePtr->COMGETTER (Name) (Path.asOutParam());
2621	break;
2622	}
2623
2624	case DriveState_NotMounted:
2625	break;
2626
2627	default:
2628	AssertMsgFailed (("Invalid DriveState: %d\n", eState));
2629	rc = E_FAIL;
2630	break;
2631	}
2632
2633	AssertComRC (rc);
2634	if (FAILED (rc))
2635	{
2636	LogFlowThisFunc (("Returns %#x\n", rc));
2637	return rc;
2638	}
2639
2640	return doDriveChange ("i82078", 0, 0, eState, &meFloppyState,
2641	Utf8Str (Path).raw(), false);
2642	}
2643
2644
2645	/**
2646	* Process a floppy or dvd change.
2647	*
2648	* @returns COM status code.
2649	*
2650	* @param pszDevice The PDM device name.
2651	* @param uInstance The PDM device instance.
2652	* @param uLun The PDM LUN number of the drive.
2653	* @param eState The new state.
2654	* @param peState Pointer to the variable keeping the actual state of the drive.
2655	* This will be both read and updated to eState or other appropriate state.
2656	* @param pszPath The path to the media / drive which is now being mounted / captured.
2657	* If NULL no media or drive is attached and the lun will be configured with
2658	* the default block driver with no media. This will also be the state if
2659	* mounting / capturing the specified media / drive fails.
2660	* @param fPassthrough Enables using passthrough mode of the host DVD drive if applicable.
2661	*
2662	* @note Locks this object for reading.
2663	*/
2664	HRESULT Console::doDriveChange (const char *pszDevice, unsigned uInstance, unsigned uLun, DriveState_T eState,
2665	DriveState_T peState, const char pszPath, bool fPassthrough)
2666	{
2667	LogFlowThisFunc (("pszDevice=%p:{%s} uInstance=%u uLun=%u eState=%d "
2668	"peState=%p:{%d} pszPath=%p:{%s} fPassthrough=%d\n",
2669	pszDevice, pszDevice, uInstance, uLun, eState,
2670	peState, *peState, pszPath, pszPath, fPassthrough));
2671
2672	AutoCaller autoCaller (this);
2673	AssertComRCReturnRC (autoCaller.rc());
2674
2675	AutoReaderLock alock (this);
2676
2677	/* protect mpVM */
2678	AutoVMCaller autoVMCaller (this);
2679	CheckComRCReturnRC (autoVMCaller.rc());
2680
2681	/*
2682	* Call worker in EMT, that's faster and safer than doing everything
2683	* using VM3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
2684	* here to make requests from under the lock in order to serialize them.
2685	*/
2686	PVMREQ pReq;
2687	int vrc = VMR3ReqCall (mpVM, &pReq, 0 /* no wait! */,
2688	(PFNRT) Console::changeDrive, 8,
2689	this, pszDevice, uInstance, uLun, eState, peState,
2690	pszPath, fPassthrough);
2691	/// @todo (r=dmik) bird, it would be nice to have a special VMR3Req method
2692	// for that purpose, that doesn't return useless VERR_TIMEOUT
2693	if (vrc == VERR_TIMEOUT)
2694	vrc = VINF_SUCCESS;
2695
2696	/* leave the lock before waiting for a result (EMT will call us back!) */
2697	alock.leave();
2698
2699	if (VBOX_SUCCESS (vrc))
2700	{
2701	vrc = VMR3ReqWait (pReq, RT_INDEFINITE_WAIT);
2702	AssertRC (vrc);
2703	if (VBOX_SUCCESS (vrc))
2704	vrc = pReq->iStatus;
2705	}
2706	VMR3ReqFree (pReq);
2707
2708	if (VBOX_SUCCESS (vrc))
2709	{
2710	LogFlowThisFunc (("Returns S_OK\n"));
2711	return S_OK;
2712	}
2713
2714	if (pszPath)
2715	return setError (E_FAIL,
2716	tr ("Could not mount the media/drive '%s' (%Vrc)"), pszPath, vrc);
2717
2718	return setError (E_FAIL,
2719	tr ("Could not unmount the currently mounted media/drive (%Vrc)"), vrc);
2720	}
2721
2722
2723	/**
2724	* Performs the Floppy/DVD change in EMT.
2725	*
2726	* @returns VBox status code.
2727	*
2728	* @param pThis Pointer to the Console object.
2729	* @param pszDevice The PDM device name.
2730	* @param uInstance The PDM device instance.
2731	* @param uLun The PDM LUN number of the drive.
2732	* @param eState The new state.
2733	* @param peState Pointer to the variable keeping the actual state of the drive.
2734	* This will be both read and updated to eState or other appropriate state.
2735	* @param pszPath The path to the media / drive which is now being mounted / captured.
2736	* If NULL no media or drive is attached and the lun will be configured with
2737	* the default block driver with no media. This will also be the state if
2738	* mounting / capturing the specified media / drive fails.
2739	* @param fPassthrough Enables using passthrough mode of the host DVD drive if applicable.
2740	*
2741	* @thread EMT
2742	* @note Locks the Console object for writing
2743	*/
2744	DECLCALLBACK(int) Console::changeDrive (Console pThis, const char pszDevice, unsigned uInstance, unsigned uLun,
2745	DriveState_T eState, DriveState_T *peState,
2746	const char *pszPath, bool fPassthrough)
2747	{
2748	LogFlowFunc (("pThis=%p pszDevice=%p:{%s} uInstance=%u uLun=%u eState=%d "
2749	"peState=%p:{%d} pszPath=%p:{%s} fPassthrough=%d\n",
2750	pThis, pszDevice, pszDevice, uInstance, uLun, eState,
2751	peState, *peState, pszPath, pszPath, fPassthrough));
2752
2753	AssertReturn (pThis, VERR_INVALID_PARAMETER);
2754
2755	AssertMsg ( (!strcmp (pszDevice, "i82078") && uLun == 0 && uInstance == 0)
2756	\|\| (!strcmp (pszDevice, "piix3ide") && uLun == 2 && uInstance == 0),
2757	("pszDevice=%s uLun=%d uInstance=%d\n", pszDevice, uLun, uInstance));
2758
2759	AutoCaller autoCaller (pThis);
2760	AssertComRCReturn (autoCaller.rc(), VERR_ACCESS_DENIED);
2761
2762	/*
2763	* Locking the object before doing VMR3* calls is quite safe here,
2764	* since we're on EMT. Write lock is necessary because we're indirectly
2765	* modify the meDVDState/meFloppyState members (pointed to by peState).
2766	*/
2767	AutoLock alock (pThis);
2768
2769	/* protect mpVM */
2770	AutoVMCaller autoVMCaller (pThis);
2771	CheckComRCReturnRC (autoVMCaller.rc());
2772
2773	PVM pVM = pThis->mpVM;
2774
2775	/*
2776	* Suspend the VM first.
2777	*
2778	* The VM must not be running since it might have pending I/O to
2779	* the drive which is being changed.
2780	*/
2781	bool fResume;
2782	VMSTATE enmVMState = VMR3GetState (pVM);
2783	switch (enmVMState)
2784	{
2785	case VMSTATE_RESETTING:
2786	case VMSTATE_RUNNING:
2787	{
2788	LogFlowFunc (("Suspending the VM...\n"));
2789	/* disable the callback to prevent Console-level state change */
2790	pThis->mVMStateChangeCallbackDisabled = true;
2791	int rc = VMR3Suspend (pVM);
2792	pThis->mVMStateChangeCallbackDisabled = false;
2793	AssertRCReturn (rc, rc);
2794	fResume = true;
2795	break;
2796	}
2797
2798	case VMSTATE_SUSPENDED:
2799	case VMSTATE_CREATED:
2800	case VMSTATE_OFF:
2801	fResume = false;
2802	break;
2803
2804	default:
2805	AssertMsgFailedReturn (("enmVMState=%d\n", enmVMState), VERR_ACCESS_DENIED);
2806	}
2807
2808	int rc = VINF_SUCCESS;
2809	int rcRet = VINF_SUCCESS;
2810
2811	do
2812	{
2813	/*
2814	* Unmount existing media / detach host drive.
2815	*/
2816	PPDMIMOUNT pIMount = NULL;
2817	switch (*peState)
2818	{
2819
2820	case DriveState_ImageMounted:
2821	{
2822	/*
2823	* Resolve the interface.
2824	*/
2825	PPDMIBASE pBase;
2826	rc = PDMR3QueryLun (pVM, pszDevice, uInstance, uLun, &pBase);
2827	if (VBOX_FAILURE (rc))
2828	{
2829	if (rc == VERR_PDM_LUN_NOT_FOUND)
2830	rc = VINF_SUCCESS;
2831	AssertRC (rc);
2832	break;
2833	}
2834
2835	pIMount = (PPDMIMOUNT) pBase->pfnQueryInterface (pBase, PDMINTERFACE_MOUNT);
2836	AssertBreak (pIMount, rc = VERR_INVALID_POINTER);
2837
2838	/*
2839	* Unmount the media.
2840	*/
2841	rc = pIMount->pfnUnmount (pIMount);
2842	if (rc == VERR_PDM_MEDIA_NOT_MOUNTED)
2843	rc = VINF_SUCCESS;
2844	break;
2845	}
2846
2847	case DriveState_HostDriveCaptured:
2848	{
2849	rc = PDMR3DeviceDetach (pVM, pszDevice, uInstance, uLun);
2850	if (rc == VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN)
2851	rc = VINF_SUCCESS;
2852	AssertRC (rc);
2853	break;
2854	}
2855
2856	case DriveState_NotMounted:
2857	break;
2858
2859	default:
2860	AssertMsgFailed (("Invalid *peState: %d\n", peState));
2861	break;
2862	}
2863
2864	if (VBOX_FAILURE (rc))
2865	{
2866	rcRet = rc;
2867	break;
2868	}
2869
2870	/*
2871	* Nothing is currently mounted.
2872	*/
2873	*peState = DriveState_NotMounted;
2874
2875
2876	/*
2877	* Process the HostDriveCaptured state first, as the fallback path
2878	* means mounting the normal block driver without media.
2879	*/
2880	if (eState == DriveState_HostDriveCaptured)
2881	{
2882	/*
2883	* Detach existing driver chain (block).
2884	*/
2885	int rc = PDMR3DeviceDetach (pVM, pszDevice, uInstance, uLun);
2886	if (VBOX_FAILURE (rc))
2887	{
2888	if (rc == VERR_PDM_LUN_NOT_FOUND)
2889	rc = VINF_SUCCESS;
2890	AssertReleaseRC (rc);
2891	break; /* we're toast */
2892	}
2893	pIMount = NULL;
2894
2895	/*
2896	* Construct a new driver configuration.
2897	*/
2898	PCFGMNODE pInst = CFGMR3GetChildF (CFGMR3GetRoot (pVM), "Devices/%s/%d/", pszDevice, uInstance);
2899	AssertRelease (pInst);
2900	/* nuke anything which might have been left behind. */
2901	CFGMR3RemoveNode (CFGMR3GetChildF (pInst, "LUN#%d", uLun));
2902
2903	/* create a new block driver config */
2904	PCFGMNODE pLunL0;
2905	PCFGMNODE pCfg;
2906	if ( VBOX_SUCCESS (rc = CFGMR3InsertNodeF (pInst, &pLunL0, "LUN#%u", uLun))
2907	&& VBOX_SUCCESS (rc = CFGMR3InsertString (pLunL0, "Driver", !strcmp (pszDevice, "i82078") ? "HostFloppy" : "HostDVD"))
2908	&& VBOX_SUCCESS (rc = CFGMR3InsertNode (pLunL0, "Config", &pCfg))
2909	&& VBOX_SUCCESS (rc = CFGMR3InsertString (pCfg, "Path", pszPath))
2910	&& VBOX_SUCCESS (rc = !strcmp (pszDevice, "i82078") ? VINF_SUCCESS : CFGMR3InsertInteger(pCfg, "Passthrough", fPassthrough)))
2911	{
2912	/*
2913	* Attempt to attach the driver.
2914	*/
2915	rc = PDMR3DeviceAttach (pVM, pszDevice, uInstance, uLun, NULL);
2916	AssertRC (rc);
2917	}
2918	if (VBOX_FAILURE (rc))
2919	rcRet = rc;
2920	}
2921
2922	/*
2923	* Process the ImageMounted, NotMounted and failed HostDriveCapture cases.
2924	*/
2925	rc = VINF_SUCCESS;
2926	switch (eState)
2927	{
2928	#define RC_CHECK() do { if (VBOX_FAILURE (rc)) { AssertReleaseRC (rc); break; } } while (0)
2929
2930	case DriveState_HostDriveCaptured:
2931	if (VBOX_SUCCESS (rcRet))
2932	break;
2933	/* fallback: umounted block driver. */
2934	pszPath = NULL;
2935	eState = DriveState_NotMounted;
2936	/* fallthru */
2937	case DriveState_ImageMounted:
2938	case DriveState_NotMounted:
2939	{
2940	/*
2941	* Resolve the drive interface / create the driver.
2942	*/
2943	if (!pIMount)
2944	{
2945	PPDMIBASE pBase;
2946	rc = PDMR3QueryLun (pVM, pszDevice, uInstance, uLun, &pBase);
2947	if (rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
2948	{
2949	/*
2950	* We have to create it, so we'll do the full config setup and everything.
2951	*/
2952	PCFGMNODE pIdeInst = CFGMR3GetChildF (CFGMR3GetRoot (pVM), "Devices/%s/%d/", pszDevice, uInstance);
2953	AssertRelease (pIdeInst);
2954
2955	/* nuke anything which might have been left behind. */
2956	CFGMR3RemoveNode (CFGMR3GetChildF (pIdeInst, "LUN#%d", uLun));
2957
2958	/* create a new block driver config */
2959	PCFGMNODE pLunL0;
2960	rc = CFGMR3InsertNodeF (pIdeInst, &pLunL0, "LUN#%d", uLun); RC_CHECK();
2961	rc = CFGMR3InsertString (pLunL0, "Driver", "Block"); RC_CHECK();
2962	PCFGMNODE pCfg;
2963	rc = CFGMR3InsertNode (pLunL0, "Config", &pCfg); RC_CHECK();
2964	rc = CFGMR3InsertString (pCfg, "Type", !strcmp (pszDevice, "i82078") ? "Floppy 1.44" : "DVD");
2965	RC_CHECK();
2966	rc = CFGMR3InsertInteger (pCfg, "Mountable", 1); RC_CHECK();
2967
2968	/*
2969	* Attach the driver.
2970	*/
2971	rc = PDMR3DeviceAttach (pVM, pszDevice, uInstance, uLun, &pBase);
2972	RC_CHECK();
2973	}
2974	else if (VBOX_FAILURE(rc))
2975	{
2976	AssertRC (rc);
2977	return rc;
2978	}
2979
2980	pIMount = (PPDMIMOUNT) pBase->pfnQueryInterface (pBase, PDMINTERFACE_MOUNT);
2981	if (!pIMount)
2982	{
2983	AssertFailed();
2984	return rc;
2985	}
2986	}
2987
2988	/*
2989	* If we've got an image, let's mount it.
2990	*/
2991	if (pszPath && *pszPath)
2992	{
2993	rc = pIMount->pfnMount (pIMount, pszPath, strcmp (pszDevice, "i82078") ? "MediaISO" : "RawImage");
2994	if (VBOX_FAILURE (rc))
2995	eState = DriveState_NotMounted;
2996	}
2997	break;
2998	}
2999
3000	default:
3001	AssertMsgFailed (("Invalid eState: %d\n", eState));
3002	break;
3003
3004	#undef RC_CHECK
3005	}
3006
3007	if (VBOX_FAILURE (rc) && VBOX_SUCCESS (rcRet))
3008	rcRet = rc;
3009
3010	*peState = eState;
3011	}
3012	while (0);
3013
3014	/*
3015	* Resume the VM if necessary.
3016	*/
3017	if (fResume)
3018	{
3019	LogFlowFunc (("Resuming the VM...\n"));
3020	/* disable the callback to prevent Console-level state change */
3021	pThis->mVMStateChangeCallbackDisabled = true;
3022	rc = VMR3Resume (pVM);
3023	pThis->mVMStateChangeCallbackDisabled = false;
3024	AssertRC (rc);
3025	if (VBOX_FAILURE (rc))
3026	{
3027	/* too bad, we failed. try to sync the console state with the VMM state */
3028	vmstateChangeCallback (pVM, VMSTATE_SUSPENDED, enmVMState, pThis);
3029	}
3030	/// @todo (r=dmik) if we failed with drive mount, then the VMR3Resume
3031	// error (if any) will be hidden from the caller. For proper reporting
3032	// of such multiple errors to the caller we need to enhance the
3033	// IVurtualBoxError interface. For now, give the first error the higher
3034	// priority.
3035	if (VBOX_SUCCESS (rcRet))
3036	rcRet = rc;
3037	}
3038
3039	LogFlowFunc (("Returning %Vrc\n", rcRet));
3040	return rcRet;
3041	}
3042
3043
3044	/**
3045	* Called by IInternalSessionControl::OnNetworkAdapterChange().
3046	*
3047	* @note Locks this object for writing.
3048	*/
3049	HRESULT Console::onNetworkAdapterChange(INetworkAdapter *networkAdapter)
3050	{
3051	LogFlowThisFunc (("\n"));
3052
3053	AutoCaller autoCaller (this);
3054	AssertComRCReturnRC (autoCaller.rc());
3055
3056	AutoLock alock (this);
3057
3058	/* Don't do anything if the VM isn't running */
3059	if (!mpVM)
3060	return S_OK;
3061
3062	/* protect mpVM */
3063	AutoVMCaller autoVMCaller (this);
3064	CheckComRCReturnRC (autoVMCaller.rc());
3065
3066	/* Get the properties we need from the adapter */
3067	BOOL fCableConnected;
3068	HRESULT rc = networkAdapter->COMGETTER(CableConnected)(&fCableConnected);
3069	AssertComRC(rc);
3070	if (SUCCEEDED(rc))
3071	{
3072	ULONG ulInstance;
3073	rc = networkAdapter->COMGETTER(Slot)(&ulInstance);
3074	AssertComRC(rc);
3075	if (SUCCEEDED(rc))
3076	{
3077	/*
3078	* Find the pcnet instance, get the config interface and update the link state.
3079	*/
3080	PPDMIBASE pBase;
3081	int rcVBox = PDMR3QueryDeviceLun(mpVM, "pcnet", (unsigned)ulInstance, 0, &pBase);
3082	ComAssertRC(rcVBox);
3083	if (VBOX_SUCCESS(rcVBox))
3084	{
3085	Assert(pBase);
3086	PPDMINETWORKCONFIG pINetCfg = (PPDMINETWORKCONFIG)pBase->pfnQueryInterface(pBase, PDMINTERFACE_NETWORK_CONFIG);
3087	if (pINetCfg)
3088	{
3089	Log(("Console::onNetworkAdapterChange: setting link state to %d\n", fCableConnected));
3090	rcVBox = pINetCfg->pfnSetLinkState(pINetCfg, fCableConnected ? PDMNETWORKLINKSTATE_UP : PDMNETWORKLINKSTATE_DOWN);
3091	ComAssertRC(rcVBox);
3092	}
3093	}
3094	}
3095	}
3096
3097	LogFlowThisFunc (("Leaving rc=%#x\n", rc));
3098	return rc;
3099	}
3100
3101	/**
3102	* Called by IInternalSessionControl::OnVRDPServerChange().
3103	*
3104	* @note Locks this object for writing.
3105	*/
3106	HRESULT Console::onVRDPServerChange()
3107	{
3108	AutoCaller autoCaller (this);
3109	AssertComRCReturnRC (autoCaller.rc());
3110
3111	AutoLock alock (this);
3112
3113	HRESULT rc = S_OK;
3114
3115	if (mVRDPServer && mMachineState == MachineState_Running)
3116	{
3117	BOOL vrdpEnabled = FALSE;
3118
3119	rc = mVRDPServer->COMGETTER(Enabled) (&vrdpEnabled);
3120	ComAssertComRCRetRC (rc);
3121
3122	if (vrdpEnabled)
3123	{
3124	// If there was no VRDP server started the 'stop' will do nothing.
3125	// However if a server was started and this notification was called,
3126	// we have to restart the server.
3127	mConsoleVRDPServer->Stop ();
3128
3129	if (VBOX_FAILURE(mConsoleVRDPServer->Launch ()))
3130	{
3131	rc = E_FAIL;
3132	}
3133	else
3134	{
3135	mConsoleVRDPServer->SetCallback ();
3136	}
3137	}
3138	else
3139	{
3140	mConsoleVRDPServer->Stop ();
3141	}
3142	}
3143
3144	return rc;
3145	}
3146
3147	/**
3148	* Called by IInternalSessionControl::OnUSBControllerChange().
3149	*
3150	* @note Locks this object for writing.
3151	*/
3152	HRESULT Console::onUSBControllerChange()
3153	{
3154	LogFlowThisFunc (("\n"));
3155
3156	AutoCaller autoCaller (this);
3157	AssertComRCReturnRC (autoCaller.rc());
3158
3159	AutoLock alock (this);
3160
3161	/* Ignore if no VM is running yet. */
3162	if (!mpVM)
3163	return S_OK;
3164
3165	/// @todo (dmik)
3166	// check for the Enabled state and disable virtual USB controller??
3167	// Anyway, if we want to query the machine's USB Controller we need to cache
3168	// it to to mUSBController in #init() (as it is done with mDVDDrive).
3169	//
3170	// bird: While the VM supports hot-plugging, I doubt any guest can handle it at this time... :-)
3171	//
3172	// /* protect mpVM */
3173	// AutoVMCaller autoVMCaller (this);
3174	// CheckComRCReturnRC (autoVMCaller.rc());
3175
3176	return S_OK;
3177	}
3178
3179	/**
3180	* Called by IInternalSessionControl::OnUSBDeviceAttach() or locally by
3181	* processRemoteUSBDevices() after IInternalMachineControl::RunUSBDeviceFilters()
3182	* returns TRUE for a given remote USB device.
3183	*
3184	* @return S_OK if the device was attached to the VM.
3185	* @return failure if not attached.
3186	*
3187	* @param aDevice
3188	* The device in question.
3189	*
3190	* @note Locks this object for writing.
3191	*/
3192	HRESULT Console::onUSBDeviceAttach (IUSBDevice aDevice, IVirtualBoxErrorInfo aError)
3193	{
3194	LogFlowThisFunc (("aDevice=%p aError=%p\n", aDevice, aError));
3195
3196	AutoCaller autoCaller (this);
3197	ComAssertComRCRetRC (autoCaller.rc());
3198
3199	AutoLock alock (this);
3200
3201	/* VM might have been stopped when this message arrives */
3202	if (mMachineState < MachineState_Running)
3203	{
3204	LogFlowThisFunc (("Attach request ignored (mMachineState=%d).\n",
3205	mMachineState));
3206	return E_FAIL;
3207	}
3208
3209	if (aError != NULL)
3210	{
3211	/* notify callback about an error */
3212	onUSBDeviceStateChange (aDevice, true /* aAttached */, aError);
3213	return S_OK;
3214	}
3215
3216	/* protect mpVM */
3217	AutoVMCaller autoVMCaller (this);
3218	CheckComRCReturnRC (autoVMCaller.rc());
3219
3220	/* Don't proceed unless we've found the usb controller. */
3221	PPDMIBASE pBase = NULL;
3222	int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
3223	if (VBOX_FAILURE (vrc))
3224	{
3225	LogFlowThisFunc (("Attach request ignored (no USB controller).\n"));
3226	return E_FAIL;
3227	}
3228
3229	PVUSBIRHCONFIG pRhConfig = (PVUSBIRHCONFIG) pBase->
3230	pfnQueryInterface (pBase, PDMINTERFACE_VUSB_RH_CONFIG);
3231	ComAssertRet (pRhConfig, E_FAIL);
3232
3233	HRESULT rc = attachUSBDevice (aDevice, pRhConfig);
3234
3235	/// @todo notify listeners of IConsoleCallback in case of error
3236	return rc;
3237	}
3238
3239	/**
3240	* Called by IInternalSessionControl::OnUSBDeviceDetach() and locally by
3241	* processRemoteUSBDevices().
3242	*
3243	* @note Locks this object for writing.
3244	*/
3245	HRESULT Console::onUSBDeviceDetach (INPTR GUIDPARAM aId,
3246	IVirtualBoxErrorInfo *aError)
3247	{
3248	Guid Uuid (aId);
3249	LogFlowThisFunc (("aId={%Vuuid} aError=%p\n", Uuid.raw(), aError));
3250
3251	AutoCaller autoCaller (this);
3252	AssertComRCReturnRC (autoCaller.rc());
3253
3254	AutoLock alock (this);
3255
3256	/* Find the device. */
3257	ComObjPtr <OUSBDevice> device;
3258	USBDeviceList::iterator it = mUSBDevices.begin();
3259	while (it != mUSBDevices.end())
3260	{
3261	LogFlowThisFunc (("it={%Vuuid}\n", (*it)->id().raw()));
3262	if ((*it)->id() == Uuid)
3263	{
3264	device = *it;
3265	break;
3266	}
3267	++ it;
3268	}
3269
3270	/* VM might have been stopped when this message arrives */
3271	if (device.isNull())
3272	{
3273	LogFlowThisFunc (("Device not found.\n"));
3274	if (mMachineState < MachineState_Running \|\|
3275	mMachineState == MachineState_Stopping)
3276	{
3277	LogFlowThisFunc (("Detach request ignored (mMachineState=%d).\n",
3278	mMachineState));
3279	return E_FAIL;
3280	}
3281	/* the device must be in the list */
3282	AssertFailedReturn (E_FAIL);
3283	}
3284
3285	if (aError != NULL)
3286	{
3287	/* notify callback about an error */
3288	onUSBDeviceStateChange (device, false /* aAttached */, aError);
3289	return S_OK;
3290	}
3291
3292	HRESULT rc = detachUSBDevice (it);
3293
3294	/// @todo notify listeners of IConsoleCallback in case of error
3295	return rc;
3296	}
3297
3298	/**
3299	* Gets called by Session::UpdateMachineState()
3300	* (IInternalSessionControl::updateMachineState()).
3301	*
3302	* Must be called only in certain cases (see the implementation).
3303	*
3304	* @note Locks this object for writing.
3305	*/
3306	HRESULT Console::updateMachineState (MachineState_T aMachineState)
3307	{
3308	AutoCaller autoCaller (this);
3309	AssertComRCReturnRC (autoCaller.rc());
3310
3311	AutoLock alock (this);
3312
3313	AssertReturn (mMachineState == MachineState_Saving \|\|
3314	mMachineState == MachineState_Discarding,
3315	E_FAIL);
3316
3317	return setMachineStateLocally (aMachineState);
3318	}
3319
3320	/**
3321	* @note Locks this object for writing.
3322	*/
3323	void Console::onMousePointerShapeChange(bool fVisible, bool fAlpha,
3324	uint32_t xHot, uint32_t yHot,
3325	uint32_t width, uint32_t height,
3326	void *pShape)
3327	{
3328	LogFlowThisFuncEnter();
3329	LogFlowThisFunc (("fVisible=%d, fAlpha=%d, xHot = %d, yHot = %d, width=%d, "
3330	"height=%d, shape=%p\n",
3331	fVisible, fAlpha, xHot, yHot, width, height, pShape));
3332
3333	AutoCaller autoCaller (this);
3334	AssertComRCReturnVoid (autoCaller.rc());
3335
3336	/* We need a write lock because we alter the cached callback data */
3337	AutoLock alock (this);
3338
3339	/* Save the callback arguments */
3340	mCallbackData.mpsc.visible = fVisible;
3341	mCallbackData.mpsc.alpha = fAlpha;
3342	mCallbackData.mpsc.xHot = xHot;
3343	mCallbackData.mpsc.yHot = yHot;
3344	mCallbackData.mpsc.width = width;
3345	mCallbackData.mpsc.height = height;
3346
3347	/* start with not valid */
3348	bool wasValid = mCallbackData.mpsc.valid;
3349	mCallbackData.mpsc.valid = false;
3350
3351	if (pShape != NULL)
3352	{
3353	size_t cb = (width + 7) / 8 * height; /* size of the AND mask */
3354	cb += ((cb + 3) & ~3) + width * 4 * height; /* + gap + size of the XOR mask */
3355	/* try to reuse the old shape buffer if the size is the same */
3356	if (!wasValid)
3357	mCallbackData.mpsc.shape = NULL;
3358	else
3359	if (mCallbackData.mpsc.shape != NULL && mCallbackData.mpsc.shapeSize != cb)
3360	{
3361	RTMemFree (mCallbackData.mpsc.shape);
3362	mCallbackData.mpsc.shape = NULL;
3363	}
3364	if (mCallbackData.mpsc.shape == NULL)
3365	{
3366	mCallbackData.mpsc.shape = (BYTE *) RTMemAllocZ (cb);
3367	AssertReturnVoid (mCallbackData.mpsc.shape);
3368	}
3369	mCallbackData.mpsc.shapeSize = cb;
3370	memcpy (mCallbackData.mpsc.shape, pShape, cb);
3371	}
3372	else
3373	{
3374	if (wasValid && mCallbackData.mpsc.shape != NULL)
3375	RTMemFree (mCallbackData.mpsc.shape);
3376	mCallbackData.mpsc.shape = NULL;
3377	mCallbackData.mpsc.shapeSize = 0;
3378	}
3379
3380	mCallbackData.mpsc.valid = true;
3381
3382	CallbackList::iterator it = mCallbacks.begin();
3383	while (it != mCallbacks.end())
3384	(*it++)->OnMousePointerShapeChange (fVisible, fAlpha, xHot, yHot,
3385	width, height, (BYTE *) pShape);
3386
3387	LogFlowThisFuncLeave();
3388	}
3389
3390	/**
3391	* @note Locks this object for writing.
3392	*/
3393	void Console::onMouseCapabilityChange (BOOL supportsAbsolute, BOOL needsHostCursor)
3394	{
3395	LogFlowThisFunc (("supportsAbsolute=%d needsHostCursor=%d\n",
3396	supportsAbsolute, needsHostCursor));
3397
3398	AutoCaller autoCaller (this);
3399	AssertComRCReturnVoid (autoCaller.rc());
3400
3401	/* We need a write lock because we alter the cached callback data */
3402	AutoLock alock (this);
3403
3404	/* save the callback arguments */
3405	mCallbackData.mcc.supportsAbsolute = supportsAbsolute;
3406	mCallbackData.mcc.needsHostCursor = needsHostCursor;
3407	mCallbackData.mcc.valid = true;
3408
3409	CallbackList::iterator it = mCallbacks.begin();
3410	while (it != mCallbacks.end())
3411	{
3412	Log2(("Console::onMouseCapabilityChange: calling %p\n", (void)it));
3413	(*it++)->OnMouseCapabilityChange (supportsAbsolute, needsHostCursor);
3414	}
3415	}
3416
3417	/**
3418	* @note Locks this object for reading.
3419	*/
3420	void Console::onStateChange (MachineState_T machineState)
3421	{
3422	AutoCaller autoCaller (this);
3423	AssertComRCReturnVoid (autoCaller.rc());
3424
3425	AutoReaderLock alock (this);
3426
3427	CallbackList::iterator it = mCallbacks.begin();
3428	while (it != mCallbacks.end())
3429	(*it++)->OnStateChange (machineState);
3430	}
3431
3432	/**
3433	* @note Locks this object for reading.
3434	*/
3435	void Console::onAdditionsStateChange()
3436	{
3437	AutoCaller autoCaller (this);
3438	AssertComRCReturnVoid (autoCaller.rc());
3439
3440	AutoReaderLock alock (this);
3441
3442	CallbackList::iterator it = mCallbacks.begin();
3443	while (it != mCallbacks.end())
3444	(*it++)->OnAdditionsStateChange();
3445	}
3446
3447	/**
3448	* @note Locks this object for reading.
3449	*/
3450	void Console::onAdditionsOutdated()
3451	{
3452	AutoCaller autoCaller (this);
3453	AssertComRCReturnVoid (autoCaller.rc());
3454
3455	AutoReaderLock alock (this);
3456
3457	/** @todo Use the On-Screen Display feature to report the fact.
3458	* The user should be told to install additions that are
3459	* provided with the current VBox build:
3460	* VBOX_VERSION_MAJOR.VBOX_VERSION_MINOR.VBOX_VERSION_BUILD
3461	*/
3462	}
3463
3464	/**
3465	* @note Locks this object for writing.
3466	*/
3467	void Console::onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock)
3468	{
3469	AutoCaller autoCaller (this);
3470	AssertComRCReturnVoid (autoCaller.rc());
3471
3472	/* We need a write lock because we alter the cached callback data */
3473	AutoLock alock (this);
3474
3475	/* save the callback arguments */
3476	mCallbackData.klc.numLock = fNumLock;
3477	mCallbackData.klc.capsLock = fCapsLock;
3478	mCallbackData.klc.scrollLock = fScrollLock;
3479	mCallbackData.klc.valid = true;
3480
3481	CallbackList::iterator it = mCallbacks.begin();
3482	while (it != mCallbacks.end())
3483	(*it++)->OnKeyboardLedsChange(fNumLock, fCapsLock, fScrollLock);
3484	}
3485
3486	/**
3487	* @note Locks this object for reading.
3488	*/
3489	void Console::onUSBDeviceStateChange (IUSBDevice *aDevice, bool aAttached,
3490	IVirtualBoxErrorInfo *aError)
3491	{
3492	AutoCaller autoCaller (this);
3493	AssertComRCReturnVoid (autoCaller.rc());
3494
3495	AutoReaderLock alock (this);
3496
3497	CallbackList::iterator it = mCallbacks.begin();
3498	while (it != mCallbacks.end())
3499	(*it++)->OnUSBDeviceStateChange (aDevice, aAttached, aError);
3500	}
3501
3502	/**
3503	* @note Locks this object for reading.
3504	*/
3505	void Console::onRuntimeError (BOOL aFatal, INPTR BSTR aErrorID, INPTR BSTR aMessage)
3506	{
3507	AutoCaller autoCaller (this);
3508	AssertComRCReturnVoid (autoCaller.rc());
3509
3510	AutoReaderLock alock (this);
3511
3512	CallbackList::iterator it = mCallbacks.begin();
3513	while (it != mCallbacks.end())
3514	(*it++)->OnRuntimeError (aFatal, aErrorID, aMessage);
3515	}
3516
3517	/**
3518	* @note Locks this object for reading.
3519	*/
3520	HRESULT Console::onShowWindow (BOOL aCheck, BOOL aCanShow, ULONG64 aWinId)
3521	{
3522	AssertReturn (aCanShow, E_POINTER);
3523	AssertReturn (aWinId, E_POINTER);
3524
3525	*aCanShow = FALSE;
3526	*aWinId = 0;
3527
3528	AutoCaller autoCaller (this);
3529	AssertComRCReturnRC (autoCaller.rc());
3530
3531	AutoReaderLock alock (this);
3532
3533	HRESULT rc = S_OK;
3534	CallbackList::iterator it = mCallbacks.begin();
3535
3536	if (aCheck)
3537	{
3538	while (it != mCallbacks.end())
3539	{
3540	BOOL canShow = FALSE;
3541	rc = (*it++)->OnCanShowWindow (&canShow);
3542	AssertComRC (rc);
3543	if (FAILED (rc) \|\| !canShow)
3544	return rc;
3545	}
3546	*aCanShow = TRUE;
3547	}
3548	else
3549	{
3550	while (it != mCallbacks.end())
3551	{
3552	ULONG64 winId = 0;
3553	rc = (*it++)->OnShowWindow (&winId);
3554	AssertComRC (rc);
3555	if (FAILED (rc))
3556	return rc;
3557	/* only one callback may return non-null winId */
3558	Assert (*aWinId == 0 \|\| winId == 0);
3559	if (*aWinId == 0)
3560	*aWinId = winId;
3561	}
3562	}
3563
3564	return S_OK;
3565	}
3566
3567	// private mehtods
3568	////////////////////////////////////////////////////////////////////////////////
3569
3570	/**
3571	* Increases the usage counter of the mpVM pointer. Guarantees that
3572	* VMR3Destroy() will not be called on it at least until releaseVMCaller()
3573	* is called.
3574	*
3575	* If this method returns a failure, the caller is not allowed to use mpVM
3576	* and may return the failed result code to the upper level. This method sets
3577	* the extended error info on failure if \a aQuiet is false.
3578	*
3579	* Setting \a aQuiet to true is useful for methods that don't want to return
3580	* the failed result code to the caller when this method fails (e.g. need to
3581	* silently check for the mpVM avaliability).
3582	*
3583	* When mpVM is NULL but \a aAllowNullVM is true, a corresponding error will be
3584	* returned instead of asserting. Having it false is intended as a sanity check
3585	* for methods that have checked mMachineState and expect mpVM NOT to be NULL.
3586	*
3587	* @param aQuiet true to suppress setting error info
3588	* @param aAllowNullVM true to accept mpVM being NULL and return a failure
3589	* (otherwise this method will assert if mpVM is NULL)
3590	*
3591	* @note Locks this object for writing.
3592	*/
3593	HRESULT Console::addVMCaller (bool aQuiet /* = false */,
3594	bool aAllowNullVM /* = false */)
3595	{
3596	AutoCaller autoCaller (this);
3597	AssertComRCReturnRC (autoCaller.rc());
3598
3599	AutoLock alock (this);
3600
3601	if (mVMDestroying)
3602	{
3603	/* powerDown() is waiting for all callers to finish */
3604	return aQuiet ? E_ACCESSDENIED : setError (E_ACCESSDENIED,
3605	tr ("Virtual machine is being powered down"));
3606	}
3607
3608	if (mpVM == NULL)
3609	{
3610	Assert (aAllowNullVM == true);
3611
3612	/* The machine is not powered up */
3613	return aQuiet ? E_ACCESSDENIED : setError (E_ACCESSDENIED,
3614	tr ("Virtual machine is not powered up"));
3615	}
3616
3617	++ mVMCallers;
3618
3619	return S_OK;
3620	}
3621
3622	/**
3623	* Decreases the usage counter of the mpVM pointer. Must always complete
3624	* the addVMCaller() call after the mpVM pointer is no more necessary.
3625	*
3626	* @note Locks this object for writing.
3627	*/
3628	void Console::releaseVMCaller()
3629	{
3630	AutoCaller autoCaller (this);
3631	AssertComRCReturnVoid (autoCaller.rc());
3632
3633	AutoLock alock (this);
3634
3635	AssertReturnVoid (mpVM != NULL);
3636
3637	Assert (mVMCallers > 0);
3638	-- mVMCallers;
3639
3640	if (mVMCallers == 0 && mVMDestroying)
3641	{
3642	/* inform powerDown() there are no more callers */
3643	RTSemEventSignal (mVMZeroCallersSem);
3644	}
3645	}
3646
3647	/**
3648	* Internal power off worker routine.
3649	*
3650	* This method may be called only at certain places with the folliwing meaning
3651	* as shown below:
3652	*
3653	* - if the machine state is either Running or Paused, a normal
3654	* Console-initiated powerdown takes place (e.g. PowerDown());
3655	* - if the machine state is Saving, saveStateThread() has successfully
3656	* done its job;
3657	* - if the machine state is Starting or Restoring, powerUpThread() has
3658	* failed to start/load the VM;
3659	* - if the machine state is Stopping, the VM has powered itself off
3660	* (i.e. not as a result of the powerDown() call).
3661	*
3662	* Calling it in situations other than the above will cause unexpected
3663	* behavior.
3664	*
3665	* Note that this method should be the only one that destroys mpVM and sets
3666	* it to NULL.
3667	*
3668	* @note Locks this object for writing.
3669	*
3670	* @note Never call this method from a thread that called addVMCaller() or
3671	* instantiated an AutoVMCaller object; first call releaseVMCaller() or
3672	* release(). Otherwise it will deadlock.
3673	*/
3674	HRESULT Console::powerDown()
3675	{
3676	LogFlowThisFuncEnter();
3677
3678	AutoCaller autoCaller (this);
3679	AssertComRCReturnRC (autoCaller.rc());
3680
3681	AutoLock alock (this);
3682
3683	/* sanity */
3684	AssertReturn (mVMDestroying == false, E_FAIL);
3685
3686	LogRel (("Console::powerDown(): a request to power off the VM has been issued "
3687	"(mMachineState=%d, InUninit=%d)\n",
3688	mMachineState, autoCaller.state() == InUninit));
3689
3690	/* First, wait for all mpVM callers to finish their work if necessary */
3691	if (mVMCallers > 0)
3692	{
3693	/* go to the destroying state to prevent from adding new callers */
3694	mVMDestroying = true;
3695
3696	/* lazy creation */
3697	if (mVMZeroCallersSem == NIL_RTSEMEVENT)
3698	RTSemEventCreate (&mVMZeroCallersSem);
3699
3700	LogFlowThisFunc (("Waiting for mpVM callers (%d) to drop to zero...\n",
3701	mVMCallers));
3702
3703	alock.leave();
3704
3705	RTSemEventWait (mVMZeroCallersSem, RT_INDEFINITE_WAIT);
3706
3707	alock.enter();
3708	}
3709
3710	AssertReturn (mpVM, E_FAIL);
3711
3712	AssertMsg (mMachineState == MachineState_Running \|\|
3713	mMachineState == MachineState_Paused \|\|
3714	mMachineState == MachineState_Saving \|\|
3715	mMachineState == MachineState_Starting \|\|
3716	mMachineState == MachineState_Restoring \|\|
3717	mMachineState == MachineState_Stopping,
3718	("Invalid machine state: %d\n", mMachineState));
3719
3720	HRESULT rc = S_OK;
3721	int vrc = VINF_SUCCESS;
3722
3723	/*
3724	* Power off the VM if not already done that. In case of Stopping, the VM
3725	* has powered itself off and notified Console in vmstateChangeCallback().
3726	* In case of Starting or Restoring, powerUpThread() is calling us on
3727	* failure, so the VM is already off at that point.
3728	*/
3729	if (mMachineState != MachineState_Stopping &&
3730	mMachineState != MachineState_Starting &&
3731	mMachineState != MachineState_Restoring)
3732	{
3733	/*
3734	* don't go from Saving to Stopping, vmstateChangeCallback needs it
3735	* to set the state to Saved on VMSTATE_TERMINATED.
3736	*/
3737	if (mMachineState != MachineState_Saving)
3738	setMachineState (MachineState_Stopping);
3739
3740	LogFlowThisFunc (("Powering off the VM...\n"));
3741
3742	/* Leave the lock since EMT will call us back on VMR3PowerOff() */
3743	alock.leave();
3744
3745	vrc = VMR3PowerOff (mpVM);
3746	/*
3747	* Note that VMR3PowerOff() may fail here (invalid VMSTATE) if the
3748	* VM-(guest-)initiated power off happened in parallel a ms before
3749	* this call. So far, we let this error pop up on the user's side.
3750	*/
3751
3752	alock.enter();
3753	}
3754
3755	LogFlowThisFunc (("Ready for VM destruction\n"));
3756
3757	/*
3758	* If we are called from Console::uninit(), then try to destroy the VM
3759	* even on failure (this will most likely fail too, but what to do?..)
3760	*/
3761	if (VBOX_SUCCESS (vrc) \|\| autoCaller.state() == InUninit)
3762	{
3763	/*
3764	* Stop the VRDP server and release all USB device.
3765	* (When called from uninit mConsoleVRDPServer is already destroyed.)
3766	*/
3767	if (mConsoleVRDPServer)
3768	{
3769	LogFlowThisFunc (("Stopping VRDP server...\n"));
3770
3771	/* Leave the lock since EMT will call us back as addVMCaller in updateDisplayData(). */
3772	alock.leave();
3773
3774	mConsoleVRDPServer->Stop();
3775
3776	alock.enter();
3777	}
3778
3779	/* If the machine has an USB comtroller, release all USB devices
3780	* (symmectric to the code in captureUSBDevices()) */
3781	{
3782	PPDMIBASE pBase;
3783	int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
3784	if (VBOX_SUCCESS (vrc))
3785	releaseAllUSBDevices();
3786	}
3787
3788	/*
3789	* Now we've got to destroy the VM as well. (mpVM is not valid
3790	* beyond this point). We leave the lock before calling VMR3Destroy()
3791	* because it will result into calling destructors of drivers
3792	* associated with Console children which may in turn try to lock
3793	* Console (e.g. by instantiating SafeVMPtr to access mpVM). It's safe
3794	* here because mVMDestroying is set which should prevent any activity.
3795	*/
3796
3797	/*
3798	* Set mpVM to NULL early just in case if some old code is not using
3799	* addVMCaller()/releaseVMCaller().
3800	*/
3801	PVM pVM = mpVM;
3802	mpVM = NULL;
3803
3804	LogFlowThisFunc (("Destroying the VM...\n"));
3805
3806	alock.leave();
3807
3808	vrc = VMR3Destroy (pVM);
3809
3810	/* take the lock again */
3811	alock.enter();
3812
3813	if (VBOX_SUCCESS (vrc))
3814	{
3815	LogFlowThisFunc (("Machine has been destroyed (mMachineState=%d)\n",
3816	mMachineState));
3817	/*
3818	* Note: the Console-level machine state change happens on the
3819	* VMSTATE_TERMINATE state change in vmstateChangeCallback(). If
3820	* powerDown() is called from EMT (i.e. from vmstateChangeCallback()
3821	* on receiving VM-initiated VMSTATE_OFF), VMSTATE_TERMINATE hasn't
3822	* occured yet. This is okay, because mMachineState is already
3823	* Stopping in this case, so any other attempt to call PowerDown()
3824	* will be rejected.
3825	*/
3826	}
3827	else
3828	{
3829	/* bad bad bad, but what to do? */
3830	mpVM = pVM;
3831	rc = setError (E_FAIL,
3832	tr ("Could not destroy the machine. (Error: %Vrc)"), vrc);
3833	}
3834	}
3835	else
3836	{
3837	rc = setError (E_FAIL,
3838	tr ("Could not power off the machine. (Error: %Vrc)"), vrc);
3839	}
3840
3841	/*
3842	* Finished with destruction. Note that if something impossible happened
3843	* and we've failed to destroy the VM, mVMDestroying will remain false and
3844	* mMachineState will be something like Stopping, so most Console methods
3845	* will return an error to the caller.
3846	*/
3847	if (mpVM == NULL)
3848	mVMDestroying = false;
3849
3850	if (SUCCEEDED (rc))
3851	{
3852	/* uninit dynamically allocated members of mCallbackData */
3853	if (mCallbackData.mpsc.valid)
3854	{
3855	if (mCallbackData.mpsc.shape != NULL)
3856	RTMemFree (mCallbackData.mpsc.shape);
3857	}
3858	memset (&mCallbackData, 0, sizeof (mCallbackData));
3859	}
3860
3861	LogFlowThisFuncLeave();
3862	return rc;
3863	}
3864
3865	/**
3866	* @note Locks this object for writing.
3867	*/
3868	HRESULT Console::setMachineState (MachineState_T aMachineState,
3869	bool aUpdateServer /* = true */)
3870	{
3871	AutoCaller autoCaller (this);
3872	AssertComRCReturnRC (autoCaller.rc());
3873
3874	AutoLock alock (this);
3875
3876	HRESULT rc = S_OK;
3877
3878	if (mMachineState != aMachineState)
3879	{
3880	LogFlowThisFunc (("machineState=%d\n", aMachineState));
3881	mMachineState = aMachineState;
3882
3883	/// @todo (dmik)
3884	// possibly, we need to redo onStateChange() using the dedicated
3885	// Event thread, like it is done in VirtualBox. This will make it
3886	// much safer (no deadlocks possible if someone tries to use the
3887	// console from the callback), however, listeners will lose the
3888	// ability to synchronously react to state changes (is it really
3889	// necessary??)
3890	LogFlowThisFunc (("Doing onStateChange()...\n"));
3891	onStateChange (aMachineState);
3892	LogFlowThisFunc (("Done onStateChange()\n"));
3893
3894	if (aUpdateServer)
3895	{
3896	/*
3897	* Server notification MUST be done from under the lock; otherwise
3898	* the machine state here and on the server might go out of sync, that
3899	* can lead to various unexpected results (like the machine state being
3900	* >= MachineState_Running on the server, while the session state is
3901	* already SessionState_SessionClosed at the same time there).
3902	*
3903	* Cross-lock conditions should be carefully watched out: calling
3904	* UpdateState we will require Machine and SessionMachine locks
3905	* (remember that here we're holding the Console lock here, and
3906	* also all locks that have been entered by the thread before calling
3907	* this method).
3908	*/
3909	LogFlowThisFunc (("Doing mControl->UpdateState()...\n"));
3910	rc = mControl->UpdateState (aMachineState);
3911	LogFlowThisFunc (("mControl->UpdateState()=%08X\n", rc));
3912	}
3913	}
3914
3915	return rc;
3916	}
3917
3918	/**
3919	* Searches for a shared folder with the given logical name
3920	* in the collection of shared folders.
3921	*
3922	* @param aName logical name of the shared folder
3923	* @param aSharedFolder where to return the found object
3924	* @param aSetError whether to set the error info if the folder is
3925	* not found
3926	* @return
3927	* S_OK when found or E_INVALIDARG when not found
3928	*
3929	* @note The caller must lock this object for writing.
3930	*/
3931	HRESULT Console::findSharedFolder (const BSTR aName,
3932	ComObjPtr <SharedFolder> &aSharedFolder,
3933	bool aSetError /* = false */)
3934	{
3935	/* sanity check */
3936	AssertReturn (isLockedOnCurrentThread(), E_FAIL);
3937
3938	bool found = false;
3939	for (SharedFolderList::const_iterator it = mSharedFolders.begin();
3940	!found && it != mSharedFolders.end();
3941	++ it)
3942	{
3943	AutoLock alock (*it);
3944	found = (*it)->name() == aName;
3945	if (found)
3946	aSharedFolder = *it;
3947	}
3948
3949	HRESULT rc = found ? S_OK : E_INVALIDARG;
3950
3951	if (aSetError && !found)
3952	setError (rc, tr ("Could not find a shared folder named '%ls'."), aName);
3953
3954	return rc;
3955	}
3956
3957	/**
3958	* VM state callback function. Called by the VMM
3959	* using its state machine states.
3960	*
3961	* Primarily used to handle VM initiated power off, suspend and state saving,
3962	* but also for doing termination completed work (VMSTATE_TERMINATE).
3963	*
3964	* In general this function is called in the context of the EMT.
3965	*
3966	* @param aVM The VM handle.
3967	* @param aState The new state.
3968	* @param aOldState The old state.
3969	* @param aUser The user argument (pointer to the Console object).
3970	*
3971	* @note Locks the Console object for writing.
3972	*/
3973	DECLCALLBACK(void)
3974	Console::vmstateChangeCallback (PVM aVM, VMSTATE aState, VMSTATE aOldState,
3975	void *aUser)
3976	{
3977	LogFlowFunc (("Changing state from %d to %d (aVM=%p)\n",
3978	aOldState, aState, aVM));
3979
3980	Console that = static_cast <Console > (aUser);
3981	AssertReturnVoid (that);
3982
3983	AutoCaller autoCaller (that);
3984	/*
3985	* Note that we must let this method proceed even if Console::uninit() has
3986	* been already called. In such case this VMSTATE change is a result of:
3987	* 1) powerDown() called from uninit() itself, or
3988	* 2) VM-(guest-)initiated power off.
3989	*/
3990	AssertReturnVoid (autoCaller.isOk() \|\|
3991	autoCaller.state() == InUninit);
3992
3993	switch (aState)
3994	{
3995	/*
3996	* The VM has terminated
3997	*/
3998	case VMSTATE_OFF:
3999	{
4000	AutoLock alock (that);
4001
4002	if (that->mVMStateChangeCallbackDisabled)
4003	break;
4004
4005	/*
4006	* Do we still think that it is running? It may happen if this is
4007	* a VM-(guest-)initiated shutdown/poweroff.
4008	*/
4009	if (that->mMachineState != MachineState_Stopping &&
4010	that->mMachineState != MachineState_Saving &&
4011	that->mMachineState != MachineState_Restoring)
4012	{
4013	LogFlowFunc (("VM has powered itself off but Console still "
4014	"thinks it is running. Notifying.\n"));
4015
4016	/* prevent powerDown() from calling VMR3PowerOff() again */
4017	that->setMachineState (MachineState_Stopping);
4018
4019	/*
4020	* Setup task object and thread to carry out the operation
4021	* asynchronously (if we call powerDown() right here but there
4022	* is one or more mpVM callers (added with addVMCaller()) we'll
4023	* deadlock.
4024	*/
4025	std::auto_ptr <VMTask> task (new VMTask (that, true /* aUsesVMPtr */));
4026	/*
4027	* If creating a task is falied, this can currently mean one
4028	* of two: either Console::uninit() has been called just a ms
4029	* before (so a powerDown() call is already on the way), or
4030	* powerDown() itself is being already executed. Just do
4031	* nothing .
4032	*/
4033	if (!task->isOk())
4034	{
4035	LogFlowFunc (("Console is already being uninitialized.\n"));
4036	break;
4037	}
4038
4039	int vrc = RTThreadCreate (NULL, Console::powerDownThread,
4040	(void *) task.get(), 0,
4041	RTTHREADTYPE_MAIN_WORKER, 0,
4042	"VMPowerDowm");
4043
4044	AssertMsgRC (vrc, ("Could not create VMPowerUp thread (%Vrc)\n", vrc));
4045	if (VBOX_FAILURE (vrc))
4046	break;
4047
4048	/* task is now owned by powerDownThread(), so release it */
4049	task.release();
4050	}
4051	break;
4052	}
4053
4054	/*
4055	* The VM has been completely destroyed.
4056	*
4057	* Note: This state change can happen at two points:
4058	* 1) At the end of VMR3Destroy() if it was not called from EMT.
4059	* 2) At the end of vmR3EmulationThread if VMR3Destroy() was
4060	* called by EMT.
4061	*/
4062	case VMSTATE_TERMINATED:
4063	{
4064	AutoLock alock (that);
4065
4066	if (that->mVMStateChangeCallbackDisabled)
4067	break;
4068
4069	/*
4070	* Terminate host interface networking. If aVM is NULL, we've been
4071	* manually called from powerUpThread() either before calling
4072	* VMR3Create() or after VMR3Create() failed, so no need to touch
4073	* networking.
4074	*/
4075	if (aVM)
4076	that->powerDownHostInterfaces();
4077
4078	/*
4079	* From now on the machine is officially powered down or
4080	* remains in the Saved state.
4081	*/
4082	switch (that->mMachineState)
4083	{
4084	default:
4085	AssertFailed();
4086	/* fall through */
4087	case MachineState_Stopping:
4088	/* successfully powered down */
4089	that->setMachineState (MachineState_PoweredOff);
4090	break;
4091	case MachineState_Saving:
4092	/*
4093	* successfully saved (note that the machine is already
4094	* in the Saved state on the server due to EndSavingState()
4095	* called from saveStateThread(), so only change the local
4096	* state)
4097	*/
4098	that->setMachineStateLocally (MachineState_Saved);
4099	break;
4100	case MachineState_Starting:
4101	/*
4102	* failed to start, but be patient: set back to PoweredOff
4103	* (for similarity with the below)
4104	*/
4105	that->setMachineState (MachineState_PoweredOff);
4106	break;
4107	case MachineState_Restoring:
4108	/*
4109	* failed to load the saved state file, but be patient:
4110	* set back to Saved (to preserve the saved state file)
4111	*/
4112	that->setMachineState (MachineState_Saved);
4113	break;
4114	}
4115
4116	break;
4117	}
4118
4119	case VMSTATE_SUSPENDED:
4120	{
4121	if (aOldState == VMSTATE_RUNNING)
4122	{
4123	AutoLock alock (that);
4124
4125	if (that->mVMStateChangeCallbackDisabled)
4126	break;
4127
4128	/* Change the machine state from Running to Paused */
4129	Assert (that->mMachineState == MachineState_Running);
4130	that->setMachineState (MachineState_Paused);
4131	}
4132	}
4133
4134	case VMSTATE_RUNNING:
4135	{
4136	if (aOldState == VMSTATE_CREATED \|\|
4137	aOldState == VMSTATE_SUSPENDED)
4138	{
4139	AutoLock alock (that);
4140
4141	if (that->mVMStateChangeCallbackDisabled)
4142	break;
4143
4144	/*
4145	* Change the machine state from Starting, Restoring or Paused
4146	* to Running
4147	*/
4148	Assert ((that->mMachineState == MachineState_Starting &&
4149	aOldState == VMSTATE_CREATED) \|\|
4150	((that->mMachineState == MachineState_Restoring \|\|
4151	that->mMachineState == MachineState_Paused) &&
4152	aOldState == VMSTATE_SUSPENDED));
4153
4154	that->setMachineState (MachineState_Running);
4155	}
4156	}
4157
4158	default: /* shut up gcc */
4159	break;
4160	}
4161	}
4162
4163	/**
4164	* Sends a request to VMM to attach the given host device.
4165	* After this method succeeds, the attached device will appear in the
4166	* mUSBDevices collection.
4167	*
4168	* @param aHostDevice device to attach
4169	*
4170	* @note Synchronously calls EMT.
4171	* @note Must be called from under this object's lock.
4172	*/
4173	HRESULT Console::attachUSBDevice (IUSBDevice *aHostDevice, PVUSBIRHCONFIG aConfig)
4174	{
4175	AssertReturn (aHostDevice && aConfig, E_FAIL);
4176
4177	AssertReturn (isLockedOnCurrentThread(), E_FAIL);
4178
4179	/* still want a lock object because we need to leave it */
4180	AutoLock alock (this);
4181
4182	HRESULT hrc;
4183
4184	/*
4185	* Get the address and the Uuid, and call the pfnCreateProxyDevice roothub
4186	* method in EMT (using usbAttachCallback()).
4187	*/
4188	Bstr BstrAddress;
4189	hrc = aHostDevice->COMGETTER (Address) (BstrAddress.asOutParam());
4190	ComAssertComRCRetRC (hrc);
4191
4192	Utf8Str Address (BstrAddress);
4193
4194	Guid Uuid;
4195	hrc = aHostDevice->COMGETTER (Id) (Uuid.asOutParam());
4196	ComAssertComRCRetRC (hrc);
4197
4198	BOOL fRemote = FALSE;
4199	void *pvRemote = NULL;
4200
4201	hrc = aHostDevice->COMGETTER (Remote) (&fRemote);
4202	ComAssertComRCRetRC (hrc);
4203
4204	#ifndef VRDP_MC
4205	if (fRemote)
4206	{
4207	pvRemote = mConsoleVRDPServer->GetUSBBackendPointer ();
4208	ComAssertRet (pvRemote, E_FAIL);
4209	}
4210	#endif /* !VRDP_MC */
4211
4212	/* protect mpVM */
4213	AutoVMCaller autoVMCaller (this);
4214	CheckComRCReturnRC (autoVMCaller.rc());
4215
4216	LogFlowThisFunc (("Proxying USB device '%s' {%Vuuid}...\n",
4217	Address.raw(), Uuid.ptr()));
4218
4219	/* leave the lock before a VMR3* call (EMT will call us back)! */
4220	alock.leave();
4221
4222	PVMREQ pReq = NULL;
4223	int vrc = VMR3ReqCall (mpVM, &pReq, RT_INDEFINITE_WAIT,
4224	(PFNRT) usbAttachCallback, 7,
4225	this, aHostDevice,
4226	aConfig, Uuid.ptr(), fRemote, Address.raw(), pvRemote);
4227	if (VBOX_SUCCESS (vrc))
4228	vrc = pReq->iStatus;
4229	VMR3ReqFree (pReq);
4230
4231	/* restore the lock */
4232	alock.enter();
4233
4234	/* hrc is S_OK here */
4235
4236	if (VBOX_FAILURE (vrc))
4237	{
4238	LogWarningThisFunc (("Failed to create proxy device for '%s' {%Vuuid} (%Vrc)\n",
4239	Address.raw(), Uuid.ptr(), vrc));
4240
4241	switch (vrc)
4242	{
4243	case VERR_VUSB_NO_PORTS:
4244	hrc = setError (E_FAIL,
4245	tr ("Failed to attach the USB device. (No available ports on the USB controller)."));
4246	break;
4247	case VERR_VUSB_USBFS_PERMISSION:
4248	hrc = setError (E_FAIL,
4249	tr ("Not permitted to open the USB device, check usbfs options"));
4250	break;
4251	default:
4252	hrc = setError (E_FAIL,
4253	tr ("Failed to create a proxy device for the USB device. (Error: %Vrc)"), vrc);
4254	break;
4255	}
4256	}
4257
4258	return hrc;
4259	}
4260
4261	/**
4262	* USB device attach callback used by AttachUSBDevice().
4263	* Note that AttachUSBDevice() doesn't return until this callback is executed,
4264	* so we don't use AutoCaller and don't care about reference counters of
4265	* interface pointers passed in.
4266	*
4267	* @thread EMT
4268	* @note Locks the console object for writing.
4269	*/
4270	//static
4271	DECLCALLBACK(int)
4272	Console::usbAttachCallback (Console that, IUSBDevice aHostDevice,
4273	PVUSBIRHCONFIG aConfig, PCRTUUID aUuid, bool aRemote,
4274	const char aAddress, void aRemoteBackend)
4275	{
4276	LogFlowFuncEnter();
4277	LogFlowFunc (("that={%p}\n", that));
4278
4279	AssertReturn (that && aConfig && aUuid, VERR_INVALID_PARAMETER);
4280
4281	#ifdef VRDP_MC
4282	if (aRemote)
4283	{
4284	/* @todo aRemoteBackend input parameter is not needed. */
4285	Assert (aRemoteBackend == NULL);
4286
4287	RemoteUSBDevice pRemoteUSBDevice = static_cast <RemoteUSBDevice > (aHostDevice);
4288
4289	Guid guid (*aUuid);
4290
4291	aRemoteBackend = that->consoleVRDPServer ()->USBBackendRequestPointer (pRemoteUSBDevice->clientId (), &guid);
4292
4293	if (aRemoteBackend == NULL)
4294	{
4295	/* The clientId is invalid then. */
4296	return VERR_INVALID_PARAMETER;
4297	}
4298	}
4299	#endif /* VRDP_MC */
4300
4301	int vrc = aConfig->pfnCreateProxyDevice (aConfig, aUuid, aRemote, aAddress,
4302	aRemoteBackend);
4303
4304	if (VBOX_SUCCESS (vrc))
4305	{
4306	/* Create a OUSBDevice and add it to the device list */
4307	ComObjPtr <OUSBDevice> device;
4308	device.createObject();
4309	HRESULT hrc = device->init (aHostDevice);
4310	AssertComRC (hrc);
4311
4312	AutoLock alock (that);
4313	that->mUSBDevices.push_back (device);
4314	LogFlowFunc (("Attached device {%Vuuid}\n", device->id().raw()));
4315
4316	/* notify callbacks */
4317	that->onUSBDeviceStateChange (device, true /* aAttached */, NULL);
4318	}
4319
4320	LogFlowFunc (("vrc=%Vrc\n", vrc));
4321	LogFlowFuncLeave();
4322	return vrc;
4323	}
4324
4325	/**
4326	* Sends a request to VMM to detach the given host device. After this method
4327	* succeeds, the detached device will disappear from the mUSBDevices
4328	* collection.
4329	*
4330	* @param aIt Iterator pointing to the device to detach.
4331	*
4332	* @note Synchronously calls EMT.
4333	* @note Must be called from under this object's lock.
4334	*/
4335	HRESULT Console::detachUSBDevice (USBDeviceList::iterator &aIt)
4336	{
4337	AssertReturn (isLockedOnCurrentThread(), E_FAIL);
4338
4339	/* still want a lock object because we need to leave it */
4340	AutoLock alock (this);
4341
4342	/* protect mpVM */
4343	AutoVMCaller autoVMCaller (this);
4344	CheckComRCReturnRC (autoVMCaller.rc());
4345
4346	PPDMIBASE pBase = NULL;
4347	int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
4348
4349	/* if the device is attached, then there must be a USB controller */
4350	AssertRCReturn (vrc, E_FAIL);
4351
4352	PVUSBIRHCONFIG pRhConfig = (PVUSBIRHCONFIG) pBase->
4353	pfnQueryInterface (pBase, PDMINTERFACE_VUSB_RH_CONFIG);
4354	AssertReturn (pRhConfig, E_FAIL);
4355
4356	LogFlowThisFunc (("Detaching USB proxy device {%Vuuid}...\n",
4357	(*aIt)->id().raw()));
4358
4359	/* leave the lock before a VMR3* call (EMT will call us back)! */
4360	alock.leave();
4361
4362	PVMREQ pReq;
4363	vrc = VMR3ReqCall (mpVM, &pReq, RT_INDEFINITE_WAIT,
4364	(PFNRT) usbDetachCallback, 5,
4365	this, &aIt, pRhConfig, (*aIt)->id().raw());
4366	if (VBOX_SUCCESS (vrc))
4367	vrc = pReq->iStatus;
4368	VMR3ReqFree (pReq);
4369
4370	ComAssertRCRet (vrc, E_FAIL);
4371
4372	return S_OK;
4373	}
4374
4375	/**
4376	* USB device detach callback used by DetachUSBDevice().
4377	* Note that DetachUSBDevice() doesn't return until this callback is executed,
4378	* so we don't use AutoCaller and don't care about reference counters of
4379	* interface pointers passed in.
4380	*
4381	* @thread EMT
4382	* @note Locks the console object for writing.
4383	*/
4384	//static
4385	DECLCALLBACK(int)
4386	Console::usbDetachCallback (Console that, USBDeviceList::iterator aIt,
4387	PVUSBIRHCONFIG aConfig, PCRTUUID aUuid)
4388	{
4389	LogFlowFuncEnter();
4390	LogFlowFunc (("that={%p}\n", that));
4391
4392	AssertReturn (that && aConfig && aUuid, VERR_INVALID_PARAMETER);
4393
4394	#ifdef VRDP_MC
4395	/*
4396	* If that was a remote device, release the backend pointer.
4397	* The pointer was requested in usbAttachCallback.
4398	*/
4399	BOOL fRemote = FALSE;
4400
4401	HRESULT hrc2 = (**aIt)->COMGETTER (Remote) (&fRemote);
4402	ComAssertComRC (hrc2);
4403
4404	if (fRemote)
4405	{
4406	Guid guid (*aUuid);
4407	that->consoleVRDPServer ()->USBBackendReleasePointer (&guid);
4408	}
4409	#endif /* VRDP_MC */
4410
4411	int vrc = aConfig->pfnDestroyProxyDevice (aConfig, aUuid);
4412
4413	if (VBOX_SUCCESS (vrc))
4414	{
4415	AutoLock alock (that);
4416
4417	/* Remove the device from the collection */
4418	that->mUSBDevices.erase (*aIt);
4419	LogFlowFunc (("Detached device {%Vuuid}\n", (**aIt)->id().raw()));
4420
4421	/* notify callbacks */
4422	that->onUSBDeviceStateChange (*aIt, false / aAttached */, NULL);
4423	}
4424
4425	LogFlowFunc (("vrc=%Vrc\n", vrc));
4426	LogFlowFuncLeave();
4427	return vrc;
4428	}
4429
4430	/**
4431	* Construct the VM configuration tree (CFGM).
4432	*
4433	* This is a callback for VMR3Create() call. It is called from CFGMR3Init()
4434	* in the emulation thread (EMT). Any per thread COM/XPCOM initialization
4435	* is done here.
4436	*
4437	* @param pVM VM handle.
4438	* @param pvTask Pointer to the VMPowerUpTask object.
4439	* @return VBox status code.
4440	*
4441	* @note Locks the Console object for writing.
4442	*/
4443	DECLCALLBACK(int) Console::configConstructor(PVM pVM, void *pvTask)
4444	{
4445	LogFlowFuncEnter();
4446
4447	/* Note: the task pointer is owned by powerUpThread() */
4448	VMPowerUpTask task = static_cast <VMPowerUpTask > (pvTask);
4449	AssertReturn (task, VERR_GENERAL_FAILURE);
4450
4451	#if defined(__WIN__)
4452	{
4453	/* initialize COM */
4454	HRESULT hrc = CoInitializeEx(NULL,
4455	COINIT_MULTITHREADED \| COINIT_DISABLE_OLE1DDE \|
4456	COINIT_SPEED_OVER_MEMORY);
4457	LogFlow (("Console::configConstructor(): CoInitializeEx()=%08X\n", hrc));
4458	AssertComRCReturn (hrc, VERR_GENERAL_FAILURE);
4459	}
4460	#endif
4461
4462	ComObjPtr <Console> pConsole = task->mConsole;
4463
4464	AutoCaller autoCaller (pConsole);
4465	AssertComRCReturn (autoCaller.rc(), VERR_ACCESS_DENIED);
4466
4467	/* lock the console because we widely use internal fields and methods */
4468	AutoLock alock (pConsole);
4469
4470	ComPtr <IMachine> pMachine = pConsole->machine();
4471
4472	int rc;
4473	HRESULT hrc;
4474	char *psz = NULL;
4475	BSTR str = NULL;
4476	ULONG cRamMBs;
4477	ULONG cMonitors;
4478	unsigned i;
4479
4480	#define STR_CONV() do { rc = RTStrUcs2ToUtf8(&psz, str); RC_CHECK(); } while (0)
4481	#define STR_FREE() do { if (str) { SysFreeString(str); str = NULL; } if (psz) { RTStrFree(psz); psz = NULL; } } while (0)
4482	#define RC_CHECK() do { if (VBOX_FAILURE(rc)) { AssertMsgFailed(("rc=%Vrc\n", rc)); STR_FREE(); return rc; } } while (0)
4483	#define H() do { if (FAILED(hrc)) { AssertMsgFailed(("hrc=%#x\n", hrc)); STR_FREE(); return VERR_GENERAL_FAILURE; } } while (0)
4484
4485	/* Get necessary objects */
4486
4487	ComPtr<IVirtualBox> virtualBox;
4488	hrc = pMachine->COMGETTER(Parent)(virtualBox.asOutParam()); H();
4489
4490	ComPtr<IHost> host;
4491	hrc = virtualBox->COMGETTER(Host)(host.asOutParam()); H();
4492
4493	ComPtr <ISystemProperties> systemProperties;
4494	hrc = virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam()); H();
4495
4496	ComPtr<IBIOSSettings> biosSettings;
4497	hrc = pMachine->COMGETTER(BIOSSettings)(biosSettings.asOutParam()); H();
4498
4499
4500	/*
4501	* Get root node first.
4502	* This is the only node in the tree.
4503	*/
4504	PCFGMNODE pRoot = CFGMR3GetRoot(pVM);
4505	Assert(pRoot);
4506
4507	/*
4508	* Set the root level values.
4509	*/
4510	hrc = pMachine->COMGETTER(Name)(&str); H();
4511	STR_CONV();
4512	rc = CFGMR3InsertString(pRoot, "Name", psz); RC_CHECK();
4513	STR_FREE();
4514	hrc = pMachine->COMGETTER(MemorySize)(&cRamMBs); H();
4515	rc = CFGMR3InsertInteger(pRoot, "RamSize", cRamMBs * _1M); RC_CHECK();
4516	rc = CFGMR3InsertInteger(pRoot, "TimerMillies", 10); RC_CHECK();
4517	rc = CFGMR3InsertInteger(pRoot, "RawR3Enabled", 1); /* boolean */ RC_CHECK();
4518	rc = CFGMR3InsertInteger(pRoot, "RawR0Enabled", 1); /* boolean */ RC_CHECK();
4519	/** @todo Config: RawR0, PATMEnabled and CASMEnabled needs attention later. */
4520	rc = CFGMR3InsertInteger(pRoot, "PATMEnabled", 1); /* boolean */ RC_CHECK();
4521	rc = CFGMR3InsertInteger(pRoot, "CSAMEnabled", 1); /* boolean */ RC_CHECK();
4522
4523	/* hardware virtualization extensions */
4524	TriStateBool_T hwVirtExEnabled;
4525	BOOL fHWVirtExEnabled;
4526	hrc = pMachine->COMGETTER(HWVirtExEnabled)(&hwVirtExEnabled); H();
4527	if (hwVirtExEnabled == TriStateBool_Default)
4528	{
4529	/* check the default value */
4530	hrc = systemProperties->COMGETTER(HWVirtExEnabled)(&fHWVirtExEnabled); H();
4531	}
4532	else
4533	fHWVirtExEnabled = (hwVirtExEnabled == TriStateBool_True);
4534	if (fHWVirtExEnabled)
4535	{
4536	PCFGMNODE pHWVirtExt;
4537	rc = CFGMR3InsertNode(pRoot, "HWVirtExt", &pHWVirtExt); RC_CHECK();
4538	rc = CFGMR3InsertInteger(pHWVirtExt, "Enabled", 1); RC_CHECK();
4539	}
4540
4541	BOOL fIOAPIC;
4542	hrc = biosSettings->COMGETTER(IOAPICEnabled)(&fIOAPIC); H();
4543
4544	/*
4545	* PDM config.
4546	* Load drivers in VBoxC.[so\|dll]
4547	*/
4548	PCFGMNODE pPDM;
4549	PCFGMNODE pDrivers;
4550	PCFGMNODE pMod;
4551	rc = CFGMR3InsertNode(pRoot, "PDM", &pPDM); RC_CHECK();
4552	rc = CFGMR3InsertNode(pPDM, "Drivers", &pDrivers); RC_CHECK();
4553	rc = CFGMR3InsertNode(pDrivers, "VBoxC", &pMod); RC_CHECK();
4554	#ifdef VBOX_WITH_XPCOM
4555	// VBoxC is located in the components subdirectory
4556	char szPathProgram[RTPATH_MAX + sizeof("/components/VBoxC")];
4557	rc = RTPathProgram(szPathProgram, RTPATH_MAX); AssertRC(rc);
4558	strcat(szPathProgram, "/components/VBoxC");
4559	rc = CFGMR3InsertString(pMod, "Path", szPathProgram); RC_CHECK();
4560	#else
4561	rc = CFGMR3InsertString(pMod, "Path", "VBoxC"); RC_CHECK();
4562	#endif
4563
4564	/*
4565	* Devices
4566	*/
4567	PCFGMNODE pDevices = NULL; /* /Devices */
4568	PCFGMNODE pDev = NULL; /* /Devices/Dev/ */
4569	PCFGMNODE pInst = NULL; /* /Devices/Dev/0/ */
4570	PCFGMNODE pCfg = NULL; /* /Devices/Dev/.../Config/ */
4571	PCFGMNODE pLunL0 = NULL; /* /Devices/Dev/0/LUN#0/ */
4572	PCFGMNODE pLunL1 = NULL; /* /Devices/Dev/0/LUN#0/AttachedDriver/ */
4573	rc = CFGMR3InsertNode(pRoot, "Devices", &pDevices); RC_CHECK();
4574
4575	/*
4576	* PC Arch.
4577	*/
4578	rc = CFGMR3InsertNode(pDevices, "pcarch", &pDev); RC_CHECK();
4579	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4580	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4581	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4582
4583	/*
4584	* PC Bios.
4585	*/
4586	rc = CFGMR3InsertNode(pDevices, "pcbios", &pDev); RC_CHECK();
4587	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4588	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4589	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4590	rc = CFGMR3InsertInteger(pCfg, "RamSize", cRamMBs * _1M); RC_CHECK();
4591	rc = CFGMR3InsertString(pCfg, "HardDiskDevice", "piix3ide"); RC_CHECK();
4592	rc = CFGMR3InsertString(pCfg, "FloppyDevice", "i82078"); RC_CHECK();
4593	rc = CFGMR3InsertInteger(pCfg, "IOAPIC", fIOAPIC); RC_CHECK();
4594
4595	DeviceType_T bootDevice;
4596	if (SchemaDefs::MaxBootPosition > 9)
4597	{
4598	AssertMsgFailed (("Too many boot devices %d\n",
4599	SchemaDefs::MaxBootPosition));
4600	return VERR_INVALID_PARAMETER;
4601	}
4602
4603	for (ULONG pos = 1; pos <= SchemaDefs::MaxBootPosition; pos ++)
4604	{
4605	hrc = pMachine->GetBootOrder(pos, &bootDevice); H();
4606
4607	char szParamName[] = "BootDeviceX";
4608	szParamName[sizeof (szParamName) - 2] = ((char (pos - 1)) + '0');
4609
4610	const char *pszBootDevice;
4611	switch (bootDevice)
4612	{
4613	case DeviceType_NoDevice:
4614	pszBootDevice = "NONE";
4615	break;
4616	case DeviceType_HardDiskDevice:
4617	pszBootDevice = "IDE";
4618	break;
4619	case DeviceType_DVDDevice:
4620	pszBootDevice = "DVD";
4621	break;
4622	case DeviceType_FloppyDevice:
4623	pszBootDevice = "FLOPPY";
4624	break;
4625	case DeviceType_NetworkDevice:
4626	pszBootDevice = "LAN";
4627	break;
4628	default:
4629	AssertMsgFailed(("Invalid bootDevice=%d\n", bootDevice));
4630	return VERR_INVALID_PARAMETER;
4631	}
4632	rc = CFGMR3InsertString(pCfg, szParamName, pszBootDevice); RC_CHECK();
4633	}
4634
4635	/*
4636	* BIOS logo
4637	*/
4638	BOOL fFadeIn;
4639	hrc = biosSettings->COMGETTER(LogoFadeIn)(&fFadeIn); H();
4640	rc = CFGMR3InsertInteger(pCfg, "FadeIn", fFadeIn ? 1 : 0); RC_CHECK();
4641	BOOL fFadeOut;
4642	hrc = biosSettings->COMGETTER(LogoFadeOut)(&fFadeOut); H();
4643	rc = CFGMR3InsertInteger(pCfg, "FadeOut", fFadeOut ? 1: 0); RC_CHECK();
4644	ULONG logoDisplayTime;
4645	hrc = biosSettings->COMGETTER(LogoDisplayTime)(&logoDisplayTime); H();
4646	rc = CFGMR3InsertInteger(pCfg, "LogoTime", logoDisplayTime); RC_CHECK();
4647	Bstr logoImagePath;
4648	hrc = biosSettings->COMGETTER(LogoImagePath)(logoImagePath.asOutParam()); H();
4649	rc = CFGMR3InsertString(pCfg, "LogoFile", logoImagePath ? Utf8Str(logoImagePath) : ""); RC_CHECK();
4650
4651	/*
4652	* Boot menu
4653	*/
4654	BIOSBootMenuMode_T bootMenuMode;
4655	int value;
4656	biosSettings->COMGETTER(BootMenuMode)(&bootMenuMode);
4657	switch (bootMenuMode)
4658	{
4659	case BIOSBootMenuMode_Disabled:
4660	value = 0;
4661	break;
4662	case BIOSBootMenuMode_MenuOnly:
4663	value = 1;
4664	break;
4665	default:
4666	value = 2;
4667	}
4668	rc = CFGMR3InsertInteger(pCfg, "ShowBootMenu", value); RC_CHECK();
4669
4670	/*
4671	* The time offset
4672	*/
4673	LONG64 timeOffset;
4674	hrc = biosSettings->COMGETTER(TimeOffset)(&timeOffset); H();
4675	PCFGMNODE pTMNode;
4676	rc = CFGMR3InsertNode(pRoot, "TM", &pTMNode); RC_CHECK();
4677	rc = CFGMR3InsertInteger(pTMNode, "UTCOffset", timeOffset * 1000000); RC_CHECK();
4678
4679	/*
4680	* ACPI
4681	*/
4682	BOOL fACPI;
4683	hrc = biosSettings->COMGETTER(ACPIEnabled)(&fACPI); H();
4684	if (fACPI)
4685	{
4686	rc = CFGMR3InsertNode(pDevices, "acpi", &pDev); RC_CHECK();
4687	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4688	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4689	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4690	rc = CFGMR3InsertInteger(pCfg, "RamSize", cRamMBs * _1M); RC_CHECK();
4691	rc = CFGMR3InsertInteger(pCfg, "IOAPIC", fIOAPIC); RC_CHECK();
4692	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", 7); RC_CHECK();
4693	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 0); RC_CHECK();
4694
4695	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
4696	rc = CFGMR3InsertString(pLunL0, "Driver", "ACPIHost"); RC_CHECK();
4697	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4698	}
4699
4700	/*
4701	* DMA
4702	*/
4703	rc = CFGMR3InsertNode(pDevices, "8237A", &pDev); RC_CHECK();
4704	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4705	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4706
4707	/*
4708	* PCI bus.
4709	*/
4710	rc = CFGMR3InsertNode(pDevices, "pci", &pDev); /* piix3 */ RC_CHECK();
4711	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4712	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4713	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4714	rc = CFGMR3InsertInteger(pCfg, "IOAPIC", fIOAPIC); RC_CHECK();
4715
4716	/*
4717	* PS/2 keyboard & mouse.
4718	*/
4719	rc = CFGMR3InsertNode(pDevices, "pckbd", &pDev); RC_CHECK();
4720	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4721	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4722	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4723
4724	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
4725	rc = CFGMR3InsertString(pLunL0, "Driver", "KeyboardQueue"); RC_CHECK();
4726	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4727	rc = CFGMR3InsertInteger(pCfg, "QueueSize", 64); RC_CHECK();
4728
4729	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
4730	rc = CFGMR3InsertString(pLunL1, "Driver", "MainKeyboard"); RC_CHECK();
4731	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
4732	Keyboard *pKeyboard = pConsole->mKeyboard;
4733	rc = CFGMR3InsertInteger(pCfg, "Object", (uintptr_t)pKeyboard); RC_CHECK();
4734
4735	rc = CFGMR3InsertNode(pInst, "LUN#1", &pLunL0); RC_CHECK();
4736	rc = CFGMR3InsertString(pLunL0, "Driver", "MouseQueue"); RC_CHECK();
4737	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4738	rc = CFGMR3InsertInteger(pCfg, "QueueSize", 128); RC_CHECK();
4739
4740	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
4741	rc = CFGMR3InsertString(pLunL1, "Driver", "MainMouse"); RC_CHECK();
4742	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
4743	Mouse *pMouse = pConsole->mMouse;
4744	rc = CFGMR3InsertInteger(pCfg, "Object", (uintptr_t)pMouse); RC_CHECK();
4745
4746	/*
4747	* i82078 Floppy drive controller
4748	*/
4749	ComPtr<IFloppyDrive> floppyDrive;
4750	hrc = pMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam()); H();
4751	BOOL fFloppyEnabled;
4752	hrc = floppyDrive->COMGETTER(Enabled)(&fFloppyEnabled); H();
4753	if (fFloppyEnabled)
4754	{
4755	rc = CFGMR3InsertNode(pDevices, "i82078", &pDev); RC_CHECK();
4756	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4757	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); RC_CHECK();
4758	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4759	rc = CFGMR3InsertInteger(pCfg, "IRQ", 6); RC_CHECK();
4760	rc = CFGMR3InsertInteger(pCfg, "DMA", 2); RC_CHECK();
4761	rc = CFGMR3InsertInteger(pCfg, "MemMapped", 0 ); RC_CHECK();
4762	rc = CFGMR3InsertInteger(pCfg, "IOBase", 0x3f0); RC_CHECK();
4763
4764	/* Attach the status driver */
4765	rc = CFGMR3InsertNode(pInst, "LUN#999", &pLunL0); RC_CHECK();
4766	rc = CFGMR3InsertString(pLunL0, "Driver", "MainStatus"); RC_CHECK();
4767	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4768	rc = CFGMR3InsertInteger(pCfg, "papLeds", (uintptr_t)&pConsole->mapFDLeds[0]); RC_CHECK();
4769	rc = CFGMR3InsertInteger(pCfg, "First", 0); RC_CHECK();
4770	rc = CFGMR3InsertInteger(pCfg, "Last", 0); RC_CHECK();
4771
4772	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
4773
4774	ComPtr<IFloppyImage> floppyImage;
4775	hrc = floppyDrive->GetImage(floppyImage.asOutParam()); H();
4776	if (floppyImage)
4777	{
4778	pConsole->meFloppyState = DriveState_ImageMounted;
4779	rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
4780	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4781	rc = CFGMR3InsertString(pCfg, "Type", "Floppy 1.44"); RC_CHECK();
4782	rc = CFGMR3InsertInteger(pCfg, "Mountable", 1); RC_CHECK();
4783
4784	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
4785	rc = CFGMR3InsertString(pLunL1, "Driver", "RawImage"); RC_CHECK();
4786	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
4787	hrc = floppyImage->COMGETTER(FilePath)(&str); H();
4788	STR_CONV();
4789	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
4790	STR_FREE();
4791	}
4792	else
4793	{
4794	ComPtr<IHostFloppyDrive> hostFloppyDrive;
4795	hrc = floppyDrive->GetHostDrive(hostFloppyDrive.asOutParam()); H();
4796	if (hostFloppyDrive)
4797	{
4798	pConsole->meFloppyState = DriveState_HostDriveCaptured;
4799	rc = CFGMR3InsertString(pLunL0, "Driver", "HostFloppy"); RC_CHECK();
4800	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4801	hrc = hostFloppyDrive->COMGETTER(Name)(&str); H();
4802	STR_CONV();
4803	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
4804	STR_FREE();
4805	}
4806	else
4807	{
4808	pConsole->meFloppyState = DriveState_NotMounted;
4809	rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
4810	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4811	rc = CFGMR3InsertString(pCfg, "Type", "Floppy 1.44"); RC_CHECK();
4812	rc = CFGMR3InsertInteger(pCfg, "Mountable", 1); RC_CHECK();
4813	}
4814	}
4815	}
4816
4817	/*
4818	* i8254 Programmable Interval Timer And Dummy Speaker
4819	*/
4820	rc = CFGMR3InsertNode(pDevices, "i8254", &pDev); RC_CHECK();
4821	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4822	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4823	#ifdef DEBUG
4824	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4825	#endif
4826
4827	/*
4828	* i8259 Programmable Interrupt Controller.
4829	*/
4830	rc = CFGMR3InsertNode(pDevices, "i8259", &pDev); RC_CHECK();
4831	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4832	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4833	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4834
4835	/*
4836	* Advanced Programmable Interrupt Controller.
4837	*/
4838	rc = CFGMR3InsertNode(pDevices, "apic", &pDev); RC_CHECK();
4839	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4840	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4841	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4842	rc = CFGMR3InsertInteger(pCfg, "IOAPIC", fIOAPIC); RC_CHECK();
4843
4844	if (fIOAPIC)
4845	{
4846	/*
4847	* I/O Advanced Programmable Interrupt Controller.
4848	*/
4849	rc = CFGMR3InsertNode(pDevices, "ioapic", &pDev); RC_CHECK();
4850	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4851	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4852	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4853	}
4854
4855	/*
4856	* RTC MC146818.
4857	*/
4858	rc = CFGMR3InsertNode(pDevices, "mc146818", &pDev); RC_CHECK();
4859	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4860	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4861
4862	#if 0
4863	/*
4864	* Serial ports
4865	*/
4866	rc = CFGMR3InsertNode(pDevices, "serial", &pDev); RC_CHECK();
4867	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4868	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4869	rc = CFGMR3InsertInteger(pCfg, "IRQ", 4); RC_CHECK();
4870	rc = CFGMR3InsertInteger(pCfg, "IOBase", 0x3f8); RC_CHECK();
4871
4872	rc = CFGMR3InsertNode(pDev, "1", &pInst); RC_CHECK();
4873	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4874	rc = CFGMR3InsertInteger(pCfg, "IRQ", 3); RC_CHECK();
4875	rc = CFGMR3InsertInteger(pCfg, "IOBase", 0x2f8); RC_CHECK();
4876	#endif
4877
4878	/*
4879	* VGA.
4880	*/
4881	rc = CFGMR3InsertNode(pDevices, "vga", &pDev); RC_CHECK();
4882	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4883	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4884	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", 2); RC_CHECK();
4885	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 0); RC_CHECK();
4886	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4887	hrc = pMachine->COMGETTER(VRAMSize)(&cRamMBs); H();
4888	rc = CFGMR3InsertInteger(pCfg, "VRamSize", cRamMBs * _1M); RC_CHECK();
4889	hrc = pMachine->COMGETTER(MonitorCount)(&cMonitors); H();
4890	rc = CFGMR3InsertInteger(pCfg, "MonitorCount", cMonitors); RC_CHECK();
4891
4892	/* Custom VESA mode list */
4893	unsigned cModes = 0;
4894	for (unsigned iMode = 1; iMode <= 16; iMode++)
4895	{
4896	char szExtraDataKey[sizeof("CustomVideoModeXX")];
4897	RTStrPrintf(szExtraDataKey, sizeof(szExtraDataKey), "CustomVideoMode%d", iMode);
4898	hrc = pMachine->GetExtraData(Bstr(szExtraDataKey), &str); H();
4899	if (!str \|\| !*str)
4900	break;
4901	STR_CONV();
4902	rc = CFGMR3InsertString(pCfg, szExtraDataKey, psz);
4903	STR_FREE();
4904	cModes++;
4905	}
4906	rc = CFGMR3InsertInteger(pCfg, "CustomVideoModes", cModes);
4907
4908	/* VESA height reduction */
4909	ULONG ulHeightReduction;
4910	IFramebuffer *pFramebuffer = pConsole->getDisplay()->getFramebuffer();
4911	hrc = pFramebuffer->COMGETTER(HeightReduction)(&ulHeightReduction); H();
4912	rc = CFGMR3InsertInteger(pCfg, "HeightReduction", ulHeightReduction); RC_CHECK();
4913
4914	/* Attach the display. */
4915	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
4916	rc = CFGMR3InsertString(pLunL0, "Driver", "MainDisplay"); RC_CHECK();
4917	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4918	Display *pDisplay = pConsole->mDisplay;
4919	rc = CFGMR3InsertInteger(pCfg, "Object", (uintptr_t)pDisplay); RC_CHECK();
4920
4921	/*
4922	* IDE (update this when the main interface changes)
4923	*/
4924	rc = CFGMR3InsertNode(pDevices, "piix3ide", &pDev); /* piix3 */ RC_CHECK();
4925	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
4926	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
4927	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", 1); RC_CHECK();
4928	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 1); RC_CHECK();
4929	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
4930
4931	/* Attach the status driver */
4932	rc = CFGMR3InsertNode(pInst, "LUN#999", &pLunL0); RC_CHECK();
4933	rc = CFGMR3InsertString(pLunL0, "Driver", "MainStatus"); RC_CHECK();
4934	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4935	rc = CFGMR3InsertInteger(pCfg, "papLeds", (uintptr_t)&pConsole->mapIDELeds[0]);RC_CHECK();
4936	rc = CFGMR3InsertInteger(pCfg, "First", 0); RC_CHECK();
4937	rc = CFGMR3InsertInteger(pCfg, "Last", 3); RC_CHECK();
4938
4939	/* Attach the harddisks */
4940	ComPtr<IHardDiskAttachmentCollection> hdaColl;
4941	hrc = pMachine->COMGETTER(HardDiskAttachments)(hdaColl.asOutParam()); H();
4942	ComPtr<IHardDiskAttachmentEnumerator> hdaEnum;
4943	hrc = hdaColl->Enumerate(hdaEnum.asOutParam()); H();
4944
4945	BOOL fMore = FALSE;
4946	while ( SUCCEEDED(hrc = hdaEnum->HasMore(&fMore))
4947	&& fMore)
4948	{
4949	ComPtr<IHardDiskAttachment> hda;
4950	hrc = hdaEnum->GetNext(hda.asOutParam()); H();
4951	ComPtr<IHardDisk> hardDisk;
4952	hrc = hda->COMGETTER(HardDisk)(hardDisk.asOutParam()); H();
4953	DiskControllerType_T enmCtl;
4954	hrc = hda->COMGETTER(Controller)(&enmCtl); H();
4955	LONG lDev;
4956	hrc = hda->COMGETTER(DeviceNumber)(&lDev); H();
4957
4958	switch (enmCtl)
4959	{
4960	case DiskControllerType_IDE0Controller:
4961	i = 0;
4962	break;
4963	case DiskControllerType_IDE1Controller:
4964	i = 2;
4965	break;
4966	default:
4967	AssertMsgFailed(("invalid disk controller type: %d\n", enmCtl));
4968	return VERR_GENERAL_FAILURE;
4969	}
4970
4971	if (lDev < 0 \|\| lDev >= 2)
4972	{
4973	AssertMsgFailed(("invalid controller device number: %d\n", lDev));
4974	return VERR_GENERAL_FAILURE;
4975	}
4976
4977	i = i + lDev;
4978
4979	char szLUN[16];
4980	RTStrPrintf(szLUN, sizeof(szLUN), "LUN#%d", i);
4981	rc = CFGMR3InsertNode(pInst, szLUN, &pLunL0); RC_CHECK();
4982	rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
4983	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
4984	rc = CFGMR3InsertString(pCfg, "Type", "HardDisk"); RC_CHECK();
4985	rc = CFGMR3InsertInteger(pCfg, "Mountable", 0); RC_CHECK();
4986
4987	HardDiskStorageType_T hddType;
4988	hardDisk->COMGETTER(StorageType)(&hddType);
4989	if (hddType == HardDiskStorageType_VirtualDiskImage)
4990	{
4991	ComPtr<IVirtualDiskImage> vdiDisk = hardDisk;
4992	AssertBreak (!vdiDisk.isNull(), hrc = E_FAIL);
4993
4994	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
4995	rc = CFGMR3InsertString(pLunL1, "Driver", "VBoxHDD"); RC_CHECK();
4996	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
4997	hrc = vdiDisk->COMGETTER(FilePath)(&str); H();
4998	STR_CONV();
4999	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
5000	STR_FREE();
5001
5002	/* Create an inversed tree of parents. */
5003	ComPtr<IHardDisk> parentHardDisk = hardDisk;
5004	for (PCFGMNODE pParent = pCfg;;)
5005	{
5006	ComPtr<IHardDisk> curHardDisk;
5007	hrc = parentHardDisk->COMGETTER(Parent)(curHardDisk.asOutParam()); H();
5008	if (!curHardDisk)
5009	break;
5010
5011	vdiDisk = curHardDisk;
5012	AssertBreak (!vdiDisk.isNull(), hrc = E_FAIL);
5013
5014	PCFGMNODE pCur;
5015	rc = CFGMR3InsertNode(pParent, "Parent", &pCur); RC_CHECK();
5016	hrc = vdiDisk->COMGETTER(FilePath)(&str); H();
5017	STR_CONV();
5018	rc = CFGMR3InsertString(pCur, "Path", psz); RC_CHECK();
5019	STR_FREE();
5020	rc = CFGMR3InsertInteger(pCur, "ReadOnly", 1); RC_CHECK();
5021
5022	/* next */
5023	pParent = pCur;
5024	parentHardDisk = curHardDisk;
5025	}
5026	}
5027	else if (hddType == HardDiskStorageType_ISCSIHardDisk)
5028	{
5029	ComPtr<IISCSIHardDisk> iSCSIDisk = hardDisk;
5030	AssertBreak (!iSCSIDisk.isNull(), hrc = E_FAIL);
5031
5032	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
5033	rc = CFGMR3InsertString(pLunL1, "Driver", "iSCSI"); RC_CHECK();
5034	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
5035
5036	/* Set up the iSCSI initiator driver configuration. */
5037	hrc = iSCSIDisk->COMGETTER(Target)(&str); H();
5038	STR_CONV();
5039	rc = CFGMR3InsertString(pCfg, "TargetName", psz); RC_CHECK();
5040	STR_FREE();
5041
5042	// @todo currently there is no Initiator name config.
5043	rc = CFGMR3InsertString(pCfg, "InitiatorName", "iqn.2006-02.de.innotek.initiator"); RC_CHECK();
5044
5045	ULONG64 lun;
5046	hrc = iSCSIDisk->COMGETTER(Lun)(&lun); H();
5047	rc = CFGMR3InsertInteger(pCfg, "LUN", lun); RC_CHECK();
5048
5049	hrc = iSCSIDisk->COMGETTER(Server)(&str); H();
5050	STR_CONV();
5051	USHORT port;
5052	hrc = iSCSIDisk->COMGETTER(Port)(&port); H();
5053	if (port != 0)
5054	{
5055	char *pszTN;
5056	RTStrAPrintf(&pszTN, "%s:%u", psz, port);
5057	rc = CFGMR3InsertString(pCfg, "TargetAddress", pszTN); RC_CHECK();
5058	RTStrFree(pszTN);
5059	}
5060	else
5061	{
5062	rc = CFGMR3InsertString(pCfg, "TargetAddress", psz); RC_CHECK();
5063	}
5064	STR_FREE();
5065
5066	hrc = iSCSIDisk->COMGETTER(UserName)(&str); H();
5067	if (str)
5068	{
5069	STR_CONV();
5070	rc = CFGMR3InsertString(pCfg, "InitiatorUsername", psz); RC_CHECK();
5071	STR_FREE();
5072	}
5073
5074	hrc = iSCSIDisk->COMGETTER(Password)(&str); H();
5075	if (str)
5076	{
5077	STR_CONV();
5078	rc = CFGMR3InsertString(pCfg, "InitiatorSecret", psz); RC_CHECK();
5079	STR_FREE();
5080	}
5081
5082	// @todo currently there is no target username config.
5083	//rc = CFGMR3InsertString(pCfg, "TargetUsername", ""); RC_CHECK();
5084
5085	// @todo currently there is no target password config.
5086	//rc = CFGMR3InsertString(pCfg, "TargetSecret", ""); RC_CHECK();
5087
5088	/* The iSCSI initiator needs an attached iSCSI transport driver. */
5089	PCFGMNODE pLunL2 = NULL; /* /Devices/Dev/0/LUN#0/AttachedDriver/AttachedDriver */
5090	rc = CFGMR3InsertNode(pLunL1, "AttachedDriver", &pLunL2); RC_CHECK();
5091	rc = CFGMR3InsertString(pLunL2, "Driver", "iSCSITCP"); RC_CHECK();
5092	/* Currently the transport driver has no config options. */
5093	}
5094	else if (hddType == HardDiskStorageType_VMDKImage)
5095	{
5096	ComPtr<IVMDKImage> vmdkDisk = hardDisk;
5097	AssertBreak (!vmdkDisk.isNull(), hrc = E_FAIL);
5098
5099	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
5100	#if 1 /* Enable new VD container code (and new VMDK), as the bugs are fixed. */
5101	rc = CFGMR3InsertString(pLunL1, "Driver", "VD"); RC_CHECK();
5102	#else
5103	rc = CFGMR3InsertString(pLunL1, "Driver", "VmdkHDD"); RC_CHECK();
5104	#endif
5105	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
5106	hrc = vmdkDisk->COMGETTER(FilePath)(&str); H();
5107	STR_CONV();
5108	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
5109	STR_FREE();
5110	}
5111	else
5112	AssertFailed();
5113	}
5114	H();
5115
5116	ComPtr<IDVDDrive> dvdDrive;
5117	hrc = pMachine->COMGETTER(DVDDrive)(dvdDrive.asOutParam()); H();
5118	if (dvdDrive)
5119	{
5120	// ASSUME: DVD drive is always attached to LUN#2 (i.e. secondary IDE master)
5121	rc = CFGMR3InsertNode(pInst, "LUN#2", &pLunL0); RC_CHECK();
5122	ComPtr<IHostDVDDrive> hostDvdDrive;
5123	hrc = dvdDrive->GetHostDrive(hostDvdDrive.asOutParam()); H();
5124	if (hostDvdDrive)
5125	{
5126	pConsole->meDVDState = DriveState_HostDriveCaptured;
5127	rc = CFGMR3InsertString(pLunL0, "Driver", "HostDVD"); RC_CHECK();
5128	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5129	hrc = hostDvdDrive->COMGETTER(Name)(&str); H();
5130	STR_CONV();
5131	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
5132	STR_FREE();
5133	BOOL fPassthrough;
5134	hrc = dvdDrive->COMGETTER(Passthrough)(&fPassthrough); H();
5135	rc = CFGMR3InsertInteger(pCfg, "Passthrough", !!fPassthrough); RC_CHECK();
5136	}
5137	else
5138	{
5139	pConsole->meDVDState = DriveState_NotMounted;
5140	rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
5141	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5142	rc = CFGMR3InsertString(pCfg, "Type", "DVD"); RC_CHECK();
5143	rc = CFGMR3InsertInteger(pCfg, "Mountable", 1); RC_CHECK();
5144
5145	ComPtr<IDVDImage> dvdImage;
5146	hrc = dvdDrive->GetImage(dvdImage.asOutParam()); H();
5147	if (dvdImage)
5148	{
5149	pConsole->meDVDState = DriveState_ImageMounted;
5150	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
5151	rc = CFGMR3InsertString(pLunL1, "Driver", "MediaISO"); RC_CHECK();
5152	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
5153	hrc = dvdImage->COMGETTER(FilePath)(&str); H();
5154	STR_CONV();
5155	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
5156	STR_FREE();
5157	}
5158	}
5159	}
5160
5161	/*
5162	* Network adapters
5163	*/
5164	rc = CFGMR3InsertNode(pDevices, "pcnet", &pDev); RC_CHECK();
5165	//rc = CFGMR3InsertNode(pDevices, "ne2000", &pDev); RC_CHECK();
5166	for (ULONG ulInstance = 0; ulInstance < SchemaDefs::NetworkAdapterCount; ulInstance++)
5167	{
5168	ComPtr<INetworkAdapter> networkAdapter;
5169	hrc = pMachine->GetNetworkAdapter(ulInstance, networkAdapter.asOutParam()); H();
5170	BOOL fEnabled = FALSE;
5171	hrc = networkAdapter->COMGETTER(Enabled)(&fEnabled); H();
5172	if (!fEnabled)
5173	continue;
5174
5175	char szInstance[4]; Assert(ulInstance <= 999);
5176	RTStrPrintf(szInstance, sizeof(szInstance), "%lu", ulInstance);
5177	rc = CFGMR3InsertNode(pDev, szInstance, &pInst); RC_CHECK();
5178	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
5179	/* the first network card gets the PCI ID 3, the followings starting from 8 */
5180	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", !ulInstance ? 3 : ulInstance - 1 + 8); RC_CHECK();
5181	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 0); RC_CHECK();
5182	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
5183
5184	/*
5185	* The virtual hardware type.
5186	*/
5187	NetworkAdapterType_T adapterType;
5188	hrc = networkAdapter->COMGETTER(AdapterType)(&adapterType); H();
5189	switch (adapterType)
5190	{
5191	case NetworkAdapterType_NetworkAdapterAm79C970A:
5192	rc = CFGMR3InsertInteger(pCfg, "Am79C973", 0); RC_CHECK();
5193	break;
5194	case NetworkAdapterType_NetworkAdapterAm79C973:
5195	rc = CFGMR3InsertInteger(pCfg, "Am79C973", 1); RC_CHECK();
5196	break;
5197	default:
5198	AssertMsgFailed(("Invalid network adapter type '%d' for slot '%d'",
5199	adapterType, ulInstance));
5200	return VERR_GENERAL_FAILURE;
5201	}
5202
5203	/*
5204	* Get the MAC address and convert it to binary representation
5205	*/
5206	Bstr macAddr;
5207	hrc = networkAdapter->COMGETTER(MACAddress)(macAddr.asOutParam()); H();
5208	Assert(macAddr);
5209	Utf8Str macAddrUtf8 = macAddr;
5210	char macStr = (char)macAddrUtf8.raw();
5211	Assert(strlen(macStr) == 12);
5212	PDMMAC Mac;
5213	memset(&Mac, 0, sizeof(Mac));
5214	char pMac = (char)&Mac;
5215	for (uint32_t i = 0; i < 6; i++)
5216	{
5217	char c1 = *macStr++ - '0';
5218	if (c1 > 9)
5219	c1 -= 7;
5220	char c2 = *macStr++ - '0';
5221	if (c2 > 9)
5222	c2 -= 7;
5223	*pMac++ = ((c1 & 0x0f) << 4) \| (c2 & 0x0f);
5224	}
5225	rc = CFGMR3InsertBytes(pCfg, "MAC", &Mac, sizeof(Mac)); RC_CHECK();
5226
5227	/*
5228	* Check if the cable is supposed to be unplugged
5229	*/
5230	BOOL fCableConnected;
5231	hrc = networkAdapter->COMGETTER(CableConnected)(&fCableConnected); H();
5232	rc = CFGMR3InsertInteger(pCfg, "CableConnected", fCableConnected ? 1 : 0); RC_CHECK();
5233
5234	/*
5235	* Attach the status driver.
5236	*/
5237	rc = CFGMR3InsertNode(pInst, "LUN#999", &pLunL0); RC_CHECK();
5238	rc = CFGMR3InsertString(pLunL0, "Driver", "MainStatus"); RC_CHECK();
5239	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5240	rc = CFGMR3InsertInteger(pCfg, "papLeds", (uintptr_t)&pConsole->mapNetworkLeds[ulInstance]); RC_CHECK();
5241
5242	/*
5243	* Enable the packet sniffer if requested.
5244	*/
5245	BOOL fSniffer;
5246	hrc = networkAdapter->COMGETTER(TraceEnabled)(&fSniffer); H();
5247	if (fSniffer)
5248	{
5249	/* insert the sniffer filter driver. */
5250	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5251	rc = CFGMR3InsertString(pLunL0, "Driver", "NetSniffer"); RC_CHECK();
5252	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5253	hrc = networkAdapter->COMGETTER(TraceFile)(&str); H();
5254	if (str) /* check convention for indicating default file. */
5255	{
5256	STR_CONV();
5257	rc = CFGMR3InsertString(pCfg, "File", psz); RC_CHECK();
5258	STR_FREE();
5259	}
5260	}
5261
5262	NetworkAttachmentType_T networkAttachment;
5263	hrc = networkAdapter->COMGETTER(AttachmentType)(&networkAttachment); H();
5264	switch (networkAttachment)
5265	{
5266	case NetworkAttachmentType_NoNetworkAttachment:
5267	break;
5268
5269	case NetworkAttachmentType_NATNetworkAttachment:
5270	{
5271	if (fSniffer)
5272	{
5273	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL0); RC_CHECK();
5274	}
5275	else
5276	{
5277	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5278	}
5279	rc = CFGMR3InsertString(pLunL0, "Driver", "NAT"); RC_CHECK();
5280	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5281	/* (Port forwarding goes here.) */
5282	break;
5283	}
5284
5285	case NetworkAttachmentType_HostInterfaceNetworkAttachment:
5286	{
5287	/*
5288	* Perform the attachment if required (don't return on error!)
5289	*/
5290	hrc = pConsole->attachToHostInterface(networkAdapter);
5291	if (SUCCEEDED(hrc))
5292	{
5293	#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
5294	Assert (pConsole->maTapFD[ulInstance] >= 0);
5295	if (pConsole->maTapFD[ulInstance] >= 0)
5296	{
5297	if (fSniffer)
5298	{
5299	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL0); RC_CHECK();
5300	}
5301	else
5302	{
5303	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5304	}
5305	rc = CFGMR3InsertString(pLunL0, "Driver", "HostInterface"); RC_CHECK();
5306	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5307	rc = CFGMR3InsertInteger(pCfg, "FileHandle", pConsole->maTapFD[ulInstance]); RC_CHECK();
5308	}
5309	#elif defined(__WIN__)
5310	if (fSniffer)
5311	{
5312	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL0); RC_CHECK();
5313	}
5314	else
5315	{
5316	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5317	}
5318	Bstr hostInterfaceName;
5319	hrc = networkAdapter->COMGETTER(HostInterface)(hostInterfaceName.asOutParam()); H();
5320	ComPtr<IHostNetworkInterfaceCollection> coll;
5321	hrc = host->COMGETTER(NetworkInterfaces)(coll.asOutParam()); H();
5322	ComPtr<IHostNetworkInterface> hostInterface;
5323	rc = coll->FindByName(hostInterfaceName, hostInterface.asOutParam());
5324	if (!SUCCEEDED(rc))
5325	{
5326	AssertMsgFailed(("Cannot get GUID for host interface '%ls'\n", hostInterfaceName));
5327	hrc = networkAdapter->Detach(); H();
5328	}
5329	else
5330	{
5331	rc = CFGMR3InsertString(pLunL0, "Driver", "HostInterface"); RC_CHECK();
5332	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5333	rc = CFGMR3InsertString(pCfg, "HostInterfaceName", Utf8Str(hostInterfaceName)); RC_CHECK();
5334	Guid hostIFGuid;
5335	hrc = hostInterface->COMGETTER(Id)(hostIFGuid.asOutParam()); H();
5336	char szDriverGUID[256] = {0};
5337	/* add curly brackets */
5338	szDriverGUID[0] = '{';
5339	strcpy(szDriverGUID + 1, hostIFGuid.toString().raw());
5340	strcat(szDriverGUID, "}");
5341	rc = CFGMR3InsertBytes(pCfg, "GUID", szDriverGUID, sizeof(szDriverGUID)); RC_CHECK();
5342	}
5343	#else
5344	# error "Port me"
5345	#endif
5346	}
5347	else
5348	{
5349	switch (hrc)
5350	{
5351	#ifdef __LINUX__
5352	case VERR_ACCESS_DENIED:
5353	return VMSetError(pVM, VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5354	"Failed to open '/dev/net/tun' for read/write access. Please check the "
5355	"permissions of that node. Either do 'chmod 0666 /dev/net/tun' or "
5356	"change the group of that node and get member of that group. Make "
5357	"sure that these changes are permanently in particular if you are "
5358	"using udev"));
5359	#endif /* __LINUX__ */
5360	default:
5361	AssertMsgFailed(("Could not attach to host interface! Bad!\n"));
5362	return VMSetError(pVM, VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5363	"Failed to initialize Host Interface Networking"));
5364	}
5365	}
5366	break;
5367	}
5368
5369	case NetworkAttachmentType_InternalNetworkAttachment:
5370	{
5371	hrc = networkAdapter->COMGETTER(InternalNetwork)(&str); H();
5372	STR_CONV();
5373	if (psz && *psz)
5374	{
5375	if (fSniffer)
5376	{
5377	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL0); RC_CHECK();
5378	}
5379	else
5380	{
5381	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5382	}
5383	rc = CFGMR3InsertString(pLunL0, "Driver", "IntNet"); RC_CHECK();
5384	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5385	rc = CFGMR3InsertString(pCfg, "Network", psz); RC_CHECK();
5386	}
5387	STR_FREE();
5388	break;
5389	}
5390
5391	default:
5392	AssertMsgFailed(("should not get here!\n"));
5393	break;
5394	}
5395	}
5396
5397	/*
5398	* VMM Device
5399	*/
5400	rc = CFGMR3InsertNode(pDevices, "VMMDev", &pDev); RC_CHECK();
5401	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
5402	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
5403	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
5404	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", 4); RC_CHECK();
5405	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 0); RC_CHECK();
5406
5407	/* the VMM device's Main driver */
5408	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5409	rc = CFGMR3InsertString(pLunL0, "Driver", "MainVMMDev"); RC_CHECK();
5410	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5411	VMMDev *pVMMDev = pConsole->mVMMDev;
5412	rc = CFGMR3InsertInteger(pCfg, "Object", (uintptr_t)pVMMDev); RC_CHECK();
5413
5414	/*
5415	* Audio Sniffer Device
5416	*/
5417	rc = CFGMR3InsertNode(pDevices, "AudioSniffer", &pDev); RC_CHECK();
5418	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
5419	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
5420
5421	/* the Audio Sniffer device's Main driver */
5422	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5423	rc = CFGMR3InsertString(pLunL0, "Driver", "MainAudioSniffer"); RC_CHECK();
5424	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5425	AudioSniffer *pAudioSniffer = pConsole->mAudioSniffer;
5426	rc = CFGMR3InsertInteger(pCfg, "Object", (uintptr_t)pAudioSniffer); RC_CHECK();
5427
5428	/*
5429	* AC'97 ICH audio
5430	*/
5431	ComPtr<IAudioAdapter> audioAdapter;
5432	hrc = pMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam()); H();
5433	BOOL enabled = FALSE;
5434	if (audioAdapter)
5435	{
5436	hrc = audioAdapter->COMGETTER(Enabled)(&enabled); H();
5437	}
5438	if (enabled)
5439	{
5440	rc = CFGMR3InsertNode(pDevices, "ichac97", &pDev); /* ichac97 */
5441	rc = CFGMR3InsertNode(pDev, "0", &pInst);
5442	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
5443	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", 5); RC_CHECK();
5444	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 0); RC_CHECK();
5445	rc = CFGMR3InsertNode(pInst, "Config", &pCfg);
5446
5447	/* the Audio driver */
5448	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5449	rc = CFGMR3InsertString(pLunL0, "Driver", "AUDIO"); RC_CHECK();
5450	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5451	AudioDriverType_T audioDriver;
5452	hrc = audioAdapter->COMGETTER(AudioDriver)(&audioDriver); H();
5453	switch (audioDriver)
5454	{
5455	case AudioDriverType_NullAudioDriver:
5456	{
5457	rc = CFGMR3InsertString(pCfg, "AudioDriver", "null"); RC_CHECK();
5458	break;
5459	}
5460	#ifdef __WIN__
5461	#ifdef VBOX_WITH_WINMM
5462	case AudioDriverType_WINMMAudioDriver:
5463	{
5464	rc = CFGMR3InsertString(pCfg, "AudioDriver", "winmm"); RC_CHECK();
5465	break;
5466	}
5467	#endif
5468	case AudioDriverType_DSOUNDAudioDriver:
5469	{
5470	rc = CFGMR3InsertString(pCfg, "AudioDriver", "dsound"); RC_CHECK();
5471	break;
5472	}
5473	#endif /* __WIN__ */
5474	#ifdef __LINUX__
5475	case AudioDriverType_OSSAudioDriver:
5476	{
5477	rc = CFGMR3InsertString(pCfg, "AudioDriver", "oss"); RC_CHECK();
5478	break;
5479	}
5480	# ifdef VBOX_WITH_ALSA
5481	case AudioDriverType_ALSAAudioDriver:
5482	{
5483	rc = CFGMR3InsertString(pCfg, "AudioDriver", "alsa"); RC_CHECK();
5484	break;
5485	}
5486	# endif
5487	#endif /* __LINUX__ */
5488	#ifdef __DARWIN__
5489	case AudioDriverType_CoreAudioDriver:
5490	{
5491	rc = CFGMR3InsertString(pCfg, "AudioDriver", "coreaudio"); RC_CHECK();
5492	break;
5493	}
5494	#endif
5495	}
5496	}
5497
5498	/*
5499	* The USB Controller.
5500	*/
5501	ComPtr<IUSBController> USBCtlPtr;
5502	hrc = pMachine->COMGETTER(USBController)(USBCtlPtr.asOutParam());
5503	if (USBCtlPtr)
5504	{
5505	BOOL fEnabled;
5506	hrc = USBCtlPtr->COMGETTER(Enabled)(&fEnabled); H();
5507	if (fEnabled)
5508	{
5509	rc = CFGMR3InsertNode(pDevices, "usb-ohci", &pDev); RC_CHECK();
5510	rc = CFGMR3InsertNode(pDev, "0", &pInst); RC_CHECK();
5511	rc = CFGMR3InsertNode(pInst, "Config", &pCfg); RC_CHECK();
5512	rc = CFGMR3InsertInteger(pInst, "Trusted", 1); /* boolean */ RC_CHECK();
5513	rc = CFGMR3InsertInteger(pInst, "PCIDeviceNo", 6); RC_CHECK();
5514	rc = CFGMR3InsertInteger(pInst, "PCIFunctionNo", 0); RC_CHECK();
5515
5516	rc = CFGMR3InsertNode(pInst, "LUN#0", &pLunL0); RC_CHECK();
5517	rc = CFGMR3InsertString(pLunL0, "Driver", "VUSBRootHub"); RC_CHECK();
5518	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
5519	}
5520	}
5521
5522	/*
5523	* Clipboard
5524	*/
5525	{
5526	ClipboardMode_T mode = ClipboardMode_ClipDisabled;
5527	hrc = pMachine->COMGETTER(ClipboardMode) (&mode); H();
5528
5529	if (mode != ClipboardMode_ClipDisabled)
5530	{
5531	/* Load the service */
5532	rc = pConsole->mVMMDev->hgcmLoadService ("VBoxSharedClipboard", "VBoxSharedClipboard");
5533
5534	if (VBOX_FAILURE (rc))
5535	{
5536	LogRel(("VBoxSharedClipboard is not available. rc = %Vrc\n", rc));
5537	/* That is not a fatal failure. */
5538	rc = VINF_SUCCESS;
5539	}
5540	else
5541	{
5542	/* Setup the service. */
5543	VBOXHGCMSVCPARM parm;
5544
5545	parm.type = VBOX_HGCM_SVC_PARM_32BIT;
5546
5547	switch (mode)
5548	{
5549	default:
5550	case ClipboardMode_ClipDisabled:
5551	{
5552	LogRel(("VBoxSharedClipboard mode: Off\n"));
5553	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_OFF;
5554	break;
5555	}
5556	case ClipboardMode_ClipGuestToHost:
5557	{
5558	LogRel(("VBoxSharedClipboard mode: Guest to Host\n"));
5559	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_GUEST_TO_HOST;
5560	break;
5561	}
5562	case ClipboardMode_ClipHostToGuest:
5563	{
5564	LogRel(("VBoxSharedClipboard mode: Host to Guest\n"));
5565	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_HOST_TO_GUEST;
5566	break;
5567	}
5568	case ClipboardMode_ClipBidirectional:
5569	{
5570	LogRel(("VBoxSharedClipboard mode: Bidirectional\n"));
5571	parm.u.uint32 = VBOX_SHARED_CLIPBOARD_MODE_BIDIRECTIONAL;
5572	break;
5573	}
5574	}
5575
5576	pConsole->mVMMDev->hgcmHostCall ("VBoxSharedClipboard", VBOX_SHARED_CLIPBOARD_HOST_FN_SET_MODE, 1, &parm);
5577
5578	Log(("Set VBoxSharedClipboard mode\n"));
5579	}
5580	}
5581	}
5582
5583	/*
5584	* CFGM overlay handling.
5585	*
5586	* Here we check the extra data entries for CFGM values
5587	* and create the nodes and insert the values on the fly. Existing
5588	* values will be removed and reinserted. If a value is a valid number,
5589	* it will be inserted as a number, otherwise as a string.
5590	*
5591	* We first perform a run on global extra data, then on the machine
5592	* extra data to support global settings with local overrides.
5593	*
5594	*/
5595	Bstr strExtraDataKey;
5596	bool fGlobalExtraData = true;
5597	for (;;)
5598	{
5599	Bstr strNextExtraDataKey;
5600	Bstr strExtraDataValue;
5601
5602	/* get the next key */
5603	if (fGlobalExtraData)
5604	hrc = virtualBox->GetNextExtraDataKey(strExtraDataKey, strNextExtraDataKey.asOutParam(),
5605	strExtraDataValue.asOutParam());
5606	else
5607	hrc = pMachine->GetNextExtraDataKey(strExtraDataKey, strNextExtraDataKey.asOutParam(),
5608	strExtraDataValue.asOutParam());
5609
5610	/* stop if for some reason there's nothing more to request */
5611	if (FAILED(hrc) \|\| !strNextExtraDataKey)
5612	{
5613	/* if we're out of global keys, continue with machine, otherwise we're done */
5614	if (fGlobalExtraData)
5615	{
5616	fGlobalExtraData = false;
5617	strExtraDataKey.setNull();
5618	continue;
5619	}
5620	break;
5621	}
5622
5623	strExtraDataKey = strNextExtraDataKey;
5624	Utf8Str strExtraDataKeyUtf8 = Utf8Str(strExtraDataKey);
5625
5626	/* we only care about keys starting with "VBoxInternal/" */
5627	if (strncmp(strExtraDataKeyUtf8.raw(), "VBoxInternal/", 13) != 0)
5628	continue;
5629	char pszExtraDataKey = (char)strExtraDataKeyUtf8.raw() + 13;
5630
5631	/* the key will be in the format "Node1/Node2/Value" or simply "Value". */
5632	PCFGMNODE pNode;
5633	char *pszCFGMValueName = strrchr(pszExtraDataKey, '/');
5634	if (pszCFGMValueName)
5635	{
5636	/* terminate the node and advance to the value */
5637	*pszCFGMValueName = '\0';
5638	pszCFGMValueName++;
5639
5640	/* does the node already exist? */
5641	pNode = CFGMR3GetChild(pRoot, pszExtraDataKey);
5642	if (pNode)
5643	{
5644	/* the value might already exist, remove it to be safe */
5645	CFGMR3RemoveValue(pNode, pszCFGMValueName);
5646	}
5647	else
5648	{
5649	/* create the node */
5650	rc = CFGMR3InsertNode(pRoot, pszExtraDataKey, &pNode);
5651	AssertMsgRC(rc, ("failed to insert node '%s'\n", pszExtraDataKey));
5652	if (VBOX_FAILURE(rc) \|\| !pNode)
5653	continue;
5654	}
5655	}
5656	else
5657	{
5658	pNode = pRoot;
5659	pszCFGMValueName = pszExtraDataKey;
5660	pszExtraDataKey--;
5661
5662	/* the value might already exist, remove it to be safe */
5663	CFGMR3RemoveValue(pNode, pszCFGMValueName);
5664	}
5665
5666	/* now let's have a look at the value */
5667	Utf8Str strCFGMValueUtf8 = Utf8Str(strExtraDataValue);
5668	const char *pszCFGMValue = strCFGMValueUtf8.raw();
5669	/* empty value means remove value which we've already done */
5670	if (pszCFGMValue && *pszCFGMValue)
5671	{
5672	/* if it's a valid number, we'll insert it as such, otherwise string */
5673	uint64_t u64Value;
5674	if (RTStrToUInt64Ex(pszCFGMValue, NULL, 0, &u64Value) == VINF_SUCCESS)
5675	{
5676	rc = CFGMR3InsertInteger(pNode, pszCFGMValueName, u64Value);
5677	}
5678	else
5679	{
5680	rc = CFGMR3InsertString(pNode, pszCFGMValueName, pszCFGMValue);
5681	}
5682	AssertMsgRC(rc, ("failed to insert CFGM value '%s' to key '%s'\n", pszCFGMValue, pszExtraDataKey));
5683	}
5684	}
5685
5686	#undef H
5687	#undef RC_CHECK
5688	#undef STR_FREE
5689	#undef STR_CONV
5690
5691	/* Register VM state change handler */
5692	int rc2 = VMR3AtStateRegister (pVM, Console::vmstateChangeCallback, pConsole);
5693	AssertRC (rc2);
5694	if (VBOX_SUCCESS (rc))
5695	rc = rc2;
5696
5697	/* Register VM runtime error handler */
5698	rc2 = VMR3AtRuntimeErrorRegister (pVM, Console::setVMRuntimeErrorCallback, pConsole);
5699	AssertRC (rc2);
5700	if (VBOX_SUCCESS (rc))
5701	rc = rc2;
5702
5703	/* Save the VM pointer in the machine object */
5704	pConsole->mpVM = pVM;
5705
5706	LogFlowFunc (("vrc = %Vrc\n", rc));
5707	LogFlowFuncLeave();
5708
5709	return rc;
5710	}
5711
5712	/**
5713	* Call the initialisation script for a dynamic TAP interface.
5714	*
5715	* The initialisation script should create a TAP interface, set it up and write its name to
5716	* standard output followed by a carriage return. Anything further written to standard
5717	* output will be ignored. If it returns a non-zero exit code, or does not write an
5718	* intelligable interface name to standard output, it will be treated as having failed.
5719	* For now, this method only works on Linux.
5720	*
5721	* @returns COM status code
5722	* @param tapDevice string to store the name of the tap device created to
5723	* @param tapSetupApplication the name of the setup script
5724	*/
5725	HRESULT Console::callTapSetupApplication(bool isStatic, RTFILE tapFD, Bstr &tapDevice,
5726	Bstr &tapSetupApplication)
5727	{
5728	LogFlowThisFunc(("\n"));
5729	#ifdef __LINUX__
5730	/* Command line to start the script with. */
5731	char szCommand[4096];
5732	/* Result code */
5733	int rc;
5734
5735	/* Get the script name. */
5736	Utf8Str tapSetupAppUtf8(tapSetupApplication), tapDeviceUtf8(tapDevice);
5737	RTStrPrintf(szCommand, sizeof(szCommand), "%s %d %s", tapSetupAppUtf8.raw(),
5738	isStatic ? tapFD : 0, isStatic ? tapDeviceUtf8.raw() : "");
5739	/*
5740	* Create the process and read its output.
5741	*/
5742	Log2(("About to start the TAP setup script with the following command line: %s\n",
5743	szCommand));
5744	FILE *pfScriptHandle = popen(szCommand, "r");
5745	if (pfScriptHandle == 0)
5746	{
5747	int iErr = errno;
5748	LogRel(("Failed to start the TAP interface setup script %s, error text: %s\n",
5749	szCommand, strerror(iErr)));
5750	LogFlowThisFunc(("rc=E_FAIL\n"));
5751	return setError(E_FAIL, tr ("Failed to run the host networking set up command %s: %s"),
5752	szCommand, strerror(iErr));
5753	}
5754	/* If we are using a dynamic TAP interface, we need to get the interface name. */
5755	if (!isStatic)
5756	{
5757	/* Buffer to read the application output to. It doesn't have to be long, as we are only
5758	interested in the first few (normally 5 or 6) bytes. */
5759	char acBuffer[64];
5760	/* The length of the string returned by the application. We only accept strings of 63
5761	characters or less. */
5762	size_t cBufSize;
5763
5764	/* Read the name of the device from the application. */
5765	fgets(acBuffer, sizeof(acBuffer), pfScriptHandle);
5766	cBufSize = strlen(acBuffer);
5767	/* The script must return the name of the interface followed by a carriage return as the
5768	first line of its output. We need a null-terminated string. */
5769	if ((cBufSize < 2) \|\| (acBuffer[cBufSize - 1] != '\n'))
5770	{
5771	pclose(pfScriptHandle);
5772	LogRel(("The TAP interface setup script did not return the name of a TAP device.\n"));
5773	LogFlowThisFunc(("rc=E_FAIL\n"));
5774	return setError(E_FAIL, tr ("The host networking set up command did not supply an interface name"));
5775	}
5776	/* Overwrite the terminating newline character. */
5777	acBuffer[cBufSize - 1] = 0;
5778	tapDevice = acBuffer;
5779	}
5780	rc = pclose(pfScriptHandle);
5781	if (!WIFEXITED(rc))
5782	{
5783	LogRel(("The TAP interface setup script terminated abnormally.\n"));
5784	LogFlowThisFunc(("rc=E_FAIL\n"));
5785	return setError(E_FAIL, tr ("The host networking set up command did not run correctly"));
5786	}
5787	if (WEXITSTATUS(rc) != 0)
5788	{
5789	LogRel(("The TAP interface setup script returned a non-zero exit code.\n"));
5790	LogFlowThisFunc(("rc=E_FAIL\n"));
5791	return setError(E_FAIL, tr ("The host networking set up command returned a non-zero exit code"));
5792	}
5793	LogFlowThisFunc(("rc=S_OK\n"));
5794	return S_OK;
5795	#else /* __LINUX__ not defined */
5796	LogFlowThisFunc(("rc=E_NOTIMPL\n"));
5797	return E_NOTIMPL; /* not yet supported */
5798	#endif
5799	}
5800
5801	/**
5802	* Helper function to handle host interface device creation and attachment.
5803	*
5804	* @param networkAdapter the network adapter which attachment should be reset
5805	* @return COM status code
5806	*
5807	* @note The caller must lock this object for writing.
5808	*/
5809	HRESULT Console::attachToHostInterface(INetworkAdapter *networkAdapter)
5810	{
5811	LogFlowThisFunc(("\n"));
5812	/* sanity check */
5813	AssertReturn (isLockedOnCurrentThread(), E_FAIL);
5814
5815	#ifdef DEBUG
5816	/* paranoia */
5817	NetworkAttachmentType_T attachment;
5818	networkAdapter->COMGETTER(AttachmentType)(&attachment);
5819	Assert(attachment == NetworkAttachmentType_HostInterfaceNetworkAttachment);
5820	#endif /* DEBUG */
5821
5822	HRESULT rc = S_OK;
5823
5824	#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
5825	ULONG slot = 0;
5826	rc = networkAdapter->COMGETTER(Slot)(&slot);
5827	AssertComRC(rc);
5828
5829	/*
5830	* Try get the FD.
5831	*/
5832	LONG ltapFD;
5833	rc = networkAdapter->COMGETTER(TAPFileDescriptor)(&ltapFD);
5834	if (SUCCEEDED(rc))
5835	maTapFD[slot] = (RTFILE)ltapFD;
5836	else
5837	maTapFD[slot] = NIL_RTFILE;
5838
5839	/*
5840	* Are we supposed to use an existing TAP interface?
5841	*/
5842	if (maTapFD[slot] != NIL_RTFILE)
5843	{
5844	/* nothing to do */
5845	Assert(ltapFD >= 0);
5846	Assert((LONG)maTapFD[slot] == ltapFD);
5847	rc = S_OK;
5848	}
5849	else
5850	#endif /* VBOX_WITH_UNIXY_TAP_NETWORKING */
5851	{
5852	/*
5853	* Allocate a host interface device
5854	*/
5855	#ifdef __WIN__
5856	/* nothing to do */
5857	int rcVBox = VINF_SUCCESS;
5858	#elif defined(__LINUX__)
5859	int rcVBox = RTFileOpen(&maTapFD[slot], "/dev/net/tun",
5860	RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE \| RTFILE_O_INHERIT);
5861	if (VBOX_SUCCESS(rcVBox))
5862	{
5863	/*
5864	* Set/obtain the tap interface.
5865	*/
5866	bool isStatic = false;
5867	struct ifreq IfReq;
5868	memset(&IfReq, 0, sizeof(IfReq));
5869	/* The name of the TAP interface we are using and the TAP setup script resp. */
5870	Bstr tapDeviceName, tapSetupApplication;
5871	rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
5872	if (FAILED(rc))
5873	{
5874	tapDeviceName.setNull(); /* Is this necessary? */
5875	}
5876	else if (!tapDeviceName.isEmpty())
5877	{
5878	isStatic = true;
5879	/* If we are using a static TAP device then try to open it. */
5880	Utf8Str str(tapDeviceName);
5881	if (str.length() <= sizeof(IfReq.ifr_name))
5882	strcpy(IfReq.ifr_name, str.raw());
5883	else
5884	memcpy(IfReq.ifr_name, str.raw(), sizeof(IfReq.ifr_name) - 1); /** @todo bitch about names which are too long... */
5885	IfReq.ifr_flags = IFF_TAP \| IFF_NO_PI;
5886	rcVBox = ioctl(maTapFD[slot], TUNSETIFF, &IfReq);
5887	if (rcVBox != 0)
5888	{
5889	LogRel(("Failed to open the host network interface %ls\n", tapDeviceName.raw()));
5890	rc = setError(E_FAIL, tr ("Failed to open the host network interface %ls"),
5891	tapDeviceName.raw());
5892	}
5893	}
5894	if (SUCCEEDED(rc))
5895	{
5896	networkAdapter->COMGETTER(TAPSetupApplication)(tapSetupApplication.asOutParam());
5897	if (tapSetupApplication.isEmpty())
5898	{
5899	if (tapDeviceName.isEmpty())
5900	{
5901	LogRel(("No setup application was supplied for the TAP interface.\n"));
5902	rc = setError(E_FAIL, tr ("No setup application was supplied for the host networking interface"));
5903	}
5904	}
5905	else
5906	{
5907	rc = callTapSetupApplication(isStatic, maTapFD[slot], tapDeviceName,
5908	tapSetupApplication);
5909	}
5910	}
5911	if (SUCCEEDED(rc))
5912	{
5913	if (!isStatic)
5914	{
5915	Utf8Str str(tapDeviceName);
5916	if (str.length() <= sizeof(IfReq.ifr_name))
5917	strcpy(IfReq.ifr_name, str.raw());
5918	else
5919	memcpy(IfReq.ifr_name, str.raw(), sizeof(IfReq.ifr_name) - 1); /** @todo bitch about names which are too long... */
5920	IfReq.ifr_flags = IFF_TAP \| IFF_NO_PI;
5921	rcVBox = ioctl(maTapFD[slot], TUNSETIFF, &IfReq);
5922	if (rcVBox != 0)
5923	{
5924	LogRel(("Failed to open the host network interface %ls returned by the setup script", tapDeviceName.raw()));
5925	rc = setError(E_FAIL, tr ("Failed to open the host network interface %ls returned by the setup script"), tapDeviceName.raw());
5926	}
5927	}
5928	if (SUCCEEDED(rc))
5929	{
5930	/*
5931	* Make it pollable.
5932	*/
5933	if (fcntl(maTapFD[slot], F_SETFL, O_NONBLOCK) != -1)
5934	{
5935	Log(("attachToHostInterface: %RTfile %ls\n", maTapFD[slot], tapDeviceName.raw()));
5936
5937	/*
5938	* Here is the right place to communicate the TAP file descriptor and
5939	* the host interface name to the server if/when it becomes really
5940	* necessary.
5941	*/
5942	maTAPDeviceName[slot] = tapDeviceName;
5943	rcVBox = VINF_SUCCESS;
5944	}
5945	else
5946	{
5947	int iErr = errno;
5948
5949	LogRel(("Configuration error: Failed to configure /dev/net/tun non blocking. Error: %s\n", strerror(iErr)));
5950	rcVBox = VERR_HOSTIF_BLOCKING;
5951	rc = setError(E_FAIL, tr ("could not set up the host networking device for non blocking access: %s"),
5952	strerror(errno));
5953	}
5954	}
5955	}
5956	}
5957	else
5958	{
5959	LogRel(("Configuration error: Failed to open /dev/net/tun rc=%Vrc\n", rcVBox));
5960	switch (rcVBox)
5961	{
5962	case VERR_ACCESS_DENIED:
5963	/* will be handled by our caller */
5964	rc = rcVBox;
5965	break;
5966	default:
5967	rc = setError(E_FAIL, tr ("Could not set up the host networking device: %Vrc"), rcVBox);
5968	break;
5969	}
5970	}
5971	#elif defined(__DARWIN__)
5972	/** @todo Implement tap networking for Darwin. */
5973	int rcVBox = VERR_NOT_IMPLEMENTED;
5974	#elif defined(VBOX_WITH_UNIXY_TAP_NETWORKING)
5975	# error "PORTME: Implement OS specific TAP interface open/creation."
5976	#else
5977	# error "Unknown host OS"
5978	#endif
5979	/* in case of failure, cleanup. */
5980	if (VBOX_FAILURE(rcVBox) && SUCCEEDED(rc))
5981	{
5982	LogRel(("General failure attaching to host interface\n"));
5983	rc = setError(E_FAIL, tr ("General failure attaching to host interface"));
5984	}
5985	}
5986	LogFlowThisFunc(("rc=%d\n", rc));
5987	return rc;
5988	}
5989
5990	/**
5991	* Helper function to handle detachment from a host interface
5992	*
5993	* @param networkAdapter the network adapter which attachment should be reset
5994	* @return COM status code
5995	*
5996	* @note The caller must lock this object for writing.
5997	*/
5998	HRESULT Console::detachFromHostInterface(INetworkAdapter *networkAdapter)
5999	{
6000	/* sanity check */
6001	LogFlowThisFunc(("\n"));
6002	AssertReturn (isLockedOnCurrentThread(), E_FAIL);
6003
6004	HRESULT rc = S_OK;
6005	#ifdef DEBUG
6006	/* paranoia */
6007	NetworkAttachmentType_T attachment;
6008	networkAdapter->COMGETTER(AttachmentType)(&attachment);
6009	Assert(attachment == NetworkAttachmentType_HostInterfaceNetworkAttachment);
6010	#endif /* DEBUG */
6011
6012	#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
6013
6014	ULONG slot = 0;
6015	rc = networkAdapter->COMGETTER(Slot)(&slot);
6016	AssertComRC(rc);
6017
6018	/* is there an open TAP device? */
6019	if (maTapFD[slot] != NIL_RTFILE)
6020	{
6021	/*
6022	* Close the file handle.
6023	*/
6024	Bstr tapDeviceName, tapTerminateApplication;
6025	bool isStatic = true;
6026	rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
6027	if (FAILED(rc) \|\| tapDeviceName.isEmpty())
6028	{
6029	/* If the name is not empty, this is a dynamic TAP device, so close it now,
6030	so that the termination script can remove the interface. Otherwise we still
6031	need the FD to pass to the termination script. */
6032	isStatic = false;
6033	int rcVBox = RTFileClose(maTapFD[slot]);
6034	AssertRC(rcVBox);
6035	maTapFD[slot] = NIL_RTFILE;
6036	}
6037	/*
6038	* Execute the termination command.
6039	*/
6040	networkAdapter->COMGETTER(TAPTerminateApplication)(tapTerminateApplication.asOutParam());
6041	if (tapTerminateApplication)
6042	{
6043	/* Get the program name. */
6044	Utf8Str tapTermAppUtf8(tapTerminateApplication);
6045
6046	/* Build the command line. */
6047	char szCommand[4096];
6048	RTStrPrintf(szCommand, sizeof(szCommand), "%s %d %s", tapTermAppUtf8.raw(),
6049	isStatic ? maTapFD[slot] : 0, maTAPDeviceName[slot].raw());
6050
6051	/*
6052	* Create the process and wait for it to complete.
6053	*/
6054	Log(("Calling the termination command: %s\n", szCommand));
6055	int rcCommand = system(szCommand);
6056	if (rcCommand == -1)
6057	{
6058	LogRel(("Failed to execute the clean up script for the TAP interface"));
6059	rc = setError(E_FAIL, tr ("Failed to execute the clean up script for the TAP interface"));
6060	}
6061	if (!WIFEXITED(rc))
6062	{
6063	LogRel(("The TAP interface clean up script terminated abnormally.\n"));
6064	rc = setError(E_FAIL, tr ("The TAP interface clean up script terminated abnormally"));
6065	}
6066	if (WEXITSTATUS(rc) != 0)
6067	{
6068	LogRel(("The TAP interface clean up script returned a non-zero exit code.\n"));
6069	rc = setError(E_FAIL, tr ("The TAP interface clean up script returned a non-zero exit code"));
6070	}
6071	}
6072
6073	if (isStatic)
6074	{
6075	/* If we are using a static TAP device, we close it now, after having called the
6076	termination script. */
6077	int rcVBox = RTFileClose(maTapFD[slot]);
6078	AssertRC(rcVBox);
6079	}
6080	/* the TAP device name and handle are no longer valid */
6081	maTapFD[slot] = NIL_RTFILE;
6082	maTAPDeviceName[slot] = "";
6083	}
6084	#endif
6085	LogFlowThisFunc(("returning %d\n", rc));
6086	return rc;
6087	}
6088
6089
6090	/**
6091	* Called at power down to terminate host interface networking.
6092	*
6093	* @note The caller must lock this object for writing.
6094	*/
6095	HRESULT Console::powerDownHostInterfaces()
6096	{
6097	LogFlowThisFunc (("\n"));
6098
6099	/* sanity check */
6100	AssertReturn (isLockedOnCurrentThread(), E_FAIL);
6101
6102	/*
6103	* host interface termination handling
6104	*/
6105	HRESULT rc;
6106	for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
6107	{
6108	ComPtr<INetworkAdapter> networkAdapter;
6109	rc = mMachine->GetNetworkAdapter(slot, networkAdapter.asOutParam());
6110	CheckComRCBreakRC (rc);
6111
6112	BOOL enabled = FALSE;
6113	networkAdapter->COMGETTER(Enabled) (&enabled);
6114	if (!enabled)
6115	continue;
6116
6117	NetworkAttachmentType_T attachment;
6118	networkAdapter->COMGETTER(AttachmentType)(&attachment);
6119	if (attachment == NetworkAttachmentType_HostInterfaceNetworkAttachment)
6120	{
6121	HRESULT rc2 = detachFromHostInterface(networkAdapter);
6122	if (FAILED(rc2) && SUCCEEDED(rc))
6123	rc = rc2;
6124	}
6125	}
6126
6127	return rc;
6128	}
6129
6130
6131	/**
6132	* Process callback handler for VMR3Load and VMR3Save.
6133	*
6134	* @param pVM The VM handle.
6135	* @param uPercent Completetion precentage (0-100).
6136	* @param pvUser Pointer to the VMProgressTask structure.
6137	* @return VINF_SUCCESS.
6138	*/
6139	/static/ DECLCALLBACK (int)
6140	Console::stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser)
6141	{
6142	VMProgressTask task = static_cast <VMProgressTask > (pvUser);
6143	AssertReturn (task, VERR_INVALID_PARAMETER);
6144
6145	/* update the progress object */
6146	if (task->mProgress)
6147	task->mProgress->notifyProgress (uPercent);
6148
6149	return VINF_SUCCESS;
6150	}
6151
6152	/**
6153	* VM error callback function. Called by the various VM components.
6154	*
6155	* @param pVM The VM handle. Can be NULL if an error occurred before
6156	* successfully creating a VM.
6157	* @param pvUser Pointer to the VMProgressTask structure.
6158	* @param rc VBox status code.
6159	* @param pszFormat The error message.
6160	* @thread EMT.
6161	*/
6162	/* static */ DECLCALLBACK (void)
6163	Console::setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
6164	const char *pszFormat, va_list args)
6165	{
6166	VMProgressTask task = static_cast <VMProgressTask > (pvUser);
6167	AssertReturnVoid (task);
6168
6169	/* we ignore RT_SRC_POS_DECL arguments to avoid confusion of end-users */
6170	HRESULT hrc = setError (E_FAIL, tr ("%N.\n"
6171	"VBox status code: %d (%Vrc)"),
6172	tr (pszFormat), &args,
6173	rc, rc);
6174	task->mProgress->notifyComplete (hrc);
6175	}
6176
6177	/**
6178	* VM runtime error callback function.
6179	* See VMSetRuntimeError for the detailed description of parameters.
6180	*
6181	* @param pVM The VM handle.
6182	* @param pvUser The user argument.
6183	* @param fFatal Whether it is a fatal error or not.
6184	* @param pszErrorID Error ID string.
6185	* @param pszFormat Error message format string.
6186	* @param args Error message arguments.
6187	* @thread EMT.
6188	*/
6189	/* static */ DECLCALLBACK(void)
6190	Console::setVMRuntimeErrorCallback (PVM pVM, void *pvUser, bool fFatal,
6191	const char *pszErrorID,
6192	const char *pszFormat, va_list args)
6193	{
6194	LogFlowFuncEnter();
6195
6196	Console that = static_cast <Console > (pvUser);
6197	AssertReturnVoid (that);
6198
6199	Utf8Str message = Utf8StrFmt (pszFormat, args);
6200
6201	LogRel (("Console: VM runtime error: fatal=%RTbool, "
6202	"errorID=%s message=\"%s\"\n",
6203	fFatal, pszErrorID, message.raw()));
6204
6205	that->onRuntimeError (BOOL (fFatal), Bstr (pszErrorID), Bstr (message));
6206
6207	LogFlowFuncLeave();
6208	}
6209
6210	/**
6211	* Captures USB devices that match filters of the VM.
6212	* Called at VM startup.
6213	*
6214	* @param pVM The VM handle.
6215	*
6216	* @note The caller must lock this object for writing.
6217	*/
6218	HRESULT Console::captureUSBDevices (PVM pVM)
6219	{
6220	LogFlowThisFunc (("\n"));
6221
6222	/* sanity check */
6223	ComAssertRet (isLockedOnCurrentThread(), E_FAIL);
6224
6225	/* If the machine has an USB controller, ask the USB proxy service to
6226	* capture devices */
6227	PPDMIBASE pBase;
6228	int vrc = PDMR3QueryLun (pVM, "usb-ohci", 0, 0, &pBase);
6229	if (VBOX_SUCCESS (vrc))
6230	{
6231	HRESULT hrc = mControl->AutoCaptureUSBDevices();
6232	ComAssertComRCRetRC (hrc);
6233	}
6234	else if ( vrc == VERR_PDM_DEVICE_NOT_FOUND
6235	\|\| vrc == VERR_PDM_DEVICE_INSTANCE_NOT_FOUND)
6236	vrc = VINF_SUCCESS;
6237	else
6238	AssertRC (vrc);
6239
6240	return VBOX_SUCCESS (vrc) ? S_OK : E_FAIL;
6241	}
6242
6243
6244	/**
6245	* Releases all USB device which is attached to the VM for the
6246	* purpose of clean up and such like.
6247	*
6248	* @note The caller must lock this object for writing.
6249	*/
6250	void Console::releaseAllUSBDevices (void)
6251	{
6252	LogFlowThisFunc (("\n"));
6253
6254	/* sanity check */
6255	AssertReturnVoid (isLockedOnCurrentThread());
6256
6257	mControl->ReleaseAllUSBDevices();
6258	mUSBDevices.clear();
6259	}
6260
6261	/**
6262	* @note Locks this object for writing.
6263	*/
6264	#ifdef VRDP_MC
6265	void Console::processRemoteUSBDevices (uint32_t u32ClientId, VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList)
6266	#else
6267	void Console::processRemoteUSBDevices (VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList)
6268	#endif /* VRDP_MC */
6269	{
6270	LogFlowThisFuncEnter();
6271	#ifdef VRDP_MC
6272	LogFlowThisFunc (("u32ClientId = %d, pDevList=%p, cbDevList = %d\n", u32ClientId, pDevList, cbDevList));
6273	#else
6274	LogFlowThisFunc (("pDevList=%p, cbDevList = %d\n", pDevList, cbDevList));
6275	#endif /* VRDP_MC */
6276
6277	AutoCaller autoCaller (this);
6278	if (!autoCaller.isOk())
6279	{
6280	/* Console has been already uninitialized, deny request */
6281	AssertMsgFailed (("Temporary assertion to prove that it happens, "
6282	"please report to dmik\n"));
6283	LogFlowThisFunc (("Console is already uninitialized\n"));
6284	LogFlowThisFuncLeave();
6285	return;
6286	}
6287
6288	AutoLock alock (this);
6289
6290	/*
6291	* Mark all existing remote USB devices as dirty.
6292	*/
6293	RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6294	while (it != mRemoteUSBDevices.end())
6295	{
6296	(*it)->dirty (true);
6297	++ it;
6298	}
6299
6300	/*
6301	* Process the pDevList and add devices those are not already in the mRemoteUSBDevices list.
6302	*/
6303	/** @todo (sunlover) REMOTE_USB Strict validation of the pDevList. */
6304	VRDPUSBDEVICEDESC *e = pDevList;
6305
6306	/* The cbDevList condition must be checked first, because the function can
6307	* receive pDevList = NULL and cbDevList = 0 on client disconnect.
6308	*/
6309	while (cbDevList >= 2 && e->oNext)
6310	{
6311	LogFlowThisFunc (("vendor %04X, product %04X, name = %s\n",
6312	e->idVendor, e->idProduct,
6313	e->oProduct? (char *)e + e->oProduct: ""));
6314
6315	bool fNewDevice = true;
6316
6317	it = mRemoteUSBDevices.begin();
6318	while (it != mRemoteUSBDevices.end())
6319	{
6320	#ifdef VRDP_MC
6321	if ((*it)->devId () == e->id
6322	&& (*it)->clientId () == u32ClientId)
6323	#else
6324	if ((*it)->devId () == e->id)
6325	#endif /* VRDP_MC */
6326	{
6327	/* The device is already in the list. */
6328	(*it)->dirty (false);
6329	fNewDevice = false;
6330	break;
6331	}
6332
6333	++ it;
6334	}
6335
6336	if (fNewDevice)
6337	{
6338	LogRel(("Remote USB: ++++ Vendor %04X. Product %04X. Name = [%s].\n",
6339	e->idVendor, e->idProduct, e->oProduct? (char *)e + e->oProduct: ""
6340	));
6341
6342	/* Create the device object and add the new device to list. */
6343	ComObjPtr <RemoteUSBDevice> device;
6344	device.createObject();
6345	#ifdef VRDP_MC
6346	device->init (u32ClientId, e);
6347	#else
6348	device->init (e);
6349	#endif /* VRDP_MC */
6350
6351	mRemoteUSBDevices.push_back (device);
6352
6353	/* Check if the device is ok for current USB filters. */
6354	BOOL fMatched = FALSE;
6355
6356	HRESULT hrc = mControl->RunUSBDeviceFilters(device, &fMatched);
6357
6358	AssertComRC (hrc);
6359
6360	LogFlowThisFunc (("USB filters return %d\n", fMatched));
6361
6362	if (fMatched)
6363	{
6364	hrc = onUSBDeviceAttach (device, NULL);
6365
6366	/// @todo (r=dmik) warning reporting subsystem
6367
6368	if (hrc == S_OK)
6369	{
6370	LogFlowThisFunc (("Device attached\n"));
6371	device->captured (true);
6372	}
6373	}
6374	}
6375
6376	if (cbDevList < e->oNext)
6377	{
6378	LogWarningThisFunc (("cbDevList %d > oNext %d\n",
6379	cbDevList, e->oNext));
6380	break;
6381	}
6382
6383	cbDevList -= e->oNext;
6384
6385	e = (VRDPUSBDEVICEDESC )((uint8_t )e + e->oNext);
6386	}
6387
6388	/*
6389	* Remove dirty devices, that is those which are not reported by the server anymore.
6390	*/
6391	for (;;)
6392	{
6393	ComObjPtr <RemoteUSBDevice> device;
6394
6395	RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6396	while (it != mRemoteUSBDevices.end())
6397	{
6398	if ((*it)->dirty ())
6399	{
6400	device = *it;
6401	break;
6402	}
6403
6404	++ it;
6405	}
6406
6407	if (!device)
6408	{
6409	break;
6410	}
6411
6412	USHORT vendorId = 0;
6413	device->COMGETTER(VendorId) (&vendorId);
6414
6415	USHORT productId = 0;
6416	device->COMGETTER(ProductId) (&productId);
6417
6418	Bstr product;
6419	device->COMGETTER(Product) (product.asOutParam());
6420
6421	LogRel(("Remote USB: ---- Vendor %04X. Product %04X. Name = [%ls].\n",
6422	vendorId, productId, product.raw ()
6423	));
6424
6425	/* Detach the device from VM. */
6426	if (device->captured ())
6427	{
6428	Guid uuid;
6429	device->COMGETTER (Id) (uuid.asOutParam());
6430	onUSBDeviceDetach (uuid, NULL);
6431	}
6432
6433	/* And remove it from the list. */
6434	mRemoteUSBDevices.erase (it);
6435	}
6436
6437	LogFlowThisFuncLeave();
6438	}
6439
6440
6441
6442	/**
6443	* Thread function which starts the VM (also from saved state) and
6444	* track progress.
6445	*
6446	* @param Thread The thread id.
6447	* @param pvUser Pointer to a VMPowerUpTask structure.
6448	* @return VINF_SUCCESS (ignored).
6449	*
6450	* @note Locks the Console object for writing.
6451	*/
6452	/static/
6453	DECLCALLBACK (int) Console::powerUpThread (RTTHREAD Thread, void *pvUser)
6454	{
6455	LogFlowFuncEnter();
6456
6457	std::auto_ptr <VMPowerUpTask> task (static_cast <VMPowerUpTask *> (pvUser));
6458	AssertReturn (task.get(), VERR_INVALID_PARAMETER);
6459
6460	AssertReturn (!task->mConsole.isNull(), VERR_INVALID_PARAMETER);
6461	AssertReturn (!task->mProgress.isNull(), VERR_INVALID_PARAMETER);
6462
6463	#if defined(__WIN__)
6464	{
6465	/* initialize COM */
6466	HRESULT hrc = CoInitializeEx (NULL,
6467	COINIT_MULTITHREADED \| COINIT_DISABLE_OLE1DDE \|
6468	COINIT_SPEED_OVER_MEMORY);
6469	LogFlowFunc (("CoInitializeEx()=%08X\n", hrc));
6470	}
6471	#endif
6472
6473	HRESULT hrc = S_OK;
6474	int vrc = VINF_SUCCESS;
6475
6476	ComObjPtr <Console> console = task->mConsole;
6477
6478	/* Note: no need to use addCaller() because VMPowerUpTask does that */
6479
6480	AutoLock alock (console);
6481
6482	/* sanity */
6483	Assert (console->mpVM == NULL);
6484
6485	do
6486	{
6487	/*
6488	* Initialize the release logging facility. In case something
6489	* goes wrong, there will be no release logging. Maybe in the future
6490	* we can add some logic to use different file names in this case.
6491	* Note that the logic must be in sync with Machine::DeleteSettings().
6492	*/
6493
6494	Bstr logFolder;
6495	hrc = console->mMachine->COMGETTER(LogFolder) (logFolder.asOutParam());
6496	CheckComRCBreakRC (hrc);
6497
6498	Utf8Str logDir = logFolder;
6499
6500	/* make sure the Logs folder exists */
6501	Assert (!logDir.isEmpty());
6502	if (!RTDirExists (logDir))
6503	RTDirCreateFullPath (logDir, 0777);
6504
6505	Utf8Str logFile = Utf8StrFmt ("%s%cVBox.log",
6506	logDir.raw(), RTPATH_DELIMITER);
6507
6508	/*
6509	* Age the old log files
6510	* Rename .2 to .3, .1 to .2 and the last log file to .1
6511	* Overwrite target files in case they exist;
6512	*/
6513	for (int i = 2; i >= 0; i--)
6514	{
6515	Utf8Str oldName;
6516	if (i > 0)
6517	oldName = Utf8StrFmt ("%s.%d", logFile.raw(), i);
6518	else
6519	oldName = logFile;
6520	Utf8Str newName = Utf8StrFmt ("%s.%d", logFile.raw(), i + 1);
6521	RTFileRename(oldName.raw(), newName.raw(), RTFILEMOVE_FLAGS_REPLACE);
6522	}
6523
6524	PRTLOGGER loggerRelease;
6525	static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
6526	RTUINT fFlags = RTLOGFLAGS_PREFIX_TIME_PROG;
6527	#ifdef __WIN__
6528	fFlags \|= RTLOGFLAGS_USECRLF;
6529	#endif /* __WIN__ */
6530	vrc = RTLogCreate(&loggerRelease, fFlags, "all",
6531	"VBOX_RELEASE_LOG", ELEMENTS(s_apszGroups), s_apszGroups,
6532	RTLOGDEST_FILE, logFile.raw());
6533	if (VBOX_SUCCESS(vrc))
6534	{
6535	/* some introductory information */
6536	RTTIMESPEC timeSpec;
6537	char nowUct[64];
6538	RTTimeSpecToString(RTTimeNow(&timeSpec), nowUct, sizeof(nowUct));
6539	RTLogRelLogger(loggerRelease, 0, ~0U,
6540	"VirtualBox %s (%s %s) release log\n"
6541	"Log opened %s\n",
6542	VBOX_VERSION_STRING, __DATE__, __TIME__,
6543	nowUct);
6544
6545	/* register this logger as the release logger */
6546	RTLogRelSetDefaultInstance(loggerRelease);
6547	}
6548	else
6549	{
6550	hrc = setError (E_FAIL,
6551	tr ("Failed to open release log file '%s' (%Vrc)"),
6552	logFile.raw(), vrc);
6553	break;
6554	}
6555
6556	#ifdef VBOX_VRDP
6557	if (VBOX_SUCCESS (vrc))
6558	{
6559	/* Create the VRDP server. In case of headless operation, this will
6560	* also create the framebuffer, required at VM creation.
6561	*/
6562	ConsoleVRDPServer *server = console->consoleVRDPServer();
6563	Assert (server);
6564	/// @todo (dmik)
6565	// does VRDP server call Console from the other thread?
6566	// Not sure, so leave the lock just in case
6567	alock.leave();
6568	vrc = server->Launch();
6569	alock.enter();
6570	if (VBOX_FAILURE (vrc))
6571	{
6572	Utf8Str errMsg;
6573	switch (vrc)
6574	{
6575	case VERR_NET_ADDRESS_IN_USE:
6576	{
6577	ULONG port = 0;
6578	console->mVRDPServer->COMGETTER(Port) (&port);
6579	errMsg = Utf8StrFmt (tr ("VRDP server port %d is already in use"),
6580	port);
6581	break;
6582	}
6583	default:
6584	errMsg = Utf8StrFmt (tr ("Failed to launch VRDP server (%Vrc)"),
6585	vrc);
6586	}
6587	LogRel (("Failed to launch VRDP server (%Vrc), error message: '%s'\n",
6588	vrc, errMsg.raw()));
6589	hrc = setError (E_FAIL, errMsg);
6590	break;
6591	}
6592	}
6593	#endif /* VBOX_VRDP */
6594
6595	/*
6596	* Create the VM
6597	*/
6598	PVM pVM;
6599	/*
6600	* leave the lock since EMT will call Console. It's safe because
6601	* mMachineState is either Starting or Restoring state here.
6602	*/
6603	alock.leave();
6604
6605	vrc = VMR3Create (task->mSetVMErrorCallback, task.get(),
6606	task->mConfigConstructor, task.get(),
6607	&pVM);
6608
6609	alock.enter();
6610
6611	#ifdef VBOX_VRDP
6612	{
6613	/* Enable client connections to the server. */
6614	ConsoleVRDPServer *server = console->consoleVRDPServer();
6615	server->SetCallback ();
6616	}
6617	#endif /* VBOX_VRDP */
6618
6619	if (VBOX_SUCCESS (vrc))
6620	{
6621	do
6622	{
6623	/*
6624	* Register our load/save state file handlers
6625	*/
6626	vrc = SSMR3RegisterExternal (pVM,
6627	sSSMConsoleUnit, 0 /* iInstance */, sSSMConsoleVer,
6628	0 /* cbGuess */,
6629	NULL, saveStateFileExec, NULL, NULL, loadStateFileExec, NULL,
6630	static_cast <Console *> (console));
6631	AssertRC (vrc);
6632	if (VBOX_FAILURE (vrc))
6633	break;
6634
6635	/*
6636	* Synchronize debugger settings
6637	*/
6638	MachineDebugger *machineDebugger = console->getMachineDebugger();
6639	if (machineDebugger)
6640	{
6641	machineDebugger->flushQueuedSettings();
6642	}
6643
6644	if (console->getVMMDev()->isShFlActive())
6645	{
6646	/// @todo (dmik)
6647	// does the code below call Console from the other thread?
6648	// Not sure, so leave the lock just in case
6649	alock.leave();
6650
6651	/*
6652	* Shared Folders
6653	*/
6654	for (std::map <Bstr, ComPtr <ISharedFolder> >::const_iterator
6655	it = task->mSharedFolders.begin();
6656	it != task->mSharedFolders.end();
6657	++ it)
6658	{
6659	Bstr name = (*it).first;
6660	ComPtr <ISharedFolder> folder = (*it).second;
6661
6662	Bstr hostPath;
6663	hrc = folder->COMGETTER(HostPath) (hostPath.asOutParam());
6664	CheckComRCBreakRC (hrc);
6665
6666	LogFlowFunc (("Adding shared folder '%ls' -> '%ls'\n",
6667	name.raw(), hostPath.raw()));
6668	ComAssertBreak (!name.isEmpty() && !hostPath.isEmpty(),
6669	hrc = E_FAIL);
6670
6671	/** @todo should move this into the shared folder class */
6672	VBOXHGCMSVCPARM parms[2];
6673	SHFLSTRING pFolderName, pMapName;
6674	int cbString;
6675
6676	cbString = (hostPath.length() + 1) * sizeof(RTUCS2);
6677	pFolderName = (SHFLSTRING *)RTMemAllocZ(sizeof(SHFLSTRING) + cbString);
6678	Assert(pFolderName);
6679	memcpy(pFolderName->String.ucs2, hostPath.raw(), cbString);
6680
6681	pFolderName->u16Size = cbString;
6682	pFolderName->u16Length = cbString - sizeof(RTUCS2);
6683
6684	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
6685	parms[0].u.pointer.addr = pFolderName;
6686	parms[0].u.pointer.size = sizeof(SHFLSTRING) + cbString;
6687
6688	cbString = (name.length() + 1) * sizeof(RTUCS2);
6689	pMapName = (SHFLSTRING *)RTMemAllocZ(sizeof(SHFLSTRING) + cbString);
6690	Assert(pMapName);
6691	memcpy(pMapName->String.ucs2, name.raw(), cbString);
6692
6693	pMapName->u16Size = cbString;
6694	pMapName->u16Length = cbString - sizeof(RTUCS2);
6695
6696	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
6697	parms[1].u.pointer.addr = pMapName;
6698	parms[1].u.pointer.size = sizeof(SHFLSTRING) + cbString;
6699
6700	vrc = console->getVMMDev()->hgcmHostCall("VBoxSharedFolders",
6701	SHFL_FN_ADD_MAPPING, 2, &parms[0]);
6702
6703	RTMemFree(pFolderName);
6704	RTMemFree(pMapName);
6705
6706	if (VBOX_FAILURE (vrc))
6707	{
6708	hrc = setError (E_FAIL,
6709	tr ("Unable to add mapping '%ls' to '%ls' (%Vrc)"),
6710	hostPath.raw(), name.raw(), vrc);
6711	break;
6712	}
6713	}
6714
6715	/* enter the lock again */
6716	alock.enter();
6717
6718	CheckComRCBreakRC (hrc);
6719	}
6720
6721	/*
6722	* Capture USB devices.
6723	*/
6724	hrc = console->captureUSBDevices (pVM);
6725	CheckComRCBreakRC (hrc);
6726
6727	/* leave the lock before a lengthy operation */
6728	alock.leave();
6729
6730	/* Load saved state? */
6731	if (!!task->mSavedStateFile)
6732	{
6733	LogFlowFunc (("Restoring saved state from '%s'...\n",
6734	task->mSavedStateFile.raw()));
6735
6736	vrc = VMR3Load (pVM, task->mSavedStateFile,
6737	Console::stateProgressCallback,
6738	static_cast <VMProgressTask *> (task.get()));
6739
6740	/* Start/Resume the VM execution */
6741	if (VBOX_SUCCESS (vrc))
6742	{
6743	vrc = VMR3Resume (pVM);
6744	AssertRC (vrc);
6745	}
6746
6747	/* Power off in case we failed loading or resuming the VM */
6748	if (VBOX_FAILURE (vrc))
6749	{
6750	int vrc2 = VMR3PowerOff (pVM);
6751	AssertRC (vrc2);
6752	}
6753	}
6754	else
6755	{
6756	/* Power on the VM (i.e. start executing) */
6757	vrc = VMR3PowerOn(pVM);
6758	AssertRC (vrc);
6759	}
6760
6761	/* enter the lock again */
6762	alock.enter();
6763	}
6764	while (0);
6765
6766	/* On failure, destroy the VM */
6767	if (FAILED (hrc) \|\| VBOX_FAILURE (vrc))
6768	{
6769	/* preserve existing error info */
6770	ErrorInfoKeeper eik;
6771
6772	/*
6773	* powerDown() will call VMR3Destroy() and do all necessary
6774	* cleanup (VRDP, USB devices)
6775	*/
6776	HRESULT hrc2 = console->powerDown();
6777	AssertComRC (hrc2);
6778	}
6779	}
6780	else
6781	{
6782	/*
6783	* If VMR3Create() failed it has released the VM memory.
6784	*/
6785	console->mpVM = NULL;
6786	}
6787
6788	if (SUCCEEDED (hrc) && VBOX_FAILURE (vrc))
6789	{
6790	/*
6791	* If VMR3Create() or one of the other calls in this function fail,
6792	* an appropriate error message has been already set. However since
6793	* that happens via a callback, the status code in this function is
6794	* not updated.
6795	*/
6796	if (!task->mProgress->completed())
6797	{
6798	/*
6799	* If the COM error info is not yet set but we've got a
6800	* failure, convert the VBox status code into a meaningful
6801	* error message. This becomes unused once all the sources of
6802	* errors set the appropriate error message themselves.
6803	* Note that we don't use VMSetError() below because pVM is
6804	* either invalid or NULL here.
6805	*/
6806	AssertMsgFailed (("Missing error message during powerup for "
6807	"status code %Vrc\n", vrc));
6808	hrc = setError (E_FAIL,
6809	tr ("Failed to start VM execution (%Vrc)"), vrc);
6810	}
6811	else
6812	hrc = task->mProgress->resultCode();
6813
6814	Assert (FAILED (hrc));
6815	break;
6816	}
6817	}
6818	while (0);
6819
6820	if (console->mMachineState == MachineState_Starting \|\|
6821	console->mMachineState == MachineState_Restoring)
6822	{
6823	/*
6824	* We are still in the Starting/Restoring state. This means one of:
6825	* 1) we failed before VMR3Create() was called;
6826	* 2) VMR3Create() failed.
6827	* In both cases, there is no need to call powerDown(), but we still
6828	* need to go back to the PoweredOff/Saved state. Reuse
6829	* vmstateChangeCallback() for that purpose.
6830	*/
6831
6832	/* preserve existing error info */
6833	ErrorInfoKeeper eik;
6834
6835	Assert (console->mpVM == NULL);
6836	vmstateChangeCallback (NULL, VMSTATE_TERMINATED, VMSTATE_CREATING,
6837	console);
6838	}
6839
6840	/*
6841	* Evaluate the final result.
6842	* Note that the appropriate mMachineState value is already set by
6843	* vmstateChangeCallback() in all cases.
6844	*/
6845
6846	/* leave the lock, don't need it any more */
6847	alock.leave();
6848
6849	if (SUCCEEDED (hrc))
6850	{
6851	/* Notify the progress object of the success */
6852	task->mProgress->notifyComplete (S_OK);
6853	}
6854	else
6855	{
6856	if (!task->mProgress->completed())
6857	{
6858	/* The progress object will fetch the current error info. This
6859	* gets the errors signalled by using setError(). The ones
6860	* signalled via VMSetError() immediately notify the progress
6861	* object that the operation is completed. */
6862	task->mProgress->notifyComplete (hrc);
6863	}
6864
6865	LogRel (("Power up failed (vrc=%Vrc, hrc=0x%08X)\n", vrc, hrc));
6866	}
6867
6868	#if defined(__WIN__)
6869	/* uninitialize COM */
6870	CoUninitialize();
6871	#endif
6872
6873	LogFlowFuncLeave();
6874
6875	return VINF_SUCCESS;
6876	}
6877
6878
6879	/**
6880	* Reconfigures a VDI.
6881	*
6882	* @param pVM The VM handle.
6883	* @param hda The harddisk attachment.
6884	* @param phrc Where to store com error - only valid if we return VERR_GENERAL_FAILURE.
6885	* @return VBox status code.
6886	*/
6887	static DECLCALLBACK(int) reconfigureVDI(PVM pVM, IHardDiskAttachment hda, HRESULT phrc)
6888	{
6889	LogFlowFunc (("pVM=%p hda=%p phrc=%p\n", pVM, hda, phrc));
6890
6891	int rc;
6892	HRESULT hrc;
6893	char *psz = NULL;
6894	BSTR str = NULL;
6895	*phrc = S_OK;
6896	#define STR_CONV() do { rc = RTStrUcs2ToUtf8(&psz, str); RC_CHECK(); } while (0)
6897	#define STR_FREE() do { if (str) { SysFreeString(str); str = NULL; } if (psz) { RTStrFree(psz); psz = NULL; } } while (0)
6898	#define RC_CHECK() do { if (VBOX_FAILURE(rc)) { AssertMsgFailed(("rc=%Vrc\n", rc)); STR_FREE(); return rc; } } while (0)
6899	#define H() do { if (FAILED(hrc)) { AssertMsgFailed(("hrc=%#x\n", hrc)); STR_FREE(); *phrc = hrc; return VERR_GENERAL_FAILURE; } } while (0)
6900
6901	/*
6902	* Figure out which IDE device this is.
6903	*/
6904	ComPtr<IHardDisk> hardDisk;
6905	hrc = hda->COMGETTER(HardDisk)(hardDisk.asOutParam()); H();
6906	DiskControllerType_T enmCtl;
6907	hrc = hda->COMGETTER(Controller)(&enmCtl); H();
6908	LONG lDev;
6909	hrc = hda->COMGETTER(DeviceNumber)(&lDev); H();
6910
6911	int i;
6912	switch (enmCtl)
6913	{
6914	case DiskControllerType_IDE0Controller:
6915	i = 0;
6916	break;
6917	case DiskControllerType_IDE1Controller:
6918	i = 2;
6919	break;
6920	default:
6921	AssertMsgFailed(("invalid disk controller type: %d\n", enmCtl));
6922	return VERR_GENERAL_FAILURE;
6923	}
6924
6925	if (lDev < 0 \|\| lDev >= 2)
6926	{
6927	AssertMsgFailed(("invalid controller device number: %d\n", lDev));
6928	return VERR_GENERAL_FAILURE;
6929	}
6930
6931	i = i + lDev;
6932
6933	/*
6934	* Is there an existing LUN? If not create it.
6935	* We ASSUME that this will NEVER collide with the DVD.
6936	*/
6937	PCFGMNODE pCfg;
6938	PCFGMNODE pLunL1 = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/piix3ide/0/LUN#%d/AttachedDriver/", i);
6939	if (!pLunL1)
6940	{
6941	PCFGMNODE pInst = CFGMR3GetChild(CFGMR3GetRoot(pVM), "Devices/piix3ide/0/");
6942	AssertReturn(pInst, VERR_INTERNAL_ERROR);
6943
6944	PCFGMNODE pLunL0;
6945	rc = CFGMR3InsertNodeF(pInst, &pLunL0, "LUN#%d", i); RC_CHECK();
6946	rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
6947	rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
6948	rc = CFGMR3InsertString(pCfg, "Type", "HardDisk"); RC_CHECK();
6949	rc = CFGMR3InsertInteger(pCfg, "Mountable", 0); RC_CHECK();
6950
6951	rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
6952	rc = CFGMR3InsertString(pLunL1, "Driver", "VBoxHDD"); RC_CHECK();
6953	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
6954	}
6955	else
6956	{
6957	#ifdef VBOX_STRICT
6958	char *pszDriver;
6959	rc = CFGMR3QueryStringAlloc(pLunL1, "Driver", &pszDriver); RC_CHECK();
6960	Assert(!strcmp(pszDriver, "VBoxHDD"));
6961	MMR3HeapFree(pszDriver);
6962	#endif
6963
6964	/*
6965	* Check if things has changed.
6966	*/
6967	pCfg = CFGMR3GetChild(pLunL1, "Config");
6968	AssertReturn(pCfg, VERR_INTERNAL_ERROR);
6969
6970	/* the image */
6971	/// @todo (dmik) we temporarily use the location property to
6972	// determine the image file name. This is subject to change
6973	// when iSCSI disks are here (we should either query a
6974	// storage-specific interface from IHardDisk, or "standardize"
6975	// the location property)
6976	hrc = hardDisk->COMGETTER(Location)(&str); H();
6977	STR_CONV();
6978	char *pszPath;
6979	rc = CFGMR3QueryStringAlloc(pCfg, "Path", &pszPath); RC_CHECK();
6980	if (!strcmp(psz, pszPath))
6981	{
6982	/* parent images. */
6983	ComPtr<IHardDisk> parentHardDisk = hardDisk;
6984	for (PCFGMNODE pParent = pCfg;;)
6985	{
6986	MMR3HeapFree(pszPath);
6987	pszPath = NULL;
6988	STR_FREE();
6989
6990	/* get parent */
6991	ComPtr<IHardDisk> curHardDisk;
6992	hrc = parentHardDisk->COMGETTER(Parent)(curHardDisk.asOutParam()); H();
6993	PCFGMNODE pCur;
6994	pCur = CFGMR3GetChild(pParent, "Parent");
6995	if (!pCur && !curHardDisk)
6996	{
6997	/* no change */
6998	LogFlowFunc (("No change!\n"));
6999	return VINF_SUCCESS;
7000	}
7001	if (!pCur \|\| !curHardDisk)
7002	break;
7003
7004	/* compare paths. */
7005	/// @todo (dmik) we temporarily use the location property to
7006	// determine the image file name. This is subject to change
7007	// when iSCSI disks are here (we should either query a
7008	// storage-specific interface from IHardDisk, or "standardize"
7009	// the location property)
7010	hrc = curHardDisk->COMGETTER(Location)(&str); H();
7011	STR_CONV();
7012	rc = CFGMR3QueryStringAlloc(pCfg, "Path", &pszPath); RC_CHECK();
7013	if (strcmp(psz, pszPath))
7014	break;
7015
7016	/* next */
7017	pParent = pCur;
7018	parentHardDisk = curHardDisk;
7019	}
7020
7021	}
7022	else
7023	LogFlowFunc (("LUN#%d: old leaf image '%s'\n", i, pszPath));
7024
7025	MMR3HeapFree(pszPath);
7026	STR_FREE();
7027
7028	/*
7029	* Detach the driver and replace the config node.
7030	*/
7031	rc = PDMR3DeviceDetach(pVM, "piix3ide", 0, i); RC_CHECK();
7032	CFGMR3RemoveNode(pCfg);
7033	rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
7034	}
7035
7036	/*
7037	* Create the driver configuration.
7038	*/
7039	/// @todo (dmik) we temporarily use the location property to
7040	// determine the image file name. This is subject to change
7041	// when iSCSI disks are here (we should either query a
7042	// storage-specific interface from IHardDisk, or "standardize"
7043	// the location property)
7044	hrc = hardDisk->COMGETTER(Location)(&str); H();
7045	STR_CONV();
7046	LogFlowFunc (("LUN#%d: leaf image '%s'\n", i, psz));
7047	rc = CFGMR3InsertString(pCfg, "Path", psz); RC_CHECK();
7048	STR_FREE();
7049	/* Create an inversed tree of parents. */
7050	ComPtr<IHardDisk> parentHardDisk = hardDisk;
7051	for (PCFGMNODE pParent = pCfg;;)
7052	{
7053	ComPtr<IHardDisk> curHardDisk;
7054	hrc = parentHardDisk->COMGETTER(Parent)(curHardDisk.asOutParam()); H();
7055	if (!curHardDisk)
7056	break;
7057
7058	PCFGMNODE pCur;
7059	rc = CFGMR3InsertNode(pParent, "Parent", &pCur); RC_CHECK();
7060	/// @todo (dmik) we temporarily use the location property to
7061	// determine the image file name. This is subject to change
7062	// when iSCSI disks are here (we should either query a
7063	// storage-specific interface from IHardDisk, or "standardize"
7064	// the location property)
7065	hrc = curHardDisk->COMGETTER(Location)(&str); H();
7066	STR_CONV();
7067	rc = CFGMR3InsertString(pCur, "Path", psz); RC_CHECK();
7068	STR_FREE();
7069
7070	/* next */
7071	pParent = pCur;
7072	parentHardDisk = curHardDisk;
7073	}
7074
7075	/*
7076	* Attach the new driver.
7077	*/
7078	rc = PDMR3DeviceAttach(pVM, "piix3ide", 0, i, NULL); RC_CHECK();
7079
7080	LogFlowFunc (("Returns success\n"));
7081	return rc;
7082	}
7083
7084
7085	/**
7086	* Thread for executing the saved state operation.
7087	*
7088	* @param Thread The thread handle.
7089	* @param pvUser Pointer to a VMSaveTask structure.
7090	* @return VINF_SUCCESS (ignored).
7091	*
7092	* @note Locks the Console object for writing.
7093	*/
7094	/static/
7095	DECLCALLBACK (int) Console::saveStateThread (RTTHREAD Thread, void *pvUser)
7096	{
7097	LogFlowFuncEnter();
7098
7099	std::auto_ptr <VMSaveTask> task (static_cast <VMSaveTask *> (pvUser));
7100	AssertReturn (task.get(), VERR_INVALID_PARAMETER);
7101
7102	Assert (!task->mSavedStateFile.isNull());
7103	Assert (!task->mProgress.isNull());
7104
7105	const ComObjPtr <Console> &that = task->mConsole;
7106
7107	/*
7108	* Note: no need to use addCaller() to protect Console or addVMCaller() to
7109	* protect mpVM because VMSaveTask does that
7110	*/
7111
7112	Utf8Str errMsg;
7113	HRESULT rc = S_OK;
7114
7115	if (task->mIsSnapshot)
7116	{
7117	Assert (!task->mServerProgress.isNull());
7118	LogFlowFunc (("Waiting until the server creates differencing VDIs...\n"));
7119
7120	rc = task->mServerProgress->WaitForCompletion (-1);
7121	if (SUCCEEDED (rc))
7122	{
7123	HRESULT result = S_OK;
7124	rc = task->mServerProgress->COMGETTER(ResultCode) (&result);
7125	if (SUCCEEDED (rc))
7126	rc = result;
7127	}
7128	}
7129
7130	if (SUCCEEDED (rc))
7131	{
7132	LogFlowFunc (("Saving the state to '%s'...\n", task->mSavedStateFile.raw()));
7133
7134	int vrc = VMR3Save (that->mpVM, task->mSavedStateFile,
7135	Console::stateProgressCallback,
7136	static_cast <VMProgressTask *> (task.get()));
7137	if (VBOX_FAILURE (vrc))
7138	{
7139	errMsg = Utf8StrFmt (
7140	Console::tr ("Failed to save the machine state to '%s' (%Vrc)"),
7141	task->mSavedStateFile.raw(), vrc);
7142	rc = E_FAIL;
7143	}
7144	}
7145
7146	/* lock the console sonce we're going to access it */
7147	AutoLock thatLock (that);
7148
7149	if (SUCCEEDED (rc))
7150	{
7151	if (task->mIsSnapshot)
7152	do
7153	{
7154	LogFlowFunc (("Reattaching new differencing VDIs...\n"));
7155
7156	ComPtr <IHardDiskAttachmentCollection> hdaColl;
7157	rc = that->mMachine->COMGETTER(HardDiskAttachments) (hdaColl.asOutParam());
7158	if (FAILED (rc))
7159	break;
7160	ComPtr <IHardDiskAttachmentEnumerator> hdaEn;
7161	rc = hdaColl->Enumerate (hdaEn.asOutParam());
7162	if (FAILED (rc))
7163	break;
7164	BOOL more = FALSE;
7165	while (SUCCEEDED (rc = hdaEn->HasMore (&more)) && more)
7166	{
7167	ComPtr <IHardDiskAttachment> hda;
7168	rc = hdaEn->GetNext (hda.asOutParam());
7169	if (FAILED (rc))
7170	break;
7171
7172	PVMREQ pReq;
7173	IHardDiskAttachment *pHda = hda;
7174	/*
7175	* don't leave the lock since reconfigureVDI isn't going to
7176	* access Console.
7177	*/
7178	int vrc = VMR3ReqCall (that->mpVM, &pReq, RT_INDEFINITE_WAIT,
7179	(PFNRT)reconfigureVDI, 3, that->mpVM,
7180	pHda, &rc);
7181	if (VBOX_SUCCESS (rc))
7182	rc = pReq->iStatus;
7183	VMR3ReqFree (pReq);
7184	if (FAILED (rc))
7185	break;
7186	if (VBOX_FAILURE (vrc))
7187	{
7188	errMsg = Utf8StrFmt (Console::tr ("%Vrc"), vrc);
7189	rc = E_FAIL;
7190	break;
7191	}
7192	}
7193	}
7194	while (0);
7195	}
7196
7197	/* finalize the procedure regardless of the result */
7198	if (task->mIsSnapshot)
7199	{
7200	/*
7201	* finalize the requested snapshot object.
7202	* This will reset the machine state to the state it had right
7203	* before calling mControl->BeginTakingSnapshot().
7204	*/
7205	that->mControl->EndTakingSnapshot (SUCCEEDED (rc));
7206	}
7207	else
7208	{
7209	/*
7210	* finalize the requested save state procedure.
7211	* In case of success, the server will set the machine state to Saved;
7212	* in case of failure it will reset the it to the state it had right
7213	* before calling mControl->BeginSavingState().
7214	*/
7215	that->mControl->EndSavingState (SUCCEEDED (rc));
7216	}
7217
7218	/* synchronize the state with the server */
7219	if (task->mIsSnapshot \|\| FAILED (rc))
7220	{
7221	if (task->mLastMachineState == MachineState_Running)
7222	{
7223	/* restore the paused state if appropriate */
7224	that->setMachineStateLocally (MachineState_Paused);
7225	/* restore the running state if appropriate */
7226	that->Resume();
7227	}
7228	else
7229	that->setMachineStateLocally (task->mLastMachineState);
7230	}
7231	else
7232	{
7233	/*
7234	* The machine has been successfully saved, so power it down
7235	* (vmstateChangeCallback() will set state to Saved on success).
7236	* Note: we release the task's VM caller, otherwise it will
7237	* deadlock.
7238	*/
7239	task->releaseVMCaller();
7240
7241	rc = that->powerDown();
7242	}
7243
7244	/* notify the progress object about operation completion */
7245	if (SUCCEEDED (rc))
7246	task->mProgress->notifyComplete (S_OK);
7247	else
7248	{
7249	if (!errMsg.isNull())
7250	task->mProgress->notifyComplete (rc,
7251	COM_IIDOF(IConsole), Console::getComponentName(), errMsg);
7252	else
7253	task->mProgress->notifyComplete (rc);
7254	}
7255
7256	LogFlowFuncLeave();
7257	return VINF_SUCCESS;
7258	}
7259
7260	/**
7261	* Thread for powering down the Console.
7262	*
7263	* @param Thread The thread handle.
7264	* @param pvUser Pointer to the VMTask structure.
7265	* @return VINF_SUCCESS (ignored).
7266	*
7267	* @note Locks the Console object for writing.
7268	*/
7269	/static/
7270	DECLCALLBACK (int) Console::powerDownThread (RTTHREAD Thread, void *pvUser)
7271	{
7272	LogFlowFuncEnter();
7273
7274	std::auto_ptr <VMTask> task (static_cast <VMTask *> (pvUser));
7275	AssertReturn (task.get(), VERR_INVALID_PARAMETER);
7276
7277	AssertReturn (task->isOk(), VERR_GENERAL_FAILURE);
7278
7279	const ComObjPtr <Console> &that = task->mConsole;
7280
7281	/*
7282	* Note: no need to use addCaller() to protect Console
7283	* because VMTask does that
7284	*/
7285
7286	/* release VM caller to let powerDown() proceed */
7287	task->releaseVMCaller();
7288
7289	HRESULT rc = that->powerDown();
7290	AssertComRC (rc);
7291
7292	LogFlowFuncLeave();
7293	return VINF_SUCCESS;
7294	}
7295
7296	/**
7297	* The Main status driver instance data.
7298	*/
7299	typedef struct DRVMAINSTATUS
7300	{
7301	/** The LED connectors. */
7302	PDMILEDCONNECTORS ILedConnectors;
7303	/** Pointer to the LED ports interface above us. */
7304	PPDMILEDPORTS pLedPorts;
7305	/** Pointer to the array of LED pointers. */
7306	PPDMLED *papLeds;
7307	/** The unit number corresponding to the first entry in the LED array. */
7308	RTUINT iFirstLUN;
7309	/** The unit number corresponding to the last entry in the LED array.
7310	* (The size of the LED array is iLastLUN - iFirstLUN + 1.) */
7311	RTUINT iLastLUN;
7312	} DRVMAINSTATUS, *PDRVMAINSTATUS;
7313
7314
7315	/**
7316	* Notification about a unit which have been changed.
7317	*
7318	* The driver must discard any pointers to data owned by
7319	* the unit and requery it.
7320	*
7321	* @param pInterface Pointer to the interface structure containing the called function pointer.
7322	* @param iLUN The unit number.
7323	*/
7324	DECLCALLBACK(void) Console::drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN)
7325	{
7326	PDRVMAINSTATUS pData = (PDRVMAINSTATUS)(void *)pInterface;
7327	if (iLUN >= pData->iFirstLUN && iLUN <= pData->iLastLUN)
7328	{
7329	PPDMLED pLed;
7330	int rc = pData->pLedPorts->pfnQueryStatusLed(pData->pLedPorts, iLUN, &pLed);
7331	if (VBOX_FAILURE(rc))
7332	pLed = NULL;
7333	ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLUN - pData->iFirstLUN], pLed);
7334	Log(("drvStatus_UnitChanged: iLUN=%d pLed=%p\n", iLUN, pLed));
7335	}
7336	}
7337
7338
7339	/**
7340	* Queries an interface to the driver.
7341	*
7342	* @returns Pointer to interface.
7343	* @returns NULL if the interface was not supported by the driver.
7344	* @param pInterface Pointer to this interface structure.
7345	* @param enmInterface The requested interface identification.
7346	*/
7347	DECLCALLBACK(void *) Console::drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
7348	{
7349	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
7350	PDRVMAINSTATUS pDrv = PDMINS2DATA(pDrvIns, PDRVMAINSTATUS);
7351	switch (enmInterface)
7352	{
7353	case PDMINTERFACE_BASE:
7354	return &pDrvIns->IBase;
7355	case PDMINTERFACE_LED_CONNECTORS:
7356	return &pDrv->ILedConnectors;
7357	default:
7358	return NULL;
7359	}
7360	}
7361
7362
7363	/**
7364	* Destruct a status driver instance.
7365	*
7366	* @returns VBox status.
7367	* @param pDrvIns The driver instance data.
7368	*/
7369	DECLCALLBACK(void) Console::drvStatus_Destruct(PPDMDRVINS pDrvIns)
7370	{
7371	PDRVMAINSTATUS pData = PDMINS2DATA(pDrvIns, PDRVMAINSTATUS);
7372	LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7373	if (pData->papLeds)
7374	{
7375	unsigned iLed = pData->iLastLUN - pData->iFirstLUN + 1;
7376	while (iLed-- > 0)
7377	ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLed], NULL);
7378	}
7379	}
7380
7381
7382	/**
7383	* Construct a status driver instance.
7384	*
7385	* @returns VBox status.
7386	* @param pDrvIns The driver instance data.
7387	* If the registration structure is needed, pDrvIns->pDrvReg points to it.
7388	* @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
7389	* of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
7390	* iInstance it's expected to be used a bit in this function.
7391	*/
7392	DECLCALLBACK(int) Console::drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
7393	{
7394	PDRVMAINSTATUS pData = PDMINS2DATA(pDrvIns, PDRVMAINSTATUS);
7395	LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7396
7397	/*
7398	* Validate configuration.
7399	*/
7400	if (!CFGMR3AreValuesValid(pCfgHandle, "papLeds\0First\0Last\0"))
7401	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
7402	PPDMIBASE pBaseIgnore;
7403	int rc = pDrvIns->pDrvHlp->pfnAttach(pDrvIns, &pBaseIgnore);
7404	if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
7405	{
7406	AssertMsgFailed(("Configuration error: Not possible to attach anything to this driver!\n"));
7407	return VERR_PDM_DRVINS_NO_ATTACH;
7408	}
7409
7410	/*
7411	* Data.
7412	*/
7413	pDrvIns->IBase.pfnQueryInterface = Console::drvStatus_QueryInterface;
7414	pData->ILedConnectors.pfnUnitChanged = Console::drvStatus_UnitChanged;
7415
7416	/*
7417	* Read config.
7418	*/
7419	rc = CFGMR3QueryPtr(pCfgHandle, "papLeds", (void **)&pData->papLeds);
7420	if (VBOX_FAILURE(rc))
7421	{
7422	AssertMsgFailed(("Configuration error: Failed to query the \"papLeds\" value! rc=%Vrc\n", rc));
7423	return rc;
7424	}
7425
7426	rc = CFGMR3QueryU32(pCfgHandle, "First", &pData->iFirstLUN);
7427	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7428	pData->iFirstLUN = 0;
7429	else if (VBOX_FAILURE(rc))
7430	{
7431	AssertMsgFailed(("Configuration error: Failed to query the \"First\" value! rc=%Vrc\n", rc));
7432	return rc;
7433	}
7434
7435	rc = CFGMR3QueryU32(pCfgHandle, "Last", &pData->iLastLUN);
7436	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7437	pData->iLastLUN = 0;
7438	else if (VBOX_FAILURE(rc))
7439	{
7440	AssertMsgFailed(("Configuration error: Failed to query the \"Last\" value! rc=%Vrc\n", rc));
7441	return rc;
7442	}
7443	if (pData->iFirstLUN > pData->iLastLUN)
7444	{
7445	AssertMsgFailed(("Configuration error: Invalid unit range %u-%u\n", pData->iFirstLUN, pData->iLastLUN));
7446	return VERR_GENERAL_FAILURE;
7447	}
7448
7449	/*
7450	* Get the ILedPorts interface of the above driver/device and
7451	* query the LEDs we want.
7452	*/
7453	pData->pLedPorts = (PPDMILEDPORTS)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_LED_PORTS);
7454	if (!pData->pLedPorts)
7455	{
7456	AssertMsgFailed(("Configuration error: No led ports interface above!\n"));
7457	return VERR_PDM_MISSING_INTERFACE_ABOVE;
7458	}
7459
7460	for (unsigned i = pData->iFirstLUN; i <= pData->iLastLUN; i++)
7461	Console::drvStatus_UnitChanged(&pData->ILedConnectors, i);
7462
7463	return VINF_SUCCESS;
7464	}
7465
7466
7467	/**
7468	* Keyboard driver registration record.
7469	*/
7470	const PDMDRVREG Console::DrvStatusReg =
7471	{
7472	/* u32Version */
7473	PDM_DRVREG_VERSION,
7474	/* szDriverName */
7475	"MainStatus",
7476	/* pszDescription */
7477	"Main status driver (Main as in the API).",
7478	/* fFlags */
7479	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
7480	/* fClass. */
7481	PDM_DRVREG_CLASS_STATUS,
7482	/* cMaxInstances */
7483	~0,
7484	/* cbInstance */
7485	sizeof(DRVMAINSTATUS),
7486	/* pfnConstruct */
7487	Console::drvStatus_Construct,
7488	/* pfnDestruct */
7489	Console::drvStatus_Destruct,
7490	/* pfnIOCtl */
7491	NULL,
7492	/* pfnPowerOn */
7493	NULL,
7494	/* pfnReset */
7495	NULL,
7496	/* pfnSuspend */
7497	NULL,
7498	/* pfnResume */
7499	NULL,
7500	/* pfnDetach */
7501	NULL
7502	};
7503

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/ConsoleImpl.cpp@ 3037

Download in other formats: