aboutsummaryrefslogtreecommitdiffstats
path: root/libevmasm/AssemblyItem.cpp
blob: 649630217bdaba5e5ca8f191c9d23b2ca71978ca (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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/*
    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 <libevmasm/AssemblyItem.h>

#include <libdevcore/CommonData.h>
#include <libdevcore/FixedHash.h>

#include <fstream>

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

AssemblyItem AssemblyItem::toSubAssemblyTag(size_t _subId) const
{
    assertThrow(data() < (u256(1) << 64), Exception, "Tag already has subassembly set.");

    assertThrow(m_type == PushTag || m_type == Tag, Exception, "");
    AssemblyItem r = *this;
    r.m_type = PushTag;
    r.setPushTagSubIdAndTag(_subId, size_t(data()));
    return r;
}

pair<size_t, size_t> AssemblyItem::splitForeignPushTag() const
{
    assertThrow(m_type == PushTag || m_type == Tag, Exception, "");
    return make_pair(size_t((data()) / (u256(1) << 64)) - 1, size_t(data()));
}

void AssemblyItem::setPushTagSubIdAndTag(size_t _subId, size_t _tag)
{
    assertThrow(m_type == PushTag || m_type == Tag, Exception, "");
    setData(_tag + (u256(_subId + 1) << 64));
}

unsigned AssemblyItem::bytesRequired(unsigned _addressLength) const
{
    switch (m_type)
    {
    case Operation:
    case Tag: // 1 byte for the JUMPDEST
        return 1;
    case PushString:
        return 1 + 32;
    case Push:
        return 1 + max<unsigned>(1, dev::bytesRequired(data()));
    case PushSubSize:
    case PushProgramSize:
        return 1 + 4;       // worst case: a 16MB program
    case PushTag:
    case PushData:
    case PushSub:
        return 1 + _addressLength;
    case PushLibraryAddress:
        return 1 + 20;
    default:
        break;
    }
    BOOST_THROW_EXCEPTION(InvalidOpcode());
}

int AssemblyItem::arguments() const
{
    if (type() == Operation)
        return instructionInfo(instruction()).args;
    else
        return 0;
}

int AssemblyItem::returnValues() const
{
    switch (m_type)
    {
    case Operation:
        return instructionInfo(instruction()).ret;
    case Push:
    case PushString:
    case PushTag:
    case PushData:
    case PushSub:
    case PushSubSize:
    case PushProgramSize:
    case PushLibraryAddress:
        return 1;
    case Tag:
        return 0;
    default:;
    }
    return 0;
}

bool AssemblyItem::canBeFunctional() const
{
    switch (m_type)
    {
    case Operation:
        return !isDupInstruction(instruction()) && !isSwapInstruction(instruction());
    case Push:
    case PushString:
    case PushTag:
    case PushData:
    case PushSub:
    case PushSubSize:
    case PushProgramSize:
    case PushLibraryAddress:
        return true;
    case Tag:
        return false;
    default:;
    }
    return 0;
}

string AssemblyItem::getJumpTypeAsString() const
{
    switch (m_jumpType)
    {
    case JumpType::IntoFunction:
        return "[in]";
    case JumpType::OutOfFunction:
        return "[out]";
    case JumpType::Ordinary:
    default:
        return "";
    }
}

string AssemblyItem::toAssemblyText() const
{
    string text;
    switch (type())
    {
    case Operation:
    {
        assertThrow(isValidInstruction(instruction()), AssemblyException, "Invalid instruction.");
        string name = instructionInfo(instruction()).name;
        transform(name.begin(), name.end(), name.begin(), [](unsigned char _c) { return tolower(_c); });
        text = name;
        break;
    }
    case Push:
        text = toHex(toCompactBigEndian(data(), 1), 1, HexPrefix::Add);
        break;
    case PushString:
        text = string("data_") + toHex(data());
        break;
    case PushTag:
    {
        size_t sub{0};
        size_t tag{0};
        tie(sub, tag) = splitForeignPushTag();
        if (sub == size_t(-1))
            text = string("tag_") + to_string(tag);
        else
            text = string("tag_") + to_string(sub) + "_" + to_string(tag);
        break;
    }
    case Tag:
        assertThrow(data() < 0x10000, AssemblyException, "Declaration of sub-assembly tag.");
        text = string("tag_") + to_string(size_t(data())) + ":";
        break;
    case PushData:
        text = string("data_") + toHex(data());
        break;
    case PushSub:
        text = string("dataOffset(sub_") + to_string(size_t(data())) + ")";
        break;
    case PushSubSize:
        text = string("dataSize(sub_") + to_string(size_t(data())) + ")";
        break;
    case PushProgramSize:
        text = string("bytecodeSize");
        break;
    case PushLibraryAddress:
        text = string("linkerSymbol(\"") + toHex(data()) + string("\")");
        break;
    case UndefinedItem:
        assertThrow(false, AssemblyException, "Invalid assembly item.");
        break;
    default:
        BOOST_THROW_EXCEPTION(InvalidOpcode());
    }
    if (m_jumpType == JumpType::IntoFunction || m_jumpType == JumpType::OutOfFunction)
    {
        text += "\t//";
        if (m_jumpType == JumpType::IntoFunction)
            text += " in";
        else
            text += " out";
    }
    return text;
}

ostream& dev::eth::operator<<(ostream& _out, AssemblyItem const& _item)
{
    switch (_item.type())
    {
    case Operation:
        _out << " " << instructionInfo(_item.instruction()).name;
        if (_item.instruction() == solidity::Instruction::JUMP || _item.instruction() == solidity::Instruction::JUMPI)
            _out << "\t" << _item.getJumpTypeAsString();
        break;
    case Push:
        _out << " PUSH " << hex << _item.data() << dec;
        break;
    case PushString:
        _out << " PushString"  << hex << (unsigned)_item.data() << dec;
        break;
    case PushTag:
    {
        size_t subId = _item.splitForeignPushTag().first;
        if (subId == size_t(-1))
            _out << " PushTag " << _item.splitForeignPushTag().second;
        else
            _out << " PushTag " << subId << ":" << _item.splitForeignPushTag().second;
        break;
    }
    case Tag:
        _out << " Tag " << _item.data();
        break;
    case PushData:
        _out << " PushData " << hex << (unsigned)_item.data() << dec;
        break;
    case PushSub:
        _out << " PushSub " << hex << size_t(_item.data()) << dec;
        break;
    case PushSubSize:
        _out << " PushSubSize " << hex << size_t(_item.data()) << dec;
        break;
    case PushProgramSize:
        _out << " PushProgramSize";
        break;
    case PushLibraryAddress:
    {
        string hash(h256((_item.data())).hex());
        _out << " PushLibraryAddress " << hash.substr(0, 8) + "..." + hash.substr(hash.length() - 8);
        break;
    }
    case UndefinedItem:
        _out << " ???";
        break;
    default:
        BOOST_THROW_EXCEPTION(InvalidOpcode());
    }
    return _out;
}