aboutsummaryrefslogtreecommitdiffstats
path: root/libevmasm/PathGasMeter.cpp
blob: cdadba7688af8af6c7f44aad9f499ef412510102 (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
/*
    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/>.
*/
/** @file PathGasMeter.cpp
 * @author Christian <c@ethdev.com>
 * @date 2015
 */

#include "PathGasMeter.h"
#include <libevmasm/KnownState.h>
#include <libevmasm/SemanticInformation.h>

using namespace std;
using namespace dev;
using namespace dev::eth;

PathGasMeter::PathGasMeter(AssemblyItems const& _items, solidity::EVMVersion _evmVersion):
    m_items(_items), m_evmVersion(_evmVersion)
{
    for (size_t i = 0; i < m_items.size(); ++i)
        if (m_items[i].type() == Tag)
            m_tagPositions[m_items[i].data()] = i;
}

GasMeter::GasConsumption PathGasMeter::estimateMax(
    size_t _startIndex,
    shared_ptr<KnownState> const& _state
)
{
    auto path = unique_ptr<GasPath>(new GasPath());
    path->index = _startIndex;
    path->state = _state->copy();
    queue(move(path));

    GasMeter::GasConsumption gas;
    while (!m_queue.empty() && !gas.isInfinite)
        gas = max(gas, handleQueueItem());
    return gas;
}

void PathGasMeter::queue(std::unique_ptr<GasPath>&& _newPath)
{
    if (
        m_highestGasUsagePerJumpdest.count(_newPath->index) &&
        _newPath->gas < m_highestGasUsagePerJumpdest.at(_newPath->index)
    )
        return;
    m_highestGasUsagePerJumpdest[_newPath->index] = _newPath->gas;
    m_queue[_newPath->index] = move(_newPath);
}

GasMeter::GasConsumption PathGasMeter::handleQueueItem()
{
    assertThrow(!m_queue.empty(), OptimizerException, "");

    unique_ptr<GasPath> path = move(m_queue.rbegin()->second);
    m_queue.erase(--m_queue.end());

    shared_ptr<KnownState> state = path->state;
    GasMeter meter(state, m_evmVersion, path->largestMemoryAccess);
    ExpressionClasses& classes = state->expressionClasses();
    GasMeter::GasConsumption gas = path->gas;
    size_t index = path->index;

    if (index >= m_items.size() || (index > 0 && m_items.at(index).type() != Tag))
        // Invalid jump usually provokes an out-of-gas exception, but we want to give an upper
        // bound on the gas that is needed without changing the behaviour, so it is fine to
        // return the current gas value.
        return gas;

    set<u256> jumpTags;
    for (; index < m_items.size() && !gas.isInfinite; ++index)
    {
        bool branchStops = false;
        jumpTags.clear();
        AssemblyItem const& item = m_items.at(index);
        if (item.type() == Tag || item == AssemblyItem(Instruction::JUMPDEST))
        {
            // Do not allow any backwards jump. This is quite restrictive but should work for
            // the simplest things.
            if (path->visitedJumpdests.count(index))
                return GasMeter::GasConsumption::infinite();
            path->visitedJumpdests.insert(index);
        }
        else if (item == AssemblyItem(Instruction::JUMP))
        {
            branchStops = true;
            jumpTags = state->tagsInExpression(state->relativeStackElement(0));
            if (jumpTags.empty()) // unknown jump destination
                return GasMeter::GasConsumption::infinite();
        }
        else if (item == AssemblyItem(Instruction::JUMPI))
        {
            ExpressionClasses::Id condition = state->relativeStackElement(-1);
            if (classes.knownNonZero(condition) || !classes.knownZero(condition))
            {
                jumpTags = state->tagsInExpression(state->relativeStackElement(0));
                if (jumpTags.empty()) // unknown jump destination
                    return GasMeter::GasConsumption::infinite();
            }
            branchStops = classes.knownNonZero(condition);
        }
        else if (SemanticInformation::altersControlFlow(item))
            branchStops = true;

        gas += meter.estimateMax(item);

        for (u256 const& tag: jumpTags)
        {
            auto newPath = unique_ptr<GasPath>(new GasPath());
            newPath->index = m_items.size();
            if (m_tagPositions.count(tag))
                newPath->index = m_tagPositions.at(tag);
            newPath->gas = gas;
            newPath->largestMemoryAccess = meter.largestMemoryAccess();
            newPath->state = state->copy();
            newPath->visitedJumpdests = path->visitedJumpdests;
            queue(move(newPath));
        }

        if (branchStops)
            break;
    }

    return gas;
}