SequentialSchedulerSvc Class Reference

This SchedulerSvc implements the IScheduler interface. More...

#include <src/SequentialSchedulerSvc.h>

Inheritance diagram for SequentialSchedulerSvc:

Collaboration diagram for SequentialSchedulerSvc:

Public Member Functions
	SequentialSchedulerSvc (const std::string &name, ISvcLocator *svc)
	Constructor. More...
	~SequentialSchedulerSvc ()
	Destructor. More...
virtual StatusCode	initialize ()
	Initialise. More...
virtual StatusCode	finalize ()
	Finalise. More...
virtual StatusCode	pushNewEvent (EventContext *eventContext)
	Make an event available to the scheduler. More...
virtual StatusCode	pushNewEvents (std::vector< EventContext * > &eventContexts)
virtual StatusCode	popFinishedEvent (EventContext *&eventContext)
	Blocks until an event is availble. More...
virtual StatusCode	tryPopFinishedEvent (EventContext *&eventContext)
	Try to fetch an event from the scheduler. More...
virtual unsigned int	freeSlots ()
	Get free slots number. More...
Public Member Functions inherited from extends< BASE, Interfaces >
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...
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 extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Attributes
bool	m_useTopAlgList
	Decide if the top alglist or its flat version has to be used. More...
std::list< IAlgorithm * >	m_algList
	Cache the list of algs to be executed. More...
EventContext *	m_eventContext
	The context of the event being processed. More...
int	m_freeSlots
	The number of free slots (0 or 1) More...

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

This SchedulerSvc implements the IScheduler interface.

It executes all the algorithms in sequence, pulling them from the AlgResourcePool. No task level parallelism is involved. Given its sequential nature, the scheduler does not run in its own thread. It has therefore to be treated a as a THREAD UNSAFE and NON REENTRANT entity.

Author

Danilo Piparo

Benedikt Hegner

Version

1.1

Definition at line 36 of file SequentialSchedulerSvc.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 23 of file SequentialSchedulerSvc.cpp.

                                                                                          :
 base_class(name,svcLoc),
 m_eventContext(nullptr),
 m_freeSlots(1){
  declareProperty("UseTopAlgList", m_useTopAlgList=true);
}

SequentialSchedulerSvc::~SequentialSchedulerSvc

(

)

Destructor.

Definition at line 31 of file SequentialSchedulerSvc.cpp.

{}

Member Function Documentation

StatusCode SequentialSchedulerSvc::finalize ( )

virtual

Finalise.

Definition at line 57 of file SequentialSchedulerSvc.cpp.

                                           {
  StatusCode sc(Service::finalize());
  if (!sc.isSuccess())
    warning () << "Base class could not be finalized" << endmsg;
  return sc;
}

unsigned int SequentialSchedulerSvc::freeSlots ( )

virtual

Get free slots number.

Given that the scheduler is sequential and its methods non reentrant, this is always 1.

Definition at line 173 of file SequentialSchedulerSvc.cpp.

{return m_freeSlots;}

StatusCode SequentialSchedulerSvc::initialize ( )

virtual

Initialise.

Definition at line 34 of file SequentialSchedulerSvc.cpp.

                                             {

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

  // Get the algo resource pool
  SmartIF<IAlgResourcePool> algResourcePool (serviceLocator()->service("AlgResourcePool"));
  if (!algResourcePool.isValid()){
    error() << "Error retrieving AlgResourcePool" << endmsg;
    return StatusCode::FAILURE;
  }

  // Get the list of algorithms
  m_algList = m_useTopAlgList ? algResourcePool->getTopAlgList() : algResourcePool->getFlatAlgList();
  info() << "Found " <<  m_algList.size() << " algorithms" << endmsg;

  return StatusCode::SUCCESS;

}

StatusCode SequentialSchedulerSvc::popFinishedEvent ( EventContext *&  eventContext )

virtual

Blocks until an event is availble.

Definition at line 154 of file SequentialSchedulerSvc.cpp.

                                                                              {
  m_freeSlots++;
  eventContext = m_eventContext;
  debug() << "[popFinishedEvent] Free slots are now: " << m_freeSlots << endmsg;
  return StatusCode::SUCCESS;
}

StatusCode SequentialSchedulerSvc::pushNewEvent ( EventContext *  eventContext )

virtual

Make an event available to the scheduler.

Immediately the algortihms are executed.

Definition at line 69 of file SequentialSchedulerSvc.cpp.

                                                                         {

  m_freeSlots--;

  debug() << "[pushNewEvent] Free slots are now: " << m_freeSlots << endmsg;

  // Call the resetExecuted() method of ALL "known" algorithms
  // (From the MinimalEventLoopMgr)
  SmartIF<IAlgManager> algMan(serviceLocator());
  if (LIKELY(algMan.isValid())) {
    for( IAlgorithm* ialg : algMan->getAlgorithms() ) {
      if (LIKELY(nullptr != ialg)) ialg->resetExecuted();
    }
  }

  m_eventContext= eventContext;
  bool eventfailed=false;

  for (IAlgorithm* ialgorithm : m_algList){

    Algorithm* this_algo = dynamic_cast<Algorithm*>(ialgorithm);
    if (!this_algo){
      throw GaudiException ("Cast to Algorithm failed!",
                            "SequentialSchedulerSvc",
                            StatusCode::FAILURE);
    }

    debug() << "Running algorithm " << this_algo->name() << endmsg;

    // m_eventContext->m_thread_id = pthread_self();
    this_algo->setContext(m_eventContext);

    // Get the IProperty interface of the ApplicationMgr to pass it to RetCodeGuard
    const SmartIF<IProperty> appmgr(serviceLocator());

    // Call the execute() method of all top algorithms
    StatusCode sc(StatusCode::FAILURE);
    try {
      RetCodeGuard rcg(appmgr, Gaudi::ReturnCode::UnhandledException);
      sc = ialgorithm->sysExecute();
      if (UNLIKELY(!sc.isSuccess()))  {
        warning() << "Execution of algorithm " << ialgorithm->name() << " failed" << endmsg;
      eventfailed = true;
    }
      rcg.ignore(); // disarm the guard
    } catch ( const GaudiException& Exception ) {
      error() << ".executeEvent(): Exception with tag=" << Exception.tag()
              << " thrown by " << ialgorithm->name() << endmsg;
      error() << Exception << endmsg;
    } catch ( const std::exception& Exception ) {
      fatal() << ".executeEvent(): Standard std::exception thrown by "
              << ialgorithm->name() << endmsg;
      error() <<  Exception.what()  << endmsg;
    } catch(...) {
      fatal() << ".executeEvent(): UNKNOWN Exception thrown by "
              << ialgorithm->name() << endmsg;
    }

    debug() << "Algorithm " << this_algo->name() << (eventfailed ? " failed" : " succeeded") << endmsg;
    debug() << "Algorithm " << this_algo->name() << (this_algo->filterPassed() ? " passed" : " rejected") << endmsg;

    // DP it is important to propagate the failure of an event.
    // We need to stop execution when this happens so that execute run can
    // then receive the FAILURE
    m_eventContext->setFail(eventfailed);

    if (eventfailed)
      return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;

}

StatusCode SequentialSchedulerSvc::pushNewEvents ( std::vector< EventContext * > &  eventContexts )

virtual

Definition at line 143 of file SequentialSchedulerSvc.cpp.

                                                                                       {
  StatusCode sc;
  for (auto context : eventContexts){
    sc = pushNewEvent(context);
    if (sc != StatusCode::SUCCESS) return sc;
  }
  return sc;
}

StatusCode SequentialSchedulerSvc::tryPopFinishedEvent ( EventContext *&  eventContext )

virtual

Try to fetch an event from the scheduler.

The scheduler is sequential.

Therefore pop and try/pop are factually the same.

Definition at line 165 of file SequentialSchedulerSvc.cpp.

                                                                                 {
  return m_freeSlots == 1 ? StatusCode::FAILURE : popFinishedEvent(eventContext);
}

Member Data Documentation

std::list<IAlgorithm*> SequentialSchedulerSvc::m_algList

private

Cache the list of algs to be executed.

Definition at line 72 of file SequentialSchedulerSvc.h.

EventContext* SequentialSchedulerSvc::m_eventContext

private

The context of the event being processed.

Definition at line 75 of file SequentialSchedulerSvc.h.

int SequentialSchedulerSvc::m_freeSlots

private

The number of free slots (0 or 1)

Definition at line 78 of file SequentialSchedulerSvc.h.

bool SequentialSchedulerSvc::m_useTopAlgList

private

Decide if the top alglist or its flat version has to be used.

Definition at line 69 of file SequentialSchedulerSvc.h.

---

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

• GaudiHive/src/SequentialSchedulerSvc.h
• GaudiHive/src/SequentialSchedulerSvc.cpp