MachineImpl.h revision c1eabfdd25befbe50456ee60bf512e437558559e
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync/* $Id$ */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync/** @file
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * VirtualBox COM class declaration
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync/*
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * available from http://www.virtualbox.org. This file is free software;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * you can redistribute it and/or modify it under the terms of the GNU
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * General Public License (GPL) as published by the Free Software
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * additional information or have any questions.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#ifndef ____H_MACHINEIMPL
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#define ____H_MACHINEIMPL
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "VirtualBoxBase.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "ProgressImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "SnapshotImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "VRDPServerImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "DVDDriveImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "FloppyDriveImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "HardDiskAttachmentImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "Collection.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "NetworkAdapterImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "AudioAdapterImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "SerialPortImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "ParallelPortImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "BIOSSettingsImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "SATAControllerImpl.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync// generated header
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include "SchemaDefs.h"
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <VBox/types.h>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <iprt/file.h>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <iprt/thread.h>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <iprt/time.h>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#ifdef VBOX_WITH_RESOURCE_USAGE_API
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <iprt/system.h>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <iprt/timer.h>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#endif /* VBOX_WITH_RESOURCE_USAGE_API */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#include <list>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync// defines
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync////////////////////////////////////////////////////////////////////////////////
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync// helper declarations
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync////////////////////////////////////////////////////////////////////////////////
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass VirtualBox;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass Progress;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass CombinedProgress;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass Keyboard;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass Mouse;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass Display;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass MachineDebugger;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass USBController;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass Snapshot;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass SharedFolder;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass HostUSBDevice;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass SessionMachine;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync// Machine class
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync////////////////////////////////////////////////////////////////////////////////
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncclass ATL_NO_VTABLE Machine :
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync public VirtualBoxBaseWithChildrenNEXT,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync public VirtualBoxSupportErrorInfoImpl <Machine, IMachine>,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync public VirtualBoxSupportTranslation <Machine>,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync public IMachine
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync{
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Q_OBJECT
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsyncpublic:
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Internal machine data.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Only one instance of this data exists per every machine --
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * it is shared by the Machine, SessionMachine and all SnapshotMachine
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * instances associated with the given machine using the util::Shareable
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * template through the mData variable.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * @note |const| members are persistent during lifetime so can be
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * accessed without locking.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * @note There is no need to lock anything inside init() or uninit()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * methods, because they are always serialized (see AutoCaller).
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync struct Data
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Data structure to hold information about sessions opened for the
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * given machine.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync struct Session
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Control of the direct session opened by openSession() */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ComPtr <IInternalSessionControl> mDirectControl;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync typedef std::list <ComPtr <IInternalSessionControl> > RemoteControlList;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** list of controls of all opened remote sessions */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync RemoteControlList mRemoteControls;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** openRemoteSession() and OnSessionEnd() progress indicator */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ComObjPtr <Progress> mProgress;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * PID of the session object that must be passed to openSession()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * to finalize the openRemoteSession() request
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * (i.e., PID of the process created by openRemoteSession())
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync RTPROCESS mPid;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Current session state */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync SessionState_T mState;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Session type string (for indirect sessions) */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mType;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Sesison machine object */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ComObjPtr <SessionMachine> mMachine;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Data();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ~Data();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync const Guid mUuid;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL mRegistered;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mConfigFile;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mConfigFileFull;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Utf8Str mSettingsFileVersion;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL mAccessible;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync com::ErrorInfo mAccessError;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync MachineState_T mMachineState;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync RTTIMESPEC mLastStateChange;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /* Note: These are guarded by VirtualBoxBase::stateLockHandle() */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync uint32_t mMachineStateDeps;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync RTSEMEVENTMULTI mMachineStateDepsSem;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync uint32_t mMachineStateChangePending;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL mCurrentStateModified;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync RTFILE mHandleCfgFile;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Session mSession;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ComObjPtr <Snapshot> mFirstSnapshot;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ComObjPtr <Snapshot> mCurrentSnapshot;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#ifdef VBOX_WITH_RESOURCE_USAGE_API
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Pointer to the usage sampling timer. */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync PRTTIMER mUsageSampler;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Structure to hold processor usage stats. */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync RTPROCCPUUSAGESTATS mCpuStats;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync#endif /* VBOX_WITH_RESOURCE_USAGE_API */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Saved state data.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * It's actually only the state file path string, but it needs to be
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * separate from Data, because Machine and SessionMachine instances
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * share it, while SnapshotMachine does not.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * The data variable is |mSSData|.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync struct SSData
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mStateFilePath;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * User changeable machine data.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * This data is common for all machine snapshots, i.e. it is shared
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * by all SnapshotMachine instances associated with the given machine
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * using the util::Backupable template through the |mUserData| variable.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * SessionMachine instances can alter this data and discard changes.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * @note There is no need to lock anything inside init() or uninit()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * methods, because they are always serialized (see AutoCaller).
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync struct UserData
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync UserData();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ~UserData();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync bool operator== (const UserData &that) const
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync return this == &that ||
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync (mName == that.mName &&
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mNameSync == that.mNameSync &&
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mDescription == that.mDescription &&
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mOSTypeId == that.mOSTypeId &&
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mSnapshotFolderFull == that.mSnapshotFolderFull);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mName;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL mNameSync;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mDescription;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mOSTypeId;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mSnapshotFolder;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Bstr mSnapshotFolderFull;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Hardware data.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * This data is unique for a machine and for every machine snapshot.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Stored using the util::Backupable template in the |mHWData| variable.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * SessionMachine instances can alter this data and discard changes.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync struct HWData
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HWData();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ~HWData();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync bool operator== (const HWData &that) const;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ULONG mMemorySize;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ULONG mMemoryBalloonSize;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ULONG mStatisticsUpdateInterval;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ULONG mVRAMSize;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ULONG mMonitorCount;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync TSBool_T mHWVirtExEnabled;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL mPAEEnabled;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync DeviceType_T mBootOrder [SchemaDefs::MaxBootPosition];
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync typedef std::list <ComObjPtr <SharedFolder> > SharedFolderList;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync SharedFolderList mSharedFolders;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ClipboardMode_T mClipboardMode;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Hard disk data.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * The usage policy is the same as for HWData, but a separate structure
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * is necessarym because hard disk data requires different procedures when
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * taking or discarding snapshots, etc.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * The data variable is |mHWData|.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync struct HDData
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HDData();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ~HDData();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync bool operator== (const HDData &that) const;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync typedef std::list <ComObjPtr <HardDiskAttachment> > HDAttachmentList;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HDAttachmentList mHDAttachments;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Right after Machine::fixupHardDisks(true): |true| if hard disks
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * were actually changed, |false| otherwise
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync bool mHDAttachmentsChanged;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync enum StateDependency
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync AnyStateDep = 0, MutableStateDep, MutableOrSavedStateDep
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Helper class that safely manages the machine state dependency by
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * calling Machine::addStateDependency() on construction and
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Machine::releaseStateDependency() on destruction. Intended for Machine
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * children. The usage pattern is:
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * @code
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * AutoCaller autoCaller (this);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * CheckComRCReturnRC (autoCaller.rc());
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Machine::AutoStateDependency <MutableStateDep> adep (mParent);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * CheckComRCReturnRC (stateDep.rc());
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * ...
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * // code that depends on the particular machine state
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * ...
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * @endcode
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Note that it is more convenient to use the following individual
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * shortcut classes instead of using this template directly:
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * AutoAnyStateDependency, AutoMutableStateDependency and
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * AutoMutableOrSavedStateDependency. The usage pattern is exactly the
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * same as above except that there is no need to specify the template
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * argument because it is already done by the shortcut class.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * @param taDepType Dependecy type to manage.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync template <StateDependency taDepType = AnyStateDep>
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync class AutoStateDependency
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync public:
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync AutoStateDependency (Machine *aThat)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync : mThat (aThat), mRC (S_OK)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync , mMachineState (MachineState_Null)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync , mRegistered (FALSE)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Assert (aThat);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mRC = aThat->addStateDependency (taDepType, &mMachineState,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync &mRegistered);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync ~AutoStateDependency()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync if (SUCCEEDED (mRC))
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mThat->releaseStateDependency();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Decreases the number of dependencies before the instance is
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * destroyed. Note that will reset #rc() to E_FAIL. */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync void release()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync AssertReturnVoid (SUCCEEDED (mRC));
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mThat->releaseStateDependency();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mRC = E_FAIL;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Restores the number of callers after by #release(). #rc() will be
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * reset to the result of calling addStateDependency() and must be
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * rechecked to ensure the operation succeeded. */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync void add()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync {
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync AssertReturnVoid (!SUCCEEDED (mRC));
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync mRC = mThat->addStateDependency (taDepType, &mMachineState,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync &mRegistered);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Returns the result of Machine::addStateDependency(). */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HRESULT rc() const { return mRC; }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Shortcut to SUCCEEDED (rc()). */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync bool isOk() const { return SUCCEEDED (mRC); }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Returns the machine state value as returned by
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Machine::addStateDependency(). */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync MachineState_T machineState() const { return mMachineState; }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /** Returns the machine state value as returned by
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Machine::addStateDependency(). */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL machineRegistered() const { return mRegistered; }
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync protected:
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync Machine *mThat;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HRESULT mRC;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync MachineState_T mMachineState;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL mRegistered;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync private:
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (AutoStateDependency)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync DECLARE_CLS_NEW_DELETE_NOOP (AutoStateDependency)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Shortcut to AutoStateDependency <AnyStateDep>.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * See AutoStateDependency to get the usage pattern.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Accepts any machine state and guarantees the state won't change before
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * this object is destroyed. If the machine state cannot be protected (as
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * a result of the state change currently in progress), this instance's
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * #rc() method will indicate a failure, and the caller is not allowed to
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * rely on any particular machine state and should return the failed
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * result code to the upper level.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync typedef AutoStateDependency <AnyStateDep> AutoAnyStateDependency;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Shortcut to AutoStateDependency <MutableStateDep>.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * See AutoStateDependency to get the usage pattern.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Succeeds only if the machine state is in one of the mutable states, and
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * guarantees the given mutable state won't change before this object is
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * destroyed. If the machine is not mutable, this instance's #rc() method
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * will indicate a failure, and the caller is not allowed to rely on any
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * particular machine state and should return the failed result code to
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * the upper level.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Intended to be used within all setter methods of IMachine
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * children objects (DVDDrive, NetworkAdapter, AudioAdapter, etc.) to
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * provide data protection and consistency.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync typedef AutoStateDependency <MutableStateDep> AutoMutableStateDependency;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync /**
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Shortcut to AutoStateDependency <MutableOrSavedStateDep>.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * See AutoStateDependency to get the usage pattern.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Succeeds only if the machine state is in one of the mutable states, or
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * if the machine is in the Saved state, and guarantees the given mutable
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * state won't change before this object is destroyed. If the machine is
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * not mutable, this instance's #rc() method will indicate a failure, and
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * the caller is not allowed to rely on any particular machine state and
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * should return the failed result code to the upper level.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync *
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * Intended to be used within setter methods of IMachine
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync * children objects that may also operate on Saved machines.
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync */
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync typedef AutoStateDependency <MutableOrSavedStateDep> AutoMutableOrSavedStateDependency;
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (Machine)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync DECLARE_NOT_AGGREGATABLE(Machine)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BEGIN_COM_MAP(Machine)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync COM_INTERFACE_ENTRY(ISupportErrorInfo)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync COM_INTERFACE_ENTRY(IMachine)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync END_COM_MAP()
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync NS_DECL_ISUPPORTS
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync DECLARE_EMPTY_CTOR_DTOR (Machine)
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HRESULT FinalConstruct();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync void FinalRelease();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync enum InitMode { Init_New, Init_Existing, Init_Registered };
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync // public initializer/uninitializer for internal purposes only
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync HRESULT init (VirtualBox *aParent, const BSTR aConfigFile,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync InitMode aMode, const BSTR aName = NULL,
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync BOOL aNameSync = TRUE, const Guid *aId = NULL);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync void uninit();
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync // IMachine properties
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(Parent))(IVirtualBox **aParent);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(Accessible)) (BOOL *aAccessible);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(AccessError)) (IVirtualBoxErrorInfo **aAccessError);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(Name))(BSTR *aName);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(Name))(INPTR BSTR aName);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(Description))(BSTR *aDescription);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(Description))(INPTR BSTR aDescription);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(Id))(GUIDPARAMOUT aId);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(OSTypeId)) (BSTR *aOSTypeId);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(OSTypeId)) (INPTR BSTR aOSTypeId);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(MemorySize))(ULONG *memorySize);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(MemorySize))(ULONG memorySize);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(MemoryBalloonSize))(ULONG *memoryBalloonSize);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(MemoryBalloonSize))(ULONG memoryBalloonSize);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(StatisticsUpdateInterval))(ULONG *statisticsUpdateInterval);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(StatisticsUpdateInterval))(ULONG statisticsUpdateInterval);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(VRAMSize))(ULONG *memorySize);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(VRAMSize))(ULONG memorySize);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(MonitorCount))(ULONG *monitorCount);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(MonitorCount))(ULONG monitorCount);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(BIOSSettings))(IBIOSSettings **biosSettings);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(HWVirtExEnabled))(TSBool_T *enabled);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(HWVirtExEnabled))(TSBool_T enabled);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(PAEEnabled))(BOOL *enabled);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(PAEEnabled))(BOOL enabled);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(SnapshotFolder))(BSTR *aSavedStateFolder);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMSETTER(SnapshotFolder))(INPTR BSTR aSavedStateFolder);
15c5e2945e3abf354a7d822904579c64f7a190c3vboxsync STDMETHOD(COMGETTER(HardDiskAttachments))(IHardDiskAttachmentCollection **attachments);
STDMETHOD(COMGETTER(VRDPServer))(IVRDPServer **vrdpServer);
STDMETHOD(COMGETTER(DVDDrive))(IDVDDrive **dvdDrive);
STDMETHOD(COMGETTER(FloppyDrive))(IFloppyDrive **floppyDrive);
STDMETHOD(COMGETTER(AudioAdapter))(IAudioAdapter **audioAdapter);
STDMETHOD(COMGETTER(USBController)) (IUSBController * *aUSBController);
STDMETHOD(COMGETTER(SATAController)) (ISATAController **aSATAController);
STDMETHOD(COMGETTER(SettingsFilePath)) (BSTR *aFilePath);
STDMETHOD(COMGETTER(SettingsFileVersion)) (BSTR *aSettingsFileVersion);
STDMETHOD(COMGETTER(SettingsModified)) (BOOL *aModified);
STDMETHOD(COMGETTER(SessionState)) (SessionState_T *aSessionState);
STDMETHOD(COMGETTER(SessionType)) (BSTR *aSessionType);
STDMETHOD(COMGETTER(SessionPid)) (ULONG *aSessionPid);
STDMETHOD(COMGETTER(State)) (MachineState_T *machineState);
STDMETHOD(COMGETTER(LastStateChange)) (LONG64 *aLastStateChange);
STDMETHOD(COMGETTER(StateFilePath)) (BSTR *aStateFilePath);
STDMETHOD(COMGETTER(LogFolder)) (BSTR *aLogFolder);
STDMETHOD(COMGETTER(CurrentSnapshot)) (ISnapshot **aCurrentSnapshot);
STDMETHOD(COMGETTER(SnapshotCount)) (ULONG *aSnapshotCount);
STDMETHOD(COMGETTER(CurrentStateModified))(BOOL *aCurrentStateModified);
STDMETHOD(COMGETTER(SharedFolders)) (ISharedFolderCollection **aSharedFolders);
STDMETHOD(COMGETTER(ClipboardMode)) (ClipboardMode_T *aClipboardMode);
STDMETHOD(COMSETTER(ClipboardMode)) (ClipboardMode_T aClipboardMode);
// IMachine methods
STDMETHOD(SetBootOrder)(ULONG aPosition, DeviceType_T aDevice);
STDMETHOD(GetBootOrder)(ULONG aPosition, DeviceType_T *aDevice);
STDMETHOD(AttachHardDisk)(INPTR GUIDPARAM aId, StorageBus_T aBus, LONG aChannel, LONG aDevice);
STDMETHOD(GetHardDisk)(StorageBus_T aBus, LONG aChannel, LONG aDevice, IHardDisk **aHardDisk);
STDMETHOD(DetachHardDisk) (StorageBus_T aBus, LONG aChannel, LONG aDevice);
STDMETHOD(GetSerialPort) (ULONG slot, ISerialPort **port);
STDMETHOD(GetParallelPort) (ULONG slot, IParallelPort **port);
STDMETHOD(GetNetworkAdapter) (ULONG slot, INetworkAdapter **adapter);
STDMETHOD(GetNextExtraDataKey)(INPTR BSTR aKey, BSTR *aNextKey, BSTR *aNextValue);
STDMETHOD(GetExtraData)(INPTR BSTR aKey, BSTR *aValue);
STDMETHOD(SetExtraData)(INPTR BSTR aKey, INPTR BSTR aValue);
STDMETHOD(SaveSettings)();
STDMETHOD(SaveSettingsWithBackup) (BSTR *aBakFileName);
STDMETHOD(DiscardSettings)();
STDMETHOD(DeleteSettings)();
STDMETHOD(GetSnapshot) (INPTR GUIDPARAM aId, ISnapshot **aSnapshot);
STDMETHOD(FindSnapshot) (INPTR BSTR aName, ISnapshot **aSnapshot);
STDMETHOD(SetCurrentSnapshot) (INPTR GUIDPARAM aId);
STDMETHOD(CreateSharedFolder) (INPTR BSTR aName, INPTR BSTR aHostPath, BOOL aWritable);
STDMETHOD(RemoveSharedFolder) (INPTR BSTR aName);
STDMETHOD(CanShowConsoleWindow) (BOOL *aCanShow);
STDMETHOD(ShowConsoleWindow) (ULONG64 *aWinId);
STDMETHOD(GetConfigRegistryValue) (INPTR BSTR aKey, BSTR *aValue);
STDMETHOD(SetConfigRegistryValue) (INPTR BSTR aKey, INPTR BSTR aValue);
STDMETHOD(GetProcessorUsage) (ULONG *user, ULONG *system);
// public methods only for internal purposes
/// @todo (dmik) add lock and make non-inlined after revising classes
// that use it. Note: they should enter Machine lock to keep the returned
// information valid!
bool isRegistered() { return !!mData->mRegistered; }
ComObjPtr <SessionMachine> sessionMachine();
/**
* Returns the VirtualBox object this machine belongs to.
*
* @note This method doesn't check this object's readiness as it is
* intended to be used only by Machine children where it is guaranteed
* that this object still exists in memory.
*/
const ComObjPtr <VirtualBox, ComWeakRef> &virtualBox() const { return mParent; }
/**
* Returns this machine's name.
*
* @note This method doesn't check this object's readiness as it is
* intended to be used only after adding a caller to this object (that
* guarantees that the object is ready or at least limited).
*/
const Guid &uuid() const { return mData->mUuid; }
/**
* Returns this machine's full settings file path.
*
* @note This method doesn't lock this object or check its readiness as
* it is intended to be used only after adding a caller to this object
* (that guarantees that the object is ready) and locking it for reading.
*/
const Bstr &settingsFileFull() const { return mData->mConfigFileFull; }
/**
* Returns this machine's name.
*
* @note This method doesn't lock this object or check its readiness as
* it is intended to be used only after adding a caller to this object
* (that guarantees that the object is ready) and locking it for reading.
*/
const Bstr &name() const { return mUserData->mName; }
// callback handlers
virtual HRESULT onDVDDriveChange() { return S_OK; }
virtual HRESULT onFloppyDriveChange() { return S_OK; }
virtual HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter) { return S_OK; }
virtual HRESULT onSerialPortChange(ISerialPort *serialPort) { return S_OK; }
virtual HRESULT onParallelPortChange(IParallelPort *ParallelPort) { return S_OK; }
virtual HRESULT onVRDPServerChange() { return S_OK; }
virtual HRESULT onUSBControllerChange() { return S_OK; }
virtual HRESULT onSATAControllerChange() { return S_OK; }
virtual HRESULT onSharedFolderChange() { return S_OK; }
HRESULT saveRegistryEntry (settings::Key &aEntryNode);
int calculateFullPath (const char *aPath, Utf8Str &aResult);
void calculateRelativePath (const char *aPath, Utf8Str &aResult);
void getLogFolder (Utf8Str &aLogFolder);
bool isDVDImageUsed (const Guid &aId, ResourceUsage_T aUsage);
bool isFloppyImageUsed (const Guid &aId, ResourceUsage_T aUsage);
HRESULT openSession (IInternalSessionControl *aControl);
HRESULT openRemoteSession (IInternalSessionControl *aControl,
INPTR BSTR aType, INPTR BSTR aEnvironment,
Progress *aProgress);
HRESULT openExistingSession (IInternalSessionControl *aControl);
HRESULT trySetRegistered (BOOL aRegistered);
HRESULT getSharedFolder (const BSTR aName,
ComObjPtr <SharedFolder> &aSharedFolder,
bool aSetError = false)
{
AutoWriteLock alock (this);
return findSharedFolder (aName, aSharedFolder, aSetError);
}
HRESULT addStateDependency (StateDependency aDepType = AnyStateDep,
MachineState_T *aState = NULL,
BOOL *aRegistered = NULL);
void releaseStateDependency();
// for VirtualBoxSupportErrorInfoImpl
static const wchar_t *getComponentName() { return L"Machine"; }
protected:
enum InstanceType { IsMachine, IsSessionMachine, IsSnapshotMachine };
HRESULT registeredInit();
HRESULT checkStateDependency (StateDependency aDepType);
inline Machine *machine();
HRESULT initDataAndChildObjects();
void uninitDataAndChildObjects();
void ensureNoStateDependencies (AutoWriteLock &aLock);
virtual HRESULT setMachineState (MachineState_T aMachineState);
HRESULT findSharedFolder (const BSTR aName,
ComObjPtr <SharedFolder> &aSharedFolder,
bool aSetError = false);
HRESULT loadSettings (bool aRegistered);
HRESULT loadSnapshot (const settings::Key &aNode, const Guid &aCurSnapshotId,
Snapshot *aParentSnapshot);
HRESULT loadHardware (const settings::Key &aNode);
HRESULT loadHardDisks (const settings::Key &aNode, bool aRegistered,
const Guid *aSnapshotId = NULL);
HRESULT findSnapshotNode (Snapshot *aSnapshot, settings::Key &aMachineNode,
settings::Key *aSnapshotsNode,
settings::Key *aSnapshotNode);
HRESULT findSnapshot (const Guid &aId, ComObjPtr <Snapshot> &aSnapshot,
bool aSetError = false);
HRESULT findSnapshot (const BSTR aName, ComObjPtr <Snapshot> &aSnapshot,
bool aSetError = false);
HRESULT findHardDiskAttachment (const ComObjPtr <HardDisk> &aHd,
ComObjPtr <Machine> *aMachine,
ComObjPtr <Snapshot> *aSnapshot,
ComObjPtr <HardDiskAttachment> *aHda);
HRESULT prepareSaveSettings (bool &aRenamed, bool &aNew);
HRESULT saveSettings (bool aMarkCurStateAsModified = true,
bool aInformCallbacksAnyway = false);
enum
{
// ops for #saveSnapshotSettings()
SaveSS_NoOp = 0x00, SaveSS_AddOp = 0x01,
SaveSS_UpdateAttrsOp = 0x02, SaveSS_UpdateAllOp = 0x03,
SaveSS_OpMask = 0xF,
// flags for #saveSnapshotSettings()
SaveSS_UpdateCurStateModified = 0x40,
SaveSS_UpdateCurrentId = 0x80,
// flags for #saveStateSettings()
SaveSTS_CurStateModified = 0x20,
SaveSTS_StateFilePath = 0x40,
SaveSTS_StateTimeStamp = 0x80,
};
HRESULT saveSnapshotSettings (Snapshot *aSnapshot, int aOpFlags);
HRESULT saveSnapshotSettingsWorker (settings::Key &aMachineNode,
Snapshot *aSnapshot, int aOpFlags);
HRESULT saveSnapshot (settings::Key &aNode, Snapshot *aSnapshot, bool aAttrsOnly);
HRESULT saveHardware (settings::Key &aNode);
HRESULT saveHardDisks (settings::Key &aNode);
HRESULT saveStateSettings (int aFlags);
HRESULT wipeOutImmutableDiffs();
HRESULT fixupHardDisks (bool aCommit);
HRESULT createSnapshotDiffs (const Guid *aSnapshotId,
const Bstr &aFolder,
const ComObjPtr <Progress> &aProgress,
bool aOnline);
HRESULT deleteSnapshotDiffs (const ComObjPtr <Snapshot> &aSnapshot);
HRESULT lockConfig();
HRESULT unlockConfig();
/** @note This method is not thread safe */
BOOL isConfigLocked()
{
return !!mData && mData->mHandleCfgFile != NIL_RTFILE;
}
bool isInOwnDir (Utf8Str *aSettingsDir = NULL);
bool isModified();
bool isReallyModified (bool aIgnoreUserData = false);
void rollback (bool aNotify);
HRESULT commit();
void copyFrom (Machine *aThat);
#ifdef VBOX_WITH_RESOURCE_USAGE_API
/** Static timer callback. */
static void UsageSamplerCallback (PRTTIMER pTimer, void *pvUser, uint64_t iTick);
/** Member timer callback. */
void usageSamplerCallback();
#endif /* VBOX_WITH_RESOURCE_USAGE_API */
const InstanceType mType;
const ComObjPtr <Machine, ComWeakRef> mPeer;
const ComObjPtr <VirtualBox, ComWeakRef> mParent;
Shareable <Data> mData;
Shareable <SSData> mSSData;
Backupable <UserData> mUserData;
Backupable <HWData> mHWData;
Backupable <HDData> mHDData;
// the following fields need special backup/rollback/commit handling,
// so they cannot be a part of HWData
const ComObjPtr <VRDPServer> mVRDPServer;
const ComObjPtr <DVDDrive> mDVDDrive;
const ComObjPtr <FloppyDrive> mFloppyDrive;
const ComObjPtr <SerialPort>
mSerialPorts [SchemaDefs::SerialPortCount];
const ComObjPtr <ParallelPort>
mParallelPorts [SchemaDefs::ParallelPortCount];
const ComObjPtr <AudioAdapter> mAudioAdapter;
const ComObjPtr <USBController> mUSBController;
const ComObjPtr <SATAController> mSATAController;
const ComObjPtr <BIOSSettings> mBIOSSettings;
const ComObjPtr <NetworkAdapter>
mNetworkAdapters [SchemaDefs::NetworkAdapterCount];
friend class SessionMachine;
friend class SnapshotMachine;
};
// SessionMachine class
////////////////////////////////////////////////////////////////////////////////
/**
* @note Notes on locking objects of this class:
* SessionMachine shares some data with the primary Machine instance (pointed
* to by the |mPeer| member). In order to provide data consistency it also
* shares its lock handle. This means that whenever you lock a SessionMachine
* instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
* instance is also locked in the same lock mode. Keep it in mind.
*/
class ATL_NO_VTABLE SessionMachine :
public VirtualBoxSupportTranslation <SessionMachine>,
public Machine,
public IInternalMachineControl
{
public:
VIRTUALBOXSUPPORTTRANSLATION_OVERRIDE(SessionMachine)
DECLARE_NOT_AGGREGATABLE(SessionMachine)
DECLARE_PROTECT_FINAL_CONSTRUCT()
BEGIN_COM_MAP(SessionMachine)
COM_INTERFACE_ENTRY(ISupportErrorInfo)
COM_INTERFACE_ENTRY(IMachine)
COM_INTERFACE_ENTRY(IInternalMachineControl)
END_COM_MAP()
NS_DECL_ISUPPORTS
DECLARE_EMPTY_CTOR_DTOR (SessionMachine)
HRESULT FinalConstruct();
void FinalRelease();
// public initializer/uninitializer for internal purposes only
HRESULT init (Machine *aMachine);
void uninit() { uninit (Uninit::Unexpected); }
// util::Lockable interface
RWLockHandle *lockHandle() const;
// IInternalMachineControl methods
STDMETHOD(UpdateState)(MachineState_T machineState);
STDMETHOD(GetIPCId)(BSTR *id);
STDMETHOD(RunUSBDeviceFilters) (IUSBDevice *aUSBDevice, BOOL *aMatched, ULONG *aMaskedIfs);
STDMETHOD(CaptureUSBDevice) (INPTR GUIDPARAM aId);
STDMETHOD(DetachUSBDevice) (INPTR GUIDPARAM aId, BOOL aDone);
STDMETHOD(AutoCaptureUSBDevices)();
STDMETHOD(DetachAllUSBDevices)(BOOL aDone);
STDMETHOD(OnSessionEnd)(ISession *aSession, IProgress **aProgress);
STDMETHOD(BeginSavingState) (IProgress *aProgress, BSTR *aStateFilePath);
STDMETHOD(EndSavingState) (BOOL aSuccess);
STDMETHOD(AdoptSavedState) (INPTR BSTR aSavedStateFile);
STDMETHOD(BeginTakingSnapshot) (IConsole *aInitiator,
INPTR BSTR aName, INPTR BSTR aDescription,
IProgress *aProgress, BSTR *aStateFilePath,
IProgress **aServerProgress);
STDMETHOD(EndTakingSnapshot) (BOOL aSuccess);
STDMETHOD(DiscardSnapshot) (IConsole *aInitiator, INPTR GUIDPARAM aId,
MachineState_T *aMachineState, IProgress **aProgress);
STDMETHOD(DiscardCurrentState) (
IConsole *aInitiator, MachineState_T *aMachineState, IProgress **aProgress);
STDMETHOD(DiscardCurrentSnapshotAndState) (
IConsole *aInitiator, MachineState_T *aMachineState, IProgress **aProgress);
// public methods only for internal purposes
bool checkForDeath();
#if defined (RT_OS_WINDOWS)
HANDLE ipcSem() { return mIPCSem; }
#elif defined (RT_OS_OS2)
HMTX ipcSem() { return mIPCSem; }
#endif
HRESULT onDVDDriveChange();
HRESULT onFloppyDriveChange();
HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter);
HRESULT onSerialPortChange(ISerialPort *serialPort);
HRESULT onParallelPortChange(IParallelPort *parallelPort);
HRESULT onVRDPServerChange();
HRESULT onUSBControllerChange();
HRESULT onUSBDeviceAttach (IUSBDevice *aDevice,
IVirtualBoxErrorInfo *aError,
ULONG aMaskedIfs);
HRESULT onUSBDeviceDetach (INPTR GUIDPARAM aId,
IVirtualBoxErrorInfo *aError);
HRESULT onSharedFolderChange();
bool hasMatchingUSBFilter (const ComObjPtr <HostUSBDevice> &aDevice, ULONG *aMaskedIfs);
private:
struct SnapshotData
{
SnapshotData() : mLastState (MachineState_Null) {}
MachineState_T mLastState;
// used when taking snapshot
ComObjPtr <Snapshot> mSnapshot;
ComObjPtr <Progress> mServerProgress;
ComObjPtr <CombinedProgress> mCombinedProgress;
// used when saving state
Guid mProgressId;
Bstr mStateFilePath;
};
struct Uninit {
enum Reason { Unexpected, Abnormal, Normal };
};
struct Task;
struct TakeSnapshotTask;
struct DiscardSnapshotTask;
struct DiscardCurrentStateTask;
friend struct TakeSnapshotTask;
friend struct DiscardSnapshotTask;
friend struct DiscardCurrentStateTask;
void uninit (Uninit::Reason aReason);
HRESULT endSavingState (BOOL aSuccess);
HRESULT endTakingSnapshot (BOOL aSuccess);
typedef std::map <ComObjPtr <Machine>, MachineState_T> AffectedMachines;
void takeSnapshotHandler (TakeSnapshotTask &aTask);
void discardSnapshotHandler (DiscardSnapshotTask &aTask);
void discardCurrentStateHandler (DiscardCurrentStateTask &aTask);
HRESULT setMachineState (MachineState_T aMachineState);
HRESULT updateMachineStateOnClient();
SnapshotData mSnapshotData;
/** interprocess semaphore handle (id) for this machine */
#if defined(RT_OS_WINDOWS)
HANDLE mIPCSem;
Bstr mIPCSemName;
#elif defined(RT_OS_OS2)
HMTX mIPCSem;
Bstr mIPCSemName;
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
int mIPCSem;
#else
# error "Port me!"
#endif
static DECLCALLBACK(int) taskHandler (RTTHREAD thread, void *pvUser);
};
// SnapshotMachine class
////////////////////////////////////////////////////////////////////////////////
/**
* @note Notes on locking objects of this class:
* SnapshotMachine shares some data with the primary Machine instance (pointed
* to by the |mPeer| member). In order to provide data consistency it also
* shares its lock handle. This means that whenever you lock a SessionMachine
* instance using Auto[Reader]Lock or AutoMultiLock, the corresponding Machine
* instance is also locked in the same lock mode. Keep it in mind.
*/
class ATL_NO_VTABLE SnapshotMachine :
public VirtualBoxSupportTranslation <SnapshotMachine>,
public Machine
{
public:
VIRTUALBOXSUPPORTTRANSLATION_OVERRIDE(SnapshotMachine)
DECLARE_NOT_AGGREGATABLE(SnapshotMachine)
DECLARE_PROTECT_FINAL_CONSTRUCT()
BEGIN_COM_MAP(SnapshotMachine)
COM_INTERFACE_ENTRY(ISupportErrorInfo)
COM_INTERFACE_ENTRY(IMachine)
END_COM_MAP()
NS_DECL_ISUPPORTS
DECLARE_EMPTY_CTOR_DTOR (SnapshotMachine)
HRESULT FinalConstruct();
void FinalRelease();
// public initializer/uninitializer for internal purposes only
HRESULT init (SessionMachine *aSessionMachine,
INPTR GUIDPARAM aSnapshotId, INPTR BSTR aStateFilePath);
HRESULT init (Machine *aMachine,
const settings::Key &aHWNode, const settings::Key &aHDAsNode,
INPTR GUIDPARAM aSnapshotId, INPTR BSTR aStateFilePath);
void uninit();
// util::Lockable interface
RWLockHandle *lockHandle() const;
// public methods only for internal purposes
HRESULT onSnapshotChange (Snapshot *aSnapshot);
private:
Guid mSnapshotId;
friend class Snapshot;
};
////////////////////////////////////////////////////////////////////////////////
/**
* Returns a pointer to the Machine object for this machine that acts like a
* parent for complex machine data objects such as shared folders, etc.
*
* For primary Machine objects and for SnapshotMachine objects, returns this
* object's pointer itself. For SessoinMachine objects, returns the peer
* (primary) machine pointer.
*/
inline Machine *Machine::machine()
{
if (mType == IsSessionMachine)
return mPeer;
return this;
}
COM_DECL_READONLY_ENUM_AND_COLLECTION (Machine)
#endif // ____H_MACHINEIMPL