VirtualBoxImpl.h revision e1d164b6e1d0d60a2d796413f0b437bcdad9d5d8
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync * VirtualBox COM class implementation
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2007 innotek GmbH
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * available from http://www.virtualbox.org. This file is free software;
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * you can redistribute it and/or modify it under the terms of the GNU
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * General Public License as published by the Free Software Foundation,
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync public VirtualBoxSupportErrorInfoImpl <VirtualBox, IVirtualBox>,
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync public IDispatchImpl<IVirtualBox, &IID_IVirtualBox, &LIBID_VirtualBox,
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync kTypeLibraryMajorVersion, kTypeLibraryMinorVersion>,
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync typedef std::list <ComPtr <IVirtualBoxCallback> > CallbackList;
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync typedef std::vector <ComPtr <IVirtualBoxCallback> > CallbackVector;
8cb6f31c3048428b42c7370dfbb20e4de7254f40vboxsync /* to postpone generation of the default ctor/dtor */
8cb6f31c3048428b42c7370dfbb20e4de7254f40vboxsync /* public initializer/uninitializer for internal purposes only */
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync /* IVirtualBox properties */
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(HomeFolder)) (BSTR *aHomeFolder);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(SystemProperties)) (ISystemProperties **aSystemProperties);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(Machines)) (IMachineCollection **aMachines);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(HardDisks)) (IHardDiskCollection **aHardDisks);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(DVDImages)) (IDVDImageCollection **aDVDImages);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(COMGETTER(FloppyImages)) (IFloppyImageCollection **aFloppyImages);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(ProgressOperations)) (IProgressCollection **aOperations);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(GuestOSTypes)) (IGuestOSTypeCollection **aGuestOSTypes);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(COMGETTER(SharedFolders)) (ISharedFolderCollection **aSharedFolders);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync /* IVirtualBox methods */
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(CreateMachine) (INPTR BSTR aBaseFolder, INPTR BSTR aName,
aa131431882ca8e44b0480d4af0b5d139f1bde21vboxsync STDMETHOD(CreateLegacyMachine) (INPTR BSTR aSettingsFile, INPTR BSTR aName,
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(OpenMachine) (INPTR BSTR aSettingsFile, IMachine **aMachine);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(GetMachine) (INPTR GUIDPARAM aId, IMachine **aMachine);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(FindMachine) (INPTR BSTR aName, IMachine **aMachine);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(UnregisterMachine) (INPTR GUIDPARAM aId, IMachine **aMachine);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(CreateHardDisk) (HardDiskStorageType_T aStorageType, IHardDisk **aHardDisk);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(OpenHardDisk) (INPTR BSTR aLocation, IHardDisk **aHardDisk);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(OpenVirtualDiskImage) (INPTR BSTR aFilePath, IVirtualDiskImage **aImage);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(RegisterHardDisk) (IHardDisk *aHardDisk);
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync STDMETHOD(GetHardDisk) (INPTR GUIDPARAM aId, IHardDisk **aHardDisk);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(FindHardDisk) (INPTR BSTR aLocation, IHardDisk **aHardDisk);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(FindVirtualDiskImage) (INPTR BSTR aFilePath, IVirtualDiskImage **aImage);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(UnregisterHardDisk) (INPTR GUIDPARAM aId, IHardDisk **aHardDisk);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(OpenDVDImage) (INPTR BSTR aFilePath, INPTR GUIDPARAM aId,
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(RegisterDVDImage) (IDVDImage *aDVDImage);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(GetDVDImage) (INPTR GUIDPARAM aId, IDVDImage **aDVDImage);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(FindDVDImage) (INPTR BSTR aFilePath, IDVDImage **aDVDImage);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(UnregisterDVDImage) (INPTR GUIDPARAM aId, IDVDImage **aDVDImage);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(OpenFloppyImage) (INPTR BSTR aFilePath, INPTR GUIDPARAM aId,
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(RegisterFloppyImage) (IFloppyImage *aFloppyImage);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(GetFloppyImage) (INPTR GUIDPARAM id, IFloppyImage **aFloppyImage);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(FindFloppyImage) (INPTR BSTR aFilePath, IFloppyImage **aFloppyImage);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(GetFloppyImageUsage) (INPTR GUIDPARAM aId,
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(UnregisterFloppyImage) (INPTR GUIDPARAM aId, IFloppyImage **aFloppyImage);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(GetGuestOSType) (INPTR BSTR aId, IGuestOSType **aType);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync STDMETHOD(CreateSharedFolder) (INPTR BSTR aName, INPTR BSTR aHostPath);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(GetNextExtraDataKey) (INPTR BSTR aKey, BSTR *aNextKey, BSTR *aNextValue);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(GetExtraData) (INPTR BSTR aKey, BSTR *aValue);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(SetExtraData) (INPTR BSTR aKey, INPTR BSTR aValue);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(OpenSession) (ISession *aSession, INPTR GUIDPARAM aMachineId);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(OpenRemoteSession) (ISession *aSession, INPTR GUIDPARAM aMachineId,
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(OpenExistingSession) (ISession *aSession, INPTR GUIDPARAM aMachineId);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(RegisterCallback) (IVirtualBoxCallback *callback);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync STDMETHOD(UnregisterCallback) (IVirtualBoxCallback *callback);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync /* public methods only for internal purposes */
cbc215af8423a8326b27143c59c5d8fc9ffb0279vboxsync typedef DECLCALLBACKPTR (HRESULT, SVCHelperClientFunc)
cbc215af8423a8326b27143c59c5d8fc9ffb0279vboxsync (SVCHlpClient *aClient, Progress *aProgress, void *aUser, int *aVrc);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onMachineStateChange (const Guid &aId, MachineState_T aState);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync BOOL onExtraDataCanChange(const Guid &aId, INPTR BSTR aKey, INPTR BSTR aValue,
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onExtraDataChange(const Guid &aId, INPTR BSTR aKey, INPTR BSTR aValue);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onMachineRegistered (const Guid &aId, BOOL aRegistered);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onSessionStateChange (const Guid &aId, SessionState_T aState);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onSnapshotTaken (const Guid &aMachineId, const Guid &aSnapshotId);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onSnapshotDiscarded (const Guid &aMachineId, const Guid &aSnapshotId);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void onSnapshotChange (const Guid &aMachineId, const Guid &aSnapshotId);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync typedef std::vector <ComObjPtr <SessionMachine> > SessionMachineVector;
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync void getOpenedMachines (SessionMachineVector &aVector);
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync return SUCCEEDED (findMachine (aId, false /* aSetError */, NULL));
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync /// @todo (dmik) remove and make findMachine() public instead
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync // after switching to VirtualBoxBaseNEXT
ece707b8d97e63ed54d4b48d7a8d841187e0023cvboxsync HRESULT getMachine (const Guid &aId, ComObjPtr <Machine> &aMachine,
2f4c1bacd54af5063c3185cc8eab03e4e8ef9b90vboxsync bool aSetError = false)
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync /// @todo (dmik) remove and make findHardDisk() public instead
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync // after switching to VirtualBoxBaseNEXT
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT getHardDisk (const Guid &aId, ComObjPtr <HardDisk> &aHardDisk)
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync return findHardDisk (&aId, NULL, true /* aDoSetError */, &aHardDisk);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync bool getDVDImageUsage (const Guid &aId, ResourceUsage_T aUsage,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync bool getFloppyImageUsage (const Guid &aId, ResourceUsage_T aUsage,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync const ComObjPtr <Host> &host() { return mData.mHost; }
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync const ComObjPtr <SystemProperties> &systemProperties() { return mData.mSystemProperties; }
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync /** Returns the VirtualBox home directory */
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync const Utf8Str &homeDir() { return mData.mHomeDir; }
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync void calculateRelativePath (const char *aPath, Utf8Str &aResult);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync enum RHD_Flags { RHD_Internal, RHD_External, RHD_OnStartUp };
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT registerHardDisk (HardDisk *aHardDisk, RHD_Flags aFlags);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT unregisterDiffHardDisk (HardDisk *aHardDisk);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT updateSettings (const char *aOldPath, const char *aNewPath);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync const Bstr &settingsFileName() { return mData.mCfgFile.mName; }
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync /* for VirtualBoxSupportErrorInfoImpl */
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync static const wchar_t *getComponentName() { return L"VirtualBox"; }
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComObjPtr <Machine> > MachineList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComObjPtr <GuestOSType> > GuestOSTypeList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComPtr <IProgress> > ProgressList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComObjPtr <HardDisk> > HardDiskList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComObjPtr <DVDImage> > DVDImageList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComObjPtr <FloppyImage> > FloppyImageList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::list <ComObjPtr <SharedFolder> > SharedFolderList;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync typedef std::map <Guid, ComObjPtr <HardDisk> > HardDiskMap;
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT findMachine (const Guid &aId, bool aSetError,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT findHardDisk (const Guid *aId, const BSTR aLocation,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync bool aSetError, ComObjPtr <HardDisk> *aHardDisk = NULL);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT findVirtualDiskImage (const Guid *aId, const BSTR aFilePathFull,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync bool aSetError, ComObjPtr <HVirtualDiskImage> *aImage = NULL);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT findDVDImage (const Guid *aId, const BSTR aFilePathFull,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync bool aSetError, ComObjPtr <DVDImage> *aImage = NULL);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT findFloppyImage (const Guid *aId, const BSTR aFilePathFull,
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync bool aSetError, ComObjPtr <FloppyImage> *aImage = NULL);
3a45119099f0df5230e8304145168aa5e2a3f1a1vboxsync HRESULT checkMediaForConflicts (HardDisk *aHardDisk,
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync HRESULT registerDVDImage (DVDImage *aImage, bool aOnStartUp);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync HRESULT registerFloppyImage (FloppyImage *aImage, bool aOnStartUp);
416817daa142e9bb7eaf14a1b10577978a5e691bvboxsync /** @note This method is not thread safe */
416817daa142e9bb7eaf14a1b10577978a5e691bvboxsync bool isConfigLocked() { return mData.mCfgFile.mHandle != NIL_RTFILE; }
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync * Main VirtualBox data structure.
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync * @note |const| members are persistent during lifetime so can be accessed
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * without locking.
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync // const data members not requiring locking
416817daa142e9bb7eaf14a1b10577978a5e691bvboxsync // const objects not requiring locking
5a07658d13590eba51dd98ef335a73d2a11edaa7vboxsync const ComObjPtr <SystemProperties> mSystemProperties;
2f4c1bacd54af5063c3185cc8eab03e4e8ef9b90vboxsync /** Client watcher thread data structure */
a8d502445ce722c6b9700c5579b4a38b58827b7dvboxsync // const objects not requiring locking
8cb6f31c3048428b42c7370dfbb20e4de7254f40vboxsync /** Lock for calling EventQueue->post() */
416817daa142e9bb7eaf14a1b10577978a5e691bvboxsync static DECLCALLBACK(int) ClientWatcher (RTTHREAD thread, void *pvUser);
416817daa142e9bb7eaf14a1b10577978a5e691bvboxsync static DECLCALLBACK(int) AsyncEventHandler (RTTHREAD thread, void *pvUser);
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync static DECLCALLBACK(int) SVCHelperClientThread (RTTHREAD aThread, void *aUser);
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync////////////////////////////////////////////////////////////////////////////////
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync * Abstract callback event class to asynchronously call VirtualBox callbacks
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * on a dedicated event thread. Subclasses reimplement #handleCallback()
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * to call appropriate IVirtualBoxCallback methods depending on the event
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * to be dispatched.
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * @note The VirtualBox instance passed to the constructor is strongly
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * referenced, so that the VirtualBox singleton won't be released until the
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * event gets handled by the event thread.
bcd589d9db90b68d3af5d6839c1d613bb64d4c04vboxsync CallbackEvent (VirtualBox *aVirtualBox) : mVirtualBox (aVirtualBox)
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync virtual void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback) = 0;
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * Note that this is a weak ref -- the CallbackEvent handler thread
610972deee47d5e5229ccdb6c86cbb332d2b4626vboxsync * is bound to the lifetime of the VirtualBox instance, so it's safe.
416817daa142e9bb7eaf14a1b10577978a5e691bvboxsync#endif // ____H_VIRTUALBOXIMPL