VirtualBox

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

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

Main/Display: properly save/restore some important members, see xtracker 3927
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 231.2 KB
Line 
1/* $Id: ConsoleImpl.cpp 20021 2009-05-26 10:31:44Z 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 /* Get the properties we need from the adapter */
3184 BOOL fCableConnected;
3185 HRESULT rc = aNetworkAdapter->COMGETTER(CableConnected) (&fCableConnected);
3186 AssertComRC(rc);
3187 if (SUCCEEDED(rc))
3188 {
3189 ULONG ulInstance;
3190 rc = aNetworkAdapter->COMGETTER(Slot) (&ulInstance);
3191 AssertComRC (rc);
3192 if (SUCCEEDED (rc))
3193 {
3194 /*
3195 * Find the pcnet instance, get the config interface and update
3196 * the link state.
3197 */
3198 PPDMIBASE pBase;
3199 const char *cszAdapterName = "pcnet";
3200#ifdef VBOX_WITH_E1000
3201 /*
3202 * Perhaps it would be much wiser to wrap both 'pcnet' and 'e1000'
3203 * into generic 'net' device.
3204 */
3205 NetworkAdapterType_T adapterType;
3206 rc = aNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
3207 AssertComRC(rc);
3208 if (adapterType == NetworkAdapterType_I82540EM ||
3209 adapterType == NetworkAdapterType_I82543GC ||
3210 adapterType == NetworkAdapterType_I82545EM)
3211 cszAdapterName = "e1000";
3212#endif
3213 int vrc = PDMR3QueryDeviceLun (mpVM, cszAdapterName,
3214 (unsigned) ulInstance, 0, &pBase);
3215 ComAssertRC (vrc);
3216 if (VBOX_SUCCESS (vrc))
3217 {
3218 Assert(pBase);
3219 PPDMINETWORKCONFIG pINetCfg = (PPDMINETWORKCONFIG) pBase->
3220 pfnQueryInterface(pBase, PDMINTERFACE_NETWORK_CONFIG);
3221 if (pINetCfg)
3222 {
3223 Log (("Console::onNetworkAdapterChange: setting link state to %d\n",
3224 fCableConnected));
3225 vrc = pINetCfg->pfnSetLinkState (pINetCfg,
3226 fCableConnected ? PDMNETWORKLINKSTATE_UP
3227 : PDMNETWORKLINKSTATE_DOWN);
3228 ComAssertRC (vrc);
3229 }
3230 }
3231
3232 if (VBOX_FAILURE (vrc))
3233 rc = E_FAIL;
3234 }
3235 }
3236
3237 /* notify console callbacks on success */
3238 if (SUCCEEDED (rc))
3239 {
3240 CallbackList::iterator it = mCallbacks.begin();
3241 while (it != mCallbacks.end())
3242 (*it++)->OnNetworkAdapterChange (aNetworkAdapter);
3243 }
3244
3245 LogFlowThisFunc (("Leaving rc=%#x\n", rc));
3246 return rc;
3247}
3248
3249/**
3250 * Called by IInternalSessionControl::OnSerialPortChange().
3251 *
3252 * @note Locks this object for writing.
3253 */
3254HRESULT Console::onSerialPortChange (ISerialPort *aSerialPort)
3255{
3256 LogFlowThisFunc (("\n"));
3257
3258 AutoCaller autoCaller (this);
3259 AssertComRCReturnRC (autoCaller.rc());
3260
3261 AutoWriteLock alock (this);
3262
3263 /* Don't do anything if the VM isn't running */
3264 if (!mpVM)
3265 return S_OK;
3266
3267 HRESULT rc = S_OK;
3268
3269 /* protect mpVM */
3270 AutoVMCaller autoVMCaller (this);
3271 CheckComRCReturnRC (autoVMCaller.rc());
3272
3273 /* nothing to do so far */
3274
3275 /* notify console callbacks on success */
3276 if (SUCCEEDED (rc))
3277 {
3278 CallbackList::iterator it = mCallbacks.begin();
3279 while (it != mCallbacks.end())
3280 (*it++)->OnSerialPortChange (aSerialPort);
3281 }
3282
3283 LogFlowThisFunc (("Leaving rc=%#x\n", rc));
3284 return rc;
3285}
3286
3287/**
3288 * Called by IInternalSessionControl::OnParallelPortChange().
3289 *
3290 * @note Locks this object for writing.
3291 */
3292HRESULT Console::onParallelPortChange (IParallelPort *aParallelPort)
3293{
3294 LogFlowThisFunc (("\n"));
3295
3296 AutoCaller autoCaller (this);
3297 AssertComRCReturnRC (autoCaller.rc());
3298
3299 AutoWriteLock alock (this);
3300
3301 /* Don't do anything if the VM isn't running */
3302 if (!mpVM)
3303 return S_OK;
3304
3305 HRESULT rc = S_OK;
3306
3307 /* protect mpVM */
3308 AutoVMCaller autoVMCaller (this);
3309 CheckComRCReturnRC (autoVMCaller.rc());
3310
3311 /* nothing to do so far */
3312
3313 /* notify console callbacks on success */
3314 if (SUCCEEDED (rc))
3315 {
3316 CallbackList::iterator it = mCallbacks.begin();
3317 while (it != mCallbacks.end())
3318 (*it++)->OnParallelPortChange (aParallelPort);
3319 }
3320
3321 LogFlowThisFunc (("Leaving rc=%#x\n", rc));
3322 return rc;
3323}
3324
3325/**
3326 * Called by IInternalSessionControl::OnStorageControllerChange().
3327 *
3328 * @note Locks this object for writing.
3329 */
3330HRESULT Console::onStorageControllerChange ()
3331{
3332 LogFlowThisFunc (("\n"));
3333
3334 AutoCaller autoCaller (this);
3335 AssertComRCReturnRC (autoCaller.rc());
3336
3337 AutoWriteLock alock (this);
3338
3339 /* Don't do anything if the VM isn't running */
3340 if (!mpVM)
3341 return S_OK;
3342
3343 HRESULT rc = S_OK;
3344
3345 /* protect mpVM */
3346 AutoVMCaller autoVMCaller (this);
3347 CheckComRCReturnRC (autoVMCaller.rc());
3348
3349 /* nothing to do so far */
3350
3351 /* notify console callbacks on success */
3352 if (SUCCEEDED (rc))
3353 {
3354 CallbackList::iterator it = mCallbacks.begin();
3355 while (it != mCallbacks.end())
3356 (*it++)->OnStorageControllerChange ();
3357 }
3358
3359 LogFlowThisFunc (("Leaving rc=%#x\n", rc));
3360 return rc;
3361}
3362
3363/**
3364 * Called by IInternalSessionControl::OnVRDPServerChange().
3365 *
3366 * @note Locks this object for writing.
3367 */
3368HRESULT Console::onVRDPServerChange()
3369{
3370 AutoCaller autoCaller (this);
3371 AssertComRCReturnRC (autoCaller.rc());
3372
3373 AutoWriteLock alock (this);
3374
3375 HRESULT rc = S_OK;
3376
3377 if (mVRDPServer && mMachineState == MachineState_Running)
3378 {
3379 BOOL vrdpEnabled = FALSE;
3380
3381 rc = mVRDPServer->COMGETTER(Enabled) (&vrdpEnabled);
3382 ComAssertComRCRetRC (rc);
3383
3384 /* VRDP server may call this Console object back from other threads (VRDP INPUT or OUTPUT). */
3385 alock.leave();
3386
3387 if (vrdpEnabled)
3388 {
3389 // If there was no VRDP server started the 'stop' will do nothing.
3390 // However if a server was started and this notification was called,
3391 // we have to restart the server.
3392 mConsoleVRDPServer->Stop ();
3393
3394 if (VBOX_FAILURE(mConsoleVRDPServer->Launch ()))
3395 {
3396 rc = E_FAIL;
3397 }
3398 else
3399 {
3400 mConsoleVRDPServer->EnableConnections ();
3401 }
3402 }
3403 else
3404 {
3405 mConsoleVRDPServer->Stop ();
3406 }
3407
3408 alock.enter();
3409 }
3410
3411 /* notify console callbacks on success */
3412 if (SUCCEEDED (rc))
3413 {
3414 CallbackList::iterator it = mCallbacks.begin();
3415 while (it != mCallbacks.end())
3416 (*it++)->OnVRDPServerChange();
3417 }
3418
3419 return rc;
3420}
3421
3422/**
3423 * Called by IInternalSessionControl::OnUSBControllerChange().
3424 *
3425 * @note Locks this object for writing.
3426 */
3427HRESULT Console::onUSBControllerChange()
3428{
3429 LogFlowThisFunc (("\n"));
3430
3431 AutoCaller autoCaller (this);
3432 AssertComRCReturnRC (autoCaller.rc());
3433
3434 AutoWriteLock alock (this);
3435
3436 /* Ignore if no VM is running yet. */
3437 if (!mpVM)
3438 return S_OK;
3439
3440 HRESULT rc = S_OK;
3441
3442/// @todo (dmik)
3443// check for the Enabled state and disable virtual USB controller??
3444// Anyway, if we want to query the machine's USB Controller we need to cache
3445// it to mUSBController in #init() (as it is done with mDVDDrive).
3446//
3447// bird: While the VM supports hot-plugging, I doubt any guest can handle it at this time... :-)
3448//
3449// /* protect mpVM */
3450// AutoVMCaller autoVMCaller (this);
3451// CheckComRCReturnRC (autoVMCaller.rc());
3452
3453 /* notify console callbacks on success */
3454 if (SUCCEEDED (rc))
3455 {
3456 CallbackList::iterator it = mCallbacks.begin();
3457 while (it != mCallbacks.end())
3458 (*it++)->OnUSBControllerChange();
3459 }
3460
3461 return rc;
3462}
3463
3464/**
3465 * Called by IInternalSessionControl::OnSharedFolderChange().
3466 *
3467 * @note Locks this object for writing.
3468 */
3469HRESULT Console::onSharedFolderChange (BOOL aGlobal)
3470{
3471 LogFlowThisFunc (("aGlobal=%RTbool\n", aGlobal));
3472
3473 AutoCaller autoCaller (this);
3474 AssertComRCReturnRC (autoCaller.rc());
3475
3476 AutoWriteLock alock (this);
3477
3478 HRESULT rc = fetchSharedFolders (aGlobal);
3479
3480 /* notify console callbacks on success */
3481 if (SUCCEEDED (rc))
3482 {
3483 CallbackList::iterator it = mCallbacks.begin();
3484 while (it != mCallbacks.end())
3485 (*it++)->OnSharedFolderChange (aGlobal ? (Scope_T) Scope_Global
3486 : (Scope_T) Scope_Machine);
3487 }
3488
3489 return rc;
3490}
3491
3492/**
3493 * Called by IInternalSessionControl::OnUSBDeviceAttach() or locally by
3494 * processRemoteUSBDevices() after IInternalMachineControl::RunUSBDeviceFilters()
3495 * returns TRUE for a given remote USB device.
3496 *
3497 * @return S_OK if the device was attached to the VM.
3498 * @return failure if not attached.
3499 *
3500 * @param aDevice
3501 * The device in question.
3502 * @param aMaskedIfs
3503 * The interfaces to hide from the guest.
3504 *
3505 * @note Locks this object for writing.
3506 */
3507HRESULT Console::onUSBDeviceAttach (IUSBDevice *aDevice, IVirtualBoxErrorInfo *aError, ULONG aMaskedIfs)
3508{
3509#ifdef VBOX_WITH_USB
3510 LogFlowThisFunc (("aDevice=%p aError=%p\n", aDevice, aError));
3511
3512 AutoCaller autoCaller (this);
3513 ComAssertComRCRetRC (autoCaller.rc());
3514
3515 AutoWriteLock alock (this);
3516
3517 /* protect mpVM (we don't need error info, since it's a callback) */
3518 AutoVMCallerQuiet autoVMCaller (this);
3519 if (FAILED (autoVMCaller.rc()))
3520 {
3521 /* The VM may be no more operational when this message arrives
3522 * (e.g. it may be Saving or Stopping or just PoweredOff) --
3523 * autoVMCaller.rc() will return a failure in this case. */
3524 LogFlowThisFunc (("Attach request ignored (mMachineState=%d).\n",
3525 mMachineState));
3526 return autoVMCaller.rc();
3527 }
3528
3529 if (aError != NULL)
3530 {
3531 /* notify callbacks about the error */
3532 onUSBDeviceStateChange (aDevice, true /* aAttached */, aError);
3533 return S_OK;
3534 }
3535
3536 /* Don't proceed unless there's at least one USB hub. */
3537 if (!PDMR3USBHasHub (mpVM))
3538 {
3539 LogFlowThisFunc (("Attach request ignored (no USB controller).\n"));
3540 return E_FAIL;
3541 }
3542
3543 HRESULT rc = attachUSBDevice (aDevice, aMaskedIfs);
3544 if (FAILED (rc))
3545 {
3546 /* take the current error info */
3547 com::ErrorInfoKeeper eik;
3548 /* the error must be a VirtualBoxErrorInfo instance */
3549 ComPtr <IVirtualBoxErrorInfo> error = eik.takeError();
3550 Assert (!error.isNull());
3551 if (!error.isNull())
3552 {
3553 /* notify callbacks about the error */
3554 onUSBDeviceStateChange (aDevice, true /* aAttached */, error);
3555 }
3556 }
3557
3558 return rc;
3559
3560#else /* !VBOX_WITH_USB */
3561 return E_FAIL;
3562#endif /* !VBOX_WITH_USB */
3563}
3564
3565/**
3566 * Called by IInternalSessionControl::OnUSBDeviceDetach() and locally by
3567 * processRemoteUSBDevices().
3568 *
3569 * @note Locks this object for writing.
3570 */
3571HRESULT Console::onUSBDeviceDetach (IN_BSTR aId,
3572 IVirtualBoxErrorInfo *aError)
3573{
3574#ifdef VBOX_WITH_USB
3575 Guid Uuid (aId);
3576 LogFlowThisFunc (("aId={%RTuuid} aError=%p\n", Uuid.raw(), aError));
3577
3578 AutoCaller autoCaller (this);
3579 AssertComRCReturnRC (autoCaller.rc());
3580
3581 AutoWriteLock alock (this);
3582
3583 /* Find the device. */
3584 ComObjPtr <OUSBDevice> device;
3585 USBDeviceList::iterator it = mUSBDevices.begin();
3586 while (it != mUSBDevices.end())
3587 {
3588 LogFlowThisFunc (("it={%RTuuid}\n", (*it)->id().raw()));
3589 if ((*it)->id() == Uuid)
3590 {
3591 device = *it;
3592 break;
3593 }
3594 ++ it;
3595 }
3596
3597
3598 if (device.isNull())
3599 {
3600 LogFlowThisFunc (("USB device not found.\n"));
3601
3602 /* The VM may be no more operational when this message arrives
3603 * (e.g. it may be Saving or Stopping or just PoweredOff). Use
3604 * AutoVMCaller to detect it -- AutoVMCaller::rc() will return a
3605 * failure in this case. */
3606
3607 AutoVMCallerQuiet autoVMCaller (this);
3608 if (FAILED (autoVMCaller.rc()))
3609 {
3610 LogFlowThisFunc (("Detach request ignored (mMachineState=%d).\n",
3611 mMachineState));
3612 return autoVMCaller.rc();
3613 }
3614
3615 /* the device must be in the list otherwise */
3616 AssertFailedReturn (E_FAIL);
3617 }
3618
3619 if (aError != NULL)
3620 {
3621 /* notify callback about an error */
3622 onUSBDeviceStateChange (device, false /* aAttached */, aError);
3623 return S_OK;
3624 }
3625
3626 HRESULT rc = detachUSBDevice (it);
3627
3628 if (FAILED (rc))
3629 {
3630 /* take the current error info */
3631 com::ErrorInfoKeeper eik;
3632 /* the error must be a VirtualBoxErrorInfo instance */
3633 ComPtr <IVirtualBoxErrorInfo> error = eik.takeError();
3634 Assert (!error.isNull());
3635 if (!error.isNull())
3636 {
3637 /* notify callbacks about the error */
3638 onUSBDeviceStateChange (device, false /* aAttached */, error);
3639 }
3640 }
3641
3642 return rc;
3643
3644#else /* !VBOX_WITH_USB */
3645 return E_FAIL;
3646#endif /* !VBOX_WITH_USB */
3647}
3648
3649/**
3650 * @note Temporarily locks this object for writing.
3651 */
3652HRESULT Console::getGuestProperty (IN_BSTR aName, BSTR *aValue,
3653 ULONG64 *aTimestamp, BSTR *aFlags)
3654{
3655#if !defined (VBOX_WITH_GUEST_PROPS)
3656 ReturnComNotImplemented();
3657#else
3658 if (!VALID_PTR (aName))
3659 return E_INVALIDARG;
3660 if (!VALID_PTR (aValue))
3661 return E_POINTER;
3662 if ((aTimestamp != NULL) && !VALID_PTR (aTimestamp))
3663 return E_POINTER;
3664 if ((aFlags != NULL) && !VALID_PTR (aFlags))
3665 return E_POINTER;
3666
3667 AutoCaller autoCaller (this);
3668 AssertComRCReturnRC (autoCaller.rc());
3669
3670 /* protect mpVM (if not NULL) */
3671 AutoVMCallerWeak autoVMCaller (this);
3672 CheckComRCReturnRC (autoVMCaller.rc());
3673
3674 /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
3675 * autoVMCaller, so there is no need to hold a lock of this */
3676
3677 HRESULT rc = E_UNEXPECTED;
3678 using namespace guestProp;
3679
3680 VBOXHGCMSVCPARM parm[4];
3681 Utf8Str Utf8Name = aName;
3682 AssertReturn(!Utf8Name.isNull(), E_OUTOFMEMORY);
3683 char pszBuffer[MAX_VALUE_LEN + MAX_FLAGS_LEN];
3684
3685 parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
3686 /* To save doing a const cast, we use the mutableRaw() member. */
3687 parm[0].u.pointer.addr = Utf8Name.mutableRaw();
3688 /* The + 1 is the null terminator */
3689 parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
3690 parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
3691 parm[1].u.pointer.addr = pszBuffer;
3692 parm[1].u.pointer.size = sizeof(pszBuffer);
3693 int vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", GET_PROP_HOST,
3694 4, &parm[0]);
3695 /* The returned string should never be able to be greater than our buffer */
3696 AssertLogRel (vrc != VERR_BUFFER_OVERFLOW);
3697 AssertLogRel (RT_FAILURE(vrc) || VBOX_HGCM_SVC_PARM_64BIT == parm[2].type);
3698 if (RT_SUCCESS (vrc) || (VERR_NOT_FOUND == vrc))
3699 {
3700 rc = S_OK;
3701 if (vrc != VERR_NOT_FOUND)
3702 {
3703 size_t iFlags = strlen(pszBuffer) + 1;
3704 Utf8Str(pszBuffer).cloneTo (aValue);
3705 *aTimestamp = parm[2].u.uint64;
3706 Utf8Str(pszBuffer + iFlags).cloneTo (aFlags);
3707 }
3708 else
3709 aValue = NULL;
3710 }
3711 else
3712 rc = setError (E_UNEXPECTED,
3713 tr ("The service call failed with the error %Rrc"), vrc);
3714 return rc;
3715#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
3716}
3717
3718/**
3719 * @note Temporarily locks this object for writing.
3720 */
3721HRESULT Console::setGuestProperty (IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
3722{
3723#if !defined (VBOX_WITH_GUEST_PROPS)
3724 ReturnComNotImplemented();
3725#else
3726 if (!VALID_PTR (aName))
3727 return E_INVALIDARG;
3728 if ((aValue != NULL) && !VALID_PTR (aValue))
3729 return E_INVALIDARG;
3730 if ((aFlags != NULL) && !VALID_PTR (aFlags))
3731 return E_INVALIDARG;
3732
3733 AutoCaller autoCaller (this);
3734 AssertComRCReturnRC (autoCaller.rc());
3735
3736 /* protect mpVM (if not NULL) */
3737 AutoVMCallerWeak autoVMCaller (this);
3738 CheckComRCReturnRC (autoVMCaller.rc());
3739
3740 /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
3741 * autoVMCaller, so there is no need to hold a lock of this */
3742
3743 HRESULT rc = E_UNEXPECTED;
3744 using namespace guestProp;
3745
3746 VBOXHGCMSVCPARM parm[3];
3747 Utf8Str Utf8Name = aName;
3748 int vrc = VINF_SUCCESS;
3749
3750 parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
3751 /* To save doing a const cast, we use the mutableRaw() member. */
3752 parm[0].u.pointer.addr = Utf8Name.mutableRaw();
3753 /* The + 1 is the null terminator */
3754 parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
3755 Utf8Str Utf8Value = aValue;
3756 if (aValue != NULL)
3757 {
3758 parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
3759 /* To save doing a const cast, we use the mutableRaw() member. */
3760 parm[1].u.pointer.addr = Utf8Value.mutableRaw();
3761 /* The + 1 is the null terminator */
3762 parm[1].u.pointer.size = (uint32_t)Utf8Value.length() + 1;
3763 }
3764 Utf8Str Utf8Flags = aFlags;
3765 if (aFlags != NULL)
3766 {
3767 parm[2].type = VBOX_HGCM_SVC_PARM_PTR;
3768 /* To save doing a const cast, we use the mutableRaw() member. */
3769 parm[2].u.pointer.addr = Utf8Flags.mutableRaw();
3770 /* The + 1 is the null terminator */
3771 parm[2].u.pointer.size = (uint32_t)Utf8Flags.length() + 1;
3772 }
3773 if ((aValue != NULL) && (aFlags != NULL))
3774 vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", SET_PROP_HOST,
3775 3, &parm[0]);
3776 else if (aValue != NULL)
3777 vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", SET_PROP_VALUE_HOST,
3778 2, &parm[0]);
3779 else
3780 vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", DEL_PROP_HOST,
3781 1, &parm[0]);
3782 if (RT_SUCCESS (vrc))
3783 rc = S_OK;
3784 else
3785 rc = setError (E_UNEXPECTED,
3786 tr ("The service call failed with the error %Rrc"), vrc);
3787 return rc;
3788#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
3789}
3790
3791
3792/**
3793 * @note Temporarily locks this object for writing.
3794 */
3795HRESULT Console::enumerateGuestProperties (IN_BSTR aPatterns,
3796 ComSafeArrayOut(BSTR, aNames),
3797 ComSafeArrayOut(BSTR, aValues),
3798 ComSafeArrayOut(ULONG64, aTimestamps),
3799 ComSafeArrayOut(BSTR, aFlags))
3800{
3801#if !defined (VBOX_WITH_GUEST_PROPS)
3802 ReturnComNotImplemented();
3803#else
3804 if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
3805 return E_POINTER;
3806 if (ComSafeArrayOutIsNull (aNames))
3807 return E_POINTER;
3808 if (ComSafeArrayOutIsNull (aValues))
3809 return E_POINTER;
3810 if (ComSafeArrayOutIsNull (aTimestamps))
3811 return E_POINTER;
3812 if (ComSafeArrayOutIsNull (aFlags))
3813 return E_POINTER;
3814
3815 AutoCaller autoCaller (this);
3816 AssertComRCReturnRC (autoCaller.rc());
3817
3818 /* protect mpVM (if not NULL) */
3819 AutoVMCallerWeak autoVMCaller (this);
3820 CheckComRCReturnRC (autoVMCaller.rc());
3821
3822 /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
3823 * autoVMCaller, so there is no need to hold a lock of this */
3824
3825 return doEnumerateGuestProperties (aPatterns, ComSafeArrayOutArg(aNames),
3826 ComSafeArrayOutArg(aValues),
3827 ComSafeArrayOutArg(aTimestamps),
3828 ComSafeArrayOutArg(aFlags));
3829#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
3830}
3831
3832/**
3833 * Gets called by Session::UpdateMachineState()
3834 * (IInternalSessionControl::updateMachineState()).
3835 *
3836 * Must be called only in certain cases (see the implementation).
3837 *
3838 * @note Locks this object for writing.
3839 */
3840HRESULT Console::updateMachineState (MachineState_T aMachineState)
3841{
3842 AutoCaller autoCaller (this);
3843 AssertComRCReturnRC (autoCaller.rc());
3844
3845 AutoWriteLock alock (this);
3846
3847 AssertReturn (mMachineState == MachineState_Saving ||
3848 mMachineState == MachineState_Discarding,
3849 E_FAIL);
3850
3851 return setMachineStateLocally (aMachineState);
3852}
3853
3854/**
3855 * @note Locks this object for writing.
3856 */
3857void Console::onMousePointerShapeChange(bool fVisible, bool fAlpha,
3858 uint32_t xHot, uint32_t yHot,
3859 uint32_t width, uint32_t height,
3860 void *pShape)
3861{
3862#if 0
3863 LogFlowThisFuncEnter();
3864 LogFlowThisFunc (("fVisible=%d, fAlpha=%d, xHot = %d, yHot = %d, width=%d, "
3865 "height=%d, shape=%p\n",
3866 fVisible, fAlpha, xHot, yHot, width, height, pShape));
3867#endif
3868
3869 AutoCaller autoCaller (this);
3870 AssertComRCReturnVoid (autoCaller.rc());
3871
3872 /* We need a write lock because we alter the cached callback data */
3873 AutoWriteLock alock (this);
3874
3875 /* Save the callback arguments */
3876 mCallbackData.mpsc.visible = fVisible;
3877 mCallbackData.mpsc.alpha = fAlpha;
3878 mCallbackData.mpsc.xHot = xHot;
3879 mCallbackData.mpsc.yHot = yHot;
3880 mCallbackData.mpsc.width = width;
3881 mCallbackData.mpsc.height = height;
3882
3883 /* start with not valid */
3884 bool wasValid = mCallbackData.mpsc.valid;
3885 mCallbackData.mpsc.valid = false;
3886
3887 if (pShape != NULL)
3888 {
3889 size_t cb = (width + 7) / 8 * height; /* size of the AND mask */
3890 cb = ((cb + 3) & ~3) + width * 4 * height; /* + gap + size of the XOR mask */
3891 /* try to reuse the old shape buffer if the size is the same */
3892 if (!wasValid)
3893 mCallbackData.mpsc.shape = NULL;
3894 else
3895 if (mCallbackData.mpsc.shape != NULL && mCallbackData.mpsc.shapeSize != cb)
3896 {
3897 RTMemFree (mCallbackData.mpsc.shape);
3898 mCallbackData.mpsc.shape = NULL;
3899 }
3900 if (mCallbackData.mpsc.shape == NULL)
3901 {
3902 mCallbackData.mpsc.shape = (BYTE *) RTMemAllocZ (cb);
3903 AssertReturnVoid (mCallbackData.mpsc.shape);
3904 }
3905 mCallbackData.mpsc.shapeSize = cb;
3906 memcpy (mCallbackData.mpsc.shape, pShape, cb);
3907 }
3908 else
3909 {
3910 if (wasValid && mCallbackData.mpsc.shape != NULL)
3911 RTMemFree (mCallbackData.mpsc.shape);
3912 mCallbackData.mpsc.shape = NULL;
3913 mCallbackData.mpsc.shapeSize = 0;
3914 }
3915
3916 mCallbackData.mpsc.valid = true;
3917
3918 CallbackList::iterator it = mCallbacks.begin();
3919 while (it != mCallbacks.end())
3920 (*it++)->OnMousePointerShapeChange (fVisible, fAlpha, xHot, yHot,
3921 width, height, (BYTE *) pShape);
3922
3923#if 0
3924 LogFlowThisFuncLeave();
3925#endif
3926}
3927
3928/**
3929 * @note Locks this object for writing.
3930 */
3931void Console::onMouseCapabilityChange (BOOL supportsAbsolute, BOOL needsHostCursor)
3932{
3933 LogFlowThisFunc (("supportsAbsolute=%d needsHostCursor=%d\n",
3934 supportsAbsolute, needsHostCursor));
3935
3936 AutoCaller autoCaller (this);
3937 AssertComRCReturnVoid (autoCaller.rc());
3938
3939 /* We need a write lock because we alter the cached callback data */
3940 AutoWriteLock alock (this);
3941
3942 /* save the callback arguments */
3943 mCallbackData.mcc.supportsAbsolute = supportsAbsolute;
3944 mCallbackData.mcc.needsHostCursor = needsHostCursor;
3945 mCallbackData.mcc.valid = true;
3946
3947 CallbackList::iterator it = mCallbacks.begin();
3948 while (it != mCallbacks.end())
3949 {
3950 Log2(("Console::onMouseCapabilityChange: calling %p\n", (void*)*it));
3951 (*it++)->OnMouseCapabilityChange (supportsAbsolute, needsHostCursor);
3952 }
3953}
3954
3955/**
3956 * @note Locks this object for reading.
3957 */
3958void Console::onStateChange (MachineState_T machineState)
3959{
3960 AutoCaller autoCaller (this);
3961 AssertComRCReturnVoid (autoCaller.rc());
3962
3963 AutoReadLock alock (this);
3964
3965 CallbackList::iterator it = mCallbacks.begin();
3966 while (it != mCallbacks.end())
3967 (*it++)->OnStateChange (machineState);
3968}
3969
3970/**
3971 * @note Locks this object for reading.
3972 */
3973void Console::onAdditionsStateChange()
3974{
3975 AutoCaller autoCaller (this);
3976 AssertComRCReturnVoid (autoCaller.rc());
3977
3978 AutoReadLock alock (this);
3979
3980 CallbackList::iterator it = mCallbacks.begin();
3981 while (it != mCallbacks.end())
3982 (*it++)->OnAdditionsStateChange();
3983}
3984
3985/**
3986 * @note Locks this object for reading.
3987 */
3988void Console::onAdditionsOutdated()
3989{
3990 AutoCaller autoCaller (this);
3991 AssertComRCReturnVoid (autoCaller.rc());
3992
3993 AutoReadLock alock (this);
3994
3995 /** @todo Use the On-Screen Display feature to report the fact.
3996 * The user should be told to install additions that are
3997 * provided with the current VBox build:
3998 * VBOX_VERSION_MAJOR.VBOX_VERSION_MINOR.VBOX_VERSION_BUILD
3999 */
4000}
4001
4002/**
4003 * @note Locks this object for writing.
4004 */
4005void Console::onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock)
4006{
4007 AutoCaller autoCaller (this);
4008 AssertComRCReturnVoid (autoCaller.rc());
4009
4010 /* We need a write lock because we alter the cached callback data */
4011 AutoWriteLock alock (this);
4012
4013 /* save the callback arguments */
4014 mCallbackData.klc.numLock = fNumLock;
4015 mCallbackData.klc.capsLock = fCapsLock;
4016 mCallbackData.klc.scrollLock = fScrollLock;
4017 mCallbackData.klc.valid = true;
4018
4019 CallbackList::iterator it = mCallbacks.begin();
4020 while (it != mCallbacks.end())
4021 (*it++)->OnKeyboardLedsChange(fNumLock, fCapsLock, fScrollLock);
4022}
4023
4024/**
4025 * @note Locks this object for reading.
4026 */
4027void Console::onUSBDeviceStateChange (IUSBDevice *aDevice, bool aAttached,
4028 IVirtualBoxErrorInfo *aError)
4029{
4030 AutoCaller autoCaller (this);
4031 AssertComRCReturnVoid (autoCaller.rc());
4032
4033 AutoReadLock alock (this);
4034
4035 CallbackList::iterator it = mCallbacks.begin();
4036 while (it != mCallbacks.end())
4037 (*it++)->OnUSBDeviceStateChange (aDevice, aAttached, aError);
4038}
4039
4040/**
4041 * @note Locks this object for reading.
4042 */
4043void Console::onRuntimeError (BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage)
4044{
4045 AutoCaller autoCaller (this);
4046 AssertComRCReturnVoid (autoCaller.rc());
4047
4048 AutoReadLock alock (this);
4049
4050 CallbackList::iterator it = mCallbacks.begin();
4051 while (it != mCallbacks.end())
4052 (*it++)->OnRuntimeError (aFatal, aErrorID, aMessage);
4053}
4054
4055/**
4056 * @note Locks this object for reading.
4057 */
4058HRESULT Console::onShowWindow (BOOL aCheck, BOOL *aCanShow, ULONG64 *aWinId)
4059{
4060 AssertReturn (aCanShow, E_POINTER);
4061 AssertReturn (aWinId, E_POINTER);
4062
4063 *aCanShow = FALSE;
4064 *aWinId = 0;
4065
4066 AutoCaller autoCaller (this);
4067 AssertComRCReturnRC (autoCaller.rc());
4068
4069 AutoReadLock alock (this);
4070
4071 HRESULT rc = S_OK;
4072 CallbackList::iterator it = mCallbacks.begin();
4073
4074 if (aCheck)
4075 {
4076 while (it != mCallbacks.end())
4077 {
4078 BOOL canShow = FALSE;
4079 rc = (*it++)->OnCanShowWindow (&canShow);
4080 AssertComRC (rc);
4081 if (FAILED (rc) || !canShow)
4082 return rc;
4083 }
4084 *aCanShow = TRUE;
4085 }
4086 else
4087 {
4088 while (it != mCallbacks.end())
4089 {
4090 ULONG64 winId = 0;
4091 rc = (*it++)->OnShowWindow (&winId);
4092 AssertComRC (rc);
4093 if (FAILED (rc))
4094 return rc;
4095 /* only one callback may return non-null winId */
4096 Assert (*aWinId == 0 || winId == 0);
4097 if (*aWinId == 0)
4098 *aWinId = winId;
4099 }
4100 }
4101
4102 return S_OK;
4103}
4104
4105// private methods
4106////////////////////////////////////////////////////////////////////////////////
4107
4108/**
4109 * Increases the usage counter of the mpVM pointer. Guarantees that
4110 * VMR3Destroy() will not be called on it at least until releaseVMCaller()
4111 * is called.
4112 *
4113 * If this method returns a failure, the caller is not allowed to use mpVM
4114 * and may return the failed result code to the upper level. This method sets
4115 * the extended error info on failure if \a aQuiet is false.
4116 *
4117 * Setting \a aQuiet to true is useful for methods that don't want to return
4118 * the failed result code to the caller when this method fails (e.g. need to
4119 * silently check for the mpVM availability).
4120 *
4121 * When mpVM is NULL but \a aAllowNullVM is true, a corresponding error will be
4122 * returned instead of asserting. Having it false is intended as a sanity check
4123 * for methods that have checked mMachineState and expect mpVM *NOT* to be NULL.
4124 *
4125 * @param aQuiet true to suppress setting error info
4126 * @param aAllowNullVM true to accept mpVM being NULL and return a failure
4127 * (otherwise this method will assert if mpVM is NULL)
4128 *
4129 * @note Locks this object for writing.
4130 */
4131HRESULT Console::addVMCaller (bool aQuiet /* = false */,
4132 bool aAllowNullVM /* = false */)
4133{
4134 AutoCaller autoCaller (this);
4135 AssertComRCReturnRC (autoCaller.rc());
4136
4137 AutoWriteLock alock (this);
4138
4139 if (mVMDestroying)
4140 {
4141 /* powerDown() is waiting for all callers to finish */
4142 return aQuiet ? E_ACCESSDENIED : setError (E_ACCESSDENIED,
4143 tr ("Virtual machine is being powered down"));
4144 }
4145
4146 if (mpVM == NULL)
4147 {
4148 Assert (aAllowNullVM == true);
4149
4150 /* The machine is not powered up */
4151 return aQuiet ? E_ACCESSDENIED : setError (E_ACCESSDENIED,
4152 tr ("Virtual machine is not powered up"));
4153 }
4154
4155 ++ mVMCallers;
4156
4157 return S_OK;
4158}
4159
4160/**
4161 * Decreases the usage counter of the mpVM pointer. Must always complete
4162 * the addVMCaller() call after the mpVM pointer is no more necessary.
4163 *
4164 * @note Locks this object for writing.
4165 */
4166void Console::releaseVMCaller()
4167{
4168 AutoCaller autoCaller (this);
4169 AssertComRCReturnVoid (autoCaller.rc());
4170
4171 AutoWriteLock alock (this);
4172
4173 AssertReturnVoid (mpVM != NULL);
4174
4175 Assert (mVMCallers > 0);
4176 -- mVMCallers;
4177
4178 if (mVMCallers == 0 && mVMDestroying)
4179 {
4180 /* inform powerDown() there are no more callers */
4181 RTSemEventSignal (mVMZeroCallersSem);
4182 }
4183}
4184
4185/**
4186 * Initialize the release logging facility. In case something
4187 * goes wrong, there will be no release logging. Maybe in the future
4188 * we can add some logic to use different file names in this case.
4189 * Note that the logic must be in sync with Machine::DeleteSettings().
4190 */
4191HRESULT Console::consoleInitReleaseLog (const ComPtr <IMachine> aMachine)
4192{
4193 HRESULT hrc = S_OK;
4194
4195 Bstr logFolder;
4196 hrc = aMachine->COMGETTER(LogFolder) (logFolder.asOutParam());
4197 CheckComRCReturnRC (hrc);
4198
4199 Utf8Str logDir = logFolder;
4200
4201 /* make sure the Logs folder exists */
4202 Assert (!logDir.isEmpty());
4203 if (!RTDirExists (logDir))
4204 RTDirCreateFullPath (logDir, 0777);
4205
4206 Utf8Str logFile = Utf8StrFmt ("%s%cVBox.log",
4207 logDir.raw(), RTPATH_DELIMITER);
4208 Utf8Str pngFile = Utf8StrFmt ("%s%cVBox.png",
4209 logDir.raw(), RTPATH_DELIMITER);
4210
4211 /*
4212 * Age the old log files
4213 * Rename .(n-1) to .(n), .(n-2) to .(n-1), ..., and the last log file to .1
4214 * Overwrite target files in case they exist.
4215 */
4216 ComPtr<IVirtualBox> virtualBox;
4217 aMachine->COMGETTER(Parent)(virtualBox.asOutParam());
4218 ComPtr <ISystemProperties> systemProperties;
4219 virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
4220 ULONG uLogHistoryCount = 3;
4221 systemProperties->COMGETTER(LogHistoryCount)(&uLogHistoryCount);
4222 if (uLogHistoryCount)
4223 {
4224 for (int i = uLogHistoryCount-1; i >= 0; i--)
4225 {
4226 Utf8Str *files[] = { &logFile, &pngFile };
4227 Utf8Str oldName, newName;
4228
4229 for (unsigned int j = 0; j < RT_ELEMENTS (files); ++ j)
4230 {
4231 if (i > 0)
4232 oldName = Utf8StrFmt ("%s.%d", files [j]->raw(), i);
4233 else
4234 oldName = *files [j];
4235 newName = Utf8StrFmt ("%s.%d", files [j]->raw(), i + 1);
4236 /* If the old file doesn't exist, delete the new file (if it
4237 * exists) to provide correct rotation even if the sequence is
4238 * broken */
4239 if ( RTFileRename (oldName, newName, RTFILEMOVE_FLAGS_REPLACE)
4240 == VERR_FILE_NOT_FOUND)
4241 RTFileDelete (newName);
4242 }
4243 }
4244 }
4245
4246 PRTLOGGER loggerRelease;
4247 static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
4248 RTUINT fFlags = RTLOGFLAGS_PREFIX_TIME_PROG;
4249#if defined (RT_OS_WINDOWS) || defined (RT_OS_OS2)
4250 fFlags |= RTLOGFLAGS_USECRLF;
4251#endif
4252 char szError[RTPATH_MAX + 128] = "";
4253 int vrc = RTLogCreateEx(&loggerRelease, fFlags, "all",
4254 "VBOX_RELEASE_LOG", RT_ELEMENTS(s_apszGroups), s_apszGroups,
4255 RTLOGDEST_FILE, szError, sizeof(szError), logFile.raw());
4256 if (RT_SUCCESS(vrc))
4257 {
4258 /* some introductory information */
4259 RTTIMESPEC timeSpec;
4260 char szTmp[256];
4261 RTTimeSpecToString(RTTimeNow(&timeSpec), szTmp, sizeof(szTmp));
4262 RTLogRelLogger(loggerRelease, 0, ~0U,
4263 "VirtualBox %s r%d %s (%s %s) release log\n"
4264 "Log opened %s\n",
4265 VBOX_VERSION_STRING, VBoxSVNRev (), VBOX_BUILD_TARGET,
4266 __DATE__, __TIME__, szTmp);
4267
4268 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szTmp, sizeof(szTmp));
4269 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4270 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Product: %s\n", szTmp);
4271 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szTmp, sizeof(szTmp));
4272 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4273 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Release: %s\n", szTmp);
4274 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szTmp, sizeof(szTmp));
4275 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4276 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Version: %s\n", szTmp);
4277 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_SERVICE_PACK, szTmp, sizeof(szTmp));
4278 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4279 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Service Pack: %s\n", szTmp);
4280 /* the package type is interesting for Linux distributions */
4281 char szExecName[RTPATH_MAX];
4282 char *pszExecName = RTProcGetExecutableName(szExecName, sizeof(szExecName));
4283 RTLogRelLogger(loggerRelease, 0, ~0U,
4284 "Executable: %s\n"
4285 "Process ID: %u\n"
4286 "Package type: %s"
4287#ifdef VBOX_OSE
4288 " (OSE)"
4289#endif
4290 "\n",
4291 pszExecName ? pszExecName : "unknown",
4292 RTProcSelf(),
4293 VBOX_PACKAGE_STRING);
4294
4295 /* register this logger as the release logger */
4296 RTLogRelSetDefaultInstance(loggerRelease);
4297 hrc = S_OK;
4298 }
4299 else
4300 hrc = setError (E_FAIL,
4301 tr ("Failed to open release log (%s, %Rrc)"), szError, vrc);
4302
4303 return hrc;
4304}
4305
4306/**
4307 * Common worker for PowerUp and PowerUpPaused.
4308 *
4309 * @returns COM status code.
4310 *
4311 * @param aProgress Where to return the progress object.
4312 * @param aPaused true if PowerUpPaused called.
4313 *
4314 * @todo move down to powerDown();
4315 */
4316HRESULT Console::powerUp (IProgress **aProgress, bool aPaused)
4317{
4318 if (aProgress == NULL)
4319 return E_POINTER;
4320
4321 LogFlowThisFuncEnter();
4322 LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
4323
4324 AutoCaller autoCaller (this);
4325 CheckComRCReturnRC (autoCaller.rc());
4326
4327 AutoWriteLock alock (this);
4328
4329 if (Global::IsOnlineOrTransient (mMachineState))
4330 return setError(VBOX_E_INVALID_VM_STATE,
4331 tr ("Virtual machine is already running or busy "
4332 "(machine state: %d)"), mMachineState);
4333
4334 HRESULT rc = S_OK;
4335
4336 /* the network cards will undergo a quick consistency check */
4337 for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
4338 {
4339 ComPtr<INetworkAdapter> adapter;
4340 mMachine->GetNetworkAdapter (slot, adapter.asOutParam());
4341 BOOL enabled = FALSE;
4342 adapter->COMGETTER(Enabled) (&enabled);
4343 if (!enabled)
4344 continue;
4345
4346 NetworkAttachmentType_T netattach;
4347 adapter->COMGETTER(AttachmentType)(&netattach);
4348 switch (netattach)
4349 {
4350 case NetworkAttachmentType_Bridged:
4351 {
4352#ifdef RT_OS_WINDOWS
4353 /* a valid host interface must have been set */
4354 Bstr hostif;
4355 adapter->COMGETTER(HostInterface)(hostif.asOutParam());
4356 if (!hostif)
4357 {
4358 return setError (VBOX_E_HOST_ERROR,
4359 tr ("VM cannot start because host interface networking "
4360 "requires a host interface name to be set"));
4361 }
4362 ComPtr<IVirtualBox> virtualBox;
4363 mMachine->COMGETTER(Parent)(virtualBox.asOutParam());
4364 ComPtr<IHost> host;
4365 virtualBox->COMGETTER(Host)(host.asOutParam());
4366 ComPtr<IHostNetworkInterface> hostInterface;
4367 if (!SUCCEEDED(host->FindHostNetworkInterfaceByName(hostif, hostInterface.asOutParam())))
4368 {
4369 return setError (VBOX_E_HOST_ERROR,
4370 tr ("VM cannot start because the host interface '%ls' "
4371 "does not exist"),
4372 hostif.raw());
4373 }
4374#endif /* RT_OS_WINDOWS */
4375 break;
4376 }
4377 default:
4378 break;
4379 }
4380 }
4381
4382 /* Read console data stored in the saved state file (if not yet done) */
4383 rc = loadDataFromSavedState();
4384 CheckComRCReturnRC (rc);
4385
4386 /* Check all types of shared folders and compose a single list */
4387 SharedFolderDataMap sharedFolders;
4388 {
4389 /* first, insert global folders */
4390 for (SharedFolderDataMap::const_iterator it = mGlobalSharedFolders.begin();
4391 it != mGlobalSharedFolders.end(); ++ it)
4392 sharedFolders [it->first] = it->second;
4393
4394 /* second, insert machine folders */
4395 for (SharedFolderDataMap::const_iterator it = mMachineSharedFolders.begin();
4396 it != mMachineSharedFolders.end(); ++ it)
4397 sharedFolders [it->first] = it->second;
4398
4399 /* third, insert console folders */
4400 for (SharedFolderMap::const_iterator it = mSharedFolders.begin();
4401 it != mSharedFolders.end(); ++ it)
4402 sharedFolders [it->first] = SharedFolderData(it->second->hostPath(), it->second->writable());
4403 }
4404
4405 Bstr savedStateFile;
4406
4407 /*
4408 * Saved VMs will have to prove that their saved states are kosher.
4409 */
4410 if (mMachineState == MachineState_Saved)
4411 {
4412 rc = mMachine->COMGETTER(StateFilePath) (savedStateFile.asOutParam());
4413 CheckComRCReturnRC (rc);
4414 ComAssertRet (!!savedStateFile, E_FAIL);
4415 int vrc = SSMR3ValidateFile (Utf8Str (savedStateFile));
4416 if (VBOX_FAILURE (vrc))
4417 return setError (VBOX_E_FILE_ERROR,
4418 tr ("VM cannot start because the saved state file '%ls' is invalid (%Rrc). "
4419 "Discard the saved state prior to starting the VM"),
4420 savedStateFile.raw(), vrc);
4421 }
4422
4423 /* create a progress object to track progress of this operation */
4424 ComObjPtr <Progress> powerupProgress;
4425 powerupProgress.createObject();
4426 Bstr progressDesc;
4427 if (mMachineState == MachineState_Saved)
4428 progressDesc = tr ("Restoring virtual machine");
4429 else
4430 progressDesc = tr ("Starting virtual machine");
4431 rc = powerupProgress->init (static_cast <IConsole *> (this),
4432 progressDesc, FALSE /* aCancelable */);
4433 CheckComRCReturnRC (rc);
4434
4435 /* setup task object and thread to carry out the operation
4436 * asynchronously */
4437
4438 std::auto_ptr <VMPowerUpTask> task (new VMPowerUpTask (this, powerupProgress));
4439 ComAssertComRCRetRC (task->rc());
4440
4441 task->mSetVMErrorCallback = setVMErrorCallback;
4442 task->mConfigConstructor = configConstructor;
4443 task->mSharedFolders = sharedFolders;
4444 task->mStartPaused = aPaused;
4445 if (mMachineState == MachineState_Saved)
4446 task->mSavedStateFile = savedStateFile;
4447
4448 /* Reset differencing hard disks for which autoReset is true */
4449 {
4450 com::SafeIfaceArray <IHardDiskAttachment> atts;
4451 rc = mMachine->
4452 COMGETTER(HardDiskAttachments) (ComSafeArrayAsOutParam (atts));
4453 CheckComRCReturnRC (rc);
4454
4455 for (size_t i = 0; i < atts.size(); ++ i)
4456 {
4457 ComPtr <IHardDisk> hardDisk;
4458 rc = atts [i]->COMGETTER(HardDisk) (hardDisk.asOutParam());
4459 CheckComRCReturnRC (rc);
4460
4461 /* save for later use on the powerup thread */
4462 task->hardDisks.push_back (hardDisk);
4463
4464 /* needs autoreset? */
4465 BOOL autoReset = FALSE;
4466 rc = hardDisk->COMGETTER(AutoReset)(&autoReset);
4467 CheckComRCReturnRC (rc);
4468
4469 if (autoReset)
4470 {
4471 ComPtr <IProgress> resetProgress;
4472 rc = hardDisk->Reset (resetProgress.asOutParam());
4473 CheckComRCReturnRC (rc);
4474
4475 /* save for later use on the powerup thread */
4476 task->hardDiskProgresses.push_back (resetProgress);
4477 }
4478 }
4479 }
4480
4481 rc = consoleInitReleaseLog (mMachine);
4482 CheckComRCReturnRC (rc);
4483
4484 /* pass the progress object to the caller if requested */
4485 if (aProgress)
4486 {
4487 if (task->hardDiskProgresses.size() == 0)
4488 {
4489 /* there are no other operations to track, return the powerup
4490 * progress only */
4491 powerupProgress.queryInterfaceTo (aProgress);
4492 }
4493 else
4494 {
4495 /* create a combined progress object */
4496 ComObjPtr <CombinedProgress> progress;
4497 progress.createObject();
4498 VMPowerUpTask::ProgressList progresses (task->hardDiskProgresses);
4499 progresses.push_back (ComPtr <IProgress> (powerupProgress));
4500 rc = progress->init (static_cast <IConsole *> (this),
4501 progressDesc, progresses.begin(),
4502 progresses.end());
4503 AssertComRCReturnRC (rc);
4504 progress.queryInterfaceTo (aProgress);
4505 }
4506 }
4507
4508 int vrc = RTThreadCreate (NULL, Console::powerUpThread, (void *) task.get(),
4509 0, RTTHREADTYPE_MAIN_WORKER, 0, "VMPowerUp");
4510
4511 ComAssertMsgRCRet (vrc, ("Could not create VMPowerUp thread (%Rrc)", vrc),
4512 E_FAIL);
4513
4514 /* task is now owned by powerUpThread(), so release it */
4515 task.release();
4516
4517 /* finally, set the state: no right to fail in this method afterwards
4518 * since we've already started the thread and it is now responsible for
4519 * any error reporting and appropriate state change! */
4520
4521 if (mMachineState == MachineState_Saved)
4522 setMachineState (MachineState_Restoring);
4523 else
4524 setMachineState (MachineState_Starting);
4525
4526 LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
4527 LogFlowThisFuncLeave();
4528 return S_OK;
4529}
4530
4531/**
4532 * Internal power off worker routine.
4533 *
4534 * This method may be called only at certain places with the following meaning
4535 * as shown below:
4536 *
4537 * - if the machine state is either Running or Paused, a normal
4538 * Console-initiated powerdown takes place (e.g. PowerDown());
4539 * - if the machine state is Saving, saveStateThread() has successfully done its
4540 * job;
4541 * - if the machine state is Starting or Restoring, powerUpThread() has failed
4542 * to start/load the VM;
4543 * - if the machine state is Stopping, the VM has powered itself off (i.e. not
4544 * as a result of the powerDown() call).
4545 *
4546 * Calling it in situations other than the above will cause unexpected behavior.
4547 *
4548 * Note that this method should be the only one that destroys mpVM and sets it
4549 * to NULL.
4550 *
4551 * @param aProgress Progress object to run (may be NULL).
4552 *
4553 * @note Locks this object for writing.
4554 *
4555 * @note Never call this method from a thread that called addVMCaller() or
4556 * instantiated an AutoVMCaller object; first call releaseVMCaller() or
4557 * release(). Otherwise it will deadlock.
4558 */
4559HRESULT Console::powerDown (Progress *aProgress /*= NULL*/)
4560{
4561 LogFlowThisFuncEnter();
4562
4563 AutoCaller autoCaller (this);
4564 AssertComRCReturnRC (autoCaller.rc());
4565
4566 AutoWriteLock alock (this);
4567
4568 /* Total # of steps for the progress object. Must correspond to the
4569 * number of "advance percent count" comments in this method! */
4570 enum { StepCount = 7 };
4571 /* current step */
4572 ULONG step = 0;
4573
4574 HRESULT rc = S_OK;
4575 int vrc = VINF_SUCCESS;
4576
4577 /* sanity */
4578 Assert (mVMDestroying == false);
4579
4580 Assert (mpVM != NULL);
4581
4582 AssertMsg (mMachineState == MachineState_Running ||
4583 mMachineState == MachineState_Paused ||
4584 mMachineState == MachineState_Stuck ||
4585 mMachineState == MachineState_Saving ||
4586 mMachineState == MachineState_Starting ||
4587 mMachineState == MachineState_Restoring ||
4588 mMachineState == MachineState_Stopping,
4589 ("Invalid machine state: %d\n", mMachineState));
4590
4591 LogRel (("Console::powerDown(): A request to power off the VM has been "
4592 "issued (mMachineState=%d, InUninit=%d)\n",
4593 mMachineState, autoCaller.state() == InUninit));
4594
4595 /* Check if we need to power off the VM. In case of mVMPoweredOff=true, the
4596 * VM has already powered itself off in vmstateChangeCallback() and is just
4597 * notifying Console about that. In case of Starting or Restoring,
4598 * powerUpThread() is calling us on failure, so the VM is already off at
4599 * that point. */
4600 if (!mVMPoweredOff &&
4601 (mMachineState == MachineState_Starting ||
4602 mMachineState == MachineState_Restoring))
4603 mVMPoweredOff = true;
4604
4605 /* go to Stopping state if not already there. Note that we don't go from
4606 * Saving/Restoring to Stopping because vmstateChangeCallback() needs it to
4607 * set the state to Saved on VMSTATE_TERMINATED. In terms of protecting from
4608 * inappropriate operations while leaving the lock below, Saving or
4609 * Restoring should be fine too */
4610 if (mMachineState != MachineState_Saving &&
4611 mMachineState != MachineState_Restoring &&
4612 mMachineState != MachineState_Stopping)
4613 setMachineState (MachineState_Stopping);
4614
4615 /* ----------------------------------------------------------------------
4616 * DONE with necessary state changes, perform the power down actions (it's
4617 * safe to leave the object lock now if needed)
4618 * ---------------------------------------------------------------------- */
4619
4620 /* Stop the VRDP server to prevent new clients connection while VM is being
4621 * powered off. */
4622 if (mConsoleVRDPServer)
4623 {
4624 LogFlowThisFunc (("Stopping VRDP server...\n"));
4625
4626 /* Leave the lock since EMT will call us back as addVMCaller()
4627 * in updateDisplayData(). */
4628 alock.leave();
4629
4630 mConsoleVRDPServer->Stop();
4631
4632 alock.enter();
4633 }
4634
4635 /* advance percent count */
4636 if (aProgress)
4637 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4638
4639#ifdef VBOX_WITH_HGCM
4640
4641# ifdef VBOX_WITH_GUEST_PROPS
4642
4643 /* Save all guest property store entries to the machine XML file */
4644 com::SafeArray <BSTR> namesOut;
4645 com::SafeArray <BSTR> valuesOut;
4646 com::SafeArray <ULONG64> timestampsOut;
4647 com::SafeArray <BSTR> flagsOut;
4648 Bstr pattern("");
4649 if (pattern.isNull())
4650 rc = E_OUTOFMEMORY;
4651 else
4652 rc = doEnumerateGuestProperties (Bstr (""), ComSafeArrayAsOutParam (namesOut),
4653 ComSafeArrayAsOutParam (valuesOut),
4654 ComSafeArrayAsOutParam (timestampsOut),
4655 ComSafeArrayAsOutParam (flagsOut));
4656 if (SUCCEEDED(rc))
4657 {
4658 try
4659 {
4660 std::vector <BSTR> names;
4661 std::vector <BSTR> values;
4662 std::vector <ULONG64> timestamps;
4663 std::vector <BSTR> flags;
4664 for (unsigned i = 0; i < namesOut.size(); ++i)
4665 {
4666 uint32_t fFlags;
4667 guestProp::validateFlags (Utf8Str(flagsOut[i]).raw(), &fFlags);
4668 if ( !( fFlags & guestProp::TRANSIENT)
4669 || (mMachineState == MachineState_Saving)
4670 )
4671 {
4672 names.push_back(namesOut[i]);
4673 values.push_back(valuesOut[i]);
4674 timestamps.push_back(timestampsOut[i]);
4675 flags.push_back(flagsOut[i]);
4676 }
4677 }
4678 com::SafeArray <BSTR> namesIn (names);
4679 com::SafeArray <BSTR> valuesIn (values);
4680 com::SafeArray <ULONG64> timestampsIn (timestamps);
4681 com::SafeArray <BSTR> flagsIn (flags);
4682 if ( namesIn.isNull()
4683 || valuesIn.isNull()
4684 || timestampsIn.isNull()
4685 || flagsIn.isNull()
4686 )
4687 throw std::bad_alloc();
4688 /* PushGuestProperties() calls DiscardSettings(), which calls us back */
4689 alock.leave();
4690 mControl->PushGuestProperties (ComSafeArrayAsInParam (namesIn),
4691 ComSafeArrayAsInParam (valuesIn),
4692 ComSafeArrayAsInParam (timestampsIn),
4693 ComSafeArrayAsInParam (flagsIn));
4694 alock.enter();
4695 }
4696 catch (std::bad_alloc)
4697 {
4698 rc = E_OUTOFMEMORY;
4699 }
4700 }
4701
4702 /* advance percent count */
4703 if (aProgress)
4704 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4705
4706# endif /* VBOX_WITH_GUEST_PROPS defined */
4707
4708 /* Shutdown HGCM services before stopping the guest, because they might
4709 * need a cleanup. */
4710 if (mVMMDev)
4711 {
4712 LogFlowThisFunc (("Shutdown HGCM...\n"));
4713
4714 /* Leave the lock since EMT will call us back as addVMCaller() */
4715 alock.leave();
4716
4717 mVMMDev->hgcmShutdown ();
4718
4719 alock.enter();
4720 }
4721
4722 /* advance percent count */
4723 if (aProgress)
4724 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4725
4726#endif /* VBOX_WITH_HGCM */
4727
4728 /* ----------------------------------------------------------------------
4729 * Now, wait for all mpVM callers to finish their work if there are still
4730 * some on other threads. NO methods that need mpVM (or initiate other calls
4731 * that need it) may be called after this point
4732 * ---------------------------------------------------------------------- */
4733
4734 if (mVMCallers > 0)
4735 {
4736 /* go to the destroying state to prevent from adding new callers */
4737 mVMDestroying = true;
4738
4739 /* lazy creation */
4740 if (mVMZeroCallersSem == NIL_RTSEMEVENT)
4741 RTSemEventCreate (&mVMZeroCallersSem);
4742
4743 LogFlowThisFunc (("Waiting for mpVM callers (%d) to drop to zero...\n",
4744 mVMCallers));
4745
4746 alock.leave();
4747
4748 RTSemEventWait (mVMZeroCallersSem, RT_INDEFINITE_WAIT);
4749
4750 alock.enter();
4751 }
4752
4753 /* advance percent count */
4754 if (aProgress)
4755 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4756
4757 vrc = VINF_SUCCESS;
4758
4759 /* Power off the VM if not already done that */
4760 if (!mVMPoweredOff)
4761 {
4762 LogFlowThisFunc (("Powering off the VM...\n"));
4763
4764 /* Leave the lock since EMT will call us back on VMR3PowerOff() */
4765 alock.leave();
4766
4767 vrc = VMR3PowerOff (mpVM);
4768
4769 /* Note that VMR3PowerOff() may fail here (invalid VMSTATE) if the
4770 * VM-(guest-)initiated power off happened in parallel a ms before this
4771 * call. So far, we let this error pop up on the user's side. */
4772
4773 alock.enter();
4774
4775 }
4776 else
4777 {
4778 /* reset the flag for further re-use */
4779 mVMPoweredOff = false;
4780 }
4781
4782 /* advance percent count */
4783 if (aProgress)
4784 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4785
4786 LogFlowThisFunc (("Ready for VM destruction.\n"));
4787
4788 /* If we are called from Console::uninit(), then try to destroy the VM even
4789 * on failure (this will most likely fail too, but what to do?..) */
4790 if (VBOX_SUCCESS (vrc) || autoCaller.state() == InUninit)
4791 {
4792 /* If the machine has an USB comtroller, release all USB devices
4793 * (symmetric to the code in captureUSBDevices()) */
4794 bool fHasUSBController = false;
4795 {
4796 PPDMIBASE pBase;
4797 int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
4798 if (VBOX_SUCCESS (vrc))
4799 {
4800 fHasUSBController = true;
4801 detachAllUSBDevices (false /* aDone */);
4802 }
4803 }
4804
4805 /* Now we've got to destroy the VM as well. (mpVM is not valid beyond
4806 * this point). We leave the lock before calling VMR3Destroy() because
4807 * it will result into calling destructors of drivers associated with
4808 * Console children which may in turn try to lock Console (e.g. by
4809 * instantiating SafeVMPtr to access mpVM). It's safe here because
4810 * mVMDestroying is set which should prevent any activity. */
4811
4812 /* Set mpVM to NULL early just in case if some old code is not using
4813 * addVMCaller()/releaseVMCaller(). */
4814 PVM pVM = mpVM;
4815 mpVM = NULL;
4816
4817 LogFlowThisFunc (("Destroying the VM...\n"));
4818
4819 alock.leave();
4820
4821 vrc = VMR3Destroy (pVM);
4822
4823 /* take the lock again */
4824 alock.enter();
4825
4826 /* advance percent count */
4827 if (aProgress)
4828 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4829
4830 if (VBOX_SUCCESS (vrc))
4831 {
4832 LogFlowThisFunc (("Machine has been destroyed (mMachineState=%d)\n",
4833 mMachineState));
4834 /* Note: the Console-level machine state change happens on the
4835 * VMSTATE_TERMINATE state change in vmstateChangeCallback(). If
4836 * powerDown() is called from EMT (i.e. from vmstateChangeCallback()
4837 * on receiving VM-initiated VMSTATE_OFF), VMSTATE_TERMINATE hasn't
4838 * occurred yet. This is okay, because mMachineState is already
4839 * Stopping in this case, so any other attempt to call PowerDown()
4840 * will be rejected. */
4841 }
4842 else
4843 {
4844 /* bad bad bad, but what to do? */
4845 mpVM = pVM;
4846 rc = setError (VBOX_E_VM_ERROR,
4847 tr ("Could not destroy the machine. (Error: %Rrc)"), vrc);
4848 }
4849
4850 /* Complete the detaching of the USB devices. */
4851 if (fHasUSBController)
4852 detachAllUSBDevices (true /* aDone */);
4853
4854 /* advance percent count */
4855 if (aProgress)
4856 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4857 }
4858 else
4859 {
4860 rc = setError (VBOX_E_VM_ERROR,
4861 tr ("Could not power off the machine. (Error: %Rrc)"), vrc);
4862 }
4863
4864 /* Finished with destruction. Note that if something impossible happened and
4865 * we've failed to destroy the VM, mVMDestroying will remain true and
4866 * mMachineState will be something like Stopping, so most Console methods
4867 * will return an error to the caller. */
4868 if (mpVM == NULL)
4869 mVMDestroying = false;
4870
4871 if (SUCCEEDED (rc))
4872 {
4873 /* uninit dynamically allocated members of mCallbackData */
4874 if (mCallbackData.mpsc.valid)
4875 {
4876 if (mCallbackData.mpsc.shape != NULL)
4877 RTMemFree (mCallbackData.mpsc.shape);
4878 }
4879 memset (&mCallbackData, 0, sizeof (mCallbackData));
4880 }
4881
4882 /* complete the progress */
4883 if (aProgress)
4884 aProgress->notifyComplete (rc);
4885
4886 LogFlowThisFuncLeave();
4887 return rc;
4888}
4889
4890/**
4891 * @note Locks this object for writing.
4892 */
4893HRESULT Console::setMachineState (MachineState_T aMachineState,
4894 bool aUpdateServer /* = true */)
4895{
4896 AutoCaller autoCaller (this);
4897 AssertComRCReturnRC (autoCaller.rc());
4898
4899 AutoWriteLock alock (this);
4900
4901 HRESULT rc = S_OK;
4902
4903 if (mMachineState != aMachineState)
4904 {
4905 LogFlowThisFunc (("machineState=%d\n", aMachineState));
4906 mMachineState = aMachineState;
4907
4908 /// @todo (dmik)
4909 // possibly, we need to redo onStateChange() using the dedicated
4910 // Event thread, like it is done in VirtualBox. This will make it
4911 // much safer (no deadlocks possible if someone tries to use the
4912 // console from the callback), however, listeners will lose the
4913 // ability to synchronously react to state changes (is it really
4914 // necessary??)
4915 LogFlowThisFunc (("Doing onStateChange()...\n"));
4916 onStateChange (aMachineState);
4917 LogFlowThisFunc (("Done onStateChange()\n"));
4918
4919 if (aUpdateServer)
4920 {
4921 /* Server notification MUST be done from under the lock; otherwise
4922 * the machine state here and on the server might go out of sync
4923 * whihc can lead to various unexpected results (like the machine
4924 * state being >= MachineState_Running on the server, while the
4925 * session state is already SessionState_Closed at the same time
4926 * there).
4927 *
4928 * Cross-lock conditions should be carefully watched out: calling
4929 * UpdateState we will require Machine and SessionMachine locks
4930 * (remember that here we're holding the Console lock here, and also
4931 * all locks that have been entered by the thread before calling
4932 * this method).
4933 */
4934 LogFlowThisFunc (("Doing mControl->UpdateState()...\n"));
4935 rc = mControl->UpdateState (aMachineState);
4936 LogFlowThisFunc (("mControl->UpdateState()=%08X\n", rc));
4937 }
4938 }
4939
4940 return rc;
4941}
4942
4943/**
4944 * Searches for a shared folder with the given logical name
4945 * in the collection of shared folders.
4946 *
4947 * @param aName logical name of the shared folder
4948 * @param aSharedFolder where to return the found object
4949 * @param aSetError whether to set the error info if the folder is
4950 * not found
4951 * @return
4952 * S_OK when found or E_INVALIDARG when not found
4953 *
4954 * @note The caller must lock this object for writing.
4955 */
4956HRESULT Console::findSharedFolder (CBSTR aName,
4957 ComObjPtr <SharedFolder> &aSharedFolder,
4958 bool aSetError /* = false */)
4959{
4960 /* sanity check */
4961 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
4962
4963 SharedFolderMap::const_iterator it = mSharedFolders.find (aName);
4964 if (it != mSharedFolders.end())
4965 {
4966 aSharedFolder = it->second;
4967 return S_OK;
4968 }
4969
4970 if (aSetError)
4971 setError (VBOX_E_FILE_ERROR,
4972 tr ("Could not find a shared folder named '%ls'."), aName);
4973
4974 return VBOX_E_FILE_ERROR;
4975}
4976
4977/**
4978 * Fetches the list of global or machine shared folders from the server.
4979 *
4980 * @param aGlobal true to fetch global folders.
4981 *
4982 * @note The caller must lock this object for writing.
4983 */
4984HRESULT Console::fetchSharedFolders (BOOL aGlobal)
4985{
4986 /* sanity check */
4987 AssertReturn (AutoCaller (this).state() == InInit ||
4988 isWriteLockOnCurrentThread(), E_FAIL);
4989
4990 /* protect mpVM (if not NULL) */
4991 AutoVMCallerQuietWeak autoVMCaller (this);
4992
4993 HRESULT rc = S_OK;
4994
4995 bool online = mpVM && autoVMCaller.isOk() && mVMMDev->isShFlActive();
4996
4997 if (aGlobal)
4998 {
4999 /// @todo grab & process global folders when they are done
5000 }
5001 else
5002 {
5003 SharedFolderDataMap oldFolders;
5004 if (online)
5005 oldFolders = mMachineSharedFolders;
5006
5007 mMachineSharedFolders.clear();
5008
5009 SafeIfaceArray <ISharedFolder> folders;
5010 rc = mMachine->COMGETTER(SharedFolders) (ComSafeArrayAsOutParam(folders));
5011 AssertComRCReturnRC (rc);
5012
5013 for (size_t i = 0; i < folders.size(); ++i)
5014 {
5015 ComPtr <ISharedFolder> folder = folders[i];
5016
5017 Bstr name;
5018 Bstr hostPath;
5019 BOOL writable;
5020
5021 rc = folder->COMGETTER(Name) (name.asOutParam());
5022 CheckComRCBreakRC (rc);
5023 rc = folder->COMGETTER(HostPath) (hostPath.asOutParam());
5024 CheckComRCBreakRC (rc);
5025 rc = folder->COMGETTER(Writable) (&writable);
5026
5027 mMachineSharedFolders.insert (std::make_pair (name, SharedFolderData (hostPath, writable)));
5028
5029 /* send changes to HGCM if the VM is running */
5030 /// @todo report errors as runtime warnings through VMSetError
5031 if (online)
5032 {
5033 SharedFolderDataMap::iterator it = oldFolders.find (name);
5034 if (it == oldFolders.end() || it->second.mHostPath != hostPath)
5035 {
5036 /* a new machine folder is added or
5037 * the existing machine folder is changed */
5038 if (mSharedFolders.find (name) != mSharedFolders.end())
5039 ; /* the console folder exists, nothing to do */
5040 else
5041 {
5042 /* remove the old machine folder (when changed)
5043 * or the global folder if any (when new) */
5044 if (it != oldFolders.end() ||
5045 mGlobalSharedFolders.find (name) !=
5046 mGlobalSharedFolders.end())
5047 rc = removeSharedFolder (name);
5048 /* create the new machine folder */
5049 rc = createSharedFolder (name, SharedFolderData (hostPath, writable));
5050 }
5051 }
5052 /* forget the processed (or identical) folder */
5053 if (it != oldFolders.end())
5054 oldFolders.erase (it);
5055
5056 rc = S_OK;
5057 }
5058 }
5059
5060 AssertComRCReturnRC (rc);
5061
5062 /* process outdated (removed) folders */
5063 /// @todo report errors as runtime warnings through VMSetError
5064 if (online)
5065 {
5066 for (SharedFolderDataMap::const_iterator it = oldFolders.begin();
5067 it != oldFolders.end(); ++ it)
5068 {
5069 if (mSharedFolders.find (it->first) != mSharedFolders.end())
5070 ; /* the console folder exists, nothing to do */
5071 else
5072 {
5073 /* remove the outdated machine folder */
5074 rc = removeSharedFolder (it->first);
5075 /* create the global folder if there is any */
5076 SharedFolderDataMap::const_iterator git =
5077 mGlobalSharedFolders.find (it->first);
5078 if (git != mGlobalSharedFolders.end())
5079 rc = createSharedFolder (git->first, git->second);
5080 }
5081 }
5082
5083 rc = S_OK;
5084 }
5085 }
5086
5087 return rc;
5088}
5089
5090/**
5091 * Searches for a shared folder with the given name in the list of machine
5092 * shared folders and then in the list of the global shared folders.
5093 *
5094 * @param aName Name of the folder to search for.
5095 * @param aIt Where to store the pointer to the found folder.
5096 * @return @c true if the folder was found and @c false otherwise.
5097 *
5098 * @note The caller must lock this object for reading.
5099 */
5100bool Console::findOtherSharedFolder (IN_BSTR aName,
5101 SharedFolderDataMap::const_iterator &aIt)
5102{
5103 /* sanity check */
5104 AssertReturn (isWriteLockOnCurrentThread(), false);
5105
5106 /* first, search machine folders */
5107 aIt = mMachineSharedFolders.find (aName);
5108 if (aIt != mMachineSharedFolders.end())
5109 return true;
5110
5111 /* second, search machine folders */
5112 aIt = mGlobalSharedFolders.find (aName);
5113 if (aIt != mGlobalSharedFolders.end())
5114 return true;
5115
5116 return false;
5117}
5118
5119/**
5120 * Calls the HGCM service to add a shared folder definition.
5121 *
5122 * @param aName Shared folder name.
5123 * @param aHostPath Shared folder path.
5124 *
5125 * @note Must be called from under AutoVMCaller and when mpVM != NULL!
5126 * @note Doesn't lock anything.
5127 */
5128HRESULT Console::createSharedFolder (CBSTR aName, SharedFolderData aData)
5129{
5130 ComAssertRet (aName && *aName, E_FAIL);
5131 ComAssertRet (aData.mHostPath, E_FAIL);
5132
5133 /* sanity checks */
5134 AssertReturn (mpVM, E_FAIL);
5135 AssertReturn (mVMMDev->isShFlActive(), E_FAIL);
5136
5137 VBOXHGCMSVCPARM parms[SHFL_CPARMS_ADD_MAPPING];
5138 SHFLSTRING *pFolderName, *pMapName;
5139 size_t cbString;
5140
5141 Log (("Adding shared folder '%ls' -> '%ls'\n", aName, aData.mHostPath.raw()));
5142
5143 cbString = (RTUtf16Len (aData.mHostPath) + 1) * sizeof (RTUTF16);
5144 if (cbString >= UINT16_MAX)
5145 return setError (E_INVALIDARG, tr ("The name is too long"));
5146 pFolderName = (SHFLSTRING *) RTMemAllocZ (sizeof (SHFLSTRING) + cbString);
5147 Assert (pFolderName);
5148 memcpy (pFolderName->String.ucs2, aData.mHostPath, cbString);
5149
5150 pFolderName->u16Size = (uint16_t)cbString;
5151 pFolderName->u16Length = (uint16_t)cbString - sizeof(RTUTF16);
5152
5153 parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
5154 parms[0].u.pointer.addr = pFolderName;
5155 parms[0].u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5156
5157 cbString = (RTUtf16Len (aName) + 1) * sizeof (RTUTF16);
5158 if (cbString >= UINT16_MAX)
5159 {
5160 RTMemFree (pFolderName);
5161 return setError (E_INVALIDARG, tr ("The host path is too long"));
5162 }
5163 pMapName = (SHFLSTRING *) RTMemAllocZ (sizeof(SHFLSTRING) + cbString);
5164 Assert (pMapName);
5165 memcpy (pMapName->String.ucs2, aName, cbString);
5166
5167 pMapName->u16Size = (uint16_t)cbString;
5168 pMapName->u16Length = (uint16_t)cbString - sizeof (RTUTF16);
5169
5170 parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
5171 parms[1].u.pointer.addr = pMapName;
5172 parms[1].u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5173
5174 parms[2].type = VBOX_HGCM_SVC_PARM_32BIT;
5175 parms[2].u.uint32 = aData.mWritable;
5176
5177 int vrc = mVMMDev->hgcmHostCall ("VBoxSharedFolders",
5178 SHFL_FN_ADD_MAPPING,
5179 SHFL_CPARMS_ADD_MAPPING, &parms[0]);
5180 RTMemFree (pFolderName);
5181 RTMemFree (pMapName);
5182
5183 if (VBOX_FAILURE (vrc))
5184 return setError (E_FAIL,
5185 tr ("Could not create a shared folder '%ls' "
5186 "mapped to '%ls' (%Rrc)"),
5187 aName, aData.mHostPath.raw(), vrc);
5188
5189 return S_OK;
5190}
5191
5192/**
5193 * Calls the HGCM service to remove the shared folder definition.
5194 *
5195 * @param aName Shared folder name.
5196 *
5197 * @note Must be called from under AutoVMCaller and when mpVM != NULL!
5198 * @note Doesn't lock anything.
5199 */
5200HRESULT Console::removeSharedFolder (CBSTR aName)
5201{
5202 ComAssertRet (aName && *aName, E_FAIL);
5203
5204 /* sanity checks */
5205 AssertReturn (mpVM, E_FAIL);
5206 AssertReturn (mVMMDev->isShFlActive(), E_FAIL);
5207
5208 VBOXHGCMSVCPARM parms;
5209 SHFLSTRING *pMapName;
5210 size_t cbString;
5211
5212 Log (("Removing shared folder '%ls'\n", aName));
5213
5214 cbString = (RTUtf16Len (aName) + 1) * sizeof (RTUTF16);
5215 if (cbString >= UINT16_MAX)
5216 return setError (E_INVALIDARG, tr ("The name is too long"));
5217 pMapName = (SHFLSTRING *) RTMemAllocZ (sizeof (SHFLSTRING) + cbString);
5218 Assert (pMapName);
5219 memcpy (pMapName->String.ucs2, aName, cbString);
5220
5221 pMapName->u16Size = (uint16_t)cbString;
5222 pMapName->u16Length = (uint16_t)cbString - sizeof (RTUTF16);
5223
5224 parms.type = VBOX_HGCM_SVC_PARM_PTR;
5225 parms.u.pointer.addr = pMapName;
5226 parms.u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5227
5228 int vrc = mVMMDev->hgcmHostCall ("VBoxSharedFolders",
5229 SHFL_FN_REMOVE_MAPPING,
5230 1, &parms);
5231 RTMemFree(pMapName);
5232 if (VBOX_FAILURE (vrc))
5233 return setError (E_FAIL,
5234 tr ("Could not remove the shared folder '%ls' (%Rrc)"),
5235 aName, vrc);
5236
5237 return S_OK;
5238}
5239
5240/**
5241 * VM state callback function. Called by the VMM
5242 * using its state machine states.
5243 *
5244 * Primarily used to handle VM initiated power off, suspend and state saving,
5245 * but also for doing termination completed work (VMSTATE_TERMINATE).
5246 *
5247 * In general this function is called in the context of the EMT.
5248 *
5249 * @param aVM The VM handle.
5250 * @param aState The new state.
5251 * @param aOldState The old state.
5252 * @param aUser The user argument (pointer to the Console object).
5253 *
5254 * @note Locks the Console object for writing.
5255 */
5256DECLCALLBACK(void)
5257Console::vmstateChangeCallback (PVM aVM, VMSTATE aState, VMSTATE aOldState,
5258 void *aUser)
5259{
5260 LogFlowFunc (("Changing state from %d to %d (aVM=%p)\n",
5261 aOldState, aState, aVM));
5262
5263 Console *that = static_cast <Console *> (aUser);
5264 AssertReturnVoid (that);
5265
5266 AutoCaller autoCaller (that);
5267
5268 /* Note that we must let this method proceed even if Console::uninit() has
5269 * been already called. In such case this VMSTATE change is a result of:
5270 * 1) powerDown() called from uninit() itself, or
5271 * 2) VM-(guest-)initiated power off. */
5272 AssertReturnVoid (autoCaller.isOk() ||
5273 autoCaller.state() == InUninit);
5274
5275 switch (aState)
5276 {
5277 /*
5278 * The VM has terminated
5279 */
5280 case VMSTATE_OFF:
5281 {
5282 AutoWriteLock alock (that);
5283
5284 if (that->mVMStateChangeCallbackDisabled)
5285 break;
5286
5287 /* Do we still think that it is running? It may happen if this is a
5288 * VM-(guest-)initiated shutdown/poweroff.
5289 */
5290 if (that->mMachineState != MachineState_Stopping &&
5291 that->mMachineState != MachineState_Saving &&
5292 that->mMachineState != MachineState_Restoring)
5293 {
5294 LogFlowFunc (("VM has powered itself off but Console still "
5295 "thinks it is running. Notifying.\n"));
5296
5297 /* prevent powerDown() from calling VMR3PowerOff() again */
5298 Assert (that->mVMPoweredOff == false);
5299 that->mVMPoweredOff = true;
5300
5301 /* we are stopping now */
5302 that->setMachineState (MachineState_Stopping);
5303
5304 /* Setup task object and thread to carry out the operation
5305 * asynchronously (if we call powerDown() right here but there
5306 * is one or more mpVM callers (added with addVMCaller()) we'll
5307 * deadlock).
5308 */
5309 std::auto_ptr <VMProgressTask> task (
5310 new VMProgressTask (that, NULL /* aProgress */,
5311 true /* aUsesVMPtr */));
5312
5313 /* If creating a task is falied, this can currently mean one of
5314 * two: either Console::uninit() has been called just a ms
5315 * before (so a powerDown() call is already on the way), or
5316 * powerDown() itself is being already executed. Just do
5317 * nothing.
5318 */
5319 if (!task->isOk())
5320 {
5321 LogFlowFunc (("Console is already being uninitialized.\n"));
5322 break;
5323 }
5324
5325 int vrc = RTThreadCreate (NULL, Console::powerDownThread,
5326 (void *) task.get(), 0,
5327 RTTHREADTYPE_MAIN_WORKER, 0,
5328 "VMPowerDown");
5329
5330 AssertMsgRCBreak (vrc,
5331 ("Could not create VMPowerDown thread (%Rrc)\n", vrc));
5332
5333 /* task is now owned by powerDownThread(), so release it */
5334 task.release();
5335 }
5336 break;
5337 }
5338
5339 /* The VM has been completely destroyed.
5340 *
5341 * Note: This state change can happen at two points:
5342 * 1) At the end of VMR3Destroy() if it was not called from EMT.
5343 * 2) At the end of vmR3EmulationThread if VMR3Destroy() was
5344 * called by EMT.
5345 */
5346 case VMSTATE_TERMINATED:
5347 {
5348 AutoWriteLock alock (that);
5349
5350 if (that->mVMStateChangeCallbackDisabled)
5351 break;
5352
5353 /* Terminate host interface networking. If aVM is NULL, we've been
5354 * manually called from powerUpThread() either before calling
5355 * VMR3Create() or after VMR3Create() failed, so no need to touch
5356 * networking.
5357 */
5358 if (aVM)
5359 that->powerDownHostInterfaces();
5360
5361 /* From now on the machine is officially powered down or remains in
5362 * the Saved state.
5363 */
5364 switch (that->mMachineState)
5365 {
5366 default:
5367 AssertFailed();
5368 /* fall through */
5369 case MachineState_Stopping:
5370 /* successfully powered down */
5371 that->setMachineState (MachineState_PoweredOff);
5372 break;
5373 case MachineState_Saving:
5374 /* successfully saved (note that the machine is already in
5375 * the Saved state on the server due to EndSavingState()
5376 * called from saveStateThread(), so only change the local
5377 * state) */
5378 that->setMachineStateLocally (MachineState_Saved);
5379 break;
5380 case MachineState_Starting:
5381 /* failed to start, but be patient: set back to PoweredOff
5382 * (for similarity with the below) */
5383 that->setMachineState (MachineState_PoweredOff);
5384 break;
5385 case MachineState_Restoring:
5386 /* failed to load the saved state file, but be patient: set
5387 * back to Saved (to preserve the saved state file) */
5388 that->setMachineState (MachineState_Saved);
5389 break;
5390 }
5391
5392 break;
5393 }
5394
5395 case VMSTATE_SUSPENDED:
5396 {
5397 if (aOldState == VMSTATE_RUNNING)
5398 {
5399 AutoWriteLock alock (that);
5400
5401 if (that->mVMStateChangeCallbackDisabled)
5402 break;
5403
5404 /* Change the machine state from Running to Paused */
5405 Assert (that->mMachineState == MachineState_Running);
5406 that->setMachineState (MachineState_Paused);
5407 }
5408
5409 break;
5410 }
5411
5412 case VMSTATE_RUNNING:
5413 {
5414 if (aOldState == VMSTATE_CREATED ||
5415 aOldState == VMSTATE_SUSPENDED)
5416 {
5417 AutoWriteLock alock (that);
5418
5419 if (that->mVMStateChangeCallbackDisabled)
5420 break;
5421
5422 /* Change the machine state from Starting, Restoring or Paused
5423 * to Running */
5424 Assert ( ( ( that->mMachineState == MachineState_Starting
5425 || that->mMachineState == MachineState_Paused)
5426 && aOldState == VMSTATE_CREATED)
5427 || ( ( that->mMachineState == MachineState_Restoring
5428 || that->mMachineState == MachineState_Paused)
5429 && aOldState == VMSTATE_SUSPENDED));
5430
5431 that->setMachineState (MachineState_Running);
5432 }
5433
5434 break;
5435 }
5436
5437 case VMSTATE_GURU_MEDITATION:
5438 {
5439 AutoWriteLock alock (that);
5440
5441 if (that->mVMStateChangeCallbackDisabled)
5442 break;
5443
5444 /* Guru respects only running VMs */
5445 Assert (Global::IsOnline (that->mMachineState));
5446
5447 that->setMachineState (MachineState_Stuck);
5448
5449 break;
5450 }
5451
5452 default: /* shut up gcc */
5453 break;
5454 }
5455}
5456
5457#ifdef VBOX_WITH_USB
5458
5459/**
5460 * Sends a request to VMM to attach the given host device.
5461 * After this method succeeds, the attached device will appear in the
5462 * mUSBDevices collection.
5463 *
5464 * @param aHostDevice device to attach
5465 *
5466 * @note Synchronously calls EMT.
5467 * @note Must be called from under this object's lock.
5468 */
5469HRESULT Console::attachUSBDevice (IUSBDevice *aHostDevice, ULONG aMaskedIfs)
5470{
5471 AssertReturn (aHostDevice, E_FAIL);
5472 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5473
5474 /* still want a lock object because we need to leave it */
5475 AutoWriteLock alock (this);
5476
5477 HRESULT hrc;
5478
5479 /*
5480 * Get the address and the Uuid, and call the pfnCreateProxyDevice roothub
5481 * method in EMT (using usbAttachCallback()).
5482 */
5483 Bstr BstrAddress;
5484 hrc = aHostDevice->COMGETTER (Address) (BstrAddress.asOutParam());
5485 ComAssertComRCRetRC (hrc);
5486
5487 Utf8Str Address (BstrAddress);
5488
5489 Bstr id;
5490 hrc = aHostDevice->COMGETTER (Id) (id.asOutParam());
5491 ComAssertComRCRetRC (hrc);
5492 Guid uuid(id);
5493
5494 BOOL fRemote = FALSE;
5495 hrc = aHostDevice->COMGETTER (Remote) (&fRemote);
5496 ComAssertComRCRetRC (hrc);
5497
5498 /* protect mpVM */
5499 AutoVMCaller autoVMCaller (this);
5500 CheckComRCReturnRC (autoVMCaller.rc());
5501
5502 LogFlowThisFunc (("Proxying USB device '%s' {%RTuuid}...\n",
5503 Address.raw(), uuid.ptr()));
5504
5505 /* leave the lock before a VMR3* call (EMT will call us back)! */
5506 alock.leave();
5507
5508/** @todo just do everything here and only wrap the PDMR3Usb call. That'll offload some notification stuff from the EMT thread. */
5509 PVMREQ pReq = NULL;
5510 int vrc = VMR3ReqCall (mpVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
5511 (PFNRT) usbAttachCallback, 6, this, aHostDevice, uuid.ptr(), fRemote, Address.raw(), aMaskedIfs);
5512 if (VBOX_SUCCESS (vrc))
5513 vrc = pReq->iStatus;
5514 VMR3ReqFree (pReq);
5515
5516 /* restore the lock */
5517 alock.enter();
5518
5519 /* hrc is S_OK here */
5520
5521 if (VBOX_FAILURE (vrc))
5522 {
5523 LogWarningThisFunc (("Failed to create proxy device for '%s' {%RTuuid} (%Rrc)\n",
5524 Address.raw(), uuid.ptr(), vrc));
5525
5526 switch (vrc)
5527 {
5528 case VERR_VUSB_NO_PORTS:
5529 hrc = setError (E_FAIL,
5530 tr ("Failed to attach the USB device. (No available ports on the USB controller)."));
5531 break;
5532 case VERR_VUSB_USBFS_PERMISSION:
5533 hrc = setError (E_FAIL,
5534 tr ("Not permitted to open the USB device, check usbfs options"));
5535 break;
5536 default:
5537 hrc = setError (E_FAIL,
5538 tr ("Failed to create a proxy device for the USB device. (Error: %Rrc)"), vrc);
5539 break;
5540 }
5541 }
5542
5543 return hrc;
5544}
5545
5546/**
5547 * USB device attach callback used by AttachUSBDevice().
5548 * Note that AttachUSBDevice() doesn't return until this callback is executed,
5549 * so we don't use AutoCaller and don't care about reference counters of
5550 * interface pointers passed in.
5551 *
5552 * @thread EMT
5553 * @note Locks the console object for writing.
5554 */
5555//static
5556DECLCALLBACK(int)
5557Console::usbAttachCallback (Console *that, IUSBDevice *aHostDevice, PCRTUUID aUuid, bool aRemote, const char *aAddress, ULONG aMaskedIfs)
5558{
5559 LogFlowFuncEnter();
5560 LogFlowFunc (("that={%p}\n", that));
5561
5562 AssertReturn (that && aUuid, VERR_INVALID_PARAMETER);
5563
5564 void *pvRemoteBackend = NULL;
5565 if (aRemote)
5566 {
5567 RemoteUSBDevice *pRemoteUSBDevice = static_cast <RemoteUSBDevice *> (aHostDevice);
5568 Guid guid (*aUuid);
5569
5570 pvRemoteBackend = that->consoleVRDPServer ()->USBBackendRequestPointer (pRemoteUSBDevice->clientId (), &guid);
5571 if (!pvRemoteBackend)
5572 return VERR_INVALID_PARAMETER; /* The clientId is invalid then. */
5573 }
5574
5575 USHORT portVersion = 1;
5576 HRESULT hrc = aHostDevice->COMGETTER(PortVersion)(&portVersion);
5577 AssertComRCReturn(hrc, VERR_GENERAL_FAILURE);
5578 Assert(portVersion == 1 || portVersion == 2);
5579
5580 int vrc = PDMR3USBCreateProxyDevice (that->mpVM, aUuid, aRemote, aAddress, pvRemoteBackend,
5581 portVersion == 1 ? VUSB_STDVER_11 : VUSB_STDVER_20, aMaskedIfs);
5582 if (VBOX_SUCCESS (vrc))
5583 {
5584 /* Create a OUSBDevice and add it to the device list */
5585 ComObjPtr <OUSBDevice> device;
5586 device.createObject();
5587 HRESULT hrc = device->init (aHostDevice);
5588 AssertComRC (hrc);
5589
5590 AutoWriteLock alock (that);
5591 that->mUSBDevices.push_back (device);
5592 LogFlowFunc (("Attached device {%RTuuid}\n", device->id().raw()));
5593
5594 /* notify callbacks */
5595 that->onUSBDeviceStateChange (device, true /* aAttached */, NULL);
5596 }
5597
5598 LogFlowFunc (("vrc=%Rrc\n", vrc));
5599 LogFlowFuncLeave();
5600 return vrc;
5601}
5602
5603/**
5604 * Sends a request to VMM to detach the given host device. After this method
5605 * succeeds, the detached device will disappear from the mUSBDevices
5606 * collection.
5607 *
5608 * @param aIt Iterator pointing to the device to detach.
5609 *
5610 * @note Synchronously calls EMT.
5611 * @note Must be called from under this object's lock.
5612 */
5613HRESULT Console::detachUSBDevice (USBDeviceList::iterator &aIt)
5614{
5615 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5616
5617 /* still want a lock object because we need to leave it */
5618 AutoWriteLock alock (this);
5619
5620 /* protect mpVM */
5621 AutoVMCaller autoVMCaller (this);
5622 CheckComRCReturnRC (autoVMCaller.rc());
5623
5624 /* if the device is attached, then there must at least one USB hub. */
5625 AssertReturn (PDMR3USBHasHub (mpVM), E_FAIL);
5626
5627 LogFlowThisFunc (("Detaching USB proxy device {%RTuuid}...\n",
5628 (*aIt)->id().raw()));
5629
5630 /* leave the lock before a VMR3* call (EMT will call us back)! */
5631 alock.leave();
5632
5633 PVMREQ pReq;
5634/** @todo just do everything here and only wrap the PDMR3Usb call. That'll offload some notification stuff from the EMT thread. */
5635 int vrc = VMR3ReqCall (mpVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
5636 (PFNRT) usbDetachCallback, 4,
5637 this, &aIt, (*aIt)->id().raw());
5638 if (VBOX_SUCCESS (vrc))
5639 vrc = pReq->iStatus;
5640 VMR3ReqFree (pReq);
5641
5642 ComAssertRCRet (vrc, E_FAIL);
5643
5644 return S_OK;
5645}
5646
5647/**
5648 * USB device detach callback used by DetachUSBDevice().
5649 * Note that DetachUSBDevice() doesn't return until this callback is executed,
5650 * so we don't use AutoCaller and don't care about reference counters of
5651 * interface pointers passed in.
5652 *
5653 * @thread EMT
5654 * @note Locks the console object for writing.
5655 */
5656//static
5657DECLCALLBACK(int)
5658Console::usbDetachCallback (Console *that, USBDeviceList::iterator *aIt, PCRTUUID aUuid)
5659{
5660 LogFlowFuncEnter();
5661 LogFlowFunc (("that={%p}\n", that));
5662
5663 AssertReturn (that && aUuid, VERR_INVALID_PARAMETER);
5664 ComObjPtr <OUSBDevice> device = **aIt;
5665
5666 /*
5667 * If that was a remote device, release the backend pointer.
5668 * The pointer was requested in usbAttachCallback.
5669 */
5670 BOOL fRemote = FALSE;
5671
5672 HRESULT hrc2 = (**aIt)->COMGETTER (Remote) (&fRemote);
5673 ComAssertComRC (hrc2);
5674
5675 if (fRemote)
5676 {
5677 Guid guid (*aUuid);
5678 that->consoleVRDPServer ()->USBBackendReleasePointer (&guid);
5679 }
5680
5681 int vrc = PDMR3USBDetachDevice (that->mpVM, aUuid);
5682
5683 if (VBOX_SUCCESS (vrc))
5684 {
5685 AutoWriteLock alock (that);
5686
5687 /* Remove the device from the collection */
5688 that->mUSBDevices.erase (*aIt);
5689 LogFlowFunc (("Detached device {%RTuuid}\n", device->id().raw()));
5690
5691 /* notify callbacks */
5692 that->onUSBDeviceStateChange (device, false /* aAttached */, NULL);
5693 }
5694
5695 LogFlowFunc (("vrc=%Rrc\n", vrc));
5696 LogFlowFuncLeave();
5697 return vrc;
5698}
5699
5700#endif /* VBOX_WITH_USB */
5701
5702
5703/**
5704 * Helper function to handle host interface device creation and attachment.
5705 *
5706 * @param networkAdapter the network adapter which attachment should be reset
5707 * @return COM status code
5708 *
5709 * @note The caller must lock this object for writing.
5710 */
5711HRESULT Console::attachToBridgedInterface(INetworkAdapter *networkAdapter)
5712{
5713#if !defined(RT_OS_LINUX) || defined(VBOX_WITH_NETFLT)
5714 /*
5715 * Nothing to do here.
5716 *
5717 * Note, the reason for this method in the first place a memory / fork
5718 * bug on linux. All this code belongs in DrvTAP and similar places.
5719 */
5720 NOREF(networkAdapter);
5721 return S_OK;
5722
5723#else /* RT_OS_LINUX && !VBOX_WITH_NETFLT */
5724
5725 LogFlowThisFunc(("\n"));
5726 /* sanity check */
5727 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5728
5729# ifdef VBOX_STRICT
5730 /* paranoia */
5731 NetworkAttachmentType_T attachment;
5732 networkAdapter->COMGETTER(AttachmentType)(&attachment);
5733 Assert(attachment == NetworkAttachmentType_Bridged);
5734# endif /* VBOX_STRICT */
5735
5736 HRESULT rc = S_OK;
5737
5738 ULONG slot = 0;
5739 rc = networkAdapter->COMGETTER(Slot)(&slot);
5740 AssertComRC(rc);
5741
5742 /*
5743 * Allocate a host interface device
5744 */
5745 int rcVBox = RTFileOpen(&maTapFD[slot], "/dev/net/tun",
5746 RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_INHERIT);
5747 if (VBOX_SUCCESS(rcVBox))
5748 {
5749 /*
5750 * Set/obtain the tap interface.
5751 */
5752 struct ifreq IfReq;
5753 memset(&IfReq, 0, sizeof(IfReq));
5754 /* The name of the TAP interface we are using */
5755 Bstr tapDeviceName;
5756 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
5757 if (FAILED(rc))
5758 tapDeviceName.setNull(); /* Is this necessary? */
5759 if (tapDeviceName.isEmpty())
5760 {
5761 LogRel(("No TAP device name was supplied.\n"));
5762 rc = setError(E_FAIL, tr ("No TAP device name was supplied for the host networking interface"));
5763 }
5764
5765 if (SUCCEEDED(rc))
5766 {
5767 /* If we are using a static TAP device then try to open it. */
5768 Utf8Str str(tapDeviceName);
5769 if (str.length() <= sizeof(IfReq.ifr_name))
5770 strcpy(IfReq.ifr_name, str.raw());
5771 else
5772 memcpy(IfReq.ifr_name, str.raw(), sizeof(IfReq.ifr_name) - 1); /** @todo bitch about names which are too long... */
5773 IfReq.ifr_flags = IFF_TAP | IFF_NO_PI;
5774 rcVBox = ioctl(maTapFD[slot], TUNSETIFF, &IfReq);
5775 if (rcVBox != 0)
5776 {
5777 LogRel(("Failed to open the host network interface %ls\n", tapDeviceName.raw()));
5778 rc = setError(E_FAIL, tr ("Failed to open the host network interface %ls"),
5779 tapDeviceName.raw());
5780 }
5781 }
5782 if (SUCCEEDED(rc))
5783 {
5784 /*
5785 * Make it pollable.
5786 */
5787 if (fcntl(maTapFD[slot], F_SETFL, O_NONBLOCK) != -1)
5788 {
5789 Log(("attachToBridgedInterface: %RTfile %ls\n", maTapFD[slot], tapDeviceName.raw()));
5790 /*
5791 * Here is the right place to communicate the TAP file descriptor and
5792 * the host interface name to the server if/when it becomes really
5793 * necessary.
5794 */
5795 maTAPDeviceName[slot] = tapDeviceName;
5796 rcVBox = VINF_SUCCESS;
5797 }
5798 else
5799 {
5800 int iErr = errno;
5801
5802 LogRel(("Configuration error: Failed to configure /dev/net/tun non blocking. Error: %s\n", strerror(iErr)));
5803 rcVBox = VERR_HOSTIF_BLOCKING;
5804 rc = setError(E_FAIL, tr ("could not set up the host networking device for non blocking access: %s"),
5805 strerror(errno));
5806 }
5807 }
5808 }
5809 else
5810 {
5811 LogRel(("Configuration error: Failed to open /dev/net/tun rc=%Rrc\n", rcVBox));
5812 switch (rcVBox)
5813 {
5814 case VERR_ACCESS_DENIED:
5815 /* will be handled by our caller */
5816 rc = rcVBox;
5817 break;
5818 default:
5819 rc = setError(E_FAIL, tr ("Could not set up the host networking device: %Rrc"), rcVBox);
5820 break;
5821 }
5822 }
5823 /* in case of failure, cleanup. */
5824 if (VBOX_FAILURE(rcVBox) && SUCCEEDED(rc))
5825 {
5826 LogRel(("General failure attaching to host interface\n"));
5827 rc = setError(E_FAIL, tr ("General failure attaching to host interface"));
5828 }
5829 LogFlowThisFunc(("rc=%d\n", rc));
5830 return rc;
5831#endif /* RT_OS_LINUX */
5832}
5833
5834/**
5835 * Helper function to handle detachment from a host interface
5836 *
5837 * @param networkAdapter the network adapter which attachment should be reset
5838 * @return COM status code
5839 *
5840 * @note The caller must lock this object for writing.
5841 */
5842HRESULT Console::detachFromBridgedInterface(INetworkAdapter *networkAdapter)
5843{
5844#if !defined(RT_OS_LINUX) || defined(VBOX_WITH_NETFLT)
5845 /*
5846 * Nothing to do here.
5847 */
5848 NOREF(networkAdapter);
5849 return S_OK;
5850
5851#else /* RT_OS_LINUX */
5852
5853 /* sanity check */
5854 LogFlowThisFunc(("\n"));
5855 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5856
5857 HRESULT rc = S_OK;
5858# ifdef VBOX_STRICT
5859 /* paranoia */
5860 NetworkAttachmentType_T attachment;
5861 networkAdapter->COMGETTER(AttachmentType)(&attachment);
5862 Assert(attachment == NetworkAttachmentType_Bridged);
5863# endif /* VBOX_STRICT */
5864
5865 ULONG slot = 0;
5866 rc = networkAdapter->COMGETTER(Slot)(&slot);
5867 AssertComRC(rc);
5868
5869 /* is there an open TAP device? */
5870 if (maTapFD[slot] != NIL_RTFILE)
5871 {
5872 /*
5873 * Close the file handle.
5874 */
5875 Bstr tapDeviceName, tapTerminateApplication;
5876 bool isStatic = true;
5877 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
5878 if (FAILED(rc) || tapDeviceName.isEmpty())
5879 {
5880 /* If the name is empty, this is a dynamic TAP device, so close it now,
5881 so that the termination script can remove the interface. Otherwise we still
5882 need the FD to pass to the termination script. */
5883 isStatic = false;
5884 int rcVBox = RTFileClose(maTapFD[slot]);
5885 AssertRC(rcVBox);
5886 maTapFD[slot] = NIL_RTFILE;
5887 }
5888 if (isStatic)
5889 {
5890 /* If we are using a static TAP device, we close it now, after having called the
5891 termination script. */
5892 int rcVBox = RTFileClose(maTapFD[slot]);
5893 AssertRC(rcVBox);
5894 }
5895 /* the TAP device name and handle are no longer valid */
5896 maTapFD[slot] = NIL_RTFILE;
5897 maTAPDeviceName[slot] = "";
5898 }
5899 LogFlowThisFunc(("returning %d\n", rc));
5900 return rc;
5901#endif /* RT_OS_LINUX */
5902}
5903
5904
5905/**
5906 * Called at power down to terminate host interface networking.
5907 *
5908 * @note The caller must lock this object for writing.
5909 */
5910HRESULT Console::powerDownHostInterfaces()
5911{
5912 LogFlowThisFunc (("\n"));
5913
5914 /* sanity check */
5915 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5916
5917 /*
5918 * host interface termination handling
5919 */
5920 HRESULT rc;
5921 for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
5922 {
5923 ComPtr<INetworkAdapter> networkAdapter;
5924 rc = mMachine->GetNetworkAdapter(slot, networkAdapter.asOutParam());
5925 CheckComRCBreakRC (rc);
5926
5927 BOOL enabled = FALSE;
5928 networkAdapter->COMGETTER(Enabled) (&enabled);
5929 if (!enabled)
5930 continue;
5931
5932 NetworkAttachmentType_T attachment;
5933 networkAdapter->COMGETTER(AttachmentType)(&attachment);
5934 if (attachment == NetworkAttachmentType_Bridged)
5935 {
5936 HRESULT rc2 = detachFromBridgedInterface(networkAdapter);
5937 if (FAILED(rc2) && SUCCEEDED(rc))
5938 rc = rc2;
5939 }
5940 }
5941
5942 return rc;
5943}
5944
5945
5946/**
5947 * Process callback handler for VMR3Load and VMR3Save.
5948 *
5949 * @param pVM The VM handle.
5950 * @param uPercent Completetion precentage (0-100).
5951 * @param pvUser Pointer to the VMProgressTask structure.
5952 * @return VINF_SUCCESS.
5953 */
5954/*static*/ DECLCALLBACK (int)
5955Console::stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser)
5956{
5957 VMProgressTask *task = static_cast <VMProgressTask *> (pvUser);
5958 AssertReturn (task, VERR_INVALID_PARAMETER);
5959
5960 /* update the progress object */
5961 if (task->mProgress)
5962 task->mProgress->setCurrentOperationProgress(uPercent);
5963
5964 return VINF_SUCCESS;
5965}
5966
5967/**
5968 * VM error callback function. Called by the various VM components.
5969 *
5970 * @param pVM VM handle. Can be NULL if an error occurred before
5971 * successfully creating a VM.
5972 * @param pvUser Pointer to the VMProgressTask structure.
5973 * @param rc VBox status code.
5974 * @param pszFormat Printf-like error message.
5975 * @param args Various number of arguments for the error message.
5976 *
5977 * @thread EMT, VMPowerUp...
5978 *
5979 * @note The VMProgressTask structure modified by this callback is not thread
5980 * safe.
5981 */
5982/* static */ DECLCALLBACK (void)
5983Console::setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
5984 const char *pszFormat, va_list args)
5985{
5986 VMProgressTask *task = static_cast <VMProgressTask *> (pvUser);
5987 AssertReturnVoid (task);
5988
5989 /* we ignore RT_SRC_POS_DECL arguments to avoid confusion of end-users */
5990 va_list va2;
5991 va_copy (va2, args); /* Have to make a copy here or GCC will break. */
5992
5993 /* append to the existing error message if any */
5994 if (!task->mErrorMsg.isEmpty())
5995 task->mErrorMsg = Utf8StrFmt ("%s.\n%N (%Rrc)", task->mErrorMsg.raw(),
5996 pszFormat, &va2, rc, rc);
5997 else
5998 task->mErrorMsg = Utf8StrFmt ("%N (%Rrc)",
5999 pszFormat, &va2, rc, rc);
6000
6001 va_end (va2);
6002}
6003
6004/**
6005 * VM runtime error callback function.
6006 * See VMSetRuntimeError for the detailed description of parameters.
6007 *
6008 * @param pVM The VM handle.
6009 * @param pvUser The user argument.
6010 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
6011 * @param pszErrorId Error ID string.
6012 * @param pszFormat Error message format string.
6013 * @param va Error message arguments.
6014 * @thread EMT.
6015 */
6016/* static */ DECLCALLBACK(void)
6017Console::setVMRuntimeErrorCallback (PVM pVM, void *pvUser, uint32_t fFlags,
6018 const char *pszErrorId,
6019 const char *pszFormat, va_list va)
6020{
6021 bool const fFatal = !!(fFlags & VMSETRTERR_FLAGS_FATAL);
6022 LogFlowFuncEnter();
6023
6024 Console *that = static_cast <Console *> (pvUser);
6025 AssertReturnVoid (that);
6026
6027 Utf8Str message = Utf8StrFmtVA (pszFormat, va);
6028
6029 LogRel (("Console: VM runtime error: fatal=%RTbool, "
6030 "errorID=%s message=\"%s\"\n",
6031 fFatal, pszErrorId, message.raw()));
6032
6033 that->onRuntimeError (BOOL (fFatal), Bstr (pszErrorId), Bstr (message));
6034
6035 LogFlowFuncLeave();
6036}
6037
6038/**
6039 * Captures USB devices that match filters of the VM.
6040 * Called at VM startup.
6041 *
6042 * @param pVM The VM handle.
6043 *
6044 * @note The caller must lock this object for writing.
6045 */
6046HRESULT Console::captureUSBDevices (PVM pVM)
6047{
6048 LogFlowThisFunc (("\n"));
6049
6050 /* sanity check */
6051 ComAssertRet (isWriteLockOnCurrentThread(), E_FAIL);
6052
6053 /* If the machine has an USB controller, ask the USB proxy service to
6054 * capture devices */
6055 PPDMIBASE pBase;
6056 int vrc = PDMR3QueryLun (pVM, "usb-ohci", 0, 0, &pBase);
6057 if (VBOX_SUCCESS (vrc))
6058 {
6059 /* leave the lock before calling Host in VBoxSVC since Host may call
6060 * us back from under its lock (e.g. onUSBDeviceAttach()) which would
6061 * produce an inter-process dead-lock otherwise. */
6062 AutoWriteLock alock (this);
6063 alock.leave();
6064
6065 HRESULT hrc = mControl->AutoCaptureUSBDevices();
6066 ComAssertComRCRetRC (hrc);
6067 }
6068 else if ( vrc == VERR_PDM_DEVICE_NOT_FOUND
6069 || vrc == VERR_PDM_DEVICE_INSTANCE_NOT_FOUND)
6070 vrc = VINF_SUCCESS;
6071 else
6072 AssertRC (vrc);
6073
6074 return VBOX_SUCCESS (vrc) ? S_OK : E_FAIL;
6075}
6076
6077
6078/**
6079 * Detach all USB device which are attached to the VM for the
6080 * purpose of clean up and such like.
6081 *
6082 * @note The caller must lock this object for writing.
6083 */
6084void Console::detachAllUSBDevices (bool aDone)
6085{
6086 LogFlowThisFunc (("aDone=%RTbool\n", aDone));
6087
6088 /* sanity check */
6089 AssertReturnVoid (isWriteLockOnCurrentThread());
6090
6091 mUSBDevices.clear();
6092
6093 /* leave the lock before calling Host in VBoxSVC since Host may call
6094 * us back from under its lock (e.g. onUSBDeviceAttach()) which would
6095 * produce an inter-process dead-lock otherwise. */
6096 AutoWriteLock alock (this);
6097 alock.leave();
6098
6099 mControl->DetachAllUSBDevices (aDone);
6100}
6101
6102/**
6103 * @note Locks this object for writing.
6104 */
6105void Console::processRemoteUSBDevices (uint32_t u32ClientId, VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList)
6106{
6107 LogFlowThisFuncEnter();
6108 LogFlowThisFunc (("u32ClientId = %d, pDevList=%p, cbDevList = %d\n", u32ClientId, pDevList, cbDevList));
6109
6110 AutoCaller autoCaller (this);
6111 if (!autoCaller.isOk())
6112 {
6113 /* Console has been already uninitialized, deny request */
6114 AssertMsgFailed (("Temporary assertion to prove that it happens, "
6115 "please report to dmik\n"));
6116 LogFlowThisFunc (("Console is already uninitialized\n"));
6117 LogFlowThisFuncLeave();
6118 return;
6119 }
6120
6121 AutoWriteLock alock (this);
6122
6123 /*
6124 * Mark all existing remote USB devices as dirty.
6125 */
6126 RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6127 while (it != mRemoteUSBDevices.end())
6128 {
6129 (*it)->dirty (true);
6130 ++ it;
6131 }
6132
6133 /*
6134 * Process the pDevList and add devices those are not already in the mRemoteUSBDevices list.
6135 */
6136 /** @todo (sunlover) REMOTE_USB Strict validation of the pDevList. */
6137 VRDPUSBDEVICEDESC *e = pDevList;
6138
6139 /* The cbDevList condition must be checked first, because the function can
6140 * receive pDevList = NULL and cbDevList = 0 on client disconnect.
6141 */
6142 while (cbDevList >= 2 && e->oNext)
6143 {
6144 LogFlowThisFunc (("vendor %04X, product %04X, name = %s\n",
6145 e->idVendor, e->idProduct,
6146 e->oProduct? (char *)e + e->oProduct: ""));
6147
6148 bool fNewDevice = true;
6149
6150 it = mRemoteUSBDevices.begin();
6151 while (it != mRemoteUSBDevices.end())
6152 {
6153 if ((*it)->devId () == e->id
6154 && (*it)->clientId () == u32ClientId)
6155 {
6156 /* The device is already in the list. */
6157 (*it)->dirty (false);
6158 fNewDevice = false;
6159 break;
6160 }
6161
6162 ++ it;
6163 }
6164
6165 if (fNewDevice)
6166 {
6167 LogRel(("Remote USB: ++++ Vendor %04X. Product %04X. Name = [%s].\n",
6168 e->idVendor, e->idProduct, e->oProduct? (char *)e + e->oProduct: ""
6169 ));
6170
6171 /* Create the device object and add the new device to list. */
6172 ComObjPtr <RemoteUSBDevice> device;
6173 device.createObject();
6174 device->init (u32ClientId, e);
6175
6176 mRemoteUSBDevices.push_back (device);
6177
6178 /* Check if the device is ok for current USB filters. */
6179 BOOL fMatched = FALSE;
6180 ULONG fMaskedIfs = 0;
6181
6182 HRESULT hrc = mControl->RunUSBDeviceFilters(device, &fMatched, &fMaskedIfs);
6183
6184 AssertComRC (hrc);
6185
6186 LogFlowThisFunc (("USB filters return %d %#x\n", fMatched, fMaskedIfs));
6187
6188 if (fMatched)
6189 {
6190 hrc = onUSBDeviceAttach (device, NULL, fMaskedIfs);
6191
6192 /// @todo (r=dmik) warning reporting subsystem
6193
6194 if (hrc == S_OK)
6195 {
6196 LogFlowThisFunc (("Device attached\n"));
6197 device->captured (true);
6198 }
6199 }
6200 }
6201
6202 if (cbDevList < e->oNext)
6203 {
6204 LogWarningThisFunc (("cbDevList %d > oNext %d\n",
6205 cbDevList, e->oNext));
6206 break;
6207 }
6208
6209 cbDevList -= e->oNext;
6210
6211 e = (VRDPUSBDEVICEDESC *)((uint8_t *)e + e->oNext);
6212 }
6213
6214 /*
6215 * Remove dirty devices, that is those which are not reported by the server anymore.
6216 */
6217 for (;;)
6218 {
6219 ComObjPtr <RemoteUSBDevice> device;
6220
6221 RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6222 while (it != mRemoteUSBDevices.end())
6223 {
6224 if ((*it)->dirty ())
6225 {
6226 device = *it;
6227 break;
6228 }
6229
6230 ++ it;
6231 }
6232
6233 if (!device)
6234 {
6235 break;
6236 }
6237
6238 USHORT vendorId = 0;
6239 device->COMGETTER(VendorId) (&vendorId);
6240
6241 USHORT productId = 0;
6242 device->COMGETTER(ProductId) (&productId);
6243
6244 Bstr product;
6245 device->COMGETTER(Product) (product.asOutParam());
6246
6247 LogRel(("Remote USB: ---- Vendor %04X. Product %04X. Name = [%ls].\n",
6248 vendorId, productId, product.raw ()
6249 ));
6250
6251 /* Detach the device from VM. */
6252 if (device->captured ())
6253 {
6254 Bstr uuid;
6255 device->COMGETTER (Id) (uuid.asOutParam());
6256 onUSBDeviceDetach (uuid, NULL);
6257 }
6258
6259 /* And remove it from the list. */
6260 mRemoteUSBDevices.erase (it);
6261 }
6262
6263 LogFlowThisFuncLeave();
6264}
6265
6266/**
6267 * Thread function which starts the VM (also from saved state) and
6268 * track progress.
6269 *
6270 * @param Thread The thread id.
6271 * @param pvUser Pointer to a VMPowerUpTask structure.
6272 * @return VINF_SUCCESS (ignored).
6273 *
6274 * @note Locks the Console object for writing.
6275 */
6276/*static*/
6277DECLCALLBACK (int) Console::powerUpThread (RTTHREAD Thread, void *pvUser)
6278{
6279 LogFlowFuncEnter();
6280
6281 std::auto_ptr <VMPowerUpTask> task (static_cast <VMPowerUpTask *> (pvUser));
6282 AssertReturn (task.get(), VERR_INVALID_PARAMETER);
6283
6284 AssertReturn (!task->mConsole.isNull(), VERR_INVALID_PARAMETER);
6285 AssertReturn (!task->mProgress.isNull(), VERR_INVALID_PARAMETER);
6286
6287#if defined(RT_OS_WINDOWS)
6288 {
6289 /* initialize COM */
6290 HRESULT hrc = CoInitializeEx (NULL,
6291 COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE |
6292 COINIT_SPEED_OVER_MEMORY);
6293 LogFlowFunc (("CoInitializeEx()=%08X\n", hrc));
6294 }
6295#endif
6296
6297 HRESULT rc = S_OK;
6298 int vrc = VINF_SUCCESS;
6299
6300 /* Set up a build identifier so that it can be seen from core dumps what
6301 * exact build was used to produce the core. */
6302 static char saBuildID[40];
6303 RTStrPrintf(saBuildID, sizeof(saBuildID), "%s%s%s%s VirtualBox %s r%d %s%s%s%s",
6304 "BU", "IL", "DI", "D", VBOX_VERSION_STRING, VBoxSVNRev (), "BU", "IL", "DI", "D");
6305
6306 ComObjPtr <Console> console = task->mConsole;
6307
6308 /* Note: no need to use addCaller() because VMPowerUpTask does that */
6309
6310 /* The lock is also used as a signal from the task initiator (which
6311 * releases it only after RTThreadCreate()) that we can start the job */
6312 AutoWriteLock alock (console);
6313
6314 /* sanity */
6315 Assert (console->mpVM == NULL);
6316
6317 try
6318 {
6319 /* wait for auto reset ops to complete so that we can successfully lock
6320 * the attached hard disks by calling LockMedia() below */
6321 for (VMPowerUpTask::ProgressList::const_iterator
6322 it = task->hardDiskProgresses.begin();
6323 it != task->hardDiskProgresses.end(); ++ it)
6324 {
6325 HRESULT rc2 = (*it)->WaitForCompletion (-1);
6326 AssertComRC (rc2);
6327 }
6328
6329 /* lock attached media. This method will also check their
6330 * accessibility. Note that the media will be unlocked automatically
6331 * by SessionMachine::setMachineState() when the VM is powered down. */
6332 rc = console->mControl->LockMedia();
6333 CheckComRCThrowRC (rc);
6334
6335#ifdef VBOX_WITH_VRDP
6336
6337 /* Create the VRDP server. In case of headless operation, this will
6338 * also create the framebuffer, required at VM creation.
6339 */
6340 ConsoleVRDPServer *server = console->consoleVRDPServer();
6341 Assert (server);
6342
6343 /// @todo (dmik)
6344 // does VRDP server call Console from the other thread?
6345 // Not sure, so leave the lock just in case
6346 alock.leave();
6347 vrc = server->Launch();
6348 alock.enter();
6349
6350 if (VBOX_FAILURE (vrc))
6351 {
6352 Utf8Str errMsg;
6353 switch (vrc)
6354 {
6355 case VERR_NET_ADDRESS_IN_USE:
6356 {
6357 ULONG port = 0;
6358 console->mVRDPServer->COMGETTER(Port) (&port);
6359 errMsg = Utf8StrFmt (tr ("VRDP server port %d is already in use"),
6360 port);
6361 break;
6362 }
6363 case VERR_FILE_NOT_FOUND:
6364 {
6365 errMsg = Utf8StrFmt (tr ("Could not load the VRDP library"));
6366 break;
6367 }
6368 default:
6369 errMsg = Utf8StrFmt (tr ("Failed to launch VRDP server (%Rrc)"),
6370 vrc);
6371 }
6372 LogRel (("Failed to launch VRDP server (%Rrc), error message: '%s'\n",
6373 vrc, errMsg.raw()));
6374 throw setError (E_FAIL, errMsg);
6375 }
6376
6377#endif /* VBOX_WITH_VRDP */
6378
6379 ComPtr <IMachine> pMachine = console->machine();
6380 ULONG cCpus = 1;
6381 pMachine->COMGETTER(CPUCount)(&cCpus);
6382
6383 /*
6384 * Create the VM
6385 */
6386 PVM pVM;
6387 /*
6388 * leave the lock since EMT will call Console. It's safe because
6389 * mMachineState is either Starting or Restoring state here.
6390 */
6391 alock.leave();
6392
6393 vrc = VMR3Create (cCpus, task->mSetVMErrorCallback, task.get(),
6394 task->mConfigConstructor, static_cast <Console *> (console),
6395 &pVM);
6396
6397 alock.enter();
6398
6399#ifdef VBOX_WITH_VRDP
6400 /* Enable client connections to the server. */
6401 console->consoleVRDPServer()->EnableConnections ();
6402#endif /* VBOX_WITH_VRDP */
6403
6404 if (VBOX_SUCCESS (vrc))
6405 {
6406 do
6407 {
6408 /*
6409 * Register our load/save state file handlers
6410 */
6411 vrc = SSMR3RegisterExternal (pVM,
6412 sSSMConsoleUnit, 0 /* iInstance */, sSSMConsoleVer,
6413 0 /* cbGuess */,
6414 NULL, saveStateFileExec, NULL, NULL, loadStateFileExec, NULL,
6415 static_cast <Console *> (console));
6416 AssertRC (vrc);
6417 if (VBOX_FAILURE (vrc))
6418 break;
6419
6420 vrc = static_cast <Console *>(console)->getDisplay()->registerSSM(pVM);
6421 AssertRC (vrc);
6422 if (VBOX_FAILURE (vrc))
6423 break;
6424
6425 /*
6426 * Synchronize debugger settings
6427 */
6428 MachineDebugger *machineDebugger = console->getMachineDebugger();
6429 if (machineDebugger)
6430 {
6431 machineDebugger->flushQueuedSettings();
6432 }
6433
6434 /*
6435 * Shared Folders
6436 */
6437 if (console->getVMMDev()->isShFlActive())
6438 {
6439 /// @todo (dmik)
6440 // does the code below call Console from the other thread?
6441 // Not sure, so leave the lock just in case
6442 alock.leave();
6443
6444 for (SharedFolderDataMap::const_iterator
6445 it = task->mSharedFolders.begin();
6446 it != task->mSharedFolders.end();
6447 ++ it)
6448 {
6449 rc = console->createSharedFolder ((*it).first, (*it).second);
6450 CheckComRCBreakRC (rc);
6451 }
6452
6453 /* enter the lock again */
6454 alock.enter();
6455
6456 CheckComRCBreakRC (rc);
6457 }
6458
6459 /*
6460 * Capture USB devices.
6461 */
6462 rc = console->captureUSBDevices (pVM);
6463 CheckComRCBreakRC (rc);
6464
6465 /* leave the lock before a lengthy operation */
6466 alock.leave();
6467
6468 /* Load saved state? */
6469 if (!!task->mSavedStateFile)
6470 {
6471 LogFlowFunc (("Restoring saved state from '%s'...\n",
6472 task->mSavedStateFile.raw()));
6473
6474 vrc = VMR3Load (pVM, task->mSavedStateFile,
6475 Console::stateProgressCallback,
6476 static_cast <VMProgressTask *> (task.get()));
6477
6478 if (VBOX_SUCCESS (vrc))
6479 {
6480 if (task->mStartPaused)
6481 /* done */
6482 console->setMachineState (MachineState_Paused);
6483 else
6484 {
6485 /* Start/Resume the VM execution */
6486 vrc = VMR3Resume (pVM);
6487 AssertRC (vrc);
6488 }
6489 }
6490
6491 /* Power off in case we failed loading or resuming the VM */
6492 if (VBOX_FAILURE (vrc))
6493 {
6494 int vrc2 = VMR3PowerOff (pVM);
6495 AssertRC (vrc2);
6496 }
6497 }
6498 else if (task->mStartPaused)
6499 /* done */
6500 console->setMachineState (MachineState_Paused);
6501 else
6502 {
6503 /* Power on the VM (i.e. start executing) */
6504 vrc = VMR3PowerOn(pVM);
6505 AssertRC (vrc);
6506 }
6507
6508 /* enter the lock again */
6509 alock.enter();
6510 }
6511 while (0);
6512
6513 /* On failure, destroy the VM */
6514 if (FAILED (rc) || VBOX_FAILURE (vrc))
6515 {
6516 /* preserve existing error info */
6517 ErrorInfoKeeper eik;
6518
6519 /* powerDown() will call VMR3Destroy() and do all necessary
6520 * cleanup (VRDP, USB devices) */
6521 HRESULT rc2 = console->powerDown();
6522 AssertComRC (rc2);
6523 }
6524 else
6525 {
6526 /*
6527 * Deregister the VMSetError callback. This is necessary as the
6528 * pfnVMAtError() function passed to VMR3Create() is supposed to
6529 * be sticky but our error callback isn't.
6530 */
6531 alock.leave();
6532 VMR3AtErrorDeregister(pVM, task->mSetVMErrorCallback, task.get());
6533 /** @todo register another VMSetError callback? */
6534 alock.enter();
6535 }
6536 }
6537 else
6538 {
6539 /*
6540 * If VMR3Create() failed it has released the VM memory.
6541 */
6542 console->mpVM = NULL;
6543 }
6544
6545 if (SUCCEEDED (rc) && VBOX_FAILURE (vrc))
6546 {
6547 /* If VMR3Create() or one of the other calls in this function fail,
6548 * an appropriate error message has been set in task->mErrorMsg.
6549 * However since that happens via a callback, the rc status code in
6550 * this function is not updated.
6551 */
6552 if (task->mErrorMsg.isNull())
6553 {
6554 /* If the error message is not set but we've got a failure,
6555 * convert the VBox status code into a meaningfulerror message.
6556 * This becomes unused once all the sources of errors set the
6557 * appropriate error message themselves.
6558 */
6559 AssertMsgFailed (("Missing error message during powerup for "
6560 "status code %Rrc\n", vrc));
6561 task->mErrorMsg = Utf8StrFmt (
6562 tr ("Failed to start VM execution (%Rrc)"), vrc);
6563 }
6564
6565 /* Set the error message as the COM error.
6566 * Progress::notifyComplete() will pick it up later. */
6567 throw setError (E_FAIL, task->mErrorMsg);
6568 }
6569 }
6570 catch (HRESULT aRC) { rc = aRC; }
6571
6572 if (console->mMachineState == MachineState_Starting ||
6573 console->mMachineState == MachineState_Restoring)
6574 {
6575 /* We are still in the Starting/Restoring state. This means one of:
6576 *
6577 * 1) we failed before VMR3Create() was called;
6578 * 2) VMR3Create() failed.
6579 *
6580 * In both cases, there is no need to call powerDown(), but we still
6581 * need to go back to the PoweredOff/Saved state. Reuse
6582 * vmstateChangeCallback() for that purpose.
6583 */
6584
6585 /* preserve existing error info */
6586 ErrorInfoKeeper eik;
6587
6588 Assert (console->mpVM == NULL);
6589 vmstateChangeCallback (NULL, VMSTATE_TERMINATED, VMSTATE_CREATING,
6590 console);
6591 }
6592
6593 /*
6594 * Evaluate the final result. Note that the appropriate mMachineState value
6595 * is already set by vmstateChangeCallback() in all cases.
6596 */
6597
6598 /* leave the lock, don't need it any more */
6599 alock.leave();
6600
6601 if (SUCCEEDED (rc))
6602 {
6603 /* Notify the progress object of the success */
6604 task->mProgress->notifyComplete (S_OK);
6605 }
6606 else
6607 {
6608 /* The progress object will fetch the current error info */
6609 task->mProgress->notifyComplete (rc);
6610
6611 LogRel (("Power up failed (vrc=%Rrc, rc=%Rhrc (%#08X))\n", vrc, rc, rc));
6612 }
6613
6614#if defined(RT_OS_WINDOWS)
6615 /* uninitialize COM */
6616 CoUninitialize();
6617#endif
6618
6619 LogFlowFuncLeave();
6620
6621 return VINF_SUCCESS;
6622}
6623
6624
6625/**
6626 * Reconfigures a VDI.
6627 *
6628 * @param pVM The VM handle.
6629 * @param lInstance The instance of the controller.
6630 * @param enmController The type of the controller.
6631 * @param hda The harddisk attachment.
6632 * @param phrc Where to store com error - only valid if we return VERR_GENERAL_FAILURE.
6633 * @return VBox status code.
6634 */
6635static DECLCALLBACK(int) reconfigureHardDisks(PVM pVM, ULONG lInstance,
6636 StorageControllerType_T enmController,
6637 IHardDiskAttachment *hda,
6638 HRESULT *phrc)
6639{
6640 LogFlowFunc (("pVM=%p hda=%p phrc=%p\n", pVM, hda, phrc));
6641
6642 int rc;
6643 HRESULT hrc;
6644 Bstr bstr;
6645 *phrc = S_OK;
6646#define RC_CHECK() do { if (VBOX_FAILURE(rc)) { AssertMsgFailed(("rc=%Rrc\n", rc)); return rc; } } while (0)
6647#define H() do { if (FAILED(hrc)) { AssertMsgFailed(("hrc=%Rhrc (%#x)\n", hrc, hrc)); *phrc = hrc; return VERR_GENERAL_FAILURE; } } while (0)
6648
6649 /*
6650 * Figure out which IDE device this is.
6651 */
6652 ComPtr<IHardDisk> hardDisk;
6653 hrc = hda->COMGETTER(HardDisk)(hardDisk.asOutParam()); H();
6654 LONG lDev;
6655 hrc = hda->COMGETTER(Device)(&lDev); H();
6656 LONG lPort;
6657 hrc = hda->COMGETTER(Port)(&lPort); H();
6658
6659 int iLUN;
6660 const char *pcszDevice = NULL;
6661 bool fSCSI = false;
6662
6663 switch (enmController)
6664 {
6665 case StorageControllerType_PIIX3:
6666 case StorageControllerType_PIIX4:
6667 case StorageControllerType_ICH6:
6668 {
6669 if (lPort >= 2 || lPort < 0)
6670 {
6671 AssertMsgFailed(("invalid controller channel number: %d\n", lPort));
6672 return VERR_GENERAL_FAILURE;
6673 }
6674
6675 if (lDev >= 2 || lDev < 0)
6676 {
6677 AssertMsgFailed(("invalid controller device number: %d\n", lDev));
6678 return VERR_GENERAL_FAILURE;
6679 }
6680
6681 iLUN = 2*lPort + lDev;
6682 pcszDevice = "piix3ide";
6683 break;
6684 }
6685 case StorageControllerType_IntelAhci:
6686 {
6687 iLUN = lPort;
6688 pcszDevice = "ahci";
6689 break;
6690 }
6691 case StorageControllerType_BusLogic:
6692 {
6693 iLUN = lPort;
6694 pcszDevice = "buslogic";
6695 fSCSI = true;
6696 break;
6697 }
6698 case StorageControllerType_LsiLogic:
6699 {
6700 iLUN = lPort;
6701 pcszDevice = "lsilogicscsi";
6702 fSCSI = true;
6703 break;
6704 }
6705 default:
6706 {
6707 AssertMsgFailed(("invalid disk controller type: %d\n", enmController));
6708 return VERR_GENERAL_FAILURE;
6709 }
6710 }
6711
6712 /** @todo this should be unified with the relevant part of
6713 * Console::configConstructor to avoid inconsistencies. */
6714
6715 /*
6716 * Is there an existing LUN? If not create it.
6717 * We ASSUME that this will NEVER collide with the DVD.
6718 */
6719 PCFGMNODE pCfg;
6720 PCFGMNODE pLunL1;
6721 PCFGMNODE pLunL2;
6722
6723 /* SCSI has an extra driver between the device and the block driver. */
6724 if (fSCSI)
6725 pLunL1 = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/%s/%u/LUN#%d/AttachedDriver/AttachedDriver/", pcszDevice, lInstance, iLUN);
6726 else
6727 pLunL1 = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/%s/%u/LUN#%d/AttachedDriver/", pcszDevice, lInstance, iLUN);
6728
6729 if (!pLunL1)
6730 {
6731 PCFGMNODE pInst = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/%s/%u/", pcszDevice, lInstance);
6732 AssertReturn(pInst, VERR_INTERNAL_ERROR);
6733
6734 PCFGMNODE pLunL0;
6735 rc = CFGMR3InsertNodeF(pInst, &pLunL0, "LUN#%d", iLUN); RC_CHECK();
6736
6737 if (fSCSI)
6738 {
6739 rc = CFGMR3InsertString(pLunL0, "Driver", "SCSI"); RC_CHECK();
6740 rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
6741
6742 rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL0); RC_CHECK();
6743 }
6744
6745 rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
6746 rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
6747 rc = CFGMR3InsertString(pCfg, "Type", "HardDisk"); RC_CHECK();
6748 rc = CFGMR3InsertInteger(pCfg, "Mountable", 0); RC_CHECK();
6749
6750 rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
6751 rc = CFGMR3InsertString(pLunL1, "Driver", "VD"); RC_CHECK();
6752 rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
6753 }
6754 else
6755 {
6756#ifdef VBOX_STRICT
6757 char *pszDriver;
6758 rc = CFGMR3QueryStringAlloc(pLunL1, "Driver", &pszDriver); RC_CHECK();
6759 Assert(!strcmp(pszDriver, "VD"));
6760 MMR3HeapFree(pszDriver);
6761#endif
6762
6763 pCfg = CFGMR3GetChild(pLunL1, "Config");
6764 AssertReturn(pCfg, VERR_INTERNAL_ERROR);
6765
6766 /* Here used to be a lot of code checking if things have changed,
6767 * but that's not really worth it, as with snapshots there is always
6768 * some change, so the code was just logging useless information in
6769 * a hard to analyze form. */
6770
6771 /*
6772 * Detach the driver and replace the config node.
6773 */
6774 rc = PDMR3DeviceDetach(pVM, pcszDevice, 0, iLUN); RC_CHECK();
6775 CFGMR3RemoveNode(pCfg);
6776 rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
6777 }
6778
6779 /*
6780 * Create the driver configuration.
6781 */
6782 hrc = hardDisk->COMGETTER(Location)(bstr.asOutParam()); H();
6783 LogFlowFunc (("LUN#%d: leaf location '%ls'\n", iLUN, bstr.raw()));
6784 rc = CFGMR3InsertString(pCfg, "Path", Utf8Str(bstr)); RC_CHECK();
6785 hrc = hardDisk->COMGETTER(Format)(bstr.asOutParam()); H();
6786 LogFlowFunc (("LUN#%d: leaf format '%ls'\n", iLUN, bstr.raw()));
6787 rc = CFGMR3InsertString(pCfg, "Format", Utf8Str(bstr)); RC_CHECK();
6788
6789#if defined(VBOX_WITH_PDM_ASYNC_COMPLETION)
6790 if (bstr == L"VMDK")
6791 {
6792 /* Create cfgm nodes for async transport driver because VMDK is
6793 * currently the only one which may support async I/O. This has
6794 * to be made generic based on the capabiliy flags when the new
6795 * HardDisk interface is merged.
6796 */
6797 rc = CFGMR3InsertNode (pLunL1, "AttachedDriver", &pLunL2); RC_CHECK();
6798 rc = CFGMR3InsertString (pLunL2, "Driver", "TransportAsync"); RC_CHECK();
6799 /* The async transport driver has no config options yet. */
6800 }
6801#endif
6802
6803 /* Pass all custom parameters. */
6804 bool fHostIP = true;
6805 SafeArray <BSTR> names;
6806 SafeArray <BSTR> values;
6807 hrc = hardDisk->GetProperties (NULL,
6808 ComSafeArrayAsOutParam (names),
6809 ComSafeArrayAsOutParam (values)); H();
6810
6811 if (names.size() != 0)
6812 {
6813 PCFGMNODE pVDC;
6814 rc = CFGMR3InsertNode (pCfg, "VDConfig", &pVDC); RC_CHECK();
6815 for (size_t i = 0; i < names.size(); ++ i)
6816 {
6817 if (values [i])
6818 {
6819 Utf8Str name = names [i];
6820 Utf8Str value = values [i];
6821 rc = CFGMR3InsertString (pVDC, name, value);
6822 if ( !(name.compare("HostIPStack"))
6823 && !(value.compare("0")))
6824 fHostIP = false;
6825 }
6826 }
6827 }
6828
6829 /* Create an inversed tree of parents. */
6830 ComPtr<IHardDisk> parentHardDisk = hardDisk;
6831 for (PCFGMNODE pParent = pCfg;;)
6832 {
6833 hrc = parentHardDisk->COMGETTER(Parent)(hardDisk.asOutParam()); H();
6834 if (hardDisk.isNull())
6835 break;
6836
6837 PCFGMNODE pCur;
6838 rc = CFGMR3InsertNode(pParent, "Parent", &pCur); RC_CHECK();
6839 hrc = hardDisk->COMGETTER(Location)(bstr.asOutParam()); H();
6840 rc = CFGMR3InsertString(pCur, "Path", Utf8Str(bstr)); RC_CHECK();
6841
6842 hrc = hardDisk->COMGETTER(Format)(bstr.asOutParam()); H();
6843 rc = CFGMR3InsertString(pCur, "Format", Utf8Str(bstr)); RC_CHECK();
6844
6845 /* Pass all custom parameters. */
6846 SafeArray <BSTR> names;
6847 SafeArray <BSTR> values;
6848 hrc = hardDisk->GetProperties (NULL,
6849 ComSafeArrayAsOutParam (names),
6850 ComSafeArrayAsOutParam (values));H();
6851
6852 if (names.size() != 0)
6853 {
6854 PCFGMNODE pVDC;
6855 rc = CFGMR3InsertNode (pCur, "VDConfig", &pVDC); RC_CHECK();
6856 for (size_t i = 0; i < names.size(); ++ i)
6857 {
6858 if (values [i])
6859 {
6860 Utf8Str name = names [i];
6861 Utf8Str value = values [i];
6862 rc = CFGMR3InsertString (pVDC, name, value);
6863 if ( !(name.compare("HostIPStack"))
6864 && !(value.compare("0")))
6865 fHostIP = false;
6866 }
6867 }
6868 }
6869
6870
6871 /* Custom code: put marker to not use host IP stack to driver
6872 * configuration node. Simplifies life of DrvVD a bit. */
6873 if (!fHostIP)
6874 {
6875 rc = CFGMR3InsertInteger (pCfg, "HostIPStack", 0); RC_CHECK();
6876 }
6877
6878
6879 /* next */
6880 pParent = pCur;
6881 parentHardDisk = hardDisk;
6882 }
6883
6884 CFGMR3Dump(CFGMR3GetRoot(pVM));
6885
6886 /*
6887 * Attach the new driver.
6888 */
6889 rc = PDMR3DeviceAttach(pVM, pcszDevice, 0, iLUN, NULL); RC_CHECK();
6890
6891 LogFlowFunc (("Returns success\n"));
6892 return rc;
6893}
6894
6895
6896/**
6897 * Thread for executing the saved state operation.
6898 *
6899 * @param Thread The thread handle.
6900 * @param pvUser Pointer to a VMSaveTask structure.
6901 * @return VINF_SUCCESS (ignored).
6902 *
6903 * @note Locks the Console object for writing.
6904 */
6905/*static*/
6906DECLCALLBACK (int) Console::saveStateThread (RTTHREAD Thread, void *pvUser)
6907{
6908 LogFlowFuncEnter();
6909
6910 std::auto_ptr <VMSaveTask> task (static_cast <VMSaveTask *> (pvUser));
6911 AssertReturn (task.get(), VERR_INVALID_PARAMETER);
6912
6913 Assert (!task->mSavedStateFile.isNull());
6914 Assert (!task->mProgress.isNull());
6915
6916 const ComObjPtr <Console> &that = task->mConsole;
6917
6918 /*
6919 * Note: no need to use addCaller() to protect Console or addVMCaller() to
6920 * protect mpVM because VMSaveTask does that
6921 */
6922
6923 Utf8Str errMsg;
6924 HRESULT rc = S_OK;
6925
6926 if (task->mIsSnapshot)
6927 {
6928 Assert (!task->mServerProgress.isNull());
6929 LogFlowFunc (("Waiting until the server creates differencing VDIs...\n"));
6930
6931 rc = task->mServerProgress->WaitForCompletion (-1);
6932 if (SUCCEEDED (rc))
6933 {
6934 LONG iRc = S_OK;
6935 rc = task->mServerProgress->COMGETTER(ResultCode) (&iRc);
6936 if (SUCCEEDED (rc))
6937 rc = iRc;
6938 }
6939 }
6940
6941 if (SUCCEEDED (rc))
6942 {
6943 LogFlowFunc (("Saving the state to '%s'...\n", task->mSavedStateFile.raw()));
6944
6945 int vrc = VMR3Save (that->mpVM, task->mSavedStateFile,
6946 Console::stateProgressCallback,
6947 static_cast <VMProgressTask *> (task.get()));
6948 if (VBOX_FAILURE (vrc))
6949 {
6950 errMsg = Utf8StrFmt (
6951 Console::tr ("Failed to save the machine state to '%s' (%Rrc)"),
6952 task->mSavedStateFile.raw(), vrc);
6953 rc = E_FAIL;
6954 }
6955 }
6956
6957 /* lock the console once we're going to access it */
6958 AutoWriteLock thatLock (that);
6959
6960 if (SUCCEEDED (rc))
6961 {
6962 if (task->mIsSnapshot)
6963 do
6964 {
6965 LogFlowFunc (("Reattaching new differencing hard disks...\n"));
6966
6967 com::SafeIfaceArray <IHardDiskAttachment> atts;
6968 rc = that->mMachine->
6969 COMGETTER(HardDiskAttachments) (ComSafeArrayAsOutParam (atts));
6970 if (FAILED (rc))
6971 break;
6972 for (size_t i = 0; i < atts.size(); ++ i)
6973 {
6974 PVMREQ pReq;
6975 ComPtr<IStorageController> controller;
6976 BSTR controllerName;
6977 ULONG lInstance;
6978 StorageControllerType_T enmController;
6979
6980 /*
6981 * We can't pass a storage controller object directly
6982 * (g++ complains about not being able to pass non POD types through '...')
6983 * so we have to query needed values here and pass them.
6984 */
6985 rc = atts[i]->COMGETTER(Controller)(&controllerName);
6986 if (FAILED (rc))
6987 break;
6988
6989 rc = that->mMachine->GetStorageControllerByName(controllerName, controller.asOutParam());
6990 if (FAILED (rc))
6991 break;
6992
6993 rc = controller->COMGETTER(ControllerType)(&enmController);
6994 rc = controller->COMGETTER(Instance)(&lInstance);
6995 /*
6996 * don't leave the lock since reconfigureHardDisks isn't going
6997 * to access Console.
6998 */
6999 int vrc = VMR3ReqCall (that->mpVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
7000 (PFNRT)reconfigureHardDisks, 5, that->mpVM, lInstance,
7001 enmController, atts [i], &rc);
7002 if (VBOX_SUCCESS (rc))
7003 rc = pReq->iStatus;
7004 VMR3ReqFree (pReq);
7005 if (FAILED (rc))
7006 break;
7007 if (VBOX_FAILURE (vrc))
7008 {
7009 errMsg = Utf8StrFmt (Console::tr ("%Rrc"), vrc);
7010 rc = E_FAIL;
7011 break;
7012 }
7013 }
7014 }
7015 while (0);
7016 }
7017
7018 /* finalize the procedure regardless of the result */
7019 if (task->mIsSnapshot)
7020 {
7021 /*
7022 * finalize the requested snapshot object.
7023 * This will reset the machine state to the state it had right
7024 * before calling mControl->BeginTakingSnapshot().
7025 */
7026 that->mControl->EndTakingSnapshot (SUCCEEDED (rc));
7027 }
7028 else
7029 {
7030 /*
7031 * finalize the requested save state procedure.
7032 * In case of success, the server will set the machine state to Saved;
7033 * in case of failure it will reset the it to the state it had right
7034 * before calling mControl->BeginSavingState().
7035 */
7036 that->mControl->EndSavingState (SUCCEEDED (rc));
7037 }
7038
7039 /* synchronize the state with the server */
7040 if (task->mIsSnapshot || FAILED (rc))
7041 {
7042 if (task->mLastMachineState == MachineState_Running)
7043 {
7044 /* restore the paused state if appropriate */
7045 that->setMachineStateLocally (MachineState_Paused);
7046 /* restore the running state if appropriate */
7047 that->Resume();
7048 }
7049 else
7050 that->setMachineStateLocally (task->mLastMachineState);
7051 }
7052 else
7053 {
7054 /*
7055 * The machine has been successfully saved, so power it down
7056 * (vmstateChangeCallback() will set state to Saved on success).
7057 * Note: we release the task's VM caller, otherwise it will
7058 * deadlock.
7059 */
7060 task->releaseVMCaller();
7061
7062 rc = that->powerDown();
7063 }
7064
7065 /* notify the progress object about operation completion */
7066 if (SUCCEEDED (rc))
7067 task->mProgress->notifyComplete (S_OK);
7068 else
7069 {
7070 if (!errMsg.isNull())
7071 task->mProgress->notifyComplete (rc,
7072 COM_IIDOF(IConsole), Console::getComponentName(), errMsg);
7073 else
7074 task->mProgress->notifyComplete (rc);
7075 }
7076
7077 LogFlowFuncLeave();
7078 return VINF_SUCCESS;
7079}
7080
7081/**
7082 * Thread for powering down the Console.
7083 *
7084 * @param Thread The thread handle.
7085 * @param pvUser Pointer to the VMTask structure.
7086 * @return VINF_SUCCESS (ignored).
7087 *
7088 * @note Locks the Console object for writing.
7089 */
7090/*static*/
7091DECLCALLBACK (int) Console::powerDownThread (RTTHREAD Thread, void *pvUser)
7092{
7093 LogFlowFuncEnter();
7094
7095 std::auto_ptr <VMProgressTask> task (static_cast <VMProgressTask *> (pvUser));
7096 AssertReturn (task.get(), VERR_INVALID_PARAMETER);
7097
7098 AssertReturn (task->isOk(), VERR_GENERAL_FAILURE);
7099
7100 const ComObjPtr <Console> &that = task->mConsole;
7101
7102 /* Note: no need to use addCaller() to protect Console because VMTask does
7103 * that */
7104
7105 /* wait until the method tat started us returns */
7106 AutoWriteLock thatLock (that);
7107
7108 /* release VM caller to avoid the powerDown() deadlock */
7109 task->releaseVMCaller();
7110
7111 that->powerDown (task->mProgress);
7112
7113 LogFlowFuncLeave();
7114 return VINF_SUCCESS;
7115}
7116
7117/**
7118 * The Main status driver instance data.
7119 */
7120typedef struct DRVMAINSTATUS
7121{
7122 /** The LED connectors. */
7123 PDMILEDCONNECTORS ILedConnectors;
7124 /** Pointer to the LED ports interface above us. */
7125 PPDMILEDPORTS pLedPorts;
7126 /** Pointer to the array of LED pointers. */
7127 PPDMLED *papLeds;
7128 /** The unit number corresponding to the first entry in the LED array. */
7129 RTUINT iFirstLUN;
7130 /** The unit number corresponding to the last entry in the LED array.
7131 * (The size of the LED array is iLastLUN - iFirstLUN + 1.) */
7132 RTUINT iLastLUN;
7133} DRVMAINSTATUS, *PDRVMAINSTATUS;
7134
7135
7136/**
7137 * Notification about a unit which have been changed.
7138 *
7139 * The driver must discard any pointers to data owned by
7140 * the unit and requery it.
7141 *
7142 * @param pInterface Pointer to the interface structure containing the called function pointer.
7143 * @param iLUN The unit number.
7144 */
7145DECLCALLBACK(void) Console::drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN)
7146{
7147 PDRVMAINSTATUS pData = (PDRVMAINSTATUS)(void *)pInterface;
7148 if (iLUN >= pData->iFirstLUN && iLUN <= pData->iLastLUN)
7149 {
7150 PPDMLED pLed;
7151 int rc = pData->pLedPorts->pfnQueryStatusLed(pData->pLedPorts, iLUN, &pLed);
7152 if (VBOX_FAILURE(rc))
7153 pLed = NULL;
7154 ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLUN - pData->iFirstLUN], pLed);
7155 Log(("drvStatus_UnitChanged: iLUN=%d pLed=%p\n", iLUN, pLed));
7156 }
7157}
7158
7159
7160/**
7161 * Queries an interface to the driver.
7162 *
7163 * @returns Pointer to interface.
7164 * @returns NULL if the interface was not supported by the driver.
7165 * @param pInterface Pointer to this interface structure.
7166 * @param enmInterface The requested interface identification.
7167 */
7168DECLCALLBACK(void *) Console::drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
7169{
7170 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
7171 PDRVMAINSTATUS pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7172 switch (enmInterface)
7173 {
7174 case PDMINTERFACE_BASE:
7175 return &pDrvIns->IBase;
7176 case PDMINTERFACE_LED_CONNECTORS:
7177 return &pDrv->ILedConnectors;
7178 default:
7179 return NULL;
7180 }
7181}
7182
7183
7184/**
7185 * Destruct a status driver instance.
7186 *
7187 * @returns VBox status.
7188 * @param pDrvIns The driver instance data.
7189 */
7190DECLCALLBACK(void) Console::drvStatus_Destruct(PPDMDRVINS pDrvIns)
7191{
7192 PDRVMAINSTATUS pData = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7193 LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7194 if (pData->papLeds)
7195 {
7196 unsigned iLed = pData->iLastLUN - pData->iFirstLUN + 1;
7197 while (iLed-- > 0)
7198 ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLed], NULL);
7199 }
7200}
7201
7202
7203/**
7204 * Construct a status driver instance.
7205 *
7206 * @returns VBox status.
7207 * @param pDrvIns The driver instance data.
7208 * If the registration structure is needed, pDrvIns->pDrvReg points to it.
7209 * @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
7210 * of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
7211 * iInstance it's expected to be used a bit in this function.
7212 */
7213DECLCALLBACK(int) Console::drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
7214{
7215 PDRVMAINSTATUS pData = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7216 LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7217
7218 /*
7219 * Validate configuration.
7220 */
7221 if (!CFGMR3AreValuesValid(pCfgHandle, "papLeds\0First\0Last\0"))
7222 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
7223 PPDMIBASE pBaseIgnore;
7224 int rc = pDrvIns->pDrvHlp->pfnAttach(pDrvIns, &pBaseIgnore);
7225 if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
7226 {
7227 AssertMsgFailed(("Configuration error: Not possible to attach anything to this driver!\n"));
7228 return VERR_PDM_DRVINS_NO_ATTACH;
7229 }
7230
7231 /*
7232 * Data.
7233 */
7234 pDrvIns->IBase.pfnQueryInterface = Console::drvStatus_QueryInterface;
7235 pData->ILedConnectors.pfnUnitChanged = Console::drvStatus_UnitChanged;
7236
7237 /*
7238 * Read config.
7239 */
7240 rc = CFGMR3QueryPtr(pCfgHandle, "papLeds", (void **)&pData->papLeds);
7241 if (VBOX_FAILURE(rc))
7242 {
7243 AssertMsgFailed(("Configuration error: Failed to query the \"papLeds\" value! rc=%Rrc\n", rc));
7244 return rc;
7245 }
7246
7247 rc = CFGMR3QueryU32(pCfgHandle, "First", &pData->iFirstLUN);
7248 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7249 pData->iFirstLUN = 0;
7250 else if (VBOX_FAILURE(rc))
7251 {
7252 AssertMsgFailed(("Configuration error: Failed to query the \"First\" value! rc=%Rrc\n", rc));
7253 return rc;
7254 }
7255
7256 rc = CFGMR3QueryU32(pCfgHandle, "Last", &pData->iLastLUN);
7257 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7258 pData->iLastLUN = 0;
7259 else if (VBOX_FAILURE(rc))
7260 {
7261 AssertMsgFailed(("Configuration error: Failed to query the \"Last\" value! rc=%Rrc\n", rc));
7262 return rc;
7263 }
7264 if (pData->iFirstLUN > pData->iLastLUN)
7265 {
7266 AssertMsgFailed(("Configuration error: Invalid unit range %u-%u\n", pData->iFirstLUN, pData->iLastLUN));
7267 return VERR_GENERAL_FAILURE;
7268 }
7269
7270 /*
7271 * Get the ILedPorts interface of the above driver/device and
7272 * query the LEDs we want.
7273 */
7274 pData->pLedPorts = (PPDMILEDPORTS)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_LED_PORTS);
7275 if (!pData->pLedPorts)
7276 {
7277 AssertMsgFailed(("Configuration error: No led ports interface above!\n"));
7278 return VERR_PDM_MISSING_INTERFACE_ABOVE;
7279 }
7280
7281 for (unsigned i = pData->iFirstLUN; i <= pData->iLastLUN; i++)
7282 Console::drvStatus_UnitChanged(&pData->ILedConnectors, i);
7283
7284 return VINF_SUCCESS;
7285}
7286
7287
7288/**
7289 * Keyboard driver registration record.
7290 */
7291const PDMDRVREG Console::DrvStatusReg =
7292{
7293 /* u32Version */
7294 PDM_DRVREG_VERSION,
7295 /* szDriverName */
7296 "MainStatus",
7297 /* pszDescription */
7298 "Main status driver (Main as in the API).",
7299 /* fFlags */
7300 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
7301 /* fClass. */
7302 PDM_DRVREG_CLASS_STATUS,
7303 /* cMaxInstances */
7304 ~0,
7305 /* cbInstance */
7306 sizeof(DRVMAINSTATUS),
7307 /* pfnConstruct */
7308 Console::drvStatus_Construct,
7309 /* pfnDestruct */
7310 Console::drvStatus_Destruct,
7311 /* pfnIOCtl */
7312 NULL,
7313 /* pfnPowerOn */
7314 NULL,
7315 /* pfnReset */
7316 NULL,
7317 /* pfnSuspend */
7318 NULL,
7319 /* pfnResume */
7320 NULL,
7321 /* pfnDetach */
7322 NULL
7323};
7324/* 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