timer.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_TIMER

Macros
#define	TMRF_READY   0x0001
#define	TMRF_SYSTEM   0x0002
#define	TMRF_RIT   0x0004
#define	TMRF_INIT   0x0008
#define	TMRF_ONESHOT   0x0010
#define	TMRF_WAITING   0x0020
#define	TMRF_TIFROMWND   0x0040
#define	ID_EVENT_SYSTIMER_MOUSEHOVER   ID_TME_TIMER
#define	ID_EVENT_SYSTIMER_FLASHWIN   (0xFFF8)
#define	ID_EVENT_SYSTIMER_TRACKWIN   (0xFFF7)
#define	ID_EVENT_SYSTIMER_ANIMATEDFADE   (0xFFF6)
#define	ID_EVENT_SYSTIMER_INVALIDATEDCES   (0xFFF5)

Typedefs
typedef struct _TIMER	TIMER
typedef struct _TIMER *	PTIMER

Functions
INIT_FUNCTION NTSTATUS NTAPI	InitTimerImpl (VOID)
BOOL FASTCALL	DestroyTimersForThread (PTHREADINFO pti)
BOOL FASTCALL	DestroyTimersForWindow (PTHREADINFO pti, PWND Window)
BOOL FASTCALL	IntKillTimer (PWND Window, UINT_PTR IDEvent, BOOL SystemTimer)
UINT_PTR FASTCALL	IntSetTimer (PWND Window, UINT_PTR IDEvent, UINT Elapse, TIMERPROC TimerFunc, INT Type)
PTIMER FASTCALL	FindSystemTimer (PMSG)
BOOL FASTCALL	ValidateTimerCallback (PTHREADINFO, LPARAM)
VOID CALLBACK	SystemTimerProc (HWND, UINT, UINT_PTR, DWORD)
UINT_PTR FASTCALL	SystemTimerSet (PWND, UINT_PTR, UINT, TIMERPROC)
BOOL FASTCALL	PostTimerMessages (PWND)
VOID FASTCALL	ProcessTimers (VOID)
VOID FASTCALL	StartTheTimers (VOID)

Variables
PKTIMER	MasterTimer

Macro Definition Documentation

ID_EVENT_SYSTIMER_ANIMATEDFADE

#define ID_EVENT_SYSTIMER_ANIMATEDFADE   (0xFFF6)

Definition at line 30 of file timer.h.

ID_EVENT_SYSTIMER_FLASHWIN

#define ID_EVENT_SYSTIMER_FLASHWIN   (0xFFF8)

Definition at line 28 of file timer.h.

ID_EVENT_SYSTIMER_INVALIDATEDCES

#define ID_EVENT_SYSTIMER_INVALIDATEDCES   (0xFFF5)

Definition at line 31 of file timer.h.

ID_EVENT_SYSTIMER_MOUSEHOVER

#define ID_EVENT_SYSTIMER_MOUSEHOVER   ID_TME_TIMER

Definition at line 27 of file timer.h.

ID_EVENT_SYSTIMER_TRACKWIN

#define ID_EVENT_SYSTIMER_TRACKWIN   (0xFFF7)

Definition at line 29 of file timer.h.

TMRF_INIT

#define TMRF_INIT   0x0008

Definition at line 22 of file timer.h.

TMRF_ONESHOT

#define TMRF_ONESHOT   0x0010

Definition at line 23 of file timer.h.

TMRF_READY

#define TMRF_READY   0x0001

Definition at line 19 of file timer.h.

TMRF_RIT

#define TMRF_RIT   0x0004

Definition at line 21 of file timer.h.

TMRF_SYSTEM

#define TMRF_SYSTEM   0x0002

Definition at line 20 of file timer.h.

TMRF_TIFROMWND

#define TMRF_TIFROMWND   0x0040

Definition at line 25 of file timer.h.

TMRF_WAITING

#define TMRF_WAITING   0x0020

Definition at line 24 of file timer.h.

Typedef Documentation

PTIMER

typedef struct _TIMER * PTIMER

TIMER

typedef struct _TIMER TIMER

Function Documentation

DestroyTimersForThread()

BOOL FASTCALL DestroyTimersForThread

(

PTHREADINFO

pti

)

Definition at line 549 of file timer.c.

{
   PLIST_ENTRY pLE = TimersListHead.Flink;
   PTIMER pTmr;
   BOOL TimersRemoved = FALSE;

   TimerEnterExclusive();

   while(pLE != &TimersListHead)
   {
      pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);
      pLE = pLE->Flink; /* get next timer list entry before current timer is removed */
      if ((pTmr) && (pTmr->pti == pti))
      {
         TimersRemoved = RemoveTimer(pTmr);
      }
   }

   TimerLeave();

   return TimersRemoved;
}

Referenced by ExitThreadCallback().

DestroyTimersForWindow()

BOOL FASTCALL DestroyTimersForWindow	(	PTHREADINFO	pti,
		PWND	Window
	)

Definition at line 522 of file timer.c.

{
   PLIST_ENTRY pLE;
   PTIMER pTmr;
   BOOL TimersRemoved = FALSE;

   if (Window == NULL)
      return FALSE;

   TimerEnterExclusive();
   pLE = TimersListHead.Flink;
   while(pLE != &TimersListHead)
   {
      pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);
      pLE = pLE->Flink; /* get next timer list entry before current timer is removed */
      if ((pTmr) && (pTmr->pti == pti) && (pTmr->pWnd == Window))
      {
         TimersRemoved = RemoveTimer(pTmr);
      }
   }

   TimerLeave();

   return TimersRemoved;
}

Referenced by co_UserFreeWindow(), and IntClientShutdown().

FindSystemTimer()

PTIMER FASTCALL FindSystemTimer

(

PMSG

)

Definition at line 126 of file timer.c.

{
  PLIST_ENTRY pLE;
  PTIMER pTmr = NULL;

  TimerEnterExclusive();
  pLE = TimersListHead.Flink;
  while (pLE != &TimersListHead)
  {
    pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);

    if ( pMsg->lParam == (LPARAM)pTmr->pfn &&
         (pTmr->flags & TMRF_SYSTEM) )
       break;

    pLE = pLE->Flink;
  }
  TimerLeave();

  return pTmr;
}

Referenced by IntDispatchMessage().

InitTimerImpl()

INIT_FUNCTION NTSTATUS NTAPI InitTimerImpl

(

VOID

)

Definition at line 594 of file timer.c.

{
   ULONG BitmapBytes;

   /* Allocate FAST_MUTEX from non paged pool */
   Mutex = ExAllocatePoolWithTag(NonPagedPool, sizeof(FAST_MUTEX), TAG_INTERNAL_SYNC);
   if (!Mutex)
   {
       return STATUS_INSUFFICIENT_RESOURCES;
   }

   ExInitializeFastMutex(Mutex);

   BitmapBytes = ALIGN_UP_BY(NUM_WINDOW_LESS_TIMERS, sizeof(ULONG) * 8) / 8;
   WindowLessTimersBitMapBuffer = ExAllocatePoolWithTag(NonPagedPool, BitmapBytes, TAG_TIMERBMP);
   if (WindowLessTimersBitMapBuffer == NULL)
   {
      return STATUS_UNSUCCESSFUL;
   }

   RtlInitializeBitMap(&WindowLessTimersBitMap,
                       WindowLessTimersBitMapBuffer,
                       BitmapBytes * 8);

   /* Yes we need this, since ExAllocatePoolWithTag isn't supposed to zero out allocated memory */
   RtlClearAllBits(&WindowLessTimersBitMap);

   ExInitializeResourceLite(&TimerLock);
   InitializeListHead(&TimersListHead);

   return STATUS_SUCCESS;
}

Referenced by DriverEntry().

IntKillTimer()

BOOL FASTCALL IntKillTimer	(	PWND	Window,
		UINT_PTR	IDEvent,
		BOOL	SystemTimer
	)

Definition at line 573 of file timer.c.

{
   PTIMER pTmr = NULL;
   TRACE("IntKillTimer Window %p id %uI systemtimer %s\n",
         Window, IDEvent, SystemTimer ? "TRUE" : "FALSE");

   TimerEnterExclusive();
   pTmr = FindTimer(Window, IDEvent, SystemTimer ? TMRF_SYSTEM : 0);

   if (pTmr)
   {
      RemoveTimer(pTmr);
   }
   TimerLeave();

   return pTmr ? TRUE :  FALSE;
}

Referenced by co_UserHideCaret(), IntFlashWindowEx(), IntRemoveTrackMouseEvent(), IntTrackMouseEvent(), IntTrackMouseMove(), NtUserCallHwndParam(), NtUserCreateCaret(), NtUserKillTimer(), and SystemTimerProc().

IntSetTimer()

UINT_PTR FASTCALL IntSetTimer	(	PWND	Window,
		UINT_PTR	IDEvent,
		UINT	Elapse,
		TIMERPROC	TimerFunc,
		INT	Type
	)

Definition at line 177 of file timer.c.

{
  PTIMER pTmr;
  UINT Ret = IDEvent;
  LARGE_INTEGER DueTime;
  DueTime.QuadPart = (LONGLONG)(-97656); // 1024hz .9765625 ms set to 10.0 ms

#if 0
  /* Windows NT/2k/XP behaviour */
  if (Elapse > USER_TIMER_MAXIMUM)
  {
     TRACE("Adjusting uElapse\n");
     Elapse = 1;
  }
#else
  /* Windows XP SP2 and Windows Server 2003 behaviour */
  if (Elapse > USER_TIMER_MAXIMUM)
  {
     TRACE("Adjusting uElapse\n");
     Elapse = USER_TIMER_MAXIMUM;
  }
#endif

  /* Windows 2k/XP and Windows Server 2003 SP1 behaviour */
  if (Elapse < USER_TIMER_MINIMUM)
  {
     TRACE("Adjusting uElapse\n");
     Elapse = USER_TIMER_MINIMUM; // 1024hz .9765625 ms, set to 10.0 ms (+/-)1 ms
  }

  /* Passing an IDEvent of 0 and the SetTimer returns 1.
     It will create the timer with an ID of 0 */
  if ((Window) && (IDEvent == 0))
     Ret = 1;

  pTmr = FindTimer(Window, IDEvent, Type);

  if ((!pTmr) && (Window == NULL) && (!(Type & TMRF_SYSTEM)))
  {
      IntLockWindowlessTimerBitmap();

      IDEvent = RtlFindClearBitsAndSet(&WindowLessTimersBitMap, 1, HintIndex);

      if (IDEvent == (UINT_PTR) -1)
      {
         IntUnlockWindowlessTimerBitmap();
         ERR("Unable to find a free window-less timer id\n");
         EngSetLastError(ERROR_NO_SYSTEM_RESOURCES);
         ASSERT(FALSE);
         return 0;
      }

      IDEvent = NUM_WINDOW_LESS_TIMERS - IDEvent;
      Ret = IDEvent;

      IntUnlockWindowlessTimerBitmap();
  }

  if (!pTmr)
  {
     pTmr = CreateTimer();
     if (!pTmr) return 0;

     if (Window && (Type & TMRF_TIFROMWND))
        pTmr->pti = Window->head.pti->pEThread->Tcb.Win32Thread;
     else
     {
        if (Type & TMRF_RIT)
           pTmr->pti = ptiRawInput;
        else
           pTmr->pti = PsGetCurrentThreadWin32Thread();
     }

     pTmr->pWnd    = Window;
     pTmr->cmsCountdown = Elapse;
     pTmr->cmsRate = Elapse;
     pTmr->pfn     = TimerFunc;
     pTmr->nID     = IDEvent;
     pTmr->flags   = Type|TMRF_INIT;
  }
  else
  {
     pTmr->cmsCountdown = Elapse;
     pTmr->cmsRate = Elapse;
  }

  ASSERT(MasterTimer != NULL);
  // Start the timer thread!
  if (TimersListHead.Flink == TimersListHead.Blink) // There is only one timer
     KeSetTimer(MasterTimer, DueTime, NULL);

  return Ret;
}

Referenced by co_IntSetCaretPos(), co_UserShowCaret(), IntFlashWindowEx(), IntTrackMouseEvent(), IntTrackMouseMove(), NtUserCreateCaret(), NtUserSetSystemTimer(), NtUserSetTimer(), StartTheTimers(), and SystemTimerSet().

PostTimerMessages()

BOOL FASTCALL PostTimerMessages

(

PWND

)

Definition at line 395 of file timer.c.

{
  PLIST_ENTRY pLE;
  MSG Msg;
  PTHREADINFO pti;
  BOOL Hit = FALSE;
  PTIMER pTmr;

  pti = PsGetCurrentThreadWin32Thread();

  TimerEnterExclusive();
  pLE = TimersListHead.Flink;
  while(pLE != &TimersListHead)
  {
     pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);
     if ( (pTmr->flags & TMRF_READY) &&
          (pTmr->pti == pti) &&
          ((pTmr->pWnd == Window) || (Window == NULL)) )
        {
           Msg.hwnd    = (pTmr->pWnd) ? pTmr->pWnd->head.h : 0;
           Msg.message = (pTmr->flags & TMRF_SYSTEM) ? WM_SYSTIMER : WM_TIMER;
           Msg.wParam  = (WPARAM) pTmr->nID;
           Msg.lParam  = (LPARAM) pTmr->pfn;
           Msg.time    = EngGetTickCount32();
           // Fix all wine win:test_GetMessagePos WM_TIMER tests. See CORE-10867.
           Msg.pt      = gpsi->ptCursor;

           MsqPostMessage(pti, &Msg, FALSE, (QS_POSTMESSAGE|QS_ALLPOSTMESSAGE), 0, 0);
           pTmr->flags &= ~TMRF_READY;
           ClearMsgBitsMask(pti, QS_TIMER);
           Hit = TRUE;
           // Now move this entry to the end of the list so it will not be
           // called again in the next msg loop.
           if (pLE != &TimersListHead)
           {
              RemoveEntryList(&pTmr->ptmrList);
              InsertTailList(&TimersListHead, &pTmr->ptmrList);
           }
           break;
        }

     pLE = pLE->Flink;
  }

  TimerLeave();

  return Hit;
}

Referenced by co_IntPeekMessage().

ProcessTimers()

VOID FASTCALL ProcessTimers

(

VOID

)

Definition at line 446 of file timer.c.

{
  LARGE_INTEGER DueTime;
  LONG Time;
  PLIST_ENTRY pLE;
  PTIMER pTmr;
  LONG TimerCount = 0;

  TimerEnterExclusive();
  pLE = TimersListHead.Flink;
  Time = EngGetTickCount32();

  DueTime.QuadPart = (LONGLONG)(-97656); // 1024hz .9765625 ms set to 10.0 ms

  while(pLE != &TimersListHead)
  {
    pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);
    TimerCount++;
    if (pTmr->flags & TMRF_WAITING)
    {
       pLE = pTmr->ptmrList.Flink;
       pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);
       continue;
    }

    if (pTmr->flags & TMRF_INIT)
    {
       pTmr->flags &= ~TMRF_INIT; // Skip this run.
    }
    else
    {
       if (pTmr->cmsCountdown < 0)
       {
          ASSERT(pTmr->pti);
          if ((!(pTmr->flags & TMRF_READY)) && (!(pTmr->pti->TIF_flags & TIF_INCLEANUP)))
          {
             if (pTmr->flags & TMRF_ONESHOT)
                pTmr->flags |= TMRF_WAITING;

             if (pTmr->flags & TMRF_RIT)
             {
                // Hard coded call here, inside raw input thread.
                pTmr->pfn(NULL, WM_SYSTIMER, pTmr->nID, (LPARAM)pTmr);
             }
             else
             {
                pTmr->flags |= TMRF_READY; // Set timer ready to be ran.
                // Set thread message queue for this timer.
                if (pTmr->pti)
                {  // Wakeup thread
                   pTmr->pti->cTimersReady++;
                   ASSERT(pTmr->pti->pEventQueueServer != NULL);
                   MsqWakeQueue(pTmr->pti, QS_TIMER, TRUE);
                }
             }
          }
          pTmr->cmsCountdown = pTmr->cmsRate;
       }
       else
          pTmr->cmsCountdown -= Time - TimeLast;
    }

    pLE = pLE->Flink;
  }

  // Restart the timer thread!
  ASSERT(MasterTimer != NULL);
  KeSetTimer(MasterTimer, DueTime, NULL);

  TimeLast = Time;

  TimerLeave();
  TRACE("TimerCount = %d\n", TimerCount);
}

Referenced by RawInputThreadMain().

StartTheTimers()

VOID FASTCALL StartTheTimers

(

VOID

)

Definition at line 368 of file timer.c.

{
  // Need to start gdi syncro timers then start timer with Hang App proc
  // that calles Idle process so the screen savers will know to run......
  IntSetTimer(NULL, 0, 1000, HungAppSysTimerProc, TMRF_RIT);
// Test Timers
//  IntSetTimer(NULL, 0, 1000, SystemTimerProc, TMRF_RIT);
}

Referenced by RawInputThreadMain().

SystemTimerProc()

VOID CALLBACK SystemTimerProc	(	HWND	,
		UINT	,
		UINT_PTR	,
		DWORD
	)

Definition at line 280 of file timer.c.

{
  PDESKTOP pDesk;
  PWND pWnd = NULL;

  if (hwnd)
  {
     pWnd = UserGetWindowObject(hwnd);
     if (!pWnd)
     {
        ERR("System Timer Proc has invalid window handle! %p Id: %u\n", hwnd, idEvent);
        return;
     }
  }
  else
  {
     TRACE( "Windowless Timer Running!\n" );
     return;
  }

  switch (idEvent)
  {
/*
   Used in NtUserTrackMouseEvent.
 */
     case ID_EVENT_SYSTIMER_MOUSEHOVER:
       {
          POINT Point;
          UINT Msg;
          WPARAM wParam;

          pDesk = pWnd->head.rpdesk;
          if ( pDesk->dwDTFlags & DF_TME_HOVER &&
               pWnd == pDesk->spwndTrack )
          {
             Point = gpsi->ptCursor;
             if ( RECTL_bPointInRect(&pDesk->rcMouseHover, Point.x, Point.y) )
             {
                if (pDesk->htEx == HTCLIENT) // In a client area.
                {
                   wParam = MsqGetDownKeyState(pWnd->head.pti->MessageQueue);
                   Msg = WM_MOUSEHOVER;

                   if (pWnd->ExStyle & WS_EX_LAYOUTRTL)
                   {
                      Point.x = pWnd->rcClient.right - Point.x - 1;
                   }
                   else
                      Point.x -= pWnd->rcClient.left;
                   Point.y -= pWnd->rcClient.top;
                }
                else
                {
                   wParam = pDesk->htEx; // Need to support all HTXYZ hits.
                   Msg = WM_NCMOUSEHOVER;
                }
                TRACE("Generating WM_NCMOUSEHOVER\n");
                UserPostMessage(hwnd, Msg, wParam, MAKELPARAM(Point.x, Point.y));
                pDesk->dwDTFlags &= ~DF_TME_HOVER;
                break; // Kill this timer.
             }
          }
       }
       return; // Not this window so just return.

     case ID_EVENT_SYSTIMER_FLASHWIN:
       {
          FLASHWINFO fwi =
            {sizeof(FLASHWINFO),
             UserHMGetHandle(pWnd),
             FLASHW_SYSTIMER,0,0};

          IntFlashWindowEx(pWnd, &fwi);
       }
       return;

     default:
       ERR("System Timer Proc invalid id %u!\n", idEvent);
       break;
  }
  IntKillTimer(pWnd, idEvent, TRUE);
}

Referenced by IntFlashWindowEx(), IntTrackMouseEvent(), and IntTrackMouseMove().

SystemTimerSet()

UINT_PTR FASTCALL SystemTimerSet	(	PWND	,
		UINT_PTR	,
		UINT	,
		TIMERPROC
	)

Definition at line 379 of file timer.c.

{
  if (Window && Window->head.pti->pEThread->ThreadsProcess != PsGetCurrentProcess())
  {
     EngSetLastError(ERROR_ACCESS_DENIED);
     TRACE("SysemTimerSet: Access Denied!\n");
     return 0;
  }
  return IntSetTimer( Window, nIDEvent, uElapse, lpTimerFunc, TMRF_SYSTEM);
}

ValidateTimerCallback()

BOOL FASTCALL ValidateTimerCallback	(	PTHREADINFO	,
		LPARAM
	)

Definition at line 150 of file timer.c.

{
  PLIST_ENTRY pLE;
  BOOL Ret = FALSE;
  PTIMER pTmr;

  TimerEnterExclusive();
  pLE = TimersListHead.Flink;
  while (pLE != &TimersListHead)
  {
    pTmr = CONTAINING_RECORD(pLE, TIMER, ptmrList);
    if ( (lParam == (LPARAM)pTmr->pfn) &&
        !(pTmr->flags & (TMRF_SYSTEM|TMRF_RIT)) &&
         (pTmr->pti->ppi == pti->ppi) )
    {
       Ret = TRUE;
       break;
    }
    pLE = pLE->Flink;
  }
  TimerLeave();

  return Ret;
}

Referenced by IntDispatchMessage(), and NtUserValidateTimerCallback().

Variable Documentation

MasterTimer

PKTIMER MasterTimer

Definition at line 16 of file input.c.

Referenced by InitInputImpl(), IntSetTimer(), ProcessTimers(), and RawInputThreadMain().