GIMHv.cpp revision 0002ffbc00d4c202557c75aebf253538084850d5
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * GIM - Guest Interface Manager, Hyper-V implementation.
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * Copyright (C) 2014 Oracle Corporation
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * available from http://www.virtualbox.org. This file is free software;
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * you can redistribute it and/or modify it under the terms of the GNU
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * General Public License (GPL) as published by the Free Software
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync/*******************************************************************************
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync* Header Files *
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync*******************************************************************************/
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync/*******************************************************************************
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync* Defined Constants And Macros *
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync*******************************************************************************/
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync//#define GIMHV_HYPERCALL "GIMHvHypercall"
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync# define GIMHV_MSRRANGE(a_uFirst, a_uLast, a_szName) \
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync { (a_uFirst), (a_uLast), kCpumMsrRdFn_Gim, kCpumMsrWrFn_Gim, 0, 0, 0, 0, 0, a_szName, { 0 }, { 0 }, { 0 }, { 0 } }
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync# define GIMHV_MSRRANGE(a_uFirst, a_uLast, a_szName) \
2c19fa7a35e93931f995c196426585b16f8bf2c0vboxsync { (a_uFirst), (a_uLast), kCpumMsrRdFn_Gim, kCpumMsrWrFn_Gim, 0, 0, 0, 0, 0, a_szName }
2c19fa7a35e93931f995c196426585b16f8bf2c0vboxsync * Array of MSR ranges supported by Hyper-V.
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE0_START, MSR_GIM_HV_RANGE0_END, "Hyper-V range 0"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE1_START, MSR_GIM_HV_RANGE1_END, "Hyper-V range 1"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE2_START, MSR_GIM_HV_RANGE2_END, "Hyper-V range 2"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE3_START, MSR_GIM_HV_RANGE3_END, "Hyper-V range 3"),
1df297ea8319f3f3afddb73e6ea2fd9c7f0e5eb4vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE4_START, MSR_GIM_HV_RANGE4_END, "Hyper-V range 4"),
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE5_START, MSR_GIM_HV_RANGE5_END, "Hyper-V range 5"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE6_START, MSR_GIM_HV_RANGE6_END, "Hyper-V range 6"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE7_START, MSR_GIM_HV_RANGE7_END, "Hyper-V range 7"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE8_START, MSR_GIM_HV_RANGE8_END, "Hyper-V range 8"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE9_START, MSR_GIM_HV_RANGE9_END, "Hyper-V range 9"),
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE10_START, MSR_GIM_HV_RANGE10_END, "Hyper-V range 10"),
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync GIMHV_MSRRANGE(MSR_GIM_HV_RANGE11_START, MSR_GIM_HV_RANGE11_END, "Hyper-V range 11")
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync * Initializes the Hyper-V GIM provider.
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync * @returns VBox status code.
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync * @param pVM Pointer to the VM.
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync * @param uVersion The interface version this VM should use.
3fd65c821ad93f378baf8c75b30dcb6a17a5dd77vboxsync AssertReturn(pVM->gim.s.enmProviderId == GIMPROVIDERID_HYPERV, VERR_INTERNAL_ERROR_5);
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync * Determine interface capabilities based on the version.
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync //| GIM_HV_BASE_FEAT_VP_RUNTIME_MSR
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync //| GIM_HV_BASE_FEAT_BASIC_SYNTH_IC
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync //| GIM_HV_BASE_FEAT_SYNTH_TIMER_MSRS
2a560b28131ee7efa5b73a9e9cbfdb08eae28624vboxsync //| GIM_HV_BASE_FEAT_APIC_ACCESS_MSRS
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync //| GIM_HV_BASE_FEAT_VIRT_SYS_RESET_MSR
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync //| GIM_HV_BASE_FEAT_STAT_PAGES_MSR
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync //| GIM_HV_BASE_FEAT_GUEST_IDLE_STATE_MSR
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync //| GIM_HV_BASE_FEAT_DEBUG_MSRS
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync * Populate the required fields in MMIO2 region records for registering.
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync PGIMMMIO2REGION pRegion = &pHv->aMmio2Regions[GIM_HV_HYPERCALL_PAGE_REGION_IDX];
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync pRegion->iRegion = GIM_HV_HYPERCALL_PAGE_REGION_IDX;
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync RTStrCopy(pRegion->szDescription, sizeof(pRegion->szDescription), "Hyper-V hypercall page");
ab7139411cba3600213877c953b69fc11a7ef0cfvboxsync pRegion = &pHv->aMmio2Regions[GIM_HV_REF_TSC_PAGE_REGION_IDX];
2c19fa7a35e93931f995c196426585b16f8bf2c0vboxsync RTStrCopy(pRegion->szDescription, sizeof(pRegion->szDescription), "Hyper-V TSC page");
2a560b28131ee7efa5b73a9e9cbfdb08eae28624vboxsync * Make sure the CPU ID bit are in accordance to the Hyper-V
2a560b28131ee7efa5b73a9e9cbfdb08eae28624vboxsync * requirement and other paranoia checks.
2a560b28131ee7efa5b73a9e9cbfdb08eae28624vboxsync * See "Requirements for implementing the Microsoft hypervisor interface" spec.
2a560b28131ee7efa5b73a9e9cbfdb08eae28624vboxsync Assert(!(pHv->uPartFlags & ( GIM_HV_PART_FLAGS_CREATE_PART
1df297ea8319f3f3afddb73e6ea2fd9c7f0e5eb4vboxsync Assert((pHv->uBaseFeat & (GIM_HV_BASE_FEAT_HYPERCALL_MSRS | GIM_HV_BASE_FEAT_VP_ID_MSR))
1df297ea8319f3f3afddb73e6ea2fd9c7f0e5eb4vboxsync == (GIM_HV_BASE_FEAT_HYPERCALL_MSRS | GIM_HV_BASE_FEAT_VP_ID_MSR));
1df297ea8319f3f3afddb73e6ea2fd9c7f0e5eb4vboxsync for (unsigned i = 0; i < RT_ELEMENTS(pHv->aMmio2Regions); i++)
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * Expose HVP (Hypervisor Present) bit to the guest.
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync CPUMSetGuestCpuIdFeature(pVM, CPUMCPUIDFEATURE_HVP);
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * Modify the standard hypervisor leaves for Hyper-V.
e0dec59adb362e8486c0622785420ad10e720972vboxsync HyperLeaf.uEax = UINT32_C(0x40000005); /* Minimum value for Hyper-V */
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * Add Hyper-V specific leaves.
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync HyperLeaf.uLeaf = UINT32_C(0x40000002); /* MBZ until MSR_GIM_HV_GUEST_OS_ID is set by the guest. */
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync * Insert all MSR ranges of Hyper-V.
2c19fa7a35e93931f995c196426585b16f8bf2c0vboxsync for (unsigned i = 0; i < RT_ELEMENTS(g_aMsrRanges_HyperV); i++)
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync rc = CPUMR3MsrRangesInsert(pVM, &g_aMsrRanges_HyperV[i]);
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync rc = PDMR3LdrGetSymbolRC(pVM, NULL /* pszModule */, GIMHV_HYPERCALL, &pVM->gim.s.pfnHypercallRC);
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync rc = PDMR3LdrGetSymbolR0(pVM, NULL /* pszModule */, GIMHV_HYPERCALL, &pVM->gim.s.pfnHypercallR0);
0aaf889969ebdaba8a310db13adcec8c10174796vboxsyncVMMR3_INT_DECL(void) GIMR3HvRelocate(PVM pVM, RTGCINTPTR offDelta)
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync int rc = PDMR3LdrGetSymbolRC(pVM, NULL /* pszModule */, GIMHV_HYPERCALL, &pVM->gim.s.pfnHypercallRC);
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * The VM is being reset. This resets Hyper-V provider MSRs and unmaps whatever
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * Hyper-V regions that the guest may have mapped.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @param pVM Pointer to the VM.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * Unmap MMIO2 pages that the guest may have setup.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync LogRelFunc(("Resetting Hyper-V MMIO2 regions and MSRs...\n"));
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync for (unsigned i = 0; i < RT_ELEMENTS(pHv->aMmio2Regions); i++)
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * Reset MSRs.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * Returns a pointer to the MMIO2 regions supported by Hyper-V.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @returns Pointer to an array of MMIO2 regions.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @param pVM Pointer to the VM.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @param pcRegions Where to store the number of regions in the array.
165b506f4c024dabd5a4caaeda31c66712d154eavboxsyncVMMR3_INT_DECL(PGIMMMIO2REGION) GIMR3HvGetMmio2Regions(PVM pVM, uint32_t *pcRegions)
165b506f4c024dabd5a4caaeda31c66712d154eavboxsync Assert(*pcRegions <= UINT8_MAX); /* See PGMR3PhysMMIO2Register(). */
return VINF_SUCCESS;
LogRelFunc(("MMIO2 region array size mismatch. size=%u expected=%u\n", cRegions, RT_ELEMENTS(pHv->aMmio2Regions)));
return VERR_SSM_FIELD_INVALID_VALUE;
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;
int rc;
return VINF_SUCCESS;
LogRel(("GIM: HyperV: Enabled TSC page at %#RGp (u64TscScale=%#RX64 u64TscKHz=%#RX64)\n", GCPhysTscPage,
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;