Please refer to the full documentation of the methods for more details. More...

#include <GaudiHive/src/IOBoundAlgSchedulerSvc.h>

Inheritance diagram for IOBoundAlgSchedulerSvc:

[legend]

Collaboration diagram for IOBoundAlgSchedulerSvc:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialise. More...

StatusCode	finalize () override
	Finalise. More...

StatusCode	push (IAlgTask &task) override
	Add an algorithm to local queue to run on accelerator. More...

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

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

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

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

MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...

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

Private Types
typedef std::function< StatusCode()>	action

Private Member Functions
void	activate ()
	Activate scheduler. More...

StatusCode	deactivate ()
	Deactivate scheduler. More...

Private Attributes
bool	m_isActive = false
	Flag to track if the scheduler is active or not. More...

std::thread	m_thread
	The thread in which the activate function runs. More...

tbb::concurrent_bounded_queue< action >	m_actionsQueue
	This is done since the copy of the lambda storage is too expensive. More...

Additional Inherited Members
Public Types inherited from extends< Service, IAccelerator >
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...

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 () 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"}

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

Please refer to the full documentation of the methods for more details.

Author: Illya Shapoval

Version: 1.0

Definition at line 25 of file IOBoundAlgSchedulerSvc.h.

Member Typedef Documentation

typedef std::function<StatusCode()> IOBoundAlgSchedulerSvc::action

private

Definition at line 56 of file IOBoundAlgSchedulerSvc.h.

Member Function Documentation

void IOBoundAlgSchedulerSvc::activate ( )

private

Activate scheduler.

Activate the scheduler.

From this moment on the queue of actions is checked. The checking will stop when the m_isActive flag is false and the queue is not empty. This will guarantee that all actions are executed and a stall is not created.

Definition at line 63 of file IOBoundAlgSchedulerSvc.cpp.

 {
 
   // Now it's running
   m_isActive = true;
 
   // Wait for actions pushed into the queue by finishing tasks.
   action     thisAction;
   StatusCode sc( StatusCode::SUCCESS );
 
   // Continue to wait if the scheduler is running or there is something to do
   info() << "Start checking the queue of I/O-bound algorithm tasks.." << endmsg;
   while ( m_isActive or m_actionsQueue.size() > 0 ) {
     m_actionsQueue.pop( thisAction );
     std::thread th( thisAction );
     th.detach();
   }
 }

StatusCode IOBoundAlgSchedulerSvc::deactivate ( )

private

Deactivate scheduler.

Deactivates the scheduler.

Two actions are pushed into the queue: 1) Drain the scheduler until all events are finished. 2) Flip the status flag m_isActive to false This second action is the last one to be executed by the scheduler.

Definition at line 90 of file IOBoundAlgSchedulerSvc.cpp.

 {
 
   if ( m_isActive ) {
     // Drain the scheduler
     // m_actionsQueue.push(std::bind(&IOBoundSchedulerSvc::m_drain,
     //                              this));
     // we set the flag in this thread, not in the last action, to avoid stall,
     // since we execute tasks asynchronously, in a detached thread, and it's possible that
     // the task doesn't complete by the time the last while-iteration is entered
     m_isActive = false;
     // This would be the last (empty) action, just to trigger one last while-iteration
     m_actionsQueue.push( []() -> StatusCode { return StatusCode::SUCCESS; } );
   }
 
   return StatusCode::SUCCESS;
 }

StatusCode IOBoundAlgSchedulerSvc::finalize ( )

override

Finalise.

Here the scheduler is deactivated and the thread joined.

Definition at line 42 of file IOBoundAlgSchedulerSvc.cpp.

 {
 
   StatusCode sc( Service::finalize() );
   if ( !sc.isSuccess() ) warning() << "Base class could not be finalized" << endmsg;
 
   sc = deactivate();
   if ( !sc.isSuccess() ) warning() << "Scheduler could not be deactivated" << endmsg;
 
   info() << "Joining preemptive scheduler's thread" << endmsg;
   m_thread.join();
 
   return sc;
 }

StatusCode IOBoundAlgSchedulerSvc::initialize ( )

override

Initialise.

Here, among some "bureaucracy" operations, the scheduler is activated, executing the activate() function in a new thread.

Definition at line 24 of file IOBoundAlgSchedulerSvc.cpp.

 {
 
   // Initialise mother class (read properties, ...)
   StatusCode sc( Service::initialize() );
   if ( !sc.isSuccess() ) warning() << "Base class could not be initialized" << endmsg;
 
   // Activate the scheduler in another thread.
   info() << "Activating scheduler in a separate thread" << endmsg;
   m_thread = std::thread( std::bind( &IOBoundAlgSchedulerSvc::activate, this ) );
 
   return sc;
 }

StatusCode IOBoundAlgSchedulerSvc::push ( IAlgTask & task )

override

Add an algorithm to local queue to run on accelerator.

Definition at line 108 of file IOBoundAlgSchedulerSvc.cpp.

 {
 
   // the temporary lambda should be moved into the queue in here
   auto actionn = [&]() {
     debug() << " .. launching I/O-bound algo-closure .. " << endmsg;
     return task.execute();
   };
 
   m_actionsQueue.push( actionn );
 
   // until the queue to accelerator becomes limited
   return StatusCode::SUCCESS;
 }

Member Data Documentation

tbb::concurrent_bounded_queue<action> IOBoundAlgSchedulerSvc::m_actionsQueue

private

This is done since the copy of the lambda storage is too expensive.

Queue where closures are stored and picked for execution

Definition at line 60 of file IOBoundAlgSchedulerSvc.h.

bool IOBoundAlgSchedulerSvc::m_isActive = false

private

Flag to track if the scheduler is active or not.

Definition at line 49 of file IOBoundAlgSchedulerSvc.h.

std::thread IOBoundAlgSchedulerSvc::m_thread

private

The thread in which the activate function runs.

Definition at line 52 of file IOBoundAlgSchedulerSvc.h.

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

GaudiHive/src/IOBoundAlgSchedulerSvc.h
GaudiHive/src/IOBoundAlgSchedulerSvc.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation