VirtualBox

source: vbox/trunk/src/VBox/Runtime/generic/timer-generic.cpp@ 289

Last change on this file since 289 was 198, checked in by vboxsync, 18 years ago

thread safe handle invalidating.
  • Property svn:keywords set to Id
File size: 9.4 KB
Line 
1/** @file
2 * InnoTek Portable Runtime - Timers, Ring-0 Driver, Generic.
3 */
4
5/*
6 * Copyright (C) 2006 InnoTek Systemberatung GmbH
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 as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * If you received this file as part of a commercial VirtualBox
17 * distribution, then only the terms of your commercial VirtualBox
18 * license agreement apply instead of the previous paragraph.
19 */
20
21
22/*******************************************************************************
23* Header Files *
24*******************************************************************************/
25#include <iprt/timer.h>
26#include <iprt/thread.h>
27#include <iprt/err.h>
28#include <iprt/assert.h>
29#include <iprt/alloc.h>
30#include <iprt/asm.h>
31#include <iprt/semaphore.h>
32#include <iprt/time.h>
33#include <iprt/log.h>
34
35
36/*******************************************************************************
37* Structures and Typedefs *
38*******************************************************************************/
39/**
40 * The internal representation of a timer handle.
41 */
42typedef struct RTTIMER
43{
44 /** Magic.
45 * This is RTTIMER_MAGIC, but changes to something else before the timer
46 * is destroyed to indicate clearly that thread should exit. */
47 uint32_t volatile u32Magic;
48 /** Flag indicating the the timer is suspended. */
49 uint8_t volatile fSuspended;
50 /** Flag indicating that the timer has been destroyed. */
51 uint8_t volatile fDestroyed;
52 /** Callback. */
53 PFNRTTIMER pfnTimer;
54 /** User argument. */
55 void *pvUser;
56 /** The timer thread. */
57 RTTHREAD Thread;
58 /** Event semaphore on which the thread is blocked. */
59 RTSEMEVENT Event;
60 /** The timer interval. 0 if one-shot. */
61 uint64_t u64NanoInterval;
62 /** The start of the current run.
63 * This is used to calculate when the timer ought to fire the next time. */
64 uint64_t volatile u64StartTS;
65 /** The start of the current run.
66 * This is used to calculate when the timer ought to fire the next time. */
67 uint64_t volatile u64NextTS;
68 /** The current tick number (since u64StartTS). */
69 uint64_t volatile iTick;
70} RTTIMER;
71/** Magic number for timer handles. (Jared Mason Diamond) */
72#define RTTIMER_MAGIC 0x19370910
73
74
75/*******************************************************************************
76* Internal Functions *
77*******************************************************************************/
78static DECLCALLBACK(int) rtTimerThread(RTTHREAD Thread, void *pvUser);
79
80
81RTDECL(int) RTTimerCreate(PRTTIMER *ppTimer, unsigned uMilliesInterval, PFNRTTIMER pfnTimer, void *pvUser)
82{
83 return RTTimerCreateEx(ppTimer, uMilliesInterval * UINT64_C(1000000), 0, pfnTimer, pvUser);
84}
85
86
87RTDECL(int) RTTimerCreateEx(PRTTIMER *ppTimer, uint64_t u64NanoInterval, unsigned fFlags, PFNRTTIMER pfnTimer, void *pvUser)
88{
89 *ppTimer = NULL;
90
91 /*
92 * Allocate and initialize the timer handle.
93 */
94 PRTTIMER pTimer = (PRTTIMER)RTMemAlloc(sizeof(*pTimer));
95 if (!pTimer)
96 return VERR_NO_MEMORY;
97
98 pTimer->u32Magic = RTTIMER_MAGIC;
99 pTimer->fSuspended = true;
100 pTimer->fDestroyed = false;
101 pTimer->pfnTimer = pfnTimer;
102 pTimer->pvUser = pvUser;
103 pTimer->Thread = NIL_RTTHREAD;
104 pTimer->Event = NIL_RTSEMEVENT;
105 pTimer->u64NanoInterval = u64NanoInterval;
106 pTimer->u64StartTS = 0;
107
108 int rc = RTSemEventCreate(&pTimer->Event);
109 if (RT_SUCCESS(rc))
110 {
111 rc = RTThreadCreate(&pTimer->Thread, rtTimerThread, pTimer, 0, RTTHREADTYPE_TIMER, RTTHREADFLAGS_WAITABLE, "TIMER");
112 if (RT_SUCCESS(rc))
113 {
114 *ppTimer = pTimer;
115 return VINF_SUCCESS;
116 }
117
118 pTimer->u32Magic = 0;
119 RTSemEventDestroy(pTimer->Event);
120 pTimer->Event = NIL_RTSEMEVENT;
121 }
122 RTMemFree(pTimer);
123
124 return rc;
125}
126
127
128/**
129 * Validates the timer handle.
130 *
131 * @returns true if valid, false if invalid.
132 * @param pTimer The handle.
133 */
134DECLINLINE(bool) rtTimerIsValid(PRTTIMER pTimer)
135{
136 AssertReturn(VALID_PTR(pTimer), false);
137 AssertReturn(pTimer->u32Magic == RTTIMER_MAGIC, false);
138 AssertReturn(!pTimer->fDestroyed, false);
139 return true;
140}
141
142
143RTDECL(int) RTTimerDestroy(PRTTIMER pTimer)
144{
145 /* It's ok to pass NULL pointer. */
146 if (pTimer == /*NIL_RTTIMER*/ NULL)
147 return VINF_SUCCESS;
148 if (!rtTimerIsValid(pTimer))
149 return VERR_INVALID_HANDLE;
150
151 /*
152 * If the timer is active, we just flag it to self destruct on the next tick.
153 * If it's suspended we can safely set the destroy flag and signal it.
154 */
155#ifdef IN_RING3
156 RTTHREAD Thread = pTimer->Thread;
157#endif
158 if (!pTimer->fSuspended)
159 {
160 ASMAtomicXchgU8(&pTimer->fSuspended, true);
161 ASMAtomicXchgU8(&pTimer->fDestroyed, true);
162 }
163 else
164 {
165 ASMAtomicXchgU8(&pTimer->fDestroyed, true);
166 int rc = RTSemEventSignal(pTimer->Event);
167 if (rc == VERR_ALREADY_POSTED)
168 rc = VINF_SUCCESS;
169 AssertRC(rc);
170 }
171
172#ifdef IN_RING3
173 RTThreadWait(Thread, 250, NULL);
174#endif
175 return VINF_SUCCESS;
176}
177
178
179RTDECL(int) RTTimerStart(PRTTIMER pTimer, uint64_t u64First)
180{
181 if (!rtTimerIsValid(pTimer))
182 return VERR_INVALID_HANDLE;
183 if (!pTimer->fSuspended)
184 return VERR_TIMER_ACTIVE;
185
186 /*
187 * Calc when it should start fireing and give the thread a kick so it get going.
188 */
189 u64First += RTTimeNanoTS();
190 ASMAtomicXchgU64(&pTimer->iTick, 0);
191 ASMAtomicXchgU64(&pTimer->iTick, u64First);
192 ASMAtomicXchgU64(&pTimer->u64StartTS, u64First);
193 ASMAtomicXchgU8(&pTimer->fSuspended, false);
194 int rc = RTSemEventSignal(pTimer->Event);
195 if (rc == VERR_ALREADY_POSTED)
196 rc = VINF_SUCCESS;
197 AssertRC(rc);
198 return rc;
199}
200
201
202RTDECL(int) RTTimerStop(PRTTIMER pTimer)
203{
204 if (!rtTimerIsValid(pTimer))
205 return VERR_INVALID_HANDLE;
206 if (pTimer->fSuspended)
207 return VERR_TIMER_SUSPENDED;
208
209 /*
210 * Mark it as suspended and kick the thread.
211 */
212 ASMAtomicXchgU8(&pTimer->fSuspended, true);
213 int rc = RTSemEventSignal(pTimer->Event);
214 if (rc == VERR_ALREADY_POSTED)
215 rc = VINF_SUCCESS;
216 AssertRC(rc);
217 return rc;
218
219}
220
221
222static DECLCALLBACK(int) rtTimerThread(RTTHREAD Thread, void *pvUser)
223{
224 PRTTIMER pTimer = (PRTTIMER)pvUser;
225
226 /*
227 * The loop.
228 */
229 while (!pTimer->fDestroyed)
230 {
231 if (pTimer->fSuspended)
232 {
233 int rc = RTSemEventWait(pTimer->Event, RT_INDEFINITE_WAIT);
234 if (RT_FAILURE(rc) && rc != VERR_INTERRUPTED)
235 {
236 AssertRC(rc);
237 RTThreadSleep(1000); /* Don't cause trouble! */
238 }
239 }
240 else
241 {
242 const uint64_t u64NanoTS = RTTimeNanoTS();
243 if (u64NanoTS >= pTimer->u64NextTS)
244 {
245 pTimer->iTick++;
246 pTimer->pfnTimer(pTimer, pTimer->pvUser);
247
248 /* status changed? */
249 if (pTimer->fSuspended || pTimer->fDestroyed)
250 continue;
251
252 /* one shot? */
253 if (!pTimer->u64NanoInterval)
254 {
255 ASMAtomicXchgU8(&pTimer->fSuspended, true);
256 continue;
257 }
258
259 /* calc the next time we should fire. */
260 pTimer->u64NextTS = pTimer->u64StartTS + pTimer->iTick * pTimer->u64NanoInterval;
261 if (pTimer->u64NextTS < u64NanoTS)
262 pTimer->u64NextTS = u64NanoTS + RTTimerGetSystemGranularity() / 2;
263 }
264
265 /* block. */
266 uint64_t cNanoSeconds = pTimer->u64NextTS - u64NanoTS;
267 int rc = RTSemEventWait(pTimer->Event, cNanoSeconds < 1000000 ? 1 : cNanoSeconds / 1000000);
268 if (RT_FAILURE(rc) && rc != VERR_INTERRUPTED && rc != VERR_TIMEOUT)
269 {
270 AssertRC(rc);
271 RTThreadSleep(1000); /* Don't cause trouble! */
272 }
273 }
274 }
275
276 /*
277 * Release the timer resources.
278 */
279 ASMAtomicIncU32(&pTimer->u32Magic); /* make the handle invalid. */
280 int rc = RTSemEventDestroy(pTimer->Event); AssertRC(rc);
281 pTimer->Event = NIL_RTSEMEVENT;
282 pTimer->Thread = NIL_RTTHREAD;
283 RTMemFree(pTimer);
284
285 return VINF_SUCCESS;
286}
287
288
289
290
291RTDECL(uint32_t) RTTimerGetSystemGranularity(void)
292{
293 return 10000000; /* 10ms */
294}
295
296
297RTDECL(int) RTTimerRequestSystemGranularity(uint32_t u32Request, uint32_t *pu32Granted)
298{
299 return VERR_NOT_SUPPORTED;
300}
301
302
303RTDECL(int) RTTimerReleaseSystemGranularity(uint32_t u32Granted)
304{
305 return VERR_NOT_SUPPORTED;
306}
307
308
Note: See TracBrowser for help on using the repository browser.

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