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.
11 // ----------------------------------------------------------------------
14 // The borrow check proceeds in two phases. In phase one, we gather the full
15 // set of loans that are required at any point. These are sorted according to
16 // their associated scopes. In phase two, checking loans, we will then make
17 // sure that all of these loans are honored.
20 use borrowck::move_data::MoveData;
21 use rustc::middle::expr_use_visitor as euv;
22 use rustc::middle::mem_categorization as mc;
23 use rustc::middle::mem_categorization::Categorization;
24 use rustc::middle::region;
25 use rustc::ty::{self, TyCtxt};
31 use self::restrictions::RestrictionResult;
38 pub fn gather_loans_in_fn<'a, 'tcx>(bccx: &BorrowckCtxt<'a, 'tcx>,
40 -> (Vec<Loan<'tcx>>, move_data::MoveData<'tcx>) {
41 let def_id = bccx.tcx.hir.body_owner_def_id(body);
42 let param_env = bccx.tcx.param_env(def_id);
43 let mut glcx = GatherLoanCtxt {
45 all_loans: Vec::new(),
46 item_ub: region::CodeExtent::Misc(body.node_id),
47 move_data: MoveData::new(),
48 move_error_collector: move_error::MoveErrorCollector::new(),
51 let body = glcx.bccx.tcx.hir.body(body);
52 euv::ExprUseVisitor::new(&mut glcx, bccx.tcx, param_env, &bccx.region_maps, bccx.tables)
55 glcx.report_potential_errors();
56 let GatherLoanCtxt { all_loans, move_data, .. } = glcx;
57 (all_loans, move_data)
60 struct GatherLoanCtxt<'a, 'tcx: 'a> {
61 bccx: &'a BorrowckCtxt<'a, 'tcx>,
62 move_data: move_data::MoveData<'tcx>,
63 move_error_collector: move_error::MoveErrorCollector<'tcx>,
64 all_loans: Vec<Loan<'tcx>>,
65 /// `item_ub` is used as an upper-bound on the lifetime whenever we
66 /// ask for the scope of an expression categorized as an upvar.
67 item_ub: region::CodeExtent,
70 impl<'a, 'tcx> euv::Delegate<'tcx> for GatherLoanCtxt<'a, 'tcx> {
72 consume_id: ast::NodeId,
75 mode: euv::ConsumeMode) {
76 debug!("consume(consume_id={}, cmt={:?}, mode={:?})",
77 consume_id, cmt, mode);
80 euv::Move(move_reason) => {
81 gather_moves::gather_move_from_expr(
82 self.bccx, &self.move_data, &mut self.move_error_collector,
83 consume_id, cmt, move_reason);
89 fn matched_pat(&mut self,
90 matched_pat: &hir::Pat,
92 mode: euv::MatchMode) {
93 debug!("matched_pat(matched_pat={:?}, cmt={:?}, mode={:?})",
98 if let Categorization::Downcast(..) = cmt.cat {
99 gather_moves::gather_match_variant(
100 self.bccx, &self.move_data, &mut self.move_error_collector,
101 matched_pat, cmt, mode);
105 fn consume_pat(&mut self,
106 consume_pat: &hir::Pat,
108 mode: euv::ConsumeMode) {
109 debug!("consume_pat(consume_pat={:?}, cmt={:?}, mode={:?})",
115 euv::Copy => { return; }
119 gather_moves::gather_move_from_pat(
120 self.bccx, &self.move_data, &mut self.move_error_collector,
125 borrow_id: ast::NodeId,
128 loan_region: ty::Region<'tcx>,
130 loan_cause: euv::LoanCause)
132 debug!("borrow(borrow_id={}, cmt={:?}, loan_region={:?}, \
133 bk={:?}, loan_cause={:?})",
134 borrow_id, cmt, loan_region,
137 self.guarantee_valid(borrow_id,
146 assignment_id: ast::NodeId,
147 assignment_span: Span,
148 assignee_cmt: mc::cmt<'tcx>,
149 mode: euv::MutateMode)
151 self.guarantee_assignment_valid(assignment_id,
157 fn decl_without_init(&mut self, id: ast::NodeId, _span: Span) {
160 .node_id_to_type(self.bccx.tcx.hir.node_to_hir_id(id));
161 gather_moves::gather_decl(self.bccx, &self.move_data, id, ty);
165 /// Implements the A-* rules in README.md.
166 fn check_aliasability<'a, 'tcx>(bccx: &BorrowckCtxt<'a, 'tcx>,
168 loan_cause: AliasableViolationKind,
170 req_kind: ty::BorrowKind)
173 let aliasability = cmt.freely_aliasable();
174 debug!("check_aliasability aliasability={:?} req_kind={:?}",
175 aliasability, req_kind);
177 match (aliasability, req_kind) {
178 (mc::Aliasability::NonAliasable, _) => {
179 /* Uniquely accessible path -- OK for `&` and `&mut` */
182 (mc::Aliasability::FreelyAliasable(mc::AliasableStatic), ty::ImmBorrow) => {
183 // Borrow of an immutable static item.
186 (mc::Aliasability::FreelyAliasable(mc::AliasableStaticMut), _) => {
187 // Even touching a static mut is considered unsafe. We assume the
188 // user knows what they're doing in these cases.
191 (mc::Aliasability::FreelyAliasable(alias_cause), ty::UniqueImmBorrow) |
192 (mc::Aliasability::FreelyAliasable(alias_cause), ty::MutBorrow) => {
193 bccx.report_aliasability_violation(
206 /// Implements the M-* rules in README.md.
207 fn check_mutability<'a, 'tcx>(bccx: &BorrowckCtxt<'a, 'tcx>,
209 cause: AliasableViolationKind,
211 req_kind: ty::BorrowKind)
213 debug!("check_mutability(cause={:?} cmt={:?} req_kind={:?}",
214 cause, cmt, req_kind);
216 ty::UniqueImmBorrow | ty::ImmBorrow => {
218 // I am intentionally leaving this here to help
219 // refactoring if, in the future, we should add new
220 // kinds of mutability.
221 mc::McImmutable | mc::McDeclared | mc::McInherited => {
222 // both imm and mut data can be lent as imm;
223 // for mutable data, this is a freeze
230 // Only mutable data can be lent as mutable.
231 if !cmt.mutbl.is_mutable() {
232 Err(bccx.report(BckError { span: borrow_span,
243 impl<'a, 'tcx> GatherLoanCtxt<'a, 'tcx> {
244 pub fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { self.bccx.tcx }
246 /// Guarantees that `cmt` is assignable, or reports an error.
247 fn guarantee_assignment_valid(&mut self,
248 assignment_id: ast::NodeId,
249 assignment_span: Span,
251 mode: euv::MutateMode) {
253 let opt_lp = opt_loan_path(&cmt);
254 debug!("guarantee_assignment_valid(assignment_id={}, cmt={:?}) opt_lp={:?}",
255 assignment_id, cmt, opt_lp);
257 if let Categorization::Local(..) = cmt.cat {
258 // Only re-assignments to locals require it to be
259 // mutable - this is checked in check_loans.
261 // Check that we don't allow assignments to non-mutable data.
262 if check_mutability(self.bccx, assignment_span, MutabilityViolation,
263 cmt.clone(), ty::MutBorrow).is_err() {
264 return; // reported an error, no sense in reporting more.
268 // Check that we don't allow assignments to aliasable data
269 if check_aliasability(self.bccx, assignment_span, MutabilityViolation,
270 cmt.clone(), ty::MutBorrow).is_err() {
271 return; // reported an error, no sense in reporting more.
276 if let Categorization::Local(..) = cmt.cat {
277 // Only re-assignments to locals require it to be
278 // mutable - this is checked in check_loans.
280 self.mark_loan_path_as_mutated(&lp);
282 gather_moves::gather_assignment(self.bccx, &self.move_data,
283 assignment_id, assignment_span,
287 // This can occur with e.g. `*foo() = 5`. In such
288 // cases, there is no need to check for conflicts
289 // with moves etc, just ignore.
294 /// Guarantees that `addr_of(cmt)` will be valid for the duration of `static_scope_r`, or
295 /// reports an error. This may entail taking out loans, which will be added to the
297 fn guarantee_valid(&mut self,
298 borrow_id: ast::NodeId,
301 req_kind: ty::BorrowKind,
302 loan_region: ty::Region<'tcx>,
303 cause: euv::LoanCause) {
304 debug!("guarantee_valid(borrow_id={}, cmt={:?}, \
305 req_mutbl={:?}, loan_region={:?})",
311 // a loan for the empty region can never be dereferenced, so
313 if *loan_region == ty::ReEmpty {
317 // Check that the lifetime of the borrow does not exceed
318 // the lifetime of the data being borrowed.
319 if lifetime::guarantee_lifetime(self.bccx, self.item_ub,
320 borrow_span, cause, cmt.clone(), loan_region,
322 return; // reported an error, no sense in reporting more.
325 // Check that we don't allow mutable borrows of non-mutable data.
326 if check_mutability(self.bccx, borrow_span, BorrowViolation(cause),
327 cmt.clone(), req_kind).is_err() {
328 return; // reported an error, no sense in reporting more.
331 // Check that we don't allow mutable borrows of aliasable data.
332 if check_aliasability(self.bccx, borrow_span, BorrowViolation(cause),
333 cmt.clone(), req_kind).is_err() {
334 return; // reported an error, no sense in reporting more.
337 // Compute the restrictions that are required to enforce the
339 let restr = restrictions::compute_restrictions(
340 self.bccx, borrow_span, cause,
341 cmt.clone(), loan_region);
343 debug!("guarantee_valid(): restrictions={:?}", restr);
345 // Create the loan record (if needed).
346 let loan = match restr {
347 RestrictionResult::Safe => {
348 // No restrictions---no loan record necessary
352 RestrictionResult::SafeIf(loan_path, restricted_paths) => {
353 let loan_scope = match *loan_region {
354 ty::ReScope(scope) => scope,
356 ty::ReEarlyBound(ref br) => {
357 self.bccx.region_maps.early_free_extent(self.tcx(), br)
360 ty::ReFree(ref fr) => {
361 self.bccx.region_maps.free_extent(self.tcx(), fr)
364 ty::ReStatic => self.item_ub,
367 ty::ReLateBound(..) |
369 ty::ReSkolemized(..) |
373 "invalid borrow lifetime: {:?}",
377 debug!("loan_scope = {:?}", loan_scope);
379 let borrow_scope = region::CodeExtent::Misc(borrow_id);
380 let gen_scope = self.compute_gen_scope(borrow_scope, loan_scope);
381 debug!("gen_scope = {:?}", gen_scope);
383 let kill_scope = self.compute_kill_scope(loan_scope, &loan_path);
384 debug!("kill_scope = {:?}", kill_scope);
386 if req_kind == ty::MutBorrow {
387 self.mark_loan_path_as_mutated(&loan_path);
391 index: self.all_loans.len(),
392 loan_path: loan_path,
394 gen_scope: gen_scope,
395 kill_scope: kill_scope,
397 restricted_paths: restricted_paths,
403 debug!("guarantee_valid(borrow_id={}), loan={:?}",
406 // let loan_path = loan.loan_path;
407 // let loan_gen_scope = loan.gen_scope;
408 // let loan_kill_scope = loan.kill_scope;
409 self.all_loans.push(loan);
411 // if loan_gen_scope != borrow_id {
412 // FIXME(#6268) Nested method calls
414 // Typically, the scope of the loan includes the point at
415 // which the loan is originated. This
416 // This is a subtle case. See the test case
417 // <compile-fail/borrowck-bad-nested-calls-free.rs>
418 // to see what we are guarding against.
420 //let restr = restrictions::compute_restrictions(
421 // self.bccx, borrow_span, cmt, RESTR_EMPTY);
423 // let all_loans = &mut *self.all_loans; // FIXME(#5074)
425 // index: all_loans.len(),
426 // loan_path: loan_path,
428 // mutbl: ConstMutability,
429 // gen_scope: borrow_id,
430 // kill_scope: kill_scope,
431 // span: borrow_span,
432 // restrictions: restrictions
437 pub fn mark_loan_path_as_mutated(&self, loan_path: &LoanPath) {
438 //! For mutable loans of content whose mutability derives
439 //! from a local variable, mark the mutability decl as necessary.
441 let mut wrapped_path = Some(loan_path);
442 let mut through_borrow = false;
444 while let Some(current_path) = wrapped_path {
445 wrapped_path = match current_path.kind {
448 self.tcx().used_mut_nodes.borrow_mut().insert(local_id);
452 LpUpvar(ty::UpvarId{ var_id: local_id, closure_expr_id: _ }) => {
453 self.tcx().used_mut_nodes.borrow_mut().insert(local_id);
456 LpExtend(ref base, mc::McInherited, LpDeref(pointer_kind)) |
457 LpExtend(ref base, mc::McDeclared, LpDeref(pointer_kind)) => {
458 if pointer_kind != mc::Unique {
459 through_borrow = true;
463 LpDowncast(ref base, _) |
464 LpExtend(ref base, mc::McInherited, _) |
465 LpExtend(ref base, mc::McDeclared, _) => {
468 LpExtend(_, mc::McImmutable, _) => {
477 pub fn compute_gen_scope(&self,
478 borrow_scope: region::CodeExtent,
479 loan_scope: region::CodeExtent)
480 -> region::CodeExtent {
481 //! Determine when to introduce the loan. Typically the loan
482 //! is introduced at the point of the borrow, but in some cases,
483 //! notably method arguments, the loan may be introduced only
484 //! later, once it comes into scope.
486 if self.bccx.region_maps.is_subscope_of(borrow_scope, loan_scope) {
493 pub fn compute_kill_scope(&self, loan_scope: region::CodeExtent, lp: &LoanPath<'tcx>)
494 -> region::CodeExtent {
495 //! Determine when the loan restrictions go out of scope.
496 //! This is either when the lifetime expires or when the
497 //! local variable which roots the loan-path goes out of scope,
498 //! whichever happens faster.
500 //! It may seem surprising that we might have a loan region
501 //! larger than the variable which roots the loan-path; this can
502 //! come about when variables of `&mut` type are re-borrowed,
503 //! as in this example:
505 //! struct Foo { counter: u32 }
507 //! fn counter<'a>(v: &'a mut Foo) -> &'a mut u32 {
511 //! In this case, the reference (`'a`) outlives the
512 //! variable `v` that hosts it. Note that this doesn't come up
513 //! with immutable `&` pointers, because borrows of such pointers
514 //! do not require restrictions and hence do not cause a loan.
516 let lexical_scope = lp.kill_scope(self.bccx);
517 if self.bccx.region_maps.is_subscope_of(lexical_scope, loan_scope) {
520 assert!(self.bccx.region_maps.is_subscope_of(loan_scope, lexical_scope));
525 pub fn report_potential_errors(&self) {
526 self.move_error_collector.report_potential_errors(self.bccx);