#include <src/ThreadPoolSvc.h>

Inheritance diagram for ThreadPoolSvc:

Collaboration diagram for ThreadPoolSvc:

Public Member Functions
	ThreadPoolSvc (const std::string &name, ISvcLocator *svc)
	Constructor. More...

	~ThreadPoolSvc ()
	Destructor. More...

virtual StatusCode	initialize ()
	Initialise. More...

virtual StatusCode	finalize ()
	Finalise. More...

virtual StatusCode	initPool (const int &poolSize)

virtual int	poolSize () const

virtual bool	isInit () const

virtual std::vector< IThreadInitTool * >	getThreadInitTools () const

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

int	m_threadPoolSize

ToolHandleArray< IThreadInitTool >	m_threadInitTools

tbb::spin_mutex	m_initMutex

tbb::task_scheduler_init *	m_tbbSchedInit

boost::barrier *	m_barrier

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

Definition at line 15 of file ThreadPoolSvc.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 19 of file ThreadPoolSvc.cpp.

                                                                         :
   base_class(name,svcLoc),
   m_init(false),
   m_threadPoolSize(0),
   m_threadInitTools(this),
   m_tbbSchedInit(0),
   m_barrier(0)
 {
 
   declareProperty("ThreadInitTools", m_threadInitTools, "ToolHandleArray of IThreadInitTools");
 
 }

ThreadPoolSvc::~ThreadPoolSvc ( )

Destructor.

Definition at line 34 of file ThreadPoolSvc.cpp.

                               {
 
   if (m_tbbSchedInit)
     delete m_tbbSchedInit;
 
   if (m_barrier)
     delete m_barrier;
 
 }

Member Function Documentation

StatusCode ThreadPoolSvc::finalize ( )

virtual

Finalise.

Definition at line 78 of file ThreadPoolSvc.cpp.

                         {
 
   if (!m_init) {
     warning() << "Looks like the ThreadPoolSvc was created, but thread pool was never initialized"
     << endmsg;
   }
 
   return StatusCode::SUCCESS;
 
 }

std::vector< IThreadInitTool * > ThreadPoolSvc::getThreadInitTools ( ) const

virtual

Definition at line 177 of file ThreadPoolSvc.cpp.

                                         {
 
   std::vector<IThreadInitTool*> tools;
 
   ToolHandleArray<IThreadInitTool>::const_iterator ito = m_threadInitTools.begin();
   for ( ; ito != m_threadInitTools.end(); ++ito ) {
     IThreadInitTool* it = &(**ito);
     tools.push_back(it);
   }
 
   return tools;
 }

StatusCode ThreadPoolSvc::initialize ( )

virtual

Initialise.

Definition at line 47 of file ThreadPoolSvc.cpp.

                           {
 
   // Initialise mother class (read properties, ...)
   StatusCode sc(Service::initialize());
   if (!sc.isSuccess()) {
     warning () << "Base class could not be initialized" << endmsg;
     return StatusCode::FAILURE;
   }
 
   if (m_threadInitTools.retrieve().isFailure()) {
     error() << "Unable to retrieve ThreadInitTools Array"
         << endmsg;
 
     return StatusCode::FAILURE;
   } else {
     if (m_threadInitTools.size() != 0) {
       info() << "retrieved " << m_threadInitTools.size() << " thread init tools"
          << endmsg;
     } else {
       info() << "no thread init tools attached"
          << endmsg;
     }
   }
 
   return StatusCode::SUCCESS;
 
 }

StatusCode ThreadPoolSvc::initPool ( const int & poolSize )

virtual

Definition at line 92 of file ThreadPoolSvc.cpp.

                                            {
 
   tbb::spin_mutex::scoped_lock  lock( m_initMutex );
 
   m_threadPoolSize = poolSize;
 
   if (msgLevel(MSG::DEBUG))
     debug() << "ThreadPoolSvc::initPool() poolSize = " << poolSize << endmsg;
 
   // -100 prevents the creation of the pool and the scheduler directly executes
   // the tasks.
   if (-100 != m_threadPoolSize){
     if (msgLevel(MSG::DEBUG))
       debug() << "Initialising a ThreadPool thread pool of size " << m_threadPoolSize
               << endmsg;
     // Leave -1 in case selected, increment otherwise
     int thePoolSize=m_threadPoolSize;
     if (thePoolSize!=-1)
       thePoolSize+=1;
     m_tbbSchedInit = new tbb::task_scheduler_init (thePoolSize);
 
     // execute the Thread Init Tools if there are any, and wait at barrier
     if (m_threadInitTools.size() > 0) {
       if (msgLevel(MSG::DEBUG))
         debug() << "creating barrier of size " << m_threadPoolSize + 1 << endmsg;
       m_barrier = new boost::barrier( m_threadPoolSize + 1 );
 
       // create ThreadInitTasks, wait until all have executed
       for (int i=0; i<m_threadPoolSize; ++i) {
         if (msgLevel(MSG::DEBUG))
           debug() << "creating ThreadInitTask " << i << endmsg;
         tbb::task* t = new(tbb::task::allocate_root())
           ThreadInitTask( m_threadInitTools, m_barrier, serviceLocator() );
 
         tbb::task::enqueue( *t );
         this_tbb_thread::sleep(tbb::tick_count::interval_t(.1));
       }
     }
 
   } else {
     if (msgLevel(MSG::DEBUG))
       debug() << "Thread pool size is one. Pool not initialised." << endmsg;
 
     if (m_threadInitTools.size() > 0) {
       if (msgLevel(MSG::DEBUG))
         debug() << "doing ThreadInitTask init in this thread" << endmsg;
       ThreadInitTask theTask(m_threadInitTools, m_barrier, serviceLocator() );
       theTask.execute();
     }
 
   }
 
   if (m_barrier) {
     if (msgLevel(MSG::DEBUG))
       debug() << "waiting at barrier for all ThreadInitTool to finish executing" << endmsg;
     m_barrier->wait();
   }
 
   if (ThreadInitTask::execFailed()) {
     error() << "a ThreadInitTask failed to execute successfully" << endmsg;
     return StatusCode::FAILURE;
   }
 
   // check to make sure all Tools were initialized
   for (auto t : m_threadInitTools) {
     if (t->nInit() != (unsigned int)m_threadPoolSize && m_threadPoolSize != -100) {
       error() << " not all threads initialized for tool " << t << " : "
           << t->nInit() << " out of " << m_threadPoolSize
           << endmsg;
       return StatusCode::FAILURE;
     }
   }
 
   if (msgLevel(MSG::DEBUG))
     debug() << " Thread Pool initialization complete!" << endmsg;
 
   m_init = true;
 
   return StatusCode::SUCCESS;
 
 }

virtual bool ThreadPoolSvc::isInit ( ) const

inlinevirtual

Definition at line 33 of file ThreadPoolSvc.h.

33 { return m_init; }

ThreadPoolSvc::m_init

bool m_init

Definition: ThreadPoolSvc.h:39

virtual int ThreadPoolSvc::poolSize ( ) const

inlinevirtual

Definition at line 32 of file ThreadPoolSvc.h.

32 {return m_threadPoolSize;}

ThreadPoolSvc::m_threadPoolSize

int m_threadPoolSize

Definition: ThreadPoolSvc.h:40

Member Data Documentation

boost::barrier* ThreadPoolSvc::m_barrier

private

Definition at line 48 of file ThreadPoolSvc.h.

bool ThreadPoolSvc::m_init

private

Definition at line 39 of file ThreadPoolSvc.h.

tbb::spin_mutex ThreadPoolSvc::m_initMutex

private

Definition at line 44 of file ThreadPoolSvc.h.

tbb::task_scheduler_init* ThreadPoolSvc::m_tbbSchedInit

private

Definition at line 46 of file ThreadPoolSvc.h.

ToolHandleArray<IThreadInitTool> ThreadPoolSvc::m_threadInitTools

private

Definition at line 42 of file ThreadPoolSvc.h.

int ThreadPoolSvc::m_threadPoolSize

private

Definition at line 40 of file ThreadPoolSvc.h.

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

GaudiHive/src/ThreadPoolSvc.h
GaudiHive/src/ThreadPoolSvc.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation