VirtualBox

source: vbox/trunk/src/VBox/Main/include/MachineImpl.h@ 34575

Last change on this file since 34575 was 34331, checked in by vboxsync, 14 years ago

PCI: more 4.0 interfaces
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 46.9 KB
Line 
1/* $Id: MachineImpl.h 34331 2010-11-24 16:24:17Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2010 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_MACHINEIMPL
19#define ____H_MACHINEIMPL
20
21#include "VirtualBoxBase.h"
22#include "SnapshotImpl.h"
23#include "ProgressImpl.h"
24#include "VRDEServerImpl.h"
25#include "MediumAttachmentImpl.h"
26#include "PciDeviceAttachmentImpl.h"
27#include "MediumLock.h"
28#include "NetworkAdapterImpl.h"
29#include "AudioAdapterImpl.h"
30#include "SerialPortImpl.h"
31#include "ParallelPortImpl.h"
32#include "BIOSSettingsImpl.h"
33#include "StorageControllerImpl.h" // required for MachineImpl.h to compile on Windows
34#include "VBox/settings.h"
35#ifdef VBOX_WITH_RESOURCE_USAGE_API
36#include "Performance.h"
37#include "PerformanceImpl.h"
38#endif /* VBOX_WITH_RESOURCE_USAGE_API */
39
40// generated header
41#include "SchemaDefs.h"
42
43#include "VBox/com/ErrorInfo.h"
44
45#include <iprt/file.h>
46#include <iprt/thread.h>
47#include <iprt/time.h>
48
49#include <list>
50
51// defines
52////////////////////////////////////////////////////////////////////////////////
53
54// helper declarations
55////////////////////////////////////////////////////////////////////////////////
56
57class Progress;
58class ProgressProxy;
59class Keyboard;
60class Mouse;
61class Display;
62class MachineDebugger;
63class USBController;
64class Snapshot;
65class SharedFolder;
66class HostUSBDevice;
67class StorageController;
68
69class SessionMachine;
70
71namespace settings
72{
73 class MachineConfigFile;
74 struct Snapshot;
75 struct Hardware;
76 struct Storage;
77 struct StorageController;
78 struct MachineRegistryEntry;
79}
80
81// Machine class
82////////////////////////////////////////////////////////////////////////////////
83
84class ATL_NO_VTABLE Machine :
85 public VirtualBoxBase,
86 VBOX_SCRIPTABLE_IMPL(IMachine)
87{
88 Q_OBJECT
89
90public:
91
92 enum StateDependency
93 {
94 AnyStateDep = 0, MutableStateDep, MutableOrSavedStateDep
95 };
96
97 /**
98 * Internal machine data.
99 *
100 * Only one instance of this data exists per every machine -- it is shared
101 * by the Machine, SessionMachine and all SnapshotMachine instances
102 * associated with the given machine using the util::Shareable template
103 * through the mData variable.
104 *
105 * @note |const| members are persistent during lifetime so can be
106 * accessed without locking.
107 *
108 * @note There is no need to lock anything inside init() or uninit()
109 * methods, because they are always serialized (see AutoCaller).
110 */
111 struct Data
112 {
113 /**
114 * Data structure to hold information about sessions opened for the
115 * given machine.
116 */
117 struct Session
118 {
119 /** Control of the direct session opened by lockMachine() */
120 ComPtr<IInternalSessionControl> mDirectControl;
121
122 typedef std::list<ComPtr<IInternalSessionControl> > RemoteControlList;
123
124 /** list of controls of all opened remote sessions */
125 RemoteControlList mRemoteControls;
126
127 /** openRemoteSession() and OnSessionEnd() progress indicator */
128 ComObjPtr<ProgressProxy> mProgress;
129
130 /**
131 * PID of the session object that must be passed to openSession() to
132 * finalize the openRemoteSession() request (i.e., PID of the
133 * process created by openRemoteSession())
134 */
135 RTPROCESS mPid;
136
137 /** Current session state */
138 SessionState_T mState;
139
140 /** Session type string (for indirect sessions) */
141 Bstr mType;
142
143 /** Session machine object */
144 ComObjPtr<SessionMachine> mMachine;
145
146 /** Medium object lock collection. */
147 MediumLockListMap mLockedMedia;
148 };
149
150 Data();
151 ~Data();
152
153 const Guid mUuid;
154 BOOL mRegistered;
155
156 Utf8Str m_strConfigFile;
157 Utf8Str m_strConfigFileFull;
158
159 // machine settings XML file
160 settings::MachineConfigFile *pMachineConfigFile;
161 uint32_t flModifications;
162
163 BOOL mAccessible;
164 com::ErrorInfo mAccessError;
165
166 MachineState_T mMachineState;
167 RTTIMESPEC mLastStateChange;
168
169 /* Note: These are guarded by VirtualBoxBase::stateLockHandle() */
170 uint32_t mMachineStateDeps;
171 RTSEMEVENTMULTI mMachineStateDepsSem;
172 uint32_t mMachineStateChangePending;
173
174 BOOL mCurrentStateModified;
175 /** Guest properties have been modified and need saving since the
176 * machine was started, or there are transient properties which need
177 * deleting and the machine is being shut down. */
178 BOOL mGuestPropertiesModified;
179
180 Session mSession;
181
182 ComObjPtr<Snapshot> mFirstSnapshot;
183 ComObjPtr<Snapshot> mCurrentSnapshot;
184
185 // list of files to delete in Delete(); this list is filled by Unregister()
186 std::list<Utf8Str> llFilesToDelete;
187 };
188
189 /**
190 * Saved state data.
191 *
192 * It's actually only the state file path string, but it needs to be
193 * separate from Data, because Machine and SessionMachine instances
194 * share it, while SnapshotMachine does not.
195 *
196 * The data variable is |mSSData|.
197 */
198 struct SSData
199 {
200 Utf8Str mStateFilePath;
201 };
202
203 /**
204 * User changeable machine data.
205 *
206 * This data is common for all machine snapshots, i.e. it is shared
207 * by all SnapshotMachine instances associated with the given machine
208 * using the util::Backupable template through the |mUserData| variable.
209 *
210 * SessionMachine instances can alter this data and discard changes.
211 *
212 * @note There is no need to lock anything inside init() or uninit()
213 * methods, because they are always serialized (see AutoCaller).
214 */
215 struct UserData
216 {
217 settings::MachineUserData s;
218 };
219
220 /**
221 * Hardware data.
222 *
223 * This data is unique for a machine and for every machine snapshot.
224 * Stored using the util::Backupable template in the |mHWData| variable.
225 *
226 * SessionMachine instances can alter this data and discard changes.
227 */
228 struct HWData
229 {
230 /**
231 * Data structure to hold information about a guest property.
232 */
233 struct GuestProperty {
234 /** Property name */
235 Utf8Str strName;
236 /** Property value */
237 Utf8Str strValue;
238 /** Property timestamp */
239 LONG64 mTimestamp;
240 /** Property flags */
241 ULONG mFlags;
242 };
243
244 HWData();
245 ~HWData();
246
247 Bstr mHWVersion;
248 Guid mHardwareUUID; /**< If Null, use mData.mUuid. */
249 ULONG mMemorySize;
250 ULONG mMemoryBalloonSize;
251 BOOL mPageFusionEnabled;
252 ULONG mVRAMSize;
253 ULONG mMonitorCount;
254 BOOL mHWVirtExEnabled;
255 BOOL mHWVirtExExclusive;
256 BOOL mHWVirtExNestedPagingEnabled;
257 BOOL mHWVirtExLargePagesEnabled;
258 BOOL mHWVirtExVPIDEnabled;
259 BOOL mHWVirtExForceEnabled;
260 BOOL mAccelerate2DVideoEnabled;
261 BOOL mPAEEnabled;
262 BOOL mSyntheticCpu;
263 ULONG mCPUCount;
264 BOOL mCPUHotPlugEnabled;
265 ULONG mCpuExecutionCap;
266 BOOL mAccelerate3DEnabled;
267 BOOL mHpetEnabled;
268
269 BOOL mCPUAttached[SchemaDefs::MaxCPUCount];
270
271 settings::CpuIdLeaf mCpuIdStdLeafs[10];
272 settings::CpuIdLeaf mCpuIdExtLeafs[10];
273
274 DeviceType_T mBootOrder[SchemaDefs::MaxBootPosition];
275
276 typedef std::list< ComObjPtr<SharedFolder> > SharedFolderList;
277 SharedFolderList mSharedFolders;
278
279 ClipboardMode_T mClipboardMode;
280
281 typedef std::list<GuestProperty> GuestPropertyList;
282 GuestPropertyList mGuestProperties;
283 Utf8Str mGuestPropertyNotificationPatterns;
284
285 FirmwareType_T mFirmwareType;
286 KeyboardHidType_T mKeyboardHidType;
287 PointingHidType_T mPointingHidType;
288 ChipsetType_T mChipsetType;
289
290 BOOL mIoCacheEnabled;
291 ULONG mIoCacheSize;
292 };
293
294 /**
295 * Hard disk and other media data.
296 *
297 * The usage policy is the same as for HWData, but a separate structure
298 * is necessary because hard disk data requires different procedures when
299 * taking or deleting snapshots, etc.
300 *
301 * The data variable is |mMediaData|.
302 */
303 struct MediaData
304 {
305 MediaData();
306 ~MediaData();
307
308 typedef std::list< ComObjPtr<MediumAttachment> > AttachmentList;
309 AttachmentList mAttachments;
310 };
311
312 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(Machine, IMachine)
313
314 DECLARE_NOT_AGGREGATABLE(Machine)
315
316 DECLARE_PROTECT_FINAL_CONSTRUCT()
317
318 BEGIN_COM_MAP(Machine)
319 COM_INTERFACE_ENTRY(ISupportErrorInfo)
320 COM_INTERFACE_ENTRY(IMachine)
321 COM_INTERFACE_ENTRY(IDispatch)
322 END_COM_MAP()
323
324 DECLARE_EMPTY_CTOR_DTOR(Machine)
325
326 HRESULT FinalConstruct();
327 void FinalRelease();
328
329 // public initializer/uninitializer for internal purposes only:
330
331 // initializer for creating a new, empty machine
332 HRESULT init(VirtualBox *aParent,
333 const Utf8Str &strConfigFile,
334 const Utf8Str &strName,
335 GuestOSType *aOsType,
336 const Guid &aId,
337 bool fForceOverwrite);
338
339 // initializer for loading existing machine XML (either registered or not)
340 HRESULT init(VirtualBox *aParent,
341 const Utf8Str &strConfigFile,
342 const Guid *aId);
343
344 // initializer for machine config in memory (OVF import)
345 HRESULT init(VirtualBox *aParent,
346 const Utf8Str &strName,
347 const settings::MachineConfigFile &config);
348
349 void uninit();
350
351#ifdef VBOX_WITH_RESOURCE_USAGE_API
352 // Needed from VirtualBox, for the delayed metrics cleanup.
353 void unregisterMetrics(PerformanceCollector *aCollector, Machine *aMachine);
354#endif /* VBOX_WITH_RESOURCE_USAGE_API */
355
356protected:
357 HRESULT initImpl(VirtualBox *aParent,
358 const Utf8Str &strConfigFile);
359 HRESULT initDataAndChildObjects();
360 HRESULT registeredInit();
361 HRESULT tryCreateMachineConfigFile(bool fForceOverwrite);
362 void uninitDataAndChildObjects();
363
364public:
365 // IMachine properties
366 STDMETHOD(COMGETTER(Parent))(IVirtualBox **aParent);
367 STDMETHOD(COMGETTER(Accessible))(BOOL *aAccessible);
368 STDMETHOD(COMGETTER(AccessError))(IVirtualBoxErrorInfo **aAccessError);
369 STDMETHOD(COMGETTER(Name))(BSTR *aName);
370 STDMETHOD(COMSETTER(Name))(IN_BSTR aName);
371 STDMETHOD(COMGETTER(Description))(BSTR *aDescription);
372 STDMETHOD(COMSETTER(Description))(IN_BSTR aDescription);
373 STDMETHOD(COMGETTER(Id))(BSTR *aId);
374 STDMETHOD(COMGETTER(OSTypeId))(BSTR *aOSTypeId);
375 STDMETHOD(COMSETTER(OSTypeId))(IN_BSTR aOSTypeId);
376 STDMETHOD(COMGETTER(HardwareVersion))(BSTR *aVersion);
377 STDMETHOD(COMSETTER(HardwareVersion))(IN_BSTR aVersion);
378 STDMETHOD(COMGETTER(HardwareUUID))(BSTR *aUUID);
379 STDMETHOD(COMSETTER(HardwareUUID))(IN_BSTR aUUID);
380 STDMETHOD(COMGETTER(MemorySize))(ULONG *memorySize);
381 STDMETHOD(COMSETTER(MemorySize))(ULONG memorySize);
382 STDMETHOD(COMGETTER(CPUCount))(ULONG *cpuCount);
383 STDMETHOD(COMSETTER(CPUCount))(ULONG cpuCount);
384 STDMETHOD(COMGETTER(CPUHotPlugEnabled))(BOOL *enabled);
385 STDMETHOD(COMSETTER(CPUHotPlugEnabled))(BOOL enabled);
386 STDMETHOD(COMGETTER(CPUExecutionCap))(ULONG *aExecutionCap);
387 STDMETHOD(COMSETTER(CPUExecutionCap))(ULONG aExecutionCap);
388 STDMETHOD(COMGETTER(HpetEnabled))(BOOL *enabled);
389 STDMETHOD(COMSETTER(HpetEnabled))(BOOL enabled);
390 STDMETHOD(COMGETTER(MemoryBalloonSize))(ULONG *memoryBalloonSize);
391 STDMETHOD(COMSETTER(MemoryBalloonSize))(ULONG memoryBalloonSize);
392 STDMETHOD(COMGETTER(PageFusionEnabled))(BOOL *enabled);
393 STDMETHOD(COMSETTER(PageFusionEnabled))(BOOL enabled);
394 STDMETHOD(COMGETTER(VRAMSize))(ULONG *memorySize);
395 STDMETHOD(COMSETTER(VRAMSize))(ULONG memorySize);
396 STDMETHOD(COMGETTER(MonitorCount))(ULONG *monitorCount);
397 STDMETHOD(COMSETTER(MonitorCount))(ULONG monitorCount);
398 STDMETHOD(COMGETTER(Accelerate3DEnabled))(BOOL *enabled);
399 STDMETHOD(COMSETTER(Accelerate3DEnabled))(BOOL enabled);
400 STDMETHOD(COMGETTER(Accelerate2DVideoEnabled))(BOOL *enabled);
401 STDMETHOD(COMSETTER(Accelerate2DVideoEnabled))(BOOL enabled);
402 STDMETHOD(COMGETTER(BIOSSettings))(IBIOSSettings **biosSettings);
403 STDMETHOD(COMGETTER(SnapshotFolder))(BSTR *aSavedStateFolder);
404 STDMETHOD(COMSETTER(SnapshotFolder))(IN_BSTR aSavedStateFolder);
405 STDMETHOD(COMGETTER(MediumAttachments))(ComSafeArrayOut(IMediumAttachment *, aAttachments));
406 STDMETHOD(COMGETTER(VRDEServer))(IVRDEServer **vrdeServer);
407 STDMETHOD(COMGETTER(AudioAdapter))(IAudioAdapter **audioAdapter);
408 STDMETHOD(COMGETTER(USBController))(IUSBController * *aUSBController);
409 STDMETHOD(COMGETTER(SettingsFilePath))(BSTR *aFilePath);
410 STDMETHOD(COMGETTER(SettingsModified))(BOOL *aModified);
411 STDMETHOD(COMGETTER(SessionState))(SessionState_T *aSessionState);
412 STDMETHOD(COMGETTER(SessionType))(BSTR *aSessionType);
413 STDMETHOD(COMGETTER(SessionPid))(ULONG *aSessionPid);
414 STDMETHOD(COMGETTER(State))(MachineState_T *machineState);
415 STDMETHOD(COMGETTER(LastStateChange))(LONG64 *aLastStateChange);
416 STDMETHOD(COMGETTER(StateFilePath))(BSTR *aStateFilePath);
417 STDMETHOD(COMGETTER(LogFolder))(BSTR *aLogFolder);
418 STDMETHOD(COMGETTER(CurrentSnapshot))(ISnapshot **aCurrentSnapshot);
419 STDMETHOD(COMGETTER(SnapshotCount))(ULONG *aSnapshotCount);
420 STDMETHOD(COMGETTER(CurrentStateModified))(BOOL *aCurrentStateModified);
421 STDMETHOD(COMGETTER(SharedFolders))(ComSafeArrayOut(ISharedFolder *, aSharedFolders));
422 STDMETHOD(COMGETTER(ClipboardMode))(ClipboardMode_T *aClipboardMode);
423 STDMETHOD(COMSETTER(ClipboardMode))(ClipboardMode_T aClipboardMode);
424 STDMETHOD(COMGETTER(GuestPropertyNotificationPatterns))(BSTR *aPattern);
425 STDMETHOD(COMSETTER(GuestPropertyNotificationPatterns))(IN_BSTR aPattern);
426 STDMETHOD(COMGETTER(StorageControllers))(ComSafeArrayOut(IStorageController *, aStorageControllers));
427 STDMETHOD(COMGETTER(TeleporterEnabled))(BOOL *aEnabled);
428 STDMETHOD(COMSETTER(TeleporterEnabled))(BOOL aEnabled);
429 STDMETHOD(COMGETTER(TeleporterPort))(ULONG *aPort);
430 STDMETHOD(COMSETTER(TeleporterPort))(ULONG aPort);
431 STDMETHOD(COMGETTER(TeleporterAddress))(BSTR *aAddress);
432 STDMETHOD(COMSETTER(TeleporterAddress))(IN_BSTR aAddress);
433 STDMETHOD(COMGETTER(TeleporterPassword))(BSTR *aPassword);
434 STDMETHOD(COMSETTER(TeleporterPassword))(IN_BSTR aPassword);
435 STDMETHOD(COMGETTER(FaultToleranceState))(FaultToleranceState_T *aEnabled);
436 STDMETHOD(COMSETTER(FaultToleranceState))(FaultToleranceState_T aEnabled);
437 STDMETHOD(COMGETTER(FaultToleranceAddress))(BSTR *aAddress);
438 STDMETHOD(COMSETTER(FaultToleranceAddress))(IN_BSTR aAddress);
439 STDMETHOD(COMGETTER(FaultTolerancePort))(ULONG *aPort);
440 STDMETHOD(COMSETTER(FaultTolerancePort))(ULONG aPort);
441 STDMETHOD(COMGETTER(FaultTolerancePassword))(BSTR *aPassword);
442 STDMETHOD(COMSETTER(FaultTolerancePassword))(IN_BSTR aPassword);
443 STDMETHOD(COMGETTER(FaultToleranceSyncInterval))(ULONG *aInterval);
444 STDMETHOD(COMSETTER(FaultToleranceSyncInterval))(ULONG aInterval);
445 STDMETHOD(COMGETTER(RTCUseUTC))(BOOL *aEnabled);
446 STDMETHOD(COMSETTER(RTCUseUTC))(BOOL aEnabled);
447 STDMETHOD(COMGETTER(FirmwareType)) (FirmwareType_T *aFirmware);
448 STDMETHOD(COMSETTER(FirmwareType)) (FirmwareType_T aFirmware);
449 STDMETHOD(COMGETTER(KeyboardHidType)) (KeyboardHidType_T *aKeyboardHidType);
450 STDMETHOD(COMSETTER(KeyboardHidType)) (KeyboardHidType_T aKeyboardHidType);
451 STDMETHOD(COMGETTER(PointingHidType)) (PointingHidType_T *aPointingHidType);
452 STDMETHOD(COMSETTER(PointingHidType)) (PointingHidType_T aPointingHidType);
453 STDMETHOD(COMGETTER(ChipsetType)) (ChipsetType_T *aChipsetType);
454 STDMETHOD(COMSETTER(ChipsetType)) (ChipsetType_T aChipsetType);
455 STDMETHOD(COMGETTER(IoCacheEnabled)) (BOOL *aEnabled);
456 STDMETHOD(COMSETTER(IoCacheEnabled)) (BOOL aEnabled);
457 STDMETHOD(COMGETTER(IoCacheSize)) (ULONG *aIoCacheSize);
458 STDMETHOD(COMSETTER(IoCacheSize)) (ULONG aIoCacheSize);
459
460 // IMachine methods
461 STDMETHOD(LockMachine)(ISession *aSession, LockType_T lockType);
462 STDMETHOD(LaunchVMProcess)(ISession *aSession, IN_BSTR aType, IN_BSTR aEnvironment, IProgress **aProgress);
463
464 STDMETHOD(SetBootOrder)(ULONG aPosition, DeviceType_T aDevice);
465 STDMETHOD(GetBootOrder)(ULONG aPosition, DeviceType_T *aDevice);
466 STDMETHOD(AttachDevice)(IN_BSTR aControllerName, LONG aControllerPort,
467 LONG aDevice, DeviceType_T aType, IMedium *aMedium);
468 STDMETHOD(DetachDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice);
469 STDMETHOD(PassthroughDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice, BOOL aPassthrough);
470 STDMETHOD(MountMedium)(IN_BSTR aControllerName, LONG aControllerPort,
471 LONG aDevice, IMedium *aMedium, BOOL aForce);
472 STDMETHOD(GetMedium)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice,
473 IMedium **aMedium);
474 STDMETHOD(GetSerialPort)(ULONG slot, ISerialPort **port);
475 STDMETHOD(GetParallelPort)(ULONG slot, IParallelPort **port);
476 STDMETHOD(GetNetworkAdapter)(ULONG slot, INetworkAdapter **adapter);
477 STDMETHOD(GetExtraDataKeys)(ComSafeArrayOut(BSTR, aKeys));
478 STDMETHOD(GetExtraData)(IN_BSTR aKey, BSTR *aValue);
479 STDMETHOD(SetExtraData)(IN_BSTR aKey, IN_BSTR aValue);
480 STDMETHOD(GetCPUProperty)(CPUPropertyType_T property, BOOL *aVal);
481 STDMETHOD(SetCPUProperty)(CPUPropertyType_T property, BOOL aVal);
482 STDMETHOD(GetCPUIDLeaf)(ULONG id, ULONG *aValEax, ULONG *aValEbx, ULONG *aValEcx, ULONG *aValEdx);
483 STDMETHOD(SetCPUIDLeaf)(ULONG id, ULONG aValEax, ULONG aValEbx, ULONG aValEcx, ULONG aValEdx);
484 STDMETHOD(RemoveCPUIDLeaf)(ULONG id);
485 STDMETHOD(RemoveAllCPUIDLeaves)();
486 STDMETHOD(GetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL *aVal);
487 STDMETHOD(SetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL aVal);
488 STDMETHOD(SaveSettings)();
489 STDMETHOD(DiscardSettings)();
490 STDMETHOD(Unregister)(CleanupMode_T cleanupMode, ComSafeArrayOut(IMedium*, aMedia));
491 STDMETHOD(Delete)(ComSafeArrayIn(IMedium*, aMedia), IProgress **aProgress);
492 STDMETHOD(Export)(IAppliance *aAppliance, IN_BSTR location, IVirtualSystemDescription **aDescription);
493 STDMETHOD(FindSnapshot)(IN_BSTR aNameOrId, ISnapshot **aSnapshot);
494 STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
495 STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);
496 STDMETHOD(CanShowConsoleWindow)(BOOL *aCanShow);
497 STDMETHOD(ShowConsoleWindow)(LONG64 *aWinId);
498 STDMETHOD(GetGuestProperty)(IN_BSTR aName, BSTR *aValue, LONG64 *aTimestamp, BSTR *aFlags);
499 STDMETHOD(GetGuestPropertyValue)(IN_BSTR aName, BSTR *aValue);
500 STDMETHOD(GetGuestPropertyTimestamp)(IN_BSTR aName, LONG64 *aTimestamp);
501 STDMETHOD(SetGuestProperty)(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags);
502 STDMETHOD(SetGuestPropertyValue)(IN_BSTR aName, IN_BSTR aValue);
503 STDMETHOD(EnumerateGuestProperties)(IN_BSTR aPattern, ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(LONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
504 STDMETHOD(GetMediumAttachmentsOfController)(IN_BSTR aName, ComSafeArrayOut(IMediumAttachment *, aAttachments));
505 STDMETHOD(GetMediumAttachment)(IN_BSTR aConstrollerName, LONG aControllerPort, LONG aDevice, IMediumAttachment **aAttachment);
506 STDMETHOD(AddStorageController)(IN_BSTR aName, StorageBus_T aConnectionType, IStorageController **controller);
507 STDMETHOD(RemoveStorageController(IN_BSTR aName));
508 STDMETHOD(GetStorageControllerByName(IN_BSTR aName, IStorageController **storageController));
509 STDMETHOD(GetStorageControllerByInstance(ULONG aInstance, IStorageController **storageController));
510 STDMETHOD(SetStorageControllerBootable)(IN_BSTR aName, BOOL fBootable);
511 STDMETHOD(QuerySavedGuestSize)(ULONG aScreenId, ULONG *puWidth, ULONG *puHeight);
512 STDMETHOD(QuerySavedThumbnailSize)(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
513 STDMETHOD(ReadSavedThumbnailToArray)(ULONG aScreenId, BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
514 STDMETHOD(ReadSavedThumbnailPNGToArray)(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
515 STDMETHOD(QuerySavedScreenshotPNGSize)(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
516 STDMETHOD(ReadSavedScreenshotPNGToArray)(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
517 STDMETHOD(HotPlugCPU(ULONG aCpu));
518 STDMETHOD(HotUnplugCPU(ULONG aCpu));
519 STDMETHOD(GetCPUStatus(ULONG aCpu, BOOL *aCpuAttached));
520 STDMETHOD(QueryLogFilename(ULONG aIdx, BSTR *aName));
521 STDMETHOD(ReadLog(ULONG aIdx, LONG64 aOffset, LONG64 aSize, ComSafeArrayOut(BYTE, aData)));
522 STDMETHOD(AttachHostPciDevice(LONG hostAddress, LONG desiredGuestAddress, IEventContext *eventContext, BOOL tryToUnbind));
523 STDMETHOD(DetachHostPciDevice(LONG hostAddress));
524 STDMETHOD(COMGETTER(PciDeviceAssignments))(ComSafeArrayOut(IPciDeviceAttachment *, aAssignments));
525 // public methods only for internal purposes
526
527 virtual bool isSnapshotMachine() const
528 {
529 return false;
530 }
531
532 virtual bool isSessionMachine() const
533 {
534 return false;
535 }
536
537 /**
538 * Override of the default locking class to be used for validating lock
539 * order with the standard member lock handle.
540 */
541 virtual VBoxLockingClass getLockingClass() const
542 {
543 return LOCKCLASS_MACHINEOBJECT;
544 }
545
546 /// @todo (dmik) add lock and make non-inlined after revising classes
547 // that use it. Note: they should enter Machine lock to keep the returned
548 // information valid!
549 bool isRegistered() { return !!mData->mRegistered; }
550
551 // unsafe inline public methods for internal purposes only (ensure there is
552 // a caller and a read lock before calling them!)
553
554 /**
555 * Returns the VirtualBox object this machine belongs to.
556 *
557 * @note This method doesn't check this object's readiness. Intended to be
558 * used by ready Machine children (whose readiness is bound to the parent's
559 * one) or after doing addCaller() manually.
560 */
561 VirtualBox* getVirtualBox() const { return mParent; }
562
563 /**
564 * Returns this machine ID.
565 *
566 * @note This method doesn't check this object's readiness. Intended to be
567 * used by ready Machine children (whose readiness is bound to the parent's
568 * one) or after adding a caller manually.
569 */
570 const Guid& getId() const { return mData->mUuid; }
571
572 /**
573 * Returns the snapshot ID this machine represents or an empty UUID if this
574 * instance is not SnapshotMachine.
575 *
576 * @note This method doesn't check this object's readiness. Intended to be
577 * used by ready Machine children (whose readiness is bound to the parent's
578 * one) or after adding a caller manually.
579 */
580 inline const Guid& getSnapshotId() const;
581
582 /**
583 * Returns this machine's full settings file path.
584 *
585 * @note This method doesn't lock this object or check its readiness.
586 * Intended to be used only after doing addCaller() manually and locking it
587 * for reading.
588 */
589 const Utf8Str& getSettingsFileFull() const { return mData->m_strConfigFileFull; }
590
591 /**
592 * Returns this machine name.
593 *
594 * @note This method doesn't lock this object or check its readiness.
595 * Intended to be used only after doing addCaller() manually and locking it
596 * for reading.
597 */
598 const Utf8Str& getName() const { return mUserData->s.strName; }
599
600 enum
601 {
602 IsModified_MachineData = 0x0001,
603 IsModified_Storage = 0x0002,
604 IsModified_NetworkAdapters = 0x0008,
605 IsModified_SerialPorts = 0x0010,
606 IsModified_ParallelPorts = 0x0020,
607 IsModified_VRDEServer = 0x0040,
608 IsModified_AudioAdapter = 0x0080,
609 IsModified_USB = 0x0100,
610 IsModified_BIOS = 0x0200,
611 IsModified_SharedFolders = 0x0400,
612 IsModified_Snapshots = 0x0800
613 };
614
615 void setModified(uint32_t fl);
616
617 // callback handlers
618 virtual HRESULT onNetworkAdapterChange(INetworkAdapter * /* networkAdapter */, BOOL /* changeAdapter */) { return S_OK; }
619 virtual HRESULT onNATRedirectRuleChange(ULONG /* slot */, BOOL /* fRemove */ , IN_BSTR /* name */,
620 NATProtocol_T /* protocol */, IN_BSTR /* host ip */, LONG /* host port */, IN_BSTR /* guest port */, LONG /* guest port */ ) { return S_OK; }
621 virtual HRESULT onSerialPortChange(ISerialPort * /* serialPort */) { return S_OK; }
622 virtual HRESULT onParallelPortChange(IParallelPort * /* parallelPort */) { return S_OK; }
623 virtual HRESULT onVRDEServerChange(BOOL /* aRestart */) { return S_OK; }
624 virtual HRESULT onUSBControllerChange() { return S_OK; }
625 virtual HRESULT onStorageControllerChange() { return S_OK; }
626 virtual HRESULT onCPUChange(ULONG /* aCPU */, BOOL /* aRemove */) { return S_OK; }
627 virtual HRESULT onCPUExecutionCapChange(ULONG /* aExecutionCap */) { return S_OK; }
628 virtual HRESULT onMediumChange(IMediumAttachment * /* mediumAttachment */, BOOL /* force */) { return S_OK; }
629 virtual HRESULT onSharedFolderChange() { return S_OK; }
630
631 HRESULT saveRegistryEntry(settings::MachineRegistryEntry &data);
632
633 int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
634 void copyPathRelativeToMachine(const Utf8Str &strSource, Utf8Str &strTarget);
635
636 void getLogFolder(Utf8Str &aLogFolder);
637 Utf8Str queryLogFilename(ULONG idx);
638
639 HRESULT openRemoteSession(IInternalSessionControl *aControl,
640 IN_BSTR aType, IN_BSTR aEnvironment,
641 ProgressProxy *aProgress);
642
643 HRESULT getDirectControl(ComPtr<IInternalSessionControl> *directControl)
644 {
645 HRESULT rc;
646 *directControl = mData->mSession.mDirectControl;
647
648 if (!*directControl)
649 rc = E_ACCESSDENIED;
650 else
651 rc = S_OK;
652
653 return rc;
654 }
655
656#if defined(RT_OS_WINDOWS)
657
658 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
659 ComPtr<IInternalSessionControl> *aControl = NULL,
660 HANDLE *aIPCSem = NULL, bool aAllowClosing = false);
661 bool isSessionSpawning(RTPROCESS *aPID = NULL);
662
663 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
664 ComPtr<IInternalSessionControl> *aControl = NULL,
665 HANDLE *aIPCSem = NULL)
666 { return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }
667
668#elif defined(RT_OS_OS2)
669
670 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
671 ComPtr<IInternalSessionControl> *aControl = NULL,
672 HMTX *aIPCSem = NULL, bool aAllowClosing = false);
673
674 bool isSessionSpawning(RTPROCESS *aPID = NULL);
675
676 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
677 ComPtr<IInternalSessionControl> *aControl = NULL,
678 HMTX *aIPCSem = NULL)
679 { return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }
680
681#else
682
683 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
684 ComPtr<IInternalSessionControl> *aControl = NULL,
685 bool aAllowClosing = false);
686 bool isSessionSpawning();
687
688 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
689 ComPtr<IInternalSessionControl> *aControl = NULL)
690 { return isSessionOpen(aMachine, aControl, true /* aAllowClosing */); }
691
692#endif
693
694 bool checkForSpawnFailure();
695
696 HRESULT prepareRegister();
697
698 HRESULT getSharedFolder(CBSTR aName,
699 ComObjPtr<SharedFolder> &aSharedFolder,
700 bool aSetError = false)
701 {
702 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
703 return findSharedFolder(aName, aSharedFolder, aSetError);
704 }
705
706 HRESULT addStateDependency(StateDependency aDepType = AnyStateDep,
707 MachineState_T *aState = NULL,
708 BOOL *aRegistered = NULL);
709 void releaseStateDependency();
710
711protected:
712
713 HRESULT checkStateDependency(StateDependency aDepType);
714
715 Machine *getMachine();
716
717 void ensureNoStateDependencies();
718
719 virtual HRESULT setMachineState(MachineState_T aMachineState);
720
721 HRESULT findSharedFolder(CBSTR aName,
722 ComObjPtr<SharedFolder> &aSharedFolder,
723 bool aSetError = false);
724
725 HRESULT loadSettings(bool aRegistered);
726 HRESULT loadMachineDataFromSettings(const settings::MachineConfigFile &config,
727 const Guid *puuidRegistry);
728 HRESULT loadSnapshot(const settings::Snapshot &data,
729 const Guid &aCurSnapshotId,
730 Snapshot *aParentSnapshot);
731 HRESULT loadHardware(const settings::Hardware &data);
732 HRESULT loadStorageControllers(const settings::Storage &data,
733 const Guid *puuidRegistry,
734 const Guid *puuidSnapshot);
735 HRESULT loadStorageDevices(StorageController *aStorageController,
736 const settings::StorageController &data,
737 const Guid *puuidRegistry,
738 const Guid *puuidSnapshot);
739
740 HRESULT findSnapshotById(const Guid &aId,
741 ComObjPtr<Snapshot> &aSnapshot,
742 bool aSetError = false);
743 HRESULT findSnapshotByName(const Utf8Str &strName,
744 ComObjPtr<Snapshot> &aSnapshot,
745 bool aSetError = false);
746
747 HRESULT getStorageControllerByName(const Utf8Str &aName,
748 ComObjPtr<StorageController> &aStorageController,
749 bool aSetError = false);
750
751 HRESULT getMediumAttachmentsOfController(CBSTR aName,
752 MediaData::AttachmentList &aAttachments);
753
754 enum
755 {
756 /* flags for #saveSettings() */
757 SaveS_ResetCurStateModified = 0x01,
758 SaveS_InformCallbacksAnyway = 0x02,
759 SaveS_Force = 0x04,
760 /* flags for #saveStateSettings() */
761 SaveSTS_CurStateModified = 0x20,
762 SaveSTS_StateFilePath = 0x40,
763 SaveSTS_StateTimeStamp = 0x80
764 };
765
766 HRESULT prepareSaveSettings(bool *pfNeedsGlobalSaveSettings);
767 HRESULT saveSettings(bool *pfNeedsGlobalSaveSettings, int aFlags = 0);
768
769 void copyMachineDataToSettings(settings::MachineConfigFile &config);
770 HRESULT saveAllSnapshots(settings::MachineConfigFile &config);
771 HRESULT saveHardware(settings::Hardware &data);
772 HRESULT saveStorageControllers(settings::Storage &data);
773 HRESULT saveStorageDevices(ComObjPtr<StorageController> aStorageController,
774 settings::StorageController &data);
775 HRESULT saveStateSettings(int aFlags);
776
777 HRESULT createImplicitDiffs(IProgress *aProgress,
778 ULONG aWeight,
779 bool aOnline,
780 GuidList *pllRegistriesThatNeedSaving);
781 HRESULT deleteImplicitDiffs(GuidList *pllRegistriesThatNeedSaving);
782
783 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
784 IN_BSTR aControllerName,
785 LONG aControllerPort,
786 LONG aDevice);
787 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
788 ComObjPtr<Medium> pMedium);
789 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
790 Guid &id);
791
792 HRESULT detachDevice(MediumAttachment *pAttach,
793 AutoWriteLock &writeLock,
794 Snapshot *pSnapshot,
795 GuidList *pllRegistriesThatNeedSaving);
796 HRESULT detachAllMedia(AutoWriteLock &writeLock,
797 Snapshot *pSnapshot,
798 CleanupMode_T cleanupMode,
799 MediaList &llMedia);
800
801 void commitMedia(bool aOnline = false);
802 void rollbackMedia();
803
804 bool isInOwnDir(Utf8Str *aSettingsDir = NULL) const;
805
806 void rollback(bool aNotify);
807 void commit();
808 void copyFrom(Machine *aThat);
809
810 struct DeleteTask;
811 static DECLCALLBACK(int) deleteThread(RTTHREAD Thread, void *pvUser);
812 HRESULT deleteTaskWorker(DeleteTask &task);
813
814#ifdef VBOX_WITH_GUEST_PROPS
815 HRESULT getGuestPropertyFromService(IN_BSTR aName, BSTR *aValue,
816 LONG64 *aTimestamp, BSTR *aFlags) const;
817 HRESULT getGuestPropertyFromVM(IN_BSTR aName, BSTR *aValue,
818 LONG64 *aTimestamp, BSTR *aFlags) const;
819 HRESULT setGuestPropertyToService(IN_BSTR aName, IN_BSTR aValue,
820 IN_BSTR aFlags);
821 HRESULT setGuestPropertyToVM(IN_BSTR aName, IN_BSTR aValue,
822 IN_BSTR aFlags);
823 HRESULT enumerateGuestPropertiesInService
824 (IN_BSTR aPatterns, ComSafeArrayOut(BSTR, aNames),
825 ComSafeArrayOut(BSTR, aValues),
826 ComSafeArrayOut(LONG64, aTimestamps),
827 ComSafeArrayOut(BSTR, aFlags));
828 HRESULT enumerateGuestPropertiesOnVM
829 (IN_BSTR aPatterns, ComSafeArrayOut(BSTR, aNames),
830 ComSafeArrayOut(BSTR, aValues),
831 ComSafeArrayOut(LONG64, aTimestamps),
832 ComSafeArrayOut(BSTR, aFlags));
833#endif /* VBOX_WITH_GUEST_PROPS */
834
835#ifdef VBOX_WITH_RESOURCE_USAGE_API
836 void registerMetrics(PerformanceCollector *aCollector, Machine *aMachine, RTPROCESS pid);
837
838 pm::CollectorGuestHAL *mGuestHAL;
839#endif /* VBOX_WITH_RESOURCE_USAGE_API */
840
841 Machine* const mPeer;
842
843 VirtualBox * const mParent;
844
845 Shareable<Data> mData;
846 Shareable<SSData> mSSData;
847
848 Backupable<UserData> mUserData;
849 Backupable<HWData> mHWData;
850 Backupable<MediaData> mMediaData;
851
852 // the following fields need special backup/rollback/commit handling,
853 // so they cannot be a part of HWData
854
855 const ComObjPtr<VRDEServer> mVRDEServer;
856 const ComObjPtr<SerialPort> mSerialPorts[SchemaDefs::SerialPortCount];
857 const ComObjPtr<ParallelPort> mParallelPorts[SchemaDefs::ParallelPortCount];
858 const ComObjPtr<AudioAdapter> mAudioAdapter;
859 const ComObjPtr<USBController> mUSBController;
860 const ComObjPtr<BIOSSettings> mBIOSSettings;
861 const ComObjPtr<NetworkAdapter> mNetworkAdapters[SchemaDefs::NetworkAdapterCount];
862
863 typedef std::list< ComObjPtr<StorageController> > StorageControllerList;
864 Backupable<StorageControllerList> mStorageControllers;
865
866 typedef std::list< ComObjPtr<PciDeviceAttachment> > PciDeviceAssignmentList;
867 PciDeviceAssignmentList mPciDeviceAssignments;
868
869 friend class SessionMachine;
870 friend class SnapshotMachine;
871 friend class Appliance;
872 friend class VirtualBox;
873};
874
875// SessionMachine class
876////////////////////////////////////////////////////////////////////////////////
877
878/**
879 * @note Notes on locking objects of this class:
880 * SessionMachine shares some data with the primary Machine instance (pointed
881 * to by the |mPeer| member). In order to provide data consistency it also
882 * shares its lock handle. This means that whenever you lock a SessionMachine
883 * instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
884 * instance is also locked in the same lock mode. Keep it in mind.
885 */
886class ATL_NO_VTABLE SessionMachine :
887 public Machine,
888 VBOX_SCRIPTABLE_IMPL(IInternalMachineControl)
889{
890public:
891 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SessionMachine, IMachine)
892
893 DECLARE_NOT_AGGREGATABLE(SessionMachine)
894
895 DECLARE_PROTECT_FINAL_CONSTRUCT()
896
897 BEGIN_COM_MAP(SessionMachine)
898 COM_INTERFACE_ENTRY2(IDispatch, IMachine)
899 COM_INTERFACE_ENTRY(ISupportErrorInfo)
900 COM_INTERFACE_ENTRY(IMachine)
901 COM_INTERFACE_ENTRY(IInternalMachineControl)
902 END_COM_MAP()
903
904 DECLARE_EMPTY_CTOR_DTOR(SessionMachine)
905
906 HRESULT FinalConstruct();
907 void FinalRelease();
908
909 // public initializer/uninitializer for internal purposes only
910 HRESULT init(Machine *aMachine);
911 void uninit() { uninit(Uninit::Unexpected); }
912
913 // util::Lockable interface
914 RWLockHandle *lockHandle() const;
915
916 // IInternalMachineControl methods
917 STDMETHOD(SetRemoveSavedStateFile)(BOOL aRemove);
918 STDMETHOD(UpdateState)(MachineState_T machineState);
919 STDMETHOD(GetIPCId)(BSTR *id);
920 STDMETHOD(BeginPowerUp)(IProgress *aProgress);
921 STDMETHOD(EndPowerUp)(LONG iResult);
922 STDMETHOD(RunUSBDeviceFilters)(IUSBDevice *aUSBDevice, BOOL *aMatched, ULONG *aMaskedIfs);
923 STDMETHOD(CaptureUSBDevice)(IN_BSTR aId);
924 STDMETHOD(DetachUSBDevice)(IN_BSTR aId, BOOL aDone);
925 STDMETHOD(AutoCaptureUSBDevices)();
926 STDMETHOD(DetachAllUSBDevices)(BOOL aDone);
927 STDMETHOD(OnSessionEnd)(ISession *aSession, IProgress **aProgress);
928 STDMETHOD(BeginSavingState)(IProgress **aProgress, BSTR *aStateFilePath);
929 STDMETHOD(EndSavingState)(LONG aResult, IN_BSTR aErrMsg);
930 STDMETHOD(AdoptSavedState)(IN_BSTR aSavedStateFile);
931 STDMETHOD(BeginTakingSnapshot)(IConsole *aInitiator,
932 IN_BSTR aName,
933 IN_BSTR aDescription,
934 IProgress *aConsoleProgress,
935 BOOL fTakingSnapshotOnline,
936 BSTR *aStateFilePath);
937 STDMETHOD(EndTakingSnapshot)(BOOL aSuccess);
938 STDMETHOD(DeleteSnapshot)(IConsole *aInitiator, IN_BSTR aId,
939 MachineState_T *aMachineState, IProgress **aProgress);
940 STDMETHOD(FinishOnlineMergeMedium)(IMediumAttachment *aMediumAttachment,
941 IMedium *aSource, IMedium *aTarget,
942 BOOL fMergeForward,
943 IMedium *pParentForTarget,
944 ComSafeArrayIn(IMedium *, aChildrenToReparent));
945 STDMETHOD(RestoreSnapshot)(IConsole *aInitiator,
946 ISnapshot *aSnapshot,
947 MachineState_T *aMachineState,
948 IProgress **aProgress);
949 STDMETHOD(PullGuestProperties)(ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues),
950 ComSafeArrayOut(LONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
951 STDMETHOD(PushGuestProperty)(IN_BSTR aName, IN_BSTR aValue,
952 LONG64 aTimestamp, IN_BSTR aFlags);
953 STDMETHOD(LockMedia)() { return lockMedia(); }
954 STDMETHOD(UnlockMedia)() { unlockMedia(); return S_OK; }
955
956 // public methods only for internal purposes
957
958 virtual bool isSessionMachine() const
959 {
960 return true;
961 }
962
963 bool checkForDeath();
964
965 HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter);
966 HRESULT onNATRedirectRuleChange(ULONG ulSlot, BOOL aNatRuleRemove, IN_BSTR aRuleName,
967 NATProtocol_T aProto, IN_BSTR aHostIp, LONG aHostPort, IN_BSTR aGuestIp, LONG aGuestPort);
968 HRESULT onStorageControllerChange();
969 HRESULT onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);
970 HRESULT onSerialPortChange(ISerialPort *serialPort);
971 HRESULT onParallelPortChange(IParallelPort *parallelPort);
972 HRESULT onCPUChange(ULONG aCPU, BOOL aRemove);
973 HRESULT onCPUExecutionCapChange(ULONG aCpuExecutionCap);
974 HRESULT onVRDEServerChange(BOOL aRestart);
975 HRESULT onUSBControllerChange();
976 HRESULT onUSBDeviceAttach(IUSBDevice *aDevice,
977 IVirtualBoxErrorInfo *aError,
978 ULONG aMaskedIfs);
979 HRESULT onUSBDeviceDetach(IN_BSTR aId,
980 IVirtualBoxErrorInfo *aError);
981 HRESULT onSharedFolderChange();
982
983 bool hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs);
984
985private:
986
987 struct SnapshotData
988 {
989 SnapshotData() : mLastState(MachineState_Null) {}
990
991 MachineState_T mLastState;
992
993 // used when taking snapshot
994 ComObjPtr<Snapshot> mSnapshot;
995
996 // used when saving state
997 Utf8Str mStateFilePath;
998 ComObjPtr<Progress> mProgress;
999 };
1000
1001 struct Uninit
1002 {
1003 enum Reason { Unexpected, Abnormal, Normal };
1004 };
1005
1006 struct SnapshotTask;
1007 struct DeleteSnapshotTask;
1008 struct RestoreSnapshotTask;
1009
1010 friend struct DeleteSnapshotTask;
1011 friend struct RestoreSnapshotTask;
1012
1013 void uninit(Uninit::Reason aReason);
1014
1015 HRESULT endSavingState(HRESULT aRC, const Utf8Str &aErrMsg);
1016
1017 void deleteSnapshotHandler(DeleteSnapshotTask &aTask);
1018 void restoreSnapshotHandler(RestoreSnapshotTask &aTask);
1019
1020 HRESULT prepareDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,
1021 const Guid &machineId,
1022 const Guid &snapshotId,
1023 bool fOnlineMergePossible,
1024 MediumLockList *aVMMALockList,
1025 ComObjPtr<Medium> &aSource,
1026 ComObjPtr<Medium> &aTarget,
1027 bool &fMergeForward,
1028 ComObjPtr<Medium> &pParentForTarget,
1029 MediaList &aChildrenToReparent,
1030 bool &fNeedOnlineMerge,
1031 MediumLockList * &aMediumLockList);
1032 void cancelDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,
1033 const ComObjPtr<Medium> &aSource,
1034 const MediaList &aChildrenToReparent,
1035 bool fNeedsOnlineMerge,
1036 MediumLockList *aMediumLockList,
1037 const Guid &aMediumId,
1038 const Guid &aSnapshotId);
1039 HRESULT onlineMergeMedium(const ComObjPtr<MediumAttachment> &aMediumAttachment,
1040 const ComObjPtr<Medium> &aSource,
1041 const ComObjPtr<Medium> &aTarget,
1042 bool fMergeForward,
1043 const ComObjPtr<Medium> &pParentForTarget,
1044 const MediaList &aChildrenToReparent,
1045 MediumLockList *aMediumLockList,
1046 ComObjPtr<Progress> &aProgress,
1047 bool *pfNeedsMachineSaveSettings);
1048
1049 HRESULT lockMedia();
1050 void unlockMedia();
1051
1052 HRESULT setMachineState(MachineState_T aMachineState);
1053 HRESULT updateMachineStateOnClient();
1054
1055 HRESULT mRemoveSavedState;
1056
1057 SnapshotData mSnapshotData;
1058
1059 /** interprocess semaphore handle for this machine */
1060#if defined(RT_OS_WINDOWS)
1061 HANDLE mIPCSem;
1062 Bstr mIPCSemName;
1063 friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
1064 ComPtr<IInternalSessionControl> *aControl,
1065 HANDLE *aIPCSem, bool aAllowClosing);
1066#elif defined(RT_OS_OS2)
1067 HMTX mIPCSem;
1068 Bstr mIPCSemName;
1069 friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
1070 ComPtr<IInternalSessionControl> *aControl,
1071 HMTX *aIPCSem, bool aAllowClosing);
1072#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1073 int mIPCSem;
1074# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
1075 Bstr mIPCKey;
1076# endif /*VBOX_WITH_NEW_SYS_V_KEYGEN */
1077#else
1078# error "Port me!"
1079#endif
1080
1081 static DECLCALLBACK(int) taskHandler(RTTHREAD thread, void *pvUser);
1082};
1083
1084// SnapshotMachine class
1085////////////////////////////////////////////////////////////////////////////////
1086
1087/**
1088 * @note Notes on locking objects of this class:
1089 * SnapshotMachine shares some data with the primary Machine instance (pointed
1090 * to by the |mPeer| member). In order to provide data consistency it also
1091 * shares its lock handle. This means that whenever you lock a SessionMachine
1092 * instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
1093 * instance is also locked in the same lock mode. Keep it in mind.
1094 */
1095class ATL_NO_VTABLE SnapshotMachine :
1096 public Machine
1097{
1098public:
1099 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SnapshotMachine, IMachine)
1100
1101 DECLARE_NOT_AGGREGATABLE(SnapshotMachine)
1102
1103 DECLARE_PROTECT_FINAL_CONSTRUCT()
1104
1105 BEGIN_COM_MAP(SnapshotMachine)
1106 COM_INTERFACE_ENTRY2(IDispatch, IMachine)
1107 COM_INTERFACE_ENTRY(ISupportErrorInfo)
1108 COM_INTERFACE_ENTRY(IMachine)
1109 END_COM_MAP()
1110
1111 DECLARE_EMPTY_CTOR_DTOR(SnapshotMachine)
1112
1113 HRESULT FinalConstruct();
1114 void FinalRelease();
1115
1116 // public initializer/uninitializer for internal purposes only
1117 HRESULT init(SessionMachine *aSessionMachine,
1118 IN_GUID aSnapshotId,
1119 const Utf8Str &aStateFilePath);
1120 HRESULT init(Machine *aMachine,
1121 const settings::Hardware &hardware,
1122 const settings::Storage &storage,
1123 IN_GUID aSnapshotId,
1124 const Utf8Str &aStateFilePath);
1125 void uninit();
1126
1127 // util::Lockable interface
1128 RWLockHandle *lockHandle() const;
1129
1130 // public methods only for internal purposes
1131
1132 virtual bool isSnapshotMachine() const
1133 {
1134 return true;
1135 }
1136
1137 HRESULT onSnapshotChange(Snapshot *aSnapshot);
1138
1139 // unsafe inline public methods for internal purposes only (ensure there is
1140 // a caller and a read lock before calling them!)
1141
1142 const Guid& getSnapshotId() const { return mSnapshotId; }
1143
1144private:
1145
1146 Guid mSnapshotId;
1147
1148 friend class Snapshot;
1149};
1150
1151// third party methods that depend on SnapshotMachine definition
1152
1153inline const Guid &Machine::getSnapshotId() const
1154{
1155 return (isSnapshotMachine())
1156 ? static_cast<const SnapshotMachine*>(this)->getSnapshotId()
1157 : Guid::Empty;
1158}
1159
1160
1161#endif // ____H_MACHINEIMPL
1162/* vi: set tabstop=4 shiftwidth=4 expandtab: */
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