The Gaudi Framework  v30r3 (a5ef0a68)
ChronoStatSvc Class Reference

The Chrono & Stat Sservice: service implements the IChronoStatSvc interface and provides the basic chronometry and some statistical counts needed by all applications. More...

#include <src/ChronoStatSvc.h>

Inheritance diagram for ChronoStatSvc:
Collaboration diagram for ChronoStatSvc:

Public Types

typedef std::map< IChronoStatSvc::ChronoTag, ChronoEntityChronoMap
 some useful typedefs More...
 
typedef std::map< IChronoStatSvc::StatTag, StatEntityStatMap
 
- Public Types inherited from extends< Service, IChronoStatSvc, IIncidentListener >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from Service
using Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 

Public Member Functions

StatusCode initialize () override
 Implementation of IService::initialize() More...
 
StatusCode finalize () override
 Implementation of IService::finalize() More...
 
ChronoEntitychronoStart (const IChronoStatSvc::ChronoTag &chronoTag) override
 Implementation of IChronoStatSvc::chronoStart. More...
 
const ChronoEntitychronoStop (const IChronoStatSvc::ChronoTag &chronoTag) override
 Implementation of IChronoStatSvc::chronoStop. More...
 
IChronoStatSvc::ChronoTime chronoDelta (const IChronoStatSvc::ChronoTag &chronoTag, IChronoStatSvc::ChronoType theType) override
 Implementation of IchronoStatSvc::chronoDelta. More...
 
void chronoPrint (const IChronoStatSvc::ChronoTag &chronoTag) override
 Implementation of IChronoStatSvc::chronoPrint. More...
 
ChronoStatus chronoStatus (const IChronoStatSvc::ChronoTag &chronoTag) override
 Implementation of IChronoStatSvc::chronoStatus. More...
 
void stat (const IChronoStatSvc::StatTag &statTag, const IChronoStatSvc::StatFlag &statFlag) override
 Implementation of IChronoStatSvc::stat add statistical information to the entity , tagged by its name. More...
 
void statPrint (const IChronoStatSvc::ChronoTag &statTag) override
 prints (using message service) info about statistical entity, tagged by its name More...
 
const ChronoEntitychrono (const IChronoStatSvc::ChronoTag &t) const override
 extract the chrono entity for the given tag (name) More...
 
StatEntitystat (const IChronoStatSvc::StatTag &t) override
 extract the stat entity for the given tag (name) More...
 
 ChronoStatSvc (const std::string &name, ISvcLocator *svcloc)
 Default constructor. More...
 
void merge (const ChronoStatSvc &css)
 Compound assignment operator. More...
 
void handle (const Incident &incident) override
 
- Public Member Functions inherited from extends< Service, IChronoStatSvc, IIncidentListener >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
- Public Member Functions inherited from Service
const std::stringname () const override
 Retrieve name of the service. More...
 
StatusCode configure () override
 
StatusCode initialize () override
 
StatusCode start () override
 
StatusCode stop () override
 
StatusCode finalize () override
 
StatusCode terminate () override
 
Gaudi::StateMachine::State FSMState () const override
 
Gaudi::StateMachine::State targetFSMState () const override
 
StatusCode reinitialize () override
 
StatusCode restart () override
 
StatusCode sysInitialize () override
 Initialize Service. More...
 
StatusCode sysStart () override
 Initialize Service. More...
 
StatusCode sysStop () override
 Initialize Service. More...
 
StatusCode sysFinalize () override
 Finalize Service. More...
 
StatusCode sysReinitialize () override
 Re-initialize the Service. More...
 
StatusCode sysRestart () override
 Re-initialize the Service. More...
 
 Service (std::string name, ISvcLocator *svcloc)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator. More...
 
StatusCode setProperties ()
 Method for setting declared properties to the values specified for the job. More...
 
template<class T >
StatusCode service (const std::string &name, const T *&psvc, bool createIf=true) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, bool createIf=true) const
 
template<typename IFace = IService>
SmartIF< IFace > service (const std::string &name, bool createIf=true) const
 
template<class T >
StatusCode service (const std::string &svcType, const std::string &svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
 Declare used tool. More...
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 PropertyHolder ()=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
 Helper to wrap a regular data member and use it as a regular property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p) override
 set the property form another property More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 set the property from name and the value More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (const std::string &name) const override
 get the property by name More...
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 convert the property to the string More...
 
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties More...
 
bool hasProperty (const std::string &name) const override
 Return true if we have a property with the given name. More...
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
- Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level msgLevel () const
 get the cached level (originally extracted from the embedded MsgStream) More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const
 Backward compatibility function for getting the output level. More...
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
const SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 

Protected Member Functions

void printStats ()
 
- Protected Member Functions inherited from Service
 ~Service () override
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level setUpMessaging () const
 Set up local caches. More...
 
MSG::Level resetMessaging ()
 Reinitialize internal states. More...
 
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 

Private Types

typedef std::map< ChronoTag, std::vector< IChronoSvc::ChronoTime > > TimeMap
 

Private Member Functions

 ChronoStatSvc ()=delete
 
 ChronoStatSvc (const ChronoStatSvc &)=delete
 
ChronoStatSvcoperator= (const ChronoStatSvc &)=delete
 
void saveStats ()
 dump the statistics into an ASCII file for offline processing More...
 

Private Attributes

ChronoMap m_chronoEntities
 chrono part More...
 
MSG::Level m_chronoPrintLevel = MSG::INFO
 level of info printing More...
 
StatMap m_statEntities
 stat part More...
 
MSG::Level m_statPrintLevel = MSG::INFO
 level of info printing More...
 
Gaudi::Property< bool > m_chronoTableFlag
 
Gaudi::Property< bool > m_chronoCoutFlag
 
Gaudi::Property< int > m_intChronoPrintLevel {this, "ChronoPrintLevel", MSG::INFO, "print level"}
 
Gaudi::Property< bool > m_chronoOrderFlag {this, "ChronoTableToBeOrdered", true, "should the printout be ordered"}
 
Gaudi::Property< bool > m_printUserTime {this, "PrintUserTime", true}
 
Gaudi::Property< bool > m_printSystemTime {this, "PrintSystemTime", false}
 
Gaudi::Property< bool > m_printEllapsedTime {this, "PrintEllapsedTime", false}
 
Gaudi::Property< bool > m_statTableFlag
 
Gaudi::Property< bool > m_statCoutFlag
 
Gaudi::Property< int > m_intStatPrintLevel {this, "StatPrintLevel", MSG::INFO, "print level"}
 
Gaudi::Property< bool > m_statOrderFlag {this, "StatTableToBeOrdered", true, "should the printout be ordered"}
 
Gaudi::Property< std::stringm_statsOutFileName
 
Gaudi::Property< std::stringm_header
 
Gaudi::Property< bool > m_useEffFormat
 
Gaudi::Property< std::stringm_perEventFile {this, "PerEventFile", "", "File name for per-event deltas"}
 
TimeMap m_perEvtTime
 
std::ofstream m_ofd
 

Additional Inherited Members

- Protected Attributes inherited from Service
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::Property< int > m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
 
Gaudi::Property< bool > m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
 
Gaudi::Property< bool > m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
 
Gaudi::Property< bool > m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
 
Gaudi::Property< bool > m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
 
Gaudi::Property< bool > m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
 
Gaudi::Property< bool > m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
 
Gaudi::Property< bool > m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
 
SmartIF< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Detailed Description

The Chrono & Stat Sservice: service implements the IChronoStatSvc interface and provides the basic chronometry and some statistical counts needed by all applications.

Author
: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru : December 1, 1999

Definition at line 33 of file ChronoStatSvc.h.

Member Typedef Documentation

typedef std::map<IChronoStatSvc::ChronoTag, ChronoEntity> ChronoStatSvc::ChronoMap

some useful typedefs

Definition at line 38 of file ChronoStatSvc.h.

typedef std::map<IChronoStatSvc::StatTag, StatEntity> ChronoStatSvc::StatMap

Definition at line 39 of file ChronoStatSvc.h.

Definition at line 170 of file ChronoStatSvc.h.

Constructor & Destructor Documentation

ChronoStatSvc::ChronoStatSvc ( const std::string name,
ISvcLocator svcloc 
)

Default constructor.

Parameters
nameservice instance name
svclocpointer to servcie locator

Definition at line 81 of file ChronoStatSvc.cpp.

81  : base_class( name, svcloc )
82 {
83  // basically limit the integer to MSG::Level range
84  auto int2level = []( int l ) -> MSG::Level {
85  return static_cast<MSG::Level>(
86  std::max( std::min( l, static_cast<int>( MSG::FATAL ) ), static_cast<int>( MSG::NIL ) ) );
87  };
88 
89  m_intStatPrintLevel.declareUpdateHandler(
90  [this, int2level]( Gaudi::Details::PropertyBase& ) { m_statPrintLevel = int2level( m_intStatPrintLevel ); } );
91  m_intChronoPrintLevel.declareUpdateHandler(
92  [this, int2level]( Gaudi::Details::PropertyBase& ) { m_chronoPrintLevel = int2level( m_intChronoPrintLevel ); } );
93 }
Gaudi::Property< int > m_intStatPrintLevel
extends base_class
Typedef to this class.
Definition: extends.h:15
T min(T...args)
Gaudi::Property< int > m_intChronoPrintLevel
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
T max(T...args)
MSG::Level m_chronoPrintLevel
level of info printing
dictionary l
Definition: gaudirun.py:440
MSG::Level m_statPrintLevel
level of info printing
ChronoStatSvc::ChronoStatSvc ( )
privatedelete
ChronoStatSvc::ChronoStatSvc ( const ChronoStatSvc )
privatedelete

Member Function Documentation

const ChronoEntity * ChronoStatSvc::chrono ( const IChronoStatSvc::ChronoTag &  t) const
override

extract the chrono entity for the given tag (name)

See also
IChronoStatSvc
Parameters
tchrono tag(name)
Returns
pointer to chrono entity

Definition at line 388 of file ChronoStatSvc.cpp.

389 {
390  auto it = m_chronoEntities.find( t );
391  return m_chronoEntities.end() != it ? &( it->second ) : nullptr;
392 }
T end(T...args)
T find(T...args)
ChronoMap m_chronoEntities
chrono part
IChronoStatSvc::ChronoTime ChronoStatSvc::chronoDelta ( const IChronoStatSvc::ChronoTag &  chronoTag,
IChronoStatSvc::ChronoType  theType 
)
override

Implementation of IchronoStatSvc::chronoDelta.

See also
IChronoStatSvc

Definition at line 328 of file ChronoStatSvc.cpp.

330 {
331  return m_chronoEntities[chronoTag].delta( theType );
332 }
ChronoMap m_chronoEntities
chrono part
void ChronoStatSvc::chronoPrint ( const IChronoStatSvc::ChronoTag &  chronoTag)
override

Implementation of IChronoStatSvc::chronoPrint.

See also
IChronoStatSvc

Definition at line 336 of file ChronoStatSvc.cpp.

337 {
338  MsgStream log( msgSvc(), chronoTag );
339  if ( m_printUserTime ) {
340  log << (MSG::Level)m_chronoPrintLevel << m_chronoEntities[chronoTag].outputUserTime() << endmsg;
341  }
342  if ( m_printSystemTime ) {
343  log << (MSG::Level)m_chronoPrintLevel << m_chronoEntities[chronoTag].outputSystemTime() << endmsg;
344  }
345 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
Gaudi::Property< bool > m_printUserTime
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
MSG::Level m_chronoPrintLevel
level of info printing
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
ChronoMap m_chronoEntities
chrono part
Gaudi::Property< bool > m_printSystemTime
ChronoEntity * ChronoStatSvc::chronoStart ( const IChronoStatSvc::ChronoTag &  chronoTag)
override

Implementation of IChronoStatSvc::chronoStart.

See also
IChronoStatSvc

Definition at line 310 of file ChronoStatSvc.cpp.

311 {
312  ChronoEntity& entity = m_chronoEntities[chronoTag];
313  entity.start();
314  return &entity;
315 }
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
IChronoSvc::ChronoStatus start()
start the current chrono
ChronoMap m_chronoEntities
chrono part
IChronoStatSvc::ChronoStatus ChronoStatSvc::chronoStatus ( const IChronoStatSvc::ChronoTag &  chronoTag)
override

Implementation of IChronoStatSvc::chronoStatus.

See also
IChronoStatSvc

Definition at line 349 of file ChronoStatSvc.cpp.

350 {
351  return m_chronoEntities[chronoTag].status();
352 }
ChronoMap m_chronoEntities
chrono part
const ChronoEntity * ChronoStatSvc::chronoStop ( const IChronoStatSvc::ChronoTag &  chronoTag)
override

Implementation of IChronoStatSvc::chronoStop.

See also
IChronoStatSvc

Definition at line 319 of file ChronoStatSvc.cpp.

320 {
321  ChronoEntity& entity = m_chronoEntities[chronoTag];
322  entity.stop();
323  return &entity;
324 }
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
IChronoSvc::ChronoStatus stop()
stop the chrono
ChronoMap m_chronoEntities
chrono part
StatusCode ChronoStatSvc::finalize ( )
override

Implementation of IService::finalize()

stop its own chrono

Is the final chrono table to be printed?

decoration

CONTINUE

CONTINUE

stop chrono (if it is still in RUNNING status)

print to std::cout

print to MsgStream

decoration

CONTINUE

CONTINUE

stop chrono (if it is still in RUNNING status)

print to std::cout

print to MsgStream

decoration

CONTINUE

CONTINUE

stop chrono (if it is still in RUNNING status)

print to std::cout

print to MsgStream

clear the temporary container

the final decoration

Is the final stat table to be printed?

< finalize the base class

Definition at line 142 of file ChronoStatSvc.cpp.

143 {
144  std::string local = name() + ".finalize()";
146  MsgStream main_log( msgSvc(), local );
149  chronoStop( name() );
150 
151  if ( m_ofd.is_open() ) {
152  debug() << "writing per-event timing data to '" << m_perEventFile << "'" << endmsg;
153  for ( const auto& itr : m_perEvtTime ) {
154  m_ofd << itr.first.substr( 0, itr.first.length() - 8 ) << " ";
155  for ( const auto& itt : itr.second ) {
156  m_ofd << " " << (long int)( itt );
157  }
158  m_ofd << std::endl;
159  }
160 
161  m_ofd.close();
162  }
163 
168  MsgStream log( msgSvc(), "*****Chrono*****" );
169  const std::string stars( ( m_chronoCoutFlag ) ? 126 : 100, '*' );
170  if ( m_chronoCoutFlag ) {
171  std::cout << stars << std::endl;
172  std::cout << local << " The Final CPU consumption (Chrono) Table "
173  << ( m_chronoOrderFlag ? "(ordered)" : "(not ordered)" ) << std::endl;
174  std::cout << stars << std::endl;
175  } else {
176  log << (MSG::Level)m_chronoPrintLevel << stars << endmsg;
177  log << (MSG::Level)m_chronoPrintLevel << " The Final CPU consumption ( Chrono ) Table "
178  << ( m_chronoOrderFlag ? "(ordered)" : "(not ordered)" ) << endmsg;
179  log << (MSG::Level)m_chronoPrintLevel << stars << endmsg;
180  }
182  { // prepare container for printing
184  tmpCont.reserve( m_chronoEntities.size() );
185  for ( auto& it : m_chronoEntities ) {
186  tmpCont.emplace_back( &it.second, &it.first );
187  }
188  // sort it
189  if ( m_chronoOrderFlag ) std::sort( tmpCont.begin(), tmpCont.end(), CompareFirstOfPointerPair );
190  // print User Time statistics
191  if ( m_printUserTime ) {
192  for ( auto iter = tmpCont.begin(); tmpCont.end() != iter; ++iter ) {
193  //
194  ChronoEntity* entity = iter->first;
195  if ( !entity ) {
196  continue;
197  }
198  const ChronoTag* tag = iter->second;
199  if ( !tag ) {
200  continue;
201  }
202  entity->stop();
204  if ( m_chronoCoutFlag )
206  {
207  std::cout << *tag << "\t" << entity->outputUserTime() << std::endl;
208  } else
209  {
210  MsgStream( msgSvc(), *tag ) << m_chronoPrintLevel << entity->outputUserTime() << endmsg;
211  }
212  //
213  }
214  }
216  if ( m_printSystemTime ) {
220  std::cout << stars << std::endl;
221  } else if ( m_printUserTime && !m_chronoCoutFlag ) {
222  log << (MSG::Level)m_chronoPrintLevel << stars << endmsg;
223  }
225  for ( auto iter = tmpCont.begin(); tmpCont.end() != iter; ++iter ) {
227  ChronoEntity* entity = iter->first;
228  if ( !entity ) {
229  continue;
230  }
231  const ChronoTag* tag = iter->second;
232  if ( !tag ) {
233  continue;
234  }
235  entity->stop();
237  if ( m_chronoCoutFlag )
239  {
240  std::cout << *tag << "\t" << entity->outputSystemTime() << std::endl;
241  } else
242  {
243  MsgStream( msgSvc(), *tag ) << m_chronoPrintLevel << entity->outputSystemTime() << endmsg;
244  }
245  //
246  }
247  }
249  if ( m_printEllapsedTime ) {
253  std::cout << stars << std::endl;
254  } else if ( ( m_printUserTime || m_printSystemTime ) && !m_chronoCoutFlag ) {
255  log << (MSG::Level)m_chronoPrintLevel << stars << endmsg;
256  }
258  for ( const auto& i : tmpCont ) {
260  ChronoEntity* entity = i.first;
261  if ( !entity ) {
262  continue;
263  }
264  const ChronoTag* tag = i.second;
265  if ( !tag ) {
266  continue;
267  }
268  entity->stop();
270  if ( m_chronoCoutFlag )
272  {
273  std::cout << *tag << "\t" << entity->outputElapsedTime() << std::endl;
274  } else
275  {
276  MsgStream( msgSvc(), *tag ) << m_chronoPrintLevel << entity->outputElapsedTime() << endmsg;
277  }
278  //
279  }
280  }
282  tmpCont.clear();
283  }
285  if ( m_chronoCoutFlag ) {
286  std::cout << stars << std::endl;
287  } else {
288  log << m_chronoPrintLevel << stars << endmsg;
289  }
290  }
291 
293 
295  if ( m_statTableFlag ) {
296  printStats();
297  }
298 
299  if ( !m_statsOutFileName.value().empty() ) {
300  saveStats();
301  }
302 
303  main_log << MSG::INFO << " Service finalized successfully " << endmsg;
304 
305  return Service::finalize();
306 }
std::string outputElapsedTime() const
print the chrono ;
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
T empty(T...args)
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:288
StatusCode finalize() override
Definition: Service.cpp:173
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
T endl(T...args)
Gaudi::Property< bool > m_chronoOrderFlag
Gaudi::Property< bool > m_printUserTime
T end(T...args)
std::string outputSystemTime() const
print the chrono ;
STL class.
void saveStats()
dump the statistics into an ASCII file for offline processing
constexpr struct CompareFirstOfPointerPair_t CompareFirstOfPointerPair
void clear(STATE_TYPE _i=std::ios_base::failbit)
Definition: MsgStream.h:187
TimeMap m_perEvtTime
T close(T...args)
const ChronoEntity * chronoStop(const IChronoStatSvc::ChronoTag &chronoTag) override
Implementation of IChronoStatSvc::chronoStop.
Gaudi::Property< bool > m_chronoTableFlag
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
std::ofstream m_ofd
MSG::Level m_chronoPrintLevel
level of info printing
Gaudi::Property< bool > m_printEllapsedTime
std::string outputUserTime() const
print the chrono ;
T size(T...args)
STL class.
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
T begin(T...args)
Gaudi::Property< bool > m_statTableFlag
Gaudi::Property< std::string > m_statsOutFileName
Gaudi::Property< bool > m_chronoCoutFlag
T sort(T...args)
T is_open(T...args)
IChronoSvc::ChronoStatus stop()
stop the chrono
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
T reserve(T...args)
ChronoMap m_chronoEntities
chrono part
T emplace_back(T...args)
Gaudi::Property< bool > m_printSystemTime
Gaudi::Property< std::string > m_perEventFile
void ChronoStatSvc::handle ( const Incident incident)
override

Definition at line 547 of file ChronoStatSvc.cpp.

548 {
549 
550  if ( !m_ofd.is_open() ) return;
551 
552  for ( const auto& itr : m_chronoEntities ) {
553  if ( itr.first.find( ":Execute" ) == std::string::npos ) continue;
554 
555  auto itm = m_perEvtTime.find( itr.first );
556  if ( itm == m_perEvtTime.end() ) {
557  m_perEvtTime[itr.first] = {itr.second.delta( IChronoSvc::ELAPSED )};
558  } else {
559  itm->second.push_back( itr.second.delta( IChronoSvc::ELAPSED ) );
560  }
561  }
562 }
T end(T...args)
TimeMap m_perEvtTime
std::ofstream m_ofd
T find(T...args)
T is_open(T...args)
ChronoMap m_chronoEntities
chrono part
StatusCode ChronoStatSvc::initialize ( )
override

Implementation of IService::initialize()

start its own chrono

Definition at line 97 of file ChronoStatSvc.cpp.

98 {
100  if ( sc.isFailure() ) return sc;
102  // Set my own properties
103  sc = setProperties();
104 
105  if ( sc.isFailure() ) {
106  error() << "setting my properties" << endmsg;
107  return StatusCode::FAILURE;
108  }
109 
110  // only add an EndEvent listener if per-event output requested
111  if ( !m_perEventFile.empty() ) {
113  if ( !m_ofd.is_open() ) {
114  error() << "unable to open per-event output file \"" << m_perEventFile << "\"" << endmsg;
115  return StatusCode::FAILURE;
116  } else {
117  auto ii = serviceLocator()->service<IIncidentSvc>( "IncidentSvc" );
118  if ( !ii ) {
119  error() << "Unable to find IncidentSvc" << endmsg;
120  return StatusCode::FAILURE;
121  }
122  ii->addListener( this, IncidentType::EndEvent );
123  }
124  }
125 
127  m_printUserTime = true;
128  }
131  m_chronoTableFlag = true;
132  }
135  chronoStart( name() );
137  return StatusCode::SUCCESS;
138 }
constexpr static const auto FAILURE
Definition: StatusCode.h:88
StatusCode initialize() override
Definition: Service.cpp:63
T open(T...args)
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:288
Gaudi::Property< bool > m_printUserTime
bool isFailure() const
Definition: StatusCode.h:139
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:79
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:51
Gaudi::Property< bool > m_chronoTableFlag
std::ofstream m_ofd
StatusCode setProperties()
Method for setting declared properties to the values specified for the job.
Definition: Service.cpp:294
constexpr static const auto SUCCESS
Definition: StatusCode.h:87
Gaudi::Property< bool > m_printEllapsedTime
ChronoEntity * chronoStart(const IChronoStatSvc::ChronoTag &chronoTag) override
Implementation of IChronoStatSvc::chronoStart.
T is_open(T...args)
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:291
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
The interface implemented by the IncidentSvc service.
Definition: IIncidentSvc.h:23
Gaudi::Property< bool > m_printSystemTime
Gaudi::Property< std::string > m_perEventFile
void ChronoStatSvc::merge ( const ChronoStatSvc css)

Compound assignment operator.

Definition at line 56 of file ChronoStatSvc.cpp.

57 {
58 
59  // Add the content of the maps, leave the rest unchanged
60 
61  // Merge Chronomaps
62  for ( auto& item : css.m_chronoEntities ) {
63  const IChronoStatSvc::ChronoTag& key = item.first;
64  const ChronoEntity& val = item.second;
65  if ( m_chronoEntities.count( key ) )
66  m_chronoEntities[key] += val;
67  else
69  }
70 
71  // Merge StatMaps
72  for ( auto& item : css.m_statEntities ) {
73  const IChronoStatSvc::StatTag& key = item.first;
74  const StatEntity& val = item.second;
75  if ( m_statEntities.count( key ) )
76  m_statEntities[key] += val;
77  else
78  m_statEntities.emplace( key, val );
79  }
80 }
StatMap m_statEntities
stat part
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
T count(T...args)
T insert(T...args)
T emplace(T...args)
backward compatible StatEntity class.
Definition: Counters.h:777
ChronoMap m_chronoEntities
chrono part
ChronoStatSvc& ChronoStatSvc::operator= ( const ChronoStatSvc )
privatedelete
void ChronoStatSvc::printStats ( )
protected

nothing to print?

CONTINUE

CONTINUE

decoration

Definition at line 477 of file ChronoStatSvc.cpp.

478 {
480  if ( m_statEntities.empty() ) {
481  return;
482  }
483 
484  MsgStream log( msgSvc(), "******Stat******" );
486  const std::string stars( ( m_statCoutFlag ) ? 126 : 100, '*' );
488  if ( m_statCoutFlag ) {
489  std::cout << stars << std::endl;
490  std::cout << " The Final stat Table " << ( m_statOrderFlag ? "(ordered)" : "(not ordered)" ) << std::endl;
491  std::cout << stars << std::endl;
492  } else {
493  log << m_statPrintLevel << stars << endmsg;
494  log << m_statPrintLevel << " The Final stat Table " << ( m_statOrderFlag ? "(ordered)" : "(not ordered)" )
495  << endmsg;
496  log << m_statPrintLevel << stars << endmsg;
497  }
498 
499  {
500  // prepare container for printing
502  typedef std::vector<SPair> SCont;
503  SCont tmpCont;
505  []( StatMap::const_reference i ) { return std::make_pair( &i.second, &i.first ); } );
506  // sort it
507  if ( m_statOrderFlag ) std::sort( tmpCont.begin(), tmpCont.end(), CompareFirstOfPointerPair );
508  // print the table header
509  if ( m_statCoutFlag ) {
510  std::cout << m_header.value() << std::endl;
511  } else {
512  log << m_statPrintLevel << m_header.value() << endmsg;
513  }
514 
515  // loop over counters and print them:
516  for ( const auto& iter : tmpCont ) {
518  const StatEntity* entity = iter.first;
519  if ( !entity ) {
520  continue;
521  }
522  const StatTag* tag = iter.second;
523  if ( !tag ) {
524  continue;
525  }
526  if ( m_statCoutFlag ) {
528  entity->print( std::cout, true, *tag, m_useEffFormat, "%|-15.15s|%|17t|" );
529  } else {
530  std::ostringstream ost;
531  entity->print( ost, true, *tag, m_useEffFormat, "%|-15.15s|%|17t|" );
532  log << m_statPrintLevel << ost.str() << endmsg;
533  }
534  }
535  tmpCont.clear();
536  }
538  if ( m_statCoutFlag ) {
539  std::cout << stars << std::endl;
540  } else {
541  log << m_statPrintLevel << stars << endmsg;
542  }
543 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
T empty(T...args)
Gaudi::Property< std::string > m_header
StatMap m_statEntities
stat part
Gaudi::Property< bool > m_statCoutFlag
T endl(T...args)
T end(T...args)
STL class.
Gaudi::Property< bool > m_useEffFormat
constexpr struct CompareFirstOfPointerPair_t CompareFirstOfPointerPair
void clear(STATE_TYPE _i=std::ios_base::failbit)
Definition: MsgStream.h:187
Gaudi::Property< bool > m_statOrderFlag
T make_pair(T...args)
std::ostream & print(std::ostream &o, bool tableFormat, const std::string &name, bool flag=true, std::string fmtHead="%|-48.48s|%|27t|") const
Definition: Counters.h:889
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
STL class.
T begin(T...args)
T back_inserter(T...args)
MSG::Level m_statPrintLevel
level of info printing
T sort(T...args)
T transform(T...args)
backward compatible StatEntity class.
Definition: Counters.h:777
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
void ChronoStatSvc::saveStats ( )
private

dump the statistics into an ASCII file for offline processing

CONTINUE

CONTINUE

Definition at line 408 of file ChronoStatSvc.cpp.

409 {
410  std::ofstream out( m_statsOutFileName.value(), std::ios_base::out | std::ios_base::trunc );
411  if ( !out.good() ) {
412  info() << "Could not open the output file for writing chrono statistics [" << m_statsOutFileName.value() << "]"
413  << endmsg;
414  return;
415  } else {
416  // format it our way
417  out << std::scientific << std::setprecision( 8 );
418  }
419 
420  // ChronoEntity
422  chronos.reserve( m_chronoEntities.size() );
424  []( ChronoMap::const_reference i ) { return std::make_pair( &i.second, &i.first ); } );
425 
426  // sort it
427  std::sort( std::begin( chronos ), std::end( chronos ), CompareFirstOfPointerPair );
428 
429  // print User Time statistics
430  for ( const auto& iter : chronos ) {
431  //
432  const ChronoEntity* entity = iter.first;
433  if ( !entity ) {
434  continue;
435  }
436 
437  const ChronoTag* tag = iter.second;
438  if ( !tag ) {
439  continue;
440  }
441 
442  // create an entry in the .INI-like table
443  out << "\n[" << *tag << "]\n";
444 
445  // user
446  out << "cpu_user_total = " << entity->uTotalTime() << "\n";
447  out << "cpu_user_min = " << entity->uMinimalTime() << "\n";
448  out << "cpu_user_mean = " << entity->uMeanTime() << "\n";
449  out << "cpu_user_RMS = " << entity->uRMSTime() << "\n";
450  out << "cpu_user_max = " << entity->uMaximalTime() << "\n";
451  out << "cpu_user_nbr = " << entity->nOfMeasurements() << "\n";
452 
453  // system
454  out << "\n"; // just for clarity
455  out << "cpu_system_total = " << entity->kTotalTime() << "\n";
456  out << "cpu_system_min = " << entity->kMinimalTime() << "\n";
457  out << "cpu_system_mean = " << entity->kMeanTime() << "\n";
458  out << "cpu_system_RMS = " << entity->kRMSTime() << "\n";
459  out << "cpu_system_max = " << entity->kMaximalTime() << "\n";
460  out << "cpu_system_nbr = " << entity->nOfMeasurements() << "\n";
461 
462  // real
463  out << "\n"; // just for clarity
464  out << "cpu_real_total = " << entity->eTotalTime() << "\n";
465  out << "cpu_real_min = " << entity->eMinimalTime() << "\n";
466  out << "cpu_real_mean = " << entity->eMeanTime() << "\n";
467  out << "cpu_real_RMS = " << entity->eRMSTime() << "\n";
468  out << "cpu_real_max = " << entity->eMaximalTime() << "\n";
469  out << "cpu_real_nbr = " << entity->nOfMeasurements() << "\n";
470  }
471 
472  out << std::endl;
473 }
double kMaximalTime() const
maximal measurement for kernel time
Definition: ChronoEntity.h:199
double uMinimalTime() const
minimal measurement for user time
Definition: ChronoEntity.h:183
double uTotalTime() const
total user time
Definition: ChronoEntity.h:207
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
double kTotalTime() const
total Kernel time
Definition: ChronoEntity.h:211
T endl(T...args)
double uRMSTime() const
r.m.s User Time
Definition: ChronoEntity.h:239
T end(T...args)
double kMinimalTime() const
minimal measurement for kernel time
Definition: ChronoEntity.h:187
double eMinimalTime() const
minimal measurement for elapsed time
Definition: ChronoEntity.h:191
double kRMSTime() const
r.m.s Kernel Time
Definition: ChronoEntity.h:235
double kMeanTime() const
average Kernel Time
Definition: ChronoEntity.h:223
STL class.
double eMeanTime() const
average Elapsed Time
Definition: ChronoEntity.h:231
constexpr struct CompareFirstOfPointerPair_t CompareFirstOfPointerPair
T make_pair(T...args)
double eRMSTime() const
r.m.s Elapsed Time
Definition: ChronoEntity.h:243
T scientific(T...args)
double uMeanTime() const
average User Time
Definition: ChronoEntity.h:227
T size(T...args)
STL class.
T begin(T...args)
T back_inserter(T...args)
double eMaximalTime() const
maximal measurement for elapsed time
Definition: ChronoEntity.h:203
unsigned long nOfMeasurements() const
number of chrono measurements
Definition: ChronoEntity.h:179
Gaudi::Property< std::string > m_statsOutFileName
T sort(T...args)
T transform(T...args)
double uMaximalTime() const
maximal measurement for user time
Definition: ChronoEntity.h:195
T setprecision(T...args)
double eTotalTime() const
total Elapsed time
Definition: ChronoEntity.h:215
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
T reserve(T...args)
ChronoMap m_chronoEntities
chrono part
void ChronoStatSvc::stat ( const IChronoStatSvc::StatTag &  statTag,
const IChronoStatSvc::StatFlag &  statFlag 
)
override

Implementation of IChronoStatSvc::stat add statistical information to the entity , tagged by its name.

See also
IChronoStatSvc

Definition at line 356 of file ChronoStatSvc.cpp.

357 {
358  auto theIter = m_statEntities.find( statTag );
359 
360  StatEntity* theStat = nullptr;
361  // if new entity, specify the number of events to be skipped
362  if ( theIter == m_statEntities.end() ) {
363  // new stat entity
364  StatEntity& theSe = m_statEntities[statTag];
365  theStat = &theSe;
366  } else {
367  // existing stat entity
368  theStat = &theIter->second;
369  }
370 
371  theStat->addFlag( statFlag );
372 }
StatMap m_statEntities
stat part
T end(T...args)
T find(T...args)
unsigned long addFlag(const double v)
Definition: Counters.h:857
backward compatible StatEntity class.
Definition: Counters.h:777
StatEntity * ChronoStatSvc::stat ( const IChronoStatSvc::StatTag &  t)
override

extract the stat entity for the given tag (name)

See also
IChronoStatSvc
Parameters
tstat tag(name)
Returns
pointer to stat entity

Definition at line 400 of file ChronoStatSvc.cpp.

401 {
402  auto it = m_statEntities.find( t );
403  return m_statEntities.end() != it ? &( it->second ) : nullptr;
404 }
StatMap m_statEntities
stat part
T end(T...args)
T find(T...args)
void ChronoStatSvc::statPrint ( const IChronoStatSvc::ChronoTag &  statTag)
override

prints (using message service) info about statistical entity, tagged by its name

See also
IChronoStatSvc

Definition at line 376 of file ChronoStatSvc.cpp.

377 {
378  MsgStream log( msgSvc(), statTag );
380 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
StatMap m_statEntities
stat part
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
MSG::Level m_statPrintLevel
level of info printing
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

Member Data Documentation

Gaudi::Property<bool> ChronoStatSvc::m_chronoCoutFlag
private
Initial value:
{this, "ChronoDestinationCout", false,
"define the destination of the table to be printed"}

Definition at line 143 of file ChronoStatSvc.h.

ChronoMap ChronoStatSvc::m_chronoEntities
private

chrono part

Definition at line 132 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_chronoOrderFlag {this, "ChronoTableToBeOrdered", true, "should the printout be ordered"}
private

Definition at line 146 of file ChronoStatSvc.h.

MSG::Level ChronoStatSvc::m_chronoPrintLevel = MSG::INFO
private

level of info printing

Definition at line 134 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_chronoTableFlag
private
Initial value:
{this, "ChronoPrintOutTable", true,
"decide if the final printout should be performed"}

Definition at line 141 of file ChronoStatSvc.h.

Gaudi::Property<std::string> ChronoStatSvc::m_header
private
Initial value:
{
this, "StatTableHeader",
" Counter | # | sum | mean/eff^* | rms/err^* | min | max |",
"The header row for the output Stat-table"}

Definition at line 161 of file ChronoStatSvc.h.

Gaudi::Property<int> ChronoStatSvc::m_intChronoPrintLevel {this, "ChronoPrintLevel", MSG::INFO, "print level"}
private

Definition at line 145 of file ChronoStatSvc.h.

Gaudi::Property<int> ChronoStatSvc::m_intStatPrintLevel {this, "StatPrintLevel", MSG::INFO, "print level"}
private

Definition at line 154 of file ChronoStatSvc.h.

std::ofstream ChronoStatSvc::m_ofd
private

Definition at line 172 of file ChronoStatSvc.h.

Gaudi::Property<std::string> ChronoStatSvc::m_perEventFile {this, "PerEventFile", "", "File name for per-event deltas"}
private

Definition at line 168 of file ChronoStatSvc.h.

TimeMap ChronoStatSvc::m_perEvtTime
private

Definition at line 171 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_printEllapsedTime {this, "PrintEllapsedTime", false}
private

Definition at line 149 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_printSystemTime {this, "PrintSystemTime", false}
private

Definition at line 148 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_printUserTime {this, "PrintUserTime", true}
private

Definition at line 147 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_statCoutFlag
private
Initial value:
{this, "StatDestinationCout", false,
"define the destination of the table to be printed"}

Definition at line 152 of file ChronoStatSvc.h.

StatMap ChronoStatSvc::m_statEntities
private

stat part

Definition at line 137 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_statOrderFlag {this, "StatTableToBeOrdered", true, "should the printout be ordered"}
private

Definition at line 155 of file ChronoStatSvc.h.

MSG::Level ChronoStatSvc::m_statPrintLevel = MSG::INFO
private

level of info printing

Definition at line 139 of file ChronoStatSvc.h.

Gaudi::Property<std::string> ChronoStatSvc::m_statsOutFileName
private
Initial value:
{
this, "AsciiStatsOutputFile", "",
"Name of the output file storing the stats. If empty, no statistics will be saved (default)"}

Definition at line 157 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_statTableFlag
private
Initial value:
{this, "StatPrintOutTable", true,
"decide if the final printout should be performed"}

Definition at line 150 of file ChronoStatSvc.h.

Gaudi::Property<bool> ChronoStatSvc::m_useEffFormat
private
Initial value:
{this, "UseEfficiencyRowFormat", true,
"Use the special format for printout of efficiency counters"}

Definition at line 165 of file ChronoStatSvc.h.


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