1 //! The entry point of the NLL borrow checker.
3 use rustc_data_structures::vec_map::VecMap;
4 use rustc_errors::Diagnostic;
5 use rustc_index::vec::IndexVec;
6 use rustc_infer::infer::InferCtxt;
7 use rustc_middle::mir::{create_dump_file, dump_enabled, dump_mir, PassWhere};
8 use rustc_middle::mir::{
9 BasicBlock, Body, ClosureOutlivesSubject, ClosureRegionRequirements, LocalKind, Location,
12 use rustc_middle::ty::{self, OpaqueTypeKey, RegionKind, RegionVid, Ty};
13 use rustc_span::symbol::sym;
17 use std::path::PathBuf;
19 use std::str::FromStr;
21 use polonius_engine::{Algorithm, Output};
23 use rustc_mir_dataflow::impls::MaybeInitializedPlaces;
24 use rustc_mir_dataflow::move_paths::{InitKind, InitLocation, MoveData};
25 use rustc_mir_dataflow::ResultsCursor;
28 borrow_set::BorrowSet,
29 constraint_generation,
30 diagnostics::RegionErrors,
31 facts::{AllFacts, AllFactsExt, RustcFacts},
33 location::LocationTable,
34 region_infer::{values::RegionValueElements, RegionInferenceContext},
36 type_check::{self, MirTypeckRegionConstraints, MirTypeckResults},
37 universal_regions::UniversalRegions,
41 pub type PoloniusOutput = Output<RustcFacts>;
43 /// The output of `nll::compute_regions`. This includes the computed `RegionInferenceContext`, any
44 /// closure requirements to propagate, and any generated errors.
45 crate struct NllOutput<'tcx> {
46 pub regioncx: RegionInferenceContext<'tcx>,
47 pub opaque_type_values: VecMap<OpaqueTypeKey<'tcx>, Ty<'tcx>>,
48 pub polonius_input: Option<Box<AllFacts>>,
49 pub polonius_output: Option<Rc<PoloniusOutput>>,
50 pub opt_closure_req: Option<ClosureRegionRequirements<'tcx>>,
51 pub nll_errors: RegionErrors<'tcx>,
54 /// Rewrites the regions in the MIR to use NLL variables, also scraping out the set of universal
55 /// regions (e.g., region parameters) declared on the function. That set will need to be given to
56 /// `compute_regions`.
57 #[instrument(skip(infcx, param_env, body, promoted), level = "debug")]
58 pub(crate) fn replace_regions_in_mir<'cx, 'tcx>(
59 infcx: &InferCtxt<'cx, 'tcx>,
60 param_env: ty::ParamEnv<'tcx>,
61 body: &mut Body<'tcx>,
62 promoted: &mut IndexVec<Promoted, Body<'tcx>>,
63 ) -> UniversalRegions<'tcx> {
64 let def = body.source.with_opt_param().as_local().unwrap();
68 // Compute named region information. This also renumbers the inputs/outputs.
69 let universal_regions = UniversalRegions::new(infcx, def, param_env);
71 // Replace all remaining regions with fresh inference variables.
72 renumber::renumber_mir(infcx, body, promoted);
74 dump_mir(infcx.tcx, None, "renumber", &0, body, |_, _| Ok(()));
79 // This function populates an AllFacts instance with base facts related to
80 // MovePaths and needed for the move analysis.
81 fn populate_polonius_move_facts(
82 all_facts: &mut AllFacts,
83 move_data: &MoveData<'_>,
84 location_table: &LocationTable,
89 .extend(move_data.rev_lookup.iter_locals_enumerated().map(|(v, &m)| (m, v)));
91 for (child, move_path) in move_data.move_paths.iter_enumerated() {
92 if let Some(parent) = move_path.parent {
93 all_facts.child_path.push((child, parent));
97 let fn_entry_start = location_table
98 .start_index(Location { block: BasicBlock::from_u32(0u32), statement_index: 0 });
101 for init in move_data.inits.iter() {
102 match init.location {
103 InitLocation::Statement(location) => {
104 let block_data = &body[location.block];
105 let is_terminator = location.statement_index == block_data.statements.len();
107 if is_terminator && init.kind == InitKind::NonPanicPathOnly {
108 // We are at the terminator of an init that has a panic path,
109 // and where the init should not happen on panic
111 for &successor in block_data.terminator().successors() {
112 if body[successor].is_cleanup {
116 // The initialization happened in (or rather, when arriving at)
117 // the successors, but not in the unwind block.
118 let first_statement = Location { block: successor, statement_index: 0 };
120 .path_assigned_at_base
121 .push((init.path, location_table.start_index(first_statement)));
124 // In all other cases, the initialization just happens at the
125 // midpoint, like any other effect.
127 .path_assigned_at_base
128 .push((init.path, location_table.mid_index(location)));
131 // Arguments are initialized on function entry
132 InitLocation::Argument(local) => {
133 assert!(body.local_kind(local) == LocalKind::Arg);
134 all_facts.path_assigned_at_base.push((init.path, fn_entry_start));
139 for (local, &path) in move_data.rev_lookup.iter_locals_enumerated() {
140 if body.local_kind(local) != LocalKind::Arg {
141 // Non-arguments start out deinitialised; we simulate this with an
143 all_facts.path_moved_at_base.push((path, fn_entry_start));
148 // deinitialisation is assumed to always happen!
151 .extend(move_data.moves.iter().map(|mo| (mo.path, location_table.mid_index(mo.source))));
154 /// Computes the (non-lexical) regions from the input MIR.
156 /// This may result in errors being reported.
157 pub(crate) fn compute_regions<'cx, 'tcx>(
158 infcx: &InferCtxt<'cx, 'tcx>,
159 universal_regions: UniversalRegions<'tcx>,
161 promoted: &IndexVec<Promoted, Body<'tcx>>,
162 location_table: &LocationTable,
163 param_env: ty::ParamEnv<'tcx>,
164 flow_inits: &mut ResultsCursor<'cx, 'tcx, MaybeInitializedPlaces<'cx, 'tcx>>,
165 move_data: &MoveData<'tcx>,
166 borrow_set: &BorrowSet<'tcx>,
167 upvars: &[Upvar<'tcx>],
169 ) -> NllOutput<'tcx> {
171 (use_polonius || AllFacts::enabled(infcx.tcx)).then_some(AllFacts::default());
173 let universal_regions = Rc::new(universal_regions);
175 let elements = &Rc::new(RegionValueElements::new(&body));
177 // Run the MIR type-checker.
178 let MirTypeckResults { constraints, universal_region_relations, opaque_type_values } =
179 type_check::type_check(
194 if let Some(all_facts) = &mut all_facts {
195 let _prof_timer = infcx.tcx.prof.generic_activity("polonius_fact_generation");
196 all_facts.universal_region.extend(universal_regions.universal_regions());
197 populate_polonius_move_facts(all_facts, move_data, location_table, &body);
199 // Emit universal regions facts, and their relations, for Polonius.
201 // 1: universal regions are modeled in Polonius as a pair:
202 // - the universal region vid itself.
203 // - a "placeholder loan" associated to this universal region. Since they don't exist in
204 // the `borrow_set`, their `BorrowIndex` are synthesized as the universal region index
205 // added to the existing number of loans, as if they succeeded them in the set.
207 let borrow_count = borrow_set.len();
209 "compute_regions: polonius placeholders, num_universals={}, borrow_count={}",
210 universal_regions.len(),
214 for universal_region in universal_regions.universal_regions() {
215 let universal_region_idx = universal_region.index();
216 let placeholder_loan_idx = borrow_count + universal_region_idx;
217 all_facts.placeholder.push((universal_region, placeholder_loan_idx.into()));
220 // 2: the universal region relations `outlives` constraints are emitted as
221 // `known_placeholder_subset` facts.
222 for (fr1, fr2) in universal_region_relations.known_outlives() {
225 "compute_regions: emitting polonius `known_placeholder_subset` \
229 all_facts.known_placeholder_subset.push((*fr1, *fr2));
234 // Create the region inference context, taking ownership of the
235 // region inference data that was contained in `infcx`, and the
236 // base constraints generated by the type-check.
237 let var_origins = infcx.take_region_var_origins();
238 let MirTypeckRegionConstraints {
240 placeholder_index_to_region: _,
241 mut liveness_constraints,
242 outlives_constraints,
244 closure_bounds_mapping,
248 let placeholder_indices = Rc::new(placeholder_indices);
250 constraint_generation::generate_constraints(
252 &mut liveness_constraints,
259 let mut regioncx = RegionInferenceContext::new(
263 universal_region_relations,
264 outlives_constraints,
266 closure_bounds_mapping,
269 liveness_constraints,
273 // Generate various additional constraints.
274 invalidation::generate_invalidates(infcx.tcx, &mut all_facts, location_table, body, borrow_set);
276 let def_id = body.source.def_id();
278 // Dump facts if requested.
279 let polonius_output = all_facts.as_ref().and_then(|all_facts| {
280 if infcx.tcx.sess.opts.debugging_opts.nll_facts {
281 let def_path = infcx.tcx.def_path(def_id);
282 let dir_path = PathBuf::from(&infcx.tcx.sess.opts.debugging_opts.nll_facts_dir)
283 .join(def_path.to_filename_friendly_no_crate());
284 all_facts.write_to_dir(dir_path, location_table).unwrap();
289 env::var("POLONIUS_ALGORITHM").unwrap_or_else(|_| String::from("Hybrid"));
290 let algorithm = Algorithm::from_str(&algorithm).unwrap();
291 debug!("compute_regions: using polonius algorithm {:?}", algorithm);
292 let _prof_timer = infcx.tcx.prof.generic_activity("polonius_analysis");
293 Some(Rc::new(Output::compute(&all_facts, algorithm, false)))
299 // Solve the region constraints.
300 let (closure_region_requirements, nll_errors) =
301 regioncx.solve(infcx, &body, polonius_output.clone());
303 if !nll_errors.is_empty() {
304 // Suppress unhelpful extra errors in `infer_opaque_types`.
305 infcx.set_tainted_by_errors();
308 let remapped_opaque_tys = regioncx.infer_opaque_types(&infcx, opaque_type_values, body.span);
312 opaque_type_values: remapped_opaque_tys,
313 polonius_input: all_facts.map(Box::new),
315 opt_closure_req: closure_region_requirements,
320 pub(super) fn dump_mir_results<'a, 'tcx>(
321 infcx: &InferCtxt<'a, 'tcx>,
323 regioncx: &RegionInferenceContext<'tcx>,
324 closure_region_requirements: &Option<ClosureRegionRequirements<'_>>,
326 if !dump_enabled(infcx.tcx, "nll", body.source.def_id()) {
330 dump_mir(infcx.tcx, None, "nll", &0, body, |pass_where, out| {
332 // Before the CFG, dump out the values for each region variable.
333 PassWhere::BeforeCFG => {
334 regioncx.dump_mir(infcx.tcx, out)?;
337 if let Some(closure_region_requirements) = closure_region_requirements {
338 writeln!(out, "| Free Region Constraints")?;
339 for_each_region_constraint(closure_region_requirements, &mut |msg| {
340 writeln!(out, "| {}", msg)
346 PassWhere::BeforeLocation(_) => {}
348 PassWhere::AfterTerminator(_) => {}
350 PassWhere::BeforeBlock(_) | PassWhere::AfterLocation(_) | PassWhere::AfterCFG => {}
355 // Also dump the inference graph constraints as a graphviz file.
356 let _: io::Result<()> = try {
358 create_dump_file(infcx.tcx, "regioncx.all.dot", None, "nll", &0, body.source)?;
359 regioncx.dump_graphviz_raw_constraints(&mut file)?;
362 // Also dump the inference graph constraints as a graphviz file.
363 let _: io::Result<()> = try {
365 create_dump_file(infcx.tcx, "regioncx.scc.dot", None, "nll", &0, body.source)?;
366 regioncx.dump_graphviz_scc_constraints(&mut file)?;
370 pub(super) fn dump_annotation<'a, 'tcx>(
371 infcx: &InferCtxt<'a, 'tcx>,
373 regioncx: &RegionInferenceContext<'tcx>,
374 closure_region_requirements: &Option<ClosureRegionRequirements<'_>>,
375 opaque_type_values: &VecMap<OpaqueTypeKey<'tcx>, Ty<'tcx>>,
376 errors_buffer: &mut Vec<Diagnostic>,
379 let base_def_id = tcx.typeck_root_def_id(body.source.def_id());
380 if !tcx.has_attr(base_def_id, sym::rustc_regions) {
384 // When the enclosing function is tagged with `#[rustc_regions]`,
385 // we dump out various bits of state as warnings. This is useful
386 // for verifying that the compiler is behaving as expected. These
387 // warnings focus on the closure region requirements -- for
388 // viewing the intraprocedural state, the -Zdump-mir output is
391 let mut err = if let Some(closure_region_requirements) = closure_region_requirements {
392 let mut err = tcx.sess.diagnostic().span_note_diag(body.span, "external requirements");
394 regioncx.annotate(tcx, &mut err);
397 "number of external vids: {}",
398 closure_region_requirements.num_external_vids
401 // Dump the region constraints we are imposing *between* those
402 // newly created variables.
403 for_each_region_constraint(closure_region_requirements, &mut |msg| {
411 let mut err = tcx.sess.diagnostic().span_note_diag(body.span, "no external requirements");
412 regioncx.annotate(tcx, &mut err);
417 if !opaque_type_values.is_empty() {
418 err.note(&format!("Inferred opaque type values:\n{:#?}", opaque_type_values));
421 err.buffer(errors_buffer);
424 fn for_each_region_constraint(
425 closure_region_requirements: &ClosureRegionRequirements<'_>,
426 with_msg: &mut dyn FnMut(&str) -> io::Result<()>,
427 ) -> io::Result<()> {
428 for req in &closure_region_requirements.outlives_requirements {
429 let subject: &dyn Debug = match &req.subject {
430 ClosureOutlivesSubject::Region(subject) => subject,
431 ClosureOutlivesSubject::Ty(ty) => ty,
433 with_msg(&format!("where {:?}: {:?}", subject, req.outlived_free_region,))?;
438 /// Right now, we piggy back on the `ReVar` to store our NLL inference
439 /// regions. These are indexed with `RegionVid`. This method will
440 /// assert that the region is a `ReVar` and extract its internal index.
441 /// This is reasonable because in our MIR we replace all universal regions
442 /// with inference variables.
443 pub trait ToRegionVid {
444 fn to_region_vid(self) -> RegionVid;
447 impl<'tcx> ToRegionVid for &'tcx RegionKind {
448 fn to_region_vid(self) -> RegionVid {
449 if let ty::ReVar(vid) = self { *vid } else { bug!("region is not an ReVar: {:?}", self) }
453 impl ToRegionVid for RegionVid {
454 fn to_region_vid(self) -> RegionVid {
459 crate trait ConstraintDescription {
460 fn description(&self) -> &'static str;