diff options
Diffstat (limited to 'src/VBox/Devices/VMMDev/VMMDevState.h')
| -rw-r--r-- | src/VBox/Devices/VMMDev/VMMDevState.h | 589 |
1 files changed, 589 insertions, 0 deletions
diff --git a/src/VBox/Devices/VMMDev/VMMDevState.h b/src/VBox/Devices/VMMDev/VMMDevState.h new file mode 100644 index 00000000..dcaa41a0 --- /dev/null +++ b/src/VBox/Devices/VMMDev/VMMDevState.h @@ -0,0 +1,589 @@ +/* $Id: VMMDevState.h $ */ +/** @file + * VMMDev - Guest <-> VMM/Host communication device, internal header. + */ + +/* + * Copyright (C) 2006-2022 Oracle and/or its affiliates. + * + * This file is part of VirtualBox base platform packages, as + * available from https://www.virtualbox.org. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, in version 3 of the + * License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, see <https://www.gnu.org/licenses>. + * + * SPDX-License-Identifier: GPL-3.0-only + */ + +#ifndef VBOX_INCLUDED_SRC_VMMDev_VMMDevState_h +#define VBOX_INCLUDED_SRC_VMMDev_VMMDevState_h +#ifndef RT_WITHOUT_PRAGMA_ONCE +# pragma once +#endif + +#include <VBoxVideo.h> /* For VBVA definitions. */ +#include <VBox/VMMDev.h> +#include <VBox/vmm/pdmdev.h> +#include <VBox/vmm/pdmifs.h> +#ifndef VBOX_WITHOUT_TESTING_FEATURES +# include <VBox/vmm/pdmthread.h> +# include <iprt/test.h> +# include <VBox/VMMDevTesting.h> +#endif + +#include <iprt/list.h> +#include <iprt/memcache.h> + + +#define VMMDEV_WITH_ALT_TIMESYNC + +/** Request locking structure (HGCM optimization). */ +typedef struct VMMDEVREQLOCK +{ + void *pvReq; + PGMPAGEMAPLOCK Lock; +} VMMDEVREQLOCK; +/** Pointer to a request lock structure. */ +typedef VMMDEVREQLOCK *PVMMDEVREQLOCK; + +typedef struct DISPLAYCHANGEREQUEST +{ + bool fPending; + bool afAlignment[3]; + VMMDevDisplayDef displayChangeRequest; + VMMDevDisplayDef lastReadDisplayChangeRequest; +} DISPLAYCHANGEREQUEST; + +typedef struct DISPLAYCHANGEDATA +{ + /* Which monitor is being reported to the guest. */ + int32_t iCurrentMonitor; + + /** true if the guest responded to VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST at least once */ + bool fGuestSentChangeEventAck; + bool afAlignment[3]; + + DISPLAYCHANGEREQUEST aRequests[VBOX_VIDEO_MAX_SCREENS]; +} DISPLAYCHANGEDATA; + + +/** + * Credentials for automatic guest logon and host configured logon (?). + * + * This is not stored in the same block as the instance data in order to make it + * harder to access. + */ +typedef struct VMMDEVCREDS +{ + /** credentials for guest logon purposes */ + struct + { + char szUserName[VMMDEV_CREDENTIALS_SZ_SIZE]; + char szPassword[VMMDEV_CREDENTIALS_SZ_SIZE]; + char szDomain[VMMDEV_CREDENTIALS_SZ_SIZE]; + bool fAllowInteractiveLogon; + } Logon; + + /** credentials for verification by guest */ + struct + { + char szUserName[VMMDEV_CREDENTIALS_SZ_SIZE]; + char szPassword[VMMDEV_CREDENTIALS_SZ_SIZE]; + char szDomain[VMMDEV_CREDENTIALS_SZ_SIZE]; + } Judge; +} VMMDEVCREDS; + + +/** + * Facility status entry. + */ +typedef struct VMMDEVFACILITYSTATUSENTRY +{ + /** The facility (may contain values other than the defined ones). */ + VBoxGuestFacilityType enmFacility; + /** The status (may contain values other than the defined ones). */ + VBoxGuestFacilityStatus enmStatus; + /** Whether this entry is fixed and cannot be reused when inactive. */ + bool fFixed; + /** Explicit alignment padding / reserved for future use. MBZ. */ + bool afPadding[3]; + /** The facility flags (yet to be defined). */ + uint32_t fFlags; + /** Last update timestamp. */ + RTTIMESPEC TimeSpecTS; +} VMMDEVFACILITYSTATUSENTRY; +/** Pointer to a facility status entry. */ +typedef VMMDEVFACILITYSTATUSENTRY *PVMMDEVFACILITYSTATUSENTRY; + + +/** + * State structure for the VMM device. + */ +typedef struct VMMDEV +{ + /** The critical section for this device. + * @remarks We use this rather than the default one, it's simpler with all + * the driver interfaces where we have to waste time digging out the + * PDMDEVINS structure. */ + PDMCRITSECT CritSect; +#if !defined(VBOX_WITHOUT_TESTING_FEATURES) || defined(DOXYGEN_RUNNING) + /** Read write critical section of lock testing. + * @remarks At the beginning to satisfy 64 byte alignment requirement. */ + PDMCRITSECTRW CritSectRw; +#endif + + /** mouse capabilities of host and guest */ + uint32_t fMouseCapabilities; + /** @name Absolute mouse position in pixels, relative wheel movement and buttons state. + * @{ */ + int32_t xMouseAbs; + int32_t yMouseAbs; + int32_t dzMouse; + int32_t dwMouse; + uint32_t fMouseButtons; + /** @} */ + /** Does the guest currently want the host pointer to be shown? */ + uint32_t fHostCursorRequested; + + /** message buffer for backdoor logging. */ + char szMsg[512]; + /** message buffer index. */ + uint32_t offMsg; + /** Alignment padding. */ + uint32_t u32Alignment2; + + /** Statistics counter for slow IRQ ACK. */ + STAMCOUNTER StatSlowIrqAck; + /** Statistics counter for fast IRQ ACK - R3. */ + STAMCOUNTER StatFastIrqAckR3; + /** Statistics counter for fast IRQ ACK - R0 / RC. */ + STAMCOUNTER StatFastIrqAckRZ; + /** Current host side event flags - VMMDEV_EVENT_XXX. */ + uint32_t fHostEventFlags; + /** Mask of events guest is interested in - VMMDEV_EVENT_XXX. + * @note The HGCM events are enabled automatically by the VMMDev device when + * guest issues HGCM commands. */ + uint32_t fGuestFilterMask; + /** Delayed mask of guest events - VMMDEV_EVENT_XXX. */ + uint32_t fNewGuestFilterMask; + /** Flag whether fNewGuestFilterMask is valid */ + bool fNewGuestFilterMaskValid; + /** Alignment padding. */ + bool afAlignment3[3]; + + /** Information reported by guest via VMMDevReportGuestInfo generic request. + * Until this information is reported the VMMDev refuses any other requests. + */ + VBoxGuestInfo guestInfo; + /** Information report \#2, chewed a little. */ + struct + { + uint32_t uFullVersion; /**< non-zero if info is present. */ + uint32_t uRevision; + uint32_t fFeatures; + char szName[128]; + } guestInfo2; + + /** Array of guest facility statuses. */ + VMMDEVFACILITYSTATUSENTRY aFacilityStatuses[32]; + /** The number of valid entries in the facility status array. */ + uint32_t cFacilityStatuses; + + /** Information reported by guest via VMMDevReportGuestCapabilities - VMMDEV_GUEST_SUPPORTS_XXX. */ + uint32_t fGuestCaps; + + /** "Additions are Ok" indicator, set to true after processing VMMDevReportGuestInfo, + * if additions version is compatible. This flag is here to avoid repeated comparing + * of the version in guestInfo. + */ + uint32_t fu32AdditionsOk; + + /** Video acceleration status set by guest. */ + uint32_t u32VideoAccelEnabled; + + DISPLAYCHANGEDATA displayChangeData; + + /** memory balloon change request */ + uint32_t cMbMemoryBalloon; + /** The last balloon size queried by the guest additions. */ + uint32_t cMbMemoryBalloonLast; + + /** guest ram size */ + uint64_t cbGuestRAM; + + /** unique session id; the id will be different after each start, reset or restore of the VM. */ + uint64_t idSession; + + /** Statistics interval in seconds. */ + uint32_t cSecsStatInterval; + /** The statistics interval last returned to the guest. */ + uint32_t cSecsLastStatInterval; + + /** Whether seamless is enabled or not. */ + bool fSeamlessEnabled; + /** The last fSeamlessEnabled state returned to the guest. */ + bool fLastSeamlessEnabled; + bool afAlignment5[1]; + + bool fVRDPEnabled; + uint32_t uVRDPExperienceLevel; + +#ifdef VMMDEV_WITH_ALT_TIMESYNC + uint64_t msLatchedHostTime; + bool fTimesyncBackdoorLo; + bool afAlignment6[1]; +#else + bool afAlignment6[2]; +#endif + + /** Set if guest should be allowed to trigger state save and power off. */ + bool fAllowGuestToSaveState; + /** Set if GetHostTime should fail. + * Loaded from the GetHostTimeDisabled configuration value. */ + bool fGetHostTimeDisabled; + /** Set if backdoor logging should be disabled (output will be ignored then) */ + bool fBackdoorLogDisabled; + /** Don't clear credentials */ + bool fKeepCredentials; + /** Heap enabled. */ + bool fHeapEnabled; + + /** Guest Core Dumping enabled. */ + bool fGuestCoreDumpEnabled; + /** Guest Core Dump location. */ + char szGuestCoreDumpDir[RTPATH_MAX]; + /** Number of additional cores to keep around. */ + uint32_t cGuestCoreDumps; + + /** FLag whether CPU hotplug events are monitored */ + bool fCpuHotPlugEventsEnabled; + /** Alignment padding. */ + bool afPadding8[3]; + /** CPU hotplug event */ + VMMDevCpuEventType enmCpuHotPlugEvent; + /** Core id of the CPU to change */ + uint32_t idCpuCore; + /** Package id of the CPU to change */ + uint32_t idCpuPackage; + + uint32_t StatMemBalloonChunks; + + /** @name Heartbeat + * @{ */ + /** Timestamp of the last heartbeat from guest in nanosec. */ + uint64_t volatile nsLastHeartbeatTS; + /** Indicates whether we missed HB from guest on last check. */ + bool volatile fFlatlined; + /** Indicates whether heartbeat check is active. */ + bool volatile fHeartbeatActive; + /** Alignment padding. */ + bool afAlignment8[6]; + /** Guest heartbeat interval in nanoseconds. + * This is the interval the guest is told to produce heartbeats at. */ + uint64_t cNsHeartbeatInterval; + /** The amount of time without a heartbeat (nanoseconds) before we + * conclude the guest is doing a Dixie Flatline (Neuromancer) impression. */ + uint64_t cNsHeartbeatTimeout; + /** Timer for signalling a flatlined guest. */ + TMTIMERHANDLE hFlatlinedTimer; + /** @} */ + + /** @name Testing + * @{ */ + /** Set if testing is enabled. */ + bool fTestingEnabled; + /** Set if testing the MMIO testing range is enabled. */ + bool fTestingMMIO; +#if defined(VBOX_WITHOUT_TESTING_FEATURES) && !defined(DOXYGEN_RUNNING) + /** Alignment padding. */ + bool afPadding9[2]; +#else + /** The amount of readable testing data (for query response). */ + uint16_t cbReadableTestingData; + /** The high timestamp value. */ + uint32_t u32TestingHighTimestamp; + /** The current testing command (VMMDEV_TESTING_CMD_XXX). */ + uint32_t u32TestingCmd; + /** The testing data offset (command specific). */ + uint32_t offTestingData; + /** For buffering the what comes in over the testing data port. */ + union + { + /** Plain byte view. */ + uint8_t ab[1024]; + + /** VMMDEV_TESTING_CMD_INIT, VMMDEV_TESTING_CMD_SUB_NEW, + * VMMDEV_TESTING_CMD_FAILED. */ + struct + { + char sz[1024]; + } String, Init, SubNew, Failed; + + /** VMMDEV_TESTING_CMD_TERM, VMMDEV_TESTING_CMD_SUB_DONE. */ + struct + { + uint32_t c; + } Error, Term, SubDone; + + /** VMMDEV_TESTING_CMD_VALUE. */ + struct + { + RTUINT64U u64Value; + uint32_t u32Unit; + char szName[1024 - 8 - 4]; + } Value; + + /** A 8-bit VMMDEV_TESTING_QUERY_CFG response. */ + uint8_t b; + /** A 32-bit VMMDEV_TESTING_QUERY_CFG response. */ + uint32_t u32; + + /** The read back register (VMMDEV_TESTING_MMIO_OFF_READBACK, + * VMMDEV_TESTING_MMIO_OFF_READBACK_R3). */ + uint8_t abReadBack[VMMDEV_TESTING_READBACK_SIZE]; + } TestingData; + /** The locking testing control dword. */ + union + { + /** Plain view. */ + uint64_t u64; + /** Plain 32-bit view. */ + uint32_t au32[2]; + struct + { + /** bits 15:0: Number of microseconds to hold the lock. */ + uint32_t cUsHold : 16; + /** bits 31:16: Number of microseconds to wait before retaking the lock again. */ + uint32_t cUsBetween : 16; + /** bits 51:32: Kilo (1024) ticks the EMT should hold the lock for. */ + uint32_t cKiloTicksEmtHold : 20; + /** bits 57:52: Reserved MBZ. */ + uint32_t uReserved : 6; + /** bit 58: Thread takes lock in shared mode when set, exclusive when clear. */ + uint32_t fThreadShared : 1; + /** bit 59: EMT takes lock in shared mode when set, exclusive when clear. */ + uint32_t fEmtShared : 1; + /** bit 60: Use read/write critical section instead of regular. */ + uint32_t fReadWriteSection : 1; + /** bit 61: EMT passes VINF_SUCCESS as rcBusy if set. */ + uint32_t fMustSucceed : 1; + /** bit 62: Thread pokes EMTs before releasing it when set. */ + uint32_t fPokeBeforeRelease : 1; + /** bit 63: Enabled/disabled. */ + uint32_t fEnabled : 1; + } s; + } TestingLockControl; + /** Event semaphore that the locking thread blocks. */ + SUPSEMEVENT hTestingLockEvt; +# if HC_ARCH_BITS == 32 + uint32_t uPadding10; +# endif + /** Handle for the I/O ports used by the testing component. */ + IOMIOPORTHANDLE hIoPortTesting; + /** Handle for the MMIO region used by the testing component. */ + IOMMMIOHANDLE hMmioTesting; + /** User defined configuration dwords. */ + uint32_t au32TestingCfgDwords[10]; +#endif /* !VBOX_WITHOUT_TESTING_FEATURES || DOXYGEN_RUNNING */ + /** @} */ + + /** Handle for the backdoor logging I/O port. */ + IOMIOPORTHANDLE hIoPortBackdoorLog; + /** Handle for the alternative timesync I/O port. */ + IOMIOPORTHANDLE hIoPortAltTimesync; + /** Handle for the VMM request I/O port (PCI region \#0). */ + IOMIOPORTHANDLE hIoPortReq; + /** Handle for the fast VMM request I/O port (PCI region \#0). */ + IOMIOPORTHANDLE hIoPortFast; + /** Handle for the VMMDev RAM (PCI region \#1). */ + PGMMMIO2HANDLE hMmio2VMMDevRAM; + /** Handle for the VMMDev Heap (PCI region \#2). */ + PGMMMIO2HANDLE hMmio2Heap; +} VMMDEV; +/** Pointer to the shared VMM device state. */ +typedef VMMDEV *PVMMDEV; +AssertCompileMemberAlignment(VMMDEV, CritSect, 8); +AssertCompileMemberAlignment(VMMDEV, StatSlowIrqAck, 8); +AssertCompileMemberAlignment(VMMDEV, cbGuestRAM, 8); +AssertCompileMemberAlignment(VMMDEV, enmCpuHotPlugEvent, 4); +AssertCompileMemberAlignment(VMMDEV, aFacilityStatuses, 8); +#ifndef VBOX_WITHOUT_TESTING_FEATURES +AssertCompileMemberAlignment(VMMDEV, TestingData.Value.u64Value, 8); +AssertCompileMemberAlignment(VMMDEV, CritSectRw, 64); +#endif + + +/** @name VMMDev/HGCM accounting categories (indexes into VMMDEVR3::aHgcmAcc) + * @{ */ +/** Legacy, VMMDEV_REQUESTOR_USR_NOT_GIVEN, VMMDEV_REQUESTOR_USR_DRV, + * VMMDEV_REQUESTOR_USR_DRV_OTHER. */ +#define VMMDEV_HGCM_CATEGORY_KERNEL 0 +/** VMMDEV_REQUESTOR_USR_ROOT, VMMDEV_REQUESTOR_USR_SYSTEM */ +#define VMMDEV_HGCM_CATEGORY_ROOT 1 +/** VMMDEV_REQUESTOR_USR_RESERVED1, VMMDEV_REQUESTOR_USR_USER, + * VMMDEV_REQUESTOR_USR_GUEST */ +#define VMMDEV_HGCM_CATEGORY_USER 2 +/** Array size. */ +#define VMMDEV_HGCM_CATEGORY_MAX 3 +/** @} */ + +/** + * State structure for the VMM device, ring-3 edition. + */ +typedef struct VMMDEVR3 +{ + /** LUN\#0 + Status: VMMDev port base interface. */ + PDMIBASE IBase; + /** LUN\#0: VMMDev port interface. */ + PDMIVMMDEVPORT IPort; +#ifdef VBOX_WITH_HGCM + /** LUN\#0: HGCM port interface. */ + PDMIHGCMPORT IHGCMPort; + /** HGCM connector interface */ + R3PTRTYPE(PPDMIHGCMCONNECTOR) pHGCMDrv; +#endif + /** Pointer to base interface of the driver. */ + R3PTRTYPE(PPDMIBASE) pDrvBase; + /** VMMDev connector interface */ + R3PTRTYPE(PPDMIVMMDEVCONNECTOR) pDrv; + /** Pointer to the device instance. + * @note Only for interface methods to get their bearings. */ + PPDMDEVINSR3 pDevIns; + + /** R3 pointer to VMMDev RAM area */ + R3PTRTYPE(VMMDevMemory *) pVMMDevRAMR3; + + /** R3 pointer to VMMDev Heap RAM area. */ + R3PTRTYPE(VMMDevMemory *) pVMMDevHeapR3; + + /** Pointer to the credentials. */ + R3PTRTYPE(VMMDEVCREDS *) pCredentials; + /** Set if pCredentials is using the RTMemSafer allocator, clear if heap. */ + bool fSaferCredentials; + bool afAlignment[7]; + +#ifdef VBOX_WITH_HGCM + /** Critical section to protect the list. */ + RTCRITSECT critsectHGCMCmdList; + /** List of pending HGCM requests (VBOXHGCMCMD). */ + RTLISTANCHORR3 listHGCMCmd; + /** Whether the HGCM events are already automatically enabled. */ + uint32_t u32HGCMEnabled; + /** Saved state version of restored commands. */ + uint32_t uSavedStateVersion; + RTMEMCACHE hHgcmCmdCache; + /** Accounting by for each requestor VMMDEV_REQUESTOR_USR_XXX group. + * Legacy requests ends up with VMMDEV_REQUESTOR_USR_NOT_GIVEN */ + struct + { + /** The configured heap budget. */ + uint64_t cbHeapBudgetConfig; + /** The currently available heap budget. */ + uint64_t cbHeapBudget; + /** Message stats. */ + STAMPROFILE StateMsgHeapUsage; + /** Budget overruns. */ + STAMCOUNTER StatBudgetOverruns; + } aHgcmAcc[VMMDEV_HGCM_CATEGORY_MAX]; + STAMPROFILE StatHgcmCmdArrival; + STAMPROFILE StatHgcmCmdCompletion; + STAMPROFILE StatHgcmCmdTotal; + STAMCOUNTER StatHgcmLargeCmdAllocs; + STAMCOUNTER StatHgcmFailedPageListLocking; +#endif /* VBOX_WITH_HGCM */ + STAMCOUNTER StatReqBufAllocs; + /** Per CPU request 4K sized buffers, allocated as needed. */ + R3PTRTYPE(VMMDevRequestHeader *) apReqBufs[VMM_MAX_CPU_COUNT]; + + /** Status LUN: Shared folders LED */ + struct + { + /** The LED. */ + PDMLED Led; + /** The LED ports. */ + PDMILEDPORTS ILeds; + /** Partner of ILeds. */ + R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector; + } SharedFolders; + +#ifndef VBOX_WITHOUT_TESTING_FEATURES + /** The XML output file name (can be a named pipe, doesn't matter to us). */ + R3PTRTYPE(char *) pszTestingXmlOutput; + /** Testing instance for dealing with the output. */ + RTTEST hTestingTest; + /** The locking test thread (). */ + PPDMTHREAD pTestingLockThread; +#endif +} VMMDEVR3; +/** Pointer to the ring-3 VMM device state. */ +typedef VMMDEVR3 *PVMMDEVR3; + + +/** + * State structure for the VMM device, ring-0 edition. + */ +typedef struct VMMDEVR0 +{ + /** R0 pointer to VMMDev RAM area - first page only, could be NULL! */ + R0PTRTYPE(VMMDevMemory *) pVMMDevRAMR0; +} VMMDEVR0; +/** Pointer to the ring-0 VMM device state. */ +typedef VMMDEVR0 *PVMMDEVR0; + + +/** + * State structure for the VMM device, raw-mode edition. + */ +typedef struct VMMDEVRC +{ + /** R0 pointer to VMMDev RAM area - first page only, could be NULL! */ + RCPTRTYPE(VMMDevMemory *) pVMMDevRAMRC; +} VMMDEVRC; +/** Pointer to the raw-mode VMM device state. */ +typedef VMMDEVRC *PVMMDEVRC; + + +/** @typedef VMMDEVCC + * The VMMDEV device data for the current context. */ +typedef CTX_SUFF(VMMDEV) VMMDEVCC; +/** @typedef PVMMDEVCC + * Pointer to the VMMDEV device for the current context. */ +typedef CTX_SUFF(PVMMDEV) PVMMDEVCC; + + +void VMMDevNotifyGuest(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC, uint32_t fAddEvents); +void VMMDevCtlSetGuestFilterMask(PPDMDEVINS pDevIns, PVMMDEV pThis, PVMMDEVCC pThisCC, uint32_t fOrMask, uint32_t fNotMask); + + +/** The saved state version. */ +#define VMMDEV_SAVED_STATE_VERSION VMMDEV_SAVED_STATE_VERSION_VMM_MOUSE_EXTENDED_DATA +/** The saved state version with VMMDev mouse buttons state and wheel movement data. */ +#define VMMDEV_SAVED_STATE_VERSION_VMM_MOUSE_EXTENDED_DATA 19 +/** The saved state version with display change data state. */ +#define VMMDEV_SAVED_STATE_VERSION_DISPLAY_CHANGE_DATA 18 +/** Updated HGCM commands. */ +#define VMMDEV_SAVED_STATE_VERSION_HGCM_PARAMS 17 +/** The saved state version with heartbeat state. */ +#define VMMDEV_SAVED_STATE_VERSION_HEARTBEAT 16 +/** The saved state version without heartbeat state. */ +#define VMMDEV_SAVED_STATE_VERSION_NO_HEARTBEAT 15 +/** The saved state version which is missing the guest facility statuses. */ +#define VMMDEV_SAVED_STATE_VERSION_MISSING_FACILITY_STATUSES 14 +/** The saved state version which is missing the guestInfo2 bits. */ +#define VMMDEV_SAVED_STATE_VERSION_MISSING_GUEST_INFO_2 13 +/** The saved state version used by VirtualBox 3.0. + * This doesn't have the config part. */ +#define VMMDEV_SAVED_STATE_VERSION_VBOX_30 11 + +#endif /* !VBOX_INCLUDED_SRC_VMMDev_VMMDevState_h */ + |