VirtualBox

source: vbox/trunk/src/VBox/Main/include/VirtualBoxImpl.h@ 37244

最後變更 在這個檔案從37244是 37244,由 vboxsync 提交於 14 年 前

Main/VirtualBox: new method for querying the API version
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 12.6 KB
行 
1/* $Id: VirtualBoxImpl.h 37244 2011-05-30 08:28:07Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2011 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.alldomusa.eu.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef ____H_VIRTUALBOXIMPL
19#define ____H_VIRTUALBOXIMPL
20
21#include "VirtualBoxBase.h"
22
23#ifdef RT_OS_WINDOWS
24# include "win/resource.h"
25#endif
26
27namespace com
28{
29 class Event;
30 class EventQueue;
31}
32
33class SessionMachine;
34class GuestOSType;
35class SharedFolder;
36class Progress;
37class Host;
38class SystemProperties;
39class DHCPServer;
40class PerformanceCollector;
41class VirtualBoxCallbackRegistration; /* see VirtualBoxImpl.cpp */
42#ifdef VBOX_WITH_EXTPACK
43class ExtPackManager;
44#endif
45
46typedef std::list< ComObjPtr<SessionMachine> > SessionMachinesList;
47
48#ifdef RT_OS_WINDOWS
49class SVCHlpClient;
50#endif
51
52struct VMClientWatcherData;
53
54namespace settings
55{
56 class MainConfigFile;
57 struct MediaRegistry;
58}
59class ATL_NO_VTABLE VirtualBox :
60 public VirtualBoxBase,
61 VBOX_SCRIPTABLE_IMPL(IVirtualBox)
62#ifdef RT_OS_WINDOWS
63 , public CComCoClass<VirtualBox, &CLSID_VirtualBox>
64#endif
65{
66
67public:
68
69 typedef std::list< ComPtr<IInternalSessionControl> > InternalControlList;
70
71 class CallbackEvent;
72 friend class CallbackEvent;
73
74 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VirtualBox, IVirtualBox)
75
76 DECLARE_CLASSFACTORY_SINGLETON(VirtualBox)
77
78 DECLARE_REGISTRY_RESOURCEID(IDR_VIRTUALBOX)
79 DECLARE_NOT_AGGREGATABLE(VirtualBox)
80
81 DECLARE_PROTECT_FINAL_CONSTRUCT()
82
83 BEGIN_COM_MAP(VirtualBox)
84 VBOX_DEFAULT_INTERFACE_ENTRIES(IVirtualBox)
85 END_COM_MAP()
86
87 // to postpone generation of the default ctor/dtor
88 VirtualBox();
89 ~VirtualBox();
90
91 HRESULT FinalConstruct();
92 void FinalRelease();
93
94 /* public initializer/uninitializer for internal purposes only */
95 HRESULT init();
96 HRESULT initMachines();
97 HRESULT initMedia(const Guid &uuidMachineRegistry,
98 const settings::MediaRegistry mediaRegistry,
99 const Utf8Str &strMachineFolder);
100 void uninit();
101
102 /* IVirtualBox properties */
103 STDMETHOD(COMGETTER(Version)) (BSTR *aVersion);
104 STDMETHOD(COMGETTER(Revision)) (ULONG *aRevision);
105 STDMETHOD(COMGETTER(PackageType)) (BSTR *aPackageType);
106 STDMETHOD(COMGETTER(APIVersion)) (BSTR *aAPIVersion);
107 STDMETHOD(COMGETTER(HomeFolder)) (BSTR *aHomeFolder);
108 STDMETHOD(COMGETTER(SettingsFilePath)) (BSTR *aSettingsFilePath);
109 STDMETHOD(COMGETTER(Host)) (IHost **aHost);
110 STDMETHOD(COMGETTER(SystemProperties)) (ISystemProperties **aSystemProperties);
111 STDMETHOD(COMGETTER(Machines)) (ComSafeArrayOut(IMachine *, aMachines));
112 STDMETHOD(COMGETTER(HardDisks)) (ComSafeArrayOut(IMedium *, aHardDisks));
113 STDMETHOD(COMGETTER(DVDImages)) (ComSafeArrayOut(IMedium *, aDVDImages));
114 STDMETHOD(COMGETTER(FloppyImages)) (ComSafeArrayOut(IMedium *, aFloppyImages));
115 STDMETHOD(COMGETTER(ProgressOperations)) (ComSafeArrayOut(IProgress *, aOperations));
116 STDMETHOD(COMGETTER(GuestOSTypes)) (ComSafeArrayOut(IGuestOSType *, aGuestOSTypes));
117 STDMETHOD(COMGETTER(SharedFolders)) (ComSafeArrayOut(ISharedFolder *, aSharedFolders));
118 STDMETHOD(COMGETTER(PerformanceCollector)) (IPerformanceCollector **aPerformanceCollector);
119 STDMETHOD(COMGETTER(DHCPServers)) (ComSafeArrayOut(IDHCPServer *, aDHCPServers));
120 STDMETHOD(COMGETTER(EventSource)) (IEventSource ** aEventSource);
121 STDMETHOD(COMGETTER(ExtensionPackManager)) (IExtPackManager **aExtPackManager);
122
123 /* IVirtualBox methods */
124 STDMETHOD(ComposeMachineFilename) (IN_BSTR aName, IN_BSTR aBaseFolder, BSTR *aFilename);
125 STDMETHOD(CreateMachine) (IN_BSTR aSettingsFile,
126 IN_BSTR aName,
127 IN_BSTR aOsTypeId,
128 IN_BSTR aId,
129 BOOL forceOverwrite,
130 IMachine **aMachine);
131 STDMETHOD(OpenMachine) (IN_BSTR aSettingsFile, IMachine **aMachine);
132 STDMETHOD(RegisterMachine) (IMachine *aMachine);
133 STDMETHOD(FindMachine) (IN_BSTR aNameOrId, IMachine **aMachine);
134 STDMETHOD(CreateAppliance) (IAppliance **anAppliance);
135
136 STDMETHOD(CreateHardDisk)(IN_BSTR aFormat,
137 IN_BSTR aLocation,
138 IMedium **aHardDisk);
139 STDMETHOD(OpenMedium)(IN_BSTR aLocation,
140 DeviceType_T deviceType,
141 AccessMode_T accessMode,
142 IMedium **aMedium);
143 STDMETHOD(FindMedium)(IN_BSTR aLocation,
144 DeviceType_T deviceType,
145 IMedium **aMedium);
146
147 STDMETHOD(GetGuestOSType) (IN_BSTR aId, IGuestOSType **aType);
148 STDMETHOD(CreateSharedFolder) (IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
149 STDMETHOD(RemoveSharedFolder) (IN_BSTR aName);
150 STDMETHOD(GetExtraDataKeys) (ComSafeArrayOut(BSTR, aKeys));
151 STDMETHOD(GetExtraData) (IN_BSTR aKey, BSTR *aValue);
152 STDMETHOD(SetExtraData) (IN_BSTR aKey, IN_BSTR aValue);
153
154 STDMETHOD(CreateDHCPServer) (IN_BSTR aName, IDHCPServer ** aServer);
155 STDMETHOD(FindDHCPServerByNetworkName) (IN_BSTR aName, IDHCPServer ** aServer);
156 STDMETHOD(RemoveDHCPServer) (IDHCPServer * aServer);
157 STDMETHOD(CheckFirmwarePresent)(FirmwareType_T aFirmwareType, IN_BSTR aVersion,
158 BSTR * aUrl, BSTR * aFile, BOOL * aResult);
159
160 /* public methods only for internal purposes */
161
162 /**
163 * Override of the default locking class to be used for validating lock
164 * order with the standard member lock handle.
165 */
166 virtual VBoxLockingClass getLockingClass() const
167 {
168 return LOCKCLASS_VIRTUALBOXOBJECT;
169 }
170
171#ifdef DEBUG
172 void dumpAllBackRefs();
173#endif
174
175 HRESULT postEvent(Event *event);
176
177 HRESULT addProgress(IProgress *aProgress);
178 HRESULT removeProgress(IN_GUID aId);
179
180#ifdef RT_OS_WINDOWS
181 typedef DECLCALLBACKPTR (HRESULT, SVCHelperClientFunc)
182 (SVCHlpClient *aClient, Progress *aProgress, void *aUser, int *aVrc);
183 HRESULT startSVCHelperClient(bool aPrivileged,
184 SVCHelperClientFunc aFunc,
185 void *aUser, Progress *aProgress);
186#endif
187
188 void addProcessToReap (RTPROCESS pid);
189 void updateClientWatcher();
190
191 void onMachineStateChange(const Guid &aId, MachineState_T aState);
192 void onMachineDataChange(const Guid &aId);
193 BOOL onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
194 Bstr &aError);
195 void onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue);
196 void onMachineRegistered(const Guid &aId, BOOL aRegistered);
197 void onSessionStateChange(const Guid &aId, SessionState_T aState);
198
199 void onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId);
200 void onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId);
201 void onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId);
202 void onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName, IN_BSTR aValue,
203 IN_BSTR aFlags);
204 void onMachineUninit(Machine *aMachine);
205 void onNatRedirectChange(const Guid &aMachineId, ULONG ulSlot, bool fRemove, IN_BSTR aName,
206 NATProtocol_T aProto, IN_BSTR aHostIp, uint16_t aHostPort,
207 IN_BSTR aGuestIp, uint16_t aGuestPort);
208
209 ComObjPtr<GuestOSType> getUnknownOSType();
210
211 void getOpenedMachines(SessionMachinesList &aMachines,
212 InternalControlList *aControls = NULL);
213
214 HRESULT findMachine(const Guid &aId,
215 bool fPermitInaccessible,
216 bool aSetError,
217 ComObjPtr<Machine> *machine = NULL);
218
219 HRESULT findHardDiskById(const Guid &id,
220 bool aSetError,
221 ComObjPtr<Medium> *aHardDisk = NULL);
222 HRESULT findHardDiskByLocation(const Utf8Str &strLocation,
223 bool aSetError,
224 ComObjPtr<Medium> *aHardDisk = NULL);
225 HRESULT findDVDOrFloppyImage(DeviceType_T mediumType,
226 const Guid *aId,
227 const Utf8Str &aLocation,
228 bool aSetError,
229 ComObjPtr<Medium> *aImage = NULL);
230 HRESULT findRemoveableMedium(DeviceType_T mediumType,
231 const Guid &uuid,
232 bool fRefresh,
233 bool aSetError,
234 ComObjPtr<Medium> &pMedium);
235
236 HRESULT findGuestOSType(const Bstr &bstrOSType,
237 GuestOSType*& pGuestOSType);
238
239 const Guid& getGlobalRegistryId() const;
240
241 const ComObjPtr<Host>& host() const;
242 SystemProperties* getSystemProperties() const;
243#ifdef VBOX_WITH_EXTPACK
244 ExtPackManager* getExtPackManager() const;
245#endif
246#ifdef VBOX_WITH_RESOURCE_USAGE_API
247 const ComObjPtr<PerformanceCollector>& performanceCollector() const;
248#endif /* VBOX_WITH_RESOURCE_USAGE_API */
249
250 void getDefaultMachineFolder(Utf8Str &str) const;
251 void getDefaultHardDiskFormat(Utf8Str &str) const;
252
253 /** Returns the VirtualBox home directory */
254 const Utf8Str& homeDir() const;
255
256 int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
257 void copyPathRelativeToConfig(const Utf8Str &strSource, Utf8Str &strTarget);
258
259 HRESULT registerHardDisk(Medium *aHardDisk, GuidList *pllRegistriesThatNeedSaving);
260 HRESULT unregisterHardDisk(Medium *aHardDisk, GuidList *pllRegistriesThatNeedSaving);
261
262 HRESULT registerImage(Medium *aImage, DeviceType_T argType, GuidList *pllRegistriesThatNeedSaving);
263 HRESULT unregisterImage(Medium *aImage, DeviceType_T argType, GuidList *pllRegistriesThatNeedSaving);
264
265 void pushMediumToListWithChildren(MediaList &llMedia, Medium *pMedium);
266 HRESULT unregisterMachineMedia(const Guid &id);
267
268 HRESULT unregisterMachine(Machine *pMachine, const Guid &id);
269
270 void rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
271 const Utf8Str &strNewConfigDir);
272
273 void saveMediaRegistry(settings::MediaRegistry &mediaRegistry,
274 const Guid &uuidRegistry,
275 const Utf8Str &strMachineFolder);
276 HRESULT saveSettings();
277
278 void addGuidToListUniquely(GuidList &llRegistriesThatNeedSaving, const Guid &uuid);
279 HRESULT saveRegistries(const GuidList &llRegistriesThatNeedSaving);
280
281 static HRESULT ensureFilePathExists(const Utf8Str &strFileName);
282
283 static HRESULT handleUnexpectedExceptions (RT_SRC_POS_DECL);
284
285 const Utf8Str& settingsFilePath();
286
287 RWLockHandle& getMediaTreeLockHandle();
288
289private:
290
291 static HRESULT setErrorStatic(HRESULT aResultCode,
292 const Utf8Str &aText)
293 {
294 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
295 }
296
297 HRESULT checkMediaForConflicts(const Guid &aId,
298 const Utf8Str &aLocation,
299 Utf8Str &aConflictType,
300 bool &fIdentical);
301
302 HRESULT registerMachine(Machine *aMachine);
303
304 HRESULT registerDHCPServer(DHCPServer *aDHCPServer,
305 bool aSaveRegistry = true);
306 HRESULT unregisterDHCPServer(DHCPServer *aDHCPServer,
307 bool aSaveRegistry = true);
308
309 struct Data; // opaque data structure, defined in VirtualBoxImpl.cpp
310 Data *m;
311
312 /* static variables (defined in VirtualBoxImpl.cpp) */
313 static Bstr sVersion;
314 static ULONG sRevision;
315 static Bstr sPackageType;
316 static Bstr sAPIVersion;
317
318 static DECLCALLBACK(int) ClientWatcher (RTTHREAD thread, void *pvUser);
319 static DECLCALLBACK(int) AsyncEventHandler (RTTHREAD thread, void *pvUser);
320
321#ifdef RT_OS_WINDOWS
322 static DECLCALLBACK(int) SVCHelperClientThread (RTTHREAD aThread, void *aUser);
323#endif
324};
325
326////////////////////////////////////////////////////////////////////////////////
327
328#endif // !____H_VIRTUALBOXIMPL
329
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette