VirtualBoxImpl.cpp revision 4fea7a40e3d4c0e903287c0ee728512f3e63df72
6a67d144095c31bbafed93cec1619590157335eajvergara/* $Id$ */
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara/** @file
6a67d144095c31bbafed93cec1619590157335eajvergara * Implementation of IVirtualBox in VBoxSVC.
6a67d144095c31bbafed93cec1619590157335eajvergara */
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara/*
6a67d144095c31bbafed93cec1619590157335eajvergara * Copyright (C) 2006-2010 Oracle Corporation
6a67d144095c31bbafed93cec1619590157335eajvergara *
6a67d144095c31bbafed93cec1619590157335eajvergara * This file is part of VirtualBox Open Source Edition (OSE), as
6a67d144095c31bbafed93cec1619590157335eajvergara * available from http://www.virtualbox.org. This file is free software;
6a67d144095c31bbafed93cec1619590157335eajvergara * you can redistribute it and/or modify it under the terms of the GNU
6a67d144095c31bbafed93cec1619590157335eajvergara * General Public License (GPL) as published by the Free Software
6a67d144095c31bbafed93cec1619590157335eajvergara * Foundation, in version 2 as it comes in the "COPYING" file of the
6a67d144095c31bbafed93cec1619590157335eajvergara * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
6a67d144095c31bbafed93cec1619590157335eajvergara * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
6a67d144095c31bbafed93cec1619590157335eajvergara */
6a67d144095c31bbafed93cec1619590157335eajvergara
f71f7a61dec7c9089378d14493ad564a1dedf0b5neil_a_wilson#include <iprt/asm.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/buildconfig.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/cpp/utils.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/dir.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/env.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/file.h>
d6c71e7b06ef8919af4c8186b4ffb08766c20a09neil_a_wilson#include <iprt/path.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/process.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/string.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/stream.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/thread.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/uuid.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <iprt/cpp/xml.h>
6a67d144095c31bbafed93cec1619590157335eajvergara
2401d3c2af505789c7c3b860a43e973f27731243jvergara#include <VBox/com/com.h>
2401d3c2af505789c7c3b860a43e973f27731243jvergara#include <VBox/com/array.h>
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara#include "VBox/com/EventQueue.h"
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
6a67d144095c31bbafed93cec1619590157335eajvergara#include <VBox/err.h>
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter#include <VBox/param.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <VBox/VBoxHDD.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <VBox/settings.h>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <VBox/version.h>
2401d3c2af505789c7c3b860a43e973f27731243jvergara
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter#include <package-generated.h>
2401d3c2af505789c7c3b860a43e973f27731243jvergara
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter#include <algorithm>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <set>
6a67d144095c31bbafed93cec1619590157335eajvergara#include <vector>
4c5f6e1826364b5d627620cbc906da0d48ec5348jvergara#include <memory> // for auto_ptr
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara#include <typeinfo>
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara#include "VirtualBoxImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara#include "Global.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "MachineImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "MediumImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "SharedFolderImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "ProgressImpl.h"
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter#include "ProgressProxyImpl.h"
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter#include "HostImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "USBControllerImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "SystemPropertiesImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "GuestOSTypeImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "DHCPServerRunner.h"
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara#include "DHCPServerImpl.h"
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara#ifdef VBOX_WITH_RESOURCE_USAGE_API
6a67d144095c31bbafed93cec1619590157335eajvergara#include "PerformanceImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#endif /* VBOX_WITH_RESOURCE_USAGE_API */
7b6b125d52edabd5b1c9134feef7aeae0e69499ekenneth_suter#include "EventImpl.h"
6a67d144095c31bbafed93cec1619590157335eajvergara
7b6b125d52edabd5b1c9134feef7aeae0e69499ekenneth_suter#include "AutoCaller.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#include "Logging.h"
7b6b125d52edabd5b1c9134feef7aeae0e69499ekenneth_suter#include "objectslist.h"
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara#ifdef RT_OS_WINDOWS
6a67d144095c31bbafed93cec1619590157335eajvergara# include "win/svchlp.h"
6a67d144095c31bbafed93cec1619590157335eajvergara# include "win/VBoxComEvents.h"
6a67d144095c31bbafed93cec1619590157335eajvergara#endif
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara////////////////////////////////////////////////////////////////////////////////
6a67d144095c31bbafed93cec1619590157335eajvergara//
6a67d144095c31bbafed93cec1619590157335eajvergara// Definitions
6a67d144095c31bbafed93cec1619590157335eajvergara//
6a67d144095c31bbafed93cec1619590157335eajvergara////////////////////////////////////////////////////////////////////////////////
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara#define VBOX_GLOBAL_SETTINGS_FILE "VirtualBox.xml"
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara////////////////////////////////////////////////////////////////////////////////
6a67d144095c31bbafed93cec1619590157335eajvergara//
6a67d144095c31bbafed93cec1619590157335eajvergara// Global variables
6a67d144095c31bbafed93cec1619590157335eajvergara//
2401d3c2af505789c7c3b860a43e973f27731243jvergara////////////////////////////////////////////////////////////////////////////////
2401d3c2af505789c7c3b860a43e973f27731243jvergara
2401d3c2af505789c7c3b860a43e973f27731243jvergara// static
2401d3c2af505789c7c3b860a43e973f27731243jvergaraBstr VirtualBox::sVersion;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara// static
2401d3c2af505789c7c3b860a43e973f27731243jvergaraULONG VirtualBox::sRevision;
2401d3c2af505789c7c3b860a43e973f27731243jvergara
2401d3c2af505789c7c3b860a43e973f27731243jvergara// static
2401d3c2af505789c7c3b860a43e973f27731243jvergaraBstr VirtualBox::sPackageType;
2401d3c2af505789c7c3b860a43e973f27731243jvergara
2401d3c2af505789c7c3b860a43e973f27731243jvergara////////////////////////////////////////////////////////////////////////////////
2401d3c2af505789c7c3b860a43e973f27731243jvergara//
2401d3c2af505789c7c3b860a43e973f27731243jvergara// VirtualBoxCallbackRegistration
2401d3c2af505789c7c3b860a43e973f27731243jvergara//
2401d3c2af505789c7c3b860a43e973f27731243jvergara////////////////////////////////////////////////////////////////////////////////
2401d3c2af505789c7c3b860a43e973f27731243jvergara
2401d3c2af505789c7c3b860a43e973f27731243jvergara/**
6a67d144095c31bbafed93cec1619590157335eajvergara * Registered IVirtualBoxCallback, used by VirtualBox::CallbackList and
6a67d144095c31bbafed93cec1619590157335eajvergara * VirtualBox::Data::llCallbacks.
6a67d144095c31bbafed93cec1619590157335eajvergara *
6a67d144095c31bbafed93cec1619590157335eajvergara * In addition to keeping the interface pointer this also keeps track of the
6a67d144095c31bbafed93cec1619590157335eajvergara * methods that asked to not be called again. The latter is for reducing
6a67d144095c31bbafed93cec1619590157335eajvergara * unnecessary IPC.
6a67d144095c31bbafed93cec1619590157335eajvergara */
6a67d144095c31bbafed93cec1619590157335eajvergaraclass VirtualBoxCallbackRegistration
6a67d144095c31bbafed93cec1619590157335eajvergara{
6a67d144095c31bbafed93cec1619590157335eajvergarapublic:
6a67d144095c31bbafed93cec1619590157335eajvergara /** Callback bit indexes (for bmDisabled). */
6a67d144095c31bbafed93cec1619590157335eajvergara typedef enum
6a67d144095c31bbafed93cec1619590157335eajvergara {
6a67d144095c31bbafed93cec1619590157335eajvergara kOnMachineStateChanged = 0,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnMachineDataChanged,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnExtraDataCanChange,
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter kOnExtraDataChanged,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnMediumRegistered,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnMachineRegistered,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnSessionStateChanged,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnSnapshotTaken,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnSnapshotDeleted,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnSnapshotChanged,
6a67d144095c31bbafed93cec1619590157335eajvergara kOnGuestPropertyChanged
6a67d144095c31bbafed93cec1619590157335eajvergara } CallbackBit;
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara VirtualBoxCallbackRegistration()
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter {
ffa279622cea61d6eec13e3df386bd3015388388jvergara /* nothing */
6a67d144095c31bbafed93cec1619590157335eajvergara }
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara ~VirtualBoxCallbackRegistration()
6a67d144095c31bbafed93cec1619590157335eajvergara {
6a67d144095c31bbafed93cec1619590157335eajvergara /* nothing */
6a67d144095c31bbafed93cec1619590157335eajvergara }
6a67d144095c31bbafed93cec1619590157335eajvergara};
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara////////////////////////////////////////////////////////////////////////////////
6a67d144095c31bbafed93cec1619590157335eajvergara//
6a67d144095c31bbafed93cec1619590157335eajvergara// CallbackEvent class
6a67d144095c31bbafed93cec1619590157335eajvergara//
6a67d144095c31bbafed93cec1619590157335eajvergara////////////////////////////////////////////////////////////////////////////////
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara/**
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara * Abstract callback event class to asynchronously call VirtualBox callbacks
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara * on a dedicated event thread. Subclasses reimplement #handleCallback()
6a67d144095c31bbafed93cec1619590157335eajvergara * to call appropriate IVirtualBoxCallback methods depending on the event
6a67d144095c31bbafed93cec1619590157335eajvergara * to be dispatched.
6a67d144095c31bbafed93cec1619590157335eajvergara *
6a67d144095c31bbafed93cec1619590157335eajvergara * @note The VirtualBox instance passed to the constructor is strongly
6a67d144095c31bbafed93cec1619590157335eajvergara * referenced, so that the VirtualBox singleton won't be released until the
6a67d144095c31bbafed93cec1619590157335eajvergara * event gets handled by the event thread.
6a67d144095c31bbafed93cec1619590157335eajvergara */
6a67d144095c31bbafed93cec1619590157335eajvergaraclass VirtualBox::CallbackEvent : public Event
6a67d144095c31bbafed93cec1619590157335eajvergara{
6a67d144095c31bbafed93cec1619590157335eajvergarapublic:
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara CallbackEvent(VirtualBox *aVirtualBox, VirtualBoxCallbackRegistration::CallbackBit aWhat)
6a67d144095c31bbafed93cec1619590157335eajvergara : mVirtualBox(aVirtualBox), mWhat(aWhat)
6a67d144095c31bbafed93cec1619590157335eajvergara {
6a67d144095c31bbafed93cec1619590157335eajvergara Assert(aVirtualBox);
6a67d144095c31bbafed93cec1619590157335eajvergara }
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara void *handler();
6a67d144095c31bbafed93cec1619590157335eajvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc) = 0;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergaraprivate:
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara /**
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara * Note that this is a weak ref -- the CallbackEvent handler thread
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara * is bound to the lifetime of the VirtualBox instance, so it's safe.
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara */
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara VirtualBox *mVirtualBox;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergaraprotected:
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara VirtualBoxCallbackRegistration::CallbackBit mWhat;
6a67d144095c31bbafed93cec1619590157335eajvergara};
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara////////////////////////////////////////////////////////////////////////////////
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter//
6a67d144095c31bbafed93cec1619590157335eajvergara// VirtualBox private member data definition
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter//
2401d3c2af505789c7c3b860a43e973f27731243jvergara////////////////////////////////////////////////////////////////////////////////
2401d3c2af505789c7c3b860a43e973f27731243jvergara
2401d3c2af505789c7c3b860a43e973f27731243jvergara#if defined(RT_OS_WINDOWS)
252ea19a057499e16910a99b951793bdd6d468f7kenneth_suter #define UPDATEREQARG NULL
6a67d144095c31bbafed93cec1619590157335eajvergara #define UPDATEREQTYPE HANDLE
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara#elif defined(RT_OS_OS2)
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter #define UPDATEREQARG NIL_RTSEMEVENT
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter #define UPDATEREQTYPE RTSEMEVENT
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
0877596da3b90efc5fd39171cef80a2fb8ec395ekenneth_suter #define UPDATEREQARG
2401d3c2af505789c7c3b860a43e973f27731243jvergara #define UPDATEREQTYPE RTSEMEVENT
2401d3c2af505789c7c3b860a43e973f27731243jvergara#else
2401d3c2af505789c7c3b860a43e973f27731243jvergara# error "Port me!"
76d78217d6ca09688d73efe4da48c76e6abc1f23kenneth_suter#endif
76d78217d6ca09688d73efe4da48c76e6abc1f23kenneth_suter
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef ObjectsList<Machine> MachinesOList;
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef ObjectsList<Medium> MediaOList;
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef ObjectsList<GuestOSType> GuestOSTypesOList;
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef ObjectsList<SharedFolder> SharedFoldersOList;
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef ObjectsList<DHCPServer> DHCPServersOList;
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergara
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef std::map<Guid, ComPtr<IProgress> > ProgressMap;
c9d984b0d2c0fda320e79eb3868dd6fbeb1ffa34jvergaratypedef std::map<Guid, ComObjPtr<Medium> > HardDiskMap;
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara/**
6a67d144095c31bbafed93cec1619590157335eajvergara * Main VirtualBox data structure.
6a67d144095c31bbafed93cec1619590157335eajvergara * @note |const| members are persistent during lifetime so can be accessed
6a67d144095c31bbafed93cec1619590157335eajvergara * without locking.
6a67d144095c31bbafed93cec1619590157335eajvergara */
6a67d144095c31bbafed93cec1619590157335eajvergarastruct VirtualBox::Data
6a67d144095c31bbafed93cec1619590157335eajvergara{
6a67d144095c31bbafed93cec1619590157335eajvergara Data()
6a67d144095c31bbafed93cec1619590157335eajvergara : pMainConfigFile(NULL),
6a67d144095c31bbafed93cec1619590157335eajvergara lockMachines(LOCKCLASS_LISTOFMACHINES),
6a67d144095c31bbafed93cec1619590157335eajvergara allMachines(lockMachines),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter lockGuestOSTypes(LOCKCLASS_LISTOFOTHEROBJECTS),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter allGuestOSTypes(lockGuestOSTypes),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter lockMedia(LOCKCLASS_LISTOFMEDIA),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter allHardDisks(lockMedia),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter allDVDImages(lockMedia),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter allFloppyImages(lockMedia),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter lockSharedFolders(LOCKCLASS_LISTOFOTHEROBJECTS),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter allSharedFolders(lockSharedFolders),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter lockDHCPServers(LOCKCLASS_LISTOFOTHEROBJECTS),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter allDHCPServers(lockDHCPServers),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter mtxProgressOperations(LOCKCLASS_PROGRESSLIST),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter updateReq(UPDATEREQARG),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter threadClientWatcher(NIL_RTTHREAD),
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter threadAsyncEvent(NIL_RTTHREAD),
6a67d144095c31bbafed93cec1619590157335eajvergara pAsyncEventQ(NULL)
6a67d144095c31bbafed93cec1619590157335eajvergara {}
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara ~Data()
6a67d144095c31bbafed93cec1619590157335eajvergara {
6a67d144095c31bbafed93cec1619590157335eajvergara if (pMainConfigFile)
6a67d144095c31bbafed93cec1619590157335eajvergara {
6a67d144095c31bbafed93cec1619590157335eajvergara delete pMainConfigFile;
6a67d144095c31bbafed93cec1619590157335eajvergara pMainConfigFile = NULL;
6a67d144095c31bbafed93cec1619590157335eajvergara }
6a67d144095c31bbafed93cec1619590157335eajvergara };
6a67d144095c31bbafed93cec1619590157335eajvergara
6a67d144095c31bbafed93cec1619590157335eajvergara // const data members not requiring locking
6a67d144095c31bbafed93cec1619590157335eajvergara const Utf8Str strHomeDir;
6a67d144095c31bbafed93cec1619590157335eajvergara
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter // VirtualBox main settings file
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const Utf8Str strSettingsFilePath;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter settings::MainConfigFile *pMainConfigFile;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter // const objects not requiring locking
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const ComObjPtr<Host> pHost;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const ComObjPtr<SystemProperties> pSystemProperties;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter#ifdef VBOX_WITH_RESOURCE_USAGE_API
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const ComObjPtr<PerformanceCollector> pPerformanceCollector;
6a67d144095c31bbafed93cec1619590157335eajvergara#endif /* VBOX_WITH_RESOURCE_USAGE_API */
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
6a67d144095c31bbafed93cec1619590157335eajvergara // Each of the following lists use a particular lock handle that protects the
6a67d144095c31bbafed93cec1619590157335eajvergara // list as a whole. As opposed to version 3.1 and earlier, these lists no
6a67d144095c31bbafed93cec1619590157335eajvergara // longer need the main VirtualBox object lock, but only the respective list
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter // lock. In each case, the locking order is defined that the list must be
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter // requested before object locks of members of the lists (see the order definitions
6a67d144095c31bbafed93cec1619590157335eajvergara // in AutoLock.h; e.g. LOCKCLASS_LISTOFMACHINES before LOCKCLASS_MACHINEOBJECT).
6a67d144095c31bbafed93cec1619590157335eajvergara RWLockHandle lockMachines;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter MachinesOList allMachines;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara RWLockHandle lockGuestOSTypes;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara GuestOSTypesOList allGuestOSTypes;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara // All the media lists are protected by the following locking handle:
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara RWLockHandle lockMedia;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara MediaOList allHardDisks, // base images only!
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara allDVDImages,
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara allFloppyImages;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara // the hard disks map is an additional map sorted by UUID for quick lookup
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara // and contains ALL hard disks (base and differencing); it is protected by
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara // the same lock as the other media lists above
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara HardDiskMap mapHardDisks;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara // list of pending machine renames (also protected by media tree lock;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara // see VirtualBox::rememberMachineNameChangeForMedia())
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara struct PendingMachineRename
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara {
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara Utf8Str strConfigDirOld;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara Utf8Str strConfigDirNew;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara };
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara typedef std::list<PendingMachineRename> PendingMachineRenamesList;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara PendingMachineRenamesList llPendingMachineRenames;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara RWLockHandle lockSharedFolders;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara SharedFoldersOList allSharedFolders;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara RWLockHandle lockDHCPServers;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara DHCPServersOList allDHCPServers;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara RWLockHandle mtxProgressOperations;
48013e6d1c0677bd7649309e6b0b611b6c364c77jvergara ProgressMap mapProgressOperations;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter // the following are data for the client watcher thread
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const UPDATEREQTYPE updateReq;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const RTTHREAD threadClientWatcher;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter typedef std::list<RTPROCESS> ProcessList;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter ProcessList llProcesses;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter // the following are data for the async event thread
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const RTTHREAD threadAsyncEvent;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter EventQueue * const pAsyncEventQ;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter const ComObjPtr<EventSource> pEventSource;
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter};
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter// constructor / destructor
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter/////////////////////////////////////////////////////////////////////////////
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suterVirtualBox::VirtualBox()
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter{}
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suterVirtualBox::~VirtualBox()
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter{}
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suterHRESULT VirtualBox::FinalConstruct()
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter{
0142bbb7ccb5d0efb942c20f5d27e5ddfb4344fdkenneth_suter LogFlowThisFunc(("\n"));
6a67d144095c31bbafed93cec1619590157335eajvergara
return init();
}
void VirtualBox::FinalRelease()
{
LogFlowThisFunc(("\n"));
uninit();
}
// public initializer/uninitializer for internal purposes only
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes the VirtualBox object.
*
* @return COM result code
*/
HRESULT VirtualBox::init()
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), E_FAIL);
/* Locking this object for writing during init sounds a bit paradoxical,
* but in the current locking mess this avoids that some code gets a
* read lock and later calls code which wants the same write lock. */
AutoWriteLock lock(this COMMA_LOCKVAL_SRC_POS);
// allocate our instance data
m = new Data;
LogFlow(("===========================================================\n"));
LogFlowThisFuncEnter();
if (sVersion.isEmpty())
sVersion = VBOX_VERSION_STRING;
sRevision = RTBldCfgRevision();
if (sPackageType.isEmpty())
sPackageType = VBOX_PACKAGE_STRING;
LogFlowThisFunc(("Version: %ls, Package: %ls\n", sVersion.raw(), sPackageType.raw()));
/* Get the VirtualBox home directory. */
{
char szHomeDir[RTPATH_MAX];
int vrc = com::GetVBoxUserHomeDirectory(szHomeDir, sizeof(szHomeDir));
if (RT_FAILURE(vrc))
return setError(E_FAIL,
tr("Could not create the VirtualBox home directory '%s' (%Rrc)"),
szHomeDir, vrc);
unconst(m->strHomeDir) = szHomeDir;
}
/* compose the VirtualBox.xml file name */
unconst(m->strSettingsFilePath) = Utf8StrFmt("%s%c%s",
m->strHomeDir.raw(),
RTPATH_DELIMITER,
VBOX_GLOBAL_SETTINGS_FILE);
HRESULT rc = S_OK;
bool fCreate = false;
try
{
// load and parse VirtualBox.xml; this will throw on XML or logic errors
try
{
m->pMainConfigFile = new settings::MainConfigFile(&m->strSettingsFilePath);
}
catch (xml::EIPRTFailure &e)
{
// this is thrown by the XML backend if the RTOpen() call fails;
// only if the main settings file does not exist, create it,
// if there's something more serious, then do fail!
if (e.rc() == VERR_FILE_NOT_FOUND)
fCreate = true;
else
throw;
}
if (fCreate)
m->pMainConfigFile = new settings::MainConfigFile(NULL);
#ifdef VBOX_WITH_RESOURCE_USAGE_API
/* create the performance collector object BEFORE host */
unconst(m->pPerformanceCollector).createObject();
rc = m->pPerformanceCollector->init();
ComAssertComRCThrowRC(rc);
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
/* create the host object early, machines will need it */
unconst(m->pHost).createObject();
rc = m->pHost->init(this);
ComAssertComRCThrowRC(rc);
rc = m->pHost->loadSettings(m->pMainConfigFile->host);
if (FAILED(rc)) throw rc;
/* create the system properties object, someone may need it too */
unconst(m->pSystemProperties).createObject();
rc = m->pSystemProperties->init(this);
ComAssertComRCThrowRC(rc);
rc = m->pSystemProperties->loadSettings(m->pMainConfigFile->systemProperties);
if (FAILED(rc)) throw rc;
/* guest OS type objects, needed by machines */
for (size_t i = 0; i < RT_ELEMENTS(Global::sOSTypes); ++ i)
{
ComObjPtr <GuestOSType> guestOSTypeObj;
rc = guestOSTypeObj.createObject();
if (SUCCEEDED(rc))
{
rc = guestOSTypeObj->init(Global::sOSTypes[i].familyId,
Global::sOSTypes[i].familyDescription,
Global::sOSTypes[i].id,
Global::sOSTypes[i].description,
Global::sOSTypes[i].osType,
Global::sOSTypes[i].osHint,
Global::sOSTypes[i].recommendedRAM,
Global::sOSTypes[i].recommendedVRAM,
Global::sOSTypes[i].recommendedHDD,
Global::sOSTypes[i].networkAdapterType,
Global::sOSTypes[i].numSerialEnabled,
Global::sOSTypes[i].dvdStorageControllerType,
Global::sOSTypes[i].dvdStorageBusType,
Global::sOSTypes[i].hdStorageControllerType,
Global::sOSTypes[i].hdStorageBusType);
if (SUCCEEDED(rc))
m->allGuestOSTypes.addChild(guestOSTypeObj);
}
ComAssertComRCThrowRC(rc);
}
/* all registered media, needed by machines */
if (FAILED(rc = initMedia()))
throw rc;
/* machines */
if (FAILED(rc = initMachines()))
throw rc;
#ifdef DEBUG
LogFlowThisFunc(("Dumping media backreferences\n"));
dumpAllBackRefs();
#endif
/* net services */
for (settings::DHCPServersList::const_iterator it = m->pMainConfigFile->llDhcpServers.begin();
it != m->pMainConfigFile->llDhcpServers.end();
++it)
{
const settings::DHCPServer &data = *it;
ComObjPtr<DHCPServer> pDhcpServer;
if (SUCCEEDED(rc = pDhcpServer.createObject()))
rc = pDhcpServer->init(this, data);
if (FAILED(rc)) throw rc;
rc = registerDHCPServer(pDhcpServer, false /* aSaveRegistry */);
if (FAILED(rc)) throw rc;
}
/* events */
if (SUCCEEDED(rc = unconst(m->pEventSource).createObject()))
rc = m->pEventSource->init(static_cast<IVirtualBox*>(this));
if (FAILED(rc)) throw rc;
}
catch (HRESULT err)
{
/* we assume that error info is set by the thrower */
rc = err;
}
catch (...)
{
rc = VirtualBox::handleUnexpectedExceptions(RT_SRC_POS);
}
if (SUCCEEDED(rc))
{
/* start the client watcher thread */
#if defined(RT_OS_WINDOWS)
unconst(m->updateReq) = ::CreateEvent(NULL, FALSE, FALSE, NULL);
#elif defined(RT_OS_OS2)
RTSemEventCreate(&unconst(m->updateReq));
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
RTSemEventCreate(&unconst(m->updateReq));
#else
# error "Port me!"
#endif
int vrc = RTThreadCreate(&unconst(m->threadClientWatcher),
ClientWatcher,
(void *)this,
0,
RTTHREADTYPE_MAIN_WORKER,
RTTHREADFLAGS_WAITABLE,
"Watcher");
ComAssertRC(vrc);
if (RT_FAILURE(vrc))
rc = E_FAIL;
}
if (SUCCEEDED(rc))
{
try
{
/* start the async event handler thread */
int vrc = RTThreadCreate(&unconst(m->threadAsyncEvent),
AsyncEventHandler,
&unconst(m->pAsyncEventQ),
0,
RTTHREADTYPE_MAIN_WORKER,
RTTHREADFLAGS_WAITABLE,
"EventHandler");
ComAssertRCThrow(vrc, E_FAIL);
/* wait until the thread sets m->pAsyncEventQ */
RTThreadUserWait(m->threadAsyncEvent, RT_INDEFINITE_WAIT);
ComAssertThrow(m->pAsyncEventQ, E_FAIL);
}
catch (HRESULT aRC)
{
rc = aRC;
}
}
/* Confirm a successful initialization when it's the case */
if (SUCCEEDED(rc))
autoInitSpan.setSucceeded();
LogFlowThisFunc(("rc=%08X\n", rc));
LogFlowThisFuncLeave();
LogFlow(("===========================================================\n"));
return rc;
}
HRESULT VirtualBox::initMachines()
{
for (settings::MachinesRegistry::const_iterator it = m->pMainConfigFile->llMachines.begin();
it != m->pMainConfigFile->llMachines.end();
++it)
{
HRESULT rc = S_OK;
const settings::MachineRegistryEntry &xmlMachine = *it;
Guid uuid = xmlMachine.uuid;
ComObjPtr<Machine> pMachine;
if (SUCCEEDED(rc = pMachine.createObject()))
{
rc = pMachine->init(this,
xmlMachine.strSettingsFile,
&uuid);
if (SUCCEEDED(rc))
rc = registerMachine(pMachine);
if (FAILED(rc))
return rc;
}
}
return S_OK;
}
HRESULT VirtualBox::initMedia()
{
AutoWriteLock treeLock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
HRESULT rc = S_OK;
settings::MediaList::const_iterator it;
for (it = m->pMainConfigFile->llHardDisks.begin();
it != m->pMainConfigFile->llHardDisks.end();
++it)
{
const settings::Medium &xmlHD = *it;
ComObjPtr<Medium> pHardDisk;
if (SUCCEEDED(rc = pHardDisk.createObject()))
rc = pHardDisk->init(this,
NULL, // parent
DeviceType_HardDisk,
xmlHD); // XML data; this recurses to processes the children
if (FAILED(rc)) return rc;
rc = registerHardDisk(pHardDisk, NULL /*pfNeedsSaveSettings*/ );
if (FAILED(rc)) return rc;
}
for (it = m->pMainConfigFile->llDvdImages.begin();
it != m->pMainConfigFile->llDvdImages.end();
++it)
{
const settings::Medium &xmlDvd = *it;
ComObjPtr<Medium> pImage;
if (SUCCEEDED(pImage.createObject()))
rc = pImage->init(this, NULL, DeviceType_DVD, xmlDvd);
if (FAILED(rc)) return rc;
rc = registerImage(pImage, DeviceType_DVD, NULL /*pfNeedsSaveSettings*/ );
if (FAILED(rc)) return rc;
}
for (it = m->pMainConfigFile->llFloppyImages.begin();
it != m->pMainConfigFile->llFloppyImages.end();
++it)
{
const settings::Medium &xmlFloppy = *it;
ComObjPtr<Medium> pImage;
if (SUCCEEDED(pImage.createObject()))
rc = pImage->init(this, NULL, DeviceType_Floppy, xmlFloppy);
if (FAILED(rc)) return rc;
rc = registerImage(pImage, DeviceType_Floppy, NULL /*pfNeedsSaveSettings*/ );
if (FAILED(rc)) return rc;
}
return S_OK;
}
void VirtualBox::uninit()
{
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
return;
LogFlow(("===========================================================\n"));
LogFlowThisFuncEnter();
LogFlowThisFunc(("initFailed()=%d\n", autoUninitSpan.initFailed()));
/* tell all our child objects we've been uninitialized */
LogFlowThisFunc(("Uninitializing machines (%d)...\n", m->allMachines.size()));
if (m->pHost)
{
/* It is necessary to hold the VirtualBox and Host locks here because
we may have to uninitialize SessionMachines. */
AutoMultiWriteLock2 multilock(this, m->pHost COMMA_LOCKVAL_SRC_POS);
m->allMachines.uninitAll();
}
else
m->allMachines.uninitAll();
m->allFloppyImages.uninitAll();
m->allDVDImages.uninitAll();
m->allHardDisks.uninitAll();
m->allDHCPServers.uninitAll();
m->mapProgressOperations.clear();
m->allGuestOSTypes.uninitAll();
/* Note that we release singleton children after we've all other children.
* In some cases this is important because these other children may use
* some resources of the singletons which would prevent them from
* uninitializing (as for example, mSystemProperties which owns
* MediumFormat objects which Medium objects refer to) */
if (m->pSystemProperties)
{
m->pSystemProperties->uninit();
unconst(m->pSystemProperties).setNull();
}
if (m->pHost)
{
m->pHost->uninit();
unconst(m->pHost).setNull();
}
#ifdef VBOX_WITH_RESOURCE_USAGE_API
if (m->pPerformanceCollector)
{
m->pPerformanceCollector->uninit();
unconst(m->pPerformanceCollector).setNull();
}
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
LogFlowThisFunc(("Terminating the async event handler...\n"));
if (m->threadAsyncEvent != NIL_RTTHREAD)
{
/* signal to exit the event loop */
if (m->pAsyncEventQ->postEvent(NULL))
{
/*
* Wait for thread termination (only if we've successfully posted
* a NULL event!)
*/
int vrc = RTThreadWait(m->threadAsyncEvent, 60000, NULL);
if (RT_FAILURE(vrc))
LogWarningFunc(("RTThreadWait(%RTthrd) -> %Rrc\n",
m->threadAsyncEvent, vrc));
}
else
{
AssertMsgFailed(("postEvent(NULL) failed\n"));
RTThreadWait(m->threadAsyncEvent, 0, NULL);
}
unconst(m->threadAsyncEvent) = NIL_RTTHREAD;
unconst(m->pAsyncEventQ) = NULL;
}
LogFlowThisFunc(("Releasing event source...\n"));
if (m->pEventSource)
{
// we don't perform uninit() as it's possible that some pending event refers to this source
unconst(m->pEventSource).setNull();
}
LogFlowThisFunc(("Terminating the client watcher...\n"));
if (m->threadClientWatcher != NIL_RTTHREAD)
{
/* signal the client watcher thread */
updateClientWatcher();
/* wait for the termination */
RTThreadWait(m->threadClientWatcher, RT_INDEFINITE_WAIT, NULL);
unconst(m->threadClientWatcher) = NIL_RTTHREAD;
}
m->llProcesses.clear();
#if defined(RT_OS_WINDOWS)
if (m->updateReq != NULL)
{
::CloseHandle(m->updateReq);
unconst(m->updateReq) = NULL;
}
#elif defined(RT_OS_OS2)
if (m->updateReq != NIL_RTSEMEVENT)
{
RTSemEventDestroy(m->updateReq);
unconst(m->updateReq) = NIL_RTSEMEVENT;
}
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
if (m->updateReq != NIL_RTSEMEVENT)
{
RTSemEventDestroy(m->updateReq);
unconst(m->updateReq) = NIL_RTSEMEVENT;
}
#else
# error "Port me!"
#endif
// clean up our instance data
delete m;
/* Unload hard disk plugin backends. */
VDShutdown();
LogFlowThisFuncLeave();
LogFlow(("===========================================================\n"));
}
// IVirtualBox properties
/////////////////////////////////////////////////////////////////////////////
STDMETHODIMP VirtualBox::COMGETTER(Version)(BSTR *aVersion)
{
CheckComArgNotNull(aVersion);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
sVersion.cloneTo(aVersion);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(Revision)(ULONG *aRevision)
{
CheckComArgNotNull(aRevision);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
*aRevision = sRevision;
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(PackageType)(BSTR *aPackageType)
{
CheckComArgNotNull(aPackageType);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
sPackageType.cloneTo(aPackageType);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(HomeFolder)(BSTR *aHomeFolder)
{
CheckComArgNotNull(aHomeFolder);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* mHomeDir is const and doesn't need a lock */
m->strHomeDir.cloneTo(aHomeFolder);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(SettingsFilePath)(BSTR *aSettingsFilePath)
{
CheckComArgNotNull(aSettingsFilePath);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* mCfgFile.mName is const and doesn't need a lock */
m->strSettingsFilePath.cloneTo(aSettingsFilePath);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(Host)(IHost **aHost)
{
CheckComArgOutSafeArrayPointerValid(aHost);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* mHost is const, no need to lock */
m->pHost.queryInterfaceTo(aHost);
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(SystemProperties)(ISystemProperties **aSystemProperties)
{
CheckComArgOutSafeArrayPointerValid(aSystemProperties);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* mSystemProperties is const, no need to lock */
m->pSystemProperties.queryInterfaceTo(aSystemProperties);
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(Machines)(ComSafeArrayOut(IMachine *, aMachines))
{
if (ComSafeArrayOutIsNull(aMachines))
return E_POINTER;
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IMachine> machines(m->allMachines.getList());
machines.detachTo(ComSafeArrayOutArg(aMachines));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(HardDisks)(ComSafeArrayOut(IMedium *, aHardDisks))
{
if (ComSafeArrayOutIsNull(aHardDisks))
return E_POINTER;
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock al(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IMedium> hardDisks(m->allHardDisks.getList());
hardDisks.detachTo(ComSafeArrayOutArg(aHardDisks));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(DVDImages)(ComSafeArrayOut(IMedium *, aDVDImages))
{
if (ComSafeArrayOutIsNull(aDVDImages))
return E_POINTER;
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock al(m->allDVDImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IMedium> images(m->allDVDImages.getList());
images.detachTo(ComSafeArrayOutArg(aDVDImages));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(FloppyImages)(ComSafeArrayOut(IMedium *, aFloppyImages))
{
if (ComSafeArrayOutIsNull(aFloppyImages))
return E_POINTER;
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock al(m->allFloppyImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IMedium> images(m->allFloppyImages.getList());
images.detachTo(ComSafeArrayOutArg(aFloppyImages));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(ProgressOperations)(ComSafeArrayOut(IProgress *, aOperations))
{
CheckComArgOutSafeArrayPointerValid(aOperations);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* protect mProgressOperations */
AutoReadLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IProgress> progress(m->mapProgressOperations);
progress.detachTo(ComSafeArrayOutArg(aOperations));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(GuestOSTypes)(ComSafeArrayOut(IGuestOSType *, aGuestOSTypes))
{
CheckComArgOutSafeArrayPointerValid(aGuestOSTypes);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock al(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IGuestOSType> ostypes(m->allGuestOSTypes.getList());
ostypes.detachTo(ComSafeArrayOutArg(aGuestOSTypes));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(SharedFolders)(ComSafeArrayOut(ISharedFolder *, aSharedFolders))
{
#ifndef RT_OS_WINDOWS
NOREF(aSharedFoldersSize);
#endif /* RT_OS_WINDOWS */
CheckComArgOutSafeArrayPointerValid(aSharedFolders);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
return setError(E_NOTIMPL, "Not yet implemented");
}
STDMETHODIMP
VirtualBox::COMGETTER(PerformanceCollector)(IPerformanceCollector **aPerformanceCollector)
{
#ifdef VBOX_WITH_RESOURCE_USAGE_API
CheckComArgOutSafeArrayPointerValid(aPerformanceCollector);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* mPerformanceCollector is const, no need to lock */
m->pPerformanceCollector.queryInterfaceTo(aPerformanceCollector);
return S_OK;
#else /* !VBOX_WITH_RESOURCE_USAGE_API */
ReturnComNotImplemented();
#endif /* !VBOX_WITH_RESOURCE_USAGE_API */
}
STDMETHODIMP
VirtualBox::COMGETTER(DHCPServers)(ComSafeArrayOut(IDHCPServer *, aDHCPServers))
{
if (ComSafeArrayOutIsNull(aDHCPServers))
return E_POINTER;
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock al(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
SafeIfaceArray<IDHCPServer> svrs(m->allDHCPServers.getList());
svrs.detachTo(ComSafeArrayOutArg(aDHCPServers));
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(EventSource)(IEventSource ** aEventSource)
{
CheckComArgOutPointerValid(aEventSource);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* event source is const, no need to lock */
m->pEventSource.queryInterfaceTo(aEventSource);
return S_OK;
}
STDMETHODIMP
VirtualBox::CheckFirmwarePresent(FirmwareType_T aFirmwareType,
IN_BSTR aVersion,
BSTR *aUrl,
BSTR *aFile,
BOOL *aResult)
{
CheckComArgNotNull(aResult);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
const char * url = NULL;
NOREF(aVersion);
static const struct {
FirmwareType_T type;
const char* fileName;
const char* url;
} firmwareDesc[] = {
{
/* compiled-in firmware */
FirmwareType_BIOS, NULL, NULL
},
{
FirmwareType_EFI32, "VBoxEFI32.fd", "http://virtualbox.org/firmware/VBoxEFI32.fd"
},
{
FirmwareType_EFI64, "VBoxEFI64.fd", "http://virtualbox.org/firmware/VBoxEFI64.fd"
},
{
FirmwareType_EFIDUAL, "VBoxEFIDual.fd", "http://virtualbox.org/firmware/VBoxEFIDual.fd"
}
};
for (size_t i = 0; i < sizeof(firmwareDesc) / sizeof(firmwareDesc[0]); i++)
{
if (aFirmwareType != firmwareDesc[i].type)
continue;
/* compiled-in firmware */
if (firmwareDesc[i].fileName == NULL)
{
*aResult = TRUE;
break;
}
Utf8Str shortName, fullName;
int rc;
shortName = Utf8StrFmt("Firmware%c%s",
RTPATH_DELIMITER,
firmwareDesc[i].fileName);
rc = calculateFullPath(shortName, fullName); AssertRCReturn(rc, rc);
if (RTFileExists(fullName.raw()))
{
*aResult = TRUE;
if (aFile)
Utf8Str(fullName).cloneTo(aFile);
break;
}
char pszVBoxPath[RTPATH_MAX];
rc = RTPathExecDir(pszVBoxPath, RTPATH_MAX); AssertRCReturn(rc, rc);
fullName = Utf8StrFmt("%s%c%s",
pszVBoxPath,
RTPATH_DELIMITER,
firmwareDesc[i].fileName);
if (RTFileExists(fullName.raw()))
{
*aResult = TRUE;
if (aFile)
Utf8Str(fullName).cloneTo(aFile);
break;
}
url = firmwareDesc[i].url;
/** @todo: account for version in the URL */
if (aUrl != NULL)
Utf8Str(firmwareDesc[i].url).cloneTo(aUrl);
*aResult = FALSE;
/* Assume single record per firmware type */
break;
}
return S_OK;
}
// IVirtualBox methods
/////////////////////////////////////////////////////////////////////////////
/** @note Locks mSystemProperties object for reading. */
STDMETHODIMP VirtualBox::CreateMachine(IN_BSTR aName,
IN_BSTR aOsTypeId,
IN_BSTR aBaseFolder,
IN_BSTR aId,
BOOL aOverride,
IMachine **aMachine)
{
LogFlowThisFuncEnter();
LogFlowThisFunc(("aName=\"%ls\",aOsTypeId =\"%ls\",aBaseFolder=\"%ls\"\n", aName, aOsTypeId, aBaseFolder));
CheckComArgStrNotEmptyOrNull(aName);
/** @todo tighten checks on aId? */
CheckComArgOutPointerValid(aMachine);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* Compose the settings file name using the following scheme:
*
* <base_folder>/<machine_name>/<machine_name>.xml
*
* If a non-null and non-empty base folder is specified, the default
* machine folder will be used as a base folder.
*/
Utf8Str strSettingsFile = aBaseFolder;
if (strSettingsFile.isEmpty())
/* we use the non-full folder value below to keep the path relative */
strSettingsFile = getDefaultMachineFolder();
strSettingsFile = Utf8StrFmt("%s%c%ls%c%ls.xml",
strSettingsFile.raw(),
RTPATH_DELIMITER,
aName,
RTPATH_DELIMITER,
aName);
HRESULT rc = E_FAIL;
/* create a new object */
ComObjPtr<Machine> machine;
rc = machine.createObject();
if (FAILED(rc)) return rc;
/* Create UUID if an empty one was specified. */
Guid id(aId);
if (id.isEmpty())
id.create();
GuestOSType *osType = NULL;
rc = findGuestOSType(Bstr(aOsTypeId), osType);
if (FAILED(rc)) return rc;
/* initialize the machine object */
rc = machine->init(this,
strSettingsFile,
Utf8Str(aName),
id,
osType,
aOverride,
TRUE /* aNameSync */);
if (SUCCEEDED(rc))
{
/* set the return value */
rc = machine.queryInterfaceTo(aMachine);
AssertComRC(rc);
}
LogFlowThisFuncLeave();
return rc;
}
STDMETHODIMP VirtualBox::CreateLegacyMachine(IN_BSTR aName,
IN_BSTR aOsTypeId,
IN_BSTR aSettingsFile,
IN_BSTR aId,
IMachine **aMachine)
{
CheckComArgStrNotEmptyOrNull(aName);
CheckComArgStrNotEmptyOrNull(aSettingsFile);
/** @todo tighten checks on aId? */
CheckComArgOutPointerValid(aMachine);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc = E_FAIL;
Utf8Str settingsFile = aSettingsFile;
/* append the default extension if none */
if (!RTPathHaveExt(settingsFile.c_str()))
settingsFile = Utf8StrFmt("%s.xml", settingsFile.raw());
/* create a new object */
ComObjPtr<Machine> machine;
rc = machine.createObject();
if (FAILED(rc)) return rc;
/* Create UUID if an empty one was specified. */
Guid id(aId);
if (id.isEmpty())
id.create();
GuestOSType *osType = NULL;
rc = findGuestOSType(Bstr(aOsTypeId), osType);
if (FAILED(rc)) return rc;
/* initialize the machine object */
rc = machine->init(this,
settingsFile,
Utf8Str(aName),
id,
osType,
FALSE /* aOverride */,
FALSE /* aNameSync */);
if (SUCCEEDED(rc))
{
/* set the return value */
rc = machine.queryInterfaceTo(aMachine);
AssertComRC(rc);
}
return rc;
}
STDMETHODIMP VirtualBox::OpenMachine(IN_BSTR aSettingsFile,
IMachine **aMachine)
{
CheckComArgStrNotEmptyOrNull(aSettingsFile);
CheckComArgOutSafeArrayPointerValid(aMachine);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc = E_FAIL;
/* create a new object */
ComObjPtr<Machine> machine;
rc = machine.createObject();
if (SUCCEEDED(rc))
{
/* initialize the machine object */
rc = machine->init(this,
aSettingsFile,
NULL); /* const Guid *aId */
if (SUCCEEDED(rc))
{
/* set the return value */
rc = machine.queryInterfaceTo(aMachine);
ComAssertComRC(rc);
}
}
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::RegisterMachine(IMachine *aMachine)
{
CheckComArgNotNull(aMachine);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc;
Bstr name;
rc = aMachine->COMGETTER(Name)(name.asOutParam());
if (FAILED(rc)) return rc;
/* We can safely cast child to Machine * here because only Machine
* implementations of IMachine can be among our children. */
Machine *pMachine = static_cast<Machine*>(aMachine);
AutoCaller machCaller(pMachine);
ComAssertComRCRetRC(machCaller.rc());
rc = registerMachine(pMachine);
/* fire an event */
if (SUCCEEDED(rc))
onMachineRegistered(pMachine->getId(), TRUE);
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::GetMachine(IN_BSTR aId, IMachine **aMachine)
{
CheckComArgOutSafeArrayPointerValid(aMachine);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ComObjPtr<Machine> machine;
HRESULT rc = findMachine(Guid(aId),
true /* fPermitInaccessible */,
true /* setError */,
&machine);
/* the below will set *aMachine to NULL if machine is null */
machine.queryInterfaceTo(aMachine);
return rc;
}
/** @note Locks this object for reading, then some machine objects for reading. */
STDMETHODIMP VirtualBox::FindMachine(IN_BSTR aName, IMachine **aMachine)
{
LogFlowThisFuncEnter();
LogFlowThisFunc(("aName=\"%ls\", aMachine={%p}\n", aName, aMachine));
CheckComArgStrNotEmptyOrNull(aName);
CheckComArgOutSafeArrayPointerValid(aMachine);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* start with not found */
ComObjPtr<Machine> pMachineFound;
AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (MachinesOList::iterator it = m->allMachines.begin();
it != m->allMachines.end();
++it)
{
ComObjPtr<Machine> &pMachine2 = *it;
AutoCaller machCaller(pMachine2);
/* skip inaccessible machines */
if (FAILED(machCaller.rc()))
continue;
AutoReadLock machLock(pMachine2 COMMA_LOCKVAL_SRC_POS);
if (pMachine2->getName() == aName)
{
pMachineFound = pMachine2;
break;
}
}
/* this will set (*machine) to NULL if machineObj is null */
pMachineFound.queryInterfaceTo(aMachine);
HRESULT rc = pMachineFound
? S_OK
: setError(VBOX_E_OBJECT_NOT_FOUND,
tr("Could not find a registered machine named '%ls'"), aName);
LogFlowThisFunc(("aName=\"%ls\", aMachine=%p, rc=%08X\n", aName, *aMachine, rc));
LogFlowThisFuncLeave();
return rc;
}
STDMETHODIMP VirtualBox::CreateHardDisk(IN_BSTR aFormat,
IN_BSTR aLocation,
IMedium **aHardDisk)
{
CheckComArgOutPointerValid(aHardDisk);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* we don't access non-const data members so no need to lock */
Bstr format = aFormat;
if (format.isEmpty())
format = getDefaultHardDiskFormat();
HRESULT rc = E_FAIL;
bool fNeedsSaveSettings = false;
ComObjPtr<Medium> hardDisk;
hardDisk.createObject();
rc = hardDisk->init(this, format.raw(), aLocation, &fNeedsSaveSettings);
if (SUCCEEDED(rc))
hardDisk.queryInterfaceTo(aHardDisk);
if (fNeedsSaveSettings)
{
AutoWriteLock vboxlock(this COMMA_LOCKVAL_SRC_POS);
saveSettings();
}
return rc;
}
STDMETHODIMP VirtualBox::OpenHardDisk(IN_BSTR aLocation,
AccessMode_T accessMode,
BOOL aSetImageId,
IN_BSTR aImageId,
BOOL aSetParentId,
IN_BSTR aParentId,
IMedium **aHardDisk)
{
CheckComArgStrNotEmptyOrNull(aLocation);
CheckComArgOutSafeArrayPointerValid(aHardDisk);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* we don't access non-const data members so no need to lock */
HRESULT rc = E_FAIL;
ComObjPtr<Medium> hardDisk;
hardDisk.createObject();
Guid imageId, parentId;
if (aSetImageId)
{
imageId = Guid(aImageId);
if (imageId.isEmpty())
return setError(E_INVALIDARG, tr("Argument %s is empty"), "aImageId");
}
if (aSetParentId)
parentId = Guid(aParentId);
rc = hardDisk->init(this,
aLocation,
(accessMode == AccessMode_ReadWrite) ? Medium::OpenReadWrite : Medium::OpenReadOnly,
DeviceType_HardDisk,
aSetImageId,
imageId,
aSetParentId,
parentId);
if (SUCCEEDED(rc))
{
bool fNeedsSaveSettings = false;
{
AutoWriteLock treeLock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
rc = registerHardDisk(hardDisk, &fNeedsSaveSettings);
}
/* Note that it's important to call uninit() on failure to register
* because the differencing hard disk would have been already associated
* with the parent and this association needs to be broken. */
if (SUCCEEDED(rc))
hardDisk.queryInterfaceTo(aHardDisk);
else
hardDisk->uninit();
if (fNeedsSaveSettings)
{
AutoWriteLock vboxlock(this COMMA_LOCKVAL_SRC_POS);
saveSettings();
}
}
return rc;
}
STDMETHODIMP VirtualBox::GetHardDisk(IN_BSTR aId,
IMedium **aHardDisk)
{
CheckComArgOutSafeArrayPointerValid(aHardDisk);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
Guid id(aId);
ComObjPtr<Medium> hardDisk;
HRESULT rc = findHardDisk(&id, NULL, true /* setError */, &hardDisk);
/* the below will set *aHardDisk to NULL if hardDisk is null */
hardDisk.queryInterfaceTo(aHardDisk);
return rc;
}
STDMETHODIMP VirtualBox::FindHardDisk(IN_BSTR aLocation,
IMedium **aHardDisk)
{
CheckComArgStrNotEmptyOrNull(aLocation);
CheckComArgOutSafeArrayPointerValid(aHardDisk);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ComObjPtr<Medium> hardDisk;
HRESULT rc = findHardDisk(NULL, aLocation, true /* setError */, &hardDisk);
/* the below will set *aHardDisk to NULL if hardDisk is null */
hardDisk.queryInterfaceTo(aHardDisk);
return rc;
}
/** @note Doesn't lock anything. */
STDMETHODIMP VirtualBox::OpenDVDImage(IN_BSTR aLocation, IN_BSTR aId,
IMedium **aDVDImage)
{
CheckComArgStrNotEmptyOrNull(aLocation);
CheckComArgOutSafeArrayPointerValid(aDVDImage);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc = VBOX_E_FILE_ERROR;
Guid id(aId);
/* generate an UUID if not specified */
if (id.isEmpty())
id.create();
ComObjPtr<Medium> image;
image.createObject();
rc = image->init(this, aLocation, Medium::OpenReadOnly, DeviceType_DVD, true, id, false, Guid());
if (SUCCEEDED(rc))
{
AutoWriteLock treeLock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
bool fNeedsSaveSettings = false;
rc = registerImage(image, DeviceType_DVD, &fNeedsSaveSettings);
treeLock.release();
if (SUCCEEDED(rc))
image.queryInterfaceTo(aDVDImage);
if (fNeedsSaveSettings)
{
AutoWriteLock vboxlock(this COMMA_LOCKVAL_SRC_POS);
saveSettings();
}
}
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::GetDVDImage(IN_BSTR aId, IMedium **aDVDImage)
{
CheckComArgOutSafeArrayPointerValid(aDVDImage);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
Guid id(aId);
ComObjPtr<Medium> image;
HRESULT rc = findDVDImage(&id, NULL, true /* setError */, &image);
/* the below will set *aDVDImage to NULL if image is null */
image.queryInterfaceTo(aDVDImage);
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::FindDVDImage(IN_BSTR aLocation, IMedium **aDVDImage)
{
CheckComArgStrNotEmptyOrNull(aLocation);
CheckComArgOutSafeArrayPointerValid(aDVDImage);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ComObjPtr<Medium> image;
HRESULT rc = findDVDImage(NULL, aLocation, true /* setError */, &image);
/* the below will set *aDVDImage to NULL if dvd is null */
image.queryInterfaceTo(aDVDImage);
return rc;
}
/** @note Doesn't lock anything. */
STDMETHODIMP VirtualBox::OpenFloppyImage(IN_BSTR aLocation, IN_BSTR aId,
IMedium **aFloppyImage)
{
CheckComArgStrNotEmptyOrNull(aLocation);
CheckComArgOutSafeArrayPointerValid(aFloppyImage);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc = VBOX_E_FILE_ERROR;
Guid id(aId);
/* generate an UUID if not specified */
if (id.isEmpty())
id.create();
ComObjPtr<Medium> image;
image.createObject();
rc = image->init(this, aLocation, Medium::OpenReadWrite, DeviceType_Floppy, true, id, false, Guid());
if (SUCCEEDED(rc))
{
AutoWriteLock treeLock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
bool fNeedsSaveSettings = false;
rc = registerImage(image, DeviceType_Floppy, &fNeedsSaveSettings);
treeLock.release();
if (SUCCEEDED(rc))
image.queryInterfaceTo(aFloppyImage);
if (fNeedsSaveSettings)
{
AutoWriteLock vboxlock(this COMMA_LOCKVAL_SRC_POS);
saveSettings();
}
}
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::GetFloppyImage(IN_BSTR aId, IMedium **aFloppyImage)
{
CheckComArgOutSafeArrayPointerValid(aFloppyImage);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
Guid id(aId);
ComObjPtr<Medium> image;
HRESULT rc = findFloppyImage(&id, NULL, true /* setError */, &image);
/* the below will set *aFloppyImage to NULL if image is null */
image.queryInterfaceTo(aFloppyImage);
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::FindFloppyImage(IN_BSTR aLocation,
IMedium **aFloppyImage)
{
CheckComArgStrNotEmptyOrNull(aLocation);
CheckComArgOutSafeArrayPointerValid(aFloppyImage);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ComObjPtr<Medium> image;
HRESULT rc = findFloppyImage(NULL, aLocation, true /* setError */, &image);
/* the below will set *aFloppyImage to NULL if img is null */
image.queryInterfaceTo(aFloppyImage);
return rc;
}
/** @note Locks this object for reading. */
STDMETHODIMP VirtualBox::GetGuestOSType(IN_BSTR aId, IGuestOSType **aType)
{
/* Old ID to new ID conversion table. See r39691 for a source */
static const wchar_t *kOldNewIDs[] =
{
L"unknown", L"Other",
L"win31", L"Windows31",
L"win95", L"Windows95",
L"win98", L"Windows98",
L"winme", L"WindowsMe",
L"winnt4", L"WindowsNT4",
L"win2k", L"Windows2000",
L"winxp", L"WindowsXP",
L"win2k3", L"Windows2003",
L"winvista", L"WindowsVista",
L"win2k8", L"Windows2008",
L"ecs", L"OS2eCS",
L"fedoracore", L"Fedora",
/* the rest is covered by the case-insensitive comparison */
};
CheckComArgNotNull(aType);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* first, look for a substitution */
Bstr id = aId;
for (size_t i = 0; i < RT_ELEMENTS(kOldNewIDs) / 2; i += 2)
{
if (id == kOldNewIDs[i])
{
id = kOldNewIDs[i + 1];
break;
}
}
*aType = NULL;
AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (GuestOSTypesOList::iterator it = m->allGuestOSTypes.begin();
it != m->allGuestOSTypes.end();
++it)
{
const Bstr &typeId = (*it)->id();
AssertMsg(!typeId.isEmpty(), ("ID must not be NULL"));
if (typeId.compare(id, Bstr::CaseInsensitive) == 0)
{
(*it).queryInterfaceTo(aType);
break;
}
}
return (*aType) ? S_OK :
setError(E_INVALIDARG,
tr("'%ls' is not a valid Guest OS type"),
aId);
}
STDMETHODIMP VirtualBox::CreateSharedFolder(IN_BSTR aName, IN_BSTR aHostPath,
BOOL /* aWritable */, BOOL /* aAutoMount */)
{
CheckComArgStrNotEmptyOrNull(aName);
CheckComArgStrNotEmptyOrNull(aHostPath);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
return setError(E_NOTIMPL, "Not yet implemented");
}
STDMETHODIMP VirtualBox::RemoveSharedFolder(IN_BSTR aName)
{
CheckComArgStrNotEmptyOrNull(aName);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
return setError(E_NOTIMPL, "Not yet implemented");
}
/**
* @note Locks this object for reading.
*/
STDMETHODIMP VirtualBox::GetExtraDataKeys(ComSafeArrayOut(BSTR, aKeys))
{
using namespace settings;
if (ComSafeArrayOutIsNull(aKeys))
return E_POINTER;
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
com::SafeArray<BSTR> saKeys(m->pMainConfigFile->mapExtraDataItems.size());
int i = 0;
for (ExtraDataItemsMap::const_iterator it = m->pMainConfigFile->mapExtraDataItems.begin();
it != m->pMainConfigFile->mapExtraDataItems.end();
++it, ++i)
{
const Utf8Str &strName = it->first; // the key
strName.cloneTo(&saKeys[i]);
}
saKeys.detachTo(ComSafeArrayOutArg(aKeys));
return S_OK;
}
/**
* @note Locks this object for reading.
*/
STDMETHODIMP VirtualBox::GetExtraData(IN_BSTR aKey,
BSTR *aValue)
{
CheckComArgStrNotEmptyOrNull(aKey);
CheckComArgNotNull(aValue);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* start with nothing found */
Utf8Str strKey(aKey);
Bstr bstrResult;
settings::ExtraDataItemsMap::const_iterator it = m->pMainConfigFile->mapExtraDataItems.find(strKey);
if (it != m->pMainConfigFile->mapExtraDataItems.end())
// found:
bstrResult = it->second; // source is a Utf8Str
/* return the result to caller (may be empty) */
bstrResult.cloneTo(aValue);
return S_OK;
}
/**
* @note Locks this object for writing.
*/
STDMETHODIMP VirtualBox::SetExtraData(IN_BSTR aKey,
IN_BSTR aValue)
{
CheckComArgStrNotEmptyOrNull(aKey);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
Utf8Str strKey(aKey);
Utf8Str strValue(aValue);
Utf8Str strOldValue; // empty
// locking note: we only hold the read lock briefly to look up the old value,
// then release it and call the onExtraCanChange callbacks. There is a small
// chance of a race insofar as the callback might be called twice if two callers
// change the same key at the same time, but that's a much better solution
// than the deadlock we had here before. The actual changing of the extradata
// is then performed under the write lock and race-free.
// look up the old value first; if nothing's changed then we need not do anything
{
AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS); // hold read lock only while looking up
settings::ExtraDataItemsMap::const_iterator it = m->pMainConfigFile->mapExtraDataItems.find(strKey);
if (it != m->pMainConfigFile->mapExtraDataItems.end())
strOldValue = it->second;
}
bool fChanged;
if ((fChanged = (strOldValue != strValue)))
{
// ask for permission from all listeners outside the locks;
// onExtraDataCanChange() only briefly requests the VirtualBox
// lock to copy the list of callbacks to invoke
Bstr error;
Bstr bstrValue(aValue);
if (!onExtraDataCanChange(Guid::Empty, aKey, bstrValue, error))
{
const char *sep = error.isEmpty() ? "" : ": ";
CBSTR err = error.raw();
LogWarningFunc(("Someone vetoed! Change refused%s%ls\n",
sep, err));
return setError(E_ACCESSDENIED,
tr("Could not set extra data because someone refused the requested change of '%ls' to '%ls'%s%ls"),
aKey,
bstrValue.raw(),
sep,
err);
}
// data is changing and change not vetoed: then write it out under the lock
AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
if (strValue.isEmpty())
m->pMainConfigFile->mapExtraDataItems.erase(strKey);
else
m->pMainConfigFile->mapExtraDataItems[strKey] = strValue;
// creates a new key if needed
/* save settings on success */
HRESULT rc = saveSettings();
if (FAILED(rc)) return rc;
}
// fire notification outside the lock
if (fChanged)
onExtraDataChange(Guid::Empty, aKey, aValue);
return S_OK;
}
STDMETHODIMP VirtualBox::WaitForPropertyChange(IN_BSTR /* aWhat */,
ULONG /* aTimeout */,
BSTR * /* aChanged */,
BSTR * /* aValues */)
{
ReturnComNotImplemented();
}
// public methods only for internal purposes
/////////////////////////////////////////////////////////////////////////////
#ifdef DEBUG
void VirtualBox::dumpAllBackRefs()
{
{
AutoReadLock al(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (MediaList::const_iterator mt = m->allHardDisks.begin();
mt != m->allHardDisks.end();
++mt)
{
ComObjPtr<Medium> pMedium = *mt;
pMedium->dumpBackRefs();
}
}
{
AutoReadLock al(m->allDVDImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (MediaList::const_iterator mt = m->allDVDImages.begin();
mt != m->allDVDImages.end();
++mt)
{
ComObjPtr<Medium> pMedium = *mt;
pMedium->dumpBackRefs();
}
}
}
#endif
/**
* Posts an event to the event queue that is processed asynchronously
* on a dedicated thread.
*
* Posting events to the dedicated event queue is useful to perform secondary
* actions outside any object locks -- for example, to iterate over a list
* of callbacks and inform them about some change caused by some object's
* method call.
*
* @param event event to post
* (must be allocated using |new|, will be deleted automatically
* by the event thread after processing)
*
* @note Doesn't lock any object.
*/
HRESULT VirtualBox::postEvent(Event *event)
{
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
if (autoCaller.state() != Ready)
{
LogWarningFunc(("VirtualBox has been uninitialized (state=%d), the event is discarded!\n",
autoCaller.state()));
return S_OK;
}
AssertReturn(event, E_FAIL);
AssertReturn(m->pAsyncEventQ, E_FAIL);
if (m->pAsyncEventQ->postEvent(event))
return S_OK;
return E_FAIL;
}
/**
* Adds a progress to the global collection of pending operations.
* Usually gets called upon progress object initialization.
*
* @param aProgress Operation to add to the collection.
*
* @note Doesn't lock objects.
*/
HRESULT VirtualBox::addProgress(IProgress *aProgress)
{
CheckComArgNotNull(aProgress);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
Bstr id;
HRESULT rc = aProgress->COMGETTER(Id)(id.asOutParam());
AssertComRCReturnRC(rc);
/* protect mProgressOperations */
AutoWriteLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
m->mapProgressOperations.insert(ProgressMap::value_type(Guid(id), aProgress));
return S_OK;
}
/**
* Removes the progress from the global collection of pending operations.
* Usually gets called upon progress completion.
*
* @param aId UUID of the progress operation to remove
*
* @note Doesn't lock objects.
*/
HRESULT VirtualBox::removeProgress(IN_GUID aId)
{
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ComPtr<IProgress> progress;
/* protect mProgressOperations */
AutoWriteLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
size_t cnt = m->mapProgressOperations.erase(aId);
Assert(cnt == 1);
NOREF(cnt);
return S_OK;
}
#ifdef RT_OS_WINDOWS
struct StartSVCHelperClientData
{
ComObjPtr<VirtualBox> that;
ComObjPtr<Progress> progress;
bool privileged;
VirtualBox::SVCHelperClientFunc func;
void *user;
};
/**
* Helper method that starts a worker thread that:
* - creates a pipe communication channel using SVCHlpClient;
* - starts an SVC Helper process that will inherit this channel;
* - executes the supplied function by passing it the created SVCHlpClient
* and opened instance to communicate to the Helper process and the given
* Progress object.
*
* The user function is supposed to communicate to the helper process
* using the \a aClient argument to do the requested job and optionally expose
* the progress through the \a aProgress object. The user function should never
* call notifyComplete() on it: this will be done automatically using the
* result code returned by the function.
*
* Before the user function is started, the communication channel passed to
* the \a aClient argument is fully set up, the function should start using
* its write() and read() methods directly.
*
* The \a aVrc parameter of the user function may be used to return an error
* code if it is related to communication errors (for example, returned by
* the SVCHlpClient members when they fail). In this case, the correct error
* message using this value will be reported to the caller. Note that the
* value of \a aVrc is inspected only if the user function itself returns
* success.
*
* If a failure happens anywhere before the user function would be normally
* called, it will be called anyway in special "cleanup only" mode indicated
* by \a aClient, \a aProgress and \aVrc arguments set to NULL. In this mode,
* all the function is supposed to do is to cleanup its aUser argument if
* necessary (it's assumed that the ownership of this argument is passed to
* the user function once #startSVCHelperClient() returns a success, thus
* making it responsible for the cleanup).
*
* After the user function returns, the thread will send the SVCHlpMsg::Null
* message to indicate a process termination.
*
* @param aPrivileged |true| to start the SVC Helper process as a privileged
* user that can perform administrative tasks
* @param aFunc user function to run
* @param aUser argument to the user function
* @param aProgress progress object that will track operation completion
*
* @note aPrivileged is currently ignored (due to some unsolved problems in
* Vista) and the process will be started as a normal (unprivileged)
* process.
*
* @note Doesn't lock anything.
*/
HRESULT VirtualBox::startSVCHelperClient(bool aPrivileged,
SVCHelperClientFunc aFunc,
void *aUser, Progress *aProgress)
{
AssertReturn(aFunc, E_POINTER);
AssertReturn(aProgress, E_POINTER);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
/* create the SVCHelperClientThread() argument */
std::auto_ptr <StartSVCHelperClientData>
d(new StartSVCHelperClientData());
AssertReturn(d.get(), E_OUTOFMEMORY);
d->that = this;
d->progress = aProgress;
d->privileged = aPrivileged;
d->func = aFunc;
d->user = aUser;
RTTHREAD tid = NIL_RTTHREAD;
int vrc = RTThreadCreate(&tid, SVCHelperClientThread,
static_cast <void *>(d.get()),
0, RTTHREADTYPE_MAIN_WORKER,
RTTHREADFLAGS_WAITABLE, "SVCHelper");
if (RT_FAILURE(vrc))
return setError(E_FAIL, "Could not create SVCHelper thread (%Rrc)", vrc);
/* d is now owned by SVCHelperClientThread(), so release it */
d.release();
return S_OK;
}
/**
* Worker thread for startSVCHelperClient().
*/
/* static */
DECLCALLBACK(int)
VirtualBox::SVCHelperClientThread(RTTHREAD aThread, void *aUser)
{
LogFlowFuncEnter();
std::auto_ptr<StartSVCHelperClientData>
d(static_cast<StartSVCHelperClientData*>(aUser));
HRESULT rc = S_OK;
bool userFuncCalled = false;
do
{
AssertBreakStmt(d.get(), rc = E_POINTER);
AssertReturn(!d->progress.isNull(), E_POINTER);
/* protect VirtualBox from uninitialization */
AutoCaller autoCaller(d->that);
if (!autoCaller.isOk())
{
/* it's too late */
rc = autoCaller.rc();
break;
}
int vrc = VINF_SUCCESS;
Guid id;
id.create();
SVCHlpClient client;
vrc = client.create(Utf8StrFmt("VirtualBox\\SVCHelper\\{%RTuuid}",
id.raw()).c_str());
if (RT_FAILURE(vrc))
{
rc = d->that->setError(E_FAIL,
tr("Could not create the communication channel (%Rrc)"), vrc);
break;
}
/* get the path to the executable */
char exePathBuf[RTPATH_MAX];
char *exePath = RTProcGetExecutableName(exePathBuf, RTPATH_MAX);
if (!exePath)
{
rc = d->that->setError(E_FAIL, tr("Cannot get executable name"));
break;
}
Utf8Str argsStr = Utf8StrFmt("/Helper %s", client.name().raw());
LogFlowFunc(("Starting '\"%s\" %s'...\n", exePath, argsStr.raw()));
RTPROCESS pid = NIL_RTPROCESS;
if (d->privileged)
{
/* Attempt to start a privileged process using the Run As dialog */
Bstr file = exePath;
Bstr parameters = argsStr;
SHELLEXECUTEINFO shExecInfo;
shExecInfo.cbSize = sizeof(SHELLEXECUTEINFO);
shExecInfo.fMask = NULL;
shExecInfo.hwnd = NULL;
shExecInfo.lpVerb = L"runas";
shExecInfo.lpFile = file;
shExecInfo.lpParameters = parameters;
shExecInfo.lpDirectory = NULL;
shExecInfo.nShow = SW_NORMAL;
shExecInfo.hInstApp = NULL;
if (!ShellExecuteEx(&shExecInfo))
{
int vrc2 = RTErrConvertFromWin32(GetLastError());
/* hide excessive details in case of a frequent error
* (pressing the Cancel button to close the Run As dialog) */
if (vrc2 == VERR_CANCELLED)
rc = d->that->setError(E_FAIL,
tr("Operation canceled by the user"));
else
rc = d->that->setError(E_FAIL,
tr("Could not launch a privileged process '%s' (%Rrc)"),
exePath, vrc2);
break;
}
}
else
{
const char *args[] = { exePath, "/Helper", client.name().c_str(), 0 };
vrc = RTProcCreate(exePath, args, RTENV_DEFAULT, 0, &pid);
if (RT_FAILURE(vrc))
{
rc = d->that->setError(E_FAIL,
tr("Could not launch a process '%s' (%Rrc)"), exePath, vrc);
break;
}
}
/* wait for the client to connect */
vrc = client.connect();
if (RT_SUCCESS(vrc))
{
/* start the user supplied function */
rc = d->func(&client, d->progress, d->user, &vrc);
userFuncCalled = true;
}
/* send the termination signal to the process anyway */
{
int vrc2 = client.write(SVCHlpMsg::Null);
if (RT_SUCCESS(vrc))
vrc = vrc2;
}
if (SUCCEEDED(rc) && RT_FAILURE(vrc))
{
rc = d->that->setError(E_FAIL,
tr("Could not operate the communication channel (%Rrc)"), vrc);
break;
}
}
while (0);
if (FAILED(rc) && !userFuncCalled)
{
/* call the user function in the "cleanup only" mode
* to let it free resources passed to in aUser */
d->func(NULL, NULL, d->user, NULL);
}
d->progress->notifyComplete(rc);
LogFlowFuncLeave();
return 0;
}
#endif /* RT_OS_WINDOWS */
/**
* Sends a signal to the client watcher thread to rescan the set of machines
* that have open sessions.
*
* @note Doesn't lock anything.
*/
void VirtualBox::updateClientWatcher()
{
AutoCaller autoCaller(this);
AssertComRCReturnVoid(autoCaller.rc());
AssertReturnVoid(m->threadClientWatcher != NIL_RTTHREAD);
/* sent an update request */
#if defined(RT_OS_WINDOWS)
::SetEvent(m->updateReq);
#elif defined(RT_OS_OS2)
RTSemEventSignal(m->updateReq);
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
RTSemEventSignal(m->updateReq);
#else
# error "Port me!"
#endif
}
/**
* Adds the given child process ID to the list of processes to be reaped.
* This call should be followed by #updateClientWatcher() to take the effect.
*/
void VirtualBox::addProcessToReap(RTPROCESS pid)
{
AutoCaller autoCaller(this);
AssertComRCReturnVoid(autoCaller.rc());
/// @todo (dmik) Win32?
#ifndef RT_OS_WINDOWS
AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
m->llProcesses.push_back(pid);
#endif
}
/** Event for onMachineStateChange(), onMachineDataChange(), onMachineRegistered() */
struct MachineEvent : public VirtualBox::CallbackEvent
{
MachineEvent(VirtualBox *aVB, const Guid &aId)
: CallbackEvent(aVB, VirtualBoxCallbackRegistration::kOnMachineDataChanged), id(aId.toUtf16())
{}
MachineEvent(VirtualBox *aVB, const Guid &aId, MachineState_T aState)
: CallbackEvent(aVB, VirtualBoxCallbackRegistration::kOnMachineStateChanged), id(aId.toUtf16())
, state(aState)
{}
MachineEvent(VirtualBox *aVB, const Guid &aId, BOOL aRegistered)
: CallbackEvent(aVB, VirtualBoxCallbackRegistration::kOnMachineRegistered), id(aId.toUtf16())
, registered(aRegistered)
{}
virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
{
switch (mWhat)
{
case VirtualBoxCallbackRegistration::kOnMachineDataChanged:
aEvDesc.init(aSource, VBoxEventType_OnMachineDataChanged, id.raw());
break;
case VirtualBoxCallbackRegistration::kOnMachineStateChanged:
aEvDesc.init(aSource, VBoxEventType_OnMachineStateChanged, id.raw(), state);
break;
case VirtualBoxCallbackRegistration::kOnMachineRegistered:
aEvDesc.init(aSource, VBoxEventType_OnMachineRegistered, id.raw(), registered);
break;
default:
AssertFailedReturn(S_OK);
}
return S_OK;
}
Bstr id;
MachineState_T state;
BOOL registered;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onMachineStateChange(const Guid &aId, MachineState_T aState)
{
postEvent(new MachineEvent(this, aId, aState));
}
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onMachineDataChange(const Guid &aId)
{
postEvent(new MachineEvent(this, aId));
}
/**
* @note Locks this object for reading.
*/
BOOL VirtualBox::onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
Bstr &aError)
{
LogFlowThisFunc(("machine={%s} aKey={%ls} aValue={%ls}\n",
aId.toString().raw(), aKey, aValue));
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
BOOL allowChange = TRUE;
Bstr id = aId.toUtf16();
VBoxEventDesc evDesc;
evDesc.init(m->pEventSource, VBoxEventType_OnExtraDataCanChange, id.raw(), aKey, aValue);
BOOL fDelivered = evDesc.fire(3000); /* Wait up to 3 secs for delivery */
//Assert(fDelivered);
if (fDelivered)
{
ComPtr<IEvent> aEvent;
evDesc.getEvent(aEvent.asOutParam());
ComPtr<IExtraDataCanChangeEvent> aCanChangeEvent = aEvent;
Assert(aCanChangeEvent);
BOOL fVetoed = FALSE;
aCanChangeEvent->IsVetoed(&fVetoed);
allowChange = !fVetoed;
if (!allowChange)
{
SafeArray<BSTR> aVetos;
aCanChangeEvent->GetVetos(ComSafeArrayAsOutParam(aVetos));
if (aVetos.size() > 0)
aError = aVetos[0];
}
}
else
allowChange = TRUE;
LogFlowThisFunc(("allowChange=%RTbool\n", allowChange));
return allowChange;
}
/** Event for onExtraDataChange() */
struct ExtraDataEvent : public VirtualBox::CallbackEvent
{
ExtraDataEvent(VirtualBox *aVB, const Guid &aMachineId,
IN_BSTR aKey, IN_BSTR aVal)
: CallbackEvent(aVB, VirtualBoxCallbackRegistration::kOnExtraDataChanged)
, machineId(aMachineId.toUtf16()), key(aKey), val(aVal)
{}
virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
{
return aEvDesc.init(aSource, VBoxEventType_OnExtraDataChanged, machineId.raw(), key.raw(), val.raw());
}
Bstr machineId, key, val;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue)
{
postEvent(new ExtraDataEvent(this, aId, aKey, aValue));
}
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onMachineRegistered(const Guid &aId, BOOL aRegistered)
{
postEvent(new MachineEvent(this, aId, aRegistered));
}
/** Event for onSessionStateChange() */
struct SessionEvent : public VirtualBox::CallbackEvent
{
SessionEvent(VirtualBox *aVB, const Guid &aMachineId, SessionState_T aState)
: CallbackEvent(aVB, VirtualBoxCallbackRegistration::kOnSessionStateChanged)
, machineId(aMachineId.toUtf16()), sessionState(aState)
{}
virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
{
return aEvDesc.init(aSource, VBoxEventType_OnSessionStateChanged, machineId.raw(), sessionState);
}
Bstr machineId;
SessionState_T sessionState;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onSessionStateChange(const Guid &aId, SessionState_T aState)
{
postEvent(new SessionEvent(this, aId, aState));
}
/** Event for onSnapshotTaken(), onSnapshotDeleted() and onSnapshotChange() */
struct SnapshotEvent : public VirtualBox::CallbackEvent
{
SnapshotEvent(VirtualBox *aVB, const Guid &aMachineId, const Guid &aSnapshotId,
VirtualBoxCallbackRegistration::CallbackBit aWhat)
: CallbackEvent(aVB, aWhat)
, machineId(aMachineId), snapshotId(aSnapshotId)
{}
virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
{
return aEvDesc.init(aSource, VBoxEventType_OnSnapshotTaken,
machineId.toUtf16().raw(), snapshotId.toUtf16().raw());
}
Guid machineId;
Guid snapshotId;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId)
{
postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
VirtualBoxCallbackRegistration::kOnSnapshotTaken));
}
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId)
{
postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
VirtualBoxCallbackRegistration::kOnSnapshotDeleted));
}
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId)
{
postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
VirtualBoxCallbackRegistration::kOnSnapshotChanged));
}
/** Event for onGuestPropertyChange() */
struct GuestPropertyEvent : public VirtualBox::CallbackEvent
{
GuestPropertyEvent(VirtualBox *aVBox, const Guid &aMachineId,
IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
: CallbackEvent(aVBox, VirtualBoxCallbackRegistration::kOnGuestPropertyChanged),
machineId(aMachineId),
name(aName),
value(aValue),
flags(aFlags)
{}
virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
{
return aEvDesc.init(aSource, VBoxEventType_OnGuestPropertyChanged,
machineId.toUtf16().raw(), name.raw(), value.raw(), flags.raw());
}
Guid machineId;
Bstr name, value, flags;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName,
IN_BSTR aValue, IN_BSTR aFlags)
{
postEvent(new GuestPropertyEvent(this, aMachineId, aName, aValue, aFlags));
}
/** Event for onMachineUninit(), this is not a CallbackEvent */
class MachineUninitEvent : public Event
{
public:
MachineUninitEvent(VirtualBox *aVirtualBox, Machine *aMachine)
: mVirtualBox(aVirtualBox), mMachine(aMachine)
{
Assert(aVirtualBox);
Assert(aMachine);
}
void *handler()
{
#ifdef VBOX_WITH_RESOURCE_USAGE_API
/* Handle unregistering metrics here, as it is not vital to get
* it done immediately. It reduces the number of locks needed and
* the lock contention in SessionMachine::uninit. */
{
AutoWriteLock mLock(mMachine COMMA_LOCKVAL_SRC_POS);
mMachine->unregisterMetrics(mVirtualBox->performanceCollector(), mMachine);
}
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
return NULL;
}
private:
/**
* Note that this is a weak ref -- the CallbackEvent handler thread
* is bound to the lifetime of the VirtualBox instance, so it's safe.
*/
VirtualBox *mVirtualBox;
/** Reference to the machine object. */
ComObjPtr<Machine> mMachine;
};
/**
* Trigger internal event. This isn't meant to be signalled to clients.
* @note Doesn't lock any object.
*/
void VirtualBox::onMachineUninit(Machine *aMachine)
{
postEvent(new MachineUninitEvent(this, aMachine));
}
/**
* @note Locks this object for reading.
*/
ComObjPtr<GuestOSType> VirtualBox::getUnknownOSType()
{
ComObjPtr<GuestOSType> type;
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), type);
/* unknown type must always be the first */
ComAssertRet(m->allGuestOSTypes.size() > 0, type);
return m->allGuestOSTypes.front();
}
/**
* Returns the list of opened machines (machines having direct sessions opened
* by client processes) and optionally the list of direct session controls.
*
* @param aMachines Where to put opened machines (will be empty if none).
* @param aControls Where to put direct session controls (optional).
*
* @note The returned lists contain smart pointers. So, clear it as soon as
* it becomes no more necessary to release instances.
*
* @note It can be possible that a session machine from the list has been
* already uninitialized, so do a usual AutoCaller/AutoReadLock sequence
* when accessing unprotected data directly.
*
* @note Locks objects for reading.
*/
void VirtualBox::getOpenedMachines(SessionMachinesList &aMachines,
InternalControlList *aControls /*= NULL*/)
{
AutoCaller autoCaller(this);
AssertComRCReturnVoid(autoCaller.rc());
aMachines.clear();
if (aControls)
aControls->clear();
AutoReadLock alock(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (MachinesOList::iterator it = m->allMachines.begin();
it != m->allMachines.end();
++it)
{
ComObjPtr<SessionMachine> sm;
ComPtr<IInternalSessionControl> ctl;
if ((*it)->isSessionOpen(sm, &ctl))
{
aMachines.push_back(sm);
if (aControls)
aControls->push_back(ctl);
}
}
}
/**
* Searches for a machine object with the given ID in the collection
* of registered machines.
*
* @param aId Machine UUID to look for.
* @param aPermitInaccessible If true, inaccessible machines will be found;
* if false, this will fail if the given machine is inaccessible.
* @param aSetError If true, set errorinfo if the machine is not found.
* @param aMachine Returned machine, if found.
* @return
*/
HRESULT VirtualBox::findMachine(const Guid &aId,
bool fPermitInaccessible,
bool aSetError,
ComObjPtr<Machine> *aMachine /* = NULL */)
{
HRESULT rc = VBOX_E_OBJECT_NOT_FOUND;
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
{
AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (MachinesOList::iterator it = m->allMachines.begin();
it != m->allMachines.end();
++it)
{
ComObjPtr<Machine> pMachine2 = *it;
if (!fPermitInaccessible)
{
// skip inaccessible machines
AutoCaller machCaller(pMachine2);
if (FAILED(machCaller.rc()))
continue;
}
if (pMachine2->getId() == aId)
{
rc = S_OK;
if (aMachine)
*aMachine = pMachine2;
break;
}
}
}
if (aSetError && FAILED(rc))
rc = setError(rc,
tr("Could not find a registered machine with UUID {%RTuuid}"),
aId.raw());
return rc;
}
/**
* Searches for a Medium object with the given ID or location in the list of
* registered hard disks. If both ID and location are specified, the first
* object that matches either of them (not necessarily both) is returned.
*
* @param aId ID of the hard disk (unused when NULL).
* @param aLocation Full location specification (unused NULL).
* @param aSetError If @c true , the appropriate error info is set in case
* when the hard disk is not found.
* @param aHardDisk Where to store the found hard disk object (can be NULL).
*
* @return S_OK when found or E_INVALIDARG when not found.
*
* @note Locks the media tree for reading.
*/
HRESULT VirtualBox::findHardDisk(const Guid *aId,
CBSTR aLocation,
bool aSetError,
ComObjPtr<Medium> *aHardDisk /*= NULL*/)
{
AssertReturn(aId || aLocation, E_INVALIDARG);
// we use the hard disks map, but it is protected by the
// hard disk _list_ lock handle
AutoReadLock alock(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
/* first, look up by UUID in the map if UUID is provided */
if (aId)
{
HardDiskMap::const_iterator it = m->mapHardDisks.find(*aId);
if (it != m->mapHardDisks.end())
{
if (aHardDisk)
*aHardDisk = (*it).second;
return S_OK;
}
}
/* then iterate and search by location */
int result = -1;
if (aLocation)
{
Utf8Str location = aLocation;
for (HardDiskMap::const_iterator it = m->mapHardDisks.begin();
it != m->mapHardDisks.end();
++ it)
{
const ComObjPtr<Medium> &hd = (*it).second;
HRESULT rc = hd->compareLocationTo(location.c_str(), result);
if (FAILED(rc)) return rc;
if (result == 0)
{
if (aHardDisk)
*aHardDisk = hd;
break;
}
}
}
HRESULT rc = result == 0 ? S_OK : VBOX_E_OBJECT_NOT_FOUND;
if (aSetError && result != 0)
{
if (aId)
setError(rc,
tr("Could not find a hard disk with UUID {%RTuuid} in the media registry ('%s')"),
aId->raw(),
m->strSettingsFilePath.raw());
else
setError(rc,
tr("Could not find a hard disk with location '%ls' in the media registry ('%s')"),
aLocation,
m->strSettingsFilePath.raw());
}
return rc;
}
/**
* Searches for a Medium object with the given ID or location in the list of
* registered DVD images. If both ID and file path are specified, the first
* object that matches either of them (not necessarily both) is returned.
*
* @param aId ID of the DVD image (unused when NULL).
* @param aLocation Full path to the image file (unused when NULL).
* @param aSetError If @c true, the appropriate error info is set in case when
* the image is not found.
* @param aImage Where to store the found image object (can be NULL).
*
* @return S_OK when found or E_INVALIDARG when not found.
*
* @note Locks the media tree for reading.
*/
HRESULT VirtualBox::findDVDImage(const Guid *aId,
CBSTR aLocation,
bool aSetError,
ComObjPtr<Medium> *aImage /* = NULL */)
{
AssertReturn(aId || aLocation, E_INVALIDARG);
Utf8Str location;
if (aLocation != NULL)
{
int vrc = calculateFullPath(Utf8Str(aLocation), location);
if (RT_FAILURE(vrc))
return setError(VBOX_E_FILE_ERROR,
tr("Invalid image file location '%ls' (%Rrc)"),
aLocation,
vrc);
}
AutoReadLock alock(m->allDVDImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
bool found = false;
for (MediaList::const_iterator it = m->allDVDImages.begin();
it != m->allDVDImages.end();
++ it)
{
/* no AutoCaller, registered image life time is bound to this */
AutoReadLock imageLock(*it COMMA_LOCKVAL_SRC_POS);
found = (aId && (*it)->getId() == *aId) ||
(aLocation != NULL &&
RTPathCompare(location.c_str(),
(*it)->getLocationFull().c_str()
) == 0);
if (found)
{
if (aImage)
*aImage = *it;
break;
}
}
HRESULT rc = found ? S_OK : VBOX_E_OBJECT_NOT_FOUND;
if (aSetError && !found)
{
if (aId)
setError(rc,
tr("Could not find a CD/DVD image with UUID {%RTuuid} in the media registry ('%s')"),
aId->raw(),
m->strSettingsFilePath.raw());
else
setError(rc,
tr("Could not find a CD/DVD image with location '%ls' in the media registry ('%s')"),
aLocation,
m->strSettingsFilePath.raw());
}
return rc;
}
/**
* Searches for a Medium object with the given ID or location in the
* collection of registered DVD images. If both ID and file path are specified,
* the first object that matches either of them (not necessarily both) is
* returned.
*
* @param aId ID of the DVD image (unused when NULL).
* @param aLocation Full path to the image file (unused when NULL).
* @param aSetError If @c true, the appropriate error info is set in case when
* the image is not found.
* @param aImage Where to store the found image object (can be NULL).
*
* @return S_OK when found or E_INVALIDARG when not found.
*
* @note Locks the media tree for reading.
*/
HRESULT VirtualBox::findFloppyImage(const Guid *aId,
CBSTR aLocation,
bool aSetError,
ComObjPtr<Medium> *aImage /* = NULL */)
{
AssertReturn(aId || aLocation, E_INVALIDARG);
Utf8Str location;
if (aLocation != NULL)
{
int vrc = calculateFullPath(Utf8Str(aLocation), location);
if (RT_FAILURE(vrc))
return setError(VBOX_E_FILE_ERROR,
tr("Invalid image file location '%ls' (%Rrc)"),
aLocation, vrc);
}
AutoReadLock alock(m->allFloppyImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
bool found = false;
for (MediaList::const_iterator it = m->allFloppyImages.begin();
it != m->allFloppyImages.end();
++ it)
{
/* no AutoCaller, registered image life time is bound to this */
AutoReadLock imageLock(*it COMMA_LOCKVAL_SRC_POS);
found = (aId && (*it)->getId() == *aId) ||
(aLocation != NULL &&
RTPathCompare(location.c_str(),
(*it)->getLocationFull().c_str()
) == 0);
if (found)
{
if (aImage)
*aImage = *it;
break;
}
}
HRESULT rc = found ? S_OK : VBOX_E_OBJECT_NOT_FOUND;
if (aSetError && !found)
{
if (aId)
setError(rc,
tr("Could not find a floppy image with UUID {%RTuuid} in the media registry ('%s')"),
aId->raw(),
m->strSettingsFilePath.raw());
else
setError(rc,
tr("Could not find a floppy image with location '%ls' in the media registry ('%s')"),
aLocation,
m->strSettingsFilePath.raw());
}
return rc;
}
HRESULT VirtualBox::findGuestOSType(const Bstr &bstrOSType,
GuestOSType*& pGuestOSType)
{
/* Look for a GuestOSType object */
AssertMsg(m->allGuestOSTypes.size() != 0,
("Guest OS types array must be filled"));
if (bstrOSType.isEmpty())
{
pGuestOSType = NULL;
return S_OK;
}
AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
it != m->allGuestOSTypes.end();
++it)
{
if ((*it)->id() == bstrOSType)
{
pGuestOSType = *it;
return S_OK;
}
}
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("Guest OS type '%ls' is invalid"),
bstrOSType.raw());
}
const ComObjPtr<Host>& VirtualBox::host() const
{
return m->pHost;
}
const ComObjPtr<SystemProperties>& VirtualBox::systemProperties() const
{
return m->pSystemProperties;
}
#ifdef VBOX_WITH_RESOURCE_USAGE_API
const ComObjPtr<PerformanceCollector>& VirtualBox::performanceCollector() const
{
return m->pPerformanceCollector;
}
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
/**
* Returns the default machine folder from the system properties
* with proper locking.
* @return
*/
const Utf8Str& VirtualBox::getDefaultMachineFolder() const
{
AutoReadLock propsLock(m->pSystemProperties COMMA_LOCKVAL_SRC_POS);
return m->pSystemProperties->m->strDefaultMachineFolder;
}
/**
* Returns the default hard disk folder from the system properties
* with proper locking.
* @return
*/
const Utf8Str& VirtualBox::getDefaultHardDiskFolder() const
{
AutoReadLock propsLock(m->pSystemProperties COMMA_LOCKVAL_SRC_POS);
return m->pSystemProperties->m->strDefaultHardDiskFolder;
}
/**
* Returns the default hard disk format from the system properties
* with proper locking.
* @return
*/
const Utf8Str& VirtualBox::getDefaultHardDiskFormat() const
{
AutoReadLock propsLock(m->pSystemProperties COMMA_LOCKVAL_SRC_POS);
return m->pSystemProperties->m->strDefaultHardDiskFormat;
}
const Utf8Str& VirtualBox::homeDir() const
{
return m->strHomeDir;
}
/**
* Calculates the absolute path of the given path taking the VirtualBox home
* directory as the current directory.
*
* @param aPath Path to calculate the absolute path for.
* @param aResult Where to put the result (used only on success, can be the
* same Utf8Str instance as passed in @a aPath).
* @return IPRT result.
*
* @note Doesn't lock any object.
*/
int VirtualBox::calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult)
{
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), VERR_GENERAL_FAILURE);
/* no need to lock since mHomeDir is const */
char folder[RTPATH_MAX];
int vrc = RTPathAbsEx(m->strHomeDir.c_str(), strPath.c_str(), folder, sizeof(folder));
if (RT_SUCCESS(vrc))
aResult = folder;
return vrc;
}
/**
* Copies strSource to strTarget, making it relative to the VirtualBox config folder
* if it is a subdirectory thereof, or simply copying it otherwise.
*
* @param strSource Path to evalue and copy.
* @param strTarget Buffer to receive target path.
*/
void VirtualBox::copyPathRelativeToConfig(const Utf8Str &strSource,
Utf8Str &strTarget)
{
AutoCaller autoCaller(this);
AssertComRCReturnVoid(autoCaller.rc());
// no need to lock since mHomeDir is const
// use strTarget as a temporary buffer to hold the machine settings dir
strTarget = m->strHomeDir;
if (RTPathStartsWith(strSource.c_str(), strTarget.c_str()))
// is relative: then append what's left
strTarget.append(strSource.c_str() + strTarget.length()); // include '/'
else
// is not relative: then overwrite
strTarget = strSource;
}
// private methods
/////////////////////////////////////////////////////////////////////////////
/**
* Checks if there is a hard disk, DVD or floppy image with the given ID or
* location already registered.
*
* On return, sets @a aConflict to the string describing the conflicting medium,
* or sets it to @c Null if no conflicting media is found. Returns S_OK in
* either case. A failure is unexpected.
*
* @param aId UUID to check.
* @param aLocation Location to check.
* @param aConflict Where to return parameters of the conflicting medium.
*
* @note Locks the media tree and media objects for reading.
*/
HRESULT VirtualBox::checkMediaForConflicts2(const Guid &aId,
const Utf8Str &aLocation,
Utf8Str &aConflict)
{
aConflict.setNull();
AssertReturn(!aId.isEmpty() && !aLocation.isEmpty(), E_FAIL);
AutoReadLock alock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
HRESULT rc = S_OK;
Bstr bstrLocation(aLocation);
{
ComObjPtr<Medium> hardDisk;
rc = findHardDisk(&aId, bstrLocation, false /* aSetError */, &hardDisk);
if (SUCCEEDED(rc))
{
/* Note: no AutoCaller since bound to this */
AutoReadLock mediaLock(hardDisk COMMA_LOCKVAL_SRC_POS);
aConflict = Utf8StrFmt(tr("hard disk '%s' with UUID {%RTuuid}"),
hardDisk->getLocationFull().raw(),
hardDisk->getId().raw());
return S_OK;
}
}
{
ComObjPtr<Medium> image;
rc = findDVDImage(&aId, bstrLocation, false /* aSetError */, &image);
if (SUCCEEDED(rc))
{
/* Note: no AutoCaller since bound to this */
AutoReadLock mediaLock(image COMMA_LOCKVAL_SRC_POS);
aConflict = Utf8StrFmt(tr("CD/DVD image '%s' with UUID {%RTuuid}"),
image->getLocationFull().raw(),
image->getId().raw());
return S_OK;
}
}
{
ComObjPtr<Medium> image;
rc = findFloppyImage(&aId, bstrLocation, false /* aSetError */, &image);
if (SUCCEEDED(rc))
{
/* Note: no AutoCaller since bound to this */
AutoReadLock mediaLock(image COMMA_LOCKVAL_SRC_POS);
aConflict = Utf8StrFmt(tr("floppy image '%s' with UUID {%RTuuid}"),
image->getLocationFull().raw(),
image->getId().raw());
return S_OK;
}
}
return S_OK;
}
/**
* Called from Machine::prepareSaveSettings() when it has detected
* that a machine has been renamed. Such renames will require
* updating the global media registry during the
* VirtualBox::saveSettings() that follows later.
*
* When a machine is renamed, there may well be media (in particular,
* diff images for snapshots) in the global registry that will need
* to have their paths updated. Before 3.2, Machine::saveSettings
* used to call VirtualBox::saveSettings implicitly, which was both
* unintuitive and caused locking order problems. Now, we remeber
* such pending name changes with this method so that
* VirtualBox::saveSettings() can process them properly.
*/
void VirtualBox::rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
const Utf8Str &strNewConfigDir)
{
AutoWriteLock mediaLock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
Data::PendingMachineRename pmr;
pmr.strConfigDirOld = strOldConfigDir;
pmr.strConfigDirNew = strNewConfigDir;
m->llPendingMachineRenames.push_back(pmr);
}
/**
* Helper function which actually writes out VirtualBox.xml, the main configuration file.
* Gets called from the public VirtualBox::SaveSettings() as well as from various other
* places internally when settings need saving.
*
* @note Caller must have locked the VirtualBox object for writing and must not hold any
* other locks since this locks all kinds of member objects and trees temporarily,
* which could cause conflicts.
*/
HRESULT VirtualBox::saveSettings()
{
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
AssertReturn(!m->strSettingsFilePath.isEmpty(), E_FAIL);
HRESULT rc = S_OK;
try
{
// lock the lists while we're here
AutoReadLock machinesLock(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
// machines
settings::MachinesRegistry machinesTemp;
{
for (MachinesOList::iterator it = m->allMachines.begin();
it != m->allMachines.end();
++it)
{
Machine *pMachine = *it;
// save actual machine registry entry
settings::MachineRegistryEntry mre;
rc = pMachine->saveRegistryEntry(mre);
machinesTemp.push_back(mre);
}
}
// lock all media for the following; use a write lock because we're
// modifying the PendingMachineRenamesList, which is protected by this
AutoWriteLock mediaLock(getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
// if a machine was renamed, then we'll need to refresh media paths
if (m->llPendingMachineRenames.size())
{
// make a single list from the three media lists so we don't need three loops
MediaList llAllMedia;
// with hard disks, we must use the map, not the list, because the list only has base images
for (HardDiskMap::iterator it = m->mapHardDisks.begin(); it != m->mapHardDisks.end(); ++it)
llAllMedia.push_back(it->second);
for (MediaList::iterator it = m->allDVDImages.begin(); it != m->allDVDImages.end(); ++it)
llAllMedia.push_back(*it);
for (MediaList::iterator it = m->allFloppyImages.begin(); it != m->allFloppyImages.end(); ++it)
llAllMedia.push_back(*it);
for (MediaList::iterator it = llAllMedia.begin();
it != llAllMedia.end();
++it)
{
Medium *pMedium = *it;
for (Data::PendingMachineRenamesList::iterator it2 = m->llPendingMachineRenames.begin();
it2 != m->llPendingMachineRenames.end();
++it2)
{
const Data::PendingMachineRename &pmr = *it2;
const char *pcszOld = pmr.strConfigDirOld.c_str();
const char *pcszNew = pmr.strConfigDirNew.c_str();
pMedium->updatePath(pcszOld, pcszNew);
}
}
// done, don't do it again until we have more machine renames
m->llPendingMachineRenames.clear();
}
// hard disks
settings::MediaList hardDisksTemp;
for (MediaList::const_iterator it = m->allHardDisks.begin();
it != m->allHardDisks.end();
++it)
{
settings::Medium med;
rc = (*it)->saveSettings(med); // this recurses into its children
if (FAILED(rc)) throw rc;
hardDisksTemp.push_back(med);
}
/* CD/DVD images */
settings::MediaList dvdsTemp;
for (MediaList::const_iterator it = m->allDVDImages.begin();
it != m->allDVDImages.end();
++it)
{
settings::Medium med;
rc = (*it)->saveSettings(med);
if (FAILED(rc)) throw rc;
dvdsTemp.push_back(med);
}
/* floppy images */
settings::MediaList floppiesTemp;
for (MediaList::const_iterator it = m->allFloppyImages.begin();
it != m->allFloppyImages.end();
++it)
{
settings::Medium med;
rc = (*it)->saveSettings(med);
if (FAILED(rc)) throw rc;
floppiesTemp.push_back(med);
}
settings::DHCPServersList dhcpServersTemp;
{
AutoReadLock dhcpLock(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (DHCPServersOList::const_iterator it = m->allDHCPServers.begin();
it != m->allDHCPServers.end();
++it)
{
settings::DHCPServer d;
rc = (*it)->saveSettings(d);
if (FAILED(rc)) throw rc;
dhcpServersTemp.push_back(d);
}
}
/* now copy the temp data to the config file under the VirtualBox lock */
m->pMainConfigFile->llMachines = machinesTemp;
m->pMainConfigFile->llHardDisks = hardDisksTemp;
m->pMainConfigFile->llDvdImages = dvdsTemp;
m->pMainConfigFile->llFloppyImages = floppiesTemp;
m->pMainConfigFile->llDhcpServers = dhcpServersTemp;
// leave extra data alone, it's still in the config file
/* host data (USB filters) */
rc = m->pHost->saveSettings(m->pMainConfigFile->host);
if (FAILED(rc)) throw rc;
rc = m->pSystemProperties->saveSettings(m->pMainConfigFile->systemProperties);
if (FAILED(rc)) throw rc;
// and write out the XML, still under the lock
m->pMainConfigFile->write(m->strSettingsFilePath);
}
catch (HRESULT err)
{
/* we assume that error info is set by the thrower */
rc = err;
}
catch (...)
{
rc = VirtualBox::handleUnexpectedExceptions(RT_SRC_POS);
}
return rc;
}
/**
* Helper to register the machine.
*
* When called during VirtualBox startup, adds the given machine to the
* collection of registered machines. Otherwise tries to mark the machine
* as registered, and, if succeeded, adds it to the collection and
* saves global settings.
*
* @note The caller must have added itself as a caller of the @a aMachine
* object if calls this method not on VirtualBox startup.
*
* @param aMachine machine to register
*
* @note Locks objects!
*/
HRESULT VirtualBox::registerMachine(Machine *aMachine)
{
ComAssertRet(aMachine, E_INVALIDARG);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc = S_OK;
AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
{
ComObjPtr<Machine> pMachine;
rc = findMachine(aMachine->getId(),
true /* fPermitInaccessible */,
false /* aDoSetError */,
&pMachine);
if (SUCCEEDED(rc))
{
/* sanity */
AutoLimitedCaller machCaller(pMachine);
AssertComRC(machCaller.rc());
return setError(E_INVALIDARG,
tr("Registered machine with UUID {%RTuuid} ('%ls') already exists"),
aMachine->getId().raw(),
pMachine->getSettingsFileFull().raw());
}
ComAssertRet(rc == VBOX_E_OBJECT_NOT_FOUND, rc);
rc = S_OK;
}
if (autoCaller.state() != InInit)
{
rc = aMachine->prepareRegister();
if (FAILED(rc)) return rc;
}
/* add to the collection of registered machines */
m->allMachines.addChild(aMachine);
if (autoCaller.state() != InInit)
rc = saveSettings();
return rc;
}
/**
* Remembers the given hard disk by storing it in the hard disk registry.
*
* @param aHardDisk Hard disk object to remember.
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note Caller must hold the media tree lock for writing; in addition, this locks @a aHardDisk for reading
*/
HRESULT VirtualBox::registerHardDisk(Medium *aHardDisk,
bool *pfNeedsSaveSettings)
{
AssertReturn(aHardDisk != NULL, E_INVALIDARG);
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AutoCaller hardDiskCaller(aHardDisk);
AssertComRCReturn(hardDiskCaller.rc(), hardDiskCaller.rc());
// caller must hold the media tree write lock
Assert(getMediaTreeLockHandle().isWriteLockOnCurrentThread());
Guid id;
Utf8Str strLocationFull;
ComObjPtr<Medium> pParent;
{
AutoReadLock hardDiskLock(aHardDisk COMMA_LOCKVAL_SRC_POS);
id = aHardDisk->getId();
strLocationFull = aHardDisk->getLocationFull();
pParent = aHardDisk->getParent();
}
HRESULT rc;
Utf8Str strConflict;
rc = checkMediaForConflicts2(id,
strLocationFull,
strConflict);
if (FAILED(rc)) return rc;
if (strConflict.length())
return setError(E_INVALIDARG,
tr("Cannot register the hard disk '%s' with UUID {%RTuuid} because a %s already exists in the media registry ('%s')"),
strLocationFull.raw(),
id.raw(),
strConflict.raw(),
m->strSettingsFilePath.raw());
// store base (root) hard disks in the list
if (pParent.isNull())
m->allHardDisks.getList().push_back(aHardDisk);
// access the list directly because we already locked the list above
// store all hard disks (even differencing images) in the map
m->mapHardDisks[id] = aHardDisk;
if (pfNeedsSaveSettings)
*pfNeedsSaveSettings = true;
return rc;
}
/**
* Removes the given hard disk from the hard disk registry.
*
* @param aHardDisk Hard disk object to remove.
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note Caller must hold the media tree lock for writing; in addition, this locks @a aHardDisk for reading
*/
HRESULT VirtualBox::unregisterHardDisk(Medium *aHardDisk,
bool *pfNeedsSaveSettings)
{
AssertReturn(aHardDisk != NULL, E_INVALIDARG);
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AutoCaller hardDiskCaller(aHardDisk);
AssertComRCReturn(hardDiskCaller.rc(), hardDiskCaller.rc());
// caller must hold the media tree write lock
Assert(getMediaTreeLockHandle().isWriteLockOnCurrentThread());
Guid id;
ComObjPtr<Medium> pParent;
{
AutoReadLock hardDiskLock(aHardDisk COMMA_LOCKVAL_SRC_POS);
id = aHardDisk->getId();
pParent = aHardDisk->getParent();
}
// remove base (root) hard disks from the list
if (pParent.isNull())
m->allHardDisks.getList().remove(aHardDisk);
// access the list directly because caller must have locked the list
// remove all hard disks (even differencing images) from map
size_t cnt = m->mapHardDisks.erase(id);
Assert(cnt == 1);
NOREF(cnt);
if (pfNeedsSaveSettings)
*pfNeedsSaveSettings = true;
return S_OK;
}
/**
* Remembers the given image by storing it in the CD/DVD or floppy image registry.
*
* @param argImage Image object to remember.
* @param argType Either DeviceType_DVD or DeviceType_Floppy.
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note Caller must hold the media tree lock for writing; in addition, this locks @a argImage for reading
*/
HRESULT VirtualBox::registerImage(Medium *argImage,
DeviceType_T argType,
bool *pfNeedsSaveSettings)
{
AssertReturn(argImage != NULL, E_INVALIDARG);
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AutoCaller imageCaller(argImage);
AssertComRCReturn(imageCaller.rc(), imageCaller.rc());
// caller must hold the media tree write lock
Assert(getMediaTreeLockHandle().isWriteLockOnCurrentThread());
Guid id;
Utf8Str strLocationFull;
ComObjPtr<Medium> pParent;
{
AutoReadLock al(argImage COMMA_LOCKVAL_SRC_POS);
id = argImage->getId();
strLocationFull = argImage->getLocationFull();
pParent = argImage->getParent();
}
// work on DVDs or floppies list?
ObjectsList<Medium> &all = (argType == DeviceType_DVD) ? m->allDVDImages : m->allFloppyImages;
HRESULT rc;
// lock the images lists (list + map) while checking for conflicts
AutoWriteLock al(all.getLockHandle() COMMA_LOCKVAL_SRC_POS);
Utf8Str strConflict;
rc = checkMediaForConflicts2(id,
strLocationFull,
strConflict);
if (FAILED(rc)) return rc;
if (strConflict.length())
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("Cannot register the image '%s' with UUID {%RTuuid} because a %s already exists in the media registry ('%s')"),
strLocationFull.raw(),
id.raw(),
strConflict.raw(),
m->strSettingsFilePath.raw());
// add to the collection
all.getList().push_back(argImage);
// access the list directly because we already locked the list above
if (pfNeedsSaveSettings)
*pfNeedsSaveSettings = true;
return rc;
}
/**
* Removes the given image from the CD/DVD or floppy image registry.
*
* @param argImage Image object to remove.
* @param argType Either DeviceType_DVD or DeviceType_Floppy.
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note Caller must hold the media tree lock for writing; in addition, this locks @a argImage for reading
*/
HRESULT VirtualBox::unregisterImage(Medium *argImage,
DeviceType_T argType,
bool *pfNeedsSaveSettings)
{
AssertReturn(argImage != NULL, E_INVALIDARG);
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AutoCaller imageCaller(argImage);
AssertComRCReturn(imageCaller.rc(), imageCaller.rc());
// caller must hold the media tree write lock
Assert(getMediaTreeLockHandle().isWriteLockOnCurrentThread());
Guid id;
ComObjPtr<Medium> pParent;
{
AutoReadLock al(argImage COMMA_LOCKVAL_SRC_POS);
id = argImage->getId();
pParent = argImage->getParent();
}
// work on DVDs or floppies list?
ObjectsList<Medium> &all = (argType == DeviceType_DVD) ? m->allDVDImages : m->allFloppyImages;
// access the list directly because the caller must have requested the lock
all.getList().remove(argImage);
HRESULT rc = S_OK;
if (pfNeedsSaveSettings)
*pfNeedsSaveSettings = true;
return rc;
}
/**
* Removes the given machine object from the internal list of registered machines.
* Called from Machine::Unregister().
* @param pMachine
* @return
*/
HRESULT VirtualBox::unregisterMachine(Machine *pMachine)
{
const Guid &id = pMachine->getId();
AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
// remove from the collection of registered machines
m->allMachines.removeChild(pMachine);
// save the global registry
HRESULT rc = saveSettings();
alock.release();
/* fire an event */
onMachineRegistered(id, FALSE);
return rc;
}
/**
* Creates the path to the specified file according to the path information
* present in the file name.
*
* Note that the given file name must contain the full path otherwise the
* extracted relative path will be created based on the current working
* directory which is normally unknown.
*
* @param aFileName Full file name which path needs to be created.
*
* @return Extended error information on failure to create the path.
*/
/* static */
HRESULT VirtualBox::ensureFilePathExists(const Utf8Str &strFileName)
{
Utf8Str strDir(strFileName);
strDir.stripFilename();
if (!RTDirExists(strDir.c_str()))
{
int vrc = RTDirCreateFullPath(strDir.c_str(), 0777);
if (RT_FAILURE(vrc))
return setErrorStatic(E_FAIL,
Utf8StrFmt(tr("Could not create the directory '%s' (%Rrc)"),
strDir.c_str(),
vrc));
}
return S_OK;
}
/**
* Handles unexpected exceptions by turning them into COM errors in release
* builds or by hitting a breakpoint in the release builds.
*
* Usage pattern:
* @code
try
{
// ...
}
catch (LaLalA)
{
// ...
}
catch (...)
{
rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
}
* @endcode
*
* @param RT_SRC_POS_DECL "RT_SRC_POS" macro instantiation.
*/
/* static */
HRESULT VirtualBox::handleUnexpectedExceptions(RT_SRC_POS_DECL)
{
try
{
/* re-throw the current exception */
throw;
}
catch (const iprt::Error &err) // includes all XML exceptions
{
return setErrorStatic(E_FAIL,
Utf8StrFmt(tr("%s.\n%s[%d] (%s)"),
err.what(),
pszFile, iLine, pszFunction).c_str());
}
catch (const std::exception &err)
{
return setErrorStatic(E_FAIL,
Utf8StrFmt(tr("Unexpected exception: %s [%s]\n%s[%d] (%s)"),
err.what(), typeid(err).name(),
pszFile, iLine, pszFunction).c_str());
}
catch (...)
{
return setErrorStatic(E_FAIL,
Utf8StrFmt(tr("Unknown exception\n%s[%d] (%s)"),
pszFile, iLine, pszFunction).c_str());
}
/* should not get here */
AssertFailed();
return E_FAIL;
}
const Utf8Str& VirtualBox::settingsFilePath()
{
return m->strSettingsFilePath;
}
/**
* Returns the lock handle which protects the media trees (hard disks,
* DVDs, floppies). As opposed to version 3.1 and earlier, these lists
* are no longer protected by the VirtualBox lock, but by this more
* specialized lock. Mind the locking order: always request this lock
* after the VirtualBox object lock but before the locks of the media
* objects contained in these lists. See AutoLock.h.
*/
RWLockHandle& VirtualBox::getMediaTreeLockHandle()
{
return m->lockMedia;
}
/**
* Thread function that watches the termination of all client processes
* that have opened sessions using IMachine::LockMachine()
*/
// static
DECLCALLBACK(int) VirtualBox::ClientWatcher(RTTHREAD /* thread */, void *pvUser)
{
LogFlowFuncEnter();
VirtualBox *that = (VirtualBox*)pvUser;
Assert(that);
typedef std::vector< ComObjPtr<Machine> > MachineVector;
typedef std::vector< ComObjPtr<SessionMachine> > SessionMachineVector;
SessionMachineVector machines;
MachineVector spawnedMachines;
size_t cnt = 0;
size_t cntSpawned = 0;
#if defined(RT_OS_WINDOWS)
HRESULT hrc = CoInitializeEx(NULL,
COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE |
COINIT_SPEED_OVER_MEMORY);
AssertComRC(hrc);
/// @todo (dmik) processes reaping!
HANDLE handles[MAXIMUM_WAIT_OBJECTS];
handles[0] = that->m->updateReq;
do
{
AutoCaller autoCaller(that);
/* VirtualBox has been early uninitialized, terminate */
if (!autoCaller.isOk())
break;
do
{
/* release the caller to let uninit() ever proceed */
autoCaller.release();
DWORD rc = ::WaitForMultipleObjects((DWORD)(1 + cnt + cntSpawned),
handles,
FALSE,
INFINITE);
/* Restore the caller before using VirtualBox. If it fails, this
* means VirtualBox is being uninitialized and we must terminate. */
autoCaller.add();
if (!autoCaller.isOk())
break;
bool update = false;
if (rc == WAIT_OBJECT_0)
{
/* update event is signaled */
update = true;
}
else if (rc > WAIT_OBJECT_0 && rc <= (WAIT_OBJECT_0 + cnt))
{
/* machine mutex is released */
(machines[rc - WAIT_OBJECT_0 - 1])->checkForDeath();
update = true;
}
else if (rc > WAIT_ABANDONED_0 && rc <= (WAIT_ABANDONED_0 + cnt))
{
/* machine mutex is abandoned due to client process termination */
(machines[rc - WAIT_ABANDONED_0 - 1])->checkForDeath();
update = true;
}
else if (rc > WAIT_OBJECT_0 + cnt && rc <= (WAIT_OBJECT_0 + cntSpawned))
{
/* spawned VM process has terminated (normally or abnormally) */
(spawnedMachines[rc - WAIT_OBJECT_0 - cnt - 1])->
checkForSpawnFailure();
update = true;
}
if (update)
{
/* close old process handles */
for (size_t i = 1 + cnt; i < 1 + cnt + cntSpawned; ++i)
CloseHandle(handles[i]);
// lock the machines list for reading
AutoReadLock thatLock(that->m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
/* obtain a new set of opened machines */
cnt = 0;
machines.clear();
for (MachinesOList::iterator it = that->m->allMachines.begin();
it != that->m->allMachines.end();
++it)
{
/// @todo handle situations with more than 64 objects
AssertMsgBreak((1 + cnt) <= MAXIMUM_WAIT_OBJECTS,
("MAXIMUM_WAIT_OBJECTS reached"));
ComObjPtr<SessionMachine> sm;
HANDLE ipcSem;
if ((*it)->isSessionOpenOrClosing(sm, NULL, &ipcSem))
{
machines.push_back(sm);
handles[1 + cnt] = ipcSem;
++cnt;
}
}
LogFlowFunc(("UPDATE: direct session count = %d\n", cnt));
/* obtain a new set of spawned machines */
cntSpawned = 0;
spawnedMachines.clear();
for (MachinesOList::iterator it = that->m->allMachines.begin();
it != that->m->allMachines.end();
++it)
{
/// @todo handle situations with more than 64 objects
AssertMsgBreak((1 + cnt + cntSpawned) <= MAXIMUM_WAIT_OBJECTS,
("MAXIMUM_WAIT_OBJECTS reached"));
RTPROCESS pid;
if ((*it)->isSessionSpawning(&pid))
{
HANDLE ph = OpenProcess(SYNCHRONIZE, FALSE, pid);
AssertMsg(ph != NULL, ("OpenProcess (pid=%d) failed with %d\n",
pid, GetLastError()));
if (rc == 0)
{
spawnedMachines.push_back(*it);
handles[1 + cnt + cntSpawned] = ph;
++cntSpawned;
}
}
}
LogFlowFunc(("UPDATE: spawned session count = %d\n", cntSpawned));
// machines lock unwinds here
}
}
while (true);
}
while (0);
/* close old process handles */
for (size_t i = 1 + cnt; i < 1 + cnt + cntSpawned; ++ i)
CloseHandle(handles[i]);
/* release sets of machines if any */
machines.clear();
spawnedMachines.clear();
::CoUninitialize();
#elif defined(RT_OS_OS2)
/// @todo (dmik) processes reaping!
/* according to PMREF, 64 is the maximum for the muxwait list */
SEMRECORD handles[64];
HMUX muxSem = NULLHANDLE;
do
{
AutoCaller autoCaller(that);
/* VirtualBox has been early uninitialized, terminate */
if (!autoCaller.isOk())
break;
do
{
/* release the caller to let uninit() ever proceed */
autoCaller.release();
int vrc = RTSemEventWait(that->m->updateReq, 500);
/* Restore the caller before using VirtualBox. If it fails, this
* means VirtualBox is being uninitialized and we must terminate. */
autoCaller.add();
if (!autoCaller.isOk())
break;
bool update = false;
bool updateSpawned = false;
if (RT_SUCCESS(vrc))
{
/* update event is signaled */
update = true;
updateSpawned = true;
}
else
{
AssertMsg(vrc == VERR_TIMEOUT || vrc == VERR_INTERRUPTED,
("RTSemEventWait returned %Rrc\n", vrc));
/* are there any mutexes? */
if (cnt > 0)
{
/* figure out what's going on with machines */
unsigned long semId = 0;
APIRET arc = ::DosWaitMuxWaitSem(muxSem,
SEM_IMMEDIATE_RETURN, &semId);
if (arc == NO_ERROR)
{
/* machine mutex is normally released */
Assert(semId >= 0 && semId < cnt);
if (semId >= 0 && semId < cnt)
{
#ifdef DEBUG
{
AutoReadLock machineLock(machines[semId] COMMA_LOCKVAL_SRC_POS);
LogFlowFunc(("released mutex: machine='%ls'\n",
machines[semId]->name().raw()));
}
#endif
machines[semId]->checkForDeath();
}
update = true;
}
else if (arc == ERROR_SEM_OWNER_DIED)
{
/* machine mutex is abandoned due to client process
* termination; find which mutex is in the Owner Died
* state */
for (size_t i = 0; i < cnt; ++ i)
{
PID pid; TID tid;
unsigned long reqCnt;
arc = DosQueryMutexSem((HMTX)handles[i].hsemCur, &pid, &tid, &reqCnt);
if (arc == ERROR_SEM_OWNER_DIED)
{
/* close the dead mutex as asked by PMREF */
::DosCloseMutexSem((HMTX)handles[i].hsemCur);
Assert(i >= 0 && i < cnt);
if (i >= 0 && i < cnt)
{
#ifdef DEBUG
{
AutoReadLock machineLock(machines[semId] COMMA_LOCKVAL_SRC_POS);
LogFlowFunc(("mutex owner dead: machine='%ls'\n",
machines[i]->name().raw()));
}
#endif
machines[i]->checkForDeath();
}
}
}
update = true;
}
else
AssertMsg(arc == ERROR_INTERRUPT || arc == ERROR_TIMEOUT,
("DosWaitMuxWaitSem returned %d\n", arc));
}
/* are there any spawning sessions? */
if (cntSpawned > 0)
{
for (size_t i = 0; i < cntSpawned; ++ i)
updateSpawned |= (spawnedMachines[i])->
checkForSpawnFailure();
}
}
if (update || updateSpawned)
{
AutoReadLock thatLock(that COMMA_LOCKVAL_SRC_POS);
if (update)
{
/* close the old muxsem */
if (muxSem != NULLHANDLE)
::DosCloseMuxWaitSem(muxSem);
/* obtain a new set of opened machines */
cnt = 0;
machines.clear();
for (MachinesOList::iterator it = that->m->llMachines.begin();
it != that->m->llMachines.end(); ++ it)
{
/// @todo handle situations with more than 64 objects
AssertMsg(cnt <= 64 /* according to PMREF */,
("maximum of 64 mutex semaphores reached (%d)",
cnt));
ComObjPtr<SessionMachine> sm;
HMTX ipcSem;
if ((*it)->isSessionOpenOrClosing(sm, NULL, &ipcSem))
{
machines.push_back(sm);
handles[cnt].hsemCur = (HSEM)ipcSem;
handles[cnt].ulUser = cnt;
++ cnt;
}
}
LogFlowFunc(("UPDATE: direct session count = %d\n", cnt));
if (cnt > 0)
{
/* create a new muxsem */
APIRET arc = ::DosCreateMuxWaitSem(NULL, &muxSem, cnt,
handles,
DCMW_WAIT_ANY);
AssertMsg(arc == NO_ERROR,
("DosCreateMuxWaitSem returned %d\n", arc));
NOREF(arc);
}
}
if (updateSpawned)
{
/* obtain a new set of spawned machines */
spawnedMachines.clear();
for (MachinesOList::iterator it = that->m->llMachines.begin();
it != that->m->llMachines.end(); ++ it)
{
if ((*it)->isSessionSpawning())
spawnedMachines.push_back(*it);
}
cntSpawned = spawnedMachines.size();
LogFlowFunc(("UPDATE: spawned session count = %d\n", cntSpawned));
}
}
}
while (true);
}
while (0);
/* close the muxsem */
if (muxSem != NULLHANDLE)
::DosCloseMuxWaitSem(muxSem);
/* release sets of machines if any */
machines.clear();
spawnedMachines.clear();
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
bool update = false;
bool updateSpawned = false;
do
{
AutoCaller autoCaller(that);
if (!autoCaller.isOk())
break;
do
{
/* release the caller to let uninit() ever proceed */
autoCaller.release();
int rc = RTSemEventWait(that->m->updateReq, 500);
/*
* Restore the caller before using VirtualBox. If it fails, this
* means VirtualBox is being uninitialized and we must terminate.
*/
autoCaller.add();
if (!autoCaller.isOk())
break;
if (RT_SUCCESS(rc) || update || updateSpawned)
{
/* RT_SUCCESS(rc) means an update event is signaled */
// lock the machines list for reading
AutoReadLock thatLock(that->m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
if (RT_SUCCESS(rc) || update)
{
/* obtain a new set of opened machines */
machines.clear();
for (MachinesOList::iterator it = that->m->allMachines.begin();
it != that->m->allMachines.end();
++it)
{
ComObjPtr<SessionMachine> sm;
if ((*it)->isSessionOpenOrClosing(sm))
machines.push_back(sm);
}
cnt = machines.size();
LogFlowFunc(("UPDATE: direct session count = %d\n", cnt));
}
if (RT_SUCCESS(rc) || updateSpawned)
{
/* obtain a new set of spawned machines */
spawnedMachines.clear();
for (MachinesOList::iterator it = that->m->allMachines.begin();
it != that->m->allMachines.end();
++it)
{
if ((*it)->isSessionSpawning())
spawnedMachines.push_back(*it);
}
cntSpawned = spawnedMachines.size();
LogFlowFunc(("UPDATE: spawned session count = %d\n", cntSpawned));
}
// machines lock unwinds here
}
update = false;
for (size_t i = 0; i < cnt; ++ i)
update |= (machines[i])->checkForDeath();
updateSpawned = false;
for (size_t i = 0; i < cntSpawned; ++ i)
updateSpawned |= (spawnedMachines[i])->checkForSpawnFailure();
/* reap child processes */
{
AutoWriteLock alock(that COMMA_LOCKVAL_SRC_POS);
if (that->m->llProcesses.size())
{
LogFlowFunc(("UPDATE: child process count = %d\n",
that->m->llProcesses.size()));
VirtualBox::Data::ProcessList::iterator it = that->m->llProcesses.begin();
while (it != that->m->llProcesses.end())
{
RTPROCESS pid = *it;
RTPROCSTATUS status;
int vrc = ::RTProcWait(pid, RTPROCWAIT_FLAGS_NOBLOCK, &status);
if (vrc == VINF_SUCCESS)
{
LogFlowFunc(("pid %d (%x) was reaped, status=%d, reason=%d\n",
pid, pid, status.iStatus,
status.enmReason));
it = that->m->llProcesses.erase(it);
}
else
{
LogFlowFunc(("pid %d (%x) was NOT reaped, vrc=%Rrc\n",
pid, pid, vrc));
if (vrc != VERR_PROCESS_RUNNING)
{
/* remove the process if it is not already running */
it = that->m->llProcesses.erase(it);
}
else
++ it;
}
}
}
}
}
while (true);
}
while (0);
/* release sets of machines if any */
machines.clear();
spawnedMachines.clear();
#else
# error "Port me!"
#endif
LogFlowFuncLeave();
return 0;
}
/**
* Thread function that handles custom events posted using #postEvent().
*/
// static
DECLCALLBACK(int) VirtualBox::AsyncEventHandler(RTTHREAD thread, void *pvUser)
{
LogFlowFuncEnter();
AssertReturn(pvUser, VERR_INVALID_POINTER);
// create an event queue for the current thread
EventQueue *eventQ = new EventQueue();
AssertReturn(eventQ, VERR_NO_MEMORY);
// return the queue to the one who created this thread
*(static_cast <EventQueue **>(pvUser)) = eventQ;
// signal that we're ready
RTThreadUserSignal(thread);
BOOL ok = TRUE;
Event *event = NULL;
while ((ok = eventQ->waitForEvent(&event)) && event)
eventQ->handleEvent(event);
AssertReturn(ok, VERR_GENERAL_FAILURE);
delete eventQ;
LogFlowFuncLeave();
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/**
* Takes the current list of registered callbacks of the managed VirtualBox
* instance, and calls #handleCallback() for every callback item from the
* list, passing the item as an argument.
*
* @note Locks the managed VirtualBox object for reading but leaves the lock
* before iterating over callbacks and calling their methods.
*/
void *VirtualBox::CallbackEvent::handler()
{
if (!mVirtualBox)
return NULL;
AutoCaller autoCaller(mVirtualBox);
if (!autoCaller.isOk())
{
LogWarningFunc(("VirtualBox has been uninitialized (state=%d), the callback event is discarded!\n",
autoCaller.state()));
/* We don't need mVirtualBox any more, so release it */
mVirtualBox = NULL;
return NULL;
}
{
VBoxEventDesc evDesc;
prepareEventDesc(mVirtualBox->m->pEventSource, evDesc);
evDesc.fire(/* don't wait for delivery */0);
}
mVirtualBox = NULL; /* Not needed any longer. Still make sense to do this? */
return NULL;
}
//STDMETHODIMP VirtualBox::CreateDHCPServerForInterface(/*IHostNetworkInterface * aIinterface,*/ IDHCPServer ** aServer)
//{
// return E_NOTIMPL;
//}
STDMETHODIMP VirtualBox::CreateDHCPServer(IN_BSTR aName, IDHCPServer ** aServer)
{
CheckComArgStrNotEmptyOrNull(aName);
CheckComArgNotNull(aServer);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
ComObjPtr<DHCPServer> dhcpServer;
dhcpServer.createObject();
HRESULT rc = dhcpServer->init(this, aName);
if (FAILED(rc)) return rc;
rc = registerDHCPServer(dhcpServer, true);
if (FAILED(rc)) return rc;
dhcpServer.queryInterfaceTo(aServer);
return rc;
}
STDMETHODIMP VirtualBox::FindDHCPServerByNetworkName(IN_BSTR aName, IDHCPServer ** aServer)
{
CheckComArgStrNotEmptyOrNull(aName);
CheckComArgNotNull(aServer);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc;
Bstr bstr;
ComPtr<DHCPServer> found;
AutoReadLock alock(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
for (DHCPServersOList::const_iterator it = m->allDHCPServers.begin();
it != m->allDHCPServers.end();
++it)
{
rc = (*it)->COMGETTER(NetworkName)(bstr.asOutParam());
if (FAILED(rc)) throw rc;
if (bstr == aName)
{
found = *it;
break;
}
}
if (!found)
return E_INVALIDARG;
return found.queryInterfaceTo(aServer);
}
STDMETHODIMP VirtualBox::RemoveDHCPServer(IDHCPServer * aServer)
{
CheckComArgNotNull(aServer);
AutoCaller autoCaller(this);
if (FAILED(autoCaller.rc())) return autoCaller.rc();
HRESULT rc = unregisterDHCPServer(static_cast<DHCPServer *>(aServer), true);
return rc;
}
/**
* Remembers the given dhcp server by storing it in the hard disk registry.
*
* @param aDHCPServer Dhcp Server object to remember.
* @param aSaveRegistry @c true to save hard disk registry to disk (default).
*
* When @a aSaveRegistry is @c true, this operation may fail because of the
* failed #saveSettings() method it calls. In this case, the dhcp server object
* will not be remembered. It is therefore the responsibility of the caller to
* call this method as the last step of some action that requires registration
* in order to make sure that only fully functional dhcp server objects get
* registered.
*
* @note Locks this object for writing and @a aDHCPServer for reading.
*/
HRESULT VirtualBox::registerDHCPServer(DHCPServer *aDHCPServer,
bool aSaveRegistry /*= true*/)
{
AssertReturn(aDHCPServer != NULL, E_INVALIDARG);
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AutoCaller dhcpServerCaller(aDHCPServer);
AssertComRCReturn(dhcpServerCaller.rc(), dhcpServerCaller.rc());
Bstr name;
HRESULT rc;
rc = aDHCPServer->COMGETTER(NetworkName)(name.asOutParam());
if (FAILED(rc)) return rc;
ComPtr<IDHCPServer> existing;
rc = FindDHCPServerByNetworkName(name, existing.asOutParam());
if (SUCCEEDED(rc))
return E_INVALIDARG;
rc = S_OK;
m->allDHCPServers.addChild(aDHCPServer);
if (aSaveRegistry)
{
AutoWriteLock vboxLock(this COMMA_LOCKVAL_SRC_POS);
rc = saveSettings();
vboxLock.release();
if (FAILED(rc))
unregisterDHCPServer(aDHCPServer, false /* aSaveRegistry */);
}
return rc;
}
/**
* Removes the given hard disk from the hard disk registry.
*
* @param aHardDisk Hard disk object to remove.
* @param aSaveRegistry @c true to save hard disk registry to disk (default).
*
* When @a aSaveRegistry is @c true, this operation may fail because of the
* failed #saveSettings() method it calls. In this case, the hard disk object
* will NOT be removed from the registry when this method returns. It is
* therefore the responsibility of the caller to call this method as the first
* step of some action that requires unregistration, before calling uninit() on
* @a aHardDisk.
*
* @note Locks this object for writing and @a aHardDisk for reading.
*/
HRESULT VirtualBox::unregisterDHCPServer(DHCPServer *aDHCPServer,
bool aSaveRegistry /*= true*/)
{
AssertReturn(aDHCPServer != NULL, E_INVALIDARG);
AutoCaller autoCaller(this);
AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
AutoCaller dhcpServerCaller(aDHCPServer);
AssertComRCReturn(dhcpServerCaller.rc(), dhcpServerCaller.rc());
m->allDHCPServers.removeChild(aDHCPServer);
HRESULT rc = S_OK;
if (aSaveRegistry)
{
AutoWriteLock vboxLock(this COMMA_LOCKVAL_SRC_POS);
rc = saveSettings();
vboxLock.release();
if (FAILED(rc))
registerDHCPServer(aDHCPServer, false /* aSaveRegistry */);
}
return rc;
}
/* vi: set tabstop=4 shiftwidth=4 expandtab: */