cprover
Loading...
Searching...
No Matches
boolbv.h
Go to the documentation of this file.
1/*******************************************************************\
2
3Module:
4
5Author: Daniel Kroening, kroening@kroening.com
6
7\*******************************************************************/
8
9
10#ifndef CPROVER_SOLVERS_FLATTENING_BOOLBV_H
11#define CPROVER_SOLVERS_FLATTENING_BOOLBV_H
12
13//
14// convert expression to boolean formula
15//
16
17#include <util/endianness_map.h>
18#include <util/expr.h>
19#include <util/mp_arith.h>
20
22
23#include "arrays.h"
24#include "boolbv_map.h"
25#include "boolbv_width.h"
26#include "bv_utils.h" // IWYU pragma: keep
27
30class bswap_exprt;
41class union_typet;
42
43class boolbvt:public arrayst
44{
45public:
59
60 virtual const bvt &convert_bv( // check cache
61 const exprt &expr,
63
64 virtual bvt convert_bitvector(const exprt &expr); // no cache
65
66 // overloading
67 exprt get(const exprt &expr) const override;
68 void set_to(const exprt &expr, bool value) override;
69 void print_assignment(std::ostream &out) const override;
70
71 void clear_cache() override
72 {
74 bv_cache.clear();
75 }
76
83
86
88 {
89 return get_value(bv, 0, bv.size());
90 }
91
92 mp_integer get_value(const bvt &bv, std::size_t offset, std::size_t width);
93
94 const boolbv_mapt &get_map() const
95 {
96 return map;
97 }
98
99 virtual std::size_t boolbv_width(const typet &type) const
100 {
101 return bv_width(type);
102 }
103
104 virtual endianness_mapt
105 endianness_map(const typet &type, bool little_endian) const
106 {
107 return endianness_mapt{type, little_endian, ns};
108 }
109
110 virtual endianness_mapt endianness_map(const typet &type) const;
111
112protected:
115
116 // uninterpreted functions
118
119 // the mapping from identifiers to literals
121
122 // overloading
123 literalt convert_rest(const exprt &expr) override;
124 virtual bool boolbv_set_equality_to_true(const equal_exprt &expr);
125
126 // NOLINTNEXTLINE(readability/identifiers)
127 typedef arrayst SUB;
128
129 bvt conversion_failed(const exprt &expr);
130
131 typedef std::unordered_map<const exprt, bvt, irep_hash> bv_cachet;
133
134 bool type_conversion(
135 const typet &src_type, const bvt &src,
136 const typet &dest_type, bvt &dest);
137
139 virtual literalt convert_typecast(const typecast_exprt &expr);
140 virtual literalt convert_reduction(const unary_exprt &expr);
141 virtual literalt convert_onehot(const unary_exprt &expr);
142 virtual literalt convert_extractbit(const extractbit_exprt &expr);
145 virtual literalt convert_equality(const equal_exprt &expr);
147 const binary_relation_exprt &expr);
149 virtual literalt convert_quantifier(const quantifier_exprt &expr);
150
151 virtual bvt convert_index(const exprt &array, const mp_integer &index);
152 virtual bvt convert_index(const index_exprt &expr);
153 virtual bvt convert_bswap(const bswap_exprt &expr);
154 virtual bvt convert_byte_extract(const byte_extract_exprt &expr);
155 virtual bvt convert_byte_update(const byte_update_exprt &expr);
156 virtual bvt convert_constraint_select_one(const exprt &expr);
157 virtual bvt convert_if(const if_exprt &expr);
158 virtual bvt convert_struct(const struct_exprt &expr);
159 virtual bvt convert_array(const exprt &expr);
160 virtual bvt convert_complex(const complex_exprt &expr);
161 virtual bvt convert_complex_real(const complex_real_exprt &expr);
162 virtual bvt convert_complex_imag(const complex_imag_exprt &expr);
164 virtual bvt convert_let(const let_exprt &);
165 virtual bvt convert_array_of(const array_of_exprt &expr);
166 virtual bvt convert_union(const union_exprt &expr);
167 virtual bvt convert_empty_union(const empty_union_exprt &expr);
168 virtual bvt convert_bv_typecast(const typecast_exprt &expr);
169 virtual bvt convert_add_sub(const exprt &expr);
170 virtual bvt convert_mult(const mult_exprt &expr);
171 virtual bvt convert_div(const div_exprt &expr);
172 virtual bvt convert_mod(const mod_exprt &expr);
176 virtual bvt convert_member(const member_exprt &expr);
177 virtual bvt convert_with(const with_exprt &expr);
178 virtual bvt convert_update(const update_exprt &);
179 virtual bvt convert_case(const exprt &expr);
180 virtual bvt convert_cond(const cond_exprt &);
181 virtual bvt convert_shift(const binary_exprt &expr);
182 virtual bvt convert_bitwise(const exprt &expr);
183 virtual bvt convert_unary_minus(const unary_minus_exprt &expr);
184 virtual bvt convert_abs(const abs_exprt &expr);
185 virtual bvt convert_concatenation(const concatenation_exprt &expr);
186 virtual bvt convert_replication(const replication_exprt &expr);
187 virtual bvt convert_constant(const constant_exprt &expr);
188 virtual bvt convert_extractbits(const extractbits_exprt &expr);
189 virtual bvt convert_symbol(const exprt &expr);
190 virtual bvt convert_bv_reduction(const unary_exprt &expr);
191 virtual bvt convert_not(const not_exprt &expr);
192 virtual bvt convert_power(const binary_exprt &expr);
194 const function_application_exprt &expr);
195 virtual bvt convert_bitreverse(const bitreverse_exprt &expr);
196 virtual bvt convert_saturating_add_sub(const binary_exprt &expr);
198
199 void convert_with(
200 const typet &type,
201 const exprt &op1,
202 const exprt &op2,
203 const bvt &prev_bv,
204 bvt &next_bv);
205
206 void convert_with_bv(
207 const exprt &op1,
208 const exprt &op2,
209 const bvt &prev_bv,
210 bvt &next_bv);
211
213 const array_typet &type,
214 const exprt &op1,
215 const exprt &op2,
216 const bvt &prev_bv,
217 bvt &next_bv);
218
220 const union_typet &type,
221 const exprt &op2,
222 const bvt &prev_bv,
223 bvt &next_bv);
224
226 const struct_typet &type,
227 const exprt &op1,
228 const exprt &op2,
229 const bvt &prev_bv,
230 bvt &next_bv);
231
233 const exprt::operandst &designator,
234 std::size_t d,
235 const typet &type,
236 std::size_t offset,
237 const exprt &new_value,
238 bvt &bv);
239
240 virtual exprt bv_get_unbounded_array(const exprt &) const;
241
242 virtual exprt
243 bv_get_rec(const exprt &expr, const bvt &bv, std::size_t offset) const;
244
245 exprt bv_get(const bvt &bv, const typet &type) const;
246 exprt bv_get_cache(const exprt &expr) const;
247
248 // unbounded arrays
249 bool is_unbounded_array(const typet &type) const override;
250
251 // quantifier instantiations
253 {
254 public:
256 : expr(std::move(_expr)), l(std::move(_l))
257 {
258 }
259
262 };
263
264 typedef std::list<quantifiert> quantifier_listt;
266
268
269 typedef std::vector<std::size_t> offset_mapt;
271
272 // strings
274
275 // scopes
276 std::size_t scope_counter = 0;
277
280};
281
282#endif // CPROVER_SOLVERS_FLATTENING_BOOLBV_H
Theory of Arrays with Extensionality.
Absolute value.
Definition std_expr.h:379
ait supplies three of the four components needed: an abstract interpreter (in this case handling func...
Definition ai.h:563
Expression to define a mapping from an argument (index) to elements.
Definition std_expr.h:3358
Array constructor from single element.
Definition std_expr.h:1498
Arrays with given size.
Definition std_types.h:763
const namespacet & ns
Definition arrays.h:56
message_handlert & message_handler
Definition arrays.h:58
void finish_eager_conversion() override
Definition arrays.h:41
bool get_array_constraints
Definition arrays.h:113
A base class for binary expressions.
Definition std_expr.h:583
A Boolean expression returning true, iff operation kind would result in an overflow when applied to o...
A base class for relations, i.e., binary predicates whose two operands have the same type.
Definition std_expr.h:707
A base class for variable bindings (quantifiers, let, lambda)
Definition std_expr.h:3052
std::vector< symbol_exprt > variablest
Definition std_expr.h:3054
Reverse the order of bits in a bit-vector.
quantifiert(exprt _expr, literalt _l)
Definition boolbv.h:255
virtual bvt convert_with(const with_exprt &expr)
virtual bvt convert_array(const exprt &expr)
Flatten array.
void convert_with_bv(const exprt &op1, const exprt &op2, const bvt &prev_bv, bvt &next_bv)
virtual literalt convert_bv_rel(const binary_relation_exprt &)
Flatten <, >, <= and >= expressions.
bv_cachet bv_cache
Definition boolbv.h:132
virtual literalt convert_onehot(const unary_exprt &expr)
virtual bvt convert_index(const exprt &array, const mp_integer &index)
index operator with constant index
std::size_t scope_counter
Definition boolbv.h:276
virtual bvt convert_constraint_select_one(const exprt &expr)
void convert_update_rec(const exprt::operandst &designator, std::size_t d, const typet &type, std::size_t offset, const exprt &new_value, bvt &bv)
virtual bvt convert_complex_imag(const complex_imag_exprt &expr)
virtual literalt convert_reduction(const unary_exprt &expr)
virtual literalt convert_ieee_float_rel(const binary_relation_exprt &)
std::unordered_map< const exprt, bvt, irep_hash > bv_cachet
Definition boolbv.h:131
virtual bvt convert_complex_real(const complex_real_exprt &expr)
virtual bvt convert_complex(const complex_exprt &expr)
virtual bvt convert_let(const let_exprt &)
virtual bvt convert_byte_extract(const byte_extract_exprt &expr)
offset_mapt build_offset_map(const struct_typet &src)
Definition boolbv.cpp:563
virtual bvt convert_bitvector(const exprt &expr)
Converts an expression into its gate-level representation and returns a vector of literals correspond...
Definition boolbv.cpp:96
unbounded_arrayt
Definition boolbv.h:84
binding_exprt::variablest fresh_binding(const binding_exprt &)
create new, unique variables for the given binding
Definition boolbv.cpp:534
virtual literalt convert_typecast(const typecast_exprt &expr)
conversion from bitvector types to boolean
virtual bvt convert_bswap(const bswap_exprt &expr)
bool is_unbounded_array(const typet &type) const override
Definition boolbv.cpp:515
void finish_eager_conversion_quantifiers()
exprt bv_get(const bvt &bv, const typet &type) const
virtual bvt convert_mod(const mod_exprt &expr)
virtual bvt convert_add_sub(const exprt &expr)
virtual bvt convert_constant(const constant_exprt &expr)
numberingt< irep_idt > string_numbering
Definition boolbv.h:273
virtual literalt convert_quantifier(const quantifier_exprt &expr)
boolbvt(const namespacet &_ns, propt &_prop, message_handlert &message_handler, bool get_array_constraints=false)
Definition boolbv.h:46
virtual bool boolbv_set_equality_to_true(const equal_exprt &expr)
Definition boolbv.cpp:474
virtual exprt bv_get_unbounded_array(const exprt &) const
virtual exprt bv_get_rec(const exprt &expr, const bvt &bv, std::size_t offset) const
void clear_cache() override
Definition boolbv.h:71
virtual bvt convert_mult(const mult_exprt &expr)
virtual bvt convert_member(const member_exprt &expr)
virtual literalt convert_verilog_case_equality(const binary_relation_exprt &expr)
virtual bvt convert_function_application(const function_application_exprt &expr)
Definition boolbv.cpp:305
virtual bvt convert_cond(const cond_exprt &)
void convert_with_struct(const struct_typet &type, const exprt &op1, const exprt &op2, const bvt &prev_bv, bvt &next_bv)
virtual bvt convert_empty_union(const empty_union_exprt &expr)
virtual bvt convert_if(const if_exprt &expr)
Definition boolbv_if.cpp:12
virtual bvt convert_union(const union_exprt &expr)
void set_to(const exprt &expr, bool value) override
For a Boolean expression expr, add the constraint 'expr' if value is true, otherwise add 'not expr'.
Definition boolbv.cpp:505
virtual bvt convert_byte_update(const byte_update_exprt &expr)
boolbv_widtht bv_width
Definition boolbv.h:113
virtual literalt convert_extractbit(const extractbit_exprt &expr)
const boolbv_mapt & get_map() const
Definition boolbv.h:94
std::list< quantifiert > quantifier_listt
Definition boolbv.h:264
unbounded_arrayt unbounded_array
Definition boolbv.h:85
exprt get(const exprt &expr) const override
Return expr with variables replaced by values from satisfying assignment if available.
virtual bvt convert_floatbv_op(const ieee_float_op_exprt &)
void print_assignment(std::ostream &out) const override
Print satisfying assignment to out.
Definition boolbv.cpp:557
virtual bvt convert_not(const not_exprt &expr)
exprt bv_get_cache(const exprt &expr) const
virtual bvt convert_extractbits(const extractbits_exprt &expr)
virtual bvt convert_shift(const binary_exprt &expr)
virtual bvt convert_update(const update_exprt &)
void finish_eager_conversion() override
Definition boolbv.h:77
virtual bvt convert_unary_minus(const unary_minus_exprt &expr)
virtual bvt convert_div(const div_exprt &expr)
virtual const bvt & convert_bv(const exprt &expr, const optionalt< std::size_t > expected_width={})
Convert expression to vector of literalts, using an internal cache to speed up conversion if availabl...
Definition boolbv.cpp:38
virtual literalt convert_binary_overflow(const binary_overflow_exprt &expr)
virtual bvt convert_array_of(const array_of_exprt &expr)
Flatten arrays constructed from a single element.
bv_utilst bv_utils
Definition boolbv.h:114
virtual bvt convert_floatbv_mod_rem(const binary_exprt &)
virtual bvt convert_saturating_add_sub(const binary_exprt &expr)
virtual bvt convert_overflow_result(const overflow_result_exprt &expr)
virtual bvt convert_bitwise(const exprt &expr)
virtual bvt convert_array_comprehension(const array_comprehension_exprt &)
Definition boolbv.cpp:246
void convert_with_union(const union_typet &type, const exprt &op2, const bvt &prev_bv, bvt &next_bv)
virtual bvt convert_bv_reduction(const unary_exprt &expr)
virtual literalt convert_equality(const equal_exprt &expr)
functionst functions
Definition boolbv.h:117
bvt conversion_failed(const exprt &expr)
Print that the expression of x has failed conversion, then return a vector of x's width.
Definition boolbv.cpp:82
quantifier_listt quantifier_list
Definition boolbv.h:265
virtual endianness_mapt endianness_map(const typet &type, bool little_endian) const
Definition boolbv.h:105
virtual literalt convert_unary_overflow(const unary_overflow_exprt &expr)
virtual std::size_t boolbv_width(const typet &type) const
Definition boolbv.h:99
virtual bvt convert_case(const exprt &expr)
virtual bvt convert_symbol(const exprt &expr)
Definition boolbv.cpp:281
void convert_with_array(const array_typet &type, const exprt &op1, const exprt &op2, const bvt &prev_bv, bvt &next_bv)
virtual bvt convert_floatbv_typecast(const floatbv_typecast_exprt &expr)
arrayst SUB
Definition boolbv.h:127
virtual bvt convert_power(const binary_exprt &expr)
virtual bvt convert_bv_typecast(const typecast_exprt &expr)
mp_integer get_value(const bvt &bv)
Definition boolbv.h:87
bool type_conversion(const typet &src_type, const bvt &src, const typet &dest_type, bvt &dest)
virtual bvt convert_concatenation(const concatenation_exprt &expr)
virtual bvt convert_struct(const struct_exprt &expr)
virtual bvt convert_bitreverse(const bitreverse_exprt &expr)
virtual bvt convert_replication(const replication_exprt &expr)
literalt convert_rest(const exprt &expr) override
Definition boolbv.cpp:316
std::vector< std::size_t > offset_mapt
Definition boolbv.h:269
virtual bvt convert_abs(const abs_exprt &expr)
boolbv_mapt map
Definition boolbv.h:120
The byte swap expression.
Expression of type type extracted from some object op starting at position offset (given in number of...
Expression corresponding to op() where the bytes starting at position offset (given in number of byte...
Complex constructor from a pair of numbers.
Definition std_expr.h:1858
Imaginary part of the expression describing a complex number.
Definition std_expr.h:1971
Real part of the expression describing a complex number.
Definition std_expr.h:1926
Concatenation of bit-vector operands.
this is a parametric version of an if-expression: it returns the value of the first case (using the o...
Definition std_expr.h:3295
A constant literal expression.
Definition std_expr.h:2942
Division.
Definition std_expr.h:1097
Union constructor to support unions without any member (a GCC/Clang feature).
Definition std_expr.h:1774
Maps a big-endian offset to a little-endian offset.
Equality.
Definition std_expr.h:1306
Base class for all expressions.
Definition expr.h:56
std::vector< exprt > operandst
Definition expr.h:58
Extracts a single bit of a bit-vector operand.
Extracts a sub-range of a bit-vector operand.
Semantic type conversion from/to floating-point formats.
Application of (mathematical) function.
virtual void finish_eager_conversion()
Definition functions.h:36
IEEE floating-point operations These have two data operands (op0 and op1) and one rounding mode (op2)...
The trinary if-then-else operator.
Definition std_expr.h:2323
Array index operator.
Definition std_expr.h:1410
A let expression.
Definition std_expr.h:3149
Extract member of struct or union.
Definition std_expr.h:2794
Modulo defined as lhs-(rhs * truncate(lhs/rhs)).
Definition std_expr.h:1168
Binary multiplication Associativity is not specified.
Definition std_expr.h:1052
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition namespace.h:91
Boolean negation.
Definition std_expr.h:2278
An expression returning both the result of the arithmetic operation under wrap-around semantics as we...
virtual void clear_cache()
TO_BE_DOCUMENTED.
Definition prop.h:25
A base class for quantifier expressions.
Bit-vector replication.
Struct constructor from list of elements.
Definition std_expr.h:1819
Structure type, corresponds to C style structs.
Definition std_types.h:231
Semantic type conversion.
Definition std_expr.h:2017
The type of an expression, extends irept.
Definition type.h:29
Generic base class for unary expressions.
Definition std_expr.h:314
The unary minus expression.
Definition std_expr.h:423
A Boolean expression returning true, iff operation kind would result in an overflow when applied to t...
Union constructor from single element.
Definition std_expr.h:1708
The union type.
Definition c_types.h:147
Operator to update elements in structs and arrays.
Definition std_expr.h:2608
Operator to update elements in structs and arrays.
Definition std_expr.h:2424
Uninterpreted Functions.
std::vector< literalt > bvt
Definition literal.h:201
STL namespace.