1 //! This query borrow-checks the MIR to (further) ensure it is not broken.
3 #![allow(rustc::potential_query_instability)]
4 #![feature(box_patterns)]
5 #![feature(let_chains)]
6 #![feature(min_specialization)]
7 #![feature(never_type)]
8 #![feature(rustc_attrs)]
9 #![feature(stmt_expr_attributes)]
10 #![feature(trusted_step)]
11 #![feature(try_blocks)]
12 #![recursion_limit = "256"]
15 extern crate rustc_middle;
19 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
20 use rustc_data_structures::graph::dominators::Dominators;
21 use rustc_data_structures::vec_map::VecMap;
22 use rustc_errors::{Diagnostic, DiagnosticBuilder};
24 use rustc_hir::def_id::LocalDefId;
25 use rustc_index::bit_set::ChunkedBitSet;
26 use rustc_index::vec::IndexVec;
27 use rustc_infer::infer::{DefiningAnchor, InferCtxt, TyCtxtInferExt};
28 use rustc_middle::mir::{
29 traversal, Body, ClearCrossCrate, Local, Location, Mutability, NonDivergingIntrinsic, Operand,
30 Place, PlaceElem, PlaceRef, VarDebugInfoContents,
32 use rustc_middle::mir::{AggregateKind, BasicBlock, BorrowCheckResult, BorrowKind};
33 use rustc_middle::mir::{Field, ProjectionElem, Promoted, Rvalue, Statement, StatementKind};
34 use rustc_middle::mir::{InlineAsmOperand, Terminator, TerminatorKind};
35 use rustc_middle::ty::query::Providers;
36 use rustc_middle::ty::{self, CapturedPlace, ParamEnv, RegionVid, TyCtxt};
37 use rustc_session::lint::builtin::UNUSED_MUT;
38 use rustc_span::{Span, Symbol};
41 use smallvec::SmallVec;
42 use std::cell::RefCell;
43 use std::collections::BTreeMap;
46 use rustc_mir_dataflow::impls::{
47 EverInitializedPlaces, MaybeInitializedPlaces, MaybeUninitializedPlaces,
49 use rustc_mir_dataflow::move_paths::{InitIndex, MoveOutIndex, MovePathIndex};
50 use rustc_mir_dataflow::move_paths::{InitLocation, LookupResult, MoveData, MoveError};
51 use rustc_mir_dataflow::Analysis;
52 use rustc_mir_dataflow::MoveDataParamEnv;
54 use crate::session_diagnostics::VarNeedNotMut;
56 use self::diagnostics::{AccessKind, RegionName};
57 use self::location::LocationTable;
58 use self::prefixes::PrefixSet;
61 use self::path_utils::*;
65 mod constraint_generation;
73 mod member_constraints;
81 mod session_diagnostics;
83 mod universal_regions;
86 /// A public API provided for the Rust compiler consumers.
89 use borrow_set::{BorrowData, BorrowSet};
90 use dataflow::{BorrowIndex, BorrowckFlowState as Flows, BorrowckResults, Borrows};
91 use nll::{PoloniusOutput, ToRegionVid};
92 use place_ext::PlaceExt;
93 use places_conflict::{places_conflict, PlaceConflictBias};
94 use region_infer::RegionInferenceContext;
96 // FIXME(eddyb) perhaps move this somewhere more centrally.
99 place: CapturedPlace<'tcx>,
101 /// If true, the capture is behind a reference.
105 /// Associate some local constants with the `'tcx` lifetime
106 struct TyCtxtConsts<'tcx>(TyCtxt<'tcx>);
107 impl<'tcx> TyCtxtConsts<'tcx> {
108 const DEREF_PROJECTION: &'tcx [PlaceElem<'tcx>; 1] = &[ProjectionElem::Deref];
111 pub fn provide(providers: &mut Providers) {
112 *providers = Providers {
113 mir_borrowck: |tcx, did| {
114 if let Some(def) = ty::WithOptConstParam::try_lookup(did, tcx) {
115 tcx.mir_borrowck_const_arg(def)
117 mir_borrowck(tcx, ty::WithOptConstParam::unknown(did))
120 mir_borrowck_const_arg: |tcx, (did, param_did)| {
121 mir_borrowck(tcx, ty::WithOptConstParam { did, const_param_did: Some(param_did) })
127 fn mir_borrowck(tcx: TyCtxt<'_>, def: ty::WithOptConstParam<LocalDefId>) -> &BorrowCheckResult<'_> {
128 let (input_body, promoted) = tcx.mir_promoted(def);
129 debug!("run query mir_borrowck: {}", tcx.def_path_str(def.did.to_def_id()));
131 if input_body.borrow().should_skip() {
132 debug!("Skipping borrowck because of injected body");
133 // Let's make up a borrowck result! Fun times!
134 let result = BorrowCheckResult {
135 concrete_opaque_types: VecMap::new(),
136 closure_requirements: None,
137 used_mut_upvars: SmallVec::new(),
138 tainted_by_errors: None,
140 return tcx.arena.alloc(result);
143 let hir_owner = tcx.hir().local_def_id_to_hir_id(def.did).owner;
146 tcx.infer_ctxt().with_opaque_type_inference(DefiningAnchor::Bind(hir_owner.def_id)).build();
147 let input_body: &Body<'_> = &input_body.borrow();
148 let promoted: &IndexVec<_, _> = &promoted.borrow();
149 let opt_closure_req = do_mir_borrowck(&infcx, input_body, promoted, false).0;
150 debug!("mir_borrowck done");
152 tcx.arena.alloc(opt_closure_req)
155 /// Perform the actual borrow checking.
157 /// If `return_body_with_facts` is true, then return the body with non-erased
158 /// region ids on which the borrow checking was performed together with Polonius
160 #[instrument(skip(infcx, input_body, input_promoted), fields(id=?input_body.source.with_opt_param().as_local().unwrap()), level = "debug")]
161 fn do_mir_borrowck<'tcx>(
162 infcx: &InferCtxt<'tcx>,
163 input_body: &Body<'tcx>,
164 input_promoted: &IndexVec<Promoted, Body<'tcx>>,
165 return_body_with_facts: bool,
166 ) -> (BorrowCheckResult<'tcx>, Option<Box<BodyWithBorrowckFacts<'tcx>>>) {
167 let def = input_body.source.with_opt_param().as_local().unwrap();
172 let param_env = tcx.param_env(def.did);
174 let mut local_names = IndexVec::from_elem(None, &input_body.local_decls);
175 for var_debug_info in &input_body.var_debug_info {
176 if let VarDebugInfoContents::Place(place) = var_debug_info.value {
177 if let Some(local) = place.as_local() {
178 if let Some(prev_name) = local_names[local] && var_debug_info.name != prev_name {
180 var_debug_info.source_info.span,
181 "local {:?} has many names (`{}` vs `{}`)",
187 local_names[local] = Some(var_debug_info.name);
192 let mut errors = error::BorrowckErrors::new(infcx.tcx);
194 // Gather the upvars of a closure, if any.
195 let tables = tcx.typeck_opt_const_arg(def);
196 if let Some(e) = tables.tainted_by_errors {
197 infcx.set_tainted_by_errors(e);
198 errors.set_tainted_by_errors(e);
200 let upvars: Vec<_> = tables
201 .closure_min_captures_flattened(def.did)
202 .map(|captured_place| {
203 let capture = captured_place.info.capture_kind;
204 let by_ref = match capture {
205 ty::UpvarCapture::ByValue => false,
206 ty::UpvarCapture::ByRef(..) => true,
208 Upvar { place: captured_place.clone(), by_ref }
212 // Replace all regions with fresh inference variables. This
213 // requires first making our own copy of the MIR. This copy will
214 // be modified (in place) to contain non-lexical lifetimes. It
215 // will have a lifetime tied to the inference context.
216 let mut body_owned = input_body.clone();
217 let mut promoted = input_promoted.clone();
219 nll::replace_regions_in_mir(infcx, param_env, &mut body_owned, &mut promoted);
220 let body = &body_owned; // no further changes
222 let location_table_owned = LocationTable::new(body);
223 let location_table = &location_table_owned;
225 let (move_data, move_errors): (MoveData<'tcx>, Vec<(Place<'tcx>, MoveError<'tcx>)>) =
226 match MoveData::gather_moves(&body, tcx, param_env) {
227 Ok((_, move_data)) => (move_data, Vec::new()),
228 Err((move_data, move_errors)) => (move_data, move_errors),
230 let promoted_errors = promoted
232 .map(|(idx, body)| (idx, MoveData::gather_moves(&body, tcx, param_env)));
234 let mdpe = MoveDataParamEnv { move_data, param_env };
236 let mut flow_inits = MaybeInitializedPlaces::new(tcx, &body, &mdpe)
237 .into_engine(tcx, &body)
238 .pass_name("borrowck")
239 .iterate_to_fixpoint()
240 .into_results_cursor(&body);
242 let locals_are_invalidated_at_exit = tcx.hir().body_owner_kind(def.did).is_fn_or_closure();
244 Rc::new(BorrowSet::build(tcx, body, locals_are_invalidated_at_exit, &mdpe.move_data));
246 let use_polonius = return_body_with_facts || infcx.tcx.sess.opts.unstable_opts.polonius;
248 // Compute non-lexical lifetimes.
256 } = nll::compute_regions(
270 // Dump MIR results into a file, if that is enabled. This let us
271 // write unit-tests, as well as helping with debugging.
272 nll::dump_mir_results(infcx, &body, ®ioncx, &opt_closure_req);
274 // We also have a `#[rustc_regions]` annotation that causes us to dump
276 nll::dump_annotation(
285 // The various `flow_*` structures can be large. We drop `flow_inits` here
286 // so it doesn't overlap with the others below. This reduces peak memory
287 // usage significantly on some benchmarks.
290 let regioncx = Rc::new(regioncx);
292 let flow_borrows = Borrows::new(tcx, body, ®ioncx, &borrow_set)
293 .into_engine(tcx, body)
294 .pass_name("borrowck")
295 .iterate_to_fixpoint();
296 let flow_uninits = MaybeUninitializedPlaces::new(tcx, body, &mdpe)
297 .into_engine(tcx, body)
298 .pass_name("borrowck")
299 .iterate_to_fixpoint();
300 let flow_ever_inits = EverInitializedPlaces::new(tcx, body, &mdpe)
301 .into_engine(tcx, body)
302 .pass_name("borrowck")
303 .iterate_to_fixpoint();
305 let movable_generator =
306 // The first argument is the generator type passed by value
307 if let Some(local) = body.local_decls.raw.get(1)
308 // Get the interior types and substs which typeck computed
309 && let ty::Generator(_, _, hir::Movability::Static) = local.ty.kind()
316 for (idx, move_data_results) in promoted_errors {
317 let promoted_body = &promoted[idx];
319 if let Err((move_data, move_errors)) = move_data_results {
320 let mut promoted_mbcx = MirBorrowckCtxt {
324 move_data: &move_data,
325 location_table, // no need to create a real one for the promoted, it is not used
327 fn_self_span_reported: Default::default(),
328 locals_are_invalidated_at_exit,
329 access_place_error_reported: Default::default(),
330 reservation_error_reported: Default::default(),
331 uninitialized_error_reported: Default::default(),
332 regioncx: regioncx.clone(),
333 used_mut: Default::default(),
334 used_mut_upvars: SmallVec::new(),
335 borrow_set: Rc::clone(&borrow_set),
336 dominators: Dominators::dummy(), // not used
338 local_names: IndexVec::from_elem(None, &promoted_body.local_decls),
339 region_names: RefCell::default(),
340 next_region_name: RefCell::new(1),
341 polonius_output: None,
344 promoted_mbcx.report_move_errors(move_errors);
345 errors = promoted_mbcx.errors;
349 let dominators = body.basic_blocks.dominators();
351 let mut mbcx = MirBorrowckCtxt {
355 move_data: &mdpe.move_data,
358 locals_are_invalidated_at_exit,
359 fn_self_span_reported: Default::default(),
360 access_place_error_reported: Default::default(),
361 reservation_error_reported: Default::default(),
362 uninitialized_error_reported: Default::default(),
363 regioncx: Rc::clone(®ioncx),
364 used_mut: Default::default(),
365 used_mut_upvars: SmallVec::new(),
366 borrow_set: Rc::clone(&borrow_set),
370 region_names: RefCell::default(),
371 next_region_name: RefCell::new(1),
376 // Compute and report region errors, if any.
377 mbcx.report_region_errors(nll_errors);
379 let results = BorrowckResults {
380 ever_inits: flow_ever_inits,
381 uninits: flow_uninits,
382 borrows: flow_borrows,
385 mbcx.report_move_errors(move_errors);
387 rustc_mir_dataflow::visit_results(
389 traversal::reverse_postorder(body).map(|(bb, _)| bb),
394 // For each non-user used mutable variable, check if it's been assigned from
395 // a user-declared local. If so, then put that local into the used_mut set.
396 // Note that this set is expected to be small - only upvars from closures
397 // would have a chance of erroneously adding non-user-defined mutable vars
399 let temporary_used_locals: FxHashSet<Local> = mbcx
402 .filter(|&local| !mbcx.body.local_decls[*local].is_user_variable())
405 // For the remaining unused locals that are marked as mutable, we avoid linting any that
406 // were never initialized. These locals may have been removed as unreachable code; or will be
407 // linted as unused variables.
408 let unused_mut_locals =
409 mbcx.body.mut_vars_iter().filter(|local| !mbcx.used_mut.contains(local)).collect();
410 mbcx.gather_used_muts(temporary_used_locals, unused_mut_locals);
412 debug!("mbcx.used_mut: {:?}", mbcx.used_mut);
413 let used_mut = std::mem::take(&mut mbcx.used_mut);
414 for local in mbcx.body.mut_vars_and_args_iter().filter(|local| !used_mut.contains(local)) {
415 let local_decl = &mbcx.body.local_decls[local];
416 let lint_root = match &mbcx.body.source_scopes[local_decl.source_info.scope].local_data {
417 ClearCrossCrate::Set(data) => data.lint_root,
421 // Skip over locals that begin with an underscore or have no name
422 match mbcx.local_names[local] {
424 if name.as_str().starts_with('_') {
431 let span = local_decl.source_info.span;
432 if span.desugaring_kind().is_some() {
433 // If the `mut` arises as part of a desugaring, we should ignore it.
437 let mut_span = tcx.sess.source_map().span_until_non_whitespace(span);
439 tcx.emit_spanned_lint(UNUSED_MUT, lint_root, span, VarNeedNotMut { span: mut_span })
442 let tainted_by_errors = mbcx.emit_errors();
444 let result = BorrowCheckResult {
445 concrete_opaque_types: opaque_type_values,
446 closure_requirements: opt_closure_req,
447 used_mut_upvars: mbcx.used_mut_upvars,
451 let body_with_facts = if return_body_with_facts {
452 let output_facts = mbcx.polonius_output.expect("Polonius output was not computed");
453 Some(Box::new(BodyWithBorrowckFacts {
455 input_facts: *polonius_input.expect("Polonius input facts were not generated"),
457 location_table: location_table_owned,
463 debug!("do_mir_borrowck: result = {:#?}", result);
465 (result, body_with_facts)
468 /// A `Body` with information computed by the borrow checker. This struct is
469 /// intended to be consumed by compiler consumers.
471 /// We need to include the MIR body here because the region identifiers must
472 /// match the ones in the Polonius facts.
473 pub struct BodyWithBorrowckFacts<'tcx> {
474 /// A mir body that contains region identifiers.
475 pub body: Body<'tcx>,
476 /// Polonius input facts.
477 pub input_facts: AllFacts,
478 /// Polonius output facts.
479 pub output_facts: Rc<self::nll::PoloniusOutput>,
480 /// The table that maps Polonius points to locations in the table.
481 pub location_table: LocationTable,
484 struct MirBorrowckCtxt<'cx, 'tcx> {
485 infcx: &'cx InferCtxt<'tcx>,
486 param_env: ParamEnv<'tcx>,
487 body: &'cx Body<'tcx>,
488 move_data: &'cx MoveData<'tcx>,
490 /// Map from MIR `Location` to `LocationIndex`; created
491 /// when MIR borrowck begins.
492 location_table: &'cx LocationTable,
494 movable_generator: bool,
495 /// This keeps track of whether local variables are free-ed when the function
496 /// exits even without a `StorageDead`, which appears to be the case for
499 /// I'm not sure this is the right approach - @eddyb could you try and
501 locals_are_invalidated_at_exit: bool,
502 /// This field keeps track of when borrow errors are reported in the access_place function
503 /// so that there is no duplicate reporting. This field cannot also be used for the conflicting
504 /// borrow errors that is handled by the `reservation_error_reported` field as the inclusion
505 /// of the `Span` type (while required to mute some errors) stops the muting of the reservation
507 access_place_error_reported: FxHashSet<(Place<'tcx>, Span)>,
508 /// This field keeps track of when borrow conflict errors are reported
509 /// for reservations, so that we don't report seemingly duplicate
510 /// errors for corresponding activations.
512 // FIXME: ideally this would be a set of `BorrowIndex`, not `Place`s,
513 // but it is currently inconvenient to track down the `BorrowIndex`
514 // at the time we detect and report a reservation error.
515 reservation_error_reported: FxHashSet<Place<'tcx>>,
516 /// This fields keeps track of the `Span`s that we have
517 /// used to report extra information for `FnSelfUse`, to avoid
518 /// unnecessarily verbose errors.
519 fn_self_span_reported: FxHashSet<Span>,
520 /// This field keeps track of errors reported in the checking of uninitialized variables,
521 /// so that we don't report seemingly duplicate errors.
522 uninitialized_error_reported: FxHashSet<PlaceRef<'tcx>>,
523 /// This field keeps track of all the local variables that are declared mut and are mutated.
524 /// Used for the warning issued by an unused mutable local variable.
525 used_mut: FxHashSet<Local>,
526 /// If the function we're checking is a closure, then we'll need to report back the list of
527 /// mutable upvars that have been used. This field keeps track of them.
528 used_mut_upvars: SmallVec<[Field; 8]>,
529 /// Region inference context. This contains the results from region inference and lets us e.g.
530 /// find out which CFG points are contained in each borrow region.
531 regioncx: Rc<RegionInferenceContext<'tcx>>,
533 /// The set of borrows extracted from the MIR
534 borrow_set: Rc<BorrowSet<'tcx>>,
536 /// Dominators for MIR
537 dominators: Dominators<BasicBlock>,
539 /// Information about upvars not necessarily preserved in types or MIR
540 upvars: Vec<Upvar<'tcx>>,
542 /// Names of local (user) variables (extracted from `var_debug_info`).
543 local_names: IndexVec<Local, Option<Symbol>>,
545 /// Record the region names generated for each region in the given
546 /// MIR def so that we can reuse them later in help/error messages.
547 region_names: RefCell<FxHashMap<RegionVid, RegionName>>,
549 /// The counter for generating new region names.
550 next_region_name: RefCell<usize>,
552 /// Results of Polonius analysis.
553 polonius_output: Option<Rc<PoloniusOutput>>,
555 errors: error::BorrowckErrors<'tcx>,
559 // 1. assignments are always made to mutable locations (FIXME: does that still really go here?)
560 // 2. loans made in overlapping scopes do not conflict
561 // 3. assignments do not affect things loaned out as immutable
562 // 4. moves do not affect things loaned out in any way
563 impl<'cx, 'tcx> rustc_mir_dataflow::ResultsVisitor<'cx, 'tcx> for MirBorrowckCtxt<'cx, 'tcx> {
564 type FlowState = Flows<'cx, 'tcx>;
566 fn visit_statement_before_primary_effect(
568 flow_state: &Flows<'cx, 'tcx>,
569 stmt: &'cx Statement<'tcx>,
572 debug!("MirBorrowckCtxt::process_statement({:?}, {:?}): {:?}", location, stmt, flow_state);
573 let span = stmt.source_info.span;
575 self.check_activations(location, span, flow_state);
578 StatementKind::Assign(box (lhs, rhs)) => {
579 self.consume_rvalue(location, (rhs, span), flow_state);
581 self.mutate_place(location, (*lhs, span), Shallow(None), flow_state);
583 StatementKind::FakeRead(box (_, place)) => {
584 // Read for match doesn't access any memory and is used to
585 // assert that a place is safe and live. So we don't have to
586 // do any checks here.
588 // FIXME: Remove check that the place is initialized. This is
589 // needed for now because matches don't have never patterns yet.
590 // So this is the only place we prevent
594 self.check_if_path_or_subpath_is_moved(
596 InitializationRequiringAction::Use,
597 (place.as_ref(), span),
601 StatementKind::Intrinsic(box kind) => match kind {
602 NonDivergingIntrinsic::Assume(op) => self.consume_operand(location, (op, span), flow_state),
603 NonDivergingIntrinsic::CopyNonOverlapping(..) => span_bug!(
605 "Unexpected CopyNonOverlapping, should only appear after lower_intrinsics",
608 // Only relevant for mir typeck
609 StatementKind::AscribeUserType(..)
610 // Doesn't have any language semantics
611 | StatementKind::Coverage(..)
612 // Does not actually affect borrowck
613 | StatementKind::StorageLive(..) => {}
614 StatementKind::StorageDead(local) => {
617 (Place::from(*local), span),
618 (Shallow(None), Write(WriteKind::StorageDeadOrDrop)),
619 LocalMutationIsAllowed::Yes,
624 | StatementKind::Retag { .. }
625 | StatementKind::Deinit(..)
626 | StatementKind::SetDiscriminant { .. } => {
627 bug!("Statement not allowed in this MIR phase")
632 fn visit_terminator_before_primary_effect(
634 flow_state: &Flows<'cx, 'tcx>,
635 term: &'cx Terminator<'tcx>,
638 debug!("MirBorrowckCtxt::process_terminator({:?}, {:?}): {:?}", loc, term, flow_state);
639 let span = term.source_info.span;
641 self.check_activations(loc, span, flow_state);
644 TerminatorKind::SwitchInt { discr, targets: _ } => {
645 self.consume_operand(loc, (discr, span), flow_state);
647 TerminatorKind::Drop { place, target: _, unwind: _ } => {
649 "visit_terminator_drop \
650 loc: {:?} term: {:?} place: {:?} span: {:?}",
651 loc, term, place, span
657 (AccessDepth::Drop, Write(WriteKind::StorageDeadOrDrop)),
658 LocalMutationIsAllowed::Yes,
662 TerminatorKind::DropAndReplace {
668 self.mutate_place(loc, (*drop_place, span), Deep, flow_state);
669 self.consume_operand(loc, (new_value, span), flow_state);
671 TerminatorKind::Call {
680 self.consume_operand(loc, (func, span), flow_state);
682 self.consume_operand(loc, (arg, span), flow_state);
684 self.mutate_place(loc, (*destination, span), Deep, flow_state);
686 TerminatorKind::Assert { cond, expected: _, msg, target: _, cleanup: _ } => {
687 self.consume_operand(loc, (cond, span), flow_state);
688 use rustc_middle::mir::AssertKind;
689 if let AssertKind::BoundsCheck { len, index } = msg {
690 self.consume_operand(loc, (len, span), flow_state);
691 self.consume_operand(loc, (index, span), flow_state);
695 TerminatorKind::Yield { value, resume: _, resume_arg, drop: _ } => {
696 self.consume_operand(loc, (value, span), flow_state);
697 self.mutate_place(loc, (*resume_arg, span), Deep, flow_state);
700 TerminatorKind::InlineAsm {
710 InlineAsmOperand::In { reg: _, value } => {
711 self.consume_operand(loc, (value, span), flow_state);
713 InlineAsmOperand::Out { reg: _, late: _, place, .. } => {
714 if let Some(place) = place {
715 self.mutate_place(loc, (*place, span), Shallow(None), flow_state);
718 InlineAsmOperand::InOut { reg: _, late: _, in_value, out_place } => {
719 self.consume_operand(loc, (in_value, span), flow_state);
720 if let &Some(out_place) = out_place {
729 InlineAsmOperand::Const { value: _ }
730 | InlineAsmOperand::SymFn { value: _ }
731 | InlineAsmOperand::SymStatic { def_id: _ } => {}
736 TerminatorKind::Goto { target: _ }
737 | TerminatorKind::Abort
738 | TerminatorKind::Unreachable
739 | TerminatorKind::Resume
740 | TerminatorKind::Return
741 | TerminatorKind::GeneratorDrop
742 | TerminatorKind::FalseEdge { real_target: _, imaginary_target: _ }
743 | TerminatorKind::FalseUnwind { real_target: _, unwind: _ } => {
744 // no data used, thus irrelevant to borrowck
749 fn visit_terminator_after_primary_effect(
751 flow_state: &Flows<'cx, 'tcx>,
752 term: &'cx Terminator<'tcx>,
755 let span = term.source_info.span;
758 TerminatorKind::Yield { value: _, resume: _, resume_arg: _, drop: _ } => {
759 if self.movable_generator {
760 // Look for any active borrows to locals
761 let borrow_set = self.borrow_set.clone();
762 for i in flow_state.borrows.iter() {
763 let borrow = &borrow_set[i];
764 self.check_for_local_borrow(borrow, span);
769 TerminatorKind::Resume | TerminatorKind::Return | TerminatorKind::GeneratorDrop => {
770 // Returning from the function implicitly kills storage for all locals and statics.
771 // Often, the storage will already have been killed by an explicit
772 // StorageDead, but we don't always emit those (notably on unwind paths),
773 // so this "extra check" serves as a kind of backup.
774 let borrow_set = self.borrow_set.clone();
775 for i in flow_state.borrows.iter() {
776 let borrow = &borrow_set[i];
777 self.check_for_invalidation_at_exit(loc, borrow, span);
781 TerminatorKind::Abort
782 | TerminatorKind::Assert { .. }
783 | TerminatorKind::Call { .. }
784 | TerminatorKind::Drop { .. }
785 | TerminatorKind::DropAndReplace { .. }
786 | TerminatorKind::FalseEdge { real_target: _, imaginary_target: _ }
787 | TerminatorKind::FalseUnwind { real_target: _, unwind: _ }
788 | TerminatorKind::Goto { .. }
789 | TerminatorKind::SwitchInt { .. }
790 | TerminatorKind::Unreachable
791 | TerminatorKind::InlineAsm { .. } => {}
796 use self::AccessDepth::{Deep, Shallow};
797 use self::ReadOrWrite::{Activation, Read, Reservation, Write};
799 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
800 enum ArtificialField {
805 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
807 /// From the RFC: "A *shallow* access means that the immediate
808 /// fields reached at P are accessed, but references or pointers
809 /// found within are not dereferenced. Right now, the only access
810 /// that is shallow is an assignment like `x = ...;`, which would
811 /// be a *shallow write* of `x`."
812 Shallow(Option<ArtificialField>),
814 /// From the RFC: "A *deep* access means that all data reachable
815 /// through the given place may be invalidated or accesses by
819 /// Access is Deep only when there is a Drop implementation that
820 /// can reach the data behind the reference.
824 /// Kind of access to a value: read or write
825 /// (For informational purposes only)
826 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
828 /// From the RFC: "A *read* means that the existing data may be
829 /// read, but will not be changed."
832 /// From the RFC: "A *write* means that the data may be mutated to
833 /// new values or otherwise invalidated (for example, it could be
834 /// de-initialized, as in a move operation).
837 /// For two-phase borrows, we distinguish a reservation (which is treated
838 /// like a Read) from an activation (which is treated like a write), and
839 /// each of those is furthermore distinguished from Reads/Writes above.
840 Reservation(WriteKind),
841 Activation(WriteKind, BorrowIndex),
844 /// Kind of read access to a value
845 /// (For informational purposes only)
846 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
852 /// Kind of write access to a value
853 /// (For informational purposes only)
854 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
857 MutableBorrow(BorrowKind),
862 /// When checking permissions for a place access, this flag is used to indicate that an immutable
863 /// local place can be mutated.
865 // FIXME: @nikomatsakis suggested that this flag could be removed with the following modifications:
866 // - Merge `check_access_permissions()` and `check_if_reassignment_to_immutable_state()`.
867 // - Split `is_mutable()` into `is_assignable()` (can be directly assigned) and
868 // `is_declared_mutable()`.
869 // - Take flow state into consideration in `is_assignable()` for local variables.
870 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
871 enum LocalMutationIsAllowed {
873 /// We want use of immutable upvars to cause a "write to immutable upvar"
874 /// error, not an "reassignment" error.
879 #[derive(Copy, Clone, Debug)]
880 enum InitializationRequiringAction {
888 struct RootPlace<'tcx> {
890 place_projection: &'tcx [PlaceElem<'tcx>],
891 is_local_mutation_allowed: LocalMutationIsAllowed,
894 impl InitializationRequiringAction {
895 fn as_noun(self) -> &'static str {
897 InitializationRequiringAction::Borrow => "borrow",
898 InitializationRequiringAction::MatchOn => "use", // no good noun
899 InitializationRequiringAction::Use => "use",
900 InitializationRequiringAction::Assignment => "assign",
901 InitializationRequiringAction::PartialAssignment => "assign to part",
905 fn as_verb_in_past_tense(self) -> &'static str {
907 InitializationRequiringAction::Borrow => "borrowed",
908 InitializationRequiringAction::MatchOn => "matched on",
909 InitializationRequiringAction::Use => "used",
910 InitializationRequiringAction::Assignment => "assigned",
911 InitializationRequiringAction::PartialAssignment => "partially assigned",
915 fn as_general_verb_in_past_tense(self) -> &'static str {
917 InitializationRequiringAction::Borrow
918 | InitializationRequiringAction::MatchOn
919 | InitializationRequiringAction::Use => "used",
920 InitializationRequiringAction::Assignment => "assigned",
921 InitializationRequiringAction::PartialAssignment => "partially assigned",
926 impl<'cx, 'tcx> MirBorrowckCtxt<'cx, 'tcx> {
927 fn body(&self) -> &'cx Body<'tcx> {
931 /// Checks an access to the given place to see if it is allowed. Examines the set of borrows
932 /// that are in scope, as well as which paths have been initialized, to ensure that (a) the
933 /// place is initialized and (b) it is not borrowed in some way that would prevent this
936 /// Returns `true` if an error is reported.
940 place_span: (Place<'tcx>, Span),
941 kind: (AccessDepth, ReadOrWrite),
942 is_local_mutation_allowed: LocalMutationIsAllowed,
943 flow_state: &Flows<'cx, 'tcx>,
947 if let Activation(_, borrow_index) = rw {
948 if self.reservation_error_reported.contains(&place_span.0) {
950 "skipping access_place for activation of invalid reservation \
951 place: {:?} borrow_index: {:?}",
952 place_span.0, borrow_index
958 // Check is_empty() first because it's the common case, and doing that
959 // way we avoid the clone() call.
960 if !self.access_place_error_reported.is_empty()
961 && self.access_place_error_reported.contains(&(place_span.0, place_span.1))
964 "access_place: suppressing error place_span=`{:?}` kind=`{:?}`",
970 let mutability_error = self.check_access_permissions(
973 is_local_mutation_allowed,
978 self.check_access_for_conflict(location, place_span, sd, rw, flow_state);
980 if conflict_error || mutability_error {
981 debug!("access_place: logging error place_span=`{:?}` kind=`{:?}`", place_span, kind);
982 self.access_place_error_reported.insert((place_span.0, place_span.1));
986 #[instrument(level = "debug", skip(self, flow_state))]
987 fn check_access_for_conflict(
990 place_span: (Place<'tcx>, Span),
993 flow_state: &Flows<'cx, 'tcx>,
995 let mut error_reported = false;
996 let tcx = self.infcx.tcx;
997 let body = self.body;
998 let borrow_set = self.borrow_set.clone();
1000 // Use polonius output if it has been enabled.
1001 let polonius_output = self.polonius_output.clone();
1002 let borrows_in_scope = if let Some(polonius) = &polonius_output {
1003 let location = self.location_table.start_index(location);
1004 Either::Left(polonius.errors_at(location).iter().copied())
1006 Either::Right(flow_state.borrows.iter())
1009 each_borrow_involving_path(
1017 |this, borrow_index, borrow| match (rw, borrow.kind) {
1018 // Obviously an activation is compatible with its own
1019 // reservation (or even prior activating uses of same
1020 // borrow); so don't check if they interfere.
1022 // NOTE: *reservations* do conflict with themselves;
1023 // thus aren't injecting unsoundness w/ this check.)
1024 (Activation(_, activating), _) if activating == borrow_index => {
1026 "check_access_for_conflict place_span: {:?} sd: {:?} rw: {:?} \
1027 skipping {:?} b/c activation of same borrow_index",
1031 (borrow_index, borrow),
1036 (Read(_), BorrowKind::Shared | BorrowKind::Shallow)
1038 Read(ReadKind::Borrow(BorrowKind::Shallow)),
1039 BorrowKind::Unique | BorrowKind::Mut { .. },
1040 ) => Control::Continue,
1042 (Reservation(_), BorrowKind::Shallow | BorrowKind::Shared) => {
1043 // This used to be a future compatibility warning (to be
1044 // disallowed on NLL). See rust-lang/rust#56254
1048 (Write(WriteKind::Move), BorrowKind::Shallow) => {
1049 // Handled by initialization checks.
1053 (Read(kind), BorrowKind::Unique | BorrowKind::Mut { .. }) => {
1054 // Reading from mere reservations of mutable-borrows is OK.
1055 if !is_active(&this.dominators, borrow, location) {
1056 assert!(allow_two_phase_borrow(borrow.kind));
1057 return Control::Continue;
1060 error_reported = true;
1064 .report_use_while_mutably_borrowed(location, place_span, borrow);
1065 this.buffer_error(err);
1067 ReadKind::Borrow(bk) => {
1069 this.report_conflicting_borrow(location, place_span, bk, borrow);
1070 this.buffer_error(err);
1076 (Reservation(kind) | Activation(kind, _) | Write(kind), _) => {
1078 Reservation(..) => {
1080 "recording invalid reservation of \
1084 this.reservation_error_reported.insert(place_span.0);
1086 Activation(_, activating) => {
1088 "observing check_place for activation of \
1089 borrow_index: {:?}",
1093 Read(..) | Write(..) => {}
1096 error_reported = true;
1098 WriteKind::MutableBorrow(bk) => {
1100 this.report_conflicting_borrow(location, place_span, bk, borrow);
1101 this.buffer_error(err);
1103 WriteKind::StorageDeadOrDrop => this
1104 .report_borrowed_value_does_not_live_long_enough(
1110 WriteKind::Mutate => {
1111 this.report_illegal_mutation_of_borrowed(location, place_span, borrow)
1113 WriteKind::Move => {
1114 this.report_move_out_while_borrowed(location, place_span, borrow)
1128 place_span: (Place<'tcx>, Span),
1130 flow_state: &Flows<'cx, 'tcx>,
1132 // Write of P[i] or *P requires P init'd.
1133 self.check_if_assigned_path_is_moved(location, place_span, flow_state);
1135 // Special case: you can assign an immutable local variable
1136 // (e.g., `x = ...`) so long as it has never been initialized
1137 // before (at this point in the flow).
1138 if let Some(local) = place_span.0.as_local() {
1139 if let Mutability::Not = self.body.local_decls[local].mutability {
1140 // check for reassignments to immutable local variables
1141 self.check_if_reassignment_to_immutable_state(
1142 location, local, place_span, flow_state,
1148 // Otherwise, use the normal access permission rules.
1152 (kind, Write(WriteKind::Mutate)),
1153 LocalMutationIsAllowed::No,
1161 (rvalue, span): (&'cx Rvalue<'tcx>, Span),
1162 flow_state: &Flows<'cx, 'tcx>,
1165 &Rvalue::Ref(_ /*rgn*/, bk, place) => {
1166 let access_kind = match bk {
1167 BorrowKind::Shallow => {
1168 (Shallow(Some(ArtificialField::ShallowBorrow)), Read(ReadKind::Borrow(bk)))
1170 BorrowKind::Shared => (Deep, Read(ReadKind::Borrow(bk))),
1171 BorrowKind::Unique | BorrowKind::Mut { .. } => {
1172 let wk = WriteKind::MutableBorrow(bk);
1173 if allow_two_phase_borrow(bk) {
1174 (Deep, Reservation(wk))
1185 LocalMutationIsAllowed::No,
1189 let action = if bk == BorrowKind::Shallow {
1190 InitializationRequiringAction::MatchOn
1192 InitializationRequiringAction::Borrow
1195 self.check_if_path_or_subpath_is_moved(
1198 (place.as_ref(), span),
1203 &Rvalue::AddressOf(mutability, place) => {
1204 let access_kind = match mutability {
1205 Mutability::Mut => (
1207 Write(WriteKind::MutableBorrow(BorrowKind::Mut {
1208 allow_two_phase_borrow: false,
1211 Mutability::Not => (Deep, Read(ReadKind::Borrow(BorrowKind::Shared))),
1218 LocalMutationIsAllowed::No,
1222 self.check_if_path_or_subpath_is_moved(
1224 InitializationRequiringAction::Borrow,
1225 (place.as_ref(), span),
1230 Rvalue::ThreadLocalRef(_) => {}
1232 Rvalue::Use(operand)
1233 | Rvalue::Repeat(operand, _)
1234 | Rvalue::UnaryOp(_ /*un_op*/, operand)
1235 | Rvalue::Cast(_ /*cast_kind*/, operand, _ /*ty*/)
1236 | Rvalue::ShallowInitBox(operand, _ /*ty*/) => {
1237 self.consume_operand(location, (operand, span), flow_state)
1240 &Rvalue::CopyForDeref(place) => {
1244 (Deep, Read(ReadKind::Copy)),
1245 LocalMutationIsAllowed::No,
1249 // Finally, check if path was already moved.
1250 self.check_if_path_or_subpath_is_moved(
1252 InitializationRequiringAction::Use,
1253 (place.as_ref(), span),
1258 &(Rvalue::Len(place) | Rvalue::Discriminant(place)) => {
1259 let af = match *rvalue {
1260 Rvalue::Len(..) => Some(ArtificialField::ArrayLength),
1261 Rvalue::Discriminant(..) => None,
1262 _ => unreachable!(),
1267 (Shallow(af), Read(ReadKind::Copy)),
1268 LocalMutationIsAllowed::No,
1271 self.check_if_path_or_subpath_is_moved(
1273 InitializationRequiringAction::Use,
1274 (place.as_ref(), span),
1279 Rvalue::BinaryOp(_bin_op, box (operand1, operand2))
1280 | Rvalue::CheckedBinaryOp(_bin_op, box (operand1, operand2)) => {
1281 self.consume_operand(location, (operand1, span), flow_state);
1282 self.consume_operand(location, (operand2, span), flow_state);
1285 Rvalue::NullaryOp(_op, _ty) => {
1286 // nullary ops take no dynamic input; no borrowck effect.
1289 Rvalue::Aggregate(aggregate_kind, operands) => {
1290 // We need to report back the list of mutable upvars that were
1291 // moved into the closure and subsequently used by the closure,
1292 // in order to populate our used_mut set.
1293 match **aggregate_kind {
1294 AggregateKind::Closure(def_id, _) | AggregateKind::Generator(def_id, _, _) => {
1295 let BorrowCheckResult { used_mut_upvars, .. } =
1296 self.infcx.tcx.mir_borrowck(def_id);
1297 debug!("{:?} used_mut_upvars={:?}", def_id, used_mut_upvars);
1298 for field in used_mut_upvars {
1299 self.propagate_closure_used_mut_upvar(&operands[field.index()]);
1302 AggregateKind::Adt(..)
1303 | AggregateKind::Array(..)
1304 | AggregateKind::Tuple { .. } => (),
1307 for operand in operands {
1308 self.consume_operand(location, (operand, span), flow_state);
1314 fn propagate_closure_used_mut_upvar(&mut self, operand: &Operand<'tcx>) {
1315 let propagate_closure_used_mut_place = |this: &mut Self, place: Place<'tcx>| {
1316 // We have three possibilities here:
1317 // a. We are modifying something through a mut-ref
1318 // b. We are modifying something that is local to our parent
1319 // c. Current body is a nested closure, and we are modifying path starting from
1320 // a Place captured by our parent closure.
1322 // Handle (c), the path being modified is exactly the path captured by our parent
1323 if let Some(field) = this.is_upvar_field_projection(place.as_ref()) {
1324 this.used_mut_upvars.push(field);
1328 for (place_ref, proj) in place.iter_projections().rev() {
1330 if proj == ProjectionElem::Deref {
1331 match place_ref.ty(this.body(), this.infcx.tcx).ty.kind() {
1332 // We aren't modifying a variable directly
1333 ty::Ref(_, _, hir::Mutability::Mut) => return,
1340 if let Some(field) = this.is_upvar_field_projection(place_ref) {
1341 this.used_mut_upvars.push(field);
1347 this.used_mut.insert(place.local);
1350 // This relies on the current way that by-value
1351 // captures of a closure are copied/moved directly
1352 // when generating MIR.
1354 Operand::Move(place) | Operand::Copy(place) => {
1355 match place.as_local() {
1356 Some(local) if !self.body.local_decls[local].is_user_variable() => {
1357 if self.body.local_decls[local].ty.is_mutable_ptr() {
1358 // The variable will be marked as mutable by the borrow.
1361 // This is an edge case where we have a `move` closure
1362 // inside a non-move closure, and the inner closure
1363 // contains a mutation:
1366 // || { move || { i += 1; }; };
1368 // In this case our usual strategy of assuming that the
1369 // variable will be captured by mutable reference is
1370 // wrong, since `i` can be copied into the inner
1371 // closure from a shared reference.
1373 // As such we have to search for the local that this
1374 // capture comes from and mark it as being used as mut.
1376 let temp_mpi = self.move_data.rev_lookup.find_local(local);
1377 let init = if let [init_index] = *self.move_data.init_path_map[temp_mpi] {
1378 &self.move_data.inits[init_index]
1380 bug!("temporary should be initialized exactly once")
1383 let InitLocation::Statement(loc) = init.location else {
1384 bug!("temporary initialized in arguments")
1387 let body = self.body;
1388 let bbd = &body[loc.block];
1389 let stmt = &bbd.statements[loc.statement_index];
1390 debug!("temporary assigned in: stmt={:?}", stmt);
1392 if let StatementKind::Assign(box (_, Rvalue::Ref(_, _, source))) = stmt.kind
1394 propagate_closure_used_mut_place(self, source);
1397 "closures should only capture user variables \
1398 or references to user variables"
1402 _ => propagate_closure_used_mut_place(self, place),
1405 Operand::Constant(..) => {}
1412 (operand, span): (&'cx Operand<'tcx>, Span),
1413 flow_state: &Flows<'cx, 'tcx>,
1416 Operand::Copy(place) => {
1417 // copy of place: check if this is "copy of frozen path"
1418 // (FIXME: see check_loans.rs)
1422 (Deep, Read(ReadKind::Copy)),
1423 LocalMutationIsAllowed::No,
1427 // Finally, check if path was already moved.
1428 self.check_if_path_or_subpath_is_moved(
1430 InitializationRequiringAction::Use,
1431 (place.as_ref(), span),
1435 Operand::Move(place) => {
1436 // move of place: check if this is move of already borrowed path
1440 (Deep, Write(WriteKind::Move)),
1441 LocalMutationIsAllowed::Yes,
1445 // Finally, check if path was already moved.
1446 self.check_if_path_or_subpath_is_moved(
1448 InitializationRequiringAction::Use,
1449 (place.as_ref(), span),
1453 Operand::Constant(_) => {}
1457 /// Checks whether a borrow of this place is invalidated when the function
1459 #[instrument(level = "debug", skip(self))]
1460 fn check_for_invalidation_at_exit(
1463 borrow: &BorrowData<'tcx>,
1466 let place = borrow.borrowed_place;
1467 let mut root_place = PlaceRef { local: place.local, projection: &[] };
1469 // FIXME(nll-rfc#40): do more precise destructor tracking here. For now
1470 // we just know that all locals are dropped at function exit (otherwise
1471 // we'll have a memory leak) and assume that all statics have a destructor.
1473 // FIXME: allow thread-locals to borrow other thread locals?
1475 let (might_be_alive, will_be_dropped) =
1476 if self.body.local_decls[root_place.local].is_ref_to_thread_local() {
1477 // Thread-locals might be dropped after the function exits
1478 // We have to dereference the outer reference because
1479 // borrows don't conflict behind shared references.
1480 root_place.projection = TyCtxtConsts::DEREF_PROJECTION;
1483 (false, self.locals_are_invalidated_at_exit)
1486 if !will_be_dropped {
1487 debug!("place_is_invalidated_at_exit({:?}) - won't be dropped", place);
1491 let sd = if might_be_alive { Deep } else { Shallow(None) };
1493 if places_conflict::borrow_conflicts_with_place(
1500 places_conflict::PlaceConflictBias::Overlap,
1502 debug!("check_for_invalidation_at_exit({:?}): INVALID", place);
1503 // FIXME: should be talking about the region lifetime instead
1504 // of just a span here.
1505 let span = self.infcx.tcx.sess.source_map().end_point(span);
1506 self.report_borrowed_value_does_not_live_long_enough(
1515 /// Reports an error if this is a borrow of local data.
1516 /// This is called for all Yield expressions on movable generators
1517 fn check_for_local_borrow(&mut self, borrow: &BorrowData<'tcx>, yield_span: Span) {
1518 debug!("check_for_local_borrow({:?})", borrow);
1520 if borrow_of_local_data(borrow.borrowed_place) {
1521 let err = self.cannot_borrow_across_generator_yield(
1522 self.retrieve_borrow_spans(borrow).var_or_use(),
1526 self.buffer_error(err);
1530 fn check_activations(&mut self, location: Location, span: Span, flow_state: &Flows<'cx, 'tcx>) {
1531 // Two-phase borrow support: For each activation that is newly
1532 // generated at this statement, check if it interferes with
1534 let borrow_set = self.borrow_set.clone();
1535 for &borrow_index in borrow_set.activations_at_location(location) {
1536 let borrow = &borrow_set[borrow_index];
1538 // only mutable borrows should be 2-phase
1539 assert!(match borrow.kind {
1540 BorrowKind::Shared | BorrowKind::Shallow => false,
1541 BorrowKind::Unique | BorrowKind::Mut { .. } => true,
1546 (borrow.borrowed_place, span),
1547 (Deep, Activation(WriteKind::MutableBorrow(borrow.kind), borrow_index)),
1548 LocalMutationIsAllowed::No,
1551 // We do not need to call `check_if_path_or_subpath_is_moved`
1552 // again, as we already called it when we made the
1553 // initial reservation.
1557 fn check_if_reassignment_to_immutable_state(
1561 place_span: (Place<'tcx>, Span),
1562 flow_state: &Flows<'cx, 'tcx>,
1564 debug!("check_if_reassignment_to_immutable_state({:?})", local);
1566 // Check if any of the initializations of `local` have happened yet:
1567 if let Some(init_index) = self.is_local_ever_initialized(local, flow_state) {
1568 // And, if so, report an error.
1569 let init = &self.move_data.inits[init_index];
1570 let span = init.span(&self.body);
1571 self.report_illegal_reassignment(location, place_span, span, place_span.0);
1575 fn check_if_full_path_is_moved(
1578 desired_action: InitializationRequiringAction,
1579 place_span: (PlaceRef<'tcx>, Span),
1580 flow_state: &Flows<'cx, 'tcx>,
1582 let maybe_uninits = &flow_state.uninits;
1586 // 1. Move of `a.b.c`, use of `a.b.c`
1587 // 2. Move of `a.b.c`, use of `a.b.c.d` (without first reinitializing `a.b.c.d`)
1588 // 3. Uninitialized `(a.b.c: &_)`, use of `*a.b.c`; note that with
1589 // partial initialization support, one might have `a.x`
1590 // initialized but not `a.b`.
1594 // 4. Move of `a.b.c`, use of `a.b.d`
1595 // 5. Uninitialized `a.x`, initialized `a.b`, use of `a.b`
1596 // 6. Copied `(a.b: &_)`, use of `*(a.b).c`; note that `a.b`
1597 // must have been initialized for the use to be sound.
1598 // 7. Move of `a.b.c` then reinit of `a.b.c.d`, use of `a.b.c.d`
1600 // The dataflow tracks shallow prefixes distinctly (that is,
1601 // field-accesses on P distinctly from P itself), in order to
1602 // track substructure initialization separately from the whole
1605 // E.g., when looking at (*a.b.c).d, if the closest prefix for
1606 // which we have a MovePath is `a.b`, then that means that the
1607 // initialization state of `a.b` is all we need to inspect to
1608 // know if `a.b.c` is valid (and from that we infer that the
1609 // dereference and `.d` access is also valid, since we assume
1610 // `a.b.c` is assigned a reference to an initialized and
1611 // well-formed record structure.)
1613 // Therefore, if we seek out the *closest* prefix for which we
1614 // have a MovePath, that should capture the initialization
1615 // state for the place scenario.
1617 // This code covers scenarios 1, 2, and 3.
1619 debug!("check_if_full_path_is_moved place: {:?}", place_span.0);
1620 let (prefix, mpi) = self.move_path_closest_to(place_span.0);
1621 if maybe_uninits.contains(mpi) {
1622 self.report_use_of_moved_or_uninitialized(
1625 (prefix, place_span.0, place_span.1),
1628 } // Only query longest prefix with a MovePath, not further
1629 // ancestors; dataflow recurs on children when parents
1630 // move (to support partial (re)inits).
1632 // (I.e., querying parents breaks scenario 7; but may want
1633 // to do such a query based on partial-init feature-gate.)
1636 /// Subslices correspond to multiple move paths, so we iterate through the
1637 /// elements of the base array. For each element we check
1639 /// * Does this element overlap with our slice.
1640 /// * Is any part of it uninitialized.
1641 fn check_if_subslice_element_is_moved(
1644 desired_action: InitializationRequiringAction,
1645 place_span: (PlaceRef<'tcx>, Span),
1646 maybe_uninits: &ChunkedBitSet<MovePathIndex>,
1650 if let Some(mpi) = self.move_path_for_place(place_span.0) {
1651 let move_paths = &self.move_data.move_paths;
1653 let root_path = &move_paths[mpi];
1654 for (child_mpi, child_move_path) in root_path.children(move_paths) {
1655 let last_proj = child_move_path.place.projection.last().unwrap();
1656 if let ProjectionElem::ConstantIndex { offset, from_end, .. } = last_proj {
1657 debug_assert!(!from_end, "Array constant indexing shouldn't be `from_end`.");
1659 if (from..to).contains(offset) {
1661 self.move_data.find_in_move_path_or_its_descendants(child_mpi, |mpi| {
1662 maybe_uninits.contains(mpi)
1665 if let Some(uninit_child) = uninit_child {
1666 self.report_use_of_moved_or_uninitialized(
1669 (place_span.0, place_span.0, place_span.1),
1672 return; // don't bother finding other problems.
1680 fn check_if_path_or_subpath_is_moved(
1683 desired_action: InitializationRequiringAction,
1684 place_span: (PlaceRef<'tcx>, Span),
1685 flow_state: &Flows<'cx, 'tcx>,
1687 let maybe_uninits = &flow_state.uninits;
1691 // 1. Move of `a.b.c`, use of `a` or `a.b`
1692 // partial initialization support, one might have `a.x`
1693 // initialized but not `a.b`.
1694 // 2. All bad scenarios from `check_if_full_path_is_moved`
1698 // 3. Move of `a.b.c`, use of `a.b.d`
1699 // 4. Uninitialized `a.x`, initialized `a.b`, use of `a.b`
1700 // 5. Copied `(a.b: &_)`, use of `*(a.b).c`; note that `a.b`
1701 // must have been initialized for the use to be sound.
1702 // 6. Move of `a.b.c` then reinit of `a.b.c.d`, use of `a.b.c.d`
1704 self.check_if_full_path_is_moved(location, desired_action, place_span, flow_state);
1706 if let Some((place_base, ProjectionElem::Subslice { from, to, from_end: false })) =
1707 place_span.0.last_projection()
1709 let place_ty = place_base.ty(self.body(), self.infcx.tcx);
1710 if let ty::Array(..) = place_ty.ty.kind() {
1711 self.check_if_subslice_element_is_moved(
1714 (place_base, place_span.1),
1723 // A move of any shallow suffix of `place` also interferes
1724 // with an attempt to use `place`. This is scenario 3 above.
1726 // (Distinct from handling of scenarios 1+2+4 above because
1727 // `place` does not interfere with suffixes of its prefixes,
1728 // e.g., `a.b.c` does not interfere with `a.b.d`)
1730 // This code covers scenario 1.
1732 debug!("check_if_path_or_subpath_is_moved place: {:?}", place_span.0);
1733 if let Some(mpi) = self.move_path_for_place(place_span.0) {
1734 let uninit_mpi = self
1736 .find_in_move_path_or_its_descendants(mpi, |mpi| maybe_uninits.contains(mpi));
1738 if let Some(uninit_mpi) = uninit_mpi {
1739 self.report_use_of_moved_or_uninitialized(
1742 (place_span.0, place_span.0, place_span.1),
1745 return; // don't bother finding other problems.
1750 /// Currently MoveData does not store entries for all places in
1751 /// the input MIR. For example it will currently filter out
1752 /// places that are Copy; thus we do not track places of shared
1753 /// reference type. This routine will walk up a place along its
1754 /// prefixes, searching for a foundational place that *is*
1755 /// tracked in the MoveData.
1757 /// An Err result includes a tag indicated why the search failed.
1758 /// Currently this can only occur if the place is built off of a
1759 /// static variable, as we do not track those in the MoveData.
1760 fn move_path_closest_to(&mut self, place: PlaceRef<'tcx>) -> (PlaceRef<'tcx>, MovePathIndex) {
1761 match self.move_data.rev_lookup.find(place) {
1762 LookupResult::Parent(Some(mpi)) | LookupResult::Exact(mpi) => {
1763 (self.move_data.move_paths[mpi].place.as_ref(), mpi)
1765 LookupResult::Parent(None) => panic!("should have move path for every Local"),
1769 fn move_path_for_place(&mut self, place: PlaceRef<'tcx>) -> Option<MovePathIndex> {
1770 // If returns None, then there is no move path corresponding
1771 // to a direct owner of `place` (which means there is nothing
1772 // that borrowck tracks for its analysis).
1774 match self.move_data.rev_lookup.find(place) {
1775 LookupResult::Parent(_) => None,
1776 LookupResult::Exact(mpi) => Some(mpi),
1780 fn check_if_assigned_path_is_moved(
1783 (place, span): (Place<'tcx>, Span),
1784 flow_state: &Flows<'cx, 'tcx>,
1786 debug!("check_if_assigned_path_is_moved place: {:?}", place);
1788 // None case => assigning to `x` does not require `x` be initialized.
1789 for (place_base, elem) in place.iter_projections().rev() {
1791 ProjectionElem::Index(_/*operand*/) |
1792 ProjectionElem::OpaqueCast(_) |
1793 ProjectionElem::ConstantIndex { .. } |
1794 // assigning to P[i] requires P to be valid.
1795 ProjectionElem::Downcast(_/*adt_def*/, _/*variant_idx*/) =>
1796 // assigning to (P->variant) is okay if assigning to `P` is okay
1798 // FIXME: is this true even if P is an adt with a dtor?
1801 // assigning to (*P) requires P to be initialized
1802 ProjectionElem::Deref => {
1803 self.check_if_full_path_is_moved(
1804 location, InitializationRequiringAction::Use,
1805 (place_base, span), flow_state);
1806 // (base initialized; no need to
1811 ProjectionElem::Subslice { .. } => {
1812 panic!("we don't allow assignments to subslices, location: {:?}",
1816 ProjectionElem::Field(..) => {
1817 // if type of `P` has a dtor, then
1818 // assigning to `P.f` requires `P` itself
1819 // be already initialized
1820 let tcx = self.infcx.tcx;
1821 let base_ty = place_base.ty(self.body(), tcx).ty;
1822 match base_ty.kind() {
1823 ty::Adt(def, _) if def.has_dtor(tcx) => {
1824 self.check_if_path_or_subpath_is_moved(
1825 location, InitializationRequiringAction::Assignment,
1826 (place_base, span), flow_state);
1828 // (base initialized; no need to
1833 // Once `let s; s.x = V; read(s.x);`,
1834 // is allowed, remove this match arm.
1835 ty::Adt(..) | ty::Tuple(..) => {
1836 check_parent_of_field(self, location, place_base, span, flow_state);
1838 // rust-lang/rust#21232, #54499, #54986: during period where we reject
1839 // partial initialization, do not complain about unnecessary `mut` on
1840 // an attempt to do a partial initialization.
1841 self.used_mut.insert(place.local);
1850 fn check_parent_of_field<'cx, 'tcx>(
1851 this: &mut MirBorrowckCtxt<'cx, 'tcx>,
1853 base: PlaceRef<'tcx>,
1855 flow_state: &Flows<'cx, 'tcx>,
1857 // rust-lang/rust#21232: Until Rust allows reads from the
1858 // initialized parts of partially initialized structs, we
1859 // will, starting with the 2018 edition, reject attempts
1860 // to write to structs that are not fully initialized.
1862 // In other words, *until* we allow this:
1864 // 1. `let mut s; s.x = Val; read(s.x);`
1866 // we will for now disallow this:
1868 // 2. `let mut s; s.x = Val;`
1872 // 3. `let mut s = ...; drop(s); s.x=Val;`
1874 // This does not use check_if_path_or_subpath_is_moved,
1875 // because we want to *allow* reinitializations of fields:
1876 // e.g., want to allow
1878 // `let mut s = ...; drop(s.x); s.x=Val;`
1880 // This does not use check_if_full_path_is_moved on
1881 // `base`, because that would report an error about the
1882 // `base` as a whole, but in this scenario we *really*
1883 // want to report an error about the actual thing that was
1884 // moved, which may be some prefix of `base`.
1886 // Shallow so that we'll stop at any dereference; we'll
1887 // report errors about issues with such bases elsewhere.
1888 let maybe_uninits = &flow_state.uninits;
1890 // Find the shortest uninitialized prefix you can reach
1891 // without going over a Deref.
1892 let mut shortest_uninit_seen = None;
1893 for prefix in this.prefixes(base, PrefixSet::Shallow) {
1894 let Some(mpi) = this.move_path_for_place(prefix) else { continue };
1896 if maybe_uninits.contains(mpi) {
1898 "check_parent_of_field updating shortest_uninit_seen from {:?} to {:?}",
1899 shortest_uninit_seen,
1902 shortest_uninit_seen = Some((prefix, mpi));
1904 debug!("check_parent_of_field {:?} is definitely initialized", (prefix, mpi));
1908 if let Some((prefix, mpi)) = shortest_uninit_seen {
1909 // Check for a reassignment into an uninitialized field of a union (for example,
1910 // after a move out). In this case, do not report an error here. There is an
1911 // exception, if this is the first assignment into the union (that is, there is
1912 // no move out from an earlier location) then this is an attempt at initialization
1913 // of the union - we should error in that case.
1914 let tcx = this.infcx.tcx;
1915 if base.ty(this.body(), tcx).ty.is_union() {
1916 if this.move_data.path_map[mpi].iter().any(|moi| {
1917 this.move_data.moves[*moi].source.is_predecessor_of(location, this.body)
1923 this.report_use_of_moved_or_uninitialized(
1925 InitializationRequiringAction::PartialAssignment,
1926 (prefix, base, span),
1933 /// Checks the permissions for the given place and read or write kind
1935 /// Returns `true` if an error is reported.
1936 fn check_access_permissions(
1938 (place, span): (Place<'tcx>, Span),
1940 is_local_mutation_allowed: LocalMutationIsAllowed,
1941 flow_state: &Flows<'cx, 'tcx>,
1945 "check_access_permissions({:?}, {:?}, is_local_mutation_allowed: {:?})",
1946 place, kind, is_local_mutation_allowed
1953 Reservation(WriteKind::MutableBorrow(
1954 borrow_kind @ (BorrowKind::Unique | BorrowKind::Mut { .. }),
1956 | Write(WriteKind::MutableBorrow(
1957 borrow_kind @ (BorrowKind::Unique | BorrowKind::Mut { .. }),
1959 let is_local_mutation_allowed = match borrow_kind {
1960 BorrowKind::Unique => LocalMutationIsAllowed::Yes,
1961 BorrowKind::Mut { .. } => is_local_mutation_allowed,
1962 BorrowKind::Shared | BorrowKind::Shallow => unreachable!(),
1964 match self.is_mutable(place.as_ref(), is_local_mutation_allowed) {
1966 self.add_used_mut(root_place, flow_state);
1970 error_access = AccessKind::MutableBorrow;
1971 the_place_err = place_err;
1975 Reservation(WriteKind::Mutate) | Write(WriteKind::Mutate) => {
1976 match self.is_mutable(place.as_ref(), is_local_mutation_allowed) {
1978 self.add_used_mut(root_place, flow_state);
1982 error_access = AccessKind::Mutate;
1983 the_place_err = place_err;
1990 | WriteKind::StorageDeadOrDrop
1991 | WriteKind::MutableBorrow(BorrowKind::Shared)
1992 | WriteKind::MutableBorrow(BorrowKind::Shallow),
1996 | WriteKind::StorageDeadOrDrop
1997 | WriteKind::MutableBorrow(BorrowKind::Shared)
1998 | WriteKind::MutableBorrow(BorrowKind::Shallow),
2000 if self.is_mutable(place.as_ref(), is_local_mutation_allowed).is_err()
2001 && !self.has_buffered_errors()
2003 // rust-lang/rust#46908: In pure NLL mode this code path should be
2004 // unreachable, but we use `delay_span_bug` because we can hit this when
2005 // dereferencing a non-Copy raw pointer *and* have `-Ztreat-err-as-bug`
2006 // enabled. We don't want to ICE for that case, as other errors will have
2007 // been emitted (#52262).
2008 self.infcx.tcx.sess.delay_span_bug(
2011 "Accessing `{:?}` with the kind `{:?}` shouldn't be possible",
2019 // permission checks are done at Reservation point.
2025 | BorrowKind::Mut { .. }
2026 | BorrowKind::Shared
2027 | BorrowKind::Shallow,
2031 // Access authorized
2036 // rust-lang/rust#21232, #54986: during period where we reject
2037 // partial initialization, do not complain about mutability
2038 // errors except for actual mutation (as opposed to an attempt
2039 // to do a partial initialization).
2040 let previously_initialized =
2041 self.is_local_ever_initialized(place.local, flow_state).is_some();
2043 // at this point, we have set up the error reporting state.
2044 if previously_initialized {
2045 self.report_mutability_error(place, span, the_place_err, error_access, location);
2052 fn is_local_ever_initialized(
2055 flow_state: &Flows<'cx, 'tcx>,
2056 ) -> Option<InitIndex> {
2057 let mpi = self.move_data.rev_lookup.find_local(local);
2058 let ii = &self.move_data.init_path_map[mpi];
2059 ii.into_iter().find(|&&index| flow_state.ever_inits.contains(index)).copied()
2062 /// Adds the place into the used mutable variables set
2063 fn add_used_mut(&mut self, root_place: RootPlace<'tcx>, flow_state: &Flows<'cx, 'tcx>) {
2065 RootPlace { place_local: local, place_projection: [], is_local_mutation_allowed } => {
2066 // If the local may have been initialized, and it is now currently being
2067 // mutated, then it is justified to be annotated with the `mut`
2068 // keyword, since the mutation may be a possible reassignment.
2069 if is_local_mutation_allowed != LocalMutationIsAllowed::Yes
2070 && self.is_local_ever_initialized(local, flow_state).is_some()
2072 self.used_mut.insert(local);
2077 place_projection: _,
2078 is_local_mutation_allowed: LocalMutationIsAllowed::Yes,
2082 place_projection: place_projection @ [.., _],
2083 is_local_mutation_allowed: _,
2085 if let Some(field) = self.is_upvar_field_projection(PlaceRef {
2087 projection: place_projection,
2089 self.used_mut_upvars.push(field);
2095 /// Whether this value can be written or borrowed mutably.
2096 /// Returns the root place if the place passed in is a projection.
2099 place: PlaceRef<'tcx>,
2100 is_local_mutation_allowed: LocalMutationIsAllowed,
2101 ) -> Result<RootPlace<'tcx>, PlaceRef<'tcx>> {
2102 debug!("is_mutable: place={:?}, is_local...={:?}", place, is_local_mutation_allowed);
2103 match place.last_projection() {
2105 let local = &self.body.local_decls[place.local];
2106 match local.mutability {
2107 Mutability::Not => match is_local_mutation_allowed {
2108 LocalMutationIsAllowed::Yes => Ok(RootPlace {
2109 place_local: place.local,
2110 place_projection: place.projection,
2111 is_local_mutation_allowed: LocalMutationIsAllowed::Yes,
2113 LocalMutationIsAllowed::ExceptUpvars => Ok(RootPlace {
2114 place_local: place.local,
2115 place_projection: place.projection,
2116 is_local_mutation_allowed: LocalMutationIsAllowed::ExceptUpvars,
2118 LocalMutationIsAllowed::No => Err(place),
2120 Mutability::Mut => Ok(RootPlace {
2121 place_local: place.local,
2122 place_projection: place.projection,
2123 is_local_mutation_allowed,
2127 Some((place_base, elem)) => {
2129 ProjectionElem::Deref => {
2130 let base_ty = place_base.ty(self.body(), self.infcx.tcx).ty;
2132 // Check the kind of deref to decide
2133 match base_ty.kind() {
2134 ty::Ref(_, _, mutbl) => {
2136 // Shared borrowed data is never mutable
2137 hir::Mutability::Not => Err(place),
2138 // Mutably borrowed data is mutable, but only if we have a
2139 // unique path to the `&mut`
2140 hir::Mutability::Mut => {
2141 let mode = match self.is_upvar_field_projection(place) {
2142 Some(field) if self.upvars[field.index()].by_ref => {
2143 is_local_mutation_allowed
2145 _ => LocalMutationIsAllowed::Yes,
2148 self.is_mutable(place_base, mode)
2152 ty::RawPtr(tnm) => {
2154 // `*const` raw pointers are not mutable
2155 hir::Mutability::Not => Err(place),
2156 // `*mut` raw pointers are always mutable, regardless of
2157 // context. The users have to check by themselves.
2158 hir::Mutability::Mut => Ok(RootPlace {
2159 place_local: place.local,
2160 place_projection: place.projection,
2161 is_local_mutation_allowed,
2165 // `Box<T>` owns its content, so mutable if its location is mutable
2166 _ if base_ty.is_box() => {
2167 self.is_mutable(place_base, is_local_mutation_allowed)
2169 // Deref should only be for reference, pointers or boxes
2170 _ => bug!("Deref of unexpected type: {:?}", base_ty),
2173 // All other projections are owned by their base path, so mutable if
2174 // base path is mutable
2175 ProjectionElem::Field(..)
2176 | ProjectionElem::Index(..)
2177 | ProjectionElem::ConstantIndex { .. }
2178 | ProjectionElem::Subslice { .. }
2179 | ProjectionElem::OpaqueCast { .. }
2180 | ProjectionElem::Downcast(..) => {
2181 let upvar_field_projection = self.is_upvar_field_projection(place);
2182 if let Some(field) = upvar_field_projection {
2183 let upvar = &self.upvars[field.index()];
2185 "is_mutable: upvar.mutability={:?} local_mutation_is_allowed={:?} \
2186 place={:?}, place_base={:?}",
2187 upvar, is_local_mutation_allowed, place, place_base
2189 match (upvar.place.mutability, is_local_mutation_allowed) {
2192 LocalMutationIsAllowed::No
2193 | LocalMutationIsAllowed::ExceptUpvars,
2195 (Mutability::Not, LocalMutationIsAllowed::Yes)
2196 | (Mutability::Mut, _) => {
2197 // Subtle: this is an upvar
2198 // reference, so it looks like
2199 // `self.foo` -- we want to double
2200 // check that the location `*self`
2201 // is mutable (i.e., this is not a
2202 // `Fn` closure). But if that
2203 // check succeeds, we want to
2204 // *blame* the mutability on
2205 // `place` (that is,
2206 // `self.foo`). This is used to
2207 // propagate the info about
2208 // whether mutability declarations
2209 // are used outwards, so that we register
2210 // the outer variable as mutable. Otherwise a
2211 // test like this fails to record the `mut`
2215 // fn foo<F: FnOnce()>(_f: F) { }
2217 // let var = Vec::new();
2224 self.is_mutable(place_base, is_local_mutation_allowed)?;
2226 place_local: place.local,
2227 place_projection: place.projection,
2228 is_local_mutation_allowed,
2233 self.is_mutable(place_base, is_local_mutation_allowed)
2241 /// If `place` is a field projection, and the field is being projected from a closure type,
2242 /// then returns the index of the field being projected. Note that this closure will always
2243 /// be `self` in the current MIR, because that is the only time we directly access the fields
2244 /// of a closure type.
2245 fn is_upvar_field_projection(&self, place_ref: PlaceRef<'tcx>) -> Option<Field> {
2246 path_utils::is_upvar_field_projection(self.infcx.tcx, &self.upvars, place_ref, self.body())
2251 use rustc_errors::ErrorGuaranteed;
2255 pub struct BorrowckErrors<'tcx> {
2257 /// This field keeps track of move errors that are to be reported for given move indices.
2259 /// There are situations where many errors can be reported for a single move out (see #53807)
2260 /// and we want only the best of those errors.
2262 /// The `report_use_of_moved_or_uninitialized` function checks this map and replaces the
2263 /// diagnostic (if there is one) if the `Place` of the error being reported is a prefix of the
2264 /// `Place` of the previous most diagnostic. This happens instead of buffering the error. Once
2265 /// all move errors have been reported, any diagnostics in this map are added to the buffer
2268 /// `BTreeMap` is used to preserve the order of insertions when iterating. This is necessary
2269 /// when errors in the map are being re-added to the error buffer so that errors with the
2270 /// same primary span come out in a consistent order.
2271 buffered_move_errors:
2272 BTreeMap<Vec<MoveOutIndex>, (PlaceRef<'tcx>, DiagnosticBuilder<'tcx, ErrorGuaranteed>)>,
2273 /// Diagnostics to be reported buffer.
2274 buffered: Vec<Diagnostic>,
2275 /// Set to Some if we emit an error during borrowck
2276 tainted_by_errors: Option<ErrorGuaranteed>,
2279 impl<'tcx> BorrowckErrors<'tcx> {
2280 pub fn new(tcx: TyCtxt<'tcx>) -> Self {
2283 buffered_move_errors: BTreeMap::new(),
2284 buffered: Default::default(),
2285 tainted_by_errors: None,
2289 pub fn buffer_error(&mut self, t: DiagnosticBuilder<'_, ErrorGuaranteed>) {
2290 if let None = self.tainted_by_errors {
2291 self.tainted_by_errors = Some(
2294 .delay_span_bug(t.span.clone(), "diagnostic buffered but not emitted"),
2297 t.buffer(&mut self.buffered);
2300 pub fn buffer_non_error_diag(&mut self, t: DiagnosticBuilder<'_, ()>) {
2301 t.buffer(&mut self.buffered);
2304 pub fn set_tainted_by_errors(&mut self, e: ErrorGuaranteed) {
2305 self.tainted_by_errors = Some(e);
2309 impl<'cx, 'tcx> MirBorrowckCtxt<'cx, 'tcx> {
2310 pub fn buffer_error(&mut self, t: DiagnosticBuilder<'_, ErrorGuaranteed>) {
2311 self.errors.buffer_error(t);
2314 pub fn buffer_non_error_diag(&mut self, t: DiagnosticBuilder<'_, ()>) {
2315 self.errors.buffer_non_error_diag(t);
2318 pub fn buffer_move_error(
2320 move_out_indices: Vec<MoveOutIndex>,
2321 place_and_err: (PlaceRef<'tcx>, DiagnosticBuilder<'tcx, ErrorGuaranteed>),
2323 if let Some((_, diag)) =
2324 self.errors.buffered_move_errors.insert(move_out_indices, place_and_err)
2326 // Cancel the old diagnostic so we don't ICE
2334 pub fn emit_errors(&mut self) -> Option<ErrorGuaranteed> {
2335 // Buffer any move errors that we collected and de-duplicated.
2336 for (_, (_, diag)) in std::mem::take(&mut self.errors.buffered_move_errors) {
2337 // We have already set tainted for this error, so just buffer it.
2338 diag.buffer(&mut self.errors.buffered);
2341 if !self.errors.buffered.is_empty() {
2342 self.errors.buffered.sort_by_key(|diag| diag.sort_span);
2344 for mut diag in self.errors.buffered.drain(..) {
2345 self.infcx.tcx.sess.diagnostic().emit_diagnostic(&mut diag);
2349 self.errors.tainted_by_errors
2352 pub fn has_buffered_errors(&self) -> bool {
2353 self.errors.buffered.is_empty()
2356 pub fn has_move_error(
2358 move_out_indices: &[MoveOutIndex],
2359 ) -> Option<&(PlaceRef<'tcx>, DiagnosticBuilder<'cx, ErrorGuaranteed>)> {
2360 self.errors.buffered_move_errors.get(move_out_indices)
2365 /// The degree of overlap between 2 places for borrow-checking.
2367 /// The places might partially overlap - in this case, we give
2368 /// up and say that they might conflict. This occurs when
2369 /// different fields of a union are borrowed. For example,
2370 /// if `u` is a union, we have no way of telling how disjoint
2371 /// `u.a.x` and `a.b.y` are.
2373 /// The places have the same type, and are either completely disjoint
2374 /// or equal - i.e., they can't "partially" overlap as can occur with
2375 /// unions. This is the "base case" on which we recur for extensions
2378 /// The places are disjoint, so we know all extensions of them
2379 /// will also be disjoint.