1 //! The region check is a final pass that runs over the AST after we have
2 //! inferred the type constraints but before we have actually finalized
3 //! the types. Its purpose is to embed a variety of region constraints.
4 //! Inserting these constraints as a separate pass is good because (1) it
5 //! localizes the code that has to do with region inference and (2) often
6 //! we cannot know what constraints are needed until the basic types have
9 //! ### Interaction with the borrow checker
11 //! In general, the job of the borrowck module (which runs later) is to
12 //! check that all soundness criteria are met, given a particular set of
13 //! regions. The job of *this* module is to anticipate the needs of the
14 //! borrow checker and infer regions that will satisfy its requirements.
15 //! It is generally true that the inference doesn't need to be sound,
16 //! meaning that if there is a bug and we inferred bad regions, the borrow
17 //! checker should catch it. This is not entirely true though; for
18 //! example, the borrow checker doesn't check subtyping, and it doesn't
19 //! check that region pointers are always live when they are used. It
20 //! might be worthwhile to fix this so that borrowck serves as a kind of
21 //! verification step -- that would add confidence in the overall
22 //! correctness of the compiler, at the cost of duplicating some type
23 //! checks and effort.
25 //! ### Inferring the duration of borrows, automatic and otherwise
27 //! Whenever we introduce a borrowed pointer, for example as the result of
28 //! a borrow expression `let x = &data`, the lifetime of the pointer `x`
29 //! is always specified as a region inference variable. `regionck` has the
30 //! job of adding constraints such that this inference variable is as
31 //! narrow as possible while still accommodating all uses (that is, every
32 //! dereference of the resulting pointer must be within the lifetime).
36 //! Generally speaking, `regionck` does NOT try to ensure that the data
37 //! `data` will outlive the pointer `x`. That is the job of borrowck. The
38 //! one exception is when "re-borrowing" the contents of another borrowed
39 //! pointer. For example, imagine you have a borrowed pointer `b` with
40 //! lifetime `L1` and you have an expression `&*b`. The result of this
41 //! expression will be another borrowed pointer with lifetime `L2` (which is
42 //! an inference variable). The borrow checker is going to enforce the
43 //! constraint that `L2 < L1`, because otherwise you are re-borrowing data
44 //! for a lifetime larger than the original loan. However, without the
45 //! routines in this module, the region inferencer would not know of this
46 //! dependency and thus it might infer the lifetime of `L2` to be greater
47 //! than `L1` (issue #3148).
49 //! There are a number of troublesome scenarios in the tests
50 //! `region-dependent-*.rs`, but here is one example:
52 //! struct Foo { i: i32 }
53 //! struct Bar { foo: Foo }
54 //! fn get_i<'a>(x: &'a Bar) -> &'a i32 {
55 //! let foo = &x.foo; // Lifetime L1
56 //! &foo.i // Lifetime L2
59 //! Note that this comes up either with `&` expressions, `ref`
60 //! bindings, and `autorefs`, which are the three ways to introduce
63 //! The key point here is that when you are borrowing a value that
64 //! is "guaranteed" by a borrowed pointer, you must link the
65 //! lifetime of that borrowed pointer (`L1`, here) to the lifetime of
66 //! the borrow itself (`L2`). What do I mean by "guaranteed" by a
67 //! borrowed pointer? I mean any data that is reached by first
68 //! dereferencing a borrowed pointer and then either traversing
69 //! interior offsets or boxes. We say that the guarantor
70 //! of such data is the region of the borrowed pointer that was
71 //! traversed. This is essentially the same as the ownership
72 //! relation, except that a borrowed pointer never owns its
75 use crate::check::dropck;
76 use crate::check::FnCtxt;
77 use crate::mem_categorization as mc;
78 use crate::middle::region;
79 use crate::outlives::outlives_bounds::InferCtxtExt as _;
80 use rustc_data_structures::stable_set::FxHashSet;
82 use rustc_hir::def_id::LocalDefId;
83 use rustc_hir::intravisit::{self, Visitor};
84 use rustc_hir::PatKind;
85 use rustc_infer::infer::outlives::env::OutlivesEnvironment;
86 use rustc_infer::infer::{self, InferCtxt, RegionObligation, RegionckMode};
87 use rustc_middle::hir::place::{PlaceBase, PlaceWithHirId};
88 use rustc_middle::ty::adjustment;
89 use rustc_middle::ty::{self, Ty};
93 // a variation on try that just returns unit
94 macro_rules! ignore_err {
99 debug!("ignoring mem-categorization error!");
106 pub(crate) trait OutlivesEnvironmentExt<'tcx> {
107 fn add_implied_bounds(
109 infcx: &InferCtxt<'_, 'tcx>,
110 fn_sig_tys: FxHashSet<Ty<'tcx>>,
116 impl<'tcx> OutlivesEnvironmentExt<'tcx> for OutlivesEnvironment<'tcx> {
117 /// This method adds "implied bounds" into the outlives environment.
118 /// Implied bounds are outlives relationships that we can deduce
119 /// on the basis that certain types must be well-formed -- these are
120 /// either the types that appear in the function signature or else
121 /// the input types to an impl. For example, if you have a function
125 /// fn foo<'a, 'b, T>(x: &'a &'b [T]) { }
128 /// we can assume in the caller's body that `'b: 'a` and that `T:
129 /// 'b` (and hence, transitively, that `T: 'a`). This method would
130 /// add those assumptions into the outlives-environment.
132 /// Tests: `src/test/ui/regions/regions-free-region-ordering-*.rs`
133 fn add_implied_bounds<'a>(
135 infcx: &InferCtxt<'a, 'tcx>,
136 fn_sig_tys: FxHashSet<Ty<'tcx>>,
140 debug!("add_implied_bounds()");
142 for ty in fn_sig_tys {
143 let ty = infcx.resolve_vars_if_possible(ty);
144 debug!("add_implied_bounds: ty = {}", ty);
145 let implied_bounds = infcx.implied_outlives_bounds(self.param_env, body_id, ty, span);
146 self.add_outlives_bounds(Some(infcx), implied_bounds)
151 ///////////////////////////////////////////////////////////////////////////
152 // PUBLIC ENTRY POINTS
154 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
155 pub fn regionck_expr(&self, body: &'tcx hir::Body<'tcx>) {
156 let subject = self.tcx.hir().body_owner_def_id(body.id());
157 let id = body.value.hir_id;
158 let mut rcx = RegionCtxt::new(self, id, Subject(subject), self.param_env);
160 // There are no add'l implied bounds when checking a
161 // standalone expr (e.g., the `E` in a type like `[u32; E]`).
162 rcx.outlives_environment.save_implied_bounds(id);
164 if !self.errors_reported_since_creation() {
165 // regionck assumes typeck succeeded
166 rcx.visit_body(body);
167 rcx.visit_region_obligations(id);
169 rcx.resolve_regions_and_report_errors(RegionckMode::for_item_body(self.tcx));
172 /// Region checking during the WF phase for items. `wf_tys` are the
173 /// types from which we should derive implied bounds, if any.
174 #[instrument(level = "debug", skip(self))]
175 pub fn regionck_item(&self, item_id: hir::HirId, span: Span, wf_tys: FxHashSet<Ty<'tcx>>) {
176 let subject = self.tcx.hir().local_def_id(item_id);
177 let mut rcx = RegionCtxt::new(self, item_id, Subject(subject), self.param_env);
178 rcx.outlives_environment.add_implied_bounds(self, wf_tys, item_id, span);
179 rcx.outlives_environment.save_implied_bounds(item_id);
180 rcx.visit_region_obligations(item_id);
181 rcx.resolve_regions_and_report_errors(RegionckMode::default());
184 /// Region check a function body. Not invoked on closures, but
185 /// only on the "root" fn item (in which closures may be
186 /// embedded). Walks the function body and adds various add'l
187 /// constraints that are needed for region inference. This is
188 /// separated both to isolate "pure" region constraints from the
189 /// rest of type check and because sometimes we need type
190 /// inference to have completed before we can determine which
191 /// constraints to add.
192 pub(crate) fn regionck_fn(
195 body: &'tcx hir::Body<'tcx>,
197 wf_tys: FxHashSet<Ty<'tcx>>,
199 debug!("regionck_fn(id={})", fn_id);
200 let subject = self.tcx.hir().body_owner_def_id(body.id());
201 let hir_id = body.value.hir_id;
202 let mut rcx = RegionCtxt::new(self, hir_id, Subject(subject), self.param_env);
203 // We need to add the implied bounds from the function signature
204 rcx.outlives_environment.add_implied_bounds(self, wf_tys, fn_id, span);
205 rcx.outlives_environment.save_implied_bounds(fn_id);
207 if !self.errors_reported_since_creation() {
208 // regionck assumes typeck succeeded
209 rcx.visit_fn_body(fn_id, body, self.tcx.hir().span(fn_id));
212 rcx.resolve_regions_and_report_errors(RegionckMode::for_item_body(self.tcx));
216 ///////////////////////////////////////////////////////////////////////////
219 pub struct RegionCtxt<'a, 'tcx> {
220 pub fcx: &'a FnCtxt<'a, 'tcx>,
222 pub region_scope_tree: &'tcx region::ScopeTree,
224 outlives_environment: OutlivesEnvironment<'tcx>,
226 // id of innermost fn body id
228 body_owner: LocalDefId,
230 // id of AST node being analyzed (the subject of the analysis).
231 subject_def_id: LocalDefId,
234 impl<'a, 'tcx> Deref for RegionCtxt<'a, 'tcx> {
235 type Target = FnCtxt<'a, 'tcx>;
236 fn deref(&self) -> &Self::Target {
241 pub struct Subject(LocalDefId);
243 impl<'a, 'tcx> RegionCtxt<'a, 'tcx> {
245 fcx: &'a FnCtxt<'a, 'tcx>,
246 initial_body_id: hir::HirId,
247 Subject(subject): Subject,
248 param_env: ty::ParamEnv<'tcx>,
249 ) -> RegionCtxt<'a, 'tcx> {
250 let region_scope_tree = fcx.tcx.region_scope_tree(subject);
251 let outlives_environment = OutlivesEnvironment::new(param_env);
255 body_id: initial_body_id,
257 subject_def_id: subject,
258 outlives_environment,
262 /// Try to resolve the type for the given node, returning `t_err` if an error results. Note that
263 /// we never care about the details of the error, the same error will be detected and reported
264 /// in the writeback phase.
266 /// Note one important point: we do not attempt to resolve *region variables* here. This is
267 /// because regionck is essentially adding constraints to those region variables and so may yet
268 /// influence how they are resolved.
270 /// Consider this silly example:
273 /// fn borrow(x: &i32) -> &i32 {x}
274 /// fn foo(x: @i32) -> i32 { // block: B
275 /// let b = borrow(x); // region: <R0>
280 /// Here, the region of `b` will be `<R0>`. `<R0>` is constrained to be some subregion of the
281 /// block B and some superregion of the call. If we forced it now, we'd choose the smaller
282 /// region (the call). But that would make the *b illegal. Since we don't resolve, the type
283 /// of b will be `&<R0>.i32` and then `*b` will require that `<R0>` be bigger than the let and
284 /// the `*b` expression, so we will effectively resolve `<R0>` to be the block B.
285 pub fn resolve_type(&self, unresolved_ty: Ty<'tcx>) -> Ty<'tcx> {
286 self.resolve_vars_if_possible(unresolved_ty)
289 /// Try to resolve the type for the given node.
290 fn resolve_node_type(&self, id: hir::HirId) -> Ty<'tcx> {
291 let t = self.node_ty(id);
295 /// This is the "main" function when region-checking a function item or a
296 /// closure within a function item. It begins by updating various fields
297 /// (e.g., `outlives_environment`) to be appropriate to the function and
298 /// then adds constraints derived from the function body.
300 /// Note that it does **not** restore the state of the fields that
301 /// it updates! This is intentional, since -- for the main
302 /// function -- we wish to be able to read the final
303 /// `outlives_environment` and other fields from the caller. For
304 /// closures, however, we save and restore any "scoped state"
305 /// before we invoke this function. (See `visit_fn` in the
306 /// `intravisit::Visitor` impl below.)
309 id: hir::HirId, // the id of the fn itself
310 body: &'tcx hir::Body<'tcx>,
313 // When we enter a function, we can derive
314 debug!("visit_fn_body(id={:?})", id);
316 let body_id = body.id();
317 self.body_id = body_id.hir_id;
318 self.body_owner = self.tcx.hir().body_owner_def_id(body_id);
320 let Some(fn_sig) = self.typeck_results.borrow().liberated_fn_sigs().get(id) else {
321 bug!("No fn-sig entry for id={:?}", id);
324 // Collect the types from which we create inferred bounds.
325 // For the return type, if diverging, substitute `bool` just
326 // because it will have no effect.
328 // FIXME(#27579) return types should not be implied bounds
329 let fn_sig_tys: FxHashSet<_> =
330 fn_sig.inputs().iter().cloned().chain(Some(fn_sig.output())).collect();
332 self.outlives_environment.add_implied_bounds(self.fcx, fn_sig_tys, body_id.hir_id, span);
333 self.outlives_environment.save_implied_bounds(body_id.hir_id);
334 self.link_fn_params(body.params);
335 self.visit_body(body);
336 self.visit_region_obligations(body_id.hir_id);
339 fn visit_inline_const(&mut self, id: hir::HirId, body: &'tcx hir::Body<'tcx>) {
340 debug!("visit_inline_const(id={:?})", id);
342 // Save state of current function. We will restore afterwards.
343 let old_body_id = self.body_id;
344 let old_body_owner = self.body_owner;
345 let env_snapshot = self.outlives_environment.push_snapshot_pre_typeck_child();
347 let body_id = body.id();
348 self.body_id = body_id.hir_id;
349 self.body_owner = self.tcx.hir().body_owner_def_id(body_id);
351 self.outlives_environment.save_implied_bounds(body_id.hir_id);
353 self.visit_body(body);
354 self.visit_region_obligations(body_id.hir_id);
356 // Restore state from previous function.
357 self.outlives_environment.pop_snapshot_post_typeck_child(env_snapshot);
358 self.body_id = old_body_id;
359 self.body_owner = old_body_owner;
362 fn visit_region_obligations(&mut self, hir_id: hir::HirId) {
363 debug!("visit_region_obligations: hir_id={:?}", hir_id);
365 // region checking can introduce new pending obligations
366 // which, when processed, might generate new region
367 // obligations. So make sure we process those.
368 self.select_all_obligations_or_error();
371 fn resolve_regions_and_report_errors(&self, mode: RegionckMode) {
372 self.infcx.process_registered_region_obligations(
373 self.outlives_environment.region_bound_pairs_map(),
374 Some(self.tcx.lifetimes.re_root_empty),
378 self.fcx.resolve_regions_and_report_errors(
379 self.subject_def_id.to_def_id(),
380 &self.outlives_environment,
385 fn constrain_bindings_in_pat(&mut self, pat: &hir::Pat<'_>) {
386 debug!("regionck::visit_pat(pat={:?})", pat);
387 pat.each_binding(|_, hir_id, span, _| {
388 let typ = self.resolve_node_type(hir_id);
389 let body_id = self.body_id;
390 dropck::check_drop_obligations(self, typ, span, body_id);
395 impl<'a, 'tcx> Visitor<'tcx> for RegionCtxt<'a, 'tcx> {
396 // (..) FIXME(#3238) should use visit_pat, not visit_arm/visit_local,
397 // However, right now we run into an issue whereby some free
398 // regions are not properly related if they appear within the
399 // types of arguments that must be inferred. This could be
400 // addressed by deferring the construction of the region
401 // hierarchy, and in particular the relationships between free
402 // regions, until regionck, as described in #3238.
406 fk: intravisit::FnKind<'tcx>,
407 _: &'tcx hir::FnDecl<'tcx>,
408 body_id: hir::BodyId,
413 matches!(fk, intravisit::FnKind::Closure),
414 "visit_fn invoked for something other than a closure"
417 // Save state of current function before invoking
418 // `visit_fn_body`. We will restore afterwards.
419 let old_body_id = self.body_id;
420 let old_body_owner = self.body_owner;
421 let env_snapshot = self.outlives_environment.push_snapshot_pre_typeck_child();
423 let body = self.tcx.hir().body(body_id);
424 self.visit_fn_body(hir_id, body, span);
426 // Restore state from previous function.
427 self.outlives_environment.pop_snapshot_post_typeck_child(env_snapshot);
428 self.body_id = old_body_id;
429 self.body_owner = old_body_owner;
432 //visit_pat: visit_pat, // (..) see above
434 fn visit_arm(&mut self, arm: &'tcx hir::Arm<'tcx>) {
436 self.constrain_bindings_in_pat(arm.pat);
437 intravisit::walk_arm(self, arm);
440 fn visit_local(&mut self, l: &'tcx hir::Local<'tcx>) {
442 self.constrain_bindings_in_pat(l.pat);
444 intravisit::walk_local(self, l);
447 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
448 // Check any autoderefs or autorefs that appear.
449 let cmt_result = self.constrain_adjustments(expr);
451 // If necessary, constrain destructors in this expression. This will be
452 // the adjusted form if there is an adjustment.
455 self.check_safety_of_rvalue_destructor_if_necessary(&head_cmt, expr.span);
458 self.tcx.sess.delay_span_bug(expr.span, "cat_expr Errd");
463 hir::ExprKind::AddrOf(hir::BorrowKind::Ref, m, ref base) => {
464 self.link_addr_of(expr, m, base);
466 intravisit::walk_expr(self, expr);
469 hir::ExprKind::Match(ref discr, arms, _) => {
470 self.link_match(discr, arms);
472 intravisit::walk_expr(self, expr);
475 hir::ExprKind::ConstBlock(anon_const) => {
476 let body = self.tcx.hir().body(anon_const.body);
477 self.visit_inline_const(anon_const.hir_id, body);
480 _ => intravisit::walk_expr(self, expr),
485 impl<'a, 'tcx> RegionCtxt<'a, 'tcx> {
486 /// Creates a temporary `MemCategorizationContext` and pass it to the closure.
487 fn with_mc<F, R>(&self, f: F) -> R
489 F: for<'b> FnOnce(mc::MemCategorizationContext<'b, 'tcx>) -> R,
491 f(mc::MemCategorizationContext::new(
493 self.outlives_environment.param_env,
495 &self.typeck_results.borrow(),
499 /// Invoked on any adjustments that occur. Checks that if this is a region pointer being
500 /// dereferenced, the lifetime of the pointer includes the deref expr.
501 fn constrain_adjustments(
503 expr: &hir::Expr<'_>,
504 ) -> mc::McResult<PlaceWithHirId<'tcx>> {
505 debug!("constrain_adjustments(expr={:?})", expr);
507 let mut place = self.with_mc(|mc| mc.cat_expr_unadjusted(expr))?;
509 let typeck_results = self.typeck_results.borrow();
510 let adjustments = typeck_results.expr_adjustments(expr);
511 if adjustments.is_empty() {
515 debug!("constrain_adjustments: adjustments={:?}", adjustments);
517 // If necessary, constrain destructors in the unadjusted form of this
519 self.check_safety_of_rvalue_destructor_if_necessary(&place, expr.span);
521 for adjustment in adjustments {
522 debug!("constrain_adjustments: adjustment={:?}, place={:?}", adjustment, place);
524 if let adjustment::Adjust::Deref(Some(deref)) = adjustment.kind {
528 ty::BorrowKind::from_mutbl(deref.mutbl),
533 if let adjustment::Adjust::Borrow(ref autoref) = adjustment.kind {
534 self.link_autoref(expr, &place, autoref);
537 place = self.with_mc(|mc| mc.cat_expr_adjusted(expr, place, adjustment))?;
543 fn check_safety_of_rvalue_destructor_if_necessary(
545 place_with_id: &PlaceWithHirId<'tcx>,
548 if let PlaceBase::Rvalue = place_with_id.place.base {
549 if place_with_id.place.projections.is_empty() {
550 let typ = self.resolve_type(place_with_id.place.ty());
551 let body_id = self.body_id;
552 dropck::check_drop_obligations(self, typ, span, body_id);
556 /// Adds constraints to inference such that `T: 'a` holds (or
557 /// reports an error if it cannot).
561 /// - `origin`, the reason we need this constraint
562 /// - `ty`, the type `T`
563 /// - `region`, the region `'a`
564 pub fn type_must_outlive(
566 origin: infer::SubregionOrigin<'tcx>,
568 region: ty::Region<'tcx>,
570 self.infcx.register_region_obligation(
572 RegionObligation { sub_region: region, sup_type: ty, origin },
576 /// Computes the guarantor for an expression `&base` and then ensures that the lifetime of the
577 /// resulting pointer is linked to the lifetime of its guarantor (if any).
580 expr: &hir::Expr<'_>,
581 mutability: hir::Mutability,
582 base: &hir::Expr<'_>,
584 debug!("link_addr_of(expr={:?}, base={:?})", expr, base);
586 let cmt = ignore_err!(self.with_mc(|mc| mc.cat_expr(base)));
588 debug!("link_addr_of: cmt={:?}", cmt);
590 self.link_region_from_node_type(expr.span, expr.hir_id, mutability, &cmt);
593 /// Computes the guarantors for any ref bindings in a `let` and
594 /// then ensures that the lifetime of the resulting pointer is
595 /// linked to the lifetime of the initialization expression.
596 fn link_local(&self, local: &hir::Local<'_>) {
597 debug!("regionck::for_local()");
598 let init_expr = match local.init {
602 Some(expr) => &*expr,
604 let discr_cmt = ignore_err!(self.with_mc(|mc| mc.cat_expr(init_expr)));
605 self.link_pattern(discr_cmt, local.pat);
608 /// Computes the guarantors for any ref bindings in a match and
609 /// then ensures that the lifetime of the resulting pointer is
610 /// linked to the lifetime of its guarantor (if any).
611 fn link_match(&self, discr: &hir::Expr<'_>, arms: &[hir::Arm<'_>]) {
612 debug!("regionck::for_match()");
613 let discr_cmt = ignore_err!(self.with_mc(|mc| mc.cat_expr(discr)));
614 debug!("discr_cmt={:?}", discr_cmt);
616 self.link_pattern(discr_cmt.clone(), arm.pat);
620 /// Computes the guarantors for any ref bindings in a match and
621 /// then ensures that the lifetime of the resulting pointer is
622 /// linked to the lifetime of its guarantor (if any).
623 fn link_fn_params(&self, params: &[hir::Param<'_>]) {
624 for param in params {
625 let param_ty = self.node_ty(param.hir_id);
627 self.with_mc(|mc| mc.cat_rvalue(param.hir_id, param.pat.span, param_ty));
628 debug!("param_ty={:?} param_cmt={:?} param={:?}", param_ty, param_cmt, param);
629 self.link_pattern(param_cmt, param.pat);
633 /// Link lifetimes of any ref bindings in `root_pat` to the pointers found
634 /// in the discriminant, if needed.
635 fn link_pattern(&self, discr_cmt: PlaceWithHirId<'tcx>, root_pat: &hir::Pat<'_>) {
636 debug!("link_pattern(discr_cmt={:?}, root_pat={:?})", discr_cmt, root_pat);
637 ignore_err!(self.with_mc(|mc| {
638 mc.cat_pattern(discr_cmt, root_pat, |sub_cmt, hir::Pat { kind, span, hir_id, .. }| {
640 if let PatKind::Binding(..) = kind
641 && let Some(ty::BindByReference(mutbl)) = mc.typeck_results.extract_binding_mode(self.tcx.sess, *hir_id, *span) {
642 self.link_region_from_node_type(*span, *hir_id, mutbl, sub_cmt);
648 /// Link lifetime of borrowed pointer resulting from autoref to lifetimes in the value being
652 expr: &hir::Expr<'_>,
653 expr_cmt: &PlaceWithHirId<'tcx>,
654 autoref: &adjustment::AutoBorrow<'tcx>,
656 debug!("link_autoref(autoref={:?}, expr_cmt={:?})", autoref, expr_cmt);
659 adjustment::AutoBorrow::Ref(r, m) => {
660 self.link_region(expr.span, r, ty::BorrowKind::from_mutbl(m.into()), expr_cmt);
663 adjustment::AutoBorrow::RawPtr(_) => {}
667 /// Like `link_region()`, except that the region is extracted from the type of `id`,
668 /// which must be some reference (`&T`, `&str`, etc).
669 fn link_region_from_node_type(
673 mutbl: hir::Mutability,
674 cmt_borrowed: &PlaceWithHirId<'tcx>,
677 "link_region_from_node_type(id={:?}, mutbl={:?}, cmt_borrowed={:?})",
678 id, mutbl, cmt_borrowed
681 let rptr_ty = self.resolve_node_type(id);
682 if let ty::Ref(r, _, _) = rptr_ty.kind() {
683 debug!("rptr_ty={}", rptr_ty);
684 self.link_region(span, *r, ty::BorrowKind::from_mutbl(mutbl), cmt_borrowed);
688 /// Informs the inference engine that `borrow_cmt` is being borrowed with
689 /// kind `borrow_kind` and lifetime `borrow_region`.
690 /// In order to ensure borrowck is satisfied, this may create constraints
691 /// between regions, as explained in `link_reborrowed_region()`.
695 borrow_region: ty::Region<'tcx>,
696 borrow_kind: ty::BorrowKind,
697 borrow_place: &PlaceWithHirId<'tcx>,
699 let origin = infer::DataBorrowed(borrow_place.place.ty(), span);
700 self.type_must_outlive(origin, borrow_place.place.ty(), borrow_region);
702 for pointer_ty in borrow_place.place.deref_tys() {
704 "link_region(borrow_region={:?}, borrow_kind={:?}, pointer_ty={:?})",
705 borrow_region, borrow_kind, borrow_place
707 match *pointer_ty.kind() {
708 ty::RawPtr(_) => return,
709 ty::Ref(ref_region, _, ref_mutability) => {
710 if self.link_reborrowed_region(span, borrow_region, ref_region, ref_mutability)
715 _ => assert!(pointer_ty.is_box(), "unexpected built-in deref type {}", pointer_ty),
718 if let PlaceBase::Upvar(upvar_id) = borrow_place.place.base {
719 self.link_upvar_region(span, borrow_region, upvar_id);
723 /// This is the most complicated case: the path being borrowed is
724 /// itself the referent of a borrowed pointer. Let me give an
725 /// example fragment of code to make clear(er) the situation:
727 /// ```ignore (incomplete Rust code)
728 /// let r: &'a mut T = ...; // the original reference "r" has lifetime 'a
730 /// &'z *r // the reborrow has lifetime 'z
733 /// Now, in this case, our primary job is to add the inference
734 /// constraint that `'z <= 'a`. Given this setup, let's clarify the
735 /// parameters in (roughly) terms of the example:
737 /// ```plain,ignore (pseudo-Rust)
738 /// A borrow of: `& 'z bk * r` where `r` has type `& 'a bk T`
739 /// borrow_region ^~ ref_region ^~
740 /// borrow_kind ^~ ref_kind ^~
744 /// Here `bk` stands for some borrow-kind (e.g., `mut`, `uniq`, etc).
746 /// There is a complication beyond the simple scenario I just painted: there
747 /// may in fact be more levels of reborrowing. In the example, I said the
748 /// borrow was like `&'z *r`, but it might in fact be a borrow like
749 /// `&'z **q` where `q` has type `&'a &'b mut T`. In that case, we want to
750 /// ensure that `'z <= 'a` and `'z <= 'b`.
752 /// The return value of this function indicates whether we *don't* need to
753 /// the recurse to the next reference up.
755 /// This is explained more below.
756 fn link_reborrowed_region(
759 borrow_region: ty::Region<'tcx>,
760 ref_region: ty::Region<'tcx>,
761 ref_mutability: hir::Mutability,
763 debug!("link_reborrowed_region: {:?} <= {:?}", borrow_region, ref_region);
764 self.sub_regions(infer::Reborrow(span), borrow_region, ref_region);
766 // Decide whether we need to recurse and link any regions within
767 // the `ref_cmt`. This is concerned for the case where the value
768 // being reborrowed is in fact a borrowed pointer found within
769 // another borrowed pointer. For example:
771 // let p: &'b &'a mut T = ...;
775 // What makes this case particularly tricky is that, if the data
776 // being borrowed is a `&mut` or `&uniq` borrow, borrowck requires
777 // not only that `'z <= 'a`, (as before) but also `'z <= 'b`
778 // (otherwise the user might mutate through the `&mut T` reference
779 // after `'b` expires and invalidate the borrow we are looking at
782 // So let's re-examine our parameters in light of this more
783 // complicated (possible) scenario:
785 // A borrow of: `& 'z bk * * p` where `p` has type `&'b bk & 'a bk T`
786 // borrow_region ^~ ref_region ^~
787 // borrow_kind ^~ ref_kind ^~
790 // (Note that since we have not examined `ref_cmt.cat`, we don't
791 // know whether this scenario has occurred; but I wanted to show
792 // how all the types get adjusted.)
793 match ref_mutability {
794 hir::Mutability::Not => {
795 // The reference being reborrowed is a shareable ref of
796 // type `&'a T`. In this case, it doesn't matter where we
797 // *found* the `&T` pointer, the memory it references will
798 // be valid and immutable for `'a`. So we can stop here.
802 hir::Mutability::Mut => {
803 // The reference being reborrowed is either an `&mut T`. This is
804 // the case where recursion is needed.
810 /// An upvar may be behind up to 2 references:
812 /// * One can come from the reference to a "by-reference" upvar.
813 /// * Another one can come from the reference to the closure itself if it's
814 /// a `FnMut` or `Fn` closure.
816 /// This function links the lifetimes of those references to the lifetime
817 /// of the borrow that's provided. See [RegionCtxt::link_reborrowed_region] for some
818 /// more explanation of this in the general case.
820 /// We also supply a *cause*, and in this case we set the cause to
821 /// indicate that the reference being "reborrowed" is itself an upvar. This
822 /// provides a nicer error message should something go wrong.
823 fn link_upvar_region(
826 borrow_region: ty::Region<'tcx>,
827 upvar_id: ty::UpvarId,
829 debug!("link_upvar_region(borrorw_region={:?}, upvar_id={:?}", borrow_region, upvar_id);
830 // A by-reference upvar can't be borrowed for longer than the
831 // upvar is borrowed from the environment.
832 let closure_local_def_id = upvar_id.closure_expr_id;
833 let mut all_captures_are_imm_borrow = true;
834 for captured_place in self
837 .closure_min_captures
838 .get(&closure_local_def_id.to_def_id())
839 .and_then(|root_var_min_cap| root_var_min_cap.get(&upvar_id.var_path.hir_id))
843 match captured_place.info.capture_kind {
844 ty::UpvarCapture::ByRef(upvar_borrow) => {
846 infer::ReborrowUpvar(span, upvar_id),
848 captured_place.region.unwrap(),
850 if let ty::ImmBorrow = upvar_borrow {
851 debug!("link_upvar_region: capture by shared ref");
853 all_captures_are_imm_borrow = false;
856 ty::UpvarCapture::ByValue => {
857 all_captures_are_imm_borrow = false;
861 if all_captures_are_imm_borrow {
864 let fn_hir_id = self.tcx.hir().local_def_id_to_hir_id(closure_local_def_id);
865 let ty = self.resolve_node_type(fn_hir_id);
866 debug!("link_upvar_region: ty={:?}", ty);
868 // A closure capture can't be borrowed for longer than the
869 // reference to the closure.
870 if let ty::Closure(_, substs) = ty.kind() {
871 match self.infcx.closure_kind(substs) {
872 Some(ty::ClosureKind::Fn | ty::ClosureKind::FnMut) => {
873 // Region of environment pointer
874 let env_region = self.tcx.mk_region(ty::ReFree(ty::FreeRegion {
875 scope: upvar_id.closure_expr_id.to_def_id(),
876 bound_region: ty::BrEnv,
879 infer::ReborrowUpvar(span, upvar_id),
884 Some(ty::ClosureKind::FnOnce) => {}
886 span_bug!(span, "Have not inferred closure kind before regionck");