TM.cpp@ 87766

最後變更在這個檔案從87766是 87766,由 vboxsync 提交於 4 年前
VMM/TM,VMM/*: Refactored the TM timer APIs to use 'handles' and take a pVM parameter. Only internal callbacks have been updated with a hTimer parameter, so far. bugref:9943
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Id Revision`
檔案大小: 174.3 KB

行
1	/* $Id: TM.cpp 87766 2021-02-16 14:27:43Z vboxsync $ */
2	/** @file
3	* TM - Time Manager.
4	*/
5
6	/*
7	* Copyright (C) 2006-2020 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.alldomusa.eu.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/** @page pg_tm TM - The Time Manager
19	*
20	* The Time Manager abstracts the CPU clocks and manages timers used by the VMM,
21	* device and drivers.
22	*
23	* @see grp_tm
24	*
25	*
26	* @section sec_tm_clocks Clocks
27	*
28	* There are currently 4 clocks:
29	* - Virtual (guest).
30	* - Synchronous virtual (guest).
31	* - CPU Tick (TSC) (guest). Only current use is rdtsc emulation. Usually a
32	* function of the virtual clock.
33	* - Real (host). This is only used for display updates atm.
34	*
35	* The most important clocks are the three first ones and of these the second is
36	* the most interesting.
37	*
38	*
39	* The synchronous virtual clock is tied to the virtual clock except that it
40	* will take into account timer delivery lag caused by host scheduling. It will
41	* normally never advance beyond the head timer, and when lagging too far behind
42	* it will gradually speed up to catch up with the virtual clock. All devices
43	* implementing time sources accessible to and used by the guest is using this
44	* clock (for timers and other things). This ensures consistency between the
45	* time sources.
46	*
47	* The virtual clock is implemented as an offset to a monotonic, high
48	* resolution, wall clock. The current time source is using the RTTimeNanoTS()
49	* machinery based upon the Global Info Pages (GIP), that is, we're using TSC
50	* deltas (usually 10 ms) to fill the gaps between GIP updates. The result is
51	* a fairly high res clock that works in all contexts and on all hosts. The
52	* virtual clock is paused when the VM isn't in the running state.
53	*
54	* The CPU tick (TSC) is normally virtualized as a function of the synchronous
55	* virtual clock, where the frequency defaults to the host cpu frequency (as we
56	* measure it). In this mode it is possible to configure the frequency. Another
57	* (non-default) option is to use the raw unmodified host TSC values. And yet
58	* another, to tie it to time spent executing guest code. All these things are
59	* configurable should non-default behavior be desirable.
60	*
61	* The real clock is a monotonic clock (when available) with relatively low
62	* resolution, though this a bit host specific. Note that we're currently not
63	* servicing timers using the real clock when the VM is not running, this is
64	* simply because it has not been needed yet therefore not implemented.
65	*
66	*
67	* @subsection subsec_tm_timesync Guest Time Sync / UTC time
68	*
69	* Guest time syncing is primarily taken care of by the VMM device. The
70	* principle is very simple, the guest additions periodically asks the VMM
71	* device what the current UTC time is and makes adjustments accordingly.
72	*
73	* A complicating factor is that the synchronous virtual clock might be doing
74	* catchups and the guest perception is currently a little bit behind the world
75	* but it will (hopefully) be catching up soon as we're feeding timer interrupts
76	* at a slightly higher rate. Adjusting the guest clock to the current wall
77	* time in the real world would be a bad idea then because the guest will be
78	* advancing too fast and run ahead of world time (if the catchup works out).
79	* To solve this problem TM provides the VMM device with an UTC time source that
80	* gets adjusted with the current lag, so that when the guest eventually catches
81	* up the lag it will be showing correct real world time.
82	*
83	*
84	* @section sec_tm_timers Timers
85	*
86	* The timers can use any of the TM clocks described in the previous section.
87	* Each clock has its own scheduling facility, or timer queue if you like.
88	* There are a few factors which makes it a bit complex. First, there is the
89	* usual R0 vs R3 vs. RC thing. Then there are multiple threads, and then there
90	* is the timer thread that periodically checks whether any timers has expired
91	* without EMT noticing. On the API level, all but the create and save APIs
92	* must be multithreaded. EMT will always run the timers.
93	*
94	* The design is using a doubly linked list of active timers which is ordered
95	* by expire date. This list is only modified by the EMT thread. Updates to
96	* the list are batched in a singly linked list, which is then processed by the
97	* EMT thread at the first opportunity (immediately, next time EMT modifies a
98	* timer on that clock, or next timer timeout). Both lists are offset based and
99	* all the elements are therefore allocated from the hyper heap.
100	*
101	* For figuring out when there is need to schedule and run timers TM will:
102	* - Poll whenever somebody queries the virtual clock.
103	* - Poll the virtual clocks from the EM and REM loops.
104	* - Poll the virtual clocks from trap exit path.
105	* - Poll the virtual clocks and calculate first timeout from the halt loop.
106	* - Employ a thread which periodically (100Hz) polls all the timer queues.
107	*
108	*
109	* @image html TMTIMER-Statechart-Diagram.gif
110	*
111	* @section sec_tm_timer Logging
112	*
113	* Level 2: Logs a most of the timer state transitions and queue servicing.
114	* Level 3: Logs a few oddments.
115	* Level 4: Logs TMCLOCK_VIRTUAL_SYNC catch-up events.
116	*
117	*/
118
119
120	/*********************************************************************************************************************************
121	* Header Files *
122	*********************************************************************************************************************************/
123	#define LOG_GROUP LOG_GROUP_TM
124	#ifdef DEBUG_bird
125	# define DBGFTRACE_DISABLED /* annoying */
126	#endif
127	#include <VBox/vmm/tm.h>
128	#include <iprt/asm-amd64-x86.h> /* for SUPGetCpuHzFromGip from sup.h */
129	#include <VBox/vmm/vmm.h>
130	#include <VBox/vmm/mm.h>
131	#include <VBox/vmm/hm.h>
132	#include <VBox/vmm/nem.h>
133	#include <VBox/vmm/gim.h>
134	#include <VBox/vmm/ssm.h>
135	#include <VBox/vmm/dbgf.h>
136	#include <VBox/vmm/dbgftrace.h>
137	#include <VBox/vmm/pdmapi.h>
138	#include <VBox/vmm/iom.h>
139	#include "TMInternal.h"
140	#include <VBox/vmm/vm.h>
141	#include <VBox/vmm/uvm.h>
142
143	#include <VBox/vmm/pdmdev.h>
144	#include <VBox/log.h>
145	#include <VBox/param.h>
146	#include <VBox/err.h>
147
148	#include <iprt/asm.h>
149	#include <iprt/asm-math.h>
150	#include <iprt/assert.h>
151	#include <iprt/env.h>
152	#include <iprt/file.h>
153	#include <iprt/getopt.h>
154	#include <iprt/semaphore.h>
155	#include <iprt/string.h>
156	#include <iprt/thread.h>
157	#include <iprt/time.h>
158	#include <iprt/timer.h>
159
160	#include "TMInline.h"
161
162
163	/*********************************************************************************************************************************
164	* Defined Constants And Macros *
165	*********************************************************************************************************************************/
166	/** The current saved state version.*/
167	#define TM_SAVED_STATE_VERSION 3
168
169
170	/*********************************************************************************************************************************
171	* Internal Functions *
172	*********************************************************************************************************************************/
173	static bool tmR3HasFixedTSC(PVM pVM);
174	static uint64_t tmR3CalibrateTSC(void);
175	static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM);
176	static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
177	static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
178	static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue);
179	static void tmR3TimerQueueRunVirtualSync(PVM pVM);
180	static DECLCALLBACK(int) tmR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent);
181	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
182	static DECLCALLBACK(void) tmR3CpuLoadTimer(PVM pVM, TMTIMERHANDLE hTimer, void *pvUser);
183	#endif
184	static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
185	static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
186	static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
187	static DECLCALLBACK(void) tmR3InfoCpuLoad(PVM pVM, PCDBGFINFOHLP pHlp, int cArgs, char **papszArgs);
188	static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtDisable(PVM pVM, PVMCPU pVCpu, void *pvData);
189	static const char * tmR3GetTSCModeName(PVM pVM);
190	static const char * tmR3GetTSCModeNameEx(TMTSCMODE enmMode);
191
192
193	/**
194	* Initializes the TM.
195	*
196	* @returns VBox status code.
197	* @param pVM The cross context VM structure.
198	*/
199	VMM_INT_DECL(int) TMR3Init(PVM pVM)
200	{
201	LogFlow(("TMR3Init:\n"));
202
203	/*
204	* Assert alignment and sizes.
205	*/
206	AssertCompileMemberAlignment(VM, tm.s, 32);
207	AssertCompile(sizeof(pVM->tm.s) <= sizeof(pVM->tm.padding));
208	AssertCompileMemberAlignment(TM, TimerCritSect, 8);
209	AssertCompileMemberAlignment(TM, VirtualSyncLock, 8);
210
211	/*
212	* Init the structure.
213	*/
214	void *pv;
215	int rc = MMHyperAlloc(pVM, sizeof(pVM->tm.s.paTimerQueuesR3[0]) * TMCLOCK_MAX, 0, MM_TAG_TM, &pv);
216	AssertRCReturn(rc, rc);
217	pVM->tm.s.paTimerQueuesR3 = (PTMTIMERQUEUE)pv;
218	pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pv);
219	pVM->tm.s.paTimerQueuesRC = MMHyperR3ToRC(pVM, pv);
220
221	pVM->tm.s.offVM = RT_UOFFSETOF(VM, tm.s);
222	pVM->tm.s.idTimerCpu = pVM->cCpus - 1; /* The last CPU. */
223	pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].enmClock = TMCLOCK_VIRTUAL;
224	pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].u64Expire = INT64_MAX;
225	pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].enmClock = TMCLOCK_VIRTUAL_SYNC;
226	pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].u64Expire = INT64_MAX;
227	pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].enmClock = TMCLOCK_REAL;
228	pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].u64Expire = INT64_MAX;
229	pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].enmClock = TMCLOCK_TSC;
230	pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].u64Expire = INT64_MAX;
231
232	/*
233	* We directly use the GIP to calculate the virtual time. We map the
234	* the GIP into the guest context so we can do this calculation there
235	* as well and save costly world switches.
236	*/
237	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
238	pVM->tm.s.pvGIPR3 = (void *)pGip;
239	AssertMsgReturn(pVM->tm.s.pvGIPR3, ("GIP support is now required!\n"), VERR_TM_GIP_REQUIRED);
240	AssertMsgReturn((pGip->u32Version >> 16) == (SUPGLOBALINFOPAGE_VERSION >> 16),
241	("Unsupported GIP version %#x! (expected=%#x)\n", pGip->u32Version, SUPGLOBALINFOPAGE_VERSION),
242	VERR_TM_GIP_VERSION);
243
244	RTHCPHYS HCPhysGIP;
245	rc = SUPR3GipGetPhys(&HCPhysGIP);
246	AssertMsgRCReturn(rc, ("Failed to get GIP physical address!\n"), rc);
247
248	#ifndef PGM_WITHOUT_MAPPINGS
249	RTGCPTR GCPtr;
250	# ifdef SUP_WITH_LOTS_OF_CPUS
251	rc = MMR3HyperMapHCPhys(pVM, pVM->tm.s.pvGIPR3, NIL_RTR0PTR, HCPhysGIP, (size_t)pGip->cPages * PAGE_SIZE,
252	"GIP", &GCPtr);
253	# else
254	rc = MMR3HyperMapHCPhys(pVM, pVM->tm.s.pvGIPR3, NIL_RTR0PTR, HCPhysGIP, PAGE_SIZE, "GIP", &GCPtr);
255	# endif
256	if (RT_FAILURE(rc))
257	{
258	AssertMsgFailed(("Failed to map GIP into GC, rc=%Rrc!\n", rc));
259	return rc;
260	}
261	pVM->tm.s.pvGIPRC = GCPtr;
262	LogFlow(("TMR3Init: HCPhysGIP=%RHp at %RRv\n", HCPhysGIP, pVM->tm.s.pvGIPRC));
263	MMR3HyperReserveFence(pVM);
264	#endif
265
266
267	/* Check assumptions made in TMAllVirtual.cpp about the GIP update interval. */
268	if ( pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC
269	&& pGip->u32UpdateIntervalNS >= 250000000 /* 0.25s */)
270	return VMSetError(pVM, VERR_TM_GIP_UPDATE_INTERVAL_TOO_BIG, RT_SRC_POS,
271	N_("The GIP update interval is too big. u32UpdateIntervalNS=%RU32 (u32UpdateHz=%RU32)"),
272	pGip->u32UpdateIntervalNS, pGip->u32UpdateHz);
273
274	/* Log GIP info that may come in handy. */
275	LogRel(("TM: GIP - u32Mode=%d (%s) u32UpdateHz=%u u32UpdateIntervalNS=%u enmUseTscDelta=%d (%s) fGetGipCpu=%#x cCpus=%d\n",
276	pGip->u32Mode, SUPGetGIPModeName(pGip), pGip->u32UpdateHz, pGip->u32UpdateIntervalNS,
277	pGip->enmUseTscDelta, SUPGetGIPTscDeltaModeName(pGip), pGip->fGetGipCpu, pGip->cCpus));
278	LogRel(("TM: GIP - u64CpuHz=%'RU64 (%#RX64) SUPGetCpuHzFromGip => %'RU64\n",
279	pGip->u64CpuHz, pGip->u64CpuHz, SUPGetCpuHzFromGip(pGip)));
280	for (uint32_t iCpuSet = 0; iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx); iCpuSet++)
281	{
282	uint16_t iGipCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
283	if (iGipCpu != UINT16_MAX)
284	LogRel(("TM: GIP - CPU: iCpuSet=%#x idCpu=%#x idApic=%#x iGipCpu=%#x i64TSCDelta=%RI64 enmState=%d u64CpuHz=%RU64(*) cErrors=%u\n",
285	iCpuSet, pGip->aCPUs[iGipCpu].idCpu, pGip->aCPUs[iGipCpu].idApic, iGipCpu, pGip->aCPUs[iGipCpu].i64TSCDelta,
286	pGip->aCPUs[iGipCpu].enmState, pGip->aCPUs[iGipCpu].u64CpuHz, pGip->aCPUs[iGipCpu].cErrors));
287	}
288
289	/*
290	* Setup the VirtualGetRaw backend.
291	*/
292	pVM->tm.s.pfnVirtualGetRawR3 = tmVirtualNanoTSRediscover;
293	pVM->tm.s.VirtualGetRawDataR3.pfnRediscover = tmVirtualNanoTSRediscover;
294	pVM->tm.s.VirtualGetRawDataR3.pfnBad = tmVirtualNanoTSBad;
295	pVM->tm.s.VirtualGetRawDataR3.pfnBadCpuIndex = tmVirtualNanoTSBadCpuIndex;
296	pVM->tm.s.VirtualGetRawDataR3.pu64Prev = &pVM->tm.s.u64VirtualRawPrev;
297	pVM->tm.s.VirtualGetRawDataRC.pu64Prev = MMHyperR3ToRC(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
298	pVM->tm.s.VirtualGetRawDataR0.pu64Prev = MMHyperR3ToR0(pVM, (void *)&pVM->tm.s.u64VirtualRawPrev);
299	AssertRelease(pVM->tm.s.VirtualGetRawDataR0.pu64Prev);
300	/* The rest is done in TMR3InitFinalize() since it's too early to call PDM. */
301
302	/*
303	* Init the locks.
304	*/
305	rc = PDMR3CritSectInit(pVM, &pVM->tm.s.TimerCritSect, RT_SRC_POS, "TM Timer Lock");
306	if (RT_FAILURE(rc))
307	return rc;
308	rc = PDMR3CritSectInit(pVM, &pVM->tm.s.VirtualSyncLock, RT_SRC_POS, "TM VirtualSync Lock");
309	if (RT_FAILURE(rc))
310	return rc;
311
312	/*
313	* Get our CFGM node, create it if necessary.
314	*/
315	PCFGMNODE pCfgHandle = CFGMR3GetChild(CFGMR3GetRoot(pVM), "TM");
316	if (!pCfgHandle)
317	{
318	rc = CFGMR3InsertNode(CFGMR3GetRoot(pVM), "TM", &pCfgHandle);
319	AssertRCReturn(rc, rc);
320	}
321
322	/*
323	* Specific errors about some obsolete TM settings (remove after 2015-12-03).
324	*/
325	if (CFGMR3Exists(pCfgHandle, "TSCVirtualized"))
326	return VMSetError(pVM, VERR_CFGM_CONFIG_UNKNOWN_VALUE, RT_SRC_POS,
327	N_("Configuration error: TM setting \"TSCVirtualized\" is no longer supported. Use the \"TSCMode\" setting instead."));
328	if (CFGMR3Exists(pCfgHandle, "UseRealTSC"))
329	return VMSetError(pVM, VERR_CFGM_CONFIG_UNKNOWN_VALUE, RT_SRC_POS,
330	N_("Configuration error: TM setting \"UseRealTSC\" is no longer supported. Use the \"TSCMode\" setting instead."));
331
332	if (CFGMR3Exists(pCfgHandle, "MaybeUseOffsettedHostTSC"))
333	return VMSetError(pVM, VERR_CFGM_CONFIG_UNKNOWN_VALUE, RT_SRC_POS,
334	N_("Configuration error: TM setting \"MaybeUseOffsettedHostTSC\" is no longer supported. Use the \"TSCMode\" setting instead."));
335
336	/*
337	* Validate the rest of the TM settings.
338	*/
339	rc = CFGMR3ValidateConfig(pCfgHandle, "/TM/",
340	"TSCMode\|"
341	"TSCModeSwitchAllowed\|"
342	"TSCTicksPerSecond\|"
343	"TSCTiedToExecution\|"
344	"TSCNotTiedToHalt\|"
345	"ScheduleSlack\|"
346	"CatchUpStopThreshold\|"
347	"CatchUpGiveUpThreshold\|"
348	"CatchUpStartThreshold0\|CatchUpStartThreshold1\|CatchUpStartThreshold2\|CatchUpStartThreshold3\|"
349	"CatchUpStartThreshold4\|CatchUpStartThreshold5\|CatchUpStartThreshold6\|CatchUpStartThreshold7\|"
350	"CatchUpStartThreshold8\|CatchUpStartThreshold9\|"
351	"CatchUpPrecentage0\|CatchUpPrecentage1\|CatchUpPrecentage2\|CatchUpPrecentage3\|"
352	"CatchUpPrecentage4\|CatchUpPrecentage5\|CatchUpPrecentage6\|CatchUpPrecentage7\|"
353	"CatchUpPrecentage8\|CatchUpPrecentage9\|"
354	"UTCOffset\|"
355	"UTCTouchFileOnJump\|"
356	"WarpDrivePercentage\|"
357	"HostHzMax\|"
358	"HostHzFudgeFactorTimerCpu\|"
359	"HostHzFudgeFactorOtherCpu\|"
360	"HostHzFudgeFactorCatchUp100\|"
361	"HostHzFudgeFactorCatchUp200\|"
362	"HostHzFudgeFactorCatchUp400\|"
363	"TimerMillies"
364	,
365	"",
366	"TM", 0);
367	if (RT_FAILURE(rc))
368	return rc;
369
370	/*
371	* Determine the TSC configuration and frequency.
372	*/
373	/** @cfgm{/TM/TSCMode, string, Depends on the CPU and VM config}
374	* The name of the TSC mode to use: VirtTSCEmulated, RealTSCOffset or Dynamic.
375	* The default depends on the VM configuration and the capabilities of the
376	* host CPU. Other config options or runtime changes may override the TSC
377	* mode specified here.
378	*/
379	char szTSCMode[32];
380	rc = CFGMR3QueryString(pCfgHandle, "TSCMode", szTSCMode, sizeof(szTSCMode));
381	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
382	{
383	/** @todo Rainy-day/never: Dynamic mode isn't currently suitable for SMP VMs, so
384	* fall back on the more expensive emulated mode. With the current TSC handling
385	* (frequent switching between offsetted mode and taking VM exits, on all VCPUs
386	* without any kind of coordination) will lead to inconsistent TSC behavior with
387	* guest SMP, including TSC going backwards. */
388	pVM->tm.s.enmTSCMode = NEMR3NeedSpecialTscMode(pVM) ? TMTSCMODE_NATIVE_API
389	: pVM->cCpus == 1 && tmR3HasFixedTSC(pVM) ? TMTSCMODE_DYNAMIC : TMTSCMODE_VIRT_TSC_EMULATED;
390	}
391	else if (RT_FAILURE(rc))
392	return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying string value \"TSCMode\""));
393	else
394	{
395	if (!RTStrCmp(szTSCMode, "VirtTSCEmulated"))
396	pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
397	else if (!RTStrCmp(szTSCMode, "RealTSCOffset"))
398	pVM->tm.s.enmTSCMode = TMTSCMODE_REAL_TSC_OFFSET;
399	else if (!RTStrCmp(szTSCMode, "Dynamic"))
400	pVM->tm.s.enmTSCMode = TMTSCMODE_DYNAMIC;
401	else
402	return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Unrecognized TM TSC mode value \"%s\""), szTSCMode);
403	if (NEMR3NeedSpecialTscMode(pVM))
404	{
405	LogRel(("TM: NEM overrides the /TM/TSCMode=%s settings.\n", szTSCMode));
406	pVM->tm.s.enmTSCMode = TMTSCMODE_NATIVE_API;
407	}
408	}
409
410	/**
411	* @cfgm{/TM/TSCModeSwitchAllowed, bool, Whether TM TSC mode switch is allowed
412	* at runtime}
413	* When using paravirtualized guests, we dynamically switch TSC modes to a more
414	* optimal one for performance. This setting allows overriding this behaviour.
415	*/
416	rc = CFGMR3QueryBool(pCfgHandle, "TSCModeSwitchAllowed", &pVM->tm.s.fTSCModeSwitchAllowed);
417	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
418	{
419	/* This is finally determined in TMR3InitFinalize() as GIM isn't initialized yet. */
420	pVM->tm.s.fTSCModeSwitchAllowed = true;
421	}
422	else if (RT_FAILURE(rc))
423	return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying bool value \"TSCModeSwitchAllowed\""));
424	if (pVM->tm.s.fTSCModeSwitchAllowed && pVM->tm.s.enmTSCMode == TMTSCMODE_NATIVE_API)
425	{
426	LogRel(("TM: NEM overrides the /TM/TSCModeSwitchAllowed setting.\n"));
427	pVM->tm.s.fTSCModeSwitchAllowed = false;
428	}
429
430	/** @cfgm{/TM/TSCTicksPerSecond, uint32_t, Current TSC frequency from GIP}
431	* The number of TSC ticks per second (i.e. the TSC frequency). This will
432	* override enmTSCMode.
433	*/
434	rc = CFGMR3QueryU64(pCfgHandle, "TSCTicksPerSecond", &pVM->tm.s.cTSCTicksPerSecond);
435	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
436	{
437	pVM->tm.s.cTSCTicksPerSecond = tmR3CalibrateTSC();
438	if ( ( pVM->tm.s.enmTSCMode == TMTSCMODE_DYNAMIC
439	\|\| pVM->tm.s.enmTSCMode == TMTSCMODE_VIRT_TSC_EMULATED)
440	&& pVM->tm.s.cTSCTicksPerSecond >= _4G)
441	{
442	pVM->tm.s.cTSCTicksPerSecond = _4G - 1; /* (A limitation of our math code) */
443	pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
444	}
445	}
446	else if (RT_FAILURE(rc))
447	return VMSetError(pVM, rc, RT_SRC_POS,
448	N_("Configuration error: Failed to querying uint64_t value \"TSCTicksPerSecond\""));
449	else if ( pVM->tm.s.cTSCTicksPerSecond < _1M
450	\|\| pVM->tm.s.cTSCTicksPerSecond >= _4G)
451	return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
452	N_("Configuration error: \"TSCTicksPerSecond\" = %RI64 is not in the range 1MHz..4GHz-1"),
453	pVM->tm.s.cTSCTicksPerSecond);
454	else if (pVM->tm.s.enmTSCMode != TMTSCMODE_NATIVE_API)
455	pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
456	else
457	{
458	LogRel(("TM: NEM overrides the /TM/TSCTicksPerSecond=%RU64 setting.\n", pVM->tm.s.cTSCTicksPerSecond));
459	pVM->tm.s.cTSCTicksPerSecond = tmR3CalibrateTSC();
460	}
461
462	/** @cfgm{/TM/TSCTiedToExecution, bool, false}
463	* Whether the TSC should be tied to execution. This will exclude most of the
464	* virtualization overhead, but will by default include the time spent in the
465	* halt state (see TM/TSCNotTiedToHalt). This setting will override all other
466	* TSC settings except for TSCTicksPerSecond and TSCNotTiedToHalt, which should
467	* be used avoided or used with great care. Note that this will only work right
468	* together with VT-x or AMD-V, and with a single virtual CPU. */
469	rc = CFGMR3QueryBoolDef(pCfgHandle, "TSCTiedToExecution", &pVM->tm.s.fTSCTiedToExecution, false);
470	if (RT_FAILURE(rc))
471	return VMSetError(pVM, rc, RT_SRC_POS,
472	N_("Configuration error: Failed to querying bool value \"TSCTiedToExecution\""));
473	if (pVM->tm.s.fTSCTiedToExecution && pVM->tm.s.enmTSCMode == TMTSCMODE_NATIVE_API)
474	return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("/TM/TSCTiedToExecution is not supported in NEM mode!"));
475	if (pVM->tm.s.fTSCTiedToExecution)
476	pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
477
478
479	/** @cfgm{/TM/TSCNotTiedToHalt, bool, false}
480	* This is used with /TM/TSCTiedToExecution to control how TSC operates
481	* accross HLT instructions. When true HLT is considered execution time and
482	* TSC continues to run, while when false (default) TSC stops during halt. */
483	rc = CFGMR3QueryBoolDef(pCfgHandle, "TSCNotTiedToHalt", &pVM->tm.s.fTSCNotTiedToHalt, false);
484	if (RT_FAILURE(rc))
485	return VMSetError(pVM, rc, RT_SRC_POS,
486	N_("Configuration error: Failed to querying bool value \"TSCNotTiedToHalt\""));
487
488	/*
489	* Configure the timer synchronous virtual time.
490	*/
491	/** @cfgm{/TM/ScheduleSlack, uint32_t, ns, 0, UINT32_MAX, 100000}
492	* Scheduling slack when processing timers. */
493	rc = CFGMR3QueryU32(pCfgHandle, "ScheduleSlack", &pVM->tm.s.u32VirtualSyncScheduleSlack);
494	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
495	pVM->tm.s.u32VirtualSyncScheduleSlack = 100000; /* 0.100ms (ASSUMES virtual time is nanoseconds) */
496	else if (RT_FAILURE(rc))
497	return VMSetError(pVM, rc, RT_SRC_POS,
498	N_("Configuration error: Failed to querying 32-bit integer value \"ScheduleSlack\""));
499
500	/** @cfgm{/TM/CatchUpStopThreshold, uint64_t, ns, 0, UINT64_MAX, 500000}
501	* When to stop a catch-up, considering it successful. */
502	rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStopThreshold", &pVM->tm.s.u64VirtualSyncCatchUpStopThreshold);
503	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
504	pVM->tm.s.u64VirtualSyncCatchUpStopThreshold = 500000; /* 0.5ms */
505	else if (RT_FAILURE(rc))
506	return VMSetError(pVM, rc, RT_SRC_POS,
507	N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpStopThreshold\""));
508
509	/** @cfgm{/TM/CatchUpGiveUpThreshold, uint64_t, ns, 0, UINT64_MAX, 60000000000}
510	* When to give up a catch-up attempt. */
511	rc = CFGMR3QueryU64(pCfgHandle, "CatchUpGiveUpThreshold", &pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold);
512	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
513	pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold = UINT64_C(60000000000); /* 60 sec */
514	else if (RT_FAILURE(rc))
515	return VMSetError(pVM, rc, RT_SRC_POS,
516	N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpGiveUpThreshold\""));
517
518
519	/** @cfgm{/TM/CatchUpPrecentage[0..9], uint32_t, %, 1, 2000, various}
520	* The catch-up percent for a given period. */
521	/** @cfgm{/TM/CatchUpStartThreshold[0..9], uint64_t, ns, 0, UINT64_MAX}
522	* The catch-up period threshold, or if you like, when a period starts. */
523	#define TM_CFG_PERIOD(iPeriod, DefStart, DefPct) \
524	do \
525	{ \
526	uint64_t u64; \
527	rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStartThreshold" #iPeriod, &u64); \
528	if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
529	u64 = UINT64_C(DefStart); \
530	else if (RT_FAILURE(rc)) \
531	return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpThreshold" #iPeriod "\"")); \
532	if ( (iPeriod > 0 && u64 <= pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod - 1].u64Start) \
533	\|\| u64 >= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold) \
534	return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("Configuration error: Invalid start of period #" #iPeriod ": %'RU64"), u64); \
535	pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u64Start = u64; \
536	rc = CFGMR3QueryU32(pCfgHandle, "CatchUpPrecentage" #iPeriod, &pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage); \
537	if (rc == VERR_CFGM_VALUE_NOT_FOUND) \
538	pVM->tm.s.aVirtualSyncCatchUpPeriods[iPeriod].u32Percentage = (DefPct); \
539	else if (RT_FAILURE(rc)) \
540	return VMSetError(pVM, rc, RT_SRC_POS, N_("Configuration error: Failed to querying 32-bit integer value \"CatchUpPrecentage" #iPeriod "\"")); \
541	} while (0)
542	/* This needs more tuning. Not sure if we really need so many period and be so gentle. */
543	TM_CFG_PERIOD(0, 750000, 5); /* 0.75ms at 1.05x */
544	TM_CFG_PERIOD(1, 1500000, 10); /* 1.50ms at 1.10x */
545	TM_CFG_PERIOD(2, 8000000, 25); /* 8ms at 1.25x */
546	TM_CFG_PERIOD(3, 30000000, 50); /* 30ms at 1.50x */
547	TM_CFG_PERIOD(4, 75000000, 75); /* 75ms at 1.75x */
548	TM_CFG_PERIOD(5, 175000000, 100); /* 175ms at 2x */
549	TM_CFG_PERIOD(6, 500000000, 200); /* 500ms at 3x */
550	TM_CFG_PERIOD(7, 3000000000, 300); /* 3s at 4x */
551	TM_CFG_PERIOD(8,30000000000, 400); /* 30s at 5x */
552	TM_CFG_PERIOD(9,55000000000, 500); /* 55s at 6x */
553	AssertCompile(RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods) == 10);
554	#undef TM_CFG_PERIOD
555
556	/*
557	* Configure real world time (UTC).
558	*/
559	/** @cfgm{/TM/UTCOffset, int64_t, ns, INT64_MIN, INT64_MAX, 0}
560	* The UTC offset. This is used to put the guest back or forwards in time. */
561	rc = CFGMR3QueryS64(pCfgHandle, "UTCOffset", &pVM->tm.s.offUTC);
562	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
563	pVM->tm.s.offUTC = 0; /* ns */
564	else if (RT_FAILURE(rc))
565	return VMSetError(pVM, rc, RT_SRC_POS,
566	N_("Configuration error: Failed to querying 64-bit integer value \"UTCOffset\""));
567
568	/** @cfgm{/TM/UTCTouchFileOnJump, string, none}
569	* File to be written to everytime the host time jumps. */
570	rc = CFGMR3QueryStringAlloc(pCfgHandle, "UTCTouchFileOnJump", &pVM->tm.s.pszUtcTouchFileOnJump);
571	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
572	pVM->tm.s.pszUtcTouchFileOnJump = NULL;
573	else if (RT_FAILURE(rc))
574	return VMSetError(pVM, rc, RT_SRC_POS,
575	N_("Configuration error: Failed to querying string value \"UTCTouchFileOnJump\""));
576
577	/*
578	* Setup the warp drive.
579	*/
580	/** @cfgm{/TM/WarpDrivePercentage, uint32_t, %, 0, 20000, 100}
581	* The warp drive percentage, 100% is normal speed. This is used to speed up
582	* or slow down the virtual clock, which can be useful for fast forwarding
583	* borring periods during tests. */
584	rc = CFGMR3QueryU32(pCfgHandle, "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage);
585	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
586	rc = CFGMR3QueryU32(CFGMR3GetRoot(pVM), "WarpDrivePercentage", &pVM->tm.s.u32VirtualWarpDrivePercentage); /* legacy */
587	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
588	pVM->tm.s.u32VirtualWarpDrivePercentage = 100;
589	else if (RT_FAILURE(rc))
590	return VMSetError(pVM, rc, RT_SRC_POS,
591	N_("Configuration error: Failed to querying uint32_t value \"WarpDrivePercent\""));
592	else if ( pVM->tm.s.u32VirtualWarpDrivePercentage < 2
593	\|\| pVM->tm.s.u32VirtualWarpDrivePercentage > 20000)
594	return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
595	N_("Configuration error: \"WarpDrivePercent\" = %RI32 is not in the range 2..20000"),
596	pVM->tm.s.u32VirtualWarpDrivePercentage);
597	pVM->tm.s.fVirtualWarpDrive = pVM->tm.s.u32VirtualWarpDrivePercentage != 100;
598	if (pVM->tm.s.fVirtualWarpDrive)
599	{
600	if (pVM->tm.s.enmTSCMode == TMTSCMODE_NATIVE_API)
601	LogRel(("TM: Warp-drive active, escept for TSC which is in NEM mode. u32VirtualWarpDrivePercentage=%RI32\n",
602	pVM->tm.s.u32VirtualWarpDrivePercentage));
603	else
604	{
605	pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
606	LogRel(("TM: Warp-drive active. u32VirtualWarpDrivePercentage=%RI32\n", pVM->tm.s.u32VirtualWarpDrivePercentage));
607	}
608	}
609
610	/*
611	* Gather the Host Hz configuration values.
612	*/
613	rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzMax", &pVM->tm.s.cHostHzMax, 20000);
614	if (RT_FAILURE(rc))
615	return VMSetError(pVM, rc, RT_SRC_POS,
616	N_("Configuration error: Failed to querying uint32_t value \"HostHzMax\""));
617
618	rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorTimerCpu", &pVM->tm.s.cPctHostHzFudgeFactorTimerCpu, 111);
619	if (RT_FAILURE(rc))
620	return VMSetError(pVM, rc, RT_SRC_POS,
621	N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorTimerCpu\""));
622
623	rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorOtherCpu", &pVM->tm.s.cPctHostHzFudgeFactorOtherCpu, 110);
624	if (RT_FAILURE(rc))
625	return VMSetError(pVM, rc, RT_SRC_POS,
626	N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorOtherCpu\""));
627
628	rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorCatchUp100", &pVM->tm.s.cPctHostHzFudgeFactorCatchUp100, 300);
629	if (RT_FAILURE(rc))
630	return VMSetError(pVM, rc, RT_SRC_POS,
631	N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorCatchUp100\""));
632
633	rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorCatchUp200", &pVM->tm.s.cPctHostHzFudgeFactorCatchUp200, 250);
634	if (RT_FAILURE(rc))
635	return VMSetError(pVM, rc, RT_SRC_POS,
636	N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorCatchUp200\""));
637
638	rc = CFGMR3QueryU32Def(pCfgHandle, "HostHzFudgeFactorCatchUp400", &pVM->tm.s.cPctHostHzFudgeFactorCatchUp400, 200);
639	if (RT_FAILURE(rc))
640	return VMSetError(pVM, rc, RT_SRC_POS,
641	N_("Configuration error: Failed to querying uint32_t value \"HostHzFudgeFactorCatchUp400\""));
642
643	/*
644	* Finally, setup and report.
645	*/
646	pVM->tm.s.enmOriginalTSCMode = pVM->tm.s.enmTSCMode;
647	CPUMR3SetCR4Feature(pVM, X86_CR4_TSD, ~X86_CR4_TSD);
648	LogRel(("TM: cTSCTicksPerSecond=%'RU64 (%#RX64) enmTSCMode=%d (%s)\n"
649	"TM: TSCTiedToExecution=%RTbool TSCNotTiedToHalt=%RTbool\n",
650	pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM),
651	pVM->tm.s.fTSCTiedToExecution, pVM->tm.s.fTSCNotTiedToHalt));
652
653	/*
654	* Start the timer (guard against REM not yielding).
655	*/
656	/** @cfgm{/TM/TimerMillies, uint32_t, ms, 1, 1000, 10}
657	* The watchdog timer interval. */
658	uint32_t u32Millies;
659	rc = CFGMR3QueryU32(pCfgHandle, "TimerMillies", &u32Millies);
660	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
661	u32Millies = VM_IS_HM_ENABLED(pVM) ? 1000 : 10;
662	else if (RT_FAILURE(rc))
663	return VMSetError(pVM, rc, RT_SRC_POS,
664	N_("Configuration error: Failed to query uint32_t value \"TimerMillies\""));
665	rc = RTTimerCreate(&pVM->tm.s.pTimer, u32Millies, tmR3TimerCallback, pVM);
666	if (RT_FAILURE(rc))
667	{
668	AssertMsgFailed(("Failed to create timer, u32Millies=%d rc=%Rrc.\n", u32Millies, rc));
669	return rc;
670	}
671	Log(("TM: Created timer %p firing every %d milliseconds\n", pVM->tm.s.pTimer, u32Millies));
672	pVM->tm.s.u32TimerMillies = u32Millies;
673
674	/*
675	* Register saved state.
676	*/
677	rc = SSMR3RegisterInternal(pVM, "tm", 1, TM_SAVED_STATE_VERSION, sizeof(uint64_t) * 8,
678	NULL, NULL, NULL,
679	NULL, tmR3Save, NULL,
680	NULL, tmR3Load, NULL);
681	if (RT_FAILURE(rc))
682	return rc;
683
684	/*
685	* Register statistics.
686	*/
687	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).");
688	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).");
689	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).");
690	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).");
691	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).");
692	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).");
693	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)");
694	STAM_REL_REG_USED(pVM,(void*)&pVM->tm.s.offVirtualSyncGivenUp, STAMTYPE_U64, "/TM/VirtualSync/GivenUp", STAMUNIT_NS, "Nanoseconds of the 'CurrentOffset' that's been given up and won't ever be attempted caught up with.");
695	STAM_REL_REG( pVM,(void*)&pVM->tm.s.uMaxHzHint, STAMTYPE_U32, "/TM/MaxHzHint", STAMUNIT_HZ, "Max guest timer frequency hint.");
696
697	#ifdef VBOX_WITH_STATISTICS
698	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).");
699	STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataR3.cUpdateRaces,STAMTYPE_U32, "/TM/R3/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
700	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).");
701	STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataR0.cUpdateRaces,STAMTYPE_U32, "/TM/R0/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
702	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).");
703	STAM_REG_USED(pVM,(void *)&pVM->tm.s.VirtualGetRawDataRC.cUpdateRaces,STAMTYPE_U32, "/TM/RC/cUpdateRaces", STAMUNIT_OCCURENCES, "Thread races when updating the previous timestamp.");
704	STAM_REG(pVM, &pVM->tm.s.StatDoQueues, STAMTYPE_PROFILE, "/TM/DoQueues", STAMUNIT_TICKS_PER_CALL, "Profiling timer TMR3TimerQueuesDo.");
705	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.");
706	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.");
707	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.");
708
709	STAM_REG(pVM, &pVM->tm.s.StatPoll, STAMTYPE_COUNTER, "/TM/Poll", STAMUNIT_OCCURENCES, "TMTimerPoll calls.");
710	STAM_REG(pVM, &pVM->tm.s.StatPollAlreadySet, STAMTYPE_COUNTER, "/TM/Poll/AlreadySet", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the FF was already set.");
711	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.");
712	STAM_REG(pVM, &pVM->tm.s.StatPollMiss, STAMTYPE_COUNTER, "/TM/Poll/Miss", STAMUNIT_OCCURENCES, "TMTimerPoll calls where nothing had expired.");
713	STAM_REG(pVM, &pVM->tm.s.StatPollRunning, STAMTYPE_COUNTER, "/TM/Poll/Running", STAMUNIT_OCCURENCES, "TMTimerPoll calls where the queues were being run.");
714	STAM_REG(pVM, &pVM->tm.s.StatPollSimple, STAMTYPE_COUNTER, "/TM/Poll/Simple", STAMUNIT_OCCURENCES, "TMTimerPoll calls where we could take the simple path.");
715	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.");
716	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.");
717
718	STAM_REG(pVM, &pVM->tm.s.StatPostponedR3, STAMTYPE_COUNTER, "/TM/PostponedR3", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-3.");
719	STAM_REG(pVM, &pVM->tm.s.StatPostponedRZ, STAMTYPE_COUNTER, "/TM/PostponedRZ", STAMUNIT_OCCURENCES, "Postponed due to unschedulable state, in ring-0 / RC.");
720
721	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.");
722	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.");
723	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.");
724
725	STAM_REG(pVM, &pVM->tm.s.StatTimerSet, STAMTYPE_COUNTER, "/TM/TimerSet", STAMUNIT_OCCURENCES, "Calls, except virtual sync timers");
726	STAM_REG(pVM, &pVM->tm.s.StatTimerSetOpt, STAMTYPE_COUNTER, "/TM/TimerSet/Opt", STAMUNIT_OCCURENCES, "Optimized path taken.");
727	STAM_REG(pVM, &pVM->tm.s.StatTimerSetR3, STAMTYPE_PROFILE, "/TM/TimerSet/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3.");
728	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRZ, STAMTYPE_PROFILE, "/TM/TimerSet/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0 / RC.");
729	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStActive, STAMTYPE_COUNTER, "/TM/TimerSet/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
730	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSet/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
731	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStOther, STAMTYPE_COUNTER, "/TM/TimerSet/StOther", STAMUNIT_OCCURENCES, "Other states");
732	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendStop, STAMTYPE_COUNTER, "/TM/TimerSet/StPendStop", STAMUNIT_OCCURENCES, "PENDING_STOP");
733	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendStopSched, STAMTYPE_COUNTER, "/TM/TimerSet/StPendStopSched", STAMUNIT_OCCURENCES, "PENDING_STOP_SCHEDULE");
734	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendSched, STAMTYPE_COUNTER, "/TM/TimerSet/StPendSched", STAMUNIT_OCCURENCES, "PENDING_SCHEDULE");
735	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStPendResched, STAMTYPE_COUNTER, "/TM/TimerSet/StPendResched", STAMUNIT_OCCURENCES, "PENDING_RESCHEDULE");
736	STAM_REG(pVM, &pVM->tm.s.StatTimerSetStStopped, STAMTYPE_COUNTER, "/TM/TimerSet/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
737
738	STAM_REG(pVM, &pVM->tm.s.StatTimerSetVs, STAMTYPE_COUNTER, "/TM/TimerSetVs", STAMUNIT_OCCURENCES, "TMTimerSet calls on virtual sync timers");
739	STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsR3, STAMTYPE_PROFILE, "/TM/TimerSetVs/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-3 on virtual sync timers.");
740	STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsRZ, STAMTYPE_PROFILE, "/TM/TimerSetVs/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSet calls made in ring-0 / RC on virtual sync timers.");
741	STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsStActive, STAMTYPE_COUNTER, "/TM/TimerSetVs/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
742	STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSetVs/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
743	STAM_REG(pVM, &pVM->tm.s.StatTimerSetVsStStopped, STAMTYPE_COUNTER, "/TM/TimerSetVs/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
744
745	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelative, STAMTYPE_COUNTER, "/TM/TimerSetRelative", STAMUNIT_OCCURENCES, "Calls, except virtual sync timers");
746	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeOpt, STAMTYPE_COUNTER, "/TM/TimerSetRelative/Opt", STAMUNIT_OCCURENCES, "Optimized path taken.");
747	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeR3, STAMTYPE_PROFILE, "/TM/TimerSetRelative/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetRelative calls made in ring-3 (sans virtual sync).");
748	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeRZ, STAMTYPE_PROFILE, "/TM/TimerSetRelative/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetReltaive calls made in ring-0 / RC (sans virtual sync).");
749	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStActive, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
750	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
751	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStOther, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StOther", STAMUNIT_OCCURENCES, "Other states");
752	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendStop, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendStop", STAMUNIT_OCCURENCES, "PENDING_STOP");
753	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendStopSched, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendStopSched",STAMUNIT_OCCURENCES, "PENDING_STOP_SCHEDULE");
754	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendSched, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendSched", STAMUNIT_OCCURENCES, "PENDING_SCHEDULE");
755	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStPendResched, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StPendResched", STAMUNIT_OCCURENCES, "PENDING_RESCHEDULE");
756	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeStStopped, STAMTYPE_COUNTER, "/TM/TimerSetRelative/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
757
758	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVs, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs", STAMUNIT_OCCURENCES, "TMTimerSetRelative calls on virtual sync timers");
759	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsR3, STAMTYPE_PROFILE, "/TM/TimerSetRelativeVs/R3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetRelative calls made in ring-3 on virtual sync timers.");
760	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsRZ, STAMTYPE_PROFILE, "/TM/TimerSetRelativeVs/RZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerSetReltaive calls made in ring-0 / RC on virtual sync timers.");
761	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsStActive, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs/StActive", STAMUNIT_OCCURENCES, "ACTIVE");
762	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsStExpDeliver, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs/StExpDeliver", STAMUNIT_OCCURENCES, "EXPIRED_DELIVER");
763	STAM_REG(pVM, &pVM->tm.s.StatTimerSetRelativeVsStStopped, STAMTYPE_COUNTER, "/TM/TimerSetRelativeVs/StStopped", STAMUNIT_OCCURENCES, "STOPPED");
764
765	STAM_REG(pVM, &pVM->tm.s.StatTimerStopR3, STAMTYPE_PROFILE, "/TM/TimerStopR3", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-3.");
766	STAM_REG(pVM, &pVM->tm.s.StatTimerStopRZ, STAMTYPE_PROFILE, "/TM/TimerStopRZ", STAMUNIT_TICKS_PER_CALL, "Profiling TMTimerStop calls made in ring-0 / RC.");
767
768	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.");
769	STAM_REG(pVM, &pVM->tm.s.StatVirtualGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualGetSetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling TMTimerGet.");
770	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGet, STAMTYPE_COUNTER, "/TM/VirtualSyncGet", STAMUNIT_OCCURENCES, "The number of times tmVirtualSyncGetEx was called.");
771	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetAdjLast, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/AdjLast", STAMUNIT_OCCURENCES, "Times we've adjusted against the last returned time stamp .");
772	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.");
773	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetExpired, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Expired", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx encountered an expired timer stopping the clock.");
774	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetLocked, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Locked", STAMUNIT_OCCURENCES, "Times we successfully acquired the lock in tmVirtualSyncGetEx.");
775	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetLockless, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/Lockless", STAMUNIT_OCCURENCES, "Times tmVirtualSyncGetEx returned without needing to take the lock.");
776	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGetSetFF, STAMTYPE_COUNTER, "/TM/VirtualSyncGet/SetFF", STAMUNIT_OCCURENCES, "Times we set the FF when calling tmVirtualSyncGetEx.");
777	STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/VirtualPause", STAMUNIT_OCCURENCES, "The number of times TMR3TimerPause was called.");
778	STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/VirtualResume", STAMUNIT_OCCURENCES, "The number of times TMR3TimerResume was called.");
779
780	STAM_REG(pVM, &pVM->tm.s.StatTimerCallbackSetFF, STAMTYPE_COUNTER, "/TM/CallbackSetFF", STAMUNIT_OCCURENCES, "The number of times the timer callback set FF.");
781	STAM_REG(pVM, &pVM->tm.s.StatTimerCallback, STAMTYPE_COUNTER, "/TM/Callback", STAMUNIT_OCCURENCES, "The number of times the timer callback is invoked.");
782
783	STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE010, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE010", STAMUNIT_OCCURENCES, "In catch-up mode, 10% or lower.");
784	STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE025, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE025", STAMUNIT_OCCURENCES, "In catch-up mode, 25%-11%.");
785	STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupLE100, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupLE100", STAMUNIT_OCCURENCES, "In catch-up mode, 100%-26%.");
786	STAM_REG(pVM, &pVM->tm.s.StatTSCCatchupOther, STAMTYPE_COUNTER, "/TM/TSC/Intercept/CatchupOther", STAMUNIT_OCCURENCES, "In catch-up mode, > 100%.");
787	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.");
788	STAM_REG(pVM, &pVM->tm.s.StatTSCNotTicking, STAMTYPE_COUNTER, "/TM/TSC/Intercept/NotTicking", STAMUNIT_OCCURENCES, "TSC is not ticking.");
789	STAM_REG(pVM, &pVM->tm.s.StatTSCSyncNotTicking, STAMTYPE_COUNTER, "/TM/TSC/Intercept/SyncNotTicking", STAMUNIT_OCCURENCES, "VirtualSync isn't ticking.");
790	STAM_REG(pVM, &pVM->tm.s.StatTSCWarp, STAMTYPE_COUNTER, "/TM/TSC/Intercept/Warp", STAMUNIT_OCCURENCES, "Warpdrive is active.");
791	STAM_REG(pVM, &pVM->tm.s.StatTSCSet, STAMTYPE_COUNTER, "/TM/TSC/Sets", STAMUNIT_OCCURENCES, "Calls to TMCpuTickSet.");
792	STAM_REG(pVM, &pVM->tm.s.StatTSCUnderflow, STAMTYPE_COUNTER, "/TM/TSC/Underflow", STAMUNIT_OCCURENCES, "TSC underflow; corrected with last seen value .");
793	STAM_REG(pVM, &pVM->tm.s.StatVirtualPause, STAMTYPE_COUNTER, "/TM/TSC/Pause", STAMUNIT_OCCURENCES, "The number of times the TSC was paused.");
794	STAM_REG(pVM, &pVM->tm.s.StatVirtualResume, STAMTYPE_COUNTER, "/TM/TSC/Resume", STAMUNIT_OCCURENCES, "The number of times the TSC was resumed.");
795	#endif /* VBOX_WITH_STATISTICS */
796
797	for (VMCPUID i = 0; i < pVM->cCpus; i++)
798	{
799	PVMCPU pVCpu = pVM->apCpusR3[i];
800	STAMR3RegisterF(pVM, &pVCpu->tm.s.offTSCRawSrc, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS, "TSC offset relative the raw source", "/TM/TSC/offCPU%u", i);
801	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
802	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
803	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsTotal, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Resettable: Total CPU run time.", "/TM/CPU/%02u", i);
804	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsExecuting, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code.", "/TM/CPU/%02u/PrfExecuting", i);
805	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsExecLong, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code - long hauls.", "/TM/CPU/%02u/PrfExecLong", i);
806	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsExecShort, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code - short stretches.", "/TM/CPU/%02u/PrfExecShort", i);
807	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsExecTiny, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent executing guest code - tiny bits.", "/TM/CPU/%02u/PrfExecTiny", i);
808	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsHalted, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent halted.", "/TM/CPU/%02u/PrfHalted", i);
809	STAMR3RegisterF(pVM, &pVCpu->tm.s.StatNsOther, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_NS_PER_OCCURENCE, "Resettable: Time spent in the VMM or preempted.", "/TM/CPU/%02u/PrfOther", i);
810	# endif
811	STAMR3RegisterF(pVM, &pVCpu->tm.s.cNsTotalStat, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Total CPU run time.", "/TM/CPU/%02u/cNsTotal", i);
812	STAMR3RegisterF(pVM, &pVCpu->tm.s.cNsExecuting, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Time spent executing guest code.", "/TM/CPU/%02u/cNsExecuting", i);
813	STAMR3RegisterF(pVM, &pVCpu->tm.s.cNsHalted, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Time spent halted.", "/TM/CPU/%02u/cNsHalted", i);
814	STAMR3RegisterF(pVM, &pVCpu->tm.s.cNsOtherStat, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "Time spent in the VMM or preempted.", "/TM/CPU/%02u/cNsOther", i);
815	STAMR3RegisterF(pVM, &pVCpu->tm.s.cPeriodsExecuting, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Times executed guest code.", "/TM/CPU/%02u/cPeriodsExecuting", i);
816	STAMR3RegisterF(pVM, &pVCpu->tm.s.cPeriodsHalted, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Times halted.", "/TM/CPU/%02u/cPeriodsHalted", i);
817	STAMR3RegisterF(pVM, &pVCpu->tm.s.CpuLoad.cPctExecuting, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent executing guest code recently.", "/TM/CPU/%02u/pctExecuting", i);
818	STAMR3RegisterF(pVM, &pVCpu->tm.s.CpuLoad.cPctHalted, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent halted recently.", "/TM/CPU/%02u/pctHalted", i);
819	STAMR3RegisterF(pVM, &pVCpu->tm.s.CpuLoad.cPctOther, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent in the VMM or preempted recently.", "/TM/CPU/%02u/pctOther", i);
820	#endif
821	}
822	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
823	STAMR3RegisterF(pVM, &pVM->tm.s.CpuLoad.cPctExecuting, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent executing guest code recently.", "/TM/CPU/pctExecuting");
824	STAMR3RegisterF(pVM, &pVM->tm.s.CpuLoad.cPctHalted, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent halted recently.", "/TM/CPU/pctHalted");
825	STAMR3RegisterF(pVM, &pVM->tm.s.CpuLoad.cPctOther, STAMTYPE_U8, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "Time spent in the VMM or preempted recently.", "/TM/CPU/pctOther");
826	#endif
827
828	#ifdef VBOX_WITH_STATISTICS
829	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.");
830	STAM_REG(pVM, (void *)&pVM->tm.s.fVirtualSyncCatchUp, STAMTYPE_U8, "/TM/VirtualSync/CatchUpActive", STAMUNIT_NONE, "Catch-Up active indicator.");
831	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)");
832	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.");
833	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncGiveUp, STAMTYPE_COUNTER, "/TM/VirtualSync/GiveUp", STAMUNIT_OCCURENCES, "Times the catch-up was abandoned.");
834	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++.)");
835	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRun, STAMTYPE_COUNTER, "/TM/VirtualSync/Run", STAMUNIT_OCCURENCES, "Times the virtual sync timer queue was considered.");
836	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunRestart, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/Restarts", STAMUNIT_OCCURENCES, "Times the clock was restarted after a run.");
837	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.");
838	STAM_REG(pVM, &pVM->tm.s.StatVirtualSyncRunStoppedAlready, STAMTYPE_COUNTER, "/TM/VirtualSync/Run/StoppedAlready", STAMUNIT_OCCURENCES, "Times the clock was already stopped elsewhere (TMVirtualSyncGet).");
839	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.)");
840	for (unsigned i = 0; i < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods); i++)
841	{
842	STAMR3RegisterF(pVM, &pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_PCT, "The catch-up percentage.", "/TM/VirtualSync/Periods/%u", i);
843	STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupAdjust[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times adjusted to this period.", "/TM/VirtualSync/Periods/%u/Adjust", i);
844	STAMR3RegisterF(pVM, &pVM->tm.s.aStatVirtualSyncCatchupInitial[i], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Times started in this period.", "/TM/VirtualSync/Periods/%u/Initial", i);
845	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);
846	}
847	#endif /* VBOX_WITH_STATISTICS */
848
849	/*
850	* Register info handlers.
851	*/
852	DBGFR3InfoRegisterInternalEx(pVM, "timers", "Dumps all timers. No arguments.", tmR3TimerInfo, DBGFINFO_FLAGS_RUN_ON_EMT);
853	DBGFR3InfoRegisterInternalEx(pVM, "activetimers", "Dumps active all timers. No arguments.", tmR3TimerInfoActive, DBGFINFO_FLAGS_RUN_ON_EMT);
854	DBGFR3InfoRegisterInternalEx(pVM, "clocks", "Display the time of the various clocks.", tmR3InfoClocks, DBGFINFO_FLAGS_RUN_ON_EMT);
855	DBGFR3InfoRegisterInternalArgv(pVM, "cpuload", "Display the CPU load stats (--help for details).", tmR3InfoCpuLoad, 0);
856
857	return VINF_SUCCESS;
858	}
859
860
861	/**
862	* Checks if the host CPU has a fixed TSC frequency.
863	*
864	* @returns true if it has, false if it hasn't.
865	*
866	* @remarks This test doesn't bother with very old CPUs that don't do power
867	* management or any other stuff that might influence the TSC rate.
868	* This isn't currently relevant.
869	*/
870	static bool tmR3HasFixedTSC(PVM pVM)
871	{
872	/*
873	* ASSUME that if the GIP is in invariant TSC mode, it's because the CPU
874	* actually has invariant TSC.
875	*/
876	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
877	if (pGip->u32Mode == SUPGIPMODE_INVARIANT_TSC)
878	return true;
879
880	/*
881	* Go by features and model info from the CPUID instruction.
882	*/
883	if (ASMHasCpuId())
884	{
885	uint32_t uEAX, uEBX, uECX, uEDX;
886
887	/*
888	* By feature. (Used to be AMD specific, intel seems to have picked it up.)
889	*/
890	ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
891	if (uEAX >= 0x80000007 && ASMIsValidExtRange(uEAX))
892	{
893	ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
894	if ( (uEDX & X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR) /* TscInvariant */
895	&& pGip->u32Mode != SUPGIPMODE_ASYNC_TSC) /* No fixed tsc if the gip timer is in async mode. */
896	return true;
897	}
898
899	/*
900	* By model.
901	*/
902	if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_AMD)
903	{
904	/*
905	* AuthenticAMD - Check for APM support and that TscInvariant is set.
906	*
907	* This test isn't correct with respect to fixed/non-fixed TSC and
908	* older models, but this isn't relevant since the result is currently
909	* only used for making a decision on AMD-V models.
910	*/
911	#if 0 /* Promoted to generic */
912	ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
913	if (uEAX >= 0x80000007)
914	{
915	ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
916	if ( (uEDX & X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR) /* TscInvariant */
917	&& ( pGip->u32Mode == SUPGIPMODE_SYNC_TSC /* No fixed tsc if the gip timer is in async mode. */
918	\|\| pGip->u32Mode == SUPGIPMODE_INVARIANT_TSC))
919	return true;
920	}
921	#endif
922	}
923	else if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_INTEL)
924	{
925	/*
926	* GenuineIntel - Check the model number.
927	*
928	* This test is lacking in the same way and for the same reasons
929	* as the AMD test above.
930	*/
931	/** @todo use ASMGetCpuFamily() and ASMGetCpuModel() here. */
932	ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
933	unsigned uModel = (uEAX >> 4) & 0x0f;
934	unsigned uFamily = (uEAX >> 8) & 0x0f;
935	if (uFamily == 0x0f)
936	uFamily += (uEAX >> 20) & 0xff;
937	if (uFamily >= 0x06)
938	uModel += ((uEAX >> 16) & 0x0f) << 4;
939	if ( (uFamily == 0x0f /P4/ && uModel >= 0x03)
940	\|\| (uFamily == 0x06 /P2/P3/ && uModel >= 0x0e))
941	return true;
942	}
943	else if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_VIA)
944	{
945	/*
946	* CentaurHauls - Check the model, family and stepping.
947	*
948	* This only checks for VIA CPU models Nano X2, Nano X3,
949	* Eden X2 and QuadCore.
950	*/
951	/** @todo use ASMGetCpuFamily() and ASMGetCpuModel() here. */
952	ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
953	unsigned uStepping = (uEAX & 0x0f);
954	unsigned uModel = (uEAX >> 4) & 0x0f;
955	unsigned uFamily = (uEAX >> 8) & 0x0f;
956	if ( uFamily == 0x06
957	&& uModel == 0x0f
958	&& uStepping >= 0x0c
959	&& uStepping <= 0x0f)
960	return true;
961	}
962	else if (CPUMGetHostCpuVendor(pVM) == CPUMCPUVENDOR_SHANGHAI)
963	{
964	/*
965	* Shanghai - Check the model, family and stepping.
966	*/
967	/** @todo use ASMGetCpuFamily() and ASMGetCpuModel() here. */
968	ASMCpuId(1, &uEAX, &uEBX, &uECX, &uEDX);
969	unsigned uFamily = (uEAX >> 8) & 0x0f;
970	if ( uFamily == 0x06
971	\|\| uFamily == 0x07)
972	{
973	return true;
974	}
975	}
976	}
977	return false;
978	}
979
980
981	/**
982	* Calibrate the CPU tick.
983	*
984	* @returns Number of ticks per second.
985	*/
986	static uint64_t tmR3CalibrateTSC(void)
987	{
988	uint64_t u64Hz;
989
990	/*
991	* Use GIP when available. Prefere the nominal one, no need to wait for it.
992	*/
993	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
994	if (pGip)
995	{
996	u64Hz = pGip->u64CpuHz;
997	if (u64Hz < _1T && u64Hz > _1M)
998	return u64Hz;
999	AssertFailed(); /* This shouldn't happen. */
1000
1001	u64Hz = SUPGetCpuHzFromGip(pGip);
1002	if (u64Hz < _1T && u64Hz > _1M)
1003	return u64Hz;
1004
1005	AssertFailed(); /* This shouldn't happen. */
1006	}
1007	/* else: This should only happen in fake SUPLib mode, which we don't really support any more... */
1008
1009	/* Call this once first to make sure it's initialized. */
1010	RTTimeNanoTS();
1011
1012	/*
1013	* Yield the CPU to increase our chances of getting
1014	* a correct value.
1015	*/
1016	RTThreadYield(); /* Try avoid interruptions between TSC and NanoTS samplings. */
1017	static const unsigned s_auSleep[5] = { 50, 30, 30, 40, 40 };
1018	uint64_t au64Samples[5];
1019	unsigned i;
1020	for (i = 0; i < RT_ELEMENTS(au64Samples); i++)
1021	{
1022	RTMSINTERVAL cMillies;
1023	int cTries = 5;
1024	uint64_t u64Start = ASMReadTSC();
1025	uint64_t u64End;
1026	uint64_t StartTS = RTTimeNanoTS();
1027	uint64_t EndTS;
1028	do
1029	{
1030	RTThreadSleep(s_auSleep[i]);
1031	u64End = ASMReadTSC();
1032	EndTS = RTTimeNanoTS();
1033	cMillies = (RTMSINTERVAL)((EndTS - StartTS + 500000) / 1000000);
1034	} while ( cMillies == 0 /* the sleep may be interrupted... */
1035	\|\| (cMillies < 20 && --cTries > 0));
1036	uint64_t u64Diff = u64End - u64Start;
1037
1038	au64Samples[i] = (u64Diff * 1000) / cMillies;
1039	AssertMsg(cTries > 0, ("cMillies=%d i=%d\n", cMillies, i));
1040	}
1041
1042	/*
1043	* Discard the highest and lowest results and calculate the average.
1044	*/
1045	unsigned iHigh = 0;
1046	unsigned iLow = 0;
1047	for (i = 1; i < RT_ELEMENTS(au64Samples); i++)
1048	{
1049	if (au64Samples[i] < au64Samples[iLow])
1050	iLow = i;
1051	if (au64Samples[i] > au64Samples[iHigh])
1052	iHigh = i;
1053	}
1054	au64Samples[iLow] = 0;
1055	au64Samples[iHigh] = 0;
1056
1057	u64Hz = au64Samples[0];
1058	for (i = 1; i < RT_ELEMENTS(au64Samples); i++)
1059	u64Hz += au64Samples[i];
1060	u64Hz /= RT_ELEMENTS(au64Samples) - 2;
1061
1062	return u64Hz;
1063	}
1064
1065
1066	/**
1067	* Finalizes the TM initialization.
1068	*
1069	* @returns VBox status code.
1070	* @param pVM The cross context VM structure.
1071	*/
1072	VMM_INT_DECL(int) TMR3InitFinalize(PVM pVM)
1073	{
1074	int rc;
1075
1076	/*
1077	* Resolve symbols.
1078	*/
1079	if (VM_IS_RAW_MODE_ENABLED(pVM))
1080	{
1081	rc = PDMR3LdrGetSymbolRC(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataRC.pfnBad);
1082	AssertRCReturn(rc, rc);
1083	rc = PDMR3LdrGetSymbolRC(pVM, NULL, "tmVirtualNanoTSBadCpuIndex", &pVM->tm.s.VirtualGetRawDataRC.pfnBadCpuIndex);
1084	AssertRCReturn(rc, rc);
1085	rc = PDMR3LdrGetSymbolRC(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataRC.pfnRediscover);
1086	AssertRCReturn(rc, rc);
1087	pVM->tm.s.pfnVirtualGetRawRC = pVM->tm.s.VirtualGetRawDataRC.pfnRediscover;
1088	}
1089
1090	rc = PDMR3LdrGetSymbolR0(pVM, NULL, "tmVirtualNanoTSBad", &pVM->tm.s.VirtualGetRawDataR0.pfnBad);
1091	AssertRCReturn(rc, rc);
1092	rc = PDMR3LdrGetSymbolR0(pVM, NULL, "tmVirtualNanoTSBadCpuIndex", &pVM->tm.s.VirtualGetRawDataR0.pfnBadCpuIndex);
1093	AssertRCReturn(rc, rc);
1094	rc = PDMR3LdrGetSymbolR0(pVM, NULL, "tmVirtualNanoTSRediscover", &pVM->tm.s.VirtualGetRawDataR0.pfnRediscover);
1095	AssertRCReturn(rc, rc);
1096	pVM->tm.s.pfnVirtualGetRawR0 = pVM->tm.s.VirtualGetRawDataR0.pfnRediscover;
1097
1098	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
1099	/*
1100	* Create a timer for refreshing the CPU load stats.
1101	*/
1102	TMTIMERHANDLE hTimer;
1103	rc = TMR3TimerCreate(pVM, TMCLOCK_REAL, tmR3CpuLoadTimer, NULL, TMTIMER_FLAGS_NO_RING0, "CPU Load Timer", &hTimer);
1104	if (RT_SUCCESS(rc))
1105	rc = TMTimerSetMillies(pVM, hTimer, 1000);
1106	#endif
1107
1108	/*
1109	* GIM is now initialized. Determine if TSC mode switching is allowed (respecting CFGM override).
1110	*/
1111	pVM->tm.s.fTSCModeSwitchAllowed &= tmR3HasFixedTSC(pVM) && GIMIsEnabled(pVM) && !VM_IS_RAW_MODE_ENABLED(pVM);
1112	LogRel(("TM: TMR3InitFinalize: fTSCModeSwitchAllowed=%RTbool\n", pVM->tm.s.fTSCModeSwitchAllowed));
1113	return rc;
1114	}
1115
1116
1117	/**
1118	* Applies relocations to data and code managed by this
1119	* component. This function will be called at init and
1120	* whenever the VMM need to relocate it self inside the GC.
1121	*
1122	* @param pVM The cross context VM structure.
1123	* @param offDelta Relocation delta relative to old location.
1124	*/
1125	VMM_INT_DECL(void) TMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
1126	{
1127	LogFlow(("TMR3Relocate\n"));
1128
1129	pVM->tm.s.paTimerQueuesR0 = MMHyperR3ToR0(pVM, pVM->tm.s.paTimerQueuesR3);
1130
1131	if (VM_IS_RAW_MODE_ENABLED(pVM))
1132	{
1133	pVM->tm.s.pvGIPRC = MMHyperR3ToRC(pVM, pVM->tm.s.pvGIPR3);
1134	pVM->tm.s.paTimerQueuesRC = MMHyperR3ToRC(pVM, pVM->tm.s.paTimerQueuesR3);
1135	pVM->tm.s.VirtualGetRawDataRC.pu64Prev += offDelta;
1136	pVM->tm.s.VirtualGetRawDataRC.pfnBad += offDelta;
1137	pVM->tm.s.VirtualGetRawDataRC.pfnBadCpuIndex += offDelta;
1138	pVM->tm.s.VirtualGetRawDataRC.pfnRediscover += offDelta;
1139	pVM->tm.s.pfnVirtualGetRawRC += offDelta;
1140	}
1141
1142	/*
1143	* Iterate the timers updating the pVMRC pointers.
1144	*/
1145	for (PTMTIMER pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
1146	{
1147	pTimer->pVMRC = pVM->pVMRC;
1148	pTimer->pVMR0 = pVM->pVMR0ForCall; /** @todo fix properly */
1149	}
1150	}
1151
1152
1153	/**
1154	* Terminates the TM.
1155	*
1156	* Termination means cleaning up and freeing all resources,
1157	* the VM it self is at this point powered off or suspended.
1158	*
1159	* @returns VBox status code.
1160	* @param pVM The cross context VM structure.
1161	*/
1162	VMM_INT_DECL(int) TMR3Term(PVM pVM)
1163	{
1164	AssertMsg(pVM->tm.s.offVM, ("bad init order!\n"));
1165	if (pVM->tm.s.pTimer)
1166	{
1167	int rc = RTTimerDestroy(pVM->tm.s.pTimer);
1168	AssertRC(rc);
1169	pVM->tm.s.pTimer = NULL;
1170	}
1171
1172	return VINF_SUCCESS;
1173	}
1174
1175
1176	/**
1177	* The VM is being reset.
1178	*
1179	* For the TM component this means that a rescheduling is preformed,
1180	* the FF is cleared and but without running the queues. We'll have to
1181	* check if this makes sense or not, but it seems like a good idea now....
1182	*
1183	* @param pVM The cross context VM structure.
1184	*/
1185	VMM_INT_DECL(void) TMR3Reset(PVM pVM)
1186	{
1187	LogFlow(("TMR3Reset:\n"));
1188	VM_ASSERT_EMT(pVM);
1189	TM_LOCK_TIMERS(pVM);
1190
1191	/*
1192	* Abort any pending catch up.
1193	* This isn't perfect...
1194	*/
1195	if (pVM->tm.s.fVirtualSyncCatchUp)
1196	{
1197	const uint64_t offVirtualNow = TMVirtualGetNoCheck(pVM);
1198	const uint64_t offVirtualSyncNow = TMVirtualSyncGetNoCheck(pVM);
1199	if (pVM->tm.s.fVirtualSyncCatchUp)
1200	{
1201	STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
1202
1203	const uint64_t offOld = pVM->tm.s.offVirtualSyncGivenUp;
1204	const uint64_t offNew = offVirtualNow - offVirtualSyncNow;
1205	Assert(offOld <= offNew);
1206	ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
1207	ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSync, offNew);
1208	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
1209	LogRel(("TM: Aborting catch-up attempt on reset with a %'RU64 ns lag on reset; new total: %'RU64 ns\n", offNew - offOld, offNew));
1210	}
1211	}
1212
1213	/*
1214	* Process the queues.
1215	*/
1216	for (int i = 0; i < TMCLOCK_MAX; i++)
1217	tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[i]);
1218	#ifdef VBOX_STRICT
1219	tmTimerQueuesSanityChecks(pVM, "TMR3Reset");
1220	#endif
1221
1222	PVMCPU pVCpuDst = pVM->apCpusR3[pVM->tm.s.idTimerCpu];
1223	VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /** @todo FIXME: this isn't right. */
1224
1225	/*
1226	* Switch TM TSC mode back to the original mode after a reset for
1227	* paravirtualized guests that alter the TM TSC mode during operation.
1228	*/
1229	if ( pVM->tm.s.fTSCModeSwitchAllowed
1230	&& pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode)
1231	{
1232	VM_ASSERT_EMT0(pVM);
1233	tmR3CpuTickParavirtDisable(pVM, pVM->apCpusR3[0], NULL /* pvData */);
1234	}
1235	Assert(!GIMIsParavirtTscEnabled(pVM));
1236	pVM->tm.s.fParavirtTscEnabled = false;
1237
1238	/*
1239	* Reset TSC to avoid a Windows 8+ bug (see @bugref{8926}). If Windows
1240	* sees TSC value beyond 0x40000000000 at startup, it will reset the
1241	* TSC on boot-up CPU only, causing confusion and mayhem with SMP.
1242	*/
1243	VM_ASSERT_EMT0(pVM);
1244	uint64_t offTscRawSrc;
1245	switch (pVM->tm.s.enmTSCMode)
1246	{
1247	case TMTSCMODE_REAL_TSC_OFFSET:
1248	offTscRawSrc = SUPReadTsc();
1249	break;
1250	case TMTSCMODE_DYNAMIC:
1251	case TMTSCMODE_VIRT_TSC_EMULATED:
1252	offTscRawSrc = TMVirtualSyncGetNoCheck(pVM);
1253	offTscRawSrc = ASMMultU64ByU32DivByU32(offTscRawSrc, pVM->tm.s.cTSCTicksPerSecond, TMCLOCK_FREQ_VIRTUAL);
1254	break;
1255	case TMTSCMODE_NATIVE_API:
1256	/** @todo NEM TSC reset on reset for Windows8+ bug workaround. */
1257	offTscRawSrc = 0;
1258	break;
1259	default:
1260	AssertFailedBreakStmt(offTscRawSrc = 0);
1261	}
1262	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1263	{
1264	PVMCPU pVCpu = pVM->apCpusR3[idCpu];
1265	pVCpu->tm.s.offTSCRawSrc = offTscRawSrc;
1266	pVCpu->tm.s.u64TSC = 0;
1267	pVCpu->tm.s.u64TSCLastSeen = 0;
1268	}
1269
1270	TM_UNLOCK_TIMERS(pVM);
1271	}
1272
1273
1274	/**
1275	* Resolve a builtin RC symbol.
1276	* Called by PDM when loading or relocating GC modules.
1277	*
1278	* @returns VBox status
1279	* @param pVM The cross context VM structure.
1280	* @param pszSymbol Symbol to resolve.
1281	* @param pRCPtrValue Where to store the symbol value.
1282	* @remark This has to work before TMR3Relocate() is called.
1283	*/
1284	VMM_INT_DECL(int) TMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue)
1285	{
1286	if (!strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
1287	*pRCPtrValue = MMHyperR3ToRC(pVM, &pVM->tm.s.pvGIPRC);
1288	//else if (..)
1289	else
1290	return VERR_SYMBOL_NOT_FOUND;
1291	return VINF_SUCCESS;
1292	}
1293
1294
1295	/**
1296	* Execute state save operation.
1297	*
1298	* @returns VBox status code.
1299	* @param pVM The cross context VM structure.
1300	* @param pSSM SSM operation handle.
1301	*/
1302	static DECLCALLBACK(int) tmR3Save(PVM pVM, PSSMHANDLE pSSM)
1303	{
1304	LogFlow(("tmR3Save:\n"));
1305	#ifdef VBOX_STRICT
1306	for (VMCPUID i = 0; i < pVM->cCpus; i++)
1307	{
1308	PVMCPU pVCpu = pVM->apCpusR3[i];
1309	Assert(!pVCpu->tm.s.fTSCTicking);
1310	}
1311	Assert(!pVM->tm.s.cVirtualTicking);
1312	Assert(!pVM->tm.s.fVirtualSyncTicking);
1313	Assert(!pVM->tm.s.cTSCsTicking);
1314	#endif
1315
1316	/*
1317	* Save the virtual clocks.
1318	*/
1319	/* the virtual clock. */
1320	SSMR3PutU64(pSSM, TMCLOCK_FREQ_VIRTUAL);
1321	SSMR3PutU64(pSSM, pVM->tm.s.u64Virtual);
1322
1323	/* the virtual timer synchronous clock. */
1324	SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSync);
1325	SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSync);
1326	SSMR3PutU64(pSSM, pVM->tm.s.offVirtualSyncGivenUp);
1327	SSMR3PutU64(pSSM, pVM->tm.s.u64VirtualSyncCatchUpPrev);
1328	SSMR3PutBool(pSSM, pVM->tm.s.fVirtualSyncCatchUp);
1329
1330	/* real time clock */
1331	SSMR3PutU64(pSSM, TMCLOCK_FREQ_REAL);
1332
1333	/* the cpu tick clock. */
1334	for (VMCPUID i = 0; i < pVM->cCpus; i++)
1335	{
1336	PVMCPU pVCpu = pVM->apCpusR3[i];
1337	SSMR3PutU64(pSSM, TMCpuTickGet(pVCpu));
1338	}
1339	return SSMR3PutU64(pSSM, pVM->tm.s.cTSCTicksPerSecond);
1340	}
1341
1342
1343	/**
1344	* Execute state load operation.
1345	*
1346	* @returns VBox status code.
1347	* @param pVM The cross context VM structure.
1348	* @param pSSM SSM operation handle.
1349	* @param uVersion Data layout version.
1350	* @param uPass The data pass.
1351	*/
1352	static DECLCALLBACK(int) tmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1353	{
1354	LogFlow(("tmR3Load:\n"));
1355
1356	Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
1357	#ifdef VBOX_STRICT
1358	for (VMCPUID i = 0; i < pVM->cCpus; i++)
1359	{
1360	PVMCPU pVCpu = pVM->apCpusR3[i];
1361	Assert(!pVCpu->tm.s.fTSCTicking);
1362	}
1363	Assert(!pVM->tm.s.cVirtualTicking);
1364	Assert(!pVM->tm.s.fVirtualSyncTicking);
1365	Assert(!pVM->tm.s.cTSCsTicking);
1366	#endif
1367
1368	/*
1369	* Validate version.
1370	*/
1371	if (uVersion != TM_SAVED_STATE_VERSION)
1372	{
1373	AssertMsgFailed(("tmR3Load: Invalid version uVersion=%d!\n", uVersion));
1374	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1375	}
1376
1377	/*
1378	* Load the virtual clock.
1379	*/
1380	pVM->tm.s.cVirtualTicking = 0;
1381	/* the virtual clock. */
1382	uint64_t u64Hz;
1383	int rc = SSMR3GetU64(pSSM, &u64Hz);
1384	if (RT_FAILURE(rc))
1385	return rc;
1386	if (u64Hz != TMCLOCK_FREQ_VIRTUAL)
1387	{
1388	AssertMsgFailed(("The virtual clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1389	u64Hz, TMCLOCK_FREQ_VIRTUAL));
1390	return VERR_SSM_VIRTUAL_CLOCK_HZ;
1391	}
1392	SSMR3GetU64(pSSM, &pVM->tm.s.u64Virtual);
1393	pVM->tm.s.u64VirtualOffset = 0;
1394
1395	/* the virtual timer synchronous clock. */
1396	pVM->tm.s.fVirtualSyncTicking = false;
1397	uint64_t u64;
1398	SSMR3GetU64(pSSM, &u64);
1399	pVM->tm.s.u64VirtualSync = u64;
1400	SSMR3GetU64(pSSM, &u64);
1401	pVM->tm.s.offVirtualSync = u64;
1402	SSMR3GetU64(pSSM, &u64);
1403	pVM->tm.s.offVirtualSyncGivenUp = u64;
1404	SSMR3GetU64(pSSM, &u64);
1405	pVM->tm.s.u64VirtualSyncCatchUpPrev = u64;
1406	bool f;
1407	SSMR3GetBool(pSSM, &f);
1408	pVM->tm.s.fVirtualSyncCatchUp = f;
1409
1410	/* the real clock */
1411	rc = SSMR3GetU64(pSSM, &u64Hz);
1412	if (RT_FAILURE(rc))
1413	return rc;
1414	if (u64Hz != TMCLOCK_FREQ_REAL)
1415	{
1416	AssertMsgFailed(("The real clock frequency differs! Saved: %'RU64 Binary: %'RU64\n",
1417	u64Hz, TMCLOCK_FREQ_REAL));
1418	return VERR_SSM_VIRTUAL_CLOCK_HZ; /* misleading... */
1419	}
1420
1421	/* the cpu tick clock. */
1422	pVM->tm.s.cTSCsTicking = 0;
1423	pVM->tm.s.offTSCPause = 0;
1424	pVM->tm.s.u64LastPausedTSC = 0;
1425	for (VMCPUID i = 0; i < pVM->cCpus; i++)
1426	{
1427	PVMCPU pVCpu = pVM->apCpusR3[i];
1428
1429	pVCpu->tm.s.fTSCTicking = false;
1430	SSMR3GetU64(pSSM, &pVCpu->tm.s.u64TSC);
1431	if (pVM->tm.s.u64LastPausedTSC < pVCpu->tm.s.u64TSC)
1432	pVM->tm.s.u64LastPausedTSC = pVCpu->tm.s.u64TSC;
1433
1434	if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1435	pVCpu->tm.s.offTSCRawSrc = 0; /** @todo TSC restore stuff and HWACC. */
1436	}
1437
1438	rc = SSMR3GetU64(pSSM, &u64Hz);
1439	if (RT_FAILURE(rc))
1440	return rc;
1441	if (pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET)
1442	pVM->tm.s.cTSCTicksPerSecond = u64Hz;
1443
1444	LogRel(("TM: cTSCTicksPerSecond=%#RX64 (%'RU64) enmTSCMode=%d (%s) (state load)\n",
1445	pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.cTSCTicksPerSecond, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM)));
1446
1447	/* Disabled as this isn't tested, also should this apply only if GIM is enabled etc. */
1448	#if 0
1449	/*
1450	* If the current host TSC frequency is incompatible with what is in the
1451	* saved state of the VM, fall back to emulating TSC and disallow TSC mode
1452	* switches during VM runtime (e.g. by GIM).
1453	*/
1454	if ( GIMIsEnabled(pVM)
1455	\|\| pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
1456	{
1457	uint64_t uGipCpuHz;
1458	bool fRelax = RTSystemIsInsideVM();
1459	bool fCompat = SUPIsTscFreqCompatible(pVM->tm.s.cTSCTicksPerSecond, &uGipCpuHz, fRelax);
1460	if (!fCompat)
1461	{
1462	pVM->tm.s.enmTSCMode = TMTSCMODE_VIRT_TSC_EMULATED;
1463	pVM->tm.s.fTSCModeSwitchAllowed = false;
1464	if (g_pSUPGlobalInfoPage->u32Mode != SUPGIPMODE_ASYNC_TSC)
1465	{
1466	LogRel(("TM: TSC frequency incompatible! uGipCpuHz=%#RX64 (%'RU64) enmTSCMode=%d (%s) fTSCModeSwitchAllowed=%RTbool (state load)\n",
1467	uGipCpuHz, uGipCpuHz, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM), pVM->tm.s.fTSCModeSwitchAllowed));
1468	}
1469	else
1470	{
1471	LogRel(("TM: GIP is async, enmTSCMode=%d (%s) fTSCModeSwitchAllowed=%RTbool (state load)\n",
1472	uGipCpuHz, uGipCpuHz, pVM->tm.s.enmTSCMode, tmR3GetTSCModeName(pVM), pVM->tm.s.fTSCModeSwitchAllowed));
1473	}
1474	}
1475	}
1476	#endif
1477
1478	/*
1479	* Make sure timers get rescheduled immediately.
1480	*/
1481	PVMCPU pVCpuDst = pVM->apCpusR3[pVM->tm.s.idTimerCpu];
1482	VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
1483
1484	return VINF_SUCCESS;
1485	}
1486
1487	#ifdef VBOX_WITH_STATISTICS
1488	/** Names the clock of the timer. */
1489	static const char *tmR3TimerClockName(PTMTIMERR3 pTimer)
1490	{
1491	switch (pTimer->enmClock)
1492	{
1493	case TMCLOCK_VIRTUAL: return "virtual";
1494	case TMCLOCK_VIRTUAL_SYNC: return "virtual-sync";
1495	case TMCLOCK_REAL: return "real";
1496	case TMCLOCK_TSC: return "tsc";
1497	case TMCLOCK_MAX: break;
1498	}
1499	return "corrupt clock value";
1500	}
1501	#endif
1502
1503
1504	/**
1505	* Internal TMR3TimerCreate worker.
1506	*
1507	* @returns VBox status code.
1508	* @param pVM The cross context VM structure.
1509	* @param enmClock The timer clock.
1510	* @param fFlags TMTIMER_FLAGS_XXX.
1511	* @param pszDesc The timer description.
1512	* @param ppTimer Where to store the timer pointer on success.
1513	*/
1514	static int tmr3TimerCreate(PVM pVM, TMCLOCK enmClock, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1515	{
1516	VM_ASSERT_EMT(pVM);
1517	AssertReturn((fFlags & (TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0)) != (TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0),
1518	VERR_INVALID_FLAGS);
1519
1520	/*
1521	* Allocate the timer.
1522	*/
1523	PTMTIMERR3 pTimer = NULL;
1524	if (pVM->tm.s.pFree && VM_IS_EMT(pVM))
1525	{
1526	pTimer = pVM->tm.s.pFree;
1527	pVM->tm.s.pFree = pTimer->pBigNext;
1528	Log3(("TM: Recycling timer %p, new free head %p.\n", pTimer, pTimer->pBigNext));
1529	}
1530
1531	if (!pTimer)
1532	{
1533	int rc = MMHyperAlloc(pVM, sizeof(pTimer), 0, MM_TAG_TM, (void *)&pTimer);
1534	if (RT_FAILURE(rc))
1535	return rc;
1536	Log3(("TM: Allocated new timer %p\n", pTimer));
1537	}
1538
1539	/*
1540	* Initialize it.
1541	*/
1542	pTimer->u64Expire = 0;
1543	pTimer->enmClock = enmClock;
1544	pTimer->hSelf = (TMTIMERHANDLE)pTimer;
1545	pTimer->pVMR3 = pVM;
1546	pTimer->pVMR0 = pVM->pVMR0ForCall; /** @todo fix properly */
1547	pTimer->pVMRC = pVM->pVMRC;
1548	pTimer->enmState = TMTIMERSTATE_STOPPED;
1549	pTimer->offScheduleNext = 0;
1550	pTimer->offNext = 0;
1551	pTimer->offPrev = 0;
1552	pTimer->pvUser = NULL;
1553	pTimer->pCritSect = NULL;
1554	pTimer->pszDesc = pszDesc;
1555	pTimer->fFlags = fFlags;
1556
1557	/* insert into the list of created timers. */
1558	TM_LOCK_TIMERS(pVM);
1559	pTimer->pBigPrev = NULL;
1560	pTimer->pBigNext = pVM->tm.s.pCreated;
1561	pVM->tm.s.pCreated = pTimer;
1562	if (pTimer->pBigNext)
1563	pTimer->pBigNext->pBigPrev = pTimer;
1564	#ifdef VBOX_STRICT
1565	tmTimerQueuesSanityChecks(pVM, "tmR3TimerCreate");
1566	#endif
1567	TM_UNLOCK_TIMERS(pVM);
1568
1569	/*
1570	* Register statistics.
1571	*/
1572	#ifdef VBOX_WITH_STATISTICS
1573
1574	STAMR3RegisterF(pVM, &pTimer->StatTimer, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL,
1575	tmR3TimerClockName(pTimer), "/TM/Timers/%s", pszDesc);
1576	STAMR3RegisterF(pVM, &pTimer->StatCritSectEnter, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL,
1577	"", "/TM/Timers/%s/CritSectEnter", pszDesc);
1578	STAMR3RegisterF(pVM, &pTimer->StatGet, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_CALLS,
1579	"", "/TM/Timers/%s/Get", pszDesc);
1580	STAMR3RegisterF(pVM, &pTimer->StatSetAbsolute, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_CALLS,
1581	"", "/TM/Timers/%s/SetAbsolute", pszDesc);
1582	STAMR3RegisterF(pVM, &pTimer->StatSetRelative, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_CALLS,
1583	"", "/TM/Timers/%s/SetRelative", pszDesc);
1584	STAMR3RegisterF(pVM, &pTimer->StatStop, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_CALLS,
1585	"", "/TM/Timers/%s/Stop", pszDesc);
1586	#endif
1587
1588	*ppTimer = pTimer;
1589	return VINF_SUCCESS;
1590	}
1591
1592
1593	/**
1594	* Creates a device timer.
1595	*
1596	* @returns VBox status code.
1597	* @param pVM The cross context VM structure.
1598	* @param pDevIns Device instance.
1599	* @param enmClock The clock to use on this timer.
1600	* @param pfnCallback Callback function.
1601	* @param pvUser The user argument to the callback.
1602	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
1603	* @param pszDesc Pointer to description string which must stay around
1604	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1605	* @param phTimer Where to store the timer handle on success.
1606	*/
1607	VMM_INT_DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock,
1608	PFNTMTIMERDEV pfnCallback, void *pvUser,
1609	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1610	{
1611	AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT \| TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0)),
1612	VERR_INVALID_FLAGS);
1613
1614	/*
1615	* Allocate and init stuff.
1616	*/
1617	PTMTIMER pTimer;
1618	int rc = tmr3TimerCreate(pVM, enmClock, fFlags, pszDesc, &pTimer);
1619	if (RT_SUCCESS(rc))
1620	{
1621	pTimer->enmType = TMTIMERTYPE_DEV;
1622	pTimer->u.Dev.pfnTimer = pfnCallback;
1623	pTimer->u.Dev.pDevIns = pDevIns;
1624	pTimer->pvUser = pvUser;
1625	if (!(fFlags & TMTIMER_FLAGS_NO_CRIT_SECT))
1626	pTimer->pCritSect = PDMR3DevGetCritSect(pVM, pDevIns);
1627	*phTimer = pTimer->hSelf;
1628	Log(("TM: Created device timer %p clock %d callback %p '%s'\n", phTimer, enmClock, pfnCallback, pszDesc));
1629	}
1630
1631	return rc;
1632	}
1633
1634
1635
1636
1637	/**
1638	* Creates a USB device timer.
1639	*
1640	* @returns VBox status code.
1641	* @param pVM The cross context VM structure.
1642	* @param pUsbIns The USB device instance.
1643	* @param enmClock The clock to use on this timer.
1644	* @param pfnCallback Callback function.
1645	* @param pvUser The user argument to the callback.
1646	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
1647	* @param pszDesc Pointer to description string which must stay around
1648	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1649	* @param phTimer Where to store the timer handle on success.
1650	*/
1651	VMM_INT_DECL(int) TMR3TimerCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, TMCLOCK enmClock,
1652	PFNTMTIMERUSB pfnCallback, void *pvUser,
1653	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1654	{
1655	AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT \| TMTIMER_FLAGS_NO_RING0)), VERR_INVALID_PARAMETER);
1656
1657	/*
1658	* Allocate and init stuff.
1659	*/
1660	PTMTIMER pTimer;
1661	int rc = tmr3TimerCreate(pVM, enmClock, fFlags, pszDesc, &pTimer);
1662	if (RT_SUCCESS(rc))
1663	{
1664	pTimer->enmType = TMTIMERTYPE_USB;
1665	pTimer->u.Usb.pfnTimer = pfnCallback;
1666	pTimer->u.Usb.pUsbIns = pUsbIns;
1667	pTimer->pvUser = pvUser;
1668	//if (!(fFlags & TMTIMER_FLAGS_NO_CRIT_SECT))
1669	//{
1670	// if (pDevIns->pCritSectR3)
1671	// pTimer->pCritSect = pUsbIns->pCritSectR3;
1672	// else
1673	// pTimer->pCritSect = IOMR3GetCritSect(pVM);
1674	//}
1675	*phTimer = pTimer->hSelf;
1676	Log(("TM: Created USB device timer %p clock %d callback %p '%s'\n", *phTimer, enmClock, pfnCallback, pszDesc));
1677	}
1678
1679	return rc;
1680	}
1681
1682
1683	/**
1684	* Creates a driver timer.
1685	*
1686	* @returns VBox status code.
1687	* @param pVM The cross context VM structure.
1688	* @param pDrvIns Driver instance.
1689	* @param enmClock The clock to use on this timer.
1690	* @param pfnCallback Callback function.
1691	* @param pvUser The user argument to the callback.
1692	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
1693	* @param pszDesc Pointer to description string which must stay around
1694	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1695	* @param phTimer Where to store the timer handle on success.
1696	*/
1697	VMM_INT_DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1698	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1699	{
1700	AssertReturn(!(fFlags & ~(TMTIMER_FLAGS_NO_CRIT_SECT \| TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0)),
1701	VERR_INVALID_FLAGS);
1702
1703	/*
1704	* Allocate and init stuff.
1705	*/
1706	PTMTIMER pTimer;
1707	int rc = tmr3TimerCreate(pVM, enmClock, fFlags, pszDesc, &pTimer);
1708	if (RT_SUCCESS(rc))
1709	{
1710	pTimer->enmType = TMTIMERTYPE_DRV;
1711	pTimer->u.Drv.pfnTimer = pfnCallback;
1712	pTimer->u.Drv.pDrvIns = pDrvIns;
1713	pTimer->pvUser = pvUser;
1714	*phTimer = pTimer->hSelf;
1715	Log(("TM: Created device timer %p clock %d callback %p '%s'\n", *phTimer, enmClock, pfnCallback, pszDesc));
1716	}
1717
1718	return rc;
1719	}
1720
1721
1722	/**
1723	* Creates an internal timer.
1724	*
1725	* @returns VBox status code.
1726	* @param pVM The cross context VM structure.
1727	* @param enmClock The clock to use on this timer.
1728	* @param pfnCallback Callback function.
1729	* @param pvUser User argument to be passed to the callback.
1730	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
1731	* @param pszDesc Pointer to description string which must stay around
1732	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
1733	* @param phTimer Where to store the timer handle on success.
1734	*/
1735	VMMR3DECL(int) TMR3TimerCreate(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser,
1736	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1737	{
1738	AssertReturn(fFlags & (TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0), VERR_INVALID_FLAGS);
1739	AssertReturn((fFlags & (TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0)) != (TMTIMER_FLAGS_RING0 \| TMTIMER_FLAGS_NO_RING0),
1740	VERR_INVALID_FLAGS);
1741
1742	/*
1743	* Allocate and init stuff.
1744	*/
1745	PTMTIMER pTimer;
1746	int rc = tmr3TimerCreate(pVM, enmClock, fFlags, pszDesc, &pTimer);
1747	if (RT_SUCCESS(rc))
1748	{
1749	pTimer->enmType = TMTIMERTYPE_INTERNAL;
1750	pTimer->u.Internal.pfnTimer = pfnCallback;
1751	pTimer->pvUser = pvUser;
1752	*phTimer = pTimer->hSelf;
1753	Log(("TM: Created internal timer %p clock %d callback %p '%s'\n", pTimer, enmClock, pfnCallback, pszDesc));
1754	}
1755
1756	return rc;
1757	}
1758
1759
1760	/**
1761	* Destroy a timer
1762	*
1763	* @returns VBox status code.
1764	* @param pTimer Timer handle as returned by one of the create functions.
1765	*/
1766	static int tmR3TimerDestroy(PVMCC pVM, PTMTIMER pTimer)
1767	{
1768	Assert((unsigned)pTimer->enmClock < (unsigned)TMCLOCK_MAX);
1769
1770	PTMTIMERQUEUE pQueue = &pVM->tm.s.CTX_SUFF(paTimerQueues)[pTimer->enmClock];
1771	bool fActive = false;
1772	bool fPending = false;
1773
1774	AssertMsg( !pTimer->pCritSect
1775	\|\| VMR3GetState(pVM) != VMSTATE_RUNNING
1776	\|\| PDMCritSectIsOwner(pTimer->pCritSect), ("%s\n", pTimer->pszDesc));
1777
1778	/*
1779	* The rest of the game happens behind the lock, just
1780	* like create does. All the work is done here.
1781	*/
1782	TM_LOCK_TIMERS(pVM);
1783	for (int cRetries = 1000;; cRetries--)
1784	{
1785	/*
1786	* Change to the DESTROY state.
1787	*/
1788	TMTIMERSTATE const enmState = pTimer->enmState;
1789	Log2(("TMTimerDestroy: %p:{.enmState=%s, .pszDesc='%s'} cRetries=%d\n",
1790	pTimer, tmTimerState(enmState), R3STRING(pTimer->pszDesc), cRetries));
1791	switch (enmState)
1792	{
1793	case TMTIMERSTATE_STOPPED:
1794	case TMTIMERSTATE_EXPIRED_DELIVER:
1795	break;
1796
1797	case TMTIMERSTATE_ACTIVE:
1798	fActive = true;
1799	break;
1800
1801	case TMTIMERSTATE_PENDING_STOP:
1802	case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
1803	case TMTIMERSTATE_PENDING_RESCHEDULE:
1804	fActive = true;
1805	fPending = true;
1806	break;
1807
1808	case TMTIMERSTATE_PENDING_SCHEDULE:
1809	fPending = true;
1810	break;
1811
1812	/*
1813	* This shouldn't happen as the caller should make sure there are no races.
1814	*/
1815	case TMTIMERSTATE_EXPIRED_GET_UNLINK:
1816	case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
1817	case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
1818	AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1819	TM_UNLOCK_TIMERS(pVM);
1820	if (!RTThreadYield())
1821	RTThreadSleep(1);
1822	AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1823	VERR_TM_UNSTABLE_STATE);
1824	TM_LOCK_TIMERS(pVM);
1825	continue;
1826
1827	/*
1828	* Invalid states.
1829	*/
1830	case TMTIMERSTATE_FREE:
1831	case TMTIMERSTATE_DESTROY:
1832	TM_UNLOCK_TIMERS(pVM);
1833	AssertLogRelMsgFailedReturn(("pTimer=%p %s\n", pTimer, tmTimerState(enmState)), VERR_TM_INVALID_STATE);
1834
1835	default:
1836	AssertMsgFailed(("Unknown timer state %d (%s)\n", enmState, R3STRING(pTimer->pszDesc)));
1837	TM_UNLOCK_TIMERS(pVM);
1838	return VERR_TM_UNKNOWN_STATE;
1839	}
1840
1841	/*
1842	* Try switch to the destroy state.
1843	* This should always succeed as the caller should make sure there are no race.
1844	*/
1845	bool fRc;
1846	TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_DESTROY, enmState, fRc);
1847	if (fRc)
1848	break;
1849	AssertMsgFailed(("%p:.enmState=%s %s\n", pTimer, tmTimerState(enmState), pTimer->pszDesc));
1850	TM_UNLOCK_TIMERS(pVM);
1851	AssertMsgReturn(cRetries > 0, ("Failed waiting for stable state. state=%d (%s)\n", pTimer->enmState, pTimer->pszDesc),
1852	VERR_TM_UNSTABLE_STATE);
1853	TM_LOCK_TIMERS(pVM);
1854	}
1855
1856	/*
1857	* Unlink from the active list.
1858	*/
1859	if (fActive)
1860	{
1861	const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
1862	const PTMTIMER pNext = TMTIMER_GET_NEXT(pTimer);
1863	if (pPrev)
1864	TMTIMER_SET_NEXT(pPrev, pNext);
1865	else
1866	{
1867	TMTIMER_SET_HEAD(pQueue, pNext);
1868	pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
1869	}
1870	if (pNext)
1871	TMTIMER_SET_PREV(pNext, pPrev);
1872	pTimer->offNext = 0;
1873	pTimer->offPrev = 0;
1874	}
1875
1876	/*
1877	* Unlink from the schedule list by running it.
1878	*/
1879	if (fPending)
1880	{
1881	Log3(("TMR3TimerDestroy: tmTimerQueueSchedule\n"));
1882	STAM_PROFILE_START(&pVM->tm.s.CTX_SUFF_Z(StatScheduleOne), a);
1883	Assert(pQueue->offSchedule);
1884	tmTimerQueueSchedule(pVM, pQueue);
1885	STAM_PROFILE_STOP(&pVM->tm.s.CTX_SUFF_Z(StatScheduleOne), a);
1886	}
1887
1888	/*
1889	* Deregister statistics.
1890	*/
1891	#ifdef VBOX_WITH_STATISTICS
1892	char szPrefix[128];
1893	RTStrPrintf(szPrefix, sizeof(szPrefix), "/TM/Timers/%s", pTimer->pszDesc);
1894	STAMR3DeregisterByPrefix(pVM->pUVM, szPrefix);
1895	#endif
1896
1897	/*
1898	* Ready to move the timer from the created list and onto the free list.
1899	*/
1900	Assert(!pTimer->offNext); Assert(!pTimer->offPrev); Assert(!pTimer->offScheduleNext);
1901
1902	/* unlink from created list */
1903	if (pTimer->pBigPrev)
1904	pTimer->pBigPrev->pBigNext = pTimer->pBigNext;
1905	else
1906	pVM->tm.s.pCreated = pTimer->pBigNext;
1907	if (pTimer->pBigNext)
1908	pTimer->pBigNext->pBigPrev = pTimer->pBigPrev;
1909	pTimer->pBigNext = 0;
1910	pTimer->pBigPrev = 0;
1911
1912	/* free */
1913	Log2(("TM: Inserting %p into the free list ahead of %p!\n", pTimer, pVM->tm.s.pFree));
1914	TM_SET_STATE(pTimer, TMTIMERSTATE_FREE);
1915	pTimer->pBigNext = pVM->tm.s.pFree;
1916	pVM->tm.s.pFree = pTimer;
1917
1918	#ifdef VBOX_STRICT
1919	tmTimerQueuesSanityChecks(pVM, "TMR3TimerDestroy");
1920	#endif
1921	TM_UNLOCK_TIMERS(pVM);
1922	return VINF_SUCCESS;
1923	}
1924
1925
1926	/**
1927	* Destroy a timer
1928	*
1929	* @returns VBox status code.
1930	* @param pVM The cross context VM structure.
1931	* @param hTimer Timer handle as returned by one of the create functions.
1932	*/
1933	VMMR3DECL(int) TMR3TimerDestroy(PVM pVM, TMTIMERHANDLE hTimer)
1934	{
1935	/* We ignore NILs here. */
1936	if (hTimer == NIL_TMTIMERHANDLE)
1937	return VINF_SUCCESS;
1938	PTMTIMER pTimer;
1939	TMTIMER_HANDLE_TO_PTR_RETURN(pVM, hTimer, pTimer);
1940	return tmR3TimerDestroy(pVM, pTimer);
1941	}
1942
1943
1944	/**
1945	* Destroy all timers owned by a device.
1946	*
1947	* @returns VBox status code.
1948	* @param pVM The cross context VM structure.
1949	* @param pDevIns Device which timers should be destroyed.
1950	*/
1951	VMM_INT_DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns)
1952	{
1953	LogFlow(("TMR3TimerDestroyDevice: pDevIns=%p\n", pDevIns));
1954	if (!pDevIns)
1955	return VERR_INVALID_PARAMETER;
1956
1957	TM_LOCK_TIMERS(pVM);
1958	PTMTIMER pCur = pVM->tm.s.pCreated;
1959	while (pCur)
1960	{
1961	PTMTIMER pDestroy = pCur;
1962	pCur = pDestroy->pBigNext;
1963	if ( pDestroy->enmType == TMTIMERTYPE_DEV
1964	&& pDestroy->u.Dev.pDevIns == pDevIns)
1965	{
1966	int rc = tmR3TimerDestroy(pVM, pDestroy);
1967	AssertRC(rc);
1968	}
1969	}
1970	TM_UNLOCK_TIMERS(pVM);
1971
1972	LogFlow(("TMR3TimerDestroyDevice: returns VINF_SUCCESS\n"));
1973	return VINF_SUCCESS;
1974	}
1975
1976
1977	/**
1978	* Destroy all timers owned by a USB device.
1979	*
1980	* @returns VBox status code.
1981	* @param pVM The cross context VM structure.
1982	* @param pUsbIns USB device which timers should be destroyed.
1983	*/
1984	VMM_INT_DECL(int) TMR3TimerDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns)
1985	{
1986	LogFlow(("TMR3TimerDestroyUsb: pUsbIns=%p\n", pUsbIns));
1987	if (!pUsbIns)
1988	return VERR_INVALID_PARAMETER;
1989
1990	TM_LOCK_TIMERS(pVM);
1991	PTMTIMER pCur = pVM->tm.s.pCreated;
1992	while (pCur)
1993	{
1994	PTMTIMER pDestroy = pCur;
1995	pCur = pDestroy->pBigNext;
1996	if ( pDestroy->enmType == TMTIMERTYPE_USB
1997	&& pDestroy->u.Usb.pUsbIns == pUsbIns)
1998	{
1999	int rc = tmR3TimerDestroy(pVM, pDestroy);
2000	AssertRC(rc);
2001	}
2002	}
2003	TM_UNLOCK_TIMERS(pVM);
2004
2005	LogFlow(("TMR3TimerDestroyUsb: returns VINF_SUCCESS\n"));
2006	return VINF_SUCCESS;
2007	}
2008
2009
2010	/**
2011	* Destroy all timers owned by a driver.
2012	*
2013	* @returns VBox status code.
2014	* @param pVM The cross context VM structure.
2015	* @param pDrvIns Driver which timers should be destroyed.
2016	*/
2017	VMM_INT_DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns)
2018	{
2019	LogFlow(("TMR3TimerDestroyDriver: pDrvIns=%p\n", pDrvIns));
2020	if (!pDrvIns)
2021	return VERR_INVALID_PARAMETER;
2022
2023	TM_LOCK_TIMERS(pVM);
2024	PTMTIMER pCur = pVM->tm.s.pCreated;
2025	while (pCur)
2026	{
2027	PTMTIMER pDestroy = pCur;
2028	pCur = pDestroy->pBigNext;
2029	if ( pDestroy->enmType == TMTIMERTYPE_DRV
2030	&& pDestroy->u.Drv.pDrvIns == pDrvIns)
2031	{
2032	int rc = tmR3TimerDestroy(pVM, pDestroy);
2033	AssertRC(rc);
2034	}
2035	}
2036	TM_UNLOCK_TIMERS(pVM);
2037
2038	LogFlow(("TMR3TimerDestroyDriver: returns VINF_SUCCESS\n"));
2039	return VINF_SUCCESS;
2040	}
2041
2042
2043	/**
2044	* Internal function for getting the clock time.
2045	*
2046	* @returns clock time.
2047	* @param pVM The cross context VM structure.
2048	* @param enmClock The clock.
2049	*/
2050	DECLINLINE(uint64_t) tmClock(PVM pVM, TMCLOCK enmClock)
2051	{
2052	switch (enmClock)
2053	{
2054	case TMCLOCK_VIRTUAL: return TMVirtualGet(pVM);
2055	case TMCLOCK_VIRTUAL_SYNC: return TMVirtualSyncGet(pVM);
2056	case TMCLOCK_REAL: return TMRealGet(pVM);
2057	case TMCLOCK_TSC: return TMCpuTickGet(pVM->apCpusR3[0] /* just take VCPU 0 */);
2058	default:
2059	AssertMsgFailed(("enmClock=%d\n", enmClock));
2060	return ~(uint64_t)0;
2061	}
2062	}
2063
2064
2065	/**
2066	* Checks if the sync queue has one or more expired timers.
2067	*
2068	* @returns true / false.
2069	*
2070	* @param pVM The cross context VM structure.
2071	* @param enmClock The queue.
2072	*/
2073	DECLINLINE(bool) tmR3HasExpiredTimer(PVM pVM, TMCLOCK enmClock)
2074	{
2075	const uint64_t u64Expire = pVM->tm.s.CTX_SUFF(paTimerQueues)[enmClock].u64Expire;
2076	return u64Expire != INT64_MAX && u64Expire <= tmClock(pVM, enmClock);
2077	}
2078
2079
2080	/**
2081	* Checks for expired timers in all the queues.
2082	*
2083	* @returns true / false.
2084	* @param pVM The cross context VM structure.
2085	*/
2086	DECLINLINE(bool) tmR3AnyExpiredTimers(PVM pVM)
2087	{
2088	/*
2089	* Combine the time calculation for the first two since we're not on EMT
2090	* TMVirtualSyncGet only permits EMT.
2091	*/
2092	uint64_t u64Now = TMVirtualGetNoCheck(pVM);
2093	if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL].u64Expire <= u64Now)
2094	return true;
2095	u64Now = pVM->tm.s.fVirtualSyncTicking
2096	? u64Now - pVM->tm.s.offVirtualSync
2097	: pVM->tm.s.u64VirtualSync;
2098	if (pVM->tm.s.CTX_SUFF(paTimerQueues)[TMCLOCK_VIRTUAL_SYNC].u64Expire <= u64Now)
2099	return true;
2100
2101	/*
2102	* The remaining timers.
2103	*/
2104	if (tmR3HasExpiredTimer(pVM, TMCLOCK_REAL))
2105	return true;
2106	if (tmR3HasExpiredTimer(pVM, TMCLOCK_TSC))
2107	return true;
2108	return false;
2109	}
2110
2111
2112	/**
2113	* Schedule timer callback.
2114	*
2115	* @param pTimer Timer handle.
2116	* @param pvUser Pointer to the VM.
2117	* @thread Timer thread.
2118	*
2119	* @remark We cannot do the scheduling and queues running from a timer handler
2120	* since it's not executing in EMT, and even if it was it would be async
2121	* and we wouldn't know the state of the affairs.
2122	* So, we'll just raise the timer FF and force any REM execution to exit.
2123	*/
2124	static DECLCALLBACK(void) tmR3TimerCallback(PRTTIMER pTimer, void pvUser, uint64_t /iTick*/)
2125	{
2126	PVM pVM = (PVM)pvUser;
2127	PVMCPU pVCpuDst = pVM->apCpusR3[pVM->tm.s.idTimerCpu];
2128	NOREF(pTimer);
2129
2130	AssertCompile(TMCLOCK_MAX == 4);
2131	STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallback);
2132
2133	#ifdef DEBUG_Sander /* very annoying, keep it private. */
2134	if (VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER))
2135	Log(("tmR3TimerCallback: timer event still pending!!\n"));
2136	#endif
2137	if ( !VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER)
2138	&& ( pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule /** @todo FIXME - reconsider offSchedule as a reason for running the timer queues. */
2139	\|\| pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule
2140	\|\| pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule
2141	\|\| pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offSchedule
2142	\|\| tmR3AnyExpiredTimers(pVM)
2143	)
2144	&& !VMCPU_FF_IS_SET(pVCpuDst, VMCPU_FF_TIMER)
2145	&& !pVM->tm.s.fRunningQueues
2146	)
2147	{
2148	Log5(("TM(%u): FF: 0 -> 1\n", __LINE__));
2149	VMCPU_FF_SET(pVCpuDst, VMCPU_FF_TIMER);
2150	VMR3NotifyCpuFFU(pVCpuDst->pUVCpu, VMNOTIFYFF_FLAGS_DONE_REM \| VMNOTIFYFF_FLAGS_POKE);
2151	STAM_COUNTER_INC(&pVM->tm.s.StatTimerCallbackSetFF);
2152	}
2153	}
2154
2155
2156	/**
2157	* Schedules and runs any pending timers.
2158	*
2159	* This is normally called from a forced action handler in EMT.
2160	*
2161	* @param pVM The cross context VM structure.
2162	*
2163	* @thread EMT (actually EMT0, but we fend off the others)
2164	*/
2165	VMMR3DECL(void) TMR3TimerQueuesDo(PVM pVM)
2166	{
2167	/*
2168	* Only the dedicated timer EMT should do stuff here.
2169	* (fRunningQueues is only used as an indicator.)
2170	*/
2171	Assert(pVM->tm.s.idTimerCpu < pVM->cCpus);
2172	PVMCPU pVCpuDst = pVM->apCpusR3[pVM->tm.s.idTimerCpu];
2173	if (VMMGetCpu(pVM) != pVCpuDst)
2174	{
2175	Assert(pVM->cCpus > 1);
2176	return;
2177	}
2178	STAM_PROFILE_START(&pVM->tm.s.StatDoQueues, a);
2179	Log2(("TMR3TimerQueuesDo:\n"));
2180	Assert(!pVM->tm.s.fRunningQueues);
2181	ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, true);
2182	TM_LOCK_TIMERS(pVM);
2183
2184	/*
2185	* Process the queues.
2186	*/
2187	AssertCompile(TMCLOCK_MAX == 4);
2188
2189	/* TMCLOCK_VIRTUAL_SYNC (see also TMR3VirtualSyncFF) */
2190	STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
2191	PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2192	ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2193	VMCPU_FF_CLEAR(pVCpuDst, VMCPU_FF_TIMER); /* Clear the FF once we started working for real. */
2194
2195	Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule);
2196	tmR3TimerQueueRunVirtualSync(pVM);
2197	if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2198	VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2199
2200	ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2201	PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2202	STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL_SYNC], s1);
2203
2204	/* TMCLOCK_VIRTUAL */
2205	STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
2206	if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL].offSchedule)
2207	tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
2208	tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL]);
2209	STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_VIRTUAL], s2);
2210
2211	/* TMCLOCK_TSC */
2212	Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_TSC].offActive); /* not used */
2213
2214	/* TMCLOCK_REAL */
2215	STAM_PROFILE_ADV_START(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
2216	if (pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL].offSchedule)
2217	tmTimerQueueSchedule(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
2218	tmR3TimerQueueRun(pVM, &pVM->tm.s.paTimerQueuesR3[TMCLOCK_REAL]);
2219	STAM_PROFILE_ADV_STOP(&pVM->tm.s.aStatDoQueues[TMCLOCK_REAL], s3);
2220
2221	#ifdef VBOX_STRICT
2222	/* check that we didn't screw up. */
2223	tmTimerQueuesSanityChecks(pVM, "TMR3TimerQueuesDo");
2224	#endif
2225
2226	/* done */
2227	Log2(("TMR3TimerQueuesDo: returns void\n"));
2228	ASMAtomicWriteBool(&pVM->tm.s.fRunningQueues, false);
2229	TM_UNLOCK_TIMERS(pVM);
2230	STAM_PROFILE_STOP(&pVM->tm.s.StatDoQueues, a);
2231	}
2232
2233	//RT_C_DECLS_BEGIN
2234	//int iomLock(PVM pVM);
2235	//void iomUnlock(PVM pVM);
2236	//RT_C_DECLS_END
2237
2238
2239	/**
2240	* Schedules and runs any pending times in the specified queue.
2241	*
2242	* This is normally called from a forced action handler in EMT.
2243	*
2244	* @param pVM The cross context VM structure.
2245	* @param pQueue The queue to run.
2246	*/
2247	static void tmR3TimerQueueRun(PVM pVM, PTMTIMERQUEUE pQueue)
2248	{
2249	VM_ASSERT_EMT(pVM);
2250
2251	/*
2252	* Run timers.
2253	*
2254	* We check the clock once and run all timers which are ACTIVE
2255	* and have an expire time less or equal to the time we read.
2256	*
2257	* N.B. A generic unlink must be applied since other threads
2258	* are allowed to mess with any active timer at any time.
2259	* However, we only allow EMT to handle EXPIRED_PENDING
2260	* timers, thus enabling the timer handler function to
2261	* arm the timer again.
2262	*/
2263	PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
2264	if (!pNext)
2265	return;
2266	const uint64_t u64Now = tmClock(pVM, pQueue->enmClock);
2267	while (pNext && pNext->u64Expire <= u64Now)
2268	{
2269	PTMTIMER pTimer = pNext;
2270	pNext = TMTIMER_GET_NEXT(pTimer);
2271	PPDMCRITSECT pCritSect = pTimer->pCritSect;
2272	if (pCritSect)
2273	{
2274	STAM_PROFILE_START(&pTimer->StatCritSectEnter, Locking);
2275	PDMCritSectEnter(pCritSect, VERR_IGNORED);
2276	STAM_PROFILE_STOP(&pTimer->StatCritSectEnter, Locking);
2277	}
2278	Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
2279	pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
2280	bool fRc;
2281	TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_GET_UNLINK, TMTIMERSTATE_ACTIVE, fRc);
2282	if (fRc)
2283	{
2284	Assert(!pTimer->offScheduleNext); /* this can trigger falsely */
2285
2286	/* unlink */
2287	const PTMTIMER pPrev = TMTIMER_GET_PREV(pTimer);
2288	if (pPrev)
2289	TMTIMER_SET_NEXT(pPrev, pNext);
2290	else
2291	{
2292	TMTIMER_SET_HEAD(pQueue, pNext);
2293	pQueue->u64Expire = pNext ? pNext->u64Expire : INT64_MAX;
2294	}
2295	if (pNext)
2296	TMTIMER_SET_PREV(pNext, pPrev);
2297	pTimer->offNext = 0;
2298	pTimer->offPrev = 0;
2299
2300	/* fire */
2301	TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2302	STAM_PROFILE_START(&pTimer->StatTimer, PrfTimer);
2303	switch (pTimer->enmType)
2304	{
2305	case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer, pTimer->pvUser); break;
2306	case TMTIMERTYPE_USB: pTimer->u.Usb.pfnTimer(pTimer->u.Usb.pUsbIns, pTimer, pTimer->pvUser); break;
2307	case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer, pTimer->pvUser); break;
2308	case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer->hSelf, pTimer->pvUser); break;
2309	default:
2310	AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2311	break;
2312	}
2313	STAM_PROFILE_STOP(&pTimer->StatTimer, PrfTimer);
2314
2315	/* change the state if it wasn't changed already in the handler. */
2316	TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2317	Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2318	}
2319	if (pCritSect)
2320	PDMCritSectLeave(pCritSect);
2321	} /* run loop */
2322	}
2323
2324
2325	/**
2326	* Schedules and runs any pending times in the timer queue for the
2327	* synchronous virtual clock.
2328	*
2329	* This scheduling is a bit different from the other queues as it need
2330	* to implement the special requirements of the timer synchronous virtual
2331	* clock, thus this 2nd queue run function.
2332	*
2333	* @param pVM The cross context VM structure.
2334	*
2335	* @remarks The caller must the Virtual Sync lock. Owning the TM lock is no
2336	* longer important.
2337	*/
2338	static void tmR3TimerQueueRunVirtualSync(PVM pVM)
2339	{
2340	PTMTIMERQUEUE const pQueue = &pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC];
2341	VM_ASSERT_EMT(pVM);
2342	Assert(PDMCritSectIsOwner(&pVM->tm.s.VirtualSyncLock));
2343
2344	/*
2345	* Any timers?
2346	*/
2347	PTMTIMER pNext = TMTIMER_GET_HEAD(pQueue);
2348	if (RT_UNLIKELY(!pNext))
2349	{
2350	Assert(pVM->tm.s.fVirtualSyncTicking \|\| !pVM->tm.s.cVirtualTicking);
2351	return;
2352	}
2353	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRun);
2354
2355	/*
2356	* Calculate the time frame for which we will dispatch timers.
2357	*
2358	* We use a time frame ranging from the current sync time (which is most likely the
2359	* same as the head timer) and some configurable period (100000ns) up towards the
2360	* current virtual time. This period might also need to be restricted by the catch-up
2361	* rate so frequent calls to this function won't accelerate the time too much, however
2362	* this will be implemented at a later point if necessary.
2363	*
2364	* Without this frame we would 1) having to run timers much more frequently
2365	* and 2) lag behind at a steady rate.
2366	*/
2367	const uint64_t u64VirtualNow = TMVirtualGetNoCheck(pVM);
2368	uint64_t const offSyncGivenUp = pVM->tm.s.offVirtualSyncGivenUp;
2369	uint64_t u64Now;
2370	if (!pVM->tm.s.fVirtualSyncTicking)
2371	{
2372	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStoppedAlready);
2373	u64Now = pVM->tm.s.u64VirtualSync;
2374	Assert(u64Now <= pNext->u64Expire);
2375	}
2376	else
2377	{
2378	/* Calc 'now'. */
2379	bool fStopCatchup = false;
2380	bool fUpdateStuff = false;
2381	uint64_t off = pVM->tm.s.offVirtualSync;
2382	if (pVM->tm.s.fVirtualSyncCatchUp)
2383	{
2384	uint64_t u64Delta = u64VirtualNow - pVM->tm.s.u64VirtualSyncCatchUpPrev;
2385	if (RT_LIKELY(!(u64Delta >> 32)))
2386	{
2387	uint64_t u64Sub = ASMMultU64ByU32DivByU32(u64Delta, pVM->tm.s.u32VirtualSyncCatchUpPercentage, 100);
2388	if (off > u64Sub + offSyncGivenUp)
2389	{
2390	off -= u64Sub;
2391	Log4(("TM: %'RU64/-%'8RU64: sub %'RU64 [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow - off, off - offSyncGivenUp, u64Sub));
2392	}
2393	else
2394	{
2395	STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2396	fStopCatchup = true;
2397	off = offSyncGivenUp;
2398	}
2399	fUpdateStuff = true;
2400	}
2401	}
2402	u64Now = u64VirtualNow - off;
2403
2404	/* Adjust against last returned time. */
2405	uint64_t u64Last = ASMAtomicUoReadU64(&pVM->tm.s.u64VirtualSync);
2406	if (u64Last > u64Now)
2407	{
2408	u64Now = u64Last + 1;
2409	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGetAdjLast);
2410	}
2411
2412	/* Check if stopped by expired timer. */
2413	uint64_t const u64Expire = pNext->u64Expire;
2414	if (u64Now >= u64Expire)
2415	{
2416	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunStop);
2417	u64Now = u64Expire;
2418	ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2419	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
2420	Log4(("TM: %'RU64/-%'8RU64: exp tmr [tmR3TimerQueueRunVirtualSync]\n", u64Now, u64VirtualNow - u64Now - offSyncGivenUp));
2421	}
2422	else
2423	{
2424	ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2425	if (fUpdateStuff)
2426	{
2427	ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, off);
2428	ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSyncCatchUpPrev, u64VirtualNow);
2429	ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, u64Now);
2430	if (fStopCatchup)
2431	{
2432	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2433	Log4(("TM: %'RU64/0: caught up [tmR3TimerQueueRunVirtualSync]\n", u64VirtualNow));
2434	}
2435	}
2436	}
2437	}
2438
2439	/* calc end of frame. */
2440	uint64_t u64Max = u64Now + pVM->tm.s.u32VirtualSyncScheduleSlack;
2441	if (u64Max > u64VirtualNow - offSyncGivenUp)
2442	u64Max = u64VirtualNow - offSyncGivenUp;
2443
2444	/* assert sanity */
2445	Assert(u64Now <= u64VirtualNow - offSyncGivenUp);
2446	Assert(u64Max <= u64VirtualNow - offSyncGivenUp);
2447	Assert(u64Now <= u64Max);
2448	Assert(offSyncGivenUp == pVM->tm.s.offVirtualSyncGivenUp);
2449
2450	/*
2451	* Process the expired timers moving the clock along as we progress.
2452	*/
2453	#ifdef VBOX_STRICT
2454	uint64_t u64Prev = u64Now; NOREF(u64Prev);
2455	#endif
2456	while (pNext && pNext->u64Expire <= u64Max)
2457	{
2458	/* Advance */
2459	PTMTIMER pTimer = pNext;
2460	pNext = TMTIMER_GET_NEXT(pTimer);
2461
2462	/* Take the associated lock. */
2463	PPDMCRITSECT pCritSect = pTimer->pCritSect;
2464	if (pCritSect)
2465	{
2466	STAM_PROFILE_START(&pTimer->StatCritSectEnter, Locking);
2467	PDMCritSectEnter(pCritSect, VERR_IGNORED);
2468	STAM_PROFILE_STOP(&pTimer->StatCritSectEnter, Locking);
2469	}
2470
2471	Log2(("tmR3TimerQueueRun: %p:{.enmState=%s, .enmClock=%d, .enmType=%d, u64Expire=%llx (now=%llx) .pszDesc=%s}\n",
2472	pTimer, tmTimerState(pTimer->enmState), pTimer->enmClock, pTimer->enmType, pTimer->u64Expire, u64Now, pTimer->pszDesc));
2473
2474	/* Advance the clock - don't permit timers to be out of order or armed
2475	in the 'past'. */
2476	#ifdef VBOX_STRICT
2477	AssertMsg(pTimer->u64Expire >= u64Prev, ("%'RU64 < %'RU64 %s\n", pTimer->u64Expire, u64Prev, pTimer->pszDesc));
2478	u64Prev = pTimer->u64Expire;
2479	#endif
2480	ASMAtomicWriteU64(&pVM->tm.s.u64VirtualSync, pTimer->u64Expire);
2481	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, false);
2482
2483	/* Unlink it, change the state and do the callout. */
2484	tmTimerQueueUnlinkActive(pQueue, pTimer);
2485	TM_SET_STATE(pTimer, TMTIMERSTATE_EXPIRED_DELIVER);
2486	STAM_PROFILE_START(&pTimer->StatTimer, PrfTimer);
2487	switch (pTimer->enmType)
2488	{
2489	case TMTIMERTYPE_DEV: pTimer->u.Dev.pfnTimer(pTimer->u.Dev.pDevIns, pTimer, pTimer->pvUser); break;
2490	case TMTIMERTYPE_USB: pTimer->u.Usb.pfnTimer(pTimer->u.Usb.pUsbIns, pTimer, pTimer->pvUser); break;
2491	case TMTIMERTYPE_DRV: pTimer->u.Drv.pfnTimer(pTimer->u.Drv.pDrvIns, pTimer, pTimer->pvUser); break;
2492	case TMTIMERTYPE_INTERNAL: pTimer->u.Internal.pfnTimer(pVM, pTimer->hSelf, pTimer->pvUser); break;
2493	default:
2494	AssertMsgFailed(("Invalid timer type %d (%s)\n", pTimer->enmType, pTimer->pszDesc));
2495	break;
2496	}
2497	STAM_PROFILE_STOP(&pTimer->StatTimer, PrfTimer);
2498
2499	/* Change the state if it wasn't changed already in the handler.
2500	Reset the Hz hint too since this is the same as TMTimerStop. */
2501	bool fRc;
2502	TM_TRY_SET_STATE(pTimer, TMTIMERSTATE_STOPPED, TMTIMERSTATE_EXPIRED_DELIVER, fRc);
2503	if (fRc && pTimer->uHzHint)
2504	{
2505	if (pTimer->uHzHint >= pVM->tm.s.uMaxHzHint)
2506	ASMAtomicWriteBool(&pVM->tm.s.fHzHintNeedsUpdating, true);
2507	pTimer->uHzHint = 0;
2508	}
2509	Log2(("tmR3TimerQueueRun: new state %s\n", tmTimerState(pTimer->enmState)));
2510
2511	/* Leave the associated lock. */
2512	if (pCritSect)
2513	PDMCritSectLeave(pCritSect);
2514	} /* run loop */
2515
2516
2517	/*
2518	* Restart the clock if it was stopped to serve any timers,
2519	* and start/adjust catch-up if necessary.
2520	*/
2521	if ( !pVM->tm.s.fVirtualSyncTicking
2522	&& pVM->tm.s.cVirtualTicking)
2523	{
2524	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncRunRestart);
2525
2526	/* calc the slack we've handed out. */
2527	const uint64_t u64VirtualNow2 = TMVirtualGetNoCheck(pVM);
2528	Assert(u64VirtualNow2 >= u64VirtualNow);
2529	AssertMsg(pVM->tm.s.u64VirtualSync >= u64Now, ("%'RU64 < %'RU64\n", pVM->tm.s.u64VirtualSync, u64Now));
2530	const uint64_t offSlack = pVM->tm.s.u64VirtualSync - u64Now;
2531	STAM_STATS({
2532	if (offSlack)
2533	{
2534	PSTAMPROFILE p = &pVM->tm.s.StatVirtualSyncRunSlack;
2535	p->cPeriods++;
2536	p->cTicks += offSlack;
2537	if (p->cTicksMax < offSlack) p->cTicksMax = offSlack;
2538	if (p->cTicksMin > offSlack) p->cTicksMin = offSlack;
2539	}
2540	});
2541
2542	/* Let the time run a little bit while we were busy running timers(?). */
2543	uint64_t u64Elapsed;
2544	#define MAX_ELAPSED 30000U /* ns */
2545	if (offSlack > MAX_ELAPSED)
2546	u64Elapsed = 0;
2547	else
2548	{
2549	u64Elapsed = u64VirtualNow2 - u64VirtualNow;
2550	if (u64Elapsed > MAX_ELAPSED)
2551	u64Elapsed = MAX_ELAPSED;
2552	u64Elapsed = u64Elapsed > offSlack ? u64Elapsed - offSlack : 0;
2553	}
2554	#undef MAX_ELAPSED
2555
2556	/* Calc the current offset. */
2557	uint64_t offNew = u64VirtualNow2 - pVM->tm.s.u64VirtualSync - u64Elapsed;
2558	Assert(!(offNew & RT_BIT_64(63)));
2559	uint64_t offLag = offNew - pVM->tm.s.offVirtualSyncGivenUp;
2560	Assert(!(offLag & RT_BIT_64(63)));
2561
2562	/*
2563	* Deal with starting, adjusting and stopping catchup.
2564	*/
2565	if (pVM->tm.s.fVirtualSyncCatchUp)
2566	{
2567	if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpStopThreshold)
2568	{
2569	/* stop */
2570	STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2571	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2572	Log4(("TM: %'RU64/-%'8RU64: caught up [pt]\n", u64VirtualNow2 - offNew, offLag));
2573	}
2574	else if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2575	{
2576	/* adjust */
2577	unsigned i = 0;
2578	while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2579	&& offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2580	i++;
2581	if (pVM->tm.s.u32VirtualSyncCatchUpPercentage < pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage)
2582	{
2583	STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupAdjust[i]);
2584	ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2585	Log4(("TM: %'RU64/%'8RU64: adj %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2586	}
2587	pVM->tm.s.u64VirtualSyncCatchUpPrev = u64VirtualNow2;
2588	}
2589	else
2590	{
2591	/* give up */
2592	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUp);
2593	STAM_PROFILE_ADV_STOP(&pVM->tm.s.StatVirtualSyncCatchup, c);
2594	ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2595	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, false);
2596	Log4(("TM: %'RU64/%'8RU64: give up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2597	LogRel(("TM: Giving up catch-up attempt at a %'RU64 ns lag; new total: %'RU64 ns\n", offLag, offNew));
2598	}
2599	}
2600	else if (offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[0].u64Start)
2601	{
2602	if (offLag <= pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold)
2603	{
2604	/* start */
2605	STAM_PROFILE_ADV_START(&pVM->tm.s.StatVirtualSyncCatchup, c);
2606	unsigned i = 0;
2607	while ( i + 1 < RT_ELEMENTS(pVM->tm.s.aVirtualSyncCatchUpPeriods)
2608	&& offLag >= pVM->tm.s.aVirtualSyncCatchUpPeriods[i + 1].u64Start)
2609	i++;
2610	STAM_COUNTER_INC(&pVM->tm.s.aStatVirtualSyncCatchupInitial[i]);
2611	ASMAtomicWriteU32(&pVM->tm.s.u32VirtualSyncCatchUpPercentage, pVM->tm.s.aVirtualSyncCatchUpPeriods[i].u32Percentage);
2612	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncCatchUp, true);
2613	Log4(("TM: %'RU64/%'8RU64: catch-up %u%%\n", u64VirtualNow2 - offNew, offLag, pVM->tm.s.u32VirtualSyncCatchUpPercentage));
2614	}
2615	else
2616	{
2617	/* don't bother */
2618	STAM_COUNTER_INC(&pVM->tm.s.StatVirtualSyncGiveUpBeforeStarting);
2619	ASMAtomicWriteU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp, offNew);
2620	Log4(("TM: %'RU64/%'8RU64: give up\n", u64VirtualNow2 - offNew, offLag));
2621	LogRel(("TM: Not bothering to attempt catching up a %'RU64 ns lag; new total: %'RU64\n", offLag, offNew));
2622	}
2623	}
2624
2625	/*
2626	* Update the offset and restart the clock.
2627	*/
2628	Assert(!(offNew & RT_BIT_64(63)));
2629	ASMAtomicWriteU64(&pVM->tm.s.offVirtualSync, offNew);
2630	ASMAtomicWriteBool(&pVM->tm.s.fVirtualSyncTicking, true);
2631	}
2632	}
2633
2634
2635	/**
2636	* Deals with stopped Virtual Sync clock.
2637	*
2638	* This is called by the forced action flag handling code in EM when it
2639	* encounters the VM_FF_TM_VIRTUAL_SYNC flag. It is called by all VCPUs and they
2640	* will block on the VirtualSyncLock until the pending timers has been executed
2641	* and the clock restarted.
2642	*
2643	* @param pVM The cross context VM structure.
2644	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
2645	*
2646	* @thread EMTs
2647	*/
2648	VMMR3_INT_DECL(void) TMR3VirtualSyncFF(PVM pVM, PVMCPU pVCpu)
2649	{
2650	Log2(("TMR3VirtualSyncFF:\n"));
2651
2652	/*
2653	* The EMT doing the timers is diverted to them.
2654	*/
2655	if (pVCpu->idCpu == pVM->tm.s.idTimerCpu)
2656	TMR3TimerQueuesDo(pVM);
2657	/*
2658	* The other EMTs will block on the virtual sync lock and the first owner
2659	* will run the queue and thus restarting the clock.
2660	*
2661	* Note! This is very suboptimal code wrt to resuming execution when there
2662	* are more than two Virtual CPUs, since they will all have to enter
2663	* the critical section one by one. But it's a very simple solution
2664	* which will have to do the job for now.
2665	*/
2666	else
2667	{
2668	STAM_PROFILE_START(&pVM->tm.s.StatVirtualSyncFF, a);
2669	PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2670	if (pVM->tm.s.fVirtualSyncTicking)
2671	{
2672	STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2673	PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2674	Log2(("TMR3VirtualSyncFF: ticking\n"));
2675	}
2676	else
2677	{
2678	PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2679
2680	/* try run it. */
2681	TM_LOCK_TIMERS(pVM);
2682	PDMCritSectEnter(&pVM->tm.s.VirtualSyncLock, VERR_IGNORED);
2683	if (pVM->tm.s.fVirtualSyncTicking)
2684	Log2(("TMR3VirtualSyncFF: ticking (2)\n"));
2685	else
2686	{
2687	ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, true);
2688	Log2(("TMR3VirtualSyncFF: running queue\n"));
2689
2690	Assert(!pVM->tm.s.paTimerQueuesR3[TMCLOCK_VIRTUAL_SYNC].offSchedule);
2691	tmR3TimerQueueRunVirtualSync(pVM);
2692	if (pVM->tm.s.fVirtualSyncTicking) /** @todo move into tmR3TimerQueueRunVirtualSync - FIXME */
2693	VM_FF_CLEAR(pVM, VM_FF_TM_VIRTUAL_SYNC);
2694
2695	ASMAtomicWriteBool(&pVM->tm.s.fRunningVirtualSyncQueue, false);
2696	}
2697	STAM_PROFILE_STOP(&pVM->tm.s.StatVirtualSyncFF, a); /* before the unlock! */
2698	PDMCritSectLeave(&pVM->tm.s.VirtualSyncLock);
2699	TM_UNLOCK_TIMERS(pVM);
2700	}
2701	}
2702	}
2703
2704
2705	/** @name Saved state values
2706	* @{ */
2707	#define TMTIMERSTATE_SAVED_PENDING_STOP 4
2708	#define TMTIMERSTATE_SAVED_PENDING_SCHEDULE 7
2709	/** @} */
2710
2711
2712	/**
2713	* Saves the state of a timer to a saved state.
2714	*
2715	* @returns VBox status code.
2716	* @param pVM The cross context VM structure.
2717	* @param hTimer Timer to save.
2718	* @param pSSM Save State Manager handle.
2719	*/
2720	VMMR3DECL(int) TMR3TimerSave(PVM pVM, TMTIMERHANDLE hTimer, PSSMHANDLE pSSM)
2721	{
2722	VM_ASSERT_EMT(pVM);
2723	PTMTIMER pTimer;
2724	TMTIMER_HANDLE_TO_PTR_RETURN(pVM, hTimer, pTimer);
2725	LogFlow(("TMR3TimerSave: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2726
2727	switch (pTimer->enmState)
2728	{
2729	case TMTIMERSTATE_STOPPED:
2730	case TMTIMERSTATE_PENDING_STOP:
2731	case TMTIMERSTATE_PENDING_STOP_SCHEDULE:
2732	return SSMR3PutU8(pSSM, TMTIMERSTATE_SAVED_PENDING_STOP);
2733
2734	case TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE:
2735	case TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE:
2736	AssertMsgFailed(("u64Expire is being updated! (%s)\n", pTimer->pszDesc));
2737	if (!RTThreadYield())
2738	RTThreadSleep(1);
2739	RT_FALL_THRU();
2740	case TMTIMERSTATE_ACTIVE:
2741	case TMTIMERSTATE_PENDING_SCHEDULE:
2742	case TMTIMERSTATE_PENDING_RESCHEDULE:
2743	SSMR3PutU8(pSSM, TMTIMERSTATE_SAVED_PENDING_SCHEDULE);
2744	return SSMR3PutU64(pSSM, pTimer->u64Expire);
2745
2746	case TMTIMERSTATE_EXPIRED_GET_UNLINK:
2747	case TMTIMERSTATE_EXPIRED_DELIVER:
2748	case TMTIMERSTATE_DESTROY:
2749	case TMTIMERSTATE_FREE:
2750	AssertMsgFailed(("Invalid timer state %d %s (%s)\n", pTimer->enmState, tmTimerState(pTimer->enmState), pTimer->pszDesc));
2751	return SSMR3HandleSetStatus(pSSM, VERR_TM_INVALID_STATE);
2752	}
2753
2754	AssertMsgFailed(("Unknown timer state %d (%s)\n", pTimer->enmState, pTimer->pszDesc));
2755	return SSMR3HandleSetStatus(pSSM, VERR_TM_UNKNOWN_STATE);
2756	}
2757
2758
2759	/**
2760	* Loads the state of a timer from a saved state.
2761	*
2762	* @returns VBox status code.
2763	* @param pVM The cross context VM structure.
2764	* @param hTimer Handle of Timer to restore.
2765	* @param pSSM Save State Manager handle.
2766	*/
2767	VMMR3DECL(int) TMR3TimerLoad(PVM pVM, TMTIMERHANDLE hTimer, PSSMHANDLE pSSM)
2768	{
2769	VM_ASSERT_EMT(pVM);
2770	PTMTIMER pTimer;
2771	TMTIMER_HANDLE_TO_PTR_RETURN(pVM, hTimer, pTimer);
2772	Assert(pSSM);
2773	LogFlow(("TMR3TimerLoad: %p:{enmState=%s, .pszDesc={%s}} pSSM=%p\n", pTimer, tmTimerState(pTimer->enmState), pTimer->pszDesc, pSSM));
2774
2775	/*
2776	* Load the state and validate it.
2777	*/
2778	uint8_t u8State;
2779	int rc = SSMR3GetU8(pSSM, &u8State);
2780	if (RT_FAILURE(rc))
2781	return rc;
2782
2783	/* TMTIMERSTATE_SAVED_XXX: Workaround for accidental state shift in r47786 (2009-05-26 19:12:12). */
2784	if ( u8State == TMTIMERSTATE_SAVED_PENDING_STOP + 1
2785	\|\| u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE + 1)
2786	u8State--;
2787
2788	if ( u8State != TMTIMERSTATE_SAVED_PENDING_STOP
2789	&& u8State != TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2790	{
2791	AssertLogRelMsgFailed(("u8State=%d\n", u8State));
2792	return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2793	}
2794
2795	/* Enter the critical sections to make TMTimerSet/Stop happy. */
2796	if (pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC)
2797	PDMCritSectEnter(&pTimer->pVMR3->tm.s.VirtualSyncLock, VERR_IGNORED);
2798	PPDMCRITSECT pCritSect = pTimer->pCritSect;
2799	if (pCritSect)
2800	PDMCritSectEnter(pCritSect, VERR_IGNORED);
2801
2802	if (u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2803	{
2804	/*
2805	* Load the expire time.
2806	*/
2807	uint64_t u64Expire;
2808	rc = SSMR3GetU64(pSSM, &u64Expire);
2809	if (RT_FAILURE(rc))
2810	return rc;
2811
2812	/*
2813	* Set it.
2814	*/
2815	Log(("u8State=%d u64Expire=%llu\n", u8State, u64Expire));
2816	rc = TMTimerSet(pVM, hTimer, u64Expire);
2817	}
2818	else
2819	{
2820	/*
2821	* Stop it.
2822	*/
2823	Log(("u8State=%d\n", u8State));
2824	rc = TMTimerStop(pVM, hTimer);
2825	}
2826
2827	if (pCritSect)
2828	PDMCritSectLeave(pCritSect);
2829	if (pTimer->enmClock == TMCLOCK_VIRTUAL_SYNC)
2830	PDMCritSectLeave(&pTimer->pVMR3->tm.s.VirtualSyncLock);
2831
2832	/*
2833	* On failure set SSM status.
2834	*/
2835	if (RT_FAILURE(rc))
2836	rc = SSMR3HandleSetStatus(pSSM, rc);
2837	return rc;
2838	}
2839
2840
2841	/**
2842	* Skips the state of a timer in a given saved state.
2843	*
2844	* @returns VBox status.
2845	* @param pSSM Save State Manager handle.
2846	* @param pfActive Where to store whether the timer was active
2847	* when the state was saved.
2848	*/
2849	VMMR3DECL(int) TMR3TimerSkip(PSSMHANDLE pSSM, bool *pfActive)
2850	{
2851	Assert(pSSM); AssertPtr(pfActive);
2852	LogFlow(("TMR3TimerSkip: pSSM=%p pfActive=%p\n", pSSM, pfActive));
2853
2854	/*
2855	* Load the state and validate it.
2856	*/
2857	uint8_t u8State;
2858	int rc = SSMR3GetU8(pSSM, &u8State);
2859	if (RT_FAILURE(rc))
2860	return rc;
2861
2862	/* TMTIMERSTATE_SAVED_XXX: Workaround for accidental state shift in r47786 (2009-05-26 19:12:12). */
2863	if ( u8State == TMTIMERSTATE_SAVED_PENDING_STOP + 1
2864	\|\| u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE + 1)
2865	u8State--;
2866
2867	if ( u8State != TMTIMERSTATE_SAVED_PENDING_STOP
2868	&& u8State != TMTIMERSTATE_SAVED_PENDING_SCHEDULE)
2869	{
2870	AssertLogRelMsgFailed(("u8State=%d\n", u8State));
2871	return SSMR3HandleSetStatus(pSSM, VERR_TM_LOAD_STATE);
2872	}
2873
2874	*pfActive = (u8State == TMTIMERSTATE_SAVED_PENDING_SCHEDULE);
2875	if (*pfActive)
2876	{
2877	/*
2878	* Load the expire time.
2879	*/
2880	uint64_t u64Expire;
2881	rc = SSMR3GetU64(pSSM, &u64Expire);
2882	}
2883
2884	return rc;
2885	}
2886
2887
2888	/**
2889	* Associates a critical section with a timer.
2890	*
2891	* The critical section will be entered prior to doing the timer call back, thus
2892	* avoiding potential races between the timer thread and other threads trying to
2893	* stop or adjust the timer expiration while it's being delivered. The timer
2894	* thread will leave the critical section when the timer callback returns.
2895	*
2896	* In strict builds, ownership of the critical section will be asserted by
2897	* TMTimerSet, TMTimerStop, TMTimerGetExpire and TMTimerDestroy (when called at
2898	* runtime).
2899	*
2900	* @retval VINF_SUCCESS on success.
2901	* @retval VERR_INVALID_HANDLE if the timer handle is NULL or invalid
2902	* (asserted).
2903	* @retval VERR_INVALID_PARAMETER if pCritSect is NULL or has an invalid magic
2904	* (asserted).
2905	* @retval VERR_ALREADY_EXISTS if a critical section was already associated
2906	* with the timer (asserted).
2907	* @retval VERR_INVALID_STATE if the timer isn't stopped.
2908	*
2909	* @param pTimer The timer handle.
2910	* @param pCritSect The critical section. The caller must make sure this
2911	* is around for the life time of the timer.
2912	*
2913	* @thread Any, but the caller is responsible for making sure the timer is not
2914	* active.
2915	*/
2916	VMMR3DECL(int) TMR3TimerSetCritSect(PVM pVM, TMTIMERHANDLE hTimer, PPDMCRITSECT pCritSect)
2917	{
2918	PTMTIMER pTimer;
2919	TMTIMER_HANDLE_TO_PTR_RETURN(pVM, hTimer, pTimer);
2920	AssertPtrReturn(pCritSect, VERR_INVALID_PARAMETER);
2921	const char pszName = PDMR3CritSectName(pCritSect); / exploited for validation */
2922	AssertReturn(pszName, VERR_INVALID_PARAMETER);
2923	AssertReturn(!pTimer->pCritSect, VERR_ALREADY_EXISTS);
2924	AssertReturn(pTimer->enmState == TMTIMERSTATE_STOPPED, VERR_INVALID_STATE);
2925	LogFlow(("pTimer=%p (%s) pCritSect=%p (%s)\n", pTimer, pTimer->pszDesc, pCritSect, pszName));
2926
2927	pTimer->pCritSect = pCritSect;
2928	return VINF_SUCCESS;
2929	}
2930
2931
2932	/**
2933	* Get the real world UTC time adjusted for VM lag.
2934	*
2935	* @returns pTime.
2936	* @param pVM The cross context VM structure.
2937	* @param pTime Where to store the time.
2938	*/
2939	VMMR3_INT_DECL(PRTTIMESPEC) TMR3UtcNow(PVM pVM, PRTTIMESPEC pTime)
2940	{
2941	/*
2942	* Get a stable set of VirtualSync parameters and calc the lag.
2943	*/
2944	uint64_t offVirtualSync;
2945	uint64_t offVirtualSyncGivenUp;
2946	do
2947	{
2948	offVirtualSync = ASMAtomicReadU64(&pVM->tm.s.offVirtualSync);
2949	offVirtualSyncGivenUp = ASMAtomicReadU64((uint64_t volatile *)&pVM->tm.s.offVirtualSyncGivenUp);
2950	} while (ASMAtomicReadU64(&pVM->tm.s.offVirtualSync) != offVirtualSync);
2951
2952	Assert(offVirtualSync >= offVirtualSyncGivenUp);
2953	uint64_t const offLag = offVirtualSync - offVirtualSyncGivenUp;
2954
2955	/*
2956	* Get current time and adjust for virtual sync lag and do time displacement.
2957	*/
2958	RTTimeNow(pTime);
2959	RTTimeSpecSubNano(pTime, offLag);
2960	RTTimeSpecAddNano(pTime, pVM->tm.s.offUTC);
2961
2962	/*
2963	* Log details if the time changed radically (also triggers on first call).
2964	*/
2965	int64_t nsPrev = ASMAtomicXchgS64(&pVM->tm.s.nsLastUtcNow, RTTimeSpecGetNano(pTime));
2966	int64_t cNsDelta = RTTimeSpecGetNano(pTime) - nsPrev;
2967	if ((uint64_t)RT_ABS(cNsDelta) > RT_NS_1HOUR / 2)
2968	{
2969	RTTIMESPEC NowAgain;
2970	RTTimeNow(&NowAgain);
2971	LogRel(("TMR3UtcNow: nsNow=%'RI64 nsPrev=%'RI64 -> cNsDelta=%'RI64 (offLag=%'RI64 offVirtualSync=%'RU64 offVirtualSyncGivenUp=%'RU64, NowAgain=%'RI64)\n",
2972	RTTimeSpecGetNano(pTime), nsPrev, cNsDelta, offLag, offVirtualSync, offVirtualSyncGivenUp, RTTimeSpecGetNano(&NowAgain)));
2973	if (pVM->tm.s.pszUtcTouchFileOnJump && nsPrev != 0)
2974	{
2975	RTFILE hFile;
2976	int rc = RTFileOpen(&hFile, pVM->tm.s.pszUtcTouchFileOnJump,
2977	RTFILE_O_WRITE \| RTFILE_O_APPEND \| RTFILE_O_OPEN_CREATE \| RTFILE_O_DENY_NONE);
2978	if (RT_SUCCESS(rc))
2979	{
2980	char szMsg[256];
2981	size_t cch;
2982	cch = RTStrPrintf(szMsg, sizeof(szMsg),
2983	"TMR3UtcNow: nsNow=%'RI64 nsPrev=%'RI64 -> cNsDelta=%'RI64 (offLag=%'RI64 offVirtualSync=%'RU64 offVirtualSyncGivenUp=%'RU64, NowAgain=%'RI64)\n",
2984	RTTimeSpecGetNano(pTime), nsPrev, cNsDelta, offLag, offVirtualSync, offVirtualSyncGivenUp, RTTimeSpecGetNano(&NowAgain));
2985	RTFileWrite(hFile, szMsg, cch, NULL);
2986	RTFileClose(hFile);
2987	}
2988	}
2989	}
2990
2991	return pTime;
2992	}
2993
2994
2995	/**
2996	* Pauses all clocks except TMCLOCK_REAL.
2997	*
2998	* @returns VBox status code, all errors are asserted.
2999	* @param pVM The cross context VM structure.
3000	* @param pVCpu The cross context virtual CPU structure.
3001	* @thread EMT corresponding to Pointer to the VMCPU.
3002	*/
3003	VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu)
3004	{
3005	VMCPU_ASSERT_EMT(pVCpu);
3006
3007	/*
3008	* The shared virtual clock (includes virtual sync which is tied to it).
3009	*/
3010	TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
3011	int rc = tmVirtualPauseLocked(pVM);
3012	TM_UNLOCK_TIMERS(pVM);
3013	if (RT_FAILURE(rc))
3014	return rc;
3015
3016	/*
3017	* Pause the TSC last since it is normally linked to the virtual
3018	* sync clock, so the above code may actually stop both clocks.
3019	*/
3020	if (!pVM->tm.s.fTSCTiedToExecution)
3021	{
3022	TM_LOCK_TIMERS(pVM); /* Exploit the timer lock for synchronization. */
3023	rc = tmCpuTickPauseLocked(pVM, pVCpu);
3024	TM_UNLOCK_TIMERS(pVM);
3025	if (RT_FAILURE(rc))
3026	return rc;
3027	}
3028
3029	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3030	/*
3031	* Update cNsTotal and stats.
3032	*/
3033	Assert(!pVCpu->tm.s.fSuspended);
3034	uint64_t const cNsTotalNew = RTTimeNanoTS() - pVCpu->tm.s.nsStartTotal;
3035	uint64_t const cNsOtherNew = cNsTotalNew - pVCpu->tm.s.cNsExecuting - pVCpu->tm.s.cNsHalted;
3036
3037	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
3038	STAM_REL_COUNTER_ADD(&pVCpu->tm.s.StatNsTotal, cNsTotalNew - pVCpu->tm.s.cNsTotalStat);
3039	int64_t const cNsOtherNewDelta = cNsOtherNew - pVCpu->tm.s.cNsOtherStat;
3040	if (cNsOtherNewDelta > 0)
3041	STAM_REL_COUNTER_ADD(&pVCpu->tm.s.StatNsOther, (uint64_t)cNsOtherNewDelta);
3042	# endif
3043
3044	uint32_t uGen = ASMAtomicIncU32(&pVCpu->tm.s.uTimesGen); Assert(uGen & 1);
3045	pVCpu->tm.s.nsStartTotal = cNsTotalNew;
3046	pVCpu->tm.s.fSuspended = true;
3047	pVCpu->tm.s.cNsTotalStat = cNsTotalNew;
3048	pVCpu->tm.s.cNsOtherStat = cNsOtherNew;
3049	ASMAtomicWriteU32(&pVCpu->tm.s.uTimesGen, (uGen \| 1) + 1);
3050	#endif
3051
3052	return VINF_SUCCESS;
3053	}
3054
3055
3056	/**
3057	* Resumes all clocks except TMCLOCK_REAL.
3058	*
3059	* @returns VBox status code, all errors are asserted.
3060	* @param pVM The cross context VM structure.
3061	* @param pVCpu The cross context virtual CPU structure.
3062	* @thread EMT corresponding to Pointer to the VMCPU.
3063	*/
3064	VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu)
3065	{
3066	VMCPU_ASSERT_EMT(pVCpu);
3067	int rc;
3068
3069	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3070	/*
3071	* Set u64NsTsStartTotal. There is no need to back this out if either of
3072	* the two calls below fail.
3073	*/
3074	uint32_t uGen = ASMAtomicIncU32(&pVCpu->tm.s.uTimesGen); Assert(uGen & 1);
3075	pVCpu->tm.s.nsStartTotal = RTTimeNanoTS() - pVCpu->tm.s.nsStartTotal;
3076	pVCpu->tm.s.fSuspended = false;
3077	ASMAtomicWriteU32(&pVCpu->tm.s.uTimesGen, (uGen \| 1) + 1);
3078	#endif
3079
3080	/*
3081	* Resume the TSC first since it is normally linked to the virtual sync
3082	* clock, so it may actually not be resumed until we've executed the code
3083	* below.
3084	*/
3085	if (!pVM->tm.s.fTSCTiedToExecution)
3086	{
3087	TM_LOCK_TIMERS(pVM); /* Exploit the timer lock for synchronization. */
3088	rc = tmCpuTickResumeLocked(pVM, pVCpu);
3089	TM_UNLOCK_TIMERS(pVM);
3090	if (RT_FAILURE(rc))
3091	return rc;
3092	}
3093
3094	/*
3095	* The shared virtual clock (includes virtual sync which is tied to it).
3096	*/
3097	TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
3098	rc = tmVirtualResumeLocked(pVM);
3099	TM_UNLOCK_TIMERS(pVM);
3100
3101	return rc;
3102	}
3103
3104
3105	/**
3106	* Sets the warp drive percent of the virtual time.
3107	*
3108	* @returns VBox status code.
3109	* @param pUVM The user mode VM structure.
3110	* @param u32Percent The new percentage. 100 means normal operation.
3111	*/
3112	VMMDECL(int) TMR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent)
3113	{
3114	return VMR3ReqPriorityCallWaitU(pUVM, VMCPUID_ANY, (PFNRT)tmR3SetWarpDrive, 2, pUVM, u32Percent);
3115	}
3116
3117
3118	/**
3119	* EMT worker for TMR3SetWarpDrive.
3120	*
3121	* @returns VBox status code.
3122	* @param pUVM The user mode VM handle.
3123	* @param u32Percent See TMR3SetWarpDrive().
3124	* @internal
3125	*/
3126	static DECLCALLBACK(int) tmR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent)
3127	{
3128	PVM pVM = pUVM->pVM;
3129	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3130	PVMCPU pVCpu = VMMGetCpu(pVM);
3131
3132	/*
3133	* Validate it.
3134	*/
3135	AssertMsgReturn(u32Percent >= 2 && u32Percent <= 20000,
3136	("%RX32 is not between 2 and 20000 (inclusive).\n", u32Percent),
3137	VERR_INVALID_PARAMETER);
3138
3139	/** @todo This isn't a feature specific to virtual time, move the variables to
3140	* TM level and make it affect TMR3UTCNow as well! */
3141
3142	/*
3143	* If the time is running we'll have to pause it before we can change
3144	* the warp drive settings.
3145	*/
3146	TM_LOCK_TIMERS(pVM); /* Paranoia: Exploiting the timer lock here. */
3147	bool fPaused = !!pVM->tm.s.cVirtualTicking;
3148	if (fPaused) /** @todo this isn't really working, but wtf. */
3149	TMR3NotifySuspend(pVM, pVCpu);
3150
3151	/** @todo Should switch TM mode to virt-tsc-emulated if it isn't already! */
3152	pVM->tm.s.u32VirtualWarpDrivePercentage = u32Percent;
3153	pVM->tm.s.fVirtualWarpDrive = u32Percent != 100;
3154	LogRel(("TM: u32VirtualWarpDrivePercentage=%RI32 fVirtualWarpDrive=%RTbool\n",
3155	pVM->tm.s.u32VirtualWarpDrivePercentage, pVM->tm.s.fVirtualWarpDrive));
3156
3157	if (fPaused)
3158	TMR3NotifyResume(pVM, pVCpu);
3159	TM_UNLOCK_TIMERS(pVM);
3160	return VINF_SUCCESS;
3161	}
3162
3163
3164	/**
3165	* Gets the current TMCLOCK_VIRTUAL time without checking
3166	* timers or anything.
3167	*
3168	* @returns The timestamp.
3169	* @param pUVM The user mode VM structure.
3170	*
3171	* @remarks See TMVirtualGetNoCheck.
3172	*/
3173	VMMR3DECL(uint64_t) TMR3TimeVirtGet(PUVM pUVM)
3174	{
3175	UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3176	PVM pVM = pUVM->pVM;
3177	VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3178	return TMVirtualGetNoCheck(pVM);
3179	}
3180
3181
3182	/**
3183	* Gets the current TMCLOCK_VIRTUAL time in milliseconds without checking
3184	* timers or anything.
3185	*
3186	* @returns The timestamp in milliseconds.
3187	* @param pUVM The user mode VM structure.
3188	*
3189	* @remarks See TMVirtualGetNoCheck.
3190	*/
3191	VMMR3DECL(uint64_t) TMR3TimeVirtGetMilli(PUVM pUVM)
3192	{
3193	UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3194	PVM pVM = pUVM->pVM;
3195	VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3196	return TMVirtualToMilli(pVM, TMVirtualGetNoCheck(pVM));
3197	}
3198
3199
3200	/**
3201	* Gets the current TMCLOCK_VIRTUAL time in microseconds without checking
3202	* timers or anything.
3203	*
3204	* @returns The timestamp in microseconds.
3205	* @param pUVM The user mode VM structure.
3206	*
3207	* @remarks See TMVirtualGetNoCheck.
3208	*/
3209	VMMR3DECL(uint64_t) TMR3TimeVirtGetMicro(PUVM pUVM)
3210	{
3211	UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3212	PVM pVM = pUVM->pVM;
3213	VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3214	return TMVirtualToMicro(pVM, TMVirtualGetNoCheck(pVM));
3215	}
3216
3217
3218	/**
3219	* Gets the current TMCLOCK_VIRTUAL time in nanoseconds without checking
3220	* timers or anything.
3221	*
3222	* @returns The timestamp in nanoseconds.
3223	* @param pUVM The user mode VM structure.
3224	*
3225	* @remarks See TMVirtualGetNoCheck.
3226	*/
3227	VMMR3DECL(uint64_t) TMR3TimeVirtGetNano(PUVM pUVM)
3228	{
3229	UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT64_MAX);
3230	PVM pVM = pUVM->pVM;
3231	VM_ASSERT_VALID_EXT_RETURN(pVM, UINT64_MAX);
3232	return TMVirtualToNano(pVM, TMVirtualGetNoCheck(pVM));
3233	}
3234
3235
3236	/**
3237	* Gets the current warp drive percent.
3238	*
3239	* @returns The warp drive percent.
3240	* @param pUVM The user mode VM structure.
3241	*/
3242	VMMR3DECL(uint32_t) TMR3GetWarpDrive(PUVM pUVM)
3243	{
3244	UVM_ASSERT_VALID_EXT_RETURN(pUVM, UINT32_MAX);
3245	PVM pVM = pUVM->pVM;
3246	VM_ASSERT_VALID_EXT_RETURN(pVM, UINT32_MAX);
3247	return pVM->tm.s.u32VirtualWarpDrivePercentage;
3248	}
3249
3250
3251	#if 0 /* unused - needs a little updating after @bugref{9941}*/
3252	/**
3253	* Gets the performance information for one virtual CPU as seen by the VMM.
3254	*
3255	* The returned times covers the period where the VM is running and will be
3256	* reset when restoring a previous VM state (at least for the time being).
3257	*
3258	* @retval VINF_SUCCESS on success.
3259	* @retval VERR_NOT_IMPLEMENTED if not compiled in.
3260	* @retval VERR_INVALID_STATE if the VM handle is bad.
3261	* @retval VERR_INVALID_CPU_ID if idCpu is out of range.
3262	*
3263	* @param pVM The cross context VM structure.
3264	* @param idCpu The ID of the virtual CPU which times to get.
3265	* @param pcNsTotal Where to store the total run time (nano seconds) of
3266	* the CPU, i.e. the sum of the three other returns.
3267	* Optional.
3268	* @param pcNsExecuting Where to store the time (nano seconds) spent
3269	* executing guest code. Optional.
3270	* @param pcNsHalted Where to store the time (nano seconds) spent
3271	* halted. Optional
3272	* @param pcNsOther Where to store the time (nano seconds) spent
3273	* preempted by the host scheduler, on virtualization
3274	* overhead and on other tasks.
3275	*/
3276	VMMR3DECL(int) TMR3GetCpuLoadTimes(PVM pVM, VMCPUID idCpu, uint64_t pcNsTotal, uint64_t pcNsExecuting,
3277	uint64_t pcNsHalted, uint64_t pcNsOther)
3278	{
3279	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_STATE);
3280	AssertReturn(idCpu < pVM->cCpus, VERR_INVALID_CPU_ID);
3281
3282	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3283	/*
3284	* Get a stable result set.
3285	* This should be way quicker than an EMT request.
3286	*/
3287	PVMCPU pVCpu = pVM->apCpusR3[idCpu];
3288	uint32_t uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3289	uint64_t cNsTotal = pVCpu->tm.s.cNsTotal;
3290	uint64_t cNsExecuting = pVCpu->tm.s.cNsExecuting;
3291	uint64_t cNsHalted = pVCpu->tm.s.cNsHalted;
3292	uint64_t cNsOther = pVCpu->tm.s.cNsOther;
3293	while ( (uTimesGen & 1) /* update in progress */
3294	\|\| uTimesGen != ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen))
3295	{
3296	RTThreadYield();
3297	uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3298	cNsTotal = pVCpu->tm.s.cNsTotal;
3299	cNsExecuting = pVCpu->tm.s.cNsExecuting;
3300	cNsHalted = pVCpu->tm.s.cNsHalted;
3301	cNsOther = pVCpu->tm.s.cNsOther;
3302	}
3303
3304	/*
3305	* Fill in the return values.
3306	*/
3307	if (pcNsTotal)
3308	*pcNsTotal = cNsTotal;
3309	if (pcNsExecuting)
3310	*pcNsExecuting = cNsExecuting;
3311	if (pcNsHalted)
3312	*pcNsHalted = cNsHalted;
3313	if (pcNsOther)
3314	*pcNsOther = cNsOther;
3315
3316	return VINF_SUCCESS;
3317
3318	#else
3319	return VERR_NOT_IMPLEMENTED;
3320	#endif
3321	}
3322	#endif /* unused */
3323
3324
3325	/**
3326	* Gets the performance information for one virtual CPU as seen by the VMM in
3327	* percents.
3328	*
3329	* The returned times covers the period where the VM is running and will be
3330	* reset when restoring a previous VM state (at least for the time being).
3331	*
3332	* @retval VINF_SUCCESS on success.
3333	* @retval VERR_NOT_IMPLEMENTED if not compiled in.
3334	* @retval VERR_INVALID_VM_HANDLE if the VM handle is bad.
3335	* @retval VERR_INVALID_CPU_ID if idCpu is out of range.
3336	*
3337	* @param pUVM The usermode VM structure.
3338	* @param idCpu The ID of the virtual CPU which times to get.
3339	* @param pcMsInterval Where to store the interval of the percentages in
3340	* milliseconds. Optional.
3341	* @param pcPctExecuting Where to return the percentage of time spent
3342	* executing guest code. Optional.
3343	* @param pcPctHalted Where to return the percentage of time spent halted.
3344	* Optional
3345	* @param pcPctOther Where to return the percentage of time spent
3346	* preempted by the host scheduler, on virtualization
3347	* overhead and on other tasks.
3348	*/
3349	VMMR3DECL(int) TMR3GetCpuLoadPercents(PUVM pUVM, VMCPUID idCpu, uint64_t pcMsInterval, uint8_t pcPctExecuting,
3350	uint8_t pcPctHalted, uint8_t pcPctOther)
3351	{
3352	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
3353	PVM pVM = pUVM->pVM;
3354	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
3355	AssertReturn(idCpu == VMCPUID_ALL \|\| idCpu < pVM->cCpus, VERR_INVALID_CPU_ID);
3356
3357	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3358	TMCPULOADSTATE volatile *pState;
3359	if (idCpu == VMCPUID_ALL)
3360	pState = &pVM->tm.s.CpuLoad;
3361	else
3362	pState = &pVM->apCpusR3[idCpu]->tm.s.CpuLoad;
3363
3364	if (pcMsInterval)
3365	*pcMsInterval = RT_MS_1SEC;
3366	if (pcPctExecuting)
3367	*pcPctExecuting = pState->cPctExecuting;
3368	if (pcPctHalted)
3369	*pcPctHalted = pState->cPctHalted;
3370	if (pcPctOther)
3371	*pcPctOther = pState->cPctOther;
3372
3373	return VINF_SUCCESS;
3374
3375	#else
3376	RT_NOREF(pcMsInterval, pcPctExecuting, pcPctHalted, pcPctOther);
3377	return VERR_NOT_IMPLEMENTED;
3378	#endif
3379	}
3380
3381	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
3382
3383	/**
3384	* Helper for tmR3CpuLoadTimer.
3385	* @returns
3386	* @param pState The state to update.
3387	* @param cNsTotal Total time.
3388	* @param cNsExecuting Time executing.
3389	* @param cNsHalted Time halted.
3390	*/
3391	DECLINLINE(void) tmR3CpuLoadTimerMakeUpdate(PTMCPULOADSTATE pState, uint64_t cNsTotal, uint64_t cNsExecuting, uint64_t cNsHalted)
3392	{
3393	/* Calc & update deltas */
3394	uint64_t cNsTotalDelta = cNsTotal - pState->cNsPrevTotal;
3395	pState->cNsPrevTotal = cNsTotal;
3396
3397	uint64_t cNsExecutingDelta = cNsExecuting - pState->cNsPrevExecuting;
3398	pState->cNsPrevExecuting = cNsExecuting;
3399
3400	uint64_t cNsHaltedDelta = cNsHalted - pState->cNsPrevHalted;
3401	pState->cNsPrevHalted = cNsHalted;
3402
3403	/* Calc pcts. */
3404	uint8_t cPctExecuting, cPctHalted, cPctOther;
3405	if (!cNsTotalDelta)
3406	{
3407	cPctExecuting = 0;
3408	cPctHalted = 100;
3409	cPctOther = 0;
3410	}
3411	else if (cNsTotalDelta < UINT64_MAX / 4)
3412	{
3413	cPctExecuting = (uint8_t)(cNsExecutingDelta * 100 / cNsTotalDelta);
3414	cPctHalted = (uint8_t)(cNsHaltedDelta * 100 / cNsTotalDelta);
3415	cPctOther = (uint8_t)((cNsTotalDelta - cNsExecutingDelta - cNsHaltedDelta) * 100 / cNsTotalDelta);
3416	}
3417	else
3418	{
3419	cPctExecuting = 0;
3420	cPctHalted = 100;
3421	cPctOther = 0;
3422	}
3423
3424	/* Update percentages: */
3425	size_t idxHistory = pState->idxHistory + 1;
3426	if (idxHistory >= RT_ELEMENTS(pState->aHistory))
3427	idxHistory = 0;
3428
3429	pState->cPctExecuting = cPctExecuting;
3430	pState->cPctHalted = cPctHalted;
3431	pState->cPctOther = cPctOther;
3432
3433	pState->aHistory[idxHistory].cPctExecuting = cPctExecuting;
3434	pState->aHistory[idxHistory].cPctHalted = cPctHalted;
3435	pState->aHistory[idxHistory].cPctOther = cPctOther;
3436
3437	pState->idxHistory = (uint16_t)idxHistory;
3438	if (pState->cHistoryEntries < RT_ELEMENTS(pState->aHistory))
3439	pState->cHistoryEntries++;
3440	}
3441
3442
3443	/**
3444	* @callback_method_impl{FNTMTIMERINT,
3445	* Timer callback that calculates the CPU load since the last
3446	* time it was called.}
3447	*/
3448	static DECLCALLBACK(void) tmR3CpuLoadTimer(PVM pVM, TMTIMERHANDLE hTimer, void *pvUser)
3449	{
3450	/*
3451	* Re-arm the timer first.
3452	*/
3453	int rc = TMTimerSetMillies(pVM, hTimer, 1000);
3454	AssertLogRelRC(rc);
3455	NOREF(pvUser);
3456
3457	/*
3458	* Update the values for each CPU.
3459	*/
3460	uint64_t cNsTotalAll = 0;
3461	uint64_t cNsExecutingAll = 0;
3462	uint64_t cNsHaltedAll = 0;
3463	for (VMCPUID iCpu = 0; iCpu < pVM->cCpus; iCpu++)
3464	{
3465	PVMCPU pVCpu = pVM->apCpusR3[iCpu];
3466
3467	/* Try get a stable data set. */
3468	uint32_t cTries = 3;
3469	uint64_t nsNow = RTTimeNanoTS();
3470	uint32_t uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3471	bool fSuspended = pVCpu->tm.s.fSuspended;
3472	uint64_t nsStartTotal = pVCpu->tm.s.nsStartTotal;
3473	uint64_t cNsExecuting = pVCpu->tm.s.cNsExecuting;
3474	uint64_t cNsHalted = pVCpu->tm.s.cNsHalted;
3475	while (RT_UNLIKELY( (uTimesGen & 1) /* update in progress */
3476	\|\| uTimesGen != ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen)))
3477	{
3478	if (!--cTries)
3479	break;
3480	ASMNopPause();
3481	nsNow = RTTimeNanoTS();
3482	uTimesGen = ASMAtomicReadU32(&pVCpu->tm.s.uTimesGen);
3483	fSuspended = pVCpu->tm.s.fSuspended;
3484	nsStartTotal = pVCpu->tm.s.nsStartTotal;
3485	cNsExecuting = pVCpu->tm.s.cNsExecuting;
3486	cNsHalted = pVCpu->tm.s.cNsHalted;
3487	}
3488
3489	/* Totals */
3490	uint64_t cNsTotal = fSuspended ? nsStartTotal : nsNow - nsStartTotal;
3491	cNsTotalAll += cNsTotal;
3492	cNsExecutingAll += cNsExecuting;
3493	cNsHaltedAll += cNsHalted;
3494
3495	/* Calc the PCTs and update the state. */
3496	tmR3CpuLoadTimerMakeUpdate(&pVCpu->tm.s.CpuLoad, cNsTotal, cNsExecuting, cNsHalted);
3497
3498	/* Tell the VCpu to update the other and total stat members. */
3499	ASMAtomicWriteBool(&pVCpu->tm.s.fUpdateStats, true);
3500	}
3501
3502	/*
3503	* Update the value for all the CPUs.
3504	*/
3505	tmR3CpuLoadTimerMakeUpdate(&pVM->tm.s.CpuLoad, cNsTotalAll, cNsExecutingAll, cNsHaltedAll);
3506
3507	}
3508
3509	#endif /* !VBOX_WITHOUT_NS_ACCOUNTING */
3510
3511
3512	/**
3513	* @callback_method_impl{PFNVMMEMTRENDEZVOUS,
3514	* Worker for TMR3CpuTickParavirtEnable}
3515	*/
3516	static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtEnable(PVM pVM, PVMCPU pVCpuEmt, void *pvData)
3517	{
3518	AssertPtr(pVM); Assert(pVM->tm.s.fTSCModeSwitchAllowed); NOREF(pVCpuEmt); NOREF(pvData);
3519	Assert(pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET);
3520	Assert(pVM->tm.s.enmTSCMode != TMTSCMODE_NATIVE_API); /** @todo figure out NEM/win and paravirt */
3521	Assert(tmR3HasFixedTSC(pVM));
3522
3523	/*
3524	* The return value of TMCpuTickGet() and the guest's TSC value for each
3525	* CPU must remain constant across the TM TSC mode-switch. Thus we have
3526	* the following equation (new/old signifies the new/old tsc modes):
3527	* uNewTsc = uOldTsc
3528	*
3529	* Where (see tmCpuTickGetInternal):
3530	* uOldTsc = uRawOldTsc - offTscRawSrcOld
3531	* uNewTsc = uRawNewTsc - offTscRawSrcNew
3532	*
3533	* Solve it for offTscRawSrcNew without replacing uOldTsc:
3534	* uRawNewTsc - offTscRawSrcNew = uOldTsc
3535	* => -offTscRawSrcNew = uOldTsc - uRawNewTsc
3536	* => offTscRawSrcNew = uRawNewTsc - uOldTsc
3537	*/
3538	uint64_t uRawOldTsc = tmR3CpuTickGetRawVirtualNoCheck(pVM);
3539	uint64_t uRawNewTsc = SUPReadTsc();
3540	uint32_t cCpus = pVM->cCpus;
3541	for (uint32_t i = 0; i < cCpus; i++)
3542	{
3543	PVMCPU pVCpu = pVM->apCpusR3[i];
3544	uint64_t uOldTsc = uRawOldTsc - pVCpu->tm.s.offTSCRawSrc;
3545	pVCpu->tm.s.offTSCRawSrc = uRawNewTsc - uOldTsc;
3546	Assert(uRawNewTsc - pVCpu->tm.s.offTSCRawSrc >= uOldTsc); /* paranoia^256 */
3547	}
3548
3549	LogRel(("TM: Switching TSC mode from '%s' to '%s'\n", tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode),
3550	tmR3GetTSCModeNameEx(TMTSCMODE_REAL_TSC_OFFSET)));
3551	pVM->tm.s.enmTSCMode = TMTSCMODE_REAL_TSC_OFFSET;
3552	return VINF_SUCCESS;
3553	}
3554
3555
3556	/**
3557	* Notify TM that the guest has enabled usage of a paravirtualized TSC.
3558	*
3559	* This may perform a EMT rendezvous and change the TSC virtualization mode.
3560	*
3561	* @returns VBox status code.
3562	* @param pVM The cross context VM structure.
3563	*/
3564	VMMR3_INT_DECL(int) TMR3CpuTickParavirtEnable(PVM pVM)
3565	{
3566	int rc = VINF_SUCCESS;
3567	if (pVM->tm.s.fTSCModeSwitchAllowed)
3568	{
3569	if (pVM->tm.s.enmTSCMode != TMTSCMODE_REAL_TSC_OFFSET)
3570	rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, tmR3CpuTickParavirtEnable, NULL);
3571	}
3572	else
3573	LogRel(("TM: Host/VM is not suitable for using TSC mode '%s', request to change TSC mode ignored\n",
3574	tmR3GetTSCModeNameEx(TMTSCMODE_REAL_TSC_OFFSET)));
3575	pVM->tm.s.fParavirtTscEnabled = true;
3576	return rc;
3577	}
3578
3579
3580	/**
3581	* @callback_method_impl{PFNVMMEMTRENDEZVOUS,
3582	* Worker for TMR3CpuTickParavirtDisable}
3583	*/
3584	static DECLCALLBACK(VBOXSTRICTRC) tmR3CpuTickParavirtDisable(PVM pVM, PVMCPU pVCpuEmt, void *pvData)
3585	{
3586	AssertPtr(pVM); Assert(pVM->tm.s.fTSCModeSwitchAllowed); NOREF(pVCpuEmt);
3587	Assert( pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET
3588	&& pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode);
3589	RT_NOREF1(pvData);
3590
3591	/*
3592	* See tmR3CpuTickParavirtEnable for an explanation of the conversion math.
3593	*/
3594	uint64_t uRawOldTsc = SUPReadTsc();
3595	uint64_t uRawNewTsc = tmR3CpuTickGetRawVirtualNoCheck(pVM);
3596	uint32_t cCpus = pVM->cCpus;
3597	for (uint32_t i = 0; i < cCpus; i++)
3598	{
3599	PVMCPU pVCpu = pVM->apCpusR3[i];
3600	uint64_t uOldTsc = uRawOldTsc - pVCpu->tm.s.offTSCRawSrc;
3601	pVCpu->tm.s.offTSCRawSrc = uRawNewTsc - uOldTsc;
3602	Assert(uRawNewTsc - pVCpu->tm.s.offTSCRawSrc >= uOldTsc); /* paranoia^256 */
3603
3604	/* Update the last-seen tick here as we havent't been updating it (as we don't
3605	need it) while in pure TSC-offsetting mode. */
3606	pVCpu->tm.s.u64TSCLastSeen = uOldTsc;
3607	}
3608
3609	LogRel(("TM: Switching TSC mode from '%s' to '%s'\n", tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode),
3610	tmR3GetTSCModeNameEx(pVM->tm.s.enmOriginalTSCMode)));
3611	pVM->tm.s.enmTSCMode = pVM->tm.s.enmOriginalTSCMode;
3612	return VINF_SUCCESS;
3613	}
3614
3615
3616	/**
3617	* Notify TM that the guest has disabled usage of a paravirtualized TSC.
3618	*
3619	* If TMR3CpuTickParavirtEnable() changed the TSC virtualization mode, this will
3620	* perform an EMT rendezvous to revert those changes.
3621	*
3622	* @returns VBox status code.
3623	* @param pVM The cross context VM structure.
3624	*/
3625	VMMR3_INT_DECL(int) TMR3CpuTickParavirtDisable(PVM pVM)
3626	{
3627	int rc = VINF_SUCCESS;
3628	if ( pVM->tm.s.fTSCModeSwitchAllowed
3629	&& pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET
3630	&& pVM->tm.s.enmTSCMode != pVM->tm.s.enmOriginalTSCMode)
3631	rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, tmR3CpuTickParavirtDisable, NULL);
3632	pVM->tm.s.fParavirtTscEnabled = false;
3633	return rc;
3634	}
3635
3636
3637	/**
3638	* Check whether the guest can be presented a fixed rate & monotonic TSC.
3639	*
3640	* @returns true if TSC is stable, false otherwise.
3641	* @param pVM The cross context VM structure.
3642	* @param fWithParavirtEnabled Whether it's fixed & monotonic when
3643	* paravirt. TSC is enabled or not.
3644	*
3645	* @remarks Must be called only after TMR3InitFinalize().
3646	*/
3647	VMMR3_INT_DECL(bool) TMR3CpuTickIsFixedRateMonotonic(PVM pVM, bool fWithParavirtEnabled)
3648	{
3649	/** @todo figure out what exactly we want here later. */
3650	NOREF(fWithParavirtEnabled);
3651	return ( tmR3HasFixedTSC(pVM) /* Host has fixed-rate TSC. */
3652	&& g_pSUPGlobalInfoPage->u32Mode != SUPGIPMODE_ASYNC_TSC); /* GIP thinks it's monotonic. */
3653	}
3654
3655
3656	/**
3657	* Gets the 5 char clock name for the info tables.
3658	*
3659	* @returns The name.
3660	* @param enmClock The clock.
3661	*/
3662	DECLINLINE(const char *) tmR3Get5CharClockName(TMCLOCK enmClock)
3663	{
3664	switch (enmClock)
3665	{
3666	case TMCLOCK_REAL: return "Real ";
3667	case TMCLOCK_VIRTUAL: return "Virt ";
3668	case TMCLOCK_VIRTUAL_SYNC: return "VrSy ";
3669	case TMCLOCK_TSC: return "TSC ";
3670	default: return "Bad ";
3671	}
3672	}
3673
3674
3675	/**
3676	* Display all timers.
3677	*
3678	* @param pVM The cross context VM structure.
3679	* @param pHlp The info helpers.
3680	* @param pszArgs Arguments, ignored.
3681	*/
3682	static DECLCALLBACK(void) tmR3TimerInfo(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3683	{
3684	NOREF(pszArgs);
3685	pHlp->pfnPrintf(pHlp,
3686	"Timers (pVM=%p)\n"
3687	"%.s %.s %.s %.s Clock %18s %18s %6s %-25s Description\n",
3688	pVM,
3689	sizeof(RTR3PTR) * 2, "pTimerR3 ",
3690	sizeof(int32_t) * 2, "offNext ",
3691	sizeof(int32_t) * 2, "offPrev ",
3692	sizeof(int32_t) * 2, "offSched ",
3693	"Time",
3694	"Expire",
3695	"HzHint",
3696	"State");
3697	TM_LOCK_TIMERS(pVM);
3698	for (PTMTIMERR3 pTimer = pVM->tm.s.pCreated; pTimer; pTimer = pTimer->pBigNext)
3699	{
3700	pHlp->pfnPrintf(pHlp,
3701	"%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %6RU32 %-25s %s\n",
3702	pTimer,
3703	pTimer->offNext,
3704	pTimer->offPrev,
3705	pTimer->offScheduleNext,
3706	tmR3Get5CharClockName(pTimer->enmClock),
3707	TMTimerGet(pVM, pTimer->hSelf),
3708	pTimer->u64Expire,
3709	pTimer->uHzHint,
3710	tmTimerState(pTimer->enmState),
3711	pTimer->pszDesc);
3712	}
3713	TM_UNLOCK_TIMERS(pVM);
3714	}
3715
3716
3717	/**
3718	* Display all active timers.
3719	*
3720	* @param pVM The cross context VM structure.
3721	* @param pHlp The info helpers.
3722	* @param pszArgs Arguments, ignored.
3723	*/
3724	static DECLCALLBACK(void) tmR3TimerInfoActive(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3725	{
3726	NOREF(pszArgs);
3727	pHlp->pfnPrintf(pHlp,
3728	"Active Timers (pVM=%p)\n"
3729	"%.s %.s %.s %.s Clock %18s %18s %6s %-25s Description\n",
3730	pVM,
3731	sizeof(RTR3PTR) * 2, "pTimerR3 ",
3732	sizeof(int32_t) * 2, "offNext ",
3733	sizeof(int32_t) * 2, "offPrev ",
3734	sizeof(int32_t) * 2, "offSched ",
3735	"Time",
3736	"Expire",
3737	"HzHint",
3738	"State");
3739	for (unsigned iQueue = 0; iQueue < TMCLOCK_MAX; iQueue++)
3740	{
3741	TM_LOCK_TIMERS(pVM);
3742	for (PTMTIMERR3 pTimer = TMTIMER_GET_HEAD(&pVM->tm.s.paTimerQueuesR3[iQueue]);
3743	pTimer;
3744	pTimer = TMTIMER_GET_NEXT(pTimer))
3745	{
3746	pHlp->pfnPrintf(pHlp,
3747	"%p %08RX32 %08RX32 %08RX32 %s %18RU64 %18RU64 %6RU32 %-25s %s\n",
3748	pTimer,
3749	pTimer->offNext,
3750	pTimer->offPrev,
3751	pTimer->offScheduleNext,
3752	tmR3Get5CharClockName(pTimer->enmClock),
3753	TMTimerGet(pVM, pTimer->hSelf),
3754	pTimer->u64Expire,
3755	pTimer->uHzHint,
3756	tmTimerState(pTimer->enmState),
3757	pTimer->pszDesc);
3758	}
3759	TM_UNLOCK_TIMERS(pVM);
3760	}
3761	}
3762
3763
3764	/**
3765	* Display all clocks.
3766	*
3767	* @param pVM The cross context VM structure.
3768	* @param pHlp The info helpers.
3769	* @param pszArgs Arguments, ignored.
3770	*/
3771	static DECLCALLBACK(void) tmR3InfoClocks(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
3772	{
3773	NOREF(pszArgs);
3774
3775	/*
3776	* Read the times first to avoid more than necessary time variation.
3777	*/
3778	const uint64_t u64Virtual = TMVirtualGet(pVM);
3779	const uint64_t u64VirtualSync = TMVirtualSyncGet(pVM);
3780	const uint64_t u64Real = TMRealGet(pVM);
3781
3782	for (VMCPUID i = 0; i < pVM->cCpus; i++)
3783	{
3784	PVMCPU pVCpu = pVM->apCpusR3[i];
3785	uint64_t u64TSC = TMCpuTickGet(pVCpu);
3786
3787	/*
3788	* TSC
3789	*/
3790	pHlp->pfnPrintf(pHlp,
3791	"Cpu Tick: %18RU64 (%#016RX64) %RU64Hz %s - virtualized",
3792	u64TSC, u64TSC, TMCpuTicksPerSecond(pVM),
3793	pVCpu->tm.s.fTSCTicking ? "ticking" : "paused");
3794	if (pVM->tm.s.enmTSCMode == TMTSCMODE_REAL_TSC_OFFSET)
3795	{
3796	pHlp->pfnPrintf(pHlp, " - real tsc offset");
3797	if (pVCpu->tm.s.offTSCRawSrc)
3798	pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVCpu->tm.s.offTSCRawSrc);
3799	}
3800	else if (pVM->tm.s.enmTSCMode == TMTSCMODE_NATIVE_API)
3801	pHlp->pfnPrintf(pHlp, " - native api");
3802	else
3803	pHlp->pfnPrintf(pHlp, " - virtual clock");
3804	pHlp->pfnPrintf(pHlp, "\n");
3805	}
3806
3807	/*
3808	* virtual
3809	*/
3810	pHlp->pfnPrintf(pHlp,
3811	" Virtual: %18RU64 (%#016RX64) %RU64Hz %s",
3812	u64Virtual, u64Virtual, TMVirtualGetFreq(pVM),
3813	pVM->tm.s.cVirtualTicking ? "ticking" : "paused");
3814	if (pVM->tm.s.fVirtualWarpDrive)
3815	pHlp->pfnPrintf(pHlp, " WarpDrive %RU32 %%", pVM->tm.s.u32VirtualWarpDrivePercentage);
3816	pHlp->pfnPrintf(pHlp, "\n");
3817
3818	/*
3819	* virtual sync
3820	*/
3821	pHlp->pfnPrintf(pHlp,
3822	"VirtSync: %18RU64 (%#016RX64) %s%s",
3823	u64VirtualSync, u64VirtualSync,
3824	pVM->tm.s.fVirtualSyncTicking ? "ticking" : "paused",
3825	pVM->tm.s.fVirtualSyncCatchUp ? " - catchup" : "");
3826	if (pVM->tm.s.offVirtualSync)
3827	{
3828	pHlp->pfnPrintf(pHlp, "\n offset %RU64", pVM->tm.s.offVirtualSync);
3829	if (pVM->tm.s.u32VirtualSyncCatchUpPercentage)
3830	pHlp->pfnPrintf(pHlp, " catch-up rate %u %%", pVM->tm.s.u32VirtualSyncCatchUpPercentage);
3831	}
3832	pHlp->pfnPrintf(pHlp, "\n");
3833
3834	/*
3835	* real
3836	*/
3837	pHlp->pfnPrintf(pHlp,
3838	" Real: %18RU64 (%#016RX64) %RU64Hz\n",
3839	u64Real, u64Real, TMRealGetFreq(pVM));
3840	}
3841
3842
3843	/**
3844	* Helper for tmR3InfoCpuLoad that adjust @a uPct to the given graph width.
3845	*/
3846	DECLINLINE(size_t) tmR3InfoCpuLoadAdjustWidth(size_t uPct, size_t cchWidth)
3847	{
3848	if (cchWidth != 100)
3849	uPct = (uPct + 0.5) * (cchWidth / 100.0);
3850	return uPct;
3851	}
3852
3853
3854	/**
3855	* @callback_method_impl{FNDBGFINFOARGVINT}
3856	*/
3857	static DECLCALLBACK(void) tmR3InfoCpuLoad(PVM pVM, PCDBGFINFOHLP pHlp, int cArgs, char **papszArgs)
3858	{
3859	char szTmp[1024];
3860
3861	/*
3862	* Parse arguments.
3863	*/
3864	PTMCPULOADSTATE pState = &pVM->tm.s.CpuLoad;
3865	VMCPUID idCpu = 0;
3866	bool fAllCpus = true;
3867	bool fExpGraph = true;
3868	uint32_t cchWidth = 80;
3869	uint32_t cPeriods = RT_ELEMENTS(pState->aHistory);
3870	uint32_t cRows = 60;
3871
3872	static const RTGETOPTDEF s_aOptions[] =
3873	{
3874	{ "all", 'a', RTGETOPT_REQ_NOTHING },
3875	{ "cpu", 'c', RTGETOPT_REQ_UINT32 },
3876	{ "periods", 'p', RTGETOPT_REQ_UINT32 },
3877	{ "rows", 'r', RTGETOPT_REQ_UINT32 },
3878	{ "uni", 'u', RTGETOPT_REQ_NOTHING },
3879	{ "uniform", 'u', RTGETOPT_REQ_NOTHING },
3880	{ "width", 'w', RTGETOPT_REQ_UINT32 },
3881	{ "exp", 'x', RTGETOPT_REQ_NOTHING },
3882	{ "exponential", 'x', RTGETOPT_REQ_NOTHING },
3883	};
3884
3885	RTGETOPTSTATE State;
3886	int rc = RTGetOptInit(&State, cArgs, papszArgs, s_aOptions, RT_ELEMENTS(s_aOptions), 0, 0 /fFlags/);
3887	AssertRC(rc);
3888
3889	RTGETOPTUNION ValueUnion;
3890	while ((rc = RTGetOpt(&State, &ValueUnion)) != 0)
3891	{
3892	switch (rc)
3893	{
3894	case 'a':
3895	pState = &pVM->apCpusR3[0]->tm.s.CpuLoad;
3896	idCpu = 0;
3897	fAllCpus = true;
3898	break;
3899	case 'c':
3900	if (ValueUnion.u32 < pVM->cCpus)
3901	{
3902	pState = &pVM->apCpusR3[ValueUnion.u32]->tm.s.CpuLoad;
3903	idCpu = ValueUnion.u32;
3904	}
3905	else
3906	{
3907	pState = &pVM->tm.s.CpuLoad;
3908	idCpu = VMCPUID_ALL;
3909	}
3910	fAllCpus = false;
3911	break;
3912	case 'p':
3913	cPeriods = RT_MIN(RT_MAX(ValueUnion.u32, 1), RT_ELEMENTS(pState->aHistory));
3914	break;
3915	case 'r':
3916	cRows = RT_MIN(RT_MAX(ValueUnion.u32, 5), RT_ELEMENTS(pState->aHistory));
3917	break;
3918	case 'w':
3919	cchWidth = RT_MIN(RT_MAX(ValueUnion.u32, 10), sizeof(szTmp) - 32);
3920	break;
3921	case 'x':
3922	fExpGraph = true;
3923	break;
3924	case 'u':
3925	fExpGraph = false;
3926	break;
3927	case 'h':
3928	pHlp->pfnPrintf(pHlp,
3929	"Usage: cpuload [parameters]\n"
3930	" all, -a\n"
3931	" Show statistics for all CPUs. (default)\n"
3932	" cpu=id, -c id\n"
3933	" Show statistics for the specified CPU ID. Show combined stats if out of range.\n"
3934	" periods=count, -p count\n"
3935	" Number of periods to show. Default: all\n"
3936	" rows=count, -r count\n"
3937	" Number of rows in the graphs. Default: 60\n"
3938	" width=count, -w count\n"
3939	" Core graph width in characters. Default: 80\n"
3940	" exp, exponential, -e\n"
3941	" Do 1:1 for more recent half / 30 seconds of the graph, combine the\n"
3942	" rest into increasinly larger chunks. Default.\n"
3943	" uniform, uni, -u\n"
3944	" Combine periods into rows in a uniform manner for the whole graph.\n");
3945	return;
3946	default:
3947	pHlp->pfnGetOptError(pHlp, rc, &ValueUnion, &State);
3948	return;
3949	}
3950	}
3951
3952	/*
3953	* Do the job.
3954	*/
3955	for (;;)
3956	{
3957	uint32_t const cMaxPeriods = pState->cHistoryEntries;
3958	if (cPeriods > cMaxPeriods)
3959	cPeriods = cMaxPeriods;
3960	if (cPeriods > 0)
3961	{
3962	if (fAllCpus)
3963	{
3964	if (idCpu > 0)
3965	pHlp->pfnPrintf(pHlp, "\n");
3966	pHlp->pfnPrintf(pHlp, " CPU load for virtual CPU %#04x\n"
3967	" -------------------------------\n", idCpu);
3968	}
3969
3970	/*
3971	* Figure number of periods per chunk. We can either do this in a linear
3972	* fashion or a exponential fashion that compresses old history more.
3973	*/
3974	size_t cPerRowDecrement = 0;
3975	size_t cPeriodsPerRow = 1;
3976	if (cRows < cPeriods)
3977	{
3978	if (!fExpGraph)
3979	cPeriodsPerRow = (cPeriods + cRows / 2) / cRows;
3980	else
3981	{
3982	/* The last 30 seconds or half of the rows are 1:1, the other part
3983	is in increasing period counts. Code is a little simple but seems
3984	to do the job most of the time, which is all I have time now. */
3985	size_t cPeriodsOneToOne = RT_MIN(30, cRows / 2);
3986	size_t cRestRows = cRows - cPeriodsOneToOne;
3987	size_t cRestPeriods = cPeriods - cPeriodsOneToOne;
3988
3989	size_t cPeriodsInWindow = 0;
3990	for (cPeriodsPerRow = 0; cPeriodsPerRow <= cRestRows && cPeriodsInWindow < cRestPeriods; cPeriodsPerRow++)
3991	cPeriodsInWindow += cPeriodsPerRow + 1;
3992
3993	size_t iLower = 1;
3994	while (cPeriodsInWindow < cRestPeriods)
3995	{
3996	cPeriodsPerRow++;
3997	cPeriodsInWindow += cPeriodsPerRow;
3998	cPeriodsInWindow -= iLower;
3999	iLower++;
4000	}
4001
4002	cPerRowDecrement = 1;
4003	}
4004	}
4005
4006	/*
4007	* Do the work.
4008	*/
4009	size_t cPctExecuting = 0;
4010	size_t cPctOther = 0;
4011	size_t cPeriodsAccumulated = 0;
4012
4013	size_t cRowsLeft = cRows;
4014	size_t iHistory = (pState->idxHistory - cPeriods) % RT_ELEMENTS(pState->aHistory);
4015	while (cPeriods-- > 0)
4016	{
4017	iHistory++;
4018	if (iHistory >= RT_ELEMENTS(pState->aHistory))
4019	iHistory = 0;
4020
4021	cPctExecuting += pState->aHistory[iHistory].cPctExecuting;
4022	cPctOther += pState->aHistory[iHistory].cPctOther;
4023	cPeriodsAccumulated += 1;
4024	if ( cPeriodsAccumulated >= cPeriodsPerRow
4025	\|\| cPeriods < cRowsLeft)
4026	{
4027	/*
4028	* Format and output the line.
4029	*/
4030	size_t offTmp = 0;
4031	size_t i = tmR3InfoCpuLoadAdjustWidth(cPctExecuting / cPeriodsAccumulated, cchWidth);
4032	while (i-- > 0)
4033	szTmp[offTmp++] = '#';
4034	i = tmR3InfoCpuLoadAdjustWidth(cPctOther / cPeriodsAccumulated, cchWidth);
4035	while (i-- > 0)
4036	szTmp[offTmp++] = 'O';
4037	szTmp[offTmp] = '\0';
4038
4039	cRowsLeft--;
4040	pHlp->pfnPrintf(pHlp, "%3zus: %s\n", cPeriods + cPeriodsAccumulated / 2, szTmp);
4041
4042	/* Reset the state: */
4043	cPctExecuting = 0;
4044	cPctOther = 0;
4045	cPeriodsAccumulated = 0;
4046	if (cPeriodsPerRow > cPerRowDecrement)
4047	cPeriodsPerRow -= cPerRowDecrement;
4048	}
4049	}
4050	pHlp->pfnPrintf(pHlp, " (#=guest, O=VMM overhead) idCpu=%#x\n", idCpu);
4051
4052	}
4053	else
4054	pHlp->pfnPrintf(pHlp, "No load data.\n");
4055
4056	/*
4057	* Next CPU if we're display all.
4058	*/
4059	if (!fAllCpus)
4060	break;
4061	idCpu++;
4062	if (idCpu >= pVM->cCpus)
4063	break;
4064	pState = &pVM->apCpusR3[idCpu]->tm.s.CpuLoad;
4065	}
4066
4067	}
4068
4069
4070	/**
4071	* Gets the descriptive TM TSC mode name given the enum value.
4072	*
4073	* @returns The name.
4074	* @param enmMode The mode to name.
4075	*/
4076	static const char *tmR3GetTSCModeNameEx(TMTSCMODE enmMode)
4077	{
4078	switch (enmMode)
4079	{
4080	case TMTSCMODE_REAL_TSC_OFFSET: return "RealTscOffset";
4081	case TMTSCMODE_VIRT_TSC_EMULATED: return "VirtTscEmulated";
4082	case TMTSCMODE_DYNAMIC: return "Dynamic";
4083	case TMTSCMODE_NATIVE_API: return "NativeApi";
4084	default: return "???";
4085	}
4086	}
4087
4088
4089	/**
4090	* Gets the descriptive TM TSC mode name.
4091	*
4092	* @returns The name.
4093	* @param pVM The cross context VM structure.
4094	*/
4095	static const char *tmR3GetTSCModeName(PVM pVM)
4096	{
4097	Assert(pVM);
4098	return tmR3GetTSCModeNameEx(pVM->tm.s.enmTSCMode);
4099	}
4100

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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

以其他格式下載: