SystemTimeKeeper.h

Go to the documentation of this file.

#ifndef FWCore_Framework_SystemTimeKeeper_h
#define FWCore_Framework_SystemTimeKeeper_h
// -*- C++ -*-
//
// Package:     FWCore/Framework
// Class  :     SystemTimeKeeper
//
//
// Original Author:  Chris Jones
//         Created:  Mon, 07 Jul 2014 14:37:31 GMT
//

// system include files
#include <atomic>
#include <vector>
#include <string>

// user include files
#include "FWCore/Utilities/interface/CPUTimer.h"
#include "FWCore/Utilities/interface/ChildrenCPUTimer.h"
#include "FWCore/Utilities/interface/WallclockTimer.h"

// forward declarations

namespace edm {
  class ModuleDescription;
  class StreamID;
  class StreamContext;
  class PathContext;
  class HLTPathStatus;
  class ModuleCallingContext;
  class ProcessContext;
  struct TriggerTimingReport;
  namespace service {
    class TriggerNamesService;
  }

  class SystemTimeKeeper {
  public:
    SystemTimeKeeper(unsigned int iNumStreams,
                     std::vector<const ModuleDescription*> const& iModules,
                     service::TriggerNamesService const& iNameService,
                     ProcessContext const* iProcessContext);

    SystemTimeKeeper(const SystemTimeKeeper&) = delete;
    SystemTimeKeeper& operator=(const SystemTimeKeeper&) = delete;

    // ---------- const member functions ---------------------

    // ---------- static member functions --------------------

    // ---------- member functions ---------------------------
    void removeModuleIfExists(ModuleDescription const& module);

    void startProcessingLoop();
    void stopProcessingLoop();

    void startEvent(StreamID);
    void stopEvent(StreamContext const&);

    void startPath(StreamContext const&, PathContext const&);
    void stopPath(StreamContext const&, PathContext const&, HLTPathStatus const&);

    void startModuleEvent(StreamContext const&, ModuleCallingContext const&);
    void stopModuleEvent(StreamContext const&, ModuleCallingContext const&);
    void pauseModuleEvent(StreamContext const&, ModuleCallingContext const&);
    void restartModuleEvent(StreamContext const&, ModuleCallingContext const&);

    struct ModuleInPathTiming {
      double m_realTime = 0.;
      unsigned int m_timesVisited = 0;
    };
    struct PathTiming {
      WallclockTimer m_timer;
      std::vector<ModuleInPathTiming> m_moduleTiming;
    };

    struct ModuleTiming {
      WallclockTimer m_timer;
      unsigned int m_timesRun = 0;
    };

    void fillTriggerTimingReport(TriggerTimingReport& rep) const;

  private:
    PathTiming& pathTiming(StreamContext const&, PathContext const&);
    bool checkBounds(unsigned int id) const;

    // ---------- member data --------------------------------
    std::vector<WallclockTimer> m_streamEventTimer;

    std::vector<std::vector<PathTiming>> m_streamPathTiming;

    std::vector<std::vector<ModuleTiming>> m_streamModuleTiming;

    std::vector<const ModuleDescription*> m_modules;
    std::vector<std::string> m_pathNames;
    std::vector<std::vector<std::string>> m_modulesOnPaths;

    CPUTimer m_processingLoopTimer;
    ChildrenCPUTimer m_processingLoopChildrenTimer;
    ProcessContext const* m_processContext;

    unsigned int m_minModuleID;
    unsigned int m_endPathOffset;
    std::atomic<unsigned int> m_numberOfEvents;
  };
}  // namespace edm

#endif