solidity/libyul/YulStack.cpp

337 lines
10 KiB
C++
Raw Normal View History

/*
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/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
* Full assembly stack that can support EVM-assembly and Yul as input and EVM, EVM1.5 and
2019-12-09 16:36:12 +00:00
* Ewasm as output.
*/
#include <libyul/YulStack.h>
2018-12-17 18:24:42 +00:00
#include <libyul/AsmAnalysis.h>
#include <libyul/AsmAnalysisInfo.h>
#include <libyul/backends/evm/EthAssemblyAdapter.h>
2018-12-17 18:24:42 +00:00
#include <libyul/backends/evm/EVMCodeTransform.h>
2018-12-06 23:56:16 +00:00
#include <libyul/backends/evm/EVMDialect.h>
2018-12-17 18:24:42 +00:00
#include <libyul/backends/evm/EVMObjectCompiler.h>
2019-05-28 10:57:15 +00:00
#include <libyul/backends/evm/EVMMetrics.h>
#include <libyul/backends/wasm/WasmDialect.h>
#include <libyul/backends/wasm/WasmObjectCompiler.h>
#include <libyul/backends/wasm/EVMToEwasmTranslator.h>
2018-11-07 11:01:43 +00:00
#include <libyul/ObjectParser.h>
#include <libyul/optimiser/Suite.h>
2019-02-13 11:07:20 +00:00
#include <libevmasm/Assembly.h>
#include <liblangutil/Scanner.h>
#include <boost/algorithm/string.hpp>
#include <optional>
2019-02-13 11:07:20 +00:00
using namespace std;
2019-12-11 16:31:36 +00:00
using namespace solidity;
using namespace solidity::yul;
using namespace solidity::langutil;
namespace
{
Dialect const& languageToDialect(YulStack::Language _language, EVMVersion _version)
{
switch (_language)
{
case YulStack::Language::Assembly:
case YulStack::Language::StrictAssembly:
2019-02-21 20:56:30 +00:00
return EVMDialect::strictAssemblyForEVMObjects(_version);
case YulStack::Language::Yul:
2020-01-29 17:14:03 +00:00
return EVMDialectTyped::instance(_version);
case YulStack::Language::Ewasm:
return WasmDialect::instance();
}
yulAssert(false, "");
2020-01-29 17:14:03 +00:00
return Dialect::yulDeprecated();
}
2020-10-29 16:44:26 +00:00
// Duplicated from libsolidity/codegen/CompilerContext.cpp
// TODO: refactor and remove duplication
evmasm::Assembly::OptimiserSettings translateOptimiserSettings(
frontend::OptimiserSettings const& _settings,
langutil::EVMVersion _evmVersion
)
{
// Constructing it this way so that we notice changes in the fields.
evmasm::Assembly::OptimiserSettings asmSettings{false, false, false, false, false, false, _evmVersion, 0};
2020-10-29 16:44:26 +00:00
asmSettings.runInliner = _settings.runInliner;
asmSettings.runJumpdestRemover = _settings.runJumpdestRemover;
asmSettings.runPeephole = _settings.runPeephole;
asmSettings.runDeduplicate = _settings.runDeduplicate;
asmSettings.runCSE = _settings.runCSE;
asmSettings.runConstantOptimiser = _settings.runConstantOptimiser;
asmSettings.expectedExecutionsPerDeployment = _settings.expectedExecutionsPerDeployment;
asmSettings.evmVersion = _evmVersion;
return asmSettings;
}
}
CharStream const& YulStack::charStream(string const& _sourceName) const
{
2021-06-29 12:38:59 +00:00
yulAssert(m_charStream, "");
yulAssert(m_charStream->name() == _sourceName, "");
return *m_charStream;
}
bool YulStack::parseAndAnalyze(std::string const& _sourceName, std::string const& _source)
{
2017-06-07 13:41:44 +00:00
m_errors.clear();
m_analysisSuccessful = false;
2021-06-29 12:38:59 +00:00
m_charStream = make_unique<CharStream>(_source, _sourceName);
shared_ptr<Scanner> scanner = make_shared<Scanner>(*m_charStream);
m_parserResult = ObjectParser(m_errorReporter, languageToDialect(m_language, m_evmVersion)).parse(scanner, false);
if (!m_errorReporter.errors().empty())
return false;
yulAssert(m_parserResult, "");
yulAssert(m_parserResult->code, "");
2017-06-02 20:52:48 +00:00
return analyzeParsed();
}
void YulStack::optimize()
{
if (!m_optimiserSettings.runYulOptimiser)
return;
yulAssert(m_analysisSuccessful, "Analysis was not successful.");
2018-12-04 17:57:32 +00:00
m_analysisSuccessful = false;
yulAssert(m_parserResult, "");
2019-05-15 08:33:35 +00:00
optimize(*m_parserResult, true);
yulAssert(analyzeParsed(), "Invalid source code after optimization.");
}
void YulStack::translate(YulStack::Language _targetLanguage)
{
if (m_language == _targetLanguage)
return;
yulAssert(
2019-12-09 16:36:12 +00:00
m_language == Language::StrictAssembly && _targetLanguage == Language::Ewasm,
"Invalid language combination"
);
*m_parserResult = EVMToEwasmTranslator(
2021-06-29 12:38:59 +00:00
languageToDialect(m_language, m_evmVersion),
*this
).run(*parserResult());
m_language = _targetLanguage;
}
bool YulStack::analyzeParsed()
2017-06-02 20:52:48 +00:00
{
yulAssert(m_parserResult, "");
2018-12-04 17:57:32 +00:00
m_analysisSuccessful = analyzeParsed(*m_parserResult);
2017-05-28 13:13:41 +00:00
return m_analysisSuccessful;
}
bool YulStack::analyzeParsed(Object& _object)
2018-12-04 17:57:32 +00:00
{
yulAssert(_object.code, "");
2019-02-13 11:07:20 +00:00
_object.analysisInfo = make_shared<AsmAnalysisInfo>();
AsmAnalyzer analyzer(
*_object.analysisInfo,
m_errorReporter,
languageToDialect(m_language, m_evmVersion),
{},
_object.qualifiedDataNames()
);
2018-12-04 17:57:32 +00:00
bool success = analyzer.analyze(*_object.code);
for (auto& subNode: _object.subObjects)
2019-02-13 11:07:20 +00:00
if (auto subObject = dynamic_cast<Object*>(subNode.get()))
2018-12-04 17:57:32 +00:00
if (!analyzeParsed(*subObject))
success = false;
return success;
}
void YulStack::compileEVM(AbstractAssembly& _assembly, bool _optimize) const
2018-12-06 23:56:16 +00:00
{
EVMDialect const* dialect = nullptr;
2019-10-25 13:39:44 +00:00
switch (m_language)
{
case Language::Assembly:
case Language::StrictAssembly:
dialect = &EVMDialect::strictAssemblyForEVMObjects(m_evmVersion);
break;
case Language::Yul:
2019-12-19 15:01:28 +00:00
dialect = &EVMDialectTyped::instance(m_evmVersion);
2019-10-25 13:39:44 +00:00
break;
default:
yulAssert(false, "Invalid language.");
2019-10-25 13:39:44 +00:00
break;
}
2018-12-06 23:56:16 +00:00
2021-03-09 11:46:33 +00:00
EVMObjectCompiler::compile(*m_parserResult, _assembly, *dialect, _optimize);
2018-12-06 23:56:16 +00:00
}
void YulStack::optimize(Object& _object, bool _isCreation)
2018-12-04 17:57:32 +00:00
{
yulAssert(_object.code, "");
yulAssert(_object.analysisInfo, "");
2018-12-04 17:57:32 +00:00
for (auto& subNode: _object.subObjects)
2019-02-13 11:07:20 +00:00
if (auto subObject = dynamic_cast<Object*>(subNode.get()))
{
bool isCreation = !boost::ends_with(subObject->name.str(), "_deployed");
optimize(*subObject, isCreation);
}
2019-05-29 21:14:06 +00:00
Dialect const& dialect = languageToDialect(m_language, m_evmVersion);
unique_ptr<GasMeter> meter;
if (EVMDialect const* evmDialect = dynamic_cast<EVMDialect const*>(&dialect))
meter = make_unique<GasMeter>(*evmDialect, _isCreation, m_optimiserSettings.expectedExecutionsPerDeployment);
OptimiserSuite::run(
dialect,
meter.get(),
_object,
m_optimiserSettings.optimizeStackAllocation,
m_optimiserSettings.yulOptimiserSteps,
m_optimiserSettings.yulOptimiserCleanupSteps,
_isCreation ? nullopt : make_optional(m_optimiserSettings.expectedExecutionsPerDeployment),
{}
2019-05-29 21:14:06 +00:00
);
2018-12-04 17:57:32 +00:00
}
MachineAssemblyObject YulStack::assemble(Machine _machine) const
{
yulAssert(m_analysisSuccessful, "");
yulAssert(m_parserResult, "");
yulAssert(m_parserResult->code, "");
yulAssert(m_parserResult->analysisInfo, "");
2017-05-23 17:21:14 +00:00
switch (_machine)
{
case Machine::EVM:
return assembleWithDeployed().first;
2019-12-09 16:36:12 +00:00
case Machine::Ewasm:
{
2019-12-09 16:36:12 +00:00
yulAssert(m_language == Language::Ewasm, "");
Dialect const& dialect = languageToDialect(m_language, EVMVersion{});
MachineAssemblyObject object;
auto result = WasmObjectCompiler::compile(*m_parserResult, dialect);
2019-10-31 17:42:14 +00:00
object.assembly = std::move(result.first);
2019-12-11 16:31:36 +00:00
object.bytecode = make_shared<evmasm::LinkerObject>();
2019-10-31 17:42:14 +00:00
object.bytecode->bytecode = std::move(result.second);
return object;
}
}
// unreachable
2017-05-29 22:50:46 +00:00
return MachineAssemblyObject();
}
std::pair<MachineAssemblyObject, MachineAssemblyObject>
YulStack::assembleWithDeployed(optional<string_view> _deployName) const
2020-05-12 14:33:05 +00:00
{
auto [creationAssembly, deployedAssembly] = assembleEVMWithDeployed(_deployName);
yulAssert(creationAssembly, "");
2021-06-29 12:38:59 +00:00
yulAssert(m_charStream, "");
2020-05-12 14:33:05 +00:00
MachineAssemblyObject creationObject;
creationObject.bytecode = make_shared<evmasm::LinkerObject>(creationAssembly->assemble());
2020-05-12 14:33:05 +00:00
yulAssert(creationObject.bytecode->immutableReferences.empty(), "Leftover immutables.");
creationObject.assembly = creationAssembly->assemblyString(m_debugInfoSelection);
2020-05-12 14:33:05 +00:00
creationObject.sourceMappings = make_unique<string>(
evmasm::AssemblyItem::computeSourceMapping(
creationAssembly->items(),
2021-06-29 12:38:59 +00:00
{{m_charStream->name(), 0}}
2020-05-12 14:33:05 +00:00
)
);
MachineAssemblyObject deployedObject;
if (deployedAssembly)
{
deployedObject.bytecode = make_shared<evmasm::LinkerObject>(deployedAssembly->assemble());
deployedObject.assembly = deployedAssembly->assemblyString(m_debugInfoSelection);
deployedObject.sourceMappings = make_unique<string>(
evmasm::AssemblyItem::computeSourceMapping(
deployedAssembly->items(),
2021-06-29 12:38:59 +00:00
{{m_charStream->name(), 0}}
)
);
}
return {std::move(creationObject), std::move(deployedObject)};
}
std::pair<std::shared_ptr<evmasm::Assembly>, std::shared_ptr<evmasm::Assembly>>
YulStack::assembleEVMWithDeployed(optional<string_view> _deployName) const
{
yulAssert(m_analysisSuccessful, "");
yulAssert(m_parserResult, "");
yulAssert(m_parserResult->code, "");
yulAssert(m_parserResult->analysisInfo, "");
evmasm::Assembly assembly(true, {});
EthAssemblyAdapter adapter(assembly);
compileEVM(adapter, m_optimiserSettings.optimizeStackAllocation);
2020-10-29 16:44:26 +00:00
assembly.optimise(translateOptimiserSettings(m_optimiserSettings, m_evmVersion));
optional<size_t> subIndex;
// Pick matching assembly if name was given
if (_deployName.has_value())
{
for (size_t i = 0; i < assembly.numSubs(); i++)
if (assembly.sub(i).name() == _deployName)
{
subIndex = i;
break;
}
solAssert(subIndex.has_value(), "Failed to find object to be deployed.");
}
// Otherwise use heuristic: If there is a single sub-assembly, this is likely the object to be deployed.
else if (assembly.numSubs() == 1)
subIndex = 0;
if (subIndex.has_value())
2020-05-12 14:33:05 +00:00
{
evmasm::Assembly& runtimeAssembly = assembly.sub(*subIndex);
return {make_shared<evmasm::Assembly>(assembly), make_shared<evmasm::Assembly>(runtimeAssembly)};
2020-05-12 14:33:05 +00:00
}
return {make_shared<evmasm::Assembly>(assembly), {}};
2020-05-12 14:33:05 +00:00
}
string YulStack::print(
CharStreamProvider const* _soliditySourceProvider
) const
{
yulAssert(m_parserResult, "");
yulAssert(m_parserResult->code, "");
return m_parserResult->toString(&languageToDialect(m_language, m_evmVersion), m_debugInfoSelection, _soliditySourceProvider) + "\n";
}
2019-02-13 11:21:53 +00:00
shared_ptr<Object> YulStack::parserResult() const
2019-02-13 11:21:53 +00:00
{
yulAssert(m_analysisSuccessful, "Analysis was not successful.");
yulAssert(m_parserResult, "");
yulAssert(m_parserResult->code, "");
2019-02-13 11:21:53 +00:00
return m_parserResult;
}