AlgExecStateSvc Class Reference

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

#include <src/AlgExecStateSvc/AlgExecStateSvc.h>

Inheritance diagram for AlgExecStateSvc:

Collaboration diagram for AlgExecStateSvc:

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
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * >	Factory
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
	AlgExecStateSvc (const std::string &name, ISvcLocator *svc)
	Constructor. More...
	~AlgExecStateSvc ()
	Destructor. More...
virtual StatusCode	initialize () override final
virtual StatusCode	finalize () override final
const AlgExecState &	algExecState (const Gaudi::StringKey &algName, const EventContext &ctx) const override
const AlgExecState &	algExecState (IAlgorithm *iAlg, 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 (IAlgorithm *iAlg) 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
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...
	~extends () override=default
	Virtual destructor. 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...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. 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 >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...
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
	~PropertyHolder () override=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, TYPE &value, const std::string &doc="none") const
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
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
	Specializations for various GaudiHandles. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
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...
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces< Interfaces... >
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Types
typedef std::vector< AlgStateMap_t >	AlgStates_t
typedef std::map< Gaudi::StringKey, std::atomic< unsigned int > >	AlgErrorMap_t

Private Member Functions
std::string	trans (const EventStatus::Status &sc) const
void	init ()
void	checkInit () const

Private Attributes
AlgStates_t	m_algStates
std::vector< EventStatus::Status >	m_eventStatus
std::vector< Gaudi::StringKey >	m_preInitAlgs
AlgErrorMap_t	m_errorCount
std::once_flag	m_initFlag
bool	m_isInit
std::mutex	m_mut

Additional Inherited Members
Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging ()
	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"}
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()"}
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

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

Definition at line 16 of file AlgExecStateSvc.h.

Member Typedef Documentation

typedef std::map<Gaudi::StringKey, std::atomic<unsigned int> > AlgExecStateSvc::AlgErrorMap_t

private

Definition at line 63 of file AlgExecStateSvc.h.

typedef IAlgExecStateSvc::AlgStateMap_t AlgExecStateSvc::AlgStateMap_t

Definition at line 28 of file AlgExecStateSvc.h.

typedef std::vector<AlgStateMap_t> AlgExecStateSvc::AlgStates_t

private

Definition at line 57 of file AlgExecStateSvc.h.

Constructor & Destructor Documentation

AlgExecStateSvc::AlgExecStateSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Constructor.

Definition at line 14 of file AlgExecStateSvc.cpp.

    : base_class( name, svcLoc ), m_isInit( false )
{
}

AlgExecStateSvc::~AlgExecStateSvc

(

)

Destructor.

Definition at line 21 of file AlgExecStateSvc.cpp.

{}

Member Function Documentation

void AlgExecStateSvc::addAlg ( IAlgorithm *  iAlg )

override

Definition at line 135 of file AlgExecStateSvc.cpp.

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

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

override

Definition at line 139 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.size() > 0 ) {
    if ( m_algStates.at( 0 ).find( alg ) != m_algStates.at( 0 ).end() ) {
      // already added
      return;
    }
  }

  {
    // in theory, this should only get called during initialization (serial)
    // so shouldn't have to protect with a mutex...
    std::lock_guard<std::mutex> lock( m_mut );

    AlgExecState s;
    for ( size_t i = 0; i < m_algStates.size(); ++i ) {
      m_algStates.at( i )[alg] = s;
    }

    m_errorCount[alg] = 0;
  }

  if ( msgLevel( MSG::DEBUG ) )
    debug() << "adding alg " << alg.str() << " to " << m_algStates.size() << " slots" << endmsg;
}

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

override

Definition at line 273 of file AlgExecStateSvc.cpp.

{
  AlgErrorMap_t::const_iterator itr = m_errorCount.find( iAlg->nameKey() );

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

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

override

Definition at line 174 of file AlgExecStateSvc.cpp.

{

  checkInit();

  AlgStateMap_t::const_iterator itr = m_algStates.at( ctx.slot() ).find( algName );

  if ( UNLIKELY( itr == m_algStates.at( ctx.slot() ).end() ) ) {
    throw GaudiException{std::string{"cannot find Alg "} + algName.str() + " in AlgStateMap", name(),
                         StatusCode::FAILURE};
  }

  return itr->second;
}

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

override

Definition at line 191 of file AlgExecStateSvc.cpp.

{

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

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

override

Definition at line 199 of file AlgExecStateSvc.cpp.

{

  std::call_once( m_initFlag, &AlgExecStateSvc::init, this );

  AlgStateMap_t::iterator itr = m_algStates.at( ctx.slot() ).find( iAlg->nameKey() );

  if ( UNLIKELY( itr == m_algStates.at( ctx.slot() ).end() ) ) {
    throw GaudiException{std::string{"cannot find Alg "} + iAlg->name() + " in AlgStateMap", name(),
                         StatusCode::FAILURE};
  }

  return itr->second;
}

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

override

Definition at line 216 of file AlgExecStateSvc.cpp.

{

  checkInit();

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

void AlgExecStateSvc::checkInit ( ) const

private

Definition at line 80 of file AlgExecStateSvc.cpp.

{

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

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

override

Definition at line 112 of file AlgExecStateSvc.cpp.

{
  size_t slotID = ctx.valid() ? ctx.slot() : 0;

  ost << "Event: " << trans( m_eventStatus.at( slotID ) ) << std::endl;
  ost << "Algs: " << m_algStates.at( slotID ).size() << std::endl;

  size_t ml( 0 );
  for ( auto& e : m_algStates.at( slotID ) ) {
    if ( e.first.str().length() > ml ) {
      ml = e.first.str().length();
    }
  }

  ost << " - Slot " << slotID << std::endl;
  const AlgStateMap_t& m = m_algStates.at( slotID );
  for ( auto& e : m ) {
    ost << "  + " << std::setw( ml ) << e.first.str() << "  " << e.second << std::endl;
  }
}

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

override

Definition at line 226 of file AlgExecStateSvc.cpp.

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

StatusCode AlgExecStateSvc::finalize ( )

finaloverridevirtual

Definition at line 108 of file AlgExecStateSvc.cpp.

{ return StatusCode::SUCCESS; }

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

override

Definition at line 301 of file AlgExecStateSvc.cpp.

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

void AlgExecStateSvc::init ( )

private

Definition at line 25 of file AlgExecStateSvc.cpp.

{

  std::string wbn;

  // seriously? do we have no way of getting a Service by type???
  std::list<IService*> lst = serviceLocator()->getServices();
  for ( auto& is : lst ) {
    IHiveWhiteBoard* iwb = dynamic_cast<IHiveWhiteBoard*>( is );
    if ( iwb != 0 ) {
      wbn = is->name();
      if ( msgLevel( MSG::VERBOSE ) ) verbose() << "HiveWhiteBoard service name is " << wbn << endmsg;
      break;
    }
  }

  SmartIF<IHiveWhiteBoard> wbs;
  wbs = serviceLocator()->service( wbn, false );

  if ( wbs.isValid() ) {
    m_algStates.resize( wbs->getNumberOfStores() );
    m_eventStatus.resize( wbs->getNumberOfStores() );
  } else {
    m_algStates.resize( 1 );
    m_eventStatus.resize( 1 );
  }

  if ( msgLevel( MSG::DEBUG ) ) debug() << "resizing state containers to : " << m_algStates.size() << 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;

  auto algos = algMan->getAlgorithms();
  for ( auto& alg : algos ) {
    addAlg( alg );
  }

  for ( 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;
  }
}

StatusCode AlgExecStateSvc::initialize ( )

finaloverridevirtual

Definition at line 91 of file AlgExecStateSvc.cpp.

{

  // Initialise mother class (read properties, ...)
  StatusCode sc( Service::initialize() );
  if ( !sc.isSuccess() ) {
    warning() << "Base class could not be initialized" << endmsg;
    return StatusCode::FAILURE;
  }

  // moved all initialization to init(). hopefully it will get called in time....

  return StatusCode::SUCCESS;
}

void AlgExecStateSvc::reset ( const EventContext &  ctx )

override

Definition at line 258 of file AlgExecStateSvc.cpp.

{

  if ( msgLevel( MSG::DEBUG ) ) verbose() << "reset(" << ctx.slot() << ")" << endmsg;

  std::call_once( m_initFlag, &AlgExecStateSvc::init, this );
  for ( auto& e : m_algStates.at( ctx.slot() ) ) {
    e.second.reset();
  }

  m_eventStatus.at( ctx.slot() ) = EventStatus::Invalid;
}

void AlgExecStateSvc::resetErrorCount ( const IAlgorithm *  iAlg )

override

Definition at line 288 of file AlgExecStateSvc.cpp.

{
  AlgErrorMap_t::iterator 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;
  }
}

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

override

Definition at line 234 of file AlgExecStateSvc.cpp.

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

std::string AlgExecStateSvc::trans ( const EventStatus::Status &  sc ) const

private

Definition at line 315 of file AlgExecStateSvc.cpp.

{
  switch ( s ) {
  case EventStatus::Invalid:
    return "Invalid";
  case EventStatus::Success:
    return "Success";
  case EventStatus::AlgFail:
    return "AlgFail";
  case EventStatus::AlgStall:
    return "AlgStall";
  case EventStatus::Other:
    return "Other";
  default:
    return "Should not happen";
  }
}

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

override

Definition at line 242 of file AlgExecStateSvc.cpp.

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

Member Data Documentation

AlgStates_t AlgExecStateSvc::m_algStates

private

Definition at line 58 of file AlgExecStateSvc.h.

AlgErrorMap_t AlgExecStateSvc::m_errorCount

private

Definition at line 64 of file AlgExecStateSvc.h.

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

private

Definition at line 60 of file AlgExecStateSvc.h.

std::once_flag AlgExecStateSvc::m_initFlag

private

Definition at line 68 of file AlgExecStateSvc.h.

bool AlgExecStateSvc::m_isInit

private

Definition at line 69 of file AlgExecStateSvc.h.

std::mutex AlgExecStateSvc::m_mut

private

Definition at line 71 of file AlgExecStateSvc.h.

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

private

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