AlgsExecutionStates Class Reference

#include <GaudiKernel/AlgsExecutionStates.h>

Collaboration diagram for AlgsExecutionStates:

Public Types
enum	State : uint8_t {   INITIAL = 0, CONTROLREADY = 1, DATAREADY = 2, RESOURCELESS = 3,   SCHEDULED = 4, EVTACCEPTED = 5, EVTREJECTED = 6, ERROR = 7,   MAXVALUE = 8 }
	Execution states of the algorithms Must have contiguous integer values 0, 1... More...

Public Member Functions
	AlgsExecutionStates (unsigned int algsNumber, SmartIF< IMessageSvc > MS)
StatusCode	set (unsigned int iAlgo, State newState)
void	reset ()
bool	contains (State state) const
	check if the collection contains at least one state of requested type More...
bool	containsAny (std::initializer_list< State > l) const
	check if the collection contains at least one state of any listed types More...
const boost::container::flat_set< int >	algsInState (State state) const
const State &	operator[] (unsigned int i) const
size_t	size () const
size_t	sizeOfSubset (State state) const

Private Member Functions
MsgStream	log ()

Private Attributes
std::vector< State >	m_states
std::vector< boost::container::flat_set< int > >	m_algsInState
SmartIF< IMessageSvc >	m_MS

Detailed Description

The AlgsExecutionStates encodes the state machine for the execution of algorithms within a single event. It is used by the concurrent schedulers

Author

Benedikt Hegner

Danilo Piparo

Version

1.0

Definition at line 37 of file AlgsExecutionStates.h.

Member Enumeration Documentation

State

enum AlgsExecutionStates::State : uint8_t

Execution states of the algorithms Must have contiguous integer values 0, 1...

N

Enumerator
INITIAL
CONTROLREADY
DATAREADY
RESOURCELESS
SCHEDULED
EVTACCEPTED
EVTREJECTED
ERROR
MAXVALUE

Definition at line 41 of file AlgsExecutionStates.h.

             : uint8_t {
    INITIAL      = 0,
    CONTROLREADY = 1,
    DATAREADY    = 2,
    RESOURCELESS = 3,
    SCHEDULED    = 4,
    EVTACCEPTED  = 5,
    EVTREJECTED  = 6,
    ERROR        = 7,
    MAXVALUE     = 8 // Allows loop over all states
  };

Constructor & Destructor Documentation

AlgsExecutionStates()

AlgsExecutionStates::AlgsExecutionStates ( unsigned int  algsNumber, SmartIF< IMessageSvc >  MS  )

inline

Definition at line 53 of file AlgsExecutionStates.h.

      : m_states( algsNumber, INITIAL ), m_algsInState( MAXVALUE ), m_MS( std::move( MS ) ) {
 
    m_algsInState[INITIAL].reserve( algsNumber );
    for ( unsigned int i = 0; i < algsNumber; ++i ) m_algsInState[INITIAL].insert( i );
  }

Member Function Documentation

algsInState()

const boost::container::flat_set<int> AlgsExecutionStates::algsInState ( State  state ) const

inline

Definition at line 82 of file AlgsExecutionStates.h.

{ return m_algsInState[state]; }

contains()

bool AlgsExecutionStates::contains ( State  state ) const

inline

check if the collection contains at least one state of requested type

Definition at line 71 of file AlgsExecutionStates.h.

{ return m_algsInState[state].size() > 0; }

containsAny()

bool AlgsExecutionStates::containsAny ( std::initializer_list< State >  l ) const

inline

check if the collection contains at least one state of any listed types

Definition at line 74 of file AlgsExecutionStates.h.

                                                         {
    for ( auto state : l )
      if ( m_algsInState[state].size() > 0 ) return true;
    return false;
  }

log()

MsgStream AlgsExecutionStates::log ( )

inlineprivate

Definition at line 95 of file AlgsExecutionStates.h.

{ return { m_MS, "AlgsExecutionStates" }; }

operator[]()

const State& AlgsExecutionStates::operator[] ( unsigned int  i ) const

inline

Definition at line 84 of file AlgsExecutionStates.h.

{ return m_states.at( i ); }

reset()

void AlgsExecutionStates::reset ( )

inline

Definition at line 62 of file AlgsExecutionStates.h.

               {
    std::fill( m_states.begin(), m_states.end(), INITIAL );
 
    for ( auto& algs : m_algsInState ) algs.clear();
    m_algsInState[INITIAL].reserve( m_states.size() );
    for ( unsigned int i = 0; i < m_states.size(); ++i ) m_algsInState[INITIAL].insert( i );
  }

set()

StatusCode AlgsExecutionStates::set	(	unsigned int	iAlgo,
		State	newState
	)

Definition at line 23 of file AlgsExecutionStates.cpp.

                                                                        {
  if ( iAlgo >= m_states.size() ) {
    log() << MSG::ERROR << "Index out of bound (" << iAlgo << " / " << m_states.size() << ")" << endmsg;
    return StatusCode::FAILURE;
  }
 
  State oldState = m_states[iAlgo];
 
  // Allow cycling of a single state
  if ( oldState == newState ) return StatusCode::SUCCESS;
 
  switch ( transition( oldState, newState ) ) {
  case transition( INITIAL, CONTROLREADY ):
    [[fallthrough]];
  case transition( CONTROLREADY, DATAREADY ):
    [[fallthrough]];
  case transition( DATAREADY, SCHEDULED ):
    [[fallthrough]];
  case transition( DATAREADY, RESOURCELESS ):
    [[fallthrough]];
  case transition( RESOURCELESS, SCHEDULED ):
    [[fallthrough]];
  case transition( SCHEDULED, ERROR ):
    [[fallthrough]];
  case transition( SCHEDULED, EVTACCEPTED ):
    [[fallthrough]];
  case transition( SCHEDULED, EVTREJECTED ):
    m_states[iAlgo] = newState;
    m_algsInState[oldState].erase( iAlgo );
    m_algsInState[newState].insert( iAlgo );
    return StatusCode::SUCCESS;
  default:
    log() << MSG::ERROR << "[AlgIndex " << iAlgo << "] Transition from " << m_states[iAlgo] << " to " << newState
          << " is not allowed" << endmsg;
    m_states[iAlgo] = ERROR;
    m_algsInState[oldState].erase( iAlgo );
    m_algsInState[ERROR].insert( iAlgo );
    return StatusCode::FAILURE;
  }
}

size()

size_t AlgsExecutionStates::size ( ) const

inline

Definition at line 86 of file AlgsExecutionStates.h.

{ return m_states.size(); }

sizeOfSubset()

size_t AlgsExecutionStates::sizeOfSubset ( State  state ) const

inline

Definition at line 88 of file AlgsExecutionStates.h.

{ return m_algsInState[state].size(); }

Member Data Documentation

m_algsInState

std::vector<boost::container::flat_set<int> > AlgsExecutionStates::m_algsInState

private

Definition at line 92 of file AlgsExecutionStates.h.

m_MS

SmartIF<IMessageSvc> AlgsExecutionStates::m_MS

private

Definition at line 93 of file AlgsExecutionStates.h.

m_states

std::vector<State> AlgsExecutionStates::m_states

private

Definition at line 91 of file AlgsExecutionStates.h.

---

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

• GaudiHive/src/AlgsExecutionStates.h
• GaudiHive/src/AlgsExecutionStates.cpp