TMInternal.h@ 4377

Last change on this file since 4377 was 4071, checked in by vboxsync, 17 years ago
Biggest check-in ever. New source code headers for all (C) innotek files.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 18.4 KB

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

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

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

Download in other formats: