Support emitting debuginfo w.r.t. LLVM IR #56792
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
topolarity
commented
Dec 10, 2024
| @@ -567,6 +567,8 @@ static void buildCleanupPipeline(ModulePassManager &MPM, PassBuilder *PB, Optimi | |||
| MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM))); | |||
| } | |||
| } | |||
| // TODO: This should be conditionally enabled depending on the emission mode for the Execution engine | |||
| MPM.addPass(createModuleToFunctionPassAdaptor(InstructionNamerPass())); | |||
There was a problem hiding this comment.
@gbaraldi Do you know where else I need to add this pass to get complete coverage?
It also needs to be turned on / off depending on the debuginfo mode, but I think I can probably pipe that through the OptimizationOptions maybe
There was a problem hiding this comment.
It should only be here. Though yeah make it conditional on the options. Similar to #55407 and maybe an llvmpasses test. Not sure if it's super worth it but 🤷
topolarity
force-pushed
the
ct/debugir
branch
2 times, most recently
from
29679d0 to
b2bdd73
Compare
This change adds two new environmental variables:
- `JULIA_DUMP_IR` - when provided, this is a path that all emitted
LLVM IR (post-optimization, just before machine code generation)
will be saved to
- `JULIA_DEBUGINFO` - when set to "LLVM-IR" this will run an additional
pass on any emitted functions to rewrite their debuginfo to refer to
the LLVM source, rather than the Julia source it was generated from
The `debugir` pass that rewrites the debuginfo is vendored from:
https://github.com/vaivaswatha/debugir. For simplicity, this is just a
copy of the one file that we need for the pass.
Using both of these together allows `gdb` to open the dumped IR and means
you can step through LLVM IR line-by-line, print SSA values, etc. This can
be very useful for debugging segfaults, or issues in codegen.
topolarity
force-pushed
the
ct/debugir
branch
from
b2bdd73 to
59f5c1e
Compare
topolarity
changed the title
topolarity
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds two new environmental variables:
JULIA_DUMP_IR- when provided, this is a path that all emitted LLVM IR (post-optimization, just before machine code generation) will be saved toJULIA_DEBUGINFO- when set to "LLVM-IR" this will run an additional pass on any emitted functions to rewrite their debuginfo to refer to the LLVM source, rather than the Julia source it was generated fromThis allows
gdbto open the dumped IR and means you can step through LLVM IR line-by-line, print SSA values, etc. which can be very useful for debugging segfaults, or issues in codegen:The
debugirpass that rewrites the debuginfo is vendored from: https://github.com/vaivaswatha/debugir. For simplicity, this is just a copy of the one file that we need for the pass.