Enable ethdebug debug info and output selection. by aarlt · Pull Request #15289 · argotorg/solidity

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

UPDATE 01/2025

enabling optimization with ethdebug will now create an error - it is not supported yet

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

test/cmdlineTests/standard_yul_ethdebug_bytecode/output.json

test/cmdlineTests/yul_ethdebug/input.yul

clonker

Nothing deal-breaking I think. A couple of suggestions and questions. I would be wary when/how much debug data is collected, in particular that we don't collect it by default and just don't output it in the end - that could pose a big performance drain.

libevmasm/EVMAssemblyStack.h

solc/CommandLineParser.cpp

clonker · 2025-01-07T09:08:15Z

liblangutil/DebugInfoSelection.h

 	static DebugInfoSelection const Only(bool DebugInfoSelection::* _member) noexcept;
-	static DebugInfoSelection const Default() noexcept { return All(); }
+	static DebugInfoSelection const Default() noexcept { return ExceptExperimental(); }
+	static DebugInfoSelection const Except(std::vector<bool DebugInfoSelection::*> const& _members) noexcept;


I think it is fine but I was a bit confused about the naming Except and ExceptExperimental. I would have imagined to call something like All{}.exceptExperimental(). Or, to make it more clear for ... people like me, you could name it AllExceptExperimental. Or something. Minor point in any case, feel free to ignore

libsolidity/interface/CompilerStack.cpp

libsolidity/interface/StandardCompiler.cpp

solc/CommandLineParser.cpp

clonker · 2025-01-07T11:44:23Z

test/libsolidity/StandardCompiler.cpp

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


clonker

just a few whitespaces :D
lgtm otherwise

libevmasm/EVMAssemblyStack.cpp

libsolidity/interface/StandardCompiler.cpp

solc/CommandLineParser.cpp

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

argotorg 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

argotorg 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 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

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

github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Nov 17, 2024

github-actions bot added the closed-due-inactivity label Nov 25, 2024

github-actions bot closed this Nov 25, 2024

argotorg deleted a comment from github-actions bot Dec 2, 2024

aarlt removed the stale The issue/PR was marked as stale because it has been open for too long. label Dec 2, 2024

aarlt reopened this Dec 2, 2024

aarlt removed the closed-due-inactivity label Dec 2, 2024

aarlt force-pushed the enable_debug_info_ethdebug branch from b8851f6 to 1edf1f4 Compare December 4, 2024 10:37

github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Dec 18, 2024

aarlt force-pushed the enable_debug_info_ethdebug branch from 1edf1f4 to bf1527c Compare December 18, 2024 13:28

github-actions bot removed the stale The issue/PR was marked as stale because it has been open for too long. label Dec 19, 2024

github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Jan 3, 2025

ekpyron added 🟡 PR review label and removed 🟡 PR review label stale The issue/PR was marked as stale because it has been open for too long. labels Jan 6, 2025

ekpyron requested a review from clonker January 6, 2025 14:42

clonker reviewed Jan 7, 2025

View reviewed changes

clonker reviewed Jan 9, 2025

View reviewed changes

clonker previously approved these changes Jan 9, 2025

View reviewed changes

clonker approved these changes Jan 27, 2025

View reviewed changes

aarlt added 2 commits January 27, 2025 16:35

Enable ethdebug debug info and output selection.

1832fbd

Error when ethdebug is used with optimization.

7ea985d

cameel mentioned this pull request Feb 10, 2026

Make ethdebug consistent with our existing conventions for outputs/settings #16460

Open

cameel mentioned this pull request Mar 4, 2026

Introduce experimental flag/option #16229

Merged

6 tasks

Conversation

aarlt commented Jul 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clonker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clonker Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clonker Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

clonker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

aarlt commented Jul 22, 2024 •

edited

Loading