1 //! Builtin attributes resolved by nameres.
3 //! The actual definitions were copied from rustc's `compiler/rustc_feature/src/builtin_attrs.rs`.
5 //! It was last synchronized with upstream commit 2225ee1b62ff089917434aefd9b2bf509cfa087f.
7 //! The macros were adjusted to only expand to the attribute name, since that is all we need to do
8 //! name resolution, and `BUILTIN_ATTRIBUTES` is almost entirely unchanged from the original, to
11 /// Ignored attribute namespaces used by tools.
12 pub const TOOL_MODULES: &[&str] = &["rustfmt", "clippy"];
14 type BuiltinAttribute = &'static str;
16 macro_rules! ungated {
17 ($attr:ident, $typ:expr, $tpl:expr $(,)?) => {
23 ($attr:ident $($rest:tt)*) => {
28 macro_rules! rustc_attr {
29 (TEST, $attr:ident $($rest:tt)*) => {
32 ($attr:ident $($rest:tt)*) => {
37 /// Attributes that have a special meaning to rustc or rustdoc.
39 pub const BUILTIN_ATTRIBUTES: &[BuiltinAttribute] = &[
40 // ==========================================================================
42 // ==========================================================================
44 // Conditional compilation:
45 ungated!(cfg, Normal, template!(List: "predicate")),
46 ungated!(cfg_attr, Normal, template!(List: "predicate, attr1, attr2, ...")),
49 ungated!(ignore, Normal, template!(Word, NameValueStr: "reason")),
52 template!(Word, List: r#"expected = "reason"#, NameValueStr: "reason"),
54 // FIXME(Centril): This can be used on stable but shouldn't.
55 ungated!(reexport_test_harness_main, Normal, template!(NameValueStr: "name")),
58 ungated!(derive, Normal, template!(List: "Trait1, Trait2, ...")),
59 ungated!(automatically_derived, Normal, template!(Word)),
61 ungated!(macro_use, Normal, template!(Word, List: "name1, name2, ...")),
62 ungated!(macro_escape, Normal, template!(Word)), // Deprecated synonym for `macro_use`.
63 ungated!(macro_export, Normal, template!(Word, List: "local_inner_macros")),
64 ungated!(proc_macro, Normal, template!(Word)),
66 proc_macro_derive, Normal,
67 template!(List: "TraitName, /*opt*/ attributes(name1, name2, ...)"),
69 ungated!(proc_macro_attribute, Normal, template!(Word)),
72 ungated!(warn, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
73 ungated!(allow, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
74 ungated!(forbid, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
75 ungated!(deny, Normal, template!(List: r#"lint1, lint2, ..., /*opt*/ reason = "...""#)),
76 ungated!(must_use, AssumedUsed, template!(Word, NameValueStr: "reason")),
82 List: r#"/*opt*/ since = "version", /*opt*/ note = "reason""#,
83 NameValueStr: "reason"
88 ungated!(crate_name, CrateLevel, template!(NameValueStr: "name")),
89 ungated!(crate_type, CrateLevel, template!(NameValueStr: "bin|lib|...")),
90 ungated!(crate_id, CrateLevel, template!(NameValueStr: "ignored")),
92 // ABI, linking, symbols, and FFI
95 template!(List: r#"name = "...", /*opt*/ kind = "dylib|static|...", /*opt*/ wasm_import_module = "...""#),
97 ungated!(link_name, AssumedUsed, template!(NameValueStr: "name")),
98 ungated!(no_link, Normal, template!(Word)),
99 ungated!(repr, Normal, template!(List: "C")),
100 ungated!(export_name, AssumedUsed, template!(NameValueStr: "name")),
101 ungated!(link_section, AssumedUsed, template!(NameValueStr: "name")),
102 ungated!(no_mangle, AssumedUsed, template!(Word)),
103 ungated!(used, AssumedUsed, template!(Word)),
106 ungated!(recursion_limit, CrateLevel, template!(NameValueStr: "N")),
107 ungated!(type_length_limit, CrateLevel, template!(NameValueStr: "N")),
109 const_eval_limit, CrateLevel, template!(NameValueStr: "N"), const_eval_limit,
110 experimental!(const_eval_limit)
114 ungated!(main, Normal, template!(Word)),
115 ungated!(start, Normal, template!(Word)),
116 ungated!(no_start, CrateLevel, template!(Word)),
117 ungated!(no_main, CrateLevel, template!(Word)),
119 // Modules, prelude, and resolution:
120 ungated!(path, Normal, template!(NameValueStr: "file")),
121 ungated!(no_std, CrateLevel, template!(Word)),
122 ungated!(no_implicit_prelude, Normal, template!(Word)),
123 ungated!(non_exhaustive, AssumedUsed, template!(Word)),
126 ungated!(windows_subsystem, AssumedUsed, template!(NameValueStr: "windows|console")),
127 ungated!(panic_handler, Normal, template!(Word)), // RFC 2070
130 ungated!(inline, AssumedUsed, template!(Word, List: "always|never")),
131 ungated!(cold, AssumedUsed, template!(Word)),
132 ungated!(no_builtins, AssumedUsed, template!(Word)),
133 ungated!(target_feature, AssumedUsed, template!(List: r#"enable = "name""#)),
134 ungated!(track_caller, AssumedUsed, template!(Word)),
136 no_sanitize, AssumedUsed,
137 template!(List: "address, memory, thread"),
138 experimental!(no_sanitize)
141 // FIXME: #14408 assume docs are used since rustdoc looks at them.
142 ungated!(doc, AssumedUsed, template!(List: "hidden|inline|...", NameValueStr: "string")),
144 // ==========================================================================
145 // Unstable attributes:
146 // ==========================================================================
149 gated!(naked, AssumedUsed, template!(Word), naked_functions, experimental!(naked)),
151 link_args, Normal, template!(NameValueStr: "args"),
152 "the `link_args` attribute is experimental and not portable across platforms, \
153 it is recommended to use `#[link(name = \"foo\")] instead",
156 link_ordinal, AssumedUsed, template!(List: "ordinal"), raw_dylib,
157 experimental!(link_ordinal)
161 // XXX Modified for use in rust-analyzer
162 gated!(plugin_registrar),
166 gated!(allow_fail, Normal, template!(Word), experimental!(allow_fail)),
168 test_runner, CrateLevel, template!(List: "path"), custom_test_frameworks,
169 "custom test frameworks are an unstable feature",
172 gated!(marker, Normal, template!(Word), marker_trait_attr, experimental!(marker)),
174 thread_local, AssumedUsed, template!(Word),
175 "`#[thread_local]` is an experimental feature, and does not currently handle destructors",
177 gated!(no_core, CrateLevel, template!(Word), experimental!(no_core)),
180 optimize, AssumedUsed, template!(List: "size|speed"), optimize_attribute,
181 experimental!(optimize),
184 gated!(instruction_set, AssumedUsed, template!(List: "set"), isa_attribute, experimental!(instruction_set)),
186 gated!(ffi_returns_twice, AssumedUsed, template!(Word), experimental!(ffi_returns_twice)),
187 gated!(ffi_pure, AssumedUsed, template!(Word), experimental!(ffi_pure)),
188 gated!(ffi_const, AssumedUsed, template!(Word), experimental!(ffi_const)),
190 register_attr, CrateLevel, template!(List: "attr1, attr2, ..."),
191 experimental!(register_attr),
194 register_tool, CrateLevel, template!(List: "tool1, tool2, ..."),
195 experimental!(register_tool),
198 gated!(cmse_nonsecure_entry, AssumedUsed, template!(Word), experimental!(cmse_nonsecure_entry)),
200 // ==========================================================================
201 // Internal attributes: Stability, deprecation, and unsafe:
202 // ==========================================================================
204 ungated!(feature, CrateLevel, template!(List: "name1, name1, ...")),
205 // FIXME(#14407) -- only looked at on-demand so we can't
206 // guarantee they'll have already been checked.
208 rustc_deprecated, AssumedUsed,
209 template!(List: r#"since = "version", reason = "...""#)
212 ungated!(stable, AssumedUsed, template!(List: r#"feature = "name", since = "version""#)),
215 unstable, AssumedUsed,
216 template!(List: r#"feature = "name", reason = "...", issue = "N""#),
219 ungated!(rustc_const_unstable, AssumedUsed, template!(List: r#"feature = "name""#)),
221 ungated!(rustc_const_stable, AssumedUsed, template!(List: r#"feature = "name""#)),
223 allow_internal_unstable, AssumedUsed, template!(Word, List: "feat1, feat2, ..."),
224 "allow_internal_unstable side-steps feature gating and stability checks",
227 rustc_allow_const_fn_unstable, AssumedUsed, template!(Word, List: "feat1, feat2, ..."),
228 "rustc_allow_const_fn_unstable side-steps feature gating and stability checks"
231 allow_internal_unsafe, Normal, template!(Word),
232 "allow_internal_unsafe side-steps the unsafe_code lint",
235 // ==========================================================================
236 // Internal attributes: Type system related:
237 // ==========================================================================
239 gated!(fundamental, AssumedUsed, template!(Word), experimental!(fundamental)),
241 may_dangle, Normal, template!(Word), dropck_eyepatch,
242 "`may_dangle` has unstable semantics and may be removed in the future",
245 // ==========================================================================
246 // Internal attributes: Runtime related:
247 // ==========================================================================
249 rustc_attr!(rustc_allocator, AssumedUsed, template!(Word), IMPL_DETAIL),
250 rustc_attr!(rustc_allocator_nounwind, AssumedUsed, template!(Word), IMPL_DETAIL),
251 gated!(alloc_error_handler, Normal, template!(Word), experimental!(alloc_error_handler)),
253 default_lib_allocator, AssumedUsed, template!(Word), allocator_internals,
254 experimental!(default_lib_allocator),
257 needs_allocator, Normal, template!(Word), allocator_internals,
258 experimental!(needs_allocator),
260 gated!(panic_runtime, AssumedUsed, template!(Word), experimental!(panic_runtime)),
261 gated!(needs_panic_runtime, AssumedUsed, template!(Word), experimental!(needs_panic_runtime)),
263 unwind, AssumedUsed, template!(List: "allowed|aborts"), unwind_attributes,
264 experimental!(unwind),
267 compiler_builtins, AssumedUsed, template!(Word),
268 "the `#[compiler_builtins]` attribute is used to identify the `compiler_builtins` crate \
269 which contains compiler-rt intrinsics and will never be stable",
272 profiler_runtime, AssumedUsed, template!(Word),
273 "the `#[profiler_runtime]` attribute is used to identify the `profiler_builtins` crate \
274 which contains the profiler runtime and will never be stable",
277 // ==========================================================================
278 // Internal attributes, Linkage:
279 // ==========================================================================
282 linkage, AssumedUsed, template!(NameValueStr: "external|internal|..."),
283 "the `linkage` attribute is experimental and not portable across platforms",
285 rustc_attr!(rustc_std_internal_symbol, AssumedUsed, template!(Word), INTERNAL_UNSTABLE),
287 // ==========================================================================
288 // Internal attributes, Macro related:
289 // ==========================================================================
291 rustc_attr!(rustc_builtin_macro, AssumedUsed, template!(Word), IMPL_DETAIL),
292 rustc_attr!(rustc_proc_macro_decls, Normal, template!(Word), INTERNAL_UNSTABLE),
294 rustc_macro_transparency, AssumedUsed,
295 template!(NameValueStr: "transparent|semitransparent|opaque"),
296 "used internally for testing macro hygiene",
299 // ==========================================================================
300 // Internal attributes, Diagnostics related:
301 // ==========================================================================
304 rustc_on_unimplemented, AssumedUsed,
306 List: r#"/*opt*/ message = "...", /*opt*/ label = "...", /*opt*/ note = "...""#,
307 NameValueStr: "message"
311 // Enumerates "identity-like" conversion methods to suggest on type mismatch.
312 rustc_attr!(rustc_conversion_suggestion, AssumedUsed, template!(Word), INTERNAL_UNSTABLE),
314 // ==========================================================================
315 // Internal attributes, Const related:
316 // ==========================================================================
318 rustc_attr!(rustc_promotable, AssumedUsed, template!(Word), IMPL_DETAIL),
319 rustc_attr!(rustc_args_required_const, AssumedUsed, template!(List: "N"), INTERNAL_UNSTABLE),
321 // ==========================================================================
322 // Internal attributes, Layout related:
323 // ==========================================================================
326 rustc_layout_scalar_valid_range_start, AssumedUsed, template!(List: "value"),
327 "the `#[rustc_layout_scalar_valid_range_start]` attribute is just used to enable \
328 niche optimizations in libcore and will never be stable",
331 rustc_layout_scalar_valid_range_end, AssumedUsed, template!(List: "value"),
332 "the `#[rustc_layout_scalar_valid_range_end]` attribute is just used to enable \
333 niche optimizations in libcore and will never be stable",
336 rustc_nonnull_optimization_guaranteed, AssumedUsed, template!(Word),
337 "the `#[rustc_nonnull_optimization_guaranteed]` attribute is just used to enable \
338 niche optimizations in libcore and will never be stable",
341 // ==========================================================================
342 // Internal attributes, Misc:
343 // ==========================================================================
345 lang, Normal, template!(NameValueStr: "name"), lang_items,
346 "language items are subject to change",
348 gated!(rustc_diagnostic_item), // XXX modified in rust-analyzer
351 prelude_import, AssumedUsed, template!(Word),
352 "`#[prelude_import]` is for use by rustc only",
355 rustc_paren_sugar, Normal, template!(Word), unboxed_closures,
356 "unboxed_closures are still evolving",
359 rustc_inherit_overflow_checks, AssumedUsed, template!(Word),
360 "the `#[rustc_inherit_overflow_checks]` attribute is just used to control \
361 overflow checking behavior of several libcore functions that are inlined \
362 across crates and will never be stable",
364 rustc_attr!(rustc_reservation_impl, Normal, template!(NameValueStr: "reservation message"),
365 "the `#[rustc_reservation_impl]` attribute is internally used \
366 for reserving for `for<T> From<!> for T` impl"
369 rustc_test_marker, Normal, template!(Word),
370 "the `#[rustc_test_marker]` attribute is used internally to track tests",
373 rustc_unsafe_specialization_marker, Normal, template!(Word),
374 "the `#[rustc_unsafe_specialization_marker]` attribute is used to check specializations"
377 rustc_specialization_trait, Normal, template!(Word),
378 "the `#[rustc_specialization_trait]` attribute is used to check specializations"
381 // ==========================================================================
382 // Internal attributes, Testing:
383 // ==========================================================================
385 rustc_attr!(TEST, rustc_outlives, Normal, template!(Word)),
386 rustc_attr!(TEST, rustc_capture_analysis, Normal, template!(Word)),
387 rustc_attr!(TEST, rustc_variance, Normal, template!(Word)),
388 rustc_attr!(TEST, rustc_layout, Normal, template!(List: "field1, field2, ...")),
389 rustc_attr!(TEST, rustc_regions, Normal, template!(Word)),
391 TEST, rustc_error, AssumedUsed,
392 template!(Word, List: "delay_span_bug_from_inside_query")
394 rustc_attr!(TEST, rustc_dump_user_substs, AssumedUsed, template!(Word)),
395 rustc_attr!(TEST, rustc_if_this_changed, AssumedUsed, template!(Word, List: "DepNode")),
396 rustc_attr!(TEST, rustc_then_this_would_need, AssumedUsed, template!(List: "DepNode")),
398 TEST, rustc_dirty, AssumedUsed,
399 template!(List: r#"cfg = "...", /*opt*/ label = "...", /*opt*/ except = "...""#),
402 TEST, rustc_clean, AssumedUsed,
403 template!(List: r#"cfg = "...", /*opt*/ label = "...", /*opt*/ except = "...""#),
406 TEST, rustc_partition_reused, AssumedUsed,
407 template!(List: r#"cfg = "...", module = "...""#),
410 TEST, rustc_partition_codegened, AssumedUsed,
411 template!(List: r#"cfg = "...", module = "...""#),
414 TEST, rustc_expected_cgu_reuse, AssumedUsed,
415 template!(List: r#"cfg = "...", module = "...", kind = "...""#),
417 rustc_attr!(TEST, rustc_synthetic, AssumedUsed, template!(Word)),
418 rustc_attr!(TEST, rustc_symbol_name, AssumedUsed, template!(Word)),
419 rustc_attr!(TEST, rustc_polymorphize_error, AssumedUsed, template!(Word)),
420 rustc_attr!(TEST, rustc_def_path, AssumedUsed, template!(Word)),
421 rustc_attr!(TEST, rustc_mir, AssumedUsed, template!(List: "arg1, arg2, ...")),
422 rustc_attr!(TEST, rustc_dump_program_clauses, AssumedUsed, template!(Word)),
423 rustc_attr!(TEST, rustc_dump_env_program_clauses, AssumedUsed, template!(Word)),
424 rustc_attr!(TEST, rustc_object_lifetime_default, AssumedUsed, template!(Word)),
425 rustc_attr!(TEST, rustc_dummy, Normal, template!(Word /* doesn't matter*/)),
427 omit_gdb_pretty_printer_section, AssumedUsed, template!(Word),
428 "the `#[omit_gdb_pretty_printer_section]` attribute is just used for the Rust test suite",