cprover
string_abstraction.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: String Abstraction
4 
5 Author: Daniel Kroening, kroening@kroening.com
6 
7 \*******************************************************************/
8 
11 
12 #ifndef CPROVER_GOTO_PROGRAMS_STRING_ABSTRACTION_H
13 #define CPROVER_GOTO_PROGRAMS_STRING_ABSTRACTION_H
14 
15 #include <util/symbol_table.h>
16 #include <util/message.h>
17 #include <util/config.h>
18 #include <util/std_expr.h>
19 
20 #include "goto_model.h"
21 
23 {
24 public:
26  symbol_tablet &_symbol_table,
27  message_handlert &_message_handler);
28 
29  void operator()(goto_programt &dest);
30  void operator()(goto_functionst &dest);
31 
32 protected:
33  const std::string arg_suffix;
34  std::string sym_suffix;
38 
39  typedef ::std::map< typet, typet > abstraction_types_mapt;
41 
42  ::std::set< irep_idt > current_args;
43 
44  static bool has_string_macros(const exprt &expr);
45 
47  exprt &expr,
48  bool lhs,
49  const source_locationt &);
50 
51  void move_lhs_arithmetic(exprt &lhs, exprt &rhs);
52 
53  bool is_char_type(const typet &type) const
54  {
55  if(type.id() == ID_struct_tag)
56  return is_char_type(ns.follow(type));
57 
58  if(type.id()!=ID_signedbv &&
59  type.id()!=ID_unsignedbv)
60  return false;
61 
63  }
64 
65  bool is_ptr_string_struct(const typet &type) const;
66 
67  void make_type(exprt &dest, const typet &type)
68  {
69  if(dest.is_not_nil() &&
70  ns.follow(dest.type())!=ns.follow(type))
71  dest.make_typecast(type);
72  }
73 
74  goto_programt::targett abstract(
82 
84  goto_programt &dest,
86  const exprt &new_lhs,
87  const exprt &lhs,
88  const exprt &rhs);
89 
91 
94  const exprt &lhs, const exprt &rhs);
95 
97  goto_programt &dest,
99  const exprt &lhs, const if_exprt &rhs);
100 
102  goto_programt &dest,
103  goto_programt::targett target,
104  const exprt &lhs, const exprt &rhs);
105 
106  enum class whatt { IS_ZERO, LENGTH, SIZE };
107 
108  static typet build_type(whatt what);
109  exprt build(
110  const exprt &pointer,
111  whatt what,
112  bool write,
113  const source_locationt &);
114 
115  bool build(const exprt &object, exprt &dest, bool write);
116  bool build_wrap(const exprt &object, exprt &dest, bool write);
117  bool build_if(const if_exprt &o_if, exprt &dest, bool write);
118  bool build_array(const array_exprt &object, exprt &dest, bool write);
119  bool build_symbol(const symbol_exprt &sym, exprt &dest);
120  bool build_symbol_constant(const mp_integer &zero_length,
121  const mp_integer &buf_size, exprt &dest);
122 
123  exprt build_unknown(whatt what, bool write);
124  exprt build_unknown(const typet &type, bool write);
125  const typet &build_abstraction_type(const typet &type);
126  const typet &build_abstraction_type_rec(const typet &type,
127  const abstraction_types_mapt &known);
128  bool build_pointer(const exprt &object, exprt &dest, bool write);
129  void build_new_symbol(const symbolt &symbol,
130  const irep_idt &identifier, const typet &type);
131 
132  exprt member(const exprt &a, whatt what);
133 
136 
137  typedef std::unordered_map<irep_idt, irep_idt> localst;
139 
140  void abstract(goto_programt &dest);
141 
142  void add_str_arguments(
143  const irep_idt &name,
145 
146  void add_argument(
147  code_typet::parameterst &str_args,
148  const symbolt &fct_symbol,
149  const typet &type,
150  const irep_idt &base_name,
151  const irep_idt &identifier);
152 
154  const irep_idt &identifier, const irep_idt &source_sym);
155 
157  goto_programt::targett ref_instr,
158  const symbolt &symbol, const typet &source_type);
159 
161  goto_programt &dest,
162  goto_programt::targett ref_instr,
163  const symbolt &symbol,
164  const irep_idt &component_name,
165  const typet &type,
166  const typet &source_type);
167 
169 };
170 
171 // keep track of length of strings
172 
173 void string_abstraction(
174  goto_modelt &,
175  message_handlert &);
176 
177 void string_abstraction(
178  symbol_tablet &,
180  goto_functionst &);
181 
182 #endif // CPROVER_GOTO_PROGRAMS_STRING_ABSTRACTION_H
messaget
Class that provides messages with a built-in verbosity 'level'.
Definition: message.h:144
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:35
string_abstractiont::string_abstractiont
string_abstractiont(symbol_tablet &_symbol_table, message_handlert &_message_handler)
Definition: string_abstraction.cpp:93
symbol_tablet
The symbol table.
Definition: symbol_table.h:19
string_abstractiont::member
exprt member(const exprt &a, whatt what)
Definition: string_abstraction.cpp:1346
string_abstractiont::build_type
static typet build_type(whatt what)
Definition: string_abstraction.cpp:122
string_abstractiont::build
exprt build(const exprt &pointer, whatt what, bool write, const source_locationt &)
Definition: string_abstraction.cpp:629
string_abstractiont::abstract_assign
goto_programt::targett abstract_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:507
string_abstraction
void string_abstraction(goto_modelt &, message_handlert &)
Definition: string_abstraction.cpp:83
typet
The type of an expression, extends irept.
Definition: type.h:27
code_typet::parameterst
std::vector< parametert > parameterst
Definition: std_types.h:754
string_abstractiont::build_pointer
bool build_pointer(const exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:868
string_abstractiont::abstraction_types_map
abstraction_types_mapt abstraction_types_map
Definition: string_abstraction.h:40
mp_integer
BigInt mp_integer
Definition: mp_arith.h:22
if_exprt
The trinary if-then-else operator.
Definition: std_expr.h:3427
string_abstractiont::string_struct
typet string_struct
Definition: string_abstraction.h:134
string_abstractiont::whatt::LENGTH
@ LENGTH
string_abstractiont::locals
localst locals
Definition: string_abstraction.h:138
string_abstractiont::current_args
::std::set< irep_idt > current_args
Definition: string_abstraction.h:42
goto_model.h
exprt
Base class for all expressions.
Definition: expr.h:54
goto_modelt
Definition: goto_model.h:24
string_abstractiont::build_abstraction_type_rec
const typet & build_abstraction_type_rec(const typet &type, const abstraction_types_mapt &known)
Definition: string_abstraction.cpp:684
configt::ansi_c
struct configt::ansi_ct ansi_c
symbol_exprt
Expression to hold a symbol (variable)
Definition: std_expr.h:143
string_abstractiont::is_ptr_string_struct
bool is_ptr_string_struct(const typet &type) const
Definition: string_abstraction.cpp:54
string_abstractiont::abstract_function_call
void abstract_function_call(goto_programt::targett it)
Definition: string_abstraction.cpp:534
string_abstractiont::abstract_char_assign
goto_programt::targett abstract_char_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:1111
string_abstractiont::value_assignments
goto_programt::targett value_assignments(goto_programt &dest, goto_programt::targett it, const exprt &lhs, const exprt &rhs)
Definition: string_abstraction.cpp:1215
string_abstractiont::make_type
void make_type(exprt &dest, const typet &type)
Definition: string_abstraction.h:67
configt::ansi_ct::char_width
std::size_t char_width
Definition: config.h:33
string_abstractiont::is_char_type
bool is_char_type(const typet &type) const
Definition: string_abstraction.h:53
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:93
string_abstractiont::whatt
whatt
Definition: string_abstraction.h:106
string_abstractiont::sym_suffix
std::string sym_suffix
Definition: string_abstraction.h:34
exprt::type
typet & type()
Return the type of the expression.
Definition: expr.h:68
string_abstractiont::abstraction_types_mapt
::std::map< typet, typet > abstraction_types_mapt
Definition: string_abstraction.h:39
irept::is_not_nil
bool is_not_nil() const
Definition: irep.h:173
string_abstractiont::has_string_macros
static bool has_string_macros(const exprt &expr)
Definition: string_abstraction.cpp:587
string_abstractiont::symbol_table
symbol_tablet & symbol_table
Definition: string_abstraction.h:35
string_abstractiont
Definition: string_abstraction.h:22
string_abstractiont::build_unknown
exprt build_unknown(whatt what, bool write)
Definition: string_abstraction.cpp:900
string_abstractiont::whatt::SIZE
@ SIZE
string_abstractiont::declare_define_locals
void declare_define_locals(goto_programt &dest)
Definition: string_abstraction.cpp:251
string_abstractiont::make_val_or_dummy_rec
exprt make_val_or_dummy_rec(goto_programt &dest, goto_programt::targett ref_instr, const symbolt &symbol, const typet &source_type)
Definition: string_abstraction.cpp:321
string_abstractiont::add_dummy_symbol_and_value
symbol_exprt add_dummy_symbol_and_value(goto_programt &dest, goto_programt::targett ref_instr, const symbolt &symbol, const irep_idt &component_name, const typet &type, const typet &source_type)
Definition: string_abstraction.cpp:392
string_abstractiont::ns
namespacet ns
Definition: string_abstraction.h:36
string_abstractiont::build_new_symbol
void build_new_symbol(const symbolt &symbol, const irep_idt &identifier, const typet &type)
Definition: string_abstraction.cpp:978
string_abstractiont::build_abstraction_type
const typet & build_abstraction_type(const typet &type)
Definition: string_abstraction.cpp:665
irept::id
const irep_idt & id() const
Definition: irep.h:259
message_handlert
Definition: message.h:24
string_abstractiont::char_assign
goto_programt::targett char_assign(goto_programt &dest, goto_programt::targett target, const exprt &new_lhs, const exprt &lhs, const exprt &rhs)
Definition: string_abstraction.cpp:1176
string_abstractiont::value_assignments_if
goto_programt::targett value_assignments_if(goto_programt &dest, goto_programt::targett target, const exprt &lhs, const if_exprt &rhs)
Definition: string_abstraction.cpp:1263
string_abstractiont::initialization
goto_programt initialization
Definition: string_abstraction.h:135
string_abstractiont::build_wrap
bool build_wrap(const exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:25
string_abstractiont::replace_string_macros
void replace_string_macros(exprt &expr, bool lhs, const source_locationt &)
Definition: string_abstraction.cpp:601
config
configt config
Definition: config.cpp:24
source_locationt
Definition: source_location.h:20
bitvector_typet::get_width
std::size_t get_width() const
Definition: std_types.h:1117
goto_functionst::goto_functiont
::goto_functiont goto_functiont
Definition: goto_functions.h:25
goto_functionst
A collection of goto functions.
Definition: goto_functions.h:22
string_abstractiont::abstract_pointer_assign
goto_programt::targett abstract_pointer_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:1066
namespace_baset::follow
const typet & follow(const typet &) const
Resolve type symbol to the type it points to.
Definition: namespace.cpp:62
string_abstractiont::temporary_counter
unsigned temporary_counter
Definition: string_abstraction.h:37
symbolt
Symbol table entry.
Definition: symbol.h:27
string_abstractiont::build_symbol_constant
bool build_symbol_constant(const mp_integer &zero_length, const mp_integer &buf_size, exprt &dest)
Definition: string_abstraction.cpp:1009
string_abstractiont::make_decl_and_def
void make_decl_and_def(goto_programt &dest, goto_programt::targett ref_instr, const irep_idt &identifier, const irep_idt &source_sym)
Definition: string_abstraction.cpp:286
goto_programt
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:72
string_abstractiont::whatt::IS_ZERO
@ IS_ZERO
config.h
string_abstractiont::build_array
bool build_array(const array_exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:843
string_abstractiont::add_str_arguments
void add_str_arguments(const irep_idt &name, goto_functionst::goto_functiont &fct)
Definition: string_abstraction.cpp:171
string_abstractiont::move_lhs_arithmetic
void move_lhs_arithmetic(exprt &lhs, exprt &rhs)
Definition: string_abstraction.cpp:1054
symbol_table.h
Author: Diffblue Ltd.
exprt::make_typecast
void make_typecast(const typet &_type)
Create a typecast_exprt to the given type.
Definition: expr.cpp:74
message.h
string_abstractiont::arg_suffix
const std::string arg_suffix
Definition: string_abstraction.h:33
string_abstractiont::build_if
bool build_if(const if_exprt &o_if, exprt &dest, bool write)
Definition: string_abstraction.cpp:815
string_abstractiont::localst
std::unordered_map< irep_idt, irep_idt > localst
Definition: string_abstraction.h:137
std_expr.h
string_abstractiont::operator()
void operator()(goto_programt &dest)
Definition: string_abstraction.cpp:161
array_exprt
Array constructor from list of elements.
Definition: std_expr.h:1739
string_abstractiont::build_symbol
bool build_symbol(const symbol_exprt &sym, exprt &dest)
Definition: string_abstraction.cpp:951
string_abstractiont::add_argument
void add_argument(code_typet::parameterst &str_args, const symbolt &fct_symbol, const typet &type, const irep_idt &base_name, const irep_idt &identifier)
Definition: string_abstraction.cpp:208
goto_programt::targett
instructionst::iterator targett
Definition: goto_program.h:414
to_bitvector_type
const bitvector_typet & to_bitvector_type(const typet &type)
Cast a typet to a bitvector_typet.
Definition: std_types.h:1158
string_abstractiont::value_assignments_string_struct
goto_programt::targett value_assignments_string_struct(goto_programt &dest, goto_programt::targett target, const exprt &lhs, const exprt &rhs)
Definition: string_abstraction.cpp:1300