VirtualBox

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

Last change on this file since 69046 was 69046, checked in by vboxsync, 7 years ago

Global: replace fall-through comments with RT_FALL_THRU().
bugref:8192: gcc warnings

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 154.1 KB
Line 
1/* $Id: TM.cpp 69046 2017-10-11 16:11:23Z 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 /*
1181 * Reset TSC to avoid a Windows 8+ bug (see @bugref{8926}). If Windows
1182 * sees TSC value beyond 0x40000000000 at startup, it will reset the
1183 * TSC on boot-up CPU only, causing confusion and mayhem with SMP.
1184 */
1185 VM_ASSERT_EMT0(pVM);
1186 uint64_t offTscRawSrc;
1187 if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1188 offTscRawSrc = SUPReadTsc();
1189 else
1190 {
1191 offTscRawSrc = TMVirtualSyncGetNoCheck(pVM);
1192 offTscRawSrc = ASMMultU64ByU32DivByU32(offTscRawSrc, pVM->tm.s.cTSCTicksPerSecond, TMCLOCK_FREQ_VIRTUAL);
1193 }
1194 for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
1195 {
1196 pVM->aCpus[iCpu].tm.s.offTSCRawSrc = offTscRawSrc;
1197 pVM->aCpus[iCpu].tm.s.u64TSC = 0;
1198 pVM->aCpus[iCpu].tm.s.u64TSCLastSeen = 0;
1199 }
1200
1201 TM_UNLOCK_TIMERS(pVM);
1202}
1203
1204
1205/**
1206 * Resolve a builtin RC symbol.
1207 * Called by PDM when loading or relocating GC modules.
1208 *
1209 * @returns VBox status
1210 * @param pVM The cross context VM structure.
1211 * @param pszSymbol Symbol to resolve.
1212 * @param pRCPtrValue Where to store the symbol value.
1213 * @remark This has to work before TMR3Relocate() is called.
1214 */
1215VMM_INT_DECL(int) TMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue)
1216{
1217 if (!strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
1218 *pRCPtrValue = MMHyperR3ToRC(pVM, &pVM->tm.s.pvGIPRC);
1219 //else if (..)
1220 else
1221 return VERR_SYMBOL_NOT_FOUND;
1222 return VINF_SUCCESS;
1223}
1224
1225
1226/**
1227 * Execute state save operation.
1228 *
1229 * @returns VBox status code.
1230 * @param pVM The cross context VM structure.
1231 * @param pSSM SSM operation handle.
1232 */
1233static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM)
1234{
1235 LogFlow(("tmR3Save:\n"));
1236#ifdef VBOX_STRICT
1237 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1238 {
1239 PVMCPU pVCpu = &pVM->aCpus[i];
1240 Assert(!pVCpu->tm.s.fTSCTicking);
1241 }
1242 Assert(!pVM->tm.s.cVirtualTicking);
1243 Assert(!pVM->tm.s.fVirtualSyncTicking);
1244 Assert(!pVM->tm.s.cTSCsTicking);
1245#endif
1246
1247 /*
1248 * Save the virtual clocks.
1249 */
1250 /* the virtual clock. */
1251 SSMR3PutU64(pSSM, TMCLOCK_FREQ_VIRTUAL);
1252 SSMR3PutU64(pSSM, pVM->tm.s.u64Virtual);
1253
1254 /* the virtual timer synchronous clock. */
1255 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSync);
1256 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSync);
1257 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSyncGivenUp);
1258 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSyncCatchUpPrev);
1259 SSMR3PutBool(pSSM, pVM->tm.s.fVirtualSyncCatchUp);
1260
1261 /* real time clock */
1262 SSMR3PutU64(pSSM, TMCLOCK_FREQ_REAL);
1263
1264 /* the cpu tick clock. */
1265 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1266 {
1267 PVMCPU pVCpu = &pVM->aCpus[i];
1268 SSMR3PutU64(pSSM, TMCpuTickGet(pVCpu));
1269 }
1270 return SSMR3PutU64(pSSM, pVM->tm.s.cTSCTicksPerSecond);
1271}
1272
1273
1274/**
1275 * Execute state load operation.
1276 *
1277 * @returns VBox status code.
1278 * @param pVM The cross context VM structure.
1279 * @param pSSM SSM operation handle.
1280 * @param uVersion Data layout version.
1281 * @param uPass The data pass.
1282 */
1283static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1284{
1285 LogFlow(("tmR3Load:\n"));
1286
1287 Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
1288#ifdef VBOX_STRICT
1289 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1290 {
1291 PVMCPU pVCpu = &pVM->aCpus[i];
1292 Assert(!pVCpu->tm.s.fTSCTicking);
1293 }
1294 Assert(!pVM->tm.s.cVirtualTicking);
1295 Assert(!pVM->tm.s.fVirtualSyncTicking);
1296 Assert(!pVM->tm.s.cTSCsTicking);
1297#endif
1298
1299 /*
1300 * Validate version.
1301 */
1302 if (uVersion != TM_SAVED_STATE_VERSION)
1303 {
1304 AssertMsgFailed(("tmR3Load: Invalid version uVersion=%d!\n", uVersion));
1305 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1306 }
1307
1308 /*
1309 * Load the virtual clock.
1310 */
1311 pVM->tm.s.cVirtualTicking = 0;
1312 /* the virtual clock. */
1313 uint64_t u64Hz;
1314 int rc = SSMR3GetU64(pSSM, &u64Hz);
1315 if (RT_FAILURE(rc))
1316 return rc;
1317 if (u64Hz != TMCLOCK_FREQ_VIRTUAL)
1318 {
1319 AssertMsgFailed(("The virtual clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1320 u64Hz, TMCLOCK_FREQ_VIRTUAL));
1321 return VERR_SSM_VIRTUAL_CLOCK_HZ;
1322 }
1323 SSMR3GetU64(pSSM, &pVM->tm.s.u64Virtual);
1324 pVM->tm.s.u64VirtualOffset = 0;
1325
1326 /* the virtual timer synchronous clock. */
1327 pVM->tm.s.fVirtualSyncTicking = false;
1328 uint64_t u64;
1329 SSMR3GetU64(pSSM, &u64);
1330 pVM->tm.s.u64VirtualSync = u64;
1331 SSMR3GetU64(pSSM, &u64);
1332 pVM->tm.s.offVirtualSync = u64;
1333 SSMR3GetU64(pSSM, &u64);
1334 pVM->tm.s.offVirtualSyncGivenUp = u64;
1335 SSMR3GetU64(pSSM, &u64);
1336 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64;
1337 bool f;
1338 SSMR3GetBool(pSSM, &f);
1339 pVM->tm.s.fVirtualSyncCatchUp = f;
1340
1341 /* the real clock */
1342 rc = SSMR3GetU64(pSSM, &u64Hz);
1343 if (RT_FAILURE(rc))
1344 return rc;
1345 if (u64Hz != TMCLOCK_FREQ_REAL)
1346 {
1347 AssertMsgFailed(("The real clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1348 u64Hz, TMCLOCK_FREQ_REAL));
1349 return VERR_SSM_VIRTUAL_CLOCK_HZ; /* misleading... */
1350 }
1351
1352 /* the cpu tick clock. */
1353 pVM->tm.s.cTSCsTicking = 0;
1354 pVM->tm.s.offTSCPause = 0;
1355 pVM->tm.s.u64LastPausedTSC = 0;
1356 for (VMCPUID i = 0; i < pVM->cCpus; i++)
1357 {
1358 PVMCPU pVCpu = &pVM->aCpus[i];
1359
1360 pVCpu->tm.s.fTSCTicking = false;
1361 SSMR3GetU64(pSSM, &pVCpu->tm.s.u64TSC);
1362 if (pVM->tm.s.u64LastPausedTSC < pVCpu->tm.s.u64TSC)
1363 pVM->tm.s.u64LastPausedTSC = pVCpu->tm.s.u64TSC;
1364
1365 if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1366 pVCpu->tm.s.offTSCRawSrc = 0; /** @todo TSC restore stuff and HWACC. */
1367 }
1368
1369 rc = SSMR3GetU64(pSSM, &u64Hz);
1370 if (RT_FAILURE(rc))
1371 return rc;
1372 if (pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET)
1373 pVM->tm.s.cTSCTicksPerSecond = u64Hz;
1374
1375 LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%'RU64) enmTSCMode=%d (%s) (state load)\n",
1376 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM)));
1377
1378 /* Disabled as this isn't tested, also should this apply only if GIM is enabled etc. */
1379#if 0
1380 /*
1381 * If the current host TSC frequency is incompatible with what is in the
1382 * saved state of the VM, fall back to emulating TSC and disallow TSC mode
1383 * switches during VM runtime (e.g. by GIM).
1384 */
1385 if ( GIMIsEnabled(pVM)
1386 || pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1387 {
1388 uint64_t uGipCpuHz;
1389 bool fRelax = RTSystemIsInsideVM();
1390 bool fCompat = SUPIsTscFreqCompatible(pVM->tm.s.cTSCTicksPerSecond, &uGipCpuHz, fRelax);
1391 if (!fCompat)
1392 {
1393 pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
1394 pVM->tm.s.fTSCModeSwitchAllowed = false;
1395 if (g_pSUPGlobalInfoPage->u32Mode != SUPGIPMODE_ASYNC_TSC)
1396 {
1397 LogRel(("TM: TSC frequency incompatible! uGipCpuHz=%#RX64 (%'RU64) enmTSCMode=%d (%s) fTSCModeSwitchAllowed=%RTbool (state load)\n",
1398 uGipCpuHz, uGipCpuHz, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM), pVM->tm.s.fTSCModeSwitchAllowed));
1399 }
1400 else
1401 {
1402 LogRel(("TM: GIP is async, enmTSCMode=%d (%s) fTSCModeSwitchAllowed=%RTbool (state load)\n",
1403 uGipCpuHz, uGipCpuHz, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM), pVM->tm.s.fTSCModeSwitchAllowed));
1404 }
1405 }
1406 }
1407#endif
1408
1409 /*
1410 * Make sure timers get rescheduled immediately.
1411 */
1412 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1413 VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
1414
1415 return VINF_SUCCESS;
1416}
1417
1418
1419/**
1420 * Internal TMR3TimerCreate worker.
1421 *
1422 * @returns VBox status code.
1423 * @param pVM The cross context VM structure.
1424 * @param enmClock The timer clock.
1425 * @param pszDesc The timer description.
1426 * @param ppTimer Where to store the timer pointer on success.
1427 */
1428static int tmr3TimerCreate(PVM pVM, TMCLOCK enmClock, const char *pszDesc, PPTMTIMERR3 ppTimer)
1429{
1430 VM_ASSERT_EMT(pVM);
1431
1432 /*
1433 * Allocate the timer.
1434 */
1435 PTMTIMERR3 pTimer = NULL;
1436 if (pVM->tm.s.pFree && VM_IS_EMT(pVM))
1437 {
1438 pTimer = pVM->tm.s.pFree;
1439 pVM->tm.s.pFree = pTimer->pBigNext;
1440 Log3(("TM: Recycling timer %p, new free head %p.\n", pTimer, pTimer->pBigNext));
1441 }
1442
1443 if (!pTimer)
1444 {
1445 int rc = MMHyperAlloc(pVM, sizeof(*pTimer), 0, MM_TAG_TM, (void **)&pTimer);
1446 if (RT_FAILURE(rc))
1447 return rc;
1448 Log3(("TM: Allocated new timer %p\n", pTimer));
1449 }
1450
1451 /*
1452 * Initialize it.
1453 */
1454 pTimer->u64Expire = 0;
1455 pTimer->enmClock = enmClock;
1456 pTimer->pVMR3 = pVM;
1457 pTimer->pVMR0 = pVM->pVMR0;
1458 pTimer->pVMRC = pVM->pVMRC;
1459 pTimer->enmState = TMTIMERSTATE_STOPPED;
1460 pTimer->offScheduleNext = 0;
1461 pTimer->offNext = 0;
1462 pTimer->offPrev = 0;
1463 pTimer->pvUser = NULL;
1464 pTimer->pCritSect = NULL;
1465 pTimer->pszDesc = pszDesc;
1466
1467 /* insert into the list of created timers. */
1468 TM_LOCK_TIMERS(pVM);
1469 pTimer->pBigPrev = NULL;
1470 pTimer->pBigNext = pVM->tm.s.pCreated;
1471 pVM->tm.s.pCreated = pTimer;
1472 if (pTimer->pBigNext)
1473 pTimer->pBigNext->pBigPrev = pTimer;
1474#ifdef VBOX_STRICT
1475 tmTimerQueuesSanityChecks(pVM, "tmR3TimerCreate");
1476#endif
1477 TM_UNLOCK_TIMERS(pVM);
1478
1479 *ppTimer = pTimer;
1480 return VINF_SUCCESS;
1481}
1482
1483
1484/**
1485 * Creates a device timer.
1486 *
1487 * @returns VBox status code.
1488 * @param pVM The cross context VM structure.
1489 * @param pDevIns Device instance.
1490 * @param enmClock The clock to use on this timer.
1491 * @param pfnCallback Callback function.
1492 * @param pvUser The user argument to the callback.
1493 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
1494 * @param pszDesc Pointer to description string which must stay around
1495 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1496 * @param ppTimer Where to store the timer on success.
1497 */
1498VMM_INT_DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock,
1499 PFNTMTIMERDEV pfnCallback, void *pvUser,
1500 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1501{
1502 AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT)), VERR_INVALID_PARAMETER);
1503
1504 /*
1505 * Allocate and init stuff.
1506 */
1507 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1508 if (RT_SUCCESS(rc))
1509 {
1510 (*ppTimer)->enmType = TMTIMERTYPE_DEV;
1511 (*ppTimer)->u.Dev.pfnTimer = pfnCallback;
1512 (*ppTimer)->u.Dev.pDevIns = pDevIns;
1513 (*ppTimer)->pvUser = pvUser;
1514 if (!(fFlags & TMTIMER_FLAGS_NO_CRIT_SECT))
1515 (*ppTimer)->pCritSect = PDMR3DevGetCritSect(pVM, pDevIns);
1516 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1517 }
1518
1519 return rc;
1520}
1521
1522
1523
1524
1525/**
1526 * Creates a USB device timer.
1527 *
1528 * @returns VBox status code.
1529 * @param pVM The cross context VM structure.
1530 * @param pUsbIns The USB device instance.
1531 * @param enmClock The clock to use on this timer.
1532 * @param pfnCallback Callback function.
1533 * @param pvUser The user argument to the callback.
1534 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
1535 * @param pszDesc Pointer to description string which must stay around
1536 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1537 * @param ppTimer Where to store the timer on success.
1538 */
1539VMM_INT_DECL(int) TMR3TimerCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, TMCLOCK enmClock,
1540 PFNTMTIMERUSB pfnCallback, void *pvUser,
1541 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1542{
1543 AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT)), VERR_INVALID_PARAMETER);
1544
1545 /*
1546 * Allocate and init stuff.
1547 */
1548 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1549 if (RT_SUCCESS(rc))
1550 {
1551 (*ppTimer)->enmType = TMTIMERTYPE_USB;
1552 (*ppTimer)->u.Usb.pfnTimer = pfnCallback;
1553 (*ppTimer)->u.Usb.pUsbIns = pUsbIns;
1554 (*ppTimer)->pvUser = pvUser;
1555 //if (!(fFlags & TMTIMER_FLAGS_NO_CRIT_SECT))
1556 //{
1557 // if (pDevIns->pCritSectR3)
1558 // (*ppTimer)->pCritSect = pUsbIns->pCritSectR3;
1559 // else
1560 // (*ppTimer)->pCritSect = IOMR3GetCritSect(pVM);
1561 //}
1562 Log(("TM: Created USB device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1563 }
1564
1565 return rc;
1566}
1567
1568
1569/**
1570 * Creates a driver timer.
1571 *
1572 * @returns VBox status code.
1573 * @param pVM The cross context VM structure.
1574 * @param pDrvIns Driver instance.
1575 * @param enmClock The clock to use on this timer.
1576 * @param pfnCallback Callback function.
1577 * @param pvUser The user argument to the callback.
1578 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
1579 * @param pszDesc Pointer to description string which must stay around
1580 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1581 * @param ppTimer Where to store the timer on success.
1582 */
1583VMM_INT_DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1584 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1585{
1586 AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT)), VERR_INVALID_PARAMETER);
1587
1588 /*
1589 * Allocate and init stuff.
1590 */
1591 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1592 if (RT_SUCCESS(rc))
1593 {
1594 (*ppTimer)->enmType = TMTIMERTYPE_DRV;
1595 (*ppTimer)->u.Drv.pfnTimer = pfnCallback;
1596 (*ppTimer)->u.Drv.pDrvIns = pDrvIns;
1597 (*ppTimer)->pvUser = pvUser;
1598 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1599 }
1600
1601 return rc;
1602}
1603
1604
1605/**
1606 * Creates an internal timer.
1607 *
1608 * @returns VBox status code.
1609 * @param pVM The cross context VM structure.
1610 * @param enmClock The clock to use on this timer.
1611 * @param pfnCallback Callback function.
1612 * @param pvUser User argument to be passed to the callback.
1613 * @param pszDesc Pointer to description string which must stay around
1614 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1615 * @param ppTimer Where to store the timer on success.
1616 */
1617VMMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer)
1618{
1619 /*
1620 * Allocate and init stuff.
1621 */
1622 PTMTIMER pTimer;
1623 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1624 if (RT_SUCCESS(rc))
1625 {
1626 pTimer->enmType = TMTIMERTYPE_INTERNAL;
1627 pTimer->u.Internal.pfnTimer = pfnCallback;
1628 pTimer->pvUser = pvUser;
1629 *ppTimer = pTimer;
1630 Log(("TM: Created internal timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1631 }
1632
1633 return rc;
1634}
1635
1636/**
1637 * Creates an external timer.
1638 *
1639 * @returns Timer handle on success.
1640 * @returns NULL on failure.
1641 * @param pVM The cross context VM structure.
1642 * @param enmClock The clock to use on this timer.
1643 * @param pfnCallback Callback function.
1644 * @param pvUser User argument.
1645 * @param pszDesc Pointer to description string which must stay around
1646 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1647 */
1648VMMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc)
1649{
1650 /*
1651 * Allocate and init stuff.
1652 */
1653 PTMTIMERR3 pTimer;
1654 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1655 if (RT_SUCCESS(rc))
1656 {
1657 pTimer->enmType = TMTIMERTYPE_EXTERNAL;
1658 pTimer->u.External.pfnTimer = pfnCallback;
1659 pTimer->pvUser = pvUser;
1660 Log(("TM: Created external timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1661 return pTimer;
1662 }
1663
1664 return NULL;
1665}
1666
1667
1668/**
1669 * Destroy a timer
1670 *
1671 * @returns VBox status code.
1672 * @param pTimer Timer handle as returned by one of the create functions.
1673 */
1674VMMR3DECL(int) TMR3TimerDestroy(PTMTIMER pTimer)
1675{
1676 /*
1677 * Be extra careful here.
1678 */
1679 if (!pTimer)
1680 return VINF_SUCCESS;
1681 AssertPtr(pTimer);
1682 Assert((unsigned)pTimer->enmClock < (unsigned)TMCLOCK_MAX);
1683
1684 PVM pVM = pTimer->CTX_SUFF(pVM);
1685 PTMTIMERQUEUE pQueue = &pVM->tm.s.CTX_SUFF(paTimerQueues)[pTimer->enmClock];
1686 bool fActive = false;
1687 bool fPending = false;
1688
1689 AssertMsg( !pTimer->pCritSect
1690 || VMR3GetState(pVM) != VMSTATE_RUNNING
1691 || PDMCritSectIsOwner(pTimer->pCritSect), ("%s\n", pTimer->pszDesc));
1692
1693 /*
1694 * The rest of the game happens behind the lock, just
1695 * like create does. All the work is done here.
1696 */
1697 TM_LOCK_TIMERS(pVM);
1698 for (int cRetries = 1000;; cRetries--)
1699 {
1700 /*
1701 * Change to the DESTROY state.
1702 */
1703 TMTIMERSTATE const enmState = pTimer->enmState;
1704 Log2(("TMTimerDestroy: %p:{.enmState=%s, .pszDesc='%s'} cRetries=%d\n",
1705 pTimer, tmTimerState(enmState), R3STRING(pTimer->pszDesc), cRetries));
1706 switch (enmState)
1707 {
1708 case TMTIMERSTATE_STOPPED:
1709 case TMTIMERSTATE_EXPIRED_DELIVER:
1710 break;
1711
1712 case TMTIMERSTATE_ACTIVE:
1713 fActive = true;
1714 break;
1715
1716 case TMTIMERSTATE_PENDING_STOP:
1717 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
1718 case TMTIMERSTATE_PENDING_RESCHEDULE:
1719 fActive = true;
1720 fPending = true;
1721 break;
1722
1723 case TMTIMERSTATE_PENDING_SCHEDULE:
1724 fPending = true;
1725 break;
1726
1727 /*
1728 * This shouldn't happen as the caller should make sure there are no races.
1729 */
1730 case TMTIMERSTATE_EXPIRED_GET_UNLINK:
1731 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
1732 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
1733 AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1734 TM_UNLOCK_TIMERS(pVM);
1735 if (!RTThreadYield())
1736 RTThreadSleep(1);
1737 AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1738 VERR_TM_UNSTABLE_STATE);
1739 TM_LOCK_TIMERS(pVM);
1740 continue;
1741
1742 /*
1743 * Invalid states.
1744 */
1745 case TMTIMERSTATE_FREE:
1746 case TMTIMERSTATE_DESTROY:
1747 TM_UNLOCK_TIMERS(pVM);
1748 AssertLogRelMsgFailedReturn(("pTimer=%p %s\n", pTimer, tmTimerState(enmState)), VERR_TM_INVALID_STATE);
1749
1750 default:
1751 AssertMsgFailed(("Unknown timer state %d (%s)\n", enmState, R3STRING(pTimer->pszDesc)));
1752 TM_UNLOCK_TIMERS(pVM);
1753 return VERR_TM_UNKNOWN_STATE;
1754 }
1755
1756 /*
1757 * Try switch to the destroy state.
1758 * This should always succeed as the caller should make sure there are no race.
1759 */
1760 bool fRc;
1761 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_DESTROY, enmState, fRc);
1762 if (fRc)
1763 break;
1764 AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1765 TM_UNLOCK_TIMERS(pVM);
1766 AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1767 VERR_TM_UNSTABLE_STATE);
1768 TM_LOCK_TIMERS(pVM);
1769 }
1770
1771 /*
1772 * Unlink from the active list.
1773 */
1774 if (fActive)
1775 {
1776 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1777 const PTMTIMER pNext = TMTIMER_GET_NEXT(pTimer);
1778 if (pPrev)
1779 TMTIMER_SET_NEXT(pPrev, pNext);
1780 else
1781 {
1782 TMTIMER_SET_HEAD(pQueue, pNext);
1783 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1784 }
1785 if (pNext)
1786 TMTIMER_SET_PREV(pNext, pPrev);
1787 pTimer->offNext = 0;
1788 pTimer->offPrev = 0;
1789 }
1790
1791 /*
1792 * Unlink from the schedule list by running it.
1793 */
1794 if (fPending)
1795 {
1796 Log3(("TMR3TimerDestroy: tmTimerQueueSchedule\n"));
1797 STAM_PROFILE_START(&pVM->tm.s.CTX_SUFF_Z(StatScheduleOne), a);
1798 Assert(pQueue->offSchedule);
1799 tmTimerQueueSchedule(pVM, pQueue);
1800 STAM_PROFILE_STOP(&pVM->tm.s.CTX_SUFF_Z(StatScheduleOne), a);
1801 }
1802
1803 /*
1804 * Read to move the timer from the created list and onto the free list.
1805 */
1806 Assert(!pTimer->offNext); Assert(!pTimer->offPrev); Assert(!pTimer->offScheduleNext);
1807
1808 /* unlink from created list */
1809 if (pTimer->pBigPrev)
1810 pTimer->pBigPrev->pBigNext = pTimer->pBigNext;
1811 else
1812 pVM->tm.s.pCreated = pTimer->pBigNext;
1813 if (pTimer->pBigNext)
1814 pTimer->pBigNext->pBigPrev = pTimer->pBigPrev;
1815 pTimer->pBigNext = 0;
1816 pTimer->pBigPrev = 0;
1817
1818 /* free */
1819 Log2(("TM: Inserting %p into the free list ahead of %p!\n", pTimer, pVM->tm.s.pFree));
1820 TM_SET_STATE(pTimer, TMTIMERSTATE_FREE);
1821 pTimer->pBigNext = pVM->tm.s.pFree;
1822 pVM->tm.s.pFree = pTimer;
1823
1824#ifdef VBOX_STRICT
1825 tmTimerQueuesSanityChecks(pVM, "TMR3TimerDestroy");
1826#endif
1827 TM_UNLOCK_TIMERS(pVM);
1828 return VINF_SUCCESS;
1829}
1830
1831
1832/**
1833 * Destroy all timers owned by a device.
1834 *
1835 * @returns VBox status code.
1836 * @param pVM The cross context VM structure.
1837 * @param pDevIns Device which timers should be destroyed.
1838 */
1839VMM_INT_DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns)
1840{
1841 LogFlow(("TMR3TimerDestroyDevice: pDevIns=%p\n", pDevIns));
1842 if (!pDevIns)
1843 return VERR_INVALID_PARAMETER;
1844
1845 TM_LOCK_TIMERS(pVM);
1846 PTMTIMER pCur = pVM->tm.s.pCreated;
1847 while (pCur)
1848 {
1849 PTMTIMER pDestroy = pCur;
1850 pCur = pDestroy->pBigNext;
1851 if ( pDestroy->enmType == TMTIMERTYPE_DEV
1852 && pDestroy->u.Dev.pDevIns == pDevIns)
1853 {
1854 int rc = TMR3TimerDestroy(pDestroy);
1855 AssertRC(rc);
1856 }
1857 }
1858 TM_UNLOCK_TIMERS(pVM);
1859
1860 LogFlow(("TMR3TimerDestroyDevice: returns VINF_SUCCESS\n"));
1861 return VINF_SUCCESS;
1862}
1863
1864
1865/**
1866 * Destroy all timers owned by a USB device.
1867 *
1868 * @returns VBox status code.
1869 * @param pVM The cross context VM structure.
1870 * @param pUsbIns USB device which timers should be destroyed.
1871 */
1872VMM_INT_DECL(int) TMR3TimerDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns)
1873{
1874 LogFlow(("TMR3TimerDestroyUsb: pUsbIns=%p\n", pUsbIns));
1875 if (!pUsbIns)
1876 return VERR_INVALID_PARAMETER;
1877
1878 TM_LOCK_TIMERS(pVM);
1879 PTMTIMER pCur = pVM->tm.s.pCreated;
1880 while (pCur)
1881 {
1882 PTMTIMER pDestroy = pCur;
1883 pCur = pDestroy->pBigNext;
1884 if ( pDestroy->enmType == TMTIMERTYPE_USB
1885 && pDestroy->u.Usb.pUsbIns == pUsbIns)
1886 {
1887 int rc = TMR3TimerDestroy(pDestroy);
1888 AssertRC(rc);
1889 }
1890 }
1891 TM_UNLOCK_TIMERS(pVM);
1892
1893 LogFlow(("TMR3TimerDestroyUsb: returns VINF_SUCCESS\n"));
1894 return VINF_SUCCESS;
1895}
1896
1897
1898/**
1899 * Destroy all timers owned by a driver.
1900 *
1901 * @returns VBox status code.
1902 * @param pVM The cross context VM structure.
1903 * @param pDrvIns Driver which timers should be destroyed.
1904 */
1905VMM_INT_DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns)
1906{
1907 LogFlow(("TMR3TimerDestroyDriver: pDrvIns=%p\n", pDrvIns));
1908 if (!pDrvIns)
1909 return VERR_INVALID_PARAMETER;
1910
1911 TM_LOCK_TIMERS(pVM);
1912 PTMTIMER pCur = pVM->tm.s.pCreated;
1913 while (pCur)
1914 {
1915 PTMTIMER pDestroy = pCur;
1916 pCur = pDestroy->pBigNext;
1917 if ( pDestroy->enmType == TMTIMERTYPE_DRV
1918 && pDestroy->u.Drv.pDrvIns == pDrvIns)
1919 {
1920 int rc = TMR3TimerDestroy(pDestroy);
1921 AssertRC(rc);
1922 }
1923 }
1924 TM_UNLOCK_TIMERS(pVM);
1925
1926 LogFlow(("TMR3TimerDestroyDriver: returns VINF_SUCCESS\n"));
1927 return VINF_SUCCESS;
1928}
1929
1930
1931/**
1932 * Internal function for getting the clock time.
1933 *
1934 * @returns clock time.
1935 * @param pVM The cross context VM structure.
1936 * @param enmClock The clock.
1937 */
1938DECLINLINE(uint64_t) tmClock(PVM pVM, TMCLOCK enmClock)
1939{
1940 switch (enmClock)
1941 {
1942 case TMCLOCK_VIRTUAL: return TMVirtualGet(pVM);
1943 case TMCLOCK_VIRTUAL_SYNC: return TMVirtualSyncGet(pVM);
1944 case TMCLOCK_REAL: return TMRealGet(pVM);
1945 case TMCLOCK_TSC: return TMCpuTickGet(&pVM->aCpus[0] /* just take VCPU 0 */);
1946 default:
1947 AssertMsgFailed(("enmClock=%d\n", enmClock));
1948 return ~(uint64_t)0;
1949 }
1950}
1951
1952
1953/**
1954 * Checks if the sync queue has one or more expired timers.
1955 *
1956 * @returns true / false.
1957 *
1958 * @param pVM The cross context VM structure.
1959 * @param enmClock The queue.
1960 */
1961DECLINLINE(bool) tmR3HasExpiredTimer(PVM pVM, TMCLOCK enmClock)
1962{
1963 const uint64_t u64Expire = pVM->tm.s.CTX_SUFF(paTimerQueues)[enmClock].u64Expire;
1964 return u64Expire != INT64_MAX && u64Expire <= tmClock(pVM, enmClock);
1965}
1966
1967
1968/**
1969 * Checks for expired timers in all the queues.
1970 *
1971 * @returns true / false.
1972 * @param pVM The cross context VM structure.
1973 */
1974DECLINLINE(bool) tmR3AnyExpiredTimers(PVM pVM)
1975{
1976 /*
1977 * Combine the time calculation for the first two since we're not on EMT
1978 * TMVirtualSyncGet only permits EMT.
1979 */
1980 uint64_t u64Now = TMVirtualGetNoCheck(pVM);
1981 if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL].u64Expire <= u64Now)
1982 return true;
1983 u64Now = pVM->tm.s.fVirtualSyncTicking
1984 ? u64Now - pVM->tm.s.offVirtualSync
1985 : pVM->tm.s.u64VirtualSync;
1986 if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL_SYNC].u64Expire <= u64Now)
1987 return true;
1988
1989 /*
1990 * The remaining timers.
1991 */
1992 if (tmR3HasExpiredTimer(pVM, TMCLOCK_REAL))
1993 return true;
1994 if (tmR3HasExpiredTimer(pVM, TMCLOCK_TSC))
1995 return true;
1996 return false;
1997}
1998
1999
2000/**
2001 * Schedule timer callback.
2002 *
2003 * @param pTimer Timer handle.
2004 * @param pvUser Pointer to the VM.
2005 * @thread Timer thread.
2006 *
2007 * @remark We cannot do the scheduling and queues running from a timer handler
2008 * since it's not executing in EMT, and even if it was it would be async
2009 * and we wouldn't know the state of the affairs.
2010 * So, we'll just raise the timer FF and force any REM execution to exit.
2011 */
2012static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t /*iTick*/)
2013{
2014 PVM pVM = (PVM)pvUser;
2015 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
2016 NOREF(pTimer);
2017
2018 AssertCompile(TMCLOCK_MAX == 4);
2019 STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallback);
2020
2021#ifdef DEBUG_Sander /* very annoying, keep it private. */
2022 if (VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER))
2023 Log(("tmR3TimerCallback: timer event still pending!!\n"));
2024#endif
2025 if ( !VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER)
2026 && ( pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule /** @todo FIXME - reconsider offSchedule as a reason for running the timer queues. */
2027 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule
2028 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule
2029 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offSchedule
2030 || tmR3AnyExpiredTimers(pVM)
2031 )
2032 && !VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER)
2033 && !pVM->tm.s.fRunningQueues
2034 )
2035 {
2036 Log5(("TM(%u): FF: 0 -> 1\n", __LINE__));
2037 VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
2038#ifdef VBOX_WITH_REM
2039 REMR3NotifyTimerPending(pVM, pVCpuDst);
2040#endif
2041 VMR3NotifyCpuFFU(pVCpuDst->pUVCpu, VMNOTIFYFF_FLAGS_DONE_REM | VMNOTIFYFF_FLAGS_POKE);
2042 STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallbackSetFF);
2043 }
2044}
2045
2046
2047/**
2048 * Schedules and runs any pending timers.
2049 *
2050 * This is normally called from a forced action handler in EMT.
2051 *
2052 * @param pVM The cross context VM structure.
2053 *
2054 * @thread EMT (actually EMT0, but we fend off the others)
2055 */
2056VMMR3DECL(void) TMR3TimerQueuesDo(PVM pVM)
2057{
2058 /*
2059 * Only the dedicated timer EMT should do stuff here.
2060 * (fRunningQueues is only used as an indicator.)
2061 */
2062 Assert(pVM->tm.s.idTimerCpu < pVM->cCpus);
2063 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
2064 if (VMMGetCpu(pVM) != pVCpuDst)
2065 {
2066 Assert(pVM->cCpus > 1);
2067 return;
2068 }
2069 STAM_PROFILE_START(&pVM->tm.s.StatDoQueues, a);
2070 Log2(("TMR3TimerQueuesDo:\n"));
2071 Assert(!pVM->tm.s.fRunningQueues);
2072 ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, true);
2073 TM_LOCK_TIMERS(pVM);
2074
2075 /*
2076 * Process the queues.
2077 */
2078 AssertCompile(TMCLOCK_MAX == 4);
2079
2080 /* TMCLOCK_VIRTUAL_SYNC (see also TMR3VirtualSyncFF) */
2081 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
2082 PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2083 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2084 VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /* Clear the FF once we started working for real. */
2085
2086 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule);
2087 tmR3TimerQueueRunVirtualSync(pVM);
2088 if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2089 VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2090
2091 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2092 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2093 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
2094
2095 /* TMCLOCK_VIRTUAL */
2096 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
2097 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule)
2098 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
2099 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
2100 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
2101
2102 /* TMCLOCK_TSC */
2103 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offActive); /* not used */
2104
2105 /* TMCLOCK_REAL */
2106 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
2107 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule)
2108 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
2109 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
2110 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
2111
2112#ifdef VBOX_STRICT
2113 /* check that we didn't screw up. */
2114 tmTimerQueuesSanityChecks(pVM, "TMR3TimerQueuesDo");
2115#endif
2116
2117 /* done */
2118 Log2(("TMR3TimerQueuesDo: returns void\n"));
2119 ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, false);
2120 TM_UNLOCK_TIMERS(pVM);
2121 STAM_PROFILE_STOP(&pVM->tm.s.StatDoQueues, a);
2122}
2123
2124//RT_C_DECLS_BEGIN
2125//int iomLock(PVM pVM);
2126//void iomUnlock(PVM pVM);
2127//RT_C_DECLS_END
2128
2129
2130/**
2131 * Schedules and runs any pending times in the specified queue.
2132 *
2133 * This is normally called from a forced action handler in EMT.
2134 *
2135 * @param pVM The cross context VM structure.
2136 * @param pQueue The queue to run.
2137 */
2138static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue)
2139{
2140 VM_ASSERT_EMT(pVM);
2141
2142 /*
2143 * Run timers.
2144 *
2145 * We check the clock once and run all timers which are ACTIVE
2146 * and have an expire time less or equal to the time we read.
2147 *
2148 * N.B. A generic unlink must be applied since other threads
2149 * are allowed to mess with any active timer at any time.
2150 * However, we only allow EMT to handle EXPIRED_PENDING
2151 * timers, thus enabling the timer handler function to
2152 * arm the timer again.
2153 */
2154 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
2155 if (!pNext)
2156 return;
2157 const uint64_t u64Now = tmClock(pVM, pQueue->enmClock);
2158 while (pNext && pNext->u64Expire <= u64Now)
2159 {
2160 PTMTIMER pTimer = pNext;
2161 pNext = TMTIMER_GET_NEXT(pTimer);
2162 PPDMCRITSECT pCritSect = pTimer->pCritSect;
2163 if (pCritSect)
2164 PDMCritSectEnter(pCritSect, VERR_IGNORED);
2165 Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
2166 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
2167 bool fRc;
2168 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_GET_UNLINK, TMTIMERSTATE_ACTIVE, fRc);
2169 if (fRc)
2170 {
2171 Assert(!pTimer->offScheduleNext); /* this can trigger falsely */
2172
2173 /* unlink */
2174 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
2175 if (pPrev)
2176 TMTIMER_SET_NEXT(pPrev, pNext);
2177 else
2178 {
2179 TMTIMER_SET_HEAD(pQueue, pNext);
2180 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
2181 }
2182 if (pNext)
2183 TMTIMER_SET_PREV(pNext, pPrev);
2184 pTimer->offNext = 0;
2185 pTimer->offPrev = 0;
2186
2187 /* fire */
2188 TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2189 switch (pTimer->enmType)
2190 {
2191 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer, pTimer->pvUser); break;
2192 case TMTIMERTYPE_USB: pTimer->u.Usb.pfnTimer(pTimer->u.Usb.pUsbIns, pTimer, pTimer->pvUser); break;
2193 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer, pTimer->pvUser); break;
2194 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->pvUser); break;
2195 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->pvUser); break;
2196 default:
2197 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2198 break;
2199 }
2200
2201 /* change the state if it wasn't changed already in the handler. */
2202 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2203 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2204 }
2205 if (pCritSect)
2206 PDMCritSectLeave(pCritSect);
2207 } /* run loop */
2208}
2209
2210
2211/**
2212 * Schedules and runs any pending times in the timer queue for the
2213 * synchronous virtual clock.
2214 *
2215 * This scheduling is a bit different from the other queues as it need
2216 * to implement the special requirements of the timer synchronous virtual
2217 * clock, thus this 2nd queue run function.
2218 *
2219 * @param pVM The cross context VM structure.
2220 *
2221 * @remarks The caller must the Virtual Sync lock. Owning the TM lock is no
2222 * longer important.
2223 */
2224static void tmR3TimerQueueRunVirtualSync(PVM pVM)
2225{
2226 PTMTIMERQUEUE const pQueue = &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC];
2227 VM_ASSERT_EMT(pVM);
2228 Assert(PDMCritSectIsOwner(&pVM->tm.s.VirtualSyncLock));
2229
2230 /*
2231 * Any timers?
2232 */
2233 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
2234 if (RT_UNLIKELY(!pNext))
2235 {
2236 Assert(pVM->tm.s.fVirtualSyncTicking || !pVM->tm.s.cVirtualTicking);
2237 return;
2238 }
2239 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRun);
2240
2241 /*
2242 * Calculate the time frame for which we will dispatch timers.
2243 *
2244 * We use a time frame ranging from the current sync time (which is most likely the
2245 * same as the head timer) and some configurable period (100000ns) up towards the
2246 * current virtual time. This period might also need to be restricted by the catch-up
2247 * rate so frequent calls to this function won't accelerate the time too much, however
2248 * this will be implemented at a later point if necessary.
2249 *
2250 * Without this frame we would 1) having to run timers much more frequently
2251 * and 2) lag behind at a steady rate.
2252 */
2253 const uint64_t u64VirtualNow = TMVirtualGetNoCheck(pVM);
2254 uint64_t const offSyncGivenUp = pVM->tm.s.offVirtualSyncGivenUp;
2255 uint64_t u64Now;
2256 if (!pVM->tm.s.fVirtualSyncTicking)
2257 {
2258 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStoppedAlready);
2259 u64Now = pVM->tm.s.u64VirtualSync;
2260 Assert(u64Now <= pNext->u64Expire);
2261 }
2262 else
2263 {
2264 /* Calc 'now'. */
2265 bool fStopCatchup = false;
2266 bool fUpdateStuff = false;
2267 uint64_t off = pVM->tm.s.offVirtualSync;
2268 if (pVM->tm.s.fVirtualSyncCatchUp)
2269 {
2270 uint64_t u64Delta = u64VirtualNow - pVM->tm.s.u64VirtualSyncCatchUpPrev;
2271 if (RT_LIKELY(!(u64Delta >> 32)))
2272 {
2273 uint64_t u64Sub = ASMMultU64ByU32DivByU32(u64Delta, pVM->tm.s.u32VirtualSyncCatchUpPercentage, 100);
2274 if (off > u64Sub + offSyncGivenUp)
2275 {
2276 off -= u64Sub;
2277 Log4(("TM: %'RU64/-%'8RU64: sub %'RU64 [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow - off, off - offSyncGivenUp, u64Sub));
2278 }
2279 else
2280 {
2281 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2282 fStopCatchup = true;
2283 off = offSyncGivenUp;
2284 }
2285 fUpdateStuff = true;
2286 }
2287 }
2288 u64Now = u64VirtualNow - off;
2289
2290 /* Adjust against last returned time. */
2291 uint64_t u64Last = ASMAtomicUoReadU64(&pVM->tm.s.u64VirtualSync);
2292 if (u64Last > u64Now)
2293 {
2294 u64Now = u64Last + 1;
2295 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGetAdjLast);
2296 }
2297
2298 /* Check if stopped by expired timer. */
2299 uint64_t const u64Expire = pNext->u64Expire;
2300 if (u64Now >= u64Expire)
2301 {
2302 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStop);
2303 u64Now = u64Expire;
2304 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2305 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
2306 Log4(("TM: %'RU64/-%'8RU64: exp tmr [tmR3TimerQueueRunVirtualSync]\n", u64Now, u64VirtualNow - u64Now - offSyncGivenUp));
2307 }
2308 else
2309 {
2310 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2311 if (fUpdateStuff)
2312 {
2313 ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, off);
2314 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSyncCatchUpPrev, u64VirtualNow);
2315 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2316 if (fStopCatchup)
2317 {
2318 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2319 Log4(("TM: %'RU64/0: caught up [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow));
2320 }
2321 }
2322 }
2323 }
2324
2325 /* calc end of frame. */
2326 uint64_t u64Max = u64Now + pVM->tm.s.u32VirtualSyncScheduleSlack;
2327 if (u64Max > u64VirtualNow - offSyncGivenUp)
2328 u64Max = u64VirtualNow - offSyncGivenUp;
2329
2330 /* assert sanity */
2331 Assert(u64Now <= u64VirtualNow - offSyncGivenUp);
2332 Assert(u64Max <= u64VirtualNow - offSyncGivenUp);
2333 Assert(u64Now <= u64Max);
2334 Assert(offSyncGivenUp == pVM->tm.s.offVirtualSyncGivenUp);
2335
2336 /*
2337 * Process the expired timers moving the clock along as we progress.
2338 */
2339#ifdef VBOX_STRICT
2340 uint64_t u64Prev = u64Now; NOREF(u64Prev);
2341#endif
2342 while (pNext && pNext->u64Expire <= u64Max)
2343 {
2344 /* Advance */
2345 PTMTIMER pTimer = pNext;
2346 pNext = TMTIMER_GET_NEXT(pTimer);
2347
2348 /* Take the associated lock. */
2349 PPDMCRITSECT pCritSect = pTimer->pCritSect;
2350 if (pCritSect)
2351 PDMCritSectEnter(pCritSect, VERR_IGNORED);
2352
2353 Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
2354 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
2355
2356 /* Advance the clock - don't permit timers to be out of order or armed
2357 in the 'past'. */
2358#ifdef VBOX_STRICT
2359 AssertMsg(pTimer->u64Expire >= u64Prev, ("%'RU64 < %'RU64 %s\n", pTimer->u64Expire, u64Prev, pTimer->pszDesc));
2360 u64Prev = pTimer->u64Expire;
2361#endif
2362 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, pTimer->u64Expire);
2363 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
2364
2365 /* Unlink it, change the state and do the callout. */
2366 tmTimerQueueUnlinkActive(pQueue, pTimer);
2367 TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2368 switch (pTimer->enmType)
2369 {
2370 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer, pTimer->pvUser); break;
2371 case TMTIMERTYPE_USB: pTimer->u.Usb.pfnTimer(pTimer->u.Usb.pUsbIns, pTimer, pTimer->pvUser); break;
2372 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer, pTimer->pvUser); break;
2373 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->pvUser); break;
2374 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->pvUser); break;
2375 default:
2376 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2377 break;
2378 }
2379
2380 /* Change the state if it wasn't changed already in the handler.
2381 Reset the Hz hint too since this is the same as TMTimerStop. */
2382 bool fRc;
2383 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2384 if (fRc && pTimer->uHzHint)
2385 {
2386 if (pTimer->uHzHint >= pVM->tm.s.uMaxHzHint)
2387 ASMAtomicWriteBool(&pVM->tm.s.fHzHintNeedsUpdating, true);
2388 pTimer->uHzHint = 0;
2389 }
2390 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2391
2392 /* Leave the associated lock. */
2393 if (pCritSect)
2394 PDMCritSectLeave(pCritSect);
2395 } /* run loop */
2396
2397
2398 /*
2399 * Restart the clock if it was stopped to serve any timers,
2400 * and start/adjust catch-up if necessary.
2401 */
2402 if ( !pVM->tm.s.fVirtualSyncTicking
2403 && pVM->tm.s.cVirtualTicking)
2404 {
2405 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunRestart);
2406
2407 /* calc the slack we've handed out. */
2408 const uint64_t u64VirtualNow2 = TMVirtualGetNoCheck(pVM);
2409 Assert(u64VirtualNow2 >= u64VirtualNow);
2410 AssertMsg(pVM->tm.s.u64VirtualSync >= u64Now, ("%'RU64 < %'RU64\n", pVM->tm.s.u64VirtualSync, u64Now));
2411 const uint64_t offSlack = pVM->tm.s.u64VirtualSync - u64Now;
2412 STAM_STATS({
2413 if (offSlack)
2414 {
2415 PSTAMPROFILE p = &pVM->tm.s.StatVirtualSyncRunSlack;
2416 p->cPeriods++;
2417 p->cTicks += offSlack;
2418 if (p->cTicksMax < offSlack) p->cTicksMax = offSlack;
2419 if (p->cTicksMin > offSlack) p->cTicksMin = offSlack;
2420 }
2421 });
2422
2423 /* Let the time run a little bit while we were busy running timers(?). */
2424 uint64_t u64Elapsed;
2425#define MAX_ELAPSED 30000U /* ns */
2426 if (offSlack > MAX_ELAPSED)
2427 u64Elapsed = 0;
2428 else
2429 {
2430 u64Elapsed = u64VirtualNow2 - u64VirtualNow;
2431 if (u64Elapsed > MAX_ELAPSED)
2432 u64Elapsed = MAX_ELAPSED;
2433 u64Elapsed = u64Elapsed > offSlack ? u64Elapsed - offSlack : 0;
2434 }
2435#undef MAX_ELAPSED
2436
2437 /* Calc the current offset. */
2438 uint64_t offNew = u64VirtualNow2 - pVM->tm.s.u64VirtualSync - u64Elapsed;
2439 Assert(!(offNew & RT_BIT_64(63)));
2440 uint64_t offLag = offNew - pVM->tm.s.offVirtualSyncGivenUp;
2441 Assert(!(offLag & RT_BIT_64(63)));
2442
2443 /*
2444 * Deal with starting, adjusting and stopping catchup.
2445 */
2446 if (pVM->tm.s.fVirtualSyncCatchUp)
2447 {
2448 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpStopThreshold)
2449 {
2450 /* stop */
2451 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2452 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2453 Log4(("TM: %'RU64/-%'8RU64: caught up [pt]\n", u64VirtualNow2 - offNew, offLag));
2454 }
2455 else if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2456 {
2457 /* adjust */
2458 unsigned i = 0;
2459 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2460 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2461 i++;
2462 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage < pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage)
2463 {
2464 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupAdjust[i]);
2465 ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2466 Log4(("TM: %'RU64/%'8RU64: adj %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2467 }
2468 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64VirtualNow2;
2469 }
2470 else
2471 {
2472 /* give up */
2473 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUp);
2474 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2475 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2476 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2477 Log4(("TM: %'RU64/%'8RU64: give up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2478 LogRel(("TM: Giving up catch-up attempt at a %'RU64 ns lag; new total: %'RU64 ns\n", offLag, offNew));
2479 }
2480 }
2481 else if (offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[0].u64Start)
2482 {
2483 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2484 {
2485 /* start */
2486 STAM_PROFILE_ADV_START(&pVM->tm.s.StatVirtualSyncCatchup, c);
2487 unsigned i = 0;
2488 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2489 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2490 i++;
2491 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupInitial[i]);
2492 ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2493 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, true);
2494 Log4(("TM: %'RU64/%'8RU64: catch-up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2495 }
2496 else
2497 {
2498 /* don't bother */
2499 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUpBeforeStarting);
2500 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2501 Log4(("TM: %'RU64/%'8RU64: give up\n", u64VirtualNow2 - offNew, offLag));
2502 LogRel(("TM: Not bothering to attempt catching up a %'RU64 ns lag; new total: %'RU64\n", offLag, offNew));
2503 }
2504 }
2505
2506 /*
2507 * Update the offset and restart the clock.
2508 */
2509 Assert(!(offNew & RT_BIT_64(63)));
2510 ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, offNew);
2511 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, true);
2512 }
2513}
2514
2515
2516/**
2517 * Deals with stopped Virtual Sync clock.
2518 *
2519 * This is called by the forced action flag handling code in EM when it
2520 * encounters the VM_FF_TM_VIRTUAL_SYNC flag. It is called by all VCPUs and they
2521 * will block on the VirtualSyncLock until the pending timers has been executed
2522 * and the clock restarted.
2523 *
2524 * @param pVM The cross context VM structure.
2525 * @param pVCpu The cross context virtual CPU structure of the calling EMT.
2526 *
2527 * @thread EMTs
2528 */
2529VMMR3_INT_DECL(void) TMR3VirtualSyncFF(PVM pVM, PVMCPU pVCpu)
2530{
2531 Log2(("TMR3VirtualSyncFF:\n"));
2532
2533 /*
2534 * The EMT doing the timers is diverted to them.
2535 */
2536 if (pVCpu->idCpu == pVM->tm.s.idTimerCpu)
2537 TMR3TimerQueuesDo(pVM);
2538 /*
2539 * The other EMTs will block on the virtual sync lock and the first owner
2540 * will run the queue and thus restarting the clock.
2541 *
2542 * Note! This is very suboptimal code wrt to resuming execution when there
2543 * are more than two Virtual CPUs, since they will all have to enter
2544 * the critical section one by one. But it's a very simple solution
2545 * which will have to do the job for now.
2546 */
2547 else
2548 {
2549 STAM_PROFILE_START(&pVM->tm.s.StatVirtualSyncFF, a);
2550 PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2551 if (pVM->tm.s.fVirtualSyncTicking)
2552 {
2553 STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2554 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2555 Log2(("TMR3VirtualSyncFF: ticking\n"));
2556 }
2557 else
2558 {
2559 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2560
2561 /* try run it. */
2562 TM_LOCK_TIMERS(pVM);
2563 PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2564 if (pVM->tm.s.fVirtualSyncTicking)
2565 Log2(("TMR3VirtualSyncFF: ticking (2)\n"));
2566 else
2567 {
2568 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2569 Log2(("TMR3VirtualSyncFF: running queue\n"));
2570
2571 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule);
2572 tmR3TimerQueueRunVirtualSync(pVM);
2573 if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2574 VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2575
2576 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2577 }
2578 STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2579 PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2580 TM_UNLOCK_TIMERS(pVM);
2581 }
2582 }
2583}
2584
2585
2586/** @name Saved state values
2587 * @{ */
2588#define TMTIMERSTATE_SAVED_PENDING_STOP 4
2589#define TMTIMERSTATE_SAVED_PENDING_SCHEDULE 7
2590/** @} */
2591
2592
2593/**
2594 * Saves the state of a timer to a saved state.
2595 *
2596 * @returns VBox status code.
2597 * @param pTimer Timer to save.
2598 * @param pSSM Save State Manager handle.
2599 */
2600VMMR3DECL(int) TMR3TimerSave(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
2601{
2602 LogFlow(("TMR3TimerSave: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2603 switch (pTimer->enmState)
2604 {
2605 case TMTIMERSTATE_STOPPED:
2606 case TMTIMERSTATE_PENDING_STOP:
2607 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
2608 return SSMR3PutU8(pSSM, TMTIMERSTATE_SAVED_PENDING_STOP);
2609
2610 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
2611 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
2612 AssertMsgFailed(("u64Expire is being updated! (%s)\n", pTimer->pszDesc));
2613 if (!RTThreadYield())
2614 RTThreadSleep(1);
2615 RT_FALL_THRU();
2616 case TMTIMERSTATE_ACTIVE:
2617 case TMTIMERSTATE_PENDING_SCHEDULE:
2618 case TMTIMERSTATE_PENDING_RESCHEDULE:
2619 SSMR3PutU8(pSSM, TMTIMERSTATE_SAVED_PENDING_SCHEDULE);
2620 return SSMR3PutU64(pSSM, pTimer->u64Expire);
2621
2622 case TMTIMERSTATE_EXPIRED_GET_UNLINK:
2623 case TMTIMERSTATE_EXPIRED_DELIVER:
2624 case TMTIMERSTATE_DESTROY:
2625 case TMTIMERSTATE_FREE:
2626 AssertMsgFailed(("Invalid timer state %d %s (%s)\n", pTimer->enmState, tmTimerState(pTimer->enmState), pTimer->pszDesc));
2627 return SSMR3HandleSetStatus(pSSM, VERR_TM_INVALID_STATE);
2628 }
2629
2630 AssertMsgFailed(("Unknown timer state %d (%s)\n", pTimer->enmState, pTimer->pszDesc));
2631 return SSMR3HandleSetStatus(pSSM, VERR_TM_UNKNOWN_STATE);
2632}
2633
2634
2635/**
2636 * Loads the state of a timer from a saved state.
2637 *
2638 * @returns VBox status code.
2639 * @param pTimer Timer to restore.
2640 * @param pSSM Save State Manager handle.
2641 */
2642VMMR3DECL(int) TMR3TimerLoad(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
2643{
2644 Assert(pTimer); Assert(pSSM); VM_ASSERT_EMT(pTimer->pVMR3);
2645 LogFlow(("TMR3TimerLoad: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2646
2647 /*
2648 * Load the state and validate it.
2649 */
2650 uint8_t u8State;
2651 int rc = SSMR3GetU8(pSSM, &u8State);
2652 if (RT_FAILURE(rc))
2653 return rc;
2654
2655 /* TMTIMERSTATE_SAVED_XXX: Workaround for accidental state shift in r47786 (2009-05-26 19:12:12). */
2656 if ( u8State == TMTIMERSTATE_SAVED_PENDING_STOP + 1
2657 || u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE + 1)
2658 u8State--;
2659
2660 if ( u8State != TMTIMERSTATE_SAVED_PENDING_STOP
2661 && u8State != TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2662 {
2663 AssertLogRelMsgFailed(("u8State=%d\n", u8State));
2664 return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2665 }
2666
2667 /* Enter the critical sections to make TMTimerSet/Stop happy. */
2668 if (pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC)
2669 PDMCritSectEnter(&pTimer->pVMR3->tm.s.VirtualSyncLock, VERR_IGNORED);
2670 PPDMCRITSECT pCritSect = pTimer->pCritSect;
2671 if (pCritSect)
2672 PDMCritSectEnter(pCritSect, VERR_IGNORED);
2673
2674 if (u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2675 {
2676 /*
2677 * Load the expire time.
2678 */
2679 uint64_t u64Expire;
2680 rc = SSMR3GetU64(pSSM, &u64Expire);
2681 if (RT_FAILURE(rc))
2682 return rc;
2683
2684 /*
2685 * Set it.
2686 */
2687 Log(("u8State=%d u64Expire=%llu\n", u8State, u64Expire));
2688 rc = TMTimerSet(pTimer, u64Expire);
2689 }
2690 else
2691 {
2692 /*
2693 * Stop it.
2694 */
2695 Log(("u8State=%d\n", u8State));
2696 rc = TMTimerStop(pTimer);
2697 }
2698
2699 if (pCritSect)
2700 PDMCritSectLeave(pCritSect);
2701 if (pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC)
2702 PDMCritSectLeave(&pTimer->pVMR3->tm.s.VirtualSyncLock);
2703
2704 /*
2705 * On failure set SSM status.
2706 */
2707 if (RT_FAILURE(rc))
2708 rc = SSMR3HandleSetStatus(pSSM, rc);
2709 return rc;
2710}
2711
2712
2713/**
2714 * Skips the state of a timer in a given saved state.
2715 *
2716 * @returns VBox status.
2717 * @param pSSM Save State Manager handle.
2718 * @param pfActive Where to store whether the timer was active
2719 * when the state was saved.
2720 */
2721VMMR3DECL(int) TMR3TimerSkip(PSSMHANDLE pSSM, bool *pfActive)
2722{
2723 Assert(pSSM); AssertPtr(pfActive);
2724 LogFlow(("TMR3TimerSkip: pSSM=%p pfActive=%p\n", pSSM, pfActive));
2725
2726 /*
2727 * Load the state and validate it.
2728 */
2729 uint8_t u8State;
2730 int rc = SSMR3GetU8(pSSM, &u8State);
2731 if (RT_FAILURE(rc))
2732 return rc;
2733
2734 /* TMTIMERSTATE_SAVED_XXX: Workaround for accidental state shift in r47786 (2009-05-26 19:12:12). */
2735 if ( u8State == TMTIMERSTATE_SAVED_PENDING_STOP + 1
2736 || u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE + 1)
2737 u8State--;
2738
2739 if ( u8State != TMTIMERSTATE_SAVED_PENDING_STOP
2740 && u8State != TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2741 {
2742 AssertLogRelMsgFailed(("u8State=%d\n", u8State));
2743 return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2744 }
2745
2746 *pfActive = (u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE);
2747 if (*pfActive)
2748 {
2749 /*
2750 * Load the expire time.
2751 */
2752 uint64_t u64Expire;
2753 rc = SSMR3GetU64(pSSM, &u64Expire);
2754 }
2755
2756 return rc;
2757}
2758
2759
2760/**
2761 * Associates a critical section with a timer.
2762 *
2763 * The critical section will be entered prior to doing the timer call back, thus
2764 * avoiding potential races between the timer thread and other threads trying to
2765 * stop or adjust the timer expiration while it's being delivered. The timer
2766 * thread will leave the critical section when the timer callback returns.
2767 *
2768 * In strict builds, ownership of the critical section will be asserted by
2769 * TMTimerSet, TMTimerStop, TMTimerGetExpire and TMTimerDestroy (when called at
2770 * runtime).
2771 *
2772 * @retval VINF_SUCCESS on success.
2773 * @retval VERR_INVALID_HANDLE if the timer handle is NULL or invalid
2774 * (asserted).
2775 * @retval VERR_INVALID_PARAMETER if pCritSect is NULL or has an invalid magic
2776 * (asserted).
2777 * @retval VERR_ALREADY_EXISTS if a critical section was already associated
2778 * with the timer (asserted).
2779 * @retval VERR_INVALID_STATE if the timer isn't stopped.
2780 *
2781 * @param pTimer The timer handle.
2782 * @param pCritSect The critical section. The caller must make sure this
2783 * is around for the life time of the timer.
2784 *
2785 * @thread Any, but the caller is responsible for making sure the timer is not
2786 * active.
2787 */
2788VMMR3DECL(int) TMR3TimerSetCritSect(PTMTIMERR3 pTimer, PPDMCRITSECT pCritSect)
2789{
2790 AssertPtrReturn(pTimer, VERR_INVALID_HANDLE);
2791 AssertPtrReturn(pCritSect, VERR_INVALID_PARAMETER);
2792 const char *pszName = PDMR3CritSectName(pCritSect); /* exploited for validation */
2793 AssertReturn(pszName, VERR_INVALID_PARAMETER);
2794 AssertReturn(!pTimer->pCritSect, VERR_ALREADY_EXISTS);
2795 AssertReturn(pTimer->enmState == TMTIMERSTATE_STOPPED, VERR_INVALID_STATE);
2796 LogFlow(("pTimer=%p (%s) pCritSect=%p (%s)\n", pTimer, pTimer->pszDesc, pCritSect, pszName));
2797
2798 pTimer->pCritSect = pCritSect;
2799 return VINF_SUCCESS;
2800}
2801
2802
2803/**
2804 * Get the real world UTC time adjusted for VM lag.
2805 *
2806 * @returns pTime.
2807 * @param pVM The cross context VM structure.
2808 * @param pTime Where to store the time.
2809 */
2810VMMR3_INT_DECL(PRTTIMESPEC) TMR3UtcNow(PVM pVM, PRTTIMESPEC pTime)
2811{
2812 /* Get a stable set of VirtualSync parameters before querying UTC. */
2813 uint64_t offVirtualSync;
2814 uint64_t offVirtualSyncGivenUp;
2815 do
2816 {
2817 offVirtualSync = ASMAtomicReadU64(&pVM->tm.s.offVirtualSync);
2818 offVirtualSyncGivenUp = ASMAtomicReadU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp);
2819 } while (ASMAtomicReadU64(&pVM->tm.s.offVirtualSync) != offVirtualSync);
2820
2821 Assert(offVirtualSync >= offVirtualSyncGivenUp);
2822 uint64_t const offLag = offVirtualSync - offVirtualSyncGivenUp;
2823
2824 RTTimeNow(pTime);
2825 RTTimeSpecSubNano(pTime, offLag);
2826 RTTimeSpecAddNano(pTime, pVM->tm.s.offUTC);
2827 return pTime;
2828}
2829
2830
2831/**
2832 * Pauses all clocks except TMCLOCK_REAL.
2833 *
2834 * @returns VBox status code, all errors are asserted.
2835 * @param pVM The cross context VM structure.
2836 * @param pVCpu The cross context virtual CPU structure.
2837 * @thread EMT corresponding to Pointer to the VMCPU.
2838 */
2839VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu)
2840{
2841 VMCPU_ASSERT_EMT(pVCpu);
2842
2843 /*
2844 * The shared virtual clock (includes virtual sync which is tied to it).
2845 */
2846 TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
2847 int rc = tmVirtualPauseLocked(pVM);
2848 TM_UNLOCK_TIMERS(pVM);
2849 if (RT_FAILURE(rc))
2850 return rc;
2851
2852 /*
2853 * Pause the TSC last since it is normally linked to the virtual
2854 * sync clock, so the above code may actually stop both clocks.
2855 */
2856 if (!pVM->tm.s.fTSCTiedToExecution)
2857 {
2858 TM_LOCK_TIMERS(pVM); /* Exploit the timer lock for synchronization. */
2859 rc = tmCpuTickPauseLocked(pVM, pVCpu);
2860 TM_UNLOCK_TIMERS(pVM);
2861 if (RT_FAILURE(rc))
2862 return rc;
2863 }
2864
2865#ifndef VBOX_WITHOUT_NS_ACCOUNTING
2866 /*
2867 * Update cNsTotal.
2868 */
2869 uint32_t uGen = ASMAtomicIncU32(&pVCpu->tm.s.uTimesGen); Assert(uGen & 1);
2870 pVCpu->tm.s.cNsTotal = RTTimeNanoTS() - pVCpu->tm.s.u64NsTsStartTotal;
2871 pVCpu->tm.s.cNsOther = pVCpu->tm.s.cNsTotal - pVCpu->tm.s.cNsExecuting - pVCpu->tm.s.cNsHalted;
2872 ASMAtomicWriteU32(&pVCpu->tm.s.uTimesGen, (uGen | 1) + 1);
2873#endif
2874
2875 return VINF_SUCCESS;
2876}
2877
2878
2879/**
2880 * Resumes all clocks except TMCLOCK_REAL.
2881 *
2882 * @returns VBox status code, all errors are asserted.
2883 * @param pVM The cross context VM structure.
2884 * @param pVCpu The cross context virtual CPU structure.
2885 * @thread EMT corresponding to Pointer to the VMCPU.
2886 */
2887VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu)
2888{
2889 VMCPU_ASSERT_EMT(pVCpu);
2890 int rc;
2891
2892#ifndef VBOX_WITHOUT_NS_ACCOUNTING
2893 /*
2894 * Set u64NsTsStartTotal. There is no need to back this out if either of
2895 * the two calls below fail.
2896 */
2897 pVCpu->tm.s.u64NsTsStartTotal = RTTimeNanoTS() - pVCpu->tm.s.cNsTotal;
2898#endif
2899
2900 /*
2901 * Resume the TSC first since it is normally linked to the virtual sync
2902 * clock, so it may actually not be resumed until we've executed the code
2903 * below.
2904 */
2905 if (!pVM->tm.s.fTSCTiedToExecution)
2906 {
2907 TM_LOCK_TIMERS(pVM); /* Exploit the timer lock for synchronization. */
2908 rc = tmCpuTickResumeLocked(pVM, pVCpu);
2909 TM_UNLOCK_TIMERS(pVM);
2910 if (RT_FAILURE(rc))
2911 return rc;
2912 }
2913
2914 /*
2915 * The shared virtual clock (includes virtual sync which is tied to it).
2916 */
2917 TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
2918 rc = tmVirtualResumeLocked(pVM);
2919 TM_UNLOCK_TIMERS(pVM);
2920
2921 return rc;
2922}
2923
2924
2925/**
2926 * Sets the warp drive percent of the virtual time.
2927 *
2928 * @returns VBox status code.
2929 * @param pUVM The user mode VM structure.
2930 * @param u32Percent The new percentage. 100 means normal operation.
2931 */
2932VMMDECL(int) TMR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent)
2933{
2934 return VMR3ReqPriorityCallWaitU(pUVM, VMCPUID_ANY, (PFNRT)tmR3SetWarpDrive, 2, pUVM, u32Percent);
2935}
2936
2937
2938/**
2939 * EMT worker for TMR3SetWarpDrive.
2940 *
2941 * @returns VBox status code.
2942 * @param pUVM The user mode VM handle.
2943 * @param u32Percent See TMR3SetWarpDrive().
2944 * @internal
2945 */
2946static DECLCALLBACK(int) tmR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent)
2947{
2948 PVM pVM = pUVM->pVM;
2949 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2950 PVMCPU pVCpu = VMMGetCpu(pVM);
2951
2952 /*
2953 * Validate it.
2954 */
2955 AssertMsgReturn(u32Percent >= 2 && u32Percent <= 20000,
2956 ("%RX32 is not between 2 and 20000 (inclusive).\n", u32Percent),
2957 VERR_INVALID_PARAMETER);
2958
2959/** @todo This isn't a feature specific to virtual time, move the variables to
2960 * TM level and make it affect TMR3UTCNow as well! */
2961
2962 /*
2963 * If the time is running we'll have to pause it before we can change
2964 * the warp drive settings.
2965 */
2966 TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
2967 bool fPaused = !!pVM->tm.s.cVirtualTicking;
2968 if (fPaused) /** @todo this isn't really working, but wtf. */
2969 TMR3NotifySuspend(pVM, pVCpu);
2970
2971 /** @todo Should switch TM mode to virt-tsc-emulated if it isn't already! */
2972 pVM->tm.s.u32VirtualWarpDrivePercentage = u32Percent;
2973 pVM->tm.s.fVirtualWarpDrive = u32Percent != 100;
2974 LogRel(("TM: u32VirtualWarpDrivePercentage=%RI32 fVirtualWarpDrive=%RTbool\n",
2975 pVM->tm.s.u32VirtualWarpDrivePercentage, pVM->tm.s.fVirtualWarpDrive));
2976
2977 if (fPaused)
2978 TMR3NotifyResume(pVM, pVCpu);
2979 TM_UNLOCK_TIMERS(pVM);
2980 return VINF_SUCCESS;
2981}
2982
2983
2984/**
2985 * Gets the current TMCLOCK_VIRTUAL time without checking
2986 * timers or anything.
2987 *
2988 * @returns The timestamp.
2989 * @param pUVM The user mode VM structure.
2990 *
2991 * @remarks See TMVirtualGetNoCheck.
2992 */
2993VMMR3DECL(uint64_t) TMR3TimeVirtGet(PUVM pUVM)
2994{
2995 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
2996 PVM pVM = pUVM->pVM;
2997 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
2998 return TMVirtualGetNoCheck(pVM);
2999}
3000
3001
3002/**
3003 * Gets the current TMCLOCK_VIRTUAL time in milliseconds without checking
3004 * timers or anything.
3005 *
3006 * @returns The timestamp in milliseconds.
3007 * @param pUVM The user mode VM structure.
3008 *
3009 * @remarks See TMVirtualGetNoCheck.
3010 */
3011VMMR3DECL(uint64_t) TMR3TimeVirtGetMilli(PUVM pUVM)
3012{
3013 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3014 PVM pVM = pUVM->pVM;
3015 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3016 return TMVirtualToMilli(pVM, TMVirtualGetNoCheck(pVM));
3017}
3018
3019
3020/**
3021 * Gets the current TMCLOCK_VIRTUAL time in microseconds without checking
3022 * timers or anything.
3023 *
3024 * @returns The timestamp in microseconds.
3025 * @param pUVM The user mode VM structure.
3026 *
3027 * @remarks See TMVirtualGetNoCheck.
3028 */
3029VMMR3DECL(uint64_t) TMR3TimeVirtGetMicro(PUVM pUVM)
3030{
3031 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3032 PVM pVM = pUVM->pVM;
3033 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3034 return TMVirtualToMicro(pVM, TMVirtualGetNoCheck(pVM));
3035}
3036
3037
3038/**
3039 * Gets the current TMCLOCK_VIRTUAL time in nanoseconds without checking
3040 * timers or anything.
3041 *
3042 * @returns The timestamp in nanoseconds.
3043 * @param pUVM The user mode VM structure.
3044 *
3045 * @remarks See TMVirtualGetNoCheck.
3046 */
3047VMMR3DECL(uint64_t) TMR3TimeVirtGetNano(PUVM pUVM)
3048{
3049 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3050 PVM pVM = pUVM->pVM;
3051 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3052 return TMVirtualToNano(pVM, TMVirtualGetNoCheck(pVM));
3053}
3054
3055
3056/**
3057 * Gets the current warp drive percent.
3058 *
3059 * @returns The warp drive percent.
3060 * @param pUVM The user mode VM structure.
3061 */
3062VMMR3DECL(uint32_t) TMR3GetWarpDrive(PUVM pUVM)
3063{
3064 UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT32_MAX);
3065 PVM pVM = pUVM->pVM;
3066 VM_ASSERT_VALID_EXT_RETURN(pVM, UINT32_MAX);
3067 return pVM->tm.s.u32VirtualWarpDrivePercentage;
3068}
3069
3070
3071/**
3072 * Gets the performance information for one virtual CPU as seen by the VMM.
3073 *
3074 * The returned times covers the period where the VM is running and will be
3075 * reset when restoring a previous VM state (at least for the time being).
3076 *
3077 * @retval VINF_SUCCESS on success.
3078 * @retval VERR_NOT_IMPLEMENTED if not compiled in.
3079 * @retval VERR_INVALID_STATE if the VM handle is bad.
3080 * @retval VERR_INVALID_PARAMETER if idCpu is out of range.
3081 *
3082 * @param pVM The cross context VM structure.
3083 * @param idCpu The ID of the virtual CPU which times to get.
3084 * @param pcNsTotal Where to store the total run time (nano seconds) of
3085 * the CPU, i.e. the sum of the three other returns.
3086 * Optional.
3087 * @param pcNsExecuting Where to store the time (nano seconds) spent
3088 * executing guest code. Optional.
3089 * @param pcNsHalted Where to store the time (nano seconds) spent
3090 * halted. Optional
3091 * @param pcNsOther Where to store the time (nano seconds) spent
3092 * preempted by the host scheduler, on virtualization
3093 * overhead and on other tasks.
3094 */
3095VMMR3DECL(int) TMR3GetCpuLoadTimes(PVM pVM, VMCPUID idCpu, uint64_t *pcNsTotal, uint64_t *pcNsExecuting,
3096 uint64_t *pcNsHalted, uint64_t *pcNsOther)
3097{
3098 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_STATE);
3099 AssertReturn(idCpu < pVM->cCpus, VERR_INVALID_PARAMETER);
3100
3101#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3102 /*
3103 * Get a stable result set.
3104 * This should be way quicker than an EMT request.
3105 */
3106 PVMCPU pVCpu = &pVM->aCpus[idCpu];
3107 uint32_t uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3108 uint64_t cNsTotal = pVCpu->tm.s.cNsTotal;
3109 uint64_t cNsExecuting = pVCpu->tm.s.cNsExecuting;
3110 uint64_t cNsHalted = pVCpu->tm.s.cNsHalted;
3111 uint64_t cNsOther = pVCpu->tm.s.cNsOther;
3112 while ( (uTimesGen & 1) /* update in progress */
3113 || uTimesGen != ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen))
3114 {
3115 RTThreadYield();
3116 uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3117 cNsTotal = pVCpu->tm.s.cNsTotal;
3118 cNsExecuting = pVCpu->tm.s.cNsExecuting;
3119 cNsHalted = pVCpu->tm.s.cNsHalted;
3120 cNsOther = pVCpu->tm.s.cNsOther;
3121 }
3122
3123 /*
3124 * Fill in the return values.
3125 */
3126 if (pcNsTotal)
3127 *pcNsTotal = cNsTotal;
3128 if (pcNsExecuting)
3129 *pcNsExecuting = cNsExecuting;
3130 if (pcNsHalted)
3131 *pcNsHalted = cNsHalted;
3132 if (pcNsOther)
3133 *pcNsOther = cNsOther;
3134
3135 return VINF_SUCCESS;
3136
3137#else
3138 return VERR_NOT_IMPLEMENTED;
3139#endif
3140}
3141
3142#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3143
3144/**
3145 * Helper for tmR3CpuLoadTimer.
3146 * @returns
3147 * @param pState The state to update.
3148 * @param cNsTotal Total time.
3149 * @param cNsExecuting Time executing.
3150 * @param cNsHalted Time halted.
3151 */
3152DECLINLINE(void) tmR3CpuLoadTimerMakeUpdate(PTMCPULOADSTATE pState, uint64_t cNsTotal, uint64_t cNsExecuting, uint64_t cNsHalted)
3153{
3154 /* Calc deltas */
3155 uint64_t cNsTotalDelta = cNsTotal - pState->cNsPrevTotal;
3156 pState->cNsPrevTotal = cNsTotal;
3157
3158 uint64_t cNsExecutingDelta = cNsExecuting - pState->cNsPrevExecuting;
3159 pState->cNsPrevExecuting = cNsExecuting;
3160
3161 uint64_t cNsHaltedDelta = cNsHalted - pState->cNsPrevHalted;
3162 pState->cNsPrevHalted = cNsHalted;
3163
3164 /* Calc pcts. */
3165 if (!cNsTotalDelta)
3166 {
3167 pState->cPctExecuting = 0;
3168 pState->cPctHalted = 100;
3169 pState->cPctOther = 0;
3170 }
3171 else if (cNsTotalDelta < UINT64_MAX / 4)
3172 {
3173 pState->cPctExecuting = (uint8_t)(cNsExecutingDelta * 100 / cNsTotalDelta);
3174 pState->cPctHalted = (uint8_t)(cNsHaltedDelta * 100 / cNsTotalDelta);
3175 pState->cPctOther = (uint8_t)((cNsTotalDelta - cNsExecutingDelta - cNsHaltedDelta) * 100 / cNsTotalDelta);
3176 }
3177 else
3178 {
3179 pState->cPctExecuting = 0;
3180 pState->cPctHalted = 100;
3181 pState->cPctOther = 0;
3182 }
3183}
3184
3185
3186/**
3187 * Timer callback that calculates the CPU load since the last time it was
3188 * called.
3189 *
3190 * @param pVM The cross context VM structure.
3191 * @param pTimer The timer.
3192 * @param pvUser NULL, unused.
3193 */
3194static DECLCALLBACK(void) tmR3CpuLoadTimer(PVM pVM, PTMTIMER pTimer, void *pvUser)
3195{
3196 /*
3197 * Re-arm the timer first.
3198 */
3199 int rc = TMTimerSetMillies(pTimer, 1000);
3200 AssertLogRelRC(rc);
3201 NOREF(pvUser);
3202
3203 /*
3204 * Update the values for each CPU.
3205 */
3206 uint64_t cNsTotalAll = 0;
3207 uint64_t cNsExecutingAll = 0;
3208 uint64_t cNsHaltedAll = 0;
3209 for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
3210 {
3211 PVMCPU pVCpu = &pVM->aCpus[iCpu];
3212
3213 /* Try get a stable data set. */
3214 uint32_t cTries = 3;
3215 uint32_t uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3216 uint64_t cNsTotal = pVCpu->tm.s.cNsTotal;
3217 uint64_t cNsExecuting = pVCpu->tm.s.cNsExecuting;
3218 uint64_t cNsHalted = pVCpu->tm.s.cNsHalted;
3219 while (RT_UNLIKELY( (uTimesGen & 1) /* update in progress */
3220 || uTimesGen != ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen)))
3221 {
3222 if (!--cTries)
3223 break;
3224 ASMNopPause();
3225 uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3226 cNsTotal = pVCpu->tm.s.cNsTotal;
3227 cNsExecuting = pVCpu->tm.s.cNsExecuting;
3228 cNsHalted = pVCpu->tm.s.cNsHalted;
3229 }
3230
3231 /* Totals */
3232 cNsTotalAll += cNsTotal;
3233 cNsExecutingAll += cNsExecuting;
3234 cNsHaltedAll += cNsHalted;
3235
3236 /* Calc the PCTs and update the state. */
3237 tmR3CpuLoadTimerMakeUpdate(&pVCpu->tm.s.CpuLoad, cNsTotal, cNsExecuting, cNsHalted);
3238 }
3239
3240 /*
3241 * Update the value for all the CPUs.
3242 */
3243 tmR3CpuLoadTimerMakeUpdate(&pVM->tm.s.CpuLoad, cNsTotalAll, cNsExecutingAll, cNsHaltedAll);
3244
3245 /** @todo Try add 1, 5 and 15 min load stats. */
3246
3247}
3248
3249#endif /* !VBOX_WITHOUT_NS_ACCOUNTING */
3250
3251
3252/**
3253 * @callback_method_impl{PFNVMMEMTRENDEZVOUS,
3254 * Worker for TMR3CpuTickParavirtEnable}
3255 */
3256static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtEnable(PVM pVM, PVMCPU pVCpuEmt, void *pvData)
3257{
3258 AssertPtr(pVM); Assert(pVM->tm.s.fTSCModeSwitchAllowed); NOREF(pVCpuEmt); NOREF(pvData);
3259 Assert(pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET);
3260 Assert(tmR3HasFixedTSC(pVM));
3261
3262 /*
3263 * The return value of TMCpuTickGet() and the guest's TSC value for each
3264 * CPU must remain constant across the TM TSC mode-switch. Thus we have
3265 * the following equation (new/old signifies the new/old tsc modes):
3266 * uNewTsc = uOldTsc
3267 *
3268 * Where (see tmCpuTickGetInternal):
3269 * uOldTsc = uRawOldTsc - offTscRawSrcOld
3270 * uNewTsc = uRawNewTsc - offTscRawSrcNew
3271 *
3272 * Solve it for offTscRawSrcNew without replacing uOldTsc:
3273 * uRawNewTsc - offTscRawSrcNew = uOldTsc
3274 * => -offTscRawSrcNew = uOldTsc - uRawNewTsc
3275 * => offTscRawSrcNew = uRawNewTsc - uOldTsc
3276 */
3277 uint64_t uRawOldTsc = tmR3CpuTickGetRawVirtualNoCheck(pVM);
3278 uint64_t uRawNewTsc = SUPReadTsc();
3279 uint32_t cCpus = pVM->cCpus;
3280 for (uint32_t i = 0; i < cCpus; i++)
3281 {
3282 PVMCPU pVCpu = &pVM->aCpus[i];
3283 uint64_t uOldTsc = uRawOldTsc - pVCpu->tm.s.offTSCRawSrc;
3284 pVCpu->tm.s.offTSCRawSrc = uRawNewTsc - uOldTsc;
3285 Assert(uRawNewTsc - pVCpu->tm.s.offTSCRawSrc >= uOldTsc); /* paranoia^256 */
3286 }
3287
3288 LogRel(("TM: Switching TSC mode from '%s' to '%s'\n", tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode),
3289 tmR3GetTSCModeNameEx(TMTSCMODE_REAL_TSC_OFFSET)));
3290 pVM->tm.s.enmTSCMode = TMTSCMODE_REAL_TSC_OFFSET;
3291 return VINF_SUCCESS;
3292}
3293
3294
3295/**
3296 * Notify TM that the guest has enabled usage of a paravirtualized TSC.
3297 *
3298 * This may perform a EMT rendezvous and change the TSC virtualization mode.
3299 *
3300 * @returns VBox status code.
3301 * @param pVM The cross context VM structure.
3302 */
3303VMMR3_INT_DECL(int) TMR3CpuTickParavirtEnable(PVM pVM)
3304{
3305 int rc = VINF_SUCCESS;
3306 if (pVM->tm.s.fTSCModeSwitchAllowed)
3307 {
3308 if (pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET)
3309 rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, tmR3CpuTickParavirtEnable, NULL);
3310 }
3311 else
3312 LogRel(("TM: Host/VM is not suitable for using TSC mode '%s', request to change TSC mode ignored\n",
3313 tmR3GetTSCModeNameEx(TMTSCMODE_REAL_TSC_OFFSET)));
3314 pVM->tm.s.fParavirtTscEnabled = true;
3315 return rc;
3316}
3317
3318
3319/**
3320 * @callback_method_impl{PFNVMMEMTRENDEZVOUS,
3321 * Worker for TMR3CpuTickParavirtDisable}
3322 */
3323static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtDisable(PVM pVM, PVMCPU pVCpuEmt, void *pvData)
3324{
3325 AssertPtr(pVM); Assert(pVM->tm.s.fTSCModeSwitchAllowed); NOREF(pVCpuEmt);
3326 Assert( pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET
3327 && pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode);
3328 RT_NOREF1(pvData);
3329
3330 /*
3331 * See tmR3CpuTickParavirtEnable for an explanation of the conversion math.
3332 */
3333 uint64_t uRawOldTsc = SUPReadTsc();
3334 uint64_t uRawNewTsc = tmR3CpuTickGetRawVirtualNoCheck(pVM);
3335 uint32_t cCpus = pVM->cCpus;
3336 for (uint32_t i = 0; i < cCpus; i++)
3337 {
3338 PVMCPU pVCpu = &pVM->aCpus[i];
3339 uint64_t uOldTsc = uRawOldTsc - pVCpu->tm.s.offTSCRawSrc;
3340 pVCpu->tm.s.offTSCRawSrc = uRawNewTsc - uOldTsc;
3341 Assert(uRawNewTsc - pVCpu->tm.s.offTSCRawSrc >= uOldTsc); /* paranoia^256 */
3342
3343 /* Update the last-seen tick here as we havent't been updating it (as we don't
3344 need it) while in pure TSC-offsetting mode. */
3345 pVCpu->tm.s.u64TSCLastSeen = uOldTsc;
3346 }
3347
3348 LogRel(("TM: Switching TSC mode from '%s' to '%s'\n", tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode),
3349 tmR3GetTSCModeNameEx(pVM->tm.s.enmOriginalTSCMode)));
3350 pVM->tm.s.enmTSCMode = pVM->tm.s.enmOriginalTSCMode;
3351 return VINF_SUCCESS;
3352}
3353
3354
3355/**
3356 * Notify TM that the guest has disabled usage of a paravirtualized TSC.
3357 *
3358 * If TMR3CpuTickParavirtEnable() changed the TSC virtualization mode, this will
3359 * perform an EMT rendezvous to revert those changes.
3360 *
3361 * @returns VBox status code.
3362 * @param pVM The cross context VM structure.
3363 */
3364VMMR3_INT_DECL(int) TMR3CpuTickParavirtDisable(PVM pVM)
3365{
3366 int rc = VINF_SUCCESS;
3367 if ( pVM->tm.s.fTSCModeSwitchAllowed
3368 && pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET
3369 && pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode)
3370 rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, tmR3CpuTickParavirtDisable, NULL);
3371 pVM->tm.s.fParavirtTscEnabled = false;
3372 return rc;
3373}
3374
3375
3376/**
3377 * Check whether the guest can be presented a fixed rate & monotonic TSC.
3378 *
3379 * @returns true if TSC is stable, false otherwise.
3380 * @param pVM The cross context VM structure.
3381 * @param fWithParavirtEnabled Whether it's fixed & monotonic when
3382 * paravirt. TSC is enabled or not.
3383 *
3384 * @remarks Must be called only after TMR3InitFinalize().
3385 */
3386VMMR3_INT_DECL(bool) TMR3CpuTickIsFixedRateMonotonic(PVM pVM, bool fWithParavirtEnabled)
3387{
3388 /** @todo figure out what exactly we want here later. */
3389 NOREF(fWithParavirtEnabled);
3390 return ( tmR3HasFixedTSC(pVM) /* Host has fixed-rate TSC. */
3391 && g_pSUPGlobalInfoPage->u32Mode != SUPGIPMODE_ASYNC_TSC); /* GIP thinks it's monotonic. */
3392}
3393
3394
3395/**
3396 * Gets the 5 char clock name for the info tables.
3397 *
3398 * @returns The name.
3399 * @param enmClock The clock.
3400 */
3401DECLINLINE(const char *) tmR3Get5CharClockName(TMCLOCK enmClock)
3402{
3403 switch (enmClock)
3404 {
3405 case TMCLOCK_REAL: return "Real ";
3406 case TMCLOCK_VIRTUAL: return "Virt ";
3407 case TMCLOCK_VIRTUAL_SYNC: return "VrSy ";
3408 case TMCLOCK_TSC: return "TSC ";
3409 default: return "Bad ";
3410 }
3411}
3412
3413
3414/**
3415 * Display all timers.
3416 *
3417 * @param pVM The cross context VM structure.
3418 * @param pHlp The info helpers.
3419 * @param pszArgs Arguments, ignored.
3420 */
3421static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3422{
3423 NOREF(pszArgs);
3424 pHlp->pfnPrintf(pHlp,
3425 "Timers (pVM=%p)\n"
3426 "%.*s %.*s %.*s %.*s Clock %18s %18s %6s %-25s Description\n",
3427 pVM,
3428 sizeof(RTR3PTR) * 2, "pTimerR3 ",
3429 sizeof(int32_t) * 2, "offNext ",
3430 sizeof(int32_t) * 2, "offPrev ",
3431 sizeof(int32_t) * 2, "offSched ",
3432 "Time",
3433 "Expire",
3434 "HzHint",
3435 "State");
3436 TM_LOCK_TIMERS(pVM);
3437 for (PTMTIMERR3 pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
3438 {
3439 pHlp->pfnPrintf(pHlp,
3440 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %6RU32 %-25s %s\n",
3441 pTimer,
3442 pTimer->offNext,
3443 pTimer->offPrev,
3444 pTimer->offScheduleNext,
3445 tmR3Get5CharClockName(pTimer->enmClock),
3446 TMTimerGet(pTimer),
3447 pTimer->u64Expire,
3448 pTimer->uHzHint,
3449 tmTimerState(pTimer->enmState),
3450 pTimer->pszDesc);
3451 }
3452 TM_UNLOCK_TIMERS(pVM);
3453}
3454
3455
3456/**
3457 * Display all active timers.
3458 *
3459 * @param pVM The cross context VM structure.
3460 * @param pHlp The info helpers.
3461 * @param pszArgs Arguments, ignored.
3462 */
3463static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3464{
3465 NOREF(pszArgs);
3466 pHlp->pfnPrintf(pHlp,
3467 "Active Timers (pVM=%p)\n"
3468 "%.*s %.*s %.*s %.*s Clock %18s %18s %6s %-25s Description\n",
3469 pVM,
3470 sizeof(RTR3PTR) * 2, "pTimerR3 ",
3471 sizeof(int32_t) * 2, "offNext ",
3472 sizeof(int32_t) * 2, "offPrev ",
3473 sizeof(int32_t) * 2, "offSched ",
3474 "Time",
3475 "Expire",
3476 "HzHint",
3477 "State");
3478 for (unsigned iQueue = 0; iQueue < TMCLOCK_MAX; iQueue++)
3479 {
3480 TM_LOCK_TIMERS(pVM);
3481 for (PTMTIMERR3 pTimer = TMTIMER_GET_HEAD(&pVM->tm.s.paTimerQueuesR3[iQueue]);
3482 pTimer;
3483 pTimer = TMTIMER_GET_NEXT(pTimer))
3484 {
3485 pHlp->pfnPrintf(pHlp,
3486 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %6RU32 %-25s %s\n",
3487 pTimer,
3488 pTimer->offNext,
3489 pTimer->offPrev,
3490 pTimer->offScheduleNext,
3491 tmR3Get5CharClockName(pTimer->enmClock),
3492 TMTimerGet(pTimer),
3493 pTimer->u64Expire,
3494 pTimer->uHzHint,
3495 tmTimerState(pTimer->enmState),
3496 pTimer->pszDesc);
3497 }
3498 TM_UNLOCK_TIMERS(pVM);
3499 }
3500}
3501
3502
3503/**
3504 * Display all clocks.
3505 *
3506 * @param pVM The cross context VM structure.
3507 * @param pHlp The info helpers.
3508 * @param pszArgs Arguments, ignored.
3509 */
3510static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3511{
3512 NOREF(pszArgs);
3513
3514 /*
3515 * Read the times first to avoid more than necessary time variation.
3516 */
3517 const uint64_t u64Virtual = TMVirtualGet(pVM);
3518 const uint64_t u64VirtualSync = TMVirtualSyncGet(pVM);
3519 const uint64_t u64Real = TMRealGet(pVM);
3520
3521 for (VMCPUID i = 0; i < pVM->cCpus; i++)
3522 {
3523 PVMCPU pVCpu = &pVM->aCpus[i];
3524 uint64_t u64TSC = TMCpuTickGet(pVCpu);
3525
3526 /*
3527 * TSC
3528 */
3529 pHlp->pfnPrintf(pHlp,
3530 "Cpu Tick: %18RU64 (%#016RX64) %RU64Hz %s - virtualized",
3531 u64TSC, u64TSC, TMCpuTicksPerSecond(pVM),
3532 pVCpu->tm.s.fTSCTicking ? "ticking" : "paused");
3533 if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
3534 {
3535 pHlp->pfnPrintf(pHlp, " - real tsc offset");
3536 if (pVCpu->tm.s.offTSCRawSrc)
3537 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVCpu->tm.s.offTSCRawSrc);
3538 }
3539 else
3540 pHlp->pfnPrintf(pHlp, " - virtual clock");
3541 pHlp->pfnPrintf(pHlp, "\n");
3542 }
3543
3544 /*
3545 * virtual
3546 */
3547 pHlp->pfnPrintf(pHlp,
3548 " Virtual: %18RU64 (%#016RX64) %RU64Hz %s",
3549 u64Virtual, u64Virtual, TMVirtualGetFreq(pVM),
3550 pVM->tm.s.cVirtualTicking ? "ticking" : "paused");
3551 if (pVM->tm.s.fVirtualWarpDrive)
3552 pHlp->pfnPrintf(pHlp, " WarpDrive %RU32 %%", pVM->tm.s.u32VirtualWarpDrivePercentage);
3553 pHlp->pfnPrintf(pHlp, "\n");
3554
3555 /*
3556 * virtual sync
3557 */
3558 pHlp->pfnPrintf(pHlp,
3559 "VirtSync: %18RU64 (%#016RX64) %s%s",
3560 u64VirtualSync, u64VirtualSync,
3561 pVM->tm.s.fVirtualSyncTicking ? "ticking" : "paused",
3562 pVM->tm.s.fVirtualSyncCatchUp ? " - catchup" : "");
3563 if (pVM->tm.s.offVirtualSync)
3564 {
3565 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVM->tm.s.offVirtualSync);
3566 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage)
3567 pHlp->pfnPrintf(pHlp, " catch-up rate %u %%", pVM->tm.s.u32VirtualSyncCatchUpPercentage);
3568 }
3569 pHlp->pfnPrintf(pHlp, "\n");
3570
3571 /*
3572 * real
3573 */
3574 pHlp->pfnPrintf(pHlp,
3575 " Real: %18RU64 (%#016RX64) %RU64Hz\n",
3576 u64Real, u64Real, TMRealGetFreq(pVM));
3577}
3578
3579
3580/**
3581 * Gets the descriptive TM TSC mode name given the enum value.
3582 *
3583 * @returns The name.
3584 * @param enmMode The mode to name.
3585 */
3586static const char *tmR3GetTSCModeNameEx(TMTSCMODE enmMode)
3587{
3588 switch (enmMode)
3589 {
3590 case TMTSCMODE_REAL_TSC_OFFSET: return "RealTscOffset";
3591 case TMTSCMODE_VIRT_TSC_EMULATED: return "VirtTscEmulated";
3592 case TMTSCMODE_DYNAMIC: return "Dynamic";
3593 default: return "???";
3594 }
3595}
3596
3597
3598/**
3599 * Gets the descriptive TM TSC mode name.
3600 *
3601 * @returns The name.
3602 * @param pVM The cross context VM structure.
3603 */
3604static const char *tmR3GetTSCModeName(PVM pVM)
3605{
3606 Assert(pVM);
3607 return tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode);
3608}
3609
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