GIMHv.cpp revision f84ab9e4599e758ec1f36479f871b3f5b7f271f2
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * GIM - Guest Interface Manager, Hyper-V implementation.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Copyright (C) 2014-2015 Oracle Corporation
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * available from http://www.virtualbox.org. This file is free software;
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * General Public License (GPL) as published by the Free Software
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync/*******************************************************************************
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync* Header Files *
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync*******************************************************************************/
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync/*******************************************************************************
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync* Defined Constants And Macros *
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync*******************************************************************************/
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync//#define GIMHV_HYPERCALL "GIMHvHypercall"
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * GIM Hyper-V saved-state version.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync/*******************************************************************************
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync* Global Variables *
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync*******************************************************************************/
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync# define GIMHV_MSRRANGE(a_uFirst, a_uLast, a_szName) \
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync { (a_uFirst), (a_uLast), kCpumMsrRdFn_Gim, kCpumMsrWrFn_Gim, 0, 0, 0, 0, 0, a_szName, { 0 }, { 0 }, { 0 }, { 0 } }
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync# define GIMHV_MSRRANGE(a_uFirst, a_uLast, a_szName) \
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync { (a_uFirst), (a_uLast), kCpumMsrRdFn_Gim, kCpumMsrWrFn_Gim, 0, 0, 0, 0, 0, a_szName }
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Array of MSR ranges supported by Hyper-V.
81b3101ea5e60964f67c97185bbd43dbf75c5ab5vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE0_START, MSR_GIM_HV_RANGE0_END, "Hyper-V range 0"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE1_START, MSR_GIM_HV_RANGE1_END, "Hyper-V range 1"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE2_START, MSR_GIM_HV_RANGE2_END, "Hyper-V range 2"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE3_START, MSR_GIM_HV_RANGE3_END, "Hyper-V range 3"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE4_START, MSR_GIM_HV_RANGE4_END, "Hyper-V range 4"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE5_START, MSR_GIM_HV_RANGE5_END, "Hyper-V range 5"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE6_START, MSR_GIM_HV_RANGE6_END, "Hyper-V range 6"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE7_START, MSR_GIM_HV_RANGE7_END, "Hyper-V range 7"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE8_START, MSR_GIM_HV_RANGE8_END, "Hyper-V range 8"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE9_START, MSR_GIM_HV_RANGE9_END, "Hyper-V range 9"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE10_START, MSR_GIM_HV_RANGE10_END, "Hyper-V range 10"),
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE11_START, MSR_GIM_HV_RANGE11_END, "Hyper-V range 11")
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Initializes the Hyper-V GIM provider.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @returns VBox status code.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @param pVM Pointer to the VM.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @param uVersion The interface version this VM should use.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync AssertReturn(pVM->gim.s.enmProviderId == GIMPROVIDERID_HYPERV, VERR_INTERNAL_ERROR_5);
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Determine interface capabilities based on the version.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync /* Basic features. */
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync //| GIM_HV_BASE_FEAT_VP_RUNTIME_MSR
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync //| GIM_HV_BASE_FEAT_BASIC_SYNTH_IC
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync //| GIM_HV_BASE_FEAT_SYNTH_TIMER_MSRS
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync //| GIM_HV_BASE_FEAT_STAT_PAGES_MSR
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync //| GIM_HV_BASE_FEAT_GUEST_IDLE_STATE_MSR
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync //| GIM_HV_BASE_FEAT_DEBUG_MSRS
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync /* Miscellaneous features. */
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync /* Hypervisor recommendations to the guest. */
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Populate the required fields in MMIO2 region records for registering.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync PGIMMMIO2REGION pRegion = &pHv->aMmio2Regions[GIM_HV_HYPERCALL_PAGE_REGION_IDX];
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync pRegion->iRegion = GIM_HV_HYPERCALL_PAGE_REGION_IDX;
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync RTStrCopy(pRegion->szDescription, sizeof(pRegion->szDescription), "Hyper-V hypercall page");
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync pRegion = &pHv->aMmio2Regions[GIM_HV_REF_TSC_PAGE_REGION_IDX];
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync RTStrCopy(pRegion->szDescription, sizeof(pRegion->szDescription), "Hyper-V TSC page");
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Make sure the CPU ID bit are in accordance to the Hyper-V
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * requirement and other paranoia checks.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * See "Requirements for implementing the Microsoft hypervisor interface" spec.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync Assert(!(pHv->uPartFlags & ( GIM_HV_PART_FLAGS_CREATE_PART
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync Assert((pHv->uBaseFeat & (GIM_HV_BASE_FEAT_HYPERCALL_MSRS | GIM_HV_BASE_FEAT_VP_ID_MSR))
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync == (GIM_HV_BASE_FEAT_HYPERCALL_MSRS | GIM_HV_BASE_FEAT_VP_ID_MSR));
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync for (unsigned i = 0; i < RT_ELEMENTS(pHv->aMmio2Regions); i++)
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Expose HVP (Hypervisor Present) bit to the guest.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync CPUMSetGuestCpuIdFeature(pVM, CPUMCPUIDFEATURE_HVP);
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Modify the standard hypervisor leaves for Hyper-V.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync HyperLeaf.uEax = UINT32_C(0x40000006); /* Minimum value for Hyper-V is 0x40000005. */
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Add Hyper-V specific leaves.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync HyperLeaf.uLeaf = UINT32_C(0x40000002); /* MBZ until MSR_GIM_HV_GUEST_OS_ID is set by the guest. */
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Insert all MSR ranges of Hyper-V.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync for (unsigned i = 0; i < RT_ELEMENTS(g_aMsrRanges_HyperV); i++)
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync rc = CPUMR3MsrRangesInsert(pVM, &g_aMsrRanges_HyperV[i]);
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Initializes remaining bits of the Hyper-V provider.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * This is called after initializing HM and almost all other VMM components.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @returns VBox status code.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @param pVM Pointer to the VM.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Determine interface capabilities based on the version.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync /* Hypervisor capabilities; features used by the hypervisor. */
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync pHv->uHyperCaps = HMIsNestedPagingActive(pVM) ? GIM_HV_HOST_FEAT_NESTED_PAGING : 0;
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync pHv->uHyperCaps |= HMAreMsrBitmapsAvailable(pVM) ? GIM_HV_HOST_FEAT_MSR_BITMAP : 0;
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync rc = PDMR3LdrGetSymbolRC(pVM, NULL /* pszModule */, GIMHV_HYPERCALL, &pVM->gim.s.pfnHypercallRC);
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync rc = PDMR3LdrGetSymbolR0(pVM, NULL /* pszModule */, GIMHV_HYPERCALL, &pVM->gim.s.pfnHypercallR0);
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * Terminates the Hyper-V GIM provider.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @returns VBox status code.
e0e0c19eefceaf5d4ec40f9466b58a771f50e799vboxsync * @param pVM Pointer to the VM.
return VINF_SUCCESS;
int rc = PDMR3LdrGetSymbolRC(pVM, NULL /* pszModule */, GIMHV_HYPERCALL, &pVM->gim.s.pfnHypercallRC);
return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Failed to enable the hypercall page. GCPhys=%#RGp rc=%Rrc"),
return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Hypercall MMIO2 region not registered. Missing GIM device?!"));
return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Failed to enable the TSC page. GCPhys=%#RGp rc=%Rrc"),
return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("TSC-page MMIO2 region not registered. Missing GIM device?!"));
return rc;
VMMR3_INT_DECL(int) gimR3HvEnableTscPage(PVM pVM, RTGCPHYS GCPhysTscPage, bool fUseThisTscSeq, uint32_t uTscSeq)
int rc;
return VINF_SUCCESS;
if ( fUseThisTscSeq
LogRel(("GIM: HyperV: Enabled TSC page at %#RGp - u64TscScale=%#RX64 u64TscKHz=%#RX64 (%'RU64) Seq=%#RU32\n",
return VINF_SUCCESS;
return VERR_GIM_OPERATION_FAILED;
return VINF_SUCCESS;
return VERR_GIM_PVTSC_NOT_ENABLED;
return VINF_SUCCESS;
return VERR_GIM_HYPERCALLS_NOT_ENABLED;
return VINF_SUCCESS;
return VINF_SUCCESS;
return rc;