TMInternal.h@ 93392

Last change on this file since 93392 was 93115, checked in by vboxsync, 3 years ago
scm --update-copyright-year
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 34.7 KB

Line
1	/* $Id: TMInternal.h 93115 2022-01-01 11:31:46Z vboxsync $ */
2	/** @file
3	* TM - Internal header file.
4	*/
5
6	/*
7	* Copyright (C) 2006-2022 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#ifndef VMM_INCLUDED_SRC_include_TMInternal_h
19	#define VMM_INCLUDED_SRC_include_TMInternal_h
20	#ifndef RT_WITHOUT_PRAGMA_ONCE
21	# pragma once
22	#endif
23
24	#include <VBox/cdefs.h>
25	#include <VBox/types.h>
26	#include <iprt/time.h>
27	#include <iprt/timer.h>
28	#include <iprt/assert.h>
29	#include <VBox/vmm/stam.h>
30	#include <VBox/vmm/pdmcritsect.h>
31	#include <VBox/vmm/pdmcritsectrw.h>
32
33	RT_C_DECLS_BEGIN
34
35
36	/** @defgroup grp_tm_int Internal
37	* @ingroup grp_tm
38	* @internal
39	* @{
40	*/
41
42	/** Frequency of the real clock. */
43	#define TMCLOCK_FREQ_REAL UINT32_C(1000)
44	/** Frequency of the virtual clock. */
45	#define TMCLOCK_FREQ_VIRTUAL UINT32_C(1000000000)
46
47
48	/**
49	* Timer type.
50	*/
51	typedef enum TMTIMERTYPE
52	{
53	/** Invalid zero value. */
54	TMTIMERTYPE_INVALID = 0,
55	/** Device timer. */
56	TMTIMERTYPE_DEV,
57	/** USB device timer. */
58	TMTIMERTYPE_USB,
59	/** Driver timer. */
60	TMTIMERTYPE_DRV,
61	/** Internal timer . */
62	TMTIMERTYPE_INTERNAL
63	} TMTIMERTYPE;
64
65	/**
66	* Timer state
67	*/
68	typedef enum TMTIMERSTATE
69	{
70	/** Invalid zero entry (used for table entry zero). */
71	TMTIMERSTATE_INVALID = 0,
72	/** Timer is stopped. */
73	TMTIMERSTATE_STOPPED,
74	/** Timer is active. */
75	TMTIMERSTATE_ACTIVE,
76	/** Timer is expired, getting expire and unlinking. */
77	TMTIMERSTATE_EXPIRED_GET_UNLINK,
78	/** Timer is expired and is being delivered. */
79	TMTIMERSTATE_EXPIRED_DELIVER,
80
81	/** Timer is stopped but still in the active list.
82	* Currently in the ScheduleTimers list. */
83	TMTIMERSTATE_PENDING_STOP,
84	/** Timer is stopped but needs unlinking from the ScheduleTimers list.
85	* Currently in the ScheduleTimers list. */
86	TMTIMERSTATE_PENDING_STOP_SCHEDULE,
87	/** Timer is being modified and will soon be pending scheduling.
88	* Currently in the ScheduleTimers list. */
89	TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE,
90	/** Timer is pending scheduling.
91	* Currently in the ScheduleTimers list. */
92	TMTIMERSTATE_PENDING_SCHEDULE,
93	/** Timer is being modified and will soon be pending rescheduling.
94	* Currently in the ScheduleTimers list and the active list. */
95	TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE,
96	/** Timer is modified and is now pending rescheduling.
97	* Currently in the ScheduleTimers list and the active list. */
98	TMTIMERSTATE_PENDING_RESCHEDULE,
99	/** Timer is being destroyed. */
100	TMTIMERSTATE_DESTROY,
101	/** Timer is free. */
102	TMTIMERSTATE_FREE
103	} TMTIMERSTATE;
104
105	/** Predicate that returns true if the give state is pending scheduling or
106	* rescheduling of any kind. Will reference the argument more than once! */
107	#define TMTIMERSTATE_IS_PENDING_SCHEDULING(enmState) \
108	( (enmState) <= TMTIMERSTATE_PENDING_RESCHEDULE \
109	&& (enmState) >= TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE)
110
111	/** @name Timer handle value elements
112	* @{ */
113	#define TMTIMERHANDLE_RANDOM_MASK UINT64_C(0xffffffffff000000)
114	#define TMTIMERHANDLE_QUEUE_IDX_SHIFT 16
115	#define TMTIMERHANDLE_QUEUE_IDX_MASK UINT64_C(0x0000000000ff0000)
116	#define TMTIMERHANDLE_QUEUE_IDX_SMASK UINT64_C(0x00000000000000ff)
117	#define TMTIMERHANDLE_TIMER_IDX_MASK UINT64_C(0x000000000000ffff)
118	/** @} */
119
120
121	/**
122	* Internal representation of a timer.
123	*
124	* For correct serialization (without the use of semaphores and
125	* other blocking/slow constructs) certain rules applies to updating
126	* this structure:
127	* - For thread other than EMT only u64Expire, enmState and pScheduleNext*
128	* are changeable. Everything else is out of bounds.
129	* - Updating of u64Expire timer can only happen in the TMTIMERSTATE_STOPPED
130	* and TMTIMERSTATE_PENDING_RESCHEDULING_SET_EXPIRE states.
131	* - Timers in the TMTIMERSTATE_EXPIRED state are only accessible from EMT.
132	* - Actual destruction of a timer can only be done at scheduling time.
133	*/
134	typedef struct TMTIMER
135	{
136	/** Expire time. */
137	volatile uint64_t u64Expire;
138
139	/** Timer state. */
140	volatile TMTIMERSTATE enmState;
141	/** The index of the next next timer in the schedule list. */
142	uint32_t volatile idxScheduleNext;
143
144	/** The index of the next timer in the chain. */
145	uint32_t idxNext;
146	/** The index of the previous timer in the chain. */
147	uint32_t idxPrev;
148
149	/** The timer frequency hint. This is 0 if not hint was given. */
150	uint32_t volatile uHzHint;
151	/** Timer callback type. */
152	TMTIMERTYPE enmType;
153
154	/** It's own handle value. */
155	TMTIMERHANDLE hSelf;
156	/** TMTIMER_FLAGS_XXX. */
157	uint32_t fFlags;
158	/** Explicit alignment padding. */
159	uint32_t u32Alignment;
160
161	/** User argument. */
162	RTR3PTR pvUser;
163	/** The critical section associated with the lock. */
164	R3PTRTYPE(PPDMCRITSECT) pCritSect;
165
166	/* --- new cache line (64-bit / 64 bytes) --- */
167
168	/** Type specific data. */
169	union
170	{
171	/** TMTIMERTYPE_DEV. */
172	struct
173	{
174	/** Callback. */
175	R3PTRTYPE(PFNTMTIMERDEV) pfnTimer;
176	/** Device instance. */
177	PPDMDEVINSR3 pDevIns;
178	} Dev;
179
180	/** TMTIMERTYPE_DEV. */
181	struct
182	{
183	/** Callback. */
184	R3PTRTYPE(PFNTMTIMERUSB) pfnTimer;
185	/** USB device instance. */
186	PPDMUSBINS pUsbIns;
187	} Usb;
188
189	/** TMTIMERTYPE_DRV. */
190	struct
191	{
192	/** Callback. */
193	R3PTRTYPE(PFNTMTIMERDRV) pfnTimer;
194	/** Device instance. */
195	R3PTRTYPE(PPDMDRVINS) pDrvIns;
196	} Drv;
197
198	/** TMTIMERTYPE_INTERNAL. */
199	struct
200	{
201	/** Callback. */
202	R3PTRTYPE(PFNTMTIMERINT) pfnTimer;
203	} Internal;
204	} u;
205
206	/** The timer name. */
207	char szName[32];
208
209	/** @todo think of two useful release statistics counters here to fill up the
210	* cache line. */
211	#ifndef VBOX_WITH_STATISTICS
212	uint64_t auAlignment2[2];
213	#else
214	STAMPROFILE StatTimer;
215	STAMPROFILE StatCritSectEnter;
216	STAMCOUNTER StatGet;
217	STAMCOUNTER StatSetAbsolute;
218	STAMCOUNTER StatSetRelative;
219	STAMCOUNTER StatStop;
220	uint64_t auAlignment2[6];
221	#endif
222	} TMTIMER;
223	AssertCompileMemberSize(TMTIMER, u64Expire, sizeof(uint64_t));
224	AssertCompileMemberSize(TMTIMER, enmState, sizeof(uint32_t));
225	AssertCompileSizeAlignment(TMTIMER, 64);
226
227
228	/**
229	* Updates a timer state in the correct atomic manner.
230	*/
231	#if 1
232	# define TM_SET_STATE(pTimer, state) \
233	ASMAtomicWriteU32((uint32_t volatile *)&(pTimer)->enmState, state)
234	#else
235	# define TM_SET_STATE(pTimer, state) \
236	do { \
237	uint32_t uOld1 = (pTimer)->enmState; \
238	Log(("%s: %p: %d -> %d\n", __FUNCTION__, (pTimer), (pTimer)->enmState, state)); \
239	uint32_t uOld2 = ASMAtomicXchgU32((uint32_t volatile *)&(pTimer)->enmState, state); \
240	Assert(uOld1 == uOld2); \
241	} while (0)
242	#endif
243
244	/**
245	* Tries to updates a timer state in the correct atomic manner.
246	*/
247	#if 1
248	# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
249	(fRc) = ASMAtomicCmpXchgU32((uint32_t volatile *)&(pTimer)->enmState, StateNew, StateOld)
250	#else
251	# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
252	do { (fRc) = ASMAtomicCmpXchgU32((uint32_t volatile *)&(pTimer)->enmState, StateNew, StateOld); \
253	Log(("%s: %p: %d -> %d %RTbool\n", __FUNCTION__, (pTimer), StateOld, StateNew, fRc)); \
254	} while (0)
255	#endif
256
257
258	/**
259	* A timer queue, shared.
260	*/
261	typedef struct TMTIMERQUEUE
262	{
263	/** The ring-0 mapping of the timer table. */
264	R3PTRTYPE(PTMTIMER) paTimers;
265
266	/** The cached expire time for this queue.
267	* Updated by EMT when scheduling the queue or modifying the head timer.
268	* Assigned UINT64_MAX when there is no head timer. */
269	uint64_t u64Expire;
270	/** Doubly linked list of active timers.
271	*
272	* When no scheduling is pending, this list is will be ordered by expire time (ascending).
273	* Access is serialized by only letting the emulation thread (EMT) do changes.
274	*/
275	uint32_t idxActive;
276	/** List of timers pending scheduling of some kind.
277	*
278	* Timer stats allowed in the list are TMTIMERSTATE_PENDING_STOPPING,
279	* TMTIMERSTATE_PENDING_DESTRUCTION, TMTIMERSTATE_PENDING_STOPPING_DESTRUCTION,
280	* TMTIMERSTATE_PENDING_RESCHEDULING and TMTIMERSTATE_PENDING_SCHEDULE.
281	*/
282	uint32_t volatile idxSchedule;
283	/** The clock for this queue. */
284	TMCLOCK enmClock; /*< @todo consider duplicating this in TMTIMERQUEUER0 for better cache locality (paTimers). /
285
286	/** The size of the paTimers allocation (in entries). */
287	uint32_t cTimersAlloc;
288	/** Number of free timer entries. */
289	uint32_t cTimersFree;
290	/** Where to start looking for free timers. */
291	uint32_t idxFreeHint;
292	/** The queue name. */
293	char szName[16];
294	/** Set when a thread is doing scheduling and callback. */
295	bool volatile fBeingProcessed;
296	/** Set if we've disabled growing. */
297	bool fCannotGrow;
298	/** Align on 64-byte boundrary. */
299	bool afAlignment1[2];
300	/** The current max timer Hz hint. */
301	uint32_t volatile uMaxHzHint;
302
303	/* --- new cache line (64-bit / 64 bytes) --- */
304
305	/** Time spent doing scheduling and timer callbacks. */
306	STAMPROFILE StatDo;
307	/** The thread servicing this queue, NIL if none. */
308	R3PTRTYPE(RTTHREAD) hThread;
309	/** The handle to the event semaphore the worker thread sleeps on. */
310	SUPSEMEVENT hWorkerEvt;
311	/** Absolute sleep deadline for the worker (enmClock time). */
312	uint64_t volatile tsWorkerWakeup;
313	uint64_t u64Alignment2;
314
315	/** Lock serializing the active timer list and associated work. */
316	PDMCRITSECT TimerLock;
317	/** Lock serializing timer allocation and deallocation.
318	* @note This may be used in read-mode all over the place if we later
319	* implement runtime array growing. */
320	PDMCRITSECTRW AllocLock;
321	} TMTIMERQUEUE;
322	AssertCompileMemberAlignment(TMTIMERQUEUE, AllocLock, 64);
323	AssertCompileSizeAlignment(TMTIMERQUEUE, 64);
324	/** Pointer to a timer queue. */
325	typedef TMTIMERQUEUE *PTMTIMERQUEUE;
326
327	/**
328	* A timer queue, ring-0 only bits.
329	*/
330	typedef struct TMTIMERQUEUER0
331	{
332	/** The size of the paTimers allocation (in entries). */
333	uint32_t cTimersAlloc;
334	uint32_t uAlignment;
335	/** The ring-0 mapping of the timer table. */
336	R0PTRTYPE(PTMTIMER) paTimers;
337	/** Handle to the timer table allocation. */
338	RTR0MEMOBJ hMemObj;
339	/** Handle to the ring-3 mapping of the timer table. */
340	RTR0MEMOBJ hMapObj;
341	} TMTIMERQUEUER0;
342	/** Pointer to the ring-0 timer queue data. */
343	typedef TMTIMERQUEUER0 *PTMTIMERQUEUER0;
344
345	/** Pointer to the current context data for a timer queue.
346	* @note In ring-3 this is the same as the shared data. */
347	#ifdef IN_RING3
348	typedef TMTIMERQUEUE *PTMTIMERQUEUECC;
349	#else
350	typedef TMTIMERQUEUER0 *PTMTIMERQUEUECC;
351	#endif
352	/** Helper macro for getting the current context queue point. */
353	#ifdef IN_RING3
354	# define TM_GET_TIMER_QUEUE_CC(a_pVM, a_idxQueue, a_pQueueShared) (a_pQueueShared)
355	#else
356	# define TM_GET_TIMER_QUEUE_CC(a_pVM, a_idxQueue, a_pQueueShared) (&(a_pVM)->tmr0.s.aTimerQueues[a_idxQueue])
357	#endif
358
359
360	/**
361	* CPU load data set.
362	* Mainly used by tmR3CpuLoadTimer.
363	*/
364	typedef struct TMCPULOADSTATE
365	{
366	/** The percent of the period spent executing guest code. */
367	uint8_t cPctExecuting;
368	/** The percent of the period spent halted. */
369	uint8_t cPctHalted;
370	/** The percent of the period spent on other things. */
371	uint8_t cPctOther;
372	/** Explicit alignment padding */
373	uint8_t au8Alignment[1];
374	/** Index into aHistory of the current entry. */
375	uint16_t volatile idxHistory;
376	/** Number of valid history entries before idxHistory. */
377	uint16_t volatile cHistoryEntries;
378
379	/** Previous cNsTotal value. */
380	uint64_t cNsPrevTotal;
381	/** Previous cNsExecuting value. */
382	uint64_t cNsPrevExecuting;
383	/** Previous cNsHalted value. */
384	uint64_t cNsPrevHalted;
385	/** Data for the last 30 min (given an interval of 1 second). */
386	struct
387	{
388	uint8_t cPctExecuting;
389	/** The percent of the period spent halted. */
390	uint8_t cPctHalted;
391	/** The percent of the period spent on other things. */
392	uint8_t cPctOther;
393	} aHistory[30*60];
394	} TMCPULOADSTATE;
395	AssertCompileSizeAlignment(TMCPULOADSTATE, 8);
396	AssertCompileMemberAlignment(TMCPULOADSTATE, cNsPrevTotal, 8);
397	/** Pointer to a CPU load data set. */
398	typedef TMCPULOADSTATE *PTMCPULOADSTATE;
399
400
401	/**
402	* TSC mode.
403	*
404	* The main modes of how TM implements the TSC clock (TMCLOCK_TSC).
405	*/
406	typedef enum TMTSCMODE
407	{
408	/** The guest TSC is an emulated, virtual TSC. */
409	TMTSCMODE_VIRT_TSC_EMULATED = 1,
410	/** The guest TSC is an offset of the real TSC. */
411	TMTSCMODE_REAL_TSC_OFFSET,
412	/** The guest TSC is dynamically derived through emulating or offsetting. */
413	TMTSCMODE_DYNAMIC,
414	/** The native API provides it. */
415	TMTSCMODE_NATIVE_API
416	} TMTSCMODE;
417	AssertCompileSize(TMTSCMODE, sizeof(uint32_t));
418
419
420	/**
421	* TM VM Instance data.
422	* Changes to this must checked against the padding of the cfgm union in VM!
423	*/
424	typedef struct TM
425	{
426	/** Timer queues for the different clock types.
427	* @note is first in the structure to ensure cache-line alignment. */
428	TMTIMERQUEUE aTimerQueues[TMCLOCK_MAX];
429
430	/** The current TSC mode of the VM.
431	* Config variable: Mode (string). */
432	TMTSCMODE enmTSCMode;
433	/** The original TSC mode of the VM. */
434	TMTSCMODE enmOriginalTSCMode;
435	/** Whether the TSC is tied to the execution of code.
436	* Config variable: TSCTiedToExecution (bool) */
437	bool fTSCTiedToExecution;
438	/** Modifier for fTSCTiedToExecution which pauses the TSC while halting if true.
439	* Config variable: TSCNotTiedToHalt (bool) */
440	bool fTSCNotTiedToHalt;
441	/** Whether TM TSC mode switching is allowed at runtime. */
442	bool fTSCModeSwitchAllowed;
443	/** Whether the guest has enabled use of paravirtualized TSC. */
444	bool fParavirtTscEnabled;
445	/** The ID of the virtual CPU that normally runs the timers. */
446	VMCPUID idTimerCpu;
447
448	/** The number of CPU clock ticks per seconds of the host CPU. */
449	uint64_t cTSCTicksPerSecondHost;
450	/** The number of CPU clock ticks per second (TMCLOCK_TSC).
451	* Config variable: TSCTicksPerSecond (64-bit unsigned int)
452	* The config variable implies @c enmTSCMode would be
453	* TMTSCMODE_VIRT_TSC_EMULATED. */
454	uint64_t cTSCTicksPerSecond;
455	/** The TSC difference introduced by pausing the VM. */
456	uint64_t offTSCPause;
457	/** The TSC value when the last TSC was paused. */
458	uint64_t u64LastPausedTSC;
459	/** CPU TSCs ticking indicator (one for each VCPU). */
460	uint32_t volatile cTSCsTicking;
461
462	/** Virtual time ticking enabled indicator (counter for each VCPU). (TMCLOCK_VIRTUAL) */
463	uint32_t volatile cVirtualTicking;
464	/** Virtual time is not running at 100%. */
465	bool fVirtualWarpDrive;
466	/** Virtual timer synchronous time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL_SYNC) */
467	bool volatile fVirtualSyncTicking;
468	/** Virtual timer synchronous time catch-up active. */
469	bool volatile fVirtualSyncCatchUp;
470	/** Alignment padding. */
471	bool afAlignment1[1];
472	/** WarpDrive percentage.
473	* 100% is normal (fVirtualSyncNormal == true). When other than 100% we apply
474	* this percentage to the raw time source for the period it's been valid in,
475	* i.e. since u64VirtualWarpDriveStart. */
476	uint32_t u32VirtualWarpDrivePercentage;
477
478	/** The offset of the virtual clock relative to it's timesource.
479	* Only valid if fVirtualTicking is set. */
480	uint64_t u64VirtualOffset;
481	/** The guest virtual time when fVirtualTicking is cleared. */
482	uint64_t u64Virtual;
483	/** When the Warp drive was started or last adjusted.
484	* Only valid when fVirtualWarpDrive is set. */
485	uint64_t u64VirtualWarpDriveStart;
486	/** The previously returned nano TS.
487	* This handles TSC drift on SMP systems and expired interval.
488	* This is a valid range u64NanoTS to u64NanoTS + 1000000000 (ie. 1sec). */
489	uint64_t volatile u64VirtualRawPrev;
490	/** The ring-3 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
491	RTTIMENANOTSDATAR3 VirtualGetRawDataR3;
492	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
493	RTTIMENANOTSDATAR0 VirtualGetRawDataR0;
494	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
495	R3PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR3;
496	/** Pointer to the ring-0 tmVirtualGetRawNanoTS worker function. */
497	R0PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR0;
498	/** The guest virtual timer synchronous time when fVirtualSyncTicking is cleared.
499	* When fVirtualSyncTicking is set it holds the last time returned to
500	* the guest (while the lock was held). */
501	uint64_t volatile u64VirtualSync;
502	/** The offset of the timer synchronous virtual clock (TMCLOCK_VIRTUAL_SYNC) relative
503	* to the virtual clock (TMCLOCK_VIRTUAL).
504	* (This is accessed by the timer thread and must be updated atomically.) */
505	uint64_t volatile offVirtualSync;
506	/** The offset into offVirtualSync that's been irrevocably given up by failed catch-up attempts.
507	* Thus the current lag is offVirtualSync - offVirtualSyncGivenUp. */
508	uint64_t offVirtualSyncGivenUp;
509	/** The TMCLOCK_VIRTUAL at the previous TMVirtualGetSync call when catch-up is active. */
510	uint64_t volatile u64VirtualSyncCatchUpPrev;
511	/** The current catch-up percentage. */
512	uint32_t volatile u32VirtualSyncCatchUpPercentage;
513	/** How much slack when processing timers. */
514	uint32_t u32VirtualSyncScheduleSlack;
515	/** When to stop catch-up. */
516	uint64_t u64VirtualSyncCatchUpStopThreshold;
517	/** When to give up catch-up. */
518	uint64_t u64VirtualSyncCatchUpGiveUpThreshold;
519	/** @def TM_MAX_CATCHUP_PERIODS
520	* The number of catchup rates. */
521	#define TM_MAX_CATCHUP_PERIODS 10
522	/** The aggressiveness of the catch-up relative to how far we've lagged behind.
523	* The idea is to have increasing catch-up percentage as the lag increases. */
524	struct TMCATCHUPPERIOD
525	{
526	uint64_t u64Start; /*< When this period starts. (u64VirtualSyncOffset). /
527	uint32_t u32Percentage; /*< The catch-up percent to apply. /
528	uint32_t u32Alignment; /*< Structure alignment /
529	} aVirtualSyncCatchUpPeriods[TM_MAX_CATCHUP_PERIODS];
530
531	union
532	{
533	/** Combined value for updating. */
534	uint64_t volatile u64Combined;
535	struct
536	{
537	/** Bitmap indicating which timer queues needs their uMaxHzHint updated. */
538	uint32_t volatile bmNeedsUpdating;
539	/** The current max timer Hz hint. */
540	uint32_t volatile uMax;
541	} s;
542	} HzHint;
543	/** @cfgm{/TM/HostHzMax, uint32_t, Hz, 0, UINT32_MAX, 20000}
544	* The max host Hz frequency hint returned by TMCalcHostTimerFrequency. */
545	uint32_t cHostHzMax;
546	/** @cfgm{/TM/HostHzFudgeFactorTimerCpu, uint32_t, Hz, 0, UINT32_MAX, 111}
547	* The number of Hz TMCalcHostTimerFrequency adds for the timer CPU. */
548	uint32_t cPctHostHzFudgeFactorTimerCpu;
549	/** @cfgm{/TM/HostHzFudgeFactorOtherCpu, uint32_t, Hz, 0, UINT32_MAX, 110}
550	* The number of Hz TMCalcHostTimerFrequency adds for the other CPUs. */
551	uint32_t cPctHostHzFudgeFactorOtherCpu;
552	/** @cfgm{/TM/HostHzFudgeFactorCatchUp100, uint32_t, Hz, 0, UINT32_MAX, 300}
553	* The fudge factor (expressed in percent) that catch-up percentages below
554	* 100% is multiplied by. */
555	uint32_t cPctHostHzFudgeFactorCatchUp100;
556	/** @cfgm{/TM/HostHzFudgeFactorCatchUp200, uint32_t, Hz, 0, UINT32_MAX, 250}
557	* The fudge factor (expressed in percent) that catch-up percentages
558	* 100%-199% is multiplied by. */
559	uint32_t cPctHostHzFudgeFactorCatchUp200;
560	/** @cfgm{/TM/HostHzFudgeFactorCatchUp400, uint32_t, Hz, 0, UINT32_MAX, 200}
561	* The fudge factor (expressed in percent) that catch-up percentages
562	* 200%-399% is multiplied by. */
563	uint32_t cPctHostHzFudgeFactorCatchUp400;
564
565	/** The UTC offset in ns.
566	* This is NOT for converting UTC to local time. It is for converting real
567	* world UTC time to VM UTC time. This feature is indented for doing date
568	* testing of software and similar.
569	* @todo Implement warpdrive on UTC. */
570	int64_t offUTC;
571	/** The last value TMR3UtcNow returned. */
572	int64_t volatile nsLastUtcNow;
573	/** File to touch on UTC jump. */
574	R3PTRTYPE(char *) pszUtcTouchFileOnJump;
575
576	/** Pointer to our R3 mapping of the GIP. */
577	R3PTRTYPE(void *) pvGIPR3;
578
579	/** The schedule timer timer handle (runtime timer).
580	* This timer will do frequent check on pending queue schedules and
581	* raise VM_FF_TIMER to pull EMTs attention to them.
582	*/
583	R3PTRTYPE(PRTTIMER) pTimer;
584	/** Interval in milliseconds of the pTimer timer. */
585	uint32_t u32TimerMillies;
586
587	/** Indicates that queues are being run. */
588	bool volatile fRunningQueues;
589	/** Indicates that the virtual sync queue is being run. */
590	bool volatile fRunningVirtualSyncQueue;
591	/** Alignment */
592	bool afAlignment3[2];
593
594	/** Lock serializing access to the VirtualSync clock and the associated
595	* timer queue.
596	* @todo Consider merging this with the TMTIMERQUEUE::TimerLock for the
597	* virtual sync queue. */
598	PDMCRITSECT VirtualSyncLock;
599
600	/** CPU load state for all the virtual CPUs (tmR3CpuLoadTimer). */
601	TMCPULOADSTATE CpuLoad;
602
603	/** TMR3TimerQueuesDo
604	* @{ */
605	STAMPROFILE StatDoQueues;
606	/** @} */
607	/** tmSchedule
608	* @{ */
609	STAMPROFILE StatScheduleOneRZ;
610	STAMPROFILE StatScheduleOneR3;
611	STAMCOUNTER StatScheduleSetFF;
612	STAMCOUNTER StatPostponedR3;
613	STAMCOUNTER StatPostponedRZ;
614	/** @} */
615	/** Read the time
616	* @{ */
617	STAMCOUNTER StatVirtualGet;
618	STAMCOUNTER StatVirtualGetSetFF;
619	STAMCOUNTER StatVirtualSyncGet;
620	STAMCOUNTER StatVirtualSyncGetAdjLast;
621	STAMCOUNTER StatVirtualSyncGetELoop;
622	STAMCOUNTER StatVirtualSyncGetExpired;
623	STAMCOUNTER StatVirtualSyncGetLockless;
624	STAMCOUNTER StatVirtualSyncGetLocked;
625	STAMCOUNTER StatVirtualSyncGetSetFF;
626	STAMCOUNTER StatVirtualPause;
627	STAMCOUNTER StatVirtualResume;
628	/** @} */
629	/** TMTimerPoll
630	* @{ */
631	STAMCOUNTER StatPoll;
632	STAMCOUNTER StatPollAlreadySet;
633	STAMCOUNTER StatPollELoop;
634	STAMCOUNTER StatPollMiss;
635	STAMCOUNTER StatPollRunning;
636	STAMCOUNTER StatPollSimple;
637	STAMCOUNTER StatPollVirtual;
638	STAMCOUNTER StatPollVirtualSync;
639	/** @} */
640	/** TMTimerSet sans virtual sync timers.
641	* @{ */
642	STAMCOUNTER StatTimerSet;
643	STAMCOUNTER StatTimerSetOpt;
644	STAMPROFILE StatTimerSetRZ;
645	STAMPROFILE StatTimerSetR3;
646	STAMCOUNTER StatTimerSetStStopped;
647	STAMCOUNTER StatTimerSetStExpDeliver;
648	STAMCOUNTER StatTimerSetStActive;
649	STAMCOUNTER StatTimerSetStPendStop;
650	STAMCOUNTER StatTimerSetStPendStopSched;
651	STAMCOUNTER StatTimerSetStPendSched;
652	STAMCOUNTER StatTimerSetStPendResched;
653	STAMCOUNTER StatTimerSetStOther;
654	/** @} */
655	/** TMTimerSet on virtual sync timers.
656	* @{ */
657	STAMCOUNTER StatTimerSetVs;
658	STAMPROFILE StatTimerSetVsRZ;
659	STAMPROFILE StatTimerSetVsR3;
660	STAMCOUNTER StatTimerSetVsStStopped;
661	STAMCOUNTER StatTimerSetVsStExpDeliver;
662	STAMCOUNTER StatTimerSetVsStActive;
663	/** @} */
664	/** TMTimerSetRelative sans virtual sync timers
665	* @{ */
666	STAMCOUNTER StatTimerSetRelative;
667	STAMPROFILE StatTimerSetRelativeRZ;
668	STAMPROFILE StatTimerSetRelativeR3;
669	STAMCOUNTER StatTimerSetRelativeOpt;
670	STAMCOUNTER StatTimerSetRelativeStStopped;
671	STAMCOUNTER StatTimerSetRelativeStExpDeliver;
672	STAMCOUNTER StatTimerSetRelativeStActive;
673	STAMCOUNTER StatTimerSetRelativeStPendStop;
674	STAMCOUNTER StatTimerSetRelativeStPendStopSched;
675	STAMCOUNTER StatTimerSetRelativeStPendSched;
676	STAMCOUNTER StatTimerSetRelativeStPendResched;
677	STAMCOUNTER StatTimerSetRelativeStOther;
678	/** @} */
679	/** TMTimerSetRelative on virtual sync timers.
680	* @{ */
681	STAMCOUNTER StatTimerSetRelativeVs;
682	STAMPROFILE StatTimerSetRelativeVsRZ;
683	STAMPROFILE StatTimerSetRelativeVsR3;
684	STAMCOUNTER StatTimerSetRelativeVsStStopped;
685	STAMCOUNTER StatTimerSetRelativeVsStExpDeliver;
686	STAMCOUNTER StatTimerSetRelativeVsStActive;
687	/** @} */
688	/** TMTimerStop sans virtual sync.
689	* @{ */
690	STAMPROFILE StatTimerStopRZ;
691	STAMPROFILE StatTimerStopR3;
692	/** @} */
693	/** TMTimerStop on virtual sync timers.
694	* @{ */
695	STAMPROFILE StatTimerStopVsRZ;
696	STAMPROFILE StatTimerStopVsR3;
697	/** @} */
698	/** VirtualSync - Running and Catching Up
699	* @{ */
700	STAMCOUNTER StatVirtualSyncRun;
701	STAMCOUNTER StatVirtualSyncRunRestart;
702	STAMPROFILE StatVirtualSyncRunSlack;
703	STAMCOUNTER StatVirtualSyncRunStop;
704	STAMCOUNTER StatVirtualSyncRunStoppedAlready;
705	STAMCOUNTER StatVirtualSyncGiveUp;
706	STAMCOUNTER StatVirtualSyncGiveUpBeforeStarting;
707	STAMPROFILEADV StatVirtualSyncCatchup;
708	STAMCOUNTER aStatVirtualSyncCatchupInitial[TM_MAX_CATCHUP_PERIODS];
709	STAMCOUNTER aStatVirtualSyncCatchupAdjust[TM_MAX_CATCHUP_PERIODS];
710	/** @} */
711	/** TMR3VirtualSyncFF (non dedicated EMT). */
712	STAMPROFILE StatVirtualSyncFF;
713	/** The timer callback. */
714	STAMCOUNTER StatTimerCallbackSetFF;
715	STAMCOUNTER StatTimerCallback;
716
717	/** Calls to TMCpuTickSet. */
718	STAMCOUNTER StatTSCSet;
719
720	/** TSC starts and stops. */
721	STAMCOUNTER StatTSCPause;
722	STAMCOUNTER StatTSCResume;
723
724	/** @name Reasons for refusing TSC offsetting in TMCpuTickCanUseRealTSC.
725	* @{ */
726	STAMCOUNTER StatTSCNotFixed;
727	STAMCOUNTER StatTSCNotTicking;
728	STAMCOUNTER StatTSCCatchupLE010;
729	STAMCOUNTER StatTSCCatchupLE025;
730	STAMCOUNTER StatTSCCatchupLE100;
731	STAMCOUNTER StatTSCCatchupOther;
732	STAMCOUNTER StatTSCWarp;
733	STAMCOUNTER StatTSCUnderflow;
734	STAMCOUNTER StatTSCSyncNotTicking;
735	/** @} */
736	} TM;
737	/** Pointer to TM VM instance data. */
738	typedef TM *PTM;
739
740
741	/**
742	* TM VMCPU Instance data.
743	* Changes to this must checked against the padding of the tm union in VM!
744	*/
745	typedef struct TMCPU
746	{
747	/** The offset between the host tick (TSC/virtual depending on the TSC mode) and
748	* the guest tick. */
749	uint64_t offTSCRawSrc;
750	/** The guest TSC when fTicking is cleared. */
751	uint64_t u64TSC;
752	/** The last seen TSC by the guest. */
753	uint64_t u64TSCLastSeen;
754	/** CPU timestamp ticking enabled indicator (bool). (RDTSC) */
755	bool fTSCTicking;
756	#ifdef VBOX_WITHOUT_NS_ACCOUNTING
757	bool afAlignment1[7]; /*< alignment padding /
758	#else /* !VBOX_WITHOUT_NS_ACCOUNTING */
759
760	/** Set by the timer callback to trigger updating of statistics in
761	* TMNotifyEndOfExecution. */
762	bool volatile fUpdateStats;
763	bool afAlignment1[6];
764	/** The time not spent executing or halted.
765	* @note Only updated after halting and after the timer runs. */
766	uint64_t cNsOtherStat;
767	/** Reasonably up to date total run time value.
768	* @note Only updated after halting and after the timer runs. */
769	uint64_t cNsTotalStat;
770	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
771	/** Resettable copy of version of cNsOtherStat.
772	* @note Only updated after halting. */
773	STAMCOUNTER StatNsOther;
774	/** Resettable copy of cNsTotalStat.
775	* @note Only updated after halting. */
776	STAMCOUNTER StatNsTotal;
777	# else
778	uint64_t auAlignment2[2];
779	# endif
780
781	/** @name Core accounting data.
782	* @note Must be cache-line aligned and only written to by the EMT owning it.
783	* @{ */
784	/** The cNsXXX generation. */
785	uint32_t volatile uTimesGen;
786	/** Set if executing (between TMNotifyStartOfExecution and
787	* TMNotifyEndOfExecution). */
788	bool volatile fExecuting;
789	/** Set if halting (between TMNotifyStartOfHalt and TMNotifyEndOfHalt). */
790	bool volatile fHalting;
791	/** Set if we're suspended and u64NsTsStartTotal is to be cNsTotal. */
792	bool volatile fSuspended;
793	bool afAlignment;
794	/** The nanosecond timestamp of the CPU start or resume.
795	* This is recalculated when the VM is started so that
796	* cNsTotal = RTTimeNanoTS() - u64NsTsStartCpu. */
797	uint64_t nsStartTotal;
798	/** The TSC of the last start-execute notification. */
799	uint64_t uTscStartExecuting;
800	/** The number of nanoseconds spent executing. */
801	uint64_t cNsExecuting;
802	/** The number of guest execution runs. */
803	uint64_t cPeriodsExecuting;
804	/** The nanosecond timestamp of the last start-halt notification. */
805	uint64_t nsStartHalting;
806	/** The number of nanoseconds being halted. */
807	uint64_t cNsHalted;
808	/** The number of halts. */
809	uint64_t cPeriodsHalted;
810	/** @} */
811
812	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
813	/** Resettable version of cNsExecuting. */
814	STAMPROFILE StatNsExecuting;
815	/** Long execution intervals. */
816	STAMPROFILE StatNsExecLong;
817	/** Short execution intervals. */
818	STAMPROFILE StatNsExecShort;
819	/** Tiny execution intervals. */
820	STAMPROFILE StatNsExecTiny;
821	/** Resettable version of cNsHalted. */
822	STAMPROFILE StatNsHalted;
823	# endif
824
825	/** CPU load state for this virtual CPU (tmR3CpuLoadTimer). */
826	TMCPULOADSTATE CpuLoad;
827	#endif
828	} TMCPU;
829	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
830	AssertCompileMemberAlignment(TMCPU, uTimesGen, 64);
831	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
832	AssertCompileMemberAlignment(TMCPU, StatNsExecuting, 64);
833	# else
834	AssertCompileMemberAlignment(TMCPU, CpuLoad, 64);
835	# endif
836	#endif
837	/** Pointer to TM VMCPU instance data. */
838	typedef TMCPU *PTMCPU;
839
840
841	/**
842	* TM data kept in the ring-0 GVM.
843	*/
844	typedef struct TMR0PERVM
845	{
846	/** Timer queues for the different clock types. */
847	TMTIMERQUEUER0 aTimerQueues[TMCLOCK_MAX];
848	} TMR0PERVM;
849
850
851	const char *tmTimerState(TMTIMERSTATE enmState);
852	void tmTimerQueueSchedule(PVMCC pVM, PTMTIMERQUEUECC pQueueCC, PTMTIMERQUEUE pQueue);
853	#ifdef VBOX_STRICT
854	void tmTimerQueuesSanityChecks(PVMCC pVM, const char *pszWhere);
855	#endif
856	void tmHCTimerQueueGrowInit(PTMTIMER paTimers, TMTIMER const *paOldTimers, uint32_t cNewTimers, uint32_t cOldTimers);
857
858	uint64_t tmR3CpuTickGetRawVirtualNoCheck(PVM pVM);
859	int tmCpuTickPause(PVMCPUCC pVCpu);
860	int tmCpuTickPauseLocked(PVMCC pVM, PVMCPUCC pVCpu);
861	int tmCpuTickResume(PVMCC pVM, PVMCPUCC pVCpu);
862	int tmCpuTickResumeLocked(PVMCC pVM, PVMCPUCC pVCpu);
863
864	int tmVirtualPauseLocked(PVMCC pVM);
865	int tmVirtualResumeLocked(PVMCC pVM);
866	DECLCALLBACK(DECLEXPORT(void)) tmVirtualNanoTSBad(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS,
867	uint64_t u64DeltaPrev, uint64_t u64PrevNanoTS);
868	DECLCALLBACK(DECLEXPORT(uint64_t)) tmVirtualNanoTSRediscover(PRTTIMENANOTSDATA pData, PRTITMENANOTSEXTRA pExtra);
869	DECLCALLBACK(DECLEXPORT(uint64_t)) tmVirtualNanoTSBadCpuIndex(PRTTIMENANOTSDATA pData, PRTITMENANOTSEXTRA pExtra,
870	uint16_t idApic, uint16_t iCpuSet, uint16_t iGipCpu);
871	/** @} */
872
873	RT_C_DECLS_END
874
875	#endif /* !VMM_INCLUDED_SRC_include_TMInternal_h */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/VMM/include/TMInternal.h@ 93392

Download in other formats: