VirtualBoxImpl.h revision 727711672728473d7957fb70a8f18c49422f8db4
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * VirtualBox COM class implementation
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * Copyright (C) 2006-2011 Oracle Corporation
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * This file is part of VirtualBox Open Source Edition (OSE), as
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * available from http://www.virtualbox.org. This file is free software;
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * you can redistribute it and/or modify it under the terms of the GNU
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * General Public License (GPL) as published by the Free Software
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * Foundation, in version 2 as it comes in the "COPYING" file of the
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
61ea54c309169801a1833f99729723071c24c047Dirk Hoganclass VirtualBoxCallbackRegistration; /* see VirtualBoxImpl.cpp */
61ea54c309169801a1833f99729723071c24c047Dirk Hogantypedef std::list< ComObjPtr<SessionMachine> > SessionMachinesList;
61ea54c309169801a1833f99729723071c24c047Dirk Hogan , public CComCoClass<VirtualBox, &CLSID_VirtualBox>
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek typedef std::list< ComPtr<IInternalSessionControl> > InternalControlList;
0f2147bc9d8fa5c26e6c2e8ea5d6c45358e72434Dirk Hogan VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VirtualBox, IVirtualBox)
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek VBOX_DEFAULT_INTERFACE_ENTRIES(IVirtualBox)
61ea54c309169801a1833f99729723071c24c047Dirk Hogan // to postpone generation of the default ctor/dtor
61ea54c309169801a1833f99729723071c24c047Dirk Hogan /* public initializer/uninitializer for internal purposes only */
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek HRESULT initMedia(const Guid &uuidMachineRegistry,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan /* IVirtualBox properties */
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(COMGETTER(Revision)) (ULONG *aRevision);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(COMGETTER(PackageType)) (BSTR *aPackageType);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(APIVersion)) (BSTR *aAPIVersion);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(HomeFolder)) (BSTR *aHomeFolder);
55e32e1d339c1e3417aa96111d48d51eb29be585Dirk Hogan STDMETHOD(COMGETTER(SettingsFilePath)) (BSTR *aSettingsFilePath);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(SystemProperties)) (ISystemProperties **aSystemProperties);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(Machines)) (ComSafeArrayOut(IMachine *, aMachines));
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(COMGETTER(HardDisks)) (ComSafeArrayOut(IMedium *, aHardDisks));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(DVDImages)) (ComSafeArrayOut(IMedium *, aDVDImages));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(FloppyImages)) (ComSafeArrayOut(IMedium *, aFloppyImages));
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(COMGETTER(ProgressOperations)) (ComSafeArrayOut(IProgress *, aOperations));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(GuestOSTypes)) (ComSafeArrayOut(IGuestOSType *, aGuestOSTypes));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(SharedFolders)) (ComSafeArrayOut(ISharedFolder *, aSharedFolders));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(PerformanceCollector)) (IPerformanceCollector **aPerformanceCollector);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(COMGETTER(DHCPServers)) (ComSafeArrayOut(IDHCPServer *, aDHCPServers));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(EventSource)) (IEventSource ** aEventSource);
4cc414596f330cc595f62252d964ef97b3795056Dirk Hogan STDMETHOD(COMGETTER(ExtensionPackManager)) (IExtPackManager **aExtPackManager);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(InternalNetworks)) (ComSafeArrayOut(BSTR, aInternalNetworks));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(COMGETTER(GenericNetworkDrivers)) (ComSafeArrayOut(BSTR, aGenericNetworkDrivers));
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek /* IVirtualBox methods */
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(ComposeMachineFilename) (IN_BSTR aName, IN_BSTR aBaseFolder, BSTR *aFilename);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(OpenMachine) (IN_BSTR aSettingsFile, IMachine **aMachine);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan STDMETHOD(FindMachine) (IN_BSTR aNameOrId, IMachine **aMachine);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan STDMETHOD(CreateAppliance) (IAppliance **anAppliance);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(GetGuestOSType) (IN_BSTR aId, IGuestOSType **aType);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(CreateSharedFolder) (IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(GetExtraDataKeys) (ComSafeArrayOut(BSTR, aKeys));
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(GetExtraData) (IN_BSTR aKey, BSTR *aValue);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(SetExtraData) (IN_BSTR aKey, IN_BSTR aValue);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(CreateDHCPServer) (IN_BSTR aName, IDHCPServer ** aServer);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(FindDHCPServerByNetworkName) (IN_BSTR aName, IDHCPServer ** aServer);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek STDMETHOD(RemoveDHCPServer) (IDHCPServer * aServer);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan STDMETHOD(CheckFirmwarePresent)(FirmwareType_T aFirmwareType, IN_BSTR aVersion,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan /* public methods only for internal purposes */
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * Override of the default locking class to be used for validating lock
61ea54c309169801a1833f99729723071c24c047Dirk Hogan * order with the standard member lock handle.
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek HRESULT addProgress(IProgress *aProgress);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan typedef DECLCALLBACKPTR (HRESULT, SVCHelperClientFunc)
61ea54c309169801a1833f99729723071c24c047Dirk Hogan (SVCHlpClient *aClient, Progress *aProgress, void *aUser, int *aVrc);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onMachineStateChange(const Guid &aId, MachineState_T aState);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onMachineDataChange(const Guid &aId, BOOL aTemporary = FALSE);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek BOOL onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek void onMachineRegistered(const Guid &aId, BOOL aRegistered);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onSessionStateChange(const Guid &aId, SessionState_T aState);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName, IN_BSTR aValue,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void onNatRedirectChange(const Guid &aMachineId, ULONG ulSlot, bool fRemove, IN_BSTR aName,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan NATProtocol_T aProto, IN_BSTR aHostIp, uint16_t aHostPort,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void getOpenedMachines(SessionMachinesList &aMachines,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan HRESULT findHardDiskByLocation(const Utf8Str &strLocation,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan HRESULT findDVDOrFloppyImage(DeviceType_T mediumType,
61ea54c309169801a1833f99729723071c24c047Dirk Hogan HRESULT findRemoveableMedium(DeviceType_T mediumType,
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek HRESULT findGuestOSType(const Bstr &bstrOSType,
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek SystemProperties* getSystemProperties() const;
61ea54c309169801a1833f99729723071c24c047Dirk Hogan const ComObjPtr<PerformanceCollector>& performanceCollector() const;
61ea54c309169801a1833f99729723071c24c047Dirk Hogan#endif /* VBOX_WITH_RESOURCE_USAGE_API */
61ea54c309169801a1833f99729723071c24c047Dirk Hogan void getDefaultMachineFolder(Utf8Str &str) const;
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan void getDefaultHardDiskFormat(Utf8Str &str) const;
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan /** Returns the VirtualBox home directory */
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan void copyPathRelativeToConfig(const Utf8Str &strSource, Utf8Str &strTarget);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT registerHardDisk(Medium *aHardDisk, GuidList *pllRegistriesThatNeedSaving);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT unregisterHardDisk(Medium *aHardDisk, GuidList *pllRegistriesThatNeedSaving);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek HRESULT registerImage(Medium *aImage, DeviceType_T argType, GuidList *pllRegistriesThatNeedSaving);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT unregisterImage(Medium *aImage, DeviceType_T argType, GuidList *pllRegistriesThatNeedSaving);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan void pushMediumToListWithChildren(MediaList &llMedia, Medium *pMedium);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT unregisterMachine(Machine *pMachine, const Guid &id);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan void rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan void saveMediaRegistry(settings::MediaRegistry &mediaRegistry,
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan void addGuidToListUniquely(GuidList &llRegistriesThatNeedSaving, const Guid &uuid);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT saveRegistries(const GuidList &llRegistriesThatNeedSaving);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan static HRESULT ensureFilePathExists(const Utf8Str &strFileName);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan static HRESULT handleUnexpectedExceptions (RT_SRC_POS_DECL);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan static HRESULT setErrorStatic(HRESULT aResultCode,
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
3d8ee1629200b24b539b887a7feaec640fe610a8Kajetan Hemzaczek HRESULT registerMachine(Machine *aMachine);
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT registerDHCPServer(DHCPServer *aDHCPServer,
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan HRESULT unregisterDHCPServer(DHCPServer *aDHCPServer,
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan struct Data; // opaque data structure, defined in VirtualBoxImpl.cpp
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan /* static variables (defined in VirtualBoxImpl.cpp) */
3744900be632496920d4c9aca8f94ba6db4dd882Dirk Hogan static DECLCALLBACK(int) ClientWatcher (RTTHREAD thread, void *pvUser);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan static DECLCALLBACK(int) AsyncEventHandler (RTTHREAD thread, void *pvUser);
61ea54c309169801a1833f99729723071c24c047Dirk Hogan static DECLCALLBACK(int) SVCHelperClientThread (RTTHREAD aThread, void *aUser);
45e9f4e13faca91c1a0f87ef805933e155cf3ae6Dirk Hogan////////////////////////////////////////////////////////////////////////////////
61ea54c309169801a1833f99729723071c24c047Dirk Hogan#endif // !____H_VIRTUALBOXIMPL