Enable ethdebug debug info and output selection. #15289

aarlt · 2024-07-22T17:17:12Z

if debug-info was set to ethdebug
- it will only work if also ir, irOptimized and/or ethdebug was selected as output.
  standard_debug_info_in_yul_ethdebug_output_ir_optimized, standard_debug_info_in_yul_ethdebug_output_no_ir
- it will always work with strict-assembly e.g. solc --strict-assembly <yul> --debug-info ethdebug
- debug-info ethdebug is excluded from the help on cli
- debug-info ethdebug is excluded from all on cli and wildcard selection * in standard-json
if ethdebug was selected as output
- if no debug-info was selected, it implicitly set debug-info to ethdebug. solc <contract> --ethdebug
- if via-ir was not specified, it will error with a message stating that ethdebug can only be selected as output, if via-ir was defined. solc <contract> --ethdebug only works with --via-ir
- if debug-info was selected and did not contain ethdebug, an error will be generated stating that ethdebug need to be set in debug-info solc <contract> --ethdebug --debug-info location
- strict-assembly will always work e.g. solc --strict-assembly <yul> --ethdebug
- output selection ethdebug is not shown in cli help
- ethdebug output selection is excluded from wildcard selection * in standard-json

UPDATE
After some discussion with @gnidan and @ekpyron it turned out that we need something slightly different:

we need to be able to distinguish ethdebug debug data from deploy-time and run-time.
standard-json: ethdebug output will now be enabled with evm.bytecode.ethdebug(deploytime part) and evm.deployedBytecode.ethdebug (runtime part)
- special case: output selection of evm.bytecodeand evm.deployedBytecodebehave like a wildcard, so the ethdebug stuff is excluded here.
cli: like binary selection --bin and --bin-runtime ethdebug selection will now work similar with --ethdebug and --ethdebug-runtime

liblangutil/DebugInfoSelection.cpp

libsolidity/codegen/ir/IRGenerator.cpp

solc/CommandLineParser.cpp

libsolidity/interface/CompilerStack.cpp

libsolidity/interface/StandardCompiler.cpp

solc/CommandLineParser.cpp

liblangutil/DebugInfoSelection.cpp

libsolidity/interface/CompilerStack.cpp

libsolidity/interface/CompilerStack.h

libsolidity/interface/StandardCompiler.cpp

libyul/YulStack.h

test/libsolidity/StandardCompiler.cpp

nikola-matic · 2024-10-08T09:12:18Z

test/libsolidity/StandardCompiler.cpp

+			[](const Json& result)
+			{
+				return result["contracts"]["fileA"]["contractA"]["evm"]["deployedBytecode"].contains("ethdebug") &&
+					result["contracts"]["fileB"]["contractB"]["evm"]["bytecode"].contains("ethdebug") ;


Suggested change

result["contracts"]["fileB"]["contractB"]["evm"]["bytecode"].contains("ethdebug") ;

result["contracts"]["fileB"]["contractB"]["evm"]["bytecode"].contains("ethdebug");

nikola-matic · 2024-10-08T09:13:17Z

libsolidity/interface/StandardCompiler.cpp

 	for (auto const& selectedArtifactJson: _outputSelection)
 	{
 		std::string const& selectedArtifact = selectedArtifactJson.get<std::string>();
 		if (
 			_artifact == selectedArtifact ||
 			boost::algorithm::starts_with(_artifact, selectedArtifact + ".")
 		)
+		{
+			if (_artifact.find("ethdebug") != std::string::npos)
+				// only accept exact matches for ethdebug, e.g. evm.bytecode.ethdebug


Do you have this covered by a test, e.g. requesting ethdebugs instead of ethdebug?

ah good point! I guess ethdebugs will be detected too ;)

ok.. this is not an issue because of the next line return selectedArtifact == _artifact;

I just noticed that the error handling of the output selection is horrible.. there are no error messages at all, if someone selects a non-existing selection option.. thats why I will also not do anything about this.. I just checked, whether evm.bytecode.ethdebugs/evm.deployedBytecode.ethdebugsis accidentally selecting ethdebug - but this is not the case

nikola-matic · 2024-10-08T09:18:41Z

libsolidity/interface/StandardCompiler.cpp

+		return false;
+
+	for (auto const& fileRequests: _outputSelection)
+		for (auto const& requests: fileRequests)


requests is just a list of contracts (wildcard included) right?

yep exactly

nikola-matic · 2024-10-08T09:28:53Z

test/libsolidity/StandardCompiler.cpp

+			std::nullopt,
+		},
+		{
+			generateStandardJson(false, Json::array({"ethdebug"}), Json::array({"ir"})),


By the way, I still think you should have one or two cmdline tests for ethdebug - one for the CLI and one for StandardJSON. These should just be happy case smoke tests. I know they're covered here, but this is significantly more difficult to read than a cmdline test :D

ah true! thanks for the reminder, I wanted to add some basic smoke tests

It was definitely worth to add those tests, because it revealed a small bug in cli parameter handling in the context of strict assembly :) also with yul in standard json the top-level ethdebug object was missing in the output

test/cmdlineTests/standard_yul_ethdebug_bytecode/output.json

test/cmdlineTests/yul_ethdebug/output

test/cmdlineTests/standard_yul_ethdebug_bytecode/output.json

test/cmdlineTests/yul_ethdebug/input.yul

aarlt commented Jul 22, 2024

View reviewed changes

liblangutil/DebugInfoSelection.cpp Outdated Show resolved Hide resolved

aarlt commented Jul 22, 2024

View reviewed changes

libsolidity/codegen/ir/IRGenerator.cpp Show resolved Hide resolved

ekpyron reviewed Jul 22, 2024

View reviewed changes

solc/CommandLineParser.cpp Outdated Show resolved Hide resolved

aarlt force-pushed the enable_debug_info_ethdebug branch 3 times, most recently from ccbe426 to 71bf655 Compare July 23, 2024 14:08

ethereum deleted a comment from stackenbotten Jul 23, 2024

aarlt mentioned this pull request Jul 23, 2024

Add output selection support for ethdebug #15293

Closed

aarlt self-assigned this Jul 23, 2024

cameel reviewed Jul 24, 2024

View reviewed changes

cameel added the ethdebug label Jul 24, 2024

cameel changed the title ~~[ethdebug] Enable ethdebug debug info selection.~~ Enable ethdebug debug info selection Jul 24, 2024

aarlt marked this pull request as draft July 24, 2024 11:14

aarlt force-pushed the enable_debug_info_ethdebug branch 5 times, most recently from ec729b3 to ee2bc12 Compare July 24, 2024 23:05

aarlt force-pushed the enable_debug_info_ethdebug branch from ee2bc12 to 9772d20 Compare August 1, 2024 18:51

aarlt changed the title ~~Enable ethdebug debug info selection~~ Enable ethdebug debug info and output selection. Aug 1, 2024

aarlt force-pushed the enable_debug_info_ethdebug branch 2 times, most recently from 09fd459 to 53e12ef Compare August 5, 2024 11:12

ethereum deleted a comment from stackenbotten Aug 6, 2024

aarlt force-pushed the enable_debug_info_ethdebug branch 4 times, most recently from 4b5c548 to a262eef Compare August 7, 2024 16:00

aarlt marked this pull request as ready for review August 7, 2024 16:00

aarlt force-pushed the enable_debug_info_ethdebug branch from a262eef to c4cb445 Compare August 12, 2024 10:30

nikola-matic self-requested a review August 12, 2024 13:30

aarlt force-pushed the enable_debug_info_ethdebug branch 4 times, most recently from fe6a4ca to 7917ca3 Compare September 30, 2024 17:50

aarlt requested a review from nikola-matic September 30, 2024 17:55

aarlt commented Sep 30, 2024

View reviewed changes

libsolidity/interface/CompilerStack.cpp Outdated Show resolved Hide resolved

aarlt commented Oct 1, 2024

View reviewed changes

libsolidity/interface/CompilerStack.h Outdated Show resolved Hide resolved

aarlt force-pushed the enable_debug_info_ethdebug branch from 7917ca3 to 13c0683 Compare October 2, 2024 09:06

aarlt commented Oct 2, 2024

View reviewed changes

libsolidity/interface/StandardCompiler.cpp Show resolved Hide resolved

aarlt commented Oct 2, 2024

View reviewed changes

libyul/YulStack.h Show resolved Hide resolved

aarlt commented Oct 2, 2024

View reviewed changes

test/libsolidity/StandardCompiler.cpp Outdated Show resolved Hide resolved

aarlt force-pushed the enable_debug_info_ethdebug branch 6 times, most recently from c4faae4 to c9417ed Compare October 8, 2024 10:32

nikola-matic reviewed Oct 8, 2024

View reviewed changes

aarlt force-pushed the enable_debug_info_ethdebug branch 4 times, most recently from 4d01075 to ada3616 Compare October 15, 2024 11:35

aarlt commented Oct 15, 2024

View reviewed changes

test/cmdlineTests/standard_yul_ethdebug_bytecode/output.json Show resolved Hide resolved

aarlt commented Oct 15, 2024

View reviewed changes

test/cmdlineTests/yul_ethdebug/output Show resolved Hide resolved

aarlt commented Oct 15, 2024

View reviewed changes

test/cmdlineTests/standard_yul_ethdebug_bytecode/output.json Outdated Show resolved Hide resolved

aarlt force-pushed the enable_debug_info_ethdebug branch from ada3616 to 6b2efa0 Compare October 16, 2024 12:18

nikola-matic reviewed Oct 23, 2024

View reviewed changes

test/cmdlineTests/yul_ethdebug/input.yul Outdated Show resolved Hide resolved

Enable ethdebug debug info and output selection.

b8851f6

aarlt force-pushed the enable_debug_info_ethdebug branch from 6b2efa0 to b8851f6 Compare October 30, 2024 14:57

aarlt requested a review from nikola-matic October 31, 2024 13:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable ethdebug debug info and output selection. #15289

Enable ethdebug debug info and output selection. #15289

aarlt commented Jul 22, 2024 •

edited

Loading

nikola-matic Oct 8, 2024

nikola-matic Oct 8, 2024

aarlt Oct 14, 2024

aarlt Oct 14, 2024

aarlt Oct 14, 2024 •

edited

Loading

nikola-matic Oct 8, 2024

aarlt Oct 14, 2024

nikola-matic Oct 8, 2024

aarlt Oct 14, 2024 •

edited

Loading

aarlt Oct 16, 2024

	result["contracts"]["fileB"]["contractB"]["evm"]["bytecode"].contains("ethdebug") ;
	result["contracts"]["fileB"]["contractB"]["evm"]["bytecode"].contains("ethdebug");

Enable ethdebug debug info and output selection. #15289

Are you sure you want to change the base?

Enable ethdebug debug info and output selection. #15289

Conversation

aarlt commented Jul 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aarlt Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aarlt Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aarlt commented Jul 22, 2024 •

edited

Loading

aarlt Oct 14, 2024 •

edited

Loading

aarlt Oct 14, 2024 •

edited

Loading