VirtualBox

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

Last change on this file since 22663 was 22624, checked in by vboxsync, 15 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette