cerc-io/solidity
16
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 #11869 from ethereum/remodelUseSrc

Browse Source 
Allow and require use-src to be repeated for each object.
This commit is contained in:
chriseth 2021-09-02 18:34:07 +02:00 committed by GitHub
commit 7f137d352a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
31 changed files with 67 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libsolidity/codegen/ir/IRGenerator.cpp
View File

@ -133,7 +133,7 @@ string IRGenerator::generate(
};
Whiskers t(R"(
/// @use-src <useSrcMap>
/// @use-src <useSrcMapCreation>
object "<CreationObject>" {
code {
<sourceLocationComment>
@ -147,6 +147,7 @@ string IRGenerator::generate(
<deploy>
<functions>
}
/// @use-src <useSrcMapDeployed>
object "<DeployedObject>" {
code {
<sourceLocationComment>
@ -177,7 +178,7 @@ string IRGenerator::generate(
", "
);
t("useSrcMap", useSrcMap);
t("useSrcMapCreation", useSrcMap);
t("sourceLocationComment", sourceLocationComment(_contract, m_context));
t("CreationObject", IRNames::creationObject(_contract));
@ -219,6 +220,7 @@ string IRGenerator::generate(
m_context.initializeInternalDispatch(move(internalDispatchMap));
// Do not register immutables to avoid assignment.
t("useSrcMapDeployed", useSrcMap);
t("DeployedObject", IRNames::deployedObject(_contract));
t("library_address", IRNames::libraryAddressImmutable());
t("dispatch", dispatchRoutine(_contract));

22
libyul/Object.cpp
View File

@ -50,38 +50,32 @@ string indent(std::string const& _input)
}
string Data::toString(Dialect const*, optional<SourceNameMap>) const
string Data::toString(Dialect const*) const
{
return "data \"" + name.str() + "\" hex\"" + util::toHex(data) + "\"";
}
string Object::toString(Dialect const* _dialect) const
{
yulAssert(code, "No code");
yulAssert(debugData, "No debug data");
string useSrcComment;
if (debugData && debugData->sourceNames)
if (debugData->sourceNames)
useSrcComment =
"/// @use-src " +
joinHumanReadable(ranges::views::transform(*debugData->sourceNames, [](auto&& _pair) {
return to_string(_pair.first) + ":" + util::escapeAndQuoteString(*_pair.second);
})) +
"\n";
return useSrcComment + toString(_dialect, debugData ? debugData->sourceNames : optional<SourceNameMap>{});
}
string Object::toString(Dialect const* _dialect, std::optional<SourceNameMap> _sourceNames) const
{
yulAssert(code, "No code");
string inner = "code " + AsmPrinter{_dialect, _sourceNames}(*code);
string inner = "code " + AsmPrinter{_dialect, debugData->sourceNames}(*code);
for (auto const& obj: subObjects)
{
if (auto const* o = dynamic_cast<Object const*>(obj.get()))
yulAssert(!o->debugData || !o->debugData->sourceNames, "");
inner += "\n" + obj->toString(_dialect, _sourceNames);
}
inner += "\n" + obj->toString(_dialect);
return "object \"" + name.str() + "\" {\n" + indent(inner) + "\n}";
return useSrcComment + "object \"" + name.str() + "\" {\n" + indent(inner) + "\n}";
}
set<YulString> Object::qualifiedDataNames() const

10
libyul/Object.h
View File

@ -49,11 +49,8 @@ struct ObjectNode
/// Name of the object.
/// Can be empty since .yul files can also just contain code, without explicitly placing it in an object.
YulString name;
protected:
virtual std::string toString(Dialect const* _dialect, std::optional<SourceNameMap> _sourceNames) const = 0;
/// Object should have access to toString
friend struct Object;
virtual std::string toString(Dialect const* _dialect) const = 0;
};
/**
@ -65,8 +62,7 @@ struct Data: public ObjectNode
bytes data;
protected:
std::string toString(Dialect const* _dialect, std::optional<SourceNameMap> _sourceNames) const override;
std::string toString(Dialect const* _dialect) const override;
};
@ -114,8 +110,6 @@ public:
/// @returns the name of the special metadata data object.
static std::string metadataName() { return ".metadata"; }
protected:
std::string toString(Dialect const* _dialect, std::optional<SourceNameMap> _sourceNames) const override;
};
}

22
libyul/ObjectParser.cpp
View File

@ -45,14 +45,15 @@ shared_ptr<Object> ObjectParser::parse(shared_ptr<Scanner> const& _scanner, bool
{
shared_ptr<Object> object;
m_scanner = _scanner;
m_sourceNameMapping = tryParseSourceNameMapping();
if (currentToken() == Token::LBrace)
{
// Special case: Code-only form.
object = make_shared<Object>();
object->name = "object"_yulstring;
object->code = parseBlock();
auto sourceNameMapping = tryParseSourceNameMapping();
object->debugData = make_shared<ObjectDebugData>(ObjectDebugData{sourceNameMapping});
object->code = parseBlock(sourceNameMapping);
if (!object->code)
return nullptr;
}
@ -60,7 +61,6 @@ shared_ptr<Object> ObjectParser::parse(shared_ptr<Scanner> const& _scanner, bool
object = parseObject();
if (!_reuseScanner)
expectToken(Token::EOS);
object->debugData = make_shared<ObjectDebugData>(ObjectDebugData{m_sourceNameMapping});
return object;
}
catch (FatalError const&)
@ -75,16 +75,20 @@ shared_ptr<Object> ObjectParser::parseObject(Object* _containingObject)
{
RecursionGuard guard(*this);
shared_ptr<Object> ret = make_shared<Object>();
auto sourceNameMapping = tryParseSourceNameMapping();
ret->debugData = make_shared<ObjectDebugData>(ObjectDebugData{sourceNameMapping});
if (currentToken() != Token::Identifier || currentLiteral() != "object")
fatalParserError(4294_error, "Expected keyword \"object\".");
advance();
shared_ptr<Object> ret = make_shared<Object>();
ret->name = parseUniqueName(_containingObject);
expectToken(Token::LBrace);
ret->code = parseCode();
ret->code = parseCode(move(sourceNameMapping));
while (currentToken() != Token::RBrace)
{
@ -103,13 +107,13 @@ shared_ptr<Object> ObjectParser::parseObject(Object* _containingObject)
return ret;
}
shared_ptr<Block> ObjectParser::parseCode()
shared_ptr<Block> ObjectParser::parseCode(optional<SourceNameMap> _sourceNames)
{
if (currentToken() != Token::Identifier || currentLiteral() != "code")
fatalParserError(4846_error, "Expected keyword \"code\".");
advance();
return parseBlock();
return parseBlock(move(_sourceNames));
}
optional<SourceNameMap> ObjectParser::tryParseSourceNameMapping() const
@ -166,9 +170,9 @@ optional<SourceNameMap> ObjectParser::tryParseSourceNameMapping() const
return nullopt;
}
shared_ptr<Block> ObjectParser::parseBlock()
shared_ptr<Block> ObjectParser::parseBlock(optional<SourceNameMap> _sourceNames)
{
Parser parser(m_errorReporter, m_dialect, m_sourceNameMapping);
Parser parser(m_errorReporter, m_dialect, move(_sourceNames));
shared_ptr<Block> block = parser.parseInline(m_scanner);
yulAssert(block || m_errorReporter.hasErrors(), "Invalid block but no error!");
return block;

8
libyul/ObjectParser.h
View File

@ -55,13 +55,11 @@ public:
/// @returns an empty shared pointer on error.
std::shared_ptr<Object> parse(std::shared_ptr<langutil::Scanner> const& _scanner, bool _reuseScanner);
std::optional<SourceNameMap> const& sourceNameMapping() const noexcept { return m_sourceNameMapping; }
private:
std::optional<SourceNameMap> tryParseSourceNameMapping() const;
std::shared_ptr<Object> parseObject(Object* _containingObject = nullptr);
std::shared_ptr<Block> parseCode();
std::shared_ptr<Block> parseBlock();
std::shared_ptr<Block> parseCode(std::optional<SourceNameMap> _sourceNames);
std::shared_ptr<Block> parseBlock(std::optional<SourceNameMap> _sourceNames);
void parseData(Object& _containingObject);
/// Tries to parse a name that is non-empty and unique inside the containing object.
@ -69,8 +67,6 @@ private:
void addNamedSubObject(Object& _container, YulString _name, std::shared_ptr<ObjectNode> _subObject);
Dialect const& m_dialect;
std::optional<SourceNameMap> m_sourceNameMapping;
};
}

1
libyul/backends/wasm/EVMToEwasmTranslator.cpp
View File

@ -93,6 +93,7 @@ Object EVMToEwasmTranslator::run(Object const& _object)
Object ret;
ret.name = _object.name;
ret.code = make_shared<Block>(move(ast));
ret.debugData = _object.debugData;
ret.analysisInfo = make_shared<AsmAnalysisInfo>();
ErrorList errors;

1
test/cmdlineTests/constant_optimizer_yul/output
View File

@ -21,6 +21,7 @@ object "C_12" {
return(128, _1)
}
}
/// @use-src 0:"constant_optimizer_yul/input.sol", 1:"#utility.yul"
object "C_12_deployed" {
code {
{

1
test/cmdlineTests/exp_base_literal/output
View File

@ -38,6 +38,7 @@ object "C_81" {
}
}
/// @use-src 0:"exp_base_literal/input.sol", 1:"#utility.yul"
object "C_81_deployed" {
code {
/// @src 0:82:370

2
test/cmdlineTests/ir_compiler_inheritance_nosubobjects/output
View File

@ -18,6 +18,7 @@ object "C_7" {
return(128, _1)
}
}
/// @use-src 0:"ir_compiler_inheritance_nosubobjects/input.sol", 1:"#utility.yul"
object "C_7_deployed" {
code {
{
@ -50,6 +51,7 @@ object "D_10" {
return(128, _1)
}
}
/// @use-src 0:"ir_compiler_inheritance_nosubobjects/input.sol", 1:"#utility.yul"
object "D_10_deployed" {
code {
{

4
test/cmdlineTests/ir_compiler_subobjects/output
View File

@ -18,6 +18,7 @@ object "C_3" {
return(128, _1)
}
}
/// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"
object "C_3_deployed" {
code {
{
@ -50,6 +51,7 @@ object "D_16" {
return(128, _1)
}
}
/// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"
object "D_16_deployed" {
code {
{
@ -88,6 +90,7 @@ object "D_16" {
revert(0, 0)
}
}
/// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"
object "C_3" {
code {
{
@ -99,6 +102,7 @@ object "D_16" {
return(128, _1)
}
}
/// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"
object "C_3_deployed" {
code {
{

1
test/cmdlineTests/ir_with_assembly_no_memoryguard_creation/output
View File

@ -18,6 +18,7 @@ object "D_12" {
return(128, _1)
}
}
/// @use-src 0:"ir_with_assembly_no_memoryguard_creation/input.sol", 1:"#utility.yul"
object "D_12_deployed" {
code {
{

1
test/cmdlineTests/ir_with_assembly_no_memoryguard_runtime/output
View File

@ -18,6 +18,7 @@ object "D_8" {
return(128, _1)
}
}
/// @use-src 0:"ir_with_assembly_no_memoryguard_runtime/input.sol", 1:"#utility.yul"
object "D_8_deployed" {
code {
{

1
test/cmdlineTests/keccak_optimization_deploy_code/output
View File

@ -22,6 +22,7 @@ object "C_12" {
return(128, _1)
}
}
/// @use-src 0:"keccak_optimization_deploy_code/input.sol", 1:"#utility.yul"
object "C_12_deployed" {
code {
{

1
test/cmdlineTests/keccak_optimization_low_runs/output
View File

@ -18,6 +18,7 @@ object "C_7" {
return(128, _1)
}
}
/// @use-src 0:"keccak_optimization_low_runs/input.sol", 1:"#utility.yul"
object "C_7_deployed" {
code {
{

1
test/cmdlineTests/name_simplifier/output
View File

@ -18,6 +18,7 @@ object "C_59" {
return(128, _1)
}
}
/// @use-src 0:"name_simplifier/input.sol", 1:"#utility.yul"
object "C_59_deployed" {
code {
{

1
test/cmdlineTests/optimizer_array_sload/output
View File

@ -18,6 +18,7 @@ object "Arraysum_34" {
return(128, _1)
}
}
/// @use-src 0:"optimizer_array_sload/input.sol", 1:"#utility.yul"
object "Arraysum_34_deployed" {
code {
{

1
test/cmdlineTests/revert_strings/output
View File

@ -53,6 +53,7 @@ object "C_15" {
}
}
/// @use-src 0:"revert_strings/input.sol", 1:"#utility.yul"
object "C_15_deployed" {
code {
/// @src 0:59:147

1
test/cmdlineTests/standard_irOptimized_requested/output.json
View File

@ -25,6 +25,7 @@ object \"C_7\" {
function revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb()
{ revert(0, 0) }
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_7_deployed\" {
code {
/// @src 0:79:121

1
test/cmdlineTests/standard_ir_requested/output.json
View File

@ -37,6 +37,7 @@ object \"C_7\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_7_deployed\" {
code {
/// @src 0:79:121

3
test/cmdlineTests/standard_viair_requested/output.json
View File

@ -37,6 +37,7 @@ object \"C_3\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_3_deployed\" {
code {
/// @src 0:79:92
@ -113,6 +114,7 @@ object \"D_16\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"D_16_deployed\" {
code {
/// @src 0:93:146
@ -244,6 +246,7 @@ object \"D_16\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_3_deployed\" {
code {
/// @src 0:79:92

1
test/cmdlineTests/viair_abicoder_v1/output
View File

@ -38,6 +38,7 @@ object "test_11" {
}
}
/// @use-src 0:"viair_abicoder_v1/input.sol", 1:"#utility.yul"
object "test_11_deployed" {
code {
/// @src 0:79:169

4
test/cmdlineTests/viair_subobjects/output
View File

@ -24,6 +24,7 @@ object "C_3" {
return(128, _1)
}
}
/// @use-src 0:"viair_subobjects/input.sol", 1:"#utility.yul"
object "C_3_deployed" {
code {
{
@ -62,6 +63,7 @@ object "D_16" {
return(128, _1)
}
}
/// @use-src 0:"viair_subobjects/input.sol", 1:"#utility.yul"
object "D_16_deployed" {
code {
{
@ -100,6 +102,7 @@ object "D_16" {
revert(0, 0)
}
}
/// @use-src 0:"viair_subobjects/input.sol", 1:"#utility.yul"
object "C_3" {
code {
{
@ -111,6 +114,7 @@ object "D_16" {
return(128, _1)
}
}
/// @use-src 0:"viair_subobjects/input.sol", 1:"#utility.yul"
object "C_3_deployed" {
code {
{

1
test/cmdlineTests/yul_optimizer_steps/output
View File

@ -25,6 +25,7 @@ object "C_7" {
function revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb()
{ revert(0, 0) }
}
/// @use-src 0:"yul_optimizer_steps/input.sol", 1:"#utility.yul"
object "C_7_deployed" {
code {
{

2
test/cmdlineTests/yul_source_locations/output.json
View File

@ -156,6 +156,7 @@ object \"C_54\" {
}
}
/// @use-src 0:\"C\", 1:\"D\", 2:\"#utility.yul\"
object \"C_54_deployed\" {
code {
/// @src 0:79:428
@ -780,6 +781,7 @@ object \"D_72\" {
}
}
/// @use-src 0:\"C\", 1:\"D\", 2:\"#utility.yul\"
object \"D_72_deployed\" {
code {
/// @src 1:91:166

1
test/cmdlineTests/yul_string_format_ascii/output.json
View File

@ -37,6 +37,7 @@ object \"C_11\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_11_deployed\" {
code {
/// @src 0:78:164

1
test/cmdlineTests/yul_string_format_ascii_bytes32/output.json
View File

@ -37,6 +37,7 @@ object \"C_11\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_11_deployed\" {
code {
/// @src 0:78:158

1
test/cmdlineTests/yul_string_format_ascii_bytes32_from_number/output.json
View File

@ -37,6 +37,7 @@ object \"C_11\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_11_deployed\" {
code {
/// @src 0:78:159

1
test/cmdlineTests/yul_string_format_ascii_long/output.json
View File

@ -37,6 +37,7 @@ object \"C_11\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_11_deployed\" {
code {
/// @src 0:78:243

1
test/cmdlineTests/yul_string_format_hex/output.json
View File

@ -37,6 +37,7 @@ object \"C_11\" {
}
}
/// @use-src 0:\"A\", 1:\"#utility.yul\"
object \"C_11_deployed\" {
code {
/// @src 0:78:159

5
test/libyul/ObjectParser.cpp
View File

@ -121,8 +121,9 @@ tuple<optional<SourceNameMap>, ErrorList> tryGetSourceLocationMapping(string _so
Dialect const& dialect = yul::EVMDialect::strictAssemblyForEVM(EVMVersion::berlin());
ObjectParser objectParser{reporter, dialect};
CharStream stream(move(source), "");
objectParser.parse(make_shared<Scanner>(stream), false);
return {objectParser.sourceNameMapping(), std::move(errors)};
auto object = objectParser.parse(make_shared<Scanner>(stream), false);
BOOST_REQUIRE(object && object->debugData);
return {object->debugData->sourceNames, std::move(errors)};
}
}

1
test/libyul/objectCompiler/sourceLocations.yul
View File

@ -10,6 +10,7 @@ object "a" {
datasize("sub")
)
}
/// @use-src 3: "abc.sol" , 2: "def.sol"
object "sub" {
code {
/// @src 2:70:72