TMInternal.h revision 0d3272d7e2b3f8aeca5b9a77652742f4c7544673
b736c553dbde2c3b2533c93c57d9b7f07714371cvboxsync * TM - Internal header file.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Copyright (C) 2006-2014 Oracle Corporation
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * available from http://www.virtualbox.org. This file is free software;
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * you can redistribute it and/or modify it under the terms of the GNU
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * General Public License (GPL) as published by the Free Software
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** @defgroup grp_tm_int Internal
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @ingroup grp_tm
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @internal
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Frequency of the real clock. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Frequency of the virtual clock. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Timer type.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Device timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** USB device timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Driver timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Internal timer . */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** External timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Timer state
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is stopped. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is active. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is expired, getting expire and unlinking. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is expired and is being delivered. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is stopped but still in the active list.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Currently in the ScheduleTimers list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is stopped but needs unlinking from the ScheduleTimers list.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Currently in the ScheduleTimers list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is being modified and will soon be pending scheduling.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Currently in the ScheduleTimers list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is pending scheduling.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Currently in the ScheduleTimers list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is being modified and will soon be pending rescheduling.
9474d83dcac691984017f8255821b95ec7642804vboxsync * Currently in the ScheduleTimers list and the active list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is modified and is now pending rescheduling.
9474d83dcac691984017f8255821b95ec7642804vboxsync * Currently in the ScheduleTimers list and the active list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is being destroyed. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer is free. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Predicate that returns true if the give state is pending scheduling or
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * rescheduling of any kind. Will reference the argument more than once! */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMERSTATE_IS_PENDING_SCHEDULING(enmState) \
9474d83dcac691984017f8255821b95ec7642804vboxsync && (enmState) >= TMTIMERSTATE_PENDING_SCHEDULE_SET_EXPIRE)
9474d83dcac691984017f8255821b95ec7642804vboxsync * Internal representation of a timer.
9474d83dcac691984017f8255821b95ec7642804vboxsync * For correct serialization (without the use of semaphores and
9474d83dcac691984017f8255821b95ec7642804vboxsync * other blocking/slow constructs) certain rules applies to updating
9474d83dcac691984017f8255821b95ec7642804vboxsync * this structure:
9474d83dcac691984017f8255821b95ec7642804vboxsync * - For thread other than EMT only u64Expire, enmState and pScheduleNext*
9474d83dcac691984017f8255821b95ec7642804vboxsync * are changeable. Everything else is out of bounds.
9474d83dcac691984017f8255821b95ec7642804vboxsync * - Updating of u64Expire timer can only happen in the TMTIMERSTATE_STOPPED
9474d83dcac691984017f8255821b95ec7642804vboxsync * and TMTIMERSTATE_PENDING_RESCHEDULING_SET_EXPIRE states.
9474d83dcac691984017f8255821b95ec7642804vboxsync * - Timers in the TMTIMERSTATE_EXPIRED state are only accessible from EMT.
9474d83dcac691984017f8255821b95ec7642804vboxsync * - Actual destruction of a timer can only be done at scheduling time.
9474d83dcac691984017f8255821b95ec7642804vboxsynctypedef struct TMTIMER
9474d83dcac691984017f8255821b95ec7642804vboxsync /** Expire time. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Clock to apply to u64Expire. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer callback type. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Type specific data. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTIMERTYPE_DEV. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Callback. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Device instance. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTIMERTYPE_DEV. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Callback. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** USB device instance. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTIMERTYPE_DRV. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Callback. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Device instance. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTIMERTYPE_INTERNAL. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Callback. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTIMERTYPE_EXTERNAL. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Callback. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer state. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer relative offset to the next timer in the schedule list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer relative offset to the next timer in the chain. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer relative offset to the previous timer in the chain. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the VM the timer belongs to - R3 Ptr. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the VM the timer belongs to - R0 Ptr. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the VM the timer belongs to - RC Ptr. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The timer frequency hint. This is 0 if not hint was given. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** User argument. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The critical section associated with the lock. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the next timer in the list of created or free timers. (TM::pTimers or TM::pFree) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the previous timer in the list of all created timers. (TM::pTimers) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the timer description. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync uint32_t padding0; /**< pad structure to multiple of 8 bytes. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncAssertCompileMemberSize(TMTIMER, enmState, sizeof(uint32_t));
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Updates a timer state in the correct atomic manner.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync ASMAtomicWriteU32((uint32_t volatile *)&(pTimer)->enmState, state)
9474d83dcac691984017f8255821b95ec7642804vboxsync Log(("%s: %p: %d -> %d\n", __FUNCTION__, (pTimer), (pTimer)->enmState, state)); \
9474d83dcac691984017f8255821b95ec7642804vboxsync uint32_t uOld2 = ASMAtomicXchgU32((uint32_t volatile *)&(pTimer)->enmState, state); \
9474d83dcac691984017f8255821b95ec7642804vboxsync } while (0)
9474d83dcac691984017f8255821b95ec7642804vboxsync * Tries to updates a timer state in the correct atomic manner.
9474d83dcac691984017f8255821b95ec7642804vboxsync# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
9474d83dcac691984017f8255821b95ec7642804vboxsync (fRc) = ASMAtomicCmpXchgU32((uint32_t volatile *)&(pTimer)->enmState, StateNew, StateOld)
9474d83dcac691984017f8255821b95ec7642804vboxsync# define TM_TRY_SET_STATE(pTimer, StateNew, StateOld, fRc) \
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync do { (fRc) = ASMAtomicCmpXchgU32((uint32_t volatile *)&(pTimer)->enmState, StateNew, StateOld); \
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync Log(("%s: %p: %d -> %d %RTbool\n", __FUNCTION__, (pTimer), StateOld, StateNew, fRc)); \
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync } while (0)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Get the previous timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMER_GET_PREV(pTimer) ((PTMTIMER)((pTimer)->offPrev ? (intptr_t)(pTimer) + (pTimer)->offPrev : 0))
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Get the next timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMER_GET_NEXT(pTimer) ((PTMTIMER)((pTimer)->offNext ? (intptr_t)(pTimer) + (pTimer)->offNext : 0))
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Set the previous timer link. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMER_SET_PREV(pTimer, pPrev) ((pTimer)->offPrev = (pPrev) ? (intptr_t)(pPrev) - (intptr_t)(pTimer) : 0)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Set the next timer link. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMER_SET_NEXT(pTimer, pNext) ((pTimer)->offNext = (pNext) ? (intptr_t)(pNext) - (intptr_t)(pTimer) : 0)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * A timer queue.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This is allocated on the hyper heap.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsynctypedef struct TMTIMERQUEUE
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The cached expire time for this queue.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Updated by EMT when scheduling the queue or modifying the head timer.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Assigned UINT64_MAX when there is no head timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Doubly linked list of active timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * When no scheduling is pending, this list is will be ordered by expire time (ascending).
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Access is serialized by only letting the emulation thread (EMT) do changes.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The offset is relative to the queue structure.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** List of timers pending scheduling of some kind.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Timer stats allowed in the list are TMTIMERSTATE_PENDING_STOPPING,
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * TMTIMERSTATE_PENDING_DESTRUCTION, TMTIMERSTATE_PENDING_STOPPING_DESTRUCTION,
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * TMTIMERSTATE_PENDING_RESCHEDULING and TMTIMERSTATE_PENDING_SCHEDULE.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The offset is relative to the queue structure.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The clock for this queue. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pad the structure up to 32 bytes. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Pointer to a timer queue. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Get the head of the active timer list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMER_GET_HEAD(pQueue) ((PTMTIMER)((pQueue)->offActive ? (intptr_t)(pQueue) + (pQueue)->offActive : 0))
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Set the head of the active timer list. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TMTIMER_SET_HEAD(pQueue, pHead) ((pQueue)->offActive = pHead ? (intptr_t)pHead - (intptr_t)(pQueue) : 0)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * CPU load data set.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Mainly used by tmR3CpuLoadTimer.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The percent of the period spent executing guest code. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The percent of the period spent halted. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The percent of the period spent on other things. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Explicit alignment padding */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Previous cNsTotal value. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Previous cNsExecuting value. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Previous cNsHalted value. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncAssertCompileMemberAlignment(TMCPULOADSTATE, cNsPrevTotal, 8);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Pointer to a CPU load data set. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * TSC mode.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The main modes of how TM implements the TSC clock (TMCLOCK_TSC).
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The guest TSC is an emulated virtual TSC. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The guest TSC is an offset of the real TSC. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The guest TSC is dynamically derived through emulation or offsetting. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Converts a TM pointer into a VM pointer.
74407ed9ebae51fb7a33c31f2965f7e105a626ebvboxsync * @returns Pointer to the VM structure the TM is part of.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param pTM Pointer to TM instance data.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync#define TM2VM(pTM) ( (PVM)((char*)pTM - pTM->offVM) )
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * TM VM Instance data.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Changes to this must checked against the padding of the cfgm union in VM!
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsynctypedef struct TM
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Offset to the VM structure.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * See TM2VM(). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The current TSC mode of the VM.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Config variable: Mode (string). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Whether the TSC is tied to the execution of code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Config variable: TSCTiedToExecution (bool) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Modifier for fTSCTiedToExecution which pauses the TSC while halting if true.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Config variable: TSCNotTiedToHalt (bool) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Alignment padding. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The ID of the virtual CPU that normally runs the timers. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The number of CPU clock ticks per second (TMCLOCK_TSC).
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Config variable: TSCTicksPerSecond (64-bit unsigned int)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The config variable implies @c enmTSCMode would be
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * TMTSCMODE_VIRT_TSC_EMULATED. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The TSC difference introduced by pausing the VM. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The TSC value when the last TSC was paused. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** CPU TSCs ticking indicator (one for each VCPU). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Virtual time ticking enabled indicator (counter for each VCPU). (TMCLOCK_VIRTUAL) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Virtual time is not running at 100%. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Virtual timer synchronous time ticking enabled indicator (bool). (TMCLOCK_VIRTUAL_SYNC) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Virtual timer synchronous time catch-up active. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Alignment padding. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** WarpDrive percentage.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * 100% is normal (fVirtualSyncNormal == true). When other than 100% we apply
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * this percentage to the raw time source for the period it's been valid in,
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * i.e. since u64VirtualWarpDriveStart. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The offset of the virtual clock relative to it's timesource.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Only valid if fVirtualTicking is set. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The guest virtual time when fVirtualTicking is cleared. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** When the Warp drive was started or last adjusted.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Only valid when fVirtualWarpDrive is set. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The previously returned nano TS.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This handles TSC drift on SMP systems and expired interval.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This is a valid range u64NanoTS to u64NanoTS + 1000000000 (ie. 1sec). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The ring-3 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The ring-0 data structure for the RTTimeNanoTS workers used by tmVirtualGetRawNanoTS. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync R3PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR3;
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync R0PTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawR0;
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to the ring-3 tmVirtualGetRawNanoTS worker function. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync RCPTRTYPE(PFNTIMENANOTSINTERNAL) pfnVirtualGetRawRC;
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Alignment. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The guest virtual timer synchronous time when fVirtualSyncTicking is cleared.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * When fVirtualSyncTicking is set it holds the last time returned to
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * the guest (while the lock was held). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The offset of the timer synchronous virtual clock (TMCLOCK_VIRTUAL_SYNC) relative
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * to the virtual clock (TMCLOCK_VIRTUAL).
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * (This is accessed by the timer thread and must be updated atomically.) */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The offset into offVirtualSync that's been irrevocably given up by failed catch-up attempts.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Thus the current lag is offVirtualSync - offVirtualSyncGivenUp. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The TMCLOCK_VIRTUAL at the previous TMVirtualGetSync call when catch-up is active. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The current catch-up percentage. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** How much slack when processing timers. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** When to stop catch-up. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** When to give up catch-up. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** @def TM_MAX_CATCHUP_PERIODS
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The number of catchup rates. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The aggressiveness of the catch-up relative to how far we've lagged behind.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The idea is to have increasing catch-up percentage as the lag increases. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync uint64_t u64Start; /**< When this period starts. (u64VirtualSyncOffset). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync uint32_t u32Percentage; /**< The catch-up percent to apply. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync } aVirtualSyncCatchUpPeriods[TM_MAX_CATCHUP_PERIODS];
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The current max timer Hz hint. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Whether to recalulate the HzHint next time its queried. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Alignment */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @cfgm{/TM/HostHzMax, uint32_t, Hz, 0, UINT32_MAX, 20000}
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The max host Hz frequency hint returned by TMCalcHostTimerFrequency. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @cfgm{/TM/HostHzFudgeFactorTimerCpu, uint32_t, Hz, 0, UINT32_MAX, 111}
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The number of Hz TMCalcHostTimerFrequency adds for the timer CPU. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @cfgm{/TM/HostHzFudgeFactorOtherCpu, uint32_t, Hz, 0, UINT32_MAX, 110}
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The number of Hz TMCalcHostTimerFrequency adds for the other CPUs. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @cfgm{/TM/HostHzFudgeFactorCatchUp100, uint32_t, Hz, 0, UINT32_MAX, 300}
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The fudge factor (expressed in percent) that catch-up percentages below
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * 100% is multiplied by. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @cfgm{/TM/HostHzFudgeFactorCatchUp200, uint32_t, Hz, 0, UINT32_MAX, 250}
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The fudge factor (expressed in percent) that catch-up percentages
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * 100%-199% is multiplied by. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @cfgm{/TM/HostHzFudgeFactorCatchUp400, uint32_t, Hz, 0, UINT32_MAX, 200}
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The fudge factor (expressed in percent) that catch-up percentages
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * 200%-399% is multiplied by. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The UTC offset in ns.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This is *NOT* for converting UTC to local time. It is for converting real
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * world UTC time to VM UTC time. This feature is indented for doing date
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * testing of software and similar.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @todo Implement warpdrive on UTC. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer queues for the different clock types - R3 Ptr */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer queues for the different clock types - R0 Ptr */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Timer queues for the different clock types - RC Ptr */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to our RC mapping of the GIP. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to our R3 mapping of the GIP. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to a singly linked list of free timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This chain is using the TMTIMER::pBigNext members.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Only accessible from the emulation thread. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Pointer to a doubly linked list of created timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This chain is using the TMTIMER::pBigNext and TMTIMER::pBigPrev members.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Only accessible from the emulation thread. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The schedule timer timer handle (runtime timer).
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This timer will do frequent check on pending queue schedules and
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * raise VM_FF_TIMER to pull EMTs attention to them.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Interval in milliseconds of the pTimer timer. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Indicates that queues are being run. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync bool volatile fRunningQueues;
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Indicates that the virtual sync queue is being run. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Alignment */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Lock serializing access to the timer lists. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Lock serializing access to the VirtualSync clock and the associated
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * timer queue. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** CPU load state for all the virtual CPUs (tmR3CpuLoadTimer). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMR3TimerQueuesDo
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** tmSchedule
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Read the time
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTimerPoll
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTimerSet sans virtual sync timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTimerSet on virtual sync timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTimerSetRelative sans virtual sync timers
9474d83dcac691984017f8255821b95ec7642804vboxsync /** TMTimerSetRelative on virtual sync timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTimerStop sans virtual sync.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMTimerStop on virtual sync timers.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** VirtualSync - Running and Catching Up
9474d83dcac691984017f8255821b95ec7642804vboxsync STAMCOUNTER aStatVirtualSyncCatchupInitial[TM_MAX_CATCHUP_PERIODS];
9474d83dcac691984017f8255821b95ec7642804vboxsync STAMCOUNTER aStatVirtualSyncCatchupAdjust[TM_MAX_CATCHUP_PERIODS];
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TMR3VirtualSyncFF (non dedicated EMT). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** The timer callback. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Calls to TMCpuTickSet. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** TSC starts and stops. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** @name Reasons for refusing TSC offsetting in TMCpuTickCanUseRealTSC.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Pointer to TM VM instance data. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * TM VMCPU Instance data.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Changes to this must checked against the padding of the tm union in VM!
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsynctypedef struct TMCPU
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Offset to the VMCPU structure.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * See TMCPU2VM(). */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** CPU timestamp ticking enabled indicator (bool). (RDTSC) */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The offset between the raw TSC source and the Guest TSC.
9474d83dcac691984017f8255821b95ec7642804vboxsync * Only valid if fTicking is set and and fTSCUseRealTSC is clear. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The guest TSC when fTicking is cleared. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The last seen TSC by the guest. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The nanosecond timestamp of the CPU start or resume.
9474d83dcac691984017f8255821b95ec7642804vboxsync * This is recalculated when the VM is started so that
9474d83dcac691984017f8255821b95ec7642804vboxsync * cNsTotal = RTTimeNanoTS() - u64NsTsStartCpu. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The nanosecond timestamp of the last start-execute notification. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The nanosecond timestamp of the last start-halt notification. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The cNsXXX generation. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** Explicit alignment padding. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The number of nanoseconds total run time.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @remarks This is updated when cNsExecuting and cNsHalted are updated. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The number of nanoseconds spent executing. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The number of nanoseconds being halted. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The number of nanoseconds spent on other things.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @remarks This is updated when cNsExecuting and cNsHalted are updated. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The number of halts. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** The number of guest execution runs. */
9474d83dcac691984017f8255821b95ec7642804vboxsync# if defined(VBOX_WITH_STATISTICS) || defined(VBOX_WITH_NS_ACCOUNTING_STATS)
9474d83dcac691984017f8255821b95ec7642804vboxsync /** Resettable version of cNsTotal. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** Resettable version of cNsExecuting. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** Long execution intervals. */
9474d83dcac691984017f8255821b95ec7642804vboxsync /** Short execution intervals . */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Tiny execution intervals . */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Resettable version of cNsHalted. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** Resettable version of cNsOther. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync /** CPU load state for this virtual CPU (tmR3CpuLoadTimer). */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Pointer to TM VMCPU instance data. */
9474d83dcac691984017f8255821b95ec7642804vboxsyncvoid tmTimerQueueSchedule(PVM pVM, PTMTIMERQUEUE pQueue);
9474d83dcac691984017f8255821b95ec7642804vboxsyncvoid tmTimerQueuesSanityChecks(PVM pVM, const char *pszWhere);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncDECLEXPORT(void) tmVirtualNanoTSBad(PRTTIMENANOTSDATA pData, uint64_t u64NanoTS, uint64_t u64DeltaPrev, uint64_t u64PrevNanoTS);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncDECLEXPORT(uint64_t) tmVirtualNanoTSRediscover(PRTTIMENANOTSDATA pData);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Try take the timer lock, wait in ring-3 return VERR_SEM_BUSY in R0/RC.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VINF_SUCCESS on success (always in ring-3).
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_SEM_BUSY in RC and R0 if the semaphore is busy.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param a_pVM Pointer to the VM.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @remarks The virtual sync timer queue requires the virtual sync lock.
9474d83dcac691984017f8255821b95ec7642804vboxsync#define TM_LOCK_TIMERS(a_pVM) PDMCritSectEnter(&(a_pVM)->tm.s.TimerCritSect, VERR_SEM_BUSY)
9474d83dcac691984017f8255821b95ec7642804vboxsync * Try take the timer lock, no waiting.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VINF_SUCCESS on success.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VERR_SEM_BUSY if busy.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param a_pVM Pointer to the VM.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @remarks The virtual sync timer queue requires the virtual sync lock.
9474d83dcac691984017f8255821b95ec7642804vboxsync#define TM_TRY_LOCK_TIMERS(a_pVM) PDMCritSectTryEnter(&(a_pVM)->tm.s.TimerCritSect)
9474d83dcac691984017f8255821b95ec7642804vboxsync/** Lock the timers (sans the virtual sync queue). */
9474d83dcac691984017f8255821b95ec7642804vboxsync#define TM_UNLOCK_TIMERS(a_pVM) do { PDMCritSectLeave(&(a_pVM)->tm.s.TimerCritSect); } while (0)
9474d83dcac691984017f8255821b95ec7642804vboxsync/** Checks that the caller owns the timer lock. */