VirtualBox

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

Last change on this file since 12559 was 12523, checked in by vboxsync, 16 years ago

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