TMInternal.h@ 6796

Last change on this file since 6796 was 6183, checked in by vboxsync, 17 years ago
Back out of r26783.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 19.3 KB

Line
1	/* $Id: TMInternal.h 6183 2007-12-24 09:03:59Z vboxsync $ */
2	/** @file
3	* TM - Internal header file.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 innotek GmbH
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 ___TMInternal_h
19	#define ___TMInternal_h
20
21	#include <VBox/cdefs.h>
22	#include <VBox/types.h>
23	#include <iprt/time.h>
24	#include <iprt/timer.h>
25	#include <VBox/stam.h>
26
27	__BEGIN_DECLS
28
29
30	/** @defgroup grp_tm_int Internal
31	* @ingroup grp_tm
32	* @internal
33	* @{
34	*/
35
36	/** Frequency of the real clock. */
37	#define TMCLOCK_FREQ_REAL UINT32_C(1000)
38	/** Frequency of the virtual clock. */
39	#define TMCLOCK_FREQ_VIRTUAL UINT32_C(1000000000)
40
41
42	/**
43	* Timer type.
44	*/
45	typedef enum TMTIMERTYPE
46	{
47	/** Device timer. */
48	TMTIMERTYPE_DEV = 1,
49	/** Driver timer. */
50	TMTIMERTYPE_DRV,
51	/** Internal timer . */
52	TMTIMERTYPE_INTERNAL,
53	/** External timer. */
54	TMTIMERTYPE_EXTERNAL
55	} TMTIMERTYPE;
56
57	/**
58	* Timer state
59	*/
60	typedef enum TMTIMERSTATE
61	{
62	/** Timer is stopped. */
63	TMTIMERSTATE_STOPPED = 1,
64	/** Timer is active. */
65	TMTIMERSTATE_ACTIVE,
66	/** Timer is expired, is being delivered. */
67	TMTIMERSTATE_EXPIRED,
68
69	/** Timer is stopped but still in the active list.
70	* Currently in the ScheduleTimers list. */
71	TMTIMERSTATE_PENDING_STOP,
72	/** Timer is stopped but needs unlinking from the ScheduleTimers list.
73	* Currently in the ScheduleTimers list. */
74	TMTIMERSTATE_PENDING_STOP_SCHEDULE,
75	/** Timer is being modified and will soon be pending scheduling.
76	* Currently in the ScheduleTimers list. */
77	TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE,
78	/** Timer is pending scheduling.
79	* Currently in the ScheduleTimers list. */
80	TMTIMERSTATE_PENDING_SCHEDULE,
81	/** Timer is being modified and will soon be pending rescheduling.
82	* Currently in the ScheduleTimers list and the active list. */
83	TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE,
84	/** Timer is modified and is now pending rescheduling.
85	* Currently in the ScheduleTimers list and the active list. */
86	TMTIMERSTATE_PENDING_RESCHEDULE,
87	/** Timer is destroyed but needs to be replaced from the
88	* active to the free list.
89	* Currently in the ScheduleTimers list and the active list. */
90	TMTIMERSTATE_PENDING_STOP_DESTROY,
91	/** Timer is destroyed but needs moving to the free list.
92	* Currently in the ScheduleTimers list. */
93	TMTIMERSTATE_PENDING_DESTROY,
94	/** Timer is free. */
95	TMTIMERSTATE_FREE
96	} TMTIMERSTATE;
97
98
99	/**
100	* Internal representation of a timer.
101	*
102	* For correct serialization (without the use of semaphores and
103	* other blocking/slow constructs) certain rules applies to updating
104	* this structure:
105	* - For thread other than EMT only u64Expire, enmState and pScheduleNext*
106	* are changeable. Everything else is out of bounds.
107	* - Updating of u64Expire timer can only happen in the TMTIMERSTATE_STOPPED
108	* and TMTIMERSTATE_PENDING_RESCHEDULING_SET_EXPIRE states.
109	* - Timers in the TMTIMERSTATE_EXPIRED state are only accessible from EMT.
110	* - Actual destruction of a timer can only be done at scheduling time.
111	*/
112	typedef struct TMTIMER
113	{
114	/** Expire time. */
115	volatile uint64_t u64Expire;
116	/** Clock to apply to u64Expire. */
117	TMCLOCK enmClock;
118	/** Timer callback type. */
119	TMTIMERTYPE enmType;
120	/** Type specific data. */
121	union
122	{
123	/** TMTIMERTYPE_DEV. */
124	struct
125	{
126	/** Callback. */
127	R3PTRTYPE(PFNTMTIMERDEV) pfnTimer;
128	/** Device instance. */
129	R3PTRTYPE(PPDMDEVINS) pDevIns;
130	} Dev;
131
132	/** TMTIMERTYPE_DRV. */
133	struct
134	{
135	/** Callback. */
136	R3PTRTYPE(PFNTMTIMERDRV) pfnTimer;
137	/** Device instance. */
138	R3PTRTYPE(PPDMDRVINS) pDrvIns;
139	} Drv;
140
141	/** TMTIMERTYPE_INTERNAL. */
142	struct
143	{
144	/** Callback. */
145	R3PTRTYPE(PFNTMTIMERINT) pfnTimer;
146	/** User argument. */
147	R3PTRTYPE(void *) pvUser;
148	} Internal;
149
150	/** TMTIMERTYPE_EXTERNAL. */
151	struct
152	{
153	/** Callback. */
154	R3PTRTYPE(PFNTMTIMEREXT) pfnTimer;
155	/** User data. */
156	R3PTRTYPE(void *) pvUser;
157	} External;
158	} u;
159
160	/** Timer state. */
161	volatile TMTIMERSTATE enmState;
162	/** Timer relative offset to the next timer in the schedule list. */
163	int32_t offScheduleNext;
164
165	/** Timer relative offset to the next timer in the chain. */
166	int32_t offNext;
167	/** Timer relative offset to the previous timer in the chain. */
168	int32_t offPrev;
169
170	/** Pointer to the next timer in the list of created or free timers. (TM::pTimers or TM::pFree) */
171	PTMTIMERR3 pBigNext;
172	/** Pointer to the previous timer in the list of all created timers. (TM::pTimers) */
173	PTMTIMERR3 pBigPrev;
174	/** Pointer to the timer description. */
175	R3PTRTYPE(const char *) pszDesc;
176	/** Pointer to the VM the timer belongs to - R3 Ptr. */
177	PVMR3 pVMR3;
178	/** Pointer to the VM the timer belongs to - R0 Ptr. */
179	PVMR0 pVMR0;
180	/** Pointer to the VM the timer belongs to - GC Ptr. */
181	PVMGC pVMGC;
182	#if HC_ARCH_BITS == 64 && GC_ARCH_BITS == 32
183	RTGCPTR padding0; /*< pad structure to multiple of 8 bytes. /
184	#endif
185	} TMTIMER;
186
187
188	/**
189	* Updates a timer state in the correct atomic manner.
190	*/
191	#if 1
192	# define TM_SET_STATE(pTimer, state) \
193	ASMAtomicXchgSize(&(pTimer)->enmState, state)
194	#else
195	# define TM_SET_STATE(pTimer, state) \
196	do { Log(("%s: %p: %d -> %d\n", __FUNCTION__, (pTimer), (pTimer)->enmState, state)); \
197	ASMAtomicXchgSize(&(pTimer)->enmState, state);\
198	} while (0)
199	#endif
200
201	/**
202	* Tries to updates a timer state in the correct atomic manner.
203	*/
204	#if 1
205	# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
206	ASMAtomicCmpXchgSize(&(pTimer)->enmState, StateNew, StateOld, fRc)
207	#else
208	# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
209	do { ASMAtomicCmpXchgSize(&(pTimer)->enmState, StateNew, StateOld, fRc); \
210	Log(("%s: %p: %d -> %d %RTbool\n", __FUNCTION__, (pTimer), StateOld, StateNew, fRc)); \
211	} while (0)
212	#endif
213
214	/** Get the previous timer. */
215	#define TMTIMER_GET_PREV(pTimer) ((PTMTIMER)((pTimer)->offPrev ? (intptr_t)(pTimer) + (pTimer)->offPrev : 0))
216	/** Get the next timer. */
217	#define TMTIMER_GET_NEXT(pTimer) ((PTMTIMER)((pTimer)->offNext ? (intptr_t)(pTimer) + (pTimer)->offNext : 0))
218	/** Set the previous timer link. */
219	#define TMTIMER_SET_PREV(pTimer, pPrev) ((pTimer)->offPrev = (pPrev) ? (intptr_t)(pPrev) - (intptr_t)(pTimer) : 0)
220	/** Set the next timer link. */
221	#define TMTIMER_SET_NEXT(pTimer, pNext) ((pTimer)->offNext = (pNext) ? (intptr_t)(pNext) - (intptr_t)(pTimer) : 0)
222
223
224	/**
225	* A timer queue.
226	*
227	* This is allocated on the hyper heap.
228	*/
229	typedef struct TMTIMERQUEUE
230	{
231	/** The cached expire time for this queue.
232	* Updated by EMT when scheduling the queue or modifying the head timer.
233	* Assigned UINT64_MAX when there is no head timer. */
234	uint64_t u64Expire;
235	/** Doubly linked list of active timers.
236	*
237	* When no scheduling is pending, this list is will be ordered by expire time (ascending).
238	* Access is serialized by only letting the emulation thread (EMT) do changes.
239	*
240	* The offset is relative to the queue structure.
241	*/
242	int32_t offActive;
243	/** List of timers pending scheduling of some kind.
244	*
245	* Timer stats allowed in the list are TMTIMERSTATE_PENDING_STOPPING,
246	* TMTIMERSTATE_PENDING_DESTRUCTION, TMTIMERSTATE_PENDING_STOPPING_DESTRUCTION,
247	* TMTIMERSTATE_PENDING_RESCHEDULING and TMTIMERSTATE_PENDING_SCHEDULE.
248	*
249	* The offset is relative to the queue structure.
250	*/
251	int32_t volatile offSchedule;
252	/** The clock for this queue. */
253	TMCLOCK enmClock;
254	/** Pad the structure up to 32 bytes. */
255	uint32_t au32Padding[3];
256	} TMTIMERQUEUE;
257
258	/** Pointer to a timer queue. */
259	typedef TMTIMERQUEUE *PTMTIMERQUEUE;
260
261	/** Get the head of the active timer list. */
262	#define TMTIMER_GET_HEAD(pQueue) ((PTMTIMER)((pQueue)->offActive ? (intptr_t)(pQueue) + (pQueue)->offActive : 0))
263	/** Set the head of the active timer list. */
264	#define TMTIMER_SET_HEAD(pQueue, pHead) ((pQueue)->offActive = pHead ? (intptr_t)pHead - (intptr_t)(pQueue) : 0)
265
266
267	/**
268	* Converts a TM pointer into a VM pointer.
269	* @returns Pointer to the VM structure the TM is part of.
270	* @param pTM Pointer to TM instance data.
271	*/
272	#define TM2VM(pTM) ( (PVM)((char*)pTM - pTM->offVM) )
273
274
275	/**
276	* TM VM Instance data.
277	* Changes to this must checked against the padding of the cfgm union in VM!
278	*/
279	typedef struct TM
280	{
281	/** Offset to the VM structure.
282	* See TM2VM(). */
283	RTUINT offVM;
284
285	/** Flag indicating that the host TSC is suitable for use in AMD-V and VT-x mode.
286	* Config variable: MaybeUseOffsettedHostTSC (boolean) */
287	bool fMaybeUseOffsettedHostTSC;
288	/** CPU timestamp ticking enabled indicator (bool). (RDTSC) */
289	bool fTSCTicking;
290	/** Set if we fully virtualize the TSC, i.e. intercept all rdtsc instructions.
291	* Config variable: TSCVirtualized (bool) */
292	bool fTSCVirtualized;
293	/** Set if we use the real TSC as time source or if we use the virtual clock.
294	* If fTSCVirtualized is set we maintain a offset to the TSC and pausing/resuming the
295	* ticking. fTSCVirtualized = false implies fTSCUseRealTSC = true.
296	* Config variable: TSCUseRealTSC (bool) */
297	bool fTSCUseRealTSC;
298	/** The offset between the host TSC and the Guest TSC.
299	* Only valid if fTicking is set and and fTSCUseRealTSC is clear. */
300	uint64_t u64TSCOffset;
301	/** The guest TSC when fTicking is cleared. */
302	uint64_t u64TSC;
303	/** The number of CPU clock ticks per second (TMCLOCK_TSC).
304	* Config variable: TSCTicksPerSecond (64-bit unsigned int)
305	* The config variable implies fTSCVirtualized = true and fTSCUseRealTSC = false. */
306	uint64_t cTSCTicksPerSecond;
307
308	/** Virtual time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL) */
309	bool fVirtualTicking;
310	/** Virtual time is not running at 100%. */
311	bool fVirtualWarpDrive;
312	/** Virtual timer synchronous time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL_SYNC) */
313	bool volatile fVirtualSyncTicking;
314	/** Virtual timer synchronous time catch-up active. */
315	bool volatile fVirtualSyncCatchUp;
316	/** WarpDrive percentage.
317	* 100% is normal (fVirtualSyncNormal == true). When other than 100% we apply
318	* this percentage to the raw time source for the period it's been valid in,
319	* i.e. since u64VirtualWarpDriveStart. */
320	uint32_t u32VirtualWarpDrivePercentage;
321
322	/** The offset of the virtual clock relative to it's timesource.
323	* Only valid if fVirtualTicking is set. */
324	uint64_t u64VirtualOffset;
325	/** The guest virtual time when fVirtualTicking is cleared. */
326	uint64_t u64Virtual;
327	/** When the Warp drive was started or last adjusted.
328	* Only valid when fVirtualWarpDrive is set. */
329	uint64_t u64VirtualWarpDriveStart;
330	/** The previously returned nano TS.
331	* This handles TSC drift on SMP systems and expired interval.
332	* This is a valid range u64NanoTS to u64NanoTS + 1000000000 (ie. 1sec). */
333	uint64_t volatile u64VirtualRawPrev;
334	/** The ring-3 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
335	RTTIMENANOTSDATAR3 VirtualGetRawDataR3;
336	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
337	RTTIMENANOTSDATAR0 VirtualGetRawDataR0;
338	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
339	RTTIMENANOTSDATAGC VirtualGetRawDataGC;
340	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
341	R3PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR3;
342	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
343	R0PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR0;
344	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
345	GCPTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawGC;
346	/** Alignment. */
347	RTGCPTR AlignmentGCPtr;
348	/** The guest virtual timer synchronous time when fVirtualSyncTicking is cleared. */
349	uint64_t volatile u64VirtualSync;
350	/** The offset of the timer synchronous virtual clock (TMCLOCK_VIRTUAL_SYNC) relative
351	* to the virtual clock (TMCLOCK_VIRTUAL).
352	* (This is accessed by the timer thread and must be updated atomically.) */
353	uint64_t volatile offVirtualSync;
354	/** The offset into offVirtualSync that's been irrevocably given up by failed catch-up attempts.
355	* Thus the current lag is offVirtualSync - offVirtualSyncGivenUp. */
356	uint64_t offVirtualSyncGivenUp;
357	/** The TMCLOCK_VIRTUAL at the previous TMVirtualGetSync call when catch-up is active. */
358	uint64_t volatile u64VirtualSyncCatchUpPrev;
359	/** The current catch-up percentage. */
360	uint32_t volatile u32VirtualSyncCatchUpPercentage;
361	/** How much slack when processing timers. */
362	uint32_t u32VirtualSyncScheduleSlack;
363	/** When to stop catch-up. */
364	uint64_t u64VirtualSyncCatchUpStopThreshold;
365	/** When to give up catch-up. */
366	uint64_t u64VirtualSyncCatchUpGiveUpThreshold;
367	/** @def TM_MAX_CATCHUP_PERIODS
368	* The number of catchup rates. */
369	#define TM_MAX_CATCHUP_PERIODS 10
370	/** The agressivness of the catch-up relative to how far we've lagged behind.
371	* The idea is to have increasing catch-up percentage as the lag increases. */
372	struct TMCATCHUPPERIOD
373	{
374	uint64_t u64Start; /*< When this period starts. (u64VirtualSyncOffset). /
375	uint32_t u32Percentage; /*< The catch-up percent to apply. /
376	uint32_t u32Alignment; /*< Structure alignment /
377	} aVirtualSyncCatchUpPeriods[TM_MAX_CATCHUP_PERIODS];
378
379	/** The UTC offset in ns.
380	* This is NOT for converting UTC to local time. It is for converting real
381	* world UTC time to VM UTC time. This feature is indented for doing date
382	* testing of software and similar.
383	* @todo Implement warpdrive on UTC. */
384	int64_t offUTC;
385
386	/** Timer queues for the different clock types - R3 Ptr */
387	R3PTRTYPE(PTMTIMERQUEUE) paTimerQueuesR3;
388	/** Timer queues for the different clock types - R0 Ptr */
389	R0PTRTYPE(PTMTIMERQUEUE) paTimerQueuesR0;
390	/** Timer queues for the different clock types - GC Ptr */
391	GCPTRTYPE(PTMTIMERQUEUE) paTimerQueuesGC;
392
393	/** Pointer to our GC mapping of the GIP. */
394	GCPTRTYPE(void *) pvGIPGC;
395	/** Pointer to our R3 mapping of the GIP. */
396	R3PTRTYPE(void *) pvGIPR3;
397
398	/** Pointer to a singly linked list of free timers.
399	* This chain is using the TMTIMER::pBigNext members.
400	* Only accessible from the emulation thread. */
401	PTMTIMERR3 pFree;
402
403	/** Pointer to a doubly linked list of created timers.
404	* This chain is using the TMTIMER::pBigNext and TMTIMER::pBigPrev members.
405	* Only accessible from the emulation thread. */
406	PTMTIMERR3 pCreated;
407
408	/** The schedulation timer timer handle (runtime timer).
409	* This timer will do freqent check on pending queue schedulations and
410	* raise VM_FF_TIMER to pull EMTs attention to them.
411	*/
412	R3PTRTYPE(PRTTIMER) pTimer;
413	/** Interval in milliseconds of the pTimer timer. */
414	uint32_t u32TimerMillies;
415
416	/** Alignment padding to ensure that the statistics are 64-bit aligned when using GCC. */
417	uint32_t u32Padding1;
418
419	/** TMR3TimerQueuesDo
420	* @{ */
421	STAMPROFILE StatDoQueues;
422	STAMPROFILEADV StatDoQueuesSchedule;
423	STAMPROFILEADV StatDoQueuesRun;
424	/** @} */
425	/** tmSchedule
426	* @{ */
427	STAMPROFILE StatScheduleOneGC;
428	STAMPROFILE StatScheduleOneR0;
429	STAMPROFILE StatScheduleOneR3;
430	STAMCOUNTER StatScheduleSetFF;
431	STAMCOUNTER StatPostponedR3;
432	STAMCOUNTER StatPostponedR0;
433	STAMCOUNTER StatPostponedGC;
434	/** @} */
435	/** Read the time
436	* @{ */
437	STAMCOUNTER StatVirtualGet;
438	STAMCOUNTER StatVirtualGetSetFF;
439	STAMCOUNTER StatVirtualGetSync;
440	STAMCOUNTER StatVirtualGetSyncSetFF;
441	STAMCOUNTER StatVirtualPause;
442	STAMCOUNTER StatVirtualResume;
443	/* @} */
444	/** TMTimerPoll
445	* @{ */
446	STAMCOUNTER StatPollAlreadySet;
447	STAMCOUNTER StatPollVirtual;
448	STAMCOUNTER StatPollVirtualSync;
449	STAMCOUNTER StatPollMiss;
450	/** @} */
451	/** TMTimerSet
452	* @{ */
453	STAMPROFILE StatTimerSetGC;
454	STAMPROFILE StatTimerSetR0;
455	STAMPROFILE StatTimerSetR3;
456	/** @} */
457	/** TMTimerStop
458	* @{ */
459	STAMPROFILE StatTimerStopGC;
460	STAMPROFILE StatTimerStopR0;
461	STAMPROFILE StatTimerStopR3;
462	/** @} */
463	/** VirtualSync - Running and Catching Up
464	* @{ */
465	STAMCOUNTER StatVirtualSyncRun;
466	STAMCOUNTER StatVirtualSyncRunRestart;
467	STAMPROFILE StatVirtualSyncRunSlack;
468	STAMCOUNTER StatVirtualSyncRunStop;
469	STAMCOUNTER StatVirtualSyncRunStoppedAlready;
470	STAMCOUNTER StatVirtualSyncGiveUp;
471	STAMCOUNTER StatVirtualSyncGiveUpBeforeStarting;
472	STAMPROFILEADV StatVirtualSyncCatchup;
473	STAMCOUNTER aStatVirtualSyncCatchupInitial[TM_MAX_CATCHUP_PERIODS];
474	STAMCOUNTER aStatVirtualSyncCatchupAdjust[TM_MAX_CATCHUP_PERIODS];
475	/** @} */
476	/** The timer callback. */
477	STAMCOUNTER StatTimerCallbackSetFF;
478
479	} TM;
480	/** Pointer to TM VM instance data. */
481	typedef TM *PTM;
482
483
484	const char *tmTimerState(TMTIMERSTATE enmState);
485	void tmTimerQueueSchedule(PVM pVM, PTMTIMERQUEUE pQueue);
486	#ifdef VBOX_STRICT
487	void tmTimerQueuesSanityChecks(PVM pVM, const char *pszWhere);
488	#endif
489
490	DECLEXPORT(void) tmVirtualNanoTSBad(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS, uint64_t u64DeltaPrev, uint64_t u64PrevNanoTS);
491	DECLEXPORT(uint64_t) tmVirtualNanoTSRediscover(PRTTIMENANOTSDATA pData);
492
493	/** @} */
494
495	__END_DECLS
496
497	#endif
498

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

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

Download in other formats: