VirtualBox

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

最後變更 在這個檔案從87633是 87633,由 vboxsync 提交於 4 年 前

VMM/TM,VMM/HMVMX: Try avoid calling TMCpuTickGetDeadlineAndTscOffset as it is expensive. Current approach is a bit erratic wrt CPUID benchmark results, but it's generally better than before.

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

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