timer-win.cpp@ 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 `Id`
File size: 14.6 KB

Line
1	/* $Id: timer-win.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2	/** @file
3	* IPRT - Timer.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27
28	/* Which code to use is determined here...
29	*
30	* The default is to use wait on NT timers directly with no APC since this
31	* is supposed to give the shortest kernel code paths.
32	*
33	* The USE_APC variation will do as above except that an APC routine is
34	* handling the callback action.
35	*
36	* The USE_WINMM version will use the NT timer wrappers in WinMM which may
37	* result in some 0.1% better correctness in number of delivered ticks. However,
38	* this codepath have more overhead (it uses APC among other things), and I'm not
39	* quite sure if it's actually any more correct.
40	*
41	* The USE_CATCH_UP will play catch up when the timer lags behind. However this
42	* requires a monotonous time source.
43	*
44	* The default mode which we are using is using relative periods of time and thus
45	* will never suffer from errors in the time source. Neither will it try catch up
46	* missed ticks. This suits our current purposes best I'd say.
47	*/
48	#undef USE_APC
49	#undef USE_WINMM
50	#undef USE_CATCH_UP
51
52
53	/*******************************************************************************
54	* Header Files *
55	*******************************************************************************/
56	#define LOG_GROUP RTLOGGROUP_TIMER
57	#define _WIN32_WINNT 0x0500
58	#include <Windows.h>
59
60	#include <iprt/timer.h>
61	#ifdef USE_CATCH_UP
62	# include <iprt/time.h>
63	#endif
64	#include <iprt/alloc.h>
65	#include <iprt/assert.h>
66	#include <iprt/thread.h>
67	#include <iprt/log.h>
68	#include <iprt/asm.h>
69	#include <iprt/semaphore.h>
70	#include <iprt/err.h>
71	#include "internal/magics.h"
72
73	RT_C_DECLS_BEGIN
74	/* from sysinternals. */
75	NTSYSAPI LONG NTAPI NtSetTimerResolution(IN ULONG DesiredResolution, IN BOOLEAN SetResolution, OUT PULONG CurrentResolution);
76	NTSYSAPI LONG NTAPI NtQueryTimerResolution(OUT PULONG MaximumResolution, OUT PULONG MinimumResolution, OUT PULONG CurrentResolution);
77	RT_C_DECLS_END
78
79
80	/*******************************************************************************
81	* Structures and Typedefs *
82	*******************************************************************************/
83	/**
84	* The internal representation of a timer handle.
85	*/
86	typedef struct RTTIMER
87	{
88	/** Magic.
89	* This is RTTIMER_MAGIC, but changes to something else before the timer
90	* is destroyed to indicate clearly that thread should exit. */
91	volatile uint32_t u32Magic;
92	/** User argument. */
93	void *pvUser;
94	/** Callback. */
95	PFNRTTIMER pfnTimer;
96	/** The current tick. */
97	uint64_t iTick;
98	/** The interval. */
99	unsigned uMilliesInterval;
100	#ifdef USE_WINMM
101	/** Win32 timer id. */
102	UINT TimerId;
103	#else
104	/** Time handle. */
105	HANDLE hTimer;
106	# ifdef USE_APC
107	/** Handle to wait on. */
108	HANDLE hevWait;
109	# endif
110	/** USE_CATCH_UP: ns time of the next tick.
111	* !USE_CATCH_UP: -uMilliesInterval * 10000 */
112	LARGE_INTEGER llNext;
113	/** The thread handle of the timer thread. */
114	RTTHREAD Thread;
115	/** The error/status of the timer.
116	* Initially -1, set to 0 when the timer have been successfully started, and
117	* to errno on failure in starting the timer. */
118	volatile int iError;
119	#endif
120	} RTTIMER;
121
122
123
124	#ifdef USE_WINMM
125	/**
126	* Win32 callback wrapper.
127	*/
128	static void CALLBACK rttimerCallback(UINT uTimerID, UINT uMsg, DWORD_PTR dwUser, DWORD_PTR dw1, DWORD_PTR dw2)
129	{
130	PRTTIMER pTimer = (PRTTIMER)(void *)dwUser;
131	Assert(pTimer->TimerId == uTimerID);
132	pTimer->pfnTimer(pTimer, pTimer->pvUser, ++pTimer->iTick);
133	NOREF(uMsg); NOREF(dw1); NOREF(dw2); NOREF(uTimerID);
134	}
135	#else /* !USE_WINMM */
136
137	#ifdef USE_APC
138	/**
139	* Async callback.
140	*
141	* @param lpArgToCompletionRoutine Pointer to our timer structure.
142	*/
143	VOID CALLBACK rttimerAPCProc(LPVOID lpArgToCompletionRoutine, DWORD dwTimerLowValue, DWORD dwTimerHighValue)
144	{
145	PRTTIMER pTimer = (PRTTIMER)lpArgToCompletionRoutine;
146
147	/*
148	* Check if we're begin destroyed.
149	*/
150	if (pTimer->u32Magic != RTTIMER_MAGIC)
151	return;
152
153	/*
154	* Callback the handler.
155	*/
156	pTimer->pfnTimer(pTimer, pTimer->pvUser, ++pTimer->iTick);
157
158	/*
159	* Rearm the timer handler.
160	*/
161	#ifdef USE_CATCH_UP
162	pTimer->llNext.QuadPart += (int64_t)pTimer->uMilliesInterval * 10000;
163	LARGE_INTEGER ll;
164	ll.QuadPart = RTTimeNanoTS() - pTimer->llNext.QuadPart;
165	if (ll.QuadPart < -500000)
166	ll.QuadPart = ll.QuadPart / 100;
167	else
168	ll.QuadPart = -500000 / 100; /* need to catch up, do a minimum wait of 0.5ms. */
169	#else
170	LARGE_INTEGER ll = pTimer->llNext;
171	#endif
172	BOOL frc = SetWaitableTimer(pTimer->hTimer, &ll, 0, rttimerAPCProc, pTimer, FALSE);
173	AssertMsg(frc \|\| pTimer->u32Magic != RTTIMER_MAGIC, ("last error %d\n", GetLastError()));
174	}
175	#endif /* USE_APC */
176
177	/**
178	* Timer thread.
179	*/
180	static DECLCALLBACK(int) rttimerCallback(RTTHREAD Thread, void *pvArg)
181	{
182	PRTTIMER pTimer = (PRTTIMER)(void *)pvArg;
183	Assert(pTimer->u32Magic == RTTIMER_MAGIC);
184
185	/*
186	* Bounce our priority up quite a bit.
187	*/
188	if ( !SetThreadPriority(GetCurrentThread(), THREAD_PRIORITY_TIME_CRITICAL)
189	/&& !SetThreadPriority(GetCurrentThread(), THREAD_PRIORITY_HIGHEST)/)
190	{
191	int rc = GetLastError();
192	AssertMsgFailed(("Failed to set priority class lasterror %d.\n", rc));
193	pTimer->iError = RTErrConvertFromWin32(rc);
194	return rc;
195	}
196
197	/*
198	* Start the waitable timer.
199	*/
200
201	#ifdef USE_CATCH_UP
202	const int64_t NSInterval = (int64_t)pTimer->uMilliesInterval * 1000000;
203	pTimer->llNext.QuadPart = RTTimeNanoTS() + NSInterval;
204	#else
205	pTimer->llNext.QuadPart = -(int64_t)pTimer->uMilliesInterval * 10000;
206	#endif
207	LARGE_INTEGER ll;
208	ll.QuadPart = -(int64_t)pTimer->uMilliesInterval * 10000;
209	#ifdef USE_APC
210	if (!SetWaitableTimer(pTimer->hTimer, &ll, 0, rttimerAPCProc, pTimer, FALSE))
211	#else
212	if (!SetWaitableTimer(pTimer->hTimer, &ll, 0, NULL, NULL, FALSE))
213	#endif
214	{
215	int rc = GetLastError();
216	AssertMsgFailed(("Failed to set timer, lasterr %d.\n", rc));
217	pTimer->iError = RTErrConvertFromWin32(rc);
218	RTThreadUserSignal(Thread);
219	return rc;
220	}
221
222	/*
223	* Wait for the semaphore to be posted.
224	*/
225	RTThreadUserSignal(Thread);
226	for (;pTimer->u32Magic == RTTIMER_MAGIC;)
227	{
228	#ifdef USE_APC
229	int rc = WaitForSingleObjectEx(pTimer->hevWait, INFINITE, TRUE);
230	if (rc != WAIT_OBJECT_0 && rc != WAIT_IO_COMPLETION)
231	#else
232	int rc = WaitForSingleObjectEx(pTimer->hTimer, INFINITE, FALSE);
233	if (pTimer->u32Magic != RTTIMER_MAGIC)
234	break;
235	if (rc == WAIT_OBJECT_0)
236	{
237	/*
238	* Callback the handler.
239	*/
240	pTimer->pfnTimer(pTimer, pTimer->pvUser, ++pTimer->iTick);
241
242	/*
243	* Rearm the timer handler.
244	*/
245	#ifdef USE_CATCH_UP
246	pTimer->llNext.QuadPart += NSInterval;
247	LARGE_INTEGER ll;
248	ll.QuadPart = RTTimeNanoTS() - pTimer->llNext.QuadPart;
249	if (ll.QuadPart < -500000)
250	ll.QuadPart = ll.QuadPart / 100;
251	else
252	ll.QuadPart = -500000 / 100; /* need to catch up, do a minimum wait of 0.5ms. */
253	#else
254	LARGE_INTEGER ll = pTimer->llNext;
255	#endif
256	BOOL frc = SetWaitableTimer(pTimer->hTimer, &ll, 0, NULL, NULL, FALSE);
257	AssertMsg(frc \|\| pTimer->u32Magic != RTTIMER_MAGIC, ("last error %d\n", GetLastError()));
258	}
259	else
260	#endif
261	{
262	/*
263	* We failed during wait, so just signal the destructor and exit.
264	*/
265	int rc2 = GetLastError();
266	RTThreadUserSignal(Thread);
267	AssertMsgFailed(("Wait on hTimer failed, rc=%d lasterr=%d\n", rc, rc2));
268	return -1;
269	}
270	}
271
272	/*
273	* Exit.
274	*/
275	RTThreadUserSignal(Thread);
276	return 0;
277	}
278	#endif /* !USE_WINMM */
279
280
281	RTDECL(int) RTTimerCreate(PRTTIMER ppTimer, unsigned uMilliesInterval, PFNRTTIMER pfnTimer, void pvUser)
282	{
283	#ifndef USE_WINMM
284	/*
285	* On windows we'll have to set the timer resolution before
286	* we start the timer.
287	*/
288	ULONG ulMax = ~0;
289	ULONG ulMin = ~0;
290	ULONG ulCur = ~0;
291	NtQueryTimerResolution(&ulMax, &ulMin, &ulCur);
292	Log(("NtQueryTimerResolution -> ulMax=%lu00ns ulMin=%lu00ns ulCur=%lu00ns\n", ulMax, ulMin, ulCur));
293	if (ulCur > ulMin && ulCur > 10000 /* = 1ms */)
294	{
295	if (NtSetTimerResolution(10000, TRUE, &ulCur) >= 0)
296	Log(("Changed timer resolution to 1ms.\n"));
297	else if (NtSetTimerResolution(20000, TRUE, &ulCur) >= 0)
298	Log(("Changed timer resolution to 2ms.\n"));
299	else if (NtSetTimerResolution(40000, TRUE, &ulCur) >= 0)
300	Log(("Changed timer resolution to 4ms.\n"));
301	else if (ulMin <= 50000 && NtSetTimerResolution(ulMin, TRUE, &ulCur) >= 0)
302	Log(("Changed timer resolution to %lu *100ns.\n", ulMin));
303	else
304	{
305	AssertMsgFailed(("Failed to configure timer resolution!\n"));
306	return VERR_INTERNAL_ERROR;
307	}
308	}
309	#endif /* !USE_WINN */
310
311	/*
312	* Create new timer.
313	*/
314	int rc;
315	PRTTIMER pTimer = (PRTTIMER)RTMemAlloc(sizeof(*pTimer));
316	if (pTimer)
317	{
318	pTimer->u32Magic = RTTIMER_MAGIC;
319	pTimer->pvUser = pvUser;
320	pTimer->pfnTimer = pfnTimer;
321	pTimer->iTick = 0;
322	pTimer->uMilliesInterval = uMilliesInterval;
323	#ifdef USE_WINMM
324	/* sync kill doesn't work. */
325	pTimer->TimerId = timeSetEvent(uMilliesInterval, 0, rttimerCallback, (DWORD_PTR)pTimer, TIME_PERIODIC \| TIME_CALLBACK_FUNCTION);
326	if (pTimer->TimerId)
327	{
328	ULONG ulMax = ~0;
329	ULONG ulMin = ~0;
330	ULONG ulCur = ~0;
331	NtQueryTimerResolution(&ulMax, &ulMin, &ulCur);
332	Log(("NtQueryTimerResolution -> ulMax=%lu00ns ulMin=%lu00ns ulCur=%lu00ns\n", ulMax, ulMin, ulCur));
333
334	*ppTimer = pTimer;
335	return VINF_SUCCESS;
336	}
337	rc = VERR_INVALID_PARAMETER;
338
339	#else /* !USE_WINMM */
340
341	/*
342	* Create Win32 event semaphore.
343	*/
344	pTimer->iError = 0;
345	pTimer->hTimer = CreateWaitableTimer(NULL, TRUE, NULL);
346	if (pTimer->hTimer)
347	{
348	#ifdef USE_APC
349	/*
350	* Create wait semaphore.
351	*/
352	pTimer->hevWait = CreateEvent(NULL, FALSE, FALSE, NULL);
353	if (pTimer->hevWait)
354	#endif
355	{
356	/*
357	* Kick off the timer thread.
358	*/
359	rc = RTThreadCreate(&pTimer->Thread, rttimerCallback, pTimer, 0, RTTHREADTYPE_TIMER, RTTHREADFLAGS_WAITABLE, "Timer");
360	if (RT_SUCCESS(rc))
361	{
362	/*
363	* Wait for the timer to successfully create the timer
364	* If we don't get a response in 10 secs, then we assume we're screwed.
365	*/
366	rc = RTThreadUserWait(pTimer->Thread, 10000);
367	if (RT_SUCCESS(rc))
368	{
369	rc = pTimer->iError;
370	if (RT_SUCCESS(rc))
371	{
372	*ppTimer = pTimer;
373	return VINF_SUCCESS;
374	}
375	}
376	ASMAtomicXchgU32(&pTimer->u32Magic, RTTIMER_MAGIC + 1);
377	RTThreadWait(pTimer->Thread, 250, NULL);
378	CancelWaitableTimer(pTimer->hTimer);
379	}
380	#ifdef USE_APC
381	CloseHandle(pTimer->hevWait);
382	#endif
383	}
384	CloseHandle(pTimer->hTimer);
385	}
386	#endif /* !USE_WINMM */
387
388	AssertMsgFailed(("Failed to create timer uMilliesInterval=%d. rc=%d\n", uMilliesInterval, rc));
389	RTMemFree(pTimer);
390	}
391	else
392	rc = VERR_NO_MEMORY;
393	return rc;
394	}
395
396
397	RTR3DECL(int) RTTimerDestroy(PRTTIMER pTimer)
398	{
399	/* NULL is ok. */
400	if (!pTimer)
401	return VINF_SUCCESS;
402
403	/*
404	* Validate handle first.
405	*/
406	int rc;
407	if ( VALID_PTR(pTimer)
408	&& pTimer->u32Magic == RTTIMER_MAGIC)
409	{
410	#ifdef USE_WINMM
411	/*
412	* Kill the timer and exit.
413	*/
414	rc = timeKillEvent(pTimer->TimerId);
415	AssertMsg(rc == TIMERR_NOERROR, ("timeKillEvent -> %d\n", rc));
416	ASMAtomicXchgU32(&pTimer->u32Magic, RTTIMER_MAGIC + 1);
417	RTThreadSleep(1);
418
419	#else /* !USE_WINMM */
420
421	/*
422	* Signal that we want the thread to exit.
423	*/
424	ASMAtomicXchgU32(&pTimer->u32Magic, RTTIMER_MAGIC + 1);
425	#ifdef USE_APC
426	SetEvent(pTimer->hevWait);
427	CloseHandle(pTimer->hevWait);
428	rc = CancelWaitableTimer(pTimer->hTimer);
429	AssertMsg(rc, ("CancelWaitableTimer lasterr=%d\n", GetLastError()));
430	#else
431	LARGE_INTEGER ll = {0};
432	ll.LowPart = 100;
433	rc = SetWaitableTimer(pTimer->hTimer, &ll, 0, NULL, NULL, FALSE);
434	AssertMsg(rc, ("CancelWaitableTimer lasterr=%d\n", GetLastError()));
435	#endif
436
437	/*
438	* Wait for the thread to exit.
439	* And if it don't wanna exit, we'll get kill it.
440	*/
441	rc = RTThreadWait(pTimer->Thread, 1000, NULL);
442	if (RT_FAILURE(rc))
443	TerminateThread((HANDLE)RTThreadGetNative(pTimer->Thread), -1);
444
445	/*
446	* Free resource.
447	*/
448	rc = CloseHandle(pTimer->hTimer);
449	AssertMsg(rc, ("CloseHandle lasterr=%d\n", GetLastError()));
450
451	#endif /* !USE_WINMM */
452	RTMemFree(pTimer);
453	return rc;
454	}
455
456	rc = VERR_INVALID_HANDLE;
457	AssertMsgFailed(("Failed to destroy timer %p. rc=%d\n", pTimer, rc));
458	return rc;
459	}
460

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Runtime/r3/win/timer-win.cpp@ 28800

Download in other formats: