compiler/rustc_hir_analysis/src/collect/predicates_of.rs

   1 use crate::astconv::AstConv;
   2 use crate::bounds::Bounds;
   3 use crate::collect::ItemCtxt;
   4 use crate::constrained_generic_params as cgp;
   5 use hir::{HirId, Node};
   6 use rustc_data_structures::fx::FxIndexSet;
   7 use rustc_hir as hir;
   8 use rustc_hir::def::DefKind;
   9 use rustc_hir::def_id::{DefId, LocalDefId};
  10 use rustc_hir::intravisit::{self, Visitor};
  11 use rustc_middle::ty::subst::InternalSubsts;
  12 use rustc_middle::ty::ToPredicate;
  13 use rustc_middle::ty::{self, Ty, TyCtxt};
  14 use rustc_span::symbol::{sym, Ident};
  15 use rustc_span::{Span, DUMMY_SP};
  16
  17 #[derive(Debug)]
  18 struct OnlySelfBounds(bool);
  19
  20 /// Returns a list of all type predicates (explicit and implicit) for the definition with
  21 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
  22 /// `Self: Trait` predicates for traits.
  23 pub(super) fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
  24     let mut result = tcx.predicates_defined_on(def_id);
  25
  26     if tcx.is_trait(def_id) {
  27         // For traits, add `Self: Trait` predicate. This is
  28         // not part of the predicates that a user writes, but it
  29         // is something that one must prove in order to invoke a
  30         // method or project an associated type.
  31         //
  32         // In the chalk setup, this predicate is not part of the
  33         // "predicates" for a trait item. But it is useful in
  34         // rustc because if you directly (e.g.) invoke a trait
  35         // method like `Trait::method(...)`, you must naturally
  36         // prove that the trait applies to the types that were
  37         // used, and adding the predicate into this list ensures
  38         // that this is done.
  39         //
  40         // We use a DUMMY_SP here as a way to signal trait bounds that come
  41         // from the trait itself that *shouldn't* be shown as the source of
  42         // an obligation and instead be skipped. Otherwise we'd use
  43         // `tcx.def_span(def_id);`
  44
  45         let constness = if tcx.has_attr(def_id, sym::const_trait) {
  46             ty::BoundConstness::ConstIfConst
  47         } else {
  48             ty::BoundConstness::NotConst
  49         };
  50
  51         let span = rustc_span::DUMMY_SP;
  52         result.predicates =
  53             tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(std::iter::once((
  54                 ty::TraitRef::identity(tcx, def_id).with_constness(constness).to_predicate(tcx),
  55                 span,
  56             ))));
  57     }
  58     debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
  59     result
  60 }
  61
  62 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
  63 /// N.B., this does not include any implied/inferred constraints.
  64 #[instrument(level = "trace", skip(tcx), ret)]
  65 fn gather_explicit_predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
  66     use rustc_hir::*;
  67
  68     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
  69     let node = tcx.hir().get(hir_id);
  70
  71     let mut is_trait = None;
  72     let mut is_default_impl_trait = None;
  73
  74     let icx = ItemCtxt::new(tcx, def_id);
  75
  76     const NO_GENERICS: &hir::Generics<'_> = hir::Generics::empty();
  77
  78     // We use an `IndexSet` to preserve order of insertion.
  79     // Preserving the order of insertion is important here so as not to break UI tests.
  80     let mut predicates: FxIndexSet<(ty::Predicate<'_>, Span)> = FxIndexSet::default();
  81
  82     let ast_generics = match node {
  83         Node::TraitItem(item) => item.generics,
  84
  85         Node::ImplItem(item) => item.generics,
  86
  87         Node::Item(item) => match item.kind {
  88             ItemKind::Impl(ref impl_) => {
  89                 if impl_.defaultness.is_default() {
  90                     is_default_impl_trait = tcx.impl_trait_ref(def_id).map(ty::Binder::dummy);
  91                 }
  92                 &impl_.generics
  93             }
  94             ItemKind::Fn(.., ref generics, _)
  95             | ItemKind::TyAlias(_, ref generics)
  96             | ItemKind::Enum(_, ref generics)
  97             | ItemKind::Struct(_, ref generics)
  98             | ItemKind::Union(_, ref generics) => *generics,
  99
 100             ItemKind::Trait(_, _, ref generics, ..) | ItemKind::TraitAlias(ref generics, _) => {
 101                 is_trait = Some(ty::TraitRef::identity(tcx, def_id));
 102                 *generics
 103             }
 104             ItemKind::OpaqueTy(OpaqueTy { ref generics, .. }) => generics,
 105             _ => NO_GENERICS,
 106         },
 107
 108         Node::ForeignItem(item) => match item.kind {
 109             ForeignItemKind::Static(..) => NO_GENERICS,
 110             ForeignItemKind::Fn(_, _, ref generics) => *generics,
 111             ForeignItemKind::Type => NO_GENERICS,
 112         },
 113
 114         _ => NO_GENERICS,
 115     };
 116
 117     let generics = tcx.generics_of(def_id);
 118     let parent_count = generics.parent_count as u32;
 119     let has_own_self = generics.has_self && parent_count == 0;
 120
 121     // Below we'll consider the bounds on the type parameters (including `Self`)
 122     // and the explicit where-clauses, but to get the full set of predicates
 123     // on a trait we need to add in the supertrait bounds and bounds found on
 124     // associated types.
 125     if let Some(_trait_ref) = is_trait {
 126         predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
 127     }
 128
 129     // In default impls, we can assume that the self type implements
 130     // the trait. So in:
 131     //
 132     //     default impl Foo for Bar { .. }
 133     //
 134     // we add a default where clause `Foo: Bar`. We do a similar thing for traits
 135     // (see below). Recall that a default impl is not itself an impl, but rather a
 136     // set of defaults that can be incorporated into another impl.
 137     if let Some(trait_ref) = is_default_impl_trait {
 138         predicates.insert((trait_ref.without_const().to_predicate(tcx), tcx.def_span(def_id)));
 139     }
 140
 141     // Collect the region predicates that were declared inline as
 142     // well. In the case of parameters declared on a fn or method, we
 143     // have to be careful to only iterate over early-bound regions.
 144     let mut index = parent_count
 145         + has_own_self as u32
 146         + super::early_bound_lifetimes_from_generics(tcx, ast_generics).count() as u32;
 147
 148     trace!(?predicates);
 149     trace!(?ast_generics);
 150     trace!(?generics);
 151
 152     // Collect the predicates that were written inline by the user on each
 153     // type parameter (e.g., `<T: Foo>`).
 154     for param in ast_generics.params {
 155         match param.kind {
 156             // We already dealt with early bound lifetimes above.
 157             GenericParamKind::Lifetime { .. } => (),
 158             GenericParamKind::Type { .. } => {
 159                 let name = param.name.ident().name;
 160                 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
 161                 index += 1;
 162
 163                 let mut bounds = Bounds::default();
 164                 // Params are implicitly sized unless a `?Sized` bound is found
 165                 icx.astconv().add_implicitly_sized(
 166                     &mut bounds,
 167                     param_ty,
 168                     &[],
 169                     Some((param.def_id, ast_generics.predicates)),
 170                     param.span,
 171                 );
 172                 trace!(?bounds);
 173                 predicates.extend(bounds.predicates());
 174                 trace!(?predicates);
 175             }
 176             GenericParamKind::Const { .. } => {
 177                 // Bounds on const parameters are currently not possible.
 178                 index += 1;
 179             }
 180         }
 181     }
 182
 183     trace!(?predicates);
 184     // Add in the bounds that appear in the where-clause.
 185     for predicate in ast_generics.predicates {
 186         match predicate {
 187             hir::WherePredicate::BoundPredicate(bound_pred) => {
 188                 let ty = icx.to_ty(bound_pred.bounded_ty);
 189                 let bound_vars = icx.tcx.late_bound_vars(bound_pred.hir_id);
 190
 191                 // Keep the type around in a dummy predicate, in case of no bounds.
 192                 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
 193                 // is still checked for WF.
 194                 if bound_pred.bounds.is_empty() {
 195                     if let ty::Param(_) = ty.kind() {
 196                         // This is a `where T:`, which can be in the HIR from the
 197                         // transformation that moves `?Sized` to `T`'s declaration.
 198                         // We can skip the predicate because type parameters are
 199                         // trivially WF, but also we *should*, to avoid exposing
 200                         // users who never wrote `where Type:,` themselves, to
 201                         // compiler/tooling bugs from not handling WF predicates.
 202                     } else {
 203                         let span = bound_pred.bounded_ty.span;
 204                         let predicate = ty::Binder::bind_with_vars(
 205                             ty::PredicateKind::WellFormed(ty.into()),
 206                             bound_vars,
 207                         );
 208                         predicates.insert((predicate.to_predicate(tcx), span));
 209                     }
 210                 }
 211
 212                 let mut bounds = Bounds::default();
 213                 icx.astconv().add_bounds(ty, bound_pred.bounds.iter(), &mut bounds, bound_vars);
 214                 predicates.extend(bounds.predicates());
 215             }
 216
 217             hir::WherePredicate::RegionPredicate(region_pred) => {
 218                 let r1 = icx.astconv().ast_region_to_region(&region_pred.lifetime, None);
 219                 predicates.extend(region_pred.bounds.iter().map(|bound| {
 220                     let (r2, span) = match bound {
 221                         hir::GenericBound::Outlives(lt) => {
 222                             (icx.astconv().ast_region_to_region(lt, None), lt.ident.span)
 223                         }
 224                         _ => bug!(),
 225                     };
 226                     let pred = ty::Binder::dummy(ty::PredicateKind::Clause(
 227                         ty::Clause::RegionOutlives(ty::OutlivesPredicate(r1, r2)),
 228                     ))
 229                     .to_predicate(icx.tcx);
 230
 231                     (pred, span)
 232                 }))
 233             }
 234
 235             hir::WherePredicate::EqPredicate(..) => {
 236                 // FIXME(#20041)
 237             }
 238         }
 239     }
 240
 241     if tcx.features().generic_const_exprs {
 242         predicates.extend(const_evaluatable_predicates_of(tcx, def_id.expect_local()));
 243     }
 244
 245     let mut predicates: Vec<_> = predicates.into_iter().collect();
 246
 247     // Subtle: before we store the predicates into the tcx, we
 248     // sort them so that predicates like `T: Foo<Item=U>` come
 249     // before uses of `U`.  This avoids false ambiguity errors
 250     // in trait checking. See `setup_constraining_predicates`
 251     // for details.
 252     if let Node::Item(&Item { kind: ItemKind::Impl { .. }, .. }) = node {
 253         let self_ty = tcx.type_of(def_id);
 254         let trait_ref = tcx.impl_trait_ref(def_id);
 255         cgp::setup_constraining_predicates(
 256             tcx,
 257             &mut predicates,
 258             trait_ref,
 259             &mut cgp::parameters_for_impl(self_ty, trait_ref),
 260         );
 261     }
 262
 263     // Opaque types duplicate some of their generic parameters.
 264     // We create bi-directional Outlives predicates between the original
 265     // and the duplicated parameter, to ensure that they do not get out of sync.
 266     if let Node::Item(&Item { kind: ItemKind::OpaqueTy(..), .. }) = node {
 267         let opaque_ty_id = tcx.hir().parent_id(hir_id);
 268         let opaque_ty_node = tcx.hir().get(opaque_ty_id);
 269         let Node::Ty(&Ty { kind: TyKind::OpaqueDef(_, lifetimes, _), .. }) = opaque_ty_node else {
 270             bug!("unexpected {opaque_ty_node:?}")
 271         };
 272         debug!(?lifetimes);
 273         for (arg, duplicate) in std::iter::zip(lifetimes, ast_generics.params) {
 274             let hir::GenericArg::Lifetime(arg) = arg else { bug!() };
 275             let orig_region = icx.astconv().ast_region_to_region(&arg, None);
 276             if !matches!(orig_region.kind(), ty::ReEarlyBound(..)) {
 277                 // Only early-bound regions can point to the original generic parameter.
 278                 continue;
 279             }
 280
 281             let hir::GenericParamKind::Lifetime { .. } = duplicate.kind else { continue };
 282             let dup_def = tcx.hir().local_def_id(duplicate.hir_id).to_def_id();
 283
 284             let Some(dup_index) = generics.param_def_id_to_index(tcx, dup_def) else { bug!() };
 285
 286             let dup_region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
 287                 def_id: dup_def,
 288                 index: dup_index,
 289                 name: duplicate.name.ident().name,
 290             }));
 291             predicates.push((
 292                 ty::Binder::dummy(ty::PredicateKind::Clause(ty::Clause::RegionOutlives(
 293                     ty::OutlivesPredicate(orig_region, dup_region),
 294                 )))
 295                 .to_predicate(icx.tcx),
 296                 duplicate.span,
 297             ));
 298             predicates.push((
 299                 ty::Binder::dummy(ty::PredicateKind::Clause(ty::Clause::RegionOutlives(
 300                     ty::OutlivesPredicate(dup_region, orig_region),
 301                 )))
 302                 .to_predicate(icx.tcx),
 303                 duplicate.span,
 304             ));
 305         }
 306         debug!(?predicates);
 307     }
 308
 309     ty::GenericPredicates {
 310         parent: generics.parent,
 311         predicates: tcx.arena.alloc_from_iter(predicates),
 312     }
 313 }
 314
 315 fn const_evaluatable_predicates_of(
 316     tcx: TyCtxt<'_>,
 317     def_id: LocalDefId,
 318 ) -> FxIndexSet<(ty::Predicate<'_>, Span)> {
 319     struct ConstCollector<'tcx> {
 320         tcx: TyCtxt<'tcx>,
 321         preds: FxIndexSet<(ty::Predicate<'tcx>, Span)>,
 322     }
 323
 324     impl<'tcx> intravisit::Visitor<'tcx> for ConstCollector<'tcx> {
 325         fn visit_anon_const(&mut self, c: &'tcx hir::AnonConst) {
 326             let ct = ty::Const::from_anon_const(self.tcx, c.def_id);
 327             if let ty::ConstKind::Unevaluated(_) = ct.kind() {
 328                 let span = self.tcx.def_span(c.def_id);
 329                 self.preds.insert((
 330                     ty::Binder::dummy(ty::PredicateKind::ConstEvaluatable(ct))
 331                         .to_predicate(self.tcx),
 332                     span,
 333                 ));
 334             }
 335         }
 336
 337         fn visit_const_param_default(&mut self, _param: HirId, _ct: &'tcx hir::AnonConst) {
 338             // Do not look into const param defaults,
 339             // these get checked when they are actually instantiated.
 340             //
 341             // We do not want the following to error:
 342             //
 343             //     struct Foo<const N: usize, const M: usize = { N + 1 }>;
 344             //     struct Bar<const N: usize>(Foo<N, 3>);
 345         }
 346     }
 347
 348     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
 349     let node = tcx.hir().get(hir_id);
 350
 351     let mut collector = ConstCollector { tcx, preds: FxIndexSet::default() };
 352     if let hir::Node::Item(item) = node && let hir::ItemKind::Impl(ref impl_) = item.kind {
 353         if let Some(of_trait) = &impl_.of_trait {
 354             debug!("const_evaluatable_predicates_of({:?}): visit impl trait_ref", def_id);
 355             collector.visit_trait_ref(of_trait);
 356         }
 357
 358         debug!("const_evaluatable_predicates_of({:?}): visit_self_ty", def_id);
 359         collector.visit_ty(impl_.self_ty);
 360     }
 361
 362     if let Some(generics) = node.generics() {
 363         debug!("const_evaluatable_predicates_of({:?}): visit_generics", def_id);
 364         collector.visit_generics(generics);
 365     }
 366
 367     if let Some(fn_sig) = tcx.hir().fn_sig_by_hir_id(hir_id) {
 368         debug!("const_evaluatable_predicates_of({:?}): visit_fn_decl", def_id);
 369         collector.visit_fn_decl(fn_sig.decl);
 370     }
 371     debug!("const_evaluatable_predicates_of({:?}) = {:?}", def_id, collector.preds);
 372
 373     collector.preds
 374 }
 375
 376 pub(super) fn trait_explicit_predicates_and_bounds(
 377     tcx: TyCtxt<'_>,
 378     def_id: LocalDefId,
 379 ) -> ty::GenericPredicates<'_> {
 380     assert_eq!(tcx.def_kind(def_id), DefKind::Trait);
 381     gather_explicit_predicates_of(tcx, def_id.to_def_id())
 382 }
 383
 384 pub(super) fn explicit_predicates_of<'tcx>(
 385     tcx: TyCtxt<'tcx>,
 386     def_id: DefId,
 387 ) -> ty::GenericPredicates<'tcx> {
 388     let def_kind = tcx.def_kind(def_id);
 389     if let DefKind::Trait = def_kind {
 390         // Remove bounds on associated types from the predicates, they will be
 391         // returned by `explicit_item_bounds`.
 392         let predicates_and_bounds = tcx.trait_explicit_predicates_and_bounds(def_id.expect_local());
 393         let trait_identity_substs = InternalSubsts::identity_for_item(tcx, def_id);
 394
 395         let is_assoc_item_ty = |ty: Ty<'tcx>| {
 396             // For a predicate from a where clause to become a bound on an
 397             // associated type:
 398             // * It must use the identity substs of the item.
 399             //   * We're in the scope of the trait, so we can't name any
 400             //     parameters of the GAT. That means that all we need to
 401             //     check are that the substs of the projection are the
 402             //     identity substs of the trait.
 403             // * It must be an associated type for this trait (*not* a
 404             //   supertrait).
 405             if let ty::Alias(ty::Projection, projection) = ty.kind() {
 406                 projection.substs == trait_identity_substs
 407                     && tcx.associated_item(projection.def_id).container_id(tcx) == def_id
 408             } else {
 409                 false
 410             }
 411         };
 412
 413         let predicates: Vec<_> = predicates_and_bounds
 414             .predicates
 415             .iter()
 416             .copied()
 417             .filter(|(pred, _)| match pred.kind().skip_binder() {
 418                 ty::PredicateKind::Clause(ty::Clause::Trait(tr)) => !is_assoc_item_ty(tr.self_ty()),
 419                 ty::PredicateKind::Clause(ty::Clause::Projection(proj)) => {
 420                     !is_assoc_item_ty(proj.projection_ty.self_ty())
 421                 }
 422                 ty::PredicateKind::Clause(ty::Clause::TypeOutlives(outlives)) => {
 423                     !is_assoc_item_ty(outlives.0)
 424                 }
 425                 _ => true,
 426             })
 427             .collect();
 428         if predicates.len() == predicates_and_bounds.predicates.len() {
 429             predicates_and_bounds
 430         } else {
 431             ty::GenericPredicates {
 432                 parent: predicates_and_bounds.parent,
 433                 predicates: tcx.arena.alloc_slice(&predicates),
 434             }
 435         }
 436     } else {
 437         if matches!(def_kind, DefKind::AnonConst) && tcx.lazy_normalization() {
 438             let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 439             let parent_def_id = tcx.hir().get_parent_item(hir_id);
 440
 441             if tcx.hir().opt_const_param_default_param_def_id(hir_id).is_some() {
 442                 // In `generics_of` we set the generics' parent to be our parent's parent which means that
 443                 // we lose out on the predicates of our actual parent if we dont return those predicates here.
 444                 // (See comment in `generics_of` for more information on why the parent shenanigans is necessary)
 445                 //
 446                 // struct Foo<T, const N: usize = { <T as Trait>::ASSOC }>(T) where T: Trait;
 447                 //        ^^^                     ^^^^^^^^^^^^^^^^^^^^^^^ the def id we are calling
 448                 //        ^^^                                             explicit_predicates_of on
 449                 //        parent item we dont have set as the
 450                 //        parent of generics returned by `generics_of`
 451                 //
 452                 // In the above code we want the anon const to have predicates in its param env for `T: Trait`
 453                 // and we would be calling `explicit_predicates_of(Foo)` here
 454                 return tcx.explicit_predicates_of(parent_def_id);
 455             }
 456
 457             let parent_def_kind = tcx.def_kind(parent_def_id);
 458             if matches!(parent_def_kind, DefKind::OpaqueTy) {
 459                 // In `instantiate_identity` we inherit the predicates of our parent.
 460                 // However, opaque types do not have a parent (see `gather_explicit_predicates_of`), which means
 461                 // that we lose out on the predicates of our actual parent if we dont return those predicates here.
 462                 //
 463                 //
 464                 // fn foo<T: Trait>() -> impl Iterator<Output = Another<{ <T as Trait>::ASSOC }> > { todo!() }
 465                 //                                                        ^^^^^^^^^^^^^^^^^^^ the def id we are calling
 466                 //                                                                            explicit_predicates_of on
 467                 //
 468                 // In the above code we want the anon const to have predicates in its param env for `T: Trait`.
 469                 // However, the anon const cannot inherit predicates from its parent since it's opaque.
 470                 //
 471                 // To fix this, we call `explicit_predicates_of` directly on `foo`, the parent's parent.
 472
 473                 // In the above example this is `foo::{opaque#0}` or `impl Iterator`
 474                 let parent_hir_id = tcx.hir().local_def_id_to_hir_id(parent_def_id.def_id);
 475
 476                 // In the above example this is the function `foo`
 477                 let item_def_id = tcx.hir().get_parent_item(parent_hir_id);
 478
 479                 // In the above code example we would be calling `explicit_predicates_of(foo)` here
 480                 return tcx.explicit_predicates_of(item_def_id);
 481             }
 482         }
 483         gather_explicit_predicates_of(tcx, def_id)
 484     }
 485 }
 486
 487 /// Ensures that the super-predicates of the trait with a `DefId`
 488 /// of `trait_def_id` are converted and stored. This also ensures that
 489 /// the transitive super-predicates are converted.
 490 pub(super) fn super_predicates_of(
 491     tcx: TyCtxt<'_>,
 492     trait_def_id: DefId,
 493 ) -> ty::GenericPredicates<'_> {
 494     tcx.super_predicates_that_define_assoc_type((trait_def_id, None))
 495 }
 496
 497 /// Ensures that the super-predicates of the trait with a `DefId`
 498 /// of `trait_def_id` are converted and stored. This also ensures that
 499 /// the transitive super-predicates are converted.
 500 pub(super) fn super_predicates_that_define_assoc_type(
 501     tcx: TyCtxt<'_>,
 502     (trait_def_id, assoc_name): (DefId, Option<Ident>),
 503 ) -> ty::GenericPredicates<'_> {
 504     if trait_def_id.is_local() {
 505         debug!("local trait");
 506         let trait_hir_id = tcx.hir().local_def_id_to_hir_id(trait_def_id.expect_local());
 507
 508         let Node::Item(item) = tcx.hir().get(trait_hir_id) else {
 509             bug!("trait_node_id {} is not an item", trait_hir_id);
 510         };
 511
 512         let (generics, bounds) = match item.kind {
 513             hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
 514             hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
 515             _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
 516         };
 517
 518         let icx = ItemCtxt::new(tcx, trait_def_id);
 519
 520         // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
 521         let self_param_ty = tcx.types.self_param;
 522         let superbounds1 = if let Some(assoc_name) = assoc_name {
 523             icx.astconv().compute_bounds_that_match_assoc_type(self_param_ty, bounds, assoc_name)
 524         } else {
 525             icx.astconv().compute_bounds(self_param_ty, bounds)
 526         };
 527
 528         let superbounds1 = superbounds1.predicates();
 529
 530         // Convert any explicit superbounds in the where-clause,
 531         // e.g., `trait Foo where Self: Bar`.
 532         // In the case of trait aliases, however, we include all bounds in the where-clause,
 533         // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
 534         // as one of its "superpredicates".
 535         let is_trait_alias = tcx.is_trait_alias(trait_def_id);
 536         let superbounds2 = icx.type_parameter_bounds_in_generics(
 537             generics,
 538             item.owner_id.def_id,
 539             self_param_ty,
 540             OnlySelfBounds(!is_trait_alias),
 541             assoc_name,
 542         );
 543
 544         // Combine the two lists to form the complete set of superbounds:
 545         let superbounds = &*tcx.arena.alloc_from_iter(superbounds1.into_iter().chain(superbounds2));
 546         debug!(?superbounds);
 547
 548         // Now require that immediate supertraits are converted,
 549         // which will, in turn, reach indirect supertraits.
 550         if assoc_name.is_none() {
 551             // Now require that immediate supertraits are converted,
 552             // which will, in turn, reach indirect supertraits.
 553             for &(pred, span) in superbounds {
 554                 debug!("superbound: {:?}", pred);
 555                 if let ty::PredicateKind::Clause(ty::Clause::Trait(bound)) =
 556                     pred.kind().skip_binder()
 557                 {
 558                     tcx.at(span).super_predicates_of(bound.def_id());
 559                 }
 560             }
 561         }
 562
 563         ty::GenericPredicates { parent: None, predicates: superbounds }
 564     } else {
 565         // if `assoc_name` is None, then the query should've been redirected to an
 566         // external provider
 567         assert!(assoc_name.is_some());
 568         tcx.super_predicates_of(trait_def_id)
 569     }
 570 }
 571
 572 /// Returns the predicates defined on `item_def_id` of the form
 573 /// `X: Foo` where `X` is the type parameter `def_id`.
 574 #[instrument(level = "trace", skip(tcx))]
 575 pub(super) fn type_param_predicates(
 576     tcx: TyCtxt<'_>,
 577     (item_def_id, def_id, assoc_name): (DefId, LocalDefId, Ident),
 578 ) -> ty::GenericPredicates<'_> {
 579     use rustc_hir::*;
 580
 581     // In the AST, bounds can derive from two places. Either
 582     // written inline like `<T: Foo>` or in a where-clause like
 583     // `where T: Foo`.
 584
 585     let param_id = tcx.hir().local_def_id_to_hir_id(def_id);
 586     let param_owner = tcx.hir().ty_param_owner(def_id);
 587     let generics = tcx.generics_of(param_owner);
 588     let index = generics.param_def_id_to_index[&def_id.to_def_id()];
 589     let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(def_id));
 590
 591     // Don't look for bounds where the type parameter isn't in scope.
 592     let parent = if item_def_id == param_owner.to_def_id() {
 593         None
 594     } else {
 595         tcx.generics_of(item_def_id).parent
 596     };
 597
 598     let mut result = parent
 599         .map(|parent| {
 600             let icx = ItemCtxt::new(tcx, parent);
 601             icx.get_type_parameter_bounds(DUMMY_SP, def_id.to_def_id(), assoc_name)
 602         })
 603         .unwrap_or_default();
 604     let mut extend = None;
 605
 606     let item_hir_id = tcx.hir().local_def_id_to_hir_id(item_def_id.expect_local());
 607     let ast_generics = match tcx.hir().get(item_hir_id) {
 608         Node::TraitItem(item) => &item.generics,
 609
 610         Node::ImplItem(item) => &item.generics,
 611
 612         Node::Item(item) => {
 613             match item.kind {
 614                 ItemKind::Fn(.., ref generics, _)
 615                 | ItemKind::Impl(hir::Impl { ref generics, .. })
 616                 | ItemKind::TyAlias(_, ref generics)
 617                 | ItemKind::OpaqueTy(OpaqueTy {
 618                     ref generics,
 619                     origin: hir::OpaqueTyOrigin::TyAlias,
 620                     ..
 621                 })
 622                 | ItemKind::Enum(_, ref generics)
 623                 | ItemKind::Struct(_, ref generics)
 624                 | ItemKind::Union(_, ref generics) => generics,
 625                 ItemKind::Trait(_, _, ref generics, ..) => {
 626                     // Implied `Self: Trait` and supertrait bounds.
 627                     if param_id == item_hir_id {
 628                         let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
 629                         extend =
 630                             Some((identity_trait_ref.without_const().to_predicate(tcx), item.span));
 631                     }
 632                     generics
 633                 }
 634                 _ => return result,
 635             }
 636         }
 637
 638         Node::ForeignItem(item) => match item.kind {
 639             ForeignItemKind::Fn(_, _, ref generics) => generics,
 640             _ => return result,
 641         },
 642
 643         _ => return result,
 644     };
 645
 646     let icx = ItemCtxt::new(tcx, item_def_id);
 647     let extra_predicates = extend.into_iter().chain(
 648         icx.type_parameter_bounds_in_generics(
 649             ast_generics,
 650             def_id,
 651             ty,
 652             OnlySelfBounds(true),
 653             Some(assoc_name),
 654         )
 655         .into_iter()
 656         .filter(|(predicate, _)| match predicate.kind().skip_binder() {
 657             ty::PredicateKind::Clause(ty::Clause::Trait(data)) => data.self_ty().is_param(index),
 658             _ => false,
 659         }),
 660     );
 661     result.predicates =
 662         tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(extra_predicates));
 663     result
 664 }
 665
 666 impl<'tcx> ItemCtxt<'tcx> {
 667     /// Finds bounds from `hir::Generics`. This requires scanning through the
 668     /// AST. We do this to avoid having to convert *all* the bounds, which
 669     /// would create artificial cycles. Instead, we can only convert the
 670     /// bounds for a type parameter `X` if `X::Foo` is used.
 671     #[instrument(level = "trace", skip(self, ast_generics))]
 672     fn type_parameter_bounds_in_generics(
 673         &self,
 674         ast_generics: &'tcx hir::Generics<'tcx>,
 675         param_def_id: LocalDefId,
 676         ty: Ty<'tcx>,
 677         only_self_bounds: OnlySelfBounds,
 678         assoc_name: Option<Ident>,
 679     ) -> Vec<(ty::Predicate<'tcx>, Span)> {
 680         ast_generics
 681             .predicates
 682             .iter()
 683             .filter_map(|wp| match *wp {
 684                 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
 685                 _ => None,
 686             })
 687             .flat_map(|bp| {
 688                 let bt = if bp.is_param_bound(param_def_id.to_def_id()) {
 689                     Some(ty)
 690                 } else if !only_self_bounds.0 {
 691                     Some(self.to_ty(bp.bounded_ty))
 692                 } else {
 693                     None
 694                 };
 695                 let bvars = self.tcx.late_bound_vars(bp.hir_id);
 696
 697                 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b, bvars))).filter(
 698                     |(_, b, _)| match assoc_name {
 699                         Some(assoc_name) => self.bound_defines_assoc_item(b, assoc_name),
 700                         None => true,
 701                     },
 702                 )
 703             })
 704             .flat_map(|(bt, b, bvars)| predicates_from_bound(self, bt, b, bvars))
 705             .collect()
 706     }
 707
 708     #[instrument(level = "trace", skip(self))]
 709     fn bound_defines_assoc_item(&self, b: &hir::GenericBound<'_>, assoc_name: Ident) -> bool {
 710         match b {
 711             hir::GenericBound::Trait(poly_trait_ref, _) => {
 712                 let trait_ref = &poly_trait_ref.trait_ref;
 713                 if let Some(trait_did) = trait_ref.trait_def_id() {
 714                     self.tcx.trait_may_define_assoc_type(trait_did, assoc_name)
 715                 } else {
 716                     false
 717                 }
 718             }
 719             _ => false,
 720         }
 721     }
 722 }
 723
 724 /// Converts a specific `GenericBound` from the AST into a set of
 725 /// predicates that apply to the self type. A vector is returned
 726 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
 727 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
 728 /// and `<T as Bar>::X == i32`).
 729 fn predicates_from_bound<'tcx>(
 730     astconv: &dyn AstConv<'tcx>,
 731     param_ty: Ty<'tcx>,
 732     bound: &'tcx hir::GenericBound<'tcx>,
 733     bound_vars: &'tcx ty::List<ty::BoundVariableKind>,
 734 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
 735     let mut bounds = Bounds::default();
 736     astconv.add_bounds(param_ty, [bound].into_iter(), &mut bounds, bound_vars);
 737     bounds.predicates().collect()
 738 }