goto_program2code.cpp

Go to the documentation of this file.

/*******************************************************************\
 
Module: Dump Goto-Program as C/C++ Source
 
Author: Daniel Kroening, kroening@kroening.com
 
\*******************************************************************/
 
 
#include "goto_program2code.h"
 
#include <util/arith_tools.h>
#include <util/bitvector_expr.h>
#include <util/c_types.h>
#include <util/expr_util.h>
#include <util/ieee_float.h>
#include <util/pointer_expr.h>
#include <util/prefix.h>
#include <util/simplify_expr.h>
#include <util/std_code.h>
 
#include <sstream>
 
void goto_program2codet::operator()()
{
  // labels stored for cleanup
  labels_in_use.clear();
 
  // just an estimate
  toplevel_block.reserve_operands(goto_program.instructions.size());
 
  // find loops first
  build_loop_map();
 
  // gather variable scope information
  build_dead_map();
 
  // see whether var args are in use, identify va_list symbol
  scan_for_varargs();
 
  // convert
  forall_goto_program_instructions(target, goto_program)
    target=convert_instruction(
        target,
        goto_program.instructions.end(),
        toplevel_block);
 
  cleanup_code(toplevel_block, ID_nil);
}
 
void goto_program2codet::build_loop_map()
{
  loop_map.clear();
  loops.loop_map.clear();
  loops(goto_program);
 
  for(natural_loopst::loop_mapt::const_iterator
      l_it=loops.loop_map.begin();
      l_it!=loops.loop_map.end();
      ++l_it)
  {
    PRECONDITION(!l_it->second.empty());
 
    // l_it->first need not be the program-order first instruction in the
    // natural loop, because a natural loop may have multiple entries. But we
    // ignore all those before l_it->first
    // Furthermore the loop may contain code after the source of the actual back
    // edge -- we also ignore such code
    goto_programt::const_targett loop_start=l_it->first;
    goto_programt::const_targett loop_end=loop_start;
    for(natural_loopst::natural_loopt::const_iterator
        it=l_it->second.begin();
        it!=l_it->second.end();
        ++it)
      if((*it)->is_goto())
      {
        if((*it)->get_target()==loop_start &&
            (*it)->location_number>loop_end->location_number)
          loop_end=*it;
      }
 
    if(!loop_map.insert(std::make_pair(loop_start, loop_end)).second)
      UNREACHABLE;
  }
}
 
void goto_program2codet::build_dead_map()
{
  dead_map.clear();
 
  // record last dead X
  for(const auto &instruction : goto_program.instructions)
  {
    if(instruction.is_dead())
    {
      dead_map[instruction.dead_symbol().get_identifier()] =
        instruction.location_number;
    }
  }
}
 
void goto_program2codet::scan_for_varargs()
{
  va_list_expr.clear();
 
  for(const auto &instruction : goto_program.instructions)
  {
    if(instruction.is_assign())
    {
      const exprt &l = instruction.assign_lhs();
      const exprt &r = instruction.assign_rhs();
 
      // find va_start
      if(
        r.id() == ID_side_effect &&
        to_side_effect_expr(r).get_statement() == ID_va_start)
      {
        va_list_expr.insert(to_unary_expr(r).op());
      }
      // try our modelling of va_start
      else if(l.type().id()==ID_pointer &&
              l.type().get(ID_C_typedef)=="va_list" &&
              l.id()==ID_symbol &&
              r.id()==ID_typecast &&
              to_typecast_expr(r).op().id()==ID_address_of)
        va_list_expr.insert(l);
    }
  }
 
  if(!va_list_expr.empty())
    system_headers.insert("stdarg.h");
}
 
goto_programt::const_targett goto_program2codet::convert_instruction(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  PRECONDITION(target != goto_program.instructions.end());
 
  if(
    target->type() != ASSERT &&
    !target->source_location().get_comment().empty())
  {
    dest.add(code_skipt());
    dest.statements().back().add_source_location().set_comment(
      target->source_location().get_comment());
  }
 
  // try do-while first
  if(target->is_target() && !target->is_goto())
  {
    loopt::const_iterator loop_entry=loop_map.find(target);
 
    if(loop_entry!=loop_map.end() &&
        (upper_bound==goto_program.instructions.end() ||
         upper_bound->location_number > loop_entry->second->location_number))
      return convert_do_while(target, loop_entry->second, dest);
  }
 
  convert_labels(target, dest);
 
  switch(target->type())
  {
    case SKIP:
    case LOCATION:
    case END_FUNCTION:
    case DEAD:
      // ignore for now
      dest.add(code_skipt());
      return target;
 
    case FUNCTION_CALL:
    {
      code_function_callt call(
        target->call_lhs(), target->call_function(), target->call_arguments());
      dest.add(call);
    }
      return target;
 
    case OTHER:
      dest.add(target->get_other());
      return target;
 
    case ASSIGN:
      return convert_assign(target, upper_bound, dest);
 
    case SET_RETURN_VALUE:
      return convert_set_return_value(target, upper_bound, dest);
 
    case DECL:
      return convert_decl(target, upper_bound, dest);
 
    case ASSERT:
      system_headers.insert("assert.h");
      dest.add(code_assertt(target->condition()));
      dest.statements().back().add_source_location().set_comment(
        target->source_location().get_comment());
      return target;
 
    case ASSUME:
      dest.add(code_assumet(target->condition()));
      return target;
 
    case GOTO:
      return convert_goto(target, upper_bound, dest);
 
    case START_THREAD:
      return convert_start_thread(target, upper_bound, dest);
 
    case END_THREAD:
      dest.add(code_assumet(false_exprt()));
      dest.statements().back().add_source_location().set_comment("END_THREAD");
      return target;
 
    case ATOMIC_BEGIN:
    case ATOMIC_END:
      {
        const code_typet void_t({}, empty_typet());
        code_function_callt f(symbol_exprt(
          target->is_atomic_begin() ? CPROVER_PREFIX "atomic_begin"
                                    : CPROVER_PREFIX "atomic_end",
          void_t));
        dest.add(std::move(f));
        return target;
      }
 
    case THROW:
      return convert_throw(target, dest);
 
    case CATCH:
      return convert_catch(target, upper_bound, dest);
 
    case NO_INSTRUCTION_TYPE:
    case INCOMPLETE_GOTO:
      UNREACHABLE;
  }
 
  // not reached
  UNREACHABLE;
  return target;
}
 
void goto_program2codet::convert_labels(
  goto_programt::const_targett target,
  code_blockt &dest)
{
  code_blockt *latest_block = &dest;
 
  irep_idt target_label;
  if(target->is_target())
  {
    std::stringstream label;
    label << CPROVER_PREFIX "DUMP_L" << target->target_number;
    code_labelt l(label.str(), code_blockt());
    l.add_source_location() = target->source_location();
    target_label=l.get_label();
    latest_block->add(std::move(l));
    latest_block =
      &to_code_block(to_code_label(latest_block->statements().back()).code());
  }
 
  for(goto_programt::instructiont::labelst::const_iterator
      it=target->labels.begin();
      it!=target->labels.end();
      ++it)
  {
    if(
      it->starts_with(CPROVER_PREFIX "ASYNC_") ||
      it->starts_with(CPROVER_PREFIX "DUMP_L"))
    {
      continue;
    }
 
    // keep all original labels
    labels_in_use.insert(*it);
 
    code_labelt l(*it, code_blockt());
    l.add_source_location() = target->source_location();
    latest_block->add(std::move(l));
    latest_block =
      &to_code_block(to_code_label(latest_block->statements().back()).code());
  }
 
  if(latest_block!=&dest)
    latest_block->add(code_skipt());
}
 
goto_programt::const_targett goto_program2codet::convert_assign(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  const code_assignt a{target->assign_lhs(), target->assign_rhs()};
 
  if(va_list_expr.find(a.lhs())!=va_list_expr.end())
    return convert_assign_varargs(target, upper_bound, dest);
  else
    convert_assign_rec(a, dest);
 
  return target;
}
 
goto_programt::const_targett goto_program2codet::convert_assign_varargs(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  const exprt this_va_list_expr = target->assign_lhs();
  const exprt &r = skip_typecast(target->assign_rhs());
 
  if(r.is_constant() && is_null_pointer(to_constant_expr(r)))
  {
    code_function_callt f(
      symbol_exprt("va_end", code_typet({}, empty_typet())),
      {this_va_list_expr});
 
    dest.add(std::move(f));
  }
  else if(
    r.id() == ID_side_effect &&
    to_side_effect_expr(r).get_statement() == ID_va_start)
  {
    code_function_callt f(
      symbol_exprt(ID_va_start, code_typet({}, empty_typet())),
      {this_va_list_expr,
       to_address_of_expr(skip_typecast(to_unary_expr(r).op())).object()});
 
    dest.add(std::move(f));
  }
  else if(r.id() == ID_plus)
  {
    code_function_callt f(
      symbol_exprt("va_arg", code_typet({}, empty_typet())),
      {this_va_list_expr});
 
    // we do not bother to set the correct types here, they are not relevant for
    // generating the correct dumped output
    side_effect_expr_function_callt type_of(
      symbol_exprt("__typeof__", code_typet({}, empty_typet())),
      {},
      typet{},
      source_locationt{});
 
    // if the return value is used, the next instruction will be assign
    goto_programt::const_targett next=target;
    ++next;
    CHECK_RETURN(next != goto_program.instructions.end());
    if(next!=upper_bound &&
       next->is_assign())
    {
      const exprt &n_r = next->assign_rhs();
      if(
        n_r.id() == ID_dereference &&
        skip_typecast(to_dereference_expr(n_r).pointer()) == this_va_list_expr)
      {
        f.lhs() = next->assign_lhs();
 
        type_of.arguments().push_back(f.lhs());
        f.arguments().push_back(type_of);
 
        dest.add(std::move(f));
        return next;
      }
    }
 
    // assignment not found, still need a proper typeof expression
    DATA_INVARIANT(
      r.find(ID_C_va_arg_type).is_not_nil(), "#va_arg_type must be set");
    const typet &va_arg_type=
      static_cast<typet const&>(r.find(ID_C_va_arg_type));
 
    dereference_exprt deref(
      null_pointer_exprt(pointer_type(va_arg_type)),
      va_arg_type);
 
    type_of.arguments().push_back(deref);
    f.arguments().push_back(type_of);
 
    code_expressiont void_f(typecast_exprt(f, empty_typet()));
 
    dest.add(std::move(void_f));
  }
  else
  {
    code_function_callt f(
      symbol_exprt("va_copy", code_typet({}, empty_typet())),
      {this_va_list_expr, r});
 
    dest.add(std::move(f));
  }
 
  return target;
}
 
void goto_program2codet::convert_assign_rec(
  const code_assignt &assign,
  code_blockt &dest)
{
  if(assign.rhs().id()==ID_array)
  {
    const array_typet &type = to_array_type(assign.rhs().type());
 
    unsigned i=0;
    for(const auto &op : assign.rhs().operands())
    {
      index_exprt index(
        assign.lhs(),
        from_integer(i++, type.index_type()),
        type.element_type());
      convert_assign_rec(code_assignt(index, op), dest);
    }
  }
  else
    dest.add(assign);
}
 
goto_programt::const_targett goto_program2codet::convert_set_return_value(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  // add return instruction unless original code was missing a return
  if(
    target->return_value().id() != ID_side_effect ||
    to_side_effect_expr(target->return_value()).get_statement() != ID_nondet)
  {
    dest.add(code_returnt{target->return_value()});
  }
 
  // all v3 (or later) goto programs have an explicit GOTO after return
  goto_programt::const_targett next=target;
  ++next;
  CHECK_RETURN(next != goto_program.instructions.end());
 
  // skip goto (and possibly dead), unless crossing the current boundary
  while(next!=upper_bound && next->is_dead() && !next->is_target())
    ++next;
 
  if(next!=upper_bound &&
     next->is_goto() &&
     !next->is_target())
    target=next;
 
  return target;
}
 
goto_programt::const_targett goto_program2codet::convert_decl(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  code_frontend_declt d = code_frontend_declt{target->decl_symbol()};
  symbol_exprt &symbol = d.symbol();
 
  goto_programt::const_targett next=target;
  ++next;
  CHECK_RETURN(next != goto_program.instructions.end());
 
  // see if decl can go in current dest block
  dead_mapt::const_iterator entry=dead_map.find(symbol.get_identifier());
  bool move_to_dest= &toplevel_block==&dest ||
    (entry!=dead_map.end() &&
     upper_bound->location_number > entry->second);
 
  // move back initialising assignments into the decl, unless crossing the
  // current boundary
  if(next!=upper_bound &&
     move_to_dest &&
     !next->is_target() &&
     (next->is_assign() || next->is_function_call()))
  {
    exprt lhs = next->is_assign() ? next->assign_lhs() : next->call_lhs();
    if(lhs==symbol &&
       va_list_expr.find(lhs)==va_list_expr.end())
    {
      if(next->is_assign())
      {
        d.set_initial_value({next->assign_rhs()});
      }
      else
      {
        // could hack this by just erasing the first operand
        side_effect_expr_function_callt call(
          next->call_function(),
          next->call_arguments(),
          typet{},
          source_locationt{});
        d.copy_to_operands(call);
      }
 
      ++target;
      convert_labels(target, dest);
    }
    else
      remove_const(symbol.type());
  }
  // if we have a constant but can't initialize them right away, we need to
  // remove the const marker
  else
    remove_const(symbol.type());
 
  if(move_to_dest)
    dest.add(std::move(d));
  else
    toplevel_block.add(d);
 
  return target;
}
 
goto_programt::const_targett goto_program2codet::convert_do_while(
  goto_programt::const_targett target,
  goto_programt::const_targett loop_end,
  code_blockt &dest)
{
  PRECONDITION(loop_end->is_goto() && loop_end->is_backwards_goto());
 
  code_dowhilet d(loop_end->condition(), code_blockt());
  simplify(d.cond(), ns);
 
  copy_source_location(loop_end->targets.front(), d);
 
  loop_last_stack.push_back(std::make_pair(loop_end, true));
 
  for( ; target!=loop_end; ++target)
    target = convert_instruction(target, loop_end, to_code_block(d.body()));
 
  loop_last_stack.pop_back();
 
  convert_labels(loop_end, to_code_block(d.body()));
 
  dest.add(std::move(d));
  return target;
}
 
goto_programt::const_targett goto_program2codet::convert_goto(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  PRECONDITION(target->is_goto());
  // we only do one target for now
  PRECONDITION(target->targets.size() == 1);
 
  loopt::const_iterator loop_entry=loop_map.find(target);
 
  if(loop_entry!=loop_map.end() &&
      (upper_bound==goto_program.instructions.end() ||
       upper_bound->location_number > loop_entry->second->location_number))
    return convert_goto_while(target, loop_entry->second, dest);
  else if(!target->condition().is_true())
    return convert_goto_switch(target, upper_bound, dest);
  else if(!loop_last_stack.empty())
    return convert_goto_break_continue(target, upper_bound, dest);
  else
    return convert_goto_goto(target, dest);
}
 
goto_programt::const_targett goto_program2codet::convert_goto_while(
  goto_programt::const_targett target,
  goto_programt::const_targett loop_end,
  code_blockt &dest)
{
  PRECONDITION(loop_end->is_goto() && loop_end->is_backwards_goto());
 
  if(target==loop_end) // 1: GOTO 1
    return convert_goto_goto(target, dest);
 
  code_whilet w(true_exprt{}, code_blockt{});
  goto_programt::const_targett after_loop=loop_end;
  ++after_loop;
  CHECK_RETURN(after_loop != goto_program.instructions.end());
 
  copy_source_location(target, w);
 
  if(target->get_target()==after_loop)
  {
    w.cond() = not_exprt(target->condition());
    simplify(w.cond(), ns);
  }
  else if(target->condition().is_true())
  {
    target = convert_goto_goto(target, to_code_block(w.body()));
  }
  else
  {
    target = convert_goto_switch(target, loop_end, to_code_block(w.body()));
  }
 
  loop_last_stack.push_back(std::make_pair(loop_end, true));
 
  for(++target; target!=loop_end; ++target)
    target = convert_instruction(target, loop_end, to_code_block(w.body()));
 
  loop_last_stack.pop_back();
 
  convert_labels(loop_end, to_code_block(w.body()));
  if(loop_end->condition().is_false())
  {
    to_code_block(w.body()).add(code_breakt());
  }
  else if(!loop_end->condition().is_true())
  {
    code_ifthenelset i(not_exprt(loop_end->condition()), code_breakt());
    simplify(i.cond(), ns);
 
    copy_source_location(target, i);
 
    to_code_block(w.body()).add(std::move(i));
  }
 
  if(w.body().has_operands() &&
     to_code(w.body().operands().back()).get_statement()==ID_assign)
  {
    exprt increment = w.body().operands().back();
    w.body().operands().pop_back();
    increment.id(ID_side_effect);
 
    code_fort f(nil_exprt(), w.cond(), increment, w.body());
 
    copy_source_location(target, f);
 
    f.swap(w);
  }
  else if(w.body().has_operands() &&
          w.cond().is_true())
  {
    const codet &back=to_code(w.body().operands().back());
 
    if(back.get_statement()==ID_break ||
       (back.get_statement()==ID_ifthenelse &&
        to_code_ifthenelse(back).cond().is_true() &&
        to_code_ifthenelse(back).then_case().get_statement()==ID_break))
    {
      w.body().operands().pop_back();
      code_dowhilet d(false_exprt(), w.body());
 
      copy_source_location(target, d);
 
      d.swap(w);
    }
  }
 
  dest.add(std::move(w));
 
  return target;
}
 
goto_programt::const_targett goto_program2codet::get_cases(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  const exprt &switch_var,
  cases_listt &cases,
  goto_programt::const_targett &first_target,
  goto_programt::const_targett &default_target)
{
  goto_programt::const_targett last_target=goto_program.instructions.end();
  std::set<goto_programt::const_targett, goto_programt::target_less_than>
    unique_targets;
 
  goto_programt::const_targett cases_it=target;
  for( ;
      cases_it!=upper_bound && cases_it!=first_target;
      ++cases_it)
  {
    if(
      cases_it->is_goto() && !cases_it->is_backwards_goto() &&
      cases_it->condition().is_true())
    {
      default_target=cases_it->get_target();
 
      if(first_target==goto_program.instructions.end() ||
         first_target->location_number > default_target->location_number)
        first_target=default_target;
      if(last_target==goto_program.instructions.end() ||
         last_target->location_number < default_target->location_number)
        last_target=default_target;
 
      cases.push_back(caset(
          goto_program,
          nil_exprt(),
          cases_it,
          default_target));
      unique_targets.insert(default_target);
 
      ++cases_it;
      break;
    }
    else if(
      cases_it->is_goto() && !cases_it->is_backwards_goto() &&
      (cases_it->condition().id() == ID_equal ||
       cases_it->condition().id() == ID_or))
    {
      exprt::operandst eqs;
      if(cases_it->condition().id() == ID_equal)
        eqs.push_back(cases_it->condition());
      else
        eqs = cases_it->condition().operands();
 
      // goto conversion builds disjunctions in reverse order
      // to ensure convergence, we turn this around again
      for(exprt::operandst::const_reverse_iterator
          e_it=eqs.rbegin();
          e_it!=(exprt::operandst::const_reverse_iterator)eqs.rend();
          ++e_it)
      {
        if(e_it->id()!=ID_equal ||
           !skip_typecast(to_equal_expr(*e_it).rhs()).is_constant() ||
           switch_var!=to_equal_expr(*e_it).lhs())
          return target;
 
        cases.push_back(caset(
            goto_program,
            to_equal_expr(*e_it).rhs(),
            cases_it,
            cases_it->get_target()));
        DATA_INVARIANT(cases.back().value.is_not_nil(), "cases should be set");
 
        if(first_target==goto_program.instructions.end() ||
           first_target->location_number>
           cases.back().case_start->location_number)
          first_target=cases.back().case_start;
        if(last_target==goto_program.instructions.end() ||
           last_target->location_number<
           cases.back().case_start->location_number)
          last_target=cases.back().case_start;
 
        unique_targets.insert(cases.back().case_start);
      }
    }
    else
      return target;
  }
 
  // if there are less than 3 targets, we revert to if/else instead; this should
  // help convergence
  if(unique_targets.size()<3)
    return target;
 
  // make sure we don't have some overlap of gotos and switch/case
  if(cases_it==upper_bound ||
     (upper_bound!=goto_program.instructions.end() &&
      upper_bound->location_number < last_target->location_number) ||
     (last_target!=goto_program.instructions.end() &&
      last_target->location_number > default_target->location_number) ||
     target->get_target()==default_target)
    return target;
 
  return cases_it;
}
 
bool goto_program2codet::set_block_end_points(
  goto_programt::const_targett upper_bound,
  const cfg_dominatorst &dominators,
  cases_listt &cases,
  std::set<unsigned> &processed_locations)
{
  std::set<goto_programt::const_targett, goto_programt::target_less_than>
    targets_done;
 
  for(cases_listt::iterator it=cases.begin();
      it!=cases.end();
      ++it)
  {
    // some branch targets may be shared by multiple branch instructions,
    // as in case 1: case 2: code; we build a nested code_switch_caset
    if(!targets_done.insert(it->case_start).second)
      continue;
 
    // compute the block that belongs to this case
    for(goto_programt::const_targett case_end = it->case_start;
        case_end != goto_program.instructions.end() &&
        case_end->type() != END_FUNCTION && case_end != upper_bound;
        ++case_end)
    {
      const auto &case_end_node = dominators.get_node(case_end);
 
      // ignore dead instructions for the following checks
      if(!dominators.program_point_reachable(case_end_node))
      {
        // simplification may have figured out that a case is unreachable
        // this is possibly getting too weird, abort to be safe
        if(case_end==it->case_start)
          return true;
 
        continue;
      }
 
      // find the last instruction dominated by the case start
      if(!dominators.dominates(it->case_start, case_end_node))
        break;
 
      if(!processed_locations.insert(case_end->location_number).second)
        UNREACHABLE;
 
      it->case_last=case_end;
    }
  }
 
  return false;
}
 
bool goto_program2codet::remove_default(
  const cfg_dominatorst &dominators,
  const cases_listt &cases,
  goto_programt::const_targett default_target)
{
  for(cases_listt::const_iterator it=cases.begin();
      it!=cases.end();
      ++it)
  {
    // ignore empty cases
    if(it->case_last==goto_program.instructions.end())
      continue;
 
    // the last case before default is the most interesting
    cases_listt::const_iterator last=--cases.end();
    if(last->case_start==default_target &&
       it==--last)
    {
      // ignore dead instructions for the following checks
      goto_programt::const_targett next_case=it->case_last;
      for(++next_case;
          next_case!=goto_program.instructions.end();
          ++next_case)
      {
        if(dominators.program_point_reachable(next_case))
          break;
      }
 
      if(
        next_case != goto_program.instructions.end() &&
        next_case == default_target &&
        (!it->case_last->is_goto() ||
         (it->case_last->condition().is_true() &&
          it->case_last->get_target() == default_target)))
      {
        // if there is no goto here, yet we got here, all others would
        // branch to this - we don't need default
        return true;
      }
    }
 
    // jumps to default are ok
    if(
      it->case_last->is_goto() && it->case_last->condition().is_true() &&
      it->case_last->get_target() == default_target)
      continue;
 
    // fall-through is ok
    if(!it->case_last->is_goto())
      continue;
 
    return false;
  }
 
  return false;
}
 
goto_programt::const_targett goto_program2codet::convert_goto_switch(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  // try to figure out whether this was a switch/case
  exprt eq_cand = target->condition();
  if(eq_cand.id()==ID_or)
    eq_cand = to_or_expr(eq_cand).op0();
 
  if(target->is_backwards_goto() ||
     eq_cand.id()!=ID_equal ||
     !skip_typecast(to_equal_expr(eq_cand).rhs()).is_constant())
    return convert_goto_if(target, upper_bound, dest);
 
  const cfg_dominatorst &dominators=loops.get_dominator_info();
 
  // always use convert_goto_if for dead code as the construction below relies
  // on effective dominator information
  if(!dominators.program_point_reachable(target))
    return convert_goto_if(target, upper_bound, dest);
 
  // maybe, let's try some more
  code_switcht s(to_equal_expr(eq_cand).lhs(), code_blockt());
 
  copy_source_location(target, s);
 
  // find the cases or fall back to convert_goto_if
  cases_listt cases;
  goto_programt::const_targett first_target=
    goto_program.instructions.end();
  goto_programt::const_targett default_target=
    goto_program.instructions.end();
 
  goto_programt::const_targett cases_start=
    get_cases(
      target,
      upper_bound,
      s.value(),
      cases,
      first_target,
      default_target);
 
  if(cases_start==target)
    return convert_goto_if(target, upper_bound, dest);
 
  // backup the top-level block as we might have to backtrack
  code_blockt toplevel_block_bak=toplevel_block;
 
  // add any instructions that go in the body of the switch before any cases
  goto_programt::const_targett orig_target=target;
  for(target=cases_start; target!=first_target; ++target)
    target = convert_instruction(target, first_target, to_code_block(s.body()));
 
  std::set<unsigned> processed_locations;
 
  // iterate over all cases to identify block end points
  if(set_block_end_points(upper_bound, dominators, cases, processed_locations))
  {
    toplevel_block.swap(toplevel_block_bak);
    return convert_goto_if(orig_target, upper_bound, dest);
  }
 
  // figure out whether we really had a default target by testing
  // whether all cases eventually jump to the default case
  if(remove_default(dominators, cases, default_target))
  {
    cases.pop_back();
    default_target=goto_program.instructions.end();
  }
 
  // find the last instruction belonging to any of the cases
  goto_programt::const_targett max_target=target;
  for(cases_listt::const_iterator it=cases.begin();
      it!=cases.end();
      ++it)
    if(it->case_last!=goto_program.instructions.end() &&
       it->case_last->location_number > max_target->location_number)
      max_target=it->case_last;
 
  std::
    map<goto_programt::const_targett, unsigned, goto_programt::target_less_than>
      targets_done;
  loop_last_stack.push_back(std::make_pair(max_target, false));
 
  // iterate over all <branch conditions, branch instruction, branch target>
  // triples, build their corresponding code
  for(cases_listt::const_iterator it=cases.begin();
      it!=cases.end();
      ++it)
  {
    code_switch_caset csc(nil_exprt{}, code_blockt{});
    // branch condition is nil_exprt for default case;
    if(it->value.is_nil())
      csc.set_default();
    else
      csc.case_op()=it->value;
 
    // some branch targets may be shared by multiple branch instructions,
    // as in case 1: case 2: code; we build a nested code_switch_caset
    if(targets_done.find(it->case_start)!=targets_done.end())
    {
      DATA_INVARIANT(
        it->case_selector == orig_target || !it->case_selector->is_target(),
        "valid case selector required");
 
      // maintain the order to ensure convergence -> go to the innermost
      code_switch_caset *cscp=&to_code_switch_case(
        to_code(s.body().operands()[targets_done[it->case_start]]));
      while(cscp->code().get_statement()==ID_switch_case)
        cscp=&to_code_switch_case(cscp->code());
 
      csc.code().swap(cscp->code());
      cscp->code().swap(csc);
 
      continue;
    }
 
    code_blockt c;
    if(it->case_selector!=orig_target)
      convert_labels(it->case_selector, c);
 
    // convert the block that belongs to this case
    target=it->case_start;
 
    // empty case
    if(it->case_last==goto_program.instructions.end())
    {
      // only emit the jump out of the switch if it's not the last case
      // this improves convergence
      if(it->case_start!=(--cases.end())->case_start)
      {
        UNREACHABLE;
        goto_programt::instructiont i=*(it->case_selector);
        i.condition_nonconst() = true_exprt();
        goto_programt tmp;
        tmp.insert_before_swap(tmp.insert_before(tmp.instructions.end()), i);
        convert_goto_goto(tmp.instructions.begin(), c);
      }
    }
    else
    {
      goto_programt::const_targett after_last=it->case_last;
      ++after_last;
      for( ; target!=after_last; ++target)
        target=convert_instruction(target, after_last, c);
    }
 
    csc.code().swap(c);
    targets_done[it->case_start]=s.body().operands().size();
    to_code_block(s.body()).add(std::move(csc));
  }
 
  loop_last_stack.pop_back();
 
  // make sure we didn't miss any non-dead instruction
  for(goto_programt::const_targett it=first_target;
      it!=target;
      ++it)
    if(processed_locations.find(it->location_number)==
        processed_locations.end())
    {
      if(dominators.program_point_reachable(it))
      {
        toplevel_block.swap(toplevel_block_bak);
        return convert_goto_if(orig_target, upper_bound, dest);
      }
    }
 
  dest.add(std::move(s));
  return max_target;
}
 
goto_programt::const_targett goto_program2codet::convert_goto_if(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  goto_programt::const_targett else_case=target->get_target();
  goto_programt::const_targett before_else=else_case;
  goto_programt::const_targett end_if=target->get_target();
  PRECONDITION(end_if != goto_program.instructions.end());
  bool has_else=false;
 
  if(!target->is_backwards_goto())
  {
    PRECONDITION(else_case != goto_program.instructions.begin());
    --before_else;
 
    // goto 1
    // 1: ...
    if(before_else==target)
    {
      dest.add(code_skipt());
      return target;
    }
 
    has_else =
      before_else->is_goto() &&
      before_else->get_target()->location_number > end_if->location_number &&
      before_else->condition().is_true() &&
      (upper_bound == goto_program.instructions.end() ||
       upper_bound->location_number >=
         before_else->get_target()->location_number);
 
    if(has_else)
      end_if=before_else->get_target();
  }
 
  // some nesting of loops and branches we might not be able to deal with
  if(target->is_backwards_goto() ||
      (upper_bound!=goto_program.instructions.end() &&
       upper_bound->location_number < end_if->location_number))
  {
    if(!loop_last_stack.empty())
      return convert_goto_break_continue(target, upper_bound, dest);
    else
      return convert_goto_goto(target, dest);
  }
 
  code_ifthenelset i(not_exprt(target->condition()), code_blockt());
  copy_source_location(target, i);
  simplify(i.cond(), ns);
 
  if(has_else)
    i.else_case()=code_blockt();
 
  if(has_else)
  {
    for(++target; target!=before_else; ++target)
      target =
        convert_instruction(target, before_else, to_code_block(i.then_case()));
 
    convert_labels(before_else, to_code_block(i.then_case()));
 
    for(++target; target!=end_if; ++target)
      target =
        convert_instruction(target, end_if, to_code_block(i.else_case()));
  }
  else
  {
    for(++target; target!=end_if; ++target)
      target =
        convert_instruction(target, end_if, to_code_block(i.then_case()));
  }
 
  dest.add(std::move(i));
  return --target;
}
 
goto_programt::const_targett goto_program2codet::convert_goto_break_continue(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  PRECONDITION(!loop_last_stack.empty());
  const cfg_dominatorst &dominators=loops.get_dominator_info();
 
  // goto 1
  // 1: ...
  goto_programt::const_targett next=target;
  for(++next;
      next!=upper_bound && next!=goto_program.instructions.end();
      ++next)
  {
    if(dominators.program_point_reachable(next))
      break;
  }
 
  if(target->get_target()==next)
  {
    dest.add(code_skipt());
    // skip over all dead instructions
    return --next;
  }
 
  goto_programt::const_targett loop_end=loop_last_stack.back().first;
 
  if(target->get_target()==loop_end &&
     loop_last_stack.back().second)
  {
    code_ifthenelset i(target->condition(), code_continuet());
    simplify(i.cond(), ns);
 
    copy_source_location(target, i);
 
    if(i.cond().is_true())
      dest.add(std::move(i.then_case()));
    else
      dest.add(std::move(i));
 
    return target;
  }
 
  goto_programt::const_targett after_loop=loop_end;
  for(++after_loop;
      after_loop!=goto_program.instructions.end();
      ++after_loop)
  {
    if(dominators.program_point_reachable(after_loop))
      break;
  }
 
  if(target->get_target()==after_loop)
  {
    code_ifthenelset i(target->condition(), code_breakt());
    simplify(i.cond(), ns);
 
    copy_source_location(target, i);
 
    if(i.cond().is_true())
      dest.add(std::move(i.then_case()));
    else
      dest.add(std::move(i));
 
    return target;
  }
 
  return convert_goto_goto(target, dest);
}
 
goto_programt::const_targett goto_program2codet::convert_goto_goto(
  goto_programt::const_targett target,
  code_blockt &dest)
{
  // filter out useless goto 1; 1: ...
  goto_programt::const_targett next=target;
  ++next;
  if(target->get_target()==next)
    return target;
 
  const cfg_dominatorst &dominators=loops.get_dominator_info();
 
  // skip dead goto L as the label might be skipped if it is dead
  // as well and at the end of a case block
  if(!dominators.program_point_reachable(target))
    return target;
 
  std::stringstream label;
  // try user-defined labels first
  for(goto_programt::instructiont::labelst::const_iterator
      it=target->get_target()->labels.begin();
      it!=target->get_target()->labels.end();
      ++it)
  {
    if(
      it->starts_with(CPROVER_PREFIX "ASYNC_") ||
      it->starts_with(CPROVER_PREFIX "DUMP_L"))
    {
      continue;
    }
 
    label << *it;
    break;
  }
 
  if(label.str().empty())
    label << CPROVER_PREFIX "DUMP_L" << target->get_target()->target_number;
 
  labels_in_use.insert(label.str());
 
  code_gotot goto_code(label.str());
 
  code_ifthenelset i(target->condition(), std::move(goto_code));
  simplify(i.cond(), ns);
 
  copy_source_location(target, i);
 
  if(i.cond().is_true())
    dest.add(std::move(i.then_case()));
  else
    dest.add(std::move(i));
 
  return target;
}
 
goto_programt::const_targett goto_program2codet::convert_start_thread(
  goto_programt::const_targett target,
  goto_programt::const_targett upper_bound,
  code_blockt &dest)
{
  PRECONDITION(target->is_start_thread());
 
  goto_programt::const_targett thread_start=target->get_target();
  PRECONDITION(thread_start->location_number > target->location_number);
 
  goto_programt::const_targett next=target;
  ++next;
  CHECK_RETURN(next != goto_program.instructions.end());
 
  // first check for old-style code:
  // __CPROVER_DUMP_0: START THREAD 1
  // code in existing thread
  // END THREAD
  // 1: code in new thread
  if(!next->is_goto())
  {
    goto_programt::const_targett this_end=next;
    ++this_end;
    DATA_INVARIANT(this_end->is_end_thread(), "should be end-of-thread");
    DATA_INVARIANT(
      thread_start->location_number > this_end->location_number,
      "start of new thread must precede end of thread");
 
    codet b=code_blockt();
    convert_instruction(next, this_end, to_code_block(b));
 
    for(goto_programt::instructiont::labelst::const_iterator
        it=target->labels.begin();
        it!=target->labels.end();
        ++it)
      if(it->starts_with(CPROVER_PREFIX "ASYNC_"))
      {
        labels_in_use.insert(*it);
 
        code_labelt l(*it, std::move(b));
        l.add_source_location() = target->source_location();
        b = std::move(l);
      }
 
    DATA_INVARIANT(b.get_statement() == ID_label, "must be label statement");
    dest.add(std::move(b));
    return this_end;
  }
 
  // code is supposed to look like this:
  // __CPROVER_ASYNC_0: START THREAD 1
  // GOTO 2
  // 1: code in new thread
  // END THREAD
  // 2: code in existing thread
  /* check the structure and compute the iterators */
  DATA_INVARIANT(
    next->is_goto() && next->condition().is_true(), "START THREAD pattern");
  DATA_INVARIANT(!next->is_backwards_goto(), "START THREAD pattern");
  DATA_INVARIANT(
    thread_start->location_number < next->get_target()->location_number,
    "START THREAD pattern");
  goto_programt::const_targett after_thread_start=thread_start;
  ++after_thread_start;
 
  goto_programt::const_targett thread_end=next->get_target();
  --thread_end;
  DATA_INVARIANT(
    thread_start->location_number < thread_end->location_number,
    "monotone location numbers");
  DATA_INVARIANT(thread_end->is_end_thread(), "should be end-of-thread");
 
  DATA_INVARIANT(
    upper_bound == goto_program.instructions.end() ||
      thread_end->location_number < upper_bound->location_number,
    "end or monotone location numbers");
  /* end structure check */
 
  // use pthreads if "code in new thread" is a function call to a function with
  // suitable signature
  if(
    thread_start->is_function_call() &&
    thread_start->call_arguments().size() == 1 &&
    after_thread_start == thread_end)
  {
    system_headers.insert("pthread.h");
 
    const null_pointer_exprt n(pointer_type(empty_typet()));
    dest.add(code_function_callt(
      thread_start->call_lhs(),
      symbol_exprt("pthread_create", code_typet({}, empty_typet())),
      {n,
       n,
       thread_start->call_function(),
       thread_start->call_arguments().front()}));
 
    return thread_end;
  }
 
  codet b=code_blockt();
  for( ; thread_start!=thread_end; ++thread_start)
    thread_start =
      convert_instruction(thread_start, upper_bound, to_code_block(b));
 
  for(goto_programt::instructiont::labelst::const_iterator
      it=target->labels.begin();
      it!=target->labels.end();
      ++it)
    if(it->starts_with(CPROVER_PREFIX "ASYNC_"))
    {
      labels_in_use.insert(*it);
 
      code_labelt l(*it, std::move(b));
      l.add_source_location() = target->source_location();
      b = std::move(l);
    }
 
  DATA_INVARIANT(b.get_statement() == ID_label, "should be label statement");
  dest.add(std::move(b));
  return thread_end;
}
 
goto_programt::const_targett goto_program2codet::convert_throw(
  goto_programt::const_targett target,
  code_blockt &)
{
  // this isn't really clear as throw is not supported in expr2cpp either
  UNREACHABLE;
  return target;
}
 
goto_programt::const_targett goto_program2codet::convert_catch(
  goto_programt::const_targett target,
  goto_programt::const_targett,
  code_blockt &)
{
  // this isn't really clear as catch is not supported in expr2cpp either
  UNREACHABLE;
  return target;
}
 
void goto_program2codet::add_local_types(const typet &type)
{
  if(type.id() == ID_struct_tag || type.id() == ID_union_tag)
  {
    const irep_idt &identifier = to_tag_type(type).get_identifier();
    const symbolt &symbol = ns.lookup(identifier);
 
    if(
      symbol.location.get_function().empty() ||
      !type_names_set.insert(identifier).second)
      return;
 
    const auto &components =
      ns.follow_tag(to_struct_or_union_tag_type(type)).components();
    for(const auto &c : components)
      add_local_types(c.type());
 
    type_names.push_back(identifier);
  }
  else if(type.id()==ID_c_enum_tag)
  {
    const irep_idt &identifier=to_c_enum_tag_type(type).get_identifier();
    const symbolt &symbol=ns.lookup(identifier);
 
    if(symbol.location.get_function().empty() ||
       !type_names_set.insert(identifier).second)
      return;
 
    DATA_INVARIANT(!identifier.empty(), "identifier required");
    type_names.push_back(identifier);
  }
  else if(type.id()==ID_pointer ||
          type.id()==ID_array)
  {
    add_local_types(to_type_with_subtype(type).subtype());
  }
}
 
void goto_program2codet::cleanup_code(
    codet &code,
    const irep_idt parent_stmt)
{
  if(code.get_statement()==ID_decl)
  {
    if(code.operands().size()==2 &&
       code.op1().id()==ID_side_effect &&
       to_side_effect_expr(code.op1()).get_statement()==ID_function_call)
    {
      side_effect_expr_function_callt &call=
        to_side_effect_expr_function_call(code.op1());
      cleanup_function_call(call.function(), call.arguments());
 
      cleanup_expr(code.op1(), false);
    }
    else
      Forall_operands(it, code)
        cleanup_expr(*it, true);
 
    if(code.op0().type().id()==ID_array)
      cleanup_expr(to_array_type(code.op0().type()).size(), true);
    else if(code.op0().type().id() == ID_c_bit_field)
    {
      c_bit_field_typet original_type = to_c_bit_field_type(code.op0().type());
      bitvector_typet bv_type =
        to_bitvector_type(original_type.underlying_type());
      code.op0().type() = bv_type;
      if(code.operands().size() == 2)
      {
        exprt bit_mask =
          from_integer(power(2, original_type.get_width()) - 1, bv_type);
        code.op1() = bitand_exprt{code.op1(), bit_mask};
      }
    }
 
    add_local_types(code.op0().type());
 
    const irep_idt &typedef_str=code.op0().type().get(ID_C_typedef);
    if(!typedef_str.empty() &&
       typedef_names.find(typedef_str)==typedef_names.end())
      code.op0().type().remove(ID_C_typedef);
 
    return;
  }
  else if(code.get_statement()==ID_function_call)
  {
    code_function_callt &call=to_code_function_call(code);
 
    cleanup_function_call(call.function(), call.arguments());
 
    while(call.lhs().is_not_nil() &&
          call.lhs().id()==ID_typecast)
      call.lhs()=to_typecast_expr(call.lhs()).op();
  }
 
  if(code.has_operands())
  {
    for(auto &op : code.operands())
    {
      if(op.id() == ID_code)
        cleanup_code(to_code(op), code.get_statement());
      else
        cleanup_expr(op, false);
    }
  }
 
  const irep_idt &statement=code.get_statement();
  if(statement==ID_label)
  {
    code_labelt &cl=to_code_label(code);
    const irep_idt &label=cl.get_label();
 
    DATA_INVARIANT(!label.empty(), "label must be set");
 
    if(labels_in_use.find(label)==labels_in_use.end())
    {
      codet tmp = cl.code();
      code.swap(tmp);
    }
  }
  else if(statement==ID_block)
    cleanup_code_block(code, parent_stmt);
  else if(statement==ID_ifthenelse)
    cleanup_code_ifthenelse(code, parent_stmt);
  else if(statement==ID_dowhile)
  {
    code_dowhilet &do_while=to_code_dowhile(code);
 
    // turn an empty do {} while(...); into a while(...);
    // to ensure convergence
    if(do_while.body().get_statement()==ID_skip)
      do_while.set_statement(ID_while);
    // do stmt while(false) is just stmt
    else if(do_while.cond().is_false() &&
            do_while.body().get_statement()!=ID_block)
      code=do_while.body();
  }
}
 
void goto_program2codet::cleanup_function_call(
  const exprt &function,
  code_function_callt::argumentst &arguments)
{
  if(function.id()!=ID_symbol)
    return;
 
  const symbol_exprt &fn=to_symbol_expr(function);
 
  // don't edit function calls we might have introduced
  const symbolt *s;
  if(!ns.lookup(fn.get_identifier(), s))
  {
    const symbolt &fn_sym=ns.lookup(fn.get_identifier());
    const code_typet &code_type=to_code_type(fn_sym.type);
    const code_typet::parameterst &parameters=code_type.parameters();
 
    if(parameters.size()==arguments.size())
    {
      code_typet::parameterst::const_iterator it=parameters.begin();
      for(auto &argument : arguments)
      {
        if(
          argument.type().id() == ID_union ||
          argument.type().id() == ID_union_tag)
        {
          argument.type() = it->type();
        }
        ++it;
      }
    }
  }
}
 
void goto_program2codet::cleanup_code_block(
    codet &code,
    const irep_idt parent_stmt)
{
  PRECONDITION(code.get_statement() == ID_block);
 
  exprt::operandst &operands=code.operands();
  for(exprt::operandst::size_type i=0;
      operands.size()>1 && i<operands.size();
     ) // no ++i
  {
    exprt::operandst::iterator it=operands.begin()+i;
    // remove skip
    if(to_code(*it).get_statement()==ID_skip &&
       it->source_location().get_comment().empty())
      operands.erase(it);
    // merge nested blocks, unless there are declarations in the inner block
    else if(to_code(*it).get_statement()==ID_block)
    {
      bool has_decl=false;
      for(const auto &op : as_const(*it).operands())
      {
        if(op.id() == ID_code && to_code(op).get_statement() == ID_decl)
        {
          has_decl=true;
          break;
        }
      }
 
      if(!has_decl)
      {
        operands.insert(operands.begin()+i+1,
            it->operands().begin(), it->operands().end());
        operands.erase(operands.begin()+i);
        // no ++i
      }
      else
        ++i;
    }
    else
      ++i;
  }
 
  if(operands.empty() && parent_stmt!=ID_nil)
    code=code_skipt();
  else if(operands.size()==1 &&
          parent_stmt!=ID_nil &&
          to_code(code.op0()).get_statement()!=ID_decl)
  {
    codet tmp = to_code(code.op0());
    code.swap(tmp);
  }
}
 
void goto_program2codet::remove_const(typet &type)
{
  if(type.get_bool(ID_C_constant))
    type.remove(ID_C_constant);
 
  if(type.id() == ID_struct_tag || type.id() == ID_union_tag)
  {
    const irep_idt &identifier = to_tag_type(type).get_identifier();
    if(!const_removed.insert(identifier).second)
      return;
 
    symbolt &symbol = symbol_table.get_writeable_ref(identifier);
    INVARIANT(
      symbol.is_type,
      "Symbol "+id2string(identifier)+" should be a type");
 
    remove_const(symbol.type);
  }
  else if(type.id()==ID_array)
    remove_const(to_array_type(type).element_type());
  else if(type.id()==ID_struct ||
          type.id()==ID_union)
  {
    struct_union_typet &sut=to_struct_union_type(type);
    struct_union_typet::componentst &c=sut.components();
 
    for(struct_union_typet::componentst::iterator
        it=c.begin();
        it!=c.end();
        ++it)
      remove_const(it->type());
  }
  else if(type.id() == ID_c_bit_field)
  {
    to_c_bit_field_type(type).underlying_type().remove(ID_C_constant);
  }
}
 
static bool has_labels(const codet &code)
{
  if(code.get_statement()==ID_label)
    return true;
 
  for(const auto &op : code.operands())
  {
    if(op.id() == ID_code && has_labels(to_code(op)))
      return true;
  }
 
  return false;
}
 
static bool move_label_ifthenelse(exprt &expr, exprt &label_dest)
{
  if(expr.is_nil() || to_code(expr).get_statement() != ID_block)
    return false;
 
  code_blockt &block=to_code_block(to_code(expr));
  if(
    !block.has_operands() ||
    block.statements().back().get_statement() != ID_label)
  {
    return false;
  }
 
  code_labelt &label = to_code_label(block.statements().back());
 
  if(label.get_label().empty() ||
      label.code().get_statement()!=ID_skip)
  {
    return false;
  }
 
  label_dest=label;
  code_skipt s;
  label.swap(s);
 
  return true;
}
 
void goto_program2codet::cleanup_code_ifthenelse(
  codet &code,
  const irep_idt parent_stmt)
{
  code_ifthenelset &i_t_e=to_code_ifthenelse(code);
  const exprt cond=simplify_expr(i_t_e.cond(), ns);
 
  // assert(false) expands to if(true) assert(false), simplify again (and also
  // simplify other cases)
  if(
    cond.is_true() &&
    (i_t_e.else_case().is_nil() || !has_labels(i_t_e.else_case())))
  {
    codet tmp = i_t_e.then_case();
    code.swap(tmp);
  }
  else if(cond.is_false() && !has_labels(i_t_e.then_case()))
  {
    if(i_t_e.else_case().is_nil())
      code=code_skipt();
    else
    {
      codet tmp = i_t_e.else_case();
      code.swap(tmp);
    }
  }
  else
  {
    if(
      i_t_e.then_case().is_not_nil() &&
      i_t_e.then_case().get_statement() == ID_ifthenelse)
    {
      // we re-introduce 1-code blocks with if-then-else to avoid dangling-else
      // ambiguity
      i_t_e.then_case() = code_blockt({i_t_e.then_case()});
    }
 
    if(
      i_t_e.else_case().is_not_nil() &&
      i_t_e.then_case().get_statement() == ID_skip &&
      i_t_e.else_case().get_statement() == ID_ifthenelse)
    {
      // we re-introduce 1-code blocks with if-then-else to avoid dangling-else
      // ambiguity
      i_t_e.else_case() = code_blockt({i_t_e.else_case()});
    }
  }
 
  // move labels at end of then or else case out
  if(code.get_statement()==ID_ifthenelse)
  {
    codet then_label=code_skipt(), else_label=code_skipt();
 
    bool moved=false;
    if(i_t_e.then_case().is_not_nil())
      moved|=move_label_ifthenelse(i_t_e.then_case(), then_label);
    if(i_t_e.else_case().is_not_nil())
      moved|=move_label_ifthenelse(i_t_e.else_case(), else_label);
 
    if(moved)
    {
      code = code_blockt({i_t_e, then_label, else_label});
      cleanup_code(code, parent_stmt);
    }
  }
 
  // remove empty then/else
  if(
    code.get_statement() == ID_ifthenelse &&
    i_t_e.then_case().get_statement() == ID_skip)
  {
    not_exprt tmp(i_t_e.cond());
    simplify(tmp, ns);
    // simplification might have removed essential type casts
    cleanup_expr(tmp, false);
    i_t_e.cond().swap(tmp);
    i_t_e.then_case().swap(i_t_e.else_case());
  }
  if(
    code.get_statement() == ID_ifthenelse && i_t_e.else_case().is_not_nil() &&
    i_t_e.else_case().get_statement() == ID_skip)
    i_t_e.else_case().make_nil();
  // or even remove the if altogether if the then case is now empty
  if(
    code.get_statement() == ID_ifthenelse && i_t_e.else_case().is_nil() &&
    (i_t_e.then_case().is_nil() ||
     i_t_e.then_case().get_statement() == ID_skip))
    code=code_skipt();
}
 
void goto_program2codet::cleanup_expr(exprt &expr, bool no_typecast)
{
  // we might have to do array -> pointer conversions
  if(no_typecast &&
     (expr.id()==ID_address_of || expr.id()==ID_member))
  {
    Forall_operands(it, expr)
      cleanup_expr(*it, false);
  }
  else if(!no_typecast &&
          (expr.id()==ID_union || expr.id()==ID_struct ||
           expr.id()==ID_array || expr.id()==ID_vector))
  {
    Forall_operands(it, expr)
      cleanup_expr(*it, true);
  }
  else
  {
    Forall_operands(it, expr)
      cleanup_expr(*it, no_typecast);
  }
 
  // work around transparent union argument
  if(
    expr.id() == ID_union && expr.type().id() != ID_union &&
    expr.type().id() != ID_union_tag)
  {
    expr=to_union_expr(expr).op();
  }
 
  // try to get rid of type casts, revealing (char)97 -> 'a'
  if(expr.id()==ID_typecast &&
     to_typecast_expr(expr).op().is_constant())
    simplify(expr, ns);
 
  if(expr.id()==ID_union ||
     expr.id()==ID_struct)
  {
    if(no_typecast)
      return;
 
    DATA_INVARIANT(
      expr.type().id() == ID_struct_tag || expr.type().id() == ID_union_tag,
      "union/struct expressions should have a tag type");
 
    const typet &t=expr.type();
 
    add_local_types(t);
    expr=typecast_exprt(expr, t);
 
    const irep_idt &typedef_str=expr.type().get(ID_C_typedef);
    if(!typedef_str.empty() &&
       typedef_names.find(typedef_str)==typedef_names.end())
      expr.type().remove(ID_C_typedef);
  }
  else if(expr.id()==ID_array ||
          expr.id()==ID_vector)
  {
    if(no_typecast ||
       expr.get_bool(ID_C_string_constant))
      return;
 
    const typet &t=expr.type();
 
    expr = typecast_exprt(expr, t);
    add_local_types(t);
 
    const irep_idt &typedef_str=expr.type().get(ID_C_typedef);
    if(!typedef_str.empty() &&
       typedef_names.find(typedef_str)==typedef_names.end())
      expr.type().remove(ID_C_typedef);
  }
  else if(expr.id()==ID_side_effect)
  {
    const irep_idt &statement=to_side_effect_expr(expr).get_statement();
 
    if(statement==ID_nondet)
    {
      // Replace by a function call to nondet_...
      // We first search for a suitable one in the symbol table.
 
      irep_idt id;
 
      for(symbol_tablet::symbolst::const_iterator
          it=symbol_table.symbols.begin();
          it!=symbol_table.symbols.end();
          it++)
      {
        if(it->second.type.id()!=ID_code)
          continue;
        if(!it->second.base_name.starts_with("nondet_"))
          continue;
        const code_typet &code_type=to_code_type(it->second.type);
        if(code_type.return_type() != expr.type())
          continue;
        if(!code_type.parameters().empty())
          continue;
        id=it->second.name;
        break;
      }
 
      // none found? make one
 
      if(id.empty())
      {
        irep_idt base_name;
 
        if(!expr.type().get(ID_C_c_type).empty())
        {
          irep_idt suffix;
          suffix=expr.type().get(ID_C_c_type);
 
          if(symbol_table.symbols.find("nondet_"+id2string(suffix))==
             symbol_table.symbols.end())
            base_name="nondet_"+id2string(suffix);
        }
 
        if(base_name.empty())
        {
          unsigned count=0;
          while(symbol_table.symbols.find("nondet_"+std::to_string(count))!=
                symbol_table.symbols.end())
            ++count;
          base_name="nondet_"+std::to_string(count);
        }
 
        symbolt symbol{base_name, code_typet({}, expr.type()), ID_C};
        symbol.base_name=base_name;
        id=symbol.name;
 
        symbol_table.insert(std::move(symbol));
      }
 
      const symbolt &symbol=ns.lookup(id);
 
      symbol_exprt symbol_expr(symbol.name, symbol.type);
      symbol_expr.add_source_location()=expr.source_location();
 
      side_effect_expr_function_callt call(
        symbol_expr, {}, expr.type(), expr.source_location());
 
      expr.swap(call);
    }
  }
  else if(expr.id()==ID_isnan ||
          expr.id()==ID_sign)
    system_headers.insert("math.h");
  else if(expr.is_constant())
  {
    if(expr.type().id()==ID_floatbv)
    {
      const ieee_floatt f(to_constant_expr(expr));
      if(f.is_NaN() || f.is_infinity())
        system_headers.insert("math.h");
    }
    else if(expr.type().id()==ID_pointer)
      add_local_types(expr.type());
 
    const irept &c_sizeof_type=expr.find(ID_C_c_sizeof_type);
 
    if(c_sizeof_type.is_not_nil())
      add_local_types(static_cast<const typet &>(c_sizeof_type));
  }
  else if(expr.id()==ID_typecast)
  {
    if(expr.type().id() == ID_c_bit_field)
      expr=to_typecast_expr(expr).op();
    else
    {
      add_local_types(expr.type());
 
      const irep_idt &typedef_str=expr.type().get(ID_C_typedef);
      if(!typedef_str.empty() &&
         typedef_names.find(typedef_str)==typedef_names.end())
        expr.type().remove(ID_C_typedef);
 
      DATA_INVARIANT(
        !can_cast_type<struct_union_typet>(expr.type()),
        "typedef must not be that of a struct or union type");
    }
  }
  else if(expr.id()==ID_symbol)
  {
    if(expr.type().id()!=ID_code)
    {
      const irep_idt &identifier=to_symbol_expr(expr).get_identifier();
      const symbolt &symbol=ns.lookup(identifier);
 
      if(symbol.is_static_lifetime &&
         symbol.type.id()!=ID_code &&
         !symbol.is_extern &&
         !symbol.location.get_function().empty() &&
         local_static_set.insert(identifier).second)
      {
        if(symbol.value.is_not_nil())
        {
          exprt value=symbol.value;
          cleanup_expr(value, true);
        }
 
        local_static.push_back(identifier);
      }
    }
  }
}
 
void goto_program2codet::copy_source_location(
  goto_programt::const_targett src,
  codet &dst)
{
  if(src->code().source_location().is_not_nil())
    dst.add_source_location() = src->code().source_location();
  else if(src->source_location().is_not_nil())
    dst.add_source_location() = src->source_location();
}