call_graph_helpers.h

Go to the documentation of this file.

/*******************************************************************\
 
Module: Function Call Graph Helpers
 
Author: Chris Smowton, chris.smowton@diffblue.com
 
\*******************************************************************/

 
#ifndef CPROVER_ANALYSES_CALL_GRAPH_HELPERS_H
#define CPROVER_ANALYSES_CALL_GRAPH_HELPERS_H
 
#include "call_graph.h"
 
// These are convenience functions for working with the directed graph
// representation of a call graph, obtained via
// `call_grapht::get_directed_graph`. Usually function names must be mapped
// to and from node indices, as in `graph.get_node_index("f")`, or
// `graph[node_index].function`; these helpers include the translation for
// convenience.

std::set<irep_idt> get_callees(
  const call_grapht::directed_grapht &graph, const irep_idt &function);

std::set<irep_idt> get_callers(
  const call_grapht::directed_grapht &graph, const irep_idt &function);

std::set<irep_idt> get_reachable_functions(
  const call_grapht::directed_grapht &graph, const irep_idt &function);

std::set<irep_idt> get_reaching_functions(
  const call_grapht::directed_grapht &graph, const irep_idt &function);

std::set<irep_idt> get_functions_reachable_within_n_steps(
  const call_grapht::directed_grapht &graph,
  const std::set<irep_idt> &start_functions,
  std::size_t n);

std::set<irep_idt> get_functions_reachable_within_n_steps(
  const call_grapht::directed_grapht &graph,
  const irep_idt &start_function,
  std::size_t n);

std::list<irep_idt> get_shortest_function_path(
  const call_grapht::directed_grapht &graph,
  const irep_idt &src,
  const irep_idt &dest);

void disconnect_unreachable_functions(
  call_grapht::directed_grapht &graph,
  const irep_idt &function);
 
#endif