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

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/ChronoStatSvc.h>

Inheritance diagram for ChronoStatSvc:

[legend]

Collaboration diagram for ChronoStatSvc:

[legend]

Public Types
using	ChronoMap = std::map<IChronoStatSvc::ChronoTag, ChronoEntity>
	some useful typedefs

using	StatMap = std::map<IChronoStatSvc::StatTag, StatEntity>

Public Types inherited from extends< Service, IChronoStatSvc, IIncidentListener >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

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
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Public Member Functions
StatusCode	initialize () override
	Implementation of IService::initialize()

StatusCode	finalize () override
	Implementation of IService::finalize()

ChronoEntity *	chronoStart (const IChronoStatSvc::ChronoTag &chronoTag) override
	Implementation of IChronoStatSvc::chronoStart.

const ChronoEntity *	chronoStop (const IChronoStatSvc::ChronoTag &chronoTag) override
	Implementation of IChronoStatSvc::chronoStop.

IChronoStatSvc::ChronoTime	chronoDelta (const IChronoStatSvc::ChronoTag &chronoTag, IChronoStatSvc::ChronoType theType) override
	Implementation of IchronoStatSvc::chronoDelta.

void	chronoPrint (const IChronoStatSvc::ChronoTag &chronoTag) override
	Implementation of IChronoStatSvc::chronoPrint.

ChronoStatus	chronoStatus (const IChronoStatSvc::ChronoTag &chronoTag) override
	Implementation of IChronoStatSvc::chronoStatus.

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.

void	statPrint (const IChronoStatSvc::ChronoTag &statTag) override
	prints (using message service) info about statistical entity, tagged by its name

const ChronoEntity *	chrono (const IChronoStatSvc::ChronoTag &t) const override
	extract the chrono entity for the given tag (name)

StatEntity *	stat (const IChronoStatSvc::StatTag &t) override
	extract the stat entity for the given tag (name)

	ChronoStatSvc (const std::string &name, ISvcLocator *svcloc)
	Default constructor.

void	merge (const ChronoStatSvc &css)
	Compound assignment operator.

void	handle (const Incident &incident) override

	~ChronoStatSvc () override=default

Public Member Functions inherited from extends< Service, IChronoStatSvc, IIncidentListener >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

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.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (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.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (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)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Protected Member Functions
void	printStats ()

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Private Types
using	TimeMap = std::map<ChronoTag, std::vector<IChronoSvc::ChronoTime>>

Private Member Functions
	ChronoStatSvc ()=delete

	ChronoStatSvc (const ChronoStatSvc &)=delete

ChronoStatSvc &	operator= (const ChronoStatSvc &)=delete

void	saveStats ()
	dump the statistics into an ASCII file for offline processing

bool	isMT () const

ChronoEntity &	getEntity (const ChronoTag &chronoTag)

Static Private Member Functions
static MSG::Level	int2level (int l)

Private Attributes
ChronoMap	m_chronoEntities
	chrono part

std::mutex	m_mutex
	Mutex protecting m_chronoEntities.

MSG::Level	m_chronoPrintLevel = MSG::INFO
	level of info printing

StatMap	m_statEntities
	stat part

MSG::Level	m_statPrintLevel = MSG::INFO
	level of info printing

Gaudi::Property< bool >	m_chronoTableFlag

Gaudi::Property< bool >	m_chronoCoutFlag

Gaudi::Property< int >	m_intChronoPrintLevel

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

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

Gaudi::Property< std::string >	m_statsOutFileName

Gaudi::Property< std::string >	m_header

Gaudi::Property< bool >	m_useEffFormat

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

ServiceHandle< IInterface >	m_hiveWhiteBoardSvc { this, "HiveWhiteBoardSvc", "EventDataSvc" }

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.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

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()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

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 @daate: December 1, 1999

Definition at line 46 of file ChronoStatSvc.h.

Member Typedef Documentation

◆ ChronoMap

using ChronoStatSvc::ChronoMap = std::map<IChronoStatSvc::ChronoTag, ChronoEntity>

some useful typedefs

Definition at line 50 of file ChronoStatSvc.h.

◆ StatMap

using ChronoStatSvc::StatMap = std::map<IChronoStatSvc::StatTag, StatEntity>

Definition at line 51 of file ChronoStatSvc.h.

◆ TimeMap

using ChronoStatSvc::TimeMap = std::map<ChronoTag, std::vector<IChronoSvc::ChronoTime>>

private

Definition at line 209 of file ChronoStatSvc.h.

Constructor & Destructor Documentation

◆ ChronoStatSvc() [1/3]

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

inline

Default constructor.

Parameters

name	service instance name
svcloc	pointer to service locator

Definition at line 118 of file ChronoStatSvc.h.

118: base_class( name, svcloc ) {}

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition Service.cpp:333

extends< Service, IChronoStatSvc, IIncidentListener >::base_class

extends base_class

Definition extends.h:23

◆ ChronoStatSvc() [2/3]

ChronoStatSvc::ChronoStatSvc ( )

privatedelete

◆ ChronoStatSvc() [3/3]

ChronoStatSvc::ChronoStatSvc ( const ChronoStatSvc & )

privatedelete

◆ ~ChronoStatSvc()

ChronoStatSvc::~ChronoStatSvc ( )

overridedefault

Member Function Documentation

◆ chrono()

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

override

extract the chrono entity for the given tag (name)

See also: IChronoStatSvc

Parameters

t	chrono tag(name)

Returns: pointer to chrono entity

Definition at line 344 of file ChronoStatSvc.cpp.

                                                                                  {
  auto lock = std::scoped_lock{ m_mutex };
  auto it   = m_chronoEntities.find( t );
  return m_chronoEntities.end() != it ? &( it->second ) : nullptr;
}

◆ chronoDelta()

IChronoStatSvc::ChronoTime ChronoStatSvc::chronoDelta	(	const IChronoStatSvc::ChronoTag &	chronoTag,
		IChronoStatSvc::ChronoType	theType )

override

Implementation of IchronoStatSvc::chronoDelta.

See also: IChronoStatSvc

Definition at line 293 of file ChronoStatSvc.cpp.

                                                                                                {
  return getEntity( chronoTag ).delta( theType );
}

◆ chronoPrint()

void ChronoStatSvc::chronoPrint ( const IChronoStatSvc::ChronoTag & chronoTag )

override

Implementation of IChronoStatSvc::chronoPrint.

See also: IChronoStatSvc

Definition at line 300 of file ChronoStatSvc.cpp.

                                                                          {
  MsgStream log( msgSvc(), chronoTag );
  if ( m_printUserTime ) { log << m_chronoPrintLevel << getEntity( chronoTag ).outputUserTime() << endmsg; }
  if ( m_printSystemTime ) { log << m_chronoPrintLevel << getEntity( chronoTag ).outputSystemTime() << endmsg; }
}

◆ chronoStart()

ChronoEntity * ChronoStatSvc::chronoStart ( const IChronoStatSvc::ChronoTag & chronoTag )

override

Implementation of IChronoStatSvc::chronoStart.

See also: IChronoStatSvc

Definition at line 277 of file ChronoStatSvc.cpp.

                                                                     {
  ChronoEntity& entity = getEntity( chronoTag );
  entity.start();
  return &entity;
}

◆ chronoStatus()

IChronoStatSvc::ChronoStatus ChronoStatSvc::chronoStatus ( const IChronoStatSvc::ChronoTag & chronoTag )

override

Implementation of IChronoStatSvc::chronoStatus.

See also: IChronoStatSvc

Definition at line 308 of file ChronoStatSvc.cpp.

                                                                                                 {
  return getEntity( chronoTag ).status();
}

◆ chronoStop()

const ChronoEntity * ChronoStatSvc::chronoStop ( const IChronoStatSvc::ChronoTag & chronoTag )

override

Implementation of IChronoStatSvc::chronoStop.

See also: IChronoStatSvc

Definition at line 285 of file ChronoStatSvc.cpp.

                                                                                        {
  ChronoEntity& entity = getEntity( chronoTag );
  entity.stop();
  return &entity;
}

◆ finalize()

StatusCode ChronoStatSvc::finalize ( )

override

Implementation of IService::finalize()

stop its own chrono

Is the final chrono table to be printed?

decoration

CONTINUE

stop chrono (if it is still in RUNNING status)

print to std::cout

print to MsgStream

decoration

CONTINUE

stop chrono (if it is still in RUNNING status)

print to std::cout

print to MsgStream

decoration

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 123 of file ChronoStatSvc.cpp.

                                   {
  std::string local = name() + ".finalize()";
  MsgStream main_log( msgSvc(), local );
  chronoStop( name() );
 
  if ( m_ofd.is_open() ) {
    debug() << "writing per-event timing data to '" << m_perEventFile << "'" << endmsg;
    for ( const auto& itr : m_perEvtTime ) {
      m_ofd << itr.first.substr( 0, itr.first.length() - 8 ) << " ";
      for ( const auto& itt : itr.second ) { m_ofd << " " << (long int)( itt ); }
      m_ofd << std::endl;
    }
 
    m_ofd.close();
  }
  if ( m_chronoTableFlag && !m_chronoEntities.empty() && ( m_printUserTime || m_printSystemTime ) ) {
    MsgStream         log( msgSvc(), "*****Chrono*****" );
    const std::string stars( ( m_chronoCoutFlag ) ? 126 : 100, '*' );
    if ( m_chronoCoutFlag ) {
      std::cout << stars << std::endl;
      if ( isMT() ) { std::cout << "WARNING: MT job; statistics are unreliable" << std::endl; }
      std::cout << local << " The Final CPU consumption (Chrono) Table "
                << ( m_chronoOrderFlag ? "(ordered)" : "(not ordered)" ) << std::endl;
      std::cout << stars << std::endl;
    } else {
      log << m_chronoPrintLevel << stars << endmsg;
      if ( isMT() ) { log << m_chronoPrintLevel << "WARNING: MT job; statistics are unreliable" << endmsg; }
      log << m_chronoPrintLevel << " The Final CPU consumption ( Chrono ) Table "
          << ( m_chronoOrderFlag ? "(ordered)" : "(not ordered)" ) << endmsg;
      log << m_chronoPrintLevel << stars << endmsg;
    }
    { // prepare container for printing
      std::vector<std::pair<ChronoEntity*, const ChronoTag*>> tmpCont;
      tmpCont.reserve( m_chronoEntities.size() );
      for ( auto& it : m_chronoEntities ) { tmpCont.emplace_back( &it.second, &it.first ); }
      // sort it
      if ( m_chronoOrderFlag ) std::sort( tmpCont.begin(), tmpCont.end(), CompareFirstOfPointerPair );
      // print User Time statistics
      if ( m_printUserTime ) {
        for ( auto iter = tmpCont.begin(); tmpCont.end() != iter; ++iter ) {
          //
          ChronoEntity* entity = iter->first;
          if ( !entity ) { continue; } 
          const ChronoTag* tag = iter->second;
          if ( !tag ) { continue; } 
          entity->stop(); 
          if ( m_chronoCoutFlag ) 
          {
            std::cout << *tag << "\t" << entity->outputUserTime() << std::endl;
          } else 
          {
            MsgStream( msgSvc(), *tag ) << m_chronoPrintLevel << entity->outputUserTime() << endmsg;
          }
          //
        }
      }
      if ( m_printSystemTime ) {
        if ( m_printUserTime && m_chronoCoutFlag ) {
          std::cout << stars << std::endl;
        } else if ( m_printUserTime && !m_chronoCoutFlag ) {
          log << m_chronoPrintLevel << stars << endmsg;
        }
        for ( auto iter = tmpCont.begin(); tmpCont.end() != iter; ++iter ) {
          ChronoEntity* entity = iter->first;
          if ( !entity ) { continue; } 
          const ChronoTag* tag = iter->second;
          if ( !tag ) { continue; } 
          entity->stop(); 
          if ( m_chronoCoutFlag ) 
          {
            std::cout << *tag << "\t" << entity->outputSystemTime() << std::endl;
          } else 
          {
            MsgStream( msgSvc(), *tag ) << m_chronoPrintLevel << entity->outputSystemTime() << endmsg;
          }
          //
        }
      }
      if ( m_printEllapsedTime ) {
        if ( ( m_printUserTime || m_printSystemTime ) && m_chronoCoutFlag ) {
          std::cout << stars << std::endl;
        } else if ( ( m_printUserTime || m_printSystemTime ) && !m_chronoCoutFlag ) {
          log << m_chronoPrintLevel << stars << endmsg;
        }
        for ( const auto& i : tmpCont ) {
          ChronoEntity* entity = i.first;
          if ( !entity ) { continue; } 
          const ChronoTag* tag = i.second;
          if ( !tag ) { continue; } 
          entity->stop(); 
          if ( m_chronoCoutFlag ) 
          {
            std::cout << *tag << "\t" << entity->outputElapsedTime() << std::endl;
          } else 
          {
            MsgStream( msgSvc(), *tag ) << m_chronoPrintLevel << entity->outputElapsedTime() << endmsg;
          }
          //
        }
      }
      tmpCont.clear(); 
    }
    if ( m_chronoCoutFlag ) {
      std::cout << stars << std::endl;
    } else {
      log << m_chronoPrintLevel << stars << endmsg;
    }
  }
  if ( m_statTableFlag ) { printStats(); }
 
  if ( !m_statsOutFileName.value().empty() ) { saveStats(); }
 
  // clear the maps.
  m_chronoEntities.clear();
  m_perEvtTime.clear();
  m_statEntities.clear();
 
  main_log << MSG::INFO << " Service finalized successfully " << endmsg;
 
  return Service::finalize(); 
}

◆ getEntity()

ChronoEntity & ChronoStatSvc::getEntity ( const ChronoTag & chronoTag )

inlineprivate

Definition at line 150 of file ChronoStatSvc.h.

                                                        {
    auto lock = std::scoped_lock{ m_mutex };
    return m_chronoEntities[chronoTag];
  }

◆ handle()

void ChronoStatSvc::handle ( const Incident & incident )

override

Definition at line 509 of file ChronoStatSvc.cpp.

                                              {
 
  if ( !m_ofd.is_open() ) return;
 
  auto lock = std::scoped_lock{ m_mutex };
  for ( const auto& itr : m_chronoEntities ) {
    if ( itr.first.find( ":Execute" ) == std::string::npos ) continue;
 
    auto itm = m_perEvtTime.find( itr.first );
    if ( itm == m_perEvtTime.end() ) {
      m_perEvtTime[itr.first] = { itr.second.delta( IChronoSvc::ELAPSED ) };
    } else {
      itm->second.push_back( itr.second.delta( IChronoSvc::ELAPSED ) );
    }
  }
}

◆ initialize()

StatusCode ChronoStatSvc::initialize ( )

override

Implementation of IService::initialize()

start its own chrono

Definition at line 91 of file ChronoStatSvc.cpp.

                                     {
  StatusCode sc = Service::initialize();
  if ( sc.isFailure() ) return sc;
 
  // only add an EndEvent listener if per-event output requested
  if ( !m_perEventFile.empty() ) {
    m_ofd.open( m_perEventFile );
    if ( !m_ofd.is_open() ) {
      error() << "unable to open per-event output file \"" << m_perEventFile << "\"" << endmsg;
      return StatusCode::FAILURE;
    } else {
      auto ii = serviceLocator()->service<IIncidentSvc>( "IncidentSvc" );
      if ( !ii ) {
        error() << "Unable to find IncidentSvc" << endmsg;
        return StatusCode::FAILURE;
      }
      ii->addListener( this, IncidentType::EndEvent );
    }
  }
 
  if ( m_chronoTableFlag && !m_printUserTime && !m_printSystemTime && !m_printEllapsedTime ) { m_printUserTime = true; }
  if ( m_printUserTime || m_printSystemTime || m_printEllapsedTime ) { m_chronoTableFlag = true; }
  chronoStart( name() );
  return StatusCode::SUCCESS;
}

◆ int2level()

static MSG::Level ChronoStatSvc::int2level ( int l )

inlinestaticprivate

Definition at line 156 of file ChronoStatSvc.h.

                                     {
    return static_cast<MSG::Level>(
        std::max( std::min( l, static_cast<int>( MSG::FATAL ) ), static_cast<int>( MSG::NIL ) ) );
  }

◆ isMT()

bool ChronoStatSvc::isMT ( ) const

private

Definition at line 430 of file ChronoStatSvc.cpp.

                               {
  bool isMT = false;
  if ( m_hiveWhiteBoardSvc.retrieve().isFailure() ) {
    error() << "Cannot retrieve HiveWhiteBoardSvc";
  } else {
    // In non-MT mode, `EventDataSvc' does not have an IHiveWhiteBoard interface.
    const SmartIF<IHiveWhiteBoard> wb( m_hiveWhiteBoardSvc.get() );
    if ( wb && wb->getNumberOfStores() > 1 ) { isMT = true; }
  }
  return isMT;
}

◆ merge()

void ChronoStatSvc::merge ( const ChronoStatSvc & css )

Compound assignment operator.

Definition at line 63 of file ChronoStatSvc.cpp.

                                                    {
 
  // Add the content of the maps, leave the rest unchanged
 
  auto lock = std::scoped_lock{ m_mutex, css.m_mutex };
  // Merge Chronomaps
  for ( auto& item : css.m_chronoEntities ) {
    const IChronoStatSvc::ChronoTag& key = item.first;
    const ChronoEntity&              val = item.second;
    if ( m_chronoEntities.count( key ) )
      m_chronoEntities[key] += val;
    else
      m_chronoEntities.insert( std::pair<IChronoStatSvc::ChronoTag, ChronoEntity>( key, val ) );
  }
 
  // Merge StatMaps
  for ( auto& item : css.m_statEntities ) {
    const IChronoStatSvc::StatTag& key = item.first;
    const StatEntity&              val = item.second;
    if ( m_statEntities.count( key ) )
      m_statEntities[key] += val;
    else
      m_statEntities.emplace( key, val );
  }
}

◆ operator=()

ChronoStatSvc & ChronoStatSvc::operator= ( const ChronoStatSvc & )

privatedelete

◆ printStats()

void ChronoStatSvc::printStats ( )

protected

nothing to print?

CONTINUE

decoration

Definition at line 444 of file ChronoStatSvc.cpp.

                               {
  if ( m_statEntities.empty() ) { return; }
 
  MsgStream log( msgSvc(), "******Stat******" );
  const std::string stars( ( m_statCoutFlag ) ? 126 : 100, '*' );
  if ( m_statCoutFlag ) {
    std::cout << stars << std::endl;
    if ( isMT() ) { std::cout << "WARNING: MT job; statistics are unreliable" << std::endl; }
    std::cout << " The Final stat Table " << ( m_statOrderFlag ? "(ordered)" : "(not ordered)" ) << std::endl;
    std::cout << stars << std::endl;
  } else {
    log << m_statPrintLevel << stars << endmsg;
    if ( isMT() ) { log << (MSG::Level)m_chronoPrintLevel << "WARNING: MT job; statistics are unreliable" << endmsg; }
    log << m_statPrintLevel << " The Final stat Table " << ( m_statOrderFlag ? "(ordered)" : "(not ordered)" )
        << endmsg;
    log << m_statPrintLevel << stars << endmsg;
  }
 
  {
    // prepare container for printing
    typedef std::pair<const StatEntity*, const StatTag*> SPair;
    typedef std::vector<SPair>                           SCont;
    SCont                                                tmpCont;
    std::transform( std::begin( m_statEntities ), std::end( m_statEntities ), std::back_inserter( tmpCont ),
                    []( StatMap::const_reference i ) { return std::make_pair( &i.second, &i.first ); } );
    // sort it
    if ( m_statOrderFlag ) std::sort( tmpCont.begin(), tmpCont.end(), CompareFirstOfPointerPair );
    // print the table header
    if ( m_statCoutFlag ) {
      std::cout << m_header.value() << std::endl;
    } else {
      log << m_statPrintLevel << m_header.value() << endmsg;
    }
 
    // loop over counters and print them:
    for ( const auto& iter : tmpCont ) {
      const StatEntity* entity = iter.first;
      if ( !entity ) { continue; } 
      const StatTag* tag = iter.second;
      if ( !tag ) { continue; } 
      if ( m_statCoutFlag ) {
        entity->print( std::cout, true, *tag, m_useEffFormat, "%|-15.15s|%|17t|" );
      } else {
        std::ostringstream ost;
        entity->print( ost, true, *tag, m_useEffFormat, "%|-15.15s|%|17t|" );
        log << m_statPrintLevel << ost.str() << endmsg;
      }
    }
    tmpCont.clear();
  }
  if ( m_statCoutFlag ) {
    std::cout << stars << std::endl;
  } else {
    log << m_statPrintLevel << stars << endmsg;
  }
}

◆ saveStats()

void ChronoStatSvc::saveStats ( )

private

dump the statistics into an ASCII file for offline processing

CONTINUE

Definition at line 363 of file ChronoStatSvc.cpp.

                              {
  std::ofstream out( m_statsOutFileName.value(), std::ios_base::out | std::ios_base::trunc );
  if ( !out.good() ) {
    info() << "Could not open the output file for writing chrono statistics [" << m_statsOutFileName.value() << "]"
           << endmsg;
    return;
  } else {
    // format it our way
    out << std::scientific << std::setprecision( 8 );
  }
 
  // ChronoEntity
  std::vector<std::pair<const ChronoEntity*, const ChronoTag*>> chronos;
  {
    auto lock = std::scoped_lock{ m_mutex };
    chronos.reserve( m_chronoEntities.size() );
    std::transform( std::begin( m_chronoEntities ), std::end( m_chronoEntities ), std::back_inserter( chronos ),
                    []( ChronoMap::const_reference i ) { return std::make_pair( &i.second, &i.first ); } );
  }
 
  // sort it
  std::sort( std::begin( chronos ), std::end( chronos ), CompareFirstOfPointerPair );
 
  // print User Time statistics
  for ( const auto& iter : chronos ) {
    //
    const ChronoEntity* entity = iter.first;
    if ( !entity ) { continue; } 
 
    const ChronoTag* tag = iter.second;
    if ( !tag ) { continue; } 
 
    // create an entry in the .INI-like table
    out << "\n[" << *tag << "]\n";
 
    // user
    out << "cpu_user_total = " << entity->uTotalTime() << "\n";
    out << "cpu_user_min = " << entity->uMinimalTime() << "\n";
    out << "cpu_user_mean = " << entity->uMeanTime() << "\n";
    out << "cpu_user_RMS = " << entity->uRMSTime() << "\n";
    out << "cpu_user_max = " << entity->uMaximalTime() << "\n";
    out << "cpu_user_nbr = " << entity->nOfMeasurements() << "\n";
 
    // system
    out << "\n"; // just for clarity
    out << "cpu_system_total = " << entity->kTotalTime() << "\n";
    out << "cpu_system_min = " << entity->kMinimalTime() << "\n";
    out << "cpu_system_mean = " << entity->kMeanTime() << "\n";
    out << "cpu_system_RMS = " << entity->kRMSTime() << "\n";
    out << "cpu_system_max = " << entity->kMaximalTime() << "\n";
    out << "cpu_system_nbr = " << entity->nOfMeasurements() << "\n";
 
    // real
    out << "\n"; // just for clarity
    out << "cpu_real_total = " << entity->eTotalTime() << "\n";
    out << "cpu_real_min = " << entity->eMinimalTime() << "\n";
    out << "cpu_real_mean = " << entity->eMeanTime() << "\n";
    out << "cpu_real_RMS = " << entity->eRMSTime() << "\n";
    out << "cpu_real_max = " << entity->eMaximalTime() << "\n";
    out << "cpu_real_nbr = " << entity->nOfMeasurements() << "\n";
  }
 
  out << std::endl;
}

◆ stat() [1/2]

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 314 of file ChronoStatSvc.cpp.

                                                                                                       {
  auto theIter = m_statEntities.find( statTag );
 
  StatEntity* theStat = nullptr;
  // if new entity, specify the number of events to be skipped
  if ( theIter == m_statEntities.end() ) {
    // new stat entity
    StatEntity& theSe = m_statEntities[statTag];
    theStat           = &theSe;
  } else {
    // existing stat entity
    theStat = &theIter->second;
  }
 
  theStat->addFlag( statFlag );
}

◆ stat() [2/2]

StatEntity * ChronoStatSvc::stat ( const IChronoStatSvc::StatTag & t )

override

extract the stat entity for the given tag (name)

See also: IChronoStatSvc

Parameters

t	stat tag(name)

Returns: pointer to stat entity

Definition at line 356 of file ChronoStatSvc.cpp.

                                                                {
  auto it = m_statEntities.find( t );
  return m_statEntities.end() != it ? &( it->second ) : nullptr;
}

◆ statPrint()

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 333 of file ChronoStatSvc.cpp.

                                                                    {
  MsgStream log( msgSvc(), statTag );
  log << m_statPrintLevel << m_statEntities[statTag] << endmsg;
}

Member Data Documentation

◆ m_chronoCoutFlag

Gaudi::Property<bool> ChronoStatSvc::m_chronoCoutFlag

private

Initial value:

{ this, "ChronoDestinationCout", false,

"define the destination of the table to be printed" }

Definition at line 176 of file ChronoStatSvc.h.

176 { this, "ChronoDestinationCout", false,

177 "define the destination of the table to be printed" };

◆ m_chronoEntities

ChronoMap ChronoStatSvc::m_chronoEntities

private

chrono part

Definition at line 162 of file ChronoStatSvc.h.

◆ m_chronoOrderFlag

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

private

Definition at line 181 of file ChronoStatSvc.h.

181{ this, "ChronoTableToBeOrdered", true, "should the printout be ordered" };

◆ m_chronoPrintLevel

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

private

level of info printing

Definition at line 167 of file ChronoStatSvc.h.

◆ m_chronoTableFlag

Gaudi::Property<bool> ChronoStatSvc::m_chronoTableFlag

private

Initial value:

{ this, "ChronoPrintOutTable", true,

"decide if the final printout should be performed" }

Definition at line 174 of file ChronoStatSvc.h.

174 { this, "ChronoPrintOutTable", true,

175 "decide if the final printout should be performed" };

◆ m_header

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 198 of file ChronoStatSvc.h.

                                   {
      this, "StatTableHeader",
      " |    Counter     |     #     |    sum     | mean/eff^* | rms/err^*  |     min     |     max     |",
      "The header row for the output Stat-table" };

◆ m_hiveWhiteBoardSvc

ServiceHandle<IInterface> ChronoStatSvc::m_hiveWhiteBoardSvc { this, "HiveWhiteBoardSvc", "EventDataSvc" }

private

Definition at line 207 of file ChronoStatSvc.h.

207{ this, "HiveWhiteBoardSvc", "EventDataSvc" };

◆ m_intChronoPrintLevel

Gaudi::Property<int> ChronoStatSvc::m_intChronoPrintLevel

private

Initial value:

{
      this, "ChronoPrintLevel", MSG::INFO, [this]( auto& ) { m_chronoPrintLevel = int2level( m_intChronoPrintLevel ); },
      "print level" }

Definition at line 178 of file ChronoStatSvc.h.

                                           {
      this, "ChronoPrintLevel", MSG::INFO, [this]( auto& ) { m_chronoPrintLevel = int2level( m_intChronoPrintLevel ); },
      "print level" };

◆ m_intStatPrintLevel

Gaudi::Property<int> ChronoStatSvc::m_intStatPrintLevel

private

Initial value:

{ this, "StatPrintLevel", MSG::INFO,
                                            [this]( auto& ) { m_statPrintLevel = int2level( m_intStatPrintLevel ); },
                                            "print level" }

Definition at line 189 of file ChronoStatSvc.h.

                                         { this, "StatPrintLevel", MSG::INFO,
                                            [this]( auto& ) { m_statPrintLevel = int2level( m_intStatPrintLevel ); },
                                            "print level" };

◆ m_mutex

std::mutex ChronoStatSvc::m_mutex

mutableprivate

Mutex protecting m_chronoEntities.

Definition at line 164 of file ChronoStatSvc.h.

◆ m_ofd

std::ofstream ChronoStatSvc::m_ofd

private

Definition at line 211 of file ChronoStatSvc.h.

◆ m_perEventFile

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

private

Definition at line 205 of file ChronoStatSvc.h.

205{ this, "PerEventFile", "", "File name for per-event deltas" };

◆ m_perEvtTime

TimeMap ChronoStatSvc::m_perEvtTime

private

Definition at line 210 of file ChronoStatSvc.h.

◆ m_printEllapsedTime

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

private

Definition at line 184 of file ChronoStatSvc.h.

184{ this, "PrintEllapsedTime", false };

◆ m_printSystemTime

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

private

Definition at line 183 of file ChronoStatSvc.h.

183{ this, "PrintSystemTime", false };

◆ m_printUserTime

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

private

Definition at line 182 of file ChronoStatSvc.h.

182{ this, "PrintUserTime", true };

◆ m_statCoutFlag

Gaudi::Property<bool> ChronoStatSvc::m_statCoutFlag

private

Initial value:

{ this, "StatDestinationCout", false,

"define the destination of the table to be printed" }

Definition at line 187 of file ChronoStatSvc.h.

187 { this, "StatDestinationCout", false,

188 "define the destination of the table to be printed" };

◆ m_statEntities

StatMap ChronoStatSvc::m_statEntities

private

stat part

Definition at line 170 of file ChronoStatSvc.h.

◆ m_statOrderFlag

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

private

Definition at line 192 of file ChronoStatSvc.h.

192{ this, "StatTableToBeOrdered", true, "should the printout be ordered" };

◆ m_statPrintLevel

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

private

level of info printing

Definition at line 172 of file ChronoStatSvc.h.

◆ m_statsOutFileName

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 194 of file ChronoStatSvc.h.

                                             {
      this, "AsciiStatsOutputFile", "",
      "Name of the output file storing the stats. If empty, no statistics will be saved (default)" };

◆ m_statTableFlag

Gaudi::Property<bool> ChronoStatSvc::m_statTableFlag

private

Initial value:

{ this, "StatPrintOutTable", true,

"decide if the final printout should be performed" }

Definition at line 185 of file ChronoStatSvc.h.

185 { this, "StatPrintOutTable", true,

186 "decide if the final printout should be performed" };

◆ m_useEffFormat

Gaudi::Property<bool> ChronoStatSvc::m_useEffFormat

private

Initial value:

{ this, "UseEfficiencyRowFormat", true,

"Use the special format for printout of efficiency counters" }

Definition at line 202 of file ChronoStatSvc.h.

202 { this, "UseEfficiencyRowFormat", true,

203 "Use the special format for printout of efficiency counters" };

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

GaudiCommonSvc/src/ChronoStatSvc.h
GaudiCommonSvc/src/ChronoStatSvc.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ChronoMap

◆ StatMap

◆ TimeMap

Constructor & Destructor Documentation

◆ ChronoStatSvc() [1/3]

◆ ChronoStatSvc() [2/3]

◆ ChronoStatSvc() [3/3]

◆ ~ChronoStatSvc()

Member Function Documentation

◆ chrono()

◆ chronoDelta()

◆ chronoPrint()

◆ chronoStart()

◆ chronoStatus()

◆ chronoStop()

◆ finalize()

◆ getEntity()

◆ handle()

◆ initialize()

◆ int2level()

◆ isMT()

◆ merge()

◆ operator=()

◆ printStats()

◆ saveStats()

◆ stat() [1/2]

◆ stat() [2/2]

◆ statPrint()

Member Data Documentation

◆ m_chronoCoutFlag

◆ m_chronoEntities

◆ m_chronoOrderFlag

◆ m_chronoPrintLevel

◆ m_chronoTableFlag

◆ m_header

◆ m_hiveWhiteBoardSvc

◆ m_intChronoPrintLevel

◆ m_intStatPrintLevel

◆ m_mutex

◆ m_ofd

◆ m_perEventFile

◆ m_perEvtTime

◆ m_printEllapsedTime

◆ m_printSystemTime

◆ m_printUserTime

◆ m_statCoutFlag

◆ m_statEntities

◆ m_statOrderFlag

◆ m_statPrintLevel

◆ m_statsOutFileName

◆ m_statTableFlag

◆ m_useEffFormat