1 //! See Rustc Dev Guide chapters on [trait-resolution] and [trait-specialization] for more info on
4 //! [trait-resolution]: https://rustc-dev-guide.rust-lang.org/traits/resolution.html
5 //! [trait-specialization]: https://rustc-dev-guide.rust-lang.org/traits/specialization.html
7 use crate::infer::{CombinedSnapshot, InferOk, TyCtxtInferExt};
8 use crate::traits::query::evaluate_obligation::InferCtxtExt;
9 use crate::traits::select::IntercrateAmbiguityCause;
10 use crate::traits::SkipLeakCheck;
12 self, Normalized, Obligation, ObligationCause, PredicateObligation, SelectionContext,
14 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
15 use rustc_middle::ty::fast_reject::{self, SimplifyParams, StripReferences};
16 use rustc_middle::ty::fold::TypeFoldable;
17 use rustc_middle::ty::subst::Subst;
18 use rustc_middle::ty::{self, Ty, TyCtxt};
19 use rustc_span::symbol::sym;
20 use rustc_span::DUMMY_SP;
23 /// Whether we do the orphan check relative to this crate or
24 /// to some remote crate.
25 #[derive(Copy, Clone, Debug)]
31 #[derive(Debug, Copy, Clone)]
37 pub struct OverlapResult<'tcx> {
38 pub impl_header: ty::ImplHeader<'tcx>,
39 pub intercrate_ambiguity_causes: Vec<IntercrateAmbiguityCause>,
41 /// `true` if the overlap might've been permitted before the shift
43 pub involves_placeholder: bool,
46 pub fn add_placeholder_note(err: &mut rustc_errors::DiagnosticBuilder<'_>) {
48 "this behavior recently changed as a result of a bug fix; \
49 see rust-lang/rust#56105 for details",
53 /// If there are types that satisfy both impls, invokes `on_overlap`
54 /// with a suitably-freshened `ImplHeader` with those types
55 /// substituted. Otherwise, invokes `no_overlap`.
56 pub fn overlapping_impls<F1, F2, R>(
60 skip_leak_check: SkipLeakCheck,
65 F1: FnOnce(OverlapResult<'_>) -> R,
72 impl1_def_id, impl2_def_id,
74 // Before doing expensive operations like entering an inference context, do
75 // a quick check via fast_reject to tell if the impl headers could possibly
77 let impl1_ref = tcx.impl_trait_ref(impl1_def_id);
78 let impl2_ref = tcx.impl_trait_ref(impl2_def_id);
80 // Check if any of the input types definitely do not unify.
82 impl1_ref.iter().flat_map(|tref| tref.substs.types()),
83 impl2_ref.iter().flat_map(|tref| tref.substs.types()),
86 let t1 = fast_reject::simplify_type(tcx, ty1, SimplifyParams::No, StripReferences::No);
87 let t2 = fast_reject::simplify_type(tcx, ty2, SimplifyParams::No, StripReferences::No);
88 if let (Some(t1), Some(t2)) = (t1, t2) {
89 // Simplified successfully
96 // Some types involved are definitely different, so the impls couldn't possibly overlap.
97 debug!("overlapping_impls: fast_reject early-exit");
101 let overlaps = tcx.infer_ctxt().enter(|infcx| {
102 let selcx = &mut SelectionContext::intercrate(&infcx);
103 overlap(selcx, skip_leak_check, impl1_def_id, impl2_def_id).is_some()
110 // In the case where we detect an error, run the check again, but
111 // this time tracking intercrate ambuiguity causes for better
112 // diagnostics. (These take time and can lead to false errors.)
113 tcx.infer_ctxt().enter(|infcx| {
114 let selcx = &mut SelectionContext::intercrate(&infcx);
115 selcx.enable_tracking_intercrate_ambiguity_causes();
116 on_overlap(overlap(selcx, skip_leak_check, impl1_def_id, impl2_def_id).unwrap())
120 fn with_fresh_ty_vars<'cx, 'tcx>(
121 selcx: &mut SelectionContext<'cx, 'tcx>,
122 param_env: ty::ParamEnv<'tcx>,
124 ) -> ty::ImplHeader<'tcx> {
125 let tcx = selcx.tcx();
126 let impl_substs = selcx.infcx().fresh_substs_for_item(DUMMY_SP, impl_def_id);
128 let header = ty::ImplHeader {
130 self_ty: tcx.type_of(impl_def_id).subst(tcx, impl_substs),
131 trait_ref: tcx.impl_trait_ref(impl_def_id).subst(tcx, impl_substs),
132 predicates: tcx.predicates_of(impl_def_id).instantiate(tcx, impl_substs).predicates,
135 let Normalized { value: mut header, obligations } =
136 traits::normalize(selcx, param_env, ObligationCause::dummy(), header);
138 header.predicates.extend(obligations.into_iter().map(|o| o.predicate));
142 /// Can both impl `a` and impl `b` be satisfied by a common type (including
143 /// where-clauses)? If so, returns an `ImplHeader` that unifies the two impls.
144 fn overlap<'cx, 'tcx>(
145 selcx: &mut SelectionContext<'cx, 'tcx>,
146 skip_leak_check: SkipLeakCheck,
149 ) -> Option<OverlapResult<'tcx>> {
150 debug!("overlap(a_def_id={:?}, b_def_id={:?})", a_def_id, b_def_id);
152 selcx.infcx().probe_maybe_skip_leak_check(skip_leak_check.is_yes(), |snapshot| {
153 overlap_within_probe(selcx, skip_leak_check, a_def_id, b_def_id, snapshot)
157 fn overlap_within_probe<'cx, 'tcx>(
158 selcx: &mut SelectionContext<'cx, 'tcx>,
159 skip_leak_check: SkipLeakCheck,
162 snapshot: &CombinedSnapshot<'_, 'tcx>,
163 ) -> Option<OverlapResult<'tcx>> {
164 fn loose_check<'cx, 'tcx>(
165 selcx: &mut SelectionContext<'cx, 'tcx>,
166 o: &PredicateObligation<'tcx>,
168 !selcx.predicate_may_hold_fatal(o)
171 fn strict_check<'cx, 'tcx>(
172 selcx: &SelectionContext<'cx, 'tcx>,
173 o: &PredicateObligation<'tcx>,
175 let infcx = selcx.infcx();
179 .map(|o| selcx.infcx().predicate_must_hold_modulo_regions(o))
183 // For the purposes of this check, we don't bring any placeholder
184 // types into scope; instead, we replace the generic types with
185 // fresh type variables, and hence we do our evaluations in an
186 // empty environment.
187 let param_env = ty::ParamEnv::empty();
189 let a_impl_header = with_fresh_ty_vars(selcx, param_env, a_def_id);
190 let b_impl_header = with_fresh_ty_vars(selcx, param_env, b_def_id);
192 debug!("overlap: a_impl_header={:?}", a_impl_header);
193 debug!("overlap: b_impl_header={:?}", b_impl_header);
195 // Do `a` and `b` unify? If not, no overlap.
196 let obligations = match selcx
198 .at(&ObligationCause::dummy(), param_env)
199 .eq_impl_headers(&a_impl_header, &b_impl_header)
201 Ok(InferOk { obligations, value: () }) => obligations,
207 debug!("overlap: unification check succeeded");
209 // There's no overlap if obligations are unsatisfiable or if the obligation negated is
212 // For example, given these two impl headers:
214 // `impl<'a> From<&'a str> for Box<dyn Error>`
215 // `impl<E> From<E> for Box<dyn Error> where E: Error`
219 // `Box<dyn Error>: From<&'?a str>`
220 // `Box<dyn Error>: From<?E>`
222 // After equating the two headers:
224 // `Box<dyn Error> = Box<dyn Error>`
225 // So, `?E = &'?a str` and then given the where clause `&'?a str: Error`.
227 // If the obligation `&'?a str: Error` holds, it means that there's overlap. If that doesn't
228 // hold we need to check if `&'?a str: !Error` holds, if doesn't hold there's overlap because
229 // at some point an impl for `&'?a str: Error` could be added.
230 let infcx = selcx.infcx();
232 let opt_failing_obligation = a_impl_header
236 .chain(b_impl_header.predicates)
237 .map(|p| infcx.resolve_vars_if_possible(p))
238 .map(|p| Obligation {
239 cause: ObligationCause::dummy(),
246 // if both impl headers are set to strict coherence it means that this will be accepted
247 // only if it's stated that T: !Trait. So only prove that the negated obligation holds.
248 if tcx.has_attr(a_def_id, sym::rustc_strict_coherence)
249 && tcx.has_attr(b_def_id, sym::rustc_strict_coherence)
251 strict_check(selcx, o)
253 loose_check(selcx, o) || tcx.features().negative_impls && strict_check(selcx, o)
256 // FIXME: the call to `selcx.predicate_may_hold_fatal` above should be ported
257 // to the canonical trait query form, `infcx.predicate_may_hold`, once
258 // the new system supports intercrate mode (which coherence needs).
260 if let Some(failing_obligation) = opt_failing_obligation {
261 debug!("overlap: obligation unsatisfiable {:?}", failing_obligation);
265 if !skip_leak_check.is_yes() {
266 if infcx.leak_check(true, snapshot).is_err() {
267 debug!("overlap: leak check failed");
272 let impl_header = selcx.infcx().resolve_vars_if_possible(a_impl_header);
273 let intercrate_ambiguity_causes = selcx.take_intercrate_ambiguity_causes();
274 debug!("overlap: intercrate_ambiguity_causes={:#?}", intercrate_ambiguity_causes);
276 let involves_placeholder =
277 matches!(selcx.infcx().region_constraints_added_in_snapshot(snapshot), Some(true));
279 Some(OverlapResult { impl_header, intercrate_ambiguity_causes, involves_placeholder })
282 pub fn trait_ref_is_knowable<'tcx>(
284 trait_ref: ty::TraitRef<'tcx>,
285 ) -> Option<Conflict> {
286 debug!("trait_ref_is_knowable(trait_ref={:?})", trait_ref);
287 if orphan_check_trait_ref(tcx, trait_ref, InCrate::Remote).is_ok() {
288 // A downstream or cousin crate is allowed to implement some
289 // substitution of this trait-ref.
290 return Some(Conflict::Downstream);
293 if trait_ref_is_local_or_fundamental(tcx, trait_ref) {
294 // This is a local or fundamental trait, so future-compatibility
295 // is no concern. We know that downstream/cousin crates are not
296 // allowed to implement a substitution of this trait ref, which
297 // means impls could only come from dependencies of this crate,
298 // which we already know about.
302 // This is a remote non-fundamental trait, so if another crate
303 // can be the "final owner" of a substitution of this trait-ref,
304 // they are allowed to implement it future-compatibly.
306 // However, if we are a final owner, then nobody else can be,
307 // and if we are an intermediate owner, then we don't care
308 // about future-compatibility, which means that we're OK if
310 if orphan_check_trait_ref(tcx, trait_ref, InCrate::Local).is_ok() {
311 debug!("trait_ref_is_knowable: orphan check passed");
314 debug!("trait_ref_is_knowable: nonlocal, nonfundamental, unowned");
315 Some(Conflict::Upstream)
319 pub fn trait_ref_is_local_or_fundamental<'tcx>(
321 trait_ref: ty::TraitRef<'tcx>,
323 trait_ref.def_id.krate == LOCAL_CRATE || tcx.has_attr(trait_ref.def_id, sym::fundamental)
326 pub enum OrphanCheckErr<'tcx> {
327 NonLocalInputType(Vec<(Ty<'tcx>, bool /* Is this the first input type? */)>),
328 UncoveredTy(Ty<'tcx>, Option<Ty<'tcx>>),
331 /// Checks the coherence orphan rules. `impl_def_id` should be the
332 /// `DefId` of a trait impl. To pass, either the trait must be local, or else
333 /// two conditions must be satisfied:
335 /// 1. All type parameters in `Self` must be "covered" by some local type constructor.
336 /// 2. Some local type must appear in `Self`.
337 pub fn orphan_check(tcx: TyCtxt<'_>, impl_def_id: DefId) -> Result<(), OrphanCheckErr<'_>> {
338 debug!("orphan_check({:?})", impl_def_id);
340 // We only except this routine to be invoked on implementations
341 // of a trait, not inherent implementations.
342 let trait_ref = tcx.impl_trait_ref(impl_def_id).unwrap();
343 debug!("orphan_check: trait_ref={:?}", trait_ref);
345 // If the *trait* is local to the crate, ok.
346 if trait_ref.def_id.is_local() {
347 debug!("trait {:?} is local to current crate", trait_ref.def_id);
351 orphan_check_trait_ref(tcx, trait_ref, InCrate::Local)
354 /// Checks whether a trait-ref is potentially implementable by a crate.
356 /// The current rule is that a trait-ref orphan checks in a crate C:
358 /// 1. Order the parameters in the trait-ref in subst order - Self first,
359 /// others linearly (e.g., `<U as Foo<V, W>>` is U < V < W).
360 /// 2. Of these type parameters, there is at least one type parameter
361 /// in which, walking the type as a tree, you can reach a type local
362 /// to C where all types in-between are fundamental types. Call the
363 /// first such parameter the "local key parameter".
364 /// - e.g., `Box<LocalType>` is OK, because you can visit LocalType
365 /// going through `Box`, which is fundamental.
366 /// - similarly, `FundamentalPair<Vec<()>, Box<LocalType>>` is OK for
368 /// - but (knowing that `Vec<T>` is non-fundamental, and assuming it's
369 /// not local), `Vec<LocalType>` is bad, because `Vec<->` is between
370 /// the local type and the type parameter.
371 /// 3. Before this local type, no generic type parameter of the impl must
372 /// be reachable through fundamental types.
373 /// - e.g. `impl<T> Trait<LocalType> for Vec<T>` is fine, as `Vec` is not fundamental.
374 /// - while `impl<T> Trait<LocalType for Box<T>` results in an error, as `T` is
375 /// reachable through the fundamental type `Box`.
376 /// 4. Every type in the local key parameter not known in C, going
377 /// through the parameter's type tree, must appear only as a subtree of
378 /// a type local to C, with only fundamental types between the type
379 /// local to C and the local key parameter.
380 /// - e.g., `Vec<LocalType<T>>>` (or equivalently `Box<Vec<LocalType<T>>>`)
381 /// is bad, because the only local type with `T` as a subtree is
382 /// `LocalType<T>`, and `Vec<->` is between it and the type parameter.
383 /// - similarly, `FundamentalPair<LocalType<T>, T>` is bad, because
384 /// the second occurrence of `T` is not a subtree of *any* local type.
385 /// - however, `LocalType<Vec<T>>` is OK, because `T` is a subtree of
386 /// `LocalType<Vec<T>>`, which is local and has no types between it and
387 /// the type parameter.
389 /// The orphan rules actually serve several different purposes:
391 /// 1. They enable link-safety - i.e., 2 mutually-unknowing crates (where
392 /// every type local to one crate is unknown in the other) can't implement
393 /// the same trait-ref. This follows because it can be seen that no such
394 /// type can orphan-check in 2 such crates.
396 /// To check that a local impl follows the orphan rules, we check it in
397 /// InCrate::Local mode, using type parameters for the "generic" types.
399 /// 2. They ground negative reasoning for coherence. If a user wants to
400 /// write both a conditional blanket impl and a specific impl, we need to
401 /// make sure they do not overlap. For example, if we write
403 /// impl<T> IntoIterator for Vec<T>
404 /// impl<T: Iterator> IntoIterator for T
406 /// We need to be able to prove that `Vec<$0>: !Iterator` for every type $0.
407 /// We can observe that this holds in the current crate, but we need to make
408 /// sure this will also hold in all unknown crates (both "independent" crates,
409 /// which we need for link-safety, and also child crates, because we don't want
410 /// child crates to get error for impl conflicts in a *dependency*).
412 /// For that, we only allow negative reasoning if, for every assignment to the
413 /// inference variables, every unknown crate would get an orphan error if they
414 /// try to implement this trait-ref. To check for this, we use InCrate::Remote
415 /// mode. That is sound because we already know all the impls from known crates.
417 /// 3. For non-`#[fundamental]` traits, they guarantee that parent crates can
418 /// add "non-blanket" impls without breaking negative reasoning in dependent
419 /// crates. This is the "rebalancing coherence" (RFC 1023) restriction.
421 /// For that, we only a allow crate to perform negative reasoning on
422 /// non-local-non-`#[fundamental]` only if there's a local key parameter as per (2).
424 /// Because we never perform negative reasoning generically (coherence does
425 /// not involve type parameters), this can be interpreted as doing the full
426 /// orphan check (using InCrate::Local mode), substituting non-local known
427 /// types for all inference variables.
429 /// This allows for crates to future-compatibly add impls as long as they
430 /// can't apply to types with a key parameter in a child crate - applying
431 /// the rules, this basically means that every type parameter in the impl
432 /// must appear behind a non-fundamental type (because this is not a
433 /// type-system requirement, crate owners might also go for "semantic
434 /// future-compatibility" involving things such as sealed traits, but
435 /// the above requirement is sufficient, and is necessary in "open world"
438 /// Note that this function is never called for types that have both type
439 /// parameters and inference variables.
440 fn orphan_check_trait_ref<'tcx>(
442 trait_ref: ty::TraitRef<'tcx>,
444 ) -> Result<(), OrphanCheckErr<'tcx>> {
445 debug!("orphan_check_trait_ref(trait_ref={:?}, in_crate={:?})", trait_ref, in_crate);
447 if trait_ref.needs_infer() && trait_ref.definitely_needs_subst(tcx) {
449 "can't orphan check a trait ref with both params and inference variables {:?}",
454 // Given impl<P1..=Pn> Trait<T1..=Tn> for T0, an impl is valid only
455 // if at least one of the following is true:
457 // - Trait is a local trait
458 // (already checked in orphan_check prior to calling this function)
460 // - At least one of the types T0..=Tn must be a local type.
461 // Let Ti be the first such type.
462 // - No uncovered type parameters P1..=Pn may appear in T0..Ti (excluding Ti)
464 fn uncover_fundamental_ty<'tcx>(
469 // FIXME: this is currently somewhat overly complicated,
470 // but fixing this requires a more complicated refactor.
471 if !contained_non_local_types(tcx, ty, in_crate).is_empty() {
472 if let Some(inner_tys) = fundamental_ty_inner_tys(tcx, ty) {
474 .flat_map(|ty| uncover_fundamental_ty(tcx, ty, in_crate))
482 let mut non_local_spans = vec![];
483 for (i, input_ty) in trait_ref
486 .flat_map(|ty| uncover_fundamental_ty(tcx, ty, in_crate))
489 debug!("orphan_check_trait_ref: check ty `{:?}`", input_ty);
490 let non_local_tys = contained_non_local_types(tcx, input_ty, in_crate);
491 if non_local_tys.is_empty() {
492 debug!("orphan_check_trait_ref: ty_is_local `{:?}`", input_ty);
494 } else if let ty::Param(_) = input_ty.kind() {
495 debug!("orphan_check_trait_ref: uncovered ty: `{:?}`", input_ty);
496 let local_type = trait_ref
499 .flat_map(|ty| uncover_fundamental_ty(tcx, ty, in_crate))
500 .find(|ty| ty_is_local_constructor(ty, in_crate));
502 debug!("orphan_check_trait_ref: uncovered ty local_type: `{:?}`", local_type);
504 return Err(OrphanCheckErr::UncoveredTy(input_ty, local_type));
507 non_local_spans.extend(non_local_tys.into_iter().map(|input_ty| (input_ty, i == 0)));
509 // If we exit above loop, never found a local type.
510 debug!("orphan_check_trait_ref: no local type");
511 Err(OrphanCheckErr::NonLocalInputType(non_local_spans))
514 /// Returns a list of relevant non-local types for `ty`.
516 /// This is just `ty` itself unless `ty` is `#[fundamental]`,
517 /// in which case we recursively look into this type.
519 /// If `ty` is local itself, this method returns an empty `Vec`.
523 /// - `u32` is not local, so this returns `[u32]`.
524 /// - for `Foo<u32>`, where `Foo` is a local type, this returns `[]`.
525 /// - `&mut u32` returns `[u32]`, as `&mut` is a fundamental type, similar to `Box`.
526 /// - `Box<Foo<u32>>` returns `[]`, as `Box` is a fundamental type and `Foo` is local.
527 fn contained_non_local_types<'tcx>(
532 if ty_is_local_constructor(ty, in_crate) {
535 match fundamental_ty_inner_tys(tcx, ty) {
537 inner_tys.flat_map(|ty| contained_non_local_types(tcx, ty, in_crate)).collect()
544 /// For `#[fundamental]` ADTs and `&T` / `&mut T`, returns `Some` with the
545 /// type parameters of the ADT, or `T`, respectively. For non-fundamental
546 /// types, returns `None`.
547 fn fundamental_ty_inner_tys<'tcx>(
550 ) -> Option<impl Iterator<Item = Ty<'tcx>>> {
551 let (first_ty, rest_tys) = match *ty.kind() {
552 ty::Ref(_, ty, _) => (ty, ty::subst::InternalSubsts::empty().types()),
553 ty::Adt(def, substs) if def.is_fundamental() => {
554 let mut types = substs.types();
556 // FIXME(eddyb) actually validate `#[fundamental]` up-front.
560 tcx.def_span(def.did),
561 "`#[fundamental]` requires at least one type parameter",
567 Some(first_ty) => (first_ty, types),
573 Some(iter::once(first_ty).chain(rest_tys))
576 fn def_id_is_local(def_id: DefId, in_crate: InCrate) -> bool {
578 // The type is local to *this* crate - it will not be
579 // local in any other crate.
580 InCrate::Remote => false,
581 InCrate::Local => def_id.is_local(),
585 fn ty_is_local_constructor(ty: Ty<'_>, in_crate: InCrate) -> bool {
586 debug!("ty_is_local_constructor({:?})", ty);
604 | ty::Projection(..) => false,
606 ty::Placeholder(..) | ty::Bound(..) | ty::Infer(..) => match in_crate {
607 InCrate::Local => false,
608 // The inference variable might be unified with a local
609 // type in that remote crate.
610 InCrate::Remote => true,
613 ty::Adt(def, _) => def_id_is_local(def.did, in_crate),
614 ty::Foreign(did) => def_id_is_local(did, in_crate),
616 // This merits some explanation.
617 // Normally, opaque types are not involed when performing
618 // coherence checking, since it is illegal to directly
619 // implement a trait on an opaque type. However, we might
620 // end up looking at an opaque type during coherence checking
621 // if an opaque type gets used within another type (e.g. as
622 // a type parameter). This requires us to decide whether or
623 // not an opaque type should be considered 'local' or not.
625 // We choose to treat all opaque types as non-local, even
626 // those that appear within the same crate. This seems
627 // somewhat surprising at first, but makes sense when
628 // you consider that opaque types are supposed to hide
629 // the underlying type *within the same crate*. When an
630 // opaque type is used from outside the module
631 // where it is declared, it should be impossible to observe
632 // anything about it other than the traits that it implements.
634 // The alternative would be to look at the underlying type
635 // to determine whether or not the opaque type itself should
636 // be considered local. However, this could make it a breaking change
637 // to switch the underlying ('defining') type from a local type
638 // to a remote type. This would violate the rule that opaque
639 // types should be completely opaque apart from the traits
640 // that they implement, so we don't use this behavior.
645 // Similar to the `Opaque` case (#83613).
649 ty::Dynamic(ref tt, ..) => {
650 if let Some(principal) = tt.principal() {
651 def_id_is_local(principal.def_id(), in_crate)
657 ty::Error(_) => true,
659 ty::Generator(..) | ty::GeneratorWitness(..) => {
660 bug!("ty_is_local invoked on unexpected type: {:?}", ty)