Simple auditor which uses SequencerTimerTool for ALL algorithms, including the algorithm from main Gaudi "TopAlg" list and algorithms managed by Data-On-Demand Service. More...

Inheritance diagram for TimingAuditor:

[legend]

Collaboration diagram for TimingAuditor:

[legend]

Public Member Functions
void	before (StandardEventType evt, INamedInterface *alg) override

void	after (StandardEventType evt, INamedInterface *alg, const StatusCode &sc) override

void	before (CustomEventTypeRef evt, const std::string &name) override

void	after (CustomEventTypeRef evt, const std::string &name, const StatusCode &sc) override

void	handle (const Incident &) override
	Inform that a new incident has occurred. More...

StatusCode	initialize () override
	factory: More...

StatusCode	finalize () override

	TimingAuditor (const std::string &name, ISvcLocator *pSvc)
	standard constructor More...

	~TimingAuditor () override=default
	destructor More...

	TimingAuditor ()=delete

	TimingAuditor (const TimingAuditor &)=delete

TimingAuditor &	operator= (const TimingAuditor &)=delete

Public Member Functions inherited from extends< BASE, Interfaces >
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...

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 extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

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

Private Member Functions
void	i_beforeInitialize (INamedInterface *alg)

void	i_afterInitialize (INamedInterface *alg)

void	i_beforeFinalize (INamedInterface *alg)

void	i_beforeExecute (INamedInterface *alg)

void	i_afterExecute (INamedInterface *alg)

Private Attributes
SmartIF< IToolSvc >	m_toolSvc = nullptr
	tool service More...

SmartIF< IIncidentSvc >	m_incSvc = nullptr
	incident service More...

ISequencerTimerTool *	m_timer = nullptr
	the timer tool More...

SmartIF< INamedInterface >	m_appMgr = nullptr
	ApplicationManager. More...

GaudiUtils::VectorMap< const INamedInterface *, int >	m_map

int	m_indent = 0
	indentation level More...

bool	m_inEvent = false
	"In event" flag More...

bool	m_goodForDOD = false
	"optimized for DOD" More...

GaudiUtils::HashMap< std::string, int >	m_mapUser
	map used to record user timing events More...

bool	m_histoSaved = false

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

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

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Simple auditor which uses SequencerTimerTool for ALL algorithms, including the algorithm from main Gaudi "TopAlg" list and algorithms managed by Data-On-Demand Service.

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-01-31

Definition at line 28 of file TimingAuditor.cpp.

Constructor & Destructor Documentation

TimingAuditor::TimingAuditor	(	const std::string &	name,
		ISvcLocator *	pSvc
	)

inline

standard constructor

Definition at line 56 of file TimingAuditor.cpp.

     : base_class ( name , pSvc )
   {
     declareProperty ( "OptimizedForDOD" , m_goodForDOD ) ;
   } 

TimingAuditor::~TimingAuditor ( )

overridedefault

destructor

TimingAuditor::TimingAuditor ( )

delete

TimingAuditor::TimingAuditor ( const TimingAuditor & )

delete

Member Function Documentation

void TimingAuditor::after	(	StandardEventType	evt,
		INamedInterface *	alg,
		const StatusCode &	sc
	)

override

Definition at line 192 of file TimingAuditor.cpp.

 {
   switch (evt) {
   case IAuditor::Initialize : i_afterInitialize( alg ); break;
   case IAuditor::Execute    : i_afterExecute( alg ); break;
   default: break;
   }
 }

void TimingAuditor::after	(	CustomEventTypeRef	evt,
		const std::string &	name,
		const StatusCode &	sc
	)

override

Definition at line 295 of file TimingAuditor.cpp.

 {
   // Ignore obvious mistakes
   if ( name.empty() && evt.empty() ) { return; }
 
   // look for the user timer in the map
   std::string nick = name + ":" + evt;
   auto found = m_mapUser.find( nick );
 
   // We cannot do much if the timer is not available
   if ( m_mapUser.end() == found ) {
     MsgStream log(msgSvc(), this->name());
     log << MSG::WARNING << "Trying to stop the measure  of the timing for '"
                         << nick << "' but it was never started. Check the code"
                         << endmsg;
     return;
   }
   m_timer->stop( found->second );
 }

void TimingAuditor::before	(	StandardEventType	evt,
		INamedInterface *	alg
	)

override

Definition at line 182 of file TimingAuditor.cpp.

 {
   switch (evt) {
   case IAuditor::Initialize : i_beforeInitialize( alg ); break;
   case IAuditor::Execute    : i_beforeExecute( alg );    break;
   case IAuditor::Finalize   : i_beforeFinalize( alg );   break;
   default: break;
   }
 }

void TimingAuditor::before	(	CustomEventTypeRef	evt,
		const std::string &	name
	)

override

Definition at line 275 of file TimingAuditor.cpp.

 {
   // Ignore obvious mistakes
   if ( name.empty() && evt.empty() ) { return; }
 
   // look for the user timer in the map
   int timer = 0;
   std::string nick = name + ":" + evt;
   auto found = m_mapUser.find( nick );
 
   if ( m_mapUser.end() == found ) {
     // add a new timer if not yet available
     timer = m_timer->addTimer( nick ) ;
     m_mapUser[nick] = timer;
   } else {
     timer = found->second;
   }
   m_timer->start( timer );
 }

StatusCode TimingAuditor::finalize ( )

override

Definition at line 158 of file TimingAuditor.cpp.

 {
   if ( m_incSvc )
   {
     m_incSvc -> removeListener ( this , IncidentType::BeginEvent ) ;
     m_incSvc -> removeListener ( this , IncidentType::EndEvent   ) ;
     m_incSvc.reset();
   }
   if ( m_toolSvc )
   {
     // the 2 following line are commented out: it is
     // is a temporary hack which prevent a crash due to a problem in
     // the reference counting
     //     if ( 0 != m_timer )
     //     { m_toolSvc -> releaseTool ( m_timer ) . ignore() ; m_timer = 0 ; }
     m_toolSvc.reset();
   }
   m_appMgr.reset();
   // clear the map
   m_map.clear() ;
   // finalize the base class
   return Auditor::finalize () ;
 }

void TimingAuditor::handle ( const Incident & i )

override

Inform that a new incident has occurred.

Definition at line 315 of file TimingAuditor.cpp.

 {
   if      ( IncidentType::BeginEvent == i.type () ) {
     m_timer -> start ( m_map[ m_appMgr.get() ] ) ;
     ++m_indent ;
     m_inEvent = true ;
   } else if ( IncidentType::EndEvent   == i.type () ) {
     m_timer -> stop  ( m_map[ m_appMgr.get() ] ) ;
     --m_indent ;
     m_inEvent = false ;
   }
 }

void TimingAuditor::i_afterExecute ( INamedInterface * alg )

private

Definition at line 266 of file TimingAuditor.cpp.

 {
   if ( !alg ) { return ; }
   auto found = m_map.find( alg ) ;
   if ( m_map.end() == found ) { return ; }
   m_timer->stop( found->second ) ;
   --m_indent ;
 }

void TimingAuditor::i_afterInitialize ( INamedInterface * alg )

private

Definition at line 236 of file TimingAuditor.cpp.

 {
   if ( m_goodForDOD || !alg ) { return ; }
   --m_indent ;
 }

void TimingAuditor::i_beforeExecute ( INamedInterface * alg )

private

Definition at line 242 of file TimingAuditor.cpp.

 {
   if ( !alg ) { return ; }
   ++m_indent ;
   auto found = m_map.find( alg ) ;
   if ( m_map.end() == found )
   {
     MsgStream log( msgSvc() , name() ) ;
     log << MSG::DEBUG
         << "Insert non-structural component '"
         << alg->name() << "' of type '"
         << System::typeinfoName(typeid(*alg)) << "' at level "
         << m_indent << endmsg ;
     std::string nick = alg->name() ;
     if ( 0 < m_indent  ) { nick = std::string ( m_indent , ' ') + nick ; }
     if ( !m_goodForDOD ) { nick[0]='*' ;}
     int timer = m_timer->addTimer( nick ) ;
     m_map.insert ( alg , timer ) ;
     m_timer->start( timer ) ;
     return ;
   }
   m_timer->start( found->second ) ;
 }

void TimingAuditor::i_beforeFinalize ( INamedInterface * alg )

private

Definition at line 201 of file TimingAuditor.cpp.

 {
   if (!m_histoSaved)
   {
     m_timer->saveHistograms();
     m_histoSaved = true;
   }
 }

void TimingAuditor::i_beforeInitialize ( INamedInterface * alg )

private

Definition at line 211 of file TimingAuditor.cpp.

 {
   if ( m_goodForDOD ) { return ; }
   //
   if ( !alg ) { return ; }
   auto found = m_map.find( alg ) ;
   if ( m_map.end() != found ) { return ; }
   ++m_indent ;
   std::string nick = alg->name() ;
   if ( 0 < m_indent ) { nick = std::string ( m_indent , ' ') + nick ; }
   if ( m_inEvent )
   {
     nick[0] = '*' ;
     MsgStream log( msgSvc() , name() ) ;
     log << MSG::DEBUG
         << "Insert non-structural component '"
         << alg->name() << "' of type '"
         << System::typeinfoName(typeid(*alg)) << "' at level "
         << m_indent << endmsg ;
   }
   int timer = m_timer->addTimer( nick ) ;
   m_map.insert ( alg , timer ) ;
   m_timer->start( timer ) ;
 }

StatusCode TimingAuditor::initialize ( )

override

factory:

Definition at line 98 of file TimingAuditor.cpp.

 {
   StatusCode sc = Auditor::initialize() ;
   if ( sc.isFailure() ) { return sc ; }                  // RETURN
 
   MsgStream log ( msgSvc() , name() ) ;
 
   // get tool service
   if ( ! m_toolSvc )
   {
     m_toolSvc = Auditor::service ( "ToolSvc" );
     if ( !m_toolSvc )
     {
       log << "Could not retrieve 'ToolSvc' " << endmsg ;
       return StatusCode::FAILURE ;                                        // RETURN
     }
     if ( !m_timer )
     {
       sc = m_toolSvc->retrieveTool
         ( "SequencerTimerTool/TIMER" , m_timer , this  , true ) ;
       if ( sc.isFailure() )
       {
         log << MSG::ERROR
             << "Could not retrieve ISequencerTimerTool" << endmsg ;
         return sc ;
       }
     }
   }
   // get incident service
   if ( !m_incSvc )
   {
     m_incSvc = Auditor::service ( "IncidentSvc" );
     if ( !m_incSvc )
     {
       log << MSG::ERROR
           << "Could not retrieve 'IncidentSvc'" << endmsg ;
       return StatusCode::FAILURE ;
     }
     m_incSvc -> addListener ( this , IncidentType::BeginEvent ) ;
     m_incSvc -> addListener ( this , IncidentType::EndEvent   ) ;
   }
   // get the application manager
   if ( !m_appMgr )
   {
     m_appMgr = Auditor::service ( "ApplicationMgr" );
     if ( !m_appMgr )
     {
       log << MSG::ERROR
           << "Could not retrieve 'ApplicationMgr'" << endmsg ;
       return sc ;
     }
     if ( m_map.end() == m_map.find( m_appMgr.get() ) )
     {
       m_map.insert ( m_appMgr.get() , m_timer->addTimer( "EVENT LOOP" )  ) ;
     }
   }
   //
   return StatusCode::SUCCESS ;
 }

TimingAuditor& TimingAuditor::operator= ( const TimingAuditor & )

delete

Member Data Documentation

SmartIF<INamedInterface> TimingAuditor::m_appMgr = nullptr

private

ApplicationManager.

Definition at line 76 of file TimingAuditor.cpp.

bool TimingAuditor::m_goodForDOD = false

private

"optimized for DOD"

Definition at line 84 of file TimingAuditor.cpp.

bool TimingAuditor::m_histoSaved = false

private

Definition at line 89 of file TimingAuditor.cpp.

SmartIF<IIncidentSvc> TimingAuditor::m_incSvc = nullptr

private

incident service

Definition at line 72 of file TimingAuditor.cpp.

int TimingAuditor::m_indent = 0

private

indentation level

Definition at line 80 of file TimingAuditor.cpp.

bool TimingAuditor::m_inEvent = false

private

"In event" flag

Definition at line 82 of file TimingAuditor.cpp.

GaudiUtils::VectorMap<const INamedInterface*,int> TimingAuditor::m_map

private

Definition at line 78 of file TimingAuditor.cpp.

GaudiUtils::HashMap<std::string,int> TimingAuditor::m_mapUser

private

map used to record user timing events

Definition at line 86 of file TimingAuditor.cpp.

ISequencerTimerTool* TimingAuditor::m_timer = nullptr

private

the timer tool

Definition at line 74 of file TimingAuditor.cpp.

SmartIF<IToolSvc> TimingAuditor::m_toolSvc = nullptr

private

tool service

Definition at line 70 of file TimingAuditor.cpp.

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

GaudiAlg/src/components/TimingAuditor.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation