VirtualBox

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

Last change on this file since 20060 was 20050, checked in by vboxsync, 15 years ago

TM: new state and more logging (gee).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 107.5 KB
Line 
1/* $Id: TM.cpp 20050 2009-05-26 17:12:12Z vboxsync $ */
2/** @file
3 * TM - Time 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/** @page pg_tm TM - The Time Manager
23 *
24 * The Time Manager abstracts the CPU clocks and manages timers used by the VMM,
25 * device and drivers.
26 *
27 * @see grp_tm
28 *
29 *
30 * @section sec_tm_clocks Clocks
31 *
32 * There are currently 4 clocks:
33 * - Virtual (guest).
34 * - Synchronous virtual (guest).
35 * - CPU Tick (TSC) (guest). Only current use is rdtsc emulation. Usually a
36 * function of the virtual clock.
37 * - Real (host). This is only used for display updates atm.
38 *
39 * The most important clocks are the three first ones and of these the second is
40 * the most interesting.
41 *
42 *
43 * The synchronous virtual clock is tied to the virtual clock except that it
44 * will take into account timer delivery lag caused by host scheduling. It will
45 * normally never advance beyond the head timer, and when lagging too far behind
46 * it will gradually speed up to catch up with the virtual clock. All devices
47 * implementing time sources accessible to and used by the guest is using this
48 * clock (for timers and other things). This ensures consistency between the
49 * time sources.
50 *
51 * The virtual clock is implemented as an offset to a monotonic, high
52 * resolution, wall clock. The current time source is using the RTTimeNanoTS()
53 * machinery based upon the Global Info Pages (GIP), that is, we're using TSC
54 * deltas (usually 10 ms) to fill the gaps between GIP updates. The result is
55 * a fairly high res clock that works in all contexts and on all hosts. The
56 * virtual clock is paused when the VM isn't in the running state.
57 *
58 * The CPU tick (TSC) is normally virtualized as a function of the synchronous
59 * virtual clock, where the frequency defaults to the host cpu frequency (as we
60 * measure it). In this mode it is possible to configure the frequency. Another
61 * (non-default) option is to use the raw unmodified host TSC values. And yet
62 * another, to tie it to time spent executing guest code. All these things are
63 * configurable should non-default behavior be desirable.
64 *
65 * The real clock is a monotonic clock (when available) with relatively low
66 * resolution, though this a bit host specific. Note that we're currently not
67 * servicing timers using the real clock when the VM is not running, this is
68 * simply because it has not been needed yet therefore not implemented.
69 *
70 *
71 * @subsection subsec_tm_timesync Guest Time Sync / UTC time
72 *
73 * Guest time syncing is primarily taken care of by the VMM device. The
74 * principle is very simple, the guest additions periodically asks the VMM
75 * device what the current UTC time is and makes adjustments accordingly.
76 *
77 * A complicating factor is that the synchronous virtual clock might be doing
78 * catchups and the guest perception is currently a little bit behind the world
79 * but it will (hopefully) be catching up soon as we're feeding timer interrupts
80 * at a slightly higher rate. Adjusting the guest clock to the current wall
81 * time in the real world would be a bad idea then because the guest will be
82 * advancing too fast and run ahead of world time (if the catchup works out).
83 * To solve this problem TM provides the VMM device with an UTC time source that
84 * gets adjusted with the current lag, so that when the guest eventually catches
85 * up the lag it will be showing correct real world time.
86 *
87 *
88 * @section sec_tm_timers Timers
89 *
90 * The timers can use any of the TM clocks described in the previous section.
91 * Each clock has its own scheduling facility, or timer queue if you like.
92 * There are a few factors which makes it a bit complex. First, there is the
93 * usual R0 vs R3 vs. RC thing. Then there are multiple threads, and then there
94 * is the timer thread that periodically checks whether any timers has expired
95 * without EMT noticing. On the API level, all but the create and save APIs
96 * must be mulithreaded. EMT will always run the timers.
97 *
98 * The design is using a doubly linked list of active timers which is ordered
99 * by expire date. This list is only modified by the EMT thread. Updates to
100 * the list are batched in a singly linked list, which is then processed by the
101 * EMT thread at the first opportunity (immediately, next time EMT modifies a
102 * timer on that clock, or next timer timeout). Both lists are offset based and
103 * all the elements are therefore allocated from the hyper heap.
104 *
105 * For figuring out when there is need to schedule and run timers TM will:
106 * - Poll whenever somebody queries the virtual clock.
107 * - Poll the virtual clocks from the EM and REM loops.
108 * - Poll the virtual clocks from trap exit path.
109 * - Poll the virtual clocks and calculate first timeout from the halt loop.
110 * - Employ a thread which periodically (100Hz) polls all the timer queues.
111 *
112 *
113 * @image html TMTIMER-Statechart-Diagram.gif
114 *
115 * @section sec_tm_timer Logging
116 *
117 * Level 2: Logs a most of the timer state transitions and queue servicing.
118 * Level 3: Logs a few oddments.
119 * Level 4: Logs TMCLOCK_VIRTUAL_SYNC catch-up events.
120 *
121 */
122
123/*******************************************************************************
124* Header Files *
125*******************************************************************************/
126#define LOG_GROUP LOG_GROUP_TM
127#include <VBox/tm.h>
128#include <VBox/vmm.h>
129#include <VBox/mm.h>
130#include <VBox/ssm.h>
131#include <VBox/dbgf.h>
132#include <VBox/rem.h>
133#include <VBox/pdm.h>
134#include "TMInternal.h"
135#include <VBox/vm.h>
136
137#include <VBox/param.h>
138#include <VBox/err.h>
139
140#include <VBox/log.h>
141#include <iprt/asm.h>
142#include <iprt/assert.h>
143#include <iprt/thread.h>
144#include <iprt/time.h>
145#include <iprt/timer.h>
146#include <iprt/semaphore.h>
147#include <iprt/string.h>
148#include <iprt/env.h>
149
150
151/*******************************************************************************
152* Defined Constants And Macros *
153*******************************************************************************/
154/** The current saved state version.*/
155#define TM_SAVED_STATE_VERSION 3
156
157
158/*******************************************************************************
159* Internal Functions *
160*******************************************************************************/
161static bool tmR3HasFixedTSC(PVM pVM);
162static uint64_t tmR3CalibrateTSC(PVM pVM);
163static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM);
164static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
165static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
166static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue);
167static void tmR3TimerQueueRunVirtualSync(PVM pVM);
168static DECLCALLBACK(int) tmR3SetWarpDrive(PVM pVM, uint32_t u32Percent);
169static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
170static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
171static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
172
173
174/**
175 * Initializes the TM.
176 *
177 * @returns VBox status code.
178 * @param pVM The VM to operate on.
179 */
180VMMR3DECL(int) TMR3Init(PVM pVM)
181{
182 LogFlow(("TMR3Init:\n"));
183
184 /*
185 * Assert alignment and sizes.
186 */
187 AssertCompileMemberAlignment(VM, tm.s, 32);
188 AssertCompile(sizeof(pVM->tm.s) <= sizeof(pVM->tm.padding));
189 AssertCompileMemberAlignment(TM, EmtLock, 8);
190 AssertCompileMemberAlignment(TM, VirtualSyncLock, 8);
191
192 /*
193 * Init the structure.
194 */
195 void *pv;
196 int rc = MMHyperAlloc(pVM, sizeof(pVM->tm.s.paTimerQueuesR3[0]) * TMCLOCK_MAX, 0, MM_TAG_TM, &pv);
197 AssertRCReturn(rc, rc);
198 pVM->tm.s.paTimerQueuesR3 = (PTMTIMERQUEUE)pv;
199 pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pv);
200 pVM->tm.s.paTimerQueuesRC = MMHyperR3ToRC(pVM, pv);
201
202 pVM->tm.s.offVM = RT_OFFSETOF(VM, tm.s);
203 pVM->tm.s.idTimerCpu = pVM->cCPUs - 1; /* The last CPU. */
204 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].enmClock = TMCLOCK_VIRTUAL;
205 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].u64Expire = INT64_MAX;
206 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].enmClock = TMCLOCK_VIRTUAL_SYNC;
207 pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].u64Expire = INT64_MAX;
208 pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].enmClock = TMCLOCK_REAL;
209 pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].u64Expire = INT64_MAX;
210 pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].enmClock = TMCLOCK_TSC;
211 pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].u64Expire = INT64_MAX;
212
213
214 /*
215 * We directly use the GIP to calculate the virtual time. We map the
216 * the GIP into the guest context so we can do this calculation there
217 * as well and save costly world switches.
218 */
219 pVM->tm.s.pvGIPR3 = (void *)g_pSUPGlobalInfoPage;
220 AssertMsgReturn(pVM->tm.s.pvGIPR3, ("GIP support is now required!\n"), VERR_INTERNAL_ERROR);
221 RTHCPHYS HCPhysGIP;
222 rc = SUPGipGetPhys(&HCPhysGIP);
223 AssertMsgRCReturn(rc, ("Failed to get GIP physical address!\n"), rc);
224
225 RTGCPTR GCPtr;
226 rc = MMR3HyperMapHCPhys(pVM, pVM->tm.s.pvGIPR3, NIL_RTR0PTR, HCPhysGIP, PAGE_SIZE, "GIP", &GCPtr);
227 if (RT_FAILURE(rc))
228 {
229 AssertMsgFailed(("Failed to map GIP into GC, rc=%Rrc!\n", rc));
230 return rc;
231 }
232 pVM->tm.s.pvGIPRC = GCPtr;
233 LogFlow(("TMR3Init: HCPhysGIP=%RHp at %RRv\n", HCPhysGIP, pVM->tm.s.pvGIPRC));
234 MMR3HyperReserve(pVM, PAGE_SIZE, "fence", NULL);
235
236 /* Check assumptions made in TMAllVirtual.cpp about the GIP update interval. */
237 if ( g_pSUPGlobalInfoPage->u32Magic == SUPGLOBALINFOPAGE_MAGIC
238 && g_pSUPGlobalInfoPage->u32UpdateIntervalNS >= 250000000 /* 0.25s */)
239 return VMSetError(pVM, VERR_INTERNAL_ERROR, RT_SRC_POS,
240 N_("The GIP update interval is too big. u32UpdateIntervalNS=%RU32 (u32UpdateHz=%RU32)"),
241 g_pSUPGlobalInfoPage->u32UpdateIntervalNS, g_pSUPGlobalInfoPage->u32UpdateHz);
242 LogRel(("TM: GIP - u32Mode=%d (%s) u32UpdateHz=%u\n", g_pSUPGlobalInfoPage->u32Mode,
243 g_pSUPGlobalInfoPage->u32Mode == SUPGIPMODE_SYNC_TSC ? "SyncTSC"
244 : g_pSUPGlobalInfoPage->u32Mode == SUPGIPMODE_ASYNC_TSC ? "AsyncTSC" : "Unknown",
245 g_pSUPGlobalInfoPage->u32UpdateHz));
246
247 /*
248 * Setup the VirtualGetRaw backend.
249 */
250 pVM->tm.s.VirtualGetRawDataR3.pu64Prev = &pVM->tm.s.u64VirtualRawPrev;
251 pVM->tm.s.VirtualGetRawDataR3.pfnBad = tmVirtualNanoTSBad;
252 pVM->tm.s.VirtualGetRawDataR3.pfnRediscover = tmVirtualNanoTSRediscover;
253 if (ASMCpuId_EDX(1) & X86_CPUID_FEATURE_EDX_SSE2)
254 {
255 if (g_pSUPGlobalInfoPage->u32Mode == SUPGIPMODE_SYNC_TSC)
256 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLFenceSync;
257 else
258 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLFenceAsync;
259 }
260 else
261 {
262 if (g_pSUPGlobalInfoPage->u32Mode == SUPGIPMODE_SYNC_TSC)
263 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLegacySync;
264 else
265 pVM->tm.s.pfnVirtualGetRawR3 = RTTimeNanoTSLegacyAsync;
266 }
267
268 pVM->tm.s.VirtualGetRawDataRC.pu64Prev = MMHyperR3ToRC(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
269 pVM->tm.s.VirtualGetRawDataR0.pu64Prev = MMHyperR3ToR0(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
270 AssertReturn(pVM->tm.s.VirtualGetRawDataR0.pu64Prev, VERR_INTERNAL_ERROR);
271 /* The rest is done in TMR3InitFinalize since it's too early to call PDM. */
272
273 /*
274 * Init the locks.
275 */
276 rc = PDMR3CritSectInit(pVM, &pVM->tm.s.EmtLock, "TM EMT Lock");
277 if (RT_FAILURE(rc))
278 return rc;
279 rc = PDMR3CritSectInit(pVM, &pVM->tm.s.VirtualSyncLock, "TM VirtualSync Lock");
280 if (RT_FAILURE(rc))
281 return rc;
282
283 /*
284 * Get our CFGM node, create it if necessary.
285 */
286 PCFGMNODE pCfgHandle = CFGMR3GetChild(CFGMR3GetRoot(pVM), "TM");
287 if (!pCfgHandle)
288 {
289 rc = CFGMR3InsertNode(CFGMR3GetRoot(pVM), "TM", &pCfgHandle);
290 AssertRCReturn(rc, rc);
291 }
292
293 /*
294 * Determin the TSC configuration and frequency.
295 */
296 /* mode */
297 /** @cfgm{/TM/TSCVirtualized,bool,true}
298 * Use a virtualize TSC, i.e. trap all TSC access. */
299 rc = CFGMR3QueryBool(pCfgHandle, "TSCVirtualized", &pVM->tm.s.fTSCVirtualized);
300 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
301 pVM->tm.s.fTSCVirtualized = true; /* trap rdtsc */
302 else if (RT_FAILURE(rc))
303 return VMSetError(pVM, rc, RT_SRC_POS,
304 N_("Configuration error: Failed to querying bool value \"UseRealTSC\""));
305
306 /* source */
307 /** @cfgm{/TM/UseRealTSC,bool,false}
308 * Use the real TSC as time source for the TSC instead of the synchronous
309 * virtual clock (false, default). */
310 rc = CFGMR3QueryBool(pCfgHandle, "UseRealTSC", &pVM->tm.s.fTSCUseRealTSC);
311 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
312 pVM->tm.s.fTSCUseRealTSC = false; /* use virtual time */
313 else if (RT_FAILURE(rc))
314 return VMSetError(pVM, rc, RT_SRC_POS,
315 N_("Configuration error: Failed to querying bool value \"UseRealTSC\""));
316 if (!pVM->tm.s.fTSCUseRealTSC)
317 pVM->tm.s.fTSCVirtualized = true;
318
319 /* TSC reliability */
320 /** @cfgm{/TM/MaybeUseOffsettedHostTSC,bool,detect}
321 * Whether the CPU has a fixed TSC rate and may be used in offsetted mode with
322 * VT-x/AMD-V execution. This is autodetected in a very restrictive way by
323 * default. */
324 rc = CFGMR3QueryBool(pCfgHandle, "MaybeUseOffsettedHostTSC", &pVM->tm.s.fMaybeUseOffsettedHostTSC);
325 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
326 {
327 if (!pVM->tm.s.fTSCUseRealTSC)
328 {
329 /* @todo simple case for guest SMP; always emulate RDTSC */
330 if (pVM->cCPUs == 1)
331 pVM->tm.s.fMaybeUseOffsettedHostTSC = tmR3HasFixedTSC(pVM);
332 }
333 else
334 pVM->tm.s.fMaybeUseOffsettedHostTSC = true;
335 }
336
337 /** @cfgm{TM/TSCTicksPerSecond, uint32_t, Current TSC frequency from GIP}
338 * The number of TSC ticks per second (i.e. the TSC frequency). This will
339 * override TSCUseRealTSC, TSCVirtualized and MaybeUseOffsettedHostTSC.
340 */
341 rc = CFGMR3QueryU64(pCfgHandle, "TSCTicksPerSecond", &pVM->tm.s.cTSCTicksPerSecond);
342 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
343 {
344 pVM->tm.s.cTSCTicksPerSecond = tmR3CalibrateTSC(pVM);
345 if ( !pVM->tm.s.fTSCUseRealTSC
346 && pVM->tm.s.cTSCTicksPerSecond >= _4G)
347 {
348 pVM->tm.s.cTSCTicksPerSecond = _4G - 1; /* (A limitation of our math code) */
349 pVM->tm.s.fMaybeUseOffsettedHostTSC = false;
350 }
351 }
352 else if (RT_FAILURE(rc))
353 return VMSetError(pVM, rc, RT_SRC_POS,
354 N_("Configuration error: Failed to querying uint64_t value \"TSCTicksPerSecond\""));
355 else if ( pVM->tm.s.cTSCTicksPerSecond < _1M
356 || pVM->tm.s.cTSCTicksPerSecond >= _4G)
357 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
358 N_("Configuration error: \"TSCTicksPerSecond\" = %RI64 is not in the range 1MHz..4GHz-1"),
359 pVM->tm.s.cTSCTicksPerSecond);
360 else
361 {
362 pVM->tm.s.fTSCUseRealTSC = pVM->tm.s.fMaybeUseOffsettedHostTSC = false;
363 pVM->tm.s.fTSCVirtualized = true;
364 }
365
366 /** @cfgm{TM/TSCTiedToExecution, bool, false}
367 * Whether the TSC should be tied to execution. This will exclude most of the
368 * virtualization overhead, but will by default include the time spent in the
369 * halt state (see TM/TSCNotTiedToHalt). This setting will override all other
370 * TSC settings except for TSCTicksPerSecond and TSCNotTiedToHalt, which should
371 * be used avoided or used with great care. Note that this will only work right
372 * together with VT-x or AMD-V, and with a single virtual CPU. */
373 rc = CFGMR3QueryBoolDef(pCfgHandle, "TSCTiedToExecution", &pVM->tm.s.fTSCTiedToExecution, false);
374 if (RT_FAILURE(rc))
375 return VMSetError(pVM, rc, RT_SRC_POS,
376 N_("Configuration error: Failed to querying bool value \"TSCTiedToExecution\""));
377 if (pVM->tm.s.fTSCTiedToExecution)
378 {
379 /* tied to execution, override all other settings. */
380 pVM->tm.s.fTSCVirtualized = true;
381 pVM->tm.s.fTSCUseRealTSC = true;
382 pVM->tm.s.fMaybeUseOffsettedHostTSC = false;
383 }
384
385 /** @cfgm{TM/TSCNotTiedToHalt, bool, true}
386 * For overriding the default of TM/TSCTiedToExecution, i.e. set this to false
387 * to make the TSC freeze during HLT. */
388 rc = CFGMR3QueryBoolDef(pCfgHandle, "TSCNotTiedToHalt", &pVM->tm.s.fTSCNotTiedToHalt, false);
389 if (RT_FAILURE(rc))
390 return VMSetError(pVM, rc, RT_SRC_POS,
391 N_("Configuration error: Failed to querying bool value \"TSCNotTiedToHalt\""));
392
393 /* setup and report */
394 if (pVM->tm.s.fTSCVirtualized)
395 CPUMR3SetCR4Feature(pVM, X86_CR4_TSD, ~X86_CR4_TSD);
396 else
397 CPUMR3SetCR4Feature(pVM, 0, ~X86_CR4_TSD);
398 LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%'RU64) fTSCVirtualized=%RTbool fTSCUseRealTSC=%RTbool\n"
399 "TM: fMaybeUseOffsettedHostTSC=%RTbool TSCTiedToExecution=%RTbool TSCNotTiedToHalt=%RTbool\n",
400 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.fTSCVirtualized, pVM->tm.s.fTSCUseRealTSC,
401 pVM->tm.s.fMaybeUseOffsettedHostTSC, pVM->tm.s.fTSCTiedToExecution, pVM->tm.s.fTSCNotTiedToHalt));
402
403 /*
404 * Configure the timer synchronous virtual time.
405 */
406 /** @cfgm{TM/ScheduleSlack, uint32_t, ns, 0, UINT32_MAX, 100000}
407 * Scheduling slack when processing timers. */
408 rc = CFGMR3QueryU32(pCfgHandle, "ScheduleSlack", &pVM->tm.s.u32VirtualSyncScheduleSlack);
409 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
410 pVM->tm.s.u32VirtualSyncScheduleSlack = 100000; /* 0.100ms (ASSUMES virtual time is nanoseconds) */
411 else if (RT_FAILURE(rc))
412 return VMSetError(pVM, rc, RT_SRC_POS,
413 N_("Configuration error: Failed to querying 32-bit integer value \"ScheduleSlack\""));
414
415 /** @cfgm{TM/CatchUpStopThreshold, uint64_t, ns, 0, UINT64_MAX, 500000}
416 * When to stop a catch-up, considering it successful. */
417 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStopThreshold", &pVM->tm.s.u64VirtualSyncCatchUpStopThreshold);
418 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
419 pVM->tm.s.u64VirtualSyncCatchUpStopThreshold = 500000; /* 0.5ms */
420 else if (RT_FAILURE(rc))
421 return VMSetError(pVM, rc, RT_SRC_POS,
422 N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpStopThreshold\""));
423
424 /** @cfgm{TM/CatchUpGiveUpThreshold, uint64_t, ns, 0, UINT64_MAX, 60000000000}
425 * When to give up a catch-up attempt. */
426 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpGiveUpThreshold", &pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold);
427 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
428 pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold = UINT64_C(60000000000); /* 60 sec */
429 else if (RT_FAILURE(rc))
430 return VMSetError(pVM, rc, RT_SRC_POS,
431 N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpGiveUpThreshold\""));
432
433
434 /** @cfgm{TM/CatchUpPrecentage[0..9], uint32_t, %, 1, 2000, various}
435 * The catch-up percent for a given period. */
436 /** @cfgm{TM/CatchUpStartThreshold[0..9], uint64_t, ns, 0, UINT64_MAX,
437 * The catch-up period threshold, or if you like, when a period starts. */
438#define TM_CFG_PERIOD(iPeriod, DefStart, DefPct) \
439 do \
440 { \
441 uint64_t u64; \
442 rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStartThreshold" #iPeriod, &u64); \
443 if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
444 u64 = UINT64_C(DefStart); \
445 else if (RT_FAILURE(rc)) \
446 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpThreshold" #iPeriod "\"")); \
447 if ( (iPeriod > 0 && u64 <= pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod - 1].u64Start) \
448 || u64 >= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold) \
449 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("Configuration error: Invalid start of period #" #iPeriod ": %'RU64"), u64); \
450 pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u64Start = u64; \
451 rc = CFGMR3QueryU32(pCfgHandle, "CatchUpPrecentage" #iPeriod, &pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage); \
452 if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
453 pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage = (DefPct); \
454 else if (RT_FAILURE(rc)) \
455 return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 32-bit integer value \"CatchUpPrecentage" #iPeriod "\"")); \
456 } while (0)
457 /* This needs more tuning. Not sure if we really need so many period and be so gentle. */
458 TM_CFG_PERIOD(0, 750000, 5); /* 0.75ms at 1.05x */
459 TM_CFG_PERIOD(1, 1500000, 10); /* 1.50ms at 1.10x */
460 TM_CFG_PERIOD(2, 8000000, 25); /* 8ms at 1.25x */
461 TM_CFG_PERIOD(3, 30000000, 50); /* 30ms at 1.50x */
462 TM_CFG_PERIOD(4, 75000000, 75); /* 75ms at 1.75x */
463 TM_CFG_PERIOD(5, 175000000, 100); /* 175ms at 2x */
464 TM_CFG_PERIOD(6, 500000000, 200); /* 500ms at 3x */
465 TM_CFG_PERIOD(7, 3000000000, 300); /* 3s at 4x */
466 TM_CFG_PERIOD(8,30000000000, 400); /* 30s at 5x */
467 TM_CFG_PERIOD(9,55000000000, 500); /* 55s at 6x */
468 AssertCompile(RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods) == 10);
469#undef TM_CFG_PERIOD
470
471 /*
472 * Configure real world time (UTC).
473 */
474 /** @cfgm{TM/UTCOffset, int64_t, ns, INT64_MIN, INT64_MAX, 0}
475 * The UTC offset. This is used to put the guest back or forwards in time. */
476 rc = CFGMR3QueryS64(pCfgHandle, "UTCOffset", &pVM->tm.s.offUTC);
477 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
478 pVM->tm.s.offUTC = 0; /* ns */
479 else if (RT_FAILURE(rc))
480 return VMSetError(pVM, rc, RT_SRC_POS,
481 N_("Configuration error: Failed to querying 64-bit integer value \"UTCOffset\""));
482
483 /*
484 * Setup the warp drive.
485 */
486 /** @cfgm{TM/WarpDrivePercentage, uint32_t, %, 0, 20000, 100}
487 * The warp drive percentage, 100% is normal speed. This is used to speed up
488 * or slow down the virtual clock, which can be useful for fast forwarding
489 * borring periods during tests. */
490 rc = CFGMR3QueryU32(pCfgHandle, "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage);
491 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
492 rc = CFGMR3QueryU32(CFGMR3GetRoot(pVM), "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage); /* legacy */
493 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
494 pVM->tm.s.u32VirtualWarpDrivePercentage = 100;
495 else if (RT_FAILURE(rc))
496 return VMSetError(pVM, rc, RT_SRC_POS,
497 N_("Configuration error: Failed to querying uint32_t value \"WarpDrivePercent\""));
498 else if ( pVM->tm.s.u32VirtualWarpDrivePercentage < 2
499 || pVM->tm.s.u32VirtualWarpDrivePercentage > 20000)
500 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
501 N_("Configuration error: \"WarpDrivePercent\" = %RI32 is not in the range 2..20000"),
502 pVM->tm.s.u32VirtualWarpDrivePercentage);
503 pVM->tm.s.fVirtualWarpDrive = pVM->tm.s.u32VirtualWarpDrivePercentage != 100;
504 if (pVM->tm.s.fVirtualWarpDrive)
505 LogRel(("TM: u32VirtualWarpDrivePercentage=%RI32\n", pVM->tm.s.u32VirtualWarpDrivePercentage));
506
507 /*
508 * Start the timer (guard against REM not yielding).
509 */
510 /** @cfgm{TM/TimerMillies, uint32_t, ms, 1, 1000, 10}
511 * The watchdog timer interval. */
512 uint32_t u32Millies;
513 rc = CFGMR3QueryU32(pCfgHandle, "TimerMillies", &u32Millies);
514 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
515 u32Millies = 10;
516 else if (RT_FAILURE(rc))
517 return VMSetError(pVM, rc, RT_SRC_POS,
518 N_("Configuration error: Failed to query uint32_t value \"TimerMillies\""));
519 rc = RTTimerCreate(&pVM->tm.s.pTimer, u32Millies, tmR3TimerCallback, pVM);
520 if (RT_FAILURE(rc))
521 {
522 AssertMsgFailed(("Failed to create timer, u32Millies=%d rc=%Rrc.\n", u32Millies, rc));
523 return rc;
524 }
525 Log(("TM: Created timer %p firing every %d millieseconds\n", pVM->tm.s.pTimer, u32Millies));
526 pVM->tm.s.u32TimerMillies = u32Millies;
527
528 /*
529 * Register saved state.
530 */
531 rc = SSMR3RegisterInternal(pVM, "tm", 1, TM_SAVED_STATE_VERSION, sizeof(uint64_t) * 8,
532 NULL, tmR3Save, NULL,
533 NULL, tmR3Load, NULL);
534 if (RT_FAILURE(rc))
535 return rc;
536
537 /*
538 * Register statistics.
539 */
540 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).");
541 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).");
542 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).");
543 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).");
544 STAM_REL_REG_USED(pVM,(void*)&pVM->tm.s.VirtualGetRawDataRC.c1nsSteps,STAMTYPE_U32, "/TM/RC/1nsSteps", STAMUNIT_OCCURENCES, "Virtual time 1ns steps (due to TSC / GIP variations).");
545 STAM_REL_REG_USED(pVM,(void*)&pVM->tm.s.VirtualGetRawDataRC.cBadPrev, STAMTYPE_U32, "/TM/RC/cBadPrev", STAMUNIT_OCCURENCES, "Times the previous virtual time was considered erratic (shouldn't ever happen).");
546 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)");
547 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.");
548
549#ifdef VBOX_WITH_STATISTICS
550 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).");
551 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataR3.cUpdateRaces,STAMTYPE_U32, "/TM/R3/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
552 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).");
553 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataR0.cUpdateRaces,STAMTYPE_U32, "/TM/R0/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
554 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataRC.cExpired, STAMTYPE_U32, "/TM/RC/cExpired", STAMUNIT_OCCURENCES, "Times the TSC interval expired (overlaps 1ns steps).");
555 STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataRC.cUpdateRaces,STAMTYPE_U32, "/TM/RC/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
556 STAM_REG(pVM, &pVM->tm.s.StatDoQueues, STAMTYPE_PROFILE, "/TM/DoQueues", STAMUNIT_TICKS_PER_CALL, "Profiling timer TMR3TimerQueuesDo.");
557 STAM_REG(pVM, &pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Virtual", STAMUNIT_TICKS_PER_CALL, "Time spent on the virtual clock queue.");
558 STAM_REG(pVM, &pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], STAMTYPE_PROFILE_ADV, "/TM/DoQueues/VirtualSync", STAMUNIT_TICKS_PER_CALL, "Time spent on the virtual sync clock queue.");
559 STAM_REG(pVM, &pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], STAMTYPE_PROFILE_ADV, "/TM/DoQueues/Real", STAMUNIT_TICKS_PER_CALL, "Time spent on the real clock queue.");
560
561 STAM_REG(pVM, &pVM->tm.s.StatPoll, STAMTYPE_COUNTER, "/TM/Poll", STAMUNIT_OCCURENCES, "TMTimerPoll calls.");
562 STAM_REG(pVM, &pVM->tm.s.StatPollAlreadySet, STAMTYPE_COUNTER, "/TM/Poll/AlreadySet", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the FF was already set.");
563 STAM_REG(pVM, &pVM->tm.s.StatPollELoop, STAMTYPE_COUNTER, "/TM/Poll/ELoop", STAMUNIT_OCCURENCES, "Times TMTimerPoll has given up getting a consistent virtual sync data set.");
564 STAM_REG(pVM, &pVM->tm.s.StatPollMiss, STAMTYPE_COUNTER, "/TM/Poll/Miss", STAMUNIT_OCCURENCES, "TMTimerPoll calls where nothing had expired.");
565 STAM_REG(pVM, &pVM->tm.s.StatPollRunning, STAMTYPE_COUNTER, "/TM/Poll/Running", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the queues were being run.");
566 STAM_REG(pVM, &pVM->tm.s.StatPollSimple, STAMTYPE_COUNTER, "/TM/Poll/Simple", STAMUNIT_OCCURENCES, "TMTimerPoll calls where we could take the simple path.");
567 STAM_REG(pVM, &pVM->tm.s.StatPollVirtual, STAMTYPE_COUNTER, "/TM/Poll/HitsVirtual", STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL queue.");
568 STAM_REG(pVM, &pVM->tm.s.StatPollVirtualSync, STAMTYPE_COUNTER, "/TM/Poll/HitsVirtualSync", STAMUNIT_OCCURENCES, "The number of times TMTimerPoll found an expired TMCLOCK_VIRTUAL_SYNC queue.");
569
570 STAM_REG(pVM, &pVM->tm.s.StatPostponedR3, STAMTYPE_COUNTER, "/TM/PostponedR3", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-3.");
571 STAM_REG(pVM, &pVM->tm.s.StatPostponedRZ, STAMTYPE_COUNTER, "/TM/PostponedRZ", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-0 / RC.");
572
573 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.");
574 STAM_REG(pVM, &pVM->tm.s.StatScheduleOneRZ, STAMTYPE_PROFILE, "/TM/ScheduleOneRZ", STAMUNIT_TICKS_PER_CALL, "Profiling the scheduling of one queue during a TMTimer* call in EMT.");
575 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.");
576
577 STAM_REG(pVM, &pVM->tm.s.StatTimerSetR3, STAMTYPE_PROFILE, "/TM/TimerSetR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3.");
578 STAM_REG(pVM, &pVM->tm.s.StatTimerSetRZ, STAMTYPE_PROFILE, "/TM/TimerSetRZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0 / RC.");
579
580 STAM_REG(pVM, &pVM->tm.s.StatTimerStopR3, STAMTYPE_PROFILE, "/TM/TimerStopR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-3.");
581 STAM_REG(pVM, &pVM->tm.s.StatTimerStopRZ, STAMTYPE_PROFILE, "/TM/TimerStopRZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-0 / RC.");
582
583 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.");
584 STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualGetSetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGet.");
585 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGet, STAMTYPE_COUNTER, "/TM/VirtualSyncGet", STAMUNIT_OCCURENCES, "The number of times tmVirtualSyncGetEx was called.");
586 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetELoop, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/ELoop", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx has given up getting a consistent virtual sync data set.");
587 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetExpired, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Expired", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx encountered an expired timer stopping the clock.");
588 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetLocked, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Locked", STAMUNIT_OCCURENCES, "Times we successfully acquired the lock in tmVirtualSyncGetEx.");
589 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetLockless, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Lockless", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx returned without needing to take the lock.");
590 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/SetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling tmVirtualSyncGetEx.");
591 STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/VirtualPause", STAMUNIT_OCCURENCES, "The number of times TMR3TimerPause was called.");
592 STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/VirtualResume", STAMUNIT_OCCURENCES, "The number of times TMR3TimerResume was called.");
593
594 STAM_REG(pVM, &pVM->tm.s.StatTimerCallbackSetFF, STAMTYPE_COUNTER, "/TM/CallbackSetFF", STAMUNIT_OCCURENCES, "The number of times the timer callback set FF.");
595
596 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE010, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE010", STAMUNIT_OCCURENCES, "In catch-up mode, 10% or lower.");
597 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE025, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE025", STAMUNIT_OCCURENCES, "In catch-up mode, 25%-11%.");
598 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE100, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE100", STAMUNIT_OCCURENCES, "In catch-up mode, 100%-26%.");
599 STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupOther, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupOther", STAMUNIT_OCCURENCES, "In catch-up mode, > 100%.");
600 STAM_REG(pVM, &pVM->tm.s.StatTSCNotFixed, STAMTYPE_COUNTER, "/TM/TSC/Intercept/NotFixed", STAMUNIT_OCCURENCES, "TSC is not fixed, it may run at variable speed.");
601 STAM_REG(pVM, &pVM->tm.s.StatTSCNotTicking, STAMTYPE_COUNTER, "/TM/TSC/Intercept/NotTicking", STAMUNIT_OCCURENCES, "TSC is not ticking.");
602 STAM_REG(pVM, &pVM->tm.s.StatTSCSyncNotTicking, STAMTYPE_COUNTER, "/TM/TSC/Intercept/SyncNotTicking", STAMUNIT_OCCURENCES, "VirtualSync isn't ticking.");
603 STAM_REG(pVM, &pVM->tm.s.StatTSCWarp, STAMTYPE_COUNTER, "/TM/TSC/Intercept/Warp", STAMUNIT_OCCURENCES, "Warpdrive is active.");
604
605 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.");
606 STAM_REG(pVM, (void *)&pVM->tm.s.fVirtualSyncCatchUp, STAMTYPE_U8, "/TM/VirtualSync/CatchUpActive", STAMUNIT_NONE, "Catch-Up active indicator.");
607 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)");
608 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncFF, STAMTYPE_PROFILE, "/TM/VirtualSync/FF", STAMUNIT_TICKS_PER_OCCURENCE, "Time spent in TMR3VirtualSyncFF by all but the dedicate timer EMT.");
609 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGiveUp, STAMTYPE_COUNTER, "/TM/VirtualSync/GiveUp", STAMUNIT_OCCURENCES, "Times the catch-up was abandoned.");
610 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++.)");
611 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRun, STAMTYPE_COUNTER, "/TM/VirtualSync/Run", STAMUNIT_OCCURENCES, "Times the virtual sync timer queue was considered.");
612 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunRestart, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/Restarts", STAMUNIT_OCCURENCES, "Times the clock was restarted after a run.");
613 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.");
614 STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunStoppedAlready, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/StoppedAlready", STAMUNIT_OCCURENCES, "Times the clock was already stopped elsewhere (TMVirtualSyncGet).");
615 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.)");
616 for (unsigned i = 0; i < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods); i++)
617 {
618 STAMR3RegisterF(pVM, &pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "The catch-up percentage.", "/TM/VirtualSync/Periods/%u", i);
619 STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupAdjust[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times adjusted to this period.", "/TM/VirtualSync/Periods/%u/Adjust", i);
620 STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupInitial[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times started in this period.", "/TM/VirtualSync/Periods/%u/Initial", i);
621 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);
622 }
623
624#endif /* VBOX_WITH_STATISTICS */
625
626 /*
627 * Register info handlers.
628 */
629 DBGFR3InfoRegisterInternalEx(pVM, "timers", "Dumps all timers. No arguments.", tmR3TimerInfo, DBGFINFO_FLAGS_RUN_ON_EMT);
630 DBGFR3InfoRegisterInternalEx(pVM, "activetimers", "Dumps active all timers. No arguments.", tmR3TimerInfoActive, DBGFINFO_FLAGS_RUN_ON_EMT);
631 DBGFR3InfoRegisterInternalEx(pVM, "clocks", "Display the time of the various clocks.", tmR3InfoClocks, DBGFINFO_FLAGS_RUN_ON_EMT);
632
633 return VINF_SUCCESS;
634}
635
636
637/**
638 * Initializes the per-VCPU TM.
639 *
640 * @returns VBox status code.
641 * @param pVM The VM to operate on.
642 */
643VMMR3DECL(int) TMR3InitCPU(PVM pVM)
644{
645 LogFlow(("TMR3InitCPU\n"));
646 return VINF_SUCCESS;
647}
648
649
650/**
651 * Checks if the host CPU has a fixed TSC frequency.
652 *
653 * @returns true if it has, false if it hasn't.
654 *
655 * @remark This test doesn't bother with very old CPUs that don't do power
656 * management or any other stuff that might influence the TSC rate.
657 * This isn't currently relevant.
658 */
659static bool tmR3HasFixedTSC(PVM pVM)
660{
661 if (ASMHasCpuId())
662 {
663 uint32_t uEAX, uEBX, uECX, uEDX;
664
665 if (CPUMGetCPUVendor(pVM) == CPUMCPUVENDOR_AMD)
666 {
667 /*
668 * AuthenticAMD - Check for APM support and that TscInvariant is set.
669 *
670 * This test isn't correct with respect to fixed/non-fixed TSC and
671 * older models, but this isn't relevant since the result is currently
672 * only used for making a descision on AMD-V models.
673 */
674 ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
675 if (uEAX >= 0x80000007)
676 {
677 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
678
679 ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
680 if ( (uEDX & X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR) /* TscInvariant */
681 && pGip->u32Mode == SUPGIPMODE_SYNC_TSC /* no fixed tsc if the gip timer is in async mode */)
682 return true;
683 }
684 }
685 else if (CPUMGetCPUVendor(pVM) == CPUMCPUVENDOR_INTEL)
686 {
687 /*
688 * GenuineIntel - Check the model number.
689 *
690 * This test is lacking in the same way and for the same reasons
691 * as the AMD test above.
692 */
693 ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
694 unsigned uModel = (uEAX >> 4) & 0x0f;
695 unsigned uFamily = (uEAX >> 8) & 0x0f;
696 if (uFamily == 0x0f)
697 uFamily += (uEAX >> 20) & 0xff;
698 if (uFamily >= 0x06)
699 uModel += ((uEAX >> 16) & 0x0f) << 4;
700 if ( (uFamily == 0x0f /*P4*/ && uModel >= 0x03)
701 || (uFamily == 0x06 /*P2/P3*/ && uModel >= 0x0e))
702 return true;
703 }
704 }
705 return false;
706}
707
708
709/**
710 * Calibrate the CPU tick.
711 *
712 * @returns Number of ticks per second.
713 */
714static uint64_t tmR3CalibrateTSC(PVM pVM)
715{
716 /*
717 * Use GIP when available present.
718 */
719 uint64_t u64Hz;
720 PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
721 if ( pGip
722 && pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC)
723 {
724 unsigned iCpu = pGip->u32Mode != SUPGIPMODE_ASYNC_TSC ? 0 : ASMGetApicId();
725 if (iCpu >= RT_ELEMENTS(pGip->aCPUs))
726 AssertReleaseMsgFailed(("iCpu=%d - the ApicId is too high. send VBox.log and hardware specs!\n", iCpu));
727 else
728 {
729 if (tmR3HasFixedTSC(pVM))
730 /* Sleep a bit to get a more reliable CpuHz value. */
731 RTThreadSleep(32);
732 else
733 {
734 /* Spin for 40ms to try push up the CPU frequency and get a more reliable CpuHz value. */
735 const uint64_t u64 = RTTimeMilliTS();
736 while ((RTTimeMilliTS() - u64) < 40 /*ms*/)
737 /* nothing */;
738 }
739
740 pGip = g_pSUPGlobalInfoPage;
741 if ( pGip
742 && pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC
743 && (u64Hz = pGip->aCPUs[iCpu].u64CpuHz)
744 && u64Hz != ~(uint64_t)0)
745 return u64Hz;
746 }
747 }
748
749 /* call this once first to make sure it's initialized. */
750 RTTimeNanoTS();
751
752 /*
753 * Yield the CPU to increase our chances of getting
754 * a correct value.
755 */
756 RTThreadYield(); /* Try avoid interruptions between TSC and NanoTS samplings. */
757 static const unsigned s_auSleep[5] = { 50, 30, 30, 40, 40 };
758 uint64_t au64Samples[5];
759 unsigned i;
760 for (i = 0; i < RT_ELEMENTS(au64Samples); i++)
761 {
762 unsigned cMillies;
763 int cTries = 5;
764 uint64_t u64Start = ASMReadTSC();
765 uint64_t u64End;
766 uint64_t StartTS = RTTimeNanoTS();
767 uint64_t EndTS;
768 do
769 {
770 RTThreadSleep(s_auSleep[i]);
771 u64End = ASMReadTSC();
772 EndTS = RTTimeNanoTS();
773 cMillies = (unsigned)((EndTS - StartTS + 500000) / 1000000);
774 } while ( cMillies == 0 /* the sleep may be interrupted... */
775 || (cMillies < 20 && --cTries > 0));
776 uint64_t u64Diff = u64End - u64Start;
777
778 au64Samples[i] = (u64Diff * 1000) / cMillies;
779 AssertMsg(cTries > 0, ("cMillies=%d i=%d\n", cMillies, i));
780 }
781
782 /*
783 * Discard the highest and lowest results and calculate the average.
784 */
785 unsigned iHigh = 0;
786 unsigned iLow = 0;
787 for (i = 1; i < RT_ELEMENTS(au64Samples); i++)
788 {
789 if (au64Samples[i] < au64Samples[iLow])
790 iLow = i;
791 if (au64Samples[i] > au64Samples[iHigh])
792 iHigh = i;
793 }
794 au64Samples[iLow] = 0;
795 au64Samples[iHigh] = 0;
796
797 u64Hz = au64Samples[0];
798 for (i = 1; i < RT_ELEMENTS(au64Samples); i++)
799 u64Hz += au64Samples[i];
800 u64Hz /= RT_ELEMENTS(au64Samples) - 2;
801
802 return u64Hz;
803}
804
805
806/**
807 * Finalizes the TM initialization.
808 *
809 * @returns VBox status code.
810 * @param pVM The VM to operate on.
811 */
812VMMR3DECL(int) TMR3InitFinalize(PVM pVM)
813{
814 int rc;
815
816 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataRC.pfnBad);
817 AssertRCReturn(rc, rc);
818 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataRC.pfnRediscover);
819 AssertRCReturn(rc, rc);
820 if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceSync)
821 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLFenceSync", &pVM->tm.s.pfnVirtualGetRawRC);
822 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceAsync)
823 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLFenceAsync", &pVM->tm.s.pfnVirtualGetRawRC);
824 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacySync)
825 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLegacySync", &pVM->tm.s.pfnVirtualGetRawRC);
826 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacyAsync)
827 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLegacyAsync", &pVM->tm.s.pfnVirtualGetRawRC);
828 else
829 AssertFatalFailed();
830 AssertRCReturn(rc, rc);
831
832 rc = PDMR3LdrGetSymbolR0Lazy(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataR0.pfnBad);
833 AssertRCReturn(rc, rc);
834 rc = PDMR3LdrGetSymbolR0Lazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataR0.pfnRediscover);
835 AssertRCReturn(rc, rc);
836 if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceSync)
837 rc = PDMR3LdrGetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLFenceSync", &pVM->tm.s.pfnVirtualGetRawR0);
838 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceAsync)
839 rc = PDMR3LdrGetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLFenceAsync", &pVM->tm.s.pfnVirtualGetRawR0);
840 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacySync)
841 rc = PDMR3LdrGetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLegacySync", &pVM->tm.s.pfnVirtualGetRawR0);
842 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacyAsync)
843 rc = PDMR3LdrGetSymbolR0Lazy(pVM, NULL, "RTTimeNanoTSLegacyAsync", &pVM->tm.s.pfnVirtualGetRawR0);
844 else
845 AssertFatalFailed();
846 AssertRCReturn(rc, rc);
847
848 return VINF_SUCCESS;
849}
850
851
852/**
853 * Applies relocations to data and code managed by this
854 * component. This function will be called at init and
855 * whenever the VMM need to relocate it self inside the GC.
856 *
857 * @param pVM The VM.
858 * @param offDelta Relocation delta relative to old location.
859 */
860VMMR3DECL(void) TMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
861{
862 int rc;
863 LogFlow(("TMR3Relocate\n"));
864
865 pVM->tm.s.pvGIPRC = MMHyperR3ToRC(pVM, pVM->tm.s.pvGIPR3);
866 pVM->tm.s.paTimerQueuesRC = MMHyperR3ToRC(pVM, pVM->tm.s.paTimerQueuesR3);
867 pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pVM->tm.s.paTimerQueuesR3);
868
869 pVM->tm.s.VirtualGetRawDataRC.pu64Prev = MMHyperR3ToRC(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
870 AssertFatal(pVM->tm.s.VirtualGetRawDataRC.pu64Prev);
871 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataRC.pfnBad);
872 AssertFatalRC(rc);
873 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataRC.pfnRediscover);
874 AssertFatalRC(rc);
875
876 if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceSync)
877 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLFenceSync", &pVM->tm.s.pfnVirtualGetRawRC);
878 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLFenceAsync)
879 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLFenceAsync", &pVM->tm.s.pfnVirtualGetRawRC);
880 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacySync)
881 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLegacySync", &pVM->tm.s.pfnVirtualGetRawRC);
882 else if (pVM->tm.s.pfnVirtualGetRawR3 == RTTimeNanoTSLegacyAsync)
883 rc = PDMR3LdrGetSymbolRCLazy(pVM, NULL, "RTTimeNanoTSLegacyAsync", &pVM->tm.s.pfnVirtualGetRawRC);
884 else
885 AssertFatalFailed();
886 AssertFatalRC(rc);
887
888 /*
889 * Iterate the timers updating the pVMRC pointers.
890 */
891 for (PTMTIMER pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
892 {
893 pTimer->pVMRC = pVM->pVMRC;
894 pTimer->pVMR0 = pVM->pVMR0;
895 }
896}
897
898
899/**
900 * Terminates the TM.
901 *
902 * Termination means cleaning up and freeing all resources,
903 * the VM it self is at this point powered off or suspended.
904 *
905 * @returns VBox status code.
906 * @param pVM The VM to operate on.
907 */
908VMMR3DECL(int) TMR3Term(PVM pVM)
909{
910 AssertMsg(pVM->tm.s.offVM, ("bad init order!\n"));
911 if (pVM->tm.s.pTimer)
912 {
913 int rc = RTTimerDestroy(pVM->tm.s.pTimer);
914 AssertRC(rc);
915 pVM->tm.s.pTimer = NULL;
916 }
917
918 return VINF_SUCCESS;
919}
920
921
922/**
923 * Terminates the per-VCPU TM.
924 *
925 * Termination means cleaning up and freeing all resources,
926 * the VM it self is at this point powered off or suspended.
927 *
928 * @returns VBox status code.
929 * @param pVM The VM to operate on.
930 */
931VMMR3DECL(int) TMR3TermCPU(PVM pVM)
932{
933 return 0;
934}
935
936
937/**
938 * The VM is being reset.
939 *
940 * For the TM component this means that a rescheduling is preformed,
941 * the FF is cleared and but without running the queues. We'll have to
942 * check if this makes sense or not, but it seems like a good idea now....
943 *
944 * @param pVM VM handle.
945 */
946VMMR3DECL(void) TMR3Reset(PVM pVM)
947{
948 LogFlow(("TMR3Reset:\n"));
949 VM_ASSERT_EMT(pVM);
950 tmLock(pVM);
951
952 /*
953 * Abort any pending catch up.
954 * This isn't perfect...
955 */
956 if (pVM->tm.s.fVirtualSyncCatchUp)
957 {
958 const uint64_t offVirtualNow = TMVirtualGetNoCheck(pVM);
959 const uint64_t offVirtualSyncNow = TMVirtualSyncGetNoCheck(pVM);
960 if (pVM->tm.s.fVirtualSyncCatchUp)
961 {
962 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
963
964 const uint64_t offOld = pVM->tm.s.offVirtualSyncGivenUp;
965 const uint64_t offNew = offVirtualNow - offVirtualSyncNow;
966 Assert(offOld <= offNew);
967 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
968 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSync, offNew);
969 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
970 LogRel(("TM: Aborting catch-up attempt on reset with a %'RU64 ns lag on reset; new total: %'RU64 ns\n", offNew - offOld, offNew));
971 }
972 }
973
974 /*
975 * Process the queues.
976 */
977 for (int i = 0; i < TMCLOCK_MAX; i++)
978 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[i]);
979#ifdef VBOX_STRICT
980 tmTimerQueuesSanityChecks(pVM, "TMR3Reset");
981#endif
982
983 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
984 VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /** @todo FIXME: this isn't right. */
985 tmUnlock(pVM);
986}
987
988
989/**
990 * Resolve a builtin RC symbol.
991 * Called by PDM when loading or relocating GC modules.
992 *
993 * @returns VBox status
994 * @param pVM VM Handle.
995 * @param pszSymbol Symbol to resolve.
996 * @param pRCPtrValue Where to store the symbol value.
997 * @remark This has to work before TMR3Relocate() is called.
998 */
999VMMR3DECL(int) TMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue)
1000{
1001 if (!strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
1002 *pRCPtrValue = MMHyperR3ToRC(pVM, &pVM->tm.s.pvGIPRC);
1003 //else if (..)
1004 else
1005 return VERR_SYMBOL_NOT_FOUND;
1006 return VINF_SUCCESS;
1007}
1008
1009
1010/**
1011 * Execute state save operation.
1012 *
1013 * @returns VBox status code.
1014 * @param pVM VM Handle.
1015 * @param pSSM SSM operation handle.
1016 */
1017static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM)
1018{
1019 LogFlow(("tmR3Save:\n"));
1020#ifdef VBOX_STRICT
1021 for (VMCPUID i = 0; i < pVM->cCPUs; i++)
1022 {
1023 PVMCPU pVCpu = &pVM->aCpus[i];
1024 Assert(!pVCpu->tm.s.fTSCTicking);
1025 }
1026 Assert(!pVM->tm.s.cVirtualTicking);
1027 Assert(!pVM->tm.s.fVirtualSyncTicking);
1028#endif
1029
1030 /*
1031 * Save the virtual clocks.
1032 */
1033 /* the virtual clock. */
1034 SSMR3PutU64(pSSM, TMCLOCK_FREQ_VIRTUAL);
1035 SSMR3PutU64(pSSM, pVM->tm.s.u64Virtual);
1036
1037 /* the virtual timer synchronous clock. */
1038 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSync);
1039 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSync);
1040 SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSyncGivenUp);
1041 SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSyncCatchUpPrev);
1042 SSMR3PutBool(pSSM, pVM->tm.s.fVirtualSyncCatchUp);
1043
1044 /* real time clock */
1045 SSMR3PutU64(pSSM, TMCLOCK_FREQ_REAL);
1046
1047 for (VMCPUID i = 0; i < pVM->cCPUs; i++)
1048 {
1049 PVMCPU pVCpu = &pVM->aCpus[i];
1050
1051 /* the cpu tick clock. */
1052 SSMR3PutU64(pSSM, TMCpuTickGet(pVCpu));
1053 }
1054 return SSMR3PutU64(pSSM, pVM->tm.s.cTSCTicksPerSecond);
1055}
1056
1057
1058/**
1059 * Execute state load operation.
1060 *
1061 * @returns VBox status code.
1062 * @param pVM VM Handle.
1063 * @param pSSM SSM operation handle.
1064 * @param u32Version Data layout version.
1065 */
1066static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version)
1067{
1068 LogFlow(("tmR3Load:\n"));
1069
1070#ifdef VBOX_STRICT
1071 for (VMCPUID i = 0; i < pVM->cCPUs; i++)
1072 {
1073 PVMCPU pVCpu = &pVM->aCpus[i];
1074 Assert(!pVCpu->tm.s.fTSCTicking);
1075 }
1076 Assert(!pVM->tm.s.cVirtualTicking);
1077 Assert(!pVM->tm.s.fVirtualSyncTicking);
1078#endif
1079
1080 /*
1081 * Validate version.
1082 */
1083 if (u32Version != TM_SAVED_STATE_VERSION)
1084 {
1085 AssertMsgFailed(("tmR3Load: Invalid version u32Version=%d!\n", u32Version));
1086 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1087 }
1088
1089 /*
1090 * Load the virtual clock.
1091 */
1092 pVM->tm.s.cVirtualTicking = 0;
1093 /* the virtual clock. */
1094 uint64_t u64Hz;
1095 int rc = SSMR3GetU64(pSSM, &u64Hz);
1096 if (RT_FAILURE(rc))
1097 return rc;
1098 if (u64Hz != TMCLOCK_FREQ_VIRTUAL)
1099 {
1100 AssertMsgFailed(("The virtual clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1101 u64Hz, TMCLOCK_FREQ_VIRTUAL));
1102 return VERR_SSM_VIRTUAL_CLOCK_HZ;
1103 }
1104 SSMR3GetU64(pSSM, &pVM->tm.s.u64Virtual);
1105 pVM->tm.s.u64VirtualOffset = 0;
1106
1107 /* the virtual timer synchronous clock. */
1108 pVM->tm.s.fVirtualSyncTicking = false;
1109 uint64_t u64;
1110 SSMR3GetU64(pSSM, &u64);
1111 pVM->tm.s.u64VirtualSync = u64;
1112 SSMR3GetU64(pSSM, &u64);
1113 pVM->tm.s.offVirtualSync = u64;
1114 SSMR3GetU64(pSSM, &u64);
1115 pVM->tm.s.offVirtualSyncGivenUp = u64;
1116 SSMR3GetU64(pSSM, &u64);
1117 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64;
1118 bool f;
1119 SSMR3GetBool(pSSM, &f);
1120 pVM->tm.s.fVirtualSyncCatchUp = f;
1121
1122 /* the real clock */
1123 rc = SSMR3GetU64(pSSM, &u64Hz);
1124 if (RT_FAILURE(rc))
1125 return rc;
1126 if (u64Hz != TMCLOCK_FREQ_REAL)
1127 {
1128 AssertMsgFailed(("The real clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1129 u64Hz, TMCLOCK_FREQ_REAL));
1130 return VERR_SSM_VIRTUAL_CLOCK_HZ; /* missleading... */
1131 }
1132
1133 /* the cpu tick clock. */
1134 for (VMCPUID i = 0; i < pVM->cCPUs; i++)
1135 {
1136 PVMCPU pVCpu = &pVM->aCpus[i];
1137
1138 pVCpu->tm.s.fTSCTicking = false;
1139 SSMR3GetU64(pSSM, &pVCpu->tm.s.u64TSC);
1140
1141 if (pVM->tm.s.fTSCUseRealTSC)
1142 pVCpu->tm.s.u64TSCOffset = 0; /** @todo TSC restore stuff and HWACC. */
1143 }
1144
1145 rc = SSMR3GetU64(pSSM, &u64Hz);
1146 if (RT_FAILURE(rc))
1147 return rc;
1148 if (!pVM->tm.s.fTSCUseRealTSC)
1149 pVM->tm.s.cTSCTicksPerSecond = u64Hz;
1150
1151 LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%'RU64) fTSCVirtualized=%RTbool fTSCUseRealTSC=%RTbool (state load)\n",
1152 pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.fTSCVirtualized, pVM->tm.s.fTSCUseRealTSC));
1153
1154 /*
1155 * Make sure timers get rescheduled immediately.
1156 */
1157 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1158 VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
1159
1160 return VINF_SUCCESS;
1161}
1162
1163
1164/**
1165 * Internal TMR3TimerCreate worker.
1166 *
1167 * @returns VBox status code.
1168 * @param pVM The VM handle.
1169 * @param enmClock The timer clock.
1170 * @param pszDesc The timer description.
1171 * @param ppTimer Where to store the timer pointer on success.
1172 */
1173static int tmr3TimerCreate(PVM pVM, TMCLOCK enmClock, const char *pszDesc, PPTMTIMERR3 ppTimer)
1174{
1175 VM_ASSERT_EMT(pVM);
1176
1177 /*
1178 * Allocate the timer.
1179 */
1180 PTMTIMERR3 pTimer = NULL;
1181 if (pVM->tm.s.pFree && VM_IS_EMT(pVM))
1182 {
1183 pTimer = pVM->tm.s.pFree;
1184 pVM->tm.s.pFree = pTimer->pBigNext;
1185 Log3(("TM: Recycling timer %p, new free head %p.\n", pTimer, pTimer->pBigNext));
1186 }
1187
1188 if (!pTimer)
1189 {
1190 int rc = MMHyperAlloc(pVM, sizeof(*pTimer), 0, MM_TAG_TM, (void **)&pTimer);
1191 if (RT_FAILURE(rc))
1192 return rc;
1193 Log3(("TM: Allocated new timer %p\n", pTimer));
1194 }
1195
1196 /*
1197 * Initialize it.
1198 */
1199 pTimer->u64Expire = 0;
1200 pTimer->enmClock = enmClock;
1201 pTimer->pVMR3 = pVM;
1202 pTimer->pVMR0 = pVM->pVMR0;
1203 pTimer->pVMRC = pVM->pVMRC;
1204 pTimer->enmState = TMTIMERSTATE_STOPPED;
1205 pTimer->offScheduleNext = 0;
1206 pTimer->offNext = 0;
1207 pTimer->offPrev = 0;
1208 pTimer->pszDesc = pszDesc;
1209
1210 /* insert into the list of created timers. */
1211 tmLock(pVM);
1212 pTimer->pBigPrev = NULL;
1213 pTimer->pBigNext = pVM->tm.s.pCreated;
1214 pVM->tm.s.pCreated = pTimer;
1215 if (pTimer->pBigNext)
1216 pTimer->pBigNext->pBigPrev = pTimer;
1217#ifdef VBOX_STRICT
1218 tmTimerQueuesSanityChecks(pVM, "tmR3TimerCreate");
1219#endif
1220 tmUnlock(pVM);
1221
1222 *ppTimer = pTimer;
1223 return VINF_SUCCESS;
1224}
1225
1226
1227/**
1228 * Creates a device timer.
1229 *
1230 * @returns VBox status.
1231 * @param pVM The VM to create the timer in.
1232 * @param pDevIns Device instance.
1233 * @param enmClock The clock to use on this timer.
1234 * @param pfnCallback Callback function.
1235 * @param pszDesc Pointer to description string which must stay around
1236 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1237 * @param ppTimer Where to store the timer on success.
1238 */
1239VMMR3DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
1240{
1241 /*
1242 * Allocate and init stuff.
1243 */
1244 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1245 if (RT_SUCCESS(rc))
1246 {
1247 (*ppTimer)->enmType = TMTIMERTYPE_DEV;
1248 (*ppTimer)->u.Dev.pfnTimer = pfnCallback;
1249 (*ppTimer)->u.Dev.pDevIns = pDevIns;
1250 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1251 }
1252
1253 return rc;
1254}
1255
1256
1257/**
1258 * Creates a driver timer.
1259 *
1260 * @returns VBox status.
1261 * @param pVM The VM to create the timer in.
1262 * @param pDrvIns Driver instance.
1263 * @param enmClock The clock to use on this timer.
1264 * @param pfnCallback Callback function.
1265 * @param pszDesc Pointer to description string which must stay around
1266 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1267 * @param ppTimer Where to store the timer on success.
1268 */
1269VMMR3DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
1270{
1271 /*
1272 * Allocate and init stuff.
1273 */
1274 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, ppTimer);
1275 if (RT_SUCCESS(rc))
1276 {
1277 (*ppTimer)->enmType = TMTIMERTYPE_DRV;
1278 (*ppTimer)->u.Drv.pfnTimer = pfnCallback;
1279 (*ppTimer)->u.Drv.pDrvIns = pDrvIns;
1280 Log(("TM: Created device timer %p clock %d callback %p '%s'\n", (*ppTimer), enmClock, pfnCallback, pszDesc));
1281 }
1282
1283 return rc;
1284}
1285
1286
1287/**
1288 * Creates an internal timer.
1289 *
1290 * @returns VBox status.
1291 * @param pVM The VM to create the timer in.
1292 * @param enmClock The clock to use on this timer.
1293 * @param pfnCallback Callback function.
1294 * @param pvUser User argument to be passed to the callback.
1295 * @param pszDesc Pointer to description string which must stay around
1296 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1297 * @param ppTimer Where to store the timer on success.
1298 */
1299VMMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer)
1300{
1301 /*
1302 * Allocate and init stuff.
1303 */
1304 PTMTIMER pTimer;
1305 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1306 if (RT_SUCCESS(rc))
1307 {
1308 pTimer->enmType = TMTIMERTYPE_INTERNAL;
1309 pTimer->u.Internal.pfnTimer = pfnCallback;
1310 pTimer->u.Internal.pvUser = pvUser;
1311 *ppTimer = pTimer;
1312 Log(("TM: Created internal timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1313 }
1314
1315 return rc;
1316}
1317
1318/**
1319 * Creates an external timer.
1320 *
1321 * @returns Timer handle on success.
1322 * @returns NULL on failure.
1323 * @param pVM The VM to create the timer in.
1324 * @param enmClock The clock to use on this timer.
1325 * @param pfnCallback Callback function.
1326 * @param pvUser User argument.
1327 * @param pszDesc Pointer to description string which must stay around
1328 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1329 */
1330VMMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc)
1331{
1332 /*
1333 * Allocate and init stuff.
1334 */
1335 PTMTIMERR3 pTimer;
1336 int rc = tmr3TimerCreate(pVM, enmClock, pszDesc, &pTimer);
1337 if (RT_SUCCESS(rc))
1338 {
1339 pTimer->enmType = TMTIMERTYPE_EXTERNAL;
1340 pTimer->u.External.pfnTimer = pfnCallback;
1341 pTimer->u.External.pvUser = pvUser;
1342 Log(("TM: Created external timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1343 return pTimer;
1344 }
1345
1346 return NULL;
1347}
1348
1349
1350/**
1351 * Destroy a timer
1352 *
1353 * @returns VBox status.
1354 * @param pTimer Timer handle as returned by one of the create functions.
1355 */
1356VMMR3DECL(int) TMR3TimerDestroy(PTMTIMER pTimer)
1357{
1358 /*
1359 * Be extra careful here.
1360 */
1361 if (!pTimer)
1362 return VINF_SUCCESS;
1363 AssertPtr(pTimer);
1364 Assert((unsigned)pTimer->enmClock < (unsigned)TMCLOCK_MAX);
1365
1366 PVM pVM = pTimer->CTX_SUFF(pVM);
1367 PTMTIMERQUEUE pQueue = &pVM->tm.s.CTX_SUFF(paTimerQueues)[pTimer->enmClock];
1368 bool fActive = false;
1369 bool fPending = false;
1370
1371 /*
1372 * The rest of the game happens behind the lock, just
1373 * like create does. All the work is done here.
1374 */
1375 tmLock(pVM);
1376 for (int cRetries = 1000;; cRetries--)
1377 {
1378 /*
1379 * Change to the DESTROY state.
1380 */
1381 TMTIMERSTATE enmState = pTimer->enmState;
1382 TMTIMERSTATE enmNewState = enmState;
1383 Log2(("TMTimerDestroy: %p:{.enmState=%s, .pszDesc='%s'} cRetries=%d\n",
1384 pTimer, tmTimerState(enmState), R3STRING(pTimer->pszDesc), cRetries));
1385 switch (enmState)
1386 {
1387 case TMTIMERSTATE_STOPPED:
1388 case TMTIMERSTATE_EXPIRED_DELIVER:
1389 break;
1390
1391 case TMTIMERSTATE_ACTIVE:
1392 fActive = true;
1393 break;
1394
1395 case TMTIMERSTATE_PENDING_STOP:
1396 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
1397 case TMTIMERSTATE_PENDING_RESCHEDULE:
1398 fActive = true;
1399 fPending = true;
1400 break;
1401
1402 case TMTIMERSTATE_PENDING_SCHEDULE:
1403 fPending = true;
1404 break;
1405
1406 /*
1407 * This shouldn't happen as the caller should make sure there are no races.
1408 */
1409 case TMTIMERSTATE_EXPIRED_GET_UNLINK:
1410 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
1411 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
1412 AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1413 tmUnlock(pVM);
1414 if (!RTThreadYield())
1415 RTThreadSleep(1);
1416 AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1417 VERR_TM_UNSTABLE_STATE);
1418 tmLock(pVM);
1419 continue;
1420
1421 /*
1422 * Invalid states.
1423 */
1424 case TMTIMERSTATE_FREE:
1425 case TMTIMERSTATE_DESTROY:
1426 tmUnlock(pVM);
1427 AssertLogRelMsgFailedReturn(("pTimer=%p %s\n", pTimer, tmTimerState(enmState)), VERR_TM_INVALID_STATE);
1428
1429 default:
1430 AssertMsgFailed(("Unknown timer state %d (%s)\n", enmState, R3STRING(pTimer->pszDesc)));
1431 tmUnlock(pVM);
1432 return VERR_TM_UNKNOWN_STATE;
1433 }
1434
1435 /*
1436 * Try switch to the destroy state.
1437 * This should always succeed as the caller should make sure there are no race.
1438 */
1439 bool fRc;
1440 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_DESTROY, enmState, fRc);
1441 if (fRc)
1442 break;
1443 AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1444 tmUnlock(pVM);
1445 AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1446 VERR_TM_UNSTABLE_STATE);
1447 tmLock(pVM);
1448 }
1449
1450 /*
1451 * Unlink from the active list.
1452 */
1453 if (fActive)
1454 {
1455 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1456 const PTMTIMER pNext = TMTIMER_GET_NEXT(pTimer);
1457 if (pPrev)
1458 TMTIMER_SET_NEXT(pPrev, pNext);
1459 else
1460 {
1461 TMTIMER_SET_HEAD(pQueue, pNext);
1462 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1463 }
1464 if (pNext)
1465 TMTIMER_SET_PREV(pNext, pPrev);
1466 pTimer->offNext = 0;
1467 pTimer->offPrev = 0;
1468 }
1469
1470 /*
1471 * Unlink from the schedule list by running it.
1472 */
1473 if (fPending)
1474 {
1475 Log3(("TMR3TimerDestroy: tmTimerQueueSchedule\n"));
1476 STAM_PROFILE_START(&pVM->tm.s.CTXALLSUFF(StatScheduleOne), a);
1477 Assert(pQueue->offSchedule);
1478 tmTimerQueueSchedule(pVM, pQueue);
1479 }
1480
1481 /*
1482 * Read to move the timer from the created list and onto the free list.
1483 */
1484 Assert(!pTimer->offNext); Assert(!pTimer->offPrev); Assert(!pTimer->offScheduleNext);
1485
1486 /* unlink from created list */
1487 if (pTimer->pBigPrev)
1488 pTimer->pBigPrev->pBigNext = pTimer->pBigNext;
1489 else
1490 pVM->tm.s.pCreated = pTimer->pBigNext;
1491 if (pTimer->pBigNext)
1492 pTimer->pBigNext->pBigPrev = pTimer->pBigPrev;
1493 pTimer->pBigNext = 0;
1494 pTimer->pBigPrev = 0;
1495
1496 /* free */
1497 Log2(("TM: Inserting %p into the free list ahead of %p!\n", pTimer, pVM->tm.s.pFree));
1498 TM_SET_STATE(pTimer, TMTIMERSTATE_FREE);
1499 pTimer->pBigNext = pVM->tm.s.pFree;
1500 pVM->tm.s.pFree = pTimer;
1501
1502#ifdef VBOX_STRICT
1503 tmTimerQueuesSanityChecks(pVM, "TMR3TimerDestroy");
1504#endif
1505 tmUnlock(pVM);
1506 return VINF_SUCCESS;
1507}
1508
1509
1510/**
1511 * Destroy all timers owned by a device.
1512 *
1513 * @returns VBox status.
1514 * @param pVM VM handle.
1515 * @param pDevIns Device which timers should be destroyed.
1516 */
1517VMMR3DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns)
1518{
1519 LogFlow(("TMR3TimerDestroyDevice: pDevIns=%p\n", pDevIns));
1520 if (!pDevIns)
1521 return VERR_INVALID_PARAMETER;
1522
1523 tmLock(pVM);
1524 PTMTIMER pCur = pVM->tm.s.pCreated;
1525 while (pCur)
1526 {
1527 PTMTIMER pDestroy = pCur;
1528 pCur = pDestroy->pBigNext;
1529 if ( pDestroy->enmType == TMTIMERTYPE_DEV
1530 && pDestroy->u.Dev.pDevIns == pDevIns)
1531 {
1532 int rc = TMR3TimerDestroy(pDestroy);
1533 AssertRC(rc);
1534 }
1535 }
1536 tmUnlock(pVM);
1537
1538 LogFlow(("TMR3TimerDestroyDevice: returns VINF_SUCCESS\n"));
1539 return VINF_SUCCESS;
1540}
1541
1542
1543/**
1544 * Destroy all timers owned by a driver.
1545 *
1546 * @returns VBox status.
1547 * @param pVM VM handle.
1548 * @param pDrvIns Driver which timers should be destroyed.
1549 */
1550VMMR3DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns)
1551{
1552 LogFlow(("TMR3TimerDestroyDriver: pDrvIns=%p\n", pDrvIns));
1553 if (!pDrvIns)
1554 return VERR_INVALID_PARAMETER;
1555
1556 tmLock(pVM);
1557 PTMTIMER pCur = pVM->tm.s.pCreated;
1558 while (pCur)
1559 {
1560 PTMTIMER pDestroy = pCur;
1561 pCur = pDestroy->pBigNext;
1562 if ( pDestroy->enmType == TMTIMERTYPE_DRV
1563 && pDestroy->u.Drv.pDrvIns == pDrvIns)
1564 {
1565 int rc = TMR3TimerDestroy(pDestroy);
1566 AssertRC(rc);
1567 }
1568 }
1569 tmUnlock(pVM);
1570
1571 LogFlow(("TMR3TimerDestroyDriver: returns VINF_SUCCESS\n"));
1572 return VINF_SUCCESS;
1573}
1574
1575
1576/**
1577 * Internal function for getting the clock time.
1578 *
1579 * @returns clock time.
1580 * @param pVM The VM handle.
1581 * @param enmClock The clock.
1582 */
1583DECLINLINE(uint64_t) tmClock(PVM pVM, TMCLOCK enmClock)
1584{
1585 switch (enmClock)
1586 {
1587 case TMCLOCK_VIRTUAL: return TMVirtualGet(pVM);
1588 case TMCLOCK_VIRTUAL_SYNC: return TMVirtualSyncGet(pVM);
1589 case TMCLOCK_REAL: return TMRealGet(pVM);
1590 case TMCLOCK_TSC: return TMCpuTickGet(&pVM->aCpus[0] /* just take VCPU 0 */);
1591 default:
1592 AssertMsgFailed(("enmClock=%d\n", enmClock));
1593 return ~(uint64_t)0;
1594 }
1595}
1596
1597
1598/**
1599 * Checks if the sync queue has one or more expired timers.
1600 *
1601 * @returns true / false.
1602 *
1603 * @param pVM The VM handle.
1604 * @param enmClock The queue.
1605 */
1606DECLINLINE(bool) tmR3HasExpiredTimer(PVM pVM, TMCLOCK enmClock)
1607{
1608 const uint64_t u64Expire = pVM->tm.s.CTX_SUFF(paTimerQueues)[enmClock].u64Expire;
1609 return u64Expire != INT64_MAX && u64Expire <= tmClock(pVM, enmClock);
1610}
1611
1612
1613/**
1614 * Checks for expired timers in all the queues.
1615 *
1616 * @returns true / false.
1617 * @param pVM The VM handle.
1618 */
1619DECLINLINE(bool) tmR3AnyExpiredTimers(PVM pVM)
1620{
1621 /*
1622 * Combine the time calculation for the first two since we're not on EMT
1623 * TMVirtualSyncGet only permits EMT.
1624 */
1625 uint64_t u64Now = TMVirtualGetNoCheck(pVM);
1626 if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL].u64Expire <= u64Now)
1627 return true;
1628 u64Now = pVM->tm.s.fVirtualSyncTicking
1629 ? u64Now - pVM->tm.s.offVirtualSync
1630 : pVM->tm.s.u64VirtualSync;
1631 if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL_SYNC].u64Expire <= u64Now)
1632 return true;
1633
1634 /*
1635 * The remaining timers.
1636 */
1637 if (tmR3HasExpiredTimer(pVM, TMCLOCK_REAL))
1638 return true;
1639 if (tmR3HasExpiredTimer(pVM, TMCLOCK_TSC))
1640 return true;
1641 return false;
1642}
1643
1644
1645/**
1646 * Schedulation timer callback.
1647 *
1648 * @param pTimer Timer handle.
1649 * @param pvUser VM handle.
1650 * @thread Timer thread.
1651 *
1652 * @remark We cannot do the scheduling and queues running from a timer handler
1653 * since it's not executing in EMT, and even if it was it would be async
1654 * and we wouldn't know the state of the affairs.
1655 * So, we'll just raise the timer FF and force any REM execution to exit.
1656 */
1657static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t /*iTick*/)
1658{
1659 PVM pVM = (PVM)pvUser;
1660 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1661
1662 AssertCompile(TMCLOCK_MAX == 4);
1663#ifdef DEBUG_Sander /* very annoying, keep it private. */
1664 if (VMCPU_FF_ISSET(pVCpuDst, VMCPU_FF_TIMER))
1665 Log(("tmR3TimerCallback: timer event still pending!!\n"));
1666#endif
1667 if ( !VMCPU_FF_ISSET(pVCpuDst, VMCPU_FF_TIMER)
1668 && ( pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule /** @todo FIXME - reconsider offSchedule as a reason for running the timer queues. */
1669 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule
1670 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule
1671 || pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offSchedule
1672 || tmR3AnyExpiredTimers(pVM)
1673 )
1674 && !VMCPU_FF_ISSET(pVCpuDst, VMCPU_FF_TIMER)
1675 && !pVM->tm.s.fRunningQueues
1676 )
1677 {
1678 Log5(("TM(%u): FF: 0 -> 1\n", __LINE__));
1679 VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
1680 REMR3NotifyTimerPending(pVM, pVCpuDst);
1681 VMR3NotifyCpuFFU(pVCpuDst->pUVCpu, VMNOTIFYFF_FLAGS_DONE_REM /** @todo | VMNOTIFYFF_FLAGS_POKE ?*/);
1682 STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallbackSetFF);
1683 }
1684}
1685
1686
1687/**
1688 * Schedules and runs any pending timers.
1689 *
1690 * This is normally called from a forced action handler in EMT.
1691 *
1692 * @param pVM The VM to run the timers for.
1693 *
1694 * @thread EMT (actually EMT0, but we fend off the others)
1695 */
1696VMMR3DECL(void) TMR3TimerQueuesDo(PVM pVM)
1697{
1698 /*
1699 * Only the dedicated timer EMT should do stuff here.
1700 * (fRunningQueues is only used as an indicator.)
1701 */
1702 Assert(pVM->tm.s.idTimerCpu < pVM->cCPUs);
1703 PVMCPU pVCpuDst = &pVM->aCpus[pVM->tm.s.idTimerCpu];
1704 if (VMMGetCpu(pVM) != pVCpuDst)
1705 {
1706 Assert(pVM->cCPUs > 1);
1707 return;
1708 }
1709 STAM_PROFILE_START(&pVM->tm.s.StatDoQueues, a);
1710 Log2(("TMR3TimerQueuesDo:\n"));
1711 Assert(!pVM->tm.s.fRunningQueues);
1712 ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, true);
1713 tmLock(pVM);
1714
1715 /*
1716 * Process the queues.
1717 */
1718 AssertCompile(TMCLOCK_MAX == 4);
1719
1720 /* TMCLOCK_VIRTUAL_SYNC (see also TMR3VirtualSyncFF) */
1721 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
1722 tmVirtualSyncLock(pVM);
1723 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
1724 VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /* Clear the FF once we started working for real. */
1725
1726 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule)
1727 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC]);
1728 tmR3TimerQueueRunVirtualSync(pVM);
1729 if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
1730 VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
1731
1732 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
1733 tmVirtualSyncUnlock(pVM);
1734 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
1735
1736 /* TMCLOCK_VIRTUAL */
1737 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
1738 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule)
1739 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
1740 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
1741 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
1742
1743 /* TMCLOCK_TSC */
1744 Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offActive); /* not used */
1745
1746 /* TMCLOCK_REAL */
1747 STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
1748 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule)
1749 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
1750 tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
1751 STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
1752
1753#ifdef VBOX_STRICT
1754 /* check that we didn't screwup. */
1755 tmTimerQueuesSanityChecks(pVM, "TMR3TimerQueuesDo");
1756#endif
1757
1758 /* done */
1759 Log2(("TMR3TimerQueuesDo: returns void\n"));
1760 ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, false);
1761 tmUnlock(pVM);
1762 STAM_PROFILE_STOP(&pVM->tm.s.StatDoQueues, a);
1763}
1764
1765//__BEGIN_DECLS
1766//int iomLock(PVM pVM);
1767//void iomUnlock(PVM pVM);
1768//__END_DECLS
1769
1770
1771/**
1772 * Schedules and runs any pending times in the specified queue.
1773 *
1774 * This is normally called from a forced action handler in EMT.
1775 *
1776 * @param pVM The VM to run the timers for.
1777 * @param pQueue The queue to run.
1778 */
1779static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue)
1780{
1781 VM_ASSERT_EMT(pVM);
1782
1783 /*
1784 * Run timers.
1785 *
1786 * We check the clock once and run all timers which are ACTIVE
1787 * and have an expire time less or equal to the time we read.
1788 *
1789 * N.B. A generic unlink must be applied since other threads
1790 * are allowed to mess with any active timer at any time.
1791 * However, we only allow EMT to handle EXPIRED_PENDING
1792 * timers, thus enabling the timer handler function to
1793 * arm the timer again.
1794 */
1795 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
1796 if (!pNext)
1797 return;
1798 const uint64_t u64Now = tmClock(pVM, pQueue->enmClock);
1799 while (pNext && pNext->u64Expire <= u64Now)
1800 {
1801 PTMTIMER pTimer = pNext;
1802 pNext = TMTIMER_GET_NEXT(pTimer);
1803 Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
1804 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
1805 bool fRc;
1806 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_GET_UNLINK, TMTIMERSTATE_ACTIVE, fRc);
1807 if (fRc)
1808 {
1809 Assert(!pTimer->offScheduleNext); /* this can trigger falsely */
1810
1811 /* unlink */
1812 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1813 if (pPrev)
1814 TMTIMER_SET_NEXT(pPrev, pNext);
1815 else
1816 {
1817 TMTIMER_SET_HEAD(pQueue, pNext);
1818 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1819 }
1820 if (pNext)
1821 TMTIMER_SET_PREV(pNext, pPrev);
1822 pTimer->offNext = 0;
1823 pTimer->offPrev = 0;
1824
1825 /* fire */
1826 TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
1827// tmUnlock(pVM);
1828 switch (pTimer->enmType)
1829 {
1830 case TMTIMERTYPE_DEV:
1831// iomLock(pVM);
1832 pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer);
1833// iomUnlock(pVM);
1834 break;
1835
1836 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer); break;
1837 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->u.Internal.pvUser); break;
1838 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->u.External.pvUser); break;
1839 default:
1840 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
1841 break;
1842 }
1843// tmLock(pVM);
1844
1845 /* change the state if it wasn't changed already in the handler. */
1846 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
1847 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
1848 }
1849 } /* run loop */
1850}
1851
1852
1853/**
1854 * Schedules and runs any pending times in the timer queue for the
1855 * synchronous virtual clock.
1856 *
1857 * This scheduling is a bit different from the other queues as it need
1858 * to implement the special requirements of the timer synchronous virtual
1859 * clock, thus this 2nd queue run funcion.
1860 *
1861 * @param pVM The VM to run the timers for.
1862 *
1863 * @remarks The caller must own both the TM/EMT and the Virtual Sync locks.
1864 */
1865static void tmR3TimerQueueRunVirtualSync(PVM pVM)
1866{
1867 PTMTIMERQUEUE const pQueue = &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC];
1868 VM_ASSERT_EMT(pVM);
1869
1870 /*
1871 * Any timers?
1872 */
1873 PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
1874 if (RT_UNLIKELY(!pNext))
1875 {
1876 Assert(pVM->tm.s.fVirtualSyncTicking || !pVM->tm.s.cVirtualTicking);
1877 return;
1878 }
1879 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRun);
1880
1881 /*
1882 * Calculate the time frame for which we will dispatch timers.
1883 *
1884 * We use a time frame ranging from the current sync time (which is most likely the
1885 * same as the head timer) and some configurable period (100000ns) up towards the
1886 * current virtual time. This period might also need to be restricted by the catch-up
1887 * rate so frequent calls to this function won't accelerate the time too much, however
1888 * this will be implemented at a later point if neccessary.
1889 *
1890 * Without this frame we would 1) having to run timers much more frequently
1891 * and 2) lag behind at a steady rate.
1892 */
1893 const uint64_t u64VirtualNow = TMVirtualGetNoCheck(pVM);
1894 uint64_t const offSyncGivenUp = pVM->tm.s.offVirtualSyncGivenUp;
1895 uint64_t u64Now;
1896 if (!pVM->tm.s.fVirtualSyncTicking)
1897 {
1898 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStoppedAlready);
1899 u64Now = pVM->tm.s.u64VirtualSync;
1900 Assert(u64Now <= pNext->u64Expire);
1901 }
1902 else
1903 {
1904 /* Calc 'now'. */
1905 bool fStopCatchup = false;
1906 bool fUpdateStuff = false;
1907 uint64_t off = pVM->tm.s.offVirtualSync;
1908 if (pVM->tm.s.fVirtualSyncCatchUp)
1909 {
1910 uint64_t u64Delta = u64VirtualNow - pVM->tm.s.u64VirtualSyncCatchUpPrev;
1911 if (RT_LIKELY(!(u64Delta >> 32)))
1912 {
1913 uint64_t u64Sub = ASMMultU64ByU32DivByU32(u64Delta, pVM->tm.s.u32VirtualSyncCatchUpPercentage, 100);
1914 if (off > u64Sub + offSyncGivenUp)
1915 {
1916 off -= u64Sub;
1917 Log4(("TM: %'RU64/-%'8RU64: sub %'RU64 [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow - off, off - offSyncGivenUp, u64Sub));
1918 }
1919 else
1920 {
1921 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
1922 fStopCatchup = true;
1923 off = offSyncGivenUp;
1924 }
1925 }
1926 }
1927 u64Now = u64VirtualNow - off;
1928
1929 /* Check if stopped by expired timer. */
1930 uint64_t u64Expire = pNext->u64Expire;
1931 if (u64Now >= pNext->u64Expire)
1932 {
1933 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStop);
1934 u64Now = pNext->u64Expire;
1935 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
1936 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
1937 Log4(("TM: %'RU64/-%'8RU64: exp tmr [tmR3TimerQueueRunVirtualSync]\n", u64Now, u64VirtualNow - u64Now - offSyncGivenUp));
1938 }
1939 else if (fUpdateStuff)
1940 {
1941 ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, off);
1942 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSyncCatchUpPrev, u64VirtualNow);
1943 if (fStopCatchup)
1944 {
1945 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
1946 Log4(("TM: %'RU64/0: caught up [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow));
1947 }
1948 }
1949 }
1950
1951 /* calc end of frame. */
1952 uint64_t u64Max = u64Now + pVM->tm.s.u32VirtualSyncScheduleSlack;
1953 if (u64Max > u64VirtualNow - offSyncGivenUp)
1954 u64Max = u64VirtualNow - offSyncGivenUp;
1955
1956 /* assert sanity */
1957 Assert(u64Now <= u64VirtualNow - offSyncGivenUp);
1958 Assert(u64Max <= u64VirtualNow - offSyncGivenUp);
1959 Assert(u64Now <= u64Max);
1960 Assert(offSyncGivenUp == pVM->tm.s.offVirtualSyncGivenUp);
1961
1962 /*
1963 * Process the expired timers moving the clock along as we progress.
1964 */
1965#ifdef VBOX_STRICT
1966 uint64_t u64Prev = u64Now; NOREF(u64Prev);
1967#endif
1968 while (pNext && pNext->u64Expire <= u64Max)
1969 {
1970 PTMTIMER pTimer = pNext;
1971 pNext = TMTIMER_GET_NEXT(pTimer);
1972 Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
1973 pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
1974 bool fRc;
1975 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_GET_UNLINK, TMTIMERSTATE_ACTIVE, fRc);
1976 if (fRc)
1977 {
1978 /* unlink */
1979 const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1980 if (pPrev)
1981 TMTIMER_SET_NEXT(pPrev, pNext);
1982 else
1983 {
1984 TMTIMER_SET_HEAD(pQueue, pNext);
1985 pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1986 }
1987 if (pNext)
1988 TMTIMER_SET_PREV(pNext, pPrev);
1989 pTimer->offNext = 0;
1990 pTimer->offPrev = 0;
1991
1992 /* advance the clock - don't permit timers to be out of order or armed in the 'past'. */
1993#ifdef VBOX_STRICT
1994 AssertMsg(pTimer->u64Expire >= u64Prev, ("%'RU64 < %'RU64 %s\n", pTimer->u64Expire, u64Prev, pTimer->pszDesc));
1995 u64Prev = pTimer->u64Expire;
1996#endif
1997 ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, pTimer->u64Expire);
1998 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
1999
2000 /* fire */
2001 TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2002 switch (pTimer->enmType)
2003 {
2004 case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer); break;
2005 case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer); break;
2006 case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer, pTimer->u.Internal.pvUser); break;
2007 case TMTIMERTYPE_EXTERNAL: pTimer->u.External.pfnTimer(pTimer->u.External.pvUser); break;
2008 default:
2009 AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2010 break;
2011 }
2012
2013 /* change the state if it wasn't changed already in the handler. */
2014 TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2015 Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2016 }
2017 } /* run loop */
2018
2019 /*
2020 * Restart the clock if it was stopped to serve any timers,
2021 * and start/adjust catch-up if necessary.
2022 */
2023 if ( !pVM->tm.s.fVirtualSyncTicking
2024 && pVM->tm.s.cVirtualTicking)
2025 {
2026 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunRestart);
2027
2028 /* calc the slack we've handed out. */
2029 const uint64_t u64VirtualNow2 = TMVirtualGetNoCheck(pVM);
2030 Assert(u64VirtualNow2 >= u64VirtualNow);
2031 AssertMsg(pVM->tm.s.u64VirtualSync >= u64Now, ("%'RU64 < %'RU64\n", pVM->tm.s.u64VirtualSync, u64Now));
2032 const uint64_t offSlack = pVM->tm.s.u64VirtualSync - u64Now;
2033 STAM_STATS({
2034 if (offSlack)
2035 {
2036 PSTAMPROFILE p = &pVM->tm.s.StatVirtualSyncRunSlack;
2037 p->cPeriods++;
2038 p->cTicks += offSlack;
2039 if (p->cTicksMax < offSlack) p->cTicksMax = offSlack;
2040 if (p->cTicksMin > offSlack) p->cTicksMin = offSlack;
2041 }
2042 });
2043
2044 /* Let the time run a little bit while we were busy running timers(?). */
2045 uint64_t u64Elapsed;
2046#define MAX_ELAPSED 30000U /* ns */
2047 if (offSlack > MAX_ELAPSED)
2048 u64Elapsed = 0;
2049 else
2050 {
2051 u64Elapsed = u64VirtualNow2 - u64VirtualNow;
2052 if (u64Elapsed > MAX_ELAPSED)
2053 u64Elapsed = MAX_ELAPSED;
2054 u64Elapsed = u64Elapsed > offSlack ? u64Elapsed - offSlack : 0;
2055 }
2056#undef MAX_ELAPSED
2057
2058 /* Calc the current offset. */
2059 uint64_t offNew = u64VirtualNow2 - pVM->tm.s.u64VirtualSync - u64Elapsed;
2060 Assert(!(offNew & RT_BIT_64(63)));
2061 uint64_t offLag = offNew - pVM->tm.s.offVirtualSyncGivenUp;
2062 Assert(!(offLag & RT_BIT_64(63)));
2063
2064 /*
2065 * Deal with starting, adjusting and stopping catchup.
2066 */
2067 if (pVM->tm.s.fVirtualSyncCatchUp)
2068 {
2069 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpStopThreshold)
2070 {
2071 /* stop */
2072 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2073 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2074 Log4(("TM: %'RU64/-%'8RU64: caught up [pt]\n", u64VirtualNow2 - offNew, offLag));
2075 }
2076 else if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2077 {
2078 /* adjust */
2079 unsigned i = 0;
2080 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2081 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2082 i++;
2083 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage < pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage)
2084 {
2085 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupAdjust[i]);
2086 ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2087 Log4(("TM: %'RU64/%'8RU64: adj %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2088 }
2089 pVM->tm.s.u64VirtualSyncCatchUpPrev = u64VirtualNow2;
2090 }
2091 else
2092 {
2093 /* give up */
2094 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUp);
2095 STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2096 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2097 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2098 Log4(("TM: %'RU64/%'8RU64: give up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2099 LogRel(("TM: Giving up catch-up attempt at a %'RU64 ns lag; new total: %'RU64 ns\n", offLag, offNew));
2100 }
2101 }
2102 else if (offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[0].u64Start)
2103 {
2104 if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2105 {
2106 /* start */
2107 STAM_PROFILE_ADV_START(&pVM->tm.s.StatVirtualSyncCatchup, c);
2108 unsigned i = 0;
2109 while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2110 && offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2111 i++;
2112 STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupInitial[i]);
2113 ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2114 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, true);
2115 Log4(("TM: %'RU64/%'8RU64: catch-up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2116 }
2117 else
2118 {
2119 /* don't bother */
2120 STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUpBeforeStarting);
2121 ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2122 Log4(("TM: %'RU64/%'8RU64: give up\n", u64VirtualNow2 - offNew, offLag));
2123 LogRel(("TM: Not bothering to attempt catching up a %'RU64 ns lag; new total: %'RU64\n", offLag, offNew));
2124 }
2125 }
2126
2127 /*
2128 * Update the offset and restart the clock.
2129 */
2130 Assert(!(offNew & RT_BIT_64(63)));
2131 ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, offNew);
2132 ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, true);
2133 }
2134}
2135
2136
2137/**
2138 * Deals with stopped Virtual Sync clock.
2139 *
2140 * This is called by the forced action flag handling code in EM when it
2141 * encounters the VM_FF_TM_VIRTUAL_SYNC flag. It is called by all VCPUs and they
2142 * will block on the VirtualSyncLock until the pending timers has been executed
2143 * and the clock restarted.
2144 *
2145 * @param pVM The VM to run the timers for.
2146 * @param pVCpu The virtual CPU we're running at.
2147 *
2148 * @thread EMTs
2149 */
2150VMMR3DECL(void) TMR3VirtualSyncFF(PVM pVM, PVMCPU pVCpu)
2151{
2152 Log2(("TMR3VirtualSyncFF:\n"));
2153
2154 /*
2155 * The EMT doing the timers is diverted to them.
2156 */
2157 if (pVCpu->idCpu == pVM->tm.s.idTimerCpu)
2158 TMR3TimerQueuesDo(pVM);
2159 /*
2160 * The other EMTs will block on the virtual sync lock and the first owner
2161 * will run the queue and thus restarting the clock.
2162 *
2163 * Note! This is very suboptimal code wrt to resuming execution when there
2164 * are more than two Virtual CPUs, since they will all have to enter
2165 * the critical section one by one. But it's a very simple solution
2166 * which will have to do the job for now.
2167 */
2168 else
2169 {
2170 STAM_PROFILE_START(&pVM->tm.s.StatVirtualSyncFF, a);
2171 tmVirtualSyncLock(pVM);
2172 if (pVM->tm.s.fVirtualSyncTicking)
2173 {
2174 STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2175 tmVirtualSyncUnlock(pVM);
2176 Log2(("TMR3VirtualSyncFF: ticking\n"));
2177 }
2178 else
2179 {
2180 tmVirtualSyncUnlock(pVM);
2181
2182 /* try run it. */
2183 tmLock(pVM);
2184 tmVirtualSyncLock(pVM);
2185 if (pVM->tm.s.fVirtualSyncTicking)
2186 Log2(("TMR3VirtualSyncFF: ticking (2)\n"));
2187 else
2188 {
2189 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2190 Log2(("TMR3VirtualSyncFF: running queue\n"));
2191
2192 if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule)
2193 tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC]);
2194 tmR3TimerQueueRunVirtualSync(pVM);
2195 if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2196 VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2197
2198 ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2199 }
2200 STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2201 tmVirtualSyncUnlock(pVM);
2202 tmUnlock(pVM);
2203 }
2204 }
2205}
2206
2207
2208/**
2209 * Saves the state of a timer to a saved state.
2210 *
2211 * @returns VBox status.
2212 * @param pTimer Timer to save.
2213 * @param pSSM Save State Manager handle.
2214 */
2215VMMR3DECL(int) TMR3TimerSave(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
2216{
2217 LogFlow(("TMR3TimerSave: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2218 switch (pTimer->enmState)
2219 {
2220 case TMTIMERSTATE_STOPPED:
2221 case TMTIMERSTATE_PENDING_STOP:
2222 case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
2223 return SSMR3PutU8(pSSM, (uint8_t)TMTIMERSTATE_PENDING_STOP);
2224
2225 case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
2226 case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
2227 AssertMsgFailed(("u64Expire is being updated! (%s)\n", pTimer->pszDesc));
2228 if (!RTThreadYield())
2229 RTThreadSleep(1);
2230 /* fall thru */
2231 case TMTIMERSTATE_ACTIVE:
2232 case TMTIMERSTATE_PENDING_SCHEDULE:
2233 case TMTIMERSTATE_PENDING_RESCHEDULE:
2234 SSMR3PutU8(pSSM, (uint8_t)TMTIMERSTATE_PENDING_SCHEDULE);
2235 return SSMR3PutU64(pSSM, pTimer->u64Expire);
2236
2237 case TMTIMERSTATE_EXPIRED_GET_UNLINK:
2238 case TMTIMERSTATE_EXPIRED_DELIVER:
2239 case TMTIMERSTATE_DESTROY:
2240 case TMTIMERSTATE_FREE:
2241 AssertMsgFailed(("Invalid timer state %d %s (%s)\n", pTimer->enmState, tmTimerState(pTimer->enmState), pTimer->pszDesc));
2242 return SSMR3HandleSetStatus(pSSM, VERR_TM_INVALID_STATE);
2243 }
2244
2245 AssertMsgFailed(("Unknown timer state %d (%s)\n", pTimer->enmState, pTimer->pszDesc));
2246 return SSMR3HandleSetStatus(pSSM, VERR_TM_UNKNOWN_STATE);
2247}
2248
2249
2250/**
2251 * Loads the state of a timer from a saved state.
2252 *
2253 * @returns VBox status.
2254 * @param pTimer Timer to restore.
2255 * @param pSSM Save State Manager handle.
2256 */
2257VMMR3DECL(int) TMR3TimerLoad(PTMTIMERR3 pTimer, PSSMHANDLE pSSM)
2258{
2259 Assert(pTimer); Assert(pSSM); VM_ASSERT_EMT(pTimer->pVMR3);
2260 LogFlow(("TMR3TimerLoad: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2261
2262 /*
2263 * Load the state and validate it.
2264 */
2265 uint8_t u8State;
2266 int rc = SSMR3GetU8(pSSM, &u8State);
2267 if (RT_FAILURE(rc))
2268 return rc;
2269 TMTIMERSTATE enmState = (TMTIMERSTATE)u8State;
2270 if ( enmState != TMTIMERSTATE_PENDING_STOP
2271 && enmState != TMTIMERSTATE_PENDING_SCHEDULE
2272 && enmState != TMTIMERSTATE_PENDING_STOP_SCHEDULE)
2273 {
2274 AssertMsgFailed(("enmState=%d %s\n", enmState, tmTimerState(enmState)));
2275 return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2276 }
2277
2278 if (enmState == TMTIMERSTATE_PENDING_SCHEDULE)
2279 {
2280 /*
2281 * Load the expire time.
2282 */
2283 uint64_t u64Expire;
2284 rc = SSMR3GetU64(pSSM, &u64Expire);
2285 if (RT_FAILURE(rc))
2286 return rc;
2287
2288 /*
2289 * Set it.
2290 */
2291 Log(("enmState=%d %s u64Expire=%llu\n", enmState, tmTimerState(enmState), u64Expire));
2292 rc = TMTimerSet(pTimer, u64Expire);
2293 }
2294 else
2295 {
2296 /*
2297 * Stop it.
2298 */
2299 Log(("enmState=%d %s\n", enmState, tmTimerState(enmState)));
2300 rc = TMTimerStop(pTimer);
2301 }
2302
2303 /*
2304 * On failure set SSM status.
2305 */
2306 if (RT_FAILURE(rc))
2307 rc = SSMR3HandleSetStatus(pSSM, rc);
2308 return rc;
2309}
2310
2311
2312/**
2313 * Get the real world UTC time adjusted for VM lag.
2314 *
2315 * @returns pTime.
2316 * @param pVM The VM instance.
2317 * @param pTime Where to store the time.
2318 */
2319VMMR3DECL(PRTTIMESPEC) TMR3UTCNow(PVM pVM, PRTTIMESPEC pTime)
2320{
2321 RTTimeNow(pTime);
2322 RTTimeSpecSubNano(pTime, ASMAtomicReadU64(&pVM->tm.s.offVirtualSync) - ASMAtomicReadU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp));
2323 RTTimeSpecAddNano(pTime, pVM->tm.s.offUTC);
2324 return pTime;
2325}
2326
2327
2328/**
2329 * Pauses all clocks except TMCLOCK_REAL.
2330 *
2331 * @returns VBox status code, all errors are asserted.
2332 * @param pVM The VM handle.
2333 * @param pVCpu The virtual CPU handle.
2334 * @thread EMT corrsponding to the virtual CPU handle.
2335 */
2336VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu)
2337{
2338 VMCPU_ASSERT_EMT(pVCpu);
2339
2340 /*
2341 * The shared virtual clock (includes virtual sync which is tied to it).
2342 */
2343 tmLock(pVM);
2344 int rc = tmVirtualPauseLocked(pVM);
2345 tmUnlock(pVM);
2346 if (RT_FAILURE(rc))
2347 return rc;
2348
2349 /*
2350 * Pause the TSC last since it is normally linked to the virtual
2351 * sync clock, so the above code may actually stop both clock.
2352 */
2353 return tmCpuTickPause(pVM, pVCpu);
2354}
2355
2356
2357/**
2358 * Resumes all clocks except TMCLOCK_REAL.
2359 *
2360 * @returns VBox status code, all errors are asserted.
2361 * @param pVM The VM handle.
2362 * @param pVCpu The virtual CPU handle.
2363 * @thread EMT corrsponding to the virtual CPU handle.
2364 */
2365VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu)
2366{
2367 VMCPU_ASSERT_EMT(pVCpu);
2368 int rc;
2369
2370 /*
2371 * Resume the TSC first since it is normally linked to the virtual sync
2372 * clock, so it may actually not be resumed until we've executed the code
2373 * below.
2374 */
2375 if (!pVM->tm.s.fTSCTiedToExecution)
2376 {
2377 rc = tmCpuTickResume(pVM, pVCpu);
2378 if (RT_FAILURE(rc))
2379 return rc;
2380 }
2381
2382 /*
2383 * The shared virtual clock (includes virtual sync which is tied to it).
2384 */
2385 tmLock(pVM);
2386 rc = tmVirtualResumeLocked(pVM);
2387 tmUnlock(pVM);
2388
2389 return rc;
2390}
2391
2392
2393/**
2394 * Sets the warp drive percent of the virtual time.
2395 *
2396 * @returns VBox status code.
2397 * @param pVM The VM handle.
2398 * @param u32Percent The new percentage. 100 means normal operation.
2399 *
2400 * @todo Move to Ring-3!
2401 */
2402VMMDECL(int) TMR3SetWarpDrive(PVM pVM, uint32_t u32Percent)
2403{
2404 PVMREQ pReq;
2405 int rc = VMR3ReqCall(pVM, VMCPUID_ANY, &pReq, RT_INDEFINITE_WAIT,
2406 (PFNRT)tmR3SetWarpDrive, 2, pVM, u32Percent);
2407 if (RT_SUCCESS(rc))
2408 rc = pReq->iStatus;
2409 VMR3ReqFree(pReq);
2410 return rc;
2411}
2412
2413
2414/**
2415 * EMT worker for TMR3SetWarpDrive.
2416 *
2417 * @returns VBox status code.
2418 * @param pVM The VM handle.
2419 * @param u32Percent See TMR3SetWarpDrive().
2420 * @internal
2421 */
2422static DECLCALLBACK(int) tmR3SetWarpDrive(PVM pVM, uint32_t u32Percent)
2423{
2424 PVMCPU pVCpu = VMMGetCpu(pVM);
2425
2426 /*
2427 * Validate it.
2428 */
2429 AssertMsgReturn(u32Percent >= 2 && u32Percent <= 20000,
2430 ("%RX32 is not between 2 and 20000 (inclusive).\n", u32Percent),
2431 VERR_INVALID_PARAMETER);
2432
2433/** @todo This isn't a feature specific to virtual time, move the variables to
2434 * TM level and make it affect TMR3UCTNow as well! */
2435
2436 /*
2437 * If the time is running we'll have to pause it before we can change
2438 * the warp drive settings.
2439 */
2440 tmLock(pVM);
2441 bool fPaused = !!pVM->tm.s.cVirtualTicking;
2442 if (fPaused) /** @todo this isn't really working, but wtf. */
2443 TMR3NotifySuspend(pVM, pVCpu);
2444
2445 pVM->tm.s.u32VirtualWarpDrivePercentage = u32Percent;
2446 pVM->tm.s.fVirtualWarpDrive = u32Percent != 100;
2447 LogRel(("TM: u32VirtualWarpDrivePercentage=%RI32 fVirtualWarpDrive=%RTbool\n",
2448 pVM->tm.s.u32VirtualWarpDrivePercentage, pVM->tm.s.fVirtualWarpDrive));
2449
2450 if (fPaused)
2451 TMR3NotifyResume(pVM, pVCpu);
2452 tmUnlock(pVM);
2453 return VINF_SUCCESS;
2454}
2455
2456
2457/**
2458 * Display all timers.
2459 *
2460 * @param pVM VM Handle.
2461 * @param pHlp The info helpers.
2462 * @param pszArgs Arguments, ignored.
2463 */
2464static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
2465{
2466 NOREF(pszArgs);
2467 pHlp->pfnPrintf(pHlp,
2468 "Timers (pVM=%p)\n"
2469 "%.*s %.*s %.*s %.*s Clock %-18s %-18s %-25s Description\n",
2470 pVM,
2471 sizeof(RTR3PTR) * 2, "pTimerR3 ",
2472 sizeof(int32_t) * 2, "offNext ",
2473 sizeof(int32_t) * 2, "offPrev ",
2474 sizeof(int32_t) * 2, "offSched ",
2475 "Time",
2476 "Expire",
2477 "State");
2478 tmLock(pVM);
2479 for (PTMTIMERR3 pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
2480 {
2481 pHlp->pfnPrintf(pHlp,
2482 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %-25s %s\n",
2483 pTimer,
2484 pTimer->offNext,
2485 pTimer->offPrev,
2486 pTimer->offScheduleNext,
2487 pTimer->enmClock == TMCLOCK_REAL ? "Real " : "Virt ",
2488 TMTimerGet(pTimer),
2489 pTimer->u64Expire,
2490 tmTimerState(pTimer->enmState),
2491 pTimer->pszDesc);
2492 }
2493 tmUnlock(pVM);
2494}
2495
2496
2497/**
2498 * Display all active timers.
2499 *
2500 * @param pVM VM Handle.
2501 * @param pHlp The info helpers.
2502 * @param pszArgs Arguments, ignored.
2503 */
2504static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
2505{
2506 NOREF(pszArgs);
2507 pHlp->pfnPrintf(pHlp,
2508 "Active Timers (pVM=%p)\n"
2509 "%.*s %.*s %.*s %.*s Clock %-18s %-18s %-25s Description\n",
2510 pVM,
2511 sizeof(RTR3PTR) * 2, "pTimerR3 ",
2512 sizeof(int32_t) * 2, "offNext ",
2513 sizeof(int32_t) * 2, "offPrev ",
2514 sizeof(int32_t) * 2, "offSched ",
2515 "Time",
2516 "Expire",
2517 "State");
2518 for (unsigned iQueue = 0; iQueue < TMCLOCK_MAX; iQueue++)
2519 {
2520 tmLock(pVM);
2521 for (PTMTIMERR3 pTimer = TMTIMER_GET_HEAD(&pVM->tm.s.paTimerQueuesR3[iQueue]);
2522 pTimer;
2523 pTimer = TMTIMER_GET_NEXT(pTimer))
2524 {
2525 pHlp->pfnPrintf(pHlp,
2526 "%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %-25s %s\n",
2527 pTimer,
2528 pTimer->offNext,
2529 pTimer->offPrev,
2530 pTimer->offScheduleNext,
2531 pTimer->enmClock == TMCLOCK_REAL
2532 ? "Real "
2533 : pTimer->enmClock == TMCLOCK_VIRTUAL
2534 ? "Virt "
2535 : pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC
2536 ? "VrSy "
2537 : "TSC ",
2538 TMTimerGet(pTimer),
2539 pTimer->u64Expire,
2540 tmTimerState(pTimer->enmState),
2541 pTimer->pszDesc);
2542 }
2543 tmUnlock(pVM);
2544 }
2545}
2546
2547
2548/**
2549 * Display all clocks.
2550 *
2551 * @param pVM VM Handle.
2552 * @param pHlp The info helpers.
2553 * @param pszArgs Arguments, ignored.
2554 */
2555static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
2556{
2557 NOREF(pszArgs);
2558
2559 /*
2560 * Read the times first to avoid more than necessary time variation.
2561 */
2562 const uint64_t u64Virtual = TMVirtualGet(pVM);
2563 const uint64_t u64VirtualSync = TMVirtualSyncGet(pVM);
2564 const uint64_t u64Real = TMRealGet(pVM);
2565
2566 for (unsigned i = 0; i < pVM->cCPUs; i++)
2567 {
2568 PVMCPU pVCpu = &pVM->aCpus[i];
2569 uint64_t u64TSC = TMCpuTickGet(pVCpu);
2570
2571 /*
2572 * TSC
2573 */
2574 pHlp->pfnPrintf(pHlp,
2575 "Cpu Tick: %18RU64 (%#016RX64) %RU64Hz %s%s",
2576 u64TSC, u64TSC, TMCpuTicksPerSecond(pVM),
2577 pVCpu->tm.s.fTSCTicking ? "ticking" : "paused",
2578 pVM->tm.s.fTSCVirtualized ? " - virtualized" : "");
2579 if (pVM->tm.s.fTSCUseRealTSC)
2580 {
2581 pHlp->pfnPrintf(pHlp, " - real tsc");
2582 if (pVCpu->tm.s.u64TSCOffset)
2583 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVCpu->tm.s.u64TSCOffset);
2584 }
2585 else
2586 pHlp->pfnPrintf(pHlp, " - virtual clock");
2587 pHlp->pfnPrintf(pHlp, "\n");
2588 }
2589
2590 /*
2591 * virtual
2592 */
2593 pHlp->pfnPrintf(pHlp,
2594 " Virtual: %18RU64 (%#016RX64) %RU64Hz %s",
2595 u64Virtual, u64Virtual, TMVirtualGetFreq(pVM),
2596 pVM->tm.s.cVirtualTicking ? "ticking" : "paused");
2597 if (pVM->tm.s.fVirtualWarpDrive)
2598 pHlp->pfnPrintf(pHlp, " WarpDrive %RU32 %%", pVM->tm.s.u32VirtualWarpDrivePercentage);
2599 pHlp->pfnPrintf(pHlp, "\n");
2600
2601 /*
2602 * virtual sync
2603 */
2604 pHlp->pfnPrintf(pHlp,
2605 "VirtSync: %18RU64 (%#016RX64) %s%s",
2606 u64VirtualSync, u64VirtualSync,
2607 pVM->tm.s.fVirtualSyncTicking ? "ticking" : "paused",
2608 pVM->tm.s.fVirtualSyncCatchUp ? " - catchup" : "");
2609 if (pVM->tm.s.offVirtualSync)
2610 {
2611 pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVM->tm.s.offVirtualSync);
2612 if (pVM->tm.s.u32VirtualSyncCatchUpPercentage)
2613 pHlp->pfnPrintf(pHlp, " catch-up rate %u %%", pVM->tm.s.u32VirtualSyncCatchUpPercentage);
2614 }
2615 pHlp->pfnPrintf(pHlp, "\n");
2616
2617 /*
2618 * real
2619 */
2620 pHlp->pfnPrintf(pHlp,
2621 " Real: %18RU64 (%#016RX64) %RU64Hz\n",
2622 u64Real, u64Real, TMRealGetFreq(pVM));
2623}
2624
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