Skip to content

Make must_not_suspend lint see through references when drop tracking is enabled #97962

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

Merged
merged 4 commits into from
Aug 18, 2022
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
12 changes: 10 additions & 2 deletions compiler/rustc_typeck/src/check/generator_interior.rs
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ impl<'a, 'tcx> Visitor<'tcx> for InteriorVisitor<'a, 'tcx> {
}

#[derive(Default)]
pub struct SuspendCheckData<'a, 'tcx> {
struct SuspendCheckData<'a, 'tcx> {
expr: Option<&'tcx Expr<'tcx>>,
source_span: Span,
yield_span: Span,
Expand All @@ -472,7 +472,7 @@ pub struct SuspendCheckData<'a, 'tcx> {
//
// Note that this technique was chosen over things like a `Suspend` marker trait
// as it is simpler and has precedent in the compiler
pub fn check_must_not_suspend_ty<'tcx>(
fn check_must_not_suspend_ty<'tcx>(
fcx: &FnCtxt<'_, 'tcx>,
ty: Ty<'tcx>,
hir_id: HirId,
Expand All @@ -489,6 +489,8 @@ pub fn check_must_not_suspend_ty<'tcx>(

let plural_suffix = pluralize!(data.plural_len);

debug!("Checking must_not_suspend for {}", ty);

match *ty.kind() {
ty::Adt(..) if ty.is_box() => {
let boxed_ty = ty.boxed_ty();
Expand Down Expand Up @@ -580,6 +582,12 @@ pub fn check_must_not_suspend_ty<'tcx>(
},
)
}
// If drop tracking is enabled, we want to look through references, since the referrent
// may not be considered live across the await point.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why don't we want to look through references when we are not in drop_tracking mode?

Copy link
Member

Choose a reason for hiding this comment

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

the PR description says

Unfortunately, this leads to duplicate warnings in some cases (e.g. dedup.rs), so we only use the new behavior when drop tracking is enabled.

Copy link
Contributor

Choose a reason for hiding this comment

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

I did not see that this whole function could only emit a lint.
Anyway, why does looking through references cause duplicate warnings?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the delay, I finally have time to look at this again.

Without drop tracking, we use a scope-based analysis to decide what should be considered live across an await point, while the drop tracking version is more precise. With the scope based analysis, I think what's happening is we are seeing both a &mut Umm live across the await point and an Umm live across the await point. The first one doesn't trigger the lint because we currently don't see through the reference, but we do warn on the second.

With drop tracking, we don't see the Umm but instead only see &mut Umm. In order to warn, we need to look through the reference. The reason we don't see the Umm is because drop tracking handles temporary values differently, which leads to use not considering the field in self, but only the reference to it.

ty::Ref(_region, ty, _mutability) if fcx.sess().opts.unstable_opts.drop_tracking => {
let descr_pre = &format!("{}reference{} to ", data.descr_pre, plural_suffix);
check_must_not_suspend_ty(fcx, ty, hir_id, SuspendCheckData { descr_pre, ..data })
}
_ => false,
}
}
Expand Down
30 changes: 30 additions & 0 deletions src/test/ui/lint/must_not_suspend/ref-drop-tracking.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// edition:2018
// compile-flags: -Zdrop-tracking
#![feature(must_not_suspend)]
#![deny(must_not_suspend)]

#[must_not_suspend = "You gotta use Umm's, ya know?"]
struct Umm {
i: i64
}

struct Bar {
u: Umm,
}

async fn other() {}

impl Bar {
async fn uhoh(&mut self) {
let guard = &mut self.u; //~ ERROR `Umm` held across

other().await;

*guard = Umm {
i: 2
}
}
}

fn main() {
}
27 changes: 27 additions & 0 deletions src/test/ui/lint/must_not_suspend/ref-drop-tracking.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
error: reference to `Umm` held across a suspend point, but should not be
--> $DIR/ref-drop-tracking.rs:19:13
|
LL | let guard = &mut self.u;
| ^^^^^
LL |
LL | other().await;
| ------ the value is held across this suspend point
|
note: the lint level is defined here
--> $DIR/ref-drop-tracking.rs:4:9
|
LL | #![deny(must_not_suspend)]
| ^^^^^^^^^^^^^^^^
note: You gotta use Umm's, ya know?
--> $DIR/ref-drop-tracking.rs:19:13
|
LL | let guard = &mut self.u;
| ^^^^^
help: consider using a block (`{ ... }`) to shrink the value's scope, ending before the suspend point
--> $DIR/ref-drop-tracking.rs:19:13
|
LL | let guard = &mut self.u;
| ^^^^^

error: aborting due to previous error