vyre-runtime 0.6.1

//! Runtime-side paired speculation races for megakernel dispatch.
//!
//! The driver crate owns the backend-neutral decision math. This module
//! owns the megakernel/runtime bridge: every candidate rewrite is measured
//! as a conservative/speculative pair, the faster side is recorded in the
//! shared autotune store, and the accumulated sample window is converted
//! into the N2 adoption verdict.

use vyre_driver::autotune_store::{AutotuneRecord, AutotuneStore};
use vyre_driver::speculate::{
    record_speculative_variant_race, SpeculativeVariantDecision, SpeculativeVariantKeys,
    SpeculativeVariantRace,
};
use vyre_driver::speculation_substrate::{
    decide_speculation, SpeculationObservation, SpeculationVerdict,
};

/// One measured conservative/speculative dispatch pair.
#[derive(Debug, Clone)]
pub struct PairedSpeculationSample {
    /// Conservative dispatch elapsed time, excluding compile/cache miss.
    pub conservative_dispatch_ns: u64,
    /// Speculative dispatch elapsed time, excluding compile/cache miss.
    pub speculative_dispatch_ns: u64,
    /// Conservative compile/cache-miss time for this pair.
    pub conservative_compile_ns: u64,
    /// Speculative compile/cache-miss time for this pair.
    pub speculative_compile_ns: u64,
    /// Autotune record attached to the conservative variant.
    pub conservative_record: AutotuneRecord,
    /// Autotune record attached to the speculative variant.
    pub speculative_record: AutotuneRecord,
}

/// Result of recording one paired race.
#[derive(Debug, Clone)]
pub struct PairedSpeculationUpdate {
    /// Winning per-sample cache/autotune decision.
    pub race_decision: SpeculativeVariantDecision,
    /// Accumulated N2 verdict for the shape.
    pub verdict: SpeculationVerdict,
    /// Observation fed into the verdict.
    pub observation: SpeculationObservation,
}

/// Accumulated paired-race window for one rewrite candidate and shape.
#[derive(Debug, Default, Clone)]
pub struct PairedSpeculationWindow {
    conservative: RunningMean,
    speculative: RunningMean,
    side_compile_cost_ns: u64,
}

impl PairedSpeculationWindow {
    /// Empty paired-race window.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            conservative: RunningMean::new(),
            speculative: RunningMean::new(),
            side_compile_cost_ns: 0,
        }
    }

    /// Number of paired samples recorded.
    #[must_use]
    pub fn len(&self) -> u32 {
        self.conservative.count.min(self.speculative.count)
    }

    /// True when no paired samples were recorded.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Current observation for the N2 speculation policy.
    #[must_use]
    pub fn observation(&self) -> SpeculationObservation {
        SpeculationObservation {
            baseline_dispatches: self.conservative.count,
            baseline_mean_ns: self.conservative.mean_ns(),
            speculative_dispatches: self.speculative.count,
            speculative_mean_ns: self.speculative.mean_ns(),
            side_compile_cost_ns: self.side_compile_cost_ns,
        }
    }

    /// Record one paired sample, update the autotune store with the
    /// per-sample winner, and return the accumulated adoption verdict.
    pub fn record_sample(
        &mut self,
        store: &mut AutotuneStore,
        keys: SpeculativeVariantKeys<'_>,
        sample: PairedSpeculationSample,
    ) -> PairedSpeculationUpdate {
        self.conservative.record(sample.conservative_dispatch_ns);
        self.speculative.record(sample.speculative_dispatch_ns);
        self.side_compile_cost_ns = self
            .side_compile_cost_ns
            .checked_add(sample.speculative_compile_ns)
            .unwrap_or_else(|| {
                panic!(
                    "paired speculation side compile cost overflowed u64. Fix: reset the speculation window before accumulating more samples."
                )
            });

        let race_decision = record_speculative_variant_race(
            store,
            keys,
            SpeculativeVariantRace {
                conservative_dispatch_ns: sample.conservative_dispatch_ns,
                speculative_dispatch_ns: sample.speculative_dispatch_ns,
                conservative_compile_ns: sample.conservative_compile_ns,
                speculative_compile_ns: sample.speculative_compile_ns,
                conservative_record: sample.conservative_record,
                speculative_record: sample.speculative_record,
            },
        );
        let observation = self.observation();
        let verdict = decide_speculation(observation);
        PairedSpeculationUpdate {
            race_decision,
            verdict,
            observation,
        }
    }
}

#[derive(Debug, Default, Clone)]
struct RunningMean {
    count: u32,
    total_ns: u128,
}

impl RunningMean {
    const fn new() -> Self {
        Self {
            count: 0,
            total_ns: 0,
        }
    }

    fn record(&mut self, value_ns: u64) {
        self.count = self.count.checked_add(1).unwrap_or_else(|| {
            panic!(
                "paired speculation sample count overflowed u32. Fix: reset the speculation window before accumulating more samples."
            )
        });
        self.total_ns = self.total_ns.checked_add(u128::from(value_ns)).unwrap_or_else(|| {
            panic!(
                "paired speculation total nanoseconds overflowed u128. Fix: reset the speculation window before accumulating more samples."
            )
        });
    }

    fn mean_ns(&self) -> u64 {
        if self.count == 0 {
            return 0;
        }
        let mean = self.total_ns / u128::from(self.count);
        u64::try_from(mean).unwrap_or_else(|error| {
            panic!(
                "paired speculation mean nanoseconds cannot fit u64: {error}. Fix: reset the speculation window before accumulating more samples."
            )
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use vyre_driver::specialization::SpecCacheKey;
    use vyre_driver::speculate::SpeculativeVariantKind;

    fn key(id: u64) -> SpecCacheKey {
        SpecCacheKey {
            shader_hash: id,
            binding_sig: id << 8,
            workgroup_size: [64, 1, 1],
            spec_hash: id << 16,
        }
    }

    fn record(workgroup: u32) -> AutotuneRecord {
        AutotuneRecord {
            workgroup_size: [workgroup, 1, 1],
            unroll: 1,
            tile: [0, 0, 0],
            recorded_at: "2026-05-02".to_string(),
        }
    }

    fn sample(conservative_ns: u64, speculative_ns: u64) -> PairedSpeculationSample {
        PairedSpeculationSample {
            conservative_dispatch_ns: conservative_ns,
            speculative_dispatch_ns: speculative_ns,
            conservative_compile_ns: 0,
            speculative_compile_ns: 0,
            conservative_record: record(64),
            speculative_record: record(128),
        }
    }

    #[test]
    fn paired_window_keeps_racing_under_threshold() {
        let mut store = AutotuneStore::default();
        let conservative = key(1);
        let speculative = key(2);
        let keys = SpeculativeVariantKeys {
            conservative: &conservative,
            speculative: &speculative,
            adapter_id: "test-adapter",
        };
        let mut window = PairedSpeculationWindow::new();
        let update = window.record_sample(&mut store, keys, sample(100_000, 50_000));
        assert_eq!(update.verdict, SpeculationVerdict::KeepRacing);
        assert_eq!(update.observation.baseline_dispatches, 1);
        assert_eq!(update.observation.speculative_dispatches, 1);
    }

    #[test]
    fn paired_window_adopts_after_sustained_win() {
        let mut store = AutotuneStore::default();
        let conservative = key(3);
        let speculative = key(4);
        let keys = SpeculativeVariantKeys {
            conservative: &conservative,
            speculative: &speculative,
            adapter_id: "test-adapter",
        };
        let mut window = PairedSpeculationWindow::new();
        let mut last = None;
        for _ in 0..8 {
            last = Some(window.record_sample(&mut store, keys, sample(100_000, 50_000)));
        }
        let update = last.expect("Fix: loop records at least one sample");
        assert_eq!(update.verdict, SpeculationVerdict::Adopt);
        assert_eq!(
            update.race_decision.winner,
            SpeculativeVariantKind::Speculative
        );
        assert_eq!(store.len(), 1);
    }

    #[test]
    fn paired_window_rejects_sustained_loss() {
        let mut store = AutotuneStore::default();
        let conservative = key(5);
        let speculative = key(6);
        let keys = SpeculativeVariantKeys {
            conservative: &conservative,
            speculative: &speculative,
            adapter_id: "test-adapter",
        };
        let mut window = PairedSpeculationWindow::new();
        let mut verdict = SpeculationVerdict::KeepRacing;
        for _ in 0..8 {
            verdict = window
                .record_sample(&mut store, keys, sample(50_000, 100_000))
                .verdict;
        }
        assert_eq!(verdict, SpeculationVerdict::Reject);
    }

    #[test]
    fn paired_window_amortizes_speculative_compile_cost() {
        let mut store = AutotuneStore::default();
        let conservative = key(7);
        let speculative = key(8);
        let keys = SpeculativeVariantKeys {
            conservative: &conservative,
            speculative: &speculative,
            adapter_id: "test-adapter",
        };
        let mut window = PairedSpeculationWindow::new();
        let mut update = None;
        for _ in 0..8 {
            let mut s = sample(100_000, 50_000);
            s.speculative_compile_ns = 1_000_000;
            update = Some(window.record_sample(&mut store, keys, s));
        }
        let update = update.expect("Fix: loop records at least one sample");
        assert_eq!(update.verdict, SpeculationVerdict::Reject);
        assert_eq!(update.observation.side_compile_cost_ns, 8_000_000);
    }
}