cprover
goto_convert_functions.cpp
Go to the documentation of this file.
1 /********************************************************************\
2 
3 Module: Goto Programs with Functions
4 
5 Author: Daniel Kroening
6 
7 Date: June 2003
8 
9 \*******************************************************************/
10 
11 #include "goto_convert_functions.h"
12 
13 #include <util/prefix.h>
14 #include <util/std_code.h>
15 #include <util/symbol_table.h>
17 
19 
20 #include "goto_model.h"
21 
23  symbol_table_baset &_symbol_table,
24  message_handlert &_message_handler)
25  : goto_convertt(_symbol_table, _message_handler)
26 {
27 }
28 
30 {
31 }
32 
34 {
35  // warning! hash-table iterators are not stable
36 
37  typedef std::list<irep_idt> symbol_listt;
38  symbol_listt symbol_list;
39 
40  for(const auto &symbol_pair : symbol_table.symbols)
41  {
42  if(
43  !symbol_pair.second.is_type && !symbol_pair.second.is_macro &&
44  symbol_pair.second.type.id() == ID_code &&
45  (symbol_pair.second.mode == ID_C || symbol_pair.second.mode == ID_cpp ||
46  symbol_pair.second.mode == ID_java ||
47  symbol_pair.second.mode == "jsil" ||
48  symbol_pair.second.mode == ID_statement_list))
49  {
50  symbol_list.push_back(symbol_pair.first);
51  }
52  }
53 
54  for(const auto &id : symbol_list)
55  {
56  convert_function(id, functions.function_map[id]);
57  }
58 
59  functions.compute_location_numbers();
60 
61 // this removes the parse tree of the bodies from memory
62 #if 0
63  for(const auto &symbol_pair, symbol_table.symbols)
64  {
65  if(!symbol_pair.second.is_type &&
66  symbol_pair.second.type.id()==ID_code &&
67  symbol_pair.second.value.is_not_nil())
68  {
69  symbol_pair.second.value=codet();
70  }
71  }
72 #endif
73 }
74 
76 {
77  for(const auto &instruction : goto_program.instructions)
78  {
79  for(const auto &label : instruction.labels)
80  {
81  if(label == CPROVER_PREFIX "HIDE")
82  return true;
83  }
84  }
85 
86  return false;
87 }
88 
91  const typet &return_type,
92  const source_locationt &source_location)
93 {
94 #if 0
95  if(!f.body.instructions.empty() &&
96  f.body.instructions.back().is_return())
97  return; // not needed, we have one already
98 
99  // see if we have an unconditional goto at the end
100  if(!f.body.instructions.empty() &&
101  f.body.instructions.back().is_goto() &&
102  f.body.instructions.back().guard.is_true())
103  return;
104 #else
105 
106  if(!f.body.instructions.empty())
107  {
108  goto_programt::const_targett last_instruction = f.body.instructions.end();
109  last_instruction--;
110 
111  while(true)
112  {
113  // unconditional goto, say from while(1)?
114  if(
115  last_instruction->is_goto() &&
116  last_instruction->get_condition().is_true())
117  {
118  return;
119  }
120 
121  // return?
122  if(last_instruction->is_set_return_value())
123  return;
124 
125  // advance if it's a 'dead' without branch target
126  if(
127  last_instruction->is_dead() &&
128  last_instruction != f.body.instructions.begin() &&
129  !last_instruction->is_target())
130  last_instruction--;
131  else
132  break; // give up
133  }
134  }
135 
136 #endif
137 
138  side_effect_expr_nondett rhs(return_type, source_location);
139 
140  f.body.add(
141  goto_programt::make_return(code_returnt(std::move(rhs)), source_location));
142 }
143 
145  const irep_idt &identifier,
147 {
148  const symbolt &symbol = ns.lookup(identifier);
149  const irep_idt mode = symbol.mode;
150 
151  if(f.body_available())
152  return; // already converted
153 
154  // make tmp variables local to function
155  tmp_symbol_prefix = id2string(symbol.name) + "::$tmp";
156 
157  // store the parameter identifiers in the goto functions
158  const code_typet &code_type = to_code_type(symbol.type);
159  f.set_parameter_identifiers(code_type);
160 
161  if(
162  symbol.value.is_nil() ||
163  symbol.is_compiled()) /* goto_inline may have removed the body */
164  return;
165 
166  // we have a body, make sure all parameter names are valid
167  for(const auto &p : f.parameter_identifiers)
168  {
169  DATA_INVARIANT(!p.empty(), "parameter identifier should not be empty");
172  "parameter identifier must be a known symbol");
173  }
174 
175  lifetimet parent_lifetime = lifetime;
176  lifetime = identifier == INITIALIZE_FUNCTION ? lifetimet::STATIC_GLOBAL
177  : lifetimet::AUTOMATIC_LOCAL;
178 
179  const codet &code = to_code(symbol.value);
180 
181  source_locationt end_location;
182 
183  if(code.get_statement() == ID_block)
184  end_location = to_code_block(code).end_location();
185  else
186  end_location.make_nil();
187 
188  goto_programt tmp_end_function;
189  goto_programt::targett end_function =
190  tmp_end_function.add(goto_programt::make_end_function(end_location));
191 
192  targets = targetst();
193  targets.set_return(end_function);
194  targets.has_return_value = code_type.return_type().id() != ID_empty &&
195  code_type.return_type().id() != ID_constructor &&
196  code_type.return_type().id() != ID_destructor;
197 
198  goto_convert_rec(code, f.body, mode);
199 
200  // add non-det return value, if needed
202  add_return(f, code_type.return_type(), end_location);
203 
204  // handle SV-COMP's __VERIFIER_atomic_
205  if(
206  !f.body.instructions.empty() &&
207  has_prefix(id2string(identifier), "__VERIFIER_atomic_"))
208  {
211  a_begin.source_location = f.body.instructions.front().source_location;
212  f.body.insert_before_swap(f.body.instructions.begin(), a_begin);
213 
214  goto_programt::targett a_end =
215  f.body.add(goto_programt::make_atomic_end(end_location));
216 
217  for(auto &instruction : f.body.instructions)
218  {
219  if(instruction.is_goto() && instruction.get_target()->is_end_function())
220  instruction.set_target(a_end);
221  }
222  }
223 
224  // add "end of function"
225  f.body.destructive_append(tmp_end_function);
226 
227  f.body.update();
228 
229  if(hide(f.body))
230  f.make_hidden();
231 
232  lifetime = parent_lifetime;
233 }
234 
235 void goto_convert(goto_modelt &goto_model, message_handlert &message_handler)
236 {
237  symbol_table_buildert symbol_table_builder =
239 
240  goto_convert(
241  symbol_table_builder, goto_model.goto_functions, message_handler);
242 }
243 
245  symbol_table_baset &symbol_table,
246  goto_functionst &functions,
247  message_handlert &message_handler)
248 {
249  symbol_table_buildert symbol_table_builder =
250  symbol_table_buildert::wrap(symbol_table);
251 
252  goto_convert_functionst goto_convert_functions(
253  symbol_table_builder, message_handler);
254 
255  goto_convert_functions.goto_convert(functions);
256 }
257 
259  const irep_idt &identifier,
260  symbol_table_baset &symbol_table,
261  goto_functionst &functions,
262  message_handlert &message_handler)
263 {
264  symbol_table_buildert symbol_table_builder =
265  symbol_table_buildert::wrap(symbol_table);
266 
267  goto_convert_functionst goto_convert_functions(
268  symbol_table_builder, message_handler);
269 
270  goto_convert_functions.convert_function(
271  identifier, functions.function_map[identifier]);
272 }
symbol_table_baset::has_symbol
bool has_symbol(const irep_idt &name) const
Check whether a symbol exists in the symbol table.
Definition: symbol_table_base.h:87
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
goto_programt::instructiont::source_location
source_locationt source_location
The location of the instruction in the source file.
Definition: goto_program.h:431
goto_convertt::ns
namespacet ns
Definition: goto_convert_class.h:52
irept::make_nil
void make_nil()
Definition: irep.h:465
typet
The type of an expression, extends irept.
Definition: type.h:28
goto_convertt::goto_convert_rec
void goto_convert_rec(const codet &code, goto_programt &dest, const irep_idt &mode)
Definition: goto_convert.cpp:286
symbolt::type
typet type
Type of symbol.
Definition: symbol.h:31
irept::add
irept & add(const irep_namet &name)
Definition: irep.cpp:116
goto_convertt::tmp_symbol_prefix
std::string tmp_symbol_prefix
Definition: goto_convert_class.h:53
goto_convert_functionst::convert_function
void convert_function(const irep_idt &identifier, goto_functionst::goto_functiont &result)
Definition: goto_convert_functions.cpp:144
prefix.h
goto_programt::make_end_function
static instructiont make_end_function(const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:1015
goto_programt::add
targett add(instructiont &&instruction)
Adds a given instruction at the end.
Definition: goto_program.h:753
goto_model.h
Symbol Table + CFG.
goto_functionst::compute_location_numbers
void compute_location_numbers()
Definition: goto_functions.cpp:20
goto_modelt
Definition: goto_model.h:26
goto_programt::make_return
static instructiont make_return(code_returnt c, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:901
goto_convert_functionst::goto_convert
void goto_convert(goto_functionst &functions)
Definition: goto_convert_functions.cpp:33
goto_functionst::function_map
function_mapt function_map
Definition: goto_functions.h:29
to_code
const codet & to_code(const exprt &expr)
Definition: std_code.h:153
goto_convertt::targetst::has_return_value
bool has_return_value
Definition: goto_convert_class.h:375
goto_convert_functionst::add_return
void add_return(goto_functionst::goto_functiont &, const typet &return_type, const source_locationt &)
Definition: goto_convert_functions.cpp:89
namespacet::lookup
bool lookup(const irep_idt &name, const symbolt *&symbol) const override
See documentation for namespace_baset::lookup().
Definition: namespace.cpp:138
to_code_type
const code_typet & to_code_type(const typet &type)
Cast a typet to a code_typet.
Definition: std_types.h:744
goto_convertt::targets
struct goto_convertt::targetst targets
symbolt::mode
irep_idt mode
Language mode.
Definition: symbol.h:49
has_prefix
bool has_prefix(const std::string &s, const std::string &prefix)
Definition: converter.cpp:13
DATA_INVARIANT
#define DATA_INVARIANT(CONDITION, REASON)
This condition should be used to document that assumptions that are made on goto_functions,...
Definition: invariant.h:510
goto_convertt
Definition: goto_convert_class.h:31
id2string
const std::string & id2string(const irep_idt &d)
Definition: irep.h:49
symbol_table_baset
The symbol table base class interface.
Definition: symbol_table_base.h:22
goto_convert_functionst
Definition: goto_convert_functions.h:41
INITIALIZE_FUNCTION
#define INITIALIZE_FUNCTION
Definition: static_lifetime_init.h:22
goto_convertt::targetst::set_return
void set_return(goto_programt::targett _return_target)
Definition: goto_convert_class.h:427
goto_programt::make_atomic_begin
static instructiont make_atomic_begin(const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:993
code_typet
Base type of functions.
Definition: std_types.h:539
irept::is_nil
bool is_nil() const
Definition: irep.h:387
irept::id
const irep_idt & id() const
Definition: irep.h:407
message_handlert
Definition: message.h:28
goto_convert
void goto_convert(goto_modelt &goto_model, message_handlert &message_handler)
Definition: goto_convert_functions.cpp:235
std_code.h
lifetimet
lifetimet
Selects the kind of objects allocated.
Definition: allocate_objects.h:18
source_locationt
Definition: source_location.h:19
side_effect_expr_nondett
A side_effect_exprt that returns a non-deterministically chosen value.
Definition: std_code.h:1966
goto_functionst::goto_functiont
::goto_functiont goto_functiont
Definition: goto_functions.h:27
goto_programt::instructions
instructionst instructions
The list of instructions in the goto program.
Definition: goto_program.h:652
goto_functionst
A collection of goto functions.
Definition: goto_functions.h:25
symbolt::value
exprt value
Initial value of symbol.
Definition: symbol.h:34
goto_convertt::targetst
Definition: goto_convert_class.h:374
code_returnt
codet representation of a "return from a function" statement.
Definition: std_code.h:1340
goto_modelt::goto_functions
goto_functionst goto_functions
GOTO functions.
Definition: goto_model.h:33
goto_convert_functionst::~goto_convert_functionst
virtual ~goto_convert_functionst()
Definition: goto_convert_functions.cpp:29
symbolt
Symbol table entry.
Definition: symbol.h:28
symbol_table_buildert::wrap
static symbol_table_buildert wrap(symbol_table_baset &base_symbol_table)
Definition: symbol_table_builder.h:42
symbol_table_buildert
Author: Diffblue Ltd.
Definition: symbol_table_builder.h:14
symbol_table_baset::symbols
const symbolst & symbols
Read-only field, used to look up symbols given their names.
Definition: symbol_table_base.h:30
CPROVER_PREFIX
#define CPROVER_PREFIX
Definition: cprover_prefix.h:14
symbolt::is_compiled
bool is_compiled() const
Returns true iff the the symbol's value has been compiled to a goto program.
Definition: symbol.h:107
goto_programt
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:71
goto_convert_functionst::goto_convert_functionst
goto_convert_functionst(symbol_table_baset &_symbol_table, message_handlert &_message_handler)
Definition: goto_convert_functions.cpp:22
goto_convert_functionst::hide
static bool hide(const goto_programt &)
Definition: goto_convert_functions.cpp:75
goto_convertt::symbol_table
symbol_table_baset & symbol_table
Definition: goto_convert_class.h:51
code_typet::return_type
const typet & return_type() const
Definition: std_types.h:645
to_code_block
const code_blockt & to_code_block(const codet &code)
Definition: std_code.h:254
goto_programt::const_targett
instructionst::const_iterator const_targett
Definition: goto_program.h:647
goto_convert_functions.h
Goto Programs with Functions.
static_lifetime_init.h
symbol_table.h
Author: Diffblue Ltd.
codet::get_statement
const irep_idt & get_statement() const
Definition: std_code.h:69
symbol_table_builder.h
goto_programt::instructiont
This class represents an instruction in the GOTO intermediate representation.
Definition: goto_program.h:178
goto_convertt::lifetime
lifetimet lifetime
Definition: goto_convert_class.h:54
goto_modelt::symbol_table
symbol_tablet symbol_table
Symbol table.
Definition: goto_model.h:30
symbolt::name
irep_idt name
The unique identifier.
Definition: symbol.h:40
goto_programt::targett
instructionst::iterator targett
Definition: goto_program.h:646
code_blockt::end_location
source_locationt end_location() const
Definition: std_code.h:225
goto_programt::make_atomic_end
static instructiont make_atomic_end(const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:1004
codet
Data structure for representing an arbitrary statement in a program.
Definition: std_code.h:33