TMInternal.h revision 25747178cb66800d8386c20b8ffd87f78f24f4e5
/* $Id$ */
/** @file
* TM - Internal header file.
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___TMInternal_h
#define ___TMInternal_h
#include <VBox/pdmcritsect.h>
/** @defgroup grp_tm_int Internal
* @ingroup grp_tm
* @internal
* @{
*/
/** Frequency of the real clock. */
/** Frequency of the virtual clock. */
/**
* Timer type.
*/
typedef enum TMTIMERTYPE
{
/** Device timer. */
TMTIMERTYPE_DEV = 1,
/** Driver timer. */
/** Internal timer . */
/** External timer. */
} TMTIMERTYPE;
/**
* Timer state
*/
typedef enum TMTIMERSTATE
{
/** Timer is stopped. */
TMTIMERSTATE_STOPPED = 1,
/** Timer is active. */
/** Timer is expired, getting expire and unlinking. */
/** Timer is expired and is being delivered. */
/** Timer is stopped but still in the active list.
* Currently in the ScheduleTimers list. */
/** Timer is stopped but needs unlinking from the ScheduleTimers list.
* Currently in the ScheduleTimers list. */
/** Timer is being modified and will soon be pending scheduling.
* Currently in the ScheduleTimers list. */
/** Timer is pending scheduling.
* Currently in the ScheduleTimers list. */
/** Timer is being modified and will soon be pending rescheduling.
* Currently in the ScheduleTimers list and the active list. */
/** Timer is modified and is now pending rescheduling.
* Currently in the ScheduleTimers list and the active list. */
/** Timer is being destroyed. */
/** Timer is free. */
} TMTIMERSTATE;
/** Predicate that returns true if the give state is pending scheduling or
* rescheduling of any kind. Will reference the argument more than once! */
#define TMTIMERSTATE_IS_PENDING_SCHEDULING(enmState) \
( (enmState) <= TMTIMERSTATE_PENDING_RESCHEDULE \
/**
* Internal representation of a timer.
*
* For correct serialization (without the use of semaphores and
* this structure:
* - For thread other than EMT only u64Expire, enmState and pScheduleNext*
* are changeable. Everything else is out of bounds.
* - Updating of u64Expire timer can only happen in the TMTIMERSTATE_STOPPED
* and TMTIMERSTATE_PENDING_RESCHEDULING_SET_EXPIRE states.
* - Timers in the TMTIMERSTATE_EXPIRED state are only accessible from EMT.
* - Actual destruction of a timer can only be done at scheduling time.
*/
typedef struct TMTIMER
{
/** Expire time. */
/** Clock to apply to u64Expire. */
/** Timer callback type. */
/** Type specific data. */
union
{
/** TMTIMERTYPE_DEV. */
struct
{
/** Callback. */
/** Device instance. */
} Dev;
/** TMTIMERTYPE_DRV. */
struct
{
/** Callback. */
/** Device instance. */
} Drv;
/** TMTIMERTYPE_INTERNAL. */
struct
{
/** Callback. */
} Internal;
/** TMTIMERTYPE_EXTERNAL. */
struct
{
/** Callback. */
} External;
} u;
/** Timer state. */
volatile TMTIMERSTATE enmState;
/** Timer relative offset to the next timer in the schedule list. */
int32_t volatile offScheduleNext;
/** Timer relative offset to the next timer in the chain. */
/** Timer relative offset to the previous timer in the chain. */
/** User argument. */
/** The critical section associated with the lock. */
/** Pointer to the next timer in the list of created or free timers. (TM::pTimers or TM::pFree) */
/** Pointer to the previous timer in the list of all created timers. (TM::pTimers) */
/** Pointer to the timer description. */
/** Pointer to the VM the timer belongs to - R3 Ptr. */
/** Pointer to the VM the timer belongs to - R0 Ptr. */
/** Pointer to the VM the timer belongs to - RC Ptr. */
#if HC_ARCH_BITS == 64
#endif
} TMTIMER;
/**
* Updates a timer state in the correct atomic manner.
*/
#if 1
#else
do { \
} while (0)
#endif
/**
* Tries to updates a timer state in the correct atomic manner.
*/
#if 1
#else
} while (0)
#endif
/** Get the previous timer. */
#define TMTIMER_GET_PREV(pTimer) ((PTMTIMER)((pTimer)->offPrev ? (intptr_t)(pTimer) + (pTimer)->offPrev : 0))
/** Get the next timer. */
#define TMTIMER_GET_NEXT(pTimer) ((PTMTIMER)((pTimer)->offNext ? (intptr_t)(pTimer) + (pTimer)->offNext : 0))
/** Set the previous timer link. */
#define TMTIMER_SET_PREV(pTimer, pPrev) ((pTimer)->offPrev = (pPrev) ? (intptr_t)(pPrev) - (intptr_t)(pTimer) : 0)
/** Set the next timer link. */
#define TMTIMER_SET_NEXT(pTimer, pNext) ((pTimer)->offNext = (pNext) ? (intptr_t)(pNext) - (intptr_t)(pTimer) : 0)
/**
* A timer queue.
*
* This is allocated on the hyper heap.
*/
typedef struct TMTIMERQUEUE
{
/** The cached expire time for this queue.
* Updated by EMT when scheduling the queue or modifying the head timer.
* Assigned UINT64_MAX when there is no head timer. */
/** Doubly linked list of active timers.
*
* When no scheduling is pending, this list is will be ordered by expire time (ascending).
* Access is serialized by only letting the emulation thread (EMT) do changes.
*
* The offset is relative to the queue structure.
*/
/** List of timers pending scheduling of some kind.
*
* Timer stats allowed in the list are TMTIMERSTATE_PENDING_STOPPING,
* TMTIMERSTATE_PENDING_DESTRUCTION, TMTIMERSTATE_PENDING_STOPPING_DESTRUCTION,
* TMTIMERSTATE_PENDING_RESCHEDULING and TMTIMERSTATE_PENDING_SCHEDULE.
*
* The offset is relative to the queue structure.
*/
int32_t volatile offSchedule;
/** The clock for this queue. */
/** Pad the structure up to 32 bytes. */
} TMTIMERQUEUE;
/** Pointer to a timer queue. */
typedef TMTIMERQUEUE *PTMTIMERQUEUE;
/** Get the head of the active timer list. */
#define TMTIMER_GET_HEAD(pQueue) ((PTMTIMER)((pQueue)->offActive ? (intptr_t)(pQueue) + (pQueue)->offActive : 0))
/** Set the head of the active timer list. */
#define TMTIMER_SET_HEAD(pQueue, pHead) ((pQueue)->offActive = pHead ? (intptr_t)pHead - (intptr_t)(pQueue) : 0)
/**
* Converts a TM pointer into a VM pointer.
* @returns Pointer to the VM structure the TM is part of.
* @param pTM Pointer to TM instance data.
*/
/**
* TM VM Instance data.
* Changes to this must checked against the padding of the cfgm union in VM!
*/
typedef struct TM
{
/** Offset to the VM structure.
* See TM2VM(). */
/** Set if we fully virtualize the TSC, i.e. intercept all rdtsc instructions.
* Config variable: TSCVirtualized (bool) */
bool fTSCVirtualized;
/** Set if we use the real TSC as time source or if we use the virtual clock.
* ticking. fTSCVirtualized = false implies fTSCUseRealTSC = true.
* Config variable: TSCUseRealTSC (bool) */
bool fTSCUseRealTSC;
/** Flag indicating that the host TSC is suitable for use in AMD-V and VT-x mode.
* Config variable: MaybeUseOffsettedHostTSC (boolean) */
/** Whether the TSC is tied to the execution of code.
* Config variable: TSCTiedToExecution (bool) */
bool fTSCTiedToExecution;
/** Modifier for fTSCTiedToExecution which pauses the TSC while halting if true.
* Config variable: TSCNotTiedToHalt (bool) */
bool fTSCNotTiedToHalt;
/** The ID of the virtual CPU that normally runs the timers. */
/** The number of CPU clock ticks per second (TMCLOCK_TSC).
* Config variable: TSCTicksPerSecond (64-bit unsigned int)
* The config variable implies fTSCVirtualized = true and fTSCUseRealTSC = false. */
/** Virtual time ticking enabled indicator (counter for each VCPU). (TMCLOCK_VIRTUAL) */
uint32_t volatile cVirtualTicking;
/** Virtual time is not running at 100%. */
bool fVirtualWarpDrive;
/** Virtual timer synchronous time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL_SYNC) */
bool volatile fVirtualSyncTicking;
/** Virtual timer synchronous time catch-up active. */
bool volatile fVirtualSyncCatchUp;
/** WarpDrive percentage.
* 100% is normal (fVirtualSyncNormal == true). When other than 100% we apply
* this percentage to the raw time source for the period it's been valid in,
* i.e. since u64VirtualWarpDriveStart. */
/** The offset of the virtual clock relative to it's timesource.
* Only valid if fVirtualTicking is set. */
/** The guest virtual time when fVirtualTicking is cleared. */
/** When the Warp drive was started or last adjusted.
* Only valid when fVirtualWarpDrive is set. */
/** The previously returned nano TS.
* This handles TSC drift on SMP systems and expired interval.
* This is a valid range u64NanoTS to u64NanoTS + 1000000000 (ie. 1sec). */
uint64_t volatile u64VirtualRawPrev;
/** The ring-3 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
/** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
/** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
/** Alignment. */
/** The guest virtual timer synchronous time when fVirtualSyncTicking is cleared. */
uint64_t volatile u64VirtualSync;
/** The offset of the timer synchronous virtual clock (TMCLOCK_VIRTUAL_SYNC) relative
* to the virtual clock (TMCLOCK_VIRTUAL).
* (This is accessed by the timer thread and must be updated atomically.) */
uint64_t volatile offVirtualSync;
/** The offset into offVirtualSync that's been irrevocably given up by failed catch-up attempts.
* Thus the current lag is offVirtualSync - offVirtualSyncGivenUp. */
/** The TMCLOCK_VIRTUAL at the previous TMVirtualGetSync call when catch-up is active. */
uint64_t volatile u64VirtualSyncCatchUpPrev;
/** The current catch-up percentage. */
uint32_t volatile u32VirtualSyncCatchUpPercentage;
/** How much slack when processing timers. */
/** When to stop catch-up. */
/** When to give up catch-up. */
/** @def TM_MAX_CATCHUP_PERIODS
* The number of catchup rates. */
#define TM_MAX_CATCHUP_PERIODS 10
/** The agressivness of the catch-up relative to how far we've lagged behind.
* The idea is to have increasing catch-up percentage as the lag increases. */
struct TMCATCHUPPERIOD
{
/** The UTC offset in ns.
* This is *NOT* for converting UTC to local time. It is for converting real
* world UTC time to VM UTC time. This feature is indented for doing date
* testing of software and similar.
* @todo Implement warpdrive on UTC. */
/** Timer queues for the different clock types - R3 Ptr */
/** Timer queues for the different clock types - R0 Ptr */
/** Timer queues for the different clock types - RC Ptr */
/** Pointer to our RC mapping of the GIP. */
/** Pointer to our R3 mapping of the GIP. */
/** Pointer to a singly linked list of free timers.
* This chain is using the TMTIMER::pBigNext members.
* Only accessible from the emulation thread. */
/** Pointer to a doubly linked list of created timers.
* This chain is using the TMTIMER::pBigNext and TMTIMER::pBigPrev members.
* Only accessible from the emulation thread. */
/** The schedulation timer timer handle (runtime timer).
* This timer will do freqent check on pending queue schedulations and
* raise VM_FF_TIMER to pull EMTs attention to them.
*/
/** Interval in milliseconds of the pTimer timer. */
/** Indicates that queues are being run. */
bool volatile fRunningQueues;
/** Indicates that the virtual sync queue is being run. */
bool volatile fRunningVirtualSyncQueue;
/* Alignment */
bool u8Alignment[2];
/** Lock serializing EMT access to TM. */
/** Lock serializing access to the VirtualSync clock. */
/** TMR3TimerQueuesDo
* @{ */
/** @} */
/** tmSchedule
* @{ */
/** @} */
/** Read the time
* @{ */
/* @} */
/** TMTimerPoll
* @{ */
/** @} */
/** TMTimerSet
* @{ */
/** @} */
/** TMTimerStop
* @{ */
/** @} */
/** VirtualSync - Running and Catching Up
* @{ */
/** @} */
/** TMR3VirtualSyncFF (non dedicated EMT). */
/** The timer callback. */
/** @name Reasons for refusing TSC offsetting in TMCpuTickCanUseRealTSC.
* @{ */
/** @} */
} TM;
/** Pointer to TM VM instance data. */
/**
* TM VMCPU Instance data.
* Changes to this must checked against the padding of the tm union in VM!
*/
typedef struct TMCPU
{
/** Offset to the VMCPU structure.
* See TMCPU2VM(). */
/** CPU timestamp ticking enabled indicator (bool). (RDTSC) */
bool fTSCTicking;
/** The offset between the host TSC and the Guest TSC.
* Only valid if fTicking is set and and fTSCUseRealTSC is clear. */
/** The guest TSC when fTicking is cleared. */
} TMCPU;
/** Pointer to TM VMCPU instance data. */
#if 0 /* enable this to rule out locking bugs on single cpu guests. */
# define tmVirtualSyncUnlock(pVM) ((void)0)
#else
/** Checks that the caller owns the EMT lock. */
#endif
#ifdef VBOX_STRICT
#endif
DECLEXPORT(void) tmVirtualNanoTSBad(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS, uint64_t u64DeltaPrev, uint64_t u64PrevNanoTS);
/** @} */
#endif