VirtualBox

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

Last change on this file since 25275 was 25150, checked in by vboxsync, 15 years ago

Main: build fix
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 44.7 KB
Line 
1/* $Id: MachineImpl.h 25150 2009-12-02 14:40:46Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class declaration
6 */
7
8/*
9 * Copyright (C) 2006-2009 Sun Microsystems, Inc.
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 *
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
20 * Clara, CA 95054 USA or visit http://www.sun.com if you need
21 * additional information or have any questions.
22 */
23
24#ifndef ____H_MACHINEIMPL
25#define ____H_MACHINEIMPL
26
27#include "VirtualBoxBase.h"
28#include "ProgressImpl.h"
29#include "SnapshotImpl.h"
30#include "VRDPServerImpl.h"
31#include "MediumAttachmentImpl.h"
32#include "NetworkAdapterImpl.h"
33#include "AudioAdapterImpl.h"
34#include "SerialPortImpl.h"
35#include "ParallelPortImpl.h"
36#include "BIOSSettingsImpl.h"
37#include "StorageControllerImpl.h" // required for MachineImpl.h to compile on Windows
38#include "VBox/settings.h"
39#ifdef VBOX_WITH_RESOURCE_USAGE_API
40#include "PerformanceImpl.h"
41#endif /* VBOX_WITH_RESOURCE_USAGE_API */
42
43// generated header
44#include "SchemaDefs.h"
45
46#include <VBox/types.h>
47
48#include <iprt/file.h>
49#include <iprt/thread.h>
50#include <iprt/time.h>
51
52#include <list>
53
54// defines
55////////////////////////////////////////////////////////////////////////////////
56
57// helper declarations
58////////////////////////////////////////////////////////////////////////////////
59
60class VirtualBox;
61class Progress;
62class Keyboard;
63class Mouse;
64class Display;
65class MachineDebugger;
66class USBController;
67class Snapshot;
68class SharedFolder;
69class HostUSBDevice;
70class StorageController;
71
72class SessionMachine;
73
74namespace settings
75{
76 class MachineConfigFile;
77 struct Snapshot;
78 struct Hardware;
79 struct Storage;
80 struct StorageController;
81 struct MachineRegistryEntry;
82}
83
84// Machine class
85////////////////////////////////////////////////////////////////////////////////
86
87class ATL_NO_VTABLE Machine :
88 public VirtualBoxBaseWithChildrenNEXT,
89 public VirtualBoxSupportErrorInfoImpl<Machine, IMachine>,
90 public VirtualBoxSupportTranslation<Machine>,
91 VBOX_SCRIPTABLE_IMPL(IMachine)
92{
93 Q_OBJECT
94
95public:
96
97 enum InstanceType { IsMachine, IsSessionMachine, IsSnapshotMachine };
98
99 enum InitMode { Init_New, Init_Import, Init_Registered };
100
101 /**
102 * Internal machine data.
103 *
104 * Only one instance of this data exists per every machine -- it is shared
105 * by the Machine, SessionMachine and all SnapshotMachine instances
106 * associated with the given machine using the util::Shareable template
107 * through the mData variable.
108 *
109 * @note |const| members are persistent during lifetime so can be
110 * accessed without locking.
111 *
112 * @note There is no need to lock anything inside init() or uninit()
113 * methods, because they are always serialized (see AutoCaller).
114 */
115 struct Data
116 {
117 /**
118 * Data structure to hold information about sessions opened for the
119 * given machine.
120 */
121 struct Session
122 {
123 /** Control of the direct session opened by openSession() */
124 ComPtr<IInternalSessionControl> mDirectControl;
125
126 typedef std::list<ComPtr<IInternalSessionControl> > RemoteControlList;
127
128 /** list of controls of all opened remote sessions */
129 RemoteControlList mRemoteControls;
130
131 /** openRemoteSession() and OnSessionEnd() progress indicator */
132 ComObjPtr<Progress> mProgress;
133
134 /**
135 * PID of the session object that must be passed to openSession() to
136 * finalize the openRemoteSession() request (i.e., PID of the
137 * process created by openRemoteSession())
138 */
139 RTPROCESS mPid;
140
141 /** Current session state */
142 SessionState_T mState;
143
144 /** Session type string (for indirect sessions) */
145 Bstr mType;
146
147 /** Session machine object */
148 ComObjPtr<SessionMachine> mMachine;
149
150 /**
151 * Successfully locked media list. The 2nd value in the pair is true
152 * if the medium is locked for writing and false if locked for
153 * reading.
154 */
155 typedef std::list<std::pair<ComPtr<IMedium>, bool > > LockedMedia;
156 LockedMedia mLockedMedia;
157 };
158
159 Data();
160 ~Data();
161
162 const Guid mUuid;
163 BOOL mRegistered;
164 InitMode mInitMode;
165
166 /** Flag indicating that the config file is read-only. */
167 BOOL mConfigFileReadonly;
168 Utf8Str m_strConfigFile;
169 Utf8Str m_strConfigFileFull;
170
171 // machine settings XML file
172 settings::MachineConfigFile *m_pMachineConfigFile;
173
174 BOOL mAccessible;
175 com::ErrorInfo mAccessError;
176
177 MachineState_T mMachineState;
178 RTTIMESPEC mLastStateChange;
179
180 /* Note: These are guarded by VirtualBoxBase::stateLockHandle() */
181 uint32_t mMachineStateDeps;
182 RTSEMEVENTMULTI mMachineStateDepsSem;
183 uint32_t mMachineStateChangePending;
184
185 BOOL mCurrentStateModified;
186
187 RTFILE mHandleCfgFile;
188
189 Session mSession;
190
191 ComObjPtr<Snapshot> mFirstSnapshot;
192 ComObjPtr<Snapshot> mCurrentSnapshot;
193
194 // protectes the snapshots tree of this machine
195 RWLockHandle mSnapshotsTreeLockHandle;
196 };
197
198 /**
199 * Saved state data.
200 *
201 * It's actually only the state file path string, but it needs to be
202 * separate from Data, because Machine and SessionMachine instances
203 * share it, while SnapshotMachine does not.
204 *
205 * The data variable is |mSSData|.
206 */
207 struct SSData
208 {
209 Utf8Str mStateFilePath;
210 };
211
212 /**
213 * User changeable machine data.
214 *
215 * This data is common for all machine snapshots, i.e. it is shared
216 * by all SnapshotMachine instances associated with the given machine
217 * using the util::Backupable template through the |mUserData| variable.
218 *
219 * SessionMachine instances can alter this data and discard changes.
220 *
221 * @note There is no need to lock anything inside init() or uninit()
222 * methods, because they are always serialized (see AutoCaller).
223 */
224 struct UserData
225 {
226 UserData();
227 ~UserData();
228
229 bool operator==(const UserData &that) const
230 {
231 return this == &that
232 || ( mName == that.mName
233 && mNameSync == that.mNameSync
234 && mDescription == that.mDescription
235 && mOSTypeId == that.mOSTypeId
236 && mSnapshotFolderFull == that.mSnapshotFolderFull
237 && mTeleporterEnabled == that.mTeleporterEnabled
238 && mTeleporterPort == that.mTeleporterPort
239 && mTeleporterAddress == that.mTeleporterAddress
240 && mTeleporterPassword == that.mTeleporterPassword);
241 }
242
243 Bstr mName;
244 BOOL mNameSync;
245 Bstr mDescription;
246 Bstr mOSTypeId;
247 Bstr mSnapshotFolder;
248 Bstr mSnapshotFolderFull;
249 BOOL mTeleporterEnabled;
250 ULONG mTeleporterPort;
251 Bstr mTeleporterAddress;
252 Bstr mTeleporterPassword;
253 };
254
255 /**
256 * Hardware data.
257 *
258 * This data is unique for a machine and for every machine snapshot.
259 * Stored using the util::Backupable template in the |mHWData| variable.
260 *
261 * SessionMachine instances can alter this data and discard changes.
262 */
263 struct HWData
264 {
265 /**
266 * Data structure to hold information about a guest property.
267 */
268 struct GuestProperty {
269 /** Property name */
270 Utf8Str strName;
271 /** Property value */
272 Utf8Str strValue;
273 /** Property timestamp */
274 ULONG64 mTimestamp;
275 /** Property flags */
276 ULONG mFlags;
277 };
278
279 HWData();
280 ~HWData();
281
282 bool operator==(const HWData &that) const;
283
284 Bstr mHWVersion;
285 Guid mHardwareUUID; /**< If Null, use mData.mUuid. */
286 ULONG mMemorySize;
287 ULONG mMemoryBalloonSize;
288 ULONG mStatisticsUpdateInterval;
289 ULONG mVRAMSize;
290 ULONG mMonitorCount;
291 BOOL mHWVirtExEnabled;
292 BOOL mHWVirtExExclusive;
293 BOOL mHWVirtExNestedPagingEnabled;
294 BOOL mHWVirtExVPIDEnabled;
295 BOOL mAccelerate2DVideoEnabled;
296 BOOL mPAEEnabled;
297 BOOL mSyntheticCpu;
298 ULONG mCPUCount;
299 BOOL mAccelerate3DEnabled;
300
301 settings::CpuIdLeaf mCpuIdStdLeafs[10];
302 settings::CpuIdLeaf mCpuIdExtLeafs[10];
303
304 DeviceType_T mBootOrder[SchemaDefs::MaxBootPosition];
305
306 typedef std::list< ComObjPtr<SharedFolder> > SharedFolderList;
307 SharedFolderList mSharedFolders;
308
309 ClipboardMode_T mClipboardMode;
310
311 typedef std::list<GuestProperty> GuestPropertyList;
312 GuestPropertyList mGuestProperties;
313 BOOL mPropertyServiceActive;
314 Utf8Str mGuestPropertyNotificationPatterns;
315
316 FirmwareType_T mFirmwareType;
317 };
318
319 /**
320 * Hard disk and other media data.
321 *
322 * The usage policy is the same as for HWData, but a separate structure
323 * is necessary because hard disk data requires different procedures when
324 * taking or discarding snapshots, etc.
325 *
326 * The data variable is |mMediaData|.
327 */
328 struct MediaData
329 {
330 MediaData();
331 ~MediaData();
332
333 bool operator==(const MediaData &that) const;
334
335 typedef std::list< ComObjPtr<MediumAttachment> > AttachmentList;
336 AttachmentList mAttachments;
337 };
338
339 enum StateDependency
340 {
341 AnyStateDep = 0, MutableStateDep, MutableOrSavedStateDep
342 };
343
344 /**
345 * Helper class that safely manages the machine state dependency by
346 * calling Machine::addStateDependency() on construction and
347 * Machine::releaseStateDependency() on destruction. Intended for Machine
348 * children. The usage pattern is:
349 *
350 * @code
351 * AutoCaller autoCaller(this);
352 * if (FAILED(autoCaller.rc())) return autoCaller.rc();
353 *
354 * Machine::AutoStateDependency<MutableStateDep> adep(mParent);
355 * if (FAILED(stateDep.rc())) return stateDep.rc();
356 * ...
357 * // code that depends on the particular machine state
358 * ...
359 * @endcode
360 *
361 * Note that it is more convenient to use the following individual
362 * shortcut classes instead of using this template directly:
363 * AutoAnyStateDependency, AutoMutableStateDependency and
364 * AutoMutableOrSavedStateDependency. The usage pattern is exactly the
365 * same as above except that there is no need to specify the template
366 * argument because it is already done by the shortcut class.
367 *
368 * @param taDepType Dependecy type to manage.
369 */
370 template <StateDependency taDepType = AnyStateDep>
371 class AutoStateDependency
372 {
373 public:
374
375 AutoStateDependency(Machine *aThat)
376 : mThat(aThat), mRC(S_OK)
377 , mMachineState(MachineState_Null)
378 , mRegistered(FALSE)
379 {
380 Assert(aThat);
381 mRC = aThat->addStateDependency(taDepType, &mMachineState,
382 &mRegistered);
383 }
384 ~AutoStateDependency()
385 {
386 if (SUCCEEDED(mRC))
387 mThat->releaseStateDependency();
388 }
389
390 /** Decreases the number of dependencies before the instance is
391 * destroyed. Note that will reset #rc() to E_FAIL. */
392 void release()
393 {
394 AssertReturnVoid(SUCCEEDED(mRC));
395 mThat->releaseStateDependency();
396 mRC = E_FAIL;
397 }
398
399 /** Restores the number of callers after by #release(). #rc() will be
400 * reset to the result of calling addStateDependency() and must be
401 * rechecked to ensure the operation succeeded. */
402 void add()
403 {
404 AssertReturnVoid(!SUCCEEDED(mRC));
405 mRC = mThat->addStateDependency(taDepType, &mMachineState,
406 &mRegistered);
407 }
408
409 /** Returns the result of Machine::addStateDependency(). */
410 HRESULT rc() const { return mRC; }
411
412 /** Shortcut to SUCCEEDED(rc()). */
413 bool isOk() const { return SUCCEEDED(mRC); }
414
415 /** Returns the machine state value as returned by
416 * Machine::addStateDependency(). */
417 MachineState_T machineState() const { return mMachineState; }
418
419 /** Returns the machine state value as returned by
420 * Machine::addStateDependency(). */
421 BOOL machineRegistered() const { return mRegistered; }
422
423 protected:
424
425 Machine *mThat;
426 HRESULT mRC;
427 MachineState_T mMachineState;
428 BOOL mRegistered;
429
430 private:
431
432 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(AutoStateDependency)
433 DECLARE_CLS_NEW_DELETE_NOOP(AutoStateDependency)
434 };
435
436 /**
437 * Shortcut to AutoStateDependency<AnyStateDep>.
438 * See AutoStateDependency to get the usage pattern.
439 *
440 * Accepts any machine state and guarantees the state won't change before
441 * this object is destroyed. If the machine state cannot be protected (as
442 * a result of the state change currently in progress), this instance's
443 * #rc() method will indicate a failure, and the caller is not allowed to
444 * rely on any particular machine state and should return the failed
445 * result code to the upper level.
446 */
447 typedef AutoStateDependency<AnyStateDep> AutoAnyStateDependency;
448
449 /**
450 * Shortcut to AutoStateDependency<MutableStateDep>.
451 * See AutoStateDependency to get the usage pattern.
452 *
453 * Succeeds only if the machine state is in one of the mutable states, and
454 * guarantees the given mutable state won't change before this object is
455 * destroyed. If the machine is not mutable, this instance's #rc() method
456 * will indicate a failure, and the caller is not allowed to rely on any
457 * particular machine state and should return the failed result code to
458 * the upper level.
459 *
460 * Intended to be used within all setter methods of IMachine
461 * children objects (DVDDrive, NetworkAdapter, AudioAdapter, etc.) to
462 * provide data protection and consistency.
463 */
464 typedef AutoStateDependency<MutableStateDep> AutoMutableStateDependency;
465
466 /**
467 * Shortcut to AutoStateDependency<MutableOrSavedStateDep>.
468 * See AutoStateDependency to get the usage pattern.
469 *
470 * Succeeds only if the machine state is in one of the mutable states, or
471 * if the machine is in the Saved state, and guarantees the given mutable
472 * state won't change before this object is destroyed. If the machine is
473 * not mutable, this instance's #rc() method will indicate a failure, and
474 * the caller is not allowed to rely on any particular machine state and
475 * should return the failed result code to the upper level.
476 *
477 * Intended to be used within setter methods of IMachine
478 * children objects that may also operate on Saved machines.
479 */
480 typedef AutoStateDependency<MutableOrSavedStateDep> AutoMutableOrSavedStateDependency;
481
482
483 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(Machine)
484
485 DECLARE_NOT_AGGREGATABLE(Machine)
486
487 DECLARE_PROTECT_FINAL_CONSTRUCT()
488
489 BEGIN_COM_MAP(Machine)
490 COM_INTERFACE_ENTRY(ISupportErrorInfo)
491 COM_INTERFACE_ENTRY(IMachine)
492 COM_INTERFACE_ENTRY(IDispatch)
493 END_COM_MAP()
494
495 DECLARE_EMPTY_CTOR_DTOR(Machine)
496
497 HRESULT FinalConstruct();
498 void FinalRelease();
499
500 // public initializer/uninitializer for internal purposes only
501 HRESULT init(VirtualBox *aParent,
502 const Utf8Str &strConfigFile,
503 InitMode aMode,
504 CBSTR aName = NULL,
505 GuestOSType *aOsType = NULL,
506 BOOL aNameSync = TRUE,
507 const Guid *aId = NULL);
508 void uninit();
509
510protected:
511 HRESULT initDataAndChildObjects();
512 void uninitDataAndChildObjects();
513
514public:
515 // IMachine properties
516 STDMETHOD(COMGETTER(Parent))(IVirtualBox **aParent);
517 STDMETHOD(COMGETTER(Accessible))(BOOL *aAccessible);
518 STDMETHOD(COMGETTER(AccessError))(IVirtualBoxErrorInfo **aAccessError);
519 STDMETHOD(COMGETTER(Name))(BSTR *aName);
520 STDMETHOD(COMSETTER(Name))(IN_BSTR aName);
521 STDMETHOD(COMGETTER(Description))(BSTR *aDescription);
522 STDMETHOD(COMSETTER(Description))(IN_BSTR aDescription);
523 STDMETHOD(COMGETTER(Id))(BSTR *aId);
524 STDMETHOD(COMGETTER(OSTypeId))(BSTR *aOSTypeId);
525 STDMETHOD(COMSETTER(OSTypeId))(IN_BSTR aOSTypeId);
526 STDMETHOD(COMGETTER(HardwareVersion))(BSTR *aVersion);
527 STDMETHOD(COMSETTER(HardwareVersion))(IN_BSTR aVersion);
528 STDMETHOD(COMGETTER(HardwareUUID))(BSTR *aUUID);
529 STDMETHOD(COMSETTER(HardwareUUID))(IN_BSTR aUUID);
530 STDMETHOD(COMGETTER(MemorySize))(ULONG *memorySize);
531 STDMETHOD(COMSETTER(MemorySize))(ULONG memorySize);
532 STDMETHOD(COMGETTER(CPUCount))(ULONG *cpuCount);
533 STDMETHOD(COMSETTER(CPUCount))(ULONG cpuCount);
534 STDMETHOD(COMGETTER(MemoryBalloonSize))(ULONG *memoryBalloonSize);
535 STDMETHOD(COMSETTER(MemoryBalloonSize))(ULONG memoryBalloonSize);
536 STDMETHOD(COMGETTER(StatisticsUpdateInterval))(ULONG *statisticsUpdateInterval);
537 STDMETHOD(COMSETTER(StatisticsUpdateInterval))(ULONG statisticsUpdateInterval);
538 STDMETHOD(COMGETTER(VRAMSize))(ULONG *memorySize);
539 STDMETHOD(COMSETTER(VRAMSize))(ULONG memorySize);
540 STDMETHOD(COMGETTER(MonitorCount))(ULONG *monitorCount);
541 STDMETHOD(COMSETTER(MonitorCount))(ULONG monitorCount);
542 STDMETHOD(COMGETTER(Accelerate3DEnabled))(BOOL *enabled);
543 STDMETHOD(COMSETTER(Accelerate3DEnabled))(BOOL enabled);
544 STDMETHOD(COMGETTER(Accelerate2DVideoEnabled))(BOOL *enabled);
545 STDMETHOD(COMSETTER(Accelerate2DVideoEnabled))(BOOL enabled);
546 STDMETHOD(COMGETTER(BIOSSettings))(IBIOSSettings **biosSettings);
547 STDMETHOD(COMGETTER(SnapshotFolder))(BSTR *aSavedStateFolder);
548 STDMETHOD(COMSETTER(SnapshotFolder))(IN_BSTR aSavedStateFolder);
549 STDMETHOD(COMGETTER(MediumAttachments))(ComSafeArrayOut(IMediumAttachment *, aAttachments));
550 STDMETHOD(COMGETTER(VRDPServer))(IVRDPServer **vrdpServer);
551 STDMETHOD(COMGETTER(AudioAdapter))(IAudioAdapter **audioAdapter);
552 STDMETHOD(COMGETTER(USBController))(IUSBController * *aUSBController);
553 STDMETHOD(COMGETTER(SettingsFilePath))(BSTR *aFilePath);
554 STDMETHOD(COMGETTER(SettingsModified))(BOOL *aModified);
555 STDMETHOD(COMGETTER(SessionState))(SessionState_T *aSessionState);
556 STDMETHOD(COMGETTER(SessionType))(BSTR *aSessionType);
557 STDMETHOD(COMGETTER(SessionPid))(ULONG *aSessionPid);
558 STDMETHOD(COMGETTER(State))(MachineState_T *machineState);
559 STDMETHOD(COMGETTER(LastStateChange))(LONG64 *aLastStateChange);
560 STDMETHOD(COMGETTER(StateFilePath))(BSTR *aStateFilePath);
561 STDMETHOD(COMGETTER(LogFolder))(BSTR *aLogFolder);
562 STDMETHOD(COMGETTER(CurrentSnapshot))(ISnapshot **aCurrentSnapshot);
563 STDMETHOD(COMGETTER(SnapshotCount))(ULONG *aSnapshotCount);
564 STDMETHOD(COMGETTER(CurrentStateModified))(BOOL *aCurrentStateModified);
565 STDMETHOD(COMGETTER(SharedFolders))(ComSafeArrayOut(ISharedFolder *, aSharedFolders));
566 STDMETHOD(COMGETTER(ClipboardMode))(ClipboardMode_T *aClipboardMode);
567 STDMETHOD(COMSETTER(ClipboardMode))(ClipboardMode_T aClipboardMode);
568 STDMETHOD(COMGETTER(GuestPropertyNotificationPatterns))(BSTR *aPattern);
569 STDMETHOD(COMSETTER(GuestPropertyNotificationPatterns))(IN_BSTR aPattern);
570 STDMETHOD(COMGETTER(StorageControllers))(ComSafeArrayOut(IStorageController *, aStorageControllers));
571 STDMETHOD(COMGETTER(TeleporterEnabled))(BOOL *aEnabled);
572 STDMETHOD(COMSETTER(TeleporterEnabled))(BOOL aEnabled);
573 STDMETHOD(COMGETTER(TeleporterPort))(ULONG *aPort);
574 STDMETHOD(COMSETTER(TeleporterPort))(ULONG aPort);
575 STDMETHOD(COMGETTER(TeleporterAddress))(BSTR *aAddress);
576 STDMETHOD(COMSETTER(TeleporterAddress))(IN_BSTR aAddress);
577 STDMETHOD(COMGETTER(TeleporterPassword))(BSTR *aPassword);
578 STDMETHOD(COMSETTER(TeleporterPassword))(IN_BSTR aPassword);
579
580 // IMachine methods
581 STDMETHOD(SetBootOrder)(ULONG aPosition, DeviceType_T aDevice);
582 STDMETHOD(GetBootOrder)(ULONG aPosition, DeviceType_T *aDevice);
583 STDMETHOD(AttachDevice)(IN_BSTR aControllerName, LONG aControllerPort,
584 LONG aDevice, DeviceType_T aType, IN_BSTR aId);
585 STDMETHOD(DetachDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice);
586 STDMETHOD(PassthroughDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice, BOOL aPassthrough);
587 STDMETHOD(MountMedium)(IN_BSTR aControllerName, LONG aControllerPort,
588 LONG aDevice, IN_BSTR aId, BOOL aForce);
589 STDMETHOD(GetMedium)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice,
590 IMedium **aMedium);
591 STDMETHOD(GetSerialPort)(ULONG slot, ISerialPort **port);
592 STDMETHOD(GetParallelPort)(ULONG slot, IParallelPort **port);
593 STDMETHOD(GetNetworkAdapter)(ULONG slot, INetworkAdapter **adapter);
594 STDMETHOD(GetExtraDataKeys)(ComSafeArrayOut(BSTR, aKeys));
595 STDMETHOD(GetExtraData)(IN_BSTR aKey, BSTR *aValue);
596 STDMETHOD(SetExtraData)(IN_BSTR aKey, IN_BSTR aValue);
597 STDMETHOD(GetCpuProperty)(CpuPropertyType_T property, BOOL *aVal);
598 STDMETHOD(SetCpuProperty)(CpuPropertyType_T property, BOOL aVal);
599 STDMETHOD(GetCpuIdLeaf)(ULONG id, ULONG *aValEax, ULONG *aValEbx, ULONG *aValEcx, ULONG *aValEdx);
600 STDMETHOD(SetCpuIdLeaf)(ULONG id, ULONG aValEax, ULONG aValEbx, ULONG aValEcx, ULONG aValEdx);
601 STDMETHOD(RemoveCpuIdLeaf)(ULONG id);
602 STDMETHOD(RemoveAllCpuIdLeafs)();
603 STDMETHOD(GetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL *aVal);
604 STDMETHOD(SetHWVirtExProperty)(HWVirtExPropertyType_T property, BOOL aVal);
605 STDMETHOD(SaveSettings)();
606 STDMETHOD(DiscardSettings)();
607 STDMETHOD(DeleteSettings)();
608 STDMETHOD(Export)(IAppliance *aAppliance, IVirtualSystemDescription **aDescription);
609 STDMETHOD(GetSnapshot)(IN_BSTR aId, ISnapshot **aSnapshot);
610 STDMETHOD(FindSnapshot)(IN_BSTR aName, ISnapshot **aSnapshot);
611 STDMETHOD(SetCurrentSnapshot)(IN_BSTR aId);
612 STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable);
613 STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);
614 STDMETHOD(CanShowConsoleWindow)(BOOL *aCanShow);
615 STDMETHOD(ShowConsoleWindow)(ULONG64 *aWinId);
616 STDMETHOD(GetGuestProperty)(IN_BSTR aName, BSTR *aValue, ULONG64 *aTimestamp, BSTR *aFlags);
617 STDMETHOD(GetGuestPropertyValue)(IN_BSTR aName, BSTR *aValue);
618 STDMETHOD(GetGuestPropertyTimestamp)(IN_BSTR aName, ULONG64 *aTimestamp);
619 STDMETHOD(SetGuestProperty)(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags);
620 STDMETHOD(SetGuestPropertyValue)(IN_BSTR aName, IN_BSTR aValue);
621 STDMETHOD(EnumerateGuestProperties)(IN_BSTR aPattern, ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(ULONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
622 STDMETHOD(GetMediumAttachmentsOfController)(IN_BSTR aName, ComSafeArrayOut(IMediumAttachment *, aAttachments));
623 STDMETHOD(GetMediumAttachment)(IN_BSTR aConstrollerName, LONG aControllerPort, LONG aDevice, IMediumAttachment **aAttachment);
624 STDMETHOD(AddStorageController)(IN_BSTR aName, StorageBus_T aConnectionType, IStorageController **controller);
625 STDMETHOD(RemoveStorageController(IN_BSTR aName));
626 STDMETHOD(GetStorageControllerByName(IN_BSTR aName, IStorageController **storageController));
627 STDMETHOD(GetStorageControllerByInstance(ULONG aInstance, IStorageController **storageController));
628 STDMETHOD(COMGETTER(FirmwareType)) (FirmwareType_T *aFirmware);
629 STDMETHOD(COMSETTER(FirmwareType)) (FirmwareType_T aFirmware);
630
631 STDMETHOD(QuerySavedThumbnailSize)(ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
632 STDMETHOD(ReadSavedThumbnailToArray)(BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
633 STDMETHOD(QuerySavedScreenshotPNGSize)(ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
634 STDMETHOD(ReadSavedScreenshotPNGToArray)(ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
635
636 // public methods only for internal purposes
637
638 InstanceType getType() const { return mType; }
639
640 /// @todo (dmik) add lock and make non-inlined after revising classes
641 // that use it. Note: they should enter Machine lock to keep the returned
642 // information valid!
643 bool isRegistered() { return !!mData->mRegistered; }
644
645 // unsafe inline public methods for internal purposes only (ensure there is
646 // a caller and a read lock before calling them!)
647
648 /**
649 * Returns the VirtualBox object this machine belongs to.
650 *
651 * @note This method doesn't check this object's readiness. Intended to be
652 * used by ready Machine children (whose readiness is bound to the parent's
653 * one) or after doing addCaller() manually.
654 */
655 const ComObjPtr<VirtualBox, ComWeakRef>& getVirtualBox() const { return mParent; }
656
657 /**
658 * Returns this machine ID.
659 *
660 * @note This method doesn't check this object's readiness. Intended to be
661 * used by ready Machine children (whose readiness is bound to the parent's
662 * one) or after adding a caller manually.
663 */
664 const Guid& getId() const { return mData->mUuid; }
665
666 /**
667 * Returns the snapshot ID this machine represents or an empty UUID if this
668 * instance is not SnapshotMachine.
669 *
670 * @note This method doesn't check this object's readiness. Intended to be
671 * used by ready Machine children (whose readiness is bound to the parent's
672 * one) or after adding a caller manually.
673 */
674 inline const Guid& getSnapshotId() const;
675
676 /**
677 * Returns this machine's full settings file path.
678 *
679 * @note This method doesn't lock this object or check its readiness.
680 * Intended to be used only after doing addCaller() manually and locking it
681 * for reading.
682 */
683 const Utf8Str& getSettingsFileFull() const { return mData->m_strConfigFileFull; }
684
685 /**
686 * Returns this machine name.
687 *
688 * @note This method doesn't lock this object or check its readiness.
689 * Intended to be used only after doing addCaller() manually and locking it
690 * for reading.
691 */
692 const Bstr& getName() const { return mUserData->mName; }
693
694 // callback handlers
695 virtual HRESULT onNetworkAdapterChange(INetworkAdapter * /* networkAdapter */, BOOL /* changeAdapter */) { return S_OK; }
696 virtual HRESULT onSerialPortChange(ISerialPort * /* serialPort */) { return S_OK; }
697 virtual HRESULT onParallelPortChange(IParallelPort * /* parallelPort */) { return S_OK; }
698 virtual HRESULT onVRDPServerChange() { return S_OK; }
699 virtual HRESULT onUSBControllerChange() { return S_OK; }
700 virtual HRESULT onStorageControllerChange() { return S_OK; }
701 virtual HRESULT onMediumChange(IMediumAttachment * /* mediumAttachment */, BOOL /* force */) { return S_OK; }
702 virtual HRESULT onSharedFolderChange() { return S_OK; }
703
704 HRESULT saveRegistryEntry(settings::MachineRegistryEntry &data);
705
706 int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
707 void calculateRelativePath(const Utf8Str &strPath, Utf8Str &aResult);
708
709 void getLogFolder(Utf8Str &aLogFolder);
710
711 HRESULT openSession(IInternalSessionControl *aControl);
712 HRESULT openRemoteSession(IInternalSessionControl *aControl,
713 IN_BSTR aType, IN_BSTR aEnvironment,
714 Progress *aProgress);
715 HRESULT openExistingSession(IInternalSessionControl *aControl);
716
717#if defined(RT_OS_WINDOWS)
718
719 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
720 ComPtr<IInternalSessionControl> *aControl = NULL,
721 HANDLE *aIPCSem = NULL, bool aAllowClosing = false);
722 bool isSessionSpawning(RTPROCESS *aPID = NULL);
723
724 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
725 ComPtr<IInternalSessionControl> *aControl = NULL,
726 HANDLE *aIPCSem = NULL)
727 { return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }
728
729#elif defined(RT_OS_OS2)
730
731 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
732 ComPtr<IInternalSessionControl> *aControl = NULL,
733 HMTX *aIPCSem = NULL, bool aAllowClosing = false);
734
735 bool isSessionSpawning(RTPROCESS *aPID = NULL);
736
737 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
738 ComPtr<IInternalSessionControl> *aControl = NULL,
739 HMTX *aIPCSem = NULL)
740 { return isSessionOpen(aMachine, aControl, aIPCSem, true /* aAllowClosing */); }
741
742#else
743
744 bool isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
745 ComPtr<IInternalSessionControl> *aControl = NULL,
746 bool aAllowClosing = false);
747 bool isSessionSpawning();
748
749 bool isSessionOpenOrClosing(ComObjPtr<SessionMachine> &aMachine,
750 ComPtr<IInternalSessionControl> *aControl = NULL)
751 { return isSessionOpen(aMachine, aControl, true /* aAllowClosing */); }
752
753#endif
754
755 bool checkForSpawnFailure();
756
757 HRESULT trySetRegistered(BOOL aRegistered);
758
759 HRESULT getSharedFolder(CBSTR aName,
760 ComObjPtr<SharedFolder> &aSharedFolder,
761 bool aSetError = false)
762 {
763 AutoWriteLock alock(this);
764 return findSharedFolder(aName, aSharedFolder, aSetError);
765 }
766
767 HRESULT addStateDependency(StateDependency aDepType = AnyStateDep,
768 MachineState_T *aState = NULL,
769 BOOL *aRegistered = NULL);
770 void releaseStateDependency();
771
772 // for VirtualBoxSupportErrorInfoImpl
773 static const wchar_t *getComponentName() { return L"Machine"; }
774
775 /**
776 * Returns the handle of the snapshots tree lock. This lock is
777 * machine-specific because there is one snapshots tree per
778 * IMachine; the lock protects the "first snapshot" member in
779 * IMachine and all the children and parent links in snapshot
780 * objects pointed to therefrom.
781 *
782 * Locking order:
783 * a) object lock of the machine;
784 * b) snapshots tree lock of the machine;
785 * c) individual snapshot object locks in parent->child order,
786 * if needed; they are _not_ needed for the tree itself
787 * (as defined above).
788 */
789 RWLockHandle* snapshotsTreeLockHandle() const
790 {
791 return &mData->mSnapshotsTreeLockHandle;
792 }
793
794protected:
795
796 HRESULT registeredInit();
797
798 HRESULT checkStateDependency(StateDependency aDepType);
799
800 inline Machine *getMachine();
801
802 void ensureNoStateDependencies();
803
804 virtual HRESULT setMachineState(MachineState_T aMachineState);
805
806 HRESULT findSharedFolder(CBSTR aName,
807 ComObjPtr<SharedFolder> &aSharedFolder,
808 bool aSetError = false);
809
810 HRESULT loadSettings(bool aRegistered);
811 HRESULT loadSnapshot(const settings::Snapshot &data,
812 const Guid &aCurSnapshotId,
813 Snapshot *aParentSnapshot);
814 HRESULT loadHardware(const settings::Hardware &data);
815 HRESULT loadStorageControllers(const settings::Storage &data,
816 bool aRegistered,
817 const Guid *aSnapshotId = NULL);
818 HRESULT loadStorageDevices(StorageController *aStorageController,
819 const settings::StorageController &data,
820 bool aRegistered,
821 const Guid *aSnapshotId = NULL);
822
823 HRESULT findSnapshot(const Guid &aId, ComObjPtr<Snapshot> &aSnapshot,
824 bool aSetError = false);
825 HRESULT findSnapshot(IN_BSTR aName, ComObjPtr<Snapshot> &aSnapshot,
826 bool aSetError = false);
827
828 HRESULT getStorageControllerByName(const Utf8Str &aName,
829 ComObjPtr<StorageController> &aStorageController,
830 bool aSetError = false);
831
832 HRESULT getMediumAttachmentsOfController(CBSTR aName,
833 MediaData::AttachmentList &aAttachments);
834
835 enum
836 {
837 /* flags for #saveSettings() */
838 SaveS_ResetCurStateModified = 0x01,
839 SaveS_InformCallbacksAnyway = 0x02,
840 /* flags for #saveSnapshotSettings() */
841 SaveSS_CurStateModified = 0x40,
842 SaveSS_CurrentId = 0x80,
843 /* flags for #saveStateSettings() */
844 SaveSTS_CurStateModified = 0x20,
845 SaveSTS_StateFilePath = 0x40,
846 SaveSTS_StateTimeStamp = 0x80,
847 };
848
849 HRESULT prepareSaveSettings(bool &aRenamed, bool &aNew);
850 HRESULT saveSettings(int aFlags = 0);
851
852 HRESULT saveAllSnapshots();
853
854 HRESULT saveHardware(settings::Hardware &data);
855 HRESULT saveStorageControllers(settings::Storage &data);
856 HRESULT saveStorageDevices(ComObjPtr<StorageController> aStorageController,
857 settings::StorageController &data);
858
859 HRESULT saveStateSettings(int aFlags);
860
861 HRESULT createImplicitDiffs(const Bstr &aFolder,
862 IProgress *aProgress,
863 ULONG aWeight,
864 bool aOnline);
865 HRESULT deleteImplicitDiffs();
866
867 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
868 IN_BSTR aControllerName,
869 LONG aControllerPort,
870 LONG aDevice);
871 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
872 ComObjPtr<Medium> pMedium);
873 MediumAttachment* findAttachment(const MediaData::AttachmentList &ll,
874 Guid &id);
875
876 void fixupMedia(bool aCommit, bool aOnline = false);
877
878 bool isInOwnDir(Utf8Str *aSettingsDir = NULL);
879
880 bool isModified();
881 bool isReallyModified(bool aIgnoreUserData = false);
882 void rollback(bool aNotify);
883 void commit();
884 void copyFrom(Machine *aThat);
885
886#ifdef VBOX_WITH_RESOURCE_USAGE_API
887 void registerMetrics(PerformanceCollector *aCollector, Machine *aMachine, RTPROCESS pid);
888 void unregisterMetrics(PerformanceCollector *aCollector, Machine *aMachine);
889#endif /* VBOX_WITH_RESOURCE_USAGE_API */
890
891 const InstanceType mType;
892
893 const ComObjPtr<Machine, ComWeakRef> mPeer;
894
895 const ComObjPtr<VirtualBox, ComWeakRef> mParent;
896
897 Shareable<Data> mData;
898 Shareable<SSData> mSSData;
899
900 Backupable<UserData> mUserData;
901 Backupable<HWData> mHWData;
902 Backupable<MediaData> mMediaData;
903
904 // the following fields need special backup/rollback/commit handling,
905 // so they cannot be a part of HWData
906
907 const ComObjPtr<VRDPServer> mVRDPServer;
908 const ComObjPtr<SerialPort>
909 mSerialPorts [SchemaDefs::SerialPortCount];
910 const ComObjPtr<ParallelPort>
911 mParallelPorts [SchemaDefs::ParallelPortCount];
912 const ComObjPtr<AudioAdapter> mAudioAdapter;
913 const ComObjPtr<USBController> mUSBController;
914 const ComObjPtr<BIOSSettings> mBIOSSettings;
915 const ComObjPtr<NetworkAdapter>
916 mNetworkAdapters [SchemaDefs::NetworkAdapterCount];
917
918 typedef std::list< ComObjPtr<StorageController> > StorageControllerList;
919 Backupable<StorageControllerList> mStorageControllers;
920
921 friend class SessionMachine;
922 friend class SnapshotMachine;
923};
924
925// SessionMachine class
926////////////////////////////////////////////////////////////////////////////////
927
928/**
929 * @note Notes on locking objects of this class:
930 * SessionMachine shares some data with the primary Machine instance (pointed
931 * to by the |mPeer| member). In order to provide data consistency it also
932 * shares its lock handle. This means that whenever you lock a SessionMachine
933 * instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
934 * instance is also locked in the same lock mode. Keep it in mind.
935 */
936class ATL_NO_VTABLE SessionMachine :
937 public VirtualBoxSupportTranslation<SessionMachine>,
938 public Machine,
939 VBOX_SCRIPTABLE_IMPL(IInternalMachineControl)
940{
941public:
942
943 VIRTUALBOXSUPPORTTRANSLATION_OVERRIDE(SessionMachine)
944
945 DECLARE_NOT_AGGREGATABLE(SessionMachine)
946
947 DECLARE_PROTECT_FINAL_CONSTRUCT()
948
949 BEGIN_COM_MAP(SessionMachine)
950 COM_INTERFACE_ENTRY2(IDispatch, IMachine)
951 COM_INTERFACE_ENTRY(ISupportErrorInfo)
952 COM_INTERFACE_ENTRY(IMachine)
953 COM_INTERFACE_ENTRY(IInternalMachineControl)
954 END_COM_MAP()
955
956 DECLARE_EMPTY_CTOR_DTOR(SessionMachine)
957
958 HRESULT FinalConstruct();
959 void FinalRelease();
960
961 // public initializer/uninitializer for internal purposes only
962 HRESULT init(Machine *aMachine);
963 void uninit() { uninit(Uninit::Unexpected); }
964
965 // util::Lockable interface
966 RWLockHandle *lockHandle() const;
967
968 // IInternalMachineControl methods
969 STDMETHOD(SetRemoveSavedState)(BOOL aRemove);
970 STDMETHOD(UpdateState)(MachineState_T machineState);
971 STDMETHOD(GetIPCId)(BSTR *id);
972 STDMETHOD(RunUSBDeviceFilters)(IUSBDevice *aUSBDevice, BOOL *aMatched, ULONG *aMaskedIfs);
973 STDMETHOD(CaptureUSBDevice)(IN_BSTR aId);
974 STDMETHOD(DetachUSBDevice)(IN_BSTR aId, BOOL aDone);
975 STDMETHOD(AutoCaptureUSBDevices)();
976 STDMETHOD(DetachAllUSBDevices)(BOOL aDone);
977 STDMETHOD(OnSessionEnd)(ISession *aSession, IProgress **aProgress);
978 STDMETHOD(BeginSavingState)(IProgress *aProgress, BSTR *aStateFilePath);
979 STDMETHOD(EndSavingState)(BOOL aSuccess);
980 STDMETHOD(AdoptSavedState)(IN_BSTR aSavedStateFile);
981 STDMETHOD(BeginTakingSnapshot)(IConsole *aInitiator,
982 IN_BSTR aName,
983 IN_BSTR aDescription,
984 IProgress *aConsoleProgress,
985 BOOL fTakingSnapshotOnline,
986 BSTR *aStateFilePath);
987 STDMETHOD(EndTakingSnapshot)(BOOL aSuccess);
988 STDMETHOD(DeleteSnapshot)(IConsole *aInitiator, IN_BSTR aId,
989 MachineState_T *aMachineState, IProgress **aProgress);
990 STDMETHOD(RestoreSnapshot)(IConsole *aInitiator,
991 ISnapshot *aSnapshot,
992 MachineState_T *aMachineState,
993 IProgress **aProgress);
994 STDMETHOD(PullGuestProperties)(ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues),
995 ComSafeArrayOut(ULONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
996 STDMETHOD(PushGuestProperties)(ComSafeArrayIn(IN_BSTR, aNames), ComSafeArrayIn(IN_BSTR, aValues),
997 ComSafeArrayIn(ULONG64, aTimestamps), ComSafeArrayIn(IN_BSTR, aFlags));
998 STDMETHOD(PushGuestProperty)(IN_BSTR aName, IN_BSTR aValue,
999 ULONG64 aTimestamp, IN_BSTR aFlags);
1000 STDMETHOD(LockMedia)() { return lockMedia(); }
1001 STDMETHOD(UnlockMedia)() { unlockMedia(); return S_OK; }
1002
1003 // public methods only for internal purposes
1004
1005 bool checkForDeath();
1006
1007 HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter);
1008 HRESULT onStorageControllerChange();
1009 HRESULT onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);
1010 HRESULT onSerialPortChange(ISerialPort *serialPort);
1011 HRESULT onParallelPortChange(IParallelPort *parallelPort);
1012 HRESULT onVRDPServerChange();
1013 HRESULT onUSBControllerChange();
1014 HRESULT onUSBDeviceAttach(IUSBDevice *aDevice,
1015 IVirtualBoxErrorInfo *aError,
1016 ULONG aMaskedIfs);
1017 HRESULT onUSBDeviceDetach(IN_BSTR aId,
1018 IVirtualBoxErrorInfo *aError);
1019 HRESULT onSharedFolderChange();
1020
1021 bool hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs);
1022
1023private:
1024
1025 struct SnapshotData
1026 {
1027 SnapshotData() : mLastState(MachineState_Null) {}
1028
1029 MachineState_T mLastState;
1030
1031 // used when taking snapshot
1032 ComObjPtr<Snapshot> mSnapshot;
1033
1034 // used when saving state
1035 Guid mProgressId;
1036 Utf8Str mStateFilePath;
1037 };
1038
1039 struct Uninit
1040 {
1041 enum Reason { Unexpected, Abnormal, Normal };
1042 };
1043
1044 struct SnapshotTask;
1045 struct DeleteSnapshotTask;
1046 struct RestoreSnapshotTask;
1047
1048 friend struct DeleteSnapshotTask;
1049 friend struct RestoreSnapshotTask;
1050
1051 void uninit(Uninit::Reason aReason);
1052
1053 HRESULT endSavingState(BOOL aSuccess);
1054 HRESULT endTakingSnapshot(BOOL aSuccess);
1055
1056 typedef std::map<ComObjPtr<Machine>, MachineState_T> AffectedMachines;
1057
1058 void deleteSnapshotHandler(DeleteSnapshotTask &aTask);
1059 void restoreSnapshotHandler(RestoreSnapshotTask &aTask);
1060
1061 HRESULT lockMedia();
1062 void unlockMedia();
1063
1064 HRESULT setMachineState(MachineState_T aMachineState);
1065 HRESULT updateMachineStateOnClient();
1066
1067 HRESULT mRemoveSavedState;
1068
1069 SnapshotData mSnapshotData;
1070
1071 /** interprocess semaphore handle for this machine */
1072#if defined(RT_OS_WINDOWS)
1073 HANDLE mIPCSem;
1074 Bstr mIPCSemName;
1075 friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
1076 ComPtr<IInternalSessionControl> *aControl,
1077 HANDLE *aIPCSem, bool aAllowClosing);
1078#elif defined(RT_OS_OS2)
1079 HMTX mIPCSem;
1080 Bstr mIPCSemName;
1081 friend bool Machine::isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
1082 ComPtr<IInternalSessionControl> *aControl,
1083 HMTX *aIPCSem, bool aAllowClosing);
1084#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1085 int mIPCSem;
1086# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
1087 Bstr mIPCKey;
1088# endif /*VBOX_WITH_NEW_SYS_V_KEYGEN */
1089#else
1090# error "Port me!"
1091#endif
1092
1093 static DECLCALLBACK(int) taskHandler(RTTHREAD thread, void *pvUser);
1094};
1095
1096// SnapshotMachine class
1097////////////////////////////////////////////////////////////////////////////////
1098
1099/**
1100 * @note Notes on locking objects of this class:
1101 * SnapshotMachine shares some data with the primary Machine instance (pointed
1102 * to by the |mPeer| member). In order to provide data consistency it also
1103 * shares its lock handle. This means that whenever you lock a SessionMachine
1104 * instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
1105 * instance is also locked in the same lock mode. Keep it in mind.
1106 */
1107class ATL_NO_VTABLE SnapshotMachine :
1108 public VirtualBoxSupportTranslation<SnapshotMachine>,
1109 public Machine
1110{
1111public:
1112
1113 VIRTUALBOXSUPPORTTRANSLATION_OVERRIDE(SnapshotMachine)
1114
1115 DECLARE_NOT_AGGREGATABLE(SnapshotMachine)
1116
1117 DECLARE_PROTECT_FINAL_CONSTRUCT()
1118
1119 BEGIN_COM_MAP(SnapshotMachine)
1120 COM_INTERFACE_ENTRY2(IDispatch, IMachine)
1121 COM_INTERFACE_ENTRY(ISupportErrorInfo)
1122 COM_INTERFACE_ENTRY(IMachine)
1123 END_COM_MAP()
1124
1125 DECLARE_EMPTY_CTOR_DTOR(SnapshotMachine)
1126
1127 HRESULT FinalConstruct();
1128 void FinalRelease();
1129
1130 // public initializer/uninitializer for internal purposes only
1131 HRESULT init(SessionMachine *aSessionMachine,
1132 IN_GUID aSnapshotId,
1133 const Utf8Str &aStateFilePath);
1134 HRESULT init(Machine *aMachine,
1135 const settings::Hardware &hardware,
1136 const settings::Storage &storage,
1137 IN_GUID aSnapshotId,
1138 const Utf8Str &aStateFilePath);
1139 void uninit();
1140
1141 // util::Lockable interface
1142 RWLockHandle *lockHandle() const;
1143
1144 // public methods only for internal purposes
1145
1146 HRESULT onSnapshotChange(Snapshot *aSnapshot);
1147
1148 // unsafe inline public methods for internal purposes only (ensure there is
1149 // a caller and a read lock before calling them!)
1150
1151 const Guid& getSnapshotId() const { return mSnapshotId; }
1152
1153private:
1154
1155 Guid mSnapshotId;
1156
1157 friend class Snapshot;
1158};
1159
1160// third party methods that depend on SnapshotMachine definiton
1161
1162inline const Guid &Machine::getSnapshotId() const
1163{
1164 return mType != IsSnapshotMachine ? Guid::Empty :
1165 static_cast<const SnapshotMachine *>(this)->getSnapshotId();
1166}
1167
1168////////////////////////////////////////////////////////////////////////////////
1169
1170/**
1171 * Returns a pointer to the Machine object for this machine that acts like a
1172 * parent for complex machine data objects such as shared folders, etc.
1173 *
1174 * For primary Machine objects and for SnapshotMachine objects, returns this
1175 * object's pointer itself. For SessoinMachine objects, returns the peer
1176 * (primary) machine pointer.
1177 */
1178inline Machine *Machine::getMachine()
1179{
1180 if (mType == IsSessionMachine)
1181 return mPeer;
1182 return this;
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.

© 2023 Oracle
Contact – Privacy policy – Terms of Use