VirtualBox

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

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

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