1 //== Z3Solver.cpp -----------------------------------------------*- C++ -*--==//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #include "llvm/ADT/Twine.h"
10 #include "llvm/Config/config.h"
11 #include "llvm/Support/SMTAPI.h"
22 /// Configuration class for Z3
24 friend class Z3Context;
29 Z3Config() : Config(Z3_mk_config()) {
30 // Enable model finding
31 Z3_set_param_value(Config, "model", "true");
32 // Disable proof generation
33 Z3_set_param_value(Config, "proof", "false");
34 // Set timeout to 15000ms = 15s
35 Z3_set_param_value(Config, "timeout", "15000");
38 ~Z3Config() { Z3_del_config(Config); }
39 }; // end class Z3Config
41 // Function used to report errors
42 void Z3ErrorHandler(Z3_context Context, Z3_error_code Error) {
43 llvm::report_fatal_error("Z3 error: " +
44 llvm::Twine(Z3_get_error_msg(Context, Error)));
47 /// Wrapper for Z3 context
53 Context = Z3_mk_context_rc(Z3Config().Config);
54 // The error function is set here because the context is the first object
55 // created by the backend
56 Z3_set_error_handler(Context, Z3ErrorHandler);
59 virtual ~Z3Context() {
60 Z3_del_context(Context);
63 }; // end class Z3Context
65 /// Wrapper for Z3 Sort
66 class Z3Sort : public SMTSort {
67 friend class Z3Solver;
74 /// Default constructor, mainly used by make_shared
75 Z3Sort(Z3Context &C, Z3_sort ZS) : Context(C), Sort(ZS) {
76 Z3_inc_ref(Context.Context, reinterpret_cast<Z3_ast>(Sort));
79 /// Override implicit copy constructor for correct reference counting.
80 Z3Sort(const Z3Sort &Other) : Context(Other.Context), Sort(Other.Sort) {
81 Z3_inc_ref(Context.Context, reinterpret_cast<Z3_ast>(Sort));
84 /// Override implicit copy assignment constructor for correct reference
86 Z3Sort &operator=(const Z3Sort &Other) {
87 Z3_inc_ref(Context.Context, reinterpret_cast<Z3_ast>(Other.Sort));
88 Z3_dec_ref(Context.Context, reinterpret_cast<Z3_ast>(Sort));
93 Z3Sort(Z3Sort &&Other) = delete;
94 Z3Sort &operator=(Z3Sort &&Other) = delete;
98 Z3_dec_ref(Context.Context, reinterpret_cast<Z3_ast>(Sort));
101 void Profile(llvm::FoldingSetNodeID &ID) const override {
103 Z3_get_ast_id(Context.Context, reinterpret_cast<Z3_ast>(Sort)));
106 bool isBitvectorSortImpl() const override {
107 return (Z3_get_sort_kind(Context.Context, Sort) == Z3_BV_SORT);
110 bool isFloatSortImpl() const override {
111 return (Z3_get_sort_kind(Context.Context, Sort) == Z3_FLOATING_POINT_SORT);
114 bool isBooleanSortImpl() const override {
115 return (Z3_get_sort_kind(Context.Context, Sort) == Z3_BOOL_SORT);
118 unsigned getBitvectorSortSizeImpl() const override {
119 return Z3_get_bv_sort_size(Context.Context, Sort);
122 unsigned getFloatSortSizeImpl() const override {
123 return Z3_fpa_get_ebits(Context.Context, Sort) +
124 Z3_fpa_get_sbits(Context.Context, Sort);
127 bool equal_to(SMTSort const &Other) const override {
128 return Z3_is_eq_sort(Context.Context, Sort,
129 static_cast<const Z3Sort &>(Other).Sort);
132 void print(raw_ostream &OS) const override {
133 OS << Z3_sort_to_string(Context.Context, Sort);
135 }; // end class Z3Sort
137 static const Z3Sort &toZ3Sort(const SMTSort &S) {
138 return static_cast<const Z3Sort &>(S);
141 class Z3Expr : public SMTExpr {
142 friend class Z3Solver;
149 Z3Expr(Z3Context &C, Z3_ast ZA) : SMTExpr(), Context(C), AST(ZA) {
150 Z3_inc_ref(Context.Context, AST);
153 /// Override implicit copy constructor for correct reference counting.
154 Z3Expr(const Z3Expr &Copy) : SMTExpr(), Context(Copy.Context), AST(Copy.AST) {
155 Z3_inc_ref(Context.Context, AST);
158 /// Override implicit copy assignment constructor for correct reference
160 Z3Expr &operator=(const Z3Expr &Other) {
161 Z3_inc_ref(Context.Context, Other.AST);
162 Z3_dec_ref(Context.Context, AST);
167 Z3Expr(Z3Expr &&Other) = delete;
168 Z3Expr &operator=(Z3Expr &&Other) = delete;
172 Z3_dec_ref(Context.Context, AST);
175 void Profile(llvm::FoldingSetNodeID &ID) const override {
176 ID.AddInteger(Z3_get_ast_id(Context.Context, AST));
179 /// Comparison of AST equality, not model equivalence.
180 bool equal_to(SMTExpr const &Other) const override {
181 assert(Z3_is_eq_sort(Context.Context, Z3_get_sort(Context.Context, AST),
182 Z3_get_sort(Context.Context,
183 static_cast<const Z3Expr &>(Other).AST)) &&
184 "AST's must have the same sort");
185 return Z3_is_eq_ast(Context.Context, AST,
186 static_cast<const Z3Expr &>(Other).AST);
189 void print(raw_ostream &OS) const override {
190 OS << Z3_ast_to_string(Context.Context, AST);
192 }; // end class Z3Expr
194 static const Z3Expr &toZ3Expr(const SMTExpr &E) {
195 return static_cast<const Z3Expr &>(E);
199 friend class Z3Solver;
206 Z3Model(Z3Context &C, Z3_model ZM) : Context(C), Model(ZM) {
207 Z3_model_inc_ref(Context.Context, Model);
210 Z3Model(const Z3Model &Other) = delete;
211 Z3Model(Z3Model &&Other) = delete;
212 Z3Model &operator=(Z3Model &Other) = delete;
213 Z3Model &operator=(Z3Model &&Other) = delete;
217 Z3_model_dec_ref(Context.Context, Model);
220 void print(raw_ostream &OS) const {
221 OS << Z3_model_to_string(Context.Context, Model);
224 LLVM_DUMP_METHOD void dump() const { print(llvm::errs()); }
225 }; // end class Z3Model
227 /// Get the corresponding IEEE floating-point type for a given bitwidth.
228 static const llvm::fltSemantics &getFloatSemantics(unsigned BitWidth) {
231 llvm_unreachable("Unsupported floating-point semantics!");
234 return llvm::APFloat::IEEEhalf();
236 return llvm::APFloat::IEEEsingle();
238 return llvm::APFloat::IEEEdouble();
240 return llvm::APFloat::IEEEquad();
244 // Determine whether two float semantics are equivalent
245 static bool areEquivalent(const llvm::fltSemantics &LHS,
246 const llvm::fltSemantics &RHS) {
247 return (llvm::APFloat::semanticsPrecision(LHS) ==
248 llvm::APFloat::semanticsPrecision(RHS)) &&
249 (llvm::APFloat::semanticsMinExponent(LHS) ==
250 llvm::APFloat::semanticsMinExponent(RHS)) &&
251 (llvm::APFloat::semanticsMaxExponent(LHS) ==
252 llvm::APFloat::semanticsMaxExponent(RHS)) &&
253 (llvm::APFloat::semanticsSizeInBits(LHS) ==
254 llvm::APFloat::semanticsSizeInBits(RHS));
257 class Z3Solver : public SMTSolver {
258 friend class Z3ConstraintManager;
265 std::set<Z3Sort> CachedSorts;
268 std::set<Z3Expr> CachedExprs;
271 Z3Solver() : Solver(Z3_mk_simple_solver(Context.Context)) {
272 Z3_solver_inc_ref(Context.Context, Solver);
275 Z3Solver(const Z3Solver &Other) = delete;
276 Z3Solver(Z3Solver &&Other) = delete;
277 Z3Solver &operator=(Z3Solver &Other) = delete;
278 Z3Solver &operator=(Z3Solver &&Other) = delete;
282 Z3_solver_dec_ref(Context.Context, Solver);
285 void addConstraint(const SMTExprRef &Exp) const override {
286 Z3_solver_assert(Context.Context, Solver, toZ3Expr(*Exp).AST);
289 // Given an SMTSort, adds/retrives it from the cache and returns
290 // an SMTSortRef to the SMTSort in the cache
291 SMTSortRef newSortRef(const SMTSort &Sort) {
292 auto It = CachedSorts.insert(toZ3Sort(Sort));
296 // Given an SMTExpr, adds/retrives it from the cache and returns
297 // an SMTExprRef to the SMTExpr in the cache
298 SMTExprRef newExprRef(const SMTExpr &Exp) {
299 auto It = CachedExprs.insert(toZ3Expr(Exp));
303 SMTSortRef getBoolSort() override {
304 return newSortRef(Z3Sort(Context, Z3_mk_bool_sort(Context.Context)));
307 SMTSortRef getBitvectorSort(unsigned BitWidth) override {
309 Z3Sort(Context, Z3_mk_bv_sort(Context.Context, BitWidth)));
312 SMTSortRef getSort(const SMTExprRef &Exp) override {
314 Z3Sort(Context, Z3_get_sort(Context.Context, toZ3Expr(*Exp).AST)));
317 SMTSortRef getFloat16Sort() override {
318 return newSortRef(Z3Sort(Context, Z3_mk_fpa_sort_16(Context.Context)));
321 SMTSortRef getFloat32Sort() override {
322 return newSortRef(Z3Sort(Context, Z3_mk_fpa_sort_32(Context.Context)));
325 SMTSortRef getFloat64Sort() override {
326 return newSortRef(Z3Sort(Context, Z3_mk_fpa_sort_64(Context.Context)));
329 SMTSortRef getFloat128Sort() override {
330 return newSortRef(Z3Sort(Context, Z3_mk_fpa_sort_128(Context.Context)));
333 SMTExprRef mkBVNeg(const SMTExprRef &Exp) override {
335 Z3Expr(Context, Z3_mk_bvneg(Context.Context, toZ3Expr(*Exp).AST)));
338 SMTExprRef mkBVNot(const SMTExprRef &Exp) override {
340 Z3Expr(Context, Z3_mk_bvnot(Context.Context, toZ3Expr(*Exp).AST)));
343 SMTExprRef mkNot(const SMTExprRef &Exp) override {
345 Z3Expr(Context, Z3_mk_not(Context.Context, toZ3Expr(*Exp).AST)));
348 SMTExprRef mkBVAdd(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
350 Z3Expr(Context, Z3_mk_bvadd(Context.Context, toZ3Expr(*LHS).AST,
351 toZ3Expr(*RHS).AST)));
354 SMTExprRef mkBVSub(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
356 Z3Expr(Context, Z3_mk_bvsub(Context.Context, toZ3Expr(*LHS).AST,
357 toZ3Expr(*RHS).AST)));
360 SMTExprRef mkBVMul(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
362 Z3Expr(Context, Z3_mk_bvmul(Context.Context, toZ3Expr(*LHS).AST,
363 toZ3Expr(*RHS).AST)));
366 SMTExprRef mkBVSRem(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
368 Z3Expr(Context, Z3_mk_bvsrem(Context.Context, toZ3Expr(*LHS).AST,
369 toZ3Expr(*RHS).AST)));
372 SMTExprRef mkBVURem(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
374 Z3Expr(Context, Z3_mk_bvurem(Context.Context, toZ3Expr(*LHS).AST,
375 toZ3Expr(*RHS).AST)));
378 SMTExprRef mkBVSDiv(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
380 Z3Expr(Context, Z3_mk_bvsdiv(Context.Context, toZ3Expr(*LHS).AST,
381 toZ3Expr(*RHS).AST)));
384 SMTExprRef mkBVUDiv(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
386 Z3Expr(Context, Z3_mk_bvudiv(Context.Context, toZ3Expr(*LHS).AST,
387 toZ3Expr(*RHS).AST)));
390 SMTExprRef mkBVShl(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
392 Z3Expr(Context, Z3_mk_bvshl(Context.Context, toZ3Expr(*LHS).AST,
393 toZ3Expr(*RHS).AST)));
396 SMTExprRef mkBVAshr(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
398 Z3Expr(Context, Z3_mk_bvashr(Context.Context, toZ3Expr(*LHS).AST,
399 toZ3Expr(*RHS).AST)));
402 SMTExprRef mkBVLshr(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
404 Z3Expr(Context, Z3_mk_bvlshr(Context.Context, toZ3Expr(*LHS).AST,
405 toZ3Expr(*RHS).AST)));
408 SMTExprRef mkBVXor(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
410 Z3Expr(Context, Z3_mk_bvxor(Context.Context, toZ3Expr(*LHS).AST,
411 toZ3Expr(*RHS).AST)));
414 SMTExprRef mkBVOr(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
416 Z3Expr(Context, Z3_mk_bvor(Context.Context, toZ3Expr(*LHS).AST,
417 toZ3Expr(*RHS).AST)));
420 SMTExprRef mkBVAnd(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
422 Z3Expr(Context, Z3_mk_bvand(Context.Context, toZ3Expr(*LHS).AST,
423 toZ3Expr(*RHS).AST)));
426 SMTExprRef mkBVUlt(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
428 Z3Expr(Context, Z3_mk_bvult(Context.Context, toZ3Expr(*LHS).AST,
429 toZ3Expr(*RHS).AST)));
432 SMTExprRef mkBVSlt(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
434 Z3Expr(Context, Z3_mk_bvslt(Context.Context, toZ3Expr(*LHS).AST,
435 toZ3Expr(*RHS).AST)));
438 SMTExprRef mkBVUgt(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
440 Z3Expr(Context, Z3_mk_bvugt(Context.Context, toZ3Expr(*LHS).AST,
441 toZ3Expr(*RHS).AST)));
444 SMTExprRef mkBVSgt(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
446 Z3Expr(Context, Z3_mk_bvsgt(Context.Context, toZ3Expr(*LHS).AST,
447 toZ3Expr(*RHS).AST)));
450 SMTExprRef mkBVUle(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
452 Z3Expr(Context, Z3_mk_bvule(Context.Context, toZ3Expr(*LHS).AST,
453 toZ3Expr(*RHS).AST)));
456 SMTExprRef mkBVSle(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
458 Z3Expr(Context, Z3_mk_bvsle(Context.Context, toZ3Expr(*LHS).AST,
459 toZ3Expr(*RHS).AST)));
462 SMTExprRef mkBVUge(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
464 Z3Expr(Context, Z3_mk_bvuge(Context.Context, toZ3Expr(*LHS).AST,
465 toZ3Expr(*RHS).AST)));
468 SMTExprRef mkBVSge(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
470 Z3Expr(Context, Z3_mk_bvsge(Context.Context, toZ3Expr(*LHS).AST,
471 toZ3Expr(*RHS).AST)));
474 SMTExprRef mkAnd(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
475 Z3_ast Args[2] = {toZ3Expr(*LHS).AST, toZ3Expr(*RHS).AST};
476 return newExprRef(Z3Expr(Context, Z3_mk_and(Context.Context, 2, Args)));
479 SMTExprRef mkOr(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
480 Z3_ast Args[2] = {toZ3Expr(*LHS).AST, toZ3Expr(*RHS).AST};
481 return newExprRef(Z3Expr(Context, Z3_mk_or(Context.Context, 2, Args)));
484 SMTExprRef mkEqual(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
486 Z3Expr(Context, Z3_mk_eq(Context.Context, toZ3Expr(*LHS).AST,
487 toZ3Expr(*RHS).AST)));
490 SMTExprRef mkFPNeg(const SMTExprRef &Exp) override {
492 Z3Expr(Context, Z3_mk_fpa_neg(Context.Context, toZ3Expr(*Exp).AST)));
495 SMTExprRef mkFPIsInfinite(const SMTExprRef &Exp) override {
496 return newExprRef(Z3Expr(
497 Context, Z3_mk_fpa_is_infinite(Context.Context, toZ3Expr(*Exp).AST)));
500 SMTExprRef mkFPIsNaN(const SMTExprRef &Exp) override {
502 Z3Expr(Context, Z3_mk_fpa_is_nan(Context.Context, toZ3Expr(*Exp).AST)));
505 SMTExprRef mkFPIsNormal(const SMTExprRef &Exp) override {
506 return newExprRef(Z3Expr(
507 Context, Z3_mk_fpa_is_normal(Context.Context, toZ3Expr(*Exp).AST)));
510 SMTExprRef mkFPIsZero(const SMTExprRef &Exp) override {
511 return newExprRef(Z3Expr(
512 Context, Z3_mk_fpa_is_zero(Context.Context, toZ3Expr(*Exp).AST)));
515 SMTExprRef mkFPMul(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
516 SMTExprRef RoundingMode = getFloatRoundingMode();
519 Z3_mk_fpa_mul(Context.Context, toZ3Expr(*LHS).AST,
520 toZ3Expr(*RHS).AST, toZ3Expr(*RoundingMode).AST)));
523 SMTExprRef mkFPDiv(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
524 SMTExprRef RoundingMode = getFloatRoundingMode();
527 Z3_mk_fpa_div(Context.Context, toZ3Expr(*LHS).AST,
528 toZ3Expr(*RHS).AST, toZ3Expr(*RoundingMode).AST)));
531 SMTExprRef mkFPRem(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
533 Z3Expr(Context, Z3_mk_fpa_rem(Context.Context, toZ3Expr(*LHS).AST,
534 toZ3Expr(*RHS).AST)));
537 SMTExprRef mkFPAdd(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
538 SMTExprRef RoundingMode = getFloatRoundingMode();
541 Z3_mk_fpa_add(Context.Context, toZ3Expr(*LHS).AST,
542 toZ3Expr(*RHS).AST, toZ3Expr(*RoundingMode).AST)));
545 SMTExprRef mkFPSub(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
546 SMTExprRef RoundingMode = getFloatRoundingMode();
549 Z3_mk_fpa_sub(Context.Context, toZ3Expr(*LHS).AST,
550 toZ3Expr(*RHS).AST, toZ3Expr(*RoundingMode).AST)));
553 SMTExprRef mkFPLt(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
555 Z3Expr(Context, Z3_mk_fpa_lt(Context.Context, toZ3Expr(*LHS).AST,
556 toZ3Expr(*RHS).AST)));
559 SMTExprRef mkFPGt(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
561 Z3Expr(Context, Z3_mk_fpa_gt(Context.Context, toZ3Expr(*LHS).AST,
562 toZ3Expr(*RHS).AST)));
565 SMTExprRef mkFPLe(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
567 Z3Expr(Context, Z3_mk_fpa_leq(Context.Context, toZ3Expr(*LHS).AST,
568 toZ3Expr(*RHS).AST)));
571 SMTExprRef mkFPGe(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
573 Z3Expr(Context, Z3_mk_fpa_geq(Context.Context, toZ3Expr(*LHS).AST,
574 toZ3Expr(*RHS).AST)));
577 SMTExprRef mkFPEqual(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
579 Z3Expr(Context, Z3_mk_fpa_eq(Context.Context, toZ3Expr(*LHS).AST,
580 toZ3Expr(*RHS).AST)));
583 SMTExprRef mkIte(const SMTExprRef &Cond, const SMTExprRef &T,
584 const SMTExprRef &F) override {
586 Z3Expr(Context, Z3_mk_ite(Context.Context, toZ3Expr(*Cond).AST,
587 toZ3Expr(*T).AST, toZ3Expr(*F).AST)));
590 SMTExprRef mkBVSignExt(unsigned i, const SMTExprRef &Exp) override {
591 return newExprRef(Z3Expr(
592 Context, Z3_mk_sign_ext(Context.Context, i, toZ3Expr(*Exp).AST)));
595 SMTExprRef mkBVZeroExt(unsigned i, const SMTExprRef &Exp) override {
596 return newExprRef(Z3Expr(
597 Context, Z3_mk_zero_ext(Context.Context, i, toZ3Expr(*Exp).AST)));
600 SMTExprRef mkBVExtract(unsigned High, unsigned Low,
601 const SMTExprRef &Exp) override {
602 return newExprRef(Z3Expr(Context, Z3_mk_extract(Context.Context, High, Low,
603 toZ3Expr(*Exp).AST)));
606 /// Creates a predicate that checks for overflow in a bitvector addition
608 SMTExprRef mkBVAddNoOverflow(const SMTExprRef &LHS, const SMTExprRef &RHS,
609 bool isSigned) override {
610 return newExprRef(Z3Expr(
611 Context, Z3_mk_bvadd_no_overflow(Context.Context, toZ3Expr(*LHS).AST,
612 toZ3Expr(*RHS).AST, isSigned)));
615 /// Creates a predicate that checks for underflow in a signed bitvector
616 /// addition operation
617 SMTExprRef mkBVAddNoUnderflow(const SMTExprRef &LHS,
618 const SMTExprRef &RHS) override {
619 return newExprRef(Z3Expr(
620 Context, Z3_mk_bvadd_no_underflow(Context.Context, toZ3Expr(*LHS).AST,
621 toZ3Expr(*RHS).AST)));
624 /// Creates a predicate that checks for overflow in a signed bitvector
625 /// subtraction operation
626 SMTExprRef mkBVSubNoOverflow(const SMTExprRef &LHS,
627 const SMTExprRef &RHS) override {
628 return newExprRef(Z3Expr(
629 Context, Z3_mk_bvsub_no_overflow(Context.Context, toZ3Expr(*LHS).AST,
630 toZ3Expr(*RHS).AST)));
633 /// Creates a predicate that checks for underflow in a bitvector subtraction
635 SMTExprRef mkBVSubNoUnderflow(const SMTExprRef &LHS, const SMTExprRef &RHS,
636 bool isSigned) override {
637 return newExprRef(Z3Expr(
638 Context, Z3_mk_bvsub_no_underflow(Context.Context, toZ3Expr(*LHS).AST,
639 toZ3Expr(*RHS).AST, isSigned)));
642 /// Creates a predicate that checks for overflow in a signed bitvector
643 /// division/modulus operation
644 SMTExprRef mkBVSDivNoOverflow(const SMTExprRef &LHS,
645 const SMTExprRef &RHS) override {
646 return newExprRef(Z3Expr(
647 Context, Z3_mk_bvsdiv_no_overflow(Context.Context, toZ3Expr(*LHS).AST,
648 toZ3Expr(*RHS).AST)));
651 /// Creates a predicate that checks for overflow in a bitvector negation
653 SMTExprRef mkBVNegNoOverflow(const SMTExprRef &Exp) override {
654 return newExprRef(Z3Expr(
655 Context, Z3_mk_bvneg_no_overflow(Context.Context, toZ3Expr(*Exp).AST)));
658 /// Creates a predicate that checks for overflow in a bitvector multiplication
660 SMTExprRef mkBVMulNoOverflow(const SMTExprRef &LHS, const SMTExprRef &RHS,
661 bool isSigned) override {
662 return newExprRef(Z3Expr(
663 Context, Z3_mk_bvmul_no_overflow(Context.Context, toZ3Expr(*LHS).AST,
664 toZ3Expr(*RHS).AST, isSigned)));
667 /// Creates a predicate that checks for underflow in a signed bitvector
668 /// multiplication operation
669 SMTExprRef mkBVMulNoUnderflow(const SMTExprRef &LHS,
670 const SMTExprRef &RHS) override {
671 return newExprRef(Z3Expr(
672 Context, Z3_mk_bvmul_no_underflow(Context.Context, toZ3Expr(*LHS).AST,
673 toZ3Expr(*RHS).AST)));
676 SMTExprRef mkBVConcat(const SMTExprRef &LHS, const SMTExprRef &RHS) override {
678 Z3Expr(Context, Z3_mk_concat(Context.Context, toZ3Expr(*LHS).AST,
679 toZ3Expr(*RHS).AST)));
682 SMTExprRef mkFPtoFP(const SMTExprRef &From, const SMTSortRef &To) override {
683 SMTExprRef RoundingMode = getFloatRoundingMode();
684 return newExprRef(Z3Expr(
686 Z3_mk_fpa_to_fp_float(Context.Context, toZ3Expr(*RoundingMode).AST,
687 toZ3Expr(*From).AST, toZ3Sort(*To).Sort)));
690 SMTExprRef mkSBVtoFP(const SMTExprRef &From, const SMTSortRef &To) override {
691 SMTExprRef RoundingMode = getFloatRoundingMode();
692 return newExprRef(Z3Expr(
694 Z3_mk_fpa_to_fp_signed(Context.Context, toZ3Expr(*RoundingMode).AST,
695 toZ3Expr(*From).AST, toZ3Sort(*To).Sort)));
698 SMTExprRef mkUBVtoFP(const SMTExprRef &From, const SMTSortRef &To) override {
699 SMTExprRef RoundingMode = getFloatRoundingMode();
700 return newExprRef(Z3Expr(
702 Z3_mk_fpa_to_fp_unsigned(Context.Context, toZ3Expr(*RoundingMode).AST,
703 toZ3Expr(*From).AST, toZ3Sort(*To).Sort)));
706 SMTExprRef mkFPtoSBV(const SMTExprRef &From, unsigned ToWidth) override {
707 SMTExprRef RoundingMode = getFloatRoundingMode();
708 return newExprRef(Z3Expr(
709 Context, Z3_mk_fpa_to_sbv(Context.Context, toZ3Expr(*RoundingMode).AST,
710 toZ3Expr(*From).AST, ToWidth)));
713 SMTExprRef mkFPtoUBV(const SMTExprRef &From, unsigned ToWidth) override {
714 SMTExprRef RoundingMode = getFloatRoundingMode();
715 return newExprRef(Z3Expr(
716 Context, Z3_mk_fpa_to_ubv(Context.Context, toZ3Expr(*RoundingMode).AST,
717 toZ3Expr(*From).AST, ToWidth)));
720 SMTExprRef mkBoolean(const bool b) override {
721 return newExprRef(Z3Expr(Context, b ? Z3_mk_true(Context.Context)
722 : Z3_mk_false(Context.Context)));
725 SMTExprRef mkBitvector(const llvm::APSInt Int, unsigned BitWidth) override {
726 const SMTSortRef Sort = getBitvectorSort(BitWidth);
728 Z3Expr(Context, Z3_mk_numeral(Context.Context, Int.toString(10).c_str(),
729 toZ3Sort(*Sort).Sort)));
732 SMTExprRef mkFloat(const llvm::APFloat Float) override {
734 getFloatSort(llvm::APFloat::semanticsSizeInBits(Float.getSemantics()));
736 llvm::APSInt Int = llvm::APSInt(Float.bitcastToAPInt(), false);
737 SMTExprRef Z3Int = mkBitvector(Int, Int.getBitWidth());
738 return newExprRef(Z3Expr(
739 Context, Z3_mk_fpa_to_fp_bv(Context.Context, toZ3Expr(*Z3Int).AST,
740 toZ3Sort(*Sort).Sort)));
743 SMTExprRef mkSymbol(const char *Name, SMTSortRef Sort) override {
745 Z3Expr(Context, Z3_mk_const(Context.Context,
746 Z3_mk_string_symbol(Context.Context, Name),
747 toZ3Sort(*Sort).Sort)));
750 llvm::APSInt getBitvector(const SMTExprRef &Exp, unsigned BitWidth,
751 bool isUnsigned) override {
753 llvm::APInt(BitWidth,
754 Z3_get_numeral_string(Context.Context, toZ3Expr(*Exp).AST),
759 bool getBoolean(const SMTExprRef &Exp) override {
760 return Z3_get_bool_value(Context.Context, toZ3Expr(*Exp).AST) == Z3_L_TRUE;
763 SMTExprRef getFloatRoundingMode() override {
764 // TODO: Don't assume nearest ties to even rounding mode
765 return newExprRef(Z3Expr(Context, Z3_mk_fpa_rne(Context.Context)));
768 bool toAPFloat(const SMTSortRef &Sort, const SMTExprRef &AST,
769 llvm::APFloat &Float, bool useSemantics) {
770 assert(Sort->isFloatSort() && "Unsupported sort to floating-point!");
772 llvm::APSInt Int(Sort->getFloatSortSize(), true);
773 const llvm::fltSemantics &Semantics =
774 getFloatSemantics(Sort->getFloatSortSize());
775 SMTSortRef BVSort = getBitvectorSort(Sort->getFloatSortSize());
776 if (!toAPSInt(BVSort, AST, Int, true)) {
780 if (useSemantics && !areEquivalent(Float.getSemantics(), Semantics)) {
781 assert(false && "Floating-point types don't match!");
785 Float = llvm::APFloat(Semantics, Int);
789 bool toAPSInt(const SMTSortRef &Sort, const SMTExprRef &AST,
790 llvm::APSInt &Int, bool useSemantics) {
791 if (Sort->isBitvectorSort()) {
792 if (useSemantics && Int.getBitWidth() != Sort->getBitvectorSortSize()) {
793 assert(false && "Bitvector types don't match!");
797 // FIXME: This function is also used to retrieve floating-point values,
798 // which can be 16, 32, 64 or 128 bits long. Bitvectors can be anything
799 // between 1 and 64 bits long, which is the reason we have this weird
800 // guard. In the future, we need proper calls in the backend to retrieve
801 // floating-points and its special values (NaN, +/-infinity, +/-zero),
802 // then we can drop this weird condition.
803 if (Sort->getBitvectorSortSize() <= 64 ||
804 Sort->getBitvectorSortSize() == 128) {
805 Int = getBitvector(AST, Int.getBitWidth(), Int.isUnsigned());
809 assert(false && "Bitwidth not supported!");
813 if (Sort->isBooleanSort()) {
814 if (useSemantics && Int.getBitWidth() < 1) {
815 assert(false && "Boolean type doesn't match!");
819 Int = llvm::APSInt(llvm::APInt(Int.getBitWidth(), getBoolean(AST)),
824 llvm_unreachable("Unsupported sort to integer!");
827 bool getInterpretation(const SMTExprRef &Exp, llvm::APSInt &Int) override {
828 Z3Model Model(Context, Z3_solver_get_model(Context.Context, Solver));
829 Z3_func_decl Func = Z3_get_app_decl(
830 Context.Context, Z3_to_app(Context.Context, toZ3Expr(*Exp).AST));
831 if (Z3_model_has_interp(Context.Context, Model.Model, Func) != Z3_L_TRUE)
834 SMTExprRef Assign = newExprRef(
836 Z3_model_get_const_interp(Context.Context, Model.Model, Func)));
837 SMTSortRef Sort = getSort(Assign);
838 return toAPSInt(Sort, Assign, Int, true);
841 bool getInterpretation(const SMTExprRef &Exp, llvm::APFloat &Float) override {
842 Z3Model Model(Context, Z3_solver_get_model(Context.Context, Solver));
843 Z3_func_decl Func = Z3_get_app_decl(
844 Context.Context, Z3_to_app(Context.Context, toZ3Expr(*Exp).AST));
845 if (Z3_model_has_interp(Context.Context, Model.Model, Func) != Z3_L_TRUE)
848 SMTExprRef Assign = newExprRef(
850 Z3_model_get_const_interp(Context.Context, Model.Model, Func)));
851 SMTSortRef Sort = getSort(Assign);
852 return toAPFloat(Sort, Assign, Float, true);
855 Optional<bool> check() const override {
856 Z3_lbool res = Z3_solver_check(Context.Context, Solver);
857 if (res == Z3_L_TRUE)
860 if (res == Z3_L_FALSE)
863 return Optional<bool>();
866 void push() override { return Z3_solver_push(Context.Context, Solver); }
868 void pop(unsigned NumStates = 1) override {
869 assert(Z3_solver_get_num_scopes(Context.Context, Solver) >= NumStates);
870 return Z3_solver_pop(Context.Context, Solver, NumStates);
873 bool isFPSupported() override { return true; }
875 /// Reset the solver and remove all constraints.
876 void reset() override { Z3_solver_reset(Context.Context, Solver); }
878 void print(raw_ostream &OS) const override {
879 OS << Z3_solver_to_string(Context.Context, Solver);
881 }; // end class Z3Solver
883 } // end anonymous namespace
887 llvm::SMTSolverRef llvm::CreateZ3Solver() {
889 return std::make_unique<Z3Solver>();
891 llvm::report_fatal_error("LLVM was not compiled with Z3 support, rebuild "
892 "with -DLLVM_ENABLE_Z3_SOLVER=ON",
898 LLVM_DUMP_METHOD void SMTSort::dump() const { print(llvm::errs()); }
899 LLVM_DUMP_METHOD void SMTExpr::dump() const { print(llvm::errs()); }
900 LLVM_DUMP_METHOD void SMTSolver::dump() const { print(llvm::errs()); }