VirtualBox

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

Last change on this file since 61644 was 60765, checked in by vboxsync, 9 years ago

API: stop using ATL and use a vastly smaller lookalike instead, plus a lot of cleanups
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.9 KB
Line 
1/* $Id: VirtualBoxImpl.h 60765 2016-04-29 14:26:58Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.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#include "objectslist.h"
23#include "VirtualBoxWrap.h"
24
25#ifdef RT_OS_WINDOWS
26# include "win/resource.h"
27#endif
28
29namespace com
30{
31 class Event;
32 class EventQueue;
33}
34
35class SessionMachine;
36class GuestOSType;
37class Progress;
38class Host;
39class SystemProperties;
40class DHCPServer;
41class PerformanceCollector;
42#ifdef VBOX_WITH_EXTPACK
43class ExtPackManager;
44#endif
45class AutostartDb;
46class NATNetwork;
47
48
49typedef std::list<ComObjPtr<SessionMachine> > SessionMachinesList;
50
51#ifdef RT_OS_WINDOWS
52class SVCHlpClient;
53#endif
54
55namespace settings
56{
57 class MainConfigFile;
58 struct MediaRegistry;
59}
60class ATL_NO_VTABLE VirtualBox :
61 public VirtualBoxWrap
62#ifdef RT_OS_WINDOWS
63 , public ATL::CComCoClass<VirtualBox, &CLSID_VirtualBox>
64#endif
65{
66
67public:
68
69 typedef std::list<ComPtr<IInternalSessionControl> > InternalControlList;
70 typedef ObjectsList<Machine> MachinesOList;
71
72 class CallbackEvent;
73 friend class CallbackEvent;
74
75 DECLARE_CLASSFACTORY_SINGLETON(VirtualBox)
76
77 // Do not use any ATL registry support.
78 //DECLARE_REGISTRY_RESOURCEID(IDR_VIRTUALBOX)
79
80 // Kind of redundant (VirtualBoxWrap declares itself not aggregatable and
81 // CComCoClass<VirtualBox, &CLSID_VirtualBox> as aggregatable, the former
82 // is the first inheritance), but the C++ multiple inheritance rules and
83 // the class factory in svcmain.cpp needs this to disambiguate.
84 DECLARE_NOT_AGGREGATABLE(VirtualBox)
85
86 // to postpone generation of the default ctor/dtor
87 DECLARE_EMPTY_CTOR_DTOR(VirtualBox)
88
89 HRESULT FinalConstruct();
90 void FinalRelease();
91
92 /* public initializer/uninitializer for internal purposes only */
93 HRESULT init();
94 HRESULT initMachines();
95 HRESULT initMedia(const Guid &uuidMachineRegistry,
96 const settings::MediaRegistry &mediaRegistry,
97 const Utf8Str &strMachineFolder);
98 void uninit();
99
100 /* public methods only for internal purposes */
101
102 /**
103 * Override of the default locking class to be used for validating lock
104 * order with the standard member lock handle.
105 */
106 virtual VBoxLockingClass getLockingClass() const
107 {
108 return LOCKCLASS_VIRTUALBOXOBJECT;
109 }
110
111#ifdef DEBUG
112 void i_dumpAllBackRefs();
113#endif
114
115 HRESULT i_postEvent(Event *event);
116
117 HRESULT i_addProgress(IProgress *aProgress);
118 HRESULT i_removeProgress(IN_GUID aId);
119
120#ifdef RT_OS_WINDOWS
121 typedef DECLCALLBACKPTR(HRESULT, SVCHelperClientFunc)
122 (SVCHlpClient *aClient, Progress *aProgress, void *aUser, int *aVrc);
123 HRESULT i_startSVCHelperClient(bool aPrivileged,
124 SVCHelperClientFunc aFunc,
125 void *aUser, Progress *aProgress);
126#endif
127
128 void i_addProcessToReap(RTPROCESS pid);
129 void i_updateClientWatcher();
130
131 int i_loadVDPlugin(const char *pszPluginLibrary);
132 int i_unloadVDPlugin(const char *pszPluginLibrary);
133
134 void i_onMachineStateChange(const Guid &aId, MachineState_T aState);
135 void i_onMachineDataChange(const Guid &aId, BOOL aTemporary = FALSE);
136 BOOL i_onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
137 Bstr &aError);
138 void i_onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue);
139 void i_onMachineRegistered(const Guid &aId, BOOL aRegistered);
140 void i_onSessionStateChange(const Guid &aId, SessionState_T aState);
141
142 void i_onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId);
143 void i_onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId);
144 void i_onSnapshotRestored(const Guid &aMachineId, const Guid &aSnapshotId);
145 void i_onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId);
146 void i_onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName, IN_BSTR aValue,
147 IN_BSTR aFlags);
148 void i_onNatRedirectChange(const Guid &aMachineId, ULONG ulSlot, bool fRemove, IN_BSTR aName,
149 NATProtocol_T aProto, IN_BSTR aHostIp, uint16_t aHostPort,
150 IN_BSTR aGuestIp, uint16_t aGuestPort);
151 void i_onNATNetworkChange(IN_BSTR aNetworkName);
152 void i_onNATNetworkStartStop(IN_BSTR aNetworkName, BOOL aStart);
153 void i_onNATNetworkSetting(IN_BSTR aNetworkName, BOOL aEnabled, IN_BSTR aNetwork,
154 IN_BSTR aGateway, BOOL aAdvertiseDefaultIpv6RouteEnabled,
155 BOOL fNeedDhcpServer);
156 void i_onNATNetworkPortForward(IN_BSTR aNetworkName, BOOL create, BOOL fIpv6,
157 IN_BSTR aRuleName, NATProtocol_T proto,
158 IN_BSTR aHostIp, LONG aHostPort,
159 IN_BSTR aGuestIp, LONG aGuestPort);
160 void i_onHostNameResolutionConfigurationChange();
161
162 int i_natNetworkRefInc(IN_BSTR aNetworkName);
163 int i_natNetworkRefDec(IN_BSTR aNetworkName);
164
165 ComObjPtr<GuestOSType> i_getUnknownOSType();
166
167 void i_getOpenedMachines(SessionMachinesList &aMachines,
168 InternalControlList *aControls = NULL);
169 MachinesOList &i_getMachinesList();
170
171 HRESULT i_findMachine(const Guid &aId,
172 bool fPermitInaccessible,
173 bool aSetError,
174 ComObjPtr<Machine> *aMachine = NULL);
175
176 HRESULT i_findMachineByName(const Utf8Str &aName,
177 bool aSetError,
178 ComObjPtr<Machine> *aMachine = NULL);
179
180 HRESULT i_validateMachineGroup(const Utf8Str &aGroup, bool fPrimary);
181 HRESULT i_convertMachineGroups(const std::vector<com::Utf8Str> aMachineGroups, StringsList *pllMachineGroups);
182
183 HRESULT i_findHardDiskById(const Guid &id,
184 bool aSetError,
185 ComObjPtr<Medium> *aHardDisk = NULL);
186 HRESULT i_findHardDiskByLocation(const Utf8Str &strLocation,
187 bool aSetError,
188 ComObjPtr<Medium> *aHardDisk = NULL);
189 HRESULT i_findDVDOrFloppyImage(DeviceType_T mediumType,
190 const Guid *aId,
191 const Utf8Str &aLocation,
192 bool aSetError,
193 ComObjPtr<Medium> *aImage = NULL);
194 HRESULT i_findRemoveableMedium(DeviceType_T mediumType,
195 const Guid &uuid,
196 bool fRefresh,
197 bool aSetError,
198 ComObjPtr<Medium> &pMedium);
199
200 HRESULT i_findGuestOSType(const Bstr &bstrOSType,
201 GuestOSType*& pGuestOSType);
202
203 const Guid &i_getGlobalRegistryId() const;
204
205 const ComObjPtr<Host>& i_host() const;
206 SystemProperties* i_getSystemProperties() const;
207#ifdef VBOX_WITH_EXTPACK
208 ExtPackManager* i_getExtPackManager() const;
209#endif
210#ifdef VBOX_WITH_RESOURCE_USAGE_API
211 const ComObjPtr<PerformanceCollector>& i_performanceCollector() const;
212#endif /* VBOX_WITH_RESOURCE_USAGE_API */
213
214 void i_getDefaultMachineFolder(Utf8Str &str) const;
215 void i_getDefaultHardDiskFormat(Utf8Str &str) const;
216
217 /** Returns the VirtualBox home directory */
218 const Utf8Str& i_homeDir() const;
219 int i_calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
220 void i_copyPathRelativeToConfig(const Utf8Str &strSource, Utf8Str &strTarget);
221 HRESULT i_registerMedium(const ComObjPtr<Medium> &pMedium, ComObjPtr<Medium> *ppMedium,
222 AutoWriteLock &mediaTreeLock);
223 HRESULT i_unregisterMedium(Medium *pMedium);
224 void i_pushMediumToListWithChildren(MediaList &llMedia, Medium *pMedium);
225 HRESULT i_unregisterMachineMedia(const Guid &id);
226 HRESULT i_unregisterMachine(Machine *pMachine, const Guid &id);
227 void i_rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
228 const Utf8Str &strNewConfigDir);
229 void i_saveMediaRegistry(settings::MediaRegistry &mediaRegistry,
230 const Guid &uuidRegistry,
231 const Utf8Str &strMachineFolder);
232 HRESULT i_saveSettings();
233 void i_markRegistryModified(const Guid &uuid);
234 void i_unmarkRegistryModified(const Guid &uuid);
235 void i_saveModifiedRegistries();
236 static const com::Utf8Str &i_getVersionNormalized();
237 static HRESULT i_ensureFilePathExists(const Utf8Str &strFileName, bool fCreate);
238 const Utf8Str& i_settingsFilePath();
239 AutostartDb* i_getAutostartDb() const;
240 RWLockHandle& i_getMachinesListLockHandle();
241 RWLockHandle& i_getMediaTreeLockHandle();
242 int i_encryptSetting(const Utf8Str &aPlaintext, Utf8Str *aCiphertext);
243 int i_decryptSetting(Utf8Str *aPlaintext, const Utf8Str &aCiphertext);
244 void i_storeSettingsKey(const Utf8Str &aKey);
245 bool i_isMediaUuidInUse(const Guid &aId, DeviceType_T deviceType);
246
247
248
249private:
250 class ClientWatcher;
251
252 // wrapped IVirtualBox properties
253 HRESULT getVersion(com::Utf8Str &aVersion);
254 HRESULT getVersionNormalized(com::Utf8Str &aVersionNormalized);
255 HRESULT getRevision(ULONG *aRevision);
256 HRESULT getPackageType(com::Utf8Str &aPackageType);
257 HRESULT getAPIVersion(com::Utf8Str &aAPIVersion);
258 HRESULT getAPIRevision(LONG64 *aAPIRevision);
259 HRESULT getHomeFolder(com::Utf8Str &aHomeFolder);
260 HRESULT getSettingsFilePath(com::Utf8Str &aSettingsFilePath);
261 HRESULT getHost(ComPtr<IHost> &aHost);
262 HRESULT getSystemProperties(ComPtr<ISystemProperties> &aSystemProperties);
263 HRESULT getMachines(std::vector<ComPtr<IMachine> > &aMachines);
264 HRESULT getMachineGroups(std::vector<com::Utf8Str> &aMachineGroups);
265 HRESULT getHardDisks(std::vector<ComPtr<IMedium> > &aHardDisks);
266 HRESULT getDVDImages(std::vector<ComPtr<IMedium> > &aDVDImages);
267 HRESULT getFloppyImages(std::vector<ComPtr<IMedium> > &aFloppyImages);
268 HRESULT getProgressOperations(std::vector<ComPtr<IProgress> > &aProgressOperations);
269 HRESULT getGuestOSTypes(std::vector<ComPtr<IGuestOSType> > &aGuestOSTypes);
270 HRESULT getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders);
271 HRESULT getPerformanceCollector(ComPtr<IPerformanceCollector> &aPerformanceCollector);
272 HRESULT getDHCPServers(std::vector<ComPtr<IDHCPServer> > &aDHCPServers);
273 HRESULT getNATNetworks(std::vector<ComPtr<INATNetwork> > &aNATNetworks);
274 HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
275 HRESULT getExtensionPackManager(ComPtr<IExtPackManager> &aExtensionPackManager);
276 HRESULT getInternalNetworks(std::vector<com::Utf8Str> &aInternalNetworks);
277 HRESULT getGenericNetworkDrivers(std::vector<com::Utf8Str> &aGenericNetworkDrivers);
278
279 // wrapped IVirtualBox methods
280 HRESULT composeMachineFilename(const com::Utf8Str &aName,
281 const com::Utf8Str &aGroup,
282 const com::Utf8Str &aCreateFlags,
283 const com::Utf8Str &aBaseFolder,
284 com::Utf8Str &aFile);
285 HRESULT createMachine(const com::Utf8Str &aSettingsFile,
286 const com::Utf8Str &aName,
287 const std::vector<com::Utf8Str> &aGroups,
288 const com::Utf8Str &aOsTypeId,
289 const com::Utf8Str &aFlags,
290 ComPtr<IMachine> &aMachine);
291 HRESULT openMachine(const com::Utf8Str &aSettingsFile,
292 ComPtr<IMachine> &aMachine);
293 HRESULT registerMachine(const ComPtr<IMachine> &aMachine);
294 HRESULT findMachine(const com::Utf8Str &aNameOrId,
295 ComPtr<IMachine> &aMachine);
296 HRESULT getMachinesByGroups(const std::vector<com::Utf8Str> &aGroups,
297 std::vector<ComPtr<IMachine> > &aMachines);
298 HRESULT getMachineStates(const std::vector<ComPtr<IMachine> > &aMachines,
299 std::vector<MachineState_T> &aStates);
300 HRESULT createAppliance(ComPtr<IAppliance> &aAppliance);
301 HRESULT createMedium(const com::Utf8Str &aFormat,
302 const com::Utf8Str &aLocation,
303 AccessMode_T aAccessMode,
304 DeviceType_T aDeviceType,
305 ComPtr<IMedium> &aMedium);
306 HRESULT openMedium(const com::Utf8Str &aLocation,
307 DeviceType_T aDeviceType,
308 AccessMode_T aAccessMode,
309 BOOL aForceNewUuid,
310 ComPtr<IMedium> &aMedium);
311 HRESULT getGuestOSType(const com::Utf8Str &aId,
312 ComPtr<IGuestOSType> &aType);
313 HRESULT createSharedFolder(const com::Utf8Str &aName,
314 const com::Utf8Str &aHostPath,
315 BOOL aWritable,
316 BOOL aAutomount);
317 HRESULT removeSharedFolder(const com::Utf8Str &aName);
318 HRESULT getExtraDataKeys(std::vector<com::Utf8Str> &aKeys);
319 HRESULT getExtraData(const com::Utf8Str &aKey,
320 com::Utf8Str &aValue);
321 HRESULT setExtraData(const com::Utf8Str &aKey,
322 const com::Utf8Str &aValue);
323 HRESULT setSettingsSecret(const com::Utf8Str &aPassword);
324 HRESULT createDHCPServer(const com::Utf8Str &aName,
325 ComPtr<IDHCPServer> &aServer);
326 HRESULT findDHCPServerByNetworkName(const com::Utf8Str &aName,
327 ComPtr<IDHCPServer> &aServer);
328 HRESULT removeDHCPServer(const ComPtr<IDHCPServer> &aServer);
329 HRESULT createNATNetwork(const com::Utf8Str &aNetworkName,
330 ComPtr<INATNetwork> &aNetwork);
331 HRESULT findNATNetworkByName(const com::Utf8Str &aNetworkName,
332 ComPtr<INATNetwork> &aNetwork);
333 HRESULT removeNATNetwork(const ComPtr<INATNetwork> &aNetwork);
334 HRESULT checkFirmwarePresent(FirmwareType_T aFirmwareType,
335 const com::Utf8Str &aVersion,
336 com::Utf8Str &aUrl,
337 com::Utf8Str &aFile,
338 BOOL *aResult);
339
340 static HRESULT i_setErrorStatic(HRESULT aResultCode,
341 const Utf8Str &aText)
342 {
343 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
344 }
345
346 HRESULT i_registerMachine(Machine *aMachine);
347 HRESULT i_registerDHCPServer(DHCPServer *aDHCPServer,
348 bool aSaveRegistry = true);
349 HRESULT i_unregisterDHCPServer(DHCPServer *aDHCPServer);
350 HRESULT i_registerNATNetwork(NATNetwork *aNATNetwork,
351 bool aSaveRegistry = true);
352 HRESULT i_unregisterNATNetwork(NATNetwork *aNATNetwork,
353 bool aSaveRegistry = true);
354 HRESULT i_checkMediaForConflicts(const Guid &aId,
355 const Utf8Str &aLocation,
356 Utf8Str &aConflictType,
357 ComObjPtr<Medium> *pDupMedium);
358 int i_decryptSettings();
359 int i_decryptMediumSettings(Medium *pMedium);
360 int i_decryptSettingBytes(uint8_t *aPlaintext,
361 const uint8_t *aCiphertext,
362 size_t aCiphertextSize) const;
363 int i_encryptSettingBytes(const uint8_t *aPlaintext,
364 uint8_t *aCiphertext,
365 size_t aPlaintextSize,
366 size_t aCiphertextSize) const;
367 void i_reportDriverVersions(void);
368
369 struct Data; // opaque data structure, defined in VirtualBoxImpl.cpp
370
371 Data *m;
372
373 /* static variables (defined in VirtualBoxImpl.cpp) */
374 static com::Utf8Str sVersion;
375 static com::Utf8Str sVersionNormalized;
376 static ULONG sRevision;
377 static com::Utf8Str sPackageType;
378 static com::Utf8Str sAPIVersion;
379 static std::map<com::Utf8Str, int> sNatNetworkNameToRefCount;
380 static RWLockHandle* spMtxNatNetworkNameToRefCountLock;
381
382 static DECLCALLBACK(int) AsyncEventHandler(RTTHREAD thread, void *pvUser);
383
384#ifdef RT_OS_WINDOWS
385 friend class StartSVCHelperClientData;
386 static DECLCALLBACK(int) SVCHelperClientThread(RTTHREAD aThread, void *aUser);
387#endif
388
389};
390
391////////////////////////////////////////////////////////////////////////////////
392
393#endif // !____H_VIRTUALBOXIMPL
394
Note: See TracBrowser for help on using the repository browser.

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