VirtualBox

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

Last change on this file since 30067 was 29925, checked in by vboxsync, 15 years ago

OVF: respect override of import parameters (setFinalValues) also when vbox:Machine is present, first batch (everything except storage)
  • 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 29925 2010-05-31 18:33:15Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation
6 */
7
8/*
9 * Copyright (C) 2006-2010 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20#ifndef ____H_VIRTUALBOXIMPL
21#define ____H_VIRTUALBOXIMPL
22
23#include "VirtualBoxBase.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 SharedFolder;
38class Progress;
39class Host;
40class SystemProperties;
41class DHCPServer;
42class PerformanceCollector;
43class VirtualBoxCallbackRegistration; /* see VirtualBoxImpl.cpp */
44
45typedef std::list< ComObjPtr<SessionMachine> > SessionMachinesList;
46
47#ifdef RT_OS_WINDOWS
48class SVCHlpClient;
49#endif
50
51struct VMClientWatcherData;
52
53namespace settings
54{
55 class MainConfigFile;
56}
57
58class ATL_NO_VTABLE VirtualBox :
59 public VirtualBoxBase,
60 public VirtualBoxSupportErrorInfoImpl<VirtualBox, IVirtualBox>,
61 public VirtualBoxSupportTranslation<VirtualBox>,
62 VBOX_SCRIPTABLE_IMPL(IVirtualBox)
63#ifdef RT_OS_WINDOWS
64 , public CComCoClass<VirtualBox, &CLSID_VirtualBox>
65 , public IConnectionPointContainerImpl<VirtualBox>
66 , public IConnectionPointImpl<VirtualBox, &IID_IVirtualBoxCallback, CComDynamicUnkArray>
67#endif
68{
69
70public:
71
72 typedef std::list< VirtualBoxCallbackRegistration > CallbackList;
73 typedef std::list< ComPtr<IInternalSessionControl> > InternalControlList;
74
75 class CallbackEvent;
76 friend class CallbackEvent;
77
78 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VirtualBox)
79
80 DECLARE_CLASSFACTORY_SINGLETON(VirtualBox)
81
82 DECLARE_REGISTRY_RESOURCEID(IDR_VIRTUALBOX)
83 DECLARE_NOT_AGGREGATABLE(VirtualBox)
84
85 DECLARE_PROTECT_FINAL_CONSTRUCT()
86
87 BEGIN_COM_MAP(VirtualBox)
88 COM_INTERFACE_ENTRY2(IDispatch, IVirtualBox)
89 COM_INTERFACE_ENTRY(ISupportErrorInfo)
90 COM_INTERFACE_ENTRY(IVirtualBox)
91 COM_INTERFACE_ENTRY(IConnectionPointContainer)
92 END_COM_MAP()
93
94#ifdef RT_OS_WINDOWS
95 BEGIN_CONNECTION_POINT_MAP(VirtualBox)
96 CONNECTION_POINT_ENTRY(IID_IVirtualBoxCallback)
97 END_CONNECTION_POINT_MAP()
98#endif
99
100 // to postpone generation of the default ctor/dtor
101 VirtualBox();
102 ~VirtualBox();
103
104 HRESULT FinalConstruct();
105 void FinalRelease();
106
107 /* public initializer/uninitializer for internal purposes only */
108 HRESULT init();
109 HRESULT initMachines();
110 HRESULT initMedia();
111 void uninit();
112
113 /* IVirtualBox properties */
114 STDMETHOD(COMGETTER(Version)) (BSTR *aVersion);
115 STDMETHOD(COMGETTER(Revision)) (ULONG *aRevision);
116 STDMETHOD(COMGETTER(PackageType)) (BSTR *aPackageType);
117 STDMETHOD(COMGETTER(HomeFolder)) (BSTR *aHomeFolder);
118 STDMETHOD(COMGETTER(SettingsFilePath)) (BSTR *aSettingsFilePath);
119 STDMETHOD(COMGETTER(Host)) (IHost **aHost);
120 STDMETHOD(COMGETTER(SystemProperties)) (ISystemProperties **aSystemProperties);
121 STDMETHOD(COMGETTER(Machines)) (ComSafeArrayOut (IMachine *, aMachines));
122 STDMETHOD(COMGETTER(HardDisks)) (ComSafeArrayOut (IMedium *, aHardDisks));
123 STDMETHOD(COMGETTER(DVDImages)) (ComSafeArrayOut (IMedium *, aDVDImages));
124 STDMETHOD(COMGETTER(FloppyImages)) (ComSafeArrayOut (IMedium *, aFloppyImages));
125 STDMETHOD(COMGETTER(ProgressOperations)) (ComSafeArrayOut (IProgress *, aOperations));
126 STDMETHOD(COMGETTER(GuestOSTypes)) (ComSafeArrayOut (IGuestOSType *, aGuestOSTypes));
127 STDMETHOD(COMGETTER(SharedFolders)) (ComSafeArrayOut (ISharedFolder *, aSharedFolders));
128 STDMETHOD(COMGETTER(PerformanceCollector)) (IPerformanceCollector **aPerformanceCollector);
129 STDMETHOD(COMGETTER(DHCPServers)) (ComSafeArrayOut (IDHCPServer *, aDHCPServers));
130
131 /* IVirtualBox methods */
132
133 STDMETHOD(CreateMachine) (IN_BSTR aName, IN_BSTR aOsTypeId, IN_BSTR aBaseFolder,
134 IN_BSTR aId, BOOL aOverride, IMachine **aMachine);
135 STDMETHOD(CreateLegacyMachine) (IN_BSTR aName, IN_BSTR aOsTypeId, IN_BSTR aSettingsFile,
136 IN_BSTR aId, IMachine **aMachine);
137 STDMETHOD(OpenMachine) (IN_BSTR aSettingsFile, IMachine **aMachine);
138 STDMETHOD(RegisterMachine) (IMachine *aMachine);
139 STDMETHOD(GetMachine) (IN_BSTR aId, IMachine **aMachine);
140 STDMETHOD(FindMachine) (IN_BSTR aName, IMachine **aMachine);
141 STDMETHOD(UnregisterMachine) (IN_BSTR aId, IMachine **aMachine);
142 STDMETHOD(CreateAppliance) (IAppliance **anAppliance);
143
144 STDMETHOD(CreateHardDisk)(IN_BSTR aFormat, IN_BSTR aLocation,
145 IMedium **aHardDisk);
146 STDMETHOD(OpenHardDisk) (IN_BSTR aLocation, AccessMode_T accessMode,
147 BOOL aSetImageId, IN_BSTR aImageId,
148 BOOL aSetParentId, IN_BSTR aParentId,
149 IMedium **aHardDisk);
150 STDMETHOD(GetHardDisk) (IN_BSTR aId, IMedium **aHardDisk);
151 STDMETHOD(FindHardDisk) (IN_BSTR aLocation, IMedium **aHardDisk);
152
153 STDMETHOD(OpenDVDImage) (IN_BSTR aLocation, IN_BSTR aId,
154 IMedium **aDVDImage);
155 STDMETHOD(GetDVDImage) (IN_BSTR aId, IMedium **aDVDImage);
156 STDMETHOD(FindDVDImage) (IN_BSTR aLocation, IMedium **aDVDImage);
157
158 STDMETHOD(OpenFloppyImage) (IN_BSTR aLocation, IN_BSTR aId,
159 IMedium **aFloppyImage);
160 STDMETHOD(GetFloppyImage) (IN_BSTR aId, IMedium **aFloppyImage);
161 STDMETHOD(FindFloppyImage) (IN_BSTR aLocation, IMedium **aFloppyImage);
162
163 STDMETHOD(GetGuestOSType) (IN_BSTR aId, IGuestOSType **aType);
164 STDMETHOD(CreateSharedFolder) (IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable);
165 STDMETHOD(RemoveSharedFolder) (IN_BSTR aName);
166 STDMETHOD(GetExtraDataKeys) (ComSafeArrayOut(BSTR, aKeys));
167 STDMETHOD(GetExtraData) (IN_BSTR aKey, BSTR *aValue);
168 STDMETHOD(SetExtraData) (IN_BSTR aKey, IN_BSTR aValue);
169 STDMETHOD(OpenSession) (ISession *aSession, IN_BSTR aMachineId);
170 STDMETHOD(OpenRemoteSession) (ISession *aSession, IN_BSTR aMachineId,
171 IN_BSTR aType, IN_BSTR aEnvironment,
172 IProgress **aProgress);
173 STDMETHOD(OpenExistingSession) (ISession *aSession, IN_BSTR aMachineId);
174
175 STDMETHOD(RegisterCallback) (IVirtualBoxCallback *aCallback);
176 STDMETHOD(UnregisterCallback) (IVirtualBoxCallback *aCallback);
177
178 STDMETHOD(WaitForPropertyChange) (IN_BSTR aWhat, ULONG aTimeout,
179 BSTR *aChanged, BSTR *aValues);
180
181 STDMETHOD(CreateDHCPServer) (IN_BSTR aName, IDHCPServer ** aServer);
182 STDMETHOD(FindDHCPServerByNetworkName) (IN_BSTR aName, IDHCPServer ** aServer);
183 STDMETHOD(RemoveDHCPServer) (IDHCPServer * aServer);
184 STDMETHOD(CheckFirmwarePresent)(FirmwareType_T aFirmwareType, IN_BSTR aVersion,
185 BSTR * aUrl, BSTR * aFile, BOOL * aResult);
186
187 /* public methods only for internal purposes */
188
189 /**
190 * Simple run-time type identification without having to enable C++ RTTI.
191 * The class IDs are defined in VirtualBoxBase.h.
192 * @return
193 */
194 virtual VBoxClsID getClassID() const
195 {
196 return clsidVirtualBox;
197 }
198
199 /**
200 * Override of the default locking class to be used for validating lock
201 * order with the standard member lock handle.
202 */
203 virtual VBoxLockingClass getLockingClass() const
204 {
205 return LOCKCLASS_VIRTUALBOXOBJECT;
206 }
207
208#ifdef DEBUG
209 void dumpAllBackRefs();
210#endif
211
212 HRESULT postEvent(Event *event);
213
214 HRESULT addProgress(IProgress *aProgress);
215 HRESULT removeProgress(IN_GUID aId);
216
217#ifdef RT_OS_WINDOWS
218 typedef DECLCALLBACKPTR (HRESULT, SVCHelperClientFunc)
219 (SVCHlpClient *aClient, Progress *aProgress, void *aUser, int *aVrc);
220 HRESULT startSVCHelperClient(bool aPrivileged,
221 SVCHelperClientFunc aFunc,
222 void *aUser, Progress *aProgress);
223#endif
224
225 void addProcessToReap (RTPROCESS pid);
226 void updateClientWatcher();
227
228 void removeDeadCallback(const ComPtr<IVirtualBoxCallback> &aCallback);
229
230 void onMachineStateChange(const Guid &aId, MachineState_T aState);
231 void onMachineDataChange(const Guid &aId);
232 BOOL onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
233 Bstr &aError);
234 void onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue);
235 void onMachineRegistered(const Guid &aId, BOOL aRegistered);
236 void onSessionStateChange(const Guid &aId, SessionState_T aState);
237
238 void onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId);
239 void onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId);
240 void onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId);
241 void onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName, IN_BSTR aValue,
242 IN_BSTR aFlags);
243
244 ComObjPtr<GuestOSType> getUnknownOSType();
245
246 void getOpenedMachines(SessionMachinesList &aMachines,
247 InternalControlList *aControls = NULL);
248
249 bool isMachineIdValid(const Guid &aId)
250 {
251 return SUCCEEDED(findMachine(aId, false /* aSetError */, NULL));
252 }
253
254 HRESULT findMachine (const Guid &aId, bool aSetError,
255 ComObjPtr<Machine> *machine = NULL);
256
257 HRESULT findHardDisk(const Guid *aId, CBSTR aLocation,
258 bool aSetError, ComObjPtr<Medium> *aHardDisk = NULL);
259 HRESULT findDVDImage(const Guid *aId, CBSTR aLocation,
260 bool aSetError, ComObjPtr<Medium> *aImage = NULL);
261 HRESULT findFloppyImage(const Guid *aId, CBSTR aLocation,
262 bool aSetError, ComObjPtr<Medium> *aImage = NULL);
263
264 HRESULT findGuestOSType(const Bstr &bstrOSType,
265 GuestOSType*& pGuestOSType);
266
267 const ComObjPtr<Host>& host() const;
268 const ComObjPtr<SystemProperties>& systemProperties() const;
269#ifdef VBOX_WITH_RESOURCE_USAGE_API
270 const ComObjPtr<PerformanceCollector>& performanceCollector() const;
271#endif /* VBOX_WITH_RESOURCE_USAGE_API */
272
273 const Utf8Str& getDefaultMachineFolder() const;
274 const Utf8Str& getDefaultHardDiskFolder() const;
275 const Utf8Str& getDefaultHardDiskFormat() const;
276
277 /** Returns the VirtualBox home directory */
278 const Utf8Str& homeDir() const;
279
280 int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
281 void calculateRelativePath(const Utf8Str &strPath, Utf8Str &aResult);
282
283 HRESULT registerHardDisk(Medium *aHardDisk, bool *pfNeedsSaveSettings);
284 HRESULT unregisterHardDisk(Medium *aHardDisk, bool *pfNeedsSaveSettings);
285
286 HRESULT registerImage(Medium *aImage, DeviceType_T argType, bool *pfNeedsSaveSettings);
287 HRESULT unregisterImage(Medium *aImage, DeviceType_T argType, bool *pfNeedsSaveSettings);
288
289 void rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
290 const Utf8Str &strNewConfigDir);
291
292 HRESULT saveSettings();
293
294 static HRESULT ensureFilePathExists(const Utf8Str &strFileName);
295
296 static HRESULT handleUnexpectedExceptions (RT_SRC_POS_DECL);
297
298 const Utf8Str& settingsFilePath();
299
300 RWLockHandle& getMediaTreeLockHandle();
301
302 /* for VirtualBoxSupportErrorInfoImpl */
303 static const wchar_t *getComponentName() { return L"VirtualBox"; }
304
305private:
306
307 HRESULT checkMediaForConflicts2(const Guid &aId, const Utf8Str &aLocation,
308 Utf8Str &aConflictType);
309
310 HRESULT registerMachine (Machine *aMachine);
311
312 HRESULT registerDHCPServer(DHCPServer *aDHCPServer,
313 bool aSaveRegistry = true);
314 HRESULT unregisterDHCPServer(DHCPServer *aDHCPServer,
315 bool aSaveRegistry = true);
316
317 struct Data; // opaque data structure, defined in VirtualBoxImpl.cpp
318 Data *m;
319
320 /* static variables (defined in VirtualBoxImpl.cpp) */
321 static Bstr sVersion;
322 static ULONG sRevision;
323 static Bstr sPackageType;
324
325 static DECLCALLBACK(int) ClientWatcher (RTTHREAD thread, void *pvUser);
326 static DECLCALLBACK(int) AsyncEventHandler (RTTHREAD thread, void *pvUser);
327
328#ifdef RT_OS_WINDOWS
329 static DECLCALLBACK(int) SVCHelperClientThread (RTTHREAD aThread, void *aUser);
330#endif
331};
332
333////////////////////////////////////////////////////////////////////////////////
334
335#endif // !____H_VIRTUALBOXIMPL
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