deloxide 1.1.0

//! Condvar Tracking and Integration with Deloxide Detector
//!
//! This module defines all the Condvar-related hooks and Detector methods needed for
//! deadlock detection and logging of Condvar operations (wait, notify). It bridges
//! condvar operations with mutex operations to ensure correct cycle detection.

use crate::core::detector::GLOBAL_DETECTOR;
use crate::core::detector::deadlock_handling;
use crate::core::logger;
use crate::core::types::{CondvarId, DeadlockInfo, LockId, ThreadId};
use crate::core::{Detector, Events, WaitIntent, WaitMode, get_current_thread_id};
use std::collections::VecDeque;

impl Detector {
    /// Register a condvar creation
    ///
    /// # Arguments
    /// * `condvar_id` - ID of the created condition variable
    pub fn create_condvar(&mut self, condvar_id: CondvarId) {
        // Initialize the wait queue for this condvar
        self.cv_waiters.insert(condvar_id, VecDeque::new());

        logger::log_lock_event(
            condvar_id,
            Some(get_current_thread_id()),
            Events::CondvarSpawn,
        );
    }

    /// Register condvar destruction
    ///
    /// # Arguments
    /// * `condvar_id` - ID of the condition variable being destroyed
    pub fn destroy_condvar(&mut self, condvar_id: CondvarId) {
        // Clear wait queue
        self.cv_waiters.remove(&condvar_id);

        // Clear any thread wait mappings for this condvar
        self.thread_wait_cv
            .retain(|_, &mut (cv_id, _)| cv_id != condvar_id);

        logger::log_lock_event(condvar_id, None, Events::CondvarExit);
    }

    /// Register the beginning of a condvar wait operation
    ///
    /// This method is called when a thread begins waiting on a condition variable.
    /// It tracks which threads are waiting on which condvars and which mutex they
    /// will need to reacquire.
    ///
    /// # Arguments
    /// * `thread_id` - ID of the thread beginning to wait
    /// * `condvar_id` - ID of the condition variable being waited on
    /// * `mutex_id` - ID of the mutex that will be reacquired after the wait
    pub fn begin_wait(&mut self, thread_id: ThreadId, condvar_id: CondvarId, mutex_id: LockId) {
        // Add thread to the wait queue for this condvar
        if let Some(queue) = self.cv_waiters.get_mut(&condvar_id) {
            queue.push_back((thread_id, mutex_id));
        } else {
            self.cv_waiters
                .insert(condvar_id, VecDeque::from([(thread_id, mutex_id)]));
        }

        // Track what this thread is waiting for
        self.thread_wait_cv
            .insert(thread_id, (condvar_id, mutex_id));

        logger::log_interaction_event(thread_id, condvar_id, Events::CondvarWaitBegin);
    }

    /// Register a condvar notify_one operation
    ///
    /// This method is called when a thread calls notify_one on a condition variable.
    ///
    /// # Arguments
    /// * `condvar_id` - ID of the condition variable being notified
    /// * `notifier_id` - ID of the thread performing the notification
    pub fn notify_one(
        &mut self,
        condvar_id: CondvarId,
        notifier_id: ThreadId,
    ) -> Vec<DeadlockInfo> {
        // Wake one waiter if any exist
        let (woken_thread_info, deadlocks) = if let Some(queue) =
            self.cv_waiters.get_mut(&condvar_id)
            && let Some((waiter_thread, mutex_id)) = queue.pop_front()
        {
            // Mark as woken (for diagnostics)
            self.cv_woken.insert(waiter_thread);
            let deadlocks = self.on_mutex_attempt_synthetic_immediate(waiter_thread, mutex_id);
            (Some((waiter_thread, mutex_id)), deadlocks)
        } else {
            (None, Vec::new())
        };

        let woken_thread_id = woken_thread_info.map(|(t, _)| t);

        // Log the notify event with woken thread information
        logger::log_condvar_notify_event(
            notifier_id,
            condvar_id,
            Events::CondvarNotifyOne,
            woken_thread_id,
        );

        // Log the synthetic mutex attempt for the woken thread
        if let Some((thread_id, mutex_id)) = woken_thread_info {
            logger::log_interaction_event(thread_id, mutex_id, Events::MutexAttempt);
        }

        deadlocks
    }

    /// Register a condvar notify_all operation
    ///
    /// This method is called when a thread calls notify_all on a condition variable.
    ///
    /// # Arguments
    /// * `condvar_id` - ID of the condition variable being notified
    /// * `notifier_id` - ID of the thread performing the notification
    pub fn notify_all(
        &mut self,
        condvar_id: CondvarId,
        notifier_id: ThreadId,
    ) -> Vec<DeadlockInfo> {
        // Wake all waiters and collect their IDs
        let waiters_to_wake: Vec<(ThreadId, LockId)> =
            if let Some(queue) = self.cv_waiters.get_mut(&condvar_id) {
                queue.drain(..).collect()
            } else {
                Vec::new()
            };

        let woken_threads: Vec<ThreadId> = waiters_to_wake.iter().map(|(t, _)| *t).collect();
        let mut all_deadlocks = Vec::new();

        for (waiter_thread, mutex_id) in &waiters_to_wake {
            // Mark as woken (for diagnostics)
            self.cv_woken.insert(*waiter_thread);
            let deadlocks = self.on_mutex_attempt_synthetic_immediate(*waiter_thread, *mutex_id);
            all_deadlocks.extend(deadlocks);
        }

        // Log the notify event - for notify_all, we log the first woken thread (if any)
        // The visualization can show all woken threads were affected by this sequence number
        logger::log_condvar_notify_event(
            notifier_id,
            condvar_id,
            Events::CondvarNotifyAll,
            woken_threads.first().copied(),
        );

        // Log the synthetic mutex attempt for all woken threads
        for (waiter_thread, mutex_id) in waiters_to_wake {
            logger::log_interaction_event(waiter_thread, mutex_id, Events::MutexAttempt);
        }

        all_deadlocks
    }

    /// Register the end of a condvar wait operation
    ///
    /// This method is called when a thread's wait operation completes (mutex reacquired).
    /// It cleans up the wait tracking.
    ///
    /// # Arguments
    /// * `thread_id` - ID of the thread whose wait is ending
    /// * `condvar_id` - ID of the condition variable that was waited on
    /// * `mutex_id` - ID of the mutex that was reacquired
    pub fn end_wait(&mut self, thread_id: ThreadId, condvar_id: CondvarId, mutex_id: LockId) {
        if let Some(waiters) = self.cv_waiters.get_mut(&condvar_id) {
            waiters.retain(|(waiter, lock)| *waiter != thread_id || *lock != mutex_id);
        }

        // Remove from thread wait tracking
        self.thread_wait_cv.remove(&thread_id);

        // Remove from woken set if present
        self.cv_woken.remove(&thread_id);
        self.clear_wait_intent(thread_id);

        // Note: CondvarWaitEnd is now logged at a higher level after MutexAcquired
    }

    /// Synthetic mutex attempt for condvar operations (immediate processing)
    ///
    /// # Arguments
    /// * `thread_id` - ID of the thread attempting to acquire the mutex
    /// * `lock_id` - ID of the mutex being attempted
    ///
    /// # Note
    /// This method does NOT attempt actual lock acquisition - it only sets up
    /// wait-for edges and performs cycle detection. The actual acquisition will
    /// happen when the woken thread calls the mutex wrapper's lock() method.
    fn on_mutex_attempt_synthetic_immediate(
        &mut self,
        thread_id: ThreadId,
        lock_id: LockId,
    ) -> Vec<DeadlockInfo> {
        let mut deadlocks = Vec::new();

        // Check for lock order violations (only if graph exists and holding other locks)
        #[cfg(feature = "lock-order-graph")]
        let lock_order_violation = if self.lock_order_graph.is_some()
            && self.thread_holds.get(&thread_id).map_or(0, |h| h.len()) >= 1
        {
            self.check_lock_order_violation(thread_id, lock_id)
        } else {
            None
        };
        #[cfg(not(feature = "lock-order-graph"))]
        let _lock_order_violation: Option<Vec<LockId>> = None;

        if self.mutex_owners.contains_key(&lock_id)
            && let Some(cycle) =
                self.register_wait(thread_id, WaitIntent::new(lock_id, WaitMode::Mutex))
        {
            let filtered_cycle = self.filter_cycle_by_common_locks(&cycle);

            if !filtered_cycle.is_empty()
                && let Some(info) = self.validated_deadlock_info(cycle)
            {
                deadlocks.push(info);
            }
        }

        // Report lock order violation if detected
        #[cfg(feature = "lock-order-graph")]
        if let Some(lock_cycle) = lock_order_violation {
            deadlocks.push(self.extract_lock_order_violation_info(thread_id, lock_id, lock_cycle));
        }

        // Keep thread in cv_woken set - it will be cleared when actual acquisition happens
        deadlocks
    }
}

/// Register a condvar creation with the global detector
///
/// # Arguments
/// * `condvar_id` - ID of the created condition variable
pub fn create_condvar(condvar_id: CondvarId) {
    let mut detector = GLOBAL_DETECTOR.lock();
    detector.create_condvar(condvar_id);
}

/// Register condvar destruction with the global detector
///
/// # Arguments
/// * `condvar_id` - ID of the condition variable being destroyed
pub fn destroy_condvar(condvar_id: CondvarId) {
    let mut detector = GLOBAL_DETECTOR.lock();
    detector.destroy_condvar(condvar_id);
}

/// Register the beginning of a condvar wait with the global detector
///
/// # Arguments
/// * `thread_id` - ID of the thread beginning to wait
/// * `condvar_id` - ID of the condition variable being waited on
/// * `mutex_id` - ID of the mutex that will be reacquired after the wait
pub fn begin_wait(thread_id: ThreadId, condvar_id: CondvarId, mutex_id: LockId) {
    let mut detector = GLOBAL_DETECTOR.lock();
    detector.begin_wait(thread_id, condvar_id, mutex_id);
}

/// Register a condvar notify_one with the global detector
///
/// # Arguments
/// * `condvar_id` - ID of the condition variable being notified
/// * `notifier_id` - ID of the thread performing the notification
pub fn notify_one(condvar_id: CondvarId, notifier_id: ThreadId) {
    let deadlocks = {
        let mut detector = GLOBAL_DETECTOR.lock();
        detector.notify_one(condvar_id, notifier_id)
    };

    for info in deadlocks {
        deadlock_handling::process_deadlock(info);
    }
}

/// Register a condvar notify_all with the global detector
///
/// # Arguments
/// * `condvar_id` - ID of the condition variable being notified
/// * `notifier_id` - ID of the thread performing the notification
pub fn notify_all(condvar_id: CondvarId, notifier_id: ThreadId) {
    let deadlocks = {
        let mut detector = GLOBAL_DETECTOR.lock();
        detector.notify_all(condvar_id, notifier_id)
    };

    for info in deadlocks {
        deadlock_handling::process_deadlock(info);
    }
}

/// Register the end of a condvar wait with the global detector
///
/// # Arguments
/// * `thread_id` - ID of the thread whose wait is ending
/// * `condvar_id` - ID of the condition variable that was waited on
/// * `mutex_id` - ID of the mutex that was reacquired
pub fn end_wait(thread_id: ThreadId, condvar_id: CondvarId, mutex_id: LockId) {
    let mut detector = GLOBAL_DETECTOR.lock();
    detector.end_wait(thread_id, condvar_id, mutex_id);
}

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

    #[test]
    fn end_wait_removes_exact_condvar_waiter() {
        let mut detector = Detector::new();
        detector.create_condvar(20);
        detector.begin_wait(1, 20, 10);

        detector.end_wait(1, 20, 10);

        assert!(detector.cv_waiters[&20].is_empty());
        assert!(!detector.thread_wait_cv.contains_key(&1));
        assert!(!detector.cv_woken.contains(&1));
    }

    #[test]
    fn notify_without_mutex_owner_does_not_invent_dependency() {
        let mut detector = Detector::new();
        detector.create_condvar(20);
        detector.begin_wait(1, 20, 10);

        let deadlocks = detector.notify_one(20, 9);

        assert!(deadlocks.is_empty());
        assert!(!detector.thread_waits_for.contains_key(&1));
    }
}