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. More...

StatusCode	initialize () override
	Initialize. More...

StatusCode	finalize () override
	Finalize. More...

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

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

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

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

bool	isBlocking (const std::string &name) const override
	Check if a task is CPU-blocking. More...

void	dumpControlFlow () const override
	Dump precedence rules. More...

void	dumpDataFlow () const override

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

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

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

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

Public Member Functions inherited from extends< Service, IPrecedenceSvc >
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...

Public Member Functions inherited from Service
const std::string &	name () 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	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used 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

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

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. More...

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. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (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::PropertyBase &	getProperty (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

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) More...

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

MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

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

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

Additional Inherited Members
Public Types inherited from extends< Service, IPrecedenceSvc >
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
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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::PropertyBase *	property (const std::string &name) const

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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, " 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< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

A service to resolve the task execution precedence.

Author: Illya Shapoval @created Aug 7, 2017

Definition at line 31 of file PrecedenceSvc.h.

Constructor & Destructor Documentation

◆ PrecedenceSvc()

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

inline

Constructor.

Definition at line 35 of file PrecedenceSvc.h.

35 : base_class( name, svcLoc ) {}

extends< Service, IPrecedenceSvc >::base_class

extends base_class

Typedef to this class.

Definition: extends.h:24

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition: Service.cpp:284

Member Function Documentation

◆ assembleCFRules()

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

private

Definition at line 146 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, false, false );
     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 GaudiSequencer 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 285 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 290 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 296 of file PrecedenceSvc.cpp.

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

◆ dumpPrecedenceRules()

void PrecedenceSvc::dumpPrecedenceRules ( EventSlot & slot )

override

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

Definition at line 310 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() ) + "." + "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 ( EventSlot & slot )

override

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

Definition at line 336 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() ) + "." + "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 );
 }

◆ finalize()

StatusCode PrecedenceSvc::finalize ( )

override

Finalize.

Definition at line 364 of file PrecedenceSvc.cpp.

364 { return Service::finalize(); }

Service::finalize

StatusCode finalize() override

Definition: Service.cpp:174

◆ getPriority()

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

inlineoverride

Get priority of an algorithm.

Definition at line 53 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 73 of file PrecedenceSvc.h.

73 { return &m_PRGraph; };

PrecedenceSvc::m_PRGraph

concurrency::PrecedenceRulesGraph m_PRGraph

Graph of precedence rules.

Definition: PrecedenceSvc.h:82

◆ initialize()

StatusCode PrecedenceSvc::initialize ( )

override

Initialize.

Definition at line 28 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;
   }
 
   ON_DEBUG 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;
 }

◆ isBlocking()

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

inlineoverride

Check if a task is CPU-blocking.

Definition at line 58 of file PrecedenceSvc.h.

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

PrecedenceSvc::m_PRGraph

concurrency::PrecedenceRulesGraph m_PRGraph

Graph of precedence rules.

Definition: PrecedenceSvc.h:82

concurrency::PrecedenceRulesGraph::getAlgorithmNode

AlgorithmNode * getAlgorithmNode(const std::string &algoName) const

Get the AlgorithmNode from by algorithm name using graph index.

Definition: PrecedenceRulesGraph.h:664

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition: Service.cpp:284

concurrency::AlgorithmNode::isIOBound

bool isIOBound() const

Check if algorithm is I/O-bound.

Definition: PrecedenceRulesGraph.h:528

◆ iterate()

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

override

Infer the precedence effect caused by an execution flow event.

Definition at line 216 of file PrecedenceSvc.cpp.

                                                                        {
 
   if ( LIKELY( 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 ( UNLIKELY( m_dumpPrecTrace ) )
     if ( UNLIKELY( CFRulesResolved( slot.parentSlot ? *slot.parentSlot : slot ) ) )
       dumpPrecedenceTrace( slot.parentSlot ? *slot.parentSlot : slot );
 
   if ( UNLIKELY( m_dumpPrecRules ) )
     if ( UNLIKELY( 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 302 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 240 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 80 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 88 of file PrecedenceSvc.h.

◆ m_dumpPrecRules

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

private

Definition at line 97 of file PrecedenceSvc.h.

◆ 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 98 of file PrecedenceSvc.h.

◆ m_dumpPrecTrace

Gaudi::Property<bool> PrecedenceSvc::m_dumpPrecTrace

private

Initial value:

{this, "DumpPrecedenceTrace", false,

"Dump task precedence traces for each event."}

Definition at line 90 of file PrecedenceSvc.h.

◆ 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 92 of file PrecedenceSvc.h.

◆ m_ignoreDFRules

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

private

Scheduling strategy.

Definition at line 86 of file PrecedenceSvc.h.

◆ m_mode

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

private

Scheduling strategy.

Definition at line 84 of file PrecedenceSvc.h.

◆ m_PRGraph

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

private

Graph of precedence rules.

Definition at line 82 of file PrecedenceSvc.h.

◆ m_verifyRules

Gaudi::Property<bool> PrecedenceSvc::m_verifyRules

private

Initial value:

{this, "VerifyTaskPrecedenceRules", true,

"Verify task precedence rules for common errors."}

Definition at line 100 of file PrecedenceSvc.h.

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

◆ isBlocking()

◆ 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_verifyRules