CBMC
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/bitvector_types.h>
16 #include <util/config.h>
17 #include <util/namespace.h>
18 #include <util/std_expr.h>
19 
20 #include "goto_function.h"
21 
22 #include <map>
23 
24 class goto_functionst;
25 class goto_modelt;
26 class message_handlert;
27 
34 {
35 public:
41  message_handlert &_message_handler);
42 
43  void apply();
44 
45 protected:
46  std::string sym_suffix;
51 
52  typedef ::std::map< typet, typet > abstraction_types_mapt;
54 
55  void apply(goto_programt &dest);
56 
57  static bool has_string_macros(const exprt &expr);
58 
60  exprt &expr,
61  bool lhs,
62  const source_locationt &);
63 
64  void move_lhs_arithmetic(exprt &lhs, exprt &rhs);
65 
66  bool is_char_type(const typet &type) const
67  {
68  if(type.id()!=ID_signedbv &&
69  type.id()!=ID_unsignedbv)
70  return false;
71 
73  }
74 
75  bool is_ptr_string_struct(const typet &type) const;
76 
77  void make_type(exprt &dest, const typet &type)
78  {
79  if(dest.is_not_nil() &&
80  ns.follow(dest.type())!=ns.follow(type))
81  dest = typecast_exprt(dest, type);
82  }
83 
84  goto_programt::targett abstract(
92 
94  goto_programt &dest,
96  const exprt &new_lhs,
97  const exprt &lhs,
98  const exprt &rhs);
99 
101 
104  const exprt &lhs, const exprt &rhs);
105 
107  goto_programt &dest,
108  goto_programt::targett target,
109  const exprt &lhs, const if_exprt &rhs);
110 
112  goto_programt &dest,
113  goto_programt::targett target,
114  const exprt &lhs, const exprt &rhs);
115 
116  enum class whatt { IS_ZERO, LENGTH, SIZE };
117 
118  static typet build_type(whatt what);
119  exprt build(
120  const exprt &pointer,
121  whatt what,
122  bool write,
123  const source_locationt &);
124 
125  bool build(const exprt &object, exprt &dest, bool write);
126  bool build_wrap(const exprt &object, exprt &dest, bool write);
127  bool build_if(const if_exprt &o_if, exprt &dest, bool write);
128  bool build_array(const array_exprt &object, exprt &dest, bool write);
129  bool build_symbol(const symbol_exprt &sym, exprt &dest);
130  bool build_symbol_constant(const mp_integer &zero_length,
131  const mp_integer &buf_size, exprt &dest);
132 
133  exprt build_unknown(whatt what, bool write);
134  exprt build_unknown(const typet &type, bool write);
135  const typet &build_abstraction_type(const typet &type);
136  const typet &build_abstraction_type_rec(const typet &type,
137  const abstraction_types_mapt &known);
138  bool build_pointer(const exprt &object, exprt &dest, bool write);
139  void build_new_symbol(const symbolt &symbol,
140  const irep_idt &identifier, const typet &type);
141 
142  exprt member(const exprt &a, whatt what);
143 
146 
147  typedef std::unordered_map<irep_idt, irep_idt> localst;
150 
151  void abstract(goto_programt &dest);
152 
153  void add_str_parameters(
154  symbolt &fct_symbol,
155  goto_functiont::parameter_identifierst &parameter_identifiers);
156 
158  const symbolt &fct_symbol,
159  const typet &type,
160  const irep_idt &identifier);
161 
163  const irep_idt &identifier, const irep_idt &source_sym);
164 
166  goto_programt::targett ref_instr,
167  const symbolt &symbol, const typet &source_type);
168 
170  goto_programt &dest,
171  goto_programt::targett ref_instr,
172  const symbolt &symbol,
173  const irep_idt &component_name,
174  const typet &type,
175  const typet &source_type);
176 
178 };
179 
180 // keep track of length of strings
181 
182 void string_abstraction(
183  goto_modelt &,
184  message_handlert &);
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:36
string_abstractiont::member
exprt member(const exprt &a, whatt what)
Definition: string_abstraction.cpp:1408
string_abstractiont::build_type
static typet build_type(whatt what)
Definition: string_abstraction.cpp:114
mp_integer
BigInt mp_integer
Definition: smt_terms.h:17
string_abstractiont::build
exprt build(const exprt &pointer, whatt what, bool write, const source_locationt &)
Definition: string_abstraction.cpp:643
string_abstractiont::abstract_assign
goto_programt::targett abstract_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:523
string_abstraction
void string_abstraction(goto_modelt &, message_handlert &)
Definition: string_abstraction.cpp:72
typet
The type of an expression, extends irept.
Definition: type.h:28
string_abstractiont::build_pointer
bool build_pointer(const exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:925
string_abstractiont::abstraction_types_map
abstraction_types_mapt abstraction_types_map
Definition: string_abstraction.h:53
if_exprt
The trinary if-then-else operator.
Definition: std_expr.h:2322
string_abstractiont::string_struct
typet string_struct
Definition: string_abstraction.h:144
string_abstractiont::whatt::LENGTH
@ LENGTH
string_abstractiont::locals
localst locals
Definition: string_abstraction.h:148
string_abstractiont::apply
void apply()
Definition: string_abstraction.cpp:130
exprt
Base class for all expressions.
Definition: expr.h:55
goto_modelt
Definition: goto_model.h:25
string_abstractiont::build_abstraction_type_rec
const typet & build_abstraction_type_rec(const typet &type, const abstraction_types_mapt &known)
Definition: string_abstraction.cpp:704
configt::ansi_c
struct configt::ansi_ct ansi_c
to_bitvector_type
const bitvector_typet & to_bitvector_type(const typet &type)
Cast a typet to a bitvector_typet.
Definition: bitvector_types.h:32
symbol_exprt
Expression to hold a symbol (variable)
Definition: std_expr.h:112
string_abstractiont::is_ptr_string_struct
bool is_ptr_string_struct(const typet &type) const
Definition: string_abstraction.cpp:61
namespace.h
string_abstractiont::add_parameter
code_typet::parametert add_parameter(const symbolt &fct_symbol, const typet &type, const irep_idt &identifier)
Definition: string_abstraction.cpp:220
string_abstractiont::abstract_function_call
void abstract_function_call(goto_programt::targett it)
Definition: string_abstraction.cpp:551
string_abstractiont::abstract_char_assign
goto_programt::targett abstract_char_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:1190
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:1287
string_abstractiont::make_type
void make_type(exprt &dest, const typet &type)
Definition: string_abstraction.h:77
configt::ansi_ct::char_width
std::size_t char_width
Definition: config.h:127
string_abstractiont::is_char_type
bool is_char_type(const typet &type) const
Definition: string_abstraction.h:66
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:90
string_abstractiont::whatt
whatt
Definition: string_abstraction.h:116
string_abstractiont::sym_suffix
std::string sym_suffix
Definition: string_abstraction.h:46
exprt::type
typet & type()
Return the type of the expression.
Definition: expr.h:84
string_abstractiont::abstraction_types_mapt
::std::map< typet, typet > abstraction_types_mapt
Definition: string_abstraction.h:52
irept::is_not_nil
bool is_not_nil() const
Definition: irep.h:380
string_abstractiont::has_string_macros
static bool has_string_macros(const exprt &expr)
Definition: string_abstraction.cpp:598
string_abstractiont
Replace all uses of char * by a struct that carries that string, and also the underlying allocation a...
Definition: string_abstraction.h:33
string_abstractiont::build_unknown
exprt build_unknown(whatt what, bool write)
Definition: string_abstraction.cpp:958
string_abstractiont::whatt::SIZE
@ SIZE
string_abstractiont::declare_define_locals
void declare_define_locals(goto_programt &dest)
Definition: string_abstraction.cpp:267
bitvector_types.h
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:333
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:406
string_abstractiont::parameter_map
localst parameter_map
Definition: string_abstraction.h:149
string_abstractiont::ns
namespacet ns
Definition: string_abstraction.h:48
string_abstractiont::build_new_symbol
void build_new_symbol(const symbolt &symbol, const irep_idt &identifier, const typet &type)
Definition: string_abstraction.cpp:1049
string_abstractiont::build_abstraction_type
const typet & build_abstraction_type(const typet &type)
Definition: string_abstraction.cpp:686
irept::id
const irep_idt & id() const
Definition: irep.h:396
message_handlert
Definition: message.h:27
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:1253
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:1334
string_abstractiont::initialization
goto_programt initialization
Definition: string_abstraction.h:145
string_abstractiont::build_wrap
bool build_wrap(const exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:29
string_abstractiont::replace_string_macros
void replace_string_macros(exprt &expr, bool lhs, const source_locationt &)
Definition: string_abstraction.cpp:612
config
configt config
Definition: config.cpp:25
source_locationt
Definition: source_location.h:18
bitvector_typet::get_width
std::size_t get_width() const
Definition: std_types.h:876
string_abstractiont::add_str_parameters
void add_str_parameters(symbolt &fct_symbol, goto_functiont::parameter_identifierst &parameter_identifiers)
Definition: string_abstraction.cpp:193
goto_functionst
A collection of goto functions.
Definition: goto_functions.h:24
string_abstractiont::abstract_pointer_assign
goto_programt::targett abstract_pointer_assign(goto_programt &dest, goto_programt::targett it)
Definition: string_abstraction.cpp:1149
string_abstractiont::goto_model
goto_modelt & goto_model
Definition: string_abstraction.h:47
namespace_baset::follow
const typet & follow(const typet &) const
Resolve type symbol to the type it points to.
Definition: namespace.cpp:49
string_abstractiont::temporary_counter
unsigned temporary_counter
Definition: string_abstraction.h:49
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:1081
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:302
code_typet::parametert
Definition: std_types.h:555
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
goto_functiont::parameter_identifierst
std::vector< irep_idt > parameter_identifierst
Definition: goto_function.h:28
string_abstractiont::build_array
bool build_array(const array_exprt &object, exprt &dest, bool write)
Definition: string_abstraction.cpp:899
string_abstractiont::move_lhs_arithmetic
void move_lhs_arithmetic(exprt &lhs, exprt &rhs)
Definition: string_abstraction.cpp:1123
typecast_exprt
Semantic type conversion.
Definition: std_expr.h:2016
string_abstractiont::string_abstractiont
string_abstractiont(goto_modelt &goto_model, message_handlert &_message_handler)
Apply string abstraction to goto_model.
Definition: string_abstraction.cpp:79
string_abstractiont::build_if
bool build_if(const if_exprt &o_if, exprt &dest, bool write)
Definition: string_abstraction.cpp:871
string_abstractiont::localst
std::unordered_map< irep_idt, irep_idt > localst
Definition: string_abstraction.h:147
std_expr.h
string_abstractiont::message_handler
message_handlert & message_handler
Definition: string_abstraction.h:50
array_exprt
Array constructor from list of elements.
Definition: std_expr.h:1562
goto_function.h
string_abstractiont::build_symbol
bool build_symbol(const symbol_exprt &sym, exprt &dest)
Definition: string_abstraction.cpp:1009
goto_programt::targett
instructionst::iterator targett
Definition: goto_program.h:586
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:1365