VirtualBox

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

Last change on this file since 8213 was 8155, checked in by vboxsync, 17 years ago

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