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(_) |
 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           def::DefErr => panic!("DefErr in memory categorization")
 618         }
 619     }
 620
 621     // Categorize an upvar, complete with invisible derefs of closure
 622     // environment and upvar reference as appropriate.
 623     fn cat_upvar(&self,
 624                  id: ast::NodeId,
 625                  span: Span,
 626                  var_id: ast::NodeId,
 627                  fn_node_id: ast::NodeId,
 628                  kind: ty::ClosureKind)
 629                  -> McResult<cmt<'tcx>>
 630     {
 631         // An upvar can have up to 3 components. We translate first to a
 632         // `Categorization::Upvar`, which is itself a fiction -- it represents the reference to the
 633         // field from the environment.
 634         //
 635         // `Categorization::Upvar`.  Next, we add a deref through the implicit
 636         // environment pointer with an anonymous free region 'env and
 637         // appropriate borrow kind for closure kinds that take self by
 638         // reference.  Finally, if the upvar was captured
 639         // by-reference, we add a deref through that reference.  The
 640         // region of this reference is an inference variable 'up that
 641         // was previously generated and recorded in the upvar borrow
 642         // map.  The borrow kind bk is inferred by based on how the
 643         // upvar is used.
 644         //
 645         // This results in the following table for concrete closure
 646         // types:
 647         //
 648         //                | move                 | ref
 649         // ---------------+----------------------+-------------------------------
 650         // Fn             | copied -> &'env      | upvar -> &'env -> &'up bk
 651         // FnMut          | copied -> &'env mut  | upvar -> &'env mut -> &'up bk
 652         // FnOnce         | copied               | upvar -> &'up bk
 653
 654         let upvar_id = ty::UpvarId { var_id: var_id,
 655                                      closure_expr_id: fn_node_id };
 656         let var_ty = try!(self.node_ty(var_id));
 657
 658         // Mutability of original variable itself
 659         let var_mutbl = MutabilityCategory::from_local(self.tcx(), var_id);
 660
 661         // Construct the upvar. This represents access to the field
 662         // from the environment (perhaps we should eventually desugar
 663         // this field further, but it will do for now).
 664         let cmt_result = cmt_ {
 665             id: id,
 666             span: span,
 667             cat: Categorization::Upvar(Upvar {id: upvar_id, kind: kind}),
 668             mutbl: var_mutbl,
 669             ty: var_ty,
 670             note: NoteNone
 671         };
 672
 673         // If this is a `FnMut` or `Fn` closure, then the above is
 674         // conceptually a `&mut` or `&` reference, so we have to add a
 675         // deref.
 676         let cmt_result = match kind {
 677             ty::FnOnceClosureKind => {
 678                 cmt_result
 679             }
 680             ty::FnMutClosureKind => {
 681                 self.env_deref(id, span, upvar_id, var_mutbl, ty::MutBorrow, cmt_result)
 682             }
 683             ty::FnClosureKind => {
 684                 self.env_deref(id, span, upvar_id, var_mutbl, ty::ImmBorrow, cmt_result)
 685             }
 686         };
 687
 688         // If this is a by-ref capture, then the upvar we loaded is
 689         // actually a reference, so we have to add an implicit deref
 690         // for that.
 691         let upvar_id = ty::UpvarId { var_id: var_id,
 692                                      closure_expr_id: fn_node_id };
 693         let upvar_capture = self.typer.upvar_capture(upvar_id).unwrap();
 694         let cmt_result = match upvar_capture {
 695             ty::UpvarCapture::ByValue => {
 696                 cmt_result
 697             }
 698             ty::UpvarCapture::ByRef(upvar_borrow) => {
 699                 let ptr = BorrowedPtr(upvar_borrow.kind, upvar_borrow.region);
 700                 cmt_ {
 701                     id: id,
 702                     span: span,
 703                     cat: Categorization::Deref(Rc::new(cmt_result), 0, ptr),
 704                     mutbl: MutabilityCategory::from_borrow_kind(upvar_borrow.kind),
 705                     ty: var_ty,
 706                     note: NoteUpvarRef(upvar_id)
 707                 }
 708             }
 709         };
 710
 711         let ret = Rc::new(cmt_result);
 712         debug!("cat_upvar ret={:?}", ret);
 713         Ok(ret)
 714     }
 715
 716     fn env_deref(&self,
 717                  id: ast::NodeId,
 718                  span: Span,
 719                  upvar_id: ty::UpvarId,
 720                  upvar_mutbl: MutabilityCategory,
 721                  env_borrow_kind: ty::BorrowKind,
 722                  cmt_result: cmt_<'tcx>)
 723                  -> cmt_<'tcx>
 724     {
 725         // Look up the node ID of the closure body so we can construct
 726         // a free region within it
 727         let fn_body_id = {
 728             let fn_expr = match self.tcx().map.find(upvar_id.closure_expr_id) {
 729                 Some(ast_map::NodeExpr(e)) => e,
 730                 _ => unreachable!()
 731             };
 732
 733             match fn_expr.node {
 734                 hir::ExprClosure(_, _, ref body) => body.id,
 735                 _ => unreachable!()
 736             }
 737         };
 738
 739         // Region of environment pointer
 740         let env_region = ty::ReFree(ty::FreeRegion {
 741             // The environment of a closure is guaranteed to
 742             // outlive any bindings introduced in the body of the
 743             // closure itself.
 744             scope: self.tcx().region_maps.item_extent(fn_body_id),
 745             bound_region: ty::BrEnv
 746         });
 747
 748         let env_ptr = BorrowedPtr(env_borrow_kind, env_region);
 749
 750         let var_ty = cmt_result.ty;
 751
 752         // We need to add the env deref.  This means
 753         // that the above is actually immutable and
 754         // has a ref type.  However, nothing should
 755         // actually look at the type, so we can get
 756         // away with stuffing a `TyError` in there
 757         // instead of bothering to construct a proper
 758         // one.
 759         let cmt_result = cmt_ {
 760             mutbl: McImmutable,
 761             ty: self.tcx().types.err,
 762             ..cmt_result
 763         };
 764
 765         let mut deref_mutbl = MutabilityCategory::from_borrow_kind(env_borrow_kind);
 766
 767         // Issue #18335. If variable is declared as immutable, override the
 768         // mutability from the environment and substitute an `&T` anyway.
 769         match upvar_mutbl {
 770             McImmutable => { deref_mutbl = McImmutable; }
 771             McDeclared | McInherited => { }
 772         }
 773
 774         let ret = cmt_ {
 775             id: id,
 776             span: span,
 777             cat: Categorization::Deref(Rc::new(cmt_result), 0, env_ptr),
 778             mutbl: deref_mutbl,
 779             ty: var_ty,
 780             note: NoteClosureEnv(upvar_id)
 781         };
 782
 783         debug!("env_deref ret {:?}", ret);
 784
 785         ret
 786     }
 787
 788     /// Returns the lifetime of a temporary created by expr with id `id`.
 789     /// This could be `'static` if `id` is part of a constant expression.
 790     pub fn temporary_scope(&self, id: ast::NodeId) -> ty::Region {
 791         match self.typer.temporary_scope(id) {
 792             Some(scope) => ty::ReScope(scope),
 793             None => ty::ReStatic
 794         }
 795     }
 796
 797     pub fn cat_rvalue_node(&self,
 798                            id: ast::NodeId,
 799                            span: Span,
 800                            expr_ty: Ty<'tcx>)
 801                            -> cmt<'tcx> {
 802         let qualif = self.tcx().const_qualif_map.borrow().get(&id).cloned()
 803                                .unwrap_or(check_const::ConstQualif::NOT_CONST);
 804
 805         // Only promote `[T; 0]` before an RFC for rvalue promotions
 806         // is accepted.
 807         let qualif = match expr_ty.sty {
 808             ty::TyArray(_, 0) => qualif,
 809             _ => check_const::ConstQualif::NOT_CONST
 810         };
 811
 812         // Compute maximum lifetime of this rvalue. This is 'static if
 813         // we can promote to a constant, otherwise equal to enclosing temp
 814         // lifetime.
 815         let re = if qualif.intersects(check_const::ConstQualif::NON_STATIC_BORROWS) {
 816             self.temporary_scope(id)
 817         } else {
 818             ty::ReStatic
 819         };
 820         let ret = self.cat_rvalue(id, span, re, expr_ty);
 821         debug!("cat_rvalue_node ret {:?}", ret);
 822         ret
 823     }
 824
 825     pub fn cat_rvalue(&self,
 826                       cmt_id: ast::NodeId,
 827                       span: Span,
 828                       temp_scope: ty::Region,
 829                       expr_ty: Ty<'tcx>) -> cmt<'tcx> {
 830         let ret = Rc::new(cmt_ {
 831             id:cmt_id,
 832             span:span,
 833             cat:Categorization::Rvalue(temp_scope),
 834             mutbl:McDeclared,
 835             ty:expr_ty,
 836             note: NoteNone
 837         });
 838         debug!("cat_rvalue ret {:?}", ret);
 839         ret
 840     }
 841
 842     pub fn cat_field<N:ast_node>(&self,
 843                                  node: &N,
 844                                  base_cmt: cmt<'tcx>,
 845                                  f_name: ast::Name,
 846                                  f_ty: Ty<'tcx>)
 847                                  -> cmt<'tcx> {
 848         let ret = Rc::new(cmt_ {
 849             id: node.id(),
 850             span: node.span(),
 851             mutbl: base_cmt.mutbl.inherit(),
 852             cat: Categorization::Interior(base_cmt, InteriorField(NamedField(f_name))),
 853             ty: f_ty,
 854             note: NoteNone
 855         });
 856         debug!("cat_field ret {:?}", ret);
 857         ret
 858     }
 859
 860     pub fn cat_tup_field<N:ast_node>(&self,
 861                                      node: &N,
 862                                      base_cmt: cmt<'tcx>,
 863                                      f_idx: usize,
 864                                      f_ty: Ty<'tcx>)
 865                                      -> cmt<'tcx> {
 866         let ret = Rc::new(cmt_ {
 867             id: node.id(),
 868             span: node.span(),
 869             mutbl: base_cmt.mutbl.inherit(),
 870             cat: Categorization::Interior(base_cmt, InteriorField(PositionalField(f_idx))),
 871             ty: f_ty,
 872             note: NoteNone
 873         });
 874         debug!("cat_tup_field ret {:?}", ret);
 875         ret
 876     }
 877
 878     fn cat_deref<N:ast_node>(&self,
 879                              node: &N,
 880                              base_cmt: cmt<'tcx>,
 881                              deref_cnt: usize,
 882                              deref_context: DerefKindContext)
 883                              -> McResult<cmt<'tcx>> {
 884         let method_call = ty::MethodCall {
 885             expr_id: node.id(),
 886             autoderef: deref_cnt as u32
 887         };
 888         let method_ty = self.typer.node_method_ty(method_call);
 889
 890         debug!("cat_deref: method_call={:?} method_ty={:?}",
 891                method_call, method_ty.map(|ty| ty));
 892
 893         let base_cmt = match method_ty {
 894             Some(method_ty) => {
 895                 let ref_ty =
 896                     self.tcx().no_late_bound_regions(&method_ty.fn_ret()).unwrap().unwrap();
 897                 self.cat_rvalue_node(node.id(), node.span(), ref_ty)
 898             }
 899             None => base_cmt
 900         };
 901         let base_cmt_ty = base_cmt.ty;
 902         match base_cmt_ty.builtin_deref(true, ty::NoPreference) {
 903             Some(mt) => {
 904                 let ret = self.cat_deref_common(node, base_cmt, deref_cnt,
 905                                               mt.ty,
 906                                               deref_context,
 907                                                 /* implicit: */ false);
 908                 debug!("cat_deref ret {:?}", ret);
 909                 ret
 910             }
 911             None => {
 912                 debug!("Explicit deref of non-derefable type: {:?}",
 913                        base_cmt_ty);
 914                 return Err(());
 915             }
 916         }
 917     }
 918
 919     fn cat_deref_common<N:ast_node>(&self,
 920                                     node: &N,
 921                                     base_cmt: cmt<'tcx>,
 922                                     deref_cnt: usize,
 923                                     deref_ty: Ty<'tcx>,
 924                                     deref_context: DerefKindContext,
 925                                     implicit: bool)
 926                                     -> McResult<cmt<'tcx>>
 927     {
 928         let (m, cat) = match try!(deref_kind(base_cmt.ty, deref_context)) {
 929             deref_ptr(ptr) => {
 930                 let ptr = if implicit {
 931                     match ptr {
 932                         BorrowedPtr(bk, r) => Implicit(bk, r),
 933                         _ => self.tcx().sess.span_bug(node.span(),
 934                             "Implicit deref of non-borrowed pointer")
 935                     }
 936                 } else {
 937                     ptr
 938                 };
 939                 // for unique ptrs, we inherit mutability from the
 940                 // owning reference.
 941                 (MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr),
 942                  Categorization::Deref(base_cmt, deref_cnt, ptr))
 943             }
 944             deref_interior(interior) => {
 945                 (base_cmt.mutbl.inherit(), Categorization::Interior(base_cmt, interior))
 946             }
 947         };
 948         let ret = Rc::new(cmt_ {
 949             id: node.id(),
 950             span: node.span(),
 951             cat: cat,
 952             mutbl: m,
 953             ty: deref_ty,
 954             note: NoteNone
 955         });
 956         debug!("cat_deref_common ret {:?}", ret);
 957         Ok(ret)
 958     }
 959
 960     pub fn cat_index<N:ast_node>(&self,
 961                                  elt: &N,
 962                                  mut base_cmt: cmt<'tcx>,
 963                                  context: InteriorOffsetKind)
 964                                  -> McResult<cmt<'tcx>> {
 965         //! Creates a cmt for an indexing operation (`[]`).
 966         //!
 967         //! One subtle aspect of indexing that may not be
 968         //! immediately obvious: for anything other than a fixed-length
 969         //! vector, an operation like `x[y]` actually consists of two
 970         //! disjoint (from the point of view of borrowck) operations.
 971         //! The first is a deref of `x` to create a pointer `p` that points
 972         //! at the first element in the array. The second operation is
 973         //! an index which adds `y*sizeof(T)` to `p` to obtain the
 974         //! pointer to `x[y]`. `cat_index` will produce a resulting
 975         //! cmt containing both this deref and the indexing,
 976         //! presuming that `base_cmt` is not of fixed-length type.
 977         //!
 978         //! # Parameters
 979         //! - `elt`: the AST node being indexed
 980         //! - `base_cmt`: the cmt of `elt`
 981
 982         let method_call = ty::MethodCall::expr(elt.id());
 983         let method_ty = self.typer.node_method_ty(method_call);
 984
 985         let element_ty = match method_ty {
 986             Some(method_ty) => {
 987                 let ref_ty = self.overloaded_method_return_ty(method_ty);
 988                 base_cmt = self.cat_rvalue_node(elt.id(), elt.span(), ref_ty);
 989
 990                 // FIXME(#20649) -- why are we using the `self_ty` as the element type...?
 991                 let self_ty = method_ty.fn_sig().input(0);
 992                 self.tcx().no_late_bound_regions(&self_ty).unwrap()
 993             }
 994             None => {
 995                 match base_cmt.ty.builtin_index() {
 996                     Some(ty) => ty,
 997                     None => {
 998                         return Err(());
 999                     }
1000                 }
1001             }
1002         };
1003
1004         let m = base_cmt.mutbl.inherit();
1005         let ret = interior(elt, base_cmt.clone(), base_cmt.ty,
1006                            m, context, element_ty);
1007         debug!("cat_index ret {:?}", ret);
1008         return Ok(ret);
1009
1010         fn interior<'tcx, N: ast_node>(elt: &N,
1011                                        of_cmt: cmt<'tcx>,
1012                                        vec_ty: Ty<'tcx>,
1013                                        mutbl: MutabilityCategory,
1014                                        context: InteriorOffsetKind,
1015                                        element_ty: Ty<'tcx>) -> cmt<'tcx>
1016         {
1017             let interior_elem = InteriorElement(context, element_kind(vec_ty));
1018             Rc::new(cmt_ {
1019                 id:elt.id(),
1020                 span:elt.span(),
1021                 cat:Categorization::Interior(of_cmt, interior_elem),
1022                 mutbl:mutbl,
1023                 ty:element_ty,
1024                 note: NoteNone
1025             })
1026         }
1027     }
1028
1029     // Takes either a vec or a reference to a vec and returns the cmt for the
1030     // underlying vec.
1031     fn deref_vec<N:ast_node>(&self,
1032                              elt: &N,
1033                              base_cmt: cmt<'tcx>,
1034                              context: InteriorOffsetKind)
1035                              -> McResult<cmt<'tcx>>
1036     {
1037         let ret = match try!(deref_kind(base_cmt.ty, Some(context))) {
1038             deref_ptr(ptr) => {
1039                 // for unique ptrs, we inherit mutability from the
1040                 // owning reference.
1041                 let m = MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr);
1042
1043                 // the deref is explicit in the resulting cmt
1044                 Rc::new(cmt_ {
1045                     id:elt.id(),
1046                     span:elt.span(),
1047                     cat:Categorization::Deref(base_cmt.clone(), 0, ptr),
1048                     mutbl:m,
1049                     ty: match base_cmt.ty.builtin_deref(false, ty::NoPreference) {
1050                         Some(mt) => mt.ty,
1051                         None => self.tcx().sess.bug("Found non-derefable type")
1052                     },
1053                     note: NoteNone
1054                 })
1055             }
1056
1057             deref_interior(_) => {
1058                 base_cmt
1059             }
1060         };
1061         debug!("deref_vec ret {:?}", ret);
1062         Ok(ret)
1063     }
1064
1065     /// Given a pattern P like: `[_, ..Q, _]`, where `vec_cmt` is the cmt for `P`, `slice_pat` is
1066     /// the pattern `Q`, returns:
1067     ///
1068     /// * a cmt for `Q`
1069     /// * the mutability and region of the slice `Q`
1070     ///
1071     /// These last two bits of info happen to be things that borrowck needs.
1072     pub fn cat_slice_pattern(&self,
1073                              vec_cmt: cmt<'tcx>,
1074                              slice_pat: &hir::Pat)
1075                              -> McResult<(cmt<'tcx>, hir::Mutability, ty::Region)> {
1076         let slice_ty = try!(self.node_ty(slice_pat.id));
1077         let (slice_mutbl, slice_r) = vec_slice_info(self.tcx(),
1078                                                     slice_pat,
1079                                                     slice_ty);
1080         let context = InteriorOffsetKind::Pattern;
1081         let cmt_vec = try!(self.deref_vec(slice_pat, vec_cmt, context));
1082         let cmt_slice = try!(self.cat_index(slice_pat, cmt_vec, context));
1083         return Ok((cmt_slice, slice_mutbl, slice_r));
1084
1085         /// In a pattern like [a, b, ..c], normally `c` has slice type, but if you have [a, b,
1086         /// ..ref c], then the type of `ref c` will be `&&[]`, so to extract the slice details we
1087         /// have to recurse through rptrs.
1088         fn vec_slice_info(tcx: &ty::ctxt,
1089                           pat: &hir::Pat,
1090                           slice_ty: Ty)
1091                           -> (hir::Mutability, ty::Region) {
1092             match slice_ty.sty {
1093                 ty::TyRef(r, ref mt) => match mt.ty.sty {
1094                     ty::TySlice(_) => (mt.mutbl, *r),
1095                     _ => vec_slice_info(tcx, pat, mt.ty),
1096                 },
1097
1098                 _ => {
1099                     tcx.sess.span_bug(pat.span,
1100                                       "type of slice pattern is not a slice");
1101                 }
1102             }
1103         }
1104     }
1105
1106     pub fn cat_imm_interior<N:ast_node>(&self,
1107                                         node: &N,
1108                                         base_cmt: cmt<'tcx>,
1109                                         interior_ty: Ty<'tcx>,
1110                                         interior: InteriorKind)
1111                                         -> cmt<'tcx> {
1112         let ret = Rc::new(cmt_ {
1113             id: node.id(),
1114             span: node.span(),
1115             mutbl: base_cmt.mutbl.inherit(),
1116             cat: Categorization::Interior(base_cmt, interior),
1117             ty: interior_ty,
1118             note: NoteNone
1119         });
1120         debug!("cat_imm_interior ret={:?}", ret);
1121         ret
1122     }
1123
1124     pub fn cat_downcast<N:ast_node>(&self,
1125                                     node: &N,
1126                                     base_cmt: cmt<'tcx>,
1127                                     downcast_ty: Ty<'tcx>,
1128                                     variant_did: DefId)
1129                                     -> cmt<'tcx> {
1130         let ret = Rc::new(cmt_ {
1131             id: node.id(),
1132             span: node.span(),
1133             mutbl: base_cmt.mutbl.inherit(),
1134             cat: Categorization::Downcast(base_cmt, variant_did),
1135             ty: downcast_ty,
1136             note: NoteNone
1137         });
1138         debug!("cat_downcast ret={:?}", ret);
1139         ret
1140     }
1141
1142     pub fn cat_pattern<F>(&self, cmt: cmt<'tcx>, pat: &hir::Pat, mut op: F) -> McResult<()>
1143         where F: FnMut(&MemCategorizationContext<'t, 'a, 'tcx>, cmt<'tcx>, &hir::Pat),
1144     {
1145         self.cat_pattern_(cmt, pat, &mut op)
1146     }
1147
1148     // FIXME(#19596) This is a workaround, but there should be a better way to do this
1149     fn cat_pattern_<F>(&self, cmt: cmt<'tcx>, pat: &hir::Pat, op: &mut F)
1150                        -> McResult<()>
1151         where F : FnMut(&MemCategorizationContext<'t, 'a, 'tcx>, cmt<'tcx>, &hir::Pat),
1152     {
1153         // Here, `cmt` is the categorization for the value being
1154         // matched and pat is the pattern it is being matched against.
1155         //
1156         // In general, the way that this works is that we walk down
1157         // the pattern, constructing a cmt that represents the path
1158         // that will be taken to reach the value being matched.
1159         //
1160         // When we encounter named bindings, we take the cmt that has
1161         // been built up and pass it off to guarantee_valid() so that
1162         // we can be sure that the binding will remain valid for the
1163         // duration of the arm.
1164         //
1165         // (*2) There is subtlety concerning the correspondence between
1166         // pattern ids and types as compared to *expression* ids and
1167         // types. This is explained briefly. on the definition of the
1168         // type `cmt`, so go off and read what it says there, then
1169         // come back and I'll dive into a bit more detail here. :) OK,
1170         // back?
1171         //
1172         // In general, the id of the cmt should be the node that
1173         // "produces" the value---patterns aren't executable code
1174         // exactly, but I consider them to "execute" when they match a
1175         // value, and I consider them to produce the value that was
1176         // matched. So if you have something like:
1177         //
1178         //     let x = @@3;
1179         //     match x {
1180         //       @@y { ... }
1181         //     }
1182         //
1183         // In this case, the cmt and the relevant ids would be:
1184         //
1185         //     CMT             Id                  Type of Id Type of cmt
1186         //
1187         //     local(x)->@->@
1188         //     ^~~~~~~^        `x` from discr      @@int      @@int
1189         //     ^~~~~~~~~~^     `@@y` pattern node  @@int      @int
1190         //     ^~~~~~~~~~~~~^  `@y` pattern node   @int       int
1191         //
1192         // You can see that the types of the id and the cmt are in
1193         // sync in the first line, because that id is actually the id
1194         // of an expression. But once we get to pattern ids, the types
1195         // step out of sync again. So you'll see below that we always
1196         // get the type of the *subpattern* and use that.
1197
1198         debug!("cat_pattern: {:?} cmt={:?}",
1199                pat,
1200                cmt);
1201
1202         (*op)(self, cmt.clone(), pat);
1203
1204         let opt_def = if let Some(path_res) = self.tcx().def_map.borrow().get(&pat.id) {
1205             if path_res.depth != 0 || path_res.base_def == def::DefErr {
1206                 // Since patterns can be associated constants
1207                 // which are resolved during typeck, we might have
1208                 // some unresolved patterns reaching this stage
1209                 // without aborting
1210                 return Err(());
1211             }
1212             Some(path_res.full_def())
1213         } else {
1214             None
1215         };
1216
1217         // Note: This goes up here (rather than within the PatEnum arm
1218         // alone) because struct patterns can refer to struct types or
1219         // to struct variants within enums.
1220         let cmt = match opt_def {
1221             Some(def::DefVariant(enum_did, variant_did, _))
1222                 // univariant enums do not need downcasts
1223                 if !self.tcx().lookup_adt_def(enum_did).is_univariant() => {
1224                     self.cat_downcast(pat, cmt.clone(), cmt.ty, variant_did)
1225                 }
1226             _ => cmt
1227         };
1228
1229         match pat.node {
1230           hir::PatWild => {
1231             // _
1232           }
1233
1234           hir::PatEnum(_, None) => {
1235             // variant(..)
1236           }
1237           hir::PatEnum(_, Some(ref subpats)) => {
1238             match opt_def {
1239                 Some(def::DefVariant(..)) => {
1240                     // variant(x, y, z)
1241                     for (i, subpat) in subpats.iter().enumerate() {
1242                         let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1243
1244                         let subcmt =
1245                             self.cat_imm_interior(
1246                                 pat, cmt.clone(), subpat_ty,
1247                                 InteriorField(PositionalField(i)));
1248
1249                         try!(self.cat_pattern_(subcmt, &**subpat, op));
1250                     }
1251                 }
1252                 Some(def::DefStruct(..)) => {
1253                     for (i, subpat) in subpats.iter().enumerate() {
1254                         let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1255                         let cmt_field =
1256                             self.cat_imm_interior(
1257                                 pat, cmt.clone(), subpat_ty,
1258                                 InteriorField(PositionalField(i)));
1259                         try!(self.cat_pattern_(cmt_field, &**subpat, op));
1260                     }
1261                 }
1262                 Some(def::DefConst(..)) | Some(def::DefAssociatedConst(..)) => {
1263                     for subpat in subpats {
1264                         try!(self.cat_pattern_(cmt.clone(), &**subpat, op));
1265                     }
1266                 }
1267                 _ => {
1268                     self.tcx().sess.span_bug(
1269                         pat.span,
1270                         &format!("enum pattern didn't resolve to enum or struct {:?}", opt_def));
1271                 }
1272             }
1273           }
1274
1275           hir::PatQPath(..) => {
1276               // Lone constant: ignore
1277           }
1278
1279           hir::PatIdent(_, _, Some(ref subpat)) => {
1280               try!(self.cat_pattern_(cmt, &**subpat, op));
1281           }
1282
1283           hir::PatIdent(_, _, None) => {
1284               // nullary variant or identifier: ignore
1285           }
1286
1287           hir::PatStruct(_, ref field_pats, _) => {
1288             // {f1: p1, ..., fN: pN}
1289             for fp in field_pats {
1290                 let field_ty = try!(self.pat_ty(&*fp.node.pat)); // see (*2)
1291                 let cmt_field = self.cat_field(pat, cmt.clone(), fp.node.name, field_ty);
1292                 try!(self.cat_pattern_(cmt_field, &*fp.node.pat, op));
1293             }
1294           }
1295
1296           hir::PatTup(ref subpats) => {
1297             // (p1, ..., pN)
1298             for (i, subpat) in subpats.iter().enumerate() {
1299                 let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1300                 let subcmt =
1301                     self.cat_imm_interior(
1302                         pat, cmt.clone(), subpat_ty,
1303                         InteriorField(PositionalField(i)));
1304                 try!(self.cat_pattern_(subcmt, &**subpat, op));
1305             }
1306           }
1307
1308           hir::PatBox(ref subpat) | hir::PatRegion(ref subpat, _) => {
1309             // box p1, &p1, &mut p1.  we can ignore the mutability of
1310             // PatRegion since that information is already contained
1311             // in the type.
1312             let subcmt = try!(self.cat_deref(pat, cmt, 0, None));
1313               try!(self.cat_pattern_(subcmt, &**subpat, op));
1314           }
1315
1316           hir::PatVec(ref before, ref slice, ref after) => {
1317               let context = InteriorOffsetKind::Pattern;
1318               let vec_cmt = try!(self.deref_vec(pat, cmt, context));
1319               let elt_cmt = try!(self.cat_index(pat, vec_cmt, context));
1320               for before_pat in before {
1321                   try!(self.cat_pattern_(elt_cmt.clone(), &**before_pat, op));
1322               }
1323               if let Some(ref slice_pat) = *slice {
1324                   let slice_ty = try!(self.pat_ty(&**slice_pat));
1325                   let slice_cmt = self.cat_rvalue_node(pat.id(), pat.span(), slice_ty);
1326                   try!(self.cat_pattern_(slice_cmt, &**slice_pat, op));
1327               }
1328               for after_pat in after {
1329                   try!(self.cat_pattern_(elt_cmt.clone(), &**after_pat, op));
1330               }
1331           }
1332
1333           hir::PatLit(_) | hir::PatRange(_, _) => {
1334               /*always ok*/
1335           }
1336         }
1337
1338         Ok(())
1339     }
1340
1341     fn overloaded_method_return_ty(&self,
1342                                    method_ty: Ty<'tcx>)
1343                                    -> Ty<'tcx>
1344     {
1345         // When we process an overloaded `*` or `[]` etc, we often
1346         // need to extract the return type of the method. These method
1347         // types are generated by method resolution and always have
1348         // all late-bound regions fully instantiated, so we just want
1349         // to skip past the binder.
1350         self.tcx().no_late_bound_regions(&method_ty.fn_ret())
1351            .unwrap()
1352            .unwrap() // overloaded ops do not diverge, either
1353     }
1354 }
1355
1356 #[derive(Clone, Debug)]
1357 pub enum Aliasability {
1358     FreelyAliasable(AliasableReason),
1359     NonAliasable,
1360     ImmutableUnique(Box<Aliasability>),
1361 }
1362
1363 #[derive(Copy, Clone, Debug)]
1364 pub enum AliasableReason {
1365     AliasableBorrowed,
1366     AliasableClosure(ast::NodeId), // Aliasable due to capture Fn closure env
1367     AliasableOther,
1368     UnaliasableImmutable, // Created as needed upon seeing ImmutableUnique
1369     AliasableStatic,
1370     AliasableStaticMut,
1371 }
1372
1373 impl<'tcx> cmt_<'tcx> {
1374     pub fn guarantor(&self) -> cmt<'tcx> {
1375         //! Returns `self` after stripping away any derefs or
1376         //! interior content. The return value is basically the `cmt` which
1377         //! determines how long the value in `self` remains live.
1378
1379         match self.cat {
1380             Categorization::Rvalue(..) |
1381             Categorization::StaticItem |
1382             Categorization::Local(..) |
1383             Categorization::Deref(_, _, UnsafePtr(..)) |
1384             Categorization::Deref(_, _, BorrowedPtr(..)) |
1385             Categorization::Deref(_, _, Implicit(..)) |
1386             Categorization::Upvar(..) => {
1387                 Rc::new((*self).clone())
1388             }
1389             Categorization::Downcast(ref b, _) |
1390             Categorization::Interior(ref b, _) |
1391             Categorization::Deref(ref b, _, Unique) => {
1392                 b.guarantor()
1393             }
1394         }
1395     }
1396
1397     /// Returns `FreelyAliasable(_)` if this lvalue represents a freely aliasable pointer type.
1398     pub fn freely_aliasable(&self, ctxt: &ty::ctxt<'tcx>)
1399                             -> Aliasability {
1400         // Maybe non-obvious: copied upvars can only be considered
1401         // non-aliasable in once closures, since any other kind can be
1402         // aliased and eventually recused.
1403
1404         match self.cat {
1405             Categorization::Deref(ref b, _, BorrowedPtr(ty::MutBorrow, _)) |
1406             Categorization::Deref(ref b, _, Implicit(ty::MutBorrow, _)) |
1407             Categorization::Deref(ref b, _, BorrowedPtr(ty::UniqueImmBorrow, _)) |
1408             Categorization::Deref(ref b, _, Implicit(ty::UniqueImmBorrow, _)) |
1409             Categorization::Downcast(ref b, _) |
1410             Categorization::Interior(ref b, _) => {
1411                 // Aliasability depends on base cmt
1412                 b.freely_aliasable(ctxt)
1413             }
1414
1415             Categorization::Deref(ref b, _, Unique) => {
1416                 let sub = b.freely_aliasable(ctxt);
1417                 if b.mutbl.is_mutable() {
1418                     // Aliasability depends on base cmt alone
1419                     sub
1420                 } else {
1421                     // Do not allow mutation through an immutable box.
1422                     ImmutableUnique(Box::new(sub))
1423                 }
1424             }
1425
1426             Categorization::Rvalue(..) |
1427             Categorization::Local(..) |
1428             Categorization::Upvar(..) |
1429             Categorization::Deref(_, _, UnsafePtr(..)) => { // yes, it's aliasable, but...
1430                 NonAliasable
1431             }
1432
1433             Categorization::StaticItem => {
1434                 if self.mutbl.is_mutable() {
1435                     FreelyAliasable(AliasableStaticMut)
1436                 } else {
1437                     FreelyAliasable(AliasableStatic)
1438                 }
1439             }
1440
1441             Categorization::Deref(ref base, _, BorrowedPtr(ty::ImmBorrow, _)) |
1442             Categorization::Deref(ref base, _, Implicit(ty::ImmBorrow, _)) => {
1443                 match base.cat {
1444                     Categorization::Upvar(Upvar{ id, .. }) =>
1445                         FreelyAliasable(AliasableClosure(id.closure_expr_id)),
1446                     _ => FreelyAliasable(AliasableBorrowed)
1447                 }
1448             }
1449         }
1450     }
1451
1452     // Digs down through one or two layers of deref and grabs the cmt
1453     // for the upvar if a note indicates there is one.
1454     pub fn upvar(&self) -> Option<cmt<'tcx>> {
1455         match self.note {
1456             NoteClosureEnv(..) | NoteUpvarRef(..) => {
1457                 Some(match self.cat {
1458                     Categorization::Deref(ref inner, _, _) => {
1459                         match inner.cat {
1460                             Categorization::Deref(ref inner, _, _) => inner.clone(),
1461                             Categorization::Upvar(..) => inner.clone(),
1462                             _ => unreachable!()
1463                         }
1464                     }
1465                     _ => unreachable!()
1466                 })
1467             }
1468             NoteNone => None
1469         }
1470     }
1471
1472
1473     pub fn descriptive_string(&self, tcx: &ty::ctxt) -> String {
1474         match self.cat {
1475             Categorization::StaticItem => {
1476                 "static item".to_string()
1477             }
1478             Categorization::Rvalue(..) => {
1479                 "non-lvalue".to_string()
1480             }
1481             Categorization::Local(vid) => {
1482                 if tcx.map.is_argument(vid) {
1483                     "argument".to_string()
1484                 } else {
1485                     "local variable".to_string()
1486                 }
1487             }
1488             Categorization::Deref(_, _, pk) => {
1489                 let upvar = self.upvar();
1490                 match upvar.as_ref().map(|i| &i.cat) {
1491                     Some(&Categorization::Upvar(ref var)) => {
1492                         var.to_string()
1493                     }
1494                     Some(_) => unreachable!(),
1495                     None => {
1496                         match pk {
1497                             Implicit(..) => {
1498                                 format!("indexed content")
1499                             }
1500                             Unique => {
1501                                 format!("`Box` content")
1502                             }
1503                             UnsafePtr(..) => {
1504                                 format!("dereference of raw pointer")
1505                             }
1506                             BorrowedPtr(..) => {
1507                                 format!("borrowed content")
1508                             }
1509                         }
1510                     }
1511                 }
1512             }
1513             Categorization::Interior(_, InteriorField(NamedField(_))) => {
1514                 "field".to_string()
1515             }
1516             Categorization::Interior(_, InteriorField(PositionalField(_))) => {
1517                 "anonymous field".to_string()
1518             }
1519             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Index,
1520                                                         VecElement)) |
1521             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Index,
1522                                                         OtherElement)) => {
1523                 "indexed content".to_string()
1524             }
1525             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Pattern,
1526                                                         VecElement)) |
1527             Categorization::Interior(_, InteriorElement(InteriorOffsetKind::Pattern,
1528                                                         OtherElement)) => {
1529                 "pattern-bound indexed content".to_string()
1530             }
1531             Categorization::Upvar(ref var) => {
1532                 var.to_string()
1533             }
1534             Categorization::Downcast(ref cmt, _) => {
1535                 cmt.descriptive_string(tcx)
1536             }
1537         }
1538     }
1539 }
1540
1541 impl<'tcx> fmt::Debug for cmt_<'tcx> {
1542     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1543         write!(f, "{{{:?} id:{} m:{:?} ty:{:?}}}",
1544                self.cat,
1545                self.id,
1546                self.mutbl,
1547                self.ty)
1548     }
1549 }
1550
1551 impl<'tcx> fmt::Debug for Categorization<'tcx> {
1552     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1553         match *self {
1554             Categorization::StaticItem => write!(f, "static"),
1555             Categorization::Rvalue(r) => write!(f, "rvalue({:?})", r),
1556             Categorization::Local(id) => {
1557                let name = ty::tls::with(|tcx| tcx.local_var_name_str(id));
1558                write!(f, "local({})", name)
1559             }
1560             Categorization::Upvar(upvar) => {
1561                 write!(f, "upvar({:?})", upvar)
1562             }
1563             Categorization::Deref(ref cmt, derefs, ptr) => {
1564                 write!(f, "{:?}-{:?}{}->", cmt.cat, ptr, derefs)
1565             }
1566             Categorization::Interior(ref cmt, interior) => {
1567                 write!(f, "{:?}.{:?}", cmt.cat, interior)
1568             }
1569             Categorization::Downcast(ref cmt, _) => {
1570                 write!(f, "{:?}->(enum)", cmt.cat)
1571             }
1572         }
1573     }
1574 }
1575
1576 pub fn ptr_sigil(ptr: PointerKind) -> &'static str {
1577     match ptr {
1578         Unique => "Box",
1579         BorrowedPtr(ty::ImmBorrow, _) |
1580         Implicit(ty::ImmBorrow, _) => "&",
1581         BorrowedPtr(ty::MutBorrow, _) |
1582         Implicit(ty::MutBorrow, _) => "&mut",
1583         BorrowedPtr(ty::UniqueImmBorrow, _) |
1584         Implicit(ty::UniqueImmBorrow, _) => "&unique",
1585         UnsafePtr(_) => "*",
1586     }
1587 }
1588
1589 impl fmt::Debug for PointerKind {
1590     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1591         match *self {
1592             Unique => write!(f, "Box"),
1593             BorrowedPtr(ty::ImmBorrow, ref r) |
1594             Implicit(ty::ImmBorrow, ref r) => {
1595                 write!(f, "&{:?}", r)
1596             }
1597             BorrowedPtr(ty::MutBorrow, ref r) |
1598             Implicit(ty::MutBorrow, ref r) => {
1599                 write!(f, "&{:?} mut", r)
1600             }
1601             BorrowedPtr(ty::UniqueImmBorrow, ref r) |
1602             Implicit(ty::UniqueImmBorrow, ref r) => {
1603                 write!(f, "&{:?} uniq", r)
1604             }
1605             UnsafePtr(_) => write!(f, "*")
1606         }
1607     }
1608 }
1609
1610 impl fmt::Debug for InteriorKind {
1611     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1612         match *self {
1613             InteriorField(NamedField(fld)) => write!(f, "{}", fld),
1614             InteriorField(PositionalField(i)) => write!(f, "#{}", i),
1615             InteriorElement(..) => write!(f, "[]"),
1616         }
1617     }
1618 }
1619
1620 fn element_kind(t: Ty) -> ElementKind {
1621     match t.sty {
1622         ty::TyRef(_, ty::TypeAndMut{ty, ..}) |
1623         ty::TyBox(ty) => match ty.sty {
1624             ty::TySlice(_) => VecElement,
1625             _ => OtherElement
1626         },
1627         ty::TyArray(..) | ty::TySlice(_) => VecElement,
1628         _ => OtherElement
1629     }
1630 }
1631
1632 impl fmt::Debug for Upvar {
1633     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1634         write!(f, "{:?}/{:?}", self.id, self.kind)
1635     }
1636 }
1637
1638 impl fmt::Display for Upvar {
1639     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1640         let kind = match self.kind {
1641             ty::FnClosureKind => "Fn",
1642             ty::FnMutClosureKind => "FnMut",
1643             ty::FnOnceClosureKind => "FnOnce",
1644         };
1645         write!(f, "captured outer variable in an `{}` closure", kind)
1646     }
1647 }