Skip to main content

cortiq_engine/
gpu.rs

1//! Facade for GPU backends: a single call entry point for qtensor/pipeline/
2//! linear_core. Job types and the threshold are canonical HERE; behind the
3//! facade dispatch goes to a platform backend:
4//!   - `gpu_metal` (Apple Silicon, unified memory + no-copy buffers);
5//!   - `gpu_wgpu` (C1: Vulkan/DX12/Metal — NVIDIA/Radeon/Intel/Apple,
6//!     weights resident in VRAM), available under `--features gpu`.
7//!
8//! Runtime selection via `CMF_GPU`: `1` — native Metal (macOS) or wgpu
9//! (other OSes); `wgpu` — force wgpu (including for the local
10//! Metal-via-wgpu parity test). Any backend refusal — `false` and the honest
11//! CPU path, no partial results.
12
13use cortiq_core::CmfModel;
14use std::cell::Cell;
15use std::sync::atomic::{AtomicU8, AtomicU32, AtomicU64, Ordering};
16use std::sync::{Arc, OnceLock};
17
18thread_local! {
19    /// Index of the current forward layer (−1 = outside a numbered layer:
20    /// lm_head/embed — always allowed). The pipeline sets it before
21    /// each layer so that the GPU/CPU layer-split works.
22    static CUR_LAYER: Cell<i64> = const { Cell::new(-1) };
23    /// Inside `cpu_scope` every GPU gate reports disabled: the timed CPU
24    /// arm of a probe (and a class that lost its probe) must run PURE
25    /// CPU, or inner per-op hooks would re-enter the GPU and poison the
26    /// comparison.
27    static CPU_ONLY: Cell<bool> = const { Cell::new(false) };
28    /// "This op paid a one-off cost" (weight upload / first pipeline
29    /// build): backends set it, `probe_record` discards the sample so
30    /// only steady-state timings compete.
31    static PROBE_COLD: Cell<bool> = const { Cell::new(false) };
32}
33
34/// Run `f` with the GPU gates off on this thread (pure-CPU arm).
35pub fn cpu_scope<R>(f: impl FnOnce() -> R) -> R {
36    struct Restore(bool);
37    impl Drop for Restore {
38        fn drop(&mut self) {
39            CPU_ONLY.with(|c| c.set(self.0));
40        }
41    }
42    let previous = CPU_ONLY.with(|c| c.replace(true));
43    let _restore = Restore(previous);
44    f()
45}
46
47/// Backends: note a one-off cost (weight upload, buffer-cache fill) so
48/// the probe discards this sample.
49pub(crate) fn probe_note_cold() {
50    PROBE_COLD.with(|c| c.set(true));
51}
52
53/// Pipeline: mark the current layer (or −1 outside layers) for layer-split.
54pub fn set_layer(l: i64) {
55    CUR_LAYER.with(|c| c.set(l));
56}
57
58/// The layer `set_layer` last marked on this thread (−1 outside layers).
59pub fn cur_layer() -> i64 {
60    CUR_LAYER.with(|c| c.get())
61}
62
63/// Parse `CMF_GPU_LAYERS` («0-19», «0,2,4», «0-9,30-39») once.
64/// None = no restriction (all layers on GPU). Garbage → also no restriction.
65fn layer_ranges() -> &'static Option<Vec<(i64, i64)>> {
66    static R: OnceLock<Option<Vec<(i64, i64)>>> = OnceLock::new();
67    R.get_or_init(|| {
68        let s = std::env::var("CMF_GPU_LAYERS").ok()?;
69        let mut v = Vec::new();
70        for part in s.split(',') {
71            let part = part.trim();
72            match part.split_once('-') {
73                Some((a, b)) => v.push((a.trim().parse().ok()?, b.trim().parse().ok()?)),
74                None => {
75                    let x: i64 = part.parse().ok()?;
76                    v.push((x, x));
77                }
78            }
79        }
80        Some(v)
81    })
82}
83
84fn layer_allowed() -> bool {
85    match layer_ranges() {
86        None => true,
87        Some(ranges) => {
88            let cur = CUR_LAYER.with(|c| c.get());
89            cur < 0 || ranges.iter().any(|(a, b)| cur >= *a && cur <= *b)
90        }
91    }
92}
93
94/// GPU allowed FOR THE CURRENT LAYER: backend is initialized AND the layer
95/// falls within `CMF_GPU_LAYERS` (GPU/CPU layer-split) AND we are not
96/// inside a `cpu_scope`. Op gates call this.
97pub fn enabled_here() -> bool {
98    !CPU_ONLY.with(|c| c.get()) && enabled() && layer_allowed()
99}
100
101// ── Runtime GPU-vs-CPU probe ────────────────────────────────────────────
102// CMF_GPU=1 does not TRUST that the device wins — it MEASURES. For each
103// op class the first calls alternate arms: GPU timed vs pure-CPU timed
104// (under cpu_scope). Cold GPU calls (weight upload / cache fill) are
105// discarded; after PROBE_SAMPLES clean samples per arm the faster arm is
106// chosen for the rest of the process. Rationale: submit+poll latency
107// differs by an order of magnitude across driver stacks (Metal/PCIe
108// ~3-4 ms, Vulkan/4090 ~0.3 ms) — a static threshold cannot know whether
109// per-op offload pays off HERE. CMF_GPU_PROBE=0 → always trust the GPU.
110
111/// GPU-eligible op classes, each with an independent probe.
112#[derive(Clone, Copy)]
113pub enum OpClass {
114    /// Whole FFN chain in one submission (dense / MoE block).
115    Ffn = 0,
116    /// Large hybrid CPU∥GPU matvec (lm_head class).
117    Matvec = 1,
118    /// Prefill GEMM (matmat).
119    Matmat = 2,
120    /// Batched matvecs of one input (QKV).
121    Batch = 3,
122}
123
124/// Probe verdict for one call.
125pub enum ProbeArm {
126    /// Run the GPU path (during probing: timed, recorded).
127    Gpu,
128    /// Probing: run the CPU path under `cpu_scope`, timed, recorded.
129    CpuTimed,
130    /// Decided: CPU won — run the CPU path (under `cpu_scope`).
131    Cpu,
132}
133
134/// Clean samples per arm before a class decides.
135const PROBE_SAMPLES: u32 = 6;
136
137struct Probe {
138    /// 0 = probing, 1 = GPU won, 2 = CPU won.
139    state: AtomicU8,
140    flip: AtomicU32,
141    gpu_ns: AtomicU64,
142    gpu_n: AtomicU32,
143    cpu_ns: AtomicU64,
144    cpu_n: AtomicU32,
145}
146
147impl Probe {
148    const fn new() -> Self {
149        Self {
150            state: AtomicU8::new(0),
151            flip: AtomicU32::new(0),
152            gpu_ns: AtomicU64::new(0),
153            gpu_n: AtomicU32::new(0),
154            cpu_ns: AtomicU64::new(0),
155            cpu_n: AtomicU32::new(0),
156        }
157    }
158}
159
160static PROBES: [Probe; 4] = [Probe::new(), Probe::new(), Probe::new(), Probe::new()];
161
162fn probe_on() -> bool {
163    static ON: OnceLock<bool> = OnceLock::new();
164    *ON.get_or_init(|| {
165        std::env::var("CMF_GPU_PROBE")
166            .map(|v| v != "0" && v != "off")
167            .unwrap_or(true)
168    })
169}
170
171/// q1 ops on the native Metal backend skip the probe entirely: the CPU
172/// q1 kernel is load-port-bound, the GPU one wins warm — and probe
173/// alternation itself cools the device between samples (measured: block
174/// times 5.8 ms warm vs 8.8 ms mixed). Other backends keep probing.
175pub fn q1_force() -> bool {
176    #[cfg(target_os = "macos")]
177    {
178        backend() == Backend::Metal
179    }
180    #[cfg(not(target_os = "macos"))]
181    {
182        false
183    }
184}
185
186/// Which arm should this GPU-eligible call take? Consult AFTER the
187/// eligibility gates (`enabled_here` / `min_rows`) so only real
188/// candidates alternate.
189pub fn probe_arm(c: OpClass) -> ProbeArm {
190    if !probe_on() {
191        return ProbeArm::Gpu;
192    }
193    let p = &PROBES[c as usize];
194    match p.state.load(Ordering::Relaxed) {
195        1 => ProbeArm::Gpu,
196        2 => ProbeArm::Cpu,
197        _ => {
198            PROBE_COLD.with(|f| f.set(false));
199            if p.flip.fetch_add(1, Ordering::Relaxed) % 2 == 0 {
200                ProbeArm::Gpu
201            } else {
202                ProbeArm::CpuTimed
203            }
204        }
205    }
206}
207
208/// Record a timed arm sample; on the `PROBE_SAMPLES`-th clean sample of
209/// BOTH arms the class decides for the rest of the process.
210pub fn probe_record(c: OpClass, gpu: bool, dur: std::time::Duration) {
211    let p = &PROBES[c as usize];
212    if p.state.load(Ordering::Relaxed) != 0 {
213        return;
214    }
215    if gpu && PROBE_COLD.with(|f| f.replace(false)) {
216        return; // one-off cost in this call — not a steady-state sample
217    }
218    let ns = dur.as_nanos().min(u64::MAX as u128) as u64;
219    if gpu {
220        p.gpu_ns.fetch_add(ns, Ordering::Relaxed);
221        p.gpu_n.fetch_add(1, Ordering::Relaxed);
222    } else {
223        p.cpu_ns.fetch_add(ns, Ordering::Relaxed);
224        p.cpu_n.fetch_add(1, Ordering::Relaxed);
225    }
226    let (gn, cn) = (
227        p.gpu_n.load(Ordering::Relaxed),
228        p.cpu_n.load(Ordering::Relaxed),
229    );
230    if gn >= 2 && cn >= 2 {
231        let g = p.gpu_ns.load(Ordering::Relaxed) as f64 / gn as f64;
232        let cp = p.cpu_ns.load(Ordering::Relaxed) as f64 / cn as f64;
233        // Early verdict on a ≥3× gap — no reason to keep feeding the
234        // losing arm; close races take the full sample count.
235        if (gn < PROBE_SAMPLES || cn < PROBE_SAMPLES) && g < cp * 3.0 && cp < g * 3.0 {
236            return;
237        }
238        let winner = if g <= cp { 1 } else { 2 };
239        if p.state
240            .compare_exchange(0, winner, Ordering::Relaxed, Ordering::Relaxed)
241            .is_ok()
242        {
243            tracing::info!(
244                "gpu probe [{}]: gpu {:.2} ms vs cpu {:.2} ms per op → {}",
245                ["ffn", "matvec", "matmat", "qkv-batch"][c as usize],
246                g / 1e6,
247                cp / 1e6,
248                if winner == 1 { "gpu" } else { "cpu" },
249            );
250        }
251    }
252}
253
254/// Is the class still collecting samples? (Call sites use this to route
255/// cold-weight calls away from the GPU arm during probing.)
256pub fn probe_deciding(c: OpClass) -> bool {
257    probe_on() && PROBES[c as usize].state.load(Ordering::Relaxed) == 0
258}
259
260/// Probing helper: true — tensor `idx`'s quant weights are ALREADY
261/// device-resident (a clean GPU sample is possible now); false — they
262/// were not (the upload starts within the VRAM budget, so a later call
263/// finds them warm) or the tensor cannot go to the GPU at all. Keeps the
264/// probe from billing a full cold dispatch+readback to a sample it will
265/// discard anyway. The verdict needs only a couple of warm tensors, so
266/// probe-driven uploads are capped — the losing-GPU machine should not
267/// pay for uploading the whole layer stack it will never use; if the GPU
268/// wins, the rest uploads lazily on demand, in the same first-touch order.
269#[allow(unused_variables)]
270pub fn q8_resident_or_upload(model: &Arc<CmfModel>, idx: usize) -> bool {
271    static PROBE_UPLOADS: AtomicU32 = AtomicU32::new(0);
272    let may_upload = PROBE_UPLOADS.load(Ordering::Relaxed) < 4;
273    let resident = match backend() {
274        #[cfg(target_os = "macos")]
275        Backend::Metal => crate::gpu_metal::q8_resident_or_upload(model, idx, may_upload),
276        #[cfg(feature = "gpu")]
277        Backend::Wgpu => crate::gpu_wgpu::q8_resident_or_upload(model, idx, may_upload),
278        Backend::None => false,
279    };
280    if !resident && may_upload {
281        PROBE_UPLOADS.fetch_add(1, Ordering::Relaxed);
282    }
283    resident
284}
285
286/// Test hook: reset all probes to the undecided state.
287#[cfg(test)]
288pub(crate) fn probe_reset() {
289    for p in &PROBES {
290        p.state.store(0, Ordering::Relaxed);
291        p.flip.store(0, Ordering::Relaxed);
292        p.gpu_ns.store(0, Ordering::Relaxed);
293        p.gpu_n.store(0, Ordering::Relaxed);
294        p.cpu_ns.store(0, Ordering::Relaxed);
295        p.cpu_n.store(0, Ordering::Relaxed);
296    }
297}
298
299#[cfg(test)]
300mod probe_tests {
301    use super::*;
302    use std::time::Duration;
303
304    // One test fn: PROBES is process-global and probe_reset touches all
305    // classes — parallel test threads would race.
306    #[test]
307    fn probe_alternates_discards_cold_and_decides() {
308        probe_reset();
309        // Probing: arms alternate.
310        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::Gpu));
311        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::CpuTimed));
312
313        // A cold GPU sample (upload noted) must be discarded: feed a
314        // catastrophic cold sample, then clean fast-GPU samples — GPU
315        // wins only if the cold one did not count.
316        probe_note_cold();
317        probe_record(OpClass::Ffn, true, Duration::from_secs(1000));
318        for _ in 0..PROBE_SAMPLES {
319            probe_record(OpClass::Ffn, true, Duration::from_millis(1));
320            probe_record(OpClass::Ffn, false, Duration::from_millis(4));
321        }
322        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::Gpu));
323
324        // The reverse: a class where the CPU arm is faster decides CPU.
325        for _ in 0..PROBE_SAMPLES {
326            probe_record(OpClass::Matmat, true, Duration::from_millis(4));
327            probe_record(OpClass::Matmat, false, Duration::from_millis(1));
328        }
329        assert!(matches!(probe_arm(OpClass::Matmat), ProbeArm::Cpu));
330
331        // cpu_scope: gates off inside, restored after.
332        cpu_scope(|| CPU_ONLY.with(|c| assert!(c.get())));
333        CPU_ONLY.with(|c| assert!(!c.get()));
334        cpu_scope(|| {
335            cpu_scope(|| CPU_ONLY.with(|c| assert!(c.get())));
336            CPU_ONLY.with(|c| assert!(c.get()));
337        });
338        let _ = std::panic::catch_unwind(|| cpu_scope(|| panic!("scope test")));
339        CPU_ONLY.with(|c| assert!(!c.get()));
340        probe_reset();
341    }
342}
343
344/// Default row threshold: the GPU takes only larger matrices (lm_head
345/// class). Below it, the dispatch/readback cost does not pay off on unified memory.
346pub const GPU_MIN_ROWS: usize = 65_536;
347
348/// Effective threshold: `CMF_GPU_MIN_ROWS` overrides. Defaults differ
349/// by device class: on a DISCRETE card VRAM bandwidth pays off even for
350/// FFN/QKV-class matrices (4096), on unified memory only lm_head-class
351/// is worth the dispatch/readback (65536). Field case behind this: a
352/// 35B model on an RTX 4090 saw ~0 offload because every layer matrix
353/// sat below the old universal 65536.
354pub fn min_rows() -> usize {
355    if let Some(v) = std::env::var("CMF_GPU_MIN_ROWS")
356        .ok()
357        .and_then(|v| v.parse().ok())
358    {
359        return v;
360    }
361    if discrete() { 4096 } else { GPU_MIN_ROWS }
362}
363
364/// Is the active backend a discrete card (PCIe VRAM)?
365pub fn discrete() -> bool {
366    match backend() {
367        #[cfg(feature = "gpu")]
368        Backend::Wgpu => crate::gpu_wgpu::is_discrete(),
369        #[cfg(target_os = "macos")]
370        Backend::Metal => false, // UMA by the init() guard
371        Backend::None => false,
372    }
373}
374
375/// A single MoE-FFN job (an expert with its own weight), executed in one
376/// submission: (rows, cols, idx, row_scale) for gate/up/down + prescaled
377/// inputs + the down θ-field + the blending weight.
378pub struct MoeJob<'a> {
379    pub gate: (usize, usize, usize, &'a [f32]),
380    pub up: (usize, usize, usize, &'a [f32]),
381    pub down: (usize, usize, usize, &'a [f32]),
382    pub xs_gate: Vec<f32>,
383    pub xs_up: Vec<f32>,
384    pub down_col: &'a [f32],
385    pub w: f32,
386    /// q1 trio: scales live inside the 6-byte tiles (row_scale slices
387    /// empty, xs raw f32). Backends without a q1 kernel refuse the job.
388    pub q1: bool,
389}
390
391/// A single independent batch matvec (GDN projections of one input).
392pub struct BatchJob<'a> {
393    pub idx: usize,
394    pub rows: usize,
395    pub cols: usize,
396    pub row_scale: &'a [f32],
397    pub xs: Vec<f32>,
398    /// q1 tensor: tile-embedded scales, raw f32 xs (see `MoeJob::q1`).
399    pub q1: bool,
400}
401
402#[derive(Clone, Copy, PartialEq, Eq)]
403enum Backend {
404    None,
405    #[cfg(target_os = "macos")]
406    Metal,
407    #[cfg(feature = "gpu")]
408    Wgpu,
409}
410
411fn backend() -> Backend {
412    #[cfg(feature = "gpu")]
413    if crate::gpu_wgpu::selected() {
414        return if crate::gpu_wgpu::enabled() {
415            Backend::Wgpu
416        } else {
417            Backend::None
418        };
419    }
420    #[cfg(target_os = "macos")]
421    if crate::gpu_metal::enabled() {
422        return Backend::Metal;
423    }
424    Backend::None
425}
426
427/// GPU enabled and initialized on the selected backend?
428pub fn enabled() -> bool {
429    backend() != Backend::None
430}
431
432/// q8_row/q8_2f matvec, rows [row0, row0+rows). `xs` — prescaled by the θ-field.
433#[allow(clippy::too_many_arguments, unused_variables)]
434pub fn q8_matvec_range(
435    model: &Arc<CmfModel>,
436    idx: usize,
437    row0: usize,
438    row_scale: &[f32],
439    xs: &[f32],
440    rows: usize,
441    cols: usize,
442    out: &mut [f32],
443) -> bool {
444    match backend() {
445        #[cfg(target_os = "macos")]
446        Backend::Metal => {
447            crate::gpu_metal::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
448        }
449        #[cfg(feature = "gpu")]
450        Backend::Wgpu => {
451            crate::gpu_wgpu::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
452        }
453        Backend::None => false,
454    }
455}
456
457/// GEMM of a prefill batch: `pre` — prescaled inputs row-major [b, cols],
458/// out — row-major [b, rows].
459#[allow(clippy::too_many_arguments, unused_variables)]
460pub fn q8_matmat(
461    model: &Arc<CmfModel>,
462    idx: usize,
463    row_scale: &[f32],
464    pre: &[f32],
465    b: usize,
466    rows: usize,
467    cols: usize,
468    out: &mut [f32],
469) -> bool {
470    match backend() {
471        #[cfg(target_os = "macos")]
472        Backend::Metal => {
473            crate::gpu_metal::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out)
474        }
475        #[cfg(feature = "gpu")]
476        Backend::Wgpu => crate::gpu_wgpu::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out),
477        Backend::None => false,
478    }
479}
480
481/// q1 matvec: raw f32 activations, tile-embedded scales. Metal only
482/// for now (wgpu q1 WGSL is queued); false = CPU fallback.
483#[allow(unused_variables)]
484pub fn q1_matvec(
485    model: &Arc<CmfModel>,
486    idx: usize,
487    xs: &[f32],
488    rows: usize,
489    cols: usize,
490    out: &mut [f32],
491) -> bool {
492    match backend() {
493        #[cfg(target_os = "macos")]
494        Backend::Metal => crate::gpu_metal::q1_matvec(model, idx, xs, rows, cols, out),
495        #[cfg(feature = "gpu")]
496        Backend::Wgpu => crate::gpu_wgpu::q1_matvec(model, idx, xs, rows, cols, out),
497        Backend::None => false,
498    }
499}
500
501/// Whole attention sub-block on the wgpu token graph (drop-in for
502/// `qwen_attention`): normed hidden in, O-projection out, resident device
503/// K/V mirror. false = refusal / not the wgpu backend → CPU path.
504#[allow(clippy::too_many_arguments)]
505pub fn attn_dropin(
506    model: &Arc<CmfModel>,
507    kv_id: u64,
508    layer: usize,
509    normed: &[f32],
510    wq_idx: usize,
511    wk_idx: usize,
512    wv_idx: usize,
513    wo_idx: usize,
514    q_norm: Option<&[f32]>,
515    k_norm: Option<&[f32]>,
516    invf: &[f32],
517    nh: usize,
518    nkv: usize,
519    hd: usize,
520    rd: usize,
521    hidden: usize,
522    pos: usize,
523    cap: usize,
524    gemma: bool,
525    eps: f32,
526    cpu_k: &[Vec<f32>],
527    cpu_v: &[Vec<f32>],
528    out: &mut [f32],
529) -> bool {
530    match backend() {
531        #[cfg(feature = "gpu")]
532        Backend::Wgpu => crate::gpu_wgpu::attn_dropin_gpu(
533            model, kv_id, layer, normed, wq_idx, wk_idx, wv_idx, wo_idx, q_norm, k_norm, invf, nh,
534            nkv, hd, rd, hidden, pos, cap, gemma, eps, cpu_k, cpu_v, out,
535        ),
536        _ => false,
537    }
538}
539
540/// One weight in the whole-token graph: tensor idx + a codec tag (0=q8_row,
541/// 1=q1, 2=q4_tiled, 3=q1t, 4=f32) + per-row scales (q8_row only) + the raw f32
542/// data (kind 4 only — small unquantized projections like GDN in_proj_a/b).
543pub struct GraphW<'a> {
544    pub idx: usize,
545    pub kind: u8,
546    pub row_scale: &'a [f32],
547    pub data: &'a [f32],
548}
549
550/// A layer's token-mixing op: standard attention or a GDN (linear-attention)
551/// block. The surrounding norms + SwiGLU FFN are common to both.
552pub enum GraphAttn<'a> {
553    Full {
554        wq: GraphW<'a>,
555        wk: GraphW<'a>,
556        wv: GraphW<'a>,
557        wo: GraphW<'a>,
558        q_norm: Option<&'a [f32]>,
559        k_norm: Option<&'a [f32]>,
560        /// (bq, bk, bv) attention biases (Qwen2). None ⇒ no bias.
561        bias: Option<(&'a [f32], &'a [f32], &'a [f32])>,
562        /// Qwen3.5 gated attention: wq emits 2·nh·hd (q||gate per head), the
563        /// attention output is scaled by sigmoid(gate) before the O projection.
564        output_gate: bool,
565        cpu_k: &'a [Vec<f32>],
566        cpu_v: &'a [Vec<f32>],
567    },
568    Gdn {
569        qkv: GraphW<'a>,
570        z: GraphW<'a>,
571        a: GraphW<'a>,
572        b: GraphW<'a>,
573        out: GraphW<'a>,
574        conv1d: &'a [f32],
575        a_log: &'a [f32],
576        dt_bias: &'a [f32],
577        norm: &'a [f32],
578        nv: usize,
579        nk: usize,
580        dk: usize,
581        dv: usize,
582        kk: usize,
583    },
584}
585
586/// Per-layer weights for the whole-token wgpu graph.
587pub struct GraphLayer<'a> {
588    pub input_norm: &'a [f32],
589    pub attn: GraphAttn<'a>,
590    pub post_norm: &'a [f32],
591    pub gate: GraphW<'a>,
592    pub up: GraphW<'a>,
593    pub down: GraphW<'a>,
594}
595
596/// Whole-token decode graph on wgpu: the entire layer stack in ONE submit,
597/// hidden resident, one readback. Updates `h` in place. false = refusal.
598#[allow(clippy::too_many_arguments)]
599pub fn forward_token_graph(
600    model: &Arc<CmfModel>,
601    kv_id: u64,
602    layers: &[GraphLayer],
603    invf: &[f32],
604    h: &mut [f32],
605    nh: usize,
606    nkv: usize,
607    hd: usize,
608    rd: usize,
609    hidden: usize,
610    inter: usize,
611    position: usize,
612    cap: usize,
613    gemma: bool,
614    eps: f32,
615    lm_head: Option<(&GraphW, usize)>,
616    final_norm: &[f32],
617    logits: &mut Vec<f32>,
618) -> bool {
619    match backend() {
620        #[cfg(feature = "gpu")]
621        Backend::Wgpu => crate::gpu_wgpu::forward_token_graph(
622            model, kv_id, layers, invf, h, nh, nkv, hd, rd, hidden, inter, position, cap, gemma,
623            eps, lm_head, final_norm, logits,
624        ),
625        _ => {
626            let _ = (lm_head, final_norm, logits);
627            false
628        }
629    }
630}
631
632/// Batched prefill: k contiguous positions through the whole graph in one submit
633/// (projections/FFN as GEMMs, attention/GDN looped over scratch). `h` is
634/// [k·hidden] in/out; `positions` len k. wgpu only.
635#[allow(clippy::too_many_arguments)]
636pub fn forward_batch_graph(
637    model: &Arc<CmfModel>,
638    kv_id: u64,
639    layers: &[GraphLayer],
640    invf: &[f32],
641    h: &mut [f32],
642    nh: usize,
643    nkv: usize,
644    hd: usize,
645    rd: usize,
646    hidden: usize,
647    inter: usize,
648    positions: &[usize],
649    cap: usize,
650    gemma: bool,
651    eps: f32,
652    k: usize,
653) -> bool {
654    match backend() {
655        #[cfg(feature = "gpu")]
656        Backend::Wgpu => crate::gpu_wgpu::forward_batch_graph(
657            model, kv_id, layers, invf, h, nh, nkv, hd, rd, hidden, inter, positions, cap, gemma,
658            eps, k,
659        ),
660        _ => false,
661    }
662}
663
664/// Drop the wgpu token graph's device K/V mirror for a pipeline.
665pub fn graph_kv_reset(_kv_id: u64) {
666    #[cfg(feature = "gpu")]
667    if backend() == Backend::Wgpu {
668        crate::gpu_wgpu::kv_mirror_reset(_kv_id);
669    }
670}
671
672/// Ternary (q1t) BASE matvec on the GPU — fills `out` with the base dot; the
673/// caller adds the sparse overlay on the CPU. Metal only for now (wgpu q1t not
674/// yet written → CPU fallback).
675pub fn q1t_matvec(
676    model: &Arc<CmfModel>,
677    idx: usize,
678    xs: &[f32],
679    rows: usize,
680    cols: usize,
681    out: &mut [f32],
682) -> bool {
683    match backend() {
684        #[cfg(target_os = "macos")]
685        Backend::Metal => {
686            if metal_q1t_enabled() {
687                crate::gpu_metal::q1t_matvec(model, idx, xs, rows, cols, out)
688            } else {
689                false
690            }
691        }
692        #[cfg(feature = "gpu")]
693        Backend::Wgpu => crate::gpu_wgpu::q1t_matvec(model, idx, xs, rows, cols, out),
694        Backend::None => false,
695    }
696}
697
698/// q4_block matvec on the GPU — wgpu only (Metal drives q4_block through the
699/// whole-token graph, not a standalone matvec).
700#[allow(unused_variables)]
701pub fn q4b_matvec(
702    model: &Arc<CmfModel>,
703    idx: usize,
704    xs: &[f32],
705    rows: usize,
706    cols: usize,
707    out: &mut [f32],
708) -> bool {
709    match backend() {
710        #[cfg(target_os = "macos")]
711        Backend::Metal => false,
712        #[cfg(feature = "gpu")]
713        Backend::Wgpu => crate::gpu_wgpu::q4b_matvec(model, idx, xs, rows, cols, out),
714        Backend::None => false,
715    }
716}
717
718/// q1t batched GEMM (prefill) — base + overlay on-device (Metal simdgroup or
719/// wgpu register-blocked).
720pub fn q1t_matmat(
721    model: &Arc<CmfModel>,
722    idx: usize,
723    xs: &[f32],
724    b: usize,
725    rows: usize,
726    cols: usize,
727    out: &mut [f32],
728) -> bool {
729    match backend() {
730        #[cfg(target_os = "macos")]
731        // Batched prefill and single-token decode are both enabled. On the
732        // real 14.8B Q1T model prefill PPL was within 0.3% of CPU (7.942 vs
733        // 7.966), and the alignment-safe decode kernel reached 3.52e-6 max_rel.
734        Backend::Metal => crate::gpu_metal::q1t_matmat(model, idx, xs, b, rows, cols, out),
735        #[cfg(feature = "gpu")]
736        Backend::Wgpu => crate::gpu_wgpu::q1t_matmat(model, idx, xs, b, rows, cols, out),
737        Backend::None => false,
738    }
739}
740
741/// Native Metal Q1T switch. Enabled by default after the byte-packed Q1T
742/// fields were changed to alignment-safe loads; keep an explicit emergency
743/// fallback for device/driver diagnostics.
744#[cfg(target_os = "macos")]
745pub(crate) fn metal_q1t_enabled() -> bool {
746    std::env::var("CMF_METAL_Q1T")
747        .map(|v| v != "0" && !v.eq_ignore_ascii_case("off"))
748        .unwrap_or(true)
749}
750
751/// Batched q1 GEMM (prefill). wgpu only — Metal has its own block path.
752pub fn q1_matmat(
753    model: &Arc<CmfModel>,
754    idx: usize,
755    xs: &[f32],
756    b: usize,
757    rows: usize,
758    cols: usize,
759    out: &mut [f32],
760) -> bool {
761    match backend() {
762        #[cfg(feature = "gpu")]
763        Backend::Wgpu => crate::gpu_wgpu::q1_matmat(model, idx, xs, b, rows, cols, out),
764        _ => false,
765    }
766}
767
768/// Whole-block token-graph types re-exported from the Metal backend.
769#[cfg(target_os = "macos")]
770pub use crate::gpu_metal::{
771    AttnDeviceParams, AttnGpuLayer, GdnGpuCfg, GdnGpuLayer, GraphDims, TokenGraph, kv_mirror_drop,
772    kv_mirror_read_last, kv_mirror_take_imp,
773};
774
775/// A BLOCK of consecutive q1 GDN layers in one submission (Metal only).
776#[cfg(target_os = "macos")]
777pub fn gdn_block(
778    model: &Arc<CmfModel>,
779    layers: &[GdnGpuLayer],
780    states: &mut [&mut [f32]],
781    cfg: &GdnGpuCfg,
782    h: &mut [f32],
783) -> bool {
784    match backend() {
785        Backend::Metal => crate::gpu_metal::gdn_block(model, layers, states, cfg, h),
786        _ => false,
787    }
788}
789
790/// A layer's MoE-FFN in one submission (amortizing the dispatch cost).
791#[allow(unused_variables)]
792pub fn moe_block(model: &Arc<CmfModel>, jobs: &[MoeJob], out: &mut [f32]) -> bool {
793    match backend() {
794        #[cfg(target_os = "macos")]
795        Backend::Metal => crate::gpu_metal::moe_block(model, jobs, out),
796        #[cfg(feature = "gpu")]
797        Backend::Wgpu => crate::gpu_wgpu::moe_block(model, jobs, out),
798        Backend::None => false,
799    }
800}
801
802/// Independent matvecs of one input in a single submission (GDN projections).
803#[allow(unused_variables)]
804pub fn matvec_batch(model: &Arc<CmfModel>, jobs: &[BatchJob], out: &mut [&mut [f32]]) -> bool {
805    match backend() {
806        #[cfg(target_os = "macos")]
807        Backend::Metal => crate::gpu_metal::matvec_batch(model, jobs, out),
808        #[cfg(feature = "gpu")]
809        Backend::Wgpu => crate::gpu_wgpu::matvec_batch(model, jobs, out),
810        Backend::None => false,
811    }
812}