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