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