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< Service, IScheduler >
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...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value 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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public 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 CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

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 output level 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 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< Service, IScheduler >
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 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...

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 CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

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

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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.

31 {}

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.

173 {return m_freeSlots;}

SequentialSchedulerSvc::m_freeSlots

int m_freeSlots

The number of free slots (0 or 1)

Definition: SequentialSchedulerSvc.h:79

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 73 of file SequentialSchedulerSvc.h.

EventContext* SequentialSchedulerSvc::m_eventContext

private

The context of the event being processed.

Definition at line 76 of file SequentialSchedulerSvc.h.

int SequentialSchedulerSvc::m_freeSlots

private

The number of free slots (0 or 1)

Definition at line 79 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 70 of file SequentialSchedulerSvc.h.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation