TMInternal.h@ 53441

Last change on this file since 53441 was 53441, checked in by vboxsync, 10 years ago
VMM/TM: Rename TMMODE to TMTSCMODE and the corresponding enum and CFGM key. Fixed an endian issue in the assembly code.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 31.7 KB

Line
1	/* $Id: TMInternal.h 53441 2014-12-04 11:06:26Z vboxsync $ */
2	/** @file
3	* TM - Internal header file.
4	*/
5
6	/*
7	* Copyright (C) 2006-2014 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 ___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 <iprt/assert.h>
26	#include <VBox/vmm/stam.h>
27	#include <VBox/vmm/pdmcritsect.h>
28
29	RT_C_DECLS_BEGIN
30
31
32	/** @defgroup grp_tm_int Internal
33	* @ingroup grp_tm
34	* @internal
35	* @{
36	*/
37
38	/** Frequency of the real clock. */
39	#define TMCLOCK_FREQ_REAL UINT32_C(1000)
40	/** Frequency of the virtual clock. */
41	#define TMCLOCK_FREQ_VIRTUAL UINT32_C(1000000000)
42
43
44	/**
45	* Timer type.
46	*/
47	typedef enum TMTIMERTYPE
48	{
49	/** Device timer. */
50	TMTIMERTYPE_DEV = 1,
51	/** USB device timer. */
52	TMTIMERTYPE_USB,
53	/** Driver timer. */
54	TMTIMERTYPE_DRV,
55	/** Internal timer . */
56	TMTIMERTYPE_INTERNAL,
57	/** External timer. */
58	TMTIMERTYPE_EXTERNAL
59	} TMTIMERTYPE;
60
61	/**
62	* Timer state
63	*/
64	typedef enum TMTIMERSTATE
65	{
66	/** Timer is stopped. */
67	TMTIMERSTATE_STOPPED = 1,
68	/** Timer is active. */
69	TMTIMERSTATE_ACTIVE,
70	/** Timer is expired, getting expire and unlinking. */
71	TMTIMERSTATE_EXPIRED_GET_UNLINK,
72	/** Timer is expired and is being delivered. */
73	TMTIMERSTATE_EXPIRED_DELIVER,
74
75	/** Timer is stopped but still in the active list.
76	* Currently in the ScheduleTimers list. */
77	TMTIMERSTATE_PENDING_STOP,
78	/** Timer is stopped but needs unlinking from the ScheduleTimers list.
79	* Currently in the ScheduleTimers list. */
80	TMTIMERSTATE_PENDING_STOP_SCHEDULE,
81	/** Timer is being modified and will soon be pending scheduling.
82	* Currently in the ScheduleTimers list. */
83	TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE,
84	/** Timer is pending scheduling.
85	* Currently in the ScheduleTimers list. */
86	TMTIMERSTATE_PENDING_SCHEDULE,
87	/** Timer is being modified and will soon be pending rescheduling.
88	* Currently in the ScheduleTimers list and the active list. */
89	TMTIMERSTATE_PENDING_RESCHEDULE_SET_EXPIRE,
90	/** Timer is modified and is now pending rescheduling.
91	* Currently in the ScheduleTimers list and the active list. */
92	TMTIMERSTATE_PENDING_RESCHEDULE,
93	/** Timer is being destroyed. */
94	TMTIMERSTATE_DESTROY,
95	/** Timer is free. */
96	TMTIMERSTATE_FREE
97	} TMTIMERSTATE;
98
99	/** Predicate that returns true if the give state is pending scheduling or
100	* rescheduling of any kind. Will reference the argument more than once! */
101	#define TMTIMERSTATE_IS_PENDING_SCHEDULING(enmState) \
102	( (enmState) <= TMTIMERSTATE_PENDING_RESCHEDULE \
103	&& (enmState) >= TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE)
104
105
106	/**
107	* Internal representation of a timer.
108	*
109	* For correct serialization (without the use of semaphores and
110	* other blocking/slow constructs) certain rules applies to updating
111	* this structure:
112	* - For thread other than EMT only u64Expire, enmState and pScheduleNext*
113	* are changeable. Everything else is out of bounds.
114	* - Updating of u64Expire timer can only happen in the TMTIMERSTATE_STOPPED
115	* and TMTIMERSTATE_PENDING_RESCHEDULING_SET_EXPIRE states.
116	* - Timers in the TMTIMERSTATE_EXPIRED state are only accessible from EMT.
117	* - Actual destruction of a timer can only be done at scheduling time.
118	*/
119	typedef struct TMTIMER
120	{
121	/** Expire time. */
122	volatile uint64_t u64Expire;
123	/** Clock to apply to u64Expire. */
124	TMCLOCK enmClock;
125	/** Timer callback type. */
126	TMTIMERTYPE enmType;
127	/** Type specific data. */
128	union
129	{
130	/** TMTIMERTYPE_DEV. */
131	struct
132	{
133	/** Callback. */
134	R3PTRTYPE(PFNTMTIMERDEV) pfnTimer;
135	/** Device instance. */
136	PPDMDEVINSR3 pDevIns;
137	} Dev;
138
139	/** TMTIMERTYPE_DEV. */
140	struct
141	{
142	/** Callback. */
143	R3PTRTYPE(PFNTMTIMERUSB) pfnTimer;
144	/** USB device instance. */
145	PPDMUSBINS pUsbIns;
146	} Usb;
147
148	/** TMTIMERTYPE_DRV. */
149	struct
150	{
151	/** Callback. */
152	R3PTRTYPE(PFNTMTIMERDRV) pfnTimer;
153	/** Device instance. */
154	R3PTRTYPE(PPDMDRVINS) pDrvIns;
155	} Drv;
156
157	/** TMTIMERTYPE_INTERNAL. */
158	struct
159	{
160	/** Callback. */
161	R3PTRTYPE(PFNTMTIMERINT) pfnTimer;
162	} Internal;
163
164	/** TMTIMERTYPE_EXTERNAL. */
165	struct
166	{
167	/** Callback. */
168	R3PTRTYPE(PFNTMTIMEREXT) pfnTimer;
169	} External;
170	} u;
171
172	/** Timer state. */
173	volatile TMTIMERSTATE enmState;
174	/** Timer relative offset to the next timer in the schedule list. */
175	int32_t volatile offScheduleNext;
176
177	/** Timer relative offset to the next timer in the chain. */
178	int32_t offNext;
179	/** Timer relative offset to the previous timer in the chain. */
180	int32_t offPrev;
181
182	/** Pointer to the VM the timer belongs to - R3 Ptr. */
183	PVMR3 pVMR3;
184	/** Pointer to the VM the timer belongs to - R0 Ptr. */
185	PVMR0 pVMR0;
186	/** Pointer to the VM the timer belongs to - RC Ptr. */
187	PVMRC pVMRC;
188	/** The timer frequency hint. This is 0 if not hint was given. */
189	uint32_t volatile uHzHint;
190
191	/** User argument. */
192	RTR3PTR pvUser;
193	/** The critical section associated with the lock. */
194	R3PTRTYPE(PPDMCRITSECT) pCritSect;
195
196	/** Pointer to the next timer in the list of created or free timers. (TM::pTimers or TM::pFree) */
197	PTMTIMERR3 pBigNext;
198	/** Pointer to the previous timer in the list of all created timers. (TM::pTimers) */
199	PTMTIMERR3 pBigPrev;
200	/** Pointer to the timer description. */
201	R3PTRTYPE(const char *) pszDesc;
202	#if HC_ARCH_BITS == 32
203	uint32_t padding0; /*< pad structure to multiple of 8 bytes. /
204	#endif
205	} TMTIMER;
206	AssertCompileMemberSize(TMTIMER, enmState, sizeof(uint32_t));
207
208
209	/**
210	* Updates a timer state in the correct atomic manner.
211	*/
212	#if 1
213	# define TM_SET_STATE(pTimer, state) \
214	ASMAtomicWriteU32((uint32_t volatile *)&(pTimer)->enmState, state)
215	#else
216	# define TM_SET_STATE(pTimer, state) \
217	do { \
218	uint32_t uOld1 = (pTimer)->enmState; \
219	Log(("%s: %p: %d -> %d\n", __FUNCTION__, (pTimer), (pTimer)->enmState, state)); \
220	uint32_t uOld2 = ASMAtomicXchgU32((uint32_t volatile *)&(pTimer)->enmState, state); \
221	Assert(uOld1 == uOld2); \
222	} while (0)
223	#endif
224
225	/**
226	* Tries to updates a timer state in the correct atomic manner.
227	*/
228	#if 1
229	# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
230	(fRc) = ASMAtomicCmpXchgU32((uint32_t volatile *)&(pTimer)->enmState, StateNew, StateOld)
231	#else
232	# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
233	do { (fRc) = ASMAtomicCmpXchgU32((uint32_t volatile *)&(pTimer)->enmState, StateNew, StateOld); \
234	Log(("%s: %p: %d -> %d %RTbool\n", __FUNCTION__, (pTimer), StateOld, StateNew, fRc)); \
235	} while (0)
236	#endif
237
238	/** Get the previous timer. */
239	#define TMTIMER_GET_PREV(pTimer) ((PTMTIMER)((pTimer)->offPrev ? (intptr_t)(pTimer) + (pTimer)->offPrev : 0))
240	/** Get the next timer. */
241	#define TMTIMER_GET_NEXT(pTimer) ((PTMTIMER)((pTimer)->offNext ? (intptr_t)(pTimer) + (pTimer)->offNext : 0))
242	/** Set the previous timer link. */
243	#define TMTIMER_SET_PREV(pTimer, pPrev) ((pTimer)->offPrev = (pPrev) ? (intptr_t)(pPrev) - (intptr_t)(pTimer) : 0)
244	/** Set the next timer link. */
245	#define TMTIMER_SET_NEXT(pTimer, pNext) ((pTimer)->offNext = (pNext) ? (intptr_t)(pNext) - (intptr_t)(pTimer) : 0)
246
247
248	/**
249	* A timer queue.
250	*
251	* This is allocated on the hyper heap.
252	*/
253	typedef struct TMTIMERQUEUE
254	{
255	/** The cached expire time for this queue.
256	* Updated by EMT when scheduling the queue or modifying the head timer.
257	* Assigned UINT64_MAX when there is no head timer. */
258	uint64_t u64Expire;
259	/** Doubly linked list of active timers.
260	*
261	* When no scheduling is pending, this list is will be ordered by expire time (ascending).
262	* Access is serialized by only letting the emulation thread (EMT) do changes.
263	*
264	* The offset is relative to the queue structure.
265	*/
266	int32_t offActive;
267	/** List of timers pending scheduling of some kind.
268	*
269	* Timer stats allowed in the list are TMTIMERSTATE_PENDING_STOPPING,
270	* TMTIMERSTATE_PENDING_DESTRUCTION, TMTIMERSTATE_PENDING_STOPPING_DESTRUCTION,
271	* TMTIMERSTATE_PENDING_RESCHEDULING and TMTIMERSTATE_PENDING_SCHEDULE.
272	*
273	* The offset is relative to the queue structure.
274	*/
275	int32_t volatile offSchedule;
276	/** The clock for this queue. */
277	TMCLOCK enmClock;
278	/** Pad the structure up to 32 bytes. */
279	uint32_t au32Padding[3];
280	} TMTIMERQUEUE;
281
282	/** Pointer to a timer queue. */
283	typedef TMTIMERQUEUE *PTMTIMERQUEUE;
284
285	/** Get the head of the active timer list. */
286	#define TMTIMER_GET_HEAD(pQueue) ((PTMTIMER)((pQueue)->offActive ? (intptr_t)(pQueue) + (pQueue)->offActive : 0))
287	/** Set the head of the active timer list. */
288	#define TMTIMER_SET_HEAD(pQueue, pHead) ((pQueue)->offActive = pHead ? (intptr_t)pHead - (intptr_t)(pQueue) : 0)
289
290
291	/**
292	* CPU load data set.
293	* Mainly used by tmR3CpuLoadTimer.
294	*/
295	typedef struct TMCPULOADSTATE
296	{
297	/** The percent of the period spent executing guest code. */
298	uint8_t cPctExecuting;
299	/** The percent of the period spent halted. */
300	uint8_t cPctHalted;
301	/** The percent of the period spent on other things. */
302	uint8_t cPctOther;
303	/** Explicit alignment padding */
304	uint8_t au8Alignment[5];
305
306	/** Previous cNsTotal value. */
307	uint64_t cNsPrevTotal;
308	/** Previous cNsExecuting value. */
309	uint64_t cNsPrevExecuting;
310	/** Previous cNsHalted value. */
311	uint64_t cNsPrevHalted;
312	} TMCPULOADSTATE;
313	AssertCompileSizeAlignment(TMCPULOADSTATE, 8);
314	AssertCompileMemberAlignment(TMCPULOADSTATE, cNsPrevTotal, 8);
315	/** Pointer to a CPU load data set. */
316	typedef TMCPULOADSTATE *PTMCPULOADSTATE;
317
318
319	/**
320	* TSC mode.
321	*
322	* The main modes of how TM implements the TSC clock (TMCLOCK_TSC).
323	*/
324	typedef enum TMTSCMODE
325	{
326	/** The guest TSC is an emulated virtual TSC. */
327	TMTSCMODE_VIRT_TSC_EMULATED = 1,
328	/** The guest TSC is an offset of the real TSC. */
329	TMTSCMODE_REAL_TSC_OFFSET,
330	/** The guest TSC is dynamically derived through emulation or offsetting. */
331	TMTSCMODE_DYNAMIC
332	} TMTSCMODE;
333	AssertCompileSize(TMTSCMODE, sizeof(uint32_t));
334
335
336	/**
337	* Converts a TM pointer into a VM pointer.
338	* @returns Pointer to the VM structure the TM is part of.
339	* @param pTM Pointer to TM instance data.
340	*/
341	#define TM2VM(pTM) ( (PVM)((char*)pTM - pTM->offVM) )
342
343
344	/**
345	* TM VM Instance data.
346	* Changes to this must checked against the padding of the cfgm union in VM!
347	*/
348	typedef struct TM
349	{
350	/** Offset to the VM structure.
351	* See TM2VM(). */
352	RTUINT offVM;
353
354	/** The current TSC mode of the VM.
355	* Config variable: Mode (string). */
356	TMTSCMODE enmTSCMode;
357	/** Whether the TSC is tied to the execution of code.
358	* Config variable: TSCTiedToExecution (bool) */
359	bool fTSCTiedToExecution;
360	/** Modifier for fTSCTiedToExecution which pauses the TSC while halting if true.
361	* Config variable: TSCNotTiedToHalt (bool) */
362	bool fTSCNotTiedToHalt;
363	/** Alignment padding. */
364	bool afAlignment0[2];
365	/** The ID of the virtual CPU that normally runs the timers. */
366	VMCPUID idTimerCpu;
367
368	/** The number of CPU clock ticks per second (TMCLOCK_TSC).
369	* Config variable: TSCTicksPerSecond (64-bit unsigned int)
370	* The config variable implies @c enmTSCMode would be
371	* TMTSCMODE_VIRT_TSC_EMULATED. */
372	uint64_t cTSCTicksPerSecond;
373	/** The TSC difference introduced by pausing the VM. */
374	uint64_t offTSCPause;
375	/** The TSC value when the last TSC was paused. */
376	uint64_t u64LastPausedTSC;
377	/** CPU TSCs ticking indicator (one for each VCPU). */
378	uint32_t volatile cTSCsTicking;
379
380	/** Virtual time ticking enabled indicator (counter for each VCPU). (TMCLOCK_VIRTUAL) */
381	uint32_t volatile cVirtualTicking;
382	/** Virtual time is not running at 100%. */
383	bool fVirtualWarpDrive;
384	/** Virtual timer synchronous time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL_SYNC) */
385	bool volatile fVirtualSyncTicking;
386	/** Virtual timer synchronous time catch-up active. */
387	bool volatile fVirtualSyncCatchUp;
388	/** Alignment padding. */
389	bool afAlignment1[1];
390	/** WarpDrive percentage.
391	* 100% is normal (fVirtualSyncNormal == true). When other than 100% we apply
392	* this percentage to the raw time source for the period it's been valid in,
393	* i.e. since u64VirtualWarpDriveStart. */
394	uint32_t u32VirtualWarpDrivePercentage;
395
396	/** The offset of the virtual clock relative to it's timesource.
397	* Only valid if fVirtualTicking is set. */
398	uint64_t u64VirtualOffset;
399	/** The guest virtual time when fVirtualTicking is cleared. */
400	uint64_t u64Virtual;
401	/** When the Warp drive was started or last adjusted.
402	* Only valid when fVirtualWarpDrive is set. */
403	uint64_t u64VirtualWarpDriveStart;
404	/** The previously returned nano TS.
405	* This handles TSC drift on SMP systems and expired interval.
406	* This is a valid range u64NanoTS to u64NanoTS + 1000000000 (ie. 1sec). */
407	uint64_t volatile u64VirtualRawPrev;
408	/** The ring-3 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
409	RTTIMENANOTSDATAR3 VirtualGetRawDataR3;
410	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
411	RTTIMENANOTSDATAR0 VirtualGetRawDataR0;
412	/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
413	RTTIMENANOTSDATARC VirtualGetRawDataRC;
414	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
415	R3PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR3;
416	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
417	R0PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR0;
418	/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
419	RCPTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawRC;
420	/** Alignment. */
421	RTRCPTR AlignmentRCPtr;
422	/** The guest virtual timer synchronous time when fVirtualSyncTicking is cleared.
423	* When fVirtualSyncTicking is set it holds the last time returned to
424	* the guest (while the lock was held). */
425	uint64_t volatile u64VirtualSync;
426	/** The offset of the timer synchronous virtual clock (TMCLOCK_VIRTUAL_SYNC) relative
427	* to the virtual clock (TMCLOCK_VIRTUAL).
428	* (This is accessed by the timer thread and must be updated atomically.) */
429	uint64_t volatile offVirtualSync;
430	/** The offset into offVirtualSync that's been irrevocably given up by failed catch-up attempts.
431	* Thus the current lag is offVirtualSync - offVirtualSyncGivenUp. */
432	uint64_t offVirtualSyncGivenUp;
433	/** The TMCLOCK_VIRTUAL at the previous TMVirtualGetSync call when catch-up is active. */
434	uint64_t volatile u64VirtualSyncCatchUpPrev;
435	/** The current catch-up percentage. */
436	uint32_t volatile u32VirtualSyncCatchUpPercentage;
437	/** How much slack when processing timers. */
438	uint32_t u32VirtualSyncScheduleSlack;
439	/** When to stop catch-up. */
440	uint64_t u64VirtualSyncCatchUpStopThreshold;
441	/** When to give up catch-up. */
442	uint64_t u64VirtualSyncCatchUpGiveUpThreshold;
443	/** @def TM_MAX_CATCHUP_PERIODS
444	* The number of catchup rates. */
445	#define TM_MAX_CATCHUP_PERIODS 10
446	/** The aggressiveness of the catch-up relative to how far we've lagged behind.
447	* The idea is to have increasing catch-up percentage as the lag increases. */
448	struct TMCATCHUPPERIOD
449	{
450	uint64_t u64Start; /*< When this period starts. (u64VirtualSyncOffset). /
451	uint32_t u32Percentage; /*< The catch-up percent to apply. /
452	uint32_t u32Alignment; /*< Structure alignment /
453	} aVirtualSyncCatchUpPeriods[TM_MAX_CATCHUP_PERIODS];
454
455	/** The current max timer Hz hint. */
456	uint32_t volatile uMaxHzHint;
457	/** Whether to recalulate the HzHint next time its queried. */
458	bool volatile fHzHintNeedsUpdating;
459	/** Alignment */
460	bool afAlignment2[3];
461	/** @cfgm{/TM/HostHzMax, uint32_t, Hz, 0, UINT32_MAX, 20000}
462	* The max host Hz frequency hint returned by TMCalcHostTimerFrequency. */
463	uint32_t cHostHzMax;
464	/** @cfgm{/TM/HostHzFudgeFactorTimerCpu, uint32_t, Hz, 0, UINT32_MAX, 111}
465	* The number of Hz TMCalcHostTimerFrequency adds for the timer CPU. */
466	uint32_t cPctHostHzFudgeFactorTimerCpu;
467	/** @cfgm{/TM/HostHzFudgeFactorOtherCpu, uint32_t, Hz, 0, UINT32_MAX, 110}
468	* The number of Hz TMCalcHostTimerFrequency adds for the other CPUs. */
469	uint32_t cPctHostHzFudgeFactorOtherCpu;
470	/** @cfgm{/TM/HostHzFudgeFactorCatchUp100, uint32_t, Hz, 0, UINT32_MAX, 300}
471	* The fudge factor (expressed in percent) that catch-up percentages below
472	* 100% is multiplied by. */
473	uint32_t cPctHostHzFudgeFactorCatchUp100;
474	/** @cfgm{/TM/HostHzFudgeFactorCatchUp200, uint32_t, Hz, 0, UINT32_MAX, 250}
475	* The fudge factor (expressed in percent) that catch-up percentages
476	* 100%-199% is multiplied by. */
477	uint32_t cPctHostHzFudgeFactorCatchUp200;
478	/** @cfgm{/TM/HostHzFudgeFactorCatchUp400, uint32_t, Hz, 0, UINT32_MAX, 200}
479	* The fudge factor (expressed in percent) that catch-up percentages
480	* 200%-399% is multiplied by. */
481	uint32_t cPctHostHzFudgeFactorCatchUp400;
482
483	/** The UTC offset in ns.
484	* This is NOT for converting UTC to local time. It is for converting real
485	* world UTC time to VM UTC time. This feature is indented for doing date
486	* testing of software and similar.
487	* @todo Implement warpdrive on UTC. */
488	int64_t offUTC;
489
490	/** Timer queues for the different clock types - R3 Ptr */
491	R3PTRTYPE(PTMTIMERQUEUE) paTimerQueuesR3;
492	/** Timer queues for the different clock types - R0 Ptr */
493	R0PTRTYPE(PTMTIMERQUEUE) paTimerQueuesR0;
494	/** Timer queues for the different clock types - RC Ptr */
495	RCPTRTYPE(PTMTIMERQUEUE) paTimerQueuesRC;
496
497	/** Pointer to our RC mapping of the GIP. */
498	RCPTRTYPE(void *) pvGIPRC;
499	/** Pointer to our R3 mapping of the GIP. */
500	R3PTRTYPE(void *) pvGIPR3;
501
502	/** Pointer to a singly linked list of free timers.
503	* This chain is using the TMTIMER::pBigNext members.
504	* Only accessible from the emulation thread. */
505	PTMTIMERR3 pFree;
506
507	/** Pointer to a doubly linked list of created timers.
508	* This chain is using the TMTIMER::pBigNext and TMTIMER::pBigPrev members.
509	* Only accessible from the emulation thread. */
510	PTMTIMERR3 pCreated;
511
512	/** The schedule timer timer handle (runtime timer).
513	* This timer will do frequent check on pending queue schedules and
514	* raise VM_FF_TIMER to pull EMTs attention to them.
515	*/
516	R3PTRTYPE(PRTTIMER) pTimer;
517	/** Interval in milliseconds of the pTimer timer. */
518	uint32_t u32TimerMillies;
519
520	/** Indicates that queues are being run. */
521	bool volatile fRunningQueues;
522	/** Indicates that the virtual sync queue is being run. */
523	bool volatile fRunningVirtualSyncQueue;
524	/** Alignment */
525	bool afAlignment3[2];
526
527	/** Lock serializing access to the timer lists. */
528	PDMCRITSECT TimerCritSect;
529	/** Lock serializing access to the VirtualSync clock and the associated
530	* timer queue. */
531	PDMCRITSECT VirtualSyncLock;
532
533	/** CPU load state for all the virtual CPUs (tmR3CpuLoadTimer). */
534	TMCPULOADSTATE CpuLoad;
535
536	/** TMR3TimerQueuesDo
537	* @{ */
538	STAMPROFILE StatDoQueues;
539	STAMPROFILEADV aStatDoQueues[TMCLOCK_MAX];
540	/** @} */
541	/** tmSchedule
542	* @{ */
543	STAMPROFILE StatScheduleOneRZ;
544	STAMPROFILE StatScheduleOneR3;
545	STAMCOUNTER StatScheduleSetFF;
546	STAMCOUNTER StatPostponedR3;
547	STAMCOUNTER StatPostponedRZ;
548	/** @} */
549	/** Read the time
550	* @{ */
551	STAMCOUNTER StatVirtualGet;
552	STAMCOUNTER StatVirtualGetSetFF;
553	STAMCOUNTER StatVirtualSyncGet;
554	STAMCOUNTER StatVirtualSyncGetAdjLast;
555	STAMCOUNTER StatVirtualSyncGetELoop;
556	STAMCOUNTER StatVirtualSyncGetExpired;
557	STAMCOUNTER StatVirtualSyncGetLockless;
558	STAMCOUNTER StatVirtualSyncGetLocked;
559	STAMCOUNTER StatVirtualSyncGetSetFF;
560	STAMCOUNTER StatVirtualPause;
561	STAMCOUNTER StatVirtualResume;
562	/** @} */
563	/** TMTimerPoll
564	* @{ */
565	STAMCOUNTER StatPoll;
566	STAMCOUNTER StatPollAlreadySet;
567	STAMCOUNTER StatPollELoop;
568	STAMCOUNTER StatPollMiss;
569	STAMCOUNTER StatPollRunning;
570	STAMCOUNTER StatPollSimple;
571	STAMCOUNTER StatPollVirtual;
572	STAMCOUNTER StatPollVirtualSync;
573	/** @} */
574	/** TMTimerSet sans virtual sync timers.
575	* @{ */
576	STAMCOUNTER StatTimerSet;
577	STAMCOUNTER StatTimerSetOpt;
578	STAMPROFILE StatTimerSetRZ;
579	STAMPROFILE StatTimerSetR3;
580	STAMCOUNTER StatTimerSetStStopped;
581	STAMCOUNTER StatTimerSetStExpDeliver;
582	STAMCOUNTER StatTimerSetStActive;
583	STAMCOUNTER StatTimerSetStPendStop;
584	STAMCOUNTER StatTimerSetStPendStopSched;
585	STAMCOUNTER StatTimerSetStPendSched;
586	STAMCOUNTER StatTimerSetStPendResched;
587	STAMCOUNTER StatTimerSetStOther;
588	/** @} */
589	/** TMTimerSet on virtual sync timers.
590	* @{ */
591	STAMCOUNTER StatTimerSetVs;
592	STAMPROFILE StatTimerSetVsRZ;
593	STAMPROFILE StatTimerSetVsR3;
594	STAMCOUNTER StatTimerSetVsStStopped;
595	STAMCOUNTER StatTimerSetVsStExpDeliver;
596	STAMCOUNTER StatTimerSetVsStActive;
597	/** @} */
598	/** TMTimerSetRelative sans virtual sync timers
599	* @{ */
600	STAMCOUNTER StatTimerSetRelative;
601	STAMPROFILE StatTimerSetRelativeRZ;
602	STAMPROFILE StatTimerSetRelativeR3;
603	STAMCOUNTER StatTimerSetRelativeOpt;
604	STAMCOUNTER StatTimerSetRelativeStStopped;
605	STAMCOUNTER StatTimerSetRelativeStExpDeliver;
606	STAMCOUNTER StatTimerSetRelativeStActive;
607	STAMCOUNTER StatTimerSetRelativeStPendStop;
608	STAMCOUNTER StatTimerSetRelativeStPendStopSched;
609	STAMCOUNTER StatTimerSetRelativeStPendSched;
610	STAMCOUNTER StatTimerSetRelativeStPendResched;
611	STAMCOUNTER StatTimerSetRelativeStOther;
612	/** @} */
613	/** TMTimerSetRelative on virtual sync timers.
614	* @{ */
615	STAMCOUNTER StatTimerSetRelativeVs;
616	STAMPROFILE StatTimerSetRelativeVsRZ;
617	STAMPROFILE StatTimerSetRelativeVsR3;
618	STAMCOUNTER StatTimerSetRelativeVsStStopped;
619	STAMCOUNTER StatTimerSetRelativeVsStExpDeliver;
620	STAMCOUNTER StatTimerSetRelativeVsStActive;
621	/** @} */
622	/** TMTimerStop sans virtual sync.
623	* @{ */
624	STAMPROFILE StatTimerStopRZ;
625	STAMPROFILE StatTimerStopR3;
626	/** @} */
627	/** TMTimerStop on virtual sync timers.
628	* @{ */
629	STAMPROFILE StatTimerStopVsRZ;
630	STAMPROFILE StatTimerStopVsR3;
631	/** @} */
632	/** VirtualSync - Running and Catching Up
633	* @{ */
634	STAMCOUNTER StatVirtualSyncRun;
635	STAMCOUNTER StatVirtualSyncRunRestart;
636	STAMPROFILE StatVirtualSyncRunSlack;
637	STAMCOUNTER StatVirtualSyncRunStop;
638	STAMCOUNTER StatVirtualSyncRunStoppedAlready;
639	STAMCOUNTER StatVirtualSyncGiveUp;
640	STAMCOUNTER StatVirtualSyncGiveUpBeforeStarting;
641	STAMPROFILEADV StatVirtualSyncCatchup;
642	STAMCOUNTER aStatVirtualSyncCatchupInitial[TM_MAX_CATCHUP_PERIODS];
643	STAMCOUNTER aStatVirtualSyncCatchupAdjust[TM_MAX_CATCHUP_PERIODS];
644	/** @} */
645	/** TMR3VirtualSyncFF (non dedicated EMT). */
646	STAMPROFILE StatVirtualSyncFF;
647	/** The timer callback. */
648	STAMCOUNTER StatTimerCallbackSetFF;
649
650	/** Calls to TMCpuTickSet. */
651	STAMCOUNTER StatTSCSet;
652
653	/** TSC starts and stops. */
654	STAMCOUNTER StatTSCPause;
655	STAMCOUNTER StatTSCResume;
656
657	/** @name Reasons for refusing TSC offsetting in TMCpuTickCanUseRealTSC.
658	* @{ */
659	STAMCOUNTER StatTSCNotFixed;
660	STAMCOUNTER StatTSCNotTicking;
661	STAMCOUNTER StatTSCCatchupLE010;
662	STAMCOUNTER StatTSCCatchupLE025;
663	STAMCOUNTER StatTSCCatchupLE100;
664	STAMCOUNTER StatTSCCatchupOther;
665	STAMCOUNTER StatTSCWarp;
666	STAMCOUNTER StatTSCUnderflow;
667	STAMCOUNTER StatTSCSyncNotTicking;
668	/** @} */
669	} TM;
670	/** Pointer to TM VM instance data. */
671	typedef TM *PTM;
672
673	/**
674	* TM VMCPU Instance data.
675	* Changes to this must checked against the padding of the tm union in VM!
676	*/
677	typedef struct TMCPU
678	{
679	/** Offset to the VMCPU structure.
680	* See TMCPU2VM(). */
681	RTUINT offVMCPU;
682
683	/** CPU timestamp ticking enabled indicator (bool). (RDTSC) */
684	bool fTSCTicking;
685	bool afAlignment0[3]; /*< alignment padding /
686
687	/** The offset between the raw TSC source and the Guest TSC.
688	* Only valid if fTicking is set and and fTSCUseRealTSC is clear. */
689	uint64_t offTSCRawSrc;
690
691	/** The guest TSC when fTicking is cleared. */
692	uint64_t u64TSC;
693
694	/** The last seen TSC by the guest. */
695	uint64_t u64TSCLastSeen;
696
697	#ifndef VBOX_WITHOUT_NS_ACCOUNTING
698	/** The nanosecond timestamp of the CPU start or resume.
699	* This is recalculated when the VM is started so that
700	* cNsTotal = RTTimeNanoTS() - u64NsTsStartCpu. */
701	uint64_t u64NsTsStartTotal;
702	/** The nanosecond timestamp of the last start-execute notification. */
703	uint64_t u64NsTsStartExecuting;
704	/** The nanosecond timestamp of the last start-halt notification. */
705	uint64_t u64NsTsStartHalting;
706	/** The cNsXXX generation. */
707	uint32_t volatile uTimesGen;
708	/** Explicit alignment padding. */
709	uint32_t u32Alignment;
710	/** The number of nanoseconds total run time.
711	* @remarks This is updated when cNsExecuting and cNsHalted are updated. */
712	uint64_t cNsTotal;
713	/** The number of nanoseconds spent executing. */
714	uint64_t cNsExecuting;
715	/** The number of nanoseconds being halted. */
716	uint64_t cNsHalted;
717	/** The number of nanoseconds spent on other things.
718	* @remarks This is updated when cNsExecuting and cNsHalted are updated. */
719	uint64_t cNsOther;
720	/** The number of halts. */
721	uint64_t cPeriodsHalted;
722	/** The number of guest execution runs. */
723	uint64_t cPeriodsExecuting;
724	# if defined(VBOX_WITH_STATISTICS) \|\| defined(VBOX_WITH_NS_ACCOUNTING_STATS)
725	/** Resettable version of cNsTotal. */
726	STAMCOUNTER StatNsTotal;
727	/** Resettable version of cNsExecuting. */
728	STAMPROFILE StatNsExecuting;
729	/** Long execution intervals. */
730	STAMPROFILE StatNsExecLong;
731	/** Short execution intervals . */
732	STAMPROFILE StatNsExecShort;
733	/** Tiny execution intervals . */
734	STAMPROFILE StatNsExecTiny;
735	/** Resettable version of cNsHalted. */
736	STAMPROFILE StatNsHalted;
737	/** Resettable version of cNsOther. */
738	STAMPROFILE StatNsOther;
739	# endif
740
741	/** CPU load state for this virtual CPU (tmR3CpuLoadTimer). */
742	TMCPULOADSTATE CpuLoad;
743	#endif
744	} TMCPU;
745	/** Pointer to TM VMCPU instance data. */
746	typedef TMCPU *PTMCPU;
747
748	const char *tmTimerState(TMTIMERSTATE enmState);
749	void tmTimerQueueSchedule(PVM pVM, PTMTIMERQUEUE pQueue);
750	#ifdef VBOX_STRICT
751	void tmTimerQueuesSanityChecks(PVM pVM, const char *pszWhere);
752	#endif
753
754	int tmCpuTickPause(PVMCPU pVCpu);
755	int tmCpuTickPauseLocked(PVM pVM, PVMCPU pVCpu);
756	int tmCpuTickResume(PVM pVM, PVMCPU pVCpu);
757	int tmCpuTickResumeLocked(PVM pVM, PVMCPU pVCpu);
758
759	int tmVirtualPauseLocked(PVM pVM);
760	int tmVirtualResumeLocked(PVM pVM);
761	DECLEXPORT(void) tmVirtualNanoTSBad(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS, uint64_t u64DeltaPrev, uint64_t u64PrevNanoTS);
762	DECLEXPORT(uint64_t) tmVirtualNanoTSRediscover(PRTTIMENANOTSDATA pData);
763
764
765	/**
766	* Try take the timer lock, wait in ring-3 return VERR_SEM_BUSY in R0/RC.
767	*
768	* @retval VINF_SUCCESS on success (always in ring-3).
769	* @retval VERR_SEM_BUSY in RC and R0 if the semaphore is busy.
770	*
771	* @param a_pVM Pointer to the VM.
772	*
773	* @remarks The virtual sync timer queue requires the virtual sync lock.
774	*/
775	#define TM_LOCK_TIMERS(a_pVM) PDMCritSectEnter(&(a_pVM)->tm.s.TimerCritSect, VERR_SEM_BUSY)
776
777	/**
778	* Try take the timer lock, no waiting.
779	*
780	* @retval VINF_SUCCESS on success.
781	* @retval VERR_SEM_BUSY if busy.
782	*
783	* @param a_pVM Pointer to the VM.
784	*
785	* @remarks The virtual sync timer queue requires the virtual sync lock.
786	*/
787	#define TM_TRY_LOCK_TIMERS(a_pVM) PDMCritSectTryEnter(&(a_pVM)->tm.s.TimerCritSect)
788
789	/** Lock the timers (sans the virtual sync queue). */
790	#define TM_UNLOCK_TIMERS(a_pVM) do { PDMCritSectLeave(&(a_pVM)->tm.s.TimerCritSect); } while (0)
791
792	/** Checks that the caller owns the timer lock. */
793	#define TM_ASSERT_TIMER_LOCK_OWNERSHIP(a_pVM) \
794	Assert(PDMCritSectIsOwner(&(a_pVM)->tm.s.TimerCritSect))
795
796	/** @} */
797
798	RT_C_DECLS_END
799
800	#endif
801

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

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

Download in other formats: