cerc-io/solidity
15
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #8513 from imapp-pl/yul-phaser-parsing-yul-objects

Browse Source 
[yul-phaser] Parsing Yul objects
This commit is contained in:
chriseth 2020-03-24 17:33:13 +01:00 committed by GitHub
commit 6b97f9a4b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 160 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

126
test/yulPhaser/Program.cpp
View File

@ -189,6 +189,132 @@ BOOST_AUTO_TEST_CASE(load_should_throw_InvalidProgram_if_program_cant_be_analyze
BOOST_TEST(holds_alternative<ErrorList>(Program::load(sourceStream)));
}
BOOST_AUTO_TEST_CASE(load_should_accept_yul_objects_as_input)
{
string sourceCode(
"object \"C_178\" {\n"
" code {\n"
" mstore(64, 128)\n"
" if iszero(calldatasize()) {}\n"
" revert(0, 0)\n"
" }\n"
"}\n"
);
CharStream sourceStream(sourceCode, current_test_case().p_name);
auto programOrErrors = Program::load(sourceStream);
BOOST_TEST(holds_alternative<Program>(programOrErrors));
}
BOOST_AUTO_TEST_CASE(load_should_return_errors_if_analysis_of_object_code_fails)
{
string sourceCode(
"object \"C_178\" {\n"
" code {\n"
" return(0, datasize(\"C_178_deployed\"))\n"
" }\n"
"}\n"
);
CharStream sourceStream(sourceCode, current_test_case().p_name);
auto programOrErrors = Program::load(sourceStream);
BOOST_TEST(holds_alternative<ErrorList>(programOrErrors));
}
BOOST_AUTO_TEST_CASE(load_should_return_errors_if_parsing_of_nested_object_fails)
{
string sourceCode(
"object \"C_178\" {\n"
" code {\n"
" return(0, datasize(\"C_178_deployed\"))\n"
" }\n"
" object \"duplicate_name\" {\n"
" code {\n"
" mstore(64, 128)\n"
" }\n"
" }\n"
" object \"duplicate_name\" {\n"
" code {\n"
" mstore(64, 128)\n"
" }\n"
" }\n"
"}\n"
);
CharStream sourceStream(sourceCode, current_test_case().p_name);
auto programOrErrors = Program::load(sourceStream);
BOOST_TEST(holds_alternative<ErrorList>(programOrErrors));
}
BOOST_AUTO_TEST_CASE(load_should_extract_nested_object_with_deployed_suffix_if_present)
{
string sourceCode(
"object \"C_178\" {\n"
" code {\n"
" return(0, datasize(\"C_178_deployed\"))\n"
" }\n"
" object \"C_178_deployed\" {\n"
" code {\n"
" mstore(64, 128)\n"
" if iszero(calldatasize()) {}\n"
" revert(0, 0)\n"
" }\n"
" }\n"
"}\n"
);
CharStream sourceStream(sourceCode, current_test_case().p_name);
auto programOrErrors = Program::load(sourceStream);
BOOST_TEST(holds_alternative<Program>(programOrErrors));
}
BOOST_AUTO_TEST_CASE(load_should_fall_back_to_parsing_the_whole_object_if_there_is_no_subobject_with_the_right_name)
{
string sourceCode(
"object \"C_178\" {\n"
" code {\n"
" mstore(64, 128)\n"
" }\n"
" object \"subobject\" {\n"
" code {\n"
" if iszero(calldatasize()) {}\n"
" revert(0, 0)\n"
" }\n"
" }\n"
" object \"C_177_deployed\" {\n"
" code {\n"
" if iszero(calldatasize()) {}\n"
" revert(0, 0)\n"
" }\n"
" }\n"
"}\n"
);
CharStream sourceStream(sourceCode, current_test_case().p_name);
auto programOrErrors = Program::load(sourceStream);
BOOST_TEST(holds_alternative<Program>(programOrErrors));
Block const& parentBlock = skipRedundantBlocks(get<Program>(programOrErrors).ast());
BOOST_TEST(parentBlock.statements.size() == 1);
BOOST_TEST(holds_alternative<ExpressionStatement>(parentBlock.statements[0]));
}
BOOST_AUTO_TEST_CASE(load_should_ignore_data_in_objects)
{
string sourceCode(
"object \"C_178\" {\n"
" code {\n"
" mstore(64, 128)\n"
" }\n"
" data \"C_178_deployed\" hex\"4123\"\n"
"}\n"
);
CharStream sourceStream(sourceCode, current_test_case().p_name);
auto programOrErrors = Program::load(sourceStream);
BOOST_TEST(holds_alternative<Program>(programOrErrors));
}
BOOST_AUTO_TEST_CASE(optimise)
{
string sourceCode(

40
tools/yulPhaser/Program.cpp
View File

@ -26,6 +26,7 @@
#include <libyul/AsmJsonConverter.h>
#include <libyul/AsmParser.h>
#include <libyul/AsmPrinter.h>
#include <libyul/ObjectParser.h>
#include <libyul/YulString.h>
#include <libyul/backends/evm/EVMDialect.h>
#include <libyul/optimiser/Disambiguator.h>
@ -77,7 +78,7 @@ variant<Program, ErrorList> Program::load(CharStream& _sourceCode)
// ASSUMPTION: parseSource() rewinds the stream on its own
Dialect const& dialect = EVMDialect::strictAssemblyForEVMObjects(EVMVersion{});
variant<unique_ptr<Block>, ErrorList> astOrErrors = parseSource(dialect, _sourceCode);
variant<unique_ptr<Block>, ErrorList> astOrErrors = parseObject(dialect, _sourceCode);
if (holds_alternative<ErrorList>(astOrErrors))
return get<ErrorList>(astOrErrors);
@ -121,19 +122,44 @@ string Program::toJson() const
return jsonPrettyPrint(serializedAst);
}
variant<unique_ptr<Block>, ErrorList> Program::parseSource(Dialect const& _dialect, CharStream _source)
variant<unique_ptr<Block>, ErrorList> Program::parseObject(Dialect const& _dialect, CharStream _source)
{
ErrorList errors;
ErrorReporter errorReporter(errors);
auto scanner = make_shared<Scanner>(move(_source));
Parser parser(errorReporter, _dialect);
unique_ptr<Block> ast = parser.parse(scanner, false);
if (ast == nullptr)
ObjectParser parser(errorReporter, _dialect);
shared_ptr<Object> object = parser.parse(scanner, false);
if (object == nullptr || !errorReporter.errors().empty())
// NOTE: It's possible to get errors even if the returned object is non-null.
// For example when there are errors in a nested object.
return errors;
assert(errorReporter.errors().empty());
return variant<unique_ptr<Block>, ErrorList>(move(ast));
Object* deployedObject = nullptr;
if (object->subObjects.size() > 0)
for (auto& subObject: object->subObjects)
// solc --ir produces an object with a subobject of the same name as the outer object
// but suffixed with "_deployed".
// The other object references the nested one which makes analysis fail. Below we try to
// extract just the nested one for that reason. This is just a heuristic. If there's no
// subobject with such a suffix we fall back to accepting the whole object as is.
if (subObject != nullptr && subObject->name.str() == object->name.str() + "_deployed")
{
deployedObject = dynamic_cast<Object*>(subObject.get());
if (deployedObject != nullptr)
break;
}
Object* selectedObject = (deployedObject != nullptr ? deployedObject : object.get());
// NOTE: I'm making a copy of the whole AST to get unique_ptr rather than shared_ptr.
// This is a slight performance hit but it's much less than the parsing itself.
// unique_ptr lets me be sure that two Program instances can never share the AST by mistake.
// The public API of the class does not provide access to the smart pointer so it won't be hard
// to switch to shared_ptr if the copying turns out to be an issue (though it would be better
// to refactor ObjectParser and Object to use unique_ptr instead).
auto astCopy = make_unique<Block>(get<Block>(ASTCopier{}(*selectedObject->code)));
return variant<unique_ptr<Block>, ErrorList>(move(astCopy));
}
variant<unique_ptr<AsmAnalysisInfo>, ErrorList> Program::analyzeAST(Dialect const& _dialect, Block const& _ast)

2
tools/yulPhaser/Program.h
View File

@ -94,7 +94,7 @@ private:
m_nameDispenser(_dialect, *m_ast, {})
{}
static std::variant<std::unique_ptr<yul::Block>, langutil::ErrorList> parseSource(
static std::variant<std::unique_ptr<yul::Block>, langutil::ErrorList> parseObject(
yul::Dialect const& _dialect,
langutil::CharStream _source
);