#include <src/ControlFlowGraph.h>

Inheritance diagram for concurrency::recursive_CF::ControlFlowGraph:

Collaboration diagram for concurrency::recursive_CF::ControlFlowGraph:

[legend]

Public Member Functions
	ControlFlowGraph (const std::string &name, SmartIF< ISvcLocator > svc)
	Constructor. More...

	~ControlFlowGraph () override
	Destructor. More...

void	initialize (const std::unordered_map< std::string, unsigned int > &algname_index_map)
	Initialize graph. More...

void	addHeadNode (const std::string &headName, bool modeConcurrent, bool modePromptDecision, bool modeOR, bool allPass)
	Add a node, which has no parents. More...

DecisionNode *	getHeadNode () const
	Get head node. More...

StatusCode	addAlgorithmNode (Algorithm *daughterAlgo, const std::string &parentName, bool inverted, bool allPass)
	Add algorithm node. More...

StatusCode	addDecisionHubNode (Algorithm *daughterAlgo, const std::string &parentName, bool modeConcurrent, bool modePromptDecision, bool modeOR, bool allPass)
	Add a node, which aggregates decisions of direct daughter nodes. More...

unsigned int	getControlFlowNodeCounter () const
	Get total number of graph nodes. More...

void	updateEventState (AlgsExecutionStates &states, std::vector< int > &node_decisions) const
	Start revision of states and decisions. More...

void	printState (std::stringstream &output, AlgsExecutionStates &states, const std::vector< int > &node_decisions, const unsigned int &recursionLevel) const
	Print a string representing the control flow state. More...

const std::string &	name () const override
	Retrieve name of the service. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

std::string	dumpControlFlow () const
	Print out control flow of Algorithms and Sequences. More...

void	dumpControlFlow (std::ostringstream &, ControlFlowNode *, const int &) const

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

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

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

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

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

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

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

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

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

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

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

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

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

MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

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

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

Private Attributes
DecisionNode *	m_headNode {nullptr}
	the head node of the control flow graph; may want to have multiple ones once supporting trigger paths More...

AlgoNodesMap	m_algoNameToAlgoNodeMap
	Index: map of algorithm's name to AlgorithmNode. More...

DecisionHubsMap	m_decisionNameToDecisionHubMap
	Index: map of decision's name to DecisionHub. More...

unsigned int	m_nodeCounter {0}
	Total number of nodes in the graph. More...

unsigned int	m_algoCounter {0}
	Total number of algorithm nodes in the graph. More...

SmartIF< ISvcLocator >	m_svcLocator
	Service locator (needed to access the MessageSvc) More...

const std::string	m_name

Additional Inherited Members
Public Types inherited from CommonMessaging< IControlFlowGraph >
using	base_class = CommonMessaging

Protected Member Functions inherited from CommonMessaging< IControlFlowGraph >
MSG::Level	setUpMessaging ()
	Set up local caches. More...

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

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Detailed Description

Definition at line 144 of file ControlFlowGraph.h.

Constructor & Destructor Documentation

concurrency::recursive_CF::ControlFlowGraph::ControlFlowGraph	(	const std::string &	name,
		SmartIF< ISvcLocator >	svc
	)

inline

Constructor.

Definition at line 148 of file ControlFlowGraph.h.

                                                                           : m_svcLocator( svc ), m_name( name )
       {
         setUpMessaging();
       }

concurrency::recursive_CF::ControlFlowGraph::~ControlFlowGraph ( )

inlineoverride

Destructor.

Definition at line 153 of file ControlFlowGraph.h.

       {
         if ( m_headNode != 0 ) delete m_headNode;
       }

Member Function Documentation

StatusCode concurrency::recursive_CF::ControlFlowGraph::addAlgorithmNode	(	Algorithm *	daughterAlgo,
		const std::string &	parentName,
		bool	inverted,
		bool	allPass
	)

Add algorithm node.

Definition at line 146 of file ControlFlowGraph.cpp.

     {
 
       StatusCode sc = StatusCode::SUCCESS;
 
       auto& algoName = algo->name();
 
       auto itP = m_decisionNameToDecisionHubMap.find( parentName );
       concurrency::recursive_CF::DecisionNode* parentNode;
       if ( itP != m_decisionNameToDecisionHubMap.end() ) {
         parentNode = itP->second;
         auto itA   = m_algoNameToAlgoNodeMap.find( algoName );
         concurrency::recursive_CF::AlgorithmNode* algoNode;
         if ( itA != m_algoNameToAlgoNodeMap.end() ) {
           algoNode = itA->second;
         } else {
           algoNode = new concurrency::recursive_CF::AlgorithmNode( *this, algo, m_nodeCounter, m_algoCounter, inverted,
                                                                    allPass );
           ++m_nodeCounter;
           ++m_algoCounter;
           m_algoNameToAlgoNodeMap[algoName] = algoNode;
           if ( msgLevel( MSG::VERBOSE ) ) verbose() << "AlgoNode " << algoName << " added @ " << algoNode << endmsg;
         }
 
         parentNode->addDaughterNode( algoNode );
       } else {
         sc = StatusCode::FAILURE;
         error() << "Decision hub node " << parentName << ", requested to be parent, is not registered." << endmsg;
       }
 
       return sc;
     }

StatusCode concurrency::recursive_CF::ControlFlowGraph::addDecisionHubNode	(	Algorithm *	daughterAlgo,
		const std::string &	parentName,
		bool	modeConcurrent,
		bool	modePromptDecision,
		bool	modeOR,
		bool	allPass
	)

Add a node, which aggregates decisions of direct daughter nodes.

Definition at line 181 of file ControlFlowGraph.cpp.

     {
 
       StatusCode sc = StatusCode::SUCCESS;
 
       auto& decisionHubName = decisionHubAlgo->name();
 
       auto itP = m_decisionNameToDecisionHubMap.find( parentName );
       concurrency::recursive_CF::DecisionNode* parentNode;
       if ( itP != m_decisionNameToDecisionHubMap.end() ) {
         parentNode = itP->second;
         auto itA   = m_decisionNameToDecisionHubMap.find( decisionHubName );
         concurrency::recursive_CF::DecisionNode* decisionHubNode;
         if ( itA != m_decisionNameToDecisionHubMap.end() ) {
           decisionHubNode = itA->second;
         } else {
           decisionHubNode = new concurrency::recursive_CF::DecisionNode(
               *this, m_nodeCounter, decisionHubName, modeConcurrent, modePromptDecision, modeOR, allPass );
           ++m_nodeCounter;
           m_decisionNameToDecisionHubMap[decisionHubName] = decisionHubNode;
           if ( msgLevel( MSG::VERBOSE ) )
             verbose() << "Decision hub node " << decisionHubName << " added @ " << decisionHubNode << endmsg;
         }
 
         parentNode->addDaughterNode( decisionHubNode );
       } else {
         sc = StatusCode::FAILURE;
         error() << "Decision hub node " << parentName << ", requested to be parent, is not registered." << endmsg;
       }
 
       return sc;
     }

void concurrency::recursive_CF::ControlFlowGraph::addHeadNode	(	const std::string &	headName,
		bool	modeConcurrent,
		bool	modePromptDecision,
		bool	modeOR,
		bool	allPass
	)

Add a node, which has no parents.

Definition at line 217 of file ControlFlowGraph.cpp.

     {
 
       auto itH = m_decisionNameToDecisionHubMap.find( headName );
       if ( itH != m_decisionNameToDecisionHubMap.end() ) {
         m_headNode = itH->second;
       } else {
         m_headNode = new concurrency::recursive_CF::DecisionNode( *this, m_nodeCounter, headName, modeConcurrent,
                                                                   modePromptDecision, modeOR, allPass );
         ++m_nodeCounter;
         m_decisionNameToDecisionHubMap[headName] = m_headNode;
       }
     }

std::string concurrency::recursive_CF::ControlFlowGraph::dumpControlFlow ( ) const

Print out control flow of Algorithms and Sequences.

Definition at line 239 of file ControlFlowGraph.cpp.

     {
       std::ostringstream ost;
       dumpControlFlow( ost, m_headNode, 0 );
       return ost.str();
     }

void concurrency::recursive_CF::ControlFlowGraph::dumpControlFlow	(	std::ostringstream &	ost,
		ControlFlowNode *	node,
		const int &	indent
	)		const

Definition at line 247 of file ControlFlowGraph.cpp.

     {
       ost << std::string( indent * 2, ' ' );
       DecisionNode* dn  = dynamic_cast<DecisionNode*>( node );
       AlgorithmNode* an = dynamic_cast<AlgorithmNode*>( node );
       if ( dn != 0 ) {
         if ( node != m_headNode ) {
           ost << node->getNodeName() << " [Seq] ";
           ost << ( ( dn->m_modeConcurrent ) ? " [Concurrent] " : " [Sequential] " );
           ost << ( ( dn->m_modePromptDecision ) ? " [Prompt] " : "" );
           ost << ( ( dn->m_modeOR ) ? " [OR] " : "" );
           ost << ( ( dn->m_allPass ) ? " [PASS] " : "" );
           ost << "\n";
         }
         const std::vector<ControlFlowNode*>& dth = dn->getDaughters();
         for ( std::vector<ControlFlowNode*>::const_iterator itr = dth.begin(); itr != dth.end(); ++itr ) {
           dumpControlFlow( ost, *itr, indent + 1 );
         }
       } else if ( an != 0 ) {
         ost << node->getNodeName() << " [Alg] ";
         if ( an != 0 ) {
           auto ar = an->getAlgorithm();
           ost << " [n= " << ar->cardinality() << "]";
           ost << ( ( !ar->isClonable() ) ? " [unclonable] " : "" );
         }
         ost << "\n";
       }
     }

unsigned int concurrency::recursive_CF::ControlFlowGraph::getControlFlowNodeCounter ( ) const

inline

Get total number of graph nodes.

Definition at line 172 of file ControlFlowGraph.h.

172 { return m_nodeCounter; }

concurrency::recursive_CF::ControlFlowGraph::m_nodeCounter

unsigned int m_nodeCounter

Total number of nodes in the graph.

Definition: ControlFlowGraph.h:198

DecisionNode* concurrency::recursive_CF::ControlFlowGraph::getHeadNode ( ) const

inline

Get head node.

Definition at line 164 of file ControlFlowGraph.h.

164 { return m_headNode; };

concurrency::recursive_CF::ControlFlowGraph::m_headNode

DecisionNode * m_headNode

the head node of the control flow graph; may want to have multiple ones once supporting trigger paths...

Definition: ControlFlowGraph.h:192

void concurrency::recursive_CF::ControlFlowGraph::initialize ( const std::unordered_map< std::string, unsigned int > & algname_index_map )

Initialize graph.

Definition at line 140 of file ControlFlowGraph.cpp.

     {
       m_headNode->initialize( algname_index_map );
     }

const std::string& concurrency::recursive_CF::ControlFlowGraph::name ( ) const

inlineoverride

Retrieve name of the service.

Definition at line 182 of file ControlFlowGraph.h.

182 { return m_name; }

concurrency::recursive_CF::ControlFlowGraph::m_name

const std::string m_name

Definition: ControlFlowGraph.h:203

void concurrency::recursive_CF::ControlFlowGraph::printState	(	std::stringstream &	output,
		AlgsExecutionStates &	states,
		const std::vector< int > &	node_decisions,
		const unsigned int &	recursionLevel
	)		const

inline

Print a string representing the control flow state.

Definition at line 176 of file ControlFlowGraph.h.

       {
         m_headNode->printState( output, states, node_decisions, recursionLevel );
       }

SmartIF<ISvcLocator>& concurrency::recursive_CF::ControlFlowGraph::serviceLocator ( ) const

inlineoverride

Retrieve pointer to service locator.

Definition at line 184 of file ControlFlowGraph.h.

184 { return m_svcLocator; }

concurrency::recursive_CF::ControlFlowGraph::m_svcLocator

SmartIF< ISvcLocator > m_svcLocator

Service locator (needed to access the MessageSvc)

Definition: ControlFlowGraph.h:202

void concurrency::recursive_CF::ControlFlowGraph::updateEventState	(	AlgsExecutionStates &	states,
		std::vector< int > &	node_decisions
	)		const

Start revision of states and decisions.

Definition at line 233 of file ControlFlowGraph.cpp.

     {
       m_headNode->updateState( algo_states, node_decisions );
     }

Member Data Documentation

unsigned int concurrency::recursive_CF::ControlFlowGraph::m_algoCounter {0}

private

Total number of algorithm nodes in the graph.

Definition at line 200 of file ControlFlowGraph.h.

AlgoNodesMap concurrency::recursive_CF::ControlFlowGraph::m_algoNameToAlgoNodeMap

private

Index: map of algorithm's name to AlgorithmNode.

Definition at line 194 of file ControlFlowGraph.h.

DecisionHubsMap concurrency::recursive_CF::ControlFlowGraph::m_decisionNameToDecisionHubMap

private

Index: map of decision's name to DecisionHub.

Definition at line 196 of file ControlFlowGraph.h.

DecisionNode* concurrency::recursive_CF::ControlFlowGraph::m_headNode {nullptr}

private

the head node of the control flow graph; may want to have multiple ones once supporting trigger paths

Definition at line 192 of file ControlFlowGraph.h.

const std::string concurrency::recursive_CF::ControlFlowGraph::m_name

private

Definition at line 203 of file ControlFlowGraph.h.

unsigned int concurrency::recursive_CF::ControlFlowGraph::m_nodeCounter {0}

private

Total number of nodes in the graph.

Definition at line 198 of file ControlFlowGraph.h.

SmartIF<ISvcLocator> concurrency::recursive_CF::ControlFlowGraph::m_svcLocator

mutableprivate

Service locator (needed to access the MessageSvc)

Definition at line 202 of file ControlFlowGraph.h.

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

GaudiHive/src/ControlFlowGraph.h
GaudiHive/src/ControlFlowGraph.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation