Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new CoverageKind::Branch to MIR #115061

Closed
wants to merge 16 commits into from
+3,035 −358
Closed

Add a new CoverageKind::Branch to MIR #115061

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f64372b
🍒 Add tool `src/tools/coverage-dump` for use by some new coverage tests
Zalathar Aug 11, 2023
285c05f
🍒 Also print expressions in a resolved form
Zalathar Aug 16, 2023
f07dcc0
🍒 Add test suite `coverage-map` to test coverage mappings emitted by …
Zalathar Aug 14, 2023
b251d34
🍒 Copy a selection of `run-coverage` test files into `coverage-map`
Zalathar Aug 14, 2023
f4d73b5
coverage: Make the zero counter a constant
Zalathar Aug 2, 2023
d22bfb4
coverage: Explicitly simplify coverage expressions in codegen
Zalathar Aug 14, 2023
91ff05c
coverage: Don't bother renumbering expressions on the Rust side
Zalathar Jul 23, 2023
bba6c6c
Inline functions called from `add_coverage`
Swatinem Aug 21, 2023
c9fb0d4
Avoid intermediate Vec allocations in coverage mapping creation
Swatinem Aug 21, 2023
81b59a7
Add a new `CoverageKind::Branch` to MIR
Swatinem Aug 21, 2023
4152c4d
Introduce `-C instrument-coverage=branch` to gate branch coverage
Swatinem Aug 21, 2023
ffafc9e
Output Branch Regions from Coverage Instrumentation
Swatinem Aug 22, 2023
7f985c4
Bless coverage tests
Swatinem Aug 22, 2023
5dd986b
revert manual Debug impl in coverag-dump
Swatinem Aug 23, 2023
8d4ba90
simplify expressions of branches
Swatinem Aug 23, 2023
f342569
Generalize Coverage Expression simplification
Swatinem Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions compiler/rustc_session/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,8 @@ pub enum MirSpanview {
pub enum InstrumentCoverage {
/// Default `-C instrument-coverage` or `-C instrument-coverage=statement`
All,
/// Additionally, instrument branches and output branch overage
Branch,
Comment on lines +171 to +172
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To save anyone else the trouble of checking whether this is accidentally stable (it's not):

New values of InstrumentCoverage are automatically treated as nightly-only unless they are explicitly added to the check shown below on line 2674, so Branch is correctly treated as a nightly-only value. 👍

rust/compiler/rustc_session/src/config.rs

Lines 2665 to 2685 in c6f5495

// Handle both `-Z instrument-coverage` and `-C instrument-coverage`; the latter takes
// precedence.
match (cg.instrument_coverage, unstable_opts.instrument_coverage) {
(Some(ic_c), Some(ic_z)) if ic_c != ic_z => {
handler.early_error(
"incompatible values passed for `-C instrument-coverage` \
and `-Z instrument-coverage`",
);
}
(Some(InstrumentCoverage::Off | InstrumentCoverage::All), _) => {}
(Some(_), _) if !unstable_opts.unstable_options => {
handler.early_error("`-C instrument-coverage=except-*` requires `-Z unstable-options`");
}
(None, None) => {}
(None, ic) => {
handler
.early_warn("`-Z instrument-coverage` is deprecated; use `-C instrument-coverage`");
cg.instrument_coverage = ic;
}
_ => {}
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I haven’t yet hooked up the option, so it doesn’t do anything right now, yet.

/// `-Zunstable-options -C instrument-coverage=except-unused-generics`
ExceptUnusedGenerics,
/// `-Zunstable-options -C instrument-coverage=except-unused-functions`
Expand Down
5 changes: 4 additions & 1 deletion compiler/rustc_session/src/options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ mod desc {
pub const parse_mir_spanview: &str = "`statement` (default), `terminator`, or `block`";
pub const parse_dump_mono_stats: &str = "`markdown` (default) or `json`";
pub const parse_instrument_coverage: &str =
"`all` (default), `except-unused-generics`, `except-unused-functions`, or `off`";
"`all` (default), `branch`, `except-unused-generics`, `except-unused-functions`, or `off`";
pub const parse_instrument_xray: &str = "either a boolean (`yes`, `no`, `on`, `off`, etc), or a comma separated list of settings: `always` or `never` (mutually exclusive), `ignore-loops`, `instruction-threshold=N`, `skip-entry`, `skip-exit`";
pub const parse_unpretty: &str = "`string` or `string=string`";
pub const parse_treat_err_as_bug: &str = "either no value or a number bigger than 0";
Expand Down Expand Up @@ -895,6 +895,7 @@ mod parse {

*slot = Some(match v {
"all" => InstrumentCoverage::All,
"branch" => InstrumentCoverage::Branch,
"except-unused-generics" | "except_unused_generics" => {
InstrumentCoverage::ExceptUnusedGenerics
}
Expand Down Expand Up @@ -1299,6 +1300,7 @@ options! {
reports (note, the compiler build config must include `profiler = true`); \
implies `-C symbol-mangling-version=v0`. Optional values are:
`=all` (implicit value)
`=branch`
`=except-unused-generics`
`=except-unused-functions`
`=off` (default)"),
Expand Down Expand Up @@ -1547,6 +1549,7 @@ options! {
reports (note, the compiler build config must include `profiler = true`); \
implies `-C symbol-mangling-version=v0`. Optional values are:
`=all` (implicit value)
`=branch`
`=except-unused-generics`
`=except-unused-functions`
`=off` (default)"),
Expand Down
4 changes: 4 additions & 0 deletions compiler/rustc_session/src/session.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,10 @@ impl Session {
self.opts.cg.instrument_coverage() != InstrumentCoverage::Off
}

pub fn instrument_coverage_branch(&self) -> bool {
self.opts.cg.instrument_coverage() == InstrumentCoverage::Branch
}

pub fn instrument_coverage_except_unused_generics(&self) -> bool {
self.opts.cg.instrument_coverage() == InstrumentCoverage::ExceptUnusedGenerics
}
Expand Down