Inheritance diagram for AlgTimingAuditor:

[legend]

Collaboration diagram for AlgTimingAuditor:

[legend]

Classes
struct	stats_t

Public Types
using	clock_t = std::conditional_t< std::chrono::high_resolution_clock::is_steady, std::chrono::high_resolution_clock, std::chrono::steady_clock >

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

Public Member Functions
StatusCode	initialize () override

void	before (StandardEventType evt, INamedInterface *alg) override

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

void	handle (const Incident &i) override

StatusCode	finalize () override

stats_t &	stats (INamedInterface *alg)

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

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

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 std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

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

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

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

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

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

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

StatusCode	getProperty (std::string_view 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 (std::string_view name) const override
	Return true if we have a property with the given name. More...

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

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

	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 Attributes
SmartIF< IIncidentSvc >	m_incSvc

std::unordered_map< std::string, std::size_t >	m_offsets

std::vector< std::uint16_t >	m_depths

std::vector< stats_t >	m_stats

stats_t	m_eventLoopStats

std::uint16_t	m_currentDepth { 0 }

Additional Inherited Members
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

Definition at line 22 of file AlgTimingAuditor.cpp.

Member Typedef Documentation

◆ clock_t

using AlgTimingAuditor::clock_t = std::conditional_t<std::chrono::high_resolution_clock::is_steady, std::chrono::high_resolution_clock, std::chrono::steady_clock>

Definition at line 115 of file AlgTimingAuditor.cpp.

Member Function Documentation

◆ after() [1/5]

void Auditor::after

override

Definition at line 76 of file Auditor.cpp.

139 {}

◆ after() [2/5]

void Auditor::after

override

Definition at line 75 of file Auditor.cpp.

138 {}

◆ after() [3/5]

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

inlineoverride

Definition at line 58 of file AlgTimingAuditor.cpp.

                                                                                         {
     if ( !alg ) return;
     switch ( evt ) {
     case Initialize:
       --m_currentDepth;
       break;
  
     case Execute:
       stats( alg ).stop();
       break;
  
     default:
       break;
     }
   }

◆ after() [4/5]

void Auditor::after

override

Definition at line 73 of file Auditor.cpp.

136 {}

◆ after() [5/5]

void Auditor::after

override

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

◆ before() [1/5]

void Auditor::before

override

Definition at line 70 of file Auditor.cpp.

109 {}

◆ before() [2/5]

void Auditor::before

override

Definition at line 69 of file Auditor.cpp.

108 {}

◆ before() [3/5]

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

inlineoverride

Definition at line 41 of file AlgTimingAuditor.cpp.

                                                                       {
     if ( !alg ) return;
     switch ( evt ) {
     case Initialize:
       stats( alg ); // this implicitly adds the algorithm to the list of known ones
       ++m_currentDepth;
       break;
  
     case Execute:
       stats( alg ).start();
       break;
  
     default:
       break;
     }
   }

◆ before() [4/5]

void Auditor::before

override

Definition at line 67 of file Auditor.cpp.

106 {}

◆ before() [5/5]

void Auditor::before

override

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

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

◆ finalize()

StatusCode AlgTimingAuditor::finalize ( )

inlineoverridevirtual

Reimplemented from Auditor.

Definition at line 82 of file AlgTimingAuditor.cpp.

                                  {
     using ms = std::chrono::duration<float, std::milli>;
     using s  = std::chrono::duration<float>;
     info() << "-------------------------------------------------------------------" << endmsg;
     info() << "Algorithm                      | exec (ms) |   count   | total (s)" << endmsg;
     info() << "-------------------------------------------------------------------" << endmsg;
     if ( m_incSvc ) {
       const auto count      = m_eventLoopStats.count;
       const auto total_time = m_eventLoopStats.total_time;
       info() << fmt::format( "{:<30.30} | {:9.4} | {:9} | {:9.4}", "EVENT LOOP",
                              count ? ms( total_time ).count() / count : 0.f, count, s( total_time ).count() )
              << endmsg;
     }
     std::vector<std::pair<std::string, std::size_t>> offsets{ begin( m_offsets ), end( m_offsets ) };
     std::sort( begin( offsets ), end( offsets ), []( auto& a, auto& b ) { return a.second < b.second; } );
     for ( const auto& [name, offset] : offsets ) {
       std::string indented_name = std::string( m_depths[offset], ' ' ) + name;
       const auto  count         = m_stats[offset].count;
       const auto  total_time    = m_stats[offset].total_time;
       info() << fmt::format( "{:<30.30} | {:9.4} | {:9} | {:9.4}", indented_name,
                              count ? ms( total_time ).count() / count : 0.f, count, s( total_time ).count() )
              << endmsg;
     }
     info() << "-------------------------------------------------------------------" << endmsg;
  
     if ( m_incSvc ) {
       m_incSvc->removeListener( this, IncidentType::BeginEvent );
       m_incSvc->removeListener( this, IncidentType::EndEvent );
       m_incSvc.reset();
     }
     return base_class::finalize();
   }

◆ handle()

void AlgTimingAuditor::handle ( const Incident & i )

inlineoverride

Definition at line 74 of file AlgTimingAuditor.cpp.

                                             {
     if ( IncidentType::BeginEvent == i.type() ) {
       m_eventLoopStats.start();
     } else if ( IncidentType::EndEvent == i.type() ) {
       m_eventLoopStats.stop();
     }
   }

◆ initialize()

StatusCode AlgTimingAuditor::initialize ( )

inlineoverridevirtual

Reimplemented from Auditor.

Definition at line 28 of file AlgTimingAuditor.cpp.

                                    {
     return base_class::initialize().andThen( [&]() {
       m_incSvc = service( "IncidentSvc" );
       if ( m_incSvc ) {
         m_incSvc->addListener( this, IncidentType::BeginEvent );
         m_incSvc->addListener( this, IncidentType::EndEvent );
         ++m_currentDepth;
       } else {
         debug() << "no IncidentSvc, I cannot measure overall event processing time" << endmsg;
       }
     } );
   }

◆ stats()

stats_t& AlgTimingAuditor::stats ( INamedInterface * alg )

inline

Definition at line 130 of file AlgTimingAuditor.cpp.

                                          {
     if ( auto it = m_offsets.find( alg->name() ); it != end( m_offsets ) ) {
       return m_stats[it->second];
     } else {
       m_depths.push_back( m_currentDepth );
       m_stats.emplace_back();
       m_offsets[alg->name()] = m_stats.size() - 1;
       return m_stats.back();
     }
   }

Member Data Documentation

◆ m_currentDepth

std::uint16_t AlgTimingAuditor::m_currentDepth { 0 }

Definition at line 147 of file AlgTimingAuditor.cpp.

◆ m_depths

std::vector<std::uint16_t> AlgTimingAuditor::m_depths

Definition at line 144 of file AlgTimingAuditor.cpp.

◆ m_eventLoopStats

stats_t AlgTimingAuditor::m_eventLoopStats

Definition at line 146 of file AlgTimingAuditor.cpp.

◆ m_incSvc

SmartIF<IIncidentSvc> AlgTimingAuditor::m_incSvc

Definition at line 141 of file AlgTimingAuditor.cpp.

◆ m_offsets

std::unordered_map<std::string, std::size_t> AlgTimingAuditor::m_offsets

Definition at line 143 of file AlgTimingAuditor.cpp.

◆ m_stats

std::vector<stats_t> AlgTimingAuditor::m_stats

Definition at line 145 of file AlgTimingAuditor.cpp.

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

GaudiAud/src/AlgTimingAuditor.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ clock_t

Member Function Documentation

◆ after() [1/5]

◆ after() [2/5]

◆ after() [3/5]

◆ after() [4/5]

◆ after() [5/5]

◆ before() [1/5]

◆ before() [2/5]

◆ before() [3/5]

◆ before() [4/5]

◆ before() [5/5]

◆ finalize()

◆ handle()

◆ initialize()

◆ stats()

Member Data Documentation

◆ m_currentDepth

◆ m_depths

◆ m_eventLoopStats

◆ m_incSvc

◆ m_offsets

◆ m_stats