nuclear@3: /************************************************************************************
nuclear@3: 
nuclear@3: Filename    :   OVR_Timer.cpp
nuclear@3: Content     :   Provides static functions for precise timing
nuclear@3: Created     :   September 19, 2012
nuclear@3: Notes       : 
nuclear@3: 
nuclear@3: Copyright   :   Copyright 2012 Oculus VR, Inc. All Rights reserved.
nuclear@3: 
nuclear@3: Use of this software is subject to the terms of the Oculus license
nuclear@3: agreement provided at the time of installation or download, or which
nuclear@3: otherwise accompanies this software in either electronic or hard copy form.
nuclear@3: 
nuclear@3: ************************************************************************************/
nuclear@3: 
nuclear@3: #include "OVR_Timer.h"
nuclear@3: 
nuclear@3: #if defined (OVR_OS_WIN32)
nuclear@3: #include <windows.h>
nuclear@3: 
nuclear@3: #else
nuclear@3: #include <sys/time.h>
nuclear@3: #endif
nuclear@3: 
nuclear@3: namespace OVR {
nuclear@3: 
nuclear@3: //-----------------------------------------------------------------------------------
nuclear@3: // ***** Timer Class
nuclear@3: 
nuclear@3: UInt64 Timer::GetProfileTicks()
nuclear@3: {
nuclear@3:     return (GetRawTicks() * MksPerSecond) / GetRawFrequency();
nuclear@3: }
nuclear@3: double Timer::GetProfileSeconds()
nuclear@3: {
nuclear@3:     static UInt64 StartTime = GetProfileTicks();
nuclear@3:     return TicksToSeconds(GetProfileTicks()-StartTime);
nuclear@3: }
nuclear@3: 
nuclear@3: 
nuclear@3: //------------------------------------------------------------------------
nuclear@3: // *** Win32 Specific Timer
nuclear@3: 
nuclear@3: #if (defined (OVR_OS_WIN32))
nuclear@3: 
nuclear@3: CRITICAL_SECTION WinAPI_GetTimeCS;
nuclear@3: volatile UInt32  WinAPI_OldTime = 0;
nuclear@3: volatile UInt32  WinAPI_WrapCounter = 0;
nuclear@3: 
nuclear@3: 
nuclear@3: UInt32 Timer::GetTicksMs()
nuclear@3: {
nuclear@3:     return timeGetTime();
nuclear@3: }
nuclear@3: 
nuclear@3: UInt64 Timer::GetTicks()
nuclear@3: {
nuclear@3:     DWORD  ticks = timeGetTime();
nuclear@3:     UInt64 result;
nuclear@3: 
nuclear@3:     // On Win32 QueryPerformanceFrequency is unreliable due to SMP and
nuclear@3:     // performance levels, so use this logic to detect wrapping and track
nuclear@3:     // high bits.
nuclear@3:     ::EnterCriticalSection(&WinAPI_GetTimeCS);
nuclear@3: 
nuclear@3:     if (WinAPI_OldTime > ticks)
nuclear@3:         WinAPI_WrapCounter++;
nuclear@3:     WinAPI_OldTime = ticks;
nuclear@3: 
nuclear@3:     result = (UInt64(WinAPI_WrapCounter) << 32) | ticks;
nuclear@3:     ::LeaveCriticalSection(&WinAPI_GetTimeCS);
nuclear@3: 
nuclear@3:     return result * MksPerMs;
nuclear@3: }
nuclear@3: 
nuclear@3: UInt64 Timer::GetRawTicks()
nuclear@3: {
nuclear@3:     LARGE_INTEGER li;
nuclear@3:     QueryPerformanceCounter(&li);
nuclear@3:     return li.QuadPart;
nuclear@3: }
nuclear@3: 
nuclear@3: UInt64 Timer::GetRawFrequency()
nuclear@3: {
nuclear@3:     static UInt64 perfFreq = 0;
nuclear@3:     if (perfFreq == 0)
nuclear@3:     {
nuclear@3:         LARGE_INTEGER freq;
nuclear@3:         QueryPerformanceFrequency(&freq);
nuclear@3:         perfFreq = freq.QuadPart;
nuclear@3:     }
nuclear@3:     return perfFreq;
nuclear@3: }
nuclear@3: 
nuclear@3: void Timer::initializeTimerSystem()
nuclear@3: {
nuclear@3:     timeBeginPeriod(1);
nuclear@3:     InitializeCriticalSection(&WinAPI_GetTimeCS);
nuclear@3: 
nuclear@3: }
nuclear@3: void Timer::shutdownTimerSystem()
nuclear@3: {
nuclear@3:     DeleteCriticalSection(&WinAPI_GetTimeCS);
nuclear@3:     timeEndPeriod(1);
nuclear@3: }
nuclear@3: 
nuclear@3: #else   // !OVR_OS_WIN32
nuclear@3: 
nuclear@3: 
nuclear@3: //------------------------------------------------------------------------
nuclear@3: // *** Standard OS Timer     
nuclear@3: 
nuclear@3: UInt32 Timer::GetTicksMs()
nuclear@3: {
nuclear@3:     return (UInt32)(GetProfileTicks() / 1000);
nuclear@3: }
nuclear@3: // The profile ticks implementation is just fine for a normal timer.
nuclear@3: UInt64 Timer::GetTicks()
nuclear@3: {
nuclear@3:     return GetProfileTicks();
nuclear@3: }
nuclear@3: 
nuclear@3: void Timer::initializeTimerSystem()
nuclear@3: {
nuclear@3: }
nuclear@3: void Timer::shutdownTimerSystem()
nuclear@3: {
nuclear@3: }
nuclear@3: 
nuclear@3: UInt64  Timer::GetRawTicks()
nuclear@3: {
nuclear@3:     // TODO: prefer rdtsc when available?
nuclear@3: 
nuclear@3:     // Return microseconds.
nuclear@3:     struct timeval tv;
nuclear@3:     UInt64 result;
nuclear@3: 
nuclear@3:     gettimeofday(&tv, 0);
nuclear@3: 
nuclear@3:     result = (UInt64)tv.tv_sec * 1000000;
nuclear@3:     result += tv.tv_usec;
nuclear@3: 
nuclear@3:     return result;
nuclear@3: }
nuclear@3: 
nuclear@3: UInt64 Timer::GetRawFrequency()
nuclear@3: {
nuclear@3:     return MksPerSecond;
nuclear@3: }
nuclear@3: 
nuclear@3: #endif  // !OVR_OS_WIN32
nuclear@3: 
nuclear@3: 
nuclear@3: 
nuclear@3: } // OVR
nuclear@3: