gzPerformance.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzPerformance.h
// Module       : gzBase
// Description  : Class definition of performance measure functionality
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training System AB, Sweden
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030612  Created file    
//
//******************************************************************************
#ifndef __GZ_PERFORMANCE_H__
#define __GZ_PERFORMANCE_H__

#include "gzBase.h"
#include "gzThread.h"
#include "gzReference.h"

enum gzPerformanceDumpFlags
{   
        GZ_PERF_DUMP_RUNNING                =   (1<<0),
        GZ_PERF_DUMP_STOPPED                =   (1<<1),
        GZ_PERF_DUMP_ACCUMULATED_SECTIONS   =   (1<<2),
        GZ_PERF_DUMP_HIERARCHICAL_SECTIONS  =   (1<<3),
        GZ_PERF_DUMP_ALL                    =   0xFFFFFFFFUL,
};

GZ_USE_BIT_LOGIC(gzPerformanceDumpFlags);
     
//******************************************************************************
// Class    : gzSectionResult
//                                  
// Purpose  : Structure to keep result data of a performance section
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030623  Created 
//                                  
//******************************************************************************
class GZ_BASE_EXPORT gzSectionResult 
{
public:

    gzULong     iterations;             
    gzULong     recursive;              

    gzDouble    execTotTime;            
    gzDouble    execSelfTime;           
    gzDouble    execParentTime;         

    gzDouble    execTotPercentage;      
    gzDouble    execSelfPercentage;     
    gzDouble    execParentPercentage;   

    gzULong     callers;                
};

//******************************************************************************
// Class    : gzSectionInfo
//                                  
// Purpose  : Structure to keep name and thread info of sections
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  050209  Created 
//                                  
//******************************************************************************
class GZ_BASE_EXPORT gzSectionInfo : public gzReference
{
public:

    gzSectionInfo(const gzString &name, gzULong treadID);
    virtual ~gzSectionInfo(){};

    gzString    sectionName;
    gzULong     threadID;
};

GZ_BASE_EXPORT gzVoid gzEnterPerformanceSection(const gzString & sectionName);

GZ_BASE_EXPORT gzVoid gzLeavePerformanceSection();

GZ_BASE_EXPORT gzVoid gzStartPerformanceThread();

GZ_BASE_EXPORT gzVoid gzStopPerformanceThread();

GZ_BASE_EXPORT gzVoid gzEnablePerformanceSections(gzBool on=TRUE);

GZ_BASE_EXPORT gzVoid gzDumpPerformanceInfo(gzPerformanceDumpFlags dumpFlags=GZ_PERF_DUMP_ALL);

GZ_BASE_EXPORT gzString gzCreatePerfLineInfo(const char *file,gzULong line);

GZ_BASE_EXPORT gzSectionResult gzGetSectionResult(const gzString &sectionName,gzULong threadID=gzThread::getThreadID());

GZ_BASE_EXPORT gzVoid gzGetAllPerformanceSections(gzRefList<gzSectionInfo> &perfSecList,gzULong threadID=gzThread::getThreadID());

GZ_BASE_EXPORT gzVoid gzClearPerformanceSection(const gzString &name=GZ_EMPTY_STRING,gzULong threadID=gzThread::getThreadID());


//******************************************************************************
// Class    : gzPerformanceBody
//                                  
// Purpose  : Class to manage section enter/exit code
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030623  Created 
//                                  
//******************************************************************************
class GZ_BASE_EXPORT gzPerformanceBody 
{
public:
    gzPerformanceBody(const gzString &sectionName)
    {
        gzEnterPerformanceSection(sectionName);
    }

    virtual ~gzPerformanceBody()
    { 
        gzLeavePerformanceSection();
    }

private:    // Do not allow copy or assignments

    gzPerformanceBody( const gzPerformanceBody &copy){}

    gzPerformanceBody & operator=(const gzPerformanceBody &copy){ return *this; }
};

//******************************************************************************
// Class    : gzPerformanceMonitorInterface
//                                  
// Purpose  : Interface to external monitor
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030623  Created 
//                                  
//******************************************************************************
class GZ_BASE_EXPORT gzPerformanceMonitorInterface
{
public:

    virtual gzVoid enter(const gzString &monitor)=0;
    virtual gzVoid leave(const gzString &monitor)=0;
    virtual gzVoid addValue(const gzString &monitor,const gzDouble &value,const gzDouble *time)=0;

    static gzVoid setPerformanceMonitor(gzPerformanceMonitorInterface *monitor);
};

GZ_BASE_EXPORT gzVoid gzEnterMonitor(const gzString & monitor);
GZ_BASE_EXPORT gzVoid gzLeaveMonitor(const gzString & monitor);
GZ_BASE_EXPORT gzVoid gzAddMonitorValue(const gzString & monitor,const gzDouble &value,const gzDouble *time=NULL);


//******************************************************************************
// Class    : gzMonitorBody
//                                  
// Purpose  : Class to manage section enter/exit code
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030623  Created 
//                                  
//******************************************************************************
class GZ_BASE_EXPORT gzMonitorBody 
{
public:
    gzMonitorBody(const gzString &monitor):m_name(monitor)
    {
        gzEnterMonitor(monitor);
    }

    virtual ~gzMonitorBody()
    { 
        gzLeaveMonitor(m_name);
    }

private:    // Do not allow copy or assignments

    gzMonitorBody( const gzMonitorBody &copy){}

    gzMonitorBody & operator=(const gzMonitorBody &copy){ return *this; }

    gzString    m_name;
};


#if defined GZ_INSTRUMENT_CODE

    #define GZ_INSTRUMENT_AUTO              gzPerformanceBody   _instrument_(gzCreatePerfLineInfo(__FILE__,__LINE__))
    #define GZ_INSTRUMENT_NAME(x)           gzPerformanceBody   _instrument_(x)
    #define GZ_ENTER_PERFORMANCE_SECTION(x) gzEnterPerformanceSection(x)
    #define GZ_LEAVE_PERFORMANCE_SECTION    gzLeavePerformanceSection()

    #define GZ_MONITOR_AUTO                 gzMonitorBody   _instrument_(gzCreatePerfLineInfo(__FILE__,__LINE__))
    #define GZ_MONITOR_NAME(x)              gzMonitorBody   _instrument_(x)
    #define GZ_ENTER_MONITOR(x)             gzEnterMonitor(x)
    #define GZ_LEAVE_MONITOR(x)             gzLeaveMonitor(x)
    #define GZ_ADD_MONITOR_VALUE(x,y)       gzAddMonitorValue(x,y)

#else

    #define GZ_INSTRUMENT_AUTO  
    #define GZ_INSTRUMENT_NAME(x)   
    #define GZ_ENTER_PERFORMANCE_SECTION(x)
    #define GZ_LEAVE_PERFORMANCE_SECTION    

    #define GZ_MONITOR_AUTO                 
    #define GZ_MONITOR_NAME(x)              
    #define GZ_ENTER_MONITOR(x)             
    #define GZ_LEAVE_MONITOR(x)             
    #define GZ_ADD_MONITOR_VALUE(x,y)       

#endif

#endif // __GZ_PERFORMANCE_H__

---