YiProfileData.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_PROFILE_DATA_H_
#define _YI_PROFILE_DATA_H_

#include "framework/YiPredef.h"
#include "utility/YiString.h"

#include <glm/gtc/constants.hpp>
#include <glm/gtc/epsilon.hpp>


// Hold on to the last 'n' values 
// Useful when real values need to be analyzed on top
// min / max / avg
static const uint32_t gHistoryLen = 1000;

class CYIProfileData
{
public:

    enum ACCURACY {
        SECONDS,
        MILLISECONDS,
        MICROSECONDS
    };

    class Average
    {
    public:
        Average();
        Average(uint32_t uWindow);
        ~Average();

        void Init(uint32_t uWindow);

        void Add(uint64_t uData);

        float Avg() const;

    private:
        uint64_t m_uTotal;
        uint32_t m_uWindow;

        uint64_t *m_pDataN; // Data of N entries where matches
            // the window size
        uint32_t m_uDataCnt;
        uint32_t m_uWriteIdx;

        bool    m_bIsFirstDataSkipped;

        YI_DISALLOW_COPY_AND_ASSIGN(Average)
    };

    CYIProfileData();

    void Reset();
    void Init(const CYIString &name);
    void ConfigureAvgWindow(uint32_t uWindow);

    // Data Collection APIs:
    /* 
      Either use MarkBegin() - MarkEnd() to mark 
      the beginning and end of an activity and let the PerfTimer
      do the calculation, or simply pass a delta that you have calculated
      with MarkDelta().
    */
    void MarkBegin();
    void MarkEnd();
    void MarkDelta(uint64_t uDelta);

    // Reporting APIs:
    uint64_t Min() const;
    uint64_t Max() const;
    float Avg() const;
    uint64_t Total() const;
    uint64_t GetLastSample() const;
    uint32_t GetSampleCnt() const;

    /* Creates a single line summary of collected statistics 
       reported in millisecond accuracy. Regular APIs report 
       results in microsecond accuracy.
     */
    CYIString Report(ACCURACY eAccuracy = MILLISECONDS) const;

    /* Creates a single line summary of collected statistics 
       reported in millisecond accuracy. Regular APIs report 
       results in microsecond accuracy. The format is XML as follows:
       <profile name=...>
            <min>...</min>
            <max>...</max>
            <avg>...</avg>
            <fps>...</fps>
       </profile>
     */
    CYIString ReportXML(ACCURACY eAccuracy = MILLISECONDS) const;

    // This is the time spent between the end of cycle and the
    // beginning of the other cycle.
    float AvgDutyCycle() const;
    float AvgPeriod() const;
    float CalculateFPS() const;

private:
    uint64_t m_uHistory[gHistoryLen];
    uint32_t m_uWriteIdx;
    uint32_t m_uDataSampleCnt;

    uint64_t m_uBeginTime;
    uint64_t m_uDelta;

    uint64_t m_uDataTotal;
    uint64_t m_uMin;
    uint64_t m_uMax;

    Average   m_nAvgSample;
    Average   m_nAvgPeriod;

    bool   m_bProfiling;

    CYIString m_Name;
};

inline uint64_t CYIProfileData::Min() const
{
    return (m_uDataSampleCnt > 1) ? m_uMin : 0;
}

inline uint64_t CYIProfileData::Max() const
{
    return (m_uDataSampleCnt > 1) ? m_uMax : 0;
}

inline float CYIProfileData::Avg() const
{
    return (m_uDataSampleCnt > 1) ? m_nAvgSample.Avg() : 0.0f;
}

inline uint64_t CYIProfileData::Total() const
{
    return (m_uDataSampleCnt > 1) ? m_uDataTotal : 0;
}

inline uint64_t CYIProfileData::GetLastSample() const
{
    return m_uDelta;
}
inline uint32_t CYIProfileData::GetSampleCnt() const
{
    return (m_uDataSampleCnt > 1) ? (m_uDataSampleCnt-1) : 0;
}

inline float CYIProfileData::AvgDutyCycle() const
{
    float period = m_nAvgPeriod.Avg();

    return (!glm::epsilonEqual(period, 0.0f, glm::epsilon<float>())) ? Avg() * 100 / period : 0;
}
inline float CYIProfileData::AvgPeriod() const
{
    return (float)m_nAvgPeriod.Avg();
}

#endif // _YI_PROFILE_DATA_H_