MachineImpl.h@ 94134

Last change on this file since 94134 was 93891, checked in by vboxsync, 3 years ago

Main: Guest Properties: improved property name and value validation, bugref:10185.

This commit also prevents guest properties loss if they were set while VM was running.

Property svn:eol-style set to native
Property svn:keywords set to Author Date Id Revision

File size: 68.8 KB

Line
1	/* $Id: MachineImpl.h 93891 2022-02-22 18:08:39Z vboxsync $ */
2	/** @file
3	* Implementation of IMachine in VBoxSVC - Header.
4	*/
5
6	/*
7	* Copyright (C) 2006-2022 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 MAIN_INCLUDED_MachineImpl_h
19	#define MAIN_INCLUDED_MachineImpl_h
20	#ifndef RT_WITHOUT_PRAGMA_ONCE
21	# pragma once
22	#endif
23
24	#include "AuthLibrary.h"
25	#include "VirtualBoxBase.h"
26	#include "SnapshotImpl.h"
27	#include "ProgressImpl.h"
28	#include "VRDEServerImpl.h"
29	#include "MediumAttachmentImpl.h"
30	#include "PCIDeviceAttachmentImpl.h"
31	#include "MediumLock.h"
32	#include "NetworkAdapterImpl.h"
33	#include "AudioAdapterImpl.h"
34	#include "SerialPortImpl.h"
35	#include "ParallelPortImpl.h"
36	#include "BIOSSettingsImpl.h"
37	#include "RecordingSettingsImpl.h"
38	#include "GraphicsAdapterImpl.h"
39	#include "StorageControllerImpl.h" // required for MachineImpl.h to compile on Windows
40	#include "USBControllerImpl.h" // required for MachineImpl.h to compile on Windows
41	#include "BandwidthControlImpl.h"
42	#include "BandwidthGroupImpl.h"
43	#include "TrustedPlatformModuleImpl.h"
44	#include "NvramStoreImpl.h"
45	#ifdef VBOX_WITH_RESOURCE_USAGE_API
46	# include "Performance.h"
47	# include "PerformanceImpl.h"
48	#endif
49	#include "ThreadTask.h"
50
51	// generated header
52	#include "SchemaDefs.h"
53
54	#include "VBox/com/ErrorInfo.h"
55
56	#include <iprt/time.h>
57
58	#include <list>
59	#include <vector>
60
61	#include "MachineWrap.h"
62
63	/** @todo r=klaus after moving the various Machine settings structs to
64	* MachineImpl.cpp it should be possible to eliminate this include. */
65	#include <VBox/settings.h>
66
67	// defines
68	////////////////////////////////////////////////////////////////////////////////
69
70	// helper declarations
71	////////////////////////////////////////////////////////////////////////////////
72
73	class Progress;
74	class ProgressProxy;
75	class Keyboard;
76	class Mouse;
77	class Display;
78	class MachineDebugger;
79	class USBController;
80	class USBDeviceFilters;
81	class Snapshot;
82	class SharedFolder;
83	class HostUSBDevice;
84	class StorageController;
85	class SessionMachine;
86	#ifdef VBOX_WITH_UNATTENDED
87	class Unattended;
88	#endif
89
90	// Machine class
91	////////////////////////////////////////////////////////////////////////////////
92	//
93	class ATL_NO_VTABLE Machine :
94	public MachineWrap
95	{
96
97	public:
98
99	enum StateDependency
100	{
101	AnyStateDep = 0,
102	MutableStateDep,
103	MutableOrSavedStateDep,
104	MutableOrRunningStateDep,
105	MutableOrSavedOrRunningStateDep,
106	};
107
108	/**
109	* Internal machine data.
110	*
111	* Only one instance of this data exists per every machine -- it is shared
112	* by the Machine, SessionMachine and all SnapshotMachine instances
113	* associated with the given machine using the util::Shareable template
114	* through the mData variable.
115	*
116	* @note \|const\| members are persistent during lifetime so can be
117	* accessed without locking.
118	*
119	* @note There is no need to lock anything inside init() or uninit()
120	* methods, because they are always serialized (see AutoCaller).
121	*/
122	struct Data
123	{
124	/**
125	* Data structure to hold information about sessions opened for the
126	* given machine.
127	*/
128	struct Session
129	{
130	/** Type of lock which created this session */
131	LockType_T mLockType;
132
133	/** Control of the direct session opened by lockMachine() */
134	ComPtr<IInternalSessionControl> mDirectControl;
135
136	typedef std::list<ComPtr<IInternalSessionControl> > RemoteControlList;
137
138	/** list of controls of all opened remote sessions */
139	RemoteControlList mRemoteControls;
140
141	/** launchVMProcess() and OnSessionEnd() progress indicator */
142	ComObjPtr<ProgressProxy> mProgress;
143
144	/**
145	* PID of the session object that must be passed to openSession()
146	* to finalize the launchVMProcess() request (i.e., PID of the
147	* process created by launchVMProcess())
148	*/
149	RTPROCESS mPID;
150
151	/** Current session state */
152	SessionState_T mState;
153
154	/** Session name string (of the primary session) */
155	Utf8Str mName;
156
157	/** Session machine object */
158	ComObjPtr<SessionMachine> mMachine;
159
160	/** Medium object lock collection. */
161	MediumLockListMap mLockedMedia;
162	};
163
164	Data();
165	~Data();
166
167	const Guid mUuid;
168	BOOL mRegistered;
169
170	Utf8Str m_strConfigFile;
171	Utf8Str m_strConfigFileFull;
172
173	// machine settings XML file
174	settings::MachineConfigFile *pMachineConfigFile;
175	uint32_t flModifications;
176	bool m_fAllowStateModification;
177
178	BOOL mAccessible;
179	com::ErrorInfo mAccessError;
180
181	MachineState_T mMachineState;
182	RTTIMESPEC mLastStateChange;
183
184	/* Note: These are guarded by VirtualBoxBase::stateLockHandle() */
185	uint32_t mMachineStateDeps;
186	RTSEMEVENTMULTI mMachineStateDepsSem;
187	uint32_t mMachineStateChangePending;
188
189	BOOL mCurrentStateModified;
190	/** Guest properties have been modified and need saving since the
191	* machine was started, or there are transient properties which need
192	* deleting and the machine is being shut down. */
193	BOOL mGuestPropertiesModified;
194
195	Session mSession;
196
197	ComObjPtr<Snapshot> mFirstSnapshot;
198	ComObjPtr<Snapshot> mCurrentSnapshot;
199
200	// list of files to delete in Delete(); this list is filled by Unregister()
201	std::list<Utf8Str> llFilesToDelete;
202	};
203
204	/**
205	* Saved state data.
206	*
207	* It's actually only the state file path string, but it needs to be
208	* separate from Data, because Machine and SessionMachine instances
209	* share it, while SnapshotMachine does not.
210	*
211	* The data variable is \|mSSData\|.
212	*/
213	struct SSData
214	{
215	Utf8Str strStateFilePath;
216	};
217
218	/**
219	* User changeable machine data.
220	*
221	* This data is common for all machine snapshots, i.e. it is shared
222	* by all SnapshotMachine instances associated with the given machine
223	* using the util::Backupable template through the \|mUserData\| variable.
224	*
225	* SessionMachine instances can alter this data and discard changes.
226	*
227	* @note There is no need to lock anything inside init() or uninit()
228	* methods, because they are always serialized (see AutoCaller).
229	*/
230	struct UserData
231	{
232	settings::MachineUserData s;
233	};
234
235	/**
236	* Hardware data.
237	*
238	* This data is unique for a machine and for every machine snapshot.
239	* Stored using the util::Backupable template in the \|mHWData\| variable.
240	*
241	* SessionMachine instances can alter this data and discard changes.
242	*
243	* @todo r=klaus move all "pointer" objects out of this struct, as they
244	* need non-obvious handling when creating a new session or when taking
245	* a snapshot. Better do this right straight away, not relying on the
246	* template magic which doesn't work right in this case.
247	*/
248	struct HWData
249	{
250	/**
251	* Data structure to hold information about a guest property.
252	*/
253	struct GuestProperty {
254	/** Property value */
255	Utf8Str strValue;
256	/** Property timestamp */
257	LONG64 mTimestamp;
258	/** Property flags */
259	ULONG mFlags;
260	};
261
262	HWData();
263	~HWData();
264
265	Bstr mHWVersion;
266	Guid mHardwareUUID; /*< If Null, use mData.mUuid. /
267	ULONG mMemorySize;
268	ULONG mMemoryBalloonSize;
269	BOOL mPageFusionEnabled;
270	settings::RecordingSettings mRecordSettings;
271	BOOL mHWVirtExEnabled;
272	BOOL mHWVirtExNestedPagingEnabled;
273	BOOL mHWVirtExLargePagesEnabled;
274	BOOL mHWVirtExVPIDEnabled;
275	BOOL mHWVirtExUXEnabled;
276	BOOL mHWVirtExForceEnabled;
277	BOOL mHWVirtExUseNativeApi;
278	BOOL mHWVirtExVirtVmsaveVmload;
279	BOOL mPAEEnabled;
280	settings::Hardware::LongModeType mLongMode;
281	BOOL mTripleFaultReset;
282	BOOL mAPIC;
283	BOOL mX2APIC;
284	BOOL mIBPBOnVMExit;
285	BOOL mIBPBOnVMEntry;
286	BOOL mSpecCtrl;
287	BOOL mSpecCtrlByHost;
288	BOOL mL1DFlushOnSched;
289	BOOL mL1DFlushOnVMEntry;
290	BOOL mMDSClearOnSched;
291	BOOL mMDSClearOnVMEntry;
292	BOOL mNestedHWVirt;
293	ULONG mCPUCount;
294	BOOL mCPUHotPlugEnabled;
295	ULONG mCpuExecutionCap;
296	uint32_t mCpuIdPortabilityLevel;
297	Utf8Str mCpuProfile;
298	BOOL mHPETEnabled;
299
300	BOOL mCPUAttached[SchemaDefs::MaxCPUCount];
301
302	std::list<settings::CpuIdLeaf> mCpuIdLeafList;
303
304	DeviceType_T mBootOrder[SchemaDefs::MaxBootPosition];
305
306	typedef std::list<ComObjPtr<SharedFolder> > SharedFolderList;
307	SharedFolderList mSharedFolders;
308
309	ClipboardMode_T mClipboardMode;
310	BOOL mClipboardFileTransfersEnabled;
311
312	DnDMode_T mDnDMode;
313
314	typedef std::map<Utf8Str, GuestProperty> GuestPropertyMap;
315	GuestPropertyMap mGuestProperties;
316
317	FirmwareType_T mFirmwareType;
318	KeyboardHIDType_T mKeyboardHIDType;
319	PointingHIDType_T mPointingHIDType;
320	ChipsetType_T mChipsetType;
321	IommuType_T mIommuType;
322	ParavirtProvider_T mParavirtProvider;
323	Utf8Str mParavirtDebug;
324	BOOL mEmulatedUSBCardReaderEnabled;
325
326	BOOL mIOCacheEnabled;
327	ULONG mIOCacheSize;
328
329	typedef std::list<ComObjPtr<PCIDeviceAttachment> > PCIDeviceAssignmentList;
330	PCIDeviceAssignmentList mPCIDeviceAssignments;
331
332	settings::Debugging mDebugging;
333	settings::Autostart mAutostart;
334
335	Utf8Str mDefaultFrontend;
336	};
337
338	typedef std::list<ComObjPtr<MediumAttachment> > MediumAttachmentList;
339
340	DECLARE_COMMON_CLASS_METHODS(Machine)
341
342	HRESULT FinalConstruct();
343	void FinalRelease();
344
345	// public initializer/uninitializer for internal purposes only:
346
347	// initializer for creating a new, empty machine
348	HRESULT init(VirtualBox *aParent,
349	const Utf8Str &strConfigFile,
350	const Utf8Str &strName,
351	const StringsList &llGroups,
352	const Utf8Str &strOsTypeId,
353	GuestOSType *aOsType,
354	const Guid &aId,
355	bool fForceOverwrite,
356	bool fDirectoryIncludesUUID);
357
358	// initializer for loading existing machine XML (either registered or not)
359	HRESULT initFromSettings(VirtualBox *aParent,
360	const Utf8Str &strConfigFile,
361	const Guid *aId);
362
363	// initializer for machine config in memory (OVF import)
364	HRESULT init(VirtualBox *aParent,
365	const Utf8Str &strName,
366	const Utf8Str &strSettingsFilename,
367	const settings::MachineConfigFile &config);
368
369	void uninit();
370
371	#ifdef VBOX_WITH_RESOURCE_USAGE_API
372	// Needed from VirtualBox, for the delayed metrics cleanup.
373	void i_unregisterMetrics(PerformanceCollector aCollector, Machine aMachine);
374	#endif /* VBOX_WITH_RESOURCE_USAGE_API */
375
376	protected:
377	HRESULT initImpl(VirtualBox *aParent,
378	const Utf8Str &strConfigFile);
379	HRESULT initDataAndChildObjects();
380	HRESULT i_registeredInit();
381	HRESULT i_tryCreateMachineConfigFile(bool fForceOverwrite);
382	void uninitDataAndChildObjects();
383
384	public:
385
386
387	// public methods only for internal purposes
388
389	virtual bool i_isSnapshotMachine() const
390	{
391	return false;
392	}
393
394	virtual bool i_isSessionMachine() const
395	{
396	return false;
397	}
398
399	/**
400	* Override of the default locking class to be used for validating lock
401	* order with the standard member lock handle.
402	*/
403	virtual VBoxLockingClass getLockingClass() const
404	{
405	return LOCKCLASS_MACHINEOBJECT;
406	}
407
408	/// @todo (dmik) add lock and make non-inlined after revising classes
409	// that use it. Note: they should enter Machine lock to keep the returned
410	// information valid!
411	bool i_isRegistered() { return !!mData->mRegistered; }
412
413	// unsafe inline public methods for internal purposes only (ensure there is
414	// a caller and a read lock before calling them!)
415
416	/**
417	* Returns the VirtualBox object this machine belongs to.
418	*
419	* @note This method doesn't check this object's readiness. Intended to be
420	* used by ready Machine children (whose readiness is bound to the parent's
421	* one) or after doing addCaller() manually.
422	*/
423	VirtualBox* i_getVirtualBox() const { return mParent; }
424
425	/**
426	* Checks if this machine is accessible, without attempting to load the
427	* config file.
428	*
429	* @note This method doesn't check this object's readiness. Intended to be
430	* used by ready Machine children (whose readiness is bound to the parent's
431	* one) or after doing addCaller() manually.
432	*/
433	bool i_isAccessible() const { return !!mData->mAccessible; }
434
435	/**
436	* Returns this machine ID.
437	*
438	* @note This method doesn't check this object's readiness. Intended to be
439	* used by ready Machine children (whose readiness is bound to the parent's
440	* one) or after adding a caller manually.
441	*/
442	const Guid& i_getId() const { return mData->mUuid; }
443
444	/**
445	* Returns the snapshot ID this machine represents or an empty UUID if this
446	* instance is not SnapshotMachine.
447	*
448	* @note This method doesn't check this object's readiness. Intended to be
449	* used by ready Machine children (whose readiness is bound to the parent's
450	* one) or after adding a caller manually.
451	*/
452	inline const Guid& i_getSnapshotId() const;
453
454	/**
455	* Returns this machine's full settings file path.
456	*
457	* @note This method doesn't lock this object or check its readiness.
458	* Intended to be used only after doing addCaller() manually and locking it
459	* for reading.
460	*/
461	const Utf8Str& i_getSettingsFileFull() const { return mData->m_strConfigFileFull; }
462
463	/**
464	* Returns this machine name.
465	*
466	* @note This method doesn't lock this object or check its readiness.
467	* Intended to be used only after doing addCaller() manually and locking it
468	* for reading.
469	*/
470	const Utf8Str& i_getName() const { return mUserData->s.strName; }
471
472	enum
473	{
474	IsModified_MachineData = 0x000001,
475	IsModified_Storage = 0x000002,
476	IsModified_NetworkAdapters = 0x000008,
477	IsModified_SerialPorts = 0x000010,
478	IsModified_ParallelPorts = 0x000020,
479	IsModified_VRDEServer = 0x000040,
480	IsModified_AudioAdapter = 0x000080,
481	IsModified_USB = 0x000100,
482	IsModified_BIOS = 0x000200,
483	IsModified_SharedFolders = 0x000400,
484	IsModified_Snapshots = 0x000800,
485	IsModified_BandwidthControl = 0x001000,
486	IsModified_Recording = 0x002000,
487	IsModified_GraphicsAdapter = 0x004000,
488	IsModified_TrustedPlatformModule = 0x008000,
489	IsModified_NvramStore = 0x010000,
490	};
491
492	/**
493	* Returns various information about this machine.
494	*
495	* @note This method doesn't lock this object or check its readiness.
496	* Intended to be used only after doing addCaller() manually and locking it
497	* for reading.
498	*/
499	Utf8Str i_getOSTypeId() const { return mUserData->s.strOsType; }
500	ChipsetType_T i_getChipsetType() const { return mHWData->mChipsetType; }
501	FirmwareType_T i_getFirmwareType() const { return mHWData->mFirmwareType; }
502	ParavirtProvider_T i_getParavirtProvider() const { return mHWData->mParavirtProvider; }
503	Utf8Str i_getParavirtDebug() const { return mHWData->mParavirtDebug; }
504
505	void i_setModified(uint32_t fl, bool fAllowStateModification = true);
506	void i_setModifiedLock(uint32_t fl, bool fAllowStateModification = true);
507
508	MachineState_T i_getMachineState() const { return mData->mMachineState; }
509
510	bool i_isStateModificationAllowed() const { return mData->m_fAllowStateModification; }
511	void i_allowStateModification() { mData->m_fAllowStateModification = true; }
512	void i_disallowStateModification() { mData->m_fAllowStateModification = false; }
513
514	const StringsList &i_getGroups() const { return mUserData->s.llGroups; }
515
516	// callback handlers
517	virtual HRESULT i_onNetworkAdapterChange(INetworkAdapter * /* networkAdapter /, BOOL / changeAdapter */) { return S_OK; }
518	virtual HRESULT i_onNATRedirectRuleChanged(ULONG /* slot /, BOOL / fRemove / , const Utf8Str & / name */,
519	NATProtocol_T /* protocol /, const Utf8Str & / host ip /, LONG / host port */,
520	const Utf8Str & /* guest port /, LONG / guest port */ ) { return S_OK; }
521	virtual HRESULT i_onAudioAdapterChange(IAudioAdapter * /* audioAdapter */) { return S_OK; }
522	virtual HRESULT i_onSerialPortChange(ISerialPort * /* serialPort */) { return S_OK; }
523	virtual HRESULT i_onParallelPortChange(IParallelPort * /* parallelPort */) { return S_OK; }
524	virtual HRESULT i_onVRDEServerChange(BOOL /* aRestart */) { return S_OK; }
525	virtual HRESULT i_onUSBControllerChange() { return S_OK; }
526	virtual HRESULT i_onStorageControllerChange(const com::Guid & /* aMachineId /, const com::Utf8Str & / aControllerName */) { return S_OK; }
527	virtual HRESULT i_onCPUChange(ULONG /* aCPU /, BOOL / aRemove */) { return S_OK; }
528	virtual HRESULT i_onCPUExecutionCapChange(ULONG /* aExecutionCap */) { return S_OK; }
529	virtual HRESULT i_onMediumChange(IMediumAttachment * /* mediumAttachment /, BOOL / force */) { return S_OK; }
530	virtual HRESULT i_onSharedFolderChange() { return S_OK; }
531	virtual HRESULT i_onVMProcessPriorityChange(VMProcPriority_T /* aPriority */) { return S_OK; }
532	virtual HRESULT i_onClipboardModeChange(ClipboardMode_T /* aClipboardMode */) { return S_OK; }
533	virtual HRESULT i_onClipboardFileTransferModeChange(BOOL /* aEnable */) { return S_OK; }
534	virtual HRESULT i_onDnDModeChange(DnDMode_T /* aDnDMode */) { return S_OK; }
535	virtual HRESULT i_onBandwidthGroupChange(IBandwidthGroup * /* aBandwidthGroup */) { return S_OK; }
536	virtual HRESULT i_onStorageDeviceChange(IMediumAttachment * /* mediumAttachment /, BOOL / remove */,
537	BOOL /* silent */) { return S_OK; }
538	virtual HRESULT i_onRecordingChange(BOOL /* aEnable */) { return S_OK; }
539
540	HRESULT i_saveRegistryEntry(settings::MachineRegistryEntry &data);
541
542	int i_calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
543	void i_copyPathRelativeToMachine(const Utf8Str &strSource, Utf8Str &strTarget);
544
545	void i_getLogFolder(Utf8Str &aLogFolder);
546	Utf8Str i_getLogFilename(ULONG idx);
547	Utf8Str i_getHardeningLogFilename(void);
548	Utf8Str i_getDefaultNVRAMFilename();
549	Utf8Str i_getSnapshotNVRAMFilename();
550	SettingsVersion_T i_getSettingsVersion(void);
551
552	void i_composeSavedStateFilename(Utf8Str &strStateFilePath);
553
554	bool i_isUSBControllerPresent();
555
556	HRESULT i_launchVMProcess(IInternalSessionControl *aControl,
557	const Utf8Str &strType,
558	const std::vector<com::Utf8Str> &aEnvironmentChanges,
559	ProgressProxy *aProgress);
560
561	HRESULT i_getDirectControl(ComPtr<IInternalSessionControl> *directControl)
562	{
563	HRESULT rc;
564	*directControl = mData->mSession.mDirectControl;
565
566	if (!*directControl)
567	rc = E_ACCESSDENIED;
568	else
569	rc = S_OK;
570
571	return rc;
572	}
573
574	bool i_isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
575	ComPtr<IInternalSessionControl> *aControl = NULL,
576	bool aRequireVM = false,
577	bool aAllowClosing = false);
578	bool i_isSessionSpawning();
579
580	bool i_isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
581	ComPtr<IInternalSessionControl> *aControl = NULL)
582	{ return i_isSessionOpen(aMachine, aControl, false /* aRequireVM /, true / aAllowClosing */); }
583
584	bool i_isSessionOpenVM(ComObjPtr<SessionMachine> &aMachine,
585	ComPtr<IInternalSessionControl> *aControl = NULL)
586	{ return i_isSessionOpen(aMachine, aControl, true /* aRequireVM /, false / aAllowClosing */); }
587
588	bool i_checkForSpawnFailure();
589
590	HRESULT i_prepareRegister();
591
592	HRESULT i_getSharedFolder(const Utf8Str &aName,
593	ComObjPtr<SharedFolder> &aSharedFolder,
594	bool aSetError = false)
595	{
596	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
597	return i_findSharedFolder(aName, aSharedFolder, aSetError);
598	}
599
600	HRESULT i_addStateDependency(StateDependency aDepType = AnyStateDep,
601	MachineState_T *aState = NULL,
602	BOOL *aRegistered = NULL);
603	void i_releaseStateDependency();
604
605	HRESULT i_getStorageControllerByName(const Utf8Str &aName,
606	ComObjPtr<StorageController> &aStorageController,
607	bool aSetError = false);
608
609	HRESULT i_getMediumAttachmentsOfController(const Utf8Str &aName,
610	MediumAttachmentList &aAttachments);
611
612	HRESULT i_getUSBControllerByName(const Utf8Str &aName,
613	ComObjPtr<USBController> &aUSBController,
614	bool aSetError = false);
615
616	HRESULT i_getBandwidthGroup(const Utf8Str &strBandwidthGroup,
617	ComObjPtr<BandwidthGroup> &pBandwidthGroup,
618	bool fSetError = false)
619	{
620	return mBandwidthControl->i_getBandwidthGroupByName(strBandwidthGroup,
621	pBandwidthGroup,
622	fSetError);
623	}
624
625	static HRESULT i_setErrorStatic(HRESULT aResultCode, const char *pcszMsg, ...);
626
627	protected:
628
629	class ClientToken;
630
631	HRESULT i_checkStateDependency(StateDependency aDepType);
632
633	Machine *i_getMachine();
634
635	void i_ensureNoStateDependencies(AutoWriteLock &alock);
636
637	virtual HRESULT i_setMachineState(MachineState_T aMachineState);
638
639	HRESULT i_findSharedFolder(const Utf8Str &aName,
640	ComObjPtr<SharedFolder> &aSharedFolder,
641	bool aSetError = false);
642
643	HRESULT i_loadSettings(bool aRegistered);
644	HRESULT i_loadMachineDataFromSettings(const settings::MachineConfigFile &config,
645	const Guid *puuidRegistry);
646	HRESULT i_loadSnapshot(const settings::Snapshot &data,
647	const Guid &aCurSnapshotId,
648	Snapshot *aParentSnapshot);
649	HRESULT i_loadHardware(const Guid *puuidRegistry,
650	const Guid *puuidSnapshot,
651	const settings::Hardware &data,
652	const settings::Debugging *pDbg,
653	const settings::Autostart *pAutostart);
654	HRESULT i_loadDebugging(const settings::Debugging *pDbg);
655	HRESULT i_loadAutostart(const settings::Autostart *pAutostart);
656	HRESULT i_loadStorageControllers(const settings::Storage &data,
657	const Guid *puuidRegistry,
658	const Guid *puuidSnapshot);
659	HRESULT i_loadStorageDevices(StorageController *aStorageController,
660	const settings::StorageController &data,
661	const Guid *puuidRegistry,
662	const Guid *puuidSnapshot);
663
664	HRESULT i_findSnapshotById(const Guid &aId,
665	ComObjPtr<Snapshot> &aSnapshot,
666	bool aSetError = false);
667	HRESULT i_findSnapshotByName(const Utf8Str &strName,
668	ComObjPtr<Snapshot> &aSnapshot,
669	bool aSetError = false);
670
671	ULONG i_getUSBControllerCountByType(USBControllerType_T enmType);
672
673	enum
674	{
675	/* flags for #saveSettings() */
676	SaveS_ResetCurStateModified = 0x01,
677	SaveS_Force = 0x04,
678	/* flags for #saveStateSettings() */
679	SaveSTS_CurStateModified = 0x20,
680	SaveSTS_StateFilePath = 0x40,
681	SaveSTS_StateTimeStamp = 0x80
682	};
683
684	HRESULT i_prepareSaveSettings(bool *pfNeedsGlobalSaveSettings,
685	bool *pfSettingsFileIsNew);
686	HRESULT i_saveSettings(bool *pfNeedsGlobalSaveSettings, AutoWriteLock &alock, int aFlags = 0);
687
688	void i_copyMachineDataToSettings(settings::MachineConfigFile &config);
689	HRESULT i_saveAllSnapshots(settings::MachineConfigFile &config);
690	HRESULT i_saveHardware(settings::Hardware &data, settings::Debugging *pDbg,
691	settings::Autostart *pAutostart);
692	HRESULT i_saveStorageControllers(settings::Storage &data);
693	HRESULT i_saveStorageDevices(ComObjPtr<StorageController> aStorageController,
694	settings::StorageController &data);
695	HRESULT i_saveStateSettings(int aFlags);
696
697	void i_addMediumToRegistry(ComObjPtr<Medium> &pMedium);
698
699	HRESULT i_createImplicitDiffs(IProgress *aProgress,
700	ULONG aWeight,
701	bool aOnline);
702	HRESULT i_deleteImplicitDiffs(bool aOnline);
703
704	MediumAttachment* i_findAttachment(const MediumAttachmentList &ll,
705	const Utf8Str &aControllerName,
706	LONG aControllerPort,
707	LONG aDevice);
708	MediumAttachment* i_findAttachment(const MediumAttachmentList &ll,
709	ComObjPtr<Medium> pMedium);
710	MediumAttachment* i_findAttachment(const MediumAttachmentList &ll,
711	Guid &id);
712
713	HRESULT i_detachDevice(MediumAttachment *pAttach,
714	AutoWriteLock &writeLock,
715	Snapshot *pSnapshot);
716
717	HRESULT i_detachAllMedia(AutoWriteLock &writeLock,
718	Snapshot *pSnapshot,
719	CleanupMode_T cleanupMode,
720	MediaList &llMedia);
721
722	void i_commitMedia(bool aOnline = false);
723	void i_rollbackMedia();
724
725	bool i_isInOwnDir(Utf8Str *aSettingsDir = NULL) const;
726
727	void i_rollback(bool aNotify);
728	void i_commit();
729	void i_copyFrom(Machine *aThat);
730	bool i_isControllerHotplugCapable(StorageControllerType_T enmCtrlType);
731
732	Utf8Str i_getExtraData(const Utf8Str &strKey);
733
734	com::Utf8Str i_controllerNameFromBusType(StorageBus_T aBusType);
735
736	#ifdef VBOX_WITH_GUEST_PROPS
737	HRESULT i_getGuestPropertyFromService(const com::Utf8Str &aName, com::Utf8Str &aValue,
738	LONG64 *aTimestamp, com::Utf8Str &aFlags) const;
739	HRESULT i_setGuestPropertyToService(const com::Utf8Str &aName, const com::Utf8Str &aValue,
740	const com::Utf8Str &aFlags, bool fDelete);
741	HRESULT i_getGuestPropertyFromVM(const com::Utf8Str &aName, com::Utf8Str &aValue,
742	LONG64 *aTimestamp, com::Utf8Str &aFlags) const;
743	HRESULT i_setGuestPropertyToVM(const com::Utf8Str &aName, const com::Utf8Str &aValue,
744	const com::Utf8Str &aFlags, bool fDelete);
745	HRESULT i_enumerateGuestPropertiesInService(const com::Utf8Str &aPatterns,
746	std::vector<com::Utf8Str> &aNames,
747	std::vector<com::Utf8Str> &aValues,
748	std::vector<LONG64> &aTimestamps,
749	std::vector<com::Utf8Str> &aFlags);
750	HRESULT i_enumerateGuestPropertiesOnVM(const com::Utf8Str &aPatterns,
751	std::vector<com::Utf8Str> &aNames,
752	std::vector<com::Utf8Str> &aValues,
753	std::vector<LONG64> &aTimestamps,
754	std::vector<com::Utf8Str> &aFlags);
755
756	#endif /* VBOX_WITH_GUEST_PROPS */
757
758	#ifdef VBOX_WITH_RESOURCE_USAGE_API
759	void i_getDiskList(MediaList &list);
760	void i_registerMetrics(PerformanceCollector aCollector, Machine aMachine, RTPROCESS pid);
761
762	pm::CollectorGuest *mCollectorGuest;
763	#endif /* VBOX_WITH_RESOURCE_USAGE_API */
764
765	Machine * const mPeer;
766
767	VirtualBox * const mParent;
768
769	Shareable<Data> mData;
770	Shareable<SSData> mSSData;
771
772	Backupable<UserData> mUserData;
773	Backupable<HWData> mHWData;
774
775	/**
776	* Hard disk and other media data.
777	*
778	* The usage policy is the same as for mHWData, but a separate field
779	* is necessary because hard disk data requires different procedures when
780	* taking or deleting snapshots, etc.
781	*
782	* @todo r=klaus change this to a regular list and use the normal way to
783	* handle the settings when creating a session or taking a snapshot.
784	* Same thing applies to mStorageControllers and mUSBControllers.
785	*/
786	Backupable<MediumAttachmentList> mMediumAttachments;
787
788	// the following fields need special backup/rollback/commit handling,
789	// so they cannot be a part of HWData
790
791	const ComObjPtr<VRDEServer> mVRDEServer;
792	const ComObjPtr<SerialPort> mSerialPorts[SchemaDefs::SerialPortCount];
793	const ComObjPtr<ParallelPort> mParallelPorts[SchemaDefs::ParallelPortCount];
794	const ComObjPtr<AudioAdapter> mAudioAdapter;
795	const ComObjPtr<USBDeviceFilters> mUSBDeviceFilters;
796	const ComObjPtr<BIOSSettings> mBIOSSettings;
797	const ComObjPtr<RecordingSettings> mRecordingSettings;
798	const ComObjPtr<GraphicsAdapter> mGraphicsAdapter;
799	const ComObjPtr<BandwidthControl> mBandwidthControl;
800
801	const ComObjPtr<TrustedPlatformModule> mTrustedPlatformModule;
802	const ComObjPtr<NvramStore> mNvramStore;
803
804	typedef std::vector<ComObjPtr<NetworkAdapter> > NetworkAdapterVector;
805	NetworkAdapterVector mNetworkAdapters;
806
807	typedef std::list<ComObjPtr<StorageController> > StorageControllerList;
808	Backupable<StorageControllerList> mStorageControllers;
809
810	typedef std::list<ComObjPtr<USBController> > USBControllerList;
811	Backupable<USBControllerList> mUSBControllers;
812
813	uint64_t uRegistryNeedsSaving;
814
815	/**
816	* Abstract base class for all Machine or SessionMachine related
817	* asynchronous tasks. This is necessary since RTThreadCreate cannot call
818	* a (non-static) method as its thread function, so instead we have it call
819	* the static Machine::taskHandler, which then calls the handler() method
820	* in here (implemented by the subclasses).
821	*/
822	class Task : public ThreadTask
823	{
824	public:
825	Task(Machine m, Progress p, const Utf8Str &t)
826	: ThreadTask(t),
827	m_pMachine(m),
828	m_machineCaller(m),
829	m_pProgress(p),
830	m_machineStateBackup(m->mData->mMachineState) // save the current machine state
831	{}
832	virtual ~Task(){}
833
834	void modifyBackedUpState(MachineState_T s)
835	{
836	const_cast<MachineState_T >(&m_machineStateBackup) = s;
837	}
838
839	ComObjPtr<Machine> m_pMachine;
840	AutoCaller m_machineCaller;
841	ComObjPtr<Progress> m_pProgress;
842	const MachineState_T m_machineStateBackup;
843	};
844
845	class DeleteConfigTask;
846	void i_deleteConfigHandler(DeleteConfigTask &task);
847
848	friend class Appliance;
849	friend class RecordingSettings;
850	friend class RecordingScreenSettings;
851	friend class SessionMachine;
852	friend class SnapshotMachine;
853	friend class VirtualBox;
854
855	friend class MachineCloneVM;
856	friend class MachineMoveVM;
857	private:
858	// wrapped IMachine properties
859	HRESULT getParent(ComPtr<IVirtualBox> &aParent);
860	HRESULT getIcon(std::vector<BYTE> &aIcon);
861	HRESULT setIcon(const std::vector<BYTE> &aIcon);
862	HRESULT getAccessible(BOOL *aAccessible);
863	HRESULT getAccessError(ComPtr<IVirtualBoxErrorInfo> &aAccessError);
864	HRESULT getName(com::Utf8Str &aName);
865	HRESULT setName(const com::Utf8Str &aName);
866	HRESULT getDescription(com::Utf8Str &aDescription);
867	HRESULT setDescription(const com::Utf8Str &aDescription);
868	HRESULT getId(com::Guid &aId);
869	HRESULT getGroups(std::vector<com::Utf8Str> &aGroups);
870	HRESULT setGroups(const std::vector<com::Utf8Str> &aGroups);
871	HRESULT getOSTypeId(com::Utf8Str &aOSTypeId);
872	HRESULT setOSTypeId(const com::Utf8Str &aOSTypeId);
873	HRESULT getHardwareVersion(com::Utf8Str &aHardwareVersion);
874	HRESULT setHardwareVersion(const com::Utf8Str &aHardwareVersion);
875	HRESULT getHardwareUUID(com::Guid &aHardwareUUID);
876	HRESULT setHardwareUUID(const com::Guid &aHardwareUUID);
877	HRESULT getCPUCount(ULONG *aCPUCount);
878	HRESULT setCPUCount(ULONG aCPUCount);
879	HRESULT getCPUHotPlugEnabled(BOOL *aCPUHotPlugEnabled);
880	HRESULT setCPUHotPlugEnabled(BOOL aCPUHotPlugEnabled);
881	HRESULT getCPUExecutionCap(ULONG *aCPUExecutionCap);
882	HRESULT setCPUExecutionCap(ULONG aCPUExecutionCap);
883	HRESULT getCPUIDPortabilityLevel(ULONG *aCPUIDPortabilityLevel);
884	HRESULT setCPUIDPortabilityLevel(ULONG aCPUIDPortabilityLevel);
885	HRESULT getCPUProfile(com::Utf8Str &aCPUProfile);
886	HRESULT setCPUProfile(const com::Utf8Str &aCPUProfile);
887	HRESULT getMemorySize(ULONG *aMemorySize);
888	HRESULT setMemorySize(ULONG aMemorySize);
889	HRESULT getMemoryBalloonSize(ULONG *aMemoryBalloonSize);
890	HRESULT setMemoryBalloonSize(ULONG aMemoryBalloonSize);
891	HRESULT getPageFusionEnabled(BOOL *aPageFusionEnabled);
892	HRESULT setPageFusionEnabled(BOOL aPageFusionEnabled);
893	HRESULT getGraphicsAdapter(ComPtr<IGraphicsAdapter> &aGraphicsAdapter);
894	HRESULT getBIOSSettings(ComPtr<IBIOSSettings> &aBIOSSettings);
895	HRESULT getTrustedPlatformModule(ComPtr<ITrustedPlatformModule> &aTrustedPlatformModule);
896	HRESULT getNonVolatileStore(ComPtr<INvramStore> &aNvramStore);
897	HRESULT getRecordingSettings(ComPtr<IRecordingSettings> &aRecordingSettings);
898	HRESULT getFirmwareType(FirmwareType_T *aFirmwareType);
899	HRESULT setFirmwareType(FirmwareType_T aFirmwareType);
900	HRESULT getPointingHIDType(PointingHIDType_T *aPointingHIDType);
901	HRESULT setPointingHIDType(PointingHIDType_T aPointingHIDType);
902	HRESULT getKeyboardHIDType(KeyboardHIDType_T *aKeyboardHIDType);
903	HRESULT setKeyboardHIDType(KeyboardHIDType_T aKeyboardHIDType);
904	HRESULT getHPETEnabled(BOOL *aHPETEnabled);
905	HRESULT setHPETEnabled(BOOL aHPETEnabled);
906	HRESULT getChipsetType(ChipsetType_T *aChipsetType);
907	HRESULT setChipsetType(ChipsetType_T aChipsetType);
908	HRESULT getIommuType(IommuType_T *aIommuType);
909	HRESULT setIommuType(IommuType_T aIommuType);
910	HRESULT getSnapshotFolder(com::Utf8Str &aSnapshotFolder);
911	HRESULT setSnapshotFolder(const com::Utf8Str &aSnapshotFolder);
912	HRESULT getVRDEServer(ComPtr<IVRDEServer> &aVRDEServer);
913	HRESULT getEmulatedUSBCardReaderEnabled(BOOL *aEmulatedUSBCardReaderEnabled);
914	HRESULT setEmulatedUSBCardReaderEnabled(BOOL aEmulatedUSBCardReaderEnabled);
915	HRESULT getMediumAttachments(std::vector<ComPtr<IMediumAttachment> > &aMediumAttachments);
916	HRESULT getUSBControllers(std::vector<ComPtr<IUSBController> > &aUSBControllers);
917	HRESULT getUSBDeviceFilters(ComPtr<IUSBDeviceFilters> &aUSBDeviceFilters);
918	HRESULT getAudioAdapter(ComPtr<IAudioAdapter> &aAudioAdapter);
919	HRESULT getStorageControllers(std::vector<ComPtr<IStorageController> > &aStorageControllers);
920	HRESULT getSettingsFilePath(com::Utf8Str &aSettingsFilePath);
921	HRESULT getSettingsAuxFilePath(com::Utf8Str &aSettingsAuxFilePath);
922	HRESULT getSettingsModified(BOOL *aSettingsModified);
923	HRESULT getSessionState(SessionState_T *aSessionState);
924	HRESULT getSessionType(SessionType_T *aSessionType);
925	HRESULT getSessionName(com::Utf8Str &aSessionType);
926	HRESULT getSessionPID(ULONG *aSessionPID);
927	HRESULT getState(MachineState_T *aState);
928	HRESULT getLastStateChange(LONG64 *aLastStateChange);
929	HRESULT getStateFilePath(com::Utf8Str &aStateFilePath);
930	HRESULT getLogFolder(com::Utf8Str &aLogFolder);
931	HRESULT getCurrentSnapshot(ComPtr<ISnapshot> &aCurrentSnapshot);
932	HRESULT getSnapshotCount(ULONG *aSnapshotCount);
933	HRESULT getCurrentStateModified(BOOL *aCurrentStateModified);
934	HRESULT getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders);
935	HRESULT getClipboardMode(ClipboardMode_T *aClipboardMode);
936	HRESULT setClipboardMode(ClipboardMode_T aClipboardMode);
937	HRESULT getClipboardFileTransfersEnabled(BOOL *aEnabled);
938	HRESULT setClipboardFileTransfersEnabled(BOOL aEnabled);
939	HRESULT getDnDMode(DnDMode_T *aDnDMode);
940	HRESULT setDnDMode(DnDMode_T aDnDMode);
941	HRESULT getTeleporterEnabled(BOOL *aTeleporterEnabled);
942	HRESULT setTeleporterEnabled(BOOL aTeleporterEnabled);
943	HRESULT getTeleporterPort(ULONG *aTeleporterPort);
944	HRESULT setTeleporterPort(ULONG aTeleporterPort);
945	HRESULT getTeleporterAddress(com::Utf8Str &aTeleporterAddress);
946	HRESULT setTeleporterAddress(const com::Utf8Str &aTeleporterAddress);
947	HRESULT getTeleporterPassword(com::Utf8Str &aTeleporterPassword);
948	HRESULT setTeleporterPassword(const com::Utf8Str &aTeleporterPassword);
949	HRESULT getParavirtProvider(ParavirtProvider_T *aParavirtProvider);
950	HRESULT setParavirtProvider(ParavirtProvider_T aParavirtProvider);
951	HRESULT getParavirtDebug(com::Utf8Str &aParavirtDebug);
952	HRESULT setParavirtDebug(const com::Utf8Str &aParavirtDebug);
953	HRESULT getRTCUseUTC(BOOL *aRTCUseUTC);
954	HRESULT setRTCUseUTC(BOOL aRTCUseUTC);
955	HRESULT getIOCacheEnabled(BOOL *aIOCacheEnabled);
956	HRESULT setIOCacheEnabled(BOOL aIOCacheEnabled);
957	HRESULT getIOCacheSize(ULONG *aIOCacheSize);
958	HRESULT setIOCacheSize(ULONG aIOCacheSize);
959	HRESULT getPCIDeviceAssignments(std::vector<ComPtr<IPCIDeviceAttachment> > &aPCIDeviceAssignments);
960	HRESULT getBandwidthControl(ComPtr<IBandwidthControl> &aBandwidthControl);
961	HRESULT getTracingEnabled(BOOL *aTracingEnabled);
962	HRESULT setTracingEnabled(BOOL aTracingEnabled);
963	HRESULT getTracingConfig(com::Utf8Str &aTracingConfig);
964	HRESULT setTracingConfig(const com::Utf8Str &aTracingConfig);
965	HRESULT getAllowTracingToAccessVM(BOOL *aAllowTracingToAccessVM);
966	HRESULT setAllowTracingToAccessVM(BOOL aAllowTracingToAccessVM);
967	HRESULT getAutostartEnabled(BOOL *aAutostartEnabled);
968	HRESULT setAutostartEnabled(BOOL aAutostartEnabled);
969	HRESULT getAutostartDelay(ULONG *aAutostartDelay);
970	HRESULT setAutostartDelay(ULONG aAutostartDelay);
971	HRESULT getAutostopType(AutostopType_T *aAutostopType);
972	HRESULT setAutostopType(AutostopType_T aAutostopType);
973	HRESULT getDefaultFrontend(com::Utf8Str &aDefaultFrontend);
974	HRESULT setDefaultFrontend(const com::Utf8Str &aDefaultFrontend);
975	HRESULT getUSBProxyAvailable(BOOL *aUSBProxyAvailable);
976	HRESULT getVMProcessPriority(VMProcPriority_T *aVMProcessPriority);
977	HRESULT setVMProcessPriority(VMProcPriority_T aVMProcessPriority);
978
979	// wrapped IMachine methods
980	HRESULT lockMachine(const ComPtr<ISession> &aSession,
981	LockType_T aLockType);
982	HRESULT launchVMProcess(const ComPtr<ISession> &aSession,
983	const com::Utf8Str &aType,
984	const std::vector<com::Utf8Str> &aEnvironmentChanges,
985	ComPtr<IProgress> &aProgress);
986	HRESULT setBootOrder(ULONG aPosition,
987	DeviceType_T aDevice);
988	HRESULT getBootOrder(ULONG aPosition,
989	DeviceType_T *aDevice);
990	HRESULT attachDevice(const com::Utf8Str &aName,
991	LONG aControllerPort,
992	LONG aDevice,
993	DeviceType_T aType,
994	const ComPtr<IMedium> &aMedium);
995	HRESULT attachDeviceWithoutMedium(const com::Utf8Str &aName,
996	LONG aControllerPort,
997	LONG aDevice,
998	DeviceType_T aType);
999	HRESULT detachDevice(const com::Utf8Str &aName,
1000	LONG aControllerPort,
1001	LONG aDevice);
1002	HRESULT passthroughDevice(const com::Utf8Str &aName,
1003	LONG aControllerPort,
1004	LONG aDevice,
1005	BOOL aPassthrough);
1006	HRESULT temporaryEjectDevice(const com::Utf8Str &aName,
1007	LONG aControllerPort,
1008	LONG aDevice,
1009	BOOL aTemporaryEject);
1010	HRESULT nonRotationalDevice(const com::Utf8Str &aName,
1011	LONG aControllerPort,
1012	LONG aDevice,
1013	BOOL aNonRotational);
1014	HRESULT setAutoDiscardForDevice(const com::Utf8Str &aName,
1015	LONG aControllerPort,
1016	LONG aDevice,
1017	BOOL aDiscard);
1018	HRESULT setHotPluggableForDevice(const com::Utf8Str &aName,
1019	LONG aControllerPort,
1020	LONG aDevice,
1021	BOOL aHotPluggable);
1022	HRESULT setBandwidthGroupForDevice(const com::Utf8Str &aName,
1023	LONG aControllerPort,
1024	LONG aDevice,
1025	const ComPtr<IBandwidthGroup> &aBandwidthGroup);
1026	HRESULT setNoBandwidthGroupForDevice(const com::Utf8Str &aName,
1027	LONG aControllerPort,
1028	LONG aDevice);
1029	HRESULT unmountMedium(const com::Utf8Str &aName,
1030	LONG aControllerPort,
1031	LONG aDevice,
1032	BOOL aForce);
1033	HRESULT mountMedium(const com::Utf8Str &aName,
1034	LONG aControllerPort,
1035	LONG aDevice,
1036	const ComPtr<IMedium> &aMedium,
1037	BOOL aForce);
1038	HRESULT getMedium(const com::Utf8Str &aName,
1039	LONG aControllerPort,
1040	LONG aDevice,
1041	ComPtr<IMedium> &aMedium);
1042	HRESULT getMediumAttachmentsOfController(const com::Utf8Str &aName,
1043	std::vector<ComPtr<IMediumAttachment> > &aMediumAttachments);
1044	HRESULT getMediumAttachment(const com::Utf8Str &aName,
1045	LONG aControllerPort,
1046	LONG aDevice,
1047	ComPtr<IMediumAttachment> &aAttachment);
1048	HRESULT attachHostPCIDevice(LONG aHostAddress,
1049	LONG aDesiredGuestAddress,
1050	BOOL aTryToUnbind);
1051	HRESULT detachHostPCIDevice(LONG aHostAddress);
1052	HRESULT getNetworkAdapter(ULONG aSlot,
1053	ComPtr<INetworkAdapter> &aAdapter);
1054	HRESULT addStorageController(const com::Utf8Str &aName,
1055	StorageBus_T aConnectionType,
1056	ComPtr<IStorageController> &aController);
1057	HRESULT getStorageControllerByName(const com::Utf8Str &aName,
1058	ComPtr<IStorageController> &aStorageController);
1059	HRESULT getStorageControllerByInstance(StorageBus_T aConnectionType,
1060	ULONG aInstance,
1061	ComPtr<IStorageController> &aStorageController);
1062	HRESULT removeStorageController(const com::Utf8Str &aName);
1063	HRESULT setStorageControllerBootable(const com::Utf8Str &aName,
1064	BOOL aBootable);
1065	HRESULT addUSBController(const com::Utf8Str &aName,
1066	USBControllerType_T aType,
1067	ComPtr<IUSBController> &aController);
1068	HRESULT removeUSBController(const com::Utf8Str &aName);
1069	HRESULT getUSBControllerByName(const com::Utf8Str &aName,
1070	ComPtr<IUSBController> &aController);
1071	HRESULT getUSBControllerCountByType(USBControllerType_T aType,
1072	ULONG *aControllers);
1073	HRESULT getSerialPort(ULONG aSlot,
1074	ComPtr<ISerialPort> &aPort);
1075	HRESULT getParallelPort(ULONG aSlot,
1076	ComPtr<IParallelPort> &aPort);
1077	HRESULT getExtraDataKeys(std::vector<com::Utf8Str> &aKeys);
1078	HRESULT getExtraData(const com::Utf8Str &aKey,
1079	com::Utf8Str &aValue);
1080	HRESULT setExtraData(const com::Utf8Str &aKey,
1081	const com::Utf8Str &aValue);
1082	HRESULT getCPUProperty(CPUPropertyType_T aProperty,
1083	BOOL *aValue);
1084	HRESULT setCPUProperty(CPUPropertyType_T aProperty,
1085	BOOL aValue);
1086	HRESULT getCPUIDLeafByOrdinal(ULONG aOrdinal,
1087	ULONG *aIdx,
1088	ULONG *aSubIdx,
1089	ULONG *aValEax,
1090	ULONG *aValEbx,
1091	ULONG *aValEcx,
1092	ULONG *aValEdx);
1093	HRESULT getCPUIDLeaf(ULONG aIdx, ULONG aSubIdx,
1094	ULONG *aValEax,
1095	ULONG *aValEbx,
1096	ULONG *aValEcx,
1097	ULONG *aValEdx);
1098	HRESULT setCPUIDLeaf(ULONG aIdx, ULONG aSubIdx,
1099	ULONG aValEax,
1100	ULONG aValEbx,
1101	ULONG aValEcx,
1102	ULONG aValEdx);
1103	HRESULT removeCPUIDLeaf(ULONG aIdx, ULONG aSubIdx);
1104	HRESULT removeAllCPUIDLeaves();
1105	HRESULT getHWVirtExProperty(HWVirtExPropertyType_T aProperty,
1106	BOOL *aValue);
1107	HRESULT setHWVirtExProperty(HWVirtExPropertyType_T aProperty,
1108	BOOL aValue);
1109	HRESULT setSettingsFilePath(const com::Utf8Str &aSettingsFilePath,
1110	ComPtr<IProgress> &aProgress);
1111	HRESULT saveSettings();
1112	HRESULT discardSettings();
1113	HRESULT unregister(AutoCaller &aAutoCaller,
1114	CleanupMode_T aCleanupMode,
1115	std::vector<ComPtr<IMedium> > &aMedia);
1116	HRESULT deleteConfig(const std::vector<ComPtr<IMedium> > &aMedia,
1117	ComPtr<IProgress> &aProgress);
1118	HRESULT exportTo(const ComPtr<IAppliance> &aAppliance,
1119	const com::Utf8Str &aLocation,
1120	ComPtr<IVirtualSystemDescription> &aDescription);
1121	HRESULT findSnapshot(const com::Utf8Str &aNameOrId,
1122	ComPtr<ISnapshot> &aSnapshot);
1123	HRESULT createSharedFolder(const com::Utf8Str &aName,
1124	const com::Utf8Str &aHostPath,
1125	BOOL aWritable,
1126	BOOL aAutomount,
1127	const com::Utf8Str &aAutoMountPoint);
1128	HRESULT removeSharedFolder(const com::Utf8Str &aName);
1129	HRESULT canShowConsoleWindow(BOOL *aCanShow);
1130	HRESULT showConsoleWindow(LONG64 *aWinId);
1131	HRESULT getGuestProperty(const com::Utf8Str &aName,
1132	com::Utf8Str &aValue,
1133	LONG64 *aTimestamp,
1134	com::Utf8Str &aFlags);
1135	HRESULT getGuestPropertyValue(const com::Utf8Str &aProperty,
1136	com::Utf8Str &aValue);
1137	HRESULT getGuestPropertyTimestamp(const com::Utf8Str &aProperty,
1138	LONG64 *aValue);
1139	HRESULT setGuestProperty(const com::Utf8Str &aProperty,
1140	const com::Utf8Str &aValue,
1141	const com::Utf8Str &aFlags);
1142	HRESULT setGuestPropertyValue(const com::Utf8Str &aProperty,
1143	const com::Utf8Str &aValue);
1144	HRESULT deleteGuestProperty(const com::Utf8Str &aName);
1145	HRESULT enumerateGuestProperties(const com::Utf8Str &aPatterns,
1146	std::vector<com::Utf8Str> &aNames,
1147	std::vector<com::Utf8Str> &aValues,
1148	std::vector<LONG64> &aTimestamps,
1149	std::vector<com::Utf8Str> &aFlags);
1150	HRESULT querySavedGuestScreenInfo(ULONG aScreenId,
1151	ULONG *aOriginX,
1152	ULONG *aOriginY,
1153	ULONG *aWidth,
1154	ULONG *aHeight,
1155	BOOL *aEnabled);
1156	HRESULT readSavedThumbnailToArray(ULONG aScreenId,
1157	BitmapFormat_T aBitmapFormat,
1158	ULONG *aWidth,
1159	ULONG *aHeight,
1160	std::vector<BYTE> &aData);
1161	HRESULT querySavedScreenshotInfo(ULONG aScreenId,
1162	ULONG *aWidth,
1163	ULONG *aHeight,
1164	std::vector<BitmapFormat_T> &aBitmapFormats);
1165	HRESULT readSavedScreenshotToArray(ULONG aScreenId,
1166	BitmapFormat_T aBitmapFormat,
1167	ULONG *aWidth,
1168	ULONG *aHeight,
1169	std::vector<BYTE> &aData);
1170
1171	HRESULT hotPlugCPU(ULONG aCpu);
1172	HRESULT hotUnplugCPU(ULONG aCpu);
1173	HRESULT getCPUStatus(ULONG aCpu,
1174	BOOL *aAttached);
1175	HRESULT getEffectiveParavirtProvider(ParavirtProvider_T *aParavirtProvider);
1176	HRESULT queryLogFilename(ULONG aIdx,
1177	com::Utf8Str &aFilename);
1178	HRESULT readLog(ULONG aIdx,
1179	LONG64 aOffset,
1180	LONG64 aSize,
1181	std::vector<BYTE> &aData);
1182	HRESULT cloneTo(const ComPtr<IMachine> &aTarget,
1183	CloneMode_T aMode,
1184	const std::vector<CloneOptions_T> &aOptions,
1185	ComPtr<IProgress> &aProgress);
1186	HRESULT moveTo(const com::Utf8Str &aTargetPath,
1187	const com::Utf8Str &aType,
1188	ComPtr<IProgress> &aProgress);
1189	HRESULT saveState(ComPtr<IProgress> &aProgress);
1190	HRESULT adoptSavedState(const com::Utf8Str &aSavedStateFile);
1191	HRESULT discardSavedState(BOOL aFRemoveFile);
1192	HRESULT takeSnapshot(const com::Utf8Str &aName,
1193	const com::Utf8Str &aDescription,
1194	BOOL aPause,
1195	com::Guid &aId,
1196	ComPtr<IProgress> &aProgress);
1197	HRESULT deleteSnapshot(const com::Guid &aId,
1198	ComPtr<IProgress> &aProgress);
1199	HRESULT deleteSnapshotAndAllChildren(const com::Guid &aId,
1200	ComPtr<IProgress> &aProgress);
1201	HRESULT deleteSnapshotRange(const com::Guid &aStartId,
1202	const com::Guid &aEndId,
1203	ComPtr<IProgress> &aProgress);
1204	HRESULT restoreSnapshot(const ComPtr<ISnapshot> &aSnapshot,
1205	ComPtr<IProgress> &aProgress);
1206	HRESULT applyDefaults(const com::Utf8Str &aFlags);
1207
1208	// wrapped IInternalMachineControl properties
1209
1210	// wrapped IInternalMachineControl methods
1211	HRESULT updateState(MachineState_T aState);
1212	HRESULT beginPowerUp(const ComPtr<IProgress> &aProgress);
1213	HRESULT endPowerUp(LONG aResult);
1214	HRESULT beginPoweringDown(ComPtr<IProgress> &aProgress);
1215	HRESULT endPoweringDown(LONG aResult,
1216	const com::Utf8Str &aErrMsg);
1217	HRESULT runUSBDeviceFilters(const ComPtr<IUSBDevice> &aDevice,
1218	BOOL *aMatched,
1219	ULONG *aMaskedInterfaces);
1220	HRESULT captureUSBDevice(const com::Guid &aId,
1221	const com::Utf8Str &aCaptureFilename);
1222	HRESULT detachUSBDevice(const com::Guid &aId,
1223	BOOL aDone);
1224	HRESULT autoCaptureUSBDevices();
1225	HRESULT detachAllUSBDevices(BOOL aDone);
1226	HRESULT onSessionEnd(const ComPtr<ISession> &aSession,
1227	ComPtr<IProgress> &aProgress);
1228	HRESULT finishOnlineMergeMedium();
1229	HRESULT pullGuestProperties(std::vector<com::Utf8Str> &aNames,
1230	std::vector<com::Utf8Str> &aValues,
1231	std::vector<LONG64> &aTimestamps,
1232	std::vector<com::Utf8Str> &aFlags);
1233	HRESULT pushGuestProperty(const com::Utf8Str &aName,
1234	const com::Utf8Str &aValue,
1235	LONG64 aTimestamp,
1236	const com::Utf8Str &aFlags,
1237	BOOL fWasDeleted);
1238	HRESULT lockMedia();
1239	HRESULT unlockMedia();
1240	HRESULT ejectMedium(const ComPtr<IMediumAttachment> &aAttachment,
1241	ComPtr<IMediumAttachment> &aNewAttachment);
1242	HRESULT reportVmStatistics(ULONG aValidStats,
1243	ULONG aCpuUser,
1244	ULONG aCpuKernel,
1245	ULONG aCpuIdle,
1246	ULONG aMemTotal,
1247	ULONG aMemFree,
1248	ULONG aMemBalloon,
1249	ULONG aMemShared,
1250	ULONG aMemCache,
1251	ULONG aPagedTotal,
1252	ULONG aMemAllocTotal,
1253	ULONG aMemFreeTotal,
1254	ULONG aMemBalloonTotal,
1255	ULONG aMemSharedTotal,
1256	ULONG aVmNetRx,
1257	ULONG aVmNetTx);
1258	HRESULT authenticateExternal(const std::vector<com::Utf8Str> &aAuthParams,
1259	com::Utf8Str &aResult);
1260	};
1261
1262	// SessionMachine class
1263	////////////////////////////////////////////////////////////////////////////////
1264
1265	/**
1266	* @note Notes on locking objects of this class:
1267	* SessionMachine shares some data with the primary Machine instance (pointed
1268	* to by the \|mPeer\| member). In order to provide data consistency it also
1269	* shares its lock handle. This means that whenever you lock a SessionMachine
1270	* instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
1271	* instance is also locked in the same lock mode. Keep it in mind.
1272	*/
1273	class ATL_NO_VTABLE SessionMachine :
1274	public Machine
1275	{
1276	public:
1277	VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SessionMachine, IMachine)
1278
1279	DECLARE_NOT_AGGREGATABLE(SessionMachine)
1280
1281	DECLARE_PROTECT_FINAL_CONSTRUCT()
1282
1283	BEGIN_COM_MAP(SessionMachine)
1284	COM_INTERFACE_ENTRY(ISupportErrorInfo)
1285	COM_INTERFACE_ENTRY(IMachine)
1286	COM_INTERFACE_ENTRY2(IDispatch, IMachine)
1287	COM_INTERFACE_ENTRY(IInternalMachineControl)
1288	VBOX_TWEAK_INTERFACE_ENTRY(IMachine)
1289	END_COM_MAP()
1290
1291	DECLARE_COMMON_CLASS_METHODS(SessionMachine)
1292
1293	HRESULT FinalConstruct();
1294	void FinalRelease();
1295
1296	struct Uninit
1297	{
1298	enum Reason { Unexpected, Abnormal, Normal };
1299	};
1300
1301	// public initializer/uninitializer for internal purposes only
1302	HRESULT init(Machine *aMachine);
1303	void uninit() { uninit(Uninit::Unexpected); }
1304	void uninit(Uninit::Reason aReason);
1305
1306
1307	// util::Lockable interface
1308	RWLockHandle *lockHandle() const;
1309
1310	// public methods only for internal purposes
1311
1312	virtual bool i_isSessionMachine() const
1313	{
1314	return true;
1315	}
1316
1317	#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
1318	bool i_checkForDeath();
1319
1320	void i_getTokenId(Utf8Str &strTokenId);
1321	#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
1322	IToken *i_getToken();
1323	#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
1324	// getClientToken must be only used by callers who can guarantee that
1325	// the object cannot be deleted in the mean time, i.e. have a caller/lock.
1326	ClientToken *i_getClientToken();
1327
1328	HRESULT i_onNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter);
1329	HRESULT i_onNATRedirectRuleChanged(ULONG ulSlot, BOOL aNatRuleRemove, const Utf8Str &aRuleName,
1330	NATProtocol_T aProto, const Utf8Str &aHostIp, LONG aHostPort,
1331	const Utf8Str &aGuestIp, LONG aGuestPort) RT_OVERRIDE;
1332	HRESULT i_onStorageControllerChange(const com::Guid &aMachineId, const com::Utf8Str &aControllerName);
1333	HRESULT i_onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);
1334	HRESULT i_onVMProcessPriorityChange(VMProcPriority_T aPriority);
1335	HRESULT i_onAudioAdapterChange(IAudioAdapter *audioAdapter);
1336	HRESULT i_onSerialPortChange(ISerialPort *serialPort);
1337	HRESULT i_onParallelPortChange(IParallelPort *parallelPort);
1338	HRESULT i_onCPUChange(ULONG aCPU, BOOL aRemove);
1339	HRESULT i_onVRDEServerChange(BOOL aRestart);
1340	HRESULT i_onRecordingChange(BOOL aEnable);
1341	HRESULT i_onUSBControllerChange();
1342	HRESULT i_onUSBDeviceAttach(IUSBDevice *aDevice,
1343	IVirtualBoxErrorInfo *aError,
1344	ULONG aMaskedIfs,
1345	const com::Utf8Str &aCaptureFilename);
1346	HRESULT i_onUSBDeviceDetach(IN_BSTR aId,
1347	IVirtualBoxErrorInfo *aError);
1348	HRESULT i_onSharedFolderChange();
1349	HRESULT i_onClipboardModeChange(ClipboardMode_T aClipboardMode);
1350	HRESULT i_onClipboardFileTransferModeChange(BOOL aEnable);
1351	HRESULT i_onDnDModeChange(DnDMode_T aDnDMode);
1352	HRESULT i_onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);
1353	HRESULT i_onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove, BOOL aSilent);
1354	HRESULT i_onCPUExecutionCapChange(ULONG aCpuExecutionCap);
1355
1356	bool i_hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs);
1357
1358	HRESULT i_lockMedia();
1359	HRESULT i_unlockMedia();
1360
1361	HRESULT i_saveStateWithReason(Reason_T aReason, ComPtr<IProgress> &aProgress);
1362
1363	private:
1364
1365	// wrapped IInternalMachineControl properties
1366
1367	// wrapped IInternalMachineControl methods
1368	HRESULT setRemoveSavedStateFile(BOOL aRemove);
1369	HRESULT updateState(MachineState_T aState);
1370	HRESULT beginPowerUp(const ComPtr<IProgress> &aProgress);
1371	HRESULT endPowerUp(LONG aResult);
1372	HRESULT beginPoweringDown(ComPtr<IProgress> &aProgress);
1373	HRESULT endPoweringDown(LONG aResult,
1374	const com::Utf8Str &aErrMsg);
1375	HRESULT runUSBDeviceFilters(const ComPtr<IUSBDevice> &aDevice,
1376	BOOL *aMatched,
1377	ULONG *aMaskedInterfaces);
1378	HRESULT captureUSBDevice(const com::Guid &aId, const com::Utf8Str &aCaptureFilename);
1379	HRESULT detachUSBDevice(const com::Guid &aId,
1380	BOOL aDone);
1381	HRESULT autoCaptureUSBDevices();
1382	HRESULT detachAllUSBDevices(BOOL aDone);
1383	HRESULT onSessionEnd(const ComPtr<ISession> &aSession,
1384	ComPtr<IProgress> &aProgress);
1385	HRESULT finishOnlineMergeMedium();
1386	HRESULT pullGuestProperties(std::vector<com::Utf8Str> &aNames,
1387	std::vector<com::Utf8Str> &aValues,
1388	std::vector<LONG64> &aTimestamps,
1389	std::vector<com::Utf8Str> &aFlags);
1390	HRESULT pushGuestProperty(const com::Utf8Str &aName,
1391	const com::Utf8Str &aValue,
1392	LONG64 aTimestamp,
1393	const com::Utf8Str &aFlags,
1394	BOOL fWasDeleted);
1395	HRESULT lockMedia();
1396	HRESULT unlockMedia();
1397	HRESULT ejectMedium(const ComPtr<IMediumAttachment> &aAttachment,
1398	ComPtr<IMediumAttachment> &aNewAttachment);
1399	HRESULT reportVmStatistics(ULONG aValidStats,
1400	ULONG aCpuUser,
1401	ULONG aCpuKernel,
1402	ULONG aCpuIdle,
1403	ULONG aMemTotal,
1404	ULONG aMemFree,
1405	ULONG aMemBalloon,
1406	ULONG aMemShared,
1407	ULONG aMemCache,
1408	ULONG aPagedTotal,
1409	ULONG aMemAllocTotal,
1410	ULONG aMemFreeTotal,
1411	ULONG aMemBalloonTotal,
1412	ULONG aMemSharedTotal,
1413	ULONG aVmNetRx,
1414	ULONG aVmNetTx);
1415	HRESULT authenticateExternal(const std::vector<com::Utf8Str> &aAuthParams,
1416	com::Utf8Str &aResult);
1417
1418
1419	struct ConsoleTaskData
1420	{
1421	ConsoleTaskData()
1422	: mLastState(MachineState_Null),
1423	mDeleteSnapshotInfo(NULL)
1424	{ }
1425
1426	MachineState_T mLastState;
1427	ComObjPtr<Progress> mProgress;
1428
1429	// used when deleting online snaphshot
1430	void *mDeleteSnapshotInfo;
1431	};
1432
1433	class SaveStateTask;
1434	class SnapshotTask;
1435	class TakeSnapshotTask;
1436	class DeleteSnapshotTask;
1437	class RestoreSnapshotTask;
1438
1439	void i_saveStateHandler(SaveStateTask &aTask);
1440
1441	// Override some functionality for SessionMachine, this is where the
1442	// real action happens (the Machine methods are just dummies).
1443	HRESULT saveState(ComPtr<IProgress> &aProgress);
1444	HRESULT adoptSavedState(const com::Utf8Str &aSavedStateFile);
1445	HRESULT discardSavedState(BOOL aFRemoveFile);
1446	HRESULT takeSnapshot(const com::Utf8Str &aName,
1447	const com::Utf8Str &aDescription,
1448	BOOL aPause,
1449	com::Guid &aId,
1450	ComPtr<IProgress> &aProgress);
1451	HRESULT deleteSnapshot(const com::Guid &aId,
1452	ComPtr<IProgress> &aProgress);
1453	HRESULT deleteSnapshotAndAllChildren(const com::Guid &aId,
1454	ComPtr<IProgress> &aProgress);
1455	HRESULT deleteSnapshotRange(const com::Guid &aStartId,
1456	const com::Guid &aEndId,
1457	ComPtr<IProgress> &aProgress);
1458	HRESULT restoreSnapshot(const ComPtr<ISnapshot> &aSnapshot,
1459	ComPtr<IProgress> &aProgress);
1460
1461	void i_releaseSavedStateFile(const Utf8Str &strSavedStateFile, Snapshot *pSnapshotToIgnore);
1462
1463	void i_takeSnapshotHandler(TakeSnapshotTask &aTask);
1464	static void i_takeSnapshotProgressCancelCallback(void *pvUser);
1465	HRESULT i_finishTakingSnapshot(TakeSnapshotTask &aTask, AutoWriteLock &alock, bool aSuccess);
1466	HRESULT i_deleteSnapshot(const com::Guid &aStartId,
1467	const com::Guid &aEndId,
1468	BOOL aDeleteAllChildren,
1469	ComPtr<IProgress> &aProgress);
1470	void i_deleteSnapshotHandler(DeleteSnapshotTask &aTask);
1471	void i_restoreSnapshotHandler(RestoreSnapshotTask &aTask);
1472
1473	HRESULT i_prepareDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,
1474	const Guid &machineId,
1475	const Guid &snapshotId,
1476	bool fOnlineMergePossible,
1477	MediumLockList *aVMMALockList,
1478	ComObjPtr<Medium> &aSource,
1479	ComObjPtr<Medium> &aTarget,
1480	bool &fMergeForward,
1481	ComObjPtr<Medium> &pParentForTarget,
1482	MediumLockList * &aChildrenToReparent,
1483	bool &fNeedOnlineMerge,
1484	MediumLockList * &aMediumLockList,
1485	ComPtr<IToken> &aHDLockToken);
1486	void i_cancelDeleteSnapshotMedium(const ComObjPtr<Medium> &aHD,
1487	const ComObjPtr<Medium> &aSource,
1488	MediumLockList *aChildrenToReparent,
1489	bool fNeedsOnlineMerge,
1490	MediumLockList *aMediumLockList,
1491	const ComPtr<IToken> &aHDLockToken,
1492	const Guid &aMediumId,
1493	const Guid &aSnapshotId);
1494	HRESULT i_onlineMergeMedium(const ComObjPtr<MediumAttachment> &aMediumAttachment,
1495	const ComObjPtr<Medium> &aSource,
1496	const ComObjPtr<Medium> &aTarget,
1497	bool fMergeForward,
1498	const ComObjPtr<Medium> &pParentForTarget,
1499	MediumLockList *aChildrenToReparent,
1500	MediumLockList *aMediumLockList,
1501	ComObjPtr<Progress> &aProgress,
1502	bool *pfNeedsMachineSaveSettings);
1503
1504	HRESULT i_setMachineState(MachineState_T aMachineState);
1505	HRESULT i_updateMachineStateOnClient();
1506
1507	bool mRemoveSavedState;
1508
1509	ConsoleTaskData mConsoleTaskData;
1510
1511	/** client token for this machine */
1512	ClientToken *mClientToken;
1513
1514	int miNATNetworksStarted;
1515
1516	AUTHLIBRARYCONTEXT mAuthLibCtx;
1517	};
1518
1519	// SnapshotMachine class
1520	////////////////////////////////////////////////////////////////////////////////
1521
1522	/**
1523	* @note Notes on locking objects of this class:
1524	* SnapshotMachine shares some data with the primary Machine instance (pointed
1525	* to by the \|mPeer\| member). In order to provide data consistency it also
1526	* shares its lock handle. This means that whenever you lock a SessionMachine
1527	* instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
1528	* instance is also locked in the same lock mode. Keep it in mind.
1529	*/
1530	class ATL_NO_VTABLE SnapshotMachine :
1531	public Machine
1532	{
1533	public:
1534	VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(SnapshotMachine, IMachine)
1535
1536	DECLARE_NOT_AGGREGATABLE(SnapshotMachine)
1537
1538	DECLARE_PROTECT_FINAL_CONSTRUCT()
1539
1540	BEGIN_COM_MAP(SnapshotMachine)
1541	COM_INTERFACE_ENTRY(ISupportErrorInfo)
1542	COM_INTERFACE_ENTRY(IMachine)
1543	COM_INTERFACE_ENTRY2(IDispatch, IMachine)
1544	VBOX_TWEAK_INTERFACE_ENTRY(IMachine)
1545	END_COM_MAP()
1546
1547	DECLARE_COMMON_CLASS_METHODS(SnapshotMachine)
1548
1549	HRESULT FinalConstruct();
1550	void FinalRelease();
1551
1552	// public initializer/uninitializer for internal purposes only
1553	HRESULT init(SessionMachine *aSessionMachine,
1554	IN_GUID aSnapshotId,
1555	const Utf8Str &aStateFilePath);
1556	HRESULT initFromSettings(Machine *aMachine,
1557	const settings::Hardware &hardware,
1558	const settings::Debugging *pDbg,
1559	const settings::Autostart *pAutostart,
1560	IN_GUID aSnapshotId,
1561	const Utf8Str &aStateFilePath);
1562	void uninit();
1563
1564	// util::Lockable interface
1565	RWLockHandle *lockHandle() const;
1566
1567	// public methods only for internal purposes
1568
1569	virtual bool i_isSnapshotMachine() const
1570	{
1571	return true;
1572	}
1573
1574	HRESULT i_onSnapshotChange(Snapshot *aSnapshot);
1575
1576	// unsafe inline public methods for internal purposes only (ensure there is
1577	// a caller and a read lock before calling them!)
1578
1579	const Guid& i_getSnapshotId() const { return mSnapshotId; }
1580
1581	private:
1582
1583	Guid mSnapshotId;
1584	/** This field replaces mPeer for SessionMachine instances, as having
1585	* a peer reference is plain meaningless and causes many subtle problems
1586	* with saving settings and the like. */
1587	Machine * const mMachine;
1588
1589	friend class Snapshot;
1590	};
1591
1592	// third party methods that depend on SnapshotMachine definition
1593
1594	inline const Guid &Machine::i_getSnapshotId() const
1595	{
1596	return (i_isSnapshotMachine())
1597	? static_cast<const SnapshotMachine*>(this)->i_getSnapshotId()
1598	: Guid::Empty;
1599	}
1600
1601
1602	#endif /* !MAIN_INCLUDED_MachineImpl_h */
1603	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: