[ethdebug] Enable ethdebug debug info selection.

aarlt · aarlt · commit 71bf6552ba30 · 2024-07-23T16:08:04.000+02:00
diff --git a/liblangutil/DebugInfoSelection.cpp b/liblangutil/DebugInfoSelection.cpp
@@ -39,6 +39,7 @@ DebugInfoSelection const DebugInfoSelection::All(bool _value) noexcept
 	DebugInfoSelection result;
 	for (bool DebugInfoSelection::* member: componentMap() | ranges::views::values)
 		result.*member = _value;
+	result.ethdebug = false;
 	return result;
 }
 
diff --git a/liblangutil/DebugInfoSelection.h b/liblangutil/DebugInfoSelection.h
@@ -72,13 +72,15 @@ struct DebugInfoSelection
 			{"location", &DebugInfoSelection::location},
 			{"snippet", &DebugInfoSelection::snippet},
 			{"ast-id", &DebugInfoSelection::astID},
+			{"ethdebug", &DebugInfoSelection::ethdebug},
 		};
 		return components;
 	}
 
 	bool location = false; ///< Include source location. E.g. `@src 3:50:100`
 	bool snippet = false;  ///< Include source code snippet next to location. E.g. `@src 3:50:100 "contract C {..."`
 	bool astID = false;    ///< Include ID of the Solidity AST node. E.g. `@ast-id 15`
+	bool ethdebug = false; ///< Include ethdebug related debug information.
 };
 
 std::ostream& operator<<(std::ostream& _stream, DebugInfoSelection const& _selection);
diff --git a/libsolidity/codegen/ir/IRGenerator.cpp b/libsolidity/codegen/ir/IRGenerator.cpp
@@ -118,7 +118,7 @@ std::string IRGenerator::generate(
 		);
 	};
 
-	Whiskers t(R"(
+	Whiskers t(R"(<?isEthdebugEnabled>/// ethdebug: enabled</isEthdebugEnabled>
 		/// @use-src <useSrcMapCreation>
 		object "<CreationObject>" {
 			code {
@@ -155,6 +155,7 @@ std::string IRGenerator::generate(
 	for (VariableDeclaration const* var: ContractType(_contract).immutableVariables())
 		m_context.registerImmutableVariable(*var);
 
+	t("isEthdebugEnabled", m_context.debugInfoSelection().ethdebug);
 	t("CreationObject", IRNames::creationObject(_contract));
 	t("sourceLocationCommentCreation", dispenseLocationComment(_contract));
 	t("library", _contract.isLibrary());
diff --git a/libsolidity/interface/CompilerStack.cpp b/libsolidity/interface/CompilerStack.cpp
@@ -1486,7 +1486,8 @@ void CompilerStack::generateIR(ContractDefinition const& _contract)
 		YulStack stack = parseYul(compiledContract.yulIR);
 		compiledContract.yulIRAst = stack.astJson();
 		stack.optimize();
-		compiledContract.yulIROptimized = stack.print(this);
+		compiledContract.yulIROptimized = m_debugInfoSelection.ethdebug ? "/// ethdebug: enabled\n" : "";
+		compiledContract.yulIROptimized += stack.print(this);
 	}
 	{
 		// Optimizer does not maintain correct native source locations in the AST.
diff --git a/libsolidity/interface/StandardCompiler.cpp b/libsolidity/interface/StandardCompiler.cpp
@@ -1324,6 +1324,12 @@ Json StandardCompiler::compileSolidity(StandardCompiler::InputsAndSettings _inpu
 
 	Json errors = std::move(_inputsAndSettings.errors);
 
+	if (_inputsAndSettings.debugInfoSelection.has_value() &&
+		_inputsAndSettings.debugInfoSelection->ethdebug &&
+		!isIRRequested(_inputsAndSettings.outputSelection)
+	)
+		errors.emplace_back(formatError(Error::Type::FatalError, "general", "debug.debugInfo setting for ethdebug only valid, if 'ir', 'irAst', 'irOptimized' or 'irOptimizedAst' where requested."));
+
 	bool const binariesRequested = isBinaryRequested(_inputsAndSettings.outputSelection);
 
 	try
diff --git a/solc/CommandLineParser.cpp b/solc/CommandLineParser.cpp
@@ -637,7 +637,12 @@ General Information)").c_str(),
 			po::value<std::string>()->default_value(util::toString(DebugInfoSelection::Default())),
 			("Debug info components to be included in the produced EVM assembly and Yul code. "
 			"Value can be all, none or a comma-separated list containing one or more of the "
-			"following components: " + util::joinHumanReadable(DebugInfoSelection::componentMap() | ranges::views::keys) + ".").c_str()
+			"following components: " +
+				util::joinHumanReadable(
+					DebugInfoSelection::componentMap() | ranges::views::keys |
+						ranges::views::filter([](std::string const& key) { return key != "ethdebug"; }) |
+						ranges::to<std::vector>()
+				) + ".").c_str()
 		)
 		(
 			g_strStopAfter.c_str(),
@@ -1439,6 +1444,14 @@ void CommandLineParser::processArgs()
 		m_options.input.mode == InputMode::CompilerWithASTImport ||
 		m_options.input.mode == InputMode::EVMAssemblerJSON
 	);
+
+	if (m_options.output.debugInfoSelection.has_value() && m_options.output.debugInfoSelection->ethdebug &&
+		!(m_options.output.viaIR || m_options.compiler.outputs.ir || m_options.compiler.outputs.irOptimized)
+	)
+		solThrow(CommandLineValidationError,
+			"--debug-info ethdebug can only be used with --" + g_strViaIR + ", --" + CompilerOutputs::componentName(&CompilerOutputs::ir) +
+			" and/or --" + CompilerOutputs::componentName(&CompilerOutputs::irOptimized) + "."
+		);
 }
 
 void CommandLineParser::parseCombinedJsonOption()
diff --git a/test/cmdlineTests/debug_info_ethdebug_no_ir/args b/test/cmdlineTests/debug_info_ethdebug_no_ir/args
@@ -0,0 +1 @@
+--debug-info ethdebug
diff --git a/test/cmdlineTests/debug_info_ethdebug_no_ir/err b/test/cmdlineTests/debug_info_ethdebug_no_ir/err
@@ -0,0 +1 @@
+Error: --debug-info ethdebug can only be used with --via-ir, --ir and/or --ir-optimized.
diff --git a/test/cmdlineTests/debug_info_ethdebug_no_ir/exit b/test/cmdlineTests/debug_info_ethdebug_no_ir/exit
@@ -0,0 +1 @@
+1
diff --git a/test/cmdlineTests/debug_info_ethdebug_no_ir/input.sol b/test/cmdlineTests/debug_info_ethdebug_no_ir/input.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0
+pragma solidity >=0.0;
+
+contract C {
+    function f() public {}
+}
diff --git a/test/cmdlineTests/debug_info_in_yul_ethdebug/args b/test/cmdlineTests/debug_info_in_yul_ethdebug/args
@@ -0,0 +1 @@
+--ir --debug-info ethdebug
diff --git a/test/cmdlineTests/debug_info_in_yul_ethdebug/input.sol b/test/cmdlineTests/debug_info_in_yul_ethdebug/input.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0
+pragma solidity >=0.0;
+
+contract C {
+    function f() public {}
+}
diff --git a/test/cmdlineTests/debug_info_in_yul_ethdebug/output b/test/cmdlineTests/debug_info_in_yul_ethdebug/output
@@ -0,0 +1,112 @@
+IR:
+/// ethdebug: enabled
+/// @use-src 0:"debug_info_in_yul_ethdebug/input.sol"
+object "C_6" {
+    code {
+        /// @src 0:60:101
+        mstore(64, memoryguard(128))
+        if callvalue() { revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb() }
+
+        constructor_C_6()
+
+        let _1 := allocate_unbounded()
+        codecopy(_1, dataoffset("C_6_deployed"), datasize("C_6_deployed"))
+
+        return(_1, datasize("C_6_deployed"))
+
+        function allocate_unbounded() -> memPtr {
+            memPtr := mload(64)
+        }
+
+        function revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb() {
+            revert(0, 0)
+        }
+
+        /// @src 0:60:101
+        function constructor_C_6() {
+
+            /// @src 0:60:101
+
+        }
+        /// @src 0:60:101
+
+    }
+    /// @use-src 0:"debug_info_in_yul_ethdebug/input.sol"
+    object "C_6_deployed" {
+        code {
+            /// @src 0:60:101
+            mstore(64, memoryguard(128))
+
+            if iszero(lt(calldatasize(), 4))
+            {
+                let selector := shift_right_224_unsigned(calldataload(0))
+                switch selector
+
+                case 0x26121ff0
+                {
+                    // f()
+
+                    external_fun_f_5()
+                }
+
+                default {}
+            }
+
+            revert_error_42b3090547df1d2001c96683413b8cf91c1b902ef5e3cb8d9f6f304cf7446f74()
+
+            function shift_right_224_unsigned(value) -> newValue {
+                newValue :=
+
+                shr(224, value)
+
+            }
+
+            function allocate_unbounded() -> memPtr {
+                memPtr := mload(64)
+            }
+
+            function revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb() {
+                revert(0, 0)
+            }
+
+            function revert_error_dbdddcbe895c83990c08b3492a0e83918d802a52331272ac6fdb6a7c4aea3b1b() {
+                revert(0, 0)
+            }
+
+            function abi_decode_tuple_(headStart, dataEnd)   {
+                if slt(sub(dataEnd, headStart), 0) { revert_error_dbdddcbe895c83990c08b3492a0e83918d802a52331272ac6fdb6a7c4aea3b1b() }
+
+            }
+
+            function abi_encode_tuple__to__fromStack(headStart ) -> tail {
+                tail := add(headStart, 0)
+
+            }
+
+            function external_fun_f_5() {
+
+                if callvalue() { revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb() }
+                abi_decode_tuple_(4, calldatasize())
+                fun_f_5()
+                let memPos := allocate_unbounded()
+                let memEnd := abi_encode_tuple__to__fromStack(memPos  )
+                return(memPos, sub(memEnd, memPos))
+
+            }
+
+            function revert_error_42b3090547df1d2001c96683413b8cf91c1b902ef5e3cb8d9f6f304cf7446f74() {
+                revert(0, 0)
+            }
+
+            /// @src 0:77:99
+            function fun_f_5() {
+
+            }
+            /// @src 0:60:101
+
+        }
+
+        data ".metadata" hex"<BYTECODE REMOVED>"
+    }
+
+}
diff --git a/test/cmdlineTests/debug_info_in_yul_ethdebug_optimized/args b/test/cmdlineTests/debug_info_in_yul_ethdebug_optimized/args
@@ -0,0 +1 @@
+--ir-optimized --optimize --debug-info ethdebug
diff --git a/test/cmdlineTests/debug_info_in_yul_ethdebug_optimized/input.sol b/test/cmdlineTests/debug_info_in_yul_ethdebug_optimized/input.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0
+pragma solidity >=0.0;
+
+contract C {
+    function f() public {}
+}
diff --git a/test/cmdlineTests/debug_info_in_yul_ethdebug_optimized/output b/test/cmdlineTests/debug_info_in_yul_ethdebug_optimized/output
@@ -0,0 +1,35 @@
+Optimized IR:
+/// ethdebug: enabled
+/// @use-src 0:"debug_info_in_yul_ethdebug_optimized/input.sol"
+object "C_6" {
+    code {
+        {
+            /// @src 0:60:101
+            let _1 := memoryguard(0x80)
+            mstore(64, _1)
+            if callvalue() { revert(0, 0) }
+            let _2 := datasize("C_6_deployed")
+            codecopy(_1, dataoffset("C_6_deployed"), _2)
+            return(_1, _2)
+        }
+    }
+    /// @use-src 0:"debug_info_in_yul_ethdebug_optimized/input.sol"
+    object "C_6_deployed" {
+        code {
+            {
+                /// @src 0:60:101
+                if iszero(lt(calldatasize(), 4))
+                {
+                    if eq(0x26121ff0, shr(224, calldataload(0)))
+                    {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 0) { revert(0, 0) }
+                        return(0, 0)
+                    }
+                }
+                revert(0, 0)
+            }
+        }
+        data ".metadata" hex"<BYTECODE REMOVED>"
+    }
+}
diff --git a/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/args b/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/args
@@ -0,0 +1 @@
+--allow-paths .
diff --git a/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/in.sol b/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/in.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0
+pragma solidity >=0.0;
+
+contract C {
+    function f() public {}
+}
diff --git a/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/input.json b/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/input.json
@@ -0,0 +1,12 @@
+{
+	"language": "Solidity",
+	"sources": {
+		"C": {"urls": ["standard_debug_info_in_yul_ethdebug_optimized/in.sol"]}
+	},
+	"settings": {
+		"debug": {"debugInfo": ["ethdebug"]},
+		"outputSelection": {
+			"*": {"*": ["asm"]}
+		}
+	}
+}
diff --git a/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/output.json b/test/cmdlineTests/standard_debug_info_ethdebug_no_ir/output.json
@@ -0,0 +1,16 @@
+{
+    "errors": [
+        {
+            "component": "general",
+            "formattedMessage": "debug.debugInfo setting for ethdebug only valid, if 'ir', 'irAst', 'irOptimized' or 'irOptimizedAst' where requested.",
+            "message": "debug.debugInfo setting for ethdebug only valid, if 'ir', 'irAst', 'irOptimized' or 'irOptimizedAst' where requested.",
+            "severity": "error",
+            "type": "FatalError"
+        }
+    ],
+    "sources": {
+        "C": {
+            "id": 0
+        }
+    }
+}
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/args b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/args
@@ -0,0 +1 @@
+--allow-paths .
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/in.sol b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/in.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0
+pragma solidity >=0.0;
+
+contract C {
+    function f() public {}
+}
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/input.json b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/input.json
@@ -0,0 +1,13 @@
+{
+	"language": "Solidity",
+	"sources": {
+		"C": {"urls": ["standard_debug_info_in_yul_ethdebug/in.sol"]}
+	},
+	"settings": {
+		"debug": {"debugInfo": ["ethdebug"]},
+		"optimizer": {"enabled": false},
+		"outputSelection": {
+			"*": {"*": ["ir"]}
+		}
+	}
+}
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/output.json b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug/output.json
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/args b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/args
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/in.sol b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/in.sol
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/input.json b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/input.json
diff --git a/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/output.json b/test/cmdlineTests/standard_debug_info_in_yul_ethdebug_optimized/output.json

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ DebugInfoSelection const DebugInfoSelection::All(bool _value) noexcept`
`39`	`39`	`DebugInfoSelection result;`
`40`	`40`	`for (bool DebugInfoSelection::* member: componentMap() \| ranges::views::values)`
`41`	`41`	`result.*member = _value;`
	`42`	`+ result.ethdebug = false;`
`42`	`43`	`return result;`
`43`	`44`	`}`
`44`	`45`
Original file line number	Diff line number	Diff line change
`@@ -1486,7 +1486,8 @@ void CompilerStack::generateIR(ContractDefinition const& _contract)`
`1486`	`1486`	`YulStack stack = parseYul(compiledContract.yulIR);`
`1487`	`1487`	`compiledContract.yulIRAst = stack.astJson();`
`1488`	`1488`	`stack.optimize();`
`1489`		`- compiledContract.yulIROptimized = stack.print(this);`
	`1489`	`+ compiledContract.yulIROptimized = m_debugInfoSelection.ethdebug ? "/// ethdebug: enabled\n" : "";`
	`1490`	`+ compiledContract.yulIROptimized += stack.print(this);`
`1490`	`1491`	`}`
`1491`	`1492`	`{`
`1492`	`1493`	`// Optimizer does not maintain correct native source locations in the AST.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Error: --debug-info ethdebug can only be used with --via-ir, --ir and/or --ir-optimized.`