VirtualBox

source: vbox/trunk/include/VBox/tm.h@ 28800

Last change on this file since 28800 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.5 KB
Line 
1/** @file
2 * TM - Time Manager. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2007 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_tm_h
27#define ___VBox_tm_h
28
29#include <VBox/cdefs.h>
30#include <VBox/types.h>
31#ifdef IN_RING3
32# include <iprt/time.h>
33#endif
34
35RT_C_DECLS_BEGIN
36
37/** @defgroup grp_tm The Time Manager API
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 real time. */
56 TMCLOCK_VIRTUAL,
57 /** Virtual guest synchronized timer time.
58 * This is a special clock and timer queue for synchronizing virtual timers and
59 * virtual time sources. This clock is trying to keep up with TMCLOCK_VIRTUAL,
60 * but will wait for timers to be executed. If it lags too far behind TMCLOCK_VIRTUAL,
61 * it will try speed up to close the distance.
62 * @remarks Do not use this unless you *must*. */
63 TMCLOCK_VIRTUAL_SYNC,
64 /** Virtual CPU timestamp. (Running only when we're executing guest code.) */
65 TMCLOCK_TSC,
66 /** Number of clocks. */
67 TMCLOCK_MAX
68} TMCLOCK;
69
70
71/** @defgroup grp_tm_timer_flags Timer flags.
72 * @{ */
73/** Use the default critical section for the class of timers. */
74#define TMTIMER_FLAGS_DEFAULT_CRIT_SECT 0
75/** No critical section needed or a custom one is set using
76 * TMR3TimerSetCritSect(). */
77#define TMTIMER_FLAGS_NO_CRIT_SECT RT_BIT_32(0)
78/** @} */
79
80
81VMMDECL(void) TMNotifyStartOfExecution(PVMCPU pVCpu);
82VMMDECL(void) TMNotifyEndOfExecution(PVMCPU pVCpu);
83VMM_INT_DECL(void) TMNotifyStartOfHalt(PVMCPU pVCpu);
84VMM_INT_DECL(void) TMNotifyEndOfHalt(PVMCPU pVCpu);
85#ifdef IN_RING3
86VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu);
87VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu);
88VMMR3DECL(int) TMR3SetWarpDrive(PVM pVM, uint32_t u32Percent);
89#endif
90VMMDECL(uint32_t) TMGetWarpDrive(PVM pVM);
91
92
93/** @name Real Clock Methods
94 * @{
95 */
96VMM_INT_DECL(uint64_t) TMRealGet(PVM pVM);
97VMM_INT_DECL(uint64_t) TMRealGetFreq(PVM pVM);
98/** @} */
99
100
101/** @name Virtual Clock Methods
102 * @{
103 */
104VMM_INT_DECL(uint64_t) TMVirtualGet(PVM pVM);
105VMM_INT_DECL(uint64_t) TMVirtualGetNoCheck(PVM pVM);
106VMM_INT_DECL(uint64_t) TMVirtualSyncGetLag(PVM pVM);
107VMM_INT_DECL(uint32_t) TMVirtualSyncGetCatchUpPct(PVM pVM);
108VMM_INT_DECL(uint64_t) TMVirtualGetFreq(PVM pVM);
109VMM_INT_DECL(uint64_t) TMVirtualSyncGet(PVM pVM);
110VMM_INT_DECL(uint64_t) TMVirtualSyncGetNoCheck(PVM pVM);
111VMM_INT_DECL(uint64_t) TMVirtualSyncGetEx(PVM pVM, bool fCheckTimers);
112VMM_INT_DECL(uint64_t) TMVirtualToNano(PVM pVM, uint64_t u64VirtualTicks);
113VMM_INT_DECL(uint64_t) TMVirtualToMicro(PVM pVM, uint64_t u64VirtualTicks);
114VMM_INT_DECL(uint64_t) TMVirtualToMilli(PVM pVM, uint64_t u64VirtualTicks);
115VMM_INT_DECL(uint64_t) TMVirtualFromNano(PVM pVM, uint64_t u64NanoTS);
116VMM_INT_DECL(uint64_t) TMVirtualFromMicro(PVM pVM, uint64_t u64MicroTS);
117VMM_INT_DECL(uint64_t) TMVirtualFromMilli(PVM pVM, uint64_t u64MilliTS);
118/** @} */
119
120
121/** @name CPU Clock Methods
122 * @{
123 */
124VMMDECL(uint64_t) TMCpuTickGet(PVMCPU pVCpu);
125VMM_INT_DECL(uint64_t) TMCpuTickGetNoCheck(PVMCPU pVCpu);
126VMM_INT_DECL(bool) TMCpuTickCanUseRealTSC(PVMCPU pVCpu, uint64_t *poffRealTSC);
127VMM_INT_DECL(int) TMCpuTickSet(PVM pVM, PVMCPU pVCpu, uint64_t u64Tick);
128VMM_INT_DECL(int) TMCpuTickSetLastSeen(PVMCPU pVCpu, uint64_t u64LastSeenTick);
129VMM_INT_DECL(uint64_t) TMCpuTickGetLastSeen(PVMCPU pVCpu);
130VMMDECL(uint64_t) TMCpuTicksPerSecond(PVM pVM);
131/** @} */
132
133
134/** @name Timer Methods
135 * @{
136 */
137/**
138 * Device timer callback function.
139 *
140 * @param pDevIns Device instance of the device which registered the timer.
141 * @param pTimer The timer handle.
142 * @param pvUser User argument specified upon timer creation.
143 */
144typedef DECLCALLBACK(void) FNTMTIMERDEV(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser);
145/** Pointer to a device timer callback function. */
146typedef FNTMTIMERDEV *PFNTMTIMERDEV;
147
148/**
149 * Device timer callback function.
150 *
151 * @param pUsbIns The USB device instance the timer is associated
152 * with.
153 * @param pTimer The timer handle.
154 * @param pvUser User argument specified upon timer creation.
155 */
156typedef DECLCALLBACK(void) FNTMTIMERUSB(PPDMUSBINS pUsbIns, PTMTIMER pTimer, void *pvUser);
157/** Pointer to a timer callback for a USB device. */
158typedef FNTMTIMERUSB *PFNTMTIMERUSB;
159
160/**
161 * Driver timer callback function.
162 *
163 * @param pDrvIns Device instance of the device which registered the timer.
164 * @param pTimer The timer handle.
165 * @param pvUser User argument specified upon timer creation.
166 */
167typedef DECLCALLBACK(void) FNTMTIMERDRV(PPDMDRVINS pDrvIns, PTMTIMER pTimer, void *pvUser);
168/** Pointer to a driver timer callback function. */
169typedef FNTMTIMERDRV *PFNTMTIMERDRV;
170
171/**
172 * Service timer callback function.
173 *
174 * @param pSrvIns Service instance of the device which registered the timer.
175 * @param pTimer The timer handle.
176 */
177typedef DECLCALLBACK(void) FNTMTIMERSRV(PPDMSRVINS pSrvIns, PTMTIMER pTimer);
178/** Pointer to a service timer callback function. */
179typedef FNTMTIMERSRV *PFNTMTIMERSRV;
180
181/**
182 * Internal timer callback function.
183 *
184 * @param pVM The VM.
185 * @param pTimer The timer handle.
186 * @param pvUser User argument specified upon timer creation.
187 */
188typedef DECLCALLBACK(void) FNTMTIMERINT(PVM pVM, PTMTIMER pTimer, void *pvUser);
189/** Pointer to internal timer callback function. */
190typedef FNTMTIMERINT *PFNTMTIMERINT;
191
192/**
193 * External timer callback function.
194 *
195 * @param pvUser User argument as specified when the timer was created.
196 */
197typedef DECLCALLBACK(void) FNTMTIMEREXT(void *pvUser);
198/** Pointer to an external timer callback function. */
199typedef FNTMTIMEREXT *PFNTMTIMEREXT;
200
201VMMDECL(PTMTIMERR3) TMTimerR3Ptr(PTMTIMER pTimer);
202VMMDECL(PTMTIMERR0) TMTimerR0Ptr(PTMTIMER pTimer);
203VMMDECL(PTMTIMERRC) TMTimerRCPtr(PTMTIMER pTimer);
204VMMDECL(int) TMTimerSet(PTMTIMER pTimer, uint64_t u64Expire);
205VMMDECL(int) TMTimerSetRelative(PTMTIMER pTimer, uint64_t cTicksToNext, uint64_t *pu64Now);
206VMMDECL(int) TMTimerSetMillies(PTMTIMER pTimer, uint32_t cMilliesToNext);
207VMMDECL(int) TMTimerSetMicro(PTMTIMER pTimer, uint64_t cMicrosToNext);
208VMMDECL(int) TMTimerSetNano(PTMTIMER pTimer, uint64_t cNanosToNext);
209VMMDECL(uint64_t) TMTimerGet(PTMTIMER pTimer);
210VMMDECL(uint64_t) TMTimerGetNano(PTMTIMER pTimer);
211VMMDECL(uint64_t) TMTimerGetMicro(PTMTIMER pTimer);
212VMMDECL(uint64_t) TMTimerGetMilli(PTMTIMER pTimer);
213VMMDECL(uint64_t) TMTimerGetFreq(PTMTIMER pTimer);
214VMMDECL(uint64_t) TMTimerGetExpire(PTMTIMER pTimer);
215VMMDECL(uint64_t) TMTimerToNano(PTMTIMER pTimer, uint64_t u64Ticks);
216VMMDECL(uint64_t) TMTimerToMicro(PTMTIMER pTimer, uint64_t u64Ticks);
217VMMDECL(uint64_t) TMTimerToMilli(PTMTIMER pTimer, uint64_t u64Ticks);
218VMMDECL(uint64_t) TMTimerFromNano(PTMTIMER pTimer, uint64_t u64NanoTS);
219VMMDECL(uint64_t) TMTimerFromMicro(PTMTIMER pTimer, uint64_t u64MicroTS);
220VMMDECL(uint64_t) TMTimerFromMilli(PTMTIMER pTimer, uint64_t u64MilliTS);
221VMMDECL(int) TMTimerStop(PTMTIMER pTimer);
222VMMDECL(bool) TMTimerIsActive(PTMTIMER pTimer);
223VMMDECL(bool) TMTimerPollBool(PVM pVM, PVMCPU pVCpu);
224VMM_INT_DECL(void) TMTimerPollVoid(PVM pVM, PVMCPU pVCpu);
225VMM_INT_DECL(uint64_t) TMTimerPollGIP(PVM pVM, PVMCPU pVCpu, uint64_t *pu64Delta);
226
227/** @} */
228
229
230#ifdef IN_RING3
231/** @defgroup grp_tm_r3 The TM Host Context Ring-3 API
232 * @ingroup grp_tm
233 * @{
234 */
235VMM_INT_DECL(int) TMR3Init(PVM pVM);
236VMM_INT_DECL(int) TMR3InitCPU(PVM pVM);
237VMM_INT_DECL(int) TMR3InitFinalize(PVM pVM);
238VMM_INT_DECL(void) TMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
239VMM_INT_DECL(int) TMR3Term(PVM pVM);
240VMM_INT_DECL(int) TMR3TermCPU(PVM pVM);
241VMM_INT_DECL(void) TMR3Reset(PVM pVM);
242VMM_INT_DECL(int) TMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue);
243VMM_INT_DECL(int) TMR3TimerCreateDevice(PVM pVM, PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer);
244VMM_INT_DECL(int) TMR3TimerCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer);
245VMMR3DECL(int) TMR3TimerCreateInternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMERINT pfnCallback, void *pvUser, const char *pszDesc, PPTMTIMERR3 ppTimer);
246VMMR3DECL(PTMTIMERR3) TMR3TimerCreateExternal(PVM pVM, TMCLOCK enmClock, PFNTMTIMEREXT pfnCallback, void *pvUser, const char *pszDesc);
247VMMR3DECL(int) TMR3TimerDestroy(PTMTIMER pTimer);
248VMM_INT_DECL(int) TMR3TimerDestroyDevice(PVM pVM, PPDMDEVINS pDevIns);
249VMM_INT_DECL(int) TMR3TimerDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns);
250VMMR3DECL(int) TMR3TimerSave(PTMTIMERR3 pTimer, PSSMHANDLE pSSM);
251VMMR3DECL(int) TMR3TimerLoad(PTMTIMERR3 pTimer, PSSMHANDLE pSSM);
252VMMR3DECL(int) TMR3TimerSetCritSect(PTMTIMERR3 pTimer, PPDMCRITSECT pCritSect);
253VMMR3DECL(void) TMR3TimerQueuesDo(PVM pVM);
254VMM_INT_DECL(void) TMR3VirtualSyncFF(PVM pVM, PVMCPU pVCpu);
255VMM_INT_DECL(PRTTIMESPEC) TMR3UtcNow(PVM pVM, PRTTIMESPEC pTime);
256/** @} */
257#endif /* IN_RING3 */
258
259
260/** @} */
261
262RT_C_DECLS_END
263
264#endif
265
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