Skip to content

Commit

Permalink
Merge pull request #1141 from Mark-Simulacrum/llvm-ir-docs
Browse files Browse the repository at this point in the history
Add documentation for LLVM IR
  • Loading branch information
Mark-Simulacrum authored Jan 10, 2022
2 parents 7940e85 + 29151c8 commit f2d9af4
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,14 @@ The mandatory `<PROFILER>` argument must be one of the following.
- **Output**. Human-readable output is written to files with an `ll` prefix.
- **Notes**. Does not work with the `Check` build kind. Also does not work
with the `IncrFull`, `IncrUnchanged`, and `IncrPatched` run kinds.
- `llvm-ir`: Dump rustc-generated LLVM IR (before any LLVM passes)
- Purpose. This command provides access to the raw LLVM IR rustc produces,
which can be used for targeted improvements to functions (e.g., those
that get monomorphized a lot) and optimization of rustc IR emission in
general.
- Slowdown. Likely runs faster than regular builds due to skipping most of
the LLVM work.
- Output. Produces `llir` prefixed files, in LLVM IR textual format.
- `mono-items`: Dump monomorphization items for each (merged) CGU in the crate.
These are also post-processed from the raw format into per-file dumps.
- **Purpose**. This is useful to investigate changes in CGU partionining.
Expand Down

0 comments on commit f2d9af4

Please sign in to comment.