Teuchos_TimeMonitor.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_TIMEMONITOR_HPP
#define TEUCHOS_TIMEMONITOR_HPP


#include "Teuchos_PerformanceMonitorBase.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_Comm.hpp"
#include "Teuchos_Time.hpp"

#include "Teuchos_CommandLineProcessor.hpp"

#define TEUCHOS_TIMER(funcName, strName) \
  static Teuchos::Time& funcName() \
  {static Teuchos::RCP<Time> rtn = \
      Teuchos::TimeMonitor::getNewCounter(strName); return *rtn;}


#define TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, DIFF ) \
  static Teuchos::RCP<Teuchos::Time> DIFF ## blabla_localTimer; \
  if(!DIFF ## blabla_localTimer.get()) { \
    std::ostringstream oss; \
    oss << FUNCNAME; \
    DIFF ## blabla_localTimer = Teuchos::TimeMonitor::getNewCounter(oss.str()); \
  } \
  Teuchos::TimeMonitor DIFF ## blabla_localTimeMonitor(*DIFF ## blabla_localTimer)


#define TEUCHOS_FUNC_TIME_MONITOR( FUNCNAME ) \
  TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, main )


namespace Teuchos {

// Forward declaration
class StackedTimer;

typedef std::map<std::string, std::vector<std::pair<double, double> > > stat_map_type;

class TEUCHOSCOMM_LIB_DLL_EXPORT TimeMonitor :
    public PerformanceMonitorBase<Time> {
public:


  TimeMonitor (Time& timer, bool reset=false);

  TimeMonitor () = delete;

  ~TimeMonitor() override;

  static RCP<Time> getNewTimer (const std::string& name) {
    return getNewCounter (name);
  }

  static void disableTimer (const std::string& name);

  static void enableTimer (const std::string& name);

  static void zeroOutTimers();

  static void
  computeGlobalTimerStatistics (stat_map_type& statData,
                                std::vector<std::string>& statNames,
                                Ptr<const Comm<int> > comm,
                                const ECounterSetOp setOp=Intersection,
                                const std::string& filter="");

  static void
  computeGlobalTimerStatistics (stat_map_type& statData,
                                std::vector<std::string>& statNames,
                                const ECounterSetOp setOp=Intersection,
                                const std::string& filter="");

  static void
  summarize (Ptr<const Comm<int> > comm,
             std::ostream &out=std::cout,
             const bool alwaysWriteLocal=false,
             const bool writeGlobalStats=true,
             const bool writeZeroTimers=true,
             const ECounterSetOp setOp=Intersection,
             const std::string& filter="",
             const bool ignoreZeroTimers=false);

  static void
  summarize (std::ostream& out=std::cout,
             const bool alwaysWriteLocal=false,
             const bool writeGlobalStats=true,
             const bool writeZeroTimers=true,
             const ECounterSetOp setOp=Intersection,
             const std::string& filter="",
             const bool ignoreZeroTimers=false);

  static void
  report (Ptr<const Comm<int> > comm,
          std::ostream& out,
          const std::string& filter,
          const RCP<ParameterList>& params=null);

  static void
  report (Ptr<const Comm<int> > comm,
          std::ostream& out,
          const RCP<ParameterList>& params=null);

  static void
  report (std::ostream& out,
          const std::string& filter,
          const RCP<ParameterList>& params=null);

  static void
  report (std::ostream& out,
          const RCP<ParameterList>& params=null);

  static RCP<const ParameterList> getValidReportParameters ();

  static void setStackedTimer(const Teuchos::RCP<Teuchos::StackedTimer>& t);

  static Teuchos::RCP<Teuchos::StackedTimer> getStackedTimer();

  static bool stackedTimerNameIsDefault();

 private:
  enum ETimeMonitorReportFormat {
    REPORT_FORMAT_YAML,
    REPORT_FORMAT_TABLE
  };

  enum ETimeMonitorYamlFormat {
    YAML_FORMAT_COMPACT,
    YAML_FORMAT_SPACIOUS
  };

  static void
  summarizeToYaml (Ptr<const Comm<int> > comm,
                   std::ostream& out,
                   const ETimeMonitorYamlFormat yamlStyle,
                   const std::string& filter="");

  static void
  summarizeToYaml (std::ostream& out,
                   const ETimeMonitorYamlFormat yamlStyle,
                   const std::string& filter="");

  static void setReportFormatParameter (ParameterList& plist);

  static void setYamlFormatParameter (ParameterList& plist);

  static void setSetOpParameter (ParameterList& plist);

  static void setReportParameters (const RCP<ParameterList>& params);



  static ETimeMonitorReportFormat reportFormat_;

  static ETimeMonitorYamlFormat yamlStyle_;

  static ECounterSetOp setOp_;

  static bool alwaysWriteLocal_;

  static bool writeGlobalStats_;

  static bool writeZeroTimers_;

  static bool setParams_;

protected:
  static Teuchos::RCP<Teuchos::StackedTimer> stackedTimer_;
};


class TEUCHOSCOMM_LIB_DLL_EXPORT SyncTimeMonitor :
    public TimeMonitor {
public:


  SyncTimeMonitor(Time& timer, Ptr<const Comm<int> > comm, bool reset=false);

  SyncTimeMonitor () = delete;

  ~SyncTimeMonitor() override;

private:
  // \brief Communicator on which barrier will be called.
  Ptr<const Comm<int> > comm_;
};


} // namespace Teuchos


namespace Teuchos {

class TimeMonitorSurrogateImpl : public CommandLineProcessor::TimeMonitorSurrogate
{
  virtual void summarize (std::ostream& out) {
    TimeMonitor::summarize (out);
  }
};

class TimeMonitorSurrogateImplInserter {
public:
  TimeMonitorSurrogateImplInserter () {
    if (is_null (CommandLineProcessor::getTimeMonitorSurrogate ())) {
      CommandLineProcessor::setTimeMonitorSurrogate (Teuchos::rcp (new TimeMonitorSurrogateImpl));
    }
  }
};

} // end namespace Teuchos


namespace {

// Inject the implementation in every translation unit.
Teuchos::TimeMonitorSurrogateImplInserter timeMonitorSurrogateImplInserter;

} // namespace (anonymous)

#endif // TEUCHOS_TIMEMONITOR_H