ForwardSchedulerSvc.h

Go to the documentation of this file.

#ifndef GAUDIHIVE_FORWARDSCHEDULERSVC_H
#define GAUDIHIVE_FORWARDSCHEDULERSVC_H

// Local includes
#include "AlgsExecutionStates.h"
#include "DataFlowManager.h"
#include "EventSlot.h"
#include "ExecutionFlowManager.h"

// Framework include files
#include "GaudiKernel/IAlgExecStateSvc.h"
#include "GaudiKernel/IAlgResourcePool.h"
#include "GaudiKernel/IHiveWhiteBoard.h"
#include "GaudiKernel/IRunable.h"
#include "GaudiKernel/IScheduler.h"
#include "GaudiKernel/IThreadPoolSvc.h"
#include "GaudiKernel/Service.h"

// C++ include files
#include <functional>
#include <string>
#include <thread>
#include <unordered_map>
#include <vector>

// External libs
#include "tbb/concurrent_queue.h"
#include "tbb/task.h"

typedef AlgsExecutionStates::State State;
typedef std::function<StatusCode()> action;

//---------------------------------------------------------------------------

class ForwardSchedulerSvc : public extends<Service, IScheduler>
{
public:
  using extends::extends;

  ~ForwardSchedulerSvc() override = default;

  StatusCode initialize() override;

  StatusCode finalize() override;

  StatusCode pushNewEvent( EventContext* eventContext ) override;

  // Make multiple events available to the scheduler
  StatusCode pushNewEvents( std::vector<EventContext*>& eventContexts ) override;

  StatusCode popFinishedEvent( EventContext*& eventContext ) override;

  StatusCode tryPopFinishedEvent( EventContext*& eventContext ) override;

  unsigned int freeSlots() override;

private:
  enum ActivationState { INACTIVE = 0, ACTIVE = 1, FAILURE = 2 };

  Gaudi::Property<int> m_maxEventsInFlight{this, "MaxEventsInFlight", 0,
                                           "Maximum number of event processed simultaneously"};
  Gaudi::Property<int> m_threadPoolSize{this, "ThreadPoolSize", -1,
    "Size of the threadpool initialised by TBB; a value of -1 gives TBB the freedom to choose"};
  Gaudi::Property<std::string> m_whiteboardSvcName{this, "WhiteboardSvc", "EventDataSvc", "The whiteboard name"};
  Gaudi::Property<unsigned int> m_maxAlgosInFlight{this, "MaxAlgosInFlight", 1,
                                                   "[[deprecated]] Taken from the whiteboard"};
  Gaudi::Property<std::vector<std::vector<std::string>>> m_algosDependencies{
      this, "AlgosDependencies", {}, "[[deprecated]]"};
  Gaudi::Property<bool> m_checkDeps{this, "CheckDependencies", false, 
      "Runtime check of Algorithm Data Dependencies"};
  Gaudi::Property<std::string> m_useDataLoader{this, "DataLoaderAlg", "",
      "Attribute unmet input dependencies to this DataLoader Algorithm"};

  Gaudi::Property<bool> m_showDataDeps{this, "ShowDataDependencies", true,
      "Show the INPUT and OUTPUT data dependencies of Algorithms"};
  Gaudi::Property<bool> m_showDataFlow{this, "ShowDataFlow", false,
      "Show the configuration of DataFlow between Algorithms"};
    Gaudi::Property<bool> m_showControlFlow{this, "ShowControlFlow", false,
      "Show the configuration of all Algorithms and Sequences"};

  // Utils and shortcuts ----------------------------------------------------

  void activate();

  StatusCode deactivate();

  std::atomic<ActivationState> m_isActive{INACTIVE};

  std::thread m_thread;

  inline unsigned int algname2index( const std::string& algoname );

  std::unordered_map<std::string, unsigned int> m_algname_index_map;

  inline const std::string& index2algname( unsigned int index );

  std::vector<std::string> m_algname_vect;

  SmartIF<IHiveWhiteBoard> m_whiteboard;

  std::vector<EventSlot> m_eventSlots;

  std::atomic_int m_freeSlots;

  tbb::concurrent_bounded_queue<EventContext*> m_finishedEvents;

  StatusCode eventFailed( EventContext* eventContext );

  SmartIF<IAlgExecStateSvc> m_algExecStateSvc;

  // States management ------------------------------------------------------

  unsigned int m_algosInFlight = 0;

  StatusCode updateStates( int si = -1 );

  StatusCode promoteToControlReady( unsigned int iAlgo, int si );
  StatusCode promoteToDataReady( unsigned int iAlgo, int si );
  StatusCode promoteToScheduled( unsigned int iAlgo, int si );
  StatusCode promoteToExecuted( unsigned int iAlgo, int si, IAlgorithm* algo, EventContext* );
  StatusCode promoteToFinished( unsigned int iAlgo, int si );

  StatusCode isStalled( int si );

  void dumpSchedulerState( int iSlot );

  bool m_updateNeeded = true;

  // Algos Management -------------------------------------------------------
  SmartIF<IAlgResourcePool> m_algResourcePool;

  StatusCode m_drain();

  // Actions management -----------------------------------------------------

  tbb::concurrent_bounded_queue<action> m_actionsQueue;

  // helper task to enqueue the scheduler's actions (closures)
  struct enqueueSchedulerActionTask: public tbb::task {

    std::function<StatusCode()> m_closure;
    SmartIF<ForwardSchedulerSvc> m_scheduler;

    enqueueSchedulerActionTask(ForwardSchedulerSvc* scheduler, std::function<StatusCode()> _closure) :
      m_closure(_closure), m_scheduler(scheduler) {}

    tbb::task* execute() override {
      m_scheduler->m_actionsQueue.push(m_closure);
      return nullptr;
    }
  };

  // ------------------------------------------------------------------------

  concurrency::ExecutionFlowManager m_efManager;

  // Service for thread pool initialization
  SmartIF<IThreadPoolSvc> m_threadPoolSvc;

  bool m_first = true;

  class SchedulerState
  {

  public:
    SchedulerState( Algorithm* a, EventContext* e, pthread_t t ) : m_a( a ), m_e( *e ), m_t( t ) {}

    Algorithm* alg() const { return m_a; }
    EventContext ctx() const { return m_e; }
    pthread_t thread() const { return m_t; }

    friend std::ostream& operator<<( std::ostream& os, const SchedulerState& ss )
    {
      os << ss.ctx() << "  a: " << ss.alg()->name() << " [" << std::hex << ss.alg() << std::dec << "]  t: 0x"
         << std::hex << ss.thread() << std::dec;
      return os;
    }

    bool operator==( const SchedulerState& ss ) const { return ( m_a == ss.alg() ); }

    bool operator==( Algorithm* a ) const { return ( m_a == a ); }

    bool operator<( const SchedulerState& rhs ) const { return ( m_a < rhs.alg() ); }

  private:
    Algorithm* m_a;
    EventContext m_e;
    pthread_t m_t;
  };

  static std::list<SchedulerState> m_sState;
  static std::mutex m_ssMut;

public:
  void addAlg( Algorithm*, EventContext*, pthread_t );
  bool delAlg( Algorithm* );
  void dumpState() override;

private:
  void dumpState( std::ostringstream& );
  concurrency::PrecedenceRulesGraph* m_efg;
};

#endif // GAUDIHIVE_FORWARDSCHEDULERSVC_H