#ifndef ____H_MACHINEIMPL

#define ____H_MACHINEIMPL

#include "VirtualBoxBase.h"

#include "SnapshotImpl.h"

#include "ProgressImpl.h"

#include "VRDEServerImpl.h"

#include "MediumAttachmentImpl.h"

#include "PciDeviceAttachmentImpl.h"

#include "MediumLock.h"

#include "NetworkAdapterImpl.h"

#include "AudioAdapterImpl.h"

#include "SerialPortImpl.h"

#include "ParallelPortImpl.h"

#include "BIOSSettingsImpl.h"

#include "StorageControllerImpl.h" // required for MachineImpl.h to compile on Windows

#include "BandwidthControlImpl.h"

#include "BandwidthGroupImpl.h"

#include "VBox/settings.h"

#ifdef VBOX_WITH_RESOURCE_USAGE_API

#include "Performance.h"

#include "PerformanceImpl.h"

#endif /* VBOX_WITH_RESOURCE_USAGE_API */

#include "SchemaDefs.h"

#include "VBox/com/ErrorInfo.h"

#include <iprt/file.h>

#include <iprt/thread.h>

#include <iprt/time.h>

#include <list>

class Progress;

class ProgressProxy;

class Keyboard;

class Mouse;

class Display;

class MachineDebugger;

class USBController;

class Snapshot;

class SharedFolder;

class HostUSBDevice;

class StorageController;

class SessionMachine;

namespace settings

{

class MachineConfigFile;

struct Snapshot;

struct Hardware;

struct Storage;

struct StorageController;

struct MachineRegistryEntry;

}

class ATL_NO_VTABLE Machine :

public VirtualBoxBase,

VBOX_SCRIPTABLE_IMPL(IMachine)

{

Q_OBJECT

public:

enum StateDependency

{

AnyStateDep = 0, MutableStateDep, MutableOrSavedStateDep

};

/**

struct Data

{

/**

struct Session

{

/** Control of the direct session opened by lockMachine() */

ComPtr<IInternalSessionControl> mDirectControl;

typedef std::list<ComPtr<IInternalSessionControl> > RemoteControlList;

/** list of controls of all opened remote sessions */

RemoteControlList mRemoteControls;

/** launchVMProcess() and OnSessionEnd() progress indicator */

ComObjPtr<ProgressProxy> mProgress;

/**

RTPROCESS mPid;

/** Current session state */

SessionState_T mState;

/** Session type string (for indirect sessions) */

Bstr mType;

/** Session machine object */

ComObjPtr<SessionMachine> mMachine;

/** Medium object lock collection. */

MediumLockListMap mLockedMedia;

};

Data();

~Data();

const Guid mUuid;

BOOL mRegistered;

Utf8Str m_strConfigFile;

Utf8Str m_strConfigFileFull;

// machine settings XML file

settings::MachineConfigFile *pMachineConfigFile;

uint32_t flModifications;

BOOL mAccessible;

com::ErrorInfo mAccessError;

MachineState_T mMachineState;

RTTIMESPEC mLastStateChange;

/* Note: These are guarded by VirtualBoxBase::stateLockHandle() */

uint32_t mMachineStateDeps;

RTSEMEVENTMULTI mMachineStateDepsSem;

uint32_t mMachineStateChangePending;

BOOL mCurrentStateModified;

/** Guest properties have been modified and need saving since the

BOOL mGuestPropertiesModified;

Session mSession;

ComObjPtr<Snapshot> mFirstSnapshot;

ComObjPtr<Snapshot> mCurrentSnapshot;

// list of files to delete in Delete(); this list is filled by Unregister()

std::list<Utf8Str> llFilesToDelete;

};

/**

struct SSData

{

Utf8Str strStateFilePath;

};

/**

struct UserData

{

settings::MachineUserData s;

};

/**

struct HWData

{

/**

struct GuestProperty {

/** Property name */

Utf8Str strName;

/** Property value */

Utf8Str strValue;

/** Property timestamp */

LONG64 mTimestamp;

/** Property flags */

ULONG mFlags;

};

HWData();

~HWData();

Bstr mHWVersion;

Guid mHardwareUUID; /**< If Null, use mData.mUuid. */

ULONG mMemorySize;

ULONG mMemoryBalloonSize;

BOOL mPageFusionEnabled;

ULONG mVRAMSize;

ULONG mMonitorCount;

BOOL mHWVirtExEnabled;

BOOL mHWVirtExExclusive;

BOOL mHWVirtExNestedPagingEnabled;

BOOL mHWVirtExLargePagesEnabled;

BOOL mHWVirtExVPIDEnabled;

BOOL mHWVirtExForceEnabled;

BOOL mAccelerate2DVideoEnabled;

BOOL mPAEEnabled;

BOOL mSyntheticCpu;

ULONG mCPUCount;

BOOL mCPUHotPlugEnabled;

ULONG mCpuExecutionCap;

BOOL mAccelerate3DEnabled;

BOOL mHpetEnabled;

BOOL mCPUAttached[SchemaDefs::MaxCPUCount];

settings::CpuIdLeaf mCpuIdStdLeafs[10];

settings::CpuIdLeaf mCpuIdExtLeafs[10];

DeviceType_T mBootOrder[SchemaDefs::MaxBootPosition];

typedef std::list< ComObjPtr<SharedFolder> > SharedFolderList;

SharedFolderList mSharedFolders;

ClipboardMode_T mClipboardMode;

typedef std::list<GuestProperty> GuestPropertyList;

GuestPropertyList mGuestProperties;

Utf8Str mGuestPropertyNotificationPatterns;

FirmwareType_T mFirmwareType;

KeyboardHidType_T mKeyboardHidType;

PointingHidType_T mPointingHidType;

ChipsetType_T mChipsetType;

BOOL mIoCacheEnabled;

ULONG mIoCacheSize;

typedef std::list< ComObjPtr<PciDeviceAttachment> > PciDeviceAssignmentList;

PciDeviceAssignmentList mPciDeviceAssignments;

};

/**

struct MediaData

{

MediaData();

~MediaData();

typedef std::list< ComObjPtr<MediumAttachment> > AttachmentList;

AttachmentList mAttachments;

};

VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(Machine, IMachine)

DECLARE_NOT_AGGREGATABLE(Machine)

DECLARE_PROTECT_FINAL_CONSTRUCT()

BEGIN_COM_MAP(Machine)

VBOX_DEFAULT_INTERFACE_ENTRIES(IMachine)

END_COM_MAP()

DECLARE_EMPTY_CTOR_DTOR(Machine)

HRESULT FinalConstruct();

void FinalRelease();

// public initializer/uninitializer for internal purposes only:

// initializer for creating a new, empty machine

HRESULT init(VirtualBox *aParent,

const Utf8Str &strConfigFile,

const Utf8Str &strName,

GuestOSType *aOsType,

const Guid &aId,

bool fForceOverwrite);

// initializer for loading existing machine XML (either registered or not)

HRESULT init(VirtualBox *aParent,

const Utf8Str &strConfigFile,

const Guid *aId);

// initializer for machine config in memory (OVF import)

HRESULT init(VirtualBox *aParent,

const Utf8Str &strName,

const settings::MachineConfigFile &config);

void uninit();

#ifdef VBOX_WITH_RESOURCE_USAGE_API

// Needed from VirtualBox, for the delayed metrics cleanup.

void unregisterMetrics(PerformanceCollector *aCollector, Machine *aMachine);

#endif /* VBOX_WITH_RESOURCE_USAGE_API */

protected:

HRESULT initImpl(VirtualBox *aParent,

const Utf8Str &strConfigFile);

HRESULT initDataAndChildObjects();

HRESULT registeredInit();

HRESULT tryCreateMachineConfigFile(bool fForceOverwrite);

void uninitDataAndChildObjects();

public:

// IMachine properties

STDMETHOD(COMGETTER(Parent))(IVirtualBox **aParent);

STDMETHOD(COMGETTER(Accessible))(BOOL *aAccessible);

STDMETHOD(COMGETTER(AccessError))(IVirtualBoxErrorInfo **aAccessError);

STDMETHOD(COMGETTER(Name))(BSTR *aName);

STDMETHOD(COMSETTER(Name))(IN_BSTR aName);

STDMETHOD(COMGETTER(Description))(BSTR *aDescription);

STDMETHOD(COMSETTER(Description))(IN_BSTR aDescription);

STDMETHOD(COMGETTER(Id))(BSTR *aId);

STDMETHOD(COMGETTER(OSTypeId))(BSTR *aOSTypeId);

STDMETHOD(COMSETTER(OSTypeId))(IN_BSTR aOSTypeId);

STDMETHOD(COMGETTER(HardwareVersion))(BSTR *aVersion);

STDMETHOD(COMSETTER(HardwareVersion))(IN_BSTR aVersion);

STDMETHOD(COMGETTER(HardwareUUID))(BSTR *aUUID);

STDMETHOD(COMSETTER(HardwareUUID))(IN_BSTR aUUID);

STDMETHOD(COMGETTER(MemorySize))(ULONG *memorySize);

STDMETHOD(COMSETTER(MemorySize))(ULONG memorySize);

STDMETHOD(COMGETTER(CPUCount))(ULONG *cpuCount);

STDMETHOD(COMSETTER(CPUCount))(ULONG cpuCount);

STDMETHOD(COMGETTER(CPUHotPlugEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(CPUHotPlugEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(CPUExecutionCap))(ULONG *aExecutionCap);

STDMETHOD(COMSETTER(CPUExecutionCap))(ULONG aExecutionCap);

STDMETHOD(COMGETTER(EmulatedUSBCardReaderEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(EmulatedUSBCardReaderEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(EmulatedUSBWebcameraEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(EmulatedUSBWebcameraEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(HpetEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(HpetEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(MemoryBalloonSize))(ULONG *memoryBalloonSize);

STDMETHOD(COMSETTER(MemoryBalloonSize))(ULONG memoryBalloonSize);

STDMETHOD(COMGETTER(PageFusionEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(PageFusionEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(VRAMSize))(ULONG *memorySize);

STDMETHOD(COMSETTER(VRAMSize))(ULONG memorySize);

STDMETHOD(COMGETTER(MonitorCount))(ULONG *monitorCount);

STDMETHOD(COMSETTER(MonitorCount))(ULONG monitorCount);

STDMETHOD(COMGETTER(Accelerate3DEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(Accelerate3DEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(Accelerate2DVideoEnabled))(BOOL *enabled);

STDMETHOD(COMSETTER(Accelerate2DVideoEnabled))(BOOL enabled);

STDMETHOD(COMGETTER(BIOSSettings))(IBIOSSettings **biosSettings);

STDMETHOD(COMGETTER(SnapshotFolder))(BSTR *aSavedStateFolder);

STDMETHOD(COMSETTER(SnapshotFolder))(IN_BSTR aSavedStateFolder);

STDMETHOD(COMGETTER(MediumAttachments))(ComSafeArrayOut(IMediumAttachment *, aAttachments));

STDMETHOD(COMGETTER(VRDEServer))(IVRDEServer **vrdeServer);

STDMETHOD(COMGETTER(AudioAdapter))(IAudioAdapter **audioAdapter);

STDMETHOD(COMGETTER(USBController))(IUSBController * *aUSBController);

STDMETHOD(COMGETTER(SettingsFilePath))(BSTR *aFilePath);

STDMETHOD(COMGETTER(SettingsModified))(BOOL *aModified);

STDMETHOD(COMGETTER(SessionState))(SessionState_T *aSessionState);

STDMETHOD(COMGETTER(SessionType))(BSTR *aSessionType);

STDMETHOD(COMGETTER(SessionPid))(ULONG *aSessionPid);

STDMETHOD(COMGETTER(State))(MachineState_T *machineState);

STDMETHOD(COMGETTER(LastStateChange))(LONG64 *aLastStateChange);

STDMETHOD(COMGETTER(StateFilePath))(BSTR *aStateFilePath);

STDMETHOD(COMGETTER(LogFolder))(BSTR *aLogFolder);

STDMETHOD(COMGETTER(CurrentSnapshot))(ISnapshot **aCurrentSnapshot);

STDMETHOD(COMGETTER(SnapshotCount))(ULONG *aSnapshotCount);

STDMETHOD(COMGETTER(CurrentStateModified))(BOOL *aCurrentStateModified);

STDMETHOD(COMGETTER(SharedFolders))(ComSafeArrayOut(ISharedFolder *, aSharedFolders));

STDMETHOD(COMGETTER(ClipboardMode))(ClipboardMode_T *aClipboardMode);

STDMETHOD(COMSETTER(ClipboardMode))(ClipboardMode_T aClipboardMode);

STDMETHOD(COMGETTER(GuestPropertyNotificationPatterns))(BSTR *aPattern);

STDMETHOD(COMSETTER(GuestPropertyNotificationPatterns))(IN_BSTR aPattern);

STDMETHOD(COMGETTER(StorageControllers))(ComSafeArrayOut(IStorageController *, aStorageControllers));

STDMETHOD(COMGETTER(TeleporterEnabled))(BOOL *aEnabled);

STDMETHOD(COMSETTER(TeleporterEnabled))(BOOL aEnabled);

STDMETHOD(COMGETTER(TeleporterPort))(ULONG *aPort);

STDMETHOD(COMSETTER(TeleporterPort))(ULONG aPort);

STDMETHOD(COMGETTER(TeleporterAddress))(BSTR *aAddress);

STDMETHOD(COMSETTER(TeleporterAddress))(IN_BSTR aAddress);

STDMETHOD(COMGETTER(TeleporterPassword))(BSTR *aPassword);

STDMETHOD(COMSETTER(TeleporterPassword))(IN_BSTR aPassword);

STDMETHOD(COMGETTER(FaultToleranceState))(FaultToleranceState_T *aEnabled);

STDMETHOD(COMSETTER(FaultToleranceState))(FaultToleranceState_T aEnabled);

STDMETHOD(COMGETTER(FaultToleranceAddress))(BSTR *aAddress);

STDMETHOD(COMSETTER(FaultToleranceAddress))(IN_BSTR aAddress);

STDMETHOD(COMGETTER(FaultTolerancePort))(ULONG *aPort);

STDMETHOD(COMSETTER(FaultTolerancePort))(ULONG aPort);

STDMETHOD(COMGETTER(FaultTolerancePassword))(BSTR *aPassword);

STDMETHOD(COMSETTER(FaultTolerancePassword))(IN_BSTR aPassword);

STDMETHOD(COMGETTER(FaultToleranceSyncInterval))(ULONG *aInterval);

STDMETHOD(COMSETTER(FaultToleranceSyncInterval))(ULONG aInterval);

STDMETHOD(COMGETTER(RTCUseUTC))(BOOL *aEnabled);

STDMETHOD(COMSETTER(RTCUseUTC))(BOOL aEnabled);

STDMETHOD(COMGETTER(FirmwareType)) (FirmwareType_T *aFirmware);

STDMETHOD(COMSETTER(FirmwareType)) (FirmwareType_T aFirmware);

STDMETHOD(COMGETTER(KeyboardHidType)) (KeyboardHidType_T *aKeyboardHidType);

STDMETHOD(COMSETTER(KeyboardHidType)) (KeyboardHidType_T aKeyboardHidType);

STDMETHOD(COMGETTER(PointingHidType)) (PointingHidType_T *aPointingHidType);

STDMETHOD(COMSETTER(PointingHidType)) (PointingHidType_T aPointingHidType);

STDMETHOD(COMGETTER(ChipsetType)) (ChipsetType_T *aChipsetType);

STDMETHOD(COMSETTER(ChipsetType)) (ChipsetType_T aChipsetType);

STDMETHOD(COMGETTER(IoCacheEnabled)) (BOOL *aEnabled);

STDMETHOD(COMSETTER(IoCacheEnabled)) (BOOL aEnabled);

STDMETHOD(COMGETTER(IoCacheSize)) (ULONG *aIoCacheSize);

STDMETHOD(COMSETTER(IoCacheSize)) (ULONG aIoCacheSize);

STDMETHOD(COMGETTER(PciDeviceAssignments))(ComSafeArrayOut(IPciDeviceAttachment *, aAssignments));

STDMETHOD(COMGETTER(BandwidthControl))(IBandwidthControl **aBandwidthControl);

// IMachine methods

STDMETHOD(LockMachine)(ISession *aSession, LockType_T lockType);

STDMETHOD(LaunchVMProcess)(ISession *aSession, IN_BSTR aType, IN_BSTR aEnvironment, IProgress **aProgress);

STDMETHOD(SetBootOrder)(ULONG aPosition, DeviceType_T aDevice);

STDMETHOD(GetBootOrder)(ULONG aPosition, DeviceType_T *aDevice);

STDMETHOD(AttachDevice)(IN_BSTR aControllerName, LONG aControllerPort,

LONG aDevice, DeviceType_T aType, IMedium *aMedium);

STDMETHOD(DetachDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice);

STDMETHOD(PassthroughDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice, BOOL aPassthrough);

STDMETHOD(SetBandwidthGroupForDevice)(IN_BSTR aControllerName, LONG aControllerPort,

LONG aDevice, IBandwidthGroup *aBandwidthGroup);

STDMETHOD(MountMedium)(IN_BSTR aControllerName, LONG aControllerPort,

LONG aDevice, IMedium *aMedium, BOOL aForce);

STDMETHOD(GetMedium)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice,

IMedium **aMedium);

STDMETHOD(GetSerialPort)(ULONG slot, ISerialPort **port);

STDMETHOD(GetParallelPort)(ULONG slot, IParallelPort **port);

STDMETHOD(GetNetworkAdapter)(ULONG slot, INetworkAdapter **adapter);

STDMETHOD(GetExtraDataKeys)(ComSafeArrayOut(BSTR, aKeys));

STDMETHOD(GetExtraData)(IN_BSTR aKey, BSTR *aValue);

STDMETHOD(SetExtraData)(IN_BSTR aKey, IN_BSTR aValue);

STDMETHOD(GetCPUProperty)(CPUPropertyType_T property, BOOL *aVal);

STDMETHOD(SetCPUProperty)(CPUPropertyType_T property, BOOL aVal);

STDMETHOD(GetCPUIDLeaf)(ULONG id, ULONG *aValEax, ULONG *aValEbx, ULONG *aValEcx, ULONG *aValEdx);

STDMETHOD(SetCPUIDLeaf)(ULONG id, ULONG aValEax, ULONG aValEbx, ULONG aValEcx, ULONG aValEdx);

STDMETHOD(RemoveCPUIDLeaf)(ULONG id);

STDMETHOD(RemoveAllCPUIDLeaves)();

STDMETHOD(GetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL *aVal);

STDMETHOD(SetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL aVal);

STDMETHOD(SaveSettings)();

STDMETHOD(DiscardSettings)();

STDMETHOD(Unregister)(CleanupMode_T cleanupMode, ComSafeArrayOut(IMedium*, aMedia));

STDMETHOD(Delete)(ComSafeArrayIn(IMedium*, aMedia), IProgress **aProgress);

STDMETHOD(Export)(IAppliance *aAppliance, IN_BSTR location, IVirtualSystemDescription **aDescription);

STDMETHOD(FindSnapshot)(IN_BSTR aNameOrId, ISnapshot **aSnapshot);

STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);

STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);

STDMETHOD(CanShowConsoleWindow)(BOOL *aCanShow);

STDMETHOD(ShowConsoleWindow)(LONG64 *aWinId);

STDMETHOD(GetGuestProperty)(IN_BSTR aName, BSTR *aValue, LONG64 *aTimestamp, BSTR *aFlags);

STDMETHOD(GetGuestPropertyValue)(IN_BSTR aName, BSTR *aValue);

STDMETHOD(GetGuestPropertyTimestamp)(IN_BSTR aName, LONG64 *aTimestamp);

STDMETHOD(SetGuestProperty)(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags);

STDMETHOD(SetGuestPropertyValue)(IN_BSTR aName, IN_BSTR aValue);

STDMETHOD(EnumerateGuestProperties)(IN_BSTR aPattern, ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(LONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));

STDMETHOD(GetMediumAttachmentsOfController)(IN_BSTR aName, ComSafeArrayOut(IMediumAttachment *, aAttachments));

STDMETHOD(GetMediumAttachment)(IN_BSTR aConstrollerName, LONG aControllerPort, LONG aDevice, IMediumAttachment **aAttachment);

STDMETHOD(AddStorageController)(IN_BSTR aName, StorageBus_T aConnectionType, IStorageController **controller);

STDMETHOD(RemoveStorageController(IN_BSTR aName));

STDMETHOD(GetStorageControllerByName(IN_BSTR aName, IStorageController **storageController));

STDMETHOD(GetStorageControllerByInstance(ULONG aInstance, IStorageController **storageController));

STDMETHOD(SetStorageControllerBootable)(IN_BSTR aName, BOOL fBootable);

STDMETHOD(QuerySavedGuestSize)(ULONG aScreenId, ULONG *puWidth, ULONG *puHeight);

STDMETHOD(QuerySavedThumbnailSize)(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight);

STDMETHOD(ReadSavedThumbnailToArray)(ULONG aScreenId, BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));

STDMETHOD(ReadSavedThumbnailPNGToArray)(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));

STDMETHOD(QuerySavedScreenshotPNGSize)(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight);

STDMETHOD(ReadSavedScreenshotPNGToArray)(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));

STDMETHOD(HotPlugCPU(ULONG aCpu));

STDMETHOD(HotUnplugCPU(ULONG aCpu));

STDMETHOD(GetCPUStatus(ULONG aCpu, BOOL *aCpuAttached));

STDMETHOD(QueryLogFilename(ULONG aIdx, BSTR *aName));

STDMETHOD(ReadLog(ULONG aIdx, LONG64 aOffset, LONG64 aSize, ComSafeArrayOut(BYTE, aData)));

STDMETHOD(AttachHostPciDevice(LONG hostAddress, LONG desiredGuestAddress, BOOL tryToUnbind));

STDMETHOD(DetachHostPciDevice(LONG hostAddress));

STDMETHOD(CloneTo(IMachine *pTarget, CloneMode_T mode, ComSafeArrayIn(CloneOptions_T, options), IProgress **pProgress));

// public methods only for internal purposes

virtual bool isSnapshotMachine() const

{

return false;

}

virtual bool isSessionMachine() const

{

return false;

}

/**

virtual VBoxLockingClass getLockingClass() const

{

return LOCKCLASS_MACHINEOBJECT;

}

/// @todo (dmik) add lock and make non-inlined after revising classes

// that use it. Note: they should enter Machine lock to keep the returned

// information valid!

bool isRegistered() { return !!mData->mRegistered; }

// unsafe inline public methods for internal purposes only (ensure there is

// a caller and a read lock before calling them!)

/**

VirtualBox* getVirtualBox() const { return mParent; }

/**

const Guid& getId() const { return mData->mUuid; }

/**

inline const Guid& getSnapshotId() const;

/**

const Utf8Str& getSettingsFileFull() const { return mData->m_strConfigFileFull; }

/**

const Utf8Str& getName() const { return mUserData->s.strName; }

enum

{

IsModified_MachineData = 0x0001,

IsModified_Storage = 0x0002,

IsModified_NetworkAdapters = 0x0008,

IsModified_SerialPorts = 0x0010,

IsModified_ParallelPorts = 0x0020,

IsModified_VRDEServer = 0x0040,

IsModified_AudioAdapter = 0x0080,

IsModified_USB = 0x0100,

IsModified_BIOS = 0x0200,

IsModified_SharedFolders = 0x0400,

IsModified_Snapshots = 0x0800,

IsModified_BandwidthControl = 0x1000

};

void setModified(uint32_t fl);

void setModifiedLock(uint32_t fl);

// callback handlers

virtual HRESULT onNetworkAdapterChange(INetworkAdapter * /* networkAdapter */, BOOL /* changeAdapter */) { return S_OK; }

virtual HRESULT onNATRedirectRuleChange(ULONG /* slot */, BOOL /* fRemove */ , IN_BSTR /* name */,

NATProtocol_T /* protocol */, IN_BSTR /* host ip */, LONG /* host port */, IN_BSTR /* guest port */, LONG /* guest port */ ) { return S_OK; }

virtual HRESULT onSerialPortChange(ISerialPort * /* serialPort */) { return S_OK; }

virtual HRESULT onParallelPortChange(IParallelPort * /* parallelPort */) { return S_OK; }

virtual HRESULT onVRDEServerChange(BOOL /* aRestart */) { return S_OK; }

virtual HRESULT onUSBControllerChange() { return S_OK; }

virtual HRESULT onStorageControllerChange() { return S_OK; }

virtual HRESULT onCPUChange(ULONG /* aCPU */, BOOL /* aRemove */) { return S_OK; }

virtual HRESULT onCPUExecutionCapChange(ULONG /* aExecutionCap */) { return S_OK; }

virtual HRESULT onMediumChange(IMediumAttachment * /* mediumAttachment */, BOOL /* force */) { return S_OK; }

virtual HRESULT onSharedFolderChange() { return S_OK; }

virtual HRESULT onBandwidthGroupChange(IBandwidthGroup * /* aBandwidthGroup */) { return S_OK; }

virtual HRESULT onStorageDeviceChange(IMediumAttachment * /* mediumAttachment */, BOOL /* remove */) { return S_OK; }

HRESULT saveRegistryEntry(settings::MachineRegistryEntry &data);

int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);

void copyPathRelativeToMachine(const Utf8Str &strSource, Utf8Str &strTarget);

void getLogFolder(Utf8Str &aLogFolder);

Utf8Str queryLogFilename(ULONG idx);

void composeSavedStateFilename(Utf8Str &strStateFilePath);

HRESULT launchVMProcess(IInternalSessionControl *aControl,

const Utf8Str &strType,

const Utf8Str &strEnvironment,

ProgressProxy *aProgress);

HRESULT getDirectControl(ComPtr<IInternalSessionControl> *directControl)

{

HRESULT rc;

*directControl = mData->mSession.mDirectControl;

if (!*directControl)

rc = E_ACCESSDENIED;

else

rc = S_OK;

return rc;

}

#if defined(RT_OS_WINDOWS)

bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl = NULL,

HANDLE *aIPCSem = NULL, bool aAllowClosing = false);

bool isSessionSpawning(RTPROCESS *aPID = NULL);

bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl = NULL,

HANDLE *aIPCSem = NULL)

{ return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }

#elif defined(RT_OS_OS2)

bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl = NULL,

HMTX *aIPCSem = NULL, bool aAllowClosing = false);

bool isSessionSpawning(RTPROCESS *aPID = NULL);

bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl = NULL,

HMTX *aIPCSem = NULL)

{ return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }

#else

bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl = NULL,

bool aAllowClosing = false);

bool isSessionSpawning();

bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl = NULL)

{ return isSessionOpen(aMachine, aControl, true /* aAllowClosing */); }

#endif

bool checkForSpawnFailure();

HRESULT prepareRegister();

HRESULT getSharedFolder(CBSTR aName,

ComObjPtr<SharedFolder> &aSharedFolder,

bool aSetError = false)

{

AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);

return findSharedFolder(aName, aSharedFolder, aSetError);

}

HRESULT addStateDependency(StateDependency aDepType = AnyStateDep,

MachineState_T *aState = NULL,

BOOL *aRegistered = NULL);

void releaseStateDependency();

HRESULT getBandwidthGroup(const Utf8Str &strBandwidthGroup,

ComObjPtr<BandwidthGroup> &pBandwidthGroup,

bool fSetError = false)

{

return mBandwidthControl->getBandwidthGroupByName(strBandwidthGroup,

pBandwidthGroup,

fSetError);

}

protected:

HRESULT checkStateDependency(StateDependency aDepType);

Machine *getMachine();

void ensureNoStateDependencies();

virtual HRESULT setMachineState(MachineState_T aMachineState);

HRESULT findSharedFolder(const Utf8Str &aName,

ComObjPtr<SharedFolder> &aSharedFolder,

bool aSetError = false);

HRESULT loadSettings(bool aRegistered);

HRESULT loadMachineDataFromSettings(const settings::MachineConfigFile &config,

const Guid *puuidRegistry);

HRESULT loadSnapshot(const settings::Snapshot &data,

const Guid &aCurSnapshotId,

Snapshot *aParentSnapshot);

HRESULT loadHardware(const settings::Hardware &data);

HRESULT loadStorageControllers(const settings::Storage &data,

const Guid *puuidRegistry,

const Guid *puuidSnapshot);

HRESULT loadStorageDevices(StorageController *aStorageController,

const settings::StorageController &data,

const Guid *puuidRegistry,

const Guid *puuidSnapshot);

HRESULT findSnapshotById(const Guid &aId,

ComObjPtr<Snapshot> &aSnapshot,

bool aSetError = false);

HRESULT findSnapshotByName(const Utf8Str &strName,

ComObjPtr<Snapshot> &aSnapshot,

bool aSetError = false);

HRESULT getStorageControllerByName(const Utf8Str &aName,

ComObjPtr<StorageController> &aStorageController,

bool aSetError = false);

HRESULT getMediumAttachmentsOfController(CBSTR aName,

MediaData::AttachmentList &aAttachments);

enum

{

/* flags for #saveSettings() */

SaveS_ResetCurStateModified = 0x01,

SaveS_InformCallbacksAnyway = 0x02,

SaveS_Force = 0x04,

/* flags for #saveStateSettings() */

SaveSTS_CurStateModified = 0x20,

SaveSTS_StateFilePath = 0x40,

SaveSTS_StateTimeStamp = 0x80

};

HRESULT prepareSaveSettings(bool *pfNeedsGlobalSaveSettings);

HRESULT saveSettings(bool *pfNeedsGlobalSaveSettings, int aFlags = 0);

void copyMachineDataToSettings(settings::MachineConfigFile &config);

HRESULT saveAllSnapshots(settings::MachineConfigFile &config);

HRESULT saveHardware(settings::Hardware &data);

HRESULT saveStorageControllers(settings::Storage &data);

HRESULT saveStorageDevices(ComObjPtr<StorageController> aStorageController,

settings::StorageController &data);

HRESULT saveStateSettings(int aFlags);

void addMediumToRegistry(ComObjPtr<Medium> &pMedium,

GuidList &llRegistriesThatNeedSaving,

Guid *puuid);

HRESULT createImplicitDiffs(IProgress *aProgress,

ULONG aWeight,

bool aOnline,

GuidList *pllRegistriesThatNeedSaving);

HRESULT deleteImplicitDiffs(GuidList *pllRegistriesThatNeedSaving);

MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,

IN_BSTR aControllerName,

LONG aControllerPort,

LONG aDevice);

MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,

ComObjPtr<Medium> pMedium);

MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,

Guid &id);

HRESULT detachDevice(MediumAttachment *pAttach,

AutoWriteLock &writeLock,

Snapshot *pSnapshot,

GuidList *pllRegistriesThatNeedSaving);

HRESULT detachAllMedia(AutoWriteLock &writeLock,

Snapshot *pSnapshot,

CleanupMode_T cleanupMode,

MediaList &llMedia);

void commitMedia(bool aOnline = false);

void rollbackMedia();

bool isInOwnDir(Utf8Str *aSettingsDir = NULL) const;

void rollback(bool aNotify);

void commit();

void copyFrom(Machine *aThat);

bool isControllerHotplugCapable(StorageControllerType_T enmCtrlType);

struct DeleteTask;

static DECLCALLBACK(int) deleteThread(RTTHREAD Thread, void *pvUser);

HRESULT deleteTaskWorker(DeleteTask &task);

#ifdef VBOX_WITH_GUEST_PROPS

HRESULT getGuestPropertyFromService(IN_BSTR aName, BSTR *aValue,

LONG64 *aTimestamp, BSTR *aFlags) const;

HRESULT getGuestPropertyFromVM(IN_BSTR aName, BSTR *aValue,

LONG64 *aTimestamp, BSTR *aFlags) const;

HRESULT setGuestPropertyToService(IN_BSTR aName, IN_BSTR aValue,

IN_BSTR aFlags);

HRESULT setGuestPropertyToVM(IN_BSTR aName, IN_BSTR aValue,

IN_BSTR aFlags);

HRESULT enumerateGuestPropertiesInService

(IN_BSTR aPatterns, ComSafeArrayOut(BSTR, aNames),

ComSafeArrayOut(BSTR, aValues),

ComSafeArrayOut(LONG64, aTimestamps),

ComSafeArrayOut(BSTR, aFlags));

HRESULT enumerateGuestPropertiesOnVM

(IN_BSTR aPatterns, ComSafeArrayOut(BSTR, aNames),

ComSafeArrayOut(BSTR, aValues),

ComSafeArrayOut(LONG64, aTimestamps),

ComSafeArrayOut(BSTR, aFlags));

#endif /* VBOX_WITH_GUEST_PROPS */

#ifdef VBOX_WITH_RESOURCE_USAGE_API

void registerMetrics(PerformanceCollector *aCollector, Machine *aMachine, RTPROCESS pid);

pm::CollectorGuest *mCollectorGuest;

#endif /* VBOX_WITH_RESOURCE_USAGE_API */

Machine* const mPeer;

VirtualBox * const mParent;

Shareable<Data> mData;

Shareable<SSData> mSSData;

Backupable<UserData> mUserData;

Backupable<HWData> mHWData;

Backupable<MediaData> mMediaData;

// the following fields need special backup/rollback/commit handling,

// so they cannot be a part of HWData

const ComObjPtr<VRDEServer> mVRDEServer;

const ComObjPtr<SerialPort> mSerialPorts[SchemaDefs::SerialPortCount];

const ComObjPtr<ParallelPort> mParallelPorts[SchemaDefs::ParallelPortCount];

const ComObjPtr<AudioAdapter> mAudioAdapter;

const ComObjPtr<USBController> mUSBController;

const ComObjPtr<BIOSSettings> mBIOSSettings;

const ComObjPtr<NetworkAdapter> mNetworkAdapters[SchemaDefs::NetworkAdapterCount];

const ComObjPtr<BandwidthControl> mBandwidthControl;

typedef std::list< ComObjPtr<StorageController> > StorageControllerList;

Backupable<StorageControllerList> mStorageControllers;

friend class SessionMachine;

friend class SnapshotMachine;

friend class Appliance;

friend class VirtualBox;

friend class MachineCloneVM;

};

class ATL_NO_VTABLE SessionMachine :

public Machine,

VBOX_SCRIPTABLE_IMPL(IInternalMachineControl)

{

public:

VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SessionMachine, IMachine)

DECLARE_NOT_AGGREGATABLE(SessionMachine)

DECLARE_PROTECT_FINAL_CONSTRUCT()

BEGIN_COM_MAP(SessionMachine)

VBOX_DEFAULT_INTERFACE_ENTRIES(IMachine)

COM_INTERFACE_ENTRY(IInternalMachineControl)

END_COM_MAP()

DECLARE_EMPTY_CTOR_DTOR(SessionMachine)

HRESULT FinalConstruct();

void FinalRelease();

// public initializer/uninitializer for internal purposes only

HRESULT init(Machine *aMachine);

void uninit() { uninit(Uninit::Unexpected); }

// util::Lockable interface

RWLockHandle *lockHandle() const;

// IInternalMachineControl methods

STDMETHOD(SetRemoveSavedStateFile)(BOOL aRemove);

STDMETHOD(UpdateState)(MachineState_T machineState);

STDMETHOD(GetIPCId)(BSTR *id);

STDMETHOD(BeginPowerUp)(IProgress *aProgress);

STDMETHOD(EndPowerUp)(LONG iResult);

STDMETHOD(BeginPoweringDown)(IProgress **aProgress);

STDMETHOD(EndPoweringDown)(LONG aResult, IN_BSTR aErrMsg);

STDMETHOD(RunUSBDeviceFilters)(IUSBDevice *aUSBDevice, BOOL *aMatched, ULONG *aMaskedIfs);

STDMETHOD(CaptureUSBDevice)(IN_BSTR aId);

STDMETHOD(DetachUSBDevice)(IN_BSTR aId, BOOL aDone);

STDMETHOD(AutoCaptureUSBDevices)();

STDMETHOD(DetachAllUSBDevices)(BOOL aDone);

STDMETHOD(OnSessionEnd)(ISession *aSession, IProgress **aProgress);

STDMETHOD(BeginSavingState)(IProgress **aProgress, BSTR *aStateFilePath);

STDMETHOD(EndSavingState)(LONG aResult, IN_BSTR aErrMsg);

STDMETHOD(AdoptSavedState)(IN_BSTR aSavedStateFile);

STDMETHOD(BeginTakingSnapshot)(IConsole *aInitiator,

IN_BSTR aName,

IN_BSTR aDescription,

IProgress *aConsoleProgress,

BOOL fTakingSnapshotOnline,

BSTR *aStateFilePath);

STDMETHOD(EndTakingSnapshot)(BOOL aSuccess);

STDMETHOD(DeleteSnapshot)(IConsole *aInitiator, IN_BSTR aId,

BOOL fDeleteAllChildren,

MachineState_T *aMachineState, IProgress **aProgress);

STDMETHOD(FinishOnlineMergeMedium)(IMediumAttachment *aMediumAttachment,

IMedium *aSource, IMedium *aTarget,

BOOL fMergeForward,

IMedium *pParentForTarget,

ComSafeArrayIn(IMedium *, aChildrenToReparent));

STDMETHOD(RestoreSnapshot)(IConsole *aInitiator,

ISnapshot *aSnapshot,

MachineState_T *aMachineState,

IProgress **aProgress);

STDMETHOD(PullGuestProperties)(ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues),

ComSafeArrayOut(LONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));

STDMETHOD(PushGuestProperty)(IN_BSTR aName, IN_BSTR aValue,

LONG64 aTimestamp, IN_BSTR aFlags);

STDMETHOD(LockMedia)() { return lockMedia(); }

STDMETHOD(UnlockMedia)() { unlockMedia(); return S_OK; }

// public methods only for internal purposes

virtual bool isSessionMachine() const

{

return true;

}

bool checkForDeath();

HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter);

HRESULT onNATRedirectRuleChange(ULONG ulSlot, BOOL aNatRuleRemove, IN_BSTR aRuleName,

NATProtocol_T aProto, IN_BSTR aHostIp, LONG aHostPort, IN_BSTR aGuestIp, LONG aGuestPort);

HRESULT onStorageControllerChange();

HRESULT onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);

HRESULT onSerialPortChange(ISerialPort *serialPort);

HRESULT onParallelPortChange(IParallelPort *parallelPort);

HRESULT onCPUChange(ULONG aCPU, BOOL aRemove);

HRESULT onCPUExecutionCapChange(ULONG aCpuExecutionCap);

HRESULT onVRDEServerChange(BOOL aRestart);

HRESULT onUSBControllerChange();

HRESULT onUSBDeviceAttach(IUSBDevice *aDevice,

IVirtualBoxErrorInfo *aError,

ULONG aMaskedIfs);

HRESULT onUSBDeviceDetach(IN_BSTR aId,

IVirtualBoxErrorInfo *aError);

HRESULT onSharedFolderChange();

HRESULT onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);

HRESULT onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove);

bool hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs);

private:

struct ConsoleTaskData

{

ConsoleTaskData()

: mLastState(MachineState_Null)

{ }

MachineState_T mLastState;

ComObjPtr<Progress> mProgress;

// used when taking snapshot

ComObjPtr<Snapshot> mSnapshot;

// used when saving state (either as part of a snapshot or separate)

Utf8Str strStateFilePath;

};

struct Uninit

{

enum Reason { Unexpected, Abnormal, Normal };

};

struct SnapshotTask;

struct DeleteSnapshotTask;

struct RestoreSnapshotTask;

friend struct DeleteSnapshotTask;

friend struct RestoreSnapshotTask;

void uninit(Uninit::Reason aReason);

HRESULT endSavingState(HRESULT aRC, const Utf8Str &aErrMsg);

void releaseSavedStateFile(const Utf8Str &strSavedStateFile, Snapshot *pSnapshotToIgnore);

void deleteSnapshotHandler(DeleteSnapshotTask &aTask);

void restoreSnapshotHandler(RestoreSnapshotTask &aTask);

HRESULT prepareDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,

const Guid &machineId,

const Guid &snapshotId,

bool fOnlineMergePossible,

MediumLockList *aVMMALockList,

ComObjPtr<Medium> &aSource,

ComObjPtr<Medium> &aTarget,

bool &fMergeForward,

ComObjPtr<Medium> &pParentForTarget,

MediaList &aChildrenToReparent,

bool &fNeedOnlineMerge,

MediumLockList * &aMediumLockList);

void cancelDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,

const ComObjPtr<Medium> &aSource,

const MediaList &aChildrenToReparent,

bool fNeedsOnlineMerge,

MediumLockList *aMediumLockList,

const Guid &aMediumId,

const Guid &aSnapshotId);

HRESULT onlineMergeMedium(const ComObjPtr<MediumAttachment> &aMediumAttachment,

const ComObjPtr<Medium> &aSource,

const ComObjPtr<Medium> &aTarget,

bool fMergeForward,

const ComObjPtr<Medium> &pParentForTarget,

const MediaList &aChildrenToReparent,

MediumLockList *aMediumLockList,

ComObjPtr<Progress> &aProgress,

bool *pfNeedsMachineSaveSettings);

HRESULT lockMedia();

void unlockMedia();

HRESULT setMachineState(MachineState_T aMachineState);

HRESULT updateMachineStateOnClient();

HRESULT mRemoveSavedState;

ConsoleTaskData mConsoleTaskData;

/** interprocess semaphore handle for this machine */

#if defined(RT_OS_WINDOWS)

HANDLE mIPCSem;

Bstr mIPCSemName;

friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl,

HANDLE *aIPCSem, bool aAllowClosing);

#elif defined(RT_OS_OS2)

HMTX mIPCSem;

Bstr mIPCSemName;

friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,

ComPtr<IInternalSessionControl> *aControl,

HMTX *aIPCSem, bool aAllowClosing);

#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)

int mIPCSem;

# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN

Bstr mIPCKey;

# endif /*VBOX_WITH_NEW_SYS_V_KEYGEN */

#else

# error "Port me!"

#endif

static DECLCALLBACK(int) taskHandler(RTTHREAD thread, void *pvUser);

};

class ATL_NO_VTABLE SnapshotMachine :

public Machine

{

public:

VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SnapshotMachine, IMachine)

DECLARE_NOT_AGGREGATABLE(SnapshotMachine)

DECLARE_PROTECT_FINAL_CONSTRUCT()

BEGIN_COM_MAP(SnapshotMachine)

VBOX_DEFAULT_INTERFACE_ENTRIES(IMachine)

END_COM_MAP()

DECLARE_EMPTY_CTOR_DTOR(SnapshotMachine)

HRESULT FinalConstruct();

void FinalRelease();

// public initializer/uninitializer for internal purposes only

HRESULT init(SessionMachine *aSessionMachine,

IN_GUID aSnapshotId,

const Utf8Str &aStateFilePath);

HRESULT init(Machine *aMachine,

const settings::Hardware &hardware,

const settings::Storage &storage,

IN_GUID aSnapshotId,

const Utf8Str &aStateFilePath);

void uninit();

// util::Lockable interface

RWLockHandle *lockHandle() const;

// public methods only for internal purposes

virtual bool isSnapshotMachine() const

{

return true;

}

HRESULT onSnapshotChange(Snapshot *aSnapshot);

// unsafe inline public methods for internal purposes only (ensure there is

// a caller and a read lock before calling them!)

const Guid& getSnapshotId() const { return mSnapshotId; }

private:

Guid mSnapshotId;

friend class Snapshot;

};

inline const Guid &Machine::getSnapshotId() const

{

return (isSnapshotMachine())

? static_cast<const SnapshotMachine*>(this)->getSnapshotId()

: Guid::Empty;

}

#endif // ____H_MACHINEIMPL