compiler/rustc_feature/src/builtin_attrs.rs

   1 //! Built-in attributes and `cfg` flag gating.
   2
   3 use AttributeGate::*;
   4 use AttributeType::*;
   5
   6 use crate::{Features, Stability};
   7
   8 use rustc_data_structures::fx::FxHashMap;
   9 use rustc_span::symbol::{sym, Symbol};
  10
  11 use std::lazy::SyncLazy;
  12
  13 type GateFn = fn(&Features) -> bool;
  14
  15 macro_rules! cfg_fn {
  16     ($field: ident) => {
  17         (|features| features.$field) as GateFn
  18     };
  19 }
  20
  21 pub type GatedCfg = (Symbol, Symbol, GateFn);
  22
  23 /// `cfg(...)`'s that are feature gated.
  24 const GATED_CFGS: &[GatedCfg] = &[
  25     // (name in cfg, feature, function to check if the feature is enabled)
  26     (sym::target_thread_local, sym::cfg_target_thread_local, cfg_fn!(cfg_target_thread_local)),
  27     (sym::target_has_atomic, sym::cfg_target_has_atomic, cfg_fn!(cfg_target_has_atomic)),
  28     (sym::target_has_atomic_load_store, sym::cfg_target_has_atomic, cfg_fn!(cfg_target_has_atomic)),
  29     (
  30         sym::target_has_atomic_equal_alignment,
  31         sym::cfg_target_has_atomic,
  32         cfg_fn!(cfg_target_has_atomic),
  33     ),
  34     (sym::sanitize, sym::cfg_sanitize, cfg_fn!(cfg_sanitize)),
  35     (sym::version, sym::cfg_version, cfg_fn!(cfg_version)),
  36     (sym::panic, sym::cfg_panic, cfg_fn!(cfg_panic)),
  37 ];
  38
  39 /// Find a gated cfg determined by the `pred`icate which is given the cfg's name.
  40 pub fn find_gated_cfg(pred: impl Fn(Symbol) -> bool) -> Option<&'static GatedCfg> {
  41     GATED_CFGS.iter().find(|(cfg_sym, ..)| pred(*cfg_sym))
  42 }
  43
  44 // If you change this, please modify `src/doc/unstable-book` as well. You must
  45 // move that documentation into the relevant place in the other docs, and
  46 // remove the chapter on the flag.
  47
  48 #[derive(Copy, Clone, PartialEq, Debug)]
  49 pub enum AttributeType {
  50     /// Normal, builtin attribute that is consumed
  51     /// by the compiler before the unused_attribute check
  52     Normal,
  53
  54     /// Builtin attribute that may not be consumed by the compiler
  55     /// before the unused_attribute check. These attributes
  56     /// will be ignored by the unused_attribute lint
  57     AssumedUsed,
  58
  59     /// Builtin attribute that is only allowed at the crate level
  60     CrateLevel,
  61 }
  62
  63 #[derive(Clone, Copy)]
  64 pub enum AttributeGate {
  65     /// Is gated by a given feature gate, reason
  66     /// and function to check if enabled
  67     Gated(Stability, Symbol, &'static str, fn(&Features) -> bool),
  68
  69     /// Ungated attribute, can be used on all release channels
  70     Ungated,
  71 }
  72
  73 // fn() is not Debug
  74 impl std::fmt::Debug for AttributeGate {
  75     fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  76         match *self {
  77             Self::Gated(ref stab, name, expl, _) => {
  78                 write!(fmt, "Gated({:?}, {}, {})", stab, name, expl)
  79             }
  80             Self::Ungated => write!(fmt, "Ungated"),
  81         }
  82     }
  83 }
  84
  85 impl AttributeGate {
  86     fn is_deprecated(&self) -> bool {
  87         matches!(*self, Self::Gated(Stability::Deprecated(_, _), ..))
  88     }
  89 }
  90
  91 /// A template that the attribute input must match.
  92 /// Only top-level shape (`#[attr]` vs `#[attr(...)]` vs `#[attr = ...]`) is considered now.
  93 #[derive(Clone, Copy, Default)]
  94 pub struct AttributeTemplate {
  95     pub word: bool,
  96     pub list: Option<&'static str>,
  97     pub name_value_str: Option<&'static str>,
  98 }
  99
 100 /// A convenience macro for constructing attribute templates.
 101 /// E.g., `template!(Word, List: "description")` means that the attribute
 102 /// supports forms `#[attr]` and `#[attr(description)]`.
 103 macro_rules! template {
 104     (Word) => { template!(@ true, None, None) };
 105     (List: $descr: expr) => { template!(@ false, Some($descr), None) };
 106     (NameValueStr: $descr: expr) => { template!(@ false, None, Some($descr)) };
 107     (Word, List: $descr: expr) => { template!(@ true, Some($descr), None) };
 108     (Word, NameValueStr: $descr: expr) => { template!(@ true, None, Some($descr)) };
 109     (List: $descr1: expr, NameValueStr: $descr2: expr) => {
 110         template!(@ false, Some($descr1), Some($descr2))
 111     };
 112     (Word, List: $descr1: expr, NameValueStr: $descr2: expr) => {
 113         template!(@ true, Some($descr1), Some($descr2))
 114     };
 115     (@ $word: expr, $list: expr, $name_value_str: expr) => { AttributeTemplate {
 116         word: $word, list: $list, name_value_str: $name_value_str
 117     } };
 118 }
 119
 120 macro_rules! ungated {
 121     ($attr:ident, $typ:expr, $tpl:expr $(,)?) => {
 122         (sym::$attr, $typ, $tpl, Ungated)
 123     };
 124 }
 125
 126 macro_rules! gated {
 127     ($attr:ident, $typ:expr, $tpl:expr, $gate:ident, $msg:expr $(,)?) => {
 128         (sym::$attr, $typ, $tpl, Gated(Stability::Unstable, sym::$gate, $msg, cfg_fn!($gate)))
 129     };
 130     ($attr:ident, $typ:expr, $tpl:expr, $msg:expr $(,)?) => {
 131         (sym::$attr, $typ, $tpl, Gated(Stability::Unstable, sym::$attr, $msg, cfg_fn!($attr)))
 132     };
 133 }
 134
 135 macro_rules! rustc_attr {
 136     (TEST, $attr:ident, $typ:expr, $tpl:expr $(,)?) => {
 137         rustc_attr!(
 138             $attr,
 139             $typ,
 140             $tpl,
 141             concat!(
 142                 "the `#[",
 143                 stringify!($attr),
 144                 "]` attribute is just used for rustc unit tests \
 145                 and will never be stable",
 146             ),
 147         )
 148     };
 149     ($attr:ident, $typ:expr, $tpl:expr, $msg:expr $(,)?) => {
 150         (
 151             sym::$attr,
 152             $typ,
 153             $tpl,
 154             Gated(Stability::Unstable, sym::rustc_attrs, $msg, cfg_fn!(rustc_attrs)),
 155         )
 156     };
 157 }
 158
 159 macro_rules! experimental {
 160     ($attr:ident) => {
 161         concat!("the `#[", stringify!($attr), "]` attribute is an experimental feature")
 162     };
 163 }
 164
 165 const IMPL_DETAIL: &str = "internal implementation detail";
 166 const INTERNAL_UNSTABLE: &str = "this is an internal attribute that will never be stable";
 167
 168 pub type BuiltinAttribute = (Symbol, AttributeType, AttributeTemplate, AttributeGate);
 169
 170 /// Attributes that have a special meaning to rustc or rustdoc.
 171 #[rustfmt::skip]
 172 pub const BUILTIN_ATTRIBUTES: &[BuiltinAttribute] = &[
 173     // ==========================================================================
 174     // Stable attributes:
 175     // ==========================================================================
 176
 177     // Conditional compilation:
 178     ungated!(cfg, Normal, template!(List: "predicate")),
 179     ungated!(cfg_attr, Normal, template!(List: "predicate, attr1, attr2, ...")),
 180
 181     // Testing:
 182     ungated!(ignore, Normal, template!(Word, NameValueStr: "reason")),
 183     ungated!(
 184         should_panic, Normal,
 185         template!(Word, List: r#"expected = "reason"#, NameValueStr: "reason"),
 186     ),
 187     // FIXME(Centril): This can be used on stable but shouldn't.
 188     ungated!(reexport_test_harness_main, Normal, template!(NameValueStr: "name")),
 189
 190     // Macros:
 191     ungated!(automatically_derived, Normal, template!(Word)),
 192     // FIXME(#14407)
 193     ungated!(macro_use, Normal, template!(Word, List: "name1, name2, ...")),
 194     ungated!(macro_escape, Normal, template!(Word)), // Deprecated synonym for `macro_use`.
 195     ungated!(macro_export, Normal, template!(Word, List: "local_inner_macros")),
 196     ungated!(proc_macro, Normal, template!(Word)),
 197     ungated!(
 198         proc_macro_derive, Normal,
 199         template!(List: "TraitName, /*opt*/ attributes(name1, name2, ...)"),
 200     ),
 201     ungated!(proc_macro_attribute, Normal, template!(Word)),
 202
 203     // Lints:
 204     ungated!(warn, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
 205     ungated!(allow, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
 206     ungated!(forbid, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
 207     ungated!(deny, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
 208     ungated!(must_use, AssumedUsed, template!(Word, NameValueStr: "reason")),
 209     // FIXME(#14407)
 210     ungated!(
 211         deprecated, Normal,
 212         template!(
 213             Word,
 214             List: r#"/*opt*/ since = "version", /*opt*/ note = "reason""#,
 215             NameValueStr: "reason"
 216         ),
 217     ),
 218
 219     // Crate properties:
 220     ungated!(crate_name, CrateLevel, template!(NameValueStr: "name")),
 221     ungated!(crate_type, CrateLevel, template!(NameValueStr: "bin|lib|...")),
 222     ungated!(crate_id, CrateLevel, template!(NameValueStr: "ignored")),
 223
 224     // ABI, linking, symbols, and FFI
 225     ungated!(
 226         link, AssumedUsed,
 227         template!(List: r#"name = "...", /*opt*/ kind = "dylib|static|...", /*opt*/ wasm_import_module = "...""#),
 228     ),
 229     ungated!(link_name, AssumedUsed, template!(NameValueStr: "name")),
 230     ungated!(no_link, Normal, template!(Word)),
 231     ungated!(repr, Normal, template!(List: "C")),
 232     ungated!(export_name, AssumedUsed, template!(NameValueStr: "name")),
 233     ungated!(link_section, AssumedUsed, template!(NameValueStr: "name")),
 234     ungated!(no_mangle, AssumedUsed, template!(Word)),
 235     ungated!(used, AssumedUsed, template!(Word)),
 236
 237     // Limits:
 238     ungated!(recursion_limit, CrateLevel, template!(NameValueStr: "N")),
 239     ungated!(type_length_limit, CrateLevel, template!(NameValueStr: "N")),
 240     gated!(
 241         const_eval_limit, CrateLevel, template!(NameValueStr: "N"), const_eval_limit,
 242         experimental!(const_eval_limit)
 243     ),
 244
 245     // Entry point:
 246     ungated!(main, Normal, template!(Word)),
 247     ungated!(start, Normal, template!(Word)),
 248     ungated!(no_start, CrateLevel, template!(Word)),
 249     ungated!(no_main, CrateLevel, template!(Word)),
 250
 251     // Modules, prelude, and resolution:
 252     ungated!(path, Normal, template!(NameValueStr: "file")),
 253     ungated!(no_std, CrateLevel, template!(Word)),
 254     ungated!(no_implicit_prelude, Normal, template!(Word)),
 255     ungated!(non_exhaustive, AssumedUsed, template!(Word)),
 256
 257     // Runtime
 258     ungated!(windows_subsystem, AssumedUsed, template!(NameValueStr: "windows|console")),
 259     ungated!(panic_handler, Normal, template!(Word)), // RFC 2070
 260
 261     // Code generation:
 262     ungated!(inline, AssumedUsed, template!(Word, List: "always|never")),
 263     ungated!(cold, AssumedUsed, template!(Word)),
 264     ungated!(no_builtins, AssumedUsed, template!(Word)),
 265     ungated!(target_feature, AssumedUsed, template!(List: r#"enable = "name""#)),
 266     ungated!(track_caller, AssumedUsed, template!(Word)),
 267     gated!(
 268         no_sanitize, AssumedUsed,
 269         template!(List: "address, memory, thread"),
 270         experimental!(no_sanitize)
 271     ),
 272
 273     // FIXME: #14408 assume docs are used since rustdoc looks at them.
 274     ungated!(doc, AssumedUsed, template!(List: "hidden|inline|...", NameValueStr: "string")),
 275
 276     // ==========================================================================
 277     // Unstable attributes:
 278     // ==========================================================================
 279
 280     // Linking:
 281     gated!(naked, AssumedUsed, template!(Word), naked_functions, experimental!(naked)),
 282     gated!(
 283         link_ordinal, AssumedUsed, template!(List: "ordinal"), raw_dylib,
 284         experimental!(link_ordinal)
 285     ),
 286
 287     // Plugins:
 288     (
 289         sym::plugin_registrar, Normal, template!(Word),
 290         Gated(
 291             Stability::Deprecated(
 292                 "https://github.com/rust-lang/rust/pull/64675",
 293                 Some("may be removed in a future compiler version"),
 294             ),
 295             sym::plugin_registrar,
 296             "compiler plugins are deprecated",
 297             cfg_fn!(plugin_registrar)
 298         )
 299     ),
 300     (
 301         sym::plugin, CrateLevel, template!(List: "name"),
 302         Gated(
 303             Stability::Deprecated(
 304                 "https://github.com/rust-lang/rust/pull/64675",
 305                 Some("may be removed in a future compiler version"),
 306             ),
 307             sym::plugin,
 308             "compiler plugins are deprecated",
 309             cfg_fn!(plugin)
 310         )
 311     ),
 312
 313     // Testing:
 314     gated!(allow_fail, Normal, template!(Word), experimental!(allow_fail)),
 315     gated!(
 316         test_runner, CrateLevel, template!(List: "path"), custom_test_frameworks,
 317         "custom test frameworks are an unstable feature",
 318     ),
 319     // RFC #1268
 320     gated!(marker, Normal, template!(Word), marker_trait_attr, experimental!(marker)),
 321     gated!(
 322         thread_local, AssumedUsed, template!(Word),
 323         "`#[thread_local]` is an experimental feature, and does not currently handle destructors",
 324     ),
 325     gated!(no_core, CrateLevel, template!(Word), experimental!(no_core)),
 326     // RFC 2412
 327     gated!(
 328         optimize, AssumedUsed, template!(List: "size|speed"), optimize_attribute,
 329         experimental!(optimize),
 330     ),
 331     // RFC 2867
 332     gated!(instruction_set, AssumedUsed, template!(List: "set"), isa_attribute, experimental!(instruction_set)),
 333
 334     gated!(ffi_returns_twice, AssumedUsed, template!(Word), experimental!(ffi_returns_twice)),
 335     gated!(ffi_pure, AssumedUsed, template!(Word), experimental!(ffi_pure)),
 336     gated!(ffi_const, AssumedUsed, template!(Word), experimental!(ffi_const)),
 337     gated!(
 338         register_attr, CrateLevel, template!(List: "attr1, attr2, ..."),
 339         experimental!(register_attr),
 340     ),
 341     gated!(
 342         register_tool, CrateLevel, template!(List: "tool1, tool2, ..."),
 343         experimental!(register_tool),
 344     ),
 345
 346     gated!(cmse_nonsecure_entry, AssumedUsed, template!(Word), experimental!(cmse_nonsecure_entry)),
 347
 348     // ==========================================================================
 349     // Internal attributes: Stability, deprecation, and unsafe:
 350     // ==========================================================================
 351
 352     ungated!(feature, CrateLevel, template!(List: "name1, name1, ...")),
 353     // FIXME(#14407) -- only looked at on-demand so we can't
 354     // guarantee they'll have already been checked.
 355     ungated!(
 356         rustc_deprecated, AssumedUsed,
 357         template!(List: r#"since = "version", reason = "...""#)
 358     ),
 359     // FIXME(#14407)
 360     ungated!(stable, AssumedUsed, template!(List: r#"feature = "name", since = "version""#)),
 361     // FIXME(#14407)
 362     ungated!(
 363         unstable, AssumedUsed,
 364         template!(List: r#"feature = "name", reason = "...", issue = "N""#),
 365     ),
 366     // FIXME(#14407)
 367     ungated!(rustc_const_unstable, AssumedUsed, template!(List: r#"feature = "name""#)),
 368     // FIXME(#14407)
 369     ungated!(rustc_const_stable, AssumedUsed, template!(List: r#"feature = "name""#)),
 370     gated!(
 371         allow_internal_unstable, AssumedUsed, template!(Word, List: "feat1, feat2, ..."),
 372         "allow_internal_unstable side-steps feature gating and stability checks",
 373     ),
 374     gated!(
 375         rustc_allow_const_fn_unstable, AssumedUsed, template!(Word, List: "feat1, feat2, ..."),
 376         "rustc_allow_const_fn_unstable side-steps feature gating and stability checks"
 377     ),
 378     gated!(
 379         allow_internal_unsafe, Normal, template!(Word),
 380         "allow_internal_unsafe side-steps the unsafe_code lint",
 381     ),
 382
 383     // ==========================================================================
 384     // Internal attributes: Type system related:
 385     // ==========================================================================
 386
 387     gated!(fundamental, AssumedUsed, template!(Word), experimental!(fundamental)),
 388     gated!(
 389         may_dangle, Normal, template!(Word), dropck_eyepatch,
 390         "`may_dangle` has unstable semantics and may be removed in the future",
 391     ),
 392
 393     // ==========================================================================
 394     // Internal attributes: Runtime related:
 395     // ==========================================================================
 396
 397     rustc_attr!(rustc_allocator, AssumedUsed, template!(Word), IMPL_DETAIL),
 398     rustc_attr!(rustc_allocator_nounwind, AssumedUsed, template!(Word), IMPL_DETAIL),
 399     gated!(alloc_error_handler, Normal, template!(Word), experimental!(alloc_error_handler)),
 400     gated!(
 401         default_lib_allocator, AssumedUsed, template!(Word), allocator_internals,
 402         experimental!(default_lib_allocator),
 403     ),
 404     gated!(
 405         needs_allocator, Normal, template!(Word), allocator_internals,
 406         experimental!(needs_allocator),
 407     ),
 408     gated!(panic_runtime, AssumedUsed, template!(Word), experimental!(panic_runtime)),
 409     gated!(needs_panic_runtime, AssumedUsed, template!(Word), experimental!(needs_panic_runtime)),
 410     gated!(
 411         unwind, AssumedUsed, template!(List: "allowed|aborts"), unwind_attributes,
 412         experimental!(unwind),
 413     ),
 414     gated!(
 415         compiler_builtins, AssumedUsed, template!(Word),
 416         "the `#[compiler_builtins]` attribute is used to identify the `compiler_builtins` crate \
 417         which contains compiler-rt intrinsics and will never be stable",
 418     ),
 419     gated!(
 420         profiler_runtime, AssumedUsed, template!(Word),
 421         "the `#[profiler_runtime]` attribute is used to identify the `profiler_builtins` crate \
 422         which contains the profiler runtime and will never be stable",
 423     ),
 424
 425     // ==========================================================================
 426     // Internal attributes, Linkage:
 427     // ==========================================================================
 428
 429     gated!(
 430         linkage, AssumedUsed, template!(NameValueStr: "external|internal|..."),
 431         "the `linkage` attribute is experimental and not portable across platforms",
 432     ),
 433     rustc_attr!(rustc_std_internal_symbol, AssumedUsed, template!(Word), INTERNAL_UNSTABLE),
 434
 435     // ==========================================================================
 436     // Internal attributes, Macro related:
 437     // ==========================================================================
 438
 439     rustc_attr!(rustc_builtin_macro, AssumedUsed, template!(Word, NameValueStr: "name"), IMPL_DETAIL),
 440     rustc_attr!(rustc_proc_macro_decls, Normal, template!(Word), INTERNAL_UNSTABLE),
 441     rustc_attr!(
 442         rustc_macro_transparency, AssumedUsed,
 443         template!(NameValueStr: "transparent|semitransparent|opaque"),
 444         "used internally for testing macro hygiene",
 445     ),
 446
 447     // ==========================================================================
 448     // Internal attributes, Diagnostics related:
 449     // ==========================================================================
 450
 451     rustc_attr!(
 452         rustc_on_unimplemented, AssumedUsed,
 453         template!(
 454             List: r#"/*opt*/ message = "...", /*opt*/ label = "...", /*opt*/ note = "...""#,
 455             NameValueStr: "message"
 456         ),
 457         INTERNAL_UNSTABLE
 458     ),
 459     // Enumerates "identity-like" conversion methods to suggest on type mismatch.
 460     rustc_attr!(rustc_conversion_suggestion, AssumedUsed, template!(Word), INTERNAL_UNSTABLE),
 461
 462     // ==========================================================================
 463     // Internal attributes, Const related:
 464     // ==========================================================================
 465
 466     rustc_attr!(rustc_promotable, AssumedUsed, template!(Word), IMPL_DETAIL),
 467     rustc_attr!(rustc_args_required_const, AssumedUsed, template!(List: "N"), INTERNAL_UNSTABLE),
 468     rustc_attr!(rustc_legacy_const_generics, AssumedUsed, template!(List: "N"), INTERNAL_UNSTABLE),
 469
 470     // ==========================================================================
 471     // Internal attributes, Layout related:
 472     // ==========================================================================
 473
 474     rustc_attr!(
 475         rustc_layout_scalar_valid_range_start, AssumedUsed, template!(List: "value"),
 476         "the `#[rustc_layout_scalar_valid_range_start]` attribute is just used to enable \
 477         niche optimizations in libcore and will never be stable",
 478     ),
 479     rustc_attr!(
 480         rustc_layout_scalar_valid_range_end, AssumedUsed, template!(List: "value"),
 481         "the `#[rustc_layout_scalar_valid_range_end]` attribute is just used to enable \
 482         niche optimizations in libcore and will never be stable",
 483     ),
 484     rustc_attr!(
 485         rustc_nonnull_optimization_guaranteed, AssumedUsed, template!(Word),
 486         "the `#[rustc_nonnull_optimization_guaranteed]` attribute is just used to enable \
 487         niche optimizations in libcore and will never be stable",
 488     ),
 489
 490     // ==========================================================================
 491     // Internal attributes, Misc:
 492     // ==========================================================================
 493     gated!(
 494         lang, Normal, template!(NameValueStr: "name"), lang_items,
 495         "language items are subject to change",
 496     ),
 497     (
 498         sym::rustc_diagnostic_item,
 499         Normal,
 500         template!(NameValueStr: "name"),
 501         Gated(
 502             Stability::Unstable,
 503             sym::rustc_attrs,
 504             "diagnostic items compiler internal support for linting",
 505             cfg_fn!(rustc_attrs),
 506         ),
 507     ),
 508     gated!(
 509         // Used in resolve:
 510         prelude_import, AssumedUsed, template!(Word),
 511         "`#[prelude_import]` is for use by rustc only",
 512     ),
 513     gated!(
 514         rustc_paren_sugar, Normal, template!(Word), unboxed_closures,
 515         "unboxed_closures are still evolving",
 516     ),
 517     rustc_attr!(
 518         rustc_inherit_overflow_checks, AssumedUsed, template!(Word),
 519         "the `#[rustc_inherit_overflow_checks]` attribute is just used to control \
 520         overflow checking behavior of several libcore functions that are inlined \
 521         across crates and will never be stable",
 522     ),
 523     rustc_attr!(rustc_reservation_impl, Normal, template!(NameValueStr: "reservation message"),
 524                 "the `#[rustc_reservation_impl]` attribute is internally used \
 525                  for reserving for `for<T> From<!> for T` impl"
 526     ),
 527     rustc_attr!(
 528         rustc_test_marker, Normal, template!(Word),
 529         "the `#[rustc_test_marker]` attribute is used internally to track tests",
 530     ),
 531     rustc_attr!(
 532         rustc_unsafe_specialization_marker, Normal, template!(Word),
 533         "the `#[rustc_unsafe_specialization_marker]` attribute is used to check specializations"
 534     ),
 535     rustc_attr!(
 536         rustc_specialization_trait, Normal, template!(Word),
 537         "the `#[rustc_specialization_trait]` attribute is used to check specializations"
 538     ),
 539     rustc_attr!(
 540         rustc_main, Normal, template!(Word),
 541         "the `#[rustc_main]` attribute is used internally to specify test entry point function",
 542     ),
 543
 544     // ==========================================================================
 545     // Internal attributes, Testing:
 546     // ==========================================================================
 547
 548     rustc_attr!(TEST, rustc_outlives, Normal, template!(Word)),
 549     rustc_attr!(TEST, rustc_capture_analysis, Normal, template!(Word)),
 550     rustc_attr!(TEST, rustc_variance, Normal, template!(Word)),
 551     rustc_attr!(TEST, rustc_layout, Normal, template!(List: "field1, field2, ...")),
 552     rustc_attr!(TEST, rustc_regions, Normal, template!(Word)),
 553     rustc_attr!(
 554         TEST, rustc_error, AssumedUsed,
 555         template!(Word, List: "delay_span_bug_from_inside_query")
 556     ),
 557     rustc_attr!(TEST, rustc_dump_user_substs, AssumedUsed, template!(Word)),
 558     rustc_attr!(TEST, rustc_if_this_changed, AssumedUsed, template!(Word, List: "DepNode")),
 559     rustc_attr!(TEST, rustc_then_this_would_need, AssumedUsed, template!(List: "DepNode")),
 560     rustc_attr!(
 561         TEST, rustc_dirty, AssumedUsed,
 562         template!(List: r#"cfg = "...", /*opt*/ label = "...", /*opt*/ except = "...""#),
 563     ),
 564     rustc_attr!(
 565         TEST, rustc_clean, AssumedUsed,
 566         template!(List: r#"cfg = "...", /*opt*/ label = "...", /*opt*/ except = "...""#),
 567     ),
 568     rustc_attr!(
 569         TEST, rustc_partition_reused, AssumedUsed,
 570         template!(List: r#"cfg = "...", module = "...""#),
 571     ),
 572     rustc_attr!(
 573         TEST, rustc_partition_codegened, AssumedUsed,
 574         template!(List: r#"cfg = "...", module = "...""#),
 575     ),
 576     rustc_attr!(
 577         TEST, rustc_expected_cgu_reuse, AssumedUsed,
 578         template!(List: r#"cfg = "...", module = "...", kind = "...""#),
 579     ),
 580     rustc_attr!(TEST, rustc_synthetic, AssumedUsed, template!(Word)),
 581     rustc_attr!(TEST, rustc_symbol_name, AssumedUsed, template!(Word)),
 582     rustc_attr!(TEST, rustc_polymorphize_error, AssumedUsed, template!(Word)),
 583     rustc_attr!(TEST, rustc_def_path, AssumedUsed, template!(Word)),
 584     rustc_attr!(TEST, rustc_mir, AssumedUsed, template!(List: "arg1, arg2, ...")),
 585     rustc_attr!(TEST, rustc_dump_program_clauses, AssumedUsed, template!(Word)),
 586     rustc_attr!(TEST, rustc_dump_env_program_clauses, AssumedUsed, template!(Word)),
 587     rustc_attr!(TEST, rustc_object_lifetime_default, AssumedUsed, template!(Word)),
 588     rustc_attr!(TEST, rustc_dummy, Normal, template!(Word /* doesn't matter*/)),
 589     gated!(
 590         omit_gdb_pretty_printer_section, AssumedUsed, template!(Word),
 591         "the `#[omit_gdb_pretty_printer_section]` attribute is just used for the Rust test suite",
 592     ),
 593 ];
 594
 595 pub fn deprecated_attributes() -> Vec<&'static BuiltinAttribute> {
 596     BUILTIN_ATTRIBUTES.iter().filter(|(.., gate)| gate.is_deprecated()).collect()
 597 }
 598
 599 pub fn is_builtin_attr_name(name: Symbol) -> bool {
 600     BUILTIN_ATTRIBUTE_MAP.get(&name).is_some()
 601 }
 602
 603 pub static BUILTIN_ATTRIBUTE_MAP: SyncLazy<FxHashMap<Symbol, &BuiltinAttribute>> =
 604     SyncLazy::new(|| {
 605         let mut map = FxHashMap::default();
 606         for attr in BUILTIN_ATTRIBUTES.iter() {
 607             if map.insert(attr.0, attr).is_some() {
 608                 panic!("duplicate builtin attribute `{}`", attr.0);
 609             }
 610         }
 611         map
 612     });