Inheritance diagram for AlgTimingAuditor:

[legend]

Collaboration diagram for AlgTimingAuditor:

[legend]

Classes
struct	stats_t

Public Types
using	clock_t

Public Types inherited from extends< Gaudi::Auditor, IIncidentListener >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Gaudi::Auditor
using	Factory = Gaudi::PluginService::Factory<IAuditor( const std::string&, ISvcLocator )>

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

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

void	before (std::string const &evt, std::string const &alg, EventContext const &) override

void	after (std::string const &evt, std::string const &alg, EventContext const &, const StatusCode &) override

void	handle (const Incident &i) override

StatusCode	finalize () override

stats_t &	stats (std::string const &alg)

Public Member Functions inherited from extends< Gaudi::Auditor, 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 Gaudi::Auditor
	Auditor (std::string name, ISvcLocator *svcloc)

	Auditor (const Auditor &a)=delete

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

StatusCode	sysInitialize () override

StatusCode	sysFinalize () override

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

void	after (std::string const &, std::string const &, EventContext const &, StatusCode const &=StatusCode::SUCCESS) override

const std::string &	name () const override

bool	isEnabled () const override

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

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAuditor, IProperty > > >
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< IAuditor, IProperty > >
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)

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.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

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

Detailed Description

Definition at line 22 of file AlgTimingAuditor.cpp.

Member Typedef Documentation

◆ clock_t

using AlgTimingAuditor::clock_t

Initial value:

std::conditional_t<std::chrono::high_resolution_clock::is_steady, std::chrono::high_resolution_clock,

std::chrono::steady_clock>

Definition at line 99 of file AlgTimingAuditor.cpp.

Member Function Documentation

◆ after()

void AlgTimingAuditor::after	(	std::string const &	evt,
		std::string const &	alg,
		EventContext const &	,
		const StatusCode &	)

inlineoverride

Definition at line 50 of file AlgTimingAuditor.cpp.

                                                                                                            {
    if ( evt == Gaudi::IAuditor::Initialize ) {
      --m_currentDepth;
    } else if ( evt == Gaudi::IAuditor::Execute ) {
      stats( alg ).stop();
    }
  }

◆ before()

void AlgTimingAuditor::before	(	std::string const &	evt,
		std::string const &	alg,
		EventContext const &	)

inlineoverride

Definition at line 41 of file AlgTimingAuditor.cpp.

                                                                                          {
    if ( evt == Gaudi::IAuditor::Initialize ) {
      stats( alg ); // this implicitly adds the algorithm to the list of known ones
      ++m_currentDepth;
    } else if ( evt == Gaudi::IAuditor::Execute ) {
      stats( alg ).start();
    }
  }

◆ finalize()

StatusCode AlgTimingAuditor::finalize ( )

inlineoverridevirtual

Reimplemented from Gaudi::Auditor.

Definition at line 66 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() << std::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() << std::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 58 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 Gaudi::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 ( std::string const & alg )

inline

Definition at line 114 of file AlgTimingAuditor.cpp.

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

Member Data Documentation

◆ m_currentDepth

std::uint16_t AlgTimingAuditor::m_currentDepth { 0 }

Definition at line 131 of file AlgTimingAuditor.cpp.

131{ 0 };

◆ m_depths

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

Definition at line 128 of file AlgTimingAuditor.cpp.

◆ m_eventLoopStats

stats_t AlgTimingAuditor::m_eventLoopStats

Definition at line 130 of file AlgTimingAuditor.cpp.

◆ m_incSvc

SmartIF<IIncidentSvc> AlgTimingAuditor::m_incSvc

Definition at line 125 of file AlgTimingAuditor.cpp.

◆ m_offsets

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

Definition at line 127 of file AlgTimingAuditor.cpp.

◆ m_stats

std::vector<stats_t> AlgTimingAuditor::m_stats

Definition at line 129 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()

◆ before()

◆ finalize()

◆ handle()

◆ initialize()

◆ stats()

Member Data Documentation

◆ m_currentDepth

◆ m_depths

◆ m_eventLoopStats

◆ m_incSvc

◆ m_offsets

◆ m_stats