aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/formal/SolverInterface.h
blob: 74c993e854e8bd1ffcee0aa0ad35e69db2ce62b2 (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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
    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/>.
*/

#pragma once

#include <libsolidity/interface/Exceptions.h>
#include <libsolidity/interface/ReadFile.h>

#include <libdevcore/Common.h>
#include <libdevcore/Exceptions.h>

#include <boost/noncopyable.hpp>

#include <map>
#include <string>
#include <vector>
#include <cstdio>

namespace dev
{
namespace solidity
{
namespace smt
{

enum class CheckResult
{
    SATISFIABLE, UNSATISFIABLE, UNKNOWN, ERROR
};

enum class Sort
{
    Int,
    Bool,
    IntIntFun // Function of one Int returning a single Int
};

/// C++ representation of an SMTLIB2 expression.
class Expression
{
    friend class SolverInterface;
public:
    explicit Expression(bool _v): name(_v ? "true" : "false"), sort(Sort::Bool) {}
    Expression(size_t _number): name(std::to_string(_number)), sort(Sort::Int) {}
    Expression(u256 const& _number): name(_number.str()), sort(Sort::Int) {}
    Expression(bigint const& _number): name(_number.str()), sort(Sort::Int) {}

    Expression(Expression const&) = default;
    Expression(Expression&&) = default;
    Expression& operator=(Expression const&) = default;
    Expression& operator=(Expression&&) = default;

    static Expression ite(Expression _condition, Expression _trueValue, Expression _falseValue)
    {
        solAssert(_trueValue.sort == _falseValue.sort, "");
        return Expression("ite", std::vector<Expression>{
            std::move(_condition), std::move(_trueValue), std::move(_falseValue)
        }, _trueValue.sort);
    }

    friend Expression operator!(Expression _a)
    {
        return Expression("not", std::move(_a), Sort::Bool);
    }
    friend Expression operator&&(Expression _a, Expression _b)
    {
        return Expression("and", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator||(Expression _a, Expression _b)
    {
        return Expression("or", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator==(Expression _a, Expression _b)
    {
        return Expression("=", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator!=(Expression _a, Expression _b)
    {
        return !(std::move(_a) == std::move(_b));
    }
    friend Expression operator<(Expression _a, Expression _b)
    {
        return Expression("<", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator<=(Expression _a, Expression _b)
    {
        return Expression("<=", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator>(Expression _a, Expression _b)
    {
        return Expression(">", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator>=(Expression _a, Expression _b)
    {
        return Expression(">=", std::move(_a), std::move(_b), Sort::Bool);
    }
    friend Expression operator+(Expression _a, Expression _b)
    {
        return Expression("+", std::move(_a), std::move(_b), Sort::Int);
    }
    friend Expression operator-(Expression _a, Expression _b)
    {
        return Expression("-", std::move(_a), std::move(_b), Sort::Int);
    }
    friend Expression operator*(Expression _a, Expression _b)
    {
        return Expression("*", std::move(_a), std::move(_b), Sort::Int);
    }
    friend Expression operator/(Expression _a, Expression _b)
    {
        return Expression("/", std::move(_a), std::move(_b), Sort::Int);
    }
    Expression operator()(Expression _a) const
    {
        solAssert(
            sort == Sort::IntIntFun && arguments.empty(),
            "Attempted function application to non-function."
        );
        return Expression(name, _a, Sort::Int);
    }

    std::string const name;
    std::vector<Expression> const arguments;
    Sort sort;

private:
    /// Manual constructor, should only be used by SolverInterface and this class itself.
    Expression(std::string _name, std::vector<Expression> _arguments, Sort _sort):
        name(std::move(_name)), arguments(std::move(_arguments)), sort(_sort) {}

    explicit Expression(std::string _name, Sort _sort):
        Expression(std::move(_name), std::vector<Expression>{}, _sort) {}
    Expression(std::string _name, Expression _arg, Sort _sort):
        Expression(std::move(_name), std::vector<Expression>{std::move(_arg)}, _sort) {}
    Expression(std::string _name, Expression _arg1, Expression _arg2, Sort _sort):
        Expression(std::move(_name), std::vector<Expression>{std::move(_arg1), std::move(_arg2)}, _sort) {}
};

DEV_SIMPLE_EXCEPTION(SolverError);

class SolverInterface
{
public:
    virtual void reset() = 0;

    virtual void push() = 0;
    virtual void pop() = 0;

    virtual Expression newFunction(std::string _name, Sort _domain, Sort _codomain)
    {
        solAssert(_domain == Sort::Int && _codomain == Sort::Int, "Function sort not supported.");
        // Subclasses should do something here
        return Expression(std::move(_name), {}, Sort::IntIntFun);
    }
    virtual Expression newInteger(std::string _name)
    {
        // Subclasses should do something here
        return Expression(std::move(_name), {}, Sort::Int);
    }
    virtual Expression newBool(std::string _name)
    {
        // Subclasses should do something here
        return Expression(std::move(_name), {}, Sort::Bool);
    }

    virtual void addAssertion(Expression const& _expr) = 0;

    /// Checks for satisfiability, evaluates the expressions if a model
    /// is available. Throws SMTSolverError on error.
    virtual std::pair<CheckResult, std::vector<std::string>>
    check(std::vector<Expression> const& _expressionsToEvaluate) = 0;
};


}
}
}