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/config.h>
17 #include <util/std_expr.h>
18 
19 #include "goto_model.h"
20 
21 class message_handlert;
22 
29 {
30 public:
32  symbol_tablet &_symbol_table,
33  message_handlert &_message_handler);
34 
35  void operator()(goto_programt &dest);
36  void operator()(goto_functionst &dest);
37 
38 protected:
39  const std::string arg_suffix;
40  std::string sym_suffix;
45 
46  typedef ::std::map< typet, typet > abstraction_types_mapt;
48 
49  ::std::set< irep_idt > current_args;
50 
51  static bool has_string_macros(const exprt &expr);
52 
54  exprt &expr,
55  bool lhs,
56  const source_locationt &);
57 
58  void move_lhs_arithmetic(exprt &lhs, exprt &rhs);
59 
60  bool is_char_type(const typet &type) const
61  {
62  if(type.id()!=ID_signedbv &&
63  type.id()!=ID_unsignedbv)
64  return false;
65 
67  }
68 
69  bool is_ptr_string_struct(const typet &type) const;
70 
71  void make_type(exprt &dest, const typet &type)
72  {
73  if(dest.is_not_nil() &&
74  ns.follow(dest.type())!=ns.follow(type))
75  dest = typecast_exprt(dest, type);
76  }
77 
78  goto_programt::targett abstract(
86 
88  goto_programt &dest,
90  const exprt &new_lhs,
91  const exprt &lhs,
92  const exprt &rhs);
93 
95 
98  const exprt &lhs, const exprt &rhs);
99 
101  goto_programt &dest,
102  goto_programt::targett target,
103  const exprt &lhs, const if_exprt &rhs);
104 
106  goto_programt &dest,
107  goto_programt::targett target,
108  const exprt &lhs, const exprt &rhs);
109 
110  enum class whatt { IS_ZERO, LENGTH, SIZE };
111 
112  static typet build_type(whatt what);
113  exprt build(
114  const exprt &pointer,
115  whatt what,
116  bool write,
117  const source_locationt &);
118 
119  bool build(const exprt &object, exprt &dest, bool write);
120  bool build_wrap(const exprt &object, exprt &dest, bool write);
121  bool build_if(const if_exprt &o_if, exprt &dest, bool write);
122  bool build_array(const array_exprt &object, exprt &dest, bool write);
123  bool build_symbol(const symbol_exprt &sym, exprt &dest);
124  bool build_symbol_constant(const mp_integer &zero_length,
125  const mp_integer &buf_size, exprt &dest);
126 
127  exprt build_unknown(whatt what, bool write);
128  exprt build_unknown(const typet &type, bool write);
129  const typet &build_abstraction_type(const typet &type);
130  const typet &build_abstraction_type_rec(const typet &type,
131  const abstraction_types_mapt &known);
132  bool build_pointer(const exprt &object, exprt &dest, bool write);
133  void build_new_symbol(const symbolt &symbol,
134  const irep_idt &identifier, const typet &type);
135 
136  exprt member(const exprt &a, whatt what);
137 
140 
141  typedef std::unordered_map<irep_idt, irep_idt> localst;
143 
144  void abstract(goto_programt &dest);
145 
146  void add_str_arguments(
147  const irep_idt &name,
149 
150  void add_argument(
151  code_typet::parameterst &str_args,
152  const symbolt &fct_symbol,
153  const typet &type,
154  const irep_idt &base_name,
155  const irep_idt &identifier);
156 
158  const irep_idt &identifier, const irep_idt &source_sym);
159 
161  goto_programt::targett ref_instr,
162  const symbolt &symbol, const typet &source_type);
163 
165  goto_programt &dest,
166  goto_programt::targett ref_instr,
167  const symbolt &symbol,
168  const irep_idt &component_name,
169  const typet &type,
170  const typet &source_type);
171 
173 };
174 
175 // keep track of length of strings
176 
177 void string_abstraction(
178  goto_modelt &,
179  message_handlert &);
180 
181 void string_abstraction(
182  symbol_tablet &,
184  goto_functionst &);
185 
186 #endif // CPROVER_GOTO_PROGRAMS_STRING_ABSTRACTION_H
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
string_abstractiont::string_abstractiont
string_abstractiont(symbol_tablet &_symbol_table, message_handlert &_message_handler)
Definition: string_abstraction.cpp:96
symbol_tablet
The symbol table.
Definition: symbol_table.h:20
string_abstractiont::member
exprt member(const exprt &a, whatt what)
Definition: string_abstraction.cpp:1323
string_abstractiont::build_type
static typet build_type(whatt what)
Definition: string_abstraction.cpp:116
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:496
string_abstraction
void string_abstraction(goto_modelt &, message_handlert &)
Definition: string_abstraction.cpp:86
typet
The type of an expression, extends irept.
Definition: type.h:28
code_typet::parameterst
std::vector< parametert > parameterst
Definition: std_types.h:746
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:47
mp_integer
BigInt mp_integer
Definition: mp_arith.h:19
if_exprt
The trinary if-then-else operator.
Definition: std_expr.h:2087
string_abstractiont::string_struct
typet string_struct
Definition: string_abstraction.h:138
string_abstractiont::whatt::LENGTH
@ LENGTH
string_abstractiont::locals
localst locals
Definition: string_abstraction.h:142
string_abstractiont::current_args
::std::set< irep_idt > current_args
Definition: string_abstraction.h:49
goto_model.h
Symbol Table + CFG.
exprt
Base class for all expressions.
Definition: expr.h:54
goto_modelt
Definition: goto_model.h:26
string_abstractiont::build_abstraction_type_rec
const typet & build_abstraction_type_rec(const typet &type, const abstraction_types_mapt &known)
Definition: string_abstraction.cpp:682
configt::ansi_c
struct configt::ansi_ct ansi_c
symbol_exprt
Expression to hold a symbol (variable)
Definition: std_expr.h:81
string_abstractiont::is_ptr_string_struct
bool is_ptr_string_struct(const typet &type) const
Definition: string_abstraction.cpp:58
string_abstractiont::abstract_function_call
void abstract_function_call(goto_programt::targett it)
Definition: string_abstraction.cpp:528
string_abstractiont::abstract_char_assign
goto_programt::targett abstract_char_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:1107
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:1205
string_abstractiont::make_type
void make_type(exprt &dest, const typet &type)
Definition: string_abstraction.h:71
configt::ansi_ct::char_width
std::size_t char_width
Definition: config.h:114
string_abstractiont::is_char_type
bool is_char_type(const typet &type) const
Definition: string_abstraction.h:60
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:92
string_abstractiont::whatt
whatt
Definition: string_abstraction.h:110
string_abstractiont::sym_suffix
std::string sym_suffix
Definition: string_abstraction.h:40
exprt::type
typet & type()
Return the type of the expression.
Definition: expr.h:82
string_abstractiont::abstraction_types_mapt
::std::map< typet, typet > abstraction_types_mapt
Definition: string_abstraction.h:46
irept::is_not_nil
bool is_not_nil() const
Definition: irep.h:391
string_abstractiont::has_string_macros
static bool has_string_macros(const exprt &expr)
Definition: string_abstraction.cpp:584
string_abstractiont::symbol_table
symbol_tablet & symbol_table
Definition: string_abstraction.h:41
string_abstractiont
Replace all uses of char * by a struct that carries that string, and also the underlying allocation a...
Definition: string_abstraction.h:29
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:244
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:309
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:379
string_abstractiont::ns
namespacet ns
Definition: string_abstraction.h:42
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:663
irept::id
const irep_idt & id() const
Definition: irep.h:407
message_handlert
Definition: message.h:28
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:1172
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:1252
string_abstractiont::initialization
goto_programt initialization
Definition: string_abstraction.h:139
string_abstractiont::build_wrap
bool build_wrap(const exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:27
string_abstractiont::replace_string_macros
void replace_string_macros(exprt &expr, bool lhs, const source_locationt &)
Definition: string_abstraction.cpp:598
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:1048
goto_functionst::goto_functiont
::goto_functiont goto_functiont
Definition: goto_functions.h:25
goto_functionst
A collection of goto functions.
Definition: goto_functions.h:23
string_abstractiont::abstract_pointer_assign
goto_programt::targett abstract_pointer_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:1065
namespace_baset::follow
const typet & follow(const typet &) const
Resolve type symbol to the type it points to.
Definition: namespace.cpp:51
string_abstractiont::temporary_counter
unsigned temporary_counter
Definition: string_abstraction.h:43
symbolt
Symbol table entry.
Definition: symbol.h:28
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:1010
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:279
goto_programt
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:74
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:842
string_abstractiont::add_str_arguments
void add_str_arguments(const irep_idt &name, goto_functionst::goto_functiont &fct)
Definition: string_abstraction.cpp:165
string_abstractiont::move_lhs_arithmetic
void move_lhs_arithmetic(exprt &lhs, exprt &rhs)
Definition: string_abstraction.cpp:1053
symbol_table.h
Author: Diffblue Ltd.
typecast_exprt
Semantic type conversion.
Definition: std_expr.h:1781
string_abstractiont::arg_suffix
const std::string arg_suffix
Definition: string_abstraction.h:39
string_abstractiont::build_if
bool build_if(const if_exprt &o_if, exprt &dest, bool write)
Definition: string_abstraction.cpp:814
string_abstractiont::localst
std::unordered_map< irep_idt, irep_idt > localst
Definition: string_abstraction.h:141
std_expr.h
API to expression classes.
string_abstractiont::message_handler
message_handlert & message_handler
Definition: string_abstraction.h:44
string_abstractiont::operator()
void operator()(goto_programt &dest)
Definition: string_abstraction.cpp:155
array_exprt
Array constructor from list of elements.
Definition: std_expr.h:1382
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:201
goto_programt::targett
instructionst::iterator targett
Definition: goto_program.h:550
to_bitvector_type
const bitvector_typet & to_bitvector_type(const typet &type)
Cast a typet to a bitvector_typet.
Definition: std_types.h:1096
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:1283