VirtualBox

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

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

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