C:/development/RenderTools/src/interface/Profiler.h

Go to the documentation of this file.

#pragma once

#ifndef PROFILER_H
#define PROFILER_H

#ifdef RT_PROFILER
        
#define MAX_GROUP_PROFILES      5
#define MAX_PASS_PROFILES       120
#define MAX_MODEL_PROFILES      10

#include <string>
#include <vector>
#include <iostream>

#include "Types.h"
#include "Stopwatch.h"

namespace RenderTools {

using namespace std;

#ifdef RT_NVPERFKIT

#define COUNTER_DISABLED        0xFFFFFFFF
#define COUNTER_ENTRY_COUNT 10
#define BUFFER_ENTRY_COUNT      10
#define MAX_COUNTERS            100

class NVDataProvider {
public:

        NVDataProvider();

        void                                    initialise();
        unsigned int                    add( unsigned int counterIndex );
        unsigned int                    add( string name );
        bool                                    sample();
        string                                  name( unsigned int counterIndex );
        float                                   value( unsigned int counterIndex );

        static int                              s_numPasses;

protected:
        unsigned int    m_counterIndexArray[ COUNTER_ENTRY_COUNT ];
        unsigned int    m_counterIndexArrayCount;
    float                       m_counterValues[ COUNTER_ENTRY_COUNT ][ BUFFER_ENTRY_COUNT ];
    unsigned int        m_counterValuesRRIndex;
};

#endif

class Profiler{
public:

        Profiler( string name, string file, int line );
        virtual ~Profiler();

        void            begin();
        void            end();
        double          average();
        double          time();
        int                     calls();
        string          name();
        string          file();
        int                     line();

public:
        static bool                                                             s_init;
        static int                                                              s_objectID;
        static int                                                              s_maxObjects;
        static int                                                              s_numPasses;
        static bool                                                             s_doExperiment;
        static vector< Profiler * >                             s_profilers;
        static vector< pair< UINT, string > >   s_counters;
#ifdef RT_NVPERFKIT
        static NVDataProvider *                                 s_dataProvider;
#endif
        static void shutDown();
        static void dumpAll();

#ifdef RT_NVPERFKIT
        static float _getValue( UINT64 value, UINT64 cycles, string name );
        static void  _initialise( bool doExperiment, int numOfObjects );
        static void  _sample();
        static void  _dumpSample( bool verbose = true );
        static void  _dumpResult( NVPMRESULT result );
#endif

private:
        int                     m_calls;
        Stopwatch       m_stopWatch;
        double          m_time;
        string          m_name;
        string          m_file;
        int                     m_line;

};

#ifdef RT_NVPERFKIT
        #define PROFILER_BEGIN_EXPERIMENT( doExperiment, numOfObjects )\
                Profiler::_initialise( doExperiment, numOfObjects );\
                Profiler::s_numPasses = 1; if( doExperiment ){ NVPMBeginExperiment( &( Profiler::s_numPasses ) ); }else{ Profiler::_sample(); }\
                for( int passCounter = 0; passCounter < Profiler::s_numPasses; passCounter++ ){\
                        if( doExperiment ){ NVPMBeginPass( passCounter ); Profiler::s_objectID = 0; }\

        #define PROFILER_END_EXPERIMENT( verbose )\
                        if( Profiler::s_doExperiment )NVPMEndPass( passCounter ); \
                }\
                if( Profiler::s_doExperiment ){ NVPMEndExperiment(); }\
                Profiler::_sample(); Profiler::_dumpSample( verbose ); 

        #define PROFILER_BEGIN_OBJECT() if( Profiler::s_doExperiment ){ NVPMBeginObject( Profiler::s_objectID++ ); }
        #define PROFILER_END_OBJECT()   if( Profiler::s_doExperiment ){ NVPMEndObject( Profiler::s_objectID - 1 ); }
#else
        #define PROFILER_BEGIN_EXPERIMENT( doExperiment, numOfObjects )
        #define PROFILER_END_EXPERIMENT( verbose )

        #define PROFILER_BEGIN_OBJECT()
        #define PROFILER_END_OBJECT()
#endif // RT_NVPERFKIT

}; // namespace RenderTools

#else // RT_PROFILER

#define PROFILER_BEGIN_EXPERIMENT( doExperiment, numOfObjects )
#define PROFILER_END_EXPERIMENT( verbose )
#define PROFILER_BEGIN_OBJECT()
#define PROFILER_END_OBJECT()

#include <string>
using namespace std;

namespace RenderTools {

// make stubs for (discouraged) use of 'loose' profilers
class Profiler{
public:

        Profiler( string name, string file, int line ){}
        void            begin( void ){}
        void            end( void ){}
        double          average( void ){ return( 0.0 ); }
        string          name( void ){ return( "" ); }
        string          file( void ){ return( "" ); }
        int                     line( void ){ return( 0 ); }

        static void  dumpAll( void ){}
        static void  shutDown( void ){}

#ifdef RT_NVPERFKIT
        static float _getValue( UINT64 value, UINT64 cycles, string name ){}
        static void  _initialise( bool doExperiment, int numOfObjects ){}
        static void  _sample(){}
        static void  _dumpSample( bool verbose = true ){}
#endif
};

}; // namespace

#endif // RT_PROFILER

#endif // PROFILER_H

---