concurrency::PrecedenceRulesGraph Class Reference

#include <src/PrecedenceRulesGraph.h>

Inheritance diagram for concurrency::PrecedenceRulesGraph:

Collaboration diagram for concurrency::PrecedenceRulesGraph:

Public Member Functions
	PrecedenceRulesGraph (const std::string &name, SmartIF< ISvcLocator > svc)
	Constructor. More...
	~PrecedenceRulesGraph () override
	Destructor. More...
StatusCode	initialize ()
	Initialize graph. More...
void	accept (const std::string &algo_name, IGraphVisitor &visitor) const
	A method to update algorithm node decision, and propagate it upwards. More...
StatusCode	addDataNode (const DataObjID &dataPath)
	Add DataNode that represents DataObject. More...
DataNode *	getDataNode (const DataObjID &dataPath) const
	Get DataNode by DataObject path using graph index. More...
void	registerIODataObjects (const Algorithm *algo)
	Register algorithm in the Data Dependency index. More...
StatusCode	buildDataDependenciesRealm ()
	Build data dependency realm WITH data object nodes participating. 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...
AlgorithmNode *	getAlgorithmNode (const std::string &algoName) const
	Get the AlgorithmNode from by algorithm name using graph index. 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 control flow graph nodes. More...
void	rankAlgorithms (IGraphVisitor &ranker) const
	Rank Algorithm nodes by the number of data outputs. More...
const std::string &	name () const override
	Retrieve name of the service. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
const std::chrono::system_clock::time_point	getInitTime () const
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...
PRVertexDesc	node (const std::string &) const
	BGL-based facilities. More...
std::string	dumpDataFlow () const
	Print out all data origins and destinations, as reflected in the EF graph. More...
std::string	dumpControlFlow () const
	Print out control flow of Algorithms and Sequences. More...
void	dumpPrecRules (const boost::filesystem::path &, const EventSlot &slot)
	dump to file the precedence rules More...
void	dumpPrecTrace (const boost::filesystem::path &)
	dump to file the precedence trace More...
void	addEdgeToPrecTrace (const AlgorithmNode *u, const AlgorithmNode *v)
	set cause-effect connection between two algorithms in the precedence trace More...
void	dumpControlFlow (std::ostringstream &, ControlFlowNode *, const int &) const
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
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 output level 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
	the head node of the control flow graph 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...
DataNodesMap	m_dataPathToDataNodeMap
	Index: map of data path to DataNode. More...
AlgoInputsMap	m_algoNameToAlgoInputsMap
	Indexes: maps of algorithm's name to algorithm's inputs/outputs. More...
AlgoOutputsMap	m_algoNameToAlgoOutputsMap
unsigned int	m_nodeCounter
	Total number of nodes in the graph. More...
unsigned int	m_algoCounter
	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
const std::chrono::system_clock::time_point	m_initTime
precedence::PrecTrace	m_precTrace
	facilities for algorithm precedence tracing More...
std::map< std::string, precedence::AlgoTraceVertex >	m_prec_trace_map
precedence::PRGraph	m_PRGraph
	BGL-based graph of precedence rules. More...
bool	m_conditionsRealmEnabled {false}
	Enable conditions realm of precedence rules. More...

Additional Inherited Members
Public Types inherited from CommonMessaging< IPrecedenceRulesGraph >
using	base_class = CommonMessaging
Protected Member Functions inherited from CommonMessaging< IPrecedenceRulesGraph >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Detailed Description

Definition at line 573 of file PrecedenceRulesGraph.h.

Constructor & Destructor Documentation

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

inline

Constructor.

Definition at line 577 of file PrecedenceRulesGraph.h.

        : m_headNode( 0 )
        , m_nodeCounter( 0 )
        , m_algoCounter( 0 )
        , m_svcLocator( svc )
        , m_name( name )
        , m_initTime( std::chrono::system_clock::now() )
    {
    }

concurrency::PrecedenceRulesGraph::~PrecedenceRulesGraph ( )

inlineoverride

Destructor.

Definition at line 587 of file PrecedenceRulesGraph.h.

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

Member Function Documentation

void concurrency::PrecedenceRulesGraph::accept	(	const std::string &	algo_name,
		IGraphVisitor &	visitor
	)		const

A method to update algorithm node decision, and propagate it upwards.

Definition at line 442 of file PrecedenceRulesGraph.cpp.

  {
    getAlgorithmNode( algo_name )->accept( visitor );
  }

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

Add algorithm node.

Definition at line 258 of file PrecedenceRulesGraph.cpp.

  {

    StatusCode sc = StatusCode::SUCCESS;

    // Create new, or fetch existent, AlgorithmNode
    auto& algoName = algo->name();
    auto itA       = m_algoNameToAlgoNodeMap.find( algoName );
    concurrency::AlgorithmNode* algoNode;
    if ( itA != m_algoNameToAlgoNodeMap.end() ) {
      algoNode = itA->second;
    } else {
      algoNode = new concurrency::AlgorithmNode( *this, algo, m_nodeCounter, m_algoCounter, inverted, allPass );
      ON_DEBUG
      { // Mirror the action above in the BGL-based graph
        auto source =
            boost::add_vertex( AlgoProps( algo, m_nodeCounter, m_algoCounter, inverted, allPass ), m_PRGraph );
        boost::add_edge( source, node( parentName ), m_PRGraph );
      }
      ++m_nodeCounter;
      ++m_algoCounter;
      m_algoNameToAlgoNodeMap[algoName] = algoNode;
      ON_VERBOSE verbose() << "AlgoNode " << algoName << " added @ " << algoNode << endmsg;
      registerIODataObjects( algo );
    }

    // Attach AlgorithmNode to its CF decision hub
    auto itP = m_decisionNameToDecisionHubMap.find( parentName );
    if ( itP != m_decisionNameToDecisionHubMap.end() ) {
      auto parentNode = itP->second;
      ON_VERBOSE verbose() << "Attaching AlgorithmNode '" << algo->name() << "' to DecisionNode '" << parentName << "'"
                           << endmsg;

      parentNode->addDaughterNode( algoNode );
      algoNode->addParentNode( parentNode );
    } else {
      sc = StatusCode::FAILURE;
      error() << "Requested DecisionNode '" << parentName << "' was not found" << endmsg;
    }

    return sc;
  }

StatusCode concurrency::PrecedenceRulesGraph::addDataNode

(

const DataObjID &

dataPath

)

Add DataNode that represents DataObject.

Definition at line 310 of file PrecedenceRulesGraph.cpp.

  {

    StatusCode sc;

    auto itD = m_dataPathToDataNodeMap.find( dataPath );
    concurrency::DataNode* dataNode;
    if ( itD != m_dataPathToDataNodeMap.end() ) {
      dataNode = itD->second;
      sc       = StatusCode::SUCCESS;
    } else {
      if ( !m_conditionsRealmEnabled ) {
        dataNode = new concurrency::DataNode( *this, dataPath );
        ON_VERBOSE verbose() << "  DataNode for " << dataPath << " added @ " << dataNode << endmsg;
      } else {
        SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc", false )};
        if ( condSvc->isRegistered( dataPath ) ) {
          dataNode = new concurrency::ConditionNode( *this, dataPath, condSvc );
          ON_VERBOSE verbose() << "  ConditionNode for " << dataPath << " added @ " << dataNode << endmsg;
        } else {
          dataNode = new concurrency::DataNode( *this, dataPath );
          ON_VERBOSE verbose() << "  DataNode for " << dataPath << " added @ " << dataNode << endmsg;
        }
      }

      m_dataPathToDataNodeMap[dataPath] = dataNode;

      sc = StatusCode::SUCCESS;
      ON_DEBUG
      { // Mirror the action above in the BGL-based graph
        boost::add_vertex( DataProps( dataPath ), m_PRGraph );
      }
    }

    return sc;
  }

StatusCode concurrency::PrecedenceRulesGraph::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 355 of file PrecedenceRulesGraph.cpp.

  {

    StatusCode sc = StatusCode::SUCCESS;

    auto& decisionHubName = decisionHubAlgo->name();

    auto itP = m_decisionNameToDecisionHubMap.find( parentName );
    concurrency::DecisionNode* parentNode;
    if ( itP != m_decisionNameToDecisionHubMap.end() ) {
      parentNode = itP->second;
      auto itA   = m_decisionNameToDecisionHubMap.find( decisionHubName );
      concurrency::DecisionNode* decisionHubNode;
      if ( itA != m_decisionNameToDecisionHubMap.end() ) {
        decisionHubNode = itA->second;
      } else {
        decisionHubNode = new concurrency::DecisionNode( *this, m_nodeCounter, decisionHubName, modeConcurrent,
                                                         modePromptDecision, modeOR, allPass );
        m_decisionNameToDecisionHubMap[decisionHubName] = decisionHubNode;

        ON_DEBUG
        { // Mirror the action above in the BGL-based graph
          auto source = boost::add_vertex(
              DecisionHubProps( decisionHubName, m_nodeCounter, modeConcurrent, modePromptDecision, modeOR, allPass ),
              m_PRGraph );
          boost::add_edge( source, node( parentName ), m_PRGraph );
        }

        ++m_nodeCounter;

        ON_VERBOSE verbose() << "Decision hub node " << decisionHubName << " added @ " << decisionHubNode << endmsg;
      }

      parentNode->addDaughterNode( decisionHubNode );
      decisionHubNode->addParentNode( parentNode );
    } else {
      sc = StatusCode::FAILURE;
      error() << "Decision hub node " << parentName << ", requested to be parent, is not registered." << endmsg;
    }

    return sc;
  }

void concurrency::PrecedenceRulesGraph::addEdgeToPrecTrace	(	const AlgorithmNode *	u,
		const AlgorithmNode *	v
	)

set cause-effect connection between two algorithms in the precedence trace

Definition at line 650 of file PrecedenceRulesGraph.cpp.

  {

    std::string u_name = u == nullptr ? "ENTRY" : u->getNodeName();
    std::string v_name = v->getNodeName();

    precedence::AlgoTraceVertex source;

    if ( u == nullptr ) {
      auto itT = m_prec_trace_map.find( "ENTRY" );
      if ( itT != m_prec_trace_map.end() ) {
        source = itT->second;
      } else {
        source = boost::add_vertex( precedence::AlgoTraceProps( "ENTRY", -1, -1, -1.0 ), m_precTrace );
        m_prec_trace_map["ENTRY"] = source;
      }
    } else {
      auto itS = m_prec_trace_map.find( u_name );
      if ( itS != m_prec_trace_map.end() ) {
        source = itS->second;
      } else {

        source =
            boost::add_vertex( precedence::AlgoTraceProps( u_name, u->getAlgoIndex(), u->getRank(), -1 ), m_precTrace );
        m_prec_trace_map[u_name] = source;
      }
    }

    precedence::AlgoTraceVertex target;

    auto itP = m_prec_trace_map.find( v_name );
    if ( itP != m_prec_trace_map.end() ) {
      target = itP->second;
    } else {

      target =
          boost::add_vertex( precedence::AlgoTraceProps( v_name, v->getAlgoIndex(), v->getRank(), -1 ), m_precTrace );
      m_prec_trace_map[v_name] = target;
    }

    boost::add_edge( source, target, m_precTrace );

    ON_DEBUG debug() << u_name << "-->" << v_name << " precedence trait added" << endmsg;
  }

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

Add a node, which has no parents.

Definition at line 401 of file PrecedenceRulesGraph.cpp.

  {

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

      ON_DEBUG
      { // Mirror the action above in the BGL-based graph
        boost::add_vertex(
            DecisionHubProps( headName, m_nodeCounter, modeConcurrent, modePromptDecision, modeOR, allPass ),
            m_PRGraph );
      }

      ++m_nodeCounter;
    }
  }

StatusCode concurrency::PrecedenceRulesGraph::buildDataDependenciesRealm

(

)

Build data dependency realm WITH data object nodes participating.

Definition at line 206 of file PrecedenceRulesGraph.cpp.

  {

    StatusCode global_sc( StatusCode::SUCCESS, true );

    // Production of DataNodes by AlgorithmNodes (DataNodes are created here)
    for ( auto algo : m_algoNameToAlgoNodeMap ) {

      auto& outputs = m_algoNameToAlgoOutputsMap[algo.first];
      for ( auto output : outputs ) {
        const auto sc = addDataNode( output );
        if ( !sc.isSuccess() ) {
          error() << "Extra producer (" << algo.first << ") for DataObject @ " << output
                  << " has been detected: this is not allowed." << endmsg;
          global_sc = sc;
        }
        auto dataNode = getDataNode( output );
        dataNode->addProducerNode( algo.second );
        algo.second->addOutputDataNode( dataNode );
        ON_DEBUG
        { // Mirror the action above in the BGL-based graph
          boost::add_edge( node( algo.second->getNodeName() ), node( output.fullKey() ), m_PRGraph );
        }
      }
    }

    // Consumption of DataNodes by AlgorithmNodes
    for ( auto algo : m_algoNameToAlgoNodeMap ) {

      for ( auto input : m_algoNameToAlgoInputsMap[algo.first] ) {

        DataNode* dataNode = nullptr;

        auto itP = m_dataPathToDataNodeMap.find( input );

        if ( itP != m_dataPathToDataNodeMap.end() ) dataNode = getDataNode( input );

        if ( dataNode ) {
          dataNode->addConsumerNode( algo.second );
          algo.second->addInputDataNode( dataNode );
          ON_DEBUG
          { // Mirror the action above in the BGL-based graph
            boost::add_edge( node( input.fullKey() ), node( algo.second->getNodeName() ), m_PRGraph );
          }
        }
      }
    }

    return global_sc;
  }

std::string concurrency::PrecedenceRulesGraph::dumpControlFlow

(

)

const

Print out control flow of Algorithms and Sequences.

Definition at line 459 of file PrecedenceRulesGraph.cpp.

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

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

Definition at line 466 of file PrecedenceRulesGraph.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";
    }
  }

std::string concurrency::PrecedenceRulesGraph::dumpDataFlow

(

)

const

Print out all data origins and destinations, as reflected in the EF graph.

Definition at line 496 of file PrecedenceRulesGraph.cpp.

  {

    const char idt[] = "      ";
    std::ostringstream ost;

    ost << "\n" << idt << "====================================\n";
    ost << idt << "Data origins and destinations:\n";
    ost << idt << "====================================\n";

    for ( auto& pair : m_dataPathToDataNodeMap ) {

      for ( auto algoNode : pair.second->getProducers() ) ost << idt << "  " << algoNode->getNodeName() << "\n";

      ost << idt << "  V\n";
      ost << idt << "  o " << pair.first << "\n";
      ost << idt << "  V\n";

      for ( auto algoNode : pair.second->getConsumers() ) ost << idt << "  " << algoNode->getNodeName() << "\n";

      ost << idt << "====================================\n";
    }

    return ost.str();
  }

void concurrency::PrecedenceRulesGraph::dumpPrecRules	(	const boost::filesystem::path &	fileName,
		const EventSlot &	slot
	)

dump to file the precedence rules

Definition at line 524 of file PrecedenceRulesGraph.cpp.

  {
    boost::filesystem::ofstream myfile;
    myfile.open( fileName, std::ios::app );

    // Declare properties to dump
    boost::dynamic_properties dp;

    using boost::make_transform_value_property_map;
    using boost::apply_visitor;
    using boost::get;
    using boost::vertex_bundle;

    dp.property( "Entity", make_transform_value_property_map(
                               []( VariantVertexProps const& v ) { return boost::lexical_cast<std::string>( v ); },
                               get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Name", make_transform_value_property_map(
                             []( VariantVertexProps const& v ) { return apply_visitor( precedence::VertexName(), v ); },
                             get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Mode", make_transform_value_property_map(
                             []( VariantVertexProps const& v ) { return apply_visitor( precedence::GroupMode(), v ); },
                             get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Logic",
                 make_transform_value_property_map(
                     []( VariantVertexProps const& v ) { return apply_visitor( precedence::GroupLogic(), v ); },
                     get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Decision Negation",
                 make_transform_value_property_map(
                     []( VariantVertexProps const& v ) { return apply_visitor( precedence::DecisionNegation(), v ); },
                     get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Negative Decision Inversion",
                 make_transform_value_property_map(
                     []( VariantVertexProps const& v ) { return apply_visitor( precedence::AllPass(), v ); },
                     get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Exit Policy",
                 make_transform_value_property_map(
                     []( VariantVertexProps const& v ) { return apply_visitor( precedence::GroupExit(), v ); },
                     get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Operations",
                 make_transform_value_property_map(
                     []( VariantVertexProps const& v ) { return apply_visitor( precedence::Operations(), v ); },
                     get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "CF Decision", make_transform_value_property_map(
                                    [&slot]( VariantVertexProps const& v ) {
                                      return apply_visitor( precedence::CFDecision( slot ), v );
                                    },
                                    get( vertex_bundle, m_PRGraph ) ) );

    dp.property( "Algorithm State", make_transform_value_property_map(
                                        [&slot]( VariantVertexProps const& v ) {
                                          return apply_visitor( precedence::FSMState( slot ), v );
                                        },
                                        get( vertex_bundle, m_PRGraph ) ) );

    SmartIF<ITimelineSvc> timelineSvc = m_svcLocator->service<ITimelineSvc>( "TimelineSvc", false );
    if ( timelineSvc.isValid() ) {
      dp.property( "Start Time (epoch ns)", make_transform_value_property_map(
                                                [&timelineSvc]( VariantVertexProps const& v ) {
                                                  return apply_visitor( precedence::StartTime( timelineSvc ), v );
                                                },
                                                get( vertex_bundle, m_PRGraph ) ) );
      dp.property( "End Time (epoch ns)", make_transform_value_property_map(
                                              [&timelineSvc]( VariantVertexProps const& v ) {
                                                return apply_visitor( precedence::EndTime( timelineSvc ), v );
                                              },
                                              get( vertex_bundle, m_PRGraph ) ) );
      dp.property( "Runtime (ns)", make_transform_value_property_map(
                                       [&timelineSvc]( VariantVertexProps const& v ) {
                                         return apply_visitor( precedence::Duration( timelineSvc ), v );
                                       },
                                       get( vertex_bundle, m_PRGraph ) ) );
    } else {
      warning() << "Failed to get the TimelineSvc, timing will not be added to "
                << "the task precedence rules dump" << endmsg;
    }

    boost::write_graphml( myfile, m_PRGraph, dp );

    myfile.close();
  }

void concurrency::PrecedenceRulesGraph::dumpPrecTrace

(

const boost::filesystem::path &

fileName

)

dump to file the precedence trace

Definition at line 614 of file PrecedenceRulesGraph.cpp.

  {
    boost::filesystem::ofstream myfile;
    myfile.open( fileName, std::ios::app );

    // Fill runtimes (as this could not be done on the fly during trace assembling)
    SmartIF<ITimelineSvc> timelineSvc = m_svcLocator->service<ITimelineSvc>( "TimelineSvc", false );
    if ( !timelineSvc.isValid() ) {
      warning() << "Failed to get the TimelineSvc, timing will not be added to "
                << "the task precedence trace dump" << endmsg;
    } else {

      typedef boost::graph_traits<precedence::PRGraph>::vertex_iterator vertex_iter;
      std::pair<vertex_iter, vertex_iter> vp;
      for ( vp = vertices( m_precTrace ); vp.first != vp.second; ++vp.first ) {
        TimelineEvent te{};
        te.algorithm = m_precTrace[*vp.first].m_name;
        timelineSvc->getTimelineEvent( te );
        int runtime = std::chrono::duration_cast<std::chrono::nanoseconds>( te.end - te.start ).count();
        m_precTrace[*vp.first].m_runtime = runtime;
      }
    }

    // Declare properties to dump
    boost::dynamic_properties dp;
    using boost::get;
    using precedence::AlgoTraceProps;
    dp.property( "Name", get( &AlgoTraceProps::m_name, m_precTrace ) );
    dp.property( "Rank", get( &AlgoTraceProps::m_rank, m_precTrace ) );
    dp.property( "Runtime", get( &AlgoTraceProps::m_runtime, m_precTrace ) );

    boost::write_graphml( myfile, m_precTrace, dp );

    myfile.close();
  }

AlgorithmNode * concurrency::PrecedenceRulesGraph::getAlgorithmNode

(

const std::string &

algoName

)

const

Get the AlgorithmNode from by algorithm name using graph index.

Definition at line 303 of file PrecedenceRulesGraph.cpp.

  {

    return m_algoNameToAlgoNodeMap.at( algoName );
  }

unsigned int concurrency::PrecedenceRulesGraph::getControlFlowNodeCounter ( ) const

inline

Get total number of control flow graph nodes.

Definition at line 620 of file PrecedenceRulesGraph.h.

{ return m_nodeCounter; }

DataNode * concurrency::PrecedenceRulesGraph::getDataNode

(

const DataObjID &

dataPath

)

const

Get DataNode by DataObject path using graph index.

Definition at line 348 of file PrecedenceRulesGraph.cpp.

  {

    return m_dataPathToDataNodeMap.at( dataPath );
  }

DecisionNode* concurrency::PrecedenceRulesGraph::getHeadNode ( ) const

inline

Get head node.

Definition at line 611 of file PrecedenceRulesGraph.h.

{ return m_headNode; };

const std::chrono::system_clock::time_point concurrency::PrecedenceRulesGraph::getInitTime ( ) const

inline

Definition at line 630 of file PrecedenceRulesGraph.h.

{ return m_initTime; }

StatusCode concurrency::PrecedenceRulesGraph::initialize

(

)

Initialize graph.

Definition at line 142 of file PrecedenceRulesGraph.cpp.

  {

    if ( serviceLocator()->existsService( "CondSvc" ) ) {
      SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc" )};
      if ( condSvc.isValid() ) {
        info() << "CondSvc found. DF precedence rules will be augmented with 'Conditions'" << endmsg;
        m_conditionsRealmEnabled = true;
      }
    }

    // Detach condition algorithms from the CF realm
    if ( m_conditionsRealmEnabled ) {
      SmartIF<ICondSvc> condSvc{serviceLocator()->service( "CondSvc", false )};
      auto& condAlgs = condSvc->condAlgs();
      for ( const auto algo : condAlgs ) {
        auto itA = m_algoNameToAlgoNodeMap.find( algo->name() );
        concurrency::AlgorithmNode* algoNode;
        if ( itA != m_algoNameToAlgoNodeMap.end() ) {
          algoNode = itA->second;
          debug() << "Detaching condition algorithm '" << algo->name() << "' from the CF realm.." << endmsg;
          for ( auto parent : algoNode->getParentDecisionHubs() ) {
            parent->m_children.erase( std::remove( parent->m_children.begin(), parent->m_children.end(), algoNode ),
                                      parent->m_children.end() );
          }
          algoNode->m_parents.clear();

        } else {
          warning() << "Algorithm '" << algo->name() << "' is not registered in the graph" << endmsg;
        }
      }
    }

    StatusCode sc = buildDataDependenciesRealm();

    if ( !sc.isSuccess() ) error() << "Could not build the data dependency realm." << endmsg;

    ON_DEBUG debug() << dumpDataFlow() << endmsg;

    return sc;
  }

const std::string& concurrency::PrecedenceRulesGraph::name ( ) const

inlineoverride

Retrieve name of the service.

Definition at line 626 of file PrecedenceRulesGraph.h.

{ return m_name; }

PRVertexDesc concurrency::PrecedenceRulesGraph::node

(

const std::string &

name

)

const

BGL-based facilities.

Definition at line 425 of file PrecedenceRulesGraph.cpp.

  {

    PRVertexDesc target{};

    for ( auto vp = vertices( m_PRGraph ); vp.first != vp.second; ++vp.first ) {
      PRVertexDesc v = *vp.first;
      if ( boost::apply_visitor( precedence::VertexName(), m_PRGraph[v] ) == name ) {
        target = v;
        break;
      }
    }

    return target;
  }

void concurrency::PrecedenceRulesGraph::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 633 of file PrecedenceRulesGraph.h.

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

void concurrency::PrecedenceRulesGraph::rankAlgorithms

(

IGraphVisitor &

ranker

)

const

Rank Algorithm nodes by the number of data outputs.

Definition at line 448 of file PrecedenceRulesGraph.cpp.

  {

    info() << "Starting ranking by data outputs .. " << endmsg;
    for ( auto& pair : m_algoNameToAlgoNodeMap ) {
      ON_DEBUG debug() << "  Ranking " << pair.first << "... " << endmsg;
      pair.second->accept( ranker );
      ON_DEBUG debug() << "  ... rank of " << pair.first << ": " << pair.second->getRank() << endmsg;
    }
  }

void concurrency::PrecedenceRulesGraph::registerIODataObjects

(

const Algorithm *

algo

)

Register algorithm in the Data Dependency index.

Definition at line 185 of file PrecedenceRulesGraph.cpp.

  {

    const std::string& algoName = algo->name();

    m_algoNameToAlgoInputsMap[algoName]  = algo->inputDataObjs();
    m_algoNameToAlgoOutputsMap[algoName] = algo->outputDataObjs();

    ON_VERBOSE
    {
      verbose() << "    Inputs of " << algoName << ": ";
      for ( auto tag : algo->inputDataObjs() ) verbose() << tag << " | ";
      verbose() << endmsg;

      verbose() << "    Outputs of " << algoName << ": ";
      for ( auto tag : algo->outputDataObjs() ) verbose() << tag << " | ";
      verbose() << endmsg;
    }
  }

SmartIF<ISvcLocator>& concurrency::PrecedenceRulesGraph::serviceLocator ( ) const

inlineoverride

Retrieve pointer to service locator.

Definition at line 628 of file PrecedenceRulesGraph.h.

{ return m_svcLocator; }

Member Data Documentation

unsigned int concurrency::PrecedenceRulesGraph::m_algoCounter

private

Total number of algorithm nodes in the graph.

Definition at line 671 of file PrecedenceRulesGraph.h.

AlgoInputsMap concurrency::PrecedenceRulesGraph::m_algoNameToAlgoInputsMap

private

Indexes: maps of algorithm's name to algorithm's inputs/outputs.

Definition at line 665 of file PrecedenceRulesGraph.h.

AlgoNodesMap concurrency::PrecedenceRulesGraph::m_algoNameToAlgoNodeMap

private

Index: map of algorithm's name to AlgorithmNode.

Definition at line 659 of file PrecedenceRulesGraph.h.

AlgoOutputsMap concurrency::PrecedenceRulesGraph::m_algoNameToAlgoOutputsMap

private

Definition at line 666 of file PrecedenceRulesGraph.h.

bool concurrency::PrecedenceRulesGraph::m_conditionsRealmEnabled {false}

private

Enable conditions realm of precedence rules.

Definition at line 686 of file PrecedenceRulesGraph.h.

DataNodesMap concurrency::PrecedenceRulesGraph::m_dataPathToDataNodeMap

private

Index: map of data path to DataNode.

Definition at line 663 of file PrecedenceRulesGraph.h.

DecisionHubsMap concurrency::PrecedenceRulesGraph::m_decisionNameToDecisionHubMap

private

Index: map of decision's name to DecisionHub.

Definition at line 661 of file PrecedenceRulesGraph.h.

DecisionNode* concurrency::PrecedenceRulesGraph::m_headNode

private

the head node of the control flow graph

Definition at line 657 of file PrecedenceRulesGraph.h.

const std::chrono::system_clock::time_point concurrency::PrecedenceRulesGraph::m_initTime

private

Definition at line 677 of file PrecedenceRulesGraph.h.

const std::string concurrency::PrecedenceRulesGraph::m_name

private

Definition at line 675 of file PrecedenceRulesGraph.h.

unsigned int concurrency::PrecedenceRulesGraph::m_nodeCounter

private

Total number of nodes in the graph.

Definition at line 669 of file PrecedenceRulesGraph.h.

std::map<std::string, precedence::AlgoTraceVertex> concurrency::PrecedenceRulesGraph::m_prec_trace_map

private

Definition at line 681 of file PrecedenceRulesGraph.h.

precedence::PrecTrace concurrency::PrecedenceRulesGraph::m_precTrace

private

facilities for algorithm precedence tracing

Definition at line 680 of file PrecedenceRulesGraph.h.

precedence::PRGraph concurrency::PrecedenceRulesGraph::m_PRGraph

private

BGL-based graph of precedence rules.

Definition at line 683 of file PrecedenceRulesGraph.h.

SmartIF<ISvcLocator> concurrency::PrecedenceRulesGraph::m_svcLocator

mutableprivate

Service locator (needed to access the MessageSvc)

Definition at line 674 of file PrecedenceRulesGraph.h.

---

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

• GaudiHive/src/PrecedenceRulesGraph.h
• GaudiHive/src/PrecedenceRulesGraph.cpp