ProcessTimer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Misc/ScopeLock.h"
#include "Common/StatsCollector.h"
 
namespace BuildPatchServices
{
    template<typename FCyclesProvider, bool bThreadSafe = true>
    class TProcessTimer
    {
    public:
        TProcessTimer()
            : ThreadLock()
            , StartCycles(0)
            , Cycles(0)
            , bIsRunning(false)
            , bIsPaused(false)
        {
        }
 
        double GetSeconds()
        {
            if (bThreadSafe)
            {
                ThreadLock.Lock();
            }
            double Seconds = FCyclesProvider::CyclesToSeconds(Cycles);
            if (bIsRunning && !bIsPaused)
            {
                Seconds += FCyclesProvider::CyclesToSeconds(FCyclesProvider::GetCycles() - StartCycles);
            }
            if (bThreadSafe)
            {
                ThreadLock.Unlock();
            }
            return Seconds;
        }
 
        void Start()
        {
            if (bThreadSafe)
            {
                ThreadLock.Lock();
            }
            if (!bIsRunning)
            {
                bIsRunning = true;
                if (!bIsPaused)
                {
                    StartCycles = FCyclesProvider::GetCycles();
                }
            }
            if (bThreadSafe)
            {
                ThreadLock.Unlock();
            }
        }
 
        void Stop()
        {
            if (bThreadSafe)
            {
                ThreadLock.Lock();
            }
            if (bIsRunning)
            {
                bIsRunning = false;
                if (!bIsPaused)
                {
                    Cycles += FCyclesProvider::GetCycles() - StartCycles;
                }
            }
            if (bThreadSafe)
            {
                ThreadLock.Unlock();
            }
        }
 
        void SetPause(bool bPause)
        {
            if (bThreadSafe)
            {
                ThreadLock.Lock();
            }
            if (bIsPaused != bPause)
            {
                bIsPaused = bPause;
                if (bIsPaused)
                {
                    if (bIsRunning)
                    {
                        Cycles += FCyclesProvider::GetCycles() - StartCycles;
                        StartCycles = 0;
                    }
                }
                else
                {
                    if (bIsRunning)
                    {
                        StartCycles = FCyclesProvider::GetCycles();
                    }
                }
            }
            if (bThreadSafe)
            {
                ThreadLock.Unlock();
            }
        }
 
        void Reset()
        {
            if (bThreadSafe)
            {
                ThreadLock.Lock();
            }
            StartCycles = 0;
            Cycles = 0;
            bIsRunning = false;
            bIsPaused = false;
            if (bThreadSafe)
            {
                ThreadLock.Unlock();
            }
        }
 
    private:
        // Thread lock for multi-threaded use.
        FCriticalSection ThreadLock;
        // The cycle count when we started timing.
        uint64 StartCycles;
        // The total accumulated cycles between Start and Stop calls.
        uint64 Cycles;
        // Whether the timer is currently running.
        bool bIsRunning;
        // Whether the timer is in pause state.
        bool bIsPaused;
    };
    typedef TProcessTimer<class FStatsCollector> FProcessTimer;
}