VirtualBox

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

Last change on this file since 36877 was 36673, checked in by vboxsync, 14 years ago

Main/Machine: add a way to terminate VM processes if they don't respond to the usual requests. Not an API change, just a comment change, and a slight VBoxManage touch up so that one can trigger it.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 48.3 KB
Line 
1/* $Id: MachineImpl.h 36673 2011-04-14 15:22:37Z 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(HpetEnabled))(BOOL *enabled);
392 STDMETHOD(COMSETTER(HpetEnabled))(BOOL enabled);
393 STDMETHOD(COMGETTER(MemoryBalloonSize))(ULONG *memoryBalloonSize);
394 STDMETHOD(COMSETTER(MemoryBalloonSize))(ULONG memoryBalloonSize);
395 STDMETHOD(COMGETTER(PageFusionEnabled))(BOOL *enabled);
396 STDMETHOD(COMSETTER(PageFusionEnabled))(BOOL enabled);
397 STDMETHOD(COMGETTER(VRAMSize))(ULONG *memorySize);
398 STDMETHOD(COMSETTER(VRAMSize))(ULONG memorySize);
399 STDMETHOD(COMGETTER(MonitorCount))(ULONG *monitorCount);
400 STDMETHOD(COMSETTER(MonitorCount))(ULONG monitorCount);
401 STDMETHOD(COMGETTER(Accelerate3DEnabled))(BOOL *enabled);
402 STDMETHOD(COMSETTER(Accelerate3DEnabled))(BOOL enabled);
403 STDMETHOD(COMGETTER(Accelerate2DVideoEnabled))(BOOL *enabled);
404 STDMETHOD(COMSETTER(Accelerate2DVideoEnabled))(BOOL enabled);
405 STDMETHOD(COMGETTER(BIOSSettings))(IBIOSSettings **biosSettings);
406 STDMETHOD(COMGETTER(SnapshotFolder))(BSTR *aSavedStateFolder);
407 STDMETHOD(COMSETTER(SnapshotFolder))(IN_BSTR aSavedStateFolder);
408 STDMETHOD(COMGETTER(MediumAttachments))(ComSafeArrayOut(IMediumAttachment *, aAttachments));
409 STDMETHOD(COMGETTER(VRDEServer))(IVRDEServer **vrdeServer);
410 STDMETHOD(COMGETTER(AudioAdapter))(IAudioAdapter **audioAdapter);
411 STDMETHOD(COMGETTER(USBController))(IUSBController * *aUSBController);
412 STDMETHOD(COMGETTER(SettingsFilePath))(BSTR *aFilePath);
413 STDMETHOD(COMGETTER(SettingsModified))(BOOL *aModified);
414 STDMETHOD(COMGETTER(SessionState))(SessionState_T *aSessionState);
415 STDMETHOD(COMGETTER(SessionType))(BSTR *aSessionType);
416 STDMETHOD(COMGETTER(SessionPid))(ULONG *aSessionPid);
417 STDMETHOD(COMGETTER(State))(MachineState_T *machineState);
418 STDMETHOD(COMGETTER(LastStateChange))(LONG64 *aLastStateChange);
419 STDMETHOD(COMGETTER(StateFilePath))(BSTR *aStateFilePath);
420 STDMETHOD(COMGETTER(LogFolder))(BSTR *aLogFolder);
421 STDMETHOD(COMGETTER(CurrentSnapshot))(ISnapshot **aCurrentSnapshot);
422 STDMETHOD(COMGETTER(SnapshotCount))(ULONG *aSnapshotCount);
423 STDMETHOD(COMGETTER(CurrentStateModified))(BOOL *aCurrentStateModified);
424 STDMETHOD(COMGETTER(SharedFolders))(ComSafeArrayOut(ISharedFolder *, aSharedFolders));
425 STDMETHOD(COMGETTER(ClipboardMode))(ClipboardMode_T *aClipboardMode);
426 STDMETHOD(COMSETTER(ClipboardMode))(ClipboardMode_T aClipboardMode);
427 STDMETHOD(COMGETTER(GuestPropertyNotificationPatterns))(BSTR *aPattern);
428 STDMETHOD(COMSETTER(GuestPropertyNotificationPatterns))(IN_BSTR aPattern);
429 STDMETHOD(COMGETTER(StorageControllers))(ComSafeArrayOut(IStorageController *, aStorageControllers));
430 STDMETHOD(COMGETTER(TeleporterEnabled))(BOOL *aEnabled);
431 STDMETHOD(COMSETTER(TeleporterEnabled))(BOOL aEnabled);
432 STDMETHOD(COMGETTER(TeleporterPort))(ULONG *aPort);
433 STDMETHOD(COMSETTER(TeleporterPort))(ULONG aPort);
434 STDMETHOD(COMGETTER(TeleporterAddress))(BSTR *aAddress);
435 STDMETHOD(COMSETTER(TeleporterAddress))(IN_BSTR aAddress);
436 STDMETHOD(COMGETTER(TeleporterPassword))(BSTR *aPassword);
437 STDMETHOD(COMSETTER(TeleporterPassword))(IN_BSTR aPassword);
438 STDMETHOD(COMGETTER(FaultToleranceState))(FaultToleranceState_T *aEnabled);
439 STDMETHOD(COMSETTER(FaultToleranceState))(FaultToleranceState_T aEnabled);
440 STDMETHOD(COMGETTER(FaultToleranceAddress))(BSTR *aAddress);
441 STDMETHOD(COMSETTER(FaultToleranceAddress))(IN_BSTR aAddress);
442 STDMETHOD(COMGETTER(FaultTolerancePort))(ULONG *aPort);
443 STDMETHOD(COMSETTER(FaultTolerancePort))(ULONG aPort);
444 STDMETHOD(COMGETTER(FaultTolerancePassword))(BSTR *aPassword);
445 STDMETHOD(COMSETTER(FaultTolerancePassword))(IN_BSTR aPassword);
446 STDMETHOD(COMGETTER(FaultToleranceSyncInterval))(ULONG *aInterval);
447 STDMETHOD(COMSETTER(FaultToleranceSyncInterval))(ULONG aInterval);
448 STDMETHOD(COMGETTER(RTCUseUTC))(BOOL *aEnabled);
449 STDMETHOD(COMSETTER(RTCUseUTC))(BOOL aEnabled);
450 STDMETHOD(COMGETTER(FirmwareType)) (FirmwareType_T *aFirmware);
451 STDMETHOD(COMSETTER(FirmwareType)) (FirmwareType_T aFirmware);
452 STDMETHOD(COMGETTER(KeyboardHidType)) (KeyboardHidType_T *aKeyboardHidType);
453 STDMETHOD(COMSETTER(KeyboardHidType)) (KeyboardHidType_T aKeyboardHidType);
454 STDMETHOD(COMGETTER(PointingHidType)) (PointingHidType_T *aPointingHidType);
455 STDMETHOD(COMSETTER(PointingHidType)) (PointingHidType_T aPointingHidType);
456 STDMETHOD(COMGETTER(ChipsetType)) (ChipsetType_T *aChipsetType);
457 STDMETHOD(COMSETTER(ChipsetType)) (ChipsetType_T aChipsetType);
458 STDMETHOD(COMGETTER(IoCacheEnabled)) (BOOL *aEnabled);
459 STDMETHOD(COMSETTER(IoCacheEnabled)) (BOOL aEnabled);
460 STDMETHOD(COMGETTER(IoCacheSize)) (ULONG *aIoCacheSize);
461 STDMETHOD(COMSETTER(IoCacheSize)) (ULONG aIoCacheSize);
462
463 // IMachine methods
464 STDMETHOD(LockMachine)(ISession *aSession, LockType_T lockType);
465 STDMETHOD(LaunchVMProcess)(ISession *aSession, IN_BSTR aType, IN_BSTR aEnvironment, IProgress **aProgress);
466
467 STDMETHOD(SetBootOrder)(ULONG aPosition, DeviceType_T aDevice);
468 STDMETHOD(GetBootOrder)(ULONG aPosition, DeviceType_T *aDevice);
469 STDMETHOD(AttachDevice)(IN_BSTR aControllerName, LONG aControllerPort,
470 LONG aDevice, DeviceType_T aType, IMedium *aMedium);
471 STDMETHOD(DetachDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice);
472 STDMETHOD(PassthroughDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice, BOOL aPassthrough);
473 STDMETHOD(SetBandwidthGroupForDevice)(IN_BSTR aControllerName, LONG aControllerPort,
474 LONG aDevice, IBandwidthGroup *aBandwidthGroup);
475 STDMETHOD(MountMedium)(IN_BSTR aControllerName, LONG aControllerPort,
476 LONG aDevice, IMedium *aMedium, BOOL aForce);
477 STDMETHOD(GetMedium)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice,
478 IMedium **aMedium);
479 STDMETHOD(GetSerialPort)(ULONG slot, ISerialPort **port);
480 STDMETHOD(GetParallelPort)(ULONG slot, IParallelPort **port);
481 STDMETHOD(GetNetworkAdapter)(ULONG slot, INetworkAdapter **adapter);
482 STDMETHOD(GetExtraDataKeys)(ComSafeArrayOut(BSTR, aKeys));
483 STDMETHOD(GetExtraData)(IN_BSTR aKey, BSTR *aValue);
484 STDMETHOD(SetExtraData)(IN_BSTR aKey, IN_BSTR aValue);
485 STDMETHOD(GetCPUProperty)(CPUPropertyType_T property, BOOL *aVal);
486 STDMETHOD(SetCPUProperty)(CPUPropertyType_T property, BOOL aVal);
487 STDMETHOD(GetCPUIDLeaf)(ULONG id, ULONG *aValEax, ULONG *aValEbx, ULONG *aValEcx, ULONG *aValEdx);
488 STDMETHOD(SetCPUIDLeaf)(ULONG id, ULONG aValEax, ULONG aValEbx, ULONG aValEcx, ULONG aValEdx);
489 STDMETHOD(RemoveCPUIDLeaf)(ULONG id);
490 STDMETHOD(RemoveAllCPUIDLeaves)();
491 STDMETHOD(GetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL *aVal);
492 STDMETHOD(SetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL aVal);
493 STDMETHOD(SaveSettings)();
494 STDMETHOD(DiscardSettings)();
495 STDMETHOD(Unregister)(CleanupMode_T cleanupMode, ComSafeArrayOut(IMedium*, aMedia));
496 STDMETHOD(Delete)(ComSafeArrayIn(IMedium*, aMedia), IProgress **aProgress);
497 STDMETHOD(Export)(IAppliance *aAppliance, IN_BSTR location, IVirtualSystemDescription **aDescription);
498 STDMETHOD(FindSnapshot)(IN_BSTR aNameOrId, ISnapshot **aSnapshot);
499 STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
500 STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);
501 STDMETHOD(CanShowConsoleWindow)(BOOL *aCanShow);
502 STDMETHOD(ShowConsoleWindow)(LONG64 *aWinId);
503 STDMETHOD(GetGuestProperty)(IN_BSTR aName, BSTR *aValue, LONG64 *aTimestamp, BSTR *aFlags);
504 STDMETHOD(GetGuestPropertyValue)(IN_BSTR aName, BSTR *aValue);
505 STDMETHOD(GetGuestPropertyTimestamp)(IN_BSTR aName, LONG64 *aTimestamp);
506 STDMETHOD(SetGuestProperty)(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags);
507 STDMETHOD(SetGuestPropertyValue)(IN_BSTR aName, IN_BSTR aValue);
508 STDMETHOD(EnumerateGuestProperties)(IN_BSTR aPattern, ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(LONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
509 STDMETHOD(GetMediumAttachmentsOfController)(IN_BSTR aName, ComSafeArrayOut(IMediumAttachment *, aAttachments));
510 STDMETHOD(GetMediumAttachment)(IN_BSTR aConstrollerName, LONG aControllerPort, LONG aDevice, IMediumAttachment **aAttachment);
511 STDMETHOD(AddStorageController)(IN_BSTR aName, StorageBus_T aConnectionType, IStorageController **controller);
512 STDMETHOD(RemoveStorageController(IN_BSTR aName));
513 STDMETHOD(GetStorageControllerByName(IN_BSTR aName, IStorageController **storageController));
514 STDMETHOD(GetStorageControllerByInstance(ULONG aInstance, IStorageController **storageController));
515 STDMETHOD(SetStorageControllerBootable)(IN_BSTR aName, BOOL fBootable);
516 STDMETHOD(QuerySavedGuestSize)(ULONG aScreenId, ULONG *puWidth, ULONG *puHeight);
517 STDMETHOD(QuerySavedThumbnailSize)(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
518 STDMETHOD(ReadSavedThumbnailToArray)(ULONG aScreenId, BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
519 STDMETHOD(ReadSavedThumbnailPNGToArray)(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
520 STDMETHOD(QuerySavedScreenshotPNGSize)(ULONG aScreenId, ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
521 STDMETHOD(ReadSavedScreenshotPNGToArray)(ULONG aScreenId, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
522 STDMETHOD(HotPlugCPU(ULONG aCpu));
523 STDMETHOD(HotUnplugCPU(ULONG aCpu));
524 STDMETHOD(GetCPUStatus(ULONG aCpu, BOOL *aCpuAttached));
525 STDMETHOD(QueryLogFilename(ULONG aIdx, BSTR *aName));
526 STDMETHOD(ReadLog(ULONG aIdx, LONG64 aOffset, LONG64 aSize, ComSafeArrayOut(BYTE, aData)));
527 STDMETHOD(AttachHostPciDevice(LONG hostAddress, LONG desiredGuestAddress, BOOL tryToUnbind));
528 STDMETHOD(DetachHostPciDevice(LONG hostAddress));
529 STDMETHOD(COMGETTER(PciDeviceAssignments))(ComSafeArrayOut(IPciDeviceAttachment *, aAssignments));
530 STDMETHOD(COMGETTER(BandwidthControl))(IBandwidthControl **aBandwidthControl);
531 // public methods only for internal purposes
532
533 virtual bool isSnapshotMachine() const
534 {
535 return false;
536 }
537
538 virtual bool isSessionMachine() const
539 {
540 return false;
541 }
542
543 /**
544 * Override of the default locking class to be used for validating lock
545 * order with the standard member lock handle.
546 */
547 virtual VBoxLockingClass getLockingClass() const
548 {
549 return LOCKCLASS_MACHINEOBJECT;
550 }
551
552 /// @todo (dmik) add lock and make non-inlined after revising classes
553 // that use it. Note: they should enter Machine lock to keep the returned
554 // information valid!
555 bool isRegistered() { return !!mData->mRegistered; }
556
557 // unsafe inline public methods for internal purposes only (ensure there is
558 // a caller and a read lock before calling them!)
559
560 /**
561 * Returns the VirtualBox object this machine belongs to.
562 *
563 * @note This method doesn't check this object's readiness. Intended to be
564 * used by ready Machine children (whose readiness is bound to the parent's
565 * one) or after doing addCaller() manually.
566 */
567 VirtualBox* getVirtualBox() const { return mParent; }
568
569 /**
570 * Returns this machine ID.
571 *
572 * @note This method doesn't check this object's readiness. Intended to be
573 * used by ready Machine children (whose readiness is bound to the parent's
574 * one) or after adding a caller manually.
575 */
576 const Guid& getId() const { return mData->mUuid; }
577
578 /**
579 * Returns the snapshot ID this machine represents or an empty UUID if this
580 * instance is not SnapshotMachine.
581 *
582 * @note This method doesn't check this object's readiness. Intended to be
583 * used by ready Machine children (whose readiness is bound to the parent's
584 * one) or after adding a caller manually.
585 */
586 inline const Guid& getSnapshotId() const;
587
588 /**
589 * Returns this machine's full settings file path.
590 *
591 * @note This method doesn't lock this object or check its readiness.
592 * Intended to be used only after doing addCaller() manually and locking it
593 * for reading.
594 */
595 const Utf8Str& getSettingsFileFull() const { return mData->m_strConfigFileFull; }
596
597 /**
598 * Returns this machine name.
599 *
600 * @note This method doesn't lock this object or check its readiness.
601 * Intended to be used only after doing addCaller() manually and locking it
602 * for reading.
603 */
604 const Utf8Str& getName() const { return mUserData->s.strName; }
605
606 enum
607 {
608 IsModified_MachineData = 0x0001,
609 IsModified_Storage = 0x0002,
610 IsModified_NetworkAdapters = 0x0008,
611 IsModified_SerialPorts = 0x0010,
612 IsModified_ParallelPorts = 0x0020,
613 IsModified_VRDEServer = 0x0040,
614 IsModified_AudioAdapter = 0x0080,
615 IsModified_USB = 0x0100,
616 IsModified_BIOS = 0x0200,
617 IsModified_SharedFolders = 0x0400,
618 IsModified_Snapshots = 0x0800,
619 IsModified_BandwidthControl = 0x1000
620 };
621
622 void setModified(uint32_t fl);
623 void setModifiedLock(uint32_t fl);
624
625 // callback handlers
626 virtual HRESULT onNetworkAdapterChange(INetworkAdapter * /* networkAdapter */, BOOL /* changeAdapter */) { return S_OK; }
627 virtual HRESULT onNATRedirectRuleChange(ULONG /* slot */, BOOL /* fRemove */ , IN_BSTR /* name */,
628 NATProtocol_T /* protocol */, IN_BSTR /* host ip */, LONG /* host port */, IN_BSTR /* guest port */, LONG /* guest port */ ) { return S_OK; }
629 virtual HRESULT onSerialPortChange(ISerialPort * /* serialPort */) { return S_OK; }
630 virtual HRESULT onParallelPortChange(IParallelPort * /* parallelPort */) { return S_OK; }
631 virtual HRESULT onVRDEServerChange(BOOL /* aRestart */) { return S_OK; }
632 virtual HRESULT onUSBControllerChange() { return S_OK; }
633 virtual HRESULT onStorageControllerChange() { return S_OK; }
634 virtual HRESULT onCPUChange(ULONG /* aCPU */, BOOL /* aRemove */) { return S_OK; }
635 virtual HRESULT onCPUExecutionCapChange(ULONG /* aExecutionCap */) { return S_OK; }
636 virtual HRESULT onMediumChange(IMediumAttachment * /* mediumAttachment */, BOOL /* force */) { return S_OK; }
637 virtual HRESULT onSharedFolderChange() { return S_OK; }
638 virtual HRESULT onBandwidthGroupChange(IBandwidthGroup * /* aBandwidthGroup */) { return S_OK; }
639
640 HRESULT saveRegistryEntry(settings::MachineRegistryEntry &data);
641
642 int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
643 void copyPathRelativeToMachine(const Utf8Str &strSource, Utf8Str &strTarget);
644
645 void getLogFolder(Utf8Str &aLogFolder);
646 Utf8Str queryLogFilename(ULONG idx);
647
648 void composeSavedStateFilename(Utf8Str &strStateFilePath);
649
650 HRESULT launchVMProcess(IInternalSessionControl *aControl,
651 const Utf8Str &strType,
652 const Utf8Str &strEnvironment,
653 ProgressProxy *aProgress);
654
655 HRESULT getDirectControl(ComPtr<IInternalSessionControl> *directControl)
656 {
657 HRESULT rc;
658 *directControl = mData->mSession.mDirectControl;
659
660 if (!*directControl)
661 rc = E_ACCESSDENIED;
662 else
663 rc = S_OK;
664
665 return rc;
666 }
667
668#if defined(RT_OS_WINDOWS)
669
670 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
671 ComPtr<IInternalSessionControl> *aControl = NULL,
672 HANDLE *aIPCSem = NULL, bool aAllowClosing = false);
673 bool isSessionSpawning(RTPROCESS *aPID = NULL);
674
675 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
676 ComPtr<IInternalSessionControl> *aControl = NULL,
677 HANDLE *aIPCSem = NULL)
678 { return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }
679
680#elif defined(RT_OS_OS2)
681
682 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
683 ComPtr<IInternalSessionControl> *aControl = NULL,
684 HMTX *aIPCSem = NULL, bool aAllowClosing = false);
685
686 bool isSessionSpawning(RTPROCESS *aPID = NULL);
687
688 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
689 ComPtr<IInternalSessionControl> *aControl = NULL,
690 HMTX *aIPCSem = NULL)
691 { return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }
692
693#else
694
695 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
696 ComPtr<IInternalSessionControl> *aControl = NULL,
697 bool aAllowClosing = false);
698 bool isSessionSpawning();
699
700 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
701 ComPtr<IInternalSessionControl> *aControl = NULL)
702 { return isSessionOpen(aMachine, aControl, true /* aAllowClosing */); }
703
704#endif
705
706 bool checkForSpawnFailure();
707
708 HRESULT prepareRegister();
709
710 HRESULT getSharedFolder(CBSTR aName,
711 ComObjPtr<SharedFolder> &aSharedFolder,
712 bool aSetError = false)
713 {
714 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
715 return findSharedFolder(aName, aSharedFolder, aSetError);
716 }
717
718 HRESULT addStateDependency(StateDependency aDepType = AnyStateDep,
719 MachineState_T *aState = NULL,
720 BOOL *aRegistered = NULL);
721 void releaseStateDependency();
722
723 HRESULT getBandwidthGroup(const Utf8Str &strBandwidthGroup,
724 ComObjPtr<BandwidthGroup> &pBandwidthGroup,
725 bool fSetError = false)
726 {
727 return mBandwidthControl->getBandwidthGroupByName(strBandwidthGroup,
728 pBandwidthGroup,
729 fSetError);
730 }
731
732protected:
733
734 HRESULT checkStateDependency(StateDependency aDepType);
735
736 Machine *getMachine();
737
738 void ensureNoStateDependencies();
739
740 virtual HRESULT setMachineState(MachineState_T aMachineState);
741
742 HRESULT findSharedFolder(const Utf8Str &aName,
743 ComObjPtr<SharedFolder> &aSharedFolder,
744 bool aSetError = false);
745
746 HRESULT loadSettings(bool aRegistered);
747 HRESULT loadMachineDataFromSettings(const settings::MachineConfigFile &config,
748 const Guid *puuidRegistry);
749 HRESULT loadSnapshot(const settings::Snapshot &data,
750 const Guid &aCurSnapshotId,
751 Snapshot *aParentSnapshot);
752 HRESULT loadHardware(const settings::Hardware &data);
753 HRESULT loadStorageControllers(const settings::Storage &data,
754 const Guid *puuidRegistry,
755 const Guid *puuidSnapshot);
756 HRESULT loadStorageDevices(StorageController *aStorageController,
757 const settings::StorageController &data,
758 const Guid *puuidRegistry,
759 const Guid *puuidSnapshot);
760
761 HRESULT findSnapshotById(const Guid &aId,
762 ComObjPtr<Snapshot> &aSnapshot,
763 bool aSetError = false);
764 HRESULT findSnapshotByName(const Utf8Str &strName,
765 ComObjPtr<Snapshot> &aSnapshot,
766 bool aSetError = false);
767
768 HRESULT getStorageControllerByName(const Utf8Str &aName,
769 ComObjPtr<StorageController> &aStorageController,
770 bool aSetError = false);
771
772 HRESULT getMediumAttachmentsOfController(CBSTR aName,
773 MediaData::AttachmentList &aAttachments);
774
775 enum
776 {
777 /* flags for #saveSettings() */
778 SaveS_ResetCurStateModified = 0x01,
779 SaveS_InformCallbacksAnyway = 0x02,
780 SaveS_Force = 0x04,
781 /* flags for #saveStateSettings() */
782 SaveSTS_CurStateModified = 0x20,
783 SaveSTS_StateFilePath = 0x40,
784 SaveSTS_StateTimeStamp = 0x80
785 };
786
787 HRESULT prepareSaveSettings(bool *pfNeedsGlobalSaveSettings);
788 HRESULT saveSettings(bool *pfNeedsGlobalSaveSettings, int aFlags = 0);
789
790 void copyMachineDataToSettings(settings::MachineConfigFile &config);
791 HRESULT saveAllSnapshots(settings::MachineConfigFile &config);
792 HRESULT saveHardware(settings::Hardware &data);
793 HRESULT saveStorageControllers(settings::Storage &data);
794 HRESULT saveStorageDevices(ComObjPtr<StorageController> aStorageController,
795 settings::StorageController &data);
796 HRESULT saveStateSettings(int aFlags);
797
798 void addMediumToRegistry(ComObjPtr<Medium> &pMedium,
799 GuidList &llRegistriesThatNeedSaving,
800 Guid *puuid);
801
802 HRESULT createImplicitDiffs(IProgress *aProgress,
803 ULONG aWeight,
804 bool aOnline,
805 GuidList *pllRegistriesThatNeedSaving);
806 HRESULT deleteImplicitDiffs(GuidList *pllRegistriesThatNeedSaving);
807
808 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
809 IN_BSTR aControllerName,
810 LONG aControllerPort,
811 LONG aDevice);
812 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
813 ComObjPtr<Medium> pMedium);
814 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
815 Guid &id);
816
817 HRESULT detachDevice(MediumAttachment *pAttach,
818 AutoWriteLock &writeLock,
819 Snapshot *pSnapshot,
820 GuidList *pllRegistriesThatNeedSaving);
821 HRESULT detachAllMedia(AutoWriteLock &writeLock,
822 Snapshot *pSnapshot,
823 CleanupMode_T cleanupMode,
824 MediaList &llMedia);
825
826 void commitMedia(bool aOnline = false);
827 void rollbackMedia();
828
829 bool isInOwnDir(Utf8Str *aSettingsDir = NULL) const;
830
831 void rollback(bool aNotify);
832 void commit();
833 void copyFrom(Machine *aThat);
834
835 struct DeleteTask;
836 static DECLCALLBACK(int) deleteThread(RTTHREAD Thread, void *pvUser);
837 HRESULT deleteTaskWorker(DeleteTask &task);
838
839#ifdef VBOX_WITH_GUEST_PROPS
840 HRESULT getGuestPropertyFromService(IN_BSTR aName, BSTR *aValue,
841 LONG64 *aTimestamp, BSTR *aFlags) const;
842 HRESULT getGuestPropertyFromVM(IN_BSTR aName, BSTR *aValue,
843 LONG64 *aTimestamp, BSTR *aFlags) const;
844 HRESULT setGuestPropertyToService(IN_BSTR aName, IN_BSTR aValue,
845 IN_BSTR aFlags);
846 HRESULT setGuestPropertyToVM(IN_BSTR aName, IN_BSTR aValue,
847 IN_BSTR aFlags);
848 HRESULT enumerateGuestPropertiesInService
849 (IN_BSTR aPatterns, ComSafeArrayOut(BSTR, aNames),
850 ComSafeArrayOut(BSTR, aValues),
851 ComSafeArrayOut(LONG64, aTimestamps),
852 ComSafeArrayOut(BSTR, aFlags));
853 HRESULT enumerateGuestPropertiesOnVM
854 (IN_BSTR aPatterns, ComSafeArrayOut(BSTR, aNames),
855 ComSafeArrayOut(BSTR, aValues),
856 ComSafeArrayOut(LONG64, aTimestamps),
857 ComSafeArrayOut(BSTR, aFlags));
858#endif /* VBOX_WITH_GUEST_PROPS */
859
860#ifdef VBOX_WITH_RESOURCE_USAGE_API
861 void registerMetrics(PerformanceCollector *aCollector, Machine *aMachine, RTPROCESS pid);
862
863 pm::CollectorGuest *mCollectorGuest;
864#endif /* VBOX_WITH_RESOURCE_USAGE_API */
865
866 Machine* const mPeer;
867
868 VirtualBox * const mParent;
869
870 Shareable<Data> mData;
871 Shareable<SSData> mSSData;
872
873 Backupable<UserData> mUserData;
874 Backupable<HWData> mHWData;
875 Backupable<MediaData> mMediaData;
876
877 // the following fields need special backup/rollback/commit handling,
878 // so they cannot be a part of HWData
879
880 const ComObjPtr<VRDEServer> mVRDEServer;
881 const ComObjPtr<SerialPort> mSerialPorts[SchemaDefs::SerialPortCount];
882 const ComObjPtr<ParallelPort> mParallelPorts[SchemaDefs::ParallelPortCount];
883 const ComObjPtr<AudioAdapter> mAudioAdapter;
884 const ComObjPtr<USBController> mUSBController;
885 const ComObjPtr<BIOSSettings> mBIOSSettings;
886 const ComObjPtr<NetworkAdapter> mNetworkAdapters[SchemaDefs::NetworkAdapterCount];
887 const ComObjPtr<BandwidthControl> mBandwidthControl;
888
889 typedef std::list< ComObjPtr<StorageController> > StorageControllerList;
890 Backupable<StorageControllerList> mStorageControllers;
891
892 friend class SessionMachine;
893 friend class SnapshotMachine;
894 friend class Appliance;
895 friend class VirtualBox;
896};
897
898// SessionMachine class
899////////////////////////////////////////////////////////////////////////////////
900
901/**
902 * @note Notes on locking objects of this class:
903 * SessionMachine shares some data with the primary Machine instance (pointed
904 * to by the |mPeer| member). In order to provide data consistency it also
905 * shares its lock handle. This means that whenever you lock a SessionMachine
906 * instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
907 * instance is also locked in the same lock mode. Keep it in mind.
908 */
909class ATL_NO_VTABLE SessionMachine :
910 public Machine,
911 VBOX_SCRIPTABLE_IMPL(IInternalMachineControl)
912{
913public:
914 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SessionMachine, IMachine)
915
916 DECLARE_NOT_AGGREGATABLE(SessionMachine)
917
918 DECLARE_PROTECT_FINAL_CONSTRUCT()
919
920 BEGIN_COM_MAP(SessionMachine)
921 VBOX_DEFAULT_INTERFACE_ENTRIES(IMachine)
922 COM_INTERFACE_ENTRY(IInternalMachineControl)
923 END_COM_MAP()
924
925 DECLARE_EMPTY_CTOR_DTOR(SessionMachine)
926
927 HRESULT FinalConstruct();
928 void FinalRelease();
929
930 // public initializer/uninitializer for internal purposes only
931 HRESULT init(Machine *aMachine);
932 void uninit() { uninit(Uninit::Unexpected); }
933
934 // util::Lockable interface
935 RWLockHandle *lockHandle() const;
936
937 // IInternalMachineControl methods
938 STDMETHOD(SetRemoveSavedStateFile)(BOOL aRemove);
939 STDMETHOD(UpdateState)(MachineState_T machineState);
940 STDMETHOD(GetIPCId)(BSTR *id);
941 STDMETHOD(BeginPowerUp)(IProgress *aProgress);
942 STDMETHOD(EndPowerUp)(LONG iResult);
943 STDMETHOD(BeginPoweringDown)(IProgress **aProgress);
944 STDMETHOD(EndPoweringDown)(LONG aResult, IN_BSTR aErrMsg);
945 STDMETHOD(RunUSBDeviceFilters)(IUSBDevice *aUSBDevice, BOOL *aMatched, ULONG *aMaskedIfs);
946 STDMETHOD(CaptureUSBDevice)(IN_BSTR aId);
947 STDMETHOD(DetachUSBDevice)(IN_BSTR aId, BOOL aDone);
948 STDMETHOD(AutoCaptureUSBDevices)();
949 STDMETHOD(DetachAllUSBDevices)(BOOL aDone);
950 STDMETHOD(OnSessionEnd)(ISession *aSession, IProgress **aProgress);
951 STDMETHOD(BeginSavingState)(IProgress **aProgress, BSTR *aStateFilePath);
952 STDMETHOD(EndSavingState)(LONG aResult, IN_BSTR aErrMsg);
953 STDMETHOD(AdoptSavedState)(IN_BSTR aSavedStateFile);
954 STDMETHOD(BeginTakingSnapshot)(IConsole *aInitiator,
955 IN_BSTR aName,
956 IN_BSTR aDescription,
957 IProgress *aConsoleProgress,
958 BOOL fTakingSnapshotOnline,
959 BSTR *aStateFilePath);
960 STDMETHOD(EndTakingSnapshot)(BOOL aSuccess);
961 STDMETHOD(DeleteSnapshot)(IConsole *aInitiator, IN_BSTR aId,
962 MachineState_T *aMachineState, IProgress **aProgress);
963 STDMETHOD(FinishOnlineMergeMedium)(IMediumAttachment *aMediumAttachment,
964 IMedium *aSource, IMedium *aTarget,
965 BOOL fMergeForward,
966 IMedium *pParentForTarget,
967 ComSafeArrayIn(IMedium *, aChildrenToReparent));
968 STDMETHOD(RestoreSnapshot)(IConsole *aInitiator,
969 ISnapshot *aSnapshot,
970 MachineState_T *aMachineState,
971 IProgress **aProgress);
972 STDMETHOD(PullGuestProperties)(ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues),
973 ComSafeArrayOut(LONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
974 STDMETHOD(PushGuestProperty)(IN_BSTR aName, IN_BSTR aValue,
975 LONG64 aTimestamp, IN_BSTR aFlags);
976 STDMETHOD(LockMedia)() { return lockMedia(); }
977 STDMETHOD(UnlockMedia)() { unlockMedia(); return S_OK; }
978
979 // public methods only for internal purposes
980
981 virtual bool isSessionMachine() const
982 {
983 return true;
984 }
985
986 bool checkForDeath();
987
988 HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter);
989 HRESULT onNATRedirectRuleChange(ULONG ulSlot, BOOL aNatRuleRemove, IN_BSTR aRuleName,
990 NATProtocol_T aProto, IN_BSTR aHostIp, LONG aHostPort, IN_BSTR aGuestIp, LONG aGuestPort);
991 HRESULT onStorageControllerChange();
992 HRESULT onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);
993 HRESULT onSerialPortChange(ISerialPort *serialPort);
994 HRESULT onParallelPortChange(IParallelPort *parallelPort);
995 HRESULT onCPUChange(ULONG aCPU, BOOL aRemove);
996 HRESULT onCPUExecutionCapChange(ULONG aCpuExecutionCap);
997 HRESULT onVRDEServerChange(BOOL aRestart);
998 HRESULT onUSBControllerChange();
999 HRESULT onUSBDeviceAttach(IUSBDevice *aDevice,
1000 IVirtualBoxErrorInfo *aError,
1001 ULONG aMaskedIfs);
1002 HRESULT onUSBDeviceDetach(IN_BSTR aId,
1003 IVirtualBoxErrorInfo *aError);
1004 HRESULT onSharedFolderChange();
1005 HRESULT onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);
1006
1007 bool hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs);
1008
1009private:
1010
1011 struct ConsoleTaskData
1012 {
1013 ConsoleTaskData()
1014 : mLastState(MachineState_Null)
1015 { }
1016
1017 MachineState_T mLastState;
1018 ComObjPtr<Progress> mProgress;
1019
1020 // used when taking snapshot
1021 ComObjPtr<Snapshot> mSnapshot;
1022
1023 // used when saving state (either as part of a snapshot or separate)
1024 Utf8Str strStateFilePath;
1025 };
1026
1027 struct Uninit
1028 {
1029 enum Reason { Unexpected, Abnormal, Normal };
1030 };
1031
1032 struct SnapshotTask;
1033 struct DeleteSnapshotTask;
1034 struct RestoreSnapshotTask;
1035
1036 friend struct DeleteSnapshotTask;
1037 friend struct RestoreSnapshotTask;
1038
1039 void uninit(Uninit::Reason aReason);
1040
1041 HRESULT endSavingState(HRESULT aRC, const Utf8Str &aErrMsg);
1042 void releaseSavedStateFile(const Utf8Str &strSavedStateFile, Snapshot *pSnapshotToIgnore);
1043
1044 void deleteSnapshotHandler(DeleteSnapshotTask &aTask);
1045 void restoreSnapshotHandler(RestoreSnapshotTask &aTask);
1046
1047 HRESULT prepareDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,
1048 const Guid &machineId,
1049 const Guid &snapshotId,
1050 bool fOnlineMergePossible,
1051 MediumLockList *aVMMALockList,
1052 ComObjPtr<Medium> &aSource,
1053 ComObjPtr<Medium> &aTarget,
1054 bool &fMergeForward,
1055 ComObjPtr<Medium> &pParentForTarget,
1056 MediaList &aChildrenToReparent,
1057 bool &fNeedOnlineMerge,
1058 MediumLockList * &aMediumLockList);
1059 void cancelDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,
1060 const ComObjPtr<Medium> &aSource,
1061 const MediaList &aChildrenToReparent,
1062 bool fNeedsOnlineMerge,
1063 MediumLockList *aMediumLockList,
1064 const Guid &aMediumId,
1065 const Guid &aSnapshotId);
1066 HRESULT onlineMergeMedium(const ComObjPtr<MediumAttachment> &aMediumAttachment,
1067 const ComObjPtr<Medium> &aSource,
1068 const ComObjPtr<Medium> &aTarget,
1069 bool fMergeForward,
1070 const ComObjPtr<Medium> &pParentForTarget,
1071 const MediaList &aChildrenToReparent,
1072 MediumLockList *aMediumLockList,
1073 ComObjPtr<Progress> &aProgress,
1074 bool *pfNeedsMachineSaveSettings);
1075
1076 HRESULT lockMedia();
1077 void unlockMedia();
1078
1079 HRESULT setMachineState(MachineState_T aMachineState);
1080 HRESULT updateMachineStateOnClient();
1081
1082 HRESULT mRemoveSavedState;
1083
1084 ConsoleTaskData mConsoleTaskData;
1085
1086 /** interprocess semaphore handle for this machine */
1087#if defined(RT_OS_WINDOWS)
1088 HANDLE mIPCSem;
1089 Bstr mIPCSemName;
1090 friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
1091 ComPtr<IInternalSessionControl> *aControl,
1092 HANDLE *aIPCSem, bool aAllowClosing);
1093#elif defined(RT_OS_OS2)
1094 HMTX mIPCSem;
1095 Bstr mIPCSemName;
1096 friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
1097 ComPtr<IInternalSessionControl> *aControl,
1098 HMTX *aIPCSem, bool aAllowClosing);
1099#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1100 int mIPCSem;
1101# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
1102 Bstr mIPCKey;
1103# endif /*VBOX_WITH_NEW_SYS_V_KEYGEN */
1104#else
1105# error "Port me!"
1106#endif
1107
1108 static DECLCALLBACK(int) taskHandler(RTTHREAD thread, void *pvUser);
1109};
1110
1111// SnapshotMachine class
1112////////////////////////////////////////////////////////////////////////////////
1113
1114/**
1115 * @note Notes on locking objects of this class:
1116 * SnapshotMachine shares some data with the primary Machine instance (pointed
1117 * to by the |mPeer| member). In order to provide data consistency it also
1118 * shares its lock handle. This means that whenever you lock a SessionMachine
1119 * instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
1120 * instance is also locked in the same lock mode. Keep it in mind.
1121 */
1122class ATL_NO_VTABLE SnapshotMachine :
1123 public Machine
1124{
1125public:
1126 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SnapshotMachine, IMachine)
1127
1128 DECLARE_NOT_AGGREGATABLE(SnapshotMachine)
1129
1130 DECLARE_PROTECT_FINAL_CONSTRUCT()
1131
1132 BEGIN_COM_MAP(SnapshotMachine)
1133 VBOX_DEFAULT_INTERFACE_ENTRIES(IMachine)
1134 END_COM_MAP()
1135
1136 DECLARE_EMPTY_CTOR_DTOR(SnapshotMachine)
1137
1138 HRESULT FinalConstruct();
1139 void FinalRelease();
1140
1141 // public initializer/uninitializer for internal purposes only
1142 HRESULT init(SessionMachine *aSessionMachine,
1143 IN_GUID aSnapshotId,
1144 const Utf8Str &aStateFilePath);
1145 HRESULT init(Machine *aMachine,
1146 const settings::Hardware &hardware,
1147 const settings::Storage &storage,
1148 IN_GUID aSnapshotId,
1149 const Utf8Str &aStateFilePath);
1150 void uninit();
1151
1152 // util::Lockable interface
1153 RWLockHandle *lockHandle() const;
1154
1155 // public methods only for internal purposes
1156
1157 virtual bool isSnapshotMachine() const
1158 {
1159 return true;
1160 }
1161
1162 HRESULT onSnapshotChange(Snapshot *aSnapshot);
1163
1164 // unsafe inline public methods for internal purposes only (ensure there is
1165 // a caller and a read lock before calling them!)
1166
1167 const Guid& getSnapshotId() const { return mSnapshotId; }
1168
1169private:
1170
1171 Guid mSnapshotId;
1172
1173 friend class Snapshot;
1174};
1175
1176// third party methods that depend on SnapshotMachine definition
1177
1178inline const Guid &Machine::getSnapshotId() const
1179{
1180 return (isSnapshotMachine())
1181 ? static_cast<const SnapshotMachine*>(this)->getSnapshotId()
1182 : Guid::Empty;
1183}
1184
1185
1186#endif // ____H_MACHINEIMPL
1187/* 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