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:

[legend]

Collaboration diagram for ChronoStatSvc:

[legend]

Public Types
typedef std::map< IChronoStatSvc::ChronoTag, ChronoEntity >	ChronoMap
	some useful typedefs More...

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

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
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

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...

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

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

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

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

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

virtual 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...

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

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

virtual const StatEntity *	stat (const IChronoStatSvc::StatTag &t) const 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...

	~ChronoStatSvc () override=default
	Destructor. 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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from Service
const std::string &	name () 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...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value 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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public 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 CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

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

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

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

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

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

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

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

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

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

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

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

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

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. 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 CommonMessaging< implements< IService, IProperty, IStateful > >
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

ChronoStatSvc &	operator= (const ChronoStatSvc &)=delete

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

Private Attributes
ChronoMap	m_chronoEntities
	chrono part More...

int	m_intChronoPrintLevel
	level of info printing More...

MSG::Level	m_chronoPrintLevel = MSG::INFO

bool	m_chronoTableFlag
	flag for printing the final table More...

bool	m_chronoCoutFlag
	flag for destination of the the final table More...

bool	m_chronoOrderFlag
	flag for formattion the final statistic table More...

bool	m_printUserTime
	flag for printing User quantities More...

bool	m_printSystemTime
	flag for printing System quantities More...

bool	m_printEllapsedTime
	flag for printing Ellapsed quantities More...

long	m_numberOfSkippedEventsForMemStat

StatMap	m_statEntities
	stat part More...

int	m_intStatPrintLevel
	level of info printing More...

MSG::Level	m_statPrintLevel = MSG::INFO

bool	m_statTableFlag
	flag for printing the final table More...

bool	m_statCoutFlag
	flag for destination of the t he final table More...

bool	m_statOrderFlag
	flag for formattion the final statistic table More...

StringProperty	m_statsOutFileName
	Name of the output file where we'll dump the stats. More...

std::string	m_header
	the header row More...

std::string	m_format1
	format for regular statistical printout rows More...

std::string	m_format2
	format for "efficiency" statistical printout rows More...

bool	m_useEffFormat = true
	flag to use the special "efficiency" format More...

TimeMap	m_perEvtTime

std::string	m_perEventFile

std::ofstream	m_ofd

Additional Inherited Members
Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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 39 of file ChronoStatSvc.h.

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

Definition at line 40 of file ChronoStatSvc.h.

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

private

Definition at line 192 of file ChronoStatSvc.h.

Constructor & Destructor Documentation

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

Default constructor.

Parameters

name	service instance name
svcloc	pointer to servcie locator

decide if the final printout should be performed

define the destination of the table to be printed

print level

if printout is to be performed, should one take care about some ordering?

if User Time information to be printed?

if System Time information to be printed?

if Ellapsed Time information to be printed?

deside if the final printout should be performed

define the destination of the table to be printed

print level

if printout is to be performed, should one take care about some ordering?

Definition at line 60 of file ChronoStatSvc.cpp.

   : base_class( name , svcloc )
   //
   // the header row
   , m_header  ( "     Counter     |     #     |    sum     | mean/eff^* | rms/err^*  |     min     |     max     |")
   // format for regular statistical printout rows
   , m_format1 ( " %|-15.15s|%|17t||%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |" )
   // format for "efficiency" statistical printout rows
   , m_format2 ( "*%|-15.15s|%|17t||%|10d| |%|11.5g| |(%|#9.7g| +- %|-#9.7g|)%%|   -------   |   -------   |" )
 {
   declareProperty ( "ChronoPrintOutTable"    ,
                     m_chronoTableFlag      = true      );
   declareProperty ( "ChronoDestinationCout"  ,
                     m_chronoCoutFlag       = false     );
   declareProperty ( "ChronoPrintLevel"       ,
                     m_intChronoPrintLevel  = MSG::INFO );
   declareProperty ( "ChronoTableToBeOrdered" ,
                     m_chronoOrderFlag      = true      );
   declareProperty ( "PrintUserTime"          ,
                     m_printUserTime        = true      );
   declareProperty ( "PrintSystemTime"        ,
                     m_printSystemTime      = false     );
   declareProperty ( "PrintEllapsedTime"      ,
                     m_printEllapsedTime    = false     );
   declareProperty ( "StatPrintOutTable"      ,
                     m_statTableFlag        = true      );
   declareProperty ( "StatDestinationCout"    ,
                     m_statCoutFlag         = false     );
   declareProperty ( "StatPrintLevel"         ,
                     m_intStatPrintLevel    = MSG::INFO );
   declareProperty ( "StatTableToBeOrdered"   ,
                     m_statOrderFlag        = true      );
 
   // specify the number of events to be skipped by the memory auditor
   // in order to better spot memory leak
   declareProperty ( "NumberOfSkippedEventsForMemStat"      ,
                     m_numberOfSkippedEventsForMemStat = -1 ) ;
 
   declareProperty( "AsciiStatsOutputFile",
            m_statsOutFileName = "",
            "Name of the output file storing the stats. If empty, no"
            " statistics will be saved (default)" );
 
   declareProperty
     ( "StatTableHeader"        , m_header                          ,
       "The header row for the output Stat-table"                   ) ;
   declareProperty
     ( "RegularRowFormat"       , m_format1                         ,
       "The format for the regular row in the output Stat-table"    ) ;
   declareProperty
     ( "EfficiencyRowFormat"    , m_format2                         ,
       "The format for the regular row in the output Stat-table"    ) ;
   declareProperty
     ( "UseEfficiencyRowFormat" , m_useEffFormat                    ,
       "Use the special format for printout of efficiency counters" ) ;
 
   declareProperty
     ( "PerEventFile", m_perEventFile="",
       "File name for per-event deltas" );
 
 }

ChronoStatSvc::~ChronoStatSvc ( )

overridedefault

Destructor.

ChronoStatSvc::ChronoStatSvc ( )

privatedelete

ChronoStatSvc::ChronoStatSvc ( const ChronoStatSvc & )

privatedelete

Member Function Documentation

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

overridevirtual

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

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

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

overridevirtual

Implementation of IchronoStatSvc::chronoDelta.

See also: IChronoStatSvc

Definition at line 410 of file ChronoStatSvc.cpp.

 {
   return m_chronoEntities[ chronoTag ].delta( theType );
 }

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

overridevirtual

Implementation of IChronoStatSvc::chronoPrint.

See also: IChronoStatSvc

Definition at line 419 of file ChronoStatSvc.cpp.

 {
   MsgStream log ( msgSvc() , chronoTag );
   if( m_printUserTime   ) {
     log << (MSG::Level) m_chronoPrintLevel
         << m_chronoEntities[ chronoTag ].outputUserTime  ()
     << endmsg;
   }
   if( m_printSystemTime ) {
     log << (MSG::Level) m_chronoPrintLevel
         << m_chronoEntities[ chronoTag ].outputSystemTime()
     << endmsg;
   }
 }

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

overridevirtual

Implementation of IChronoStatSvc::chronoStart.

See also: IChronoStatSvc

Definition at line 388 of file ChronoStatSvc.cpp.

 {
   ChronoEntity& entity = m_chronoEntities [ chronoTag ] ;
   entity.start() ;
   return &entity ;
 }

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

overridevirtual

Implementation of IChronoStatSvc::chronoStatus.

See also: IChronoStatSvc

Definition at line 438 of file ChronoStatSvc.cpp.

439 { return m_chronoEntities[ chronoTag ].status(); }

ChronoStatSvc::m_chronoEntities

ChronoMap m_chronoEntities

chrono part

Definition: ChronoStatSvc.h:146

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

overridevirtual

Implementation of IChronoStatSvc::chronoStop.

See also: IChronoStatSvc

Definition at line 399 of file ChronoStatSvc.cpp.

 {
   ChronoEntity& entity = m_chronoEntities [ chronoTag ] ;
   entity.stop() ;
   return &entity ;
 }

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 229 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;
       std::cout << local <<  " The Final CPU consumption (Chrono) Table "
             << ( m_chronoOrderFlag ? "(ordered)" : "(not ordered)" ) << std::endl;
       std::cout << stars << std::endl;
     }
       else
     {
       log << (MSG::Level) m_chronoPrintLevel
         << stars << endmsg;
       log << (MSG::Level) m_chronoPrintLevel
         << " The Final CPU consumption ( Chrono ) Table "
           << ( m_chronoOrderFlag ? "(ordered)" : "(not ordered)" ) << endmsg;
       log << (MSG::Level) 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 << (MSG::Level) 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 << (MSG::Level) 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();
   }
 
   main_log << MSG::INFO << " Service finalized successfully " << endmsg;
 
   return Service::finalize(); 
 }

void ChronoStatSvc::handle ( const Incident & incident )

override

Definition at line 649 of file ChronoStatSvc.cpp.

                                             {
 
   if (! m_ofd.is_open()) return;
 
   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) );
     }
   }
 }

StatusCode ChronoStatSvc::initialize ( )

override

Implementation of IService::initialize()

redefine some "properties"

start its own chrono

Definition at line 166 of file ChronoStatSvc.cpp.

 {
   StatusCode sc = Service::initialize();
   if ( sc.isFailure() ) return sc;
   // Set my own properties
   sc = setProperties();
 
   if (sc.isFailure()) {
     error() << "setting my properties" << endmsg;
     return StatusCode::FAILURE;
   }
 
   // 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);
     }
   }
 
   info() << " Number of skipped events for MemStat"
       << m_numberOfSkippedEventsForMemStat << endmsg ;
 
   m_statPrintLevel =
     ( MSG::FATAL < m_intStatPrintLevel   ) ? MSG::FATAL :
     ( MSG::NIL   > m_intStatPrintLevel   ) ? MSG::NIL   :
     ( MSG::Level ) m_intStatPrintLevel  ;
   m_chronoPrintLevel =
     ( MSG::FATAL < m_intChronoPrintLevel ) ? MSG::FATAL :
     ( MSG::NIL   > m_intChronoPrintLevel ) ? MSG::NIL   :
     ( MSG::Level ) m_intChronoPrintLevel ;
   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;
 }

void ChronoStatSvc::merge ( const ChronoStatSvc & css )

Compound assignment operator.

Definition at line 138 of file ChronoStatSvc.cpp.

                                                    {
 
     // Add the content of the maps, leave the rest unchanged
 
     // 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.insert (std::pair<IChronoStatSvc::StatTag,StatEntity>(key,val));
     }
 
 }

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

privatedelete

void ChronoStatSvc::printStats ( )

protected

nothing to print?

CONTINUE

decoration

Definition at line 576 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;
       std::cout <<  " The Final stat Table "
               << ( m_statOrderFlag ? "(ordered)" : "(not ordered)" ) << std::endl;
       std::cout << stars << std::endl;
     }
   else
   {
       log << m_statPrintLevel << stars << 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 << std::endl ; }
     else                  { log       << m_statPrintLevel << m_header << 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 )
       {
         std::cout
           << Gaudi::Utils::formatAsTableRow
           ( *tag , *entity , m_useEffFormat , m_format1 , m_format2 )
           << std::endl;
       }
         else
       {
         log
           << m_statPrintLevel
           << Gaudi::Utils::formatAsTableRow
           ( *tag , *entity , m_useEffFormat , m_format1 , m_format2 )
           << endmsg ;
       }
       }
     tmpCont.clear();
   }
   if ( m_statCoutFlag  ) { std::cout << stars << std::endl;            }
   else                   { log << m_statPrintLevel << stars << endmsg; }
 }

void ChronoStatSvc::saveStats ( )

private

dump the statistics into an ASCII file for offline processing

CONTINUE

Definition at line 503 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;
   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;
 }

void ChronoStatSvc::stat	(	const IChronoStatSvc::StatTag &	statTag,
		const IChronoStatSvc::StatFlag &	statFlag
	)

overridevirtual

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

See also: IChronoStatSvc

Definition at line 444 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;
     theStat->setnEntriesBeforeReset(m_numberOfSkippedEventsForMemStat);
   }
   else
   {
     //existing stat entity
     theStat=&theIter->second;
   }
 
   theStat->addFlag ( statFlag ) ;
 }

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

overridevirtual

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

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

void ChronoStatSvc::statPrint ( const IChronoStatSvc::ChronoTag & statTag )

overridevirtual

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

See also: IChronoStatSvc

Definition at line 469 of file ChronoStatSvc.cpp.

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

Member Data Documentation

bool ChronoStatSvc::m_chronoCoutFlag

private

flag for destination of the the final table

Definition at line 153 of file ChronoStatSvc.h.

ChronoMap ChronoStatSvc::m_chronoEntities

private

chrono part

Definition at line 146 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_chronoOrderFlag

private

flag for formattion the final statistic table

Definition at line 155 of file ChronoStatSvc.h.

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

private

Definition at line 149 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_chronoTableFlag

private

flag for printing the final table

Definition at line 151 of file ChronoStatSvc.h.

std::string ChronoStatSvc::m_format1

private

format for regular statistical printout rows

Definition at line 186 of file ChronoStatSvc.h.

std::string ChronoStatSvc::m_format2

private

format for "efficiency" statistical printout rows

Definition at line 188 of file ChronoStatSvc.h.

std::string ChronoStatSvc::m_header

private

the header row

Definition at line 184 of file ChronoStatSvc.h.

int ChronoStatSvc::m_intChronoPrintLevel

private

level of info printing

Definition at line 148 of file ChronoStatSvc.h.

int ChronoStatSvc::m_intStatPrintLevel

private

level of info printing

Definition at line 170 of file ChronoStatSvc.h.

long ChronoStatSvc::m_numberOfSkippedEventsForMemStat

private

Definition at line 164 of file ChronoStatSvc.h.

std::ofstream ChronoStatSvc::m_ofd

private

Definition at line 195 of file ChronoStatSvc.h.

std::string ChronoStatSvc::m_perEventFile

private

Definition at line 194 of file ChronoStatSvc.h.

TimeMap ChronoStatSvc::m_perEvtTime

private

Definition at line 193 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_printEllapsedTime

private

flag for printing Ellapsed quantities

Definition at line 161 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_printSystemTime

private

flag for printing System quantities

Definition at line 159 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_printUserTime

private

flag for printing User quantities

Definition at line 157 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_statCoutFlag

private

flag for destination of the t he final table

Definition at line 175 of file ChronoStatSvc.h.

StatMap ChronoStatSvc::m_statEntities

private

stat part

Definition at line 167 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_statOrderFlag

private

flag for formattion the final statistic table

Definition at line 177 of file ChronoStatSvc.h.

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

private

Definition at line 171 of file ChronoStatSvc.h.

StringProperty ChronoStatSvc::m_statsOutFileName

private

Name of the output file where we'll dump the stats.

Definition at line 181 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_statTableFlag

private

flag for printing the final table

Definition at line 173 of file ChronoStatSvc.h.

bool ChronoStatSvc::m_useEffFormat = true

private

flag to use the special "efficiency" format

Definition at line 190 of file ChronoStatSvc.h.

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

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation