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

Reduce false positives of tail-expr-drop-order from consumed values #129864

Conversation

dingxiangfei2009
Copy link
Contributor

@dingxiangfei2009 dingxiangfei2009 commented Sep 1, 2024

r? @jieyouxu

To reduce false positives, the lint does not fire if the locals are consumed/moved, or the values with significant drop are consumed/moved at the tail expression location.

For this, we rely on solving a small dataflow to determine whether a Local is either live, or moved/dropped.

I am also printing the type involved for easier diagnosis.

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Sep 1, 2024
@dingxiangfei2009 dingxiangfei2009 force-pushed the reduce-false-positives-from-consumed-droppers branch 2 times, most recently from 491fb13 to de2d256 Compare September 1, 2024 18:29
@dingxiangfei2009
Copy link
Contributor Author

I also found that std::io::Error is considered to have significant drop. How weird.

type Error = !;

fn typeck_results(&self) -> Self::TypeckResults<'_> {
self.0.typeck(self.1)
Copy link
Member

Choose a reason for hiding this comment

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

This is going to be extremely expensive for the query, for the record. I would probably make some helper that caches the typeck results after the first call, or better yet just load the typeck results yourself and pass them here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I should drop this code, since we are not using this anymore.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Dropped

Comment on lines 19 to 28
match place_with_id.place.base {
PlaceBase::Rvalue => {
self.nodes.insert(place_with_id.hir_id);
}
PlaceBase::Local(id) => {
self.nodes.insert(id);
}
PlaceBase::Upvar(upvar) => {
self.nodes.insert(upvar.var_path.hir_id);
}
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't this count partial moves as full moves? Isn't that still not correct for drop ordering?

Copy link
Member

Choose a reason for hiding this comment

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

Also, doesn't this not respect different paths correctly? What about consuming operations that happen on only one branch of a conditional path? I don't know if this sort of analysis is supported with ExprUseVisitor, which has no "flow" state.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I don't have a good strategy towards that. How do we track partial moves and drops currently? Can we invoke machinery from borrow checker or somewhere else for such information?

I have switched to treat partial moves not as full moves. It could still get noisy but still safe.

}
}

fn extract_tail_expr_consuming_nodes<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> &'tcx HirIdSet {
Copy link
Member

Choose a reason for hiding this comment

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

Make this into a hook, not a query; I don't believe it needs any sort of caching, since that has overhead. This should also explain very clearly what it does.

@compiler-errors compiler-errors self-assigned this Sep 2, 2024
@jieyouxu
Copy link
Member

jieyouxu commented Sep 2, 2024

I opened a zulip thread at https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/More.20precise.20lint.20impl.20for.20Edition.202024.20tail-expr-drop-order to discuss this lint, because as @compiler-errors mentioned I feel like this might almost need to be some kind of flow analysis.

@compiler-errors
Copy link
Member

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 10, 2024
@bors
Copy link
Contributor

bors commented Sep 14, 2024

☔ The latest upstream changes (presumably #130357) made this pull request unmergeable. Please resolve the merge conflicts.

@dingxiangfei2009 dingxiangfei2009 force-pushed the reduce-false-positives-from-consumed-droppers branch from de2d256 to 08ec439 Compare September 22, 2024 20:12
@rustbot
Copy link
Collaborator

rustbot commented Sep 22, 2024

This PR changes MIR

cc @oli-obk, @RalfJung, @JakobDegen, @davidtwco, @celinval, @vakaras

Some changes occurred to MIR optimizations

cc @rust-lang/wg-mir-opt

Some changes occurred in compiler/rustc_codegen_cranelift

cc @bjorn3

These commits modify the Cargo.lock file. Unintentional changes to Cargo.lock can be introduced when switching branches and rebasing PRs.

If this was unintentional then you should revert the changes before this PR is merged.
Otherwise, you can ignore this comment.

Some changes occurred to the CTFE / Miri interpreter

cc @rust-lang/miri

place: Place<'tcx>,
target: BasicBlock,
unwind: UnwindAction,
scope: Option<(DefId, ItemLocalId)>,
Copy link
Member

Choose a reason for hiding this comment

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

Please also add a comment explaining the meaning of this new field.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added

Copy link
Member

Choose a reason for hiding this comment

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

Could you make this a ClearCrossCrate? Then it can just be a HirId.

@dingxiangfei2009 dingxiangfei2009 force-pushed the reduce-false-positives-from-consumed-droppers branch from 08ec439 to e71ad9f Compare September 22, 2024 20:31
@dingxiangfei2009
Copy link
Contributor Author

@rustbot ready

  • Reimplement the lint with flow information.
    • MaybeLiveLocal is eventually not used. It treats a move out of a whole local as a Use site and an "obligatory" drop on the same local later in the control flow as a Use site as well, even though the local is technically not live at all after the move and the later drop is treated as no-op.
  • We are still not exactly very precise here. I don't have a clue for treatment of partial moves. Help needed. 🙇

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 22, 2024
@dingxiangfei2009
Copy link
Contributor Author

I am looking at MaybeInitializedPlaces and MaybeUninitializedPlaces. They might be useful for identifying the partial moves and move paths.

@rust-log-analyzer

This comment has been minimized.

@bors
Copy link
Contributor

bors commented Sep 23, 2024

☔ The latest upstream changes (presumably #130724) made this pull request unmergeable. Please resolve the merge conflicts.

@dingxiangfei2009
Copy link
Contributor Author

cc @jieyouxu

I also gave a hard thought about upvars and whether we should lint against upvars. I have arrived at the conclusion that we should not lint against the case where upvars are dropped later than the tail expression temporaries.

What I mean is the following example, where f does not move out self.

fn should_we_lint_or_not() -> impl FnOnce() -> (?, ?) {
    let x = LoudDropper;
    move || (x.f(), LoudDropper.f())
}

Upvar x is "embedded" into the closure move || .. and, sure enough, is obliged to live as long as the closure. Upon completing evaluation of (x.f(), ..) the LoudDropper is indeed dropped first. This is a contract that we have been honoring. I think now that it was a mistake to lint against this case because the supposed transpose in drop order did not happen. This is also confirmed by the MIR output of the closure body if we check this out in the playground.

I am going to flip the test on this to not linting against.

bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 25, 2024
…ves-from-consumed-droppers, r=<try>

Reduce false positives of tail-expr-drop-order from consumed values

r? `@jieyouxu`

To reduce false positives, the lint does not fire if the locals are consumed/moved, or the values with significant drop are consumed/moved at the tail expression location.

For this, we rely on solving a small dataflow to determine whether a `Local` is either live, or moved/dropped.

I am also printing the type involved for easier diagnosis.
@bors
Copy link
Contributor

bors commented Sep 25, 2024

⌛ Trying commit 2457860 with merge 7014e13...

@@ -17,6 +17,7 @@ rustc_fluent_macro = { path = "../rustc_fluent_macro" }
rustc_hir = { path = "../rustc_hir" }
rustc_index = { path = "../rustc_index" }
rustc_infer = { path = "../rustc_infer" }
rustc_lint = { path = "../rustc_lint" }
Copy link
Contributor

Choose a reason for hiding this comment

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

Wouldn't rustc_lint_defs suffice?

@bors
Copy link
Contributor

bors commented Sep 25, 2024

☀️ Try build successful - checks-actions
Build commit: 7014e13 (7014e13d5becc920d4bea3cd87942c8a13d359bf)

@compiler-errors
Copy link
Member

@craterbot check p=1 crates=https://crater-reports.s3.amazonaws.com/pr-129604/retry-regressed-list.txt start=master#38352b01ae4af9300be03b805d6db68c45e51068 end=try#7014e13d5becc920d4bea3cd87942c8a13d359bf+rustflags=-Dtail_expr_drop_order

@craterbot
Copy link
Collaborator

🚨 Error: missing desired crates: {"dym", "maxplus", "vkopt-message-parser", "lucia", "rustoku_gui", "flp-tsl", "awsl-pest", "roast-2d", "cl-traits", "cleu-orm-derive", "future-iter", "ndsparse", "genai-custom", "restruct"}

🆘 If you have any trouble with Crater please ping @rust-lang/infra!
ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

@compiler-errors
Copy link
Member

@craterbot run mode=check-only p=1 crates=https://gist.githubusercontent.com/compiler-errors/cc84423a4a9fbc5eb598383fe2555467/raw/a11fe3433fefddaab0038ee75cd2e0ab8852748a/crates start=master#38352b01ae4af9300be03b805d6db68c45e51068 end=try#7014e13d5becc920d4bea3cd87942c8a13d359bf+rustflags=-Dtail_expr_drop_order

@craterbot
Copy link
Collaborator

👌 Experiment pr-129864 created and queued.
🔍 You can check out the queue and this experiment's details.

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

@craterbot craterbot added S-waiting-on-crater Status: Waiting on a crater run to be completed. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 25, 2024
@craterbot
Copy link
Collaborator

🚧 Experiment pr-129864 is now running

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

@craterbot
Copy link
Collaborator

🎉 Experiment pr-129864 is completed!
📊 13314 regressed and 0 fixed (70615 total)
📰 Open the full report.

⚠️ If you notice any spurious failure please add them to the blacklist!
ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

@craterbot craterbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-crater Status: Waiting on a crater run to be completed. labels Sep 26, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 27, 2024
…er, r=<try>

[crater] validate impact of marking more types as `#[rustc_insignificant_dtor]` on tail expr drop order lint

Validate impact of rust-lang#130914 on rust-lang#129864 and the tail expr drop order lint.

r? `@ghost`
tgross35 added a commit to tgross35/rust that referenced this pull request Sep 30, 2024
…, r=Amanieu

Mark some more types as having insignificant dtor

These were caught by rust-lang#129864 (comment), which is implementing a lint for some changes in drop order for temporaries in tail expressions.

Specifically, the destructors of `CString` and the bitpacked repr for `std::io::Error` are insignificant insofar as they don't have side-effects on things like locking or synchronization; they just free memory.

See some discussion on rust-lang#89144 for what makes a drop impl "significant"
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 1, 2024
Rollup merge of rust-lang#130914 - compiler-errors:insignificant-dtor, r=Amanieu

Mark some more types as having insignificant dtor

These were caught by rust-lang#129864 (comment), which is implementing a lint for some changes in drop order for temporaries in tail expressions.

Specifically, the destructors of `CString` and the bitpacked repr for `std::io::Error` are insignificant insofar as they don't have side-effects on things like locking or synchronization; they just free memory.

See some discussion on rust-lang#89144 for what makes a drop impl "significant"
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 7, 2024
…t-2, r=<try>

Reduce false positives of tail-expr-drop-order from consumed values (attempt #2)

r? `@nikomatsakis`

Related to rust-lang#129864 but not replacing, yet.

Related to rust-lang#130836.

This is an implementation of the approach suggested in the [Zulip stream](https://rust-lang.zulipchat.com/#narrow/stream/213817-t-lang/topic/temporary.20drop.20order.20changes). A new MIR statement `BackwardsIncompatibleDrop` is added to the MIR syntax. The lint now works by inspecting possibly live move paths before at the `BackwardsIncompatibleDrop` location and the actual drop under the current edition, which should be one before Edition 2024 in practice.
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 7, 2024
…t-2, r=<try>

Reduce false positives of tail-expr-drop-order from consumed values (attempt #2)

r? `@nikomatsakis`

Related to rust-lang#129864 but not replacing, yet.

Related to rust-lang#130836.

This is an implementation of the approach suggested in the [Zulip stream](https://rust-lang.zulipchat.com/#narrow/stream/213817-t-lang/topic/temporary.20drop.20order.20changes). A new MIR statement `BackwardsIncompatibleDrop` is added to the MIR syntax. The lint now works by inspecting possibly live move paths before at the `BackwardsIncompatibleDrop` location and the actual drop under the current edition, which should be one before Edition 2024 in practice.
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 8, 2024
…t-2, r=<try>

Reduce false positives of tail-expr-drop-order from consumed values (attempt #2)

r? `@nikomatsakis`

Tracked by rust-lang#123739.

Related to rust-lang#129864 but not replacing, yet.

Related to rust-lang#130836.

This is an implementation of the approach suggested in the [Zulip stream](https://rust-lang.zulipchat.com/#narrow/stream/213817-t-lang/topic/temporary.20drop.20order.20changes). A new MIR statement `BackwardsIncompatibleDrop` is added to the MIR syntax. The lint now works by inspecting possibly live move paths before at the `BackwardsIncompatibleDrop` location and the actual drop under the current edition, which should be one before Edition 2024 in practice.
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 12, 2024
…t-2, r=<try>

Reduce false positives of tail-expr-drop-order from consumed values (attempt #2)

r? `@nikomatsakis`

Tracked by rust-lang#123739.

Related to rust-lang#129864 but not replacing, yet.

Related to rust-lang#130836.

This is an implementation of the approach suggested in the [Zulip stream](https://rust-lang.zulipchat.com/#narrow/stream/213817-t-lang/topic/temporary.20drop.20order.20changes). A new MIR statement `BackwardsIncompatibleDrop` is added to the MIR syntax. The lint now works by inspecting possibly live move paths before at the `BackwardsIncompatibleDrop` location and the actual drop under the current edition, which should be one before Edition 2024 in practice.
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 20, 2024
…t-2, r=nikomatsakis

Reduce false positives of tail-expr-drop-order from consumed values (attempt #2)

r? `@nikomatsakis`

Tracked by rust-lang#123739.

Related to rust-lang#129864 but not replacing, yet.

Related to rust-lang#130836.

This is an implementation of the approach suggested in the [Zulip stream](https://rust-lang.zulipchat.com/#narrow/stream/213817-t-lang/topic/temporary.20drop.20order.20changes). A new MIR statement `BackwardsIncompatibleDrop` is added to the MIR syntax. The lint now works by inspecting possibly live move paths before at the `BackwardsIncompatibleDrop` location and the actual drop under the current edition, which should be one before Edition 2024 in practice.
@dingxiangfei2009
Copy link
Contributor Author

I am closing this since the second attempt achieve greater success.

A PoC for detecting future borrow checking error is working. What remains is to work out a good error message and suggestion. I am working on it. 🚧

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-edition-2024 Area: The 2024 edition perf-regression Performance regression. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.