compiler/rustc_typeck/src/mem_categorization.rs

   1 //! # Categorization
   2 //!
   3 //! The job of the categorization module is to analyze an expression to
   4 //! determine what kind of memory is used in evaluating it (for example,
   5 //! where dereferences occur and what kind of pointer is dereferenced;
   6 //! whether the memory is mutable, etc.).
   7 //!
   8 //! Categorization effectively transforms all of our expressions into
   9 //! expressions of the following forms (the actual enum has many more
  10 //! possibilities, naturally, but they are all variants of these base
  11 //! forms):
  12 //! ```ignore (not-rust)
  13 //! E = rvalue    // some computed rvalue
  14 //!   | x         // address of a local variable or argument
  15 //!   | *E        // deref of a ptr
  16 //!   | E.comp    // access to an interior component
  17 //! ```
  18 //! Imagine a routine ToAddr(Expr) that evaluates an expression and returns an
  19 //! address where the result is to be found. If Expr is a place, then this
  20 //! is the address of the place. If `Expr` is an rvalue, this is the address of
  21 //! some temporary spot in memory where the result is stored.
  22 //!
  23 //! Now, `cat_expr()` classifies the expression `Expr` and the address `A = ToAddr(Expr)`
  24 //! as follows:
  25 //!
  26 //! - `cat`: what kind of expression was this? This is a subset of the
  27 //!   full expression forms which only includes those that we care about
  28 //!   for the purpose of the analysis.
  29 //! - `mutbl`: mutability of the address `A`.
  30 //! - `ty`: the type of data found at the address `A`.
  31 //!
  32 //! The resulting categorization tree differs somewhat from the expressions
  33 //! themselves. For example, auto-derefs are explicit. Also, an index `a[b]` is
  34 //! decomposed into two operations: a dereference to reach the array data and
  35 //! then an index to jump forward to the relevant item.
  36 //!
  37 //! ## By-reference upvars
  38 //!
  39 //! One part of the codegen which may be non-obvious is that we translate
  40 //! closure upvars into the dereference of a borrowed pointer; this more closely
  41 //! resembles the runtime codegen. So, for example, if we had:
  42 //!
  43 //!     let mut x = 3;
  44 //!     let y = 5;
  45 //!     let inc = || x += y;
  46 //!
  47 //! Then when we categorize `x` (*within* the closure) we would yield a
  48 //! result of `*x'`, effectively, where `x'` is a `Categorization::Upvar` reference
  49 //! tied to `x`. The type of `x'` will be a borrowed pointer.
  50
  51 use rustc_middle::hir::place::*;
  52 use rustc_middle::ty::adjustment;
  53 use rustc_middle::ty::fold::TypeFoldable;
  54 use rustc_middle::ty::visit::TypeVisitable;
  55 use rustc_middle::ty::{self, Ty, TyCtxt};
  56
  57 use rustc_data_structures::fx::FxIndexMap;
  58 use rustc_hir as hir;
  59 use rustc_hir::def::{CtorOf, DefKind, Res};
  60 use rustc_hir::def_id::LocalDefId;
  61 use rustc_hir::pat_util::EnumerateAndAdjustIterator;
  62 use rustc_hir::PatKind;
  63 use rustc_index::vec::Idx;
  64 use rustc_infer::infer::InferCtxt;
  65 use rustc_span::Span;
  66 use rustc_target::abi::VariantIdx;
  67 use rustc_trait_selection::infer::InferCtxtExt;
  68
  69 pub(crate) trait HirNode {
  70     fn hir_id(&self) -> hir::HirId;
  71     fn span(&self) -> Span;
  72 }
  73
  74 impl HirNode for hir::Expr<'_> {
  75     fn hir_id(&self) -> hir::HirId {
  76         self.hir_id
  77     }
  78     fn span(&self) -> Span {
  79         self.span
  80     }
  81 }
  82
  83 impl HirNode for hir::Pat<'_> {
  84     fn hir_id(&self) -> hir::HirId {
  85         self.hir_id
  86     }
  87     fn span(&self) -> Span {
  88         self.span
  89     }
  90 }
  91
  92 #[derive(Clone)]
  93 pub(crate) struct MemCategorizationContext<'a, 'tcx> {
  94     pub(crate) typeck_results: &'a ty::TypeckResults<'tcx>,
  95     infcx: &'a InferCtxt<'a, 'tcx>,
  96     param_env: ty::ParamEnv<'tcx>,
  97     body_owner: LocalDefId,
  98     upvars: Option<&'tcx FxIndexMap<hir::HirId, hir::Upvar>>,
  99 }
 100
 101 pub(crate) type McResult<T> = Result<T, ()>;
 102
 103 impl<'a, 'tcx> MemCategorizationContext<'a, 'tcx> {
 104     /// Creates a `MemCategorizationContext`.
 105     pub(crate) fn new(
 106         infcx: &'a InferCtxt<'a, 'tcx>,
 107         param_env: ty::ParamEnv<'tcx>,
 108         body_owner: LocalDefId,
 109         typeck_results: &'a ty::TypeckResults<'tcx>,
 110     ) -> MemCategorizationContext<'a, 'tcx> {
 111         MemCategorizationContext {
 112             typeck_results,
 113             infcx,
 114             param_env,
 115             body_owner,
 116             upvars: infcx.tcx.upvars_mentioned(body_owner),
 117         }
 118     }
 119
 120     pub(crate) fn tcx(&self) -> TyCtxt<'tcx> {
 121         self.infcx.tcx
 122     }
 123
 124     pub(crate) fn type_is_copy_modulo_regions(&self, ty: Ty<'tcx>, span: Span) -> bool {
 125         self.infcx.type_is_copy_modulo_regions(self.param_env, ty, span)
 126     }
 127
 128     fn resolve_vars_if_possible<T>(&self, value: T) -> T
 129     where
 130         T: TypeFoldable<'tcx>,
 131     {
 132         self.infcx.resolve_vars_if_possible(value)
 133     }
 134
 135     fn is_tainted_by_errors(&self) -> bool {
 136         self.infcx.is_tainted_by_errors()
 137     }
 138
 139     fn resolve_type_vars_or_error(
 140         &self,
 141         id: hir::HirId,
 142         ty: Option<Ty<'tcx>>,
 143     ) -> McResult<Ty<'tcx>> {
 144         match ty {
 145             Some(ty) => {
 146                 let ty = self.resolve_vars_if_possible(ty);
 147                 if ty.references_error() || ty.is_ty_var() {
 148                     debug!("resolve_type_vars_or_error: error from {:?}", ty);
 149                     Err(())
 150                 } else {
 151                     Ok(ty)
 152                 }
 153             }
 154             // FIXME
 155             None if self.is_tainted_by_errors() => Err(()),
 156             None => {
 157                 bug!(
 158                     "no type for node {}: {} in mem_categorization",
 159                     id,
 160                     self.tcx().hir().node_to_string(id)
 161                 );
 162             }
 163         }
 164     }
 165
 166     pub(crate) fn node_ty(&self, hir_id: hir::HirId) -> McResult<Ty<'tcx>> {
 167         self.resolve_type_vars_or_error(hir_id, self.typeck_results.node_type_opt(hir_id))
 168     }
 169
 170     fn expr_ty(&self, expr: &hir::Expr<'_>) -> McResult<Ty<'tcx>> {
 171         self.resolve_type_vars_or_error(expr.hir_id, self.typeck_results.expr_ty_opt(expr))
 172     }
 173
 174     pub(crate) fn expr_ty_adjusted(&self, expr: &hir::Expr<'_>) -> McResult<Ty<'tcx>> {
 175         self.resolve_type_vars_or_error(expr.hir_id, self.typeck_results.expr_ty_adjusted_opt(expr))
 176     }
 177
 178     /// Returns the type of value that this pattern matches against.
 179     /// Some non-obvious cases:
 180     ///
 181     /// - a `ref x` binding matches against a value of type `T` and gives
 182     ///   `x` the type `&T`; we return `T`.
 183     /// - a pattern with implicit derefs (thanks to default binding
 184     ///   modes #42640) may look like `Some(x)` but in fact have
 185     ///   implicit deref patterns attached (e.g., it is really
 186     ///   `&Some(x)`). In that case, we return the "outermost" type
 187     ///   (e.g., `&Option<T>).
 188     pub(crate) fn pat_ty_adjusted(&self, pat: &hir::Pat<'_>) -> McResult<Ty<'tcx>> {
 189         // Check for implicit `&` types wrapping the pattern; note
 190         // that these are never attached to binding patterns, so
 191         // actually this is somewhat "disjoint" from the code below
 192         // that aims to account for `ref x`.
 193         if let Some(vec) = self.typeck_results.pat_adjustments().get(pat.hir_id) {
 194             if let Some(first_ty) = vec.first() {
 195                 debug!("pat_ty(pat={:?}) found adjusted ty `{:?}`", pat, first_ty);
 196                 return Ok(*first_ty);
 197             }
 198         }
 199
 200         self.pat_ty_unadjusted(pat)
 201     }
 202
 203     /// Like `pat_ty`, but ignores implicit `&` patterns.
 204     fn pat_ty_unadjusted(&self, pat: &hir::Pat<'_>) -> McResult<Ty<'tcx>> {
 205         let base_ty = self.node_ty(pat.hir_id)?;
 206         debug!("pat_ty(pat={:?}) base_ty={:?}", pat, base_ty);
 207
 208         // This code detects whether we are looking at a `ref x`,
 209         // and if so, figures out what the type *being borrowed* is.
 210         let ret_ty = match pat.kind {
 211             PatKind::Binding(..) => {
 212                 let bm = *self
 213                     .typeck_results
 214                     .pat_binding_modes()
 215                     .get(pat.hir_id)
 216                     .expect("missing binding mode");
 217
 218                 if let ty::BindByReference(_) = bm {
 219                     // a bind-by-ref means that the base_ty will be the type of the ident itself,
 220                     // but what we want here is the type of the underlying value being borrowed.
 221                     // So peel off one-level, turning the &T into T.
 222                     match base_ty.builtin_deref(false) {
 223                         Some(t) => t.ty,
 224                         None => {
 225                             debug!("By-ref binding of non-derefable type {:?}", base_ty);
 226                             return Err(());
 227                         }
 228                     }
 229                 } else {
 230                     base_ty
 231                 }
 232             }
 233             _ => base_ty,
 234         };
 235         debug!("pat_ty(pat={:?}) ret_ty={:?}", pat, ret_ty);
 236
 237         Ok(ret_ty)
 238     }
 239
 240     pub(crate) fn cat_expr(&self, expr: &hir::Expr<'_>) -> McResult<PlaceWithHirId<'tcx>> {
 241         // This recursion helper avoids going through *too many*
 242         // adjustments, since *only* non-overloaded deref recurses.
 243         fn helper<'a, 'tcx>(
 244             mc: &MemCategorizationContext<'a, 'tcx>,
 245             expr: &hir::Expr<'_>,
 246             adjustments: &[adjustment::Adjustment<'tcx>],
 247         ) -> McResult<PlaceWithHirId<'tcx>> {
 248             match adjustments.split_last() {
 249                 None => mc.cat_expr_unadjusted(expr),
 250                 Some((adjustment, previous)) => {
 251                     mc.cat_expr_adjusted_with(expr, || helper(mc, expr, previous), adjustment)
 252                 }
 253             }
 254         }
 255
 256         helper(self, expr, self.typeck_results.expr_adjustments(expr))
 257     }
 258
 259     pub(crate) fn cat_expr_adjusted(
 260         &self,
 261         expr: &hir::Expr<'_>,
 262         previous: PlaceWithHirId<'tcx>,
 263         adjustment: &adjustment::Adjustment<'tcx>,
 264     ) -> McResult<PlaceWithHirId<'tcx>> {
 265         self.cat_expr_adjusted_with(expr, || Ok(previous), adjustment)
 266     }
 267
 268     fn cat_expr_adjusted_with<F>(
 269         &self,
 270         expr: &hir::Expr<'_>,
 271         previous: F,
 272         adjustment: &adjustment::Adjustment<'tcx>,
 273     ) -> McResult<PlaceWithHirId<'tcx>>
 274     where
 275         F: FnOnce() -> McResult<PlaceWithHirId<'tcx>>,
 276     {
 277         debug!("cat_expr_adjusted_with({:?}): {:?}", adjustment, expr);
 278         let target = self.resolve_vars_if_possible(adjustment.target);
 279         match adjustment.kind {
 280             adjustment::Adjust::Deref(overloaded) => {
 281                 // Equivalent to *expr or something similar.
 282                 let base = if let Some(deref) = overloaded {
 283                     let ref_ty = self
 284                         .tcx()
 285                         .mk_ref(deref.region, ty::TypeAndMut { ty: target, mutbl: deref.mutbl });
 286                     self.cat_rvalue(expr.hir_id, expr.span, ref_ty)
 287                 } else {
 288                     previous()?
 289                 };
 290                 self.cat_deref(expr, base)
 291             }
 292
 293             adjustment::Adjust::NeverToAny
 294             | adjustment::Adjust::Pointer(_)
 295             | adjustment::Adjust::Borrow(_) => {
 296                 // Result is an rvalue.
 297                 Ok(self.cat_rvalue(expr.hir_id, expr.span, target))
 298             }
 299         }
 300     }
 301
 302     pub(crate) fn cat_expr_unadjusted(
 303         &self,
 304         expr: &hir::Expr<'_>,
 305     ) -> McResult<PlaceWithHirId<'tcx>> {
 306         debug!("cat_expr: id={} expr={:?}", expr.hir_id, expr);
 307
 308         let expr_ty = self.expr_ty(expr)?;
 309         match expr.kind {
 310             hir::ExprKind::Unary(hir::UnOp::Deref, ref e_base) => {
 311                 if self.typeck_results.is_method_call(expr) {
 312                     self.cat_overloaded_place(expr, e_base)
 313                 } else {
 314                     let base = self.cat_expr(e_base)?;
 315                     self.cat_deref(expr, base)
 316                 }
 317             }
 318
 319             hir::ExprKind::Field(ref base, _) => {
 320                 let base = self.cat_expr(base)?;
 321                 debug!("cat_expr(cat_field): id={} expr={:?} base={:?}", expr.hir_id, expr, base);
 322
 323                 let field_idx = self
 324                     .typeck_results
 325                     .field_indices()
 326                     .get(expr.hir_id)
 327                     .cloned()
 328                     .expect("Field index not found");
 329
 330                 Ok(self.cat_projection(
 331                     expr,
 332                     base,
 333                     expr_ty,
 334                     ProjectionKind::Field(field_idx as u32, VariantIdx::new(0)),
 335                 ))
 336             }
 337
 338             hir::ExprKind::Index(ref base, _) => {
 339                 if self.typeck_results.is_method_call(expr) {
 340                     // If this is an index implemented by a method call, then it
 341                     // will include an implicit deref of the result.
 342                     // The call to index() returns a `&T` value, which
 343                     // is an rvalue. That is what we will be
 344                     // dereferencing.
 345                     self.cat_overloaded_place(expr, base)
 346                 } else {
 347                     let base = self.cat_expr(base)?;
 348                     Ok(self.cat_projection(expr, base, expr_ty, ProjectionKind::Index))
 349                 }
 350             }
 351
 352             hir::ExprKind::Path(ref qpath) => {
 353                 let res = self.typeck_results.qpath_res(qpath, expr.hir_id);
 354                 self.cat_res(expr.hir_id, expr.span, expr_ty, res)
 355             }
 356
 357             hir::ExprKind::Type(ref e, _) => self.cat_expr(e),
 358
 359             hir::ExprKind::AddrOf(..)
 360             | hir::ExprKind::Call(..)
 361             | hir::ExprKind::Assign(..)
 362             | hir::ExprKind::AssignOp(..)
 363             | hir::ExprKind::Closure { .. }
 364             | hir::ExprKind::Ret(..)
 365             | hir::ExprKind::Unary(..)
 366             | hir::ExprKind::Yield(..)
 367             | hir::ExprKind::MethodCall(..)
 368             | hir::ExprKind::Cast(..)
 369             | hir::ExprKind::DropTemps(..)
 370             | hir::ExprKind::Array(..)
 371             | hir::ExprKind::If(..)
 372             | hir::ExprKind::Tup(..)
 373             | hir::ExprKind::Binary(..)
 374             | hir::ExprKind::Block(..)
 375             | hir::ExprKind::Let(..)
 376             | hir::ExprKind::Loop(..)
 377             | hir::ExprKind::Match(..)
 378             | hir::ExprKind::Lit(..)
 379             | hir::ExprKind::ConstBlock(..)
 380             | hir::ExprKind::Break(..)
 381             | hir::ExprKind::Continue(..)
 382             | hir::ExprKind::Struct(..)
 383             | hir::ExprKind::Repeat(..)
 384             | hir::ExprKind::InlineAsm(..)
 385             | hir::ExprKind::Box(..)
 386             | hir::ExprKind::Err => Ok(self.cat_rvalue(expr.hir_id, expr.span, expr_ty)),
 387         }
 388     }
 389
 390     pub(crate) fn cat_res(
 391         &self,
 392         hir_id: hir::HirId,
 393         span: Span,
 394         expr_ty: Ty<'tcx>,
 395         res: Res,
 396     ) -> McResult<PlaceWithHirId<'tcx>> {
 397         debug!("cat_res: id={:?} expr={:?} def={:?}", hir_id, expr_ty, res);
 398
 399         match res {
 400             Res::Def(
 401                 DefKind::Ctor(..)
 402                 | DefKind::Const
 403                 | DefKind::ConstParam
 404                 | DefKind::AssocConst
 405                 | DefKind::Fn
 406                 | DefKind::AssocFn,
 407                 _,
 408             )
 409             | Res::SelfCtor(..) => Ok(self.cat_rvalue(hir_id, span, expr_ty)),
 410
 411             Res::Def(DefKind::Static(_), _) => {
 412                 Ok(PlaceWithHirId::new(hir_id, expr_ty, PlaceBase::StaticItem, Vec::new()))
 413             }
 414
 415             Res::Local(var_id) => {
 416                 if self.upvars.map_or(false, |upvars| upvars.contains_key(&var_id)) {
 417                     self.cat_upvar(hir_id, var_id)
 418                 } else {
 419                     Ok(PlaceWithHirId::new(hir_id, expr_ty, PlaceBase::Local(var_id), Vec::new()))
 420                 }
 421             }
 422
 423             def => span_bug!(span, "unexpected definition in memory categorization: {:?}", def),
 424         }
 425     }
 426
 427     /// Categorize an upvar.
 428     ///
 429     /// Note: the actual upvar access contains invisible derefs of closure
 430     /// environment and upvar reference as appropriate. Only regionck cares
 431     /// about these dereferences, so we let it compute them as needed.
 432     fn cat_upvar(&self, hir_id: hir::HirId, var_id: hir::HirId) -> McResult<PlaceWithHirId<'tcx>> {
 433         let closure_expr_def_id = self.body_owner;
 434
 435         let upvar_id = ty::UpvarId {
 436             var_path: ty::UpvarPath { hir_id: var_id },
 437             closure_expr_id: closure_expr_def_id,
 438         };
 439         let var_ty = self.node_ty(var_id)?;
 440
 441         let ret = PlaceWithHirId::new(hir_id, var_ty, PlaceBase::Upvar(upvar_id), Vec::new());
 442
 443         debug!("cat_upvar ret={:?}", ret);
 444         Ok(ret)
 445     }
 446
 447     pub(crate) fn cat_rvalue(
 448         &self,
 449         hir_id: hir::HirId,
 450         span: Span,
 451         expr_ty: Ty<'tcx>,
 452     ) -> PlaceWithHirId<'tcx> {
 453         debug!("cat_rvalue hir_id={:?}, expr_ty={:?}, span={:?}", hir_id, expr_ty, span);
 454         let ret = PlaceWithHirId::new(hir_id, expr_ty, PlaceBase::Rvalue, Vec::new());
 455         debug!("cat_rvalue ret={:?}", ret);
 456         ret
 457     }
 458
 459     pub(crate) fn cat_projection<N: HirNode>(
 460         &self,
 461         node: &N,
 462         base_place: PlaceWithHirId<'tcx>,
 463         ty: Ty<'tcx>,
 464         kind: ProjectionKind,
 465     ) -> PlaceWithHirId<'tcx> {
 466         let mut projections = base_place.place.projections;
 467         projections.push(Projection { kind, ty });
 468         let ret = PlaceWithHirId::new(
 469             node.hir_id(),
 470             base_place.place.base_ty,
 471             base_place.place.base,
 472             projections,
 473         );
 474         debug!("cat_field ret {:?}", ret);
 475         ret
 476     }
 477
 478     fn cat_overloaded_place(
 479         &self,
 480         expr: &hir::Expr<'_>,
 481         base: &hir::Expr<'_>,
 482     ) -> McResult<PlaceWithHirId<'tcx>> {
 483         debug!("cat_overloaded_place(expr={:?}, base={:?})", expr, base);
 484
 485         // Reconstruct the output assuming it's a reference with the
 486         // same region and mutability as the receiver. This holds for
 487         // `Deref(Mut)::Deref(_mut)` and `Index(Mut)::index(_mut)`.
 488         let place_ty = self.expr_ty(expr)?;
 489         let base_ty = self.expr_ty_adjusted(base)?;
 490
 491         let ty::Ref(region, _, mutbl) = *base_ty.kind() else {
 492             span_bug!(expr.span, "cat_overloaded_place: base is not a reference");
 493         };
 494         let ref_ty = self.tcx().mk_ref(region, ty::TypeAndMut { ty: place_ty, mutbl });
 495
 496         let base = self.cat_rvalue(expr.hir_id, expr.span, ref_ty);
 497         self.cat_deref(expr, base)
 498     }
 499
 500     fn cat_deref(
 501         &self,
 502         node: &impl HirNode,
 503         base_place: PlaceWithHirId<'tcx>,
 504     ) -> McResult<PlaceWithHirId<'tcx>> {
 505         debug!("cat_deref: base_place={:?}", base_place);
 506
 507         let base_curr_ty = base_place.place.ty();
 508         let deref_ty = match base_curr_ty.builtin_deref(true) {
 509             Some(mt) => mt.ty,
 510             None => {
 511                 debug!("explicit deref of non-derefable type: {:?}", base_curr_ty);
 512                 return Err(());
 513             }
 514         };
 515         let mut projections = base_place.place.projections;
 516         projections.push(Projection { kind: ProjectionKind::Deref, ty: deref_ty });
 517
 518         let ret = PlaceWithHirId::new(
 519             node.hir_id(),
 520             base_place.place.base_ty,
 521             base_place.place.base,
 522             projections,
 523         );
 524         debug!("cat_deref ret {:?}", ret);
 525         Ok(ret)
 526     }
 527
 528     pub(crate) fn cat_pattern<F>(
 529         &self,
 530         place: PlaceWithHirId<'tcx>,
 531         pat: &hir::Pat<'_>,
 532         mut op: F,
 533     ) -> McResult<()>
 534     where
 535         F: FnMut(&PlaceWithHirId<'tcx>, &hir::Pat<'_>),
 536     {
 537         self.cat_pattern_(place, pat, &mut op)
 538     }
 539
 540     /// Returns the variant index for an ADT used within a Struct or TupleStruct pattern
 541     /// Here `pat_hir_id` is the HirId of the pattern itself.
 542     fn variant_index_for_adt(
 543         &self,
 544         qpath: &hir::QPath<'_>,
 545         pat_hir_id: hir::HirId,
 546         span: Span,
 547     ) -> McResult<VariantIdx> {
 548         let res = self.typeck_results.qpath_res(qpath, pat_hir_id);
 549         let ty = self.typeck_results.node_type(pat_hir_id);
 550         let ty::Adt(adt_def, _) = ty.kind() else {
 551             self.tcx()
 552                 .sess
 553                 .delay_span_bug(span, "struct or tuple struct pattern not applied to an ADT");
 554             return Err(());
 555         };
 556
 557         match res {
 558             Res::Def(DefKind::Variant, variant_id) => Ok(adt_def.variant_index_with_id(variant_id)),
 559             Res::Def(DefKind::Ctor(CtorOf::Variant, ..), variant_ctor_id) => {
 560                 Ok(adt_def.variant_index_with_ctor_id(variant_ctor_id))
 561             }
 562             Res::Def(DefKind::Ctor(CtorOf::Struct, ..), _)
 563             | Res::Def(DefKind::Struct | DefKind::Union | DefKind::TyAlias | DefKind::AssocTy, _)
 564             | Res::SelfCtor(..)
 565             | Res::SelfTy { .. } => {
 566                 // Structs and Unions have only have one variant.
 567                 Ok(VariantIdx::new(0))
 568             }
 569             _ => bug!("expected ADT path, found={:?}", res),
 570         }
 571     }
 572
 573     /// Returns the total number of fields in an ADT variant used within a pattern.
 574     /// Here `pat_hir_id` is the HirId of the pattern itself.
 575     fn total_fields_in_adt_variant(
 576         &self,
 577         pat_hir_id: hir::HirId,
 578         variant_index: VariantIdx,
 579         span: Span,
 580     ) -> McResult<usize> {
 581         let ty = self.typeck_results.node_type(pat_hir_id);
 582         match ty.kind() {
 583             ty::Adt(adt_def, _) => Ok(adt_def.variant(variant_index).fields.len()),
 584             _ => {
 585                 self.tcx()
 586                     .sess
 587                     .delay_span_bug(span, "struct or tuple struct pattern not applied to an ADT");
 588                 Err(())
 589             }
 590         }
 591     }
 592
 593     /// Returns the total number of fields in a tuple used within a Tuple pattern.
 594     /// Here `pat_hir_id` is the HirId of the pattern itself.
 595     fn total_fields_in_tuple(&self, pat_hir_id: hir::HirId, span: Span) -> McResult<usize> {
 596         let ty = self.typeck_results.node_type(pat_hir_id);
 597         match ty.kind() {
 598             ty::Tuple(substs) => Ok(substs.len()),
 599             _ => {
 600                 self.tcx().sess.delay_span_bug(span, "tuple pattern not applied to a tuple");
 601                 Err(())
 602             }
 603         }
 604     }
 605
 606     // FIXME(#19596) This is a workaround, but there should be a better way to do this
 607     fn cat_pattern_<F>(
 608         &self,
 609         mut place_with_id: PlaceWithHirId<'tcx>,
 610         pat: &hir::Pat<'_>,
 611         op: &mut F,
 612     ) -> McResult<()>
 613     where
 614         F: FnMut(&PlaceWithHirId<'tcx>, &hir::Pat<'_>),
 615     {
 616         // Here, `place` is the `PlaceWithHirId` being matched and pat is the pattern it
 617         // is being matched against.
 618         //
 619         // In general, the way that this works is that we walk down the pattern,
 620         // constructing a `PlaceWithHirId` that represents the path that will be taken
 621         // to reach the value being matched.
 622
 623         debug!("cat_pattern(pat={:?}, place_with_id={:?})", pat, place_with_id);
 624
 625         // If (pattern) adjustments are active for this pattern, adjust the `PlaceWithHirId` correspondingly.
 626         // `PlaceWithHirId`s are constructed differently from patterns. For example, in
 627         //
 628         // ```
 629         // match foo {
 630         //     &&Some(x, ) => { ... },
 631         //     _ => { ... },
 632         // }
 633         // ```
 634         //
 635         // the pattern `&&Some(x,)` is represented as `Ref { Ref { TupleStruct }}`. To build the
 636         // corresponding `PlaceWithHirId` we start with the `PlaceWithHirId` for `foo`, and then, by traversing the
 637         // pattern, try to answer the question: given the address of `foo`, how is `x` reached?
 638         //
 639         // `&&Some(x,)` `place_foo`
 640         //  `&Some(x,)` `deref { place_foo}`
 641         //   `Some(x,)` `deref { deref { place_foo }}`
 642         //        (x,)` `field0 { deref { deref { place_foo }}}` <- resulting place
 643         //
 644         // The above example has no adjustments. If the code were instead the (after adjustments,
 645         // equivalent) version
 646         //
 647         // ```
 648         // match foo {
 649         //     Some(x, ) => { ... },
 650         //     _ => { ... },
 651         // }
 652         // ```
 653         //
 654         // Then we see that to get the same result, we must start with
 655         // `deref { deref { place_foo }}` instead of `place_foo` since the pattern is now `Some(x,)`
 656         // and not `&&Some(x,)`, even though its assigned type is that of `&&Some(x,)`.
 657         for _ in 0..self.typeck_results.pat_adjustments().get(pat.hir_id).map_or(0, |v| v.len()) {
 658             debug!("cat_pattern: applying adjustment to place_with_id={:?}", place_with_id);
 659             place_with_id = self.cat_deref(pat, place_with_id)?;
 660         }
 661         let place_with_id = place_with_id; // lose mutability
 662         debug!("cat_pattern: applied adjustment derefs to get place_with_id={:?}", place_with_id);
 663
 664         // Invoke the callback, but only now, after the `place_with_id` has adjusted.
 665         //
 666         // To see that this makes sense, consider `match &Some(3) { Some(x) => { ... }}`. In that
 667         // case, the initial `place_with_id` will be that for `&Some(3)` and the pattern is `Some(x)`. We
 668         // don't want to call `op` with these incompatible values. As written, what happens instead
 669         // is that `op` is called with the adjusted place (that for `*&Some(3)`) and the pattern
 670         // `Some(x)` (which matches). Recursing once more, `*&Some(3)` and the pattern `Some(x)`
 671         // result in the place `Downcast<Some>(*&Some(3)).0` associated to `x` and invoke `op` with
 672         // that (where the `ref` on `x` is implied).
 673         op(&place_with_id, pat);
 674
 675         match pat.kind {
 676             PatKind::Tuple(subpats, dots_pos) => {
 677                 // (p1, ..., pN)
 678                 let total_fields = self.total_fields_in_tuple(pat.hir_id, pat.span)?;
 679
 680                 for (i, subpat) in subpats.iter().enumerate_and_adjust(total_fields, dots_pos) {
 681                     let subpat_ty = self.pat_ty_adjusted(subpat)?;
 682                     let projection_kind = ProjectionKind::Field(i as u32, VariantIdx::new(0));
 683                     let sub_place =
 684                         self.cat_projection(pat, place_with_id.clone(), subpat_ty, projection_kind);
 685                     self.cat_pattern_(sub_place, subpat, op)?;
 686                 }
 687             }
 688
 689             PatKind::TupleStruct(ref qpath, subpats, dots_pos) => {
 690                 // S(p1, ..., pN)
 691                 let variant_index = self.variant_index_for_adt(qpath, pat.hir_id, pat.span)?;
 692                 let total_fields =
 693                     self.total_fields_in_adt_variant(pat.hir_id, variant_index, pat.span)?;
 694
 695                 for (i, subpat) in subpats.iter().enumerate_and_adjust(total_fields, dots_pos) {
 696                     let subpat_ty = self.pat_ty_adjusted(subpat)?;
 697                     let projection_kind = ProjectionKind::Field(i as u32, variant_index);
 698                     let sub_place =
 699                         self.cat_projection(pat, place_with_id.clone(), subpat_ty, projection_kind);
 700                     self.cat_pattern_(sub_place, subpat, op)?;
 701                 }
 702             }
 703
 704             PatKind::Struct(ref qpath, field_pats, _) => {
 705                 // S { f1: p1, ..., fN: pN }
 706
 707                 let variant_index = self.variant_index_for_adt(qpath, pat.hir_id, pat.span)?;
 708
 709                 for fp in field_pats {
 710                     let field_ty = self.pat_ty_adjusted(fp.pat)?;
 711                     let field_index = self
 712                         .typeck_results
 713                         .field_indices()
 714                         .get(fp.hir_id)
 715                         .cloned()
 716                         .expect("no index for a field");
 717
 718                     let field_place = self.cat_projection(
 719                         pat,
 720                         place_with_id.clone(),
 721                         field_ty,
 722                         ProjectionKind::Field(field_index as u32, variant_index),
 723                     );
 724                     self.cat_pattern_(field_place, fp.pat, op)?;
 725                 }
 726             }
 727
 728             PatKind::Or(pats) => {
 729                 for pat in pats {
 730                     self.cat_pattern_(place_with_id.clone(), pat, op)?;
 731                 }
 732             }
 733
 734             PatKind::Binding(.., Some(ref subpat)) => {
 735                 self.cat_pattern_(place_with_id, subpat, op)?;
 736             }
 737
 738             PatKind::Box(ref subpat) | PatKind::Ref(ref subpat, _) => {
 739                 // box p1, &p1, &mut p1.  we can ignore the mutability of
 740                 // PatKind::Ref since that information is already contained
 741                 // in the type.
 742                 let subplace = self.cat_deref(pat, place_with_id)?;
 743                 self.cat_pattern_(subplace, subpat, op)?;
 744             }
 745
 746             PatKind::Slice(before, ref slice, after) => {
 747                 let Some(element_ty) = place_with_id.place.ty().builtin_index() else {
 748                     debug!("explicit index of non-indexable type {:?}", place_with_id);
 749                     return Err(());
 750                 };
 751                 let elt_place = self.cat_projection(
 752                     pat,
 753                     place_with_id.clone(),
 754                     element_ty,
 755                     ProjectionKind::Index,
 756                 );
 757                 for before_pat in before {
 758                     self.cat_pattern_(elt_place.clone(), before_pat, op)?;
 759                 }
 760                 if let Some(ref slice_pat) = *slice {
 761                     let slice_pat_ty = self.pat_ty_adjusted(slice_pat)?;
 762                     let slice_place = self.cat_projection(
 763                         pat,
 764                         place_with_id,
 765                         slice_pat_ty,
 766                         ProjectionKind::Subslice,
 767                     );
 768                     self.cat_pattern_(slice_place, slice_pat, op)?;
 769                 }
 770                 for after_pat in after {
 771                     self.cat_pattern_(elt_place.clone(), after_pat, op)?;
 772                 }
 773             }
 774
 775             PatKind::Path(_)
 776             | PatKind::Binding(.., None)
 777             | PatKind::Lit(..)
 778             | PatKind::Range(..)
 779             | PatKind::Wild => {
 780                 // always ok
 781             }
 782         }
 783
 784         Ok(())
 785     }
 786 }