VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMR3/TM.cpp@ 67924

Last change on this file since 67924 was 65897, checked in by vboxsync, 8 years ago

TMR3TimerSkip: No need to to set ssm handle status on failure when the error came from an SSM API.
TMR3TimerSkip,TMR3TimerLoad: Clearified the r47786 workaround.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 153.3 KB
Line 
1/* $Id: TM.cpp 65897 2017-02-28 14:34:11Z vboxsync $ */
2/** @file
3 * TM - Time Manager.
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18/** @page pg_tm TM - The Time Manager
19 *
20 * The Time Manager abstracts the CPU clocks and manages timers used by the VMM,
21 * device and drivers.
22 *
23 * @see grp_tm
24 *
25 *
26 * @section sec_tm_clocks Clocks
27 *
28 * There are currently 4 clocks:
29 * - Virtual (guest).
30 * - Synchronous virtual (guest).
31 * - CPU Tick (TSC) (guest). Only current use is rdtsc emulation. Usually a
32 * function of the virtual clock.
33 * - Real (host). This is only used for display updates atm.
34 *
35 * The most important clocks are the three first ones and of these the second is
36 * the most interesting.
37 *
38 *
39 * The synchronous virtual clock is tied to the virtual clock except that it
40 * will take into account timer delivery lag caused by host scheduling. It will
41 * normally never advance beyond the head timer, and when lagging too far behind
42 * it will gradually speed up to catch up with the virtual clock. All devices
43 * implementing time sources accessible to and used by the guest is using this
44 * clock (for timers and other things). This ensures consistency between the
45 * time sources.
46 *
47 * The virtual clock is implemented as an offset to a monotonic, high
48 * resolution, wall clock. The current time source is using the RTTimeNanoTS()
49 * machinery based upon the Global Info Pages (GIP), that is, we're using TSC
50 * deltas (usually 10 ms) to fill the gaps between GIP updates. The result is
51 * a fairly high res clock that works in all contexts and on all hosts. The
52 * virtual clock is paused when the VM isn't in the running state.
53 *
54 * The CPU tick (TSC) is normally virtualized as a function of the synchronous
55 * virtual clock, where the frequency defaults to the host cpu frequency (as we
56 * measure it). In this mode it is possible to configure the frequency. Another
57 * (non-default) option is to use the raw unmodified host TSC values. And yet
58 * another, to tie it to time spent executing guest code. All these things are
59 * configurable should non-default behavior be desirable.
60 *
61 * The real clock is a monotonic clock (when available) with relatively low
62 * resolution, though this a bit host specific. Note that we're currently not
63 * servicing timers using the real clock when the VM is not running, this is
64 * simply because it has not been needed yet therefore not implemented.
65 *
66 *
67 * @subsection subsec_tm_timesync Guest Time Sync / UTC time
68 *
69 * Guest time syncing is primarily taken care of by the VMM device. The
70 * principle is very simple, the guest additions periodically asks the VMM
71 * device what the current UTC time is and makes adjustments accordingly.
72 *
73 * A complicating factor is that the synchronous virtual clock might be doing
74 * catchups and the guest perception is currently a little bit behind the world
75 * but it will (hopefully) be catching up soon as we're feeding timer interrupts
76 * at a slightly higher rate. Adjusting the guest clock to the current wall
77 * time in the real world would be a bad idea then because the guest will be
78 * advancing too fast and run ahead of world time (if the catchup works out).
79 * To solve this problem TM provides the VMM device with an UTC time source that
80 * gets adjusted with the current lag, so that when the guest eventually catches
81 * up the lag it will be showing correct real world time.
82 *
83 *
84 * @section sec_tm_timers Timers
85 *
86 * The timers can use any of the TM clocks described in the previous section.
87 * Each clock has its own scheduling facility, or timer queue if you like.
88 * There are a few factors which makes it a bit complex. First, there is the
89 * usual R0 vs R3 vs. RC thing. Then there are multiple threads, and then there
90 * is the timer thread that periodically checks whether any timers has expired
91 * without EMT noticing. On the API level, all but the create and save APIs
92 * must be multithreaded. EMT will always run the timers.
93 *
94 * The design is using a doubly linked list of active timers which is ordered
95 * by expire date. This list is only modified by the EMT thread. Updates to
96 * the list are batched in a singly linked list, which is then processed by the
97 * EMT thread at the first opportunity (immediately, next time EMT modifies a
98 * timer on that clock, or next timer timeout). Both lists are offset based and
99 * all the elements are therefore allocated from the hyper heap.
100 *
101 * For figuring out when there is need to schedule and run timers TM will:
102 * - Poll whenever somebody queries the virtual clock.
103 * - Poll the virtual clocks from the EM and REM loops.
104 * - Poll the virtual clocks from trap exit path.
105 * - Poll the virtual clocks and calculate first timeout from the halt loop.
106 * - Employ a thread which periodically (100Hz) polls all the timer queues.
107 *
108 *
109 * @image html TMTIMER-Statechart-Diagram.gif
110 *
111 * @section sec_tm_timer Logging
112 *
113 * Level 2: Logs a most of the timer state transitions and queue servicing.
114 * Level 3: Logs a few oddments.
115 * Level 4: Logs TMCLOCK_VIRTUAL_SYNC catch-up events.
116 *
117 */
118
119
120/*********************************************************************************************************************************
121* Header Files *
122*********************************************************************************************************************************/
123#define LOG_GROUP LOG_GROUP_TM
124#include <VBox/vmm/tm.h>
125#include <iprt/asm-amd64-x86.h> /* for SUPGetCpuHzFromGip from sup.h */
126#include <VBox/vmm/vmm.h>
127#include <VBox/vmm/mm.h>
128#include <VBox/vmm/hm.h>
129#include <VBox/vmm/gim.h>
130#include <VBox/vmm/ssm.h>
131#include <VBox/vmm/dbgf.h>
132#include <VBox/vmm/dbgftrace.h>
133#ifdef VBOX_WITH_REM
134# include <VBox/vmm/rem.h>
135#endif
136#include <VBox/vmm/pdmapi.h>
137#include <VBox/vmm/iom.h>
138#include "TMInternal.h"
139#include <VBox/vmm/vm.h>
140#include <VBox/vmm/uvm.h>
141
142#include <VBox/vmm/pdmdev.h>
143#include <VBox/param.h>
144#include <VBox/err.h>
145
146#include <VBox/log.h>
147#include <iprt/asm.h>
148#include <iprt/asm-math.h>
149#include <iprt/assert.h>
150#include <iprt/thread.h>
151#include <iprt/time.h>
152#include <iprt/timer.h>
153#include <iprt/semaphore.h>
154#include <iprt/string.h>
155#include <iprt/env.h>
156
157#include "TMInline.h"
158
159
160/*********************************************************************************************************************************
161* Defined Constants And Macros *
162*********************************************************************************************************************************/
163/** The current saved state version.*/
164#define TM_SAVED_STATE_VERSION 3
165
166
167/*********************************************************************************************************************************
168* Internal Functions *
169*********************************************************************************************************************************/
170static bool tmR3HasFixedTSC(PVM pVM);
171static uint64_t tmR3CalibrateTSC(void);
172static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM);
173static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
174static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
175static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue);
176static void tmR3TimerQueueRunVirtualSync(PVM pVM);
177static DECLCALLBACK(int) tmR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent);
178#ifndef VBOX_WITHOUT_NS_ACCOUNTING
179static DECLCALLBACK(void) tmR3CpuLoadTimer(PVM pVM, PTMTIMER pTimer, void *pvUser);
180#endif
181static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
182static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
183static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
184static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtDisable(PVM pVM, PVMCPU pVCpu, void *pvData);
185static const char * tmR3GetTSCModeName(PVM pVM);
186static const char * tmR3GetTSCModeNameEx(TMTSCMODE enmMode);
187
188
189/**
190 * Initializes the TM.
191 *
192 * @returns VBox status code.
193 * @param pVM The cross context VM structure.
194 */
195VMM_INT_DECL(int) TMR3Init(PVM pVM)
196{
197 LogFlow(("TMR3Init:\n"));
198
199 /*
200 * Assert alignment and sizes.
201 */
202 AssertCompileMemberAlignment(VM, tm.s, 32);
203 AssertCompile(sizeof(pVM->tm.s) <= sizeof(pVM->tm.padding));
204 AssertCompileMemberAlignment(TM, TimerCritSect, 8);
205 AssertCompileMemberAlignment(TM, VirtualSyncLock, 8);
206
207 /*
208 * Init the structure.
209 */
210 void *pv;
211 int rc = MMHyperAlloc(pVM, sizeof(pVM->tm.s.paTimerQueuesR3[0]) * TMCLOCK_MAX, 0, MM_TAG_TM, &pv);
212 AssertRCReturn(rc, rc);
213 pVM->tm.s.paTimerQueuesR3 = (PTMTIMERQUEUE)pv;
214 pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pv);
215 pVM->tm.s.paTimerQueuesRC = MMHyperR3ToRC(pVM, pv);
216
217 pVM->tm.s.offVM = RT_OFFSETOF(VM, tm.s);
218 pVM->tm.s.idTimerCpu = pVM->cCpus - 1; /* The last CPU. */
219 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].enmClock = TMCLOCK_VIRTUAL;
220 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].u64Expire = INT64_MAX;
221 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].enmClock = TMCLOCK_VIRTUAL_SYNC;
222 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].u64Expire = INT64_MAX;
223 pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].enmClock = TMCLOCK_REAL;
224 pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].u64Expire = INT64_MAX;
225 pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].enmClock = TMCLOCK_TSC;
226 pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].u64Expire = INT64_MAX;
227
228
229 /*
230 * We directly use the GIP to calculate the virtual time. We map the
231 * the GIP into the guest context so we can do this calculation there
232 * as well and save costly world switches.
233 */
234 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
235 pVM->tm.s.pvGIPR3 = (void *)pGip;
236 AssertMsgReturn(pVM->tm.s.pvGIPR3, ("GIP support is now required!\n"), VERR_TM_GIP_REQUIRED);
237 AssertMsgReturn((pGip->u32Version >> 16) == (SUPGLOBALINFOPAGE_VERSION >> 16),
238 ("Unsupported GIP version %#x! (expected=%#x)\n", pGip->u32Version, SUPGLOBALINFOPAGE_VERSION),
239 VERR_TM_GIP_VERSION);
240
241 RTHCPHYS HCPhysGIP;
242 rc = SUPR3GipGetPhys(&HCPhysGIP);
243 AssertMsgRCReturn(rc, ("Failed to get GIP physical address!\n"), rc);
244
245 RTGCPTR GCPtr;
246#ifdef SUP_WITH_LOTS_OF_CPUS
247 rc = MMR3HyperMapHCPhys(pVM, pVM->tm.s.pvGIPR3, NIL_RTR0PTR, HCPhysGIP, (size_t)pGip->cPages * PAGE_SIZE,
248 "GIP", &GCPtr);
249#else
250 rc = MMR3HyperMapHCPhys(pVM, pVM->tm.s.pvGIPR3, NIL_RTR0PTR, HCPhysGIP, PAGE_SIZE, "GIP", &GCPtr);
251#endif
252 if (RT_FAILURE(rc))
253 {
254 AssertMsgFailed(("Failed to map GIP into GC, rc=%Rrc!\n", rc));
255 return rc;
256 }
257 pVM->tm.s.pvGIPRC = GCPtr;
258 LogFlow(("TMR3Init: HCPhysGIP=%RHp at %RRv\n", HCPhysGIP, pVM->tm.s.pvGIPRC));
259 MMR3HyperReserve(pVM, PAGE_SIZE, "fence", NULL);
260
261 /* Check assumptions made in TMAllVirtual.cpp about the GIP update interval. */
262 if ( pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC
263 && pGip->u32UpdateIntervalNS >= 250000000 /* 0.25s */)
264 return VMSetError(pVM, VERR_TM_GIP_UPDATE_INTERVAL_TOO_BIG, RT_SRC_POS,
265 N_("The GIP update interval is too big. u32UpdateIntervalNS=%RU32 (u32UpdateHz=%RU32)"),
266 pGip->u32UpdateIntervalNS, pGip->u32UpdateHz);
267
268 /* Log GIP info that may come in handy. */
269 LogRel(("TM: GIP - u32Mode=%d (%s) u32UpdateHz=%u u32UpdateIntervalNS=%u enmUseTscDelta=%d (%s) fGetGipCpu=%#x cCpus=%d\n",
270 pGip->u32Mode, SUPGetGIPModeName(pGip), pGip->u32UpdateHz, pGip->u32UpdateIntervalNS,
271 pGip->enmUseTscDelta, SUPGetGIPTscDeltaModeName(pGip), pGip->fGetGipCpu, pGip->cCpus));
272 LogRel(("TM: GIP - u64CpuHz=%'RU64 (%#RX64) SUPGetCpuHzFromGip => %'RU64\n",
273 pGip->u64CpuHz, pGip->u64CpuHz, SUPGetCpuHzFromGip(pGip)));
274 for (uint32_t iCpuSet = 0; iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx); iCpuSet++)
275 {
276 uint16_t iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
277 if (iGipCpu != UINT16_MAX)
278 LogRel(("TM: GIP - CPU: iCpuSet=%#x idCpu=%#x idApic=%#x iGipCpu=%#x i64TSCDelta=%RI64 enmState=%d u64CpuHz=%RU64(*) cErrors=%u\n",
279 iCpuSet, pGip->aCPUs[iGipCpu].idCpu, pGip->aCPUs[iGipCpu].idApic, iGipCpu, pGip->aCPUs[iGipCpu].i64TSCDelta,
280 pGip->aCPUs[iGipCpu].enmState, pGip->aCPUs[iGipCpu].u64CpuHz, pGip->aCPUs[iGipCpu].cErrors));
281 }
282
283 /*
284 * Setup the VirtualGetRaw backend.
285 */
286 pVM->tm.s.pfnVirtualGetRawR3 = tmVirtualNanoTSRediscover;
287 pVM->tm.s.VirtualGetRawDataR3.pfnRediscover = tmVirtualNanoTSRediscover;
288 pVM->tm.s.VirtualGetRawDataR3.pfnBad = tmVirtualNanoTSBad;
289 pVM->tm.s.VirtualGetRawDataR3.pfnBadCpuIndex = tmVirtualNanoTSBadCpuIndex;
290 pVM->tm.s.VirtualGetRawDataR3.pu64Prev = &pVM->tm.s.u64VirtualRawPrev;
291 pVM->tm.s.VirtualGetRawDataRC.pu64Prev = MMHyperR3ToRC(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
292 pVM->tm.s.VirtualGetRawDataR0.pu64Prev = MMHyperR3ToR0(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
293 AssertRelease(pVM->tm.s.VirtualGetRawDataR0.pu64Prev);
294 /* The rest is done in TMR3InitFinalize() since it's too early to call PDM. */
295
296 /*
297 * Init the locks.
298 */
299 rc = PDMR3CritSectInit(pVM, &pVM->tm.s.TimerCritSect, RT_SRC_POS, "TM Timer Lock");
300 if (RT_FAILURE(rc))
301 return rc;
302 rc = PDMR3CritSectInit(pVM, &pVM->tm.s.VirtualSyncLock, RT_SRC_POS, "TM VirtualSync Lock");
303 if (RT_FAILURE(rc))
304 return rc;
305
306 /*
307 * Get our CFGM node, create it if necessary.
308 */
309 PCFGMNODE pCfgHandle = CFGMR3GetChild(CFGMR3GetRoot(pVM), "TM");
310 if (!pCfgHandle)
311 {
312 rc = CFGMR3InsertNode(CFGMR3GetRoot(pVM), "TM", &pCfgHandle);
313 AssertRCReturn(rc, rc);
314 }
315
316 /*
317 * Specific errors about some obsolete TM settings (remove after 2015-12-03).
318 */
319 if (CFGMR3Exists(pCfgHandle, "TSCVirtualized"))
320 return VMSetError(pVM, VERR_CFGM_CONFIG_UNKNOWN_VALUE, RT_SRC_POS,
321 N_("Configuration error: TM setting \"TSCVirtualized\" is no longer supported. Use the \"TSCMode\" setting instead."));
322 if (CFGMR3Exists(pCfgHandle, "UseRealTSC"))
323 return VMSetError(pVM, VERR_CFGM_CONFIG_UNKNOWN_VALUE, RT_SRC_POS,
324 N_("Configuration error: TM setting \"UseRealTSC\" is no longer supported. Use the \"TSCMode\" setting instead."));
325
326 if (CFGMR3Exists(pCfgHandle, "MaybeUseOffsettedHostTSC"))
327 return VMSetError(pVM, VERR_CFGM_CONFIG_UNKNOWN_VALUE, RT_SRC_POS,
328 N_("Configuration error: TM setting \"MaybeUseOffsettedHostTSC\" is no longer supported. Use the \"TSCMode\" setting instead."));
329
330 /*
331 * Validate the rest of the TM settings.
332 */
333 rc = CFGMR3ValidateConfig(pCfgHandle, "/TM/",
334 "TSCMode|"
335 "TSCModeSwitchAllowed|"
336 "TSCTicksPerSecond|"
337 "TSCTiedToExecution|"
338 "TSCNotTiedToHalt|"
339 "ScheduleSlack|"
340 "CatchUpStopThreshold|"
341 "CatchUpGiveUpThreshold|"
342 "CatchUpStartThreshold0|CatchUpStartThreshold1|CatchUpStartThreshold2|CatchUpStartThreshold3|"
343 "CatchUpStartThreshold4|CatchUpStartThreshold5|CatchUpStartThreshold6|CatchUpStartThreshold7|"
344 "CatchUpStartThreshold8|CatchUpStartThreshold9|"
345 "CatchUpPrecentage0|CatchUpPrecentage1|CatchUpPrecentage2|CatchUpPrecentage3|"
346 "CatchUpPrecentage4|CatchUpPrecentage5|CatchUpPrecentage6|CatchUpPrecentage7|"
347 "CatchUpPrecentage8|CatchUpPrecentage9|"
348 "UTCOffset|"
349 "WarpDrivePercentage|"
350 "HostHzMax|"
351 "HostHzFudgeFactorTimerCpu|"
352 "HostHzFudgeFactorOtherCpu|"
353 "HostHzFudgeFactorCatchUp100|"
354 "HostHzFudgeFactorCatchUp200|"
355 "HostHzFudgeFactorCatchUp400|"
356 "TimerMillies",
357 "",
358 "TM", 0);
359 if (RT_FAILURE(rc))
360 return rc;
361
362 /*
363 * Determine the TSC configuration and frequency.
364 */
365 /** @cfgm{/TM/TSCMode, string, Depends on the CPU and VM config}
366 * The name of the TSC mode to use: VirtTSCEmulated, RealTSCOffset or Dynamic.
367 * The default depends on the VM configuration and the capabilities of the
368 * host CPU. Other config options or runtime changes may override the TSC
369 * mode specified here.
370 */
371 char szTSCMode[32];
372 rc = CFGMR3QueryString(pCfgHandle, "TSCMode", szTSCMode, sizeof(szTSCMode));
373 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
374 {
375 /** @todo Rainy-day/never: Dynamic mode isn't currently suitable for SMP VMs, so
376 * fall back on the more expensive emulated mode. With the current TSC handling
377 * (frequent switching between offsetted mode and taking VM exits, on all VCPUs
378 * without any kind of coordination) will lead to inconsistent TSC behavior with
379 * guest SMP, including TSC going backwards. */
380 pVM->tm.s.enmTSCMode = pVM->cCpus == 1 && tmR3HasFixedTSC(pVM) ? TMTSCMODE_DYNAMIC : TMTSCMODE_VIRT_TSC_EMULATED;
381 }
382 else if (RT_FAILURE(rc))
383 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying string value \"TSCMode\""));
384 else
385 {
386 if (!RTStrCmp(szTSCMode, "VirtTSCEmulated"))
387 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
388 else if (!RTStrCmp(szTSCMode, "RealTSCOffset"))
389 pVM->tm.s.enmTSCMode = TMTSCMODE_REAL_TSC_OFFSET;
390 else if (!RTStrCmp(szTSCMode, "Dynamic"))
391 pVM->tm.s.enmTSCMode = TMTSCMODE_DYNAMIC;
392 else
393 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Unrecognized TM TSC mode value \"%s\""), szTSCMode);
394 }
395
396 /**
397 * @cfgm{/TM/TSCModeSwitchAllowed, bool, Whether TM TSC mode switch is allowed
398 * at runtime}
399 * When using paravirtualized guests, we dynamically switch TSC modes to a more
400 * optimal one for performance. This setting allows overriding this behaviour.
401 */
402 rc = CFGMR3QueryBool(pCfgHandle, "TSCModeSwitchAllowed", &pVM->tm.s.fTSCModeSwitchAllowed);
403 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
404 {
405 /* This is finally determined in TMR3InitFinalize() as GIM isn't initialized yet. */
406 pVM->tm.s.fTSCModeSwitchAllowed = true;
407 }
408 else if (RT_FAILURE(rc))
409 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying bool value \"TSCModeSwitchAllowed\""));
410
411 /** @cfgm{/TM/TSCTicksPerSecond, uint32_t, Current TSC frequency from GIP}
412 * The number of TSC ticks per second (i.e. the TSC frequency). This will
413 * override enmTSCMode.
414 */
415 rc = CFGMR3QueryU64(pCfgHandle, "TSCTicksPerSecond", &pVM->tm.s.cTSCTicksPerSecond);
416 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
417 {
418 pVM->tm.s.cTSCTicksPerSecond = tmR3CalibrateTSC();
419 if ( pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET
420 && pVM->tm.s.cTSCTicksPerSecond >= _4G)
421 {
422 pVM->tm.s.cTSCTicksPerSecond = _4G - 1; /* (A limitation of our math code) */
423 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
424 }
425 }
426 else if (RT_FAILURE(rc))
427 return VMSetError(pVM, rc, RT_SRC_POS,
428 N_("Configuration error: Failed to querying uint64_t value \"TSCTicksPerSecond\""));
429 else if ( pVM->tm.s.cTSCTicksPerSecond < _1M
430 || pVM->tm.s.cTSCTicksPerSecond >= _4G)
431 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
432 N_("Configuration error: \"TSCTicksPerSecond\" = %RI64 is not in the range 1MHz..4GHz-1"),
433 pVM->tm.s.cTSCTicksPerSecond);
434 else
435 {
436 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
437 }
438
439 /** @cfgm{/TM/TSCTiedToExecution, bool, false}
440 * Whether the TSC should be tied to execution. This will exclude most of the
441 * virtualization overhead, but will by default include the time spent in the
442 * halt state (see TM/TSCNotTiedToHalt). This setting will override all other
443 * TSC settings except for TSCTicksPerSecond and TSCNotTiedToHalt, which should
444 * be used avoided or used with great care. Note that this will only work right
445 * together with VT-x or AMD-V, and with a single virtual CPU. */
446 rc = CFGMR3QueryBoolDef(pCfgHandle, "TSCTiedToExecution", &pVM->tm.s.fTSCTiedToExecution, false);
447 if (RT_FAILURE(rc))
448 return VMSetError(pVM, rc, RT_SRC_POS,
449 N_("Configuration error: Failed to querying bool value \"TSCTiedToExecution\""));
450 if (pVM->tm.s.fTSCTiedToExecution)
451 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
452
453 /** @cfgm{/TM/TSCNotTiedToHalt, bool, true}
454 * For overriding the default of TM/TSCTiedToExecution, i.e. set this to false
455 * to make the TSC freeze during HLT. */
456 rc = CFGMR3QueryBoolDef(pCfgHandle, "TSCNotTiedToHalt", &pVM->tm.s.fTSCNotTiedToHalt, false);
457 if (RT_FAILURE(rc))
458 return VMSetError(pVM, rc, RT_SRC_POS,
459 N_("Configuration error: Failed to querying bool value \"TSCNotTiedToHalt\""));
460
461 /*
462 * Configure the timer synchronous virtual time.
463 */
464 /** @cfgm{/TM/ScheduleSlack, uint32_t, ns, 0, UINT32_MAX, 100000}
465 * Scheduling slack when processing timers. */
466 rc = CFGMR3QueryU32(pCfgHandle, "ScheduleSlack", &pVM->tm.s.u32VirtualSyncScheduleSlack);
467 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
468 pVM->tm.s.u32VirtualSyncScheduleSlack = 100000; /* 0.100ms (ASSUMES virtual time is nanoseconds) */
469 else if (RT_FAILURE(rc))
470 return VMSetError(pVM, rc, RT_SRC_POS,
471 N_("Configuration error: Failed to querying 32-bit integer value \"ScheduleSlack\""));
472
473 /** @cfgm{/TM/CatchUpStopThreshold, uint64_t, ns, 0, UINT64_MAX, 500000}
474 * When to stop a catch-up, considering it successful. */
475 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStopThreshold", &pVM->tm.s.u64VirtualSyncCatchUpStopThreshold);
476 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
477 pVM->tm.s.u64VirtualSyncCatchUpStopThreshold = 500000; /* 0.5ms */
478 else if (RT_FAILURE(rc))
479 return VMSetError(pVM, rc, RT_SRC_POS,
480 N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpStopThreshold\""));
481
482 /** @cfgm{/TM/CatchUpGiveUpThreshold, uint64_t, ns, 0, UINT64_MAX, 60000000000}
483 * When to give up a catch-up attempt. */
484 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpGiveUpThreshold", &pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold);
485 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
486 pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold = UINT64_C(60000000000); /* 60 sec */
487 else if (RT_FAILURE(rc))
488 return VMSetError(pVM, rc, RT_SRC_POS,
489 N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpGiveUpThreshold\""));
490
491
492 /** @cfgm{/TM/CatchUpPrecentage[0..9], uint32_t, %, 1, 2000, various}
493 * The catch-up percent for a given period. */
494 /** @cfgm{/TM/CatchUpStartThreshold[0..9], uint64_t, ns, 0, UINT64_MAX}
495 * The catch-up period threshold, or if you like, when a period starts. */
496#define TM_CFG_PERIOD(iPeriod, DefStart, DefPct) \
497 do \
498 { \
499 uint64_t u64; \
500 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStartThreshold" #iPeriod, &u64); \
501 if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
502 u64 = UINT64_C(DefStart); \
503 else if (RT_FAILURE(rc)) \
504 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpThreshold" #iPeriod "\"")); \
505 if ( (iPeriod > 0 && u64 <= pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod - 1].u64Start) \
506 || u64 >= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold) \
507 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("Configuration error: Invalid start of period #" #iPeriod ": %'RU64"), u64); \
508 pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u64Start = u64; \
509 rc = CFGMR3QueryU32(pCfgHandle, "CatchUpPrecentage" #iPeriod, &pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage); \
510 if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
511 pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage = (DefPct); \
512 else if (RT_FAILURE(rc)) \
513 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 32-bit integer value \"CatchUpPrecentage" #iPeriod "\"")); \
514 } while (0)
515 /* This needs more tuning. Not sure if we really need so many period and be so gentle. */
516 TM_CFG_PERIOD(0, 750000, 5); /* 0.75ms at 1.05x */
517 TM_CFG_PERIOD(1, 1500000, 10); /* 1.50ms at 1.10x */
518 TM_CFG_PERIOD(2, 8000000, 25); /* 8ms at 1.25x */
519 TM_CFG_PERIOD(3, 30000000, 50); /* 30ms at 1.50x */
520 TM_CFG_PERIOD(4, 75000000, 75); /* 75ms at 1.75x */
521 TM_CFG_PERIOD(5, 175000000, 100); /* 175ms at 2x */
522 TM_CFG_PERIOD(6, 500000000, 200); /* 500ms at 3x */
523 TM_CFG_PERIOD(7, 3000000000, 300); /* 3s at 4x */
524 TM_CFG_PERIOD(8,30000000000, 400); /* 30s at 5x */
525 TM_CFG_PERIOD(9,55000000000, 500); /* 55s at 6x */
526 AssertCompile(RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods) == 10);
527#undef TM_CFG_PERIOD
528
529 /*
530 * Configure real world time (UTC).
531 */
532 /** @cfgm{/TM/UTCOffset, int64_t, ns, INT64_MIN, INT64_MAX, 0}
533 * The UTC offset. This is used to put the guest back or forwards in time. */
534 rc = CFGMR3QueryS64(pCfgHandle, "UTCOffset", &pVM->tm.s.offUTC);
535 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
536 pVM->tm.s.offUTC = 0; /* ns */
537 else if (RT_FAILURE(rc))
538 return VMSetError(pVM, rc, RT_SRC_POS,
539 N_("Configuration error: Failed to querying 64-bit integer value \"UTCOffset\""));
540
541 /*
542 * Setup the warp drive.
543 */
544 /** @cfgm{/TM/WarpDrivePercentage, uint32_t, %, 0, 20000, 100}
545 * The warp drive percentage, 100% is normal speed. This is used to speed up
546 * or slow down the virtual clock, which can be useful for fast forwarding
547 * borring periods during tests. */
548 rc = CFGMR3QueryU32(pCfgHandle, "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage);
549 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
550 rc = CFGMR3QueryU32(CFGMR3GetRoot(pVM), "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage); /* legacy */
551 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
552 pVM->tm.s.u32VirtualWarpDrivePercentage = 100;
553 else if (RT_FAILURE(rc))
554 return VMSetError(pVM, rc, RT_SRC_POS,
555 N_("Configuration error: Failed to querying uint32_t value \"WarpDrivePercent\""));
556 else if ( pVM->tm.s.u32VirtualWarpDrivePercentage < 2
557 || pVM->tm.s.u32VirtualWarpDrivePercentage > 20000)
558 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
559 N_("Configuration error: \"WarpDrivePercent\" = %RI32 is not in the range 2..20000"),
560 pVM->tm.s.u32VirtualWarpDrivePercentage);
561 pVM->tm.s.fVirtualWarpDrive = pVM->tm.s.u32VirtualWarpDrivePercentage != 100;
562 if (pVM->tm.s.fVirtualWarpDrive)
563 {
564 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
565 LogRel(("TM: Warp-drive active. u32VirtualWarpDrivePercentage=%RI32\n", pVM->tm.s.u32VirtualWarpDrivePercentage));
566 }
567
568 /*
569 * Gather the Host Hz configuration values.
570 */
571 rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzMax", &pVM->tm.s.cHostHzMax, 20000);
572 if (RT_FAILURE(rc))
573 return VMSetError(pVM, rc, RT_SRC_POS,
574 N_("Configuration error: Failed to querying uint32_t value \"HostHzMax\""));
575
576 rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorTimerCpu", &pVM->tm.s.cPctHostHzFudgeFactorTimerCpu, 111);
577 if (RT_FAILURE(rc))
578 return VMSetError(pVM, rc, RT_SRC_POS,
579 N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorTimerCpu\""));
580
581 rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorOtherCpu", &pVM->tm.s.cPctHostHzFudgeFactorOtherCpu, 110);
582 if (RT_FAILURE(rc))
583 return VMSetError(pVM, rc, RT_SRC_POS,
584 N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorOtherCpu\""));
585
586 rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorCatchUp100", &pVM->tm.s.cPctHostHzFudgeFactorCatchUp100, 300);
587 if (RT_FAILURE(rc))
588 return VMSetError(pVM, rc, RT_SRC_POS,
589 N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorCatchUp100\""));
590
591 rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorCatchUp200", &pVM->tm.s.cPctHostHzFudgeFactorCatchUp200, 250);
592 if (RT_FAILURE(rc))
593 return VMSetError(pVM, rc, RT_SRC_POS,
594 N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorCatchUp200\""));
595
596 rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorCatchUp400", &pVM->tm.s.cPctHostHzFudgeFactorCatchUp400, 200);
597 if (RT_FAILURE(rc))
598 return VMSetError(pVM, rc, RT_SRC_POS,
599 N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorCatchUp400\""));
600
601 /*
602 * Finally, setup and report.
603 */
604 pVM->tm.s.enmOriginalTSCMode = pVM->tm.s.enmTSCMode;
605 CPUMR3SetCR4Feature(pVM, X86_CR4_TSD, ~X86_CR4_TSD);
606 LogRel(("TM: cTSCTicksPerSecond=%'RU64 (%#RX64) enmTSCMode=%d (%s)\n"
607 "TM: TSCTiedToExecution=%RTbool TSCNotTiedToHalt=%RTbool\n",
608 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM),
609 pVM->tm.s.fTSCTiedToExecution, pVM->tm.s.fTSCNotTiedToHalt));
610
611 /*
612 * Start the timer (guard against REM not yielding).
613 */
614 /** @cfgm{/TM/TimerMillies, uint32_t, ms, 1, 1000, 10}
615 * The watchdog timer interval. */
616 uint32_t u32Millies;
617 rc = CFGMR3QueryU32(pCfgHandle, "TimerMillies", &u32Millies);
618 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
619 u32Millies = 10;
620 else if (RT_FAILURE(rc))
621 return VMSetError(pVM, rc, RT_SRC_POS,
622 N_("Configuration error: Failed to query uint32_t value \"TimerMillies\""));
623 rc = RTTimerCreate(&pVM->tm.s.pTimer, u32Millies, tmR3TimerCallback, pVM);
624 if (RT_FAILURE(rc))
625 {
626 AssertMsgFailed(("Failed to create timer, u32Millies=%d rc=%Rrc.\n", u32Millies, rc));
627 return rc;
628 }
629 Log(("TM: Created timer %p firing every %d milliseconds\n", pVM->tm.s.pTimer, u32Millies));
630 pVM->tm.s.u32TimerMillies = u32Millies;
631
632 /*
633 * Register saved state.
634 */
635 rc = SSMR3RegisterInternal(pVM, "tm", 1, TM_SAVED_STATE_VERSION, sizeof(uint64_t) * 8,
636 NULL, NULL, NULL,
637 NULL, tmR3Save, NULL,
638 NULL, tmR3Load, NULL);
639 if (RT_FAILURE(rc))
640 return rc;
641
642 /*
643 * Register statistics.
644 */
645 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).");
646 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).");
647 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).");
648 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).");
649 STAM_REL_REG_USED(pVM,(void*)&pVM->tm.s.VirtualGetRawDataRC.c1nsSteps,STAMTYPE_U32, "/TM/RC/1nsSteps", STAMUNIT_OCCURENCES, "Virtual time 1ns steps (due to TSC / GIP variations).");
650 STAM_REL_REG_USED(pVM,(void*)&pVM->tm.s.VirtualGetRawDataRC.cBadPrev, STAMTYPE_U32, "/TM/RC/cBadPrev", STAMUNIT_OCCURENCES, "Times the previous virtual time was considered erratic (shouldn't ever happen).");
651 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)");
652 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 attempted caught up with.");
653 STAM_REL_REG( pVM,(void*)&pVM->tm.s.uMaxHzHint, STAMTYPE_U32, "/TM/MaxHzHint", STAMUNIT_HZ, "Max guest timer frequency hint.");
654
655#ifdef VBOX_WITH_STATISTICS
656 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).");
657 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataR3.cUpdateRaces,STAMTYPE_U32, "/TM/R3/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
658 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).");
659 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataR0.cUpdateRaces,STAMTYPE_U32, "/TM/R0/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
660 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataRC.cExpired, STAMTYPE_U32, "/TM/RC/cExpired", STAMUNIT_OCCURENCES, "Times the TSC interval expired (overlaps 1ns steps).");
661 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataRC.cUpdateRaces,STAMTYPE_U32, "/TM/RC/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
662 STAM_REG(pVM, &pVM->tm.s.StatDoQueues, STAMTYPE_PROFILE, "/TM/DoQueues", STAMUNIT_TICKS_PER_CALL, "Profiling timer TMR3TimerQueuesDo.");
663 STAM_REG(pVM, &pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Virtual", STAMUNIT_TICKS_PER_CALL, "Time spent on the virtual clock queue.");
664 STAM_REG(pVM, &pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], STAMTYPE_PROFILE_ADV, "/TM/DoQueues/VirtualSync", STAMUNIT_TICKS_PER_CALL, "Time spent on the virtual sync clock queue.");
665 STAM_REG(pVM, &pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Real", STAMUNIT_TICKS_PER_CALL, "Time spent on the real clock queue.");
666
667 STAM_REG(pVM, &pVM->tm.s.StatPoll, STAMTYPE_COUNTER, "/TM/Poll", STAMUNIT_OCCURENCES, "TMTimerPoll calls.");
668 STAM_REG(pVM, &pVM->tm.s.StatPollAlreadySet, STAMTYPE_COUNTER, "/TM/Poll/AlreadySet", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the FF was already set.");
669 STAM_REG(pVM, &pVM->tm.s.StatPollELoop, STAMTYPE_COUNTER, "/TM/Poll/ELoop", STAMUNIT_OCCURENCES, "Times TMTimerPoll has given up getting a consistent virtual sync data set.");
670 STAM_REG(pVM, &pVM->tm.s.StatPollMiss, STAMTYPE_COUNTER, "/TM/Poll/Miss", STAMUNIT_OCCURENCES, "TMTimerPoll calls where nothing had expired.");
671 STAM_REG(pVM, &pVM->tm.s.StatPollRunning, STAMTYPE_COUNTER, "/TM/Poll/Running", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the queues were being run.");
672 STAM_REG(pVM, &pVM->tm.s.StatPollSimple, STAMTYPE_COUNTER, "/TM/Poll/Simple", STAMUNIT_OCCURENCES, "TMTimerPoll calls where we could take the simple path.");
673 STAM_REG(pVM, &pVM->tm.s.StatPollVirtual, STAMTYPE_COUNTER, "/TM/Poll/HitsVirtual", STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL queue.");
674 STAM_REG(pVM, &pVM->tm.s.StatPollVirtualSync, STAMTYPE_COUNTER, "/TM/Poll/HitsVirtualSync", STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL_SYNC queue.");
675
676 STAM_REG(pVM, &pVM->tm.s.StatPostponedR3, STAMTYPE_COUNTER, "/TM/PostponedR3", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-3.");
677 STAM_REG(pVM, &pVM->tm.s.StatPostponedRZ, STAMTYPE_COUNTER, "/TM/PostponedRZ", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-0 / RC.");
678
679 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.");
680 STAM_REG(pVM, &pVM->tm.s.StatScheduleOneRZ, STAMTYPE_PROFILE, "/TM/ScheduleOneRZ", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.");
681 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.");
682
683 STAM_REG(pVM, &pVM->tm.s.StatTimerSet, STAMTYPE_COUNTER, "/TM/TimerSet", STAMUNIT_OCCURENCES, "Calls, except virtual sync timers");
684 STAM_REG(pVM, &pVM->tm.s.StatTimerSetOpt, STAMTYPE_COUNTER, "/TM/TimerSet/Opt", STAMUNIT_OCCURENCES, "Optimized path taken.");
685 STAM_REG(pVM, &pVM->tm.s.StatTimerSetR3, STAMTYPE_PROFILE, "/TM/TimerSet/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3.");
686 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRZ, STAMTYPE_PROFILE, "/TM/TimerSet/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0 / RC.");
687 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStActive, STAMTYPE_COUNTER, "/TM/TimerSet/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
688 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSet/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
689 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStOther, STAMTYPE_COUNTER, "/TM/TimerSet/StOther", STAMUNIT_OCCURENCES, "Other states");
690 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendStop, STAMTYPE_COUNTER, "/TM/TimerSet/StPendStop", STAMUNIT_OCCURENCES, "PENDING_STOP");
691 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendStopSched, STAMTYPE_COUNTER, "/TM/TimerSet/StPendStopSched", STAMUNIT_OCCURENCES, "PENDING_STOP_SCHEDULE");
692 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendSched, STAMTYPE_COUNTER, "/TM/TimerSet/StPendSched", STAMUNIT_OCCURENCES, "PENDING_SCHEDULE");
693 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendResched, STAMTYPE_COUNTER, "/TM/TimerSet/StPendResched", STAMUNIT_OCCURENCES, "PENDING_RESCHEDULE");
694 STAM_REG(pVM, &pVM->tm.s.StatTimerSetStStopped, STAMTYPE_COUNTER, "/TM/TimerSet/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
695
696 STAM_REG(pVM, &pVM->tm.s.StatTimerSetVs, STAMTYPE_COUNTER, "/TM/TimerSetVs", STAMUNIT_OCCURENCES, "TMTimerSet calls on virtual sync timers");
697 STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsR3, STAMTYPE_PROFILE, "/TM/TimerSetVs/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3 on virtual sync timers.");
698 STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsRZ, STAMTYPE_PROFILE, "/TM/TimerSetVs/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0 / RC on virtual sync timers.");
699 STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsStActive, STAMTYPE_COUNTER, "/TM/TimerSetVs/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
700 STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSetVs/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
701 STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsStStopped, STAMTYPE_COUNTER, "/TM/TimerSetVs/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
702
703 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelative, STAMTYPE_COUNTER, "/TM/TimerSetRelative", STAMUNIT_OCCURENCES, "Calls, except virtual sync timers");
704 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeOpt, STAMTYPE_COUNTER, "/TM/TimerSetRelative/Opt", STAMUNIT_OCCURENCES, "Optimized path taken.");
705 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeR3, STAMTYPE_PROFILE, "/TM/TimerSetRelative/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetRelative calls made in ring-3 (sans virtual sync).");
706 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeRZ, STAMTYPE_PROFILE, "/TM/TimerSetRelative/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetReltaive calls made in ring-0 / RC (sans virtual sync).");
707 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStActive, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
708 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
709 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStOther, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StOther", STAMUNIT_OCCURENCES, "Other states");
710 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendStop, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendStop", STAMUNIT_OCCURENCES, "PENDING_STOP");
711 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendStopSched, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendStopSched",STAMUNIT_OCCURENCES, "PENDING_STOP_SCHEDULE");
712 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendSched, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendSched", STAMUNIT_OCCURENCES, "PENDING_SCHEDULE");
713 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendResched, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendResched", STAMUNIT_OCCURENCES, "PENDING_RESCHEDULE");
714 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStStopped, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
715
716 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVs, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs", STAMUNIT_OCCURENCES, "TMTimerSetRelative calls on virtual sync timers");
717 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsR3, STAMTYPE_PROFILE, "/TM/TimerSetRelativeVs/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetRelative calls made in ring-3 on virtual sync timers.");
718 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsRZ, STAMTYPE_PROFILE, "/TM/TimerSetRelativeVs/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetReltaive calls made in ring-0 / RC on virtual sync timers.");
719 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsStActive, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
720 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
721 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsStStopped, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
722
723 STAM_REG(pVM, &pVM->tm.s.StatTimerStopR3, STAMTYPE_PROFILE, "/TM/TimerStopR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-3.");
724 STAM_REG(pVM, &pVM->tm.s.StatTimerStopRZ, STAMTYPE_PROFILE, "/TM/TimerStopRZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-0 / RC.");
725
726 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.");
727 STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualGetSetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGet.");
728 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGet, STAMTYPE_COUNTER, "/TM/VirtualSyncGet", STAMUNIT_OCCURENCES, "The number of times tmVirtualSyncGetEx was called.");
729 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetAdjLast, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/AdjLast", STAMUNIT_OCCURENCES, "Times we've adjusted against the last returned time stamp .");
730 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetELoop, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/ELoop", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx has given up getting a consistent virtual sync data set.");
731 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetExpired, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Expired", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx encountered an expired timer stopping the clock.");
732 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetLocked, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Locked", STAMUNIT_OCCURENCES, "Times we successfully acquired the lock in tmVirtualSyncGetEx.");
733 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetLockless, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Lockless", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx returned without needing to take the lock.");
734 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/SetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling tmVirtualSyncGetEx.");
735 STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/VirtualPause", STAMUNIT_OCCURENCES, "The number of times TMR3TimerPause was called.");
736 STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/VirtualResume", STAMUNIT_OCCURENCES, "The number of times TMR3TimerResume was called.");
737
738 STAM_REG(pVM, &pVM->tm.s.StatTimerCallbackSetFF, STAMTYPE_COUNTER, "/TM/CallbackSetFF", STAMUNIT_OCCURENCES, "The number of times the timer callback set FF.");
739 STAM_REG(pVM, &pVM->tm.s.StatTimerCallback, STAMTYPE_COUNTER, "/TM/Callback", STAMUNIT_OCCURENCES, "The number of times the timer callback is invoked.");
740
741 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE010, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE010", STAMUNIT_OCCURENCES, "In catch-up mode, 10% or lower.");
742 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE025, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE025", STAMUNIT_OCCURENCES, "In catch-up mode, 25%-11%.");
743 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE100, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE100", STAMUNIT_OCCURENCES, "In catch-up mode, 100%-26%.");
744 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupOther, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupOther", STAMUNIT_OCCURENCES, "In catch-up mode, > 100%.");
745 STAM_REG(pVM, &pVM->tm.s.StatTSCNotFixed, STAMTYPE_COUNTER, "/TM/TSC/Intercept/NotFixed", STAMUNIT_OCCURENCES, "TSC is not fixed, it may run at variable speed.");
746 STAM_REG(pVM, &pVM->tm.s.StatTSCNotTicking, STAMTYPE_COUNTER, "/TM/TSC/Intercept/NotTicking", STAMUNIT_OCCURENCES, "TSC is not ticking.");
747 STAM_REG(pVM, &pVM->tm.s.StatTSCSyncNotTicking, STAMTYPE_COUNTER, "/TM/TSC/Intercept/SyncNotTicking", STAMUNIT_OCCURENCES, "VirtualSync isn't ticking.");
748 STAM_REG(pVM, &pVM->tm.s.StatTSCWarp, STAMTYPE_COUNTER, "/TM/TSC/Intercept/Warp", STAMUNIT_OCCURENCES, "Warpdrive is active.");
749 STAM_REG(pVM, &pVM->tm.s.StatTSCSet, STAMTYPE_COUNTER, "/TM/TSC/Sets", STAMUNIT_OCCURENCES, "Calls to TMCpuTickSet.");
750 STAM_REG(pVM, &pVM->tm.s.StatTSCUnderflow, STAMTYPE_COUNTER, "/TM/TSC/Underflow", STAMUNIT_OCCURENCES, "TSC underflow; corrected with last seen value .");
751 STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/TSC/Pause", STAMUNIT_OCCURENCES, "The number of times the TSC was paused.");
752 STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/TSC/Resume", STAMUNIT_OCCURENCES, "The number of times the TSC was resumed.");
753#endif /* VBOX_WITH_STATISTICS */
754
755 for (VMCPUID i = 0; i < pVM->cCpus; i++)
756 {
757 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.offTSCRawSrc, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS, "TSC offset relative the raw source", "/TM/TSC/offCPU%u", i);
758#ifndef VBOX_WITHOUT_NS_ACCOUNTING
759# if defined(VBOX_WITH_STATISTICS) || defined(VBOX_WITH_NS_ACCOUNTING_STATS)
760 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsTotal, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Resettable: Total CPU run time.", "/TM/CPU/%02u", i);
761 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsExecuting, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code.", "/TM/CPU/%02u/PrfExecuting", i);
762 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsExecLong, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code - long hauls.", "/TM/CPU/%02u/PrfExecLong", i);
763 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsExecShort, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code - short stretches.", "/TM/CPU/%02u/PrfExecShort", i);
764 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsExecTiny, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code - tiny bits.", "/TM/CPU/%02u/PrfExecTiny", i);
765 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsHalted, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent halted.", "/TM/CPU/%02u/PrfHalted", i);
766 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.StatNsOther, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent in the VMM or preempted.", "/TM/CPU/%02u/PrfOther", i);
767# endif
768 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.cNsTotal, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Total CPU run time.", "/TM/CPU/%02u/cNsTotal", i);
769 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.cNsExecuting, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Time spent executing guest code.", "/TM/CPU/%02u/cNsExecuting", i);
770 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.cNsHalted, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Time spent halted.", "/TM/CPU/%02u/cNsHalted", i);
771 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.cNsOther, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Time spent in the VMM or preempted.", "/TM/CPU/%02u/cNsOther", i);
772 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.cPeriodsExecuting, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Times executed guest code.", "/TM/CPU/%02u/cPeriodsExecuting", i);
773 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.cPeriodsHalted, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Times halted.", "/TM/CPU/%02u/cPeriodsHalted", i);
774 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.CpuLoad.cPctExecuting, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent executing guest code recently.", "/TM/CPU/%02u/pctExecuting", i);
775 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.CpuLoad.cPctHalted, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent halted recently.", "/TM/CPU/%02u/pctHalted", i);
776 STAMR3RegisterF(pVM, &pVM->aCpus[i].tm.s.CpuLoad.cPctOther, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent in the VMM or preempted recently.", "/TM/CPU/%02u/pctOther", i);
777#endif
778 }
779#ifndef VBOX_WITHOUT_NS_ACCOUNTING
780 STAMR3RegisterF(pVM, &pVM->tm.s.CpuLoad.cPctExecuting, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent executing guest code recently.", "/TM/CPU/pctExecuting");
781 STAMR3RegisterF(pVM, &pVM->tm.s.CpuLoad.cPctHalted, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent halted recently.", "/TM/CPU/pctHalted");
782 STAMR3RegisterF(pVM, &pVM->tm.s.CpuLoad.cPctOther, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent in the VMM or preempted recently.", "/TM/CPU/pctOther");
783#endif
784
785#ifdef VBOX_WITH_STATISTICS
786 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.");
787 STAM_REG(pVM, (void *)&pVM->tm.s.fVirtualSyncCatchUp, STAMTYPE_U8, "/TM/VirtualSync/CatchUpActive", STAMUNIT_NONE, "Catch-Up active indicator.");
788 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)");
789 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncFF, STAMTYPE_PROFILE, "/TM/VirtualSync/FF", STAMUNIT_TICKS_PER_OCCURENCE, "Time spent in TMR3VirtualSyncFF by all but the dedicate timer EMT.");
790 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGiveUp, STAMTYPE_COUNTER, "/TM/VirtualSync/GiveUp", STAMUNIT_OCCURENCES, "Times the catch-up was abandoned.");
791 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++.)");
792 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRun, STAMTYPE_COUNTER, "/TM/VirtualSync/Run", STAMUNIT_OCCURENCES, "Times the virtual sync timer queue was considered.");
793 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunRestart, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/Restarts", STAMUNIT_OCCURENCES, "Times the clock was restarted after a run.");
794 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.");
795 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunStoppedAlready, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/StoppedAlready", STAMUNIT_OCCURENCES, "Times the clock was already stopped elsewhere (TMVirtualSyncGet).");
796 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.)");
797 for (unsigned i = 0; i < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods); i++)
798 {
799 STAMR3RegisterF(pVM, &pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "The catch-up percentage.", "/TM/VirtualSync/Periods/%u", i);
800 STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupAdjust[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times adjusted to this period.", "/TM/VirtualSync/Periods/%u/Adjust", i);
801 STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupInitial[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times started in this period.", "/TM/VirtualSync/Periods/%u/Initial", i);
802 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);
803 }
804#endif /* VBOX_WITH_STATISTICS */
805
806 /*
807 * Register info handlers.
808 */
809 DBGFR3InfoRegisterInternalEx(pVM, "timers", "Dumps all timers. No arguments.", tmR3TimerInfo, DBGFINFO_FLAGS_RUN_ON_EMT);
810 DBGFR3InfoRegisterInternalEx(pVM, "activetimers", "Dumps active all timers. No arguments.", tmR3TimerInfoActive, DBGFINFO_FLAGS_RUN_ON_EMT);
811 DBGFR3InfoRegisterInternalEx(pVM, "clocks", "Display the time of the various clocks.", tmR3InfoClocks, DBGFINFO_FLAGS_RUN_ON_EMT);
812
813 return VINF_SUCCESS;
814}
815
816
817/**
818 * Checks if the host CPU has a fixed TSC frequency.
819 *
820 * @returns true if it has, false if it hasn't.
821 *
822 * @remarks This test doesn't bother with very old CPUs that don't do power
823 * management or any other stuff that might influence the TSC rate.
824 * This isn't currently relevant.
825 */
826static bool tmR3HasFixedTSC(PVM pVM)
827{
828 /*
829 * ASSUME that if the GIP is in invariant TSC mode, it's because the CPU
830 * actually has invariant TSC.
831 */
832 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
833 if (pGip->u32Mode == SUPGIPMODE_INVARIANT_TSC)
834 return true;
835
836 /*
837 * Go by features and model info from the CPUID instruction.
838 */
839 if (ASMHasCpuId())
840 {
841 uint32_t uEAX, uEBX, uECX, uEDX;
842
843 /*
844 * By feature. (Used to be AMD specific, intel seems to have picked it up.)
845 */
846 ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
847 if (uEAX >= 0x80000007 && ASMIsValidExtRange(uEAX))
848 {
849 ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
850 if ( (uEDX & X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR) /* TscInvariant */
851 && pGip->u32Mode != SUPGIPMODE_ASYNC_TSC) /* No fixed tsc if the gip timer is in async mode. */
852 return true;
853 }
854
855 /*
856 * By model.
857 */
858 if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_AMD)
859 {
860 /*
861 * AuthenticAMD - Check for APM support and that TscInvariant is set.
862 *
863 * This test isn't correct with respect to fixed/non-fixed TSC and
864 * older models, but this isn't relevant since the result is currently
865 * only used for making a decision on AMD-V models.
866 */
867#if 0 /* Promoted to generic */
868 ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
869 if (uEAX >= 0x80000007)
870 {
871 ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
872 if ( (uEDX & X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR) /* TscInvariant */
873 && ( pGip->u32Mode == SUPGIPMODE_SYNC_TSC /* No fixed tsc if the gip timer is in async mode. */
874 || pGip->u32Mode == SUPGIPMODE_INVARIANT_TSC))
875 return true;
876 }
877#endif
878 }
879 else if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_INTEL)
880 {
881 /*
882 * GenuineIntel - Check the model number.
883 *
884 * This test is lacking in the same way and for the same reasons
885 * as the AMD test above.
886 */
887 /** @todo use ASMGetCpuFamily() and ASMGetCpuModel() here. */
888 ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
889 unsigned uModel = (uEAX >> 4) & 0x0f;
890 unsigned uFamily = (uEAX >> 8) & 0x0f;
891 if (uFamily == 0x0f)
892 uFamily += (uEAX >> 20) & 0xff;
893 if (uFamily >= 0x06)
894 uModel += ((uEAX >> 16) & 0x0f) << 4;
895 if ( (uFamily == 0x0f /*P4*/ && uModel >= 0x03)
896 || (uFamily == 0x06 /*P2/P3*/ && uModel >= 0x0e))
897 return true;
898 }
899 else if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_VIA)
900 {
901 /*
902 * CentaurHauls - Check the model, family and stepping.
903 *
904 * This only checks for VIA CPU models Nano X2, Nano X3,
905 * Eden X2 and QuadCore.
906 */
907 /** @todo use ASMGetCpuFamily() and ASMGetCpuModel() here. */
908 ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
909 unsigned uStepping = (uEAX & 0x0f);
910 unsigned uModel = (uEAX >> 4) & 0x0f;
911 unsigned uFamily = (uEAX >> 8) & 0x0f;
912 if ( uFamily == 0x06
913 && uModel == 0x0f
914 && uStepping >= 0x0c
915 && uStepping <= 0x0f)
916 return true;
917 }
918 }
919 return false;
920}
921
922
923/**
924 * Calibrate the CPU tick.
925 *
926 * @returns Number of ticks per second.
927 */
928static uint64_t tmR3CalibrateTSC(void)
929{
930 uint64_t u64Hz;
931
932 /*
933 * Use GIP when available. Prefere the nominal one, no need to wait for it.
934 */
935 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
936 if (pGip)
937 {
938 u64Hz = pGip->u64CpuHz;
939 if (u64Hz < _1T && u64Hz > _1M)
940 return u64Hz;
941 AssertFailed(); /* This shouldn't happen. */
942
943 u64Hz = SUPGetCpuHzFromGip(pGip);
944 if (u64Hz < _1T && u64Hz > _1M)
945 return u64Hz;
946
947 AssertFailed(); /* This shouldn't happen. */
948 }
949 /* else: This should only happen in fake SUPLib mode, which we don't really support any more... */
950
951 /* Call this once first to make sure it's initialized. */
952 RTTimeNanoTS();
953
954 /*
955 * Yield the CPU to increase our chances of getting
956 * a correct value.
957 */
958 RTThreadYield(); /* Try avoid interruptions between TSC and NanoTS samplings. */
959 static const unsigned s_auSleep[5] = { 50, 30, 30, 40, 40 };
960 uint64_t au64Samples[5];
961 unsigned i;
962 for (i = 0; i < RT_ELEMENTS(au64Samples); i++)
963 {
964 RTMSINTERVAL cMillies;
965 int cTries = 5;
966 uint64_t u64Start = ASMReadTSC();
967 uint64_t u64End;
968 uint64_t StartTS = RTTimeNanoTS();
969 uint64_t EndTS;
970 do
971 {
972 RTThreadSleep(s_auSleep[i]);
973 u64End = ASMReadTSC();
974 EndTS = RTTimeNanoTS();
975 cMillies = (RTMSINTERVAL)((EndTS - StartTS + 500000) / 1000000);
976 } while ( cMillies == 0 /* the sleep may be interrupted... */
977 || (cMillies < 20 && --cTries > 0));
978 uint64_t u64Diff = u64End - u64Start;
979
980 au64Samples[i] = (u64Diff * 1000) / cMillies;
981 AssertMsg(cTries > 0, ("cMillies=%d i=%d\n", cMillies, i));
982 }
983
984 /*
985 * Discard the highest and lowest results and calculate the average.
986 */
987 unsigned iHigh = 0;
988 unsigned iLow = 0;
989 for (i = 1; i < RT_ELEMENTS(au64Samples); i++)
990 {
991 if (au64Samples[i] < au64Samples[iLow])
992 iLow = i;
993 if (au64Samples[i] > au64Samples[iHigh])
994 iHigh = i;
995 }
996 au64Samples[iLow] = 0;
997 au64Samples[iHigh] = 0;
998
999 u64Hz = au64Samples[0];
1000 for (i = 1; i < RT_ELEMENTS(au64Samples); i++)
1001 u64Hz += au64Samples[i];
1002 u64Hz /= RT_ELEMENTS(au64Samples) - 2;
1003
1004 return u64Hz;
1005}
1006
1007
1008/**
1009 * Finalizes the TM initialization.
1010 *
1011 * @returns VBox status code.
1012 * @param pVM The cross context VM structure.
1013 */
1014VMM_INT_DECL(int) TMR3InitFinalize(PVM pVM)
1015{
1016 int rc;
1017
1018 /*
1019 * Resolve symbols.
1020 */
1021 if (!HMIsEnabled(pVM))
1022 {
1023 rc = PDMR3LdrGetSymbolRC(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataRC.pfnBad);
1024 AssertRCReturn(rc, rc);
1025 rc = PDMR3LdrGetSymbolRC(pVM, NULL, "tmVirtualNanoTSBadCpuIndex", &pVM->tm.s.VirtualGetRawDataRC.pfnBadCpuIndex);
1026 AssertRCReturn(rc, rc);
1027 rc = PDMR3LdrGetSymbolRC(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataRC.pfnRediscover);
1028 AssertRCReturn(rc, rc);
1029 pVM->tm.s.pfnVirtualGetRawRC = pVM->tm.s.VirtualGetRawDataRC.pfnRediscover;
1030 }
1031
1032 rc = PDMR3LdrGetSymbolR0(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataR0.pfnBad);
1033 AssertRCReturn(rc, rc);
1034 rc = PDMR3LdrGetSymbolR0(pVM, NULL, "tmVirtualNanoTSBadCpuIndex", &pVM->tm.s.VirtualGetRawDataR0.pfnBadCpuIndex);
1035 AssertRCReturn(rc, rc);
1036 rc = PDMR3LdrGetSymbolR0(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataR0.pfnRediscover);
1037 AssertRCReturn(rc, rc);
1038 pVM->tm.s.pfnVirtualGetRawR0 = pVM->tm.s.VirtualGetRawDataR0.pfnRediscover;
1039
1040#ifndef VBOX_WITHOUT_NS_ACCOUNTING
1041 /*
1042 * Create a timer for refreshing the CPU load stats.
1043 */
1044 PTMTIMER pTimer;
1045 rc = TMR3TimerCreateInternal(pVM, TMCLOCK_REAL, tmR3CpuLoadTimer, NULL, "CPU Load Timer", &pTimer);
1046 if (RT_SUCCESS(rc))
1047 rc = TMTimerSetMillies(pTimer, 1000);
1048#endif
1049
1050 /*
1051 * GIM is now initialized. Determine if TSC mode switching is allowed (respecting CFGM override).
1052 */
1053 pVM->tm.s.fTSCModeSwitchAllowed &= tmR3HasFixedTSC(pVM) && GIMIsEnabled(pVM) && HMIsEnabled(pVM);
1054 LogRel(("TM: TMR3InitFinalize: fTSCModeSwitchAllowed=%RTbool\n", pVM->tm.s.fTSCModeSwitchAllowed));
1055 return rc;
1056}
1057
1058
1059/**
1060 * Applies relocations to data and code managed by this
1061 * component. This function will be called at init and
1062 * whenever the VMM need to relocate it self inside the GC.
1063 *
1064 * @param pVM The cross context VM structure.
1065 * @param offDelta Relocation delta relative to old location.
1066 */
1067VMM_INT_DECL(void) TMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
1068{
1069 LogFlow(("TMR3Relocate\n"));
1070
1071 pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pVM->tm.s.paTimerQueuesR3);
1072
1073 if (!HMIsEnabled(pVM))
1074 {
1075 pVM->tm.s.pvGIPRC = MMHyperR3ToRC(pVM, pVM->tm.s.pvGIPR3);
1076 pVM->tm.s.paTimerQueuesRC = MMHyperR3ToRC(pVM, pVM->tm.s.paTimerQueuesR3);
1077 pVM->tm.s.VirtualGetRawDataRC.pu64Prev += offDelta;
1078 pVM->tm.s.VirtualGetRawDataRC.pfnBad += offDelta;
1079 pVM->tm.s.VirtualGetRawDataRC.pfnBadCpuIndex += offDelta;
1080 pVM->tm.s.VirtualGetRawDataRC.pfnRediscover += offDelta;
1081 pVM->tm.s.pfnVirtualGetRawRC += offDelta;
1082 }
1083
1084 /*
1085 * Iterate the timers updating the pVMRC pointers.
1086 */
1087 for (PTMTIMER pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
1088 {
1089 pTimer->pVMRC = pVM->pVMRC;
1090 pTimer->pVMR0 = pVM->pVMR0;
1091 }
1092}
1093
1094
1095/**
1096 * Terminates the TM.
1097 *
1098 * Termination means cleaning up and freeing all resources,
1099 * the VM it self is at this point powered off or suspended.
1100 *
1101 * @returns VBox status code.
1102 * @param pVM The cross context VM structure.
1103 */
1104VMM_INT_DECL(int) TMR3Term(PVM pVM)
1105{
1106 AssertMsg(pVM->tm.s.offVM, ("bad init order!\n"));
1107 if (pVM->tm.s.pTimer)
1108 {
1109 int rc = RTTimerDestroy(pVM->tm.s.pTimer);
1110 AssertRC(rc);
1111 pVM->tm.s.pTimer = NULL;
1112 }
1113
1114 return VINF_SUCCESS;
1115}
1116
1117
1118/**
1119 * The VM is being reset.
1120 *
1121 * For the TM component this means that a rescheduling is preformed,
1122 * the FF is cleared and but without running the queues. We'll have to
1123 * check if this makes sense or not, but it seems like a good idea now....
1124 *
1125 * @param pVM The cross context VM structure.
1126 */
1127VMM_INT_DECL(void) TMR3Reset(PVM pVM)
1128{
1129 LogFlow(("TMR3Reset:\n"));
1130 VM_ASSERT_EMT(pVM);
1131 TM_LOCK_TIMERS(pVM);
1132
1133 /*
1134 * Abort any pending catch up.
1135 * This isn't perfect...
1136 */
1137 if (pVM->tm.s.fVirtualSyncCatchUp)
1138 {
1139 const uint64_t offVirtualNow = TMVirtualGetNoCheck(pVM);
1140 const uint64_t offVirtualSyncNow = TMVirtualSyncGetNoCheck(pVM);
1141 if (pVM->tm.s.fVirtualSyncCatchUp)
1142 {
1143 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
1144
1145 const uint64_t offOld = pVM->tm.s.offVirtualSyncGivenUp;
1146 const uint64_t offNew = offVirtualNow - offVirtualSyncNow;
1147 Assert(offOld <= offNew);
1148 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
1149 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSync, offNew);
1150 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
1151 LogRel(("TM: Aborting catch-up attempt on reset with a %'RU64 ns lag on reset; new total: %'RU64 ns\n", offNew - offOld, offNew));
1152 }
1153 }
1154
1155 /*
1156 * Process the queues.
1157 */
1158 for (int i = 0; i < TMCLOCK_MAX; i++)
1159 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[i]);
1160#ifdef VBOX_STRICT
1161 tmTimerQueuesSanityChecks(pVM, "TMR3Reset");
1162#endif
1163
1164 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1165 VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /** @todo FIXME: this isn't right. */
1166
1167 /*
1168 * Switch TM TSC mode back to the original mode after a reset for
1169 * paravirtualized guests that alter the TM TSC mode during operation.
1170 */
1171 if ( pVM->tm.s.fTSCModeSwitchAllowed
1172 && pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode)
1173 {
1174 VM_ASSERT_EMT0(pVM);
1175 tmR3CpuTickParavirtDisable(pVM, &pVM->aCpus[0], NULL /* pvData */);
1176 }
1177 Assert(!GIMIsParavirtTscEnabled(pVM));
1178 pVM->tm.s.fParavirtTscEnabled = false;
1179
1180 TM_UNLOCK_TIMERS(pVM);
1181}
1182
1183
1184/**
1185 * Resolve a builtin RC symbol.
1186 * Called by PDM when loading or relocating GC modules.
1187 *
1188 * @returns VBox status
1189 * @param pVM The cross context VM structure.
1190 * @param pszSymbol Symbol to resolve.
1191 * @param pRCPtrValue Where to store the symbol value.
1192 * @remark This has to work before TMR3Relocate() is called.
1193 */
1194VMM_INT_DECL(int) TMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue)
1195{
1196 if (!strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
1197 *pRCPtrValue = MMHyperR3ToRC(pVM, &pVM->tm.s.pvGIPRC);
1198 //else if (..)
1199 else
1200 return VERR_SYMBOL_NOT_FOUND;
1201 return VINF_SUCCESS;
1202}
1203
1204
1205/**
1206 * Execute state save operation.
1207 *
1208 * @returns VBox status code.
1209 * @param pVM The cross context VM structure.
1210 * @param pSSM SSM operation handle.
1211 */
1212static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM)
1213{
1214 LogFlow(("tmR3Save:\n"));
1215#ifdef VBOX_STRICT
1216 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1217 {
1218 PVMCPU pVCpu = &pVM->aCpus[i];
1219 Assert(!pVCpu->tm.s.fTSCTicking);
1220 }
1221 Assert(!pVM->tm.s.cVirtualTicking);
1222 Assert(!pVM->tm.s.fVirtualSyncTicking);
1223 Assert(!pVM->tm.s.cTSCsTicking);
1224#endif
1225
1226 /*
1227 * Save the virtual clocks.
1228 */
1229 /* the virtual clock. */
1230 SSMR3PutU64(pSSM, TMCLOCK_FREQ_VIRTUAL);
1231 SSMR3PutU64(pSSM, pVM->tm.s.u64Virtual);
1232
1233 /* the virtual timer synchronous clock. */
1234 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSync);
1235 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSync);
1236 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSyncGivenUp);
1237 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSyncCatchUpPrev);
1238 SSMR3PutBool(pSSM, pVM->tm.s.fVirtualSyncCatchUp);
1239
1240 /* real time clock */
1241 SSMR3PutU64(pSSM, TMCLOCK_FREQ_REAL);
1242
1243 /* the cpu tick clock. */
1244 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1245 {
1246 PVMCPU pVCpu = &pVM->aCpus[i];
1247 SSMR3PutU64(pSSM, TMCpuTickGet(pVCpu));
1248 }
1249 return SSMR3PutU64(pSSM, pVM->tm.s.cTSCTicksPerSecond);
1250}
1251
1252
1253/**
1254 * Execute state load operation.
1255 *
1256 * @returns VBox status code.
1257 * @param pVM The cross context VM structure.
1258 * @param pSSM SSM operation handle.
1259 * @param uVersion Data layout version.
1260 * @param uPass The data pass.
1261 */
1262static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1263{
1264 LogFlow(("tmR3Load:\n"));
1265
1266 Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
1267#ifdef VBOX_STRICT
1268 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1269 {
1270 PVMCPU pVCpu = &pVM->aCpus[i];
1271 Assert(!pVCpu->tm.s.fTSCTicking);
1272 }
1273 Assert(!pVM->tm.s.cVirtualTicking);
1274 Assert(!pVM->tm.s.fVirtualSyncTicking);
1275 Assert(!pVM->tm.s.cTSCsTicking);
1276#endif
1277
1278 /*
1279 * Validate version.
1280 */
1281 if (uVersion != TM_SAVED_STATE_VERSION)
1282 {
1283 AssertMsgFailed(("tmR3Load: Invalid version uVersion=%d!\n", uVersion));
1284 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1285 }
1286
1287 /*
1288 * Load the virtual clock.
1289 */
1290 pVM->tm.s.cVirtualTicking = 0;
1291 /* the virtual clock. */
1292 uint64_t u64Hz;
1293 int rc = SSMR3GetU64(pSSM, &u64Hz);
1294 if (RT_FAILURE(rc))
1295 return rc;
1296 if (u64Hz != TMCLOCK_FREQ_VIRTUAL)
1297 {
1298 AssertMsgFailed(("The virtual clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1299 u64Hz, TMCLOCK_FREQ_VIRTUAL));
1300 return VERR_SSM_VIRTUAL_CLOCK_HZ;
1301 }
1302 SSMR3GetU64(pSSM, &pVM->tm.s.u64Virtual);
1303 pVM->tm.s.u64VirtualOffset = 0;
1304
1305 /* the virtual timer synchronous clock. */
1306 pVM->tm.s.fVirtualSyncTicking = false;
1307 uint64_t u64;
1308 SSMR3GetU64(pSSM, &u64);
1309 pVM->tm.s.u64VirtualSync = u64;
1310 SSMR3GetU64(pSSM, &u64);
1311 pVM->tm.s.offVirtualSync = u64;
1312 SSMR3GetU64(pSSM, &u64);
1313 pVM->tm.s.offVirtualSyncGivenUp = u64;
1314 SSMR3GetU64(pSSM, &u64);
1315 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64;
1316 bool f;
1317 SSMR3GetBool(pSSM, &f);
1318 pVM->tm.s.fVirtualSyncCatchUp = f;
1319
1320 /* the real clock */
1321 rc = SSMR3GetU64(pSSM, &u64Hz);
1322 if (RT_FAILURE(rc))
1323 return rc;
1324 if (u64Hz != TMCLOCK_FREQ_REAL)
1325 {
1326 AssertMsgFailed(("The real clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1327 u64Hz, TMCLOCK_FREQ_REAL));
1328 return VERR_SSM_VIRTUAL_CLOCK_HZ; /* misleading... */
1329 }
1330
1331 /* the cpu tick clock. */
1332 pVM->tm.s.cTSCsTicking = 0;
1333 pVM->tm.s.offTSCPause = 0;
1334 pVM->tm.s.u64LastPausedTSC = 0;
1335 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1336 {
1337 PVMCPU pVCpu = &pVM->aCpus[i];
1338
1339 pVCpu->tm.s.fTSCTicking = false;
1340 SSMR3GetU64(pSSM, &pVCpu->tm.s.u64TSC);
1341 if (pVM->tm.s.u64LastPausedTSC < pVCpu->tm.s.u64TSC)
1342 pVM->tm.s.u64LastPausedTSC = pVCpu->tm.s.u64TSC;
1343
1344 if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1345 pVCpu->tm.s.offTSCRawSrc = 0; /** @todo TSC restore stuff and HWACC. */
1346 }
1347
1348 rc = SSMR3GetU64(pSSM, &u64Hz);
1349 if (RT_FAILURE(rc))
1350 return rc;
1351 if (pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET)
1352 pVM->tm.s.cTSCTicksPerSecond = u64Hz;
1353
1354 LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%'RU64) enmTSCMode=%d (%s) (state load)\n",
1355 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM)));
1356
1357 /* Disabled as this isn't tested, also should this apply only if GIM is enabled etc. */
1358#if 0
1359 /*
1360 * If the current host TSC frequency is incompatible with what is in the
1361 * saved state of the VM, fall back to emulating TSC and disallow TSC mode
1362 * switches during VM runtime (e.g. by GIM).
1363 */
1364 if ( GIMIsEnabled(pVM)
1365 || pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1366 {
1367 uint64_t uGipCpuHz;
1368 bool fRelax = RTSystemIsInsideVM();
1369 bool fCompat = SUPIsTscFreqCompatible(pVM->tm.s.cTSCTicksPerSecond, &uGipCpuHz, fRelax);
1370 if (!fCompat)
1371 {
1372 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
1373 pVM->tm.s.fTSCModeSwitchAllowed = false;
1374 if (g_pSUPGlobalInfoPage->u32Mode != SUPGIPMODE_ASYNC_TSC)
1375 {
1376 LogRel(("TM: TSC frequency incompatible! uGipCpuHz=%#RX64 (%'RU64) enmTSCMode=%d (%s) fTSCModeSwitchAllowed=%RTbool (state load)\n",
1377 uGipCpuHz, uGipCpuHz, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM), pVM->tm.s.fTSCModeSwitchAllowed));
1378 }
1379 else
1380 {
1381 LogRel(("TM: GIP is async, enmTSCMode=%d (%s) fTSCModeSwitchAllowed=%RTbool (state load)\n",
1382 uGipCpuHz, uGipCpuHz, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM), pVM->tm.s.fTSCModeSwitchAllowed));
1383 }
1384 }
1385 }
1386#endif
1387
1388 /*
1389 * Make sure timers get rescheduled immediately.
1390 */
1391 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1392 VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
1393
1394 return VINF_SUCCESS;
1395}
1396
1397
1398/**
1399 * Internal TMR3TimerCreate worker.
1400 *
1401 * @returns VBox status code.
1402 * @param pVM The cross context VM structure.
1403 * @param enmClock The timer clock.
1404 * @param pszDesc The timer description.
1405 * @param ppTimer Where to store the timer pointer on success.
1406 */
1407static int tmr3TimerCreate(PVM pVM, TMCLOCK enmClock, const char *pszDesc, PPTMTIMERR3 ppTimer)
1408{
1409 VM_ASSERT_EMT(pVM);
1410
1411 /*
1412 * Allocate the timer.
1413 */
1414 PTMTIMERR3 pTimer = NULL;
1415 if (pVM->tm.s.pFree && VM_IS_EMT(pVM))
1416 {
1417 pTimer = pVM->tm.s.pFree;
1418 pVM->tm.s.pFree = pTimer->pBigNext;
1419 Log3(("TM: Recycling timer %p, new free head %p.\n", pTimer, pTimer->pBigNext));
1420 }
1421
1422 if (!pTimer)
1423 {
1424 int rc = MMHyperAlloc(pVM, sizeof(*pTimer), 0, MM_TAG_TM, (void **)&pTimer);
1425 if (RT_FAILURE(rc))
1426 return rc;
1427 Log3(("TM: Allocated new timer %p\n", pTimer));
1428 }
1429
1430 /*
1431 * Initialize it.
1432 */
1433 pTimer->u64Expire = 0;
1434 pTimer->enmClock = enmClock;
1435 pTimer->pVMR3 = pVM;
1436 pTimer->pVMR0 = pVM->pVMR0;
1437 pTimer->pVMRC = pVM->pVMRC;
1438 pTimer->enmState = TMTIMERSTATE_STOPPED;
1439 pTimer->offScheduleNext = 0;
1440 pTimer->offNext = 0;
1441 pTimer->offPrev = 0;
1442 pTimer->pvUser = NULL;
1443 pTimer->pCritSect = NULL;
1444 pTimer->pszDesc = pszDesc;
1445
1446 /* insert into the list of created timers. */
1447 TM_LOCK_TIMERS(pVM);
1448 pTimer->pBigPrev = NULL;
1449 pTimer->pBigNext = pVM->tm.s.pCreated;
1450 pVM->tm.s.pCreated = pTimer;
1451 if (pTimer->pBigNext)
1452 pTimer->pBigNext->pBigPrev = pTimer;
1453#ifdef VBOX_STRICT
1454 tmTimerQueuesSanityChecks(pVM, "tmR3TimerCreate");
1455#endif
1456 TM_UNLOCK_TIMERS(pVM);
1457
1458 *ppTimer = pTimer;
1459 return VINF_SUCCESS;
1460}
1461
1462
1463/**
1464 * Creates a device timer.
1465 *
1466 * @returns VBox status code.
1467 * @param pVM The cross context VM structure.
1468 * @param pDevIns Device instance.
1469 * @param enmClock The clock to use on this timer.
1470 * @param pfnCallback Callback function.
1471 * @param pvUser The user argument to the callback.
1472 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
1473 * @param pszDesc Pointer to description string which must stay around
1474 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1475 * @param ppTimer Where to store the timer on success.
1476 */
1477VMM_INT_DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock,
1478 PFNTMTIMERDEV pfnCallback, void *pvUser,
1479 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1480{
1481 AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT)), VERR_INVALID_PARAMETER);
1482
1483 /*
1484 * Allocate and init stuff.
1485 */
1486 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1487 if (RT_SUCCESS(rc))
1488 {
1489 (*ppTimer)->enmType = TMTIMERTYPE_DEV;
1490 (*ppTimer)->u.Dev.pfnTimer = pfnCallback;
1491 (*ppTimer)->u.Dev.pDevIns = pDevIns;
1492 (*ppTimer)->pvUser = pvUser;
1493 if (!(fFlags & TMTIMER_FLAGS_NO_CRIT_SECT))
1494 (*ppTimer)->pCritSect = PDMR3DevGetCritSect(pVM, pDevIns);
1495 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1496 }
1497
1498 return rc;
1499}
1500
1501
1502
1503
1504/**
1505 * Creates a USB device timer.
1506 *
1507 * @returns VBox status code.
1508 * @param pVM The cross context VM structure.
1509 * @param pUsbIns The USB device instance.
1510 * @param enmClock The clock to use on this timer.
1511 * @param pfnCallback Callback function.
1512 * @param pvUser The user argument to the callback.
1513 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
1514 * @param pszDesc Pointer to description string which must stay around
1515 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1516 * @param ppTimer Where to store the timer on success.
1517 */
1518VMM_INT_DECL(int) TMR3TimerCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, TMCLOCK enmClock,
1519 PFNTMTIMERUSB pfnCallback, void *pvUser,
1520 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1521{
1522 AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT)), VERR_INVALID_PARAMETER);
1523
1524 /*
1525 * Allocate and init stuff.
1526 */
1527 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1528 if (RT_SUCCESS(rc))
1529 {
1530 (*ppTimer)->enmType = TMTIMERTYPE_USB;
1531 (*ppTimer)->u.Usb.pfnTimer = pfnCallback;
1532 (*ppTimer)->u.Usb.pUsbIns = pUsbIns;
1533 (*ppTimer)->pvUser = pvUser;
1534 //if (!(fFlags & TMTIMER_FLAGS_NO_CRIT_SECT))
1535 //{
1536 // if (pDevIns->pCritSectR3)
1537 // (*ppTimer)->pCritSect = pUsbIns->pCritSectR3;
1538 // else
1539 // (*ppTimer)->pCritSect = IOMR3GetCritSect(pVM);
1540 //}
1541 Log(("TM: Created USB device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1542 }
1543
1544 return rc;
1545}
1546
1547
1548/**
1549 * Creates a driver timer.
1550 *
1551 * @returns VBox status code.
1552 * @param pVM The cross context VM structure.
1553 * @param pDrvIns Driver instance.
1554 * @param enmClock The clock to use on this timer.
1555 * @param pfnCallback Callback function.
1556 * @param pvUser The user argument to the callback.
1557 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
1558 * @param pszDesc Pointer to description string which must stay around
1559 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1560 * @param ppTimer Where to store the timer on success.
1561 */
1562VMM_INT_DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1563 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1564{
1565 AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT)), VERR_INVALID_PARAMETER);
1566
1567 /*
1568 * Allocate and init stuff.
1569 */
1570 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1571 if (RT_SUCCESS(rc))
1572 {
1573 (*ppTimer)->enmType = TMTIMERTYPE_DRV;
1574 (*ppTimer)->u.Drv.pfnTimer = pfnCallback;
1575 (*ppTimer)->u.Drv.pDrvIns = pDrvIns;
1576 (*ppTimer)->pvUser = pvUser;
1577 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1578 }
1579
1580 return rc;
1581}
1582
1583
1584/**
1585 * Creates an internal timer.
1586 *
1587 * @returns VBox status code.
1588 * @param pVM The cross context VM structure.
1589 * @param enmClock The clock to use on this timer.
1590 * @param pfnCallback Callback function.
1591 * @param pvUser User argument to be passed to the callback.
1592 * @param pszDesc Pointer to description string which must stay around
1593 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1594 * @param ppTimer Where to store the timer on success.
1595 */
1596VMMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer)
1597{
1598 /*
1599 * Allocate and init stuff.
1600 */
1601 PTMTIMER pTimer;
1602 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1603 if (RT_SUCCESS(rc))
1604 {
1605 pTimer->enmType = TMTIMERTYPE_INTERNAL;
1606 pTimer->u.Internal.pfnTimer = pfnCallback;
1607 pTimer->pvUser = pvUser;
1608 *ppTimer = pTimer;
1609 Log(("TM: Created internal timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1610 }
1611
1612 return rc;
1613}
1614
1615/**
1616 * Creates an external timer.
1617 *
1618 * @returns Timer handle on success.
1619 * @returns NULL on failure.
1620 * @param pVM The cross context VM structure.
1621 * @param enmClock The clock to use on this timer.
1622 * @param pfnCallback Callback function.
1623 * @param pvUser User argument.
1624 * @param pszDesc Pointer to description string which must stay around
1625 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1626 */
1627VMMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc)
1628{
1629 /*
1630 * Allocate and init stuff.
1631 */
1632 PTMTIMERR3 pTimer;
1633 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1634 if (RT_SUCCESS(rc))
1635 {
1636 pTimer->enmType = TMTIMERTYPE_EXTERNAL;
1637 pTimer->u.External.pfnTimer = pfnCallback;
1638 pTimer->pvUser = pvUser;
1639 Log(("TM: Created external timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1640 return pTimer;
1641 }
1642
1643 return NULL;
1644}
1645
1646
1647/**
1648 * Destroy a timer
1649 *
1650 * @returns VBox status code.
1651 * @param pTimer Timer handle as returned by one of the create functions.
1652 */
1653VMMR3DECL(int) TMR3TimerDestroy(PTMTIMER pTimer)
1654{
1655 /*
1656 * Be extra careful here.
1657 */
1658 if (!pTimer)
1659 return VINF_SUCCESS;
1660 AssertPtr(pTimer);
1661 Assert((unsigned)pTimer->enmClock < (unsigned)TMCLOCK_MAX);
1662
1663 PVM pVM = pTimer->CTX_SUFF(pVM);
1664 PTMTIMERQUEUE pQueue = &pVM->tm.s.CTX_SUFF(paTimerQueues)[pTimer->enmClock];
1665 bool fActive = false;
1666 bool fPending = false;
1667
1668 AssertMsg( !pTimer->pCritSect
1669 || VMR3GetState(pVM) != VMSTATE_RUNNING
1670 || PDMCritSectIsOwner(pTimer->pCritSect), ("%s\n", pTimer->pszDesc));
1671
1672 /*
1673 * The rest of the game happens behind the lock, just
1674 * like create does. All the work is done here.
1675 */
1676 TM_LOCK_TIMERS(pVM);
1677 for (int cRetries = 1000;; cRetries--)
1678 {
1679 /*
1680 * Change to the DESTROY state.
1681 */
1682 TMTIMERSTATE const enmState = pTimer->enmState;
1683 Log2(("TMTimerDestroy: %p:{.enmState=%s, .pszDesc='%s'} cRetries=%d\n",
1684 pTimer, tmTimerState(enmState), R3STRING(pTimer->pszDesc), cRetries));
1685 switch (enmState)
1686 {
1687 case TMTIMERSTATE_STOPPED:
1688 case TMTIMERSTATE_EXPIRED_DELIVER:
1689 break;
1690
1691 case TMTIMERSTATE_ACTIVE:
1692 fActive = true;
1693 break;
1694
1695 case TMTIMERSTATE_PENDING_STOP:
1696 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
1697 case TMTIMERSTATE_PENDING_RESCHEDULE:
1698 fActive = true;
1699 fPending = true;
1700 break;
1701
1702 case TMTIMERSTATE_PENDING_SCHEDULE:
1703 fPending = true;
1704 break;
1705
1706 /*
1707 * This shouldn't happen as the caller should make sure there are no races.
1708 */
1709 case TMTIMERSTATE_EXPIRED_GET_UNLINK:
1710 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
1711 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
1712 AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1713 TM_UNLOCK_TIMERS(pVM);
1714 if (!RTThreadYield())
1715 RTThreadSleep(1);
1716 AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1717 VERR_TM_UNSTABLE_STATE);
1718 TM_LOCK_TIMERS(pVM);
1719 continue;
1720
1721 /*
1722 * Invalid states.
1723 */
1724 case TMTIMERSTATE_FREE:
1725 case TMTIMERSTATE_DESTROY:
1726 TM_UNLOCK_TIMERS(pVM);
1727 AssertLogRelMsgFailedReturn(("pTimer=%p %s\n", pTimer, tmTimerState(enmState)), VERR_TM_INVALID_STATE);
1728
1729 default:
1730 AssertMsgFailed(("Unknown timer state %d (%s)\n", enmState, R3STRING(pTimer->pszDesc)));
1731 TM_UNLOCK_TIMERS(pVM);
1732 return VERR_TM_UNKNOWN_STATE;
1733 }
1734
1735 /*
1736 * Try switch to the destroy state.
1737 * This should always succeed as the caller should make sure there are no race.
1738 */
1739 bool fRc;
1740 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_DESTROY, enmState, fRc);
1741 if (fRc)
1742 break;
1743 AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1744 TM_UNLOCK_TIMERS(pVM);
1745 AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1746 VERR_TM_UNSTABLE_STATE);
1747 TM_LOCK_TIMERS(pVM);
1748 }
1749
1750 /*
1751 * Unlink from the active list.
1752 */
1753 if (fActive)
1754 {
1755 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1756 const PTMTIMER pNext = TMTIMER_GET_NEXT(pTimer);
1757 if (pPrev)
1758 TMTIMER_SET_NEXT(pPrev, pNext);
1759 else
1760 {
1761 TMTIMER_SET_HEAD(pQueue, pNext);
1762 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1763 }
1764 if (pNext)
1765 TMTIMER_SET_PREV(pNext, pPrev);
1766 pTimer->offNext = 0;
1767 pTimer->offPrev = 0;
1768 }
1769
1770 /*
1771 * Unlink from the schedule list by running it.
1772 */
1773 if (fPending)
1774 {
1775 Log3(("TMR3TimerDestroy: tmTimerQueueSchedule\n"));
1776 STAM_PROFILE_START(&pVM->tm.s.CTX_SUFF_Z(StatScheduleOne), a);
1777 Assert(pQueue->offSchedule);
1778 tmTimerQueueSchedule(pVM, pQueue);
1779 STAM_PROFILE_STOP(&pVM->tm.s.CTX_SUFF_Z(StatScheduleOne), a);
1780 }
1781
1782 /*
1783 * Read to move the timer from the created list and onto the free list.
1784 */
1785 Assert(!pTimer->offNext); Assert(!pTimer->offPrev); Assert(!pTimer->offScheduleNext);
1786
1787 /* unlink from created list */
1788 if (pTimer->pBigPrev)
1789 pTimer->pBigPrev->pBigNext = pTimer->pBigNext;
1790 else
1791 pVM->tm.s.pCreated = pTimer->pBigNext;
1792 if (pTimer->pBigNext)
1793 pTimer->pBigNext->pBigPrev = pTimer->pBigPrev;
1794 pTimer->pBigNext = 0;
1795 pTimer->pBigPrev = 0;
1796
1797 /* free */
1798 Log2(("TM: Inserting %p into the free list ahead of %p!\n", pTimer, pVM->tm.s.pFree));
1799 TM_SET_STATE(pTimer, TMTIMERSTATE_FREE);
1800 pTimer->pBigNext = pVM->tm.s.pFree;
1801 pVM->tm.s.pFree = pTimer;
1802
1803#ifdef VBOX_STRICT
1804 tmTimerQueuesSanityChecks(pVM, "TMR3TimerDestroy");
1805#endif
1806 TM_UNLOCK_TIMERS(pVM);
1807 return VINF_SUCCESS;
1808}
1809
1810
1811/**
1812 * Destroy all timers owned by a device.
1813 *
1814 * @returns VBox status code.
1815 * @param pVM The cross context VM structure.
1816 * @param pDevIns Device which timers should be destroyed.
1817 */
1818VMM_INT_DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns)
1819{
1820 LogFlow(("TMR3TimerDestroyDevice: pDevIns=%p\n", pDevIns));
1821 if (!pDevIns)
1822 return VERR_INVALID_PARAMETER;
1823
1824 TM_LOCK_TIMERS(pVM);
1825 PTMTIMER pCur = pVM->tm.s.pCreated;
1826 while (pCur)
1827 {
1828 PTMTIMER pDestroy = pCur;
1829 pCur = pDestroy->pBigNext;
1830 if ( pDestroy->enmType == TMTIMERTYPE_DEV
1831 && pDestroy->u.Dev.pDevIns == pDevIns)
1832 {
1833 int rc = TMR3TimerDestroy(pDestroy);
1834 AssertRC(rc);
1835 }
1836 }
1837 TM_UNLOCK_TIMERS(pVM);
1838
1839 LogFlow(("TMR3TimerDestroyDevice: returns VINF_SUCCESS\n"));
1840 return VINF_SUCCESS;
1841}
1842
1843
1844/**
1845 * Destroy all timers owned by a USB device.
1846 *
1847 * @returns VBox status code.
1848 * @param pVM The cross context VM structure.
1849 * @param pUsbIns USB device which timers should be destroyed.
1850 */
1851VMM_INT_DECL(int) TMR3TimerDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns)
1852{
1853 LogFlow(("TMR3TimerDestroyUsb: pUsbIns=%p\n", pUsbIns));
1854 if (!pUsbIns)
1855 return VERR_INVALID_PARAMETER;
1856
1857 TM_LOCK_TIMERS(pVM);
1858 PTMTIMER pCur = pVM->tm.s.pCreated;
1859 while (pCur)
1860 {
1861 PTMTIMER pDestroy = pCur;
1862 pCur = pDestroy->pBigNext;
1863 if ( pDestroy->enmType == TMTIMERTYPE_USB
1864 && pDestroy->u.Usb.pUsbIns == pUsbIns)
1865 {
1866 int rc = TMR3TimerDestroy(pDestroy);
1867 AssertRC(rc);
1868 }
1869 }
1870 TM_UNLOCK_TIMERS(pVM);
1871
1872 LogFlow(("TMR3TimerDestroyUsb: returns VINF_SUCCESS\n"));
1873 return VINF_SUCCESS;
1874}
1875
1876
1877/**
1878 * Destroy all timers owned by a driver.
1879 *
1880 * @returns VBox status code.
1881 * @param pVM The cross context VM structure.
1882 * @param pDrvIns Driver which timers should be destroyed.
1883 */
1884VMM_INT_DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns)
1885{
1886 LogFlow(("TMR3TimerDestroyDriver: pDrvIns=%p\n", pDrvIns));
1887 if (!pDrvIns)
1888 return VERR_INVALID_PARAMETER;
1889
1890 TM_LOCK_TIMERS(pVM);
1891 PTMTIMER pCur = pVM->tm.s.pCreated;
1892 while (pCur)
1893 {
1894 PTMTIMER pDestroy = pCur;
1895 pCur = pDestroy->pBigNext;
1896 if ( pDestroy->enmType == TMTIMERTYPE_DRV
1897 && pDestroy->u.Drv.pDrvIns == pDrvIns)
1898 {
1899 int rc = TMR3TimerDestroy(pDestroy);
1900 AssertRC(rc);
1901 }
1902 }
1903 TM_UNLOCK_TIMERS(pVM);
1904
1905 LogFlow(("TMR3TimerDestroyDriver: returns VINF_SUCCESS\n"));
1906 return VINF_SUCCESS;
1907}
1908
1909
1910/**
1911 * Internal function for getting the clock time.
1912 *
1913 * @returns clock time.
1914 * @param pVM The cross context VM structure.
1915 * @param enmClock The clock.
1916 */
1917DECLINLINE(uint64_t) tmClock(PVM pVM, TMCLOCK enmClock)
1918{
1919 switch (enmClock)
1920 {
1921 case TMCLOCK_VIRTUAL: return TMVirtualGet(pVM);
1922 case TMCLOCK_VIRTUAL_SYNC: return TMVirtualSyncGet(pVM);
1923 case TMCLOCK_REAL: return TMRealGet(pVM);
1924 case TMCLOCK_TSC: return TMCpuTickGet(&pVM->aCpus[0] /* just take VCPU 0 */);
1925 default:
1926 AssertMsgFailed(("enmClock=%d\n", enmClock));
1927 return ~(uint64_t)0;
1928 }
1929}
1930
1931
1932/**
1933 * Checks if the sync queue has one or more expired timers.
1934 *
1935 * @returns true / false.
1936 *
1937 * @param pVM The cross context VM structure.
1938 * @param enmClock The queue.
1939 */
1940DECLINLINE(bool) tmR3HasExpiredTimer(PVM pVM, TMCLOCK enmClock)
1941{
1942 const uint64_t u64Expire = pVM->tm.s.CTX_SUFF(paTimerQueues)[enmClock].u64Expire;
1943 return u64Expire != INT64_MAX && u64Expire <= tmClock(pVM, enmClock);
1944}
1945
1946
1947/**
1948 * Checks for expired timers in all the queues.
1949 *
1950 * @returns true / false.
1951 * @param pVM The cross context VM structure.
1952 */
1953DECLINLINE(bool) tmR3AnyExpiredTimers(PVM pVM)
1954{
1955 /*
1956 * Combine the time calculation for the first two since we're not on EMT
1957 * TMVirtualSyncGet only permits EMT.
1958 */
1959 uint64_t u64Now = TMVirtualGetNoCheck(pVM);
1960 if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL].u64Expire <= u64Now)
1961 return true;
1962 u64Now = pVM->tm.s.fVirtualSyncTicking
1963 ? u64Now - pVM->tm.s.offVirtualSync
1964 : pVM->tm.s.u64VirtualSync;
1965 if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL_SYNC].u64Expire <= u64Now)
1966 return true;
1967
1968 /*
1969 * The remaining timers.
1970 */
1971 if (tmR3HasExpiredTimer(pVM, TMCLOCK_REAL))
1972 return true;
1973 if (tmR3HasExpiredTimer(pVM, TMCLOCK_TSC))
1974 return true;
1975 return false;
1976}
1977
1978
1979/**
1980 * Schedule timer callback.
1981 *
1982 * @param pTimer Timer handle.
1983 * @param pvUser Pointer to the VM.
1984 * @thread Timer thread.
1985 *
1986 * @remark We cannot do the scheduling and queues running from a timer handler
1987 * since it's not executing in EMT, and even if it was it would be async
1988 * and we wouldn't know the state of the affairs.
1989 * So, we'll just raise the timer FF and force any REM execution to exit.
1990 */
1991static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t /*iTick*/)
1992{
1993 PVM pVM = (PVM)pvUser;
1994 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1995 NOREF(pTimer);
1996
1997 AssertCompile(TMCLOCK_MAX == 4);
1998 STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallback);
1999
2000#ifdef DEBUG_Sander /* very annoying, keep it private. */
2001 if (VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER))
2002 Log(("tmR3TimerCallback: timer event still pending!!\n"));
2003#endif
2004 if ( !VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER)
2005 && ( pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule /** @todo FIXME - reconsider offSchedule as a reason for running the timer queues. */
2006 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule
2007 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule
2008 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offSchedule
2009 || tmR3AnyExpiredTimers(pVM)
2010 )
2011 && !VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER)
2012 && !pVM->tm.s.fRunningQueues
2013 )
2014 {
2015 Log5(("TM(%u): FF: 0 -> 1\n", __LINE__));
2016 VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
2017#ifdef VBOX_WITH_REM
2018 REMR3NotifyTimerPending(pVM, pVCpuDst);
2019#endif
2020 VMR3NotifyCpuFFU(pVCpuDst->pUVCpu, VMNOTIFYFF_FLAGS_DONE_REM | VMNOTIFYFF_FLAGS_POKE);
2021 STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallbackSetFF);
2022 }
2023}
2024
2025
2026/**
2027 * Schedules and runs any pending timers.
2028 *
2029 * This is normally called from a forced action handler in EMT.
2030 *
2031 * @param pVM The cross context VM structure.
2032 *
2033 * @thread EMT (actually EMT0, but we fend off the others)
2034 */
2035VMMR3DECL(void) TMR3TimerQueuesDo(PVM pVM)
2036{
2037 /*
2038 * Only the dedicated timer EMT should do stuff here.
2039 * (fRunningQueues is only used as an indicator.)
2040 */
2041 Assert(pVM->tm.s.idTimerCpu < pVM->cCpus);
2042 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
2043 if (VMMGetCpu(pVM) != pVCpuDst)
2044 {
2045 Assert(pVM->cCpus > 1);
2046 return;
2047 }
2048 STAM_PROFILE_START(&pVM->tm.s.StatDoQueues, a);
2049 Log2(("TMR3TimerQueuesDo:\n"));
2050 Assert(!pVM->tm.s.fRunningQueues);
2051 ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, true);
2052 TM_LOCK_TIMERS(pVM);
2053
2054 /*
2055 * Process the queues.
2056 */
2057 AssertCompile(TMCLOCK_MAX == 4);
2058
2059 /* TMCLOCK_VIRTUAL_SYNC (see also TMR3VirtualSyncFF) */
2060 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
2061 PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2062 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2063 VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /* Clear the FF once we started working for real. */
2064
2065 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule);
2066 tmR3TimerQueueRunVirtualSync(pVM);
2067 if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2068 VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2069
2070 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2071 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2072 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
2073
2074 /* TMCLOCK_VIRTUAL */
2075 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
2076 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule)
2077 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
2078 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
2079 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
2080
2081 /* TMCLOCK_TSC */
2082 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offActive); /* not used */
2083
2084 /* TMCLOCK_REAL */
2085 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
2086 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule)
2087 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
2088 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
2089 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
2090
2091#ifdef VBOX_STRICT
2092 /* check that we didn't screw up. */
2093 tmTimerQueuesSanityChecks(pVM, "TMR3TimerQueuesDo");
2094#endif
2095
2096 /* done */
2097 Log2(("TMR3TimerQueuesDo: returns void\n"));
2098 ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, false);
2099 TM_UNLOCK_TIMERS(pVM);
2100 STAM_PROFILE_STOP(&pVM->tm.s.StatDoQueues, a);
2101}
2102
2103//RT_C_DECLS_BEGIN
2104//int iomLock(PVM pVM);
2105//void iomUnlock(PVM pVM);
2106//RT_C_DECLS_END
2107
2108
2109/**
2110 * Schedules and runs any pending times in the specified queue.
2111 *
2112 * This is normally called from a forced action handler in EMT.
2113 *
2114 * @param pVM The cross context VM structure.
2115 * @param pQueue The queue to run.
2116 */
2117static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue)
2118{
2119 VM_ASSERT_EMT(pVM);
2120
2121 /*
2122 * Run timers.
2123 *
2124 * We check the clock once and run all timers which are ACTIVE
2125 * and have an expire time less or equal to the time we read.
2126 *
2127 * N.B. A generic unlink must be applied since other threads
2128 * are allowed to mess with any active timer at any time.
2129 * However, we only allow EMT to handle EXPIRED_PENDING
2130 * timers, thus enabling the timer handler function to
2131 * arm the timer again.
2132 */
2133 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
2134 if (!pNext)
2135 return;
2136 const uint64_t u64Now = tmClock(pVM, pQueue->enmClock);
2137 while (pNext && pNext->u64Expire <= u64Now)
2138 {
2139 PTMTIMER pTimer = pNext;
2140 pNext = TMTIMER_GET_NEXT(pTimer);
2141 PPDMCRITSECT pCritSect = pTimer->pCritSect;
2142 if (pCritSect)
2143 PDMCritSectEnter(pCritSect, VERR_IGNORED);
2144 Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
2145 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
2146 bool fRc;
2147 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_GET_UNLINK, TMTIMERSTATE_ACTIVE, fRc);
2148 if (fRc)
2149 {
2150 Assert(!pTimer->offScheduleNext); /* this can trigger falsely */
2151
2152 /* unlink */
2153 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
2154 if (pPrev)
2155 TMTIMER_SET_NEXT(pPrev, pNext);
2156 else
2157 {
2158 TMTIMER_SET_HEAD(pQueue, pNext);
2159 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
2160 }
2161 if (pNext)
2162 TMTIMER_SET_PREV(pNext, pPrev);
2163 pTimer->offNext = 0;
2164 pTimer->offPrev = 0;
2165
2166 /* fire */
2167 TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2168 switch (pTimer->enmType)
2169 {
2170 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer, pTimer->pvUser); break;
2171 case TMTIMERTYPE_USB: pTimer->u.Usb.pfnTimer(pTimer->u.Usb.pUsbIns, pTimer, pTimer->pvUser); break;
2172 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer, pTimer->pvUser); break;
2173 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->pvUser); break;
2174 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->pvUser); break;
2175 default:
2176 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2177 break;
2178 }
2179
2180 /* change the state if it wasn't changed already in the handler. */
2181 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2182 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2183 }
2184 if (pCritSect)
2185 PDMCritSectLeave(pCritSect);
2186 } /* run loop */
2187}
2188
2189
2190/**
2191 * Schedules and runs any pending times in the timer queue for the
2192 * synchronous virtual clock.
2193 *
2194 * This scheduling is a bit different from the other queues as it need
2195 * to implement the special requirements of the timer synchronous virtual
2196 * clock, thus this 2nd queue run function.
2197 *
2198 * @param pVM The cross context VM structure.
2199 *
2200 * @remarks The caller must the Virtual Sync lock. Owning the TM lock is no
2201 * longer important.
2202 */
2203static void tmR3TimerQueueRunVirtualSync(PVM pVM)
2204{
2205 PTMTIMERQUEUE const pQueue = &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC];
2206 VM_ASSERT_EMT(pVM);
2207 Assert(PDMCritSectIsOwner(&pVM->tm.s.VirtualSyncLock));
2208
2209 /*
2210 * Any timers?
2211 */
2212 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
2213 if (RT_UNLIKELY(!pNext))
2214 {
2215 Assert(pVM->tm.s.fVirtualSyncTicking || !pVM->tm.s.cVirtualTicking);
2216 return;
2217 }
2218 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRun);
2219
2220 /*
2221 * Calculate the time frame for which we will dispatch timers.
2222 *
2223 * We use a time frame ranging from the current sync time (which is most likely the
2224 * same as the head timer) and some configurable period (100000ns) up towards the
2225 * current virtual time. This period might also need to be restricted by the catch-up
2226 * rate so frequent calls to this function won't accelerate the time too much, however
2227 * this will be implemented at a later point if necessary.
2228 *
2229 * Without this frame we would 1) having to run timers much more frequently
2230 * and 2) lag behind at a steady rate.
2231 */
2232 const uint64_t u64VirtualNow = TMVirtualGetNoCheck(pVM);
2233 uint64_t const offSyncGivenUp = pVM->tm.s.offVirtualSyncGivenUp;
2234 uint64_t u64Now;
2235 if (!pVM->tm.s.fVirtualSyncTicking)
2236 {
2237 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStoppedAlready);
2238 u64Now = pVM->tm.s.u64VirtualSync;
2239 Assert(u64Now <= pNext->u64Expire);
2240 }
2241 else
2242 {
2243 /* Calc 'now'. */
2244 bool fStopCatchup = false;
2245 bool fUpdateStuff = false;
2246 uint64_t off = pVM->tm.s.offVirtualSync;
2247 if (pVM->tm.s.fVirtualSyncCatchUp)
2248 {
2249 uint64_t u64Delta = u64VirtualNow - pVM->tm.s.u64VirtualSyncCatchUpPrev;
2250 if (RT_LIKELY(!(u64Delta >> 32)))
2251 {
2252 uint64_t u64Sub = ASMMultU64ByU32DivByU32(u64Delta, pVM->tm.s.u32VirtualSyncCatchUpPercentage, 100);
2253 if (off > u64Sub + offSyncGivenUp)
2254 {
2255 off -= u64Sub;
2256 Log4(("TM: %'RU64/-%'8RU64: sub %'RU64 [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow - off, off - offSyncGivenUp, u64Sub));
2257 }
2258 else
2259 {
2260 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2261 fStopCatchup = true;
2262 off = offSyncGivenUp;
2263 }
2264 fUpdateStuff = true;
2265 }
2266 }
2267 u64Now = u64VirtualNow - off;
2268
2269 /* Adjust against last returned time. */
2270 uint64_t u64Last = ASMAtomicUoReadU64(&pVM->tm.s.u64VirtualSync);
2271 if (u64Last > u64Now)
2272 {
2273 u64Now = u64Last + 1;
2274 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGetAdjLast);
2275 }
2276
2277 /* Check if stopped by expired timer. */
2278 uint64_t const u64Expire = pNext->u64Expire;
2279 if (u64Now >= u64Expire)
2280 {
2281 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStop);
2282 u64Now = u64Expire;
2283 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2284 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
2285 Log4(("TM: %'RU64/-%'8RU64: exp tmr [tmR3TimerQueueRunVirtualSync]\n", u64Now, u64VirtualNow - u64Now - offSyncGivenUp));
2286 }
2287 else
2288 {
2289 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2290 if (fUpdateStuff)
2291 {
2292 ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, off);
2293 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSyncCatchUpPrev, u64VirtualNow);
2294 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2295 if (fStopCatchup)
2296 {
2297 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2298 Log4(("TM: %'RU64/0: caught up [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow));
2299 }
2300 }
2301 }
2302 }
2303
2304 /* calc end of frame. */
2305 uint64_t u64Max = u64Now + pVM->tm.s.u32VirtualSyncScheduleSlack;
2306 if (u64Max > u64VirtualNow - offSyncGivenUp)
2307 u64Max = u64VirtualNow - offSyncGivenUp;
2308
2309 /* assert sanity */
2310 Assert(u64Now <= u64VirtualNow - offSyncGivenUp);
2311 Assert(u64Max <= u64VirtualNow - offSyncGivenUp);
2312 Assert(u64Now <= u64Max);
2313 Assert(offSyncGivenUp == pVM->tm.s.offVirtualSyncGivenUp);
2314
2315 /*
2316 * Process the expired timers moving the clock along as we progress.
2317 */
2318#ifdef VBOX_STRICT
2319 uint64_t u64Prev = u64Now; NOREF(u64Prev);
2320#endif
2321 while (pNext && pNext->u64Expire <= u64Max)
2322 {
2323 /* Advance */
2324 PTMTIMER pTimer = pNext;
2325 pNext = TMTIMER_GET_NEXT(pTimer);
2326
2327 /* Take the associated lock. */
2328 PPDMCRITSECT pCritSect = pTimer->pCritSect;
2329 if (pCritSect)
2330 PDMCritSectEnter(pCritSect, VERR_IGNORED);
2331
2332 Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
2333 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
2334
2335 /* Advance the clock - don't permit timers to be out of order or armed
2336 in the 'past'. */
2337#ifdef VBOX_STRICT
2338 AssertMsg(pTimer->u64Expire >= u64Prev, ("%'RU64 < %'RU64 %s\n", pTimer->u64Expire, u64Prev, pTimer->pszDesc));
2339 u64Prev = pTimer->u64Expire;
2340#endif
2341 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, pTimer->u64Expire);
2342 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
2343
2344 /* Unlink it, change the state and do the callout. */
2345 tmTimerQueueUnlinkActive(pQueue, pTimer);
2346 TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2347 switch (pTimer->enmType)
2348 {
2349 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer, pTimer->pvUser); break;
2350 case TMTIMERTYPE_USB: pTimer->u.Usb.pfnTimer(pTimer->u.Usb.pUsbIns, pTimer, pTimer->pvUser); break;
2351 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer, pTimer->pvUser); break;
2352 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->pvUser); break;
2353 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->pvUser); break;
2354 default:
2355 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2356 break;
2357 }
2358
2359 /* Change the state if it wasn't changed already in the handler.
2360 Reset the Hz hint too since this is the same as TMTimerStop. */
2361 bool fRc;
2362 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2363 if (fRc && pTimer->uHzHint)
2364 {
2365 if (pTimer->uHzHint >= pVM->tm.s.uMaxHzHint)
2366 ASMAtomicWriteBool(&pVM->tm.s.fHzHintNeedsUpdating, true);
2367 pTimer->uHzHint = 0;
2368 }
2369 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2370
2371 /* Leave the associated lock. */
2372 if (pCritSect)
2373 PDMCritSectLeave(pCritSect);
2374 } /* run loop */
2375
2376
2377 /*
2378 * Restart the clock if it was stopped to serve any timers,
2379 * and start/adjust catch-up if necessary.
2380 */
2381 if ( !pVM->tm.s.fVirtualSyncTicking
2382 && pVM->tm.s.cVirtualTicking)
2383 {
2384 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunRestart);
2385
2386 /* calc the slack we've handed out. */
2387 const uint64_t u64VirtualNow2 = TMVirtualGetNoCheck(pVM);
2388 Assert(u64VirtualNow2 >= u64VirtualNow);
2389 AssertMsg(pVM->tm.s.u64VirtualSync >= u64Now, ("%'RU64 < %'RU64\n", pVM->tm.s.u64VirtualSync, u64Now));
2390 const uint64_t offSlack = pVM->tm.s.u64VirtualSync - u64Now;
2391 STAM_STATS({
2392 if (offSlack)
2393 {
2394 PSTAMPROFILE p = &pVM->tm.s.StatVirtualSyncRunSlack;
2395 p->cPeriods++;
2396 p->cTicks += offSlack;
2397 if (p->cTicksMax < offSlack) p->cTicksMax = offSlack;
2398 if (p->cTicksMin > offSlack) p->cTicksMin = offSlack;
2399 }
2400 });
2401
2402 /* Let the time run a little bit while we were busy running timers(?). */
2403 uint64_t u64Elapsed;
2404#define MAX_ELAPSED 30000U /* ns */
2405 if (offSlack > MAX_ELAPSED)
2406 u64Elapsed = 0;
2407 else
2408 {
2409 u64Elapsed = u64VirtualNow2 - u64VirtualNow;
2410 if (u64Elapsed > MAX_ELAPSED)
2411 u64Elapsed = MAX_ELAPSED;
2412 u64Elapsed = u64Elapsed > offSlack ? u64Elapsed - offSlack : 0;
2413 }
2414#undef MAX_ELAPSED
2415
2416 /* Calc the current offset. */
2417 uint64_t offNew = u64VirtualNow2 - pVM->tm.s.u64VirtualSync - u64Elapsed;
2418 Assert(!(offNew & RT_BIT_64(63)));
2419 uint64_t offLag = offNew - pVM->tm.s.offVirtualSyncGivenUp;
2420 Assert(!(offLag & RT_BIT_64(63)));
2421
2422 /*
2423 * Deal with starting, adjusting and stopping catchup.
2424 */
2425 if (pVM->tm.s.fVirtualSyncCatchUp)
2426 {
2427 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpStopThreshold)
2428 {
2429 /* stop */
2430 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2431 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2432 Log4(("TM: %'RU64/-%'8RU64: caught up [pt]\n", u64VirtualNow2 - offNew, offLag));
2433 }
2434 else if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2435 {
2436 /* adjust */
2437 unsigned i = 0;
2438 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2439 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2440 i++;
2441 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage < pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage)
2442 {
2443 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupAdjust[i]);
2444 ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2445 Log4(("TM: %'RU64/%'8RU64: adj %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2446 }
2447 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64VirtualNow2;
2448 }
2449 else
2450 {
2451 /* give up */
2452 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUp);
2453 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2454 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2455 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2456 Log4(("TM: %'RU64/%'8RU64: give up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2457 LogRel(("TM: Giving up catch-up attempt at a %'RU64 ns lag; new total: %'RU64 ns\n", offLag, offNew));
2458 }
2459 }
2460 else if (offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[0].u64Start)
2461 {
2462 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2463 {
2464 /* start */
2465 STAM_PROFILE_ADV_START(&pVM->tm.s.StatVirtualSyncCatchup, c);
2466 unsigned i = 0;
2467 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2468 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2469 i++;
2470 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupInitial[i]);
2471 ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2472 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, true);
2473 Log4(("TM: %'RU64/%'8RU64: catch-up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2474 }
2475 else
2476 {
2477 /* don't bother */
2478 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUpBeforeStarting);
2479 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2480 Log4(("TM: %'RU64/%'8RU64: give up\n", u64VirtualNow2 - offNew, offLag));
2481 LogRel(("TM: Not bothering to attempt catching up a %'RU64 ns lag; new total: %'RU64\n", offLag, offNew));
2482 }
2483 }
2484
2485 /*
2486 * Update the offset and restart the clock.
2487 */
2488 Assert(!(offNew & RT_BIT_64(63)));
2489 ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, offNew);
2490 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, true);
2491 }
2492}
2493
2494
2495/**
2496 * Deals with stopped Virtual Sync clock.
2497 *
2498 * This is called by the forced action flag handling code in EM when it
2499 * encounters the VM_FF_TM_VIRTUAL_SYNC flag. It is called by all VCPUs and they
2500 * will block on the VirtualSyncLock until the pending timers has been executed
2501 * and the clock restarted.
2502 *
2503 * @param pVM The cross context VM structure.
2504 * @param pVCpu The cross context virtual CPU structure of the calling EMT.
2505 *
2506 * @thread EMTs
2507 */
2508VMMR3_INT_DECL(void) TMR3VirtualSyncFF(PVM pVM, PVMCPU pVCpu)
2509{
2510 Log2(("TMR3VirtualSyncFF:\n"));
2511
2512 /*
2513 * The EMT doing the timers is diverted to them.
2514 */
2515 if (pVCpu->idCpu == pVM->tm.s.idTimerCpu)
2516 TMR3TimerQueuesDo(pVM);
2517 /*
2518 * The other EMTs will block on the virtual sync lock and the first owner
2519 * will run the queue and thus restarting the clock.
2520 *
2521 * Note! This is very suboptimal code wrt to resuming execution when there
2522 * are more than two Virtual CPUs, since they will all have to enter
2523 * the critical section one by one. But it's a very simple solution
2524 * which will have to do the job for now.
2525 */
2526 else
2527 {
2528 STAM_PROFILE_START(&pVM->tm.s.StatVirtualSyncFF, a);
2529 PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2530 if (pVM->tm.s.fVirtualSyncTicking)
2531 {
2532 STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2533 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2534 Log2(("TMR3VirtualSyncFF: ticking\n"));
2535 }
2536 else
2537 {
2538 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2539
2540 /* try run it. */
2541 TM_LOCK_TIMERS(pVM);
2542 PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2543 if (pVM->tm.s.fVirtualSyncTicking)
2544 Log2(("TMR3VirtualSyncFF: ticking (2)\n"));
2545 else
2546 {
2547 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2548 Log2(("TMR3VirtualSyncFF: running queue\n"));
2549
2550 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule);
2551 tmR3TimerQueueRunVirtualSync(pVM);
2552 if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2553 VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2554
2555 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2556 }
2557 STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2558 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2559 TM_UNLOCK_TIMERS(pVM);
2560 }
2561 }
2562}
2563
2564
2565/** @name Saved state values
2566 * @{ */
2567#define TMTIMERSTATE_SAVED_PENDING_STOP 4
2568#define TMTIMERSTATE_SAVED_PENDING_SCHEDULE 7
2569/** @} */
2570
2571
2572/**
2573 * Saves the state of a timer to a saved state.
2574 *
2575 * @returns VBox status code.
2576 * @param pTimer Timer to save.
2577 * @param pSSM Save State Manager handle.
2578 */
2579VMMR3DECL(int) TMR3TimerSave(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
2580{
2581 LogFlow(("TMR3TimerSave: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2582 switch (pTimer->enmState)
2583 {
2584 case TMTIMERSTATE_STOPPED:
2585 case TMTIMERSTATE_PENDING_STOP:
2586 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
2587 return SSMR3PutU8(pSSM, TMTIMERSTATE_SAVED_PENDING_STOP);
2588
2589 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
2590 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
2591 AssertMsgFailed(("u64Expire is being updated! (%s)\n", pTimer->pszDesc));
2592 if (!RTThreadYield())
2593 RTThreadSleep(1);
2594 /* fall thru */
2595 case TMTIMERSTATE_ACTIVE:
2596 case TMTIMERSTATE_PENDING_SCHEDULE:
2597 case TMTIMERSTATE_PENDING_RESCHEDULE:
2598 SSMR3PutU8(pSSM, TMTIMERSTATE_SAVED_PENDING_SCHEDULE);
2599 return SSMR3PutU64(pSSM, pTimer->u64Expire);
2600
2601 case TMTIMERSTATE_EXPIRED_GET_UNLINK:
2602 case TMTIMERSTATE_EXPIRED_DELIVER:
2603 case TMTIMERSTATE_DESTROY:
2604 case TMTIMERSTATE_FREE:
2605 AssertMsgFailed(("Invalid timer state %d %s (%s)\n", pTimer->enmState, tmTimerState(pTimer->enmState), pTimer->pszDesc));
2606 return SSMR3HandleSetStatus(pSSM, VERR_TM_INVALID_STATE);
2607 }
2608
2609 AssertMsgFailed(("Unknown timer state %d (%s)\n", pTimer->enmState, pTimer->pszDesc));
2610 return SSMR3HandleSetStatus(pSSM, VERR_TM_UNKNOWN_STATE);
2611}
2612
2613
2614/**
2615 * Loads the state of a timer from a saved state.
2616 *
2617 * @returns VBox status code.
2618 * @param pTimer Timer to restore.
2619 * @param pSSM Save State Manager handle.
2620 */
2621VMMR3DECL(int) TMR3TimerLoad(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
2622{
2623 Assert(pTimer); Assert(pSSM); VM_ASSERT_EMT(pTimer->pVMR3);
2624 LogFlow(("TMR3TimerLoad: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2625
2626 /*
2627 * Load the state and validate it.
2628 */
2629 uint8_t u8State;
2630 int rc = SSMR3GetU8(pSSM, &u8State);
2631 if (RT_FAILURE(rc))
2632 return rc;
2633
2634 /* TMTIMERSTATE_SAVED_XXX: Workaround for accidental state shift in r47786 (2009-05-26 19:12:12). */
2635 if ( u8State == TMTIMERSTATE_SAVED_PENDING_STOP + 1
2636 || u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE + 1)
2637 u8State--;
2638
2639 if ( u8State != TMTIMERSTATE_SAVED_PENDING_STOP
2640 && u8State != TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2641 {
2642 AssertLogRelMsgFailed(("u8State=%d\n", u8State));
2643 return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2644 }
2645
2646 /* Enter the critical sections to make TMTimerSet/Stop happy. */
2647 if (pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC)
2648 PDMCritSectEnter(&pTimer->pVMR3->tm.s.VirtualSyncLock, VERR_IGNORED);
2649 PPDMCRITSECT pCritSect = pTimer->pCritSect;
2650 if (pCritSect)
2651 PDMCritSectEnter(pCritSect, VERR_IGNORED);
2652
2653 if (u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2654 {
2655 /*
2656 * Load the expire time.
2657 */
2658 uint64_t u64Expire;
2659 rc = SSMR3GetU64(pSSM, &u64Expire);
2660 if (RT_FAILURE(rc))
2661 return rc;
2662
2663 /*
2664 * Set it.
2665 */
2666 Log(("u8State=%d u64Expire=%llu\n", u8State, u64Expire));
2667 rc = TMTimerSet(pTimer, u64Expire);
2668 }
2669 else
2670 {
2671 /*
2672 * Stop it.
2673 */
2674 Log(("u8State=%d\n", u8State));
2675 rc = TMTimerStop(pTimer);
2676 }
2677
2678 if (pCritSect)
2679 PDMCritSectLeave(pCritSect);
2680 if (pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC)
2681 PDMCritSectLeave(&pTimer->pVMR3->tm.s.VirtualSyncLock);
2682
2683 /*
2684 * On failure set SSM status.
2685 */
2686 if (RT_FAILURE(rc))
2687 rc = SSMR3HandleSetStatus(pSSM, rc);
2688 return rc;
2689}
2690
2691
2692/**
2693 * Skips the state of a timer in a given saved state.
2694 *
2695 * @returns VBox status.
2696 * @param pSSM Save State Manager handle.
2697 * @param pfActive Where to store whether the timer was active
2698 * when the state was saved.
2699 */
2700VMMR3DECL(int) TMR3TimerSkip(PSSMHANDLE pSSM, bool *pfActive)
2701{
2702 Assert(pSSM); AssertPtr(pfActive);
2703 LogFlow(("TMR3TimerSkip: pSSM=%p pfActive=%p\n", pSSM, pfActive));
2704
2705 /*
2706 * Load the state and validate it.
2707 */
2708 uint8_t u8State;
2709 int rc = SSMR3GetU8(pSSM, &u8State);
2710 if (RT_FAILURE(rc))
2711 return rc;
2712
2713 /* TMTIMERSTATE_SAVED_XXX: Workaround for accidental state shift in r47786 (2009-05-26 19:12:12). */
2714 if ( u8State == TMTIMERSTATE_SAVED_PENDING_STOP + 1
2715 || u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE + 1)
2716 u8State--;
2717
2718 if ( u8State != TMTIMERSTATE_SAVED_PENDING_STOP
2719 && u8State != TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2720 {
2721 AssertLogRelMsgFailed(("u8State=%d\n", u8State));
2722 return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2723 }
2724
2725 *pfActive = (u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE);
2726 if (*pfActive)
2727 {
2728 /*
2729 * Load the expire time.
2730 */
2731 uint64_t u64Expire;
2732 rc = SSMR3GetU64(pSSM, &u64Expire);
2733 }
2734
2735 return rc;
2736}
2737
2738
2739/**
2740 * Associates a critical section with a timer.
2741 *
2742 * The critical section will be entered prior to doing the timer call back, thus
2743 * avoiding potential races between the timer thread and other threads trying to
2744 * stop or adjust the timer expiration while it's being delivered. The timer
2745 * thread will leave the critical section when the timer callback returns.
2746 *
2747 * In strict builds, ownership of the critical section will be asserted by
2748 * TMTimerSet, TMTimerStop, TMTimerGetExpire and TMTimerDestroy (when called at
2749 * runtime).
2750 *
2751 * @retval VINF_SUCCESS on success.
2752 * @retval VERR_INVALID_HANDLE if the timer handle is NULL or invalid
2753 * (asserted).
2754 * @retval VERR_INVALID_PARAMETER if pCritSect is NULL or has an invalid magic
2755 * (asserted).
2756 * @retval VERR_ALREADY_EXISTS if a critical section was already associated
2757 * with the timer (asserted).
2758 * @retval VERR_INVALID_STATE if the timer isn't stopped.
2759 *
2760 * @param pTimer The timer handle.
2761 * @param pCritSect The critical section. The caller must make sure this
2762 * is around for the life time of the timer.
2763 *
2764 * @thread Any, but the caller is responsible for making sure the timer is not
2765 * active.
2766 */
2767VMMR3DECL(int) TMR3TimerSetCritSect(PTMTIMERR3 pTimer, PPDMCRITSECT pCritSect)
2768{
2769 AssertPtrReturn(pTimer, VERR_INVALID_HANDLE);
2770 AssertPtrReturn(pCritSect, VERR_INVALID_PARAMETER);
2771 const char *pszName = PDMR3CritSectName(pCritSect); /* exploited for validation */
2772 AssertReturn(pszName, VERR_INVALID_PARAMETER);
2773 AssertReturn(!pTimer->pCritSect, VERR_ALREADY_EXISTS);
2774 AssertReturn(pTimer->enmState == TMTIMERSTATE_STOPPED, VERR_INVALID_STATE);
2775 LogFlow(("pTimer=%p (%s) pCritSect=%p (%s)\n", pTimer, pTimer->pszDesc, pCritSect, pszName));
2776
2777 pTimer->pCritSect = pCritSect;
2778 return VINF_SUCCESS;
2779}
2780
2781
2782/**
2783 * Get the real world UTC time adjusted for VM lag.
2784 *
2785 * @returns pTime.
2786 * @param pVM The cross context VM structure.
2787 * @param pTime Where to store the time.
2788 */
2789VMMR3_INT_DECL(PRTTIMESPEC) TMR3UtcNow(PVM pVM, PRTTIMESPEC pTime)
2790{
2791 /* Get a stable set of VirtualSync parameters before querying UTC. */
2792 uint64_t offVirtualSync;
2793 uint64_t offVirtualSyncGivenUp;
2794 do
2795 {
2796 offVirtualSync = ASMAtomicReadU64(&pVM->tm.s.offVirtualSync);
2797 offVirtualSyncGivenUp = ASMAtomicReadU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp);
2798 } while (ASMAtomicReadU64(&pVM->tm.s.offVirtualSync) != offVirtualSync);
2799
2800 Assert(offVirtualSync >= offVirtualSyncGivenUp);
2801 uint64_t const offLag = offVirtualSync - offVirtualSyncGivenUp;
2802
2803 RTTimeNow(pTime);
2804 RTTimeSpecSubNano(pTime, offLag);
2805 RTTimeSpecAddNano(pTime, pVM->tm.s.offUTC);
2806 return pTime;
2807}
2808
2809
2810/**
2811 * Pauses all clocks except TMCLOCK_REAL.
2812 *
2813 * @returns VBox status code, all errors are asserted.
2814 * @param pVM The cross context VM structure.
2815 * @param pVCpu The cross context virtual CPU structure.
2816 * @thread EMT corresponding to Pointer to the VMCPU.
2817 */
2818VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu)
2819{
2820 VMCPU_ASSERT_EMT(pVCpu);
2821
2822 /*
2823 * The shared virtual clock (includes virtual sync which is tied to it).
2824 */
2825 TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
2826 int rc = tmVirtualPauseLocked(pVM);
2827 TM_UNLOCK_TIMERS(pVM);
2828 if (RT_FAILURE(rc))
2829 return rc;
2830
2831 /*
2832 * Pause the TSC last since it is normally linked to the virtual
2833 * sync clock, so the above code may actually stop both clocks.
2834 */
2835 if (!pVM->tm.s.fTSCTiedToExecution)
2836 {
2837 TM_LOCK_TIMERS(pVM); /* Exploit the timer lock for synchronization. */
2838 rc = tmCpuTickPauseLocked(pVM, pVCpu);
2839 TM_UNLOCK_TIMERS(pVM);
2840 if (RT_FAILURE(rc))
2841 return rc;
2842 }
2843
2844#ifndef VBOX_WITHOUT_NS_ACCOUNTING
2845 /*
2846 * Update cNsTotal.
2847 */
2848 uint32_t uGen = ASMAtomicIncU32(&pVCpu->tm.s.uTimesGen); Assert(uGen & 1);
2849 pVCpu->tm.s.cNsTotal = RTTimeNanoTS() - pVCpu->tm.s.u64NsTsStartTotal;
2850 pVCpu->tm.s.cNsOther = pVCpu->tm.s.cNsTotal - pVCpu->tm.s.cNsExecuting - pVCpu->tm.s.cNsHalted;
2851 ASMAtomicWriteU32(&pVCpu->tm.s.uTimesGen, (uGen | 1) + 1);
2852#endif
2853
2854 return VINF_SUCCESS;
2855}
2856
2857
2858/**
2859 * Resumes all clocks except TMCLOCK_REAL.
2860 *
2861 * @returns VBox status code, all errors are asserted.
2862 * @param pVM The cross context VM structure.
2863 * @param pVCpu The cross context virtual CPU structure.
2864 * @thread EMT corresponding to Pointer to the VMCPU.
2865 */
2866VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu)
2867{
2868 VMCPU_ASSERT_EMT(pVCpu);
2869 int rc;
2870
2871#ifndef VBOX_WITHOUT_NS_ACCOUNTING
2872 /*
2873 * Set u64NsTsStartTotal. There is no need to back this out if either of
2874 * the two calls below fail.
2875 */
2876 pVCpu->tm.s.u64NsTsStartTotal = RTTimeNanoTS() - pVCpu->tm.s.cNsTotal;
2877#endif
2878
2879 /*
2880 * Resume the TSC first since it is normally linked to the virtual sync
2881 * clock, so it may actually not be resumed until we've executed the code
2882 * below.
2883 */
2884 if (!pVM->tm.s.fTSCTiedToExecution)
2885 {
2886 TM_LOCK_TIMERS(pVM); /* Exploit the timer lock for synchronization. */
2887 rc = tmCpuTickResumeLocked(pVM, pVCpu);
2888 TM_UNLOCK_TIMERS(pVM);
2889 if (RT_FAILURE(rc))
2890 return rc;
2891 }
2892
2893 /*
2894 * The shared virtual clock (includes virtual sync which is tied to it).
2895 */
2896 TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
2897 rc = tmVirtualResumeLocked(pVM);
2898 TM_UNLOCK_TIMERS(pVM);
2899
2900 return rc;
2901}
2902
2903
2904/**
2905 * Sets the warp drive percent of the virtual time.
2906 *
2907 * @returns VBox status code.
2908 * @param pUVM The user mode VM structure.
2909 * @param u32Percent The new percentage. 100 means normal operation.
2910 */
2911VMMDECL(int) TMR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent)
2912{
2913 return VMR3ReqPriorityCallWaitU(pUVM, VMCPUID_ANY, (PFNRT)tmR3SetWarpDrive, 2, pUVM, u32Percent);
2914}
2915
2916
2917/**
2918 * EMT worker for TMR3SetWarpDrive.
2919 *
2920 * @returns VBox status code.
2921 * @param pUVM The user mode VM handle.
2922 * @param u32Percent See TMR3SetWarpDrive().
2923 * @internal
2924 */
2925static DECLCALLBACK(int) tmR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent)
2926{
2927 PVM pVM = pUVM->pVM;
2928 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2929 PVMCPU pVCpu = VMMGetCpu(pVM);
2930
2931 /*
2932 * Validate it.
2933 */
2934 AssertMsgReturn(u32Percent >= 2 && u32Percent <= 20000,
2935 ("%RX32 is not between 2 and 20000 (inclusive).\n", u32Percent),
2936 VERR_INVALID_PARAMETER);
2937
2938/** @todo This isn't a feature specific to virtual time, move the variables to
2939 * TM level and make it affect TMR3UTCNow as well! */
2940
2941 /*
2942 * If the time is running we'll have to pause it before we can change
2943 * the warp drive settings.
2944 */
2945 TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
2946 bool fPaused = !!pVM->tm.s.cVirtualTicking;
2947 if (fPaused) /** @todo this isn't really working, but wtf. */
2948 TMR3NotifySuspend(pVM, pVCpu);
2949
2950 /** @todo Should switch TM mode to virt-tsc-emulated if it isn't already! */
2951 pVM->tm.s.u32VirtualWarpDrivePercentage = u32Percent;
2952 pVM->tm.s.fVirtualWarpDrive = u32Percent != 100;
2953 LogRel(("TM: u32VirtualWarpDrivePercentage=%RI32 fVirtualWarpDrive=%RTbool\n",
2954 pVM->tm.s.u32VirtualWarpDrivePercentage, pVM->tm.s.fVirtualWarpDrive));
2955
2956 if (fPaused)
2957 TMR3NotifyResume(pVM, pVCpu);
2958 TM_UNLOCK_TIMERS(pVM);
2959 return VINF_SUCCESS;
2960}
2961
2962
2963/**
2964 * Gets the current TMCLOCK_VIRTUAL time without checking
2965 * timers or anything.
2966 *
2967 * @returns The timestamp.
2968 * @param pUVM The user mode VM structure.
2969 *
2970 * @remarks See TMVirtualGetNoCheck.
2971 */
2972VMMR3DECL(uint64_t) TMR3TimeVirtGet(PUVM pUVM)
2973{
2974 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
2975 PVM pVM = pUVM->pVM;
2976 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
2977 return TMVirtualGetNoCheck(pVM);
2978}
2979
2980
2981/**
2982 * Gets the current TMCLOCK_VIRTUAL time in milliseconds without checking
2983 * timers or anything.
2984 *
2985 * @returns The timestamp in milliseconds.
2986 * @param pUVM The user mode VM structure.
2987 *
2988 * @remarks See TMVirtualGetNoCheck.
2989 */
2990VMMR3DECL(uint64_t) TMR3TimeVirtGetMilli(PUVM pUVM)
2991{
2992 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
2993 PVM pVM = pUVM->pVM;
2994 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
2995 return TMVirtualToMilli(pVM, TMVirtualGetNoCheck(pVM));
2996}
2997
2998
2999/**
3000 * Gets the current TMCLOCK_VIRTUAL time in microseconds without checking
3001 * timers or anything.
3002 *
3003 * @returns The timestamp in microseconds.
3004 * @param pUVM The user mode VM structure.
3005 *
3006 * @remarks See TMVirtualGetNoCheck.
3007 */
3008VMMR3DECL(uint64_t) TMR3TimeVirtGetMicro(PUVM pUVM)
3009{
3010 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3011 PVM pVM = pUVM->pVM;
3012 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3013 return TMVirtualToMicro(pVM, TMVirtualGetNoCheck(pVM));
3014}
3015
3016
3017/**
3018 * Gets the current TMCLOCK_VIRTUAL time in nanoseconds without checking
3019 * timers or anything.
3020 *
3021 * @returns The timestamp in nanoseconds.
3022 * @param pUVM The user mode VM structure.
3023 *
3024 * @remarks See TMVirtualGetNoCheck.
3025 */
3026VMMR3DECL(uint64_t) TMR3TimeVirtGetNano(PUVM pUVM)
3027{
3028 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3029 PVM pVM = pUVM->pVM;
3030 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3031 return TMVirtualToNano(pVM, TMVirtualGetNoCheck(pVM));
3032}
3033
3034
3035/**
3036 * Gets the current warp drive percent.
3037 *
3038 * @returns The warp drive percent.
3039 * @param pUVM The user mode VM structure.
3040 */
3041VMMR3DECL(uint32_t) TMR3GetWarpDrive(PUVM pUVM)
3042{
3043 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT32_MAX);
3044 PVM pVM = pUVM->pVM;
3045 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT32_MAX);
3046 return pVM->tm.s.u32VirtualWarpDrivePercentage;
3047}
3048
3049
3050/**
3051 * Gets the performance information for one virtual CPU as seen by the VMM.
3052 *
3053 * The returned times covers the period where the VM is running and will be
3054 * reset when restoring a previous VM state (at least for the time being).
3055 *
3056 * @retval VINF_SUCCESS on success.
3057 * @retval VERR_NOT_IMPLEMENTED if not compiled in.
3058 * @retval VERR_INVALID_STATE if the VM handle is bad.
3059 * @retval VERR_INVALID_PARAMETER if idCpu is out of range.
3060 *
3061 * @param pVM The cross context VM structure.
3062 * @param idCpu The ID of the virtual CPU which times to get.
3063 * @param pcNsTotal Where to store the total run time (nano seconds) of
3064 * the CPU, i.e. the sum of the three other returns.
3065 * Optional.
3066 * @param pcNsExecuting Where to store the time (nano seconds) spent
3067 * executing guest code. Optional.
3068 * @param pcNsHalted Where to store the time (nano seconds) spent
3069 * halted. Optional
3070 * @param pcNsOther Where to store the time (nano seconds) spent
3071 * preempted by the host scheduler, on virtualization
3072 * overhead and on other tasks.
3073 */
3074VMMR3DECL(int) TMR3GetCpuLoadTimes(PVM pVM, VMCPUID idCpu, uint64_t *pcNsTotal, uint64_t *pcNsExecuting,
3075 uint64_t *pcNsHalted, uint64_t *pcNsOther)
3076{
3077 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_STATE);
3078 AssertReturn(idCpu < pVM->cCpus, VERR_INVALID_PARAMETER);
3079
3080#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3081 /*
3082 * Get a stable result set.
3083 * This should be way quicker than an EMT request.
3084 */
3085 PVMCPU pVCpu = &pVM->aCpus[idCpu];
3086 uint32_t uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3087 uint64_t cNsTotal = pVCpu->tm.s.cNsTotal;
3088 uint64_t cNsExecuting = pVCpu->tm.s.cNsExecuting;
3089 uint64_t cNsHalted = pVCpu->tm.s.cNsHalted;
3090 uint64_t cNsOther = pVCpu->tm.s.cNsOther;
3091 while ( (uTimesGen & 1) /* update in progress */
3092 || uTimesGen != ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen))
3093 {
3094 RTThreadYield();
3095 uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3096 cNsTotal = pVCpu->tm.s.cNsTotal;
3097 cNsExecuting = pVCpu->tm.s.cNsExecuting;
3098 cNsHalted = pVCpu->tm.s.cNsHalted;
3099 cNsOther = pVCpu->tm.s.cNsOther;
3100 }
3101
3102 /*
3103 * Fill in the return values.
3104 */
3105 if (pcNsTotal)
3106 *pcNsTotal = cNsTotal;
3107 if (pcNsExecuting)
3108 *pcNsExecuting = cNsExecuting;
3109 if (pcNsHalted)
3110 *pcNsHalted = cNsHalted;
3111 if (pcNsOther)
3112 *pcNsOther = cNsOther;
3113
3114 return VINF_SUCCESS;
3115
3116#else
3117 return VERR_NOT_IMPLEMENTED;
3118#endif
3119}
3120
3121#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3122
3123/**
3124 * Helper for tmR3CpuLoadTimer.
3125 * @returns
3126 * @param pState The state to update.
3127 * @param cNsTotal Total time.
3128 * @param cNsExecuting Time executing.
3129 * @param cNsHalted Time halted.
3130 */
3131DECLINLINE(void) tmR3CpuLoadTimerMakeUpdate(PTMCPULOADSTATE pState, uint64_t cNsTotal, uint64_t cNsExecuting, uint64_t cNsHalted)
3132{
3133 /* Calc deltas */
3134 uint64_t cNsTotalDelta = cNsTotal - pState->cNsPrevTotal;
3135 pState->cNsPrevTotal = cNsTotal;
3136
3137 uint64_t cNsExecutingDelta = cNsExecuting - pState->cNsPrevExecuting;
3138 pState->cNsPrevExecuting = cNsExecuting;
3139
3140 uint64_t cNsHaltedDelta = cNsHalted - pState->cNsPrevHalted;
3141 pState->cNsPrevHalted = cNsHalted;
3142
3143 /* Calc pcts. */
3144 if (!cNsTotalDelta)
3145 {
3146 pState->cPctExecuting = 0;
3147 pState->cPctHalted = 100;
3148 pState->cPctOther = 0;
3149 }
3150 else if (cNsTotalDelta < UINT64_MAX / 4)
3151 {
3152 pState->cPctExecuting = (uint8_t)(cNsExecutingDelta * 100 / cNsTotalDelta);
3153 pState->cPctHalted = (uint8_t)(cNsHaltedDelta * 100 / cNsTotalDelta);
3154 pState->cPctOther = (uint8_t)((cNsTotalDelta - cNsExecutingDelta - cNsHaltedDelta) * 100 / cNsTotalDelta);
3155 }
3156 else
3157 {
3158 pState->cPctExecuting = 0;
3159 pState->cPctHalted = 100;
3160 pState->cPctOther = 0;
3161 }
3162}
3163
3164
3165/**
3166 * Timer callback that calculates the CPU load since the last time it was
3167 * called.
3168 *
3169 * @param pVM The cross context VM structure.
3170 * @param pTimer The timer.
3171 * @param pvUser NULL, unused.
3172 */
3173static DECLCALLBACK(void) tmR3CpuLoadTimer(PVM pVM, PTMTIMER pTimer, void *pvUser)
3174{
3175 /*
3176 * Re-arm the timer first.
3177 */
3178 int rc = TMTimerSetMillies(pTimer, 1000);
3179 AssertLogRelRC(rc);
3180 NOREF(pvUser);
3181
3182 /*
3183 * Update the values for each CPU.
3184 */
3185 uint64_t cNsTotalAll = 0;
3186 uint64_t cNsExecutingAll = 0;
3187 uint64_t cNsHaltedAll = 0;
3188 for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
3189 {
3190 PVMCPU pVCpu = &pVM->aCpus[iCpu];
3191
3192 /* Try get a stable data set. */
3193 uint32_t cTries = 3;
3194 uint32_t uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3195 uint64_t cNsTotal = pVCpu->tm.s.cNsTotal;
3196 uint64_t cNsExecuting = pVCpu->tm.s.cNsExecuting;
3197 uint64_t cNsHalted = pVCpu->tm.s.cNsHalted;
3198 while (RT_UNLIKELY( (uTimesGen & 1) /* update in progress */
3199 || uTimesGen != ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen)))
3200 {
3201 if (!--cTries)
3202 break;
3203 ASMNopPause();
3204 uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3205 cNsTotal = pVCpu->tm.s.cNsTotal;
3206 cNsExecuting = pVCpu->tm.s.cNsExecuting;
3207 cNsHalted = pVCpu->tm.s.cNsHalted;
3208 }
3209
3210 /* Totals */
3211 cNsTotalAll += cNsTotal;
3212 cNsExecutingAll += cNsExecuting;
3213 cNsHaltedAll += cNsHalted;
3214
3215 /* Calc the PCTs and update the state. */
3216 tmR3CpuLoadTimerMakeUpdate(&pVCpu->tm.s.CpuLoad, cNsTotal, cNsExecuting, cNsHalted);
3217 }
3218
3219 /*
3220 * Update the value for all the CPUs.
3221 */
3222 tmR3CpuLoadTimerMakeUpdate(&pVM->tm.s.CpuLoad, cNsTotalAll, cNsExecutingAll, cNsHaltedAll);
3223
3224 /** @todo Try add 1, 5 and 15 min load stats. */
3225
3226}
3227
3228#endif /* !VBOX_WITHOUT_NS_ACCOUNTING */
3229
3230
3231/**
3232 * @callback_method_impl{PFNVMMEMTRENDEZVOUS,
3233 * Worker for TMR3CpuTickParavirtEnable}
3234 */
3235static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtEnable(PVM pVM, PVMCPU pVCpuEmt, void *pvData)
3236{
3237 AssertPtr(pVM); Assert(pVM->tm.s.fTSCModeSwitchAllowed); NOREF(pVCpuEmt); NOREF(pvData);
3238 Assert(pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET);
3239 Assert(tmR3HasFixedTSC(pVM));
3240
3241 /*
3242 * The return value of TMCpuTickGet() and the guest's TSC value for each
3243 * CPU must remain constant across the TM TSC mode-switch. Thus we have
3244 * the following equation (new/old signifies the new/old tsc modes):
3245 * uNewTsc = uOldTsc
3246 *
3247 * Where (see tmCpuTickGetInternal):
3248 * uOldTsc = uRawOldTsc - offTscRawSrcOld
3249 * uNewTsc = uRawNewTsc - offTscRawSrcNew
3250 *
3251 * Solve it for offTscRawSrcNew without replacing uOldTsc:
3252 * uRawNewTsc - offTscRawSrcNew = uOldTsc
3253 * => -offTscRawSrcNew = uOldTsc - uRawNewTsc
3254 * => offTscRawSrcNew = uRawNewTsc - uOldTsc
3255 */
3256 uint64_t uRawOldTsc = tmR3CpuTickGetRawVirtualNoCheck(pVM);
3257 uint64_t uRawNewTsc = SUPReadTsc();
3258 uint32_t cCpus = pVM->cCpus;
3259 for (uint32_t i = 0; i < cCpus; i++)
3260 {
3261 PVMCPU pVCpu = &pVM->aCpus[i];
3262 uint64_t uOldTsc = uRawOldTsc - pVCpu->tm.s.offTSCRawSrc;
3263 pVCpu->tm.s.offTSCRawSrc = uRawNewTsc - uOldTsc;
3264 Assert(uRawNewTsc - pVCpu->tm.s.offTSCRawSrc >= uOldTsc); /* paranoia^256 */
3265 }
3266
3267 LogRel(("TM: Switching TSC mode from '%s' to '%s'\n", tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode),
3268 tmR3GetTSCModeNameEx(TMTSCMODE_REAL_TSC_OFFSET)));
3269 pVM->tm.s.enmTSCMode = TMTSCMODE_REAL_TSC_OFFSET;
3270 return VINF_SUCCESS;
3271}
3272
3273
3274/**
3275 * Notify TM that the guest has enabled usage of a paravirtualized TSC.
3276 *
3277 * This may perform a EMT rendezvous and change the TSC virtualization mode.
3278 *
3279 * @returns VBox status code.
3280 * @param pVM The cross context VM structure.
3281 */
3282VMMR3_INT_DECL(int) TMR3CpuTickParavirtEnable(PVM pVM)
3283{
3284 int rc = VINF_SUCCESS;
3285 if (pVM->tm.s.fTSCModeSwitchAllowed)
3286 {
3287 if (pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET)
3288 rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, tmR3CpuTickParavirtEnable, NULL);
3289 }
3290 else
3291 LogRel(("TM: Host/VM is not suitable for using TSC mode '%s', request to change TSC mode ignored\n",
3292 tmR3GetTSCModeNameEx(TMTSCMODE_REAL_TSC_OFFSET)));
3293 pVM->tm.s.fParavirtTscEnabled = true;
3294 return rc;
3295}
3296
3297
3298/**
3299 * @callback_method_impl{PFNVMMEMTRENDEZVOUS,
3300 * Worker for TMR3CpuTickParavirtDisable}
3301 */
3302static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtDisable(PVM pVM, PVMCPU pVCpuEmt, void *pvData)
3303{
3304 AssertPtr(pVM); Assert(pVM->tm.s.fTSCModeSwitchAllowed); NOREF(pVCpuEmt);
3305 Assert( pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET
3306 && pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode);
3307 RT_NOREF1(pvData);
3308
3309 /*
3310 * See tmR3CpuTickParavirtEnable for an explanation of the conversion math.
3311 */
3312 uint64_t uRawOldTsc = SUPReadTsc();
3313 uint64_t uRawNewTsc = tmR3CpuTickGetRawVirtualNoCheck(pVM);
3314 uint32_t cCpus = pVM->cCpus;
3315 for (uint32_t i = 0; i < cCpus; i++)
3316 {
3317 PVMCPU pVCpu = &pVM->aCpus[i];
3318 uint64_t uOldTsc = uRawOldTsc - pVCpu->tm.s.offTSCRawSrc;
3319 pVCpu->tm.s.offTSCRawSrc = uRawNewTsc - uOldTsc;
3320 Assert(uRawNewTsc - pVCpu->tm.s.offTSCRawSrc >= uOldTsc); /* paranoia^256 */
3321
3322 /* Update the last-seen tick here as we havent't been updating it (as we don't
3323 need it) while in pure TSC-offsetting mode. */
3324 pVCpu->tm.s.u64TSCLastSeen = uOldTsc;
3325 }
3326
3327 LogRel(("TM: Switching TSC mode from '%s' to '%s'\n", tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode),
3328 tmR3GetTSCModeNameEx(pVM->tm.s.enmOriginalTSCMode)));
3329 pVM->tm.s.enmTSCMode = pVM->tm.s.enmOriginalTSCMode;
3330 return VINF_SUCCESS;
3331}
3332
3333
3334/**
3335 * Notify TM that the guest has disabled usage of a paravirtualized TSC.
3336 *
3337 * If TMR3CpuTickParavirtEnable() changed the TSC virtualization mode, this will
3338 * perform an EMT rendezvous to revert those changes.
3339 *
3340 * @returns VBox status code.
3341 * @param pVM The cross context VM structure.
3342 */
3343VMMR3_INT_DECL(int) TMR3CpuTickParavirtDisable(PVM pVM)
3344{
3345 int rc = VINF_SUCCESS;
3346 if ( pVM->tm.s.fTSCModeSwitchAllowed
3347 && pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET
3348 && pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode)
3349 rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, tmR3CpuTickParavirtDisable, NULL);
3350 pVM->tm.s.fParavirtTscEnabled = false;
3351 return rc;
3352}
3353
3354
3355/**
3356 * Check whether the guest can be presented a fixed rate & monotonic TSC.
3357 *
3358 * @returns true if TSC is stable, false otherwise.
3359 * @param pVM The cross context VM structure.
3360 * @param fWithParavirtEnabled Whether it's fixed & monotonic when
3361 * paravirt. TSC is enabled or not.
3362 *
3363 * @remarks Must be called only after TMR3InitFinalize().
3364 */
3365VMMR3_INT_DECL(bool) TMR3CpuTickIsFixedRateMonotonic(PVM pVM, bool fWithParavirtEnabled)
3366{
3367 /** @todo figure out what exactly we want here later. */
3368 NOREF(fWithParavirtEnabled);
3369 return ( tmR3HasFixedTSC(pVM) /* Host has fixed-rate TSC. */
3370 && g_pSUPGlobalInfoPage->u32Mode != SUPGIPMODE_ASYNC_TSC); /* GIP thinks it's monotonic. */
3371}
3372
3373
3374/**
3375 * Gets the 5 char clock name for the info tables.
3376 *
3377 * @returns The name.
3378 * @param enmClock The clock.
3379 */
3380DECLINLINE(const char *) tmR3Get5CharClockName(TMCLOCK enmClock)
3381{
3382 switch (enmClock)
3383 {
3384 case TMCLOCK_REAL: return "Real ";
3385 case TMCLOCK_VIRTUAL: return "Virt ";
3386 case TMCLOCK_VIRTUAL_SYNC: return "VrSy ";
3387 case TMCLOCK_TSC: return "TSC ";
3388 default: return "Bad ";
3389 }
3390}
3391
3392
3393/**
3394 * Display all timers.
3395 *
3396 * @param pVM The cross context VM structure.
3397 * @param pHlp The info helpers.
3398 * @param pszArgs Arguments, ignored.
3399 */
3400static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3401{
3402 NOREF(pszArgs);
3403 pHlp->pfnPrintf(pHlp,
3404 "Timers (pVM=%p)\n"
3405 "%.*s %.*s %.*s %.*s Clock %18s %18s %6s %-25s Description\n",
3406 pVM,
3407 sizeof(RTR3PTR) * 2, "pTimerR3 ",
3408 sizeof(int32_t) * 2, "offNext ",
3409 sizeof(int32_t) * 2, "offPrev ",
3410 sizeof(int32_t) * 2, "offSched ",
3411 "Time",
3412 "Expire",
3413 "HzHint",
3414 "State");
3415 TM_LOCK_TIMERS(pVM);
3416 for (PTMTIMERR3 pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
3417 {
3418 pHlp->pfnPrintf(pHlp,
3419 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %6RU32 %-25s %s\n",
3420 pTimer,
3421 pTimer->offNext,
3422 pTimer->offPrev,
3423 pTimer->offScheduleNext,
3424 tmR3Get5CharClockName(pTimer->enmClock),
3425 TMTimerGet(pTimer),
3426 pTimer->u64Expire,
3427 pTimer->uHzHint,
3428 tmTimerState(pTimer->enmState),
3429 pTimer->pszDesc);
3430 }
3431 TM_UNLOCK_TIMERS(pVM);
3432}
3433
3434
3435/**
3436 * Display all active timers.
3437 *
3438 * @param pVM The cross context VM structure.
3439 * @param pHlp The info helpers.
3440 * @param pszArgs Arguments, ignored.
3441 */
3442static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3443{
3444 NOREF(pszArgs);
3445 pHlp->pfnPrintf(pHlp,
3446 "Active Timers (pVM=%p)\n"
3447 "%.*s %.*s %.*s %.*s Clock %18s %18s %6s %-25s Description\n",
3448 pVM,
3449 sizeof(RTR3PTR) * 2, "pTimerR3 ",
3450 sizeof(int32_t) * 2, "offNext ",
3451 sizeof(int32_t) * 2, "offPrev ",
3452 sizeof(int32_t) * 2, "offSched ",
3453 "Time",
3454 "Expire",
3455 "HzHint",
3456 "State");
3457 for (unsigned iQueue = 0; iQueue < TMCLOCK_MAX; iQueue++)
3458 {
3459 TM_LOCK_TIMERS(pVM);
3460 for (PTMTIMERR3 pTimer = TMTIMER_GET_HEAD(&pVM->tm.s.paTimerQueuesR3[iQueue]);
3461 pTimer;
3462 pTimer = TMTIMER_GET_NEXT(pTimer))
3463 {
3464 pHlp->pfnPrintf(pHlp,
3465 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %6RU32 %-25s %s\n",
3466 pTimer,
3467 pTimer->offNext,
3468 pTimer->offPrev,
3469 pTimer->offScheduleNext,
3470 tmR3Get5CharClockName(pTimer->enmClock),
3471 TMTimerGet(pTimer),
3472 pTimer->u64Expire,
3473 pTimer->uHzHint,
3474 tmTimerState(pTimer->enmState),
3475 pTimer->pszDesc);
3476 }
3477 TM_UNLOCK_TIMERS(pVM);
3478 }
3479}
3480
3481
3482/**
3483 * Display all clocks.
3484 *
3485 * @param pVM The cross context VM structure.
3486 * @param pHlp The info helpers.
3487 * @param pszArgs Arguments, ignored.
3488 */
3489static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3490{
3491 NOREF(pszArgs);
3492
3493 /*
3494 * Read the times first to avoid more than necessary time variation.
3495 */
3496 const uint64_t u64Virtual = TMVirtualGet(pVM);
3497 const uint64_t u64VirtualSync = TMVirtualSyncGet(pVM);
3498 const uint64_t u64Real = TMRealGet(pVM);
3499
3500 for (VMCPUID i = 0; i < pVM->cCpus; i++)
3501 {
3502 PVMCPU pVCpu = &pVM->aCpus[i];
3503 uint64_t u64TSC = TMCpuTickGet(pVCpu);
3504
3505 /*
3506 * TSC
3507 */
3508 pHlp->pfnPrintf(pHlp,
3509 "Cpu Tick: %18RU64 (%#016RX64) %RU64Hz %s - virtualized",
3510 u64TSC, u64TSC, TMCpuTicksPerSecond(pVM),
3511 pVCpu->tm.s.fTSCTicking ? "ticking" : "paused");
3512 if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
3513 {
3514 pHlp->pfnPrintf(pHlp, " - real tsc offset");
3515 if (pVCpu->tm.s.offTSCRawSrc)
3516 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVCpu->tm.s.offTSCRawSrc);
3517 }
3518 else
3519 pHlp->pfnPrintf(pHlp, " - virtual clock");
3520 pHlp->pfnPrintf(pHlp, "\n");
3521 }
3522
3523 /*
3524 * virtual
3525 */
3526 pHlp->pfnPrintf(pHlp,
3527 " Virtual: %18RU64 (%#016RX64) %RU64Hz %s",
3528 u64Virtual, u64Virtual, TMVirtualGetFreq(pVM),
3529 pVM->tm.s.cVirtualTicking ? "ticking" : "paused");
3530 if (pVM->tm.s.fVirtualWarpDrive)
3531 pHlp->pfnPrintf(pHlp, " WarpDrive %RU32 %%", pVM->tm.s.u32VirtualWarpDrivePercentage);
3532 pHlp->pfnPrintf(pHlp, "\n");
3533
3534 /*
3535 * virtual sync
3536 */
3537 pHlp->pfnPrintf(pHlp,
3538 "VirtSync: %18RU64 (%#016RX64) %s%s",
3539 u64VirtualSync, u64VirtualSync,
3540 pVM->tm.s.fVirtualSyncTicking ? "ticking" : "paused",
3541 pVM->tm.s.fVirtualSyncCatchUp ? " - catchup" : "");
3542 if (pVM->tm.s.offVirtualSync)
3543 {
3544 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVM->tm.s.offVirtualSync);
3545 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage)
3546 pHlp->pfnPrintf(pHlp, " catch-up rate %u %%", pVM->tm.s.u32VirtualSyncCatchUpPercentage);
3547 }
3548 pHlp->pfnPrintf(pHlp, "\n");
3549
3550 /*
3551 * real
3552 */
3553 pHlp->pfnPrintf(pHlp,
3554 " Real: %18RU64 (%#016RX64) %RU64Hz\n",
3555 u64Real, u64Real, TMRealGetFreq(pVM));
3556}
3557
3558
3559/**
3560 * Gets the descriptive TM TSC mode name given the enum value.
3561 *
3562 * @returns The name.
3563 * @param enmMode The mode to name.
3564 */
3565static const char *tmR3GetTSCModeNameEx(TMTSCMODE enmMode)
3566{
3567 switch (enmMode)
3568 {
3569 case TMTSCMODE_REAL_TSC_OFFSET: return "RealTscOffset";
3570 case TMTSCMODE_VIRT_TSC_EMULATED: return "VirtTscEmulated";
3571 case TMTSCMODE_DYNAMIC: return "Dynamic";
3572 default: return "???";
3573 }
3574}
3575
3576
3577/**
3578 * Gets the descriptive TM TSC mode name.
3579 *
3580 * @returns The name.
3581 * @param pVM The cross context VM structure.
3582 */
3583static const char *tmR3GetTSCModeName(PVM pVM)
3584{
3585 Assert(pVM);
3586 return tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode);
3587}
3588
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette