ProcessCallGraph Class Reference

#include <ProcessCallGraph.h>

Classes
struct	NodeType
struct	PathType
struct	ProcessType

Public Types
using	GraphType = boost::subgraph< boost::adjacency_list< boost::vecS, boost::vecS, boost::directedS, NodeType, boost::property< boost::edge_index_t, int >, boost::property< boost::graph_name_t, std::string > >>

Public Member Functions
std::pair< std::vector< unsigned int >, std::vector< unsigned int > >	dependencies (std::vector< unsigned int > const &path)
std::vector< unsigned int >	depends (unsigned int module) const
edm::ModuleDescription const &	module (unsigned int module) const
NodeType const &	operator[] (unsigned int module) const
void	preBeginJob (edm::PathsAndConsumesOfModulesBase const &, edm::ProcessContext const &)
void	preSourceConstruction (edm::ModuleDescription const &)
	ProcessCallGraph ()
ProcessType const &	processDescription (unsigned int) const
ProcessType const &	processDescription (edm::ProcessContext const &) const
ProcessType const &	processDescription (std::string const &) const
std::vector< ProcessType > const &	processes () const
unsigned int	processId (edm::ProcessContext const &) const
unsigned int	processId (std::string const &) const
unsigned int	size () const
edm::ModuleDescription const &	source () const

Private Member Functions
unsigned int	registerProcess (edm::ProcessContext const &)

Private Attributes
GraphType	graph_
std::vector< ProcessType >	process_description_
std::unordered_map< std::string, unsigned int >	process_id_
unsigned int	source_

Detailed Description

Definition at line 26 of file ProcessCallGraph.h.

Member Typedef Documentation

using ProcessCallGraph::GraphType = boost::subgraph<boost::adjacency_list< boost::vecS, boost::vecS, boost::directedS, NodeType, boost::property<boost::edge_index_t, int>, boost::property<boost::graph_name_t, std::string> >>

Definition at line 48 of file ProcessCallGraph.h.

Constructor & Destructor Documentation

ProcessCallGraph::ProcessCallGraph

(

)

Definition at line 33 of file ProcessCallGraph.cc.

Referenced by ProcessCallGraph::ProcessType::ProcessType().

{
}

Member Function Documentation

std::pair< std::vector< unsigned int >, std::vector< unsigned int > > ProcessCallGraph::dependencies

(

std::vector< unsigned int > const &

path

)

Definition at line 220 of file ProcessCallGraph.cc.

References colors, graph_, mps_fire::i, size(), and primaryVertexAssociation_cfi::vertices.

Referenced by depends(), preBeginJob(), and ProcessCallGraph::ProcessType::ProcessType().

{
  std::vector<unsigned int> colors(boost::num_vertices(graph_));
  auto colormap = boost::make_container_vertex_map(colors);

  // first, find and count all the path's modules' dependencies
  boost::default_dfs_visitor visitor;
  for (unsigned int module: path)
    boost::depth_first_visit(graph_, module, visitor, colormap);

  unsigned int size = 0;
  for (unsigned int i = 0; i < colors.size(); ++i)
    if (colors[i] == 0)
      ++size;

  // allocate the output vectors
  std::vector<unsigned int> dependencies(size);
  dependencies.resize(0);
  std::vector<unsigned int> indices(path.size());
  indices.resize(0);

  // reset the color map
  for (unsigned int i = 0; i < colors.size(); ++i)
    colors[i] = 0;

  // find again all the dependencies, and record those associated to each module
  struct record_vertices : boost::default_dfs_visitor {
    record_vertices(std::vector<unsigned int> & vertices) :
      vertices_(vertices) { }

    void discover_vertex(unsigned int vertex, GraphType const& graph) {
      vertices_.push_back(vertex);
    }

    std::vector<unsigned int> & vertices_;
  };
  record_vertices recorder(dependencies);

  for (unsigned int module: path) {
    // skip modules that have already been added as dependencies
    if (colors[module] != boost::black_color)
      boost::depth_first_visit(graph_, module, recorder, colormap);
    indices.push_back(dependencies.size());
  }

  return std::make_pair(dependencies, indices);

}

std::vector< unsigned int > ProcessCallGraph::depends

(

unsigned int

module

)

const

Definition at line 189 of file ProcessCallGraph.cc.

References colors, dependencies(), graph_, mps_fire::i, and size().

Referenced by ProcessCallGraph::ProcessType::ProcessType().

{
  std::vector<unsigned int> colors(boost::num_vertices(graph_));
  auto colormap = boost::make_container_vertex_map(colors);

  // depht-first visit all vertices starting from the given module
  boost::default_dfs_visitor visitor;
  boost::depth_first_visit(graph_, module, visitor, colormap);

  // count the visited vertices (the `black' ones) in order to properly size the
  // output vector; then fill the dependencies with the list of visited nodes
  unsigned int size = 0;
  for (unsigned int i = 0; i < colors.size(); ++i)
    if (boost::black_color == colors[i])
      ++size;
  std::vector<unsigned int> dependencies(size);
  unsigned j = 0;
  for (unsigned int i = 0; i < colors.size(); ++i)
    if (boost::black_color == colors[i])
      dependencies[j++] = i;
  assert(size == j);

  return dependencies;
}

edm::ModuleDescription const & ProcessCallGraph::module

(

unsigned int

module

)

const

Definition at line 173 of file ProcessCallGraph.cc.

References graph_.

Referenced by FastTimerService::PlotsPerJob::book(), operator[](), FastTimerService::postBeginJob(), preBeginJob(), preSourceConstruction(), FastTimerService::printEvent(), FastTimerService::printSummary(), ProcessCallGraph::ProcessType::ProcessType(), and FastTimerService::queryModuleTimeByLabel().

{
  return graph_.m_graph[module].module_;
}

ProcessCallGraph::NodeType const & ProcessCallGraph::operator[]

(

unsigned int

module

)

const

Definition at line 181 of file ProcessCallGraph.cc.

References graph_, and module().

Referenced by ProcessCallGraph::ProcessType::ProcessType().

{
  return graph_.m_graph[module];
}

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

Definition at line 75 of file ProcessCallGraph.cc.

References edm::PathsAndConsumesOfModulesBase::allModules(), dependencies(), symbols::deps, edm::edmModuleTypeEnum(), edm::PathsAndConsumesOfModulesBase::endPaths(), graph_, mps_fire::i, edm::ProcessContext::isSubProcess(), module(), ErrorSummaryFilter_cfi::modules, edm::PathsAndConsumesOfModulesBase::modulesOnEndPath(), edm::PathsAndConsumesOfModulesBase::modulesOnPath(), edm::PathsAndConsumesOfModulesBase::modulesWhoseProductsAreConsumedBy(), edm::ProcessContext::parentProcessContext(), edm::PathsAndConsumesOfModulesBase::paths(), sysUtil::pid, process_description_, processId(), edm::ProcessContext::processName(), registerProcess(), and size().

Referenced by FastTimerService::preBeginJob(), and ProcessCallGraph::ProcessType::ProcessType().

{
  unsigned int pid = registerProcess(context);

  // work on the full graph (for the main process) or a subgraph (for a subprocess)
  GraphType & graph = context.isSubProcess() ? graph_.create_subgraph() : graph_.root();

  // set the graph name property to the process name
  boost::get_property(graph, boost::graph_name) = context.processName();

  // 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(graph);

  // set the vertices properties (use the module id as the global index into the graph)
  std::vector<unsigned int> modules;
  modules.reserve(size);
  for (edm::ModuleDescription const * module: pathsAndConsumes.allModules()) {
    modules.push_back(module->id());
    graph_.m_graph[module->id()] = { *module, edmModuleTypeEnum(*module), false };
  }

  // add graph edges associated to module dependencies
  for (edm::ModuleDescription const * consumer: pathsAndConsumes.allModules()) {
    for (edm::ModuleDescription const * module: pathsAndConsumes.modulesWhoseProductsAreConsumedBy(consumer->id())) {
      // module `consumer' depends on module `module'
      boost::add_edge(consumer->id(), module->id(), graph_);
    }
  }

  // extract path names from the TriggerNamesService
  edm::service::TriggerNamesService const & tns = * edm::Service<edm::service::TriggerNamesService>();

  // extract the details of the paths and endpaths: name, modules on the path, and their dependencies
  size = pathsAndConsumes.paths().size();
  assert (tns.getTrigPaths().size() == size);
  std::vector<PathType> paths;
  paths.reserve(size);
  for (unsigned int i = 0; i < size; ++i) {
    std::vector<unsigned int> modules;
    for (edm::ModuleDescription const * module: pathsAndConsumes.modulesOnPath(i)) {
      modules.push_back(module->id());
      // mark the modules in the Paths as scheduled
      graph_.m_graph[module->id()].scheduled_ = true;
    }
    auto deps = dependencies(modules);
    paths.emplace_back(tns.getTrigPath(i), modules, deps.first, deps.second);
  }
  size = pathsAndConsumes.endPaths().size();
  std::vector<PathType> endPaths;
  endPaths.reserve(size);
  for (unsigned int i = 0; i < size; ++i) {
    std::vector<unsigned int> modules;
    for (edm::ModuleDescription const * module: pathsAndConsumes.modulesOnEndPath(i)) {
      modules.push_back(module->id());
      // mark the modules in the EndPaths as scheduled
      graph_.m_graph[module->id()].scheduled_ = true;
    }
    auto deps = dependencies(modules);
    endPaths.emplace_back(tns.getEndPath(i), modules, deps.first, deps.second);
  }

  // store the description of process, modules and paths
  process_description_.emplace_back(
      context.processName(),
      graph,
      modules,
      paths,
      endPaths);
  assert(process_description_.size() == pid+1);

  // attach a subprocess to its parent
  if (context.isSubProcess()) {
    unsigned int parent_pid = processId(context.parentProcessContext());
    process_description_[parent_pid].subprocesses_.push_back(pid);
  }
}

void ProcessCallGraph::preSourceConstruction

(

edm::ModuleDescription const &

module

)

Definition at line 59 of file ProcessCallGraph.cc.

References graph_, edm::ModuleDescription::id(), edm::kSource, module(), and source_.

Referenced by FastTimerService::preSourceConstruction(), and ProcessCallGraph::ProcessType::ProcessType().

{
  // keep track of the Source module id
  source_ = module.id();

  // create graph vertex for the source module
  boost::add_vertex(graph_);
  graph_.m_graph[module.id()] = { module, edm::EDMModuleType::kSource, true };
}

ProcessCallGraph::ProcessType const & ProcessCallGraph::processDescription

(

unsigned int

pid

)

const

Definition at line 327 of file ProcessCallGraph.cc.

References process_description_.

Referenced by FastTimerService::PlotsPerJob::book(), FastTimerService::PlotsPerJob::fill(), FastTimerService::postEvent(), FastTimerService::postPathEvent(), FastTimerService::printEvent(), FastTimerService::printSummary(), ProcessCallGraph::ProcessType::ProcessType(), FastTimerService::queryModuleTimeByLabel(), and FastTimerService::queryPathTime().

{
  return process_description_.at(pid);
}

ProcessCallGraph::ProcessType const & ProcessCallGraph::processDescription

(

edm::ProcessContext const &

context

)

const

Definition at line 334 of file ProcessCallGraph.cc.

References sysUtil::pid, process_description_, and processId().

{
  unsigned int pid = processId(context);
  return process_description_[pid];
}

ProcessCallGraph::ProcessType const & ProcessCallGraph::processDescription

(

std::string const &

processName

)

const

Definition at line 342 of file ProcessCallGraph.cc.

References sysUtil::pid, process_description_, and processId().

{
  unsigned int pid = processId(processName);
  return process_description_[pid];
}

std::vector< ProcessCallGraph::ProcessType > const & ProcessCallGraph::processes

(

)

const

Definition at line 320 of file ProcessCallGraph.cc.

References process_description_.

Referenced by FastTimerService::PlotsPerJob::book(), FastTimerService::isLastSubprocess(), FastTimerService::PlotsPerJob::PlotsPerJob(), FastTimerService::printEvent(), FastTimerService::printSummary(), ProcessCallGraph::ProcessType::ProcessType(), FastTimerService::queryPathTime(), and FastTimerService::ResourcesPerJob::ResourcesPerJob().

{
  return process_description_;
}

unsigned int ProcessCallGraph::processId

(

edm::ProcessContext const &

context

)

const

Definition at line 297 of file ProcessCallGraph.cc.

References edm::ProcessContext::isSubProcess(), edm::errors::LogicError, process_id_, and edm::ProcessContext::processName().

Referenced by FastTimerService::postEvent(), FastTimerService::postPathEvent(), preBeginJob(), FastTimerService::prePathEvent(), processDescription(), ProcessCallGraph::ProcessType::ProcessType(), FastTimerService::queryEventTime(), and FastTimerService::queryPathTime().

{
  auto id = process_id_.find(context.processName());
  if (id == process_id_.end())
    throw edm::Exception(edm::errors::LogicError)
      << "ProcessCallGraph::processId(): unexpected " << (context.isSubProcess() ? "subprocess" : "process") << " " << context.processName();
  return id->second;
}

unsigned int ProcessCallGraph::processId

(

std::string const &

processName

)

const

Definition at line 309 of file ProcessCallGraph.cc.

References edm::errors::LogicError, process_id_, and modifiedElectrons_cfi::processName.

{
  auto id = process_id_.find(processName);
  if (id == process_id_.end())
    throw edm::Exception(edm::errors::LogicError)
      << "ProcessCallGraph::processId(): unexpected (sub)process " << processName;
  return id->second;
}

unsigned int ProcessCallGraph::registerProcess ( edm::ProcessContext const &  context )

private

Definition at line 271 of file ProcessCallGraph.cc.

References Exception, SequenceTypes::ignore(), edm::ProcessContext::isSubProcess(), edm::errors::LogicError, edm::ProcessContext::parentProcessContext(), process_id_, edm::ProcessContext::processName(), and s_id.

Referenced by preBeginJob(), and ProcessCallGraph::ProcessType::ProcessType().

{
  static unsigned int s_id = 0;

  // registerProcess (called by preBeginJob) must be called for the parent process before its subprocess(es)
  if (context.isSubProcess() and process_id_.find(context.parentProcessContext().processName()) == process_id_.end())  {
    throw edm::Exception(edm::errors::LogicError)
      << "ProcessCallGraph::preBeginJob(): called for subprocess \"" << context.processName() << "\""
      << " before being called for its parent process \"" << context.parentProcessContext().processName() << "\"";
  }

  // registerProcess (called by preBeginJob) should be called once or each (sub)process
  auto id = process_id_.find(context.processName());
  if (id != process_id_.end()) {
    throw edm::Exception(edm::errors::LogicError)
      << "ProcessCallGraph::preBeginJob(): called twice for the same "
      << (context.isSubProcess() ? "subprocess" : "process") << " " << context.processName();
  }

  std::tie(id, std::ignore) = process_id_.insert(std::make_pair(context.processName(), s_id++));
  return id->second;
}

unsigned int ProcessCallGraph::size

(

void

)

const

Definition at line 157 of file ProcessCallGraph.cc.

References graph_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), dependencies(), depends(), FastTimerService::postBeginJob(), preBeginJob(), ProcessCallGraph::ProcessType::ProcessType(), FastTimerService::queryModuleTime(), and FastTimerService::queryModuleTimeByLabel().

{
  return boost::num_vertices(graph_);
}

edm::ModuleDescription const & ProcessCallGraph::source

(

)

const

Definition at line 165 of file ProcessCallGraph.cc.

References graph_, and source_.

Referenced by FastTimerService::PlotsPerJob::book(), FastTimerService::postSourceEvent(), FastTimerService::printEvent(), FastTimerService::printSummary(), ProcessCallGraph::ProcessType::ProcessType(), and FastTimerService::querySourceTime().

{
  return graph_.m_graph[source_].module_;
}

Member Data Documentation

GraphType ProcessCallGraph::graph_

private

Definition at line 186 of file ProcessCallGraph.h.

Referenced by dependencies(), depends(), module(), operator[](), preBeginJob(), preSourceConstruction(), ProcessCallGraph::ProcessType::ProcessType(), size(), and source().

std::vector<ProcessType> ProcessCallGraph::process_description_

private

Definition at line 195 of file ProcessCallGraph.h.

Referenced by preBeginJob(), processDescription(), and processes().

std::unordered_map<std::string, unsigned int> ProcessCallGraph::process_id_

private

Definition at line 192 of file ProcessCallGraph.h.

Referenced by processId(), and registerProcess().

unsigned int ProcessCallGraph::source_

private

Definition at line 189 of file ProcessCallGraph.h.

Referenced by Config.Process::dumpConfig(), Config.Process::dumpPython(), preSourceConstruction(), and source().