rustc_attr_parsing/attributes/
prototype.rs

1//! Attributes that are only used on function prototypes.
2
3use rustc_feature::{AttributeTemplate, template};
4use rustc_hir::Target;
5use rustc_hir::attrs::{AttributeKind, MirDialect, MirPhase};
6use rustc_span::{Span, Symbol, sym};
7
8use crate::attributes::SingleAttributeParser;
9use crate::context::AcceptContext;
10use crate::parser::{ArgParser, NameValueParser};
11use crate::session_diagnostics;
12use crate::target_checking::AllowedTargets;
13use crate::target_checking::Policy::Allow;
14
15pub(crate) struct CustomMirParser;
16
17impl SingleAttributeParser for CustomMirParser {
18    const PATH: &[rustc_span::Symbol] = &[sym::custom_mir];
19
20    const ALLOWED_TARGETS: AllowedTargets = AllowedTargets::AllowList(&[Allow(Target::Fn)]);
21
22    const TEMPLATE: AttributeTemplate = ::rustc_feature::AttributeTemplate {
    word: false,
    list: Some(&[r#"dialect = "...", phase = "...""#]),
    one_of: &[],
    name_value_str: None,
    docs: None,
}template!(List: &[r#"dialect = "...", phase = "...""#]);
23
24    fn convert(cx: &mut AcceptContext<'_, '_>, args: &ArgParser) -> Option<AttributeKind> {
25        let list = cx.expect_list(args, cx.attr_span)?;
26
27        let mut dialect = None;
28        let mut phase = None;
29        let mut failed = false;
30
31        for item in list.mixed() {
32            let Some((path, arg)) = cx.expect_name_value(item, item.span(), None) else {
33                failed = true;
34                break;
35            };
36
37            match path.name {
38                sym::dialect => {
39                    extract_value(cx, sym::dialect, arg, item.span(), &mut dialect, &mut failed)
40                }
41                sym::phase => {
42                    extract_value(cx, sym::phase, arg, item.span(), &mut phase, &mut failed)
43                }
44                _ => {
45                    cx.adcx().expected_specific_argument(item.span(), &[sym::dialect, sym::phase]);
46                    failed = true;
47                }
48            }
49        }
50
51        let dialect = parse_dialect(cx, dialect, &mut failed);
52        let phase = parse_phase(cx, phase, &mut failed);
53        check_custom_mir(cx, dialect, phase, &mut failed);
54
55        if failed {
56            return None;
57        }
58
59        Some(AttributeKind::CustomMir(dialect, phase, cx.attr_span))
60    }
61}
62
63fn extract_value(
64    cx: &mut AcceptContext<'_, '_>,
65    key: Symbol,
66    val: &NameValueParser,
67    span: Span,
68    out_val: &mut Option<(Symbol, Span)>,
69    failed: &mut bool,
70) {
71    if out_val.is_some() {
72        cx.adcx().duplicate_key(span, key);
73        *failed = true;
74        return;
75    }
76
77    let Some(value_sym) = val.value_as_str() else {
78        cx.adcx().expected_string_literal(val.value_span, Some(val.value_as_lit()));
79        *failed = true;
80        return;
81    };
82
83    *out_val = Some((value_sym, val.value_span));
84}
85
86fn parse_dialect(
87    cx: &mut AcceptContext<'_, '_>,
88    dialect: Option<(Symbol, Span)>,
89    failed: &mut bool,
90) -> Option<(MirDialect, Span)> {
91    let (dialect, span) = dialect?;
92
93    let dialect = match dialect {
94        sym::analysis => MirDialect::Analysis,
95        sym::built => MirDialect::Built,
96        sym::runtime => MirDialect::Runtime,
97
98        _ => {
99            cx.adcx().expected_specific_argument(span, &[sym::analysis, sym::built, sym::runtime]);
100            *failed = true;
101            return None;
102        }
103    };
104
105    Some((dialect, span))
106}
107
108fn parse_phase(
109    cx: &mut AcceptContext<'_, '_>,
110    phase: Option<(Symbol, Span)>,
111    failed: &mut bool,
112) -> Option<(MirPhase, Span)> {
113    let (phase, span) = phase?;
114
115    let phase = match phase {
116        sym::initial => MirPhase::Initial,
117        sym::post_cleanup => MirPhase::PostCleanup,
118        sym::optimized => MirPhase::Optimized,
119
120        _ => {
121            cx.adcx().expected_specific_argument(
122                span,
123                &[sym::initial, sym::post_cleanup, sym::optimized],
124            );
125            *failed = true;
126            return None;
127        }
128    };
129
130    Some((phase, span))
131}
132
133fn check_custom_mir(
134    cx: &mut AcceptContext<'_, '_>,
135    dialect: Option<(MirDialect, Span)>,
136    phase: Option<(MirPhase, Span)>,
137    failed: &mut bool,
138) {
139    let attr_span = cx.attr_span;
140    let Some((dialect, dialect_span)) = dialect else {
141        if let Some((_, phase_span)) = phase {
142            *failed = true;
143            cx.emit_err(session_diagnostics::CustomMirPhaseRequiresDialect {
144                attr_span,
145                phase_span,
146            });
147        }
148        return;
149    };
150
151    match dialect {
152        MirDialect::Analysis => {
153            if let Some((MirPhase::Optimized, phase_span)) = phase {
154                *failed = true;
155                cx.emit_err(session_diagnostics::CustomMirIncompatibleDialectAndPhase {
156                    dialect,
157                    phase: MirPhase::Optimized,
158                    attr_span,
159                    dialect_span,
160                    phase_span,
161                });
162            }
163        }
164
165        MirDialect::Built => {
166            if let Some((phase, phase_span)) = phase {
167                *failed = true;
168                cx.emit_err(session_diagnostics::CustomMirIncompatibleDialectAndPhase {
169                    dialect,
170                    phase,
171                    attr_span,
172                    dialect_span,
173                    phase_span,
174                });
175            }
176        }
177        MirDialect::Runtime => {}
178    }
179}
rustc_attr_parsing/attributes/prototype.rs

rustc_attr_parsing/attributes/
prototype.rs
