2015-04-24 15:35:16 +00:00
|
|
|
/*
|
2016-11-18 23:13:20 +00:00
|
|
|
This file is part of solidity.
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is free software: you can redistribute it and/or modify
|
2015-04-24 15:35:16 +00:00
|
|
|
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.
|
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is distributed in the hope that it will be useful,
|
2015-04-24 15:35:16 +00:00
|
|
|
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
|
2016-11-18 23:13:20 +00:00
|
|
|
along with solidity. If not, see <http://www.gnu.org/licenses/>.
|
2015-04-24 15:35:16 +00:00
|
|
|
*/
|
|
|
|
/** @file Assembly.cpp
|
|
|
|
* @author Gav Wood <i@gavwood.com>
|
|
|
|
* @date 2014
|
|
|
|
*/
|
|
|
|
|
2019-03-28 12:07:52 +00:00
|
|
|
#include <libevmasm/Assembly.h>
|
2016-11-11 13:11:07 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
#include <libevmasm/CommonSubexpressionEliminator.h>
|
|
|
|
#include <libevmasm/ControlFlowGraph.h>
|
2016-11-11 13:11:07 +00:00
|
|
|
#include <libevmasm/PeepholeOptimiser.h>
|
2017-07-27 22:28:49 +00:00
|
|
|
#include <libevmasm/JumpdestRemover.h>
|
2015-05-12 14:16:44 +00:00
|
|
|
#include <libevmasm/BlockDeduplicator.h>
|
2015-06-01 10:32:59 +00:00
|
|
|
#include <libevmasm/ConstantOptimiser.h>
|
|
|
|
#include <libevmasm/GasMeter.h>
|
2016-11-11 13:11:07 +00:00
|
|
|
|
|
|
|
#include <fstream>
|
2015-04-24 15:35:16 +00:00
|
|
|
#include <json/json.h>
|
2016-11-11 13:11:07 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
using namespace std;
|
|
|
|
using namespace dev;
|
|
|
|
using namespace dev::eth;
|
2018-11-14 16:11:55 +00:00
|
|
|
using namespace langutil;
|
2015-04-24 15:35:16 +00:00
|
|
|
|
|
|
|
void Assembly::append(Assembly const& _a)
|
|
|
|
{
|
|
|
|
auto newDeposit = m_deposit + _a.deposit();
|
|
|
|
for (AssemblyItem i: _a.m_items)
|
|
|
|
{
|
2018-09-27 08:01:45 +00:00
|
|
|
switch (i.type())
|
|
|
|
{
|
|
|
|
case Tag:
|
|
|
|
case PushTag:
|
2015-04-24 15:35:16 +00:00
|
|
|
i.setData(i.data() + m_usedTags);
|
2018-09-27 08:01:45 +00:00
|
|
|
break;
|
|
|
|
case PushSub:
|
|
|
|
case PushSubSize:
|
2015-06-25 16:41:26 +00:00
|
|
|
i.setData(i.data() + m_subs.size());
|
2018-09-27 08:01:45 +00:00
|
|
|
break;
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
append(i);
|
|
|
|
}
|
|
|
|
m_deposit = newDeposit;
|
|
|
|
m_usedTags += _a.m_usedTags;
|
2017-08-25 15:04:31 +00:00
|
|
|
// This does not transfer the names of named tags on purpose. The tags themselves are
|
|
|
|
// transferred, but their names are only available inside the assembly.
|
2015-04-24 15:35:16 +00:00
|
|
|
for (auto const& i: _a.m_data)
|
|
|
|
m_data.insert(i);
|
|
|
|
for (auto const& i: _a.m_strings)
|
|
|
|
m_strings.insert(i);
|
2015-09-10 10:02:18 +00:00
|
|
|
m_subs += _a.m_subs;
|
|
|
|
for (auto const& lib: _a.m_libraries)
|
|
|
|
m_libraries.insert(lib);
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void Assembly::append(Assembly const& _a, int _deposit)
|
|
|
|
{
|
2016-11-16 10:16:01 +00:00
|
|
|
assertThrow(_deposit <= _a.m_deposit, InvalidDeposit, "");
|
|
|
|
|
|
|
|
append(_a);
|
|
|
|
while (_deposit++ < _a.m_deposit)
|
|
|
|
append(Instruction::POP);
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
|
2018-09-19 16:29:43 +00:00
|
|
|
AssemblyItem const& Assembly::append(AssemblyItem const& _i)
|
|
|
|
{
|
|
|
|
assertThrow(m_deposit >= 0, AssemblyException, "Stack underflow.");
|
|
|
|
m_deposit += _i.deposit();
|
2018-12-10 18:02:39 +00:00
|
|
|
m_items.emplace_back(_i);
|
2018-09-19 16:29:43 +00:00
|
|
|
if (m_items.back().location().isEmpty() && !m_currentSourceLocation.isEmpty())
|
|
|
|
m_items.back().setLocation(m_currentSourceLocation);
|
2019-10-08 09:00:40 +00:00
|
|
|
m_items.back().m_modifierDepth = m_currentModifierDepth;
|
2018-09-19 16:29:43 +00:00
|
|
|
return back();
|
|
|
|
}
|
|
|
|
|
|
|
|
void Assembly::injectStart(AssemblyItem const& _i)
|
|
|
|
{
|
|
|
|
m_items.insert(m_items.begin(), _i);
|
|
|
|
}
|
|
|
|
|
2016-11-11 10:41:50 +00:00
|
|
|
unsigned Assembly::bytesRequired(unsigned subTagSize) const
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2016-11-16 14:09:01 +00:00
|
|
|
for (unsigned tagSize = subTagSize; true; ++tagSize)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
|
|
|
unsigned ret = 1;
|
|
|
|
for (auto const& i: m_data)
|
|
|
|
ret += i.second.size();
|
|
|
|
|
|
|
|
for (AssemblyItem const& i: m_items)
|
2016-11-11 10:41:50 +00:00
|
|
|
ret += i.bytesRequired(tagSize);
|
|
|
|
if (dev::bytesRequired(ret) <= tagSize)
|
2015-04-24 15:35:16 +00:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-01-24 00:09:10 +00:00
|
|
|
namespace
|
|
|
|
{
|
|
|
|
|
|
|
|
string locationFromSources(StringMap const& _sourceCodes, SourceLocation const& _location)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2018-11-28 15:19:22 +00:00
|
|
|
if (_location.isEmpty() || !_location.source.get() || _sourceCodes.empty() || _location.start >= _location.end || _location.start < 0)
|
2015-04-24 15:35:16 +00:00
|
|
|
return "";
|
|
|
|
|
2018-11-28 15:19:22 +00:00
|
|
|
auto it = _sourceCodes.find(_location.source->name());
|
2015-04-24 15:35:16 +00:00
|
|
|
if (it == _sourceCodes.end())
|
|
|
|
return "";
|
|
|
|
|
|
|
|
string const& source = it->second;
|
|
|
|
if (size_t(_location.start) >= source.size())
|
|
|
|
return "";
|
|
|
|
|
|
|
|
string cut = source.substr(_location.start, _location.end - _location.start);
|
|
|
|
auto newLinePos = cut.find_first_of("\n");
|
|
|
|
if (newLinePos != string::npos)
|
|
|
|
cut = cut.substr(0, newLinePos) + "...";
|
|
|
|
|
2015-06-08 10:09:24 +00:00
|
|
|
return cut;
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
|
2017-01-24 00:09:10 +00:00
|
|
|
class Functionalizer
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2017-01-24 00:09:10 +00:00
|
|
|
public:
|
|
|
|
Functionalizer (ostream& _out, string const& _prefix, StringMap const& _sourceCodes):
|
|
|
|
m_out(_out), m_prefix(_prefix), m_sourceCodes(_sourceCodes)
|
|
|
|
{}
|
|
|
|
|
|
|
|
void feed(AssemblyItem const& _item)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2017-01-24 00:09:10 +00:00
|
|
|
if (!_item.location().isEmpty() && _item.location() != m_location)
|
|
|
|
{
|
|
|
|
flush();
|
|
|
|
m_location = _item.location();
|
2017-02-16 18:58:08 +00:00
|
|
|
printLocation();
|
2017-01-24 00:09:10 +00:00
|
|
|
}
|
|
|
|
if (!(
|
|
|
|
_item.canBeFunctional() &&
|
|
|
|
_item.returnValues() <= 1 &&
|
|
|
|
_item.arguments() <= int(m_pending.size())
|
|
|
|
))
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2017-01-24 00:09:10 +00:00
|
|
|
flush();
|
|
|
|
m_out << m_prefix << (_item.type() == Tag ? "" : " ") << _item.toAssemblyText() << endl;
|
|
|
|
return;
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
2017-01-24 00:09:10 +00:00
|
|
|
string expression = _item.toAssemblyText();
|
|
|
|
if (_item.arguments() > 0)
|
|
|
|
{
|
|
|
|
expression += "(";
|
|
|
|
for (int i = 0; i < _item.arguments(); ++i)
|
|
|
|
{
|
|
|
|
expression += m_pending.back();
|
|
|
|
m_pending.pop_back();
|
|
|
|
if (i + 1 < _item.arguments())
|
|
|
|
expression += ", ";
|
|
|
|
}
|
|
|
|
expression += ")";
|
|
|
|
}
|
|
|
|
|
|
|
|
m_pending.push_back(expression);
|
|
|
|
if (_item.returnValues() != 1)
|
|
|
|
flush();
|
|
|
|
}
|
|
|
|
|
|
|
|
void flush()
|
|
|
|
{
|
|
|
|
for (string const& expression: m_pending)
|
|
|
|
m_out << m_prefix << " " << expression << endl;
|
|
|
|
m_pending.clear();
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
|
2017-01-24 00:09:10 +00:00
|
|
|
void printLocation()
|
|
|
|
{
|
2018-11-28 15:19:22 +00:00
|
|
|
if (!m_location.source && m_location.isEmpty())
|
2017-01-24 00:09:10 +00:00
|
|
|
return;
|
|
|
|
m_out << m_prefix << " /*";
|
2018-11-28 15:19:22 +00:00
|
|
|
if (m_location.source)
|
|
|
|
m_out << " \"" + m_location.source->name() + "\"";
|
2017-01-24 00:09:10 +00:00
|
|
|
if (!m_location.isEmpty())
|
|
|
|
m_out << ":" << to_string(m_location.start) + ":" + to_string(m_location.end);
|
|
|
|
m_out << " " << locationFromSources(m_sourceCodes, m_location);
|
|
|
|
m_out << " */" << endl;
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
strings m_pending;
|
|
|
|
SourceLocation m_location;
|
|
|
|
|
|
|
|
ostream& m_out;
|
|
|
|
string const& m_prefix;
|
|
|
|
StringMap const& m_sourceCodes;
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2017-08-30 00:58:19 +00:00
|
|
|
void Assembly::assemblyStream(ostream& _out, string const& _prefix, StringMap const& _sourceCodes) const
|
2017-01-24 00:09:10 +00:00
|
|
|
{
|
|
|
|
Functionalizer f(_out, _prefix, _sourceCodes);
|
|
|
|
|
|
|
|
for (auto const& i: m_items)
|
|
|
|
f.feed(i);
|
|
|
|
f.flush();
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
if (!m_data.empty() || !m_subs.empty())
|
|
|
|
{
|
2016-11-15 13:01:11 +00:00
|
|
|
_out << _prefix << "stop" << endl;
|
2015-04-24 15:35:16 +00:00
|
|
|
for (auto const& i: m_data)
|
2017-04-11 17:53:55 +00:00
|
|
|
if (u256(i.first) >= m_subs.size())
|
|
|
|
_out << _prefix << "data_" << toHex(u256(i.first)) << " " << toHex(i.second) << endl;
|
2016-11-15 13:01:11 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
for (size_t i = 0; i < m_subs.size(); ++i)
|
|
|
|
{
|
2016-11-15 13:01:11 +00:00
|
|
|
_out << endl << _prefix << "sub_" << i << ": assembly {\n";
|
2017-06-15 09:22:47 +00:00
|
|
|
m_subs[i]->assemblyStream(_out, _prefix + " ", _sourceCodes);
|
2016-11-15 13:01:11 +00:00
|
|
|
_out << _prefix << "}" << endl;
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
}
|
2016-11-15 13:01:11 +00:00
|
|
|
|
2017-06-14 12:31:04 +00:00
|
|
|
if (m_auxiliaryData.size() > 0)
|
|
|
|
_out << endl << _prefix << "auxdata: 0x" << toHex(m_auxiliaryData) << endl;
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
|
2017-08-30 01:17:15 +00:00
|
|
|
string Assembly::assemblyString(StringMap const& _sourceCodes) const
|
|
|
|
{
|
|
|
|
ostringstream tmp;
|
|
|
|
assemblyStream(tmp, "", _sourceCodes);
|
|
|
|
return tmp.str();
|
|
|
|
}
|
|
|
|
|
2017-08-28 14:30:01 +00:00
|
|
|
Json::Value Assembly::createJsonValue(string _name, int _begin, int _end, string _value, string _jumpType)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
|
|
|
Json::Value value;
|
|
|
|
value["name"] = _name;
|
|
|
|
value["begin"] = _begin;
|
|
|
|
value["end"] = _end;
|
|
|
|
if (!_value.empty())
|
|
|
|
value["value"] = _value;
|
|
|
|
if (!_jumpType.empty())
|
|
|
|
value["jumpType"] = _jumpType;
|
|
|
|
return value;
|
|
|
|
}
|
|
|
|
|
2017-08-28 14:30:01 +00:00
|
|
|
string Assembly::toStringInHex(u256 _value)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
|
|
|
std::stringstream hexStr;
|
2019-11-04 16:00:48 +00:00
|
|
|
hexStr << std::uppercase << hex << _value;
|
2015-04-24 15:35:16 +00:00
|
|
|
return hexStr.str();
|
|
|
|
}
|
|
|
|
|
2017-06-15 09:22:47 +00:00
|
|
|
Json::Value Assembly::assemblyJSON(StringMap const& _sourceCodes) const
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
|
|
|
Json::Value root;
|
|
|
|
|
2017-07-27 14:40:01 +00:00
|
|
|
Json::Value& collection = root[".code"] = Json::arrayValue;
|
2015-04-24 15:35:16 +00:00
|
|
|
for (AssemblyItem const& i: m_items)
|
|
|
|
{
|
|
|
|
switch (i.type())
|
|
|
|
{
|
|
|
|
case Operation:
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue(instructionInfo(i.instruction()).name, i.location().start, i.location().end, i.getJumpTypeAsString()));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case Push:
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("PUSH", i.location().start, i.location().end, toStringInHex(i.data()), i.getJumpTypeAsString()));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushString:
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("PUSH tag", i.location().start, i.location().end, m_strings.at((h256)i.data())));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushTag:
|
2015-05-15 10:23:13 +00:00
|
|
|
if (i.data() == 0)
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("PUSH [ErrorTag]", i.location().start, i.location().end, ""));
|
2015-05-20 11:15:01 +00:00
|
|
|
else
|
|
|
|
collection.append(
|
2018-08-08 19:46:28 +00:00
|
|
|
createJsonValue("PUSH [tag]", i.location().start, i.location().end, dev::toString(i.data())));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushSub:
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("PUSH [$]", i.location().start, i.location().end, dev::toString(h256(i.data()))));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushSubSize:
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("PUSH #[$]", i.location().start, i.location().end, dev::toString(h256(i.data()))));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushProgramSize:
|
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("PUSHSIZE", i.location().start, i.location().end));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
2015-09-10 10:02:18 +00:00
|
|
|
case PushLibraryAddress:
|
|
|
|
collection.append(
|
|
|
|
createJsonValue("PUSHLIB", i.location().start, i.location().end, m_libraries.at(h256(i.data())))
|
|
|
|
);
|
|
|
|
break;
|
2017-11-14 11:58:04 +00:00
|
|
|
case PushDeployTimeAddress:
|
|
|
|
collection.append(
|
|
|
|
createJsonValue("PUSHDEPLOYADDRESS", i.location().start, i.location().end)
|
|
|
|
);
|
|
|
|
break;
|
2015-04-24 15:35:16 +00:00
|
|
|
case Tag:
|
|
|
|
collection.append(
|
2018-08-08 19:46:28 +00:00
|
|
|
createJsonValue("tag", i.location().start, i.location().end, dev::toString(i.data())));
|
2015-04-24 15:35:16 +00:00
|
|
|
collection.append(
|
2015-09-08 15:11:02 +00:00
|
|
|
createJsonValue("JUMPDEST", i.location().start, i.location().end));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushData:
|
2015-09-08 15:11:02 +00:00
|
|
|
collection.append(createJsonValue("PUSH data", i.location().start, i.location().end, toStringInHex(i.data())));
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
default:
|
2019-11-22 17:02:12 +00:00
|
|
|
assertThrow(false, InvalidOpcode, "");
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!m_data.empty() || !m_subs.empty())
|
|
|
|
{
|
2017-07-27 14:40:01 +00:00
|
|
|
Json::Value& data = root[".data"] = Json::objectValue;
|
2015-04-24 15:35:16 +00:00
|
|
|
for (auto const& i: m_data)
|
|
|
|
if (u256(i.first) >= m_subs.size())
|
|
|
|
data[toStringInHex((u256)i.first)] = toHex(i.second);
|
|
|
|
|
|
|
|
for (size_t i = 0; i < m_subs.size(); ++i)
|
|
|
|
{
|
|
|
|
std::stringstream hexStr;
|
|
|
|
hexStr << hex << i;
|
2017-06-15 09:22:47 +00:00
|
|
|
data[hexStr.str()] = m_subs[i]->assemblyJSON(_sourceCodes);
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
}
|
2017-06-14 12:30:34 +00:00
|
|
|
|
2017-06-14 12:31:04 +00:00
|
|
|
if (m_auxiliaryData.size() > 0)
|
|
|
|
root[".auxdata"] = toHex(m_auxiliaryData);
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
return root;
|
|
|
|
}
|
|
|
|
|
2017-08-25 15:04:31 +00:00
|
|
|
AssemblyItem Assembly::namedTag(string const& _name)
|
|
|
|
{
|
2017-09-18 10:04:09 +00:00
|
|
|
assertThrow(!_name.empty(), AssemblyException, "Empty named tag.");
|
2017-08-25 15:04:31 +00:00
|
|
|
if (!m_namedTags.count(_name))
|
|
|
|
m_namedTags[_name] = size_t(newTag().data());
|
2018-12-10 18:03:47 +00:00
|
|
|
return AssemblyItem{Tag, m_namedTags.at(_name)};
|
2017-08-25 15:04:31 +00:00
|
|
|
}
|
|
|
|
|
2015-09-10 10:02:18 +00:00
|
|
|
AssemblyItem Assembly::newPushLibraryAddress(string const& _identifier)
|
|
|
|
{
|
2016-10-05 10:30:28 +00:00
|
|
|
h256 h(dev::keccak256(_identifier));
|
2015-09-10 10:02:18 +00:00
|
|
|
m_libraries[h] = _identifier;
|
2018-12-10 18:03:47 +00:00
|
|
|
return AssemblyItem{PushLibraryAddress, h};
|
2015-09-10 10:02:18 +00:00
|
|
|
}
|
|
|
|
|
2018-03-01 11:06:36 +00:00
|
|
|
Assembly& Assembly::optimise(bool _enable, EVMVersion _evmVersion, bool _isCreation, size_t _runs)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2017-06-30 21:10:55 +00:00
|
|
|
OptimiserSettings settings;
|
|
|
|
settings.isCreation = _isCreation;
|
2017-07-27 22:28:49 +00:00
|
|
|
settings.runJumpdestRemover = true;
|
2017-06-30 21:10:55 +00:00
|
|
|
settings.runPeephole = true;
|
|
|
|
if (_enable)
|
|
|
|
{
|
|
|
|
settings.runDeduplicate = true;
|
|
|
|
settings.runCSE = true;
|
|
|
|
settings.runConstantOptimiser = true;
|
|
|
|
}
|
2018-03-01 11:06:36 +00:00
|
|
|
settings.evmVersion = _evmVersion;
|
2017-06-30 21:10:55 +00:00
|
|
|
settings.expectedExecutionsPerDeployment = _runs;
|
2017-07-27 22:28:49 +00:00
|
|
|
optimise(settings);
|
2017-06-30 21:10:55 +00:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-07-27 22:28:49 +00:00
|
|
|
Assembly& Assembly::optimise(OptimiserSettings const& _settings)
|
2017-06-30 21:10:55 +00:00
|
|
|
{
|
2017-07-27 22:28:49 +00:00
|
|
|
optimiseInternal(_settings, {});
|
2016-11-10 17:16:21 +00:00
|
|
|
return *this;
|
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2017-07-27 22:28:49 +00:00
|
|
|
map<u256, u256> Assembly::optimiseInternal(
|
|
|
|
OptimiserSettings const& _settings,
|
2019-02-20 11:10:29 +00:00
|
|
|
std::set<size_t> _tagsReferencedFromOutside
|
2017-07-27 22:28:49 +00:00
|
|
|
)
|
2016-11-10 17:16:21 +00:00
|
|
|
{
|
2017-06-30 21:10:55 +00:00
|
|
|
// Run optimisation for sub-assemblies.
|
2016-11-10 17:16:21 +00:00
|
|
|
for (size_t subId = 0; subId < m_subs.size(); ++subId)
|
|
|
|
{
|
2017-06-30 21:10:55 +00:00
|
|
|
OptimiserSettings settings = _settings;
|
|
|
|
// Disable creation mode for sub-assemblies.
|
|
|
|
settings.isCreation = false;
|
2017-07-27 22:28:49 +00:00
|
|
|
map<u256, u256> subTagReplacements = m_subs[subId]->optimiseInternal(
|
|
|
|
settings,
|
|
|
|
JumpdestRemover::referencedTags(m_items, subId)
|
|
|
|
);
|
2017-06-30 21:10:55 +00:00
|
|
|
// Apply the replacements (can be empty).
|
2016-11-10 17:16:21 +00:00
|
|
|
BlockDeduplicator::applyTagReplacement(m_items, subTagReplacements, subId);
|
|
|
|
}
|
|
|
|
|
|
|
|
map<u256, u256> tagReplacements;
|
2017-06-30 21:10:55 +00:00
|
|
|
// Iterate until no new optimisation possibilities are found.
|
2016-12-01 10:31:58 +00:00
|
|
|
for (unsigned count = 1; count > 0;)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
|
|
|
count = 0;
|
|
|
|
|
2017-07-27 22:28:49 +00:00
|
|
|
if (_settings.runJumpdestRemover)
|
|
|
|
{
|
2018-12-10 18:03:47 +00:00
|
|
|
JumpdestRemover jumpdestOpt{m_items};
|
2017-07-27 22:28:49 +00:00
|
|
|
if (jumpdestOpt.optimise(_tagsReferencedFromOutside))
|
|
|
|
count++;
|
|
|
|
}
|
|
|
|
|
2017-06-30 21:10:55 +00:00
|
|
|
if (_settings.runPeephole)
|
|
|
|
{
|
2018-12-10 18:03:47 +00:00
|
|
|
PeepholeOptimiser peepOpt{m_items};
|
2017-10-16 16:45:21 +00:00
|
|
|
while (peepOpt.optimise())
|
|
|
|
{
|
2017-06-30 21:10:55 +00:00
|
|
|
count++;
|
2017-10-16 16:45:21 +00:00
|
|
|
assertThrow(count < 64000, OptimizerException, "Peephole optimizer seems to be stuck.");
|
|
|
|
}
|
2017-06-30 21:10:55 +00:00
|
|
|
}
|
2016-11-11 13:11:07 +00:00
|
|
|
|
2015-05-28 12:43:46 +00:00
|
|
|
// This only modifies PushTags, we have to run again to actually remove code.
|
2017-06-30 21:10:55 +00:00
|
|
|
if (_settings.runDeduplicate)
|
2016-11-10 17:16:21 +00:00
|
|
|
{
|
2018-12-10 18:03:47 +00:00
|
|
|
BlockDeduplicator dedup{m_items};
|
2017-06-30 21:10:55 +00:00
|
|
|
if (dedup.deduplicate())
|
|
|
|
{
|
2019-02-20 11:10:29 +00:00
|
|
|
for (auto const& replacement: dedup.replacedTags())
|
|
|
|
{
|
|
|
|
assertThrow(
|
|
|
|
replacement.first <= size_t(-1) && replacement.second <= size_t(-1),
|
|
|
|
OptimizerException,
|
|
|
|
"Invalid tag replacement."
|
|
|
|
);
|
|
|
|
assertThrow(
|
|
|
|
!tagReplacements.count(replacement.first),
|
|
|
|
OptimizerException,
|
|
|
|
"Replacement already known."
|
|
|
|
);
|
|
|
|
tagReplacements[replacement.first] = replacement.second;
|
|
|
|
if (_tagsReferencedFromOutside.erase(size_t(replacement.first)))
|
|
|
|
_tagsReferencedFromOutside.insert(size_t(replacement.second));
|
|
|
|
}
|
2017-06-30 21:10:55 +00:00
|
|
|
count++;
|
|
|
|
}
|
2016-11-10 17:16:21 +00:00
|
|
|
}
|
2015-05-28 12:43:46 +00:00
|
|
|
|
2017-06-30 21:10:55 +00:00
|
|
|
if (_settings.runCSE)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2016-11-10 17:16:21 +00:00
|
|
|
// Control flow graph optimization has been here before but is disabled because it
|
|
|
|
// assumes we only jump to tags that are pushed. This is not the case anymore with
|
|
|
|
// function types that can be stored in storage.
|
2015-05-06 17:15:14 +00:00
|
|
|
AssemblyItems optimisedItems;
|
2016-11-10 17:16:21 +00:00
|
|
|
|
2018-12-10 18:03:47 +00:00
|
|
|
bool usesMSize = (find(m_items.begin(), m_items.end(), AssemblyItem{Instruction::MSIZE}) != m_items.end());
|
2018-03-08 18:41:29 +00:00
|
|
|
|
2016-11-10 17:16:21 +00:00
|
|
|
auto iter = m_items.begin();
|
|
|
|
while (iter != m_items.end())
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2016-10-21 15:33:30 +00:00
|
|
|
KnownState emptyState;
|
2018-12-10 18:03:47 +00:00
|
|
|
CommonSubexpressionEliminator eliminator{emptyState};
|
2016-11-22 13:55:09 +00:00
|
|
|
auto orig = iter;
|
2018-03-08 18:41:29 +00:00
|
|
|
iter = eliminator.feedItems(iter, m_items.end(), usesMSize);
|
2016-11-22 13:55:09 +00:00
|
|
|
bool shouldReplace = false;
|
|
|
|
AssemblyItems optimisedChunk;
|
|
|
|
try
|
|
|
|
{
|
|
|
|
optimisedChunk = eliminator.getOptimizedItems();
|
|
|
|
shouldReplace = (optimisedChunk.size() < size_t(iter - orig));
|
|
|
|
}
|
|
|
|
catch (StackTooDeepException const&)
|
|
|
|
{
|
|
|
|
// This might happen if the opcode reconstruction is not as efficient
|
|
|
|
// as the hand-crafted code.
|
|
|
|
}
|
|
|
|
catch (ItemNotAvailableException const&)
|
2015-05-06 17:15:14 +00:00
|
|
|
{
|
2016-11-22 13:55:09 +00:00
|
|
|
// This might happen if e.g. associativity and commutativity rules
|
|
|
|
// reorganise the expression tree, but not all leaves are available.
|
2015-05-06 17:15:14 +00:00
|
|
|
}
|
2016-11-22 13:55:09 +00:00
|
|
|
|
|
|
|
if (shouldReplace)
|
|
|
|
{
|
|
|
|
count++;
|
|
|
|
optimisedItems += optimisedChunk;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
copy(orig, iter, back_inserter(optimisedItems));
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
2016-11-11 10:41:50 +00:00
|
|
|
if (optimisedItems.size() < m_items.size())
|
|
|
|
{
|
|
|
|
m_items = move(optimisedItems);
|
|
|
|
count++;
|
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-06-30 21:10:55 +00:00
|
|
|
if (_settings.runConstantOptimiser)
|
2016-12-01 10:31:58 +00:00
|
|
|
ConstantOptimisationMethod::optimiseConstants(
|
2017-06-30 21:10:55 +00:00
|
|
|
_settings.isCreation,
|
|
|
|
_settings.isCreation ? 1 : _settings.expectedExecutionsPerDeployment,
|
2018-03-01 11:06:36 +00:00
|
|
|
_settings.evmVersion,
|
2019-01-28 16:29:10 +00:00
|
|
|
*this
|
2016-11-11 13:11:07 +00:00
|
|
|
);
|
2015-06-01 10:32:59 +00:00
|
|
|
|
2016-11-10 17:16:21 +00:00
|
|
|
return tagReplacements;
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
|
2015-09-10 10:02:18 +00:00
|
|
|
LinkerObject const& Assembly::assemble() const
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2019-11-20 21:34:39 +00:00
|
|
|
// Return the already assembled object, if present.
|
2015-09-10 10:02:18 +00:00
|
|
|
if (!m_assembledObject.bytecode.empty())
|
|
|
|
return m_assembledObject;
|
2019-11-20 21:34:39 +00:00
|
|
|
// Otherwise ensure the object is actually clear.
|
|
|
|
assertThrow(m_assembledObject.linkReferences.empty(), AssemblyException, "Unexpected link references.");
|
2015-09-10 10:02:18 +00:00
|
|
|
|
2016-11-11 10:41:50 +00:00
|
|
|
size_t subTagSize = 1;
|
|
|
|
for (auto const& sub: m_subs)
|
|
|
|
{
|
|
|
|
sub->assemble();
|
2017-07-27 22:28:49 +00:00
|
|
|
for (size_t tagPos: sub->m_tagPositionsInBytecode)
|
|
|
|
if (tagPos != size_t(-1) && tagPos > subTagSize)
|
|
|
|
subTagSize = tagPos;
|
2016-11-11 10:41:50 +00:00
|
|
|
}
|
|
|
|
|
2015-09-10 10:02:18 +00:00
|
|
|
LinkerObject& ret = m_assembledObject;
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2016-11-11 10:41:50 +00:00
|
|
|
size_t bytesRequiredForCode = bytesRequired(subTagSize);
|
2016-11-10 17:16:21 +00:00
|
|
|
m_tagPositionsInBytecode = vector<size_t>(m_usedTags, -1);
|
|
|
|
map<size_t, pair<size_t, size_t>> tagRef;
|
2015-04-24 15:35:16 +00:00
|
|
|
multimap<h256, unsigned> dataRef;
|
2015-09-10 10:02:18 +00:00
|
|
|
multimap<size_t, size_t> subRef;
|
2015-04-24 15:35:16 +00:00
|
|
|
vector<unsigned> sizeRef; ///< Pointers to code locations where the size of the program is inserted
|
2016-11-11 10:41:50 +00:00
|
|
|
unsigned bytesPerTag = dev::bytesRequired(bytesRequiredForCode);
|
2018-11-07 11:04:46 +00:00
|
|
|
uint8_t tagPush = (uint8_t)Instruction::PUSH1 - 1 + bytesPerTag;
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2016-11-24 09:32:52 +00:00
|
|
|
unsigned bytesRequiredIncludingData = bytesRequiredForCode + 1 + m_auxiliaryData.size();
|
2015-09-10 10:02:18 +00:00
|
|
|
for (auto const& sub: m_subs)
|
2016-11-11 10:41:50 +00:00
|
|
|
bytesRequiredIncludingData += sub->assemble().bytecode.size();
|
2015-09-10 10:02:18 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
unsigned bytesPerDataRef = dev::bytesRequired(bytesRequiredIncludingData);
|
2018-11-07 11:04:46 +00:00
|
|
|
uint8_t dataRefPush = (uint8_t)Instruction::PUSH1 - 1 + bytesPerDataRef;
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.reserve(bytesRequiredIncludingData);
|
2015-04-24 15:35:16 +00:00
|
|
|
|
|
|
|
for (AssemblyItem const& i: m_items)
|
2015-05-15 10:23:13 +00:00
|
|
|
{
|
|
|
|
// store position of the invalid jump destination
|
2016-11-10 17:16:21 +00:00
|
|
|
if (i.type() != Tag && m_tagPositionsInBytecode[0] == size_t(-1))
|
|
|
|
m_tagPositionsInBytecode[0] = ret.bytecode.size();
|
2015-05-15 10:23:13 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
switch (i.type())
|
|
|
|
{
|
|
|
|
case Operation:
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back((uint8_t)i.instruction());
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushString:
|
|
|
|
{
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back((uint8_t)Instruction::PUSH32);
|
2015-04-24 15:35:16 +00:00
|
|
|
unsigned ii = 0;
|
|
|
|
for (auto j: m_strings.at((h256)i.data()))
|
|
|
|
if (++ii > 32)
|
|
|
|
break;
|
|
|
|
else
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back((uint8_t)j);
|
2015-04-24 15:35:16 +00:00
|
|
|
while (ii++ < 32)
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.push_back(0);
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
case Push:
|
|
|
|
{
|
2018-11-07 11:04:46 +00:00
|
|
|
uint8_t b = max<unsigned>(1, dev::bytesRequired(i.data()));
|
|
|
|
ret.bytecode.push_back((uint8_t)Instruction::PUSH1 - 1 + b);
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.resize(ret.bytecode.size() + b);
|
|
|
|
bytesRef byr(&ret.bytecode.back() + 1 - b, b);
|
2015-04-24 15:35:16 +00:00
|
|
|
toBigEndian(i.data(), byr);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case PushTag:
|
|
|
|
{
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.push_back(tagPush);
|
2016-11-10 17:16:21 +00:00
|
|
|
tagRef[ret.bytecode.size()] = i.splitForeignPushTag();
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.resize(ret.bytecode.size() + bytesPerTag);
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
}
|
2015-09-10 10:02:18 +00:00
|
|
|
case PushData:
|
|
|
|
ret.bytecode.push_back(dataRefPush);
|
|
|
|
dataRef.insert(make_pair((h256)i.data(), ret.bytecode.size()));
|
|
|
|
ret.bytecode.resize(ret.bytecode.size() + bytesPerDataRef);
|
|
|
|
break;
|
|
|
|
case PushSub:
|
2019-01-29 15:15:58 +00:00
|
|
|
assertThrow(i.data() <= size_t(-1), AssemblyException, "");
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.push_back(dataRefPush);
|
|
|
|
subRef.insert(make_pair(size_t(i.data()), ret.bytecode.size()));
|
|
|
|
ret.bytecode.resize(ret.bytecode.size() + bytesPerDataRef);
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
case PushSubSize:
|
|
|
|
{
|
2019-01-29 15:15:58 +00:00
|
|
|
assertThrow(i.data() <= size_t(-1), AssemblyException, "");
|
2016-11-11 10:41:50 +00:00
|
|
|
auto s = m_subs.at(size_t(i.data()))->assemble().bytecode.size();
|
2015-05-19 22:27:07 +00:00
|
|
|
i.setPushedValue(u256(s));
|
2018-11-07 11:04:46 +00:00
|
|
|
uint8_t b = max<unsigned>(1, dev::bytesRequired(s));
|
|
|
|
ret.bytecode.push_back((uint8_t)Instruction::PUSH1 - 1 + b);
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.resize(ret.bytecode.size() + b);
|
|
|
|
bytesRef byr(&ret.bytecode.back() + 1 - b, b);
|
2015-04-24 15:35:16 +00:00
|
|
|
toBigEndian(s, byr);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
case PushProgramSize:
|
|
|
|
{
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode.push_back(dataRefPush);
|
|
|
|
sizeRef.push_back(ret.bytecode.size());
|
|
|
|
ret.bytecode.resize(ret.bytecode.size() + bytesPerDataRef);
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
}
|
2015-09-10 10:02:18 +00:00
|
|
|
case PushLibraryAddress:
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back(uint8_t(Instruction::PUSH20));
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.linkReferences[ret.bytecode.size()] = m_libraries.at(i.data());
|
|
|
|
ret.bytecode.resize(ret.bytecode.size() + 20);
|
|
|
|
break;
|
2017-11-14 11:58:04 +00:00
|
|
|
case PushDeployTimeAddress:
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back(uint8_t(Instruction::PUSH20));
|
2017-11-14 11:58:04 +00:00
|
|
|
ret.bytecode.resize(ret.bytecode.size() + 20);
|
|
|
|
break;
|
2015-04-24 15:35:16 +00:00
|
|
|
case Tag:
|
2017-09-18 10:04:09 +00:00
|
|
|
assertThrow(i.data() != 0, AssemblyException, "Invalid tag position.");
|
2016-11-10 17:16:21 +00:00
|
|
|
assertThrow(i.splitForeignPushTag().first == size_t(-1), AssemblyException, "Foreign tag.");
|
|
|
|
assertThrow(ret.bytecode.size() < 0xffffffffL, AssemblyException, "Tag too large.");
|
2017-08-25 15:04:31 +00:00
|
|
|
assertThrow(m_tagPositionsInBytecode[size_t(i.data())] == size_t(-1), AssemblyException, "Duplicate tag position.");
|
2016-11-10 17:16:21 +00:00
|
|
|
m_tagPositionsInBytecode[size_t(i.data())] = ret.bytecode.size();
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back((uint8_t)Instruction::JUMPDEST);
|
2015-04-24 15:35:16 +00:00
|
|
|
break;
|
|
|
|
default:
|
2019-11-22 17:02:12 +00:00
|
|
|
assertThrow(false, InvalidOpcode, "Unexpected opcode while assembling.");
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
2015-05-15 10:23:13 +00:00
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2016-11-24 11:32:42 +00:00
|
|
|
if (!m_subs.empty() || !m_data.empty() || !m_auxiliaryData.empty())
|
2018-08-14 09:41:40 +00:00
|
|
|
// Append an INVALID here to help tests find miscompilation.
|
2018-11-07 11:04:46 +00:00
|
|
|
ret.bytecode.push_back(uint8_t(Instruction::INVALID));
|
2016-11-24 09:32:52 +00:00
|
|
|
|
2015-09-10 10:02:18 +00:00
|
|
|
for (size_t i = 0; i < m_subs.size(); ++i)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2015-09-10 10:02:18 +00:00
|
|
|
auto references = subRef.equal_range(i);
|
|
|
|
if (references.first == references.second)
|
|
|
|
continue;
|
|
|
|
for (auto ref = references.first; ref != references.second; ++ref)
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2015-09-10 10:02:18 +00:00
|
|
|
bytesRef r(ret.bytecode.data() + ref->second, bytesPerDataRef);
|
|
|
|
toBigEndian(ret.bytecode.size(), r);
|
|
|
|
}
|
2016-11-11 10:41:50 +00:00
|
|
|
ret.append(m_subs[i]->assemble());
|
2015-09-10 10:02:18 +00:00
|
|
|
}
|
2016-11-10 17:16:21 +00:00
|
|
|
for (auto const& i: tagRef)
|
|
|
|
{
|
|
|
|
size_t subId;
|
|
|
|
size_t tagId;
|
|
|
|
tie(subId, tagId) = i.second;
|
|
|
|
assertThrow(subId == size_t(-1) || subId < m_subs.size(), AssemblyException, "Invalid sub id");
|
|
|
|
std::vector<size_t> const& tagPositions =
|
|
|
|
subId == size_t(-1) ?
|
|
|
|
m_tagPositionsInBytecode :
|
2016-11-11 10:41:50 +00:00
|
|
|
m_subs[subId]->m_tagPositionsInBytecode;
|
2016-11-10 17:16:21 +00:00
|
|
|
assertThrow(tagId < tagPositions.size(), AssemblyException, "Reference to non-existing tag.");
|
|
|
|
size_t pos = tagPositions[tagId];
|
|
|
|
assertThrow(pos != size_t(-1), AssemblyException, "Reference to tag without position.");
|
|
|
|
assertThrow(dev::bytesRequired(pos) <= bytesPerTag, AssemblyException, "Tag too large for reserved space.");
|
|
|
|
bytesRef r(ret.bytecode.data() + i.first, bytesPerTag);
|
|
|
|
toBigEndian(pos, r);
|
|
|
|
}
|
2015-09-10 10:02:18 +00:00
|
|
|
for (auto const& dataItem: m_data)
|
|
|
|
{
|
|
|
|
auto references = dataRef.equal_range(dataItem.first);
|
|
|
|
if (references.first == references.second)
|
|
|
|
continue;
|
|
|
|
for (auto ref = references.first; ref != references.second; ++ref)
|
|
|
|
{
|
|
|
|
bytesRef r(ret.bytecode.data() + ref->second, bytesPerDataRef);
|
|
|
|
toBigEndian(ret.bytecode.size(), r);
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
2015-09-10 10:02:18 +00:00
|
|
|
ret.bytecode += dataItem.second;
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
2016-11-24 09:32:52 +00:00
|
|
|
|
|
|
|
ret.bytecode += m_auxiliaryData;
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
for (unsigned pos: sizeRef)
|
|
|
|
{
|
2015-09-10 10:02:18 +00:00
|
|
|
bytesRef r(ret.bytecode.data() + pos, bytesPerDataRef);
|
|
|
|
toBigEndian(ret.bytecode.size(), r);
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
|
|
|
return ret;
|
|
|
|
}
|