StackTimer.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLUtils/src/ICLUtils/StackTimer.h                     **
** Module : ICLUtils                                               **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/Macros.h>
#include <ICLUtils/Timer.h>
#include <string>
#include <cstdio>

namespace icl{
  namespace utils{

    class StackTimer{
    public:
      class StackTimerNotifier{
        public:
        StackTimerNotifier(const char* functionname, 
                           bool writeCounts=true, 
                           bool writeAvg=true,
                           bool writeMin=true,
                           bool writeMax=true){
          m_bWriteCounts = writeCounts;
          m_bWriteAvg = writeAvg;
          m_bWriteMin = writeMin;
          m_bWriteMax = writeMax;
          m_liCount = 0;
          m_liTime = 0;
          m_sFunctionName = functionname;
          m_liMaxTime = 0;
          m_liMinTime = 2<<29;
        }
        std::string getTimeStr(long int l){
          static char acBuf[100];
          if(l>1000000){
            sprintf(acBuf,"%3ld.%1ld  s",l/1000000,l/100000-10*(l/1000000));
          }else if(l>1000){
            sprintf(acBuf,"%3ld.%1ld ms",l/1000,l/100-10*(l/1000));
          }else{
            sprintf(acBuf,"  %3ld ns",l);
          }
          return std::string(acBuf);
        }
        ~StackTimerNotifier(){
          if(m_bWriteCounts){
            printf("calls[%8ld]  ",m_liCount);
          }
          printf("time[%s]  ",getTimeStr(m_liTime).c_str());
          if(m_bWriteAvg){
            printf("avg[%s]  ",getTimeStr(m_liTime/m_liCount).c_str());
          }
          if(m_bWriteMin){
            printf("min[%s]  ",getTimeStr(m_liMinTime).c_str());
          } 
          if(m_bWriteMax){
            printf("max[%s]  ",getTimeStr(m_liMaxTime).c_str());
          }
          printf("{%s}\n",m_sFunctionName.c_str());
        }
        void incCount(){
          m_liCount++;
        }
        void incTime(long int dt){
          m_liTime+=dt;
          m_liMinTime = iclMin(dt,m_liMinTime);
          m_liMaxTime = iclMax(dt,m_liMaxTime);
        }
        private:
        long int m_liCount;
        long int m_liTime;
        long int m_liMaxTime;
        long int m_liMinTime;
        std::string m_sFunctionName;
  
        bool m_bWriteCounts;
        bool m_bWriteAvg;
        bool m_bWriteMin;
        bool m_bWriteMax;
      };
      StackTimer(StackTimerNotifier *notifier){
        m_poTimer = new Timer(1);//1=ns
        m_poNotifier = notifier;
        notifier->incCount();
        m_poTimer->start();
      }
      ~StackTimer(){
        m_poNotifier->incTime(m_poTimer->stopSilent());
        delete m_poTimer;
      }
      private:
      Timer *m_poTimer;
      StackTimerNotifier* m_poNotifier;
     
    };
    
  #define BENCHMARK_THIS_SECTION(SECTION_NAME)                            \
    static icl::utils::StackTimer::StackTimerNotifier __notifier(#SECTION_NAME);      \
    icl::utils::StackTimer __stacktimer(&__notifier);
    
  #define BENCHMARK_THIS_FUNCTION                                         \
    static icl::utils::StackTimer::StackTimerNotifier __notifier(__FUNCTION__);       \
    icl::utils::StackTimer __stacktimer(&__notifier);
    
  #define BENCHMARK_THIS_FUNCTION_LITE                                       \
    static icl::utils::StackTimer::StackTimerNotifier __notifier(__FUNCTION__,0,0,0,0);  \
    icl::utils::StackTimer __stacktimer(&__notifier);
  } // namespace utils
}