sChronoManager.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR is free software: you can redistribute it and/or modify it under the
    terms of the GNU General Public License as published by the Free Software
    Foundation, either version 3 of the License, or (at your option) any later
    version.

    CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    details.

    You should have received a copy of the GNU General Public License along with
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2019 all CASToR contributors listed below:

    --> Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Thibaut MERLIN, Mael MILLARDET, Simon STUTE, Valentin VIELZEUF

This is CASToR version 3.0.
*/

#ifndef SCHRONOMANAGER_HH
#define SCHRONOMANAGER_HH 1

#include "gVariables.hh"
#include "sOutputManager.hh"

// Typedef for times and durations
typedef std::chrono::time_point<std::chrono::system_clock> ChronoTime;
typedef std::chrono::duration<int64_t,std::nano> DurationNano;
typedef std::chrono::milliseconds Ms;
typedef std::chrono::seconds Secs;
typedef std::chrono::minutes Mins;
typedef std::chrono::hours Hs;

class sChronoManager
{
  // -----------------------------------------------------------------------------------------
  // Constructor & Destructor
  public :
    static sChronoManager *GetInstance()
    {
      if (mp_Instance == NULL) mp_Instance = new sChronoManager;
      return mp_Instance;
    };
    ~sChronoManager() {mp_Instance = NULL;}

  // -----------------------------------------------------------------------------------------
  // Public functions
  public:
    int CheckParameters();
    int Initialize();
    void Display();

  // -----------------------------------------------------------------------------------------
  // Public inline functions for updating timers
  public:
    inline void StartIterativeDataUpdateStep1(int a_thread)
           {mp_startIterativeDataUpdateStep1[a_thread] = std::chrono::system_clock::now();}
    inline void StopIterativeDataUpdateStep1(int a_thread)
           {mp_durationIterativeDataUpdateStep1[a_thread] += std::chrono::system_clock::now() - mp_startIterativeDataUpdateStep1[a_thread];}
    inline void StartIterativeDataUpdateStep2(int a_thread)
           {mp_startIterativeDataUpdateStep2[a_thread] = std::chrono::system_clock::now();}
    inline void StopIterativeDataUpdateStep2(int a_thread)
           {mp_durationIterativeDataUpdateStep2[a_thread] += std::chrono::system_clock::now() - mp_startIterativeDataUpdateStep2[a_thread];}
    inline void StartIterativeDataUpdateStep3(int a_thread)
           {mp_startIterativeDataUpdateStep3[a_thread] = std::chrono::system_clock::now();}
    inline void StopIterativeDataUpdateStep3(int a_thread)
           {mp_durationIterativeDataUpdateStep3[a_thread] += std::chrono::system_clock::now() - mp_startIterativeDataUpdateStep3[a_thread];}
    inline void StartIterativeDataUpdateStep4(int a_thread)
           {mp_startIterativeDataUpdateStep4[a_thread] = std::chrono::system_clock::now();}
    inline void StopIterativeDataUpdateStep4(int a_thread)
           {mp_durationIterativeDataUpdateStep4[a_thread] += std::chrono::system_clock::now() - mp_startIterativeDataUpdateStep4[a_thread];}
    inline void StartConvolution()
           {m_startConvolution = std::chrono::system_clock::now();}
    inline void StopConvolution()
           {m_durationConvolution += std::chrono::system_clock::now() - m_startConvolution;}
    inline void StartCustomStep(int a_thread, int a_step)
           {mpp_startCustomSteps[a_step][a_thread] = std::chrono::system_clock::now();}
    inline void StopCustomStep(int a_thread, int a_step)
           {mpp_durationCustomSteps[a_step][a_thread] += std::chrono::system_clock::now() - mpp_startCustomSteps[a_step][a_thread];}

  // -----------------------------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline void SetNbThreads(int a_nbThreadsForProjection, int a_nbThreadsForImageComputation)
           {m_nbThreadsForProjection = a_nbThreadsForProjection; m_nbThreadsForImageComputation = a_nbThreadsForImageComputation;
            m_nbThreadsMax = m_nbThreadsForProjection; if (m_nbThreadsForImageComputation>m_nbThreadsForProjection) m_nbThreadsMax = m_nbThreadsForImageComputation;}
    inline void SetNbCustomSteps(int a_nbCustomSteps)
           {m_nbCustomSteps = a_nbCustomSteps;}
    inline void SetVerbose(int a_verbose)
           {m_verbose = a_verbose;}

  // -------------------------------------------------------------------
  // Private constructor
  private:
    sChronoManager();
    // Prevent the compiler to generate methods to copy the object
    sChronoManager(sChronoManager const&){};     
    void operator=(sChronoManager const&){};

  // -------------------------------------------------------------------
  // Private data members
  private:
    static sChronoManager *mp_Instance; 
    // Number of threads
    int m_nbThreadsForProjection;
    int m_nbThreadsForImageComputation;
    int m_nbThreadsMax;
    // Permanent profiled steps
    DurationNano* mp_durationIterativeDataUpdateStep1;
    DurationNano* mp_durationIterativeDataUpdateStep2;
    DurationNano* mp_durationIterativeDataUpdateStep3;
    DurationNano* mp_durationIterativeDataUpdateStep4;
    ChronoTime* mp_startIterativeDataUpdateStep1;
    ChronoTime* mp_startIterativeDataUpdateStep2;
    ChronoTime* mp_startIterativeDataUpdateStep3;
    ChronoTime* mp_startIterativeDataUpdateStep4;
    DurationNano m_durationConvolution;
    ChronoTime m_startConvolution;
    // Custom profiled steps
    int m_nbCustomSteps;
    DurationNano** mpp_durationCustomSteps;
    ChronoTime** mpp_startCustomSteps;
    // Verbose
    int m_verbose;
};

#endif