1 use crate::infer::{InferCtxt, TyOrConstInferVar};
2 use rustc_data_structures::obligation_forest::ProcessResult;
3 use rustc_data_structures::obligation_forest::{DoCompleted, Error, ForestObligation};
4 use rustc_data_structures::obligation_forest::{ObligationForest, ObligationProcessor};
5 use rustc_errors::ErrorReported;
6 use rustc_infer::traits::{PolyTraitObligation, TraitEngine, TraitEngineExt as _};
7 use rustc_middle::mir::interpret::ErrorHandled;
8 use rustc_middle::ty::error::ExpectedFound;
9 use rustc_middle::ty::ToPredicate;
10 use rustc_middle::ty::{self, Binder, Const, Ty, TypeFoldable};
11 use std::marker::PhantomData;
14 use super::select::SelectionContext;
16 use super::CodeAmbiguity;
17 use super::CodeProjectionError;
18 use super::CodeSelectionError;
19 use super::{ConstEvalFailure, Unimplemented};
20 use super::{FulfillmentError, FulfillmentErrorCode};
21 use super::{ObligationCause, PredicateObligation};
23 use crate::traits::error_reporting::InferCtxtExt as _;
24 use crate::traits::project::PolyProjectionObligation;
25 use crate::traits::query::evaluate_obligation::InferCtxtExt as _;
27 impl<'tcx> ForestObligation for PendingPredicateObligation<'tcx> {
28 /// Note that we include both the `ParamEnv` and the `Predicate`,
29 /// as the `ParamEnv` can influence whether fulfillment succeeds
31 type CacheKey = ty::ParamEnvAnd<'tcx, ty::Predicate<'tcx>>;
33 fn as_cache_key(&self) -> Self::CacheKey {
34 self.obligation.param_env.and(self.obligation.predicate)
38 /// The fulfillment context is used to drive trait resolution. It
39 /// consists of a list of obligations that must be (eventually)
40 /// satisfied. The job is to track which are satisfied, which yielded
41 /// errors, and which are still pending. At any point, users can call
42 /// `select_where_possible`, and the fulfillment context will try to do
43 /// selection, retaining only those obligations that remain
44 /// ambiguous. This may be helpful in pushing type inference
45 /// along. Once all type inference constraints have been generated, the
46 /// method `select_all_or_error` can be used to report any remaining
47 /// ambiguous cases as errors.
48 pub struct FulfillmentContext<'tcx> {
49 // A list of all obligations that have been registered with this
50 // fulfillment context.
51 predicates: ObligationForest<PendingPredicateObligation<'tcx>>,
52 // Should this fulfillment context register type-lives-for-region
53 // obligations on its parent infcx? In some cases, region
54 // obligations are either already known to hold (normalization) or
55 // hopefully verifed elsewhere (type-impls-bound), and therefore
56 // should not be checked.
58 // Note that if we are normalizing a type that we already
59 // know is well-formed, there should be no harm setting this
60 // to true - all the region variables should be determinable
61 // using the RFC 447 rules, which don't depend on
62 // type-lives-for-region constraints, and because the type
63 // is well-formed, the constraints should hold.
64 register_region_obligations: bool,
65 // Is it OK to register obligations into this infcx inside
68 // The "primary fulfillment" in many cases in typeck lives
69 // outside of any snapshot, so any use of it inside a snapshot
70 // will lead to trouble and therefore is checked against, but
71 // other fulfillment contexts sometimes do live inside of
72 // a snapshot (they don't *straddle* a snapshot, so there
73 // is no trouble there).
74 usable_in_snapshot: bool,
77 #[derive(Clone, Debug)]
78 pub struct PendingPredicateObligation<'tcx> {
79 pub obligation: PredicateObligation<'tcx>,
80 // This is far more often read than modified, meaning that we
81 // should mostly optimize for reading speed, while modifying is not as relevant.
83 // For whatever reason using a boxed slice is slower than using a `Vec` here.
84 pub stalled_on: Vec<TyOrConstInferVar<'tcx>>,
87 // `PendingPredicateObligation` is used a lot. Make sure it doesn't unintentionally get bigger.
88 #[cfg(target_arch = "x86_64")]
89 static_assert_size!(PendingPredicateObligation<'_>, 64);
91 impl<'a, 'tcx> FulfillmentContext<'tcx> {
92 /// Creates a new fulfillment context.
93 pub fn new() -> FulfillmentContext<'tcx> {
95 predicates: ObligationForest::new(),
96 register_region_obligations: true,
97 usable_in_snapshot: false,
101 pub fn new_in_snapshot() -> FulfillmentContext<'tcx> {
103 predicates: ObligationForest::new(),
104 register_region_obligations: true,
105 usable_in_snapshot: true,
109 pub fn new_ignoring_regions() -> FulfillmentContext<'tcx> {
111 predicates: ObligationForest::new(),
112 register_region_obligations: false,
113 usable_in_snapshot: false,
117 /// Attempts to select obligations using `selcx`.
120 selcx: &mut SelectionContext<'a, 'tcx>,
121 ) -> Result<(), Vec<FulfillmentError<'tcx>>> {
122 debug!("select(obligation-forest-size={})", self.predicates.len());
124 let mut errors = Vec::new();
127 debug!("select: starting another iteration");
129 // Process pending obligations.
130 let outcome = self.predicates.process_obligations(
131 &mut FulfillProcessor {
133 register_region_obligations: self.register_region_obligations,
137 debug!("select: outcome={:#?}", outcome);
139 // FIXME: if we kept the original cache key, we could mark projection
140 // obligations as complete for the projection cache here.
142 errors.extend(outcome.errors.into_iter().map(to_fulfillment_error));
144 // If nothing new was added, no need to keep looping.
151 "select({} predicates remaining, {} errors) done",
152 self.predicates.len(),
156 if errors.is_empty() { Ok(()) } else { Err(errors) }
160 impl<'tcx> TraitEngine<'tcx> for FulfillmentContext<'tcx> {
161 /// "Normalize" a projection type `<SomeType as SomeTrait>::X` by
162 /// creating a fresh type variable `$0` as well as a projection
163 /// predicate `<SomeType as SomeTrait>::X == $0`. When the
164 /// inference engine runs, it will attempt to find an impl of
165 /// `SomeTrait` or a where-clause that lets us unify `$0` with
166 /// something concrete. If this fails, we'll unify `$0` with
167 /// `projection_ty` again.
168 fn normalize_projection_type(
170 infcx: &InferCtxt<'_, 'tcx>,
171 param_env: ty::ParamEnv<'tcx>,
172 projection_ty: ty::ProjectionTy<'tcx>,
173 cause: ObligationCause<'tcx>,
175 debug!("normalize_projection_type(projection_ty={:?})", projection_ty);
177 debug_assert!(!projection_ty.has_escaping_bound_vars());
179 // FIXME(#20304) -- cache
181 let mut selcx = SelectionContext::new(infcx);
182 let mut obligations = vec![];
183 let normalized_ty = project::normalize_projection_type(
191 self.register_predicate_obligations(infcx, obligations);
193 debug!("normalize_projection_type: result={:?}", normalized_ty);
198 fn register_predicate_obligation(
200 infcx: &InferCtxt<'_, 'tcx>,
201 obligation: PredicateObligation<'tcx>,
203 // this helps to reduce duplicate errors, as well as making
204 // debug output much nicer to read and so on.
205 let obligation = infcx.resolve_vars_if_possible(&obligation);
207 debug!("register_predicate_obligation(obligation={:?})", obligation);
209 assert!(!infcx.is_in_snapshot() || self.usable_in_snapshot);
212 .register_obligation(PendingPredicateObligation { obligation, stalled_on: vec![] });
215 fn select_all_or_error(
217 infcx: &InferCtxt<'_, 'tcx>,
218 ) -> Result<(), Vec<FulfillmentError<'tcx>>> {
219 self.select_where_possible(infcx)?;
221 let errors: Vec<_> = self
223 .to_errors(CodeAmbiguity)
225 .map(to_fulfillment_error)
227 if errors.is_empty() { Ok(()) } else { Err(errors) }
230 fn select_where_possible(
232 infcx: &InferCtxt<'_, 'tcx>,
233 ) -> Result<(), Vec<FulfillmentError<'tcx>>> {
234 let mut selcx = SelectionContext::new(infcx);
235 self.select(&mut selcx)
238 fn pending_obligations(&self) -> Vec<PredicateObligation<'tcx>> {
239 self.predicates.map_pending_obligations(|o| o.obligation.clone())
243 struct FulfillProcessor<'a, 'b, 'tcx> {
244 selcx: &'a mut SelectionContext<'b, 'tcx>,
245 register_region_obligations: bool,
248 fn mk_pending(os: Vec<PredicateObligation<'tcx>>) -> Vec<PendingPredicateObligation<'tcx>> {
250 .map(|o| PendingPredicateObligation { obligation: o, stalled_on: vec![] })
254 impl<'a, 'b, 'tcx> ObligationProcessor for FulfillProcessor<'a, 'b, 'tcx> {
255 type Obligation = PendingPredicateObligation<'tcx>;
256 type Error = FulfillmentErrorCode<'tcx>;
258 /// Processes a predicate obligation and returns either:
259 /// - `Changed(v)` if the predicate is true, presuming that `v` are also true
260 /// - `Unchanged` if we don't have enough info to be sure
261 /// - `Error(e)` if the predicate does not hold
263 /// This is always inlined, despite its size, because it has a single
264 /// callsite and it is called *very* frequently.
266 fn process_obligation(
268 pending_obligation: &mut Self::Obligation,
269 ) -> ProcessResult<Self::Obligation, Self::Error> {
270 // If we were stalled on some unresolved variables, first check whether
271 // any of them have been resolved; if not, don't bother doing more work
273 let change = match pending_obligation.stalled_on.len() {
274 // Match arms are in order of frequency, which matters because this
275 // code is so hot. 1 and 0 dominate; 2+ is fairly rare.
277 let infer_var = pending_obligation.stalled_on[0];
278 self.selcx.infcx().ty_or_const_infer_var_changed(infer_var)
281 // In this case we haven't changed, but wish to make a change.
285 // This `for` loop was once a call to `all()`, but this lower-level
286 // form was a perf win. See #64545 for details.
288 for &infer_var in &pending_obligation.stalled_on {
289 if self.selcx.infcx().ty_or_const_infer_var_changed(infer_var) {
300 "process_predicate: pending obligation {:?} still stalled on {:?}",
301 self.selcx.infcx().resolve_vars_if_possible(&pending_obligation.obligation),
302 pending_obligation.stalled_on
304 return ProcessResult::Unchanged;
307 // This part of the code is much colder.
309 pending_obligation.stalled_on.truncate(0);
311 let obligation = &mut pending_obligation.obligation;
313 if obligation.predicate.has_infer_types_or_consts() {
314 obligation.predicate =
315 self.selcx.infcx().resolve_vars_if_possible(&obligation.predicate);
318 debug!("process_obligation: obligation = {:?} cause = {:?}", obligation, obligation.cause);
320 let infcx = self.selcx.infcx();
322 match obligation.predicate.kind() {
323 ty::PredicateKind::ForAll(binder) => match binder.skip_binder().kind() {
324 ty::PredicateKind::ForAll(_) => bug!("unexpected forall"),
325 // Evaluation will discard candidates using the leak check.
326 // This means we need to pass it the bound version of our
328 &ty::PredicateKind::Atom(atom) => match atom {
329 ty::PredicateAtom::Trait(trait_ref, _constness) => {
330 let trait_obligation = obligation.with(Binder::bind(trait_ref));
332 self.process_trait_obligation(
335 &mut pending_obligation.stalled_on,
338 ty::PredicateAtom::Projection(projection) => {
339 let project_obligation = obligation.with(Binder::bind(projection));
341 self.process_projection_obligation(
343 &mut pending_obligation.stalled_on,
346 ty::PredicateAtom::RegionOutlives(_)
347 | ty::PredicateAtom::TypeOutlives(_)
348 | ty::PredicateAtom::WellFormed(_)
349 | ty::PredicateAtom::ObjectSafe(_)
350 | ty::PredicateAtom::ClosureKind(..)
351 | ty::PredicateAtom::Subtype(_)
352 | ty::PredicateAtom::ConstEvaluatable(..)
353 | ty::PredicateAtom::ConstEquate(..) => {
354 let (pred, _) = infcx.replace_bound_vars_with_placeholders(binder);
355 ProcessResult::Changed(mk_pending(vec![obligation.with(pred)]))
359 &ty::PredicateKind::Atom(atom) => match atom {
360 ty::PredicateAtom::Trait(ref data, _) => {
361 let trait_obligation = obligation.with(Binder::dummy(*data));
363 self.process_trait_obligation(
366 &mut pending_obligation.stalled_on,
370 ty::PredicateAtom::RegionOutlives(data) => {
371 match infcx.region_outlives_predicate(&obligation.cause, Binder::dummy(data)) {
372 Ok(()) => ProcessResult::Changed(vec![]),
373 Err(_) => ProcessResult::Error(CodeSelectionError(Unimplemented)),
377 ty::PredicateAtom::TypeOutlives(ty::OutlivesPredicate(t_a, r_b)) => {
378 if self.register_region_obligations {
379 self.selcx.infcx().register_region_obligation_with_cause(
385 ProcessResult::Changed(vec![])
388 ty::PredicateAtom::Projection(ref data) => {
389 let project_obligation = obligation.with(Binder::dummy(*data));
391 self.process_projection_obligation(
393 &mut pending_obligation.stalled_on,
397 ty::PredicateAtom::ObjectSafe(trait_def_id) => {
398 if !self.selcx.tcx().is_object_safe(trait_def_id) {
399 ProcessResult::Error(CodeSelectionError(Unimplemented))
401 ProcessResult::Changed(vec![])
405 ty::PredicateAtom::ClosureKind(_, closure_substs, kind) => {
406 match self.selcx.infcx().closure_kind(closure_substs) {
407 Some(closure_kind) => {
408 if closure_kind.extends(kind) {
409 ProcessResult::Changed(vec![])
411 ProcessResult::Error(CodeSelectionError(Unimplemented))
414 None => ProcessResult::Unchanged,
418 ty::PredicateAtom::WellFormed(arg) => {
419 match wf::obligations(
421 obligation.param_env,
422 obligation.cause.body_id,
424 obligation.cause.span,
427 pending_obligation.stalled_on =
428 vec![TyOrConstInferVar::maybe_from_generic_arg(arg).unwrap()];
429 ProcessResult::Unchanged
431 Some(os) => ProcessResult::Changed(mk_pending(os)),
435 ty::PredicateAtom::Subtype(subtype) => {
436 match self.selcx.infcx().subtype_predicate(
438 obligation.param_env,
439 Binder::dummy(subtype),
442 // None means that both are unresolved.
443 pending_obligation.stalled_on = vec![
444 TyOrConstInferVar::maybe_from_ty(subtype.a).unwrap(),
445 TyOrConstInferVar::maybe_from_ty(subtype.b).unwrap(),
447 ProcessResult::Unchanged
449 Some(Ok(ok)) => ProcessResult::Changed(mk_pending(ok.obligations)),
452 ExpectedFound::new(subtype.a_is_expected, subtype.a, subtype.b);
453 ProcessResult::Error(FulfillmentErrorCode::CodeSubtypeError(
461 ty::PredicateAtom::ConstEvaluatable(def_id, substs) => {
462 match self.selcx.infcx().const_eval_resolve(
463 obligation.param_env,
467 Some(obligation.cause.span),
469 Ok(_) => ProcessResult::Changed(vec![]),
470 Err(err) => ProcessResult::Error(CodeSelectionError(ConstEvalFailure(err))),
474 ty::PredicateAtom::ConstEquate(c1, c2) => {
475 debug!("equating consts: c1={:?} c2={:?}", c1, c2);
477 let stalled_on = &mut pending_obligation.stalled_on;
479 let mut evaluate = |c: &'tcx Const<'tcx>| {
480 if let ty::ConstKind::Unevaluated(def, substs, promoted) = c.val {
481 match self.selcx.infcx().const_eval_resolve(
482 obligation.param_env,
486 Some(obligation.cause.span),
488 Ok(val) => Ok(Const::from_value(self.selcx.tcx(), val, c.ty)),
489 Err(ErrorHandled::TooGeneric) => {
493 .filter_map(|ty| TyOrConstInferVar::maybe_from_ty(ty))
496 Err(ErrorHandled::TooGeneric)
503 match (evaluate(c1), evaluate(c2)) {
504 (Ok(c1), Ok(c2)) => {
508 .at(&obligation.cause, obligation.param_env)
511 Ok(_) => ProcessResult::Changed(vec![]),
512 Err(err) => ProcessResult::Error(
513 FulfillmentErrorCode::CodeConstEquateError(
514 ExpectedFound::new(true, c1, c2),
520 (Err(ErrorHandled::Reported(ErrorReported)), _)
521 | (_, Err(ErrorHandled::Reported(ErrorReported))) => {
522 ProcessResult::Error(CodeSelectionError(ConstEvalFailure(
523 ErrorHandled::Reported(ErrorReported),
526 (Err(ErrorHandled::Linted), _) | (_, Err(ErrorHandled::Linted)) => {
528 obligation.cause.span(self.selcx.tcx()),
529 "ConstEquate: const_eval_resolve returned an unexpected error"
532 (Err(ErrorHandled::TooGeneric), _) | (_, Err(ErrorHandled::TooGeneric)) => {
533 ProcessResult::Unchanged
541 fn process_backedge<'c, I>(
544 _marker: PhantomData<&'c PendingPredicateObligation<'tcx>>,
546 I: Clone + Iterator<Item = &'c PendingPredicateObligation<'tcx>>,
548 if self.selcx.coinductive_match(cycle.clone().map(|s| s.obligation.predicate)) {
549 debug!("process_child_obligations: coinductive match");
551 let cycle: Vec<_> = cycle.map(|c| c.obligation.clone()).collect();
552 self.selcx.infcx().report_overflow_error_cycle(&cycle);
557 impl<'a, 'b, 'tcx> FulfillProcessor<'a, 'b, 'tcx> {
558 fn process_trait_obligation(
560 obligation: &PredicateObligation<'tcx>,
561 trait_obligation: PolyTraitObligation<'tcx>,
562 stalled_on: &mut Vec<TyOrConstInferVar<'tcx>>,
563 ) -> ProcessResult<PendingPredicateObligation<'tcx>, FulfillmentErrorCode<'tcx>> {
564 let infcx = self.selcx.infcx();
565 if obligation.predicate.is_global() {
566 // no type variables present, can use evaluation for better caching.
567 // FIXME: consider caching errors too.
568 if infcx.predicate_must_hold_considering_regions(obligation) {
570 "selecting trait `{:?}` at depth {} evaluated to holds",
571 obligation.predicate, obligation.recursion_depth
573 return ProcessResult::Changed(vec![]);
577 match self.selcx.select(&trait_obligation) {
578 Ok(Some(impl_source)) => {
580 "selecting trait `{:?}` at depth {} yielded Ok(Some)",
581 trait_obligation.predicate, obligation.recursion_depth
583 ProcessResult::Changed(mk_pending(impl_source.nested_obligations()))
587 "selecting trait `{:?}` at depth {} yielded Ok(None)",
588 trait_obligation.predicate, obligation.recursion_depth
591 // This is a bit subtle: for the most part, the
592 // only reason we can fail to make progress on
593 // trait selection is because we don't have enough
594 // information about the types in the trait.
595 *stalled_on = trait_ref_infer_vars(
597 trait_obligation.predicate.map_bound(|pred| pred.trait_ref),
601 "process_predicate: pending obligation {:?} now stalled on {:?}",
602 infcx.resolve_vars_if_possible(obligation),
606 ProcessResult::Unchanged
608 Err(selection_err) => {
610 "selecting trait `{:?}` at depth {} yielded Err",
611 trait_obligation.predicate, obligation.recursion_depth
614 ProcessResult::Error(CodeSelectionError(selection_err))
619 fn process_projection_obligation(
621 project_obligation: PolyProjectionObligation<'tcx>,
622 stalled_on: &mut Vec<TyOrConstInferVar<'tcx>>,
623 ) -> ProcessResult<PendingPredicateObligation<'tcx>, FulfillmentErrorCode<'tcx>> {
624 match project::poly_project_and_unify_type(self.selcx, &project_obligation) {
626 *stalled_on = trait_ref_infer_vars(
628 project_obligation.predicate.to_poly_trait_ref(self.selcx.tcx()),
630 ProcessResult::Unchanged
632 Ok(Some(os)) => ProcessResult::Changed(mk_pending(os)),
633 Err(e) => ProcessResult::Error(CodeProjectionError(e)),
638 /// Returns the set of inference variables contained in a trait ref.
639 fn trait_ref_infer_vars<'a, 'tcx>(
640 selcx: &mut SelectionContext<'a, 'tcx>,
641 trait_ref: ty::PolyTraitRef<'tcx>,
642 ) -> Vec<TyOrConstInferVar<'tcx>> {
645 .resolve_vars_if_possible(&trait_ref)
649 // FIXME(eddyb) try using `skip_current_subtree` to skip everything that
650 // doesn't contain inference variables, not just the outermost level.
651 .filter(|arg| arg.has_infer_types_or_consts())
652 .flat_map(|arg| arg.walk())
653 .filter_map(TyOrConstInferVar::maybe_from_generic_arg)
657 fn to_fulfillment_error<'tcx>(
658 error: Error<PendingPredicateObligation<'tcx>, FulfillmentErrorCode<'tcx>>,
659 ) -> FulfillmentError<'tcx> {
660 let obligation = error.backtrace.into_iter().next().unwrap().obligation;
661 FulfillmentError::new(obligation, error.error)