AlgResourcePool Class Reference

The AlgResourcePool is a concrete implementation of the IAlgResourcePool interface. More...

#include <GaudiHive/AlgResourcePool.h>

Inheritance diagram for AlgResourcePool:
Collaboration diagram for AlgResourcePool:

Public Member Functions

 ~AlgResourcePool () override
 
StatusCode start () override
 
StatusCode initialize () override
 
StatusCode acquireAlgorithm (const std::string &name, IAlgorithm *&algo, bool blocking=false) override
 Acquire a certain algorithm using its name. More...
 
StatusCode releaseAlgorithm (const std::string &name, IAlgorithm *&algo) override
 Release a certain algorithm. More...
 
StatusCode acquireResource (const std::string &name) override
 Acquire a certain resource. More...
 
StatusCode releaseResource (const std::string &name) override
 Release a certrain resource. More...
 
std::list< IAlgorithm * > getFlatAlgList () override
 
std::list< IAlgorithm * > getTopAlgList () override
 
StatusCode beginRun () override
 
StatusCode endRun () override
 
StatusCode stop () override
 
virtual concurrency::ExecutionFlowGraphgetExecutionFlowGraph () const
 
- Public Member Functions inherited from extends< Service, IAlgResourcePool >
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::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Service
const std::stringname () 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 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 PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 PropertyHolder ()=default
 
 ~PropertyHolder () override=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareRemoteProperty (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::PropertyBasegetProperty (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
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandle< TYPE > &ref, const std::string &doc="none")
 Specializations for various GaudiHandles. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ServiceHandle< TYPE > &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandleArray< TYPE > &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ServiceHandleArray< TYPE > &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, DataObjectHandle< TYPE > &ref, const std::string &doc="none")
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () 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 Types

typedef tbb::concurrent_bounded_queue< IAlgorithm * > concurrentQueueIAlgPtr
 
typedef std::list< SmartIF< IAlgorithm > > ListAlg
 
typedef boost::dynamic_bitset state_type
 

Private Member Functions

StatusCode decodeTopAlgs ()
 Decode the top alg list. More...
 
StatusCode flattenSequencer (Algorithm *sequencer, ListAlg &alglist, const std::string &parentName, unsigned int recursionDepth=0)
 Recursively flatten an algList. More...
 

Private Attributes

std::mutex m_resource_mutex
 
state_type m_available_resources {0}
 
std::map< size_t, concurrentQueueIAlgPtr * > m_algqueue_map
 
std::map< size_t, state_typem_resource_requirements
 
std::map< size_t, size_t > m_n_of_allowed_instances
 
std::map< size_t, unsigned int > m_n_of_created_instances
 
std::map< std::string, unsigned int > m_resource_indices
 
Gaudi::Property< bool > m_lazyCreation {this, "CreateLazily", false, ""}
 
Gaudi::Property< std::vector< std::string > > m_topAlgNames
 
ListAlg m_algList
 The list of all algorithms created withing the Pool which are not top. More...
 
ListAlg m_topAlgList
 The list of top algorithms. More...
 
ListAlg m_flatUniqueAlgList
 The flat list of algorithms w/o clones. More...
 
std::list< IAlgorithm * > m_flatUniqueAlgPtrList
 The flat list of algorithms w/o clones which is returned. More...
 
std::list< IAlgorithm * > m_topAlgPtrList
 The top list of algorithms. More...
 
concurrency::ExecutionFlowGraphm_EFGraph = nullptr
 OMG yet another hack. More...
 

Additional Inherited Members

- Public Types inherited from extends< Service, IAlgResourcePool >
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 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::PropertyBaseproperty (const std::string &name) const
 
- 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
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< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Detailed Description

The AlgResourcePool is a concrete implementation of the IAlgResourcePool interface.

It either creates all instances upfront or lazily. Internal bookkeeping is done via hashes of the algo names.

Author
Benedikt Hegner

Definition at line 34 of file AlgResourcePool.h.

Member Typedef Documentation

typedef tbb::concurrent_bounded_queue<IAlgorithm*> AlgResourcePool::concurrentQueueIAlgPtr
private

Definition at line 64 of file AlgResourcePool.h.

Definition at line 65 of file AlgResourcePool.h.

typedef boost::dynamic_bitset AlgResourcePool::state_type
private

Definition at line 66 of file AlgResourcePool.h.

Constructor & Destructor Documentation

AlgResourcePool::~AlgResourcePool ( )
override

Definition at line 24 of file AlgResourcePool.cpp.

24  {
25 
26  for (auto& algoId_algoQueue : m_algqueue_map){
27  auto* queue = algoId_algoQueue.second;
28  delete queue;
29  }
30 
31  delete m_EFGraph;
32 }
concurrency::ExecutionFlowGraph * m_EFGraph
OMG yet another hack.
std::map< size_t, concurrentQueueIAlgPtr * > m_algqueue_map

Member Function Documentation

StatusCode AlgResourcePool::acquireAlgorithm ( const std::string name,
IAlgorithm *&  algo,
bool  blocking = false 
)
override

Acquire a certain algorithm using its name.

Definition at line 85 of file AlgResourcePool.cpp.

85  {
86 
87  std::hash<std::string> hash_function;
88  size_t algo_id = hash_function(name);
89  auto itQueueIAlgPtr = m_algqueue_map.find(algo_id);
90 
91  if (itQueueIAlgPtr == m_algqueue_map.end()) {
92  error() << "Algorithm " << name << " requested, but not recognised"
93  << endmsg;
94  algo = nullptr;
95  return StatusCode::FAILURE;
96  }
97 
98  StatusCode sc;
99  if (blocking) {
100  itQueueIAlgPtr->second->pop(algo);
101  sc = StatusCode::SUCCESS;
102  } else {
103  sc = itQueueIAlgPtr->second->try_pop(algo);
104  }
105 
106  if(sc.isFailure())
107  DEBUG_MSG << "No instance of algorithm " << name << " could be retrieved in non-blocking mode" << endmsg;
108 
109  // if (m_lazyCreation ) {
110  // TODO: fill the lazyCreation part
111  // }
112  if (sc.isSuccess()){
113  state_type requirements = m_resource_requirements[algo_id];
115  if (requirements.is_subset_of(m_available_resources)) {
116  m_available_resources^=requirements;
117  } else {
118  sc = StatusCode::FAILURE;
119  error() << "Failure to allocate resources of algorithm " << name << endmsg;
120  itQueueIAlgPtr->second->push(algo);
121  }
123  }
124  return sc;
125 }
T unlock(T...args)
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
std::mutex m_resource_mutex
T end(T...args)
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
state_type m_available_resources
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
std::map< size_t, state_type > m_resource_requirements
T lock(T...args)
std::map< size_t, concurrentQueueIAlgPtr * > m_algqueue_map
boost::dynamic_bitset state_type
T find(T...args)
#define DEBUG_MSG
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode AlgResourcePool::acquireResource ( const std::string name)
override

Acquire a certain resource.

Definition at line 146 of file AlgResourcePool.cpp.

146  {
150  return StatusCode::SUCCESS;
151 }
T unlock(T...args)
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:289
std::map< std::string, unsigned int > m_resource_indices
std::mutex m_resource_mutex
state_type m_available_resources
T lock(T...args)
StatusCode AlgResourcePool::beginRun ( )
override

Definition at line 374 of file AlgResourcePool.cpp.

374  {
375  auto algBeginRun = [&] (SmartIF<IAlgorithm>& algoSmartIF) -> StatusCode {
376  StatusCode sc = algoSmartIF->sysBeginRun();
377  if (!sc.isSuccess()) {
378  warning() << "beginRun() of algorithm " << algoSmartIF->name() << " failed" << endmsg;
379  return StatusCode::FAILURE;
380  }
381  return StatusCode::SUCCESS;
382  };
383  // Call the beginRun() method of all algorithms
384  for (auto& algoSmartIF : m_flatUniqueAlgList ) {
385  if (algBeginRun(algoSmartIF).isFailure())
386  return StatusCode::FAILURE;
387  }
388 
389  return StatusCode::SUCCESS;
390 }
ListAlg m_flatUniqueAlgList
The flat list of algorithms w/o clones.
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode AlgResourcePool::decodeTopAlgs ( )
private

Decode the top alg list.

Definition at line 214 of file AlgResourcePool.cpp.

214  {
215 
217  if (!algMan.isValid()){
218  error() << "Algorithm manager could not be properly fetched." << endmsg;
219  return StatusCode::FAILURE;
220  }
221 
222  // Useful lambda not to repeat ourselves --------------------------
223  auto createAlg = [&algMan,this] (const std::string& item_type,
224  const std::string& item_name,
225  IAlgorithm*& algo){
226  StatusCode createAlgSc = algMan->createAlgorithm(item_type,
227  item_name,
228  algo,
229  true,
230  false);
231  if (createAlgSc.isFailure())
232  this->warning() << "Algorithm " << item_type << "/" << item_name
233  << " could not be created." << endmsg;
234  };
235  // End of lambda --------------------------------------------------
236 
238 
239  // Fill the top alg list ----
240  const std::vector<std::string>& topAlgNames = m_topAlgNames.value();
241  for (auto& name : topAlgNames) {
242  IAlgorithm* algo(nullptr);
243 
245  const std::string& item_name = item.name();
246  const std::string& item_type = item.type();
247  SmartIF<IAlgorithm> algoSmartIF (algMan->algorithm(item_name,false));
248 
249  if (!algoSmartIF.isValid()){
250  createAlg(item_type,item_name,algo);
251  algoSmartIF = algo;
252  }
253  // Init and start
254  algoSmartIF->sysInitialize();
255  m_topAlgList.push_back(algoSmartIF);
256  }
257  // Top Alg list filled ----
258 
259  // start forming the control flow graph by adding the head node
260  m_EFGraph->addHeadNode("EVENT LOOP",true,true,false);
261 
262  // Now we unroll it ----
263  for (auto& algoSmartIF : m_topAlgList){
264  Algorithm* algorithm = dynamic_cast<Algorithm*> (algoSmartIF.get());
265  if (!algorithm) fatal() << "Conversion from IAlgorithm to Algorithm failed" << endmsg;
266  sc = flattenSequencer(algorithm, m_flatUniqueAlgList, "EVENT LOOP");
267  }
268  if (msgLevel(MSG::DEBUG)){
269  debug() << "List of algorithms is: " << endmsg;
270  for (auto& algo : m_flatUniqueAlgList)
271  debug() << " o " << algo->type() << "/" << algo->name() << " @ " << algo << endmsg;
272  }
273 
274  // Unrolled ---
275 
276  // Now let's manage the clones
277  unsigned int resource_counter(0);
278  std::hash<std::string> hash_function;
279  for (auto& ialgoSmartIF : m_flatUniqueAlgList) {
280 
281  const std::string& item_name = ialgoSmartIF->name();
282 
283  verbose() << "Treating resource management and clones of " << item_name << endmsg;
284 
285  Algorithm* algo = dynamic_cast<Algorithm*> ( ialgoSmartIF.get() );
286  if (!algo) fatal() << "Conversion from IAlgorithm to Algorithm failed" << endmsg;
287  const std::string& item_type = algo->type();
288 
289  size_t algo_id = hash_function(item_name);
291  m_algqueue_map[algo_id] = queue;
292 
293  // DP TODO Do it properly with SmartIFs, also in the queues
294  IAlgorithm* ialgo(ialgoSmartIF.get());
295 
296  queue->push(ialgo);
297  m_algList.push_back(ialgo);
298  m_n_of_allowed_instances[algo_id] = ialgo->cardinality();
299  m_n_of_created_instances[algo_id] = 1;
300 
301  state_type requirements(0);
302 
303  for (auto& resource_name : ialgo->neededResources()){
304  auto ret = m_resource_indices.insert(std::pair<std::string, unsigned int>(resource_name,resource_counter));
305  // insert successful means == wasn't known before. So increment counter
306  if (ret.second==true) {
307  ++resource_counter;
308  }
309  // Resize for every algo according to the found resources
310  requirements.resize(resource_counter);
311  // in any case the return value holds the proper product index
312  requirements[ret.first->second] = true;
313 
314  }
315 
316  m_resource_requirements[algo_id] = requirements;
317 
318  // potentially create clones; if not lazy creation we have to do it now
319  if (!m_lazyCreation) {
320  for (unsigned int i =1, end =ialgo->cardinality();i<end; ++i){
321  debug() << "type/name to create clone of: " << item_type << "/"
322  << item_name << endmsg;
323  IAlgorithm* ialgoClone(nullptr);
324  createAlg(item_type,item_name,ialgoClone);
325  ialgoClone->setIndex(i);
326  if (ialgoClone->sysInitialize().isFailure()) {
327  error() << "unable to initialize Algorithm clone "
328  << ialgoClone->name() << endmsg;
329  sc = StatusCode::FAILURE;
330  // FIXME: should we delete this failed clone?
331  } else {
332  queue->push(ialgoClone);
333  m_n_of_created_instances[algo_id]+=1;
334  }
335  }
336  }
337 
339 
340  }
341 
342  // Now resize all the requirement bitsets to the same size
343  for (auto& kv : m_resource_requirements) {
344  kv.second.resize(resource_counter);
345  }
346 
347  // Set all resources to be available
348  m_available_resources.resize(resource_counter);
349  m_available_resources.set();
350 
351  return sc;
352 }
ListAlg m_flatUniqueAlgList
The flat list of algorithms w/o clones.
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:289
std::map< std::string, unsigned int > m_resource_indices
MsgStream & verbose() const
shortcut for the method msgStream(MSG::VERBOSE)
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
state_type m_available_resources
STL class.
T push_back(T...args)
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
Helper class to parse a string of format "type/name".
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
tbb::concurrent_bounded_queue< IAlgorithm * > concurrentQueueIAlgPtr
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
concurrency::ExecutionFlowGraph * m_EFGraph
OMG yet another hack.
std::map< size_t, state_type > m_resource_requirements
auto end(reverse_wrapper< T > &w)
Definition: reverse.h:49
Gaudi::Property< std::vector< std::string > > m_topAlgNames
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:27
std::map< size_t, concurrentQueueIAlgPtr * > m_algqueue_map
boost::dynamic_bitset state_type
T insert(T...args)
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
StatusCode flattenSequencer(Algorithm *sequencer, ListAlg &alglist, const std::string &parentName, unsigned int recursionDepth=0)
Recursively flatten an algList.
void addHeadNode(const std::string &headName, bool modeOR, bool allPass, bool isLazy)
Add a node, which has no parents.
std::map< size_t, unsigned int > m_n_of_created_instances
MsgStream & fatal() const
shortcut for the method msgStream(MSG::FATAL)
ListAlg m_topAlgList
The list of top algorithms.
const std::string & type() const override
The type of the algorithm object.
Definition: Algorithm.h:165
MSG::Level msgLevel() const
get the output level from the embedded MsgStream
void attachAlgorithmsToNodes(const std::string &algo_name, const T &container)
Attach pointers to real Algorithms (and their clones) to Algorithm nodes of the graph.
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:292
std::map< size_t, size_t > m_n_of_allowed_instances
ListAlg m_algList
The list of all algorithms created withing the Pool which are not top.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
Gaudi::Property< bool > m_lazyCreation
StatusCode AlgResourcePool::endRun ( )
override

Definition at line 394 of file AlgResourcePool.cpp.

394  {
395 
396  auto algEndRun = [&] (SmartIF<IAlgorithm>& algoSmartIF) -> StatusCode {
397  StatusCode sc = algoSmartIF->sysEndRun();
398  if (!sc.isSuccess()) {
399  warning() << "endRun() of algorithm " << algoSmartIF->name() << " failed" << endmsg;
400  return StatusCode::FAILURE;
401  }
402  return StatusCode::SUCCESS;
403  };
404  // Call the beginRun() method of all top algorithms
405  for (auto& algoSmartIF : m_flatUniqueAlgList ) {
406  if (algEndRun(algoSmartIF).isFailure())
407  return StatusCode::FAILURE;
408  }
409  for (auto& algoSmartIF : m_topAlgList ) {
410  if (algEndRun(algoSmartIF).isFailure())
411  return StatusCode::FAILURE;
412  }
413  return StatusCode::SUCCESS;
414 }
ListAlg m_flatUniqueAlgList
The flat list of algorithms w/o clones.
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
ListAlg m_topAlgList
The list of top algorithms.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode AlgResourcePool::flattenSequencer ( Algorithm sequencer,
ListAlg alglist,
const std::string parentName,
unsigned int  recursionDepth = 0 
)
private

Recursively flatten an algList.

Definition at line 164 of file AlgResourcePool.cpp.

164  {
165 
167 
168  std::vector<Algorithm*>* subAlgorithms = algo->subAlgorithms();
169  if ( // we only want to add basic algorithms -> have no subAlgs
170  // and exclude the case of empty GaudiSequencers
171  (subAlgorithms->empty() and not (algo->type() == "GaudiSequencer"))
172  // we want to add non-empty GaudiAtomicSequencers
173  or (algo->type() == "GaudiAtomicSequencer" and not subAlgorithms->empty())){
174 
175  DEBUG_MSG << std::string(recursionDepth, ' ') << algo->name() << " is "
176  << (algo->type() != "GaudiAtomicSequencer" ? "not a sequencer" : "an atomic sequencer")
177  << ". Appending it" << endmsg;
178 
179  alglist.emplace_back(algo);
180  m_EFGraph->addAlgorithmNode(algo, parentName, false, false).ignore();
181  return sc;
182  }
183 
184  // Recursively unroll
185  ++recursionDepth;
186  DEBUG_MSG << std::string(recursionDepth, ' ') << algo->name() << " is a sequencer. Flattening it." << endmsg;
187  bool modeOR = false;
188  bool allPass = false;
189  bool isLazy = false;
190  if ("GaudiSequencer" == algo->type()) {
191  modeOR = (algo->getProperty("ModeOR").toString() == "True")? true : false;
192  allPass = (algo->getProperty("IgnoreFilterPassed").toString() == "True")? true : false;
193  isLazy = (algo->getProperty("ShortCircuit").toString() == "True")? true : false;
194  if (allPass) isLazy = false; // standard GaudiSequencer behavior on all pass is to execute everything
195  }
196  sc = m_EFGraph->addDecisionHubNode(algo, parentName, modeOR, allPass, isLazy);
197  if (sc.isFailure()) {
198  error() << "Failed to add DecisionHub " << algo->name() << " to execution flow graph" << endmsg;
199  return sc;
200  }
201 
202  for (Algorithm* subalgo : *subAlgorithms ) {
203  sc = flattenSequencer(subalgo,alglist,algo->name(),recursionDepth);
204  if (sc.isFailure()) {
205  error() << "Algorithm " << subalgo->name() << " could not be flattened" << endmsg;
206  return sc;
207  }
208  }
209  return sc;
210 }
T empty(T...args)
StatusCode addDecisionHubNode(Algorithm *daughterAlgo, const std::string &parentName, bool modeOR, bool allPass, bool isLazy)
Add a node, which aggregates decisions of direct daughter nodes.
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
STL class.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
concurrency::ExecutionFlowGraph * m_EFGraph
OMG yet another hack.
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
StatusCode addAlgorithmNode(Algorithm *daughterAlgo, const std::string &parentName, bool inverted, bool allPass)
Add algorithm node.
StatusCode flattenSequencer(Algorithm *sequencer, ListAlg &alglist, const std::string &parentName, unsigned int recursionDepth=0)
Recursively flatten an algList.
#define DEBUG_MSG
void ignore() const
Definition: StatusCode.h:106
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
virtual concurrency::ExecutionFlowGraph* AlgResourcePool::getExecutionFlowGraph ( ) const
inlinevirtual

Definition at line 61 of file AlgResourcePool.h.

61 { return m_EFGraph; }
concurrency::ExecutionFlowGraph * m_EFGraph
OMG yet another hack.
std::list< IAlgorithm * > AlgResourcePool::getFlatAlgList ( )
override

Definition at line 356 of file AlgResourcePool.cpp.

356  {
358  for (auto algoSmartIF :m_flatUniqueAlgList )
359  m_flatUniqueAlgPtrList.push_back(const_cast<IAlgorithm*>(algoSmartIF.get()));
360  return m_flatUniqueAlgPtrList;
361 }
ListAlg m_flatUniqueAlgList
The flat list of algorithms w/o clones.
T push_back(T...args)
std::list< IAlgorithm * > m_flatUniqueAlgPtrList
The flat list of algorithms w/o clones which is returned.
T clear(T...args)
std::list< IAlgorithm * > AlgResourcePool::getTopAlgList ( )
override

Definition at line 365 of file AlgResourcePool.cpp.

365  {
367  for (auto algoSmartIF :m_topAlgList )
368  m_topAlgPtrList.push_back(const_cast<IAlgorithm*>(algoSmartIF.get()));
369  return m_topAlgPtrList;
370 }
T push_back(T...args)
std::list< IAlgorithm * > m_topAlgPtrList
The top list of algorithms.
T clear(T...args)
ListAlg m_topAlgList
The list of top algorithms.
StatusCode AlgResourcePool::initialize ( )
override

Definition at line 37 of file AlgResourcePool.cpp.

37  {
38 
40  if (!sc.isSuccess())
41  warning () << "Base class could not be started" << endmsg;
42 
43  // Try to recover the topAlgList from the ApplicationManager for backward-compatibility
44  if (m_topAlgNames.value().empty()){
45  info() << "TopAlg list empty. Recovering the one of Application Manager" << endmsg;
46  const Gaudi::Utils::TypeNameString appMgrName("ApplicationMgr/ApplicationMgr");
47  SmartIF<IProperty> appMgrProps (serviceLocator()->service(appMgrName));
48  m_topAlgNames.assign(appMgrProps->getProperty("TopAlg"));
49  }
50 
51  // XXX: Prepare empty Control Flow graph
52  const std::string& name = "ExecutionFlowGraph";
55 
56  sc = decodeTopAlgs();
57  if (sc.isFailure())
58  warning() << "Algorithms could not be properly decoded." << endmsg;
59 
60  // let's assume all resources are there
62  return StatusCode::SUCCESS;
63 }
StatusCode initialize() override
Definition: Service.cpp:64
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:289
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
state_type m_available_resources
STL class.
Helper class to parse a string of format "type/name".
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
concurrency::ExecutionFlowGraph * m_EFGraph
OMG yet another hack.
Gaudi::Property< std::vector< std::string > > m_topAlgNames
StatusCode decodeTopAlgs()
Decode the top alg list.
StatusCode service(const std::string &name, const T *&psvc, bool createIf=true) const
Access a service by name, creating it if it doesn&#39;t already exist.
Definition: Service.h:85
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:292
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode AlgResourcePool::releaseAlgorithm ( const std::string name,
IAlgorithm *&  algo 
)
override

Release a certain algorithm.

Definition at line 129 of file AlgResourcePool.cpp.

129  {
130 
131  std::hash<std::string> hash_function;
132  size_t algo_id = hash_function(name);
133 
134  // release resources used by the algorithm
138 
139  //release algorithm itself
140  m_algqueue_map[algo_id]->push(algo);
141  return StatusCode::SUCCESS;
142  }
T unlock(T...args)
std::mutex m_resource_mutex
state_type m_available_resources
std::map< size_t, state_type > m_resource_requirements
T lock(T...args)
std::map< size_t, concurrentQueueIAlgPtr * > m_algqueue_map
StatusCode AlgResourcePool::releaseResource ( const std::string name)
override

Release a certrain resource.

Definition at line 155 of file AlgResourcePool.cpp.

155  {
159  return StatusCode::SUCCESS;
160 }
T unlock(T...args)
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:289
std::map< std::string, unsigned int > m_resource_indices
std::mutex m_resource_mutex
state_type m_available_resources
T lock(T...args)
StatusCode AlgResourcePool::start ( )
override

Definition at line 67 of file AlgResourcePool.cpp.

67  {
68 
69  StatusCode startSc = Service::start();
70  if ( ! startSc.isSuccess() ) return startSc;
71 
72  // sys-Start the algos
73  for (auto& ialgo : m_algList){
74  startSc = ialgo->sysStart();
75  if (startSc.isFailure()){
76  error() << "Unable to start Algorithm: " << ialgo->name() << endmsg;
77  return startSc;
78  }
79  }
80  return StatusCode::SUCCESS;
81 }
StatusCode start() override
Definition: Service.cpp:137
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
ListAlg m_algList
The list of all algorithms created withing the Pool which are not top.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode AlgResourcePool::stop ( )
override

Definition at line 418 of file AlgResourcePool.cpp.

418  {
419 
420  StatusCode stopSc = Service::stop();
421  if ( ! stopSc.isSuccess() ) return stopSc;
422 
423  // sys-Stop the algos
424  for (auto& ialgo : m_algList){
425  stopSc = ialgo->sysStop();
426  if (stopSc.isFailure()){
427  error() << "Unable to stop Algorithm: " << ialgo->name() << endmsg;
428  return stopSc;
429  }
430  }
431  return StatusCode::SUCCESS;
432 }
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
StatusCode stop() override
Definition: Service.cpp:130
ListAlg m_algList
The list of all algorithms created withing the Pool which are not top.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244

Member Data Documentation

ListAlg AlgResourcePool::m_algList
private

The list of all algorithms created withing the Pool which are not top.

Definition at line 89 of file AlgResourcePool.h.

std::map<size_t, concurrentQueueIAlgPtr*> AlgResourcePool::m_algqueue_map
private

Definition at line 71 of file AlgResourcePool.h.

state_type AlgResourcePool::m_available_resources {0}
private

Definition at line 70 of file AlgResourcePool.h.

concurrency::ExecutionFlowGraph* AlgResourcePool::m_EFGraph = nullptr
private

OMG yet another hack.

Definition at line 104 of file AlgResourcePool.h.

ListAlg AlgResourcePool::m_flatUniqueAlgList
private

The flat list of algorithms w/o clones.

Definition at line 95 of file AlgResourcePool.h.

std::list<IAlgorithm*> AlgResourcePool::m_flatUniqueAlgPtrList
private

The flat list of algorithms w/o clones which is returned.

Definition at line 98 of file AlgResourcePool.h.

Gaudi::Property<bool> AlgResourcePool::m_lazyCreation {this, "CreateLazily", false, ""}
private

Definition at line 84 of file AlgResourcePool.h.

std::map<size_t, size_t> AlgResourcePool::m_n_of_allowed_instances
private

Definition at line 73 of file AlgResourcePool.h.

std::map<size_t, unsigned int> AlgResourcePool::m_n_of_created_instances
private

Definition at line 74 of file AlgResourcePool.h.

std::map<std::string, unsigned int> AlgResourcePool::m_resource_indices
private

Definition at line 75 of file AlgResourcePool.h.

std::mutex AlgResourcePool::m_resource_mutex
private

Definition at line 68 of file AlgResourcePool.h.

std::map<size_t, state_type> AlgResourcePool::m_resource_requirements
private

Definition at line 72 of file AlgResourcePool.h.

ListAlg AlgResourcePool::m_topAlgList
private

The list of top algorithms.

Definition at line 92 of file AlgResourcePool.h.

Gaudi::Property<std::vector<std::string> > AlgResourcePool::m_topAlgNames
private
Initial value:
{
this, "TopAlg", {}, "names of the algorithms to be passed to the algorithm manager"}

Definition at line 85 of file AlgResourcePool.h.

std::list<IAlgorithm*> AlgResourcePool::m_topAlgPtrList
private

The top list of algorithms.

Definition at line 101 of file AlgResourcePool.h.


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