Main/include/ConsoleImpl.h

	ConsoleImpl.h revision f244f3b6136a2c0642e68a3dce252362c08e2437
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync/** @file
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * VBox Console COM Class definition
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync/*
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * Copyright (C) 2006-2007 innotek GmbH
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * available from http://www.virtualbox.org. This file is free software;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * General Public License (GPL) as published by the Free Software
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#ifndef ____H_CONSOLEIMPL
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#define ____H_CONSOLEIMPL
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#include "VirtualBoxBase.h"
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#include "ProgressImpl.h"
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass Guest;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass Keyboard;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass Mouse;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass Display;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass MachineDebugger;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass OUSBDevice;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass RemoteUSBDevice;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass SharedFolder;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass RemoteDisplayInfo;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass AudioSniffer;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass ConsoleVRDPServer;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass VMMDev;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#include <VBox/vrdpapi.h>
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#include <VBox/pdmdrv.h>
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncstruct VUSBIRHCONFIG;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsynctypedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#include <list>
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync// defines
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync///////////////////////////////////////////////////////////////////////////////
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync/**
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  Checks the availability of the underlying VM device driver corresponding
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  to the COM interface (IKeyboard, IMouse, IDisplay, etc.). When the driver is
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  not available (NULL), sets error info and returns returns E_ACCESSDENIED.
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  The translatable error message is defined in null context.
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  Intended to used only within Console children (i,e. Keyboard, Mouse,
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  Display, etc.).
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  @param drv  driver pointer to check (compare it with NULL)
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#define CHECK_CONSOLE_DRV(drv) \
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    do { \
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync        if (!(drv)) \
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync            return setError (E_ACCESSDENIED, tr ("The console is not powered up")); \
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    } while (0)
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync/** @def VBOX_WITH_UNIXY_TAP_NETWORKING
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  Unixy style TAP networking. This is defined in the Makefile since it's also
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync *  used by NetworkAdapterImpl.h/cpp.
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#ifdef __DOXYGEN__
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync# define VBOX_WITH_UNIXY_TAP_NETWORKING
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync#endif
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync// Console
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync///////////////////////////////////////////////////////////////////////////////
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync/** IConsole implementation class */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncclass ATL_NO_VTABLE Console :
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    public VirtualBoxBaseWithChildrenNEXT,
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    public VirtualBoxSupportErrorInfoImpl <Console, IConsole>,
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    public VirtualBoxSupportTranslation <Console>,
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    public IConsole
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync{
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    Q_OBJECT
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsyncpublic:
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    DECLARE_NOT_AGGREGATABLE(Console)
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    DECLARE_PROTECT_FINAL_CONSTRUCT()
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    BEGIN_COM_MAP(Console)
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync        COM_INTERFACE_ENTRY(ISupportErrorInfo)
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync        COM_INTERFACE_ENTRY(IConsole)
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    END_COM_MAP()
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    NS_DECL_ISUPPORTS
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    Console();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    ~Console();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT FinalConstruct();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void FinalRelease();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    // public initializers/uninitializers for internal purposes only
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT init (IMachine *aMachine, IInternalMachineControl *aControl);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void uninit();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    // IConsole properties
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(Machine)) (IMachine **aMachine);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(State)) (MachineState_T *aMachineState);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(Guest)) (IGuest **aGuest);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(Keyboard)) (IKeyboard **aKeyboard);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(Mouse)) (IMouse **aMouse);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(Display)) (IDisplay **aDisplay);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(Debugger)) (IMachineDebugger **aDebugger);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(USBDevices)) (IUSBDeviceCollection **aUSBDevices);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(RemoteUSBDevices)) (IHostUSBDeviceCollection **aRemoteUSBDevices);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(RemoteDisplayInfo)) (IRemoteDisplayInfo **aRemoteDisplayInfo);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(COMGETTER(SharedFolders)) (ISharedFolderCollection **aSharedFolders);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    // IConsole methods
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(PowerUp) (IProgress **aProgress);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(PowerDown)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(Reset)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(Pause)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(Resume)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(PowerButton)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(SleepButton)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(GetPowerButtonHandled)(BOOL *aHandled);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(SaveState) (IProgress **aProgress);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(AdoptSavedState) (INPTR BSTR aSavedStateFile);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(DiscardSavedState)();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(GetDeviceActivity) (DeviceType_T aDeviceType,
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync                                 DeviceActivity_T *aDeviceActivity);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(AttachUSBDevice) (INPTR GUIDPARAM aId);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(DetachUSBDevice) (INPTR GUIDPARAM aId, IUSBDevice **aDevice);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(CreateSharedFolder) (INPTR BSTR aName, INPTR BSTR aHostPath, BOOL aWritable);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(RemoveSharedFolder) (INPTR BSTR aName);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(TakeSnapshot) (INPTR BSTR aName, INPTR BSTR aDescription,
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync                             IProgress **aProgress);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(DiscardSnapshot) (INPTR GUIDPARAM aId, IProgress **aProgress);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(DiscardCurrentState) (IProgress **aProgress);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(DiscardCurrentSnapshotAndState) (IProgress **aProgress);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(RegisterCallback) (IConsoleCallback *aCallback);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    STDMETHOD(UnregisterCallback)(IConsoleCallback *aCallback);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    // public methods for internal purposes only
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    /*
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync     *  Note: the following methods do not increase refcount. intended to be
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync     *  called only by the VM execution thread.
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync     */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    Guest *getGuest() { return mGuest; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    Keyboard *getKeyboard() { return mKeyboard; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    Mouse *getMouse() { return mMouse; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    Display *getDisplay() { return mDisplay; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    MachineDebugger *getMachineDebugger() { return mDebugger; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    const ComPtr <IMachine> &machine() { return mMachine; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    /** Method is called only from ConsoleVRDPServer */
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    IVRDPServer *getVRDPServer() { return mVRDPServer; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    ConsoleVRDPServer *consoleVRDPServer() { return mConsoleVRDPServer; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT updateMachineState (MachineState_T aMachineState);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    // events from IInternalSessionControl
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onDVDDriveChange();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onFloppyDriveChange();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onNetworkAdapterChange (INetworkAdapter *aNetworkAdapter);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onSerialPortChange (ISerialPort *aSerialPort);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onParallelPortChange (IParallelPort *aParallelPort);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onVRDPServerChange();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onUSBControllerChange();
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onSharedFolderChange (BOOL aGlobal);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onUSBDeviceAttach (IUSBDevice *aDevice, IVirtualBoxErrorInfo *aError, ULONG aMaskedIfs);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    HRESULT onUSBDeviceDetach (INPTR GUIDPARAM aId, IVirtualBoxErrorInfo *aError);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    VMMDev *getVMMDev() { return mVMMDev; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    AudioSniffer *getAudioSniffer () { return mAudioSniffer; }
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    int VRDPClientLogon (uint32_t u32ClientId, const char *pszUser, const char *pszPassword, const char *pszDomain);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void VRDPClientConnect (uint32_t u32ClientId);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void VRDPClientDisconnect (uint32_t u32ClientId, uint32_t fu32Intercepted);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void VRDPInterceptAudio (uint32_t u32ClientId);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void VRDPInterceptUSB (uint32_t u32ClientId, void **ppvIntercept);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void VRDPInterceptClipboard (uint32_t u32ClientId);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync    void processRemoteUSBDevices (uint32_t u32ClientId, VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList);
1d7eb4842eb34752cbc8655fc26097b97806314dvboxsync
    // callback callers (partly; for some events console callbacks are notified
    // directly from IInternalSessionControl event handlers declared above)
    void onMousePointerShapeChange(bool fVisible, bool fAlpha,
                                   uint32_t xHot, uint32_t yHot,
                                   uint32_t width, uint32_t height,
                                   void *pShape);
    void onMouseCapabilityChange (BOOL supportsAbsolute, BOOL needsHostCursor);
    void onStateChange (MachineState_T aMachineState);
    void onAdditionsStateChange();
    void onAdditionsOutdated();
    void onKeyboardLedsChange (bool fNumLock, bool fCapsLock, bool fScrollLock);
    void onUSBDeviceStateChange (IUSBDevice *aDevice, bool aAttached,
                                 IVirtualBoxErrorInfo *aError);
    void onRuntimeError (BOOL aFatal, INPTR BSTR aErrorID, INPTR BSTR aMessage);
    HRESULT onShowWindow (BOOL aCheck, BOOL *aCanShow, ULONG64 *aWinId);

    static const PDMDRVREG DrvStatusReg;

    void reportAuthLibraryError (const char *filename, int rc)
    {
        setError (E_FAIL, tr("Could not load the external authentication library '%s' (%Vrc)"), filename, rc);
    }

    // for VirtualBoxSupportErrorInfoImpl
    static const wchar_t *getComponentName() { return L"Console"; }

private:

    /**
     *  Base template for AutoVMCaller and SaveVMPtr. Template arguments
     *  have the same meaning as arguments of Console::addVMCaller().
     */
    template <bool taQuiet = false, bool taAllowNullVM = false>
    class AutoVMCallerBase
    {
    public:
        AutoVMCallerBase (Console *aThat) : mThat (aThat), mRC (S_OK)
        {
            Assert (aThat);
            mRC = aThat->addVMCaller (taQuiet, taAllowNullVM);
        }
        ~AutoVMCallerBase()
        {
            if (SUCCEEDED (mRC))
                mThat->releaseVMCaller();
        }
        /** Decreases the number of callers before the instance is destroyed. */
        void release()
        {
            AssertReturnVoid (SUCCEEDED (mRC));
            mThat->releaseVMCaller();
            mRC = E_FAIL;
        }
        /** Restores the number of callers after by #release(). #rc() must be
         *  rechecked to ensure the operation succeeded. */
        void add()
        {
            AssertReturnVoid (!SUCCEEDED (mRC));
            mRC = mThat->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;
        HRESULT mRC;
    private:
        DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (AutoVMCallerBase)
        DECLARE_CLS_NEW_DELETE_NOOP (AutoVMCallerBase)
    };

    /**
     *  Helper class that protects sections of code using the mpVM pointer by
     *  automatically calling addVMCaller() on construction and
     *  releaseVMCaller() on destruction. Intended for Console methods dealing
     *  with mpVM. The usage pattern is:
     *  <code>
     *      AutoVMCaller autoVMCaller (this);
     *      CheckComRCReturnRC (autoVMCaller.rc());
     *      ...
     *      VMR3ReqCall (mpVM, ...
     *  </code>
     *
     *  @sa SafeVMPtr, SafeVMPtrQuiet
     */
    typedef AutoVMCallerBase <false, false> AutoVMCaller;

    /**
     *  Same as AutoVMCaller but doesn't set extended error info on failure.
     */
    typedef AutoVMCallerBase <true, false> AutoVMCallerQuiet;

    /**
     *  Same as AutoVMCaller but allows a null VM pointer (to trigger an error
     *  instead of assertion).
     */
    typedef AutoVMCallerBase <false, true> AutoVMCallerWeak;

    /**
     *  Same as AutoVMCaller but doesn't set extended error info on failure
     *  and allows a null VM pointer (to trigger an error instead of
     *  assertion).
     */
    typedef AutoVMCallerBase <true, true> AutoVMCallerQuietWeak;

    /**
     *  Base template for SaveVMPtr and SaveVMPtrQuiet.
     */
    template <bool taQuiet = false>
    class SafeVMPtrBase : public AutoVMCallerBase <taQuiet, true>
    {
        typedef AutoVMCallerBase <taQuiet, true> Base;
    public:
        SafeVMPtrBase (Console *aThat) : Base (aThat), mpVM (NULL)
        {
            if (SUCCEEDED (Base::mRC))
                mpVM = aThat->mpVM;
        }
        /** Smart SaveVMPtr to PVM cast operator */
        operator PVM() const { return mpVM; }
        /** Direct PVM access for printf()-like functions */
        PVM raw() const { return mpVM; }
    private:
        PVM mpVM;
        DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (SafeVMPtrBase)
        DECLARE_CLS_NEW_DELETE_NOOP (SafeVMPtrBase)
    };

public:

    /**
     *  Helper class that safely manages the Console::mpVM pointer
     *  by calling addVMCaller() on construction and releaseVMCaller() on
     *  destruction. Intended for Console children. The usage pattern is:
     *  <code>
     *      Console::SaveVMPtr pVM (mParent);
     *      CheckComRCReturnRC (pVM.rc());
     *      ...
     *      VMR3ReqCall (pVM, ...
     *      ...
     *      printf ("%p\n", pVM.raw());
     *  </code>
     *
     *  @sa SafeVMPtrQuiet, AutoVMCaller
     */
    typedef SafeVMPtrBase <false> SafeVMPtr;

    /**
     *  A deviation of SaveVMPtr that doesn't set the error info on failure.
     *  Intenede for pieces of code that don't need to return the VM access
     *  failure to the caller. The usage pattern is:
     *  <code>
     *      Console::SaveVMPtrQuiet pVM (mParent);
     *      if (pVM.rc())
     *          VMR3ReqCall (pVM, ...
     *      return S_OK;
     *  </code>
     *
     *  @sa SafeVMPtr, AutoVMCaller
     */
    typedef SafeVMPtrBase <true> SafeVMPtrQuiet;

    class SharedFolderData
    {
    public:
        SharedFolderData() {}
        SharedFolderData(Bstr aHostPath, BOOL aWritable)
           : mHostPath (aHostPath)
           , mWritable (aWritable) {}
        SharedFolderData(const SharedFolderData& aThat)
           : mHostPath (aThat.mHostPath)
           , mWritable (aThat.mWritable) {}
        Bstr mHostPath;
        BOOL mWritable;
    };
    typedef std::map <Bstr, ComObjPtr <SharedFolder> > SharedFolderMap;
    typedef std::map <Bstr, SharedFolderData> SharedFolderDataMap;

private:

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

    HRESULT addVMCaller (bool aQuiet = false, bool aAllowNullVM = false);
    void releaseVMCaller();

    HRESULT consoleInitReleaseLog (const ComPtr <IMachine> aMachine);

    HRESULT powerDown();

    HRESULT callTapSetupApplication(bool isStatic, RTFILE tapFD, Bstr &tapDevice,
                                    Bstr &tapSetupApplication);
    HRESULT attachToHostInterface(INetworkAdapter *networkAdapter);
    HRESULT detachFromHostInterface(INetworkAdapter *networkAdapter);
    HRESULT powerDownHostInterfaces();

    HRESULT setMachineState (MachineState_T aMachineState, bool aUpdateServer = true);
    HRESULT setMachineStateLocally (MachineState_T aMachineState)
    {
        return setMachineState (aMachineState, false /* aUpdateServer */);
    }

    HRESULT findSharedFolder (const BSTR aName,
                              ComObjPtr <SharedFolder> &aSharedFolder,
                              bool aSetError = false);

    HRESULT fetchSharedFolders (BOOL aGlobal);
    bool findOtherSharedFolder (INPTR BSTR aName,
                                SharedFolderDataMap::const_iterator &aIt);

    HRESULT createSharedFolder (INPTR BSTR aName, SharedFolderData aData);
    HRESULT removeSharedFolder (INPTR BSTR aName);

    static DECLCALLBACK(int) configConstructor(PVM pVM, void *pvConsole);
    static DECLCALLBACK(void) vmstateChangeCallback(PVM aVM, VMSTATE aState,
                                                    VMSTATE aOldState, void *aUser);
    HRESULT doDriveChange (const char *pszDevice, unsigned uInstance,
                           unsigned uLun, DriveState_T eState,
                           DriveState_T *peState, const char *pszPath,
                           bool fPassthrough);
    static DECLCALLBACK(int) changeDrive (Console *pThis, const char *pszDevice,
                                          unsigned uInstance, unsigned uLun,
                                          DriveState_T eState, DriveState_T *peState,
                                          const char *pszPath, bool fPassthrough);

#ifdef VBOX_WITH_USB
    HRESULT attachUSBDevice (IUSBDevice *aHostDevice, ULONG aMaskedIfs);
    HRESULT detachUSBDevice (USBDeviceList::iterator &aIt);

    static DECLCALLBACK(int)
    usbAttachCallback (Console *that, IUSBDevice *aHostDevice, PCRTUUID aUuid,
                       bool aRemote, const char *aAddress, ULONG aMaskedIfs);
    static DECLCALLBACK(int)
    usbDetachCallback (Console *that, USBDeviceList::iterator *aIt, PCRTUUID aUuid);
#endif

    static DECLCALLBACK (int)
    stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser);

    static DECLCALLBACK(void)
    setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
                        const char *pszFormat, va_list args);

    static DECLCALLBACK(void)
    setVMRuntimeErrorCallback (PVM pVM, void *pvUser, bool fFatal,
                               const char *pszErrorID,
                               const char *pszFormat, va_list args);

    HRESULT                     captureUSBDevices (PVM pVM);
    void                        detachAllUSBDevices (bool aDone);

    static DECLCALLBACK (int)   powerUpThread (RTTHREAD Thread, void *pvUser);
    static DECLCALLBACK (int)   saveStateThread (RTTHREAD Thread, void *pvUser);
    static DECLCALLBACK (int)   powerDownThread (RTTHREAD Thread, void *pvUser);

    static DECLCALLBACK(void *) drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface);
    static DECLCALLBACK(void)   drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);
    static DECLCALLBACK(void)   drvStatus_Destruct(PPDMDRVINS pDrvIns);
    static DECLCALLBACK(int)    drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle);

    int mcAudioRefs;
    volatile uint32_t mcVRDPClients;

    static const char *sSSMConsoleUnit;
    static uint32_t sSSMConsoleVer;

    HRESULT loadDataFromSavedState();

    static DECLCALLBACK(void)   saveStateFileExec (PSSMHANDLE pSSM, void *pvUser);
    static DECLCALLBACK(int)    loadStateFileExec (PSSMHANDLE pSSM, void *pvUser, uint32_t u32Version);

    bool mSavedStateDataLoaded : 1;

    const ComPtr <IMachine> mMachine;
    const ComPtr <IInternalMachineControl> mControl;

    const ComPtr <IVRDPServer> mVRDPServer;
    const ComPtr <IDVDDrive> mDVDDrive;
    const ComPtr <IFloppyDrive> mFloppyDrive;

    ConsoleVRDPServer * const mConsoleVRDPServer;

    const ComObjPtr <Guest> mGuest;
    const ComObjPtr <Keyboard> mKeyboard;
    const ComObjPtr <Mouse> mMouse;
    const ComObjPtr <Display> mDisplay;
    const ComObjPtr <MachineDebugger> mDebugger;
    const ComObjPtr <RemoteDisplayInfo> mRemoteDisplayInfo;

    USBDeviceList mUSBDevices;
    RemoteUSBDeviceList mRemoteUSBDevices;

    SharedFolderMap mSharedFolders;
    SharedFolderDataMap mMachineSharedFolders;
    SharedFolderDataMap mGlobalSharedFolders;

    /** The VM instance handle. */
    PVM mpVM;
    /** Holds the number of "readonly" mpVM callers (users) */
    uint32_t mVMCallers;
    /** Semaphore posted when the number of mpVM callers drops to zero */
    RTSEMEVENT mVMZeroCallersSem;
    /** true when Console has entered the mpVM destruction phase */
    bool mVMDestroying : 1;

    /** The current DVD drive state in the VM.
     * This does not have to match the state maintained in the DVD. */
    DriveState_T meDVDState;
    /** The current Floppy drive state in the VM.
     * This does not have to match the state maintained in the Floppy. */
    DriveState_T meFloppyState;

    VMMDev * const mVMMDev;
    AudioSniffer * const mAudioSniffer;

    PPDMLED     mapFDLeds[2];
    PPDMLED     mapIDELeds[4];
    PPDMLED     mapSATALeds[30];
    PPDMLED     mapNetworkLeds[8];
    PPDMLED     mapSharedFolderLed;
    PPDMLED     mapUSBLed;
#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
    Utf8Str     maTAPDeviceName[8];
    RTFILE      maTapFD[8];
#endif

    bool mVMStateChangeCallbackDisabled;

    /* Local machine state value */
    MachineState_T mMachineState;

    typedef std::list <ComPtr <IConsoleCallback> > CallbackList;
    CallbackList mCallbacks;

    struct
    {
        /** OnMousePointerShapeChange() cache */
        struct
        {
            bool valid;
            bool visible;
            bool alpha;
            uint32_t xHot;
            uint32_t yHot;
            uint32_t width;
            uint32_t height;
            BYTE *shape;
            size_t shapeSize;
        }
        mpsc;

        /** OnMouseCapabilityChange() cache */
        struct
        {
            bool valid;
            BOOL supportsAbsolute;
            BOOL needsHostCursor;
        }
        mcc;

        /** OnKeyboardLedsChange() cache */
        struct
        {
            bool valid;
            bool numLock;
            bool capsLock;
            bool scrollLock;
        }
        klc;
    }
    mCallbackData;

    friend struct VMTask;
};

#endif // ____H_CONSOLEIMPL