Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NLL] Use span of the closure args in free region errors #53088

Merged
merged 2 commits into from
Aug 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

use borrow_check::nll::region_infer::RegionInferenceContext;
use borrow_check::nll::ToRegionVid;
use borrow_check::nll::universal_regions::DefiningTy;
use rustc::hir;
use rustc::hir::def_id::DefId;
use rustc::infer::InferCtxt;
Expand Down Expand Up @@ -72,7 +73,7 @@ impl<'tcx> RegionInferenceContext<'tcx> {
})
.or_else(|| {
self.give_name_if_anonymous_region_appears_in_output(
infcx.tcx, mir, fr, counter, diag)
infcx, mir, mir_def_id, fr, counter, diag)
})
.unwrap_or_else(|| span_bug!(mir.span, "can't make a name for free region {:?}", fr))
}
Expand Down Expand Up @@ -107,13 +108,46 @@ impl<'tcx> RegionInferenceContext<'tcx> {
},

ty::BoundRegion::BrEnv => {
let closure_span = tcx.hir.span_if_local(mir_def_id).unwrap();
let region_name = self.synthesize_region_name(counter);
diag.span_label(
closure_span,
format!("lifetime `{}` represents the closure body", region_name),
);
Some(region_name)
let mir_node_id = tcx.hir.as_local_node_id(mir_def_id).expect("non-local mir");
let def_ty = self.universal_regions.defining_ty;

if let DefiningTy::Closure(def_id, substs) = def_ty {
let args_span = if let hir::ExprKind::Closure(_, _, _, span, _)
= tcx.hir.expect_expr(mir_node_id).node
{
span
} else {
bug!("Closure is not defined by a closure expr");
};
let region_name = self.synthesize_region_name(counter);
diag.span_label(
args_span,
format!("lifetime `{}` represents this closure's body", region_name),
);

let closure_kind_ty = substs.closure_kind_ty(def_id, tcx);
let note = match closure_kind_ty.to_opt_closure_kind() {
Some(ty::ClosureKind::Fn) => {
"closure implements `Fn`, so references to captured variables \
can't escape the closure"
}
Some(ty::ClosureKind::FnMut) => {
"closure implements `FnMut`, so references to captured variables \
can't escape the closure"
}
Some(ty::ClosureKind::FnOnce) => {
bug!("BrEnv in a `FnOnce` closure");
}
None => bug!("Closure kind not inferred in borrow check"),
};

diag.note(note);

Some(region_name)
} else {
// Can't have BrEnv in functions, constants or generators.
bug!("BrEnv outside of closure.");
}
}

ty::BoundRegion::BrAnon(_) | ty::BoundRegion::BrFresh(_) => None,
Expand Down Expand Up @@ -543,28 +577,51 @@ impl<'tcx> RegionInferenceContext<'tcx> {
/// or be early bound (named, not in argument).
fn give_name_if_anonymous_region_appears_in_output(
&self,
tcx: TyCtxt<'_, '_, 'tcx>,
infcx: &InferCtxt<'_, '_, 'tcx>,
mir: &Mir<'tcx>,
mir_def_id: DefId,
fr: RegionVid,
counter: &mut usize,
diag: &mut DiagnosticBuilder<'_>,
) -> Option<InternedString> {
let tcx = infcx.tcx;

let return_ty = self.universal_regions.unnormalized_output_ty;
debug!(
"give_name_if_anonymous_region_appears_in_output: return_ty = {:?}",
return_ty
);
if !tcx.any_free_region_meets(&return_ty, |r| r.to_region_vid() == fr) {
if !infcx.tcx.any_free_region_meets(&return_ty, |r| r.to_region_vid() == fr) {
return None;
}

let region_name = self.synthesize_region_name(counter);
let type_name = with_highlight_region(fr, *counter, || {
infcx.extract_type_name(&return_ty)
});

let mir_node_id = tcx.hir.as_local_node_id(mir_def_id).expect("non-local mir");

let (return_span, mir_description) = if let hir::ExprKind::Closure(_, _, _, span, gen_move)
= tcx.hir.expect_expr(mir_node_id).node
{
(
tcx.sess.codemap().end_point(span),
if gen_move.is_some() { " of generator" } else { " of closure" }
)
} else {
// unreachable?
(mir.span, "")
};

diag.span_label(
mir.span,
format!("lifetime `{}` appears in return type", region_name),
return_span,
format!("return type{} is {}", mir_description, type_name),
);

Some(region_name)
// This counter value will already have been used, so this function will increment it
// so the next value will be used next and return the region name that would have been
// used.
Some(self.synthesize_region_name(counter))
}

/// Create a synthetic region named `'1`, incrementing the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ error: unsatisfied lifetime constraints
--> $DIR/E0621-does-not-trigger-for-closures.rs:25:26
|
LL | invoke(&x, |a, b| if a > b { a } else { b }); //~ ERROR E0495
| ----------^^^^^-----------------
| | | |
| | | requires that `'1` must outlive `'2`
| | has type `&'1 i32`
| lifetime `'2` appears in return type
| -- ^^^^^ requires that `'1` must outlive `'2`
| ||
| |return type of closure is &'2 i32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so nice

| has type `&'1 i32`

error: aborting due to previous error

20 changes: 9 additions & 11 deletions src/test/ui/issue-40510-1.nll.stderr
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
error: unsatisfied lifetime constraints
--> $DIR/issue-40510-1.rs:18:9
|
LL | || {
| _____-
| |_____|
| ||
LL | || &mut x
| || ^^^^^^ return requires that `'1` must outlive `'2`
LL | || };
| || -
| ||_____|
| |______lifetime `'1` represents the closure body
| lifetime `'2` appears in return type
LL | || {
| --
| ||
| |return type of closure is &'2 mut std::boxed::Box<()>
| lifetime `'1` represents this closure's body
LL | &mut x
| ^^^^^^ return requires that `'1` must outlive `'2`
|
= note: closure implements `FnMut`, so references to captured variables can't escape the closure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also so nice — I do wonder if we can "re-orient" the message around this note though. Something like this:

error: captured variable cannot escape a `FnMut` closure
  --> $DIR/issue-40510-1.rs:18:9
   |
LL |     || {
   |     -- closure implements `FnMut`, so references to captured variables can't escape the closure
LL |         &mut x
   |         ^^^^^^ returns a reference that is local to the closure

error: aborting due to previous error

maybe we should shelve this for a later improvement, though -- in particular, I would really like to do a bit more analysis and connect the message to the variable x. Something like this:

error: captured variable cannot escape a `FnMut` closure
  --> $DIR/issue-40510-1.rs:18:9
   |
LL |     || {
   |     -- closure implements `FnMut`, so references to captured variables can't escape the closure
LL |         &mut x
   |              ^ references to `x` cannot escape the closure body

error: aborting due to previous error


error: aborting due to previous error

25 changes: 11 additions & 14 deletions src/test/ui/issue-40510-3.nll.stderr
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
error: unsatisfied lifetime constraints
--> $DIR/issue-40510-3.rs:18:9
|
LL | || {
| _____-
| |_____|
| ||
LL | || || {
| ||_________^
LL | ||| x.push(())
LL | ||| }
| |||_________^ requires that `'1` must outlive `'2`
LL | || };
| || -
| ||_____|
| |______lifetime `'1` represents the closure body
| lifetime `'2` appears in return type
LL | || {
| --
| ||
| |return type of closure is [closure@$DIR/issue-40510-3.rs:18:9: 20:10 x:&'2 mut std::vec::Vec<()>]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another place we should take a note for future improvement: rather than printing the return type here, I'd rather we found some way to describe the role that '2 plays (i.e., the reference to x). But this is a start.

| lifetime `'1` represents this closure's body
LL | / || {
LL | | x.push(())
LL | | }
| |_________^ requires that `'1` must outlive `'2`
|
= note: closure implements `FnMut`, so references to captured variables can't escape the closure

error: aborting due to previous error

25 changes: 11 additions & 14 deletions src/test/ui/issue-49824.nll.stderr
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
error: unsatisfied lifetime constraints
--> $DIR/issue-49824.rs:22:9
|
LL | || {
| _____-
| |_____|
| ||
LL | || || {
| ||_________^
LL | ||| let _y = &mut x;
LL | ||| }
| |||_________^ requires that `'1` must outlive `'2`
LL | || };
| || -
| ||_____|
| |______lifetime `'1` represents the closure body
| lifetime `'2` appears in return type
LL | || {
| --
| ||
| |return type of closure is [closure@$DIR/issue-49824.rs:22:9: 24:10 x:&'2 mut i32]
| lifetime `'1` represents this closure's body
LL | / || {
LL | | let _y = &mut x;
LL | | }
| |_________^ requires that `'1` must outlive `'2`
|
= note: closure implements `FnMut`, so references to captured variables can't escape the closure

error: aborting due to previous error

11 changes: 6 additions & 5 deletions src/test/ui/nll/issue-48238.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ error: unsatisfied lifetime constraints
--> $DIR/issue-48238.rs:21:13
|
LL | move || use_val(&orig); //~ ERROR
| --------^^^^^^^^^^^^^^
| | |
| | argument requires that `'1` must outlive `'2`
| lifetime `'1` represents the closure body
| lifetime `'2` appears in return type
| ------- ^^^^^^^^^^^^^^ argument requires that `'1` must outlive `'2`
| | |
| | return type of closure is &'2 u8
| lifetime `'1` represents this closure's body
|
= note: closure implements `Fn`, so references to captured variables can't escape the closure

error: aborting due to previous error