aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/formal/SMTPortfolio.cpp
blob: e1cde04c645b8639ce1e24c69a2eb2a8bd2b25d0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
    This file is part of solidity.

    solidity is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    solidity is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with solidity.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <libsolidity/formal/SMTPortfolio.h>

#ifdef HAVE_Z3
#include <libsolidity/formal/Z3Interface.h>
#endif
#ifdef HAVE_CVC4
#include <libsolidity/formal/CVC4Interface.h>
#endif
#if !defined (HAVE_Z3) && !defined (HAVE_CVC4)
#include <libsolidity/formal/SMTLib2Interface.h>
#endif

using namespace std;
using namespace dev;
using namespace dev::solidity;
using namespace dev::solidity::smt;

SMTPortfolio::SMTPortfolio(ReadCallback::Callback const& _readCallback)
{
#ifdef HAVE_Z3
    m_solvers.emplace_back(make_shared<smt::Z3Interface>());
#endif
#ifdef HAVE_CVC4
    m_solvers.emplace_back(make_shared<smt::CVC4Interface>());
#endif
#if !defined (HAVE_Z3) && !defined (HAVE_CVC4)
    m_solvers.emplace_back(make_shared<smt::SMTLib2Interface>(_readCallback)),
#endif
    (void)_readCallback;
}

void SMTPortfolio::reset()
{
    for (auto s : m_solvers)
        s->reset();
}

void SMTPortfolio::push()
{
    for (auto s : m_solvers)
        s->push();
}

void SMTPortfolio::pop()
{
    for (auto s : m_solvers)
        s->pop();
}

void SMTPortfolio::declareFunction(string _name, vector<Sort> const& _domain, Sort _codomain)
{
    for (auto s : m_solvers)
        s->declareFunction(_name, _domain, _codomain);
}

void SMTPortfolio::declareInteger(string _name)
{
    for (auto s : m_solvers)
        s->declareInteger(_name);
}

void SMTPortfolio::declareBool(string _name)
{
    for (auto s : m_solvers)
        s->declareBool(_name);
}

void SMTPortfolio::addAssertion(Expression const& _expr)
{
    for (auto s : m_solvers)
        s->addAssertion(_expr);
}

/*
 * Broadcasts the SMT query to all solvers and returns a single result.
 * This comment explains how this result is decided.
 *
 * When a solver is queried, there are four possible answers:
 *   SATISFIABLE (SAT), UNSATISFIABLE (UNSAT), UNKNOWN, CONFLICTING, ERROR
 * We say that a solver _answered_ the query if it returns either:
 *   SAT or UNSAT
 * A solver did not answer the query if it returns either:
 *   UNKNOWN (it tried but couldn't solve it) or ERROR (crash, internal error, API error, etc).
 *
 * Ideally all solvers answer the query and agree on what the answer is
 * (all say SAT or all say UNSAT).
 *
 * The actual logic as as follows:
 * 1) If at least one solver answers the query, all the non-answer results are ignored.
 *   Here SAT/UNSAT is preferred over UNKNOWN since it's an actual answer, and over ERROR
 *   because one buggy solver/integration shouldn't break the portfolio.
 *
 * 2) If at least one solver answers SAT and at least one answers UNSAT, at least one of them is buggy
 * and the result is CONFLICTING.
 *   In the future if we have more than 2 solvers enabled we could go with the majority.
 *
 * 3) If NO solver answers the query:
 *   If at least one solver returned UNKNOWN (where the rest returned ERROR), the result is UNKNOWN.
 *   This is preferred over ERROR since the SMTChecker might decide to abstract the query
 *   when it is told that this is a hard query to solve.
 *
 *   If all solvers return ERROR, the result is ERROR.
*/
pair<CheckResult, vector<string>> SMTPortfolio::check(vector<Expression> const& _expressionsToEvaluate)
{
    CheckResult lastResult = CheckResult::ERROR;
    vector<string> finalValues;
    for (auto s : m_solvers)
    {
        CheckResult result;
        vector<string> values;
        tie(result, values) = s->check(_expressionsToEvaluate);
        if (solverAnswered(result))
        {
            if (!solverAnswered(lastResult))
            {
                lastResult = result;
                finalValues = std::move(values);
            }
            else if (lastResult != result)
            {
                lastResult = CheckResult::CONFLICTING;
                break;
            }
        }
        else if (result == CheckResult::UNKNOWN && lastResult == CheckResult::ERROR)
            lastResult = result;
    }
    return make_pair(lastResult, finalValues);
}

bool SMTPortfolio::solverAnswered(CheckResult result)
{
    return result == CheckResult::SATISFIABLE || result == CheckResult::UNSATISFIABLE;
}