| 1 | /** @file
|
|---|
| 2 | * VMM - The Virtual Machine Monitor.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2013 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___VBox_vmm_vmm_h
|
|---|
| 27 | #define ___VBox_vmm_vmm_h
|
|---|
| 28 |
|
|---|
| 29 | #include <VBox/types.h>
|
|---|
| 30 | #include <VBox/vmm/vmapi.h>
|
|---|
| 31 | #include <VBox/sup.h>
|
|---|
| 32 | #include <VBox/log.h>
|
|---|
| 33 | #include <iprt/stdarg.h>
|
|---|
| 34 | #include <iprt/thread.h>
|
|---|
| 35 |
|
|---|
| 36 | RT_C_DECLS_BEGIN
|
|---|
| 37 |
|
|---|
| 38 | /** @defgroup grp_vmm The Virtual Machine Monitor API
|
|---|
| 39 | * @{
|
|---|
| 40 | */
|
|---|
| 41 |
|
|---|
| 42 | /**
|
|---|
| 43 | * World switcher identifiers.
|
|---|
| 44 | */
|
|---|
| 45 | typedef enum VMMSWITCHER
|
|---|
| 46 | {
|
|---|
| 47 | /** The usual invalid 0. */
|
|---|
| 48 | VMMSWITCHER_INVALID = 0,
|
|---|
| 49 | /** Switcher for 32-bit host to 32-bit shadow paging. */
|
|---|
| 50 | VMMSWITCHER_32_TO_32,
|
|---|
| 51 | /** Switcher for 32-bit host paging to PAE shadow paging. */
|
|---|
| 52 | VMMSWITCHER_32_TO_PAE,
|
|---|
| 53 | /** Switcher for 32-bit host paging to AMD64 shadow paging. */
|
|---|
| 54 | VMMSWITCHER_32_TO_AMD64,
|
|---|
| 55 | /** Switcher for PAE host to 32-bit shadow paging. */
|
|---|
| 56 | VMMSWITCHER_PAE_TO_32,
|
|---|
| 57 | /** Switcher for PAE host to PAE shadow paging. */
|
|---|
| 58 | VMMSWITCHER_PAE_TO_PAE,
|
|---|
| 59 | /** Switcher for PAE host paging to AMD64 shadow paging. */
|
|---|
| 60 | VMMSWITCHER_PAE_TO_AMD64,
|
|---|
| 61 | /** Switcher for AMD64 host paging to 32-bit shadow paging. */
|
|---|
| 62 | VMMSWITCHER_AMD64_TO_32,
|
|---|
| 63 | /** Switcher for AMD64 host paging to PAE shadow paging. */
|
|---|
| 64 | VMMSWITCHER_AMD64_TO_PAE,
|
|---|
| 65 | /** Switcher for AMD64 host paging to AMD64 shadow paging. */
|
|---|
| 66 | VMMSWITCHER_AMD64_TO_AMD64,
|
|---|
| 67 | /** Stub switcher for 32-bit and PAE. */
|
|---|
| 68 | VMMSWITCHER_X86_STUB,
|
|---|
| 69 | /** Stub switcher for AMD64. */
|
|---|
| 70 | VMMSWITCHER_AMD64_STUB,
|
|---|
| 71 | /** Used to make a count for array declarations and suchlike. */
|
|---|
| 72 | VMMSWITCHER_MAX,
|
|---|
| 73 | /** The usual 32-bit paranoia. */
|
|---|
| 74 | VMMSWITCHER_32BIT_HACK = 0x7fffffff
|
|---|
| 75 | } VMMSWITCHER;
|
|---|
| 76 |
|
|---|
| 77 |
|
|---|
| 78 | /**
|
|---|
| 79 | * VMMRZCallRing3 operations.
|
|---|
| 80 | */
|
|---|
| 81 | typedef enum VMMCALLRING3
|
|---|
| 82 | {
|
|---|
| 83 | /** Invalid operation. */
|
|---|
| 84 | VMMCALLRING3_INVALID = 0,
|
|---|
| 85 | /** Acquire the PDM lock. */
|
|---|
| 86 | VMMCALLRING3_PDM_LOCK,
|
|---|
| 87 | /** Acquire the critical section specified as argument. */
|
|---|
| 88 | VMMCALLRING3_PDM_CRIT_SECT_ENTER,
|
|---|
| 89 | /** Enter the R/W critical section (in argument) exclusively. */
|
|---|
| 90 | VMMCALLRING3_PDM_CRIT_SECT_RW_ENTER_EXCL,
|
|---|
| 91 | /** Enter the R/W critical section (in argument) shared. */
|
|---|
| 92 | VMMCALLRING3_PDM_CRIT_SECT_RW_ENTER_SHARED,
|
|---|
| 93 | /** Acquire the PGM lock. */
|
|---|
| 94 | VMMCALLRING3_PGM_LOCK,
|
|---|
| 95 | /** Grow the PGM shadow page pool. */
|
|---|
| 96 | VMMCALLRING3_PGM_POOL_GROW,
|
|---|
| 97 | /** Maps a chunk into ring-3. */
|
|---|
| 98 | VMMCALLRING3_PGM_MAP_CHUNK,
|
|---|
| 99 | /** Allocates more handy pages. */
|
|---|
| 100 | VMMCALLRING3_PGM_ALLOCATE_HANDY_PAGES,
|
|---|
| 101 | /** Allocates a large (2MB) page. */
|
|---|
| 102 | VMMCALLRING3_PGM_ALLOCATE_LARGE_HANDY_PAGE,
|
|---|
| 103 | /** Acquire the MM hypervisor heap lock. */
|
|---|
| 104 | VMMCALLRING3_MMHYPER_LOCK,
|
|---|
| 105 | /** Replay the REM handler notifications. */
|
|---|
| 106 | VMMCALLRING3_REM_REPLAY_HANDLER_NOTIFICATIONS,
|
|---|
| 107 | /** Flush the GC/R0 logger. */
|
|---|
| 108 | VMMCALLRING3_VMM_LOGGER_FLUSH,
|
|---|
| 109 | /** Set the VM error message. */
|
|---|
| 110 | VMMCALLRING3_VM_SET_ERROR,
|
|---|
| 111 | /** Set the VM runtime error message. */
|
|---|
| 112 | VMMCALLRING3_VM_SET_RUNTIME_ERROR,
|
|---|
| 113 | /** Signal a ring 0 assertion. */
|
|---|
| 114 | VMMCALLRING3_VM_R0_ASSERTION,
|
|---|
| 115 | /** Ring switch to force preemption. */
|
|---|
| 116 | VMMCALLRING3_VM_R0_PREEMPT,
|
|---|
| 117 | /** Sync the FTM state with the standby node. */
|
|---|
| 118 | VMMCALLRING3_FTM_SET_CHECKPOINT,
|
|---|
| 119 | /** The usual 32-bit hack. */
|
|---|
| 120 | VMMCALLRING3_32BIT_HACK = 0x7fffffff
|
|---|
| 121 | } VMMCALLRING3;
|
|---|
| 122 |
|
|---|
| 123 | /**
|
|---|
| 124 | * VMMRZCallRing3 notification callback.
|
|---|
| 125 | *
|
|---|
| 126 | * @returns VBox status code.
|
|---|
| 127 | * @param pVCpu Pointer to the VMCPU.
|
|---|
| 128 | * @param enmOperation The operation causing the ring-3 jump.
|
|---|
| 129 | * @param pvUser The user argument.
|
|---|
| 130 | */
|
|---|
| 131 | typedef DECLCALLBACK(int) FNVMMR0CALLRING3NOTIFICATION(PVMCPU pVCpu, VMMCALLRING3 enmOperation, void *pvUser);
|
|---|
| 132 | /** Pointer to a FNRTMPNOTIFICATION(). */
|
|---|
| 133 | typedef FNVMMR0CALLRING3NOTIFICATION *PFNVMMR0CALLRING3NOTIFICATION;
|
|---|
| 134 |
|
|---|
| 135 | /**
|
|---|
| 136 | * Rendezvous callback.
|
|---|
| 137 | *
|
|---|
| 138 | * @returns VBox strict status code - EM scheduling. Do not return
|
|---|
| 139 | * informational status code other than the ones used by EM for
|
|---|
| 140 | * scheduling.
|
|---|
| 141 | *
|
|---|
| 142 | * @param pVM The VM handle.
|
|---|
| 143 | * @param pVCpu The handle of the calling virtual CPU.
|
|---|
| 144 | * @param pvUser The user argument.
|
|---|
| 145 | */
|
|---|
| 146 | typedef DECLCALLBACK(VBOXSTRICTRC) FNVMMEMTRENDEZVOUS(PVM pVM, PVMCPU pVCpu, void *pvUser);
|
|---|
| 147 | /** Pointer to a rendezvous callback function. */
|
|---|
| 148 | typedef FNVMMEMTRENDEZVOUS *PFNVMMEMTRENDEZVOUS;
|
|---|
| 149 |
|
|---|
| 150 | /**
|
|---|
| 151 | * Method table that the VMM uses to call back the user of the VMM.
|
|---|
| 152 | */
|
|---|
| 153 | typedef struct VMM2USERMETHODS
|
|---|
| 154 | {
|
|---|
| 155 | /** Magic value (VMM2USERMETHODS_MAGIC). */
|
|---|
| 156 | uint32_t u32Magic;
|
|---|
| 157 | /** Structure version (VMM2USERMETHODS_VERSION). */
|
|---|
| 158 | uint32_t u32Version;
|
|---|
| 159 |
|
|---|
| 160 | /**
|
|---|
| 161 | * Save the VM state.
|
|---|
| 162 | *
|
|---|
| 163 | * @returns VBox status code.
|
|---|
| 164 | * @param pThis Pointer to the callback method table.
|
|---|
| 165 | * @param pUVM The user mode VM handle.
|
|---|
| 166 | *
|
|---|
| 167 | * @remarks This member shall be set to NULL if the operation is not
|
|---|
| 168 | * supported.
|
|---|
| 169 | */
|
|---|
| 170 | DECLR3CALLBACKMEMBER(int, pfnSaveState,(PCVMM2USERMETHODS pThis, PUVM pUVM));
|
|---|
| 171 | /** @todo Move pfnVMAtError and pfnCFGMConstructor here? */
|
|---|
| 172 |
|
|---|
| 173 | /**
|
|---|
| 174 | * EMT initialization notification callback.
|
|---|
| 175 | *
|
|---|
| 176 | * This is intended for doing per-thread initialization for EMTs (like COM
|
|---|
| 177 | * init).
|
|---|
| 178 | *
|
|---|
| 179 | * @param pThis Pointer to the callback method table.
|
|---|
| 180 | * @param pUVM The user mode VM handle.
|
|---|
| 181 | * @param pUVCpu The user mode virtual CPU handle.
|
|---|
| 182 | *
|
|---|
| 183 | * @remarks This is optional and shall be set to NULL if not wanted.
|
|---|
| 184 | */
|
|---|
| 185 | DECLR3CALLBACKMEMBER(void, pfnNotifyEmtInit,(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu));
|
|---|
| 186 |
|
|---|
| 187 | /**
|
|---|
| 188 | * EMT termination notification callback.
|
|---|
| 189 | *
|
|---|
| 190 | * This is intended for doing per-thread cleanups for EMTs (like COM).
|
|---|
| 191 | *
|
|---|
| 192 | * @param pThis Pointer to the callback method table.
|
|---|
| 193 | * @param pUVM The user mode VM handle.
|
|---|
| 194 | * @param pUVCpu The user mode virtual CPU handle.
|
|---|
| 195 | *
|
|---|
| 196 | * @remarks This is optional and shall be set to NULL if not wanted.
|
|---|
| 197 | */
|
|---|
| 198 | DECLR3CALLBACKMEMBER(void, pfnNotifyEmtTerm,(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu));
|
|---|
| 199 |
|
|---|
| 200 | /**
|
|---|
| 201 | * PDM thread initialization notification callback.
|
|---|
| 202 | *
|
|---|
| 203 | * This is intended for doing per-thread initialization (like COM init).
|
|---|
| 204 | *
|
|---|
| 205 | * @param pThis Pointer to the callback method table.
|
|---|
| 206 | * @param pUVM The user mode VM handle.
|
|---|
| 207 | *
|
|---|
| 208 | * @remarks This is optional and shall be set to NULL if not wanted.
|
|---|
| 209 | */
|
|---|
| 210 | DECLR3CALLBACKMEMBER(void, pfnNotifyPdmtInit,(PCVMM2USERMETHODS pThis, PUVM pUVM));
|
|---|
| 211 |
|
|---|
| 212 | /**
|
|---|
| 213 | * EMT termination notification callback.
|
|---|
| 214 | *
|
|---|
| 215 | * This is intended for doing per-thread cleanups for EMTs (like COM).
|
|---|
| 216 | *
|
|---|
| 217 | * @param pThis Pointer to the callback method table.
|
|---|
| 218 | * @param pUVM The user mode VM handle.
|
|---|
| 219 | *
|
|---|
| 220 | * @remarks This is optional and shall be set to NULL if not wanted.
|
|---|
| 221 | */
|
|---|
| 222 | DECLR3CALLBACKMEMBER(void, pfnNotifyPdmtTerm,(PCVMM2USERMETHODS pThis, PUVM pUVM));
|
|---|
| 223 |
|
|---|
| 224 | /** Magic value (VMM2USERMETHODS_MAGIC) marking the end of the structure. */
|
|---|
| 225 | uint32_t u32EndMagic;
|
|---|
| 226 | } VMM2USERMETHODS;
|
|---|
| 227 |
|
|---|
| 228 | /** Magic value of the VMM2USERMETHODS (Franz Kafka). */
|
|---|
| 229 | #define VMM2USERMETHODS_MAGIC UINT32_C(0x18830703)
|
|---|
| 230 | /** The VMM2USERMETHODS structure version. */
|
|---|
| 231 | #define VMM2USERMETHODS_VERSION UINT32_C(0x00020000)
|
|---|
| 232 |
|
|---|
| 233 |
|
|---|
| 234 | /**
|
|---|
| 235 | * Checks whether we've armed the ring-0 long jump machinery.
|
|---|
| 236 | *
|
|---|
| 237 | * @returns @c true / @c false
|
|---|
| 238 | * @param pVCpu The caller's cross context virtual CPU structure.
|
|---|
| 239 | * @thread EMT
|
|---|
| 240 | * @sa VMMR0IsLongJumpArmed
|
|---|
| 241 | */
|
|---|
| 242 | #ifdef IN_RING0
|
|---|
| 243 | # define VMMIsLongJumpArmed(a_pVCpu) VMMR0IsLongJumpArmed(a_pVCpu)
|
|---|
| 244 | #else
|
|---|
| 245 | # define VMMIsLongJumpArmed(a_pVCpu) (false)
|
|---|
| 246 | #endif
|
|---|
| 247 |
|
|---|
| 248 |
|
|---|
| 249 | VMM_INT_DECL(RTRCPTR) VMMGetStackRC(PVMCPU pVCpu);
|
|---|
| 250 | VMMDECL(VMCPUID) VMMGetCpuId(PVM pVM);
|
|---|
| 251 | VMMDECL(PVMCPU) VMMGetCpu(PVM pVM);
|
|---|
| 252 | VMMDECL(PVMCPU) VMMGetCpu0(PVM pVM);
|
|---|
| 253 | VMMDECL(PVMCPU) VMMGetCpuById(PVM pVM, VMCPUID idCpu);
|
|---|
| 254 | VMMR3DECL(PVMCPU) VMMR3GetCpuByIdU(PUVM pVM, VMCPUID idCpu);
|
|---|
| 255 | VMM_INT_DECL(uint32_t) VMMGetSvnRev(void);
|
|---|
| 256 | VMM_INT_DECL(VMMSWITCHER) VMMGetSwitcher(PVM pVM);
|
|---|
| 257 | VMM_INT_DECL(bool) VMMIsInRing3Call(PVMCPU pVCpu);
|
|---|
| 258 | VMM_INT_DECL(void) VMMTrashVolatileXMMRegs(void);
|
|---|
| 259 |
|
|---|
| 260 |
|
|---|
| 261 | #ifdef IN_RING3
|
|---|
| 262 | /** @defgroup grp_vmm_r3 The VMM Host Context Ring 3 API
|
|---|
| 263 | * @ingroup grp_vmm
|
|---|
| 264 | * @{
|
|---|
| 265 | */
|
|---|
| 266 | VMMR3_INT_DECL(int) VMMR3Init(PVM pVM);
|
|---|
| 267 | VMMR3_INT_DECL(int) VMMR3InitR0(PVM pVM);
|
|---|
| 268 | # ifdef VBOX_WITH_RAW_MODE
|
|---|
| 269 | VMMR3_INT_DECL(int) VMMR3InitRC(PVM pVM);
|
|---|
| 270 | # endif
|
|---|
| 271 | VMMR3_INT_DECL(int) VMMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
|
|---|
| 272 | VMMR3_INT_DECL(int) VMMR3Term(PVM pVM);
|
|---|
| 273 | VMMR3_INT_DECL(void) VMMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
|
|---|
| 274 | VMMR3_INT_DECL(int) VMMR3UpdateLoggers(PVM pVM);
|
|---|
| 275 | VMMR3DECL(const char *) VMMR3GetRZAssertMsg1(PVM pVM);
|
|---|
| 276 | VMMR3DECL(const char *) VMMR3GetRZAssertMsg2(PVM pVM);
|
|---|
| 277 | VMMR3_INT_DECL(int) VMMR3SelectSwitcher(PVM pVM, VMMSWITCHER enmSwitcher);
|
|---|
| 278 | VMMR3_INT_DECL(RTR0PTR) VMMR3GetHostToGuestSwitcher(PVM pVM, VMMSWITCHER enmSwitcher);
|
|---|
| 279 | VMMR3_INT_DECL(int) VMMR3HmRunGC(PVM pVM, PVMCPU pVCpu);
|
|---|
| 280 | # ifdef VBOX_WITH_RAW_MODE
|
|---|
| 281 | VMMR3_INT_DECL(int) VMMR3RawRunGC(PVM pVM, PVMCPU pVCpu);
|
|---|
| 282 | VMMR3DECL(int) VMMR3ResumeHyper(PVM pVM, PVMCPU pVCpu);
|
|---|
| 283 | VMMR3_INT_DECL(int) VMMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue);
|
|---|
| 284 | VMMR3DECL(int) VMMR3CallRC(PVM pVM, RTRCPTR RCPtrEntry, unsigned cArgs, ...);
|
|---|
| 285 | VMMR3DECL(int) VMMR3CallRCV(PVM pVM, RTRCPTR RCPtrEntry, unsigned cArgs, va_list args);
|
|---|
| 286 | # endif
|
|---|
| 287 | VMMR3DECL(int) VMMR3CallR0(PVM pVM, uint32_t uOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
|
|---|
| 288 | VMMR3DECL(void) VMMR3FatalDump(PVM pVM, PVMCPU pVCpu, int rcErr);
|
|---|
| 289 | VMMR3_INT_DECL(void) VMMR3YieldSuspend(PVM pVM);
|
|---|
| 290 | VMMR3_INT_DECL(void) VMMR3YieldStop(PVM pVM);
|
|---|
| 291 | VMMR3_INT_DECL(void) VMMR3YieldResume(PVM pVM);
|
|---|
| 292 | VMMR3_INT_DECL(void) VMMR3SendSipi(PVM pVM, VMCPUID idCpu, uint32_t uVector);
|
|---|
| 293 | VMMR3_INT_DECL(void) VMMR3SendInitIpi(PVM pVM, VMCPUID idCpu);
|
|---|
| 294 | VMMR3DECL(int) VMMR3RegisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
|
|---|
| 295 | VMMR3DECL(int) VMMR3DeregisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
|
|---|
| 296 | VMMR3DECL(int) VMMR3EmtRendezvous(PVM pVM, uint32_t fFlags, PFNVMMEMTRENDEZVOUS pfnRendezvous, void *pvUser);
|
|---|
| 297 | VMMR3_INT_DECL(bool) VMMR3EmtRendezvousSetDisabled(PVMCPU pVCpu, bool fDisabled);
|
|---|
| 298 | /** @defgroup grp_VMMR3EmtRendezvous_fFlags VMMR3EmtRendezvous flags
|
|---|
| 299 | * @{ */
|
|---|
| 300 | /** Execution type mask. */
|
|---|
| 301 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_MASK UINT32_C(0x00000007)
|
|---|
| 302 | /** Invalid execution type. */
|
|---|
| 303 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_INVALID UINT32_C(0)
|
|---|
| 304 | /** Let the EMTs execute the callback one by one (in no particular order). */
|
|---|
| 305 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONE_BY_ONE UINT32_C(1)
|
|---|
| 306 | /** Let all the EMTs execute the callback at the same time. */
|
|---|
| 307 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_ALL_AT_ONCE UINT32_C(2)
|
|---|
| 308 | /** Only execute the callback on one EMT (no particular one). */
|
|---|
| 309 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE UINT32_C(3)
|
|---|
| 310 | /** Let the EMTs execute the callback one by one in ascending order. */
|
|---|
| 311 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_ASCENDING UINT32_C(4)
|
|---|
| 312 | /** Let the EMTs execute the callback one by one in descending order. */
|
|---|
| 313 | #define VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING UINT32_C(5)
|
|---|
| 314 | /** Stop after the first error.
|
|---|
| 315 | * This is not valid for any execution type where more than one EMT is active
|
|---|
| 316 | * at a time. */
|
|---|
| 317 | #define VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR UINT32_C(0x00000008)
|
|---|
| 318 | /** The valid flags. */
|
|---|
| 319 | #define VMMEMTRENDEZVOUS_FLAGS_VALID_MASK UINT32_C(0x0000000f)
|
|---|
| 320 | /** @} */
|
|---|
| 321 | VMMR3_INT_DECL(int) VMMR3EmtRendezvousFF(PVM pVM, PVMCPU pVCpu);
|
|---|
| 322 | VMMR3_INT_DECL(int) VMMR3ReadR0Stack(PVM pVM, VMCPUID idCpu, RTHCUINTPTR R0Addr, void *pvBuf, size_t cbRead);
|
|---|
| 323 | /** @} */
|
|---|
| 324 | #endif /* IN_RING3 */
|
|---|
| 325 |
|
|---|
| 326 |
|
|---|
| 327 | /** @defgroup grp_vmm_r0 The VMM Host Context Ring 0 API
|
|---|
| 328 | * @ingroup grp_vmm
|
|---|
| 329 | * @{
|
|---|
| 330 | */
|
|---|
| 331 |
|
|---|
| 332 | /**
|
|---|
| 333 | * The VMMR0Entry() codes.
|
|---|
| 334 | */
|
|---|
| 335 | typedef enum VMMR0OPERATION
|
|---|
| 336 | {
|
|---|
| 337 | /** Run guest context. */
|
|---|
| 338 | VMMR0_DO_RAW_RUN = SUP_VMMR0_DO_RAW_RUN,
|
|---|
| 339 | /** Run guest code using the available hardware acceleration technology. */
|
|---|
| 340 | VMMR0_DO_HM_RUN = SUP_VMMR0_DO_HM_RUN,
|
|---|
| 341 | /** Official NOP that we use for profiling. */
|
|---|
| 342 | VMMR0_DO_NOP = SUP_VMMR0_DO_NOP,
|
|---|
| 343 | /** Official slow iocl NOP that we use for profiling. */
|
|---|
| 344 | VMMR0_DO_SLOW_NOP,
|
|---|
| 345 |
|
|---|
| 346 | /** Ask the GVMM to create a new VM. */
|
|---|
| 347 | VMMR0_DO_GVMM_CREATE_VM,
|
|---|
| 348 | /** Ask the GVMM to destroy the VM. */
|
|---|
| 349 | VMMR0_DO_GVMM_DESTROY_VM,
|
|---|
| 350 | /** Call GVMMR0SchedHalt(). */
|
|---|
| 351 | VMMR0_DO_GVMM_SCHED_HALT,
|
|---|
| 352 | /** Call GVMMR0SchedWakeUp(). */
|
|---|
| 353 | VMMR0_DO_GVMM_SCHED_WAKE_UP,
|
|---|
| 354 | /** Call GVMMR0SchedPoke(). */
|
|---|
| 355 | VMMR0_DO_GVMM_SCHED_POKE,
|
|---|
| 356 | /** Call GVMMR0SchedWakeUpAndPokeCpus(). */
|
|---|
| 357 | VMMR0_DO_GVMM_SCHED_WAKE_UP_AND_POKE_CPUS,
|
|---|
| 358 | /** Call GVMMR0SchedPoll(). */
|
|---|
| 359 | VMMR0_DO_GVMM_SCHED_POLL,
|
|---|
| 360 | /** Call GVMMR0QueryStatistics(). */
|
|---|
| 361 | VMMR0_DO_GVMM_QUERY_STATISTICS,
|
|---|
| 362 | /** Call GVMMR0ResetStatistics(). */
|
|---|
| 363 | VMMR0_DO_GVMM_RESET_STATISTICS,
|
|---|
| 364 | /** Call GVMMR0RegisterVCpu(). */
|
|---|
| 365 | VMMR0_DO_GVMM_REGISTER_VMCPU,
|
|---|
| 366 |
|
|---|
| 367 | /** Call VMMR0 Per VM Init. */
|
|---|
| 368 | VMMR0_DO_VMMR0_INIT,
|
|---|
| 369 | /** Call VMMR0 Per VM Termination. */
|
|---|
| 370 | VMMR0_DO_VMMR0_TERM,
|
|---|
| 371 | /** Setup the hardware accelerated raw-mode session. */
|
|---|
| 372 | VMMR0_DO_HM_SETUP_VM,
|
|---|
| 373 | /** Attempt to enable or disable hardware accelerated raw-mode. */
|
|---|
| 374 | VMMR0_DO_HM_ENABLE,
|
|---|
| 375 | /** Calls function in the hypervisor.
|
|---|
| 376 | * The caller must setup the hypervisor context so the call will be performed.
|
|---|
| 377 | * The difference between VMMR0_DO_RUN_GC and this one is the handling of
|
|---|
| 378 | * the return GC code. The return code will not be interpreted by this operation.
|
|---|
| 379 | */
|
|---|
| 380 | VMMR0_DO_CALL_HYPERVISOR,
|
|---|
| 381 |
|
|---|
| 382 | /** Call PGMR0PhysAllocateHandyPages(). */
|
|---|
| 383 | VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES,
|
|---|
| 384 | /** Call PGMR0PhysFlushHandyPages(). */
|
|---|
| 385 | VMMR0_DO_PGM_FLUSH_HANDY_PAGES,
|
|---|
| 386 | /** Call PGMR0AllocateLargePage(). */
|
|---|
| 387 | VMMR0_DO_PGM_ALLOCATE_LARGE_HANDY_PAGE,
|
|---|
| 388 | /** Call PGMR0PhysSetupIommu(). */
|
|---|
| 389 | VMMR0_DO_PGM_PHYS_SETUP_IOMMU,
|
|---|
| 390 |
|
|---|
| 391 | /** Call GMMR0InitialReservation(). */
|
|---|
| 392 | VMMR0_DO_GMM_INITIAL_RESERVATION,
|
|---|
| 393 | /** Call GMMR0UpdateReservation(). */
|
|---|
| 394 | VMMR0_DO_GMM_UPDATE_RESERVATION,
|
|---|
| 395 | /** Call GMMR0AllocatePages(). */
|
|---|
| 396 | VMMR0_DO_GMM_ALLOCATE_PAGES,
|
|---|
| 397 | /** Call GMMR0FreePages(). */
|
|---|
| 398 | VMMR0_DO_GMM_FREE_PAGES,
|
|---|
| 399 | /** Call GMMR0FreeLargePage(). */
|
|---|
| 400 | VMMR0_DO_GMM_FREE_LARGE_PAGE,
|
|---|
| 401 | /** Call GMMR0QueryHypervisorMemoryStatsReq(). */
|
|---|
| 402 | VMMR0_DO_GMM_QUERY_HYPERVISOR_MEM_STATS,
|
|---|
| 403 | /** Call GMMR0QueryMemoryStatsReq(). */
|
|---|
| 404 | VMMR0_DO_GMM_QUERY_MEM_STATS,
|
|---|
| 405 | /** Call GMMR0BalloonedPages(). */
|
|---|
| 406 | VMMR0_DO_GMM_BALLOONED_PAGES,
|
|---|
| 407 | /** Call GMMR0MapUnmapChunk(). */
|
|---|
| 408 | VMMR0_DO_GMM_MAP_UNMAP_CHUNK,
|
|---|
| 409 | /** Call GMMR0SeedChunk(). */
|
|---|
| 410 | VMMR0_DO_GMM_SEED_CHUNK,
|
|---|
| 411 | /** Call GMMR0RegisterSharedModule. */
|
|---|
| 412 | VMMR0_DO_GMM_REGISTER_SHARED_MODULE,
|
|---|
| 413 | /** Call GMMR0UnregisterSharedModule. */
|
|---|
| 414 | VMMR0_DO_GMM_UNREGISTER_SHARED_MODULE,
|
|---|
| 415 | /** Call GMMR0ResetSharedModules. */
|
|---|
| 416 | VMMR0_DO_GMM_RESET_SHARED_MODULES,
|
|---|
| 417 | /** Call GMMR0CheckSharedModules. */
|
|---|
| 418 | VMMR0_DO_GMM_CHECK_SHARED_MODULES,
|
|---|
| 419 | /** Call GMMR0FindDuplicatePage. */
|
|---|
| 420 | VMMR0_DO_GMM_FIND_DUPLICATE_PAGE,
|
|---|
| 421 | /** Call GMMR0QueryStatistics(). */
|
|---|
| 422 | VMMR0_DO_GMM_QUERY_STATISTICS,
|
|---|
| 423 | /** Call GMMR0ResetStatistics(). */
|
|---|
| 424 | VMMR0_DO_GMM_RESET_STATISTICS,
|
|---|
| 425 |
|
|---|
| 426 | /** Set a GVMM or GMM configuration value. */
|
|---|
| 427 | VMMR0_DO_GCFGM_SET_VALUE,
|
|---|
| 428 | /** Query a GVMM or GMM configuration value. */
|
|---|
| 429 | VMMR0_DO_GCFGM_QUERY_VALUE,
|
|---|
| 430 |
|
|---|
| 431 | /** Call PDMR0DriverCallReqHandler. */
|
|---|
| 432 | VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER,
|
|---|
| 433 | /** Call PDMR0DeviceCallReqHandler. */
|
|---|
| 434 | VMMR0_DO_PDM_DEVICE_CALL_REQ_HANDLER,
|
|---|
| 435 |
|
|---|
| 436 | /** The start of the R0 service operations. */
|
|---|
| 437 | VMMR0_DO_SRV_START,
|
|---|
| 438 | /** Call IntNetR0Open(). */
|
|---|
| 439 | VMMR0_DO_INTNET_OPEN,
|
|---|
| 440 | /** Call IntNetR0IfClose(). */
|
|---|
| 441 | VMMR0_DO_INTNET_IF_CLOSE,
|
|---|
| 442 | /** Call IntNetR0IfGetBufferPtrs(). */
|
|---|
| 443 | VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS,
|
|---|
| 444 | /** Call IntNetR0IfSetPromiscuousMode(). */
|
|---|
| 445 | VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE,
|
|---|
| 446 | /** Call IntNetR0IfSetMacAddress(). */
|
|---|
| 447 | VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS,
|
|---|
| 448 | /** Call IntNetR0IfSetActive(). */
|
|---|
| 449 | VMMR0_DO_INTNET_IF_SET_ACTIVE,
|
|---|
| 450 | /** Call IntNetR0IfSend(). */
|
|---|
| 451 | VMMR0_DO_INTNET_IF_SEND,
|
|---|
| 452 | /** Call IntNetR0IfWait(). */
|
|---|
| 453 | VMMR0_DO_INTNET_IF_WAIT,
|
|---|
| 454 | /** Call IntNetR0IfAbortWait(). */
|
|---|
| 455 | VMMR0_DO_INTNET_IF_ABORT_WAIT,
|
|---|
| 456 |
|
|---|
| 457 | /** Forward call to the PCI driver */
|
|---|
| 458 | VMMR0_DO_PCIRAW_REQ,
|
|---|
| 459 |
|
|---|
| 460 | /** The end of the R0 service operations. */
|
|---|
| 461 | VMMR0_DO_SRV_END,
|
|---|
| 462 |
|
|---|
| 463 | /** Official call we use for testing Ring-0 APIs. */
|
|---|
| 464 | VMMR0_DO_TESTS,
|
|---|
| 465 | /** Test the 32->64 bits switcher. */
|
|---|
| 466 | VMMR0_DO_TEST_SWITCHER3264,
|
|---|
| 467 |
|
|---|
| 468 | /** The usual 32-bit type blow up. */
|
|---|
| 469 | VMMR0_DO_32BIT_HACK = 0x7fffffff
|
|---|
| 470 | } VMMR0OPERATION;
|
|---|
| 471 |
|
|---|
| 472 |
|
|---|
| 473 | /**
|
|---|
| 474 | * Request buffer for VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE.
|
|---|
| 475 | * @todo Move got GCFGM.h when it's implemented.
|
|---|
| 476 | */
|
|---|
| 477 | typedef struct GCFGMVALUEREQ
|
|---|
| 478 | {
|
|---|
| 479 | /** The request header.*/
|
|---|
| 480 | SUPVMMR0REQHDR Hdr;
|
|---|
| 481 | /** The support driver session handle. */
|
|---|
| 482 | PSUPDRVSESSION pSession;
|
|---|
| 483 | /** The value.
|
|---|
| 484 | * This is input for the set request and output for the query. */
|
|---|
| 485 | uint64_t u64Value;
|
|---|
| 486 | /** The variable name.
|
|---|
| 487 | * This is fixed sized just to make things simple for the mock-up. */
|
|---|
| 488 | char szName[48];
|
|---|
| 489 | } GCFGMVALUEREQ;
|
|---|
| 490 | /** Pointer to a VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE request buffer.
|
|---|
| 491 | * @todo Move got GCFGM.h when it's implemented.
|
|---|
| 492 | */
|
|---|
| 493 | typedef GCFGMVALUEREQ *PGCFGMVALUEREQ;
|
|---|
| 494 |
|
|---|
| 495 | #ifdef IN_RING0
|
|---|
| 496 | VMMR0DECL(int) VMMR0EntryInt(PVM pVM, VMMR0OPERATION enmOperation, void *pvArg);
|
|---|
| 497 | VMMR0DECL(void) VMMR0EntryFast(PVM pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation);
|
|---|
| 498 | VMMR0DECL(int) VMMR0EntryEx(PVM pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation, PSUPVMMR0REQHDR pReq, uint64_t u64Arg, PSUPDRVSESSION);
|
|---|
| 499 | VMMR0DECL(int) VMMR0TermVM(PVM pVM, PGVM pGVM);
|
|---|
| 500 | VMMR0_INT_DECL(bool) VMMR0IsLongJumpArmed(PVMCPU pVCpu);
|
|---|
| 501 | VMMR0_INT_DECL(bool) VMMR0IsInRing3LongJump(PVMCPU pVCpu);
|
|---|
| 502 | VMMR0DECL(int) VMMR0ThreadCtxHooksCreate(PVMCPU pVCpu);
|
|---|
| 503 | VMMR0DECL(void) VMMR0ThreadCtxHooksRelease(PVMCPU pVCpu);
|
|---|
| 504 | VMMR0DECL(bool) VMMR0ThreadCtxHooksAreCreated(PVMCPU pVCpu);
|
|---|
| 505 | VMMR0DECL(int) VMMR0ThreadCtxHooksRegister(PVMCPU pVCpu, PFNRTTHREADCTXHOOK pfnHook);
|
|---|
| 506 | VMMR0DECL(int) VMMR0ThreadCtxHooksDeregister(PVMCPU pVCpu);
|
|---|
| 507 | VMMR0DECL(bool) VMMR0ThreadCtxHooksAreRegistered(PVMCPU pVCpu);
|
|---|
| 508 |
|
|---|
| 509 | # ifdef LOG_ENABLED
|
|---|
| 510 | VMMR0DECL(void) VMMR0LogFlushDisable(PVMCPU pVCpu);
|
|---|
| 511 | VMMR0DECL(void) VMMR0LogFlushEnable(PVMCPU pVCpu);
|
|---|
| 512 | VMMR0DECL(bool) VMMR0IsLogFlushDisabled(PVMCPU pVCpu);
|
|---|
| 513 | # else
|
|---|
| 514 | # define VMMR0LogFlushDisable(pVCpu) do { } while(0)
|
|---|
| 515 | # define VMMR0LogFlushEnable(pVCpu) do { } while(0)
|
|---|
| 516 | # define VMMR0IsLogFlushDisabled(pVCpu) (true)
|
|---|
| 517 | # endif /* LOG_ENABLED */
|
|---|
| 518 | #endif /* IN_RING0 */
|
|---|
| 519 |
|
|---|
| 520 | /** @} */
|
|---|
| 521 |
|
|---|
| 522 |
|
|---|
| 523 | #ifdef IN_RC
|
|---|
| 524 | /** @defgroup grp_vmm_rc The VMM Raw-Mode Context API
|
|---|
| 525 | * @ingroup grp_vmm
|
|---|
| 526 | * @{
|
|---|
| 527 | */
|
|---|
| 528 | VMMRCDECL(int) VMMGCEntry(PVM pVM, unsigned uOperation, unsigned uArg, ...);
|
|---|
| 529 | VMMRCDECL(void) VMMGCGuestToHost(PVM pVM, int rc);
|
|---|
| 530 | VMMRCDECL(void) VMMGCLogFlushIfFull(PVM pVM);
|
|---|
| 531 | /** @} */
|
|---|
| 532 | #endif /* IN_RC */
|
|---|
| 533 |
|
|---|
| 534 | #if defined(IN_RC) || defined(IN_RING0)
|
|---|
| 535 | /** @defgroup grp_vmm_rz The VMM Raw-Mode and Ring-0 Context API
|
|---|
| 536 | * @ingroup grp_vmm
|
|---|
| 537 | * @{
|
|---|
| 538 | */
|
|---|
| 539 | VMMRZDECL(int) VMMRZCallRing3(PVM pVM, PVMCPU pVCpu, VMMCALLRING3 enmOperation, uint64_t uArg);
|
|---|
| 540 | VMMRZDECL(int) VMMRZCallRing3NoCpu(PVM pVM, VMMCALLRING3 enmOperation, uint64_t uArg);
|
|---|
| 541 | VMMRZDECL(void) VMMRZCallRing3Disable(PVMCPU pVCpu);
|
|---|
| 542 | VMMRZDECL(void) VMMRZCallRing3Enable(PVMCPU pVCpu);
|
|---|
| 543 | VMMRZDECL(bool) VMMRZCallRing3IsEnabled(PVMCPU pVCpu);
|
|---|
| 544 | VMMRZDECL(int) VMMRZCallRing3SetNotification(PVMCPU pVCpu, R0PTRTYPE(PFNVMMR0CALLRING3NOTIFICATION) pfnCallback, RTR0PTR pvUser);
|
|---|
| 545 | VMMRZDECL(void) VMMRZCallRing3RemoveNotification(PVMCPU pVCpu);
|
|---|
| 546 | VMMRZDECL(bool) VMMRZCallRing3IsNotificationSet(PVMCPU pVCpu);
|
|---|
| 547 | /** @} */
|
|---|
| 548 | #endif
|
|---|
| 549 |
|
|---|
| 550 |
|
|---|
| 551 | /** @} */
|
|---|
| 552 | RT_C_DECLS_END
|
|---|
| 553 |
|
|---|
| 554 | #endif
|
|---|
