Skip to content

[stable] Backport fix for malformed coverage #117857

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions compiler/rustc_mir_transform/src/coverage/spans.rs
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,12 @@ impl<'a, 'tcx> CoverageSpans<'a, 'tcx> {
let merged_prefix_len = self.curr_original_span.lo() - self.curr().span.lo();
let after_macro_bang =
merged_prefix_len + BytePos(visible_macro.as_str().len() as u32 + 1);
if self.curr().span.lo() + after_macro_bang > self.curr().span.hi() {
// Something is wrong with the macro name span;
// return now to avoid emitting malformed mappings.
// FIXME(#117788): Track down why this happens.
return;
}
let mut macro_name_cov = self.curr().clone();
self.curr_mut().span =
self.curr().span.with_lo(self.curr().span.lo() + after_macro_bang);
Expand Down
10 changes: 10 additions & 0 deletions tests/run-coverage/auxiliary/macro_name_span_helper.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// edition: 2021

#[macro_export]
macro_rules! macro_that_defines_a_function {
(fn $name:ident () $body:tt) => {
fn $name () -> () $body
}
}

// Non-executable comment.
39 changes: 39 additions & 0 deletions tests/run-coverage/macro_name_span.coverage
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
$DIR/auxiliary/macro_name_span_helper.rs:
LL| |// edition: 2021
LL| |
LL| |#[macro_export]
LL| |macro_rules! macro_that_defines_a_function {
LL| | (fn $name:ident () $body:tt) => {
LL| 1| fn $name () -> () $body
LL| | }
LL| |}
LL| |
LL| |// Non-executable comment.

$DIR/macro_name_span.rs:
LL| |// edition: 2021
LL| |
LL| |// Regression test for <https://github.com/rust-lang/rust/issues/117788>.
LL| |// Under some circumstances, the heuristics that detect macro name spans can
LL| |// get confused and produce incorrect spans beyond the bounds of the span
LL| |// being processed.
LL| |
LL| |// aux-build: macro_name_span_helper.rs
LL| |extern crate macro_name_span_helper;
LL| |
LL| 1|fn main() {
LL| 1| affected_function();
LL| 1|}
LL| |
LL| |macro_rules! macro_with_an_unreasonably_and_egregiously_long_name {
LL| | () => {
LL| | println!("hello");
LL| | };
LL| |}
LL| |
LL| |macro_name_span_helper::macro_that_defines_a_function! {
LL| | fn affected_function() {
LL| | macro_with_an_unreasonably_and_egregiously_long_name!();
LL| | }
LL| |}

25 changes: 25 additions & 0 deletions tests/run-coverage/macro_name_span.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// edition: 2021

// Regression test for <https://github.com/rust-lang/rust/issues/117788>.
// Under some circumstances, the heuristics that detect macro name spans can
// get confused and produce incorrect spans beyond the bounds of the span
// being processed.

// aux-build: macro_name_span_helper.rs
extern crate macro_name_span_helper;

fn main() {
affected_function();
}

macro_rules! macro_with_an_unreasonably_and_egregiously_long_name {
() => {
println!("hello");
};
}

macro_name_span_helper::macro_that_defines_a_function! {
fn affected_function() {
macro_with_an_unreasonably_and_egregiously_long_name!();
}
}