Inheritance diagram for edm::service::Timing:

Public Member Functions
void	addToCPUTime (double iTime) override

double	getTotalCPU () const override

	Timing (ParameterSet const &, ActivityRegistry &)

	~Timing () override

Public Member Functions inherited from edm::TimingServiceBase
	TimingServiceBase ()

virtual	~TimingServiceBase ()

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::TimingServiceBase
static void	jobStarted ()

static double	jobStartTime ()

Private Member Functions
void	postBeginJob ()

double	postCommon () const

void	postEndJob ()

void	postEvent (StreamContext const &)

void	postModule (ModuleDescription const &md)

void	postModuleEvent (StreamContext const &, ModuleCallingContext const &)

void	postModuleGlobal (GlobalContext const &, ModuleCallingContext const &)

void	postModuleStream (StreamContext const &, ModuleCallingContext const &)

void	postOpenFile (std::string const &, bool)

void	postSourceEvent (StreamID)

void	postSourceLumi ()

void	postSourceRun ()

void	preEvent (StreamContext const &)

void	preModule (ModuleDescription const &md)

void	preModuleGlobal (GlobalContext const &, ModuleCallingContext const &)

void	preModuleStream (StreamContext const &, ModuleCallingContext const &)

void	preOpenFile (std::string const &, bool)

void	preSourceEvent (StreamID)

void	preSourceLumi ()

void	preSourceRun ()

Private Attributes
std::vector< double >	curr_events_time_

double	curr_job_cpu_

double	curr_job_time_

std::atomic< double >	extra_job_cpu_

std::atomic< double >	last_run_cpu_

std::atomic< double >	last_run_time_

std::vector< double >	max_events_time_

std::vector< double >	min_events_time_

unsigned int	nStreams_

unsigned int	nThreads_

bool	report_summary_

std::vector< double >	sum_events_time_

bool	summary_only_

double	threshold_

std::atomic< unsigned long >	total_event_count_

Detailed Description

Definition at line 36 of file Timing.cc.

Constructor & Destructor Documentation

edm::service::Timing::Timing	(	ParameterSet const &	iPS,
		ActivityRegistry &	iRegistry
	)

Definition at line 168 of file Timing.cc.

                                                                        :
         curr_job_time_(0.),
         curr_job_cpu_(0.),
         extra_job_cpu_(0.0),
         last_run_time_(0.0),
         last_run_cpu_(0.0),
         curr_events_time_(),
         summary_only_(iPS.getUntrackedParameter<bool>("summaryOnly")),
         report_summary_(iPS.getUntrackedParameter<bool>("useJobReport")),
         threshold_(iPS.getUntrackedParameter<double>("excessiveTimeThreshold")),
         max_events_time_(),
         min_events_time_(),
         total_event_count_(0) {
       iRegistry.watchPostBeginJob(this, &Timing::postBeginJob);
       iRegistry.watchPostEndJob(this, &Timing::postEndJob);
 
       iRegistry.watchPreEvent(this, &Timing::preEvent);
       iRegistry.watchPostEvent(this, &Timing::postEvent);
 
       bool checkThreshold = true;
       if (threshold_ <= 0.0) {
         //we need to ignore the threshold check
         threshold_ = std::numeric_limits<double>::max();
         checkThreshold = false;
       }
           
       if( (not summary_only_) || (checkThreshold) ) {
         iRegistry.watchPreModuleEvent(this, &Timing::preModuleStream);
         iRegistry.watchPostModuleEvent(this, &Timing::postModuleEvent);
       } 
       if(checkThreshold) {
         iRegistry.watchPreSourceEvent(this, &Timing::preSourceEvent);
         iRegistry.watchPostSourceEvent(this, &Timing::postSourceEvent);
       
         iRegistry.watchPreSourceLumi(this, &Timing::preSourceLumi);
         iRegistry.watchPostSourceLumi(this, &Timing::postSourceLumi);
       
         iRegistry.watchPreSourceRun(this, &Timing::preSourceRun);
         iRegistry.watchPostSourceRun(this, &Timing::postSourceRun);
       
         iRegistry.watchPreOpenFile(this, &Timing::preOpenFile);
         iRegistry.watchPostOpenFile(this, &Timing::postOpenFile);
       
         iRegistry.watchPreEventReadFromSource(this, &Timing::preModuleStream);
         iRegistry.watchPostEventReadFromSource(this, &Timing::postModuleStream);
 
         iRegistry.watchPreModuleConstruction(this, &Timing::preModule);
         iRegistry.watchPostModuleConstruction(this, &Timing::postModule);
 
         iRegistry.watchPreModuleBeginJob(this, &Timing::preModule);
         iRegistry.watchPostModuleBeginJob(this, &Timing::postModule);
 
         iRegistry.watchPreModuleEndJob(this, &Timing::preModule);
         iRegistry.watchPostModuleEndJob(this, &Timing::postModule);
 
         iRegistry.watchPreModuleStreamBeginRun(this, &Timing::preModuleStream);
         iRegistry.watchPostModuleStreamBeginRun(this, &Timing::postModuleStream);
         iRegistry.watchPreModuleStreamEndRun(this, &Timing::preModuleStream);
         iRegistry.watchPostModuleStreamEndRun(this, &Timing::postModuleStream);
 
         iRegistry.watchPreModuleStreamBeginLumi(this, &Timing::preModuleStream);
         iRegistry.watchPostModuleStreamBeginLumi(this, &Timing::postModuleStream);
         iRegistry.watchPreModuleStreamEndLumi(this, &Timing::preModuleStream);
         iRegistry.watchPostModuleStreamEndLumi(this, &Timing::postModuleStream);
 
         iRegistry.watchPreModuleGlobalBeginRun(this, &Timing::preModuleGlobal);
         iRegistry.watchPostModuleGlobalBeginRun(this, &Timing::postModuleGlobal);
         iRegistry.watchPreModuleGlobalEndRun(this, &Timing::preModuleGlobal);
         iRegistry.watchPostModuleGlobalEndRun(this, &Timing::postModuleGlobal);
 
         iRegistry.watchPreModuleGlobalBeginLumi(this, &Timing::preModuleGlobal);
         iRegistry.watchPostModuleGlobalBeginLumi(this, &Timing::postModuleGlobal);
         iRegistry.watchPreModuleGlobalEndLumi(this, &Timing::preModuleGlobal);
         iRegistry.watchPostModuleGlobalEndLumi(this, &Timing::postModuleGlobal);
 
         iRegistry.watchPreSourceConstruction(this, &Timing::preModule);
         iRegistry.watchPostSourceConstruction(this, &Timing::postModule);
       }
 
       iRegistry.preallocateSignal_.connect([this](service::SystemBounds const& iBounds){
         nStreams_ = iBounds.maxNumberOfStreams();
         nThreads_ = iBounds.maxNumberOfThreads();
         curr_events_time_.resize(nStreams_,0.);
         sum_events_time_.resize(nStreams_,0.);
         max_events_time_.resize(nStreams_,0.);
         min_events_time_.resize(nStreams_,1.E6);
         
       });
       
       iRegistry.postGlobalEndRunSignal_.connect([this](edm::GlobalContext const&) {
         last_run_time_ = getTime();
         last_run_cpu_ = getCPU();
       });
     }

edm::service::Timing::~Timing ( )

override

Definition at line 263 of file Timing.cc.

263 {

264 }

Member Function Documentation

void edm::service::Timing::addToCPUTime ( double iTime )

overridevirtual

Extra CPU time used by a job but not seen by cmsRun The value should be in seconds. This function is safe to call from multiple threads

Implements edm::TimingServiceBase.

Definition at line 266 of file Timing.cc.

References extra_job_cpu_.

                                           {
       //For accounting purposes we effectively can say we started earlier
       double expected = extra_job_cpu_.load();
       while( not extra_job_cpu_.compare_exchange_strong(expected,expected+iTime) ) {}
     }

void edm::service::Timing::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 276 of file Timing.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), edm::ConfigurationDescriptions::setComment(), and edm::ParameterDescriptionNode::setComment().

                                                                          {
       ParameterSetDescription desc;
       desc.addUntracked<bool>("summaryOnly", false)->setComment(
       "If 'true' do not report timing for each event");
       desc.addUntracked<bool>("useJobReport", true)->setComment(
        "If 'true' write summary information to JobReport");
       desc.addUntracked<double>("excessiveTimeThreshold", 0.)->setComment(
        "Amount of time in seconds before reporting a module or source has taken excessive time. A value of 0.0 turns off this reporting.");
       descriptions.add("Timing", desc);
       descriptions.setComment(
        "This service reports the time it takes to run each module in a job.");
     }

double edm::service::Timing::getTotalCPU ( ) const

overridevirtual

CPU time used by this process and all its children. The value returned should be in seconds.

Implements edm::TimingServiceBase.

Definition at line 272 of file Timing.cc.

References edm::service::getCPU().

                                      {
       return getCPU();
     }

void edm::service::Timing::postBeginJob ( )

private

Definition at line 289 of file Timing.cc.

References curr_job_cpu_, curr_job_time_, edm::service::getCPU(), edm::service::getTime(), and summary_only_.

Referenced by Timing().

                               {
       curr_job_time_ = getTime();
       curr_job_cpu_ = getCPU();
 
       if(not summary_only_) {
         LogImportant("TimeReport")
         << "TimeReport> Report activated" << "\n"
         << "TimeReport> Report columns headings for events: "
         << "eventnum runnum timetaken\n"
         << "TimeReport> Report columns headings for modules: "
         << "eventnum runnum modulelabel modulename timetakeni\n"
         << "TimeReport> JobTime=" << curr_job_time_  << " JobCPU=" << curr_job_cpu_  << "\n";
       }
     }

double edm::service::Timing::postCommon ( ) const

private

Definition at line 486 of file Timing.cc.

References edm::service::popStack(), lumiQTWidget::t, threshold_, and trackingPlots::Timing.

Referenced by postModule(), postModuleEvent(), postModuleGlobal(), postModuleStream(), postOpenFile(), postSourceEvent(), postSourceLumi(), and postSourceRun().

                              {
       double t = popStack();
       if(t > threshold_) {
         LogError("ExcessiveTime")
           << "ExcessiveTime: Module used " << t
           << " seconds of time which exceeds the error threshold configured in the Timing Service of "
           << threshold_ << " seconds.";
       }
       return t;
     }

void edm::service::Timing::postEndJob ( )

private

Definition at line 304 of file Timing.cc.

References curr_job_cpu_, curr_job_time_, edm::service::d2str(), extra_job_cpu_, edm::service::getCPU(), edm::service::getTime(), edm::TimingServiceBase::jobStartTime(), last_run_cpu_, last_run_time_, max_events_time_, min_events_time_, nStreams_, nThreads_, report_summary_, sum_events_time_, lumiQTWidget::t, total_event_count_, and edm::service::ui2str().

Referenced by Timing().

                             {
       const double job_end_time =getTime();
       const double job_end_cpu =getCPU();
       double total_job_time = job_end_time - jobStartTime();
 
       double total_job_cpu = job_end_cpu+extra_job_cpu_;
 
       const double total_initialization_time = curr_job_time_ - jobStartTime();
       const double total_initialization_cpu =  curr_job_cpu_;
       
       if( 0.0 == jobStartTime()) {
         //did not capture beginning time
         total_job_time =job_end_time - curr_job_time_;
         total_job_cpu =job_end_cpu + extra_job_cpu_ - curr_job_cpu_ ;
       }
       
       double min_event_time = *(std::min_element(min_events_time_.begin(),
                                                  min_events_time_.end()));
       double max_event_time = *(std::max_element(max_events_time_.begin(),
                                                max_events_time_.end()));
 
       auto total_loop_time = last_run_time_ - curr_job_time_;
       auto total_loop_cpu = last_run_cpu_ + extra_job_cpu_ - curr_job_cpu_;
 
       if(last_run_time_ == 0.0) {
         total_loop_time = 0.0;
         total_loop_cpu = 0.0;
       }
 
       double sum_all_events_time = 0;
       for(auto t : sum_events_time_) { sum_all_events_time += t; }
 
       double average_event_time = 0.0;
       if(total_event_count_ != 0) {
         average_event_time = sum_all_events_time / total_event_count_;
       }
 
       double event_throughput = 0.0;
       if(total_loop_time != 0.0) {
         event_throughput = total_event_count_ / total_loop_time;
       }
 
       LogImportant("TimeReport")
         << "TimeReport> Time report complete in "
         << total_job_time << " seconds"
         << "\n"
         << " Time Summary: \n"
         << " - Min event:   " << min_event_time << "\n"
         << " - Max event:   " << max_event_time << "\n"
         << " - Avg event:   " << average_event_time << "\n"
         << " - Total loop:  " << total_loop_time <<"\n"
         << " - Total init:  " << total_initialization_time <<"\n"
         << " - Total job:   " << total_job_time << "\n"
         << " Event Throughput: "<< event_throughput <<" ev/s\n"
         << " CPU Summary: \n"
         << " - Total loop:  " << total_loop_cpu << "\n"
         << " - Total init:  " << total_initialization_cpu <<"\n"
         << " - Total extra: " << extra_job_cpu_ << "\n"
         << " - Total job:   " << total_job_cpu << "\n";
 
 
       if(report_summary_) {
         Service<JobReport> reportSvc;
         std::map<std::string, std::string> reportData;
 
         reportData.insert(std::make_pair("MinEventTime", d2str(min_event_time)));
         reportData.insert(std::make_pair("MaxEventTime", d2str(max_event_time)));
         reportData.insert(std::make_pair("AvgEventTime", d2str(average_event_time)));
         reportData.insert(std::make_pair("EventThroughput", d2str(event_throughput)));
         reportData.insert(std::make_pair("TotalJobTime", d2str(total_job_time)));
         reportData.insert(std::make_pair("TotalJobCPU", d2str(total_job_cpu)));
         reportData.insert(std::make_pair("TotalLoopTime", d2str(total_loop_time)));
         reportData.insert(std::make_pair("TotalLoopCPU", d2str(total_loop_cpu)));
         reportData.insert(std::make_pair("TotalInitTime", d2str(total_initialization_time)));
         reportData.insert(std::make_pair("TotalInitCPU", d2str(total_initialization_cpu)));
         reportData.insert(std::make_pair("NumberOfStreams",ui2str(nStreams_)));
         reportData.insert(std::make_pair("NumberOfThreads",ui2str(nThreads_)));
         reportSvc->reportPerformanceSummary("Timing", reportData);
       }
     }

void edm::service::Timing::postEvent ( StreamContext const & iStream )

private

Definition at line 390 of file Timing.cc.

References curr_events_time_, edm::StreamContext::eventID(), edm::service::getTime(), diffTreeTool::index, max_events_time_, min_events_time_, edm::StreamContext::streamID(), sum_events_time_, summary_only_, total_event_count_, and edm::StreamID::value().

Referenced by Timing().

                                                        {
       auto index = iStream.streamID().value();
 
       double curr_event_time = getTime() - curr_events_time_[index];
       sum_events_time_[index] +=curr_event_time;
 
       if(not summary_only_) {
         auto const & eventID = iStream.eventID();
         LogPrint("TimeEvent")
         << "TimeEvent> "
         << eventID.event() << " "
         << eventID.run() << " "
         << curr_event_time ;
       }
       if(curr_event_time > max_events_time_[index]) max_events_time_[index] = curr_event_time;
       if(curr_event_time < min_events_time_[index]) min_events_time_[index] = curr_event_time;
       ++total_event_count_;
     }

void edm::service::Timing::postModule ( ModuleDescription const & md )

private

Definition at line 461 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                                     {
       postCommon();
     }

void edm::service::Timing::postModuleEvent	(	StreamContext const &	iStream,
		ModuleCallingContext const &	iModule
	)

private

Definition at line 409 of file Timing.cc.

References edm::StreamContext::eventID(), edm::ModuleCallingContext::moduleDescription(), postCommon(), summary_only_, and lumiQTWidget::t.

Referenced by Timing().

                                                                                                   {
       auto const & eventID = iStream.eventID();
       auto const & desc = *(iModule.moduleDescription());
       double t = postCommon();
       if ( not summary_only_) {
           LogPrint("TimeModule") << "TimeModule> "
           << eventID.event() << " "
           << eventID.run() << " "
           << desc.moduleLabel() << " "
           << desc.moduleName() << " "
           << t;
       }
     }

void edm::service::Timing::postModuleGlobal	(	GlobalContext const &	,
		ModuleCallingContext const &	mcc
	)

private

Definition at line 471 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                                                                   {
       postCommon();
     }

void edm::service::Timing::postModuleStream	(	StreamContext const &	,
		ModuleCallingContext const &	mcc
	)

private

Definition at line 481 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                                                                   {
       postCommon();
     }

void edm::service::Timing::postOpenFile	(	std::string const &	lfn,
		bool	b
	)

private

Definition at line 451 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                                           {
       postCommon();
     }

void edm::service::Timing::postSourceEvent ( StreamID sid )

private

Definition at line 427 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                              {
       postCommon();
     }

void edm::service::Timing::postSourceLumi ( )

private

Definition at line 435 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                 {
       postCommon();
     }

void edm::service::Timing::postSourceRun ( )

private

Definition at line 443 of file Timing.cc.

References postCommon().

Referenced by Timing().

                                {
       postCommon();
     }

void edm::service::Timing::preEvent ( StreamContext const & iStream )

private

Definition at line 385 of file Timing.cc.

References curr_events_time_, edm::service::getTime(), diffTreeTool::index, edm::StreamContext::streamID(), and edm::StreamID::value().

Referenced by Timing().

                                                       {
       auto index = iStream.streamID().value();
       curr_events_time_[index] = getTime();
     }

void edm::service::Timing::preModule ( ModuleDescription const & md )

private

Definition at line 456 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                                               {
       pushStack();
     }

void edm::service::Timing::preModuleGlobal	(	GlobalContext const &	,
		ModuleCallingContext const &
	)

private

Definition at line 466 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                                                                              {
       pushStack();
     }

void edm::service::Timing::preModuleStream	(	StreamContext const &	,
		ModuleCallingContext const &
	)

private

Definition at line 476 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                                                                              {
       pushStack();
     }

void edm::service::Timing::preOpenFile	(	std::string const &	lfn,
		bool	b
	)

private

Definition at line 447 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                                                          {
       pushStack();
     }

void edm::service::Timing::preSourceEvent ( StreamID sid )

private

Definition at line 423 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                                             {
       pushStack(); 
     }

void edm::service::Timing::preSourceLumi ( )

private

Definition at line 431 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                                {
       pushStack();
     }

void edm::service::Timing::preSourceRun ( )

private

Definition at line 439 of file Timing.cc.

References edm::service::pushStack().

Referenced by Timing().

                               {
       pushStack();
     }

Member Data Documentation

std::vector<double> edm::service::Timing::curr_events_time_

private

Definition at line 85 of file Timing.cc.

Referenced by postEvent(), preEvent(), and Timing().

double edm::service::Timing::curr_job_cpu_

private

Definition at line 80 of file Timing.cc.

Referenced by postBeginJob(), and postEndJob().

double edm::service::Timing::curr_job_time_

private

Definition at line 79 of file Timing.cc.

Referenced by postBeginJob(), and postEndJob().

std::atomic<double> edm::service::Timing::extra_job_cpu_

private

Definition at line 81 of file Timing.cc.

Referenced by addToCPUTime(), and postEndJob().

std::atomic<double> edm::service::Timing::last_run_cpu_

private

Definition at line 84 of file Timing.cc.

Referenced by postEndJob(), and Timing().

std::atomic<double> edm::service::Timing::last_run_time_

private

Definition at line 83 of file Timing.cc.

Referenced by postEndJob(), and Timing().

std::vector<double> edm::service::Timing::max_events_time_

private

Definition at line 92 of file Timing.cc.

Referenced by postEndJob(), postEvent(), and Timing().

std::vector<double> edm::service::Timing::min_events_time_

private

Definition at line 93 of file Timing.cc.

Referenced by postEndJob(), postEvent(), and Timing().

unsigned int edm::service::Timing::nStreams_

private

Definition at line 96 of file Timing.cc.

Referenced by postEndJob(), and Timing().

unsigned int edm::service::Timing::nThreads_

private

Definition at line 97 of file Timing.cc.

Referenced by postEndJob(), and Timing().

bool edm::service::Timing::report_summary_

private

Definition at line 87 of file Timing.cc.

Referenced by postEndJob().

std::vector<double> edm::service::Timing::sum_events_time_

private

Definition at line 94 of file Timing.cc.

Referenced by postEndJob(), postEvent(), and Timing().

bool edm::service::Timing::summary_only_

private

Definition at line 86 of file Timing.cc.

Referenced by postBeginJob(), postEvent(), postModuleEvent(), and Timing().

double edm::service::Timing::threshold_

private

Definition at line 88 of file Timing.cc.

Referenced by postCommon(), and Timing().

std::atomic<unsigned long> edm::service::Timing::total_event_count_

private

Definition at line 95 of file Timing.cc.

Referenced by postEndJob(), and postEvent().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation