Replace Attr::SpvDebugLine with a better basic debug source location attribute.
#9
Conversation
| // HACK(eddyb) the syntaxes used are taken from VSCode, i.e.: | ||
| // https://github.com/microsoft/vscode/blob/6b924c5/src/vs/workbench/contrib/terminalContrib/links/browser/terminalLinkParsing.ts#L75-L91 | ||
| // (using the most boring syntax possible for every situation). | ||
| let is_quoted = s.ends_with('"'); | ||
| let is_range = (start_line, start_col) != (end_line, end_col); | ||
| write!( | ||
| s, | ||
| "{}{start_line}{}{start_col}", | ||
| if is_quoted { ',' } else { ':' }, | ||
| if is_quoted && is_range { '.' } else { ':' } | ||
| ) | ||
| .unwrap(); | ||
| if is_range { | ||
| s += "-"; | ||
| if start_line != end_line { | ||
| write!(s, "{end_line}.").unwrap(); | ||
| } | ||
| write!(s, "{end_col}").unwrap(); | ||
| } |
There was a problem hiding this comment.
This is the more "subjective" part of this change (based on comments in VSCode's source code, also linked in the // HACK... comment for posterity).
Since multiple syntaxes are possible for (almost) every situation, I tried to mix and match them to reduce variation or redundancy wherever possible.
There was a problem hiding this comment.
A couple of things:
- Feels like we should have a test here if we don't need to add too much plumbing? Not sure how much work that is.
- Is there any way we can use
tracingand wire it up with a provider that outputs in this format? I know rustc has its own debug/error machinery as well as tracing, so perhaps both are preferable. - Doc comments would really help us newcomers follow the code.
Feel free to ignore me, still ramping on spirt.
Sadly the only user of this right now would be Rust-GPU, and at least with the implementation I have for converting to this new encoding, none of its tests that depend on "showing the entire call chain, including inlined calls, for a Rust-GPU diagnostic", changed output.
This is for source code locations for the code being compiled, not in the host ( What this replaces is
The critical one is on |
Partially modeled on a subset of the
NonSemantic.Shader.DebugInfo.100SPIR-V extended instruction set, but more with Rust-GPU's needs in mind, this extends the existingfile:line:coldebuginfo to support both:Span)NonSemantic.Shader.DebugInfo.100in one key way: for some reason, that extension only seems to allow distinguishing call sites by line number which seems borderline incorrect (wrt DWARF)There is nothing in the
spirtlibrary itself that can create such extended debuginfo (even though in theory e.g.NonSemantic.Shader.DebugInfo.100support could do that), and instead Rust-GPU is expected to produce it by converting its own custom instructions.The Rust-GPU side of this already exists since it's part of the polaris/lodestar demo branches (IIRC this specifically happened for recursion emulation, where
FuncCallbeing outsideBlocks meant).Example from a relatively messy inlining stack:
Ideally large amounts of deduplication could be done by having a "debug context tracker" in
printthat only needs to show changes (i.e. entering/leaving a group of inlined instructions, and individual location debuginfo that could still differ between instructions), but that's not done in this PR.The status quo on the Rust-GPU side was already quite verbose, and arguably worse than this at times (or at least more "syntaxful"), so this will do for the time being.