cprover
value_set_fivrns.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Value Set (Flow Insensitive, Validity Regions)
4 
5 Author: Daniel Kroening, kroening@kroening.com
6  CM Wintersteiger
7 
8 \*******************************************************************/
9 
12 
13 #ifndef CPROVER_POINTER_ANALYSIS_VALUE_SET_FIVRNS_H
14 #define CPROVER_POINTER_ANALYSIS_VALUE_SET_FIVRNS_H
15 
16 #include <list>
17 #include <map>
18 #include <string>
19 #include <unordered_set>
20 
21 #include <util/mp_arith.h>
22 #include <util/namespace.h>
24 #include <util/invariant.h>
25 
26 #include "object_numbering.h"
27 
29 {
30 public:
32  {
33  }
34 
39 
40  void set_from(const irep_idt &function, unsigned inx)
41  {
42  from_function = function_numbering.number(function);
43  from_target_index = inx;
44  }
45 
46  void set_to(const irep_idt &function, unsigned inx)
47  {
48  to_function = function_numbering.number(function);
49  to_target_index = inx;
50  }
51 
52  typedef irep_idt idt;
53 
57  bool offset_is_zero(offsett offset) const
58  {
59  return offset && offset->is_zero();
60  }
61 
63  {
64  public:
66  static const object_map_dt blank;
67 
68  typedef std::map<object_numberingt::number_type, offsett> objmapt;
70 
71  // NOLINTNEXTLINE(readability/identifiers)
72  typedef objmapt::const_iterator const_iterator;
73  // NOLINTNEXTLINE(readability/identifiers)
74  typedef objmapt::iterator iterator;
75 
77  {
78  return objmap.find(k);
79  }
80  iterator begin() { return objmap.begin(); }
81  const_iterator begin() const { return objmap.begin(); }
82  iterator end() { return objmap.end(); }
83  const_iterator end() const { return objmap.end(); }
84  size_t size() const { return objmap.size(); }
85  bool empty() const { return objmap.empty(); }
86  void clear() { objmap.clear(); validity_ranges.clear(); }
87 
89  {
90  return objmap[k];
91  }
92 
93  // operator[] is the only way to insert something!
94  std::pair<iterator, bool>
95  insert(const std::pair<object_numberingt::number_type, offsett> &)
96  {
98  }
99  iterator
100  insert(iterator, const std::pair<object_numberingt::number_type, offsett> &)
101  {
102  UNREACHABLE;
103  }
104 
106  {
107  public:
108  unsigned function;
109  unsigned from, to;
110 
112  function(0), from(0), to(0)
113  {
114  }
115 
116  validity_ranget(unsigned fnc, unsigned f, unsigned t):
117  function(fnc), from(f), to(t)
118  {
119  }
120 
121  bool contains(unsigned f, unsigned line) const
122  {
123  return (function==f && from<=line && line<=to);
124  }
125  };
126 
127  typedef std::list<validity_ranget> vrange_listt;
128  typedef std::map<unsigned, vrange_listt> validity_rangest;
130 
131  bool set_valid_at(unsigned inx, unsigned f, unsigned line);
132  bool is_valid_at(unsigned inx, unsigned f, unsigned line) const;
133  };
134 
136 
138 
140  {
141  dest.write()[it->first]=it->second;
142  }
143 
145  {
146  return insert_to(dest, it->first, it->second);
147  }
148 
149  bool insert_to(object_mapt &dest, const exprt &src) const
150  {
151  return insert_to(dest, object_numbering.number(src), offsett());
152  }
153 
154  bool insert_to(
155  object_mapt &dest,
156  const exprt &src,
157  const mp_integer &offset_value) const
158  {
159  return insert_to(dest, object_numbering.number(src), offsett(offset_value));
160  }
161 
162  bool insert_to(
163  object_mapt &dest,
165  const offsett &offset) const;
166 
167  bool
168  insert_to(object_mapt &dest, const exprt &expr, const offsett &offset) const
169  {
170  return insert_to(dest, object_numbering.number(expr), offset);
171  }
172 
174  {
175  return insert_from(dest, it->first, it->second);
176  }
177 
178  bool insert_from(object_mapt &dest, const exprt &src) const
179  {
180  return insert_from(dest, object_numbering.number(src), offsett());
181  }
182 
184  object_mapt &dest,
185  const exprt &src,
186  const mp_integer &offset_value) const
187  {
188  return insert_from(
189  dest, object_numbering.number(src), offsett(offset_value));
190  }
191 
192  bool insert_from(
193  object_mapt &dest,
195  const offsett &offset) const;
196 
197  bool
198  insert_from(object_mapt &dest, const exprt &expr, const offsett &offset) const
199  {
200  return insert_from(dest, object_numbering.number(expr), offset);
201  }
202 
203  struct entryt
204  {
207  std::string suffix;
208 
209  entryt() { }
210 
211  entryt(const idt &_identifier, const std::string _suffix):
212  identifier(_identifier),
213  suffix(_suffix)
214  {
215  }
216  };
217 
218  typedef std::unordered_set<exprt, irep_hash> expr_sett;
219 
220  typedef std::unordered_set<unsigned int> dynamic_object_id_sett;
221 
222  #ifdef USE_DSTRING
223  typedef std::map<idt, entryt> valuest;
224  #else
225  typedef std::unordered_map<idt, entryt, string_hash> valuest;
226  #endif
227 
228  void get_value_set(
229  const exprt &expr,
230  std::list<exprt> &expr_set,
231  const namespacet &ns) const;
232 
233  expr_sett &get(
234  const idt &identifier,
235  const std::string &suffix);
236 
237  void clear()
238  {
239  values.clear();
240  }
241 
242  void add_var(const idt &id, const std::string &suffix)
243  {
244  get_entry(id, suffix);
245  }
246 
247  void add_var(const entryt &e)
248  {
250  }
251 
252  entryt &get_entry(const idt &id, const std::string &suffix)
253  {
254  return get_entry(entryt(id, suffix));
255  }
256 
258  {
259  std::string index=id2string(e.identifier)+e.suffix;
260 
261  std::pair<valuest::iterator, bool> r=
262  values.insert(std::pair<idt, entryt>(index, e));
263 
264  return r.first->second;
265  }
266 
267  entryt &get_temporary_entry(const idt &id, const std::string &suffix)
268  {
269  std::string index=id2string(id)+suffix;
270  return temporary_values[index];
271  }
272 
273  void add_vars(const std::list<entryt> &vars)
274  {
275  for(std::list<entryt>::const_iterator
276  it=vars.begin();
277  it!=vars.end();
278  it++)
279  add_var(*it);
280  }
281 
282  void output(
283  const namespacet &ns,
284  std::ostream &out) const;
285 
286  void output_entry(
287  const entryt &e,
288  const namespacet &ns,
289  std::ostream &out) const;
290 
293 
294  // true = added something new
295  bool make_union(
296  object_mapt &dest,
297  const object_mapt &src) const;
298 
299  bool make_valid_union(
300  object_mapt &dest,
301  const object_mapt &src) const;
302 
303  void copy_objects(
304  object_mapt &dest,
305  const object_mapt &src) const;
306 
307  void apply_code(
308  const exprt &code,
309  const namespacet &ns);
310 
311  bool handover();
312 
313  void assign(
314  const exprt &lhs,
315  const exprt &rhs,
316  const namespacet &ns,
317  bool add_to_sets=false);
318 
319  void do_function_call(
320  const irep_idt &function,
321  const exprt::operandst &arguments,
322  const namespacet &ns);
323 
324  // edge back to call site
325  void do_end_function(
326  const exprt &lhs,
327  const namespacet &ns);
328 
329  void get_reference_set(
330  const exprt &expr,
331  expr_sett &expr_set,
332  const namespacet &ns) const;
333 
334 protected:
335  void get_value_set_rec(
336  const exprt &expr,
337  object_mapt &dest,
338  const std::string &suffix,
339  const typet &original_type,
340  const namespacet &ns) const;
341 
342  void get_value_set(
343  const exprt &expr,
344  object_mapt &dest,
345  const namespacet &ns) const;
346 
348  const exprt &expr,
349  object_mapt &dest,
350  const namespacet &ns) const
351  {
352  get_reference_set_rec(expr, dest, ns);
353  }
354 
356  const exprt &expr,
357  object_mapt &dest,
358  const namespacet &ns) const;
359 
360  void dereference_rec(
361  const exprt &src,
362  exprt &dest) const;
363 
364  void assign_rec(
365  const exprt &lhs,
366  const object_mapt &values_rhs,
367  const std::string &suffix,
368  const namespacet &ns,
369  bool add_to_sets);
370 };
371 
372 #endif // CPROVER_POINTER_ANALYSIS_VALUE_SET_FIVRNS_H
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:35
value_set_fivrnst::object_map_dt::validity_ranget::contains
bool contains(unsigned f, unsigned line) const
Definition: value_set_fivrns.h:121
value_set_fivrnst::set
void set(object_mapt &dest, object_map_dt::const_iterator it) const
Definition: value_set_fivrns.h:139
value_set_fivrnst::assign
void assign(const exprt &lhs, const exprt &rhs, const namespacet &ns, bool add_to_sets=false)
Definition: value_set_fivrns.cpp:763
value_set_fivrnst::output
void output(const namespacet &ns, std::ostream &out) const
Definition: value_set_fivrns.cpp:57
value_set_fivrnst::to_expr
exprt to_expr(object_map_dt::const_iterator it) const
Definition: value_set_fivrns.cpp:202
value_set_fivrnst::object_map_dt::begin
const_iterator begin() const
Definition: value_set_fivrns.h:81
mp_arith.h
value_set_fivrnst::add_var
void add_var(const idt &id, const std::string &suffix)
Definition: value_set_fivrns.h:242
value_set_fivrnst::object_map_dt::set_valid_at
bool set_valid_at(unsigned inx, unsigned f, unsigned line)
Definition: value_set_fivrns.cpp:1310
value_set_fivrnst::object_map_dt::begin
iterator begin()
Definition: value_set_fivrns.h:80
value_set_fivrnst::values
valuest values
Definition: value_set_fivrns.h:291
value_set_fivrnst::object_map_dt::validity_ranget::validity_ranget
validity_ranget()
Definition: value_set_fivrns.h:111
typet
The type of an expression, extends irept.
Definition: type.h:27
value_set_fivrnst::do_function_call
void do_function_call(const irep_idt &function, const exprt::operandst &arguments, const namespacet &ns)
Definition: value_set_fivrns.cpp:1063
value_set_fivrnst::object_map_dt::validity_rangest
std::map< unsigned, vrange_listt > validity_rangest
Definition: value_set_fivrns.h:128
value_set_fivrnst::get_reference_set_rec
void get_reference_set_rec(const exprt &expr, object_mapt &dest, const namespacet &ns) const
Definition: value_set_fivrns.cpp:619
value_set_fivrnst::set_to
void set_to(const irep_idt &function, unsigned inx)
Definition: value_set_fivrns.h:46
mp_integer
BigInt mp_integer
Definition: mp_arith.h:22
value_set_fivrnst::add_vars
void add_vars(const std::list< entryt > &vars)
Definition: value_set_fivrns.h:273
value_set_fivrnst::entryt::entryt
entryt()
Definition: value_set_fivrns.h:209
template_numberingt
Definition: numbering.h:21
value_set_fivrnst::to_target_index
unsigned to_target_index
Definition: value_set_fivrns.h:36
value_set_fivrnst::object_map_dt::insert
std::pair< iterator, bool > insert(const std::pair< object_numberingt::number_type, offsett > &)
Definition: value_set_fivrns.h:95
value_set_fivrnst::object_map_dt::object_map_dt
object_map_dt()
Definition: value_set_fivrns.h:65
value_set_fivrnst::expr_sett
std::unordered_set< exprt, irep_hash > expr_sett
Definition: value_set_fivrns.h:218
value_set_fivrnst::from_target_index
unsigned from_target_index
Definition: value_set_fivrns.h:36
exprt
Base class for all expressions.
Definition: expr.h:54
object_numbering.h
invariant.h
value_set_fivrnst::handover
bool handover()
Definition: value_set_fivrns.cpp:1412
value_set_fivrnst::apply_code
void apply_code(const exprt &code, const namespacet &ns)
Definition: value_set_fivrns.cpp:1144
value_set_fivrnst::object_map_dt::clear
void clear()
Definition: value_set_fivrns.h:86
value_set_fivrnst::entryt::suffix
std::string suffix
Definition: value_set_fivrns.h:207
value_set_fivrnst::assign_rec
void assign_rec(const exprt &lhs, const object_mapt &values_rhs, const std::string &suffix, const namespacet &ns, bool add_to_sets)
Definition: value_set_fivrns.cpp:919
value_set_fivrnst::offsett
optionalt< mp_integer > offsett
Represents the offset into an object: either a unique integer offset, or an unknown value,...
Definition: value_set_fivrns.h:56
namespace.h
UNREACHABLE
#define UNREACHABLE
This should be used to mark dead code.
Definition: invariant.h:478
value_set_fivrnst
Definition: value_set_fivrns.h:28
template_numberingt::number
number_type number(const key_type &a)
Definition: numbering.h:37
value_set_fivrnst::get_value_set
void get_value_set(const exprt &expr, std::list< exprt > &expr_set, const namespacet &ns) const
Definition: value_set_fivrns.cpp:266
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:93
value_set_fivrnst::object_map_dt::objmap
objmapt objmap
Definition: value_set_fivrns.h:69
value_set_fivrnst::object_map_dt::size
size_t size() const
Definition: value_set_fivrns.h:84
value_set_fivrnst::insert_from
bool insert_from(object_mapt &dest, object_map_dt::const_iterator it) const
Definition: value_set_fivrns.h:173
value_set_fivrnst::idt
irep_idt idt
Definition: value_set_fivrns.h:52
value_set_fivrnst::insert_to
bool insert_to(object_mapt &dest, const exprt &expr, const offsett &offset) const
Definition: value_set_fivrns.h:168
id2string
const std::string & id2string(const irep_idt &d)
Definition: irep.h:44
value_set_fivrnst::get_reference_set
void get_reference_set(const exprt &expr, object_mapt &dest, const namespacet &ns) const
Definition: value_set_fivrns.h:347
value_set_fivrnst::get_reference_set
void get_reference_set(const exprt &expr, expr_sett &expr_set, const namespacet &ns) const
Definition: value_set_fivrns.cpp:607
value_set_fivrnst::object_map_dt::empty
bool empty() const
Definition: value_set_fivrns.h:85
value_set_fivrnst::object_map_dt::operator[]
offsett & operator[](object_numberingt::number_type k)
Definition: value_set_fivrns.h:88
value_set_fivrnst::insert_from
bool insert_from(object_mapt &dest, const exprt &expr, const offsett &offset) const
Definition: value_set_fivrns.h:198
value_set_fivrnst::object_map_dt::end
const_iterator end() const
Definition: value_set_fivrns.h:83
value_set_fivrnst::entryt::object_map
object_mapt object_map
Definition: value_set_fivrns.h:205
value_set_fivrnst::object_map_dt::vrange_listt
std::list< validity_ranget > vrange_listt
Definition: value_set_fivrns.h:127
value_set_fivrnst::object_map_dt::find
const_iterator find(object_numberingt::number_type k)
Definition: value_set_fivrns.h:76
value_set_fivrnst::make_valid_union
bool make_valid_union(object_mapt &dest, const object_mapt &src) const
Definition: value_set_fivrns.cpp:237
value_set_fivrnst::object_map_dt::validity_ranges
validity_rangest validity_ranges
Definition: value_set_fivrns.h:129
reference_counting::write
T & write()
Definition: reference_counting.h:74
exprt::operandst
std::vector< exprt > operandst
Definition: expr.h:57
value_set_fivrnst::object_map_dt::is_valid_at
bool is_valid_at(unsigned inx, unsigned f, unsigned line) const
Definition: value_set_fivrns.cpp:1381
value_set_fivrnst::object_map_dt::validity_ranget::to
unsigned to
Definition: value_set_fivrns.h:109
value_set_fivrnst::to_function
unsigned to_function
Definition: value_set_fivrns.h:35
value_set_fivrnst::object_mapt
reference_counting< object_map_dt > object_mapt
Definition: value_set_fivrns.h:137
reference_counting< object_map_dt >
optionalt
nonstd::optional< T > optionalt
Definition: optional.h:35
value_set_fivrnst::get
expr_sett & get(const idt &identifier, const std::string &suffix)
value_set_fivrnst::value_set_fivrnst
value_set_fivrnst()
Definition: value_set_fivrns.h:31
value_set_fivrnst::function_numbering
static hash_numbering< irep_idt, irep_id_hash > function_numbering
Definition: value_set_fivrns.h:38
value_set_fivrnst::set_from
void set_from(const irep_idt &function, unsigned inx)
Definition: value_set_fivrns.h:40
value_set_fivrnst::object_map_dt::const_iterator
objmapt::const_iterator const_iterator
Definition: value_set_fivrns.h:72
value_set_fivrnst::object_map_dt::blank
static const object_map_dt blank
Definition: value_set_fivrns.h:66
value_set_fivrnst::object_map_dt::validity_ranget::function
unsigned function
Definition: value_set_fivrns.h:108
value_set_fivrnst::make_union
bool make_union(object_mapt &dest, const object_mapt &src) const
Definition: value_set_fivrns.cpp:222
value_set_fivrnst::insert_to
bool insert_to(object_mapt &dest, object_map_dt::const_iterator it) const
Definition: value_set_fivrns.h:144
value_set_fivrnst::object_map_dt
Definition: value_set_fivrns.h:62
value_set_fivrnst::copy_objects
void copy_objects(object_mapt &dest, const object_mapt &src) const
Definition: value_set_fivrns.cpp:252
template_numberingt::number_type
typename Map::mapped_type number_type
Definition: numbering.h:24
value_set_fivrnst::dereference_rec
void dereference_rec(const exprt &src, exprt &dest) const
Definition: value_set_fivrns.cpp:589
value_set_fivrnst::do_end_function
void do_end_function(const exprt &lhs, const namespacet &ns)
Definition: value_set_fivrns.cpp:1129
value_set_fivrnst::object_map_dt::validity_ranget::from
unsigned from
Definition: value_set_fivrns.h:109
value_set_fivrnst::from_function
unsigned from_function
Definition: value_set_fivrns.h:35
value_set_fivrnst::insert_to
bool insert_to(object_mapt &dest, const exprt &src, const mp_integer &offset_value) const
Definition: value_set_fivrns.h:154
value_set_fivrnst::insert_to
bool insert_to(object_mapt &dest, const exprt &src) const
Definition: value_set_fivrns.h:149
value_set_fivrnst::clear
void clear()
Definition: value_set_fivrns.h:237
reference_counting.h
value_set_fivrnst::add_var
void add_var(const entryt &e)
Definition: value_set_fivrns.h:247
value_set_fivrnst::get_entry
entryt & get_entry(const entryt &e)
Definition: value_set_fivrns.h:257
value_set_fivrnst::object_map_dt::validity_ranget
Definition: value_set_fivrns.h:105
value_set_fivrnst::entryt::identifier
idt identifier
Definition: value_set_fivrns.h:206
value_set_fivrnst::insert_from
bool insert_from(object_mapt &dest, const exprt &src, const mp_integer &offset_value) const
Definition: value_set_fivrns.h:183
value_set_fivrnst::get_value_set_rec
void get_value_set_rec(const exprt &expr, object_mapt &dest, const std::string &suffix, const typet &original_type, const namespacet &ns) const
Definition: value_set_fivrns.cpp:295
value_set_fivrnst::get_temporary_entry
entryt & get_temporary_entry(const idt &id, const std::string &suffix)
Definition: value_set_fivrns.h:267
value_set_fivrnst::temporary_values
valuest temporary_values
Definition: value_set_fivrns.h:292
value_set_fivrnst::object_map_dt::end
iterator end()
Definition: value_set_fivrns.h:82
value_set_fivrnst::object_map_dt::insert
iterator insert(iterator, const std::pair< object_numberingt::number_type, offsett > &)
Definition: value_set_fivrns.h:100
value_set_fivrnst::entryt
Definition: value_set_fivrns.h:203
r
static int8_t r
Definition: irep_hash.h:59
value_set_fivrnst::offset_is_zero
bool offset_is_zero(offsett offset) const
Definition: value_set_fivrns.h:57
value_set_fivrnst::object_numbering
static object_numberingt object_numbering
Definition: value_set_fivrns.h:37
value_set_fivrnst::object_map_dt::objmapt
std::map< object_numberingt::number_type, offsett > objmapt
Definition: value_set_fivrns.h:68
value_set_fivrnst::object_map_dt::iterator
objmapt::iterator iterator
Definition: value_set_fivrns.h:74
value_set_fivrnst::dynamic_object_id_sett
std::unordered_set< unsigned int > dynamic_object_id_sett
Definition: value_set_fivrns.h:220
value_set_fivrnst::output_entry
void output_entry(const entryt &e, const namespacet &ns, std::ostream &out) const
Definition: value_set_fivrns.cpp:68
value_set_fivrnst::object_map_dt::validity_ranget::validity_ranget
validity_ranget(unsigned fnc, unsigned f, unsigned t)
Definition: value_set_fivrns.h:116
value_set_fivrnst::get_entry
entryt & get_entry(const idt &id, const std::string &suffix)
Definition: value_set_fivrns.h:252
value_set_fivrnst::insert_from
bool insert_from(object_mapt &dest, const exprt &src) const
Definition: value_set_fivrns.h:178
value_set_fivrnst::entryt::entryt
entryt(const idt &_identifier, const std::string _suffix)
Definition: value_set_fivrns.h:211
value_set_fivrnst::valuest
std::unordered_map< idt, entryt, string_hash > valuest
Definition: value_set_fivrns.h:225