A service to resolve the task execution precedence. More...

#include <GaudiHive/PrecedenceSvc.h>

Inheritance diagram for PrecedenceSvc:

[legend]

Collaboration diagram for PrecedenceSvc:

[legend]

Public Member Functions
	PrecedenceSvc (const std::string &name, ISvcLocator *svcLoc)
	Constructor.

StatusCode	initialize () override
	Initialize.

StatusCode	finalize () override
	Finalize.

StatusCode	iterate (EventSlot &, const Cause &) override
	Infer the precedence effect caused by an execution flow event.

StatusCode	simulate (EventSlot &) const override
	Simulate execution flow.

bool	CFRulesResolved (EventSlot &) const override
	Check if the root CF decision is resolved.

uint	getPriority (const std::string &name) const override
	Get priority of an algorithm.

bool	isAsynchronous (const std::string &name) const override
	Check if a task is asynchronous.

void	dumpControlFlow () const override
	Dump precedence rules.

void	dumpDataFlow () const override

const std::string	printState (EventSlot &) const override

void	dumpPrecedenceRules (const EventSlot &) override
	Dump precedence rules (available only in DEBUG mode, and must be enabled with the corresponding service property)

void	dumpPrecedenceTrace (const EventSlot &) override
	Dump precedence trace (available only in DEBUG mode, and must be enabled with the corresponding service property)

const concurrency::PrecedenceRulesGraph *	getRules () const
	Precedence rules accessor.

Public Member Functions inherited from extends< Service, IPrecedenceSvc >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

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.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (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.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Private Member Functions
StatusCode	assembleCFRules (Gaudi::Algorithm *, const std::string &, unsigned int recursionDepth=0)

Private Attributes
SmartIF< IAlgResourcePool >	m_algResourcePool
	A shortcut to the algorithm resource pool.

concurrency::PrecedenceRulesGraph	m_PRGraph { "PrecedenceRulesGraph", serviceLocator() }
	Graph of precedence rules.

Gaudi::Property< std::string >	m_mode { this, "TaskPriorityRule", "", "Task avalanche induction strategy." }
	Scheduling strategy.

Gaudi::Property< bool >	m_ignoreDFRules { this, "IgnoreDFRules", false, "Ignore the data flow rules." }
	Scheduling strategy.

boost::filesystem::path	m_dumpDirName
	Precedence analysis facilities.

Gaudi::Property< bool >	m_dumpPrecTrace

Gaudi::Property< std::string >	m_dumpPrecTraceFile

Gaudi::Property< bool >	m_dumpPrecRules { this, "DumpPrecedenceRules", false, "Dump task precedence rules." }

Gaudi::Property< std::string >	m_dumpPrecRulesFile

Gaudi::Property< bool >	m_verifyRules

Gaudi::Property< bool >	m_showDataFlow

Additional Inherited Members
Public Types inherited from extends< Service, IPrecedenceSvc >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

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()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

A service to resolve the task execution precedence.

Author: Illya Shapoval @created Aug 7, 2017

Definition at line 30 of file PrecedenceSvc.h.

Constructor & Destructor Documentation

◆ PrecedenceSvc()

PrecedenceSvc::PrecedenceSvc	(	const std::string &	name,
		ISvcLocator *	svcLoc )

inline

Constructor.

Definition at line 34 of file PrecedenceSvc.h.

34: base_class( name, svcLoc ) {}

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition Service.cpp:333

extends< Service, IPrecedenceSvc >::base_class

extends base_class

Definition extends.h:23

Member Function Documentation

◆ assembleCFRules()

StatusCode PrecedenceSvc::assembleCFRules	(	Gaudi::Algorithm *	algo,
		const std::string &	parentName,
		unsigned int	recursionDepth = 0 )

private

Definition at line 149 of file PrecedenceSvc.cpp.

                                                                         {
  using namespace concurrency;
 
  StatusCode sc = StatusCode::SUCCESS;
 
  ++recursionDepth;
 
  bool isGaudiSequencer( false );
  bool isAthSequencer( false );
 
  if ( !algo->isSequence() ) {
    ON_DEBUG debug() << std::string( recursionDepth, ' ' ) << "Algorithm '" << algo->name() << "' discovered" << endmsg;
    sc = m_PRGraph.addAlgorithmNode( algo, parentName );
    return sc;
  } else {
    if ( algo->hasProperty( "ShortCircuit" ) )
      isGaudiSequencer = true;
    else if ( algo->hasProperty( "StopOverride" ) )
      isAthSequencer = true;
  }
 
  auto seq = dynamic_cast<Gaudi::Sequence*>( algo );
  if ( seq == 0 ) {
    error() << "Algorithm " << algo->name() << " has isSequence==true, but unable to dcast to Sequence" << endmsg;
    return StatusCode::FAILURE;
  }
 
  auto subAlgorithms = seq->subAlgorithms();
 
  // Recursively unroll
  ON_DEBUG debug() << std::string( recursionDepth, ' ' ) << "Decision hub '" << algo->name() << "' discovered"
                   << endmsg;
  bool modeOr         = false;
  bool allPass        = false;
  bool promptDecision = false;
  bool isSequential   = false;
  bool isInverted     = false;
 
  if ( isGaudiSequencer ) {
    modeOr         = ( algo->getProperty( "ModeOR" ).toString() == "True" );
    allPass        = ( algo->getProperty( "IgnoreFilterPassed" ).toString() == "True" );
    promptDecision = ( algo->getProperty( "ShortCircuit" ).toString() == "True" );
    isInverted     = ( algo->getProperty( "Invert" ).toString() == "True" );
    if ( allPass ) promptDecision = false; // standard Gaudi::Sequencer behavior on all pass is to execute everything
    isSequential = ( algo->hasProperty( "Sequential" ) && ( algo->getProperty( "Sequential" ).toString() == "True" ) );
  } else if ( isAthSequencer ) {
    modeOr         = ( algo->getProperty( "ModeOR" ).toString() == "True" );
    allPass        = ( algo->getProperty( "IgnoreFilterPassed" ).toString() == "True" );
    promptDecision = ( algo->getProperty( "StopOverride" ).toString() == "False" );
    isSequential = ( algo->hasProperty( "Sequential" ) && ( algo->getProperty( "Sequential" ).toString() == "True" ) );
  }
  sc = m_PRGraph.addDecisionHubNode( algo, parentName, Concurrent{ !isSequential }, PromptDecision{ promptDecision },
                                     ModeOr{ modeOr }, AllPass{ allPass }, Inverted{ isInverted } );
  if ( sc.isFailure() ) {
    error() << "Failed to add DecisionHub " << algo->name() << " to graph of precedence rules" << endmsg;
    return sc;
  }
 
  for ( auto subalgo : *subAlgorithms ) {
    sc = assembleCFRules( subalgo, algo->name(), recursionDepth );
    if ( sc.isFailure() ) {
      error() << "Algorithm " << subalgo->name() << " could not be flattened" << endmsg;
      return sc;
    }
  }
  return sc;
}

◆ CFRulesResolved()

bool PrecedenceSvc::CFRulesResolved ( EventSlot & slot ) const

override

Check if the root CF decision is resolved.

Definition at line 288 of file PrecedenceSvc.cpp.

                                                           {
  return ( -1 != slot.controlFlowState[m_PRGraph.getHeadNode()->getNodeIndex()] ? true : false );
}

◆ dumpControlFlow()

void PrecedenceSvc::dumpControlFlow ( ) const

override

Dump precedence rules.

Definition at line 293 of file PrecedenceSvc.cpp.

                                          {
 
  info() << std::endl << "==================== Control Flow Configuration ==================" << std::endl << std::endl;
  info() << m_PRGraph.dumpControlFlow() << endmsg;
}

◆ dumpDataFlow()

void PrecedenceSvc::dumpDataFlow ( ) const

override

Definition at line 299 of file PrecedenceSvc.cpp.

                                       {
  info() << std::endl << "===================== Data Flow Configuration ====================" << std::endl;
  info() << m_PRGraph.dumpDataFlow() << endmsg;
}

◆ dumpPrecedenceRules()

void PrecedenceSvc::dumpPrecedenceRules ( const EventSlot & slot )

override

Dump precedence rules (available only in DEBUG mode, and must be enabled with the corresponding service property)

Definition at line 313 of file PrecedenceSvc.cpp.

                                                               {
 
  if ( !m_dumpPrecRules ) {
    warning() << "To trace temporal and topological aspects of execution flow, "
              << "set DumpPrecedenceRules property to True " << endmsg;
    return;
  }
 
  ON_DEBUG debug() << "Dumping temporal precedence rules" << endmsg;
 
  std::string fileName;
  if ( m_dumpPrecRulesFile.empty() ) {
    const auto& eventID = slot.eventContext->eventID();
    fileName            = "rules_evt-" + std::to_string( eventID.event_number() ) + "_slot-" +
               std::to_string( slot.eventContext->slot() ) + "_run-" + std::to_string( eventID.run_number() ) +
               ".graphml";
  } else {
    fileName = m_dumpPrecRulesFile;
  }
 
  boost::filesystem::path pth{ m_dumpDirName };
  pth.append( fileName );
 
  m_PRGraph.dumpPrecRules( pth, slot );
}

◆ dumpPrecedenceTrace()

void PrecedenceSvc::dumpPrecedenceTrace ( const EventSlot & slot )

override

Dump precedence trace (available only in DEBUG mode, and must be enabled with the corresponding service property)

Definition at line 340 of file PrecedenceSvc.cpp.

                                                               {
 
  if ( !m_dumpPrecTrace ) {
    warning() << "To trace task precedence patterns, set DumpPrecedenceTrace "
              << "property to True " << endmsg;
    return;
  }
 
  ON_DEBUG debug() << "Dumping temporal precedence trace" << endmsg;
 
  std::string fileName;
  if ( m_dumpPrecTraceFile.empty() ) {
    const auto& eventID = slot.eventContext->eventID();
    fileName            = "trace_evt-" + std::to_string( eventID.event_number() ) + "_slot-" +
               std::to_string( slot.eventContext->slot() ) + "_run-" + std::to_string( eventID.run_number() ) +
               ".graphml";
  } else {
    fileName = m_dumpPrecTraceFile;
  }
 
  boost::filesystem::path pth{ m_dumpDirName };
  pth.append( fileName );
 
  m_PRGraph.dumpPrecTrace( pth, slot );
}

◆ finalize()

StatusCode PrecedenceSvc::finalize ( )

override

Finalize.

Definition at line 369 of file PrecedenceSvc.cpp.

369{ return Service::finalize(); }

Service::finalize

StatusCode finalize() override

Definition Service.cpp:223

◆ getPriority()

uint PrecedenceSvc::getPriority ( const std::string & name ) const

inlineoverride

Get priority of an algorithm.

Definition at line 52 of file PrecedenceSvc.h.

                                                           {
    return (int)m_PRGraph.getAlgorithmNode( name )->getRank();
  }

◆ getRules()

const concurrency::PrecedenceRulesGraph * PrecedenceSvc::getRules ( ) const

inline

Precedence rules accessor.

Definition at line 74 of file PrecedenceSvc.h.

74{ return &m_PRGraph; }

◆ initialize()

StatusCode PrecedenceSvc::initialize ( )

override

Initialize.

Definition at line 31 of file PrecedenceSvc.cpp.

                                     {
  using namespace concurrency;
 
  auto sc = Service::initialize(); // parent class must be initialized first
  if ( sc.isFailure() ) {
    fatal() << "Base class failed to initialize" << endmsg;
    return sc;
  }
 
  // prepare a directory to dump precedence analysis files to.
  if ( m_dumpPrecTrace || m_dumpPrecRules ) {
    if ( !boost::filesystem::create_directory( m_dumpDirName ) ) {
      error() << "Could not create directory " << m_dumpDirName
              << "required "
                 "for task precedence tracing"
              << endmsg;
      return StatusCode::FAILURE;
    }
  }
 
  if ( m_dumpPrecRules ) m_PRGraph.enableAnalysis();
 
  // Get the algo resource pool
  m_algResourcePool = serviceLocator()->service( "AlgResourcePool" );
  if ( !m_algResourcePool.isValid() ) {
    fatal() << "Error retrieving AlgoResourcePool" << endmsg;
    return StatusCode::FAILURE;
  }
 
  info() << "Assembling CF and DF task precedence rules" << endmsg;
 
  ON_DEBUG debug() << "Assembling CF precedence realm:" << endmsg;
  // create the root CF node
  m_PRGraph.addHeadNode( "RootDecisionHub", Concurrent{ true }, PromptDecision{ false }, ModeOr{ true },
                         AllPass{ true }, Inverted{ false } );
  // assemble the CF rules
  for ( const auto& ialgoPtr : m_algResourcePool->getTopAlgList() ) {
    auto algorithm = dynamic_cast<Gaudi::Algorithm*>( ialgoPtr );
    if ( !algorithm ) fatal() << "Conversion from IAlgorithm to Gaudi::Algorithm failed" << endmsg;
    sc = assembleCFRules( algorithm, "RootDecisionHub" );
    if ( sc.isFailure() ) {
      fatal() << "Could not assemble the CF precedence realm" << endmsg;
      return sc;
    }
  }
 
  if ( m_ignoreDFRules ) {
    warning() << "Ignoring DF precedence rules, disabling all associated features" << endmsg;
    return StatusCode::SUCCESS;
  }
 
  ON_DEBUG debug() << "Assembling DF precedence realm:" << endmsg;
  sc = m_PRGraph.initialize();
  if ( sc.isFailure() ) {
    fatal() << "Could not assemble the DF precedence realm" << endmsg;
    return sc;
  }
 
  // Rank algorithms if a prioritization rule is supplied
  if ( m_mode == "PCE" ) {
    auto ranker = concurrency::RankerByProductConsumption();
    m_PRGraph.rankAlgorithms( ranker );
  } else if ( m_mode == "COD" ) {
    auto ranker = concurrency::RankerByCummulativeOutDegree();
    m_PRGraph.rankAlgorithms( ranker );
  } else if ( m_mode == "E" ) {
    auto ranker = concurrency::RankerByEccentricity();
    m_PRGraph.rankAlgorithms( ranker );
  } else if ( m_mode == "T" ) {
    auto ranker = concurrency::RankerByTiming();
    m_PRGraph.rankAlgorithms( ranker );
  } else if ( m_mode == "DRE" ) {
    auto ranker = concurrency::RankerByDataRealmEccentricity();
    m_PRGraph.rankAlgorithms( ranker );
  } else if ( !m_mode.empty() ) {
    error() << "Requested prioritization rule '" << m_mode << "' is unknown" << endmsg;
    return StatusCode::FAILURE;
  }
 
  if ( m_showDataFlow ) { debug() << m_PRGraph.dumpDataFlow() << endmsg; }
 
  if ( m_verifyRules ) {
    ON_DEBUG debug() << "Verifying task precedence rules" << endmsg;
 
    // Check if CF properties are self-consistent
    auto propValidator = concurrency::NodePropertiesValidator();
    m_PRGraph.accept( propValidator );
    if ( !propValidator.passed() )
      warning() << propValidator.reply() << endmsg;
    else
      ON_DEBUG debug() << propValidator.reply() << endmsg;
 
    // Check for violations in the DF topology
    auto prodValidator = concurrency::ProductionAmbiguityFinder();
    m_PRGraph.accept( prodValidator );
    if ( !prodValidator.passed() ) {
      error() << prodValidator.reply() << endmsg;
      return StatusCode::FAILURE;
    } else {
      ON_DEBUG debug() << prodValidator.reply() << endmsg;
    }
 
    auto sccFinder = concurrency::TarjanSCCFinder();
    m_PRGraph.accept( sccFinder );
    if ( !sccFinder.passed() ) {
      error() << sccFinder.reply() << endmsg;
      return StatusCode::FAILURE;
    } else {
      ON_DEBUG debug() << sccFinder.reply() << endmsg;
    }
  }
 
  if ( sc.isSuccess() ) info() << "PrecedenceSvc initialized successfully" << endmsg;
 
  return sc;
}

◆ isAsynchronous()

bool PrecedenceSvc::isAsynchronous ( const std::string & name ) const

inlineoverride

Check if a task is asynchronous.

Definition at line 57 of file PrecedenceSvc.h.

                                                              {
    return m_PRGraph.getAlgorithmNode( name )->isAsynchronous();
  }

◆ iterate()

StatusCode PrecedenceSvc::iterate	(	EventSlot &	slot,
		const Cause &	cause )

override

Infer the precedence effect caused by an execution flow event.

Definition at line 219 of file PrecedenceSvc.cpp.

                                                                       {
 
  if ( Cause::source::Task == cause.m_source ) {
    ON_VERBOSE verbose() << "Triggering bottom-up traversal at node '" << cause.m_sourceName << "'" << endmsg;
    auto       visitor = concurrency::DecisionUpdater( slot, cause, m_dumpPrecTrace );
    m_PRGraph.getAlgorithmNode( cause.m_sourceName )->accept( visitor );
  } else {
    ON_VERBOSE verbose() << "Triggering top-down traversal at the root node" << endmsg;
    auto       visitor = concurrency::Supervisor( slot, cause, m_dumpPrecTrace );
    m_PRGraph.getHeadNode()->accept( visitor );
  }
 
  if ( m_dumpPrecTrace )
    if ( CFRulesResolved( slot.parentSlot ? *slot.parentSlot : slot ) )
      dumpPrecedenceTrace( slot.parentSlot ? *slot.parentSlot : slot );
 
  if ( m_dumpPrecRules )
    if ( CFRulesResolved( slot.parentSlot ? *slot.parentSlot : slot ) )
      dumpPrecedenceRules( slot.parentSlot ? *slot.parentSlot : slot );
 
  return StatusCode::SUCCESS;
}

◆ printState()

const std::string PrecedenceSvc::printState ( EventSlot & slot ) const

override

Definition at line 305 of file PrecedenceSvc.cpp.

                                                                 {
 
  std::stringstream ss;
  m_PRGraph.printState( ss, slot, 0 );
  return ss.str();
}

◆ simulate()

StatusCode PrecedenceSvc::simulate ( EventSlot & slot ) const

override

Simulate execution flow.

Definition at line 243 of file PrecedenceSvc.cpp.

                                                          {
 
  Cause cs      = { Cause::source::Root, "RootDecisionHub" };
  auto  visitor = concurrency::RunSimulator( slot, cs );
 
  auto& nodeDecisions = slot.controlFlowState;
 
  std::vector<int> prevNodeDecisions;
  int              cntr = 0;
  std::vector<int> counters;
 
  while ( !CFRulesResolved( slot ) ) {
    cntr += 1;
    int      prevAlgosNum = visitor.m_nodesSucceeded;
    ON_DEBUG debug() << "  Proceeding with iteration #" << cntr << endmsg;
    prevNodeDecisions = slot.controlFlowState;
    m_PRGraph.getHeadNode()->accept( visitor );
    if ( prevNodeDecisions == nodeDecisions ) {
      error() << "  No progress on iteration " << cntr << " detected, node decisions are:" << nodeDecisions << endmsg;
      return StatusCode::FAILURE;
    }
    info() << "   Iteration #" << cntr << " finished, total algorithms executed: " << visitor.m_nodesSucceeded
           << endmsg;
 
    std::stringstream s;
    s << cntr << ", " << ( visitor.m_nodesSucceeded - prevAlgosNum ) << "\n";
 
    std::ofstream myfile;
    myfile.open( "RunSimulation.csv", std::ios::app );
    myfile << s.str();
    myfile.close();
 
    if ( visitor.m_nodesSucceeded != prevAlgosNum ) counters.push_back( visitor.m_nodesSucceeded );
  }
 
  info() << "Asymptotical intra-event speedup: " << (float)visitor.m_nodesSucceeded / (float)counters.size() << endmsg;
 
  // Reset algorithm states and node decisions
  slot.algsStates.reset();
  nodeDecisions.assign( nodeDecisions.size(), -1 );
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_algResourcePool

SmartIF<IAlgResourcePool> PrecedenceSvc::m_algResourcePool

private

A shortcut to the algorithm resource pool.

Definition at line 81 of file PrecedenceSvc.h.

◆ m_dumpDirName

boost::filesystem::path PrecedenceSvc::m_dumpDirName

private

Initial value:

{

boost::filesystem::unique_path( boost::filesystem::path( "precedence.analysis.%%%%" ) ) }

Precedence analysis facilities.

Definition at line 89 of file PrecedenceSvc.h.

89 {

90 boost::filesystem::unique_path( boost::filesystem::path( "precedence.analysis.%%%%" ) ) };

◆ m_dumpPrecRules

Gaudi::Property<bool> PrecedenceSvc::m_dumpPrecRules { this, "DumpPrecedenceRules", false, "Dump task precedence rules." }

private

Definition at line 98 of file PrecedenceSvc.h.

98{ this, "DumpPrecedenceRules", false, "Dump task precedence rules." };

◆ m_dumpPrecRulesFile

Gaudi::Property<std::string> PrecedenceSvc::m_dumpPrecRulesFile

private

Initial value:

{ this, "PrecedenceRulesFile", "",

"Override default name of the GRAPHML precedence rules file." }

Definition at line 99 of file PrecedenceSvc.h.

99 { this, "PrecedenceRulesFile", "",

100 "Override default name of the GRAPHML precedence rules file." };

◆ m_dumpPrecTrace

Gaudi::Property<bool> PrecedenceSvc::m_dumpPrecTrace

private

Initial value:

{ this, "DumpPrecedenceTrace", false,

"Dump task precedence traces for each event." }

Definition at line 91 of file PrecedenceSvc.h.

91 { this, "DumpPrecedenceTrace", false,

92 "Dump task precedence traces for each event." };

◆ m_dumpPrecTraceFile

Gaudi::Property<std::string> PrecedenceSvc::m_dumpPrecTraceFile

private

Initial value:

{
      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." }

Definition at line 93 of file PrecedenceSvc.h.

                                              {
      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." };

◆ m_ignoreDFRules

Gaudi::Property<bool> PrecedenceSvc::m_ignoreDFRules { this, "IgnoreDFRules", false, "Ignore the data flow rules." }

private

Scheduling strategy.

Definition at line 87 of file PrecedenceSvc.h.

87{ this, "IgnoreDFRules", false, "Ignore the data flow rules." };

◆ m_mode

Gaudi::Property<std::string> PrecedenceSvc::m_mode { this, "TaskPriorityRule", "", "Task avalanche induction strategy." }

private

Scheduling strategy.

Definition at line 85 of file PrecedenceSvc.h.

85{ this, "TaskPriorityRule", "", "Task avalanche induction strategy." };

◆ m_PRGraph

concurrency::PrecedenceRulesGraph PrecedenceSvc::m_PRGraph { "PrecedenceRulesGraph", serviceLocator() }

private

Graph of precedence rules.

Definition at line 83 of file PrecedenceSvc.h.

83{ "PrecedenceRulesGraph", serviceLocator() };

◆ m_showDataFlow

Gaudi::Property<bool> PrecedenceSvc::m_showDataFlow

private

Initial value:

{ this, "ShowDataFlow", false,

"Show the configuration of DataFlow between Algorithms" }

Definition at line 103 of file PrecedenceSvc.h.

103 { this, "ShowDataFlow", false,

104 "Show the configuration of DataFlow between Algorithms" };

◆ m_verifyRules

Gaudi::Property<bool> PrecedenceSvc::m_verifyRules

private

Initial value:

{ this, "VerifyTaskPrecedenceRules", true,

"Verify task precedence rules for common errors." }

Definition at line 101 of file PrecedenceSvc.h.

101 { this, "VerifyTaskPrecedenceRules", true,

102 "Verify task precedence rules for common errors." };

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

GaudiHive/src/PrecedenceSvc.h
GaudiHive/src/PrecedenceSvc.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PrecedenceSvc()

Member Function Documentation

◆ assembleCFRules()

◆ CFRulesResolved()

◆ dumpControlFlow()

◆ dumpDataFlow()

◆ dumpPrecedenceRules()

◆ dumpPrecedenceTrace()

◆ finalize()

◆ getPriority()

◆ getRules()

◆ initialize()

◆ isAsynchronous()

◆ iterate()

◆ printState()

◆ simulate()

Member Data Documentation

◆ m_algResourcePool

◆ m_dumpDirName

◆ m_dumpPrecRules

◆ m_dumpPrecRulesFile

◆ m_dumpPrecTrace

◆ m_dumpPrecTraceFile

◆ m_ignoreDFRules

◆ m_mode

◆ m_PRGraph

◆ m_showDataFlow

◆ m_verifyRules