TMInternal.h@ 87816

Last change on this file since 87816 was 87816, checked in by vboxsync, 4 years ago
VMM/TM: Gearing up to spreading out the timer work a little. bugref:9943
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 34.9 KB

Line
1	/* $Id: TMInternal.h 87816 2021-02-20 00:54:46Z vboxsync $ */
2	/** @file
3	* TM - Internal header file.
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.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	AssertCompileSizeAlignment(TMTIMERQUEUE, 64);
323	/** Pointer to a timer queue. */
324	typedef TMTIMERQUEUE *PTMTIMERQUEUE;
325
326	/**
327	* A timer queue, ring-0 only bits.
328	*/
329	typedef struct TMTIMERQUEUER0
330	{
331	/** The size of the paTimers allocation (in entries). */
332	uint32_t cTimersAlloc;
333	uint32_t uAlignment;
334	/** The ring-0 mapping of the timer table. */
335	R0PTRTYPE(PTMTIMER) paTimers;
336	/** Handle to the timer table allocation. */
337	RTR0MEMOBJ hMemObj;
338	/** Handle to the ring-3 mapping of the timer table. */
339	RTR0MEMOBJ hMapObj;
340	} TMTIMERQUEUER0;
341	/** Pointer to the ring-0 timer queue data. */
342	typedef TMTIMERQUEUER0 *PTMTIMERQUEUER0;
343
344	/** Pointer to the current context data for a timer queue.
345	* @note In ring-3 this is the same as the shared data. */
346	#ifdef IN_RING3
347	typedef TMTIMERQUEUE *PTMTIMERQUEUECC;
348	#else
349	typedef TMTIMERQUEUER0 *PTMTIMERQUEUECC;
350	#endif
351	/** Helper macro for getting the current context queue point. */
352	#ifdef IN_RING3
353	# define TM_GET_TIMER_QUEUE_CC(a_pVM, a_idxQueue, a_pQueueShared) (a_pQueueShared)
354	#else
355	# define TM_GET_TIMER_QUEUE_CC(a_pVM, a_idxQueue, a_pQueueShared) (&(a_pVM)->tmr0.s.aTimerQueues[a_idxQueue])
356	#endif
357
358
359	/**
360	* CPU load data set.
361	* Mainly used by tmR3CpuLoadTimer.
362	*/
363	typedef struct TMCPULOADSTATE
364	{
365	/** The percent of the period spent executing guest code. */
366	uint8_t cPctExecuting;
367	/** The percent of the period spent halted. */
368	uint8_t cPctHalted;
369	/** The percent of the period spent on other things. */
370	uint8_t cPctOther;
371	/** Explicit alignment padding */
372	uint8_t au8Alignment[1];
373	/** Index into aHistory of the current entry. */
374	uint16_t volatile idxHistory;
375	/** Number of valid history entries before idxHistory. */
376	uint16_t volatile cHistoryEntries;
377
378	/** Previous cNsTotal value. */
379	uint64_t cNsPrevTotal;
380	/** Previous cNsExecuting value. */
381	uint64_t cNsPrevExecuting;
382	/** Previous cNsHalted value. */
383	uint64_t cNsPrevHalted;
384	/** Data for the last 30 min (given an interval of 1 second). */
385	struct
386	{
387	uint8_t cPctExecuting;
388	/** The percent of the period spent halted. */
389	uint8_t cPctHalted;
390	/** The percent of the period spent on other things. */
391	uint8_t cPctOther;
392	} aHistory[30*60];
393	} TMCPULOADSTATE;
394	AssertCompileSizeAlignment(TMCPULOADSTATE, 8);
395	AssertCompileMemberAlignment(TMCPULOADSTATE, cNsPrevTotal, 8);
396	/** Pointer to a CPU load data set. */
397	typedef TMCPULOADSTATE *PTMCPULOADSTATE;
398
399
400	/**
401	* TSC mode.
402	*
403	* The main modes of how TM implements the TSC clock (TMCLOCK_TSC).
404	*/
405	typedef enum TMTSCMODE
406	{
407	/** The guest TSC is an emulated, virtual TSC. */
408	TMTSCMODE_VIRT_TSC_EMULATED = 1,
409	/** The guest TSC is an offset of the real TSC. */
410	TMTSCMODE_REAL_TSC_OFFSET,
411	/** The guest TSC is dynamically derived through emulating or offsetting. */
412	TMTSCMODE_DYNAMIC,
413	/** The native API provides it. */
414	TMTSCMODE_NATIVE_API
415	} TMTSCMODE;
416	AssertCompileSize(TMTSCMODE, sizeof(uint32_t));
417
418
419	/**
420	* TM VM Instance data.
421	* Changes to this must checked against the padding of the cfgm union in VM!
422	*/
423	typedef struct TM
424	{
425	/** Timer queues for the different clock types.
426	* @note is first in the structure to ensure cache-line alignment. */
427	TMTIMERQUEUE aTimerQueues[TMCLOCK_MAX];
428
429	/** The current TSC mode of the VM.
430	* Config variable: Mode (string). */
431	TMTSCMODE enmTSCMode;
432	/** The original TSC mode of the VM. */
433	TMTSCMODE enmOriginalTSCMode;
434	/** Whether the TSC is tied to the execution of code.
435	* Config variable: TSCTiedToExecution (bool) */
436	bool fTSCTiedToExecution;
437	/** Modifier for fTSCTiedToExecution which pauses the TSC while halting if true.
438	* Config variable: TSCNotTiedToHalt (bool) */
439	bool fTSCNotTiedToHalt;
440	/** Whether TM TSC mode switching is allowed at runtime. */
441	bool fTSCModeSwitchAllowed;
442	/** Whether the guest has enabled use of paravirtualized TSC. */
443	bool fParavirtTscEnabled;
444	/** The ID of the virtual CPU that normally runs the timers. */
445	VMCPUID idTimerCpu;
446
447	/** The number of CPU clock ticks per second (TMCLOCK_TSC).
448	* Config variable: TSCTicksPerSecond (64-bit unsigned int)
449	* The config variable implies @c enmTSCMode would be
450	* TMTSCMODE_VIRT_TSC_EMULATED. */
451	uint64_t cTSCTicksPerSecond;
452	/** The TSC difference introduced by pausing the VM. */
453	uint64_t offTSCPause;
454	/** The TSC value when the last TSC was paused. */
455	uint64_t u64LastPausedTSC;
456	/** CPU TSCs ticking indicator (one for each VCPU). */
457	uint32_t volatile cTSCsTicking;
458
459	/** Virtual time ticking enabled indicator (counter for each VCPU). (TMCLOCK_VIRTUAL) */
460	uint32_t volatile cVirtualTicking;
461	/** Virtual time is not running at 100%. */
462	bool fVirtualWarpDrive;
463	/** Virtual timer synchronous time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL_SYNC) */
464	bool volatile fVirtualSyncTicking;
465	/** Virtual timer synchronous time catch-up active. */
466	bool volatile fVirtualSyncCatchUp;
467	/** Alignment padding. */
468	bool afAlignment1[1];
469	/** WarpDrive percentage.
470	* 100% is normal (fVirtualSyncNormal == true). When other than 100% we apply
471	* this percentage to the raw time source for the period it's been valid in,
472	* i.e. since u64VirtualWarpDriveStart. */
473	uint32_t u32VirtualWarpDrivePercentage;
474
475	/** The offset of the virtual clock relative to it's timesource.
476	* Only valid if fVirtualTicking is set. */
477	uint64_t u64VirtualOffset;
478	/** The guest virtual time when fVirtualTicking is cleared. */
479	uint64_t u64Virtual;
480	/** When the Warp drive was started or last adjusted.
481	* Only valid when fVirtualWarpDrive is set. */
482	uint64_t u64VirtualWarpDriveStart;
483	/** The previously returned nano TS.
484	* This handles TSC drift on SMP systems and expired interval.
485	* This is a valid range u64NanoTS to u64NanoTS + 1000000000 (ie. 1sec). */
486	uint64_t volatile u64VirtualRawPrev;
487	/** The ring-3 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
488	RTTIMENANOTSDATAR3 VirtualGetRawDataR3;
489	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
490	RTTIMENANOTSDATAR0 VirtualGetRawDataR0;
491	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
492	RTTIMENANOTSDATARC VirtualGetRawDataRC;
493	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
494	R3PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR3;
495	/** Pointer to the ring-0 tmVirtualGetRawNanoTS worker function. */
496	R0PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR0;
497	/** Pointer to the raw-mode tmVirtualGetRawNanoTS worker function. */
498	RCPTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawRC;
499	/** Alignment. */
500	RTRCPTR AlignmentRCPtr;
501	/** The guest virtual timer synchronous time when fVirtualSyncTicking is cleared.
502	* When fVirtualSyncTicking is set it holds the last time returned to
503	* the guest (while the lock was held). */
504	uint64_t volatile u64VirtualSync;
505	/** The offset of the timer synchronous virtual clock (TMCLOCK_VIRTUAL_SYNC) relative
506	* to the virtual clock (TMCLOCK_VIRTUAL).
507	* (This is accessed by the timer thread and must be updated atomically.) */
508	uint64_t volatile offVirtualSync;
509	/** The offset into offVirtualSync that's been irrevocably given up by failed catch-up attempts.
510	* Thus the current lag is offVirtualSync - offVirtualSyncGivenUp. */
511	uint64_t offVirtualSyncGivenUp;
512	/** The TMCLOCK_VIRTUAL at the previous TMVirtualGetSync call when catch-up is active. */
513	uint64_t volatile u64VirtualSyncCatchUpPrev;
514	/** The current catch-up percentage. */
515	uint32_t volatile u32VirtualSyncCatchUpPercentage;
516	/** How much slack when processing timers. */
517	uint32_t u32VirtualSyncScheduleSlack;
518	/** When to stop catch-up. */
519	uint64_t u64VirtualSyncCatchUpStopThreshold;
520	/** When to give up catch-up. */
521	uint64_t u64VirtualSyncCatchUpGiveUpThreshold;
522	/** @def TM_MAX_CATCHUP_PERIODS
523	* The number of catchup rates. */
524	#define TM_MAX_CATCHUP_PERIODS 10
525	/** The aggressiveness of the catch-up relative to how far we've lagged behind.
526	* The idea is to have increasing catch-up percentage as the lag increases. */
527	struct TMCATCHUPPERIOD
528	{
529	uint64_t u64Start; /*< When this period starts. (u64VirtualSyncOffset). /
530	uint32_t u32Percentage; /*< The catch-up percent to apply. /
531	uint32_t u32Alignment; /*< Structure alignment /
532	} aVirtualSyncCatchUpPeriods[TM_MAX_CATCHUP_PERIODS];
533
534	union
535	{
536	/** Combined value for updating. */
537	uint64_t volatile u64Combined;
538	struct
539	{
540	/** Bitmap indicating which timer queues needs their uMaxHzHint updated. */
541	uint32_t volatile bmNeedsUpdating;
542	/** The current max timer Hz hint. */
543	uint32_t volatile uMax;
544	} s;
545	} HzHint;
546	/** @cfgm{/TM/HostHzMax, uint32_t, Hz, 0, UINT32_MAX, 20000}
547	* The max host Hz frequency hint returned by TMCalcHostTimerFrequency. */
548	uint32_t cHostHzMax;
549	/** @cfgm{/TM/HostHzFudgeFactorTimerCpu, uint32_t, Hz, 0, UINT32_MAX, 111}
550	* The number of Hz TMCalcHostTimerFrequency adds for the timer CPU. */
551	uint32_t cPctHostHzFudgeFactorTimerCpu;
552	/** @cfgm{/TM/HostHzFudgeFactorOtherCpu, uint32_t, Hz, 0, UINT32_MAX, 110}
553	* The number of Hz TMCalcHostTimerFrequency adds for the other CPUs. */
554	uint32_t cPctHostHzFudgeFactorOtherCpu;
555	/** @cfgm{/TM/HostHzFudgeFactorCatchUp100, uint32_t, Hz, 0, UINT32_MAX, 300}
556	* The fudge factor (expressed in percent) that catch-up percentages below
557	* 100% is multiplied by. */
558	uint32_t cPctHostHzFudgeFactorCatchUp100;
559	/** @cfgm{/TM/HostHzFudgeFactorCatchUp200, uint32_t, Hz, 0, UINT32_MAX, 250}
560	* The fudge factor (expressed in percent) that catch-up percentages
561	* 100%-199% is multiplied by. */
562	uint32_t cPctHostHzFudgeFactorCatchUp200;
563	/** @cfgm{/TM/HostHzFudgeFactorCatchUp400, uint32_t, Hz, 0, UINT32_MAX, 200}
564	* The fudge factor (expressed in percent) that catch-up percentages
565	* 200%-399% is multiplied by. */
566	uint32_t cPctHostHzFudgeFactorCatchUp400;
567
568	/** The UTC offset in ns.
569	* This is NOT for converting UTC to local time. It is for converting real
570	* world UTC time to VM UTC time. This feature is indented for doing date
571	* testing of software and similar.
572	* @todo Implement warpdrive on UTC. */
573	int64_t offUTC;
574	/** The last value TMR3UtcNow returned. */
575	int64_t volatile nsLastUtcNow;
576	/** File to touch on UTC jump. */
577	R3PTRTYPE(char *) pszUtcTouchFileOnJump;
578	/** Just to avoid dealing with 32-bit alignment trouble. */
579	R3PTRTYPE(char *) pszAlignment2b;
580
581	/** Pointer to our RC mapping of the GIP. */
582	RCPTRTYPE(void *) pvGIPRC;
583	/** Pointer to our R3 mapping of the GIP. */
584	R3PTRTYPE(void *) pvGIPR3;
585
586
587	/** The schedule timer timer handle (runtime timer).
588	* This timer will do frequent check on pending queue schedules and
589	* raise VM_FF_TIMER to pull EMTs attention to them.
590	*/
591	R3PTRTYPE(PRTTIMER) pTimer;
592	/** Interval in milliseconds of the pTimer timer. */
593	uint32_t u32TimerMillies;
594
595	/** Indicates that queues are being run. */
596	bool volatile fRunningQueues;
597	/** Indicates that the virtual sync queue is being run. */
598	bool volatile fRunningVirtualSyncQueue;
599	/** Alignment */
600	bool afAlignment3[2];
601
602	/** Lock serializing access to the VirtualSync clock and the associated
603	* timer queue.
604	* @todo Consider merging this with the TMTIMERQUEUE::TimerLock for the
605	* virtual sync queue. */
606	PDMCRITSECT VirtualSyncLock;
607
608	/** CPU load state for all the virtual CPUs (tmR3CpuLoadTimer). */
609	TMCPULOADSTATE CpuLoad;
610
611	/** TMR3TimerQueuesDo
612	* @{ */
613	STAMPROFILE StatDoQueues;
614	/** @} */
615	/** tmSchedule
616	* @{ */
617	STAMPROFILE StatScheduleOneRZ;
618	STAMPROFILE StatScheduleOneR3;
619	STAMCOUNTER StatScheduleSetFF;
620	STAMCOUNTER StatPostponedR3;
621	STAMCOUNTER StatPostponedRZ;
622	/** @} */
623	/** Read the time
624	* @{ */
625	STAMCOUNTER StatVirtualGet;
626	STAMCOUNTER StatVirtualGetSetFF;
627	STAMCOUNTER StatVirtualSyncGet;
628	STAMCOUNTER StatVirtualSyncGetAdjLast;
629	STAMCOUNTER StatVirtualSyncGetELoop;
630	STAMCOUNTER StatVirtualSyncGetExpired;
631	STAMCOUNTER StatVirtualSyncGetLockless;
632	STAMCOUNTER StatVirtualSyncGetLocked;
633	STAMCOUNTER StatVirtualSyncGetSetFF;
634	STAMCOUNTER StatVirtualPause;
635	STAMCOUNTER StatVirtualResume;
636	/** @} */
637	/** TMTimerPoll
638	* @{ */
639	STAMCOUNTER StatPoll;
640	STAMCOUNTER StatPollAlreadySet;
641	STAMCOUNTER StatPollELoop;
642	STAMCOUNTER StatPollMiss;
643	STAMCOUNTER StatPollRunning;
644	STAMCOUNTER StatPollSimple;
645	STAMCOUNTER StatPollVirtual;
646	STAMCOUNTER StatPollVirtualSync;
647	/** @} */
648	/** TMTimerSet sans virtual sync timers.
649	* @{ */
650	STAMCOUNTER StatTimerSet;
651	STAMCOUNTER StatTimerSetOpt;
652	STAMPROFILE StatTimerSetRZ;
653	STAMPROFILE StatTimerSetR3;
654	STAMCOUNTER StatTimerSetStStopped;
655	STAMCOUNTER StatTimerSetStExpDeliver;
656	STAMCOUNTER StatTimerSetStActive;
657	STAMCOUNTER StatTimerSetStPendStop;
658	STAMCOUNTER StatTimerSetStPendStopSched;
659	STAMCOUNTER StatTimerSetStPendSched;
660	STAMCOUNTER StatTimerSetStPendResched;
661	STAMCOUNTER StatTimerSetStOther;
662	/** @} */
663	/** TMTimerSet on virtual sync timers.
664	* @{ */
665	STAMCOUNTER StatTimerSetVs;
666	STAMPROFILE StatTimerSetVsRZ;
667	STAMPROFILE StatTimerSetVsR3;
668	STAMCOUNTER StatTimerSetVsStStopped;
669	STAMCOUNTER StatTimerSetVsStExpDeliver;
670	STAMCOUNTER StatTimerSetVsStActive;
671	/** @} */
672	/** TMTimerSetRelative sans virtual sync timers
673	* @{ */
674	STAMCOUNTER StatTimerSetRelative;
675	STAMPROFILE StatTimerSetRelativeRZ;
676	STAMPROFILE StatTimerSetRelativeR3;
677	STAMCOUNTER StatTimerSetRelativeOpt;
678	STAMCOUNTER StatTimerSetRelativeStStopped;
679	STAMCOUNTER StatTimerSetRelativeStExpDeliver;
680	STAMCOUNTER StatTimerSetRelativeStActive;
681	STAMCOUNTER StatTimerSetRelativeStPendStop;
682	STAMCOUNTER StatTimerSetRelativeStPendStopSched;
683	STAMCOUNTER StatTimerSetRelativeStPendSched;
684	STAMCOUNTER StatTimerSetRelativeStPendResched;
685	STAMCOUNTER StatTimerSetRelativeStOther;
686	/** @} */
687	/** TMTimerSetRelative on virtual sync timers.
688	* @{ */
689	STAMCOUNTER StatTimerSetRelativeVs;
690	STAMPROFILE StatTimerSetRelativeVsRZ;
691	STAMPROFILE StatTimerSetRelativeVsR3;
692	STAMCOUNTER StatTimerSetRelativeVsStStopped;
693	STAMCOUNTER StatTimerSetRelativeVsStExpDeliver;
694	STAMCOUNTER StatTimerSetRelativeVsStActive;
695	/** @} */
696	/** TMTimerStop sans virtual sync.
697	* @{ */
698	STAMPROFILE StatTimerStopRZ;
699	STAMPROFILE StatTimerStopR3;
700	/** @} */
701	/** TMTimerStop on virtual sync timers.
702	* @{ */
703	STAMPROFILE StatTimerStopVsRZ;
704	STAMPROFILE StatTimerStopVsR3;
705	/** @} */
706	/** VirtualSync - Running and Catching Up
707	* @{ */
708	STAMCOUNTER StatVirtualSyncRun;
709	STAMCOUNTER StatVirtualSyncRunRestart;
710	STAMPROFILE StatVirtualSyncRunSlack;
711	STAMCOUNTER StatVirtualSyncRunStop;
712	STAMCOUNTER StatVirtualSyncRunStoppedAlready;
713	STAMCOUNTER StatVirtualSyncGiveUp;
714	STAMCOUNTER StatVirtualSyncGiveUpBeforeStarting;
715	STAMPROFILEADV StatVirtualSyncCatchup;
716	STAMCOUNTER aStatVirtualSyncCatchupInitial[TM_MAX_CATCHUP_PERIODS];
717	STAMCOUNTER aStatVirtualSyncCatchupAdjust[TM_MAX_CATCHUP_PERIODS];
718	/** @} */
719	/** TMR3VirtualSyncFF (non dedicated EMT). */
720	STAMPROFILE StatVirtualSyncFF;
721	/** The timer callback. */
722	STAMCOUNTER StatTimerCallbackSetFF;
723	STAMCOUNTER StatTimerCallback;
724
725	/** Calls to TMCpuTickSet. */
726	STAMCOUNTER StatTSCSet;
727
728	/** TSC starts and stops. */
729	STAMCOUNTER StatTSCPause;
730	STAMCOUNTER StatTSCResume;
731
732	/** @name Reasons for refusing TSC offsetting in TMCpuTickCanUseRealTSC.
733	* @{ */
734	STAMCOUNTER StatTSCNotFixed;
735	STAMCOUNTER StatTSCNotTicking;
736	STAMCOUNTER StatTSCCatchupLE010;
737	STAMCOUNTER StatTSCCatchupLE025;
738	STAMCOUNTER StatTSCCatchupLE100;
739	STAMCOUNTER StatTSCCatchupOther;
740	STAMCOUNTER StatTSCWarp;
741	STAMCOUNTER StatTSCUnderflow;
742	STAMCOUNTER StatTSCSyncNotTicking;
743	/** @} */
744	} TM;
745	/** Pointer to TM VM instance data. */
746	typedef TM *PTM;
747
748
749	/**
750	* TM VMCPU Instance data.
751	* Changes to this must checked against the padding of the tm union in VM!
752	*/
753	typedef struct TMCPU
754	{
755	/** The offset between the host tick (TSC/virtual depending on the TSC mode) and
756	* the guest tick. */
757	uint64_t offTSCRawSrc;
758	/** The guest TSC when fTicking is cleared. */
759	uint64_t u64TSC;
760	/** The last seen TSC by the guest. */
761	uint64_t u64TSCLastSeen;
762	/** CPU timestamp ticking enabled indicator (bool). (RDTSC) */
763	bool fTSCTicking;
764	#ifdef VBOX_WITHOUT_NS_ACCOUNTING
765	bool afAlignment1[7]; /*< alignment padding /
766	#else /* !VBOX_WITHOUT_NS_ACCOUNTING */
767
768	/** Set by the timer callback to trigger updating of statistics in
769	* TMNotifyEndOfExecution. */
770	bool volatile fUpdateStats;
771	bool afAlignment1[6];
772	/** The time not spent executing or halted.
773	* @note Only updated after halting and after the timer runs. */
774	uint64_t cNsOtherStat;
775	/** Reasonably up to date total run time value.
776	* @note Only updated after halting and after the timer runs. */
777	uint64_t cNsTotalStat;
778	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
779	/** Resettable copy of version of cNsOtherStat.
780	* @note Only updated after halting. */
781	STAMCOUNTER StatNsOther;
782	/** Resettable copy of cNsTotalStat.
783	* @note Only updated after halting. */
784	STAMCOUNTER StatNsTotal;
785	# else
786	uint64_t auAlignment2[2];
787	# endif
788
789	/** @name Core accounting data.
790	* @note Must be cache-line aligned and only written to by the EMT owning it.
791	* @{ */
792	/** The cNsXXX generation. */
793	uint32_t volatile uTimesGen;
794	/** Set if executing (between TMNotifyStartOfExecution and
795	* TMNotifyEndOfExecution). */
796	bool volatile fExecuting;
797	/** Set if halting (between TMNotifyStartOfHalt and TMNotifyEndOfHalt). */
798	bool volatile fHalting;
799	/** Set if we're suspended and u64NsTsStartTotal is to be cNsTotal. */
800	bool volatile fSuspended;
801	bool afAlignment;
802	/** The nanosecond timestamp of the CPU start or resume.
803	* This is recalculated when the VM is started so that
804	* cNsTotal = RTTimeNanoTS() - u64NsTsStartCpu. */
805	uint64_t nsStartTotal;
806	/** The TSC of the last start-execute notification. */
807	uint64_t uTscStartExecuting;
808	/** The number of nanoseconds spent executing. */
809	uint64_t cNsExecuting;
810	/** The number of guest execution runs. */
811	uint64_t cPeriodsExecuting;
812	/** The nanosecond timestamp of the last start-halt notification. */
813	uint64_t nsStartHalting;
814	/** The number of nanoseconds being halted. */
815	uint64_t cNsHalted;
816	/** The number of halts. */
817	uint64_t cPeriodsHalted;
818	/** @} */
819
820	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
821	/** Resettable version of cNsExecuting. */
822	STAMPROFILE StatNsExecuting;
823	/** Long execution intervals. */
824	STAMPROFILE StatNsExecLong;
825	/** Short execution intervals. */
826	STAMPROFILE StatNsExecShort;
827	/** Tiny execution intervals. */
828	STAMPROFILE StatNsExecTiny;
829	/** Resettable version of cNsHalted. */
830	STAMPROFILE StatNsHalted;
831	# endif
832
833	/** CPU load state for this virtual CPU (tmR3CpuLoadTimer). */
834	TMCPULOADSTATE CpuLoad;
835	#endif
836	} TMCPU;
837	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
838	AssertCompileMemberAlignment(TMCPU, uTimesGen, 64);
839	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
840	AssertCompileMemberAlignment(TMCPU, StatNsExecuting, 64);
841	# else
842	AssertCompileMemberAlignment(TMCPU, CpuLoad, 64);
843	# endif
844	#endif
845	/** Pointer to TM VMCPU instance data. */
846	typedef TMCPU *PTMCPU;
847
848
849	/**
850	* TM data kept in the ring-0 GVM.
851	*/
852	typedef struct TMR0PERVM
853	{
854	/** Timer queues for the different clock types. */
855	TMTIMERQUEUER0 aTimerQueues[TMCLOCK_MAX];
856	} TMR0PERVM;
857
858
859	const char *tmTimerState(TMTIMERSTATE enmState);
860	void tmTimerQueueSchedule(PVMCC pVM, PTMTIMERQUEUECC pQueueCC, PTMTIMERQUEUE pQueue);
861	#ifdef VBOX_STRICT
862	void tmTimerQueuesSanityChecks(PVMCC pVM, const char *pszWhere);
863	#endif
864
865	uint64_t tmR3CpuTickGetRawVirtualNoCheck(PVM pVM);
866	int tmCpuTickPause(PVMCPUCC pVCpu);
867	int tmCpuTickPauseLocked(PVMCC pVM, PVMCPUCC pVCpu);
868	int tmCpuTickResume(PVMCC pVM, PVMCPUCC pVCpu);
869	int tmCpuTickResumeLocked(PVMCC pVM, PVMCPUCC pVCpu);
870
871	int tmVirtualPauseLocked(PVMCC pVM);
872	int tmVirtualResumeLocked(PVMCC pVM);
873	DECLCALLBACK(DECLEXPORT(void)) tmVirtualNanoTSBad(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS,
874	uint64_t u64DeltaPrev, uint64_t u64PrevNanoTS);
875	DECLCALLBACK(DECLEXPORT(uint64_t)) tmVirtualNanoTSRediscover(PRTTIMENANOTSDATA pData, PRTITMENANOTSEXTRA pExtra);
876	DECLCALLBACK(DECLEXPORT(uint64_t)) tmVirtualNanoTSBadCpuIndex(PRTTIMENANOTSDATA pData, PRTITMENANOTSEXTRA pExtra,
877	uint16_t idApic, uint16_t iCpuSet, uint16_t iGipCpu);
878	/** @} */
879
880	RT_C_DECLS_END
881
882	#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@ 87816

Download in other formats: