PrecedenceSvc.h

Go to the documentation of this file.

#ifndef GAUDIHIVE_PRECEDENCESVC_H_
#define GAUDIHIVE_PRECEDENCESVC_H_

#include "IPrecedenceSvc.h"
#include "PRGraph/PrecedenceRulesGraph.h"

// Framework include files
#include "GaudiKernel/IAlgResourcePool.h"
#include "GaudiKernel/Service.h"

#include <boost/filesystem.hpp>

class PrecedenceSvc : public extends<Service, IPrecedenceSvc> {

public:
  PrecedenceSvc( const std::string& name, ISvcLocator* svcLoc ) : base_class( name, svcLoc ) {}

  StatusCode initialize() override;

  StatusCode finalize() override;

  StatusCode iterate( EventSlot&, const Cause& ) override;

  StatusCode simulate( EventSlot& ) const override;

  bool CFRulesResolved( EventSlot& ) const override;

  uint getPriority( const std::string& name ) const override {
    return (int)m_PRGraph.getAlgorithmNode( name )->getRank();
  }

  bool isBlocking( const std::string& name ) const override { return m_PRGraph.getAlgorithmNode( name )->isIOBound(); }

  void              dumpControlFlow() const override;
  void              dumpDataFlow() const override;
  const std::string printState( EventSlot& ) const override;

  void dumpPrecedenceRules( EventSlot& ) override;
  void dumpPrecedenceTrace( EventSlot& ) override;

  const concurrency::PrecedenceRulesGraph* getRules() const { return &m_PRGraph; };

private:
  StatusCode assembleCFRules( Gaudi::Algorithm*, const std::string&, unsigned int recursionDepth = 0 );

private:
  SmartIF<IAlgResourcePool> m_algResourcePool;
  concurrency::PrecedenceRulesGraph m_PRGraph{"PrecedenceRulesGraph", serviceLocator()};
  Gaudi::Property<std::string> m_mode{this, "TaskPriorityRule", "", "Task avalanche induction strategy."};
  Gaudi::Property<bool> m_ignoreDFRules{this, "IgnoreDFRules", false, "Ignore the data flow rules."};
  boost::filesystem::path m_dumpDirName{
      boost::filesystem::unique_path( boost::filesystem::path( "precedence.analysis.%%%%" ) )};
  Gaudi::Property<bool>        m_dumpPrecTrace{this, "DumpPrecedenceTrace", false,
                                        "Dump task precedence traces for each event."};
  Gaudi::Property<std::string> m_dumpPrecTraceFile{
      this, "PrecedenceTraceFile", "",
      "Override default name of the GRAPHML trace file. NOTE: if more than "
      "1 event is processed, the setting forces creation of a single file "
      "with cumulative precedence trace."};
  Gaudi::Property<bool>        m_dumpPrecRules{this, "DumpPrecedenceRules", false, "Dump task precedence rules."};
  Gaudi::Property<std::string> m_dumpPrecRulesFile{this, "PrecedenceRulesFile", "",
                                                   "Override default name of the GRAPHML precedence rules file."};
  Gaudi::Property<bool>        m_verifyRules{this, "VerifyTaskPrecedenceRules", true,
                                      "Verify task precedence rules for common errors."};
};

#endif /* GAUDIHIVE_PRECEDENCESVC_H_ */