1 // Copyright 2012-2013 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.
11 // ----------------------------------------------------------------------
14 // Phase 2 of check: we walk down the tree and check that:
15 // 1. assignments are always made to mutable locations;
16 // 2. loans made in overlapping scopes do not conflict
17 // 3. assignments do not affect things loaned out as immutable
18 // 4. moves do not affect things loaned out in any way
19 use self::UseError::*;
22 use borrowck::InteriorKind::{InteriorElement, InteriorField};
23 use rustc::middle::expr_use_visitor as euv;
24 use rustc::middle::expr_use_visitor::MutateMode;
25 use rustc::middle::mem_categorization as mc;
26 use rustc::middle::mem_categorization::Categorization;
27 use rustc::middle::region;
28 use rustc::ty::{self, TyCtxt};
35 // FIXME (#16118): These functions are intended to allow the borrow checker to
36 // be less precise in its handling of Box while still allowing moves out of a
37 // Box. They should be removed when Unique is removed from LoanPath.
39 fn owned_ptr_base_path<'a, 'tcx>(loan_path: &'a LoanPath<'tcx>) -> &'a LoanPath<'tcx> {
40 //! Returns the base of the leftmost dereference of an Unique in
41 //! `loan_path`. If there is no dereference of an Unique in `loan_path`,
42 //! then it just returns `loan_path` itself.
44 return match helper(loan_path) {
45 Some(new_loan_path) => new_loan_path,
46 None => loan_path.clone()
49 fn helper<'a, 'tcx>(loan_path: &'a LoanPath<'tcx>) -> Option<&'a LoanPath<'tcx>> {
50 match loan_path.kind {
51 LpVar(_) | LpUpvar(_) => None,
52 LpExtend(ref lp_base, _, LpDeref(mc::Unique)) => {
53 match helper(&lp_base) {
55 None => Some(&lp_base)
58 LpDowncast(ref lp_base, _) |
59 LpExtend(ref lp_base, ..) => helper(&lp_base)
64 fn owned_ptr_base_path_rc<'tcx>(loan_path: &Rc<LoanPath<'tcx>>) -> Rc<LoanPath<'tcx>> {
65 //! The equivalent of `owned_ptr_base_path` for an &Rc<LoanPath> rather than
68 return match helper(loan_path) {
69 Some(new_loan_path) => new_loan_path,
70 None => loan_path.clone()
73 fn helper<'tcx>(loan_path: &Rc<LoanPath<'tcx>>) -> Option<Rc<LoanPath<'tcx>>> {
74 match loan_path.kind {
75 LpVar(_) | LpUpvar(_) => None,
76 LpExtend(ref lp_base, _, LpDeref(mc::Unique)) => {
77 match helper(lp_base) {
79 None => Some(lp_base.clone())
82 LpDowncast(ref lp_base, _) |
83 LpExtend(ref lp_base, ..) => helper(lp_base)
88 struct CheckLoanCtxt<'a, 'tcx: 'a> {
89 bccx: &'a BorrowckCtxt<'a, 'tcx>,
90 dfcx_loans: &'a LoanDataFlow<'a, 'tcx>,
91 move_data: &'a move_data::FlowedMoveData<'a, 'tcx>,
92 all_loans: &'a [Loan<'tcx>],
93 param_env: &'a ty::ParameterEnvironment<'tcx>,
96 impl<'a, 'tcx> euv::Delegate<'tcx> for CheckLoanCtxt<'a, 'tcx> {
98 consume_id: ast::NodeId,
101 mode: euv::ConsumeMode) {
102 debug!("consume(consume_id={}, cmt={:?}, mode={:?})",
103 consume_id, cmt, mode);
105 self.consume_common(consume_id, consume_span, cmt, mode);
108 fn matched_pat(&mut self,
109 _matched_pat: &hir::Pat,
111 _mode: euv::MatchMode) { }
113 fn consume_pat(&mut self,
114 consume_pat: &hir::Pat,
116 mode: euv::ConsumeMode) {
117 debug!("consume_pat(consume_pat={:?}, cmt={:?}, mode={:?})",
122 self.consume_common(consume_pat.id, consume_pat.span, cmt, mode);
126 borrow_id: ast::NodeId,
129 loan_region: ty::Region<'tcx>,
131 loan_cause: euv::LoanCause)
133 debug!("borrow(borrow_id={}, cmt={:?}, loan_region={:?}, \
134 bk={:?}, loan_cause={:?})",
135 borrow_id, cmt, loan_region,
138 if let Some(lp) = opt_loan_path(&cmt) {
139 let moved_value_use_kind = match loan_cause {
140 euv::ClosureCapture(_) => MovedInCapture,
143 self.check_if_path_is_moved(borrow_id, borrow_span, moved_value_use_kind, &lp);
146 self.check_for_conflicting_loans(borrow_id);
150 assignment_id: ast::NodeId,
151 assignment_span: Span,
152 assignee_cmt: mc::cmt<'tcx>,
153 mode: euv::MutateMode)
155 debug!("mutate(assignment_id={}, assignee_cmt={:?})",
156 assignment_id, assignee_cmt);
158 if let Some(lp) = opt_loan_path(&assignee_cmt) {
160 MutateMode::Init | MutateMode::JustWrite => {
161 // In a case like `path = 1`, then path does not
162 // have to be *FULLY* initialized, but we still
163 // must be careful lest it contains derefs of
165 self.check_if_assigned_path_is_moved(assignee_cmt.id,
170 MutateMode::WriteAndRead => {
171 // In a case like `path += 1`, then path must be
172 // fully initialized, since we will read it before
174 self.check_if_path_is_moved(assignee_cmt.id,
181 self.check_assignment(assignment_id, assignment_span, assignee_cmt);
184 fn decl_without_init(&mut self, _id: ast::NodeId, _span: Span) { }
187 pub fn check_loans<'a, 'b, 'c, 'tcx>(bccx: &BorrowckCtxt<'a, 'tcx>,
188 dfcx_loans: &LoanDataFlow<'b, 'tcx>,
189 move_data: &move_data::FlowedMoveData<'c, 'tcx>,
190 all_loans: &[Loan<'tcx>],
192 debug!("check_loans(body id={})", body.value.id);
194 let infcx = bccx.tcx.borrowck_fake_infer_ctxt(body.id());
195 let mut clcx = CheckLoanCtxt {
197 dfcx_loans: dfcx_loans,
198 move_data: move_data,
199 all_loans: all_loans,
200 param_env: &infcx.parameter_environment
202 euv::ExprUseVisitor::new(&mut clcx, &bccx.region_maps, &infcx).consume_body(body);
206 enum UseError<'tcx> {
208 UseWhileBorrowed(/*loan*/Rc<LoanPath<'tcx>>, /*loan*/Span)
211 fn compatible_borrow_kinds(borrow_kind1: ty::BorrowKind,
212 borrow_kind2: ty::BorrowKind)
214 borrow_kind1 == ty::ImmBorrow && borrow_kind2 == ty::ImmBorrow
217 impl<'a, 'tcx> CheckLoanCtxt<'a, 'tcx> {
218 pub fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { self.bccx.tcx }
220 pub fn each_issued_loan<F>(&self, node: ast::NodeId, mut op: F) -> bool where
221 F: FnMut(&Loan<'tcx>) -> bool,
223 //! Iterates over each loan that has been issued
224 //! on entrance to `node`, regardless of whether it is
225 //! actually *in scope* at that point. Sometimes loans
226 //! are issued for future scopes and thus they may have been
227 //! *issued* but not yet be in effect.
229 self.dfcx_loans.each_bit_on_entry(node, |loan_index| {
230 let loan = &self.all_loans[loan_index];
235 pub fn each_in_scope_loan<F>(&self, scope: region::CodeExtent<'tcx>, mut op: F) -> bool where
236 F: FnMut(&Loan<'tcx>) -> bool,
238 //! Like `each_issued_loan()`, but only considers loans that are
239 //! currently in scope.
241 self.each_issued_loan(scope.node_id(), |loan| {
242 if self.bccx.region_maps.is_subscope_of(scope, loan.kill_scope) {
250 fn each_in_scope_loan_affecting_path<F>(&self,
251 scope: region::CodeExtent<'tcx>,
252 loan_path: &LoanPath<'tcx>,
255 F: FnMut(&Loan<'tcx>) -> bool,
257 //! Iterates through all of the in-scope loans affecting `loan_path`,
258 //! calling `op`, and ceasing iteration if `false` is returned.
260 // First, we check for a loan restricting the path P being used. This
261 // accounts for borrows of P but also borrows of subpaths, like P.a.b.
262 // Consider the following example:
264 // let x = &mut a.b.c; // Restricts a, a.b, and a.b.c
265 // let y = a; // Conflicts with restriction
267 let loan_path = owned_ptr_base_path(loan_path);
268 let cont = self.each_in_scope_loan(scope, |loan| {
270 for restr_path in &loan.restricted_paths {
271 if **restr_path == *loan_path {
285 // Next, we must check for *loans* (not restrictions) on the path P or
286 // any base path. This rejects examples like the following:
291 // Limiting this search to *loans* and not *restrictions* means that
292 // examples like the following continue to work:
297 let mut loan_path = loan_path;
299 match loan_path.kind {
300 LpVar(_) | LpUpvar(_) => {
303 LpDowncast(ref lp_base, _) |
304 LpExtend(ref lp_base, ..) => {
305 loan_path = &lp_base;
309 let cont = self.each_in_scope_loan(scope, |loan| {
310 if *loan.loan_path == *loan_path {
325 pub fn loans_generated_by(&self, node: ast::NodeId) -> Vec<usize> {
326 //! Returns a vector of the loans that are generated as
329 let mut result = Vec::new();
330 self.dfcx_loans.each_gen_bit(node, |loan_index| {
331 result.push(loan_index);
337 pub fn check_for_conflicting_loans(&self, node: ast::NodeId) {
338 //! Checks to see whether any of the loans that are issued
339 //! on entrance to `node` conflict with loans that have already been
340 //! issued when we enter `node` (for example, we do not
341 //! permit two `&mut` borrows of the same variable).
343 //! (Note that some loans can be *issued* without necessarily
344 //! taking effect yet.)
346 debug!("check_for_conflicting_loans(node={:?})", node);
348 let new_loan_indices = self.loans_generated_by(node);
349 debug!("new_loan_indices = {:?}", new_loan_indices);
351 for &new_loan_index in &new_loan_indices {
352 self.each_issued_loan(node, |issued_loan| {
353 let new_loan = &self.all_loans[new_loan_index];
354 // Only report an error for the first issued loan that conflicts
355 // to avoid O(n^2) errors.
356 self.report_error_if_loans_conflict(issued_loan, new_loan)
360 for (i, &x) in new_loan_indices.iter().enumerate() {
361 let old_loan = &self.all_loans[x];
362 for &y in &new_loan_indices[(i+1) ..] {
363 let new_loan = &self.all_loans[y];
364 self.report_error_if_loans_conflict(old_loan, new_loan);
369 pub fn report_error_if_loans_conflict(&self,
370 old_loan: &Loan<'tcx>,
371 new_loan: &Loan<'tcx>)
373 //! Checks whether `old_loan` and `new_loan` can safely be issued
376 debug!("report_error_if_loans_conflict(old_loan={:?}, new_loan={:?})",
380 // Should only be called for loans that are in scope at the same time.
381 assert!(self.bccx.region_maps.scopes_intersect(old_loan.kill_scope,
382 new_loan.kill_scope));
384 self.report_error_if_loan_conflicts_with_restriction(
385 old_loan, new_loan, old_loan, new_loan) &&
386 self.report_error_if_loan_conflicts_with_restriction(
387 new_loan, old_loan, old_loan, new_loan)
390 pub fn report_error_if_loan_conflicts_with_restriction(&self,
393 old_loan: &Loan<'tcx>,
394 new_loan: &Loan<'tcx>)
396 //! Checks whether the restrictions introduced by `loan1` would
397 //! prohibit `loan2`. Returns false if an error is reported.
399 debug!("report_error_if_loan_conflicts_with_restriction(\
400 loan1={:?}, loan2={:?})",
404 if compatible_borrow_kinds(loan1.kind, loan2.kind) {
408 let loan2_base_path = owned_ptr_base_path_rc(&loan2.loan_path);
409 for restr_path in &loan1.restricted_paths {
410 if *restr_path != loan2_base_path { continue; }
412 // If new_loan is something like `x.a`, and old_loan is something like `x.b`, we would
413 // normally generate a rather confusing message (in this case, for multiple mutable
416 // error: cannot borrow `x.b` as mutable more than once at a time
417 // note: previous borrow of `x.a` occurs here; the mutable borrow prevents
418 // subsequent moves, borrows, or modification of `x.a` until the borrow ends
420 // What we want to do instead is get the 'common ancestor' of the two borrow paths and
421 // use that for most of the message instead, giving is something like this:
423 // error: cannot borrow `x` as mutable more than once at a time
424 // note: previous borrow of `x` occurs here (through borrowing `x.a`); the mutable
425 // borrow prevents subsequent moves, borrows, or modification of `x` until the
428 let common = new_loan.loan_path.common(&old_loan.loan_path);
429 let (nl, ol, new_loan_msg, old_loan_msg) = {
430 if new_loan.loan_path.has_fork(&old_loan.loan_path) && common.is_some() {
431 let nl = self.bccx.loan_path_to_string(&common.unwrap());
433 let new_loan_msg = format!(" (via `{}`)",
434 self.bccx.loan_path_to_string(
435 &new_loan.loan_path));
436 let old_loan_msg = format!(" (via `{}`)",
437 self.bccx.loan_path_to_string(
438 &old_loan.loan_path));
439 (nl, ol, new_loan_msg, old_loan_msg)
441 (self.bccx.loan_path_to_string(&new_loan.loan_path),
442 self.bccx.loan_path_to_string(&old_loan.loan_path),
448 let ol_pronoun = if new_loan.loan_path == old_loan.loan_path {
454 // We want to assemble all the relevant locations for the error.
456 // 1. Where did the new loan occur.
457 // - if due to closure creation, where was the variable used in closure?
458 // 2. Where did old loan occur.
459 // 3. Where does old loan expire.
461 let previous_end_span =
462 self.tcx().hir.span(old_loan.kill_scope.node_id()).end_point();
464 let mut err = match (new_loan.kind, old_loan.kind) {
465 (ty::MutBorrow, ty::MutBorrow) => {
466 let mut err = struct_span_err!(self.bccx, new_loan.span, E0499,
467 "cannot borrow `{}`{} as mutable \
468 more than once at a time",
472 format!("first mutable borrow occurs here{}", old_loan_msg));
475 format!("second mutable borrow occurs here{}", new_loan_msg));
478 "first borrow ends here");
482 (ty::UniqueImmBorrow, ty::UniqueImmBorrow) => {
483 let mut err = struct_span_err!(self.bccx, new_loan.span, E0524,
484 "two closures require unique access to `{}` \
489 "first closure is constructed here");
492 "second closure is constructed here");
495 "borrow from first closure ends here");
499 (ty::UniqueImmBorrow, _) => {
500 let mut err = struct_span_err!(self.bccx, new_loan.span, E0500,
501 "closure requires unique access to `{}` \
502 but {} is already borrowed{}",
503 nl, ol_pronoun, old_loan_msg);
506 format!("closure construction occurs here{}", new_loan_msg));
509 format!("borrow occurs here{}", old_loan_msg));
516 (_, ty::UniqueImmBorrow) => {
517 let mut err = struct_span_err!(self.bccx, new_loan.span, E0501,
518 "cannot borrow `{}`{} as {} because \
519 previous closure requires unique access",
520 nl, new_loan_msg, new_loan.kind.to_user_str());
523 format!("borrow occurs here{}", new_loan_msg));
526 format!("closure construction occurs here{}", old_loan_msg));
529 "borrow from closure ends here");
534 let mut err = struct_span_err!(self.bccx, new_loan.span, E0502,
535 "cannot borrow `{}`{} as {} because \
536 {} is also borrowed as {}{}",
539 new_loan.kind.to_user_str(),
541 old_loan.kind.to_user_str(),
545 format!("{} borrow occurs here{}",
546 new_loan.kind.to_user_str(),
550 format!("{} borrow occurs here{}",
551 old_loan.kind.to_user_str(),
555 format!("{} borrow ends here",
556 old_loan.kind.to_user_str()));
561 match new_loan.cause {
562 euv::ClosureCapture(span) => {
565 format!("borrow occurs due to use of `{}` in closure", nl));
570 match old_loan.cause {
571 euv::ClosureCapture(span) => {
574 format!("previous borrow occurs due to use of `{}` in closure",
587 fn consume_common(&self,
591 mode: euv::ConsumeMode) {
592 if let Some(lp) = opt_loan_path(&cmt) {
593 let moved_value_use_kind = match mode {
595 self.check_for_copy_of_frozen_path(id, span, &lp);
599 match self.move_data.kind_of_move_of_path(id, &lp) {
601 // Sometimes moves don't have a move kind;
602 // this either means that the original move
603 // was from something illegal to move,
604 // or was moved from referent of an unsafe
605 // pointer or something like that.
609 self.check_for_move_of_borrowed_path(id, span,
611 if move_kind == move_data::Captured {
621 self.check_if_path_is_moved(id, span, moved_value_use_kind, &lp);
625 fn check_for_copy_of_frozen_path(&self,
628 copy_path: &LoanPath<'tcx>) {
629 match self.analyze_restrictions_on_use(id, copy_path, ty::ImmBorrow) {
631 UseWhileBorrowed(loan_path, loan_span) => {
632 struct_span_err!(self.bccx, span, E0503,
633 "cannot use `{}` because it was mutably borrowed",
634 &self.bccx.loan_path_to_string(copy_path))
635 .span_label(loan_span,
636 format!("borrow of `{}` occurs here",
637 &self.bccx.loan_path_to_string(&loan_path))
640 format!("use of borrowed `{}`",
641 &self.bccx.loan_path_to_string(&loan_path)))
647 fn check_for_move_of_borrowed_path(&self,
650 move_path: &LoanPath<'tcx>,
651 move_kind: move_data::MoveKind) {
652 // We want to detect if there are any loans at all, so we search for
653 // any loans incompatible with MutBorrrow, since all other kinds of
654 // loans are incompatible with that.
655 match self.analyze_restrictions_on_use(id, move_path, ty::MutBorrow) {
657 UseWhileBorrowed(loan_path, loan_span) => {
658 let mut err = match move_kind {
659 move_data::Captured => {
660 let mut err = struct_span_err!(self.bccx, span, E0504,
661 "cannot move `{}` into closure because it is borrowed",
662 &self.bccx.loan_path_to_string(move_path));
665 format!("borrow of `{}` occurs here",
666 &self.bccx.loan_path_to_string(&loan_path))
670 "move into closure occurs here"
674 move_data::Declared |
675 move_data::MoveExpr |
676 move_data::MovePat => {
677 let mut err = struct_span_err!(self.bccx, span, E0505,
678 "cannot move out of `{}` because it is borrowed",
679 &self.bccx.loan_path_to_string(move_path));
682 format!("borrow of `{}` occurs here",
683 &self.bccx.loan_path_to_string(&loan_path))
687 format!("move out of `{}` occurs here",
688 &self.bccx.loan_path_to_string(move_path))
699 pub fn analyze_restrictions_on_use(&self,
700 expr_id: ast::NodeId,
701 use_path: &LoanPath<'tcx>,
702 borrow_kind: ty::BorrowKind)
704 debug!("analyze_restrictions_on_use(expr_id={}, use_path={:?})",
705 self.tcx().hir.node_to_string(expr_id),
710 self.each_in_scope_loan_affecting_path(
711 self.tcx().node_extent(expr_id), use_path, |loan| {
712 if !compatible_borrow_kinds(loan.kind, borrow_kind) {
713 ret = UseWhileBorrowed(loan.loan_path.clone(), loan.span);
723 /// Reports an error if `expr` (which should be a path)
724 /// is using a moved/uninitialized value
725 fn check_if_path_is_moved(&self,
728 use_kind: MovedValueUseKind,
729 lp: &Rc<LoanPath<'tcx>>) {
730 debug!("check_if_path_is_moved(id={}, use_kind={:?}, lp={:?})",
733 // FIXME (22079): if you find yourself tempted to cut and paste
734 // the body below and then specializing the error reporting,
735 // consider refactoring this instead!
737 let base_lp = owned_ptr_base_path_rc(lp);
738 self.move_data.each_move_of(id, &base_lp, |the_move, moved_lp| {
739 self.bccx.report_use_of_moved_value(
750 /// Reports an error if assigning to `lp` will use a
751 /// moved/uninitialized value. Mainly this is concerned with
752 /// detecting derefs of uninitialized pointers.
758 /// a = 10; // ok, even though a is uninitialized
760 /// struct Point { x: u32, y: u32 }
762 /// p.x = 22; // ok, even though `p` is uninitialized
764 /// let p: Box<Point>;
765 /// (*p).x = 22; // not ok, p is uninitialized, can't deref
767 fn check_if_assigned_path_is_moved(&self,
770 use_kind: MovedValueUseKind,
771 lp: &Rc<LoanPath<'tcx>>)
774 LpVar(_) | LpUpvar(_) => {
775 // assigning to `x` does not require that `x` is initialized
777 LpDowncast(ref lp_base, _) => {
778 // assigning to `(P->Variant).f` is ok if assigning to `P` is ok
779 self.check_if_assigned_path_is_moved(id, span,
782 LpExtend(ref lp_base, _, LpInterior(_, InteriorField(_))) => {
783 match lp_base.to_type().sty {
784 ty::TyAdt(def, _) if def.has_dtor(self.tcx()) => {
785 // In the case where the owner implements drop, then
786 // the path must be initialized to prevent a case of
787 // partial reinitialization
789 // FIXME (22079): could refactor via hypothetical
790 // generalized check_if_path_is_moved
791 let loan_path = owned_ptr_base_path_rc(lp_base);
792 self.move_data.each_move_of(id, &loan_path, |_, _| {
794 .report_partial_reinitialization_of_uninitialized_structure(
804 // assigning to `P.f` is ok if assigning to `P` is ok
805 self.check_if_assigned_path_is_moved(id, span,
808 LpExtend(ref lp_base, _, LpInterior(_, InteriorElement(..))) |
809 LpExtend(ref lp_base, _, LpDeref(_)) => {
810 // assigning to `P[i]` requires `P` is initialized
811 // assigning to `(*P)` requires `P` is initialized
812 self.check_if_path_is_moved(id, span, use_kind, lp_base);
817 fn check_assignment(&self,
818 assignment_id: ast::NodeId,
819 assignment_span: Span,
820 assignee_cmt: mc::cmt<'tcx>) {
821 debug!("check_assignment(assignee_cmt={:?})", assignee_cmt);
823 // Check that we don't invalidate any outstanding loans
824 if let Some(loan_path) = opt_loan_path(&assignee_cmt) {
825 let scope = self.tcx().node_extent(assignment_id);
826 self.each_in_scope_loan_affecting_path(scope, &loan_path, |loan| {
827 self.report_illegal_mutation(assignment_span, &loan_path, loan);
832 // Check for reassignments to (immutable) local variables. This
833 // needs to be done here instead of in check_loans because we
834 // depend on move data.
835 if let Categorization::Local(local_id) = assignee_cmt.cat {
836 let lp = opt_loan_path(&assignee_cmt).unwrap();
837 self.move_data.each_assignment_of(assignment_id, &lp, |assign| {
838 if assignee_cmt.mutbl.is_mutable() {
839 self.tcx().used_mut_nodes.borrow_mut().insert(local_id);
841 self.bccx.report_reassigned_immutable_variable(
852 pub fn report_illegal_mutation(&self,
854 loan_path: &LoanPath<'tcx>,
856 struct_span_err!(self.bccx, span, E0506,
857 "cannot assign to `{}` because it is borrowed",
858 self.bccx.loan_path_to_string(loan_path))
859 .span_label(loan.span,
860 format!("borrow of `{}` occurs here",
861 self.bccx.loan_path_to_string(loan_path)))
863 format!("assignment to borrowed `{}` occurs here",
864 self.bccx.loan_path_to_string(loan_path)))