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 (const std::string &name, ISvcLocator *svc)
	~AlgResourcePool ()
virtual StatusCode	start ()
virtual StatusCode	initialize ()
virtual StatusCode	acquireAlgorithm (const std::string &name, IAlgorithm *&algo, bool blocking=false)
	Acquire a certain algorithm using its name. More...
virtual StatusCode	releaseAlgorithm (const std::string &name, IAlgorithm *&algo)
	Release a certain algorithm. More...
virtual StatusCode	acquireResource (const std::string &name)
	Acquire a certain resource. More...
virtual StatusCode	releaseResource (const std::string &name)
	Release a certrain resource. More...
virtual std::list< IAlgorithm * >	getFlatAlgList ()
virtual std::list< IAlgorithm * >	getTopAlgList ()
virtual StatusCode	beginRun ()
virtual StatusCode	endRun ()
virtual StatusCode	stop ()
virtual concurrency::ExecutionFlowGraph *	getExecutionFlowGraph () const
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 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
bool	m_lazyCreation
state_type	m_available_resources
std::map< size_t, concurrentQueueIAlgPtr * >	m_algqueue_map
std::map< size_t, state_type >	m_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
StringArrayProperty	m_topAlgNames
	The names of the algorithms to be passed to the algorithm manager. More...
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::ExecutionFlowGraph *	m_EFGraph
	OMG yet another hack. 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

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 63 of file AlgResourcePool.h.

typedef std::list<SmartIF<IAlgorithm> > AlgResourcePool::ListAlg

private

Definition at line 64 of file AlgResourcePool.h.

typedef boost::dynamic_bitset AlgResourcePool::state_type

private

Definition at line 65 of file AlgResourcePool.h.

Constructor & Destructor Documentation

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

Definition at line 19 of file AlgResourcePool.cpp.

                                                                          :
  base_class(name,svc), m_available_resources(0), m_EFGraph(0)
{
  declareProperty("CreateLazily", m_lazyCreation = false );
  declareProperty("TopAlg", m_topAlgNames );
}

AlgResourcePool::~AlgResourcePool

(

)

Definition at line 29 of file AlgResourcePool.cpp.

                                  {

  for (auto& algoId_algoQueue : m_algqueue_map){
    auto* queue = algoId_algoQueue.second;
    delete queue;
  }

  delete m_EFGraph;
}

Member Function Documentation

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

virtual

Acquire a certain algorithm using its name.

Definition at line 90 of file AlgResourcePool.cpp.

                                                                                                   {

  std::hash<std::string> hash_function;
  size_t algo_id = hash_function(name);
  auto itQueueIAlgPtr = m_algqueue_map.find(algo_id);

  if (itQueueIAlgPtr == m_algqueue_map.end()) {
    error() << "Algorithm " << name << " requested, but not recognised"
            << endmsg;
    algo = nullptr;
    return StatusCode::FAILURE;
  }

  StatusCode sc;
  if (blocking) {
    itQueueIAlgPtr->second->pop(algo);
    sc = StatusCode::SUCCESS;
  } else {
    sc = itQueueIAlgPtr->second->try_pop(algo);
  }

  if(sc.isFailure())
    if (msgLevel(MSG::DEBUG))
      debug() << "No instance of algorithm " << name << " could be retrieved in non-blocking mode" << endmsg;

  //  if (m_lazyCreation ) {
  // TODO: fill the lazyCreation part
  //}
  if (sc.isSuccess()){
    algo->resetExecuted();
    state_type requirements = m_resource_requirements[algo_id];
    m_resource_mutex.lock();
    if (requirements.is_subset_of(m_available_resources)) {
      m_available_resources^=requirements;
    } else {
      sc = StatusCode::FAILURE;
      error() << "Failure to allocate resources of algorithm " << name << endmsg;
      itQueueIAlgPtr->second->push(algo);
    }
    m_resource_mutex.unlock();
  }
  return sc;
}

StatusCode AlgResourcePool::acquireResource ( const std::string &  name )

virtual

Acquire a certain resource.

Definition at line 153 of file AlgResourcePool.cpp.

                                                                {
  m_resource_mutex.lock();
  m_available_resources[m_resource_indices[name]] = false;
  m_resource_mutex.unlock();
  return StatusCode::SUCCESS;
}

StatusCode AlgResourcePool::beginRun ( )

virtual

Definition at line 373 of file AlgResourcePool.cpp.

                                    {
  auto algBeginRun = [&] (SmartIF<IAlgorithm>& algoSmartIF) -> StatusCode {
    StatusCode sc = algoSmartIF->sysBeginRun();
    if (!sc.isSuccess()) {
      warning() << "beginRun() of algorithm " << algoSmartIF->name() << " failed" << endmsg;
    return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  };
  // Call the beginRun() method of all algorithms
  for (auto& algoSmartIF : m_flatUniqueAlgList ) {
    if (algBeginRun(algoSmartIF).isFailure())
      return StatusCode::FAILURE;
  }

  return StatusCode::SUCCESS;
}

StatusCode AlgResourcePool::decodeTopAlgs ( )

private

Decode the top alg list.

Definition at line 221 of file AlgResourcePool.cpp.

                                             {

  SmartIF<IAlgManager> algMan ( serviceLocator() );
  if (!algMan.isValid()){
    error() << "Algorithm manager could not be properly fetched." << endmsg;
    return StatusCode::FAILURE;
  }

  // Useful lambda not to repeat ourselves --------------------------
  auto createAlg = [&algMan,this] (const std::string& item_type,
                                   const std::string& item_name,
                                   IAlgorithm*& algo){
        StatusCode createAlgSc = algMan->createAlgorithm(item_type,
                                                         item_name,
                                                         algo,
                                                         true,
                                                         false);
        if (createAlgSc.isFailure())
          this->warning() << "Algorithm " << item_type << "/" << item_name
                          << " could not be created." << endmsg;
    };
  // End of lambda --------------------------------------------------

  StatusCode sc = StatusCode::SUCCESS;

  // Fill the top alg list ----
  const std::vector<std::string>& topAlgNames = m_topAlgNames.value();
  for (auto& name : topAlgNames) {
    IAlgorithm* algo(nullptr);

    Gaudi::Utils::TypeNameString item(name);
    const std::string& item_name = item.name();
    const std::string& item_type = item.type();
    SmartIF<IAlgorithm> algoSmartIF (algMan->algorithm(item_name,false));

    if (!algoSmartIF.isValid()){
      createAlg(item_type,item_name,algo);
      algoSmartIF = algo;
    }
    // Init and start
    algoSmartIF->sysInitialize();
    m_topAlgList.push_back(algoSmartIF);
  }
  // Top Alg list filled ----

  // start forming the control flow graph by adding the head node
  m_EFGraph->addHeadNode("EVENT LOOP",true,true,false);

  // Now we unroll it ----
  for (auto& algoSmartIF : m_topAlgList){
    Algorithm* algorithm = dynamic_cast<Algorithm*> (algoSmartIF.get());
    if (!algorithm) fatal() << "Conversion from IAlgorithm to Algorithm failed" << endmsg;
    sc = flattenSequencer(algorithm, m_flatUniqueAlgList, "EVENT LOOP");
  }
  if (outputLevel() <= MSG::DEBUG){
    debug() << "List of algorithms is: " << endmsg;
    for (auto& algo : m_flatUniqueAlgList)
      debug() << "  o " << algo->type() << "/" << algo->name() << " @ " << algo <<  endmsg;
  }

  // Unrolled ---

  // Now let's manage the clones
  unsigned int resource_counter(0);
  std::hash<std::string> hash_function;
  for (auto& ialgoSmartIF : m_flatUniqueAlgList) {

    const std::string& item_name = ialgoSmartIF->name();

    verbose() << "Treating resource management and clones of " << item_name << endmsg;

    Algorithm* algo = dynamic_cast<Algorithm*> ( ialgoSmartIF.get() );
    if (!algo) fatal() << "Conversion from IAlgorithm to Algorithm failed" << endmsg;
    const std::string& item_type = algo->type();

    size_t algo_id = hash_function(item_name);
    concurrentQueueIAlgPtr* queue = new concurrentQueueIAlgPtr();
    m_algqueue_map[algo_id] = queue;

    // DP TODO Do it properly with SmartIFs, also in the queues
    IAlgorithm* ialgo(ialgoSmartIF.get());

    queue->push(ialgo);
    m_algList.push_back(ialgo);
    m_n_of_allowed_instances[algo_id] = ialgo->cardinality();
    m_n_of_created_instances[algo_id] = 1;

    state_type requirements(0);

    for (auto& resource_name : ialgo->neededResources()){
      auto ret = m_resource_indices.insert(std::pair<std::string, unsigned int>(resource_name,resource_counter));
      // insert successful means == wasn't known before. So increment counter
      if (ret.second==true) {
         ++resource_counter;
      }
      // Resize for every algo according to the found resources
      requirements.resize(resource_counter);
      // in any case the return value holds the proper product index
      requirements[ret.first->second] = true;

    }

    m_resource_requirements[algo_id] = requirements;

    // potentially create clones; if not lazy creation we have to do it now
    if (!m_lazyCreation) {
      for (unsigned int i =1, end =ialgo->cardinality();i<end; ++i){
        debug() << "type/name to create clone of: " << item_type << "/" << item_name << endmsg;
        IAlgorithm* ialgoClone(nullptr);
        createAlg(item_type,item_name,ialgoClone);
        ialgoClone->sysInitialize();
        queue->push(ialgoClone);
        m_n_of_created_instances[algo_id]+=1;
      }
    }

    m_EFGraph->attachAlgorithmsToNodes<concurrentQueueIAlgPtr>(item_name,*queue);

  }

  // Now resize all the requirement bitsets to the same size
  for (auto& kv :  m_resource_requirements) {
    kv.second.resize(resource_counter);
  }

  // Set all resources to be available
  m_available_resources.resize(resource_counter);
  m_available_resources.set();

  return sc;
}

StatusCode AlgResourcePool::endRun ( )

virtual

Definition at line 393 of file AlgResourcePool.cpp.

                                   {

  auto algEndRun = [&] (SmartIF<IAlgorithm>& algoSmartIF) -> StatusCode {
    StatusCode sc = algoSmartIF->sysEndRun();
    if (!sc.isSuccess()) {
      warning() << "endRun() of algorithm " << algoSmartIF->name() << " failed" << endmsg;
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  };
  // Call the beginRun() method of all top algorithms
  for (auto& algoSmartIF : m_flatUniqueAlgList ) {
    if (algEndRun(algoSmartIF).isFailure())
    return StatusCode::FAILURE;
  }
  for (auto& algoSmartIF : m_topAlgList ) {
    if (algEndRun(algoSmartIF).isFailure())
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

StatusCode AlgResourcePool::flattenSequencer ( Algorithm *  sequencer, ListAlg &  alglist, const std::string &  parentName, unsigned int  recursionDepth = 0  )

private

Recursively flatten an algList.

Definition at line 171 of file AlgResourcePool.cpp.

                                                                                                                                       {

  StatusCode sc = StatusCode::SUCCESS;

  std::vector<Algorithm*>* subAlgorithms = algo->subAlgorithms();
  if ( //we only want to add basic algorithms -> have no subAlgs
          // and exclude the case of empty GaudiSequencers
       (subAlgorithms->empty() and not (algo->type() == "GaudiSequencer"))
       // we want to add non-empty GaudiAtomicSequencers
       or (algo->type() == "GaudiAtomicSequencer" and not subAlgorithms->empty())){

      debug() << std::string(recursionDepth, ' ') << algo->name() << " is " <<
              (algo->type() != "GaudiAtomicSequencer" ? "not a sequencer" : "an atomic sequencer")
              << ". Appending it" << endmsg;

      alglist.emplace_back(algo);
      m_EFGraph->addAlgorithmNode(algo,parentName,false,false);
    return sc;
  }

  // Recursively unroll
  ++recursionDepth;
  debug() << std::string(recursionDepth, ' ') << algo->name() << " is a sequencer. Flattening it." << endmsg;
  bool modeOR = false;
  bool allPass = false;
  bool isLazy = false;
  if ("GaudiSequencer" == algo->type()) {
    modeOR  = (algo->getProperty("ModeOR").toString() == "True")? true : false;
    allPass = (algo->getProperty("IgnoreFilterPassed").toString() == "True")? true : false;
    isLazy = (algo->getProperty("ShortCircuit").toString() == "True")? true : false;
    if (allPass) isLazy = false; // standard GaudiSequencer behavior on all pass is to execute everything
  }
  sc = m_EFGraph->addDecisionHubNode(algo,parentName,modeOR,allPass,isLazy);
  if (sc.isFailure()) {
    error() << "Failed to add DecisionHub " << algo->name() << " to execution flow graph" << endmsg;
    return sc;
  }

  for (Algorithm* subalgo : *subAlgorithms ) {
    sc = flattenSequencer(subalgo,alglist,algo->name(),recursionDepth);
    if (sc.isFailure()) {
      error() << "Algorithm " << subalgo->name() << " could not be flattened" << endmsg;
      return sc;
    }
  }
  return sc;
}

virtual concurrency::ExecutionFlowGraph* AlgResourcePool::getExecutionFlowGraph ( ) const

inlinevirtual

Definition at line 60 of file AlgResourcePool.h.

{return m_EFGraph;}

std::list< IAlgorithm * > AlgResourcePool::getFlatAlgList ( )

virtual

Definition at line 355 of file AlgResourcePool.cpp.

                                                    {
  m_flatUniqueAlgPtrList.clear();
  for (auto algoSmartIF :m_flatUniqueAlgList )
    m_flatUniqueAlgPtrList.push_back(const_cast<IAlgorithm*>(algoSmartIF.get()));
  return m_flatUniqueAlgPtrList;
}

std::list< IAlgorithm * > AlgResourcePool::getTopAlgList ( )

virtual

Definition at line 364 of file AlgResourcePool.cpp.

                                                   {
  m_topAlgPtrList.clear();
  for (auto algoSmartIF :m_topAlgList )
    m_topAlgPtrList.push_back(const_cast<IAlgorithm*>(algoSmartIF.get()));
  return m_topAlgPtrList;
}

StatusCode AlgResourcePool::initialize ( )

virtual

Definition at line 42 of file AlgResourcePool.cpp.

                                      {

  StatusCode sc(Service::initialize());
  if (!sc.isSuccess())
    warning () << "Base class could not be started" << endmsg;

  // Try to recover the topAlgList from the ApplicationManager for backward-compatibility
  if (m_topAlgNames.value().empty()){
    info() << "TopAlg list empty. Recovering the one of Application Manager" << endmsg;
    const Gaudi::Utils::TypeNameString appMgrName("ApplicationMgr/ApplicationMgr");
    SmartIF<IProperty> appMgrProps (serviceLocator()->service(appMgrName));
    m_topAlgNames.assign(appMgrProps->getProperty("TopAlg"));
  }

  // XXX: Prepare empty Control Flow graph
  const std::string& name = "ExecutionFlowGraph";
  SmartIF<ISvcLocator> svc = serviceLocator();
  m_EFGraph = new concurrency::ExecutionFlowGraph(name, svc);

  sc = decodeTopAlgs();
  if (sc.isFailure())
    warning() << "Algorithms could not be properly decoded." << endmsg;

  // let's assume all resources are there
  m_available_resources.set();
  return StatusCode::SUCCESS;
}

StatusCode AlgResourcePool::releaseAlgorithm ( const std::string &  name, IAlgorithm *&  algo  )

virtual

Release a certain algorithm.

Definition at line 136 of file AlgResourcePool.cpp.

                                                                                    {

  std::hash<std::string> hash_function;
  size_t algo_id = hash_function(name);

  // release resources used by the algorithm
  m_resource_mutex.lock();
  m_available_resources|= m_resource_requirements[algo_id];
  m_resource_mutex.unlock();

  //release algorithm itself
  m_algqueue_map[algo_id]->push(algo);
  return StatusCode::SUCCESS;
 }

StatusCode AlgResourcePool::releaseResource ( const std::string &  name )

virtual

Release a certrain resource.

Definition at line 162 of file AlgResourcePool.cpp.

                                                                {
  m_resource_mutex.lock();
  m_available_resources[m_resource_indices[name]] = true;
  m_resource_mutex.unlock();
  return StatusCode::SUCCESS;
}

StatusCode AlgResourcePool::start ( )

virtual

Definition at line 72 of file AlgResourcePool.cpp.

                                 {

  StatusCode startSc = Service::start();
  if ( ! startSc.isSuccess() ) return startSc;

  // sys-Start the algos
  for (auto& ialgo : m_algList){
    startSc = ialgo->sysStart();
    if (startSc.isFailure()){
      error() << "Unable to start Algorithm: " << ialgo->name() << endmsg;
      return startSc;
      }
    }
  return StatusCode::SUCCESS;
}

StatusCode AlgResourcePool::stop ( )

virtual

Definition at line 417 of file AlgResourcePool.cpp.

                                {

  StatusCode stopSc = Service::stop();
  if ( ! stopSc.isSuccess() ) return stopSc;

  // sys-Stop the algos
  for (auto& ialgo : m_algList){
    stopSc = ialgo->sysStop();
    if (stopSc.isFailure()){
      error() << "Unable to stop Algorithm: " << ialgo->name() << endmsg;
      return stopSc;
    }
    }
  return StatusCode::SUCCESS;
}

Member Data Documentation

ListAlg AlgResourcePool::m_algList

private

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

Definition at line 86 of file AlgResourcePool.h.

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

private

Definition at line 70 of file AlgResourcePool.h.

state_type AlgResourcePool::m_available_resources

private

Definition at line 69 of file AlgResourcePool.h.

concurrency::ExecutionFlowGraph* AlgResourcePool::m_EFGraph

private

OMG yet another hack.

Definition at line 101 of file AlgResourcePool.h.

ListAlg AlgResourcePool::m_flatUniqueAlgList

private

The flat list of algorithms w/o clones.

Definition at line 92 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 95 of file AlgResourcePool.h.

bool AlgResourcePool::m_lazyCreation

private

Definition at line 68 of file AlgResourcePool.h.

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

private

Definition at line 72 of file AlgResourcePool.h.

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

private

Definition at line 73 of file AlgResourcePool.h.

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

private

Definition at line 74 of file AlgResourcePool.h.

std::mutex AlgResourcePool::m_resource_mutex

private

Definition at line 67 of file AlgResourcePool.h.

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

private

Definition at line 71 of file AlgResourcePool.h.

ListAlg AlgResourcePool::m_topAlgList

private

The list of top algorithms.

Definition at line 89 of file AlgResourcePool.h.

StringArrayProperty AlgResourcePool::m_topAlgNames

private

The names of the algorithms to be passed to the algorithm manager.

Definition at line 83 of file AlgResourcePool.h.

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

private

The top list of algorithms.

Definition at line 98 of file AlgResourcePool.h.

---

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

• GaudiHive/src/AlgResourcePool.h
• GaudiHive/src/AlgResourcePool.cpp