VirtualBox

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

Last change on this file since 10934 was 10567, checked in by vboxsync, 16 years ago

Expose cpuid 0x80000007 (AMD - Advanced Power Management (TSC invariant)) and 0x80000008 (virtual & physical address size) to the guest.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 83.9 KB
Line 
1/* $Id: TM.cpp 10567 2008-07-12 15:29:13Z vboxsync $ */
2/** @file
3 * TM - Timeout Manager.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22
23/** @page pg_tm TM - The Time Manager
24 *
25 * The Time Manager abstracts the CPU clocks and manages timers used by the VMM,
26 * device and drivers.
27 *
28 *
29 * @section sec_tm_clocks Clocks
30 *
31 * There are currently 4 clocks:
32 * - Virtual (guest).
33 * - Synchronous virtual (guest).
34 * - CPU Tick (TSC) (guest). Only current use is rdtsc emulation. Usually a
35 * function of the virtual clock.
36 * - Real (host). The only current use is display updates for not real
37 * good reason...
38 *
39 * The interesting clocks are two first ones, the virtual and synchronous virtual
40 * clock. The synchronous virtual clock is tied to the virtual clock except that
41 * it will take into account timer delivery lag caused by host scheduling. It will
42 * normally never advance beyond the header timer, and when lagging too far behind
43 * it will gradually speed up to catch up with the virtual clock.
44 *
45 * The CPU tick (TSC) is normally virtualized as a function of the virtual time,
46 * where the frequency defaults to the host cpu frequency (as we measure it). It
47 * can also use the host TSC as source and either present it with an offset or
48 * unmodified. It is of course possible to configure the TSC frequency and mode
49 * of operation.
50 *
51 * @subsection subsec_tm_timesync Guest Time Sync / UTC time
52 *
53 * Guest time syncing is primarily taken care of by the VMM device. The principle
54 * is very simple, the guest additions periodically asks the VMM device what the
55 * current UTC time is and makes adjustments accordingly. Now, because the
56 * synchronous virtual clock might be doing catchups and we would therefore
57 * deliver more than the normal rate for a little while, some adjusting of the
58 * UTC time is required before passing it on to the guest. This is why TM provides
59 * an API for query the current UTC time.
60 *
61 *
62 * @section sec_tm_timers Timers
63 *
64 * The timers can use any of the TM clocks described in the previous section. Each
65 * clock has its own scheduling facility, or timer queue if you like. There are
66 * a few factors which makes it a bit complex. First there is the usual R0 vs R3
67 * vs. GC thing. Then there is multiple threads, and then there is the timer thread
68 * that periodically checks whether any timers has expired without EMT noticing. On
69 * the API level, all but the create and save APIs must be mulithreaded. EMT will
70 * always run the timers.
71 *
72 * The design is using a doubly linked list of active timers which is ordered
73 * by expire date. This list is only modified by the EMT thread. Updates to the
74 * list are are batched in a singly linked list, which is then process by the EMT
75 * thread at the first opportunity (immediately, next time EMT modifies a timer
76 * on that clock, or next timer timeout). Both lists are offset based and all
77 * the elements therefore allocated from the hyper heap.
78 *
79 * For figuring out when there is need to schedule and run timers TM will:
80 * - Poll whenever somebody queries the virtual clock.
81 * - Poll the virtual clocks from the EM and REM loops.
82 * - Poll the virtual clocks from trap exit path.
83 * - Poll the virtual clocks and calculate first timeout from the halt loop.
84 * - Employ a thread which periodically (100Hz) polls all the timer queues.
85 *
86 *
87 * @section sec_tm_timer Logging
88 *
89 * Level 2: Logs a most of the timer state transitions and queue servicing.
90 * Level 3: Logs a few oddments.
91 * Level 4: Logs TMCLOCK_VIRTUAL_SYNC catch-up events.
92 *
93 */
94
95
96
97
98/*******************************************************************************
99* Header Files *
100*******************************************************************************/
101#define LOG_GROUP LOG_GROUP_TM
102#include <VBox/tm.h>
103#include <VBox/vmm.h>
104#include <VBox/mm.h>
105#include <VBox/ssm.h>
106#include <VBox/dbgf.h>
107#include <VBox/rem.h>
108#include <VBox/pdm.h>
109#include "TMInternal.h"
110#include <VBox/vm.h>
111
112#include <VBox/param.h>
113#include <VBox/err.h>
114
115#include <VBox/log.h>
116#include <iprt/asm.h>
117#include <iprt/assert.h>
118#include <iprt/thread.h>
119#include <iprt/time.h>
120#include <iprt/timer.h>
121#include <iprt/semaphore.h>
122#include <iprt/string.h>
123#include <iprt/env.h>
124
125
126/*******************************************************************************
127* Defined Constants And Macros *
128*******************************************************************************/
129/** The current saved state version.*/
130#define TM_SAVED_STATE_VERSION 3
131
132
133/*******************************************************************************
134* Internal Functions *
135*******************************************************************************/
136static bool tmR3HasFixedTSC(PVM pVM);
137static uint64_t tmR3CalibrateTSC(PVM pVM);
138static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM);
139static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
140static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
141static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue);
142static void tmR3TimerQueueRunVirtualSync(PVM pVM);
143static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
144static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
145static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
146
147
148/**
149 * Internal function for getting the clock time.
150 *
151 * @returns clock time.
152 * @param pVM The VM handle.
153 * @param enmClock The clock.
154 */
155DECLINLINE(uint64_t) tmClock(PVM pVM, TMCLOCK enmClock)
156{
157 switch (enmClock)
158 {
159 case TMCLOCK_VIRTUAL: return TMVirtualGet(pVM);
160 case TMCLOCK_VIRTUAL_SYNC: return TMVirtualSyncGet(pVM);
161 case TMCLOCK_REAL: return TMRealGet(pVM);
162 case TMCLOCK_TSC: return TMCpuTickGet(pVM);
163 default:
164 AssertMsgFailed(("enmClock=%d\n", enmClock));
165 return ~(uint64_t)0;
166 }
167}
168
169
170/**
171 * Initializes the TM.
172 *
173 * @returns VBox status code.
174 * @param pVM The VM to operate on.
175 */
176TMR3DECL(int) TMR3Init(PVM pVM)
177{
178 LogFlow(("TMR3Init:\n"));
179
180 /*
181 * Assert alignment and sizes.
182 */
183 AssertRelease(!(RT_OFFSETOF(VM, tm.s) & 31));
184 AssertRelease(sizeof(pVM->tm.s) <= sizeof(pVM->tm.padding));
185
186 /*
187 * Init the structure.
188 */
189 void *pv;
190 int rc = MMHyperAlloc(pVM, sizeof(pVM->tm.s.paTimerQueuesR3[0]) * TMCLOCK_MAX, 0, MM_TAG_TM, &pv);
191 AssertRCReturn(rc, rc);
192 pVM->tm.s.paTimerQueuesR3 = (PTMTIMERQUEUE)pv;
193
194 pVM->tm.s.offVM = RT_OFFSETOF(VM, tm.s);
195 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].enmClock = TMCLOCK_VIRTUAL;
196 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].u64Expire = INT64_MAX;
197 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].enmClock = TMCLOCK_VIRTUAL_SYNC;
198 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].u64Expire = INT64_MAX;
199 pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].enmClock = TMCLOCK_REAL;
200 pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].u64Expire = INT64_MAX;
201 pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].enmClock = TMCLOCK_TSC;
202 pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].u64Expire = INT64_MAX;
203
204 /*
205 * We directly use the GIP to calculate the virtual time. We map the
206 * the GIP into the guest context so we can do this calculation there
207 * as well and save costly world switches.
208 */
209 pVM->tm.s.pvGIPR3 = (void *)g_pSUPGlobalInfoPage;
210 AssertMsgReturn(pVM->tm.s.pvGIPR3, ("GIP support is now required!\n"), VERR_INTERNAL_ERROR);
211 RTHCPHYS HCPhysGIP;
212 rc = SUPGipGetPhys(&HCPhysGIP);
213 AssertMsgRCReturn(rc, ("Failed to get GIP physical address!\n"), rc);
214
215 RTGCPTR GCPtr;
216 rc = MMR3HyperMapHCPhys(pVM, pVM->tm.s.pvGIPR3, HCPhysGIP, PAGE_SIZE, "GIP", &GCPtr);
217 if (VBOX_FAILURE(rc))
218 {
219 AssertMsgFailed(("Failed to map GIP into GC, rc=%Vrc!\n", rc));
220 return rc;
221 }
222 pVM->tm.s.pvGIPGC = GCPtr;
223 LogFlow(("TMR3Init: HCPhysGIP=%RHp at %VGv\n", HCPhysGIP, pVM->tm.s.pvGIPGC));
224 MMR3HyperReserve(pVM, PAGE_SIZE, "fence", NULL);
225
226 /* Check assumptions made in TMAllVirtual.cpp about the GIP update interval. */
227 if ( g_pSUPGlobalInfoPage->u32Magic == SUPGLOBALINFOPAGE_MAGIC
228 && g_pSUPGlobalInfoPage->u32UpdateIntervalNS >= 250000000 /* 0.25s */)
229 return VMSetError(pVM, VERR_INTERNAL_ERROR, RT_SRC_POS,
230 N_("The GIP update interval is too big. u32UpdateIntervalNS=%RU32 (u32UpdateHz=%RU32)"),
231 g_pSUPGlobalInfoPage->u32UpdateIntervalNS, g_pSUPGlobalInfoPage->u32UpdateHz);
232
233 /*
234 * Setup the VirtualGetRaw backend.
235 */
236 pVM->tm.s.VirtualGetRawDataR3.pu64Prev = &pVM->tm.s.u64VirtualRawPrev;
237 pVM->tm.s.VirtualGetRawDataR3.pfnBad = tmVirtualNanoTSBad;
238 pVM->tm.s.VirtualGetRawDataR3.pfnRediscover = tmVirtualNanoTSRediscover;
239 if (ASMCpuId_EDX(1) & X86_CPUID_FEATURE_EDX_SSE2)
240 {
241 if (g_pSUPGlobalInfoPage->u32Mode == SUPGIPMODE_SYNC_TSC)
242 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLFenceSync;
243 else
244 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLFenceAsync;
245 }
246 else
247 {
248 if (g_pSUPGlobalInfoPage->u32Mode == SUPGIPMODE_SYNC_TSC)
249 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLegacySync;
250 else
251 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLegacyAsync;
252 }
253
254 pVM->tm.s.VirtualGetRawDataGC.pu64Prev = MMHyperR3ToGC(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
255 pVM->tm.s.VirtualGetRawDataR0.pu64Prev = MMHyperR3ToR0(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
256 AssertReturn(pVM->tm.s.VirtualGetRawDataR0.pu64Prev, VERR_INTERNAL_ERROR);
257 /* The rest is done in TMR3InitFinalize since it's too early to call PDM. */
258
259
260 /*
261 * Get our CFGM node, create it if necessary.
262 */
263 PCFGMNODE pCfgHandle = CFGMR3GetChild(CFGMR3GetRoot(pVM), "TM");
264 if (!pCfgHandle)
265 {
266 rc = CFGMR3InsertNode(CFGMR3GetRoot(pVM), "TM", &pCfgHandle);
267 AssertRCReturn(rc, rc);
268 }
269
270 /*
271 * Determin the TSC configuration and frequency.
272 */
273 /* mode */
274 rc = CFGMR3QueryBool(pCfgHandle, "TSCVirtualized", &pVM->tm.s.fTSCVirtualized);
275 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
276 pVM->tm.s.fTSCVirtualized = true; /* trap rdtsc */
277 else if (VBOX_FAILURE(rc))
278 return VMSetError(pVM, rc, RT_SRC_POS,
279 N_("Configuration error: Failed to querying bool value \"UseRealTSC\""));
280
281 /* source */
282 rc = CFGMR3QueryBool(pCfgHandle, "UseRealTSC", &pVM->tm.s.fTSCUseRealTSC);
283 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
284 pVM->tm.s.fTSCUseRealTSC = false; /* use virtual time */
285 else if (VBOX_FAILURE(rc))
286 return VMSetError(pVM, rc, RT_SRC_POS,
287 N_("Configuration error: Failed to querying bool value \"UseRealTSC\""));
288 if (!pVM->tm.s.fTSCUseRealTSC)
289 pVM->tm.s.fTSCVirtualized = true;
290
291 /* TSC reliability */
292 rc = CFGMR3QueryBool(pCfgHandle, "MaybeUseOffsettedHostTSC", &pVM->tm.s.fMaybeUseOffsettedHostTSC);
293 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
294 {
295 if (!pVM->tm.s.fTSCUseRealTSC)
296 pVM->tm.s.fMaybeUseOffsettedHostTSC = tmR3HasFixedTSC(pVM);
297 else
298 pVM->tm.s.fMaybeUseOffsettedHostTSC = true;
299 }
300
301 /* frequency */
302 rc = CFGMR3QueryU64(pCfgHandle, "TSCTicksPerSecond", &pVM->tm.s.cTSCTicksPerSecond);
303 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
304 {
305 pVM->tm.s.cTSCTicksPerSecond = tmR3CalibrateTSC(pVM);
306 if ( !pVM->tm.s.fTSCUseRealTSC
307 && pVM->tm.s.cTSCTicksPerSecond >= _4G)
308 {
309 pVM->tm.s.cTSCTicksPerSecond = _4G - 1; /* (A limitation of our math code) */
310 pVM->tm.s.fMaybeUseOffsettedHostTSC = false;
311 }
312 }
313 else if (VBOX_FAILURE(rc))
314 return VMSetError(pVM, rc, RT_SRC_POS,
315 N_("Configuration error: Failed to querying uint64_t value \"TSCTicksPerSecond\""));
316 else if ( pVM->tm.s.cTSCTicksPerSecond < _1M
317 || pVM->tm.s.cTSCTicksPerSecond >= _4G)
318 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
319 N_("Configuration error: \"TSCTicksPerSecond\" = %RI64 is not in the range 1MHz..4GHz-1"),
320 pVM->tm.s.cTSCTicksPerSecond);
321 else
322 {
323 pVM->tm.s.fTSCUseRealTSC = pVM->tm.s.fMaybeUseOffsettedHostTSC = false;
324 pVM->tm.s.fTSCVirtualized = true;
325 }
326
327 /* setup and report */
328 if (pVM->tm.s.fTSCVirtualized)
329 CPUMR3SetCR4Feature(pVM, X86_CR4_TSD, ~X86_CR4_TSD);
330 else
331 CPUMR3SetCR4Feature(pVM, 0, ~X86_CR4_TSD);
332 LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%RU64) fTSCVirtualized=%RTbool fTSCUseRealTSC=%RTbool fMaybeUseOffsettedHostTSC=%RTbool\n",
333 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.fTSCVirtualized,
334 pVM->tm.s.fTSCUseRealTSC, pVM->tm.s.fMaybeUseOffsettedHostTSC));
335
336 /*
337 * Configure the timer synchronous virtual time.
338 */
339 rc = CFGMR3QueryU32(pCfgHandle, "ScheduleSlack", &pVM->tm.s.u32VirtualSyncScheduleSlack);
340 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
341 pVM->tm.s.u32VirtualSyncScheduleSlack = 100000; /* 0.100ms (ASSUMES virtual time is nanoseconds) */
342 else if (VBOX_FAILURE(rc))
343 return VMSetError(pVM, rc, RT_SRC_POS,
344 N_("Configuration error: Failed to querying 32-bit integer value \"ScheduleSlack\""));
345
346 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStopThreshold", &pVM->tm.s.u64VirtualSyncCatchUpStopThreshold);
347 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
348 pVM->tm.s.u64VirtualSyncCatchUpStopThreshold = 500000; /* 0.5ms */
349 else if (VBOX_FAILURE(rc))
350 return VMSetError(pVM, rc, RT_SRC_POS,
351 N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpStopThreshold\""));
352
353 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpGiveUpThreshold", &pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold);
354 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
355 pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold = UINT64_C(60000000000); /* 60 sec */
356 else if (VBOX_FAILURE(rc))
357 return VMSetError(pVM, rc, RT_SRC_POS,
358 N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpGiveUpThreshold\""));
359
360
361#define TM_CFG_PERIOD(iPeriod, DefStart, DefPct) \
362 do \
363 { \
364 uint64_t u64; \
365 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStartThreshold" #iPeriod, &u64); \
366 if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
367 u64 = UINT64_C(DefStart); \
368 else if (VBOX_FAILURE(rc)) \
369 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpThreshold" #iPeriod "\"")); \
370 if ( (iPeriod > 0 && u64 <= pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod - 1].u64Start) \
371 || u64 >= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold) \
372 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("Configuration error: Invalid start of period #" #iPeriod ": %RU64"), u64); \
373 pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u64Start = u64; \
374 rc = CFGMR3QueryU32(pCfgHandle, "CatchUpPrecentage" #iPeriod, &pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage); \
375 if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
376 pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage = (DefPct); \
377 else if (VBOX_FAILURE(rc)) \
378 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 32-bit integer value \"CatchUpPrecentage" #iPeriod "\"")); \
379 } while (0)
380 /* This needs more tuning. Not sure if we really need so many period and be so gentle. */
381 TM_CFG_PERIOD(0, 750000, 5); /* 0.75ms at 1.05x */
382 TM_CFG_PERIOD(1, 1500000, 10); /* 1.50ms at 1.10x */
383 TM_CFG_PERIOD(2, 8000000, 25); /* 8ms at 1.25x */
384 TM_CFG_PERIOD(3, 30000000, 50); /* 30ms at 1.50x */
385 TM_CFG_PERIOD(4, 75000000, 75); /* 75ms at 1.75x */
386 TM_CFG_PERIOD(5, 175000000, 100); /* 175ms at 2x */
387 TM_CFG_PERIOD(6, 500000000, 200); /* 500ms at 3x */
388 TM_CFG_PERIOD(7, 3000000000, 300); /* 3s at 4x */
389 TM_CFG_PERIOD(8,30000000000, 400); /* 30s at 5x */
390 TM_CFG_PERIOD(9,55000000000, 500); /* 55s at 6x */
391 AssertCompile(RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods) == 10);
392#undef TM_CFG_PERIOD
393
394 /*
395 * Configure real world time (UTC).
396 */
397 rc = CFGMR3QueryS64(pCfgHandle, "UTCOffset", &pVM->tm.s.offUTC);
398 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
399 pVM->tm.s.offUTC = 0; /* ns */
400 else if (VBOX_FAILURE(rc))
401 return VMSetError(pVM, rc, RT_SRC_POS,
402 N_("Configuration error: Failed to querying 64-bit integer value \"UTCOffset\""));
403
404 /*
405 * Setup the warp drive.
406 */
407 rc = CFGMR3QueryU32(pCfgHandle, "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage);
408 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
409 rc = CFGMR3QueryU32(CFGMR3GetRoot(pVM), "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage); /* legacy */
410 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
411 pVM->tm.s.u32VirtualWarpDrivePercentage = 100;
412 else if (VBOX_FAILURE(rc))
413 return VMSetError(pVM, rc, RT_SRC_POS,
414 N_("Configuration error: Failed to querying uint32_t value \"WarpDrivePercent\""));
415 else if ( pVM->tm.s.u32VirtualWarpDrivePercentage < 2
416 || pVM->tm.s.u32VirtualWarpDrivePercentage > 20000)
417 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
418 N_("Configuration error: \"WarpDrivePercent\" = %RI32 is not in the range 2..20000"),
419 pVM->tm.s.u32VirtualWarpDrivePercentage);
420 pVM->tm.s.fVirtualWarpDrive = pVM->tm.s.u32VirtualWarpDrivePercentage != 100;
421 if (pVM->tm.s.fVirtualWarpDrive)
422 LogRel(("TM: u32VirtualWarpDrivePercentage=%RI32\n", pVM->tm.s.u32VirtualWarpDrivePercentage));
423
424 /*
425 * Start the timer (guard against REM not yielding).
426 */
427 uint32_t u32Millies;
428 rc = CFGMR3QueryU32(pCfgHandle, "TimerMillies", &u32Millies);
429 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
430 u32Millies = 10;
431 else if (VBOX_FAILURE(rc))
432 return VMSetError(pVM, rc, RT_SRC_POS,
433 N_("Configuration error: Failed to query uint32_t value \"TimerMillies\""));
434 rc = RTTimerCreate(&pVM->tm.s.pTimer, u32Millies, tmR3TimerCallback, pVM);
435 if (VBOX_FAILURE(rc))
436 {
437 AssertMsgFailed(("Failed to create timer, u32Millies=%d rc=%Vrc.\n", u32Millies, rc));
438 return rc;
439 }
440 Log(("TM: Created timer %p firing every %d millieseconds\n", pVM->tm.s.pTimer, u32Millies));
441 pVM->tm.s.u32TimerMillies = u32Millies;
442
443 /*
444 * Register saved state.
445 */
446 rc = SSMR3RegisterInternal(pVM, "tm", 1, TM_SAVED_STATE_VERSION, sizeof(uint64_t) * 8,
447 NULL, tmR3Save, NULL,
448 NULL, tmR3Load, NULL);
449 if (VBOX_FAILURE(rc))
450 return rc;
451
452 /*
453 * Register statistics.
454 */
455 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).");
456 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).");
457 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).");
458 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).");
459 STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.c1nsSteps, STAMTYPE_U32, "/TM/GC/1nsSteps", STAMUNIT_OCCURENCES, "Virtual time 1ns steps (due to TSC / GIP variations).");
460 STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.cBadPrev, STAMTYPE_U32, "/TM/GC/cBadPrev", STAMUNIT_OCCURENCES, "Times the previous virtual time was considered erratic (shouldn't ever happen).");
461 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)");
462 STAM_REL_REG_USED(pVM, (void *)&pVM->tm.s.offVirtualSyncGivenUp, STAMTYPE_U64, "/TM/VirtualSync/GivenUp", STAMUNIT_NS, "Nanoseconds of the 'CurrentOffset' that's been given up and won't ever be attemted caught up with.");
463
464#ifdef VBOX_WITH_STATISTICS
465 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).");
466 STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataR3.cUpdateRaces,STAMTYPE_U32, "/TM/R3/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
467 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).");
468 STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataR0.cUpdateRaces,STAMTYPE_U32, "/TM/R0/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
469 STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.cExpired, STAMTYPE_U32, "/TM/GC/cExpired", STAMUNIT_OCCURENCES, "Times the TSC interval expired (overlaps 1ns steps).");
470 STAM_REG_USED( pVM, (void *)&pVM->tm.s.VirtualGetRawDataGC.cUpdateRaces,STAMTYPE_U32, "/TM/GC/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
471
472 STAM_REG(pVM, &pVM->tm.s.StatDoQueues, STAMTYPE_PROFILE, "/TM/DoQueues", STAMUNIT_TICKS_PER_CALL, "Profiling timer TMR3TimerQueuesDo.");
473 STAM_REG(pVM, &pVM->tm.s.StatDoQueuesSchedule, STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Schedule",STAMUNIT_TICKS_PER_CALL, "The scheduling part.");
474 STAM_REG(pVM, &pVM->tm.s.StatDoQueuesRun, STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Run", STAMUNIT_TICKS_PER_CALL, "The run part.");
475
476 STAM_REG(pVM, &pVM->tm.s.StatPollAlreadySet, STAMTYPE_COUNTER, "/TM/PollAlreadySet", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the FF was already set.");
477 STAM_REG(pVM, &pVM->tm.s.StatPollVirtual, STAMTYPE_COUNTER, "/TM/PollHitsVirtual", STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL queue.");
478 STAM_REG(pVM, &pVM->tm.s.StatPollVirtualSync, STAMTYPE_COUNTER, "/TM/PollHitsVirtualSync",STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL_SYNC queue.");
479 STAM_REG(pVM, &pVM->tm.s.StatPollMiss, STAMTYPE_COUNTER, "/TM/PollMiss", STAMUNIT_OCCURENCES, "TMTimerPoll calls where nothing had expired.");
480
481 STAM_REG(pVM, &pVM->tm.s.StatPostponedR3, STAMTYPE_COUNTER, "/TM/PostponedR3", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-3.");
482 STAM_REG(pVM, &pVM->tm.s.StatPostponedR0, STAMTYPE_COUNTER, "/TM/PostponedR0", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-0.");
483 STAM_REG(pVM, &pVM->tm.s.StatPostponedGC, STAMTYPE_COUNTER, "/TM/PostponedGC", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in GC.");
484
485 STAM_REG(pVM, &pVM->tm.s.StatScheduleOneGC, STAMTYPE_PROFILE, "/TM/ScheduleOneGC", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.\n");
486 STAM_REG(pVM, &pVM->tm.s.StatScheduleOneR0, STAMTYPE_PROFILE, "/TM/ScheduleOneR0", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.\n");
487 STAM_REG(pVM, &pVM->tm.s.StatScheduleOneR3, STAMTYPE_PROFILE, "/TM/ScheduleOneR3", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.\n");
488 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.");
489
490 STAM_REG(pVM, &pVM->tm.s.StatTimerSetGC, STAMTYPE_PROFILE, "/TM/TimerSetGC", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in GC.");
491 STAM_REG(pVM, &pVM->tm.s.StatTimerSetR0, STAMTYPE_PROFILE, "/TM/TimerSetR0", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0.");
492 STAM_REG(pVM, &pVM->tm.s.StatTimerSetR3, STAMTYPE_PROFILE, "/TM/TimerSetR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3.");
493
494 STAM_REG(pVM, &pVM->tm.s.StatTimerStopGC, STAMTYPE_PROFILE, "/TM/TimerStopGC", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in GC.");
495 STAM_REG(pVM, &pVM->tm.s.StatTimerStopR0, STAMTYPE_PROFILE, "/TM/TimerStopR0", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-0.");
496 STAM_REG(pVM, &pVM->tm.s.StatTimerStopR3, STAMTYPE_PROFILE, "/TM/TimerStopR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-3.");
497
498 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.");
499 STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualGetSetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGet.");
500 STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSync, STAMTYPE_COUNTER, "/TM/VirtualGetSync", STAMUNIT_OCCURENCES, "The number of times TMTimerGetSync was called when the clock was running.");
501 STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSyncSetFF,STAMTYPE_COUNTER, "/TM/VirtualGetSyncSetFF",STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGetSync.");
502 STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/VirtualPause", STAMUNIT_OCCURENCES, "The number of times TMR3TimerPause was called.");
503 STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/VirtualResume", STAMUNIT_OCCURENCES, "The number of times TMR3TimerResume was called.");
504
505 STAM_REG(pVM, &pVM->tm.s.StatTimerCallbackSetFF,STAMTYPE_COUNTER, "/TM/CallbackSetFF", STAMUNIT_OCCURENCES, "The number of times the timer callback set FF.");
506
507
508 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.");
509 STAM_REG(pVM, (void *)&pVM->tm.s.fVirtualSyncCatchUp, STAMTYPE_U8, "/TM/VirtualSync/CatchUpActive", STAMUNIT_NONE, "Catch-Up active indicator.");
510 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)");
511 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGiveUp, STAMTYPE_COUNTER, "/TM/VirtualSync/GiveUp", STAMUNIT_OCCURENCES, "Times the catch-up was abandoned.");
512 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++.)");
513 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRun, STAMTYPE_COUNTER, "/TM/VirtualSync/Run", STAMUNIT_OCCURENCES, "Times the virtual sync timer queue was considered.");
514 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunRestart, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/Restarts", STAMUNIT_OCCURENCES, "Times the clock was restarted after a run.");
515 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.");
516 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunStoppedAlready, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/StoppedAlready", STAMUNIT_OCCURENCES, "Times the clock was already stopped elsewhere (TMVirtualSyncGet).");
517 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.)");
518 for (unsigned i = 0; i < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods); i++)
519 {
520 STAMR3RegisterF(pVM, &pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "The catch-up percentage.", "/TM/VirtualSync/Periods/%u", i);
521 STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupAdjust[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times adjusted to this period.", "/TM/VirtualSync/Periods/%u/Adjust", i);
522 STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupInitial[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times started in this period.", "/TM/VirtualSync/Periods/%u/Initial", i);
523 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);
524 }
525
526#endif /* VBOX_WITH_STATISTICS */
527
528 /*
529 * Register info handlers.
530 */
531 DBGFR3InfoRegisterInternalEx(pVM, "timers", "Dumps all timers. No arguments.", tmR3TimerInfo, DBGFINFO_FLAGS_RUN_ON_EMT);
532 DBGFR3InfoRegisterInternalEx(pVM, "activetimers", "Dumps active all timers. No arguments.", tmR3TimerInfoActive, DBGFINFO_FLAGS_RUN_ON_EMT);
533 DBGFR3InfoRegisterInternalEx(pVM, "clocks", "Display the time of the various clocks.", tmR3InfoClocks, DBGFINFO_FLAGS_RUN_ON_EMT);
534
535 return VINF_SUCCESS;
536}
537
538
539/**
540 * Checks if the host CPU has a fixed TSC frequency.
541 *
542 * @returns true if it has, false if it hasn't.
543 *
544 * @remark This test doesn't bother with very old CPUs that don't do power
545 * management or any other stuff that might influence the TSC rate.
546 * This isn't currently relevant.
547 */
548static bool tmR3HasFixedTSC(PVM pVM)
549{
550 if (ASMHasCpuId())
551 {
552 uint32_t uEAX, uEBX, uECX, uEDX;
553
554 if (CPUMGetCPUVendor(pVM) == CPUMCPUVENDOR_AMD)
555 {
556 /*
557 * AuthenticAMD - Check for APM support and that TscInvariant is set.
558 *
559 * This test isn't correct with respect to fixed/non-fixed TSC and
560 * older models, but this isn't relevant since the result is currently
561 * only used for making a descision on AMD-V models.
562 */
563 ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
564 if (uEAX >= 0x80000007)
565 {
566 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
567
568 ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
569 if ( (uEDX & X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR) /* TscInvariant */
570 && pGip->u32Mode == SUPGIPMODE_SYNC_TSC /* no fixed tsc if the gip timer is in async mode */)
571 return true;
572 }
573 }
574 else if (CPUMGetCPUVendor(pVM) == CPUMCPUVENDOR_INTEL)
575 {
576 /*
577 * GenuineIntel - Check the model number.
578 *
579 * This test is lacking in the same way and for the same reasons
580 * as the AMD test above.
581 */
582 ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
583 unsigned uModel = (uEAX >> 4) & 0x0f;
584 unsigned uFamily = (uEAX >> 8) & 0x0f;
585 if (uFamily == 0x0f)
586 uFamily += (uEAX >> 20) & 0xff;
587 if (uFamily >= 0x06)
588 uModel += ((uEAX >> 16) & 0x0f) << 4;
589 if ( (uFamily == 0x0f /*P4*/ && uModel >= 0x03)
590 || (uFamily == 0x06 /*P2/P3*/ && uModel >= 0x0e))
591 return true;
592 }
593 }
594 return false;
595}
596
597
598/**
599 * Calibrate the CPU tick.
600 *
601 * @returns Number of ticks per second.
602 */
603static uint64_t tmR3CalibrateTSC(PVM pVM)
604{
605 /*
606 * Use GIP when available present.
607 */
608 uint64_t u64Hz;
609 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
610 if ( pGip
611 && pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC)
612 {
613 unsigned iCpu = pGip->u32Mode != SUPGIPMODE_ASYNC_TSC ? 0 : ASMGetApicId();
614 if (iCpu >= RT_ELEMENTS(pGip->aCPUs))
615 AssertReleaseMsgFailed(("iCpu=%d - the ApicId is too high. send VBox.log and hardware specs!\n", iCpu));
616 else
617 {
618 if (tmR3HasFixedTSC(pVM))
619 /* Sleep a bit to get a more reliable CpuHz value. */
620 RTThreadSleep(32);
621 else
622 {
623 /* Spin for 40ms to try push up the CPU frequency and get a more reliable CpuHz value. */
624 const uint64_t u64 = RTTimeMilliTS();
625 while ((RTTimeMilliTS() - u64) < 40 /*ms*/)
626 /* nothing */;
627 }
628
629 pGip = g_pSUPGlobalInfoPage;
630 if ( pGip
631 && pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC
632 && (u64Hz = pGip->aCPUs[iCpu].u64CpuHz)
633 && u64Hz != ~(uint64_t)0)
634 return u64Hz;
635 }
636 }
637
638 /* call this once first to make sure it's initialized. */
639 RTTimeNanoTS();
640
641 /*
642 * Yield the CPU to increase our chances of getting
643 * a correct value.
644 */
645 RTThreadYield(); /* Try avoid interruptions between TSC and NanoTS samplings. */
646 static const unsigned s_auSleep[5] = { 50, 30, 30, 40, 40 };
647 uint64_t au64Samples[5];
648 unsigned i;
649 for (i = 0; i < ELEMENTS(au64Samples); i++)
650 {
651 unsigned cMillies;
652 int cTries = 5;
653 uint64_t u64Start = ASMReadTSC();
654 uint64_t u64End;
655 uint64_t StartTS = RTTimeNanoTS();
656 uint64_t EndTS;
657 do
658 {
659 RTThreadSleep(s_auSleep[i]);
660 u64End = ASMReadTSC();
661 EndTS = RTTimeNanoTS();
662 cMillies = (unsigned)((EndTS - StartTS + 500000) / 1000000);
663 } while ( cMillies == 0 /* the sleep may be interrupted... */
664 || (cMillies < 20 && --cTries > 0));
665 uint64_t u64Diff = u64End - u64Start;
666
667 au64Samples[i] = (u64Diff * 1000) / cMillies;
668 AssertMsg(cTries > 0, ("cMillies=%d i=%d\n", cMillies, i));
669 }
670
671 /*
672 * Discard the highest and lowest results and calculate the average.
673 */
674 unsigned iHigh = 0;
675 unsigned iLow = 0;
676 for (i = 1; i < ELEMENTS(au64Samples); i++)
677 {
678 if (au64Samples[i] < au64Samples[iLow])
679 iLow = i;
680 if (au64Samples[i] > au64Samples[iHigh])
681 iHigh = i;
682 }
683 au64Samples[iLow] = 0;
684 au64Samples[iHigh] = 0;
685
686 u64Hz = au64Samples[0];
687 for (i = 1; i < ELEMENTS(au64Samples); i++)
688 u64Hz += au64Samples[i];
689 u64Hz /= ELEMENTS(au64Samples) - 2;
690
691 return u64Hz;
692}
693
694
695/**
696 * Finalizes the TM initialization.
697 *
698 * @returns VBox status code.
699 * @param pVM The VM to operate on.
700 */
701TMR3DECL(int) TMR3InitFinalize(PVM pVM)
702{
703 int rc;
704
705 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataGC.pfnBad);
706 AssertRCReturn(rc, rc);
707 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataGC.pfnRediscover);
708 AssertRCReturn(rc, rc);
709 if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceSync)
710 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLFenceSync", &pVM->tm.s.pfnVirtualGetRawGC);
711 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceAsync)
712 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLFenceAsync", &pVM->tm.s.pfnVirtualGetRawGC);
713 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacySync)
714 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLegacySync", &pVM->tm.s.pfnVirtualGetRawGC);
715 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacyAsync)
716 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLegacyAsync", &pVM->tm.s.pfnVirtualGetRawGC);
717 else
718 AssertFatalFailed();
719 AssertRCReturn(rc, rc);
720
721 rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataR0.pfnBad);
722 AssertRCReturn(rc, rc);
723 rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataR0.pfnRediscover);
724 AssertRCReturn(rc, rc);
725 if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceSync)
726 rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLFenceSync", &pVM->tm.s.pfnVirtualGetRawR0);
727 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceAsync)
728 rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLFenceAsync", &pVM->tm.s.pfnVirtualGetRawR0);
729 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacySync)
730 rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLegacySync", &pVM->tm.s.pfnVirtualGetRawR0);
731 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacyAsync)
732 rc = PDMR3GetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLegacyAsync", &pVM->tm.s.pfnVirtualGetRawR0);
733 else
734 AssertFatalFailed();
735 AssertRCReturn(rc, rc);
736
737 return VINF_SUCCESS;
738}
739
740
741/**
742 * Applies relocations to data and code managed by this
743 * component. This function will be called at init and
744 * whenever the VMM need to relocate it self inside the GC.
745 *
746 * @param pVM The VM.
747 * @param offDelta Relocation delta relative to old location.
748 */
749TMR3DECL(void) TMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
750{
751 int rc;
752 LogFlow(("TMR3Relocate\n"));
753
754 pVM->tm.s.pvGIPGC = MMHyperR3ToGC(pVM, pVM->tm.s.pvGIPR3);
755 pVM->tm.s.paTimerQueuesGC = MMHyperR3ToGC(pVM, pVM->tm.s.paTimerQueuesR3);
756 pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pVM->tm.s.paTimerQueuesR3);
757
758 pVM->tm.s.VirtualGetRawDataGC.pu64Prev = MMHyperR3ToGC(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
759 AssertFatal(pVM->tm.s.VirtualGetRawDataGC.pu64Prev);
760 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataGC.pfnBad);
761 AssertFatalRC(rc);
762 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataGC.pfnRediscover);
763 AssertFatalRC(rc);
764
765 if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceSync)
766 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLFenceSync", &pVM->tm.s.pfnVirtualGetRawGC);
767 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceAsync)
768 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLFenceAsync", &pVM->tm.s.pfnVirtualGetRawGC);
769 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacySync)
770 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLegacySync", &pVM->tm.s.pfnVirtualGetRawGC);
771 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacyAsync)
772 rc = PDMR3GetSymbolGCLazy(pVM, NULL, "RTTimeNanoTSLegacyAsync", &pVM->tm.s.pfnVirtualGetRawGC);
773 else
774 AssertFatalFailed();
775 AssertFatalRC(rc);
776
777 /*
778 * Iterate the timers updating the pVMGC pointers.
779 */
780 for (PTMTIMER pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
781 {
782 pTimer->pVMGC = pVM->pVMGC;
783 pTimer->pVMR0 = pVM->pVMR0;
784 }
785}
786
787
788/**
789 * Terminates the TM.
790 *
791 * Termination means cleaning up and freeing all resources,
792 * the VM it self is at this point powered off or suspended.
793 *
794 * @returns VBox status code.
795 * @param pVM The VM to operate on.
796 */
797TMR3DECL(int) TMR3Term(PVM pVM)
798{
799 AssertMsg(pVM->tm.s.offVM, ("bad init order!\n"));
800 if (pVM->tm.s.pTimer)
801 {
802 int rc = RTTimerDestroy(pVM->tm.s.pTimer);
803 AssertRC(rc);
804 pVM->tm.s.pTimer = NULL;
805 }
806
807 return VINF_SUCCESS;
808}
809
810
811/**
812 * The VM is being reset.
813 *
814 * For the TM component this means that a rescheduling is preformed,
815 * the FF is cleared and but without running the queues. We'll have to
816 * check if this makes sense or not, but it seems like a good idea now....
817 *
818 * @param pVM VM handle.
819 */
820TMR3DECL(void) TMR3Reset(PVM pVM)
821{
822 LogFlow(("TMR3Reset:\n"));
823 VM_ASSERT_EMT(pVM);
824
825 /*
826 * Abort any pending catch up.
827 * This isn't perfect,
828 */
829 if (pVM->tm.s.fVirtualSyncCatchUp)
830 {
831 const uint64_t offVirtualNow = TMVirtualGetEx(pVM, false /* don't check timers */);
832 const uint64_t offVirtualSyncNow = TMVirtualSyncGetEx(pVM, false /* don't check timers */);
833 if (pVM->tm.s.fVirtualSyncCatchUp)
834 {
835 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
836
837 const uint64_t offOld = pVM->tm.s.offVirtualSyncGivenUp;
838 const uint64_t offNew = offVirtualNow - offVirtualSyncNow;
839 Assert(offOld <= offNew);
840 ASMAtomicXchgU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
841 ASMAtomicXchgU64((uint64_t volatile *)&pVM->tm.s.offVirtualSync, offNew);
842 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
843 LogRel(("TM: Aborting catch-up attempt on reset with a %RU64 ns lag on reset; new total: %RU64 ns\n", offNew - offOld, offNew));
844 }
845 }
846
847 /*
848 * Process the queues.
849 */
850 for (int i = 0; i < TMCLOCK_MAX; i++)
851 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[i]);
852#ifdef VBOX_STRICT
853 tmTimerQueuesSanityChecks(pVM, "TMR3Reset");
854#endif
855 VM_FF_CLEAR(pVM, VM_FF_TIMER);
856}
857
858
859/**
860 * Resolve a builtin GC symbol.
861 * Called by PDM when loading or relocating GC modules.
862 *
863 * @returns VBox status
864 * @param pVM VM Handle.
865 * @param pszSymbol Symbol to resolv
866 * @param pGCPtrValue Where to store the symbol value.
867 * @remark This has to work before TMR3Relocate() is called.
868 */
869TMR3DECL(int) TMR3GetImportGC(PVM pVM, const char *pszSymbol, PRTGCPTR pGCPtrValue)
870{
871 if (!strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
872 *pGCPtrValue = MMHyperHC2GC(pVM, &pVM->tm.s.pvGIPGC);
873 //else if (..)
874 else
875 return VERR_SYMBOL_NOT_FOUND;
876 return VINF_SUCCESS;
877}
878
879
880/**
881 * Execute state save operation.
882 *
883 * @returns VBox status code.
884 * @param pVM VM Handle.
885 * @param pSSM SSM operation handle.
886 */
887static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM)
888{
889 LogFlow(("tmR3Save:\n"));
890 Assert(!pVM->tm.s.fTSCTicking);
891 Assert(!pVM->tm.s.fVirtualTicking);
892 Assert(!pVM->tm.s.fVirtualSyncTicking);
893
894 /*
895 * Save the virtual clocks.
896 */
897 /* the virtual clock. */
898 SSMR3PutU64(pSSM, TMCLOCK_FREQ_VIRTUAL);
899 SSMR3PutU64(pSSM, pVM->tm.s.u64Virtual);
900
901 /* the virtual timer synchronous clock. */
902 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSync);
903 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSync);
904 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSyncGivenUp);
905 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSyncCatchUpPrev);
906 SSMR3PutBool(pSSM, pVM->tm.s.fVirtualSyncCatchUp);
907
908 /* real time clock */
909 SSMR3PutU64(pSSM, TMCLOCK_FREQ_REAL);
910
911 /* the cpu tick clock. */
912 SSMR3PutU64(pSSM, TMCpuTickGet(pVM));
913 return SSMR3PutU64(pSSM, pVM->tm.s.cTSCTicksPerSecond);
914}
915
916
917/**
918 * Execute state load operation.
919 *
920 * @returns VBox status code.
921 * @param pVM VM Handle.
922 * @param pSSM SSM operation handle.
923 * @param u32Version Data layout version.
924 */
925static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version)
926{
927 LogFlow(("tmR3Load:\n"));
928 Assert(!pVM->tm.s.fTSCTicking);
929 Assert(!pVM->tm.s.fVirtualTicking);
930 Assert(!pVM->tm.s.fVirtualSyncTicking);
931
932 /*
933 * Validate version.
934 */
935 if (u32Version != TM_SAVED_STATE_VERSION)
936 {
937 Log(("tmR3Load: Invalid version u32Version=%d!\n", u32Version));
938 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
939 }
940
941 /*
942 * Load the virtual clock.
943 */
944 pVM->tm.s.fVirtualTicking = false;
945 /* the virtual clock. */
946 uint64_t u64Hz;
947 int rc = SSMR3GetU64(pSSM, &u64Hz);
948 if (VBOX_FAILURE(rc))
949 return rc;
950 if (u64Hz != TMCLOCK_FREQ_VIRTUAL)
951 {
952 AssertMsgFailed(("The virtual clock frequency differs! Saved: %RU64 Binary: %RU64\n",
953 u64Hz, TMCLOCK_FREQ_VIRTUAL));
954 return VERR_SSM_VIRTUAL_CLOCK_HZ;
955 }
956 SSMR3GetU64(pSSM, &pVM->tm.s.u64Virtual);
957 pVM->tm.s.u64VirtualOffset = 0;
958
959 /* the virtual timer synchronous clock. */
960 pVM->tm.s.fVirtualSyncTicking = false;
961 uint64_t u64;
962 SSMR3GetU64(pSSM, &u64);
963 pVM->tm.s.u64VirtualSync = u64;
964 SSMR3GetU64(pSSM, &u64);
965 pVM->tm.s.offVirtualSync = u64;
966 SSMR3GetU64(pSSM, &u64);
967 pVM->tm.s.offVirtualSyncGivenUp = u64;
968 SSMR3GetU64(pSSM, &u64);
969 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64;
970 bool f;
971 SSMR3GetBool(pSSM, &f);
972 pVM->tm.s.fVirtualSyncCatchUp = f;
973
974 /* the real clock */
975 rc = SSMR3GetU64(pSSM, &u64Hz);
976 if (VBOX_FAILURE(rc))
977 return rc;
978 if (u64Hz != TMCLOCK_FREQ_REAL)
979 {
980 AssertMsgFailed(("The real clock frequency differs! Saved: %RU64 Binary: %RU64\n",
981 u64Hz, TMCLOCK_FREQ_REAL));
982 return VERR_SSM_VIRTUAL_CLOCK_HZ; /* missleading... */
983 }
984
985 /* the cpu tick clock. */
986 pVM->tm.s.fTSCTicking = false;
987 SSMR3GetU64(pSSM, &pVM->tm.s.u64TSC);
988 rc = SSMR3GetU64(pSSM, &u64Hz);
989 if (VBOX_FAILURE(rc))
990 return rc;
991 if (pVM->tm.s.fTSCUseRealTSC)
992 pVM->tm.s.u64TSCOffset = 0; /** @todo TSC restore stuff and HWACC. */
993 else
994 pVM->tm.s.cTSCTicksPerSecond = u64Hz;
995 LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%RU64) fTSCVirtualized=%RTbool fTSCUseRealTSC=%RTbool (state load)\n",
996 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.fTSCVirtualized, pVM->tm.s.fTSCUseRealTSC));
997
998 /*
999 * Make sure timers get rescheduled immediately.
1000 */
1001 VM_FF_SET(pVM, VM_FF_TIMER);
1002
1003 return VINF_SUCCESS;
1004}
1005
1006
1007/**
1008 * Internal TMR3TimerCreate worker.
1009 *
1010 * @returns VBox status code.
1011 * @param pVM The VM handle.
1012 * @param enmClock The timer clock.
1013 * @param pszDesc The timer description.
1014 * @param ppTimer Where to store the timer pointer on success.
1015 */
1016static int tmr3TimerCreate(PVM pVM, TMCLOCK enmClock, const char *pszDesc, PPTMTIMERR3 ppTimer)
1017{
1018 VM_ASSERT_EMT(pVM);
1019
1020 /*
1021 * Allocate the timer.
1022 */
1023 PTMTIMERR3 pTimer = NULL;
1024 if (pVM->tm.s.pFree && VM_IS_EMT(pVM))
1025 {
1026 pTimer = pVM->tm.s.pFree;
1027 pVM->tm.s.pFree = pTimer->pBigNext;
1028 Log3(("TM: Recycling timer %p, new free head %p.\n", pTimer, pTimer->pBigNext));
1029 }
1030
1031 if (!pTimer)
1032 {
1033 int rc = MMHyperAlloc(pVM, sizeof(*pTimer), 0, MM_TAG_TM, (void **)&pTimer);
1034 if (VBOX_FAILURE(rc))
1035 return rc;
1036 Log3(("TM: Allocated new timer %p\n", pTimer));
1037 }
1038
1039 /*
1040 * Initialize it.
1041 */
1042 pTimer->u64Expire = 0;
1043 pTimer->enmClock = enmClock;
1044 pTimer->pVMR3 = pVM;
1045 pTimer->pVMR0 = pVM->pVMR0;
1046 pTimer->pVMGC = pVM->pVMGC;
1047 pTimer->enmState = TMTIMERSTATE_STOPPED;
1048 pTimer->offScheduleNext = 0;
1049 pTimer->offNext = 0;
1050 pTimer->offPrev = 0;
1051 pTimer->pszDesc = pszDesc;
1052
1053 /* insert into the list of created timers. */
1054 pTimer->pBigPrev = NULL;
1055 pTimer->pBigNext = pVM->tm.s.pCreated;
1056 pVM->tm.s.pCreated = pTimer;
1057 if (pTimer->pBigNext)
1058 pTimer->pBigNext->pBigPrev = pTimer;
1059#ifdef VBOX_STRICT
1060 tmTimerQueuesSanityChecks(pVM, "tmR3TimerCreate");
1061#endif
1062
1063 *ppTimer = pTimer;
1064 return VINF_SUCCESS;
1065}
1066
1067
1068/**
1069 * Creates a device timer.
1070 *
1071 * @returns VBox status.
1072 * @param pVM The VM to create the timer in.
1073 * @param pDevIns Device instance.
1074 * @param enmClock The clock to use on this timer.
1075 * @param pfnCallback Callback function.
1076 * @param pszDesc Pointer to description string which must stay around
1077 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1078 * @param ppTimer Where to store the timer on success.
1079 */
1080TMR3DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
1081{
1082 /*
1083 * Allocate and init stuff.
1084 */
1085 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1086 if (VBOX_SUCCESS(rc))
1087 {
1088 (*ppTimer)->enmType = TMTIMERTYPE_DEV;
1089 (*ppTimer)->u.Dev.pfnTimer = pfnCallback;
1090 (*ppTimer)->u.Dev.pDevIns = pDevIns;
1091 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1092 }
1093
1094 return rc;
1095}
1096
1097
1098/**
1099 * Creates a driver timer.
1100 *
1101 * @returns VBox status.
1102 * @param pVM The VM to create the timer in.
1103 * @param pDrvIns Driver instance.
1104 * @param enmClock The clock to use on this timer.
1105 * @param pfnCallback Callback function.
1106 * @param pszDesc Pointer to description string which must stay around
1107 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1108 * @param ppTimer Where to store the timer on success.
1109 */
1110TMR3DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
1111{
1112 /*
1113 * Allocate and init stuff.
1114 */
1115 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1116 if (VBOX_SUCCESS(rc))
1117 {
1118 (*ppTimer)->enmType = TMTIMERTYPE_DRV;
1119 (*ppTimer)->u.Drv.pfnTimer = pfnCallback;
1120 (*ppTimer)->u.Drv.pDrvIns = pDrvIns;
1121 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1122 }
1123
1124 return rc;
1125}
1126
1127
1128/**
1129 * Creates an internal timer.
1130 *
1131 * @returns VBox status.
1132 * @param pVM The VM to create the timer in.
1133 * @param enmClock The clock to use on this timer.
1134 * @param pfnCallback Callback function.
1135 * @param pvUser User argument to be passed to the callback.
1136 * @param pszDesc Pointer to description string which must stay around
1137 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1138 * @param ppTimer Where to store the timer on success.
1139 */
1140TMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer)
1141{
1142 /*
1143 * Allocate and init stuff.
1144 */
1145 PTMTIMER pTimer;
1146 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1147 if (VBOX_SUCCESS(rc))
1148 {
1149 pTimer->enmType = TMTIMERTYPE_INTERNAL;
1150 pTimer->u.Internal.pfnTimer = pfnCallback;
1151 pTimer->u.Internal.pvUser = pvUser;
1152 *ppTimer = pTimer;
1153 Log(("TM: Created internal timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1154 }
1155
1156 return rc;
1157}
1158
1159/**
1160 * Creates an external timer.
1161 *
1162 * @returns Timer handle on success.
1163 * @returns NULL on failure.
1164 * @param pVM The VM to create the timer in.
1165 * @param enmClock The clock to use on this timer.
1166 * @param pfnCallback Callback function.
1167 * @param pvUser User argument.
1168 * @param pszDesc Pointer to description string which must stay around
1169 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1170 */
1171TMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc)
1172{
1173 /*
1174 * Allocate and init stuff.
1175 */
1176 PTMTIMERR3 pTimer;
1177 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1178 if (VBOX_SUCCESS(rc))
1179 {
1180 pTimer->enmType = TMTIMERTYPE_EXTERNAL;
1181 pTimer->u.External.pfnTimer = pfnCallback;
1182 pTimer->u.External.pvUser = pvUser;
1183 Log(("TM: Created external timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1184 return pTimer;
1185 }
1186
1187 return NULL;
1188}
1189
1190
1191/**
1192 * Destroy all timers owned by a device.
1193 *
1194 * @returns VBox status.
1195 * @param pVM VM handle.
1196 * @param pDevIns Device which timers should be destroyed.
1197 */
1198TMR3DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns)
1199{
1200 LogFlow(("TMR3TimerDestroyDevice: pDevIns=%p\n", pDevIns));
1201 if (!pDevIns)
1202 return VERR_INVALID_PARAMETER;
1203
1204 PTMTIMER pCur = pVM->tm.s.pCreated;
1205 while (pCur)
1206 {
1207 PTMTIMER pDestroy = pCur;
1208 pCur = pDestroy->pBigNext;
1209 if ( pDestroy->enmType == TMTIMERTYPE_DEV
1210 && pDestroy->u.Dev.pDevIns == pDevIns)
1211 {
1212 int rc = TMTimerDestroy(pDestroy);
1213 AssertRC(rc);
1214 }
1215 }
1216 LogFlow(("TMR3TimerDestroyDevice: returns VINF_SUCCESS\n"));
1217 return VINF_SUCCESS;
1218}
1219
1220
1221/**
1222 * Destroy all timers owned by a driver.
1223 *
1224 * @returns VBox status.
1225 * @param pVM VM handle.
1226 * @param pDrvIns Driver which timers should be destroyed.
1227 */
1228TMR3DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns)
1229{
1230 LogFlow(("TMR3TimerDestroyDriver: pDrvIns=%p\n", pDrvIns));
1231 if (!pDrvIns)
1232 return VERR_INVALID_PARAMETER;
1233
1234 PTMTIMER pCur = pVM->tm.s.pCreated;
1235 while (pCur)
1236 {
1237 PTMTIMER pDestroy = pCur;
1238 pCur = pDestroy->pBigNext;
1239 if ( pDestroy->enmType == TMTIMERTYPE_DRV
1240 && pDestroy->u.Drv.pDrvIns == pDrvIns)
1241 {
1242 int rc = TMTimerDestroy(pDestroy);
1243 AssertRC(rc);
1244 }
1245 }
1246 LogFlow(("TMR3TimerDestroyDriver: returns VINF_SUCCESS\n"));
1247 return VINF_SUCCESS;
1248}
1249
1250
1251/**
1252 * Checks if the sync queue has one or more expired timers.
1253 *
1254 * @returns true / false.
1255 *
1256 * @param pVM The VM handle.
1257 * @param enmClock The queue.
1258 */
1259DECLINLINE(bool) tmR3HasExpiredTimer(PVM pVM, TMCLOCK enmClock)
1260{
1261 const uint64_t u64Expire = pVM->tm.s.CTXALLSUFF(paTimerQueues)[enmClock].u64Expire;
1262 return u64Expire != INT64_MAX && u64Expire <= tmClock(pVM, enmClock);
1263}
1264
1265
1266/**
1267 * Checks for expired timers in all the queues.
1268 *
1269 * @returns true / false.
1270 * @param pVM The VM handle.
1271 */
1272DECLINLINE(bool) tmR3AnyExpiredTimers(PVM pVM)
1273{
1274 /*
1275 * Combine the time calculation for the first two since we're not on EMT
1276 * TMVirtualSyncGet only permits EMT.
1277 */
1278 uint64_t u64Now = TMVirtualGet(pVM);
1279 if (pVM->tm.s.CTXALLSUFF(paTimerQueues)[TMCLOCK_VIRTUAL].u64Expire <= u64Now)
1280 return true;
1281 u64Now = pVM->tm.s.fVirtualSyncTicking
1282 ? u64Now - pVM->tm.s.offVirtualSync
1283 : pVM->tm.s.u64VirtualSync;
1284 if (pVM->tm.s.CTXALLSUFF(paTimerQueues)[TMCLOCK_VIRTUAL_SYNC].u64Expire <= u64Now)
1285 return true;
1286
1287 /*
1288 * The remaining timers.
1289 */
1290 if (tmR3HasExpiredTimer(pVM, TMCLOCK_REAL))
1291 return true;
1292 if (tmR3HasExpiredTimer(pVM, TMCLOCK_TSC))
1293 return true;
1294 return false;
1295}
1296
1297
1298/**
1299 * Schedulation timer callback.
1300 *
1301 * @param pTimer Timer handle.
1302 * @param pvUser VM handle.
1303 * @thread Timer thread.
1304 *
1305 * @remark We cannot do the scheduling and queues running from a timer handler
1306 * since it's not executing in EMT, and even if it was it would be async
1307 * and we wouldn't know the state of the affairs.
1308 * So, we'll just raise the timer FF and force any REM execution to exit.
1309 */
1310static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t /*iTick*/)
1311{
1312 PVM pVM = (PVM)pvUser;
1313 AssertCompile(TMCLOCK_MAX == 4);
1314#ifdef DEBUG_Sander /* very annoying, keep it private. */
1315 if (VM_FF_ISSET(pVM, VM_FF_TIMER))
1316 Log(("tmR3TimerCallback: timer event still pending!!\n"));
1317#endif
1318 if ( !VM_FF_ISSET(pVM, VM_FF_TIMER)
1319 && ( pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule
1320 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule
1321 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule
1322 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offSchedule
1323 || tmR3AnyExpiredTimers(pVM)
1324 )
1325 && !VM_FF_ISSET(pVM, VM_FF_TIMER)
1326 )
1327 {
1328 VM_FF_SET(pVM, VM_FF_TIMER);
1329 REMR3NotifyTimerPending(pVM);
1330 VMR3NotifyFF(pVM, true);
1331 STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallbackSetFF);
1332 }
1333}
1334
1335
1336/**
1337 * Schedules and runs any pending timers.
1338 *
1339 * This is normally called from a forced action handler in EMT.
1340 *
1341 * @param pVM The VM to run the timers for.
1342 */
1343TMR3DECL(void) TMR3TimerQueuesDo(PVM pVM)
1344{
1345 STAM_PROFILE_START(&pVM->tm.s.StatDoQueues, a);
1346 Log2(("TMR3TimerQueuesDo:\n"));
1347
1348 /*
1349 * Process the queues.
1350 */
1351 AssertCompile(TMCLOCK_MAX == 4);
1352
1353 /* TMCLOCK_VIRTUAL_SYNC */
1354 STAM_PROFILE_ADV_START(&pVM->tm.s.StatDoQueuesSchedule, s1);
1355 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC]);
1356 STAM_PROFILE_ADV_SUSPEND(&pVM->tm.s.StatDoQueuesSchedule, s1);
1357 STAM_PROFILE_ADV_START(&pVM->tm.s.StatDoQueuesRun, r1);
1358 tmR3TimerQueueRunVirtualSync(pVM);
1359 STAM_PROFILE_ADV_SUSPEND(&pVM->tm.s.StatDoQueuesRun, r1);
1360
1361 /* TMCLOCK_VIRTUAL */
1362 STAM_PROFILE_ADV_RESUME(&pVM->tm.s.StatDoQueuesSchedule, s1);
1363 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
1364 STAM_PROFILE_ADV_SUSPEND(&pVM->tm.s.StatDoQueuesSchedule, s2);
1365 STAM_PROFILE_ADV_RESUME(&pVM->tm.s.StatDoQueuesRun, r1);
1366 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
1367 STAM_PROFILE_ADV_SUSPEND(&pVM->tm.s.StatDoQueuesRun, r2);
1368
1369#if 0 /** @todo if ever used, remove this and fix the stam prefixes on TMCLOCK_REAL below. */
1370 /* TMCLOCK_TSC */
1371 STAM_PROFILE_ADV_RESUME(&pVM->tm.s.StatDoQueuesSchedule, s2);
1372 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC]);
1373 STAM_PROFILE_ADV_SUSPEND(&pVM->tm.s.StatDoQueuesSchedule, s3);
1374 STAM_PROFILE_ADV_RESUME(&pVM->tm.s.StatDoQueuesRun, r2);
1375 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC]);
1376 STAM_PROFILE_ADV_SUSPEND(&pVM->tm.s.StatDoQueuesRun, r3);
1377#endif
1378
1379 /* TMCLOCK_REAL */
1380 STAM_PROFILE_ADV_RESUME(&pVM->tm.s.StatDoQueuesSchedule, s2);
1381 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
1382 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatDoQueuesSchedule, s3);
1383 STAM_PROFILE_ADV_RESUME(&pVM->tm.s.StatDoQueuesRun, r2);
1384 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
1385 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatDoQueuesRun, r3);
1386
1387 /* done. */
1388 VM_FF_CLEAR(pVM, VM_FF_TIMER);
1389
1390#ifdef VBOX_STRICT
1391 /* check that we didn't screwup. */
1392 tmTimerQueuesSanityChecks(pVM, "TMR3TimerQueuesDo");
1393#endif
1394
1395 Log2(("TMR3TimerQueuesDo: returns void\n"));
1396 STAM_PROFILE_STOP(&pVM->tm.s.StatDoQueues, a);
1397}
1398
1399
1400/**
1401 * Schedules and runs any pending times in the specified queue.
1402 *
1403 * This is normally called from a forced action handler in EMT.
1404 *
1405 * @param pVM The VM to run the timers for.
1406 * @param pQueue The queue to run.
1407 */
1408static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue)
1409{
1410 VM_ASSERT_EMT(pVM);
1411
1412 /*
1413 * Run timers.
1414 *
1415 * We check the clock once and run all timers which are ACTIVE
1416 * and have an expire time less or equal to the time we read.
1417 *
1418 * N.B. A generic unlink must be applied since other threads
1419 * are allowed to mess with any active timer at any time.
1420 * However, we only allow EMT to handle EXPIRED_PENDING
1421 * timers, thus enabling the timer handler function to
1422 * arm the timer again.
1423 */
1424 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
1425 if (!pNext)
1426 return;
1427 const uint64_t u64Now = tmClock(pVM, pQueue->enmClock);
1428 while (pNext && pNext->u64Expire <= u64Now)
1429 {
1430 PTMTIMER pTimer = pNext;
1431 pNext = TMTIMER_GET_NEXT(pTimer);
1432 Log2(("tmR3TimerQueueRun: pTimer=%p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
1433 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
1434 bool fRc;
1435 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED, TMTIMERSTATE_ACTIVE, fRc);
1436 if (fRc)
1437 {
1438 Assert(!pTimer->offScheduleNext); /* this can trigger falsely */
1439
1440 /* unlink */
1441 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1442 if (pPrev)
1443 TMTIMER_SET_NEXT(pPrev, pNext);
1444 else
1445 {
1446 TMTIMER_SET_HEAD(pQueue, pNext);
1447 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1448 }
1449 if (pNext)
1450 TMTIMER_SET_PREV(pNext, pPrev);
1451 pTimer->offNext = 0;
1452 pTimer->offPrev = 0;
1453
1454
1455 /* fire */
1456 switch (pTimer->enmType)
1457 {
1458 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer); break;
1459 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer); break;
1460 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->u.Internal.pvUser); break;
1461 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->u.External.pvUser); break;
1462 default:
1463 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
1464 break;
1465 }
1466
1467 /* change the state if it wasn't changed already in the handler. */
1468 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED, fRc);
1469 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
1470 }
1471 } /* run loop */
1472}
1473
1474
1475/**
1476 * Schedules and runs any pending times in the timer queue for the
1477 * synchronous virtual clock.
1478 *
1479 * This scheduling is a bit different from the other queues as it need
1480 * to implement the special requirements of the timer synchronous virtual
1481 * clock, thus this 2nd queue run funcion.
1482 *
1483 * @param pVM The VM to run the timers for.
1484 */
1485static void tmR3TimerQueueRunVirtualSync(PVM pVM)
1486{
1487 PTMTIMERQUEUE const pQueue = &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC];
1488 VM_ASSERT_EMT(pVM);
1489
1490 /*
1491 * Any timers?
1492 */
1493 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
1494 if (RT_UNLIKELY(!pNext))
1495 {
1496 Assert(pVM->tm.s.fVirtualSyncTicking || !pVM->tm.s.fVirtualTicking);
1497 return;
1498 }
1499 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRun);
1500
1501 /*
1502 * Calculate the time frame for which we will dispatch timers.
1503 *
1504 * We use a time frame ranging from the current sync time (which is most likely the
1505 * same as the head timer) and some configurable period (100000ns) up towards the
1506 * current virtual time. This period might also need to be restricted by the catch-up
1507 * rate so frequent calls to this function won't accelerate the time too much, however
1508 * this will be implemented at a later point if neccessary.
1509 *
1510 * Without this frame we would 1) having to run timers much more frequently
1511 * and 2) lag behind at a steady rate.
1512 */
1513 const uint64_t u64VirtualNow = TMVirtualGetEx(pVM, false /* don't check timers */);
1514 uint64_t u64Now;
1515 if (!pVM->tm.s.fVirtualSyncTicking)
1516 {
1517 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStoppedAlready);
1518 u64Now = pVM->tm.s.u64VirtualSync;
1519 Assert(u64Now <= pNext->u64Expire);
1520 }
1521 else
1522 {
1523 /* Calc 'now'. (update order doesn't really matter here) */
1524 uint64_t off = pVM->tm.s.offVirtualSync;
1525 if (pVM->tm.s.fVirtualSyncCatchUp)
1526 {
1527 uint64_t u64Delta = u64VirtualNow - pVM->tm.s.u64VirtualSyncCatchUpPrev;
1528 if (RT_LIKELY(!(u64Delta >> 32)))
1529 {
1530 uint64_t u64Sub = ASMMultU64ByU32DivByU32(u64Delta, pVM->tm.s.u32VirtualSyncCatchUpPercentage, 100);
1531 if (off > u64Sub + pVM->tm.s.offVirtualSyncGivenUp)
1532 {
1533 off -= u64Sub;
1534 Log4(("TM: %RU64/%RU64: sub %RU64 (run)\n", u64VirtualNow - off, off - pVM->tm.s.offVirtualSyncGivenUp, u64Sub));
1535 }
1536 else
1537 {
1538 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
1539 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
1540 off = pVM->tm.s.offVirtualSyncGivenUp;
1541 Log4(("TM: %RU64/0: caught up (run)\n", u64VirtualNow));
1542 }
1543 }
1544 ASMAtomicXchgU64(&pVM->tm.s.offVirtualSync, off);
1545 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64VirtualNow;
1546 }
1547 u64Now = u64VirtualNow - off;
1548
1549 /* Check if stopped by expired timer. */
1550 if (u64Now >= pNext->u64Expire)
1551 {
1552 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStop);
1553 u64Now = pNext->u64Expire;
1554 ASMAtomicXchgU64(&pVM->tm.s.u64VirtualSync, u64Now);
1555 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncTicking, false);
1556 Log4(("TM: %RU64/%RU64: exp tmr (run)\n", u64Now, u64VirtualNow - u64Now - pVM->tm.s.offVirtualSyncGivenUp));
1557
1558 }
1559 }
1560
1561 /* calc end of frame. */
1562 uint64_t u64Max = u64Now + pVM->tm.s.u32VirtualSyncScheduleSlack;
1563 if (u64Max > u64VirtualNow - pVM->tm.s.offVirtualSyncGivenUp)
1564 u64Max = u64VirtualNow - pVM->tm.s.offVirtualSyncGivenUp;
1565
1566 /* assert sanity */
1567 Assert(u64Now <= u64VirtualNow - pVM->tm.s.offVirtualSyncGivenUp);
1568 Assert(u64Max <= u64VirtualNow - pVM->tm.s.offVirtualSyncGivenUp);
1569 Assert(u64Now <= u64Max);
1570
1571 /*
1572 * Process the expired timers moving the clock along as we progress.
1573 */
1574#ifdef VBOX_STRICT
1575 uint64_t u64Prev = u64Now; NOREF(u64Prev);
1576#endif
1577 while (pNext && pNext->u64Expire <= u64Max)
1578 {
1579 PTMTIMER pTimer = pNext;
1580 pNext = TMTIMER_GET_NEXT(pTimer);
1581 Log2(("tmR3TimerQueueRun: pTimer=%p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
1582 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
1583 bool fRc;
1584 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED, TMTIMERSTATE_ACTIVE, fRc);
1585 if (fRc)
1586 {
1587 /* unlink */
1588 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1589 if (pPrev)
1590 TMTIMER_SET_NEXT(pPrev, pNext);
1591 else
1592 {
1593 TMTIMER_SET_HEAD(pQueue, pNext);
1594 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1595 }
1596 if (pNext)
1597 TMTIMER_SET_PREV(pNext, pPrev);
1598 pTimer->offNext = 0;
1599 pTimer->offPrev = 0;
1600
1601 /* advance the clock - don't permit timers to be out of order or armed in the 'past'. */
1602#ifdef VBOX_STRICT
1603 AssertMsg(pTimer->u64Expire >= u64Prev, ("%RU64 < %RU64 %s\n", pTimer->u64Expire, u64Prev, pTimer->pszDesc));
1604 u64Prev = pTimer->u64Expire;
1605#endif
1606 ASMAtomicXchgSize(&pVM->tm.s.fVirtualSyncTicking, false);
1607 ASMAtomicXchgU64(&pVM->tm.s.u64VirtualSync, pTimer->u64Expire);
1608
1609 /* fire */
1610 switch (pTimer->enmType)
1611 {
1612 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer); break;
1613 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer); break;
1614 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->u.Internal.pvUser); break;
1615 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->u.External.pvUser); break;
1616 default:
1617 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
1618 break;
1619 }
1620
1621 /* change the state if it wasn't changed already in the handler. */
1622 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED, fRc);
1623 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
1624 }
1625 } /* run loop */
1626
1627 /*
1628 * Restart the clock if it was stopped to serve any timers,
1629 * and start/adjust catch-up if necessary.
1630 */
1631 if ( !pVM->tm.s.fVirtualSyncTicking
1632 && pVM->tm.s.fVirtualTicking)
1633 {
1634 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunRestart);
1635
1636 /* calc the slack we've handed out. */
1637 const uint64_t u64VirtualNow2 = TMVirtualGetEx(pVM, false /* don't check timers */);
1638 Assert(u64VirtualNow2 >= u64VirtualNow);
1639 AssertMsg(pVM->tm.s.u64VirtualSync >= u64Now, ("%RU64 < %RU64\n", pVM->tm.s.u64VirtualSync, u64Now));
1640 const uint64_t offSlack = pVM->tm.s.u64VirtualSync - u64Now;
1641 STAM_STATS({
1642 if (offSlack)
1643 {
1644 PSTAMPROFILE p = &pVM->tm.s.StatVirtualSyncRunSlack;
1645 p->cPeriods++;
1646 p->cTicks += offSlack;
1647 if (p->cTicksMax < offSlack) p->cTicksMax = offSlack;
1648 if (p->cTicksMin > offSlack) p->cTicksMin = offSlack;
1649 }
1650 });
1651
1652 /* Let the time run a little bit while we were busy running timers(?). */
1653 uint64_t u64Elapsed;
1654#define MAX_ELAPSED 30000 /* ns */
1655 if (offSlack > MAX_ELAPSED)
1656 u64Elapsed = 0;
1657 else
1658 {
1659 u64Elapsed = u64VirtualNow2 - u64VirtualNow;
1660 if (u64Elapsed > MAX_ELAPSED)
1661 u64Elapsed = MAX_ELAPSED;
1662 u64Elapsed = u64Elapsed > offSlack ? u64Elapsed - offSlack : 0;
1663 }
1664#undef MAX_ELAPSED
1665
1666 /* Calc the current offset. */
1667 uint64_t offNew = u64VirtualNow2 - pVM->tm.s.u64VirtualSync - u64Elapsed;
1668 Assert(!(offNew & RT_BIT_64(63)));
1669 uint64_t offLag = offNew - pVM->tm.s.offVirtualSyncGivenUp;
1670 Assert(!(offLag & RT_BIT_64(63)));
1671
1672 /*
1673 * Deal with starting, adjusting and stopping catchup.
1674 */
1675 if (pVM->tm.s.fVirtualSyncCatchUp)
1676 {
1677 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpStopThreshold)
1678 {
1679 /* stop */
1680 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
1681 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
1682 Log4(("TM: %RU64/%RU64: caught up\n", u64VirtualNow2 - offNew, offLag));
1683 }
1684 else if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
1685 {
1686 /* adjust */
1687 unsigned i = 0;
1688 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
1689 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
1690 i++;
1691 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage < pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage)
1692 {
1693 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupAdjust[i]);
1694 ASMAtomicXchgU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
1695 Log4(("TM: %RU64/%RU64: adj %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
1696 }
1697 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64VirtualNow2;
1698 }
1699 else
1700 {
1701 /* give up */
1702 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUp);
1703 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
1704 ASMAtomicXchgU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
1705 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
1706 Log4(("TM: %RU64/%RU64: give up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
1707 LogRel(("TM: Giving up catch-up attempt at a %RU64 ns lag; new total: %RU64 ns\n", offLag, offNew));
1708 }
1709 }
1710 else if (offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[0].u64Start)
1711 {
1712 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
1713 {
1714 /* start */
1715 STAM_PROFILE_ADV_START(&pVM->tm.s.StatVirtualSyncCatchup, c);
1716 unsigned i = 0;
1717 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
1718 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
1719 i++;
1720 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupInitial[i]);
1721 ASMAtomicXchgU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
1722 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncCatchUp, true);
1723 Log4(("TM: %RU64/%RU64: catch-up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
1724 }
1725 else
1726 {
1727 /* don't bother */
1728 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUpBeforeStarting);
1729 ASMAtomicXchgU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
1730 Log4(("TM: %RU64/%RU64: give up\n", u64VirtualNow2 - offNew, offLag));
1731 LogRel(("TM: Not bothering to attempt catching up a %RU64 ns lag; new total: %RU64\n", offLag, offNew));
1732 }
1733 }
1734
1735 /*
1736 * Update the offset and restart the clock.
1737 */
1738 Assert(!(offNew & RT_BIT_64(63)));
1739 ASMAtomicXchgU64(&pVM->tm.s.offVirtualSync, offNew);
1740 ASMAtomicXchgBool(&pVM->tm.s.fVirtualSyncTicking, true);
1741 }
1742}
1743
1744
1745/**
1746 * Saves the state of a timer to a saved state.
1747 *
1748 * @returns VBox status.
1749 * @param pTimer Timer to save.
1750 * @param pSSM Save State Manager handle.
1751 */
1752TMR3DECL(int) TMR3TimerSave(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
1753{
1754 LogFlow(("TMR3TimerSave: pTimer=%p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
1755 switch (pTimer->enmState)
1756 {
1757 case TMTIMERSTATE_STOPPED:
1758 case TMTIMERSTATE_PENDING_STOP:
1759 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
1760 return SSMR3PutU8(pSSM, (uint8_t)TMTIMERSTATE_PENDING_STOP);
1761
1762 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
1763 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
1764 AssertMsgFailed(("u64Expire is being updated! (%s)\n", pTimer->pszDesc));
1765 if (!RTThreadYield())
1766 RTThreadSleep(1);
1767 /* fall thru */
1768 case TMTIMERSTATE_ACTIVE:
1769 case TMTIMERSTATE_PENDING_SCHEDULE:
1770 case TMTIMERSTATE_PENDING_RESCHEDULE:
1771 SSMR3PutU8(pSSM, (uint8_t)TMTIMERSTATE_PENDING_SCHEDULE);
1772 return SSMR3PutU64(pSSM, pTimer->u64Expire);
1773
1774 case TMTIMERSTATE_EXPIRED:
1775 case TMTIMERSTATE_PENDING_DESTROY:
1776 case TMTIMERSTATE_PENDING_STOP_DESTROY:
1777 case TMTIMERSTATE_FREE:
1778 AssertMsgFailed(("Invalid timer state %d %s (%s)\n", pTimer->enmState, tmTimerState(pTimer->enmState), pTimer->pszDesc));
1779 return SSMR3HandleSetStatus(pSSM, VERR_TM_INVALID_STATE);
1780 }
1781
1782 AssertMsgFailed(("Unknown timer state %d (%s)\n", pTimer->enmState, pTimer->pszDesc));
1783 return SSMR3HandleSetStatus(pSSM, VERR_TM_UNKNOWN_STATE);
1784}
1785
1786
1787/**
1788 * Loads the state of a timer from a saved state.
1789 *
1790 * @returns VBox status.
1791 * @param pTimer Timer to restore.
1792 * @param pSSM Save State Manager handle.
1793 */
1794TMR3DECL(int) TMR3TimerLoad(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
1795{
1796 Assert(pTimer); Assert(pSSM); VM_ASSERT_EMT(pTimer->pVMR3);
1797 LogFlow(("TMR3TimerLoad: pTimer=%p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
1798
1799 /*
1800 * Load the state and validate it.
1801 */
1802 uint8_t u8State;
1803 int rc = SSMR3GetU8(pSSM, &u8State);
1804 if (VBOX_FAILURE(rc))
1805 return rc;
1806 TMTIMERSTATE enmState = (TMTIMERSTATE)u8State;
1807 if ( enmState != TMTIMERSTATE_PENDING_STOP
1808 && enmState != TMTIMERSTATE_PENDING_SCHEDULE
1809 && enmState != TMTIMERSTATE_PENDING_STOP_SCHEDULE)
1810 {
1811 AssertMsgFailed(("enmState=%d %s\n", enmState, tmTimerState(enmState)));
1812 return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
1813 }
1814
1815 if (enmState == TMTIMERSTATE_PENDING_SCHEDULE)
1816 {
1817 /*
1818 * Load the expire time.
1819 */
1820 uint64_t u64Expire;
1821 rc = SSMR3GetU64(pSSM, &u64Expire);
1822 if (VBOX_FAILURE(rc))
1823 return rc;
1824
1825 /*
1826 * Set it.
1827 */
1828 Log(("enmState=%d %s u64Expire=%llu\n", enmState, tmTimerState(enmState), u64Expire));
1829 rc = TMTimerSet(pTimer, u64Expire);
1830 }
1831 else
1832 {
1833 /*
1834 * Stop it.
1835 */
1836 Log(("enmState=%d %s\n", enmState, tmTimerState(enmState)));
1837 rc = TMTimerStop(pTimer);
1838 }
1839
1840 /*
1841 * On failure set SSM status.
1842 */
1843 if (VBOX_FAILURE(rc))
1844 rc = SSMR3HandleSetStatus(pSSM, rc);
1845 return rc;
1846}
1847
1848
1849/**
1850 * Get the real world UTC time adjusted for VM lag.
1851 *
1852 * @returns pTime.
1853 * @param pVM The VM instance.
1854 * @param pTime Where to store the time.
1855 */
1856TMR3DECL(PRTTIMESPEC) TMR3UTCNow(PVM pVM, PRTTIMESPEC pTime)
1857{
1858 RTTimeNow(pTime);
1859 RTTimeSpecSubNano(pTime, pVM->tm.s.offVirtualSync - pVM->tm.s.offVirtualSyncGivenUp);
1860 RTTimeSpecAddNano(pTime, pVM->tm.s.offUTC);
1861 return pTime;
1862}
1863
1864
1865/**
1866 * Display all timers.
1867 *
1868 * @param pVM VM Handle.
1869 * @param pHlp The info helpers.
1870 * @param pszArgs Arguments, ignored.
1871 */
1872static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
1873{
1874 NOREF(pszArgs);
1875 pHlp->pfnPrintf(pHlp,
1876 "Timers (pVM=%p)\n"
1877 "%.*s %.*s %.*s %.*s Clock %-18s %-18s %-25s Description\n",
1878 pVM,
1879 sizeof(RTR3PTR) * 2, "pTimerR3 ",
1880 sizeof(int32_t) * 2, "offNext ",
1881 sizeof(int32_t) * 2, "offPrev ",
1882 sizeof(int32_t) * 2, "offSched ",
1883 "Time",
1884 "Expire",
1885 "State");
1886 for (PTMTIMERR3 pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
1887 {
1888 pHlp->pfnPrintf(pHlp,
1889 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %-25s %s\n",
1890 pTimer,
1891 pTimer->offNext,
1892 pTimer->offPrev,
1893 pTimer->offScheduleNext,
1894 pTimer->enmClock == TMCLOCK_REAL ? "Real " : "Virt ",
1895 TMTimerGet(pTimer),
1896 pTimer->u64Expire,
1897 tmTimerState(pTimer->enmState),
1898 pTimer->pszDesc);
1899 }
1900}
1901
1902
1903/**
1904 * Display all active timers.
1905 *
1906 * @param pVM VM Handle.
1907 * @param pHlp The info helpers.
1908 * @param pszArgs Arguments, ignored.
1909 */
1910static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
1911{
1912 NOREF(pszArgs);
1913 pHlp->pfnPrintf(pHlp,
1914 "Active Timers (pVM=%p)\n"
1915 "%.*s %.*s %.*s %.*s Clock %-18s %-18s %-25s Description\n",
1916 pVM,
1917 sizeof(RTR3PTR) * 2, "pTimerR3 ",
1918 sizeof(int32_t) * 2, "offNext ",
1919 sizeof(int32_t) * 2, "offPrev ",
1920 sizeof(int32_t) * 2, "offSched ",
1921 "Time",
1922 "Expire",
1923 "State");
1924 for (unsigned iQueue = 0; iQueue < TMCLOCK_MAX; iQueue++)
1925 {
1926 for (PTMTIMERR3 pTimer = TMTIMER_GET_HEAD(&pVM->tm.s.paTimerQueuesR3[iQueue]);
1927 pTimer;
1928 pTimer = TMTIMER_GET_NEXT(pTimer))
1929 {
1930 pHlp->pfnPrintf(pHlp,
1931 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %-25s %s\n",
1932 pTimer,
1933 pTimer->offNext,
1934 pTimer->offPrev,
1935 pTimer->offScheduleNext,
1936 pTimer->enmClock == TMCLOCK_REAL
1937 ? "Real "
1938 : pTimer->enmClock == TMCLOCK_VIRTUAL
1939 ? "Virt "
1940 : pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC
1941 ? "VrSy "
1942 : "TSC ",
1943 TMTimerGet(pTimer),
1944 pTimer->u64Expire,
1945 tmTimerState(pTimer->enmState),
1946 pTimer->pszDesc);
1947 }
1948 }
1949}
1950
1951
1952/**
1953 * Display all clocks.
1954 *
1955 * @param pVM VM Handle.
1956 * @param pHlp The info helpers.
1957 * @param pszArgs Arguments, ignored.
1958 */
1959static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
1960{
1961 NOREF(pszArgs);
1962
1963 /*
1964 * Read the times first to avoid more than necessary time variation.
1965 */
1966 const uint64_t u64TSC = TMCpuTickGet(pVM);
1967 const uint64_t u64Virtual = TMVirtualGet(pVM);
1968 const uint64_t u64VirtualSync = TMVirtualSyncGet(pVM);
1969 const uint64_t u64Real = TMRealGet(pVM);
1970
1971 /*
1972 * TSC
1973 */
1974 pHlp->pfnPrintf(pHlp,
1975 "Cpu Tick: %18RU64 (%#016RX64) %RU64Hz %s%s",
1976 u64TSC, u64TSC, TMCpuTicksPerSecond(pVM),
1977 pVM->tm.s.fTSCTicking ? "ticking" : "paused",
1978 pVM->tm.s.fTSCVirtualized ? " - virtualized" : "");
1979 if (pVM->tm.s.fTSCUseRealTSC)
1980 {
1981 pHlp->pfnPrintf(pHlp, " - real tsc");
1982 if (pVM->tm.s.u64TSCOffset)
1983 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVM->tm.s.u64TSCOffset);
1984 }
1985 else
1986 pHlp->pfnPrintf(pHlp, " - virtual clock");
1987 pHlp->pfnPrintf(pHlp, "\n");
1988
1989 /*
1990 * virtual
1991 */
1992 pHlp->pfnPrintf(pHlp,
1993 " Virtual: %18RU64 (%#016RX64) %RU64Hz %s",
1994 u64Virtual, u64Virtual, TMVirtualGetFreq(pVM),
1995 pVM->tm.s.fVirtualTicking ? "ticking" : "paused");
1996 if (pVM->tm.s.fVirtualWarpDrive)
1997 pHlp->pfnPrintf(pHlp, " WarpDrive %RU32 %%", pVM->tm.s.u32VirtualWarpDrivePercentage);
1998 pHlp->pfnPrintf(pHlp, "\n");
1999
2000 /*
2001 * virtual sync
2002 */
2003 pHlp->pfnPrintf(pHlp,
2004 "VirtSync: %18RU64 (%#016RX64) %s%s",
2005 u64VirtualSync, u64VirtualSync,
2006 pVM->tm.s.fVirtualSyncTicking ? "ticking" : "paused",
2007 pVM->tm.s.fVirtualSyncCatchUp ? " - catchup" : "");
2008 if (pVM->tm.s.offVirtualSync)
2009 {
2010 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVM->tm.s.offVirtualSync);
2011 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage)
2012 pHlp->pfnPrintf(pHlp, " catch-up rate %u %%", pVM->tm.s.u32VirtualSyncCatchUpPercentage);
2013 }
2014 pHlp->pfnPrintf(pHlp, "\n");
2015
2016 /*
2017 * real
2018 */
2019 pHlp->pfnPrintf(pHlp,
2020 " Real: %18RU64 (%#016RX64) %RU64Hz\n",
2021 u64Real, u64Real, TMRealGetFreq(pVM));
2022}
2023
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