DependencyGraph Class Reference

Classes
struct	node

Public Member Functions
	DependencyGraph (const ParameterSet &, ActivityRegistry &)
void	postBeginJob ()
void	preBeginJob (PathsAndConsumesOfModulesBase const &, ProcessContext const &)
void	preSourceConstruction (ModuleDescription const &)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Private Types
enum	EDMModuleType {   EDMModuleType::Unknown, EDMModuleType::Source, EDMModuleType::ESSource, EDMModuleType::ESProducer,   EDMModuleType::EDAnalyzer, EDMModuleType::EDProducer, EDMModuleType::EDFilter, EDMModuleType::OutputModule }
using	GraphvizAttributes = std::map< std::string, std::string >

Private Member Functions
bool	highlighted (std::string const &module)

Static Private Member Functions
static const char *	edmModuleType (edm::ModuleDescription const &module)
static EDMModuleType	edmModuleTypeEnum (edm::ModuleDescription const &module)

Private Attributes
std::string	m_filename
boost::subgraph< boost::adjacency_list< boost::vecS, boost::vecS, boost::directedS, boost::property< boost::vertex_attribute_t, GraphvizAttributes, node >, boost::property< boost::edge_index_t, int, boost::property< boost::edge_attribute_t, GraphvizAttributes > >, boost::property< boost::graph_name_t, std::string, boost::property< boost::graph_graph_attribute_t, GraphvizAttributes, boost::property< boost::graph_vertex_attribute_t, GraphvizAttributes, boost::property< boost::graph_edge_attribute_t, GraphvizAttributes > > > > > >	m_graph
std::unordered_set< std::string >	m_highlightModules
bool	m_initialized
bool	m_showPathDependencies

Static Private Attributes
static const char *	module_type_desc []
static const char *	shapes []

Detailed Description

Definition at line 56 of file DependencyGraph.cc.

Member Typedef Documentation

using DependencyGraph::GraphvizAttributes = std::map<std::string, std::string>

private

Definition at line 120 of file DependencyGraph.cc.

Member Enumeration Documentation

enum DependencyGraph::EDMModuleType

strongprivate

Enumerator
Unknown
Source
ESSource
ESProducer
EDAnalyzer
EDProducer
EDFilter
OutputModule

Definition at line 71 of file DependencyGraph.cc.

                           {
    Unknown,
    Source,
    ESSource,
    ESProducer,
    EDAnalyzer,
    EDProducer,
    EDFilter,
    OutputModule
  };

Constructor & Destructor Documentation

DependencyGraph::DependencyGraph	(	const ParameterSet &	,
		ActivityRegistry &
	)

Definition at line 198 of file DependencyGraph.cc.

References postBeginJob(), preBeginJob(), preSourceConstruction(), edm::ActivityRegistry::watchPostBeginJob(), edm::ActivityRegistry::watchPreBeginJob(), and edm::ActivityRegistry::watchPreSourceConstruction().

                                                                                         :
  m_filename( config.getUntrackedParameter<std::string>("fileName") ),
  m_highlightModules( make_unordered_set(config.getUntrackedParameter<std::vector<std::string>>("highlightModules")) ),
  m_showPathDependencies( config.getUntrackedParameter<bool>("showPathDependencies") ),
  m_initialized( false )
{
  registry.watchPreSourceConstruction(this, &DependencyGraph::preSourceConstruction);
  registry.watchPreBeginJob(this, &DependencyGraph::preBeginJob);
  registry.watchPostBeginJob(this, &DependencyGraph::postBeginJob);
}

Member Function Documentation

const char * DependencyGraph::edmModuleType ( edm::ModuleDescription const &  module )

staticprivate

Definition at line 181 of file DependencyGraph.cc.

References edm::edmModuleTypeEnum(), and edm::module_type_desc.

{
  return module_type_desc[static_cast<std::underlying_type_t<EDMModuleType>>(edmModuleTypeEnum(module))];
}

DependencyGraph::EDMModuleType DependencyGraph::edmModuleTypeEnum ( edm::ModuleDescription const &  module )

staticprivate

Definition at line 156 of file DependencyGraph.cc.

References mixOne_cfi::ESProducer, edm::pset::Registry::instance(), edm::module_type_desc, edm::ModuleDescription::parameterSetID(), muonDTDigis_cfi::pset, PhysicsTools::registry, PFJetToCaloProducer_cfi::Source, AlCaHLTBitMon_QueryRunRegistry::string, lumiQTWidget::t, reco::Unknown, and findQualityFiles::v.

Referenced by preBeginJob().

{
  auto const & registry = * edm::pset::Registry::instance();
  auto const & pset = * registry.getMapped(module.parameterSetID());

  if (not pset.existsAs<std::string>("@module_edm_type"))
    return EDMModuleType::Unknown;

  std::string const & t = pset.getParameter<std::string>("@module_edm_type");
  for (EDMModuleType v: {
    EDMModuleType::Source,
    EDMModuleType::ESSource,
    EDMModuleType::ESProducer,
    EDMModuleType::EDAnalyzer,
    EDMModuleType::EDProducer,
    EDMModuleType::EDFilter,
    EDMModuleType::OutputModule
  }) {
    if (t == module_type_desc[static_cast<std::underlying_type_t<EDMModuleType>>(v)])
      return v;
  }
  return EDMModuleType::Unknown;
}

void DependencyGraph::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 188 of file DependencyGraph.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), and AlCaHLTBitMon_QueryRunRegistry::string.

{
  edm::ParameterSetDescription desc;
  desc.addUntracked<std::string>("fileName", "dependency.gv");
  desc.addUntracked<std::vector<std::string>>("highlightModules", {});
  desc.addUntracked<bool>("showPathDependencies", true);
  descriptions.add("DependencyGraph", desc);
}

bool DependencyGraph::highlighted ( std::string const &  module )

inlineprivate

Definition at line 67 of file DependencyGraph.cc.

Referenced by preBeginJob(), and preSourceConstruction().

                                             {
    return (m_highlightModules.find(module) != m_highlightModules.end());
  }

void DependencyGraph::postBeginJob

(

)

Definition at line 363 of file DependencyGraph.cc.

References m_filename, m_graph, m_initialized, and MillePedeFileConverter_cfg::out.

Referenced by DependencyGraph().

                              {

  if (not m_initialized)
    return;

  // draw the dependency graph
  std::ofstream out(m_filename);
  boost::write_graphviz(
      out,
      m_graph
  );
  out.close();
}

void DependencyGraph::preBeginJob	(	PathsAndConsumesOfModulesBase const &	pathsAndConsumes,
		ProcessContext const &	context
	)

Definition at line 244 of file DependencyGraph.cc.

References edm::PathsAndConsumesOfModulesBase::allModules(), edmModuleTypeEnum(), edm::PathsAndConsumesOfModulesBase::endPaths(), runEdmFileComparison::found, reco::get(), highlighted(), mps_fire::i, edm::ModuleDescription::id(), edm::ProcessContext::isSubProcess(), m_graph, m_initialized, m_showPathDependencies, edm::ModuleDescription::moduleLabel(), edm::PathsAndConsumesOfModulesBase::modulesOnEndPath(), edm::PathsAndConsumesOfModulesBase::modulesOnPath(), edm::PathsAndConsumesOfModulesBase::modulesWhoseProductsAreConsumedBy(), edm::PathsAndConsumesOfModulesBase::paths(), edm::ProcessContext::processName(), shapes, and findQualityFiles::size.

Referenced by DependencyGraph().

                                                                                                                   {

  // if the Service is not in the main Process do not do anything
  if (context.isSubProcess() and not m_initialized) {
    edm::LogError("DependencyGraph")
      << "You have requested an instance of the DependencyGraph Service in the \"" << context.processName()
      << "\" SubProcess, which is not supported.\nPlease move it to the main process.";
    return;
  }

  if (not context.isSubProcess()) {
    // set the graph name property to the process name
    boost::get_property(m_graph, boost::graph_name) = context.processName();
    boost::get_property(m_graph, boost::graph_graph_attribute)["label"] = "process " + context.processName();
    boost::get_property(m_graph, boost::graph_graph_attribute)["labelloc"] = "top";

    // create graph vertices associated to all modules in the process
    auto size = pathsAndConsumes.allModules().size();
    for (size_t i = 0; i < size; ++i)
      boost::add_vertex(m_graph);

    m_initialized = true;
  } else {
    // create a subgraph to match the subprocess
    auto & graph = m_graph.create_subgraph();

    // set the subgraph name property to the subprocess name
    boost::get_property(graph, boost::graph_name) = "cluster" + context.processName();
    boost::get_property(graph, boost::graph_graph_attribute)["label"] = "subprocess " + context.processName();
    boost::get_property(graph, boost::graph_graph_attribute)["labelloc"] = "top";

    // create graph vertices associated to all modules in the subprocess
    auto size = pathsAndConsumes.allModules().size();
    for (size_t i = 0; i < size; ++i)
      boost::add_vertex(graph);
  }

  // set the vertices properties (use the module id as the global index into the graph)
  for (edm::ModuleDescription const * module: pathsAndConsumes.allModules()) {
    m_graph.m_graph[module->id()] = { module->moduleLabel(), module->moduleName(), module->id(), edmModuleTypeEnum(*module), false };

    auto & attributes = boost::get(boost::get(boost::vertex_attribute, m_graph), module->id());
    attributes["label"] = module->moduleLabel();
    attributes["tooltip"] = module->moduleName();
    attributes["shape"] = shapes[static_cast<std::underlying_type_t<EDMModuleType>>(edmModuleTypeEnum(*module))];
    attributes["style"] = "filled";
    attributes["color"] = "black";
    attributes["fillcolor"] = highlighted(module->moduleLabel()) ? "green" : "lightgrey";
  }

  // paths and endpaths
  auto const & paths = pathsAndConsumes.paths();
  auto const & endps = pathsAndConsumes.endPaths();

  // add graph edges associated to module dependencies
  for (edm::ModuleDescription const * consumer: pathsAndConsumes.allModules()) {
    for (edm::ModuleDescription const * module: pathsAndConsumes.modulesWhoseProductsAreConsumedBy(consumer->id())) {
      edm::LogInfo("DependencyGraph") << "module " << consumer->moduleLabel() << " depends on module " << module->moduleLabel();
      auto edge_status = boost::add_edge(consumer->id(), module->id(), m_graph);
      // highlight the arrow between highlighted nodes
      if (highlighted(module->moduleLabel()) and highlighted(consumer->moduleLabel())) {
        auto const & edge = edge_status.first;
        auto & attributes = boost::get(boost::get(boost::edge_attribute, m_graph), edge);
        attributes["color"] = "darkgreen";
      }
    }
  }

  // marke the modules in the paths as scheduled, and add a soft dependency to reflect the order of modules along each path
  edm::ModuleDescription const * previous;
  for (unsigned int i = 0; i < paths.size(); ++i) {
    previous = nullptr;
    for (edm::ModuleDescription const * module: pathsAndConsumes.modulesOnPath(i)) {
      m_graph.m_graph[module->id()].scheduled = true;
      auto & attributes = boost::get(boost::get(boost::vertex_attribute, m_graph), module->id());
      attributes["fillcolor"] = highlighted(module->moduleLabel()) ? "lightgreen" : "white";
      if (previous and m_showPathDependencies) {
        edm::LogInfo("DependencyGraph") << "module " << module->moduleLabel() << " follows module " << previous->moduleLabel() << " in Path " << i;
        auto edge_status = boost::lookup_edge(module->id(), previous->id(), m_graph);
        bool found = edge_status.second;
        if (not found) {
          edge_status = boost::add_edge(module->id(), previous->id(), m_graph);
          auto const & edge = edge_status.first;
          auto & attributes = boost::get(boost::get(boost::edge_attribute, m_graph), edge);
          attributes["style"] = "dashed";
          // highlight the arrow between highlighted nodes
          if (highlighted(module->moduleLabel()) and highlighted(previous->moduleLabel()))
            attributes["color"] = "darkgreen";
        }
      }
      previous = module;
    }
  }
  for (unsigned int i = 0; i < endps.size(); ++i) {
    previous = nullptr;
    for (edm::ModuleDescription const * module: pathsAndConsumes.modulesOnEndPath(i)) {
      m_graph.m_graph[module->id()].scheduled = true;
      auto & attributes = boost::get(boost::get(boost::vertex_attribute, m_graph), module->id());
      attributes["fillcolor"] = highlighted(module->moduleLabel()) ? "lightgreen" : "white";
      if (previous and m_showPathDependencies) {
        edm::LogInfo("DependencyGraph") << "module " << module->moduleLabel() << " follows module " << previous->moduleLabel() << " in EndPath " << i;
        auto edge_status = boost::lookup_edge(module->id(), previous->id(), m_graph);
        bool found = edge_status.second;
        if (not found) {
          edge_status = boost::add_edge(module->id(), previous->id(), m_graph);
          auto const & edge = edge_status.first;
          auto & attributes = boost::get(boost::get(boost::edge_attribute, m_graph), edge);
          attributes["style"] = "dashed";
          // highlight the arrow between highlighted nodes
          if (highlighted(module->moduleLabel()) and highlighted(previous->moduleLabel()))
            attributes["color"] = "darkgreen";
        }
      }
      previous = module;
    }
  }
}

void DependencyGraph::preSourceConstruction

(

ModuleDescription const &

module

)

Definition at line 229 of file DependencyGraph.cc.

References reco::get(), highlighted(), edm::ModuleDescription::id(), m_graph, edm::ModuleDescription::moduleLabel(), edm::ModuleDescription::moduleName(), shapes, and Source.

Referenced by DependencyGraph().

                                                                       {
  // create graph vertex for the source module and fill its attributes
  boost::add_vertex(m_graph);
  m_graph.m_graph[module.id()] = node{ module.moduleLabel(), module.moduleName(), module.id(), EDMModuleType::Source, true };
  auto & attributes = boost::get(boost::get(boost::vertex_attribute, m_graph), 0);
  attributes["label"] = module.moduleLabel();
  attributes["tooltip"] = module.moduleName();
  attributes["shape"] = shapes[static_cast<std::underlying_type_t<EDMModuleType>>(EDMModuleType::Source)];
  attributes["style"] = "filled";
  attributes["color"] = "black";
  attributes["fillcolor"] = highlighted(module.moduleLabel()) ? "lightgreen" : "white";
}

Member Data Documentation

std::string DependencyGraph::m_filename

private

Definition at line 142 of file DependencyGraph.cc.

Referenced by postBeginJob().

boost::subgraph<boost::adjacency_list< boost::vecS, boost::vecS, boost::directedS, boost::property<boost::vertex_attribute_t, GraphvizAttributes, node>, boost::property<boost::edge_index_t, int, boost::property<boost::edge_attribute_t, GraphvizAttributes> >, boost::property<boost::graph_name_t, std::string, boost::property<boost::graph_graph_attribute_t, GraphvizAttributes, boost::property<boost::graph_vertex_attribute_t, GraphvizAttributes, boost::property<boost::graph_edge_attribute_t, GraphvizAttributes> > > > > > DependencyGraph::m_graph

private

Definition at line 140 of file DependencyGraph.cc.

Referenced by postBeginJob(), preBeginJob(), and preSourceConstruction().

std::unordered_set<std::string> DependencyGraph::m_highlightModules

private

Definition at line 143 of file DependencyGraph.cc.

bool DependencyGraph::m_initialized

private

Definition at line 146 of file DependencyGraph.cc.

Referenced by postBeginJob(), and preBeginJob().

bool DependencyGraph::m_showPathDependencies

private

Definition at line 145 of file DependencyGraph.cc.

Referenced by preBeginJob().

const char * DependencyGraph::module_type_desc

staticprivate

Initial value:

{
    "Unknown",
    "Source",
    "ESSource",
    "ESProducer",
    "EDAnalyzer",
    "EDProducer",
    "EDFilter",
    "OutputModule"
  }

Definition at line 83 of file DependencyGraph.cc.

const char * DependencyGraph::shapes

staticprivate

Initial value:

{
    "note",     
    "oval",     
    "cylinder", 
    "cylinder", 
    "oval",     
    "box",      
    "diamond",  
    "oval",     
  }

Definition at line 95 of file DependencyGraph.cc.

Referenced by preBeginJob(), and preSourceConstruction().