moirai-async 0.7.0

#![expect(
    clippy::unwrap_used,
    reason = "ratchet MOIRAI-UNWRAP-1: pre-existing debt"
)]

use std::future::Future;
use std::pin::Pin;
use std::task::{Context, Poll, Waker};

use crate::sync::wait_queue::{WaitQueue, WaiterPoll};

use super::mutex::{Mutex, MutexGuard};

fn noop_waker() -> Waker {
    Waker::noop().clone()
}

/// Async condition variable pairing with the async [`Mutex`].
pub struct Condvar {
    state: std::sync::Mutex<CondvarState>,
}

struct CondvarState {
    waiters: WaitQueue<()>,
}

impl Condvar {
    /// Create a condition variable with no waiters.
    pub fn new() -> Self {
        Self {
            state: std::sync::Mutex::new(CondvarState {
                waiters: WaitQueue::new(),
            }),
        }
    }

    /// Release the guard, wait for a notification, and reacquire.
    pub async fn wait<'a, T>(&self, guard: MutexGuard<'a, T>) -> MutexGuard<'a, T> {
        let mutex_ref: &'a Mutex<T> = guard.mutex;
        // Register a pending waiter WHILE still holding the outer MutexGuard.
        // This closes the lost-notification window: a concurrent notify_one/all
        // after the guard is dropped will see this waiter (or will have already
        // seen it and set Granted, which poll_waiter returns immediately).
        let id = {
            let mut state = self.state.lock().unwrap();
            state.waiters.register(noop_waker())
        };
        drop(guard);
        CondvarNotifyFuture {
            condvar: self,
            id: Some(id),
        }
        .await;
        mutex_ref.lock().await
    }

    /// Wait until `condition` on the guarded value turns false.
    pub async fn wait_while<'a, T, F>(
        &self,
        guard: MutexGuard<'a, T>,
        mut condition: F,
    ) -> MutexGuard<'a, T>
    where
        F: FnMut(&T) -> bool,
    {
        let mut guard = guard;
        while condition(&guard) {
            guard = self.wait(guard).await;
        }
        guard
    }

    /// Wake the oldest waiter, if any.
    ///
    /// The waker is taken under the state lock and woken after it is released:
    /// `Waker::wake` may poll the task inline on this thread, and that poll
    /// re-locks this state — waking under the lock would self-deadlock. Same
    /// discipline as `notify_all` below and `hybrid::notify`.
    pub fn notify_one(&self) {
        let waker = {
            let mut state = self.state.lock().unwrap();
            state.waiters.grant_oldest(())
        };
        if let Some(waker) = waker {
            waker.wake();
        }
    }

    /// Wake every current waiter.
    pub fn notify_all(&self) {
        let mut state = self.state.lock().unwrap();
        let wakers = state.waiters.grant_all(());
        drop(state);
        for waker in wakers {
            waker.wake();
        }
    }
}

impl Default for Condvar {
    fn default() -> Self {
        Self::new()
    }
}

struct CondvarNotifyFuture<'a> {
    condvar: &'a Condvar,
    id: Option<u64>,
}

impl<'a> Future for CondvarNotifyFuture<'a> {
    type Output = ();

    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let mut state = self.condvar.state.lock().unwrap();

        if let Some(id) = self.id {
            match state.waiters.poll_waiter(id, cx.waker()) {
                WaiterPoll::Granted(()) => {
                    self.id = None;
                    return Poll::Ready(());
                }
                WaiterPoll::Pending => return Poll::Pending,
                WaiterPoll::NotRegistered => {}
            }
        }

        if self.id.is_none() {
            self.id = Some(state.waiters.register(cx.waker().clone()));
        }

        Poll::Pending
    }
}

impl<'a> Drop for CondvarNotifyFuture<'a> {
    fn drop(&mut self) {
        if let Some(id) = self.id
            && let Ok(mut state) = self.condvar.state.lock()
        {
            state.waiters.deregister(id);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_condvar_notify_one() {
        let cv = Condvar::new();
        cv.notify_one();
    }

    #[test]
    fn test_condvar_notify_all() {
        let cv = Condvar::new();
        cv.notify_all();
    }
}