VirtualBox

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

Last change on this file since 20961 was 20928, checked in by vboxsync, 15 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette