Skip to content

Commit 4e054fc

Browse files
scrabshascrabsha
committed
Port #[coverage] to the new attribute system
1 parent f21fbac commit 4e054fc

File tree

17 files changed

+377
-405
lines changed

17 files changed

+377
-405
lines changed

‎compiler/rustc_attr_data_structures/src/attributes.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,22 @@ pub enum DeprecatedSince {
110110
Err,
111111
}
112112

113+
#[derive(
114+
Copy,
115+
Debug,
116+
Eq,
117+
PartialEq,
118+
Encodable,
119+
Decodable,
120+
Clone,
121+
HashStable_Generic,
122+
PrintAttribute
123+
)]
124+
pub enum CoverageStatus {
125+
On,
126+
Off,
127+
}
128+
113129
impl Deprecation {
114130
/// Whether an item marked with #[deprecated(since = "X")] is currently
115131
/// deprecated (i.e., whether X is not greater than the current rustc
@@ -274,6 +290,9 @@ pub enum AttributeKind {
274290
/// Represents `#[const_trait]`.
275291
ConstTrait(Span),
276292

293+
/// Represents `#[coverage]`.
294+
Coverage(Span, CoverageStatus),
295+
277296
///Represents `#[rustc_deny_explicit_impl]`.
278297
DenyExplicitImpl(Span),
279298

‎compiler/rustc_attr_data_structures/src/encode_cross_crate.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ impl AttributeKind {
2828
ConstStability { .. } => Yes,
2929
ConstStabilityIndirect => No,
3030
ConstTrait(..) => No,
31+
Coverage(..) => No,
3132
DenyExplicitImpl(..) => No,
3233
Deprecation { .. } => Yes,
3334
DoNotImplementViaObject(..) => No,

‎compiler/rustc_attr_parsing/src/attributes/codegen_attrs.rs

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use rustc_attr_data_structures::{AttributeKind, OptimizeAttr, UsedBy};
1+
use rustc_attr_data_structures::{AttributeKind, CoverageStatus, OptimizeAttr, UsedBy};
22
use rustc_feature::{AttributeTemplate, template};
33
use rustc_session::parse::feature_err;
44
use rustc_span::{Span, Symbol, sym};
@@ -52,6 +52,45 @@ impl<S: Stage> NoArgsAttributeParser<S> for ColdParser {
5252
const CREATE: fn(Span) -> AttributeKind = AttributeKind::Cold;
5353
}
5454

55+
pub(crate) struct CoverageParser;
56+
57+
impl<S: Stage> SingleAttributeParser<S> for CoverageParser {
58+
const PATH: &[Symbol] = &[sym::coverage];
59+
const ATTRIBUTE_ORDER: AttributeOrder = AttributeOrder::KeepOutermost;
60+
const ON_DUPLICATE: OnDuplicate<S> = OnDuplicate::Error;
61+
const TEMPLATE: AttributeTemplate = template!(OneOf: &[sym::off, sym::on]);
62+
63+
fn convert(cx: &mut AcceptContext<'_, '_, S>, args: &ArgParser<'_>) -> Option<AttributeKind> {
64+
let Some(args) = args.list() else {
65+
cx.expected_specific_argument_and_list(cx.attr_span, vec!["on", "off"]);
66+
return None;
67+
};
68+
69+
let Some(arg) = args.single() else {
70+
cx.expected_single_argument(args.span);
71+
return None;
72+
};
73+
74+
let fail_incorrect_argument = |span| cx.expected_specific_argument(span, vec!["on", "off"]);
75+
76+
let Some(arg) = arg.meta_item() else {
77+
fail_incorrect_argument(args.span);
78+
return None;
79+
};
80+
81+
let status = match arg.path().word_sym() {
82+
Some(sym::off) => CoverageStatus::Off,
83+
Some(sym::on) => CoverageStatus::On,
84+
None | Some(_) => {
85+
fail_incorrect_argument(arg.span());
86+
return None;
87+
}
88+
};
89+
90+
Some(AttributeKind::Coverage(cx.attr_span, status))
91+
}
92+
}
93+
5594
pub(crate) struct ExportNameParser;
5695

5796
impl<S: Stage> SingleAttributeParser<S> for ExportNameParser {

‎compiler/rustc_attr_parsing/src/context.rs

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ use rustc_span::{DUMMY_SP, ErrorGuaranteed, Span, Symbol, sym};
1515

1616
use crate::attributes::allow_unstable::{AllowConstFnUnstableParser, AllowInternalUnstableParser};
1717
use crate::attributes::codegen_attrs::{
18-
ColdParser, ExportNameParser, NakedParser, NoMangleParser, OmitGdbPrettyPrinterSectionParser,
19-
OptimizeParser, TargetFeatureParser, TrackCallerParser, UsedParser,
18+
ColdParser, CoverageParser, ExportNameParser, NakedParser, NoMangleParser,
19+
OmitGdbPrettyPrinterSectionParser, OptimizeParser, TargetFeatureParser, TrackCallerParser,
20+
UsedParser,
2021
};
2122
use crate::attributes::confusables::ConfusablesParser;
2223
use crate::attributes::deprecation::DeprecationParser;
@@ -136,6 +137,7 @@ attribute_parsers!(
136137
// tidy-alphabetical-end
137138

138139
// tidy-alphabetical-start
140+
Single<CoverageParser>,
139141
Single<DeprecationParser>,
140142
Single<DummyParser>,
141143
Single<ExportNameParser>,
@@ -449,6 +451,25 @@ impl<'f, 'sess: 'f, S: Stage> AcceptContext<'f, 'sess, S> {
449451
reason: AttributeParseErrorReason::ExpectedSpecificArgument {
450452
possibilities,
451453
strings: false,
454+
list: false,
455+
},
456+
})
457+
}
458+
459+
pub(crate) fn expected_specific_argument_and_list(
460+
&self,
461+
span: Span,
462+
possibilities: Vec<&'static str>,
463+
) -> ErrorGuaranteed {
464+
self.emit_err(AttributeParseError {
465+
span,
466+
attr_span: self.attr_span,
467+
template: self.template.clone(),
468+
attribute: self.attr_path.clone(),
469+
reason: AttributeParseErrorReason::ExpectedSpecificArgument {
470+
possibilities,
471+
strings: false,
472+
list: true,
452473
},
453474
})
454475
}
@@ -466,6 +487,7 @@ impl<'f, 'sess: 'f, S: Stage> AcceptContext<'f, 'sess, S> {
466487
reason: AttributeParseErrorReason::ExpectedSpecificArgument {
467488
possibilities,
468489
strings: true,
490+
list: false,
469491
},
470492
})
471493
}

‎compiler/rustc_attr_parsing/src/session_diagnostics.rs

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -525,15 +525,22 @@ pub(crate) struct LinkOrdinalOutOfRange {
525525

526526
pub(crate) enum AttributeParseErrorReason {
527527
ExpectedNoArgs,
528-
ExpectedStringLiteral { byte_string: Option<Span> },
528+
ExpectedStringLiteral {
529+
byte_string: Option<Span>,
530+
},
529531
ExpectedIntegerLiteral,
530532
ExpectedAtLeastOneArgument,
531533
ExpectedSingleArgument,
532534
ExpectedList,
533535
UnexpectedLiteral,
534536
ExpectedNameValue(Option<Symbol>),
535537
DuplicateKey(Symbol),
536-
ExpectedSpecificArgument { possibilities: Vec<&'static str>, strings: bool },
538+
ExpectedSpecificArgument {
539+
possibilities: Vec<&'static str>,
540+
strings: bool,
541+
/// Should we tell the user to write a list when they didn't?
542+
list: bool,
543+
},
537544
}
538545

539546
pub(crate) struct AttributeParseError {
@@ -607,7 +614,11 @@ impl<'a, G: EmissionGuarantee> Diagnostic<'a, G> for AttributeParseError {
607614
format!("expected this to be of the form `{name} = \"...\"`"),
608615
);
609616
}
610-
AttributeParseErrorReason::ExpectedSpecificArgument { possibilities, strings } => {
617+
AttributeParseErrorReason::ExpectedSpecificArgument {
618+
possibilities,
619+
strings,
620+
list: false,
621+
} => {
611622
let quote = if strings { '"' } else { '`' };
612623
match possibilities.as_slice() {
613624
&[] => {}
@@ -633,6 +644,38 @@ impl<'a, G: EmissionGuarantee> Diagnostic<'a, G> for AttributeParseError {
633644
}
634645
}
635646
}
647+
AttributeParseErrorReason::ExpectedSpecificArgument {
648+
possibilities,
649+
strings,
650+
list: true,
651+
} => {
652+
let quote = if strings { '"' } else { '`' };
653+
match possibilities.as_slice() {
654+
&[] => {}
655+
&[x] => {
656+
diag.span_label(
657+
self.span,
658+
format!(
659+
"this attribute is only valid with {quote}{x}{quote} as an argument"
660+
),
661+
);
662+
}
663+
[first, second] => {
664+
diag.span_label(self.span, format!("this attribute is only valid with either {quote}{first}{quote} or {quote}{second}{quote} as an argument"));
665+
}
666+
[first @ .., second_to_last, last] => {
667+
let mut res = String::new();
668+
for i in first {
669+
res.push_str(&format!("{quote}{i}{quote}, "));
670+
}
671+
res.push_str(&format!(
672+
"{quote}{second_to_last}{quote} or {quote}{last}{quote}"
673+
));
674+
675+
diag.span_label(self.span, format!("this attribute is only valid with one of the following arguments: {res}"));
676+
}
677+
}
678+
}
636679
}
637680

638681
let suggestions = self.template.suggestions(false, &name);

‎compiler/rustc_mir_transform/src/coverage/query.rs

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1+
use rustc_attr_data_structures::{AttributeKind, CoverageStatus, find_attr};
12
use rustc_index::bit_set::DenseBitSet;
23
use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrFlags;
34
use rustc_middle::mir::coverage::{BasicCoverageBlock, CoverageIdsInfo, CoverageKind, MappingKind};
45
use rustc_middle::mir::{Body, Statement, StatementKind};
56
use rustc_middle::ty::{self, TyCtxt};
67
use rustc_middle::util::Providers;
78
use rustc_span::def_id::LocalDefId;
8-
use rustc_span::sym;
99
use tracing::trace;
1010

1111
use crate::coverage::counters::node_flow::make_node_counters;
@@ -58,26 +58,20 @@ fn is_eligible_for_coverage(tcx: TyCtxt<'_>, def_id: LocalDefId) -> bool {
5858
/// Query implementation for `coverage_attr_on`.
5959
fn coverage_attr_on(tcx: TyCtxt<'_>, def_id: LocalDefId) -> bool {
6060
// Check for annotations directly on this def.
61-
if let Some(attr) = tcx.get_attr(def_id, sym::coverage) {
62-
match attr.meta_item_list().as_deref() {
63-
Some([item]) if item.has_name(sym::off) => return false,
64-
Some([item]) if item.has_name(sym::on) => return true,
65-
Some(_) | None => {
66-
// Other possibilities should have been rejected by `rustc_parse::validate_attr`.
67-
// Use `span_delayed_bug` to avoid an ICE in failing builds (#127880).
68-
tcx.dcx().span_delayed_bug(attr.span(), "unexpected value of coverage attribute");
69-
}
61+
if let Some(coverage_status) =
62+
find_attr!(tcx.get_all_attrs(def_id), AttributeKind::Coverage(_, status) => status)
63+
{
64+
*coverage_status == CoverageStatus::On
65+
} else {
66+
match tcx.opt_local_parent(def_id) {
67+
// Check the parent def (and so on recursively) until we find an
68+
// enclosing attribute or reach the crate root.
69+
Some(parent) => tcx.coverage_attr_on(parent),
70+
// We reached the crate root without seeing a coverage attribute, so
71+
// allow coverage instrumentation by default.
72+
None => true,
7073
}
7174
}
72-
73-
match tcx.opt_local_parent(def_id) {
74-
// Check the parent def (and so on recursively) until we find an
75-
// enclosing attribute or reach the crate root.
76-
Some(parent) => tcx.coverage_attr_on(parent),
77-
// We reached the crate root without seeing a coverage attribute, so
78-
// allow coverage instrumentation by default.
79-
None => true,
80-
}
8175
}
8276

8377
/// Query implementation for `coverage_ids_info`.

‎compiler/rustc_parse/src/validate_attr.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,7 @@ pub fn check_builtin_meta_item(
318318
| sym::rustc_layout_scalar_valid_range_end
319319
| sym::no_implicit_prelude
320320
| sym::automatically_derived
321+
| sym::coverage
321322
) {
322323
return;
323324
}

‎compiler/rustc_passes/src/check_attr.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,9 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
285285
&Attribute::Parsed(AttributeKind::StdInternalSymbol(attr_span)) => {
286286
self.check_rustc_std_internal_symbol(attr_span, span, target)
287287
}
288+
&Attribute::Parsed(AttributeKind::Coverage(attr_span, _)) => {
289+
self.check_coverage(attr_span, span, target)
290+
}
288291
Attribute::Unparsed(attr_item) => {
289292
style = Some(attr_item.style);
290293
match attr.path().as_slice() {
@@ -294,7 +297,6 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
294297
[sym::diagnostic, sym::on_unimplemented, ..] => {
295298
self.check_diagnostic_on_unimplemented(attr.span(), hir_id, target)
296299
}
297-
[sym::coverage, ..] => self.check_coverage(attr, span, target),
298300
[sym::no_sanitize, ..] => {
299301
self.check_no_sanitize(attr, span, target)
300302
}
@@ -585,7 +587,7 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
585587

586588
/// Checks that `#[coverage(..)]` is applied to a function/closure/method,
587589
/// or to an impl block or module.
588-
fn check_coverage(&self, attr: &Attribute, target_span: Span, target: Target) {
590+
fn check_coverage(&self, attr_span: Span, target_span: Span, target: Target) {
589591
let mut not_fn_impl_mod = None;
590592
let mut no_body = None;
591593

@@ -608,7 +610,7 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
608610
}
609611

610612
self.dcx().emit_err(errors::CoverageAttributeNotAllowed {
611-
attr_span: attr.span(),
613+
attr_span,
612614
not_fn_impl_mod,
613615
no_body,
614616
help: (),

‎tests/ui/attributes/malformed-attrs.stderr

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,6 @@ error: malformed `crate_name` attribute input
3737
LL | #[crate_name]
3838
| ^^^^^^^^^^^^^ help: must be of the form: `#[crate_name = "name"]`
3939

40-
error: malformed `coverage` attribute input
41-
--> $DIR/malformed-attrs.rs:90:1
42-
|
43-
LL | #[coverage]
44-
| ^^^^^^^^^^^
45-
|
46-
help: the following are the possible correct uses
47-
|
48-
LL | #[coverage(off)]
49-
| +++++
50-
LL | #[coverage(on)]
51-
| ++++
52-
5340
error: malformed `no_sanitize` attribute input
5441
--> $DIR/malformed-attrs.rs:92:1
5542
|
@@ -460,6 +447,19 @@ error[E0539]: malformed `link_section` attribute input
460447
LL | #[link_section]
461448
| ^^^^^^^^^^^^^^^ help: must be of the form: `#[link_section = "name"]`
462449

450+
error[E0539]: malformed `coverage` attribute input
451+
--> $DIR/malformed-attrs.rs:90:1
452+
|
453+
LL | #[coverage]
454+
| ^^^^^^^^^^^ this attribute is only valid with either `on` or `off` as an argument
455+
|
456+
help: try changing it to one of the following valid forms of the attribute
457+
|
458+
LL | #[coverage(off)]
459+
| +++++
460+
LL | #[coverage(on)]
461+
| ++++
462+
463463
error[E0565]: malformed `no_implicit_prelude` attribute input
464464
--> $DIR/malformed-attrs.rs:97:1
465465
|

‎tests/ui/coverage-attr/bad-attr-ice.feat.stderr

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
error: malformed `coverage` attribute input
1+
error[E0539]: malformed `coverage` attribute input
22
--> $DIR/bad-attr-ice.rs:11:1
33
|
44
LL | #[coverage]
5-
| ^^^^^^^^^^^
5+
| ^^^^^^^^^^^ this attribute is only valid with either `on` or `off` as an argument
66
|
7-
help: the following are the possible correct uses
7+
help: try changing it to one of the following valid forms of the attribute
88
|
99
LL | #[coverage(off)]
1010
| +++++
@@ -13,3 +13,4 @@ LL | #[coverage(on)]
1313

1414
error: aborting due to 1 previous error
1515

16+
For more information about this error, try `rustc --explain E0539`.

0 commit comments

Comments
 (0)