cprover
generate_function_bodies.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Replace bodies of goto functions
4 
5 Author: Diffblue Ltd.
6 
7 \*******************************************************************/
8 
10 
12 
17 
18 #include <util/format_expr.h>
19 #include <util/fresh_symbol.h>
20 #include <util/make_unique.h>
21 #include <util/pointer_expr.h>
22 #include <util/prefix.h>
23 #include <util/string2int.h>
24 #include <util/string_utils.h>
25 
27  goto_functiont &function,
28  symbol_tablet &symbol_table,
29  const irep_idt &function_name) const
30 {
31  PRECONDITION(!function.body_available());
32  generate_parameter_names(function, symbol_table, function_name);
33  generate_function_body_impl(function, symbol_table, function_name);
34 }
35 
37  goto_functiont &function,
38  symbol_tablet &symbol_table,
39  const irep_idt &function_name) const
40 {
41  auto &function_symbol = symbol_table.get_writeable_ref(function_name);
42  auto &parameters = to_code_type(function_symbol.type).parameters();
43 
44  int param_counter = 0;
45  for(auto &parameter : parameters)
46  {
47  if(parameter.get_identifier().empty())
48  {
49  const std::string param_base_name =
50  parameter.get_base_name().empty()
51  ? "__param$" + std::to_string(param_counter++)
52  : id2string(parameter.get_base_name());
53  irep_idt new_param_identifier =
54  id2string(function_name) + "::" + param_base_name;
55  parameter.set_base_name(param_base_name);
56  parameter.set_identifier(new_param_identifier);
57  parameter_symbolt new_param_sym;
58  new_param_sym.name = new_param_identifier;
59  new_param_sym.type = parameter.type();
60  new_param_sym.base_name = param_base_name;
61  new_param_sym.mode = function_symbol.mode;
62  new_param_sym.module = function_symbol.module;
63  new_param_sym.location = function_symbol.location;
64  symbol_table.add(new_param_sym);
65  }
66  }
67  function.set_parameter_identifiers(to_code_type(function_symbol.type));
68 }
69 
71 {
72 protected:
74  goto_functiont &function,
75  symbol_tablet &symbol_table,
76  const irep_idt &function_name) const override
77  {
78  auto const &function_symbol = symbol_table.lookup_ref(function_name);
79  // NOLINTNEXTLINE
80  auto add_instruction = [&](goto_programt::instructiont &&i) {
81  auto instruction = function.body.add(std::move(i));
82  instruction->source_location = function_symbol.location;
83  return instruction;
84  };
85  add_instruction(goto_programt::make_assumption(false_exprt()));
86  add_instruction(goto_programt::make_end_function());
87  }
88 };
89 
91 {
92 protected:
94  goto_functiont &function,
95  symbol_tablet &symbol_table,
96  const irep_idt &function_name) const override
97  {
98  auto const &function_symbol = symbol_table.lookup_ref(function_name);
99  // NOLINTNEXTLINE
100  auto add_instruction = [&](goto_programt::instructiont &&i) {
101  auto instruction = function.body.add(std::move(i));
102  instruction->source_location = function_symbol.location;
103  instruction->source_location.set_function(function_name);
104  return instruction;
105  };
106  auto assert_instruction =
107  add_instruction(goto_programt::make_assertion(false_exprt()));
108  const namespacet ns(symbol_table);
109  std::ostringstream comment_stream;
110  comment_stream << id2string(ID_assertion) << " "
111  << format(assert_instruction->get_condition());
112  assert_instruction->source_location.set_comment(comment_stream.str());
113  assert_instruction->source_location.set_property_class(ID_assertion);
114  add_instruction(goto_programt::make_end_function());
115  }
116 };
117 
120 {
121 protected:
123  goto_functiont &function,
124  symbol_tablet &symbol_table,
125  const irep_idt &function_name) const override
126  {
127  auto const &function_symbol = symbol_table.lookup_ref(function_name);
128  // NOLINTNEXTLINE
129  auto add_instruction = [&](goto_programt::instructiont &&i) {
130  auto instruction = function.body.add(std::move(i));
131  instruction->source_location = function_symbol.location;
132  instruction->source_location.set_function(function_name);
133  return instruction;
134  };
135  auto assert_instruction =
136  add_instruction(goto_programt::make_assertion(false_exprt()));
137  const namespacet ns(symbol_table);
138  std::ostringstream comment_stream;
139  comment_stream << id2string(ID_assertion) << " "
140  << format(assert_instruction->get_condition());
141  assert_instruction->source_location.set_comment(comment_stream.str());
142  assert_instruction->source_location.set_property_class(ID_assertion);
143  add_instruction(goto_programt::make_assumption(false_exprt()));
144  add_instruction(goto_programt::make_end_function());
145  }
146 };
147 
149 {
150 public:
152  std::vector<irep_idt> globals_to_havoc,
153  std::regex parameters_to_havoc,
155  message_handlert &message_handler)
160  message(message_handler)
161  {
162  }
163 
165  std::vector<irep_idt> globals_to_havoc,
166  std::vector<std::size_t> param_numbers_to_havoc,
168  message_handlert &message_handler)
173  message(message_handler)
174  {
175  }
176 
177 private:
179  const exprt &lhs,
180  const std::size_t initial_depth,
181  const source_locationt &source_location,
182  const irep_idt &function_id,
183  symbol_tablet &symbol_table,
184  goto_programt &dest) const
185  {
186  symbol_factoryt symbol_factory(
187  symbol_table,
188  source_location,
189  function_id,
192 
193  code_blockt assignments;
194 
195  symbol_factory.gen_nondet_init(
196  assignments,
197  lhs,
198  initial_depth,
200  false); // do not initialize const objects at the top level
201 
202  code_blockt init_code;
203 
204  symbol_factory.declare_created_symbols(init_code);
205  init_code.append(assignments);
206 
207  goto_programt tmp_dest;
208  goto_convert(
209  init_code, symbol_table, tmp_dest, message.get_message_handler(), ID_C);
210 
211  dest.destructive_append(tmp_dest);
212  }
213 
215  const std::string &param_name,
216  std::size_t param_number) const
217  {
218  if(parameters_to_havoc.has_value())
219  {
220  return std::regex_match(param_name, *parameters_to_havoc);
221  }
222  else
223  {
225  return std::binary_search(
226  param_numbers_to_havoc->begin(),
227  param_numbers_to_havoc->end(),
228  param_number);
229  }
230  }
231 
232 protected:
234  goto_functiont &function,
235  symbol_tablet &symbol_table,
236  const irep_idt &function_name) const override
237  {
238  const namespacet ns(symbol_table);
239  // some user input checking
240  if(param_numbers_to_havoc.has_value() && !param_numbers_to_havoc->empty())
241  {
242  auto max_param_number = std::max_element(
244  if(*max_param_number >= function.parameter_identifiers.size())
245  {
247  "function " + id2string(function_name) + " does not take " +
248  std::to_string(*max_param_number + 1) + " arguments",
249  "--generate-havocing-body"};
250  }
251  for(const auto number : *param_numbers_to_havoc)
252  {
253  const auto &parameter = function.parameter_identifiers[number];
254  const symbolt &parameter_symbol = ns.lookup(parameter);
255  if(parameter_symbol.type.id() != ID_pointer)
256  {
258  "argument number " + std::to_string(number) + " of function " +
259  id2string(function_name) + " is not a pointer",
260  "--generate-havocing-body"};
261  }
262  }
263  }
264 
265  auto const &function_symbol = symbol_table.lookup_ref(function_name);
266  // NOLINTNEXTLINE
267  auto add_instruction = [&](goto_programt::instructiont &&i) {
268  auto instruction = function.body.add(std::move(i));
269  instruction->source_location = function_symbol.location;
270  return instruction;
271  };
272 
273  for(std::size_t i = 0; i < function.parameter_identifiers.size(); ++i)
274  {
275  const auto &parameter = function.parameter_identifiers[i];
276  const symbolt &parameter_symbol = ns.lookup(parameter);
277  if(
278  parameter_symbol.type.id() == ID_pointer &&
279  !parameter_symbol.type.subtype().get_bool(ID_C_constant) &&
280  should_havoc_param(id2string(parameter_symbol.base_name), i))
281  {
282  auto goto_instruction =
284  parameter_symbol.symbol_expr(),
285  null_pointer_exprt(to_pointer_type(parameter_symbol.type)))));
286 
287  dereference_exprt dereference_expr(
288  parameter_symbol.symbol_expr(), parameter_symbol.type.subtype());
289 
290  goto_programt dest;
292  dereference_expr,
293  1, // depth 1 since we pass the dereferenced pointer
294  function_symbol.location,
295  function_name,
296  symbol_table,
297  dest);
298 
299  function.body.destructive_append(dest);
300 
301  auto label_instruction = add_instruction(goto_programt::make_skip());
302  goto_instruction->complete_goto(label_instruction);
303  }
304  }
305 
306  for(auto const &global_id : globals_to_havoc)
307  {
308  auto const &global_sym = symbol_table.lookup_ref(global_id);
309 
310  goto_programt dest;
311 
313  symbol_exprt(global_sym.name, global_sym.type),
314  0,
315  function_symbol.location,
316  irep_idt(),
317  symbol_table,
318  dest);
319 
320  function.body.destructive_append(dest);
321  }
322 
323  const typet &return_type = to_code_type(function_symbol.type).return_type();
324  if(return_type != empty_typet())
325  {
326  typet type(return_type);
327  type.remove(ID_C_constant);
328 
329  symbolt &aux_symbol = get_fresh_aux_symbol(
330  type,
331  id2string(function_name),
332  "return_value",
333  function_symbol.location,
334  ID_C,
335  symbol_table);
336 
337  aux_symbol.is_static_lifetime = false;
338 
339  add_instruction(goto_programt::make_decl(aux_symbol.symbol_expr()));
340 
341  goto_programt dest;
342 
344  aux_symbol.symbol_expr(),
345  0,
346  function_symbol.location,
347  function_name,
348  symbol_table,
349  dest);
350 
351  function.body.destructive_append(dest);
352 
353  exprt return_expr =
354  typecast_exprt::conditional_cast(aux_symbol.symbol_expr(), return_type);
355 
356  add_instruction(goto_programt::make_return(code_returnt(return_expr)));
357 
358  add_instruction(goto_programt::make_dead(aux_symbol.symbol_expr()));
359  }
360 
361  add_instruction(goto_programt::make_end_function());
362 
363  remove_skip(function.body);
364  }
365 
366 private:
367  const std::vector<irep_idt> globals_to_havoc;
371  mutable messaget message;
372 };
373 
374 class generate_function_bodies_errort : public std::runtime_error
375 {
376 public:
377  explicit generate_function_bodies_errort(const std::string &reason)
378  : runtime_error(reason)
379  {
380  }
381 };
382 
385 std::unique_ptr<generate_function_bodiest> generate_function_bodies_factory(
386  const std::string &options,
387  const c_object_factory_parameterst &object_factory_parameters,
388  const symbol_tablet &symbol_table,
389  message_handlert &message_handler)
390 {
391  if(options.empty() || options == "nondet-return")
392  {
393  return util_make_unique<havoc_generate_function_bodiest>(
394  std::vector<irep_idt>{},
395  std::regex{},
396  object_factory_parameters,
397  message_handler);
398  }
399 
400  if(options == "assume-false")
401  {
402  return util_make_unique<assume_false_generate_function_bodiest>();
403  }
404 
405  if(options == "assert-false")
406  {
407  return util_make_unique<assert_false_generate_function_bodiest>();
408  }
409 
410  if(options == "assert-false-assume-false")
411  {
412  return util_make_unique<
414  }
415 
416  const std::vector<std::string> option_components = split_string(options, ',');
417  if(!option_components.empty() && option_components[0] == "havoc")
418  {
419  std::regex globals_regex;
420  std::regex params_regex;
421  std::vector<std::size_t> param_numbers;
422  for(std::size_t i = 1; i < option_components.size(); ++i)
423  {
424  const std::vector<std::string> key_value_pair =
425  split_string(option_components[i], ':');
426  if(key_value_pair.size() != 2)
427  {
429  "Expected key_value_pair of form argument:value");
430  }
431  if(key_value_pair[0] == "globals")
432  {
433  globals_regex = key_value_pair[1];
434  }
435  else if(key_value_pair[0] == "params")
436  {
437  auto param_identifiers = split_string(key_value_pair[1], ';');
438  if(param_identifiers.size() == 1)
439  {
440  auto maybe_nondet_param_number =
441  string2optional_size_t(param_identifiers.back());
442  if(!maybe_nondet_param_number.has_value())
443  {
444  params_regex = key_value_pair[1];
445  continue;
446  }
447  }
449  param_identifiers.begin(),
450  param_identifiers.end(),
451  std::back_inserter(param_numbers),
452  [](const std::string &param_id) {
453  auto maybe_nondet_param_number = string2optional_size_t(param_id);
454  INVARIANT(
455  maybe_nondet_param_number.has_value(),
456  param_id + " not a number");
457  return *maybe_nondet_param_number;
458  });
459  std::sort(param_numbers.begin(), param_numbers.end());
460  }
461  else
462  {
464  "Unknown option \"" + key_value_pair[0] + "\"");
465  }
466  }
467  std::vector<irep_idt> globals_to_havoc;
468  namespacet ns(symbol_table);
469  messaget messages(message_handler);
470  const std::regex cprover_prefix = std::regex("__CPROVER.*");
471  for(auto const &symbol : symbol_table.symbols)
472  {
473  if(
474  symbol.second.is_lvalue && symbol.second.is_static_lifetime &&
475  std::regex_match(id2string(symbol.first), globals_regex))
476  {
477  if(std::regex_match(id2string(symbol.first), cprover_prefix))
478  {
479  messages.warning() << "generate function bodies: "
480  << "matched global '" << id2string(symbol.first)
481  << "' begins with __CPROVER, "
482  << "havoc-ing this global may interfere"
483  << " with analysis" << messaget::eom;
484  }
485  globals_to_havoc.push_back(symbol.first);
486  }
487  }
488  if(param_numbers.empty())
489  return util_make_unique<havoc_generate_function_bodiest>(
490  std::move(globals_to_havoc),
491  std::move(params_regex),
492  object_factory_parameters,
493  message_handler);
494  else
495  return util_make_unique<havoc_generate_function_bodiest>(
496  std::move(globals_to_havoc),
497  std::move(param_numbers),
498  object_factory_parameters,
499  message_handler);
500  }
501  throw generate_function_bodies_errort("Can't parse \"" + options + "\"");
502 }
503 
512  const std::regex &functions_regex,
513  const generate_function_bodiest &generate_function_body,
514  goto_modelt &model,
515  message_handlert &message_handler)
516 {
517  messaget messages(message_handler);
518  const std::regex cprover_prefix = std::regex("__CPROVER.*");
519  bool did_generate_body = false;
520  for(auto &function : model.goto_functions.function_map)
521  {
522  if(
523  !function.second.body_available() &&
524  std::regex_match(id2string(function.first), functions_regex))
525  {
526  if(std::regex_match(id2string(function.first), cprover_prefix))
527  {
528  messages.warning() << "generate function bodies: matched function '"
529  << id2string(function.first)
530  << "' begins with __CPROVER "
531  << "the generated body for this function "
532  << "may interfere with analysis" << messaget::eom;
533  }
534  did_generate_body = true;
535  generate_function_body.generate_function_body(
536  function.second, model.symbol_table, function.first);
537  }
538  }
539  if(!did_generate_body)
540  {
541  messages.warning()
542  << "generate function bodies: No function name matched regex"
543  << messaget::eom;
544  }
545 }
546 
548  const std::string &function_name,
549  const std::string &call_site_id,
550  const generate_function_bodiest &generate_function_body,
551  goto_modelt &model,
552  message_handlert &message_handler)
553 {
554  PRECONDITION(!has_prefix(function_name, CPROVER_PREFIX));
555  auto call_site_number = string2optional_size_t(call_site_id);
556  PRECONDITION(call_site_number.has_value());
557 
558  messaget messages(message_handler);
559 
560  bool found = false;
561  irep_idt function_mode;
562  typet function_type;
563 
564  // get the mode and type from symbol table
565  for(auto const &symbol_pair : model.symbol_table)
566  {
567  auto const symbol = symbol_pair.second;
568  if(symbol.type.id() == ID_code && symbol.name == function_name)
569  {
570  function_mode = symbol.mode;
571  function_type = symbol.type;
572  found = true;
573  break;
574  }
575  }
576  CHECK_RETURN(found);
577 
578  // add function of the right name to the symbol table
579  symbolt havoc_function_symbol{};
580  havoc_function_symbol.name = havoc_function_symbol.base_name =
581  havoc_function_symbol.pretty_name = function_name + "." + call_site_id;
582 
583  havoc_function_symbol.is_lvalue = true;
584  havoc_function_symbol.mode = function_mode;
585  havoc_function_symbol.type = function_type;
586 
587  model.symbol_table.insert(havoc_function_symbol);
588 
589  auto const &generated_havoc =
590  model.symbol_table.lookup_ref(havoc_function_symbol.name);
591 
592  // convert to get the function stub to goto-model
593  goto_convert(model.symbol_table, model.goto_functions, message_handler);
594 
595  // now generate body as above
596  for(auto &function : model.goto_functions.function_map)
597  {
598  if(
599  !function.second.body_available() &&
600  havoc_function_symbol.name == id2string(function.first))
601  {
602  generate_function_body.generate_function_body(
603  function.second, model.symbol_table, function.first);
604  }
605  }
606 
607  auto is_havoc_function_call = [&function_name](const exprt &expr) {
608  if(expr.id() != ID_symbol)
609  return false;
610  std::string called_function_name =
611  id2string(to_symbol_expr(expr).get_identifier());
612  if(called_function_name == function_name)
613  return true;
614 
615  return (has_prefix(called_function_name, function_name + "."));
616  };
617 
618  // finally, rename the (right) call site
619  std::size_t counter = 0;
620  for(auto &function : model.goto_functions.function_map)
621  {
622  for(auto &instruction : function.second.body.instructions)
623  {
624  if(instruction.is_function_call())
625  {
626  auto &called_function =
627  to_code_function_call(instruction.code_nonconst()).function();
628  if(is_havoc_function_call(called_function))
629  {
630  if(++counter == *call_site_number)
631  {
632  called_function = generated_havoc.symbol_expr();
633  return;
634  }
635  }
636  }
637  }
638  }
639 }
static abstract_object_pointert transform(const exprt &expr, const std::vector< abstract_object_pointert > &operands, const abstract_environmentt &environment, const namespacet &ns)
@ DYNAMIC
Allocate dynamic objects (using ALLOCATE)
C Nondet Symbol Factory.
void generate_function_body_impl(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const override
Produce a body for the passed function At this point the body of function is always empty,...
void generate_function_body_impl(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const override
Produce a body for the passed function At this point the body of function is always empty,...
void generate_function_body_impl(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const override
Produce a body for the passed function At this point the body of function is always empty,...
A codet representing sequential composition of program statements.
Definition: std_code.h:168
void append(const code_blockt &extra_block)
Add all the codets from extra_block to the current code_blockt.
Definition: std_code.cpp:89
exprt & function()
Definition: std_code.h:1248
codet representation of a "return from a function" statement.
Definition: std_code.h:1340
const typet & return_type() const
Definition: std_types.h:645
const parameterst & parameters() const
Definition: std_types.h:655
Operator to dereference a pointer.
Definition: pointer_expr.h:628
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
The empty type.
Definition: std_types.h:51
Equality.
Definition: std_expr.h:1225
Base class for all expressions.
Definition: expr.h:54
The Boolean constant false.
Definition: std_expr.h:2811
generate_function_bodies_errort(const std::string &reason)
Base class for replace_function_body implementations.
void generate_function_body(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const
Replace the function body with one based on the replace_function_body class being used.
void generate_parameter_names(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const
Generate parameter names for unnamed parameters.
virtual void generate_function_body_impl(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const =0
Produce a body for the passed function At this point the body of function is always empty,...
function_mapt function_map
A goto function, consisting of function body (see body) and parameter identifiers (see parameter_iden...
Definition: goto_function.h:24
symbol_tablet symbol_table
Symbol table.
Definition: goto_model.h:30
goto_functionst goto_functions
GOTO functions.
Definition: goto_model.h:33
This class represents an instruction in the GOTO intermediate representation.
Definition: goto_program.h:178
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:71
static instructiont make_assumption(const exprt &g, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:963
static instructiont make_dead(const symbol_exprt &symbol, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:985
static instructiont make_end_function(const source_locationt &l=source_locationt::nil())
void destructive_append(goto_programt &p)
Appends the given program p to *this. p is destroyed.
Definition: goto_program.h:736
static instructiont make_return(code_returnt c, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:901
static instructiont make_skip(const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:909
static instructiont make_decl(const symbol_exprt &symbol, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:978
static instructiont make_assertion(const exprt &g, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:951
static instructiont make_incomplete_goto(const exprt &_cond, const source_locationt &l=source_locationt::nil())
havoc_generate_function_bodiest(std::vector< irep_idt > globals_to_havoc, std::vector< std::size_t > param_numbers_to_havoc, const c_object_factory_parameterst &object_factory_parameters, message_handlert &message_handler)
const std::vector< irep_idt > globals_to_havoc
havoc_generate_function_bodiest(std::vector< irep_idt > globals_to_havoc, std::regex parameters_to_havoc, const c_object_factory_parameterst &object_factory_parameters, message_handlert &message_handler)
bool should_havoc_param(const std::string &param_name, std::size_t param_number) const
optionalt< std::vector< std::size_t > > param_numbers_to_havoc
void generate_function_body_impl(goto_functiont &function, symbol_tablet &symbol_table, const irep_idt &function_name) const override
Produce a body for the passed function At this point the body of function is always empty,...
const c_object_factory_parameterst & object_factory_parameters
void havoc_expr_rec(const exprt &lhs, const std::size_t initial_depth, const source_locationt &source_location, const irep_idt &function_id, symbol_tablet &symbol_table, goto_programt &dest) const
Thrown when users pass incorrect command line arguments, for example passing no files to analysis or ...
bool get_bool(const irep_namet &name) const
Definition: irep.cpp:58
const irep_idt & id() const
Definition: irep.h:407
void remove(const irep_namet &name)
Definition: irep.cpp:96
Class that provides messages with a built-in verbosity 'level'.
Definition: message.h:155
mstreamt & warning() const
Definition: message.h:404
message_handlert & get_message_handler()
Definition: message.h:184
static eomt eom
Definition: message.h:297
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:91
bool lookup(const irep_idt &name, const symbolt *&symbol) const override
See documentation for namespace_baset::lookup().
Definition: namespace.cpp:138
The null pointer constant.
Definition: pointer_expr.h:703
Symbol table entry of function parameterThis is a symbol generated as part of type checking.
Definition: symbol.h:171
void set_function(const irep_idt &function)
Expression to hold a symbol (variable)
Definition: std_expr.h:80
void gen_nondet_init(code_blockt &assignments, const exprt &expr, const std::size_t depth=0, recursion_sett recursion_set=recursion_sett(), const bool assign_const=true)
Creates a nondet for expr, including calling itself recursively to make appropriate symbols to point ...
std::set< irep_idt > recursion_sett
void declare_created_symbols(code_blockt &init_code)
symbolt & get_writeable_ref(const irep_idt &name)
Find a symbol in the symbol table for read-write access.
const symbolst & symbols
Read-only field, used to look up symbols given their names.
const symbolt & lookup_ref(const irep_idt &name) const
Find a symbol in the symbol table for read-only access.
bool add(const symbolt &symbol)
Add a new symbol to the symbol table.
The symbol table.
Definition: symbol_table.h:14
virtual std::pair< symbolt &, bool > insert(symbolt symbol) override
Author: Diffblue Ltd.
Symbol table entry.
Definition: symbol.h:28
irep_idt base_name
Base (non-scoped) name.
Definition: symbol.h:46
irep_idt module
Name of module the symbol belongs to.
Definition: symbol.h:43
bool is_static_lifetime
Definition: symbol.h:65
source_locationt location
Source code location of definition of symbol.
Definition: symbol.h:37
class symbol_exprt symbol_expr() const
Produces a symbol_exprt for a symbol.
Definition: symbol.cpp:121
typet type
Type of symbol.
Definition: symbol.h:31
irep_idt name
The unique identifier.
Definition: symbol.h:40
irep_idt mode
Language mode.
Definition: symbol.h:49
static exprt conditional_cast(const exprt &expr, const typet &type)
Definition: std_expr.h:1874
The type of an expression, extends irept.
Definition: type.h:28
const typet & subtype() const
Definition: type.h:47
bool has_prefix(const std::string &s, const std::string &prefix)
Definition: converter.cpp:13
#define CPROVER_PREFIX
static format_containert< T > format(const T &o)
Definition: format.h:37
symbolt & get_fresh_aux_symbol(const typet &type, const std::string &name_prefix, const std::string &basename_prefix, const source_locationt &source_location, const irep_idt &symbol_mode, const namespacet &ns, symbol_table_baset &symbol_table)
Installs a fresh-named symbol with respect to the given namespace ns with the requested name pattern ...
Fresh auxiliary symbol creation.
std::unique_ptr< generate_function_bodiest > generate_function_bodies_factory(const std::string &options, const c_object_factory_parameterst &object_factory_parameters, const symbol_tablet &symbol_table, message_handlert &message_handler)
Create the type that actually generates the functions.
void generate_function_bodies(const std::regex &functions_regex, const generate_function_bodiest &generate_function_body, goto_modelt &model, message_handlert &message_handler)
Generate function bodies with some default behavior: assert-false, assume-false, assert-false-assume-...
void goto_convert(const codet &code, symbol_table_baset &symbol_table, goto_programt &dest, message_handlert &message_handler, const irep_idt &mode)
Program Transformation.
Goto Programs with Functions.
Symbol Table + CFG.
const std::string & id2string(const irep_idt &d)
Definition: irep.h:49
std::unique_ptr< T > util_make_unique(Ts &&... ts)
Definition: make_unique.h:19
nonstd::optional< T > optionalt
Definition: optional.h:35
API to expression classes for Pointers.
const pointer_typet & to_pointer_type(const typet &type)
Cast a typet to a pointer_typet.
Definition: pointer_expr.h:62
void remove_skip(goto_programt &goto_program, goto_programt::targett begin, goto_programt::targett end)
remove unnecessary skip statements
Definition: remove_skip.cpp:86
Program Transformation.
#define CHECK_RETURN(CONDITION)
Definition: invariant.h:495
#define PRECONDITION(CONDITION)
Definition: invariant.h:463
const code_function_callt & to_code_function_call(const codet &code)
Definition: std_code.h:1324
const symbol_exprt & to_symbol_expr(const exprt &expr)
Cast an exprt to a symbol_exprt.
Definition: std_expr.h:189
const code_typet & to_code_type(const typet &type)
Cast a typet to a code_typet.
Definition: std_types.h:744
optionalt< std::size_t > string2optional_size_t(const std::string &str, int base)
Convert string to size_t similar to the stoul or stoull functions, return nullopt when the conversion...
Definition: string2int.cpp:69
std::string to_string(const string_not_contains_constraintt &expr)
Used for debug printing.
void split_string(const std::string &s, char delim, std::vector< std::string > &result, bool strip, bool remove_empty)