| 1 | /** @file
|
|---|
| 2 | * GIM - Guest Interface Manager.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2014-2024 Oracle and/or its affiliates.
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 9 | * available from https://www.virtualbox.org.
|
|---|
| 10 | *
|
|---|
| 11 | * This program is free software; you can redistribute it and/or
|
|---|
| 12 | * modify it under the terms of the GNU General Public License
|
|---|
| 13 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 14 | * License.
|
|---|
| 15 | *
|
|---|
| 16 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 17 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 19 | * General Public License for more details.
|
|---|
| 20 | *
|
|---|
| 21 | * You should have received a copy of the GNU General Public License
|
|---|
| 22 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 23 | *
|
|---|
| 24 | * The contents of this file may alternatively be used under the terms
|
|---|
| 25 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 26 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 27 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 28 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 29 | *
|
|---|
| 30 | * You may elect to license modified versions of this file under the
|
|---|
| 31 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 32 | *
|
|---|
| 33 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef VBOX_INCLUDED_vmm_gim_h
|
|---|
| 37 | #define VBOX_INCLUDED_vmm_gim_h
|
|---|
| 38 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 39 | # pragma once
|
|---|
| 40 | #endif
|
|---|
| 41 |
|
|---|
| 42 | #include <VBox/cdefs.h>
|
|---|
| 43 | #include <VBox/types.h>
|
|---|
| 44 | #include <VBox/param.h>
|
|---|
| 45 |
|
|---|
| 46 | #include <VBox/vmm/cpum.h>
|
|---|
| 47 | #include <VBox/vmm/pdmifs.h>
|
|---|
| 48 |
|
|---|
| 49 | /** The value used to specify that VirtualBox must use the newest
|
|---|
| 50 | * implementation version of the GIM provider. */
|
|---|
| 51 | #define GIM_VERSION_LATEST UINT32_C(0)
|
|---|
| 52 |
|
|---|
| 53 | RT_C_DECLS_BEGIN
|
|---|
| 54 |
|
|---|
| 55 | /** @defgroup grp_gim The Guest Interface Manager API
|
|---|
| 56 | * @ingroup grp_vmm
|
|---|
| 57 | * @{
|
|---|
| 58 | */
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * GIM Provider Identifiers.
|
|---|
| 62 | * @remarks Part of saved state!
|
|---|
| 63 | */
|
|---|
| 64 | typedef enum GIMPROVIDERID
|
|---|
| 65 | {
|
|---|
| 66 | /** None. */
|
|---|
| 67 | GIMPROVIDERID_NONE = 0,
|
|---|
| 68 | /** Minimal. */
|
|---|
| 69 | GIMPROVIDERID_MINIMAL,
|
|---|
| 70 | /** Microsoft Hyper-V. */
|
|---|
| 71 | GIMPROVIDERID_HYPERV,
|
|---|
| 72 | /** Linux KVM Interface. */
|
|---|
| 73 | GIMPROVIDERID_KVM
|
|---|
| 74 | } GIMPROVIDERID;
|
|---|
| 75 | AssertCompileSize(GIMPROVIDERID, sizeof(uint32_t));
|
|---|
| 76 |
|
|---|
| 77 |
|
|---|
| 78 | /**
|
|---|
| 79 | * A GIM MMIO2 region record.
|
|---|
| 80 | */
|
|---|
| 81 | typedef struct GIMMMIO2REGION
|
|---|
| 82 | {
|
|---|
| 83 | /** The region index. */
|
|---|
| 84 | uint8_t iRegion;
|
|---|
| 85 | /** Whether an RC mapping is required. */
|
|---|
| 86 | bool fRCMapping;
|
|---|
| 87 | /** Whether this region has been registered. */
|
|---|
| 88 | bool fRegistered;
|
|---|
| 89 | /** Whether this region is currently mapped. */
|
|---|
| 90 | bool fMapped;
|
|---|
| 91 | /** Size of the region (must be page aligned). */
|
|---|
| 92 | uint32_t cbRegion;
|
|---|
| 93 | /** The host ring-0 address of the first page in the region. */
|
|---|
| 94 | R0PTRTYPE(void *) pvPageR0;
|
|---|
| 95 | /** The host ring-3 address of the first page in the region. */
|
|---|
| 96 | R3PTRTYPE(void *) pvPageR3;
|
|---|
| 97 | # ifdef VBOX_WITH_RAW_MODE_KEEP
|
|---|
| 98 | /** The ring-context address of the first page in the region. */
|
|---|
| 99 | RCPTRTYPE(void *) pvPageRC;
|
|---|
| 100 | RTRCPTR RCPtrAlignment0;
|
|---|
| 101 | # endif
|
|---|
| 102 | /** The guest-physical address of the first page in the region. */
|
|---|
| 103 | RTGCPHYS GCPhysPage;
|
|---|
| 104 | /** The MMIO2 handle. */
|
|---|
| 105 | PGMMMIO2HANDLE hMmio2;
|
|---|
| 106 | /** The description of the region. */
|
|---|
| 107 | char szDescription[32];
|
|---|
| 108 | } GIMMMIO2REGION;
|
|---|
| 109 | /** Pointer to a GIM MMIO2 region. */
|
|---|
| 110 | typedef GIMMMIO2REGION *PGIMMMIO2REGION;
|
|---|
| 111 | /** Pointer to a const GIM MMIO2 region. */
|
|---|
| 112 | typedef GIMMMIO2REGION const *PCGIMMMIO2REGION;
|
|---|
| 113 | AssertCompileMemberAlignment(GIMMMIO2REGION, pvPageR0, 8);
|
|---|
| 114 | AssertCompileMemberAlignment(GIMMMIO2REGION, GCPhysPage, 8);
|
|---|
| 115 |
|
|---|
| 116 | /**
|
|---|
| 117 | * Debug data buffer available callback over the GIM debug connection.
|
|---|
| 118 | *
|
|---|
| 119 | * @param pVM The cross context VM structure.
|
|---|
| 120 | */
|
|---|
| 121 | typedef DECLCALLBACKTYPE(void, FNGIMDEBUGBUFAVAIL,(PVM pVM));
|
|---|
| 122 | /** Pointer to GIM debug buffer available callback. */
|
|---|
| 123 | typedef FNGIMDEBUGBUFAVAIL *PFNGIMDEBUGBUFAVAIL;
|
|---|
| 124 |
|
|---|
| 125 | /**
|
|---|
| 126 | * GIM debug setup.
|
|---|
| 127 | *
|
|---|
| 128 | * These are parameters/options filled in by the GIM provider and passed along
|
|---|
| 129 | * to the GIM device.
|
|---|
| 130 | */
|
|---|
| 131 | typedef struct GIMDEBUGSETUP
|
|---|
| 132 | {
|
|---|
| 133 | /** The callback to invoke when the receive buffer has data. */
|
|---|
| 134 | PFNGIMDEBUGBUFAVAIL pfnDbgRecvBufAvail;
|
|---|
| 135 | /** The size of the receive buffer as specified by the GIM provider. */
|
|---|
| 136 | uint32_t cbDbgRecvBuf;
|
|---|
| 137 | } GIMDEBUGSETUP;
|
|---|
| 138 | /** Pointer to a GIM debug setup struct. */
|
|---|
| 139 | typedef struct GIMDEBUGSETUP *PGIMDEBUGSETUP;
|
|---|
| 140 | /** Pointer to a const GIM debug setup struct. */
|
|---|
| 141 | typedef struct GIMDEBUGSETUP const *PCGGIMDEBUGSETUP;
|
|---|
| 142 |
|
|---|
| 143 | /**
|
|---|
| 144 | * GIM debug structure (common to the GIM device and GIM).
|
|---|
| 145 | *
|
|---|
| 146 | * This is used to exchanging data between the GIM provider and the GIM device.
|
|---|
| 147 | */
|
|---|
| 148 | typedef struct GIMDEBUG
|
|---|
| 149 | {
|
|---|
| 150 | /** The receive buffer. */
|
|---|
| 151 | void *pvDbgRecvBuf;
|
|---|
| 152 | /** The debug I/O stream driver. */
|
|---|
| 153 | PPDMISTREAM pDbgDrvStream;
|
|---|
| 154 | /** Number of bytes pending to be read from the receive buffer. */
|
|---|
| 155 | size_t cbDbgRecvBufRead;
|
|---|
| 156 | /** The flag synchronizing reads of the receive buffer from EMT. */
|
|---|
| 157 | volatile bool fDbgRecvBufRead;
|
|---|
| 158 | /** The receive thread wakeup semaphore. */
|
|---|
| 159 | RTSEMEVENTMULTI hDbgRecvThreadSem;
|
|---|
| 160 | } GIMDEBUG;
|
|---|
| 161 | /** Pointer to a GIM debug struct. */
|
|---|
| 162 | typedef struct GIMDEBUG *PGIMDEBUG;
|
|---|
| 163 | /** Pointer to a const GIM debug struct. */
|
|---|
| 164 | typedef struct GIMDEBUG const *PCGIMDEBUG;
|
|---|
| 165 |
|
|---|
| 166 |
|
|---|
| 167 | #ifdef IN_RC
|
|---|
| 168 | /** @defgroup grp_gim_rc The GIM Raw-mode Context API
|
|---|
| 169 | * @{
|
|---|
| 170 | */
|
|---|
| 171 | /** @} */
|
|---|
| 172 | #endif /* IN_RC */
|
|---|
| 173 |
|
|---|
| 174 | #ifdef IN_RING0
|
|---|
| 175 | /** @defgroup grp_gim_r0 The GIM Host Context Ring-0 API
|
|---|
| 176 | * @{
|
|---|
| 177 | */
|
|---|
| 178 | VMMR0_INT_DECL(int) GIMR0InitVM(PVMCC pVM);
|
|---|
| 179 | VMMR0_INT_DECL(int) GIMR0TermVM(PVMCC pVM);
|
|---|
| 180 | VMMR0_INT_DECL(int) GIMR0UpdateParavirtTsc(PVMCC pVM, uint64_t u64Offset);
|
|---|
| 181 | /** @} */
|
|---|
| 182 | #endif /* IN_RING0 */
|
|---|
| 183 |
|
|---|
| 184 |
|
|---|
| 185 | #ifdef IN_RING3
|
|---|
| 186 | /** @defgroup grp_gim_r3 The GIM Host Context Ring-3 API
|
|---|
| 187 | * @{
|
|---|
| 188 | */
|
|---|
| 189 | VMMR3_INT_DECL(int) GIMR3Init(PVM pVM);
|
|---|
| 190 | VMMR3_INT_DECL(int) GIMR3InitCompleted(PVM pVM);
|
|---|
| 191 | VMMR3_INT_DECL(void) GIMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
|
|---|
| 192 | VMMR3_INT_DECL(int) GIMR3Term(PVM pVM);
|
|---|
| 193 | VMMR3_INT_DECL(void) GIMR3Reset(PVM pVM);
|
|---|
| 194 | VMMR3DECL(void) GIMR3GimDeviceRegister(PVM pVM, PPDMDEVINS pDevInsR3, PGIMDEBUG pDbg);
|
|---|
| 195 | VMMR3DECL(int) GIMR3GetDebugSetup(PVM pVM, PGIMDEBUGSETUP pDbgSetup);
|
|---|
| 196 | /** @} */
|
|---|
| 197 | #endif /* IN_RING3 */
|
|---|
| 198 |
|
|---|
| 199 | VMMDECL(bool) GIMIsEnabled(PVM pVM);
|
|---|
| 200 | VMMDECL(GIMPROVIDERID) GIMGetProvider(PVM pVM);
|
|---|
| 201 | VMMDECL(PGIMMMIO2REGION) GIMGetMmio2Regions(PVMCC pVM, uint32_t *pcRegions);
|
|---|
| 202 | VMM_INT_DECL(bool) GIMIsParavirtTscEnabled(PVMCC pVM);
|
|---|
| 203 | VMM_INT_DECL(bool) GIMAreHypercallsEnabled(PVMCPUCC pVCpu);
|
|---|
| 204 | VMM_INT_DECL(VBOXSTRICTRC) GIMHypercall(PVMCPUCC pVCpu, PCPUMCTX pCtx);
|
|---|
| 205 | VMM_INT_DECL(VBOXSTRICTRC) GIMHypercallEx(PVMCPUCC pVCpu, PCPUMCTX pCtx, unsigned uDisOpcode, uint8_t cbInstr);
|
|---|
| 206 | VMM_INT_DECL(VBOXSTRICTRC) GIMExecHypercallInstr(PVMCPUCC pVCpu, PCPUMCTX pCtx, uint8_t *pcbInstr);
|
|---|
| 207 | VMM_INT_DECL(VBOXSTRICTRC) GIMXcptUD(PVMCPUCC pVCpu, PCPUMCTX pCtx, PDISSTATE pDis, uint8_t *pcbInstr);
|
|---|
| 208 | VMM_INT_DECL(bool) GIMShouldTrapXcptUD(PVMCPUCC pVCpu);
|
|---|
| 209 | #if !defined(VBOX_VMM_TARGET_ARMV8)
|
|---|
| 210 | VMM_INT_DECL(VBOXSTRICTRC) GIMReadMsr(PVMCPUCC pVCpu, uint32_t idMsr, PCCPUMMSRRANGE pRange, uint64_t *puValue);
|
|---|
| 211 | VMM_INT_DECL(VBOXSTRICTRC) GIMWriteMsr(PVMCPUCC pVCpu, uint32_t idMsr, PCCPUMMSRRANGE pRange, uint64_t uValue, uint64_t uRawValue);
|
|---|
| 212 | #endif
|
|---|
| 213 | VMM_INT_DECL(int) GIMQueryHypercallOpcodeBytes(PVM pVM, void *pvBuf, size_t cbBuf,
|
|---|
| 214 | size_t *pcbWritten, uint16_t *puDisOpcode);
|
|---|
| 215 | /** @} */
|
|---|
| 216 |
|
|---|
| 217 | RT_C_DECLS_END
|
|---|
| 218 |
|
|---|
| 219 | #endif /* !VBOX_INCLUDED_vmm_gim_h */
|
|---|
| 220 |
|
|---|
