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.
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.
13 //! The job of the categorization module is to analyze an expression to
14 //! determine what kind of memory is used in evaluating it (for example,
15 //! where dereferences occur and what kind of pointer is dereferenced;
16 //! whether the memory is mutable; etc)
18 //! Categorization effectively transforms all of our expressions into
19 //! expressions of the following forms (the actual enum has many more
20 //! possibilities, naturally, but they are all variants of these base
23 //! E = rvalue // some computed rvalue
24 //! | x // address of a local variable or argument
25 //! | *E // deref of a ptr
26 //! | E.comp // access to an interior component
28 //! Imagine a routine ToAddr(Expr) that evaluates an expression and returns an
29 //! address where the result is to be found. If Expr is an lvalue, then this
30 //! is the address of the lvalue. If Expr is an rvalue, this is the address of
31 //! some temporary spot in memory where the result is stored.
33 //! Now, cat_expr() classifies the expression Expr and the address A=ToAddr(Expr)
36 //! - cat: what kind of expression was this? This is a subset of the
37 //! full expression forms which only includes those that we care about
38 //! for the purpose of the analysis.
39 //! - mutbl: mutability of the address A
40 //! - ty: the type of data found at the address A
42 //! The resulting categorization tree differs somewhat from the expressions
43 //! themselves. For example, auto-derefs are explicit. Also, an index a[b] is
44 //! decomposed into two operations: a dereference to reach the array data and
45 //! then an index to jump forward to the relevant item.
47 //! ## By-reference upvars
49 //! One part of the translation which may be non-obvious is that we translate
50 //! closure upvars into the dereference of a borrowed pointer; this more closely
51 //! resembles the runtime translation. So, for example, if we had:
55 //! let inc = || x += y;
57 //! Then when we categorize `x` (*within* the closure) we would yield a
58 //! result of `*x'`, effectively, where `x'` is a `cat_upvar` reference
59 //! tied to `x`. The type of `x'` will be a borrowed pointer.
61 #![allow(non_camel_case_types)]
63 pub use self::PointerKind::*;
64 pub use self::InteriorKind::*;
65 pub use self::FieldName::*;
66 pub use self::ElementKind::*;
67 pub use self::MutabilityCategory::*;
68 pub use self::AliasableReason::*;
69 pub use self::Note::*;
70 pub use self::deref_kind::*;
71 pub use self::categorization::*;
73 use self::Aliasability::*;
75 use middle::def_id::DefId;
76 use front::map as ast_map;
78 use middle::check_const;
80 use middle::ty::{self, Ty};
82 use rustc_front::hir::{MutImmutable, MutMutable};
85 use syntax::codemap::Span;
90 #[derive(Clone, PartialEq)]
91 pub enum categorization<'tcx> {
92 cat_rvalue(ty::Region), // temporary val, argument is its scope
94 cat_upvar(Upvar), // upvar referenced by closure env
95 cat_local(ast::NodeId), // local variable
96 cat_deref(cmt<'tcx>, usize, PointerKind), // deref of a ptr
97 cat_interior(cmt<'tcx>, InteriorKind), // something interior: field, tuple, etc
98 cat_downcast(cmt<'tcx>, DefId), // selects a particular enum variant (*1)
100 // (*1) downcast is only required if the enum has more than one variant
103 // Represents any kind of upvar
104 #[derive(Clone, Copy, PartialEq)]
107 pub kind: ty::ClosureKind
110 // different kinds of pointers:
111 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
112 pub enum PointerKind {
117 BorrowedPtr(ty::BorrowKind, ty::Region),
120 UnsafePtr(hir::Mutability),
122 /// Implicit deref of the `&T` that results from an overloaded index `[]`.
123 Implicit(ty::BorrowKind, ty::Region),
126 // We use the term "interior" to mean "something reachable from the
127 // base without a pointer dereference", e.g. a field
128 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
129 pub enum InteriorKind {
130 InteriorField(FieldName),
131 InteriorElement(InteriorOffsetKind, ElementKind),
134 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
136 NamedField(ast::Name),
137 PositionalField(usize)
140 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
141 pub enum InteriorOffsetKind {
142 Index, // e.g. `array_expr[index_expr]`
143 Pattern, // e.g. `fn foo([_, a, _, _]: [A; 4]) { ... }`
146 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
147 pub enum ElementKind {
152 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
153 pub enum MutabilityCategory {
154 McImmutable, // Immutable.
155 McDeclared, // Directly declared as mutable.
156 McInherited, // Inherited from the fact that owner is mutable.
159 // A note about the provenance of a `cmt`. This is used for
160 // special-case handling of upvars such as mutability inference.
161 // Upvar categorization can generate a variable number of nested
162 // derefs. The note allows detecting them without deep pattern
163 // matching on the categorization.
164 #[derive(Clone, Copy, PartialEq, Debug)]
166 NoteClosureEnv(ty::UpvarId), // Deref through closure env
167 NoteUpvarRef(ty::UpvarId), // Deref through by-ref upvar
168 NoteNone // Nothing special
171 // `cmt`: "Category, Mutability, and Type".
173 // a complete categorization of a value indicating where it originated
174 // and how it is located, as well as the mutability of the memory in
175 // which the value is stored.
177 // *WARNING* The field `cmt.type` is NOT necessarily the same as the
178 // result of `node_id_to_type(cmt.id)`. This is because the `id` is
179 // always the `id` of the node producing the type; in an expression
180 // like `*x`, the type of this deref node is the deref'd type (`T`),
181 // but in a pattern like `@x`, the `@x` pattern is again a
182 // dereference, but its type is the type *before* the dereference
183 // (`@T`). So use `cmt.ty` to find the type of the value in a consistent
184 // fashion. For more details, see the method `cat_pattern`
185 #[derive(Clone, PartialEq)]
186 pub struct cmt_<'tcx> {
187 pub id: ast::NodeId, // id of expr/pat producing this value
188 pub span: Span, // span of same expr/pat
189 pub cat: categorization<'tcx>, // categorization of expr
190 pub mutbl: MutabilityCategory, // mutability of expr as lvalue
191 pub ty: Ty<'tcx>, // type of the expr (*see WARNING above*)
192 pub note: Note, // Note about the provenance of this cmt
195 pub type cmt<'tcx> = Rc<cmt_<'tcx>>;
197 // We pun on *T to mean both actual deref of a ptr as well
198 // as accessing of components:
199 #[derive(Copy, Clone)]
200 pub enum deref_kind {
201 deref_ptr(PointerKind),
202 deref_interior(InteriorKind),
205 type DerefKindContext = Option<InteriorOffsetKind>;
207 // Categorizes a derefable type. Note that we include vectors and strings as
208 // derefable (we model an index as the combination of a deref and then a
209 // pointer adjustment).
210 fn deref_kind(t: Ty, context: DerefKindContext) -> McResult<deref_kind> {
213 Ok(deref_ptr(Unique))
216 ty::TyRef(r, mt) => {
217 let kind = ty::BorrowKind::from_mutbl(mt.mutbl);
218 Ok(deref_ptr(BorrowedPtr(kind, *r)))
221 ty::TyRawPtr(ref mt) => {
222 Ok(deref_ptr(UnsafePtr(mt.mutbl)))
226 ty::TyStruct(..) => { // newtype
227 Ok(deref_interior(InteriorField(PositionalField(0))))
230 ty::TyArray(_, _) | ty::TySlice(_) | ty::TyStr => {
231 // no deref of indexed content without supplying InteriorOffsetKind
232 if let Some(context) = context {
233 Ok(deref_interior(InteriorElement(context, element_kind(t))))
244 fn id(&self) -> ast::NodeId;
245 fn span(&self) -> Span;
248 impl ast_node for hir::Expr {
249 fn id(&self) -> ast::NodeId { self.id }
250 fn span(&self) -> Span { self.span }
253 impl ast_node for hir::Pat {
254 fn id(&self) -> ast::NodeId { self.id }
255 fn span(&self) -> Span { self.span }
258 #[derive(Copy, Clone)]
259 pub struct MemCategorizationContext<'t, 'a: 't, 'tcx : 'a> {
260 pub typer: &'t infer::InferCtxt<'a, 'tcx>,
263 pub type McResult<T> = Result<T, ()>;
265 impl MutabilityCategory {
266 pub fn from_mutbl(m: hir::Mutability) -> MutabilityCategory {
268 MutImmutable => McImmutable,
269 MutMutable => McDeclared
271 debug!("MutabilityCategory::{}({:?}) => {:?}",
272 "from_mutbl", m, ret);
276 pub fn from_borrow_kind(borrow_kind: ty::BorrowKind) -> MutabilityCategory {
277 let ret = match borrow_kind {
278 ty::ImmBorrow => McImmutable,
279 ty::UniqueImmBorrow => McImmutable,
280 ty::MutBorrow => McDeclared,
282 debug!("MutabilityCategory::{}({:?}) => {:?}",
283 "from_borrow_kind", borrow_kind, ret);
287 fn from_pointer_kind(base_mutbl: MutabilityCategory,
288 ptr: PointerKind) -> MutabilityCategory {
289 let ret = match ptr {
293 BorrowedPtr(borrow_kind, _) | Implicit(borrow_kind, _) => {
294 MutabilityCategory::from_borrow_kind(borrow_kind)
297 MutabilityCategory::from_mutbl(m)
300 debug!("MutabilityCategory::{}({:?}, {:?}) => {:?}",
301 "from_pointer_kind", base_mutbl, ptr, ret);
305 fn from_local(tcx: &ty::ctxt, id: ast::NodeId) -> MutabilityCategory {
306 let ret = match tcx.map.get(id) {
307 ast_map::NodeLocal(p) | ast_map::NodeArg(p) => match p.node {
308 hir::PatIdent(bind_mode, _, _) => {
309 if bind_mode == hir::BindByValue(hir::MutMutable) {
315 _ => tcx.sess.span_bug(p.span, "expected identifier pattern")
317 _ => tcx.sess.span_bug(tcx.map.span(id), "expected identifier pattern")
319 debug!("MutabilityCategory::{}(tcx, id={:?}) => {:?}",
320 "from_local", id, ret);
324 pub fn inherit(&self) -> MutabilityCategory {
325 let ret = match *self {
326 McImmutable => McImmutable,
327 McDeclared => McInherited,
328 McInherited => McInherited,
330 debug!("{:?}.inherit() => {:?}", self, ret);
334 pub fn is_mutable(&self) -> bool {
335 let ret = match *self {
336 McImmutable => false,
340 debug!("{:?}.is_mutable() => {:?}", self, ret);
344 pub fn is_immutable(&self) -> bool {
345 let ret = match *self {
347 McDeclared | McInherited => false
349 debug!("{:?}.is_immutable() => {:?}", self, ret);
353 pub fn to_user_str(&self) -> &'static str {
355 McDeclared | McInherited => "mutable",
356 McImmutable => "immutable",
361 impl<'t, 'a,'tcx> MemCategorizationContext<'t, 'a, 'tcx> {
362 pub fn new(typer: &'t infer::InferCtxt<'a, 'tcx>) -> MemCategorizationContext<'t, 'a, 'tcx> {
363 MemCategorizationContext { typer: typer }
366 fn tcx(&self) -> &'a ty::ctxt<'tcx> {
370 fn expr_ty(&self, expr: &hir::Expr) -> McResult<Ty<'tcx>> {
371 match self.typer.node_ty(expr.id) {
374 debug!("expr_ty({:?}) yielded Err", expr);
380 fn expr_ty_adjusted(&self, expr: &hir::Expr) -> McResult<Ty<'tcx>> {
381 let unadjusted_ty = try!(self.expr_ty(expr));
382 Ok(unadjusted_ty.adjust(
383 self.tcx(), expr.span, expr.id,
384 self.typer.adjustments().get(&expr.id),
385 |method_call| self.typer.node_method_ty(method_call)))
388 fn node_ty(&self, id: ast::NodeId) -> McResult<Ty<'tcx>> {
389 self.typer.node_ty(id)
392 fn pat_ty(&self, pat: &hir::Pat) -> McResult<Ty<'tcx>> {
393 let base_ty = try!(self.typer.node_ty(pat.id));
394 // FIXME (Issue #18207): This code detects whether we are
395 // looking at a `ref x`, and if so, figures out what the type
396 // *being borrowed* is. But ideally we would put in a more
397 // fundamental fix to this conflated use of the node id.
398 let ret_ty = match pat.node {
399 hir::PatIdent(hir::BindByRef(_), _, _) => {
400 // a bind-by-ref means that the base_ty will be the type of the ident itself,
401 // but what we want here is the type of the underlying value being borrowed.
402 // So peel off one-level, turning the &T into T.
403 match base_ty.builtin_deref(false, ty::NoPreference) {
405 None => { return Err(()); }
410 debug!("pat_ty(pat={:?}) base_ty={:?} ret_ty={:?}",
411 pat, base_ty, ret_ty);
415 pub fn cat_expr(&self, expr: &hir::Expr) -> McResult<cmt<'tcx>> {
416 match self.typer.adjustments().get(&expr.id) {
419 self.cat_expr_unadjusted(expr)
422 Some(adjustment) => {
426 autoref: None, unsize: None, autoderefs, ..}) => {
427 // Equivalent to *expr or something similar.
428 self.cat_expr_autoderefd(expr, autoderefs)
431 ty::AdjustReifyFnPointer |
432 ty::AdjustUnsafeFnPointer |
433 ty::AdjustDerefRef(_) => {
434 debug!("cat_expr({:?}): {:?}",
437 // Result is an rvalue.
438 let expr_ty = try!(self.expr_ty_adjusted(expr));
439 Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
446 pub fn cat_expr_autoderefd(&self,
449 -> McResult<cmt<'tcx>> {
450 let mut cmt = try!(self.cat_expr_unadjusted(expr));
451 debug!("cat_expr_autoderefd: autoderefs={}, cmt={:?}",
454 for deref in 1..autoderefs + 1 {
455 cmt = try!(self.cat_deref(expr, cmt, deref, None));
460 pub fn cat_expr_unadjusted(&self, expr: &hir::Expr) -> McResult<cmt<'tcx>> {
461 debug!("cat_expr: id={} expr={:?}", expr.id, expr);
463 let expr_ty = try!(self.expr_ty(expr));
465 hir::ExprUnary(hir::UnDeref, ref e_base) => {
466 let base_cmt = try!(self.cat_expr(&**e_base));
467 self.cat_deref(expr, base_cmt, 0, None)
470 hir::ExprField(ref base, f_name) => {
471 let base_cmt = try!(self.cat_expr(&**base));
472 debug!("cat_expr(cat_field): id={} expr={:?} base={:?}",
476 Ok(self.cat_field(expr, base_cmt, f_name.node.name, expr_ty))
479 hir::ExprTupField(ref base, idx) => {
480 let base_cmt = try!(self.cat_expr(&**base));
481 Ok(self.cat_tup_field(expr, base_cmt, idx.node, expr_ty))
484 hir::ExprIndex(ref base, _) => {
485 let method_call = ty::MethodCall::expr(expr.id());
486 let context = InteriorOffsetKind::Index;
487 match self.typer.node_method_ty(method_call) {
489 // If this is an index implemented by a method call, then it
490 // will include an implicit deref of the result.
491 let ret_ty = self.overloaded_method_return_ty(method_ty);
493 // The index method always returns an `&T`, so
494 // dereference it to find the result type.
495 let elem_ty = match ret_ty.sty {
496 ty::TyRef(_, mt) => mt.ty,
498 debug!("cat_expr_unadjusted: return type of overloaded index is {:?}?",
504 // The call to index() returns a `&T` value, which
505 // is an rvalue. That is what we will be
507 let base_cmt = self.cat_rvalue_node(expr.id(), expr.span(), ret_ty);
508 self.cat_deref_common(expr, base_cmt, 1, elem_ty, Some(context), true)
511 self.cat_index(expr, try!(self.cat_expr(&**base)), context)
516 hir::ExprPath(..) => {
517 let def = self.tcx().def_map.borrow().get(&expr.id).unwrap().full_def();
518 self.cat_def(expr.id, expr.span, expr_ty, def)
521 hir::ExprParen(ref e) => {
525 hir::ExprAddrOf(..) | hir::ExprCall(..) |
526 hir::ExprAssign(..) | hir::ExprAssignOp(..) |
527 hir::ExprClosure(..) | hir::ExprRet(..) |
528 hir::ExprUnary(..) | hir::ExprRange(..) |
529 hir::ExprMethodCall(..) | hir::ExprCast(..) |
530 hir::ExprVec(..) | hir::ExprTup(..) | hir::ExprIf(..) |
531 hir::ExprBinary(..) | hir::ExprWhile(..) |
532 hir::ExprBlock(..) | hir::ExprLoop(..) | hir::ExprMatch(..) |
533 hir::ExprLit(..) | hir::ExprBreak(..) |
534 hir::ExprAgain(..) | hir::ExprStruct(..) | hir::ExprRepeat(..) |
535 hir::ExprInlineAsm(..) | hir::ExprBox(..) => {
536 Ok(self.cat_rvalue_node(expr.id(), expr.span(), expr_ty))
541 pub fn cat_def(&self,
546 -> McResult<cmt<'tcx>> {
547 debug!("cat_def: id={} expr={:?} def={:?}",
551 def::DefStruct(..) | def::DefVariant(..) | def::DefConst(..) |
552 def::DefAssociatedConst(..) | def::DefFn(..) | def::DefMethod(..) => {
553 Ok(self.cat_rvalue_node(id, span, expr_ty))
555 def::DefMod(_) | def::DefForeignMod(_) | def::DefUse(_) |
556 def::DefTrait(_) | def::DefTy(..) | def::DefPrimTy(_) |
557 def::DefTyParam(..) | def::DefRegion(_) |
558 def::DefLabel(_) | def::DefSelfTy(..) |
559 def::DefAssociatedTy(..) => {
570 def::DefStatic(_, mutbl) => {
575 mutbl: if mutbl { McDeclared } else { McImmutable},
581 def::DefUpvar(var_id, fn_node_id) => {
582 let ty = try!(self.node_ty(fn_node_id));
584 ty::TyClosure(closure_id, _) => {
585 match self.typer.closure_kind(closure_id) {
587 self.cat_upvar(id, span, var_id, fn_node_id, kind)
590 self.tcx().sess.span_bug(
592 &*format!("No closure kind for {:?}", closure_id));
597 self.tcx().sess.span_bug(
599 &format!("Upvar of non-closure {} - {:?}",
606 def::DefLocal(vid) => {
611 mutbl: MutabilityCategory::from_local(self.tcx(), vid),
619 // Categorize an upvar, complete with invisible derefs of closure
620 // environment and upvar reference as appropriate.
625 fn_node_id: ast::NodeId,
626 kind: ty::ClosureKind)
627 -> McResult<cmt<'tcx>>
629 // An upvar can have up to 3 components. We translate first to a
630 // `cat_upvar`, which is itself a fiction -- it represents the reference to the
631 // field from the environment.
633 // `cat_upvar`. Next, we add a deref through the implicit
634 // environment pointer with an anonymous free region 'env and
635 // appropriate borrow kind for closure kinds that take self by
636 // reference. Finally, if the upvar was captured
637 // by-reference, we add a deref through that reference. The
638 // region of this reference is an inference variable 'up that
639 // was previously generated and recorded in the upvar borrow
640 // map. The borrow kind bk is inferred by based on how the
643 // This results in the following table for concrete closure
647 // ---------------+----------------------+-------------------------------
648 // Fn | copied -> &'env | upvar -> &'env -> &'up bk
649 // FnMut | copied -> &'env mut | upvar -> &'env mut -> &'up bk
650 // FnOnce | copied | upvar -> &'up bk
652 let upvar_id = ty::UpvarId { var_id: var_id,
653 closure_expr_id: fn_node_id };
654 let var_ty = try!(self.node_ty(var_id));
656 // Mutability of original variable itself
657 let var_mutbl = MutabilityCategory::from_local(self.tcx(), var_id);
659 // Construct the upvar. This represents access to the field
660 // from the environment (perhaps we should eventually desugar
661 // this field further, but it will do for now).
662 let cmt_result = cmt_ {
665 cat: cat_upvar(Upvar {id: upvar_id, kind: kind}),
671 // If this is a `FnMut` or `Fn` closure, then the above is
672 // conceptually a `&mut` or `&` reference, so we have to add a
674 let cmt_result = match kind {
675 ty::FnOnceClosureKind => {
678 ty::FnMutClosureKind => {
679 self.env_deref(id, span, upvar_id, var_mutbl, ty::MutBorrow, cmt_result)
681 ty::FnClosureKind => {
682 self.env_deref(id, span, upvar_id, var_mutbl, ty::ImmBorrow, cmt_result)
686 // If this is a by-ref capture, then the upvar we loaded is
687 // actually a reference, so we have to add an implicit deref
689 let upvar_id = ty::UpvarId { var_id: var_id,
690 closure_expr_id: fn_node_id };
691 let upvar_capture = self.typer.upvar_capture(upvar_id).unwrap();
692 let cmt_result = match upvar_capture {
693 ty::UpvarCapture::ByValue => {
696 ty::UpvarCapture::ByRef(upvar_borrow) => {
697 let ptr = BorrowedPtr(upvar_borrow.kind, upvar_borrow.region);
701 cat: cat_deref(Rc::new(cmt_result), 0, ptr),
702 mutbl: MutabilityCategory::from_borrow_kind(upvar_borrow.kind),
704 note: NoteUpvarRef(upvar_id)
709 let ret = Rc::new(cmt_result);
710 debug!("cat_upvar ret={:?}", ret);
717 upvar_id: ty::UpvarId,
718 upvar_mutbl: MutabilityCategory,
719 env_borrow_kind: ty::BorrowKind,
720 cmt_result: cmt_<'tcx>)
723 // Look up the node ID of the closure body so we can construct
724 // a free region within it
726 let fn_expr = match self.tcx().map.find(upvar_id.closure_expr_id) {
727 Some(ast_map::NodeExpr(e)) => e,
732 hir::ExprClosure(_, _, ref body) => body.id,
737 // Region of environment pointer
738 let env_region = ty::ReFree(ty::FreeRegion {
739 // The environment of a closure is guaranteed to
740 // outlive any bindings introduced in the body of the
742 scope: self.tcx().region_maps.item_extent(fn_body_id),
743 bound_region: ty::BrEnv
746 let env_ptr = BorrowedPtr(env_borrow_kind, env_region);
748 let var_ty = cmt_result.ty;
750 // We need to add the env deref. This means
751 // that the above is actually immutable and
752 // has a ref type. However, nothing should
753 // actually look at the type, so we can get
754 // away with stuffing a `TyError` in there
755 // instead of bothering to construct a proper
757 let cmt_result = cmt_ {
759 ty: self.tcx().types.err,
763 let mut deref_mutbl = MutabilityCategory::from_borrow_kind(env_borrow_kind);
765 // Issue #18335. If variable is declared as immutable, override the
766 // mutability from the environment and substitute an `&T` anyway.
768 McImmutable => { deref_mutbl = McImmutable; }
769 McDeclared | McInherited => { }
775 cat: cat_deref(Rc::new(cmt_result), 0, env_ptr),
778 note: NoteClosureEnv(upvar_id)
781 debug!("env_deref ret {:?}", ret);
786 /// Returns the lifetime of a temporary created by expr with id `id`.
787 /// This could be `'static` if `id` is part of a constant expression.
788 pub fn temporary_scope(&self, id: ast::NodeId) -> ty::Region {
789 match self.typer.temporary_scope(id) {
790 Some(scope) => ty::ReScope(scope),
795 pub fn cat_rvalue_node(&self,
800 let qualif = self.tcx().const_qualif_map.borrow().get(&id).cloned()
801 .unwrap_or(check_const::ConstQualif::NOT_CONST);
803 // Only promote `[T; 0]` before an RFC for rvalue promotions
805 let qualif = match expr_ty.sty {
806 ty::TyArray(_, 0) => qualif,
807 _ => check_const::ConstQualif::NOT_CONST
810 // Compute maximum lifetime of this rvalue. This is 'static if
811 // we can promote to a constant, otherwise equal to enclosing temp
813 let re = if qualif.intersects(check_const::ConstQualif::NON_STATIC_BORROWS) {
814 self.temporary_scope(id)
818 let ret = self.cat_rvalue(id, span, re, expr_ty);
819 debug!("cat_rvalue_node ret {:?}", ret);
823 pub fn cat_rvalue(&self,
826 temp_scope: ty::Region,
827 expr_ty: Ty<'tcx>) -> cmt<'tcx> {
828 let ret = Rc::new(cmt_ {
831 cat:cat_rvalue(temp_scope),
836 debug!("cat_rvalue ret {:?}", ret);
840 pub fn cat_field<N:ast_node>(&self,
846 let ret = Rc::new(cmt_ {
849 mutbl: base_cmt.mutbl.inherit(),
850 cat: cat_interior(base_cmt, InteriorField(NamedField(f_name))),
854 debug!("cat_field ret {:?}", ret);
858 pub fn cat_tup_field<N:ast_node>(&self,
864 let ret = Rc::new(cmt_ {
867 mutbl: base_cmt.mutbl.inherit(),
868 cat: cat_interior(base_cmt, InteriorField(PositionalField(f_idx))),
872 debug!("cat_tup_field ret {:?}", ret);
876 fn cat_deref<N:ast_node>(&self,
880 deref_context: DerefKindContext)
881 -> McResult<cmt<'tcx>> {
882 let method_call = ty::MethodCall {
884 autoderef: deref_cnt as u32
886 let method_ty = self.typer.node_method_ty(method_call);
888 debug!("cat_deref: method_call={:?} method_ty={:?}",
889 method_call, method_ty.map(|ty| ty));
891 let base_cmt = match method_ty {
894 self.tcx().no_late_bound_regions(&method_ty.fn_ret()).unwrap().unwrap();
895 self.cat_rvalue_node(node.id(), node.span(), ref_ty)
899 let base_cmt_ty = base_cmt.ty;
900 match base_cmt_ty.builtin_deref(true, ty::NoPreference) {
902 let ret = self.cat_deref_common(node, base_cmt, deref_cnt,
905 /* implicit: */ false);
906 debug!("cat_deref ret {:?}", ret);
910 debug!("Explicit deref of non-derefable type: {:?}",
917 fn cat_deref_common<N:ast_node>(&self,
922 deref_context: DerefKindContext,
924 -> McResult<cmt<'tcx>>
926 let (m, cat) = match try!(deref_kind(base_cmt.ty, deref_context)) {
928 let ptr = if implicit {
930 BorrowedPtr(bk, r) => Implicit(bk, r),
931 _ => self.tcx().sess.span_bug(node.span(),
932 "Implicit deref of non-borrowed pointer")
937 // for unique ptrs, we inherit mutability from the
939 (MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr),
940 cat_deref(base_cmt, deref_cnt, ptr))
942 deref_interior(interior) => {
943 (base_cmt.mutbl.inherit(), cat_interior(base_cmt, interior))
946 let ret = Rc::new(cmt_ {
954 debug!("cat_deref_common ret {:?}", ret);
958 pub fn cat_index<N:ast_node>(&self,
960 mut base_cmt: cmt<'tcx>,
961 context: InteriorOffsetKind)
962 -> McResult<cmt<'tcx>> {
963 //! Creates a cmt for an indexing operation (`[]`).
965 //! One subtle aspect of indexing that may not be
966 //! immediately obvious: for anything other than a fixed-length
967 //! vector, an operation like `x[y]` actually consists of two
968 //! disjoint (from the point of view of borrowck) operations.
969 //! The first is a deref of `x` to create a pointer `p` that points
970 //! at the first element in the array. The second operation is
971 //! an index which adds `y*sizeof(T)` to `p` to obtain the
972 //! pointer to `x[y]`. `cat_index` will produce a resulting
973 //! cmt containing both this deref and the indexing,
974 //! presuming that `base_cmt` is not of fixed-length type.
977 //! - `elt`: the AST node being indexed
978 //! - `base_cmt`: the cmt of `elt`
980 let method_call = ty::MethodCall::expr(elt.id());
981 let method_ty = self.typer.node_method_ty(method_call);
983 let element_ty = match method_ty {
985 let ref_ty = self.overloaded_method_return_ty(method_ty);
986 base_cmt = self.cat_rvalue_node(elt.id(), elt.span(), ref_ty);
988 // FIXME(#20649) -- why are we using the `self_ty` as the element type...?
989 let self_ty = method_ty.fn_sig().input(0);
990 self.tcx().no_late_bound_regions(&self_ty).unwrap()
993 match base_cmt.ty.builtin_index() {
1002 let m = base_cmt.mutbl.inherit();
1003 let ret = interior(elt, base_cmt.clone(), base_cmt.ty,
1004 m, context, element_ty);
1005 debug!("cat_index ret {:?}", ret);
1008 fn interior<'tcx, N: ast_node>(elt: &N,
1011 mutbl: MutabilityCategory,
1012 context: InteriorOffsetKind,
1013 element_ty: Ty<'tcx>) -> cmt<'tcx>
1015 let interior_elem = InteriorElement(context, element_kind(vec_ty));
1019 cat:cat_interior(of_cmt, interior_elem),
1027 // Takes either a vec or a reference to a vec and returns the cmt for the
1029 fn deref_vec<N:ast_node>(&self,
1031 base_cmt: cmt<'tcx>,
1032 context: InteriorOffsetKind)
1033 -> McResult<cmt<'tcx>>
1035 let ret = match try!(deref_kind(base_cmt.ty, Some(context))) {
1037 // for unique ptrs, we inherit mutability from the
1038 // owning reference.
1039 let m = MutabilityCategory::from_pointer_kind(base_cmt.mutbl, ptr);
1041 // the deref is explicit in the resulting cmt
1045 cat:cat_deref(base_cmt.clone(), 0, ptr),
1047 ty: match base_cmt.ty.builtin_deref(false, ty::NoPreference) {
1049 None => self.tcx().sess.bug("Found non-derefable type")
1055 deref_interior(_) => {
1059 debug!("deref_vec ret {:?}", ret);
1063 /// Given a pattern P like: `[_, ..Q, _]`, where `vec_cmt` is the cmt for `P`, `slice_pat` is
1064 /// the pattern `Q`, returns:
1067 /// * the mutability and region of the slice `Q`
1069 /// These last two bits of info happen to be things that borrowck needs.
1070 pub fn cat_slice_pattern(&self,
1072 slice_pat: &hir::Pat)
1073 -> McResult<(cmt<'tcx>, hir::Mutability, ty::Region)> {
1074 let slice_ty = try!(self.node_ty(slice_pat.id));
1075 let (slice_mutbl, slice_r) = vec_slice_info(self.tcx(),
1078 let context = InteriorOffsetKind::Pattern;
1079 let cmt_vec = try!(self.deref_vec(slice_pat, vec_cmt, context));
1080 let cmt_slice = try!(self.cat_index(slice_pat, cmt_vec, context));
1081 return Ok((cmt_slice, slice_mutbl, slice_r));
1083 /// In a pattern like [a, b, ..c], normally `c` has slice type, but if you have [a, b,
1084 /// ..ref c], then the type of `ref c` will be `&&[]`, so to extract the slice details we
1085 /// have to recurse through rptrs.
1086 fn vec_slice_info(tcx: &ty::ctxt,
1089 -> (hir::Mutability, ty::Region) {
1090 match slice_ty.sty {
1091 ty::TyRef(r, ref mt) => match mt.ty.sty {
1092 ty::TySlice(_) => (mt.mutbl, *r),
1093 _ => vec_slice_info(tcx, pat, mt.ty),
1097 tcx.sess.span_bug(pat.span,
1098 "type of slice pattern is not a slice");
1104 pub fn cat_imm_interior<N:ast_node>(&self,
1106 base_cmt: cmt<'tcx>,
1107 interior_ty: Ty<'tcx>,
1108 interior: InteriorKind)
1110 let ret = Rc::new(cmt_ {
1113 mutbl: base_cmt.mutbl.inherit(),
1114 cat: cat_interior(base_cmt, interior),
1118 debug!("cat_imm_interior ret={:?}", ret);
1122 pub fn cat_downcast<N:ast_node>(&self,
1124 base_cmt: cmt<'tcx>,
1125 downcast_ty: Ty<'tcx>,
1128 let ret = Rc::new(cmt_ {
1131 mutbl: base_cmt.mutbl.inherit(),
1132 cat: cat_downcast(base_cmt, variant_did),
1136 debug!("cat_downcast ret={:?}", ret);
1140 pub fn cat_pattern<F>(&self, cmt: cmt<'tcx>, pat: &hir::Pat, mut op: F) -> McResult<()>
1141 where F: FnMut(&MemCategorizationContext<'t, 'a, 'tcx>, cmt<'tcx>, &hir::Pat),
1143 self.cat_pattern_(cmt, pat, &mut op)
1146 // FIXME(#19596) This is a workaround, but there should be a better way to do this
1147 fn cat_pattern_<F>(&self, cmt: cmt<'tcx>, pat: &hir::Pat, op: &mut F)
1149 where F : FnMut(&MemCategorizationContext<'t, 'a, 'tcx>, cmt<'tcx>, &hir::Pat),
1151 // Here, `cmt` is the categorization for the value being
1152 // matched and pat is the pattern it is being matched against.
1154 // In general, the way that this works is that we walk down
1155 // the pattern, constructing a cmt that represents the path
1156 // that will be taken to reach the value being matched.
1158 // When we encounter named bindings, we take the cmt that has
1159 // been built up and pass it off to guarantee_valid() so that
1160 // we can be sure that the binding will remain valid for the
1161 // duration of the arm.
1163 // (*2) There is subtlety concerning the correspondence between
1164 // pattern ids and types as compared to *expression* ids and
1165 // types. This is explained briefly. on the definition of the
1166 // type `cmt`, so go off and read what it says there, then
1167 // come back and I'll dive into a bit more detail here. :) OK,
1170 // In general, the id of the cmt should be the node that
1171 // "produces" the value---patterns aren't executable code
1172 // exactly, but I consider them to "execute" when they match a
1173 // value, and I consider them to produce the value that was
1174 // matched. So if you have something like:
1181 // In this case, the cmt and the relevant ids would be:
1183 // CMT Id Type of Id Type of cmt
1186 // ^~~~~~~^ `x` from discr @@int @@int
1187 // ^~~~~~~~~~^ `@@y` pattern node @@int @int
1188 // ^~~~~~~~~~~~~^ `@y` pattern node @int int
1190 // You can see that the types of the id and the cmt are in
1191 // sync in the first line, because that id is actually the id
1192 // of an expression. But once we get to pattern ids, the types
1193 // step out of sync again. So you'll see below that we always
1194 // get the type of the *subpattern* and use that.
1196 debug!("cat_pattern: {:?} cmt={:?}",
1200 (*op)(self, cmt.clone(), pat);
1202 let opt_def = self.tcx().def_map.borrow().get(&pat.id).map(|d| d.full_def());
1204 // Note: This goes up here (rather than within the PatEnum arm
1205 // alone) because struct patterns can refer to struct types or
1206 // to struct variants within enums.
1207 let cmt = match opt_def {
1208 Some(def::DefVariant(enum_did, variant_did, _))
1209 // univariant enums do not need downcasts
1210 if !self.tcx().lookup_adt_def(enum_did).is_univariant() => {
1211 self.cat_downcast(pat, cmt.clone(), cmt.ty, variant_did)
1217 hir::PatWild(_) => {
1221 hir::PatEnum(_, None) => {
1224 hir::PatEnum(_, Some(ref subpats)) => {
1226 Some(def::DefVariant(..)) => {
1228 for (i, subpat) in subpats.iter().enumerate() {
1229 let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1232 self.cat_imm_interior(
1233 pat, cmt.clone(), subpat_ty,
1234 InteriorField(PositionalField(i)));
1236 try!(self.cat_pattern_(subcmt, &**subpat, op));
1239 Some(def::DefStruct(..)) => {
1240 for (i, subpat) in subpats.iter().enumerate() {
1241 let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1243 self.cat_imm_interior(
1244 pat, cmt.clone(), subpat_ty,
1245 InteriorField(PositionalField(i)));
1246 try!(self.cat_pattern_(cmt_field, &**subpat, op));
1249 Some(def::DefConst(..)) | Some(def::DefAssociatedConst(..)) => {
1250 for subpat in subpats {
1251 try!(self.cat_pattern_(cmt.clone(), &**subpat, op));
1255 self.tcx().sess.span_bug(
1257 "enum pattern didn't resolve to enum or struct");
1262 hir::PatQPath(..) => {
1263 // Lone constant: ignore
1266 hir::PatIdent(_, _, Some(ref subpat)) => {
1267 try!(self.cat_pattern_(cmt, &**subpat, op));
1270 hir::PatIdent(_, _, None) => {
1271 // nullary variant or identifier: ignore
1274 hir::PatStruct(_, ref field_pats, _) => {
1275 // {f1: p1, ..., fN: pN}
1276 for fp in field_pats {
1277 let field_ty = try!(self.pat_ty(&*fp.node.pat)); // see (*2)
1278 let cmt_field = self.cat_field(pat, cmt.clone(), fp.node.ident.name, field_ty);
1279 try!(self.cat_pattern_(cmt_field, &*fp.node.pat, op));
1283 hir::PatTup(ref subpats) => {
1285 for (i, subpat) in subpats.iter().enumerate() {
1286 let subpat_ty = try!(self.pat_ty(&**subpat)); // see (*2)
1288 self.cat_imm_interior(
1289 pat, cmt.clone(), subpat_ty,
1290 InteriorField(PositionalField(i)));
1291 try!(self.cat_pattern_(subcmt, &**subpat, op));
1295 hir::PatBox(ref subpat) | hir::PatRegion(ref subpat, _) => {
1296 // box p1, &p1, &mut p1. we can ignore the mutability of
1297 // PatRegion since that information is already contained
1299 let subcmt = try!(self.cat_deref(pat, cmt, 0, None));
1300 try!(self.cat_pattern_(subcmt, &**subpat, op));
1303 hir::PatVec(ref before, ref slice, ref after) => {
1304 let context = InteriorOffsetKind::Pattern;
1305 let vec_cmt = try!(self.deref_vec(pat, cmt, context));
1306 let elt_cmt = try!(self.cat_index(pat, vec_cmt, context));
1307 for before_pat in before {
1308 try!(self.cat_pattern_(elt_cmt.clone(), &**before_pat, op));
1310 if let Some(ref slice_pat) = *slice {
1311 let slice_ty = try!(self.pat_ty(&**slice_pat));
1312 let slice_cmt = self.cat_rvalue_node(pat.id(), pat.span(), slice_ty);
1313 try!(self.cat_pattern_(slice_cmt, &**slice_pat, op));
1315 for after_pat in after {
1316 try!(self.cat_pattern_(elt_cmt.clone(), &**after_pat, op));
1320 hir::PatLit(_) | hir::PatRange(_, _) => {
1328 fn overloaded_method_return_ty(&self,
1329 method_ty: Ty<'tcx>)
1332 // When we process an overloaded `*` or `[]` etc, we often
1333 // need to extract the return type of the method. These method
1334 // types are generated by method resolution and always have
1335 // all late-bound regions fully instantiated, so we just want
1336 // to skip past the binder.
1337 self.tcx().no_late_bound_regions(&method_ty.fn_ret())
1339 .unwrap() // overloaded ops do not diverge, either
1343 #[derive(Clone, Debug)]
1344 pub enum Aliasability {
1345 FreelyAliasable(AliasableReason),
1347 ImmutableUnique(Box<Aliasability>),
1350 #[derive(Copy, Clone, Debug)]
1351 pub enum AliasableReason {
1353 AliasableClosure(ast::NodeId), // Aliasable due to capture Fn closure env
1355 UnaliasableImmutable, // Created as needed upon seeing ImmutableUnique
1360 impl<'tcx> cmt_<'tcx> {
1361 pub fn guarantor(&self) -> cmt<'tcx> {
1362 //! Returns `self` after stripping away any derefs or
1363 //! interior content. The return value is basically the `cmt` which
1364 //! determines how long the value in `self` remains live.
1370 cat_deref(_, _, UnsafePtr(..)) |
1371 cat_deref(_, _, BorrowedPtr(..)) |
1372 cat_deref(_, _, Implicit(..)) |
1374 Rc::new((*self).clone())
1376 cat_downcast(ref b, _) |
1377 cat_interior(ref b, _) |
1378 cat_deref(ref b, _, Unique) => {
1384 /// Returns `FreelyAliasable(_)` if this lvalue represents a freely aliasable pointer type.
1385 pub fn freely_aliasable(&self, ctxt: &ty::ctxt<'tcx>)
1387 // Maybe non-obvious: copied upvars can only be considered
1388 // non-aliasable in once closures, since any other kind can be
1389 // aliased and eventually recused.
1392 cat_deref(ref b, _, BorrowedPtr(ty::MutBorrow, _)) |
1393 cat_deref(ref b, _, Implicit(ty::MutBorrow, _)) |
1394 cat_deref(ref b, _, BorrowedPtr(ty::UniqueImmBorrow, _)) |
1395 cat_deref(ref b, _, Implicit(ty::UniqueImmBorrow, _)) |
1396 cat_downcast(ref b, _) |
1397 cat_interior(ref b, _) => {
1398 // Aliasability depends on base cmt
1399 b.freely_aliasable(ctxt)
1402 cat_deref(ref b, _, Unique) => {
1403 let sub = b.freely_aliasable(ctxt);
1404 if b.mutbl.is_mutable() {
1405 // Aliasability depends on base cmt alone
1408 // Do not allow mutation through an immutable box.
1409 ImmutableUnique(Box::new(sub))
1416 cat_deref(_, _, UnsafePtr(..)) => { // yes, it's aliasable, but...
1420 cat_static_item(..) => {
1421 if self.mutbl.is_mutable() {
1422 FreelyAliasable(AliasableStaticMut)
1424 FreelyAliasable(AliasableStatic)
1428 cat_deref(ref base, _, BorrowedPtr(ty::ImmBorrow, _)) |
1429 cat_deref(ref base, _, Implicit(ty::ImmBorrow, _)) => {
1431 cat_upvar(Upvar{ id, .. }) =>
1432 FreelyAliasable(AliasableClosure(id.closure_expr_id)),
1433 _ => FreelyAliasable(AliasableBorrowed)
1439 // Digs down through one or two layers of deref and grabs the cmt
1440 // for the upvar if a note indicates there is one.
1441 pub fn upvar(&self) -> Option<cmt<'tcx>> {
1443 NoteClosureEnv(..) | NoteUpvarRef(..) => {
1444 Some(match self.cat {
1445 cat_deref(ref inner, _, _) => {
1447 cat_deref(ref inner, _, _) => inner.clone(),
1448 cat_upvar(..) => inner.clone(),
1460 pub fn descriptive_string(&self, tcx: &ty::ctxt) -> String {
1462 cat_static_item => {
1463 "static item".to_string()
1466 "non-lvalue".to_string()
1469 match tcx.map.find(vid) {
1470 Some(ast_map::NodeArg(_)) => {
1471 "argument".to_string()
1473 _ => "local variable".to_string()
1476 cat_deref(_, _, pk) => {
1477 let upvar = self.upvar();
1478 match upvar.as_ref().map(|i| &i.cat) {
1479 Some(&cat_upvar(ref var)) => {
1482 Some(_) => unreachable!(),
1486 format!("indexed content")
1489 format!("`Box` content")
1492 format!("dereference of raw pointer")
1494 BorrowedPtr(..) => {
1495 format!("borrowed content")
1501 cat_interior(_, InteriorField(NamedField(_))) => {
1504 cat_interior(_, InteriorField(PositionalField(_))) => {
1505 "anonymous field".to_string()
1507 cat_interior(_, InteriorElement(InteriorOffsetKind::Index,
1509 cat_interior(_, InteriorElement(InteriorOffsetKind::Index,
1511 "indexed content".to_string()
1513 cat_interior(_, InteriorElement(InteriorOffsetKind::Pattern,
1515 cat_interior(_, InteriorElement(InteriorOffsetKind::Pattern,
1517 "pattern-bound indexed content".to_string()
1519 cat_upvar(ref var) => {
1522 cat_downcast(ref cmt, _) => {
1523 cmt.descriptive_string(tcx)
1529 impl<'tcx> fmt::Debug for cmt_<'tcx> {
1530 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1531 write!(f, "{{{:?} id:{} m:{:?} ty:{:?}}}",
1539 impl<'tcx> fmt::Debug for categorization<'tcx> {
1540 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1542 cat_static_item => write!(f, "static"),
1543 cat_rvalue(r) => write!(f, "rvalue({:?})", r),
1545 let name = ty::tls::with(|tcx| tcx.local_var_name_str(id));
1546 write!(f, "local({})", name)
1548 cat_upvar(upvar) => {
1549 write!(f, "upvar({:?})", upvar)
1551 cat_deref(ref cmt, derefs, ptr) => {
1552 write!(f, "{:?}-{:?}{}->", cmt.cat, ptr, derefs)
1554 cat_interior(ref cmt, interior) => {
1555 write!(f, "{:?}.{:?}", cmt.cat, interior)
1557 cat_downcast(ref cmt, _) => {
1558 write!(f, "{:?}->(enum)", cmt.cat)
1564 pub fn ptr_sigil(ptr: PointerKind) -> &'static str {
1567 BorrowedPtr(ty::ImmBorrow, _) |
1568 Implicit(ty::ImmBorrow, _) => "&",
1569 BorrowedPtr(ty::MutBorrow, _) |
1570 Implicit(ty::MutBorrow, _) => "&mut",
1571 BorrowedPtr(ty::UniqueImmBorrow, _) |
1572 Implicit(ty::UniqueImmBorrow, _) => "&unique",
1573 UnsafePtr(_) => "*",
1577 impl fmt::Debug for PointerKind {
1578 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1580 Unique => write!(f, "Box"),
1581 BorrowedPtr(ty::ImmBorrow, ref r) |
1582 Implicit(ty::ImmBorrow, ref r) => {
1583 write!(f, "&{:?}", r)
1585 BorrowedPtr(ty::MutBorrow, ref r) |
1586 Implicit(ty::MutBorrow, ref r) => {
1587 write!(f, "&{:?} mut", r)
1589 BorrowedPtr(ty::UniqueImmBorrow, ref r) |
1590 Implicit(ty::UniqueImmBorrow, ref r) => {
1591 write!(f, "&{:?} uniq", r)
1593 UnsafePtr(_) => write!(f, "*")
1598 impl fmt::Debug for InteriorKind {
1599 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1601 InteriorField(NamedField(fld)) => write!(f, "{}", fld),
1602 InteriorField(PositionalField(i)) => write!(f, "#{}", i),
1603 InteriorElement(..) => write!(f, "[]"),
1608 fn element_kind(t: Ty) -> ElementKind {
1610 ty::TyRef(_, ty::TypeAndMut{ty, ..}) |
1611 ty::TyBox(ty) => match ty.sty {
1612 ty::TySlice(_) => VecElement,
1615 ty::TyArray(..) | ty::TySlice(_) => VecElement,
1620 impl fmt::Debug for Upvar {
1621 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1622 write!(f, "{:?}/{:?}", self.id, self.kind)
1626 impl fmt::Display for Upvar {
1627 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1628 let kind = match self.kind {
1629 ty::FnClosureKind => "Fn",
1630 ty::FnMutClosureKind => "FnMut",
1631 ty::FnOnceClosureKind => "FnOnce",
1633 write!(f, "captured outer variable in an `{}` closure", kind)