VirtualBox

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

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

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

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