VirtualBoxImpl.cpp revision 3918ed075bc7939d7397b643c46b460a4f3b67fc
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync/* $Id$ */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync/** @file
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * Implmentation of IVirtualBox in VBoxSVC.
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync/*
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync *
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * available from http://www.virtualbox.org. This file is free software;
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * General Public License (GPL) as published by the Free Software
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync *
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * additional information or have any questions.
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include "VirtualBoxImpl.h"
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include "Global.h"
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include "MachineImpl.h"
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync#include "HardDisk2Impl.h"
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include "MediumImpl.h"
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include "SharedFolderImpl.h"
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync#include "ProgressImpl.h"
50453af238fcec34bf98f91cc4c32bf57f738bd3vboxsync#include "HostImpl.h"
f2490dbf97c8247439446844458461b00e50beb0vboxsync#include "USBControllerImpl.h"
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync#include "SystemPropertiesImpl.h"
482a222498aae619afda0255a7edf4ebda97268cvboxsync#include "GuestOSTypeImpl.h"
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#include "Version.h"
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#include "VirtualBoxXMLUtil.h"
21293ca6a2967f796ed30a6c8492911619476a48vboxsync
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#include "Logging.h"
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#ifdef RT_OS_WINDOWS
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync# include "win/svchlp.h"
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#endif
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#include <stdio.h>
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync#include <stdlib.h>
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync#include <iprt/path.h>
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync#include <iprt/dir.h>
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync#include <iprt/file.h>
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync#include <iprt/string.h>
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync#include <iprt/uuid.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <iprt/thread.h>
eeb2d581c99b451fb1a26a5870af65981dc9cd5dvboxsync#include <iprt/process.h>
f32de6c198a491c28ace2b4c53f8d04a79fd6d69vboxsync#include <iprt/env.h>
f32de6c198a491c28ace2b4c53f8d04a79fd6d69vboxsync#include <iprt/cpputils.h>
0ce6ae9d6efed5d54222a13bbdabce9e688e4447vboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/err.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/param.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/VBoxHDD.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/VBoxHDD-new.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/version.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <package-generated.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/com/com.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <VBox/com/array.h>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <algorithm>
57b49c1557a310ee615bc0ee79dd2a2e92319a1bvboxsync#include <set>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <memory> // for auto_ptr
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync#include <typeinfo>
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
f2490dbf97c8247439446844458461b00e50beb0vboxsync// defines
f2490dbf97c8247439446844458461b00e50beb0vboxsync/////////////////////////////////////////////////////////////////////////////
f2490dbf97c8247439446844458461b00e50beb0vboxsync
f2490dbf97c8247439446844458461b00e50beb0vboxsync#define VBOX_GLOBAL_SETTINGS_FILE "VirtualBox.xml"
f2490dbf97c8247439446844458461b00e50beb0vboxsync
f2490dbf97c8247439446844458461b00e50beb0vboxsync// globals
f2490dbf97c8247439446844458461b00e50beb0vboxsync/////////////////////////////////////////////////////////////////////////////
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsyncstatic const char gDefaultGlobalConfig [] =
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync{
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>" RTFILE_LINEFEED
e52c9984c4f6b8ea141bc50a3bdaf31941d8cd7dvboxsync "<!-- Sun xVM VirtualBox Global Configuration -->" RTFILE_LINEFEED
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync "<VirtualBox xmlns=\"" VBOX_XML_NAMESPACE "\" "
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync "version=\"" VBOX_XML_VERSION_FULL "\">" RTFILE_LINEFEED
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync " <Global>"RTFILE_LINEFEED
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync " <MachineRegistry/>"RTFILE_LINEFEED
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync " <MediaRegistry/>"RTFILE_LINEFEED
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync " <USBDeviceFilters/>"RTFILE_LINEFEED
ee5869bb73f07de9c139dc6a608836a7b5767933vboxsync " <SystemProperties/>"RTFILE_LINEFEED
f6dde23cd488aee26203b38ec67220270f5c4273vboxsync " </Global>"RTFILE_LINEFEED
f6dde23cd488aee26203b38ec67220270f5c4273vboxsync "</VirtualBox>"RTFILE_LINEFEED
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync};
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
dc311b529996345ea65d51c87b60b6849642d894vboxsync// static
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsyncBstr VirtualBox::sVersion;
ee5869bb73f07de9c139dc6a608836a7b5767933vboxsync
e52c9984c4f6b8ea141bc50a3bdaf31941d8cd7dvboxsync// static
dc311b529996345ea65d51c87b60b6849642d894vboxsyncULONG VirtualBox::sRevision;
dc311b529996345ea65d51c87b60b6849642d894vboxsync
0a3eb63419e41ef10cd135aeb66dcd6bd6f87cdcvboxsync// static
dc311b529996345ea65d51c87b60b6849642d894vboxsyncBstr VirtualBox::sPackageType;
c4d6c81bd0de216d0f42db2e477b1d788fbaefb4vboxsync
c4d6c81bd0de216d0f42db2e477b1d788fbaefb4vboxsync// static
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsyncBstr VirtualBox::sSettingsFormatVersion;
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync// constructor / destructor
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync/////////////////////////////////////////////////////////////////////////////
482a222498aae619afda0255a7edf4ebda97268cvboxsync
d19316699d7f91959d88c850fd7e0d64840f39a7vboxsyncVirtualBox::VirtualBox()
482a222498aae619afda0255a7edf4ebda97268cvboxsync : mAsyncEventThread (NIL_RTTHREAD)
d020036eb167a2f97f5010276fda5daa3f4773b3vboxsync , mAsyncEventQ (NULL)
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync{}
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
25c5ce7baf4b227ea80250c46d427d0e9fdab4c1vboxsyncVirtualBox::~VirtualBox() {}
25c5ce7baf4b227ea80250c46d427d0e9fdab4c1vboxsync
d91dc86210d602f51a4701762488a5e696c80a45vboxsyncHRESULT VirtualBox::FinalConstruct()
d91dc86210d602f51a4701762488a5e696c80a45vboxsync{
2c1d8cd8efdd4c486ff681135035d24111b03af8vboxsync LogFlowThisFunc (("\n"));
59d96bafa78f7257869e30b88f2f98142ef5928evboxsync
c4d6c81bd0de216d0f42db2e477b1d788fbaefb4vboxsync return init();
a96ed55e8e1b248965a3d29d6e4c3116979e887bvboxsync}
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsyncvoid VirtualBox::FinalRelease()
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync{
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync LogFlowThisFunc (("\n"));
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync uninit();
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync}
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsyncVirtualBox::Data::Data()
7a2986a2fdd00cd130bcda05a53575fb58874754vboxsync{
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync}
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync// public initializer/uninitializer for internal purposes only
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync/////////////////////////////////////////////////////////////////////////////
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync/**
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync * Initializes the VirtualBox object.
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync *
b8ae33177906f4130b85b7c861cae0e78ed4859bvboxsync * @return COM result code
d5bf937d132098565e18a0d1fc408fb777c5e5b6vboxsync */
d76ca6cbea4e45aa218c74e33c784bde5e997ffcvboxsyncHRESULT VirtualBox::init()
d76ca6cbea4e45aa218c74e33c784bde5e997ffcvboxsync{
d76ca6cbea4e45aa218c74e33c784bde5e997ffcvboxsync /* Enclose the state transition NotReady->InInit->Ready */
d76ca6cbea4e45aa218c74e33c784bde5e997ffcvboxsync AutoInitSpan autoInitSpan (this);
d76ca6cbea4e45aa218c74e33c784bde5e997ffcvboxsync AssertReturn (autoInitSpan.isOk(), E_UNEXPECTED);
7a71f66d53a7dcdf19a7a357e99e560fda812dc3vboxsync
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync LogFlow (("===========================================================\n"));
7a71f66d53a7dcdf19a7a357e99e560fda812dc3vboxsync LogFlowThisFuncEnter();
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync if (sVersion.isNull())
21293ca6a2967f796ed30a6c8492911619476a48vboxsync sVersion = VBOX_VERSION_STRING;
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync sRevision = VBoxSVNRev();
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync if (sPackageType.isNull())
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync sPackageType = VBOX_PACKAGE_STRING;
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync LogFlowThisFunc (("Version: %ls, Package: %ls\n", sVersion.raw(), sPackageType.raw()));
21293ca6a2967f796ed30a6c8492911619476a48vboxsync
21293ca6a2967f796ed30a6c8492911619476a48vboxsync if (sSettingsFormatVersion.isNull())
21293ca6a2967f796ed30a6c8492911619476a48vboxsync sSettingsFormatVersion = VBOX_XML_VERSION_FULL;
21293ca6a2967f796ed30a6c8492911619476a48vboxsync LogFlowThisFunc (("Settings Format Version: %ls\n",
2c1d8cd8efdd4c486ff681135035d24111b03af8vboxsync sSettingsFormatVersion.raw()));
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync /* Get the VirtualBox home directory. */
35d8d2372afb180daa0ba01af33a1922511d6b07vboxsync {
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync char homeDir [RTPATH_MAX];
7a71f66d53a7dcdf19a7a357e99e560fda812dc3vboxsync int vrc = com::GetVBoxUserHomeDirectory (homeDir, sizeof (homeDir));
f2490dbf97c8247439446844458461b00e50beb0vboxsync if (RT_FAILURE (vrc))
d20e5d189feff7841cc3f40e5c9cca8c86b45eb5vboxsync return setError (E_FAIL,
f2490dbf97c8247439446844458461b00e50beb0vboxsync tr ("Could not create the VirtualBox home directory '%s'"
f2490dbf97c8247439446844458461b00e50beb0vboxsync "(%Rrc)"),
f2490dbf97c8247439446844458461b00e50beb0vboxsync homeDir, vrc);
f2490dbf97c8247439446844458461b00e50beb0vboxsync
f2490dbf97c8247439446844458461b00e50beb0vboxsync unconst (mData.mHomeDir) = homeDir;
f2490dbf97c8247439446844458461b00e50beb0vboxsync }
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync
6b9316bfe743cc7d2ee00d925f4ab455bc224e86vboxsync /* compose the global config file name (always full path) */
db85b6b8ce514217c1fb35d04b0854a65dc299f3vboxsync Utf8StrFmt vboxConfigFile ("%s%c%s", mData.mHomeDir.raw(),
db85b6b8ce514217c1fb35d04b0854a65dc299f3vboxsync RTPATH_DELIMITER, VBOX_GLOBAL_SETTINGS_FILE);
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync /* store the config file name */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync unconst (mData.mCfgFile.mName) = vboxConfigFile;
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync /* lock the config file */
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync HRESULT rc = lockConfig();
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync if (SUCCEEDED (rc))
40becad9511726726c5959a8ad8b62fb3e1c020cvboxsync {
40becad9511726726c5959a8ad8b62fb3e1c020cvboxsync if (!isConfigLocked())
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync {
50453af238fcec34bf98f91cc4c32bf57f738bd3vboxsync /*
2c1d8cd8efdd4c486ff681135035d24111b03af8vboxsync * This means the config file not found. This is not fatal --
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync * we just create an empty one.
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync RTFILE handle = NIL_RTFILE;
eeb2d581c99b451fb1a26a5870af65981dc9cd5dvboxsync int vrc = RTFileOpen (&handle, vboxConfigFile,
f32de6c198a491c28ace2b4c53f8d04a79fd6d69vboxsync RTFILE_O_READWRITE | RTFILE_O_CREATE |
f32de6c198a491c28ace2b4c53f8d04a79fd6d69vboxsync RTFILE_O_DENY_WRITE);
0ce6ae9d6efed5d54222a13bbdabce9e688e4447vboxsync if (RT_SUCCESS (vrc))
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync vrc = RTFileWrite (handle,
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync (void *) gDefaultGlobalConfig,
c4d6c81bd0de216d0f42db2e477b1d788fbaefb4vboxsync sizeof (gDefaultGlobalConfig), NULL);
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync if (RT_FAILURE (vrc))
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync {
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync rc = setError (E_FAIL, tr ("Could not create the default settings file "
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync "'%s' (%Rrc)"),
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync vboxConfigFile.raw(), vrc);
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync }
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync else
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync {
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync mData.mCfgFile.mHandle = handle;
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync /* we do not close the file to simulate lockConfig() */
ea743ed8b8effc9f3647b76eb109c45788052fa0vboxsync }
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync }
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync }
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync if (SUCCEEDED (rc))
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync {
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync try
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync {
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync using namespace settings;
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync /* no concurrent file access is possible in init() so open by handle */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync File file (mData.mCfgFile.mHandle, vboxConfigFile);
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync XmlTreeBackend tree;
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync rc = VirtualBox::loadSettingsTree_FirstTime (tree, file,
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync mData.mSettingsFileVersion);
23ab2e25f17cdd6af9c0448ee70905a8c1c82896vboxsync CheckComRCThrowRC (rc);
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync Key global = tree.rootKey().key ("Global");
f6dde23cd488aee26203b38ec67220270f5c4273vboxsync
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync#ifdef VBOX_WITH_RESOURCE_USAGE_API
40becad9511726726c5959a8ad8b62fb3e1c020cvboxsync /* create the performance collector object BEFORE host */
40becad9511726726c5959a8ad8b62fb3e1c020cvboxsync unconst (mData.mPerformanceCollector).createObject();
43e9355f77c0463e7ace350984bb5a09fb8c50a1vboxsync rc = mData.mPerformanceCollector->init();
611af5c9fc04865215e86b6e4906c9dfdfb6a381vboxsync ComAssertComRCThrowRC (rc);
d07e901177d22a8f66c66f155c423a524ac07776vboxsync#endif /* VBOX_WITH_RESOURCE_USAGE_API */
d07e901177d22a8f66c66f155c423a524ac07776vboxsync
d07e901177d22a8f66c66f155c423a524ac07776vboxsync /* create the host object early, machines will need it */
d07e901177d22a8f66c66f155c423a524ac07776vboxsync unconst (mData.mHost).createObject();
d07e901177d22a8f66c66f155c423a524ac07776vboxsync rc = mData.mHost->init (this);
d07e901177d22a8f66c66f155c423a524ac07776vboxsync ComAssertComRCThrowRC (rc);
d07e901177d22a8f66c66f155c423a524ac07776vboxsync
f48fe310f85f13db0140bef980de1f56c2007957vboxsync rc = mData.mHost->loadSettings (global);
f48fe310f85f13db0140bef980de1f56c2007957vboxsync CheckComRCThrowRC (rc);
f48fe310f85f13db0140bef980de1f56c2007957vboxsync
f48fe310f85f13db0140bef980de1f56c2007957vboxsync /* create the system properties object */
1b186b95b77faa977d3651bbfc13afb3f13e0225vboxsync unconst (mData.mSystemProperties).createObject();
40becad9511726726c5959a8ad8b62fb3e1c020cvboxsync rc = mData.mSystemProperties->init (this);
0b10203d41681eb80716c97a34ed6c3b6d5318ccvboxsync ComAssertComRCThrowRC (rc);
611af5c9fc04865215e86b6e4906c9dfdfb6a381vboxsync
d4f7483a46e1c44ae5fcc4195be291545ae720a4vboxsync rc = mData.mSystemProperties->loadSettings (global);
d4f7483a46e1c44ae5fcc4195be291545ae720a4vboxsync CheckComRCThrowRC (rc);
d4f7483a46e1c44ae5fcc4195be291545ae720a4vboxsync
d4f7483a46e1c44ae5fcc4195be291545ae720a4vboxsync /* guest OS type objects, needed by machines */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync for (size_t i = 0; i < RT_ELEMENTS (Global::sOSTypes); ++ i)
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync {
f9cac318205d74ee5b35dabcf2bd39118f6293d7vboxsync ComObjPtr <GuestOSType> guestOSTypeObj;
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync rc = guestOSTypeObj.createObject();
d91dc86210d602f51a4701762488a5e696c80a45vboxsync if (SUCCEEDED (rc))
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync {
50453af238fcec34bf98f91cc4c32bf57f738bd3vboxsync rc = guestOSTypeObj->init (Global::sOSTypes [i].id,
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync Global::sOSTypes [i].description,
f9cac318205d74ee5b35dabcf2bd39118f6293d7vboxsync Global::sOSTypes [i].osType,
f9cac318205d74ee5b35dabcf2bd39118f6293d7vboxsync Global::sOSTypes [i].recommendedRAM,
4831e82ecaa3c813398d2f343e9d38ee34a3acf4vboxsync Global::sOSTypes [i].recommendedVRAM,
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync Global::sOSTypes [i].recommendedHDD);
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync if (SUCCEEDED (rc))
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync mData.mGuestOSTypes.push_back (guestOSTypeObj);
f7c0f913c4c22ee18059ff97055442566d0f14a1vboxsync }
db85b6b8ce514217c1fb35d04b0854a65dc299f3vboxsync ComAssertComRCThrowRC (rc);
db85b6b8ce514217c1fb35d04b0854a65dc299f3vboxsync }
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync /* all registered media, needed by machines */
3221ae1f7bf53d9cccdd578099f55f782dba1447vboxsync rc = loadMedia (global);
3221ae1f7bf53d9cccdd578099f55f782dba1447vboxsync CheckComRCThrowRC (rc);
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync /* machines */
8184f68cdef3c26869cdebc6a18829c854d0d17dvboxsync rc = loadMachines (global);
5e3a885d489b1c99d79d576813f8f321bae46927vboxsync CheckComRCThrowRC (rc);
/* check hard disk consistency */
/// @todo (r=dmik) add IVirtualBox::cleanupHardDisks() instead or similar
// for (HardDiskList::const_iterator it = mData.mHardDisks.begin();
// it != mData.mHardDisks.end() && SUCCEEDED (rc);
// ++ it)
// {
// rc = (*it)->checkConsistency();
// }
// CheckComRCBreakRC ((rc));
/// @todo (dmik) if successful, check for orphan (unused) diffs
// that might be left because of the server crash, and remove
// Hmm, is it the same remark as above?..
}
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 (mWatcherData.mUpdateReq) = ::CreateEvent (NULL, FALSE, FALSE, NULL);
#elif defined(RT_OS_OS2)
RTSemEventCreate (&unconst (mWatcherData.mUpdateReq));
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
RTSemEventCreate (&unconst (mWatcherData.mUpdateReq));
#else
# error "Port me!"
#endif
int vrc = RTThreadCreate (&unconst (mWatcherData.mThread),
ClientWatcher, (void *) this,
0, RTTHREADTYPE_MAIN_WORKER,
RTTHREADFLAGS_WAITABLE, "Watcher");
ComAssertRC (vrc);
if (RT_FAILURE (vrc))
rc = E_FAIL;
}
if (SUCCEEDED (rc)) do
{
/* start the async event handler thread */
int vrc = RTThreadCreate (&unconst (mAsyncEventThread), AsyncEventHandler,
&unconst (mAsyncEventQ),
0, RTTHREADTYPE_MAIN_WORKER,
RTTHREADFLAGS_WAITABLE, "EventHandler");
ComAssertRCBreak (vrc, rc = E_FAIL);
/* wait until the thread sets mAsyncEventQ */
RTThreadUserWait (mAsyncEventThread, RT_INDEFINITE_WAIT);
ComAssertBreak (mAsyncEventQ, rc = E_FAIL);
}
while (0);
/* Confirm a successful initialization when it's the case */
if (SUCCEEDED (rc))
autoInitSpan.setSucceeded();
LogFlowThisFunc (("rc=%08X\n", rc));
LogFlowThisFuncLeave();
LogFlow (("===========================================================\n"));
return rc;
}
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", mData.mMachines.size()));
if (mData.mMachines.size())
{
MachineList::iterator it = mData.mMachines.begin();
while (it != mData.mMachines.end())
(*it++)->uninit();
mData.mMachines.clear();
}
if (mData.mSystemProperties)
{
mData.mSystemProperties->uninit();
unconst (mData.mSystemProperties).setNull();
}
if (mData.mHost)
{
mData.mHost->uninit();
unconst (mData.mHost).setNull();
}
#ifdef VBOX_WITH_RESOURCE_USAGE_API
if (mData.mPerformanceCollector)
{
mData.mPerformanceCollector->uninit();
unconst (mData.mPerformanceCollector).setNull();
}
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
/* Uninit all other children still referenced by clients (unregistered
* machines, hard disks, DVD/floppy images, server-side progress
* operations). */
uninitDependentChildren();
mData.mHardDisk2Map.clear();
mData.mFloppyImages2.clear();
mData.mDVDImages2.clear();
mData.mHardDisks2.clear();
mData.mProgressOperations.clear();
mData.mGuestOSTypes.clear();
/* unlock the config file */
unlockConfig();
LogFlowThisFunc (("Releasing callbacks...\n"));
if (mData.mCallbacks.size())
{
/* release all callbacks */
LogWarningFunc (("%d unregistered callbacks!\n",
mData.mCallbacks.size()));
mData.mCallbacks.clear();
}
LogFlowThisFunc (("Terminating the async event handler...\n"));
if (mAsyncEventThread != NIL_RTTHREAD)
{
/* signal to exit the event loop */
if (mAsyncEventQ->postEvent (NULL))
{
/*
* Wait for thread termination (only if we've successfully posted
* a NULL event!)
*/
int vrc = RTThreadWait (mAsyncEventThread, 60000, NULL);
if (RT_FAILURE (vrc))
LogWarningFunc (("RTThreadWait(%RTthrd) -> %Rrc\n",
mAsyncEventThread, vrc));
}
else
{
AssertMsgFailed (("postEvent(NULL) failed\n"));
RTThreadWait (mAsyncEventThread, 0, NULL);
}
unconst (mAsyncEventThread) = NIL_RTTHREAD;
unconst (mAsyncEventQ) = NULL;
}
LogFlowThisFunc (("Terminating the client watcher...\n"));
if (mWatcherData.mThread != NIL_RTTHREAD)
{
/* signal the client watcher thread */
updateClientWatcher();
/* wait for the termination */
RTThreadWait (mWatcherData.mThread, RT_INDEFINITE_WAIT, NULL);
unconst (mWatcherData.mThread) = NIL_RTTHREAD;
}
mWatcherData.mProcesses.clear();
#if defined(RT_OS_WINDOWS)
if (mWatcherData.mUpdateReq != NULL)
{
::CloseHandle (mWatcherData.mUpdateReq);
unconst (mWatcherData.mUpdateReq) = NULL;
}
#elif defined(RT_OS_OS2)
if (mWatcherData.mUpdateReq != NIL_RTSEMEVENT)
{
RTSemEventDestroy (mWatcherData.mUpdateReq);
unconst (mWatcherData.mUpdateReq) = NIL_RTSEMEVENT;
}
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
if (mWatcherData.mUpdateReq != NIL_RTSEMEVENT)
{
RTSemEventDestroy (mWatcherData.mUpdateReq);
unconst (mWatcherData.mUpdateReq) = NIL_RTSEMEVENT;
}
#else
# error "Port me!"
#endif
LogFlowThisFuncLeave();
LogFlow (("===========================================================\n"));
}
// IVirtualBox properties
/////////////////////////////////////////////////////////////////////////////
STDMETHODIMP VirtualBox::COMGETTER(Version) (BSTR *aVersion)
{
if (!aVersion)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
sVersion.cloneTo (aVersion);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(Revision) (ULONG *aRevision)
{
if (!aRevision)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
*aRevision = sRevision;
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(PackageType) (BSTR *aPackageType)
{
if (!aPackageType)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
sPackageType.cloneTo (aPackageType);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(HomeFolder) (BSTR *aHomeFolder)
{
if (!aHomeFolder)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* mHomeDir is const and doesn't need a lock */
mData.mHomeDir.cloneTo (aHomeFolder);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(SettingsFilePath) (BSTR *aSettingsFilePath)
{
if (!aSettingsFilePath)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* mCfgFile.mName is const and doesn't need a lock */
mData.mCfgFile.mName.cloneTo (aSettingsFilePath);
return S_OK;
}
STDMETHODIMP VirtualBox::
COMGETTER(SettingsFileVersion) (BSTR *aSettingsFileVersion)
{
if (!aSettingsFileVersion)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReadLock alock (this);
mData.mSettingsFileVersion.cloneTo (aSettingsFileVersion);
return S_OK;
}
STDMETHODIMP VirtualBox::
COMGETTER(SettingsFormatVersion) (BSTR *aSettingsFormatVersion)
{
if (!aSettingsFormatVersion)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
sSettingsFormatVersion.cloneTo (aSettingsFormatVersion);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(Host) (IHost **aHost)
{
if (!aHost)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* mHost is const, no need to lock */
mData.mHost.queryInterfaceTo (aHost);
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(SystemProperties) (ISystemProperties **aSystemProperties)
{
if (!aSystemProperties)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* mSystemProperties is const, no need to lock */
mData.mSystemProperties.queryInterfaceTo (aSystemProperties);
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(Machines2) (ComSafeArrayOut (IMachine *, aMachines))
{
if (ComSafeArrayOutIsNull (aMachines))
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReadLock alock (this);
SafeIfaceArray <IMachine> machines (mData.mMachines);
machines.detachTo (ComSafeArrayOutArg (aMachines));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(HardDisks2) (ComSafeArrayOut (IHardDisk2 *, aHardDisks))
{
if (ComSafeArrayOutIsNull (aHardDisks))
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReadLock alock (this);
SafeIfaceArray <IHardDisk2> hardDisks (mData.mHardDisks2);
hardDisks.detachTo (ComSafeArrayOutArg (aHardDisks));
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(DVDImages) (ComSafeArrayOut (IDVDImage2 *, aDVDImages))
{
if (ComSafeArrayOutIsNull (aDVDImages))
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReadLock alock (this);
SafeIfaceArray <IDVDImage2> images (mData.mDVDImages2);
images.detachTo (ComSafeArrayOutArg (aDVDImages));
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(FloppyImages) (ComSafeArrayOut (IFloppyImage2 *, aFloppyImages))
{
if (ComSafeArrayOutIsNull (aFloppyImages))
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReadLock alock (this);
SafeIfaceArray <IFloppyImage2> images (mData.mFloppyImages2);
images.detachTo (ComSafeArrayOutArg (aFloppyImages));
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(ProgressOperations) (IProgressCollection **aOperations)
{
if (!aOperations)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComObjPtr <ProgressCollection> collection;
collection.createObject();
/* protect mProgressOperations */
AutoReadLock safeLock (mSafeLock);
collection->init (mData.mProgressOperations);
collection.queryInterfaceTo (aOperations);
return S_OK;
}
STDMETHODIMP VirtualBox::COMGETTER(GuestOSTypes) (IGuestOSTypeCollection **aGuestOSTypes)
{
if (!aGuestOSTypes)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComObjPtr <GuestOSTypeCollection> collection;
collection.createObject();
AutoReadLock alock (this);
collection->init (mData.mGuestOSTypes);
collection.queryInterfaceTo (aGuestOSTypes);
return S_OK;
}
STDMETHODIMP
VirtualBox::COMGETTER(SharedFolders) (ISharedFolderCollection **aSharedFolders)
{
if (!aSharedFolders)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
return setError (E_NOTIMPL, "Not yet implemented");
}
STDMETHODIMP
VirtualBox::COMGETTER(PerformanceCollector) (IPerformanceCollector **aPerformanceCollector)
{
#ifdef VBOX_WITH_RESOURCE_USAGE_API
if (!aPerformanceCollector)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* mPerformanceCollector is const, no need to lock */
mData.mPerformanceCollector.queryInterfaceTo (aPerformanceCollector);
return S_OK;
#else /* !VBOX_WITH_RESOURCE_USAGE_API */
return E_NOTIMPL;
#endif /* !VBOX_WITH_RESOURCE_USAGE_API */
}
// IVirtualBox methods
/////////////////////////////////////////////////////////////////////////////
/** @note Locks mSystemProperties object for reading. */
STDMETHODIMP VirtualBox::CreateMachine (INPTR BSTR aBaseFolder,
INPTR BSTR aName,
INPTR GUIDPARAM aId,
IMachine **aMachine)
{
LogFlowThisFuncEnter();
LogFlowThisFunc (("aBaseFolder='%ls', aName='%ls' aMachine={%p}\n",
aBaseFolder, aName, aMachine));
if (!aName)
return E_INVALIDARG;
if (!aMachine)
return E_POINTER;
if (!*aName)
return setError (E_INVALIDARG,
tr ("Machine name cannot be empty"));
AutoCaller autoCaller (this);
CheckComRCReturnRC (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.
*/
Bstr settingsFile = aBaseFolder;
if (settingsFile.isEmpty())
{
AutoReadLock propsLock (systemProperties());
/* we use the non-full folder value below to keep the path relative */
settingsFile = systemProperties()->defaultMachineFolder();
}
settingsFile = Utf8StrFmt ("%ls%c%ls%c%ls.xml",
settingsFile.raw(), RTPATH_DELIMITER,
aName, RTPATH_DELIMITER, aName);
HRESULT rc = E_FAIL;
/* create a new object */
ComObjPtr <Machine> machine;
rc = machine.createObject();
if (SUCCEEDED (rc))
{
/* Create UUID if an empty one was specified. */
Guid id = aId;
if (id.isEmpty())
id.create();
/* initialize the machine object */
rc = machine->init (this, settingsFile, Machine::Init_New, aName, TRUE, &id);
if (SUCCEEDED (rc))
{
/* set the return value */
rc = machine.queryInterfaceTo (aMachine);
ComAssertComRC (rc);
}
}
LogFlowThisFunc (("rc=%08X\n", rc));
LogFlowThisFuncLeave();
return rc;
}
STDMETHODIMP VirtualBox::CreateLegacyMachine (INPTR BSTR aSettingsFile,
INPTR BSTR aName,
INPTR GUIDPARAM aId,
IMachine **aMachine)
{
/* null and empty strings are not allowed as path names */
if (!aSettingsFile || !(*aSettingsFile))
return E_INVALIDARG;
if (!aName)
return E_INVALIDARG;
if (!aMachine)
return E_POINTER;
if (!*aName)
return setError (E_INVALIDARG,
tr ("Machine name cannot be empty"));
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
HRESULT rc = E_FAIL;
Utf8Str settingsFile = aSettingsFile;
/* append the default extension if none */
if (!RTPathHaveExt (settingsFile))
settingsFile = Utf8StrFmt ("%s.xml", settingsFile.raw());
/* create a new object */
ComObjPtr<Machine> machine;
rc = machine.createObject();
if (SUCCEEDED (rc))
{
/* Create UUID if an empty one was specified. */
Guid id = aId;
if (id.isEmpty())
id.create();
/* initialize the machine object */
rc = machine->init (this, Bstr (settingsFile), Machine::Init_New,
aName, FALSE /* aNameSync */, &id);
if (SUCCEEDED (rc))
{
/* set the return value */
rc = machine.queryInterfaceTo (aMachine);
ComAssertComRC (rc);
}
}
return rc;
}
STDMETHODIMP VirtualBox::OpenMachine (INPTR BSTR aSettingsFile,
IMachine **aMachine)
{
/* null and empty strings are not allowed as path names */
if (!aSettingsFile || !(*aSettingsFile))
return E_INVALIDARG;
if (!aMachine)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (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, Machine::Init_Existing);
if (SUCCEEDED (rc))
{
/* set the return value */
rc = machine.queryInterfaceTo (aMachine);
ComAssertComRC (rc);
}
}
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::RegisterMachine (IMachine *aMachine)
{
if (!aMachine)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
HRESULT rc;
Bstr name;
rc = aMachine->COMGETTER(Name) (name.asOutParam());
CheckComRCReturnRC (rc);
/*
* we can safely cast child to Machine * here because only Machine
* implementations of IMachine can be among our children
*/
Machine *machine = static_cast <Machine *> (getDependentChild (aMachine));
if (!machine)
{
/*
* this machine was not created by CreateMachine()
* or opened by OpenMachine() or loaded during startup
*/
return setError (E_FAIL,
tr ("The machine named '%ls' is not created within this "
"VirtualBox instance"), name.raw());
}
AutoCaller machCaller (machine);
ComAssertComRCRetRC (machCaller.rc());
rc = registerMachine (machine);
/* fire an event */
if (SUCCEEDED (rc))
onMachineRegistered (machine->id(), TRUE);
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::GetMachine (INPTR GUIDPARAM aId, IMachine **aMachine)
{
if (!aMachine)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComObjPtr <Machine> machine;
HRESULT rc = findMachine (Guid (aId), 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 (INPTR BSTR aName, IMachine **aMachine)
{
LogFlowThisFuncEnter();
LogFlowThisFunc (("aName=\"%ls\", aMachine={%p}\n", aName, aMachine));
if (!aName)
return E_INVALIDARG;
if (!aMachine)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* start with not found */
ComObjPtr <Machine> machine;
MachineList machines;
{
/* take a copy for safe iteration outside the lock */
AutoReadLock alock (this);
machines = mData.mMachines;
}
for (MachineList::iterator it = machines.begin();
!machine && it != machines.end();
++ it)
{
AutoLimitedCaller machCaller (*it);
AssertComRC (machCaller.rc());
/* skip inaccessible machines */
if (machCaller.state() == Machine::Ready)
{
AutoReadLock machLock (*it);
if ((*it)->name() == aName)
machine = *it;
}
}
/* this will set (*machine) to NULL if machineObj is null */
machine.queryInterfaceTo (aMachine);
HRESULT rc = machine
? S_OK
: setError (E_INVALIDARG,
tr ("Could not find a registered machine named '%ls'"), aName);
LogFlowThisFunc (("rc=%08X\n", rc));
LogFlowThisFuncLeave();
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::UnregisterMachine (INPTR GUIDPARAM aId,
IMachine **aMachine)
{
Guid id = aId;
if (id.isEmpty())
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoWriteLock alock (this);
ComObjPtr <Machine> machine;
HRESULT rc = findMachine (id, true /* setError */, &machine);
CheckComRCReturnRC (rc);
rc = machine->trySetRegistered (FALSE);
CheckComRCReturnRC (rc);
/* remove from the collection of registered machines */
mData.mMachines.remove (machine);
/* save the global registry */
rc = saveSettings();
/* return the unregistered machine to the caller */
machine.queryInterfaceTo (aMachine);
/* fire an event */
onMachineRegistered (id, FALSE);
return rc;
}
STDMETHODIMP VirtualBox::CreateHardDisk2 (INPTR BSTR aFormat,
INPTR BSTR aLocation,
IHardDisk2 **aHardDisk)
{
if (!aFormat)
return E_INVALIDARG;
if (!aLocation)
return E_INVALIDARG;
if (!aHardDisk)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* we don't access non-const data members so no need to lock */
HRESULT rc = E_FAIL;
ComObjPtr <HardDisk2> hardDisk;
hardDisk.createObject();
rc = hardDisk->init (this, aFormat, aLocation);
if (SUCCEEDED (rc))
hardDisk.queryInterfaceTo (aHardDisk);
return rc;
}
STDMETHODIMP VirtualBox::OpenHardDisk2 (INPTR BSTR aLocation,
IHardDisk2 **aHardDisk)
{
if (!aLocation)
return E_INVALIDARG;
if (!aHardDisk)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* we don't access non-const data members so no need to lock */
HRESULT rc = E_FAIL;
ComObjPtr <HardDisk2> hardDisk;
hardDisk.createObject();
rc = hardDisk->init (this, aLocation);
if (SUCCEEDED (rc))
{
rc = registerHardDisk2 (hardDisk);
/* 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();
}
return rc;
}
STDMETHODIMP VirtualBox::GetHardDisk2 (INPTR GUIDPARAM aId,
IHardDisk2 **aHardDisk)
{
if (!aHardDisk)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id = aId;
ComObjPtr <HardDisk2> hardDisk;
HRESULT rc = findHardDisk2 (&id, NULL, true /* setError */, &hardDisk);
/* the below will set *aHardDisk to NULL if hardDisk is null */
hardDisk.queryInterfaceTo (aHardDisk);
return rc;
}
STDMETHODIMP VirtualBox::FindHardDisk2 (INPTR BSTR aLocation,
IHardDisk2 **aHardDisk)
{
if (!aLocation)
return E_INVALIDARG;
if (!aHardDisk)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComObjPtr <HardDisk2> hardDisk;
HRESULT rc = findHardDisk2 (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 (INPTR BSTR aLocation, INPTR GUIDPARAM aId,
IDVDImage2 **aDVDImage)
{
/* null and empty strings are not allowed as path names */
if (!aLocation || !(*aLocation))
return E_INVALIDARG;
if (!aDVDImage)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
HRESULT rc = E_FAIL;
Guid id = aId;
/* generate an UUID if not specified */
if (id.isEmpty())
id.create();
ComObjPtr <DVDImage2> image;
image.createObject();
rc = image->init (this, aLocation, id);
if (SUCCEEDED (rc))
{
rc = registerDVDImage (image);
if (SUCCEEDED (rc))
image.queryInterfaceTo (aDVDImage);
}
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::GetDVDImage (INPTR GUIDPARAM aId, IDVDImage2 **aDVDImage)
{
if (!aDVDImage)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id = aId;
ComObjPtr <DVDImage2> image;
HRESULT rc = findDVDImage2 (&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 (INPTR BSTR aLocation, IDVDImage2 **aDVDImage)
{
if (!aLocation)
return E_INVALIDARG;
if (!aDVDImage)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComObjPtr <DVDImage2> image;
HRESULT rc = findDVDImage2 (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 (INPTR BSTR aLocation, INPTR GUIDPARAM aId,
IFloppyImage2 **aFloppyImage)
{
/* null and empty strings are not allowed as path names */
if (!aLocation || !(*aLocation))
return E_INVALIDARG;
if (!aFloppyImage)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
HRESULT rc = E_FAIL;
Guid id = aId;
/* generate an UUID if not specified */
if (id.isEmpty())
id.create();
ComObjPtr <FloppyImage2> image;
image.createObject();
rc = image->init (this, aLocation, id);
if (SUCCEEDED (rc))
{
rc = registerFloppyImage (image);
if (SUCCEEDED (rc))
image.queryInterfaceTo (aFloppyImage);
}
return rc;
}
/** @note Locks objects! */
STDMETHODIMP VirtualBox::GetFloppyImage (INPTR GUIDPARAM aId,
IFloppyImage2 **aFloppyImage)
{
if (!aFloppyImage)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id = aId;
ComObjPtr <FloppyImage2> image;
HRESULT rc = findFloppyImage2 (&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 (INPTR BSTR aLocation,
IFloppyImage2 **aFloppyImage)
{
if (!aLocation)
return E_INVALIDARG;
if (!aFloppyImage)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComObjPtr <FloppyImage2> image;
HRESULT rc = findFloppyImage2 (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 (INPTR BSTR aId, IGuestOSType **aType)
{
if (!aType)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
*aType = NULL;
AutoReadLock alock (this);
for (GuestOSTypeList::iterator it = mData.mGuestOSTypes.begin();
it != mData.mGuestOSTypes.end();
++ it)
{
const Bstr &typeId = (*it)->id();
AssertMsg (!!typeId, ("ID must not be NULL"));
if (typeId == aId)
{
(*it).queryInterfaceTo (aType);
break;
}
}
return (*aType) ? S_OK :
setError (E_INVALIDARG,
tr ("'%ls' is not a valid Guest OS type"),
aId);
}
STDMETHODIMP
VirtualBox::CreateSharedFolder (INPTR BSTR aName, INPTR BSTR aHostPath, BOOL aWritable)
{
if (!aName || !aHostPath)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
return setError (E_NOTIMPL, "Not yet implemented");
}
STDMETHODIMP VirtualBox::RemoveSharedFolder (INPTR BSTR aName)
{
if (!aName)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
return setError (E_NOTIMPL, "Not yet implemented");
}
/**
* @note Locks this object for reading.
*/
STDMETHODIMP VirtualBox::
GetNextExtraDataKey (INPTR BSTR aKey, BSTR *aNextKey, BSTR *aNextValue)
{
if (!aNextKey)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* start with nothing found */
*aNextKey = NULL;
if (aNextValue)
*aNextValue = NULL;
HRESULT rc = S_OK;
/* serialize file access (prevent writes) */
AutoReadLock alock (this);
try
{
using namespace settings;
/* load the settings file (we don't reuse the existing handle but
* request a new one to allow for concurrent multithreaded reads) */
File file (File::Mode_Read, Utf8Str (mData.mCfgFile.mName));
XmlTreeBackend tree;
rc = VirtualBox::loadSettingsTree_Again (tree, file);
CheckComRCReturnRC (rc);
Key globalNode = tree.rootKey().key ("Global");
Key extraDataNode = globalNode.findKey ("ExtraData");
if (!extraDataNode.isNull())
{
Key::List items = extraDataNode.keys ("ExtraDataItem");
if (items.size())
{
for (Key::List::const_iterator it = items.begin();
it != items.end(); ++ it)
{
Bstr key = (*it).stringValue ("name");
/* if we're supposed to return the first one */
if (aKey == NULL)
{
key.cloneTo (aNextKey);
if (aNextValue)
{
Bstr val = (*it).stringValue ("value");
val.cloneTo (aNextValue);
}
return S_OK;
}
/* did we find the key we're looking for? */
if (key == aKey)
{
++ it;
/* is there another item? */
if (it != items.end())
{
Bstr key = (*it).stringValue ("name");
key.cloneTo (aNextKey);
if (aNextValue)
{
Bstr val = (*it).stringValue ("value");
val.cloneTo (aNextValue);
}
}
/* else it's the last one, arguments are already NULL */
return S_OK;
}
}
}
}
/* Here we are when a) there are no items at all or b) there are items
* but none of them equals to the requested non-NULL key. b) is an
* error as well as a) if the key is non-NULL. When the key is NULL
* (which is the case only when there are no items), we just fall
* through to return NULLs and S_OK. */
if (aKey != NULL)
return setError (E_FAIL,
tr ("Could not find the extra data key '%ls'"), aKey);
}
catch (...)
{
rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
}
return rc;
}
/**
* @note Locks this object for reading.
*/
STDMETHODIMP VirtualBox::GetExtraData (INPTR BSTR aKey, BSTR *aValue)
{
if (!aKey)
return E_INVALIDARG;
if (!aValue)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* start with nothing found */
*aValue = NULL;
HRESULT rc = S_OK;
/* serialize file access (prevent writes) */
AutoReadLock alock (this);
try
{
using namespace settings;
/* load the settings file (we don't reuse the existing handle but
* request a new one to allow for concurrent multithreaded reads) */
File file (File::Mode_Read, Utf8Str (mData.mCfgFile.mName));
XmlTreeBackend tree;
rc = VirtualBox::loadSettingsTree_Again (tree, file);
CheckComRCReturnRC (rc);
const Utf8Str key = aKey;
Key globalNode = tree.rootKey().key ("Global");
Key extraDataNode = globalNode.findKey ("ExtraData");
if (!extraDataNode.isNull())
{
/* check if the key exists */
Key::List items = extraDataNode.keys ("ExtraDataItem");
for (Key::List::const_iterator it = items.begin();
it != items.end(); ++ it)
{
if (key == (*it).stringValue ("name"))
{
Bstr val = (*it).stringValue ("value");
val.cloneTo (aValue);
break;
}
}
}
}
catch (...)
{
rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
}
return rc;
}
/**
* @note Locks this object for writing.
*/
STDMETHODIMP VirtualBox::SetExtraData (INPTR BSTR aKey, INPTR BSTR aValue)
{
if (!aKey)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid emptyGuid;
bool changed = false;
HRESULT rc = S_OK;
/* serialize file access (prevent concurrent reads and writes) */
AutoWriteLock alock (this);
try
{
using namespace settings;
/* load the settings file */
File file (mData.mCfgFile.mHandle, Utf8Str (mData.mCfgFile.mName));
XmlTreeBackend tree;
rc = VirtualBox::loadSettingsTree_ForUpdate (tree, file);
CheckComRCReturnRC (rc);
const Utf8Str key = aKey;
Bstr oldVal;
Key globalNode = tree.rootKey().key ("Global");
Key extraDataNode = globalNode.createKey ("ExtraData");
Key extraDataItemNode;
Key::List items = extraDataNode.keys ("ExtraDataItem");
for (Key::List::const_iterator it = items.begin();
it != items.end(); ++ it)
{
if (key == (*it).stringValue ("name"))
{
extraDataItemNode = *it;
oldVal = (*it).stringValue ("value");
break;
}
}
/* When no key is found, oldVal is null */
changed = oldVal != aValue;
if (changed)
{
/* ask for permission from all listeners */
Bstr error;
if (!onExtraDataCanChange (Guid::Empty, aKey, aValue, error))
{
const char *sep = error.isEmpty() ? "" : ": ";
const BSTR err = error.isNull() ? (const BSTR) L"" : 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, aValue, sep, err);
}
if (aValue != NULL)
{
if (extraDataItemNode.isNull())
{
extraDataItemNode = extraDataNode.appendKey ("ExtraDataItem");
extraDataItemNode.setStringValue ("name", key);
}
extraDataItemNode.setStringValue ("value", Utf8Str (aValue));
}
else
{
/* an old value does for sure exist here (XML schema
* guarantees that "value" may not absent in the
* <ExtraDataItem> element) */
Assert (!extraDataItemNode.isNull());
extraDataItemNode.zap();
}
/* save settings on success */
rc = VirtualBox::saveSettingsTree (tree, file,
mData.mSettingsFileVersion);
CheckComRCReturnRC (rc);
}
}
catch (...)
{
rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
}
/* fire a notification */
if (SUCCEEDED (rc) && changed)
onExtraDataChange (Guid::Empty, aKey, aValue);
return rc;
}
/**
* @note Locks objects!
*/
STDMETHODIMP VirtualBox::OpenSession (ISession *aSession, INPTR GUIDPARAM aMachineId)
{
if (!aSession)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id = aMachineId;
ComObjPtr <Machine> machine;
HRESULT rc = findMachine (id, true /* setError */, &machine);
CheckComRCReturnRC (rc);
/* check the session state */
SessionState_T state;
rc = aSession->COMGETTER(State) (&state);
CheckComRCReturnRC (rc);
if (state != SessionState_Closed)
return setError (E_INVALIDARG,
tr ("The given session is already open or being opened"));
/* get the IInternalSessionControl interface */
ComPtr <IInternalSessionControl> control = aSession;
ComAssertMsgRet (!!control, ("No IInternalSessionControl interface"),
E_INVALIDARG);
rc = machine->openSession (control);
if (SUCCEEDED (rc))
{
/*
* tell the client watcher thread to update the set of
* machines that have open sessions
*/
updateClientWatcher();
/* fire an event */
onSessionStateChange (aMachineId, SessionState_Open);
}
return rc;
}
/**
* @note Locks objects!
*/
STDMETHODIMP VirtualBox::OpenRemoteSession (ISession *aSession,
INPTR GUIDPARAM aMachineId,
INPTR BSTR aType,
INPTR BSTR aEnvironment,
IProgress **aProgress)
{
if (!aSession || !aType)
return E_INVALIDARG;
if (!aProgress)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id = aMachineId;
ComObjPtr <Machine> machine;
HRESULT rc = findMachine (id, true /* setError */, &machine);
CheckComRCReturnRC (rc);
/* check the session state */
SessionState_T state;
rc = aSession->COMGETTER(State) (&state);
CheckComRCReturnRC (rc);
if (state != SessionState_Closed)
return setError (E_INVALIDARG,
tr ("The given session is already open or being opened"));
/* get the IInternalSessionControl interface */
ComPtr <IInternalSessionControl> control = aSession;
ComAssertMsgRet (!!control, ("No IInternalSessionControl interface"),
E_INVALIDARG);
/* create a progress object */
ComObjPtr <Progress> progress;
progress.createObject();
progress->init (this, static_cast <IMachine *> (machine),
Bstr (tr ("Spawning session")),
FALSE /* aCancelable */);
rc = machine->openRemoteSession (control, aType, aEnvironment, progress);
if (SUCCEEDED (rc))
{
progress.queryInterfaceTo (aProgress);
/* signal the client watcher thread */
updateClientWatcher();
/* fire an event */
onSessionStateChange (aMachineId, SessionState_Spawning);
}
return rc;
}
/**
* @note Locks objects!
*/
STDMETHODIMP VirtualBox::OpenExistingSession (ISession *aSession,
INPTR GUIDPARAM aMachineId)
{
if (!aSession)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id = aMachineId;
ComObjPtr <Machine> machine;
HRESULT rc = findMachine (id, true /* setError */, &machine);
CheckComRCReturnRC (rc);
/* check the session state */
SessionState_T state;
rc = aSession->COMGETTER(State) (&state);
CheckComRCReturnRC (rc);
if (state != SessionState_Closed)
return setError (E_INVALIDARG,
tr ("The given session is already open or being opened"));
/* get the IInternalSessionControl interface */
ComPtr <IInternalSessionControl> control = aSession;
ComAssertMsgRet (!!control, ("No IInternalSessionControl interface"),
E_INVALIDARG);
rc = machine->openExistingSession (control);
return rc;
}
/**
* @note Locks this object for writing.
*/
STDMETHODIMP VirtualBox::RegisterCallback (IVirtualBoxCallback *aCallback)
{
LogFlowThisFunc (("aCallback=%p\n", aCallback));
if (!aCallback)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoWriteLock alock (this);
mData.mCallbacks.push_back (CallbackList::value_type (aCallback));
return S_OK;
}
/**
* @note Locks this object for writing.
*/
STDMETHODIMP VirtualBox::UnregisterCallback (IVirtualBoxCallback *aCallback)
{
if (!aCallback)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
HRESULT rc = S_OK;
AutoWriteLock alock (this);
CallbackList::iterator it;
it = std::find (mData.mCallbacks.begin(),
mData.mCallbacks.end(),
CallbackList::value_type (aCallback));
if (it == mData.mCallbacks.end())
rc = E_INVALIDARG;
else
mData.mCallbacks.erase (it);
LogFlowThisFunc (("aCallback=%p, rc=%08X\n", aCallback, rc));
return rc;
}
STDMETHODIMP VirtualBox::WaitForPropertyChange (INPTR BSTR aWhat, ULONG aTimeout,
BSTR *aChanged, BSTR *aValues)
{
return E_NOTIMPL;
}
STDMETHODIMP VirtualBox::SaveSettings()
{
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
return saveSettings();
}
STDMETHODIMP VirtualBox::SaveSettingsWithBackup (BSTR *aBakFileName)
{
if (!aBakFileName)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* saveSettings() needs write lock */
AutoWriteLock alock (this);
/* perform backup only when there was auto-conversion */
if (mData.mSettingsFileVersion != VBOX_XML_VERSION_FULL)
{
Bstr bakFileName;
HRESULT rc = backupSettingsFile (mData.mCfgFile.mName,
mData.mSettingsFileVersion,
bakFileName);
CheckComRCReturnRC (rc);
bakFileName.cloneTo (aBakFileName);
}
return saveSettings();
}
// public methods only for internal purposes
/////////////////////////////////////////////////////////////////////////////
/**
* 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 (mAsyncEventQ, E_FAIL);
if (mAsyncEventQ->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 Peration to add to the collection.
*
* @note Doesn't lock objects.
*/
HRESULT VirtualBox::addProgress (IProgress *aProgress)
{
if (!aProgress)
return E_INVALIDARG;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
Guid id;
HRESULT rc = aProgress->COMGETTER(Id) (id.asOutParam());
AssertComRCReturnRC (rc);
/* protect mProgressOperations */
AutoWriteLock safeLock (mSafeLock);
mData.mProgressOperations.insert (ProgressMap::value_type (id, aProgress));
return S_OK;
}
/**
* Removes the progress from the global collection of pending operations.
* Usualy gets called upon progress completion.
*
* @param aId UUID of the progress operation to remove
*
* @note Doesn't lock objects.
*/
HRESULT VirtualBox::removeProgress (INPTR GUIDPARAM aId)
{
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
ComPtr <IProgress> progress;
/* protect mProgressOperations */
AutoWriteLock safeLock (mSafeLock);
size_t cnt = mData.mProgressOperations.erase (aId);
Assert (cnt == 1);
return S_OK;
}
#ifdef RT_OS_WINDOWS
struct StartSVCHelperClientData
{
ComObjPtr <VirtualBox> that;
ComObjPtr <Progress> progress;
bool privileged;
VirtualBox::SVCHelperClientFunc func;
void *user;
};
/**
* Helper method to that starts a worker thread that:
* - creates a pipe communication channel using SVCHlpClient;
* - starts a 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 prgress 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 stared, the communication channel passed to in
* the \a aClient argument, is fully set up, the function should start using
* it's 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
* a 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 Hepler process as a privlieged
* 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);
CheckComRCReturnRC (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");
ComAssertMsgRCRet (vrc, ("Could not create SVCHelper thread (%Rrc)\n", vrc),
E_FAIL);
/* 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\\{%Ruuid}",
id.raw()));
if (RT_FAILURE (vrc))
{
rc = 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);
ComAssertBreak (exePath, E_FAIL);
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 = setError (E_FAIL,
tr ("Operatiion cancelled by the user"));
else
rc = setError (E_FAIL,
tr ("Could not launch a privileged process '%s' (%Rrc)"),
exePath, vrc2);
break;
}
}
else
{
const char *args[] = { exePath, "/Helper", client.name(), 0 };
vrc = RTProcCreate (exePath, args, RTENV_DEFAULT, 0, &pid);
if (RT_FAILURE (vrc))
{
rc = 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 = 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);
AssertComRCReturn (autoCaller.rc(), (void) 0);
AssertReturn (mWatcherData.mThread != NIL_RTTHREAD, (void) 0);
/* sent an update request */
#if defined(RT_OS_WINDOWS)
::SetEvent (mWatcherData.mUpdateReq);
#elif defined(RT_OS_OS2)
RTSemEventSignal (mWatcherData.mUpdateReq);
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
RTSemEventSignal (mWatcherData.mUpdateReq);
#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);
AssertComRCReturn (autoCaller.rc(), (void) 0);
/// @todo (dmik) Win32?
#ifndef RT_OS_WINDOWS
AutoWriteLock alock (this);
mWatcherData.mProcesses.push_back (pid);
#endif
}
/** Event for onMachineStateChange(), onMachineDataChange(), onMachineRegistered() */
struct MachineEvent : public VirtualBox::CallbackEvent
{
enum What { DataChanged, StateChanged, Registered };
MachineEvent (VirtualBox *aVB, const Guid &aId)
: CallbackEvent (aVB), what (DataChanged), id (aId)
{}
MachineEvent (VirtualBox *aVB, const Guid &aId, MachineState_T aState)
: CallbackEvent (aVB), what (StateChanged), id (aId)
, state (aState)
{}
MachineEvent (VirtualBox *aVB, const Guid &aId, BOOL aRegistered)
: CallbackEvent (aVB), what (Registered), id (aId)
, registered (aRegistered)
{}
void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback)
{
switch (what)
{
case DataChanged:
LogFlow (("OnMachineDataChange: id={%Ruuid}\n", id.ptr()));
aCallback->OnMachineDataChange (id);
break;
case StateChanged:
LogFlow (("OnMachineStateChange: id={%Ruuid}, state=%d\n",
id.ptr(), state));
aCallback->OnMachineStateChange (id, state);
break;
case Registered:
LogFlow (("OnMachineRegistered: id={%Ruuid}, registered=%d\n",
id.ptr(), registered));
aCallback->OnMachineRegistered (id, registered);
break;
}
}
const What what;
Guid 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, INPTR BSTR aKey, INPTR 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());
CallbackList list;
{
AutoReadLock alock (this);
list = mData.mCallbacks;
}
BOOL allowChange = TRUE;
CallbackList::iterator it = list.begin();
while ((it != list.end()) && allowChange)
{
HRESULT rc = (*it++)->OnExtraDataCanChange (aId, aKey, aValue,
aError.asOutParam(), &allowChange);
if (FAILED (rc))
{
/* if a call to this method fails for some reason (for ex., because
* the other side is dead), we ensure allowChange stays true
* (MS COM RPC implementation seems to zero all output vars before
* issuing an IPC call or after a failure, so it's essential
* there) */
allowChange = TRUE;
}
}
LogFlowThisFunc (("allowChange=%RTbool\n", allowChange));
return allowChange;
}
/** Event for onExtraDataChange() */
struct ExtraDataEvent : public VirtualBox::CallbackEvent
{
ExtraDataEvent (VirtualBox *aVB, const Guid &aMachineId,
INPTR BSTR aKey, INPTR BSTR aVal)
: CallbackEvent (aVB), machineId (aMachineId)
, key (aKey), val (aVal)
{}
void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback)
{
LogFlow (("OnExtraDataChange: machineId={%Ruuid}, key='%ls', val='%ls'\n",
machineId.ptr(), key.raw(), val.raw()));
aCallback->OnExtraDataChange (machineId, key, val);
}
Guid machineId;
Bstr key, val;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onExtraDataChange (const Guid &aId, INPTR BSTR aKey, INPTR 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), machineId (aMachineId), sessionState (aState)
{}
void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback)
{
LogFlow (("OnSessionStateChange: machineId={%Ruuid}, sessionState=%d\n",
machineId.ptr(), sessionState));
aCallback->OnSessionStateChange (machineId, sessionState);
}
Guid 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(), onSnapshotRemoved() and onSnapshotChange() */
struct SnapshotEvent : public VirtualBox::CallbackEvent
{
enum What { Taken, Discarded, Changed };
SnapshotEvent (VirtualBox *aVB, const Guid &aMachineId, const Guid &aSnapshotId,
What aWhat)
: CallbackEvent (aVB)
, what (aWhat)
, machineId (aMachineId), snapshotId (aSnapshotId)
{}
void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback)
{
switch (what)
{
case Taken:
LogFlow (("OnSnapshotTaken: machineId={%Ruuid}, snapshotId={%Ruuid}\n",
machineId.ptr(), snapshotId.ptr()));
aCallback->OnSnapshotTaken (machineId, snapshotId);
break;
case Discarded:
LogFlow (("OnSnapshotDiscarded: machineId={%Ruuid}, snapshotId={%Ruuid}\n",
machineId.ptr(), snapshotId.ptr()));
aCallback->OnSnapshotDiscarded (machineId, snapshotId);
break;
case Changed:
LogFlow (("OnSnapshotChange: machineId={%Ruuid}, snapshotId={%Ruuid}\n",
machineId.ptr(), snapshotId.ptr()));
aCallback->OnSnapshotChange (machineId, snapshotId);
break;
}
}
const What what;
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, SnapshotEvent::Taken));
}
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onSnapshotDiscarded (const Guid &aMachineId, const Guid &aSnapshotId)
{
postEvent (new SnapshotEvent (this, aMachineId, aSnapshotId, SnapshotEvent::Discarded));
}
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onSnapshotChange (const Guid &aMachineId, const Guid &aSnapshotId)
{
postEvent (new SnapshotEvent (this, aMachineId, aSnapshotId, SnapshotEvent::Changed));
}
/** Event for onGuestPropertyChange() */
struct GuestPropertyEvent : public VirtualBox::CallbackEvent
{
GuestPropertyEvent (VirtualBox *aVBox, const Guid &aMachineId,
INPTR BSTR aName, INPTR BSTR aValue, INPTR BSTR aFlags)
: CallbackEvent (aVBox), machineId (aMachineId)
, name (aName), value (aValue), flags(aFlags)
{}
void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback)
{
LogFlow (("OnGuestPropertyChange: machineId={%Ruuid}, name='%ls', value='%ls', flags='%ls'\n",
machineId.ptr(), name.raw(), value.raw(), flags.raw()));
aCallback->OnGuestPropertyChange (machineId, name, value, flags);
}
Guid machineId;
Bstr name, value, flags;
};
/**
* @note Doesn't lock any object.
*/
void VirtualBox::onGuestPropertyChange (const Guid &aMachineId, INPTR BSTR aName,
INPTR BSTR aValue, INPTR BSTR aFlags)
{
postEvent (new GuestPropertyEvent (this, aMachineId, aName, aValue, aFlags));
}
/**
* @note Locks this object for reading.
*/
ComObjPtr <GuestOSType> VirtualBox::getUnknownOSType()
{
ComObjPtr <GuestOSType> type;
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), type);
AutoReadLock alock (this);
/* unknown type must always be the first */
ComAssertRet (mData.mGuestOSTypes.size() > 0, type);
type = mData.mGuestOSTypes.front();
return type;
}
/**
* 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
* whenaccessing unprotected data directly.
*
* @note Locks objects for reading.
*/
void VirtualBox::getOpenedMachines (SessionMachineVector &aMachines,
InternalControlVector *aControls /*= NULL*/)
{
AutoCaller autoCaller (this);
AssertComRCReturnVoid (autoCaller.rc());
aMachines.clear();
if (aControls)
aControls->clear();
AutoReadLock alock (this);
for (MachineList::iterator it = mData.mMachines.begin();
it != mData.mMachines.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 id
* ID of the machine
* @param doSetError
* if TRUE, the appropriate error info is set in case when the machine
* is not found
* @param machine
* where to store the found machine object (can be NULL)
*
* @return
* S_OK when found or E_INVALIDARG when not found
*
* @note Locks this object for reading.
*/
HRESULT VirtualBox::findMachine (const Guid &aId, bool aSetError,
ComObjPtr <Machine> *aMachine /* = NULL */)
{
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
bool found = false;
{
AutoReadLock alock (this);
for (MachineList::iterator it = mData.mMachines.begin();
!found && it != mData.mMachines.end();
++ it)
{
/* sanity */
AutoLimitedCaller machCaller (*it);
AssertComRC (machCaller.rc());
found = (*it)->id() == aId;
if (found && aMachine)
*aMachine = *it;
}
}
HRESULT rc = found ? S_OK : E_INVALIDARG;
if (aSetError && !found)
{
setError (E_INVALIDARG,
tr ("Could not find a registered machine with UUID {%Ruuid}"),
aId.raw());
}
return rc;
}
/**
* Searches for a HardDisk 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 this object and hard disk objects for reading.
*/
HRESULT VirtualBox::
findHardDisk2 (const Guid *aId, const BSTR aLocation,
bool aSetError, ComObjPtr <HardDisk2> *aHardDisk /*= NULL*/)
{
AssertReturn (aId || aLocation, E_INVALIDARG);
AutoReadLock alock (this);
/* first, look up by UUID in the map if UUID is provided */
if (aId)
{
HardDisk2Map::const_iterator it = mData.mHardDisk2Map.find (*aId);
if (it != mData.mHardDisk2Map.end())
{
if (aHardDisk)
*aHardDisk = (*it).second;
return S_OK;
}
}
/* then iterate and search by location */
int result = -1;
if (aLocation)
{
Utf8Str location = aLocation;
for (HardDisk2Map::const_iterator it = mData.mHardDisk2Map.begin();
it != mData.mHardDisk2Map.end();
++ it)
{
const ComObjPtr <HardDisk2> &hd = (*it).second;
HRESULT rc = hd->compareLocationTo (location, result);
CheckComRCReturnRC (rc);
if (result == 0)
{
if (aHardDisk)
*aHardDisk = hd;
break;
}
}
}
HRESULT rc = result == 0 ? S_OK : E_INVALIDARG;
if (aSetError && result != 0)
{
if (aId)
setError (rc, tr ("Could not find a hard disk with UUID {%Ruuid} "
"in the media registry ('%ls')"),
aId->raw(), mData.mCfgFile.mName.raw());
else
setError (rc, tr ("Could not find a hard disk with location '%ls' "
"in the media registry ('%ls')"),
aLocation, mData.mCfgFile.mName.raw());
}
return rc;
}
/**
* Searches for a DVDImage2 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 this object and image objects for reading.
*/
HRESULT VirtualBox::findDVDImage2 (const Guid *aId, const BSTR aLocation,
bool aSetError,
ComObjPtr <DVDImage2> *aImage /* = NULL */)
{
AssertReturn (aId || aLocation, E_INVALIDARG);
Utf8Str location;
if (aLocation != NULL)
{
int vrc = calculateFullPath (Utf8Str (aLocation), location);
if (RT_FAILURE (vrc))
return setError (E_FAIL,
tr ("Invalid image file location '%ls' (%Rrc)"),
aLocation, vrc);
}
AutoReadLock alock (this);
bool found = false;
for (DVDImage2List::const_iterator it = mData.mDVDImages2.begin();
it != mData.mDVDImages2.end();
++ it)
{
/* no AutoCaller, registered image life time is bound to this */
AutoReadLock imageLock (*it);
found = (aId && (*it)->id() == *aId) ||
(aLocation != NULL &&
RTPathCompare (location, Utf8Str ((*it)->locationFull())) == 0);
if (found)
{
if (aImage)
*aImage = *it;
break;
}
}
HRESULT rc = found ? S_OK : E_INVALIDARG;
if (aSetError && !found)
{
if (aId)
setError (rc, tr ("Could not find a CD/DVD image with UUID {%Ruuid} "
"in the media registry ('%ls')"),
aId->raw(), mData.mCfgFile.mName.raw());
else
setError (rc, tr ("Could not find a CD/DVD image with location '%ls' "
"in the media registry ('%ls')"),
aLocation, mData.mCfgFile.mName.raw());
}
return rc;
}
/**
* Searches for a FloppyImage2 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 this object and image objects for reading.
*/
HRESULT VirtualBox::findFloppyImage2 (const Guid *aId, const BSTR aLocation,
bool aSetError,
ComObjPtr <FloppyImage2> *aImage /* = NULL */)
{
AssertReturn (aId || aLocation, E_INVALIDARG);
Utf8Str location;
if (aLocation != NULL)
{
int vrc = calculateFullPath (Utf8Str (aLocation), location);
if (RT_FAILURE (vrc))
return setError (E_FAIL,
tr ("Invalid image file location '%ls' (%Rrc)"),
aLocation, vrc);
}
AutoReadLock alock (this);
bool found = false;
for (FloppyImage2List::const_iterator it = mData.mFloppyImages2.begin();
it != mData.mFloppyImages2.end();
++ it)
{
/* no AutoCaller, registered image life time is bound to this */
AutoReadLock imageLock (*it);
found = (aId && (*it)->id() == *aId) ||
(aLocation != NULL &&
RTPathCompare (location, Utf8Str ((*it)->locationFull())) == 0);
if (found)
{
if (aImage)
*aImage = *it;
break;
}
}
HRESULT rc = found ? S_OK : E_INVALIDARG;
if (aSetError && !found)
{
if (aId)
setError (rc, tr ("Could not find a floppy image with UUID {%Ruuid} "
"in the media registry ('%ls')"),
aId->raw(), mData.mCfgFile.mName.raw());
else
setError (rc, tr ("Could not find a CD/DVD image with location '%ls' "
"in the media registry ('%ls')"),
aLocation, mData.mCfgFile.mName.raw());
}
return rc;
}
/**
* 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 char *aPath, 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 (mData.mHomeDir, aPath, folder, sizeof (folder));
if (RT_SUCCESS (vrc))
aResult = folder;
return vrc;
}
/**
* Tries to calculate the relative path of the given absolute path using the
* directory of the VirtualBox settings file as the base directory.
*
* @param aPath Absolute path to calculate the relative path for.
* @param aResult Where to put the result (used only when it's possible to
* make a relative path from the given absolute path; otherwise
* left untouched).
*
* @note Doesn't lock any object.
*/
void VirtualBox::calculateRelativePath (const char *aPath, Utf8Str &aResult)
{
AutoCaller autoCaller (this);
AssertComRCReturnVoid (autoCaller.rc());
/* no need to lock since mHomeDir is const */
Utf8Str settingsDir = mData.mHomeDir;
if (RTPathStartsWith (aPath, settingsDir))
{
/* when assigning, we create a separate Utf8Str instance because both
* aPath and aResult can point to the same memory location when this
* func is called (if we just do aResult = aPath, aResult will be freed
* first, and since its the same as aPath, an attempt to copy garbage
* will be made. */
aResult = Utf8Str (aPath + settingsDir.length() + 1);
}
}
// private methods
/////////////////////////////////////////////////////////////////////////////
/**
* Checks if there is a hard disk, DVD or floppy image with the given ID or
* location already registered.
*
* On return, sets @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 this object and media objects for reading.
*/
HRESULT VirtualBox::checkMediaForConflicts2 (const Guid &aId,
const Bstr &aLocation,
Utf8Str &aConflict)
{
aConflict.setNull();
AssertReturn (!aId.isEmpty() && !aLocation.isEmpty(), E_FAIL);
AutoReadLock alock (this);
HRESULT rc = S_OK;
{
ComObjPtr <HardDisk2> hardDisk;
rc = findHardDisk2 (&aId, aLocation, false /* aSetError */, &hardDisk);
if (SUCCEEDED (rc))
{
/* Note: no AutoCaller since bound to this */
AutoReadLock mediaLock (hardDisk);
aConflict = Utf8StrFmt (
tr ("hard disk '%ls' with UUID {%Ruuid}"),
hardDisk->locationFull().raw(), hardDisk->id().raw());
return S_OK;
}
}
{
ComObjPtr <DVDImage2> image;
rc = findDVDImage2 (&aId, aLocation, false /* aSetError */, &image);
if (SUCCEEDED (rc))
{
/* Note: no AutoCaller since bound to this */
AutoReadLock mediaLock (image);
aConflict = Utf8StrFmt (
tr ("CD/DVD image '%ls' with UUID {%Ruuid}"),
image->locationFull().raw(), image->id().raw());
return S_OK;
}
}
{
ComObjPtr <FloppyImage2> image;
rc = findFloppyImage2 (&aId, aLocation, false /* aSetError */, &image);
if (SUCCEEDED (rc))
{
/* Note: no AutoCaller since bound to this */
AutoReadLock mediaLock (image);
aConflict = Utf8StrFmt (
tr ("floppy image '%ls' with UUID {%Ruuid}"),
image->locationFull().raw(), image->id().raw());
return S_OK;
}
}
return S_OK;
}
/**
* Reads in the machine definitions from the configuration loader
* and creates the relevant objects.
*
* @param aGlobal <Global> node.
*
* @note Can be called only from #init().
* @note Doesn't lock anything.
*/
HRESULT VirtualBox::loadMachines (const settings::Key &aGlobal)
{
using namespace settings;
AutoCaller autoCaller (this);
AssertReturn (autoCaller.state() == InInit, E_FAIL);
HRESULT rc = S_OK;
Key::List machines = aGlobal.key ("MachineRegistry").keys ("MachineEntry");
for (Key::List::const_iterator it = machines.begin();
it != machines.end(); ++ it)
{
/* required */
Guid uuid = (*it).value <Guid> ("uuid");
/* required */
Bstr src = (*it).stringValue ("src");
/* create a new machine object */
ComObjPtr <Machine> machine;
rc = machine.createObject();
if (SUCCEEDED (rc))
{
/* initialize the machine object and register it */
rc = machine->init (this, src, Machine::Init_Registered,
NULL, FALSE, &uuid);
if (SUCCEEDED (rc))
rc = registerMachine (machine);
}
}
return rc;
}
/**
* Reads in the media registration entries from the global settings file
* and creates the relevant objects.
*
* @param aGlobal <Global> node
*
* @note Can be called only from #init().
* @note Doesn't lock anything.
*/
HRESULT VirtualBox::loadMedia (const settings::Key &aGlobal)
{
using namespace settings;
AutoCaller autoCaller (this);
AssertReturn (autoCaller.state() == InInit, E_FAIL);
HRESULT rc = S_OK;
Key registry = aGlobal.key ("MediaRegistry");
const char *kMediaNodes[] = { "HardDisks", "DVDImages", "FloppyImages" };
for (size_t n = 0; n < RT_ELEMENTS (kMediaNodes); ++ n)
{
/* All three media nodes are optional */
Key node = registry.findKey (kMediaNodes [n]);
if (node.isNull())
continue;
if (n == 0)
{
Key::List hardDisks = node.keys ("HardDisk");
for (Key::List::const_iterator it = hardDisks.begin();
it != hardDisks.end(); ++ it)
{
ComObjPtr <HardDisk2> hardDisk;
hardDisk.createObject();
rc = hardDisk->init (this, NULL, *it);
CheckComRCBreakRC (rc);
rc = registerHardDisk2 (hardDisk, false /* aSaveRegistry */);
CheckComRCBreakRC (rc);
}
continue;
}
CheckComRCBreakRC (rc);
Key::List images = node.keys ("Image");
for (Key::List::const_iterator it = images.begin();
it != images.end(); ++ it)
{
switch (n)
{
case 1: /* DVDImages */
{
ComObjPtr <DVDImage2> image;
image.createObject();
rc = image->init (this, *it);
CheckComRCBreakRC (rc);
rc = registerDVDImage (image, false /* aSaveRegistry */);
CheckComRCBreakRC (rc);
break;
}
case 2: /* FloppyImages */
{
ComObjPtr <FloppyImage2> image;
image.createObject();
rc = image->init (this, *it);
CheckComRCBreakRC (rc);
rc = registerFloppyImage (image, false /* aSaveRegistry */);
CheckComRCBreakRC (rc);
break;
}
default:
AssertFailed();
}
CheckComRCBreakRC (rc);
}
CheckComRCBreakRC (rc);
}
return rc;
}
/**
* Helper function to write out the configuration tree.
*
* @note Locks this object for writing and child objects for reading/writing!
*/
HRESULT VirtualBox::saveSettings()
{
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AssertReturn (!!mData.mCfgFile.mName, E_FAIL);
HRESULT rc = S_OK;
/* serialize file access (prevent concurrent reads and writes) */
AutoWriteLock alock (this);
try
{
using namespace settings;
/* load the settings file */
File file (mData.mCfgFile.mHandle, Utf8Str (mData.mCfgFile.mName));
XmlTreeBackend tree;
rc = VirtualBox::loadSettingsTree_ForUpdate (tree, file);
CheckComRCThrowRC (rc);
Key global = tree.rootKey().createKey ("Global");
/* machines */
{
/* first, delete the entire machine registry */
Key registryNode = global.findKey ("MachineRegistry");
if (!registryNode.isNull())
registryNode.zap();
/* then, recreate it */
registryNode = global.createKey ("MachineRegistry");
/* write out the machines */
for (MachineList::iterator it = mData.mMachines.begin();
it != mData.mMachines.end();
++ it)
{
Key entryNode = registryNode.appendKey ("MachineEntry");
rc = (*it)->saveRegistryEntry (entryNode);
CheckComRCThrowRC (rc);
}
}
/* media */
{
/* first, delete the entire media registry */
Key registryNode = global.findKey ("MediaRegistry");
if (!registryNode.isNull())
registryNode.zap();
/* then, recreate it */
registryNode = global.createKey ("MediaRegistry");
/* hard disks */
{
Key hardDisksNode = registryNode.createKey ("HardDisks");
for (HardDisk2List::const_iterator it =
mData.mHardDisks2.begin();
it != mData.mHardDisks2.end();
++ it)
{
rc = (*it)->saveSettings (hardDisksNode);
CheckComRCThrowRC (rc);
}
}
/* CD/DVD images */
{
Key imagesNode = registryNode.createKey ("DVDImages");
for (DVDImage2List::const_iterator it =
mData.mDVDImages2.begin();
it != mData.mDVDImages2.end();
++ it)
{
rc = (*it)->saveSettings (imagesNode);
CheckComRCThrowRC (rc);
}
}
/* floppy images */
{
Key imagesNode = registryNode.createKey ("FloppyImages");
for (FloppyImage2List::const_iterator it =
mData.mFloppyImages2.begin();
it != mData.mFloppyImages2.end();
++ it)
{
rc = (*it)->saveSettings (imagesNode);
CheckComRCThrowRC (rc);
}
}
}
/* host data (USB filters) */
rc = mData.mHost->saveSettings (global);
CheckComRCThrowRC (rc);
rc = mData.mSystemProperties->saveSettings (global);
CheckComRCThrowRC (rc);
/* save the settings on success */
rc = VirtualBox::saveSettingsTree (tree, file,
mData.mSettingsFileVersion);
CheckComRCThrowRC (rc);
}
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);
CheckComRCReturnRC (autoCaller.rc());
AutoWriteLock alock (this);
HRESULT rc = S_OK;
{
ComObjPtr <Machine> m;
rc = findMachine (aMachine->id(), false /* aDoSetError */, &m);
if (SUCCEEDED (rc))
{
/* sanity */
AutoLimitedCaller machCaller (m);
AssertComRC (machCaller.rc());
return setError (E_INVALIDARG,
tr ("Registered machine with UUID {%Ruuid} ('%ls') already exists"),
aMachine->id().raw(), m->settingsFileFull().raw());
}
ComAssertRet (rc == E_INVALIDARG, rc);
rc = S_OK;
}
if (autoCaller.state() != InInit)
{
/* Machine::trySetRegistered() will commit and save machine settings */
rc = aMachine->trySetRegistered (TRUE);
CheckComRCReturnRC (rc);
}
/* add to the collection of registered machines */
mData.mMachines.push_back (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 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 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 hard disk objects get
* registered.
*
* @note Locks this object for writing and @a aHardDisk for reading.
*/
HRESULT VirtualBox::registerHardDisk2 (HardDisk2 *aHardDisk,
bool aSaveRegistry /*= true*/)
{
AssertReturn (aHardDisk != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
AutoCaller hardDiskCaller (aHardDisk);
AssertComRCReturn (hardDiskCaller.rc(), hardDiskCaller.rc());
AutoReadLock hardDiskLock (aHardDisk);
Utf8Str conflict;
HRESULT rc = checkMediaForConflicts2 (aHardDisk->id(),
aHardDisk->locationFull(),
conflict);
CheckComRCReturnRC (rc);
if (!conflict.isNull())
{
return setError (E_INVALIDARG,
tr ("Cannot register the hard disk '%ls' with UUID {%Ruuid} "
"because a %s already exists in the media registry ('%ls')"),
aHardDisk->locationFull().raw(), aHardDisk->id().raw(),
conflict.raw(), mData.mCfgFile.mName.raw());
}
if (aHardDisk->parent().isNull())
{
/* base (root) hard disk */
mData.mHardDisks2.push_back (aHardDisk);
}
mData.mHardDisk2Map
.insert (HardDisk2Map::value_type (
aHardDisk->id(), HardDisk2Map::mapped_type (aHardDisk)));
if (aSaveRegistry)
{
rc = saveSettings();
if (FAILED (rc))
unregisterHardDisk2 (aHardDisk, 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::unregisterHardDisk2 (HardDisk2 *aHardDisk,
bool aSaveRegistry /*= true*/)
{
AssertReturn (aHardDisk != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
AutoCaller hardDiskCaller (aHardDisk);
AssertComRCReturn (hardDiskCaller.rc(), hardDiskCaller.rc());
AutoReadLock hardDiskLock (aHardDisk);
size_t cnt = mData.mHardDisk2Map.erase (aHardDisk->id());
Assert (cnt == 1);
if (aHardDisk->parent().isNull())
{
/* base (root) hard disk */
mData.mHardDisks2.remove (aHardDisk);
}
HRESULT rc = S_OK;
if (aSaveRegistry)
{
rc = saveSettings();
if (FAILED (rc))
registerHardDisk2 (aHardDisk, false /* aSaveRegistry */);
}
return rc;
}
/**
* Remembers the given image by storing it in the CD/DVD image registry.
*
* @param aImage Image object to remember.
* @param aSaveRegistry @c true to save the image 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 image 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 image objects get
* registered.
*
* @note Locks this object for writing and @a aImage for reading.
*/
HRESULT VirtualBox::registerDVDImage (DVDImage2 *aImage,
bool aSaveRegistry /*= true*/)
{
AssertReturn (aImage != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
AutoCaller imageCaller (aImage);
AssertComRCReturn (imageCaller.rc(), imageCaller.rc());
AutoReadLock imageLock (aImage);
Utf8Str conflict;
HRESULT rc = checkMediaForConflicts2 (aImage->id(), aImage->locationFull(),
conflict);
CheckComRCReturnRC (rc);
if (!conflict.isNull())
{
return setError (E_INVALIDARG,
tr ("Cannot register the CD/DVD image '%ls' with UUID {%Ruuid} "
"because a %s already exists in the media registry ('%ls')"),
aImage->locationFull().raw(), aImage->id().raw(),
conflict.raw(), mData.mCfgFile.mName.raw());
}
/* add to the collection */
mData.mDVDImages2.push_back (aImage);
if (aSaveRegistry)
{
rc = saveSettings();
if (FAILED (rc))
unregisterDVDImage (aImage, false /* aSaveRegistry */);
}
return rc;
}
/**
* Removes the given image from the CD/DVD image registry registry.
*
* @param aImage Image 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 image 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 aImage.
*
* @note Locks this object for writing and @a aImage for reading.
*/
HRESULT VirtualBox::unregisterDVDImage (DVDImage2 *aImage,
bool aSaveRegistry /*= true*/)
{
AssertReturn (aImage != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
AutoCaller imageCaller (aImage);
AssertComRCReturn (imageCaller.rc(), imageCaller.rc());
AutoReadLock imageLock (aImage);
mData.mDVDImages2.remove (aImage);
HRESULT rc = S_OK;
if (aSaveRegistry)
{
rc = saveSettings();
if (FAILED (rc))
registerDVDImage (aImage, false /* aSaveRegistry */);
}
return rc;
}
/**
* Remembers the given image by storing it in the floppy image registry.
*
* @param aImage Image object to remember.
* @param aSaveRegistry @c true to save the image 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 image 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 image objects get
* registered.
*
* @note Locks this object for writing and @a aImage for reading.
*/
HRESULT VirtualBox::registerFloppyImage (FloppyImage2 *aImage,
bool aSaveRegistry /*= true*/)
{
AssertReturn (aImage != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
AutoCaller imageCaller (aImage);
AssertComRCReturn (imageCaller.rc(), imageCaller.rc());
AutoReadLock imageLock (aImage);
Utf8Str conflict;
HRESULT rc = checkMediaForConflicts2 (aImage->id(), aImage->locationFull(),
conflict);
CheckComRCReturnRC (rc);
if (!conflict.isNull())
{
return setError (E_INVALIDARG,
tr ("Cannot register the floppy image '%ls' with UUID {%Ruuid} "
"because a %s already exists in the media registry ('%ls')"),
aImage->locationFull().raw(), aImage->id().raw(),
conflict.raw(), mData.mCfgFile.mName.raw());
}
/* add to the collection */
mData.mFloppyImages2.push_back (aImage);
if (aSaveRegistry)
{
rc = saveSettings();
if (FAILED (rc))
unregisterFloppyImage (aImage, false /* aSaveRegistry */);
}
return rc;
}
/**
* Removes the given image from the floppy image registry registry.
*
* @param aImage Image 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 image 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 aImage.
*
* @note Locks this object for writing and @a aImage for reading.
*/
HRESULT VirtualBox::unregisterFloppyImage (FloppyImage2 *aImage,
bool aSaveRegistry /*= true*/)
{
AssertReturn (aImage != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
AutoCaller imageCaller (aImage);
AssertComRCReturn (imageCaller.rc(), imageCaller.rc());
AutoReadLock imageLock (aImage);
mData.mFloppyImages2.remove (aImage);
HRESULT rc = S_OK;
if (aSaveRegistry)
{
rc = saveSettings();
if (FAILED (rc))
registerFloppyImage (aImage, false /* aSaveRegistry */);
}
return rc;
}
/**
* Attempts to cast from a raw interface pointer to an underlying object.
* On sucess, @a aTo will contain the object reference. On failure, @a aTo will
* be set to @c null and an extended error info will be returned.
*
* @param aFrom Interface pointer to cast from.
* @param aTo Where to store a reference to the underlying object.
*
* @note Locks this object for reading.
*/
HRESULT VirtualBox::cast (IHardDisk2 *aFrom, ComObjPtr <HardDisk2> &aTo)
{
AssertReturn (aFrom != NULL, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoReadLock alock (this);
VirtualBoxBase *child = getDependentChild (aFrom);
if (!child)
return setError (E_FAIL, tr ("The given hard disk object is not created "
"within this VirtualBox instance"));
/* we can safely cast child to HardDisk * here because only HardDisk
* implementations of IHardDisk can be among our children */
aTo = static_cast <HardDisk2 *> (child);
return S_OK;
}
/**
* Helper to update the global settings file when the name of some machine
* changes so that file and directory renaming occurs. This method ensures that
* all affected paths in the disk registry are properly updated.
*
* @param aOldPath Old path (full).
* @param aNewPath New path (full).
*
* @note Locks this object + DVD, Floppy and HardDisk children for writing.
*/
HRESULT VirtualBox::updateSettings (const char *aOldPath, const char *aNewPath)
{
LogFlowThisFunc (("aOldPath={%s} aNewPath={%s}\n", aOldPath, aNewPath));
AssertReturn (aOldPath, E_INVALIDARG);
AssertReturn (aNewPath, E_INVALIDARG);
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AutoWriteLock alock (this);
/* check DVD paths */
for (DVDImage2List::iterator it = mData.mDVDImages2.begin();
it != mData.mDVDImages2.end();
++ it)
{
(*it)->updatePath (aOldPath, aNewPath);
}
/* check Floppy paths */
for (FloppyImage2List::iterator it = mData.mFloppyImages2.begin();
it != mData.mFloppyImages2.end();
++ it)
{
(*it)->updatePath (aOldPath, aNewPath);
}
/* check HardDisk paths */
for (HardDisk2List::const_iterator it = mData.mHardDisks2.begin();
it != mData.mHardDisks2.end();
++ it)
{
(*it)->updatePaths (aOldPath, aNewPath);
}
HRESULT rc = saveSettings();
return rc;
}
/**
* Creates the path to the specified file accoring to the path information
* present in the file name.
*
* Note that the given file name must contain the full path otherwise the
* extracted reliative 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 char *aFileName)
{
Utf8Str dir = aFileName;
RTPathStripFilename (dir.mutableRaw());
if (!RTDirExists (dir))
{
int vrc = RTDirCreateFullPath (dir, 0777);
if (RT_FAILURE (vrc))
{
return setError (E_FAIL,
tr ("Could not create the directory '%s' (%Rrc)"),
dir.raw(), vrc);
}
}
return S_OK;
}
/**
* Helper method to load the setting tree and turn expected exceptions into
* COM errors, according to arguments.
*
* Note that this method will not catch unexpected errors so it may still
* throw something.
*
* @param aTree Tree to load into settings.
* @param aFile File to load settings from.
* @param aValidate @c @true to enable tree validation.
* @param aCatchLoadErrors @c true to catch exceptions caused by file
* access or validation errors.
* @param aAddDefaults @c true to cause the substitution of default
* values for for missing attributes that have
* defaults in the XML schema.
* @param aFormatVersion Where to store the current format version of the
* loaded settings tree (optional, may be NULL).
*/
/* static */
HRESULT VirtualBox::loadSettingsTree (settings::XmlTreeBackend &aTree,
settings::File &aFile,
bool aValidate,
bool aCatchLoadErrors,
bool aAddDefaults,
Utf8Str *aFormatVersion /* = NULL */)
{
using namespace settings;
try
{
SettingsTreeHelper helper = SettingsTreeHelper();
aTree.setInputResolver (helper);
aTree.setAutoConverter (helper);
aTree.read (aFile, aValidate ? VBOX_XML_SCHEMA : NULL,
aAddDefaults ? XmlTreeBackend::Read_AddDefaults : 0);
aTree.resetAutoConverter();
aTree.resetInputResolver();
/* on success, memorize the current settings file version or set it to
* the most recent version if no settings conversion took place. Note
* that it's not necessary to do it every time we load the settings file
* (i.e. only loadSettingsTree_FirstTime() passes a non-NULL
* aFormatVersion value) because currently we keep the settings
* files locked so that the only legal way to change the format version
* while VirtualBox is running is saveSettingsTree(). */
if (aFormatVersion != NULL)
{
*aFormatVersion = aTree.oldVersion();
if (aFormatVersion->isNull())
*aFormatVersion = VBOX_XML_VERSION_FULL;
}
}
catch (const EIPRTFailure &err)
{
if (!aCatchLoadErrors)
throw;
return setError (E_FAIL,
tr ("Could not load the settings file '%s' (%Rrc)"),
aFile.uri(), err.rc());
}
catch (const XmlTreeBackend::Error &err)
{
Assert (err.what() != NULL);
if (!aCatchLoadErrors)
throw;
return setError (E_FAIL,
tr ("Could not load the settings file '%s'.\n%s"),
aFile.uri(),
err.what() ? err.what() : "Unknown error");
}
return S_OK;
}
/**
* Helper method to save the settings tree and turn expected exceptions to COM
* errors.
*
* Note that this method will not catch unexpected errors so it may still
* throw something.
*
* @param aTree Tree to save.
* @param aFile File to save the tree to.
* @param aFormatVersion Where to store the (recent) format version of the
* saved settings tree on success.
*/
/* static */
HRESULT VirtualBox::saveSettingsTree (settings::TreeBackend &aTree,
settings::File &aFile,
Utf8Str &aFormatVersion)
{
using namespace settings;
try
{
aTree.write (aFile);
/* set the current settings file version to the most recent version on
* success. See also VirtualBox::loadSettingsTree(). */
if (aFormatVersion != VBOX_XML_VERSION_FULL)
aFormatVersion = VBOX_XML_VERSION_FULL;
}
catch (const EIPRTFailure &err)
{
/* this is the only expected exception for now */
return setError (E_FAIL,
tr ("Could not save the settings file '%s' (%Rrc)"),
aFile.uri(), err.rc());
}
return S_OK;
}
/**
* Creates a backup copy of the given settings file by suffixing it with the
* supplied version format string and optionally with numbers from .0 to .9
* if the backup file already exists.
*
* @param aFileName Orignal settings file name.
* @param aOldFormat Version of the original format.
* @param aBakFileName File name of the created backup copy (only on success).
*/
/* static */
HRESULT VirtualBox::backupSettingsFile (const Bstr &aFileName,
const Utf8Str &aOldFormat,
Bstr &aBakFileName)
{
Utf8Str of = aFileName;
Utf8Str nf = Utf8StrFmt ("%s.%s.bak", of.raw(), aOldFormat.raw());
int vrc = RTFileCopyEx (of, nf, RTFILECOPY_FLAGS_NO_SRC_DENY_WRITE,
NULL, NULL);
/* try progressive suffix from .0 to .9 on failure */
if (vrc == VERR_ALREADY_EXISTS)
{
Utf8Str tmp = nf;
for (int i = 0; i <= 9 && RT_FAILURE (vrc); ++ i)
{
nf = Utf8StrFmt ("%s.%d", tmp.raw(), i);
vrc = RTFileCopyEx (of, nf, RTFILECOPY_FLAGS_NO_SRC_DENY_WRITE,
NULL, NULL);
}
}
if (RT_FAILURE (vrc))
return setError (E_FAIL,
tr ("Could not copy the settings file '%s' to '%s' (%Rrc)"),
of.raw(), nf.raw(), vrc);
aBakFileName = nf;
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
{
/* rethrow the current exception */
throw;
}
catch (const std::exception &err)
{
ComAssertMsgFailedPos (("Unexpected exception '%s' (%s)\n",
typeid (err).name(), err.what()),
pszFile, iLine, pszFunction);
return E_FAIL;
}
catch (...)
{
ComAssertMsgFailedPos (("Unknown exception\n"),
pszFile, iLine, pszFunction);
return E_FAIL;
}
/* should not get here */
AssertFailed();
return E_FAIL;
}
/**
* Helper to lock the VirtualBox configuration for write access.
*
* @note This method is not thread safe (must be called only from #init()
* or #uninit()).
*
* @note If the configuration file is not found, the method returns
* S_OK, but subsequent #isConfigLocked() will return FALSE. This is used
* in some places to determine the (valid) situation when no config file
* exists yet, and therefore a new one should be created from scatch.
*/
HRESULT VirtualBox::lockConfig()
{
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
AssertReturn (autoCaller.state() == InInit, E_FAIL);
HRESULT rc = S_OK;
Assert (!isConfigLocked());
if (!isConfigLocked())
{
/* open the associated config file */
int vrc = RTFileOpen (&mData.mCfgFile.mHandle,
Utf8Str (mData.mCfgFile.mName),
RTFILE_O_READWRITE | RTFILE_O_OPEN |
RTFILE_O_DENY_WRITE);
if (RT_FAILURE (vrc))
{
mData.mCfgFile.mHandle = NIL_RTFILE;
/*
* It is ok if the file is not found, it will be created by
* init(). Otherwise return an error.
*/
if (vrc != VERR_FILE_NOT_FOUND)
rc = setError (E_FAIL,
tr ("Could not lock the settings file '%ls' (%Rrc)"),
mData.mCfgFile.mName.raw(), vrc);
}
LogFlowThisFunc (("mCfgFile.mName='%ls', mCfgFile.mHandle=%d, rc=%08X\n",
mData.mCfgFile.mName.raw(), mData.mCfgFile.mHandle, rc));
}
return rc;
}
/**
* Helper to unlock the VirtualBox configuration from write access.
*
* @note This method is not thread safe (must be called only from #init()
* or #uninit()).
*/
HRESULT VirtualBox::unlockConfig()
{
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), E_FAIL);
AssertReturn (autoCaller.state() == InUninit, E_FAIL);
HRESULT rc = S_OK;
if (isConfigLocked())
{
RTFileFlush (mData.mCfgFile.mHandle);
RTFileClose (mData.mCfgFile.mHandle);
/** @todo flush the directory too. */
mData.mCfgFile.mHandle = NIL_RTFILE;
LogFlowThisFunc (("\n"));
}
return rc;
}
/**
* Thread function that watches the termination of all client processes
* that have opened sessions using IVirtualBox::OpenSession()
*/
// static
DECLCALLBACK(int) VirtualBox::ClientWatcher (RTTHREAD thread, void *pvUser)
{
LogFlowFuncEnter();
VirtualBox *that = (VirtualBox *) pvUser;
Assert (that);
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->mWatcherData.mUpdateReq;
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 (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]);
AutoReadLock thatLock (that);
/* obtain a new set of opened machines */
cnt = 0;
machines.clear();
for (MachineList::iterator it = that->mData.mMachines.begin();
it != that->mData.mMachines.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 (MachineList::iterator it = that->mData.mMachines.begin();
it != that->mData.mMachines.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));
}
}
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->mWatcherData.mUpdateReq, 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]);
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]);
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);
if (update)
{
/* close the old muxsem */
if (muxSem != NULLHANDLE)
::DosCloseMuxWaitSem (muxSem);
/* obtain a new set of opened machines */
cnt = 0;
machines.clear();
for (MachineList::iterator it = that->mData.mMachines.begin();
it != that->mData.mMachines.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 (MachineList::iterator it = that->mData.mMachines.begin();
it != that->mData.mMachines.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->mWatcherData.mUpdateReq, 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 */
AutoReadLock thatLock (that);
if (RT_SUCCESS (rc) || update)
{
/* obtain a new set of opened machines */
machines.clear();
for (MachineList::iterator it = that->mData.mMachines.begin();
it != that->mData.mMachines.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 (MachineList::iterator it = that->mData.mMachines.begin();
it != that->mData.mMachines.end(); ++ it)
{
if ((*it)->isSessionSpawning())
spawnedMachines.push_back (*it);
}
cntSpawned = spawnedMachines.size();
LogFlowFunc (("UPDATE: spawned session count = %d\n", cntSpawned));
}
}
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);
if (that->mWatcherData.mProcesses.size())
{
LogFlowFunc (("UPDATE: child process count = %d\n",
that->mWatcherData.mProcesses.size()));
ClientWatcherData::ProcessList::iterator it =
that->mWatcherData.mProcesses.begin();
while (it != that->mWatcherData.mProcesses.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->mWatcherData.mProcesses.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->mWatcherData.mProcesses.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.isNull())
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.setNull();
return NULL;
}
CallbackVector callbacks;
{
/* Make a copy to release the lock before iterating */
AutoReadLock alock (mVirtualBox);
callbacks = CallbackVector (mVirtualBox->mData.mCallbacks.begin(),
mVirtualBox->mData.mCallbacks.end());
/* We don't need mVirtualBox any more, so release it */
mVirtualBox.setNull();
}
for (VirtualBox::CallbackVector::const_iterator it = callbacks.begin();
it != callbacks.end(); ++ it)
handleCallback (*it);
return NULL;
}