remove_virtual_functions.h

Go to the documentation of this file.

/*******************************************************************\
 
Module: Remove Virtual Function (Method) Calls
 
Author: Daniel Kroening
 
Date: April 2016
 
\*******************************************************************/

 
#ifndef CPROVER_GOTO_PROGRAMS_REMOVE_VIRTUAL_FUNCTIONS_H
#define CPROVER_GOTO_PROGRAMS_REMOVE_VIRTUAL_FUNCTIONS_H
 
#include <util/std_expr.h>
 
#include "goto_program.h"
 
#include <map>
 
class class_hierarchyt;
class goto_functionst;
class goto_model_functiont;
class goto_modelt;
class symbol_table_baset;
 
// For all of the following the class-hierarchy and non-class-hierarchy
// overloads are equivalent, but the class-hierarchy-taking one saves time if
// you already have a class-hierarchy object available.
 
void remove_virtual_functions(
  goto_modelt &goto_model);
 
void remove_virtual_functions(
  goto_modelt &goto_model,
  const class_hierarchyt &class_hierarchy);
 
void remove_virtual_functions(
  symbol_table_baset &symbol_table,
  goto_functionst &goto_functions);
 
void remove_virtual_functions(
  symbol_table_baset &symbol_table,
  goto_functionst &goto_functions,
  const class_hierarchyt &class_hierarchy);
 
void remove_virtual_functions(goto_model_functiont &function);
 
void remove_virtual_functions(
  goto_model_functiont &function,
  const class_hierarchyt &class_hierarchy);

enum class virtual_dispatch_fallback_actiont
{
  CALL_LAST_FUNCTION,
  ASSUME_FALSE
};
 
class dispatch_table_entryt
{
public:
  explicit dispatch_table_entryt(const irep_idt &_class_id)
    : symbol_expr(), class_id(_class_id)
  {
  }
 
#if defined(__GNUC__) && __GNUC__ < 7
  // GCC up to version 6.5 warns about irept::data being used uninitialized upon
  // the move triggered by std::sort; using operator= works around this
  dispatch_table_entryt(dispatch_table_entryt &&other)
  {
    symbol_expr = other.symbol_expr;
    class_id = other.class_id;
  }
 
  dispatch_table_entryt &operator=(const dispatch_table_entryt &other)
  {
    symbol_expr = other.symbol_expr;
    class_id = other.class_id;
    return *this;
  }
 
  dispatch_table_entryt(const dispatch_table_entryt &other)
    : symbol_expr(other.symbol_expr), class_id(other.class_id)
  {
  }
#endif
 
  std::optional<symbol_exprt> symbol_expr;
  irep_idt class_id;
};
 
typedef std::vector<dispatch_table_entryt> dispatch_table_entriest;
typedef std::map<irep_idt, dispatch_table_entryt> dispatch_table_entries_mapt;
 
goto_programt::targett remove_virtual_function(
  goto_modelt &goto_model,
  const irep_idt &function_id,
  goto_programt &goto_program,
  goto_programt::targett instruction,
  const dispatch_table_entriest &dispatch_table,
  virtual_dispatch_fallback_actiont fallback_action);
 
goto_programt::targett remove_virtual_function(
  symbol_table_baset &symbol_table,
  const irep_idt &function_id,
  goto_programt &goto_program,
  goto_programt::targett instruction,
  const dispatch_table_entriest &dispatch_table,
  virtual_dispatch_fallback_actiont fallback_action);

void collect_virtual_function_callees(
  const exprt &function,
  const symbol_table_baset &symbol_table,
  const class_hierarchyt &class_hierarchy,
  dispatch_table_entriest &overridden_functions);
 
#endif // CPROVER_GOTO_PROGRAMS_REMOVE_VIRTUAL_FUNCTIONS_H