| The Gaudi Framework v30r0 (c919700c)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

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
7 #include "GaudiKernel/DataHandleHolderVisitor.h"
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 //---------------------------------------------------------------------------
28 DecisionNode::~DecisionNode()
29 {
30
31 for ( auto node : m_children ) delete node;
32 }
33
34 //---------------------------------------------------------------------------
35 void DecisionNode::addParentNode( DecisionNode* node )
36 {
37
38 if ( std::find( m_parents.begin(), m_parents.end(), node ) == m_parents.end() ) m_parents.push_back( node );
39 }
40
41 //--------------------------------------------------------------------------
42 void DecisionNode::addDaughterNode( ControlFlowNode* node )
43 {
44
45 if ( std::find( m_children.begin(), m_children.end(), node ) == m_children.end() ) m_children.push_back( node );
46 }
47
48 //---------------------------------------------------------------------------
49 void DecisionNode::printState( std::stringstream& output, AlgsExecutionStates& states,
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 //---------------------------------------------------------------------------
61 bool DecisionNode::accept( IGraphVisitor& visitor )
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 //---------------------------------------------------------------------------
90 AlgorithmNode::~AlgorithmNode()
91 {
92
93 for ( auto node : m_outputs ) {
94 delete node;
95 }
96 }
97
98 //---------------------------------------------------------------------------
99 void AlgorithmNode::printState( std::stringstream& output, AlgsExecutionStates& states,
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 //---------------------------------------------------------------------------
109 bool AlgorithmNode::accept( IGraphVisitor& visitor )
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 //---------------------------------------------------------------------------
121 void AlgorithmNode::addParentNode( DecisionNode* node )
122 {
123
124 if ( std::find( m_parents.begin(), m_parents.end(), node ) == m_parents.end() ) m_parents.push_back( node );
125 }
126
127 //---------------------------------------------------------------------------
128 void AlgorithmNode::addOutputDataNode( DataNode* node )
129 {
130
131 if ( std::find( m_outputs.begin(), m_outputs.end(), node ) == m_outputs.end() ) m_outputs.push_back( node );
132 }
133
134 //---------------------------------------------------------------------------
135 void AlgorithmNode::addInputDataNode( DataNode* node )
136 {
137
138 if ( std::find( m_inputs.begin(), m_inputs.end(), node ) == m_inputs.end() ) m_inputs.push_back( node );
139 }
140
141 //---------------------------------------------------------------------------
142 StatusCode PrecedenceRulesGraph::initialize()
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 //---------------------------------------------------------------------------
187 void PrecedenceRulesGraph::registerIODataObjects( const Algorithm* algo )
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 //---------------------------------------------------------------------------
208 StatusCode PrecedenceRulesGraph::buildDataDependenciesRealm()
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
264 StatusCode sc = StatusCode::SUCCESS;
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 //---------------------------------------------------------------------------
305 AlgorithmNode* PrecedenceRulesGraph::getAlgorithmNode( const std::string& algoName ) const
306 {
307
308 return m_algoNameToAlgoNodeMap.at( algoName );
309 }
310
311 //---------------------------------------------------------------------------
312 StatusCode PrecedenceRulesGraph::addDataNode( const DataObjID& dataPath )
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 //---------------------------------------------------------------------------
352 DataNode* PrecedenceRulesGraph::getDataNode( const DataObjID& dataPath ) const
353 {
354
355 return m_dataPathToDataNodeMap.at( dataPath );
356 }
357
358 //---------------------------------------------------------------------------
359 StatusCode PrecedenceRulesGraph::addDecisionHubNode( Algorithm* decisionHubAlgo, const std::string& parentName,
360 Concurrent modeConcurrent, PromptDecision modePromptDecision,
361 ModeOr modeOR, AllPass allPass, Inverted isInverted )
362 {
363
364 StatusCode sc = StatusCode::SUCCESS;
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 //---------------------------------------------------------------------------
405 void PrecedenceRulesGraph::addHeadNode( const std::string& headName, concurrency::Concurrent modeConcurrent,
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 //---------------------------------------------------------------------------
430 PRVertexDesc PrecedenceRulesGraph::node( const std::string& name ) const
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 //---------------------------------------------------------------------------
453 void PrecedenceRulesGraph::rankAlgorithms( IGraphVisitor& ranker ) const
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
464 std::string PrecedenceRulesGraph::dumpControlFlow() const
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 //---------------------------------------------------------------------------
501 std::string PrecedenceRulesGraph::dumpDataFlow() const
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
529 void PrecedenceRulesGraph::dumpPrecRules( const boost::filesystem::path& fileName, const EventSlot& slot )
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 //---------------------------------------------------------------------------
615 void PrecedenceRulesGraph::dumpPrecTrace( const boost::filesystem::path& fileName )
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;
628 std::pair<vertex_iter, vertex_iter> vp;
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;
641 using precedence::AlgoTraceProps;
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
651 void PrecedenceRulesGraph::addEdgeToPrecTrace( const AlgorithmNode* u, const AlgorithmNode* v )
652 {
653
654 std::string u_name = u == nullptr ? "ENTRY" : u->getNodeName();
655 std::string v_name = v->getNodeName();
656
657 precedence::AlgoTraceVertex source;
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
679 precedence::AlgoTraceVertex target;
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
StatusCode::SUCCESS
Definition: StatusCode.h:29
concurrency::PrecedenceRulesGraph::node
PRVertexDesc node(const std::string &) const
Definition: PrecedenceRulesGraph.cpp:430
std::chrono::nanoseconds
concurrency::AlgorithmNode::getAlgoIndex
const unsigned int & getAlgoIndex() const
Get algorithm index.
Definition: PrecedenceRulesGraph.h:573
precedence::CFDecision
Definition: PrecedenceRulesGraph.h:183
SmartIF< ICondSvc >
precedence::GroupMode
Definition: PrecedenceRulesGraph.h:137
PRGraphVisitors.h
concurrency::DecisionNode
Definition: PrecedenceRulesGraph.h:478
precedence::Duration
Definition: PrecedenceRulesGraph.h:365
concurrency::PrecedenceRulesGraph::addAlgorithmNode
StatusCode addAlgorithmNode(Algorithm *daughterAlgo, const std::string &parentName, bool inverted, bool allPass)
Add algorithm node.
Definition: PrecedenceRulesGraph.cpp:260
Algorithm::name
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:737
GaudiPython.HistoUtils.path
path
Definition: HistoUtils.py:895
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
concurrency::DecisionNode::addDaughterNode
void addDaughterNode(ControlFlowNode *node)
Add a daughter node.
Definition: PrecedenceRulesGraph.cpp:42
precedence::AlgoTraceVertex
boost::graph_traits< PrecTrace >::vertex_descriptor AlgoTraceVertex
Definition: PrecedenceRulesGraph.h:56
DataObjID
Definition: DataObjID.h:37
concurrency::DataNode
Definition: PrecedenceRulesGraph.h:616
precedence::PRVertexDesc
boost::graph_traits< PRGraph >::vertex_descriptor PRVertexDesc
Definition: PrecedenceRulesGraph.h:422
gaudirun.output
output
Definition: gaudirun.py:404
concurrency
Definition: IGraphVisitor.h:4
DataHandleHolderBase::outputDataObjs
const DataObjIDColl & outputDataObjs() const override
Definition: DataHandleHolderBase.h:62
StatusCode::isSuccess
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
concurrency::IGraphVisitor::visit
virtual bool visit(DecisionNode &)
Definition: IGraphVisitor.h:18
precedence::AlgoProps
Definition: PrecedenceRulesGraph.h:59
concurrency::PrecedenceRulesGraph::dumpPrecRules
void dumpPrecRules(const boost::filesystem::path &, const EventSlot &slot)
dump to file the precedence rules
Definition: PrecedenceRulesGraph.cpp:529
std::endl
T endl(T...args)
concurrency::AlgorithmNode::m_parents
std::vector< DecisionNode * > m_parents
Control flow parents of an AlgorithmNode (DecisionNodes)
Definition: PrecedenceRulesGraph.h:591
concurrency::ControlFlowNode
Definition: PrecedenceRulesGraph.h:447
TimelineEvent::algorithm
std::string algorithm
Definition: ITimelineSvc.h:18
precedence::AlgoTraceProps
Definition: PrecedenceRulesGraph.h:42
concurrency::ControlFlowNode::stateToString
std::string stateToString(const int &stateId) const
Translation between state id and name.
Definition: PrecedenceRulesGraph.cpp:16
std::chrono::duration_cast
T duration_cast(T...args)
std::vector::end
T end(T...args)
concurrency::PrecedenceRulesGraph::addDataNode
StatusCode addDataNode(const DataObjID &dataPath)
Add DataNode that represents DataObject.
Definition: PrecedenceRulesGraph.cpp:312
concurrency::PrecedenceRulesGraph::getAlgorithmNode
AlgorithmNode * getAlgorithmNode(const std::string &algoName) const
Get the AlgorithmNode from by algorithm name using graph index.
Definition: PrecedenceRulesGraph.cpp:305
concurrency::PrecedenceRulesGraph::rankAlgorithms
void rankAlgorithms(IGraphVisitor &ranker) const
Rank Algorithm nodes by the number of data outputs.
Definition: PrecedenceRulesGraph.cpp:453
ON_DEBUG
#define ON_DEBUG
Definition: PrecedenceRulesGraph.cpp:9
concurrency::DecisionNode::m_allPass
bool m_allPass
Whether always passing regardless of daughter results.
Definition: PrecedenceRulesGraph.h:519
concurrency::AlgorithmNode::getParentDecisionHubs
const std::vector< DecisionNode * > & getParentDecisionHubs() const
Get all parent decision hubs.
Definition: PrecedenceRulesGraph.h:554
concurrency::AlgorithmNode::~AlgorithmNode
~AlgorithmNode()
Destructor.
Definition: PrecedenceRulesGraph.cpp:90
TimelineEvent
Definition: ITimelineSvc.h:13
std::remove
T remove(T...args)
std::stringstream
STL class.
concurrency::ModeOr
Gaudi::tagged_bool< class ModeOr_tag > ModeOr
Definition: PrecedenceRulesGraph.h:32
concurrency::IGraphVisitor::visitEnter
virtual bool visitEnter(DecisionNode &) const
Definition: IGraphVisitor.h:17
std::string
STL class.
concurrency::AlgorithmNode::getAlgorithm
Algorithm * getAlgorithm() const
get Algorithm representatives
Definition: PrecedenceRulesGraph.h:571
ITimelineSvc::getTimelineEvent
virtual void getTimelineEvent(TimelineEvent &) const =0
concurrency::DecisionNode::m_modeOR
bool m_modeOR
Whether acting as "and" (false) or "or" node (true)
Definition: PrecedenceRulesGraph.h:517
concurrency::AlgorithmNode::addInputDataNode
void addInputDataNode(DataNode *node)
Associate an AlgorithmNode, which is a data consumer of this one.
Definition: PrecedenceRulesGraph.cpp:135
concurrency::DecisionNode::accept
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
Definition: PrecedenceRulesGraph.cpp:61
concurrency::PrecedenceRulesGraph::initialize
StatusCode initialize()
Initialize graph.
Definition: PrecedenceRulesGraph.cpp:142
concurrency::PrecedenceRulesGraph::dumpPrecTrace
void dumpPrecTrace(const boost::filesystem::path &)
dump to file the precedence trace
Definition: PrecedenceRulesGraph.cpp:615
concurrency::AlgorithmNode::getRank
const float & getRank() const
Get Algorithm rank.
Definition: PrecedenceRulesGraph.h:568
precedence::GroupExit
Definition: PrecedenceRulesGraph.h:156
AlgsExecutionStates
The AlgsExecutionStates encodes the state machine for the execution of algorithms within a single eve...
Definition: AlgsExecutionStates.h:28
ICondSvc::condAlgs
virtual const std::set< IAlgorithm * > & condAlgs() const =0
get list of all registered condition Algorithms
concurrency::Inverted
Gaudi::tagged_bool< class Inverted_tag > Inverted
Definition: PrecedenceRulesGraph.h:34
concurrency::ControlFlowNode::m_nodeIndex
unsigned int m_nodeIndex
Definition: PrecedenceRulesGraph.h:474
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
DataHandleHolderBase::inputDataObjs
const DataObjIDColl & inputDataObjs() const override
Definition: DataHandleHolderBase.h:61
std::ostringstream
STL class.
concurrency::PrecedenceRulesGraph::dumpDataFlow
std::string dumpDataFlow() const
Print out all data origins and destinations, as reflected in the EF graph.
Definition: PrecedenceRulesGraph.cpp:501
concurrency::DecisionNode::getDaughters
const std::vector< ControlFlowNode * > & getDaughters() const
Get children nodes.
Definition: PrecedenceRulesGraph.h:505
precedence::EndTime
Definition: PrecedenceRulesGraph.h:324
std::ostringstream::str
T str(T...args)
concurrency::IGraphVisitor
Definition: IGraphVisitor.h:12
concurrency::PrecedenceRulesGraph::accept
void accept(const std::string &algo_name, IGraphVisitor &visitor) const
A method to update algorithm node decision, and propagate it upwards.
Definition: PrecedenceRulesGraph.cpp:447
DataHandleHolderVisitor.h
ITimelineSvc
Definition: ITimelineSvc.h:24
precedence::VertexName
Definition: PrecedenceRulesGraph.h:129
concurrency::PrecedenceRulesGraph::getDataNode
DataNode * getDataNode(const DataObjID &dataPath) const
Get DataNode by DataObject path using graph index.
Definition: PrecedenceRulesGraph.cpp:352
concurrency::Concurrent
Gaudi::tagged_bool< class Concurrent_tag > Concurrent
Definition: PrecedenceRulesGraph.h:30
concurrency::DecisionNode::m_modePromptDecision
bool m_modePromptDecision
Whether to evaluate the hub decision ASA its child decisions allow to do that.
Definition: PrecedenceRulesGraph.h:515
precedence::EntityState
Definition: PrecedenceRulesGraph.h:201
std::pair
concurrency::PrecedenceRulesGraph::addEdgeToPrecTrace
void addEdgeToPrecTrace(const AlgorithmNode *u, const AlgorithmNode *v)
set cause-effect connection between two algorithms in the precedence trace
Definition: PrecedenceRulesGraph.cpp:651
concurrency::ControlFlowNode::m_nodeName
std::string m_nodeName
Definition: PrecedenceRulesGraph.h:475
precedence::StartTime
Definition: PrecedenceRulesGraph.h:282
concurrency::AlgorithmNode::addOutputDataNode
void addOutputDataNode(DataNode *node)
Associate an AlgorithmNode, which is a data supplier for this one.
Definition: PrecedenceRulesGraph.cpp:128
Algorithm
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:79
std::find
T find(T...args)
Gaudi::Functional::m_inputs
std::vector< InputHandle_t< In > > m_inputs
Definition: MergingTransformer.h:45
std::vector< int >
GaudiPython.Persistency.get
def get(type_)
Definition: Persistency.py:29
precedence::DecisionNegation
Definition: PrecedenceRulesGraph.h:167
concurrency::PromptDecision
Gaudi::tagged_bool< class PromptDecision_tag > PromptDecision
Definition: PrecedenceRulesGraph.h:31
concurrency::DecisionNode::addParentNode
void addParentNode(DecisionNode *node)
Add a parent node.
Definition: PrecedenceRulesGraph.cpp:35
SmartIF::isValid
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:68
std::vector::begin
T begin(T...args)
genconfuser.verbose
verbose
Definition: genconfuser.py:19
concurrency::PrecedenceRulesGraph::registerIODataObjects
void registerIODataObjects(const Algorithm *algo)
Register algorithm in the Data Dependency index.
Definition: PrecedenceRulesGraph.cpp:187
concurrency::DecisionNode::m_modeConcurrent
bool m_modeConcurrent
Whether all daughters will be evaluated concurrently or sequentially.
Definition: PrecedenceRulesGraph.h:512
precedence::CondDataProps
Definition: PrecedenceRulesGraph.h:123
concurrency::PrecedenceRulesGraph::addDecisionHubNode
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.
Definition: PrecedenceRulesGraph.cpp:359
precedence::Operations
Definition: PrecedenceRulesGraph.h:405
concurrency::DecisionNode::printState
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.
Definition: PrecedenceRulesGraph.cpp:49
concurrency::ConditionNode
Definition: PrecedenceRulesGraph.h:659
EventSlot
Class representing the event slot.
Definition: EventSlot.h:10
concurrency::AllPass
Gaudi::tagged_bool< class AllPass_tag > AllPass
Definition: PrecedenceRulesGraph.h:33
concurrency::AlgorithmNode
Definition: PrecedenceRulesGraph.h:531
concurrency::AlgorithmNode::addParentNode
void addParentNode(DecisionNode *node)
Add a parent node.
Definition: PrecedenceRulesGraph.cpp:121
concurrency::AlgorithmNode::accept
bool accept(IGraphVisitor &visitor) override
Visitor entry point.
Definition: PrecedenceRulesGraph.cpp:109
precedence::GroupLogic
Definition: PrecedenceRulesGraph.h:148
concurrency::ControlFlowNode::getNodeName
const std::string & getNodeName() const
Get node name.
Definition: PrecedenceRulesGraph.h:466
ON_VERBOSE
#define ON_VERBOSE
Definition: PrecedenceRulesGraph.cpp:10
StatusCode::FAILURE
Definition: StatusCode.h:29
concurrency::AlgorithmNode::printState
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.
Definition: PrecedenceRulesGraph.cpp:99
concurrency::PrecedenceRulesGraph::buildDataDependenciesRealm
StatusCode buildDataDependenciesRealm()
Build data dependency realm WITH data object nodes participating.
Definition: PrecedenceRulesGraph.cpp:208
precedence::DecisionHubProps
Definition: PrecedenceRulesGraph.h:87
concurrency::PrecedenceRulesGraph::dumpControlFlow
std::string dumpControlFlow() const
Print out control flow of Algorithms and Sequences.
Definition: PrecedenceRulesGraph.cpp:464
concurrency::DecisionNode::~DecisionNode
~DecisionNode() override
Destructor.
Definition: PrecedenceRulesGraph.cpp:28
PrecedenceRulesGraph.h
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
concurrency::PrecedenceRulesGraph::addHeadNode
void addHeadNode(const std::string &headName, concurrency::Concurrent, concurrency::PromptDecision, concurrency::ModeOr, concurrency::AllPass, concurrency::Inverted)
Add a node, which has no parents.
Definition: PrecedenceRulesGraph.cpp:405
AlgsExecutionStates::stateNames
static std::map< State, std::string > stateNames
Definition: AlgsExecutionStates.h:42
precedence::VariantVertexProps
boost::variant< AlgoProps, DecisionHubProps, DataProps, CondDataProps > VariantVertexProps
Definition: PrecedenceRulesGraph.h:420
precedence::DataProps
Definition: PrecedenceRulesGraph.h:117
concurrency::DataNode::addConsumerNode
void addConsumerNode(AlgorithmNode *node)
Add relationship to consumer AlgorithmNode.
Definition: PrecedenceRulesGraph.h:640