rust-lang / rust-lang/rust-clippy

False positive using async-condvar-fair / MutexGuard moved into future that is then awaited

Open
#13,075 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-bug I-false-positive
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

Summary

When using this library the warning this MutexGuard is held across an await point fires, but I don't believe any mutex is held across await

Lint Name

await_holding_lock

Reproducer

I tried this code:

use async_condvar_fair::Condvar;
use parking_lot::Mutex;

//... 

pub struct Pools<T> {
    cond: Condvar,
    resources: Mutex<(Vec<usize>, Vec<T>)>,
}

// ...
impl<T: Send> Pools<T> {
    // ...
    pub async fn get<I: IntoIterator<Item = usize>>(&self, token_counts: I) -> Resources<T> {
        let mut guard = self.resources.lock();
        loop {
            // ...
            if some_embarrassing_garbage() {
                return more_embarrassing_garbage();
            }
            guard = self.cond.wait(guard).await;
        }
    }

I saw this happen:

❯❯  cargo clippy
warning: this `MutexGuard` is held across an `await` point
  --> src/resource.rs:38:13
   |
38 |         let mut guard = self.resources.lock();
   |             ^^^^^^^^^
   |
   = help: consider using an async-aware `Mutex` type or ensuring the `MutexGuard` is dropped before calling await
note: these are all the `await` points this lock is held through
  --> src/resource.rs:59:60
   |
59 |             guard = self.cond.wait::<MutexGuard<_>>(guard).await;
   |                                                            ^^^^^
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#await_holding_lock
   = note: `#[warn(clippy::await_holding_lock)]` on by default

warning: `local-ci` (bin "local-ci") generated 1 warning
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.04s

I do not expect any warning here because I believe the guard is moved into the future before it is awaited. (The code implementing the future will release the lock, I believe that even if it didn't, that would be a bug in the library and not something for Clippy to warn about here).

Version
rustc 1.79.0 (129f3b996 2024-06-10)
binary: rustc
commit-hash: 129f3b9964af4d4a709d1383930ade12dfe7c081
commit-date: 2024-06-10
host: x86_64-unknown-linux-gnu
release: 1.79.0
LLVM version: 18.1.7
Additional Labels

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the warning with the linked local-ci example and focus on Clippy's await_holding_lock lint. Trace how the lint handles a MutexGuard passed into the future awaited by async_condvar_fair::Condvar::wait. Done means the reported case no longer produces a false positive while genuine guards held across await points remain diagnosed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.