src/librustc/middle/mem_categorization.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! # Categorization
  12 //!
  13 //! The job of the categorization module is to analyze an expression to
  14 //! determine what kind of memory is used in evaluating it (for example,
  15 //! where dereferences occur and what kind of pointer is dereferenced;
  16 //! whether the memory is mutable; etc)
  17 //!
  18 //! Categorization effectively transforms all of our expressions into
  19 //! expressions of the following forms (the actual enum has many more
  20 //! possibilities, naturally, but they are all variants of these base
  21 //! forms):
  22 //!
  23 //!     E = rvalue    // some computed rvalue
  24 //!       | x         // address of a local variable or argument
  25 //!       | *E        // deref of a ptr
  26 //!       | E.comp    // access to an interior component
  27 //!
  28 //! Imagine a routine ToAddr(Expr) that evaluates an expression and returns an
  29 //! address where the result is to be found.  If Expr is an lvalue, then this
  30 //! is the address of the lvalue.  If Expr is an rvalue, this is the address of
  31 //! some temporary spot in memory where the result is stored.
  32 //!
  33 //! Now, cat_expr() classifies the expression Expr and the address A=ToAddr(Expr)
  34 //! as follows:
  35 //!
  36 //! - cat: what kind of expression was this?  This is a subset of the
  37 //!   full expression forms which only includes those that we care about
  38 //!   for the purpose of the analysis.
  39 //! - mutbl: mutability of the address A
  40 //! - ty: the type of data found at the address A
  41 //!
  42 //! The resulting categorization tree differs somewhat from the expressions
  43 //! themselves.  For example, auto-derefs are explicit.  Also, an index a[b] is
  44 //! decomposed into two operations: a dereference to reach the array data and
  45 //! then an index to jump forward to the relevant item.
  46 //!
  47 //! ## By-reference upvars
  48 //!
  49 //! One part of the translation which may be non-obvious is that we translate
  50 //! closure upvars into the dereference of a borrowed pointer; this more closely
  51 //! resembles the runtime translation. So, for example, if we had:
  52 //!
  53 //!     let mut x = 3;
  54 //!     let y = 5;
  55 //!     let inc = || x += y;
  56 //!
  57 //! Then when we categorize `x` (*within* the closure) we would yield a
  58 //! result of `*x'`, effectively, where `x'` is a `Categorization::Upvar` reference
  59 //! tied to `x`. The type of `x'` will be a borrowed pointer.
  60
  61 #![allow(non_camel_case_types)]
  62
  63 pub use self::PointerKind::*;
  64 pub use self::InteriorKind::*;
  65 pub use self::FieldName::*;
  66 pub use self::ElementKind::*;
  67 pub use self::MutabilityCategory::*;
  68 pub use self::AliasableReason::*;
  69 pub use self::Note::*;
  70 pub use self::deref_kind::*;
  71
  72 use self::Aliasability::*;
  73
  74 use middle::def_id::DefId;
  75 use front::map as ast_map;
  76 use middle::infer;
  77 use middle::check_const;
  78 use middle::def;
  79 use middle::ty::adjustment;
  80 use middle::ty::{self, Ty};
  81
  82 use rustc_front::hir::{MutImmutable, MutMutable};
  83 use rustc_front::hir;
  84 use syntax::ast;
  85 use syntax::codemap::Span;
  86
  87 use std::fmt;
  88 use std::rc::Rc;
  89
  90 #[derive(Clone, PartialEq)]
  91 pub enum Categorization<'tcx> {
  92     Rvalue(ty::Region),                    // temporary val, argument is its scope
  93     StaticItem,
  94     Upvar(Upvar),                          // upvar referenced by closure env
  95     Local(ast::NodeId),                    // local variable
  96     Deref(cmt<'tcx>, usize, PointerKind),  // deref of a ptr
  97     Interior(cmt<'tcx>, InteriorKind),     // something interior: field, tuple, etc
  98     Downcast(cmt<'tcx>, DefId),            // selects a particular enum variant (*1)
  99
 100     // (*1) downcast is only required if the enum has more than one variant
 101 }
 102
 103 // Represents any kind of upvar
 104 #[derive(Clone, Copy, PartialEq)]
 105 pub struct Upvar {
 106     pub id: ty::UpvarId,
 107     pub kind: ty::ClosureKind
 108 }
 109
 110 // different kinds of pointers:
 111 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
 112 pub enum PointerKind {
 113     /// `Box<T>`
 114     Unique,
 115
 116     /// `&T`
 117     BorrowedPtr(ty::BorrowKind, ty::Region),
 118
 119     /// `*T`
 120     UnsafePtr(hir::Mutability),
 121
 122     /// Implicit deref of the `&T` that results from an overloaded index `[]`.
 123     Implicit(ty::BorrowKind, ty::Region),
 124 }
 125
 126 // We use the term "interior" to mean "something reachable from the
 127 // base without a pointer dereference", e.g. a field
 128 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
 129 pub enum InteriorKind {
 130     InteriorField(FieldName),
 131     InteriorElement(InteriorOffsetKind, ElementKind),
 132 }
 133
 134 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
 135 pub enum FieldName {
 136     NamedField(ast::Name),
 137     PositionalField(usize)
 138 }
 139
 140 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
 141 pub enum InteriorOffsetKind {
 142     Index,            // e.g. `array_expr[index_expr]`
 143     Pattern,          // e.g. `fn foo([_, a, _, _]: [A; 4]) { ... }`
 144 }
 145
 146 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
 147 pub enum ElementKind {
 148     VecElement,
 149     OtherElement,
 150 }
 151
 152 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
 153 pub enum MutabilityCategory {
 154     McImmutable, // Immutable.
 155     McDeclared,  // Directly declared as mutable.
 156     McInherited, // Inherited from the fact that owner is mutable.
 157 }
 158
 159 // A note about the provenance of a `cmt`.  This is used for
 160 // special-case handling of upvars such as mutability inference.
 161 // Upvar categorization can generate a variable number of nested
 162 // derefs.  The note allows detecting them without deep pattern
 163 // matching on the categorization.
 164 #[derive(Clone, Copy, PartialEq, Debug)]
 165 pub enum Note {
 166     NoteClosureEnv(ty::UpvarId), // Deref through closure env
 167     NoteUpvarRef(ty::UpvarId),   // Deref through by-ref upvar
 168     NoteNone                     // Nothing special
 169 }
 170
 171 // `cmt`: "Category, Mutability, and Type".
 172 //
 173 // a complete categorization of a value indicating where it originated
 174 // and how it is located, as well as the mutability of the memory in
 175 // which the value is stored.
 176 //
 177 // *WARNING* The field `cmt.type` is NOT necessarily the same as the
 178 // result of `node_id_to_type(cmt.id)`. This is because the `id` is
 179 // always the `id` of the node producing the type; in an expression
 180 // like `*x`, the type of this deref node is the deref'd type (`T`),
 181 // but in a pattern like `@x`, the `@x` pattern is again a
 182 // dereference, but its type is the type *before* the dereference
 183 // (`@T`). So use `cmt.ty` to find the type of the value in a consistent
 184 // fashion. For more details, see the method `cat_pattern`
 185 #[derive(Clone, PartialEq)]
 186 pub struct cmt_<'tcx> {
 187     pub id: ast::NodeId,           // id of expr/pat producing this value
 188     pub span: Span,                // span of same expr/pat
 189     pub cat: Categorization<'tcx>, // categorization of expr
 190     pub mutbl: MutabilityCategory, // mutability of expr as lvalue
 191     pub ty: Ty<'tcx>,              // type of the expr (*see WARNING above*)
 192     pub note: Note,                // Note about the provenance of this cmt
 193 }
 194
 195 pub type cmt<'tcx> = Rc<cmt_<'tcx>>;
 196
 197 // We pun on *T to mean both actual deref of a ptr as well
 198 // as accessing of components:
 199 #[derive(Copy, Clone)]
 200 pub enum deref_kind {
 201     deref_ptr(PointerKind),
 202     deref_interior(InteriorKind),
 203 }
 204
 205 type DerefKindContext = Option<InteriorOffsetKind>;
 206
 207 // Categorizes a derefable type.  Note that we include vectors and strings as
 208 // derefable (we model an index as the combination of a deref and then a
 209 // pointer adjustment).
 210 fn deref_kind(t: Ty, context: DerefKindContext) -> McResult<deref_kind> {
 211     match t.sty {
 212         ty::TyBox(_) => {
 213             Ok(deref_ptr(Unique))
 214         }
 215
 216         ty::TyRef(r, mt) => {
 217             let kind = ty::BorrowKind::from_mutbl(mt.mutbl);
 218             Ok(deref_ptr(BorrowedPtr(kind, *r)))
 219         }
 220
 221         ty::TyRawPtr(ref mt) => {
 222             Ok(deref_ptr(UnsafePtr(mt.mutbl)))
 223         }
 224
 225         ty::TyEnum(..) |
 226         ty::TyStruct(..) => { // newtype
 227             Ok(deref_interior(InteriorField(PositionalField(0))))
 228         }
 229
 230         ty::TyArray(_, _) | ty::TySlice(_) | ty::TyStr => {
 231             // no deref of indexed content without supplying InteriorOffsetKind
 232             if let Some(context) = context {
 233                 Ok(deref_interior(InteriorElement(context, element_kind(t))))
 234             } else {
 235                 Err(())
 236             }
 237         }
 238
 239         _ => Err(()),
 240     }
 241 }
 242
 243 pub trait ast_node {
 244     fn id(&self) -> ast::NodeId;
 245     fn span(&self) -> Span;
 246 }
 247
 248 impl ast_node for hir::Expr {
 249     fn id(&self) -> ast::NodeId { self.id }
 250     fn span(&self) -> Span { self.span }
 251 }
 252
 253 impl ast_node for hir::Pat {
 254     fn id(&self) -> ast::NodeId { self.id }
 255     fn span(&self) -> Span { self.span }
 256 }
 257
 258 #[derive(Copy, Clone)]
 259 pub struct MemCategorizationContext<'t, 'a: 't, 'tcx : 'a> {
 260     pub typer: &'t infer::InferCtxt<'a, 'tcx>,
 261 }
 262
 263 pub type McResult<T> = Result<T, ()>;
 264
 265 impl MutabilityCategory {
 266     pub fn from_mutbl(m: hir::Mutability) -> MutabilityCategory {
 267         let ret = match m {
 268             MutImmutable => McImmutable,
 269             MutMutable => McDeclared
 270         };
 271         debug!("MutabilityCategory::{}({:?}) => {:?}",
 272                "from_mutbl", m, ret);
 273         ret
 274     }
 275
 276     pub fn from_borrow_kind(borrow_kind: ty::BorrowKind) -> MutabilityCategory {
 277         let ret = match borrow_kind {
 278             ty::ImmBorrow => McImmutable,
 279             ty::UniqueImmBorrow => McImmutable,
 280             ty::MutBorrow => McDeclared,
 281         };
 282         debug!("MutabilityCategory::{}({:?}) => {:?}",
 283                "from_borrow_kind", borrow_kind, ret);
 284         ret
 285     }
 286
 287     fn from_pointer_kind(base_mutbl: MutabilityCategory,
 288                          ptr: PointerKind) -> MutabilityCategory {
 289         let ret = match ptr {
 290             Unique => {
 291                 base_mutbl.inherit()
 292             }
 293             BorrowedPtr(borrow_kind, _) | Implicit(borrow_kind, _) => {
 294                 MutabilityCategory::from_borrow_kind(borrow_kind)
 295             }
 296             UnsafePtr(m) => {
 297                 MutabilityCategory::from_mutbl(m)
 298             }
 299         };
 300         debug!("MutabilityCategory::{}({:?}, {:?}) => {:?}",
 301                "from_pointer_kind", base_mutbl, ptr, ret);
 302         ret
 303     }
 304
 305     fn from_local(tcx: &ty::ctxt, id: ast::NodeId) -> MutabilityCategory {
 306         let ret = match tcx.map.get(id) {
 307             ast_map::NodeLocal(p) => match p.node {
 308                 hir::PatIdent(bind_mode, _, _) => {
 309                     if bind_mode == hir::BindByValue(hir::MutMutable) {
 310                         McDeclared
 311                     } else {
 312                         McImmutable
 313                     }
 314                 }
 315                 _ => tcx.sess.span_bug(p.span, "expected identifier pattern")
 316             },
 317             _ => tcx.sess.span_bug(tcx.map.span(id), "expected identifier pattern")
 318         };
 319         debug!("MutabilityCategory::{}(tcx, id={:?}) => {:?}",
 320                "from_local", id, ret);
 321         ret
 322     }
 323
 324     pub fn inherit(&self) -> MutabilityCategory {
 325         let ret = match *self {
 326             McImmutable => McImmutable,
 327             McDeclared => McInherited,
 328             McInherited => McInherited,
 329         };
 330         debug!("{:?}.inherit() => {:?}", self, ret);
 331         ret
 332     }
 333
 334     pub fn is_mutable(&self) -> bool {
 335         let ret = match *self {
 336             McImmutable => false,
 337             McInherited => true,
 338             McDeclared => true,
 339         };
 340         debug!("{:?}.is_mutable() => {:?}", self, ret);
 341         ret
 342     }
 343
 344     pub fn is_immutable(&self) -> bool {
 345         let ret = match *self {
 346             McImmutable => true,
 347             McDeclared | McInherited => false
 348         };
 349         debug!("{:?}.is_immutable() => {:?}", self, ret);
 350         ret
 351     }
 352
 353     pub fn to_user_str(&self) -> &'static str {
 354         match *self {
 355             McDeclared | McInherited => "mutable",
 356             McImmutable => "immutable",
 357         }
 358     }
 359 }
 360
 361 impl<'t, 'a,'tcx> MemCategorizationContext<'t, 'a, 'tcx> {
 362     pub fn new(typer: &'t infer::InferCtxt<'a, 'tcx>) -> MemCategorizationContext<'t, 'a, 'tcx> {
 363         MemCategorizationContext { typer: typer }
 364     }
 365
 366     fn tcx(&self) -> &'a ty::ctxt<'tcx> {
 367         self.typer.tcx
 368     }
 369
 370     fn expr_ty(&self, expr: &hir::Expr) -> McResult<Ty<'tcx>> {
 371         match self.typer.node_ty(expr.id) {
 372             Ok(t) => Ok(t),
 373             Err(()) => {
 374                 debug!("expr_ty({:?}) yielded Err", expr);
 375                 Err(())
 376             }
 377         }
 378     }
 379
 380     fn expr_ty_adjusted(&self, expr: &hir::Expr) -> McResult<Ty<'tcx>> {
 381         let unadjusted_ty = try!(self.expr_ty(expr));
 382         Ok(unadjusted_ty.adjust(
 383             self.tcx(), expr.span, expr.id,
 384             self.typer.adjustments().get(&expr.id),
 385             |method_call| self.typer.node_method_ty(method_call)))
 386     }
 387
 388     fn node_ty(&self, id: ast::NodeId) -> McResult<Ty<'tcx>> {
 389         self.typer.node_ty(id)
 390     }
 391
 392     fn pat_ty(&self, pat: &hir::Pat) -> McResult<Ty<'tcx>> {
 393         let base_ty = try!(self.typer.node_ty(pat.id));
 394         // FIXME (Issue #18207): This code detects whether we are
 395         // looking at a `ref x`, and if so, figures out what the type
 396         // *being borrowed* is.  But ideally we would put in a more
 397         // fundamental fix to this conflated use of the node id.
 398         let ret_ty = match pat.node {
 399             hir::PatIdent(hir::BindByRef(_), _, _) => {
 400                 // a bind-by-ref means that the base_ty will be the type of the ident itself,
 401                 // but what we want here is the type of the underlying value being borrowed.
 402                 // So peel off one-level, turning the &T into T.
 403                 match base_ty.builtin_deref(false, ty::NoPreference) {
 404                     Some(t) => t.ty,
 405                     None => { return Err(()); }
 406                 }
 407             }
 408             _ => base_ty,
 409         };
 410         debug!("pat_ty(pat={:?}) base_ty={:?} ret_ty={:?}",
 411                pat, base_ty, ret_ty);
 412         Ok(ret_ty)
 413     }
 414
 415     pub fn cat_expr(&self, expr: &hir::Expr) -> McResult<cmt<'tcx>> {
 416         match self.typer.adjustments().get(&expr.id) {
 417             None => {
 418                 // No adjustments.
 419                 self.cat_expr_unadjusted(expr)
 420             }
 421
 422             Some(adjustment) => {
 423                 match *adjustment {
 424                     adjustment::AdjustDerefRef(
 425                         adjustment::AutoDerefRef {
 426                             autoref: None, unsize: None, autoderefs, ..}) => {
 427                         // Equivalent to *expr or something similar.
 428                         self.cat_expr_autoderefd(expr, autoderefs)
 429                     }
 430
 431                     adjustment::AdjustReifyFnPointer |
 432                     adjustment::AdjustUnsafeFnPointer |
 433                     adjustment::AdjustDerefRef(_) => {
 434                         debug!("cat_expr({:?}): {:?}",
 435                                adjustment,
 436                                expr);
 437                         // Result is an rvalue.
 438                         let expr_ty = try!(self.expr_ty_adjusted(expr));
 439                         Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
 440                     }
 441                 }
 442             }
 443         }
 444     }
 445
 446     pub fn cat_expr_autoderefd(&self,
 447                                expr: &hir::Expr,
 448                                autoderefs: usize)
 449                                -> McResult<cmt<'tcx>> {
 450         let mut cmt = try!(self.cat_expr_unadjusted(expr));
 451         debug!("cat_expr_autoderefd: autoderefs={}, cmt={:?}",
 452                autoderefs,
 453                cmt);
 454         for deref in 1..autoderefs + 1 {
 455             cmt = try!(self.cat_deref(expr, cmt, deref, None));
 456         }
 457         return Ok(cmt);
 458     }
 459
 460     pub fn cat_expr_unadjusted(&self, expr: &hir::Expr) -> McResult<cmt<'tcx>> {
 461         debug!("cat_expr: id={} expr={:?}", expr.id, expr);
 462
 463         let expr_ty = try!(self.expr_ty(expr));
 464         match expr.node {
 465           hir::ExprUnary(hir::UnDeref, ref e_base) => {
 466             let base_cmt = try!(self.cat_expr(&**e_base));
 467             self.cat_deref(expr, base_cmt, 0, None)
 468           }
 469
 470           hir::ExprField(ref base, f_name) => {
 471             let base_cmt = try!(self.cat_expr(&**base));
 472             debug!("cat_expr(cat_field): id={} expr={:?} base={:?}",
 473                    expr.id,
 474                    expr,
 475                    base_cmt);
 476             Ok(self.cat_field(expr, base_cmt, f_name.node, expr_ty))
 477           }
 478
 479           hir::ExprTupField(ref base, idx) => {
 480             let base_cmt = try!(self.cat_expr(&**base));
 481             Ok(self.cat_tup_field(expr, base_cmt, idx.node, expr_ty))
 482           }
 483
 484           hir::ExprIndex(ref base, _) => {
 485             let method_call = ty::MethodCall::expr(expr.id());
 486             let context = InteriorOffsetKind::Index;
 487             match self.typer.node_method_ty(method_call) {
 488                 Some(method_ty) => {
 489                     // If this is an index implemented by a method call, then it
 490                     // will include an implicit deref of the result.
 491                     let ret_ty = self.overloaded_method_return_ty(method_ty);
 492
 493                     // The index method always returns an `&T`, so
 494                     // dereference it to find the result type.
 495                     let elem_ty = match ret_ty.sty {
 496                         ty::TyRef(_, mt) => mt.ty,
 497                         _ => {
 498                             debug!("cat_expr_unadjusted: return type of overloaded index is {:?}?",
 499                                    ret_ty);
 500                             return Err(());
 501                         }
 502                     };
 503
 504                     // The call to index() returns a `&T` value, which
 505                     // is an rvalue. That is what we will be
 506                     // dereferencing.
 507                     let base_cmt = self.cat_rvalue_node(expr.id(), expr.span(), ret_ty);
 508                     self.cat_deref_common(expr, base_cmt, 1, elem_ty, Some(context), true)
 509                 }
 510                 None => {
 511                     self.cat_index(expr, try!(self.cat_expr(&**base)), context)
 512                 }
 513             }
 514           }
 515
 516           hir::ExprPath(..) => {
 517             let def = self.tcx().def_map.borrow().get(&expr.id).unwrap().full_def();
 518             self.cat_def(expr.id, expr.span, expr_ty, def)
 519           }
 520
 521           hir::ExprType(ref e, _) => {
 522             self.cat_expr(&**e)
 523           }
 524
 525           hir::ExprAddrOf(..) | hir::ExprCall(..) |
 526           hir::ExprAssign(..) | hir::ExprAssignOp(..) |
 527           hir::ExprClosure(..) | hir::ExprRet(..) |
 528           hir::ExprUnary(..) | hir::ExprRange(..) |
 529           hir::ExprMethodCall(..) | hir::ExprCast(..) |
 530           hir::ExprVec(..) | hir::ExprTup(..) | hir::ExprIf(..) |
 531           hir::ExprBinary(..) | hir::ExprWhile(..) |
 532           hir::ExprBlock(..) | hir::ExprLoop(..) | hir::ExprMatch(..) |
 533           hir::ExprLit(..) | hir::ExprBreak(..) |
 534           hir::ExprAgain(..) | hir::ExprStruct(..) | hir::ExprRepeat(..) |
 535           hir::ExprInlineAsm(..) | hir::ExprBox(..) => {
 536             Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
 537           }
 538         }
 539     }
 540
 541     pub fn cat_def(&self,
 542                    id: ast::NodeId,
 543                    span: Span,
 544                    expr_ty: Ty<'tcx>,
 545                    def: def::Def)
 546                    -> McResult<cmt<'tcx>> {
 547         debug!("cat_def: id={} expr={:?} def={:?}",
 548                id, expr_ty, def);
 549
 550         match def {
 551           def::DefStruct(..) | def::DefVariant(..) | def::DefConst(..) |
 552           def::DefAssociatedConst(..) | def::DefFn(..) | def::DefMethod(..) => {
 553                 Ok(self.cat_rvalue_node(id, span, expr_ty))
 554           }
 555           def::DefMod(_) | def::DefForeignMod(_) | def::DefUse(_) |
 556           def::DefTrait(_) | def::DefTy(..) | def::DefPrimTy(_) |
 557           def::DefTyParam(..) |
 558           def::DefLabel(_) | def::DefSelfTy(..) |
 559           def::DefAssociatedTy(..) => {
 560               Ok(Rc::new(cmt_ {
 561                   id:id,
 562                   span:span,
 563                   cat:Categorization::StaticItem,
 564                   mutbl: McImmutable,
 565                   ty:expr_ty,
 566                   note: NoteNone
 567               }))
 568           }
 569
 570           def::DefStatic(_, mutbl) => {
 571               Ok(Rc::new(cmt_ {
 572                   id:id,
 573                   span:span,
 574                   cat:Categorization::StaticItem,
 575                   mutbl: if mutbl { McDeclared } else { McImmutable},
 576                   ty:expr_ty,
 577                   note: NoteNone
 578               }))
 579           }
 580
 581           def::DefUpvar(_, var_id, _, fn_node_id) => {
 582               let ty = try!(self.node_ty(fn_node_id));
 583               match ty.sty {
 584                   ty::TyClosure(closure_id, _) => {
 585                       match self.typer.closure_kind(closure_id) {
 586                           Some(kind) => {
 587                               self.cat_upvar(id, span, var_id, fn_node_id, kind)
 588                           }
 589                           None => {
 590                               self.tcx().sess.span_bug(
 591                                   span,
 592                                   &*format!("No closure kind for {:?}", closure_id));
 593                           }
 594                       }
 595                   }
 596                   _ => {
 597                       self.tcx().sess.span_bug(
 598                           span,
 599                           &format!("Upvar of non-closure {} - {:?}",
 600                                   fn_node_id,
 601                                   ty));
 602                   }
 603               }
 604           }
 605
 606           def::DefLocal(_, vid) => {
 607             Ok(Rc::new(cmt_ {
 608                 id: id,
 609                 span: span,
 610                 cat: Categorization::Local(vid),
 611                 mutbl: MutabilityCategory::from_local(self.tcx(), vid),
 612                 ty: expr_ty,
 613                 note: NoteNone
 614             }))
 615           }
 616         }
 617     }
 618
 619     // Categorize an upvar, complete with invisible derefs of closure
 620     // environment and upvar reference as appropriate.
 621     fn cat_upvar(&self,
 622                  id: ast::NodeId,
 623                  span: Span,
 624                  var_id: ast::NodeId,
 625                  fn_node_id: ast::NodeId,
 626                  kind: ty::ClosureKind)
 627                  -> McResult<cmt<'tcx>>
 628     {
 629         // An upvar can have up to 3 components. We translate first to a
 630         // `Categorization::Upvar`, which is itself a fiction -- it represents the reference to the
 631         // field from the environment.
 632         //
 633         // `Categorization::Upvar`.  Next, we add a deref through the implicit
 634         // environment pointer with an anonymous free region 'env and
 635         // appropriate borrow kind for closure kinds that take self by
 636         // reference.  Finally, if the upvar was captured
 637         // by-reference, we add a deref through that reference.  The
 638         // region of this reference is an inference variable 'up that
 639         // was previously generated and recorded in the upvar borrow
 640         // map.  The borrow kind bk is inferred by based on how the
 641         // upvar is used.
 642         //
 643         // This results in the following table for concrete closure
 644         // types:
 645         //
 646         //                | move                 | ref
 647         // ---------------+----------------------+-------------------------------
 648         // Fn             | copied -> &'env      | upvar -> &'env -> &'up bk
 649         // FnMut          | copied -> &'env mut  | upvar -> &'env mut -> &'up bk
 650         // FnOnce         | copied               | upvar -> &'up bk
 651
 652         let upvar_id = ty::UpvarId { var_id: var_id,
 653                                      closure_expr_id: fn_node_id };
 654         let var_ty = try!(self.node_ty(var_id));
 655
 656         // Mutability of original variable itself
 657         let var_mutbl = MutabilityCategory::from_local(self.tcx(), var_id);
 658
 659         // Construct the upvar. This represents access to the field
 660         // from the environment (perhaps we should eventually desugar
 661         // this field further, but it will do for now).
 662         let cmt_result = cmt_ {
 663             id: id,
 664             span: span,
 665             cat: Categorization::Upvar(Upvar {id: upvar_id, kind: kind}),
 666             mutbl: var_mutbl,
 667             ty: var_ty,
 668             note: NoteNone
 669         };
 670
 671         // If this is a `FnMut` or `Fn` closure, then the above is
 672         // conceptually a `&mut` or `&` reference, so we have to add a
 673         // deref.
 674         let cmt_result = match kind {
 675             ty::FnOnceClosureKind => {
 676                 cmt_result
 677             }
 678             ty::FnMutClosureKind => {
 679                 self.env_deref(id, span, upvar_id, var_mutbl, ty::MutBorrow, cmt_result)
 680             }
 681             ty::FnClosureKind => {
 682                 self.env_deref(id, span, upvar_id, var_mutbl, ty::ImmBorrow, cmt_result)
 683             }
 684         };
 685
 686         // If this is a by-ref capture, then the upvar we loaded is
 687         // actually a reference, so we have to add an implicit deref
 688         // for that.
 689         let upvar_id = ty::UpvarId { var_id: var_id,
 690                                      closure_expr_id: fn_node_id };
 691         let upvar_capture = self.typer.upvar_capture(upvar_id).unwrap();
 692         let cmt_result = match upvar_capture {
 693             ty::UpvarCapture::ByValue => {
 694                 cmt_result
 695             }
 696             ty::UpvarCapture::ByRef(upvar_borrow) => {
 697                 let ptr = BorrowedPtr(upvar_borrow.kind, upvar_borrow.region);
 698                 cmt_ {
 699                     id: id,
 700                     span: span,
 701                     cat: Categorization::Deref(Rc::new(cmt_result), 0, ptr),
 702                     mutbl: MutabilityCategory::from_borrow_kind(upvar_borrow.kind),
 703                     ty: var_ty,
 704                     note: NoteUpvarRef(upvar_id)
 705                 }
 706             }
 707         };
 708
 709         let ret = Rc::new(cmt_result);
 710         debug!("cat_upvar ret={:?}", ret);
 711         Ok(ret)
 712     }
 713
 714     fn env_deref(&self,
 715                  id: ast::NodeId,
 716                  span: Span,
 717                  upvar_id: ty::UpvarId,
 718                  upvar_mutbl: MutabilityCategory,
 719                  env_borrow_kind: ty::BorrowKind,
 720                  cmt_result: cmt_<'tcx>)
 721                  -> cmt_<'tcx>
 722     {
 723         // Look up the node ID of the closure body so we can construct
 724         // a free region within it
 725         let fn_body_id = {
 726             let fn_expr = match self.tcx().map.find(upvar_id.closure_expr_id) {
 727                 Some(ast_map::NodeExpr(e)) => e,
 728                 _ => unreachable!()
 729             };
 730
 731             match fn_expr.node {
 732                 hir::ExprClosure(_, _, ref body) => body.id,
 733                 _ => unreachable!()
 734             }
 735         };
 736
 737         // Region of environment pointer
 738         let env_region = ty::ReFree(ty::FreeRegion {
 739             // The environment of a closure is guaranteed to
 740             // outlive any bindings introduced in the body of the
 741             // closure itself.
 742             scope: self.tcx().region_maps.item_extent(fn_body_id),
 743             bound_region: ty::BrEnv
 744         });
 745
 746         let env_ptr = BorrowedPtr(env_borrow_kind, env_region);
 747
 748         let var_ty = cmt_result.ty;
 749
 750         // We need to add the env deref.  This means
 751         // that the above is actually immutable and
 752         // has a ref type.  However, nothing should
 753         // actually look at the type, so we can get
 754         // away with stuffing a `TyError` in there
 755         // instead of bothering to construct a proper
 756         // one.
 757         let cmt_result = cmt_ {
 758             mutbl: McImmutable,
 759             ty: self.tcx().types.err,
 760             ..cmt_result
 761         };
 762
 763         let mut deref_mutbl = MutabilityCategory::from_borrow_kind(env_borrow_kind);
 764
 765         // Issue #18335. If variable is declared as immutable, override the
 766         // mutability from the environment and substitute an `&T` anyway.
 767         match upvar_mutbl {
 768             McImmutable => { deref_mutbl = McImmutable; }
 769             McDeclared | McInherited => { }
 770         }
 771
 772         let ret = cmt_ {
 773             id: id,
 774             span: span,
 775             cat: Categorization::Deref(Rc::new(cmt_result), 0, env_ptr),
 776             mutbl: deref_mutbl,
 777             ty: var_ty,
 778             note: NoteClosureEnv(upvar_id)
 779         };
 780
 781         debug!("env_deref ret {:?}", ret);
 782
 783         ret
 784     }
 785
 786     /// Returns the lifetime of a temporary created by expr with id `id`.
 787     /// This could be `'static` if `id` is part of a constant expression.
 788     pub fn temporary_scope(&self, id: ast::NodeId) -> ty::Region {
 789         match self.typer.temporary_scope(id) {
 790             Some(scope) => ty::ReScope(scope),
 791             None => ty::ReStatic
 792         }
 793     }
 794
 795     pub fn cat_rvalue_node(&self,
 796                            id: ast::NodeId,
 797                            span: Span,
 798                            expr_ty: Ty<'tcx>)
 799                            -> cmt<'tcx> {
 800         let qualif = self.tcx().const_qualif_map.borrow().get(&id).cloned()
 801                                .unwrap_or(check_const::ConstQualif::NOT_CONST);
 802
 803         // Only promote `[T; 0]` before an RFC for rvalue promotions
 804         // is accepted.
 805         let qualif = match expr_ty.sty {
 806             ty::TyArray(_, 0) => qualif,
 807             _ => check_const::ConstQualif::NOT_CONST
 808         };
 809
 810         // Compute maximum lifetime of this rvalue. This is 'static if
 811         // we can promote to a constant, otherwise equal to enclosing temp
 812         // lifetime.
 813         let re = if qualif.intersects(check_const::ConstQualif::NON_STATIC_BORROWS) {
 814             self.temporary_scope(id)
 815         } else {
 816             ty::ReStatic
 817         };
 818         let ret = self.cat_rvalue(id, span, re, expr_ty);
 819         debug!("cat_rvalue_node ret {:?}", ret);
 820         ret
 821     }
 822
 823     pub fn cat_rvalue(&self,
 824                       cmt_id: ast::NodeId,
 825                       span: Span,
 826                       temp_scope: ty::Region,
 827                       expr_ty: Ty<'tcx>) -> cmt<'tcx> {
 828         let ret = Rc::new(cmt_ {
 829             id:cmt_id,
 830             span:span,
 831             cat:Categorization::Rvalue(temp_scope),
 832             mutbl:McDeclared,
 833             ty:expr_ty,
 834             note: NoteNone
 835         });
 836         debug!("cat_rvalue ret {:?}", ret);
 837         ret
 838     }
 839
 840     pub fn cat_field<N:ast_node>(&self,
 841                                  node: &N,
 842                                  base_cmt: cmt<'tcx>,
 843                                  f_name: ast::Name,
 844                                  f_ty: Ty<'tcx>)
 845                                  -> cmt<'tcx> {
 846         let ret = Rc::new(cmt_ {
 847             id: node.id(),
 848             span: node.span(),
 849             mutbl: base_cmt.mutbl.inherit(),
 850             cat: Categorization::Interior(base_cmt, InteriorField(NamedField(f_name))),
 851             ty: f_ty,
 852             note: NoteNone
 853         });
 854         debug!("cat_field ret {:?}", ret);
 855         ret
 856     }
 857
 858     pub fn cat_tup_field<N:ast_node>(&self,
 859                                      node: &N,
 860                                      base_cmt: cmt<'tcx>,
 861                                      f_idx: usize,
 862                                      f_ty: Ty<'tcx>)
 863                                      -> cmt<'tcx> {
 864         let ret = Rc::new(cmt_ {
 865             id: node.id(),
 866             span: node.span(),
 867             mutbl: base_cmt.mutbl.inherit(),
 868             cat: Categorization::Interior(base_cmt, InteriorField(PositionalField(f_idx))),
 869             ty: f_ty,
 870             note: NoteNone
 871         });
 872         debug!("cat_tup_field ret {:?}", ret);
 873         ret
 874     }
 875
 876     fn cat_deref<N:ast_node>(&self,
 877                              node: &N,
 878                              base_cmt: cmt<'tcx>,
 879                              deref_cnt: usize,
 880                              deref_context: DerefKindContext)
 881                              -> McResult<cmt<'tcx>> {
 882         let method_call = ty::MethodCall {
 883             expr_id: node.id(),
 884             autoderef: deref_cnt as u32
 885         };
 886         let method_ty = self.typer.node_method_ty(method_call);
 887
 888         debug!("cat_deref: method_call={:?} method_ty={:?}",
 889                method_call, method_ty.map(|ty| ty));
 890
 891         let base_cmt = match method_ty {
 892             Some(method_ty) => {
 893                 let ref_ty =
 894                     self.tcx().no_late_bound_regions(&method_ty.fn_ret()).unwrap().unwrap();
 895                 self.cat_rvalue_node(node.id(), node.span(), ref_ty)
 896             }
 897             None => base_cmt
 898         };
 899         let base_cmt_ty = base_cmt.ty;
 900         match base_cmt_ty.builtin_deref(true, ty::NoPreference) {
 901             Some(mt) => {
 902                 let ret = self.cat_deref_common(node, base_cmt, deref_cnt,
 903                                               mt.ty,
 904                                               deref_context,
 905                                                 /* implicit: */ false);
 906                 debug!("cat_deref ret {:?}", ret);
 907                 ret
 908             }
 909             None => {
 910                 debug!("Explicit deref of non-derefable type: {:?}",
 911                        base_cmt_ty);
 912                 return Err(());
 913             }
 914         }
 915     }
 916
 917     fn cat_deref_common<N:ast_node>(&self,
 918                                     node: &N,
 919                                     base_cmt: cmt<'tcx>,
 920                                     deref_cnt: usize,
 921                                     deref_ty: Ty<'tcx>,
 922                                     deref_context: DerefKindContext,
 923                                     implicit: bool)
 924                                     -> McResult<cmt<'tcx>>
 925     {
 926         let (m, cat) = match try!(deref_kind(base_cmt.ty, deref_context)) {
 927             deref_ptr(ptr) => {
 928                 let ptr = if implicit {
 929                     match ptr {
 930                         BorrowedPtr(bk, r) => Implicit(bk, r),
 931                         _ => self.tcx().sess.span_bug(node.span(),
 932                             "Implicit deref of non-borrowed pointer")
 933                     }
 934                 } else {
 935                     ptr
 936                 };
 937                 // for unique ptrs, we inherit mutability from the
 938                 // owning reference.
 939                 (MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr),
 940                  Categorization::Deref(base_cmt, deref_cnt, ptr))
 941             }
 942             deref_interior(interior) => {
 943                 (base_cmt.mutbl.inherit(), Categorization::Interior(base_cmt, interior))
 944             }
 945         };
 946         let ret = Rc::new(cmt_ {
 947             id: node.id(),
 948             span: node.span(),
 949             cat: cat,
 950             mutbl: m,
 951             ty: deref_ty,
 952             note: NoteNone
 953         });
 954         debug!("cat_deref_common ret {:?}", ret);
 955         Ok(ret)
 956     }
 957
 958     pub fn cat_index<N:ast_node>(&self,
 959                                  elt: &N,
 960                                  mut base_cmt: cmt<'tcx>,
 961                                  context: InteriorOffsetKind)
 962                                  -> McResult<cmt<'tcx>> {
 963         //! Creates a cmt for an indexing operation (`[]`).
 964         //!
 965         //! One subtle aspect of indexing that may not be
 966         //! immediately obvious: for anything other than a fixed-length
 967         //! vector, an operation like `x[y]` actually consists of two
 968         //! disjoint (from the point of view of borrowck) operations.
 969         //! The first is a deref of `x` to create a pointer `p` that points
 970         //! at the first element in the array. The second operation is
 971         //! an index which adds `y*sizeof(T)` to `p` to obtain the
 972         //! pointer to `x[y]`. `cat_index` will produce a resulting
 973         //! cmt containing both this deref and the indexing,
 974         //! presuming that `base_cmt` is not of fixed-length type.
 975         //!
 976         //! # Parameters
 977         //! - `elt`: the AST node being indexed
 978         //! - `base_cmt`: the cmt of `elt`
 979
 980         let method_call = ty::MethodCall::expr(elt.id());
 981         let method_ty = self.typer.node_method_ty(method_call);
 982
 983         let element_ty = match method_ty {
 984             Some(method_ty) => {
 985                 let ref_ty = self.overloaded_method_return_ty(method_ty);
 986                 base_cmt = self.cat_rvalue_node(elt.id(), elt.span(), ref_ty);
 987
 988                 // FIXME(#20649) -- why are we using the `self_ty` as the element type...?
 989                 let self_ty = method_ty.fn_sig().input(0);
 990                 self.tcx().no_late_bound_regions(&self_ty).unwrap()
 991             }
 992             None => {
 993                 match base_cmt.ty.builtin_index() {
 994                     Some(ty) => ty,
 995                     None => {
 996                         return Err(());
 997                     }
 998                 }
 999             }
1000         };
1001
1002         let m = base_cmt.mutbl.inherit();
1003         let ret = interior(elt, base_cmt.clone(), base_cmt.ty,
1004                            m, context, element_ty);
1005         debug!("cat_index ret {:?}", ret);
1006         return Ok(ret);
1007
1008         fn interior<'tcx, N: ast_node>(elt: &N,
1009                                        of_cmt: cmt<'tcx>,
1010                                        vec_ty: Ty<'tcx>,
1011                                        mutbl: MutabilityCategory,
1012                                        context: InteriorOffsetKind,
1013                                        element_ty: Ty<'tcx>) -> cmt<'tcx>
1014         {
1015             let interior_elem = InteriorElement(context, element_kind(vec_ty));
1016             Rc::new(cmt_ {
1017                 id:elt.id(),
1018                 span:elt.span(),
1019                 cat:Categorization::Interior(of_cmt, interior_elem),
1020                 mutbl:mutbl,
1021                 ty:element_ty,
1022                 note: NoteNone
1023             })
1024         }
1025     }
1026
1027     // Takes either a vec or a reference to a vec and returns the cmt for the
1028     // underlying vec.
1029     fn deref_vec<N:ast_node>(&self,
1030                              elt: &N,
1031                              base_cmt: cmt<'tcx>,
1032                              context: InteriorOffsetKind)
1033                              -> McResult<cmt<'tcx>>
1034     {
1035         let ret = match try!(deref_kind(base_cmt.ty, Some(context))) {
1036             deref_ptr(ptr) => {
1037                 // for unique ptrs, we inherit mutability from the
1038                 // owning reference.
1039                 let m = MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr);
1040
1041                 // the deref is explicit in the resulting cmt
1042                 Rc::new(cmt_ {
1043                     id:elt.id(),
1044                     span:elt.span(),
1045                     cat:Categorization::Deref(base_cmt.clone(), 0, ptr),
1046                     mutbl:m,
1047                     ty: match base_cmt.ty.builtin_deref(false, ty::NoPreference) {
1048                         Some(mt) => mt.ty,
1049                         None => self.tcx().sess.bug("Found non-derefable type")
1050                     },
1051                     note: NoteNone
1052                 })
1053             }
1054
1055             deref_interior(_) => {
1056                 base_cmt
1057             }
1058         };
1059         debug!("deref_vec ret {:?}", ret);
1060         Ok(ret)
1061     }
1062
1063     /// Given a pattern P like: `[_, ..Q, _]`, where `vec_cmt` is the cmt for `P`, `slice_pat` is
1064     /// the pattern `Q`, returns:
1065     ///
1066     /// * a cmt for `Q`
1067     /// * the mutability and region of the slice `Q`
1068     ///
1069     /// These last two bits of info happen to be things that borrowck needs.
1070     pub fn cat_slice_pattern(&self,
1071                              vec_cmt: cmt<'tcx>,
1072                              slice_pat: &hir::Pat)
1073                              -> McResult<(cmt<'tcx>, hir::Mutability, ty::Region)> {
1074         let slice_ty = try!(self.node_ty(slice_pat.id));
1075         let (slice_mutbl, slice_r) = vec_slice_info(self.tcx(),
1076                                                     slice_pat,
1077                                                     slice_ty);
1078         let context = InteriorOffsetKind::Pattern;
1079         let cmt_vec = try!(self.deref_vec(slice_pat, vec_cmt, context));
1080         let cmt_slice = try!(self.cat_index(slice_pat, cmt_vec, context));
1081         return Ok((cmt_slice, slice_mutbl, slice_r));
1082
1083         /// In a pattern like [a, b, ..c], normally `c` has slice type, but if you have [a, b,
1084         /// ..ref c], then the type of `ref c` will be `&&[]`, so to extract the slice details we
1085         /// have to recurse through rptrs.
1086         fn vec_slice_info(tcx: &ty::ctxt,
1087                           pat: &hir::Pat,
1088                           slice_ty: Ty)
1089                           -> (hir::Mutability, ty::Region) {
1090             match slice_ty.sty {
1091                 ty::TyRef(r, ref mt) => match mt.ty.sty {
1092                     ty::TySlice(_) => (mt.mutbl, *r),
1093                     _ => vec_slice_info(tcx, pat, mt.ty),
1094                 },
1095
1096                 _ => {
1097                     tcx.sess.span_bug(pat.span,
1098                                       "type of slice pattern is not a slice");
1099                 }
1100             }
1101         }
1102     }
1103
1104     pub fn cat_imm_interior<N:ast_node>(&self,
1105                                         node: &N,
1106                                         base_cmt: cmt<'tcx>,
1107                                         interior_ty: Ty<'tcx>,
1108                                         interior: InteriorKind)
1109                                         -> cmt<'tcx> {
1110         let ret = Rc::new(cmt_ {
1111             id: node.id(),
1112             span: node.span(),
1113             mutbl: base_cmt.mutbl.inherit(),
1114             cat: Categorization::Interior(base_cmt, interior),
1115             ty: interior_ty,
1116             note: NoteNone
1117         });
1118         debug!("cat_imm_interior ret={:?}", ret);
1119         ret
1120     }
1121
1122     pub fn cat_downcast<N:ast_node>(&self,
1123                                     node: &N,
1124                                     base_cmt: cmt<'tcx>,
1125                                     downcast_ty: Ty<'tcx>,
1126                                     variant_did: DefId)
1127                                     -> cmt<'tcx> {
1128         let ret = Rc::new(cmt_ {
1129             id: node.id(),
1130             span: node.span(),
1131             mutbl: base_cmt.mutbl.inherit(),
1132             cat: Categorization::Downcast(base_cmt, variant_did),
1133             ty: downcast_ty,
1134             note: NoteNone
1135         });
1136         debug!("cat_downcast ret={:?}", ret);
1137         ret
1138     }
1139
1140     pub fn cat_pattern<F>(&self, cmt: cmt<'tcx>, pat: &hir::Pat, mut op: F) -> McResult<()>
1141         where F: FnMut(&MemCategorizationContext<'t, 'a, 'tcx>, cmt<'tcx>, &hir::Pat),
1142     {
1143         self.cat_pattern_(cmt, pat, &mut op)
1144     }
1145
1146     // FIXME(#19596) This is a workaround, but there should be a better way to do this
1147     fn cat_pattern_<F>(&self, cmt: cmt<'tcx>, pat: &hir::Pat, op: &mut F)
1148                        -> McResult<()>
1149         where F : FnMut(&MemCategorizationContext<'t, 'a, 'tcx>, cmt<'tcx>, &hir::Pat),
1150     {
1151         // Here, `cmt` is the categorization for the value being
1152         // matched and pat is the pattern it is being matched against.
1153         //
1154         // In general, the way that this works is that we walk down
1155         // the pattern, constructing a cmt that represents the path
1156         // that will be taken to reach the value being matched.
1157         //
1158         // When we encounter named bindings, we take the cmt that has
1159         // been built up and pass it off to guarantee_valid() so that
1160         // we can be sure that the binding will remain valid for the
1161         // duration of the arm.
1162         //
1163         // (*2) There is subtlety concerning the correspondence between
1164         // pattern ids and types as compared to *expression* ids and
1165         // types. This is explained briefly. on the definition of the
1166         // type `cmt`, so go off and read what it says there, then
1167         // come back and I'll dive into a bit more detail here. :) OK,
1168         // back?
1169         //
1170         // In general, the id of the cmt should be the node that
1171         // "produces" the value---patterns aren't executable code
1172         // exactly, but I consider them to "execute" when they match a
1173         // value, and I consider them to produce the value that was
1174         // matched. So if you have something like:
1175         //
1176         //     let x = @@3;
1177         //     match x {
1178         //       @@y { ... }
1179         //     }
1180         //
1181         // In this case, the cmt and the relevant ids would be:
1182         //
1183         //     CMT             Id                  Type of Id Type of cmt
1184         //
1185         //     local(x)->@->@
1186         //     ^~~~~~~^        `x` from discr      @@int      @@int
1187         //     ^~~~~~~~~~^     `@@y` pattern node  @@int      @int
1188         //     ^~~~~~~~~~~~~^  `@y` pattern node   @int       int
1189         //
1190         // You can see that the types of the id and the cmt are in
1191         // sync in the first line, because that id is actually the id
1192         // of an expression. But once we get to pattern ids, the types
1193         // step out of sync again. So you'll see below that we always
1194         // get the type of the *subpattern* and use that.
1195
1196         debug!("cat_pattern: {:?} cmt={:?}",
1197                pat,
1198                cmt);
1199
1200         (*op)(self, cmt.clone(), pat);
1201
1202         let opt_def = if let Some(path_res) = self.tcx().def_map.borrow().get(&pat.id) {
1203             if path_res.depth != 0 {
1204                 // Since patterns can be associated constants
1205                 // which are resolved during typeck, we might have
1206                 // some unresolved patterns reaching this stage
1207                 // without aborting
1208                 return Err(());
1209             }
1210             Some(path_res.full_def())
1211         } else {
1212             None
1213         };
1214
1215         // Note: This goes up here (rather than within the PatEnum arm
1216         // alone) because struct patterns can refer to struct types or
1217         // to struct variants within enums.
1218         let cmt = match opt_def {
1219             Some(def::DefVariant(enum_did, variant_did, _))
1220                 // univariant enums do not need downcasts
1221                 if !self.tcx().lookup_adt_def(enum_did).is_univariant() => {
1222                     self.cat_downcast(pat, cmt.clone(), cmt.ty, variant_did)
1223                 }
1224             _ => cmt
1225         };
1226
1227         match pat.node {
1228           hir::PatWild => {
1229             // _
1230           }
1231
1232           hir::PatEnum(_, None) => {
1233             // variant(..)
1234           }
1235           hir::PatEnum(_, Some(ref subpats)) => {
1236             match opt_def {
1237                 Some(def::DefVariant(..)) => {
1238                     // variant(x, y, z)
1239                     for (i, subpat) in subpats.iter().enumerate() {
1240                         let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1241
1242                         let subcmt =
1243                             self.cat_imm_interior(
1244                                 pat, cmt.clone(), subpat_ty,
1245                                 InteriorField(PositionalField(i)));
1246
1247                         try!(self.cat_pattern_(subcmt, &**subpat, op));
1248                     }
1249                 }
1250                 Some(def::DefStruct(..)) => {
1251                     for (i, subpat) in subpats.iter().enumerate() {
1252                         let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1253                         let cmt_field =
1254                             self.cat_imm_interior(
1255                                 pat, cmt.clone(), subpat_ty,
1256                                 InteriorField(PositionalField(i)));
1257                         try!(self.cat_pattern_(cmt_field, &**subpat, op));
1258                     }
1259                 }
1260                 Some(def::DefConst(..)) | Some(def::DefAssociatedConst(..)) => {
1261                     for subpat in subpats {
1262                         try!(self.cat_pattern_(cmt.clone(), &**subpat, op));
1263                     }
1264                 }
1265                 _ => {
1266                     self.tcx().sess.span_bug(
1267                         pat.span,
1268                         "enum pattern didn't resolve to enum or struct");
1269                 }
1270             }
1271           }
1272
1273           hir::PatQPath(..) => {
1274               // Lone constant: ignore
1275           }
1276
1277           hir::PatIdent(_, _, Some(ref subpat)) => {
1278               try!(self.cat_pattern_(cmt, &**subpat, op));
1279           }
1280
1281           hir::PatIdent(_, _, None) => {
1282               // nullary variant or identifier: ignore
1283           }
1284
1285           hir::PatStruct(_, ref field_pats, _) => {
1286             // {f1: p1, ..., fN: pN}
1287             for fp in field_pats {
1288                 let field_ty = try!(self.pat_ty(&*fp.node.pat)); // see (*2)
1289                 let cmt_field = self.cat_field(pat, cmt.clone(), fp.node.name, field_ty);
1290                 try!(self.cat_pattern_(cmt_field, &*fp.node.pat, op));
1291             }
1292           }
1293
1294           hir::PatTup(ref subpats) => {
1295             // (p1, ..., pN)
1296             for (i, subpat) in subpats.iter().enumerate() {
1297                 let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1298                 let subcmt =
1299                     self.cat_imm_interior(
1300                         pat, cmt.clone(), subpat_ty,
1301                         InteriorField(PositionalField(i)));
1302                 try!(self.cat_pattern_(subcmt, &**subpat, op));
1303             }
1304           }
1305
1306           hir::PatBox(ref subpat) | hir::PatRegion(ref subpat, _) => {
1307             // box p1, &p1, &mut p1.  we can ignore the mutability of
1308             // PatRegion since that information is already contained
1309             // in the type.
1310             let subcmt = try!(self.cat_deref(pat, cmt, 0, None));
1311               try!(self.cat_pattern_(subcmt, &**subpat, op));
1312           }
1313
1314           hir::PatVec(ref before, ref slice, ref after) => {
1315               let context = InteriorOffsetKind::Pattern;
1316               let vec_cmt = try!(self.deref_vec(pat, cmt, context));
1317               let elt_cmt = try!(self.cat_index(pat, vec_cmt, context));
1318               for before_pat in before {
1319                   try!(self.cat_pattern_(elt_cmt.clone(), &**before_pat, op));
1320               }
1321               if let Some(ref slice_pat) = *slice {
1322                   let slice_ty = try!(self.pat_ty(&**slice_pat));
1323                   let slice_cmt = self.cat_rvalue_node(pat.id(), pat.span(), slice_ty);
1324                   try!(self.cat_pattern_(slice_cmt, &**slice_pat, op));
1325               }
1326               for after_pat in after {
1327                   try!(self.cat_pattern_(elt_cmt.clone(), &**after_pat, op));
1328               }
1329           }
1330
1331           hir::PatLit(_) | hir::PatRange(_, _) => {
1332               /*always ok*/
1333           }
1334         }
1335
1336         Ok(())
1337     }
1338
1339     fn overloaded_method_return_ty(&self,
1340                                    method_ty: Ty<'tcx>)
1341                                    -> Ty<'tcx>
1342     {
1343         // When we process an overloaded `*` or `[]` etc, we often
1344         // need to extract the return type of the method. These method
1345         // types are generated by method resolution and always have
1346         // all late-bound regions fully instantiated, so we just want
1347         // to skip past the binder.
1348         self.tcx().no_late_bound_regions(&method_ty.fn_ret())
1349            .unwrap()
1350            .unwrap() // overloaded ops do not diverge, either
1351     }
1352 }
1353
1354 #[derive(Clone, Debug)]
1355 pub enum Aliasability {
1356     FreelyAliasable(AliasableReason),
1357     NonAliasable,
1358     ImmutableUnique(Box<Aliasability>),
1359 }
1360
1361 #[derive(Copy, Clone, Debug)]
1362 pub enum AliasableReason {
1363     AliasableBorrowed,
1364     AliasableClosure(ast::NodeId), // Aliasable due to capture Fn closure env
1365     AliasableOther,
1366     UnaliasableImmutable, // Created as needed upon seeing ImmutableUnique
1367     AliasableStatic,
1368     AliasableStaticMut,
1369 }
1370
1371 impl<'tcx> cmt_<'tcx> {
1372     pub fn guarantor(&self) -> cmt<'tcx> {
1373         //! Returns `self` after stripping away any derefs or
1374         //! interior content. The return value is basically the `cmt` which
1375         //! determines how long the value in `self` remains live.
1376
1377         match self.cat {
1378             Categorization::Rvalue(..) |
1379             Categorization::StaticItem |
1380             Categorization::Local(..) |
1381             Categorization::Deref(_, _, UnsafePtr(..)) |
1382             Categorization::Deref(_, _, BorrowedPtr(..)) |
1383             Categorization::Deref(_, _, Implicit(..)) |
1384             Categorization::Upvar(..) => {
1385                 Rc::new((*self).clone())
1386             }
1387             Categorization::Downcast(ref b, _) |
1388             Categorization::Interior(ref b, _) |
1389             Categorization::Deref(ref b, _, Unique) => {
1390                 b.guarantor()
1391             }
1392         }
1393     }
1394
1395     /// Returns `FreelyAliasable(_)` if this lvalue represents a freely aliasable pointer type.
1396     pub fn freely_aliasable(&self, ctxt: &ty::ctxt<'tcx>)
1397                             -> Aliasability {
1398         // Maybe non-obvious: copied upvars can only be considered
1399         // non-aliasable in once closures, since any other kind can be
1400         // aliased and eventually recused.
1401
1402         match self.cat {
1403             Categorization::Deref(ref b, _, BorrowedPtr(ty::MutBorrow, _)) |
1404             Categorization::Deref(ref b, _, Implicit(ty::MutBorrow, _)) |
1405             Categorization::Deref(ref b, _, BorrowedPtr(ty::UniqueImmBorrow, _)) |
1406             Categorization::Deref(ref b, _, Implicit(ty::UniqueImmBorrow, _)) |
1407             Categorization::Downcast(ref b, _) |
1408             Categorization::Interior(ref b, _) => {
1409                 // Aliasability depends on base cmt
1410                 b.freely_aliasable(ctxt)
1411             }
1412
1413             Categorization::Deref(ref b, _, Unique) => {
1414                 let sub = b.freely_aliasable(ctxt);
1415                 if b.mutbl.is_mutable() {
1416                     // Aliasability depends on base cmt alone
1417                     sub
1418                 } else {
1419                     // Do not allow mutation through an immutable box.
1420                     ImmutableUnique(Box::new(sub))
1421                 }
1422             }
1423
1424             Categorization::Rvalue(..) |
1425             Categorization::Local(..) |
1426             Categorization::Upvar(..) |
1427             Categorization::Deref(_, _, UnsafePtr(..)) => { // yes, it's aliasable, but...
1428                 NonAliasable
1429             }
1430
1431             Categorization::StaticItem => {
1432                 if self.mutbl.is_mutable() {
1433                     FreelyAliasable(AliasableStaticMut)
1434                 } else {
1435                     FreelyAliasable(AliasableStatic)
1436                 }
1437             }
1438
1439             Categorization::Deref(ref base, _, BorrowedPtr(ty::ImmBorrow, _)) |
1440             Categorization::Deref(ref base, _, Implicit(ty::ImmBorrow, _)) => {
1441                 match base.cat {
1442                     Categorization::Upvar(Upvar{ id, .. }) =>
1443                         FreelyAliasable(AliasableClosure(id.closure_expr_id)),
1444                     _ => FreelyAliasable(AliasableBorrowed)
1445                 }
1446             }
1447         }
1448     }
1449
1450     // Digs down through one or two layers of deref and grabs the cmt
1451     // for the upvar if a note indicates there is one.
1452     pub fn upvar(&self) -> Option<cmt<'tcx>> {
1453         match self.note {
1454             NoteClosureEnv(..) | NoteUpvarRef(..) => {
1455                 Some(match self.cat {
1456                     Categorization::Deref(ref inner, _, _) => {
1457                         match inner.cat {
1458                             Categorization::Deref(ref inner, _, _) => inner.clone(),
1459                             Categorization::Upvar(..) => inner.clone(),
1460                             _ => unreachable!()
1461                         }
1462                     }
1463                     _ => unreachable!()
1464                 })
1465             }
1466             NoteNone => None
1467         }
1468     }
1469
1470
1471     pub fn descriptive_string(&self, tcx: &ty::ctxt) -> String {
1472         match self.cat {
1473             Categorization::StaticItem => {
1474                 "static item".to_string()
1475             }
1476             Categorization::Rvalue(..) => {
1477                 "non-lvalue".to_string()
1478             }
1479             Categorization::Local(vid) => {
1480                 if tcx.map.is_argument(vid) {
1481                     "argument".to_string()
1482                 } else {
1483                     "local variable".to_string()
1484                 }
1485             }
1486             Categorization::Deref(_, _, pk) => {
1487                 let upvar = self.upvar();
1488                 match upvar.as_ref().map(|i| &i.cat) {
1489                     Some(&Categorization::Upvar(ref var)) => {
1490                         var.to_string()
1491                     }
1492                     Some(_) => unreachable!(),
1493                     None => {
1494                         match pk {
1495                             Implicit(..) => {
1496                                 format!("indexed content")
1497                             }
1498                             Unique => {
1499                                 format!("`Box` content")
1500                             }
1501                             UnsafePtr(..) => {
1502                                 format!("dereference of raw pointer")
1503                             }
1504                             BorrowedPtr(..) => {
1505                                 format!("borrowed content")
1506                             }
1507                         }
1508                     }
1509                 }
1510             }
1511             Categorization::Interior(_, InteriorField(NamedField(_))) => {
1512                 "field".to_string()
1513             }
1514             Categorization::Interior(_, InteriorField(PositionalField(_))) => {
1515                 "anonymous field".to_string()
1516             }
1517             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Index,
1518                                                         VecElement)) |
1519             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Index,
1520                                                         OtherElement)) => {
1521                 "indexed content".to_string()
1522             }
1523             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Pattern,
1524                                                         VecElement)) |
1525             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Pattern,
1526                                                         OtherElement)) => {
1527                 "pattern-bound indexed content".to_string()
1528             }
1529             Categorization::Upvar(ref var) => {
1530                 var.to_string()
1531             }
1532             Categorization::Downcast(ref cmt, _) => {
1533                 cmt.descriptive_string(tcx)
1534             }
1535         }
1536     }
1537 }
1538
1539 impl<'tcx> fmt::Debug for cmt_<'tcx> {
1540     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1541         write!(f, "{{{:?} id:{} m:{:?} ty:{:?}}}",
1542                self.cat,
1543                self.id,
1544                self.mutbl,
1545                self.ty)
1546     }
1547 }
1548
1549 impl<'tcx> fmt::Debug for Categorization<'tcx> {
1550     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1551         match *self {
1552             Categorization::StaticItem => write!(f, "static"),
1553             Categorization::Rvalue(r) => write!(f, "rvalue({:?})", r),
1554             Categorization::Local(id) => {
1555                let name = ty::tls::with(|tcx| tcx.local_var_name_str(id));
1556                write!(f, "local({})", name)
1557             }
1558             Categorization::Upvar(upvar) => {
1559                 write!(f, "upvar({:?})", upvar)
1560             }
1561             Categorization::Deref(ref cmt, derefs, ptr) => {
1562                 write!(f, "{:?}-{:?}{}->", cmt.cat, ptr, derefs)
1563             }
1564             Categorization::Interior(ref cmt, interior) => {
1565                 write!(f, "{:?}.{:?}", cmt.cat, interior)
1566             }
1567             Categorization::Downcast(ref cmt, _) => {
1568                 write!(f, "{:?}->(enum)", cmt.cat)
1569             }
1570         }
1571     }
1572 }
1573
1574 pub fn ptr_sigil(ptr: PointerKind) -> &'static str {
1575     match ptr {
1576         Unique => "Box",
1577         BorrowedPtr(ty::ImmBorrow, _) |
1578         Implicit(ty::ImmBorrow, _) => "&",
1579         BorrowedPtr(ty::MutBorrow, _) |
1580         Implicit(ty::MutBorrow, _) => "&mut",
1581         BorrowedPtr(ty::UniqueImmBorrow, _) |
1582         Implicit(ty::UniqueImmBorrow, _) => "&unique",
1583         UnsafePtr(_) => "*",
1584     }
1585 }
1586
1587 impl fmt::Debug for PointerKind {
1588     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1589         match *self {
1590             Unique => write!(f, "Box"),
1591             BorrowedPtr(ty::ImmBorrow, ref r) |
1592             Implicit(ty::ImmBorrow, ref r) => {
1593                 write!(f, "&{:?}", r)
1594             }
1595             BorrowedPtr(ty::MutBorrow, ref r) |
1596             Implicit(ty::MutBorrow, ref r) => {
1597                 write!(f, "&{:?} mut", r)
1598             }
1599             BorrowedPtr(ty::UniqueImmBorrow, ref r) |
1600             Implicit(ty::UniqueImmBorrow, ref r) => {
1601                 write!(f, "&{:?} uniq", r)
1602             }
1603             UnsafePtr(_) => write!(f, "*")
1604         }
1605     }
1606 }
1607
1608 impl fmt::Debug for InteriorKind {
1609     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1610         match *self {
1611             InteriorField(NamedField(fld)) => write!(f, "{}", fld),
1612             InteriorField(PositionalField(i)) => write!(f, "#{}", i),
1613             InteriorElement(..) => write!(f, "[]"),
1614         }
1615     }
1616 }
1617
1618 fn element_kind(t: Ty) -> ElementKind {
1619     match t.sty {
1620         ty::TyRef(_, ty::TypeAndMut{ty, ..}) |
1621         ty::TyBox(ty) => match ty.sty {
1622             ty::TySlice(_) => VecElement,
1623             _ => OtherElement
1624         },
1625         ty::TyArray(..) | ty::TySlice(_) => VecElement,
1626         _ => OtherElement
1627     }
1628 }
1629
1630 impl fmt::Debug for Upvar {
1631     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1632         write!(f, "{:?}/{:?}", self.id, self.kind)
1633     }
1634 }
1635
1636 impl fmt::Display for Upvar {
1637     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1638         let kind = match self.kind {
1639             ty::FnClosureKind => "Fn",
1640             ty::FnMutClosureKind => "FnMut",
1641             ty::FnOnceClosureKind => "FnOnce",
1642         };
1643         write!(f, "captured outer variable in an `{}` closure", kind)
1644     }
1645 }