Adds a dev guide section on Rust Coverage

rust-lang · Dec 7, 2020 · 30da3ed · 30da3ed
1 parent af2aa99
commit 30da3ed
Show file tree

Hide file tree

Showing 7 changed files with 635 additions and 1 deletion.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -147,6 +147,7 @@
     - [Backend Agnostic Codegen](./backend/backend-agnostic.md)
     - [Implicit Caller Location](./backend/implicit-caller-location.md)
 - [Profile-guided Optimization](./profile-guided-optimization.md)
+- [LLVM Source-Based Code Coverage](./llvm-coverage-instrumentation.md)
 - [Sanitizers Support](./sanitizers.md)
 - [Debugging Support in the Rust Compiler](./debugging-support-in-rustc.md)
 

diff --git a/src/img/coverage-branch-counting-01.png b/src/img/coverage-branch-counting-01.png
diff --git a/src/img/coverage-graphviz-01.png b/src/img/coverage-graphviz-01.png
diff --git a/src/img/coverage-spanview-01.png b/src/img/coverage-spanview-01.png
diff --git a/src/img/llvm-cov-show-01.png b/src/img/llvm-cov-show-01.png
diff --git a/src/llvm-coverage-instrumentation.md b/src/llvm-coverage-instrumentation.md
diff --git a/src/profile-guided-optimization.md b/src/profile-guided-optimization.md
@@ -29,7 +29,8 @@ LLVM actually [supports multiple forms][clang-pgo] of PGO:
 - GCOV-based profiling, where code coverage infrastructure is used to collect
   profiling information.
 - Front-end based instrumentation, where the compiler front-end (e.g. Clang)
-  inserts instrumentation intrinsics into the LLVM IR it generates.
+  inserts instrumentation intrinsics into the LLVM IR it generates (but see the
+  [^note-instrument-coverage]"Note").
 - IR-level instrumentation, where LLVM inserts the instrumentation intrinsics
   itself during optimization passes.
 
@@ -44,6 +45,11 @@ optimized. Instrumentation-based PGO has two components: a compile-time
 component and run-time component, and one needs to understand the overall
 workflow to see how they interact.
 
+[^note-instrument-coverage]: Note: `rustc` now supports front-end-based coverage
+instrumentation, via the experimental option
+[`-Z instrument-coverage`](../llvm-coverage-instrumentation), but using these
+coverage results for PGO has not been attempted at this time.
+
 ### Overall Workflow
 
 Generating a PGO-optimized program involves the following four steps: