compiler/rustc_typeck/src/collect/type_of.rs

   1 use rustc_errors::{Applicability, StashKey};
   2 use rustc_hir as hir;
   3 use rustc_hir::def_id::{DefId, LocalDefId};
   4 use rustc_hir::intravisit;
   5 use rustc_hir::intravisit::Visitor;
   6 use rustc_hir::{HirId, Node};
   7 use rustc_middle::hir::nested_filter;
   8 use rustc_middle::ty::subst::InternalSubsts;
   9 use rustc_middle::ty::util::IntTypeExt;
  10 use rustc_middle::ty::{self, DefIdTree, Ty, TyCtxt, TypeFolder, TypeSuperFoldable, TypeVisitable};
  11 use rustc_span::symbol::Ident;
  12 use rustc_span::{Span, DUMMY_SP};
  13
  14 use super::ItemCtxt;
  15 use super::{bad_placeholder, is_suggestable_infer_ty};
  16 use crate::errors::UnconstrainedOpaqueType;
  17
  18 /// Computes the relevant generic parameter for a potential generic const argument.
  19 ///
  20 /// This should be called using the query `tcx.opt_const_param_of`.
  21 pub(super) fn opt_const_param_of(tcx: TyCtxt<'_>, def_id: LocalDefId) -> Option<DefId> {
  22     use hir::*;
  23     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
  24
  25     match tcx.hir().get(hir_id) {
  26         Node::AnonConst(_) => (),
  27         _ => return None,
  28     };
  29
  30     let parent_node_id = tcx.hir().get_parent_node(hir_id);
  31     let parent_node = tcx.hir().get(parent_node_id);
  32
  33     let (generics, arg_idx) = match parent_node {
  34         // This match arm is for when the def_id appears in a GAT whose
  35         // path can't be resolved without typechecking e.g.
  36         //
  37         // trait Foo {
  38         //   type Assoc<const N: usize>;
  39         //   fn foo() -> Self::Assoc<3>;
  40         // }
  41         //
  42         // In the above code we would call this query with the def_id of 3 and
  43         // the parent_node we match on would be the hir node for Self::Assoc<3>
  44         //
  45         // `Self::Assoc<3>` cant be resolved without typechecking here as we
  46         // didnt write <Self as Foo>::Assoc<3>. If we did then another match
  47         // arm would handle this.
  48         //
  49         // I believe this match arm is only needed for GAT but I am not 100% sure - BoxyUwU
  50         Node::Ty(hir_ty @ Ty { kind: TyKind::Path(QPath::TypeRelative(_, segment)), .. }) => {
  51             // Find the Item containing the associated type so we can create an ItemCtxt.
  52             // Using the ItemCtxt convert the HIR for the unresolved assoc type into a
  53             // ty which is a fully resolved projection.
  54             // For the code example above, this would mean converting Self::Assoc<3>
  55             // into a ty::Projection(<Self as Foo>::Assoc<3>)
  56             let item_hir_id = tcx
  57                 .hir()
  58                 .parent_iter(hir_id)
  59                 .filter(|(_, node)| matches!(node, Node::Item(_)))
  60                 .map(|(id, _)| id)
  61                 .next()
  62                 .unwrap();
  63             let item_did = tcx.hir().local_def_id(item_hir_id).to_def_id();
  64             let item_ctxt = &ItemCtxt::new(tcx, item_did) as &dyn crate::astconv::AstConv<'_>;
  65             let ty = item_ctxt.ast_ty_to_ty(hir_ty);
  66
  67             // Iterate through the generics of the projection to find the one that corresponds to
  68             // the def_id that this query was called with. We filter to only const args here as a
  69             // precaution for if it's ever allowed to elide lifetimes in GAT's. It currently isn't
  70             // but it can't hurt to be safe ^^
  71             if let ty::Projection(projection) = ty.kind() {
  72                 let generics = tcx.generics_of(projection.item_def_id);
  73
  74                 let arg_index = segment
  75                     .args
  76                     .and_then(|args| {
  77                         args.args
  78                             .iter()
  79                             .filter(|arg| arg.is_ty_or_const())
  80                             .position(|arg| arg.hir_id() == hir_id)
  81                     })
  82                     .unwrap_or_else(|| {
  83                         bug!("no arg matching AnonConst in segment");
  84                     });
  85
  86                 (generics, arg_index)
  87             } else {
  88                 // I dont think it's possible to reach this but I'm not 100% sure - BoxyUwU
  89                 tcx.sess.delay_span_bug(
  90                     tcx.def_span(def_id),
  91                     "unexpected non-GAT usage of an anon const",
  92                 );
  93                 return None;
  94             }
  95         }
  96         Node::Expr(&Expr {
  97             kind:
  98                 ExprKind::MethodCall(segment, ..) | ExprKind::Path(QPath::TypeRelative(_, segment)),
  99             ..
 100         }) => {
 101             let body_owner = tcx.hir().enclosing_body_owner(hir_id);
 102             let tables = tcx.typeck(body_owner);
 103             // This may fail in case the method/path does not actually exist.
 104             // As there is no relevant param for `def_id`, we simply return
 105             // `None` here.
 106             let type_dependent_def = tables.type_dependent_def_id(parent_node_id)?;
 107             let idx = segment
 108                 .args
 109                 .and_then(|args| {
 110                     args.args
 111                         .iter()
 112                         .filter(|arg| arg.is_ty_or_const())
 113                         .position(|arg| arg.hir_id() == hir_id)
 114                 })
 115                 .unwrap_or_else(|| {
 116                     bug!("no arg matching AnonConst in segment");
 117                 });
 118
 119             (tcx.generics_of(type_dependent_def), idx)
 120         }
 121
 122         Node::Ty(&Ty { kind: TyKind::Path(_), .. })
 123         | Node::Expr(&Expr { kind: ExprKind::Path(_) | ExprKind::Struct(..), .. })
 124         | Node::TraitRef(..)
 125         | Node::Pat(_) => {
 126             let path = match parent_node {
 127                 Node::Ty(&Ty { kind: TyKind::Path(QPath::Resolved(_, path)), .. })
 128                 | Node::TraitRef(&TraitRef { path, .. }) => &*path,
 129                 Node::Expr(&Expr {
 130                     kind:
 131                         ExprKind::Path(QPath::Resolved(_, path))
 132                         | ExprKind::Struct(&QPath::Resolved(_, path), ..),
 133                     ..
 134                 }) => {
 135                     let body_owner = tcx.hir().enclosing_body_owner(hir_id);
 136                     let _tables = tcx.typeck(body_owner);
 137                     &*path
 138                 }
 139                 Node::Pat(pat) => {
 140                     if let Some(path) = get_path_containing_arg_in_pat(pat, hir_id) {
 141                         path
 142                     } else {
 143                         tcx.sess.delay_span_bug(
 144                             tcx.def_span(def_id),
 145                             &format!("unable to find const parent for {} in pat {:?}", hir_id, pat),
 146                         );
 147                         return None;
 148                     }
 149                 }
 150                 _ => {
 151                     tcx.sess.delay_span_bug(
 152                         tcx.def_span(def_id),
 153                         &format!("unexpected const parent path {:?}", parent_node),
 154                     );
 155                     return None;
 156                 }
 157             };
 158
 159             // We've encountered an `AnonConst` in some path, so we need to
 160             // figure out which generic parameter it corresponds to and return
 161             // the relevant type.
 162             let Some((arg_index, segment)) = path.segments.iter().find_map(|seg| {
 163                 let args = seg.args?;
 164                 args.args
 165                 .iter()
 166                 .filter(|arg| arg.is_ty_or_const())
 167                 .position(|arg| arg.hir_id() == hir_id)
 168                 .map(|index| (index, seg)).or_else(|| args.bindings
 169                     .iter()
 170                     .filter_map(TypeBinding::opt_const)
 171                     .position(|ct| ct.hir_id == hir_id)
 172                     .map(|idx| (idx, seg)))
 173             }) else {
 174                 tcx.sess.delay_span_bug(
 175                     tcx.def_span(def_id),
 176                     "no arg matching AnonConst in path",
 177                 );
 178                 return None;
 179             };
 180
 181             let generics = match tcx.res_generics_def_id(segment.res) {
 182                 Some(def_id) => tcx.generics_of(def_id),
 183                 None => {
 184                     tcx.sess.delay_span_bug(
 185                         tcx.def_span(def_id),
 186                         &format!("unexpected anon const res {:?} in path: {:?}", segment.res, path),
 187                     );
 188                     return None;
 189                 }
 190             };
 191
 192             (generics, arg_index)
 193         }
 194         _ => return None,
 195     };
 196
 197     debug!(?parent_node);
 198     debug!(?generics, ?arg_idx);
 199     generics
 200         .params
 201         .iter()
 202         .filter(|param| param.kind.is_ty_or_const())
 203         .nth(match generics.has_self && generics.parent.is_none() {
 204             true => arg_idx + 1,
 205             false => arg_idx,
 206         })
 207         .and_then(|param| match param.kind {
 208             ty::GenericParamDefKind::Const { .. } => {
 209                 debug!(?param);
 210                 Some(param.def_id)
 211             }
 212             _ => None,
 213         })
 214 }
 215
 216 fn get_path_containing_arg_in_pat<'hir>(
 217     pat: &'hir hir::Pat<'hir>,
 218     arg_id: HirId,
 219 ) -> Option<&'hir hir::Path<'hir>> {
 220     use hir::*;
 221
 222     let is_arg_in_path = |p: &hir::Path<'_>| {
 223         p.segments
 224             .iter()
 225             .filter_map(|seg| seg.args)
 226             .flat_map(|args| args.args)
 227             .any(|arg| arg.hir_id() == arg_id)
 228     };
 229     let mut arg_path = None;
 230     pat.walk(|pat| match pat.kind {
 231         PatKind::Struct(QPath::Resolved(_, path), _, _)
 232         | PatKind::TupleStruct(QPath::Resolved(_, path), _, _)
 233         | PatKind::Path(QPath::Resolved(_, path))
 234             if is_arg_in_path(path) =>
 235         {
 236             arg_path = Some(path);
 237             false
 238         }
 239         _ => true,
 240     });
 241     arg_path
 242 }
 243
 244 pub(super) fn type_of(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
 245     let def_id = def_id.expect_local();
 246     use rustc_hir::*;
 247
 248     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
 249
 250     let icx = ItemCtxt::new(tcx, def_id.to_def_id());
 251
 252     match tcx.hir().get(hir_id) {
 253         Node::TraitItem(item) => match item.kind {
 254             TraitItemKind::Fn(..) => {
 255                 let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 256                 tcx.mk_fn_def(def_id.to_def_id(), substs)
 257             }
 258             TraitItemKind::Const(ty, body_id) => body_id
 259                 .and_then(|body_id| {
 260                     if is_suggestable_infer_ty(ty) {
 261                         Some(infer_placeholder_type(
 262                             tcx, def_id, body_id, ty.span, item.ident, "constant",
 263                         ))
 264                     } else {
 265                         None
 266                     }
 267                 })
 268                 .unwrap_or_else(|| icx.to_ty(ty)),
 269             TraitItemKind::Type(_, Some(ty)) => icx.to_ty(ty),
 270             TraitItemKind::Type(_, None) => {
 271                 span_bug!(item.span, "associated type missing default");
 272             }
 273         },
 274
 275         Node::ImplItem(item) => match item.kind {
 276             ImplItemKind::Fn(..) => {
 277                 let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 278                 tcx.mk_fn_def(def_id.to_def_id(), substs)
 279             }
 280             ImplItemKind::Const(ty, body_id) => {
 281                 if is_suggestable_infer_ty(ty) {
 282                     infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident, "constant")
 283                 } else {
 284                     icx.to_ty(ty)
 285                 }
 286             }
 287             ImplItemKind::TyAlias(ty) => {
 288                 if tcx.impl_trait_ref(tcx.hir().get_parent_item(hir_id)).is_none() {
 289                     check_feature_inherent_assoc_ty(tcx, item.span);
 290                 }
 291
 292                 icx.to_ty(ty)
 293             }
 294         },
 295
 296         Node::Item(item) => {
 297             match item.kind {
 298                 ItemKind::Static(ty, .., body_id) => {
 299                     if is_suggestable_infer_ty(ty) {
 300                         infer_placeholder_type(
 301                             tcx,
 302                             def_id,
 303                             body_id,
 304                             ty.span,
 305                             item.ident,
 306                             "static variable",
 307                         )
 308                     } else {
 309                         icx.to_ty(ty)
 310                     }
 311                 }
 312                 ItemKind::Const(ty, body_id) => {
 313                     if is_suggestable_infer_ty(ty) {
 314                         infer_placeholder_type(
 315                             tcx, def_id, body_id, ty.span, item.ident, "constant",
 316                         )
 317                     } else {
 318                         icx.to_ty(ty)
 319                     }
 320                 }
 321                 ItemKind::TyAlias(self_ty, _) => icx.to_ty(self_ty),
 322                 ItemKind::Impl(hir::Impl { self_ty, .. }) => icx.to_ty(*self_ty),
 323                 ItemKind::Fn(..) => {
 324                     let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 325                     tcx.mk_fn_def(def_id.to_def_id(), substs)
 326                 }
 327                 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) => {
 328                     let def = tcx.adt_def(def_id);
 329                     let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 330                     tcx.mk_adt(def, substs)
 331                 }
 332                 ItemKind::OpaqueTy(OpaqueTy { origin: hir::OpaqueTyOrigin::TyAlias, .. }) => {
 333                     find_opaque_ty_constraints_for_tait(tcx, def_id)
 334                 }
 335                 // Opaque types desugared from `impl Trait`.
 336                 ItemKind::OpaqueTy(OpaqueTy { origin: hir::OpaqueTyOrigin::FnReturn(owner) | hir::OpaqueTyOrigin::AsyncFn(owner), .. }) => {
 337                     find_opaque_ty_constraints_for_rpit(tcx, def_id, owner)
 338                 }
 339                 ItemKind::Trait(..)
 340                 | ItemKind::TraitAlias(..)
 341                 | ItemKind::Macro(..)
 342                 | ItemKind::Mod(..)
 343                 | ItemKind::ForeignMod { .. }
 344                 | ItemKind::GlobalAsm(..)
 345                 | ItemKind::ExternCrate(..)
 346                 | ItemKind::Use(..) => {
 347                     span_bug!(
 348                         item.span,
 349                         "compute_type_of_item: unexpected item type: {:?}",
 350                         item.kind
 351                     );
 352                 }
 353             }
 354         }
 355
 356         Node::ForeignItem(foreign_item) => match foreign_item.kind {
 357             ForeignItemKind::Fn(..) => {
 358                 let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 359                 tcx.mk_fn_def(def_id.to_def_id(), substs)
 360             }
 361             ForeignItemKind::Static(t, _) => icx.to_ty(t),
 362             ForeignItemKind::Type => tcx.mk_foreign(def_id.to_def_id()),
 363         },
 364
 365         Node::Ctor(&ref def) | Node::Variant(Variant { data: ref def, .. }) => match *def {
 366             VariantData::Unit(..) | VariantData::Struct(..) => {
 367                 tcx.type_of(tcx.hir().get_parent_item(hir_id))
 368             }
 369             VariantData::Tuple(..) => {
 370                 let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 371                 tcx.mk_fn_def(def_id.to_def_id(), substs)
 372             }
 373         },
 374
 375         Node::Field(field) => icx.to_ty(field.ty),
 376
 377         Node::Expr(&Expr { kind: ExprKind::Closure{..}, .. }) => tcx.typeck(def_id).node_type(hir_id),
 378
 379         Node::AnonConst(_) if let Some(param) = tcx.opt_const_param_of(def_id) => {
 380             // We defer to `type_of` of the corresponding parameter
 381             // for generic arguments.
 382             tcx.type_of(param)
 383         }
 384
 385         Node::AnonConst(_) => {
 386             let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
 387             match parent_node {
 388                 Node::Ty(&Ty { kind: TyKind::Array(_, ref constant), .. })
 389                 | Node::Expr(&Expr { kind: ExprKind::Repeat(_, ref constant), .. })
 390                     if constant.hir_id() == hir_id =>
 391                 {
 392                     tcx.types.usize
 393                 }
 394                 Node::Ty(&Ty { kind: TyKind::Typeof(ref e), .. }) if e.hir_id == hir_id => {
 395                     tcx.typeck(def_id).node_type(e.hir_id)
 396                 }
 397
 398                 Node::Expr(&Expr { kind: ExprKind::ConstBlock(ref anon_const), .. })
 399                     if anon_const.hir_id == hir_id =>
 400                 {
 401                     let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
 402                     substs.as_inline_const().ty()
 403                 }
 404
 405                 Node::Expr(&Expr { kind: ExprKind::InlineAsm(asm), .. })
 406                 | Node::Item(&Item { kind: ItemKind::GlobalAsm(asm), .. })
 407                     if asm.operands.iter().any(|(op, _op_sp)| match op {
 408                         hir::InlineAsmOperand::Const { anon_const }
 409                         | hir::InlineAsmOperand::SymFn { anon_const } => anon_const.hir_id == hir_id,
 410                         _ => false,
 411                     }) =>
 412                 {
 413                     tcx.typeck(def_id).node_type(hir_id)
 414                 }
 415
 416                 Node::Variant(Variant { disr_expr: Some(ref e), .. }) if e.hir_id == hir_id => tcx
 417                     .adt_def(tcx.hir().get_parent_item(hir_id))
 418                     .repr()
 419                     .discr_type()
 420                     .to_ty(tcx),
 421
 422                 Node::TypeBinding(binding @ &TypeBinding { hir_id: binding_id, ..  })
 423                     if let Node::TraitRef(trait_ref) = tcx.hir().get(
 424                         tcx.hir().get_parent_node(binding_id)
 425                     ) =>
 426                 {
 427                   let Some(trait_def_id) = trait_ref.trait_def_id() else {
 428                     return tcx.ty_error_with_message(DUMMY_SP, "Could not find trait");
 429                   };
 430                   let assoc_items = tcx.associated_items(trait_def_id);
 431                   let assoc_item = assoc_items.find_by_name_and_kind(
 432                     tcx, binding.ident, ty::AssocKind::Const, def_id.to_def_id(),
 433                   );
 434                   if let Some(assoc_item) = assoc_item {
 435                     tcx.type_of(assoc_item.def_id)
 436                   } else {
 437                       // FIXME(associated_const_equality): add a useful error message here.
 438                       tcx.ty_error_with_message(
 439                         DUMMY_SP,
 440                         "Could not find associated const on trait",
 441                     )
 442                   }
 443                 }
 444
 445                 Node::GenericParam(&GenericParam {
 446                     hir_id: param_hir_id,
 447                     kind: GenericParamKind::Const { default: Some(ct), .. },
 448                     ..
 449                 }) if ct.hir_id == hir_id => tcx.type_of(tcx.hir().local_def_id(param_hir_id)),
 450
 451                 x =>
 452                   tcx.ty_error_with_message(
 453                     DUMMY_SP,
 454                     &format!("unexpected const parent in type_of(): {x:?}"),
 455                 ),
 456             }
 457         }
 458
 459         Node::GenericParam(param) => match &param.kind {
 460             GenericParamKind::Type { default: Some(ty), .. }
 461             | GenericParamKind::Const { ty, .. } => icx.to_ty(ty),
 462             x => bug!("unexpected non-type Node::GenericParam: {:?}", x),
 463         },
 464
 465         x => {
 466             bug!("unexpected sort of node in type_of(): {:?}", x);
 467         }
 468     }
 469 }
 470
 471 #[instrument(skip(tcx), level = "debug")]
 472 /// Checks "defining uses" of opaque `impl Trait` types to ensure that they meet the restrictions
 473 /// laid for "higher-order pattern unification".
 474 /// This ensures that inference is tractable.
 475 /// In particular, definitions of opaque types can only use other generics as arguments,
 476 /// and they cannot repeat an argument. Example:
 477 ///
 478 /// ```ignore (illustrative)
 479 /// type Foo<A, B> = impl Bar<A, B>;
 480 ///
 481 /// // Okay -- `Foo` is applied to two distinct, generic types.
 482 /// fn a<T, U>() -> Foo<T, U> { .. }
 483 ///
 484 /// // Not okay -- `Foo` is applied to `T` twice.
 485 /// fn b<T>() -> Foo<T, T> { .. }
 486 ///
 487 /// // Not okay -- `Foo` is applied to a non-generic type.
 488 /// fn b<T>() -> Foo<T, u32> { .. }
 489 /// ```
 490 ///
 491 fn find_opaque_ty_constraints_for_tait(tcx: TyCtxt<'_>, def_id: LocalDefId) -> Ty<'_> {
 492     use rustc_hir::{Expr, ImplItem, Item, TraitItem};
 493
 494     struct ConstraintLocator<'tcx> {
 495         tcx: TyCtxt<'tcx>,
 496
 497         /// def_id of the opaque type whose defining uses are being checked
 498         def_id: LocalDefId,
 499
 500         /// as we walk the defining uses, we are checking that all of them
 501         /// define the same hidden type. This variable is set to `Some`
 502         /// with the first type that we find, and then later types are
 503         /// checked against it (we also carry the span of that first
 504         /// type).
 505         found: Option<ty::OpaqueHiddenType<'tcx>>,
 506     }
 507
 508     impl ConstraintLocator<'_> {
 509         #[instrument(skip(self), level = "debug")]
 510         fn check(&mut self, item_def_id: LocalDefId) {
 511             // Don't try to check items that cannot possibly constrain the type.
 512             if !self.tcx.has_typeck_results(item_def_id) {
 513                 debug!("no constraint: no typeck results");
 514                 return;
 515             }
 516             // Calling `mir_borrowck` can lead to cycle errors through
 517             // const-checking, avoid calling it if we don't have to.
 518             // ```rust
 519             // type Foo = impl Fn() -> usize; // when computing type for this
 520             // const fn bar() -> Foo {
 521             //     || 0usize
 522             // }
 523             // const BAZR: Foo = bar(); // we would mir-borrowck this, causing cycles
 524             // // because we again need to reveal `Foo` so we can check whether the
 525             // // constant does not contain interior mutability.
 526             // ```
 527             let tables = self.tcx.typeck(item_def_id);
 528             if let Some(_) = tables.tainted_by_errors {
 529                 self.found = Some(ty::OpaqueHiddenType { span: DUMMY_SP, ty: self.tcx.ty_error() });
 530                 return;
 531             }
 532             if !tables.concrete_opaque_types.contains_key(&self.def_id) {
 533                 debug!("no constraints in typeck results");
 534                 return;
 535             }
 536             // Use borrowck to get the type with unerased regions.
 537             let concrete_opaque_types = &self.tcx.mir_borrowck(item_def_id).concrete_opaque_types;
 538             debug!(?concrete_opaque_types);
 539             if let Some(&concrete_type) = concrete_opaque_types.get(&self.def_id) {
 540                 debug!(?concrete_type, "found constraint");
 541                 if let Some(prev) = self.found {
 542                     if concrete_type.ty != prev.ty && !(concrete_type, prev).references_error() {
 543                         prev.report_mismatch(&concrete_type, self.tcx);
 544                     }
 545                 } else {
 546                     self.found = Some(concrete_type);
 547                 }
 548             }
 549         }
 550     }
 551
 552     impl<'tcx> intravisit::Visitor<'tcx> for ConstraintLocator<'tcx> {
 553         type NestedFilter = nested_filter::All;
 554
 555         fn nested_visit_map(&mut self) -> Self::Map {
 556             self.tcx.hir()
 557         }
 558         fn visit_expr(&mut self, ex: &'tcx Expr<'tcx>) {
 559             if let hir::ExprKind::Closure { .. } = ex.kind {
 560                 let def_id = self.tcx.hir().local_def_id(ex.hir_id);
 561                 self.check(def_id);
 562             }
 563             intravisit::walk_expr(self, ex);
 564         }
 565         fn visit_item(&mut self, it: &'tcx Item<'tcx>) {
 566             trace!(?it.def_id);
 567             // The opaque type itself or its children are not within its reveal scope.
 568             if it.def_id != self.def_id {
 569                 self.check(it.def_id);
 570                 intravisit::walk_item(self, it);
 571             }
 572         }
 573         fn visit_impl_item(&mut self, it: &'tcx ImplItem<'tcx>) {
 574             trace!(?it.def_id);
 575             // The opaque type itself or its children are not within its reveal scope.
 576             if it.def_id != self.def_id {
 577                 self.check(it.def_id);
 578                 intravisit::walk_impl_item(self, it);
 579             }
 580         }
 581         fn visit_trait_item(&mut self, it: &'tcx TraitItem<'tcx>) {
 582             trace!(?it.def_id);
 583             self.check(it.def_id);
 584             intravisit::walk_trait_item(self, it);
 585         }
 586     }
 587
 588     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
 589     let scope = tcx.hir().get_defining_scope(hir_id);
 590     let mut locator = ConstraintLocator { def_id: def_id, tcx, found: None };
 591
 592     debug!(?scope);
 593
 594     if scope == hir::CRATE_HIR_ID {
 595         tcx.hir().walk_toplevel_module(&mut locator);
 596     } else {
 597         trace!("scope={:#?}", tcx.hir().get(scope));
 598         match tcx.hir().get(scope) {
 599             // We explicitly call `visit_*` methods, instead of using `intravisit::walk_*` methods
 600             // This allows our visitor to process the defining item itself, causing
 601             // it to pick up any 'sibling' defining uses.
 602             //
 603             // For example, this code:
 604             // ```
 605             // fn foo() {
 606             //     type Blah = impl Debug;
 607             //     let my_closure = || -> Blah { true };
 608             // }
 609             // ```
 610             //
 611             // requires us to explicitly process `foo()` in order
 612             // to notice the defining usage of `Blah`.
 613             Node::Item(it) => locator.visit_item(it),
 614             Node::ImplItem(it) => locator.visit_impl_item(it),
 615             Node::TraitItem(it) => locator.visit_trait_item(it),
 616             other => bug!("{:?} is not a valid scope for an opaque type item", other),
 617         }
 618     }
 619
 620     match locator.found {
 621         Some(hidden) => hidden.ty,
 622         None => {
 623             tcx.sess.emit_err(UnconstrainedOpaqueType {
 624                 span: tcx.def_span(def_id),
 625                 name: tcx.item_name(tcx.local_parent(def_id).to_def_id()),
 626             });
 627             tcx.ty_error()
 628         }
 629     }
 630 }
 631
 632 fn find_opaque_ty_constraints_for_rpit(
 633     tcx: TyCtxt<'_>,
 634     def_id: LocalDefId,
 635     owner_def_id: LocalDefId,
 636 ) -> Ty<'_> {
 637     use rustc_hir::{Expr, ImplItem, Item, TraitItem};
 638
 639     struct ConstraintChecker<'tcx> {
 640         tcx: TyCtxt<'tcx>,
 641
 642         /// def_id of the opaque type whose defining uses are being checked
 643         def_id: LocalDefId,
 644
 645         found: ty::OpaqueHiddenType<'tcx>,
 646     }
 647
 648     impl ConstraintChecker<'_> {
 649         #[instrument(skip(self), level = "debug")]
 650         fn check(&self, def_id: LocalDefId) {
 651             // Use borrowck to get the type with unerased regions.
 652             let concrete_opaque_types = &self.tcx.mir_borrowck(def_id).concrete_opaque_types;
 653             debug!(?concrete_opaque_types);
 654             for &(def_id, concrete_type) in concrete_opaque_types {
 655                 if def_id != self.def_id {
 656                     // Ignore constraints for other opaque types.
 657                     continue;
 658                 }
 659
 660                 debug!(?concrete_type, "found constraint");
 661
 662                 if concrete_type.ty != self.found.ty
 663                     && !(concrete_type, self.found).references_error()
 664                 {
 665                     self.found.report_mismatch(&concrete_type, self.tcx);
 666                 }
 667             }
 668         }
 669     }
 670
 671     impl<'tcx> intravisit::Visitor<'tcx> for ConstraintChecker<'tcx> {
 672         type NestedFilter = nested_filter::OnlyBodies;
 673
 674         fn nested_visit_map(&mut self) -> Self::Map {
 675             self.tcx.hir()
 676         }
 677         fn visit_expr(&mut self, ex: &'tcx Expr<'tcx>) {
 678             if let hir::ExprKind::Closure { .. } = ex.kind {
 679                 let def_id = self.tcx.hir().local_def_id(ex.hir_id);
 680                 self.check(def_id);
 681             }
 682             intravisit::walk_expr(self, ex);
 683         }
 684         fn visit_item(&mut self, it: &'tcx Item<'tcx>) {
 685             trace!(?it.def_id);
 686             // The opaque type itself or its children are not within its reveal scope.
 687             if it.def_id != self.def_id {
 688                 self.check(it.def_id);
 689                 intravisit::walk_item(self, it);
 690             }
 691         }
 692         fn visit_impl_item(&mut self, it: &'tcx ImplItem<'tcx>) {
 693             trace!(?it.def_id);
 694             // The opaque type itself or its children are not within its reveal scope.
 695             if it.def_id != self.def_id {
 696                 self.check(it.def_id);
 697                 intravisit::walk_impl_item(self, it);
 698             }
 699         }
 700         fn visit_trait_item(&mut self, it: &'tcx TraitItem<'tcx>) {
 701             trace!(?it.def_id);
 702             self.check(it.def_id);
 703             intravisit::walk_trait_item(self, it);
 704         }
 705     }
 706
 707     let concrete = tcx.mir_borrowck(owner_def_id).concrete_opaque_types.get(&def_id).copied();
 708
 709     if let Some(concrete) = concrete {
 710         let scope = tcx.hir().local_def_id_to_hir_id(owner_def_id);
 711         debug!(?scope);
 712         let mut locator = ConstraintChecker { def_id: def_id, tcx, found: concrete };
 713
 714         match tcx.hir().get(scope) {
 715             Node::Item(it) => intravisit::walk_item(&mut locator, it),
 716             Node::ImplItem(it) => intravisit::walk_impl_item(&mut locator, it),
 717             Node::TraitItem(it) => intravisit::walk_trait_item(&mut locator, it),
 718             other => bug!("{:?} is not a valid scope for an opaque type item", other),
 719         }
 720     }
 721
 722     concrete.map(|concrete| concrete.ty).unwrap_or_else(|| {
 723         let table = tcx.typeck(owner_def_id);
 724         if let Some(_) = table.tainted_by_errors {
 725             // Some error in the
 726             // owner fn prevented us from populating
 727             // the `concrete_opaque_types` table.
 728             tcx.ty_error()
 729         } else {
 730             table
 731                 .concrete_opaque_types
 732                 .get(&def_id)
 733                 .copied()
 734                 .unwrap_or_else(|| {
 735                     // We failed to resolve the opaque type or it
 736                     // resolves to itself. We interpret this as the
 737                     // no values of the hidden type ever being constructed,
 738                     // so we can just make the hidden type be `!`.
 739                     // For backwards compatibility reasons, we fall back to
 740                     // `()` until we the diverging default is changed.
 741                     Some(tcx.mk_diverging_default())
 742                 })
 743                 .expect("RPIT always have a hidden type from typeck")
 744         }
 745     })
 746 }
 747
 748 fn infer_placeholder_type<'a>(
 749     tcx: TyCtxt<'a>,
 750     def_id: LocalDefId,
 751     body_id: hir::BodyId,
 752     span: Span,
 753     item_ident: Ident,
 754     kind: &'static str,
 755 ) -> Ty<'a> {
 756     // Attempts to make the type nameable by turning FnDefs into FnPtrs.
 757     struct MakeNameable<'tcx> {
 758         success: bool,
 759         tcx: TyCtxt<'tcx>,
 760     }
 761
 762     impl<'tcx> MakeNameable<'tcx> {
 763         fn new(tcx: TyCtxt<'tcx>) -> Self {
 764             MakeNameable { success: true, tcx }
 765         }
 766     }
 767
 768     impl<'tcx> TypeFolder<'tcx> for MakeNameable<'tcx> {
 769         fn tcx(&self) -> TyCtxt<'tcx> {
 770             self.tcx
 771         }
 772
 773         fn fold_ty(&mut self, ty: Ty<'tcx>) -> Ty<'tcx> {
 774             if !self.success {
 775                 return ty;
 776             }
 777
 778             match ty.kind() {
 779                 ty::FnDef(def_id, _) => self.tcx.mk_fn_ptr(self.tcx.fn_sig(*def_id)),
 780                 // FIXME: non-capturing closures should also suggest a function pointer
 781                 ty::Closure(..) | ty::Generator(..) => {
 782                     self.success = false;
 783                     ty
 784                 }
 785                 _ => ty.super_fold_with(self),
 786             }
 787         }
 788     }
 789
 790     let ty = tcx.diagnostic_only_typeck(def_id).node_type(body_id.hir_id);
 791
 792     // If this came from a free `const` or `static mut?` item,
 793     // then the user may have written e.g. `const A = 42;`.
 794     // In this case, the parser has stashed a diagnostic for
 795     // us to improve in typeck so we do that now.
 796     match tcx.sess.diagnostic().steal_diagnostic(span, StashKey::ItemNoType) {
 797         Some(mut err) => {
 798             if !ty.references_error() {
 799                 // Only suggest adding `:` if it was missing (and suggested by parsing diagnostic)
 800                 let colon = if span == item_ident.span.shrink_to_hi() { ":" } else { "" };
 801
 802                 // The parser provided a sub-optimal `HasPlaceholders` suggestion for the type.
 803                 // We are typeck and have the real type, so remove that and suggest the actual type.
 804                 // FIXME(eddyb) this looks like it should be functionality on `Diagnostic`.
 805                 if let Ok(suggestions) = &mut err.suggestions {
 806                     suggestions.clear();
 807                 }
 808
 809                 // Suggesting unnameable types won't help.
 810                 let mut mk_nameable = MakeNameable::new(tcx);
 811                 let ty = mk_nameable.fold_ty(ty);
 812                 let sugg_ty = if mk_nameable.success { Some(ty) } else { None };
 813                 if let Some(sugg_ty) = sugg_ty {
 814                     err.span_suggestion(
 815                         span,
 816                         &format!("provide a type for the {item}", item = kind),
 817                         format!("{colon} {sugg_ty}"),
 818                         Applicability::MachineApplicable,
 819                     );
 820                 } else {
 821                     err.span_note(
 822                         tcx.hir().body(body_id).value.span,
 823                         &format!("however, the inferred type `{}` cannot be named", ty),
 824                     );
 825                 }
 826             }
 827
 828             err.emit();
 829         }
 830         None => {
 831             let mut diag = bad_placeholder(tcx, vec![span], kind);
 832
 833             if !ty.references_error() {
 834                 let mut mk_nameable = MakeNameable::new(tcx);
 835                 let ty = mk_nameable.fold_ty(ty);
 836                 let sugg_ty = if mk_nameable.success { Some(ty) } else { None };
 837                 if let Some(sugg_ty) = sugg_ty {
 838                     diag.span_suggestion(
 839                         span,
 840                         "replace with the correct type",
 841                         sugg_ty,
 842                         Applicability::MaybeIncorrect,
 843                     );
 844                 } else {
 845                     diag.span_note(
 846                         tcx.hir().body(body_id).value.span,
 847                         &format!("however, the inferred type `{}` cannot be named", ty),
 848                     );
 849                 }
 850             }
 851
 852             diag.emit();
 853         }
 854     }
 855
 856     // Typeck doesn't expect erased regions to be returned from `type_of`.
 857     tcx.fold_regions(ty, |r, _| match *r {
 858         ty::ReErased => tcx.lifetimes.re_static,
 859         _ => r,
 860     })
 861 }
 862
 863 fn check_feature_inherent_assoc_ty(tcx: TyCtxt<'_>, span: Span) {
 864     if !tcx.features().inherent_associated_types {
 865         use rustc_session::parse::feature_err;
 866         use rustc_span::symbol::sym;
 867         feature_err(
 868             &tcx.sess.parse_sess,
 869             sym::inherent_associated_types,
 870             span,
 871             "inherent associated types are unstable",
 872         )
 873         .emit();
 874     }
 875 }