Compiler source info into DebugInfo
#1235
Conversation
shargon
changed the title
DebugInfo
src/Neo.Compiler.CSharp/CompilationEngine/CompilationContext.cs
Outdated
Show resolved
Hide resolved
|
And there is a problem that, after optimization, a single Instruction may come from multiple different lines of contract source codes, and seq v2 using key-value is unable to represent them. Yet this will not be a problem for my debuggers or optimizers. |
I will change it to an array |
Hey, how about NEP-19? We have a number of compilers and we can't do these changes that easy. And I'm still not sure what's the real problem we're trying to solve, looks like this data is purely an internal compiler thing. I'd not expect it to be a part of the debug info since the details of codegenerator are not really relevant there and compiler should be debugged in some other way. It can be a separate info file if really needed, but debug info is expected to be NEP-19-compliant unless we have any real reasons to change that standard. |
Is full compatible with previous version, just more information inside the json for easily trace the compiler |
|
Yeah, it's an extension, but every tool that expects a proper NEP-19 document can fail with it. Every developer that see it has to guess what this all is about (NEP-19 things are documented). To me it's either we have and follow some standards or not. |
If you strictly follow NEP 17, couldn't you add other methods beyond the standard? |
src/Neo.Compiler.CSharp/CompilationEngine/CompilationContext.cs
Outdated
Show resolved
Hide resolved
| /// Script: DAtUb2tlblN5bWJvbEA= | ||
| /// 00 : OpCode.PUSHDATA1 546F6B656E53796D626F6C [8 datoshi] | ||
| /// 0D : OpCode.RET [0 datoshi] | ||
| /// </remarks> | ||
| [DisplayName("symbol")] | ||
| public abstract string? Symbol(); |
There was a problem hiding this comment.
This was fixed with the Abi export
There was a problem hiding this comment.
We can't relate the DebugInfo to the ABI, so, this information will only work with others compilers if they attach the abi information to the NEP19 file
| // Create sequence-points-v2 | ||
|
|
||
| var v2 = new JObject(); | ||
| v2["optimization"] = CompilationOptions.OptimizationType.None.ToString().ToLowerInvariant(); |
There was a problem hiding this comment.
TODO: it will require a change in the optimization later
There was a problem hiding this comment.
Done. Value of ["optimization"] is not changed in optimization.
...ate.UnitTests/templates/neocontractnep17/TestingArtifacts/Nep17ContractTemplate.artifacts.cs
Show resolved
Hide resolved
|
#1237 ready for merge |
Alternative to #1229
Related to neo-project/proposals#184
Require #1240
This introduce a new property,
sequence-points-v2, inside the method in debugInfo:sequence-points remains as before, not changed:
{ "sequence-points": [ "20[0]12:20-12:21", "21[0]12:24-12:25", "22[0]12:20-12:25", "23[0]12:20-12:25", "25[0]12:28-12:35", "32[0]12:20-12:35", "33[0]12:20-12:35", "35[0]12:13-12:36", "37[0]13:9-13:10" ] }sequence-points-v2was included in json format, with more information:{ "sequence-points-v2": { "20": { "source": { "document": 0, "location": "12:20-12:21" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "21": { "source": { "document": 0, "location": "12:24-12:25" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "22": { "source": { "document": 0, "location": "12:20-12:25" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "23": { "source": { "document": 0, "location": "12:20-12:25" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "25": { "source": { "document": 0, "location": "12:28-12:35" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "32": { "source": { "document": 0, "location": "12:20-12:35" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "33": { "source": { "document": 0, "location": "12:20-12:35" }, "compiler": { "file": "Expression.cs", "line": 36, "method": "ConvertExpression" } }, "35": { "source": { "document": 0, "location": "12:13-12:36" }, "compiler": { "file": "ReturnStatement.cs", "line": 42, "method": "ConvertReturnStatement" } }, "37": { "source": { "document": 0, "location": "13:9-13:10" }, "compiler": { "file": "BlockStatement.cs", "line": 52, "method": "ConvertBlockStatement" } } } }Note: My bad, it was pushed to main and already reverted...