mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
302 lines
9.3 KiB
C++
302 lines
9.3 KiB
C++
/*
|
|
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
|
|
*/
|
|
|
|
|
|
#include <libyul/YulStack.h>
|
|
|
|
#include <libyul/AsmAnalysis.h>
|
|
#include <libyul/AsmAnalysisInfo.h>
|
|
#include <libyul/backends/evm/EthAssemblyAdapter.h>
|
|
#include <libyul/backends/evm/EVMCodeTransform.h>
|
|
#include <libyul/backends/evm/EVMDialect.h>
|
|
#include <libyul/backends/evm/EVMObjectCompiler.h>
|
|
#include <libyul/backends/evm/EVMMetrics.h>
|
|
#include <libyul/ObjectParser.h>
|
|
#include <libyul/optimiser/Semantics.h>
|
|
#include <libyul/optimiser/Suite.h>
|
|
#include <libevmasm/Assembly.h>
|
|
#include <liblangutil/Scanner.h>
|
|
|
|
#include <boost/algorithm/string.hpp>
|
|
|
|
#include <optional>
|
|
|
|
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:
|
|
return EVMDialect::strictAssemblyForEVMObjects(_version);
|
|
case YulStack::Language::Yul:
|
|
return EVMDialectTyped::instance(_version);
|
|
}
|
|
yulAssert(false, "");
|
|
return Dialect::yulDeprecated();
|
|
}
|
|
|
|
}
|
|
|
|
|
|
CharStream const& YulStack::charStream(std::string const& _sourceName) const
|
|
{
|
|
yulAssert(m_charStream, "");
|
|
yulAssert(m_charStream->name() == _sourceName, "");
|
|
return *m_charStream;
|
|
}
|
|
|
|
bool YulStack::parseAndAnalyze(std::string const& _sourceName, std::string const& _source)
|
|
{
|
|
m_errors.clear();
|
|
m_analysisSuccessful = false;
|
|
m_charStream = std::make_unique<CharStream>(_source, _sourceName);
|
|
std::shared_ptr<Scanner> scanner = std::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, "");
|
|
|
|
return analyzeParsed();
|
|
}
|
|
|
|
void YulStack::optimize()
|
|
{
|
|
yulAssert(m_analysisSuccessful, "Analysis was not successful.");
|
|
yulAssert(m_parserResult);
|
|
|
|
if (
|
|
!m_optimiserSettings.runYulOptimiser &&
|
|
yul::MSizeFinder::containsMSize(languageToDialect(m_language, m_evmVersion), *m_parserResult)
|
|
)
|
|
return;
|
|
|
|
m_analysisSuccessful = false;
|
|
yulAssert(m_parserResult, "");
|
|
optimize(*m_parserResult, true);
|
|
yulAssert(analyzeParsed(), "Invalid source code after optimization.");
|
|
}
|
|
|
|
bool YulStack::analyzeParsed()
|
|
{
|
|
yulAssert(m_parserResult, "");
|
|
m_analysisSuccessful = analyzeParsed(*m_parserResult);
|
|
return m_analysisSuccessful;
|
|
}
|
|
|
|
bool YulStack::analyzeParsed(Object& _object)
|
|
{
|
|
yulAssert(_object.code, "");
|
|
_object.analysisInfo = std::make_shared<AsmAnalysisInfo>();
|
|
|
|
AsmAnalyzer analyzer(
|
|
*_object.analysisInfo,
|
|
m_errorReporter,
|
|
languageToDialect(m_language, m_evmVersion),
|
|
{},
|
|
_object.qualifiedDataNames()
|
|
);
|
|
bool success = analyzer.analyze(*_object.code);
|
|
for (auto& subNode: _object.subObjects)
|
|
if (auto subObject = dynamic_cast<Object*>(subNode.get()))
|
|
if (!analyzeParsed(*subObject))
|
|
success = false;
|
|
return success;
|
|
}
|
|
|
|
void YulStack::compileEVM(AbstractAssembly& _assembly, bool _optimize) const
|
|
{
|
|
EVMDialect const* dialect = nullptr;
|
|
switch (m_language)
|
|
{
|
|
case Language::Assembly:
|
|
case Language::StrictAssembly:
|
|
dialect = &EVMDialect::strictAssemblyForEVMObjects(m_evmVersion);
|
|
break;
|
|
case Language::Yul:
|
|
dialect = &EVMDialectTyped::instance(m_evmVersion);
|
|
break;
|
|
default:
|
|
yulAssert(false, "Invalid language.");
|
|
break;
|
|
}
|
|
|
|
EVMObjectCompiler::compile(*m_parserResult, _assembly, *dialect, _optimize, m_eofVersion);
|
|
}
|
|
|
|
void YulStack::optimize(Object& _object, bool _isCreation)
|
|
{
|
|
yulAssert(_object.code, "");
|
|
yulAssert(_object.analysisInfo, "");
|
|
for (auto& subNode: _object.subObjects)
|
|
if (auto subObject = dynamic_cast<Object*>(subNode.get()))
|
|
{
|
|
bool isCreation = !boost::ends_with(subObject->name.str(), "_deployed");
|
|
optimize(*subObject, isCreation);
|
|
}
|
|
|
|
Dialect const& dialect = languageToDialect(m_language, m_evmVersion);
|
|
std::unique_ptr<GasMeter> meter;
|
|
if (EVMDialect const* evmDialect = dynamic_cast<EVMDialect const*>(&dialect))
|
|
meter = std::make_unique<GasMeter>(*evmDialect, _isCreation, m_optimiserSettings.expectedExecutionsPerDeployment);
|
|
|
|
OptimiserSuite::run(
|
|
dialect,
|
|
meter.get(),
|
|
_object,
|
|
// Defaults are the minimum necessary to avoid running into "Stack too deep" constantly.
|
|
m_optimiserSettings.runYulOptimiser ? m_optimiserSettings.optimizeStackAllocation : true,
|
|
m_optimiserSettings.runYulOptimiser ? m_optimiserSettings.yulOptimiserSteps : "u",
|
|
m_optimiserSettings.runYulOptimiser ? m_optimiserSettings.yulOptimiserCleanupSteps : "",
|
|
_isCreation ? std::nullopt : std::make_optional(m_optimiserSettings.expectedExecutionsPerDeployment),
|
|
{}
|
|
);
|
|
}
|
|
|
|
MachineAssemblyObject YulStack::assemble(Machine _machine) const
|
|
{
|
|
yulAssert(m_analysisSuccessful, "");
|
|
yulAssert(m_parserResult, "");
|
|
yulAssert(m_parserResult->code, "");
|
|
yulAssert(m_parserResult->analysisInfo, "");
|
|
|
|
switch (_machine)
|
|
{
|
|
case Machine::EVM:
|
|
return assembleWithDeployed().first;
|
|
}
|
|
// unreachable
|
|
return MachineAssemblyObject();
|
|
}
|
|
|
|
std::pair<MachineAssemblyObject, MachineAssemblyObject>
|
|
YulStack::assembleWithDeployed(std::optional<std::string_view> _deployName) const
|
|
{
|
|
auto [creationAssembly, deployedAssembly] = assembleEVMWithDeployed(_deployName);
|
|
yulAssert(creationAssembly, "");
|
|
yulAssert(m_charStream, "");
|
|
|
|
MachineAssemblyObject creationObject;
|
|
creationObject.bytecode = std::make_shared<evmasm::LinkerObject>(creationAssembly->assemble());
|
|
yulAssert(creationObject.bytecode->immutableReferences.empty(), "Leftover immutables.");
|
|
creationObject.assembly = creationAssembly->assemblyString(m_debugInfoSelection);
|
|
creationObject.sourceMappings = std::make_unique<std::string>(
|
|
evmasm::AssemblyItem::computeSourceMapping(
|
|
creationAssembly->items(),
|
|
{{m_charStream->name(), 0}}
|
|
)
|
|
);
|
|
|
|
MachineAssemblyObject deployedObject;
|
|
if (deployedAssembly)
|
|
{
|
|
deployedObject.bytecode = std::make_shared<evmasm::LinkerObject>(deployedAssembly->assemble());
|
|
deployedObject.assembly = deployedAssembly->assemblyString(m_debugInfoSelection);
|
|
deployedObject.sourceMappings = std::make_unique<std::string>(
|
|
evmasm::AssemblyItem::computeSourceMapping(
|
|
deployedAssembly->items(),
|
|
{{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(std::optional<std::string_view> _deployName) const
|
|
{
|
|
yulAssert(m_analysisSuccessful, "");
|
|
yulAssert(m_parserResult, "");
|
|
yulAssert(m_parserResult->code, "");
|
|
yulAssert(m_parserResult->analysisInfo, "");
|
|
|
|
evmasm::Assembly assembly(m_evmVersion, true, {});
|
|
EthAssemblyAdapter adapter(assembly);
|
|
|
|
// NOTE: We always need stack optimization when Yul optimizer is disabled (unless code contains
|
|
// msize). It being disabled just means that we don't use the full step sequence. We still run
|
|
// it with the minimal steps required to avoid "stack too deep".
|
|
bool optimize = m_optimiserSettings.optimizeStackAllocation || (
|
|
!m_optimiserSettings.runYulOptimiser &&
|
|
!yul::MSizeFinder::containsMSize(languageToDialect(m_language, m_evmVersion), *m_parserResult)
|
|
);
|
|
compileEVM(adapter, optimize);
|
|
|
|
assembly.optimise(evmasm::Assembly::OptimiserSettings::translateSettings(m_optimiserSettings, m_evmVersion));
|
|
|
|
std::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())
|
|
{
|
|
evmasm::Assembly& runtimeAssembly = assembly.sub(*subIndex);
|
|
return {std::make_shared<evmasm::Assembly>(assembly), std::make_shared<evmasm::Assembly>(runtimeAssembly)};
|
|
}
|
|
|
|
return {std::make_shared<evmasm::Assembly>(assembly), {}};
|
|
}
|
|
|
|
std::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";
|
|
}
|
|
|
|
Json::Value YulStack::astJson() const
|
|
{
|
|
yulAssert(m_parserResult, "");
|
|
yulAssert(m_parserResult->code, "");
|
|
return m_parserResult->toJson();
|
|
}
|
|
|
|
std::shared_ptr<Object> YulStack::parserResult() const
|
|
{
|
|
yulAssert(m_analysisSuccessful, "Analysis was not successful.");
|
|
yulAssert(m_parserResult, "");
|
|
yulAssert(m_parserResult->code, "");
|
|
return m_parserResult;
|
|
}
|