VirtualBox

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

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

LogRel() the amount of available host memory as well
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 230.9 KB
Line 
1/* $Id: ConsoleImpl.cpp 20384 2009-06-08 08:46:55Z 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 ComPtr <IHost> host;
4223 virtualBox->COMGETTER(Host)(host.asOutParam());
4224 ULONG uHostRamMb = 0, uHostRamAvailMb = 0;
4225 host->COMGETTER(MemorySize)(&uHostRamMb);
4226 host->COMGETTER(MemoryAvailable)(&uHostRamAvailMb);
4227 if (uLogHistoryCount)
4228 {
4229 for (int i = uLogHistoryCount-1; i >= 0; i--)
4230 {
4231 Utf8Str *files[] = { &logFile, &pngFile };
4232 Utf8Str oldName, newName;
4233
4234 for (unsigned int j = 0; j < RT_ELEMENTS (files); ++ j)
4235 {
4236 if (i > 0)
4237 oldName = Utf8StrFmt ("%s.%d", files [j]->raw(), i);
4238 else
4239 oldName = *files [j];
4240 newName = Utf8StrFmt ("%s.%d", files [j]->raw(), i + 1);
4241 /* If the old file doesn't exist, delete the new file (if it
4242 * exists) to provide correct rotation even if the sequence is
4243 * broken */
4244 if ( RTFileRename (oldName, newName, RTFILEMOVE_FLAGS_REPLACE)
4245 == VERR_FILE_NOT_FOUND)
4246 RTFileDelete (newName);
4247 }
4248 }
4249 }
4250
4251 PRTLOGGER loggerRelease;
4252 static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
4253 RTUINT fFlags = RTLOGFLAGS_PREFIX_TIME_PROG;
4254#if defined (RT_OS_WINDOWS) || defined (RT_OS_OS2)
4255 fFlags |= RTLOGFLAGS_USECRLF;
4256#endif
4257 char szError[RTPATH_MAX + 128] = "";
4258 int vrc = RTLogCreateEx(&loggerRelease, fFlags, "all",
4259 "VBOX_RELEASE_LOG", RT_ELEMENTS(s_apszGroups), s_apszGroups,
4260 RTLOGDEST_FILE, szError, sizeof(szError), logFile.raw());
4261 if (RT_SUCCESS(vrc))
4262 {
4263 /* some introductory information */
4264 RTTIMESPEC timeSpec;
4265 char szTmp[256];
4266 RTTimeSpecToString(RTTimeNow(&timeSpec), szTmp, sizeof(szTmp));
4267 RTLogRelLogger(loggerRelease, 0, ~0U,
4268 "VirtualBox %s r%d %s (%s %s) release log\n"
4269 "Log opened %s\n",
4270 VBOX_VERSION_STRING, VBoxSVNRev (), VBOX_BUILD_TARGET,
4271 __DATE__, __TIME__, szTmp);
4272
4273 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szTmp, sizeof(szTmp));
4274 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4275 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Product: %s\n", szTmp);
4276 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szTmp, sizeof(szTmp));
4277 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4278 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Release: %s\n", szTmp);
4279 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szTmp, sizeof(szTmp));
4280 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4281 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Version: %s\n", szTmp);
4282 vrc = RTSystemQueryOSInfo(RTSYSOSINFO_SERVICE_PACK, szTmp, sizeof(szTmp));
4283 if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
4284 RTLogRelLogger(loggerRelease, 0, ~0U, "OS Service Pack: %s\n", szTmp);
4285 RTLogRelLogger(loggerRelease, 0, ~0U, "Host RAM: %uMB RAM, available: %uMB\n",
4286 uHostRamMb, uHostRamAvailMb);
4287 /* the package type is interesting for Linux distributions */
4288 char szExecName[RTPATH_MAX];
4289 char *pszExecName = RTProcGetExecutableName(szExecName, sizeof(szExecName));
4290 RTLogRelLogger(loggerRelease, 0, ~0U,
4291 "Executable: %s\n"
4292 "Process ID: %u\n"
4293 "Package type: %s"
4294#ifdef VBOX_OSE
4295 " (OSE)"
4296#endif
4297 "\n",
4298 pszExecName ? pszExecName : "unknown",
4299 RTProcSelf(),
4300 VBOX_PACKAGE_STRING);
4301
4302 /* register this logger as the release logger */
4303 RTLogRelSetDefaultInstance(loggerRelease);
4304 hrc = S_OK;
4305 }
4306 else
4307 hrc = setError (E_FAIL,
4308 tr ("Failed to open release log (%s, %Rrc)"), szError, vrc);
4309
4310 return hrc;
4311}
4312
4313/**
4314 * Common worker for PowerUp and PowerUpPaused.
4315 *
4316 * @returns COM status code.
4317 *
4318 * @param aProgress Where to return the progress object.
4319 * @param aPaused true if PowerUpPaused called.
4320 *
4321 * @todo move down to powerDown();
4322 */
4323HRESULT Console::powerUp (IProgress **aProgress, bool aPaused)
4324{
4325 if (aProgress == NULL)
4326 return E_POINTER;
4327
4328 LogFlowThisFuncEnter();
4329 LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
4330
4331 AutoCaller autoCaller (this);
4332 CheckComRCReturnRC (autoCaller.rc());
4333
4334 AutoWriteLock alock (this);
4335
4336 if (Global::IsOnlineOrTransient (mMachineState))
4337 return setError(VBOX_E_INVALID_VM_STATE,
4338 tr ("Virtual machine is already running or busy "
4339 "(machine state: %d)"), mMachineState);
4340
4341 HRESULT rc = S_OK;
4342
4343 /* the network cards will undergo a quick consistency check */
4344 for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
4345 {
4346 ComPtr<INetworkAdapter> adapter;
4347 mMachine->GetNetworkAdapter (slot, adapter.asOutParam());
4348 BOOL enabled = FALSE;
4349 adapter->COMGETTER(Enabled) (&enabled);
4350 if (!enabled)
4351 continue;
4352
4353 NetworkAttachmentType_T netattach;
4354 adapter->COMGETTER(AttachmentType)(&netattach);
4355 switch (netattach)
4356 {
4357 case NetworkAttachmentType_Bridged:
4358 {
4359#ifdef RT_OS_WINDOWS
4360 /* a valid host interface must have been set */
4361 Bstr hostif;
4362 adapter->COMGETTER(HostInterface)(hostif.asOutParam());
4363 if (!hostif)
4364 {
4365 return setError (VBOX_E_HOST_ERROR,
4366 tr ("VM cannot start because host interface networking "
4367 "requires a host interface name to be set"));
4368 }
4369 ComPtr<IVirtualBox> virtualBox;
4370 mMachine->COMGETTER(Parent)(virtualBox.asOutParam());
4371 ComPtr<IHost> host;
4372 virtualBox->COMGETTER(Host)(host.asOutParam());
4373 ComPtr<IHostNetworkInterface> hostInterface;
4374 if (!SUCCEEDED(host->FindHostNetworkInterfaceByName(hostif, hostInterface.asOutParam())))
4375 {
4376 return setError (VBOX_E_HOST_ERROR,
4377 tr ("VM cannot start because the host interface '%ls' "
4378 "does not exist"),
4379 hostif.raw());
4380 }
4381#endif /* RT_OS_WINDOWS */
4382 break;
4383 }
4384 default:
4385 break;
4386 }
4387 }
4388
4389 /* Read console data stored in the saved state file (if not yet done) */
4390 rc = loadDataFromSavedState();
4391 CheckComRCReturnRC (rc);
4392
4393 /* Check all types of shared folders and compose a single list */
4394 SharedFolderDataMap sharedFolders;
4395 {
4396 /* first, insert global folders */
4397 for (SharedFolderDataMap::const_iterator it = mGlobalSharedFolders.begin();
4398 it != mGlobalSharedFolders.end(); ++ it)
4399 sharedFolders [it->first] = it->second;
4400
4401 /* second, insert machine folders */
4402 for (SharedFolderDataMap::const_iterator it = mMachineSharedFolders.begin();
4403 it != mMachineSharedFolders.end(); ++ it)
4404 sharedFolders [it->first] = it->second;
4405
4406 /* third, insert console folders */
4407 for (SharedFolderMap::const_iterator it = mSharedFolders.begin();
4408 it != mSharedFolders.end(); ++ it)
4409 sharedFolders [it->first] = SharedFolderData(it->second->hostPath(), it->second->writable());
4410 }
4411
4412 Bstr savedStateFile;
4413
4414 /*
4415 * Saved VMs will have to prove that their saved states are kosher.
4416 */
4417 if (mMachineState == MachineState_Saved)
4418 {
4419 rc = mMachine->COMGETTER(StateFilePath) (savedStateFile.asOutParam());
4420 CheckComRCReturnRC (rc);
4421 ComAssertRet (!!savedStateFile, E_FAIL);
4422 int vrc = SSMR3ValidateFile (Utf8Str (savedStateFile));
4423 if (VBOX_FAILURE (vrc))
4424 return setError (VBOX_E_FILE_ERROR,
4425 tr ("VM cannot start because the saved state file '%ls' is invalid (%Rrc). "
4426 "Discard the saved state prior to starting the VM"),
4427 savedStateFile.raw(), vrc);
4428 }
4429
4430 /* create a progress object to track progress of this operation */
4431 ComObjPtr <Progress> powerupProgress;
4432 powerupProgress.createObject();
4433 Bstr progressDesc;
4434 if (mMachineState == MachineState_Saved)
4435 progressDesc = tr ("Restoring virtual machine");
4436 else
4437 progressDesc = tr ("Starting virtual machine");
4438 rc = powerupProgress->init (static_cast <IConsole *> (this),
4439 progressDesc, FALSE /* aCancelable */);
4440 CheckComRCReturnRC (rc);
4441
4442 /* setup task object and thread to carry out the operation
4443 * asynchronously */
4444
4445 std::auto_ptr <VMPowerUpTask> task (new VMPowerUpTask (this, powerupProgress));
4446 ComAssertComRCRetRC (task->rc());
4447
4448 task->mSetVMErrorCallback = setVMErrorCallback;
4449 task->mConfigConstructor = configConstructor;
4450 task->mSharedFolders = sharedFolders;
4451 task->mStartPaused = aPaused;
4452 if (mMachineState == MachineState_Saved)
4453 task->mSavedStateFile = savedStateFile;
4454
4455 /* Reset differencing hard disks for which autoReset is true */
4456 {
4457 com::SafeIfaceArray <IHardDiskAttachment> atts;
4458 rc = mMachine->
4459 COMGETTER(HardDiskAttachments) (ComSafeArrayAsOutParam (atts));
4460 CheckComRCReturnRC (rc);
4461
4462 for (size_t i = 0; i < atts.size(); ++ i)
4463 {
4464 ComPtr <IHardDisk> hardDisk;
4465 rc = atts [i]->COMGETTER(HardDisk) (hardDisk.asOutParam());
4466 CheckComRCReturnRC (rc);
4467
4468 /* save for later use on the powerup thread */
4469 task->hardDisks.push_back (hardDisk);
4470
4471 /* needs autoreset? */
4472 BOOL autoReset = FALSE;
4473 rc = hardDisk->COMGETTER(AutoReset)(&autoReset);
4474 CheckComRCReturnRC (rc);
4475
4476 if (autoReset)
4477 {
4478 ComPtr <IProgress> resetProgress;
4479 rc = hardDisk->Reset (resetProgress.asOutParam());
4480 CheckComRCReturnRC (rc);
4481
4482 /* save for later use on the powerup thread */
4483 task->hardDiskProgresses.push_back (resetProgress);
4484 }
4485 }
4486 }
4487
4488 rc = consoleInitReleaseLog (mMachine);
4489 CheckComRCReturnRC (rc);
4490
4491 /* pass the progress object to the caller if requested */
4492 if (aProgress)
4493 {
4494 if (task->hardDiskProgresses.size() == 0)
4495 {
4496 /* there are no other operations to track, return the powerup
4497 * progress only */
4498 powerupProgress.queryInterfaceTo (aProgress);
4499 }
4500 else
4501 {
4502 /* create a combined progress object */
4503 ComObjPtr <CombinedProgress> progress;
4504 progress.createObject();
4505 VMPowerUpTask::ProgressList progresses (task->hardDiskProgresses);
4506 progresses.push_back (ComPtr <IProgress> (powerupProgress));
4507 rc = progress->init (static_cast <IConsole *> (this),
4508 progressDesc, progresses.begin(),
4509 progresses.end());
4510 AssertComRCReturnRC (rc);
4511 progress.queryInterfaceTo (aProgress);
4512 }
4513 }
4514
4515 int vrc = RTThreadCreate (NULL, Console::powerUpThread, (void *) task.get(),
4516 0, RTTHREADTYPE_MAIN_WORKER, 0, "VMPowerUp");
4517
4518 ComAssertMsgRCRet (vrc, ("Could not create VMPowerUp thread (%Rrc)", vrc),
4519 E_FAIL);
4520
4521 /* task is now owned by powerUpThread(), so release it */
4522 task.release();
4523
4524 /* finally, set the state: no right to fail in this method afterwards
4525 * since we've already started the thread and it is now responsible for
4526 * any error reporting and appropriate state change! */
4527
4528 if (mMachineState == MachineState_Saved)
4529 setMachineState (MachineState_Restoring);
4530 else
4531 setMachineState (MachineState_Starting);
4532
4533 LogFlowThisFunc (("mMachineState=%d\n", mMachineState));
4534 LogFlowThisFuncLeave();
4535 return S_OK;
4536}
4537
4538/**
4539 * Internal power off worker routine.
4540 *
4541 * This method may be called only at certain places with the following meaning
4542 * as shown below:
4543 *
4544 * - if the machine state is either Running or Paused, a normal
4545 * Console-initiated powerdown takes place (e.g. PowerDown());
4546 * - if the machine state is Saving, saveStateThread() has successfully done its
4547 * job;
4548 * - if the machine state is Starting or Restoring, powerUpThread() has failed
4549 * to start/load the VM;
4550 * - if the machine state is Stopping, the VM has powered itself off (i.e. not
4551 * as a result of the powerDown() call).
4552 *
4553 * Calling it in situations other than the above will cause unexpected behavior.
4554 *
4555 * Note that this method should be the only one that destroys mpVM and sets it
4556 * to NULL.
4557 *
4558 * @param aProgress Progress object to run (may be NULL).
4559 *
4560 * @note Locks this object for writing.
4561 *
4562 * @note Never call this method from a thread that called addVMCaller() or
4563 * instantiated an AutoVMCaller object; first call releaseVMCaller() or
4564 * release(). Otherwise it will deadlock.
4565 */
4566HRESULT Console::powerDown (Progress *aProgress /*= NULL*/)
4567{
4568 LogFlowThisFuncEnter();
4569
4570 AutoCaller autoCaller (this);
4571 AssertComRCReturnRC (autoCaller.rc());
4572
4573 AutoWriteLock alock (this);
4574
4575 /* Total # of steps for the progress object. Must correspond to the
4576 * number of "advance percent count" comments in this method! */
4577 enum { StepCount = 7 };
4578 /* current step */
4579 ULONG step = 0;
4580
4581 HRESULT rc = S_OK;
4582 int vrc = VINF_SUCCESS;
4583
4584 /* sanity */
4585 Assert (mVMDestroying == false);
4586
4587 Assert (mpVM != NULL);
4588
4589 AssertMsg (mMachineState == MachineState_Running ||
4590 mMachineState == MachineState_Paused ||
4591 mMachineState == MachineState_Stuck ||
4592 mMachineState == MachineState_Saving ||
4593 mMachineState == MachineState_Starting ||
4594 mMachineState == MachineState_Restoring ||
4595 mMachineState == MachineState_Stopping,
4596 ("Invalid machine state: %d\n", mMachineState));
4597
4598 LogRel (("Console::powerDown(): A request to power off the VM has been "
4599 "issued (mMachineState=%d, InUninit=%d)\n",
4600 mMachineState, autoCaller.state() == InUninit));
4601
4602 /* Check if we need to power off the VM. In case of mVMPoweredOff=true, the
4603 * VM has already powered itself off in vmstateChangeCallback() and is just
4604 * notifying Console about that. In case of Starting or Restoring,
4605 * powerUpThread() is calling us on failure, so the VM is already off at
4606 * that point. */
4607 if (!mVMPoweredOff &&
4608 (mMachineState == MachineState_Starting ||
4609 mMachineState == MachineState_Restoring))
4610 mVMPoweredOff = true;
4611
4612 /* go to Stopping state if not already there. Note that we don't go from
4613 * Saving/Restoring to Stopping because vmstateChangeCallback() needs it to
4614 * set the state to Saved on VMSTATE_TERMINATED. In terms of protecting from
4615 * inappropriate operations while leaving the lock below, Saving or
4616 * Restoring should be fine too */
4617 if (mMachineState != MachineState_Saving &&
4618 mMachineState != MachineState_Restoring &&
4619 mMachineState != MachineState_Stopping)
4620 setMachineState (MachineState_Stopping);
4621
4622 /* ----------------------------------------------------------------------
4623 * DONE with necessary state changes, perform the power down actions (it's
4624 * safe to leave the object lock now if needed)
4625 * ---------------------------------------------------------------------- */
4626
4627 /* Stop the VRDP server to prevent new clients connection while VM is being
4628 * powered off. */
4629 if (mConsoleVRDPServer)
4630 {
4631 LogFlowThisFunc (("Stopping VRDP server...\n"));
4632
4633 /* Leave the lock since EMT will call us back as addVMCaller()
4634 * in updateDisplayData(). */
4635 alock.leave();
4636
4637 mConsoleVRDPServer->Stop();
4638
4639 alock.enter();
4640 }
4641
4642 /* advance percent count */
4643 if (aProgress)
4644 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4645
4646#ifdef VBOX_WITH_HGCM
4647
4648# ifdef VBOX_WITH_GUEST_PROPS
4649
4650 /* Save all guest property store entries to the machine XML file */
4651 com::SafeArray <BSTR> namesOut;
4652 com::SafeArray <BSTR> valuesOut;
4653 com::SafeArray <ULONG64> timestampsOut;
4654 com::SafeArray <BSTR> flagsOut;
4655 Bstr pattern("");
4656 if (pattern.isNull())
4657 rc = E_OUTOFMEMORY;
4658 else
4659 rc = doEnumerateGuestProperties (Bstr (""), ComSafeArrayAsOutParam (namesOut),
4660 ComSafeArrayAsOutParam (valuesOut),
4661 ComSafeArrayAsOutParam (timestampsOut),
4662 ComSafeArrayAsOutParam (flagsOut));
4663 if (SUCCEEDED(rc))
4664 {
4665 try
4666 {
4667 std::vector <BSTR> names;
4668 std::vector <BSTR> values;
4669 std::vector <ULONG64> timestamps;
4670 std::vector <BSTR> flags;
4671 for (unsigned i = 0; i < namesOut.size(); ++i)
4672 {
4673 uint32_t fFlags;
4674 guestProp::validateFlags (Utf8Str(flagsOut[i]).raw(), &fFlags);
4675 if ( !( fFlags & guestProp::TRANSIENT)
4676 || (mMachineState == MachineState_Saving)
4677 )
4678 {
4679 names.push_back(namesOut[i]);
4680 values.push_back(valuesOut[i]);
4681 timestamps.push_back(timestampsOut[i]);
4682 flags.push_back(flagsOut[i]);
4683 }
4684 }
4685 com::SafeArray <BSTR> namesIn (names);
4686 com::SafeArray <BSTR> valuesIn (values);
4687 com::SafeArray <ULONG64> timestampsIn (timestamps);
4688 com::SafeArray <BSTR> flagsIn (flags);
4689 if ( namesIn.isNull()
4690 || valuesIn.isNull()
4691 || timestampsIn.isNull()
4692 || flagsIn.isNull()
4693 )
4694 throw std::bad_alloc();
4695 /* PushGuestProperties() calls DiscardSettings(), which calls us back */
4696 alock.leave();
4697 mControl->PushGuestProperties (ComSafeArrayAsInParam (namesIn),
4698 ComSafeArrayAsInParam (valuesIn),
4699 ComSafeArrayAsInParam (timestampsIn),
4700 ComSafeArrayAsInParam (flagsIn));
4701 alock.enter();
4702 }
4703 catch (std::bad_alloc)
4704 {
4705 rc = E_OUTOFMEMORY;
4706 }
4707 }
4708
4709 /* advance percent count */
4710 if (aProgress)
4711 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4712
4713# endif /* VBOX_WITH_GUEST_PROPS defined */
4714
4715 /* Shutdown HGCM services before stopping the guest, because they might
4716 * need a cleanup. */
4717 if (mVMMDev)
4718 {
4719 LogFlowThisFunc (("Shutdown HGCM...\n"));
4720
4721 /* Leave the lock since EMT will call us back as addVMCaller() */
4722 alock.leave();
4723
4724 mVMMDev->hgcmShutdown ();
4725
4726 alock.enter();
4727 }
4728
4729 /* advance percent count */
4730 if (aProgress)
4731 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4732
4733#endif /* VBOX_WITH_HGCM */
4734
4735 /* ----------------------------------------------------------------------
4736 * Now, wait for all mpVM callers to finish their work if there are still
4737 * some on other threads. NO methods that need mpVM (or initiate other calls
4738 * that need it) may be called after this point
4739 * ---------------------------------------------------------------------- */
4740
4741 if (mVMCallers > 0)
4742 {
4743 /* go to the destroying state to prevent from adding new callers */
4744 mVMDestroying = true;
4745
4746 /* lazy creation */
4747 if (mVMZeroCallersSem == NIL_RTSEMEVENT)
4748 RTSemEventCreate (&mVMZeroCallersSem);
4749
4750 LogFlowThisFunc (("Waiting for mpVM callers (%d) to drop to zero...\n",
4751 mVMCallers));
4752
4753 alock.leave();
4754
4755 RTSemEventWait (mVMZeroCallersSem, RT_INDEFINITE_WAIT);
4756
4757 alock.enter();
4758 }
4759
4760 /* advance percent count */
4761 if (aProgress)
4762 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4763
4764 vrc = VINF_SUCCESS;
4765
4766 /* Power off the VM if not already done that */
4767 if (!mVMPoweredOff)
4768 {
4769 LogFlowThisFunc (("Powering off the VM...\n"));
4770
4771 /* Leave the lock since EMT will call us back on VMR3PowerOff() */
4772 alock.leave();
4773
4774 vrc = VMR3PowerOff (mpVM);
4775
4776 /* Note that VMR3PowerOff() may fail here (invalid VMSTATE) if the
4777 * VM-(guest-)initiated power off happened in parallel a ms before this
4778 * call. So far, we let this error pop up on the user's side. */
4779
4780 alock.enter();
4781
4782 }
4783 else
4784 {
4785 /* reset the flag for further re-use */
4786 mVMPoweredOff = false;
4787 }
4788
4789 /* advance percent count */
4790 if (aProgress)
4791 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4792
4793 LogFlowThisFunc (("Ready for VM destruction.\n"));
4794
4795 /* If we are called from Console::uninit(), then try to destroy the VM even
4796 * on failure (this will most likely fail too, but what to do?..) */
4797 if (VBOX_SUCCESS (vrc) || autoCaller.state() == InUninit)
4798 {
4799 /* If the machine has an USB comtroller, release all USB devices
4800 * (symmetric to the code in captureUSBDevices()) */
4801 bool fHasUSBController = false;
4802 {
4803 PPDMIBASE pBase;
4804 int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
4805 if (VBOX_SUCCESS (vrc))
4806 {
4807 fHasUSBController = true;
4808 detachAllUSBDevices (false /* aDone */);
4809 }
4810 }
4811
4812 /* Now we've got to destroy the VM as well. (mpVM is not valid beyond
4813 * this point). We leave the lock before calling VMR3Destroy() because
4814 * it will result into calling destructors of drivers associated with
4815 * Console children which may in turn try to lock Console (e.g. by
4816 * instantiating SafeVMPtr to access mpVM). It's safe here because
4817 * mVMDestroying is set which should prevent any activity. */
4818
4819 /* Set mpVM to NULL early just in case if some old code is not using
4820 * addVMCaller()/releaseVMCaller(). */
4821 PVM pVM = mpVM;
4822 mpVM = NULL;
4823
4824 LogFlowThisFunc (("Destroying the VM...\n"));
4825
4826 alock.leave();
4827
4828 vrc = VMR3Destroy (pVM);
4829
4830 /* take the lock again */
4831 alock.enter();
4832
4833 /* advance percent count */
4834 if (aProgress)
4835 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4836
4837 if (VBOX_SUCCESS (vrc))
4838 {
4839 LogFlowThisFunc (("Machine has been destroyed (mMachineState=%d)\n",
4840 mMachineState));
4841 /* Note: the Console-level machine state change happens on the
4842 * VMSTATE_TERMINATE state change in vmstateChangeCallback(). If
4843 * powerDown() is called from EMT (i.e. from vmstateChangeCallback()
4844 * on receiving VM-initiated VMSTATE_OFF), VMSTATE_TERMINATE hasn't
4845 * occurred yet. This is okay, because mMachineState is already
4846 * Stopping in this case, so any other attempt to call PowerDown()
4847 * will be rejected. */
4848 }
4849 else
4850 {
4851 /* bad bad bad, but what to do? */
4852 mpVM = pVM;
4853 rc = setError (VBOX_E_VM_ERROR,
4854 tr ("Could not destroy the machine. (Error: %Rrc)"), vrc);
4855 }
4856
4857 /* Complete the detaching of the USB devices. */
4858 if (fHasUSBController)
4859 detachAllUSBDevices (true /* aDone */);
4860
4861 /* advance percent count */
4862 if (aProgress)
4863 aProgress->setCurrentOperationProgress(99 * (++ step) / StepCount );
4864 }
4865 else
4866 {
4867 rc = setError (VBOX_E_VM_ERROR,
4868 tr ("Could not power off the machine. (Error: %Rrc)"), vrc);
4869 }
4870
4871 /* Finished with destruction. Note that if something impossible happened and
4872 * we've failed to destroy the VM, mVMDestroying will remain true and
4873 * mMachineState will be something like Stopping, so most Console methods
4874 * will return an error to the caller. */
4875 if (mpVM == NULL)
4876 mVMDestroying = false;
4877
4878 if (SUCCEEDED (rc))
4879 {
4880 /* uninit dynamically allocated members of mCallbackData */
4881 if (mCallbackData.mpsc.valid)
4882 {
4883 if (mCallbackData.mpsc.shape != NULL)
4884 RTMemFree (mCallbackData.mpsc.shape);
4885 }
4886 memset (&mCallbackData, 0, sizeof (mCallbackData));
4887 }
4888
4889 /* complete the progress */
4890 if (aProgress)
4891 aProgress->notifyComplete (rc);
4892
4893 LogFlowThisFuncLeave();
4894 return rc;
4895}
4896
4897/**
4898 * @note Locks this object for writing.
4899 */
4900HRESULT Console::setMachineState (MachineState_T aMachineState,
4901 bool aUpdateServer /* = true */)
4902{
4903 AutoCaller autoCaller (this);
4904 AssertComRCReturnRC (autoCaller.rc());
4905
4906 AutoWriteLock alock (this);
4907
4908 HRESULT rc = S_OK;
4909
4910 if (mMachineState != aMachineState)
4911 {
4912 LogFlowThisFunc (("machineState=%d\n", aMachineState));
4913 mMachineState = aMachineState;
4914
4915 /// @todo (dmik)
4916 // possibly, we need to redo onStateChange() using the dedicated
4917 // Event thread, like it is done in VirtualBox. This will make it
4918 // much safer (no deadlocks possible if someone tries to use the
4919 // console from the callback), however, listeners will lose the
4920 // ability to synchronously react to state changes (is it really
4921 // necessary??)
4922 LogFlowThisFunc (("Doing onStateChange()...\n"));
4923 onStateChange (aMachineState);
4924 LogFlowThisFunc (("Done onStateChange()\n"));
4925
4926 if (aUpdateServer)
4927 {
4928 /* Server notification MUST be done from under the lock; otherwise
4929 * the machine state here and on the server might go out of sync
4930 * whihc can lead to various unexpected results (like the machine
4931 * state being >= MachineState_Running on the server, while the
4932 * session state is already SessionState_Closed at the same time
4933 * there).
4934 *
4935 * Cross-lock conditions should be carefully watched out: calling
4936 * UpdateState we will require Machine and SessionMachine locks
4937 * (remember that here we're holding the Console lock here, and also
4938 * all locks that have been entered by the thread before calling
4939 * this method).
4940 */
4941 LogFlowThisFunc (("Doing mControl->UpdateState()...\n"));
4942 rc = mControl->UpdateState (aMachineState);
4943 LogFlowThisFunc (("mControl->UpdateState()=%08X\n", rc));
4944 }
4945 }
4946
4947 return rc;
4948}
4949
4950/**
4951 * Searches for a shared folder with the given logical name
4952 * in the collection of shared folders.
4953 *
4954 * @param aName logical name of the shared folder
4955 * @param aSharedFolder where to return the found object
4956 * @param aSetError whether to set the error info if the folder is
4957 * not found
4958 * @return
4959 * S_OK when found or E_INVALIDARG when not found
4960 *
4961 * @note The caller must lock this object for writing.
4962 */
4963HRESULT Console::findSharedFolder (CBSTR aName,
4964 ComObjPtr <SharedFolder> &aSharedFolder,
4965 bool aSetError /* = false */)
4966{
4967 /* sanity check */
4968 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
4969
4970 SharedFolderMap::const_iterator it = mSharedFolders.find (aName);
4971 if (it != mSharedFolders.end())
4972 {
4973 aSharedFolder = it->second;
4974 return S_OK;
4975 }
4976
4977 if (aSetError)
4978 setError (VBOX_E_FILE_ERROR,
4979 tr ("Could not find a shared folder named '%ls'."), aName);
4980
4981 return VBOX_E_FILE_ERROR;
4982}
4983
4984/**
4985 * Fetches the list of global or machine shared folders from the server.
4986 *
4987 * @param aGlobal true to fetch global folders.
4988 *
4989 * @note The caller must lock this object for writing.
4990 */
4991HRESULT Console::fetchSharedFolders (BOOL aGlobal)
4992{
4993 /* sanity check */
4994 AssertReturn (AutoCaller (this).state() == InInit ||
4995 isWriteLockOnCurrentThread(), E_FAIL);
4996
4997 /* protect mpVM (if not NULL) */
4998 AutoVMCallerQuietWeak autoVMCaller (this);
4999
5000 HRESULT rc = S_OK;
5001
5002 bool online = mpVM && autoVMCaller.isOk() && mVMMDev->isShFlActive();
5003
5004 if (aGlobal)
5005 {
5006 /// @todo grab & process global folders when they are done
5007 }
5008 else
5009 {
5010 SharedFolderDataMap oldFolders;
5011 if (online)
5012 oldFolders = mMachineSharedFolders;
5013
5014 mMachineSharedFolders.clear();
5015
5016 SafeIfaceArray <ISharedFolder> folders;
5017 rc = mMachine->COMGETTER(SharedFolders) (ComSafeArrayAsOutParam(folders));
5018 AssertComRCReturnRC (rc);
5019
5020 for (size_t i = 0; i < folders.size(); ++i)
5021 {
5022 ComPtr <ISharedFolder> folder = folders[i];
5023
5024 Bstr name;
5025 Bstr hostPath;
5026 BOOL writable;
5027
5028 rc = folder->COMGETTER(Name) (name.asOutParam());
5029 CheckComRCBreakRC (rc);
5030 rc = folder->COMGETTER(HostPath) (hostPath.asOutParam());
5031 CheckComRCBreakRC (rc);
5032 rc = folder->COMGETTER(Writable) (&writable);
5033
5034 mMachineSharedFolders.insert (std::make_pair (name, SharedFolderData (hostPath, writable)));
5035
5036 /* send changes to HGCM if the VM is running */
5037 /// @todo report errors as runtime warnings through VMSetError
5038 if (online)
5039 {
5040 SharedFolderDataMap::iterator it = oldFolders.find (name);
5041 if (it == oldFolders.end() || it->second.mHostPath != hostPath)
5042 {
5043 /* a new machine folder is added or
5044 * the existing machine folder is changed */
5045 if (mSharedFolders.find (name) != mSharedFolders.end())
5046 ; /* the console folder exists, nothing to do */
5047 else
5048 {
5049 /* remove the old machine folder (when changed)
5050 * or the global folder if any (when new) */
5051 if (it != oldFolders.end() ||
5052 mGlobalSharedFolders.find (name) !=
5053 mGlobalSharedFolders.end())
5054 rc = removeSharedFolder (name);
5055 /* create the new machine folder */
5056 rc = createSharedFolder (name, SharedFolderData (hostPath, writable));
5057 }
5058 }
5059 /* forget the processed (or identical) folder */
5060 if (it != oldFolders.end())
5061 oldFolders.erase (it);
5062
5063 rc = S_OK;
5064 }
5065 }
5066
5067 AssertComRCReturnRC (rc);
5068
5069 /* process outdated (removed) folders */
5070 /// @todo report errors as runtime warnings through VMSetError
5071 if (online)
5072 {
5073 for (SharedFolderDataMap::const_iterator it = oldFolders.begin();
5074 it != oldFolders.end(); ++ it)
5075 {
5076 if (mSharedFolders.find (it->first) != mSharedFolders.end())
5077 ; /* the console folder exists, nothing to do */
5078 else
5079 {
5080 /* remove the outdated machine folder */
5081 rc = removeSharedFolder (it->first);
5082 /* create the global folder if there is any */
5083 SharedFolderDataMap::const_iterator git =
5084 mGlobalSharedFolders.find (it->first);
5085 if (git != mGlobalSharedFolders.end())
5086 rc = createSharedFolder (git->first, git->second);
5087 }
5088 }
5089
5090 rc = S_OK;
5091 }
5092 }
5093
5094 return rc;
5095}
5096
5097/**
5098 * Searches for a shared folder with the given name in the list of machine
5099 * shared folders and then in the list of the global shared folders.
5100 *
5101 * @param aName Name of the folder to search for.
5102 * @param aIt Where to store the pointer to the found folder.
5103 * @return @c true if the folder was found and @c false otherwise.
5104 *
5105 * @note The caller must lock this object for reading.
5106 */
5107bool Console::findOtherSharedFolder (IN_BSTR aName,
5108 SharedFolderDataMap::const_iterator &aIt)
5109{
5110 /* sanity check */
5111 AssertReturn (isWriteLockOnCurrentThread(), false);
5112
5113 /* first, search machine folders */
5114 aIt = mMachineSharedFolders.find (aName);
5115 if (aIt != mMachineSharedFolders.end())
5116 return true;
5117
5118 /* second, search machine folders */
5119 aIt = mGlobalSharedFolders.find (aName);
5120 if (aIt != mGlobalSharedFolders.end())
5121 return true;
5122
5123 return false;
5124}
5125
5126/**
5127 * Calls the HGCM service to add a shared folder definition.
5128 *
5129 * @param aName Shared folder name.
5130 * @param aHostPath Shared folder path.
5131 *
5132 * @note Must be called from under AutoVMCaller and when mpVM != NULL!
5133 * @note Doesn't lock anything.
5134 */
5135HRESULT Console::createSharedFolder (CBSTR aName, SharedFolderData aData)
5136{
5137 ComAssertRet (aName && *aName, E_FAIL);
5138 ComAssertRet (aData.mHostPath, E_FAIL);
5139
5140 /* sanity checks */
5141 AssertReturn (mpVM, E_FAIL);
5142 AssertReturn (mVMMDev->isShFlActive(), E_FAIL);
5143
5144 VBOXHGCMSVCPARM parms[SHFL_CPARMS_ADD_MAPPING];
5145 SHFLSTRING *pFolderName, *pMapName;
5146 size_t cbString;
5147
5148 Log (("Adding shared folder '%ls' -> '%ls'\n", aName, aData.mHostPath.raw()));
5149
5150 cbString = (RTUtf16Len (aData.mHostPath) + 1) * sizeof (RTUTF16);
5151 if (cbString >= UINT16_MAX)
5152 return setError (E_INVALIDARG, tr ("The name is too long"));
5153 pFolderName = (SHFLSTRING *) RTMemAllocZ (sizeof (SHFLSTRING) + cbString);
5154 Assert (pFolderName);
5155 memcpy (pFolderName->String.ucs2, aData.mHostPath, cbString);
5156
5157 pFolderName->u16Size = (uint16_t)cbString;
5158 pFolderName->u16Length = (uint16_t)cbString - sizeof(RTUTF16);
5159
5160 parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
5161 parms[0].u.pointer.addr = pFolderName;
5162 parms[0].u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5163
5164 cbString = (RTUtf16Len (aName) + 1) * sizeof (RTUTF16);
5165 if (cbString >= UINT16_MAX)
5166 {
5167 RTMemFree (pFolderName);
5168 return setError (E_INVALIDARG, tr ("The host path is too long"));
5169 }
5170 pMapName = (SHFLSTRING *) RTMemAllocZ (sizeof(SHFLSTRING) + cbString);
5171 Assert (pMapName);
5172 memcpy (pMapName->String.ucs2, aName, cbString);
5173
5174 pMapName->u16Size = (uint16_t)cbString;
5175 pMapName->u16Length = (uint16_t)cbString - sizeof (RTUTF16);
5176
5177 parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
5178 parms[1].u.pointer.addr = pMapName;
5179 parms[1].u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5180
5181 parms[2].type = VBOX_HGCM_SVC_PARM_32BIT;
5182 parms[2].u.uint32 = aData.mWritable;
5183
5184 int vrc = mVMMDev->hgcmHostCall ("VBoxSharedFolders",
5185 SHFL_FN_ADD_MAPPING,
5186 SHFL_CPARMS_ADD_MAPPING, &parms[0]);
5187 RTMemFree (pFolderName);
5188 RTMemFree (pMapName);
5189
5190 if (VBOX_FAILURE (vrc))
5191 return setError (E_FAIL,
5192 tr ("Could not create a shared folder '%ls' "
5193 "mapped to '%ls' (%Rrc)"),
5194 aName, aData.mHostPath.raw(), vrc);
5195
5196 return S_OK;
5197}
5198
5199/**
5200 * Calls the HGCM service to remove the shared folder definition.
5201 *
5202 * @param aName Shared folder name.
5203 *
5204 * @note Must be called from under AutoVMCaller and when mpVM != NULL!
5205 * @note Doesn't lock anything.
5206 */
5207HRESULT Console::removeSharedFolder (CBSTR aName)
5208{
5209 ComAssertRet (aName && *aName, E_FAIL);
5210
5211 /* sanity checks */
5212 AssertReturn (mpVM, E_FAIL);
5213 AssertReturn (mVMMDev->isShFlActive(), E_FAIL);
5214
5215 VBOXHGCMSVCPARM parms;
5216 SHFLSTRING *pMapName;
5217 size_t cbString;
5218
5219 Log (("Removing shared folder '%ls'\n", aName));
5220
5221 cbString = (RTUtf16Len (aName) + 1) * sizeof (RTUTF16);
5222 if (cbString >= UINT16_MAX)
5223 return setError (E_INVALIDARG, tr ("The name is too long"));
5224 pMapName = (SHFLSTRING *) RTMemAllocZ (sizeof (SHFLSTRING) + cbString);
5225 Assert (pMapName);
5226 memcpy (pMapName->String.ucs2, aName, cbString);
5227
5228 pMapName->u16Size = (uint16_t)cbString;
5229 pMapName->u16Length = (uint16_t)cbString - sizeof (RTUTF16);
5230
5231 parms.type = VBOX_HGCM_SVC_PARM_PTR;
5232 parms.u.pointer.addr = pMapName;
5233 parms.u.pointer.size = sizeof (SHFLSTRING) + (uint16_t)cbString;
5234
5235 int vrc = mVMMDev->hgcmHostCall ("VBoxSharedFolders",
5236 SHFL_FN_REMOVE_MAPPING,
5237 1, &parms);
5238 RTMemFree(pMapName);
5239 if (VBOX_FAILURE (vrc))
5240 return setError (E_FAIL,
5241 tr ("Could not remove the shared folder '%ls' (%Rrc)"),
5242 aName, vrc);
5243
5244 return S_OK;
5245}
5246
5247/**
5248 * VM state callback function. Called by the VMM
5249 * using its state machine states.
5250 *
5251 * Primarily used to handle VM initiated power off, suspend and state saving,
5252 * but also for doing termination completed work (VMSTATE_TERMINATE).
5253 *
5254 * In general this function is called in the context of the EMT.
5255 *
5256 * @param aVM The VM handle.
5257 * @param aState The new state.
5258 * @param aOldState The old state.
5259 * @param aUser The user argument (pointer to the Console object).
5260 *
5261 * @note Locks the Console object for writing.
5262 */
5263DECLCALLBACK(void)
5264Console::vmstateChangeCallback (PVM aVM, VMSTATE aState, VMSTATE aOldState,
5265 void *aUser)
5266{
5267 LogFlowFunc (("Changing state from %d to %d (aVM=%p)\n",
5268 aOldState, aState, aVM));
5269
5270 Console *that = static_cast <Console *> (aUser);
5271 AssertReturnVoid (that);
5272
5273 AutoCaller autoCaller (that);
5274
5275 /* Note that we must let this method proceed even if Console::uninit() has
5276 * been already called. In such case this VMSTATE change is a result of:
5277 * 1) powerDown() called from uninit() itself, or
5278 * 2) VM-(guest-)initiated power off. */
5279 AssertReturnVoid (autoCaller.isOk() ||
5280 autoCaller.state() == InUninit);
5281
5282 switch (aState)
5283 {
5284 /*
5285 * The VM has terminated
5286 */
5287 case VMSTATE_OFF:
5288 {
5289 AutoWriteLock alock (that);
5290
5291 if (that->mVMStateChangeCallbackDisabled)
5292 break;
5293
5294 /* Do we still think that it is running? It may happen if this is a
5295 * VM-(guest-)initiated shutdown/poweroff.
5296 */
5297 if (that->mMachineState != MachineState_Stopping &&
5298 that->mMachineState != MachineState_Saving &&
5299 that->mMachineState != MachineState_Restoring)
5300 {
5301 LogFlowFunc (("VM has powered itself off but Console still "
5302 "thinks it is running. Notifying.\n"));
5303
5304 /* prevent powerDown() from calling VMR3PowerOff() again */
5305 Assert (that->mVMPoweredOff == false);
5306 that->mVMPoweredOff = true;
5307
5308 /* we are stopping now */
5309 that->setMachineState (MachineState_Stopping);
5310
5311 /* Setup task object and thread to carry out the operation
5312 * asynchronously (if we call powerDown() right here but there
5313 * is one or more mpVM callers (added with addVMCaller()) we'll
5314 * deadlock).
5315 */
5316 std::auto_ptr <VMProgressTask> task (
5317 new VMProgressTask (that, NULL /* aProgress */,
5318 true /* aUsesVMPtr */));
5319
5320 /* If creating a task is falied, this can currently mean one of
5321 * two: either Console::uninit() has been called just a ms
5322 * before (so a powerDown() call is already on the way), or
5323 * powerDown() itself is being already executed. Just do
5324 * nothing.
5325 */
5326 if (!task->isOk())
5327 {
5328 LogFlowFunc (("Console is already being uninitialized.\n"));
5329 break;
5330 }
5331
5332 int vrc = RTThreadCreate (NULL, Console::powerDownThread,
5333 (void *) task.get(), 0,
5334 RTTHREADTYPE_MAIN_WORKER, 0,
5335 "VMPowerDown");
5336
5337 AssertMsgRCBreak (vrc,
5338 ("Could not create VMPowerDown thread (%Rrc)\n", vrc));
5339
5340 /* task is now owned by powerDownThread(), so release it */
5341 task.release();
5342 }
5343 break;
5344 }
5345
5346 /* The VM has been completely destroyed.
5347 *
5348 * Note: This state change can happen at two points:
5349 * 1) At the end of VMR3Destroy() if it was not called from EMT.
5350 * 2) At the end of vmR3EmulationThread if VMR3Destroy() was
5351 * called by EMT.
5352 */
5353 case VMSTATE_TERMINATED:
5354 {
5355 AutoWriteLock alock (that);
5356
5357 if (that->mVMStateChangeCallbackDisabled)
5358 break;
5359
5360 /* Terminate host interface networking. If aVM is NULL, we've been
5361 * manually called from powerUpThread() either before calling
5362 * VMR3Create() or after VMR3Create() failed, so no need to touch
5363 * networking.
5364 */
5365 if (aVM)
5366 that->powerDownHostInterfaces();
5367
5368 /* From now on the machine is officially powered down or remains in
5369 * the Saved state.
5370 */
5371 switch (that->mMachineState)
5372 {
5373 default:
5374 AssertFailed();
5375 /* fall through */
5376 case MachineState_Stopping:
5377 /* successfully powered down */
5378 that->setMachineState (MachineState_PoweredOff);
5379 break;
5380 case MachineState_Saving:
5381 /* successfully saved (note that the machine is already in
5382 * the Saved state on the server due to EndSavingState()
5383 * called from saveStateThread(), so only change the local
5384 * state) */
5385 that->setMachineStateLocally (MachineState_Saved);
5386 break;
5387 case MachineState_Starting:
5388 /* failed to start, but be patient: set back to PoweredOff
5389 * (for similarity with the below) */
5390 that->setMachineState (MachineState_PoweredOff);
5391 break;
5392 case MachineState_Restoring:
5393 /* failed to load the saved state file, but be patient: set
5394 * back to Saved (to preserve the saved state file) */
5395 that->setMachineState (MachineState_Saved);
5396 break;
5397 }
5398
5399 break;
5400 }
5401
5402 case VMSTATE_SUSPENDED:
5403 {
5404 if (aOldState == VMSTATE_RUNNING)
5405 {
5406 AutoWriteLock alock (that);
5407
5408 if (that->mVMStateChangeCallbackDisabled)
5409 break;
5410
5411 /* Change the machine state from Running to Paused */
5412 Assert (that->mMachineState == MachineState_Running);
5413 that->setMachineState (MachineState_Paused);
5414 }
5415
5416 break;
5417 }
5418
5419 case VMSTATE_RUNNING:
5420 {
5421 if (aOldState == VMSTATE_CREATED ||
5422 aOldState == VMSTATE_SUSPENDED)
5423 {
5424 AutoWriteLock alock (that);
5425
5426 if (that->mVMStateChangeCallbackDisabled)
5427 break;
5428
5429 /* Change the machine state from Starting, Restoring or Paused
5430 * to Running */
5431 Assert ( ( ( that->mMachineState == MachineState_Starting
5432 || that->mMachineState == MachineState_Paused)
5433 && aOldState == VMSTATE_CREATED)
5434 || ( ( that->mMachineState == MachineState_Restoring
5435 || that->mMachineState == MachineState_Paused)
5436 && aOldState == VMSTATE_SUSPENDED));
5437
5438 that->setMachineState (MachineState_Running);
5439 }
5440
5441 break;
5442 }
5443
5444 case VMSTATE_GURU_MEDITATION:
5445 {
5446 AutoWriteLock alock (that);
5447
5448 if (that->mVMStateChangeCallbackDisabled)
5449 break;
5450
5451 /* Guru respects only running VMs */
5452 Assert (Global::IsOnline (that->mMachineState));
5453
5454 that->setMachineState (MachineState_Stuck);
5455
5456 break;
5457 }
5458
5459 default: /* shut up gcc */
5460 break;
5461 }
5462}
5463
5464#ifdef VBOX_WITH_USB
5465
5466/**
5467 * Sends a request to VMM to attach the given host device.
5468 * After this method succeeds, the attached device will appear in the
5469 * mUSBDevices collection.
5470 *
5471 * @param aHostDevice device to attach
5472 *
5473 * @note Synchronously calls EMT.
5474 * @note Must be called from under this object's lock.
5475 */
5476HRESULT Console::attachUSBDevice (IUSBDevice *aHostDevice, ULONG aMaskedIfs)
5477{
5478 AssertReturn (aHostDevice, E_FAIL);
5479 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5480
5481 /* still want a lock object because we need to leave it */
5482 AutoWriteLock alock (this);
5483
5484 HRESULT hrc;
5485
5486 /*
5487 * Get the address and the Uuid, and call the pfnCreateProxyDevice roothub
5488 * method in EMT (using usbAttachCallback()).
5489 */
5490 Bstr BstrAddress;
5491 hrc = aHostDevice->COMGETTER (Address) (BstrAddress.asOutParam());
5492 ComAssertComRCRetRC (hrc);
5493
5494 Utf8Str Address (BstrAddress);
5495
5496 Bstr id;
5497 hrc = aHostDevice->COMGETTER (Id) (id.asOutParam());
5498 ComAssertComRCRetRC (hrc);
5499 Guid uuid(id);
5500
5501 BOOL fRemote = FALSE;
5502 hrc = aHostDevice->COMGETTER (Remote) (&fRemote);
5503 ComAssertComRCRetRC (hrc);
5504
5505 /* protect mpVM */
5506 AutoVMCaller autoVMCaller (this);
5507 CheckComRCReturnRC (autoVMCaller.rc());
5508
5509 LogFlowThisFunc (("Proxying USB device '%s' {%RTuuid}...\n",
5510 Address.raw(), uuid.ptr()));
5511
5512 /* leave the lock before a VMR3* call (EMT will call us back)! */
5513 alock.leave();
5514
5515/** @todo just do everything here and only wrap the PDMR3Usb call. That'll offload some notification stuff from the EMT thread. */
5516 PVMREQ pReq = NULL;
5517 int vrc = VMR3ReqCall (mpVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
5518 (PFNRT) usbAttachCallback, 6, this, aHostDevice, uuid.ptr(), fRemote, Address.raw(), aMaskedIfs);
5519 if (VBOX_SUCCESS (vrc))
5520 vrc = pReq->iStatus;
5521 VMR3ReqFree (pReq);
5522
5523 /* restore the lock */
5524 alock.enter();
5525
5526 /* hrc is S_OK here */
5527
5528 if (VBOX_FAILURE (vrc))
5529 {
5530 LogWarningThisFunc (("Failed to create proxy device for '%s' {%RTuuid} (%Rrc)\n",
5531 Address.raw(), uuid.ptr(), vrc));
5532
5533 switch (vrc)
5534 {
5535 case VERR_VUSB_NO_PORTS:
5536 hrc = setError (E_FAIL,
5537 tr ("Failed to attach the USB device. (No available ports on the USB controller)."));
5538 break;
5539 case VERR_VUSB_USBFS_PERMISSION:
5540 hrc = setError (E_FAIL,
5541 tr ("Not permitted to open the USB device, check usbfs options"));
5542 break;
5543 default:
5544 hrc = setError (E_FAIL,
5545 tr ("Failed to create a proxy device for the USB device. (Error: %Rrc)"), vrc);
5546 break;
5547 }
5548 }
5549
5550 return hrc;
5551}
5552
5553/**
5554 * USB device attach callback used by AttachUSBDevice().
5555 * Note that AttachUSBDevice() doesn't return until this callback is executed,
5556 * so we don't use AutoCaller and don't care about reference counters of
5557 * interface pointers passed in.
5558 *
5559 * @thread EMT
5560 * @note Locks the console object for writing.
5561 */
5562//static
5563DECLCALLBACK(int)
5564Console::usbAttachCallback (Console *that, IUSBDevice *aHostDevice, PCRTUUID aUuid, bool aRemote, const char *aAddress, ULONG aMaskedIfs)
5565{
5566 LogFlowFuncEnter();
5567 LogFlowFunc (("that={%p}\n", that));
5568
5569 AssertReturn (that && aUuid, VERR_INVALID_PARAMETER);
5570
5571 void *pvRemoteBackend = NULL;
5572 if (aRemote)
5573 {
5574 RemoteUSBDevice *pRemoteUSBDevice = static_cast <RemoteUSBDevice *> (aHostDevice);
5575 Guid guid (*aUuid);
5576
5577 pvRemoteBackend = that->consoleVRDPServer ()->USBBackendRequestPointer (pRemoteUSBDevice->clientId (), &guid);
5578 if (!pvRemoteBackend)
5579 return VERR_INVALID_PARAMETER; /* The clientId is invalid then. */
5580 }
5581
5582 USHORT portVersion = 1;
5583 HRESULT hrc = aHostDevice->COMGETTER(PortVersion)(&portVersion);
5584 AssertComRCReturn(hrc, VERR_GENERAL_FAILURE);
5585 Assert(portVersion == 1 || portVersion == 2);
5586
5587 int vrc = PDMR3USBCreateProxyDevice (that->mpVM, aUuid, aRemote, aAddress, pvRemoteBackend,
5588 portVersion == 1 ? VUSB_STDVER_11 : VUSB_STDVER_20, aMaskedIfs);
5589 if (VBOX_SUCCESS (vrc))
5590 {
5591 /* Create a OUSBDevice and add it to the device list */
5592 ComObjPtr <OUSBDevice> device;
5593 device.createObject();
5594 HRESULT hrc = device->init (aHostDevice);
5595 AssertComRC (hrc);
5596
5597 AutoWriteLock alock (that);
5598 that->mUSBDevices.push_back (device);
5599 LogFlowFunc (("Attached device {%RTuuid}\n", device->id().raw()));
5600
5601 /* notify callbacks */
5602 that->onUSBDeviceStateChange (device, true /* aAttached */, NULL);
5603 }
5604
5605 LogFlowFunc (("vrc=%Rrc\n", vrc));
5606 LogFlowFuncLeave();
5607 return vrc;
5608}
5609
5610/**
5611 * Sends a request to VMM to detach the given host device. After this method
5612 * succeeds, the detached device will disappear from the mUSBDevices
5613 * collection.
5614 *
5615 * @param aIt Iterator pointing to the device to detach.
5616 *
5617 * @note Synchronously calls EMT.
5618 * @note Must be called from under this object's lock.
5619 */
5620HRESULT Console::detachUSBDevice (USBDeviceList::iterator &aIt)
5621{
5622 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5623
5624 /* still want a lock object because we need to leave it */
5625 AutoWriteLock alock (this);
5626
5627 /* protect mpVM */
5628 AutoVMCaller autoVMCaller (this);
5629 CheckComRCReturnRC (autoVMCaller.rc());
5630
5631 /* if the device is attached, then there must at least one USB hub. */
5632 AssertReturn (PDMR3USBHasHub (mpVM), E_FAIL);
5633
5634 LogFlowThisFunc (("Detaching USB proxy device {%RTuuid}...\n",
5635 (*aIt)->id().raw()));
5636
5637 /* leave the lock before a VMR3* call (EMT will call us back)! */
5638 alock.leave();
5639
5640 PVMREQ pReq;
5641/** @todo just do everything here and only wrap the PDMR3Usb call. That'll offload some notification stuff from the EMT thread. */
5642 int vrc = VMR3ReqCall (mpVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
5643 (PFNRT) usbDetachCallback, 4,
5644 this, &aIt, (*aIt)->id().raw());
5645 if (VBOX_SUCCESS (vrc))
5646 vrc = pReq->iStatus;
5647 VMR3ReqFree (pReq);
5648
5649 ComAssertRCRet (vrc, E_FAIL);
5650
5651 return S_OK;
5652}
5653
5654/**
5655 * USB device detach callback used by DetachUSBDevice().
5656 * Note that DetachUSBDevice() doesn't return until this callback is executed,
5657 * so we don't use AutoCaller and don't care about reference counters of
5658 * interface pointers passed in.
5659 *
5660 * @thread EMT
5661 * @note Locks the console object for writing.
5662 */
5663//static
5664DECLCALLBACK(int)
5665Console::usbDetachCallback (Console *that, USBDeviceList::iterator *aIt, PCRTUUID aUuid)
5666{
5667 LogFlowFuncEnter();
5668 LogFlowFunc (("that={%p}\n", that));
5669
5670 AssertReturn (that && aUuid, VERR_INVALID_PARAMETER);
5671 ComObjPtr <OUSBDevice> device = **aIt;
5672
5673 /*
5674 * If that was a remote device, release the backend pointer.
5675 * The pointer was requested in usbAttachCallback.
5676 */
5677 BOOL fRemote = FALSE;
5678
5679 HRESULT hrc2 = (**aIt)->COMGETTER (Remote) (&fRemote);
5680 ComAssertComRC (hrc2);
5681
5682 if (fRemote)
5683 {
5684 Guid guid (*aUuid);
5685 that->consoleVRDPServer ()->USBBackendReleasePointer (&guid);
5686 }
5687
5688 int vrc = PDMR3USBDetachDevice (that->mpVM, aUuid);
5689
5690 if (VBOX_SUCCESS (vrc))
5691 {
5692 AutoWriteLock alock (that);
5693
5694 /* Remove the device from the collection */
5695 that->mUSBDevices.erase (*aIt);
5696 LogFlowFunc (("Detached device {%RTuuid}\n", device->id().raw()));
5697
5698 /* notify callbacks */
5699 that->onUSBDeviceStateChange (device, false /* aAttached */, NULL);
5700 }
5701
5702 LogFlowFunc (("vrc=%Rrc\n", vrc));
5703 LogFlowFuncLeave();
5704 return vrc;
5705}
5706
5707#endif /* VBOX_WITH_USB */
5708
5709
5710/**
5711 * Helper function to handle host interface device creation and attachment.
5712 *
5713 * @param networkAdapter the network adapter which attachment should be reset
5714 * @return COM status code
5715 *
5716 * @note The caller must lock this object for writing.
5717 */
5718HRESULT Console::attachToBridgedInterface(INetworkAdapter *networkAdapter)
5719{
5720#if !defined(RT_OS_LINUX) || defined(VBOX_WITH_NETFLT)
5721 /*
5722 * Nothing to do here.
5723 *
5724 * Note, the reason for this method in the first place a memory / fork
5725 * bug on linux. All this code belongs in DrvTAP and similar places.
5726 */
5727 NOREF(networkAdapter);
5728 return S_OK;
5729
5730#else /* RT_OS_LINUX && !VBOX_WITH_NETFLT */
5731
5732 LogFlowThisFunc(("\n"));
5733 /* sanity check */
5734 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5735
5736# ifdef VBOX_STRICT
5737 /* paranoia */
5738 NetworkAttachmentType_T attachment;
5739 networkAdapter->COMGETTER(AttachmentType)(&attachment);
5740 Assert(attachment == NetworkAttachmentType_Bridged);
5741# endif /* VBOX_STRICT */
5742
5743 HRESULT rc = S_OK;
5744
5745 ULONG slot = 0;
5746 rc = networkAdapter->COMGETTER(Slot)(&slot);
5747 AssertComRC(rc);
5748
5749 /*
5750 * Allocate a host interface device
5751 */
5752 int rcVBox = RTFileOpen(&maTapFD[slot], "/dev/net/tun",
5753 RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_INHERIT);
5754 if (VBOX_SUCCESS(rcVBox))
5755 {
5756 /*
5757 * Set/obtain the tap interface.
5758 */
5759 struct ifreq IfReq;
5760 memset(&IfReq, 0, sizeof(IfReq));
5761 /* The name of the TAP interface we are using */
5762 Bstr tapDeviceName;
5763 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
5764 if (FAILED(rc))
5765 tapDeviceName.setNull(); /* Is this necessary? */
5766 if (tapDeviceName.isEmpty())
5767 {
5768 LogRel(("No TAP device name was supplied.\n"));
5769 rc = setError(E_FAIL, tr ("No TAP device name was supplied for the host networking interface"));
5770 }
5771
5772 if (SUCCEEDED(rc))
5773 {
5774 /* If we are using a static TAP device then try to open it. */
5775 Utf8Str str(tapDeviceName);
5776 if (str.length() <= sizeof(IfReq.ifr_name))
5777 strcpy(IfReq.ifr_name, str.raw());
5778 else
5779 memcpy(IfReq.ifr_name, str.raw(), sizeof(IfReq.ifr_name) - 1); /** @todo bitch about names which are too long... */
5780 IfReq.ifr_flags = IFF_TAP | IFF_NO_PI;
5781 rcVBox = ioctl(maTapFD[slot], TUNSETIFF, &IfReq);
5782 if (rcVBox != 0)
5783 {
5784 LogRel(("Failed to open the host network interface %ls\n", tapDeviceName.raw()));
5785 rc = setError(E_FAIL, tr ("Failed to open the host network interface %ls"),
5786 tapDeviceName.raw());
5787 }
5788 }
5789 if (SUCCEEDED(rc))
5790 {
5791 /*
5792 * Make it pollable.
5793 */
5794 if (fcntl(maTapFD[slot], F_SETFL, O_NONBLOCK) != -1)
5795 {
5796 Log(("attachToBridgedInterface: %RTfile %ls\n", maTapFD[slot], tapDeviceName.raw()));
5797 /*
5798 * Here is the right place to communicate the TAP file descriptor and
5799 * the host interface name to the server if/when it becomes really
5800 * necessary.
5801 */
5802 maTAPDeviceName[slot] = tapDeviceName;
5803 rcVBox = VINF_SUCCESS;
5804 }
5805 else
5806 {
5807 int iErr = errno;
5808
5809 LogRel(("Configuration error: Failed to configure /dev/net/tun non blocking. Error: %s\n", strerror(iErr)));
5810 rcVBox = VERR_HOSTIF_BLOCKING;
5811 rc = setError(E_FAIL, tr ("could not set up the host networking device for non blocking access: %s"),
5812 strerror(errno));
5813 }
5814 }
5815 }
5816 else
5817 {
5818 LogRel(("Configuration error: Failed to open /dev/net/tun rc=%Rrc\n", rcVBox));
5819 switch (rcVBox)
5820 {
5821 case VERR_ACCESS_DENIED:
5822 /* will be handled by our caller */
5823 rc = rcVBox;
5824 break;
5825 default:
5826 rc = setError(E_FAIL, tr ("Could not set up the host networking device: %Rrc"), rcVBox);
5827 break;
5828 }
5829 }
5830 /* in case of failure, cleanup. */
5831 if (VBOX_FAILURE(rcVBox) && SUCCEEDED(rc))
5832 {
5833 LogRel(("General failure attaching to host interface\n"));
5834 rc = setError(E_FAIL, tr ("General failure attaching to host interface"));
5835 }
5836 LogFlowThisFunc(("rc=%d\n", rc));
5837 return rc;
5838#endif /* RT_OS_LINUX */
5839}
5840
5841/**
5842 * Helper function to handle detachment from a host interface
5843 *
5844 * @param networkAdapter the network adapter which attachment should be reset
5845 * @return COM status code
5846 *
5847 * @note The caller must lock this object for writing.
5848 */
5849HRESULT Console::detachFromBridgedInterface(INetworkAdapter *networkAdapter)
5850{
5851#if !defined(RT_OS_LINUX) || defined(VBOX_WITH_NETFLT)
5852 /*
5853 * Nothing to do here.
5854 */
5855 NOREF(networkAdapter);
5856 return S_OK;
5857
5858#else /* RT_OS_LINUX */
5859
5860 /* sanity check */
5861 LogFlowThisFunc(("\n"));
5862 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5863
5864 HRESULT rc = S_OK;
5865# ifdef VBOX_STRICT
5866 /* paranoia */
5867 NetworkAttachmentType_T attachment;
5868 networkAdapter->COMGETTER(AttachmentType)(&attachment);
5869 Assert(attachment == NetworkAttachmentType_Bridged);
5870# endif /* VBOX_STRICT */
5871
5872 ULONG slot = 0;
5873 rc = networkAdapter->COMGETTER(Slot)(&slot);
5874 AssertComRC(rc);
5875
5876 /* is there an open TAP device? */
5877 if (maTapFD[slot] != NIL_RTFILE)
5878 {
5879 /*
5880 * Close the file handle.
5881 */
5882 Bstr tapDeviceName, tapTerminateApplication;
5883 bool isStatic = true;
5884 rc = networkAdapter->COMGETTER(HostInterface)(tapDeviceName.asOutParam());
5885 if (FAILED(rc) || tapDeviceName.isEmpty())
5886 {
5887 /* If the name is empty, this is a dynamic TAP device, so close it now,
5888 so that the termination script can remove the interface. Otherwise we still
5889 need the FD to pass to the termination script. */
5890 isStatic = false;
5891 int rcVBox = RTFileClose(maTapFD[slot]);
5892 AssertRC(rcVBox);
5893 maTapFD[slot] = NIL_RTFILE;
5894 }
5895 if (isStatic)
5896 {
5897 /* If we are using a static TAP device, we close it now, after having called the
5898 termination script. */
5899 int rcVBox = RTFileClose(maTapFD[slot]);
5900 AssertRC(rcVBox);
5901 }
5902 /* the TAP device name and handle are no longer valid */
5903 maTapFD[slot] = NIL_RTFILE;
5904 maTAPDeviceName[slot] = "";
5905 }
5906 LogFlowThisFunc(("returning %d\n", rc));
5907 return rc;
5908#endif /* RT_OS_LINUX */
5909}
5910
5911
5912/**
5913 * Called at power down to terminate host interface networking.
5914 *
5915 * @note The caller must lock this object for writing.
5916 */
5917HRESULT Console::powerDownHostInterfaces()
5918{
5919 LogFlowThisFunc (("\n"));
5920
5921 /* sanity check */
5922 AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5923
5924 /*
5925 * host interface termination handling
5926 */
5927 HRESULT rc;
5928 for (ULONG slot = 0; slot < SchemaDefs::NetworkAdapterCount; slot ++)
5929 {
5930 ComPtr<INetworkAdapter> networkAdapter;
5931 rc = mMachine->GetNetworkAdapter(slot, networkAdapter.asOutParam());
5932 CheckComRCBreakRC (rc);
5933
5934 BOOL enabled = FALSE;
5935 networkAdapter->COMGETTER(Enabled) (&enabled);
5936 if (!enabled)
5937 continue;
5938
5939 NetworkAttachmentType_T attachment;
5940 networkAdapter->COMGETTER(AttachmentType)(&attachment);
5941 if (attachment == NetworkAttachmentType_Bridged)
5942 {
5943 HRESULT rc2 = detachFromBridgedInterface(networkAdapter);
5944 if (FAILED(rc2) && SUCCEEDED(rc))
5945 rc = rc2;
5946 }
5947 }
5948
5949 return rc;
5950}
5951
5952
5953/**
5954 * Process callback handler for VMR3Load and VMR3Save.
5955 *
5956 * @param pVM The VM handle.
5957 * @param uPercent Completetion precentage (0-100).
5958 * @param pvUser Pointer to the VMProgressTask structure.
5959 * @return VINF_SUCCESS.
5960 */
5961/*static*/ DECLCALLBACK (int)
5962Console::stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser)
5963{
5964 VMProgressTask *task = static_cast <VMProgressTask *> (pvUser);
5965 AssertReturn (task, VERR_INVALID_PARAMETER);
5966
5967 /* update the progress object */
5968 if (task->mProgress)
5969 task->mProgress->setCurrentOperationProgress(uPercent);
5970
5971 return VINF_SUCCESS;
5972}
5973
5974/**
5975 * VM error callback function. Called by the various VM components.
5976 *
5977 * @param pVM VM handle. Can be NULL if an error occurred before
5978 * successfully creating a VM.
5979 * @param pvUser Pointer to the VMProgressTask structure.
5980 * @param rc VBox status code.
5981 * @param pszFormat Printf-like error message.
5982 * @param args Various number of arguments for the error message.
5983 *
5984 * @thread EMT, VMPowerUp...
5985 *
5986 * @note The VMProgressTask structure modified by this callback is not thread
5987 * safe.
5988 */
5989/* static */ DECLCALLBACK (void)
5990Console::setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
5991 const char *pszFormat, va_list args)
5992{
5993 VMProgressTask *task = static_cast <VMProgressTask *> (pvUser);
5994 AssertReturnVoid (task);
5995
5996 /* we ignore RT_SRC_POS_DECL arguments to avoid confusion of end-users */
5997 va_list va2;
5998 va_copy (va2, args); /* Have to make a copy here or GCC will break. */
5999
6000 /* append to the existing error message if any */
6001 if (!task->mErrorMsg.isEmpty())
6002 task->mErrorMsg = Utf8StrFmt ("%s.\n%N (%Rrc)", task->mErrorMsg.raw(),
6003 pszFormat, &va2, rc, rc);
6004 else
6005 task->mErrorMsg = Utf8StrFmt ("%N (%Rrc)",
6006 pszFormat, &va2, rc, rc);
6007
6008 va_end (va2);
6009}
6010
6011/**
6012 * VM runtime error callback function.
6013 * See VMSetRuntimeError for the detailed description of parameters.
6014 *
6015 * @param pVM The VM handle.
6016 * @param pvUser The user argument.
6017 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
6018 * @param pszErrorId Error ID string.
6019 * @param pszFormat Error message format string.
6020 * @param va Error message arguments.
6021 * @thread EMT.
6022 */
6023/* static */ DECLCALLBACK(void)
6024Console::setVMRuntimeErrorCallback (PVM pVM, void *pvUser, uint32_t fFlags,
6025 const char *pszErrorId,
6026 const char *pszFormat, va_list va)
6027{
6028 bool const fFatal = !!(fFlags & VMSETRTERR_FLAGS_FATAL);
6029 LogFlowFuncEnter();
6030
6031 Console *that = static_cast <Console *> (pvUser);
6032 AssertReturnVoid (that);
6033
6034 Utf8Str message = Utf8StrFmtVA (pszFormat, va);
6035
6036 LogRel (("Console: VM runtime error: fatal=%RTbool, "
6037 "errorID=%s message=\"%s\"\n",
6038 fFatal, pszErrorId, message.raw()));
6039
6040 that->onRuntimeError (BOOL (fFatal), Bstr (pszErrorId), Bstr (message));
6041
6042 LogFlowFuncLeave();
6043}
6044
6045/**
6046 * Captures USB devices that match filters of the VM.
6047 * Called at VM startup.
6048 *
6049 * @param pVM The VM handle.
6050 *
6051 * @note The caller must lock this object for writing.
6052 */
6053HRESULT Console::captureUSBDevices (PVM pVM)
6054{
6055 LogFlowThisFunc (("\n"));
6056
6057 /* sanity check */
6058 ComAssertRet (isWriteLockOnCurrentThread(), E_FAIL);
6059
6060 /* If the machine has an USB controller, ask the USB proxy service to
6061 * capture devices */
6062 PPDMIBASE pBase;
6063 int vrc = PDMR3QueryLun (pVM, "usb-ohci", 0, 0, &pBase);
6064 if (VBOX_SUCCESS (vrc))
6065 {
6066 /* leave the lock before calling Host in VBoxSVC since Host may call
6067 * us back from under its lock (e.g. onUSBDeviceAttach()) which would
6068 * produce an inter-process dead-lock otherwise. */
6069 AutoWriteLock alock (this);
6070 alock.leave();
6071
6072 HRESULT hrc = mControl->AutoCaptureUSBDevices();
6073 ComAssertComRCRetRC (hrc);
6074 }
6075 else if ( vrc == VERR_PDM_DEVICE_NOT_FOUND
6076 || vrc == VERR_PDM_DEVICE_INSTANCE_NOT_FOUND)
6077 vrc = VINF_SUCCESS;
6078 else
6079 AssertRC (vrc);
6080
6081 return VBOX_SUCCESS (vrc) ? S_OK : E_FAIL;
6082}
6083
6084
6085/**
6086 * Detach all USB device which are attached to the VM for the
6087 * purpose of clean up and such like.
6088 *
6089 * @note The caller must lock this object for writing.
6090 */
6091void Console::detachAllUSBDevices (bool aDone)
6092{
6093 LogFlowThisFunc (("aDone=%RTbool\n", aDone));
6094
6095 /* sanity check */
6096 AssertReturnVoid (isWriteLockOnCurrentThread());
6097
6098 mUSBDevices.clear();
6099
6100 /* leave the lock before calling Host in VBoxSVC since Host may call
6101 * us back from under its lock (e.g. onUSBDeviceAttach()) which would
6102 * produce an inter-process dead-lock otherwise. */
6103 AutoWriteLock alock (this);
6104 alock.leave();
6105
6106 mControl->DetachAllUSBDevices (aDone);
6107}
6108
6109/**
6110 * @note Locks this object for writing.
6111 */
6112void Console::processRemoteUSBDevices (uint32_t u32ClientId, VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList)
6113{
6114 LogFlowThisFuncEnter();
6115 LogFlowThisFunc (("u32ClientId = %d, pDevList=%p, cbDevList = %d\n", u32ClientId, pDevList, cbDevList));
6116
6117 AutoCaller autoCaller (this);
6118 if (!autoCaller.isOk())
6119 {
6120 /* Console has been already uninitialized, deny request */
6121 AssertMsgFailed (("Temporary assertion to prove that it happens, "
6122 "please report to dmik\n"));
6123 LogFlowThisFunc (("Console is already uninitialized\n"));
6124 LogFlowThisFuncLeave();
6125 return;
6126 }
6127
6128 AutoWriteLock alock (this);
6129
6130 /*
6131 * Mark all existing remote USB devices as dirty.
6132 */
6133 RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6134 while (it != mRemoteUSBDevices.end())
6135 {
6136 (*it)->dirty (true);
6137 ++ it;
6138 }
6139
6140 /*
6141 * Process the pDevList and add devices those are not already in the mRemoteUSBDevices list.
6142 */
6143 /** @todo (sunlover) REMOTE_USB Strict validation of the pDevList. */
6144 VRDPUSBDEVICEDESC *e = pDevList;
6145
6146 /* The cbDevList condition must be checked first, because the function can
6147 * receive pDevList = NULL and cbDevList = 0 on client disconnect.
6148 */
6149 while (cbDevList >= 2 && e->oNext)
6150 {
6151 LogFlowThisFunc (("vendor %04X, product %04X, name = %s\n",
6152 e->idVendor, e->idProduct,
6153 e->oProduct? (char *)e + e->oProduct: ""));
6154
6155 bool fNewDevice = true;
6156
6157 it = mRemoteUSBDevices.begin();
6158 while (it != mRemoteUSBDevices.end())
6159 {
6160 if ((*it)->devId () == e->id
6161 && (*it)->clientId () == u32ClientId)
6162 {
6163 /* The device is already in the list. */
6164 (*it)->dirty (false);
6165 fNewDevice = false;
6166 break;
6167 }
6168
6169 ++ it;
6170 }
6171
6172 if (fNewDevice)
6173 {
6174 LogRel(("Remote USB: ++++ Vendor %04X. Product %04X. Name = [%s].\n",
6175 e->idVendor, e->idProduct, e->oProduct? (char *)e + e->oProduct: ""
6176 ));
6177
6178 /* Create the device object and add the new device to list. */
6179 ComObjPtr <RemoteUSBDevice> device;
6180 device.createObject();
6181 device->init (u32ClientId, e);
6182
6183 mRemoteUSBDevices.push_back (device);
6184
6185 /* Check if the device is ok for current USB filters. */
6186 BOOL fMatched = FALSE;
6187 ULONG fMaskedIfs = 0;
6188
6189 HRESULT hrc = mControl->RunUSBDeviceFilters(device, &fMatched, &fMaskedIfs);
6190
6191 AssertComRC (hrc);
6192
6193 LogFlowThisFunc (("USB filters return %d %#x\n", fMatched, fMaskedIfs));
6194
6195 if (fMatched)
6196 {
6197 hrc = onUSBDeviceAttach (device, NULL, fMaskedIfs);
6198
6199 /// @todo (r=dmik) warning reporting subsystem
6200
6201 if (hrc == S_OK)
6202 {
6203 LogFlowThisFunc (("Device attached\n"));
6204 device->captured (true);
6205 }
6206 }
6207 }
6208
6209 if (cbDevList < e->oNext)
6210 {
6211 LogWarningThisFunc (("cbDevList %d > oNext %d\n",
6212 cbDevList, e->oNext));
6213 break;
6214 }
6215
6216 cbDevList -= e->oNext;
6217
6218 e = (VRDPUSBDEVICEDESC *)((uint8_t *)e + e->oNext);
6219 }
6220
6221 /*
6222 * Remove dirty devices, that is those which are not reported by the server anymore.
6223 */
6224 for (;;)
6225 {
6226 ComObjPtr <RemoteUSBDevice> device;
6227
6228 RemoteUSBDeviceList::iterator it = mRemoteUSBDevices.begin();
6229 while (it != mRemoteUSBDevices.end())
6230 {
6231 if ((*it)->dirty ())
6232 {
6233 device = *it;
6234 break;
6235 }
6236
6237 ++ it;
6238 }
6239
6240 if (!device)
6241 {
6242 break;
6243 }
6244
6245 USHORT vendorId = 0;
6246 device->COMGETTER(VendorId) (&vendorId);
6247
6248 USHORT productId = 0;
6249 device->COMGETTER(ProductId) (&productId);
6250
6251 Bstr product;
6252 device->COMGETTER(Product) (product.asOutParam());
6253
6254 LogRel(("Remote USB: ---- Vendor %04X. Product %04X. Name = [%ls].\n",
6255 vendorId, productId, product.raw ()
6256 ));
6257
6258 /* Detach the device from VM. */
6259 if (device->captured ())
6260 {
6261 Bstr uuid;
6262 device->COMGETTER (Id) (uuid.asOutParam());
6263 onUSBDeviceDetach (uuid, NULL);
6264 }
6265
6266 /* And remove it from the list. */
6267 mRemoteUSBDevices.erase (it);
6268 }
6269
6270 LogFlowThisFuncLeave();
6271}
6272
6273/**
6274 * Thread function which starts the VM (also from saved state) and
6275 * track progress.
6276 *
6277 * @param Thread The thread id.
6278 * @param pvUser Pointer to a VMPowerUpTask structure.
6279 * @return VINF_SUCCESS (ignored).
6280 *
6281 * @note Locks the Console object for writing.
6282 */
6283/*static*/
6284DECLCALLBACK (int) Console::powerUpThread (RTTHREAD Thread, void *pvUser)
6285{
6286 LogFlowFuncEnter();
6287
6288 std::auto_ptr <VMPowerUpTask> task (static_cast <VMPowerUpTask *> (pvUser));
6289 AssertReturn (task.get(), VERR_INVALID_PARAMETER);
6290
6291 AssertReturn (!task->mConsole.isNull(), VERR_INVALID_PARAMETER);
6292 AssertReturn (!task->mProgress.isNull(), VERR_INVALID_PARAMETER);
6293
6294#if defined(RT_OS_WINDOWS)
6295 {
6296 /* initialize COM */
6297 HRESULT hrc = CoInitializeEx (NULL,
6298 COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE |
6299 COINIT_SPEED_OVER_MEMORY);
6300 LogFlowFunc (("CoInitializeEx()=%08X\n", hrc));
6301 }
6302#endif
6303
6304 HRESULT rc = S_OK;
6305 int vrc = VINF_SUCCESS;
6306
6307 /* Set up a build identifier so that it can be seen from core dumps what
6308 * exact build was used to produce the core. */
6309 static char saBuildID[40];
6310 RTStrPrintf(saBuildID, sizeof(saBuildID), "%s%s%s%s VirtualBox %s r%d %s%s%s%s",
6311 "BU", "IL", "DI", "D", VBOX_VERSION_STRING, VBoxSVNRev (), "BU", "IL", "DI", "D");
6312
6313 ComObjPtr <Console> console = task->mConsole;
6314
6315 /* Note: no need to use addCaller() because VMPowerUpTask does that */
6316
6317 /* The lock is also used as a signal from the task initiator (which
6318 * releases it only after RTThreadCreate()) that we can start the job */
6319 AutoWriteLock alock (console);
6320
6321 /* sanity */
6322 Assert (console->mpVM == NULL);
6323
6324 try
6325 {
6326 /* wait for auto reset ops to complete so that we can successfully lock
6327 * the attached hard disks by calling LockMedia() below */
6328 for (VMPowerUpTask::ProgressList::const_iterator
6329 it = task->hardDiskProgresses.begin();
6330 it != task->hardDiskProgresses.end(); ++ it)
6331 {
6332 HRESULT rc2 = (*it)->WaitForCompletion (-1);
6333 AssertComRC (rc2);
6334 }
6335
6336 /* lock attached media. This method will also check their
6337 * accessibility. Note that the media will be unlocked automatically
6338 * by SessionMachine::setMachineState() when the VM is powered down. */
6339 rc = console->mControl->LockMedia();
6340 CheckComRCThrowRC (rc);
6341
6342#ifdef VBOX_WITH_VRDP
6343
6344 /* Create the VRDP server. In case of headless operation, this will
6345 * also create the framebuffer, required at VM creation.
6346 */
6347 ConsoleVRDPServer *server = console->consoleVRDPServer();
6348 Assert (server);
6349
6350 /// @todo (dmik)
6351 // does VRDP server call Console from the other thread?
6352 // Not sure, so leave the lock just in case
6353 alock.leave();
6354 vrc = server->Launch();
6355 alock.enter();
6356
6357 if (VBOX_FAILURE (vrc))
6358 {
6359 Utf8Str errMsg;
6360 switch (vrc)
6361 {
6362 case VERR_NET_ADDRESS_IN_USE:
6363 {
6364 ULONG port = 0;
6365 console->mVRDPServer->COMGETTER(Port) (&port);
6366 errMsg = Utf8StrFmt (tr ("VRDP server port %d is already in use"),
6367 port);
6368 break;
6369 }
6370 case VERR_FILE_NOT_FOUND:
6371 {
6372 errMsg = Utf8StrFmt (tr ("Could not load the VRDP library"));
6373 break;
6374 }
6375 default:
6376 errMsg = Utf8StrFmt (tr ("Failed to launch VRDP server (%Rrc)"),
6377 vrc);
6378 }
6379 LogRel (("Failed to launch VRDP server (%Rrc), error message: '%s'\n",
6380 vrc, errMsg.raw()));
6381 throw setError (E_FAIL, errMsg);
6382 }
6383
6384#endif /* VBOX_WITH_VRDP */
6385
6386 ComPtr <IMachine> pMachine = console->machine();
6387 ULONG cCpus = 1;
6388 pMachine->COMGETTER(CPUCount)(&cCpus);
6389
6390 /*
6391 * Create the VM
6392 */
6393 PVM pVM;
6394 /*
6395 * leave the lock since EMT will call Console. It's safe because
6396 * mMachineState is either Starting or Restoring state here.
6397 */
6398 alock.leave();
6399
6400 vrc = VMR3Create (cCpus, task->mSetVMErrorCallback, task.get(),
6401 task->mConfigConstructor, static_cast <Console *> (console),
6402 &pVM);
6403
6404 alock.enter();
6405
6406#ifdef VBOX_WITH_VRDP
6407 /* Enable client connections to the server. */
6408 console->consoleVRDPServer()->EnableConnections ();
6409#endif /* VBOX_WITH_VRDP */
6410
6411 if (VBOX_SUCCESS (vrc))
6412 {
6413 do
6414 {
6415 /*
6416 * Register our load/save state file handlers
6417 */
6418 vrc = SSMR3RegisterExternal (pVM,
6419 sSSMConsoleUnit, 0 /* iInstance */, sSSMConsoleVer,
6420 0 /* cbGuess */,
6421 NULL, saveStateFileExec, NULL, NULL, loadStateFileExec, NULL,
6422 static_cast <Console *> (console));
6423 AssertRC (vrc);
6424 if (VBOX_FAILURE (vrc))
6425 break;
6426
6427 vrc = static_cast <Console *>(console)->getDisplay()->registerSSM(pVM);
6428 AssertRC (vrc);
6429 if (VBOX_FAILURE (vrc))
6430 break;
6431
6432 /*
6433 * Synchronize debugger settings
6434 */
6435 MachineDebugger *machineDebugger = console->getMachineDebugger();
6436 if (machineDebugger)
6437 {
6438 machineDebugger->flushQueuedSettings();
6439 }
6440
6441 /*
6442 * Shared Folders
6443 */
6444 if (console->getVMMDev()->isShFlActive())
6445 {
6446 /// @todo (dmik)
6447 // does the code below call Console from the other thread?
6448 // Not sure, so leave the lock just in case
6449 alock.leave();
6450
6451 for (SharedFolderDataMap::const_iterator
6452 it = task->mSharedFolders.begin();
6453 it != task->mSharedFolders.end();
6454 ++ it)
6455 {
6456 rc = console->createSharedFolder ((*it).first, (*it).second);
6457 CheckComRCBreakRC (rc);
6458 }
6459
6460 /* enter the lock again */
6461 alock.enter();
6462
6463 CheckComRCBreakRC (rc);
6464 }
6465
6466 /*
6467 * Capture USB devices.
6468 */
6469 rc = console->captureUSBDevices (pVM);
6470 CheckComRCBreakRC (rc);
6471
6472 /* leave the lock before a lengthy operation */
6473 alock.leave();
6474
6475 /* Load saved state? */
6476 if (!!task->mSavedStateFile)
6477 {
6478 LogFlowFunc (("Restoring saved state from '%s'...\n",
6479 task->mSavedStateFile.raw()));
6480
6481 vrc = VMR3Load (pVM, task->mSavedStateFile,
6482 Console::stateProgressCallback,
6483 static_cast <VMProgressTask *> (task.get()));
6484
6485 if (VBOX_SUCCESS (vrc))
6486 {
6487 if (task->mStartPaused)
6488 /* done */
6489 console->setMachineState (MachineState_Paused);
6490 else
6491 {
6492 /* Start/Resume the VM execution */
6493 vrc = VMR3Resume (pVM);
6494 AssertRC (vrc);
6495 }
6496 }
6497
6498 /* Power off in case we failed loading or resuming the VM */
6499 if (VBOX_FAILURE (vrc))
6500 {
6501 int vrc2 = VMR3PowerOff (pVM);
6502 AssertRC (vrc2);
6503 }
6504 }
6505 else if (task->mStartPaused)
6506 /* done */
6507 console->setMachineState (MachineState_Paused);
6508 else
6509 {
6510 /* Power on the VM (i.e. start executing) */
6511 vrc = VMR3PowerOn(pVM);
6512 AssertRC (vrc);
6513 }
6514
6515 /* enter the lock again */
6516 alock.enter();
6517 }
6518 while (0);
6519
6520 /* On failure, destroy the VM */
6521 if (FAILED (rc) || VBOX_FAILURE (vrc))
6522 {
6523 /* preserve existing error info */
6524 ErrorInfoKeeper eik;
6525
6526 /* powerDown() will call VMR3Destroy() and do all necessary
6527 * cleanup (VRDP, USB devices) */
6528 HRESULT rc2 = console->powerDown();
6529 AssertComRC (rc2);
6530 }
6531 else
6532 {
6533 /*
6534 * Deregister the VMSetError callback. This is necessary as the
6535 * pfnVMAtError() function passed to VMR3Create() is supposed to
6536 * be sticky but our error callback isn't.
6537 */
6538 alock.leave();
6539 VMR3AtErrorDeregister(pVM, task->mSetVMErrorCallback, task.get());
6540 /** @todo register another VMSetError callback? */
6541 alock.enter();
6542 }
6543 }
6544 else
6545 {
6546 /*
6547 * If VMR3Create() failed it has released the VM memory.
6548 */
6549 console->mpVM = NULL;
6550 }
6551
6552 if (SUCCEEDED (rc) && VBOX_FAILURE (vrc))
6553 {
6554 /* If VMR3Create() or one of the other calls in this function fail,
6555 * an appropriate error message has been set in task->mErrorMsg.
6556 * However since that happens via a callback, the rc status code in
6557 * this function is not updated.
6558 */
6559 if (task->mErrorMsg.isNull())
6560 {
6561 /* If the error message is not set but we've got a failure,
6562 * convert the VBox status code into a meaningfulerror message.
6563 * This becomes unused once all the sources of errors set the
6564 * appropriate error message themselves.
6565 */
6566 AssertMsgFailed (("Missing error message during powerup for "
6567 "status code %Rrc\n", vrc));
6568 task->mErrorMsg = Utf8StrFmt (
6569 tr ("Failed to start VM execution (%Rrc)"), vrc);
6570 }
6571
6572 /* Set the error message as the COM error.
6573 * Progress::notifyComplete() will pick it up later. */
6574 throw setError (E_FAIL, task->mErrorMsg);
6575 }
6576 }
6577 catch (HRESULT aRC) { rc = aRC; }
6578
6579 if (console->mMachineState == MachineState_Starting ||
6580 console->mMachineState == MachineState_Restoring)
6581 {
6582 /* We are still in the Starting/Restoring state. This means one of:
6583 *
6584 * 1) we failed before VMR3Create() was called;
6585 * 2) VMR3Create() failed.
6586 *
6587 * In both cases, there is no need to call powerDown(), but we still
6588 * need to go back to the PoweredOff/Saved state. Reuse
6589 * vmstateChangeCallback() for that purpose.
6590 */
6591
6592 /* preserve existing error info */
6593 ErrorInfoKeeper eik;
6594
6595 Assert (console->mpVM == NULL);
6596 vmstateChangeCallback (NULL, VMSTATE_TERMINATED, VMSTATE_CREATING,
6597 console);
6598 }
6599
6600 /*
6601 * Evaluate the final result. Note that the appropriate mMachineState value
6602 * is already set by vmstateChangeCallback() in all cases.
6603 */
6604
6605 /* leave the lock, don't need it any more */
6606 alock.leave();
6607
6608 if (SUCCEEDED (rc))
6609 {
6610 /* Notify the progress object of the success */
6611 task->mProgress->notifyComplete (S_OK);
6612 }
6613 else
6614 {
6615 /* The progress object will fetch the current error info */
6616 task->mProgress->notifyComplete (rc);
6617
6618 LogRel (("Power up failed (vrc=%Rrc, rc=%Rhrc (%#08X))\n", vrc, rc, rc));
6619 }
6620
6621#if defined(RT_OS_WINDOWS)
6622 /* uninitialize COM */
6623 CoUninitialize();
6624#endif
6625
6626 LogFlowFuncLeave();
6627
6628 return VINF_SUCCESS;
6629}
6630
6631
6632/**
6633 * Reconfigures a VDI.
6634 *
6635 * @param pVM The VM handle.
6636 * @param lInstance The instance of the controller.
6637 * @param enmController The type of the controller.
6638 * @param hda The harddisk attachment.
6639 * @param phrc Where to store com error - only valid if we return VERR_GENERAL_FAILURE.
6640 * @return VBox status code.
6641 */
6642static DECLCALLBACK(int) reconfigureHardDisks(PVM pVM, ULONG lInstance,
6643 StorageControllerType_T enmController,
6644 IHardDiskAttachment *hda,
6645 HRESULT *phrc)
6646{
6647 LogFlowFunc (("pVM=%p hda=%p phrc=%p\n", pVM, hda, phrc));
6648
6649 int rc;
6650 HRESULT hrc;
6651 Bstr bstr;
6652 *phrc = S_OK;
6653#define RC_CHECK() do { if (VBOX_FAILURE(rc)) { AssertMsgFailed(("rc=%Rrc\n", rc)); return rc; } } while (0)
6654#define H() do { if (FAILED(hrc)) { AssertMsgFailed(("hrc=%Rhrc (%#x)\n", hrc, hrc)); *phrc = hrc; return VERR_GENERAL_FAILURE; } } while (0)
6655
6656 /*
6657 * Figure out which IDE device this is.
6658 */
6659 ComPtr<IHardDisk> hardDisk;
6660 hrc = hda->COMGETTER(HardDisk)(hardDisk.asOutParam()); H();
6661 LONG lDev;
6662 hrc = hda->COMGETTER(Device)(&lDev); H();
6663 LONG lPort;
6664 hrc = hda->COMGETTER(Port)(&lPort); H();
6665
6666 int iLUN;
6667 const char *pcszDevice = NULL;
6668 bool fSCSI = false;
6669
6670 switch (enmController)
6671 {
6672 case StorageControllerType_PIIX3:
6673 case StorageControllerType_PIIX4:
6674 case StorageControllerType_ICH6:
6675 {
6676 if (lPort >= 2 || lPort < 0)
6677 {
6678 AssertMsgFailed(("invalid controller channel number: %d\n", lPort));
6679 return VERR_GENERAL_FAILURE;
6680 }
6681
6682 if (lDev >= 2 || lDev < 0)
6683 {
6684 AssertMsgFailed(("invalid controller device number: %d\n", lDev));
6685 return VERR_GENERAL_FAILURE;
6686 }
6687
6688 iLUN = 2*lPort + lDev;
6689 pcszDevice = "piix3ide";
6690 break;
6691 }
6692 case StorageControllerType_IntelAhci:
6693 {
6694 iLUN = lPort;
6695 pcszDevice = "ahci";
6696 break;
6697 }
6698 case StorageControllerType_BusLogic:
6699 {
6700 iLUN = lPort;
6701 pcszDevice = "buslogic";
6702 fSCSI = true;
6703 break;
6704 }
6705 case StorageControllerType_LsiLogic:
6706 {
6707 iLUN = lPort;
6708 pcszDevice = "lsilogicscsi";
6709 fSCSI = true;
6710 break;
6711 }
6712 default:
6713 {
6714 AssertMsgFailed(("invalid disk controller type: %d\n", enmController));
6715 return VERR_GENERAL_FAILURE;
6716 }
6717 }
6718
6719 /** @todo this should be unified with the relevant part of
6720 * Console::configConstructor to avoid inconsistencies. */
6721
6722 /*
6723 * Is there an existing LUN? If not create it.
6724 * We ASSUME that this will NEVER collide with the DVD.
6725 */
6726 PCFGMNODE pCfg;
6727 PCFGMNODE pLunL1;
6728 PCFGMNODE pLunL2;
6729
6730 /* SCSI has an extra driver between the device and the block driver. */
6731 if (fSCSI)
6732 pLunL1 = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/%s/%u/LUN#%d/AttachedDriver/AttachedDriver/", pcszDevice, lInstance, iLUN);
6733 else
6734 pLunL1 = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/%s/%u/LUN#%d/AttachedDriver/", pcszDevice, lInstance, iLUN);
6735
6736 if (!pLunL1)
6737 {
6738 PCFGMNODE pInst = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "Devices/%s/%u/", pcszDevice, lInstance);
6739 AssertReturn(pInst, VERR_INTERNAL_ERROR);
6740
6741 PCFGMNODE pLunL0;
6742 rc = CFGMR3InsertNodeF(pInst, &pLunL0, "LUN#%d", iLUN); RC_CHECK();
6743
6744 if (fSCSI)
6745 {
6746 rc = CFGMR3InsertString(pLunL0, "Driver", "SCSI"); RC_CHECK();
6747 rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
6748
6749 rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL0); RC_CHECK();
6750 }
6751
6752 rc = CFGMR3InsertString(pLunL0, "Driver", "Block"); RC_CHECK();
6753 rc = CFGMR3InsertNode(pLunL0, "Config", &pCfg); RC_CHECK();
6754 rc = CFGMR3InsertString(pCfg, "Type", "HardDisk"); RC_CHECK();
6755 rc = CFGMR3InsertInteger(pCfg, "Mountable", 0); RC_CHECK();
6756
6757 rc = CFGMR3InsertNode(pLunL0, "AttachedDriver", &pLunL1); RC_CHECK();
6758 rc = CFGMR3InsertString(pLunL1, "Driver", "VD"); RC_CHECK();
6759 rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
6760 }
6761 else
6762 {
6763#ifdef VBOX_STRICT
6764 char *pszDriver;
6765 rc = CFGMR3QueryStringAlloc(pLunL1, "Driver", &pszDriver); RC_CHECK();
6766 Assert(!strcmp(pszDriver, "VD"));
6767 MMR3HeapFree(pszDriver);
6768#endif
6769
6770 pCfg = CFGMR3GetChild(pLunL1, "Config");
6771 AssertReturn(pCfg, VERR_INTERNAL_ERROR);
6772
6773 /* Here used to be a lot of code checking if things have changed,
6774 * but that's not really worth it, as with snapshots there is always
6775 * some change, so the code was just logging useless information in
6776 * a hard to analyze form. */
6777
6778 /*
6779 * Detach the driver and replace the config node.
6780 */
6781 rc = PDMR3DeviceDetach(pVM, pcszDevice, 0, iLUN); RC_CHECK();
6782 CFGMR3RemoveNode(pCfg);
6783 rc = CFGMR3InsertNode(pLunL1, "Config", &pCfg); RC_CHECK();
6784 }
6785
6786 /*
6787 * Create the driver configuration.
6788 */
6789 hrc = hardDisk->COMGETTER(Location)(bstr.asOutParam()); H();
6790 LogFlowFunc (("LUN#%d: leaf location '%ls'\n", iLUN, bstr.raw()));
6791 rc = CFGMR3InsertString(pCfg, "Path", Utf8Str(bstr)); RC_CHECK();
6792 hrc = hardDisk->COMGETTER(Format)(bstr.asOutParam()); H();
6793 LogFlowFunc (("LUN#%d: leaf format '%ls'\n", iLUN, bstr.raw()));
6794 rc = CFGMR3InsertString(pCfg, "Format", Utf8Str(bstr)); RC_CHECK();
6795
6796 /* Pass all custom parameters. */
6797 bool fHostIP = true;
6798 SafeArray <BSTR> names;
6799 SafeArray <BSTR> values;
6800 hrc = hardDisk->GetProperties (NULL,
6801 ComSafeArrayAsOutParam (names),
6802 ComSafeArrayAsOutParam (values)); H();
6803
6804 if (names.size() != 0)
6805 {
6806 PCFGMNODE pVDC;
6807 rc = CFGMR3InsertNode (pCfg, "VDConfig", &pVDC); RC_CHECK();
6808 for (size_t i = 0; i < names.size(); ++ i)
6809 {
6810 if (values [i])
6811 {
6812 Utf8Str name = names [i];
6813 Utf8Str value = values [i];
6814 rc = CFGMR3InsertString (pVDC, name, value);
6815 if ( !(name.compare("HostIPStack"))
6816 && !(value.compare("0")))
6817 fHostIP = false;
6818 }
6819 }
6820 }
6821
6822 /* Create an inversed tree of parents. */
6823 ComPtr<IHardDisk> parentHardDisk = hardDisk;
6824 for (PCFGMNODE pParent = pCfg;;)
6825 {
6826 hrc = parentHardDisk->COMGETTER(Parent)(hardDisk.asOutParam()); H();
6827 if (hardDisk.isNull())
6828 break;
6829
6830 PCFGMNODE pCur;
6831 rc = CFGMR3InsertNode(pParent, "Parent", &pCur); RC_CHECK();
6832 hrc = hardDisk->COMGETTER(Location)(bstr.asOutParam()); H();
6833 rc = CFGMR3InsertString(pCur, "Path", Utf8Str(bstr)); RC_CHECK();
6834
6835 hrc = hardDisk->COMGETTER(Format)(bstr.asOutParam()); H();
6836 rc = CFGMR3InsertString(pCur, "Format", Utf8Str(bstr)); RC_CHECK();
6837
6838 /* Pass all custom parameters. */
6839 SafeArray <BSTR> names;
6840 SafeArray <BSTR> values;
6841 hrc = hardDisk->GetProperties (NULL,
6842 ComSafeArrayAsOutParam (names),
6843 ComSafeArrayAsOutParam (values));H();
6844
6845 if (names.size() != 0)
6846 {
6847 PCFGMNODE pVDC;
6848 rc = CFGMR3InsertNode (pCur, "VDConfig", &pVDC); RC_CHECK();
6849 for (size_t i = 0; i < names.size(); ++ i)
6850 {
6851 if (values [i])
6852 {
6853 Utf8Str name = names [i];
6854 Utf8Str value = values [i];
6855 rc = CFGMR3InsertString (pVDC, name, value);
6856 if ( !(name.compare("HostIPStack"))
6857 && !(value.compare("0")))
6858 fHostIP = false;
6859 }
6860 }
6861 }
6862
6863
6864 /* Custom code: put marker to not use host IP stack to driver
6865 * configuration node. Simplifies life of DrvVD a bit. */
6866 if (!fHostIP)
6867 {
6868 rc = CFGMR3InsertInteger (pCfg, "HostIPStack", 0); RC_CHECK();
6869 }
6870
6871
6872 /* next */
6873 pParent = pCur;
6874 parentHardDisk = hardDisk;
6875 }
6876
6877 CFGMR3Dump(CFGMR3GetRoot(pVM));
6878
6879 /*
6880 * Attach the new driver.
6881 */
6882 rc = PDMR3DeviceAttach(pVM, pcszDevice, 0, iLUN, NULL); RC_CHECK();
6883
6884 LogFlowFunc (("Returns success\n"));
6885 return rc;
6886}
6887
6888
6889/**
6890 * Thread for executing the saved state operation.
6891 *
6892 * @param Thread The thread handle.
6893 * @param pvUser Pointer to a VMSaveTask structure.
6894 * @return VINF_SUCCESS (ignored).
6895 *
6896 * @note Locks the Console object for writing.
6897 */
6898/*static*/
6899DECLCALLBACK (int) Console::saveStateThread (RTTHREAD Thread, void *pvUser)
6900{
6901 LogFlowFuncEnter();
6902
6903 std::auto_ptr <VMSaveTask> task (static_cast <VMSaveTask *> (pvUser));
6904 AssertReturn (task.get(), VERR_INVALID_PARAMETER);
6905
6906 Assert (!task->mSavedStateFile.isNull());
6907 Assert (!task->mProgress.isNull());
6908
6909 const ComObjPtr <Console> &that = task->mConsole;
6910
6911 /*
6912 * Note: no need to use addCaller() to protect Console or addVMCaller() to
6913 * protect mpVM because VMSaveTask does that
6914 */
6915
6916 Utf8Str errMsg;
6917 HRESULT rc = S_OK;
6918
6919 if (task->mIsSnapshot)
6920 {
6921 Assert (!task->mServerProgress.isNull());
6922 LogFlowFunc (("Waiting until the server creates differencing VDIs...\n"));
6923
6924 rc = task->mServerProgress->WaitForCompletion (-1);
6925 if (SUCCEEDED (rc))
6926 {
6927 LONG iRc = S_OK;
6928 rc = task->mServerProgress->COMGETTER(ResultCode) (&iRc);
6929 if (SUCCEEDED (rc))
6930 rc = iRc;
6931 }
6932 }
6933
6934 if (SUCCEEDED (rc))
6935 {
6936 LogFlowFunc (("Saving the state to '%s'...\n", task->mSavedStateFile.raw()));
6937
6938 int vrc = VMR3Save (that->mpVM, task->mSavedStateFile,
6939 Console::stateProgressCallback,
6940 static_cast <VMProgressTask *> (task.get()));
6941 if (VBOX_FAILURE (vrc))
6942 {
6943 errMsg = Utf8StrFmt (
6944 Console::tr ("Failed to save the machine state to '%s' (%Rrc)"),
6945 task->mSavedStateFile.raw(), vrc);
6946 rc = E_FAIL;
6947 }
6948 }
6949
6950 /* lock the console once we're going to access it */
6951 AutoWriteLock thatLock (that);
6952
6953 if (SUCCEEDED (rc))
6954 {
6955 if (task->mIsSnapshot)
6956 do
6957 {
6958 LogFlowFunc (("Reattaching new differencing hard disks...\n"));
6959
6960 com::SafeIfaceArray <IHardDiskAttachment> atts;
6961 rc = that->mMachine->
6962 COMGETTER(HardDiskAttachments) (ComSafeArrayAsOutParam (atts));
6963 if (FAILED (rc))
6964 break;
6965 for (size_t i = 0; i < atts.size(); ++ i)
6966 {
6967 PVMREQ pReq;
6968 ComPtr<IStorageController> controller;
6969 BSTR controllerName;
6970 ULONG lInstance;
6971 StorageControllerType_T enmController;
6972
6973 /*
6974 * We can't pass a storage controller object directly
6975 * (g++ complains about not being able to pass non POD types through '...')
6976 * so we have to query needed values here and pass them.
6977 */
6978 rc = atts[i]->COMGETTER(Controller)(&controllerName);
6979 if (FAILED (rc))
6980 break;
6981
6982 rc = that->mMachine->GetStorageControllerByName(controllerName, controller.asOutParam());
6983 if (FAILED (rc))
6984 break;
6985
6986 rc = controller->COMGETTER(ControllerType)(&enmController);
6987 rc = controller->COMGETTER(Instance)(&lInstance);
6988 /*
6989 * don't leave the lock since reconfigureHardDisks isn't going
6990 * to access Console.
6991 */
6992 int vrc = VMR3ReqCall (that->mpVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
6993 (PFNRT)reconfigureHardDisks, 5, that->mpVM, lInstance,
6994 enmController, atts [i], &rc);
6995 if (VBOX_SUCCESS (rc))
6996 rc = pReq->iStatus;
6997 VMR3ReqFree (pReq);
6998 if (FAILED (rc))
6999 break;
7000 if (VBOX_FAILURE (vrc))
7001 {
7002 errMsg = Utf8StrFmt (Console::tr ("%Rrc"), vrc);
7003 rc = E_FAIL;
7004 break;
7005 }
7006 }
7007 }
7008 while (0);
7009 }
7010
7011 /* finalize the procedure regardless of the result */
7012 if (task->mIsSnapshot)
7013 {
7014 /*
7015 * finalize the requested snapshot object.
7016 * This will reset the machine state to the state it had right
7017 * before calling mControl->BeginTakingSnapshot().
7018 */
7019 that->mControl->EndTakingSnapshot (SUCCEEDED (rc));
7020 }
7021 else
7022 {
7023 /*
7024 * finalize the requested save state procedure.
7025 * In case of success, the server will set the machine state to Saved;
7026 * in case of failure it will reset the it to the state it had right
7027 * before calling mControl->BeginSavingState().
7028 */
7029 that->mControl->EndSavingState (SUCCEEDED (rc));
7030 }
7031
7032 /* synchronize the state with the server */
7033 if (task->mIsSnapshot || FAILED (rc))
7034 {
7035 if (task->mLastMachineState == MachineState_Running)
7036 {
7037 /* restore the paused state if appropriate */
7038 that->setMachineStateLocally (MachineState_Paused);
7039 /* restore the running state if appropriate */
7040 that->Resume();
7041 }
7042 else
7043 that->setMachineStateLocally (task->mLastMachineState);
7044 }
7045 else
7046 {
7047 /*
7048 * The machine has been successfully saved, so power it down
7049 * (vmstateChangeCallback() will set state to Saved on success).
7050 * Note: we release the task's VM caller, otherwise it will
7051 * deadlock.
7052 */
7053 task->releaseVMCaller();
7054
7055 rc = that->powerDown();
7056 }
7057
7058 /* notify the progress object about operation completion */
7059 if (SUCCEEDED (rc))
7060 task->mProgress->notifyComplete (S_OK);
7061 else
7062 {
7063 if (!errMsg.isNull())
7064 task->mProgress->notifyComplete (rc,
7065 COM_IIDOF(IConsole), Console::getComponentName(), errMsg);
7066 else
7067 task->mProgress->notifyComplete (rc);
7068 }
7069
7070 LogFlowFuncLeave();
7071 return VINF_SUCCESS;
7072}
7073
7074/**
7075 * Thread for powering down the Console.
7076 *
7077 * @param Thread The thread handle.
7078 * @param pvUser Pointer to the VMTask structure.
7079 * @return VINF_SUCCESS (ignored).
7080 *
7081 * @note Locks the Console object for writing.
7082 */
7083/*static*/
7084DECLCALLBACK (int) Console::powerDownThread (RTTHREAD Thread, void *pvUser)
7085{
7086 LogFlowFuncEnter();
7087
7088 std::auto_ptr <VMProgressTask> task (static_cast <VMProgressTask *> (pvUser));
7089 AssertReturn (task.get(), VERR_INVALID_PARAMETER);
7090
7091 AssertReturn (task->isOk(), VERR_GENERAL_FAILURE);
7092
7093 const ComObjPtr <Console> &that = task->mConsole;
7094
7095 /* Note: no need to use addCaller() to protect Console because VMTask does
7096 * that */
7097
7098 /* wait until the method tat started us returns */
7099 AutoWriteLock thatLock (that);
7100
7101 /* release VM caller to avoid the powerDown() deadlock */
7102 task->releaseVMCaller();
7103
7104 that->powerDown (task->mProgress);
7105
7106 LogFlowFuncLeave();
7107 return VINF_SUCCESS;
7108}
7109
7110/**
7111 * The Main status driver instance data.
7112 */
7113typedef struct DRVMAINSTATUS
7114{
7115 /** The LED connectors. */
7116 PDMILEDCONNECTORS ILedConnectors;
7117 /** Pointer to the LED ports interface above us. */
7118 PPDMILEDPORTS pLedPorts;
7119 /** Pointer to the array of LED pointers. */
7120 PPDMLED *papLeds;
7121 /** The unit number corresponding to the first entry in the LED array. */
7122 RTUINT iFirstLUN;
7123 /** The unit number corresponding to the last entry in the LED array.
7124 * (The size of the LED array is iLastLUN - iFirstLUN + 1.) */
7125 RTUINT iLastLUN;
7126} DRVMAINSTATUS, *PDRVMAINSTATUS;
7127
7128
7129/**
7130 * Notification about a unit which have been changed.
7131 *
7132 * The driver must discard any pointers to data owned by
7133 * the unit and requery it.
7134 *
7135 * @param pInterface Pointer to the interface structure containing the called function pointer.
7136 * @param iLUN The unit number.
7137 */
7138DECLCALLBACK(void) Console::drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN)
7139{
7140 PDRVMAINSTATUS pData = (PDRVMAINSTATUS)(void *)pInterface;
7141 if (iLUN >= pData->iFirstLUN && iLUN <= pData->iLastLUN)
7142 {
7143 PPDMLED pLed;
7144 int rc = pData->pLedPorts->pfnQueryStatusLed(pData->pLedPorts, iLUN, &pLed);
7145 if (VBOX_FAILURE(rc))
7146 pLed = NULL;
7147 ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLUN - pData->iFirstLUN], pLed);
7148 Log(("drvStatus_UnitChanged: iLUN=%d pLed=%p\n", iLUN, pLed));
7149 }
7150}
7151
7152
7153/**
7154 * Queries an interface to the driver.
7155 *
7156 * @returns Pointer to interface.
7157 * @returns NULL if the interface was not supported by the driver.
7158 * @param pInterface Pointer to this interface structure.
7159 * @param enmInterface The requested interface identification.
7160 */
7161DECLCALLBACK(void *) Console::drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
7162{
7163 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
7164 PDRVMAINSTATUS pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7165 switch (enmInterface)
7166 {
7167 case PDMINTERFACE_BASE:
7168 return &pDrvIns->IBase;
7169 case PDMINTERFACE_LED_CONNECTORS:
7170 return &pDrv->ILedConnectors;
7171 default:
7172 return NULL;
7173 }
7174}
7175
7176
7177/**
7178 * Destruct a status driver instance.
7179 *
7180 * @returns VBox status.
7181 * @param pDrvIns The driver instance data.
7182 */
7183DECLCALLBACK(void) Console::drvStatus_Destruct(PPDMDRVINS pDrvIns)
7184{
7185 PDRVMAINSTATUS pData = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7186 LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7187 if (pData->papLeds)
7188 {
7189 unsigned iLed = pData->iLastLUN - pData->iFirstLUN + 1;
7190 while (iLed-- > 0)
7191 ASMAtomicXchgPtr((void * volatile *)&pData->papLeds[iLed], NULL);
7192 }
7193}
7194
7195
7196/**
7197 * Construct a status driver instance.
7198 *
7199 * @returns VBox status.
7200 * @param pDrvIns The driver instance data.
7201 * If the registration structure is needed, pDrvIns->pDrvReg points to it.
7202 * @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
7203 * of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
7204 * iInstance it's expected to be used a bit in this function.
7205 */
7206DECLCALLBACK(int) Console::drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
7207{
7208 PDRVMAINSTATUS pData = PDMINS_2_DATA(pDrvIns, PDRVMAINSTATUS);
7209 LogFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
7210
7211 /*
7212 * Validate configuration.
7213 */
7214 if (!CFGMR3AreValuesValid(pCfgHandle, "papLeds\0First\0Last\0"))
7215 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
7216 PPDMIBASE pBaseIgnore;
7217 int rc = pDrvIns->pDrvHlp->pfnAttach(pDrvIns, &pBaseIgnore);
7218 if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
7219 {
7220 AssertMsgFailed(("Configuration error: Not possible to attach anything to this driver!\n"));
7221 return VERR_PDM_DRVINS_NO_ATTACH;
7222 }
7223
7224 /*
7225 * Data.
7226 */
7227 pDrvIns->IBase.pfnQueryInterface = Console::drvStatus_QueryInterface;
7228 pData->ILedConnectors.pfnUnitChanged = Console::drvStatus_UnitChanged;
7229
7230 /*
7231 * Read config.
7232 */
7233 rc = CFGMR3QueryPtr(pCfgHandle, "papLeds", (void **)&pData->papLeds);
7234 if (VBOX_FAILURE(rc))
7235 {
7236 AssertMsgFailed(("Configuration error: Failed to query the \"papLeds\" value! rc=%Rrc\n", rc));
7237 return rc;
7238 }
7239
7240 rc = CFGMR3QueryU32(pCfgHandle, "First", &pData->iFirstLUN);
7241 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7242 pData->iFirstLUN = 0;
7243 else if (VBOX_FAILURE(rc))
7244 {
7245 AssertMsgFailed(("Configuration error: Failed to query the \"First\" value! rc=%Rrc\n", rc));
7246 return rc;
7247 }
7248
7249 rc = CFGMR3QueryU32(pCfgHandle, "Last", &pData->iLastLUN);
7250 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
7251 pData->iLastLUN = 0;
7252 else if (VBOX_FAILURE(rc))
7253 {
7254 AssertMsgFailed(("Configuration error: Failed to query the \"Last\" value! rc=%Rrc\n", rc));
7255 return rc;
7256 }
7257 if (pData->iFirstLUN > pData->iLastLUN)
7258 {
7259 AssertMsgFailed(("Configuration error: Invalid unit range %u-%u\n", pData->iFirstLUN, pData->iLastLUN));
7260 return VERR_GENERAL_FAILURE;
7261 }
7262
7263 /*
7264 * Get the ILedPorts interface of the above driver/device and
7265 * query the LEDs we want.
7266 */
7267 pData->pLedPorts = (PPDMILEDPORTS)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_LED_PORTS);
7268 if (!pData->pLedPorts)
7269 {
7270 AssertMsgFailed(("Configuration error: No led ports interface above!\n"));
7271 return VERR_PDM_MISSING_INTERFACE_ABOVE;
7272 }
7273
7274 for (unsigned i = pData->iFirstLUN; i <= pData->iLastLUN; i++)
7275 Console::drvStatus_UnitChanged(&pData->ILedConnectors, i);
7276
7277 return VINF_SUCCESS;
7278}
7279
7280
7281/**
7282 * Keyboard driver registration record.
7283 */
7284const PDMDRVREG Console::DrvStatusReg =
7285{
7286 /* u32Version */
7287 PDM_DRVREG_VERSION,
7288 /* szDriverName */
7289 "MainStatus",
7290 /* pszDescription */
7291 "Main status driver (Main as in the API).",
7292 /* fFlags */
7293 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
7294 /* fClass. */
7295 PDM_DRVREG_CLASS_STATUS,
7296 /* cMaxInstances */
7297 ~0,
7298 /* cbInstance */
7299 sizeof(DRVMAINSTATUS),
7300 /* pfnConstruct */
7301 Console::drvStatus_Construct,
7302 /* pfnDestruct */
7303 Console::drvStatus_Destruct,
7304 /* pfnIOCtl */
7305 NULL,
7306 /* pfnPowerOn */
7307 NULL,
7308 /* pfnReset */
7309 NULL,
7310 /* pfnSuspend */
7311 NULL,
7312 /* pfnResume */
7313 NULL,
7314 /* pfnDetach */
7315 NULL
7316};
7317/* 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