The Gaudi Framework  v30r3 (a5ef0a68)
PrecedenceSvc Class Reference

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

#include <GaudiHive/PrecedenceSvc.h>

Inheritance diagram for PrecedenceSvc:
Collaboration diagram for PrecedenceSvc:

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::PrecedenceRulesGraphgetRules () 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::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
- Public Member Functions inherited from Service
const std::stringname () 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::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (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::PropertyBasedeclareRemoteProperty (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::PropertyBasegetProperty (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
 
PropertyHolderoperator= (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...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 

Private Member Functions

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

Private Attributes

SmartIF< IAlgResourcePoolm_algResourcePool
 A shortcut to the algorithm resource pool. More...
 
concurrency::PrecedenceRulesGraph m_PRGraph {"PrecedenceRulesGraph", serviceLocator()}
 Graph of precedence rules. More...
 
Gaudi::Property< std::stringm_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::stringm_dumpPrecTraceFile
 
Gaudi::Property< bool > m_dumpPrecRules {this, "DumpPrecedenceRules", false, "Dump task precedence rules."}
 
Gaudi::Property< std::stringm_dumpPrecRulesFile
 

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::PropertyBaseproperty (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, "[[deprecated]] 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< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Detailed Description

A service to resolve the task execution precedence.

Author
Illya Shapoval Aug 7, 2017

Definition at line 21 of file PrecedenceSvc.h.

Constructor & Destructor Documentation

PrecedenceSvc::PrecedenceSvc ( const std::string name,
ISvcLocator svcLoc 
)
inline

Constructor.

Definition at line 26 of file PrecedenceSvc.h.

26 : base_class( name, svcLoc ) {}
extends base_class
Typedef to this class.
Definition: extends.h:15

Member Function Documentation

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

Definition at line 102 of file PrecedenceSvc.cpp.

103 {
104  using namespace concurrency;
105 
107 
108  ++recursionDepth;
109 
110  bool isGaudiSequencer( false );
111  bool isAthSequencer( false );
112 
113  if ( algo->isSequence() ) {
114  if ( algo->hasProperty( "ShortCircuit" ) )
115  isGaudiSequencer = true;
116  else if ( algo->hasProperty( "StopOverride" ) )
117  isAthSequencer = true;
118  }
119 
120  std::vector<Algorithm*>* subAlgorithms = algo->subAlgorithms();
121  if ( // we only want to add basic algorithms -> have no subAlgs
122  // and exclude the case of empty sequencers
123  ( subAlgorithms->empty() && !( isGaudiSequencer || isAthSequencer ) ) ) {
124 
125  ON_DEBUG debug() << std::string( recursionDepth, ' ' ) << "Algorithm '" << algo->name() << "' discovered" << endmsg;
126  sc = m_PRGraph.addAlgorithmNode( algo, parentName, false, false );
127  return sc;
128  }
129 
130  // Recursively unroll
131  ON_DEBUG debug() << std::string( recursionDepth, ' ' ) << "Decision hub '" << algo->name() << "' discovered"
132  << endmsg;
133  bool modeOr = false;
134  bool allPass = false;
135  bool promptDecision = false;
136  bool isSequential = false;
137  bool isInverted = false;
138 
139  if ( isGaudiSequencer ) {
140  modeOr = ( algo->getProperty( "ModeOR" ).toString() == "True" );
141  allPass = ( algo->getProperty( "IgnoreFilterPassed" ).toString() == "True" );
142  promptDecision = ( algo->getProperty( "ShortCircuit" ).toString() == "True" );
143  isInverted = ( algo->getProperty( "Invert" ).toString() == "True" );
144  if ( allPass ) promptDecision = false; // standard GaudiSequencer behavior on all pass is to execute everything
145  isSequential = ( algo->hasProperty( "Sequential" ) && ( algo->getProperty( "Sequential" ).toString() == "True" ) );
146  } else if ( isAthSequencer ) {
147  modeOr = ( algo->getProperty( "ModeOR" ).toString() == "True" );
148  allPass = ( algo->getProperty( "IgnoreFilterPassed" ).toString() == "True" );
149  promptDecision = ( algo->getProperty( "StopOverride" ).toString() == "False" );
150  isSequential = ( algo->hasProperty( "Sequential" ) && ( algo->getProperty( "Sequential" ).toString() == "True" ) );
151  }
152  sc = m_PRGraph.addDecisionHubNode( algo, parentName, Concurrent{!isSequential}, PromptDecision{promptDecision},
153  ModeOr{modeOr}, AllPass{allPass}, Inverted{isInverted} );
154  if ( sc.isFailure() ) {
155  error() << "Failed to add DecisionHub " << algo->name() << " to graph of precedence rules" << endmsg;
156  return sc;
157  }
158 
159  for ( Algorithm* subalgo : *subAlgorithms ) {
160  sc = assembleCFRules( subalgo, algo->name(), recursionDepth );
161  if ( sc.isFailure() ) {
162  error() << "Algorithm " << subalgo->name() << " could not be flattened" << endmsg;
163  return sc;
164  }
165  }
166  return sc;
167 }
StatusCode getProperty(Gaudi::Details::PropertyBase *p) const override
get the property
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
T empty(T...args)
StatusCode addAlgorithmNode(Algorithm *daughterAlgo, const std::string &parentName, bool inverted, bool allPass)
Add algorithm node.
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:765
StatusCode assembleCFRules(Algorithm *, const std::string &, unsigned int recursionDepth=0)
bool hasProperty(const std::string &name) const override
Return true if we have a property with the given name.
#define ON_DEBUG
bool isFailure() const
Definition: StatusCode.h:139
Gaudi::tagged_bool< class ModeOr_tag > ModeOr
STL class.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
Gaudi::tagged_bool< class Inverted_tag > Inverted
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:51
Gaudi::tagged_bool< class Concurrent_tag > Concurrent
constexpr static const auto SUCCESS
Definition: StatusCode.h:87
const std::vector< Algorithm * > * subAlgorithms() const
List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms.
Definition: Algorithm.cpp:801
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
Gaudi::tagged_bool< class PromptDecision_tag > PromptDecision
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
bool isSequence() const override
Are we a Sequence?
Definition: Algorithm.h:218
StatusCode addDecisionHubNode(Algorithm *daughterAlgo, const std::string &parentName, concurrency::Concurrent, concurrency::PromptDecision, concurrency::ModeOr, concurrency::AllPass, concurrency::Inverted)
Add a node, which aggregates decisions of direct daughter nodes.
Gaudi::tagged_bool< class AllPass_tag > AllPass
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
bool PrecedenceSvc::CFRulesResolved ( EventSlot slot) const
override

Check if the root CF decision is resolved.

Definition at line 241 of file PrecedenceSvc.cpp.

242 {
243  return ( -1 != slot.controlFlowState[m_PRGraph.getHeadNode()->getNodeIndex()] ? true : false );
244 }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
std::vector< int > controlFlowState
State of the control flow.
Definition: EventSlot.h:53
const unsigned int & getNodeIndex() const
Get node index.
DecisionNode * getHeadNode() const
Get head node.
void PrecedenceSvc::dumpControlFlow ( ) const
override

Dump precedence rules.

Definition at line 247 of file PrecedenceSvc.cpp.

248 {
249 
250  info() << std::endl << "==================== Control Flow Configuration ==================" << std::endl << std::endl;
252 }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
T endl(T...args)
std::string dumpControlFlow() const
Print out control flow of Algorithms and Sequences.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
void PrecedenceSvc::dumpDataFlow ( ) const
override

Definition at line 254 of file PrecedenceSvc.cpp.

255 {
256  info() << std::endl << "===================== Data Flow Configuration ====================" << std::endl;
257  info() << m_PRGraph.dumpDataFlow() << endmsg;
258 }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
T endl(T...args)
std::string dumpDataFlow() const
Print out all data origins and destinations, as reflected in the EF graph.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
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 270 of file PrecedenceSvc.cpp.

271 {
272 
273  if ( !m_dumpPrecRules ) {
274  warning() << "To trace temporal and topological aspects of execution flow, "
275  << "set DumpPrecedenceRules property to True " << endmsg;
276  return;
277  }
278 
279  ON_DEBUG debug() << "Dumping temporal precedence rules" << endmsg;
280 
281  std::string fileName;
282  if ( m_dumpPrecRulesFile.empty() ) {
283  const auto& eventID = slot.eventContext->eventID();
284  fileName = "rules.evt-" + std::to_string( eventID.event_number() ) + "." + "run-" +
285  std::to_string( eventID.run_number() ) + ".graphml";
286  } else {
287  fileName = m_dumpPrecRulesFile;
288  }
289 
291  pth.append( fileName );
292 
293  m_PRGraph.dumpPrecRules( pth, slot );
294 }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
EventContext * eventContext
Cache for the eventContext.
Definition: EventSlot.h:44
void dumpPrecRules(const boost::filesystem::path &, const EventSlot &slot)
dump to file the precedence rules
T to_string(T...args)
boost::filesystem::path m_dumpDirName
Precedence analysis facilities.
Definition: PrecedenceSvc.h:80
#define ON_DEBUG
STL class.
Gaudi::Property< std::string > m_dumpPrecRulesFile
Definition: PrecedenceSvc.h:89
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Gaudi::Property< bool > m_dumpPrecRules
Definition: PrecedenceSvc.h:88
const EventIDBase & eventID() const
Definition: EventContext.h:42
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
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 297 of file PrecedenceSvc.cpp.

298 {
299 
300  if ( !m_dumpPrecTrace ) {
301  warning() << "To trace task precedence patterns, set DumpPrecedenceTrace "
302  << "property to True " << endmsg;
303  return;
304  }
305 
306  ON_DEBUG debug() << "Dumping temporal precedence trace" << endmsg;
307 
308  std::string fileName;
309  if ( m_dumpPrecTraceFile.empty() ) {
310  const auto& eventID = slot.eventContext->eventID();
311  fileName = "trace.evt-" + std::to_string( eventID.event_number() ) + "." + "run-" +
312  std::to_string( eventID.run_number() ) + ".graphml";
313  } else {
314  fileName = m_dumpPrecTraceFile;
315  }
316 
318  pth.append( fileName );
319 
320  m_PRGraph.dumpPrecTrace( pth );
321 }
Gaudi::Property< bool > m_dumpPrecTrace
Definition: PrecedenceSvc.h:82
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
EventContext * eventContext
Cache for the eventContext.
Definition: EventSlot.h:44
T to_string(T...args)
boost::filesystem::path m_dumpDirName
Precedence analysis facilities.
Definition: PrecedenceSvc.h:80
#define ON_DEBUG
STL class.
void dumpPrecTrace(const boost::filesystem::path &)
dump to file the precedence trace
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Gaudi::Property< std::string > m_dumpPrecTraceFile
Definition: PrecedenceSvc.h:84
const EventIDBase & eventID() const
Definition: EventContext.h:42
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCode PrecedenceSvc::finalize ( )
override

Finalize.

Definition at line 326 of file PrecedenceSvc.cpp.

326 { return Service::finalize(); }
StatusCode finalize() override
Definition: Service.cpp:173
uint PrecedenceSvc::getPriority ( const std::string name) const
inlineoverride

Get priority of an algorithm.

Definition at line 44 of file PrecedenceSvc.h.

45  {
46  return (int)m_PRGraph.getAlgorithmNode( name )->getRank();
47  }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
const float & getRank() const
Get Algorithm rank.
AlgorithmNode * getAlgorithmNode(const std::string &algoName) const
Get the AlgorithmNode from by algorithm name using graph index.
const concurrency::PrecedenceRulesGraph* PrecedenceSvc::getRules ( ) const
inline

Precedence rules accessor.

Definition at line 65 of file PrecedenceSvc.h.

65 { return &m_PRGraph; };
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
StatusCode PrecedenceSvc::initialize ( )
override

Initialize.

Definition at line 15 of file PrecedenceSvc.cpp.

16 {
17  using namespace concurrency;
18 
19  auto sc = Service::initialize(); // parent class must be initialized first
20  if ( sc.isFailure() ) {
21  fatal() << "Base class failed to initialize" << endmsg;
22  return sc;
23  }
24 
25  // prepare a directory to dump precedence analysis files to.
27  if ( !boost::filesystem::create_directory( m_dumpDirName ) ) {
28  error() << "Could not create directory " << m_dumpDirName << "required "
29  "for task precedence tracing"
30  << endmsg;
31  return StatusCode::FAILURE;
32  }
33  }
34 
36 
37  // Get the algo resource pool
38  m_algResourcePool = serviceLocator()->service( "AlgResourcePool" );
39  if ( !m_algResourcePool.isValid() ) {
40  fatal() << "Error retrieving AlgoResourcePool" << endmsg;
41  return StatusCode::FAILURE;
42  }
43 
44  info() << "Assembling CF and DF task precedence rules" << endmsg;
45 
46  ON_DEBUG debug() << "Assembling CF precedence realm:" << endmsg;
47  // create the root CF node
48  m_PRGraph.addHeadNode( "RootDecisionHub", Concurrent{true}, PromptDecision{false}, ModeOr{true}, AllPass{true},
49  Inverted{false} );
50  // assemble the CF rules
51  for ( const auto& ialgoPtr : m_algResourcePool->getTopAlgList() ) {
52  auto algorithm = dynamic_cast<Algorithm*>( ialgoPtr );
53  if ( !algorithm ) fatal() << "Conversion from IAlgorithm to Algorithm failed" << endmsg;
54  sc = assembleCFRules( algorithm, "RootDecisionHub" );
55  if ( sc.isFailure() ) {
56  fatal() << "Could not assemble the CF precedence realm" << endmsg;
57  return sc;
58  }
59  }
60 
61  if ( m_ignoreDFRules ) {
62  warning() << "Ignoring DF precedence rules, disabling all associated features" << endmsg;
63  return StatusCode::SUCCESS;
64  }
65 
66  ON_DEBUG debug() << "Assembling DF precedence realm:" << endmsg;
67  sc = m_PRGraph.initialize();
68  if ( sc.isFailure() ) {
69  fatal() << "Could not assemble the DF precedence realm" << endmsg;
70  return sc;
71  }
72 
73  // Rank algorithms if a prioritization rule is supplied
74  if ( m_mode == "PCE" ) {
76  m_PRGraph.rankAlgorithms( ranker );
77  } else if ( m_mode == "COD" ) {
79  m_PRGraph.rankAlgorithms( ranker );
80  } else if ( m_mode == "E" ) {
81  auto ranker = concurrency::RankerByEccentricity();
82  m_PRGraph.rankAlgorithms( ranker );
83  } else if ( m_mode == "T" ) {
84  auto ranker = concurrency::RankerByTiming();
85  m_PRGraph.rankAlgorithms( ranker );
86  } else if ( m_mode == "DRE" ) {
88  m_PRGraph.rankAlgorithms( ranker );
89  } else if ( !m_mode.empty() ) {
90  error() << "Requested prioritization rule '" << m_mode << "' is unknown" << endmsg;
91  return StatusCode::FAILURE;
92  }
93 
95 
96  if ( sc.isSuccess() ) info() << "PrecedenceSvc initialized successfully" << endmsg;
97 
98  return sc;
99 }
constexpr static const auto FAILURE
Definition: StatusCode.h:88
Gaudi::Property< bool > m_dumpPrecTrace
Definition: PrecedenceSvc.h:82
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
StatusCode initialize() override
Definition: Service.cpp:63
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
StatusCode assembleCFRules(Algorithm *, const std::string &, unsigned int recursionDepth=0)
boost::filesystem::path m_dumpDirName
Precedence analysis facilities.
Definition: PrecedenceSvc.h:80
#define ON_DEBUG
void rankAlgorithms(IGraphVisitor &ranker) const
Rank Algorithm nodes by the number of data outputs.
Gaudi::tagged_bool< class ModeOr_tag > ModeOr
Gaudi::Property< bool > m_ignoreDFRules
Scheduling strategy.
Definition: PrecedenceSvc.h:78
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:79
StatusCode initialize()
Initialize graph.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
SmartIF< IAlgResourcePool > m_algResourcePool
A shortcut to the algorithm resource pool.
Definition: PrecedenceSvc.h:72
virtual std::list< IAlgorithm * > getTopAlgList()=0
Get top list of algorithms.
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
Gaudi::tagged_bool< class Inverted_tag > Inverted
void enableAnalysis()
BGL-based facilities.
std::string dumpDataFlow() const
Print out all data origins and destinations, as reflected in the EF graph.
Gaudi::Property< std::string > m_mode
Scheduling strategy.
Definition: PrecedenceSvc.h:76
Gaudi::tagged_bool< class Concurrent_tag > Concurrent
constexpr static const auto SUCCESS
Definition: StatusCode.h:87
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
Gaudi::tagged_bool< class PromptDecision_tag > PromptDecision
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:68
Gaudi::Property< bool > m_dumpPrecRules
Definition: PrecedenceSvc.h:88
Gaudi::tagged_bool< class AllPass_tag > AllPass
MsgStream & fatal() const
shortcut for the method msgStream(MSG::FATAL)
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:291
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
void addHeadNode(const std::string &headName, concurrency::Concurrent, concurrency::PromptDecision, concurrency::ModeOr, concurrency::AllPass, concurrency::Inverted)
Add a node, which has no parents.
bool PrecedenceSvc::isBlocking ( const std::string name) const
inlineoverride

Check if a task is CPU-blocking.

Definition at line 50 of file PrecedenceSvc.h.

50 { return m_PRGraph.getAlgorithmNode( name )->isIOBound(); }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
bool isIOBound() const
Check if algorithm is I/O-bound.
AlgorithmNode * getAlgorithmNode(const std::string &algoName) const
Get the AlgorithmNode from by algorithm name using graph index.
StatusCode PrecedenceSvc::iterate ( EventSlot slot,
const Cause cause 
)
override

Infer the precedence effect caused by an execution flow event.

Definition at line 170 of file PrecedenceSvc.cpp.

171 {
172 
173  if ( LIKELY( Cause::source::Task == cause.m_source ) ) {
174  ON_VERBOSE verbose() << "Triggering bottom-up traversal at node '" << cause.m_sourceName << "'" << endmsg;
175  auto visitor = concurrency::DecisionUpdater( slot, cause, m_dumpPrecTrace );
176  m_PRGraph.getAlgorithmNode( cause.m_sourceName )->accept( visitor );
177  } else {
178  ON_VERBOSE verbose() << "Triggering top-down traversal at the root node" << endmsg;
179  auto visitor = concurrency::Supervisor( slot, cause, m_dumpPrecTrace );
180  m_PRGraph.getHeadNode()->accept( visitor );
181  }
182 
183  if ( UNLIKELY( m_dumpPrecTrace ) )
184  if ( UNLIKELY( CFRulesResolved( slot.parentSlot ? *slot.parentSlot : slot ) ) )
185  dumpPrecedenceTrace( slot.parentSlot ? *slot.parentSlot : slot );
186 
187  if ( UNLIKELY( m_dumpPrecRules ) )
188  if ( UNLIKELY( CFRulesResolved( slot.parentSlot ? *slot.parentSlot : slot ) ) )
189  dumpPrecedenceRules( slot.parentSlot ? *slot.parentSlot : slot );
190 
191  return StatusCode::SUCCESS;
192 }
#define UNLIKELY(x)
Definition: Kernel.h:122
Gaudi::Property< bool > m_dumpPrecTrace
Definition: PrecedenceSvc.h:82
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
void dumpPrecedenceRules(EventSlot &) override
Dump precedence rules (available only in DEBUG mode, and must be enabled with the corresponding servi...
MsgStream & verbose() const
shortcut for the method msgStream(MSG::VERBOSE)
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
#define ON_VERBOSE
EventSlot * parentSlot
Pointer to parent slot (null for top level)
Definition: EventSlot.h:59
void dumpPrecedenceTrace(EventSlot &) override
Dump precedence trace (available only in DEBUG mode, and must be enabled with the corresponding servi...
bool CFRulesResolved(EventSlot &) const override
Check if the root CF decision is resolved.
constexpr static const auto SUCCESS
Definition: StatusCode.h:87
#define LIKELY(x)
Definition: Kernel.h:121
Gaudi::Property< bool > m_dumpPrecRules
Definition: PrecedenceSvc.h:88
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
AlgorithmNode * getAlgorithmNode(const std::string &algoName) const
Get the AlgorithmNode from by algorithm name using graph index.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
std::string m_sourceName
DecisionNode * getHeadNode() const
Get head node.
const std::string PrecedenceSvc::printState ( EventSlot slot) const
override

Definition at line 261 of file PrecedenceSvc.cpp.

262 {
263 
265  m_PRGraph.printState( ss, slot.algsStates, slot.controlFlowState, 0 );
266  return ss.str();
267 }
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
AlgsExecutionStates algsStates
Vector of algorithms states.
Definition: EventSlot.h:49
void printState(std::stringstream &output, AlgsExecutionStates &states, const std::vector< int > &node_decisions, const unsigned int &recursionLevel) const
Print a string representing the control flow state.
std::vector< int > controlFlowState
State of the control flow.
Definition: EventSlot.h:53
T str(T...args)
StatusCode PrecedenceSvc::simulate ( EventSlot slot) const
override

Simulate execution flow.

Definition at line 195 of file PrecedenceSvc.cpp.

196 {
197 
198  Cause cs = {Cause::source::Root, "RootDecisionHub"};
199  auto visitor = concurrency::RunSimulator( slot, cs );
200 
201  auto& nodeDecisions = slot.controlFlowState;
202 
203  std::vector<int> prevNodeDecisions;
204  int cntr = 0;
205  std::vector<int> counters;
206 
207  while ( !CFRulesResolved( slot ) ) {
208  cntr += 1;
209  int prevAlgosNum = visitor.m_nodesSucceeded;
210  ON_DEBUG debug() << " Proceeding with iteration #" << cntr << endmsg;
211  prevNodeDecisions = slot.controlFlowState;
212  m_PRGraph.getHeadNode()->accept( visitor );
213  if ( prevNodeDecisions == nodeDecisions ) {
214  error() << " No progress on iteration " << cntr << " detected, node decisions are:" << nodeDecisions << endmsg;
215  return StatusCode::FAILURE;
216  }
217  info() << " Iteration #" << cntr << " finished, total algorithms executed: " << visitor.m_nodesSucceeded
218  << endmsg;
219 
221  s << cntr << ", " << ( visitor.m_nodesSucceeded - prevAlgosNum ) << "\n";
222 
223  std::ofstream myfile;
224  myfile.open( "RunSimulation.csv", std::ios::app );
225  myfile << s.str();
226  myfile.close();
227 
228  if ( visitor.m_nodesSucceeded != prevAlgosNum ) counters.push_back( visitor.m_nodesSucceeded );
229  }
230 
231  info() << "Asymptotical intra-event speedup: " << (float)visitor.m_nodesSucceeded / (float)counters.size() << endmsg;
232 
233  // Reset algorithm states and node decisions
234  slot.algsStates.reset();
235  nodeDecisions.assign( nodeDecisions.size(), -1 );
236 
237  return StatusCode::SUCCESS;
238 }
constexpr static const auto FAILURE
Definition: StatusCode.h:88
concurrency::PrecedenceRulesGraph m_PRGraph
Graph of precedence rules.
Definition: PrecedenceSvc.h:74
T open(T...args)
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
AlgsExecutionStates algsStates
Vector of algorithms states.
Definition: EventSlot.h:49
#define ON_DEBUG
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
T push_back(T...args)
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
STL class.
std::vector< int > controlFlowState
State of the control flow.
Definition: EventSlot.h:53
T str(T...args)
bool CFRulesResolved(EventSlot &) const override
Check if the root CF decision is resolved.
constexpr static const auto SUCCESS
Definition: StatusCode.h:87
T size(T...args)
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
string s
Definition: gaudirun.py:253
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
DecisionNode * getHeadNode() const
Get head node.

Member Data Documentation

SmartIF<IAlgResourcePool> PrecedenceSvc::m_algResourcePool
private

A shortcut to the algorithm resource pool.

Definition at line 72 of file PrecedenceSvc.h.

boost::filesystem::path PrecedenceSvc::m_dumpDirName
private
Initial value:
{
boost::filesystem::unique_path( boost::filesystem::path( "precedence.analysis.%%%%" ) )}

Precedence analysis facilities.

Definition at line 80 of file PrecedenceSvc.h.

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

Definition at line 88 of file PrecedenceSvc.h.

Gaudi::Property<std::string> PrecedenceSvc::m_dumpPrecRulesFile
private
Initial value:
{this, "PrecedenceRulesFile", "",
"Override default name of the GRAPHML precedence rules file."}

Definition at line 89 of file PrecedenceSvc.h.

Gaudi::Property<bool> PrecedenceSvc::m_dumpPrecTrace
private
Initial value:
{this, "DumpPrecedenceTrace", false,
"Dump task precedence traces for each event."}

Definition at line 82 of file PrecedenceSvc.h.

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

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

Scheduling strategy.

Definition at line 78 of file PrecedenceSvc.h.

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

Scheduling strategy.

Definition at line 76 of file PrecedenceSvc.h.

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

Graph of precedence rules.

Definition at line 74 of file PrecedenceSvc.h.


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