The Gaudi Framework  v30r1 (5d4f4ae2)
PrecedenceRulesGraph.cpp
Go to the documentation of this file.
1 #include "PrecedenceRulesGraph.h"
2 #include "PRGraphVisitors.h"
3 
4 #include <boost/property_map/transform_value_property_map.hpp>
5 #include <fstream>
6 
8 
9 #define ON_DEBUG if ( msgLevel( MSG::DEBUG ) )
10 #define ON_VERBOSE if ( msgLevel( MSG::VERBOSE ) )
11 
12 namespace concurrency
13 {
14 
15  //---------------------------------------------------------------------------
16  std::string ControlFlowNode::stateToString( const int& stateId ) const
17  {
18 
19  if ( 0 == stateId )
20  return "FALSE";
21  else if ( 1 == stateId )
22  return "TRUE";
23  else
24  return "UNDEFINED";
25  }
26 
27  //---------------------------------------------------------------------------
29  {
30 
31  for ( auto node : m_children ) delete node;
32  }
33 
34  //---------------------------------------------------------------------------
36  {
37 
38  if ( std::find( m_parents.begin(), m_parents.end(), node ) == m_parents.end() ) m_parents.push_back( node );
39  }
40 
41  //--------------------------------------------------------------------------
43  {
44 
45  if ( std::find( m_children.begin(), m_children.end(), node ) == m_children.end() ) m_children.push_back( node );
46  }
47 
48  //---------------------------------------------------------------------------
50  const std::vector<int>& node_decisions, const unsigned int& recursionLevel ) const
51  {
52 
53  output << std::string( recursionLevel, ' ' ) << m_nodeName << " (" << m_nodeIndex << ")"
54  << ", w/ decision: " << stateToString( node_decisions[m_nodeIndex] ) << "(" << node_decisions[m_nodeIndex]
55  << ")" << std::endl;
56 
57  for ( auto daughter : m_children ) daughter->printState( output, states, node_decisions, recursionLevel + 2 );
58  }
59 
60  //---------------------------------------------------------------------------
62  {
63 
64  if ( visitor.visitEnter( *this ) ) {
65  // try to aggregate a decision
66  bool result = visitor.visit( *this );
67 
68  // if a decision was made for this node, propagate the result upwards
69  if ( result ) {
70  for ( auto parent : m_parents ) {
71  parent->accept( visitor );
72  }
73  return false;
74  }
75 
76  return true; // visitor was accepted to try to aggregate the node's decision
77  }
78 
79  return false; // visitor was rejected (since the decision node has an aggregated decision already)
80  }
81 
82  //---------------------------------------------------------------------------
84  {
85 
86  for ( auto node : m_outputs ) {
87  delete node;
88  }
89  }
90 
91  //---------------------------------------------------------------------------
93  const std::vector<int>& node_decisions, const unsigned int& recursionLevel ) const
94  {
95  output << std::string( recursionLevel, ' ' ) << m_nodeName << " (" << m_nodeIndex << ")"
96  << ", w/ decision: " << stateToString( node_decisions[m_nodeIndex] ) << "(" << node_decisions[m_nodeIndex]
97  << ")"
98  << ", in state: " << AlgsExecutionStates::stateNames[states[m_algoIndex]] << std::endl;
99  }
100 
101  //---------------------------------------------------------------------------
103  {
104 
105  if ( visitor.visitEnter( *this ) ) {
106  visitor.visit( *this );
107  return true; // visitor was accepted to promote the algorithm
108  }
109 
110  return false; // visitor was rejected (since the algorithm already produced a decision)
111  }
112 
113  //---------------------------------------------------------------------------
115  {
116 
117  if ( std::find( m_parents.begin(), m_parents.end(), node ) == m_parents.end() ) m_parents.push_back( node );
118  }
119 
120  //---------------------------------------------------------------------------
122  {
123 
124  if ( std::find( m_outputs.begin(), m_outputs.end(), node ) == m_outputs.end() ) m_outputs.push_back( node );
125  }
126 
127  //---------------------------------------------------------------------------
129  {
130 
131  if ( std::find( m_inputs.begin(), m_inputs.end(), node ) == m_inputs.end() ) m_inputs.push_back( node );
132  }
133 
134  //---------------------------------------------------------------------------
136  {
137  if ( serviceLocator()->existsService( "CondSvc" ) ) {
138  SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc" )};
139  if ( condSvc.isValid() ) {
140  info() << "CondSvc found. DF precedence rules will be augmented with 'Conditions'" << endmsg;
141  m_conditionsRealmEnabled = true;
142  }
143  }
144 
145  // Detach condition algorithms from the CF realm
146  if ( m_conditionsRealmEnabled ) {
147  SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc", false )};
148  auto& condAlgs = condSvc->condAlgs();
149  for ( const auto algo : condAlgs ) {
150  auto itA = m_algoNameToAlgoNodeMap.find( algo->name() );
151  concurrency::AlgorithmNode* algoNode;
152  if ( itA != m_algoNameToAlgoNodeMap.end() ) {
153  algoNode = itA->second;
154  debug() << "Detaching condition algorithm '" << algo->name() << "' from the CF realm.." << endmsg;
155  for ( auto parent : algoNode->getParentDecisionHubs() ) {
156  parent->m_children.erase( std::remove( parent->m_children.begin(), parent->m_children.end(), algoNode ),
157  parent->m_children.end() );
158  // clean up also auxiliary BGL-based graph of precedence rules
159  if ( m_enableAnalysis )
160  boost::remove_edge( node( algoNode->getNodeName() ), node( parent->getNodeName() ), m_PRGraph );
161  }
162  algoNode->m_parents.clear();
163 
164  } else {
165  warning() << "Algorithm '" << algo->name() << "' is not registered in the graph" << endmsg;
166  }
167  }
168  }
169 
170  StatusCode sc = buildDataDependenciesRealm();
171 
172  if ( !sc.isSuccess() ) error() << "Could not build the data dependency realm." << endmsg;
173 
174  ON_DEBUG debug() << dumpDataFlow() << endmsg;
175 
176  return sc;
177  }
178 
179  //---------------------------------------------------------------------------
181  {
182 
183  const std::string& algoName = algo->name();
184 
185  m_algoNameToAlgoInputsMap[algoName] = algo->inputDataObjs();
186  m_algoNameToAlgoOutputsMap[algoName] = algo->outputDataObjs();
187 
188  ON_VERBOSE
189  {
190  verbose() << " Inputs of " << algoName << ": ";
191  for ( auto tag : algo->inputDataObjs() ) verbose() << tag << " | ";
192  verbose() << endmsg;
193 
194  verbose() << " Outputs of " << algoName << ": ";
195  for ( auto tag : algo->outputDataObjs() ) verbose() << tag << " | ";
196  verbose() << endmsg;
197  }
198  }
199 
200  //---------------------------------------------------------------------------
202  {
203 
204  StatusCode global_sc( StatusCode::SUCCESS, true );
205 
206  // Production of DataNodes by AlgorithmNodes (DataNodes are created here)
207  for ( auto algo : m_algoNameToAlgoNodeMap ) {
208 
209  auto& outputs = m_algoNameToAlgoOutputsMap[algo.first];
210  for ( auto output : outputs ) {
211  const auto sc = addDataNode( output );
212  if ( !sc.isSuccess() ) {
213  error() << "Extra producer (" << algo.first << ") for DataObject @ " << output
214  << " has been detected: this is not allowed." << endmsg;
215  global_sc = sc;
216  }
217  auto dataNode = getDataNode( output );
218  dataNode->addProducerNode( algo.second );
219  algo.second->addOutputDataNode( dataNode );
220 
221  // Mirror the action above in the BGL-based graph
222  if ( m_enableAnalysis )
223  boost::add_edge( node( algo.second->getNodeName() ), node( output.fullKey() ), m_PRGraph );
224  }
225  }
226 
227  // Consumption of DataNodes by AlgorithmNodes
228  for ( auto algo : m_algoNameToAlgoNodeMap ) {
229 
230  for ( auto input : m_algoNameToAlgoInputsMap[algo.first] ) {
231 
232  DataNode* dataNode = nullptr;
233 
234  auto itP = m_dataPathToDataNodeMap.find( input );
235 
236  if ( itP != m_dataPathToDataNodeMap.end() ) dataNode = getDataNode( input );
237 
238  if ( dataNode ) {
239  dataNode->addConsumerNode( algo.second );
240  algo.second->addInputDataNode( dataNode );
241 
242  // Mirror the action above in the BGL-based graph
243  if ( m_enableAnalysis )
244  boost::add_edge( node( input.fullKey() ), node( algo.second->getNodeName() ), m_PRGraph );
245  }
246  }
247  }
248 
249  return global_sc;
250  }
251 
252  //---------------------------------------------------------------------------
253  StatusCode PrecedenceRulesGraph::addAlgorithmNode( Algorithm* algo, const std::string& parentName, bool inverted,
254  bool allPass )
255  {
256 
258 
259  // Create new, or fetch existent, AlgorithmNode
260  auto& algoName = algo->name();
261  auto itA = m_algoNameToAlgoNodeMap.find( algoName );
262  concurrency::AlgorithmNode* algoNode;
263  if ( itA != m_algoNameToAlgoNodeMap.end() ) {
264  algoNode = itA->second;
265  } else {
266  algoNode = new concurrency::AlgorithmNode( *this, algo, m_nodeCounter, m_algoCounter, inverted, allPass );
267  // Mirror the action above in the BGL-based graph
268  if ( m_enableAnalysis ) {
269  auto source =
270  boost::add_vertex( AlgoProps( algo, m_nodeCounter, m_algoCounter, inverted, allPass ), m_PRGraph );
271  boost::add_edge( source, node( parentName ), m_PRGraph );
272  }
273  ++m_nodeCounter;
274  ++m_algoCounter;
275  m_algoNameToAlgoNodeMap[algoName] = algoNode;
276  ON_VERBOSE verbose() << "AlgoNode " << algoName << " added @ " << algoNode << endmsg;
277  registerIODataObjects( algo );
278  }
279 
280  // Attach AlgorithmNode to its CF decision hub
281  auto itP = m_decisionNameToDecisionHubMap.find( parentName );
282  if ( itP != m_decisionNameToDecisionHubMap.end() ) {
283  auto parentNode = itP->second;
284  ON_VERBOSE verbose() << "Attaching AlgorithmNode '" << algo->name() << "' to DecisionNode '" << parentName << "'"
285  << endmsg;
286 
287  parentNode->addDaughterNode( algoNode );
288  algoNode->addParentNode( parentNode );
289  } else {
290  sc = StatusCode::FAILURE;
291  error() << "Requested DecisionNode '" << parentName << "' was not found" << endmsg;
292  }
293 
294  return sc;
295  }
296 
297  //---------------------------------------------------------------------------
299  {
300 
301  return m_algoNameToAlgoNodeMap.at( algoName );
302  }
303 
304  //---------------------------------------------------------------------------
306  {
307 
308  StatusCode sc;
309 
310  auto itD = m_dataPathToDataNodeMap.find( dataPath );
311  concurrency::DataNode* dataNode;
312  if ( itD != m_dataPathToDataNodeMap.end() ) {
313  dataNode = itD->second;
314  sc = StatusCode::SUCCESS;
315  } else {
316  if ( !m_conditionsRealmEnabled ) {
317  dataNode = new concurrency::DataNode( *this, dataPath );
318  ON_VERBOSE verbose() << " DataNode for " << dataPath << " added @ " << dataNode << endmsg;
319  // Mirror the action above in the BGL-based graph
320  if ( m_enableAnalysis ) boost::add_vertex( DataProps( dataPath ), m_PRGraph );
321  } else {
322  SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc", false )};
323  if ( condSvc->isRegistered( dataPath ) ) {
324  dataNode = new concurrency::ConditionNode( *this, dataPath, condSvc );
325  ON_VERBOSE verbose() << " ConditionNode for " << dataPath << " added @ " << dataNode << endmsg;
326  // Mirror the action above in the BGL-based graph
327  if ( m_enableAnalysis ) boost::add_vertex( CondDataProps( dataPath ), m_PRGraph );
328  } else {
329  dataNode = new concurrency::DataNode( *this, dataPath );
330  ON_VERBOSE verbose() << " DataNode for " << dataPath << " added @ " << dataNode << endmsg;
331  // Mirror the action above in the BGL-based graph
332  if ( m_enableAnalysis ) boost::add_vertex( DataProps( dataPath ), m_PRGraph );
333  }
334  }
335 
336  m_dataPathToDataNodeMap[dataPath] = dataNode;
337 
338  sc = StatusCode::SUCCESS;
339  }
340 
341  return sc;
342  }
343 
344  //---------------------------------------------------------------------------
346  {
347 
348  return m_dataPathToDataNodeMap.at( dataPath );
349  }
350 
351  //---------------------------------------------------------------------------
353  Concurrent modeConcurrent, PromptDecision modePromptDecision,
354  ModeOr modeOR, AllPass allPass, Inverted isInverted )
355  {
356 
358 
359  auto& decisionHubName = decisionHubAlgo->name();
360 
361  auto itP = m_decisionNameToDecisionHubMap.find( parentName );
362  concurrency::DecisionNode* parentNode;
363  if ( itP != m_decisionNameToDecisionHubMap.end() ) {
364  parentNode = itP->second;
365  auto itA = m_decisionNameToDecisionHubMap.find( decisionHubName );
366  concurrency::DecisionNode* decisionHubNode;
367  if ( itA != m_decisionNameToDecisionHubMap.end() ) {
368  decisionHubNode = itA->second;
369  } else {
370  decisionHubNode = new concurrency::DecisionNode( *this, m_nodeCounter, decisionHubName, modeConcurrent,
371  modePromptDecision, modeOR, allPass, isInverted );
372  m_decisionNameToDecisionHubMap[decisionHubName] = decisionHubNode;
373 
374  // Mirror the action above in the BGL-based graph
375  if ( m_enableAnalysis ) {
376  auto source = boost::add_vertex( DecisionHubProps( decisionHubName, m_nodeCounter, modeConcurrent,
377  modePromptDecision, modeOR, allPass, isInverted ),
378  m_PRGraph );
379  boost::add_edge( source, node( parentName ), m_PRGraph );
380  }
381 
382  ++m_nodeCounter;
383 
384  ON_VERBOSE verbose() << "Decision hub node " << decisionHubName << " added @ " << decisionHubNode << endmsg;
385  }
386 
387  parentNode->addDaughterNode( decisionHubNode );
388  decisionHubNode->addParentNode( parentNode );
389  } else {
390  sc = StatusCode::FAILURE;
391  error() << "Decision hub node " << parentName << ", requested to be parent, is not registered." << endmsg;
392  }
393 
394  return sc;
395  }
396 
397  //---------------------------------------------------------------------------
399  concurrency::PromptDecision modePromptDecision, concurrency::ModeOr modeOR,
400  concurrency::AllPass allPass, concurrency::Inverted isInverted )
401  {
402 
403  auto itH = m_decisionNameToDecisionHubMap.find( headName );
404  if ( itH != m_decisionNameToDecisionHubMap.end() ) {
405  m_headNode = itH->second;
406  } else {
407  m_headNode = new concurrency::DecisionNode( *this, m_nodeCounter, headName, modeConcurrent, modePromptDecision,
408  modeOR, allPass, isInverted );
409  m_decisionNameToDecisionHubMap[headName] = m_headNode;
410 
411  // Mirror the action above in the BGL-based graph
412  if ( m_enableAnalysis ) {
413  boost::add_vertex( DecisionHubProps( headName, m_nodeCounter, modeConcurrent, modePromptDecision, modeOR,
414  allPass, isInverted ),
415  m_PRGraph );
416  }
417 
418  ++m_nodeCounter;
419  }
420  }
421 
422  //---------------------------------------------------------------------------
424  {
425 
426  PRVertexDesc target{};
427 
428  for ( auto vp = vertices( m_PRGraph ); vp.first != vp.second; ++vp.first ) {
429  PRVertexDesc v = *vp.first;
430  if ( boost::apply_visitor( precedence::VertexName(), m_PRGraph[v] ) == name ) {
431  target = v;
432  break;
433  }
434  }
435 
436  return target;
437  }
438 
439  //---------------------------------------------------------------------------
440  void PrecedenceRulesGraph::accept( const std::string& algo_name, IGraphVisitor& visitor ) const
441  {
442  getAlgorithmNode( algo_name )->accept( visitor );
443  }
444 
445  //---------------------------------------------------------------------------
447  {
448 
449  info() << "Starting ranking by data outputs .. " << endmsg;
450  for ( auto& pair : m_algoNameToAlgoNodeMap ) {
451  ON_DEBUG debug() << " Ranking " << pair.first << "... " << endmsg;
452  pair.second->accept( ranker );
453  ON_DEBUG debug() << " ... rank of " << pair.first << ": " << pair.second->getRank() << endmsg;
454  }
455  }
456 
458  {
459  std::ostringstream ost;
460  dumpControlFlow( ost, m_headNode, 0 );
461  return ost.str();
462  }
463 
464  void PrecedenceRulesGraph::dumpControlFlow( std::ostringstream& ost, ControlFlowNode* node, const int& indent ) const
465  {
466  ost << std::string( indent * 2, ' ' );
467  DecisionNode* dn = dynamic_cast<DecisionNode*>( node );
468  AlgorithmNode* an = dynamic_cast<AlgorithmNode*>( node );
469  if ( dn != 0 ) {
470  if ( node != m_headNode ) {
471  ost << node->getNodeName() << " [Seq] ";
472  ost << ( ( dn->m_modeConcurrent ) ? " [Concurrent] " : " [Sequential] " );
473  ost << ( ( dn->m_modePromptDecision ) ? " [Prompt] " : "" );
474  ost << ( ( dn->m_modeOR ) ? " [OR] " : "" );
475  ost << ( ( dn->m_allPass ) ? " [PASS] " : "" );
476  ost << "\n";
477  }
478  const std::vector<ControlFlowNode*>& dth = dn->getDaughters();
479  for ( std::vector<ControlFlowNode*>::const_iterator itr = dth.begin(); itr != dth.end(); ++itr ) {
480  dumpControlFlow( ost, *itr, indent + 1 );
481  }
482  } else if ( an != 0 ) {
483  ost << node->getNodeName() << " [Alg] ";
484  if ( an != 0 ) {
485  auto ar = an->getAlgorithm();
486  ost << " [n= " << ar->cardinality() << "]";
487  ost << ( ( !ar->isClonable() ) ? " [unclonable] " : "" );
488  }
489  ost << "\n";
490  }
491  }
492 
493  //---------------------------------------------------------------------------
495  {
496 
497  const char idt[] = " ";
498  std::ostringstream ost;
499 
500  ost << "\n" << idt << "====================================\n";
501  ost << idt << "Data origins and destinations:\n";
502  ost << idt << "====================================\n";
503 
504  for ( auto& pair : m_dataPathToDataNodeMap ) {
505 
506  for ( auto algoNode : pair.second->getProducers() ) ost << idt << " " << algoNode->getNodeName() << "\n";
507 
508  ost << idt << " V\n";
509  ost << idt << " o " << pair.first << "\n";
510  ost << idt << " V\n";
511 
512  for ( auto algoNode : pair.second->getConsumers() ) ost << idt << " " << algoNode->getNodeName() << "\n";
513 
514  ost << idt << "====================================\n";
515  }
516 
517  return ost.str();
518  }
519 
520  //---------------------------------------------------------------------------
521 
523  {
524  boost::filesystem::ofstream myfile;
525  myfile.open( fileName, std::ios::app );
526 
527  // Declare properties to dump
528  boost::dynamic_properties dp;
529 
530  using boost::make_transform_value_property_map;
531  using boost::apply_visitor;
532  using boost::get;
533  using boost::vertex_bundle;
534 
535  dp.property( "Entity", make_transform_value_property_map(
536  []( const VariantVertexProps& v ) { return boost::lexical_cast<std::string>( v ); },
537  get( vertex_bundle, m_PRGraph ) ) );
538 
539  auto nameVis = precedence::VertexName();
540  dp.property( "Name", make_transform_value_property_map(
541  [&nameVis]( const VariantVertexProps& v ) { return apply_visitor( nameVis, v ); },
542  get( vertex_bundle, m_PRGraph ) ) );
543 
544  auto gMVis = precedence::GroupMode();
545  dp.property( "Mode", make_transform_value_property_map(
546  [&gMVis]( const VariantVertexProps& v ) { return apply_visitor( gMVis, v ); },
547  get( vertex_bundle, m_PRGraph ) ) );
548 
549  auto gLVis = precedence::GroupLogic();
550  dp.property( "Logic", make_transform_value_property_map(
551  [&gLVis]( const VariantVertexProps& v ) { return apply_visitor( gLVis, v ); },
552  get( vertex_bundle, m_PRGraph ) ) );
553 
554  auto dNVis = precedence::DecisionNegation();
555  dp.property( "Decision Negation", make_transform_value_property_map(
556  [&dNVis]( const VariantVertexProps& v ) { return apply_visitor( dNVis, v ); },
557  get( vertex_bundle, m_PRGraph ) ) );
558 
559  auto aPVis = precedence::AllPass();
560  dp.property( "Negative Decision Inversion",
561  make_transform_value_property_map(
562  [&aPVis]( const VariantVertexProps& v ) { return apply_visitor( aPVis, v ); },
563  get( vertex_bundle, m_PRGraph ) ) );
564 
565  auto gEVis = precedence::GroupExit();
566  dp.property( "Exit Policy", make_transform_value_property_map(
567  [&gEVis]( const VariantVertexProps& v ) { return apply_visitor( gEVis, v ); },
568  get( vertex_bundle, m_PRGraph ) ) );
569 
570  auto opVis = precedence::Operations();
571  dp.property( "Operations", make_transform_value_property_map(
572  [&opVis]( const VariantVertexProps& v ) { return apply_visitor( opVis, v ); },
573  get( vertex_bundle, m_PRGraph ) ) );
574 
575  auto cFDVis = precedence::CFDecision( slot );
576  dp.property( "CF Decision", make_transform_value_property_map(
577  [&cFDVis]( const VariantVertexProps& v ) { return apply_visitor( cFDVis, v ); },
578  get( vertex_bundle, m_PRGraph ) ) );
579 
580  auto stVis = precedence::EntityState( slot, serviceLocator(), m_conditionsRealmEnabled );
581  dp.property( "State", make_transform_value_property_map(
582  [&stVis]( const VariantVertexProps& v ) { return apply_visitor( stVis, v ); },
583  get( vertex_bundle, m_PRGraph ) ) );
584 
585  auto sTVis = precedence::StartTime( slot, serviceLocator() );
586  dp.property( "Start Time (Epoch ns)",
587  make_transform_value_property_map(
588  [&sTVis]( const VariantVertexProps& v ) { return apply_visitor( sTVis, v ); },
589  get( vertex_bundle, m_PRGraph ) ) );
590 
591  auto eTVis = precedence::EndTime( slot, serviceLocator() );
592  dp.property( "End Time (Epoch ns)",
593  make_transform_value_property_map(
594  [&eTVis]( const VariantVertexProps& v ) { return apply_visitor( eTVis, v ); },
595  get( vertex_bundle, m_PRGraph ) ) );
596 
597  auto durVis = precedence::Duration( slot, serviceLocator() );
598  dp.property( "Runtime (ns)", make_transform_value_property_map(
599  [&durVis]( const VariantVertexProps& v ) { return apply_visitor( durVis, v ); },
600  get( vertex_bundle, m_PRGraph ) ) );
601 
602  boost::write_graphml( myfile, m_PRGraph, dp );
603 
604  myfile.close();
605  }
606 
607  //---------------------------------------------------------------------------
609  {
610  boost::filesystem::ofstream myfile;
611  myfile.open( fileName, std::ios::app );
612 
613  // Fill runtimes (as this could not be done on the fly during trace assembling)
614  SmartIF<ITimelineSvc> timelineSvc = m_svcLocator->service<ITimelineSvc>( "TimelineSvc", false );
615  if ( !timelineSvc.isValid() ) {
616  warning() << "Failed to get the TimelineSvc, timing will not be added to "
617  << "the task precedence trace dump" << endmsg;
618  } else {
619 
620  typedef boost::graph_traits<precedence::PRGraph>::vertex_iterator vertex_iter;
622  for ( vp = vertices( m_precTrace ); vp.first != vp.second; ++vp.first ) {
623  TimelineEvent te{};
624  te.algorithm = m_precTrace[*vp.first].m_name;
625  timelineSvc->getTimelineEvent( te );
626  int runtime = std::chrono::duration_cast<std::chrono::nanoseconds>( te.end - te.start ).count();
627  m_precTrace[*vp.first].m_runtime = runtime;
628  }
629  }
630 
631  // Declare properties to dump
632  boost::dynamic_properties dp;
633  using boost::get;
635  dp.property( "Name", get( &AlgoTraceProps::m_name, m_precTrace ) );
636  dp.property( "Rank", get( &AlgoTraceProps::m_rank, m_precTrace ) );
637  dp.property( "Runtime", get( &AlgoTraceProps::m_runtime, m_precTrace ) );
638 
639  boost::write_graphml( myfile, m_precTrace, dp );
640 
641  myfile.close();
642  }
643 
645  {
646 
647  std::string u_name = u == nullptr ? "ENTRY" : u->getNodeName();
648  std::string v_name = v->getNodeName();
649 
651 
652  if ( u == nullptr ) {
653  auto itT = m_prec_trace_map.find( "ENTRY" );
654  if ( itT != m_prec_trace_map.end() ) {
655  source = itT->second;
656  } else {
657  source = boost::add_vertex( precedence::AlgoTraceProps( "ENTRY", -1, -1, -1.0 ), m_precTrace );
658  m_prec_trace_map["ENTRY"] = source;
659  }
660  } else {
661  auto itS = m_prec_trace_map.find( u_name );
662  if ( itS != m_prec_trace_map.end() ) {
663  source = itS->second;
664  } else {
665 
666  source =
667  boost::add_vertex( precedence::AlgoTraceProps( u_name, u->getAlgoIndex(), u->getRank(), -1 ), m_precTrace );
668  m_prec_trace_map[u_name] = source;
669  }
670  }
671 
673 
674  auto itP = m_prec_trace_map.find( v_name );
675  if ( itP != m_prec_trace_map.end() ) {
676  target = itP->second;
677  } else {
678 
679  target =
680  boost::add_vertex( precedence::AlgoTraceProps( v_name, v->getAlgoIndex(), v->getRank(), -1 ), m_precTrace );
681  m_prec_trace_map[v_name] = target;
682  }
683 
684  boost::add_edge( source, target, m_precTrace );
685 
686  ON_DEBUG debug() << u_name << "-->" << v_name << " precedence trait added" << endmsg;
687  }
688 
689 } // namespace
PRVertexDesc node(const std::string &) const
const unsigned int & getAlgoIndex() const
Get algorithm index.
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:737
void addDaughterNode(ControlFlowNode *node)
Add a daughter node.
boost::graph_traits< PrecTrace >::vertex_descriptor AlgoTraceVertex
boost::graph_traits< PRGraph >::vertex_descriptor PRVertexDesc
const DataObjIDColl & outputDataObjs() const override
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
virtual bool visit(DecisionNode &)
Definition: IGraphVisitor.h:18
void dumpPrecRules(const boost::filesystem::path &, const EventSlot &slot)
dump to file the precedence rules
T endl(T...args)
std::vector< DecisionNode * > m_parents
Control flow parents of an AlgorithmNode (DecisionNodes)
std::string algorithm
Definition: ITimelineSvc.h:18
std::string stateToString(const int &stateId) const
Translation between state id and name.
T duration_cast(T...args)
T end(T...args)
StatusCode addDataNode(const DataObjID &dataPath)
Add DataNode that represents DataObject.
AlgorithmNode * getAlgorithmNode(const std::string &algoName) const
Get the AlgorithmNode from by algorithm name using graph index.
void rankAlgorithms(IGraphVisitor &ranker) const
Rank Algorithm nodes by the number of data outputs.
#define ON_DEBUG
bool m_allPass
Whether always passing regardless of daughter results.
const std::vector< DecisionNode * > & getParentDecisionHubs() const
Get all parent decision hubs.
T remove(T...args)
Gaudi::tagged_bool< class ModeOr_tag > ModeOr
virtual bool visitEnter(DecisionNode &) const
Definition: IGraphVisitor.h:17
STL class.
Algorithm * getAlgorithm() const
get Algorithm representatives
virtual void getTimelineEvent(TimelineEvent &) const =0
bool m_modeOR
Whether acting as "and" (false) or "or" node (true)
void addInputDataNode(DataNode *node)
Associate an AlgorithmNode, which is a data consumer of this one.
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
StatusCode initialize()
Initialize graph.
void dumpPrecTrace(const boost::filesystem::path &)
dump to file the precedence trace
const float & getRank() const
Get Algorithm rank.
The AlgsExecutionStates encodes the state machine for the execution of algorithms within a single eve...
virtual const std::set< IAlgorithm * > & condAlgs() const =0
get list of all registered condition Algorithms
Gaudi::tagged_bool< class Inverted_tag > Inverted
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
const DataObjIDColl & inputDataObjs() const override
std::string dumpDataFlow() const
Print out all data origins and destinations, as reflected in the EF graph.
const std::vector< ControlFlowNode * > & getDaughters() const
Get children nodes.
void accept(const std::string &algo_name, IGraphVisitor &visitor) const
A method to update algorithm node decision, and propagate it upwards.
DataNode * getDataNode(const DataObjID &dataPath) const
Get DataNode by DataObject path using graph index.
Gaudi::tagged_bool< class Concurrent_tag > Concurrent
bool m_modePromptDecision
Whether to evaluate the hub decision ASA its child decisions allow to do that.
void addEdgeToPrecTrace(const AlgorithmNode *u, const AlgorithmNode *v)
set cause-effect connection between two algorithms in the precedence trace
void addOutputDataNode(DataNode *node)
Associate an AlgorithmNode, which is a data supplier for this one.
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
T find(T...args)
std::vector< InputHandle_t< In > > m_inputs
Gaudi::tagged_bool< class PromptDecision_tag > PromptDecision
void addParentNode(DecisionNode *node)
Add a parent node.
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:68
T begin(T...args)
void registerIODataObjects(const Algorithm *algo)
Register algorithm in the Data Dependency index.
bool m_modeConcurrent
Whether all daughters will be evaluated concurrently or sequentially.
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.
void printState(std::stringstream &output, AlgsExecutionStates &states, const std::vector< int > &node_decisions, const unsigned int &recursionLevel) const override
Print a string representing the control flow state.
Class representing the event slot.
Definition: EventSlot.h:10
Gaudi::tagged_bool< class AllPass_tag > AllPass
void addParentNode(DecisionNode *node)
Add a parent node.
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
const std::string & getNodeName() const
Get node name.
#define ON_VERBOSE
void printState(std::stringstream &output, AlgsExecutionStates &states, const std::vector< int > &node_decisions, const unsigned int &recursionLevel) const override
Print a string representing the control flow state.
StatusCode buildDataDependenciesRealm()
Build data dependency realm WITH data object nodes participating.
std::string dumpControlFlow() const
Print out control flow of Algorithms and Sequences.
~DecisionNode() override
Destructor.
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.
static std::map< State, std::string > stateNames
boost::variant< AlgoProps, DecisionHubProps, DataProps, CondDataProps > VariantVertexProps
void addConsumerNode(AlgorithmNode *node)
Add relationship to consumer AlgorithmNode.