VirtualBox

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

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

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