]> git.lizzy.rs Git - rust.git/blob - src/librustc_ast_passes/feature_gate.rs
Rollup merge of #69645 - DutchGhost:const-forget-tests, r=Dylan-DPC
[rust.git] / src / librustc_ast_passes / feature_gate.rs
1 use rustc_ast::ast::{self, AssocTyConstraint, AssocTyConstraintKind, NodeId};
2 use rustc_ast::ast::{GenericParam, GenericParamKind, PatKind, RangeEnd, VariantData};
3 use rustc_ast::attr;
4 use rustc_ast::visit::{self, AssocCtxt, FnCtxt, FnKind, Visitor};
5 use rustc_errors::{struct_span_err, Handler};
6 use rustc_feature::{AttributeGate, BUILTIN_ATTRIBUTE_MAP};
7 use rustc_feature::{Features, GateIssue, UnstableFeatures};
8 use rustc_session::parse::{feature_err, feature_err_issue, ParseSess};
9 use rustc_span::source_map::Spanned;
10 use rustc_span::symbol::sym;
11 use rustc_span::Span;
12
13 use log::debug;
14
15 macro_rules! gate_feature_fn {
16     ($cx: expr, $has_feature: expr, $span: expr, $name: expr, $explain: expr) => {{
17         let (cx, has_feature, span, name, explain) = (&*$cx, $has_feature, $span, $name, $explain);
18         let has_feature: bool = has_feature(&$cx.features);
19         debug!("gate_feature(feature = {:?}, span = {:?}); has? {}", name, span, has_feature);
20         if !has_feature && !span.allows_unstable($name) {
21             feature_err_issue(cx.parse_sess, name, span, GateIssue::Language, explain).emit();
22         }
23     }};
24 }
25
26 macro_rules! gate_feature_post {
27     ($cx: expr, $feature: ident, $span: expr, $explain: expr) => {
28         gate_feature_fn!($cx, |x: &Features| x.$feature, $span, sym::$feature, $explain)
29     };
30 }
31
32 pub fn check_attribute(attr: &ast::Attribute, parse_sess: &ParseSess, features: &Features) {
33     PostExpansionVisitor { parse_sess, features }.visit_attribute(attr)
34 }
35
36 struct PostExpansionVisitor<'a> {
37     parse_sess: &'a ParseSess,
38     features: &'a Features,
39 }
40
41 impl<'a> PostExpansionVisitor<'a> {
42     fn check_abi(&self, abi: ast::StrLit) {
43         let ast::StrLit { symbol_unescaped, span, .. } = abi;
44
45         match &*symbol_unescaped.as_str() {
46             // Stable
47             "Rust" | "C" | "cdecl" | "stdcall" | "fastcall" | "aapcs" | "win64" | "sysv64"
48             | "system" => {}
49             "rust-intrinsic" => {
50                 gate_feature_post!(&self, intrinsics, span, "intrinsics are subject to change");
51             }
52             "platform-intrinsic" => {
53                 gate_feature_post!(
54                     &self,
55                     platform_intrinsics,
56                     span,
57                     "platform intrinsics are experimental and possibly buggy"
58                 );
59             }
60             "vectorcall" => {
61                 gate_feature_post!(
62                     &self,
63                     abi_vectorcall,
64                     span,
65                     "vectorcall is experimental and subject to change"
66                 );
67             }
68             "thiscall" => {
69                 gate_feature_post!(
70                     &self,
71                     abi_thiscall,
72                     span,
73                     "thiscall is experimental and subject to change"
74                 );
75             }
76             "rust-call" => {
77                 gate_feature_post!(
78                     &self,
79                     unboxed_closures,
80                     span,
81                     "rust-call ABI is subject to change"
82                 );
83             }
84             "ptx-kernel" => {
85                 gate_feature_post!(
86                     &self,
87                     abi_ptx,
88                     span,
89                     "PTX ABIs are experimental and subject to change"
90                 );
91             }
92             "unadjusted" => {
93                 gate_feature_post!(
94                     &self,
95                     abi_unadjusted,
96                     span,
97                     "unadjusted ABI is an implementation detail and perma-unstable"
98                 );
99             }
100             "msp430-interrupt" => {
101                 gate_feature_post!(
102                     &self,
103                     abi_msp430_interrupt,
104                     span,
105                     "msp430-interrupt ABI is experimental and subject to change"
106                 );
107             }
108             "x86-interrupt" => {
109                 gate_feature_post!(
110                     &self,
111                     abi_x86_interrupt,
112                     span,
113                     "x86-interrupt ABI is experimental and subject to change"
114                 );
115             }
116             "amdgpu-kernel" => {
117                 gate_feature_post!(
118                     &self,
119                     abi_amdgpu_kernel,
120                     span,
121                     "amdgpu-kernel ABI is experimental and subject to change"
122                 );
123             }
124             "efiapi" => {
125                 gate_feature_post!(
126                     &self,
127                     abi_efiapi,
128                     span,
129                     "efiapi ABI is experimental and subject to change"
130                 );
131             }
132             abi => self
133                 .parse_sess
134                 .span_diagnostic
135                 .delay_span_bug(span, &format!("unrecognized ABI not caught in lowering: {}", abi)),
136         }
137     }
138
139     fn check_extern(&self, ext: ast::Extern) {
140         if let ast::Extern::Explicit(abi) = ext {
141             self.check_abi(abi);
142         }
143     }
144
145     fn maybe_report_invalid_custom_discriminants(&self, variants: &[ast::Variant]) {
146         let has_fields = variants.iter().any(|variant| match variant.data {
147             VariantData::Tuple(..) | VariantData::Struct(..) => true,
148             VariantData::Unit(..) => false,
149         });
150
151         let discriminant_spans = variants
152             .iter()
153             .filter(|variant| match variant.data {
154                 VariantData::Tuple(..) | VariantData::Struct(..) => false,
155                 VariantData::Unit(..) => true,
156             })
157             .filter_map(|variant| variant.disr_expr.as_ref().map(|c| c.value.span))
158             .collect::<Vec<_>>();
159
160         if !discriminant_spans.is_empty() && has_fields {
161             let mut err = feature_err(
162                 self.parse_sess,
163                 sym::arbitrary_enum_discriminant,
164                 discriminant_spans.clone(),
165                 "custom discriminant values are not allowed in enums with tuple or struct variants",
166             );
167             for sp in discriminant_spans {
168                 err.span_label(sp, "disallowed custom discriminant");
169             }
170             for variant in variants.iter() {
171                 match &variant.data {
172                     VariantData::Struct(..) => {
173                         err.span_label(variant.span, "struct variant defined here");
174                     }
175                     VariantData::Tuple(..) => {
176                         err.span_label(variant.span, "tuple variant defined here");
177                     }
178                     VariantData::Unit(..) => {}
179                 }
180             }
181             err.emit();
182         }
183     }
184
185     fn check_gat(&self, generics: &ast::Generics, span: Span) {
186         if !generics.params.is_empty() {
187             gate_feature_post!(
188                 &self,
189                 generic_associated_types,
190                 span,
191                 "generic associated types are unstable"
192             );
193         }
194         if !generics.where_clause.predicates.is_empty() {
195             gate_feature_post!(
196                 &self,
197                 generic_associated_types,
198                 span,
199                 "where clauses on associated types are unstable"
200             );
201         }
202     }
203
204     /// Feature gate `impl Trait` inside `type Alias = $type_expr;`.
205     fn check_impl_trait(&self, ty: &ast::Ty) {
206         struct ImplTraitVisitor<'a> {
207             vis: &'a PostExpansionVisitor<'a>,
208         }
209         impl Visitor<'_> for ImplTraitVisitor<'_> {
210             fn visit_ty(&mut self, ty: &ast::Ty) {
211                 if let ast::TyKind::ImplTrait(..) = ty.kind {
212                     gate_feature_post!(
213                         &self.vis,
214                         type_alias_impl_trait,
215                         ty.span,
216                         "`impl Trait` in type aliases is unstable"
217                     );
218                 }
219                 visit::walk_ty(self, ty);
220             }
221         }
222         ImplTraitVisitor { vis: self }.visit_ty(ty);
223     }
224 }
225
226 impl<'a> Visitor<'a> for PostExpansionVisitor<'a> {
227     fn visit_attribute(&mut self, attr: &ast::Attribute) {
228         let attr_info =
229             attr.ident().and_then(|ident| BUILTIN_ATTRIBUTE_MAP.get(&ident.name)).map(|a| **a);
230         // Check feature gates for built-in attributes.
231         if let Some((.., AttributeGate::Gated(_, name, descr, has_feature))) = attr_info {
232             gate_feature_fn!(self, has_feature, attr.span, name, descr);
233         }
234         // Check unstable flavors of the `#[doc]` attribute.
235         if attr.check_name(sym::doc) {
236             for nested_meta in attr.meta_item_list().unwrap_or_default() {
237                 macro_rules! gate_doc { ($($name:ident => $feature:ident)*) => {
238                     $(if nested_meta.check_name(sym::$name) {
239                         let msg = concat!("`#[doc(", stringify!($name), ")]` is experimental");
240                         gate_feature_post!(self, $feature, attr.span, msg);
241                     })*
242                 }}
243
244                 gate_doc!(
245                     include => external_doc
246                     cfg => doc_cfg
247                     masked => doc_masked
248                     alias => doc_alias
249                     keyword => doc_keyword
250                 );
251             }
252         }
253     }
254
255     fn visit_name(&mut self, sp: Span, name: ast::Name) {
256         if !name.as_str().is_ascii() {
257             gate_feature_post!(
258                 &self,
259                 non_ascii_idents,
260                 self.parse_sess.source_map().def_span(sp),
261                 "non-ascii idents are not fully supported"
262             );
263         }
264     }
265
266     fn visit_item(&mut self, i: &'a ast::Item) {
267         match i.kind {
268             ast::ItemKind::ForeignMod(ref foreign_module) => {
269                 if let Some(abi) = foreign_module.abi {
270                     self.check_abi(abi);
271                 }
272             }
273
274             ast::ItemKind::Fn(..) => {
275                 if attr::contains_name(&i.attrs[..], sym::plugin_registrar) {
276                     gate_feature_post!(
277                         &self,
278                         plugin_registrar,
279                         i.span,
280                         "compiler plugins are experimental and possibly buggy"
281                     );
282                 }
283                 if attr::contains_name(&i.attrs[..], sym::start) {
284                     gate_feature_post!(
285                         &self,
286                         start,
287                         i.span,
288                         "`#[start]` functions are experimental \
289                                        and their signature may change \
290                                        over time"
291                     );
292                 }
293                 if attr::contains_name(&i.attrs[..], sym::main) {
294                     gate_feature_post!(
295                         &self,
296                         main,
297                         i.span,
298                         "declaration of a non-standard `#[main]` \
299                                         function may change over time, for now \
300                                         a top-level `fn main()` is required"
301                     );
302                 }
303             }
304
305             ast::ItemKind::Struct(..) => {
306                 for attr in attr::filter_by_name(&i.attrs[..], sym::repr) {
307                     for item in attr.meta_item_list().unwrap_or_else(Vec::new) {
308                         if item.check_name(sym::simd) {
309                             gate_feature_post!(
310                                 &self,
311                                 repr_simd,
312                                 attr.span,
313                                 "SIMD types are experimental and possibly buggy"
314                             );
315                         }
316                     }
317                 }
318             }
319
320             ast::ItemKind::Enum(ast::EnumDef { ref variants, .. }, ..) => {
321                 for variant in variants {
322                     match (&variant.data, &variant.disr_expr) {
323                         (ast::VariantData::Unit(..), _) => {}
324                         (_, Some(disr_expr)) => gate_feature_post!(
325                             &self,
326                             arbitrary_enum_discriminant,
327                             disr_expr.value.span,
328                             "discriminants on non-unit variants are experimental"
329                         ),
330                         _ => {}
331                     }
332                 }
333
334                 let has_feature = self.features.arbitrary_enum_discriminant;
335                 if !has_feature && !i.span.allows_unstable(sym::arbitrary_enum_discriminant) {
336                     self.maybe_report_invalid_custom_discriminants(&variants);
337                 }
338             }
339
340             ast::ItemKind::Impl { polarity, defaultness, .. } => {
341                 if polarity == ast::ImplPolarity::Negative {
342                     gate_feature_post!(
343                         &self,
344                         optin_builtin_traits,
345                         i.span,
346                         "negative trait bounds are not yet fully implemented; \
347                                         use marker types for now"
348                     );
349                 }
350
351                 if let ast::Defaultness::Default(_) = defaultness {
352                     gate_feature_post!(&self, specialization, i.span, "specialization is unstable");
353                 }
354             }
355
356             ast::ItemKind::Trait(ast::IsAuto::Yes, ..) => {
357                 gate_feature_post!(
358                     &self,
359                     optin_builtin_traits,
360                     i.span,
361                     "auto traits are experimental and possibly buggy"
362                 );
363             }
364
365             ast::ItemKind::TraitAlias(..) => {
366                 gate_feature_post!(&self, trait_alias, i.span, "trait aliases are experimental");
367             }
368
369             ast::ItemKind::MacroDef(ast::MacroDef { legacy: false, .. }) => {
370                 let msg = "`macro` is experimental";
371                 gate_feature_post!(&self, decl_macro, i.span, msg);
372             }
373
374             ast::ItemKind::TyAlias(_, _, _, Some(ref ty)) => self.check_impl_trait(&ty),
375
376             _ => {}
377         }
378
379         visit::walk_item(self, i);
380     }
381
382     fn visit_foreign_item(&mut self, i: &'a ast::ForeignItem) {
383         match i.kind {
384             ast::ForeignItemKind::Fn(..) | ast::ForeignItemKind::Static(..) => {
385                 let link_name = attr::first_attr_value_str_by_name(&i.attrs, sym::link_name);
386                 let links_to_llvm = match link_name {
387                     Some(val) => val.as_str().starts_with("llvm."),
388                     _ => false,
389                 };
390                 if links_to_llvm {
391                     gate_feature_post!(
392                         &self,
393                         link_llvm_intrinsics,
394                         i.span,
395                         "linking to LLVM intrinsics is experimental"
396                     );
397                 }
398             }
399             ast::ForeignItemKind::TyAlias(..) => {
400                 gate_feature_post!(&self, extern_types, i.span, "extern types are experimental");
401             }
402             ast::ForeignItemKind::Macro(..) => {}
403         }
404
405         visit::walk_foreign_item(self, i)
406     }
407
408     fn visit_ty(&mut self, ty: &'a ast::Ty) {
409         match ty.kind {
410             ast::TyKind::BareFn(ref bare_fn_ty) => {
411                 self.check_extern(bare_fn_ty.ext);
412             }
413             ast::TyKind::Never => {
414                 gate_feature_post!(&self, never_type, ty.span, "the `!` type is experimental");
415             }
416             _ => {}
417         }
418         visit::walk_ty(self, ty)
419     }
420
421     fn visit_fn_ret_ty(&mut self, ret_ty: &'a ast::FnRetTy) {
422         if let ast::FnRetTy::Ty(ref output_ty) = *ret_ty {
423             if let ast::TyKind::Never = output_ty.kind {
424                 // Do nothing.
425             } else {
426                 self.visit_ty(output_ty)
427             }
428         }
429     }
430
431     fn visit_expr(&mut self, e: &'a ast::Expr) {
432         match e.kind {
433             ast::ExprKind::Box(_) => {
434                 gate_feature_post!(
435                     &self,
436                     box_syntax,
437                     e.span,
438                     "box expression syntax is experimental; you can call `Box::new` instead"
439                 );
440             }
441             ast::ExprKind::Type(..) => {
442                 // To avoid noise about type ascription in common syntax errors, only emit if it
443                 // is the *only* error.
444                 if self.parse_sess.span_diagnostic.err_count() == 0 {
445                     gate_feature_post!(
446                         &self,
447                         type_ascription,
448                         e.span,
449                         "type ascription is experimental"
450                     );
451                 }
452             }
453             ast::ExprKind::TryBlock(_) => {
454                 gate_feature_post!(&self, try_blocks, e.span, "`try` expression is experimental");
455             }
456             ast::ExprKind::Block(_, opt_label) => {
457                 if let Some(label) = opt_label {
458                     gate_feature_post!(
459                         &self,
460                         label_break_value,
461                         label.ident.span,
462                         "labels on blocks are unstable"
463                     );
464                 }
465             }
466             _ => {}
467         }
468         visit::walk_expr(self, e)
469     }
470
471     fn visit_pat(&mut self, pattern: &'a ast::Pat) {
472         match &pattern.kind {
473             PatKind::Box(..) => {
474                 gate_feature_post!(
475                     &self,
476                     box_patterns,
477                     pattern.span,
478                     "box pattern syntax is experimental"
479                 );
480             }
481             PatKind::Range(_, _, Spanned { node: RangeEnd::Excluded, .. }) => {
482                 gate_feature_post!(
483                     &self,
484                     exclusive_range_pattern,
485                     pattern.span,
486                     "exclusive range pattern syntax is experimental"
487                 );
488             }
489             _ => {}
490         }
491         visit::walk_pat(self, pattern)
492     }
493
494     fn visit_fn(&mut self, fn_kind: FnKind<'a>, span: Span, _: NodeId) {
495         if let Some(header) = fn_kind.header() {
496             // Stability of const fn methods are covered in `visit_assoc_item` below.
497             self.check_extern(header.ext);
498
499             if let (ast::Const::Yes(_), ast::Extern::Implicit)
500             | (ast::Const::Yes(_), ast::Extern::Explicit(_)) = (header.constness, header.ext)
501             {
502                 gate_feature_post!(
503                     &self,
504                     const_extern_fn,
505                     span,
506                     "`const extern fn` definitions are unstable"
507                 );
508             }
509         }
510
511         if fn_kind.ctxt() != Some(FnCtxt::Foreign) && fn_kind.decl().c_variadic() {
512             gate_feature_post!(&self, c_variadic, span, "C-variadic functions are unstable");
513         }
514
515         visit::walk_fn(self, fn_kind, span)
516     }
517
518     fn visit_generic_param(&mut self, param: &'a GenericParam) {
519         match param.kind {
520             GenericParamKind::Const { .. } => gate_feature_post!(
521                 &self,
522                 const_generics,
523                 param.ident.span,
524                 "const generics are unstable"
525             ),
526             _ => {}
527         }
528         visit::walk_generic_param(self, param)
529     }
530
531     fn visit_assoc_ty_constraint(&mut self, constraint: &'a AssocTyConstraint) {
532         match constraint.kind {
533             AssocTyConstraintKind::Bound { .. } => gate_feature_post!(
534                 &self,
535                 associated_type_bounds,
536                 constraint.span,
537                 "associated type bounds are unstable"
538             ),
539             _ => {}
540         }
541         visit::walk_assoc_ty_constraint(self, constraint)
542     }
543
544     fn visit_assoc_item(&mut self, i: &'a ast::AssocItem, ctxt: AssocCtxt) {
545         if let ast::Defaultness::Default(_) = i.kind.defaultness() {
546             gate_feature_post!(&self, specialization, i.span, "specialization is unstable");
547         }
548
549         match i.kind {
550             ast::AssocItemKind::Fn(_, ref sig, _, _) => {
551                 if let (ast::Const::Yes(_), AssocCtxt::Trait) = (sig.header.constness, ctxt) {
552                     gate_feature_post!(&self, const_fn, i.span, "const fn is unstable");
553                 }
554             }
555             ast::AssocItemKind::TyAlias(_, ref generics, _, ref ty) => {
556                 if let (Some(_), AssocCtxt::Trait) = (ty, ctxt) {
557                     gate_feature_post!(
558                         &self,
559                         associated_type_defaults,
560                         i.span,
561                         "associated type defaults are unstable"
562                     );
563                 }
564                 if let Some(ty) = ty {
565                     self.check_impl_trait(ty);
566                 }
567                 self.check_gat(generics, i.span);
568             }
569             _ => {}
570         }
571         visit::walk_assoc_item(self, i, ctxt)
572     }
573
574     fn visit_vis(&mut self, vis: &'a ast::Visibility) {
575         if let ast::VisibilityKind::Crate(ast::CrateSugar::JustCrate) = vis.node {
576             gate_feature_post!(
577                 &self,
578                 crate_visibility_modifier,
579                 vis.span,
580                 "`crate` visibility modifier is experimental"
581             );
582         }
583         visit::walk_vis(self, vis)
584     }
585 }
586
587 pub fn check_crate(
588     krate: &ast::Crate,
589     parse_sess: &ParseSess,
590     features: &Features,
591     unstable: UnstableFeatures,
592 ) {
593     maybe_stage_features(&parse_sess.span_diagnostic, krate, unstable);
594     let mut visitor = PostExpansionVisitor { parse_sess, features };
595
596     let spans = parse_sess.gated_spans.spans.borrow();
597     macro_rules! gate_all {
598         ($gate:ident, $msg:literal) => {
599             for span in spans.get(&sym::$gate).unwrap_or(&vec![]) {
600                 gate_feature_post!(&visitor, $gate, *span, $msg);
601             }
602         };
603     }
604     gate_all!(let_chains, "`let` expressions in this position are experimental");
605     gate_all!(async_closure, "async closures are unstable");
606     gate_all!(generators, "yield syntax is experimental");
607     gate_all!(or_patterns, "or-patterns syntax is experimental");
608     gate_all!(raw_ref_op, "raw address of syntax is experimental");
609     gate_all!(const_trait_bound_opt_out, "`?const` on trait bounds is experimental");
610     gate_all!(const_trait_impl, "const trait impls are experimental");
611     gate_all!(half_open_range_patterns, "half-open range patterns are unstable");
612
613     // All uses of `gate_all!` below this point were added in #65742,
614     // and subsequently disabled (with the non-early gating readded).
615     macro_rules! gate_all {
616         ($gate:ident, $msg:literal) => {
617             // FIXME(eddyb) do something more useful than always
618             // disabling these uses of early feature-gatings.
619             if false {
620                 for span in spans.get(&sym::$gate).unwrap_or(&vec![]) {
621                     gate_feature_post!(&visitor, $gate, *span, $msg);
622                 }
623             }
624         };
625     }
626
627     gate_all!(trait_alias, "trait aliases are experimental");
628     gate_all!(associated_type_bounds, "associated type bounds are unstable");
629     gate_all!(crate_visibility_modifier, "`crate` visibility modifier is experimental");
630     gate_all!(const_generics, "const generics are unstable");
631     gate_all!(decl_macro, "`macro` is experimental");
632     gate_all!(box_patterns, "box pattern syntax is experimental");
633     gate_all!(exclusive_range_pattern, "exclusive range pattern syntax is experimental");
634     gate_all!(try_blocks, "`try` blocks are unstable");
635     gate_all!(label_break_value, "labels on blocks are unstable");
636     gate_all!(box_syntax, "box expression syntax is experimental; you can call `Box::new` instead");
637     // To avoid noise about type ascription in common syntax errors,
638     // only emit if it is the *only* error. (Also check it last.)
639     if parse_sess.span_diagnostic.err_count() == 0 {
640         gate_all!(type_ascription, "type ascription is experimental");
641     }
642
643     visit::walk_crate(&mut visitor, krate);
644 }
645
646 fn maybe_stage_features(span_handler: &Handler, krate: &ast::Crate, unstable: UnstableFeatures) {
647     if !unstable.is_nightly_build() {
648         for attr in krate.attrs.iter().filter(|attr| attr.check_name(sym::feature)) {
649             struct_span_err!(
650                 span_handler,
651                 attr.span,
652                 E0554,
653                 "`#![feature]` may not be used on the {} release channel",
654                 option_env!("CFG_RELEASE_CHANNEL").unwrap_or("(unknown)")
655             )
656             .emit();
657         }
658     }
659 }