TM.cpp revision 0f77dc54d7ec617480988ccdfcd080f480e79698
/* $Id$ */
/** @file
* TM - Timeout Manager.
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
/** @page pg_tm TM - The Time Manager
*
* The Time Manager abstracts the CPU clocks and manages timers used by the VMM,
* device and drivers.
*
*
* @section sec_tm_clocks Clocks
*
* There are currently 4 clocks:
* - Virtual (guest).
* - Synchronous virtual (guest).
* - CPU Tick (TSC) (guest). Only current use is rdtsc emulation. Usually a
* function of the virtual clock.
* - Real (host). The only current use is display updates for not real
* good reason...
*
* The interesting clocks are two first ones, the virtual and synchronous virtual
* clock. The synchronous virtual clock is tied to the virtual clock except that
* it will take into account timer delivery lag caused by host scheduling. It will
* normally never advance beyond the header timer, and when lagging too far behind
* it will gradually speed up to catch up with the virtual clock.
*
* The CPU tick (TSC) is normally virtualized as a function of the virtual time,
* where the frequency defaults to the host cpu frequency (as we measure it). It
* can also use the host TSC as source and either present it with an offset or
* unmodified. It is of course possible to configure the TSC frequency and mode
* of operation.
*
* @subsection subsec_tm_timesync Guest Time Sync / UTC time
*
* Guest time syncing is primarily taken care of by the VMM device. The principle
* is very simple, the guest additions periodically asks the VMM device what the
* current UTC time is and makes adjustments accordingly. Now, because the
* synchronous virtual clock might be doing catchups and we would therefore
* deliver more than the normal rate for a little while, some adjusting of the
* UTC time is required before passing it on to the guest. This is why TM provides
* an API for query the current UTC time.
*
*
* @section sec_tm_timers Timers
*
* The timers can use any of the TM clocks described in the previous section. Each
* clock has its own scheduling facility, or timer queue if you like. There are
* a few factors which makes it a bit complex. First there is the usual R0 vs R3
* vs. GC thing. Then there is multiple threads, and then there is the timer thread
* that periodically checks whether any timers has expired without EMT noticing. On
* the API level, all but the create and save APIs must be mulithreaded. EMT will
* always run the timers.
*
* The design is using a doubly linked list of active timers which is ordered
* by expire date. This list is only modified by the EMT thread. Updates to the
* list are are batched in a singly linked list, which is then process by the EMT
* thread at the first opportunity (immediately, next time EMT modifies a timer
* on that clock, or next timer timeout). Both lists are offset based and all
* the elements therefore allocated from the hyper heap.
*
* For figuring out when there is need to schedule and run timers TM will:
* - Poll whenever somebody queries the virtual clock.
* - Poll the virtual clocks from the EM and REM loops.
* - Poll the virtual clocks from trap exit path.
* - Poll the virtual clocks and calculate first timeout from the halt loop.
* - Employ a thread which periodically (100Hz) polls all the timer queues.
*
*
* @section sec_tm_timer Logging
*
* Level 2: Logs a most of the timer state transitions and queue servicing.
* Level 3: Logs a few oddments.
* Level 4: Logs TMCLOCK_VIRTUAL_SYNC catch-up events.
*
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#define LOG_GROUP LOG_GROUP_TM
#include "TMInternal.h"
#include <iprt/semaphore.h>
/*******************************************************************************
* Defined Constants And Macros *
*******************************************************************************/
/** The current saved state version.*/
#define TM_SAVED_STATE_VERSION 3
/*******************************************************************************
* Internal Functions *
*******************************************************************************/
/**
* Internal function for getting the clock time.
*
* @returns clock time.
* @param pVM The VM handle.
* @param enmClock The clock.
*/
{
switch (enmClock)
{
default:
return ~(uint64_t)0;
}
}
/**
* Initializes the TM.
*
* @returns VBox status code.
* @param pVM The VM to operate on.
*/
{
LogFlow(("TMR3Init:\n"));
/*
* Assert alignment and sizes.
*/
/*
* Init the structure.
*/
void *pv;
/*
* We directly use the GIP to calculate the virtual time. We map the
* the GIP into the guest context so we can do this calculation there
* as well and save costly world switches.
*/
if (VBOX_FAILURE(rc))
{
return rc;
}
/* Check assumptions made in TMAllVirtual.cpp about the GIP update interval. */
N_("The GIP update interval is too big. u32UpdateIntervalNS=%RU32 (u32UpdateHz=%RU32)"),
/*
* Setup the VirtualGetRaw backend.
*/
{
else
}
else
{
else
}
/* The rest is done in TMR3InitFinalize since it's too early to call PDM. */
/*
* Get our CFGM node, create it if necessary.
*/
if (!pCfgHandle)
{
}
/*
* Determin the TSC configuration and frequency.
*/
/* mode */
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying bool value \"UseRealTSC\""));
/* source */
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying bool value \"UseRealTSC\""));
/* TSC reliability */
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
{
else
}
/* frequency */
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
{
{
}
}
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying uint64_t value \"TSCTicksPerSecond\""));
N_("Configuration error: \"TSCTicksPerSecond\" = %RI64 is not in the range 1MHz..4GHz-1"),
else
{
}
/* setup and report */
else
LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%RU64) fTSCVirtualized=%RTbool fTSCUseRealTSC=%RTbool fMaybeUseOffsettedHostTSC=%RTbool\n",
/*
* Configure the timer synchronous virtual time.
*/
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying 32-bit integer value \"ScheduleSlack\""));
rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStopThreshold", &pVM->tm.s.u64VirtualSyncCatchUpStopThreshold);
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpStopThreshold\""));
rc = CFGMR3QueryU64(pCfgHandle, "CatchUpGiveUpThreshold", &pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold);
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpGiveUpThreshold\""));
do \
{ \
if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
else if (VBOX_FAILURE(rc)) \
return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpThreshold" #iPeriod "\"")); \
return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("Configuration error: Invalid start of period #" #iPeriod ": %RU64"), u64); \
rc = CFGMR3QueryU32(pCfgHandle, "CatchUpPrecentage" #iPeriod, &pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage); \
if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
else if (VBOX_FAILURE(rc)) \
return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 32-bit integer value \"CatchUpPrecentage" #iPeriod "\"")); \
} while (0)
/* This needs more tuning. Not sure if we really need so many period and be so gentle. */
/*
* Configure real world time (UTC).
*/
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying 64-bit integer value \"UTCOffset\""));
/*
* Setup the warp drive.
*/
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
rc = CFGMR3QueryU32(CFGMR3GetRoot(pVM), "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage); /* legacy */
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to querying uint32_t value \"WarpDrivePercent\""));
N_("Configuration error: \"WarpDrivePercent\" = %RI32 is not in the range 2..20000"),
/*
* Start the timer (guard against REM not yielding).
*/
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
u32Millies = 10;
else if (VBOX_FAILURE(rc))
N_("Configuration error: Failed to query uint32_t value \"TimerMillies\""));
if (VBOX_FAILURE(rc))
{
return rc;
}
/*
* Register saved state.
*/
if (VBOX_FAILURE(rc))
return rc;
/*
* Register statistics.
*/
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataR3.c1nsSteps, STAMTYPE_U32, "/TM/R3/1nsSteps", STAMUNIT_OCCURENCES, "Virtual time 1ns steps (due to TSC / GIP variations).");
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataR3.cBadPrev, STAMTYPE_U32, "/TM/R3/cBadPrev", STAMUNIT_OCCURENCES, "Times the previous virtual time was considered erratic (shouldn't ever happen).");
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataR0.c1nsSteps, STAMTYPE_U32, "/TM/R0/1nsSteps", STAMUNIT_OCCURENCES, "Virtual time 1ns steps (due to TSC / GIP variations).");
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataR0.cBadPrev, STAMTYPE_U32, "/TM/R0/cBadPrev", STAMUNIT_OCCURENCES, "Times the previous virtual time was considered erratic (shouldn't ever happen).");
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.c1nsSteps, STAMTYPE_U32, "/TM/GC/1nsSteps", STAMUNIT_OCCURENCES, "Virtual time 1ns steps (due to TSC / GIP variations).");
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.cBadPrev, STAMTYPE_U32, "/TM/GC/cBadPrev", STAMUNIT_OCCURENCES, "Times the previous virtual time was considered erratic (shouldn't ever happen).");
STAM_REL_REG( pVM, (void *)&pVM->tm.s.offVirtualSync, STAMTYPE_U64, "/TM/VirtualSync/CurrentOffset", STAMUNIT_NS, "The current offset. (subtract GivenUp to get the lag)");
STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.offVirtualSyncGivenUp, STAMTYPE_U64, "/TM/VirtualSync/GivenUp", STAMUNIT_NS, "Nanoseconds of the 'CurrentOffset' that's been given up and won't ever be attemted caught up with.");
#ifdef VBOX_WITH_STATISTICS
STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataR3.cExpired, STAMTYPE_U32, "/TM/R3/cExpired", STAMUNIT_OCCURENCES, "Times the TSC interval expired (overlaps 1ns steps).");
STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataR3.cUpdateRaces,STAMTYPE_U32, "/TM/R3/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataR0.cExpired, STAMTYPE_U32, "/TM/R0/cExpired", STAMUNIT_OCCURENCES, "Times the TSC interval expired (overlaps 1ns steps).");
STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataR0.cUpdateRaces,STAMTYPE_U32, "/TM/R0/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.cExpired, STAMTYPE_U32, "/TM/GC/cExpired", STAMUNIT_OCCURENCES, "Times the TSC interval expired (overlaps 1ns steps).");
STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.cUpdateRaces,STAMTYPE_U32, "/TM/GC/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
STAM_REG(pVM, &pVM->tm.s.StatDoQueues, STAMTYPE_PROFILE, "/TM/DoQueues", STAMUNIT_TICKS_PER_CALL, "Profiling timer TMR3TimerQueuesDo.");
STAM_REG(pVM, &pVM->tm.s.StatDoQueuesSchedule, STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Schedule",STAMUNIT_TICKS_PER_CALL, "The scheduling part.");
STAM_REG(pVM, &pVM->tm.s.StatDoQueuesRun, STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Run", STAMUNIT_TICKS_PER_CALL, "The run part.");
STAM_REG(pVM, &pVM->tm.s.StatPollAlreadySet, STAMTYPE_COUNTER, "/TM/PollAlreadySet", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the FF was already set.");
STAM_REG(pVM, &pVM->tm.s.StatPollVirtual, STAMTYPE_COUNTER, "/TM/PollHitsVirtual", STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL queue.");
STAM_REG(pVM, &pVM->tm.s.StatPollVirtualSync, STAMTYPE_COUNTER, "/TM/PollHitsVirtualSync",STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL_SYNC queue.");
STAM_REG(pVM, &pVM->tm.s.StatPollMiss, STAMTYPE_COUNTER, "/TM/PollMiss", STAMUNIT_OCCURENCES, "TMTimerPoll calls where nothing had expired.");
STAM_REG(pVM, &pVM->tm.s.StatPostponedR3, STAMTYPE_COUNTER, "/TM/PostponedR3", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-3.");
STAM_REG(pVM, &pVM->tm.s.StatPostponedR0, STAMTYPE_COUNTER, "/TM/PostponedR0", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-0.");
STAM_REG(pVM, &pVM->tm.s.StatPostponedGC, STAMTYPE_COUNTER, "/TM/PostponedGC", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in GC.");
STAM_REG(pVM, &pVM->tm.s.StatScheduleOneGC, STAMTYPE_PROFILE, "/TM/ScheduleOneGC", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.\n");
STAM_REG(pVM, &pVM->tm.s.StatScheduleOneR0, STAMTYPE_PROFILE, "/TM/ScheduleOneR0", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.\n");
STAM_REG(pVM, &pVM->tm.s.StatScheduleOneR3, STAMTYPE_PROFILE, "/TM/ScheduleOneR3", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.\n");
STAM_REG(pVM, &pVM->tm.s.StatScheduleSetFF, STAMTYPE_COUNTER, "/TM/ScheduleSetFF", STAMUNIT_OCCURENCES, "The number of times the timer FF was set instead of doing scheduling.");
STAM_REG(pVM, &pVM->tm.s.StatTimerSetGC, STAMTYPE_PROFILE, "/TM/TimerSetGC", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in GC.");
STAM_REG(pVM, &pVM->tm.s.StatTimerSetR0, STAMTYPE_PROFILE, "/TM/TimerSetR0", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0.");
STAM_REG(pVM, &pVM->tm.s.StatTimerSetR3, STAMTYPE_PROFILE, "/TM/TimerSetR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3.");
STAM_REG(pVM, &pVM->tm.s.StatTimerStopGC, STAMTYPE_PROFILE, "/TM/TimerStopGC", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in GC.");
STAM_REG(pVM, &pVM->tm.s.StatTimerStopR0, STAMTYPE_PROFILE, "/TM/TimerStopR0", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-0.");
STAM_REG(pVM, &pVM->tm.s.StatTimerStopR3, STAMTYPE_PROFILE, "/TM/TimerStopR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-3.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualGet, STAMTYPE_COUNTER, "/TM/VirtualGet", STAMUNIT_OCCURENCES, "The number of times TMTimerGet was called when the clock was running.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualGetSetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGet.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSync, STAMTYPE_COUNTER, "/TM/VirtualGetSync", STAMUNIT_OCCURENCES, "The number of times TMTimerGetSync was called when the clock was running.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSyncSetFF,STAMTYPE_COUNTER, "/TM/VirtualGetSyncSetFF",STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGetSync.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/VirtualPause", STAMUNIT_OCCURENCES, "The number of times TMR3TimerPause was called.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/VirtualResume", STAMUNIT_OCCURENCES, "The number of times TMR3TimerResume was called.");
STAM_REG(pVM, &pVM->tm.s.StatTimerCallbackSetFF,STAMTYPE_COUNTER, "/TM/CallbackSetFF", STAMUNIT_OCCURENCES, "The number of times the timer callback set FF.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncCatchup, STAMTYPE_PROFILE_ADV, "/TM/VirtualSync/CatchUp", STAMUNIT_TICKS_PER_OCCURENCE, "Counting and measuring the times spent catching up.");
STAM_REG(pVM, (void *)&pVM->tm.s.fVirtualSyncCatchUp, STAMTYPE_U8, "/TM/VirtualSync/CatchUpActive", STAMUNIT_NONE, "Catch-Up active indicator.");
STAM_REG(pVM, (void *)&pVM->tm.s.u32VirtualSyncCatchUpPercentage, STAMTYPE_U32, "/TM/VirtualSync/CatchUpPercentage", STAMUNIT_PCT, "The catch-up percentage. (+100/100 to get clock multiplier)");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGiveUp, STAMTYPE_COUNTER, "/TM/VirtualSync/GiveUp", STAMUNIT_OCCURENCES, "Times the catch-up was abandoned.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGiveUpBeforeStarting,STAMTYPE_COUNTER, "/TM/VirtualSync/GiveUpBeforeStarting", STAMUNIT_OCCURENCES, "Times the catch-up was abandoned before even starting. (Typically debugging++.)");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRun, STAMTYPE_COUNTER, "/TM/VirtualSync/Run", STAMUNIT_OCCURENCES, "Times the virtual sync timer queue was considered.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunRestart, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/Restarts", STAMUNIT_OCCURENCES, "Times the clock was restarted after a run.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunStop, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/Stop", STAMUNIT_OCCURENCES, "Times the clock was stopped when calculating the current time before examining the timers.");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunStoppedAlready, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/StoppedAlready", STAMUNIT_OCCURENCES, "Times the clock was already stopped elsewhere (TMVirtualSyncGet).");
STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunSlack, STAMTYPE_PROFILE, "/TM/VirtualSync/Run/Slack", STAMUNIT_NS_PER_OCCURENCE, "The scheduling slack. (Catch-up handed out when running timers.)");
{
STAMR3RegisterF(pVM, &pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "The catch-up percentage.", "/TM/VirtualSync/Periods/%u", i);
STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupAdjust[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times adjusted to this period.", "/TM/VirtualSync/Periods/%u/Adjust", i);
STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupInitial[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times started in this period.", "/TM/VirtualSync/Periods/%u/Initial", i);
STAMR3RegisterF(pVM, &pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u64Start, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Start of this period (lag).", "/TM/VirtualSync/Periods/%u/Start", i);
}
#endif /* VBOX_WITH_STATISTICS */
/*
* Register info handlers.
*/
DBGFR3InfoRegisterInternalEx(pVM, "timers", "Dumps all timers. No arguments.", tmR3TimerInfo, DBGFINFO_FLAGS_RUN_ON_EMT);
DBGFR3InfoRegisterInternalEx(pVM, "activetimers", "Dumps active all timers. No arguments.", tmR3TimerInfoActive, DBGFINFO_FLAGS_RUN_ON_EMT);
DBGFR3InfoRegisterInternalEx(pVM, "clocks", "Display the time of the various clocks.", tmR3InfoClocks, DBGFINFO_FLAGS_RUN_ON_EMT);
return VINF_SUCCESS;
}
/**
* Checks if the host CPU has a fixed TSC frequency.
*
* @returns true if it has, false if it hasn't.
*
* @remark This test doesn't bother with very old CPUs that don't do power
* management or any other stuff that might influence the TSC rate.
* This isn't currently relevant.
*/
{
if (ASMHasCpuId())
{
{
/*
* AuthenticAMD - Check for APM support and that TscInvariant is set.
*
* older models, but this isn't relevant since the result is currently
* only used for making a descision on AMD-V models.
*/
if (uEAX >= 0x80000007)
{
return true;
}
}
{
/*
* GenuineIntel - Check the model number.
*
* This test is lacking in the same way and for the same reasons
* as the AMD test above.
*/
if (uFamily == 0x0f)
if (uFamily >= 0x06)
return true;
}
}
return false;
}
/**
* Calibrate the CPU tick.
*
* @returns Number of ticks per second.
*/
{
/*
* Use GIP when available present.
*/
if ( pGip
{
AssertReleaseMsgFailed(("iCpu=%d - the ApicId is too high. send VBox.log and hardware specs!\n", iCpu));
else
{
if (tmR3HasFixedTSC(pVM))
/* Sleep a bit to get a more reliable CpuHz value. */
RTThreadSleep(32);
else
{
/* Spin for 40ms to try push up the CPU frequency and get a more reliable CpuHz value. */
/* nothing */;
}
if ( pGip
return u64Hz;
}
}
/* call this once first to make sure it's initialized. */
RTTimeNanoTS();
/*
* Yield the CPU to increase our chances of getting
* a correct value.
*/
RTThreadYield(); /* Try avoid interruptions between TSC and NanoTS samplings. */
unsigned i;
for (i = 0; i < ELEMENTS(au64Samples); i++)
{
unsigned cMillies;
int cTries = 5;
do
{
RTThreadSleep(s_auSleep[i]);
u64End = ASMReadTSC();
EndTS = RTTimeNanoTS();
} while ( cMillies == 0 /* the sleep may be interrupted... */
}
/*
* Discard the highest and lowest results and calculate the average.
*/
unsigned iHigh = 0;
unsigned iLow = 0;
{
iLow = i;
iHigh = i;
}
au64Samples[iLow] = 0;
au64Samples[iHigh] = 0;
u64Hz = au64Samples[0];
u64Hz += au64Samples[i];
return u64Hz;
}
/**
* Finalizes the TM initialization.
*
* @returns VBox status code.
* @param pVM The VM to operate on.
*/
{
int rc;
rc = PDMR3GetSymbolGCLazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataGC.pfnRediscover);
else
rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataR0.pfnRediscover);
else
return VINF_SUCCESS;
}
/**
* Applies relocations to data and code managed by this
* component. This function will be called at init and
* whenever the VMM need to relocate it self inside the GC.
*
* @param pVM The VM.
* @param offDelta Relocation delta relative to old location.
*/
{
int rc;
LogFlow(("TMR3Relocate\n"));
rc = PDMR3GetSymbolGCLazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataGC.pfnRediscover);
else
/*
* Iterate the timers updating the pVMGC pointers.
*/
{
}
}
/**
* Terminates the TM.
*
* Termination means cleaning up and freeing all resources,
* the VM it self is at this point powered off or suspended.
*
* @returns VBox status code.
* @param pVM The VM to operate on.
*/
{
{
}
return VINF_SUCCESS;
}
/**
* The VM is being reset.
*
* For the TM component this means that a rescheduling is preformed,
* the FF is cleared and but without running the queues. We'll have to
* check if this makes sense or not, but it seems like a good idea now....
*
* @param pVM VM handle.
*/
{
LogFlow(("TMR3Reset:\n"));
/*
* Abort any pending catch up.
* This isn't perfect,
*/
{
{
LogRel(("TM: Aborting catch-up attempt on reset with a %RU64 ns lag on reset; new total: %RU64 ns\n", offNew - offOld, offNew));
}
}
/*
* Process the queues.
*/
for (int i = 0; i < TMCLOCK_MAX; i++)
#ifdef VBOX_STRICT
#endif
}
/**
* Resolve a builtin GC symbol.
* Called by PDM when loading or relocating GC modules.
*
* @returns VBox status
* @param pVM VM Handle.
* @param pszSymbol Symbol to resolv
* @param pGCPtrValue Where to store the symbol value.
* @remark This has to work before TMR3Relocate() is called.
*/
{
//else if (..)
else
return VERR_SYMBOL_NOT_FOUND;
return VINF_SUCCESS;
}
/**
* Execute state save operation.
*
* @returns VBox status code.
* @param pVM VM Handle.
* @param pSSM SSM operation handle.
*/
{
LogFlow(("tmR3Save:\n"));
/*
* Save the virtual clocks.
*/
/* the virtual clock. */
/* the virtual timer synchronous clock. */
/* real time clock */
/* the cpu tick clock. */
}
/**
* Execute state load operation.
*
* @returns VBox status code.
* @param pVM VM Handle.
* @param pSSM SSM operation handle.
* @param u32Version Data layout version.
*/
{
LogFlow(("tmR3Load:\n"));
/*
* Validate version.
*/
if (u32Version != TM_SAVED_STATE_VERSION)
{
}
/*
* Load the virtual clock.
*/
/* the virtual clock. */
if (VBOX_FAILURE(rc))
return rc;
if (u64Hz != TMCLOCK_FREQ_VIRTUAL)
{
AssertMsgFailed(("The virtual clock frequency differs! Saved: %RU64 Binary: %RU64\n",
return VERR_SSM_VIRTUAL_CLOCK_HZ;
}
/* the virtual timer synchronous clock. */
bool f;
SSMR3GetBool(pSSM, &f);
/* the real clock */
if (VBOX_FAILURE(rc))
return rc;
if (u64Hz != TMCLOCK_FREQ_REAL)
{
AssertMsgFailed(("The real clock frequency differs! Saved: %RU64 Binary: %RU64\n",
return VERR_SSM_VIRTUAL_CLOCK_HZ; /* missleading... */
}
/* the cpu tick clock. */
if (VBOX_FAILURE(rc))
return rc;
else
LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%RU64) fTSCVirtualized=%RTbool fTSCUseRealTSC=%RTbool (state load)\n",
pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.fTSCVirtualized, pVM->tm.s.fTSCUseRealTSC));
/*
* Make sure timers get rescheduled immediately.
*/
return VINF_SUCCESS;
}
/**
* Internal TMR3TimerCreate worker.
*
* @returns VBox status code.
* @param pVM The VM handle.
* @param enmClock The timer clock.
* @param pszDesc The timer description.
* @param ppTimer Where to store the timer pointer on success.
*/
{
/*
* Allocate the timer.
*/
{
}
if (!pTimer)
{
if (VBOX_FAILURE(rc))
return rc;
}
/*
* Initialize it.
*/
pTimer->offScheduleNext = 0;
/* insert into the list of created timers. */
#ifdef VBOX_STRICT
#endif
return VINF_SUCCESS;
}
/**
* Creates a device timer.
*
* @returns VBox status.
* @param pVM The VM to create the timer in.
* @param pDevIns Device instance.
* @param enmClock The clock to use on this timer.
* @param pfnCallback Callback function.
* @param pszDesc Pointer to description string which must stay around
* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
* @param ppTimer Where to store the timer on success.
*/
TMR3DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
{
/*
* Allocate and init stuff.
*/
if (VBOX_SUCCESS(rc))
{
Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
}
return rc;
}
/**
* Creates a driver timer.
*
* @returns VBox status.
* @param pVM The VM to create the timer in.
* @param pDrvIns Driver instance.
* @param enmClock The clock to use on this timer.
* @param pfnCallback Callback function.
* @param pszDesc Pointer to description string which must stay around
* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
* @param ppTimer Where to store the timer on success.
*/
TMR3DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
{
/*
* Allocate and init stuff.
*/
if (VBOX_SUCCESS(rc))
{
Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
}
return rc;
}
/**
* Creates an internal timer.
*
* @returns VBox status.
* @param pVM The VM to create the timer in.
* @param enmClock The clock to use on this timer.
* @param pfnCallback Callback function.
* @param pvUser User argument to be passed to the callback.
* @param pszDesc Pointer to description string which must stay around
* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
* @param ppTimer Where to store the timer on success.
*/
TMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer)
{
/*
* Allocate and init stuff.
*/
if (VBOX_SUCCESS(rc))
{
Log(("TM: Created internal timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
}
return rc;
}
/**
* Creates an external timer.
*
* @returns Timer handle on success.
* @returns NULL on failure.
* @param pVM The VM to create the timer in.
* @param enmClock The clock to use on this timer.
* @param pfnCallback Callback function.
* @param pvUser User argument.
* @param pszDesc Pointer to description string which must stay around
* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
*/
TMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc)
{
/*
* Allocate and init stuff.
*/
if (VBOX_SUCCESS(rc))
{
Log(("TM: Created external timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
return pTimer;
}
return NULL;
}
/**
* Destroy all timers owned by a device.
*
* @returns VBox status.
* @param pVM VM handle.
* @param pDevIns Device which timers should be destroyed.
*/
{
if (!pDevIns)
return VERR_INVALID_PARAMETER;
while (pCur)
{
{
}
}
LogFlow(("TMR3TimerDestroyDevice: returns VINF_SUCCESS\n"));
return VINF_SUCCESS;
}
/**
* Destroy all timers owned by a driver.
*
* @returns VBox status.
* @param pVM VM handle.
* @param pDrvIns Driver which timers should be destroyed.
*/
{
if (!pDrvIns)
return VERR_INVALID_PARAMETER;
while (pCur)
{
{
}
}
LogFlow(("TMR3TimerDestroyDriver: returns VINF_SUCCESS\n"));
return VINF_SUCCESS;
}
/**
* Checks if the sync queue has one or more expired timers.
*
* @returns true / false.
*
* @param pVM The VM handle.
* @param enmClock The queue.
*/
{
}
/**
* Checks for expired timers in all the queues.
*
* @returns true / false.
* @param pVM The VM handle.
*/
{
/*
* Combine the time calculation for the first two since we're not on EMT
* TMVirtualSyncGet only permits EMT.
*/
return true;
return true;
/*
* The remaining timers.
*/
return true;
return true;
return false;
}
/**
* Schedulation timer callback.
*
* @param pTimer Timer handle.
* @param pvUser VM handle.
* @thread Timer thread.
*
* @remark We cannot do the scheduling and queues running from a timer handler
* since it's not executing in EMT, and even if it was it would be async
* and we wouldn't know the state of the affairs.
* So, we'll just raise the timer FF and force any REM execution to exit.
*/
{
#ifdef DEBUG_Sander /* very annoying, keep it private. */
Log(("tmR3TimerCallback: timer event still pending!!\n"));
#endif
)
)
{
VMR3NotifyFF(pVM, true);
}
}
/**
* Schedules and runs any pending timers.
*
* This is normally called from a forced action handler in EMT.
*
* @param pVM The VM to run the timers for.
*/
{
Log2(("TMR3TimerQueuesDo:\n"));
/*
* Process the queues.
*/
/* TMCLOCK_VIRTUAL_SYNC */
/* TMCLOCK_VIRTUAL */
#if 0 /** @todo if ever used, remove this and fix the stam prefixes on TMCLOCK_REAL below. */
/* TMCLOCK_TSC */
#endif
/* TMCLOCK_REAL */
/* done. */
#ifdef VBOX_STRICT
/* check that we didn't screwup. */
#endif
Log2(("TMR3TimerQueuesDo: returns void\n"));
}
/**
* Schedules and runs any pending times in the specified queue.
*
* This is normally called from a forced action handler in EMT.
*
* @param pVM The VM to run the timers for.
* @param pQueue The queue to run.
*/
{
/*
* Run timers.
*
* We check the clock once and run all timers which are ACTIVE
* and have an expire time less or equal to the time we read.
*
* N.B. A generic unlink must be applied since other threads
* are allowed to mess with any active timer at any time.
* However, we only allow EMT to handle EXPIRED_PENDING
* timers, thus enabling the timer handler function to
* arm the timer again.
*/
if (!pNext)
return;
{
Log2(("tmR3TimerQueueRun: pTimer=%p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
bool fRc;
if (fRc)
{
/* unlink */
if (pPrev)
else
{
}
if (pNext)
/* fire */
{
case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->u.Internal.pvUser); break;
default:
break;
}
/* change the state if it wasn't changed already in the handler. */
}
} /* run loop */
}
/**
* Schedules and runs any pending times in the timer queue for the
* synchronous virtual clock.
*
* This scheduling is a bit different from the other queues as it need
* to implement the special requirements of the timer synchronous virtual
* clock, thus this 2nd queue run funcion.
*
* @param pVM The VM to run the timers for.
*/
{
/*
* Any timers?
*/
if (RT_UNLIKELY(!pNext))
{
return;
}
/*
* Calculate the time frame for which we will dispatch timers.
*
* We use a time frame ranging from the current sync time (which is most likely the
* same as the head timer) and some configurable period (100000ns) up towards the
* current virtual time. This period might also need to be restricted by the catch-up
* rate so frequent calls to this function won't accelerate the time too much, however
* this will be implemented at a later point if neccessary.
*
* Without this frame we would 1) having to run timers much more frequently
* and 2) lag behind at a steady rate.
*/
{
}
else
{
/* Calc 'now'. (update order doesn't really matter here) */
{
{
uint64_t u64Sub = ASMMultU64ByU32DivByU32(u64Delta, pVM->tm.s.u32VirtualSyncCatchUpPercentage, 100);
{
Log4(("TM: %RU64/%RU64: sub %RU64 (run)\n", u64VirtualNow - off, off - pVM->tm.s.offVirtualSyncGivenUp, u64Sub));
}
else
{
}
}
}
/* Check if stopped by expired timer. */
{
Log4(("TM: %RU64/%RU64: exp tmr (run)\n", u64Now, u64VirtualNow - u64Now - pVM->tm.s.offVirtualSyncGivenUp));
}
}
/* calc end of frame. */
/* assert sanity */
/*
* Process the expired timers moving the clock along as we progress.
*/
#ifdef VBOX_STRICT
#endif
{
Log2(("tmR3TimerQueueRun: pTimer=%p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
bool fRc;
if (fRc)
{
/* unlink */
if (pPrev)
else
{
}
if (pNext)
/* advance the clock - don't permit timers to be out of order or armed in the 'past'. */
#ifdef VBOX_STRICT
AssertMsg(pTimer->u64Expire >= u64Prev, ("%RU64 < %RU64 %s\n", pTimer->u64Expire, u64Prev, pTimer->pszDesc));
#endif
/* fire */
{
case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->u.Internal.pvUser); break;
default:
break;
}
/* change the state if it wasn't changed already in the handler. */
}
} /* run loop */
/*
* Restart the clock if it was stopped to serve any timers,
*/
{
/* calc the slack we've handed out. */
AssertMsg(pVM->tm.s.u64VirtualSync >= u64Now, ("%RU64 < %RU64\n", pVM->tm.s.u64VirtualSync, u64Now));
if (offSlack)
{
p->cPeriods++;
}
});
/* Let the time run a little bit while we were busy running timers(?). */
if (offSlack > MAX_ELAPSED)
u64Elapsed = 0;
else
{
if (u64Elapsed > MAX_ELAPSED)
}
/* Calc the current offset. */
/*
* Deal with starting, adjusting and stopping catchup.
*/
{
{
/* stop */
}
{
/* adjust */
unsigned i = 0;
i++;
if (pVM->tm.s.u32VirtualSyncCatchUpPercentage < pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage)
{
ASMAtomicXchgU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
Log4(("TM: %RU64/%RU64: adj %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
}
}
else
{
/* give up */
Log4(("TM: %RU64/%RU64: give up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
LogRel(("TM: Giving up catch-up attempt at a %RU64 ns lag; new total: %RU64 ns\n", offLag, offNew));
}
}
{
{
/* start */
unsigned i = 0;
i++;
ASMAtomicXchgU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
Log4(("TM: %RU64/%RU64: catch-up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
}
else
{
/* don't bother */
LogRel(("TM: Not bothering to attempt catching up a %RU64 ns lag; new total: %RU64\n", offLag, offNew));
}
}
/*
* Update the offset and restart the clock.
*/
}
}
/**
* Saves the state of a timer to a saved state.
*
* @returns VBox status.
* @param pTimer Timer to save.
* @param pSSM Save State Manager handle.
*/
{
LogFlow(("TMR3TimerSave: pTimer=%p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
{
case TMTIMERSTATE_STOPPED:
if (!RTThreadYield())
RTThreadSleep(1);
/* fall thru */
case TMTIMERSTATE_ACTIVE:
case TMTIMERSTATE_EXPIRED:
case TMTIMERSTATE_FREE:
AssertMsgFailed(("Invalid timer state %d %s (%s)\n", pTimer->enmState, tmTimerState(pTimer->enmState), pTimer->pszDesc));
}
}
/**
* Loads the state of a timer from a saved state.
*
* @returns VBox status.
* @param pTimer Timer to restore.
* @param pSSM Save State Manager handle.
*/
{
LogFlow(("TMR3TimerLoad: pTimer=%p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
/*
* Load the state and validate it.
*/
if (VBOX_FAILURE(rc))
return rc;
if ( enmState != TMTIMERSTATE_PENDING_STOP
{
}
{
/*
* Load the expire time.
*/
if (VBOX_FAILURE(rc))
return rc;
/*
* Set it.
*/
}
else
{
/*
* Stop it.
*/
}
/*
* On failure set SSM status.
*/
if (VBOX_FAILURE(rc))
return rc;
}
/**
* Get the real world UTC time adjusted for VM lag.
*
* @returns pTime.
* @param pVM The VM instance.
* @param pTime Where to store the time.
*/
{
return pTime;
}
/**
* Display all timers.
*
* @param pVM VM Handle.
* @param pHlp The info helpers.
* @param pszArgs Arguments, ignored.
*/
{
"Timers (pVM=%p)\n"
"%.*s %.*s %.*s %.*s Clock %-18s %-18s %-25s Description\n",
pVM,
"Time",
"Expire",
"State");
{
"%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %-25s %s\n",
}
}
/**
* Display all active timers.
*
* @param pVM VM Handle.
* @param pHlp The info helpers.
* @param pszArgs Arguments, ignored.
*/
{
"Active Timers (pVM=%p)\n"
"%.*s %.*s %.*s %.*s Clock %-18s %-18s %-25s Description\n",
pVM,
"Time",
"Expire",
"State");
{
{
"%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %-25s %s\n",
? "Real "
? "Virt "
? "VrSy "
: "TSC ",
}
}
}
/**
* Display all clocks.
*
* @param pVM VM Handle.
* @param pHlp The info helpers.
* @param pszArgs Arguments, ignored.
*/
{
/*
* Read the times first to avoid more than necessary time variation.
*/
/*
* TSC
*/
"Cpu Tick: %18RU64 (%#016RX64) %RU64Hz %s%s",
{
}
else
/*
* virtual
*/
" Virtual: %18RU64 (%#016RX64) %RU64Hz %s",
/*
* virtual sync
*/
"VirtSync: %18RU64 (%#016RX64) %s%s",
{
}
/*
* real
*/
" Real: %18RU64 (%#016RX64) %RU64Hz\n",
}