1 //! This pass enforces various "well-formedness constraints" on impls.
2 //! Logically, it is part of wfcheck -- but we do it early so that we
3 //! can stop compilation afterwards, since part of the trait matching
4 //! infrastructure gets very grumpy if these conditions don't hold. In
5 //! particular, if there are type parameters that are not part of the
6 //! impl, then coherence will report strange inference ambiguity
7 //! errors; if impls have duplicate items, we get misleading
8 //! specialization errors. These things can (and probably should) be
9 //! fixed, but for the moment it's easier to do these checks early.
11 use crate::constrained_generic_params as cgp;
12 use min_specialization::check_min_specialization;
14 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
15 use rustc_errors::struct_span_err;
17 use rustc_hir::def_id::LocalDefId;
18 use rustc_hir::itemlikevisit::ItemLikeVisitor;
19 use rustc_middle::ty::query::Providers;
20 use rustc_middle::ty::{self, TyCtxt, TypeFoldable};
23 use std::collections::hash_map::Entry::{Occupied, Vacant};
25 mod min_specialization;
27 /// Checks that all the type/lifetime parameters on an impl also
28 /// appear in the trait ref or self type (or are constrained by a
29 /// where-clause). These rules are needed to ensure that, given a
30 /// trait ref like `<T as Trait<U>>`, we can derive the values of all
31 /// parameters on the impl (which is needed to make specialization
34 /// However, in the case of lifetimes, we only enforce these rules if
35 /// the lifetime parameter is used in an associated type. This is a
36 /// concession to backwards compatibility; see comment at the end of
37 /// the fn for details.
41 /// ```rust,ignore (pseudo-Rust)
42 /// impl<T> Trait<Foo> for Bar { ... }
43 /// // ^ T does not appear in `Foo` or `Bar`, error!
45 /// impl<T> Trait<Foo<T>> for Bar { ... }
46 /// // ^ T appears in `Foo<T>`, ok.
48 /// impl<T> Trait<Foo> for Bar where Bar: Iterator<Item = T> { ... }
49 /// // ^ T is bound to `<Bar as Iterator>::Item`, ok.
51 /// impl<'a> Trait<Foo> for Bar { }
52 /// // ^ 'a is unused, but for back-compat we allow it
54 /// impl<'a> Trait<Foo> for Bar { type X = &'a i32; }
55 /// // ^ 'a is unused and appears in assoc type, error
57 pub fn impl_wf_check(tcx: TyCtxt<'_>) {
58 // We will tag this as part of the WF check -- logically, it is,
59 // but it's one that we must perform earlier than the rest of
61 for &module in tcx.hir().krate().modules.keys() {
62 tcx.ensure().check_mod_impl_wf(tcx.hir().local_def_id(module));
66 fn check_mod_impl_wf(tcx: TyCtxt<'_>, module_def_id: LocalDefId) {
67 let min_specialization = tcx.features().min_specialization;
69 .visit_item_likes_in_module(module_def_id, &mut ImplWfCheck { tcx, min_specialization });
72 pub fn provide(providers: &mut Providers) {
73 *providers = Providers { check_mod_impl_wf, ..*providers };
76 struct ImplWfCheck<'tcx> {
78 min_specialization: bool,
81 impl ItemLikeVisitor<'tcx> for ImplWfCheck<'tcx> {
82 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
83 if let hir::ItemKind::Impl { ref items, .. } = item.kind {
84 let impl_def_id = self.tcx.hir().local_def_id(item.hir_id);
85 enforce_impl_params_are_constrained(self.tcx, impl_def_id, items);
86 enforce_impl_items_are_distinct(self.tcx, items);
87 if self.min_specialization {
88 check_min_specialization(self.tcx, impl_def_id.to_def_id(), item.span);
93 fn visit_trait_item(&mut self, _trait_item: &'tcx hir::TraitItem<'tcx>) {}
95 fn visit_impl_item(&mut self, _impl_item: &'tcx hir::ImplItem<'tcx>) {}
98 fn enforce_impl_params_are_constrained(
100 impl_def_id: LocalDefId,
101 impl_item_refs: &[hir::ImplItemRef<'_>],
103 // Every lifetime used in an associated type must be constrained.
104 let impl_self_ty = tcx.type_of(impl_def_id);
105 if impl_self_ty.references_error() {
106 // Don't complain about unconstrained type params when self ty isn't known due to errors.
108 tcx.sess.delay_span_bug(
109 tcx.def_span(impl_def_id),
111 "potentially unconstrained type parameters weren't evaluated: {:?}",
117 let impl_generics = tcx.generics_of(impl_def_id);
118 let impl_predicates = tcx.predicates_of(impl_def_id);
119 let impl_trait_ref = tcx.impl_trait_ref(impl_def_id);
121 let mut input_parameters = cgp::parameters_for_impl(impl_self_ty, impl_trait_ref);
122 cgp::identify_constrained_generic_params(
126 &mut input_parameters,
129 // Disallow unconstrained lifetimes, but only if they appear in assoc types.
130 let lifetimes_in_associated_types: FxHashSet<_> = impl_item_refs
132 .map(|item_ref| tcx.hir().local_def_id(item_ref.id.hir_id))
134 let item = tcx.associated_item(def_id);
136 ty::AssocKind::Type => {
137 if item.defaultness.has_value() {
138 cgp::parameters_for(&tcx.type_of(def_id), true)
143 ty::AssocKind::Fn | ty::AssocKind::Const => Vec::new(),
148 for param in &impl_generics.params {
150 // Disallow ANY unconstrained type parameters.
151 ty::GenericParamDefKind::Type { .. } => {
152 let param_ty = ty::ParamTy::for_def(param);
153 if !input_parameters.contains(&cgp::Parameter::from(param_ty)) {
154 report_unused_parameter(
156 tcx.def_span(param.def_id),
158 ¶m_ty.to_string(),
162 ty::GenericParamDefKind::Lifetime => {
163 let param_lt = cgp::Parameter::from(param.to_early_bound_region_data());
164 if lifetimes_in_associated_types.contains(¶m_lt) && // (*)
165 !input_parameters.contains(¶m_lt)
167 report_unused_parameter(
169 tcx.def_span(param.def_id),
171 ¶m.name.to_string(),
175 ty::GenericParamDefKind::Const => {
176 let param_ct = ty::ParamConst::for_def(param);
177 if !input_parameters.contains(&cgp::Parameter::from(param_ct)) {
178 report_unused_parameter(
180 tcx.def_span(param.def_id),
182 ¶m_ct.to_string(),
189 // (*) This is a horrible concession to reality. I think it'd be
190 // better to just ban unconstrianed lifetimes outright, but in
191 // practice people do non-hygenic macros like:
194 // macro_rules! __impl_slice_eq1 {
195 // ($Lhs: ty, $Rhs: ty, $Bound: ident) => {
196 // impl<'a, 'b, A: $Bound, B> PartialEq<$Rhs> for $Lhs where A: PartialEq<B> {
203 // In a concession to backwards compatibility, we continue to
204 // permit those, so long as the lifetimes aren't used in
205 // associated types. I believe this is sound, because lifetimes
206 // used elsewhere are not projected back out.
209 fn report_unused_parameter(tcx: TyCtxt<'_>, span: Span, kind: &str, name: &str) {
214 "the {} parameter `{}` is not constrained by the \
215 impl trait, self type, or predicates",
219 .span_label(span, format!("unconstrained {} parameter", kind))
223 /// Enforce that we do not have two items in an impl with the same name.
224 fn enforce_impl_items_are_distinct(tcx: TyCtxt<'_>, impl_item_refs: &[hir::ImplItemRef<'_>]) {
225 let mut seen_type_items = FxHashMap::default();
226 let mut seen_value_items = FxHashMap::default();
227 for impl_item_ref in impl_item_refs {
228 let impl_item = tcx.hir().impl_item(impl_item_ref.id);
229 let seen_items = match impl_item.kind {
230 hir::ImplItemKind::TyAlias(_) => &mut seen_type_items,
231 _ => &mut seen_value_items,
233 match seen_items.entry(impl_item.ident.normalize_to_macros_2_0()) {
235 let mut err = struct_span_err!(
239 "duplicate definitions with name `{}`:",
244 format!("previous definition of `{}` here", impl_item.ident),
246 err.span_label(impl_item.span, "duplicate definition");
250 entry.insert(impl_item.span);