2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * PURPOSE: Window timers messages
5 * FILE: subsystems/win32/win32k/ntuser/timer.c
7 * Thomas Weidenmueller (w3seek@users.sourceforge.net)
8 * Michael Martin (michael.martin@reactos.org)
9 * REVISION HISTORY: 10/04/2003 Implemented System Timers
13 /* INCLUDES ******************************************************************/
20 /* GLOBALS *******************************************************************/
22 static PTIMER FirstpTmr
= NULL
;
23 static LONG TimeLast
= 0;
25 #define MAX_ELAPSE_TIME 0x7FFFFFFF
27 /* Windows 2000 has room for 32768 window-less timers */
28 #define NUM_WINDOW_LESS_TIMERS 32768
30 static FAST_MUTEX Mutex
;
31 static RTL_BITMAP WindowLessTimersBitMap
;
32 static PVOID WindowLessTimersBitMapBuffer
;
33 static ULONG HintIndex
= 1;
37 #define IntLockWindowlessTimerBitmap() \
38 ExEnterCriticalRegionAndAcquireFastMutexUnsafe(&Mutex)
40 #define IntUnlockWindowlessTimerBitmap() \
41 ExReleaseFastMutexUnsafeAndLeaveCriticalRegion(&Mutex)
43 #define TimerEnterExclusive() \
45 KeEnterCriticalRegion(); \
46 ExAcquireResourceExclusiveLite(&TimerLock, TRUE); \
49 #define TimerLeave() \
51 ExReleaseResourceLite(&TimerLock); \
52 KeLeaveCriticalRegion(); \
56 /* FUNCTIONS *****************************************************************/
67 ExInitializeResourceLite(&TimerLock
);
68 FirstpTmr
= UserCreateObject(gHandleTable
, NULL
, &Handle
, otTimer
, sizeof(TIMER
));
71 FirstpTmr
->head
.h
= Handle
;
72 InitializeListHead(&FirstpTmr
->ptmrList
);
78 Ret
= UserCreateObject(gHandleTable
, NULL
, &Handle
, otTimer
, sizeof(TIMER
));
82 InsertTailList(&FirstpTmr
->ptmrList
, &Ret
->ptmrList
);
91 RemoveTimer(PTIMER pTmr
)
96 /* Set the flag, it will be removed when ready */
97 RemoveEntryList(&pTmr
->ptmrList
);
98 if ((pTmr
->pWnd
== NULL
) && (!(pTmr
->flags
& TMRF_SYSTEM
)))
102 IDEvent
= NUM_WINDOW_LESS_TIMERS
- pTmr
->nID
;
103 IntLockWindowlessTimerBitmap();
104 RtlClearBit(&WindowLessTimersBitMap
, IDEvent
);
105 IntUnlockWindowlessTimerBitmap();
107 UserDereferenceObject(pTmr
);
108 Ret
= UserDeleteObject( UserHMGetHandle(pTmr
), otTimer
);
110 if (!Ret
) DPRINT1("Warning: Unable to delete timer\n");
117 FindTimer(PWND Window
,
122 PTIMER pTmr
= FirstpTmr
, RetTmr
= NULL
;
123 TimerEnterExclusive();
128 if ( pTmr
->nID
== nID
&&
129 pTmr
->pWnd
== Window
&&
130 (pTmr
->flags
& (TMRF_SYSTEM
|TMRF_RIT
)) == (flags
& (TMRF_SYSTEM
|TMRF_RIT
)))
136 pLE
= pTmr
->ptmrList
.Flink
;
137 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
138 } while (pTmr
!= FirstpTmr
);
146 FindSystemTimer(PMSG pMsg
)
149 PTIMER pTmr
= FirstpTmr
;
150 TimerEnterExclusive();
155 if ( pMsg
->lParam
== (LPARAM
)pTmr
->pfn
&&
156 (pTmr
->flags
& TMRF_SYSTEM
) )
159 pLE
= pTmr
->ptmrList
.Flink
;
160 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
161 } while (pTmr
!= FirstpTmr
);
169 ValidateTimerCallback(PTHREADINFO pti
,
174 PTIMER pTmr
= FirstpTmr
;
176 if (!pTmr
) return FALSE
;
178 TimerEnterExclusive();
181 if ( (lParam
== (LPARAM
)pTmr
->pfn
) &&
182 !(pTmr
->flags
& (TMRF_SYSTEM
|TMRF_RIT
)) &&
183 (pTmr
->pti
->ppi
== pti
->ppi
) )
188 pLE
= pTmr
->ptmrList
.Flink
;
189 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
190 } while (pTmr
!= FirstpTmr
);
197 IntSetTimer( PWND Window
,
205 LARGE_INTEGER DueTime
;
206 DueTime
.QuadPart
= (LONGLONG
)(-5000000);
209 /* Windows NT/2k/XP behaviour */
210 if (Elapse
> MAX_ELAPSE_TIME
)
212 DPRINT("Adjusting uElapse\n");
216 /* Windows XP SP2 and Windows Server 2003 behaviour */
217 if (Elapse
> MAX_ELAPSE_TIME
)
219 DPRINT("Adjusting uElapse\n");
220 Elapse
= MAX_ELAPSE_TIME
;
224 /* Windows 2k/XP and Windows Server 2003 SP1 behaviour */
227 DPRINT("Adjusting uElapse\n");
231 /* Passing an IDEvent of 0 and the SetTimer returns 1.
232 It will create the timer with an ID of 0 */
233 if ((Window
) && (IDEvent
== 0))
236 pTmr
= FindTimer(Window
, IDEvent
, Type
);
238 if ((!pTmr
) && (Window
== NULL
) && (!(Type
& TMRF_SYSTEM
)))
240 IntLockWindowlessTimerBitmap();
242 IDEvent
= RtlFindClearBitsAndSet(&WindowLessTimersBitMap
, 1, HintIndex
);
244 if (IDEvent
== (UINT_PTR
) -1)
246 IntUnlockWindowlessTimerBitmap();
247 DPRINT1("Unable to find a free window-less timer id\n");
248 SetLastWin32Error(ERROR_NO_SYSTEM_RESOURCES
);
253 IDEvent
= NUM_WINDOW_LESS_TIMERS
- IDEvent
;
256 IntUnlockWindowlessTimerBitmap();
261 pTmr
= CreateTimer();
264 if (Window
&& (Type
& TMRF_TIFROMWND
))
265 pTmr
->pti
= Window
->head
.pti
->pEThread
->Tcb
.Win32Thread
;
269 pTmr
->pti
= ptiRawInput
;
271 pTmr
->pti
= PsGetCurrentThreadWin32Thread();
275 pTmr
->cmsCountdown
= Elapse
;
276 pTmr
->cmsRate
= Elapse
;
277 pTmr
->pfn
= TimerFunc
;
279 pTmr
->flags
= Type
|TMRF_INIT
;
283 pTmr
->cmsCountdown
= Elapse
;
284 pTmr
->cmsRate
= Elapse
;
287 ASSERT(MasterTimer
!= NULL
);
288 // Start the timer thread!
289 if (pTmr
== FirstpTmr
)
290 KeSetTimer(MasterTimer
, DueTime
, NULL
);
296 // Process win32k system timers.
300 SystemTimerProc(HWND hwnd
,
305 DPRINT( "Timer Running!\n" );
312 // Need to start gdi syncro timers then start timer with Hang App proc
313 // that calles Idle process so the screen savers will know to run......
314 IntSetTimer(NULL
, 0, 1000, SystemTimerProc
, TMRF_RIT
);
319 SystemTimerSet( PWND Window
,
322 TIMERPROC lpTimerFunc
)
324 if (Window
&& Window
->head
.pti
->pEThread
->ThreadsProcess
!= PsGetCurrentProcess())
326 SetLastWin32Error(ERROR_ACCESS_DENIED
);
327 DPRINT("SysemTimerSet: Access Denied!\n");
330 return IntSetTimer( Window
, nIDEvent
, uElapse
, lpTimerFunc
, TMRF_SYSTEM
);
335 PostTimerMessages(PWND Window
)
338 PUSER_MESSAGE_QUEUE ThreadQueue
;
342 PTIMER pTmr
= FirstpTmr
;
344 if (!pTmr
) return FALSE
;
346 pti
= PsGetCurrentThreadWin32Thread();
347 ThreadQueue
= pti
->MessageQueue
;
349 TimerEnterExclusive();
353 if ( (pTmr
->flags
& TMRF_READY
) &&
354 (pTmr
->pti
== pti
) &&
355 ((pTmr
->pWnd
== Window
) || (Window
== NULL
)) )
357 Msg
.hwnd
= (pTmr
->pWnd
) ? pTmr
->pWnd
->head
.h
: 0;
358 Msg
.message
= (pTmr
->flags
& TMRF_SYSTEM
) ? WM_SYSTIMER
: WM_TIMER
;
359 Msg
.wParam
= (WPARAM
) pTmr
->nID
;
360 Msg
.lParam
= (LPARAM
) pTmr
->pfn
;
362 MsqPostMessage(ThreadQueue
, &Msg
, FALSE
, QS_TIMER
);
363 pTmr
->flags
&= ~TMRF_READY
;
364 ThreadQueue
->WakeMask
= ~QS_TIMER
;
369 pLE
= pTmr
->ptmrList
.Flink
;
370 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
371 } while (pTmr
!= FirstpTmr
);
382 LARGE_INTEGER TickCount
, DueTime
;
385 PTIMER pTmr
= FirstpTmr
;
390 TimerEnterExclusive();
392 KeQueryTickCount(&TickCount
);
393 Time
= MsqCalculateMessageTime(&TickCount
);
395 DueTime
.QuadPart
= (LONGLONG
)(-500000);
400 if (pTmr
->flags
& TMRF_WAITING
)
402 pLE
= pTmr
->ptmrList
.Flink
;
403 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
407 if (pTmr
->flags
& TMRF_INIT
)
409 pTmr
->flags
&= ~TMRF_INIT
; // Skip this run.
413 if (pTmr
->cmsCountdown
< 0)
416 if ((!(pTmr
->flags
& TMRF_READY
)) && (!(pTmr
->pti
->TIF_flags
& TIF_INCLEANUP
)))
418 if (pTmr
->flags
& TMRF_ONESHOT
)
419 pTmr
->flags
|= TMRF_WAITING
;
421 if (pTmr
->flags
& TMRF_RIT
)
423 // Hard coded call here, inside raw input thread.
424 pTmr
->pfn(NULL
, WM_SYSTIMER
, pTmr
->nID
, (LPARAM
)pTmr
);
428 pTmr
->flags
|= TMRF_READY
; // Set timer ready to be ran.
429 // Set thread message queue for this timer.
430 if (pTmr
->pti
->MessageQueue
)
432 ASSERT(pTmr
->pti
->MessageQueue
->NewMessages
!= NULL
);
433 KeSetEvent(pTmr
->pti
->MessageQueue
->NewMessages
, IO_NO_INCREMENT
, FALSE
);
437 pTmr
->cmsCountdown
= pTmr
->cmsRate
;
440 pTmr
->cmsCountdown
-= Time
- TimeLast
;
443 pLE
= pTmr
->ptmrList
.Flink
;
444 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
445 } while (pTmr
!= FirstpTmr
);
447 // Restart the timer thread!
448 ASSERT(MasterTimer
!= NULL
);
449 KeSetTimer(MasterTimer
, DueTime
, NULL
);
454 DPRINT("TimerCount = %d\n", TimerCount
);
458 DestroyTimersForWindow(PTHREADINFO pti
, PWND Window
)
461 PTIMER pTmr
= FirstpTmr
;
462 BOOL TimersRemoved
= FALSE
;
464 if ((FirstpTmr
== NULL
) || (Window
== NULL
))
467 TimerEnterExclusive();
471 if ((pTmr
) && (pTmr
->pti
== pti
) && (pTmr
->pWnd
== Window
))
473 TimersRemoved
= RemoveTimer(pTmr
);
475 pLE
= pTmr
->ptmrList
.Flink
;
476 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
477 } while (pTmr
!= FirstpTmr
);
481 return TimersRemoved
;
485 DestroyTimersForThread(PTHREADINFO pti
)
488 PTIMER pTmr
= FirstpTmr
;
489 BOOL TimersRemoved
= FALSE
;
491 if (FirstpTmr
== NULL
)
494 TimerEnterExclusive();
498 if ((pTmr
) && (pTmr
->pti
== pti
))
500 TimersRemoved
= RemoveTimer(pTmr
);
502 pLE
= pTmr
->ptmrList
.Flink
;
503 pTmr
= CONTAINING_RECORD(pLE
, TIMER
, ptmrList
);
504 } while (pTmr
!= FirstpTmr
);
508 return TimersRemoved
;
512 IntKillTimer(PWND Window
, UINT_PTR IDEvent
, BOOL SystemTimer
)
515 DPRINT("IntKillTimer Window %x id %p systemtimer %s\n",
516 Window
, IDEvent
, SystemTimer
? "TRUE" : "FALSE");
518 pTmr
= FindTimer(Window
, IDEvent
, SystemTimer
? TMRF_SYSTEM
: 0);
522 TimerEnterExclusive();
527 return pTmr
? TRUE
: FALSE
;
535 ExInitializeFastMutex(&Mutex
);
537 BitmapBytes
= ROUND_UP(NUM_WINDOW_LESS_TIMERS
, sizeof(ULONG
) * 8) / 8;
538 WindowLessTimersBitMapBuffer
= ExAllocatePoolWithTag(NonPagedPool
, BitmapBytes
, TAG_TIMERBMP
);
539 if (WindowLessTimersBitMapBuffer
== NULL
)
541 return STATUS_UNSUCCESSFUL
;
544 RtlInitializeBitMap(&WindowLessTimersBitMap
,
545 WindowLessTimersBitMapBuffer
,
548 /* yes we need this, since ExAllocatePoolWithTag isn't supposed to zero out allocated memory */
549 RtlClearAllBits(&WindowLessTimersBitMap
);
551 return STATUS_SUCCESS
;
561 TIMERPROC lpTimerFunc
565 DECLARE_RETURN(UINT_PTR
);
567 DPRINT("Enter NtUserSetTimer\n");
568 UserEnterExclusive();
569 Window
= UserGetWindowObject(hWnd
);
572 RETURN(IntSetTimer(Window
, nIDEvent
, uElapse
, lpTimerFunc
, TMRF_TIFROMWND
));
575 DPRINT("Leave NtUserSetTimer, ret=%i\n", _ret_
);
590 DECLARE_RETURN(BOOL
);
592 DPRINT("Enter NtUserKillTimer\n");
593 UserEnterExclusive();
594 Window
= UserGetWindowObject(hWnd
);
597 RETURN(IntKillTimer(Window
, uIDEvent
, FALSE
));
600 DPRINT("Leave NtUserKillTimer, ret=%i\n", _ret_
);
607 NtUserSetSystemTimer(
611 TIMERPROC lpTimerFunc
614 DECLARE_RETURN(UINT_PTR
);
616 DPRINT("Enter NtUserSetSystemTimer\n");
618 RETURN(IntSetTimer(UserGetWindowObject(hWnd
), nIDEvent
, uElapse
, NULL
, TMRF_SYSTEM
));
621 DPRINT("Leave NtUserSetSystemTimer, ret=%i\n", _ret_
);