VirtualBox

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

Last change on this file since 41105 was 41105, checked in by vboxsync, 13 years ago

use openMedium instead of findMedium
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.5 KB
Line 
1/* $Id: VirtualBoxImpl.h 41105 2012-05-01 18:14:46Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2012 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.215389.xyz. 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 STDMETHOD(COMGETTER(InternalNetworks))(ComSafeArrayOut(BSTR, aInternalNetworks));
123 STDMETHOD(COMGETTER(GenericNetworkDrivers))(ComSafeArrayOut(BSTR, aGenericNetworkDrivers));
124
125 /* IVirtualBox methods */
126 STDMETHOD(ComposeMachineFilename)(IN_BSTR aName, IN_BSTR aBaseFolder, BSTR *aFilename);
127 STDMETHOD(CreateMachine)(IN_BSTR aSettingsFile,
128 IN_BSTR aName,
129 IN_BSTR aOsTypeId,
130 IN_BSTR aId,
131 BOOL forceOverwrite,
132 IMachine **aMachine);
133 STDMETHOD(OpenMachine)(IN_BSTR aSettingsFile, IMachine **aMachine);
134 STDMETHOD(RegisterMachine)(IMachine *aMachine);
135 STDMETHOD(FindMachine)(IN_BSTR aNameOrId, IMachine **aMachine);
136 STDMETHOD(GetMachineStates)(ComSafeArrayIn(IMachine *, aMachines), ComSafeArrayOut(MachineState_T, aStates));
137 STDMETHOD(CreateAppliance)(IAppliance **anAppliance);
138
139 STDMETHOD(CreateHardDisk)(IN_BSTR aFormat,
140 IN_BSTR aLocation,
141 IMedium **aHardDisk);
142 STDMETHOD(OpenMedium)(IN_BSTR aLocation,
143 DeviceType_T deviceType,
144 AccessMode_T accessMode,
145 BOOL fForceNewUuid,
146 IMedium **aMedium);
147#if 0 // Remove def of fineMedium
148 STDMETHOD(FindMedium)(IN_BSTR aLocation,
149 DeviceType_T deviceType,
150 IMedium **aMedium);
151#endif
152
153 STDMETHOD(GetGuestOSType)(IN_BSTR aId, IGuestOSType **aType);
154 STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
155 STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);
156 STDMETHOD(GetExtraDataKeys)(ComSafeArrayOut(BSTR, aKeys));
157 STDMETHOD(GetExtraData)(IN_BSTR aKey, BSTR *aValue);
158 STDMETHOD(SetExtraData)(IN_BSTR aKey, IN_BSTR aValue);
159
160 STDMETHOD(CreateDHCPServer)(IN_BSTR aName, IDHCPServer ** aServer);
161 STDMETHOD(FindDHCPServerByNetworkName)(IN_BSTR aName, IDHCPServer ** aServer);
162 STDMETHOD(RemoveDHCPServer)(IDHCPServer * aServer);
163 STDMETHOD(CheckFirmwarePresent)(FirmwareType_T aFirmwareType, IN_BSTR aVersion,
164 BSTR * aUrl, BSTR * aFile, BOOL * aResult);
165
166 /* public methods only for internal purposes */
167
168 /**
169 * Override of the default locking class to be used for validating lock
170 * order with the standard member lock handle.
171 */
172 virtual VBoxLockingClass getLockingClass() const
173 {
174 return LOCKCLASS_VIRTUALBOXOBJECT;
175 }
176
177#ifdef DEBUG
178 void dumpAllBackRefs();
179#endif
180
181 HRESULT postEvent(Event *event);
182
183 HRESULT addProgress(IProgress *aProgress);
184 HRESULT removeProgress(IN_GUID aId);
185
186#ifdef RT_OS_WINDOWS
187 typedef DECLCALLBACKPTR(HRESULT, SVCHelperClientFunc)
188 (SVCHlpClient *aClient, Progress *aProgress, void *aUser, int *aVrc);
189 HRESULT startSVCHelperClient(bool aPrivileged,
190 SVCHelperClientFunc aFunc,
191 void *aUser, Progress *aProgress);
192#endif
193
194 void addProcessToReap(RTPROCESS pid);
195 void updateClientWatcher();
196
197 void onMachineStateChange(const Guid &aId, MachineState_T aState);
198 void onMachineDataChange(const Guid &aId, BOOL aTemporary = FALSE);
199 BOOL onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
200 Bstr &aError);
201 void onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue);
202 void onMachineRegistered(const Guid &aId, BOOL aRegistered);
203 void onSessionStateChange(const Guid &aId, SessionState_T aState);
204
205 void onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId);
206 void onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId);
207 void onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId);
208 void onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName, IN_BSTR aValue,
209 IN_BSTR aFlags);
210 void onMachineUninit(Machine *aMachine);
211 void onNatRedirectChange(const Guid &aMachineId, ULONG ulSlot, bool fRemove, IN_BSTR aName,
212 NATProtocol_T aProto, IN_BSTR aHostIp, uint16_t aHostPort,
213 IN_BSTR aGuestIp, uint16_t aGuestPort);
214
215 ComObjPtr<GuestOSType> getUnknownOSType();
216
217 void getOpenedMachines(SessionMachinesList &aMachines,
218 InternalControlList *aControls = NULL);
219
220 HRESULT findMachine(const Guid &aId,
221 bool fPermitInaccessible,
222 bool aSetError,
223 ComObjPtr<Machine> *machine = NULL);
224
225 HRESULT findHardDiskById(const Guid &id,
226 bool aSetError,
227 ComObjPtr<Medium> *aHardDisk = NULL);
228 HRESULT findHardDiskByLocation(const Utf8Str &strLocation,
229 bool aSetError,
230 ComObjPtr<Medium> *aHardDisk = NULL);
231 HRESULT findDVDOrFloppyImage(DeviceType_T mediumType,
232 const Guid *aId,
233 const Utf8Str &aLocation,
234 bool aSetError,
235 ComObjPtr<Medium> *aImage = NULL);
236 HRESULT findRemoveableMedium(DeviceType_T mediumType,
237 const Guid &uuid,
238 bool fRefresh,
239 bool aSetError,
240 ComObjPtr<Medium> &pMedium);
241
242 HRESULT findGuestOSType(const Bstr &bstrOSType,
243 GuestOSType*& pGuestOSType);
244
245 const Guid& getGlobalRegistryId() const;
246
247 const ComObjPtr<Host>& host() const;
248 SystemProperties* getSystemProperties() const;
249#ifdef VBOX_WITH_EXTPACK
250 ExtPackManager* getExtPackManager() const;
251#endif
252#ifdef VBOX_WITH_RESOURCE_USAGE_API
253 const ComObjPtr<PerformanceCollector>& performanceCollector() const;
254#endif /* VBOX_WITH_RESOURCE_USAGE_API */
255
256 void getDefaultMachineFolder(Utf8Str &str) const;
257 void getDefaultHardDiskFormat(Utf8Str &str) const;
258
259 /** Returns the VirtualBox home directory */
260 const Utf8Str& homeDir() const;
261
262 int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
263 void copyPathRelativeToConfig(const Utf8Str &strSource, Utf8Str &strTarget);
264
265 HRESULT registerMedium(const ComObjPtr<Medium> &pMedium, ComObjPtr<Medium> *ppMedium, DeviceType_T argType);
266 HRESULT unregisterMedium(Medium *pMedium);
267
268 void pushMediumToListWithChildren(MediaList &llMedia, Medium *pMedium);
269 HRESULT unregisterMachineMedia(const Guid &id);
270
271 HRESULT unregisterMachine(Machine *pMachine, const Guid &id);
272
273 void rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
274 const Utf8Str &strNewConfigDir);
275
276 void saveMediaRegistry(settings::MediaRegistry &mediaRegistry,
277 const Guid &uuidRegistry,
278 const Utf8Str &strMachineFolder);
279 HRESULT saveSettings();
280
281 void markRegistryModified(const Guid &uuid);
282 void saveModifiedRegistries();
283
284 static HRESULT ensureFilePathExists(const Utf8Str &strFileName, bool fCreate);
285
286 static HRESULT handleUnexpectedExceptions(RT_SRC_POS_DECL);
287
288 const Utf8Str& settingsFilePath();
289
290 RWLockHandle& getMediaTreeLockHandle();
291
292private:
293
294 static HRESULT setErrorStatic(HRESULT aResultCode,
295 const Utf8Str &aText)
296 {
297 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
298 }
299
300 HRESULT checkMediaForConflicts(const Guid &aId,
301 const Utf8Str &aLocation,
302 Utf8Str &aConflictType,
303 ComObjPtr<Medium> *pDupMedium);
304
305 HRESULT registerMachine(Machine *aMachine);
306
307 HRESULT registerDHCPServer(DHCPServer *aDHCPServer,
308 bool aSaveRegistry = true);
309 HRESULT unregisterDHCPServer(DHCPServer *aDHCPServer,
310 bool aSaveRegistry = true);
311
312 struct Data; // opaque data structure, defined in VirtualBoxImpl.cpp
313 Data *m;
314
315 /* static variables (defined in VirtualBoxImpl.cpp) */
316 static Bstr sVersion;
317 static ULONG sRevision;
318 static Bstr sPackageType;
319 static Bstr sAPIVersion;
320
321 static DECLCALLBACK(int) ClientWatcher(RTTHREAD thread, void *pvUser);
322 static DECLCALLBACK(int) AsyncEventHandler(RTTHREAD thread, void *pvUser);
323
324#ifdef RT_OS_WINDOWS
325 static DECLCALLBACK(int) SVCHelperClientThread(RTTHREAD aThread, void *aUser);
326#endif
327};
328
329////////////////////////////////////////////////////////////////////////////////
330
331#endif // !____H_VIRTUALBOXIMPL
332
Note: See TracBrowser for help on using the repository browser.

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