VirtualBox

source: vbox/trunk/include/VBox/vmm/tm.h@ 67989

Last change on this file since 67989 was 65896, checked in by vboxsync, 8 years ago

VMM: Add TMR3TimerSkip to skip a saved timer state in a given SSM stream (for saved state comptibility if timers get removed)
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.2 KB
Line 
1/** @file
2 * TM - Time Manager.
3 */
4
5/*
6 * Copyright (C) 2006-2016 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vmm_tm_h
27#define ___VBox_vmm_tm_h
28
29#include <VBox/types.h>
30#ifdef IN_RING3
31# include <iprt/time.h>
32#endif
33
34RT_C_DECLS_BEGIN
35
36/** @defgroup grp_tm The Time Manager API
37 * @ingroup grp_vmm
38 * @{
39 */
40
41/** Enable a timer hack which improves the timer response/resolution a bit. */
42#define VBOX_HIGH_RES_TIMERS_HACK
43
44
45/**
46 * Clock type.
47 */
48typedef enum TMCLOCK
49{
50 /** Real host time.
51 * This clock ticks all the time, so use with care. */
52 TMCLOCK_REAL = 0,
53 /** Virtual guest time.
54 * This clock only ticks when the guest is running. It's implemented
55 * as an offset to monotonic real time (GIP). */
56 TMCLOCK_VIRTUAL,
57 /** Virtual guest synchronized timer time.
58 * This is a special clock and timer queue for synchronizing virtual timers
59 * and virtual time sources. This clock is trying to keep up with
60 * TMCLOCK_VIRTUAL, but will wait for timers to be executed. If it lags
61 * too far behind TMCLOCK_VIRTUAL, it will try speed up to close the
62 * distance.
63 * @remarks Do not use this unless you really *must*. */
64 TMCLOCK_VIRTUAL_SYNC,
65 /** Virtual CPU timestamp.
66 * By default this is a function of TMCLOCK_VIRTUAL_SYNC and the virtual
67 * CPU frequency. */
68 TMCLOCK_TSC,
69 /** Number of clocks. */
70 TMCLOCK_MAX
71} TMCLOCK;
72
73
74/** @defgroup grp_tm_timer_flags Timer flags.
75 * @{ */
76/** Use the default critical section for the class of timers. */
77#define TMTIMER_FLAGS_DEFAULT_CRIT_SECT 0
78/** No critical section needed or a custom one is set using
79 * TMR3TimerSetCritSect(). */
80#define TMTIMER_FLAGS_NO_CRIT_SECT RT_BIT_32(0)
81/** @} */
82
83
84VMMDECL(void) TMNotifyStartOfExecution(PVMCPU pVCpu);
85VMMDECL(void) TMNotifyEndOfExecution(PVMCPU pVCpu);
86VMM_INT_DECL(void) TMNotifyStartOfHalt(PVMCPU pVCpu);
87VMM_INT_DECL(void) TMNotifyEndOfHalt(PVMCPU pVCpu);
88#ifdef IN_RING3
89VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu);
90VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu);
91VMMR3DECL(int) TMR3SetWarpDrive(PUVM pUVM, uint32_t u32Percent);
92VMMR3DECL(uint32_t) TMR3GetWarpDrive(PUVM pUVM);
93#endif
94VMM_INT_DECL(uint32_t) TMCalcHostTimerFrequency(PVM pVM, PVMCPU pVCpu);
95#ifdef IN_RING3
96VMMR3DECL(int) TMR3GetCpuLoadTimes(PVM pVM, VMCPUID idCpu, uint64_t *pcNsTotal, uint64_t *pcNsExecuting,
97 uint64_t *pcNsHalted, uint64_t *pcNsOther);
98#endif
99
100
101/** @name Real Clock Methods
102 * @{
103 */
104VMM_INT_DECL(uint64_t) TMRealGet(PVM pVM);
105VMM_INT_DECL(uint64_t) TMRealGetFreq(PVM pVM);
106/** @} */
107
108
109/** @name Virtual Clock Methods
110 * @{
111 */
112VMM_INT_DECL(uint64_t) TMVirtualGet(PVM pVM);
113VMM_INT_DECL(uint64_t) TMVirtualGetNoCheck(PVM pVM);
114VMM_INT_DECL(uint64_t) TMVirtualSyncGetLag(PVM pVM);
115VMM_INT_DECL(uint32_t) TMVirtualSyncGetCatchUpPct(PVM pVM);
116VMM_INT_DECL(uint64_t) TMVirtualGetFreq(PVM pVM);
117VMM_INT_DECL(uint64_t) TMVirtualSyncGet(PVM pVM);
118VMM_INT_DECL(uint64_t) TMVirtualSyncGetNoCheck(PVM pVM);
119VMM_INT_DECL(uint64_t) TMVirtualSyncGetEx(PVM pVM, bool fCheckTimers);
120VMM_INT_DECL(uint64_t) TMVirtualSyncGetWithDeadlineNoCheck(PVM pVM, uint64_t *pcNsToDeadline);
121VMMDECL(uint64_t) TMVirtualSyncGetNsToDeadline(PVM pVM);
122VMM_INT_DECL(uint64_t) TMVirtualToNano(PVM pVM, uint64_t u64VirtualTicks);
123VMM_INT_DECL(uint64_t) TMVirtualToMicro(PVM pVM, uint64_t u64VirtualTicks);
124VMM_INT_DECL(uint64_t) TMVirtualToMilli(PVM pVM, uint64_t u64VirtualTicks);
125VMM_INT_DECL(uint64_t) TMVirtualFromNano(PVM pVM, uint64_t u64NanoTS);
126VMM_INT_DECL(uint64_t) TMVirtualFromMicro(PVM pVM, uint64_t u64MicroTS);
127VMM_INT_DECL(uint64_t) TMVirtualFromMilli(PVM pVM, uint64_t u64MilliTS);
128VMM_INT_DECL(bool) TMVirtualIsTicking(PVM pVM);
129
130VMMR3DECL(uint64_t) TMR3TimeVirtGet(PUVM pUVM);
131VMMR3DECL(uint64_t) TMR3TimeVirtGetMilli(PUVM pUVM);
132VMMR3DECL(uint64_t) TMR3TimeVirtGetMicro(PUVM pUVM);
133VMMR3DECL(uint64_t) TMR3TimeVirtGetNano(PUVM pUVM);
134/** @} */
135
136
137/** @name CPU Clock Methods
138 * @{
139 */
140VMMDECL(uint64_t) TMCpuTickGet(PVMCPU pVCpu);
141VMM_INT_DECL(uint64_t) TMCpuTickGetNoCheck(PVMCPU pVCpu);
142VMM_INT_DECL(bool) TMCpuTickCanUseRealTSC(PVM pVM, PVMCPU pVCpu, uint64_t *poffRealTSC, bool *pfParavirtTsc);
143VMM_INT_DECL(uint64_t) TMCpuTickGetDeadlineAndTscOffset(PVM pVM, PVMCPU pVCpu, uint64_t *poffRealTSC, bool *pfOffsettedTsc, bool *pfParavirtTsc);
144VMM_INT_DECL(int) TMCpuTickSet(PVM pVM, PVMCPU pVCpu, uint64_t u64Tick);
145VMM_INT_DECL(int) TMCpuTickSetLastSeen(PVMCPU pVCpu, uint64_t u64LastSeenTick);
146VMM_INT_DECL(uint64_t) TMCpuTickGetLastSeen(PVMCPU pVCpu);
147VMMDECL(uint64_t) TMCpuTicksPerSecond(PVM pVM);
148VMM_INT_DECL(bool) TMCpuTickIsTicking(PVMCPU pVCpu);
149/** @} */
150
151
152/** @name Timer Methods
153 * @{
154 */
155/**
156 * Device timer callback function.
157 *
158 * @param pDevIns Device instance of the device which registered the timer.
159 * @param pTimer The timer handle.
160 * @param pvUser User argument specified upon timer creation.
161 */
162typedef DECLCALLBACK(void) FNTMTIMERDEV(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser);
163/** Pointer to a device timer callback function. */
164typedef FNTMTIMERDEV *PFNTMTIMERDEV;
165
166/**
167 * USB device timer callback function.
168 *
169 * @param pUsbIns The USB device instance the timer is associated
170 * with.
171 * @param pTimer The timer handle.
172 * @param pvUser User argument specified upon timer creation.
173 */
174typedef DECLCALLBACK(void) FNTMTIMERUSB(PPDMUSBINS pUsbIns, PTMTIMER pTimer, void *pvUser);
175/** Pointer to a timer callback for a USB device. */
176typedef FNTMTIMERUSB *PFNTMTIMERUSB;
177
178/**
179 * Driver timer callback function.
180 *
181 * @param pDrvIns Device instance of the device which registered the timer.
182 * @param pTimer The timer handle.
183 * @param pvUser User argument specified upon timer creation.
184 */
185typedef DECLCALLBACK(void) FNTMTIMERDRV(PPDMDRVINS pDrvIns, PTMTIMER pTimer, void *pvUser);
186/** Pointer to a driver timer callback function. */
187typedef FNTMTIMERDRV *PFNTMTIMERDRV;
188
189/**
190 * Service timer callback function.
191 *
192 * @param pSrvIns Service instance of the device which registered the timer.
193 * @param pTimer The timer handle.
194 */
195typedef DECLCALLBACK(void) FNTMTIMERSRV(PPDMSRVINS pSrvIns, PTMTIMER pTimer);
196/** Pointer to a service timer callback function. */
197typedef FNTMTIMERSRV *PFNTMTIMERSRV;
198
199/**
200 * Internal timer callback function.
201 *
202 * @param pVM The cross context VM structure.
203 * @param pTimer The timer handle.
204 * @param pvUser User argument specified upon timer creation.
205 */
206typedef DECLCALLBACK(void) FNTMTIMERINT(PVM pVM, PTMTIMER pTimer, void *pvUser);
207/** Pointer to internal timer callback function. */
208typedef FNTMTIMERINT *PFNTMTIMERINT;
209
210/**
211 * External timer callback function.
212 *
213 * @param pvUser User argument as specified when the timer was created.
214 */
215typedef DECLCALLBACK(void) FNTMTIMEREXT(void *pvUser);
216/** Pointer to an external timer callback function. */
217typedef FNTMTIMEREXT *PFNTMTIMEREXT;
218
219VMMDECL(PTMTIMERR3) TMTimerR3Ptr(PTMTIMER pTimer);
220VMMDECL(PTMTIMERR0) TMTimerR0Ptr(PTMTIMER pTimer);
221VMMDECL(PTMTIMERRC) TMTimerRCPtr(PTMTIMER pTimer);
222VMMDECL(int) TMTimerLock(PTMTIMER pTimer, int rcBusy);
223VMMDECL(void) TMTimerUnlock(PTMTIMER pTimer);
224VMMDECL(bool) TMTimerIsLockOwner(PTMTIMER pTimer);
225VMMDECL(int) TMTimerSet(PTMTIMER pTimer, uint64_t u64Expire);
226VMMDECL(int) TMTimerSetRelative(PTMTIMER pTimer, uint64_t cTicksToNext, uint64_t *pu64Now);
227VMMDECL(int) TMTimerSetFrequencyHint(PTMTIMER pTimer, uint32_t uHz);
228VMMDECL(uint64_t) TMTimerGet(PTMTIMER pTimer);
229VMMDECL(int) TMTimerStop(PTMTIMER pTimer);
230VMMDECL(bool) TMTimerIsActive(PTMTIMER pTimer);
231
232VMMDECL(int) TMTimerSetMillies(PTMTIMER pTimer, uint32_t cMilliesToNext);
233VMMDECL(int) TMTimerSetMicro(PTMTIMER pTimer, uint64_t cMicrosToNext);
234VMMDECL(int) TMTimerSetNano(PTMTIMER pTimer, uint64_t cNanosToNext);
235VMMDECL(uint64_t) TMTimerGetNano(PTMTIMER pTimer);
236VMMDECL(uint64_t) TMTimerGetMicro(PTMTIMER pTimer);
237VMMDECL(uint64_t) TMTimerGetMilli(PTMTIMER pTimer);
238VMMDECL(uint64_t) TMTimerGetFreq(PTMTIMER pTimer);
239VMMDECL(uint64_t) TMTimerGetExpire(PTMTIMER pTimer);
240VMMDECL(uint64_t) TMTimerToNano(PTMTIMER pTimer, uint64_t cTicks);
241VMMDECL(uint64_t) TMTimerToMicro(PTMTIMER pTimer, uint64_t cTicks);
242VMMDECL(uint64_t) TMTimerToMilli(PTMTIMER pTimer, uint64_t cTicks);
243VMMDECL(uint64_t) TMTimerFromNano(PTMTIMER pTimer, uint64_t cNanoSecs);
244VMMDECL(uint64_t) TMTimerFromMicro(PTMTIMER pTimer, uint64_t cMicroSecs);
245VMMDECL(uint64_t) TMTimerFromMilli(PTMTIMER pTimer, uint64_t cMilliSecs);
246
247VMMDECL(bool) TMTimerPollBool(PVM pVM, PVMCPU pVCpu);
248VMM_INT_DECL(void) TMTimerPollVoid(PVM pVM, PVMCPU pVCpu);
249VMM_INT_DECL(uint64_t) TMTimerPollGIP(PVM pVM, PVMCPU pVCpu, uint64_t *pu64Delta);
250/** @} */
251
252
253#ifdef IN_RING3
254/** @defgroup grp_tm_r3 The TM Host Context Ring-3 API
255 * @{
256 */
257VMM_INT_DECL(int) TMR3Init(PVM pVM);
258VMM_INT_DECL(int) TMR3InitFinalize(PVM pVM);
259VMM_INT_DECL(void) TMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
260VMM_INT_DECL(int) TMR3Term(PVM pVM);
261VMM_INT_DECL(void) TMR3Reset(PVM pVM);
262VMM_INT_DECL(int) TMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue);
263VMM_INT_DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer);
264VMM_INT_DECL(int) TMR3TimerCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer);
265VMM_INT_DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer);
266VMMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer);
267VMMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc);
268VMMR3DECL(int) TMR3TimerDestroy(PTMTIMER pTimer);
269VMM_INT_DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns);
270VMM_INT_DECL(int) TMR3TimerDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns);
271VMM_INT_DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns);
272VMMR3DECL(int) TMR3TimerSave(PTMTIMERR3 pTimer, PSSMHANDLE pSSM);
273VMMR3DECL(int) TMR3TimerLoad(PTMTIMERR3 pTimer, PSSMHANDLE pSSM);
274VMMR3DECL(int) TMR3TimerSkip(PSSMHANDLE pSSM, bool *pfActive);
275VMMR3DECL(int) TMR3TimerSetCritSect(PTMTIMERR3 pTimer, PPDMCRITSECT pCritSect);
276VMMR3DECL(void) TMR3TimerQueuesDo(PVM pVM);
277VMMR3_INT_DECL(void) TMR3VirtualSyncFF(PVM pVM, PVMCPU pVCpu);
278VMMR3_INT_DECL(PRTTIMESPEC) TMR3UtcNow(PVM pVM, PRTTIMESPEC pTime);
279
280VMMR3_INT_DECL(int) TMR3CpuTickParavirtEnable(PVM pVM);
281VMMR3_INT_DECL(int) TMR3CpuTickParavirtDisable(PVM pVM);
282VMMR3_INT_DECL(bool) TMR3CpuTickIsFixedRateMonotonic(PVM pVM, bool fWithParavirtEnabled);
283/** @} */
284#endif /* IN_RING3 */
285
286
287/** @} */
288
289RT_C_DECLS_END
290
291#endif
292
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette