A service that keeps track of the execution state of Algorithm. More...

#include </builds/gaudi/Gaudi/GaudiCoreSvc/src/AlgExecStateSvc/AlgExecStateSvc.h>

Inheritance diagram for AlgExecStateSvc:

[legend]

Collaboration diagram for AlgExecStateSvc:

[legend]

Public Types
typedef IAlgExecStateSvc::AlgStateMap_t	AlgStateMap_t

Public Types inherited from extends< Service, IAlgExecStateSvc >
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
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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

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
const AlgExecState &	algExecState (const Gaudi::StringKey &algName, const EventContext &ctx) const override

AlgExecState &	algExecState (IAlgorithm *iAlg, const EventContext &ctx) override

const AlgStateMap_t &	algExecStates (const EventContext &ctx) const override

void	reset (const EventContext &ctx) override

void	addAlg (const Gaudi::StringKey &algName) override

const EventStatus::Status &	eventStatus (const EventContext &ctx) const override

void	setEventStatus (const EventStatus::Status &sc, const EventContext &ctx) override

void	updateEventStatus (const bool &b, const EventContext &ctx) override

unsigned int	algErrorCount (const IAlgorithm *iAlg) const override

void	resetErrorCount (const IAlgorithm *iAlg) override

unsigned int	incrementErrorCount (const IAlgorithm *iAlg) override

void	dump (std::ostringstream &ost, const EventContext &ctx) const override

virtual const AlgExecState &	algExecState (const Gaudi::StringKey &algName, const EventContext &ctx) const=0

const AlgExecState &	algExecState (IAlgorithm *iAlg, const EventContext &ctx) const

virtual AlgExecState &	algExecState (IAlgorithm *iAlg, const EventContext &ctx)=0

virtual void	addAlg (const Gaudi::StringKey &algName)=0

void	addAlg (IAlgorithm *iAlg)

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

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator 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 >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	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< IService, IProperty, IStateful > >
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...

Private Member Functions
void	init ()

void	checkInit () const

Private Attributes
std::vector< AlgStateMap_t >	m_algStates

std::vector< std::vector< AlgStateMap_t > >	m_algSubSlotStates

std::vector< EventStatus::Status >	m_eventStatus

std::vector< Gaudi::StringKey >	m_preInitAlgs

std::unordered_map< Gaudi::StringKey, std::atomic< unsigned int > >	m_errorCount

std::once_flag	m_initFlag

bool	m_isInit { false }

std::mutex	m_mut

Additional Inherited Members
Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

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

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

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

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

A service that keeps track of the execution state of Algorithm.

Definition at line 26 of file AlgExecStateSvc.h.

Member Typedef Documentation

◆ AlgStateMap_t

typedef IAlgExecStateSvc::AlgStateMap_t AlgExecStateSvc::AlgStateMap_t

Definition at line 30 of file AlgExecStateSvc.h.

Member Function Documentation

◆ addAlg() [1/3]

void AlgExecStateSvc::addAlg ( const Gaudi::StringKey & algName )

override

Definition at line 76 of file AlgExecStateSvc.cpp.

                                                         {
   if ( !m_isInit ) {
     if ( msgLevel( MSG::DEBUG ) ) debug() << "preInit: will add Alg " << alg.str() << " later" << endmsg;
     m_preInitAlgs.push_back( alg );
     return;
   }
  
   if ( !m_algStates.empty() && m_algStates.front().find( alg ) != m_algStates.front().end() ) {
     // already added
     return;
   }
  
   {
     // in theory, this should only get called during initialization (serial)
     // so shouldn't have to protect with a mutex...
     std::scoped_lock lock( m_mut );
  
     AlgExecState s;
     for ( auto& a : m_algStates ) a[alg] = s;
     m_errorCount[alg] = 0;
   }
  
   if ( msgLevel( MSG::DEBUG ) )
     debug() << "adding alg " << alg.str() << " to " << m_algStates.size() << " slots" << endmsg;
 }

◆ addAlg() [2/3]

virtual void IAlgExecStateSvc::addAlg

◆ addAlg() [3/3]

void IAlgExecStateSvc::addAlg

inline

Definition at line 99 of file IAlgExecStateSvc.h.

99 { addAlg( iAlg->nameKey() ); }

◆ algErrorCount()

unsigned int AlgExecStateSvc::algErrorCount ( const IAlgorithm * iAlg ) const

override

Definition at line 222 of file AlgExecStateSvc.cpp.

                                                                           {
   auto itr = m_errorCount.find( iAlg->nameKey() );
   if ( itr == m_errorCount.end() ) {
     error() << "Unable to find Algorithm \"" << iAlg->name() << "\" in map"
             << " of ErrorCounts" << endmsg;
     return 0;
   }
  
   return itr->second;
 }

◆ algExecState() [1/5]

const AlgExecState & AlgExecStateSvc::algExecState	(	const Gaudi::StringKey &	algName,
		const EventContext &	ctx
	)		const

override

Definition at line 104 of file AlgExecStateSvc.cpp.

                                                                                                                 {
   checkInit();
  
   auto& algState = m_algStates.at( ctx.slot() );
   auto  itr      = algState.find( algName );
   if ( itr == algState.end() ) {
     throw GaudiException{ "cannot find Alg " + algName.str() + " in AlgStateMap", name(), StatusCode::FAILURE };
   }
  
   // Assuming the alg is known, look for its state in the sub-slot
   if ( ctx.usesSubSlot() ) {
     auto& subSlots    = m_algSubSlotStates[ctx.slot()];
     auto& thisSubSlot = subSlots[ctx.subSlot()];
     auto  subitr      = thisSubSlot.find( algName );
     if ( subitr == thisSubSlot.end() ) {
       throw GaudiException{ "cannot find Alg " + algName.str() + " in AlgStateMap", name(), StatusCode::FAILURE };
     } else {
       return subitr->second;
     }
   }
  
   return itr->second;
 }

◆ algExecState() [2/5]

virtual const AlgExecState& IAlgExecStateSvc::algExecState

◆ algExecState() [3/5]

const AlgExecState& IAlgExecStateSvc::algExecState

inline

Definition at line 88 of file IAlgExecStateSvc.h.

                                                                                               {
     return algExecState( iAlg->nameKey(), ctx );
   }

◆ algExecState() [4/5]

AlgExecState & AlgExecStateSvc::algExecState	(	IAlgorithm *	iAlg,
		const EventContext &	ctx
	)

override

Definition at line 130 of file AlgExecStateSvc.cpp.

                                                                                        {
   std::call_once( m_initFlag, &AlgExecStateSvc::init, this );
  
   auto& algState = m_algStates.at( ctx.slot() );
   auto  itr      = algState.find( iAlg->nameKey() );
   if ( itr == algState.end() ) {
     throw GaudiException{ std::string{ "cannot find Alg " } + iAlg->name() + " in AlgStateMap", name(),
                           StatusCode::FAILURE };
   }
  
   // Sub-slots are dynamic
   // Assuming the alg is known, look for a subslot
   // Return the existing state, or create a new one
   if ( ctx.usesSubSlot() ) {
  
     // Use mutex since dynamic
     std::scoped_lock lock( m_mut );
  
     // Check that there is any sub-slot information for this slot
     if ( ctx.slot() >= m_algSubSlotStates.size() ) m_algSubSlotStates.resize( ctx.slot() + 1 );
  
     // Check that there is information for this sub-slot
     auto& subSlots = m_algSubSlotStates[ctx.slot()];
     if ( ctx.subSlot() >= subSlots.size() ) subSlots.resize( ctx.subSlot() + 1 );
  
     // Find (or create) the state of the algorithm in this sub-slot
     auto& thisSubSlot = subSlots[ctx.subSlot()];
     auto  subitr      = thisSubSlot.find( iAlg->name() );
     if ( subitr == thisSubSlot.end() ) {
       thisSubSlot[iAlg->name()] = AlgExecState();
       return thisSubSlot[iAlg->name()];
     } else {
       return subitr->second;
     }
   }
  
   return itr->second;
 }

◆ algExecState() [5/5]

virtual AlgExecState& IAlgExecStateSvc::algExecState

◆ algExecStates()

const IAlgExecStateSvc::AlgStateMap_t & AlgExecStateSvc::algExecStates ( const EventContext & ctx ) const

override

Definition at line 171 of file AlgExecStateSvc.cpp.

                                                                                                    {
   checkInit();
   return m_algStates.at( ctx.slot() );
 }

◆ checkInit()

void AlgExecStateSvc::checkInit ( ) const

private

Definition at line 53 of file AlgExecStateSvc.cpp.

                                       {
  
   if ( !m_isInit ) {
     throw GaudiException( "AlgExecStateSvc not initialized before first use!", "AlgExecStateSvc", StatusCode::FAILURE );
   }
 }

◆ dump()

void AlgExecStateSvc::dump	(	std::ostringstream &	ost,
		const EventContext &	ctx
	)		const

override

Definition at line 62 of file AlgExecStateSvc.cpp.

                                                                                  {
   const size_t slotID = ctx.valid() ? ctx.slot() : 0;
  
   ost << "  [slot: " << slotID << ", incident: " << m_eventStatus.at( slotID ) << "]:\n\n";
  
   auto& algState = m_algStates.at( slotID );
   auto  ml       = std::accumulate( begin( algState ), end( algState ), size_t{ 0 },
                                     []( size_t m, const auto& as ) { return std::max( m, as.first.str().length() ); } );
  
   for ( const auto& e : algState ) ost << "  + " << std::setw( ml ) << e.first.str() << "  " << e.second << '\n';
 }

◆ eventStatus()

const EventStatus::Status & AlgExecStateSvc::eventStatus ( const EventContext & ctx ) const

override

Definition at line 178 of file AlgExecStateSvc.cpp.

                                                                                      {
   checkInit();
   return m_eventStatus.at( ctx.slot() );
 }

◆ incrementErrorCount()

unsigned int AlgExecStateSvc::incrementErrorCount ( const IAlgorithm * iAlg )

override

Definition at line 247 of file AlgExecStateSvc.cpp.

                                                                           {
   auto itr = m_errorCount.find( iAlg->nameKey() );
   if ( itr == m_errorCount.end() ) {
     error() << "Unable to find Algorithm \"" << iAlg->name() << "\" in map"
             << " of ErrorCounts" << endmsg;
     return 0;
   }
   return ++( itr->second );
 }

◆ init()

void AlgExecStateSvc::init ( )

private

Definition at line 22 of file AlgExecStateSvc.cpp.

                            {
  
   const std::size_t slots = Gaudi::Concurrency::ConcurrencyFlags::concurrent()
                                 ? std::max( (size_t)1, Gaudi::Concurrency::ConcurrencyFlags::numConcurrentEvents() )
                                 : 1;
  
   m_algStates.resize( slots );
   m_eventStatus.resize( slots );
  
   if ( msgLevel( MSG::DEBUG ) ) debug() << "resizing state containers to : " << slots << endmsg;
  
   SmartIF<IAlgManager> algMan( serviceLocator() );
   if ( !algMan.isValid() ) {
     fatal() << "could not get the AlgManager" << endmsg;
     throw GaudiException( "In AlgExecStateSvc, unable to get the AlgManager!", "AlgExecStateSvc", StatusCode::FAILURE );
   }
  
   m_isInit = true;
  
   for ( const auto& alg : algMan->getAlgorithms() ) addAlg( alg );
   for ( const auto& alg : m_preInitAlgs ) addAlg( alg );
  
   if ( msgLevel( MSG::VERBOSE ) ) {
     std::ostringstream ost;
     dump( ost, Gaudi::Hive::currentContext() );
     verbose() << "dumping state:\n" << ost.str() << endmsg;
   }
 }

◆ reset()

void AlgExecStateSvc::reset ( const EventContext & ctx )

override

Definition at line 204 of file AlgExecStateSvc.cpp.

                                                      {
   if ( msgLevel( MSG::VERBOSE ) ) verbose() << "reset(" << ctx.slot() << ")" << endmsg;
  
   std::call_once( m_initFlag, &AlgExecStateSvc::init, this );
   for ( auto& e : m_algStates.at( ctx.slot() ) ) e.second.reset();
  
   // Also clear sub slots
   if ( ctx.slot() < m_algSubSlotStates.size() ) {
     for ( auto& subSlot : m_algSubSlotStates[ctx.slot()] ) {
       for ( auto& e : subSlot ) e.second.reset();
     }
   }
  
   m_eventStatus.at( ctx.slot() ) = EventStatus::Invalid;
 }

◆ resetErrorCount()

void AlgExecStateSvc::resetErrorCount ( const IAlgorithm * iAlg )

override

Definition at line 235 of file AlgExecStateSvc.cpp.

                                                               {
   auto itr = m_errorCount.find( iAlg->nameKey() );
   if ( itr != m_errorCount.end() ) {
     itr->second = 0;
   } else {
     error() << "Unable to find Algorithm \"" << iAlg->name() << "\" in map"
             << " of ErrorCounts" << endmsg;
   }
 }

◆ setEventStatus()

void AlgExecStateSvc::setEventStatus	(	const EventStatus::Status &	sc,
		const EventContext &	ctx
	)

override

Definition at line 185 of file AlgExecStateSvc.cpp.

                                                                                            {
   std::call_once( m_initFlag, &AlgExecStateSvc::init, this );
   m_eventStatus.at( ctx.slot() ) = sc;
 }

◆ updateEventStatus()

void AlgExecStateSvc::updateEventStatus	(	const bool &	b,
		const EventContext &	ctx
	)

override

Definition at line 192 of file AlgExecStateSvc.cpp.

                                                                                    {
   std::call_once( m_initFlag, &AlgExecStateSvc::init, this );
   auto& status = m_eventStatus.at( ctx.slot() );
   if ( status == EventStatus::Success ) {
     if ( fail ) status = EventStatus::AlgFail;
   } else if ( status == EventStatus::Invalid ) {
     status = ( fail ? EventStatus::AlgFail : EventStatus::Success );
   }
 }

Member Data Documentation

◆ m_algStates

std::vector<AlgStateMap_t> AlgExecStateSvc::m_algStates

private

Definition at line 56 of file AlgExecStateSvc.h.

◆ m_algSubSlotStates

std::vector<std::vector<AlgStateMap_t> > AlgExecStateSvc::m_algSubSlotStates

private

Definition at line 57 of file AlgExecStateSvc.h.

◆ m_errorCount

std::unordered_map<Gaudi::StringKey, std::atomic<unsigned int> > AlgExecStateSvc::m_errorCount

private

Definition at line 62 of file AlgExecStateSvc.h.

◆ m_eventStatus

std::vector<EventStatus::Status> AlgExecStateSvc::m_eventStatus

private

Definition at line 59 of file AlgExecStateSvc.h.

◆ m_initFlag

std::once_flag AlgExecStateSvc::m_initFlag

private

Definition at line 66 of file AlgExecStateSvc.h.

◆ m_isInit

bool AlgExecStateSvc::m_isInit { false }

private

Definition at line 67 of file AlgExecStateSvc.h.

◆ m_mut

std::mutex AlgExecStateSvc::m_mut

private

Definition at line 69 of file AlgExecStateSvc.h.

◆ m_preInitAlgs

std::vector<Gaudi::StringKey> AlgExecStateSvc::m_preInitAlgs

private

Definition at line 60 of file AlgExecStateSvc.h.

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

GaudiCoreSvc/src/AlgExecStateSvc/AlgExecStateSvc.h
GaudiCoreSvc/src/AlgExecStateSvc/AlgExecStateSvc.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AlgStateMap_t

Member Function Documentation

◆ addAlg() [1/3]

◆ addAlg() [2/3]

◆ addAlg() [3/3]

◆ algErrorCount()

◆ algExecState() [1/5]

◆ algExecState() [2/5]

◆ algExecState() [3/5]

◆ algExecState() [4/5]

◆ algExecState() [5/5]

◆ algExecStates()

◆ checkInit()

◆ dump()

◆ eventStatus()

◆ incrementErrorCount()

◆ init()

◆ reset()

◆ resetErrorCount()

◆ setEventStatus()

◆ updateEventStatus()

Member Data Documentation

◆ m_algStates

◆ m_algSubSlotStates

◆ m_errorCount

◆ m_eventStatus

◆ m_initFlag

◆ m_isInit

◆ m_mut

◆ m_preInitAlgs