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 ()=delete

	TimingAuditor (const TimingAuditor &)=delete

TimingAuditor &	operator= (const TimingAuditor &)=delete

void	before (StandardEventType, INamedInterface *) override
	The following methods are meant to be implemented by the child class... More...

void	before (StandardEventType, const std::string &) override

void	before (CustomEventTypeRef, INamedInterface *) override

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

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

void	after (StandardEventType, const std::string &, const StatusCode &) override

void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override

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

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

Public Member Functions inherited from Auditor
	Auditor (std::string name, ISvcLocator *svcloc)
	Constructor. More...

	Auditor (const Auditor &a)=delete

Auditor &	operator= (const Auditor &rhs)=delete

StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...

StatusCode	sysFinalize () override
	Finalization method invoked by the framework. More...

void	before (StandardEventType, INamedInterface *) override
	The following methods are meant to be implemented by the child class... More...

void	before (StandardEventType, const std::string &) override

void	before (CustomEventTypeRef, INamedInterface *) override

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

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

void	after (StandardEventType, const std::string &, const StatusCode &) override

void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override

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

void	beforeInitialize (INamedInterface *) override

void	afterInitialize (INamedInterface *) override

void	beforeReinitialize (INamedInterface *) override

void	afterReinitialize (INamedInterface *) override

void	beforeExecute (INamedInterface *) override

void	afterExecute (INamedInterface *, const StatusCode &) override

void	beforeFinalize (INamedInterface *) override

void	afterFinalize (INamedInterface *) override

const std::string &	name () const override

bool	isEnabled () const override

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...

template<class T >
StatusCode	service (std::string_view name, T *&svc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T = IService>
SmartIF< T >	service (std::string_view name, bool createIf=false) const

StatusCode	setProperties ()
	Set the auditor's properties. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	PropertyHolder ()=default

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

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

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

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

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

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

StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...

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

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

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

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

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

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

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

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

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

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

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

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

bool	m_histoSaved = false

Gaudi::Property< bool >	m_goodForDOD {this, "OptimizedForDOD", false, "enable optimization for Data-On-Demand Service"}

Additional Inherited Members
Public Types inherited from extends< Auditor, 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 Auditor
using	Factory = Gaudi::PluginService::Factory< IAuditor (const std::string &, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IAuditor, IProperty > >
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...

Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

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 37 of file TimingAuditor.cpp.

Constructor & Destructor Documentation

◆ TimingAuditor() [1/2]

TimingAuditor::TimingAuditor ( )

delete

◆ TimingAuditor() [2/2]

TimingAuditor::TimingAuditor ( const TimingAuditor & )

delete

Member Function Documentation

◆ after() [1/6]

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

override

Definition at line 179 of file TimingAuditor.cpp.

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

◆ after() [2/6]

void Auditor::after

override

Definition at line 108 of file Auditor.cpp.

                                                                                        {
   switch ( evt ) {
   case Initialize:
     afterInitialize( obj );
     break;
   case ReInitialize:
     afterReinitialize( obj );
     break;
   case Execute:
     afterExecute( obj, sc );
     break;
   case Finalize:
     afterFinalize( obj );
     break;
   case Start:
     break;
   case Stop:
     break;
   case ReStart:
     break;
   default:
     break; // do nothing
   }
 }

◆ after() [3/6]

void Auditor::after

override

Definition at line 132 of file Auditor.cpp.

132 {}

◆ after() [4/6]

void Auditor::after

override

Definition at line 134 of file Auditor.cpp.

134 {}

◆ after() [5/6]

void Auditor::after

override

Definition at line 135 of file Auditor.cpp.

135 {}

◆ after() [6/6]

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

override

Definition at line 269 of file TimingAuditor.cpp.

                                                                                             {
   // Ignore obvious mistakes
   if ( name.empty() && evt.empty() ) { return; }
 
   // look for the user timer in the map
   std::string nick  = std::string{name}.append( ":" ).append( evt );
   auto        found = m_mapUser.find( nick );
 
   // We cannot do much if the timer is not available
   if ( m_mapUser.end() == found ) {
     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 );
 }

◆ before() [1/6]

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

override

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

◆ before() [2/6]

void Auditor::before

override

Definition at line 105 of file Auditor.cpp.

105 {}

◆ before() [3/6]

void Auditor::before

override

Definition at line 104 of file Auditor.cpp.

104 {}

◆ before() [4/6]

void Auditor::before

override

The following methods are meant to be implemented by the child class...

Definition at line 78 of file Auditor.cpp.

                                                                   {
   switch ( evt ) {
   case Initialize:
     beforeInitialize( obj );
     break;
   case ReInitialize:
     beforeReinitialize( obj );
     break;
   case Execute:
     beforeExecute( obj );
     break;
   case Finalize:
     beforeFinalize( obj );
     break;
   case Start:
     break;
   case Stop:
     break;
   case ReStart:
     break;
   default:
     break; // do nothing
   }
 }

◆ before() [5/6]

void Auditor::before

override

Definition at line 102 of file Auditor.cpp.

102 {}

◆ before() [6/6]

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

override

Definition at line 250 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  = std::string{name}.append( ":" ).append( 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 );
 }

◆ finalize()

StatusCode TimingAuditor::finalize ( )

overridevirtual

Reimplemented from Auditor.

Definition at line 142 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();
 }

◆ handle()

void TimingAuditor::handle ( const Incident & i )

override

Inform that a new incident has occurred.

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

◆ i_afterExecute()

void TimingAuditor::i_afterExecute ( INamedInterface * alg )

private

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

◆ i_afterInitialize()

void TimingAuditor::i_afterInitialize ( INamedInterface * alg )

private

Definition at line 219 of file TimingAuditor.cpp.

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

◆ i_beforeExecute()

void TimingAuditor::i_beforeExecute ( INamedInterface * alg )

private

Definition at line 224 of file TimingAuditor.cpp.

                                                           {
   if ( !alg ) { return; }
   ++m_indent;
   auto found = m_map.find( alg );
   if ( m_map.end() == found ) {
     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 );
 }

◆ i_beforeFinalize()

void TimingAuditor::i_beforeFinalize ( INamedInterface * alg )

private

Definition at line 192 of file TimingAuditor.cpp.

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

◆ i_beforeInitialize()

void TimingAuditor::i_beforeInitialize ( INamedInterface * alg )

private

Definition at line 200 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] = '*';
     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 );
 }

◆ initialize()

StatusCode TimingAuditor::initialize ( )

overridevirtual

factory:

Reimplemented from Auditor.

Definition at line 98 of file TimingAuditor.cpp.

                                      {
   StatusCode sc = Auditor::initialize();
   if ( sc.isFailure() ) { return sc; } // RETURN
 
   // get tool service
   if ( !m_toolSvc ) {
     m_toolSvc = Auditor::service( "ToolSvc" );
     if ( !m_toolSvc ) {
       error() << "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() ) {
         error() << "Could not retrieve ISequencerTimerTool" << endmsg;
         return sc;
       }
     }
   }
   // get incident service
   if ( !m_incSvc ) {
     m_incSvc = Auditor::service( "IncidentSvc" );
     if ( !m_incSvc ) {
       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 ) {
       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;
 }

◆ operator=()

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

delete

Member Data Documentation

◆ m_appMgr

SmartIF<INamedInterface> TimingAuditor::m_appMgr = nullptr

private

ApplicationManager.

Definition at line 78 of file TimingAuditor.cpp.

◆ m_goodForDOD

Gaudi::Property<bool> TimingAuditor::m_goodForDOD {this, "OptimizedForDOD", false, "enable optimization for Data-On-Demand Service"}

private

Definition at line 91 of file TimingAuditor.cpp.

◆ m_histoSaved

bool TimingAuditor::m_histoSaved = false

private

Definition at line 89 of file TimingAuditor.cpp.

◆ m_incSvc

SmartIF<IIncidentSvc> TimingAuditor::m_incSvc = nullptr

private

incident service

Definition at line 74 of file TimingAuditor.cpp.

◆ m_indent

int TimingAuditor::m_indent = 0

private

indentation level

Definition at line 82 of file TimingAuditor.cpp.

◆ m_inEvent

bool TimingAuditor::m_inEvent = false

private

"In event" flag

Definition at line 84 of file TimingAuditor.cpp.

◆ m_map

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

private

Definition at line 80 of file TimingAuditor.cpp.

◆ m_mapUser

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

private

map used to record user timing events

Definition at line 86 of file TimingAuditor.cpp.

◆ m_timer

ISequencerTimerTool* TimingAuditor::m_timer = nullptr

private

the timer tool

Definition at line 76 of file TimingAuditor.cpp.

◆ m_toolSvc

SmartIF<IToolSvc> TimingAuditor::m_toolSvc = nullptr

private

tool service

Definition at line 72 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

◆ TimingAuditor() [1/2]

◆ TimingAuditor() [2/2]

Member Function Documentation

◆ after() [1/6]

◆ after() [2/6]

◆ after() [3/6]

◆ after() [4/6]

◆ after() [5/6]

◆ after() [6/6]

◆ before() [1/6]

◆ before() [2/6]

◆ before() [3/6]

◆ before() [4/6]

◆ before() [5/6]

◆ before() [6/6]

◆ finalize()

◆ handle()

◆ i_afterExecute()

◆ i_afterInitialize()

◆ i_beforeExecute()

◆ i_beforeFinalize()

◆ i_beforeInitialize()

◆ initialize()

◆ operator=()

Member Data Documentation

◆ m_appMgr

◆ m_goodForDOD

◆ m_histoSaved

◆ m_incSvc

◆ m_indent

◆ m_inEvent

◆ m_map

◆ m_mapUser

◆ m_timer

◆ m_toolSvc