VirtualBox

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

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

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

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