golang: Show escape analysis results in VS Code sources (visualising escape analysis output)

[maxim-ge]

Motivation

Have a greate command:

go build -gcflags "-m=3"

It has output like:

.\types.go:619:6: cannot inline (*rowType).HasValue: function too complex: cost 179 exceeds budget 80
.\types.go:635:39: inlining call to appdef.DefKind.HasSystemField
.\types.go:637:25: inlining call to dynobuffers.(*Buffer).HasValue
.\validation-errors.go:45:6: can inline validateError with cost 75 as: func(int, error) ValidateError { e := validateErrorType{...}; return e }
.\validation-errors.go:53:6: cannot inline validateErrorf: function too complex: cost 140 exceeds budget 80
.\validation-errors.go:54:22: inlining call to validateError
.\validation.go:397:6: cannot inline (*validators).validPKey: function too complex: cost 318 exceeds budget 80

Want the output to be mapped to the sources in the VS Code editor

Functional Design

Configure Tasks

• Open User Tasks: F1 -> Tasks:Open User Tasks
  • dropdown list appears (in case if no tasks yet) -> choose Others
• Paste tasks code
• Windows
  • To run commands like xargs, sed, grep add to PATH, if needed: C:\Program Files\Git\usr\bin
  • Set Git Bash as a default terminal profile: F1 -> Terminal: Select Default Profile

Configure graphiz

• https://graphviz.org/download/
  • Windows: choco install graphviz

See escapes as problems

F1 -> Tasks: Run task -> Go: Escape analysis, leaking + escapes

Result


Get details for the current file + line

F1 -> Tasks: Run tasks -> Go: Escape analysis, detailed, for current file and line

Result


Cleanup PROBLEMS window

F1 -> Developer: Reload Window

Profile benchmarks

• Move the cursor over the line where the benchmark starts
• F1 -> Tasks: Run tasks -> Go: Profile current benchmark (memory)
• F1 -> Tasks: Run tasks -> Go: Profile current benchmark (cpu)

References

• https://github.com/microsoft/vscode-go/issues/1948
• https://github.com/Microsoft/vscode/issues/50448
• Making Global Tasks in VS Code
• VS Code Variables Reference
• Analyzing Go Heap Escapes (does not work)