VirtualBox

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

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

VM starts even if VRDP server fails to bind to a port.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 243.6 KB
Line 
1/* $Id: ConsoleImpl.cpp 23130 2009-09-18 13:02:03Z 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 uPass The data pass.
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 uPass)
1066{
1067 LogFlowFunc (("\n"));
1068
1069 if (SSM_VERSION_MAJOR_CHANGED(uVersion, sSSMConsoleVer))
1070 return VERR_VERSION_MISMATCH;
1071 Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
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#ifndef VBOX_WITH_LIVE_MIGRATION /** @todo update the API docs. */
2389 if (mMachineState == MachineState_Running)
2390 {
2391 HRESULT rc = Pause();
2392 CheckComRCReturnRC(rc);
2393 }
2394#endif
2395
2396 HRESULT rc = S_OK;
2397
2398 bool const fTakingSnapshotOnline = ( mMachineState == MachineState_Running
2399 || mMachineState == MachineState_Paused);
2400
2401 /*
2402 * create a descriptionless VM-side progress object
2403 * (only when creating a snapshot online)
2404 */
2405 ComObjPtr<Progress> saveProgress;
2406 if (fTakingSnapshotOnline)
2407 {
2408 saveProgress.createObject();
2409 rc = saveProgress->init(FALSE, 1, Bstr(tr("Saving the execution state")));
2410 AssertComRCReturn (rc, rc);
2411 }
2412
2413 bool fBeganTakingSnapshot = false;
2414 bool fTaskCreationFailed = false;
2415
2416 do
2417 {
2418 /* create a task object early to ensure mpVM protection is successful */
2419 std::auto_ptr<VMSaveTask> task;
2420 if (fTakingSnapshotOnline)
2421 {
2422 task.reset(new VMSaveTask(this, saveProgress));
2423 rc = task->rc();
2424 /*
2425 * If we fail here it means a PowerDown() call happened on another
2426 * thread while we were doing Pause() (which leaves the Console lock).
2427 * We assign PowerDown() a higher precedence than TakeSnapshot(),
2428 * therefore just return the error to the caller.
2429 */
2430 if (FAILED (rc))
2431 {
2432 fTaskCreationFailed = true;
2433 break;
2434 }
2435 }
2436
2437 Bstr stateFilePath;
2438 ComPtr<IProgress> serverProgress;
2439
2440 /*
2441 * request taking a new snapshot object on the server
2442 * (this will set the machine state to Saving on the server to block
2443 * others from accessing this machine)
2444 */
2445 rc = mControl->BeginTakingSnapshot(this,
2446 aName,
2447 aDescription,
2448 saveProgress,
2449 stateFilePath.asOutParam(),
2450 serverProgress.asOutParam());
2451 if (FAILED (rc))
2452 break;
2453
2454 /*
2455 * The state file is non-null only when creating a online or live snapshot.
2456 */
2457 ComAssertBreak( (!stateFilePath.isNull() && fTakingSnapshotOnline)
2458 || (stateFilePath.isNull() && !fTakingSnapshotOnline),
2459 rc = E_FAIL);
2460
2461 fBeganTakingSnapshot = true;
2462
2463 /* sync the state with the server */
2464 setMachineStateLocally(MachineState_Saving);
2465
2466 /*
2467 * create a combined VM-side progress object and start the save task
2468 * (only when creating a snapshot online)
2469 */
2470 ComObjPtr<CombinedProgress> combinedProgress;
2471 if (fTakingSnapshotOnline)
2472 {
2473 combinedProgress.createObject();
2474 rc = combinedProgress->init(static_cast<IConsole*>(this),
2475 Bstr(tr("Taking snapshot of virtual machine")),
2476 serverProgress,
2477 saveProgress);
2478 AssertComRCBreakRC (rc);
2479
2480 /* setup task object and thread to carry out the operation asynchronously */
2481 task->mIsSnapshot = true;
2482 task->mSavedStateFile = stateFilePath;
2483 task->mServerProgress = serverProgress;
2484 /* set the state the operation thread will restore when it is finished */
2485 task->mLastMachineState = lastMachineState;
2486
2487 /* create a thread to wait until the VM state is saved */
2488 int vrc = RTThreadCreate(NULL,
2489 Console::saveStateThread,
2490 (void*)task.get(),
2491 0,
2492 RTTHREADTYPE_MAIN_WORKER,
2493 0,
2494 "VMTakeSnap");
2495
2496 ComAssertMsgRCBreak(vrc,
2497 ("Could not create VMTakeSnap thread (%Rrc)", vrc),
2498 rc = E_FAIL);
2499
2500 /* task is now owned by saveStateThread(), so release it */
2501 task.release();
2502 }
2503
2504 if (SUCCEEDED(rc))
2505 {
2506 /* return the correct progress to the caller */
2507 if (combinedProgress)
2508 combinedProgress.queryInterfaceTo(aProgress);
2509 else
2510 serverProgress.queryInterfaceTo(aProgress);
2511 }
2512 } while (0);
2513
2514 if (FAILED(rc) && !fTaskCreationFailed)
2515 {
2516 /* preserve existing error info */
2517 ErrorInfoKeeper eik;
2518
2519 if (fBeganTakingSnapshot && fTakingSnapshotOnline)
2520 {
2521 /*
2522 * cancel the requested snapshot (only when creating a snapshot
2523 * online, otherwise the server will cancel the snapshot itself).
2524 * This will reset the machine state to the state it had right
2525 * before calling mControl->BeginTakingSnapshot().
2526 */
2527 mControl->EndTakingSnapshot(FALSE);
2528 }
2529
2530 if (lastMachineState == MachineState_Running)
2531 {
2532 /* restore the paused state if appropriate */
2533 setMachineStateLocally(MachineState_Paused);
2534 /* restore the running state if appropriate */
2535 Resume();
2536 }
2537 else
2538 setMachineStateLocally(lastMachineState);
2539 }
2540
2541 LogFlowThisFunc(("rc=%08X\n", rc));
2542 LogFlowThisFuncLeave();
2543 return rc;
2544}
2545
2546STDMETHODIMP Console::DiscardSnapshot(IN_BSTR aId, IProgress **aProgress)
2547{
2548 CheckComArgExpr(aId, Guid (aId).isEmpty() == false);
2549 CheckComArgOutPointerValid(aProgress);
2550
2551 AutoCaller autoCaller(this);
2552 CheckComRCReturnRC(autoCaller.rc());
2553
2554 AutoWriteLock alock(this);
2555
2556 if (Global::IsOnlineOrTransient (mMachineState))
2557 return setError (VBOX_E_INVALID_VM_STATE,
2558 tr ("Cannot discard a snapshot of the running machine "
2559 "(machine state: %d)"),
2560 mMachineState);
2561
2562 MachineState_T machineState = MachineState_Null;
2563 HRESULT rc = mControl->DiscardSnapshot (this, aId, &machineState, aProgress);
2564 CheckComRCReturnRC(rc);
2565
2566 setMachineStateLocally (machineState);
2567 return S_OK;
2568}
2569
2570STDMETHODIMP Console::DiscardCurrentState (IProgress **aProgress)
2571{
2572 AutoCaller autoCaller(this);
2573 CheckComRCReturnRC(autoCaller.rc());
2574
2575 AutoWriteLock alock(this);
2576
2577 if (Global::IsOnlineOrTransient (mMachineState))
2578 return setError (VBOX_E_INVALID_VM_STATE,
2579 tr ("Cannot discard the current state of the running machine "
2580 "(nachine state: %d)"),
2581 mMachineState);
2582
2583 MachineState_T machineState = MachineState_Null;
2584 HRESULT rc = mControl->DiscardCurrentState (this, &machineState, aProgress);
2585 CheckComRCReturnRC(rc);
2586
2587 setMachineStateLocally (machineState);
2588 return S_OK;
2589}
2590
2591STDMETHODIMP Console::DiscardCurrentSnapshotAndState (IProgress **aProgress)
2592{
2593 AutoCaller autoCaller(this);
2594 CheckComRCReturnRC(autoCaller.rc());
2595
2596 AutoWriteLock alock(this);
2597
2598 if (Global::IsOnlineOrTransient (mMachineState))
2599 return setError (VBOX_E_INVALID_VM_STATE,
2600 tr ("Cannot discard the current snapshot and state of the "
2601 "running machine (machine state: %d)"),
2602 mMachineState);
2603
2604 MachineState_T machineState = MachineState_Null;
2605 HRESULT rc =
2606 mControl->DiscardCurrentSnapshotAndState (this, &machineState, aProgress);
2607 CheckComRCReturnRC(rc);
2608
2609 setMachineStateLocally (machineState);
2610 return S_OK;
2611}
2612
2613STDMETHODIMP Console::RegisterCallback (IConsoleCallback *aCallback)
2614{
2615 CheckComArgNotNull(aCallback);
2616
2617 AutoCaller autoCaller(this);
2618 CheckComRCReturnRC(autoCaller.rc());
2619
2620#if 0 /** @todo r=bird,r=pritesh: must check that the interface id match correct or we might screw up with old code! */
2621 void *dummy;
2622 HRESULT hrc = aCallback->QueryInterface(NS_GET_IID(IConsoleCallback), &dummy);
2623 if (FAILED(hrc))
2624 return hrc;
2625 aCallback->Release();
2626#endif
2627
2628 AutoWriteLock alock(this);
2629
2630 mCallbacks.push_back (CallbackList::value_type (aCallback));
2631
2632 /* Inform the callback about the current status (for example, the new
2633 * callback must know the current mouse capabilities and the pointer
2634 * shape in order to properly integrate the mouse pointer). */
2635
2636 if (mCallbackData.mpsc.valid)
2637 aCallback->OnMousePointerShapeChange (mCallbackData.mpsc.visible,
2638 mCallbackData.mpsc.alpha,
2639 mCallbackData.mpsc.xHot,
2640 mCallbackData.mpsc.yHot,
2641 mCallbackData.mpsc.width,
2642 mCallbackData.mpsc.height,
2643 mCallbackData.mpsc.shape);
2644 if (mCallbackData.mcc.valid)
2645 aCallback->OnMouseCapabilityChange (mCallbackData.mcc.supportsAbsolute,
2646 mCallbackData.mcc.needsHostCursor);
2647
2648 aCallback->OnAdditionsStateChange();
2649
2650 if (mCallbackData.klc.valid)
2651 aCallback->OnKeyboardLedsChange (mCallbackData.klc.numLock,
2652 mCallbackData.klc.capsLock,
2653 mCallbackData.klc.scrollLock);
2654
2655 /* Note: we don't call OnStateChange for new callbacks because the
2656 * machine state is a) not actually changed on callback registration
2657 * and b) can be always queried from Console. */
2658
2659 return S_OK;
2660}
2661
2662STDMETHODIMP Console::UnregisterCallback (IConsoleCallback *aCallback)
2663{
2664 CheckComArgNotNull(aCallback);
2665
2666 AutoCaller autoCaller(this);
2667 CheckComRCReturnRC(autoCaller.rc());
2668
2669 AutoWriteLock alock(this);
2670
2671 CallbackList::iterator it;
2672 it = std::find (mCallbacks.begin(),
2673 mCallbacks.end(),
2674 CallbackList::value_type (aCallback));
2675 if (it == mCallbacks.end())
2676 return setError (E_INVALIDARG,
2677 tr ("The given callback handler is not registered"));
2678
2679 mCallbacks.erase (it);
2680 return S_OK;
2681}
2682
2683// Non-interface public methods
2684/////////////////////////////////////////////////////////////////////////////
2685
2686/**
2687 * Called by IInternalSessionControl::OnDVDDriveChange().
2688 *
2689 * @note Locks this object for writing.
2690 */
2691HRESULT Console::onDVDDriveChange()
2692{
2693 LogFlowThisFuncEnter();
2694
2695 AutoCaller autoCaller(this);
2696 AssertComRCReturnRC(autoCaller.rc());
2697
2698 /* doDriveChange() needs a write lock */
2699 AutoWriteLock alock(this);
2700
2701 /* Ignore callbacks when there's no VM around */
2702 if (!mpVM)
2703 return S_OK;
2704
2705 /* protect mpVM */
2706 AutoVMCaller autoVMCaller (this);
2707 CheckComRCReturnRC(autoVMCaller.rc());
2708
2709 /* Get the current DVD state */
2710 HRESULT rc;
2711 DriveState_T eState;
2712
2713 rc = mDVDDrive->COMGETTER (State) (&eState);
2714 ComAssertComRCRetRC (rc);
2715
2716 /* Paranoia */
2717 if ( eState == DriveState_NotMounted
2718 && meDVDState == DriveState_NotMounted)
2719 {
2720 LogFlowThisFunc(("Returns (NotMounted -> NotMounted)\n"));
2721 return S_OK;
2722 }
2723
2724 /* Get the path string and other relevant properties */
2725 Bstr Path;
2726 bool fPassthrough = false;
2727 switch (eState)
2728 {
2729 case DriveState_ImageMounted:
2730 {
2731 ComPtr<IDVDImage> ImagePtr;
2732 rc = mDVDDrive->GetImage (ImagePtr.asOutParam());
2733 if (SUCCEEDED(rc))
2734 rc = ImagePtr->COMGETTER(Location) (Path.asOutParam());
2735 break;
2736 }
2737
2738 case DriveState_HostDriveCaptured:
2739 {
2740 ComPtr<IHostDVDDrive> DrivePtr;
2741 BOOL enabled;
2742 rc = mDVDDrive->GetHostDrive (DrivePtr.asOutParam());
2743 if (SUCCEEDED(rc))
2744 rc = DrivePtr->COMGETTER (Name) (Path.asOutParam());
2745 if (SUCCEEDED(rc))
2746 rc = mDVDDrive->COMGETTER (Passthrough) (&enabled);
2747 if (SUCCEEDED(rc))
2748 fPassthrough = !!enabled;
2749 break;
2750 }
2751
2752 case DriveState_NotMounted:
2753 break;
2754
2755 default:
2756 AssertMsgFailed (("Invalid DriveState: %d\n", eState));
2757 rc = E_FAIL;
2758 break;
2759 }
2760
2761 AssertComRC (rc);
2762 if (SUCCEEDED(rc))
2763 {
2764 rc = doDriveChange ("piix3ide", 0, 2, eState, &meDVDState,
2765 Utf8Str (Path).raw(), fPassthrough);
2766
2767 /* notify console callbacks on success */
2768 if (SUCCEEDED(rc))
2769 {
2770 CallbackList::iterator it = mCallbacks.begin();
2771 while (it != mCallbacks.end())
2772 (*it++)->OnDVDDriveChange();
2773 }
2774 }
2775
2776 LogFlowThisFunc(("Returns %Rhrc (%#x)\n", rc, rc));
2777 LogFlowThisFuncLeave();
2778 return rc;
2779}
2780
2781
2782/**
2783 * Called by IInternalSessionControl::OnFloppyDriveChange().
2784 *
2785 * @note Locks this object for writing.
2786 */
2787HRESULT Console::onFloppyDriveChange()
2788{
2789 LogFlowThisFuncEnter();
2790
2791 AutoCaller autoCaller(this);
2792 AssertComRCReturnRC(autoCaller.rc());
2793
2794 /* doDriveChange() needs a write lock */
2795 AutoWriteLock alock(this);
2796
2797 /* Ignore callbacks when there's no VM around */
2798 if (!mpVM)
2799 return S_OK;
2800
2801 /* protect mpVM */
2802 AutoVMCaller autoVMCaller (this);
2803 CheckComRCReturnRC(autoVMCaller.rc());
2804
2805 /* Get the current floppy state */
2806 HRESULT rc;
2807 DriveState_T eState;
2808
2809 /* If the floppy drive is disabled, we're not interested */
2810 BOOL fEnabled;
2811 rc = mFloppyDrive->COMGETTER (Enabled) (&fEnabled);
2812 ComAssertComRCRetRC (rc);
2813
2814 if (!fEnabled)
2815 return S_OK;
2816
2817 rc = mFloppyDrive->COMGETTER (State) (&eState);
2818 ComAssertComRCRetRC (rc);
2819
2820 Log2 (("onFloppyDriveChange: eState=%d meFloppyState=%d\n", eState, meFloppyState));
2821
2822
2823 /* Paranoia */
2824 if ( eState == DriveState_NotMounted
2825 && meFloppyState == DriveState_NotMounted)
2826 {
2827 LogFlowThisFunc(("Returns (NotMounted -> NotMounted)\n"));
2828 return S_OK;
2829 }
2830
2831 /* Get the path string and other relevant properties */
2832 Bstr Path;
2833 switch (eState)
2834 {
2835 case DriveState_ImageMounted:
2836 {
2837 ComPtr<IFloppyImage> ImagePtr;
2838 rc = mFloppyDrive->GetImage (ImagePtr.asOutParam());
2839 if (SUCCEEDED(rc))
2840 rc = ImagePtr->COMGETTER(Location) (Path.asOutParam());
2841 break;
2842 }
2843
2844 case DriveState_HostDriveCaptured:
2845 {
2846 ComPtr<IHostFloppyDrive> DrivePtr;
2847 rc = mFloppyDrive->GetHostDrive (DrivePtr.asOutParam());
2848 if (SUCCEEDED(rc))
2849 rc = DrivePtr->COMGETTER (Name) (Path.asOutParam());
2850 break;
2851 }
2852
2853 case DriveState_NotMounted:
2854 break;
2855
2856 default:
2857 AssertMsgFailed (("Invalid DriveState: %d\n", eState));
2858 rc = E_FAIL;
2859 break;
2860 }
2861
2862 AssertComRC (rc);
2863 if (SUCCEEDED(rc))
2864 {
2865 rc = doDriveChange ("i82078", 0, 0, eState, &meFloppyState,
2866 Utf8Str (Path).raw(), false);
2867
2868 /* notify console callbacks on success */
2869 if (SUCCEEDED(rc))
2870 {
2871 CallbackList::iterator it = mCallbacks.begin();
2872 while (it != mCallbacks.end())
2873 (*it++)->OnFloppyDriveChange();
2874 }
2875 }
2876
2877 LogFlowThisFunc(("Returns %Rhrc (%#x)\n", rc, rc));
2878 LogFlowThisFuncLeave();
2879 return rc;
2880}
2881
2882
2883/**
2884 * Process a floppy or dvd change.
2885 *
2886 * @returns COM status code.
2887 *
2888 * @param pszDevice The PDM device name.
2889 * @param uInstance The PDM device instance.
2890 * @param uLun The PDM LUN number of the drive.
2891 * @param eState The new state.
2892 * @param peState Pointer to the variable keeping the actual state of the drive.
2893 * This will be both read and updated to eState or other appropriate state.
2894 * @param pszPath The path to the media / drive which is now being mounted / captured.
2895 * If NULL no media or drive is attached and the LUN will be configured with
2896 * the default block driver with no media. This will also be the state if
2897 * mounting / capturing the specified media / drive fails.
2898 * @param fPassthrough Enables using passthrough mode of the host DVD drive if applicable.
2899 *
2900 * @note Locks this object for writing.
2901 */
2902HRESULT Console::doDriveChange (const char *pszDevice, unsigned uInstance, unsigned uLun, DriveState_T eState,
2903 DriveState_T *peState, const char *pszPath, bool fPassthrough)
2904{
2905 LogFlowThisFunc(("pszDevice=%p:{%s} uInstance=%u uLun=%u eState=%d "
2906 "peState=%p:{%d} pszPath=%p:{%s} fPassthrough=%d\n",
2907 pszDevice, pszDevice, uInstance, uLun, eState,
2908 peState, *peState, pszPath, pszPath, fPassthrough));
2909
2910 AutoCaller autoCaller(this);
2911 AssertComRCReturnRC(autoCaller.rc());
2912
2913 /* We will need to release the write lock before calling EMT */
2914 AutoWriteLock alock(this);
2915
2916 /* protect mpVM */
2917 AutoVMCaller autoVMCaller (this);
2918 CheckComRCReturnRC(autoVMCaller.rc());
2919
2920 /*
2921 * Call worker in EMT, that's faster and safer than doing everything
2922 * using VM3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
2923 * here to make requests from under the lock in order to serialize them.
2924 */
2925 PVMREQ pReq;
2926 int vrc = VMR3ReqCall (mpVM, VMCPUID_ANY, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
2927 (PFNRT) Console::changeDrive, 8,
2928 this, pszDevice, uInstance, uLun, eState, peState, pszPath, fPassthrough);
2929
2930 /* leave the lock before waiting for a result (EMT will call us back!) */
2931 alock.leave();
2932
2933 if (vrc == VERR_TIMEOUT || VBOX_SUCCESS (vrc))
2934 {
2935 vrc = VMR3ReqWait (pReq, RT_INDEFINITE_WAIT);
2936 AssertRC (vrc);
2937 if (VBOX_SUCCESS (vrc))
2938 vrc = pReq->iStatus;
2939 }
2940 VMR3ReqFree (pReq);
2941
2942 if (VBOX_SUCCESS (vrc))
2943 {
2944 LogFlowThisFunc(("Returns S_OK\n"));
2945 return S_OK;
2946 }
2947
2948 if (pszPath)
2949 return setError (E_FAIL,
2950 tr ("Could not mount the media/drive '%s' (%Rrc)"), pszPath, vrc);
2951
2952 return setError (E_FAIL,
2953 tr ("Could not unmount the currently mounted media/drive (%Rrc)"), vrc);
2954}
2955
2956
2957/**
2958 * Performs the Floppy/DVD change in EMT.
2959 *
2960 * @returns VBox status code.
2961 *
2962 * @param pThis Pointer to the Console object.
2963 * @param pszDevice The PDM device name.
2964 * @param uInstance The PDM device instance.
2965 * @param uLun The PDM LUN number of the drive.
2966 * @param eState The new state.
2967 * @param peState Pointer to the variable keeping the actual state of the drive.
2968 * This will be both read and updated to eState or other appropriate state.
2969 * @param pszPath The path to the media / drive which is now being mounted / captured.
2970 * If NULL no media or drive is attached and the LUN will be configured with
2971 * the default block driver with no media. This will also be the state if
2972 * mounting / capturing the specified media / drive fails.
2973 * @param fPassthrough Enables using passthrough mode of the host DVD drive if applicable.
2974 *
2975 * @thread EMT
2976 * @note Locks the Console object for writing.
2977 */
2978DECLCALLBACK(int) Console::changeDrive (Console *pThis, const char *pszDevice, unsigned uInstance, unsigned uLun,
2979 DriveState_T eState, DriveState_T *peState,
2980 const char *pszPath, bool fPassthrough)
2981{
2982 LogFlowFunc (("pThis=%p pszDevice=%p:{%s} uInstance=%u uLun=%u eState=%d "
2983 "peState=%p:{%d} pszPath=%p:{%s} fPassthrough=%d\n",
2984 pThis, pszDevice, pszDevice, uInstance, uLun, eState,
2985 peState, *peState, pszPath, pszPath, fPassthrough));
2986
2987 AssertReturn(pThis, VERR_INVALID_PARAMETER);
2988
2989 AssertMsg ( (!strcmp (pszDevice, "i82078") && uLun == 0 && uInstance == 0)
2990 || (!strcmp (pszDevice, "piix3ide") && uLun == 2 && uInstance == 0),
2991 ("pszDevice=%s uLun=%d uInstance=%d\n", pszDevice, uLun, uInstance));
2992
2993 AutoCaller autoCaller(pThis);
2994 AssertComRCReturn (autoCaller.rc(), VERR_ACCESS_DENIED);
2995
2996 /* protect mpVM */
2997 AutoVMCaller autoVMCaller (pThis);
2998 CheckComRCReturnRC(autoVMCaller.rc());
2999
3000 PVM pVM = pThis->mpVM;
3001
3002 /*
3003 * Suspend the VM first.
3004 *
3005 * The VM must not be running since it might have pending I/O to
3006 * the drive which is being changed.
3007 */
3008 bool fResume;
3009 VMSTATE enmVMState = VMR3GetState (pVM);
3010 switch (enmVMState)
3011 {
3012 case VMSTATE_RESETTING:
3013 case VMSTATE_RUNNING:
3014 {
3015 LogFlowFunc (("Suspending the VM...\n"));
3016 /* disable the callback to prevent Console-level state change */
3017 pThis->mVMStateChangeCallbackDisabled = true;
3018 int rc = VMR3Suspend (pVM);
3019 pThis->mVMStateChangeCallbackDisabled = false;
3020 AssertRCReturn (rc, rc);
3021 fResume = true;
3022 break;
3023 }
3024
3025 case VMSTATE_SUSPENDED:
3026 case VMSTATE_CREATED:
3027 case VMSTATE_OFF:
3028 fResume = false;
3029 break;
3030
3031 default:
3032 AssertMsgFailedReturn (("enmVMState=%d\n", enmVMState), VERR_ACCESS_DENIED);
3033 }
3034
3035 int rc = VINF_SUCCESS;
3036 int rcRet = VINF_SUCCESS;
3037
3038 /*
3039 In general locking the object before doing VMR3* calls is quite safe
3040 here, since we're on EMT. Anyway we lock for write after eventually
3041 suspending the vm. The reason is that in the vmstateChangeCallback the
3042 var mVMStateChangeCallbackDisabled is checked under a lock also, which
3043 can lead to an dead lock. The write lock is necessary because we
3044 indirectly modify the meDVDState/meFloppyState members (pointed to by
3045 peState).
3046 */
3047 AutoWriteLock alock(pThis);
3048
3049 do
3050 {
3051 /*
3052 * Unmount existing media / detach host drive.
3053 */
3054 PPDMIMOUNT pIMount = NULL;
3055 switch (*peState)
3056 {
3057
3058 case DriveState_ImageMounted:
3059 {
3060 /*
3061 * Resolve the interface.
3062 */
3063 PPDMIBASE pBase;
3064 rc = PDMR3QueryLun (pVM, pszDevice, uInstance, uLun, &pBase);
3065 if (VBOX_FAILURE (rc))
3066 {
3067 if (rc == VERR_PDM_LUN_NOT_FOUND)
3068 rc = VINF_SUCCESS;
3069 AssertRC (rc);
3070 break;
3071 }
3072
3073 pIMount = (PPDMIMOUNT) pBase->pfnQueryInterface (pBase, PDMINTERFACE_MOUNT);
3074 AssertBreakStmt (pIMount, rc = VERR_INVALID_POINTER);
3075
3076 /*
3077 * Unmount the media.
3078 */
3079 rc = pIMount->pfnUnmount (pIMount, false);
3080 if (rc == VERR_PDM_MEDIA_NOT_MOUNTED)
3081 rc = VINF_SUCCESS;
3082 break;
3083 }
3084
3085 case DriveState_HostDriveCaptured:
3086 {
3087 rc = PDMR3DeviceDetach (pVM, pszDevice, uInstance, uLun, PDM_TACH_FLAGS_NOT_HOT_PLUG);
3088 if (rc == VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN)
3089 rc = VINF_SUCCESS;
3090 AssertRC (rc);
3091 break;
3092 }
3093
3094 case DriveState_NotMounted:
3095 break;
3096
3097 default:
3098 AssertMsgFailed (("Invalid *peState: %d\n", peState));
3099 break;
3100 }
3101
3102 if (VBOX_FAILURE (rc))
3103 {
3104 rcRet = rc;
3105 break;
3106 }
3107
3108 /*
3109 * Nothing is currently mounted.
3110 */
3111 *peState = DriveState_NotMounted;
3112
3113
3114 /*
3115 * Process the HostDriveCaptured state first, as the fallback path
3116 * means mounting the normal block driver without media.
3117 */
3118 if (eState == DriveState_HostDriveCaptured)
3119 {
3120 /*
3121 * Detach existing driver chain (block).
3122 */
3123 int rc = PDMR3DeviceDetach (pVM, pszDevice, uInstance, uLun, PDM_TACH_FLAGS_NOT_HOT_PLUG);
3124 if (VBOX_FAILURE (rc))
3125 {
3126 if (rc == VERR_PDM_LUN_NOT_FOUND)
3127 rc = VINF_SUCCESS;
3128 AssertReleaseRC (rc);
3129 break; /* we're toast */
3130 }
3131 pIMount = NULL;
3132
3133 /*
3134 * Construct a new driver configuration.
3135 */
3136 PCFGMNODE pInst = CFGMR3GetChildF (CFGMR3GetRoot (pVM), "Devices/%s/%d/", pszDevice, uInstance);
3137 AssertRelease (pInst);
3138 /* nuke anything which might have been left behind. */
3139 CFGMR3RemoveNode (CFGMR3GetChildF (pInst, "LUN#%d", uLun));
3140
3141 /* create a new block driver config */
3142 PCFGMNODE pLunL0;
3143 PCFGMNODE pCfg;
3144 if ( VBOX_SUCCESS (rc = CFGMR3InsertNodeF (pInst, &pLunL0, "LUN#%u", uLun))
3145 && VBOX_SUCCESS (rc = CFGMR3InsertString (pLunL0, "Driver", !strcmp (pszDevice, "i82078") ? "HostFloppy" : "HostDVD"))
3146 && VBOX_SUCCESS (rc = CFGMR3InsertNode (pLunL0, "Config", &pCfg))
3147 && VBOX_SUCCESS (rc = CFGMR3InsertString (pCfg, "Path", pszPath))
3148 && VBOX_SUCCESS (rc = !strcmp (pszDevice, "i82078") ? VINF_SUCCESS : CFGMR3InsertInteger(pCfg, "Passthrough", fPassthrough)))
3149 {
3150 /*
3151 * Attempt to attach the driver.
3152 */
3153 rc = PDMR3DeviceAttach(pVM, pszDevice, uInstance, uLun, PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /*ppBase*/);
3154 AssertRC (rc);
3155 }
3156 if (VBOX_FAILURE (rc))
3157 rcRet = rc;
3158 }
3159
3160 /*
3161 * Process the ImageMounted, NotMounted and failed HostDriveCapture cases.
3162 */
3163 rc = VINF_SUCCESS;
3164 switch (eState)
3165 {
3166#define RC_CHECK() do { if (VBOX_FAILURE (rc)) { AssertReleaseRC (rc); break; } } while (0)
3167
3168 case DriveState_HostDriveCaptured:
3169 if (VBOX_SUCCESS (rcRet))
3170 break;
3171 /* fallback: umounted block driver. */
3172 pszPath = NULL;
3173 eState = DriveState_NotMounted;
3174 /* fallthru */
3175 case DriveState_ImageMounted:
3176 case DriveState_NotMounted:
3177 {
3178 /*
3179 * Resolve the drive interface / create the driver.
3180 */
3181 if (!pIMount)
3182 {
3183 PPDMIBASE pBase;
3184 rc = PDMR3QueryLun (pVM, pszDevice, uInstance, uLun, &pBase);
3185 if (rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
3186 {
3187 /*
3188 * We have to create it, so we'll do the full config setup and everything.
3189 */
3190 PCFGMNODE pIdeInst = CFGMR3GetChildF (CFGMR3GetRoot (pVM), "Devices/%s/%d/", pszDevice, uInstance);
3191 AssertRelease (pIdeInst);
3192
3193 /* nuke anything which might have been left behind. */
3194 CFGMR3RemoveNode (CFGMR3GetChildF (pIdeInst, "LUN#%d", uLun));
3195
3196 /* create a new block driver config */
3197 PCFGMNODE pLunL0;
3198 rc = CFGMR3InsertNodeF (pIdeInst, &pLunL0, "LUN#%d", uLun); RC_CHECK();
3199 rc = CFGMR3InsertString (pLunL0, "Driver", "Block"); RC_CHECK();
3200 PCFGMNODE pCfg;
3201 rc = CFGMR3InsertNode (pLunL0, "Config", &pCfg); RC_CHECK();
3202 rc = CFGMR3InsertString (pCfg, "Type", !strcmp (pszDevice, "i82078") ? "Floppy 1.44" : "DVD");
3203 RC_CHECK();
3204 rc = CFGMR3InsertInteger (pCfg, "Mountable", 1); RC_CHECK();
3205
3206 /*
3207 * Attach the driver.
3208 */
3209 rc = PDMR3DeviceAttach(pVM, pszDevice, uInstance, uLun, PDM_TACH_FLAGS_NOT_HOT_PLUG, &pBase);
3210 RC_CHECK();
3211 }
3212 else if (VBOX_FAILURE(rc))
3213 {
3214 AssertRC (rc);
3215 return rc;
3216 }
3217
3218 pIMount = (PPDMIMOUNT) pBase->pfnQueryInterface (pBase, PDMINTERFACE_MOUNT);
3219 if (!pIMount)
3220 {
3221 AssertFailed();
3222 return rc;
3223 }
3224 }
3225
3226 /*
3227 * If we've got an image, let's mount it.
3228 */
3229 if (pszPath && *pszPath)
3230 {
3231 rc = pIMount->pfnMount (pIMount, pszPath, strcmp (pszDevice, "i82078") ? "MediaISO" : "RawImage");
3232 if (VBOX_FAILURE (rc))
3233 eState = DriveState_NotMounted;
3234 }
3235 break;
3236 }
3237
3238 default:
3239 AssertMsgFailed (("Invalid eState: %d\n", eState));
3240 break;
3241
3242#undef RC_CHECK
3243 }
3244
3245 if (VBOX_FAILURE (rc) && VBOX_SUCCESS (rcRet))
3246 rcRet = rc;
3247
3248 *peState = eState;
3249 }
3250 while (0);
3251
3252 /*
3253 Unlock before resuming because the vmstateChangeCallback problem
3254 described above.
3255 */
3256 alock.unlock();
3257
3258 /*
3259 * Resume the VM if necessary.
3260 */
3261 if (fResume)
3262 {
3263 LogFlowFunc (("Resuming the VM...\n"));
3264 /* disable the callback to prevent Console-level state change */
3265 pThis->mVMStateChangeCallbackDisabled = true;
3266 rc = VMR3Resume (pVM);
3267 pThis->mVMStateChangeCallbackDisabled = false;
3268 AssertRC (rc);
3269 if (VBOX_FAILURE (rc))
3270 {
3271 /* too bad, we failed. try to sync the console state with the VMM state */
3272 vmstateChangeCallback (pVM, VMSTATE_SUSPENDED, enmVMState, pThis);
3273 }
3274 /// @todo (r=dmik) if we failed with drive mount, then the VMR3Resume
3275 // error (if any) will be hidden from the caller. For proper reporting
3276 // of such multiple errors to the caller we need to enhance the
3277 // IVurtualBoxError interface. For now, give the first error the higher
3278 // priority.
3279 if (VBOX_SUCCESS (rcRet))
3280 rcRet = rc;
3281 }
3282
3283 LogFlowFunc (("Returning %Rrc\n", rcRet));
3284 return rcRet;
3285}
3286
3287
3288/**
3289 * Called by IInternalSessionControl::OnNetworkAdapterChange().
3290 *
3291 * @note Locks this object for writing.
3292 */
3293HRESULT Console::onNetworkAdapterChange (INetworkAdapter *aNetworkAdapter, BOOL changeAdapter)
3294{
3295 LogFlowThisFunc(("\n"));
3296
3297 AutoCaller autoCaller(this);
3298 AssertComRCReturnRC(autoCaller.rc());
3299
3300 AutoWriteLock alock(this);
3301
3302 /* Don't do anything if the VM isn't running */
3303 if (!mpVM)
3304 return S_OK;
3305
3306 /* protect mpVM */
3307 AutoVMCaller autoVMCaller (this);
3308 CheckComRCReturnRC(autoVMCaller.rc());
3309
3310 /* Get the properties we need from the adapter */
3311 BOOL fCableConnected, fTraceEnabled;
3312 HRESULT rc = aNetworkAdapter->COMGETTER(CableConnected) (&fCableConnected);
3313 AssertComRC(rc);
3314 if (SUCCEEDED(rc))
3315 {
3316 rc = aNetworkAdapter->COMGETTER(TraceEnabled) (&fTraceEnabled);
3317 AssertComRC(rc);
3318 }
3319 if (SUCCEEDED(rc))
3320 {
3321 ULONG ulInstance;
3322 rc = aNetworkAdapter->COMGETTER(Slot) (&ulInstance);
3323 AssertComRC (rc);
3324 if (SUCCEEDED(rc))
3325 {
3326 /*
3327 * Find the pcnet instance, get the config interface and update
3328 * the link state.
3329 */
3330 PPDMIBASE pBase;
3331 const char *pszAdapterName = "pcnet";
3332#ifdef VBOX_WITH_E1000
3333 /*
3334 * Perhaps it would be much wiser to wrap both 'pcnet' and 'e1000'
3335 * into generic 'net' device.
3336 */
3337 NetworkAdapterType_T adapterType;
3338 rc = aNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
3339 AssertComRC(rc);
3340 if (adapterType == NetworkAdapterType_I82540EM ||
3341 adapterType == NetworkAdapterType_I82543GC ||
3342 adapterType == NetworkAdapterType_I82545EM)
3343 pszAdapterName = "e1000";
3344#ifdef VBOX_WITH_VIRTIO
3345 if (adapterType == NetworkAdapterType_Virtio)
3346 pszAdapterName = "virtio";
3347#endif /* VBOX_WITH_VIRTIO */
3348#endif
3349 int vrc = PDMR3QueryDeviceLun (mpVM, pszAdapterName,
3350 (unsigned) ulInstance, 0, &pBase);
3351 ComAssertRC (vrc);
3352 if (VBOX_SUCCESS(vrc))
3353 {
3354 Assert(pBase);
3355 PPDMINETWORKCONFIG pINetCfg = (PPDMINETWORKCONFIG) pBase->
3356 pfnQueryInterface(pBase, PDMINTERFACE_NETWORK_CONFIG);
3357 if (pINetCfg)
3358 {
3359 Log (("Console::onNetworkAdapterChange: setting link state to %d\n",
3360 fCableConnected));
3361 vrc = pINetCfg->pfnSetLinkState (pINetCfg,
3362 fCableConnected ? PDMNETWORKLINKSTATE_UP
3363 : PDMNETWORKLINKSTATE_DOWN);
3364 ComAssertRC(vrc);
3365 }
3366#ifdef VBOX_DYNAMIC_NET_ATTACH
3367 if (RT_SUCCESS(vrc) && changeAdapter)
3368 {
3369 VMSTATE enmVMState = VMR3GetState(mpVM);
3370
3371 if ( enmVMState == VMSTATE_RUNNING
3372 || enmVMState == VMSTATE_SUSPENDED)
3373 {
3374 if (fTraceEnabled && fCableConnected && pINetCfg)
3375 {
3376 vrc = pINetCfg->pfnSetLinkState (pINetCfg, PDMNETWORKLINKSTATE_DOWN);
3377 ComAssertRC(vrc);
3378 }
3379
3380 rc = doNetworkAdapterChange(pszAdapterName, ulInstance, 0, aNetworkAdapter);
3381
3382 if (fTraceEnabled && fCableConnected && pINetCfg)
3383 {
3384 vrc = pINetCfg->pfnSetLinkState (pINetCfg, PDMNETWORKLINKSTATE_UP);
3385 ComAssertRC(vrc);
3386 }
3387 }
3388 }
3389#endif /* VBOX_DYNAMIC_NET_ATTACH */
3390 }
3391
3392 if (VBOX_FAILURE (vrc))
3393 rc = E_FAIL;
3394 }
3395 }
3396
3397 /* notify console callbacks on success */
3398 if (SUCCEEDED(rc))
3399 {
3400 CallbackList::iterator it = mCallbacks.begin();
3401 while (it != mCallbacks.end())
3402 (*it++)->OnNetworkAdapterChange (aNetworkAdapter);
3403 }
3404
3405 LogFlowThisFunc(("Leaving rc=%#x\n", rc));
3406 return rc;
3407}
3408
3409
3410#ifdef VBOX_DYNAMIC_NET_ATTACH
3411/**
3412 * Process a network adaptor change.
3413 *
3414 * @returns COM status code.
3415 *
3416 * @param pszDevice The PDM device name.
3417 * @param uInstance The PDM device instance.
3418 * @param uLun The PDM LUN number of the drive.
3419 * @param aNetworkAdapter The network adapter whose attachment needs to be changed
3420 *
3421 * @note Locks this object for writing.
3422 */
3423HRESULT Console::doNetworkAdapterChange (const char *pszDevice,
3424 unsigned uInstance,
3425 unsigned uLun,
3426 INetworkAdapter *aNetworkAdapter)
3427{
3428 LogFlowThisFunc(("pszDevice=%p:{%s} uInstance=%u uLun=%u aNetworkAdapter=%p\n",
3429 pszDevice, pszDevice, uInstance, uLun, aNetworkAdapter));
3430
3431 AutoCaller autoCaller(this);
3432 AssertComRCReturnRC(autoCaller.rc());
3433
3434 /* We will need to release the write lock before calling EMT */
3435 AutoWriteLock alock(this);
3436
3437 /* protect mpVM */
3438 AutoVMCaller autoVMCaller (this);
3439 CheckComRCReturnRC(autoVMCaller.rc());
3440
3441 /*
3442 * Call worker in EMT, that's faster and safer than doing everything
3443 * using VM3ReqCall. Note that we separate VMR3ReqCall from VMR3ReqWait
3444 * here to make requests from under the lock in order to serialize them.
3445 */
3446 PVMREQ pReq;
3447 int vrc = VMR3ReqCall (mpVM, 0 /*idDstCpu*/, &pReq, 0 /* no wait! */, VMREQFLAGS_VBOX_STATUS,
3448 (PFNRT) Console::changeNetworkAttachment, 5,
3449 this, pszDevice, uInstance, uLun, aNetworkAdapter);
3450
3451 /* leave the lock before waiting for a result (EMT will call us back!) */
3452 alock.leave();
3453
3454 if (vrc == VERR_TIMEOUT || VBOX_SUCCESS (vrc))
3455 {
3456 vrc = VMR3ReqWait (pReq, RT_INDEFINITE_WAIT);
3457 AssertRC (vrc);
3458 if (VBOX_SUCCESS (vrc))
3459 vrc = pReq->iStatus;
3460 }
3461 VMR3ReqFree (pReq);
3462
3463 if (VBOX_SUCCESS (vrc))
3464 {
3465 LogFlowThisFunc(("Returns S_OK\n"));
3466 return S_OK;
3467 }
3468
3469 return setError (E_FAIL,
3470 tr ("Could not change the network adaptor attachement type (%Rrc)"), vrc);
3471}
3472
3473
3474/**
3475 * Performs the Network Adaptor change in EMT.
3476 *
3477 * @returns VBox status code.
3478 *
3479 * @param pThis Pointer to the Console object.
3480 * @param pszDevice The PDM device name.
3481 * @param uInstance The PDM device instance.
3482 * @param uLun The PDM LUN number of the drive.
3483 * @param aNetworkAdapter The network adapter whose attachment needs to be changed
3484 *
3485 * @thread EMT
3486 * @note Locks the Console object for writing.
3487 */
3488DECLCALLBACK(int) Console::changeNetworkAttachment (Console *pThis,
3489 const char *pszDevice,
3490 unsigned uInstance,
3491 unsigned uLun,
3492 INetworkAdapter *aNetworkAdapter)
3493{
3494 LogFlowFunc (("pThis=%p pszDevice=%p:{%s} uInstance=%u uLun=%u aNetworkAdapter=%p\n",
3495 pThis, pszDevice, pszDevice, uInstance, uLun, aNetworkAdapter));
3496
3497 AssertReturn(pThis, VERR_INVALID_PARAMETER);
3498
3499 AssertMsg ( (!strcmp (pszDevice, "pcnet") && uLun == 0 && uInstance < SchemaDefs::NetworkAdapterCount)
3500 || (!strcmp (pszDevice, "e1000") && uLun == 0 && uInstance < SchemaDefs::NetworkAdapterCount),
3501 ("pszDevice=%s uLun=%d uInstance=%d\n", pszDevice, uLun, uInstance));
3502 Log(("pszDevice=%s uLun=%d uInstance=%d\n", pszDevice, uLun, uInstance));
3503
3504 AutoCaller autoCaller(pThis);
3505 AssertComRCReturn (autoCaller.rc(), VERR_ACCESS_DENIED);
3506
3507 /* protect mpVM */
3508 AutoVMCaller autoVMCaller (pThis);
3509 CheckComRCReturnRC(autoVMCaller.rc());
3510
3511 PVM pVM = pThis->mpVM;
3512
3513 /*
3514 * Suspend the VM first.
3515 *
3516 * The VM must not be running since it might have pending I/O to
3517 * the drive which is being changed.
3518 */
3519 bool fResume;
3520 VMSTATE enmVMState = VMR3GetState (pVM);
3521 switch (enmVMState)
3522 {
3523 case VMSTATE_RESETTING:
3524 case VMSTATE_RUNNING:
3525 {
3526 LogFlowFunc (("Suspending the VM...\n"));
3527 /* disable the callback to prevent Console-level state change */
3528 pThis->mVMStateChangeCallbackDisabled = true;
3529 int rc = VMR3Suspend (pVM);
3530 pThis->mVMStateChangeCallbackDisabled = false;
3531 AssertRCReturn (rc, rc);
3532 fResume = true;
3533 break;
3534 }
3535
3536 case VMSTATE_SUSPENDED:
3537 case VMSTATE_CREATED:
3538 case VMSTATE_OFF:
3539 fResume = false;
3540 break;
3541
3542 default:
3543 AssertMsgFailedReturn (("enmVMState=%d\n", enmVMState), VERR_ACCESS_DENIED);
3544 }
3545
3546 int rc = VINF_SUCCESS;
3547 int rcRet = VINF_SUCCESS;
3548
3549 PCFGMNODE pCfg = NULL; /* /Devices/Dev/.../Config/ */
3550 PCFGMNODE pLunL0 = NULL; /* /Devices/Dev/0/LUN#0/ */
3551 PCFGMNODE pInst = CFGMR3GetChildF (CFGMR3GetRoot (pVM), "Devices/%s/%d/", pszDevice, uInstance);
3552 AssertRelease (pInst);
3553
3554 rcRet = configNetwork(pThis, pszDevice, uInstance, uLun, aNetworkAdapter, pCfg, pLunL0, pInst, true);
3555
3556 /*
3557 * Resume the VM if necessary.
3558 */
3559 if (fResume)
3560 {
3561 LogFlowFunc (("Resuming the VM...\n"));
3562 /* disable the callback to prevent Console-level state change */
3563 pThis->mVMStateChangeCallbackDisabled = true;
3564 rc = VMR3Resume (pVM);
3565 pThis->mVMStateChangeCallbackDisabled = false;
3566 AssertRC (rc);
3567 if (VBOX_FAILURE (rc))
3568 {
3569 /* too bad, we failed. try to sync the console state with the VMM state */
3570 vmstateChangeCallback (pVM, VMSTATE_SUSPENDED, enmVMState, pThis);
3571 }
3572 /// @todo (r=dmik) if we failed with drive mount, then the VMR3Resume
3573 // error (if any) will be hidden from the caller. For proper reporting
3574 // of such multiple errors to the caller we need to enhance the
3575 // IVirtualBoxError interface. For now, give the first error the higher
3576 // priority.
3577 if (VBOX_SUCCESS (rcRet))
3578 rcRet = rc;
3579 }
3580
3581 LogFlowFunc (("Returning %Rrc\n", rcRet));
3582 return rcRet;
3583}
3584#endif /* VBOX_DYNAMIC_NET_ATTACH */
3585
3586
3587/**
3588 * Called by IInternalSessionControl::OnSerialPortChange().
3589 *
3590 * @note Locks this object for writing.
3591 */
3592HRESULT Console::onSerialPortChange (ISerialPort *aSerialPort)
3593{
3594 LogFlowThisFunc(("\n"));
3595
3596 AutoCaller autoCaller(this);
3597 AssertComRCReturnRC(autoCaller.rc());
3598
3599 AutoWriteLock alock(this);
3600
3601 /* Don't do anything if the VM isn't running */
3602 if (!mpVM)
3603 return S_OK;
3604
3605 HRESULT rc = S_OK;
3606
3607 /* protect mpVM */
3608 AutoVMCaller autoVMCaller (this);
3609 CheckComRCReturnRC(autoVMCaller.rc());
3610
3611 /* nothing to do so far */
3612
3613 /* notify console callbacks on success */
3614 if (SUCCEEDED(rc))
3615 {
3616 CallbackList::iterator it = mCallbacks.begin();
3617 while (it != mCallbacks.end())
3618 (*it++)->OnSerialPortChange (aSerialPort);
3619 }
3620
3621 LogFlowThisFunc(("Leaving rc=%#x\n", rc));
3622 return rc;
3623}
3624
3625/**
3626 * Called by IInternalSessionControl::OnParallelPortChange().
3627 *
3628 * @note Locks this object for writing.
3629 */
3630HRESULT Console::onParallelPortChange (IParallelPort *aParallelPort)
3631{
3632 LogFlowThisFunc(("\n"));
3633
3634 AutoCaller autoCaller(this);
3635 AssertComRCReturnRC(autoCaller.rc());
3636
3637 AutoWriteLock alock(this);
3638
3639 /* Don't do anything if the VM isn't running */
3640 if (!mpVM)
3641 return S_OK;
3642
3643 HRESULT rc = S_OK;
3644
3645 /* protect mpVM */
3646 AutoVMCaller autoVMCaller (this);
3647 CheckComRCReturnRC(autoVMCaller.rc());
3648
3649 /* nothing to do so far */
3650
3651 /* notify console callbacks on success */
3652 if (SUCCEEDED(rc))
3653 {
3654 CallbackList::iterator it = mCallbacks.begin();
3655 while (it != mCallbacks.end())
3656 (*it++)->OnParallelPortChange (aParallelPort);
3657 }
3658
3659 LogFlowThisFunc(("Leaving rc=%#x\n", rc));
3660 return rc;
3661}
3662
3663/**
3664 * Called by IInternalSessionControl::OnStorageControllerChange().
3665 *
3666 * @note Locks this object for writing.
3667 */
3668HRESULT Console::onStorageControllerChange ()
3669{
3670 LogFlowThisFunc(("\n"));
3671
3672 AutoCaller autoCaller(this);
3673 AssertComRCReturnRC(autoCaller.rc());
3674
3675 AutoWriteLock alock(this);
3676
3677 /* Don't do anything if the VM isn't running */
3678 if (!mpVM)
3679 return S_OK;
3680
3681 HRESULT rc = S_OK;
3682
3683 /* protect mpVM */
3684 AutoVMCaller autoVMCaller (this);
3685 CheckComRCReturnRC(autoVMCaller.rc());
3686
3687 /* nothing to do so far */
3688
3689 /* notify console callbacks on success */
3690 if (SUCCEEDED(rc))
3691 {
3692 CallbackList::iterator it = mCallbacks.begin();
3693 while (it != mCallbacks.end())
3694 (*it++)->OnStorageControllerChange ();
3695 }
3696
3697 LogFlowThisFunc(("Leaving rc=%#x\n", rc));
3698 return rc;
3699}
3700
3701/**
3702 * Called by IInternalSessionControl::OnVRDPServerChange().
3703 *
3704 * @note Locks this object for writing.
3705 */
3706HRESULT Console::onVRDPServerChange()
3707{
3708 AutoCaller autoCaller(this);
3709 AssertComRCReturnRC(autoCaller.rc());
3710
3711 AutoWriteLock alock(this);
3712
3713 HRESULT rc = S_OK;
3714
3715 if (mVRDPServer && mMachineState == MachineState_Running)
3716 {
3717 BOOL vrdpEnabled = FALSE;
3718
3719 rc = mVRDPServer->COMGETTER(Enabled) (&vrdpEnabled);
3720 ComAssertComRCRetRC (rc);
3721
3722 /* VRDP server may call this Console object back from other threads (VRDP INPUT or OUTPUT). */
3723 alock.leave();
3724
3725 if (vrdpEnabled)
3726 {
3727 // If there was no VRDP server started the 'stop' will do nothing.
3728 // However if a server was started and this notification was called,
3729 // we have to restart the server.
3730 mConsoleVRDPServer->Stop ();
3731
3732 if (RT_FAILURE(mConsoleVRDPServer->Launch ()))
3733 {
3734 rc = E_FAIL;
3735 }
3736 else
3737 {
3738 mConsoleVRDPServer->EnableConnections ();
3739 }
3740 }
3741 else
3742 {
3743 mConsoleVRDPServer->Stop ();
3744 }
3745
3746 alock.enter();
3747 }
3748
3749 /* notify console callbacks on success */
3750 if (SUCCEEDED(rc))
3751 {
3752 CallbackList::iterator it = mCallbacks.begin();
3753 while (it != mCallbacks.end())
3754 (*it++)->OnVRDPServerChange();
3755 }
3756
3757 return rc;
3758}
3759
3760/**
3761 * Called by IInternalSessionControl::OnUSBControllerChange().
3762 *
3763 * @note Locks this object for writing.
3764 */
3765HRESULT Console::onUSBControllerChange()
3766{
3767 LogFlowThisFunc(("\n"));
3768
3769 AutoCaller autoCaller(this);
3770 AssertComRCReturnRC(autoCaller.rc());
3771
3772 AutoWriteLock alock(this);
3773
3774 /* Ignore if no VM is running yet. */
3775 if (!mpVM)
3776 return S_OK;
3777
3778 HRESULT rc = S_OK;
3779
3780/// @todo (dmik)
3781// check for the Enabled state and disable virtual USB controller??
3782// Anyway, if we want to query the machine's USB Controller we need to cache
3783// it to mUSBController in #init() (as it is done with mDVDDrive).
3784//
3785// bird: While the VM supports hot-plugging, I doubt any guest can handle it at this time... :-)
3786//
3787// /* protect mpVM */
3788// AutoVMCaller autoVMCaller (this);
3789// CheckComRCReturnRC(autoVMCaller.rc());
3790
3791 /* notify console callbacks on success */
3792 if (SUCCEEDED(rc))
3793 {
3794 CallbackList::iterator it = mCallbacks.begin();
3795 while (it != mCallbacks.end())
3796 (*it++)->OnUSBControllerChange();
3797 }
3798
3799 return rc;
3800}
3801
3802/**
3803 * Called by IInternalSessionControl::OnSharedFolderChange().
3804 *
3805 * @note Locks this object for writing.
3806 */
3807HRESULT Console::onSharedFolderChange (BOOL aGlobal)
3808{
3809 LogFlowThisFunc(("aGlobal=%RTbool\n", aGlobal));
3810
3811 AutoCaller autoCaller(this);
3812 AssertComRCReturnRC(autoCaller.rc());
3813
3814 AutoWriteLock alock(this);
3815
3816 HRESULT rc = fetchSharedFolders (aGlobal);
3817
3818 /* notify console callbacks on success */
3819 if (SUCCEEDED(rc))
3820 {
3821 CallbackList::iterator it = mCallbacks.begin();
3822 while (it != mCallbacks.end())
3823 (*it++)->OnSharedFolderChange (aGlobal ? (Scope_T) Scope_Global
3824 : (Scope_T) Scope_Machine);
3825 }
3826
3827 return rc;
3828}
3829
3830/**
3831 * Called by IInternalSessionControl::OnUSBDeviceAttach() or locally by
3832 * processRemoteUSBDevices() after IInternalMachineControl::RunUSBDeviceFilters()
3833 * returns TRUE for a given remote USB device.
3834 *
3835 * @return S_OK if the device was attached to the VM.
3836 * @return failure if not attached.
3837 *
3838 * @param aDevice
3839 * The device in question.
3840 * @param aMaskedIfs
3841 * The interfaces to hide from the guest.
3842 *
3843 * @note Locks this object for writing.
3844 */
3845HRESULT Console::onUSBDeviceAttach (IUSBDevice *aDevice, IVirtualBoxErrorInfo *aError, ULONG aMaskedIfs)
3846{
3847#ifdef VBOX_WITH_USB
3848 LogFlowThisFunc(("aDevice=%p aError=%p\n", aDevice, aError));
3849
3850 AutoCaller autoCaller(this);
3851 ComAssertComRCRetRC (autoCaller.rc());
3852
3853 AutoWriteLock alock(this);
3854
3855 /* protect mpVM (we don't need error info, since it's a callback) */
3856 AutoVMCallerQuiet autoVMCaller (this);
3857 if (FAILED (autoVMCaller.rc()))
3858 {
3859 /* The VM may be no more operational when this message arrives
3860 * (e.g. it may be Saving or Stopping or just PoweredOff) --
3861 * autoVMCaller.rc() will return a failure in this case. */
3862 LogFlowThisFunc(("Attach request ignored (mMachineState=%d).\n",
3863 mMachineState));
3864 return autoVMCaller.rc();
3865 }
3866
3867 if (aError != NULL)
3868 {
3869 /* notify callbacks about the error */
3870 onUSBDeviceStateChange (aDevice, true /* aAttached */, aError);
3871 return S_OK;
3872 }
3873
3874 /* Don't proceed unless there's at least one USB hub. */
3875 if (!PDMR3USBHasHub (mpVM))
3876 {
3877 LogFlowThisFunc(("Attach request ignored (no USB controller).\n"));
3878 return E_FAIL;
3879 }
3880
3881 HRESULT rc = attachUSBDevice (aDevice, aMaskedIfs);
3882 if (FAILED (rc))
3883 {
3884 /* take the current error info */
3885 com::ErrorInfoKeeper eik;
3886 /* the error must be a VirtualBoxErrorInfo instance */
3887 ComPtr<IVirtualBoxErrorInfo> error = eik.takeError();
3888 Assert (!error.isNull());
3889 if (!error.isNull())
3890 {
3891 /* notify callbacks about the error */
3892 onUSBDeviceStateChange (aDevice, true /* aAttached */, error);
3893 }
3894 }
3895
3896 return rc;
3897
3898#else /* !VBOX_WITH_USB */
3899 return E_FAIL;
3900#endif /* !VBOX_WITH_USB */
3901}
3902
3903/**
3904 * Called by IInternalSessionControl::OnUSBDeviceDetach() and locally by
3905 * processRemoteUSBDevices().
3906 *
3907 * @note Locks this object for writing.
3908 */
3909HRESULT Console::onUSBDeviceDetach (IN_BSTR aId,
3910 IVirtualBoxErrorInfo *aError)
3911{
3912#ifdef VBOX_WITH_USB
3913 Guid Uuid (aId);
3914 LogFlowThisFunc(("aId={%RTuuid} aError=%p\n", Uuid.raw(), aError));
3915
3916 AutoCaller autoCaller(this);
3917 AssertComRCReturnRC(autoCaller.rc());
3918
3919 AutoWriteLock alock(this);
3920
3921 /* Find the device. */
3922 ComObjPtr<OUSBDevice> device;
3923 USBDeviceList::iterator it = mUSBDevices.begin();
3924 while (it != mUSBDevices.end())
3925 {
3926 LogFlowThisFunc(("it={%RTuuid}\n", (*it)->id().raw()));
3927 if ((*it)->id() == Uuid)
3928 {
3929 device = *it;
3930 break;
3931 }
3932 ++ it;
3933 }
3934
3935
3936 if (device.isNull())
3937 {
3938 LogFlowThisFunc(("USB device not found.\n"));
3939
3940 /* The VM may be no more operational when this message arrives
3941 * (e.g. it may be Saving or Stopping or just PoweredOff). Use
3942 * AutoVMCaller to detect it -- AutoVMCaller::rc() will return a
3943 * failure in this case. */
3944
3945 AutoVMCallerQuiet autoVMCaller (this);
3946 if (FAILED (autoVMCaller.rc()))
3947 {
3948 LogFlowThisFunc(("Detach request ignored (mMachineState=%d).\n",
3949 mMachineState));
3950 return autoVMCaller.rc();
3951 }
3952
3953 /* the device must be in the list otherwise */
3954 AssertFailedReturn (E_FAIL);
3955 }
3956
3957 if (aError != NULL)
3958 {
3959 /* notify callback about an error */
3960 onUSBDeviceStateChange (device, false /* aAttached */, aError);
3961 return S_OK;
3962 }
3963
3964 HRESULT rc = detachUSBDevice (it);
3965
3966 if (FAILED (rc))
3967 {
3968 /* take the current error info */
3969 com::ErrorInfoKeeper eik;
3970 /* the error must be a VirtualBoxErrorInfo instance */
3971 ComPtr<IVirtualBoxErrorInfo> error = eik.takeError();
3972 Assert (!error.isNull());
3973 if (!error.isNull())
3974 {
3975 /* notify callbacks about the error */
3976 onUSBDeviceStateChange (device, false /* aAttached */, error);
3977 }
3978 }
3979
3980 return rc;
3981
3982#else /* !VBOX_WITH_USB */
3983 return E_FAIL;
3984#endif /* !VBOX_WITH_USB */
3985}
3986
3987/**
3988 * @note Temporarily locks this object for writing.
3989 */
3990HRESULT Console::getGuestProperty (IN_BSTR aName, BSTR *aValue,
3991 ULONG64 *aTimestamp, BSTR *aFlags)
3992{
3993#if !defined (VBOX_WITH_GUEST_PROPS)
3994 ReturnComNotImplemented();
3995#else
3996 if (!VALID_PTR (aName))
3997 return E_INVALIDARG;
3998 if (!VALID_PTR (aValue))
3999 return E_POINTER;
4000 if ((aTimestamp != NULL) && !VALID_PTR (aTimestamp))
4001 return E_POINTER;
4002 if ((aFlags != NULL) && !VALID_PTR (aFlags))
4003 return E_POINTER;
4004
4005 AutoCaller autoCaller(this);
4006 AssertComRCReturnRC(autoCaller.rc());
4007
4008 /* protect mpVM (if not NULL) */
4009 AutoVMCallerWeak autoVMCaller (this);
4010 CheckComRCReturnRC(autoVMCaller.rc());
4011
4012 /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
4013 * autoVMCaller, so there is no need to hold a lock of this */
4014
4015 HRESULT rc = E_UNEXPECTED;
4016 using namespace guestProp;
4017
4018 try
4019 {
4020 VBOXHGCMSVCPARM parm[4];
4021 Utf8Str Utf8Name = aName;
4022 char pszBuffer[MAX_VALUE_LEN + MAX_FLAGS_LEN];
4023
4024 parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
4025 parm[0].u.pointer.addr = (void*)Utf8Name.c_str();
4026 /* The + 1 is the null terminator */
4027 parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
4028 parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
4029 parm[1].u.pointer.addr = pszBuffer;
4030 parm[1].u.pointer.size = sizeof(pszBuffer);
4031 int vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", GET_PROP_HOST,
4032 4, &parm[0]);
4033 /* The returned string should never be able to be greater than our buffer */
4034 AssertLogRel (vrc != VERR_BUFFER_OVERFLOW);
4035 AssertLogRel (RT_FAILURE(vrc) || VBOX_HGCM_SVC_PARM_64BIT == parm[2].type);
4036 if (RT_SUCCESS(vrc) || (VERR_NOT_FOUND == vrc))
4037 {
4038 rc = S_OK;
4039 if (vrc != VERR_NOT_FOUND)
4040 {
4041 Utf8Str strBuffer(pszBuffer);
4042 strBuffer.cloneTo(aValue);
4043
4044 *aTimestamp = parm[2].u.uint64;
4045
4046 size_t iFlags = strBuffer.length() + 1;
4047 Utf8Str(pszBuffer + iFlags).cloneTo(aFlags);
4048 }
4049 else
4050 aValue = NULL;
4051 }
4052 else
4053 rc = setError (E_UNEXPECTED,
4054 tr ("The service call failed with the error %Rrc"), vrc);
4055 }
4056 catch(std::bad_alloc & /*e*/)
4057 {
4058 rc = E_OUTOFMEMORY;
4059 }
4060 return rc;
4061#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
4062}
4063
4064/**
4065 * @note Temporarily locks this object for writing.
4066 */
4067HRESULT Console::setGuestProperty (IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
4068{
4069#if !defined (VBOX_WITH_GUEST_PROPS)
4070 ReturnComNotImplemented();
4071#else
4072 if (!VALID_PTR (aName))
4073 return E_INVALIDARG;
4074 if ((aValue != NULL) && !VALID_PTR (aValue))
4075 return E_INVALIDARG;
4076 if ((aFlags != NULL) && !VALID_PTR (aFlags))
4077 return E_INVALIDARG;
4078
4079 AutoCaller autoCaller(this);
4080 AssertComRCReturnRC(autoCaller.rc());
4081
4082 /* protect mpVM (if not NULL) */
4083 AutoVMCallerWeak autoVMCaller (this);
4084 CheckComRCReturnRC(autoVMCaller.rc());
4085
4086 /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
4087 * autoVMCaller, so there is no need to hold a lock of this */
4088
4089 HRESULT rc = E_UNEXPECTED;
4090 using namespace guestProp;
4091
4092 VBOXHGCMSVCPARM parm[3];
4093 Utf8Str Utf8Name = aName;
4094 int vrc = VINF_SUCCESS;
4095
4096 parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
4097 parm[0].u.pointer.addr = (void*)Utf8Name.c_str();
4098 /* The + 1 is the null terminator */
4099 parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
4100 Utf8Str Utf8Value = aValue;
4101 if (aValue != NULL)
4102 {
4103 parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
4104 parm[1].u.pointer.addr = (void*)Utf8Value.c_str();
4105 /* The + 1 is the null terminator */
4106 parm[1].u.pointer.size = (uint32_t)Utf8Value.length() + 1;
4107 }
4108 Utf8Str Utf8Flags = aFlags;
4109 if (aFlags != NULL)
4110 {
4111 parm[2].type = VBOX_HGCM_SVC_PARM_PTR;
4112 parm[2].u.pointer.addr = (void*)Utf8Flags.c_str();
4113 /* The + 1 is the null terminator */
4114 parm[2].u.pointer.size = (uint32_t)Utf8Flags.length() + 1;
4115 }
4116 if ((aValue != NULL) && (aFlags != NULL))
4117 vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", SET_PROP_HOST,
4118 3, &parm[0]);
4119 else if (aValue != NULL)
4120 vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", SET_PROP_VALUE_HOST,
4121 2, &parm[0]);
4122 else
4123 vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", DEL_PROP_HOST,
4124 1, &parm[0]);
4125 if (RT_SUCCESS(vrc))
4126 rc = S_OK;
4127 else
4128 rc = setError (E_UNEXPECTED,
4129 tr ("The service call failed with the error %Rrc"), vrc);
4130 return rc;
4131#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
4132}
4133
4134
4135/**
4136 * @note Temporarily locks this object for writing.
4137 */
4138HRESULT Console::enumerateGuestProperties (IN_BSTR aPatterns,
4139 ComSafeArrayOut(BSTR, aNames),
4140 ComSafeArrayOut(BSTR, aValues),
4141 ComSafeArrayOut(ULONG64, aTimestamps),
4142 ComSafeArrayOut(BSTR, aFlags))
4143{
4144#if !defined (VBOX_WITH_GUEST_PROPS)
4145 ReturnComNotImplemented();
4146#else
4147 if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
4148 return E_POINTER;
4149 if (ComSafeArrayOutIsNull(aNames))
4150 return E_POINTER;
4151 if (ComSafeArrayOutIsNull(aValues))
4152 return E_POINTER;
4153 if (ComSafeArrayOutIsNull(aTimestamps))
4154 return E_POINTER;
4155 if (ComSafeArrayOutIsNull(aFlags))
4156 return E_POINTER;
4157
4158 AutoCaller autoCaller(this);
4159 AssertComRCReturnRC(autoCaller.rc());
4160
4161 /* protect mpVM (if not NULL) */
4162 AutoVMCallerWeak autoVMCaller (this);
4163 CheckComRCReturnRC(autoVMCaller.rc());
4164
4165 /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
4166 * autoVMCaller, so there is no need to hold a lock of this */
4167
4168 return doEnumerateGuestProperties (aPatterns, ComSafeArrayOutArg(aNames),
4169 ComSafeArrayOutArg(aValues),
4170 ComSafeArrayOutArg(aTimestamps),
4171 ComSafeArrayOutArg(aFlags));
4172#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
4173}
4174
4175/**
4176 * Gets called by Session::UpdateMachineState()
4177 * (IInternalSessionControl::updateMachineState()).
4178 *
4179 * Must be called only in certain cases (see the implementation).
4180 *
4181 * @note Locks this object for writing.
4182 */
4183HRESULT Console::updateMachineState (MachineState_T aMachineState)
4184{
4185 AutoCaller autoCaller(this);
4186 AssertComRCReturnRC(autoCaller.rc());
4187
4188 AutoWriteLock alock(this);
4189
4190 AssertReturn(mMachineState == MachineState_Saving ||
4191 mMachineState == MachineState_Discarding,
4192 E_FAIL);
4193
4194 return setMachineStateLocally (aMachineState);
4195}
4196
4197/**
4198 * @note Locks this object for writing.
4199 */
4200void Console::onMousePointerShapeChange(bool fVisible, bool fAlpha,
4201 uint32_t xHot, uint32_t yHot,
4202 uint32_t width, uint32_t height,
4203 void *pShape)
4204{
4205#if 0
4206 LogFlowThisFuncEnter();
4207 LogFlowThisFunc(("fVisible=%d, fAlpha=%d, xHot = %d, yHot = %d, width=%d, "
4208 "height=%d, shape=%p\n",
4209 fVisible, fAlpha, xHot, yHot, width, height, pShape));
4210#endif
4211
4212 AutoCaller autoCaller(this);
4213 AssertComRCReturnVoid (autoCaller.rc());
4214
4215 /* We need a write lock because we alter the cached callback data */
4216 AutoWriteLock alock(this);
4217
4218 /* Save the callback arguments */
4219 mCallbackData.mpsc.visible = fVisible;
4220 mCallbackData.mpsc.alpha = fAlpha;
4221 mCallbackData.mpsc.xHot = xHot;
4222 mCallbackData.mpsc.yHot = yHot;
4223 mCallbackData.mpsc.width = width;
4224 mCallbackData.mpsc.height = height;
4225
4226 /* start with not valid */
4227 bool wasValid = mCallbackData.mpsc.valid;
4228 mCallbackData.mpsc.valid = false;
4229
4230 if (pShape != NULL)
4231 {
4232 size_t cb = (width + 7) / 8 * height; /* size of the AND mask */
4233 cb = ((cb + 3) & ~3) + width * 4 * height; /* + gap + size of the XOR mask */
4234 /* try to reuse the old shape buffer if the size is the same */
4235 if (!wasValid)
4236 mCallbackData.mpsc.shape = NULL;
4237 else
4238 if (mCallbackData.mpsc.shape != NULL && mCallbackData.mpsc.shapeSize != cb)
4239 {
4240 RTMemFree (mCallbackData.mpsc.shape);
4241 mCallbackData.mpsc.shape = NULL;
4242 }
4243 if (mCallbackData.mpsc.shape == NULL)
4244 {
4245 mCallbackData.mpsc.shape = (BYTE *) RTMemAllocZ (cb);
4246 AssertReturnVoid (mCallbackData.mpsc.shape);
4247 }
4248 mCallbackData.mpsc.shapeSize = cb;
4249 memcpy (mCallbackData.mpsc.shape, pShape, cb);
4250 }
4251 else
4252 {
4253 if (wasValid && mCallbackData.mpsc.shape != NULL)
4254 RTMemFree (mCallbackData.mpsc.shape);
4255 mCallbackData.mpsc.shape = NULL;
4256 mCallbackData.mpsc.shapeSize = 0;
4257 }
4258
4259 mCallbackData.mpsc.valid = true;
4260
4261 CallbackList::iterator it = mCallbacks.begin();
4262 while (it != mCallbacks.end())
4263 (*it++)->OnMousePointerShapeChange (fVisible, fAlpha, xHot, yHot,
4264 width, height, (BYTE *) pShape);
4265
4266#if 0
4267 LogFlowThisFuncLeave();
4268#endif
4269}
4270
4271/**
4272 * @note Locks this object for writing.
4273 */
4274void Console::onMouseCapabilityChange (BOOL supportsAbsolute, BOOL needsHostCursor)
4275{
4276 LogFlowThisFunc(("supportsAbsolute=%d needsHostCursor=%d\n",
4277 supportsAbsolute, needsHostCursor));
4278
4279 AutoCaller autoCaller(this);
4280 AssertComRCReturnVoid (autoCaller.rc());
4281
4282 /* We need a write lock because we alter the cached callback data */
4283 AutoWriteLock alock(this);
4284
4285 /* save the callback arguments */
4286 mCallbackData.mcc.supportsAbsolute = supportsAbsolute;
4287 mCallbackData.mcc.needsHostCursor = needsHostCursor;
4288 mCallbackData.mcc.valid = true;
4289
4290 CallbackList::iterator it = mCallbacks.begin();
4291 while (it != mCallbacks.end())
4292 {
4293 Log2(("Console::onMouseCapabilityChange: calling %p\n", (void*)*it));
4294 (*it++)->OnMouseCapabilityChange (supportsAbsolute, needsHostCursor);
4295 }
4296}
4297
4298/**
4299 * @note Locks this object for reading.
4300 */
4301void Console::onStateChange (MachineState_T machineState)
4302{
4303 AutoCaller autoCaller(this);
4304 AssertComRCReturnVoid (autoCaller.rc());
4305
4306 AutoReadLock alock(this);
4307
4308 CallbackList::iterator it = mCallbacks.begin();
4309 while (it != mCallbacks.end())
4310 (*it++)->OnStateChange (machineState);
4311}
4312
4313/**
4314 * @note Locks this object for reading.
4315 */
4316void Console::onAdditionsStateChange()
4317{
4318 AutoCaller autoCaller(this);
4319 AssertComRCReturnVoid (autoCaller.rc());
4320
4321 AutoReadLock alock(this);
4322
4323 CallbackList::iterator it = mCallbacks.begin();
4324 while (it != mCallbacks.end())
4325 (*it++)->OnAdditionsStateChange();
4326}
4327
4328/**
4329 * @note Locks this object for reading.
4330 */
4331void Console::onAdditionsOutdated()
4332{
4333 AutoCaller autoCaller(this);
4334 AssertComRCReturnVoid (autoCaller.rc());
4335
4336 AutoReadLock alock(this);
4337
4338 /** @todo Use the On-Screen Display feature to report the fact.
4339 * The user should be told to install additions that are
4340 * provided with the current VBox build:
4341 * VBOX_VERSION_MAJOR.VBOX_VERSION_MINOR.VBOX_VERSION_BUILD
4342 */
4343}
4344
4345/**
4346 * @note Locks this object for writing.
4347 */
4348void Console::onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock)
4349{
4350 AutoCaller autoCaller(this);
4351 AssertComRCReturnVoid (autoCaller.rc());
4352
4353 /* We need a write lock because we alter the cached callback data */
4354 AutoWriteLock alock(this);
4355
4356 /* save the callback arguments */
4357 mCallbackData.klc.numLock = fNumLock;
4358 mCallbackData.klc.capsLock = fCapsLock;
4359 mCallbackData.klc.scrollLock = fScrollLock;
4360 mCallbackData.klc.valid = true;
4361
4362 CallbackList::iterator it = mCallbacks.begin();
4363 while (it != mCallbacks.end())
4364 (*it++)->OnKeyboardLedsChange(fNumLock, fCapsLock, fScrollLock);
4365}
4366
4367/**
4368 * @note Locks this object for reading.
4369 */
4370void Console::onUSBDeviceStateChange (IUSBDevice *aDevice, bool aAttached,
4371 IVirtualBoxErrorInfo *aError)
4372{
4373 AutoCaller autoCaller(this);
4374 AssertComRCReturnVoid (autoCaller.rc());
4375
4376 AutoReadLock alock(this);
4377
4378 CallbackList::iterator it = mCallbacks.begin();
4379 while (it != mCallbacks.end())
4380 (*it++)->OnUSBDeviceStateChange (aDevice, aAttached, aError);
4381}
4382
4383/**
4384 * @note Locks this object for reading.
4385 */
4386void Console::onRuntimeError (BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage)
4387{
4388 AutoCaller autoCaller(this);
4389 AssertComRCReturnVoid (autoCaller.rc());
4390
4391 AutoReadLock alock(this);
4392
4393 CallbackList::iterator it = mCallbacks.begin();
4394 while (it != mCallbacks.end())
4395 (*it++)->OnRuntimeError (aFatal, aErrorID, aMessage);
4396}
4397
4398/**
4399 * @note Locks this object for reading.
4400 */
4401HRESULT Console::onShowWindow (BOOL aCheck, BOOL *aCanShow, ULONG64 *aWinId)
4402{
4403 AssertReturn(aCanShow, E_POINTER);
4404 AssertReturn(aWinId, E_POINTER);
4405
4406 *aCanShow = FALSE;
4407 *aWinId = 0;
4408
4409 AutoCaller autoCaller(this);
4410 AssertComRCReturnRC(autoCaller.rc());
4411
4412 AutoReadLock alock(this);
4413
4414 HRESULT rc = S_OK;
4415 CallbackList::iterator it = mCallbacks.begin();
4416
4417 if (aCheck)
4418 {
4419 while (it != mCallbacks.end())
4420 {
4421 BOOL canShow = FALSE;
4422 rc = (*it++)->OnCanShowWindow (&canShow);
4423 AssertComRC (rc);
4424 if (FAILED (rc) || !canShow)
4425 return rc;
4426 }
4427 *aCanShow = TRUE;
4428 }
4429 else
4430 {
4431 while (it != mCallbacks.end())
4432 {
4433 ULONG64 winId = 0;
4434 rc = (*it++)->OnShowWindow (&winId);
4435 AssertComRC (rc);
4436 if (FAILED (rc))
4437 return rc;
4438 /* only one callback may return non-null winId */
4439 Assert (*aWinId == 0 || winId == 0);
4440 if (*aWinId == 0)
4441 *aWinId = winId;
4442 }
4443 }
4444
4445 return S_OK;
4446}
4447
4448// private methods
4449////////////////////////////////////////////////////////////////////////////////
4450
4451/**
4452 * Increases the usage counter of the mpVM pointer. Guarantees that
4453 * VMR3Destroy() will not be called on it at least until releaseVMCaller()
4454 * is called.
4455 *
4456 * If this method returns a failure, the caller is not allowed to use mpVM
4457 * and may return the failed result code to the upper level. This method sets
4458 * the extended error info on failure if \a aQuiet is false.
4459 *
4460 * Setting \a aQuiet to true is useful for methods that don't want to return
4461 * the failed result code to the caller when this method fails (e.g. need to
4462 * silently check for the mpVM availability).
4463 *
4464 * When mpVM is NULL but \a aAllowNullVM is true, a corresponding error will be
4465 * returned instead of asserting. Having it false is intended as a sanity check
4466 * for methods that have checked mMachineState and expect mpVM *NOT* to be NULL.
4467 *
4468 * @param aQuiet true to suppress setting error info
4469 * @param aAllowNullVM true to accept mpVM being NULL and return a failure
4470 * (otherwise this method will assert if mpVM is NULL)
4471 *
4472 * @note Locks this object for writing.
4473 */
4474HRESULT Console::addVMCaller (bool aQuiet /* = false */,
4475 bool aAllowNullVM /* = false */)
4476{
4477 AutoCaller autoCaller (this);
4478 AssertComRCReturnRC(autoCaller.rc());
4479
4480 AutoWriteLock alock(this);
4481
4482 if (mVMDestroying)
4483 {
4484 /* powerDown() is waiting for all callers to finish */
4485 return aQuiet ? E_ACCESSDENIED : setError (E_ACCESSDENIED,
4486 tr ("Virtual machine is being powered down"));
4487 }
4488
4489 if (mpVM == NULL)
4490 {
4491 Assert (aAllowNullVM == true);
4492
4493 /* The machine is not powered up */
4494 return aQuiet ? E_ACCESSDENIED : setError (E_ACCESSDENIED,
4495 tr ("Virtual machine is not powered up"));
4496 }
4497
4498 ++ mVMCallers;
4499
4500 return S_OK;
4501}
4502
4503/**
4504 * Decreases the usage counter of the mpVM pointer. Must always complete
4505 * the addVMCaller() call after the mpVM pointer is no more necessary.
4506 *
4507 * @note Locks this object for writing.
4508 */
4509void Console::releaseVMCaller()
4510{
4511 AutoCaller autoCaller (this);
4512 AssertComRCReturnVoid (autoCaller.rc());
4513
4514 AutoWriteLock alock(this);
4515
4516 AssertReturnVoid (mpVM != NULL);
4517
4518 Assert (mVMCallers > 0);
4519 -- mVMCallers;
4520
4521 if (mVMCallers == 0 && mVMDestroying)
4522 {
4523 /* inform powerDown() there are no more callers */
4524 RTSemEventSignal (mVMZeroCallersSem);
4525 }
4526}
4527
4528/**
4529 * Initialize the release logging facility. In case something
4530 * goes wrong, there will be no release logging. Maybe in the future
4531 * we can add some logic to use different file names in this case.
4532 * Note that the logic must be in sync with Machine::DeleteSettings().
4533 */
4534HRESULT Console::consoleInitReleaseLog (const ComPtr<IMachine> aMachine)
4535{
4536 HRESULT hrc = S_OK;
4537
4538 Bstr logFolder;
4539 hrc = aMachine->COMGETTER(LogFolder) (logFolder.asOutParam());
4540 CheckComRCReturnRC(hrc);
4541
4542 Utf8Str logDir = logFolder;
4543
4544 /* make sure the Logs folder exists */
4545 Assert(logDir.length());
4546 if (!RTDirExists(logDir.c_str()))
4547 RTDirCreateFullPath(logDir.c_str(), 0777);
4548
4549 Utf8Str logFile = Utf8StrFmt("%s%cVBox.log",
4550 logDir.raw(), RTPATH_DELIMITER);
4551 Utf8Str pngFile = Utf8StrFmt("%s%cVBox.png",
4552 logDir.raw(), RTPATH_DELIMITER);
4553
4554 /*
4555 * Age the old log files
4556 * Rename .(n-1) to .(n), .(n-2) to .(n-1), ..., and the last log file to .1
4557 * Overwrite target files in case they exist.
4558 */
4559 ComPtr<IVirtualBox> virtualBox;
4560 aMachine->COMGETTER(Parent)(virtualBox.asOutParam());
4561 ComPtr<ISystemProperties> systemProperties;
4562 virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
4563 ULONG uLogHistoryCount = 3;
4564 systemProperties->COMGETTER(LogHistoryCount)(&uLogHistoryCount);
4565 ComPtr<IHost> host;
4566 virtualBox->COMGETTER(Host)(host.asOutParam());
4567 ULONG uHostRamMb = 0, uHostRamAvailMb = 0;
4568 host->COMGETTER(MemorySize)(&uHostRamMb);
4569 host->COMGETTER(MemoryAvailable)(&uHostRamAvailMb);
4570 if (uLogHistoryCount)
4571 {
4572 for (int i = uLogHistoryCount-1; i >= 0; i--)
4573 {
4574 Utf8Str *files[] = { &logFile, &pngFile };
4575 Utf8Str oldName, newName;
4576
4577 for (unsigned int j = 0; j < RT_ELEMENTS (files); ++ j)
4578 {
4579 if (i > 0)
4580 oldName = Utf8StrFmt ("%s.%d", files [j]->raw(), i);
4581 else
4582 oldName = *files [j];
4583 newName = Utf8StrFmt ("%s.%d", files [j]->raw(), i + 1);
4584 /* If the old file doesn't exist, delete the new file (if it
4585 * exists) to provide correct rotation even if the sequence is
4586 * broken */
4587 if ( RTFileRename(oldName.c_str(), newName.c_str(), RTFILEMOVE_FLAGS_REPLACE)
4588 == VERR_FILE_NOT_FOUND)
4589 RTFileDelete(newName.c_str());
4590 }
4591 }
4592 }
4593
4594 PRTLOGGER loggerRelease;
4595 static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
4596 RTUINT fFlags = RTLOGFLAGS_PREFIX_TIME_PROG;
4597#if defined (RT_OS_WINDOWS) || defined (RT_OS_OS2)
4598 fFlags |= RTLOGFLAGS_USECRLF;
4599#endif
4600 char szError[RTPATH_MAX + 128] = "";
4601 int vrc = RTLogCreateEx(&loggerRelease, fFlags, "all",
4602 "VBOX_RELEASE_LOG", RT_ELEMENTS(s_apszGroups), s_apszGroups,
4603 RTLOGDEST_FILE, szError, sizeof(szError), logFile.raw());
4604 if (RT_SUCCESS(vrc))
4605 {
4606 /* some introductory information */
4607 RTTIMESPEC timeSpec;
4608 char szTmp[256];
4609 RTTimeSpecToString(RTTimeNow(&timeSpec), szTmp, sizeof(szTmp));
4610 RTLogRelLogger(loggerRelease, 0, ~0U,
4611 "VirtualBox %s r%u %s (%s %s) release log\n"
4612#ifdef VBOX_BLEEDING_EDGE
4613 "EXPERIMENTAL build " VBOX_BLEEDING_EDGE "\n"
4614#endif
4615 "Log opened %s\n",
4616 VBOX_VERSION_STRING, RTBldCfgRevision(), VBOX_BUILD_TARGET,
4617 __DATE__, __TIME__, szTmp);
4618
4619 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szTmp, sizeof(szTmp));
4620 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4621 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Product: %s\n", szTmp);
4622 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szTmp, sizeof(szTmp));
4623 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4624 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Release: %s\n", szTmp);
4625 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szTmp, sizeof(szTmp));
4626 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4627 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Version: %s\n", szTmp);
4628 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_SERVICE_PACK, szTmp, sizeof(szTmp));
4629 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4630 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Service Pack: %s\n", szTmp);
4631 RTLogRelLogger(loggerRelease, 0, ~0U, "Host RAM: %uMB RAM, available: %uMB\n",
4632 uHostRamMb, uHostRamAvailMb);
4633 /* the package type is interesting for Linux distributions */
4634 char szExecName[RTPATH_MAX];
4635 char *pszExecName = RTProcGetExecutableName(szExecName, sizeof(szExecName));
4636 RTLogRelLogger(loggerRelease, 0, ~0U,
4637 "Executable: %s\n"
4638 "Process ID: %u\n"
4639 "Package type: %s"
4640#ifdef VBOX_OSE
4641 " (OSE)"
4642#endif
4643 "\n",
4644 pszExecName ? pszExecName : "unknown",
4645 RTProcSelf(),
4646 VBOX_PACKAGE_STRING);
4647
4648 /* register this logger as the release logger */
4649 RTLogRelSetDefaultInstance(loggerRelease);
4650 hrc = S_OK;
4651 }
4652 else
4653 hrc = setError (E_FAIL,
4654 tr ("Failed to open release log (%s, %Rrc)"), szError, vrc);
4655
4656 return hrc;
4657}
4658
4659/**
4660 * Common worker for PowerUp and PowerUpPaused.
4661 *
4662 * @returns COM status code.
4663 *
4664 * @param aProgress Where to return the progress object.
4665 * @param aPaused true if PowerUpPaused called.
4666 *
4667 * @todo move down to powerDown();
4668 */
4669HRESULT Console::powerUp (IProgress **aProgress, bool aPaused)
4670{
4671 if (aProgress == NULL)
4672 return E_POINTER;
4673
4674 LogFlowThisFuncEnter();
4675 LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
4676
4677 AutoCaller autoCaller(this);
4678 CheckComRCReturnRC(autoCaller.rc());
4679
4680 AutoWriteLock alock(this);
4681
4682 if (Global::IsOnlineOrTransient (mMachineState))
4683 return setError(VBOX_E_INVALID_VM_STATE,
4684 tr ("Virtual machine is already running or busy "
4685 "(machine state: %d)"), mMachineState);
4686
4687 HRESULT rc = S_OK;
4688
4689 /* the network cards will undergo a quick consistency check */
4690 for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
4691 {
4692 ComPtr<INetworkAdapter> adapter;
4693 mMachine->GetNetworkAdapter (slot, adapter.asOutParam());
4694 BOOL enabled = FALSE;
4695 adapter->COMGETTER(Enabled) (&enabled);
4696 if (!enabled)
4697 continue;
4698
4699 NetworkAttachmentType_T netattach;
4700 adapter->COMGETTER(AttachmentType)(&netattach);
4701 switch (netattach)
4702 {
4703 case NetworkAttachmentType_Bridged:
4704 {
4705#ifdef RT_OS_WINDOWS
4706 /* a valid host interface must have been set */
4707 Bstr hostif;
4708 adapter->COMGETTER(HostInterface)(hostif.asOutParam());
4709 if (!hostif)
4710 {
4711 return setError (VBOX_E_HOST_ERROR,
4712 tr ("VM cannot start because host interface networking "
4713 "requires a host interface name to be set"));
4714 }
4715 ComPtr<IVirtualBox> virtualBox;
4716 mMachine->COMGETTER(Parent)(virtualBox.asOutParam());
4717 ComPtr<IHost> host;
4718 virtualBox->COMGETTER(Host)(host.asOutParam());
4719 ComPtr<IHostNetworkInterface> hostInterface;
4720 if (!SUCCEEDED(host->FindHostNetworkInterfaceByName(hostif, hostInterface.asOutParam())))
4721 {
4722 return setError (VBOX_E_HOST_ERROR,
4723 tr ("VM cannot start because the host interface '%ls' "
4724 "does not exist"),
4725 hostif.raw());
4726 }
4727#endif /* RT_OS_WINDOWS */
4728 break;
4729 }
4730 default:
4731 break;
4732 }
4733 }
4734
4735 /* Read console data stored in the saved state file (if not yet done) */
4736 rc = loadDataFromSavedState();
4737 CheckComRCReturnRC(rc);
4738
4739 /* Check all types of shared folders and compose a single list */
4740 SharedFolderDataMap sharedFolders;
4741 {
4742 /* first, insert global folders */
4743 for (SharedFolderDataMap::const_iterator it = mGlobalSharedFolders.begin();
4744 it != mGlobalSharedFolders.end(); ++ it)
4745 sharedFolders [it->first] = it->second;
4746
4747 /* second, insert machine folders */
4748 for (SharedFolderDataMap::const_iterator it = mMachineSharedFolders.begin();
4749 it != mMachineSharedFolders.end(); ++ it)
4750 sharedFolders [it->first] = it->second;
4751
4752 /* third, insert console folders */
4753 for (SharedFolderMap::const_iterator it = mSharedFolders.begin();
4754 it != mSharedFolders.end(); ++ it)
4755 sharedFolders [it->first] = SharedFolderData(it->second->hostPath(), it->second->writable());
4756 }
4757
4758 Bstr savedStateFile;
4759
4760 /*
4761 * Saved VMs will have to prove that their saved states seem kosher.
4762 */
4763 if (mMachineState == MachineState_Saved)
4764 {
4765 rc = mMachine->COMGETTER(StateFilePath) (savedStateFile.asOutParam());
4766 CheckComRCReturnRC(rc);
4767 ComAssertRet (!!savedStateFile, E_FAIL);
4768 int vrc = SSMR3ValidateFile(Utf8Str(savedStateFile).c_str(), false /* fChecksumIt */);
4769 if (VBOX_FAILURE(vrc))
4770 return setError(VBOX_E_FILE_ERROR,
4771 tr("VM cannot start because the saved state file '%ls' is invalid (%Rrc). "
4772 "Discard the saved state prior to starting the VM"),
4773 savedStateFile.raw(), vrc);
4774 }
4775
4776 /* create a progress object to track progress of this operation */
4777 ComObjPtr<Progress> powerupProgress;
4778 powerupProgress.createObject();
4779 Bstr progressDesc;
4780 if (mMachineState == MachineState_Saved)
4781 progressDesc = tr ("Restoring virtual machine");
4782 else
4783 progressDesc = tr ("Starting virtual machine");
4784 rc = powerupProgress->init (static_cast <IConsole *> (this),
4785 progressDesc, FALSE /* aCancelable */);
4786 CheckComRCReturnRC(rc);
4787
4788 /* setup task object and thread to carry out the operation
4789 * asynchronously */
4790
4791 std::auto_ptr <VMPowerUpTask> task (new VMPowerUpTask (this, powerupProgress));
4792 ComAssertComRCRetRC (task->rc());
4793
4794 task->mSetVMErrorCallback = setVMErrorCallback;
4795 task->mConfigConstructor = configConstructor;
4796 task->mSharedFolders = sharedFolders;
4797 task->mStartPaused = aPaused;
4798 if (mMachineState == MachineState_Saved)
4799 task->mSavedStateFile = savedStateFile;
4800
4801 /* Reset differencing hard disks for which autoReset is true */
4802 {
4803 com::SafeIfaceArray<IHardDiskAttachment> atts;
4804 rc = mMachine->
4805 COMGETTER(HardDiskAttachments) (ComSafeArrayAsOutParam (atts));
4806 CheckComRCReturnRC(rc);
4807
4808 for (size_t i = 0; i < atts.size(); ++ i)
4809 {
4810 ComPtr<IHardDisk> hardDisk;
4811 rc = atts [i]->COMGETTER(HardDisk) (hardDisk.asOutParam());
4812 CheckComRCReturnRC(rc);
4813
4814 /* save for later use on the powerup thread */
4815 task->hardDisks.push_back (hardDisk);
4816
4817 /* needs autoreset? */
4818 BOOL autoReset = FALSE;
4819 rc = hardDisk->COMGETTER(AutoReset)(&autoReset);
4820 CheckComRCReturnRC(rc);
4821
4822 if (autoReset)
4823 {
4824 ComPtr<IProgress> resetProgress;
4825 rc = hardDisk->Reset (resetProgress.asOutParam());
4826 CheckComRCReturnRC(rc);
4827
4828 /* save for later use on the powerup thread */
4829 task->hardDiskProgresses.push_back (resetProgress);
4830 }
4831 }
4832 }
4833
4834 rc = consoleInitReleaseLog (mMachine);
4835 CheckComRCReturnRC(rc);
4836
4837 /* pass the progress object to the caller if requested */
4838 if (aProgress)
4839 {
4840 if (task->hardDiskProgresses.size() == 0)
4841 {
4842 /* there are no other operations to track, return the powerup
4843 * progress only */
4844 powerupProgress.queryInterfaceTo(aProgress);
4845 }
4846 else
4847 {
4848 /* create a combined progress object */
4849 ComObjPtr<CombinedProgress> progress;
4850 progress.createObject();
4851 VMPowerUpTask::ProgressList progresses (task->hardDiskProgresses);
4852 progresses.push_back (ComPtr<IProgress> (powerupProgress));
4853 rc = progress->init (static_cast <IConsole *> (this),
4854 progressDesc, progresses.begin(),
4855 progresses.end());
4856 AssertComRCReturnRC(rc);
4857 progress.queryInterfaceTo(aProgress);
4858 }
4859 }
4860
4861 int vrc = RTThreadCreate (NULL, Console::powerUpThread, (void *) task.get(),
4862 0, RTTHREADTYPE_MAIN_WORKER, 0, "VMPowerUp");
4863
4864 ComAssertMsgRCRet (vrc, ("Could not create VMPowerUp thread (%Rrc)", vrc),
4865 E_FAIL);
4866
4867 /* task is now owned by powerUpThread(), so release it */
4868 task.release();
4869
4870 /* finally, set the state: no right to fail in this method afterwards
4871 * since we've already started the thread and it is now responsible for
4872 * any error reporting and appropriate state change! */
4873
4874 if (mMachineState == MachineState_Saved)
4875 setMachineState (MachineState_Restoring);
4876 else
4877 setMachineState (MachineState_Starting);
4878
4879 LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
4880 LogFlowThisFuncLeave();
4881 return S_OK;
4882}
4883
4884/**
4885 * Internal power off worker routine.
4886 *
4887 * This method may be called only at certain places with the following meaning
4888 * as shown below:
4889 *
4890 * - if the machine state is either Running or Paused, a normal
4891 * Console-initiated powerdown takes place (e.g. PowerDown());
4892 * - if the machine state is Saving, saveStateThread() has successfully done its
4893 * job;
4894 * - if the machine state is Starting or Restoring, powerUpThread() has failed
4895 * to start/load the VM;
4896 * - if the machine state is Stopping, the VM has powered itself off (i.e. not
4897 * as a result of the powerDown() call).
4898 *
4899 * Calling it in situations other than the above will cause unexpected behavior.
4900 *
4901 * Note that this method should be the only one that destroys mpVM and sets it
4902 * to NULL.
4903 *
4904 * @param aProgress Progress object to run (may be NULL).
4905 *
4906 * @note Locks this object for writing.
4907 *
4908 * @note Never call this method from a thread that called addVMCaller() or
4909 * instantiated an AutoVMCaller object; first call releaseVMCaller() or
4910 * release(). Otherwise it will deadlock.
4911 */
4912HRESULT Console::powerDown (Progress *aProgress /*= NULL*/)
4913{
4914 LogFlowThisFuncEnter();
4915
4916 AutoCaller autoCaller(this);
4917 AssertComRCReturnRC(autoCaller.rc());
4918
4919 AutoWriteLock alock(this);
4920
4921 /* Total # of steps for the progress object. Must correspond to the
4922 * number of "advance percent count" comments in this method! */
4923 enum { StepCount = 7 };
4924 /* current step */
4925 ULONG step = 0;
4926
4927 HRESULT rc = S_OK;
4928 int vrc = VINF_SUCCESS;
4929
4930 /* sanity */
4931 Assert (mVMDestroying == false);
4932
4933 Assert (mpVM != NULL);
4934
4935 AssertMsg (mMachineState == MachineState_Running ||
4936 mMachineState == MachineState_Paused ||
4937 mMachineState == MachineState_Stuck ||
4938 mMachineState == MachineState_Saving ||
4939 mMachineState == MachineState_Starting ||
4940 mMachineState == MachineState_Restoring ||
4941 mMachineState == MachineState_Stopping,
4942 ("Invalid machine state: %d\n", mMachineState));
4943
4944 LogRel (("Console::powerDown(): A request to power off the VM has been "
4945 "issued (mMachineState=%d, InUninit=%d)\n",
4946 mMachineState, autoCaller.state() == InUninit));
4947
4948 /* Check if we need to power off the VM. In case of mVMPoweredOff=true, the
4949 * VM has already powered itself off in vmstateChangeCallback() and is just
4950 * notifying Console about that. In case of Starting or Restoring,
4951 * powerUpThread() is calling us on failure, so the VM is already off at
4952 * that point. */
4953 if (!mVMPoweredOff &&
4954 (mMachineState == MachineState_Starting ||
4955 mMachineState == MachineState_Restoring))
4956 mVMPoweredOff = true;
4957
4958 /* go to Stopping state if not already there. Note that we don't go from
4959 * Saving/Restoring to Stopping because vmstateChangeCallback() needs it to
4960 * set the state to Saved on VMSTATE_TERMINATED. In terms of protecting from
4961 * inappropriate operations while leaving the lock below, Saving or
4962 * Restoring should be fine too */
4963 if (mMachineState != MachineState_Saving &&
4964 mMachineState != MachineState_Restoring &&
4965 mMachineState != MachineState_Stopping)
4966 setMachineState (MachineState_Stopping);
4967
4968 /* ----------------------------------------------------------------------
4969 * DONE with necessary state changes, perform the power down actions (it's
4970 * safe to leave the object lock now if needed)
4971 * ---------------------------------------------------------------------- */
4972
4973 /* Stop the VRDP server to prevent new clients connection while VM is being
4974 * powered off. */
4975 if (mConsoleVRDPServer)
4976 {
4977 LogFlowThisFunc(("Stopping VRDP server...\n"));
4978
4979 /* Leave the lock since EMT will call us back as addVMCaller()
4980 * in updateDisplayData(). */
4981 alock.leave();
4982
4983 mConsoleVRDPServer->Stop();
4984
4985 alock.enter();
4986 }
4987
4988 /* advance percent count */
4989 if (aProgress)
4990 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4991
4992#ifdef VBOX_WITH_HGCM
4993
4994# ifdef VBOX_WITH_GUEST_PROPS
4995
4996 /* Save all guest property store entries to the machine XML file */
4997 com::SafeArray<BSTR> namesOut;
4998 com::SafeArray<BSTR> valuesOut;
4999 com::SafeArray<ULONG64> timestampsOut;
5000 com::SafeArray<BSTR> flagsOut;
5001 Bstr pattern("");
5002 if (pattern.isNull())
5003 rc = E_OUTOFMEMORY;
5004 else
5005 rc = doEnumerateGuestProperties (Bstr (""), ComSafeArrayAsOutParam (namesOut),
5006 ComSafeArrayAsOutParam (valuesOut),
5007 ComSafeArrayAsOutParam (timestampsOut),
5008 ComSafeArrayAsOutParam (flagsOut));
5009 if (SUCCEEDED(rc))
5010 {
5011 try
5012 {
5013 std::vector <BSTR> names;
5014 std::vector <BSTR> values;
5015 std::vector <ULONG64> timestamps;
5016 std::vector <BSTR> flags;
5017 for (unsigned i = 0; i < namesOut.size(); ++i)
5018 {
5019 uint32_t fFlags;
5020 guestProp::validateFlags (Utf8Str(flagsOut[i]).raw(), &fFlags);
5021 if ( !( fFlags & guestProp::TRANSIENT)
5022 || (mMachineState == MachineState_Saving)
5023 )
5024 {
5025 names.push_back(namesOut[i]);
5026 values.push_back(valuesOut[i]);
5027 timestamps.push_back(timestampsOut[i]);
5028 flags.push_back(flagsOut[i]);
5029 }
5030 }
5031 com::SafeArray<BSTR> namesIn (names);
5032 com::SafeArray<BSTR> valuesIn (values);
5033 com::SafeArray<ULONG64> timestampsIn (timestamps);
5034 com::SafeArray<BSTR> flagsIn (flags);
5035 if ( namesIn.isNull()
5036 || valuesIn.isNull()
5037 || timestampsIn.isNull()
5038 || flagsIn.isNull()
5039 )
5040 throw std::bad_alloc();
5041 /* PushGuestProperties() calls DiscardSettings(), which calls us back */
5042 alock.leave();
5043 mControl->PushGuestProperties (ComSafeArrayAsInParam (namesIn),
5044 ComSafeArrayAsInParam (valuesIn),
5045 ComSafeArrayAsInParam (timestampsIn),
5046 ComSafeArrayAsInParam (flagsIn));
5047 alock.enter();
5048 }
5049 catch (std::bad_alloc)
5050 {
5051 rc = E_OUTOFMEMORY;
5052 }
5053 }
5054
5055 /* advance percent count */
5056 if (aProgress)
5057 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
5058
5059# endif /* VBOX_WITH_GUEST_PROPS defined */
5060
5061 /* Shutdown HGCM services before stopping the guest, because they might
5062 * need a cleanup. */
5063 if (mVMMDev)
5064 {
5065 LogFlowThisFunc(("Shutdown HGCM...\n"));
5066
5067 /* Leave the lock since EMT will call us back as addVMCaller() */
5068 alock.leave();
5069
5070 mVMMDev->hgcmShutdown ();
5071
5072 alock.enter();
5073 }
5074
5075 /* advance percent count */
5076 if (aProgress)
5077 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
5078
5079#endif /* VBOX_WITH_HGCM */
5080
5081 /* ----------------------------------------------------------------------
5082 * Now, wait for all mpVM callers to finish their work if there are still
5083 * some on other threads. NO methods that need mpVM (or initiate other calls
5084 * that need it) may be called after this point
5085 * ---------------------------------------------------------------------- */
5086
5087 if (mVMCallers > 0)
5088 {
5089 /* go to the destroying state to prevent from adding new callers */
5090 mVMDestroying = true;
5091
5092 /* lazy creation */
5093 if (mVMZeroCallersSem == NIL_RTSEMEVENT)
5094 RTSemEventCreate (&mVMZeroCallersSem);
5095
5096 LogFlowThisFunc(("Waiting for mpVM callers (%d) to drop to zero...\n",
5097 mVMCallers));
5098
5099 alock.leave();
5100
5101 RTSemEventWait (mVMZeroCallersSem, RT_INDEFINITE_WAIT);
5102
5103 alock.enter();
5104 }
5105
5106 /* advance percent count */
5107 if (aProgress)
5108 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
5109
5110 vrc = VINF_SUCCESS;
5111
5112 /* Power off the VM if not already done that */
5113 if (!mVMPoweredOff)
5114 {
5115 LogFlowThisFunc(("Powering off the VM...\n"));
5116
5117 /* Leave the lock since EMT will call us back on VMR3PowerOff() */
5118 alock.leave();
5119
5120 vrc = VMR3PowerOff (mpVM);
5121
5122 /* Note that VMR3PowerOff() may fail here (invalid VMSTATE) if the
5123 * VM-(guest-)initiated power off happened in parallel a ms before this
5124 * call. So far, we let this error pop up on the user's side. */
5125
5126 alock.enter();
5127
5128 }
5129 else
5130 {
5131 /* reset the flag for further re-use */
5132 mVMPoweredOff = false;
5133 }
5134
5135 /* advance percent count */
5136 if (aProgress)
5137 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
5138
5139 LogFlowThisFunc(("Ready for VM destruction.\n"));
5140
5141 /* If we are called from Console::uninit(), then try to destroy the VM even
5142 * on failure (this will most likely fail too, but what to do?..) */
5143 if (VBOX_SUCCESS (vrc) || autoCaller.state() == InUninit)
5144 {
5145 /* If the machine has an USB comtroller, release all USB devices
5146 * (symmetric to the code in captureUSBDevices()) */
5147 bool fHasUSBController = false;
5148 {
5149 PPDMIBASE pBase;
5150 int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
5151 if (VBOX_SUCCESS (vrc))
5152 {
5153 fHasUSBController = true;
5154 detachAllUSBDevices (false /* aDone */);
5155 }
5156 }
5157
5158 /* Now we've got to destroy the VM as well. (mpVM is not valid beyond
5159 * this point). We leave the lock before calling VMR3Destroy() because
5160 * it will result into calling destructors of drivers associated with
5161 * Console children which may in turn try to lock Console (e.g. by
5162 * instantiating SafeVMPtr to access mpVM). It's safe here because
5163 * mVMDestroying is set which should prevent any activity. */
5164
5165 /* Set mpVM to NULL early just in case if some old code is not using
5166 * addVMCaller()/releaseVMCaller(). */
5167 PVM pVM = mpVM;
5168 mpVM = NULL;
5169
5170 LogFlowThisFunc(("Destroying the VM...\n"));
5171
5172 alock.leave();
5173
5174 vrc = VMR3Destroy (pVM);
5175
5176 /* take the lock again */
5177 alock.enter();
5178
5179 /* advance percent count */
5180 if (aProgress)
5181 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
5182
5183 if (VBOX_SUCCESS (vrc))
5184 {
5185 LogFlowThisFunc(("Machine has been destroyed (mMachineState=%d)\n",
5186 mMachineState));
5187 /* Note: the Console-level machine state change happens on the
5188 * VMSTATE_TERMINATE state change in vmstateChangeCallback(). If
5189 * powerDown() is called from EMT (i.e. from vmstateChangeCallback()
5190 * on receiving VM-initiated VMSTATE_OFF), VMSTATE_TERMINATE hasn't
5191 * occurred yet. This is okay, because mMachineState is already
5192 * Stopping in this case, so any other attempt to call PowerDown()
5193 * will be rejected. */
5194 }
5195 else
5196 {
5197 /* bad bad bad, but what to do? */
5198 mpVM = pVM;
5199 rc = setError (VBOX_E_VM_ERROR,
5200 tr ("Could not destroy the machine. (Error: %Rrc)"), vrc);
5201 }
5202
5203 /* Complete the detaching of the USB devices. */
5204 if (fHasUSBController)
5205 detachAllUSBDevices (true /* aDone */);
5206
5207 /* advance percent count */
5208 if (aProgress)
5209 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
5210 }
5211 else
5212 {
5213 rc = setError (VBOX_E_VM_ERROR,
5214 tr ("Could not power off the machine. (Error: %Rrc)"), vrc);
5215 }
5216
5217 /* Finished with destruction. Note that if something impossible happened and
5218 * we've failed to destroy the VM, mVMDestroying will remain true and
5219 * mMachineState will be something like Stopping, so most Console methods
5220 * will return an error to the caller. */
5221 if (mpVM == NULL)
5222 mVMDestroying = false;
5223
5224 if (SUCCEEDED(rc))
5225 {
5226 /* uninit dynamically allocated members of mCallbackData */
5227 if (mCallbackData.mpsc.valid)
5228 {
5229 if (mCallbackData.mpsc.shape != NULL)
5230 RTMemFree (mCallbackData.mpsc.shape);
5231 }
5232 memset (&mCallbackData, 0, sizeof (mCallbackData));
5233 }
5234
5235 /* complete the progress */
5236 if (aProgress)
5237 aProgress->notifyComplete (rc);
5238
5239 LogFlowThisFuncLeave();
5240 return rc;
5241}
5242
5243/**
5244 * @note Locks this object for writing.
5245 */
5246HRESULT Console::setMachineState (MachineState_T aMachineState,
5247 bool aUpdateServer /* = true */)
5248{
5249 AutoCaller autoCaller(this);
5250 AssertComRCReturnRC(autoCaller.rc());
5251
5252 AutoWriteLock alock(this);
5253
5254 HRESULT rc = S_OK;
5255
5256 if (mMachineState != aMachineState)
5257 {
5258 LogFlowThisFunc(("machineState=%d\n", aMachineState));
5259 mMachineState = aMachineState;
5260
5261 /// @todo (dmik)
5262 // possibly, we need to redo onStateChange() using the dedicated
5263 // Event thread, like it is done in VirtualBox. This will make it
5264 // much safer (no deadlocks possible if someone tries to use the
5265 // console from the callback), however, listeners will lose the
5266 // ability to synchronously react to state changes (is it really
5267 // necessary??)
5268 LogFlowThisFunc(("Doing onStateChange()...\n"));
5269 onStateChange (aMachineState);
5270 LogFlowThisFunc(("Done onStateChange()\n"));
5271
5272 if (aUpdateServer)
5273 {
5274 /* Server notification MUST be done from under the lock; otherwise
5275 * the machine state here and on the server might go out of sync
5276 * whihc can lead to various unexpected results (like the machine
5277 * state being >= MachineState_Running on the server, while the
5278 * session state is already SessionState_Closed at the same time
5279 * there).
5280 *
5281 * Cross-lock conditions should be carefully watched out: calling
5282 * UpdateState we will require Machine and SessionMachine locks
5283 * (remember that here we're holding the Console lock here, and also
5284 * all locks that have been entered by the thread before calling
5285 * this method).
5286 */
5287 LogFlowThisFunc(("Doing mControl->UpdateState()...\n"));
5288 rc = mControl->UpdateState (aMachineState);
5289 LogFlowThisFunc(("mControl->UpdateState()=%08X\n", rc));
5290 }
5291 }
5292
5293 return rc;
5294}
5295
5296/**
5297 * Searches for a shared folder with the given logical name
5298 * in the collection of shared folders.
5299 *
5300 * @param aName logical name of the shared folder
5301 * @param aSharedFolder where to return the found object
5302 * @param aSetError whether to set the error info if the folder is
5303 * not found
5304 * @return
5305 * S_OK when found or E_INVALIDARG when not found
5306 *
5307 * @note The caller must lock this object for writing.
5308 */
5309HRESULT Console::findSharedFolder (CBSTR aName,
5310 ComObjPtr<SharedFolder> &aSharedFolder,
5311 bool aSetError /* = false */)
5312{
5313 /* sanity check */
5314 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
5315
5316 SharedFolderMap::const_iterator it = mSharedFolders.find (aName);
5317 if (it != mSharedFolders.end())
5318 {
5319 aSharedFolder = it->second;
5320 return S_OK;
5321 }
5322
5323 if (aSetError)
5324 setError (VBOX_E_FILE_ERROR,
5325 tr ("Could not find a shared folder named '%ls'."), aName);
5326
5327 return VBOX_E_FILE_ERROR;
5328}
5329
5330/**
5331 * Fetches the list of global or machine shared folders from the server.
5332 *
5333 * @param aGlobal true to fetch global folders.
5334 *
5335 * @note The caller must lock this object for writing.
5336 */
5337HRESULT Console::fetchSharedFolders (BOOL aGlobal)
5338{
5339 /* sanity check */
5340 AssertReturn(AutoCaller (this).state() == InInit ||
5341 isWriteLockOnCurrentThread(), E_FAIL);
5342
5343 /* protect mpVM (if not NULL) */
5344 AutoVMCallerQuietWeak autoVMCaller (this);
5345
5346 HRESULT rc = S_OK;
5347
5348 bool online = mpVM && autoVMCaller.isOk() && mVMMDev->isShFlActive();
5349
5350 if (aGlobal)
5351 {
5352 /// @todo grab & process global folders when they are done
5353 }
5354 else
5355 {
5356 SharedFolderDataMap oldFolders;
5357 if (online)
5358 oldFolders = mMachineSharedFolders;
5359
5360 mMachineSharedFolders.clear();
5361
5362 SafeIfaceArray<ISharedFolder> folders;
5363 rc = mMachine->COMGETTER(SharedFolders) (ComSafeArrayAsOutParam(folders));
5364 AssertComRCReturnRC(rc);
5365
5366 for (size_t i = 0; i < folders.size(); ++i)
5367 {
5368 ComPtr<ISharedFolder> folder = folders[i];
5369
5370 Bstr name;
5371 Bstr hostPath;
5372 BOOL writable;
5373
5374 rc = folder->COMGETTER(Name) (name.asOutParam());
5375 CheckComRCBreakRC (rc);
5376 rc = folder->COMGETTER(HostPath) (hostPath.asOutParam());
5377 CheckComRCBreakRC (rc);
5378 rc = folder->COMGETTER(Writable) (&writable);
5379
5380 mMachineSharedFolders.insert (std::make_pair (name, SharedFolderData (hostPath, writable)));
5381
5382 /* send changes to HGCM if the VM is running */
5383 /// @todo report errors as runtime warnings through VMSetError
5384 if (online)
5385 {
5386 SharedFolderDataMap::iterator it = oldFolders.find (name);
5387 if (it == oldFolders.end() || it->second.mHostPath != hostPath)
5388 {
5389 /* a new machine folder is added or
5390 * the existing machine folder is changed */
5391 if (mSharedFolders.find (name) != mSharedFolders.end())
5392 ; /* the console folder exists, nothing to do */
5393 else
5394 {
5395 /* remove the old machine folder (when changed)
5396 * or the global folder if any (when new) */
5397 if (it != oldFolders.end() ||
5398 mGlobalSharedFolders.find (name) !=
5399 mGlobalSharedFolders.end())
5400 rc = removeSharedFolder (name);
5401 /* create the new machine folder */
5402 rc = createSharedFolder (name, SharedFolderData (hostPath, writable));
5403 }
5404 }
5405 /* forget the processed (or identical) folder */
5406 if (it != oldFolders.end())
5407 oldFolders.erase (it);
5408
5409 rc = S_OK;
5410 }
5411 }
5412
5413 AssertComRCReturnRC(rc);
5414
5415 /* process outdated (removed) folders */
5416 /// @todo report errors as runtime warnings through VMSetError
5417 if (online)
5418 {
5419 for (SharedFolderDataMap::const_iterator it = oldFolders.begin();
5420 it != oldFolders.end(); ++ it)
5421 {
5422 if (mSharedFolders.find (it->first) != mSharedFolders.end())
5423 ; /* the console folder exists, nothing to do */
5424 else
5425 {
5426 /* remove the outdated machine folder */
5427 rc = removeSharedFolder (it->first);
5428 /* create the global folder if there is any */
5429 SharedFolderDataMap::const_iterator git =
5430 mGlobalSharedFolders.find (it->first);
5431 if (git != mGlobalSharedFolders.end())
5432 rc = createSharedFolder (git->first, git->second);
5433 }
5434 }
5435
5436 rc = S_OK;
5437 }
5438 }
5439
5440 return rc;
5441}
5442
5443/**
5444 * Searches for a shared folder with the given name in the list of machine
5445 * shared folders and then in the list of the global shared folders.
5446 *
5447 * @param aName Name of the folder to search for.
5448 * @param aIt Where to store the pointer to the found folder.
5449 * @return @c true if the folder was found and @c false otherwise.
5450 *
5451 * @note The caller must lock this object for reading.
5452 */
5453bool Console::findOtherSharedFolder (IN_BSTR aName,
5454 SharedFolderDataMap::const_iterator &aIt)
5455{
5456 /* sanity check */
5457 AssertReturn(isWriteLockOnCurrentThread(), false);
5458
5459 /* first, search machine folders */
5460 aIt = mMachineSharedFolders.find (aName);
5461 if (aIt != mMachineSharedFolders.end())
5462 return true;
5463
5464 /* second, search machine folders */
5465 aIt = mGlobalSharedFolders.find (aName);
5466 if (aIt != mGlobalSharedFolders.end())
5467 return true;
5468
5469 return false;
5470}
5471
5472/**
5473 * Calls the HGCM service to add a shared folder definition.
5474 *
5475 * @param aName Shared folder name.
5476 * @param aHostPath Shared folder path.
5477 *
5478 * @note Must be called from under AutoVMCaller and when mpVM != NULL!
5479 * @note Doesn't lock anything.
5480 */
5481HRESULT Console::createSharedFolder (CBSTR aName, SharedFolderData aData)
5482{
5483 ComAssertRet (aName && *aName, E_FAIL);
5484 ComAssertRet (aData.mHostPath, E_FAIL);
5485
5486 /* sanity checks */
5487 AssertReturn(mpVM, E_FAIL);
5488 AssertReturn(mVMMDev->isShFlActive(), E_FAIL);
5489
5490 VBOXHGCMSVCPARM parms[SHFL_CPARMS_ADD_MAPPING];
5491 SHFLSTRING *pFolderName, *pMapName;
5492 size_t cbString;
5493
5494 Log (("Adding shared folder '%ls' -> '%ls'\n", aName, aData.mHostPath.raw()));
5495
5496 cbString = (RTUtf16Len (aData.mHostPath) + 1) * sizeof (RTUTF16);
5497 if (cbString >= UINT16_MAX)
5498 return setError (E_INVALIDARG, tr ("The name is too long"));
5499 pFolderName = (SHFLSTRING *) RTMemAllocZ (sizeof (SHFLSTRING) + cbString);
5500 Assert (pFolderName);
5501 memcpy (pFolderName->String.ucs2, aData.mHostPath, cbString);
5502
5503 pFolderName->u16Size = (uint16_t)cbString;
5504 pFolderName->u16Length = (uint16_t)cbString - sizeof(RTUTF16);
5505
5506 parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
5507 parms[0].u.pointer.addr = pFolderName;
5508 parms[0].u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5509
5510 cbString = (RTUtf16Len (aName) + 1) * sizeof (RTUTF16);
5511 if (cbString >= UINT16_MAX)
5512 {
5513 RTMemFree (pFolderName);
5514 return setError (E_INVALIDARG, tr ("The host path is too long"));
5515 }
5516 pMapName = (SHFLSTRING *) RTMemAllocZ (sizeof(SHFLSTRING) + cbString);
5517 Assert (pMapName);
5518 memcpy (pMapName->String.ucs2, aName, cbString);
5519
5520 pMapName->u16Size = (uint16_t)cbString;
5521 pMapName->u16Length = (uint16_t)cbString - sizeof (RTUTF16);
5522
5523 parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
5524 parms[1].u.pointer.addr = pMapName;
5525 parms[1].u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5526
5527 parms[2].type = VBOX_HGCM_SVC_PARM_32BIT;
5528 parms[2].u.uint32 = aData.mWritable;
5529
5530 int vrc = mVMMDev->hgcmHostCall ("VBoxSharedFolders",
5531 SHFL_FN_ADD_MAPPING,
5532 SHFL_CPARMS_ADD_MAPPING, &parms[0]);
5533 RTMemFree (pFolderName);
5534 RTMemFree (pMapName);
5535
5536 if (VBOX_FAILURE (vrc))
5537 return setError (E_FAIL,
5538 tr ("Could not create a shared folder '%ls' "
5539 "mapped to '%ls' (%Rrc)"),
5540 aName, aData.mHostPath.raw(), vrc);
5541
5542 return S_OK;
5543}
5544
5545/**
5546 * Calls the HGCM service to remove the shared folder definition.
5547 *
5548 * @param aName Shared folder name.
5549 *
5550 * @note Must be called from under AutoVMCaller and when mpVM != NULL!
5551 * @note Doesn't lock anything.
5552 */
5553HRESULT Console::removeSharedFolder (CBSTR aName)
5554{
5555 ComAssertRet (aName && *aName, E_FAIL);
5556
5557 /* sanity checks */
5558 AssertReturn(mpVM, E_FAIL);
5559 AssertReturn(mVMMDev->isShFlActive(), E_FAIL);
5560
5561 VBOXHGCMSVCPARM parms;
5562 SHFLSTRING *pMapName;
5563 size_t cbString;
5564
5565 Log (("Removing shared folder '%ls'\n", aName));
5566
5567 cbString = (RTUtf16Len (aName) + 1) * sizeof (RTUTF16);
5568 if (cbString >= UINT16_MAX)
5569 return setError (E_INVALIDARG, tr ("The name is too long"));
5570 pMapName = (SHFLSTRING *) RTMemAllocZ (sizeof (SHFLSTRING) + cbString);
5571 Assert (pMapName);
5572 memcpy (pMapName->String.ucs2, aName, cbString);
5573
5574 pMapName->u16Size = (uint16_t)cbString;
5575 pMapName->u16Length = (uint16_t)cbString - sizeof (RTUTF16);
5576
5577 parms.type = VBOX_HGCM_SVC_PARM_PTR;
5578 parms.u.pointer.addr = pMapName;
5579 parms.u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5580
5581 int vrc = mVMMDev->hgcmHostCall ("VBoxSharedFolders",
5582 SHFL_FN_REMOVE_MAPPING,
5583 1, &parms);
5584 RTMemFree(pMapName);
5585 if (VBOX_FAILURE (vrc))
5586 return setError (E_FAIL,
5587 tr ("Could not remove the shared folder '%ls' (%Rrc)"),
5588 aName, vrc);
5589
5590 return S_OK;
5591}
5592
5593/**
5594 * VM state callback function. Called by the VMM
5595 * using its state machine states.
5596 *
5597 * Primarily used to handle VM initiated power off, suspend and state saving,
5598 * but also for doing termination completed work (VMSTATE_TERMINATE).
5599 *
5600 * In general this function is called in the context of the EMT.
5601 *
5602 * @param aVM The VM handle.
5603 * @param aState The new state.
5604 * @param aOldState The old state.
5605 * @param aUser The user argument (pointer to the Console object).
5606 *
5607 * @note Locks the Console object for writing.
5608 */
5609DECLCALLBACK(void)
5610Console::vmstateChangeCallback(PVM aVM, VMSTATE aState, VMSTATE aOldState,
5611 void *aUser)
5612{
5613 LogFlowFunc(("Changing state from %d to %d (aVM=%p)\n",
5614 aOldState, aState, aVM));
5615
5616 Console *that = static_cast<Console *> (aUser);
5617 AssertReturnVoid(that);
5618
5619 AutoCaller autoCaller(that);
5620
5621 /* Note that we must let this method proceed even if Console::uninit() has
5622 * been already called. In such case this VMSTATE change is a result of:
5623 * 1) powerDown() called from uninit() itself, or
5624 * 2) VM-(guest-)initiated power off. */
5625 AssertReturnVoid( autoCaller.isOk()
5626 || autoCaller.state() == InUninit);
5627
5628 switch (aState)
5629 {
5630 /*
5631 * The VM has terminated
5632 */
5633 case VMSTATE_OFF:
5634 {
5635 AutoWriteLock alock(that);
5636
5637 if (that->mVMStateChangeCallbackDisabled)
5638 break;
5639
5640 /* Do we still think that it is running? It may happen if this is a
5641 * VM-(guest-)initiated shutdown/poweroff.
5642 */
5643 if ( that->mMachineState != MachineState_Stopping
5644 && that->mMachineState != MachineState_Saving
5645 && that->mMachineState != MachineState_Restoring)
5646 {
5647 LogFlowFunc(("VM has powered itself off but Console still thinks it is running. Notifying.\n"));
5648
5649 /* prevent powerDown() from calling VMR3PowerOff() again */
5650 Assert(that->mVMPoweredOff == false);
5651 that->mVMPoweredOff = true;
5652
5653 /* we are stopping now */
5654 that->setMachineState(MachineState_Stopping);
5655
5656 /* Setup task object and thread to carry out the operation
5657 * asynchronously (if we call powerDown() right here but there
5658 * is one or more mpVM callers (added with addVMCaller()) we'll
5659 * deadlock).
5660 */
5661 std::auto_ptr<VMProgressTask> task(new VMProgressTask(that, NULL /* aProgress */,
5662 true /* aUsesVMPtr */));
5663
5664 /* If creating a task is falied, this can currently mean one of
5665 * two: either Console::uninit() has been called just a ms
5666 * before (so a powerDown() call is already on the way), or
5667 * powerDown() itself is being already executed. Just do
5668 * nothing.
5669 */
5670 if (!task->isOk())
5671 {
5672 LogFlowFunc(("Console is already being uninitialized.\n"));
5673 break;
5674 }
5675
5676 int vrc = RTThreadCreate(NULL, Console::powerDownThread,
5677 (void *) task.get(), 0,
5678 RTTHREADTYPE_MAIN_WORKER, 0,
5679 "VMPowerDown");
5680 AssertMsgRCBreak(vrc, ("Could not create VMPowerDown thread (%Rrc)\n", vrc));
5681
5682 /* task is now owned by powerDownThread(), so release it */
5683 task.release();
5684 }
5685 break;
5686 }
5687
5688 /* The VM has been completely destroyed.
5689 *
5690 * Note: This state change can happen at two points:
5691 * 1) At the end of VMR3Destroy() if it was not called from EMT.
5692 * 2) At the end of vmR3EmulationThread if VMR3Destroy() was
5693 * called by EMT.
5694 */
5695 case VMSTATE_TERMINATED:
5696 {
5697 AutoWriteLock alock(that);
5698
5699 if (that->mVMStateChangeCallbackDisabled)
5700 break;
5701
5702 /* Terminate host interface networking. If aVM is NULL, we've been
5703 * manually called from powerUpThread() either before calling
5704 * VMR3Create() or after VMR3Create() failed, so no need to touch
5705 * networking.
5706 */
5707 if (aVM)
5708 that->powerDownHostInterfaces();
5709
5710 /* From now on the machine is officially powered down or remains in
5711 * the Saved state.
5712 */
5713 switch (that->mMachineState)
5714 {
5715 default:
5716 AssertFailed();
5717 /* fall through */
5718 case MachineState_Stopping:
5719 /* successfully powered down */
5720 that->setMachineState(MachineState_PoweredOff);
5721 break;
5722 case MachineState_Saving:
5723 /* successfully saved (note that the machine is already in
5724 * the Saved state on the server due to EndSavingState()
5725 * called from saveStateThread(), so only change the local
5726 * state) */
5727 that->setMachineStateLocally(MachineState_Saved);
5728 break;
5729 case MachineState_Starting:
5730 /* failed to start, but be patient: set back to PoweredOff
5731 * (for similarity with the below) */
5732 that->setMachineState(MachineState_PoweredOff);
5733 break;
5734 case MachineState_Restoring:
5735 /* failed to load the saved state file, but be patient: set
5736 * back to Saved (to preserve the saved state file) */
5737 that->setMachineState(MachineState_Saved);
5738 break;
5739 }
5740 break;
5741 }
5742
5743 case VMSTATE_SUSPENDED:
5744 {
5745 /** @todo state/live VMSTATE_SUSPENDING_LS. */
5746 if ( aOldState == VMSTATE_SUSPENDING)
5747 {
5748 AutoWriteLock alock(that);
5749
5750 if (that->mVMStateChangeCallbackDisabled)
5751 break;
5752
5753 /* Change the machine state from Running to Paused. */
5754 AssertBreak(that->mMachineState == MachineState_Running);
5755 that->setMachineState(MachineState_Paused);
5756 }
5757 break;
5758 }
5759
5760 case VMSTATE_RUNNING:
5761 {
5762 if ( aOldState == VMSTATE_POWERING_ON
5763 || aOldState == VMSTATE_RESUMING)
5764 {
5765 AutoWriteLock alock(that);
5766
5767 if (that->mVMStateChangeCallbackDisabled)
5768 break;
5769
5770 /* Change the machine state from Starting, Restoring or Paused
5771 * to Running */
5772 Assert ( ( ( that->mMachineState == MachineState_Starting
5773 || that->mMachineState == MachineState_Paused)
5774 && aOldState == VMSTATE_POWERING_ON)
5775 || ( ( that->mMachineState == MachineState_Restoring
5776 || that->mMachineState == MachineState_Paused)
5777 && aOldState == VMSTATE_RESUMING));
5778
5779 that->setMachineState (MachineState_Running);
5780 }
5781
5782 break;
5783 }
5784
5785 case VMSTATE_FATAL_ERROR:
5786 {
5787 AutoWriteLock alock(that);
5788
5789 if (that->mVMStateChangeCallbackDisabled)
5790 break;
5791
5792 /* Fatal errors are only for running VMs. */
5793 Assert(Global::IsOnline(that->mMachineState));
5794
5795 /* Note! 'Pause' is used here in want of something better. There
5796 * are currently only two places where fatal errors might be
5797 * raised, so it is not worth adding a new externally
5798 * visible state for this yet. */
5799 that->setMachineState(MachineState_Paused);
5800 break;
5801 }
5802
5803 case VMSTATE_GURU_MEDITATION:
5804 {
5805 AutoWriteLock alock(that);
5806
5807 if (that->mVMStateChangeCallbackDisabled)
5808 break;
5809
5810 /* Guru are only for running VMs */
5811 Assert(Global::IsOnline (that->mMachineState));
5812
5813 that->setMachineState(MachineState_Stuck);
5814 break;
5815 }
5816
5817 default: /* shut up gcc */
5818 break;
5819 }
5820}
5821
5822#ifdef VBOX_WITH_USB
5823
5824/**
5825 * Sends a request to VMM to attach the given host device.
5826 * After this method succeeds, the attached device will appear in the
5827 * mUSBDevices collection.
5828 *
5829 * @param aHostDevice device to attach
5830 *
5831 * @note Synchronously calls EMT.
5832 * @note Must be called from under this object's lock.
5833 */
5834HRESULT Console::attachUSBDevice (IUSBDevice *aHostDevice, ULONG aMaskedIfs)
5835{
5836 AssertReturn(aHostDevice, E_FAIL);
5837 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
5838
5839 /* still want a lock object because we need to leave it */
5840 AutoWriteLock alock(this);
5841
5842 HRESULT hrc;
5843
5844 /*
5845 * Get the address and the Uuid, and call the pfnCreateProxyDevice roothub
5846 * method in EMT (using usbAttachCallback()).
5847 */
5848 Bstr BstrAddress;
5849 hrc = aHostDevice->COMGETTER (Address) (BstrAddress.asOutParam());
5850 ComAssertComRCRetRC (hrc);
5851
5852 Utf8Str Address (BstrAddress);
5853
5854 Bstr id;
5855 hrc = aHostDevice->COMGETTER (Id) (id.asOutParam());
5856 ComAssertComRCRetRC (hrc);
5857 Guid uuid(id);
5858
5859 BOOL fRemote = FALSE;
5860 hrc = aHostDevice->COMGETTER (Remote) (&fRemote);
5861 ComAssertComRCRetRC (hrc);
5862
5863 /* protect mpVM */
5864 AutoVMCaller autoVMCaller (this);
5865 CheckComRCReturnRC(autoVMCaller.rc());
5866
5867 LogFlowThisFunc(("Proxying USB device '%s' {%RTuuid}...\n",
5868 Address.raw(), uuid.ptr()));
5869
5870 /* leave the lock before a VMR3* call (EMT will call us back)! */
5871 alock.leave();
5872
5873/** @todo just do everything here and only wrap the PDMR3Usb call. That'll offload some notification stuff from the EMT thread. */
5874 int vrc = VMR3ReqCallWait (mpVM, VMCPUID_ANY,
5875 (PFNRT) usbAttachCallback, 6, this, aHostDevice, uuid.ptr(), fRemote, Address.raw(), aMaskedIfs);
5876
5877 /* restore the lock */
5878 alock.enter();
5879
5880 /* hrc is S_OK here */
5881
5882 if (VBOX_FAILURE (vrc))
5883 {
5884 LogWarningThisFunc(("Failed to create proxy device for '%s' {%RTuuid} (%Rrc)\n",
5885 Address.raw(), uuid.ptr(), vrc));
5886
5887 switch (vrc)
5888 {
5889 case VERR_VUSB_NO_PORTS:
5890 hrc = setError (E_FAIL,
5891 tr ("Failed to attach the USB device. (No available ports on the USB controller)."));
5892 break;
5893 case VERR_VUSB_USBFS_PERMISSION:
5894 hrc = setError (E_FAIL,
5895 tr ("Not permitted to open the USB device, check usbfs options"));
5896 break;
5897 default:
5898 hrc = setError (E_FAIL,
5899 tr ("Failed to create a proxy device for the USB device. (Error: %Rrc)"), vrc);
5900 break;
5901 }
5902 }
5903
5904 return hrc;
5905}
5906
5907/**
5908 * USB device attach callback used by AttachUSBDevice().
5909 * Note that AttachUSBDevice() doesn't return until this callback is executed,
5910 * so we don't use AutoCaller and don't care about reference counters of
5911 * interface pointers passed in.
5912 *
5913 * @thread EMT
5914 * @note Locks the console object for writing.
5915 */
5916//static
5917DECLCALLBACK(int)
5918Console::usbAttachCallback (Console *that, IUSBDevice *aHostDevice, PCRTUUID aUuid, bool aRemote, const char *aAddress, ULONG aMaskedIfs)
5919{
5920 LogFlowFuncEnter();
5921 LogFlowFunc (("that={%p}\n", that));
5922
5923 AssertReturn(that && aUuid, VERR_INVALID_PARAMETER);
5924
5925 void *pvRemoteBackend = NULL;
5926 if (aRemote)
5927 {
5928 RemoteUSBDevice *pRemoteUSBDevice = static_cast <RemoteUSBDevice *> (aHostDevice);
5929 Guid guid (*aUuid);
5930
5931 pvRemoteBackend = that->consoleVRDPServer ()->USBBackendRequestPointer (pRemoteUSBDevice->clientId (), &guid);
5932 if (!pvRemoteBackend)
5933 return VERR_INVALID_PARAMETER; /* The clientId is invalid then. */
5934 }
5935
5936 USHORT portVersion = 1;
5937 HRESULT hrc = aHostDevice->COMGETTER(PortVersion)(&portVersion);
5938 AssertComRCReturn(hrc, VERR_GENERAL_FAILURE);
5939 Assert(portVersion == 1 || portVersion == 2);
5940
5941 int vrc = PDMR3USBCreateProxyDevice (that->mpVM, aUuid, aRemote, aAddress, pvRemoteBackend,
5942 portVersion == 1 ? VUSB_STDVER_11 : VUSB_STDVER_20, aMaskedIfs);
5943 if (VBOX_SUCCESS (vrc))
5944 {
5945 /* Create a OUSBDevice and add it to the device list */
5946 ComObjPtr<OUSBDevice> device;
5947 device.createObject();
5948 HRESULT hrc = device->init (aHostDevice);
5949 AssertComRC (hrc);
5950
5951 AutoWriteLock alock(that);
5952 that->mUSBDevices.push_back (device);
5953 LogFlowFunc (("Attached device {%RTuuid}\n", device->id().raw()));
5954
5955 /* notify callbacks */
5956 that->onUSBDeviceStateChange (device, true /* aAttached */, NULL);
5957 }
5958
5959 LogFlowFunc (("vrc=%Rrc\n", vrc));
5960 LogFlowFuncLeave();
5961 return vrc;
5962}
5963
5964/**
5965 * Sends a request to VMM to detach the given host device. After this method
5966 * succeeds, the detached device will disappear from the mUSBDevices
5967 * collection.
5968 *
5969 * @param aIt Iterator pointing to the device to detach.
5970 *
5971 * @note Synchronously calls EMT.
5972 * @note Must be called from under this object's lock.
5973 */
5974HRESULT Console::detachUSBDevice (USBDeviceList::iterator &aIt)
5975{
5976 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
5977
5978 /* still want a lock object because we need to leave it */
5979 AutoWriteLock alock(this);
5980
5981 /* protect mpVM */
5982 AutoVMCaller autoVMCaller (this);
5983 CheckComRCReturnRC(autoVMCaller.rc());
5984
5985 /* if the device is attached, then there must at least one USB hub. */
5986 AssertReturn(PDMR3USBHasHub (mpVM), E_FAIL);
5987
5988 LogFlowThisFunc(("Detaching USB proxy device {%RTuuid}...\n",
5989 (*aIt)->id().raw()));
5990
5991 /* leave the lock before a VMR3* call (EMT will call us back)! */
5992 alock.leave();
5993
5994/** @todo just do everything here and only wrap the PDMR3Usb call. That'll offload some notification stuff from the EMT thread. */
5995 int vrc = VMR3ReqCallWait (mpVM, VMCPUID_ANY,
5996 (PFNRT) usbDetachCallback, 4, this, &aIt, (*aIt)->id().raw());
5997 ComAssertRCRet (vrc, E_FAIL);
5998
5999 return S_OK;
6000}
6001
6002/**
6003 * USB device detach callback used by DetachUSBDevice().
6004 * Note that DetachUSBDevice() doesn't return until this callback is executed,
6005 * so we don't use AutoCaller and don't care about reference counters of
6006 * interface pointers passed in.
6007 *
6008 * @thread EMT
6009 * @note Locks the console object for writing.
6010 */
6011//static
6012DECLCALLBACK(int)
6013Console::usbDetachCallback (Console *that, USBDeviceList::iterator *aIt, PCRTUUID aUuid)
6014{
6015 LogFlowFuncEnter();
6016 LogFlowFunc (("that={%p}\n", that));
6017
6018 AssertReturn(that && aUuid, VERR_INVALID_PARAMETER);
6019 ComObjPtr<OUSBDevice> device = **aIt;
6020
6021 /*
6022 * If that was a remote device, release the backend pointer.
6023 * The pointer was requested in usbAttachCallback.
6024 */
6025 BOOL fRemote = FALSE;
6026
6027 HRESULT hrc2 = (**aIt)->COMGETTER (Remote) (&fRemote);
6028 ComAssertComRC (hrc2);
6029
6030 if (fRemote)
6031 {
6032 Guid guid (*aUuid);
6033 that->consoleVRDPServer ()->USBBackendReleasePointer (&guid);
6034 }
6035
6036 int vrc = PDMR3USBDetachDevice (that->mpVM, aUuid);
6037
6038 if (VBOX_SUCCESS (vrc))
6039 {
6040 AutoWriteLock alock(that);
6041
6042 /* Remove the device from the collection */
6043 that->mUSBDevices.erase (*aIt);
6044 LogFlowFunc (("Detached device {%RTuuid}\n", device->id().raw()));
6045
6046 /* notify callbacks */
6047 that->onUSBDeviceStateChange (device, false /* aAttached */, NULL);
6048 }
6049
6050 LogFlowFunc (("vrc=%Rrc\n", vrc));
6051 LogFlowFuncLeave();
6052 return vrc;
6053}
6054
6055#endif /* VBOX_WITH_USB */
6056#if (defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD)) && !defined(VBOX_WITH_NETFLT)
6057
6058/**
6059 * Helper function to handle host interface device creation and attachment.
6060 *
6061 * @param networkAdapter the network adapter which attachment should be reset
6062 * @return COM status code
6063 *
6064 * @note The caller must lock this object for writing.
6065 *
6066 * @todo Move this back into the driver!
6067 */
6068HRESULT Console::attachToTapInterface(INetworkAdapter *networkAdapter)
6069{
6070 LogFlowThisFunc(("\n"));
6071 /* sanity check */
6072 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
6073
6074# ifdef VBOX_STRICT
6075 /* paranoia */
6076 NetworkAttachmentType_T attachment;
6077 networkAdapter->COMGETTER(AttachmentType)(&attachment);
6078 Assert(attachment == NetworkAttachmentType_Bridged);
6079# endif /* VBOX_STRICT */
6080
6081 HRESULT rc = S_OK;
6082
6083 ULONG slot = 0;
6084 rc = networkAdapter->COMGETTER(Slot)(&slot);
6085 AssertComRC(rc);
6086
6087# ifdef RT_OS_LINUX
6088 /*
6089 * Allocate a host interface device
6090 */
6091 int rcVBox = RTFileOpen(&maTapFD[slot], "/dev/net/tun",
6092 RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_INHERIT);
6093 if (VBOX_SUCCESS(rcVBox))
6094 {
6095 /*
6096 * Set/obtain the tap interface.
6097 */
6098 struct ifreq IfReq;
6099 memset(&IfReq, 0, sizeof(IfReq));
6100 /* The name of the TAP interface we are using */
6101 Bstr tapDeviceName;
6102 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
6103 if (FAILED(rc))
6104 tapDeviceName.setNull(); /* Is this necessary? */
6105 if (tapDeviceName.isEmpty())
6106 {
6107 LogRel(("No TAP device name was supplied.\n"));
6108 rc = setError(E_FAIL, tr ("No TAP device name was supplied for the host networking interface"));
6109 }
6110
6111 if (SUCCEEDED(rc))
6112 {
6113 /* If we are using a static TAP device then try to open it. */
6114 Utf8Str str(tapDeviceName);
6115 if (str.length() <= sizeof(IfReq.ifr_name))
6116 strcpy(IfReq.ifr_name, str.raw());
6117 else
6118 memcpy(IfReq.ifr_name, str.raw(), sizeof(IfReq.ifr_name) - 1); /** @todo bitch about names which are too long... */
6119 IfReq.ifr_flags = IFF_TAP | IFF_NO_PI;
6120 rcVBox = ioctl(maTapFD[slot], TUNSETIFF, &IfReq);
6121 if (rcVBox != 0)
6122 {
6123 LogRel(("Failed to open the host network interface %ls\n", tapDeviceName.raw()));
6124 rc = setError(E_FAIL, tr ("Failed to open the host network interface %ls"),
6125 tapDeviceName.raw());
6126 }
6127 }
6128 if (SUCCEEDED(rc))
6129 {
6130 /*
6131 * Make it pollable.
6132 */
6133 if (fcntl(maTapFD[slot], F_SETFL, O_NONBLOCK) != -1)
6134 {
6135 Log(("attachToTapInterface: %RTfile %ls\n", maTapFD[slot], tapDeviceName.raw()));
6136 /*
6137 * Here is the right place to communicate the TAP file descriptor and
6138 * the host interface name to the server if/when it becomes really
6139 * necessary.
6140 */
6141 maTAPDeviceName[slot] = tapDeviceName;
6142 rcVBox = VINF_SUCCESS;
6143 }
6144 else
6145 {
6146 int iErr = errno;
6147
6148 LogRel(("Configuration error: Failed to configure /dev/net/tun non blocking. Error: %s\n", strerror(iErr)));
6149 rcVBox = VERR_HOSTIF_BLOCKING;
6150 rc = setError(E_FAIL, tr ("could not set up the host networking device for non blocking access: %s"),
6151 strerror(errno));
6152 }
6153 }
6154 }
6155 else
6156 {
6157 LogRel(("Configuration error: Failed to open /dev/net/tun rc=%Rrc\n", rcVBox));
6158 switch (rcVBox)
6159 {
6160 case VERR_ACCESS_DENIED:
6161 /* will be handled by our caller */
6162 rc = rcVBox;
6163 break;
6164 default:
6165 rc = setError(E_FAIL, tr ("Could not set up the host networking device: %Rrc"), rcVBox);
6166 break;
6167 }
6168 }
6169
6170# elif defined(RT_OS_FREEBSD)
6171 /*
6172 * Set/obtain the tap interface.
6173 */
6174 /* The name of the TAP interface we are using */
6175 Bstr tapDeviceName;
6176 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
6177 if (FAILED(rc))
6178 tapDeviceName.setNull(); /* Is this necessary? */
6179 if (tapDeviceName.isEmpty())
6180 {
6181 LogRel(("No TAP device name was supplied.\n"));
6182 rc = setError(E_FAIL, tr ("No TAP device name was supplied for the host networking interface"));
6183 }
6184 char szTapdev[1024] = "/dev/";
6185 /* If we are using a static TAP device then try to open it. */
6186 Utf8Str str(tapDeviceName);
6187 if (str.length() + strlen(szTapdev) <= sizeof(szTapdev))
6188 strcat(szTapdev, str.raw());
6189 else
6190 memcpy(szTapdev + strlen(szTapdev), str.raw(), sizeof(szTapdev) - strlen(szTapdev) - 1); /** @todo bitch about names which are too long... */
6191 int rcVBox = RTFileOpen(&maTapFD[slot], szTapdev,
6192 RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_INHERIT | RTFILE_O_NON_BLOCK);
6193
6194 if (RT_SUCCESS(rcVBox))
6195 maTAPDeviceName[slot] = tapDeviceName;
6196 else
6197 {
6198 switch (rcVBox)
6199 {
6200 case VERR_ACCESS_DENIED:
6201 /* will be handled by our caller */
6202 rc = rcVBox;
6203 break;
6204 default:
6205 rc = setError(E_FAIL, tr ("Failed to open the host network interface %ls"),
6206 tapDeviceName.raw());
6207 break;
6208 }
6209 }
6210# else
6211# error "huh?"
6212# endif
6213 /* in case of failure, cleanup. */
6214 if (VBOX_FAILURE(rcVBox) && SUCCEEDED(rc))
6215 {
6216 LogRel(("General failure attaching to host interface\n"));
6217 rc = setError(E_FAIL, tr ("General failure attaching to host interface"));
6218 }
6219 LogFlowThisFunc(("rc=%d\n", rc));
6220 return rc;
6221}
6222
6223
6224/**
6225 * Helper function to handle detachment from a host interface
6226 *
6227 * @param networkAdapter the network adapter which attachment should be reset
6228 * @return COM status code
6229 *
6230 * @note The caller must lock this object for writing.
6231 *
6232 * @todo Move this back into the driver!
6233 */
6234HRESULT Console::detachFromTapInterface(INetworkAdapter *networkAdapter)
6235{
6236 /* sanity check */
6237 LogFlowThisFunc(("\n"));
6238 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
6239
6240 HRESULT rc = S_OK;
6241# ifdef VBOX_STRICT
6242 /* paranoia */
6243 NetworkAttachmentType_T attachment;
6244 networkAdapter->COMGETTER(AttachmentType)(&attachment);
6245 Assert(attachment == NetworkAttachmentType_Bridged);
6246# endif /* VBOX_STRICT */
6247
6248 ULONG slot = 0;
6249 rc = networkAdapter->COMGETTER(Slot)(&slot);
6250 AssertComRC(rc);
6251
6252 /* is there an open TAP device? */
6253 if (maTapFD[slot] != NIL_RTFILE)
6254 {
6255 /*
6256 * Close the file handle.
6257 */
6258 Bstr tapDeviceName, tapTerminateApplication;
6259 bool isStatic = true;
6260 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
6261 if (FAILED(rc) || tapDeviceName.isEmpty())
6262 {
6263 /* If the name is empty, this is a dynamic TAP device, so close it now,
6264 so that the termination script can remove the interface. Otherwise we still
6265 need the FD to pass to the termination script. */
6266 isStatic = false;
6267 int rcVBox = RTFileClose(maTapFD[slot]);
6268 AssertRC(rcVBox);
6269 maTapFD[slot] = NIL_RTFILE;
6270 }
6271 if (isStatic)
6272 {
6273 /* If we are using a static TAP device, we close it now, after having called the
6274 termination script. */
6275 int rcVBox = RTFileClose(maTapFD[slot]);
6276 AssertRC(rcVBox);
6277 }
6278 /* the TAP device name and handle are no longer valid */
6279 maTapFD[slot] = NIL_RTFILE;
6280 maTAPDeviceName[slot] = "";
6281 }
6282 LogFlowThisFunc(("returning %d\n", rc));
6283 return rc;
6284}
6285
6286#endif /* (RT_OS_LINUX || RT_OS_FREEBSD) && !VBOX_WITH_NETFLT */
6287
6288/**
6289 * Called at power down to terminate host interface networking.
6290 *
6291 * @note The caller must lock this object for writing.
6292 */
6293HRESULT Console::powerDownHostInterfaces()
6294{
6295 LogFlowThisFunc(("\n"));
6296
6297 /* sanity check */
6298 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
6299
6300 /*
6301 * host interface termination handling
6302 */
6303 HRESULT rc;
6304 for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
6305 {
6306 ComPtr<INetworkAdapter> networkAdapter;
6307 rc = mMachine->GetNetworkAdapter(slot, networkAdapter.asOutParam());
6308 CheckComRCBreakRC (rc);
6309
6310 BOOL enabled = FALSE;
6311 networkAdapter->COMGETTER(Enabled) (&enabled);
6312 if (!enabled)
6313 continue;
6314
6315 NetworkAttachmentType_T attachment;
6316 networkAdapter->COMGETTER(AttachmentType)(&attachment);
6317 if (attachment == NetworkAttachmentType_Bridged)
6318 {
6319#if defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)
6320 HRESULT rc2 = detachFromTapInterface(networkAdapter);
6321 if (FAILED(rc2) && SUCCEEDED(rc))
6322 rc = rc2;
6323#endif
6324 }
6325 }
6326
6327 return rc;
6328}
6329
6330
6331/**
6332 * Process callback handler for VMR3Load and VMR3Save.
6333 *
6334 * @param pVM The VM handle.
6335 * @param uPercent Completetion precentage (0-100).
6336 * @param pvUser Pointer to the VMProgressTask structure.
6337 * @return VINF_SUCCESS.
6338 */
6339/*static*/ DECLCALLBACK (int)
6340Console::stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser)
6341{
6342 VMProgressTask *task = static_cast <VMProgressTask *> (pvUser);
6343 AssertReturn(task, VERR_INVALID_PARAMETER);
6344
6345 /* update the progress object */
6346 if (task->mProgress)
6347 task->mProgress->setCurrentOperationProgress(uPercent);
6348
6349 return VINF_SUCCESS;
6350}
6351
6352/**
6353 * VM error callback function. Called by the various VM components.
6354 *
6355 * @param pVM VM handle. Can be NULL if an error occurred before
6356 * successfully creating a VM.
6357 * @param pvUser Pointer to the VMProgressTask structure.
6358 * @param rc VBox status code.
6359 * @param pszFormat Printf-like error message.
6360 * @param args Various number of arguments for the error message.
6361 *
6362 * @thread EMT, VMPowerUp...
6363 *
6364 * @note The VMProgressTask structure modified by this callback is not thread
6365 * safe.
6366 */
6367/* static */ DECLCALLBACK (void)
6368Console::setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
6369 const char *pszFormat, va_list args)
6370{
6371 VMProgressTask *task = static_cast <VMProgressTask *> (pvUser);
6372 AssertReturnVoid (task);
6373
6374 /* we ignore RT_SRC_POS_DECL arguments to avoid confusion of end-users */
6375 va_list va2;
6376 va_copy (va2, args); /* Have to make a copy here or GCC will break. */
6377
6378 /* append to the existing error message if any */
6379 if (task->mErrorMsg.length())
6380 task->mErrorMsg = Utf8StrFmt ("%s.\n%N (%Rrc)", task->mErrorMsg.raw(),
6381 pszFormat, &va2, rc, rc);
6382 else
6383 task->mErrorMsg = Utf8StrFmt ("%N (%Rrc)",
6384 pszFormat, &va2, rc, rc);
6385
6386 va_end (va2);
6387}
6388
6389/**
6390 * VM runtime error callback function.
6391 * See VMSetRuntimeError for the detailed description of parameters.
6392 *
6393 * @param pVM The VM handle.
6394 * @param pvUser The user argument.
6395 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
6396 * @param pszErrorId Error ID string.
6397 * @param pszFormat Error message format string.
6398 * @param va Error message arguments.
6399 * @thread EMT.
6400 */
6401/* static */ DECLCALLBACK(void)
6402Console::setVMRuntimeErrorCallback (PVM pVM, void *pvUser, uint32_t fFlags,
6403 const char *pszErrorId,
6404 const char *pszFormat, va_list va)
6405{
6406 bool const fFatal = !!(fFlags & VMSETRTERR_FLAGS_FATAL);
6407 LogFlowFuncEnter();
6408
6409 Console *that = static_cast <Console *> (pvUser);
6410 AssertReturnVoid (that);
6411
6412 Utf8Str message = Utf8StrFmtVA (pszFormat, va);
6413
6414 LogRel (("Console: VM runtime error: fatal=%RTbool, "
6415 "errorID=%s message=\"%s\"\n",
6416 fFatal, pszErrorId, message.raw()));
6417
6418 that->onRuntimeError (BOOL (fFatal), Bstr (pszErrorId), Bstr (message));
6419
6420 LogFlowFuncLeave();
6421}
6422
6423/**
6424 * Captures USB devices that match filters of the VM.
6425 * Called at VM startup.
6426 *
6427 * @param pVM The VM handle.
6428 *
6429 * @note The caller must lock this object for writing.
6430 */
6431HRESULT Console::captureUSBDevices (PVM pVM)
6432{
6433 LogFlowThisFunc(("\n"));
6434
6435 /* sanity check */
6436 ComAssertRet (isWriteLockOnCurrentThread(), E_FAIL);
6437
6438 /* If the machine has an USB controller, ask the USB proxy service to
6439 * capture devices */
6440 PPDMIBASE pBase;
6441 int vrc = PDMR3QueryLun (pVM, "usb-ohci", 0, 0, &pBase);
6442 if (VBOX_SUCCESS (vrc))
6443 {
6444 /* leave the lock before calling Host in VBoxSVC since Host may call
6445 * us back from under its lock (e.g. onUSBDeviceAttach()) which would
6446 * produce an inter-process dead-lock otherwise. */
6447 AutoWriteLock alock(this);
6448 alock.leave();
6449
6450 HRESULT hrc = mControl->AutoCaptureUSBDevices();
6451 ComAssertComRCRetRC (hrc);
6452 }
6453 else if ( vrc == VERR_PDM_DEVICE_NOT_FOUND
6454 || vrc == VERR_PDM_DEVICE_INSTANCE_NOT_FOUND)
6455 vrc = VINF_SUCCESS;
6456 else
6457 AssertRC (vrc);
6458
6459 return VBOX_SUCCESS (vrc) ? S_OK : E_FAIL;
6460}
6461
6462
6463/**
6464 * Detach all USB device which are attached to the VM for the
6465 * purpose of clean up and such like.
6466 *
6467 * @note The caller must lock this object for writing.
6468 */
6469void Console::detachAllUSBDevices (bool aDone)
6470{
6471 LogFlowThisFunc(("aDone=%RTbool\n", aDone));
6472
6473 /* sanity check */
6474 AssertReturnVoid (isWriteLockOnCurrentThread());
6475
6476 mUSBDevices.clear();
6477
6478 /* leave the lock before calling Host in VBoxSVC since Host may call
6479 * us back from under its lock (e.g. onUSBDeviceAttach()) which would
6480 * produce an inter-process dead-lock otherwise. */
6481 AutoWriteLock alock(this);
6482 alock.leave();
6483
6484 mControl->DetachAllUSBDevices (aDone);
6485}
6486
6487/**
6488 * @note Locks this object for writing.
6489 */
6490void Console::processRemoteUSBDevices (uint32_t u32ClientId, VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList)
6491{
6492 LogFlowThisFuncEnter();
6493 LogFlowThisFunc(("u32ClientId = %d, pDevList=%p, cbDevList = %d\n", u32ClientId, pDevList, cbDevList));
6494
6495 AutoCaller autoCaller(this);
6496 if (!autoCaller.isOk())
6497 {
6498 /* Console has been already uninitialized, deny request */
6499 AssertMsgFailed (("Temporary assertion to prove that it happens, "
6500 "please report to dmik\n"));
6501 LogFlowThisFunc(("Console is already uninitialized\n"));
6502 LogFlowThisFuncLeave();
6503 return;
6504 }
6505
6506 AutoWriteLock alock(this);
6507
6508 /*
6509 * Mark all existing remote USB devices as dirty.
6510 */
6511 RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6512 while (it != mRemoteUSBDevices.end())
6513 {
6514 (*it)->dirty (true);
6515 ++ it;
6516 }
6517
6518 /*
6519 * Process the pDevList and add devices those are not already in the mRemoteUSBDevices list.
6520 */
6521 /** @todo (sunlover) REMOTE_USB Strict validation of the pDevList. */
6522 VRDPUSBDEVICEDESC *e = pDevList;
6523
6524 /* The cbDevList condition must be checked first, because the function can
6525 * receive pDevList = NULL and cbDevList = 0 on client disconnect.
6526 */
6527 while (cbDevList >= 2 && e->oNext)
6528 {
6529 LogFlowThisFunc(("vendor %04X, product %04X, name = %s\n",
6530 e->idVendor, e->idProduct,
6531 e->oProduct? (char *)e + e->oProduct: ""));
6532
6533 bool fNewDevice = true;
6534
6535 it = mRemoteUSBDevices.begin();
6536 while (it != mRemoteUSBDevices.end())
6537 {
6538 if ((*it)->devId () == e->id
6539 && (*it)->clientId () == u32ClientId)
6540 {
6541 /* The device is already in the list. */
6542 (*it)->dirty (false);
6543 fNewDevice = false;
6544 break;
6545 }
6546
6547 ++ it;
6548 }
6549
6550 if (fNewDevice)
6551 {
6552 LogRel(("Remote USB: ++++ Vendor %04X. Product %04X. Name = [%s].\n",
6553 e->idVendor, e->idProduct, e->oProduct? (char *)e + e->oProduct: ""
6554 ));
6555
6556 /* Create the device object and add the new device to list. */
6557 ComObjPtr<RemoteUSBDevice> device;
6558 device.createObject();
6559 device->init (u32ClientId, e);
6560
6561 mRemoteUSBDevices.push_back (device);
6562
6563 /* Check if the device is ok for current USB filters. */
6564 BOOL fMatched = FALSE;
6565 ULONG fMaskedIfs = 0;
6566
6567 HRESULT hrc = mControl->RunUSBDeviceFilters(device, &fMatched, &fMaskedIfs);
6568
6569 AssertComRC (hrc);
6570
6571 LogFlowThisFunc(("USB filters return %d %#x\n", fMatched, fMaskedIfs));
6572
6573 if (fMatched)
6574 {
6575 hrc = onUSBDeviceAttach (device, NULL, fMaskedIfs);
6576
6577 /// @todo (r=dmik) warning reporting subsystem
6578
6579 if (hrc == S_OK)
6580 {
6581 LogFlowThisFunc(("Device attached\n"));
6582 device->captured (true);
6583 }
6584 }
6585 }
6586
6587 if (cbDevList < e->oNext)
6588 {
6589 LogWarningThisFunc(("cbDevList %d > oNext %d\n",
6590 cbDevList, e->oNext));
6591 break;
6592 }
6593
6594 cbDevList -= e->oNext;
6595
6596 e = (VRDPUSBDEVICEDESC *)((uint8_t *)e + e->oNext);
6597 }
6598
6599 /*
6600 * Remove dirty devices, that is those which are not reported by the server anymore.
6601 */
6602 for (;;)
6603 {
6604 ComObjPtr<RemoteUSBDevice> device;
6605
6606 RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6607 while (it != mRemoteUSBDevices.end())
6608 {
6609 if ((*it)->dirty ())
6610 {
6611 device = *it;
6612 break;
6613 }
6614
6615 ++ it;
6616 }
6617
6618 if (!device)
6619 {
6620 break;
6621 }
6622
6623 USHORT vendorId = 0;
6624 device->COMGETTER(VendorId) (&vendorId);
6625
6626 USHORT productId = 0;
6627 device->COMGETTER(ProductId) (&productId);
6628
6629 Bstr product;
6630 device->COMGETTER(Product) (product.asOutParam());
6631
6632 LogRel(("Remote USB: ---- Vendor %04X. Product %04X. Name = [%ls].\n",
6633 vendorId, productId, product.raw ()
6634 ));
6635
6636 /* Detach the device from VM. */
6637 if (device->captured ())
6638 {
6639 Bstr uuid;
6640 device->COMGETTER (Id) (uuid.asOutParam());
6641 onUSBDeviceDetach (uuid, NULL);
6642 }
6643
6644 /* And remove it from the list. */
6645 mRemoteUSBDevices.erase (it);
6646 }
6647
6648 LogFlowThisFuncLeave();
6649}
6650
6651/**
6652 * Thread function which starts the VM (also from saved state) and
6653 * track progress.
6654 *
6655 * @param Thread The thread id.
6656 * @param pvUser Pointer to a VMPowerUpTask structure.
6657 * @return VINF_SUCCESS (ignored).
6658 *
6659 * @note Locks the Console object for writing.
6660 */
6661/*static*/
6662DECLCALLBACK (int) Console::powerUpThread (RTTHREAD Thread, void *pvUser)
6663{
6664 LogFlowFuncEnter();
6665
6666 std::auto_ptr <VMPowerUpTask> task (static_cast <VMPowerUpTask *> (pvUser));
6667 AssertReturn(task.get(), VERR_INVALID_PARAMETER);
6668
6669 AssertReturn(!task->mConsole.isNull(), VERR_INVALID_PARAMETER);
6670 AssertReturn(!task->mProgress.isNull(), VERR_INVALID_PARAMETER);
6671
6672#if defined(RT_OS_WINDOWS)
6673 {
6674 /* initialize COM */
6675 HRESULT hrc = CoInitializeEx (NULL,
6676 COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE |
6677 COINIT_SPEED_OVER_MEMORY);
6678 LogFlowFunc (("CoInitializeEx()=%08X\n", hrc));
6679 }
6680#endif
6681
6682 HRESULT rc = S_OK;
6683 int vrc = VINF_SUCCESS;
6684
6685 /* Set up a build identifier so that it can be seen from core dumps what
6686 * exact build was used to produce the core. */
6687 static char saBuildID[40];
6688 RTStrPrintf(saBuildID, sizeof(saBuildID), "%s%s%s%s VirtualBox %s r%u %s%s%s%s",
6689 "BU", "IL", "DI", "D", VBOX_VERSION_STRING, RTBldCfgRevision(), "BU", "IL", "DI", "D");
6690
6691 ComObjPtr<Console> console = task->mConsole;
6692
6693 /* Note: no need to use addCaller() because VMPowerUpTask does that */
6694
6695 /* The lock is also used as a signal from the task initiator (which
6696 * releases it only after RTThreadCreate()) that we can start the job */
6697 AutoWriteLock alock(console);
6698
6699 /* sanity */
6700 Assert (console->mpVM == NULL);
6701
6702 try
6703 {
6704 /* wait for auto reset ops to complete so that we can successfully lock
6705 * the attached hard disks by calling LockMedia() below */
6706 for (VMPowerUpTask::ProgressList::const_iterator
6707 it = task->hardDiskProgresses.begin();
6708 it != task->hardDiskProgresses.end(); ++ it)
6709 {
6710 HRESULT rc2 = (*it)->WaitForCompletion (-1);
6711 AssertComRC (rc2);
6712 }
6713
6714 /* lock attached media. This method will also check their
6715 * accessibility. Note that the media will be unlocked automatically
6716 * by SessionMachine::setMachineState() when the VM is powered down. */
6717 rc = console->mControl->LockMedia();
6718 CheckComRCThrowRC (rc);
6719
6720#ifdef VBOX_WITH_VRDP
6721
6722 /* Create the VRDP server. In case of headless operation, this will
6723 * also create the framebuffer, required at VM creation.
6724 */
6725 ConsoleVRDPServer *server = console->consoleVRDPServer();
6726 Assert (server);
6727
6728 /// @todo (dmik)
6729 // does VRDP server call Console from the other thread?
6730 // Not sure, so leave the lock just in case
6731 alock.leave();
6732 vrc = server->Launch();
6733 alock.enter();
6734
6735 if (vrc == VERR_NET_ADDRESS_IN_USE)
6736 {
6737 Utf8Str errMsg;
6738 ULONG port = 0;
6739 console->mVRDPServer->COMGETTER(Port) (&port);
6740 errMsg = Utf8StrFmt (tr ("VRDP server port %d is already in use"),
6741 port);
6742 LogRel (("Warning: failed to launch VRDP server (%Rrc): '%s'\n",
6743 vrc, errMsg.raw()));
6744 }
6745 else if (RT_FAILURE (vrc))
6746 {
6747 Utf8Str errMsg;
6748 switch (vrc)
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 task->mIsSnapshot /*fContinueAfterwards*/,
7319 Console::stateProgressCallback,
7320 static_cast<VMProgressTask*>(task.get()));
7321 if (VBOX_FAILURE (vrc))
7322 {
7323 errMsg = Utf8StrFmt (
7324 Console::tr ("Failed to save the machine state to '%s' (%Rrc)"),
7325 task->mSavedStateFile.raw(), vrc);
7326 rc = E_FAIL;
7327 }
7328 }
7329
7330 /* lock the console once we're going to access it */
7331 AutoWriteLock thatLock (that);
7332
7333 if (SUCCEEDED(rc))
7334 {
7335 if (task->mIsSnapshot)
7336 do
7337 {
7338 LogFlowFunc(("Reattaching new differencing hard disks...\n"));
7339
7340 com::SafeIfaceArray<IHardDiskAttachment> atts;
7341 rc = that->mMachine->COMGETTER(HardDiskAttachments)(ComSafeArrayAsOutParam(atts));
7342 if (FAILED (rc))
7343 break;
7344 for (size_t i = 0; i < atts.size(); ++ i)
7345 {
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 = VMR3ReqCallWait(that->mpVM, VMCPUID_ANY,
7371 (PFNRT)reconfigureHardDisks, 5, that->mpVM, lInstance, enmController, atts[i], &rc);
7372 if (RT_FAILURE(vrc))
7373 {
7374 errMsg = Utf8StrFmt(Console::tr("%Rrc"), vrc);
7375 rc = E_FAIL;
7376 break;
7377 }
7378 if (FAILED(rc))
7379 break;
7380 }
7381 }
7382 while (0);
7383 }
7384
7385 /* finalize the procedure regardless of the result */
7386 if (task->mIsSnapshot)
7387 {
7388 /*
7389 * finalize the requested snapshot object.
7390 * This will reset the machine state to the state it had right
7391 * before calling mControl->BeginTakingSnapshot().
7392 */
7393 that->mControl->EndTakingSnapshot (SUCCEEDED(rc));
7394 }
7395 else
7396 {
7397 /*
7398 * finalize the requested save state procedure.
7399 * In case of success, the server will set the machine state to Saved;
7400 * in case of failure it will reset the it to the state it had right
7401 * before calling mControl->BeginSavingState().
7402 */
7403 that->mControl->EndSavingState (SUCCEEDED(rc));
7404 }
7405
7406 /* synchronize the state with the server */
7407 if (task->mIsSnapshot || FAILED (rc))
7408 {
7409 if (task->mLastMachineState == MachineState_Running)
7410 {
7411 /* restore the paused state if appropriate */
7412 that->setMachineStateLocally (MachineState_Paused);
7413 /* restore the running state if appropriate */
7414 that->Resume();
7415 }
7416 else
7417 that->setMachineStateLocally (task->mLastMachineState);
7418 }
7419 else
7420 {
7421 /*
7422 * The machine has been successfully saved, so power it down
7423 * (vmstateChangeCallback() will set state to Saved on success).
7424 * Note: we release the task's VM caller, otherwise it will
7425 * deadlock.
7426 */
7427 task->releaseVMCaller();
7428
7429 rc = that->powerDown();
7430 }
7431
7432 /* notify the progress object about operation completion */
7433 if (SUCCEEDED(rc))
7434 task->mProgress->notifyComplete (S_OK);
7435 else
7436 {
7437 if (errMsg.length())
7438 task->mProgress->notifyComplete(rc,
7439 COM_IIDOF(IConsole),
7440 Console::getComponentName(),
7441 errMsg.c_str());
7442 else
7443 task->mProgress->notifyComplete (rc);
7444 }
7445
7446 LogFlowFuncLeave();
7447 return VINF_SUCCESS;
7448}
7449
7450/**
7451 * Thread for powering down the Console.
7452 *
7453 * @param Thread The thread handle.
7454 * @param pvUser Pointer to the VMTask structure.
7455 * @return VINF_SUCCESS (ignored).
7456 *
7457 * @note Locks the Console object for writing.
7458 */
7459/*static*/
7460DECLCALLBACK (int) Console::powerDownThread (RTTHREAD Thread, void *pvUser)
7461{
7462 LogFlowFuncEnter();
7463
7464 std::auto_ptr <VMProgressTask> task (static_cast <VMProgressTask *> (pvUser));
7465 AssertReturn(task.get(), VERR_INVALID_PARAMETER);
7466
7467 AssertReturn(task->isOk(), VERR_GENERAL_FAILURE);
7468
7469 const ComObjPtr<Console> &that = task->mConsole;
7470
7471 /* Note: no need to use addCaller() to protect Console because VMTask does
7472 * that */
7473
7474 /* wait until the method tat started us returns */
7475 AutoWriteLock thatLock (that);
7476
7477 /* release VM caller to avoid the powerDown() deadlock */
7478 task->releaseVMCaller();
7479
7480 that->powerDown (task->mProgress);
7481
7482 LogFlowFuncLeave();
7483 return VINF_SUCCESS;
7484}
7485
7486/**
7487 * The Main status driver instance data.
7488 */
7489typedef struct DRVMAINSTATUS
7490{
7491 /** The LED connectors. */
7492 PDMILEDCONNECTORS ILedConnectors;
7493 /** Pointer to the LED ports interface above us. */
7494 PPDMILEDPORTS pLedPorts;
7495 /** Pointer to the array of LED pointers. */
7496 PPDMLED *papLeds;
7497 /** The unit number corresponding to the first entry in the LED array. */
7498 RTUINT iFirstLUN;
7499 /** The unit number corresponding to the last entry in the LED array.
7500 * (The size of the LED array is iLastLUN - iFirstLUN + 1.) */
7501 RTUINT iLastLUN;
7502} DRVMAINSTATUS, *PDRVMAINSTATUS;
7503
7504
7505/**
7506 * Notification about a unit which have been changed.
7507 *
7508 * The driver must discard any pointers to data owned by
7509 * the unit and requery it.
7510 *
7511 * @param pInterface Pointer to the interface structure containing the called function pointer.
7512 * @param iLUN The unit number.
7513 */
7514DECLCALLBACK(void) Console::drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN)
7515{
7516 PDRVMAINSTATUS pData = (PDRVMAINSTATUS)(void *)pInterface;
7517 if (iLUN >= pData->iFirstLUN && iLUN <= pData->iLastLUN)
7518 {
7519 PPDMLED pLed;
7520 int rc = pData->pLedPorts->pfnQueryStatusLed(pData->pLedPorts, iLUN, &pLed);
7521 if (VBOX_FAILURE(rc))
7522 pLed = NULL;
7523 ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLUN - pData->iFirstLUN], pLed);
7524 Log(("drvStatus_UnitChanged: iLUN=%d pLed=%p\n", iLUN, pLed));
7525 }
7526}
7527
7528
7529/**
7530 * Queries an interface to the driver.
7531 *
7532 * @returns Pointer to interface.
7533 * @returns NULL if the interface was not supported by the driver.
7534 * @param pInterface Pointer to this interface structure.
7535 * @param enmInterface The requested interface identification.
7536 */
7537DECLCALLBACK(void *) Console::drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
7538{
7539 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
7540 PDRVMAINSTATUS pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7541 switch (enmInterface)
7542 {
7543 case PDMINTERFACE_BASE:
7544 return &pDrvIns->IBase;
7545 case PDMINTERFACE_LED_CONNECTORS:
7546 return &pDrv->ILedConnectors;
7547 default:
7548 return NULL;
7549 }
7550}
7551
7552
7553/**
7554 * Destruct a status driver instance.
7555 *
7556 * @returns VBox status.
7557 * @param pDrvIns The driver instance data.
7558 */
7559DECLCALLBACK(void) Console::drvStatus_Destruct(PPDMDRVINS pDrvIns)
7560{
7561 PDRVMAINSTATUS pData = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7562 LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7563 if (pData->papLeds)
7564 {
7565 unsigned iLed = pData->iLastLUN - pData->iFirstLUN + 1;
7566 while (iLed-- > 0)
7567 ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLed], NULL);
7568 }
7569}
7570
7571
7572/**
7573 * Construct a status driver instance.
7574 *
7575 * @copydoc FNPDMDRVCONSTRUCT
7576 */
7577DECLCALLBACK(int) Console::drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle, uint32_t fFlags)
7578{
7579 PDRVMAINSTATUS pData = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7580 LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7581
7582 /*
7583 * Validate configuration.
7584 */
7585 if (!CFGMR3AreValuesValid(pCfgHandle, "papLeds\0First\0Last\0"))
7586 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
7587 AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
7588 ("Configuration error: Not possible to attach anything to this driver!\n"),
7589 VERR_PDM_DRVINS_NO_ATTACH);
7590
7591 /*
7592 * Data.
7593 */
7594 pDrvIns->IBase.pfnQueryInterface = Console::drvStatus_QueryInterface;
7595 pData->ILedConnectors.pfnUnitChanged = Console::drvStatus_UnitChanged;
7596
7597 /*
7598 * Read config.
7599 */
7600 int rc = CFGMR3QueryPtr(pCfgHandle, "papLeds", (void **)&pData->papLeds);
7601 if (VBOX_FAILURE(rc))
7602 {
7603 AssertMsgFailed(("Configuration error: Failed to query the \"papLeds\" value! rc=%Rrc\n", rc));
7604 return rc;
7605 }
7606
7607 rc = CFGMR3QueryU32(pCfgHandle, "First", &pData->iFirstLUN);
7608 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7609 pData->iFirstLUN = 0;
7610 else if (VBOX_FAILURE(rc))
7611 {
7612 AssertMsgFailed(("Configuration error: Failed to query the \"First\" value! rc=%Rrc\n", rc));
7613 return rc;
7614 }
7615
7616 rc = CFGMR3QueryU32(pCfgHandle, "Last", &pData->iLastLUN);
7617 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7618 pData->iLastLUN = 0;
7619 else if (VBOX_FAILURE(rc))
7620 {
7621 AssertMsgFailed(("Configuration error: Failed to query the \"Last\" value! rc=%Rrc\n", rc));
7622 return rc;
7623 }
7624 if (pData->iFirstLUN > pData->iLastLUN)
7625 {
7626 AssertMsgFailed(("Configuration error: Invalid unit range %u-%u\n", pData->iFirstLUN, pData->iLastLUN));
7627 return VERR_GENERAL_FAILURE;
7628 }
7629
7630 /*
7631 * Get the ILedPorts interface of the above driver/device and
7632 * query the LEDs we want.
7633 */
7634 pData->pLedPorts = (PPDMILEDPORTS)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_LED_PORTS);
7635 if (!pData->pLedPorts)
7636 {
7637 AssertMsgFailed(("Configuration error: No led ports interface above!\n"));
7638 return VERR_PDM_MISSING_INTERFACE_ABOVE;
7639 }
7640
7641 for (unsigned i = pData->iFirstLUN; i <= pData->iLastLUN; i++)
7642 Console::drvStatus_UnitChanged(&pData->ILedConnectors, i);
7643
7644 return VINF_SUCCESS;
7645}
7646
7647
7648/**
7649 * Keyboard driver registration record.
7650 */
7651const PDMDRVREG Console::DrvStatusReg =
7652{
7653 /* u32Version */
7654 PDM_DRVREG_VERSION,
7655 /* szDriverName */
7656 "MainStatus",
7657 /* pszDescription */
7658 "Main status driver (Main as in the API).",
7659 /* fFlags */
7660 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
7661 /* fClass. */
7662 PDM_DRVREG_CLASS_STATUS,
7663 /* cMaxInstances */
7664 ~0,
7665 /* cbInstance */
7666 sizeof(DRVMAINSTATUS),
7667 /* pfnConstruct */
7668 Console::drvStatus_Construct,
7669 /* pfnDestruct */
7670 Console::drvStatus_Destruct,
7671 /* pfnIOCtl */
7672 NULL,
7673 /* pfnPowerOn */
7674 NULL,
7675 /* pfnReset */
7676 NULL,
7677 /* pfnSuspend */
7678 NULL,
7679 /* pfnResume */
7680 NULL,
7681 /* pfnAttach */
7682 NULL,
7683 /* pfnDetach */
7684 NULL,
7685 /* pfnPowerOff */
7686 NULL,
7687 /* pfnSoftReset */
7688 NULL,
7689 /* u32EndVersion */
7690 PDM_DRVREG_VERSION
7691};
7692
7693/* 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