#ifndef ____H_CONSOLEIMPL

#define ____H_CONSOLEIMPL

#include "VirtualBoxBase.h"

#include "VBox/com/array.h"

#include "EventImpl.h"

#include "ConsoleWrap.h"

class Guest;

class Keyboard;

class Mouse;

class Display;

class MachineDebugger;

class TeleporterStateSrc;

class OUSBDevice;

class RemoteUSBDevice;

class SharedFolder;

class VRDEServerInfo;

class EmulatedUSB;

#ifdef VBOX_WITH_PDM_AUDIO_DRIVER

class AudioVRDE;

#else

class AudioSniffer;

#endif

class Nvram;

#ifdef VBOX_WITH_USB_CARDREADER

class UsbCardReader;

#endif

class ConsoleVRDPServer;

class VMMDev;

class Progress;

class BusAssignmentManager;

COM_STRUCT_OR_CLASS(IEventListener);

#ifdef VBOX_WITH_EXTPACK

class ExtPackManager;

#endif

class VMMDevMouseInterface;

class DisplayMouseInterface;

#include <iprt/uuid.h>

#include <iprt/memsafer.h>

#include <VBox/RemoteDesktop/VRDE.h>

#include <VBox/vmm/pdmdrv.h>

#ifdef VBOX_WITH_GUEST_PROPS

# include <VBox/HostServices/GuestPropertySvc.h> /* For the property notification callback */

#endif

#ifdef RT_OS_WINDOWS

# include "../src-server/win/VBoxComEvents.h"

#endif

struct VUSBIRHCONFIG;

typedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;

#include <list>

#include <vector>

#define CHECK_CONSOLE_DRV(drv) \

do { \

if (!(drv)) \

return setError(E_ACCESSDENIED, tr("The console is not powered up")); \

} while (0)

class ConsoleMouseInterface

{

public:

virtual VMMDevMouseInterface *i_getVMMDevMouseInterface(){return NULL;}

virtual DisplayMouseInterface *i_getDisplayMouseInterface(){return NULL;}

virtual void i_onMouseCapabilityChange(BOOL supportsAbsolute,

BOOL supportsRelative,

BOOL supportsMT,

BOOL needsHostCursor){NOREF(supportsAbsolute); NOREF(supportsRelative); NOREF(supportsMT); NOREF(needsHostCursor);}

};

class ATL_NO_VTABLE Console :

public ConsoleWrap,

public ConsoleMouseInterface

{

public:

DECLARE_EMPTY_CTOR_DTOR(Console)

HRESULT FinalConstruct();

void FinalRelease();

// public initializers/uninitializers for internal purposes only

HRESULT init(IMachine *aMachine, IInternalMachineControl *aControl, LockType_T aLockType);

void uninit();

// public methods for internal purposes only

/*

Guest *i_getGuest() const { return mGuest; }

Keyboard *i_getKeyboard() const { return mKeyboard; }

Mouse *i_getMouse() const { return mMouse; }

Display *i_getDisplay() const { return mDisplay; }

MachineDebugger *i_getMachineDebugger() const { return mDebugger; }

#ifdef VBOX_WITH_PDM_AUDIO_DRIVER

AudioVRDE *i_getAudioVRDE() const { return mAudioVRDE; }

#else

AudioSniffer *i_getAudioSniffer() const { return mAudioSniffer; }

#endif

const ComPtr<IMachine> &i_machine() const { return mMachine; }

bool i_useHostClipboard() { return mfUseHostClipboard; }

/** Method is called only from ConsoleVRDPServer */

IVRDEServer *i_getVRDEServer() const { return mVRDEServer; }

ConsoleVRDPServer *i_consoleVRDPServer() const { return mConsoleVRDPServer; }

HRESULT i_updateMachineState(MachineState_T aMachineState);

// events from IInternalSessionControl

HRESULT i_onNetworkAdapterChange(INetworkAdapter *aNetworkAdapter, BOOL changeAdapter);

HRESULT i_onSerialPortChange(ISerialPort *aSerialPort);

HRESULT i_onParallelPortChange(IParallelPort *aParallelPort);

HRESULT i_onStorageControllerChange();

HRESULT i_onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);

HRESULT i_onCPUChange(ULONG aCPU, BOOL aRemove);

HRESULT i_onCPUExecutionCapChange(ULONG aExecutionCap);

HRESULT i_onClipboardModeChange(ClipboardMode_T aClipboardMode);

HRESULT i_onDnDModeChange(DnDMode_T aDnDMode);

HRESULT i_onVRDEServerChange(BOOL aRestart);

HRESULT i_onVideoCaptureChange();

HRESULT i_onUSBControllerChange();

HRESULT i_onSharedFolderChange(BOOL aGlobal);

HRESULT i_onUSBDeviceAttach(IUSBDevice *aDevice, IVirtualBoxErrorInfo *aError, ULONG aMaskedIfs);

HRESULT i_onUSBDeviceDetach(IN_BSTR aId, IVirtualBoxErrorInfo *aError);

HRESULT i_onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);

HRESULT i_onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove, BOOL aSilent);

HRESULT i_onExtraDataChange(IN_BSTR aMachineId, IN_BSTR aKey, IN_BSTR aVal);

HRESULT i_getGuestProperty(const Utf8Str &aName, Utf8Str *aValue, LONG64 *aTimestamp, Utf8Str *aFlags);

HRESULT i_setGuestProperty(const Utf8Str &aName, const Utf8Str &aValue, const Utf8Str &aFlags);

HRESULT i_deleteGuestProperty(const Utf8Str &aName);

HRESULT i_enumerateGuestProperties(IN_BSTR aPatterns,

ComSafeArrayOut(BSTR, aNames),

ComSafeArrayOut(BSTR, aValues),

ComSafeArrayOut(LONG64, aTimestamps),

ComSafeArrayOut(BSTR, aFlags));

HRESULT i_onlineMergeMedium(IMediumAttachment *aMediumAttachment,

ULONG aSourceIdx, ULONG aTargetIdx,

IProgress *aProgress);

int i_hgcmLoadService(const char *pszServiceLibrary, const char *pszServiceName);

VMMDev *i_getVMMDev() { return m_pVMMDev; }

#ifdef VBOX_WITH_PDM_AUDIO_DRIVER

AudioVRDE *i_getAudioVRDE() { return mAudioVRDE; }

#else

AudioSniffer *i_getAudioSniffer() { return mAudioSniffer; }

#endif

#ifdef VBOX_WITH_EXTPACK

ExtPackManager *i_getExtPackManager();

#endif

EventSource *i_getEventSource() { return mEventSource; }

#ifdef VBOX_WITH_USB_CARDREADER

UsbCardReader *i_getUsbCardReader() { return mUsbCardReader; }

#endif

int i_VRDPClientLogon(uint32_t u32ClientId, const char *pszUser, const char *pszPassword, const char *pszDomain);

void i_VRDPClientStatusChange(uint32_t u32ClientId, const char *pszStatus);

void i_VRDPClientConnect(uint32_t u32ClientId);

void i_VRDPClientDisconnect(uint32_t u32ClientId, uint32_t fu32Intercepted);

void i_VRDPInterceptAudio(uint32_t u32ClientId);

void i_VRDPInterceptUSB(uint32_t u32ClientId, void **ppvIntercept);

void i_VRDPInterceptClipboard(uint32_t u32ClientId);

void i_processRemoteUSBDevices(uint32_t u32ClientId, VRDEUSBDEVICEDESC *pDevList, uint32_t cbDevList, bool fDescExt);

void i_reportVmStatistics(ULONG aValidStats, ULONG aCpuUser,

ULONG aCpuKernel, ULONG aCpuIdle,

ULONG aMemTotal, ULONG aMemFree,

ULONG aMemBalloon, ULONG aMemShared,

ULONG aMemCache, ULONG aPageTotal,

ULONG aAllocVMM, ULONG aFreeVMM,

ULONG aBalloonedVMM, ULONG aSharedVMM,

ULONG aVmNetRx, ULONG aVmNetTx)

{

mControl->ReportVmStatistics(aValidStats, aCpuUser, aCpuKernel, aCpuIdle,

aMemTotal, aMemFree, aMemBalloon, aMemShared,

aMemCache, aPageTotal, aAllocVMM, aFreeVMM,

aBalloonedVMM, aSharedVMM, aVmNetRx, aVmNetTx);

}

void i_enableVMMStatistics(BOOL aEnable);

HRESULT i_pause(Reason_T aReason);

HRESULT i_resume(Reason_T aReason);

HRESULT i_saveState(Reason_T aReason, IProgress **aProgress);

// callback callers (partly; for some events console callbacks are notified

// directly from IInternalSessionControl event handlers declared above)

void i_onMousePointerShapeChange(bool fVisible, bool fAlpha,

uint32_t xHot, uint32_t yHot,

uint32_t width, uint32_t height,

ComSafeArrayIn(uint8_t, aShape));

void i_onMouseCapabilityChange(BOOL supportsAbsolute, BOOL supportsRelative,

BOOL supportsMT, BOOL needsHostCursor);

void i_onStateChange(MachineState_T aMachineState);

void i_onAdditionsStateChange();

void i_onAdditionsOutdated();

void i_onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock);

void i_onUSBDeviceStateChange(IUSBDevice *aDevice, bool aAttached,

IVirtualBoxErrorInfo *aError);

void i_onRuntimeError(BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage);

HRESULT i_onShowWindow(BOOL aCheck, BOOL *aCanShow, LONG64 *aWinId);

void i_onVRDEServerInfoChange();

static const PDMDRVREG DrvStatusReg;

static HRESULT i_setErrorStatic(HRESULT aResultCode, const char *pcsz, ...);

HRESULT i_setInvalidMachineStateError();

static const char *i_convertControllerTypeToDev(StorageControllerType_T enmCtrlType);

static HRESULT i_convertBusPortDeviceToLun(StorageBus_T enmBus, LONG port, LONG device, unsigned &uLun);

// Called from event listener

HRESULT i_onNATRedirectRuleChange(ULONG ulInstance, BOOL aNatRuleRemove,

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

// Mouse interface

VMMDevMouseInterface *i_getVMMDevMouseInterface();

DisplayMouseInterface *i_getDisplayMouseInterface();

EmulatedUSB *i_getEmulatedUSB(void) { return mEmulatedUSB; }

/**

HRESULT i_setDiskEncryptionKeys(const Utf8Str &strCfg);

private:

// wraped IConsole properties

HRESULT getMachine(ComPtr<IMachine> &aMachine);

HRESULT getState(MachineState_T *aState);

HRESULT getGuest(ComPtr<IGuest> &aGuest);

HRESULT getKeyboard(ComPtr<IKeyboard> &aKeyboard);

HRESULT getMouse(ComPtr<IMouse> &aMouse);

HRESULT getDisplay(ComPtr<IDisplay> &aDisplay);

HRESULT getDebugger(ComPtr<IMachineDebugger> &aDebugger);

HRESULT getUSBDevices(std::vector<ComPtr<IUSBDevice> > &aUSBDevices);

HRESULT getRemoteUSBDevices(std::vector<ComPtr<IHostUSBDevice> > &aRemoteUSBDevices);

HRESULT getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders);

HRESULT getVRDEServerInfo(ComPtr<IVRDEServerInfo> &aVRDEServerInfo);

HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);

HRESULT getAttachedPCIDevices(std::vector<ComPtr<IPCIDeviceAttachment> > &aAttachedPCIDevices);

HRESULT getUseHostClipboard(BOOL *aUseHostClipboard);

HRESULT setUseHostClipboard(BOOL aUseHostClipboard);

HRESULT getEmulatedUSB(ComPtr<IEmulatedUSB> &aEmulatedUSB);

// wraped IConsole methods

HRESULT powerUp(ComPtr<IProgress> &aProgress);

HRESULT powerUpPaused(ComPtr<IProgress> &aProgress);

HRESULT powerDown(ComPtr<IProgress> &aProgress);

HRESULT reset();

HRESULT pause();

HRESULT resume();

HRESULT powerButton();

HRESULT sleepButton();

HRESULT getPowerButtonHandled(BOOL *aHandled);

HRESULT getGuestEnteredACPIMode(BOOL *aEntered);

HRESULT saveState(ComPtr<IProgress> &aProgress);

HRESULT adoptSavedState(const com::Utf8Str &aSavedStateFile);

HRESULT discardSavedState(BOOL aFRemoveFile);

HRESULT getDeviceActivity(DeviceType_T aType,

DeviceActivity_T *aActivity);

HRESULT attachUSBDevice(const com::Guid &aId);

HRESULT detachUSBDevice(const com::Guid &aId,

ComPtr<IUSBDevice> &aDevice);

HRESULT findUSBDeviceByAddress(const com::Utf8Str &aName,

ComPtr<IUSBDevice> &aDevice);

HRESULT findUSBDeviceById(const com::Guid &aId,

ComPtr<IUSBDevice> &aDevice);

HRESULT createSharedFolder(const com::Utf8Str &aName,

const com::Utf8Str &aHostPath,

BOOL aWritable,

BOOL aAutomount);

HRESULT removeSharedFolder(const com::Utf8Str &aName);

HRESULT takeSnapshot(const com::Utf8Str &aName,

const com::Utf8Str &aDescription,

ComPtr<IProgress> &aProgress);

HRESULT deleteSnapshot(const com::Guid &aId,

ComPtr<IProgress> &aProgress);

HRESULT deleteSnapshotAndAllChildren(const com::Guid &aId,

ComPtr<IProgress> &aProgress);

HRESULT deleteSnapshotRange(const com::Guid &aStartId,

const com::Guid &aEndId,

ComPtr<IProgress> &aProgress);

HRESULT restoreSnapshot(const ComPtr<ISnapshot> &aSnapshot,

ComPtr<IProgress> &aProgress);

HRESULT teleport(const com::Utf8Str &aHostname,

ULONG aTcpport,

const com::Utf8Str &aPassword,

ULONG aMaxDowntime,

ComPtr<IProgress> &aProgress);

/**

template <bool taQuiet = false, bool taAllowNullVM = false>

class AutoVMCallerBase

{

public:

AutoVMCallerBase(Console *aThat) : mThat(aThat), mRC(E_FAIL)

{

Assert(aThat);

mRC = aThat->i_addVMCaller(taQuiet, taAllowNullVM);

}

~AutoVMCallerBase()

{

doRelease();

}

/** Decreases the number of callers before the instance is destroyed. */

void releaseCaller()

{

Assert(SUCCEEDED(mRC));

doRelease();

}

/** Restores the number of callers after by #release(). #rc() must be

void addYY()

{

AssertReturnVoid(!SUCCEEDED(mRC));

mRC = mThat->i_addVMCaller(taQuiet, taAllowNullVM);

}

/** Returns the result of Console::addVMCaller() */

HRESULT rc() const { return mRC; }

/** Shortcut to SUCCEEDED(rc()) */

bool isOk() const { return SUCCEEDED(mRC); }

protected:

Console *mThat;

void doRelease()

{

if (SUCCEEDED(mRC))

{

mThat->i_releaseVMCaller();

mRC = E_FAIL;

}

}

private:

HRESULT mRC; /* Whether the caller was added. */

DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(AutoVMCallerBase)

};

#if 0

/**

typedef AutoVMCallerBase<false, false> AutoVMCaller;

#endif

/**

typedef AutoVMCallerBase<true, false> AutoVMCallerQuiet;

/**

typedef AutoVMCallerBase<false, true> AutoVMCallerWeak;

/**

typedef AutoVMCallerBase<true, true> AutoVMCallerQuietWeak;

/**

template<bool taQuiet = false>

class SafeVMPtrBase : public AutoVMCallerBase<taQuiet, true>

{

typedef AutoVMCallerBase<taQuiet, true> Base;

public:

SafeVMPtrBase(Console *aThat) : Base(aThat), mRC(E_FAIL), mpUVM(NULL)

{

if (Base::isOk())

mRC = aThat->i_safeVMPtrRetainer(&mpUVM, taQuiet);

}

~SafeVMPtrBase()

{

doRelease();

}

/** Direct PUVM access. */

PUVM rawUVM() const { return mpUVM; }

/** Release the handles. */

void release()

{

Assert(SUCCEEDED(mRC));

doRelease();

}

/** The combined result of Console::addVMCaller() and Console::safeVMPtrRetainer */

HRESULT rc() const { return Base::isOk()? mRC: Base::rc(); }

/** Shortcut to SUCCEEDED(rc()) */

bool isOk() const { return SUCCEEDED(mRC) && Base::isOk(); }

private:

void doRelease()

{

if (SUCCEEDED(mRC))

{

Base::mThat->i_safeVMPtrReleaser(&mpUVM);

mRC = E_FAIL;

}

Base::doRelease();

}

HRESULT mRC; /* Whether the VM ptr was retained. */

PUVM mpUVM;

DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(SafeVMPtrBase)

};

public:

/*

typedef SafeVMPtrBase<false> SafeVMPtr;

/**

typedef SafeVMPtrBase<true> SafeVMPtrQuiet;

class SharedFolderData

{

public:

SharedFolderData()

{ }

SharedFolderData(const Utf8Str &aHostPath,

bool aWritable,

bool aAutoMount)

: m_strHostPath(aHostPath),

m_fWritable(aWritable),

m_fAutoMount(aAutoMount)

{ }

// copy constructor

SharedFolderData(const SharedFolderData& aThat)

: m_strHostPath(aThat.m_strHostPath),

m_fWritable(aThat.m_fWritable),

m_fAutoMount(aThat.m_fAutoMount)

{ }

Utf8Str m_strHostPath;

bool m_fWritable;

bool m_fAutoMount;

};

/**

class USBStorageDevice

{

public:

USBStorageDevice()

{ }

/** The UUID associated with the USB device. */

RTUUID mUuid;

/** Port of the storage device. */

LONG iPort;

};

/**

class SecretKey

{

public:

SecretKey() { }

SecretKey(uint8_t *pbKey, size_t cbKey)

: m_cRefs(0),

m_pbKey(pbKey),

m_cbKey(cbKey)

{ }

~SecretKey()

{

RTMemSaferFree(m_pbKey, m_cbKey);

m_cRefs = 0;

m_pbKey = NULL;

m_cbKey = 0;

}

/** Reference counter of the key. */

volatile uint32_t m_cRefs;

/** Key material. */

uint8_t *m_pbKey;

/** Size of the key in bytes. */

size_t m_cbKey;

};

typedef std::map<Utf8Str, ComObjPtr<SharedFolder> > SharedFolderMap;

typedef std::map<Utf8Str, SharedFolderData> SharedFolderDataMap;

typedef std::map<Utf8Str, ComPtr<IMediumAttachment> > MediumAttachmentMap;

typedef std::list <USBStorageDevice> USBStorageDeviceList;

typedef std::map<Utf8Str, SecretKey *> SecretKeyMap;

private:

typedef std::list <ComObjPtr<OUSBDevice> > USBDeviceList;

typedef std::list <ComObjPtr<RemoteUSBDevice> > RemoteUSBDeviceList;

HRESULT i_addVMCaller(bool aQuiet = false, bool aAllowNullVM = false);

void i_releaseVMCaller();

HRESULT i_safeVMPtrRetainer(PUVM *a_ppUVM, bool aQuiet);

void i_safeVMPtrReleaser(PUVM *a_ppUVM);

HRESULT i_consoleInitReleaseLog(const ComPtr<IMachine> aMachine);

HRESULT i_powerUp(IProgress **aProgress, bool aPaused);

HRESULT i_powerDown(IProgress *aProgress = NULL);

#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) || defined(RT_OS_FREEBSD))

HRESULT i_attachToTapInterface(INetworkAdapter *networkAdapter);

HRESULT i_detachFromTapInterface(INetworkAdapter *networkAdapter);

#endif

HRESULT i_powerDownHostInterfaces();

HRESULT i_setMachineState(MachineState_T aMachineState, bool aUpdateServer = true);

HRESULT i_setMachineStateLocally(MachineState_T aMachineState)

{

return i_setMachineState(aMachineState, false /* aUpdateServer */);

}

HRESULT i_findSharedFolder(const Utf8Str &strName,

ComObjPtr<SharedFolder> &aSharedFolder,

bool aSetError = false);

HRESULT i_fetchSharedFolders(BOOL aGlobal);

bool i_findOtherSharedFolder(const Utf8Str &straName,

SharedFolderDataMap::const_iterator &aIt);

HRESULT i_createSharedFolder(const Utf8Str &strName, const SharedFolderData &aData);

HRESULT i_removeSharedFolder(const Utf8Str &strName);

HRESULT i_suspendBeforeConfigChange(PUVM pUVM, AutoWriteLock *pAlock, bool *pfResume);

void i_resumeAfterConfigChange(PUVM pUVM);

static DECLCALLBACK(int) i_configConstructor(PUVM pUVM, PVM pVM, void *pvConsole);

int i_configConstructorInner(PUVM pUVM, PVM pVM, AutoWriteLock *pAlock);

int i_configCfgmOverlay(PCFGMNODE pRoot, IVirtualBox *pVirtualBox, IMachine *pMachine);

int i_configDumpAPISettingsTweaks(IVirtualBox *pVirtualBox, IMachine *pMachine);

int i_configGraphicsController(PCFGMNODE pDevices,

const GraphicsControllerType_T graphicsController,

BusAssignmentManager *pBusMgr,

const ComPtr<IMachine> &pMachine,

const ComPtr<IBIOSSettings> &biosSettings,

bool fHMEnabled);

int i_configMediumAttachment(PCFGMNODE pCtlInst,

const char *pcszDevice,

unsigned uInstance,

StorageBus_T enmBus,

bool fUseHostIOCache,

bool fBuiltinIoCache,

bool fSetupMerge,

unsigned uMergeSource,

unsigned uMergeTarget,

IMediumAttachment *pMediumAtt,

MachineState_T aMachineState,

HRESULT *phrc,

bool fAttachDetach,

bool fForceUnmount,

bool fHotplug,

PUVM pUVM,

DeviceType_T *paLedDevType,

PCFGMNODE *ppLunL0);

int i_configMedium(PCFGMNODE pLunL0,

bool fPassthrough,

DeviceType_T enmType,

bool fUseHostIOCache,

bool fBuiltinIoCache,

bool fSetupMerge,

unsigned uMergeSource,

unsigned uMergeTarget,

const char *pcszBwGroup,

bool fDiscard,

IMedium *pMedium,

MachineState_T aMachineState,

HRESULT *phrc);

static DECLCALLBACK(int) i_reconfigureMediumAttachment(Console *pThis,

PUVM pUVM,

const char *pcszDevice,

unsigned uInstance,

StorageBus_T enmBus,

bool fUseHostIOCache,

bool fBuiltinIoCache,

bool fSetupMerge,

unsigned uMergeSource,

unsigned uMergeTarget,

IMediumAttachment *aMediumAtt,

MachineState_T aMachineState,

HRESULT *phrc);

static DECLCALLBACK(int) i_changeRemovableMedium(Console *pThis,

PUVM pUVM,

const char *pcszDevice,

unsigned uInstance,

StorageBus_T enmBus,

bool fUseHostIOCache,

IMediumAttachment *aMediumAtt,

bool fForce);

HRESULT i_attachRawPCIDevices(PUVM pUVM, BusAssignmentManager *BusMgr, PCFGMNODE pDevices);

void i_attachStatusDriver(PCFGMNODE pCtlInst, PPDMLED *papLeds,

uint64_t uFirst, uint64_t uLast,

Console::MediumAttachmentMap *pmapMediumAttachments,

const char *pcszDevice, unsigned uInstance);

int i_configNetwork(const char *pszDevice, unsigned uInstance, unsigned uLun,

INetworkAdapter *aNetworkAdapter, PCFGMNODE pCfg,

PCFGMNODE pLunL0, PCFGMNODE pInst,

bool fAttachDetach, bool fIgnoreConnectFailure);

static DECLCALLBACK(int) i_configGuestProperties(void *pvConsole, PUVM pUVM);

static DECLCALLBACK(int) i_configGuestControl(void *pvConsole);

static DECLCALLBACK(void) i_vmstateChangeCallback(PUVM pUVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser);

static DECLCALLBACK(int) i_unplugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);

static DECLCALLBACK(int) i_plugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);

HRESULT i_doMediumChange(IMediumAttachment *aMediumAttachment, bool fForce, PUVM pUVM);

HRESULT i_doCPURemove(ULONG aCpu, PUVM pUVM);

HRESULT i_doCPUAdd(ULONG aCpu, PUVM pUVM);

HRESULT i_doNetworkAdapterChange(PUVM pUVM, const char *pszDevice, unsigned uInstance,

unsigned uLun, INetworkAdapter *aNetworkAdapter);

static DECLCALLBACK(int) i_changeNetworkAttachment(Console *pThis, PUVM pUVM, const char *pszDevice,

unsigned uInstance, unsigned uLun,

INetworkAdapter *aNetworkAdapter);

void i_changeClipboardMode(ClipboardMode_T aClipboardMode);

int i_changeDnDMode(DnDMode_T aDnDMode);

#ifdef VBOX_WITH_USB

HRESULT i_attachUSBDevice(IUSBDevice *aHostDevice, ULONG aMaskedIfs);

HRESULT i_detachUSBDevice(const ComObjPtr<OUSBDevice> &aHostDevice);

static DECLCALLBACK(int) i_usbAttachCallback(Console *that, PUVM pUVM, IUSBDevice *aHostDevice, PCRTUUID aUuid,

bool aRemote, const char *aAddress, void *pvRemoteBackend,

USHORT aPortVersion, ULONG aMaskedIfs);

static DECLCALLBACK(int) i_usbDetachCallback(Console *that, PUVM pUVM, PCRTUUID aUuid);

#endif

static DECLCALLBACK(int) i_attachStorageDevice(Console *pThis,

PUVM pUVM,

const char *pcszDevice,

unsigned uInstance,

StorageBus_T enmBus,

bool fUseHostIOCache,

IMediumAttachment *aMediumAtt,

bool fSilent);

static DECLCALLBACK(int) i_detachStorageDevice(Console *pThis,

PUVM pUVM,

const char *pcszDevice,

unsigned uInstance,

StorageBus_T enmBus,

IMediumAttachment *aMediumAtt,

bool fSilent);

HRESULT i_doStorageDeviceAttach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent);

HRESULT i_doStorageDeviceDetach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent);

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

static DECLCALLBACK(int) i_stateProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser);

static DECLCALLBACK(void) i_genericVMSetErrorCallback(PUVM pUVM, void *pvUser, int rc, RT_SRC_POS_DECL,

const char *pszErrorFmt, va_list va);

void i_setVMRuntimeErrorCallbackF(uint32_t fFatal, const char *pszErrorId, const char *pszFormat, ...);

static DECLCALLBACK(void) i_setVMRuntimeErrorCallback(PUVM pUVM, void *pvUser, uint32_t fFatal,

const char *pszErrorId, const char *pszFormat, va_list va);

HRESULT i_captureUSBDevices(PUVM pUVM);

void i_detachAllUSBDevices(bool aDone);

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

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

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

static DECLCALLBACK(int) i_vmm2User_SaveState(PCVMM2USERMETHODS pThis, PUVM pUVM);

static DECLCALLBACK(void) i_vmm2User_NotifyEmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);

static DECLCALLBACK(void) i_vmm2User_NotifyEmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);

static DECLCALLBACK(void) i_vmm2User_NotifyPdmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM);

static DECLCALLBACK(void) i_vmm2User_NotifyPdmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM);

static DECLCALLBACK(void) i_vmm2User_NotifyResetTurnedIntoPowerOff(PCVMM2USERMETHODS pThis, PUVM pUVM);

static DECLCALLBACK(void *) i_drvStatus_QueryInterface(PPDMIBASE pInterface, const char *pszIID);

static DECLCALLBACK(void) i_drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);

static DECLCALLBACK(int) i_drvStatus_MediumEjected(PPDMIMEDIANOTIFY pInterface, unsigned iLUN);

static DECLCALLBACK(void) i_drvStatus_Destruct(PPDMDRVINS pDrvIns);

static DECLCALLBACK(int) i_drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags);

static DECLCALLBACK(int) i_pdmIfSecKey_KeyRetain(PPDMISECKEY pInterface, const char *pszId, const uint8_t **ppbKey,

size_t *pcbKey);

static DECLCALLBACK(int) i_pdmIfSecKey_KeyRelease(PPDMISECKEY pInterface, const char *pszId);

int mcAudioRefs;

volatile uint32_t mcVRDPClients;

uint32_t mu32SingleRDPClientId; /* The id of a connected client in the single connection mode. */

volatile bool mcGuestCredentialsProvided;

static const char *sSSMConsoleUnit;

static uint32_t sSSMConsoleVer;

HRESULT i_loadDataFromSavedState();

int i_loadStateFileExecInternal(PSSMHANDLE pSSM, uint32_t u32Version);

static DECLCALLBACK(void) i_saveStateFileExec(PSSMHANDLE pSSM, void *pvUser);

static DECLCALLBACK(int) i_loadStateFileExec(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);

#ifdef VBOX_WITH_GUEST_PROPS

static DECLCALLBACK(int) i_doGuestPropNotification(void *pvExtension, uint32_t, void *pvParms, uint32_t cbParms);

HRESULT i_doEnumerateGuestProperties(CBSTR aPatterns,

ComSafeArrayOut(BSTR, aNames),

ComSafeArrayOut(BSTR, aValues),

ComSafeArrayOut(LONG64, aTimestamps),

ComSafeArrayOut(BSTR, aFlags));

void i_guestPropertiesHandleVMReset(void);

bool i_guestPropertiesVRDPEnabled(void);

void i_guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char *pszUser, const char *pszDomain);

void i_guestPropertiesVRDPUpdateActiveClient(uint32_t u32ClientId);

void i_guestPropertiesVRDPUpdateClientAttach(uint32_t u32ClientId, bool fAttached);

void i_guestPropertiesVRDPUpdateNameChange(uint32_t u32ClientId, const char *pszName);

void i_guestPropertiesVRDPUpdateIPAddrChange(uint32_t u32ClientId, const char *pszIPAddr);

void i_guestPropertiesVRDPUpdateLocationChange(uint32_t u32ClientId, const char *pszLocation);

void i_guestPropertiesVRDPUpdateOtherInfoChange(uint32_t u32ClientId, const char *pszOtherInfo);

void i_guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId);

#endif

bool i_isResetTurnedIntoPowerOff(void);

/** @name Disk encryption support

HRESULT i_consoleParseDiskEncryption(const char *psz, const char **ppszEnd);

HRESULT i_configureEncryptionForDisk(const char *pszUuid);

HRESULT i_clearDiskEncryptionKeysOnAllAttachments(void);

int i_consoleParseKeyValue(const char *psz, const char **ppszEnd,

char **ppszKey, char **ppszVal);

/** @} */

/** @name Teleporter support

static DECLCALLBACK(int) i_teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser);

HRESULT i_teleporterSrc(TeleporterStateSrc *pState);

HRESULT i_teleporterSrcReadACK(TeleporterStateSrc *pState, const char *pszWhich, const char *pszNAckMsg = NULL);

HRESULT i_teleporterSrcSubmitCommand(TeleporterStateSrc *pState, const char *pszCommand, bool fWaitForAck = true);

HRESULT i_teleporterTrg(PUVM pUVM, IMachine *pMachine, Utf8Str *pErrorMsg, bool fStartPaused,

Progress *pProgress, bool *pfPowerOffOnFailure);

static DECLCALLBACK(int) i_teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser);

/** @} */

bool mSavedStateDataLoaded : 1;

const ComPtr<IMachine> mMachine;

const ComPtr<IInternalMachineControl> mControl;

const ComPtr<IVRDEServer> mVRDEServer;

ConsoleVRDPServer * const mConsoleVRDPServer;

bool mfVRDEChangeInProcess;

bool mfVRDEChangePending;

const ComObjPtr<Guest> mGuest;

const ComObjPtr<Keyboard> mKeyboard;

const ComObjPtr<Mouse> mMouse;

const ComObjPtr<Display> mDisplay;

const ComObjPtr<MachineDebugger> mDebugger;

const ComObjPtr<VRDEServerInfo> mVRDEServerInfo;

/** This can safely be used without holding any locks.

const ComObjPtr<EventSource> mEventSource;

#ifdef VBOX_WITH_EXTPACK

const ComObjPtr<ExtPackManager> mptrExtPackManager;

#endif

const ComObjPtr<EmulatedUSB> mEmulatedUSB;

USBDeviceList mUSBDevices;

RemoteUSBDeviceList mRemoteUSBDevices;

SharedFolderDataMap m_mapGlobalSharedFolders;

SharedFolderDataMap m_mapMachineSharedFolders;

SharedFolderMap m_mapSharedFolders; // the console instances

/** The user mode VM handle. */

PUVM mpUVM;

/** Holds the number of "readonly" mpUVM callers (users). */

uint32_t mVMCallers;

/** Semaphore posted when the number of mpUVM callers drops to zero. */

RTSEMEVENT mVMZeroCallersSem;

/** true when Console has entered the mpUVM destruction phase. */

bool mVMDestroying : 1;

/** true when power down is initiated by vmstateChangeCallback (EMT). */

bool mVMPoweredOff : 1;

/** true when vmstateChangeCallback shouldn't initiate a power down. */

bool mVMIsAlreadyPoweringOff : 1;

/** true if we already showed the snapshot folder size warning. */

bool mfSnapshotFolderSizeWarningShown : 1;

/** true if we already showed the snapshot folder ext4/xfs bug warning. */

bool mfSnapshotFolderExt4WarningShown : 1;

/** true if we already listed the disk type of the snapshot folder. */

bool mfSnapshotFolderDiskTypeShown : 1;

/** true if a USB controller is available (i.e. USB devices can be attached). */

bool mfVMHasUsbController : 1;

/** true if the VM power off was caused by reset. */

bool mfPowerOffCausedByReset : 1;

/** Pointer to the VMM -> User (that's us) callbacks. */

struct MYVMM2USERMETHODS : public VMM2USERMETHODS

{

Console *pConsole;

} *mpVmm2UserMethods;

/** The current network attachment type in the VM.

typedef std::vector<NetworkAttachmentType_T> NetworkAttachmentTypeVector;

NetworkAttachmentTypeVector meAttachmentType;

VMMDev * m_pVMMDev;

#ifdef VBOX_WITH_PDM_AUDIO_DRIVER

AudioVRDE * const mAudioVRDE;

#else

AudioSniffer * const mAudioSniffer;

#endif

Nvram * const mNvram;

#ifdef VBOX_WITH_USB_CARDREADER

UsbCardReader * const mUsbCardReader;

#endif

BusAssignmentManager* mBusMgr;

enum

{

iLedFloppy = 0,

cLedFloppy = 2,

iLedIde = iLedFloppy + cLedFloppy,

cLedIde = 4,

iLedSata = iLedIde + cLedIde,

cLedSata = 30,

iLedScsi = iLedSata + cLedSata,

cLedScsi = 16,

iLedSas = iLedScsi + cLedScsi,

cLedSas = 8,

iLedUsb = iLedSas + cLedSas,

cLedUsb = 8,

cLedStorage = cLedFloppy + cLedIde + cLedSata + cLedScsi + cLedSas + cLedUsb

};

DeviceType_T maStorageDevType[cLedStorage];

PPDMLED mapStorageLeds[cLedStorage];

PPDMLED mapNetworkLeds[36]; /**< @todo adapt this to the maximum network card count */

PPDMLED mapSharedFolderLed;

PPDMLED mapUSBLed[2];

PPDMLED mapCrOglLed;

MediumAttachmentMap mapMediumAttachments;

/** List of attached USB storage devices. */

USBStorageDeviceList mUSBStorageDevices;

/** Map of secret keys used for disk encryption. */

SecretKeyMap m_mapSecretKeys;

/** Pointer to the key consumer -> provider (that's us) callbacks. */

struct MYPDMISECKEY : public PDMISECKEY

{

Console *pConsole;

} *mpIfSecKey;

#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) || defined(RT_OS_FREEBSD))

Utf8Str maTAPDeviceName[8];

RTFILE maTapFD[8];

#endif

bool mVMStateChangeCallbackDisabled;

bool mfUseHostClipboard;

/** Local machine state value. */

MachineState_T mMachineState;

/** Pointer to the progress object of a live cancelable task.

ComObjPtr<Progress> mptrCancelableProgress;

/* The purpose of caching of some events is probably in order to

#ifdef CONSOLE_WITH_EVENT_CACHE

struct

{

/** OnMousePointerShapeChange() cache */

struct

{

bool valid;

bool visible;

bool alpha;

uint32_t xHot;

uint32_t yHot;

uint32_t width;

uint32_t height;

com::SafeArray<BYTE> shape;

} mpsc;

/** OnMouseCapabilityChange() cache */

struct

{

bool valid;

BOOL supportsAbsolute;

BOOL supportsRelative;

BOOL needsHostCursor;

} mcc;

/** OnKeyboardLedsChange() cache */

struct

{

bool valid;

bool numLock;

bool capsLock;

bool scrollLock;

} klc;

void clear()

{

RT_ZERO(mcc);

RT_ZERO(klc);

/* We cannot RT_ZERO mpsc because of shape's vtable. */

mpsc.shape.setNull();

mpsc.valid = mpsc.visible = mpsc.alpha = false;

mpsc.xHot = mpsc.yHot = mpsc.width = mpsc.height = 0;

}

} mCallbackData;

#endif

ComPtr<IEventListener> mVmListener;

friend struct VMTask;

};

#endif // !____H_CONSOLEIMPL