VirtualBox

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

Last change on this file since 87093 was 86908, checked in by vboxsync, 4 years ago

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