Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[test] Add support to run yul optimizer assembly test.
- Loading branch information
Showing
6 changed files
with
306 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
/* | ||
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 | ||
|
||
#include <test/libyul/YulOptimizerAssemblyTest.h> | ||
#include <test/libyul/YulOptimizerTestCommon.h> | ||
|
||
#include <test/libsolidity/util/SoltestErrors.h> | ||
#include <test/libyul/Common.h> | ||
#include <test/Common.h> | ||
|
||
#include <libyul/Object.h> | ||
#include <libyul/AsmPrinter.h> | ||
|
||
#include <liblangutil/CharStreamProvider.h> | ||
#include <liblangutil/SourceReferenceFormatter.h> | ||
#include <liblangutil/Scanner.h> | ||
|
||
#include <libsolutil/AnsiColorized.h> | ||
#include <libsolutil/StringUtils.h> | ||
|
||
#include <libyul/YulStack.h> | ||
#include <libyul/backends/evm/EthAssemblyAdapter.h> | ||
#include <libyul/backends/evm/EVMObjectCompiler.h> | ||
|
||
#include <libevmasm/Assembly.h> | ||
|
||
#include <fstream> | ||
|
||
using namespace solidity; | ||
using namespace solidity::util; | ||
using namespace solidity::langutil; | ||
using namespace solidity::yul; | ||
using namespace solidity::yul::test; | ||
using namespace solidity::frontend; | ||
using namespace solidity::frontend::test; | ||
|
||
YulOptimizerAssemblyTest::YulOptimizerAssemblyTest(std::string const& _filename): | ||
EVMVersionRestrictedTestCase(_filename) | ||
{ | ||
boost::filesystem::path path(_filename); | ||
|
||
if (path.empty() || std::next(path.begin()) == path.end() || std::next(std::next(path.begin())) == path.end()) | ||
BOOST_THROW_EXCEPTION(std::runtime_error("Filename path has to contain a directory: \"" + _filename + "\".")); | ||
m_optimizerStep = std::prev(std::prev(path.end()))->string(); | ||
|
||
m_source = m_reader.source(); | ||
|
||
auto dialectName = m_reader.stringSetting("dialect", "evm"); | ||
m_dialect = &dialect(dialectName, solidity::test::CommonOptions::get().evmVersion()); | ||
|
||
m_expectation = m_reader.simpleExpectations(); | ||
} | ||
|
||
TestCase::TestResult YulOptimizerAssemblyTest::run(std::ostream& _stream, std::string const& _linePrefix, bool const _formatted) | ||
{ | ||
std::tie(m_object, m_analysisInfo) = parse(_stream, _linePrefix, _formatted, m_source); | ||
if (!m_object) | ||
return TestResult::FatalError; | ||
|
||
soltestAssert(m_dialect, "Dialect not set."); | ||
|
||
m_object->analysisInfo = m_analysisInfo; | ||
YulOptimizerTestCommon tester(m_object, *m_dialect); | ||
tester.setStep(m_optimizerStep); | ||
|
||
if (!tester.runStep()) | ||
{ | ||
AnsiColorized(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Invalid optimizer step: " << m_optimizerStep << std::endl; | ||
return TestResult::FatalError; | ||
} | ||
|
||
auto const printed = (m_object->subObjects.empty() ? AsmPrinter{ *m_dialect }(*m_object->code) : m_object->toString(m_dialect)); | ||
|
||
// Re-parse new code for compilability | ||
// TODO: support for wordSizeTransform which needs different input and output dialects | ||
if (m_optimizerStep != "wordSizeTransform" && !std::get<0>(parse(_stream, _linePrefix, _formatted, printed))) | ||
{ | ||
util::AnsiColorized(_stream, _formatted, {util::formatting::BOLD, util::formatting::CYAN}) | ||
<< _linePrefix << "Result after the optimiser:" << std::endl; | ||
printPrefixed(_stream, printed, _linePrefix + " "); | ||
return TestResult::FatalError; | ||
} | ||
|
||
m_obtainedResult = "step: " + m_optimizerStep + "\n\n" + printed + "\n"; | ||
|
||
OptimiserSettings settings = OptimiserSettings::none(); | ||
YulStack stack( | ||
EVMVersion{}, | ||
std::nullopt, | ||
YulStack::Language::StrictAssembly, | ||
settings, | ||
DebugInfoSelection::All() | ||
); | ||
if (!stack.parseAndAnalyze("", printed)) | ||
{ | ||
AnsiColorized(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Error parsing source." << std::endl; | ||
SourceReferenceFormatter{_stream, stack, true, false} | ||
.printErrorInformation(stack.errors()); | ||
return TestResult::FatalError; | ||
} | ||
|
||
evmasm::Assembly assembly{solidity::test::CommonOptions::get().evmVersion(), false, {}}; | ||
EthAssemblyAdapter adapter(assembly); | ||
EVMObjectCompiler::compile( | ||
*stack.parserResult(), | ||
adapter, | ||
EVMDialect::strictAssemblyForEVMObjects(EVMVersion{}), | ||
settings.optimizeStackAllocation, | ||
std::nullopt | ||
); | ||
|
||
std::ostringstream output; | ||
output << assembly; | ||
m_obtainedResult += "\nAssembly:\n" + output.str(); | ||
|
||
return checkResult(_stream, _linePrefix, _formatted); | ||
} | ||
|
||
std::pair<std::shared_ptr<Object>, std::shared_ptr<AsmAnalysisInfo>> YulOptimizerAssemblyTest::parse( | ||
std::ostream& _stream, | ||
std::string const& _linePrefix, | ||
bool const _formatted, | ||
std::string const& _source | ||
) | ||
{ | ||
ErrorList errors; | ||
soltestAssert(m_dialect, ""); | ||
std::shared_ptr<Object> object; | ||
std::shared_ptr<AsmAnalysisInfo> analysisInfo; | ||
std::tie(object, analysisInfo) = yul::test::parse(_source, *m_dialect, errors); | ||
if (!object || !analysisInfo || Error::containsErrors(errors)) | ||
{ | ||
AnsiColorized(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Error parsing source." << std::endl; | ||
CharStream charStream(_source, ""); | ||
SourceReferenceFormatter{_stream, SingletonCharStreamProvider(charStream), true, false} | ||
.printErrorInformation(errors); | ||
return {}; | ||
} | ||
return {std::move(object), std::move(analysisInfo)}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
/* | ||
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 | ||
|
||
#pragma once | ||
|
||
#include <test/TestCase.h> | ||
|
||
namespace solidity::langutil | ||
{ | ||
class Error; | ||
using ErrorList = std::vector<std::shared_ptr<Error const>>; | ||
} | ||
|
||
namespace solidity::yul | ||
{ | ||
struct AsmAnalysisInfo; | ||
struct Object; | ||
struct Dialect; | ||
} | ||
|
||
namespace solidity::yul::test | ||
{ | ||
|
||
class YulOptimizerAssemblyTest: public solidity::frontend::test::EVMVersionRestrictedTestCase | ||
{ | ||
public: | ||
static std::unique_ptr<TestCase> create(Config const& _config) | ||
{ | ||
return std::make_unique<YulOptimizerAssemblyTest>(_config.filename); | ||
} | ||
|
||
explicit YulOptimizerAssemblyTest(std::string const& _filename); | ||
|
||
TestResult run(std::ostream& _stream, std::string const& _linePrefix = "", bool const _formatted = false) override; | ||
private: | ||
std::pair<std::shared_ptr<Object>, std::shared_ptr<AsmAnalysisInfo>> parse( | ||
std::ostream& _stream, std::string const& _linePrefix, bool const _formatted, std::string const& _source | ||
); | ||
|
||
std::string m_optimizerStep; | ||
|
||
Dialect const* m_dialect = nullptr; | ||
|
||
std::shared_ptr<Object> m_object; | ||
std::shared_ptr<AsmAnalysisInfo> m_analysisInfo; | ||
}; | ||
|
||
} |
62 changes: 62 additions & 0 deletions
62
test/libyul/yulOptimizerAssemblyTests/blockFlattener/basic.yul
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
{ | ||
{ | ||
let _1 := mload(0) | ||
let f_a := mload(1) | ||
let f_r | ||
{ | ||
f_a := mload(f_a) | ||
f_r := add(f_a, calldatasize()) | ||
} | ||
let z := mload(2) | ||
} | ||
} | ||
// ---- | ||
// step: blockFlattener | ||
// | ||
// { | ||
// { | ||
// let _1 := mload(0) | ||
// let f_a := mload(1) | ||
// let f_r | ||
// f_a := mload(f_a) | ||
// f_r := add(f_a, calldatasize()) | ||
// let z := mload(2) | ||
// } | ||
// } | ||
// | ||
// Assembly: | ||
// /* "":32:33 */ | ||
// 0x00 | ||
// /* "":26:34 */ | ||
// mload | ||
// /* "":60:61 */ | ||
// 0x01 | ||
// /* "":54:62 */ | ||
// mload | ||
// /* "":71:78 */ | ||
// 0x00 | ||
// /* "":100:103 */ | ||
// dup2 | ||
// /* "":94:104 */ | ||
// mload | ||
// /* "":87:104 */ | ||
// swap2 | ||
// pop | ||
// /* "":129:143 */ | ||
// calldatasize | ||
// /* "":124:127 */ | ||
// dup3 | ||
// /* "":120:144 */ | ||
// add | ||
// /* "":113:144 */ | ||
// swap1 | ||
// pop | ||
// /* "":168:169 */ | ||
// 0x02 | ||
// /* "":162:170 */ | ||
// mload | ||
// /* "":6:176 */ | ||
// pop | ||
// pop | ||
// pop | ||
// pop |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters