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

new lint that detects blocking operations in async #11578

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

J-ZhengLi
Copy link
Member

fixes: #10794

changelog: new lint [unnecessary_blocking_ops]

Ok, this is a rough one, I have no confident in many things (the name ofc), and there are certain things I wanna address before I put too much effort in it.

@rustbot
Copy link
Collaborator

rustbot commented Sep 28, 2023

r? @Jarcho

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Sep 28, 2023
@J-ZhengLi J-ZhengLi changed the title Issue10794 new lint that detects blocking operations in async Sep 28, 2023
@bors
Copy link
Collaborator

bors commented Sep 29, 2023

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

Copy link
Contributor

@Jarcho Jarcho left a comment

Choose a reason for hiding this comment

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

You can avoid the extra HIR traversals by keeping a stack of bodies and whether that body is async. check_body and check_body_post would maintain the stack and check_expr would be used to detect the calls.

You'll also need to make a distinction between async and maybe async contexts. Closures and nested functions inside an async context might run in an async context, but they may also not.

impl<'tcx> LateLintPass<'tcx> for UnnecessaryBlockingOps {
fn check_crate(&mut self, cx: &LateContext<'tcx>) {
// Avoids processing and storing a long list of paths if this lint was allowed entirely
if is_lint_allowed(cx, UNNECESSARY_BLOCKING_OPS, CRATE_HIR_ID) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Lints levels can change anywhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

@Jarcho Sorry for late response, I was a bit busy dealing with other stuffs.

I'm not sure if I fully understand this phrase:

Closures and nested functions inside an async context might run in an async context, but they may also not.

So, if there's an async function like this

async fn foo() {
    fn bar() {
        // hehe, sleep!
        std::time::sleep(INF)
    }
}

Then it shouldn't trigger any warning unless the function bar was called in foo later, correct?

Copy link
Contributor

Choose a reason for hiding this comment

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

That is correct. Unless the call occurs directly within foo there's no way to know if the function is called in an async context. Something like thread::spawn(|| sleep(10)) or thread::spawn(bar) would be fine since the sleep call doesn't block the current thread.

Copy link
Member Author

@J-ZhengLi J-ZhengLi Nov 1, 2023

Choose a reason for hiding this comment

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

That is correct. Unless the call occurs directly within foo there's no way to know if the function is called in an async context. Something like thread::spawn(|| sleep(10)) or thread::spawn(bar) would be fine since the sleep call doesn't block the current thread.

Ok, I think my code logic already prevent linting on such case, but I'm not sure, I'll add a few test cases tomorrow just in case

Edit: Actually, calling nested function in async function would have FN, so in the above example code, even if the bar gets called in foo, there wouldn't be any warnings... To lint those I'm afraid I have to loop through each body's parent, take note of the function id if there is one, then keep looping the parent to find an upper block and search every expr inside that block until a call to the noted function id is found? And ofc ignore the calls inside thread::spawn, but I got a feeling this whole thing could take a lot of time 🤔

clippy_lints/src/utils/conf.rs Outdated Show resolved Hide resolved
@Jarcho Jarcho added S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties labels Oct 8, 2023
@J-ZhengLi J-ZhengLi marked this pull request as draft October 23, 2023 10:33
@bors
Copy link
Collaborator

bors commented Oct 24, 2023

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

@J-ZhengLi J-ZhengLi force-pushed the issue10794 branch 3 times, most recently from 95ff7c8 to 0bf6239 Compare October 25, 2023 01:55
@J-ZhengLi J-ZhengLi marked this pull request as ready for review October 25, 2023 02:41
@bors
Copy link
Collaborator

bors commented Nov 14, 2023

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

@J-ZhengLi J-ZhengLi force-pushed the issue10794 branch 4 times, most recently from 976b2a2 to f26775c Compare November 16, 2023 01:27
@J-ZhengLi J-ZhengLi force-pushed the issue10794 branch 2 times, most recently from 3c822ed to 24f6dcd Compare December 25, 2023 08:30
@bors
Copy link
Collaborator

bors commented Dec 29, 2023

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

@J-ZhengLi J-ZhengLi force-pushed the issue10794 branch 2 times, most recently from 399780b to 6ac03a4 Compare January 19, 2024 07:00
Comment on lines 92 to 93
"std::io::copy",
"std::io::read_to_string",
Copy link
Contributor

Choose a reason for hiding this comment

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

These are only blocking if the underlying reader or writer are blocking. For example, copying between Vecs or reading from a Vec into a string isn't blocking in practice.

Copy link
Member Author

Choose a reason for hiding this comment

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

...only blocking if the underlying reader or writer are blocking.

That's interesting, can you further explain this?

Initially, I list those methods purely base on the observation from the tokio crate, since there are AsyncRead and AsyncWrite in the crate, I assume the Read and Write traits from std::io are blocking 😄 , but now that you mention it, I wonder if copying between slices would actually affect anything.

@bors
Copy link
Collaborator

bors commented Jan 20, 2024

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

@xFrednet
Copy link
Member

Hey @Jarcho, this is a ping from triage. Can you give this PR a review? It's totally fine if you don't have the time right now, you can reassign the PR to a random team member using r? clippy.

@J-ZhengLi could you rebase on master again? Since only conf.rs and lib.rs need to be updated it should be safe to already review this :D

@rustbot ready

@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 from the author. (Use `@rustbot ready` to update this status) labels Mar 31, 2024
@J-ZhengLi J-ZhengLi force-pushed the issue10794 branch 3 times, most recently from b1914c3 to 3194a51 Compare April 1, 2024 02:33
@J-ZhengLi
Copy link
Member Author

...
@J-ZhengLi could you rebase on master again? Since only conf.rs and lib.rs need to be updated it should be safe to already review this :D
...

yeah sure, I forgot about this one, still feel very unconfident about this one, running lintcheck gives nothing lol (maybe because not many of those use async at all).

@J-ZhengLi J-ZhengLi marked this pull request as ready for review April 1, 2024 09:46
@xFrednet
Copy link
Member

xFrednet commented Apr 1, 2024

I believe none of the lints in lintcheck use async extensively, but I could be wrong.

@bors
Copy link
Collaborator

bors commented Apr 12, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New lint suggestion: You're using a blocking operation when you could be using an async one
6 participants