aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/formal/SymbolicVariables.h
blob: ef40944cdc185338c92b006d850de8b56d603acb (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
/*
    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/formal/SSAVariable.h>

#include <libsolidity/formal/SolverInterface.h>

#include <libsolidity/ast/Types.h>

#include <memory>

namespace dev
{
namespace solidity
{

class Type;

/**
 * This abstract class represents the symbolic version of a program variable.
 */
class SymbolicVariable
{
public:
    SymbolicVariable(
        TypePointer _type,
        std::string const& _uniqueName,
        smt::SolverInterface& _interface
    );

    virtual ~SymbolicVariable() = default;

    smt::Expression currentValue() const;
    std::string currentName() const;
    virtual smt::Expression valueAtIndex(int _index) const;
    smt::Expression increaseIndex();

    unsigned index() const { return m_ssa->index(); }
    unsigned& index() { return m_ssa->index(); }

    TypePointer const& type() const { return m_type; }

protected:
    std::string uniqueSymbol(unsigned _index) const;

    TypePointer m_type;
    std::string m_uniqueName;
    smt::SolverInterface& m_interface;
    std::shared_ptr<SSAVariable> m_ssa;
};

/**
 * Specialization of SymbolicVariable for Bool
 */
class SymbolicBoolVariable: public SymbolicVariable
{
public:
    SymbolicBoolVariable(
        TypePointer _type,
        std::string const& _uniqueName,
        smt::SolverInterface& _interface
    );
};

/**
 * Specialization of SymbolicVariable for Integers
 */
class SymbolicIntVariable: public SymbolicVariable
{
public:
    SymbolicIntVariable(
        TypePointer _type,
        std::string const& _uniqueName,
        smt::SolverInterface& _interface
    );
};

/**
 * Specialization of SymbolicVariable for Address
 */
class SymbolicAddressVariable: public SymbolicIntVariable
{
public:
    SymbolicAddressVariable(
        std::string const& _uniqueName,
        smt::SolverInterface& _interface
    );
};

/**
 * Specialization of SymbolicVariable for FixedBytes
 */
class SymbolicFixedBytesVariable: public SymbolicIntVariable
{
public:
    SymbolicFixedBytesVariable(
        unsigned _numBytes,
        std::string const& _uniqueName,
        smt::SolverInterface& _interface
    );
};

}
}