aboutsummaryrefslogtreecommitdiffstats
path: root/libevmasm/PeepholeOptimiser.cpp
blob: f42dba487a4905b71327bedd7ed62a4ce719f525 (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
/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @file PeepholeOptimiser.h
 * Performs local optimising code changes to assembly.
 */

#include "PeepholeOptimiser.h"

#include <libevmasm/AssemblyItem.h>
#include <libevmasm/SemanticInformation.h>

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

// TODO: Extend this to use the tools from ExpressionClasses.cpp

struct Identity
{
    static size_t windowSize() { return 1; }
    static bool apply(AssemblyItems::const_iterator _in, std::back_insert_iterator<AssemblyItems> _out)
    {
        *_out = *_in;
        return true;
    }
};

struct PushPop
{
    static size_t windowSize() { return 2; }
    static bool apply(AssemblyItems::const_iterator _in, std::back_insert_iterator<AssemblyItems>)
    {
        auto t = _in[0].type();
        if (_in[1] == Instruction::POP && (
            SemanticInformation::isDupInstruction(_in[0]) ||
            t == Push || t == PushString || t == PushTag || t == PushSub ||
            t == PushSubSize || t == PushProgramSize || t == PushData || t == PushLibraryAddress
        ))
            return true;
        else
            return false;
    }
};

struct DoubleSwap
{
    static size_t windowSize() { return 2; }
    static bool apply(AssemblyItems::const_iterator _in, std::back_insert_iterator<AssemblyItems>)
    {
        if (_in[0] == _in[1] && SemanticInformation::isSwapInstruction(_in[0]))
            return true;
        else
            return false;
    }
};

struct JumpToNext
{
    static size_t windowSize() { return 3; }
    static bool apply(AssemblyItems::const_iterator _in, std::back_insert_iterator<AssemblyItems> _out)
    {
        if (
            _in[0].type() == PushTag &&
            (_in[1] == Instruction::JUMP || _in[1] == Instruction::JUMPI) &&
            _in[2].type() == Tag &&
            _in[0].data() == _in[2].data()
        )
        {
            if (_in[1] == Instruction::JUMPI)
                *_out = AssemblyItem(Instruction::POP, _in[1].location());
            *_out = _in[2];
            return true;
        }
        else
            return false;
    }
};

struct TagConjunctions
{
    static size_t windowSize() { return 3; }
    static bool apply(AssemblyItems::const_iterator _in, std::back_insert_iterator<AssemblyItems> _out)
    {
        if (
            _in[0].type() == PushTag &&
            _in[2] == Instruction::AND &&
            _in[1].type() == Push &&
            (_in[1].data() & u256(0xFFFFFFFF)) == u256(0xFFFFFFFF)
        )
        {
            *_out = _in[0];
            return true;
        }
        else
            return false;
    }
};

struct OptimiserState
{
    AssemblyItems const& items;
    size_t i;
    std::back_insert_iterator<AssemblyItems> out;
};

void applyMethods(OptimiserState&)
{
    assertThrow(false, OptimizerException, "Peephole optimizer failed to apply identity.");
}

template <typename Method, typename... OtherMethods>
void applyMethods(OptimiserState& _state, Method, OtherMethods... _other)
{
    if (_state.i + Method::windowSize() <= _state.items.size() && Method::apply(_state.items.begin() + _state.i, _state.out))
        _state.i += Method::windowSize();
    else
        applyMethods(_state, _other...);
}

bool PeepholeOptimiser::optimise()
{
    OptimiserState state {m_items, 0, std::back_inserter(m_optimisedItems)};
    while (state.i < m_items.size())
        applyMethods(state, PushPop(), DoubleSwap(), JumpToNext(), TagConjunctions(), Identity());
    if (m_optimisedItems.size() < m_items.size())
    {
        m_items = std::move(m_optimisedItems);
        return true;
    }
    else
        return false;

}