EL::Detail::StopwatchModule Class Reference

a Module wrapping the TStopwatch class More...

#include <StopwatchModule.h>

Inheritance diagram for EL::Detail::StopwatchModule:

Collaboration diagram for EL::Detail::StopwatchModule:

Public Member Functions
virtual StatusCode	firstInitialize (ModuleData &data) override
	action at the the very beginning of the worker job More...
virtual StatusCode	onFileExecute (ModuleData &data) override
	actions just before fileExecute is called on algorithms More...
virtual StatusCode	postFinalize (ModuleData &data) override
	actions after algorithms have been finalized More...
virtual StatusCode	onWorkerEnd (ModuleData &data) override
	action at the end of the worker job More...
virtual StatusCode	preFileInitialize (ModuleData &data)
	action before opening the first file in the worker job More...
virtual StatusCode	onInitialize (ModuleData &data)
	action just before algorithms are initialized More...
virtual StatusCode	processInputs (ModuleData &data, IInputModuleActions &actions)
	process all input files More...
virtual StatusCode	postFirstEvent (ModuleData &data)
	action after processing first event More...
virtual StatusCode	onNewInputFile (ModuleData &data)
	actions after opening a new input file More...
virtual StatusCode	onCloseInputFile (ModuleData &data)
	actions before closing an input file More...
virtual StatusCode	postCloseInputFile (ModuleData &data)
	actions after CloseInputFile is called on the algorithms More...
virtual StatusCode	onExecute (ModuleData &data)
	actions just before execute is called on algorithms More...
virtual StatusCode	onFinalize (ModuleData &data)
	actions just before algorithms are finalized More...
virtual StatusCode	postFileClose (ModuleData &data)
	action at end of the worker job More...
virtual void	reportInputFailure (ModuleData &data)
	report that we failed to open our input file More...

Private Attributes
std::unique_ptr< TH1 >	m_runTime {nullptr}
	the run time summary histogram More...
std::unique_ptr< TStopwatch >	m_stopwatch
	the stop watch we use for measuring total time spend More...

Detailed Description

a Module wrapping the TStopwatch class

Definition at line 24 of file StopwatchModule.h.

Member Function Documentation

firstInitialize()

StatusCode EL::Detail::StopwatchModule::firstInitialize ( ModuleData &  data )

overridevirtual

action at the the very beginning of the worker job

This gets called as early as possible in the worker initialization. Essentially all that should happen before this is to load all the modules. The main purpose is to start any benchmarks that are meant to capture the initialization process as well.

Reimplemented from EL::Detail::Module.

Definition at line 28 of file StopwatchModule.cxx.

    {
      m_stopwatch = std::make_unique<TStopwatch> ();
 
      m_stopwatch->Start ();
 
      m_runTime = std::make_unique<TH1D> ("EventLoop_RunTime", "worker run-time summary", 5, 0, 5);
      m_runTime->SetDirectory (nullptr);
      m_runTime->Fill (0);
      m_runTime->GetXaxis()->SetBinLabel (1, "jobs");
      m_runTime->GetXaxis()->SetBinLabel (2, "files");
      m_runTime->GetXaxis()->SetBinLabel (3, "events");
      m_runTime->GetXaxis()->SetBinLabel (4, "cpu time");
      m_runTime->GetXaxis()->SetBinLabel (5, "real time");
      return ::StatusCode::SUCCESS;
    }

onCloseInputFile()

StatusCode EL::Detail::Module::onCloseInputFile ( ModuleData &  data )

virtualinherited

actions before closing an input file

Reimplemented in EL::Detail::AlgorithmStateModule, and EL::Detail::TreeCacheModule.

Definition at line 43 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

onExecute()

StatusCode EL::Detail::Module::onExecute ( ModuleData &  data )

virtualinherited

actions just before execute is called on algorithms

For now that is mostly used to point input modules to the right event

Reimplemented in EL::Detail::TEventModule, EL::Detail::AlgorithmStateModule, EL::Detail::MemoryMonitorModule, and EL::Detail::GridReportingModule.

Definition at line 71 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

onFileExecute()

StatusCode EL::Detail::StopwatchModule::onFileExecute ( ModuleData &  data )

overridevirtual

actions just before fileExecute is called on algorithms

Reimplemented from EL::Detail::Module.

Definition at line 48 of file StopwatchModule.cxx.

    {
      m_runTime->Fill (1);
      return ::StatusCode::SUCCESS;
    }

onFinalize()

StatusCode EL::Detail::Module::onFinalize ( ModuleData &  data )

virtualinherited

actions just before algorithms are finalized

Reimplemented in EL::Detail::AlgorithmStateModule, and EL::Detail::MemoryMonitorModule.

Definition at line 89 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

onInitialize()

StatusCode EL::Detail::Module::onInitialize ( ModuleData &  data )

virtualinherited

action just before algorithms are initialized

This is typically used for any setup that this module needs to do.

Reimplemented in EL::Detail::TEventModule, EL::Detail::AlgorithmStateModule, EL::Detail::MemoryMonitorModule, EL::Detail::FileExecutedModule, EL::Detail::FactoryPreloadModule, and EL::Detail::WorkerConfigModule.

Definition at line 77 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

onNewInputFile()

StatusCode EL::Detail::Module::onNewInputFile ( ModuleData &  data )

virtualinherited

actions after opening a new input file

Reimplemented in EL::Detail::TEventModule, EL::Detail::AlgorithmStateModule, EL::Detail::GridReportingModule, and EL::Detail::TreeCacheModule.

Definition at line 37 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

onWorkerEnd()

StatusCode EL::Detail::StopwatchModule::onWorkerEnd ( ModuleData &  data )

overridevirtual

action at the end of the worker job

This is mostly meant/used to print job summary statements at the very end of worker job, and actually have them show up at or at least near the end of any log file.

Reimplemented from EL::Detail::Module.

Definition at line 71 of file StopwatchModule.cxx.

    {
      m_stopwatch->Stop ();
      m_stopwatch->Print ();
      return ::StatusCode::SUCCESS;
    }

postCloseInputFile()

StatusCode EL::Detail::Module::postCloseInputFile ( ModuleData &  data )

virtualinherited

actions after CloseInputFile is called on the algorithms

Right now that is only used to disconnect the TEvent object from the input file.

Reimplemented in EL::Detail::TEventModule.

Definition at line 49 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

postFileClose()

StatusCode EL::Detail::Module::postFileClose ( ModuleData &  data )

virtualinherited

action at end of the worker job

Executed just right before worker exit successfully at this stage all outputs have been created

Reimplemented in EL::Detail::GridReportingModule, and EL::Detail::PostClosedOutputsModule.

Definition at line 107 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

postFinalize()

StatusCode EL::Detail::StopwatchModule::postFinalize ( ModuleData &  data )

overridevirtual

actions after algorithms have been finalized

This is usually used to calculate some job summary information that is to be stored it in the histogram output file.

Reimplemented from EL::Detail::Module.

Definition at line 57 of file StopwatchModule.cxx.

    {
      m_stopwatch->Stop ();
      m_runTime->Fill (2, data.m_eventsProcessed);
      m_runTime->Fill (3, m_stopwatch->CpuTime());
      m_runTime->Fill (4, m_stopwatch->RealTime());
      m_stopwatch->Continue ();
      data.addOutput (std::move (m_runTime));
      return ::StatusCode::SUCCESS;
    }

postFirstEvent()

StatusCode EL::Detail::Module::postFirstEvent ( ModuleData &  data )

virtualinherited

action after processing first event

This is mostly meant to set up benchmarks that record per-event performance. While a lot of initialization happens during initialize() there is a fair amount of initialization that happens on the first event, so when recording per-event performance the first event is sort of "special" and may need to be omitted.

Reimplemented in EL::Detail::MemoryMonitorModule, and EL::Detail::LeakCheckModule.

Definition at line 55 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

preFileInitialize()

StatusCode EL::Detail::Module::preFileInitialize ( ModuleData &  data )

virtualinherited

action before opening the first file in the worker job

This is mostly meant to allow loading the dictionaries before any files and associated information is loaded.

Definition at line 31 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

processInputs()

StatusCode EL::Detail::Module::processInputs ( ModuleData &  data, IInputModuleActions &  actions  )

virtualinherited

process all input files

This deviates slightly from the usual pattern for module functions in that I pass in the possible actions as an argument. See IInputModuleActions for details.

Reimplemented in EL::Detail::BatchInputModule, and EL::Detail::DirectInputModule.

Definition at line 83 of file Module.cxx.

    {
      return ::StatusCode::SUCCESS;
    }

reportInputFailure()

void EL::Detail::Module::reportInputFailure ( ModuleData &  data )

virtualinherited

report that we failed to open our input file

Reimplemented in EL::Detail::GridReportingModule.

Definition at line 61 of file Module.cxx.

    {}

Member Data Documentation

m_runTime

std::unique_ptr<TH1> EL::Detail::StopwatchModule::m_runTime {nullptr}

private

the run time summary histogram

Definition at line 45 of file StopwatchModule.h.

m_stopwatch

std::unique_ptr<TStopwatch> EL::Detail::StopwatchModule::m_stopwatch

private

the stop watch we use for measuring total time spend

Definition at line 49 of file StopwatchModule.h.

---

The documentation for this class was generated from the following files:

• StopwatchModule.h
• StopwatchModule.cxx