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::{AtomicBool, 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/// Peek the cold flag without consuming it (`probe_record` consumes).
54/// Contention heuristics use this: a slow COLD op is a one-off build
55/// cost, not evidence the device is busy.
56pub(crate) fn probe_was_cold() -> bool {
57    PROBE_COLD.with(|c| c.get())
58}
59
60/// Pipeline: mark the current layer (or −1 outside layers) for layer-split.
61pub fn set_layer(l: i64) {
62    CUR_LAYER.with(|c| c.set(l));
63}
64
65/// The layer `set_layer` last marked on this thread (−1 outside layers).
66pub fn cur_layer() -> i64 {
67    CUR_LAYER.with(|c| c.get())
68}
69
70/// Parse `CMF_GPU_LAYERS` («0-19», «0,2,4», «0-9,30-39») once.
71/// None = no restriction (all layers on GPU). Garbage → also no restriction.
72fn layer_ranges() -> &'static Option<Vec<(i64, i64)>> {
73    static R: OnceLock<Option<Vec<(i64, i64)>>> = OnceLock::new();
74    R.get_or_init(|| {
75        let s = std::env::var("CMF_GPU_LAYERS").ok()?;
76        let mut v = Vec::new();
77        for part in s.split(',') {
78            let part = part.trim();
79            match part.split_once('-') {
80                Some((a, b)) => v.push((a.trim().parse().ok()?, b.trim().parse().ok()?)),
81                None => {
82                    let x: i64 = part.parse().ok()?;
83                    v.push((x, x));
84                }
85            }
86        }
87        Some(v)
88    })
89}
90
91fn layer_allowed() -> bool {
92    match layer_ranges() {
93        None => true,
94        Some(ranges) => {
95            let cur = CUR_LAYER.with(|c| c.get());
96            cur < 0 || ranges.iter().any(|(a, b)| cur >= *a && cur <= *b)
97        }
98    }
99}
100
101/// GPU allowed FOR THE CURRENT LAYER: backend is initialized AND the layer
102/// falls within `CMF_GPU_LAYERS` (GPU/CPU layer-split) AND we are not
103/// inside a `cpu_scope`. Op gates call this.
104pub fn enabled_here() -> bool {
105    !CPU_ONLY.with(|c| c.get()) && enabled() && layer_allowed()
106}
107
108// ── Runtime GPU-vs-CPU probe ────────────────────────────────────────────
109// CMF_GPU=1 does not TRUST that the device wins — it MEASURES. For each
110// op class the first calls alternate arms: GPU timed vs pure-CPU timed
111// (under cpu_scope). Cold GPU calls (weight upload / cache fill) are
112// discarded; after PROBE_SAMPLES clean samples per arm the faster arm is
113// chosen for the rest of the process. Rationale: submit+poll latency
114// differs by an order of magnitude across driver stacks (Metal/PCIe
115// ~3-4 ms, Vulkan/4090 ~0.3 ms) — a static threshold cannot know whether
116// per-op offload pays off HERE. CMF_GPU_PROBE=0 → always trust the GPU.
117
118/// GPU-eligible op classes, each with an independent probe.
119#[derive(Clone, Copy)]
120pub enum OpClass {
121    /// Whole FFN chain in one submission (dense / MoE block).
122    Ffn = 0,
123    /// Large hybrid CPU∥GPU matvec (lm_head class).
124    Matvec = 1,
125    /// Prefill GEMM (matmat).
126    Matmat = 2,
127    /// Batched matvecs of one input (QKV).
128    Batch = 3,
129    /// Prefill GEMM at image-diffusion widths (b ≥ 128). Probed apart
130    /// from `Matmat`: one imagegen process runs BOTH populations
131    /// (prompt encode b≈40 where the GPU wins big, DiT b≥256 where
132    /// the CPU AMX arm is competitive) — a single shared verdict locks
133    /// the wrong arm for whichever population samples second.
134    MatmatWide = 4,
135    /// The lm_head itself, apart from the merely-large matvecs. Same
136    /// reasoning as `MatmatWide`, and DeepSeek-V4 is where it bit: its
137    /// attention projections are 37M weights and its head is 529M, so
138    /// the projections' verdict — CPU, honestly measured at 0.19 ms —
139    /// decided for a matvec fourteen times their size that took 11 ms
140    /// a token on the host.
141    MatvecHead = 5,
142}
143
144/// Which probe a large matvec belongs to. The head is an order of
145/// magnitude bigger than anything else that reaches this gate, and the
146/// two populations do not have the same answer.
147pub fn matvec_class(rows: usize, cols: usize) -> OpClass {
148    if rows * cols >= 67_108_864 {
149        OpClass::MatvecHead
150    } else {
151        OpClass::Matvec
152    }
153}
154
155/// Probe verdict for one call.
156pub enum ProbeArm {
157    /// Run the GPU path (during probing: timed, recorded).
158    Gpu,
159    /// Probing: run the CPU path under `cpu_scope`, timed, recorded.
160    CpuTimed,
161    /// Decided: CPU won — run the CPU path (under `cpu_scope`).
162    Cpu,
163}
164
165/// Clean samples per arm before a class decides.
166const PROBE_SAMPLES: u32 = 6;
167
168struct Probe {
169    /// 0 = probing, 1 = GPU won, 2 = CPU won.
170    state: AtomicU8,
171    flip: AtomicU32,
172    gpu_ns: AtomicU64,
173    gpu_n: AtomicU32,
174    cpu_ns: AtomicU64,
175    cpu_n: AtomicU32,
176    /// Best (minimum) sample per arm. The DECISION compares these:
177    /// means are poisoned by one-off cold costs the cold-flag cannot
178    /// see — e.g. the CPU arm's first mmap-cold expert matvec page
179    /// faults its weights in and reads 3× its steady state, which
180    /// locked the GPU arm on a 35B MoE at a 4× real-world loss. The
181    /// minimum is each arm's honest steady-state pace.
182    gpu_min: AtomicU64,
183    cpu_min: AtomicU64,
184}
185
186impl Probe {
187    const fn new() -> Self {
188        Self {
189            state: AtomicU8::new(0),
190            flip: AtomicU32::new(0),
191            gpu_ns: AtomicU64::new(0),
192            gpu_n: AtomicU32::new(0),
193            cpu_ns: AtomicU64::new(0),
194            cpu_n: AtomicU32::new(0),
195            gpu_min: AtomicU64::new(u64::MAX),
196            cpu_min: AtomicU64::new(u64::MAX),
197        }
198    }
199}
200
201static PROBES: [Probe; 6] = [
202    Probe::new(),
203    Probe::new(),
204    Probe::new(),
205    Probe::new(),
206    Probe::new(),
207    Probe::new(),
208];
209
210fn probe_on() -> bool {
211    static ON: OnceLock<bool> = OnceLock::new();
212    *ON.get_or_init(|| {
213        std::env::var("CMF_GPU_PROBE")
214            .map(|v| v != "0" && v != "off")
215            .unwrap_or(true)
216    })
217}
218
219/// q1 ops on the native Metal backend skip the probe entirely: the CPU
220/// q1 kernel is load-port-bound, the GPU one wins warm — and probe
221/// alternation itself cools the device between samples (measured: block
222/// times 5.8 ms warm vs 8.8 ms mixed). Other backends keep probing.
223pub fn q1_force() -> bool {
224    #[cfg(target_os = "macos")]
225    {
226        backend() == Backend::Metal
227    }
228    #[cfg(not(target_os = "macos"))]
229    {
230        false
231    }
232}
233
234/// Should a FUSED whole-block path trust the device instead of asking
235/// the per-op probe? True on native Metal and on discrete wgpu adapters.
236///
237/// The probe answers "is one wide matmat faster on the GPU", and for the
238/// DiT on Metal that is a coin flip — measured 2.62 ms GPU vs 2.56 ms
239/// CPU, a 2% spread that lands on either arm run to run. But the fused
240/// block's advantage is not per-op speed, it is that the hidden state,
241/// the packs and the attention panels never leave the device: end to end
242/// the whole-block path renders a 512² Lumina step in ~5.4 s against
243/// ~8.4 s when the probe happens to pick the CPU. Gating a fusion win on
244/// a per-op tie made every second render half-speed at random.
245///
246/// On a discrete card the verdict is never in doubt — an RTX 3090 against
247/// a 256-core EPYC measured 11.5 ms vs 31 ms per wide op, four runs out
248/// of four — so the probe's sampling phase is pure cost: it alone was 10%
249/// of a 512² render (74.3 s against 66.9 s with the probe off). Integrated
250/// and mobile adapters keep probing; there the submit latency is real and
251/// can genuinely lose.
252pub fn fused_block_trusted() -> bool {
253    #[cfg(target_os = "macos")]
254    if backend() == Backend::Metal {
255        return true;
256    }
257    wgpu_graph_default()
258}
259
260/// Which arm should this GPU-eligible call take? Consult AFTER the
261/// eligibility gates (`enabled_here` / `min_rows`) so only real
262/// candidates alternate.
263pub fn probe_arm(c: OpClass) -> ProbeArm {
264    // Every arbitrated call starts with a clean cold flag: both the
265    // sample discard in `probe_record` and the contention kill-switch
266    // read it AFTER the op, so a stale note from a previous call on
267    // this thread must not leak in.
268    PROBE_COLD.with(|f| f.set(false));
269    if !probe_on() {
270        return ProbeArm::Gpu;
271    }
272    let p = &PROBES[c as usize];
273    match p.state.load(Ordering::Relaxed) {
274        1 => ProbeArm::Gpu,
275        2 => ProbeArm::Cpu,
276        _ => {
277            if p.flip.fetch_add(1, Ordering::Relaxed) % 2 == 0 {
278                ProbeArm::Gpu
279            } else {
280                ProbeArm::CpuTimed
281            }
282        }
283    }
284}
285
286/// Record a timed arm sample; on the `PROBE_SAMPLES`-th clean sample of
287/// BOTH arms the class decides for the rest of the process.
288pub fn probe_record(c: OpClass, gpu: bool, dur: std::time::Duration) {
289    let p = &PROBES[c as usize];
290    if p.state.load(Ordering::Relaxed) != 0 {
291        return;
292    }
293    if gpu && PROBE_COLD.with(|f| f.replace(false)) {
294        return; // one-off cost in this call — not a steady-state sample
295    }
296    let ns = dur.as_nanos().min(u64::MAX as u128) as u64;
297    if gpu {
298        p.gpu_ns.fetch_add(ns, Ordering::Relaxed);
299        p.gpu_n.fetch_add(1, Ordering::Relaxed);
300        p.gpu_min.fetch_min(ns, Ordering::Relaxed);
301    } else {
302        p.cpu_ns.fetch_add(ns, Ordering::Relaxed);
303        p.cpu_n.fetch_add(1, Ordering::Relaxed);
304        p.cpu_min.fetch_min(ns, Ordering::Relaxed);
305    }
306    let (gn, cn) = (
307        p.gpu_n.load(Ordering::Relaxed),
308        p.cpu_n.load(Ordering::Relaxed),
309    );
310    if gn >= 2 && cn >= 2 {
311        // Decide on each arm's BEST sample — the steady-state pace.
312        // Means carry one-off cold costs (mmap page-in on the CPU arm)
313        // that the cold-flag machinery cannot see.
314        let g = p.gpu_min.load(Ordering::Relaxed) as f64;
315        let cp = p.cpu_min.load(Ordering::Relaxed) as f64;
316        // Early verdict on a ≥3× gap — no reason to keep feeding the
317        // losing arm; close races take the full sample count.
318        if (gn < PROBE_SAMPLES || cn < PROBE_SAMPLES) && g < cp * 3.0 && cp < g * 3.0 {
319            return;
320        }
321        let winner = if g <= cp { 1 } else { 2 };
322        if p.state
323            .compare_exchange(0, winner, Ordering::Relaxed, Ordering::Relaxed)
324            .is_ok()
325        {
326            tracing::info!(
327                "gpu probe [{}]: gpu {:.2} ms vs cpu {:.2} ms per op → {}",
328                ["ffn", "matvec", "matmat", "qkv-batch", "matmat-wide", "lm-head"][c as usize],
329                g / 1e6,
330                cp / 1e6,
331                if winner == 1 { "gpu" } else { "cpu" },
332            );
333        }
334    }
335}
336
337/// Is the class still collecting samples? (Call sites use this to route
338/// cold-weight calls away from the GPU arm during probing.)
339pub fn probe_deciding(c: OpClass) -> bool {
340    probe_on() && PROBES[c as usize].state.load(Ordering::Relaxed) == 0
341}
342
343/// Probing helper: true — tensor `idx`'s quant weights are ALREADY
344/// device-resident (a clean GPU sample is possible now); false — they
345/// were not (the upload starts within the VRAM budget, so a later call
346/// finds them warm) or the tensor cannot go to the GPU at all. Keeps the
347/// probe from billing a full cold dispatch+readback to a sample it will
348/// discard anyway. The verdict needs only a couple of warm tensors, so
349/// probe-driven uploads are capped — the losing-GPU machine should not
350/// pay for uploading the whole layer stack it will never use; if the GPU
351/// wins, the rest uploads lazily on demand, in the same first-touch order.
352#[allow(unused_variables)]
353pub fn q8_resident_or_upload(model: &Arc<CmfModel>, idx: usize) -> bool {
354    static PROBE_UPLOADS: AtomicU32 = AtomicU32::new(0);
355    let may_upload = PROBE_UPLOADS.load(Ordering::Relaxed) < 4;
356    let resident = match backend() {
357        #[cfg(target_os = "macos")]
358        Backend::Metal => crate::gpu_metal::q8_resident_or_upload(model, idx, may_upload),
359        #[cfg(feature = "gpu")]
360        Backend::Wgpu => crate::gpu_wgpu::q8_resident_or_upload(model, idx, may_upload),
361        Backend::None => false,
362    };
363    if !resident && may_upload {
364        PROBE_UPLOADS.fetch_add(1, Ordering::Relaxed);
365    }
366    resident
367}
368
369/// Test hook: reset all probes to the undecided state.
370#[cfg(test)]
371pub(crate) fn probe_reset() {
372    for p in &PROBES {
373        p.state.store(0, Ordering::Relaxed);
374        p.flip.store(0, Ordering::Relaxed);
375        p.gpu_ns.store(0, Ordering::Relaxed);
376        p.gpu_n.store(0, Ordering::Relaxed);
377        p.cpu_ns.store(0, Ordering::Relaxed);
378        p.cpu_n.store(0, Ordering::Relaxed);
379    }
380}
381
382#[cfg(test)]
383mod probe_tests {
384    use super::*;
385    use std::time::Duration;
386
387    // One test fn: PROBES is process-global and probe_reset touches all
388    // classes — parallel test threads would race.
389    #[test]
390    fn probe_alternates_discards_cold_and_decides() {
391        probe_reset();
392        // Probing: arms alternate.
393        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::Gpu));
394        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::CpuTimed));
395
396        // A cold GPU sample (upload noted) must be discarded: feed a
397        // catastrophic cold sample, then clean fast-GPU samples — GPU
398        // wins only if the cold one did not count.
399        probe_note_cold();
400        probe_record(OpClass::Ffn, true, Duration::from_secs(1000));
401        for _ in 0..PROBE_SAMPLES {
402            probe_record(OpClass::Ffn, true, Duration::from_millis(1));
403            probe_record(OpClass::Ffn, false, Duration::from_millis(4));
404        }
405        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::Gpu));
406
407        // The reverse: a class where the CPU arm is faster decides CPU.
408        for _ in 0..PROBE_SAMPLES {
409            probe_record(OpClass::Matmat, true, Duration::from_millis(4));
410            probe_record(OpClass::Matmat, false, Duration::from_millis(1));
411        }
412        assert!(matches!(probe_arm(OpClass::Matmat), ProbeArm::Cpu));
413
414        // cpu_scope: gates off inside, restored after.
415        cpu_scope(|| CPU_ONLY.with(|c| assert!(c.get())));
416        CPU_ONLY.with(|c| assert!(!c.get()));
417        cpu_scope(|| {
418            cpu_scope(|| CPU_ONLY.with(|c| assert!(c.get())));
419            CPU_ONLY.with(|c| assert!(c.get()));
420        });
421        let _ = std::panic::catch_unwind(|| cpu_scope(|| panic!("scope test")));
422        CPU_ONLY.with(|c| assert!(!c.get()));
423        probe_reset();
424    }
425}
426
427/// Default row threshold: the GPU takes only larger matrices (lm_head
428/// class). Below it, the dispatch/readback cost does not pay off on unified memory.
429pub const GPU_MIN_ROWS: usize = 65_536;
430
431/// Effective threshold: `CMF_GPU_MIN_ROWS` overrides. Defaults differ
432/// by device class: on a DISCRETE card VRAM bandwidth pays off even for
433/// FFN/QKV-class matrices (4096), on unified memory only lm_head-class
434/// is worth the dispatch/readback (65536). Field case behind this: a
435/// 35B model on an RTX 4090 saw ~0 offload because every layer matrix
436/// sat below the old universal 65536.
437pub fn min_rows() -> usize {
438    if let Some(v) = std::env::var("CMF_GPU_MIN_ROWS")
439        .ok()
440        .and_then(|v| v.parse().ok())
441    {
442        return v;
443    }
444    if discrete() { 4096 } else { GPU_MIN_ROWS }
445}
446
447/// Is the active backend a discrete card (PCIe VRAM)?
448pub fn discrete() -> bool {
449    match backend() {
450        #[cfg(feature = "gpu")]
451        Backend::Wgpu => crate::gpu_wgpu::is_discrete(),
452        #[cfg(target_os = "macos")]
453        Backend::Metal => false, // UMA by the init() guard
454        Backend::None => false,
455    }
456}
457
458/// A single MoE-FFN job (an expert with its own weight), executed in one
459/// submission: (rows, cols, idx, row_scale) for gate/up/down + prescaled
460/// inputs + the down θ-field + the blending weight.
461pub struct MoeJob<'a> {
462    pub gate: (usize, usize, usize, &'a [f32]),
463    pub up: (usize, usize, usize, &'a [f32]),
464    pub down: (usize, usize, usize, &'a [f32]),
465    pub xs_gate: Vec<f32>,
466    pub xs_up: Vec<f32>,
467    pub down_col: &'a [f32],
468    pub w: f32,
469    /// q1 trio: scales live inside the 6-byte tiles (row_scale slices
470    /// empty, xs raw f32). Backends without a q1 kernel refuse the job.
471    pub q1: bool,
472    /// q4_tiled trio: scales inside the 18-byte tiles (row_scale
473    /// slices empty, xs raw f32) — the MoE-hybrid coder class.
474    pub q4t: bool,
475    /// q4tp trio: same raw-xs contract, 16-byte nibble stride and the scale
476    /// on a per-row ladder. Without this the experts of a q4tp MoE model fall
477    /// to the CPU while every other dtype rides the device.
478    pub q4tp: bool,
479    /// The reference's `swiglu_limit`; 0 disables the clamp. A backend that
480    /// cannot apply it must REFUSE the job rather than drop it silently —
481    /// the difference only shows on saturating activations, which is the
482    /// hardest kind of divergence to notice.
483    pub swiglu_limit: f32,
484}
485
486/// A single independent batch matvec (GDN projections of one input).
487pub struct BatchJob<'a> {
488    pub idx: usize,
489    pub rows: usize,
490    pub cols: usize,
491    pub row_scale: &'a [f32],
492    pub xs: Vec<f32>,
493    /// Weight layout. Was a bare `q1: bool`, which could only ever spell two
494    /// of the four and silently sent everything else back to the CPU — the
495    /// GDN projections of a q4t/q4tp model never reached the device at all.
496    pub layout: BatchLayout,
497}
498
499/// Which kernel a batched matvec needs. q8 carries row scales in a side
500/// buffer; the rest embed them in the payload and differ in stride.
501#[derive(Clone, Copy, PartialEq, Eq, Debug)]
502pub enum BatchLayout {
503    Q8,
504    Q1,
505    Q4t,
506    Q4tp,
507}
508
509#[derive(Clone, Copy, PartialEq, Eq)]
510enum Backend {
511    None,
512    #[cfg(target_os = "macos")]
513    Metal,
514    #[cfg(feature = "gpu")]
515    Wgpu,
516}
517
518fn backend() -> Backend {
519    #[cfg(feature = "gpu")]
520    if crate::gpu_wgpu::selected() {
521        return if crate::gpu_wgpu::enabled() {
522            Backend::Wgpu
523        } else {
524            Backend::None
525        };
526    }
527    #[cfg(target_os = "macos")]
528    if crate::gpu_metal::enabled() {
529        return Backend::Metal;
530    }
531    Backend::None
532}
533
534/// GPU enabled and initialized on the selected backend?
535/// Whether THIS build can bring a GPU up on THIS device: a compiled-in
536/// backend plus a live adapter. The mobile FFI exposes it so an app can
537/// tell "GPU off" from "GPU impossible" (a CPU-only .so ships no
538/// backend at all). Cached after the first call.
539pub fn backend_available() -> bool {
540    #[cfg(target_os = "macos")]
541    {
542        // The Metal path is always compiled on macOS.
543        true
544    }
545    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
546    {
547        static AVAIL: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
548        *AVAIL.get_or_init(crate::gpu_wgpu::adapter_probe)
549    }
550    #[cfg(all(not(feature = "gpu"), not(target_os = "macos")))]
551    {
552        false
553    }
554}
555
556pub fn enabled() -> bool {
557    backend() != Backend::None
558}
559
560/// Default-on condition for the wgpu whole-token graph: the wgpu
561/// backend on a DISCRETE adapter. NOT plain `enabled()` (macOS/Metal
562/// must not pay a per-token layer scan for a graph its backend
563/// refuses), and NOT integrated adapters: the graph's ~300 barriered
564/// dispatches per token are cheap on desktop immediate-mode GPUs but
565/// tiled mobile GPUs (Adreno/Mali) drain the pipeline at every barrier
566/// — field report: 0.2 tok/s on-graph vs 15 tok/s on the CPU. On
567/// integrated adapters the per-op probe path arbitrates each op class
568/// against the CPU instead; CMF_GPU_WGPU_GRAPH=1 still forces the
569/// graph anywhere.
570/// Is the wgpu backend active at all (any adapter)? Eligibility gate
571/// for the whole-token graph — whether it actually RUNS is decided by
572/// `wgpu_graph_default` (trusted on discrete) or the generation race.
573pub fn wgpu_active() -> bool {
574    #[cfg(feature = "gpu")]
575    {
576        matches!(backend(), Backend::Wgpu)
577    }
578    #[cfg(not(feature = "gpu"))]
579    {
580        false
581    }
582}
583
584pub fn wgpu_graph_default() -> bool {
585    #[cfg(feature = "gpu")]
586    {
587        matches!(backend(), Backend::Wgpu) && crate::gpu_wgpu::discrete_active()
588    }
589    #[cfg(not(feature = "gpu"))]
590    {
591        false
592    }
593}
594
595/// q8_row/q8_2f matvec, rows [row0, row0+rows). `xs` — prescaled by the θ-field.
596#[allow(clippy::too_many_arguments, unused_variables)]
597pub fn q8_matvec_range(
598    model: &Arc<CmfModel>,
599    idx: usize,
600    row0: usize,
601    row_scale: &[f32],
602    xs: &[f32],
603    rows: usize,
604    cols: usize,
605    out: &mut [f32],
606) -> bool {
607    match backend() {
608        #[cfg(target_os = "macos")]
609        Backend::Metal => {
610            crate::gpu_metal::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
611        }
612        #[cfg(feature = "gpu")]
613        Backend::Wgpu => {
614            crate::gpu_wgpu::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
615        }
616        Backend::None => false,
617    }
618}
619
620/// GEMM of a prefill batch: `pre` — prescaled inputs row-major [b, cols],
621/// out — row-major [b, rows].
622#[allow(clippy::too_many_arguments, unused_variables)]
623pub fn q8_matmat(
624    model: &Arc<CmfModel>,
625    idx: usize,
626    row_scale: &[f32],
627    pre: &[f32],
628    b: usize,
629    rows: usize,
630    cols: usize,
631    out: &mut [f32],
632) -> bool {
633    match backend() {
634        #[cfg(target_os = "macos")]
635        Backend::Metal => {
636            crate::gpu_metal::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out)
637        }
638        #[cfg(feature = "gpu")]
639        Backend::Wgpu => crate::gpu_wgpu::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out),
640        Backend::None => false,
641    }
642}
643
644/// q1 matvec: raw f32 activations, tile-embedded scales. Metal only
645/// for now (wgpu q1 WGSL is queued); false = CPU fallback.
646#[allow(unused_variables)]
647pub fn q1_matvec(
648    model: &Arc<CmfModel>,
649    idx: usize,
650    xs: &[f32],
651    rows: usize,
652    cols: usize,
653    out: &mut [f32],
654) -> bool {
655    match backend() {
656        #[cfg(target_os = "macos")]
657        Backend::Metal => crate::gpu_metal::q1_matvec(model, idx, xs, rows, cols, out),
658        #[cfg(feature = "gpu")]
659        Backend::Wgpu => crate::gpu_wgpu::q1_matvec(model, idx, xs, rows, cols, out),
660        Backend::None => false,
661    }
662}
663
664/// Whole attention sub-block on the wgpu token graph (drop-in for
665/// `qwen_attention`): normed hidden in, O-projection out, resident device
666/// K/V mirror. false = refusal / not the wgpu backend → CPU path.
667#[allow(clippy::too_many_arguments)]
668pub fn attn_dropin(
669    model: &Arc<CmfModel>,
670    kv_id: u64,
671    layer: usize,
672    normed: &[f32],
673    wq_idx: usize,
674    wk_idx: usize,
675    wv_idx: usize,
676    wo_idx: usize,
677    q_norm: Option<&[f32]>,
678    k_norm: Option<&[f32]>,
679    invf: &[f32],
680    nh: usize,
681    nkv: usize,
682    hd: usize,
683    rd: usize,
684    hidden: usize,
685    pos: usize,
686    cap: usize,
687    gemma: bool,
688    eps: f32,
689    cpu_k: &[Vec<f32>],
690    cpu_v: &[Vec<f32>],
691    out: &mut [f32],
692) -> bool {
693    match backend() {
694        #[cfg(feature = "gpu")]
695        Backend::Wgpu => crate::gpu_wgpu::attn_dropin_gpu(
696            model, kv_id, layer, normed, wq_idx, wk_idx, wv_idx, wo_idx, q_norm, k_norm, invf, nh,
697            nkv, hd, rd, hidden, pos, cap, gemma, eps, cpu_k, cpu_v, out,
698        ),
699        #[allow(unused_variables)]
700        _ => false,
701    }
702}
703
704/// One weight in the whole-token graph: tensor idx + a codec tag (0=q8_row,
705/// 1=q1, 2=q4_tiled, 3=q1t, 4=f32) + per-row scales (q8_row only) + the raw f32
706/// data (kind 4 only — small unquantized projections like GDN in_proj_a/b).
707pub struct GraphW<'a> {
708    pub idx: usize,
709    pub kind: u8,
710    pub row_scale: &'a [f32],
711    pub data: &'a [f32],
712}
713
714/// A layer's token-mixing op: standard attention or a GDN (linear-attention)
715/// block. The surrounding norms + SwiGLU FFN are common to both.
716pub enum GraphAttn<'a> {
717    Full {
718        wq: GraphW<'a>,
719        wk: GraphW<'a>,
720        wv: GraphW<'a>,
721        wo: GraphW<'a>,
722        q_norm: Option<&'a [f32]>,
723        k_norm: Option<&'a [f32]>,
724        /// (bq, bk, bv) attention biases (Qwen2). None ⇒ no bias.
725        bias: Option<(&'a [f32], &'a [f32], &'a [f32])>,
726        /// Qwen3.5 gated attention: wq emits 2·nh·hd (q||gate per head), the
727        /// attention output is scaled by sigmoid(gate) before the O projection.
728        output_gate: bool,
729        cpu_k: &'a [Vec<f32>],
730        cpu_v: &'a [Vec<f32>],
731    },
732    Gdn {
733        qkv: GraphW<'a>,
734        z: GraphW<'a>,
735        a: GraphW<'a>,
736        b: GraphW<'a>,
737        out: GraphW<'a>,
738        conv1d: &'a [f32],
739        a_log: &'a [f32],
740        dt_bias: &'a [f32],
741        norm: &'a [f32],
742        nv: usize,
743        nk: usize,
744        dk: usize,
745        dv: usize,
746        kk: usize,
747        /// CPU recurrent state `[ring (kk-1)·cdim | S nv·dk·dv]` — seeds the
748        /// device mirror when prefill ran on the host (o1 collection, CPU
749        /// fallback): a zero-initialized device state at decode is exactly
750        /// the "coherent but contextless" garble.
751        cpu_state: &'a [f32],
752    },
753}
754
755/// Per-layer weights for the whole-token wgpu graph.
756pub struct GraphLayer<'a> {
757    pub input_norm: &'a [f32],
758    pub attn: GraphAttn<'a>,
759    pub post_norm: &'a [f32],
760    pub ffn: GraphFfn<'a>,
761}
762
763/// The FFN of one graph layer: a dense SwiGLU trio, or a routed MoE —
764/// router + top-k selection + all selected experts run ON DEVICE (the
765/// routing decision depends on the resident hidden state, so a CPU
766/// round-trip per layer would forfeit the one-submit design).
767pub enum GraphFfn<'a> {
768    Dense {
769        gate: GraphW<'a>,
770        up: GraphW<'a>,
771        down: GraphW<'a>,
772    },
773    Moe {
774        /// Router logits weight (f32, kind 4) `[n_exp, hidden]`.
775        router: GraphW<'a>,
776        /// Shared-expert sigmoid gate (f32) `[1, hidden]`.
777        shared_gate: GraphW<'a>,
778        /// Per-expert q4_tiled directory indices `(gate, up, down)`;
779        /// the SHARED expert rides as the LAST entry — the select
780        /// kernel pins it with the sigmoid weight.
781        experts: Vec<(usize, usize, usize)>,
782        /// Routed experts (shared excluded).
783        n_exp: usize,
784        top_k: usize,
785        inter: usize,
786        norm_topk: bool,
787        /// Expert weight layout, uniform across the layer: `false` =
788        /// q4_tiled (18 B tiles, inline f16 scale), `true` = q4tp
789        /// (16 B nibbles + a per-row ladder plane). The two differ only
790        /// in where the scale comes from, so they share every kernel
791        /// but the weight-staging block.
792        q4tp: bool,
793        /// `true` = the gate/up experts are `q2tp` (2-bit plane) while
794        /// `down` stays q4tp — the mixed profile a 2-bit-class checkpoint
795        /// converts into. Only meaningful with `q4tp: true`.
796        gu_q2: bool,
797    },
798}
799
800/// Whole-token decode graph on wgpu: the entire layer stack in ONE submit,
801/// hidden resident, one readback. Updates `h` in place. false = refusal.
802/// `loop_norm_at`: virtual layer indices after which `final_norm` is applied
803/// (Looped Transformer mid-stack norm). Empty for standard models.
804#[allow(clippy::too_many_arguments)]
805pub fn forward_token_graph(
806    model: &Arc<CmfModel>,
807    kv_id: u64,
808    layers: &[GraphLayer],
809    // Per-layer sealed o1 (Nystrom) state; Some = replace this layer's
810    // exact attention with the O(1) kernels. wgpu only.
811    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
812    o1_epoch: u64,
813    invf: &[f32],
814    h: &mut [f32],
815    nh: usize,
816    nkv: usize,
817    hd: usize,
818    rd: usize,
819    hidden: usize,
820    inter: usize,
821    position: usize,
822    cap: usize,
823    gemma: bool,
824    eps: f32,
825    lm_head: Option<(&GraphW, usize)>,
826    final_norm: &[f32],
827    logits: &mut Vec<f32>,
828    loop_norm_at: &[usize],
829    steps: usize,
830    embed: Option<(&GraphW, usize, f32)>,
831    ids_out: Option<&mut Vec<u32>>,
832) -> bool {
833    match backend() {
834        #[cfg(feature = "gpu")]
835        Backend::Wgpu => crate::gpu_wgpu::forward_token_graph(
836            model,
837            kv_id,
838            layers,
839            o1,
840            o1_epoch,
841            invf,
842            h,
843            nh,
844            nkv,
845            hd,
846            rd,
847            hidden,
848            inter,
849            position,
850            cap,
851            gemma,
852            eps,
853            lm_head,
854            final_norm,
855            logits,
856            loop_norm_at,
857            steps,
858            embed,
859            ids_out,
860        ),
861        #[allow(unused_variables)]
862        _ => {
863            let _ = (lm_head, final_norm, logits, loop_norm_at);
864            false
865        }
866    }
867}
868
869/// Batched prefill: k contiguous positions through the whole graph in one submit
870/// (projections/FFN as GEMMs, attention/GDN looped over scratch). `h` is
871/// [k·hidden] in/out; `positions` len k. wgpu only.
872#[allow(clippy::too_many_arguments)]
873pub fn forward_batch_graph(
874    model: &Arc<CmfModel>,
875    kv_id: u64,
876    layers: &[GraphLayer],
877    invf: &[f32],
878    h: &mut [f32],
879    nh: usize,
880    nkv: usize,
881    hd: usize,
882    rd: usize,
883    hidden: usize,
884    inter: usize,
885    positions: &[usize],
886    cap: usize,
887    gemma: bool,
888    eps: f32,
889    k: usize,
890) -> bool {
891    match backend() {
892        #[cfg(feature = "gpu")]
893        Backend::Wgpu => crate::gpu_wgpu::forward_batch_graph(
894            model, kv_id, layers, invf, h, nh, nkv, hd, rd, hidden, inter, positions, cap, gemma,
895            eps, k,
896        ),
897        _ => false,
898    }
899}
900
901/// Drop the wgpu token graph's device K/V mirror for a pipeline.
902pub fn graph_kv_reset(_kv_id: u64) {
903    #[cfg(feature = "gpu")]
904    if backend() == Backend::Wgpu {
905        crate::gpu_wgpu::kv_mirror_reset(_kv_id);
906    }
907}
908
909/// Ternary (q1t) BASE matvec on the GPU — fills `out` with the base dot; the
910/// caller adds the sparse overlay on the CPU. Metal only for now (wgpu q1t not
911/// yet written → CPU fallback).
912pub fn q1t_matvec(
913    model: &Arc<CmfModel>,
914    idx: usize,
915    xs: &[f32],
916    rows: usize,
917    cols: usize,
918    out: &mut [f32],
919) -> bool {
920    match backend() {
921        #[cfg(target_os = "macos")]
922        Backend::Metal => {
923            if metal_q1t_enabled() {
924                crate::gpu_metal::q1t_matvec(model, idx, xs, rows, cols, out)
925            } else {
926                false
927            }
928        }
929        #[cfg(feature = "gpu")]
930        Backend::Wgpu => crate::gpu_wgpu::q1t_matvec(model, idx, xs, rows, cols, out),
931        Backend::None => false,
932    }
933}
934
935/// q4_block matvec on the GPU — wgpu only (Metal drives q4_block through the
936/// whole-token graph, not a standalone matvec).
937#[allow(unused_variables)]
938pub fn q4b_matvec(
939    model: &Arc<CmfModel>,
940    idx: usize,
941    xs: &[f32],
942    rows: usize,
943    cols: usize,
944    out: &mut [f32],
945) -> bool {
946    match backend() {
947        #[cfg(target_os = "macos")]
948        Backend::Metal => false,
949        #[cfg(feature = "gpu")]
950        Backend::Wgpu => crate::gpu_wgpu::q4b_matvec(model, idx, xs, rows, cols, out),
951        Backend::None => false,
952    }
953}
954
955/// q1t batched GEMM (prefill) — base + overlay on-device (Metal simdgroup or
956/// wgpu register-blocked).
957pub fn q1t_matmat(
958    model: &Arc<CmfModel>,
959    idx: usize,
960    xs: &[f32],
961    b: usize,
962    rows: usize,
963    cols: usize,
964    out: &mut [f32],
965) -> bool {
966    match backend() {
967        #[cfg(target_os = "macos")]
968        // Batched prefill and single-token decode are both enabled. On the
969        // real 14.8B Q1T model prefill PPL was within 0.3% of CPU (7.942 vs
970        // 7.966), and the alignment-safe decode kernel reached 3.52e-6 max_rel.
971        Backend::Metal => crate::gpu_metal::q1t_matmat(model, idx, xs, b, rows, cols, out),
972        #[cfg(feature = "gpu")]
973        Backend::Wgpu => crate::gpu_wgpu::q1t_matmat(model, idx, xs, b, rows, cols, out),
974        Backend::None => false,
975    }
976}
977
978/// Native Metal Q1T switch. Enabled by default after the byte-packed Q1T
979/// fields were changed to alignment-safe loads; keep an explicit emergency
980/// fallback for device/driver diagnostics.
981#[cfg(target_os = "macos")]
982pub(crate) fn metal_q1t_enabled() -> bool {
983    std::env::var("CMF_METAL_Q1T")
984        .map(|v| v != "0" && !v.eq_ignore_ascii_case("off"))
985        .unwrap_or(true)
986}
987
988/// Batched q1 GEMM (prefill). wgpu only — Metal has its own block path.
989pub fn q1_matmat(
990    model: &Arc<CmfModel>,
991    idx: usize,
992    xs: &[f32],
993    b: usize,
994    rows: usize,
995    cols: usize,
996    out: &mut [f32],
997) -> bool {
998    match backend() {
999        #[cfg(feature = "gpu")]
1000        Backend::Wgpu => crate::gpu_wgpu::q1_matmat(model, idx, xs, b, rows, cols, out),
1001        #[allow(unused_variables)]
1002        _ => false,
1003    }
1004}
1005
1006/// Contention kill for the wide imagegen GEMM/FFN paths: one grossly
1007/// slow op under a work-proportional budget (fair-device ops are
1008/// ≤~100 ms even at 1024px) means another process owns the device —
1009/// verdicts are per-process, so CPU for the rest of this one.
1010static MM_KILL: AtomicBool = AtomicBool::new(false);
1011pub(crate) fn mm_killed() -> bool {
1012    MM_KILL.load(Ordering::Relaxed)
1013}
1014pub(crate) fn mm_kill() {
1015    MM_KILL.store(true, Ordering::Relaxed);
1016}
1017
1018/// Fused DiT SwiGLU FFN on the device: g=X·W1ᵀ, u=X·W3ᵀ, silu(g)·u,
1019/// Causal chunk attention on the device: `b` queries against `s0 + b`
1020/// cached keys. wgpu only — Metal's chunk graph keeps attention inside
1021/// the resident block and never calls out.
1022#[allow(unused_variables, clippy::too_many_arguments)]
1023pub fn chunk_attend(
1024    q: &[f32],
1025    k: &[&[f32]],
1026    v: &[&[f32]],
1027    b: usize,
1028    s0: usize,
1029    nh: usize,
1030    nkv: usize,
1031    hd: usize,
1032    scale: f32,
1033    out: &mut [f32],
1034) -> bool {
1035    match backend() {
1036        #[cfg(feature = "gpu")]
1037        Backend::Wgpu => crate::gpu_wgpu::chunk_attend(q, k, v, b, s0, nh, nkv, hd, scale, out),
1038        #[allow(unreachable_patterns)]
1039        _ => false,
1040    }
1041}
1042
1043/// Fused QKV projection: one upload of the normed chunk, three GEMMs,
1044/// one readback of Q|K|V back to back. Metal has no twin yet — its
1045/// chunk graph keeps the whole layer resident and never surfaces QKV.
1046#[allow(unused_variables, clippy::too_many_arguments)]
1047pub fn q4t_qkv(
1048    model: &Arc<CmfModel>,
1049    wq: usize,
1050    wk: usize,
1051    wv: usize,
1052    xs: &[f32],
1053    b: usize,
1054    cols: usize,
1055    rq: usize,
1056    rk: usize,
1057    rv: usize,
1058    out: &mut [f32],
1059) -> bool {
1060    match backend() {
1061        #[cfg(feature = "gpu")]
1062        Backend::Wgpu => crate::gpu_wgpu::q4t_qkv(model, wq, wk, wv, xs, b, cols, rq, rk, rv, out),
1063        #[allow(unreachable_patterns)]
1064        _ => false,
1065    }
1066}
1067
1068/// y=·W2ᵀ — one command buffer, only X and Y cross the CPU boundary.
1069#[allow(unused_variables, clippy::too_many_arguments)]
1070pub fn q4tp_ffn(
1071    model: &Arc<CmfModel>,
1072    w1: usize,
1073    w3: usize,
1074    w2: usize,
1075    xs: &[f32],
1076    b: usize,
1077    hidden: usize,
1078    inter: usize,
1079    out: &mut [f32],
1080) -> bool {
1081    match backend() {
1082        #[cfg(target_os = "macos")]
1083        Backend::Metal => crate::gpu_metal::q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
1084        #[cfg(feature = "gpu")]
1085        // No wgpu twin yet: the fused DiT chain there is q4t-only, so a q4tp
1086        // model keeps the unfused wgpu path rather than a wrong kernel.
1087        Backend::Wgpu => false,
1088        #[allow(unreachable_patterns)]
1089        _ => false,
1090    }
1091}
1092
1093pub fn q4t_ffn(
1094    model: &Arc<CmfModel>,
1095    w1: usize,
1096    w3: usize,
1097    w2: usize,
1098    xs: &[f32],
1099    b: usize,
1100    hidden: usize,
1101    inter: usize,
1102    out: &mut [f32],
1103) -> bool {
1104    match backend() {
1105        #[cfg(target_os = "macos")]
1106        Backend::Metal => crate::gpu_metal::q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
1107        #[cfg(feature = "gpu")]
1108        Backend::Wgpu => crate::gpu_wgpu::q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
1109        #[allow(unreachable_patterns)]
1110        _ => false,
1111    }
1112}
1113
1114/// One whole modulated DiT block for `dit_block`: geometry, norm
1115/// weights, AdaLN scale/gate vectors (gates pre-tanh'd), a per-token
1116/// f32 RoPE cos/sin table, and the directory indices of the seven
1117/// q4t projections. `x` is in-out `[n, hidden]`.
1118pub struct DitBlockArgs<'a> {
1119    pub n: usize,
1120    pub hidden: usize,
1121    pub inter: usize,
1122    pub nh: usize,
1123    pub nkv: usize,
1124    pub hd: usize,
1125    pub eps: f32,
1126    pub rope_cos: &'a [f32],
1127    pub rope_sin: &'a [f32],
1128    pub norm1: &'a [f32],
1129    pub norm2: &'a [f32],
1130    pub ffn_norm1: &'a [f32],
1131    pub ffn_norm2: &'a [f32],
1132    pub norm_q: &'a [f32],
1133    pub norm_k: &'a [f32],
1134    pub s_msa: &'a [f32],
1135    pub gate_msa: &'a [f32],
1136    pub s_mlp: &'a [f32],
1137    pub gate_mlp: &'a [f32],
1138    pub wq: usize,
1139    pub wk: usize,
1140    pub wv: usize,
1141    pub wo: usize,
1142    pub w1: usize,
1143    pub w3: usize,
1144    pub w2: usize,
1145}
1146
1147/// One whole modulated DiT block on the device — norms, qkv, RoPE,
1148/// attention, residuals and the SwiGLU FFN in a single command
1149/// buffer; only `x` crosses the CPU boundary (in and out).
1150#[allow(unused_variables)]
1151pub fn dit_block(model: &Arc<CmfModel>, a: &DitBlockArgs, x: &mut [f32]) -> bool {
1152    match backend() {
1153        #[cfg(target_os = "macos")]
1154        Backend::Metal => crate::gpu_metal::dit_block(model, a, x),
1155        _ => false,
1156    }
1157}
1158
1159/// One VAE resnet block for `vae_resnet`: norm/conv weights and the
1160/// channel/shape geometry. `shortcut` is the 1×1 projection (w, b, k)
1161/// when in/out channels differ.
1162pub struct VaeResnetArgs<'a> {
1163    pub groups: usize,
1164    pub ic: usize,
1165    pub oc: usize,
1166    pub h: usize,
1167    pub w: usize,
1168    pub n1w: &'a [f32],
1169    pub n1b: &'a [f32],
1170    pub c1w: &'a [f32],
1171    pub c1b: &'a [f32],
1172    pub c1k: usize,
1173    pub n2w: &'a [f32],
1174    pub n2b: &'a [f32],
1175    pub c2w: &'a [f32],
1176    pub c2b: &'a [f32],
1177    pub c2k: usize,
1178    pub shortcut: Option<(&'a [f32], &'a [f32], usize)>,
1179}
1180
1181/// One whole VAE resnet block on the device (norm+silu → conv ×2 →
1182/// shortcut → add, one command buffer).
1183#[allow(unused_variables)]
1184pub fn vae_resnet(a: &VaeResnetArgs, x: &[f32], out: &mut [f32]) -> bool {
1185    match backend() {
1186        #[cfg(target_os = "macos")]
1187        Backend::Metal => crate::gpu_metal::vae_resnet(a, x, out),
1188        _ => false,
1189    }
1190}
1191
1192/// Nearest-2× upsample fused with the following conv — the small
1193/// pre-upsample image is what crosses the CPU boundary.
1194#[allow(unused_variables, clippy::too_many_arguments)]
1195pub fn vae_upsample_conv(
1196    w: &[f32],
1197    bias: &[f32],
1198    x: &[f32],
1199    ic: usize,
1200    oc: usize,
1201    h: usize,
1202    w_img: usize,
1203    k: usize,
1204    out: &mut [f32],
1205) -> bool {
1206    match backend() {
1207        #[cfg(target_os = "macos")]
1208        Backend::Metal => crate::gpu_metal::vae_upsample_conv(w, bias, x, ic, oc, h, w_img, k, out),
1209        _ => false,
1210    }
1211}
1212
1213/// VAE conv2d on the device (implicit GEMM — the CPU path pays for a
1214/// multi-GB im2col matrix at high resolutions).
1215#[allow(unused_variables, clippy::too_many_arguments)]
1216pub fn vae_conv2d(
1217    w: &[f32],
1218    bias: &[f32],
1219    x: &[f32],
1220    ic: usize,
1221    oc: usize,
1222    h: usize,
1223    w_img: usize,
1224    k: usize,
1225    out: &mut [f32],
1226) -> bool {
1227    match backend() {
1228        #[cfg(target_os = "macos")]
1229        Backend::Metal => crate::gpu_metal::vae_conv2d(w, bias, x, ic, oc, h, w_img, k, out),
1230        _ => false,
1231    }
1232}
1233
1234/// DiT full bidirectional attention on the device (all heads:
1235/// scores GEMM → row softmax → P·V → panel unstack, one command
1236/// buffer). Head-major inputs; out is [n, nh·hd].
1237#[allow(unused_variables, clippy::too_many_arguments)]
1238pub fn dit_attention(
1239    qh: &[f32],
1240    kh: &[f32],
1241    vh: &[f32],
1242    nh: usize,
1243    nkv: usize,
1244    n: usize,
1245    hd: usize,
1246    scale: f32,
1247    out: &mut [f32],
1248) -> bool {
1249    match backend() {
1250        #[cfg(target_os = "macos")]
1251        Backend::Metal => crate::gpu_metal::dit_attention(qh, kh, vh, nh, nkv, n, hd, scale, out),
1252        #[cfg(feature = "gpu")]
1253        Backend::Wgpu => crate::gpu_wgpu::dit_attention(qh, kh, vh, nh, nkv, n, hd, scale, out),
1254        #[allow(unreachable_patterns)]
1255        _ => false,
1256    }
1257}
1258
1259/// Batched q4t GEMM on the device (imagegen DiT prefill shapes).
1260/// Metal: q4t_mul_mm decodes the mmap-resident tiles inside the
1261/// GEMM's K loop. wgpu (Vulkan/DX12 → NVIDIA/AMD/Intel/Adreno/Mali):
1262/// the register-blocked WGSL twin, weights cached in VRAM.
1263#[allow(unused_variables)]
1264pub fn q4tp_matmat(
1265    model: &Arc<CmfModel>,
1266    idx: usize,
1267    xs: &[f32],
1268    b: usize,
1269    rows: usize,
1270    cols: usize,
1271    out: &mut [f32],
1272) -> bool {
1273    match backend() {
1274        #[cfg(target_os = "macos")]
1275        Backend::Metal => crate::gpu_metal::q4tp_matmat(model, idx, xs, b, rows, cols, out),
1276        #[cfg(feature = "gpu")]
1277        Backend::Wgpu => crate::gpu_wgpu::q4tp_matmat(model, idx, xs, b, rows, cols, out),
1278        #[allow(unreachable_patterns)]
1279        _ => false,
1280    }
1281}
1282
1283/// Single-token q4tp matvec on the device — the lm_head class. Through the
1284/// DEDICATED matvec kernel: the batched GEMM at b=1 measured 11.73 ms
1285/// against the host's 9.51 on the release head, so the route that was
1286/// supposed to save eleven milliseconds a token lost its own probe instead.
1287pub fn q4tp_matvec(
1288    model: &Arc<CmfModel>,
1289    idx: usize,
1290    xs: &[f32],
1291    rows: usize,
1292    cols: usize,
1293    out: &mut [f32],
1294) -> bool {
1295    match backend() {
1296        #[cfg(target_os = "macos")]
1297        Backend::Metal => crate::gpu_metal::q4tp_matvec_for_test(model, idx, xs, rows, cols, out),
1298        #[cfg(feature = "gpu")]
1299        Backend::Wgpu => crate::gpu_wgpu::q4tp_matvec(model, idx, xs, rows, cols, out),
1300        #[allow(unreachable_patterns)]
1301        _ => false,
1302    }
1303}
1304
1305pub fn q4t_matmat(
1306    model: &Arc<CmfModel>,
1307    idx: usize,
1308    xs: &[f32],
1309    b: usize,
1310    rows: usize,
1311    cols: usize,
1312    out: &mut [f32],
1313) -> bool {
1314    match backend() {
1315        #[cfg(target_os = "macos")]
1316        Backend::Metal => crate::gpu_metal::q4t_matmat(model, idx, xs, b, rows, cols, out),
1317        #[cfg(feature = "gpu")]
1318        Backend::Wgpu => crate::gpu_wgpu::q4t_matmat(model, idx, xs, b, rows, cols, out),
1319        #[allow(unreachable_patterns)]
1320        _ => false,
1321    }
1322}
1323
1324/// Whole-block token-graph types re-exported from the Metal backend.
1325#[cfg(target_os = "macos")]
1326pub use crate::gpu_metal::{
1327    AttnDeviceParams, AttnGpuLayer, GdnGpuCfg, GdnGpuLayer, GraphDims, TokenGraph, kv_mirror_drop,
1328    kv_mirror_read_last, kv_mirror_take_imp,
1329};
1330
1331/// A BLOCK of consecutive q1 GDN layers in one submission (Metal only).
1332#[cfg(target_os = "macos")]
1333pub fn gdn_block(
1334    model: &Arc<CmfModel>,
1335    layers: &[GdnGpuLayer],
1336    states: &mut [&mut [f32]],
1337    cfg: &GdnGpuCfg,
1338    h: &mut [f32],
1339) -> bool {
1340    match backend() {
1341        Backend::Metal => crate::gpu_metal::gdn_block(model, layers, states, cfg, h),
1342        _ => false,
1343    }
1344}
1345
1346/// A layer's MoE-FFN in one submission (amortizing the dispatch cost).
1347#[allow(unused_variables)]
1348pub fn moe_block(model: &Arc<CmfModel>, jobs: &[MoeJob], out: &mut [f32]) -> bool {
1349    match backend() {
1350        #[cfg(target_os = "macos")]
1351        Backend::Metal => crate::gpu_metal::moe_block(model, jobs, out),
1352        #[cfg(feature = "gpu")]
1353        Backend::Wgpu => crate::gpu_wgpu::moe_block(model, jobs, out),
1354        Backend::None => false,
1355    }
1356}
1357
1358/// Independent matvecs of one input in a single submission (GDN projections).
1359#[allow(unused_variables)]
1360pub fn matvec_batch(model: &Arc<CmfModel>, jobs: &[BatchJob], out: &mut [&mut [f32]]) -> bool {
1361    match backend() {
1362        #[cfg(target_os = "macos")]
1363        Backend::Metal => crate::gpu_metal::matvec_batch(model, jobs, out),
1364        #[cfg(feature = "gpu")]
1365        Backend::Wgpu => crate::gpu_wgpu::matvec_batch(model, jobs, out),
1366        Backend::None => false,
1367    }
1368}
1369
1370// ── Whole-token wgpu graph race (generation granularity) ─────────────
1371// On integrated/mobile adapters the graph is neither trusted nor banned
1372// a priori — it RACES the normal path: generations alternate arms (the
1373// normal path first — known-good UX — then the graph), per-token wall
1374// times accumulate per arm, and once both arms have enough steady
1375// samples the faster one wins for the process. Arm switches happen ONLY
1376// at generation boundaries (`kv_cache.clear()` resets state), so the
1377// device KV mirror and the CPU cache never diverge mid-sequence. The
1378// single exception is the first-token bail: the very first decode token
1379// of a graph generation may be discarded and recomputed on the CPU
1380// path (the prompt KV is CPU-owned at that point, so this is safe) —
1381// a tiled mobile GPU that drains its pipeline at every barrier turns
1382// the ~300-dispatch graph into seconds per token (field report: 0.2
1383// tok/s vs 15 on the CPU), and one token is all it takes to see that.
1384static GRAPH_RACE_STATE: AtomicU8 = AtomicU8::new(0); // 0 racing, 1 graph won, 2 normal won
1385static GRAPH_RACE_FLIP: AtomicU32 = AtomicU32::new(0);
1386static GRAPH_RACE_ARM_GRAPH: AtomicU8 = AtomicU8::new(0); // this generation's arm
1387static GRAPH_RACE_TOK: AtomicU32 = AtomicU32::new(0); // token index within the generation
1388static GRAPH_NS: [AtomicU64; 2] = [AtomicU64::new(0), AtomicU64::new(0)]; // [normal, graph]
1389static GRAPH_N: [AtomicU32; 2] = [AtomicU32::new(0), AtomicU32::new(0)];
1390
1391/// Steady per-token samples per arm before the race decides.
1392const GRAPH_RACE_SAMPLES: u32 = 4;
1393
1394/// Called at every generation start (fresh KV). Applies a pending
1395/// verdict and picks this generation's arm while racing.
1396pub fn graph_race_begin_generation() {
1397    GRAPH_RACE_TOK.store(0, Ordering::Relaxed);
1398    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
1399        return;
1400    }
1401    let (gn, cn) = (
1402        GRAPH_N[1].load(Ordering::Relaxed),
1403        GRAPH_N[0].load(Ordering::Relaxed),
1404    );
1405    if gn >= GRAPH_RACE_SAMPLES && cn >= GRAPH_RACE_SAMPLES {
1406        let g_avg = GRAPH_NS[1].load(Ordering::Relaxed) / gn as u64;
1407        let c_avg = GRAPH_NS[0].load(Ordering::Relaxed) / cn as u64;
1408        let verdict = if g_avg < c_avg { 1 } else { 2 };
1409        GRAPH_RACE_STATE.store(verdict, Ordering::Relaxed);
1410        tracing::info!(
1411            "wgpu graph race: graph {:.2} ms/tok vs normal {:.2} ms/tok -> {}",
1412            g_avg as f64 / 1e6,
1413            c_avg as f64 / 1e6,
1414            if verdict == 1 { "graph" } else { "normal path" }
1415        );
1416        return;
1417    }
1418    let flip = GRAPH_RACE_FLIP.fetch_add(1, Ordering::Relaxed);
1419    GRAPH_RACE_ARM_GRAPH.store((flip % 2 == 1) as u8, Ordering::Relaxed);
1420}
1421
1422/// Should this decode token try the graph? `trusted` (discrete adapter,
1423/// explicit env, or a GDN hybrid whose state lives on the device) skips
1424/// the race entirely.
1425pub fn graph_race_use_graph(trusted: bool) -> bool {
1426    if trusted {
1427        return true;
1428    }
1429    match GRAPH_RACE_STATE.load(Ordering::Relaxed) {
1430        1 => true,
1431        2 => false,
1432        _ => GRAPH_RACE_ARM_GRAPH.load(Ordering::Relaxed) == 1,
1433    }
1434}
1435
1436/// First decode token of a racing graph generation: hopeless already?
1437/// (>4x the normal path's per-token average AND over a second.) Settles
1438/// the race immediately; the caller discards the graph result and
1439/// recomputes this token on the normal path.
1440pub fn graph_race_first_token_hopeless(dur: std::time::Duration) -> bool {
1441    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
1442        return false;
1443    }
1444    let first = GRAPH_RACE_TOK.load(Ordering::Relaxed) == 0;
1445    let cn = GRAPH_N[0].load(Ordering::Relaxed);
1446    if !first || cn == 0 {
1447        return false;
1448    }
1449    let c_avg = GRAPH_NS[0].load(Ordering::Relaxed) / cn as u64;
1450    let ns = dur.as_nanos() as u64;
1451    if ns > 1_000_000_000 && ns > 4 * c_avg {
1452        GRAPH_RACE_STATE.store(2, Ordering::Relaxed);
1453        tracing::info!(
1454            "wgpu graph race: first graph token {:.0} ms vs normal {:.2} ms/tok — hopeless, normal path wins",
1455            ns as f64 / 1e6,
1456            c_avg as f64 / 1e6
1457        );
1458        return true;
1459    }
1460    false
1461}
1462
1463/// Record one decode-token wall time for the racing arm. The first
1464/// token of each generation is discarded (KV-mirror upload / cold
1465/// caches on the graph arm; cold mmap on the normal arm).
1466pub fn graph_race_record(used_graph: bool, dur: std::time::Duration) {
1467    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
1468        return;
1469    }
1470    let tok = GRAPH_RACE_TOK.fetch_add(1, Ordering::Relaxed);
1471    if tok == 0 {
1472        return;
1473    }
1474    let i = used_graph as usize;
1475    GRAPH_NS[i].fetch_add(dur.as_nanos() as u64, Ordering::Relaxed);
1476    GRAPH_N[i].fetch_add(1, Ordering::Relaxed);
1477}