rustc_traits/
codegen.rs

1// This file contains various trait resolution methods used by codegen.
2// They all assume regions can be erased and monomorphic types. It
3// seems likely that they should eventually be merged into more
4// general routines.
5
6use rustc_infer::infer::TyCtxtInferExt;
7use rustc_middle::bug;
8use rustc_middle::traits::CodegenObligationError;
9use rustc_middle::ty::{self, PseudoCanonicalInput, TyCtxt, TypeVisitableExt};
10use rustc_trait_selection::error_reporting::InferCtxtErrorExt;
11use rustc_trait_selection::traits::{
12    ImplSource, Obligation, ObligationCause, ObligationCtxt, ScrubbedTraitError, SelectionContext,
13    Unimplemented,
14};
15use tracing::debug;
16
17/// Attempts to resolve an obligation to an `ImplSource`. The result is
18/// a shallow `ImplSource` resolution, meaning that we do not
19/// (necessarily) resolve all nested obligations on the impl. Note
20/// that type check should guarantee to us that all nested
21/// obligations *could be* resolved if we wanted to.
22///
23/// This also expects that `trait_ref` is fully normalized.
24pub(crate) fn codegen_select_candidate<'tcx>(
25    tcx: TyCtxt<'tcx>,
26    key: PseudoCanonicalInput<'tcx, ty::TraitRef<'tcx>>,
27) -> Result<&'tcx ImplSource<'tcx, ()>, CodegenObligationError> {
28    let PseudoCanonicalInput { typing_env, value: trait_ref } = key;
29    // We expect the input to be fully normalized.
30    debug_assert_eq!(trait_ref, tcx.normalize_erasing_regions(typing_env, trait_ref));
31
32    // Do the initial selection for the obligation. This yields the
33    // shallow result we are looking for -- that is, what specific impl.
34    let (infcx, param_env) = tcx.infer_ctxt().ignoring_regions().build_with_typing_env(typing_env);
35    let mut selcx = SelectionContext::new(&infcx);
36
37    let obligation_cause = ObligationCause::dummy();
38    let obligation = Obligation::new(tcx, obligation_cause, param_env, trait_ref);
39
40    let selection = match selcx.select(&obligation) {
41        Ok(Some(selection)) => selection,
42        Ok(None) => return Err(CodegenObligationError::Ambiguity),
43        Err(Unimplemented) => return Err(CodegenObligationError::Unimplemented),
44        Err(e) => {
45            bug!("Encountered error `{:?}` selecting `{:?}` during codegen", e, trait_ref)
46        }
47    };
48
49    debug!(?selection);
50
51    // Currently, we use a fulfillment context to completely resolve
52    // all nested obligations. This is because they can inform the
53    // inference of the impl's type parameters.
54    // FIXME(-Znext-solver): Doesn't need diagnostics if new solver.
55    let ocx = ObligationCtxt::new(&infcx);
56    let impl_source = selection.map(|obligation| {
57        ocx.register_obligation(obligation);
58    });
59
60    // In principle, we only need to do this so long as `impl_source`
61    // contains unbound type parameters. It could be a slight
62    // optimization to stop iterating early.
63    let errors = ocx.select_all_or_error();
64    if !errors.is_empty() {
65        // `rustc_monomorphize::collector` assumes there are no type errors.
66        // Cycle errors are the only post-monomorphization errors possible; emit them now so
67        // `rustc_ty_utils::resolve_associated_item` doesn't return `None` post-monomorphization.
68        for err in errors {
69            if let ScrubbedTraitError::Cycle(cycle) = err {
70                infcx.err_ctxt().report_overflow_obligation_cycle(&cycle);
71            }
72        }
73        return Err(CodegenObligationError::Unimplemented);
74    }
75
76    let impl_source = infcx.resolve_vars_if_possible(impl_source);
77    let impl_source = tcx.erase_regions(impl_source);
78    if impl_source.has_non_region_infer() {
79        // Unused generic types or consts on an impl get replaced with inference vars,
80        // but never resolved, causing the return value of a query to contain inference
81        // vars. We do not have a concept for this and will in fact ICE in stable hashing
82        // of the return value. So bail out instead.
83        let guar = match impl_source {
84            ImplSource::UserDefined(impl_) => tcx.dcx().span_delayed_bug(
85                tcx.def_span(impl_.impl_def_id),
86                "this impl has unconstrained generic parameters",
87            ),
88            _ => unreachable!(),
89        };
90        return Err(CodegenObligationError::UnconstrainedParam(guar));
91    }
92
93    Ok(&*tcx.arena.alloc(impl_source))
94}