summaryrefslogtreecommitdiffstats
path: root/src/VBox/HostDrivers/Support/SUPLibAll.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/VBox/HostDrivers/Support/SUPLibAll.cpp')
-rw-r--r--src/VBox/HostDrivers/Support/SUPLibAll.cpp332
1 files changed, 332 insertions, 0 deletions
diff --git a/src/VBox/HostDrivers/Support/SUPLibAll.cpp b/src/VBox/HostDrivers/Support/SUPLibAll.cpp
new file mode 100644
index 00000000..e8c3eeaf
--- /dev/null
+++ b/src/VBox/HostDrivers/Support/SUPLibAll.cpp
@@ -0,0 +1,332 @@
+/* $Id: SUPLibAll.cpp $ */
+/** @file
+ * VirtualBox Support Library - All Contexts Code.
+ */
+
+/*
+ * Copyright (C) 2006-2019 Oracle Corporation
+ *
+ * This file is part of VirtualBox Open Source Edition (OSE), as
+ * available from http://www.virtualbox.org. This file is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU
+ * General Public License (GPL) as published by the Free Software
+ * Foundation, in version 2 as it comes in the "COPYING" file of the
+ * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
+ * VirtualBox OSE distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ */
+
+
+/*********************************************************************************************************************************
+* Header Files *
+*********************************************************************************************************************************/
+#include <VBox/sup.h>
+#ifdef IN_RC
+# include <VBox/vmm/vm.h>
+# include <VBox/vmm/vmm.h>
+#endif
+#ifdef IN_RING0
+# include <iprt/mp.h>
+#endif
+#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
+# include <iprt/asm-amd64-x86.h>
+#endif
+#include <iprt/errcore.h>
+
+
+#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
+
+/**
+ * The slow case for SUPReadTsc where we need to apply deltas.
+ *
+ * Must only be called when deltas are applicable, so please do not call it
+ * directly.
+ *
+ * @returns TSC with delta applied.
+ * @param pGip Pointer to the GIP.
+ *
+ * @remarks May be called with interrupts disabled in ring-0! This is why the
+ * ring-0 code doesn't attempt to figure the delta.
+ *
+ * @internal
+ */
+SUPDECL(uint64_t) SUPReadTscWithDelta(PSUPGLOBALINFOPAGE pGip)
+{
+ uint64_t uTsc;
+ uint16_t iGipCpu;
+ AssertCompile(RT_IS_POWER_OF_TWO(RTCPUSET_MAX_CPUS));
+ AssertCompile(RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx) >= RTCPUSET_MAX_CPUS);
+ Assert(pGip->enmUseTscDelta > SUPGIPUSETSCDELTA_PRACTICALLY_ZERO);
+
+ /*
+ * Read the TSC and get the corresponding aCPUs index.
+ */
+#ifdef IN_RING3
+ if (pGip->fGetGipCpu & SUPGIPGETCPU_RDTSCP_MASK_MAX_SET_CPUS)
+ {
+ /* RDTSCP gives us all we need, no loops/cli. */
+ uint32_t iCpuSet;
+ uTsc = ASMReadTscWithAux(&iCpuSet);
+ iCpuSet &= RTCPUSET_MAX_CPUS - 1;
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ }
+ else if (pGip->fGetGipCpu & SUPGIPGETCPU_IDTR_LIMIT_MASK_MAX_SET_CPUS)
+ {
+ /* Storing the IDTR is normally very quick, but we need to loop. */
+ uint32_t cTries = 0;
+ for (;;)
+ {
+ uint16_t cbLim = ASMGetIdtrLimit();
+ uTsc = ASMReadTSC();
+ if (RT_LIKELY(ASMGetIdtrLimit() == cbLim))
+ {
+ uint16_t iCpuSet = cbLim - 256 * (ARCH_BITS == 64 ? 16 : 8);
+ iCpuSet &= RTCPUSET_MAX_CPUS - 1;
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ break;
+ }
+ if (cTries >= 16)
+ {
+ iGipCpu = UINT16_MAX;
+ break;
+ }
+ cTries++;
+ }
+ }
+ else
+ {
+ /* Get APIC ID via the slow CPUID instruction, requires looping. */
+ uint32_t cTries = 0;
+ for (;;)
+ {
+ uint8_t idApic = ASMGetApicId();
+ uTsc = ASMReadTSC();
+ if (RT_LIKELY(ASMGetApicId() == idApic))
+ {
+ iGipCpu = pGip->aiCpuFromApicId[idApic];
+ break;
+ }
+ if (cTries >= 16)
+ {
+ iGipCpu = UINT16_MAX;
+ break;
+ }
+ cTries++;
+ }
+ }
+#elif defined(IN_RING0)
+ /* Ring-0: Use use RTMpCpuId(), no loops. */
+ RTCCUINTREG uFlags = ASMIntDisableFlags();
+ int iCpuSet = RTMpCpuIdToSetIndex(RTMpCpuId());
+ if (RT_LIKELY((unsigned)iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ else
+ iGipCpu = UINT16_MAX;
+ uTsc = ASMReadTSC();
+ ASMSetFlags(uFlags);
+
+# elif defined(IN_RC)
+ /* Raw-mode context: We can get the host CPU set index via VMCPU, no loops. */
+ RTCCUINTREG uFlags = ASMIntDisableFlags(); /* Are already disable, but play safe. */
+ uint32_t iCpuSet = VMMGetCpu(&g_VM)->iHostCpuSet;
+ if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ else
+ iGipCpu = UINT16_MAX;
+ uTsc = ASMReadTSC();
+ ASMSetFlags(uFlags);
+#else
+# error "IN_RING3, IN_RC or IN_RING0 must be defined!"
+#endif
+
+ /*
+ * If the delta is valid, apply it.
+ */
+ if (RT_LIKELY(iGipCpu < pGip->cCpus))
+ {
+ int64_t iTscDelta = pGip->aCPUs[iGipCpu].i64TSCDelta;
+ if (RT_LIKELY(iTscDelta != INT64_MAX))
+ return uTsc - iTscDelta;
+
+# ifdef IN_RING3
+ /*
+ * The delta needs calculating, call supdrv to get the TSC.
+ */
+ int rc = SUPR3ReadTsc(&uTsc, NULL);
+ if (RT_SUCCESS(rc))
+ return uTsc;
+ AssertMsgFailed(("SUPR3ReadTsc -> %Rrc\n", rc));
+ uTsc = ASMReadTSC();
+# endif /* IN_RING3 */
+ }
+
+ /*
+ * This shouldn't happen, especially not in ring-3 and raw-mode context.
+ * But if it does, return something that's half useful.
+ */
+ AssertMsgFailed(("iGipCpu=%d (%#x) cCpus=%d fGetGipCpu=%#x\n", iGipCpu, iGipCpu, pGip->cCpus, pGip->fGetGipCpu));
+ return uTsc;
+}
+
+
+/**
+ * Internal worker for getting the GIP CPU array index for the calling CPU.
+ *
+ * @returns Index into SUPGLOBALINFOPAGE::aCPUs or UINT16_MAX.
+ * @param pGip The GIP.
+ */
+DECLINLINE(uint16_t) supGetGipCpuIndex(PSUPGLOBALINFOPAGE pGip)
+{
+ uint16_t iGipCpu;
+#ifdef IN_RING3
+ if (pGip->fGetGipCpu & SUPGIPGETCPU_IDTR_LIMIT_MASK_MAX_SET_CPUS)
+ {
+ /* Storing the IDTR is normally very fast. */
+ uint16_t cbLim = ASMGetIdtrLimit();
+ uint16_t iCpuSet = cbLim - 256 * (ARCH_BITS == 64 ? 16 : 8);
+ iCpuSet &= RTCPUSET_MAX_CPUS - 1;
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ }
+ else if (pGip->fGetGipCpu & SUPGIPGETCPU_RDTSCP_MASK_MAX_SET_CPUS)
+ {
+ /* RDTSCP gives us what need need and more. */
+ uint32_t iCpuSet;
+ ASMReadTscWithAux(&iCpuSet);
+ iCpuSet &= RTCPUSET_MAX_CPUS - 1;
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ }
+ else
+ {
+ /* Get APIC ID via the slow CPUID instruction. */
+ uint8_t idApic = ASMGetApicId();
+ iGipCpu = pGip->aiCpuFromApicId[idApic];
+ }
+#elif defined(IN_RING0)
+ /* Ring-0: Use use RTMpCpuId() (disables cli to avoid host OS assertions about unsafe CPU number usage). */
+ RTCCUINTREG uFlags = ASMIntDisableFlags();
+ int iCpuSet = RTMpCpuIdToSetIndex(RTMpCpuId());
+ if (RT_LIKELY((unsigned)iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ else
+ iGipCpu = UINT16_MAX;
+ ASMSetFlags(uFlags);
+
+# elif defined(IN_RC)
+ /* Raw-mode context: We can get the host CPU set index via VMCPU. */
+ uint32_t iCpuSet = VMMGetCpu(&g_VM)->iHostCpuSet;
+ if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
+ iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
+ else
+ iGipCpu = UINT16_MAX;
+#else
+# error "IN_RING3, IN_RC or IN_RING0 must be defined!"
+#endif
+ return iGipCpu;
+}
+
+
+/**
+ * Slow path in SUPGetTscDelta, don't call directly.
+ *
+ * @returns See SUPGetTscDelta.
+ * @param pGip The GIP.
+ * @internal
+ */
+SUPDECL(uint64_t) SUPGetTscDeltaSlow(PSUPGLOBALINFOPAGE pGip)
+{
+ uint16_t iGipCpu = supGetGipCpuIndex(pGip);
+ if (RT_LIKELY(iGipCpu < pGip->cCpus))
+ {
+ int64_t iTscDelta = pGip->aCPUs[iGipCpu].i64TSCDelta;
+ if (iTscDelta != INT64_MAX)
+ return iTscDelta;
+ }
+ AssertFailed();
+ return 0;
+}
+
+
+/**
+ * Slow path in SUPGetCpuHzFromGip, don't call directly.
+ *
+ * @returns See SUPGetCpuHzFromGip.
+ * @param pGip The GIP.
+ * @internal
+ */
+SUPDECL(uint64_t) SUPGetCpuHzFromGipForAsyncMode(PSUPGLOBALINFOPAGE pGip)
+{
+ uint16_t iGipCpu = supGetGipCpuIndex(pGip);
+ if (RT_LIKELY(iGipCpu < pGip->cCpus))
+ return pGip->aCPUs[iGipCpu].u64CpuHz;
+ AssertFailed();
+ return pGip->u64CpuHz;
+}
+
+
+/**
+ * Worker for SUPIsTscFreqCompatible().
+ *
+ * @returns true if it's compatible, false otherwise.
+ * @param uBaseCpuHz The reference CPU frequency of the system.
+ * @param uCpuHz The CPU frequency to compare with the base.
+ * @param fRelax Whether to use a more relaxed threshold (like
+ * for when running in a virtualized environment).
+ *
+ * @remarks Don't use directly, use SUPIsTscFreqCompatible() instead. This is
+ * to be used by tstGIP-2 or the like.
+ */
+SUPDECL(bool) SUPIsTscFreqCompatibleEx(uint64_t uBaseCpuHz, uint64_t uCpuHz, bool fRelax)
+{
+ if (uBaseCpuHz != uCpuHz)
+ {
+ /* Arbitrary tolerance threshold, tweak later if required, perhaps
+ more tolerance on lower frequencies and less tolerance on higher. */
+ uint16_t uFact = !fRelax ? 666 /* 0.15% */ : 125 /* 0.8% */;
+ uint64_t uThr = uBaseCpuHz / uFact;
+ uint64_t uLo = uBaseCpuHz - uThr;
+ uint64_t uHi = uBaseCpuHz + uThr;
+ if ( uCpuHz < uLo
+ || uCpuHz > uHi)
+ return false;
+ }
+ return true;
+}
+
+
+/**
+ * Checks if the provided TSC frequency is close enough to the computed TSC
+ * frequency of the host.
+ *
+ * @returns true if it's compatible, false otherwise.
+ * @param uCpuHz The TSC frequency to check.
+ * @param puGipCpuHz Where to store the GIP TSC frequency used
+ * during the compatibility test - optional.
+ * @param fRelax Whether to use a more relaxed threshold (like
+ * for when running in a virtualized environment).
+ */
+SUPDECL(bool) SUPIsTscFreqCompatible(uint64_t uCpuHz, uint64_t *puGipCpuHz, bool fRelax)
+{
+ PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
+ bool fCompat = false;
+ uint64_t uGipCpuHz = 0;
+ if ( pGip
+ && pGip->u32Mode != SUPGIPMODE_ASYNC_TSC)
+ {
+ uGipCpuHz = pGip->u64CpuHz;
+ fCompat = SUPIsTscFreqCompatibleEx(uGipCpuHz, uCpuHz, fRelax);
+ }
+ if (puGipCpuHz)
+ *puGipCpuHz = uGipCpuHz;
+ return fCompat;
+}
+
+#endif /* RT_ARCH_AMD64 || RT_ARCH_X86 */
+