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 /*!
  12  * # Categorization
  13  *
  14  * The job of the categorization module is to analyze an expression to
  15  * determine what kind of memory is used in evaluating it (for example,
  16  * where dereferences occur and what kind of pointer is dereferenced;
  17  * whether the memory is mutable; etc)
  18  *
  19  * Categorization effectively transforms all of our expressions into
  20  * expressions of the following forms (the actual enum has many more
  21  * possibilities, naturally, but they are all variants of these base
  22  * forms):
  23  *
  24  *     E = rvalue    // some computed rvalue
  25  *       | x         // address of a local variable or argument
  26  *       | *E        // deref of a ptr
  27  *       | E.comp    // access to an interior component
  28  *
  29  * Imagine a routine ToAddr(Expr) that evaluates an expression and returns an
  30  * address where the result is to be found.  If Expr is an lvalue, then this
  31  * is the address of the lvalue.  If Expr is an rvalue, this is the address of
  32  * some temporary spot in memory where the result is stored.
  33  *
  34  * Now, cat_expr() classifies the expression Expr and the address A=ToAddr(Expr)
  35  * as follows:
  36  *
  37  * - cat: what kind of expression was this?  This is a subset of the
  38  *   full expression forms which only includes those that we care about
  39  *   for the purpose of the analysis.
  40  * - mutbl: mutability of the address A
  41  * - ty: the type of data found at the address A
  42  *
  43  * The resulting categorization tree differs somewhat from the expressions
  44  * themselves.  For example, auto-derefs are explicit.  Also, an index a[b] is
  45  * decomposed into two operations: a dereference to reach the array data and
  46  * then an index to jump forward to the relevant item.
  47  *
  48  * ## By-reference upvars
  49  *
  50  * One part of the translation which may be non-obvious is that we translate
  51  * closure upvars into the dereference of a borrowed pointer; this more closely
  52  * resembles the runtime translation. So, for example, if we had:
  53  *
  54  *     let mut x = 3;
  55  *     let y = 5;
  56  *     let inc = || x += y;
  57  *
  58  * Then when we categorize `x` (*within* the closure) we would yield a
  59  * result of `*x'`, effectively, where `x'` is a `cat_upvar` reference
  60  * tied to `x`. The type of `x'` will be a borrowed pointer.
  61  */
  62
  63 #![allow(non_camel_case_types)]
  64
  65 use middle::def;
  66 use middle::ty;
  67 use middle::typeck;
  68 use util::nodemap::{DefIdMap, NodeMap};
  69 use util::ppaux::{ty_to_string, Repr};
  70
  71 use syntax::ast::{MutImmutable, MutMutable};
  72 use syntax::ast;
  73 use syntax::ast_map;
  74 use syntax::codemap::Span;
  75 use syntax::print::pprust;
  76 use syntax::parse::token;
  77
  78 use std::cell::RefCell;
  79 use std::rc::Rc;
  80
  81 #[deriving(Clone, PartialEq)]
  82 pub enum categorization {
  83     cat_rvalue(ty::Region),            // temporary val, argument is its scope
  84     cat_static_item,
  85     cat_copied_upvar(CopiedUpvar),     // upvar copied into proc env
  86     cat_upvar(ty::UpvarId, ty::UpvarBorrow), // by ref upvar from stack closure
  87     cat_local(ast::NodeId),            // local variable
  88     cat_deref(cmt, uint, PointerKind), // deref of a ptr
  89     cat_interior(cmt, InteriorKind),   // something interior: field, tuple, etc
  90     cat_downcast(cmt),                 // selects a particular enum variant (*1)
  91     cat_discr(cmt, ast::NodeId),       // match discriminant (see preserve())
  92
  93     // (*1) downcast is only required if the enum has more than one variant
  94 }
  95
  96 #[deriving(Clone, PartialEq)]
  97 pub struct CopiedUpvar {
  98     pub upvar_id: ast::NodeId,
  99     pub onceness: ast::Onceness,
 100     pub capturing_proc: ast::NodeId,
 101 }
 102
 103 // different kinds of pointers:
 104 #[deriving(Clone, PartialEq, Eq, Hash)]
 105 pub enum PointerKind {
 106     OwnedPtr,
 107     GcPtr,
 108     BorrowedPtr(ty::BorrowKind, ty::Region),
 109     Implicit(ty::BorrowKind, ty::Region),     // Implicit deref of a borrowed ptr.
 110     UnsafePtr(ast::Mutability)
 111 }
 112
 113 // We use the term "interior" to mean "something reachable from the
 114 // base without a pointer dereference", e.g. a field
 115 #[deriving(Clone, PartialEq, Eq, Hash)]
 116 pub enum InteriorKind {
 117     InteriorField(FieldName),
 118     InteriorElement(ElementKind),
 119 }
 120
 121 #[deriving(Clone, PartialEq, Eq, Hash)]
 122 pub enum FieldName {
 123     NamedField(ast::Name),
 124     PositionalField(uint)
 125 }
 126
 127 #[deriving(Clone, PartialEq, Eq, Hash)]
 128 pub enum ElementKind {
 129     VecElement,
 130     OtherElement,
 131 }
 132
 133 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 134 pub enum MutabilityCategory {
 135     McImmutable, // Immutable.
 136     McDeclared,  // Directly declared as mutable.
 137     McInherited, // Inherited from the fact that owner is mutable.
 138 }
 139
 140 // `cmt`: "Category, Mutability, and Type".
 141 //
 142 // a complete categorization of a value indicating where it originated
 143 // and how it is located, as well as the mutability of the memory in
 144 // which the value is stored.
 145 //
 146 // *WARNING* The field `cmt.type` is NOT necessarily the same as the
 147 // result of `node_id_to_type(cmt.id)`. This is because the `id` is
 148 // always the `id` of the node producing the type; in an expression
 149 // like `*x`, the type of this deref node is the deref'd type (`T`),
 150 // but in a pattern like `@x`, the `@x` pattern is again a
 151 // dereference, but its type is the type *before* the dereference
 152 // (`@T`). So use `cmt.ty` to find the type of the value in a consistent
 153 // fashion. For more details, see the method `cat_pattern`
 154 #[deriving(Clone, PartialEq)]
 155 pub struct cmt_ {
 156     pub id: ast::NodeId,          // id of expr/pat producing this value
 157     pub span: Span,                // span of same expr/pat
 158     pub cat: categorization,       // categorization of expr
 159     pub mutbl: MutabilityCategory, // mutability of expr as lvalue
 160     pub ty: ty::t                  // type of the expr (*see WARNING above*)
 161 }
 162
 163 pub type cmt = Rc<cmt_>;
 164
 165 // We pun on *T to mean both actual deref of a ptr as well
 166 // as accessing of components:
 167 pub enum deref_kind {
 168     deref_ptr(PointerKind),
 169     deref_interior(InteriorKind),
 170 }
 171
 172 // Categorizes a derefable type.  Note that we include vectors and strings as
 173 // derefable (we model an index as the combination of a deref and then a
 174 // pointer adjustment).
 175 pub fn opt_deref_kind(t: ty::t) -> Option<deref_kind> {
 176     match ty::get(t).sty {
 177         ty::ty_uniq(_) |
 178         ty::ty_closure(box ty::ClosureTy {store: ty::UniqTraitStore, ..}) => {
 179             Some(deref_ptr(OwnedPtr))
 180         }
 181
 182         ty::ty_rptr(r, mt) => {
 183             let kind = ty::BorrowKind::from_mutbl(mt.mutbl);
 184             Some(deref_ptr(BorrowedPtr(kind, r)))
 185         }
 186
 187         ty::ty_closure(box ty::ClosureTy {
 188                 store: ty::RegionTraitStore(r, _),
 189                 ..
 190             }) => {
 191             Some(deref_ptr(BorrowedPtr(ty::ImmBorrow, r)))
 192         }
 193
 194         ty::ty_box(..) => {
 195             Some(deref_ptr(GcPtr))
 196         }
 197
 198         ty::ty_ptr(ref mt) => {
 199             Some(deref_ptr(UnsafePtr(mt.mutbl)))
 200         }
 201
 202         ty::ty_enum(..) |
 203         ty::ty_struct(..) => { // newtype
 204             Some(deref_interior(InteriorField(PositionalField(0))))
 205         }
 206
 207         ty::ty_vec(_, _) | ty::ty_str => {
 208             Some(deref_interior(InteriorElement(element_kind(t))))
 209         }
 210
 211         _ => None
 212     }
 213 }
 214
 215 pub fn deref_kind(tcx: &ty::ctxt, t: ty::t) -> deref_kind {
 216     debug!("deref_kind {}", ty_to_string(tcx, t));
 217     match opt_deref_kind(t) {
 218       Some(k) => k,
 219       None => {
 220         tcx.sess.bug(
 221             format!("deref_kind() invoked on non-derefable type {}",
 222                     ty_to_string(tcx, t)).as_slice());
 223       }
 224     }
 225 }
 226
 227 trait ast_node {
 228     fn id(&self) -> ast::NodeId;
 229     fn span(&self) -> Span;
 230 }
 231
 232 impl ast_node for ast::Expr {
 233     fn id(&self) -> ast::NodeId { self.id }
 234     fn span(&self) -> Span { self.span }
 235 }
 236
 237 impl ast_node for ast::Pat {
 238     fn id(&self) -> ast::NodeId { self.id }
 239     fn span(&self) -> Span { self.span }
 240 }
 241
 242 pub struct MemCategorizationContext<'t,TYPER:'t> {
 243     typer: &'t TYPER
 244 }
 245
 246 pub type McResult<T> = Result<T, ()>;
 247
 248 /**
 249  * The `Typer` trait provides the interface for the mem-categorization
 250  * module to the results of the type check. It can be used to query
 251  * the type assigned to an expression node, to inquire after adjustments,
 252  * and so on.
 253  *
 254  * This interface is needed because mem-categorization is used from
 255  * two places: `regionck` and `borrowck`. `regionck` executes before
 256  * type inference is complete, and hence derives types and so on from
 257  * intermediate tables.  This also implies that type errors can occur,
 258  * and hence `node_ty()` and friends return a `Result` type -- any
 259  * error will propagate back up through the mem-categorization
 260  * routines.
 261  *
 262  * In the borrow checker, in contrast, type checking is complete and we
 263  * know that no errors have occurred, so we simply consult the tcx and we
 264  * can be sure that only `Ok` results will occur.
 265  */
 266 pub trait Typer<'tcx> {
 267     fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx>;
 268     fn node_ty(&self, id: ast::NodeId) -> McResult<ty::t>;
 269     fn node_method_ty(&self, method_call: typeck::MethodCall) -> Option<ty::t>;
 270     fn adjustments<'a>(&'a self) -> &'a RefCell<NodeMap<ty::AutoAdjustment>>;
 271     fn is_method_call(&self, id: ast::NodeId) -> bool;
 272     fn temporary_scope(&self, rvalue_id: ast::NodeId) -> Option<ast::NodeId>;
 273     fn upvar_borrow(&self, upvar_id: ty::UpvarId) -> ty::UpvarBorrow;
 274     fn capture_mode(&self, closure_expr_id: ast::NodeId)
 275                     -> ast::CaptureClause;
 276     fn unboxed_closures<'a>(&'a self)
 277                         -> &'a RefCell<DefIdMap<ty::UnboxedClosure>>;
 278 }
 279
 280 impl MutabilityCategory {
 281     pub fn from_mutbl(m: ast::Mutability) -> MutabilityCategory {
 282         match m {
 283             MutImmutable => McImmutable,
 284             MutMutable => McDeclared
 285         }
 286     }
 287
 288     pub fn from_borrow_kind(borrow_kind: ty::BorrowKind) -> MutabilityCategory {
 289         match borrow_kind {
 290             ty::ImmBorrow => McImmutable,
 291             ty::UniqueImmBorrow => McImmutable,
 292             ty::MutBorrow => McDeclared,
 293         }
 294     }
 295
 296     pub fn from_pointer_kind(base_mutbl: MutabilityCategory,
 297                              ptr: PointerKind) -> MutabilityCategory {
 298         match ptr {
 299             OwnedPtr => {
 300                 base_mutbl.inherit()
 301             }
 302             BorrowedPtr(borrow_kind, _) | Implicit(borrow_kind, _) => {
 303                 MutabilityCategory::from_borrow_kind(borrow_kind)
 304             }
 305             GcPtr => {
 306                 McImmutable
 307             }
 308             UnsafePtr(m) => {
 309                 MutabilityCategory::from_mutbl(m)
 310             }
 311         }
 312     }
 313
 314     fn from_local(tcx: &ty::ctxt, id: ast::NodeId) -> MutabilityCategory {
 315         match tcx.map.get(id) {
 316             ast_map::NodeLocal(p) | ast_map::NodeArg(p) => match p.node {
 317                 ast::PatIdent(bind_mode, _, _) => {
 318                     if bind_mode == ast::BindByValue(ast::MutMutable) {
 319                         McDeclared
 320                     } else {
 321                         McImmutable
 322                     }
 323                 }
 324                 _ => tcx.sess.span_bug(p.span, "expected identifier pattern")
 325             },
 326             _ => tcx.sess.span_bug(tcx.map.span(id), "expected identifier pattern")
 327         }
 328     }
 329
 330     pub fn inherit(&self) -> MutabilityCategory {
 331         match *self {
 332             McImmutable => McImmutable,
 333             McDeclared => McInherited,
 334             McInherited => McInherited,
 335         }
 336     }
 337
 338     pub fn is_mutable(&self) -> bool {
 339         match *self {
 340             McImmutable => false,
 341             McInherited => true,
 342             McDeclared => true,
 343         }
 344     }
 345
 346     pub fn is_immutable(&self) -> bool {
 347         match *self {
 348             McImmutable => true,
 349             McDeclared | McInherited => false
 350         }
 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 macro_rules! if_ok(
 362     ($inp: expr) => (
 363         match $inp {
 364             Ok(v) => { v }
 365             Err(e) => { return Err(e); }
 366         }
 367     )
 368 )
 369
 370 impl<'t,'tcx,TYPER:Typer<'tcx>> MemCategorizationContext<'t,TYPER> {
 371     pub fn new(typer: &'t TYPER) -> MemCategorizationContext<'t,TYPER> {
 372         MemCategorizationContext { typer: typer }
 373     }
 374
 375     fn tcx(&self) -> &'t ty::ctxt<'tcx> {
 376         self.typer.tcx()
 377     }
 378
 379     fn expr_ty(&self, expr: &ast::Expr) -> McResult<ty::t> {
 380         self.typer.node_ty(expr.id)
 381     }
 382
 383     fn expr_ty_adjusted(&self, expr: &ast::Expr) -> McResult<ty::t> {
 384         let unadjusted_ty = if_ok!(self.expr_ty(expr));
 385         Ok(ty::adjust_ty(self.tcx(), expr.span, expr.id, unadjusted_ty,
 386                          self.typer.adjustments().borrow().find(&expr.id),
 387                          |method_call| self.typer.node_method_ty(method_call)))
 388     }
 389
 390     fn node_ty(&self, id: ast::NodeId) -> McResult<ty::t> {
 391         self.typer.node_ty(id)
 392     }
 393
 394     fn pat_ty(&self, pat: &ast::Pat) -> McResult<ty::t> {
 395         self.typer.node_ty(pat.id)
 396     }
 397
 398     pub fn cat_expr(&self, expr: &ast::Expr) -> McResult<cmt> {
 399         match self.typer.adjustments().borrow().find(&expr.id) {
 400             None => {
 401                 // No adjustments.
 402                 self.cat_expr_unadjusted(expr)
 403             }
 404
 405             Some(adjustment) => {
 406                 match *adjustment {
 407                     ty::AdjustAddEnv(..) => {
 408                         // Convert a bare fn to a closure by adding NULL env.
 409                         // Result is an rvalue.
 410                         let expr_ty = if_ok!(self.expr_ty_adjusted(expr));
 411                         Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
 412                     }
 413
 414                     ty::AdjustDerefRef(
 415                         ty::AutoDerefRef {
 416                             autoref: Some(_), ..}) => {
 417                         // Equivalent to &*expr or something similar.
 418                         // Result is an rvalue.
 419                         let expr_ty = if_ok!(self.expr_ty_adjusted(expr));
 420                         Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
 421                     }
 422
 423                     ty::AdjustDerefRef(
 424                         ty::AutoDerefRef {
 425                             autoref: None, autoderefs: autoderefs}) => {
 426                         // Equivalent to *expr or something similar.
 427                         self.cat_expr_autoderefd(expr, autoderefs)
 428                     }
 429                 }
 430             }
 431         }
 432     }
 433
 434     pub fn cat_expr_autoderefd(&self,
 435                                expr: &ast::Expr,
 436                                autoderefs: uint)
 437                                -> McResult<cmt> {
 438         let mut cmt = if_ok!(self.cat_expr_unadjusted(expr));
 439         for deref in range(1u, autoderefs + 1) {
 440             cmt = self.cat_deref(expr, cmt, deref, false);
 441         }
 442         return Ok(cmt);
 443     }
 444
 445     pub fn cat_expr_unadjusted(&self, expr: &ast::Expr) -> McResult<cmt> {
 446         debug!("cat_expr: id={} expr={}", expr.id, expr.repr(self.tcx()));
 447
 448         let expr_ty = if_ok!(self.expr_ty(expr));
 449         match expr.node {
 450           ast::ExprUnary(ast::UnDeref, ref e_base) => {
 451             let base_cmt = if_ok!(self.cat_expr(&**e_base));
 452             Ok(self.cat_deref(expr, base_cmt, 0, false))
 453           }
 454
 455           ast::ExprField(ref base, f_name, _) => {
 456             let base_cmt = if_ok!(self.cat_expr(&**base));
 457             Ok(self.cat_field(expr, base_cmt, f_name.node, expr_ty))
 458           }
 459
 460           ast::ExprTupField(ref base, idx, _) => {
 461             let base_cmt = if_ok!(self.cat_expr(&**base));
 462             Ok(self.cat_tup_field(expr, base_cmt, idx.node, expr_ty))
 463           }
 464
 465           ast::ExprIndex(ref base, _) => {
 466             let method_call = typeck::MethodCall::expr(expr.id());
 467             match self.typer.node_method_ty(method_call) {
 468                 Some(method_ty) => {
 469                     // If this is an index implemented by a method call, then it will
 470                     // include an implicit deref of the result.
 471                     let ret_ty = ty::ty_fn_ret(method_ty);
 472                     Ok(self.cat_deref(expr,
 473                                       self.cat_rvalue_node(expr.id(),
 474                                                            expr.span(),
 475                                                            ret_ty), 1, true))
 476                 }
 477                 None => {
 478                     let base_cmt = if_ok!(self.cat_expr(&**base));
 479                     Ok(self.cat_index(expr, base_cmt))
 480                 }
 481             }
 482           }
 483
 484           ast::ExprPath(_) => {
 485             let def = *self.tcx().def_map.borrow().get(&expr.id);
 486             self.cat_def(expr.id, expr.span, expr_ty, def)
 487           }
 488
 489           ast::ExprParen(ref e) => {
 490             self.cat_expr(&**e)
 491           }
 492
 493           ast::ExprAddrOf(..) | ast::ExprCall(..) |
 494           ast::ExprAssign(..) | ast::ExprAssignOp(..) |
 495           ast::ExprFnBlock(..) | ast::ExprProc(..) |
 496           ast::ExprUnboxedFn(..) | ast::ExprRet(..) |
 497           ast::ExprUnary(..) | ast::ExprSlice(..) |
 498           ast::ExprMethodCall(..) | ast::ExprCast(..) |
 499           ast::ExprVec(..) | ast::ExprTup(..) | ast::ExprIf(..) |
 500           ast::ExprBinary(..) | ast::ExprWhile(..) |
 501           ast::ExprBlock(..) | ast::ExprLoop(..) | ast::ExprMatch(..) |
 502           ast::ExprLit(..) | ast::ExprBreak(..) | ast::ExprMac(..) |
 503           ast::ExprAgain(..) | ast::ExprStruct(..) | ast::ExprRepeat(..) |
 504           ast::ExprInlineAsm(..) | ast::ExprBox(..) |
 505           ast::ExprForLoop(..) => {
 506             Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
 507           }
 508         }
 509     }
 510
 511     pub fn cat_def(&self,
 512                    id: ast::NodeId,
 513                    span: Span,
 514                    expr_ty: ty::t,
 515                    def: def::Def)
 516                    -> McResult<cmt> {
 517         debug!("cat_def: id={} expr={} def={:?}",
 518                id, expr_ty.repr(self.tcx()), def);
 519
 520         match def {
 521           def::DefStruct(..) | def::DefVariant(..) | def::DefFn(..) |
 522           def::DefStaticMethod(..) => {
 523                 Ok(self.cat_rvalue_node(id, span, expr_ty))
 524           }
 525           def::DefMod(_) | def::DefForeignMod(_) | def::DefUse(_) |
 526           def::DefTrait(_) | def::DefTy(..) | def::DefPrimTy(_) |
 527           def::DefTyParam(..) | def::DefTyParamBinder(..) | def::DefRegion(_) |
 528           def::DefLabel(_) | def::DefSelfTy(..) | def::DefMethod(..) |
 529           def::DefAssociatedTy(..) => {
 530               Ok(Rc::new(cmt_ {
 531                   id:id,
 532                   span:span,
 533                   cat:cat_static_item,
 534                   mutbl: McImmutable,
 535                   ty:expr_ty
 536               }))
 537           }
 538
 539           def::DefStatic(_, mutbl) => {
 540               Ok(Rc::new(cmt_ {
 541                   id:id,
 542                   span:span,
 543                   cat:cat_static_item,
 544                   mutbl: if mutbl { McDeclared } else { McImmutable},
 545                   ty:expr_ty
 546               }))
 547           }
 548
 549           def::DefUpvar(var_id, fn_node_id, _) => {
 550               let ty = if_ok!(self.node_ty(fn_node_id));
 551               match ty::get(ty).sty {
 552                   ty::ty_closure(ref closure_ty) => {
 553                       // Decide whether to use implicit reference or by copy/move
 554                       // capture for the upvar. This, combined with the onceness,
 555                       // determines whether the closure can move out of it.
 556                       let var_is_refd = match (closure_ty.store, closure_ty.onceness) {
 557                           // Many-shot stack closures can never move out.
 558                           (ty::RegionTraitStore(..), ast::Many) => true,
 559                           // 1-shot stack closures can move out.
 560                           (ty::RegionTraitStore(..), ast::Once) => false,
 561                           // Heap closures always capture by copy/move, and can
 562                           // move out if they are once.
 563                           (ty::UniqTraitStore, _) => false,
 564
 565                       };
 566                       if var_is_refd {
 567                           self.cat_upvar(id, span, var_id, fn_node_id)
 568                       } else {
 569                           Ok(Rc::new(cmt_ {
 570                               id:id,
 571                               span:span,
 572                               cat:cat_copied_upvar(CopiedUpvar {
 573                                   upvar_id: var_id,
 574                                   onceness: closure_ty.onceness,
 575                                   capturing_proc: fn_node_id,
 576                               }),
 577                               mutbl: MutabilityCategory::from_local(self.tcx(), var_id),
 578                               ty:expr_ty
 579                           }))
 580                       }
 581                   }
 582                   ty::ty_unboxed_closure(closure_id, _) => {
 583                       let unboxed_closures = self.typer
 584                                                  .unboxed_closures()
 585                                                  .borrow();
 586                       let kind = unboxed_closures.get(&closure_id).kind;
 587                       let onceness = match kind {
 588                           ty::FnUnboxedClosureKind |
 589                           ty::FnMutUnboxedClosureKind => ast::Many,
 590                           ty::FnOnceUnboxedClosureKind => ast::Once,
 591                       };
 592                       Ok(Rc::new(cmt_ {
 593                           id: id,
 594                           span: span,
 595                           cat: cat_copied_upvar(CopiedUpvar {
 596                               upvar_id: var_id,
 597                               onceness: onceness,
 598                               capturing_proc: fn_node_id,
 599                           }),
 600                           mutbl: MutabilityCategory::from_local(self.tcx(), var_id),
 601                           ty: expr_ty
 602                       }))
 603                   }
 604                   _ => {
 605                       self.tcx().sess.span_bug(
 606                           span,
 607                           format!("Upvar of non-closure {} - {}",
 608                                   fn_node_id,
 609                                   ty.repr(self.tcx())).as_slice());
 610                   }
 611               }
 612           }
 613
 614           def::DefLocal(vid) => {
 615             Ok(Rc::new(cmt_ {
 616                 id: id,
 617                 span: span,
 618                 cat: cat_local(vid),
 619                 mutbl: MutabilityCategory::from_local(self.tcx(), vid),
 620                 ty: expr_ty
 621             }))
 622           }
 623         }
 624     }
 625
 626     fn cat_upvar(&self,
 627                  id: ast::NodeId,
 628                  span: Span,
 629                  var_id: ast::NodeId,
 630                  fn_node_id: ast::NodeId)
 631                  -> McResult<cmt> {
 632         /*!
 633          * Upvars through a closure are in fact indirect
 634          * references. That is, when a closure refers to a
 635          * variable from a parent stack frame like `x = 10`,
 636          * that is equivalent to `*x_ = 10` where `x_` is a
 637          * borrowed pointer (`&mut x`) created when the closure
 638          * was created and store in the environment. This
 639          * equivalence is expose in the mem-categorization.
 640          */
 641
 642         let upvar_id = ty::UpvarId { var_id: var_id,
 643                                      closure_expr_id: fn_node_id };
 644
 645         let upvar_borrow = self.typer.upvar_borrow(upvar_id);
 646
 647         let var_ty = if_ok!(self.node_ty(var_id));
 648
 649         // We can't actually represent the types of all upvars
 650         // as user-describable types, since upvars support const
 651         // and unique-imm borrows! Therefore, we cheat, and just
 652         // give err type. Nobody should be inspecting this type anyhow.
 653         let upvar_ty = ty::mk_err();
 654
 655         let base_cmt = Rc::new(cmt_ {
 656             id:id,
 657             span:span,
 658             cat:cat_upvar(upvar_id, upvar_borrow),
 659             mutbl:McImmutable,
 660             ty:upvar_ty,
 661         });
 662
 663         let ptr = BorrowedPtr(upvar_borrow.kind, upvar_borrow.region);
 664
 665         let deref_cmt = Rc::new(cmt_ {
 666             id:id,
 667             span:span,
 668             cat:cat_deref(base_cmt, 0, ptr),
 669             mutbl:MutabilityCategory::from_borrow_kind(upvar_borrow.kind),
 670             ty:var_ty,
 671         });
 672
 673         Ok(deref_cmt)
 674     }
 675
 676     pub fn cat_rvalue_node(&self,
 677                            id: ast::NodeId,
 678                            span: Span,
 679                            expr_ty: ty::t)
 680                            -> cmt {
 681         match self.typer.temporary_scope(id) {
 682             Some(scope) => {
 683                 match ty::get(expr_ty).sty {
 684                     ty::ty_vec(_, Some(0)) => self.cat_rvalue(id, span, ty::ReStatic, expr_ty),
 685                     _ => self.cat_rvalue(id, span, ty::ReScope(scope), expr_ty)
 686                 }
 687             }
 688             None => {
 689                 self.cat_rvalue(id, span, ty::ReStatic, expr_ty)
 690             }
 691         }
 692     }
 693
 694     pub fn cat_rvalue(&self,
 695                       cmt_id: ast::NodeId,
 696                       span: Span,
 697                       temp_scope: ty::Region,
 698                       expr_ty: ty::t) -> cmt {
 699         Rc::new(cmt_ {
 700             id:cmt_id,
 701             span:span,
 702             cat:cat_rvalue(temp_scope),
 703             mutbl:McDeclared,
 704             ty:expr_ty
 705         })
 706     }
 707
 708     pub fn cat_field<N:ast_node>(&self,
 709                                  node: &N,
 710                                  base_cmt: cmt,
 711                                  f_name: ast::Ident,
 712                                  f_ty: ty::t)
 713                                  -> cmt {
 714         Rc::new(cmt_ {
 715             id: node.id(),
 716             span: node.span(),
 717             mutbl: base_cmt.mutbl.inherit(),
 718             cat: cat_interior(base_cmt, InteriorField(NamedField(f_name.name))),
 719             ty: f_ty
 720         })
 721     }
 722
 723     pub fn cat_tup_field<N:ast_node>(&self,
 724                                      node: &N,
 725                                      base_cmt: cmt,
 726                                      f_idx: uint,
 727                                      f_ty: ty::t)
 728                                      -> cmt {
 729         Rc::new(cmt_ {
 730             id: node.id(),
 731             span: node.span(),
 732             mutbl: base_cmt.mutbl.inherit(),
 733             cat: cat_interior(base_cmt, InteriorField(PositionalField(f_idx))),
 734             ty: f_ty
 735         })
 736     }
 737
 738     pub fn cat_deref_obj<N:ast_node>(&self, node: &N, base_cmt: cmt) -> cmt {
 739         self.cat_deref_common(node, base_cmt, 0, ty::mk_nil(), false)
 740     }
 741
 742     fn cat_deref<N:ast_node>(&self,
 743                              node: &N,
 744                              base_cmt: cmt,
 745                              deref_cnt: uint,
 746                              implicit: bool)
 747                              -> cmt {
 748         let adjustment = match self.typer.adjustments().borrow().find(&node.id()) {
 749             Some(adj) if ty::adjust_is_object(adj) => typeck::AutoObject,
 750             _ if deref_cnt != 0 => typeck::AutoDeref(deref_cnt),
 751             _ => typeck::NoAdjustment
 752         };
 753
 754         let method_call = typeck::MethodCall {
 755             expr_id: node.id(),
 756             adjustment: adjustment
 757         };
 758         let method_ty = self.typer.node_method_ty(method_call);
 759
 760         debug!("cat_deref: method_call={:?} method_ty={}",
 761             method_call, method_ty.map(|ty| ty.repr(self.tcx())));
 762
 763         let base_cmt = match method_ty {
 764             Some(method_ty) => {
 765                 let ref_ty = ty::ty_fn_ret(method_ty);
 766                 self.cat_rvalue_node(node.id(), node.span(), ref_ty)
 767             }
 768             None => base_cmt
 769         };
 770         match ty::deref(base_cmt.ty, true) {
 771             Some(mt) => self.cat_deref_common(node, base_cmt, deref_cnt, mt.ty, implicit),
 772             None => {
 773                 self.tcx().sess.span_bug(
 774                     node.span(),
 775                     format!("Explicit deref of non-derefable type: {}",
 776                             base_cmt.ty.repr(self.tcx())).as_slice());
 777             }
 778         }
 779     }
 780
 781     fn cat_deref_common<N:ast_node>(&self,
 782                                     node: &N,
 783                                     base_cmt: cmt,
 784                                     deref_cnt: uint,
 785                                     deref_ty: ty::t,
 786                                     implicit: bool)
 787                                     -> cmt {
 788         let (m, cat) = match deref_kind(self.tcx(), base_cmt.ty) {
 789             deref_ptr(ptr) => {
 790                 let ptr = if implicit {
 791                     match ptr {
 792                         BorrowedPtr(bk, r) => Implicit(bk, r),
 793                         _ => self.tcx().sess.span_bug(node.span(),
 794                             "Implicit deref of non-borrowed pointer")
 795                     }
 796                 } else {
 797                     ptr
 798                 };
 799                 // for unique ptrs, we inherit mutability from the
 800                 // owning reference.
 801                 (MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr),
 802                  cat_deref(base_cmt, deref_cnt, ptr))
 803             }
 804             deref_interior(interior) => {
 805                 (base_cmt.mutbl.inherit(), cat_interior(base_cmt, interior))
 806             }
 807         };
 808         Rc::new(cmt_ {
 809             id: node.id(),
 810             span: node.span(),
 811             cat: cat,
 812             mutbl: m,
 813             ty: deref_ty
 814         })
 815     }
 816
 817     pub fn cat_index<N:ast_node>(&self,
 818                                  elt: &N,
 819                                  mut base_cmt: cmt)
 820                                  -> cmt {
 821         //! Creates a cmt for an indexing operation (`[]`).
 822         //!
 823         //! One subtle aspect of indexing that may not be
 824         //! immediately obvious: for anything other than a fixed-length
 825         //! vector, an operation like `x[y]` actually consists of two
 826         //! disjoint (from the point of view of borrowck) operations.
 827         //! The first is a deref of `x` to create a pointer `p` that points
 828         //! at the first element in the array. The second operation is
 829         //! an index which adds `y*sizeof(T)` to `p` to obtain the
 830         //! pointer to `x[y]`. `cat_index` will produce a resulting
 831         //! cmt containing both this deref and the indexing,
 832         //! presuming that `base_cmt` is not of fixed-length type.
 833         //!
 834         //! # Parameters
 835         //! - `elt`: the AST node being indexed
 836         //! - `base_cmt`: the cmt of `elt`
 837
 838         let method_call = typeck::MethodCall::expr(elt.id());
 839         let method_ty = self.typer.node_method_ty(method_call);
 840
 841         let element_ty = match method_ty {
 842             Some(method_ty) => {
 843                 let ref_ty = ty::ty_fn_ret(method_ty);
 844                 base_cmt = self.cat_rvalue_node(elt.id(), elt.span(), ref_ty);
 845                 *ty::ty_fn_args(method_ty).get(0)
 846             }
 847             None => {
 848                 match ty::array_element_ty(base_cmt.ty) {
 849                     Some(ty) => ty,
 850                     None => {
 851                         self.tcx().sess.span_bug(
 852                             elt.span(),
 853                             format!("Explicit index of non-index type `{}`",
 854                                     base_cmt.ty.repr(self.tcx())).as_slice());
 855                     }
 856                 }
 857             }
 858         };
 859
 860         let m = base_cmt.mutbl.inherit();
 861         return interior(elt, base_cmt.clone(), base_cmt.ty, m, element_ty);
 862
 863         fn interior<N: ast_node>(elt: &N,
 864                                  of_cmt: cmt,
 865                                  vec_ty: ty::t,
 866                                  mutbl: MutabilityCategory,
 867                                  element_ty: ty::t) -> cmt
 868         {
 869             Rc::new(cmt_ {
 870                 id:elt.id(),
 871                 span:elt.span(),
 872                 cat:cat_interior(of_cmt, InteriorElement(element_kind(vec_ty))),
 873                 mutbl:mutbl,
 874                 ty:element_ty
 875             })
 876         }
 877     }
 878
 879     // Takes either a vec or a reference to a vec and returns the cmt for the
 880     // underlying vec.
 881     fn deref_vec<N:ast_node>(&self,
 882                              elt: &N,
 883                              base_cmt: cmt)
 884                              -> cmt {
 885         match deref_kind(self.tcx(), base_cmt.ty) {
 886             deref_ptr(ptr) => {
 887                 // for unique ptrs, we inherit mutability from the
 888                 // owning reference.
 889                 let m = MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr);
 890
 891                 // the deref is explicit in the resulting cmt
 892                 Rc::new(cmt_ {
 893                     id:elt.id(),
 894                     span:elt.span(),
 895                     cat:cat_deref(base_cmt.clone(), 0, ptr),
 896                     mutbl:m,
 897                     ty: match ty::deref(base_cmt.ty, false) {
 898                         Some(mt) => mt.ty,
 899                         None => self.tcx().sess.bug("Found non-derefable type")
 900                     }
 901                 })
 902             }
 903
 904             deref_interior(_) => {
 905                 base_cmt
 906             }
 907         }
 908     }
 909
 910     pub fn cat_slice_pattern(&self,
 911                              vec_cmt: cmt,
 912                              slice_pat: &ast::Pat)
 913                              -> McResult<(cmt, ast::Mutability, ty::Region)> {
 914         /*!
 915          * Given a pattern P like: `[_, ..Q, _]`, where `vec_cmt` is
 916          * the cmt for `P`, `slice_pat` is the pattern `Q`, returns:
 917          * - a cmt for `Q`
 918          * - the mutability and region of the slice `Q`
 919          *
 920          * These last two bits of info happen to be things that
 921          * borrowck needs.
 922          */
 923
 924         let slice_ty = if_ok!(self.node_ty(slice_pat.id));
 925         let (slice_mutbl, slice_r) = vec_slice_info(self.tcx(),
 926                                                     slice_pat,
 927                                                     slice_ty);
 928         let cmt_slice = self.cat_index(slice_pat, self.deref_vec(slice_pat, vec_cmt));
 929         return Ok((cmt_slice, slice_mutbl, slice_r));
 930
 931         fn vec_slice_info(tcx: &ty::ctxt,
 932                           pat: &ast::Pat,
 933                           slice_ty: ty::t)
 934                           -> (ast::Mutability, ty::Region) {
 935             /*!
 936              * In a pattern like [a, b, ..c], normally `c` has slice type,
 937              * but if you have [a, b, ..ref c], then the type of `ref c`
 938              * will be `&&[]`, so to extract the slice details we have
 939              * to recurse through rptrs.
 940              */
 941
 942             match ty::get(slice_ty).sty {
 943                 ty::ty_rptr(r, ref mt) => match ty::get(mt.ty).sty {
 944                     ty::ty_vec(_, None) => (mt.mutbl, r),
 945                     _ => vec_slice_info(tcx, pat, mt.ty),
 946                 },
 947
 948                 _ => {
 949                     tcx.sess.span_bug(pat.span,
 950                                       "type of slice pattern is not a slice");
 951                 }
 952             }
 953         }
 954     }
 955
 956     pub fn cat_imm_interior<N:ast_node>(&self,
 957                                         node: &N,
 958                                         base_cmt: cmt,
 959                                         interior_ty: ty::t,
 960                                         interior: InteriorKind)
 961                                         -> cmt {
 962         Rc::new(cmt_ {
 963             id: node.id(),
 964             span: node.span(),
 965             mutbl: base_cmt.mutbl.inherit(),
 966             cat: cat_interior(base_cmt, interior),
 967             ty: interior_ty
 968         })
 969     }
 970
 971     pub fn cat_downcast<N:ast_node>(&self,
 972                                     node: &N,
 973                                     base_cmt: cmt,
 974                                     downcast_ty: ty::t)
 975                                     -> cmt {
 976         Rc::new(cmt_ {
 977             id: node.id(),
 978             span: node.span(),
 979             mutbl: base_cmt.mutbl.inherit(),
 980             cat: cat_downcast(base_cmt),
 981             ty: downcast_ty
 982         })
 983     }
 984
 985     pub fn cat_pattern(&self,
 986                        cmt: cmt,
 987                        pat: &ast::Pat,
 988                        op: |&MemCategorizationContext<TYPER>,
 989                             cmt,
 990                             &ast::Pat|)
 991                        -> McResult<()> {
 992         // Here, `cmt` is the categorization for the value being
 993         // matched and pat is the pattern it is being matched against.
 994         //
 995         // In general, the way that this works is that we walk down
 996         // the pattern, constructing a cmt that represents the path
 997         // that will be taken to reach the value being matched.
 998         //
 999         // When we encounter named bindings, we take the cmt that has
1000         // been built up and pass it off to guarantee_valid() so that
1001         // we can be sure that the binding will remain valid for the
1002         // duration of the arm.
1003         //
1004         // (*2) There is subtlety concerning the correspondence between
1005         // pattern ids and types as compared to *expression* ids and
1006         // types. This is explained briefly. on the definition of the
1007         // type `cmt`, so go off and read what it says there, then
1008         // come back and I'll dive into a bit more detail here. :) OK,
1009         // back?
1010         //
1011         // In general, the id of the cmt should be the node that
1012         // "produces" the value---patterns aren't executable code
1013         // exactly, but I consider them to "execute" when they match a
1014         // value, and I consider them to produce the value that was
1015         // matched. So if you have something like:
1016         //
1017         //     let x = @@3;
1018         //     match x {
1019         //       @@y { ... }
1020         //     }
1021         //
1022         // In this case, the cmt and the relevant ids would be:
1023         //
1024         //     CMT             Id                  Type of Id Type of cmt
1025         //
1026         //     local(x)->@->@
1027         //     ^~~~~~~^        `x` from discr      @@int      @@int
1028         //     ^~~~~~~~~~^     `@@y` pattern node  @@int      @int
1029         //     ^~~~~~~~~~~~~^  `@y` pattern node   @int       int
1030         //
1031         // You can see that the types of the id and the cmt are in
1032         // sync in the first line, because that id is actually the id
1033         // of an expression. But once we get to pattern ids, the types
1034         // step out of sync again. So you'll see below that we always
1035         // get the type of the *subpattern* and use that.
1036
1037         debug!("cat_pattern: id={} pat={} cmt={}",
1038                pat.id, pprust::pat_to_string(pat),
1039                cmt.repr(self.tcx()));
1040
1041         op(self, cmt.clone(), pat);
1042
1043         match pat.node {
1044           ast::PatWild(_) => {
1045             // _
1046           }
1047
1048           ast::PatEnum(_, None) => {
1049             // variant(..)
1050           }
1051           ast::PatEnum(_, Some(ref subpats)) => {
1052             match self.tcx().def_map.borrow().find(&pat.id) {
1053                 Some(&def::DefVariant(enum_did, _, _)) => {
1054                     // variant(x, y, z)
1055
1056                     let downcast_cmt = {
1057                         if ty::enum_is_univariant(self.tcx(), enum_did) {
1058                             cmt // univariant, no downcast needed
1059                         } else {
1060                             self.cat_downcast(pat, cmt.clone(), cmt.ty)
1061                         }
1062                     };
1063
1064                     for (i, subpat) in subpats.iter().enumerate() {
1065                         let subpat_ty = if_ok!(self.pat_ty(&**subpat)); // see (*2)
1066
1067                         let subcmt =
1068                             self.cat_imm_interior(
1069                                 pat, downcast_cmt.clone(), subpat_ty,
1070                                 InteriorField(PositionalField(i)));
1071
1072                         if_ok!(self.cat_pattern(subcmt, &**subpat, |x,y,z| op(x,y,z)));
1073                     }
1074                 }
1075                 Some(&def::DefFn(..)) |
1076                 Some(&def::DefStruct(..)) => {
1077                     for (i, subpat) in subpats.iter().enumerate() {
1078                         let subpat_ty = if_ok!(self.pat_ty(&**subpat)); // see (*2)
1079                         let cmt_field =
1080                             self.cat_imm_interior(
1081                                 pat, cmt.clone(), subpat_ty,
1082                                 InteriorField(PositionalField(i)));
1083                         if_ok!(self.cat_pattern(cmt_field, &**subpat,
1084                                                 |x,y,z| op(x,y,z)));
1085                     }
1086                 }
1087                 Some(&def::DefStatic(..)) => {
1088                     for subpat in subpats.iter() {
1089                         if_ok!(self.cat_pattern(cmt.clone(), &**subpat, |x,y,z| op(x,y,z)));
1090                     }
1091                 }
1092                 _ => {
1093                     self.tcx().sess.span_bug(
1094                         pat.span,
1095                         "enum pattern didn't resolve to enum or struct");
1096                 }
1097             }
1098           }
1099
1100           ast::PatIdent(_, _, Some(ref subpat)) => {
1101               if_ok!(self.cat_pattern(cmt, &**subpat, op));
1102           }
1103
1104           ast::PatIdent(_, _, None) => {
1105               // nullary variant or identifier: ignore
1106           }
1107
1108           ast::PatStruct(_, ref field_pats, _) => {
1109             // {f1: p1, ..., fN: pN}
1110             for fp in field_pats.iter() {
1111                 let field_ty = if_ok!(self.pat_ty(&*fp.pat)); // see (*2)
1112                 let cmt_field = self.cat_field(pat, cmt.clone(), fp.ident, field_ty);
1113                 if_ok!(self.cat_pattern(cmt_field, &*fp.pat, |x,y,z| op(x,y,z)));
1114             }
1115           }
1116
1117           ast::PatTup(ref subpats) => {
1118             // (p1, ..., pN)
1119             for (i, subpat) in subpats.iter().enumerate() {
1120                 let subpat_ty = if_ok!(self.pat_ty(&**subpat)); // see (*2)
1121                 let subcmt =
1122                     self.cat_imm_interior(
1123                         pat, cmt.clone(), subpat_ty,
1124                         InteriorField(PositionalField(i)));
1125                 if_ok!(self.cat_pattern(subcmt, &**subpat, |x,y,z| op(x,y,z)));
1126             }
1127           }
1128
1129           ast::PatBox(ref subpat) | ast::PatRegion(ref subpat) => {
1130             // @p1, ~p1, ref p1
1131             let subcmt = self.cat_deref(pat, cmt, 0, false);
1132             if_ok!(self.cat_pattern(subcmt, &**subpat, op));
1133           }
1134
1135           ast::PatVec(ref before, ref slice, ref after) => {
1136               let elt_cmt = self.cat_index(pat, self.deref_vec(pat, cmt));
1137               for before_pat in before.iter() {
1138                   if_ok!(self.cat_pattern(elt_cmt.clone(), &**before_pat,
1139                                           |x,y,z| op(x,y,z)));
1140               }
1141               for slice_pat in slice.iter() {
1142                   let slice_ty = if_ok!(self.pat_ty(&**slice_pat));
1143                   let slice_cmt = self.cat_rvalue_node(pat.id(), pat.span(), slice_ty);
1144                   if_ok!(self.cat_pattern(slice_cmt, &**slice_pat, |x,y,z| op(x,y,z)));
1145               }
1146               for after_pat in after.iter() {
1147                   if_ok!(self.cat_pattern(elt_cmt.clone(), &**after_pat, |x,y,z| op(x,y,z)));
1148               }
1149           }
1150
1151           ast::PatLit(_) | ast::PatRange(_, _) => {
1152               /*always ok*/
1153           }
1154
1155           ast::PatMac(_) => {
1156               self.tcx().sess.span_bug(pat.span, "unexpanded macro");
1157           }
1158         }
1159
1160         Ok(())
1161     }
1162
1163     pub fn cmt_to_string(&self, cmt: &cmt_) -> String {
1164         match cmt.cat {
1165           cat_static_item => {
1166               "static item".to_string()
1167           }
1168           cat_copied_upvar(_) => {
1169               "captured outer variable in a proc".to_string()
1170           }
1171           cat_rvalue(..) => {
1172               "non-lvalue".to_string()
1173           }
1174           cat_local(vid) => {
1175               match self.tcx().map.find(vid) {
1176                   Some(ast_map::NodeArg(_)) => {
1177                       "argument".to_string()
1178                   }
1179                   _ => "local variable".to_string()
1180               }
1181           }
1182           cat_deref(ref base, _, pk) => {
1183               match base.cat {
1184                   cat_upvar(..) => {
1185                       "captured outer variable".to_string()
1186                   }
1187                   _ => {
1188                       match pk {
1189                           Implicit(..) => {
1190                             "dereference (dereference is implicit, due to indexing)".to_string()
1191                           }
1192                           OwnedPtr | GcPtr => format!("dereference of `{}`", ptr_sigil(pk)),
1193                           _ => format!("dereference of `{}`-pointer", ptr_sigil(pk))
1194                       }
1195                   }
1196               }
1197           }
1198           cat_interior(_, InteriorField(NamedField(_))) => {
1199               "field".to_string()
1200           }
1201           cat_interior(_, InteriorField(PositionalField(_))) => {
1202               "anonymous field".to_string()
1203           }
1204           cat_interior(_, InteriorElement(VecElement)) => {
1205               "vec content".to_string()
1206           }
1207           cat_interior(_, InteriorElement(OtherElement)) => {
1208               "indexed content".to_string()
1209           }
1210           cat_upvar(..) => {
1211               "captured outer variable".to_string()
1212           }
1213           cat_discr(ref cmt, _) => {
1214             self.cmt_to_string(&**cmt)
1215           }
1216           cat_downcast(ref cmt) => {
1217             self.cmt_to_string(&**cmt)
1218           }
1219         }
1220     }
1221 }
1222
1223 pub enum InteriorSafety {
1224     InteriorUnsafe,
1225     InteriorSafe
1226 }
1227
1228 pub enum AliasableReason {
1229     AliasableManaged,
1230     AliasableBorrowed,
1231     AliasableOther,
1232     AliasableStatic(InteriorSafety),
1233     AliasableStaticMut(InteriorSafety),
1234 }
1235
1236 impl cmt_ {
1237     pub fn guarantor(&self) -> cmt {
1238         //! Returns `self` after stripping away any owned pointer derefs or
1239         //! interior content. The return value is basically the `cmt` which
1240         //! determines how long the value in `self` remains live.
1241
1242         match self.cat {
1243             cat_rvalue(..) |
1244             cat_static_item |
1245             cat_copied_upvar(..) |
1246             cat_local(..) |
1247             cat_deref(_, _, UnsafePtr(..)) |
1248             cat_deref(_, _, GcPtr(..)) |
1249             cat_deref(_, _, BorrowedPtr(..)) |
1250             cat_deref(_, _, Implicit(..)) |
1251             cat_upvar(..) => {
1252                 Rc::new((*self).clone())
1253             }
1254             cat_downcast(ref b) |
1255             cat_discr(ref b, _) |
1256             cat_interior(ref b, _) |
1257             cat_deref(ref b, _, OwnedPtr) => {
1258                 b.guarantor()
1259             }
1260         }
1261     }
1262
1263     pub fn freely_aliasable(&self, ctxt: &ty::ctxt) -> Option<AliasableReason> {
1264         /*!
1265          * Returns `Some(_)` if this lvalue represents a freely aliasable
1266          * pointer type.
1267          */
1268
1269         // Maybe non-obvious: copied upvars can only be considered
1270         // non-aliasable in once closures, since any other kind can be
1271         // aliased and eventually recused.
1272
1273         match self.cat {
1274             cat_deref(ref b, _, BorrowedPtr(ty::MutBorrow, _)) |
1275             cat_deref(ref b, _, Implicit(ty::MutBorrow, _)) |
1276             cat_deref(ref b, _, BorrowedPtr(ty::UniqueImmBorrow, _)) |
1277             cat_deref(ref b, _, Implicit(ty::UniqueImmBorrow, _)) |
1278             cat_downcast(ref b) |
1279             cat_deref(ref b, _, OwnedPtr) |
1280             cat_interior(ref b, _) |
1281             cat_discr(ref b, _) => {
1282                 // Aliasability depends on base cmt
1283                 b.freely_aliasable(ctxt)
1284             }
1285
1286             cat_copied_upvar(CopiedUpvar {onceness: ast::Once, ..}) |
1287             cat_rvalue(..) |
1288             cat_local(..) |
1289             cat_upvar(..) |
1290             cat_deref(_, _, UnsafePtr(..)) => { // yes, it's aliasable, but...
1291                 None
1292             }
1293
1294             cat_copied_upvar(CopiedUpvar {onceness: ast::Many, ..}) => {
1295                 Some(AliasableOther)
1296             }
1297
1298             cat_static_item(..) => {
1299                 let int_safe = if ty::type_interior_is_unsafe(ctxt, self.ty) {
1300                     InteriorUnsafe
1301                 } else {
1302                     InteriorSafe
1303                 };
1304
1305                 if self.mutbl.is_mutable() {
1306                     Some(AliasableStaticMut(int_safe))
1307                 } else {
1308                     Some(AliasableStatic(int_safe))
1309                 }
1310             }
1311
1312             cat_deref(_, _, GcPtr) => {
1313                 Some(AliasableManaged)
1314             }
1315
1316             cat_deref(_, _, BorrowedPtr(ty::ImmBorrow, _)) |
1317             cat_deref(_, _, Implicit(ty::ImmBorrow, _)) => {
1318                 Some(AliasableBorrowed)
1319             }
1320         }
1321     }
1322 }
1323
1324 impl Repr for cmt_ {
1325     fn repr(&self, tcx: &ty::ctxt) -> String {
1326         format!("{{{} id:{} m:{:?} ty:{}}}",
1327                 self.cat.repr(tcx),
1328                 self.id,
1329                 self.mutbl,
1330                 self.ty.repr(tcx))
1331     }
1332 }
1333
1334 impl Repr for categorization {
1335     fn repr(&self, tcx: &ty::ctxt) -> String {
1336         match *self {
1337             cat_static_item |
1338             cat_rvalue(..) |
1339             cat_copied_upvar(..) |
1340             cat_local(..) |
1341             cat_upvar(..) => {
1342                 format!("{:?}", *self)
1343             }
1344             cat_deref(ref cmt, derefs, ptr) => {
1345                 format!("{}-{}{}->", cmt.cat.repr(tcx), ptr_sigil(ptr), derefs)
1346             }
1347             cat_interior(ref cmt, interior) => {
1348                 format!("{}.{}", cmt.cat.repr(tcx), interior.repr(tcx))
1349             }
1350             cat_downcast(ref cmt) => {
1351                 format!("{}->(enum)", cmt.cat.repr(tcx))
1352             }
1353             cat_discr(ref cmt, _) => {
1354                 cmt.cat.repr(tcx)
1355             }
1356         }
1357     }
1358 }
1359
1360 pub fn ptr_sigil(ptr: PointerKind) -> &'static str {
1361     match ptr {
1362         OwnedPtr => "Box",
1363         GcPtr => "Gc",
1364         BorrowedPtr(ty::ImmBorrow, _) |
1365         Implicit(ty::ImmBorrow, _) => "&",
1366         BorrowedPtr(ty::MutBorrow, _) |
1367         Implicit(ty::MutBorrow, _) => "&mut",
1368         BorrowedPtr(ty::UniqueImmBorrow, _) |
1369         Implicit(ty::UniqueImmBorrow, _) => "&unique",
1370         UnsafePtr(_) => "*"
1371     }
1372 }
1373
1374 impl Repr for InteriorKind {
1375     fn repr(&self, _tcx: &ty::ctxt) -> String {
1376         match *self {
1377             InteriorField(NamedField(fld)) => {
1378                 token::get_name(fld).get().to_string()
1379             }
1380             InteriorField(PositionalField(i)) => format!("#{:?}", i),
1381             InteriorElement(_) => "[]".to_string(),
1382         }
1383     }
1384 }
1385
1386 fn element_kind(t: ty::t) -> ElementKind {
1387     match ty::get(t).sty {
1388         ty::ty_rptr(_, ty::mt{ty:ty, ..}) |
1389         ty::ty_uniq(ty) => match ty::get(ty).sty {
1390             ty::ty_vec(_, None) => VecElement,
1391             _ => OtherElement
1392         },
1393         ty::ty_vec(..) => VecElement,
1394         _ => OtherElement
1395     }
1396 }