1 //! Built-in attributes and `cfg` flag gating.
6 use crate::{Features, Stability};
8 use lazy_static::lazy_static;
9 use rustc_data_structures::fx::FxHashMap;
10 use syntax_pos::symbol::{sym, Symbol};
12 type GateFn = fn(&Features) -> bool;
16 (|features| features.$field) as GateFn
20 pub type GatedCfg = (Symbol, Symbol, GateFn);
22 /// `cfg(...)`'s that are feature gated.
23 const GATED_CFGS: &[GatedCfg] = &[
24 // (name in cfg, feature, function to check if the feature is enabled)
25 (sym::target_thread_local, sym::cfg_target_thread_local, cfg_fn!(cfg_target_thread_local)),
26 (sym::target_has_atomic, sym::cfg_target_has_atomic, cfg_fn!(cfg_target_has_atomic)),
27 (sym::target_has_atomic_load_store, sym::cfg_target_has_atomic, cfg_fn!(cfg_target_has_atomic)),
28 (sym::sanitize, sym::cfg_sanitize, cfg_fn!(cfg_sanitize)),
31 /// Find a gated cfg determined by the `pred`icate which is given the cfg's name.
32 pub fn find_gated_cfg(pred: impl Fn(Symbol) -> bool) -> Option<&'static GatedCfg> {
33 GATED_CFGS.iter().find(|(cfg_sym, ..)| pred(*cfg_sym))
36 // If you change this, please modify `src/doc/unstable-book` as well. You must
37 // move that documentation into the relevant place in the other docs, and
38 // remove the chapter on the flag.
40 #[derive(Copy, Clone, PartialEq, Debug)]
41 pub enum AttributeType {
42 /// Normal, builtin attribute that is consumed
43 /// by the compiler before the unused_attribute check
46 /// Builtin attribute that may not be consumed by the compiler
47 /// before the unused_attribute check. These attributes
48 /// will be ignored by the unused_attribute lint
51 /// Builtin attribute that is only allowed at the crate level
55 #[derive(Clone, Copy)]
56 pub enum AttributeGate {
57 /// Is gated by a given feature gate, reason
58 /// and function to check if enabled
59 Gated(Stability, Symbol, &'static str, fn(&Features) -> bool),
61 /// Ungated attribute, can be used on all release channels
66 impl std::fmt::Debug for AttributeGate {
67 fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
69 Self::Gated(ref stab, name, expl, _) => {
70 write!(fmt, "Gated({:?}, {}, {})", stab, name, expl)
72 Self::Ungated => write!(fmt, "Ungated"),
78 fn is_deprecated(&self) -> bool {
80 Self::Gated(Stability::Deprecated(_, _), ..) => true,
86 /// A template that the attribute input must match.
87 /// Only top-level shape (`#[attr]` vs `#[attr(...)]` vs `#[attr = ...]`) is considered now.
88 #[derive(Clone, Copy)]
89 pub struct AttributeTemplate {
91 pub list: Option<&'static str>,
92 pub name_value_str: Option<&'static str>,
95 impl AttributeTemplate {
96 pub fn only_word() -> Self {
97 Self { word: true, list: None, name_value_str: None }
101 /// A convenience macro for constructing attribute templates.
102 /// E.g., `template!(Word, List: "description")` means that the attribute
103 /// supports forms `#[attr]` and `#[attr(description)]`.
104 macro_rules! template {
105 (Word) => { template!(@ true, None, None) };
106 (List: $descr: expr) => { template!(@ false, Some($descr), None) };
107 (NameValueStr: $descr: expr) => { template!(@ false, None, Some($descr)) };
108 (Word, List: $descr: expr) => { template!(@ true, Some($descr), None) };
109 (Word, NameValueStr: $descr: expr) => { template!(@ true, None, Some($descr)) };
110 (List: $descr1: expr, NameValueStr: $descr2: expr) => {
111 template!(@ false, Some($descr1), Some($descr2))
113 (Word, List: $descr1: expr, NameValueStr: $descr2: expr) => {
114 template!(@ true, Some($descr1), Some($descr2))
116 (@ $word: expr, $list: expr, $name_value_str: expr) => { AttributeTemplate {
117 word: $word, list: $list, name_value_str: $name_value_str
121 macro_rules! ungated {
122 ($attr:ident, $typ:expr, $tpl:expr $(,)?) => {
123 (sym::$attr, $typ, $tpl, Ungated)
128 ($attr:ident, $typ:expr, $tpl:expr, $gate:ident, $msg:expr $(,)?) => {
129 (sym::$attr, $typ, $tpl, Gated(Stability::Unstable, sym::$gate, $msg, cfg_fn!($gate)))
131 ($attr:ident, $typ:expr, $tpl:expr, $msg:expr $(,)?) => {
132 (sym::$attr, $typ, $tpl, Gated(Stability::Unstable, sym::$attr, $msg, cfg_fn!($attr)))
136 macro_rules! rustc_attr {
137 (TEST, $attr:ident, $typ:expr, $tpl:expr $(,)?) => {
145 "]` attribute is just used for rustc unit tests \
146 and will never be stable",
150 ($attr:ident, $typ:expr, $tpl:expr, $msg:expr $(,)?) => {
155 Gated(Stability::Unstable, sym::rustc_attrs, $msg, cfg_fn!(rustc_attrs)),
160 macro_rules! experimental {
162 concat!("the `#[", stringify!($attr), "]` attribute is an experimental feature")
166 const IMPL_DETAIL: &str = "internal implementation detail";
167 const INTERNAL_UNSTABLE: &str = "this is an internal attribute that will never be stable";
169 pub type BuiltinAttribute = (Symbol, AttributeType, AttributeTemplate, AttributeGate);
171 /// Attributes that have a special meaning to rustc or rustdoc.
173 pub const BUILTIN_ATTRIBUTES: &[BuiltinAttribute] = &[
174 // ==========================================================================
175 // Stable attributes:
176 // ==========================================================================
178 // Condtional compilation:
179 ungated!(cfg, Normal, template!(List: "predicate")),
180 ungated!(cfg_attr, Normal, template!(List: "predicate, attr1, attr2, ...")),
183 ungated!(ignore, Normal, template!(Word, NameValueStr: "reason")),
185 should_panic, Normal,
186 template!(Word, List: r#"expected = "reason"#, NameValueStr: "reason"),
188 // FIXME(Centril): This can be used on stable but shouldn't.
189 ungated!(reexport_test_harness_main, Normal, template!(NameValueStr: "name")),
192 ungated!(derive, Normal, template!(List: "Trait1, Trait2, ...")),
193 ungated!(automatically_derived, Normal, template!(Word)),
195 ungated!(macro_use, Normal, template!(Word, List: "name1, name2, ...")),
196 ungated!(macro_escape, Normal, template!(Word)), // Deprecated synonym for `macro_use`.
197 ungated!(macro_export, Normal, template!(Word, List: "local_inner_macros")),
198 ungated!(proc_macro, Normal, template!(Word)),
200 proc_macro_derive, Normal,
201 template!(List: "TraitName, /*opt*/ attributes(name1, name2, ...)"),
203 ungated!(proc_macro_attribute, Normal, template!(Word)),
206 ungated!(warn, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
207 ungated!(allow, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
208 ungated!(forbid, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
209 ungated!(deny, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
210 ungated!(must_use, Whitelisted, template!(Word, NameValueStr: "reason")),
216 List: r#"/*opt*/ since = "version", /*opt*/ note = "reason""#,
217 NameValueStr: "reason"
222 ungated!(crate_name, CrateLevel, template!(NameValueStr: "name")),
223 ungated!(crate_type, CrateLevel, template!(NameValueStr: "bin|lib|...")),
224 ungated!(crate_id, CrateLevel, template!(NameValueStr: "ignored")),
226 // ABI, linking, symbols, and FFI
229 template!(List: r#"name = "...", /*opt*/ kind = "dylib|static|...", /*opt*/ cfg = "...""#),
231 ungated!(link_name, Whitelisted, template!(NameValueStr: "name")),
232 ungated!(no_link, Normal, template!(Word)),
233 ungated!(repr, Normal, template!(List: "C")),
234 ungated!(export_name, Whitelisted, template!(NameValueStr: "name")),
235 ungated!(link_section, Whitelisted, template!(NameValueStr: "name")),
236 ungated!(no_mangle, Whitelisted, template!(Word)),
237 ungated!(used, Whitelisted, template!(Word)),
240 ungated!(recursion_limit, CrateLevel, template!(NameValueStr: "N")),
241 ungated!(type_length_limit, CrateLevel, template!(NameValueStr: "N")),
244 ungated!(main, Normal, template!(Word)),
245 ungated!(start, Normal, template!(Word)),
246 ungated!(no_start, CrateLevel, template!(Word)),
247 ungated!(no_main, CrateLevel, template!(Word)),
249 // Modules, prelude, and resolution:
250 ungated!(path, Normal, template!(NameValueStr: "file")),
251 ungated!(no_std, CrateLevel, template!(Word)),
252 ungated!(no_implicit_prelude, Normal, template!(Word)),
253 ungated!(non_exhaustive, Whitelisted, template!(Word)),
256 ungated!(windows_subsystem, Whitelisted, template!(NameValueStr: "windows|console")),
257 ungated!(panic_handler, Normal, template!(Word)), // RFC 2070
260 ungated!(inline, Whitelisted, template!(Word, List: "always|never")),
261 ungated!(cold, Whitelisted, template!(Word)),
262 ungated!(no_builtins, Whitelisted, template!(Word)),
263 ungated!(target_feature, Whitelisted, template!(List: r#"enable = "name""#)),
265 // FIXME: #14408 whitelist docs since rustdoc looks at them
266 ungated!(doc, Whitelisted, template!(List: "hidden|inline|...", NameValueStr: "string")),
268 // ==========================================================================
269 // Unstable attributes:
270 // ==========================================================================
273 gated!(naked, Whitelisted, template!(Word), naked_functions, experimental!(naked)),
275 link_args, Normal, template!(NameValueStr: "args"),
276 "the `link_args` attribute is experimental and not portable across platforms, \
277 it is recommended to use `#[link(name = \"foo\")] instead",
280 link_ordinal, Whitelisted, template!(List: "ordinal"), raw_dylib,
281 experimental!(link_ordinal)
286 sym::plugin_registrar, Normal, template!(Word),
288 Stability::Deprecated(
289 "https://github.com/rust-lang/rust/pull/64675",
290 Some("may be removed in a future compiler version"),
292 sym::plugin_registrar,
293 "compiler plugins are deprecated",
294 cfg_fn!(plugin_registrar)
298 sym::plugin, CrateLevel, template!(List: "name"),
300 Stability::Deprecated(
301 "https://github.com/rust-lang/rust/pull/64675",
302 Some("may be removed in a future compiler version"),
305 "compiler plugins are deprecated",
311 gated!(allow_fail, Normal, template!(Word), experimental!(allow_fail)),
313 test_runner, CrateLevel, template!(List: "path"), custom_test_frameworks,
314 "custom test frameworks are an unstable feature",
317 gated!(marker, Normal, template!(Word), marker_trait_attr, experimental!(marker)),
319 thread_local, Whitelisted, template!(Word),
320 "`#[thread_local]` is an experimental feature, and does not currently handle destructors",
322 gated!(no_core, CrateLevel, template!(Word), experimental!(no_core)),
325 optimize, Whitelisted, template!(List: "size|speed"), optimize_attribute,
326 experimental!(optimize),
329 gated!(ffi_returns_twice, Whitelisted, template!(Word), experimental!(ffi_returns_twice)),
330 gated!(track_caller, Whitelisted, template!(Word), experimental!(track_caller)),
332 register_attr, CrateLevel, template!(List: "attr1, attr2, ..."),
333 experimental!(register_attr),
336 register_tool, CrateLevel, template!(List: "tool1, tool2, ..."),
337 experimental!(register_tool),
340 // ==========================================================================
341 // Internal attributes: Stability, deprecation, and unsafe:
342 // ==========================================================================
344 ungated!(feature, CrateLevel, template!(List: "name1, name1, ...")),
345 // FIXME(#14407) -- only looked at on-demand so we can't
346 // guarantee they'll have already been checked.
348 rustc_deprecated, Whitelisted,
349 template!(List: r#"since = "version", reason = "...""#)
352 ungated!(stable, Whitelisted, template!(List: r#"feature = "name", since = "version""#)),
355 unstable, Whitelisted,
356 template!(List: r#"feature = "name", reason = "...", issue = "N""#),
359 ungated!(rustc_const_unstable, Whitelisted, template!(List: r#"feature = "name""#)),
361 ungated!(rustc_const_stable, Whitelisted, template!(List: r#"feature = "name""#)),
363 allow_internal_unstable, Normal, template!(Word, List: "feat1, feat2, ..."),
364 "allow_internal_unstable side-steps feature gating and stability checks",
367 allow_internal_unsafe, Normal, template!(Word),
368 "allow_internal_unsafe side-steps the unsafe_code lint",
371 // ==========================================================================
372 // Internal attributes: Type system related:
373 // ==========================================================================
375 gated!(fundamental, Whitelisted, template!(Word), experimental!(fundamental)),
378 structural_match, Whitelisted, template!(Word),
379 "the semantics of constant patterns is not yet settled",
382 may_dangle, Normal, template!(Word), dropck_eyepatch,
383 "`may_dangle` has unstable semantics and may be removed in the future",
386 // ==========================================================================
387 // Internal attributes: Runtime related:
388 // ==========================================================================
390 rustc_attr!(rustc_allocator, Whitelisted, template!(Word), IMPL_DETAIL),
391 rustc_attr!(rustc_allocator_nounwind, Whitelisted, template!(Word), IMPL_DETAIL),
392 gated!(alloc_error_handler, Normal, template!(Word), experimental!(alloc_error_handler)),
394 default_lib_allocator, Whitelisted, template!(Word), allocator_internals,
395 experimental!(default_lib_allocator),
398 needs_allocator, Normal, template!(Word), allocator_internals,
399 experimental!(needs_allocator),
401 gated!(panic_runtime, Whitelisted, template!(Word), experimental!(panic_runtime)),
402 gated!(needs_panic_runtime, Whitelisted, template!(Word), experimental!(needs_panic_runtime)),
404 unwind, Whitelisted, template!(List: "allowed|aborts"), unwind_attributes,
405 experimental!(unwind),
408 compiler_builtins, Whitelisted, template!(Word),
409 "the `#[compiler_builtins]` attribute is used to identify the `compiler_builtins` crate \
410 which contains compiler-rt intrinsics and will never be stable",
413 sanitizer_runtime, Whitelisted, template!(Word),
414 "the `#[sanitizer_runtime]` attribute is used to identify crates that contain the runtime \
415 of a sanitizer and will never be stable",
418 profiler_runtime, Whitelisted, template!(Word),
419 "the `#[profiler_runtime]` attribute is used to identify the `profiler_builtins` crate \
420 which contains the profiler runtime and will never be stable",
423 // ==========================================================================
424 // Internal attributes, Linkage:
425 // ==========================================================================
428 linkage, Whitelisted, template!(NameValueStr: "external|internal|..."),
429 "the `linkage` attribute is experimental and not portable across platforms",
431 rustc_attr!(rustc_std_internal_symbol, Whitelisted, template!(Word), INTERNAL_UNSTABLE),
433 // ==========================================================================
434 // Internal attributes, Macro related:
435 // ==========================================================================
437 rustc_attr!(rustc_builtin_macro, Whitelisted, template!(Word), IMPL_DETAIL),
438 rustc_attr!(rustc_proc_macro_decls, Normal, template!(Word), INTERNAL_UNSTABLE),
440 rustc_macro_transparency, Whitelisted,
441 template!(NameValueStr: "transparent|semitransparent|opaque"),
442 "used internally for testing macro hygiene",
445 // ==========================================================================
446 // Internal attributes, Diagnostics related:
447 // ==========================================================================
450 rustc_on_unimplemented, Whitelisted,
452 List: r#"/*opt*/ message = "...", /*opt*/ label = "...", /*opt*/ note = "...""#,
453 NameValueStr: "message"
457 // Whitelists "identity-like" conversion methods to suggest on type mismatch.
458 rustc_attr!(rustc_conversion_suggestion, Whitelisted, template!(Word), INTERNAL_UNSTABLE),
460 // ==========================================================================
461 // Internal attributes, Const related:
462 // ==========================================================================
464 rustc_attr!(rustc_promotable, Whitelisted, template!(Word), IMPL_DETAIL),
465 rustc_attr!(rustc_allow_const_fn_ptr, Whitelisted, template!(Word), IMPL_DETAIL),
466 rustc_attr!(rustc_args_required_const, Whitelisted, template!(List: "N"), INTERNAL_UNSTABLE),
468 // ==========================================================================
469 // Internal attributes, Layout related:
470 // ==========================================================================
473 rustc_layout_scalar_valid_range_start, Whitelisted, template!(List: "value"),
474 "the `#[rustc_layout_scalar_valid_range_start]` attribute is just used to enable \
475 niche optimizations in libcore and will never be stable",
478 rustc_layout_scalar_valid_range_end, Whitelisted, template!(List: "value"),
479 "the `#[rustc_layout_scalar_valid_range_end]` attribute is just used to enable \
480 niche optimizations in libcore and will never be stable",
483 rustc_nonnull_optimization_guaranteed, Whitelisted, template!(Word),
484 "the `#[rustc_nonnull_optimization_guaranteed]` attribute is just used to enable \
485 niche optimizations in libcore and will never be stable",
488 // ==========================================================================
489 // Internal attributes, Misc:
490 // ==========================================================================
492 lang, Normal, template!(NameValueStr: "name"), lang_items,
493 "language items are subject to change",
496 sym::rustc_diagnostic_item,
498 template!(NameValueStr: "name"),
502 "diagnostic items compiler internal support for linting",
503 cfg_fn!(rustc_attrs),
507 sym::no_debug, Whitelisted, template!(Word),
509 Stability::Deprecated("https://github.com/rust-lang/rust/issues/29721", None),
511 "the `#[no_debug]` attribute was an experimental feature that has been \
512 deprecated due to lack of demand",
518 prelude_import, Whitelisted, template!(Word),
519 "`#[prelude_import]` is for use by rustc only",
522 rustc_paren_sugar, Normal, template!(Word), unboxed_closures,
523 "unboxed_closures are still evolving",
526 rustc_inherit_overflow_checks, Whitelisted, template!(Word),
527 "the `#[rustc_inherit_overflow_checks]` attribute is just used to control \
528 overflow checking behavior of several libcore functions that are inlined \
529 across crates and will never be stable",
531 rustc_attr!(rustc_reservation_impl, Normal, template!(NameValueStr: "reservation message"),
532 "the `#[rustc_reservation_impl]` attribute is internally used \
533 for reserving for `for<T> From<!> for T` impl"
536 rustc_test_marker, Normal, template!(Word),
537 "the `#[rustc_test_marker]` attribute is used internally to track tests",
540 // ==========================================================================
541 // Internal attributes, Testing:
542 // ==========================================================================
544 rustc_attr!(TEST, rustc_outlives, Normal, template!(Word)),
545 rustc_attr!(TEST, rustc_variance, Normal, template!(Word)),
546 rustc_attr!(TEST, rustc_layout, Normal, template!(List: "field1, field2, ...")),
547 rustc_attr!(TEST, rustc_regions, Normal, template!(Word)),
549 TEST, rustc_error, Whitelisted,
550 template!(Word, List: "delay_span_bug_from_inside_query")
552 rustc_attr!(TEST, rustc_dump_user_substs, Whitelisted, template!(Word)),
553 rustc_attr!(TEST, rustc_if_this_changed, Whitelisted, template!(Word, List: "DepNode")),
554 rustc_attr!(TEST, rustc_then_this_would_need, Whitelisted, template!(List: "DepNode")),
556 TEST, rustc_dirty, Whitelisted,
557 template!(List: r#"cfg = "...", /*opt*/ label = "...", /*opt*/ except = "...""#),
560 TEST, rustc_clean, Whitelisted,
561 template!(List: r#"cfg = "...", /*opt*/ label = "...", /*opt*/ except = "...""#),
564 TEST, rustc_partition_reused, Whitelisted,
565 template!(List: r#"cfg = "...", module = "...""#),
568 TEST, rustc_partition_codegened, Whitelisted,
569 template!(List: r#"cfg = "...", module = "...""#),
572 TEST, rustc_expected_cgu_reuse, Whitelisted,
573 template!(List: r#"cfg = "...", module = "...", kind = "...""#),
575 rustc_attr!(TEST, rustc_synthetic, Whitelisted, template!(Word)),
576 rustc_attr!(TEST, rustc_symbol_name, Whitelisted, template!(Word)),
577 rustc_attr!(TEST, rustc_def_path, Whitelisted, template!(Word)),
578 rustc_attr!(TEST, rustc_mir, Whitelisted, template!(List: "arg1, arg2, ...")),
579 rustc_attr!(TEST, rustc_dump_program_clauses, Whitelisted, template!(Word)),
580 rustc_attr!(TEST, rustc_dump_env_program_clauses, Whitelisted, template!(Word)),
581 rustc_attr!(TEST, rustc_object_lifetime_default, Whitelisted, template!(Word)),
582 rustc_attr!(TEST, rustc_dummy, Normal, template!(Word /* doesn't matter*/)),
584 omit_gdb_pretty_printer_section, Whitelisted, template!(Word),
585 "the `#[omit_gdb_pretty_printer_section]` attribute is just used for the Rust test suite",
589 pub fn deprecated_attributes() -> Vec<&'static BuiltinAttribute> {
590 BUILTIN_ATTRIBUTES.iter().filter(|(.., gate)| gate.is_deprecated()).collect()
593 pub fn is_builtin_attr_name(name: Symbol) -> bool {
594 BUILTIN_ATTRIBUTE_MAP.get(&name).is_some()
598 pub static ref BUILTIN_ATTRIBUTE_MAP: FxHashMap<Symbol, &'static BuiltinAttribute> = {
599 let mut map = FxHashMap::default();
600 for attr in BUILTIN_ATTRIBUTES.iter() {
601 if map.insert(attr.0, attr).is_some() {
602 panic!("duplicate builtin attribute `{}`", attr.0);