fuel-dispatch 0.19.1

// SPDX-License-Identifier: MIT OR Apache-2.0
//! `JudgeOracle` — abstraction over the Phase 6b empirical
//! profiler for the cost composer's Layer-2 refinement.
//!
//! Phase 3 of the picker-work arc.
//!
//! # Why a trait
//!
//! The Phase 6b Judge + its `DispatchTable` + `ProfileReport` all
//! live in `fuel-core` (specifically `fuel_core::judge::*` after the
//! 2026-05-31 rename of `fuel_core::dispatch` → `fuel_core::judge`).
//! `fuel-dispatch` can't depend on `fuel-core` (that would cycle —
//! `fuel-core` already depends on `fuel-dispatch`), so the integration
//! happens through a trait: this module defines the contract, and
//! `fuel-core` ships an adapter impl on top of the live profile data.
//!
//! # The contract
//!
//! For each `(op, dtype, size_class, backend, kernel_source)`
//! lookup, return the measured median latency in nanoseconds when
//! available. `None` means "no measurement" — the cost composer
//! leaves the Layer-1 static estimate in place rather than
//! substituting a fabricated number.
//!
//! `kernel_source` distinguishes sibling kernels that register at the
//! same `(backend, device)` pair — e.g. AOCL vs MKL vs portable-cpu
//! at `BackendId::Cpu`, or cuBLAS vs CUTLASS at `BackendId::Cuda`.
//! Use `""` for the legacy single-impl cells.
//!
//! Implementors are typically free-function HashMaps built once
//! from a `ProfileReport`. The trait stays narrow on purpose: the
//! optimizer ranker doesn't need to know HOW the Judge collected
//! the data, just that it can be queried per cell.

use fuel_ir::DType;
use fuel_ir::dispatch::{OpKind, SizeClass};
use fuel_ir::probe::BackendId;

/// Read-only oracle over empirical measurements. Phase 3 wires this
/// into [`super::cost::compute_static_costs`] as the optional
/// Layer-2 refinement source.
pub trait JudgeOracle: Send + Sync {
    /// Median wall-clock latency in nanoseconds for the
    /// `(op, dtype, size_class, backend, kernel_source,
    /// kernel_revision_hash)` cell. Returns `None` when the cell isn't
    /// profiled. Callers MUST treat absence as "no measurement" — not
    /// "zero" — so the static estimate stays the fallback.
    ///
    /// `kernel_source` is the [`fuel_ir::dispatch::Pick::kernel_source`]
    /// tag (e.g. `"aocl"`, `"mkl"`, `"cublas"`, `"cutlass"`,
    /// `"portable-cpu"`, `"slang"`) — the *provider*-granular axis. It
    /// alone does not disambiguate variant siblings of one provider
    /// (forty tilings of `"baracuda"`), so `kernel_revision_hash` — the
    /// content-derived *variant*-granular axis, completing
    /// `ImplId = (backend, op, dtypes, kernel_source, revision)` — is
    /// part of the key. Two distinct non-zero revisions are two cells.
    /// Pass `""` / `0` for legacy / single-impl / untracked cells.
    fn measured_latency_ns(
        &self,
        op: OpKind,
        dtype: DType,
        size_class: SizeClass,
        backend: BackendId,
        kernel_source: &str,
        kernel_revision_hash: u64,
    ) -> Option<u64>;
}

/// HashMap-backed JudgeOracle. The simplest possible impl —
/// callers (and tests) populate it from a `ProfileReport` or
/// equivalent and hand it to [`super::cost::compute_static_costs`].
///
/// Production callers typically use this directly: `fuel_core`'s
/// integration computes a `HashMapJudge` from the cached
/// `ProfileReport` once at plan-start and feeds the same instance
/// to every `compile_plan` call until the topology generation
/// changes.
#[derive(Debug, Default, Clone)]
pub struct HashMapJudge {
    entries: std::collections::HashMap<(OpKind, DType, SizeClass, BackendId, String, u64), u64>,
}

impl HashMapJudge {
    /// Empty map. Add entries via [`Self::insert`].
    pub fn new() -> Self {
        Self::default()
    }

    /// Insert one measured latency. Replaces any prior entry with
    /// the same key (last-write-wins, mirroring the conventions in
    /// `fuel_core::judge::DispatchTable::rebuild_from`).
    ///
    /// `kernel_source` distinguishes sibling kernels at the same
    /// `(backend, device)` slot — see [`JudgeOracle::measured_latency_ns`].
    /// The owned `String` is stored as part of the key; pass `""`
    /// for legacy single-impl cells.
    /// `kernel_revision_hash` is last in the parameter list (after the
    /// `latency_ns` value) deliberately: the key tuple's canonical order
    /// keeps it beside `kernel_source`, but placing it last here lets the
    /// many existing call sites append the argument rather than splice it
    /// mid-call. `0` is the untracked / single-impl default.
    pub fn insert(
        &mut self,
        op: OpKind,
        dtype: DType,
        size_class: SizeClass,
        backend: BackendId,
        kernel_source: &str,
        latency_ns: u64,
        kernel_revision_hash: u64,
    ) {
        self.entries.insert(
            (
                op,
                dtype,
                size_class,
                backend,
                kernel_source.to_string(),
                kernel_revision_hash,
            ),
            latency_ns,
        );
    }

    /// Total number of populated cells.
    pub fn len(&self) -> usize {
        self.entries.len()
    }

    /// Is the map empty?
    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }
}

impl JudgeOracle for HashMapJudge {
    fn measured_latency_ns(
        &self,
        op: OpKind,
        dtype: DType,
        size_class: SizeClass,
        backend: BackendId,
        kernel_source: &str,
        kernel_revision_hash: u64,
    ) -> Option<u64> {
        // Look up via the borrowed-key trick: build a tuple with an
        // owned `String` only when needed. Most cells use `""` or a
        // small interned tag so the allocation is cheap, and HashMap
        // borrow-trait keys for tuples-with-String don't work
        // out-of-the-box.
        self.entries
            .get(&(
                op,
                dtype,
                size_class,
                backend,
                kernel_source.to_string(),
                kernel_revision_hash,
            ))
            .copied()
    }
}

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

    #[test]
    fn hashmap_judge_round_trip() {
        let mut j = HashMapJudge::new();
        assert!(j.is_empty());
        j.insert(
            OpKind::MatMul,
            DType::F32,
            SizeClass(16),
            BackendId::Cuda,
            "cublas",
            5_000_000,
            0,
        );
        assert_eq!(j.len(), 1);
        assert_eq!(
            j.measured_latency_ns(
                OpKind::MatMul,
                DType::F32,
                SizeClass(16),
                BackendId::Cuda,
                "cublas",
                0,
            ),
            Some(5_000_000),
        );
    }

    #[test]
    fn hashmap_judge_miss_returns_none() {
        let j = HashMapJudge::new();
        assert!(
            j.measured_latency_ns(
                OpKind::AddElementwise,
                DType::F32,
                SizeClass(8),
                BackendId::Cpu,
                "",
                0,
            )
            .is_none()
        );
    }

    #[test]
    fn hashmap_judge_last_write_wins_per_kernel_source() {
        // Same (op, dtype, size, backend) but identical kernel_source —
        // last write wins per cell.
        let mut j = HashMapJudge::new();
        j.insert(
            OpKind::MatMul,
            DType::F32,
            SizeClass(16),
            BackendId::Cpu,
            "aocl",
            1_000,
            0,
        );
        j.insert(
            OpKind::MatMul,
            DType::F32,
            SizeClass(16),
            BackendId::Cpu,
            "aocl",
            2_000,
            0,
        );
        assert_eq!(
            j.measured_latency_ns(
                OpKind::MatMul,
                DType::F32,
                SizeClass(16),
                BackendId::Cpu,
                "aocl",
                0,
            ),
            Some(2_000),
        );
        // Distinct kernel_source at the same (op, dtype, size, backend)
        // produces a DISTINCT entry — no collision.
        j.insert(
            OpKind::MatMul,
            DType::F32,
            SizeClass(16),
            BackendId::Cpu,
            "mkl",
            1_500,
            0,
        );
        assert_eq!(j.len(), 2);
        assert_eq!(
            j.measured_latency_ns(
                OpKind::MatMul,
                DType::F32,
                SizeClass(16),
                BackendId::Cpu,
                "mkl",
                0,
            ),
            Some(1_500),
        );
        assert_eq!(
            j.measured_latency_ns(
                OpKind::MatMul,
                DType::F32,
                SizeClass(16),
                BackendId::Cpu,
                "aocl",
                0,
            ),
            Some(2_000),
        );
        // Unknown kernel_source at the same (op, dtype, size, backend)
        // misses — no fallthrough to either sibling.
        assert!(
            j.measured_latency_ns(
                OpKind::MatMul,
                DType::F32,
                SizeClass(16),
                BackendId::Cpu,
                "portable-cpu",
                0,
            )
            .is_none()
        );
    }

    #[test]
    fn hashmap_judge_distinguishes_backends_at_same_key() {
        let mut j = HashMapJudge::new();
        let (op, dt, sc) = (OpKind::MatMul, DType::F32, SizeClass(16));
        j.insert(op, dt, sc, BackendId::Cpu, "", 1_000_000, 0);
        j.insert(op, dt, sc, BackendId::Cuda, "", 100_000, 0);
        assert_eq!(
            j.measured_latency_ns(op, dt, sc, BackendId::Cpu, "", 0),
            Some(1_000_000)
        );
        assert_eq!(
            j.measured_latency_ns(op, dt, sc, BackendId::Cuda, "", 0),
            Some(100_000)
        );
        assert!(
            j.measured_latency_ns(op, dt, sc, BackendId::Vulkan, "", 0)
                .is_none()
        );
    }

    #[test]
    fn trait_is_dyn_compatible() {
        // Compile-time check encoded as runtime construction.
        let j: Box<dyn JudgeOracle> = Box::new(HashMapJudge::new());
        assert!(
            j.measured_latency_ns(
                OpKind::AddElementwise,
                DType::F32,
                SizeClass(0),
                BackendId::Cpu,
                "",
                0,
            )
            .is_none()
        );
    }

    /// Two entries at the same `(op, dtype, size, backend, kernel_source)`
    /// cell differing ONLY in `kernel_revision_hash` — both NON-ZERO —
    /// resolve to DISTINCT latencies. `kernel_source` alone (`"baracuda"`)
    /// cannot tell forty tilings of one provider apart, so without the
    /// revision in the key they would collapse to one cell. Both revisions
    /// are nonzero deliberately: a `0`-vs-nonzero variant would pass while
    /// real siblings still collapsed.
    #[test]
    fn sibling_kernel_revisions_do_not_collide() {
        let mut j = HashMapJudge::new();
        let (op, dt, sc, be, src) = (
            OpKind::MatMul,
            DType::F32,
            SizeClass(16),
            BackendId::Cuda,
            "baracuda",
        );
        j.insert(op, dt, sc, be, src, 5_000, 0x1111_1111_1111_1111);
        j.insert(op, dt, sc, be, src, 9_000, 0x2222_2222_2222_2222);
        assert_eq!(j.len(), 2, "distinct non-zero revisions are distinct cells");
        assert_eq!(
            j.measured_latency_ns(op, dt, sc, be, src, 0x1111_1111_1111_1111),
            Some(5_000),
        );
        assert_eq!(
            j.measured_latency_ns(op, dt, sc, be, src, 0x2222_2222_2222_2222),
            Some(9_000),
        );
        // An untracked (0) revision at the same tag is its OWN cell — no
        // fallthrough to either measured sibling.
        assert!(j.measured_latency_ns(op, dt, sc, be, src, 0).is_none());
    }
}