MachineImpl.cpp revision 825c2485cf84eec495985ffd605a1c9cddee8c32
/* $Id$ */
/** @file
* Implementation of IMachine in VBoxSVC.
*/
/*
* Copyright (C) 2006-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/* Make sure all the stdint.h macros are included - must come first! */
#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif
# include <errno.h>
#endif
#include "Logging.h"
#include "VirtualBoxImpl.h"
#include "MachineImpl.h"
#include "ProgressImpl.h"
#include "ProgressProxyImpl.h"
#include "MediumAttachmentImpl.h"
#include "MediumImpl.h"
#include "MediumLock.h"
#include "USBControllerImpl.h"
#include "HostImpl.h"
#include "SharedFolderImpl.h"
#include "GuestOSTypeImpl.h"
#include "VirtualBoxErrorInfoImpl.h"
#include "GuestImpl.h"
#include "StorageControllerImpl.h"
#ifdef VBOX_WITH_USB
# include "USBProxyService.h"
#endif
#include "AutoCaller.h"
#include "Performance.h"
#include <iprt/lockvalidator.h>
#include <VBox/settings.h>
#ifdef VBOX_WITH_GUEST_PROPS
#endif
#include "VBox/com/MultiResult.h"
#include <algorithm>
#include <typeinfo>
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
# define HOSTSUFF_EXE ".exe"
#else /* !RT_OS_WINDOWS */
# define HOSTSUFF_EXE ""
#endif /* !RT_OS_WINDOWS */
// defines / prototypes
/////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Machine::Data structure
/////////////////////////////////////////////////////////////////////////////
{
mRegistered = FALSE;
flModifications = 0;
mAccessible = FALSE;
/* mUuid is initialized in Machine::init() */
mMachineStateDeps = 0;
}
{
{
}
if (pMachineConfigFile)
{
delete pMachineConfigFile;
}
}
/////////////////////////////////////////////////////////////////////////////
// Machine::UserData structure
/////////////////////////////////////////////////////////////////////////////
{
/* default values for a newly created machine */
mTeleporterPort = 0;
mRTCUseUTC = FALSE;
/* mName, mOSTypeId, mSnapshotFolder, mSnapshotFolderFull are initialized in
* Machine::init() */
}
{
}
/////////////////////////////////////////////////////////////////////////////
// Machine::HWData structure
/////////////////////////////////////////////////////////////////////////////
{
/* default values for a newly created machine */
mMemorySize = 128;
mCPUCount = 1;
mCPUHotPlugEnabled = false;
mMemoryBalloonSize = 0;
mPageFusionEnabled = false;
mVRAMSize = 8;
mAccelerate3DEnabled = false;
mAccelerate2DVideoEnabled = false;
mMonitorCount = 1;
mHWVirtExEnabled = true;
mHWVirtExNestedPagingEnabled = true;
#if HC_ARCH_BITS == 64
/* Default value decision pending. */
mHWVirtExLargePagesEnabled = false;
#else
/* Not supported on 32 bits hosts. */
mHWVirtExLargePagesEnabled = false;
#endif
mHWVirtExVPIDEnabled = true;
#if defined(RT_OS_DARWIN) || defined(RT_OS_WINDOWS)
mHWVirtExExclusive = false;
#else
mHWVirtExExclusive = true;
#endif
mPAEEnabled = true;
#else
mPAEEnabled = false;
#endif
mSyntheticCpu = false;
mHpetEnabled = false;
/* default boot order: floppy - DVD - HDD */
mBootOrder[0] = DeviceType_Floppy;
mBootOrder[i] = DeviceType_Null;
mCPUAttached[i] = false;
mIoCacheEnabled = true;
mIoBandwidthMax = 0; /* Unlimited */
}
{
}
/////////////////////////////////////////////////////////////////////////////
// Machine::HDData structure
/////////////////////////////////////////////////////////////////////////////
{
}
{
}
/////////////////////////////////////////////////////////////////////////////
// Machine class
/////////////////////////////////////////////////////////////////////////////
// constructor / destructor
/////////////////////////////////////////////////////////////////////////////
{}
{}
{
LogFlowThisFunc(("\n"));
return S_OK;
}
void Machine::FinalRelease()
{
LogFlowThisFunc(("\n"));
uninit();
}
/**
* Initializes a new machine instance; this init() variant creates a new, empty machine.
* This gets called from VirtualBox::CreateMachine() or VirtualBox::CreateLegacyMachine().
*
* @param aParent Associated parent object
* @param strConfigFile Local file system path to the VM settings file (can
* be relative to the VirtualBox config directory).
* @param strName name for the machine
* @param aId UUID for the new machine.
* @param aOsType Optional OS Type of this machine.
* @param aOverride |TRUE| to override VM config file existence checks.
* |FALSE| refuses to overwrite existing VM configs.
* @param aNameSync |TRUE| to automatically sync settings dir and file
* name with the machine name. |FALSE| is used for legacy
* machines where the file name is specified by the
* user and should never change.
*
* @return Success indicator. if not S_OK, the machine object is invalid
*/
const Utf8Str &strConfigFile,
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
{
// create an empty machine config
}
{
// set to true now to cause uninit() to call uninitDataAndChildObjects() on failure
/* initialize the default snapshots folder
* (note: depends on the name value set above!) */
if (aOsType)
{
/* Store OS type */
/* Apply BIOS defaults */
/* Apply network adapters defaults */
/* Apply serial port defaults */
}
/* commit all changes made during the initialization */
commit();
}
/* Confirm a successful initialization when it's the case */
{
if (mData->mAccessible)
else
}
LogFlowThisFunc(("mName='%ls', mRegistered=%RTbool, mAccessible=%RTbool, rc=%08X\n",
rc));
return rc;
}
/**
* Initializes a new instance with data from machine XML (formerly Init_Registered).
* Gets called in two modes:
*
* -- from VirtualBox::initMachines() during VirtualBox startup; in that case, the
* UUID is specified and we mark the machine as "registered";
*
* -- from the public VirtualBox::OpenMachine() API, in which case the UUID is NULL
* and the machine remains unregistered until RegisterMachine() is called.
*
* @param aParent Associated parent object
* @param aConfigFile Local file system path to the VM settings file (can
* be relative to the VirtualBox config directory).
* @param aId UUID of the machine or NULL (see above).
*
* @return Success indicator. if not S_OK, the machine object is invalid
*/
const Utf8Str &strConfigFile,
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
if (aId)
{
// loading a registered VM:
// now load the settings from XML:
rc = registeredInit();
// this calls initDataAndChildObjects() and loadSettings()
}
else
{
// opening an unregistered VM (VirtualBox::OpenMachine()):
{
// set to true now to cause uninit() to call uninitDataAndChildObjects() on failure
try
{
// load and parse machine XML; this will throw on XML or logic errors
// use UUID from machine config
commit();
}
{
/* we assume that error info is set by the thrower */
}
catch (...)
{
}
}
}
/* Confirm a successful initialization when it's the case */
{
if (mData->mAccessible)
else
}
LogFlowThisFunc(("mName='%ls', mRegistered=%RTbool, mAccessible=%RTbool "
"rc=%08X\n",
return rc;
}
/**
* Initializes a new instance from a machine config that is already in memory
* (import OVF case). Since we are importing, the UUID in the machine
* config is ignored and we always generate a fresh one.
*
* @param strName Name for the new machine; this overrides what is specified in config and is used
* for the settings file as well.
* @param config Machine configuration loaded and parsed from XML.
*
* @return Success indicator. if not S_OK, the machine object is invalid
*/
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
{
// set to true now to cause uninit() to call uninitDataAndChildObjects() on failure
// create empty machine config for instance data
// generate fresh UUID, ignore machine config
// override VM name as well, it may be different
/* commit all changes made during the initialization */
commit();
}
/* Confirm a successful initialization when it's the case */
{
if (mData->mAccessible)
else
}
LogFlowThisFunc(("mName='%ls', mRegistered=%RTbool, mAccessible=%RTbool "
"rc=%08X\n",
return rc;
}
/**
* Shared code between the various init() implementations.
* @param aParent
* @return
*/
const Utf8Str &strConfigFile)
{
/* share the parent weakly */
/* allocate the essential machine data structure (the rest will be
* allocated later by initDataAndChildObjects() */
/* memorize the config file name (as provided) */
/* get the full file name */
if (RT_FAILURE(vrc1))
return setError(VBOX_E_FILE_ERROR,
tr("Invalid machine settings file name '%s' (%Rrc)"),
strConfigFile.raw(),
vrc1);
return rc;
}
/**
* Tries to create a machine settings file in the path stored in the machine
* instance data. Used when a new machine is created to fail gracefully if
* the settings file could not be written (e.g. because machine dir is read-only).
* @return
*/
{
// when we create a new machine, we must be able to create the settings file
RTFILE f = NIL_RTFILE;
int vrc = RTFileOpen(&f, mData->m_strConfigFileFull.c_str(), RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
if ( RT_SUCCESS(vrc)
|| vrc == VERR_SHARING_VIOLATION
)
{
if (RT_SUCCESS(vrc))
RTFileClose(f);
if (!aOverride)
tr("Machine settings file '%s' already exists"),
else
{
/* try to delete the config file, as otherwise the creation
* of a new settings file will fail. */
if (RT_FAILURE(vrc2))
tr("Could not delete the existing settings file '%s' (%Rrc)"),
}
}
else if ( vrc != VERR_FILE_NOT_FOUND
&& vrc != VERR_PATH_NOT_FOUND
)
tr("Invalid machine settings file name '%s' (%Rrc)"),
vrc);
return rc;
}
/**
* Initializes the registered machine by loading the settings file.
* This method is separated from #init() in order to make it possible to
* retry the operation after VirtualBox startup instead of refusing to
* startup the whole VirtualBox server in case if the settings file of some
* registered VM is invalid or inaccessible.
*
* @note Must be always called from this object's write lock
* (unless called from #init() that doesn't need any locking).
* @note Locks the mUSBController method for writing.
* @note Subclasses must not call this method.
*/
{
{
/* Temporarily reset the registered flag in order to let setters
* potentially called from loadSettings() succeed (isMutable() used in
* all setters will return FALSE for a Machine instance if mRegistered
* is TRUE). */
try
{
// load and parse machine XML; this will throw on XML or logic errors
tr("Machine UUID {%RTuuid} in '%s' doesn't match its UUID {%s} in the registry file '%s'"),
}
{
/* we assume that error info is set by the thrower */
}
catch (...)
{
}
/* Restore the registered flag (even on failure) */
}
{
/* Set mAccessible to TRUE only if we successfully locked and loaded
* the settings file */
/* commit all changes made during loading the settings file */
commit(); // @todo r=dj why do we need a commit during init?!? this is very expensive
}
else
{
/* If the machine is registered, then, instead of returning a
* failure, we mark it as inaccessible and set the result to
* success to give it a try later */
/* fetch the current error info */
LogWarning(("Machine {%RTuuid} is inaccessible! [%ls]\n",
/* rollback all changes */
rollback(false /* aNotify */);
/* uninitialize the common part to make sure all data is reset to
* default (null) values */
}
return rc;
}
/**
* Uninitializes the instance.
* Called either from FinalRelease() or by the parent when it gets destroyed.
*
* @note The caller of this method must make sure that this object
* a) doesn't have active callers on the current thread and b) is not locked
* by the current thread; otherwise uninit() will hang either a) due to
* AutoUninitSpan waiting for a number of calls to drop to zero or b) due to
* a dead-lock caused by this thread waiting for all callers on the other
* threads are done but preventing them from doing so by holding a lock.
*/
{
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
return;
Assert(!isSnapshotMachine());
Assert(!isSessionMachine());
{
/* Theoretically, this can only happen if the VirtualBox server has been
* terminated while there were clients running that owned open direct
* sessions. Since in this case we are definitely called by
* VirtualBox::uninit(), we may be sure that SessionMachine::uninit()
* won't happen on the client watcher thread (because it does
* VirtualBox::addCaller() for the duration of the
* SessionMachine::checkForDeath() call, so that VirtualBox::uninit()
* cannot happen until the VirtualBox caller is released). This is
* important, because SessionMachine::uninit() cannot correctly operate
* after we return from this method (it expects the Machine instance is
* still valid). We'll call it ourselves below.
*/
LogWarningThisFunc(("Session machine is not NULL (%p), the direct session is still open!\n",
{
LogWarningThisFunc(("Setting state to Aborted!\n"));
/* set machine state using SessionMachine reimplementation */
}
/*
* Uninitialize SessionMachine using public uninit() to indicate
* an unexpected uninitialization.
*/
/* SessionMachine::uninit() must set mSession.mMachine to null */
}
/* the lock is no more necessary (SessionMachine is uninitialized) */
// has machine been modified?
if (mData->flModifications)
{
LogWarningThisFunc(("Discarding unsaved settings changes!\n"));
rollback(false /* aNotify */);
}
if (mData->mAccessible)
/* free the essential data structure last */
}
// IMachine properties
/////////////////////////////////////////////////////////////////////////////
{
AutoLimitedCaller autoCaller(this);
/* mParent is constant during life time, no need to lock */
return S_OK;
}
{
AutoLimitedCaller autoCaller(this);
LogFlowThisFunc(("ENTER\n"));
if (!mData->mAccessible)
{
/* try to initialize the VM once more if not accessible */
AutoReinitSpan autoReinitSpan(this);
#ifdef DEBUG
LogFlowThisFunc(("Dumping media backreferences\n"));
#endif
if (mData->pMachineConfigFile)
{
// reset the XML file to force loadSettings() (called from registeredInit())
// to parse it again; the file might have changed
delete mData->pMachineConfigFile;
}
rc = registeredInit();
{
/* make sure interesting parties will notice the accessibility
* state change */
}
}
return rc;
}
{
AutoLimitedCaller autoCaller(this);
{
/* return shortly */
aAccessError = NULL;
return S_OK;
}
{
}
return rc;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoLimitedCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
/* look up the object by Id to check it is valid */
/* when setting, always use the "etalon" value for consistency -- lookup
* by ID is case-insensitive and the input value may have different case */
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
if (!aHWVersion)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
/* check known version */
return setError(E_INVALIDARG,
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
else
return S_OK;
}
{
if (hardwareUUID.isEmpty())
return E_INVALIDARG;
AutoCaller autoCaller(this);
else
return S_OK;
}
{
if (!memorySize)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
/* check RAM limits */
if ( memorySize < MM_RAM_MIN_IN_MB
)
return setError(E_INVALIDARG,
tr("Invalid RAM size: %lu MB (must be in range [%lu, %lu] MB)"),
AutoCaller autoCaller(this);
return S_OK;
}
{
if (!CPUCount)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
/* check CPU limits */
)
return setError(E_INVALIDARG,
tr("Invalid virtual CPU count: %lu (must be in range [%lu, %lu])"),
AutoCaller autoCaller(this);
/* We cant go below the current number of CPUs if hotplug is enabled*/
if (mHWData->mCPUHotPlugEnabled)
{
{
return setError(E_INVALIDARG,
tr(": %lu (must be higher than or equal to %lu)"),
}
}
return S_OK;
}
{
if (!enabled)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
{
if (enabled)
{
/* Add the amount of CPUs currently attached */
{
mHWData->mCPUAttached[i] = true;
}
}
else
{
/*
* We can disable hotplug only if the amount of maximum CPUs is equal
* to the amount of attached CPUs
*/
unsigned cCpusAttached = 0;
unsigned iHighestId = 0;
for (unsigned i = 0; i < SchemaDefs::MaxCPUCount; i++)
{
if (mHWData->mCPUAttached[i])
{
iHighestId = i;
}
}
return setError(E_INVALIDARG,
tr("CPU hotplugging can't be disabled because the maximum number of CPUs is not equal to the amount of CPUs attached\n"));
}
}
return rc;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return rc;
}
{
if (!memorySize)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
/* check VRAM limits */
return setError(E_INVALIDARG,
tr("Invalid VRAM size: %lu MB (must be in range [%lu, %lu] MB)"),
AutoCaller autoCaller(this);
return S_OK;
}
/** @todo this method should not be public */
{
if (!memoryBalloonSize)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
/**
* Set the memory balloon size.
*
* This method is also called from IGuest::COMSETTER(MemoryBalloonSize) so
* we have to make sure that we never call IGuest from here.
*/
{
/* This must match GMMR0Init; currently we only support memory ballooning on all 64-bit hosts except Mac OS X */
#if HC_ARCH_BITS == 64 && (defined(RT_OS_WINDOWS) || defined(RT_OS_SOLARIS) || defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD))
/* check limits */
return setError(E_INVALIDARG,
tr("Invalid memory balloon size: %lu MB (must be in range [%lu, %lu] MB)"),
AutoCaller autoCaller(this);
return S_OK;
#else
#endif
}
{
if (!enabled)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
#ifdef VBOX_WITH_PAGE_SHARING
AutoCaller autoCaller(this);
return S_OK;
#else
#endif
}
{
if (!enabled)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
/** @todo check validity! */
return S_OK;
}
{
if (!enabled)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
/** @todo check validity! */
return S_OK;
}
{
if (!monitorCount)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
/* make sure monitor count is a sensible number */
return setError(E_INVALIDARG,
tr("Invalid monitor count: %lu (must be in range [%lu, %lu])"),
AutoCaller autoCaller(this);
return S_OK;
}
{
if (!biosSettings)
return E_POINTER;
AutoCaller autoCaller(this);
/* mBIOSSettings is constant during life time, no need to lock */
return S_OK;
}
{
if (!aVal)
return E_POINTER;
AutoCaller autoCaller(this);
switch(property)
{
case CPUPropertyType_PAE:
break;
break;
default:
return E_INVALIDARG;
}
return S_OK;
}
{
AutoCaller autoCaller(this);
switch(property)
{
case CPUPropertyType_PAE:
break;
break;
default:
return E_INVALIDARG;
}
return S_OK;
}
STDMETHODIMP Machine::GetCPUIDLeaf(ULONG aId, ULONG *aValEax, ULONG *aValEbx, ULONG *aValEcx, ULONG *aValEdx)
{
AutoCaller autoCaller(this);
switch(aId)
{
case 0x0:
case 0x1:
case 0x2:
case 0x3:
case 0x4:
case 0x5:
case 0x6:
case 0x7:
case 0x8:
case 0x9:
case 0xA:
break;
case 0x80000000:
case 0x80000001:
case 0x80000002:
case 0x80000003:
case 0x80000004:
case 0x80000005:
case 0x80000006:
case 0x80000007:
case 0x80000008:
case 0x80000009:
case 0x8000000A:
break;
default:
}
return S_OK;
}
STDMETHODIMP Machine::SetCPUIDLeaf(ULONG aId, ULONG aValEax, ULONG aValEbx, ULONG aValEcx, ULONG aValEdx)
{
AutoCaller autoCaller(this);
switch(aId)
{
case 0x0:
case 0x1:
case 0x2:
case 0x3:
case 0x4:
case 0x5:
case 0x6:
case 0x7:
case 0x8:
case 0x9:
case 0xA:
break;
case 0x80000000:
case 0x80000001:
case 0x80000002:
case 0x80000003:
case 0x80000004:
case 0x80000005:
case 0x80000006:
case 0x80000007:
case 0x80000008:
case 0x80000009:
case 0x8000000A:
break;
default:
}
return S_OK;
}
{
AutoCaller autoCaller(this);
switch(aId)
{
case 0x0:
case 0x1:
case 0x2:
case 0x3:
case 0x4:
case 0x5:
case 0x6:
case 0x7:
case 0x8:
case 0x9:
case 0xA:
/* Invalidate leaf. */
break;
case 0x80000000:
case 0x80000001:
case 0x80000002:
case 0x80000003:
case 0x80000004:
case 0x80000005:
case 0x80000006:
case 0x80000007:
case 0x80000008:
case 0x80000009:
case 0x8000000A:
/* Invalidate leaf. */
break;
default:
}
return S_OK;
}
{
AutoCaller autoCaller(this);
/* Invalidate all standard leafs. */
/* Invalidate all extended leafs. */
return S_OK;
}
{
if (!aVal)
return E_POINTER;
AutoCaller autoCaller(this);
switch(property)
{
break;
break;
break;
break;
break;
default:
return E_INVALIDARG;
}
return S_OK;
}
{
AutoCaller autoCaller(this);
switch(property)
{
break;
break;
break;
break;
break;
default:
return E_INVALIDARG;
}
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
/* @todo (r=dmik):
* 1. Allow to change the name of the snapshot folder containing snapshots
* 2. Rename the folder on disk instead of just changing the property
* value (to be smart and not to leave garbage). Note that it cannot be
* done here because the change may be rolled back. Thus, the right
* place is #saveSettings().
*/
AutoCaller autoCaller(this);
tr("The snapshot folder of a machine with snapshots cannot be changed (please delete all snapshots first)"));
if (snapshotFolder.isEmpty())
{
if (isInOwnDir())
{
/* the default snapshots folder is 'Snapshots' in the machine dir */
snapshotFolder = "Snapshots";
}
else
{
/* the default snapshots folder is {UUID}, for backwards
* compatibility and to resolve conflicts */
}
}
if (RT_FAILURE(vrc))
tr("Invalid snapshot folder '%ls' (%Rrc)"),
return S_OK;
}
STDMETHODIMP Machine::COMGETTER(MediumAttachments)(ComSafeArrayOut(IMediumAttachment*, aAttachments))
{
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
#ifdef VBOX_WITH_VRDP
if (!vrdpServer)
return E_POINTER;
AutoCaller autoCaller(this);
Assert(!!mVRDPServer);
return S_OK;
#else
#endif
}
{
if (!audioAdapter)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
#ifdef VBOX_WITH_VUSB
AutoCaller autoCaller(this);
# ifdef VBOX_WITH_USB
# endif
#else
/* Note: The GUI depends on this method returning E_NOTIMPL with no
* extended error info to indicate that USB is simply not available
* (w/o treting it as a failure), for example, as in OSE */
#endif /* VBOX_WITH_VUSB */
}
{
AutoLimitedCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
// this is a new machine, and no config file exists yet:
else
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
if (!machineState)
return E_POINTER;
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
? 0
return S_OK;
}
{
AutoCaller autoCaller(this);
/* Note: for machines with no snapshots, we always return FALSE
* (mData->mCurrentStateModified will be TRUE in this case, for historical
* reasons :) */
? FALSE
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
try
{
}
catch (...)
{
}
return S_OK;
}
{
AutoCaller autoCaller(this);
return rc;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
/* Only allow it to be set to true when PoweredOff or Aborted.
(Clearing it is always permitted.) */
if ( aEnabled
&& mData->mRegistered
&& ( !isSessionMachine()
)
)
)
return setError(VBOX_E_INVALID_VM_STATE,
tr("The machine is not powered off (state is %s)"),
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
/* Only allow it to be set to true when PoweredOff or Aborted.
(Clearing it is always permitted.) */
if ( aEnabled
&& mData->mRegistered
&& ( !isSessionMachine()
)
)
)
return setError(VBOX_E_INVALID_VM_STATE,
tr("The machine is not powered off (state is %s)"),
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
/**
* @note Locks objects!
*/
{
AutoCaller autoCaller(this);
/* check the session state */
if (state != SessionState_Unlocked)
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("The given session is busy"));
// get the client's IInternalSessionControl interface
if (!mData->mRegistered)
return setError(E_UNEXPECTED,
tr("The machine '%ls' is not registered"),
/* Hack: in case the session is closing and there is a progress object
* which allows waiting for the session to be closed, take the opportunity
* and do a limited wait (max. 1 second). This helps a lot when the system
* is busy and thus session closing can take a little while. */
{
LogFlowThisFunc(("after waiting: mSession.mState=%s\n", Global::stringifySessionState(mData->mSession.mState)));
}
// try again now
if ( (mData->mSession.mState == SessionState_Locked) // machine is write-locked already (i.e. session machine exists)
&& (lockType == LockType_Shared) // caller wants a shared link to the existing session that holds the write lock:
)
{
// OK, share the session... we are now dealing with three processes:
// 1) VBoxSVC (where this code runs);
// 2) process C: the caller's client process (who wants a shared session);
// 3) process W: the process which already holds the write lock on the machine (write-locking session)
// copy pointers to W (the write-locking session) before leaving lock (these must not be NULL)
/*
* Leave the lock before calling the client process. It's safe here
* since the only thing to do after we get the lock again is to add
* the remote control to the list (which doesn't directly influence
* anything).
*/
// get the console of the session holding the write lock (this is a remote call)
LogFlowThisFunc(("Calling GetRemoteConsole()...\n"));
// the failure may occur w/o any error info (from RPC), so provide one
return setError(VBOX_E_VM_ERROR,
// share the session machine and W's console with the caller's session
LogFlowThisFunc(("Calling AssignRemoteMachine()...\n"));
// the failure may occur w/o any error info (from RPC), so provide one
return setError(VBOX_E_VM_ERROR,
// need to revalidate the state after entering the lock again
{
return setError(VBOX_E_INVALID_SESSION_STATE,
tr("The machine '%ls' was unlocked unexpectedly while attempting to share its session"),
}
// add the caller's session to the list
}
)
{
// sharing not permitted, or machine still unlocking:
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("The machine '%ls' is already locked for a session (or being unlocked)"),
}
else
{
// machine is not locked: then write-lock the machine (create the session machine)
// must not be busy
// get the caller's session PID
if (fLaunchingVMProcess)
{
// this machine is awaiting for a spawning session to be opened:
// then the calling process must be the one that got started by
// launchVMProcess()
return setError(E_ACCESSDENIED,
tr("An unexpected process (PID=0x%08X) has tried to lock the "
"machine '%ls', while only the process started by launchVMProcess (PID=0x%08X) is allowed"),
}
// create the mutable SessionMachine from the current machine
/* NOTE: doing return from this function after this point but
* before the end is forbidden since it may call SessionMachine::uninit()
* (through the ComObjPtr's destructor) which requests the VirtualBox write
* lock while still holding the Machine lock in alock so that a deadlock
* is possible due to the wrong lock order. */
{
/*
* Set the session state to Spawning to protect against subsequent
* attempts to open a session and to unregister the machine after
* we leave the lock.
*/
/*
* Leave the lock before calling the client process -- it will call
* Machine/SessionMachine methods. Leaving the lock here is quite safe
* because the state is Spawning, so that openRemotesession() and
* openExistingSession() calls will fail. This method, called before we
* enter the lock again, will fail because of the wrong PID.
*
* Note that mData->mSession.mRemoteControls accessed outside
* the lock may not be modified when state is Spawning, so it's safe.
*/
LogFlowThisFunc(("Calling AssignMachine()...\n"));
/* The failure may occur w/o any error info (from RPC), so provide one */
)
{
/* complete the remote session initialization */
/* get the console from the direct session */
{
}
/* assign machine & console to the remote session */
{
/*
* after openRemoteSession(), the first and the only
* entry in remoteControls is that remote session
*/
LogFlowThisFunc(("Calling AssignRemoteMachine()...\n"));
/* The failure may occur w/o any error info (from RPC), so provide one */
}
}
/* enter the lock again */
/* Restore the session state */
}
// finalize spawning anyway (this is why we don't return on errors above)
if (fLaunchingVMProcess)
{
/* Note that the progress object is finalized later */
/** @todo Consider checking mData->mSession.mProgress for cancellation
* around here. */
/* We don't reset mSession.mPid here because it is necessary for
* SessionMachine::uninit() to reap the child process later. */
{
/* Close the remote session, remove the remote control from the list
* and reset session state to Closed (@note keep the code in sync
* with the relevant part in openSession()). */
{
}
}
}
else
{
/* memorize PID of the directly opened session */
}
{
/* memorize the direct session control and cache IUnknown for it */
/* associate the SessionMachine with this Machine */
/* request an IUnknown pointer early from the remote party for later
* identity checks (it will be internally cached within mDirectControl
* at least on XPCOM) */
}
/* Leave the lock since SessionMachine::uninit() locks VirtualBox which
* would break the lock order */
/* uninitialize the created session machine on failure */
sessionMachine->uninit();
}
{
/*
* tell the client watcher thread to update the set of
* machines that have open sessions
*/
if (oldState != SessionState_Locked)
/* fire an event */
}
return rc;
}
/**
* @note Locks objects!
*/
{
AutoCaller autoCaller(this);
/* check the session state */
if (state != SessionState_Unlocked)
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("The given session is busy"));
/* get the IInternalSessionControl interface */
/* get the teleporter enable state for the progress object init. */
return rc;
/* create a progress object */
static_cast<IMachine*>(this),
TRUE /* aCancelable */,
2 /* uFirstOperationWeight */,
{
{
/* signal the client watcher thread */
/* fire an event */
}
}
return rc;
}
{
return setError(E_INVALIDARG,
tr("Invalid boot position: %lu (must be in range [1, %lu])"),
if (aDevice == DeviceType_USB)
tr("Booting from USB device is currently not supported"));
AutoCaller autoCaller(this);
return S_OK;
}
{
return setError(E_INVALIDARG,
tr("Invalid boot position: %lu (must be in range [1, %lu])"),
AutoCaller autoCaller(this);
return S_OK;
}
{
LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%d aDevice=%d aType=%d aId=\"%ls\"\n",
AutoCaller autoCaller(this);
// if this becomes true then we need to call saveSettings in the end
// @todo r=dj there is no error handling so far...
bool fNeedsSaveSettings = false;
// request the host lock first, since might be calling Host methods for getting host drives;
// next, protect the media tree all the while we're in here, as well as our member variables
this->lockHandle() COMMA_LOCKVAL_SRC_POS);
/// @todo NEWMEDIA implicit machine registration
if (!mData->mRegistered)
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("Cannot attach storage devices to an unregistered machine"));
return setError(VBOX_E_INVALID_VM_STATE,
tr("Invalid machine state: %s"),
/* Check for an existing controller. */
/* check that the port and device are not out of range. */
if ( (aControllerPort < 0)
|| (aDevice < 0)
)
return setError(E_INVALIDARG,
/* check if the device slot is already busy */
aDevice)))
{
if (pMedium)
{
return setError(VBOX_E_OBJECT_IN_USE,
tr("Medium '%s' is already attached to port %d, device %d of controller '%ls' of this virtual machine"),
}
else
return setError(VBOX_E_OBJECT_IN_USE,
tr("Device is already attached to port %d, device %d of controller '%ls' of this virtual machine"),
}
switch (aType)
{
case DeviceType_HardDisk:
/* find a hard disk by UUID */
break;
case DeviceType_DVD: // @todo r=dj eliminate this, replace with findDVDImage
{
/* first search for host drive */
{
{
/// @todo eliminate this conversion
{
break;
}
}
}
{
/* find a DVD image by UUID */
}
}
else
{
/* null UUID means null medium, which needs no code */
}
break;
case DeviceType_Floppy: // @todo r=dj eliminate this, replace with findFloppyImage
{
/* first search for host drive */
{
{
/// @todo eliminate this conversion
{
break;
}
}
}
{
/* find a floppy image by UUID */
}
}
else
{
/* null UUID means null medium, which needs no code */
}
break;
default:
return setError(E_INVALIDARG,
tr("The device type %d is not recognized"),
(int)aType);
}
)
return setError(VBOX_E_OBJECT_IN_USE,
tr("Medium '%s' is already attached to this virtual machine"),
bool indirect = false;
bool associate = true;
do
{
{
/* check if the medium was attached to the VM before we started
* changing attachments in which case the attachment just needs to
* be restored */
{
{
/* the simplest case: restore the whole attachment
* and return, nothing else to do */
return S_OK;
}
* but don't try to associate it again */
associate = false;
break;
}
}
/* go further only if the attachment is to be indirect */
if (!indirect)
break;
/* perform the so called smart attachment logic for indirect
* attachments. Note that smart attachment is only applicable to base
* hard disks. */
{
/* first, investigate the backup copy of the current hard disk
* attachments to make it possible to re-attach existing diffs to
* another device slot w/o losing their contents */
if (mMediaData.isBackedUp())
{
uint32_t foundLevel = 0;
++it)
{
continue;
{
/* skip the hard disk if its currently attached (we
* cannot attach the same hard disk twice) */
pMedium))
continue;
/* matched device, channel and bus (i.e. attached to the
* same place) will win and immediately stop the search;
* otherwise the attachment that has the youngest
* descendant of medium will be used
*/
{
/* the simplest case: restore the whole attachment
* and return, nothing else to do */
return S_OK;
}
)
{
foundLevel = level;
}
}
}
{
/* use the previously attached hard disk */
/* not implicit, doesn't require association with this VM */
indirect = false;
associate = false;
/* go right to the MediumAttachment creation */
break;
}
}
/* must give up the medium lock and medium tree lock as below we
* go over snapshots, which needs a lock with higher lock order. */
/* then, search through snapshots for the best diff in the given
* hard disk's chain to base the new diff on */
while (snap)
{
uint32_t foundLevel = 0;
++it)
{
continue;
{
/* matched device, channel and bus (i.e. attached to the
* same place) will win and immediately stop the search;
* otherwise the attachment that has the youngest
* descendant of medium will be used
*/
)
{
break;
}
)
{
foundLevel = level;
}
}
}
{
break;
}
}
/* re-lock medium tree and the medium, as we need it below */
/* found a suitable diff, use it as a base */
{
}
}
diff.createObject();
/* Apply the normal locking logic to the entire chain. */
true /* fMediumLockWrite */,
tr("Could not lock medium when creating diff '%s'"),
/* will leave the lock before the potentially lengthy operation, so
* protect with the special state */
mediumLock.leave();
NULL /* aProgress */,
true /* aWait */,
mediumLock.enter();
/* Unlock the media and free the associated memory. */
delete pMediumLockList;
/* use the created diff for the actual attachment */
}
while (0);
{
/* as the last step, associate the medium to the VM */
/* here we can fail because of Deleting, or being in process of
* creating a Diff */
}
/* success: finally remember the attachment */
mMediaData.backup();
if (fNeedsSaveSettings)
{
// save the global settings; for that we should hold only the VirtualBox lock
mParent->saveSettings();
}
return rc;
}
{
LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld\n",
AutoCaller autoCaller(this);
bool fNeedsSaveSettings = false;
return setError(VBOX_E_INVALID_VM_STATE,
tr("Invalid machine state: %s"),
aDevice);
if (!pAttach)
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("No storage device attached to device slot %d on port %d of controller '%ls'"),
if (fNeedsSaveSettings)
{
bool fNeedsGlobalSaveSettings = false;
{
// save the global settings; for that we should hold only the VirtualBox lock
mParent->saveSettings();
}
}
return S_OK;
}
{
LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld aPassthrough=%d\n",
AutoCaller autoCaller(this);
return setError(VBOX_E_INVALID_VM_STATE,
tr("Invalid machine state: %s"),
aDevice);
if (!pAttach)
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("No storage device attached to device slot %d on port %d of controller '%ls'"),
mMediaData.backup();
return setError(E_INVALIDARG,
tr("Setting passthrough rejected as the device attached to device slot %d on port %d of controller '%ls' is not a DVD"),
return S_OK;
}
{
LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld aForce=%d\n",
AutoCaller autoCaller(this);
// we're calling host methods for getting DVD and floppy drives so lock host first
aDevice);
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("No drive attached to device slot %d on port %d of controller '%ls'"),
/* Remember previously mounted medium. The medium before taking the
* backup is not necessarily the same thing. */
switch (mediumType)
{
case DeviceType_DVD:
{
/* find a DVD by host device UUID */
{
++it)
{
{
medium = p;
break;
}
}
}
/* find a DVD by UUID */
}
break;
case DeviceType_Floppy:
{
/* find a Floppy by host device UUID */
{
++it)
{
{
medium = p;
break;
}
}
}
/* find a Floppy by UUID */
}
break;
default:
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("Cannot change medium attached to device slot %d on port %d of controller '%ls'"),
}
{
mMediaData.backup();
/* The backup operation makes the pAttach reference point to the
* old settings. Re-get the correct reference. */
aDevice);
/* For non-hard disk media, detach straight away. */
}
/* On error roll back this change only. */
{
aDevice);
/* If the attachment is gone in the mean time, bail out. */
return rc;
/* For non-hard disk media, re-attach straight away. */
}
return rc;
}
{
LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld\n",
AutoCaller autoCaller(this);
aDevice);
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("No storage device attached to device slot %d on port %d of controller '%ls'"),
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
{
if (ComSafeArrayOutIsNull(aKeys))
return E_POINTER;
AutoCaller autoCaller(this);
int i = 0;
for (settings::ExtraDataItemsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.begin();
++it, ++i)
{
}
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
AutoCaller autoCaller(this);
/* start with nothing found */
settings::ExtraDataItemsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.find(Utf8Str(aKey));
// found:
/* return the result to caller (may be empty) */
return S_OK;
}
/**
* @note Locks mParent for writing + this object for writing.
*/
{
AutoCaller autoCaller(this);
// locking note: we only hold the read lock briefly to look up the old value,
// then release it and call the onExtraCanChange callbacks. There is a small
// chance of a race insofar as the callback might be called twice if two callers
// change the same key at the same time, but that's a much better solution
// than the deadlock we had here before. The actual changing of the extradata
// is then performed under the write lock and race-free.
// look up the old value first; if nothing's changed then we need not do anything
{
settings::ExtraDataItemsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.find(strKey);
}
bool fChanged;
{
// ask for permission from all listeners outside the locks;
// onExtraDataCanChange() only briefly requests the VirtualBox
// lock to copy the list of callbacks to invoke
{
LogWarningFunc(("Someone vetoed! Change refused%s%ls\n",
return setError(E_ACCESSDENIED,
tr("Could not set extra data because someone refused the requested change of '%ls' to '%ls'%s%ls"),
aKey,
sep,
err);
}
// data is changing and change not vetoed: then write it out under the lock
if (isSnapshotMachine())
{
}
else
// creates a new key if needed
bool fNeedsGlobalSaveSettings = false;
{
// save the global settings; for that we should hold only the VirtualBox lock
mParent->saveSettings();
}
}
// fire notification outside the lock
if (fChanged)
return S_OK;
}
{
AutoCaller autoCaller(this);
/* when there was auto-conversion, we want to save the file even if
* the VM is saved */
/* the settings file path may never be null */
/* save all VM data excluding snapshots */
bool fNeedsGlobalSaveSettings = false;
{
// save the global settings; for that we should hold only the VirtualBox lock
}
return rc;
}
{
AutoCaller autoCaller(this);
/*
* during this rollback, the session will be notified if data has
* been actually changed
*/
rollback(true /* aNotify */);
return S_OK;
}
/** @note Locks objects! */
{
AutoCaller autoCaller(this);
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("Cannot unregister the machine '%ls' while it is locked"),
// @todo optionally discard saved state
return setError(VBOX_E_INVALID_VM_STATE,
tr("Cannot unregister the machine '%ls' because it is in the Saved state"),
// @todo optionally nuke snapshots
size_t snapshotCount = 0;
if (mData->mFirstSnapshot)
if (snapshotCount)
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("Cannot unregister the machine '%ls' because it has %d snapshots"),
)
{
// we have media attachments:
if (fCloseMedia)
{
// caller wants automatic detachment: then do that and report all media to the array
// make a temporary list because detachDevice invalidates iterators into
// mMediaData->mAttachments
++it)
{
NULL /* pfNeedsSaveSettings */);
};
}
else
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("Cannot unregister the machine '%ls' because it has %d media attachments"),
}
// commit all the media changes made above
commitMedia();
mData->mRegistered = false;
// machine lock no longer needed
if (fCloseMedia)
{
// now go thru the list of attached media reported by prepareUnregister() and close them all
size_t u = 0;
++it)
{
// this uninitializes the medium
// report the path to the caller
++u;
}
// report all paths to the caller
}
mParent->unregisterMachine(this);
return S_OK;
}
{
AutoCaller autoCaller(this);
if (mData->mRegistered)
return setError(VBOX_E_INVALID_VM_STATE,
tr("Cannot delete settings of a registered machine"));
if (!systemProperties.isNull())
/* delete the settings only when the file actually exists */
{
if (RT_FAILURE(vrc))
return setError(VBOX_E_IPRT_ERROR,
tr("Could not delete the settings file '%s' (%Rrc)"),
vrc);
/* Delete any backup or uncommitted XML files. Ignore failures.
See the fSafe parameter of xml::XmlFileWriter::write for details. */
Utf8Str otherXml = Utf8StrFmt("%s%s", mData->m_strConfigFileFull.c_str(), xml::XmlFileWriter::s_pszTmpSuff);
otherXml = Utf8StrFmt("%s%s", mData->m_strConfigFileFull.c_str(), xml::XmlFileWriter::s_pszPrevSuff);
/* delete the Logs folder, nothing important should be left
* there (we don't check for errors because the user might have
* some private files there that we don't want to delete) */
{
/* Delete all VBox.log[.N] files from the Logs folder
* (this must be in sync with the rotation logic in
* Console::powerUpThread()). Also, delete the VBox.png[.N]
* files that may have been created by the GUI. */
for (int i = uLogHistoryCount; i > 0; i--)
{
}
}
/* delete the Snapshots folder, nothing important should be left
* there (we don't check for errors because the user might have
* some private files there that we don't want to delete) */
/* delete the directory that contains the settings file, but only
* if it matches the VM name (i.e. a structure created by default in
* prepareSaveSettings()) */
{
if (isInOwnDir(&settingsDir))
}
}
return S_OK;
}
{
AutoCaller autoCaller(this);
/* Todo: fix this properly by perhaps introducing an isValid method for the Guid class */
if ( (aId)
{
/* Either it's a null UUID or the conversion failed. (null uuid has a special meaning in findSnapshot) */
tr("Could not find a snapshot with UUID {%ls}"),
aId);
}
return rc;
}
{
AutoCaller autoCaller(this);
return rc;
}
{
/// @todo (dmik) don't forget to set
// mData->mCurrentStateModified to FALSE
}
STDMETHODIMP Machine::CreateSharedFolder(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount)
{
AutoCaller autoCaller(this);
return setError(VBOX_E_OBJECT_IN_USE,
tr("Shared folder named '%ls' already exists"),
aName);
/* inform the direct session if any */
return S_OK;
}
{
AutoCaller autoCaller(this);
/* inform the direct session if any */
return S_OK;
}
{
/* start with No */
AutoCaller autoCaller(this);
{
return setError(VBOX_E_INVALID_VM_STATE,
tr("Machine is not locked for session (session state: %s)"),
}
/* ignore calls made after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
{
AutoCaller autoCaller(this);
{
tr("Machine is not locked for session (session state: %s)"),
}
/* ignore calls made after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
#ifdef VBOX_WITH_GUEST_PROPS
/**
* Look up a guest property in VBoxSVC's internal structures.
*/
{
using namespace guestProp;
{
{
break;
}
}
return S_OK;
}
/**
* Query the VM that a guest property belongs to for the property.
* @returns E_ACCESSDENIED if the VM process is not available or not
* currently handling queries and the lookup should then be done in
* VBoxSVC.
*/
{
/* fail if we were called after #OnSessionEnd() is called. This is a
* silly race condition. */
if (!directControl)
rc = E_ACCESSDENIED;
else
false /* isSetter */,
return rc;
}
#endif // VBOX_WITH_GUEST_PROPS
{
#ifndef VBOX_WITH_GUEST_PROPS
#else // VBOX_WITH_GUEST_PROPS
AutoCaller autoCaller(this);
if (rc == E_ACCESSDENIED)
/* The VM is not running or the service is not (yet) accessible */
return rc;
#endif // VBOX_WITH_GUEST_PROPS
}
{
}
{
}
#ifdef VBOX_WITH_GUEST_PROPS
/**
* Set a guest property in VBoxSVC's internal structures.
*/
{
using namespace guestProp;
bool found = false;
try
{
)
return setError(E_INVALIDARG,
tr("Invalid flag values: '%ls'"),
aFlags);
/** @todo r=bird: see efficiency rant in PushGuestProperty. (Yeah, I
* know, this is simple and do an OK job atm.) */
{
tr("The property '%ls' cannot be changed by the host"),
aName);
else
{
/* The backup() operation invalidates our iterator, so
* get a new one. */
++it)
;
}
found = true;
break;
}
{
if (*aValue)
{
}
}
{
}
)
{
/** @todo r=bird: Why aren't we leaving the lock here? The
* same code in PushGuestProperty does... */
}
}
{
rc = E_OUTOFMEMORY;
}
return rc;
}
/**
* Set a property on the VM that that property belongs to.
* @returns E_ACCESSDENIED if the VM process is not available or not
* currently handling queries and the setting should then be done in
* VBoxSVC.
*/
{
try {
if (!directControl)
rc = E_ACCESSDENIED;
else
(aName,
/** @todo Fix when adding DeleteGuestProperty(),
see defect. */
}
{
rc = E_OUTOFMEMORY;
}
return rc;
}
#endif // VBOX_WITH_GUEST_PROPS
{
#ifndef VBOX_WITH_GUEST_PROPS
#else // VBOX_WITH_GUEST_PROPS
return E_INVALIDARG;
AutoCaller autoCaller(this);
if (rc == E_ACCESSDENIED)
/* The VM is not running or the service is not (yet) accessible */
return rc;
#endif // VBOX_WITH_GUEST_PROPS
}
{
}
#ifdef VBOX_WITH_GUEST_PROPS
/**
* Enumerate the guest properties in VBoxSVC's internal structures.
*/
{
using namespace guestProp;
/*
* Look for matching patterns and build up a list.
*/
++it)
if ( strPatterns.isEmpty()
)
/*
* And build up the arrays for returning the property information.
*/
++it)
{
++iProp;
}
return S_OK;
}
/**
* Enumerate the properties managed by a VM.
* @returns E_ACCESSDENIED if the VM process is not available or not
* currently handling queries and the setting should then be done in
* VBoxSVC.
*/
{
if (!directControl)
rc = E_ACCESSDENIED;
else
return rc;
}
#endif // VBOX_WITH_GUEST_PROPS
{
#ifndef VBOX_WITH_GUEST_PROPS
#else // VBOX_WITH_GUEST_PROPS
return E_POINTER;
AutoCaller autoCaller(this);
if (rc == E_ACCESSDENIED)
/* The VM is not running or the service is not (yet) accessible */
return rc;
#endif // VBOX_WITH_GUEST_PROPS
}
{
return S_OK;
}
{
LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%d aDevice=%d\n",
AutoCaller autoCaller(this);
*aAttachment = NULL;
aDevice);
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("No storage device attached to device slot %d on port %d of controller '%ls'"),
return S_OK;
}
{
if ( (aConnectionType <= StorageBus_Null)
|| (aConnectionType > StorageBus_SAS))
return setError(E_INVALIDARG,
tr("Invalid connection type: %d"),
AutoCaller autoCaller(this);
/* try to find one with the name first. */
return setError(VBOX_E_OBJECT_IN_USE,
tr("Storage controller named '%ls' already exists"),
aName);
ctrl.createObject();
/* get a new instance number for the storage controller */
ULONG ulInstance = 0;
++it)
{
{
if (ulCurInst >= ulInstance)
}
}
/* inform the direct session if any */
return S_OK;
}
{
AutoCaller autoCaller(this);
return rc;
}
{
AutoCaller autoCaller(this);
++it)
{
{
return S_OK;
}
}
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("Could not find a storage controller with instance number '%lu'"),
}
{
AutoCaller autoCaller(this);
/* We can remove the controller only if there is no device attached. */
/* check if the device slot is already busy */
++it)
{
return setError(VBOX_E_OBJECT_IN_USE,
tr("Storage controller named '%ls' has still devices attached"),
aName);
}
/* We can remove it now. */
/* inform the direct session if any */
return S_OK;
}
/* @todo where is the right place for this? */
#define sSSMDisplayScreenshotVer 0x00010001
static int readSavedDisplayScreenshot(Utf8Str *pStateFilePath, uint32_t u32Type, uint8_t **ppu8Data, uint32_t *pcbData, uint32_t *pu32Width, uint32_t *pu32Height)
{
/* @todo cache read data */
if (pStateFilePath->isEmpty())
{
/* No saved state data. */
return VERR_NOT_SUPPORTED;
}
if (RT_SUCCESS(vrc))
{
if (RT_SUCCESS(vrc))
{
if (uVersion == sSSMDisplayScreenshotVer)
{
{
if (typeOfBlock == u32Type)
{
{
{
break;
}
}
else
{
/* No saved state data. */
}
break;
}
else
{
/* displaySSMSaveScreenshot did not write any data, if
* cbBlock was == 2 * sizeof (uint32_t).
*/
{
}
}
}
}
else
{
}
}
}
if (RT_SUCCESS(vrc))
{
{
/* Bitmap is 32bpp, so data is invalid. */
}
}
if (RT_SUCCESS(vrc))
{
*pu32Height = u32Height;
}
return vrc;
}
{
/* @todo not necessary when caching is implemented. */
}
STDMETHODIMP Machine::QuerySavedThumbnailSize(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight)
{
LogFlowThisFunc(("\n"));
if (aScreenId != 0)
return E_NOTIMPL;
AutoCaller autoCaller(this);
int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 0 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
if (RT_FAILURE(vrc))
return setError(VBOX_E_IPRT_ERROR,
tr("Saved screenshot data is not available (%Rrc)"),
vrc);
return S_OK;
}
STDMETHODIMP Machine::ReadSavedThumbnailToArray(ULONG aScreenId, BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData))
{
LogFlowThisFunc(("\n"));
if (aScreenId != 0)
return E_NOTIMPL;
AutoCaller autoCaller(this);
int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 0 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
if (RT_FAILURE(vrc))
return setError(VBOX_E_IPRT_ERROR,
tr("Saved screenshot data is not available (%Rrc)"),
vrc);
/* Convert pixels to format expected by the API caller. */
if (aBGR)
{
/* [0] B, [1] G, [2] R, [3] A. */
for (unsigned i = 0; i < cbData; i += 4)
{
}
}
else
{
/* [0] R, [1] G, [2] B, [3] A. */
for (unsigned i = 0; i < cbData; i += 4)
{
}
}
return S_OK;
}
STDMETHODIMP Machine::QuerySavedScreenshotPNGSize(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight)
{
LogFlowThisFunc(("\n"));
if (aScreenId != 0)
return E_NOTIMPL;
AutoCaller autoCaller(this);
int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
if (RT_FAILURE(vrc))
return setError(VBOX_E_IPRT_ERROR,
tr("Saved screenshot data is not available (%Rrc)"),
vrc);
return S_OK;
}
STDMETHODIMP Machine::ReadSavedScreenshotPNGToArray(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData))
{
LogFlowThisFunc(("\n"));
if (aScreenId != 0)
return E_NOTIMPL;
AutoCaller autoCaller(this);
int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
if (RT_FAILURE(vrc))
return setError(VBOX_E_IPRT_ERROR,
tr("Saved screenshot data is not available (%Rrc)"),
vrc);
for (unsigned i = 0; i < cbData; i++)
return S_OK;
}
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
if (!mHWData->mCPUHotPlugEnabled)
return setError(E_INVALIDARG, tr("CPU id exceeds number of possible CPUs [0:%lu]"), mHWData->mCPUCount-1);
/* Save settings if online */
return S_OK;
}
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
if (!mHWData->mCPUHotPlugEnabled)
return setError(E_INVALIDARG,
tr("CPU index exceeds maximum CPU count (must be in range [0:%lu])"),
/* CPU 0 can't be detached */
if (aCpu == 0)
/* Save settings if online */
return S_OK;
}
{
LogFlowThisFunc(("\n"));
*aCpuAttached = false;
AutoCaller autoCaller(this);
/* If hotplug is enabled the CPU is always enabled. */
if (!mHWData->mCPUHotPlugEnabled)
{
*aCpuAttached = true;
}
else
{
}
return S_OK;
}
{
AutoCaller autoCaller(this);
return S_OK;
}
STDMETHODIMP Machine::ReadLog(ULONG aIdx, ULONG64 aOffset, ULONG64 aSize, ComSafeArrayOut(BYTE, aData))
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
/* do not unnecessarily hold the lock while doing something which does
* not need the lock and potentially takes a long time. */
/* Limit the chunk size to 32K for now, as that gives better performance
* over (XP)COM, and keeps the SOAP reply size under 1M for the webservice.
* One byte expands to approx. 25 bytes of breathtaking XML. */
if (RT_SUCCESS(vrc))
{
if (RT_SUCCESS(vrc))
else
tr("Could not read log file '%s' (%Rrc)"),
}
else
tr("Could not open log file '%s' (%Rrc)"),
return rc;
}
// public methods for internal purposes
/////////////////////////////////////////////////////////////////////////////
/**
* Adds the given IsModified_* flag to the dirty flags of the machine.
* This must be called either during loadSettings or under the machine write lock.
* @param fl
*/
{
}
/**
* Saves the registry entry of this machine to the given configuration node.
*
* @param aEntryNode Node to save the registry entry to.
*
* @note locks this object for reading.
*/
{
AutoLimitedCaller autoCaller(this);
return S_OK;
}
/**
* Calculates the absolute path of the given path taking the directory of the
* machine settings file 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 Locks this object for reading.
*/
{
AutoCaller autoCaller(this);
char folder[RTPATH_MAX];
if (RT_SUCCESS(vrc))
return vrc;
}
/**
* Copies strSource to strTarget, making it relative to the machine folder
* if it is a subdirectory thereof, or simply copying it otherwise.
*
* @param strSource Path to evalue and copy.
* @param strTarget Buffer to receive target path.
*
* @note Locks this object for reading.
*/
{
AutoCaller autoCaller(this);
// use strTarget as a temporary buffer to hold the machine settings dir
// is relative: then append what's left
else
// is not relative: then overwrite
}
/**
* Returns the full path to the machine's log folder in the
* \a aLogFolder argument.
*/
{
AutoCaller autoCaller(this);
if (isInOwnDir(&settingsDir))
{
/* Log folder is <Machines>/<VM_Name>/Logs */
}
else
{
/* Log folder is <Machines>/<VM_SnapshotFolder>/Logs */
}
}
/**
* Returns the full path to the machine's log file for an given index.
*/
{
if (idx == 0)
else
return log;
}
/**
* @note Locks this object for writing, calls the client process
* (inside the lock).
*/
{
AutoCaller autoCaller(this);
if (!mData->mRegistered)
return setError(E_UNEXPECTED,
tr("The machine '%ls' is not registered"),
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("The machine '%ls' is already locked by a session (or being locked or unlocked)"),
/* may not be busy */
/* get the path to the executable */
char szPath[RTPATH_MAX];
int vrc = VINF_SUCCESS;
{
do
{
/* clone the current environment */
/* put new variables to the environment
* (ignore empty variable names here since RTEnv API
* intentionally doesn't do that) */
for (char *p = newEnvStr; *p; ++p)
{
{
*p = '\0';
if (*var)
{
if (val)
{
*val++ = '\0';
}
else
if (RT_FAILURE(vrc2))
break;
}
var = p + 1;
}
}
}
while (0);
}
/* Qt is default */
#ifdef VBOX_WITH_QTGUI
{
# ifdef RT_OS_DARWIN /* Avoid Launch Services confusing this with the selector by using a helper app. */
const char VirtualBox_exe[] = "../Resources/VirtualBoxVM.app/Contents/MacOS/VirtualBoxVM";
# else
# endif
const char * args[] = {szPath, "--comment", strName.c_str(), "--startvm", idStr.c_str(), "--no-startvm-errormsgbox", 0 };
}
#else /* !VBOX_WITH_QTGUI */
if (0)
;
#endif /* VBOX_WITH_QTGUI */
else
#ifdef VBOX_WITH_VBOXSDL
{
}
#else /* !VBOX_WITH_VBOXSDL */
if (0)
;
#endif /* !VBOX_WITH_VBOXSDL */
else
#ifdef VBOX_WITH_HEADLESS
if ( strType == "headless"
|| strType == "capture"
#ifdef VBOX_WITH_VRDP
|| strType == "vrdp"
#endif
)
{
/* Leave space for 2 args, as "headless" needs --vrdp off on non-OSE. */
#ifdef VBOX_WITH_VRDP
if (strType == "headless")
{
}
#endif
if (strType == "capture")
{
}
}
#else /* !VBOX_WITH_HEADLESS */
if (0)
;
#endif /* !VBOX_WITH_HEADLESS */
else
{
return setError(E_INVALIDARG,
tr("Invalid session type: '%s'"),
}
if (RT_FAILURE(vrc))
return setError(VBOX_E_IPRT_ERROR,
tr("Could not launch a process for the machine '%ls' (%Rrc)"),
/*
* Note that we don't leave the lock here before calling the client,
* because it doesn't need to call us back if called with a NULL argument.
* Leaving the lock herer is dangerous because we didn't prepare the
* launch data yet, but the client we've just started may happen to be
* too fast and call openSession() that will fail (because of PID, etc.),
* so that the Machine will never get out of the Spawning session state.
*/
/* inform the session that it will be a remote one */
LogFlowThisFunc(("Calling AssignMachine (NULL)...\n"));
{
/* restore the session state */
/* The failure may occur w/o any error info (from RPC), so provide one */
return setError(VBOX_E_VM_ERROR,
}
/* attach launch data to the machine */
return S_OK;
}
/**
* Returns @c true if the given machine has an open direct session and returns
* the session machine instance and additional session data (on some platforms)
* if so.
*
* Note that when the method returns @c false, the arguments remain unchanged.
*
* @param aMachine Session machine object.
* @param aControl Direct session control object (optional).
* @param aIPCSem Mutex IPC semaphore handle for this machine (optional).
*
* @note locks this object for reading.
*/
#if defined(RT_OS_WINDOWS)
bool aAllowClosing /*= false*/)
bool aAllowClosing /*= false*/)
#else
bool aAllowClosing /*= false*/)
#endif
{
AutoLimitedCaller autoCaller(this);
/* just return false for inaccessible machines */
return false;
)
{
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
/* Additional session data */
#endif
return true;
}
return false;
}
/**
* Returns @c true if the given machine has an spawning direct session and
* returns and additional session data (on some platforms) if so.
*
* Note that when the method returns @c false, the arguments remain unchanged.
*
* @param aPID PID of the spawned direct session process.
*
* @note locks this object for reading.
*/
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
#else
bool Machine::isSessionSpawning()
#endif
{
AutoLimitedCaller autoCaller(this);
/* just return false for inaccessible machines */
return false;
{
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
/* Additional session data */
{
}
#endif
return true;
}
return false;
}
/**
* Called from the client watcher thread to check for unexpected client process
* death during Session_Spawning state (e.g. before it successfully opened a
* direct session).
*
* On Win32 and on OS/2, this method is called only when we've got the
* direct client's process termination notification, so it always returns @c
* true.
*
* On other platforms, this method returns @c true if the client process is
* terminated and @c false if it's still alive.
*
* @note Locks this object for writing.
*/
bool Machine::checkForSpawnFailure()
{
AutoCaller autoCaller(this);
if (!autoCaller.isOk())
{
/* nothing to do */
LogFlowThisFunc(("Already uninitialized!\n"));
return true;
}
/* VirtualBox::addProcessToReap() needs a write lock */
{
/* nothing to do */
LogFlowThisFunc(("Not spawning any more!\n"));
return true;
}
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
/* the process was already unexpectedly terminated, we just need to set an
* error and finalize session spawning */
tr("The virtual machine '%ls' has terminated unexpectedly during startup"),
#else
/* PID not yet initialized, skip check. */
return false;
&status);
if (vrc != VERR_PROCESS_RUNNING)
{
tr("The virtual machine '%ls' has terminated unexpectedly during startup with exit code %d"),
tr("The virtual machine '%ls' has terminated unexpectedly during startup because of signal %d"),
tr("The virtual machine '%ls' has terminated abnormally"),
else
tr("The virtual machine '%ls' has terminated unexpectedly during startup (%Rrc)"),
}
#endif
{
/* Close the remote session, remove the remote control from the list
* and reset session state to Closed (@note keep the code in sync with
* the relevant part in checkForSpawnFailure()). */
{
}
/* finalize the progress after setting the state */
{
}
return true;
}
return false;
}
/**
* Checks whether the machine can be registered. If so, commits and saves
* all settings.
*
* @note Must be called from mParent's write lock. Locks this object and
* children for writing.
*/
{
AutoLimitedCaller autoCaller(this);
/* wait for state dependants to drop to zero */
if (!mData->mAccessible)
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("The machine '%ls' with UUID {%s} is inaccessible and cannot be registered"),
if (mData->mRegistered)
return setError(VBOX_E_INVALID_OBJECT_STATE,
tr("The machine '%ls' with UUID {%s} is already registered"),
// Ensure the settings are saved. If we are going to be registered and
// no config file exists yet, create it by calling saveSettings() too.
if ( (mData->flModifications)
)
{
// no need to check whether VirtualBox.xml needs saving too since
// we can't have a machine XML file rename pending
}
/* more config checking goes here */
{
/* we may have had implicit modifications we want to fix on success */
commit();
mData->mRegistered = true;
}
else
{
/* we may have had implicit modifications we want to cancel on failure*/
rollback(false /* aNotify */);
}
return rc;
}
/**
* Increases the number of objects dependent on the machine state or on the
* registered state. Guarantees that these two states will not change at least
* until #releaseStateDependency() is called.
*
* Depending on the @a aDepType value, additional state checks may be made.
* These checks will set extended error info on failure. See
* #checkStateDependency() for more info.
*
* If this method returns a failure, the dependency is not added and the caller
* is not allowed to rely on any particular machine state or registration state
* value and may return the failed result code to the upper level.
*
* @param aDepType Dependency type to add.
* @param aState Current machine state (NULL if not interested).
* @param aRegistered Current registered state (NULL if not interested).
*
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
{
if (mData->mMachineStateChangePending != 0)
{
/* ensureNoStateDependencies() is waiting for state dependencies to
* drop to zero so don't add more. It may make sense to wait a bit
* and retry before reporting an error (since the pending state
* transition should be really quick) but let's just assert for
* now to see if it ever happens on practice. */
AssertFailed();
return setError(E_ACCESSDENIED,
tr("Machine state change is in progress. Please retry the operation later."));
}
}
if (aState)
if (aRegistered)
return S_OK;
}
/**
* Decreases the number of objects dependent on the machine state.
* Must always complete the #addStateDependency() call after the state
* dependency is no more necessary.
*/
void Machine::releaseStateDependency()
{
AutoCaller autoCaller(this);
/* releaseStateDependency() w/o addStateDependency()? */
-- mData->mMachineStateDeps;
if (mData->mMachineStateDeps == 0)
{
/* inform ensureNoStateDependencies() that there are no more deps */
if (mData->mMachineStateChangePending != 0)
{
}
}
}
// protected methods
/////////////////////////////////////////////////////////////////////////////
/**
* Performs machine state checks based on the @a aDepType value. If a check
* fails, this method will set extended error info, otherwise it will return
* S_OK. It is supposed, that on failure, the caller will immedieately return
* the return value of this method to the upper level.
*
* When @a aDepType is AnyStateDep, this method always returns S_OK.
*
* When @a aDepType is MutableStateDep, this method returns S_OK only if the
* current state of this machine object allows to change settings of the
* machine (i.e. the machine is not registered, or registered but not running
* and not saved). It is useful to call this method from Machine setters
* before performing any change.
*
* When @a aDepType is MutableOrSavedStateDep, this method behaves the same
* as for MutableStateDep except that if the machine is saved, S_OK is also
* returned. This is useful in setters which allow changing machine
* properties when it is in the saved state.
*
* @param aDepType Dependency type to check.
*
* @note Non Machine based classes should use #addStateDependency() and
* #releaseStateDependency() methods or the smart AutoStateDependency
* template.
*
* @note This method must be called from under this object's read or write
* lock.
*/
{
switch (aDepType)
{
case AnyStateDep:
{
break;
}
case MutableStateDep:
{
if ( mData->mRegistered
&& ( !isSessionMachine() /** @todo This was just convered raw; Check if Running and Paused should actually be included here... (Live Migration) */
)
)
)
return setError(VBOX_E_INVALID_VM_STATE,
tr("The machine is not mutable (state is %s)"),
break;
}
case MutableOrSavedStateDep:
{
if ( mData->mRegistered
&& ( !isSessionMachine() /** @todo This was just convered raw; Check if Running and Paused should actually be included here... (Live Migration) */
)
)
)
return setError(VBOX_E_INVALID_VM_STATE,
tr("The machine is not mutable (state is %s)"),
break;
}
}
return S_OK;
}
/**
* Helper to initialize all associated child objects and allocate data
* structures.
*
* This method must be called as a part of the object's initialization procedure
* (usually done in the #init() method).
*
* @note Must be called only from #init() or from #registeredInit().
*/
{
AutoCaller autoCaller(this);
/* allocate data structures */
/* initialize mOSTypeId */
/* create associated BIOS settings object */
mBIOSSettings->init(this);
#ifdef VBOX_WITH_VRDP
/* create an associated VRDPServer object (default is disabled) */
mVRDPServer->init(this);
#endif
/* create associated serial port objects */
{
}
/* create associated parallel port objects */
{
}
/* create the audio adapter object (always present, default is disabled) */
mAudioAdapter->init(this);
/* create the USB controller object (always present, default is disabled) */
mUSBController->init(this);
/* create associated network adapter objects */
{
}
return S_OK;
}
/**
* Helper to uninitialize all associated child objects and to free all data
* structures.
*
* This method must be called as a part of the object's uninitialization
* procedure (usually done in the #uninit() method).
*
* @note Must be called only from #uninit() or from #registeredInit().
*/
void Machine::uninitDataAndChildObjects()
{
AutoCaller autoCaller(this);
/* uninit all children using addDependentChild()/removeDependentChild()
* in their init()/uninit() methods */
/* tell all our other child objects we've been uninitialized */
{
if (mNetworkAdapters[slot])
{
}
}
if (mUSBController)
{
mUSBController->uninit();
}
if (mAudioAdapter)
{
mAudioAdapter->uninit();
}
{
if (mParallelPorts[slot])
{
}
}
{
if (mSerialPorts[slot])
{
}
}
#ifdef VBOX_WITH_VRDP
if (mVRDPServer)
{
mVRDPServer->uninit();
}
#endif
if (mBIOSSettings)
{
mBIOSSettings->uninit();
}
/* Deassociate hard disks (only when a real Machine or a SnapshotMachine
* instance is uninitialized; SessionMachine instances refer to real
* Machine hard disks). This is necessary for a clean re-initialization of
* the VM after successfully re-checking the accessibility state. Note
* that in case of normal Machine or SnapshotMachine uninitialization (as
* a result of unregistering or deleting the snapshot), outdated hard
* disk attachments will already be uninitialized and deleted, so this
* code will not affect them. */
if ( !!mMediaData
&& (!isSessionMachine())
)
{
++it)
{
continue;
}
}
if (!isSessionMachine() && !isSnapshotMachine())
{
// clean up the snapshots list (Snapshot::uninit() will handle the snapshot's children recursively)
if (mData->mFirstSnapshot)
{
// snapshots tree is protected by media write lock; strictly
// this isn't necessary here since we're deleting the entire
// machine, but otherwise we assert in Snapshot::uninit()
}
}
/* free data structures (the essential mData structure is not freed here
* since it may be still in use) */
mMediaData.free();
}
/**
* Returns a pointer to the Machine object for this machine that acts like a
* parent for complex machine data objects such as shared folders, etc.
*
* For primary Machine objects and for SnapshotMachine objects, returns this
* object's pointer itself. For SessoinMachine objects, returns the peer
* (primary) machine pointer.
*/
{
if (isSessionMachine())
return this;
}
/**
* Makes sure that there are no machine state dependants. If necessary, waits
* for the number of dependants to drop to zero.
*
* Make sure this method is called from under this object's write lock to
* guarantee that no new dependants may be added when this method returns
* control to the caller.
*
* @note Locks this object for writing. The lock will be released while waiting
* (if necessary).
*
* @warning To be used only in methods that change the machine state!
*/
void Machine::ensureNoStateDependencies()
{
/* Wait for all state dependants if necessary */
if (mData->mMachineStateDeps != 0)
{
/* lazy semaphore creation */
LogFlowThisFunc(("Waiting for state deps (%d) to drop to zero...\n",
/* reset the semaphore before waiting, the last dependant will signal
* it */
}
}
/**
* Changes the machine state and informs callbacks.
*
* This method is not intended to fail so it either returns S_OK or asserts (and
* returns a failure).
*
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
/* wait for state dependants to drop to zero */
{
}
return S_OK;
}
/**
* Searches for a shared folder with the given logical name
* in the collection of shared folders.
*
* @param aName logical name of the shared folder
* @param aSharedFolder where to return the found object
* @param aSetError whether to set the error info if the folder is
* not found
* @return
* S_OK when found or VBOX_E_OBJECT_NOT_FOUND when not found
*
* @note
* must be called from under the object's lock!
*/
bool aSetError /* = false */)
{
bool found = false;
++it)
{
if (found)
aSharedFolder = *it;
}
return rc;
}
/**
* Initializes all machine instance data from the given settings structures
* from XML. The exception is the machine UUID which needs special handling
* depending on the caller's use case, so the caller needs to set that herself.
*
* @param config
* @param fAllowStorage
*/
{
/* name (required) */
/* nameSync (optional, default is true) */
// guest OS type
/* look up the object by Id to check it is valid */
// stateFile (optional)
else
{
if (RT_FAILURE(vrc))
tr("Invalid saved state file path '%s' (%Rrc)"),
vrc);
}
/* snapshotFolder (optional) */
/* currentStateModified (optional, default is true) */
/* teleportation */
/* RTC */
/*
* note: all mUserData members must be assigned prior this point because
* we need to commit changes in order to let mUserData be shared by all
* snapshot machine instances.
*/
/* Snapshot node (optional) */
{
// there must be only one root snapshot
NULL); // no parent == first snapshot
}
/* Hardware node (required) */
/* Load storage controllers */
/*
* NOTE: the assignment below must be the last thing to do,
* otherwise it will be not possible to change the settings
* somewehere in the code above because all setters will be
* blocked by checkStateDependency(MutableStateDep).
*/
/* set the machine state to Aborted or Saved when appropriate */
{
/* no need to use setMachineState() during init() */
}
{
/* no need to use setMachineState() during init() */
}
// after loading settings, we are no longer different from the XML on disk
mData->flModifications = 0;
return S_OK;
}
/**
* Recursively loads all snapshots starting from the given.
*
* @param aNode <Snapshot> node.
* @param aCurSnapshotId Current snapshot ID from the settings file.
* @param aParentSnapshot Parent snapshot.
*/
const Guid &aCurSnapshotId,
{
{
/* optional */
if (RT_FAILURE(vrc))
tr("Invalid saved state file path '%s' (%Rrc)"),
strStateFile.raw(),
vrc);
}
/* create a snapshot machine object */
/* create a snapshot object */
/* initialize the snapshot */
/* memorize the first snapshot if necessary */
if (!mData->mFirstSnapshot)
/* memorize the current snapshot when appropriate */
if ( !mData->mCurrentSnapshot
)
// now create the children
++it)
{
// recurse
pSnapshot); // parent = the one we created above
}
return rc;
}
/**
* @param aNode <Hardware> node.
*/
{
try
{
/* The hardware version attribute (optional). */
// cpu
if (mHWData->mCPUHotPlugEnabled)
{
++it)
{
}
}
// cpuid leafs
++it)
{
{
case 0x0:
case 0x1:
case 0x2:
case 0x3:
case 0x4:
case 0x5:
case 0x6:
case 0x7:
case 0x8:
case 0x9:
case 0xA:
break;
case 0x80000000:
case 0x80000001:
case 0x80000002:
case 0x80000003:
case 0x80000004:
case 0x80000005:
case 0x80000006:
case 0x80000007:
case 0x80000008:
case 0x80000009:
case 0x8000000A:
break;
default:
/* just ignore */
break;
}
}
// boot order
for (size_t i = 0;
i++)
{
else
}
#ifdef VBOX_WITH_VRDP
/* RemoteDisplay */
#endif
/* BIOS */
/* USB Controller */
// network adapters
++it)
{
/* slot unicity is guaranteed by XML Schema */
}
// serial ports
++it)
{
}
// parallel ports (optional)
++it)
{
}
/* AudioAdapter */
++it)
{
}
// Clipboard
// guest settings
// IO settings
#ifdef VBOX_WITH_GUEST_PROPS
/* Guest properties (optional) */
++it)
{
}
#endif /* VBOX_WITH_GUEST_PROPS defined */
}
{
return E_OUTOFMEMORY;
}
return rc;
}
/**
* @param aNode <StorageControllers> node.
*/
{
++it)
{
/* Try to find one with the name first. */
return setError(VBOX_E_OBJECT_IN_USE,
tr("Storage controller named '%s' already exists"),
pCtl.createObject();
/* Set IDE emulation settings (only for AHCI controller). */
{
)
return rc;
}
/* Load the attached devices now. */
}
return S_OK;
}
/**
* @param aNode <HardDiskAttachments> node.
* @param fAllowStorage if false, we produce an error if the config requests media attachments
* (used with importing unregistered machines which cannot have media attachments)
* @param aSnapshotId pointer to the snapshot ID if this is a snapshot machine
*
* @note Lock mParent for reading and hard disks for writing before calling.
*/
{
/* paranoia: detect duplicate attachments */
++it)
{
++it2)
{
continue;
{
tr("Duplicate attachments for storage controller '%s', port %d, device %d of the virtual machine '%ls'"),
}
}
}
++it)
{
switch (dev.deviceType)
{
case DeviceType_Floppy:
/* find a floppy by UUID */
/* find a floppy by host device name */
{
{
{
/// @todo eliminate this conversion
{
break;
}
}
}
}
break;
case DeviceType_DVD:
/* find a DVD by UUID */
/* find a DVD by host device name */
{
{
{
/// @todo eliminate this conversion
{
break;
}
}
}
}
break;
case DeviceType_HardDisk:
{
/* find a hard disk by UUID */
{
if (isSnapshotMachine())
{
// wrap another error message around the "cannot find hard disk" set by findHardDisk
// so the user knows that the bad disk is in a snapshot somewhere
tr("A differencing image of snapshot {%RTuuid} could not be found. %ls"),
aSnapshotId->raw(),
}
else
return rc;
}
{
if (isSnapshotMachine())
tr("Immutable hard disk '%s' with UUID {%RTuuid} cannot be directly attached to snapshot with UUID {%RTuuid} "
"of the virtual machine '%ls' ('%s')"),
aSnapshotId->raw(),
tr("Immutable hard disk '%s' with UUID {%RTuuid} cannot be directly attached to the virtual machine '%ls' ('%s')"),
}
if ( !isSnapshotMachine()
)
tr("Hard disk '%s' with UUID {%RTuuid} cannot be directly attached to the virtual machine '%ls' ('%s') "
"because it has %d differencing child hard disks"),
medium))
tr("Hard disk '%s' with UUID {%RTuuid} is already attached to the virtual machine '%ls' ('%s')"),
break;
}
default:
tr("Device with unknown type is attached to the virtual machine '%s' ('%s')"),
}
break;
/* associate the medium with this machine and snapshot */
{
if (isSnapshotMachine())
else
}
break;
/* back up mMediaData to let registeredInit() properly rollback on failure
* (= limited accessibility) */
mMediaData.backup();
}
return rc;
}
/**
* Returns the snapshot with the given UUID or fails of no such snapshot exists.
*
* @param aId snapshot UUID to find (empty UUID refers the first snapshot)
* @param aSnapshot where to return the found snapshot
* @param aSetError true to set extended error info on failure
*/
bool aSetError /* = false */)
{
if (!mData->mFirstSnapshot)
{
if (aSetError)
tr("This machine does not have any snapshots"));
return E_FAIL;
}
else
if (!aSnapshot)
{
if (aSetError)
tr("Could not find a snapshot with UUID {%s}"),
return E_FAIL;
}
return S_OK;
}
/**
* Returns the snapshot with the given name or fails of no such snapshot.
*
* @param aName snapshot name to find
* @param aSnapshot where to return the found snapshot
* @param aSetError true to set extended error info on failure
*/
bool aSetError /* = false */)
{
if (!mData->mFirstSnapshot)
{
if (aSetError)
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("This machine does not have any snapshots"));
return VBOX_E_OBJECT_NOT_FOUND;
}
if (!aSnapshot)
{
if (aSetError)
return setError(VBOX_E_OBJECT_NOT_FOUND,
return VBOX_E_OBJECT_NOT_FOUND;
}
return S_OK;
}
/**
* Returns a storage controller object with the given name.
*
* @param aName storage controller name to find
* @param aStorageController where to return the found storage controller
* @param aSetError true to set extended error info on failure
*/
bool aSetError /* = false */)
{
++it)
{
{
aStorageController = (*it);
return S_OK;
}
}
if (aSetError)
return setError(VBOX_E_OBJECT_NOT_FOUND,
tr("Could not find a storage controller named '%s'"),
return VBOX_E_OBJECT_NOT_FOUND;
}
{
AutoCaller autoCaller(this);
++it)
{
// should never happen, but deal with NULL pointers in the list.
// getControllerName() needs caller+read lock
{
return autoAttCaller.rc();
}
}
return S_OK;
}
/**
* Helper for #saveSettings. Cares about renaming the settings directory and
* file if the machine name was changed and about creating a new settings file
* if this is a new machine.
*
* @note Must be never called directly but only from #saveSettings().
*/
{
/* attempt to rename the settings file if machine name is changed */
&& mUserData.isBackedUp()
)
{
bool dirRenamed = false;
bool fileRenamed = false;
do
{
int vrc = VINF_SUCCESS;
/* first, rename the directory if it matches the machine name */
{
/* new dir and old dir cannot be equal here because of 'if'
* above and because name != newName */
if (!fSettingsFileIsNew)
{
/* perform real rename only if the machine is not new */
if (RT_FAILURE(vrc))
{
tr("Could not rename the directory '%s' to '%s' to save the settings file (%Rrc)"),
newConfigDir.raw(),
vrc);
break;
}
dirRenamed = true;
}
}
/* then try to rename the settings file itself */
if (newConfigFile != configFile)
{
/* get the path to old settings file in renamed directory */
newConfigDir.raw(),
if (!fSettingsFileIsNew)
{
/* perform real rename only if the machine is not new */
if (RT_FAILURE(vrc))
{
tr("Could not rename the settings file '%s' to '%s' (%Rrc)"),
configFile.raw(),
newConfigFile.raw(),
vrc);
break;
}
fileRenamed = true;
}
}
/* update m_strConfigFileFull amd mConfigFile */
// compute the relative path too
// store the old and new so that VirtualBox::saveSettings() can update
// the media registry
if ( mData->mRegistered
&& configDir != newConfigDir)
{
*pfNeedsGlobalSaveSettings = true;
}
/* update the snapshot folder */
{
}
/* update the saved state file path */
{
}
/* Update saved state file paths of all online snapshots.
* Note that saveSettings() will recognize name change
* and will save all snapshots in this case. */
if (mData->mFirstSnapshot)
newConfigDir.c_str());
}
while (0);
{
/* silently try to rename everything back */
if (fileRenamed)
if (dirRenamed)
}
}
if (fSettingsFileIsNew)
{
/* create a virgin config file */
int vrc = VINF_SUCCESS;
/* ensure the settings directory exists */
{
if (RT_FAILURE(vrc))
{
tr("Could not create a directory '%s' to save the settings file (%Rrc)"),
vrc);
}
}
/* Note: open flags must correlate with RTFileOpen() in lockConfig() */
RTFILE f = NIL_RTFILE;
if (RT_FAILURE(vrc))
tr("Could not create the settings file '%s' (%Rrc)"),
vrc);
RTFileClose(f);
}
return rc;
}
/**
* Saves and commits machine data, user data and hardware data.
*
* Note that on failure, the data remains uncommitted.
*
* @a aFlags may combine the following flags:
*
* - SaveS_ResetCurStateModified: Resets mData->mCurrentStateModified to FALSE.
* Used when saving settings after an operation that makes them 100%
* correspond to the settings from the current snapshot.
* - SaveS_InformCallbacksAnyway: Callbacks will be informed even if
* #isReallyModified() returns false. This is necessary for cases when we
* change machine data directly, not through the backup()/commit() mechanism.
* - SaveS_Force: settings will be saved without doing a deep compare of the
* settings structures. This is used when this is called because snapshots
* have changed to avoid the overhead of the deep compare.
*
* @note Must be called from under this object's write lock. Locks children for
* writing.
*
* @param pfNeedsGlobalSaveSettings Optional pointer to a bool that must have been
* initialized to false and that will be set to true by this function if
* the caller must invoke VirtualBox::saveSettings() because the global
* settings have changed. This will happen if a machine rename has been
* saved and the global machine and media registries will therefore need
* updating.
*/
int aFlags /*= 0*/)
{
/* make sure child objects are unable to modify the settings while we are
* saving them */
E_FAIL);
bool fNeedsWrite = false;
/* First, prepare to save settings. It will care about renaming the
* settings directory and file if the machine name was changed and about
* creating a new settings file if this is a new machine. */
// keep a pointer to the current settings structures
try
{
// make a fresh one to have everyone write stuff into
// now go and copy all the settings data from COM to the settings structures
// (this calles saveSettings() on all the COM objects in the machine)
{
// this gets set by takeSnapshot() (if offline snapshot) and restoreSnapshot()
fNeedsWrite = true; // always, no need to compare
}
else if (aFlags & SaveS_Force)
{
fNeedsWrite = true; // always, no need to compare
}
else
{
if (!mData->mCurrentStateModified)
{
// do a deep compare of the settings that we just saved with the settings
// previously stored in the config file; this invokes MachineConfigFile::operator==
// which does a deep compare of all the settings, which is expensive but less expensive
// than writing out XML in vain
// could still be modified if any settings changed
}
else
fNeedsWrite = true;
}
if (fNeedsWrite)
// now spit it all out!
delete pOldConfig;
commit();
// after saving settings, we are no longer different from the XML on disk
mData->flModifications = 0;
}
{
// we assume that error info is set by the thrower
// restore old config
delete pNewConfig;
}
catch (...)
{
}
{
/* Fire the data change event, even on failure (since we've already
* committed all data). This is done only for SessionMachines because
* mutable Machine instances are always not registered (i.e. private
* to the client process that creates them) and thus don't need to
* inform callbacks. */
if (isSessionMachine())
}
return rc;
}
/**
* Implementation for saving the machine settings into the given
* settings::MachineConfigFile instance. This copies machine extradata
* from the previous machine config file in the instance data, if any.
*
* This gets called from two locations:
*
* -- Machine::saveSettings(), during the regular XML writing;
*
* -- Appliance::buildXMLForOneVirtualSystem(), when a machine gets
* exported to OVF and we write the VirtualBox proprietary XML
* into a <vbox:Machine> tag.
*
* This routine fills all the fields in there, including snapshots, *except*
* for the following:
*
* -- fCurrentStateModified. There is some special logic associated with that.
*
* The caller can then call MachineConfigFile::write() or do something else
* with it.
*
* Caller must hold the machine lock!
*
* This throws XML errors and HRESULT, so the caller must have a catch block!
*/
{
// deep copy extradata
// when deleting a snapshot we may or may not have a saved state in the current state,
// so let's not assert here please
)
)
{
/* try to make the file name relative to the settings file dir */
}
else
{
}
if (mData->mCurrentSnapshot)
else
// config.fCurrentStateModified is special, see below
/// @todo Live Migration: config.fTeleported = (mData->mMachineState == MachineState_Teleported);
// save snapshots
}
/**
* Saves all snapshots of the machine into the given machine config file. Called
* from Machine::buildMachineXML() and SessionMachine::deleteSnapshotHandler().
* @param config
* @return
*/
{
try
{
if (mData->mFirstSnapshot)
{
// get reference to the fresh copy of the snapshot on the list and
// work on that copy directly to avoid excessive copying later
}
// if (mType == IsSessionMachine)
// mParent->onMachineDataChange(mData->mUuid); @todo is this necessary?
}
{
/* we assume that error info is set by the thrower */
}
catch (...)
{
}
return rc;
}
/**
* Saves the VM hardware configuration. It is assumed that the
* given node is empty.
*
* @param aNode <Hardware> node to save the VM hardware confguration to.
*/
{
try
{
/* The hardware version attribute (optional).
Automatically upgrade from 1 to 2 when there is no saved state. (ugly!) */
)
mHWData->mHWVersion = "2"; /** @todo Is this safe, to update mHWVersion here? If not some other point needs to be found where this can be done. */
// CPU
/* Standard and Extended CPUID leafs. */
{
}
{
}
if (data.fCpuHotPlug)
{
{
{
}
}
}
// memory
// firmware
// HID
// HPET
// boot order
for (size_t i = 0;
++i)
// display
#ifdef VBOX_WITH_VRDP
/* VRDP settings (optional) */
#endif
/* BIOS (required) */
/* USB Controller (required) */
/* Network adapters (required) */
++slot)
{
}
/* Serial ports */
++slot)
{
settings::SerialPort s;
}
/* Parallel ports */
++slot)
{
settings::ParallelPort p;
}
/* Audio adapter */
/* Shared folders */
++it)
{
}
// clipboard
/* Guest */
// IO settings
// guest properties
#ifdef VBOX_WITH_GUEST_PROPS
++it)
{
/* Remove transient guest properties at shutdown unless we
* are saving state */
continue;
}
/* I presume this doesn't require a backup(). */
#endif /* VBOX_WITH_GUEST_PROPS defined */
}
{
return E_OUTOFMEMORY;
}
return rc;
}
/**
* Saves the storage controller configuration.
*
* @param aNode <StorageControllers> node to save the VM hardware confguration to.
*/
{
++it)
{
/* Save the port count. */
/* Save fUseHostIOCache */
/* Save IDE emulation settings. */
{
)
}
/* save the devices now. */
}
return S_OK;
}
/**
* Saves the hard disk confguration.
*/
{
++it)
{
if (pMedium)
{
return rc;
if (fHostDrive)
else
}
}
return S_OK;
}
/**
* Saves machine state settings as defined by aFlags
* (SaveSTS_* values).
*
* @param aFlags Combination of SaveSTS_* flags.
*
* @note Locks objects for writing.
*/
{
if (aFlags == 0)
return S_OK;
AutoCaller autoCaller(this);
/* This object's write lock is also necessary to serialize file access
* (prevent concurrent reads and writes) */
try
{
if (aFlags & SaveSTS_CurStateModified)
if (aFlags & SaveSTS_StateFilePath)
{
/* try to make the file name relative to the settings file dir */
else
}
if (aFlags & SaveSTS_StateTimeStamp)
{
//@todo live migration mData->pMachineConfigFile->fTeleported = (mData->mMachineState == MachineState_Teleported);
}
}
catch (...)
{
}
return rc;
}
/**
* Creates differencing hard disks for all normal hard disks attached to this
* machine and a new set of attachments to refer to created disks.
*
* Used when taking a snapshot or when deleting the current state.
*
* This method assumes that mMediaData contains the original hard disk attachments
* it needs to create diffs for. On success, these attachments will be replaced
* with the created diffs. On failure, #deleteImplicitDiffs() is implicitly
* called to delete created diffs which will also rollback mMediaData and restore
* whatever was backed up before calling this method.
*
* Attachments with non-normal hard disks are left as is.
*
* If @a aOnline is @c false then the original hard disks that require implicit
* diffs will be locked for reading. Otherwise it is assumed that they are
* already locked for writing (when the VM was started). Note that in the latter
* case it is responsibility of the caller to lock the newly created diffs for
* writing if this method succeeds.
*
* @param aFolder Folder where to create diff hard disks.
* @param aProgress Progress object to run (must contain at least as
* many operations left as the number of hard disks
* attached).
* @param aOnline Whether the VM was online prior to this operation.
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note The progress object is not marked as completed, neither on success nor
* on failure. This is a responsibility of the caller.
*
* @note Locks this object for writing.
*/
bool aOnline,
bool *pfNeedsSaveSettings)
{
AutoCaller autoCaller(this);
/* must be in a protective state because we leave the lock below */
, E_FAIL);
if (aOnline)
else
try
{
if (!aOnline)
{
/* lock all attached hard disks early to detect "in use"
* situations before creating actual diffs */
++it)
{
{
false /* fMediumLockWrite */,
NULL,
{
delete pMediumLockList;
throw rc;
}
{
tr("Collecting locking information for all attached media failed"));
}
}
}
/* Now lock all media. If this fails, nothing is locked. */
{
tr("Locking of attached media failed"));
}
}
/* remember the current list (note that we don't use backup() since
* mMediaData may be already backed up) */
/* start from scratch */
/* go through remembered attachments and create diffs for normal hard
* disks and attach them */
++it)
{
if ( devType != DeviceType_HardDisk
{
/* copy the attachment as is */
/** @todo the progress object created in Console::TakeSnaphot
* only expects operations for hard disks. Later other
* device types need to show up in the progress as well. */
if (devType == DeviceType_HardDisk)
{
aWeight); // weight
else
aWeight); // weight
}
continue;
}
/* need a diff */
aWeight); // weight
diff.createObject();
/** @todo r=bird: How is the locking and diff image cleaned up if we fail before
* the push_back? Looks like we're going to leave medium with the
* wrong kind of lock (general issue with if we fail anywhere at all)
* and an orphaned VDI in the snapshots folder. */
/* update the appropriate lock list */
if (aOnline)
{
}
/* leave the lock before the potentially lengthy operation */
NULL /* aProgress */,
true /* aWait */,
/* add a new attachment */
diff,
true /* aImplicit */);
}
}
/* unlock all hard disks we locked */
if (!aOnline)
{
}
{
}
return rc;
}
/**
* Deletes implicit differencing hard disks created either by
* #createImplicitDiffs() or by #AttachMedium() and rolls back mMediaData.
*
* Note that to delete hard disks created by #AttachMedium() this method is
* called from #fixupMedia() when the changes are rolled back.
*
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
/* enumerate new attachments */
++it)
{
continue;
if ((*it)->isImplicit())
{
/* deassociate and mark for deletion */
continue;
}
/* was this hard disk attached before? */
{
/* no: de-associate */
continue;
}
}
/* rollback hard disk changes */
/* delete unused implicit diffs */
if (implicitAtts.size() != 0)
{
/* will leave the lock before the potentially lengthy
* operation, so protect with the special state (unless already
* protected) */
if ( oldState != MachineState_Saving
)
++it)
{
AssertMsg(SUCCEEDED(rc), ("rc=%Rhrc it=%s hd=%s\n", rc, (*it)->getLogName(), hd->getLocationFull().c_str() ));
}
{
}
}
return mrc;
}
/**
* Looks through the given list of media attachments for one with the given parameters
* and returns it, or NULL if not found. The list is a parameter so that backup lists
* can be searched as well if needed.
*
* @param list
* @param aControllerName
* @param aControllerPort
* @param aDevice
* @return
*/
{
++it)
{
return pAttach;
}
return NULL;
}
/**
* Looks through the given list of media attachments for one with the given parameters
* and returns it, or NULL if not found. The list is a parameter so that backup lists
* can be searched as well if needed.
*
* @param list
* @param aControllerName
* @param aControllerPort
* @param aDevice
* @return
*/
{
++it)
{
if (pMediumThis == pMedium)
return pAttach;
}
return NULL;
}
/**
* Looks through the given list of media attachments for one with the given parameters
* and returns it, or NULL if not found. The list is a parameter so that backup lists
* can be searched as well if needed.
*
* @param list
* @param aControllerName
* @param aControllerPort
* @param aDevice
* @return
*/
{
++it)
{
return pAttach;
}
return NULL;
}
/**
* Main implementation for Machine::DetachDevice. This also gets called
* from Machine::prepareUnregister() so it has been taken out for simplicity.
*
* @param pAttach Medium attachment to detach.
* @param writeLock Machine write lock which the caller must have locked once. This may be released temporarily in here.
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
* @return
*/
bool *pfNeedsSaveSettings)
{
if (pAttach->isImplicit())
{
/* attempt to implicitly delete the implicitly created diff */
/// @todo move the implicit flag from MediumAttachment to Medium
/// and forbid any hard disk operation when it is implicit. Or maybe
/// a special media state for it to make it even more simple.
/* will leave the lock before the potentially lengthy operation, so
* protect with the special state */
}
mMediaData.backup();
/* we cannot use erase (it) below because backup() above will create
* a copy of the list and make this copy active, but the iterator
* still refers to the original and is not valid for the copy */
/* For non-hard disk media, detach straight away. */
return S_OK;
}
/**
* Perform deferred hard disk detachments.
*
* Does nothing if the hard disk attachment data (mMediaData) is not changed (not
* backed up).
*
* If @a aOnline is @c true then this method will also unlock the old hard disks
* for which the new implicit diffs were created and will lock these new diffs for
* writing.
*
* @param aOnline Whether the VM was online prior to this operation.
*
* @note Locks this object for writing!
*/
{
AutoCaller autoCaller(this);
if (!mMediaData.isBackedUp())
return;
bool fMediaNeedsLocking = false;
/* enumerate new attachments */
++it)
{
LogFlowThisFunc(("Examining current medium '%s' (implicit: %d)\n",
fImplicit));
/** @todo convert all this Machine-based voodoo to MediumAttachment
* based commit logic. */
if (fImplicit)
{
/* convert implicit attachment to normal */
pAttach->setImplicit(false);
if ( aOnline
&& pMedium
)
{
/* update the appropriate lock list */
if (pMediumLockList)
{
/* unlock if there's a need to change the locking */
if (!fMediaNeedsLocking)
{
fMediaNeedsLocking = true;
}
}
}
continue;
}
if (pMedium)
{
/* was this medium attached before? */
++oldIt)
{
{
LogFlowThisFunc(("--> medium '%s' was attached before, will not remove\n", pMedium->getName().raw()));
/* yes: remove from old to avoid de-association */
break;
}
}
}
}
/* enumerate remaining old attachments and de-associate from the
* current machine state */
++it)
{
* instantly in MountMedium. */
{
/* now de-associate from the current machine state */
if (aOnline)
{
/* unlock since medium is not used anymore */
if (pMediumLockList)
{
}
}
}
}
/* take media locks again so that the locking state is consistent */
if (fMediaNeedsLocking)
{
}
/* commit the hard disk changes */
mMediaData.commit();
if (isSessionMachine())
{
/* attach new data to the primary machine and reshare it */
}
return;
}
/**
* Perform deferred deletion of implicitly created diffs.
*
* Does nothing if the hard disk attachment data (mMediaData) is not changed (not
* backed up).
*
* @param pfNeedsSaveSettings Optional pointer to a bool that must have been initialized to false and that will be set to true
* by this function if the caller should invoke VirtualBox::saveSettings() because the global settings have changed.
*
* @note Locks this object for writing!
*/
void Machine::rollbackMedia()
{
AutoCaller autoCaller(this);
LogFlowThisFunc(("Entering\n"));
if (!mMediaData.isBackedUp())
return;
/* enumerate new attachments */
++it)
{
{
if (pMedium)
{
}
}
{
if (pMedium)
{
}
}
}
/** @todo convert all this Machine-based voodoo to MediumAttachment
* based rollback logic. */
// @todo r=dj the below totally fails if this gets called from Machine::rollback(),
// which gets called if Machine::registeredInit() fails...
return;
}
/**
* Returns true if the settings file is located in the directory named exactly
* as the machine. This will be true if the machine settings structure was
* created by default in #openConfigLoader().
*
* @param aSettingsDir if not NULL, the full machine settings file directory
* name will be assigned there.
*
* @note Doesn't lock anything.
* @note Not thread safe (must be called from this object's lock).
*/
{
AssertReturn(dirName, false);
/* if we don't rename anything on name change, return false shorlty */
return false;
if (aSettingsDir)
}
/**
* Discards all changes to machine settings.
*
* @param aNotify Whether to notify the direct session about changes or not.
*
* @note Locks objects for writing!
*/
{
AutoCaller autoCaller(this);
if (!mStorageControllers.isNull())
{
if (mStorageControllers.isBackedUp())
{
/* unitialize all new devices (absent in the backed up list). */
{
== backedList->end()
)
{
}
++it;
}
/* restore the list */
}
/* rollback any changes to devices after restoring the list */
{
{
++it;
}
}
}
if (mBIOSSettings)
#ifdef VBOX_WITH_VRDP
mVRDPServer->rollback();
#endif
if (mAudioAdapter)
if ( mNetworkAdapters[slot]
{
}
if ( mSerialPorts[slot]
{
}
if ( mParallelPorts[slot]
{
}
if (aNotify)
{
/* inform the direct session about changes */
if (flModifications & IsModified_USB)
if (networkAdapters[slot])
if (serialPorts[slot])
if (parallelPorts[slot])
}
}
/**
* Commits all the changes to machine settings.
*
* Note that this operation is supposed to never fail.
*
* @note Locks this object and children for writing.
*/
{
AutoCaller autoCaller(this);
/*
* use safe commit to ensure Snapshot machines (that share mUserData)
* will still refer to a valid memory location
*/
if (mMediaData.isBackedUp())
commitMedia();
mBIOSSettings->commit();
#ifdef VBOX_WITH_VRDP
mVRDPServer->commit();
#endif
mAudioAdapter->commit();
mUSBController->commit();
bool commitStorageControllers = false;
if (mStorageControllers.isBackedUp())
{
if (mPeer)
{
/* Commit all changes to new controllers (this will reshare data with
* peers for thos who have peers) */
{
/* look if this controller has a peer device */
if (!peer)
{
/* no peer means the device is a newly created one;
* create a peer owning data this device share it with */
peer.createObject();
}
else
{
/* remove peer from the old list */
}
/* and add it to the new list */
++it;
}
/* uninit old peer's controllers that are left */
{
++it;
}
/* attach new list of controllers to our peer */
}
else
{
/* we have no peer (our parent is the newly created machine);
* just commit changes to devices */
commitStorageControllers = true;
}
}
else
{
/* the list of controllers itself is not changed,
* just commit changes to controllers themselves */
commitStorageControllers = true;
}
{
{
++it;
}
}
if (isSessionMachine())
{
/* attach new data to the primary machine and reshare it */
/* mMediaData is reshared by fixupMedia */
// mPeer->mMediaData.attach(mMediaData);
}
}
/**
* Copies all the hardware data from the given machine.
*
* Currently, only called when the VM is being restored from a snapshot. In
* particular, this implies that the VM is not running during this method's
* call.
*
* @note This method must be called from under this object's lock.
*
* @note This method doesn't call #commit(), so all data remains backed up and
* unsaved.
*/
{
// create copies of all shared folders (mHWData after attiching a copy
// contains just references to original objects)
++it)
{
}
#ifdef VBOX_WITH_VRDP
#endif
/* create private copies of all controllers */
++it)
{
ctrl.createObject();
}
}
#ifdef VBOX_WITH_RESOURCE_USAGE_API
{
/* Create sub metrics */
"Percentage of processor time spent in user mode by the VM process.");
"Percentage of processor time spent in kernel mode by the VM process.");
"Size of resident portion of VM process in memory.");
/* Create and register base metrics */
new pm::AggregateAvg()));
new pm::AggregateMin()));
new pm::AggregateMax()));
new pm::AggregateAvg()));
new pm::AggregateMin()));
new pm::AggregateMax()));
new pm::AggregateAvg()));
new pm::AggregateMin()));
new pm::AggregateMax()));
/* Guest metrics */
/* Create sub metrics */
"Percentage of processor time spent in user mode as seen by the guest.");
"Percentage of processor time spent in kernel mode as seen by the guest.");
"Percentage of processor time spent idling as seen by the guest.");
/* The total amount of physical ram is fixed now, but we'll support dynamic guest ram configurations in the future. */
pm::SubMetric *guestMemTotal = new pm::SubMetric("Guest/RAM/Usage/Total", "Total amount of physical guest RAM.");
pm::SubMetric *guestMemFree = new pm::SubMetric("Guest/RAM/Usage/Free", "Free amount of physical guest RAM.");
pm::SubMetric *guestMemBalloon = new pm::SubMetric("Guest/RAM/Usage/Balloon", "Amount of ballooned physical guest RAM.");
pm::SubMetric *guestMemShared = new pm::SubMetric("Guest/RAM/Usage/Shared", "Amount of shared physical guest RAM.");
pm::SubMetric *guestMemCache = new pm::SubMetric("Guest/RAM/Usage/Cache", "Total amount of guest (disk) cache memory.");
pm::SubMetric *guestPagedTotal = new pm::SubMetric("Guest/Pagefile/Usage/Total", "Total amount of space in the page file.");
/* Create and register base metrics */
pm::BaseMetric *guestCpuLoad = new pm::GuestCpuLoad(mGuestHAL, aMachine, guestLoadUser, guestLoadKernel, guestLoadIdle);
pm::BaseMetric *guestCpuMem = new pm::GuestRamUsage(mGuestHAL, aMachine, guestMemTotal, guestMemFree, guestMemBalloon, guestMemShared,
}
{
if (aCollector)
{
}
if (mGuestHAL)
{
delete mGuestHAL;
}
}
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
////////////////////////////////////////////////////////////////////////////////
{
LogFlowThisFunc(("\n"));
#if defined(RT_OS_WINDOWS)
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
mIPCSem = -1;
#else
# error "Port me!"
#endif
return S_OK;
}
void SessionMachine::FinalRelease()
{
LogFlowThisFunc(("\n"));
}
/**
* @note Must be called only by Machine::openSession() from its own write lock.
*/
{
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
/* create the interprocess semaphore */
#if defined(RT_OS_WINDOWS)
if (mIPCSemName[i] == '\\')
mIPCSemName[i] = '/';
("Cannot create IPC mutex '%ls', err=%d",
E_FAIL);
("Cannot create IPC mutex '%s', arc=%ld",
E_FAIL);
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
/** @todo Check that this still works correctly. */
# else
# endif
mIPCSem = -1;
mIPCKey = "0";
{
{
if (sem >= 0)
break;
}
}
# else /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
char *pszSemName = NULL;
# endif /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
{
tr("Cannot create IPC semaphore. Most likely your host kernel lacks "
"support for SysV IPC. Check the host kernel configuration for "
"CONFIG_SYSVIPC=y"));
return E_FAIL;
}
/* ENOSPC can also be the result of VBoxSVC crashes without properly freeing
* the IPC semaphores */
{
#ifdef RT_OS_LINUX
tr("Cannot create IPC semaphore because the system limit for the "
"maximum number of semaphore sets (SEMMNI), or the system wide "
"maximum number of sempahores (SEMMNS) would be exceeded. The "
"current set of SysV IPC semaphores can be determined from "
#else
tr("Cannot create IPC semaphore because the system-imposed limit "
"on the maximum number of allowed semaphores or semaphore "
"identifiers system-wide would be exceeded"));
#endif
return E_FAIL;
}
E_FAIL);
/* set the initial value to 1 */
E_FAIL);
#else
# error "Port me!"
#endif
/* memorize the peer Machine */
/* share the parent pointer */
/* take the pointers to data to share */
++it)
{
ctl.createObject();
}
#ifdef VBOX_WITH_VRDP
/* create another VRDPServer object that will be mutable */
#endif
/* create another audio adapter object that will be mutable */
/* create a list of serial ports that will be mutable */
{
}
/* create a list of parallel ports that will be mutable */
{
}
/* create another USB controller object that will be mutable */
/* create a list of network adapters that will be mutable */
{
}
/* default is to delete saved state on Saved -> PoweredOff transition */
mRemoveSavedState = true;
/* Confirm a successful initialization when it's the case */
return S_OK;
}
/**
* Uninitializes this session object. If the reason is other than
* Uninit::Unexpected, then this method MUST be called from #checkForDeath().
*
* @param aReason uninitialization reason
*
* @note Locks mParent + this object for writing.
*/
{
/*
* Strongly reference ourselves to prevent this object deletion after
* mData->mSession.mMachine.setNull() below (which can release the last
* reference and call the destructor). Important: this must be done before
* accessing any members (and before AutoUninitSpan that does it as well).
* This self reference will be released as the very last step on return.
*/
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
{
LogFlowThisFunc(("Already uninitialized\n"));
return;
}
if (autoUninitSpan.initFailed())
{
/* We've been called by init() because it's failed. It's not really
* necessary (nor it's safe) to perform the regular uninit sequense
* below, the following is enough.
*/
LogFlowThisFunc(("Initialization failed.\n"));
#if defined(RT_OS_WINDOWS)
if (mIPCSem)
::CloseHandle(mIPCSem);
if (mIPCSem != NULLHANDLE)
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
if (mIPCSem >= 0)
mIPCSem = -1;
# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
mIPCKey = "0";
# endif /* VBOX_WITH_NEW_SYS_V_KEYGEN */
#else
# error "Port me!"
#endif
return;
}
{
}
#ifdef VBOX_WITH_USB
// release all captured USB devices, but do this before requesting the locks below
{
/* Console::captureUSBDevices() is called in the VM process only after
* setting the machine state to Starting or Restoring.
* Console::detachAllUSBDevices() will be called upon successful
* termination. So, we need to release USB devices only if there was
* an abnormal termination of a running VM.
*
* This is identical to SessionMachine::DetachAllUSBDevices except
* for the aAbnormal argument. */
if (service)
}
#endif /* VBOX_WITH_USB */
// we need to lock this object in uninit() because the lock is shared
// with mPeer (as well as data we modify below). mParent->addProcessToReap()
// and others need mParent lock, and USB needs host lock.
// Trigger async cleanup tasks, avoid doing things here which are not
// vital to be done immediately and maybe need more locks. This calls
// Machine::unregisterMetrics().
{
LogWarningThisFunc(("ABNORMAL client termination! (wasBusy=%d)\n",
/* reset the state to Aborted */
}
// any machine settings modified?
if (mData->flModifications)
{
LogWarningThisFunc(("Discarding unsaved settings changes!\n"));
rollback(false /* aNotify */);
}
{
LogWarningThisFunc(("canceling failed save state request!\n"));
}
{
LogWarningThisFunc(("canceling untaken snapshot!\n"));
/* delete all differencing hard disks created (this will also attach
* their parents back by rolling back mMediaData) */
/* delete the saved state file (it might have been already created) */
}
{
/* mType is not null when this machine's process has been started by
* Machine::launchVMProcess(), therefore it is our child. We
* need to queue the PID to reap the process (and avoid zombies on
* Linux). */
}
{
/* Uninitialization didn't come from #checkForDeath(), so tell the
* client watcher thread to update the set of machines that have open
* sessions. */
}
/* uninitialize all remote controls */
{
LogFlowThisFunc(("Closing remote sessions (%d):\n",
{
LogFlowThisFunc((" Calling remoteControl->Uninitialize()...\n"));
LogWarningThisFunc(("Forgot to close the remote session?\n"));
++it;
}
}
/*
* An expected uninitialization can come only from #checkForDeath().
* Otherwise it means that something's got really wrong (for examlple,
* the Session implementation has released the VirtualBox reference
* before it triggered #OnSessionEnd(), or before releasing IPC semaphore,
* etc). However, it's also possible, that the client releases the IPC
* semaphore correctly (i.e. before it releases the VirtualBox reference),
* but the VirtualBox release event comes first to the server process.
* This case is practically possible, so we should not assert on an
* unexpected uninit, just log a warning.
*/
LogWarningThisFunc(("Unexpected SessionMachine uninitialization!\n"));
{
}
else
{
/* this must be null here (see #OnSessionEnd()) */
}
{
else
tr("The VM session was aborted"));
}
/* remove the association between the peer machine and this session machine */
/* reset the rest of session data */
/* close the interprocess semaphore before leaving the exclusive lock */
#if defined(RT_OS_WINDOWS)
if (mIPCSem)
::CloseHandle(mIPCSem);
if (mIPCSem != NULLHANDLE)
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
if (mIPCSem >= 0)
mIPCSem = -1;
# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
mIPCKey = "0";
# endif /* VBOX_WITH_NEW_SYS_V_KEYGEN */
#else
# error "Port me!"
#endif
/* fire an event */
/* free the essential data structure last */
#if 1 /** @todo Please review this change! (bird) */
/* drop the exclusive lock before setting the below two to NULL */
#else
/* leave the exclusive lock before setting the below two to NULL */
#endif
}
// util::Lockable interface
////////////////////////////////////////////////////////////////////////////////
/**
* Overrides VirtualBoxBase::lockHandle() in order to share the lock handle
* with the primary Machine instance (mPeer).
*/
{
return mPeer->lockHandle();
}
// IInternalMachineControl methods
////////////////////////////////////////////////////////////////////////////////
/**
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
return S_OK;
}
/**
* @note Locks the same as #setMachineState() does.
*/
{
return setMachineState(aMachineState);
}
/**
* @note Locks this object for reading.
*/
{
AutoCaller autoCaller(this);
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
return S_OK;
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
# else /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
# endif /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
return S_OK;
#else
# error "Port me!"
#endif
}
/**
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
return VBOX_E_INVALID_OBJECT_STATE;
return S_OK;
}
/**
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
return VBOX_E_INVALID_OBJECT_STATE;
/* Finalize the openRemoteSession progress object. */
{
{
#ifdef VBOX_WITH_RESOURCE_USAGE_API
/* The VM has been powered up successfully, so it makes sense
* now to offer the performance metrics for a running machine
* object. Doing it earlier wouldn't be safe. */
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
}
}
return S_OK;
}
/**
* Goes through the USB filters of the given machine to see if the given
* device matches any filter or not.
*
* @note Locks the same as USBController::hasMatchingFilter() does.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
#ifdef VBOX_WITH_USB
#else
#endif
return S_OK;
}
/**
* @note Locks the same as Host::captureUSBDevice() does.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
#ifdef VBOX_WITH_USB
/* if captureDeviceForVM() fails, it must have set extended error info */
#else
return E_NOTIMPL;
#endif
}
/**
* @note Locks the same as Host::detachUSBDevice() does.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
#ifdef VBOX_WITH_USB
#else
return E_NOTIMPL;
#endif
}
/**
* Inserts all machine filters to the USB proxy service and then calls
* Host::autoCaptureUSBDevices().
*
* Called by Console from the VM process upon VM startup.
*
* @note Locks what called methods lock.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
#ifdef VBOX_WITH_USB
return service->autoCaptureDevicesForVM(this);
#else
return S_OK;
#endif
}
/**
* Removes all machine filters from the USB proxy service and then calls
* Host::detachAllUSBDevices().
*
* Called by Console from the VM process upon normal VM termination or by
* SessionMachine::uninit() upon abnormal VM termination (from under the
* Machine/SessionMachine lock).
*
* @note Locks what called methods lock.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
#ifdef VBOX_WITH_USB
#else
return S_OK;
#endif
}
/**
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
/*
* We don't assert below because it might happen that a non-direct session
* informs us it is closed right after we've been uninitialized -- it's ok.
*/
/* get IInternalSessionControl interface */
/* Creating a Progress object requires the VirtualBox lock, and
* thus locking it here is required by the lock order rules. */
{
/* The direct session is being normally closed by the client process
* ----------------------------------------------------------------- */
/* go to the closing state (essential for all open*Session() calls and
* for #checkForDeath()) */
/* set direct control to NULL to release the remote instance */
LogFlowThisFunc(("Direct control is set to NULL\n"));
{
/* finalize the progress, someone might wait if a frontend
* closes the session before powering on the VM. */
tr("The VM session was closed before any attempt to power it on"));
}
/* Create the progress object the client will use to wait until
* #checkForDeath() is called to uninitialize this session object after
* it releases the IPC semaphore.
* Note! Because we're "reusing" mProgress here, this must be a proxy
* object just like for openRemoteSession. */
FALSE /* aCancelable */);
}
else
{
/* the remote session is being normally closed */
{
break;
++it;
}
}
return S_OK;
}
/**
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
E_FAIL);
/* memorize the progress ID and add it to the global collection */
/* stateFilePath is null when the machine is not running */
{
}
/* fill in the snapshot data */
/* set the state to Saving (this is expected by Console::SaveState()) */
return S_OK;
}
/**
* @note Locks mParent + this object for writing.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
/* endSavingState() need mParent lock */
E_FAIL);
/*
* on success, set the state to Saved;
* on failure, set the state to the state we had when BeginSavingState() was
* called (this is expected by Console::SaveState() and
* Console::saveStateThread())
*/
if (aSuccess)
else
return endSavingState(aSuccess);
}
/**
* @note Locks this object for writing.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
, E_FAIL); /** @todo setError. */
if (RT_FAILURE(vrc))
return setError(VBOX_E_FILE_ERROR,
tr("Invalid saved state file path '%ls' (%Rrc)"),
vrc);
/* The below setMachineState() will detect the state transition and will
* update the settings file */
return setMachineState(MachineState_Saved);
}
{
LogFlowThisFunc(("\n"));
#ifdef VBOX_WITH_GUEST_PROPS
using namespace guestProp;
AutoCaller autoCaller(this);
unsigned i = 0;
++it)
{
/* If it is NULL, keep it NULL. */
{
}
else
++i;
}
return S_OK;
#else
#endif
}
{
LogFlowThisFunc(("\n"));
#ifdef VBOX_WITH_GUEST_PROPS
using namespace guestProp;
return E_POINTER; /* aValue can be NULL to indicate deletion */
try
{
/*
* Convert input up front.
*/
if (aFlags)
{
}
/*
* Now grab the object lock, validate the state and do the update.
*/
AutoCaller autoCaller(this);
switch (mData->mMachineState)
{
case MachineState_Paused:
case MachineState_Running:
case MachineState_Teleporting:
case MachineState_Saving:
break;
default:
}
/** @todo r=bird: The careful memory handling doesn't work out here because
* the catch block won't undo any damange we've done. So, if push_back throws
* bad_alloc then you've lost the value.
*
* Another thing. Doing a linear search here isn't extremely efficient, esp.
* since values that changes actually bubbles to the end of the list. Using
* something that has an efficient lookup and can tollerate a bit of updates
* would be nice. RTStrSpace is one suggestion (it's not perfect). Some
* combination of RTStrCache (for sharing names and getting uniqueness into
++iter)
{
break;
}
{
}
/*
* Send a callback notification if appropriate
*/
)
{
aFlags);
}
}
catch (...)
{
}
return S_OK;
#else
#endif
}
// public methods only for internal purposes
/////////////////////////////////////////////////////////////////////////////
/**
* Called from the client watcher thread to check for expected or unexpected
* death of the client process that has a direct session to this machine.
*
* On Win32 and on OS/2, this method is called only when we've got the
* mutex (i.e. the client has either died or terminated normally) so it always
* returns @c true (the client is terminated, the session machine is
* uninitialized).
*
* On other platforms, the method returns @c true if the client process has
* terminated normally or abnormally and the session machine was uninitialized,
* and @c false if the client process is still alive.
*
* @note Locks this object for writing.
*/
bool SessionMachine::checkForDeath()
{
bool terminated = false;
/* Enclose autoCaller with a block because calling uninit() from under it
* will deadlock. */
{
AutoCaller autoCaller(this);
if (!autoCaller.isOk())
{
/* return true if not ready, to cause the client watcher to exclude
* the corresponding session from watching */
LogFlowThisFunc(("Already uninitialized!\n"));
return true;
}
/* Determine the reason of death: if the session state is Closing here,
* everything is fine. Otherwise it means that the client did not call
* OnSessionEnd() before it released the IPC semaphore. This may happen
* either because the client process has abnormally terminated, or
* because it simply forgot to call ISession::Close() before exiting. We
* threat the latter also as an abnormal termination (see
* Session::uninit() for details). */
#if defined(RT_OS_WINDOWS)
/* release the IPC mutex */
::ReleaseMutex(mIPCSem);
terminated = true;
/* release the IPC mutex */
terminated = true;
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
if (val > 0)
{
/* the semaphore is signaled, meaning the session is terminated */
terminated = true;
}
#else
# error "Port me!"
#endif
} /* AutoCaller block */
if (terminated)
return terminated;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
return directControl->OnStorageControllerChange();
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
return directControl->OnUSBControllerChange();
}
/**
* @note Locks this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
{
}
/* ignore notifications sent after #OnSessionEnd() is called */
if (!directControl)
return S_OK;
}
/**
* Returns @c true if this machine's USB controller reports it has a matching
* filter for the given USB device and @c false otherwise.
*
* @note Caller must have requested machine read lock.
*/
bool SessionMachine::hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs)
{
AutoCaller autoCaller(this);
/* silently return if not ready -- this method may be called after the
* direct machine session has been called */
if (!autoCaller.isOk())
return false;
#ifdef VBOX_WITH_USB
switch (mData->mMachineState)
{
case MachineState_Starting:
case MachineState_Restoring:
case MachineState_Paused:
case MachineState_Running:
/** @todo Live Migration: snapshoting & teleporting. Need to fend things of
* elsewhere... */
default: break;
}
#else
#endif
return false;
}
/**
* @note The calls shall hold no locks. Will temporarily lock this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
/* This notification may happen after the machine object has been
* uninitialized (the session was closed), so don't assert. */
{
}
/* fail on notifications sent after #OnSessionEnd() is called, it is
* expected by the caller */
if (!directControl)
return E_FAIL;
/* No locks should be held at this point. */
AssertMsg(RTLockValidatorWriteLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorWriteLockGetCount(RTThreadSelf())));
AssertMsg(RTLockValidatorReadLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorReadLockGetCount(RTThreadSelf())));
}
/**
* @note The calls shall hold no locks. Will temporarily lock this object for reading.
*/
{
LogFlowThisFunc(("\n"));
AutoCaller autoCaller(this);
/* This notification may happen after the machine object has been
* uninitialized (the session was closed), so don't assert. */
{
}
/* fail on notifications sent after #OnSessionEnd() is called, it is
* expected by the caller */
if (!directControl)
return E_FAIL;
/* No locks should be held at this point. */
AssertMsg(RTLockValidatorWriteLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorWriteLockGetCount(RTThreadSelf())));
AssertMsg(RTLockValidatorReadLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorReadLockGetCount(RTThreadSelf())));
}
// protected methods
/////////////////////////////////////////////////////////////////////////////
/**
* Helper method to finalize saving the state.
*
* @note Must be called from under this object's lock.
*
* @param aSuccess TRUE if the snapshot has been taken successfully
*
* @note Locks mParent + this objects for writing.
*/
{
AutoCaller autoCaller(this);
if (aSuccess)
{
/* save all VM settings */
// no need to check whether VirtualBox.xml needs saving also since
// we can't have a name change pending at this point
}
else
{
/* delete the saved state file (it might have been already created) */
}
/* remove the completed progress object */
/* clear out the temporary saved state data */
return rc;
}
/**
* Locks the attached media.
*
* reading. Parents of attached hard disks (if any) are locked for reading.
*
* This method also performs accessibility check of all media it locks: if some
* media is inaccessible, the method will return a failure and a bunch of
* extended error info objects per each inaccessible medium.
*
* Note that this method is atomic: if it returns a success, all media are
* locked as described above; on failure no media is locked at all (all
* succeeded individual locks will be undone).
*
* This method is intended to be called when the machine is in Starting or
* Restoring state and asserts otherwise.
*
* The locks made by this method must be undone by calling #unlockMedia() when
* no more needed.
*/
{
AutoCaller autoCaller(this);
/* bail out if trying to lock things with already set up locking */
/* Collect locking information for all medium objects attached to the VM. */
++it)
{
// it's impossible to create a medium lock list. It still makes sense
// to have the empty medium lock list in the map in case a medium is
// attached later.
{
|| mediumType == MediumType_Shareable;
!fIsReadOnlyImage /* fMediumLockWrite */,
NULL,
{
delete pMediumLockList;
break;
}
}
{
tr("Collecting locking information for all attached media failed"));
break;
}
}
{
/* Now lock all media. If this fails, nothing is locked. */
{
tr("Locking of attached media failed"));
}
}
return mrc;
}
/**
* Undoes the locks made by by #lockMedia().
*/
void SessionMachine::unlockMedia()
{
AutoCaller autoCaller(this);
/* we may be holding important error info on the current thread;
* preserve it */
}
/**
* Helper to change the machine state (reimplementation).
*
* @note Locks this object for writing.
*/
{
AutoCaller autoCaller(this);
("oldMachineState=%s, aMachineState=%s\n",
E_FAIL);
int stsFlags = 0;
bool deleteSavedState = false;
/* detect some state transitions */
if ( ( oldMachineState == MachineState_Saved
|| ( ( oldMachineState == MachineState_PoweredOff
)
)
)
)
{
/* The EMT thread is about to start */
/* Nothing to do here for now... */
/// @todo NEWMEDIA don't let mDVDDrive and other children
}
else if ( ( oldMachineState == MachineState_Running
)
&& ( aMachineState == MachineState_PoweredOff
)
/* ignore PoweredOff->Saving->PoweredOff transition when taking a
* snapshot */
|| mSnapshotData.mLastState >= MachineState_Running /** @todo Live Migration: clean up (lazy bird) */
)
)
{
/* The EMT thread has just stopped, unlock attached media. Note that as
* opposed to locking that is done from Console, we do unlocking here
* because the VM process may have aborted before having a chance to
* properly unlock all media it locked. */
unlockMedia();
}
{
if (aMachineState != MachineState_Saved)
{
/*
* delete the saved state file once the machine has finished
* restoring from it (note that Console sets the state from
* Restoring to Saved if the VM couldn't restore successfully,
* to give the user an ability to fix an error and retry --
* we keep the saved state file in this case)
*/
deleteSavedState = true;
}
}
else if ( oldMachineState == MachineState_Saved
&& ( aMachineState == MachineState_PoweredOff
)
)
{
/*
* delete the saved state after Console::ForgetSavedState() is called
* or if the VM process (owning a direct VM session) crashed while the
* VM was Saved
*/
/// @todo (dmik)
// Not sure that deleting the saved state file just because of the
// client death before it attempted to restore the VM is a good
// thing. But when it crashes we need to go to the Aborted state
// which cannot have the saved state file associated... The only
// way to fix this is to make the Aborted condition not a VM state
// but a bool flag: i.e., when a crash occurs, set it to true and
// change the state to PoweredOff or Saved depending on the
// saved state presence.
deleteSavedState = true;
}
if ( aMachineState == MachineState_Starting
)
{
/* set the current state modified flag to indicate that the current
* state is no more identical to the state in the
* current snapshot */
{
}
}
if (deleteSavedState)
{
if (mRemoveSavedState)
{
}
}
/* redirect to the underlying peer machine */
if ( aMachineState == MachineState_PoweredOff
|| aMachineState == MachineState_Saved)
{
/* the machine has stopped execution
* (or the saved state file was adopted) */
}
if ( ( oldMachineState == MachineState_PoweredOff
)
&& aMachineState == MachineState_Saved)
{
/* the saved state file was adopted */
}
if ( aMachineState == MachineState_PoweredOff
{
/* Make sure any transient guest properties get removed from the
* property store on shutdown. */
if (!fNeedsSaving)
{
fNeedsSaving = true;
break;
}
if (fNeedsSaving)
{
SaveSettings(); // @todo r=dj why the public method? why first SaveSettings and then saveStateSettings?
}
}
if ( ( oldMachineState != MachineState_PoweredOff
)
&& ( aMachineState == MachineState_PoweredOff
)
)
{
/* we've been shut down for any reason */
/* no special action so far */
}
return rc;
}
/**
* Sends the current machine state value to the VM process.
*
* @note Locks this object for reading, then calls a client process.
*/
{
AutoCaller autoCaller(this);
{
/* directControl may be already set to NULL here in #OnSessionEnd()
* called too early by the direct session process while there is still
* some operation (like deleting the snapshot) in progress. The client
* process in this case is waiting inside Session::close() for the
* "end session" process object to complete, while #uninit() called by
* #checkForDeath() on the Watcher thread is waiting for the pending
* operation to complete. For now, we accept this inconsitent behavior
* and simply do nothing here. */
return S_OK;
}
}