Merge pull request #11869 from ethereum/remodelUseSrc

chriseth · web-flow · commit 7f137d352a22 · 2021-09-02T18:34:07.000+02:00
Allow and require use-src to be repeated for each object.
diff --git a/libsolidity/codegen/ir/IRGenerator.cpp b/libsolidity/codegen/ir/IRGenerator.cpp
@@ -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));
diff --git a/libyul/Object.cpp b/libyul/Object.cpp
@@ -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
diff --git a/libyul/Object.h b/libyul/Object.h
@@ -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 @@ struct Object: public ObjectNode
 
 	/// @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;
 };
 
 }
diff --git a/libyul/ObjectParser.cpp b/libyul/ObjectParser.cpp
@@ -45,22 +45,22 @@ 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;
 		}
 		else
 			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;
diff --git a/libyul/ObjectParser.h b/libyul/ObjectParser.h
@@ -55,22 +55,18 @@ class ObjectParser: public langutil::ParserBase
 	/// @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.
 	YulString parseUniqueName(Object const* _containingObject);
 	void addNamedSubObject(Object& _container, YulString _name, std::shared_ptr<ObjectNode> _subObject);
 
 	Dialect const& m_dialect;
-
-	std::optional<SourceNameMap> m_sourceNameMapping;
 };
 
 }
diff --git a/libyul/backends/wasm/EVMToEwasmTranslator.cpp b/libyul/backends/wasm/EVMToEwasmTranslator.cpp
@@ -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;
diff --git a/test/cmdlineTests/constant_optimizer_yul/output b/test/cmdlineTests/constant_optimizer_yul/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/exp_base_literal/output b/test/cmdlineTests/exp_base_literal/output
@@ -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
diff --git a/test/cmdlineTests/ir_compiler_inheritance_nosubobjects/output b/test/cmdlineTests/ir_compiler_inheritance_nosubobjects/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/ir_compiler_subobjects/output b/test/cmdlineTests/ir_compiler_subobjects/output
@@ -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 {
                     {
diff --git a/test/cmdlineTests/ir_with_assembly_no_memoryguard_creation/output b/test/cmdlineTests/ir_with_assembly_no_memoryguard_creation/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/ir_with_assembly_no_memoryguard_runtime/output b/test/cmdlineTests/ir_with_assembly_no_memoryguard_runtime/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/keccak_optimization_deploy_code/output b/test/cmdlineTests/keccak_optimization_deploy_code/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/keccak_optimization_low_runs/output b/test/cmdlineTests/keccak_optimization_low_runs/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/name_simplifier/output b/test/cmdlineTests/name_simplifier/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/optimizer_array_sload/output b/test/cmdlineTests/optimizer_array_sload/output
@@ -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 {
             {
diff --git a/test/cmdlineTests/revert_strings/output b/test/cmdlineTests/revert_strings/output
@@ -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
diff --git a/test/cmdlineTests/standard_irOptimized_requested/output.json b/test/cmdlineTests/standard_irOptimized_requested/output.json
@@ -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
diff --git a/test/cmdlineTests/standard_ir_requested/output.json b/test/cmdlineTests/standard_ir_requested/output.json
@@ -37,6 +37,7 @@ object \"C_7\" {
         }
 
     }
+    /// @use-src 0:\"A\", 1:\"#utility.yul\"
     object \"C_7_deployed\" {
         code {
             /// @src 0:79:121
diff --git a/test/cmdlineTests/standard_viair_requested/output.json b/test/cmdlineTests/standard_viair_requested/output.json
@@ -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
diff --git a/test/cmdlineTests/viair_abicoder_v1/output b/test/cmdlineTests/viair_abicoder_v1/output
@@ -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
diff --git a/test/cmdlineTests/viair_subobjects/output b/test/cmdlineTests/viair_subobjects/output
diff --git a/test/cmdlineTests/yul_optimizer_steps/output b/test/cmdlineTests/yul_optimizer_steps/output
diff --git a/test/cmdlineTests/yul_source_locations/output.json b/test/cmdlineTests/yul_source_locations/output.json
diff --git a/test/cmdlineTests/yul_string_format_ascii/output.json b/test/cmdlineTests/yul_string_format_ascii/output.json
diff --git a/test/cmdlineTests/yul_string_format_ascii_bytes32/output.json b/test/cmdlineTests/yul_string_format_ascii_bytes32/output.json
diff --git a/test/cmdlineTests/yul_string_format_ascii_bytes32_from_number/output.json b/test/cmdlineTests/yul_string_format_ascii_bytes32_from_number/output.json
diff --git a/test/cmdlineTests/yul_string_format_ascii_long/output.json b/test/cmdlineTests/yul_string_format_ascii_long/output.json
diff --git a/test/cmdlineTests/yul_string_format_hex/output.json b/test/cmdlineTests/yul_string_format_hex/output.json
diff --git a/test/libyul/ObjectParser.cpp b/test/libyul/ObjectParser.cpp
diff --git a/test/libyul/objectCompiler/sourceLocations.yul b/test/libyul/objectCompiler/sourceLocations.yul

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ object "C_12" {`
`21`	`21`	`return(128, _1)`
`22`	`22`	`}`
`23`	`23`	`}`
	`24`	`+ /// @use-src 0:"constant_optimizer_yul/input.sol", 1:"#utility.yul"`
`24`	`25`	`object "C_12_deployed" {`
`25`	`26`	`code {`
`26`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ object "C_81" {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`}`
	`41`	`+ /// @use-src 0:"exp_base_literal/input.sol", 1:"#utility.yul"`
`41`	`42`	`object "C_81_deployed" {`
`42`	`43`	`code {`
`43`	`44`	`/// @src 0:82:370`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ object "C_7" {`
`18`	`18`	`return(128, _1)`
`19`	`19`	`}`
`20`	`20`	`}`
	`21`	`+ /// @use-src 0:"ir_compiler_inheritance_nosubobjects/input.sol", 1:"#utility.yul"`
`21`	`22`	`object "C_7_deployed" {`
`22`	`23`	`code {`
`23`	`24`	`{`
`@@ -50,6 +51,7 @@ object "D_10" {`
`50`	`51`	`return(128, _1)`
`51`	`52`	`}`
`52`	`53`	`}`
	`54`	`+ /// @use-src 0:"ir_compiler_inheritance_nosubobjects/input.sol", 1:"#utility.yul"`
`53`	`55`	`object "D_10_deployed" {`
`54`	`56`	`code {`
`55`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ object "C_3" {`
`18`	`18`	`return(128, _1)`
`19`	`19`	`}`
`20`	`20`	`}`
	`21`	`+ /// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"`
`21`	`22`	`object "C_3_deployed" {`
`22`	`23`	`code {`
`23`	`24`	`{`
`@@ -50,6 +51,7 @@ object "D_16" {`
`50`	`51`	`return(128, _1)`
`51`	`52`	`}`
`52`	`53`	`}`
	`54`	`+ /// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"`
`53`	`55`	`object "D_16_deployed" {`
`54`	`56`	`code {`
`55`	`57`	`{`
`@@ -88,6 +90,7 @@ object "D_16" {`
`88`	`90`	`revert(0, 0)`
`89`	`91`	`}`
`90`	`92`	`}`
	`93`	`+ /// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"`
`91`	`94`	`object "C_3" {`
`92`	`95`	`code {`
`93`	`96`	`{`
`@@ -99,6 +102,7 @@ object "D_16" {`
`99`	`102`	`return(128, _1)`
`100`	`103`	`}`
`101`	`104`	`}`
	`105`	`+ /// @use-src 0:"ir_compiler_subobjects/input.sol", 1:"#utility.yul"`
`102`	`106`	`object "C_3_deployed" {`
`103`	`107`	`code {`
`104`	`108`	`{`