The Gaudi Framework  v30r0 (c919700c)
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  // if no decision can be made yet, request further information downwards
77  for ( auto child : m_children ) {
78  bool result = child->accept( visitor );
79  if ( !m_modeConcurrent )
80  if ( result ) break; // stop on first unresolved child if its decision hub is sequential
81  }
82 
83  return true; // visitor was accepted to try to aggregate the node's decision
84  }
85 
86  return false; // visitor was rejected (since the decision node has an aggregated decision already)
87  }
88 
89  //---------------------------------------------------------------------------
91  {
92 
93  for ( auto node : m_outputs ) {
94  delete node;
95  }
96  }
97 
98  //---------------------------------------------------------------------------
100  const std::vector<int>& node_decisions, const unsigned int& recursionLevel ) const
101  {
102  output << std::string( recursionLevel, ' ' ) << m_nodeName << " (" << m_nodeIndex << ")"
103  << ", w/ decision: " << stateToString( node_decisions[m_nodeIndex] ) << "(" << node_decisions[m_nodeIndex]
104  << ")"
105  << ", in state: " << AlgsExecutionStates::stateNames[states[m_algoIndex]] << std::endl;
106  }
107 
108  //---------------------------------------------------------------------------
110  {
111 
112  if ( visitor.visitEnter( *this ) ) {
113  visitor.visit( *this );
114  return true; // visitor was accepted to promote the algorithm
115  }
116 
117  return false; // visitor was rejected (since the algorithm already produced a decision)
118  }
119 
120  //---------------------------------------------------------------------------
122  {
123 
124  if ( std::find( m_parents.begin(), m_parents.end(), node ) == m_parents.end() ) m_parents.push_back( node );
125  }
126 
127  //---------------------------------------------------------------------------
129  {
130 
131  if ( std::find( m_outputs.begin(), m_outputs.end(), node ) == m_outputs.end() ) m_outputs.push_back( node );
132  }
133 
134  //---------------------------------------------------------------------------
136  {
137 
138  if ( std::find( m_inputs.begin(), m_inputs.end(), node ) == m_inputs.end() ) m_inputs.push_back( node );
139  }
140 
141  //---------------------------------------------------------------------------
143  {
144  if ( serviceLocator()->existsService( "CondSvc" ) ) {
145  SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc" )};
146  if ( condSvc.isValid() ) {
147  info() << "CondSvc found. DF precedence rules will be augmented with 'Conditions'" << endmsg;
148  m_conditionsRealmEnabled = true;
149  }
150  }
151 
152  // Detach condition algorithms from the CF realm
153  if ( m_conditionsRealmEnabled ) {
154  SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc", false )};
155  auto& condAlgs = condSvc->condAlgs();
156  for ( const auto algo : condAlgs ) {
157  auto itA = m_algoNameToAlgoNodeMap.find( algo->name() );
158  concurrency::AlgorithmNode* algoNode;
159  if ( itA != m_algoNameToAlgoNodeMap.end() ) {
160  algoNode = itA->second;
161  debug() << "Detaching condition algorithm '" << algo->name() << "' from the CF realm.." << endmsg;
162  for ( auto parent : algoNode->getParentDecisionHubs() ) {
163  parent->m_children.erase( std::remove( parent->m_children.begin(), parent->m_children.end(), algoNode ),
164  parent->m_children.end() );
165  // clean up also auxiliary BGL-based graph of precedence rules
166  if ( m_enableAnalysis )
167  boost::remove_edge( node( algoNode->getNodeName() ), node( parent->getNodeName() ), m_PRGraph );
168  }
169  algoNode->m_parents.clear();
170 
171  } else {
172  warning() << "Algorithm '" << algo->name() << "' is not registered in the graph" << endmsg;
173  }
174  }
175  }
176 
177  StatusCode sc = buildDataDependenciesRealm();
178 
179  if ( !sc.isSuccess() ) error() << "Could not build the data dependency realm." << endmsg;
180 
181  ON_DEBUG debug() << dumpDataFlow() << endmsg;
182 
183  return sc;
184  }
185 
186  //---------------------------------------------------------------------------
188  {
189 
190  const std::string& algoName = algo->name();
191 
192  m_algoNameToAlgoInputsMap[algoName] = algo->inputDataObjs();
193  m_algoNameToAlgoOutputsMap[algoName] = algo->outputDataObjs();
194 
195  ON_VERBOSE
196  {
197  verbose() << " Inputs of " << algoName << ": ";
198  for ( auto tag : algo->inputDataObjs() ) verbose() << tag << " | ";
199  verbose() << endmsg;
200 
201  verbose() << " Outputs of " << algoName << ": ";
202  for ( auto tag : algo->outputDataObjs() ) verbose() << tag << " | ";
203  verbose() << endmsg;
204  }
205  }
206 
207  //---------------------------------------------------------------------------
209  {
210 
211  StatusCode global_sc( StatusCode::SUCCESS, true );
212 
213  // Production of DataNodes by AlgorithmNodes (DataNodes are created here)
214  for ( auto algo : m_algoNameToAlgoNodeMap ) {
215 
216  auto& outputs = m_algoNameToAlgoOutputsMap[algo.first];
217  for ( auto output : outputs ) {
218  const auto sc = addDataNode( output );
219  if ( !sc.isSuccess() ) {
220  error() << "Extra producer (" << algo.first << ") for DataObject @ " << output
221  << " has been detected: this is not allowed." << endmsg;
222  global_sc = sc;
223  }
224  auto dataNode = getDataNode( output );
225  dataNode->addProducerNode( algo.second );
226  algo.second->addOutputDataNode( dataNode );
227 
228  // Mirror the action above in the BGL-based graph
229  if ( m_enableAnalysis )
230  boost::add_edge( node( algo.second->getNodeName() ), node( output.fullKey() ), m_PRGraph );
231  }
232  }
233 
234  // Consumption of DataNodes by AlgorithmNodes
235  for ( auto algo : m_algoNameToAlgoNodeMap ) {
236 
237  for ( auto input : m_algoNameToAlgoInputsMap[algo.first] ) {
238 
239  DataNode* dataNode = nullptr;
240 
241  auto itP = m_dataPathToDataNodeMap.find( input );
242 
243  if ( itP != m_dataPathToDataNodeMap.end() ) dataNode = getDataNode( input );
244 
245  if ( dataNode ) {
246  dataNode->addConsumerNode( algo.second );
247  algo.second->addInputDataNode( dataNode );
248 
249  // Mirror the action above in the BGL-based graph
250  if ( m_enableAnalysis )
251  boost::add_edge( node( input.fullKey() ), node( algo.second->getNodeName() ), m_PRGraph );
252  }
253  }
254  }
255 
256  return global_sc;
257  }
258 
259  //---------------------------------------------------------------------------
260  StatusCode PrecedenceRulesGraph::addAlgorithmNode( Algorithm* algo, const std::string& parentName, bool inverted,
261  bool allPass )
262  {
263 
265 
266  // Create new, or fetch existent, AlgorithmNode
267  auto& algoName = algo->name();
268  auto itA = m_algoNameToAlgoNodeMap.find( algoName );
269  concurrency::AlgorithmNode* algoNode;
270  if ( itA != m_algoNameToAlgoNodeMap.end() ) {
271  algoNode = itA->second;
272  } else {
273  algoNode = new concurrency::AlgorithmNode( *this, algo, m_nodeCounter, m_algoCounter, inverted, allPass );
274  // Mirror the action above in the BGL-based graph
275  if ( m_enableAnalysis ) {
276  auto source =
277  boost::add_vertex( AlgoProps( algo, m_nodeCounter, m_algoCounter, inverted, allPass ), m_PRGraph );
278  boost::add_edge( source, node( parentName ), m_PRGraph );
279  }
280  ++m_nodeCounter;
281  ++m_algoCounter;
282  m_algoNameToAlgoNodeMap[algoName] = algoNode;
283  ON_VERBOSE verbose() << "AlgoNode " << algoName << " added @ " << algoNode << endmsg;
284  registerIODataObjects( algo );
285  }
286 
287  // Attach AlgorithmNode to its CF decision hub
288  auto itP = m_decisionNameToDecisionHubMap.find( parentName );
289  if ( itP != m_decisionNameToDecisionHubMap.end() ) {
290  auto parentNode = itP->second;
291  ON_VERBOSE verbose() << "Attaching AlgorithmNode '" << algo->name() << "' to DecisionNode '" << parentName << "'"
292  << endmsg;
293 
294  parentNode->addDaughterNode( algoNode );
295  algoNode->addParentNode( parentNode );
296  } else {
297  sc = StatusCode::FAILURE;
298  error() << "Requested DecisionNode '" << parentName << "' was not found" << endmsg;
299  }
300 
301  return sc;
302  }
303 
304  //---------------------------------------------------------------------------
306  {
307 
308  return m_algoNameToAlgoNodeMap.at( algoName );
309  }
310 
311  //---------------------------------------------------------------------------
313  {
314 
315  StatusCode sc;
316 
317  auto itD = m_dataPathToDataNodeMap.find( dataPath );
318  concurrency::DataNode* dataNode;
319  if ( itD != m_dataPathToDataNodeMap.end() ) {
320  dataNode = itD->second;
321  sc = StatusCode::SUCCESS;
322  } else {
323  if ( !m_conditionsRealmEnabled ) {
324  dataNode = new concurrency::DataNode( *this, dataPath );
325  ON_VERBOSE verbose() << " DataNode for " << dataPath << " added @ " << dataNode << endmsg;
326  // Mirror the action above in the BGL-based graph
327  if ( m_enableAnalysis ) boost::add_vertex( DataProps( dataPath ), m_PRGraph );
328  } else {
329  SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc", false )};
330  if ( condSvc->isRegistered( dataPath ) ) {
331  dataNode = new concurrency::ConditionNode( *this, dataPath, condSvc );
332  ON_VERBOSE verbose() << " ConditionNode for " << dataPath << " added @ " << dataNode << endmsg;
333  // Mirror the action above in the BGL-based graph
334  if ( m_enableAnalysis ) boost::add_vertex( CondDataProps( dataPath ), m_PRGraph );
335  } else {
336  dataNode = new concurrency::DataNode( *this, dataPath );
337  ON_VERBOSE verbose() << " DataNode for " << dataPath << " added @ " << dataNode << endmsg;
338  // Mirror the action above in the BGL-based graph
339  if ( m_enableAnalysis ) boost::add_vertex( DataProps( dataPath ), m_PRGraph );
340  }
341  }
342 
343  m_dataPathToDataNodeMap[dataPath] = dataNode;
344 
345  sc = StatusCode::SUCCESS;
346  }
347 
348  return sc;
349  }
350 
351  //---------------------------------------------------------------------------
353  {
354 
355  return m_dataPathToDataNodeMap.at( dataPath );
356  }
357 
358  //---------------------------------------------------------------------------
360  Concurrent modeConcurrent, PromptDecision modePromptDecision,
361  ModeOr modeOR, AllPass allPass, Inverted isInverted )
362  {
363 
365 
366  auto& decisionHubName = decisionHubAlgo->name();
367 
368  auto itP = m_decisionNameToDecisionHubMap.find( parentName );
369  concurrency::DecisionNode* parentNode;
370  if ( itP != m_decisionNameToDecisionHubMap.end() ) {
371  parentNode = itP->second;
372  auto itA = m_decisionNameToDecisionHubMap.find( decisionHubName );
373  concurrency::DecisionNode* decisionHubNode;
374  if ( itA != m_decisionNameToDecisionHubMap.end() ) {
375  decisionHubNode = itA->second;
376  } else {
377  decisionHubNode = new concurrency::DecisionNode( *this, m_nodeCounter, decisionHubName, modeConcurrent,
378  modePromptDecision, modeOR, allPass, isInverted );
379  m_decisionNameToDecisionHubMap[decisionHubName] = decisionHubNode;
380 
381  // Mirror the action above in the BGL-based graph
382  if ( m_enableAnalysis ) {
383  auto source = boost::add_vertex( DecisionHubProps( decisionHubName, m_nodeCounter, modeConcurrent,
384  modePromptDecision, modeOR, allPass, isInverted ),
385  m_PRGraph );
386  boost::add_edge( source, node( parentName ), m_PRGraph );
387  }
388 
389  ++m_nodeCounter;
390 
391  ON_VERBOSE verbose() << "Decision hub node " << decisionHubName << " added @ " << decisionHubNode << endmsg;
392  }
393 
394  parentNode->addDaughterNode( decisionHubNode );
395  decisionHubNode->addParentNode( parentNode );
396  } else {
397  sc = StatusCode::FAILURE;
398  error() << "Decision hub node " << parentName << ", requested to be parent, is not registered." << endmsg;
399  }
400 
401  return sc;
402  }
403 
404  //---------------------------------------------------------------------------
406  concurrency::PromptDecision modePromptDecision, concurrency::ModeOr modeOR,
407  concurrency::AllPass allPass, concurrency::Inverted isInverted )
408  {
409 
410  auto itH = m_decisionNameToDecisionHubMap.find( headName );
411  if ( itH != m_decisionNameToDecisionHubMap.end() ) {
412  m_headNode = itH->second;
413  } else {
414  m_headNode = new concurrency::DecisionNode( *this, m_nodeCounter, headName, modeConcurrent, modePromptDecision,
415  modeOR, allPass, isInverted );
416  m_decisionNameToDecisionHubMap[headName] = m_headNode;
417 
418  // Mirror the action above in the BGL-based graph
419  if ( m_enableAnalysis ) {
420  boost::add_vertex( DecisionHubProps( headName, m_nodeCounter, modeConcurrent, modePromptDecision, modeOR,
421  allPass, isInverted ),
422  m_PRGraph );
423  }
424 
425  ++m_nodeCounter;
426  }
427  }
428 
429  //---------------------------------------------------------------------------
431  {
432 
433  PRVertexDesc target{};
434 
435  for ( auto vp = vertices( m_PRGraph ); vp.first != vp.second; ++vp.first ) {
436  PRVertexDesc v = *vp.first;
437  if ( boost::apply_visitor( precedence::VertexName(), m_PRGraph[v] ) == name ) {
438  target = v;
439  break;
440  }
441  }
442 
443  return target;
444  }
445 
446  //---------------------------------------------------------------------------
447  void PrecedenceRulesGraph::accept( const std::string& algo_name, IGraphVisitor& visitor ) const
448  {
449  getAlgorithmNode( algo_name )->accept( visitor );
450  }
451 
452  //---------------------------------------------------------------------------
454  {
455 
456  info() << "Starting ranking by data outputs .. " << endmsg;
457  for ( auto& pair : m_algoNameToAlgoNodeMap ) {
458  ON_DEBUG debug() << " Ranking " << pair.first << "... " << endmsg;
459  pair.second->accept( ranker );
460  ON_DEBUG debug() << " ... rank of " << pair.first << ": " << pair.second->getRank() << endmsg;
461  }
462  }
463 
465  {
466  std::ostringstream ost;
467  dumpControlFlow( ost, m_headNode, 0 );
468  return ost.str();
469  }
470 
471  void PrecedenceRulesGraph::dumpControlFlow( std::ostringstream& ost, ControlFlowNode* node, const int& indent ) const
472  {
473  ost << std::string( indent * 2, ' ' );
474  DecisionNode* dn = dynamic_cast<DecisionNode*>( node );
475  AlgorithmNode* an = dynamic_cast<AlgorithmNode*>( node );
476  if ( dn != 0 ) {
477  if ( node != m_headNode ) {
478  ost << node->getNodeName() << " [Seq] ";
479  ost << ( ( dn->m_modeConcurrent ) ? " [Concurrent] " : " [Sequential] " );
480  ost << ( ( dn->m_modePromptDecision ) ? " [Prompt] " : "" );
481  ost << ( ( dn->m_modeOR ) ? " [OR] " : "" );
482  ost << ( ( dn->m_allPass ) ? " [PASS] " : "" );
483  ost << "\n";
484  }
485  const std::vector<ControlFlowNode*>& dth = dn->getDaughters();
486  for ( std::vector<ControlFlowNode*>::const_iterator itr = dth.begin(); itr != dth.end(); ++itr ) {
487  dumpControlFlow( ost, *itr, indent + 1 );
488  }
489  } else if ( an != 0 ) {
490  ost << node->getNodeName() << " [Alg] ";
491  if ( an != 0 ) {
492  auto ar = an->getAlgorithm();
493  ost << " [n= " << ar->cardinality() << "]";
494  ost << ( ( !ar->isClonable() ) ? " [unclonable] " : "" );
495  }
496  ost << "\n";
497  }
498  }
499 
500  //---------------------------------------------------------------------------
502  {
503 
504  const char idt[] = " ";
505  std::ostringstream ost;
506 
507  ost << "\n" << idt << "====================================\n";
508  ost << idt << "Data origins and destinations:\n";
509  ost << idt << "====================================\n";
510 
511  for ( auto& pair : m_dataPathToDataNodeMap ) {
512 
513  for ( auto algoNode : pair.second->getProducers() ) ost << idt << " " << algoNode->getNodeName() << "\n";
514 
515  ost << idt << " V\n";
516  ost << idt << " o " << pair.first << "\n";
517  ost << idt << " V\n";
518 
519  for ( auto algoNode : pair.second->getConsumers() ) ost << idt << " " << algoNode->getNodeName() << "\n";
520 
521  ost << idt << "====================================\n";
522  }
523 
524  return ost.str();
525  }
526 
527  //---------------------------------------------------------------------------
528 
530  {
531  boost::filesystem::ofstream myfile;
532  myfile.open( fileName, std::ios::app );
533 
534  // Declare properties to dump
535  boost::dynamic_properties dp;
536 
537  using boost::make_transform_value_property_map;
538  using boost::apply_visitor;
539  using boost::get;
540  using boost::vertex_bundle;
541 
542  dp.property( "Entity", make_transform_value_property_map(
543  []( const VariantVertexProps& v ) { return boost::lexical_cast<std::string>( v ); },
544  get( vertex_bundle, m_PRGraph ) ) );
545 
546  auto nameVis = precedence::VertexName();
547  dp.property( "Name", make_transform_value_property_map(
548  [&nameVis]( const VariantVertexProps& v ) { return apply_visitor( nameVis, v ); },
549  get( vertex_bundle, m_PRGraph ) ) );
550 
551  auto gMVis = precedence::GroupMode();
552  dp.property( "Mode", make_transform_value_property_map(
553  [&gMVis]( const VariantVertexProps& v ) { return apply_visitor( gMVis, v ); },
554  get( vertex_bundle, m_PRGraph ) ) );
555 
556  auto gLVis = precedence::GroupLogic();
557  dp.property( "Logic", make_transform_value_property_map(
558  [&gLVis]( const VariantVertexProps& v ) { return apply_visitor( gLVis, v ); },
559  get( vertex_bundle, m_PRGraph ) ) );
560 
561  auto dNVis = precedence::DecisionNegation();
562  dp.property( "Decision Negation", make_transform_value_property_map(
563  [&dNVis]( const VariantVertexProps& v ) { return apply_visitor( dNVis, v ); },
564  get( vertex_bundle, m_PRGraph ) ) );
565 
566  auto aPVis = precedence::AllPass();
567  dp.property( "Negative Decision Inversion",
568  make_transform_value_property_map(
569  [&aPVis]( const VariantVertexProps& v ) { return apply_visitor( aPVis, v ); },
570  get( vertex_bundle, m_PRGraph ) ) );
571 
572  auto gEVis = precedence::GroupExit();
573  dp.property( "Exit Policy", make_transform_value_property_map(
574  [&gEVis]( const VariantVertexProps& v ) { return apply_visitor( gEVis, v ); },
575  get( vertex_bundle, m_PRGraph ) ) );
576 
577  auto opVis = precedence::Operations();
578  dp.property( "Operations", make_transform_value_property_map(
579  [&opVis]( const VariantVertexProps& v ) { return apply_visitor( opVis, v ); },
580  get( vertex_bundle, m_PRGraph ) ) );
581 
582  auto cFDVis = precedence::CFDecision( slot );
583  dp.property( "CF Decision", make_transform_value_property_map(
584  [&cFDVis]( const VariantVertexProps& v ) { return apply_visitor( cFDVis, v ); },
585  get( vertex_bundle, m_PRGraph ) ) );
586 
587  auto stVis = precedence::EntityState( slot, serviceLocator(), m_conditionsRealmEnabled );
588  dp.property( "State", make_transform_value_property_map(
589  [&stVis]( const VariantVertexProps& v ) { return apply_visitor( stVis, v ); },
590  get( vertex_bundle, m_PRGraph ) ) );
591 
592  auto sTVis = precedence::StartTime( slot, serviceLocator() );
593  dp.property( "Start Time (Epoch ns)",
594  make_transform_value_property_map(
595  [&sTVis]( const VariantVertexProps& v ) { return apply_visitor( sTVis, v ); },
596  get( vertex_bundle, m_PRGraph ) ) );
597 
598  auto eTVis = precedence::EndTime( slot, serviceLocator() );
599  dp.property( "End Time (Epoch ns)",
600  make_transform_value_property_map(
601  [&eTVis]( const VariantVertexProps& v ) { return apply_visitor( eTVis, v ); },
602  get( vertex_bundle, m_PRGraph ) ) );
603 
604  auto durVis = precedence::Duration( slot, serviceLocator() );
605  dp.property( "Runtime (ns)", make_transform_value_property_map(
606  [&durVis]( const VariantVertexProps& v ) { return apply_visitor( durVis, v ); },
607  get( vertex_bundle, m_PRGraph ) ) );
608 
609  boost::write_graphml( myfile, m_PRGraph, dp );
610 
611  myfile.close();
612  }
613 
614  //---------------------------------------------------------------------------
616  {
617  boost::filesystem::ofstream myfile;
618  myfile.open( fileName, std::ios::app );
619 
620  // Fill runtimes (as this could not be done on the fly during trace assembling)
621  SmartIF<ITimelineSvc> timelineSvc = m_svcLocator->service<ITimelineSvc>( "TimelineSvc", false );
622  if ( !timelineSvc.isValid() ) {
623  warning() << "Failed to get the TimelineSvc, timing will not be added to "
624  << "the task precedence trace dump" << endmsg;
625  } else {
626 
627  typedef boost::graph_traits<precedence::PRGraph>::vertex_iterator vertex_iter;
629  for ( vp = vertices( m_precTrace ); vp.first != vp.second; ++vp.first ) {
630  TimelineEvent te{};
631  te.algorithm = m_precTrace[*vp.first].m_name;
632  timelineSvc->getTimelineEvent( te );
633  int runtime = std::chrono::duration_cast<std::chrono::nanoseconds>( te.end - te.start ).count();
634  m_precTrace[*vp.first].m_runtime = runtime;
635  }
636  }
637 
638  // Declare properties to dump
639  boost::dynamic_properties dp;
640  using boost::get;
642  dp.property( "Name", get( &AlgoTraceProps::m_name, m_precTrace ) );
643  dp.property( "Rank", get( &AlgoTraceProps::m_rank, m_precTrace ) );
644  dp.property( "Runtime", get( &AlgoTraceProps::m_runtime, m_precTrace ) );
645 
646  boost::write_graphml( myfile, m_precTrace, dp );
647 
648  myfile.close();
649  }
650 
652  {
653 
654  std::string u_name = u == nullptr ? "ENTRY" : u->getNodeName();
655  std::string v_name = v->getNodeName();
656 
658 
659  if ( u == nullptr ) {
660  auto itT = m_prec_trace_map.find( "ENTRY" );
661  if ( itT != m_prec_trace_map.end() ) {
662  source = itT->second;
663  } else {
664  source = boost::add_vertex( precedence::AlgoTraceProps( "ENTRY", -1, -1, -1.0 ), m_precTrace );
665  m_prec_trace_map["ENTRY"] = source;
666  }
667  } else {
668  auto itS = m_prec_trace_map.find( u_name );
669  if ( itS != m_prec_trace_map.end() ) {
670  source = itS->second;
671  } else {
672 
673  source =
674  boost::add_vertex( precedence::AlgoTraceProps( u_name, u->getAlgoIndex(), u->getRank(), -1 ), m_precTrace );
675  m_prec_trace_map[u_name] = source;
676  }
677  }
678 
680 
681  auto itP = m_prec_trace_map.find( v_name );
682  if ( itP != m_prec_trace_map.end() ) {
683  target = itP->second;
684  } else {
685 
686  target =
687  boost::add_vertex( precedence::AlgoTraceProps( v_name, v->getAlgoIndex(), v->getRank(), -1 ), m_precTrace );
688  m_prec_trace_map[v_name] = target;
689  }
690 
691  boost::add_edge( source, target, m_precTrace );
692 
693  ON_DEBUG debug() << u_name << "-->" << v_name << " precedence trait added" << endmsg;
694  }
695 
696 } // 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:79
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.