VirtualBox

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

Last change on this file since 255 was 1, checked in by vboxsync, 55 years ago

import
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.9 KB
Line 
1/** @file
2 *
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006 InnoTek Systemberatung GmbH
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 as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * If you received this file as part of a commercial VirtualBox
18 * distribution, then only the terms of your commercial VirtualBox
19 * license agreement apply instead of the previous paragraph.
20 */
21
22#ifndef ____H_VIRTUALBOXIMPL
23#define ____H_VIRTUALBOXIMPL
24
25#include "VirtualBoxBase.h"
26#include "VirtualBoxXMLUtil.h"
27
28#include "VBox/com/EventQueue.h"
29
30#include <VBox/cfgldr.h>
31
32#include <list>
33#include <vector>
34#include <map>
35
36#ifdef __WIN__
37#include "win32/resource.h"
38#endif
39
40class Machine;
41class SessionMachine;
42class HardDisk;
43class HVirtualDiskImage;
44class DVDImage;
45class FloppyImage;
46class MachineCollection;
47class HardDiskCollection;
48class DVDImageCollection;
49class FloppyImageCollection;
50class GuestOSType;
51class GuestOSTypeCollection;
52class SharedFolder;
53class Progress;
54class ProgressCollection;
55class Host;
56class SystemProperties;
57
58#ifdef __WIN__
59class SVCHlpClient;
60#endif
61
62struct VMClientWatcherData;
63
64class ATL_NO_VTABLE VirtualBox :
65 public VirtualBoxBaseWithChildrenNEXT,
66 public VirtualBoxXMLUtil,
67 public VirtualBoxSupportErrorInfoImpl <VirtualBox, IVirtualBox>,
68 public VirtualBoxSupportTranslation <VirtualBox>,
69#ifdef __WIN__
70 public IDispatchImpl<IVirtualBox, &IID_IVirtualBox, &LIBID_VirtualBox,
71 kTypeLibraryMajorVersion, kTypeLibraryMinorVersion>,
72 public CComCoClass<VirtualBox, &CLSID_VirtualBox>
73#else
74 public IVirtualBox
75#endif
76{
77
78public:
79
80 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (VirtualBox)
81
82 typedef std::list <ComPtr <IVirtualBoxCallback> > CallbackList;
83 typedef std::vector <ComPtr <IVirtualBoxCallback> > CallbackVector;
84
85 class CallbackEvent;
86 friend class CallbackEvent;
87
88 DECLARE_CLASSFACTORY_SINGLETON(VirtualBox)
89
90 DECLARE_REGISTRY_RESOURCEID(IDR_VIRTUALBOX)
91 DECLARE_NOT_AGGREGATABLE(VirtualBox)
92
93 DECLARE_PROTECT_FINAL_CONSTRUCT()
94
95 BEGIN_COM_MAP(VirtualBox)
96 COM_INTERFACE_ENTRY(IDispatch)
97 COM_INTERFACE_ENTRY(ISupportErrorInfo)
98 COM_INTERFACE_ENTRY(IVirtualBox)
99 END_COM_MAP()
100
101 NS_DECL_ISUPPORTS
102
103 /* to postpone generation of the default ctor/dtor */
104 VirtualBox();
105 ~VirtualBox();
106
107 HRESULT FinalConstruct();
108 void FinalRelease();
109
110 /* public initializer/uninitializer for internal purposes only */
111 HRESULT init();
112 void uninit();
113
114 /* IVirtualBox properties */
115 STDMETHOD(COMGETTER(Version)) (BSTR *aVersion);
116 STDMETHOD(COMGETTER(HomeFolder)) (BSTR *aHomeFolder);
117 STDMETHOD(COMGETTER(Host)) (IHost **aHost);
118 STDMETHOD(COMGETTER(SystemProperties)) (ISystemProperties **aSystemProperties);
119 STDMETHOD(COMGETTER(Machines)) (IMachineCollection **aMachines);
120 STDMETHOD(COMGETTER(HardDisks)) (IHardDiskCollection **aHardDisks);
121 STDMETHOD(COMGETTER(DVDImages)) (IDVDImageCollection **aDVDImages);
122 STDMETHOD(COMGETTER(FloppyImages)) (IFloppyImageCollection **aFloppyImages);
123 STDMETHOD(COMGETTER(ProgressOperations)) (IProgressCollection **aOperations);
124 STDMETHOD(COMGETTER(GuestOSTypes)) (IGuestOSTypeCollection **aGuestOSTypes);
125 STDMETHOD(COMGETTER(SharedFolders)) (ISharedFolderCollection **aSharedFolders);
126
127 /* IVirtualBox methods */
128
129 STDMETHOD(CreateMachine) (INPTR BSTR aBaseFolder, INPTR BSTR aName,
130 IMachine **aMachine);
131 STDMETHOD(CreateLegacyMachine) (INPTR BSTR aSettingsFile, INPTR BSTR aName,
132 IMachine **aMachine);
133 STDMETHOD(OpenMachine) (INPTR BSTR aSettingsFile, IMachine **aMachine);
134 STDMETHOD(RegisterMachine) (IMachine *aMachine);
135 STDMETHOD(GetMachine) (INPTR GUIDPARAM aId, IMachine **aMachine);
136 STDMETHOD(FindMachine) (INPTR BSTR aName, IMachine **aMachine);
137 STDMETHOD(UnregisterMachine) (INPTR GUIDPARAM aId, IMachine **aMachine);
138
139 STDMETHOD(CreateHardDisk) (HardDiskStorageType_T aStorageType, IHardDisk **aHardDisk);
140 STDMETHOD(OpenVirtualDiskImage) (INPTR BSTR aFilePath, IVirtualDiskImage **aImage);
141 STDMETHOD(RegisterHardDisk) (IHardDisk *aHardDisk);
142 STDMETHOD(GetHardDisk) (INPTR GUIDPARAM id, IHardDisk **hardDisk);
143 STDMETHOD(FindVirtualDiskImage) (INPTR BSTR aFilePath, IVirtualDiskImage **aImage);
144 STDMETHOD(UnregisterHardDisk) (INPTR GUIDPARAM aId, IHardDisk **aHardDisk);
145
146 STDMETHOD(OpenDVDImage) (INPTR BSTR aFilePath, INPTR GUIDPARAM aId,
147 IDVDImage **aDVDImage);
148 STDMETHOD(RegisterDVDImage) (IDVDImage *aDVDImage);
149 STDMETHOD(GetDVDImage) (INPTR GUIDPARAM aId, IDVDImage **aDVDImage);
150 STDMETHOD(FindDVDImage) (INPTR BSTR aFilePath, IDVDImage **aDVDImage);
151 STDMETHOD(GetDVDImageUsage) (INPTR GUIDPARAM aId,
152 ResourceUsage_T aUsage,
153 BSTR *aMachineIDs);
154 STDMETHOD(UnregisterDVDImage) (INPTR GUIDPARAM aId, IDVDImage **aDVDImage);
155
156 STDMETHOD(OpenFloppyImage) (INPTR BSTR aFilePath, INPTR GUIDPARAM aId,
157 IFloppyImage **aFloppyImage);
158 STDMETHOD(RegisterFloppyImage) (IFloppyImage *aFloppyImage);
159 STDMETHOD(GetFloppyImage) (INPTR GUIDPARAM id, IFloppyImage **aFloppyImage);
160 STDMETHOD(FindFloppyImage) (INPTR BSTR aFilePath, IFloppyImage **aFloppyImage);
161 STDMETHOD(GetFloppyImageUsage) (INPTR GUIDPARAM aId,
162 ResourceUsage_T aUsage,
163 BSTR *aMachineIDs);
164 STDMETHOD(UnregisterFloppyImage) (INPTR GUIDPARAM aId, IFloppyImage **aFloppyImage);
165
166 STDMETHOD(FindGuestOSType)(INPTR BSTR aId, IGuestOSType **aType);
167 STDMETHOD(CreateSharedFolder)(INPTR BSTR aName, INPTR BSTR aHostPath);
168 STDMETHOD(RemoveSharedFolder)(INPTR BSTR aName);
169 STDMETHOD(GetNextExtraDataKey)(INPTR BSTR aKey, BSTR *aNextKey, BSTR *aNextValue);
170 STDMETHOD(GetExtraData)(INPTR BSTR aKey, BSTR *aValue);
171 STDMETHOD(SetExtraData)(INPTR BSTR aKey, INPTR BSTR aValue);
172 STDMETHOD(OpenSession) (ISession *aSession, INPTR GUIDPARAM aMachineId);
173 STDMETHOD(OpenRemoteSession) (ISession *aSession, INPTR GUIDPARAM aMachineId,
174 INPTR BSTR aType, IProgress **aProgress);
175 STDMETHOD(OpenExistingSession) (ISession *aSession, INPTR GUIDPARAM aMachineId);
176 STDMETHOD(RegisterCallback)(IVirtualBoxCallback *callback);
177 STDMETHOD(UnregisterCallback)(IVirtualBoxCallback *callback);
178
179 /* public methods only for internal purposes */
180
181 HRESULT postEvent (Event *event);
182
183 HRESULT addProgress (IProgress *aProgress);
184 HRESULT removeProgress (INPTR GUIDPARAM aId);
185
186#ifdef __WIN__
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 &id, MachineState_T state);
198 void onMachineDataChange (const Guid &id);
199 BOOL onExtraDataCanChange(const Guid &id, INPTR BSTR key, INPTR BSTR value);
200 void onExtraDataChange(const Guid &id, INPTR BSTR key, INPTR BSTR value);
201 void onMachineRegistered (const Guid &aId, BOOL aRegistered);
202 void onSessionStateChange (const Guid &id, SessionState_T state);
203
204 void onSnapshotTaken (const Guid &aMachineId, const Guid &aSnapshotId);
205 void onSnapshotDiscarded (const Guid &aMachineId, const Guid &aSnapshotId);
206 void onSnapshotChange (const Guid &aMachineId, const Guid &aSnapshotId);
207
208 ComPtr <IGuestOSType> getUnknownOSType();
209
210 typedef std::vector <ComObjPtr <SessionMachine> > SessionMachineVector;
211 void getOpenedMachines (SessionMachineVector &aVector);
212
213 bool isMachineIdValid (const Guid &aId)
214 {
215 return SUCCEEDED (findMachine (aId, false /* aSetError */, NULL));
216 }
217
218 /// @todo (dmik) remove and make findMachine() public instead
219 // after switching to VirtualBoxBaseNEXT
220 HRESULT getMachine (const Guid &aId, ComObjPtr <Machine> &aMachine,
221 bool aSetError = false)
222 {
223 return findMachine (aId, aSetError, &aMachine);
224 }
225
226 /// @todo (dmik) remove and make findHardDisk() public instead
227 // after switching to VirtualBoxBaseNEXT
228 HRESULT getHardDisk (const Guid &aId, ComObjPtr <HardDisk> &aHardDisk)
229 {
230 return findHardDisk (aId, true /* aDoSetError */, &aHardDisk);
231 }
232
233 BOOL getDVDImageUsage (const Guid &id, ResourceUsage_T usage,
234 Bstr *machineIDs = NULL);
235 BOOL getFloppyImageUsage (const Guid &id, ResourceUsage_T usage,
236 Bstr *machineIDs = NULL);
237
238 const ComObjPtr <Host> &host() { return mData.mHost; }
239 const ComObjPtr <SystemProperties> &systemProperties() { return mData.mSystemProperties; }
240
241 /** Returns the VirtualBox home directory */
242 const Utf8Str &homeDir() { return mData.mHomeDir; }
243
244 void calculateRelativePath (const char *aPath, Utf8Str &aResult);
245
246 enum RHD_Flags { RHD_Internal, RHD_External, RHD_OnStartUp };
247 HRESULT registerHardDisk (HardDisk *aHardDisk, RHD_Flags aFlags);
248 HRESULT unregisterHardDisk (HardDisk *aHardDisk);
249 HRESULT unregisterDiffHardDisk (HardDisk *aHardDisk);
250
251 HRESULT saveSettings() { return saveConfig(); }
252 HRESULT updateSettings (const char *aOldPath, const char *aNewPath);
253
254 const Bstr &settingsFileName() { return mData.mCfgFile.mName; }
255
256 /* for VirtualBoxSupportErrorInfoImpl */
257 static const wchar_t *getComponentName() { return L"VirtualBox"; }
258
259private:
260
261 typedef std::list <ComObjPtr <Machine> > MachineList;
262 typedef std::list <ComObjPtr <GuestOSType> > GuestOSTypeList;
263 typedef std::list <ComPtr <IProgress> > ProgressList;
264
265 typedef std::list <ComObjPtr <HardDisk> > HardDiskList;
266 typedef std::list <ComObjPtr <DVDImage> > DVDImageList;
267 typedef std::list <ComObjPtr <FloppyImage> > FloppyImageList;
268 typedef std::list <ComObjPtr <SharedFolder> > SharedFolderList;
269
270 typedef std::map <Guid, ComObjPtr <HardDisk> > HardDiskMap;
271
272 HRESULT findMachine (const Guid &aId, bool aSetError,
273 ComObjPtr <Machine> *machine = NULL);
274
275 HRESULT findHardDisk (const Guid &aId, bool aSetError,
276 ComObjPtr <HardDisk> *aHardDisk = NULL);
277
278 HRESULT findVirtualDiskImage (const Guid *aId, const BSTR aFilePathFull,
279 bool aSetError, ComObjPtr <HVirtualDiskImage> *aImage = NULL);
280 HRESULT findDVDImage (const Guid *aId, const BSTR aFilePathFull,
281 bool aSetError, ComObjPtr <DVDImage> *aImage = NULL);
282 HRESULT findFloppyImage (const Guid *aId, const BSTR aFilePathFull,
283 bool aSetError, ComObjPtr <FloppyImage> *aImage = NULL);
284
285 HRESULT checkMediaForConflicts (HardDisk *aHardDisk,
286 const Guid *aId, const BSTR aFilePathFull);
287
288 HRESULT loadMachines (CFGNODE aGlobal);
289 HRESULT loadDisks (CFGNODE aGlobal);
290 HRESULT loadHardDisks (CFGNODE aNode);
291
292 HRESULT saveConfig();
293 HRESULT saveHardDisks (CFGNODE aNode);
294
295 HRESULT registerMachine (Machine *aMachine);
296
297 HRESULT registerDVDImage (DVDImage *aImage, bool aOnStartUp);
298 HRESULT registerFloppyImage (FloppyImage *aImage, bool aOnStartUp);
299 HRESULT registerGuestOSTypes();
300
301 HRESULT lockConfig();
302 HRESULT unlockConfig();
303
304 /** @note This method is not thread safe */
305 bool isConfigLocked() { return mData.mCfgFile.mHandle != NIL_RTFILE; }
306
307 /**
308 * Main VirtualBox data structure.
309 * @note |const| members are persistent during lifetime so can be accessed
310 * without locking.
311 */
312 struct Data
313 {
314 Data();
315
316 struct CfgFile
317 {
318 CfgFile() : mHandle (NIL_RTFILE) {}
319
320 const Bstr mName;
321 RTFILE mHandle;
322 };
323
324 // const data members not requiring locking
325 const Utf8Str mHomeDir;
326
327 // const objects not requiring locking
328 const ComObjPtr <Host> mHost;
329 const ComObjPtr <SystemProperties> mSystemProperties;
330
331 CfgFile mCfgFile;
332
333 MachineList mMachines;
334 GuestOSTypeList mGuestOSTypes;
335
336 ProgressList mProgressOperations;
337 HardDiskList mHardDisks;
338 DVDImageList mDVDImages;
339 FloppyImageList mFloppyImages;
340 SharedFolderList mSharedFolders;
341
342 HardDiskMap mHardDiskMap;
343
344 CallbackList mCallbacks;
345 };
346
347 Data mData;
348
349 /** Client watcher thread data structure */
350 struct ClientWatcherData
351 {
352 ClientWatcherData()
353#if defined(__WIN__)
354 : mUpdateReq (NULL)
355#elif defined(__LINUX__)
356 : mUpdateReq (NIL_RTSEMEVENT)
357#endif
358 , mThread (NIL_RTTHREAD) {}
359
360 // const objects not requiring locking
361#if defined(__WIN__)
362 const HANDLE mUpdateReq;
363#elif defined(__LINUX__)
364 const RTSEMEVENT mUpdateReq;
365#endif
366 const RTTHREAD mThread;
367
368 typedef std::list <RTPROCESS> ProcessList;
369 ProcessList mProcesses;
370 };
371
372 ClientWatcherData mWatcherData;
373
374 const RTTHREAD mAsyncEventThread;
375 EventQueue * const mAsyncEventQ;
376 /** Lock for calling EventQueue->post() */
377 AutoLock::Handle mAsyncEventQLock;
378
379 static Bstr sVersion;
380
381 static DECLCALLBACK(int) clientWatcher (RTTHREAD thread, void *pvUser);
382 static DECLCALLBACK(int) asyncEventHandler (RTTHREAD thread, void *pvUser);
383
384#ifdef __WIN__
385 static DECLCALLBACK(int) SVCHelperClientThread (RTTHREAD aThread, void *aUser);
386#endif
387};
388
389////////////////////////////////////////////////////////////////////////////////
390
391/**
392 * Abstract callback event class to asynchronously call VirtualBox callbacks
393 * on a dedicated event thread. Subclasses reimplement #handleCallback()
394 * to call appropriate IVirtualBoxCallback methods depending on the event
395 * to be dispatched.
396 *
397 * @note The VirtualBox instance passed to the constructor is strongly
398 * referenced, so that the VirtualBox singleton won't be released until the
399 * event gets handled by the event thread.
400 */
401class VirtualBox::CallbackEvent : public Event
402{
403public:
404
405 CallbackEvent (VirtualBox *aVirtualBox) : mVirtualBox (aVirtualBox)
406 {
407 Assert (aVirtualBox);
408 }
409
410 void *handler();
411
412 virtual void handleCallback (const ComPtr <IVirtualBoxCallback> &aCallback) = 0;
413
414private:
415
416 /*
417 * Note that this is a weak ref -- the CallbackEvent handler thread
418 * is bound to the lifetime of the VirtualBox instance, so it's safe.
419 */
420 ComObjPtr <VirtualBox, ComWeakRef> mVirtualBox;
421};
422
423#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