compiler/rustc_trait_selection/src/traits/wf.rs

   1 use crate::infer::InferCtxt;
   2 use crate::traits;
   3 use rustc_hir as hir;
   4 use rustc_hir::def_id::DefId;
   5 use rustc_hir::lang_items::LangItem;
   6 use rustc_middle::ty::subst::{GenericArg, GenericArgKind, SubstsRef};
   7 use rustc_middle::ty::{self, ToPredicate, Ty, TyCtxt, TypeVisitable};
   8 use rustc_span::Span;
   9
  10 use std::iter;
  11 /// Returns the set of obligations needed to make `arg` well-formed.
  12 /// If `arg` contains unresolved inference variables, this may include
  13 /// further WF obligations. However, if `arg` IS an unresolved
  14 /// inference variable, returns `None`, because we are not able to
  15 /// make any progress at all. This is to prevent "livelock" where we
  16 /// say "$0 is WF if $0 is WF".
  17 pub fn obligations<'a, 'tcx>(
  18     infcx: &InferCtxt<'a, 'tcx>,
  19     param_env: ty::ParamEnv<'tcx>,
  20     body_id: hir::HirId,
  21     recursion_depth: usize,
  22     arg: GenericArg<'tcx>,
  23     span: Span,
  24 ) -> Option<Vec<traits::PredicateObligation<'tcx>>> {
  25     // Handle the "livelock" case (see comment above) by bailing out if necessary.
  26     let arg = match arg.unpack() {
  27         GenericArgKind::Type(ty) => {
  28             match ty.kind() {
  29                 ty::Infer(ty::TyVar(_)) => {
  30                     let resolved_ty = infcx.shallow_resolve(ty);
  31                     if resolved_ty == ty {
  32                         // No progress, bail out to prevent "livelock".
  33                         return None;
  34                     } else {
  35                         resolved_ty
  36                     }
  37                 }
  38                 _ => ty,
  39             }
  40             .into()
  41         }
  42         GenericArgKind::Const(ct) => {
  43             match ct.kind() {
  44                 ty::ConstKind::Infer(_) => {
  45                     let resolved = infcx.shallow_resolve(ct);
  46                     if resolved == ct {
  47                         // No progress.
  48                         return None;
  49                     } else {
  50                         resolved
  51                     }
  52                 }
  53                 _ => ct,
  54             }
  55             .into()
  56         }
  57         // There is nothing we have to do for lifetimes.
  58         GenericArgKind::Lifetime(..) => return Some(Vec::new()),
  59     };
  60
  61     let mut wf = WfPredicates {
  62         tcx: infcx.tcx,
  63         param_env,
  64         body_id,
  65         span,
  66         out: vec![],
  67         recursion_depth,
  68         item: None,
  69     };
  70     wf.compute(arg);
  71     debug!("wf::obligations({:?}, body_id={:?}) = {:?}", arg, body_id, wf.out);
  72
  73     let result = wf.normalize(infcx);
  74     debug!("wf::obligations({:?}, body_id={:?}) ~~> {:?}", arg, body_id, result);
  75     Some(result)
  76 }
  77
  78 /// Returns the obligations that make this trait reference
  79 /// well-formed.  For example, if there is a trait `Set` defined like
  80 /// `trait Set<K:Eq>`, then the trait reference `Foo: Set<Bar>` is WF
  81 /// if `Bar: Eq`.
  82 pub fn trait_obligations<'a, 'tcx>(
  83     infcx: &InferCtxt<'a, 'tcx>,
  84     param_env: ty::ParamEnv<'tcx>,
  85     body_id: hir::HirId,
  86     trait_pred: &ty::TraitPredicate<'tcx>,
  87     span: Span,
  88     item: &'tcx hir::Item<'tcx>,
  89 ) -> Vec<traits::PredicateObligation<'tcx>> {
  90     let mut wf = WfPredicates {
  91         tcx: infcx.tcx,
  92         param_env,
  93         body_id,
  94         span,
  95         out: vec![],
  96         recursion_depth: 0,
  97         item: Some(item),
  98     };
  99     wf.compute_trait_pred(trait_pred, Elaborate::All);
 100     debug!(obligations = ?wf.out);
 101     wf.normalize(infcx)
 102 }
 103
 104 #[instrument(skip(infcx), ret)]
 105 pub fn predicate_obligations<'a, 'tcx>(
 106     infcx: &InferCtxt<'a, 'tcx>,
 107     param_env: ty::ParamEnv<'tcx>,
 108     body_id: hir::HirId,
 109     predicate: ty::Predicate<'tcx>,
 110     span: Span,
 111 ) -> Vec<traits::PredicateObligation<'tcx>> {
 112     let mut wf = WfPredicates {
 113         tcx: infcx.tcx,
 114         param_env,
 115         body_id,
 116         span,
 117         out: vec![],
 118         recursion_depth: 0,
 119         item: None,
 120     };
 121
 122     // It's ok to skip the binder here because wf code is prepared for it
 123     match predicate.kind().skip_binder() {
 124         ty::PredicateKind::Trait(t) => {
 125             wf.compute_trait_pred(&t, Elaborate::None);
 126         }
 127         ty::PredicateKind::RegionOutlives(..) => {}
 128         ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ty, _reg)) => {
 129             wf.compute(ty.into());
 130         }
 131         ty::PredicateKind::Projection(t) => {
 132             wf.compute_projection(t.projection_ty);
 133             wf.compute(match t.term.unpack() {
 134                 ty::TermKind::Ty(ty) => ty.into(),
 135                 ty::TermKind::Const(c) => c.into(),
 136             })
 137         }
 138         ty::PredicateKind::WellFormed(arg) => {
 139             wf.compute(arg);
 140         }
 141         ty::PredicateKind::ObjectSafe(_) => {}
 142         ty::PredicateKind::ClosureKind(..) => {}
 143         ty::PredicateKind::Subtype(ty::SubtypePredicate { a, b, a_is_expected: _ }) => {
 144             wf.compute(a.into());
 145             wf.compute(b.into());
 146         }
 147         ty::PredicateKind::Coerce(ty::CoercePredicate { a, b }) => {
 148             wf.compute(a.into());
 149             wf.compute(b.into());
 150         }
 151         ty::PredicateKind::ConstEvaluatable(uv) => {
 152             let obligations = wf.nominal_obligations(uv.def.did, uv.substs);
 153             wf.out.extend(obligations);
 154
 155             for arg in uv.substs.iter() {
 156                 wf.compute(arg);
 157             }
 158         }
 159         ty::PredicateKind::ConstEquate(c1, c2) => {
 160             wf.compute(c1.into());
 161             wf.compute(c2.into());
 162         }
 163         ty::PredicateKind::TypeWellFormedFromEnv(..) => {
 164             bug!("TypeWellFormedFromEnv is only used for Chalk")
 165         }
 166     }
 167
 168     wf.normalize(infcx)
 169 }
 170
 171 struct WfPredicates<'tcx> {
 172     tcx: TyCtxt<'tcx>,
 173     param_env: ty::ParamEnv<'tcx>,
 174     body_id: hir::HirId,
 175     span: Span,
 176     out: Vec<traits::PredicateObligation<'tcx>>,
 177     recursion_depth: usize,
 178     item: Option<&'tcx hir::Item<'tcx>>,
 179 }
 180
 181 /// Controls whether we "elaborate" supertraits and so forth on the WF
 182 /// predicates. This is a kind of hack to address #43784. The
 183 /// underlying problem in that issue was a trait structure like:
 184 ///
 185 /// ```ignore (illustrative)
 186 /// trait Foo: Copy { }
 187 /// trait Bar: Foo { }
 188 /// impl<T: Bar> Foo for T { }
 189 /// impl<T> Bar for T { }
 190 /// ```
 191 ///
 192 /// Here, in the `Foo` impl, we will check that `T: Copy` holds -- but
 193 /// we decide that this is true because `T: Bar` is in the
 194 /// where-clauses (and we can elaborate that to include `T:
 195 /// Copy`). This wouldn't be a problem, except that when we check the
 196 /// `Bar` impl, we decide that `T: Foo` must hold because of the `Foo`
 197 /// impl. And so nowhere did we check that `T: Copy` holds!
 198 ///
 199 /// To resolve this, we elaborate the WF requirements that must be
 200 /// proven when checking impls. This means that (e.g.) the `impl Bar
 201 /// for T` will be forced to prove not only that `T: Foo` but also `T:
 202 /// Copy` (which it won't be able to do, because there is no `Copy`
 203 /// impl for `T`).
 204 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 205 enum Elaborate {
 206     All,
 207     None,
 208 }
 209
 210 fn extend_cause_with_original_assoc_item_obligation<'tcx>(
 211     tcx: TyCtxt<'tcx>,
 212     trait_ref: &ty::TraitRef<'tcx>,
 213     item: Option<&hir::Item<'tcx>>,
 214     cause: &mut traits::ObligationCause<'tcx>,
 215     pred: ty::Predicate<'tcx>,
 216 ) {
 217     debug!(
 218         "extended_cause_with_original_assoc_item_obligation {:?} {:?} {:?} {:?}",
 219         trait_ref, item, cause, pred
 220     );
 221     let (items, impl_def_id) = match item {
 222         Some(hir::Item { kind: hir::ItemKind::Impl(impl_), def_id, .. }) => (impl_.items, *def_id),
 223         _ => return,
 224     };
 225     let fix_span =
 226         |impl_item_ref: &hir::ImplItemRef| match tcx.hir().impl_item(impl_item_ref.id).kind {
 227             hir::ImplItemKind::Const(ty, _) | hir::ImplItemKind::TyAlias(ty) => ty.span,
 228             _ => impl_item_ref.span,
 229         };
 230
 231     // It is fine to skip the binder as we don't care about regions here.
 232     match pred.kind().skip_binder() {
 233         ty::PredicateKind::Projection(proj) => {
 234             // The obligation comes not from the current `impl` nor the `trait` being implemented,
 235             // but rather from a "second order" obligation, where an associated type has a
 236             // projection coming from another associated type. See
 237             // `src/test/ui/associated-types/point-at-type-on-obligation-failure.rs` and
 238             // `traits-assoc-type-in-supertrait-bad.rs`.
 239             if let Some(ty::Projection(projection_ty)) = proj.term.ty().map(|ty| ty.kind())
 240                 && let Some(&impl_item_id) =
 241                     tcx.impl_item_implementor_ids(impl_def_id).get(&projection_ty.item_def_id)
 242                 && let Some(impl_item_span) = items
 243                     .iter()
 244                     .find(|item| item.id.def_id.to_def_id() == impl_item_id)
 245                     .map(fix_span)
 246             {
 247                 cause.span = impl_item_span;
 248             }
 249         }
 250         ty::PredicateKind::Trait(pred) => {
 251             // An associated item obligation born out of the `trait` failed to be met. An example
 252             // can be seen in `ui/associated-types/point-at-type-on-obligation-failure-2.rs`.
 253             debug!("extended_cause_with_original_assoc_item_obligation trait proj {:?}", pred);
 254             if let ty::Projection(ty::ProjectionTy { item_def_id, .. }) = *pred.self_ty().kind()
 255                 && let Some(&impl_item_id) =
 256                     tcx.impl_item_implementor_ids(impl_def_id).get(&item_def_id)
 257                 && let Some(impl_item_span) = items
 258                     .iter()
 259                     .find(|item| item.id.def_id.to_def_id() == impl_item_id)
 260                     .map(fix_span)
 261             {
 262                 cause.span = impl_item_span;
 263             }
 264         }
 265         _ => {}
 266     }
 267 }
 268
 269 impl<'tcx> WfPredicates<'tcx> {
 270     fn tcx(&self) -> TyCtxt<'tcx> {
 271         self.tcx
 272     }
 273
 274     fn cause(&self, code: traits::ObligationCauseCode<'tcx>) -> traits::ObligationCause<'tcx> {
 275         traits::ObligationCause::new(self.span, self.body_id, code)
 276     }
 277
 278     fn normalize(self, infcx: &InferCtxt<'_, 'tcx>) -> Vec<traits::PredicateObligation<'tcx>> {
 279         let cause = self.cause(traits::WellFormed(None));
 280         let param_env = self.param_env;
 281         let mut obligations = Vec::with_capacity(self.out.len());
 282         for mut obligation in self.out {
 283             assert!(!obligation.has_escaping_bound_vars());
 284             let mut selcx = traits::SelectionContext::new(infcx);
 285             // Don't normalize the whole obligation, the param env is either
 286             // already normalized, or we're currently normalizing the
 287             // param_env. Either way we should only normalize the predicate.
 288             let normalized_predicate = traits::project::normalize_with_depth_to(
 289                 &mut selcx,
 290                 param_env,
 291                 cause.clone(),
 292                 self.recursion_depth,
 293                 obligation.predicate,
 294                 &mut obligations,
 295             );
 296             obligation.predicate = normalized_predicate;
 297             obligations.push(obligation);
 298         }
 299         obligations
 300     }
 301
 302     /// Pushes the obligations required for `trait_ref` to be WF into `self.out`.
 303     fn compute_trait_pred(&mut self, trait_pred: &ty::TraitPredicate<'tcx>, elaborate: Elaborate) {
 304         let tcx = self.tcx;
 305         let trait_ref = &trait_pred.trait_ref;
 306
 307         // if the trait predicate is not const, the wf obligations should not be const as well.
 308         let obligations = if trait_pred.constness == ty::BoundConstness::NotConst {
 309             self.nominal_obligations_without_const(trait_ref.def_id, trait_ref.substs)
 310         } else {
 311             self.nominal_obligations(trait_ref.def_id, trait_ref.substs)
 312         };
 313
 314         debug!("compute_trait_pred obligations {:?}", obligations);
 315         let param_env = self.param_env;
 316         let depth = self.recursion_depth;
 317
 318         let item = self.item;
 319
 320         let extend = |traits::PredicateObligation { predicate, mut cause, .. }| {
 321             if let Some(parent_trait_pred) = predicate.to_opt_poly_trait_pred() {
 322                 cause = cause.derived_cause(
 323                     parent_trait_pred,
 324                     traits::ObligationCauseCode::DerivedObligation,
 325                 );
 326             }
 327             extend_cause_with_original_assoc_item_obligation(
 328                 tcx, trait_ref, item, &mut cause, predicate,
 329             );
 330             traits::Obligation::with_depth(cause, depth, param_env, predicate)
 331         };
 332
 333         if let Elaborate::All = elaborate {
 334             let implied_obligations = traits::util::elaborate_obligations(tcx, obligations);
 335             let implied_obligations = implied_obligations.map(extend);
 336             self.out.extend(implied_obligations);
 337         } else {
 338             self.out.extend(obligations);
 339         }
 340
 341         let tcx = self.tcx();
 342         self.out.extend(
 343             trait_ref
 344                 .substs
 345                 .iter()
 346                 .enumerate()
 347                 .filter(|(_, arg)| {
 348                     matches!(arg.unpack(), GenericArgKind::Type(..) | GenericArgKind::Const(..))
 349                 })
 350                 .filter(|(_, arg)| !arg.has_escaping_bound_vars())
 351                 .map(|(i, arg)| {
 352                     let mut cause = traits::ObligationCause::misc(self.span, self.body_id);
 353                     // The first subst is the self ty - use the correct span for it.
 354                     if i == 0 {
 355                         if let Some(hir::ItemKind::Impl(hir::Impl { self_ty, .. })) =
 356                             item.map(|i| &i.kind)
 357                         {
 358                             cause.span = self_ty.span;
 359                         }
 360                     }
 361                     traits::Obligation::with_depth(
 362                         cause,
 363                         depth,
 364                         param_env,
 365                         ty::Binder::dummy(ty::PredicateKind::WellFormed(arg)).to_predicate(tcx),
 366                     )
 367                 }),
 368         );
 369     }
 370
 371     /// Pushes the obligations required for `trait_ref::Item` to be WF
 372     /// into `self.out`.
 373     fn compute_projection(&mut self, data: ty::ProjectionTy<'tcx>) {
 374         // A projection is well-formed if
 375         //
 376         // (a) its predicates hold (*)
 377         // (b) its substs are wf
 378         //
 379         // (*) The predicates of an associated type include the predicates of
 380         //     the trait that it's contained in. For example, given
 381         //
 382         // trait A<T>: Clone {
 383         //     type X where T: Copy;
 384         // }
 385         //
 386         // The predicates of `<() as A<i32>>::X` are:
 387         // [
 388         //     `(): Sized`
 389         //     `(): Clone`
 390         //     `(): A<i32>`
 391         //     `i32: Sized`
 392         //     `i32: Clone`
 393         //     `i32: Copy`
 394         // ]
 395         let obligations = self.nominal_obligations(data.item_def_id, data.substs);
 396         self.out.extend(obligations);
 397
 398         let tcx = self.tcx();
 399         let cause = self.cause(traits::WellFormed(None));
 400         let param_env = self.param_env;
 401         let depth = self.recursion_depth;
 402
 403         self.out.extend(
 404             data.substs
 405                 .iter()
 406                 .filter(|arg| {
 407                     matches!(arg.unpack(), GenericArgKind::Type(..) | GenericArgKind::Const(..))
 408                 })
 409                 .filter(|arg| !arg.has_escaping_bound_vars())
 410                 .map(|arg| {
 411                     traits::Obligation::with_depth(
 412                         cause.clone(),
 413                         depth,
 414                         param_env,
 415                         ty::Binder::dummy(ty::PredicateKind::WellFormed(arg)).to_predicate(tcx),
 416                     )
 417                 }),
 418         );
 419     }
 420
 421     fn require_sized(&mut self, subty: Ty<'tcx>, cause: traits::ObligationCauseCode<'tcx>) {
 422         if !subty.has_escaping_bound_vars() {
 423             let cause = self.cause(cause);
 424             let trait_ref = ty::TraitRef {
 425                 def_id: self.tcx.require_lang_item(LangItem::Sized, None),
 426                 substs: self.tcx.mk_substs_trait(subty, &[]),
 427             };
 428             self.out.push(traits::Obligation::with_depth(
 429                 cause,
 430                 self.recursion_depth,
 431                 self.param_env,
 432                 ty::Binder::dummy(trait_ref).without_const().to_predicate(self.tcx),
 433             ));
 434         }
 435     }
 436
 437     /// Pushes all the predicates needed to validate that `ty` is WF into `out`.
 438     #[instrument(level = "debug", skip(self))]
 439     fn compute(&mut self, arg: GenericArg<'tcx>) {
 440         let mut walker = arg.walk();
 441         let param_env = self.param_env;
 442         let depth = self.recursion_depth;
 443         while let Some(arg) = walker.next() {
 444             debug!(?arg, ?self.out);
 445             let ty = match arg.unpack() {
 446                 GenericArgKind::Type(ty) => ty,
 447
 448                 // No WF constraints for lifetimes being present, any outlives
 449                 // obligations are handled by the parent (e.g. `ty::Ref`).
 450                 GenericArgKind::Lifetime(_) => continue,
 451
 452                 GenericArgKind::Const(constant) => {
 453                     match constant.kind() {
 454                         ty::ConstKind::Unevaluated(uv) => {
 455                             let obligations = self.nominal_obligations(uv.def.did, uv.substs);
 456                             self.out.extend(obligations);
 457
 458                             let predicate =
 459                                 ty::Binder::dummy(ty::PredicateKind::ConstEvaluatable(uv.shrink()))
 460                                     .to_predicate(self.tcx());
 461                             let cause = self.cause(traits::WellFormed(None));
 462                             self.out.push(traits::Obligation::with_depth(
 463                                 cause,
 464                                 self.recursion_depth,
 465                                 self.param_env,
 466                                 predicate,
 467                             ));
 468                         }
 469                         ty::ConstKind::Infer(_) => {
 470                             let cause = self.cause(traits::WellFormed(None));
 471
 472                             self.out.push(traits::Obligation::with_depth(
 473                                 cause,
 474                                 self.recursion_depth,
 475                                 self.param_env,
 476                                 ty::Binder::dummy(ty::PredicateKind::WellFormed(constant.into()))
 477                                     .to_predicate(self.tcx()),
 478                             ));
 479                         }
 480                         ty::ConstKind::Error(_)
 481                         | ty::ConstKind::Param(_)
 482                         | ty::ConstKind::Bound(..)
 483                         | ty::ConstKind::Placeholder(..) => {
 484                             // These variants are trivially WF, so nothing to do here.
 485                         }
 486                         ty::ConstKind::Value(..) => {
 487                             // FIXME: Enforce that values are structurally-matchable.
 488                         }
 489                     }
 490                     continue;
 491                 }
 492             };
 493
 494             debug!("wf bounds for ty={:?} ty.kind={:#?}", ty, ty.kind());
 495
 496             match *ty.kind() {
 497                 ty::Bool
 498                 | ty::Char
 499                 | ty::Int(..)
 500                 | ty::Uint(..)
 501                 | ty::Float(..)
 502                 | ty::Error(_)
 503                 | ty::Str
 504                 | ty::GeneratorWitness(..)
 505                 | ty::Never
 506                 | ty::Param(_)
 507                 | ty::Bound(..)
 508                 | ty::Placeholder(..)
 509                 | ty::Foreign(..) => {
 510                     // WfScalar, WfParameter, etc
 511                 }
 512
 513                 // Can only infer to `ty::Int(_) | ty::Uint(_)`.
 514                 ty::Infer(ty::IntVar(_)) => {}
 515
 516                 // Can only infer to `ty::Float(_)`.
 517                 ty::Infer(ty::FloatVar(_)) => {}
 518
 519                 ty::Slice(subty) => {
 520                     self.require_sized(subty, traits::SliceOrArrayElem);
 521                 }
 522
 523                 ty::Array(subty, _) => {
 524                     self.require_sized(subty, traits::SliceOrArrayElem);
 525                     // Note that we handle the len is implicitly checked while walking `arg`.
 526                 }
 527
 528                 ty::Tuple(ref tys) => {
 529                     if let Some((_last, rest)) = tys.split_last() {
 530                         for &elem in rest {
 531                             self.require_sized(elem, traits::TupleElem);
 532                         }
 533                     }
 534                 }
 535
 536                 ty::RawPtr(_) => {
 537                     // Simple cases that are WF if their type args are WF.
 538                 }
 539
 540                 ty::Projection(data) => {
 541                     walker.skip_current_subtree(); // Subtree handled by compute_projection.
 542                     self.compute_projection(data);
 543                 }
 544
 545                 ty::Adt(def, substs) => {
 546                     // WfNominalType
 547                     let obligations = self.nominal_obligations(def.did(), substs);
 548                     self.out.extend(obligations);
 549                 }
 550
 551                 ty::FnDef(did, substs) => {
 552                     let obligations = self.nominal_obligations(did, substs);
 553                     self.out.extend(obligations);
 554                 }
 555
 556                 ty::Ref(r, rty, _) => {
 557                     // WfReference
 558                     if !r.has_escaping_bound_vars() && !rty.has_escaping_bound_vars() {
 559                         let cause = self.cause(traits::ReferenceOutlivesReferent(ty));
 560                         self.out.push(traits::Obligation::with_depth(
 561                             cause,
 562                             depth,
 563                             param_env,
 564                             ty::Binder::dummy(ty::PredicateKind::TypeOutlives(
 565                                 ty::OutlivesPredicate(rty, r),
 566                             ))
 567                             .to_predicate(self.tcx()),
 568                         ));
 569                     }
 570                 }
 571
 572                 ty::Generator(did, substs, ..) => {
 573                     // Walk ALL the types in the generator: this will
 574                     // include the upvar types as well as the yield
 575                     // type. Note that this is mildly distinct from
 576                     // the closure case, where we have to be careful
 577                     // about the signature of the closure. We don't
 578                     // have the problem of implied bounds here since
 579                     // generators don't take arguments.
 580                     let obligations = self.nominal_obligations(did, substs);
 581                     self.out.extend(obligations);
 582                 }
 583
 584                 ty::Closure(did, substs) => {
 585                     // Only check the upvar types for WF, not the rest
 586                     // of the types within. This is needed because we
 587                     // capture the signature and it may not be WF
 588                     // without the implied bounds. Consider a closure
 589                     // like `|x: &'a T|` -- it may be that `T: 'a` is
 590                     // not known to hold in the creator's context (and
 591                     // indeed the closure may not be invoked by its
 592                     // creator, but rather turned to someone who *can*
 593                     // verify that).
 594                     //
 595                     // The special treatment of closures here really
 596                     // ought not to be necessary either; the problem
 597                     // is related to #25860 -- there is no way for us
 598                     // to express a fn type complete with the implied
 599                     // bounds that it is assuming. I think in reality
 600                     // the WF rules around fn are a bit messed up, and
 601                     // that is the rot problem: `fn(&'a T)` should
 602                     // probably always be WF, because it should be
 603                     // shorthand for something like `where(T: 'a) {
 604                     // fn(&'a T) }`, as discussed in #25860.
 605                     walker.skip_current_subtree(); // subtree handled below
 606                     // FIXME(eddyb) add the type to `walker` instead of recursing.
 607                     self.compute(substs.as_closure().tupled_upvars_ty().into());
 608                     // Note that we cannot skip the generic types
 609                     // types. Normally, within the fn
 610                     // body where they are created, the generics will
 611                     // always be WF, and outside of that fn body we
 612                     // are not directly inspecting closure types
 613                     // anyway, except via auto trait matching (which
 614                     // only inspects the upvar types).
 615                     // But when a closure is part of a type-alias-impl-trait
 616                     // then the function that created the defining site may
 617                     // have had more bounds available than the type alias
 618                     // specifies. This may cause us to have a closure in the
 619                     // hidden type that is not actually well formed and
 620                     // can cause compiler crashes when the user abuses unsafe
 621                     // code to procure such a closure.
 622                     // See src/test/ui/type-alias-impl-trait/wf_check_closures.rs
 623                     let obligations = self.nominal_obligations(did, substs);
 624                     self.out.extend(obligations);
 625                 }
 626
 627                 ty::FnPtr(_) => {
 628                     // let the loop iterate into the argument/return
 629                     // types appearing in the fn signature
 630                 }
 631
 632                 ty::Opaque(did, substs) => {
 633                     // All of the requirements on type parameters
 634                     // have already been checked for `impl Trait` in
 635                     // return position. We do need to check type-alias-impl-trait though.
 636                     if ty::is_impl_trait_defn(self.tcx, did).is_none() {
 637                         let obligations = self.nominal_obligations(did, substs);
 638                         self.out.extend(obligations);
 639                     }
 640                 }
 641
 642                 ty::Dynamic(data, r, _) => {
 643                     // WfObject
 644                     //
 645                     // Here, we defer WF checking due to higher-ranked
 646                     // regions. This is perhaps not ideal.
 647                     self.from_object_ty(ty, data, r);
 648
 649                     // FIXME(#27579) RFC also considers adding trait
 650                     // obligations that don't refer to Self and
 651                     // checking those
 652
 653                     let defer_to_coercion = self.tcx().features().object_safe_for_dispatch;
 654
 655                     if !defer_to_coercion {
 656                         let cause = self.cause(traits::WellFormed(None));
 657                         let component_traits = data.auto_traits().chain(data.principal_def_id());
 658                         let tcx = self.tcx();
 659                         self.out.extend(component_traits.map(|did| {
 660                             traits::Obligation::with_depth(
 661                                 cause.clone(),
 662                                 depth,
 663                                 param_env,
 664                                 ty::Binder::dummy(ty::PredicateKind::ObjectSafe(did))
 665                                     .to_predicate(tcx),
 666                             )
 667                         }));
 668                     }
 669                 }
 670
 671                 // Inference variables are the complicated case, since we don't
 672                 // know what type they are. We do two things:
 673                 //
 674                 // 1. Check if they have been resolved, and if so proceed with
 675                 //    THAT type.
 676                 // 2. If not, we've at least simplified things (e.g., we went
 677                 //    from `Vec<$0>: WF` to `$0: WF`), so we can
 678                 //    register a pending obligation and keep
 679                 //    moving. (Goal is that an "inductive hypothesis"
 680                 //    is satisfied to ensure termination.)
 681                 // See also the comment on `fn obligations`, describing "livelock"
 682                 // prevention, which happens before this can be reached.
 683                 ty::Infer(_) => {
 684                     let cause = self.cause(traits::WellFormed(None));
 685                     self.out.push(traits::Obligation::with_depth(
 686                         cause,
 687                         self.recursion_depth,
 688                         param_env,
 689                         ty::Binder::dummy(ty::PredicateKind::WellFormed(ty.into()))
 690                             .to_predicate(self.tcx()),
 691                     ));
 692                 }
 693             }
 694
 695             debug!(?self.out);
 696         }
 697     }
 698
 699     #[instrument(level = "debug", skip(self))]
 700     fn nominal_obligations_inner(
 701         &mut self,
 702         def_id: DefId,
 703         substs: SubstsRef<'tcx>,
 704         remap_constness: bool,
 705     ) -> Vec<traits::PredicateObligation<'tcx>> {
 706         let predicates = self.tcx.predicates_of(def_id);
 707         let mut origins = vec![def_id; predicates.predicates.len()];
 708         let mut head = predicates;
 709         while let Some(parent) = head.parent {
 710             head = self.tcx.predicates_of(parent);
 711             origins.extend(iter::repeat(parent).take(head.predicates.len()));
 712         }
 713
 714         let predicates = predicates.instantiate(self.tcx, substs);
 715         trace!("{:#?}", predicates);
 716         debug_assert_eq!(predicates.predicates.len(), origins.len());
 717
 718         iter::zip(iter::zip(predicates.predicates, predicates.spans), origins.into_iter().rev())
 719             .map(|((mut pred, span), origin_def_id)| {
 720                 let code = if span.is_dummy() {
 721                     traits::ItemObligation(origin_def_id)
 722                 } else {
 723                     traits::BindingObligation(origin_def_id, span)
 724                 };
 725                 let cause = self.cause(code);
 726                 if remap_constness {
 727                     pred = pred.without_const(self.tcx);
 728                 }
 729                 traits::Obligation::with_depth(cause, self.recursion_depth, self.param_env, pred)
 730             })
 731             .filter(|pred| !pred.has_escaping_bound_vars())
 732             .collect()
 733     }
 734
 735     fn nominal_obligations(
 736         &mut self,
 737         def_id: DefId,
 738         substs: SubstsRef<'tcx>,
 739     ) -> Vec<traits::PredicateObligation<'tcx>> {
 740         self.nominal_obligations_inner(def_id, substs, false)
 741     }
 742
 743     fn nominal_obligations_without_const(
 744         &mut self,
 745         def_id: DefId,
 746         substs: SubstsRef<'tcx>,
 747     ) -> Vec<traits::PredicateObligation<'tcx>> {
 748         self.nominal_obligations_inner(def_id, substs, true)
 749     }
 750
 751     fn from_object_ty(
 752         &mut self,
 753         ty: Ty<'tcx>,
 754         data: &'tcx ty::List<ty::Binder<'tcx, ty::ExistentialPredicate<'tcx>>>,
 755         region: ty::Region<'tcx>,
 756     ) {
 757         // Imagine a type like this:
 758         //
 759         //     trait Foo { }
 760         //     trait Bar<'c> : 'c { }
 761         //
 762         //     &'b (Foo+'c+Bar<'d>)
 763         //         ^
 764         //
 765         // In this case, the following relationships must hold:
 766         //
 767         //     'b <= 'c
 768         //     'd <= 'c
 769         //
 770         // The first conditions is due to the normal region pointer
 771         // rules, which say that a reference cannot outlive its
 772         // referent.
 773         //
 774         // The final condition may be a bit surprising. In particular,
 775         // you may expect that it would have been `'c <= 'd`, since
 776         // usually lifetimes of outer things are conservative
 777         // approximations for inner things. However, it works somewhat
 778         // differently with trait objects: here the idea is that if the
 779         // user specifies a region bound (`'c`, in this case) it is the
 780         // "master bound" that *implies* that bounds from other traits are
 781         // all met. (Remember that *all bounds* in a type like
 782         // `Foo+Bar+Zed` must be met, not just one, hence if we write
 783         // `Foo<'x>+Bar<'y>`, we know that the type outlives *both* 'x and
 784         // 'y.)
 785         //
 786         // Note: in fact we only permit builtin traits, not `Bar<'d>`, I
 787         // am looking forward to the future here.
 788         if !data.has_escaping_bound_vars() && !region.has_escaping_bound_vars() {
 789             let implicit_bounds = object_region_bounds(self.tcx, data);
 790
 791             let explicit_bound = region;
 792
 793             self.out.reserve(implicit_bounds.len());
 794             for implicit_bound in implicit_bounds {
 795                 let cause = self.cause(traits::ObjectTypeBound(ty, explicit_bound));
 796                 let outlives =
 797                     ty::Binder::dummy(ty::OutlivesPredicate(explicit_bound, implicit_bound));
 798                 self.out.push(traits::Obligation::with_depth(
 799                     cause,
 800                     self.recursion_depth,
 801                     self.param_env,
 802                     outlives.to_predicate(self.tcx),
 803                 ));
 804             }
 805         }
 806     }
 807 }
 808
 809 /// Given an object type like `SomeTrait + Send`, computes the lifetime
 810 /// bounds that must hold on the elided self type. These are derived
 811 /// from the declarations of `SomeTrait`, `Send`, and friends -- if
 812 /// they declare `trait SomeTrait : 'static`, for example, then
 813 /// `'static` would appear in the list. The hard work is done by
 814 /// `infer::required_region_bounds`, see that for more information.
 815 pub fn object_region_bounds<'tcx>(
 816     tcx: TyCtxt<'tcx>,
 817     existential_predicates: &'tcx ty::List<ty::Binder<'tcx, ty::ExistentialPredicate<'tcx>>>,
 818 ) -> Vec<ty::Region<'tcx>> {
 819     // Since we don't actually *know* the self type for an object,
 820     // this "open(err)" serves as a kind of dummy standin -- basically
 821     // a placeholder type.
 822     let open_ty = tcx.mk_ty_infer(ty::FreshTy(0));
 823
 824     let predicates = existential_predicates.iter().filter_map(|predicate| {
 825         if let ty::ExistentialPredicate::Projection(_) = predicate.skip_binder() {
 826             None
 827         } else {
 828             Some(predicate.with_self_ty(tcx, open_ty))
 829         }
 830     });
 831
 832     required_region_bounds(tcx, open_ty, predicates)
 833 }
 834
 835 /// Given a set of predicates that apply to an object type, returns
 836 /// the region bounds that the (erased) `Self` type must
 837 /// outlive. Precisely *because* the `Self` type is erased, the
 838 /// parameter `erased_self_ty` must be supplied to indicate what type
 839 /// has been used to represent `Self` in the predicates
 840 /// themselves. This should really be a unique type; `FreshTy(0)` is a
 841 /// popular choice.
 842 ///
 843 /// N.B., in some cases, particularly around higher-ranked bounds,
 844 /// this function returns a kind of conservative approximation.
 845 /// That is, all regions returned by this function are definitely
 846 /// required, but there may be other region bounds that are not
 847 /// returned, as well as requirements like `for<'a> T: 'a`.
 848 ///
 849 /// Requires that trait definitions have been processed so that we can
 850 /// elaborate predicates and walk supertraits.
 851 #[instrument(skip(tcx, predicates), level = "debug", ret)]
 852 pub(crate) fn required_region_bounds<'tcx>(
 853     tcx: TyCtxt<'tcx>,
 854     erased_self_ty: Ty<'tcx>,
 855     predicates: impl Iterator<Item = ty::Predicate<'tcx>>,
 856 ) -> Vec<ty::Region<'tcx>> {
 857     assert!(!erased_self_ty.has_escaping_bound_vars());
 858
 859     traits::elaborate_predicates(tcx, predicates)
 860         .filter_map(|obligation| {
 861             debug!(?obligation);
 862             match obligation.predicate.kind().skip_binder() {
 863                 ty::PredicateKind::Projection(..)
 864                 | ty::PredicateKind::Trait(..)
 865                 | ty::PredicateKind::Subtype(..)
 866                 | ty::PredicateKind::Coerce(..)
 867                 | ty::PredicateKind::WellFormed(..)
 868                 | ty::PredicateKind::ObjectSafe(..)
 869                 | ty::PredicateKind::ClosureKind(..)
 870                 | ty::PredicateKind::RegionOutlives(..)
 871                 | ty::PredicateKind::ConstEvaluatable(..)
 872                 | ty::PredicateKind::ConstEquate(..)
 873                 | ty::PredicateKind::TypeWellFormedFromEnv(..) => None,
 874                 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ref t, ref r)) => {
 875                     // Search for a bound of the form `erased_self_ty
 876                     // : 'a`, but be wary of something like `for<'a>
 877                     // erased_self_ty : 'a` (we interpret a
 878                     // higher-ranked bound like that as 'static,
 879                     // though at present the code in `fulfill.rs`
 880                     // considers such bounds to be unsatisfiable, so
 881                     // it's kind of a moot point since you could never
 882                     // construct such an object, but this seems
 883                     // correct even if that code changes).
 884                     if t == &erased_self_ty && !r.has_escaping_bound_vars() {
 885                         Some(*r)
 886                     } else {
 887                         None
 888                     }
 889                 }
 890             }
 891         })
 892         .collect()
 893 }