-
Notifications
You must be signed in to change notification settings - Fork 5.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[test] Add support to run yul optimizer assembly test. #15009
Open
aarlt
wants to merge
1
commit into
develop
Choose a base branch
from
add_yul_optimizer_assembly_test
base: develop
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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,105 @@ | ||
/* | ||
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/libyul/Common.h> | ||
#include <test/Common.h> | ||
|
||
#include <libyul/Object.h> | ||
#include <libyul/AsmPrinter.h> | ||
|
||
#include <liblangutil/SourceReferenceFormatter.h> | ||
#include <liblangutil/Scanner.h> | ||
|
||
#include <libsolutil/AnsiColorized.h> | ||
#include <libsolutil/CommonIO.h> | ||
|
||
#include <libyul/YulStack.h> | ||
#include <libyul/AsmAnalysis.h> | ||
#include <libyul/AsmAnalysisInfo.h> | ||
#include <libyul/backends/evm/EVMDialect.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(); | ||
m_expectation = m_reader.simpleExpectations(); | ||
} | ||
|
||
TestCase::TestResult YulOptimizerAssemblyTest::run(std::ostream& _stream, std::string const& _linePrefix, bool const _formatted) | ||
{ | ||
std::shared_ptr<Object> object; | ||
std::shared_ptr<AsmAnalysisInfo> analysisInfo; | ||
|
||
Dialect const& dialect = test::dialect("evm", solidity::test::CommonOptions::get().evmVersion()); | ||
std::tie(object, analysisInfo) = test::parse(_stream, _linePrefix, _formatted, m_source, dialect); | ||
if (!object) | ||
return TestResult::FatalError; | ||
|
||
object->analysisInfo = analysisInfo; | ||
YulOptimizerTestCommon tester(object, 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 = (object->subObjects.empty() ? AsmPrinter{ dialect }(*object->code) : object->toString(&dialect)); | ||
|
||
m_obtainedResult = "step: " + m_optimizerStep + "\n\n" + printed + "\n"; | ||
|
||
*object->analysisInfo = AsmAnalyzer::analyzeStrictAssertCorrect(dialect, *object); | ||
|
||
evmasm::Assembly assembly{solidity::test::CommonOptions::get().evmVersion(), false, {}}; | ||
EthAssemblyAdapter adapter(assembly); | ||
EVMObjectCompiler::compile( | ||
*object, | ||
adapter, | ||
EVMDialect::strictAssemblyForEVMObjects(solidity::test::CommonOptions::get().evmVersion()), | ||
false, // optimize - don't run any other optimization | ||
solidity::test::CommonOptions::get().eofVersion() | ||
); | ||
|
||
m_obtainedResult += "\nAssembly:\n" + toString(assembly); | ||
|
||
return checkResult(_stream, _linePrefix, _formatted); | ||
} |
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,54 @@ | ||
/* | ||
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::string m_optimizerStep; | ||
}; | ||
|
||
} |
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
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 | ||
// /* "":114:117 */ | ||
// dup2 | ||
// /* "":108:118 */ | ||
// mload | ||
// /* "":101:118 */ | ||
// swap2 | ||
// pop | ||
// /* "":147:161 */ | ||
// calldatasize | ||
// /* "":142:145 */ | ||
// dup3 | ||
// /* "":138:162 */ | ||
// add | ||
// /* "":131:162 */ | ||
// swap1 | ||
// pop | ||
// /* "":196:197 */ | ||
// 0x02 | ||
// /* "":190:198 */ | ||
// mload | ||
// /* "":6:204 */ | ||
// 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, if the new test is meant for inspecting the debug data, then it would be useful to actually have some debug annotations in the sample test to see if it's even preserved in the output.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now it is only meant to print the assembly in this PR. The printing of the debug data is so far done in #14969 - but I guess some changes are still needed there.