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
18/// Packed, f32-only Embryo model consumed by the resident Vulkan graph.
19///
20/// This is deliberately a separate representation from `CmfModel`: the
21/// Embryo graph owns one contiguous device copy and never dereferences the
22/// mmap or asks the ordinary per-op residency path for a tensor.  `meta`
23/// contains byte-free element offsets into `weights`; `UINT_MAX` marks an
24/// absent optional matrix.  The builder lives in `pipeline.rs`, where the
25/// architecture-specific weight types are visible.
26pub struct EmbryoGraphModel {
27    pub id: u64,
28    pub hidden: usize,
29    pub intermediate: usize,
30    pub vocab: usize,
31    pub layers: usize,
32    pub phase_heads: usize,
33    pub nphase: usize,
34    pub phase_dv: usize,
35    pub anchor_q_heads: usize,
36    pub anchor_kv_heads: usize,
37    pub anchor_head_dim: usize,
38    pub rotary_dim: usize,
39    pub max_seq: usize,
40    pub cluster_count: usize,
41    pub cluster_size: usize,
42    pub phase_state_len: usize,
43    pub state_stride: usize,
44    pub kv_stride: usize,
45    pub norm_gemma: bool,
46    pub phase_mass: f32,
47    pub weights: Vec<f32>,
48    pub meta: Vec<u32>,
49    pub lm_head: Vec<f32>,
50    pub clusters: Vec<f32>,
51    pub final_norm: Vec<f32>,
52    pub inv_freq: Vec<f32>,
53    /// Natively bounded anchors (`swa_sink_v1`): every anchor layer owns a
54    /// ring of `anchor_window` raw keys/values instead of a `max_seq` KV
55    /// plane, so `kv_stride` is the ring size, `kv_layers` counts the
56    /// anchors, and no position cap applies (the operator has none).
57    pub bounded: bool,
58    /// Layers that own a KV/ring slot of `kv_stride` f32 (all layers for
59    /// the legacy full anchor — offsets are `layer·kv_stride` — or the
60    /// bounded anchors only).
61    pub kv_layers: usize,
62    /// Recurrent (phase or GDN) layers — the state buffer holds one
63    /// `state_stride` per such layer; anchors own none.
64    pub state_layers: usize,
65    pub anchor_window: usize,
66    pub anchor_sink: usize,
67    /// vmf_phase mixer layers (kind 0/1) in the stack.
68    pub phase_layers: usize,
69    /// GatedDeltaNet mixer layers (kind 4) in the stack; their geometry
70    /// is `gdn_heads` (nv), `gdn_k_heads` (nk), `gdn_dk`, `gdn_dv`,
71    /// `gdn_kk` (conv taps) — header words 24..29 of `meta`.
72    pub gdn_layers: usize,
73    pub gdn_heads: usize,
74    pub gdn_k_heads: usize,
75    pub gdn_dk: usize,
76    pub gdn_dv: usize,
77    pub gdn_kk: usize,
78}
79
80impl EmbryoGraphModel {
81    /// Fused q/k/v projection width of the GDN mixer (`2·nk·dk + nv·dv`).
82    pub fn gdn_c_dim(&self) -> usize {
83        2 * self.gdn_k_heads * self.gdn_dk + self.gdn_heads * self.gdn_dv
84    }
85}
86
87/// Words in the resident graph's `meta` header before the per-layer
88/// records (64 words each). Shared by the host packer and the encoder.
89pub const EMBRYO_META_HEADER: usize = 32;
90
91/// Positions one chunked-prefill submit of the resident Embryo graph
92/// covers (the shader's `CMAX`; the chunk window of the scratch buffer is
93/// sized by it).
94pub const EMBRYO_CHUNK_MAX: usize = 64;
95
96/// `n` contiguous prompt positions (`rows` = n × hidden embeddings from
97/// `position`) through the resident Embryo graph in one submit; logits of
98/// the last position. False = refused before any device work (the caller
99/// keeps the per-position path), or the sequence went cold.
100pub fn forward_embryo_graph_chunk(
101    model: &Arc<EmbryoGraphModel>,
102    kv_id: u64,
103    rows: &[f32],
104    position: usize,
105    n: usize,
106    logits: &mut Vec<f32>,
107) -> bool {
108    #[cfg(feature = "gpu")]
109    if backend() == Backend::Wgpu {
110        return crate::gpu_wgpu::forward_embryo_graph_chunk(model, kv_id, rows, position, n, logits);
111    }
112    let _ = (model, kv_id, rows, position, n, logits);
113    false
114}
115
116/// Bytes the resident Embryo graph holds on the device for a sequence:
117/// `(recurrent state, anchor KV/ring)`. None when the sequence has no
118/// device image (host path, or not started yet). This is the measured
119/// long-context claim of the resident path — a bounded genome reports
120/// the same two numbers at every context depth.
121pub fn embryo_device_state_bytes(kv_id: u64) -> Option<(u64, u64)> {
122    #[cfg(feature = "gpu")]
123    if backend() == Backend::Wgpu {
124        return crate::gpu_wgpu::embryo_device_state_bytes(kv_id);
125    }
126    let _ = kv_id;
127    None
128}
129
130/// Does this directory entry count as WEIGHT in the device placement
131/// heuristics (layer prefix, live-weight budget, `serve` replicas vs
132/// split)? On a genome file only the trunk does: skill tensors replace
133/// trunk tensors of the same shape inside their own lane, so counting
134/// them would give the backbone of F1 another GPU prefix than F0's
135/// (NF-7). Other files keep the historical whole-directory count.
136pub fn counts_as_placement_weight(model: &CmfModel, name: &str) -> bool {
137    model.header.genome.is_none() || cortiq_core::knowledge::is_trunk_tensor(name)
138}
139
140/// Weight bytes the placement heuristics budget for `model`: the trunk's
141/// payload on a genome file ([`counts_as_placement_weight`]), the whole
142/// mapped file otherwise (the historical measure).
143pub fn placement_weight_bytes(model: &CmfModel) -> u64 {
144    if model.header.genome.is_none() {
145        return model.primary_bytes().len() as u64;
146    }
147    model
148        .tensors
149        .iter()
150        .filter(|t| counts_as_placement_weight(model, &t.name))
151        .map(|t| t.nbytes)
152        .sum()
153}
154
155/// Next position of the resident Embryo sequence `kv_id` (`Some(n)` = the
156/// device holds positions `0..n` of it), `None` when the device holds no
157/// initialized image of that sequence — the host owns it (or none began).
158pub fn embryo_device_next_position(kv_id: u64) -> Option<usize> {
159    #[cfg(feature = "gpu")]
160    if backend() == Backend::Wgpu {
161        return crate::gpu_wgpu::embryo_device_next_position(kv_id);
162    }
163    let _ = kv_id;
164    None
165}
166
167thread_local! {
168    /// Index of the current forward layer (−1 = outside a numbered layer:
169    /// lm_head/embed — always allowed). The pipeline sets it before
170    /// each layer so that the GPU/CPU layer-split works.
171    static CUR_LAYER: Cell<i64> = const { Cell::new(-1) };
172    /// Inside `cpu_scope` every GPU gate reports disabled: the timed CPU
173    /// arm of a probe (and a class that lost its probe) must run PURE
174    /// CPU, or inner per-op hooks would re-enter the GPU and poison the
175    /// comparison.
176    static CPU_ONLY: Cell<bool> = const { Cell::new(false) };
177    /// "This op paid a one-off cost" (weight upload / first pipeline
178    /// build): backends set it, `probe_record` discards the sample so
179    /// only steady-state timings compete.
180    static PROBE_COLD: Cell<bool> = const { Cell::new(false) };
181}
182
183/// RAII form of `cpu_scope`, used when a device-prefix graph hands a whole
184/// remainder of the forward pass to the host. Without a guard around that
185/// tail, its ordinary per-op hooks re-entered the GPU and streamed the rest of
186/// an over-size model through the residency arena, defeating the prefix's VRAM
187/// bound at the driver-allocation level.
188pub struct CpuScopeGuard(bool);
189
190impl Drop for CpuScopeGuard {
191    fn drop(&mut self) {
192        CPU_ONLY.with(|c| c.set(self.0));
193    }
194}
195
196pub fn enter_cpu_scope() -> CpuScopeGuard {
197    let previous = CPU_ONLY.with(|c| c.replace(true));
198    CpuScopeGuard(previous)
199}
200
201/// Run `f` with the GPU gates off on this thread (pure-CPU arm).
202pub fn cpu_scope<R>(f: impl FnOnce() -> R) -> R {
203    let _restore = enter_cpu_scope();
204    f()
205}
206
207/// Capture CPU-only placement before dispatching whole operators to workers.
208/// `cpu_scope` is thread-local, while a MoE panel worker calls QTensor again;
209/// without inheritance, which expert happened to land on the caller changed
210/// its precision/backend from run to run.
211pub(crate) fn inherit_cpu_scope() -> impl Fn() -> Option<CpuScopeGuard> + Copy {
212    let on = CPU_ONLY.get();
213    move || on.then(enter_cpu_scope)
214}
215
216/// Backends: name the device once at init. The probe cache is keyed by
217/// it, because a verdict is a property of THIS silicon and nothing else.
218/// First writer wins: a process runs one backend, and on the rare host
219/// where two initialize, the one that came up first is the one in use.
220pub fn probe_set_device(label: &str) {
221    let _ = DEVICE_LABEL.set(label.to_string());
222}
223
224fn device_label() -> &'static str {
225    DEVICE_LABEL.get().map(String::as_str).unwrap_or("unknown")
226}
227
228static DEVICE_LABEL: std::sync::OnceLock<String> = std::sync::OnceLock::new();
229
230/// Somewhere this process may write small caches.
231///
232/// `std::env::temp_dir()` is NOT that place on Android: with no `TMPDIR`
233/// it answers `/tmp`, which does not exist in an app sandbox, and every
234/// write fails silently — measured, after the pipeline cache appeared to
235/// work in a shell (where `TMPDIR=/data/local/tmp`) and did nothing at
236/// all in the app. The loader points this at the model's own directory,
237/// which is somewhere the caller already writes.
238static CACHE_DIR: std::sync::OnceLock<std::path::PathBuf> = std::sync::OnceLock::new();
239
240/// Loader: name a directory this process can write to. First call wins.
241pub fn set_cache_dir(dir: std::path::PathBuf) {
242    let _ = CACHE_DIR.set(dir);
243}
244
245/// Same directory, for the backends.
246pub fn cache_dir_pub() -> std::path::PathBuf {
247    cache_dir()
248}
249
250fn cache_dir() -> std::path::PathBuf {
251    if let Some(d) = CACHE_DIR.get() {
252        return d.clone();
253    }
254    match std::env::var_os("TMPDIR") {
255        Some(t) => std::path::PathBuf::from(t),
256        None => std::env::temp_dir(),
257    }
258}
259
260/// Where decided verdicts are remembered between runs. `CMF_PROBE_CACHE`
261/// overrides the path; `0` disables the cache entirely.
262fn probe_cache_path() -> Option<std::path::PathBuf> {
263    match std::env::var("CMF_PROBE_CACHE") {
264        Ok(v) if v == "0" => None,
265        Ok(v) => Some(std::path::PathBuf::from(v)),
266        Err(_) => Some(cache_dir().join("cortiq-gpu-probe.tsv")),
267    }
268}
269
270/// One line per decided class: `version \t device \t class \t winner`.
271/// A different engine build or a different device simply does not match,
272/// so a stale file is inert rather than wrong.
273fn probe_cache_key_named(class: &str) -> String {
274    format!(
275        "{}\t{}\t{}",
276        env!("CARGO_PKG_VERSION"),
277        device_label(),
278        class
279    )
280}
281
282const CLASS_NAMES: [&str; 8] = [
283    "ffn",
284    "matvec",
285    "matmat",
286    "qkv-batch",
287    "matmat-wide",
288    "lm-head",
289    "gemm-nt",
290    // MoE has a different residency policy from a dense FFN. In
291    // particular, an out-of-core Metal MoE block can become viable after a
292    // dense `ffn` probe has (correctly) decided that ordinary per-op FFNs
293    // lose. Never let that remembered verdict suppress the separate path.
294    "moe",
295];
296
297/// Adopt every verdict this device already reached in an earlier run.
298///
299/// Probing is not cheap and it is not free of consequences: on a
300/// Snapdragon 778G the three deciding classes took **three minutes of
301/// wall clock** before the first token, every process, and in the phone
302/// app that was the whole first answer — 209.6 s for 25 tokens against
303/// 10.5 s on the CPU path. The verdict itself was the same every time.
304/// Paying to rediscover it is the defect; the answer is to write it down.
305fn probe_cache_load() {
306    static ONCE: std::sync::Once = std::sync::Once::new();
307    ONCE.call_once(|| {
308        let Some(path) = probe_cache_path() else {
309            return;
310        };
311        // Unit tests share this process and its default cache path; a
312        // verdict left by an earlier run would decide a class before the
313        // arbitration tests get to watch it alternate. Tests that mean to
314        // exercise the cache point `CMF_PROBE_CACHE` at their own file.
315        if cfg!(test) && std::env::var("CMF_PROBE_CACHE").is_err() {
316            return;
317        }
318        let Ok(text) = std::fs::read_to_string(&path) else {
319            return;
320        };
321        probe_cache_adopt(&text);
322    });
323}
324
325/// Apply verdicts from a cache file's text. Split out from the file
326/// reading so the adoption rule — including which lines must be IGNORED
327/// — is testable without a filesystem.
328fn probe_cache_adopt(text: &str) {
329    for line in text.lines() {
330        let Some((key, verdict)) = line.rsplit_once('\t') else {
331            continue;
332        };
333        let winner = match verdict.trim() {
334            "gpu" => 1u8,
335            "cpu" => 2u8,
336            _ => continue,
337        };
338        for (i, name) in CLASS_NAMES.iter().enumerate() {
339            if probe_cache_key_named(name) == key {
340                let _ = PROBES[i].state.compare_exchange(
341                    0,
342                    winner,
343                    Ordering::Relaxed,
344                    Ordering::Relaxed,
345                );
346                tracing::debug!("gpu probe [{name}]: remembered → {verdict}");
347            }
348        }
349    }
350}
351
352/// Remember a verdict for the next run. Best-effort: a read-only cache
353/// directory costs a re-probe, never a failure.
354fn probe_cache_store(c: OpClass, winner: u8) {
355    let Some(path) = probe_cache_path() else {
356        return;
357    };
358    let line = format!(
359        "{}\t{}\n",
360        probe_cache_key_named(CLASS_NAMES[c as usize]),
361        if winner == 1 { "gpu" } else { "cpu" }
362    );
363    use std::io::Write;
364    if let Ok(mut f) = std::fs::OpenOptions::new()
365        .create(true)
366        .append(true)
367        .open(&path)
368    {
369        let _ = f.write_all(line.as_bytes());
370    }
371}
372
373/// Backends: note a one-off cost (weight upload, buffer-cache fill) so
374/// the probe discards this sample.
375/// Every buffer creation anywhere bumps this; the graph's bind-group
376/// cache treats any cold event as total invalidation — a stale bind
377/// group is silent corruption, a cleared cache is one re-encoded token.
378pub fn cold_epoch() -> u64 {
379    COLD_EPOCH.load(std::sync::atomic::Ordering::Relaxed)
380}
381static COLD_EPOCH: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
382
383pub(crate) fn probe_note_cold() {
384    COLD_EPOCH.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
385    PROBE_COLD.with(|c| c.set(true));
386}
387
388/// Peek the cold flag without consuming it (`probe_record` consumes).
389/// Contention heuristics use this: a slow COLD op is a one-off build
390/// cost, not evidence the device is busy.
391pub(crate) fn probe_was_cold() -> bool {
392    PROBE_COLD.with(|c| c.get())
393}
394
395/// Pipeline: mark the current layer (or −1 outside layers) for layer-split.
396pub fn set_layer(l: i64) {
397    CUR_LAYER.with(|c| c.set(l));
398}
399
400/// The layer `set_layer` last marked on this thread (−1 outside layers).
401pub fn cur_layer() -> i64 {
402    CUR_LAYER.with(|c| c.get())
403}
404
405/// Capacity-derived layer prefix for per-op walks. The explicit
406/// `CMF_GPU_LAYERS` override is handled by the backend and takes precedence.
407pub fn automatic_layer_prefix(
408    model: &Arc<CmfModel>,
409    num_layers: usize,
410    physical_layers: usize,
411) -> Option<usize> {
412    match backend() {
413        #[cfg(feature = "gpu")]
414        Backend::Wgpu => {
415            crate::gpu_wgpu::automatic_layer_prefix(model, num_layers, physical_layers)
416        }
417        _ => None,
418    }
419}
420
421/// Parse `CMF_GPU_LAYERS` («0-19», «0,2,4», «0-9,30-39») once.
422/// None = no restriction (all layers on GPU). Garbage → also no restriction.
423fn layer_ranges() -> &'static Option<Vec<(i64, i64)>> {
424    static R: OnceLock<Option<Vec<(i64, i64)>>> = OnceLock::new();
425    R.get_or_init(|| {
426        let s = std::env::var("CMF_GPU_LAYERS").ok()?;
427        let mut v = Vec::new();
428        for part in s.split(',') {
429            let part = part.trim();
430            match part.split_once('-') {
431                Some((a, b)) => v.push((a.trim().parse().ok()?, b.trim().parse().ok()?)),
432                None => {
433                    let x: i64 = part.parse().ok()?;
434                    v.push((x, x));
435                }
436            }
437        }
438        Some(v)
439    })
440}
441
442fn layer_allowed() -> bool {
443    match layer_ranges() {
444        None => true,
445        Some(ranges) => {
446            let cur = CUR_LAYER.with(|c| c.get());
447            cur < 0 || ranges.iter().any(|(a, b)| cur >= *a && cur <= *b)
448        }
449    }
450}
451
452/// GPU allowed FOR THE CURRENT LAYER: backend is initialized AND the layer
453/// falls within `CMF_GPU_LAYERS` (GPU/CPU layer-split) AND we are not
454/// inside a `cpu_scope`. Op gates call this.
455pub fn enabled_here() -> bool {
456    !CPU_ONLY.with(|c| c.get()) && enabled() && layer_allowed()
457}
458
459/// Descriptor-aware q2tp Vulkan kernels are kept behind an explicit opt-in
460/// until the Prism full-graph/resident-weight path has a coherent generation
461/// gate.  `CMF_GPU=1` alone must not silently turn synchronous per-op
462/// readbacks into the default model path; callers and validation tests can
463/// request the measured kernels with `CMF_Q2TP_GPU=1`.
464pub fn q2tp_gpu_opt_in() -> bool {
465    std::env::var("CMF_Q2TP_GPU").as_deref() == Ok("1")
466}
467
468// ── Runtime GPU-vs-CPU probe ────────────────────────────────────────────
469// CMF_GPU=1 does not TRUST that the device wins — it MEASURES. For each
470// op class the first calls alternate arms: GPU timed vs pure-CPU timed
471// (under cpu_scope). Cold GPU calls (weight upload / cache fill) are
472// discarded; after PROBE_SAMPLES clean samples per arm the faster arm is
473// chosen for the rest of the process. Rationale: submit+poll latency
474// differs by an order of magnitude across driver stacks (Metal/PCIe
475// ~3-4 ms, Vulkan/4090 ~0.3 ms) — a static threshold cannot know whether
476// per-op offload pays off HERE. CMF_GPU_PROBE=0 → always trust the GPU.
477
478/// GPU-eligible op classes, each with an independent probe.
479#[derive(Clone, Copy)]
480pub enum OpClass {
481    /// Whole FFN chain in one submission (dense / MoE block).
482    Ffn = 0,
483    /// Large hybrid CPU∥GPU matvec (lm_head class).
484    Matvec = 1,
485    /// Prefill GEMM (matmat).
486    Matmat = 2,
487    /// Batched matvecs of one input (QKV).
488    Batch = 3,
489    /// Prefill GEMM at image-diffusion widths (b ≥ 128). Probed apart
490    /// from `Matmat`: one imagegen process runs BOTH populations
491    /// (prompt encode b≈40 where the GPU wins big, DiT b≥256 where
492    /// the CPU AMX arm is competitive) — a single shared verdict locks
493    /// the wrong arm for whichever population samples second.
494    MatmatWide = 4,
495    /// The lm_head itself, apart from the merely-large matvecs. Same
496    /// reasoning as `MatmatWide`, and DeepSeek-V4 is where it bit: its
497    /// attention projections are 37M weights and its head is 529M, so
498    /// the projections' verdict — CPU, honestly measured at 0.19 ms —
499    /// decided for a matvec fourteen times their size that took 11 ms
500    /// a token on the host.
501    MatvecHead = 5,
502    /// The blocked f32 GEMM (`fcd_ops::gemm_nt`): attention's QKᵀ and
503    /// AV, and the VAE decoders' projections. It used to take every job
504    /// over 4 M MACs on sight, with no CPU arm to lose to — which on
505    /// the MiniMax-H3 video decoder was three times SLOWER than the
506    /// host it displaced. Its population is per-head slices, nothing
507    /// like the weight GEMMs above, so it probes on its own.
508    GemmNt = 6,
509    /// A host-routed MoE block. Kept separate from [`Self::Ffn`] because
510    /// its selected-weight pager has different memory and latency costs.
511    Moe = 7,
512}
513
514/// Which probe a large matvec belongs to. The head is an order of
515/// magnitude bigger than anything else that reaches this gate, and the
516/// two populations do not have the same answer.
517pub fn matvec_class(rows: usize, cols: usize) -> OpClass {
518    if rows * cols >= 67_108_864 {
519        OpClass::MatvecHead
520    } else {
521        OpClass::Matvec
522    }
523}
524
525/// Probe verdict for one call.
526pub enum ProbeArm {
527    /// Run the GPU path (during probing: timed, recorded).
528    Gpu,
529    /// Probing: run the CPU path under `cpu_scope`, timed, recorded.
530    CpuTimed,
531    /// Decided: CPU won — run the CPU path (under `cpu_scope`).
532    Cpu,
533}
534
535/// Clean samples per arm before a class decides.
536const PROBE_SAMPLES: u32 = 6;
537
538/// Declines before a class gives the work to the host for good. High
539/// enough that a transient refusal — an unsealed state during prefill, a
540/// shape the kernel skips this once — cannot settle the question.
541const PROBE_DECLINE_LIMIT: u32 = 16;
542
543/// Device samples discarded before any count — see `Probe::gpu_burn`.
544const PROBE_WARMUP: u32 = 1;
545
546struct Probe {
547    /// 0 = probing, 1 = GPU won, 2 = CPU won.
548    state: AtomicU8,
549    flip: AtomicU32,
550    gpu_ns: AtomicU64,
551    gpu_n: AtomicU32,
552    /// Times the device arm was chosen and the device DECLINED.
553    ///
554    /// A decline carries no timing, so nothing is recorded — and a class
555    /// whose device path always refuses therefore never reaches a
556    /// verdict, alternates arms forever, and pays a failed device
557    /// attempt on half of every token's calls. Measured on an M4 with
558    /// LFM2.5-2.6B: `ffn` was still undecided after 9000 calls, and a
559    /// token cost 83.55 ms against 41.85 with the device off — twice the
560    /// price for work the host did anyway.
561    declines: AtomicU32,
562    /// GPU samples still to discard as warm-up.
563    ///
564    /// The cold flag catches buffer and weight uploads, but a compute
565    /// pipeline is compiled on first use and not every creation site
566    /// raises it — the wgpu path has 21 pipeline creations against 12
567    /// cold notes. One uncaught shader compile is enough to lose a
568    /// class for the whole process: `gemm-nt` on an A100 was recorded at
569    /// 117.01 ms against the host's 3.19 and sent to the CPU, which
570    /// parked a 27B bake on 2.6 cores with the card idle. The decision
571    /// already uses each arm's BEST sample, so discarding the first
572    /// GPU sample costs one extra round trip and removes the whole
573    /// class of first-call artefacts.
574    gpu_burn: AtomicU32,
575    cpu_ns: AtomicU64,
576    cpu_n: AtomicU32,
577    /// Best (minimum) sample per arm. The DECISION compares these:
578    /// means are poisoned by one-off cold costs the cold-flag cannot
579    /// see — e.g. the CPU arm's first mmap-cold expert matvec page
580    /// faults its weights in and reads 3× its steady state, which
581    /// locked the GPU arm on a 35B MoE at a 4× real-world loss. The
582    /// minimum is each arm's honest steady-state pace.
583    gpu_min: AtomicU64,
584    cpu_min: AtomicU64,
585}
586
587impl Probe {
588    const fn new() -> Self {
589        Self {
590            state: AtomicU8::new(0),
591            flip: AtomicU32::new(0),
592            gpu_ns: AtomicU64::new(0),
593            gpu_n: AtomicU32::new(0),
594            declines: AtomicU32::new(0),
595            gpu_burn: AtomicU32::new(PROBE_WARMUP),
596            cpu_ns: AtomicU64::new(0),
597            cpu_n: AtomicU32::new(0),
598            gpu_min: AtomicU64::new(u64::MAX),
599            cpu_min: AtomicU64::new(u64::MAX),
600        }
601    }
602}
603
604static PROBES: [Probe; 8] = [
605    Probe::new(),
606    Probe::new(),
607    Probe::new(),
608    Probe::new(),
609    Probe::new(),
610    Probe::new(),
611    Probe::new(),
612    Probe::new(),
613];
614
615/// A caller that knows its loop is long, uniform and warm can say so: the
616/// probe times ops in isolation and alternates arms to do it, which reads a
617/// sustained diffusion step as slower on the device than it is. Measured on
618/// an M4 at 672 video tokens: the probe picked the CPU at 1.25 ms against
619/// 0.88 ms per op, and the loop it picked for ran 23.9 s a step against the
620/// device's 19.7 s.
621static TRUST_GPU: AtomicBool = AtomicBool::new(false);
622
623/// Take the probe out of the loop until the guard drops.
624pub fn trust_gpu() -> GpuTrust {
625    let was = TRUST_GPU.swap(true, Ordering::Relaxed);
626    GpuTrust(was)
627}
628
629pub struct GpuTrust(bool);
630
631impl Drop for GpuTrust {
632    fn drop(&mut self) {
633        TRUST_GPU.store(self.0, Ordering::Relaxed);
634    }
635}
636
637fn probe_on_for(c: OpClass) -> bool {
638    // The trust is only for the *wide* class. A sustained diffusion step is
639    // where the probe reads a warm device as cold; the narrow batches inside
640    // the same loop — an audio stream of fifty-one tokens against the same
641    // weights — are small enough that submit latency can genuinely beat the
642    // arithmetic, and there the probe is right and should keep deciding.
643    if TRUST_GPU.load(Ordering::Relaxed) && matches!(c, OpClass::MatmatWide | OpClass::Ffn) {
644        return false;
645    }
646    probe_on()
647}
648
649/// Is the per-op GPU/CPU probe enabled (`CMF_GPU_PROBE`, default on)?
650/// The native Metal decode route never consults it — `q1_force` routes
651/// the token graph to the device outright — so it is reported, not used.
652pub fn probe_enabled() -> bool {
653    probe_on()
654}
655
656fn probe_on() -> bool {
657    static ON: OnceLock<bool> = OnceLock::new();
658    *ON.get_or_init(|| {
659        std::env::var("CMF_GPU_PROBE")
660            .map(|v| v != "0" && v != "off")
661            .unwrap_or(true)
662    })
663}
664
665/// q1 ops on the native Metal backend skip the probe entirely: the CPU
666/// q1 kernel is load-port-bound, the GPU one wins warm — and probe
667/// alternation itself cools the device between samples (measured: block
668/// times 5.8 ms warm vs 8.8 ms mixed). Other backends keep probing.
669pub fn q1_force() -> bool {
670    #[cfg(target_os = "macos")]
671    {
672        backend() == Backend::Metal
673    }
674    #[cfg(not(target_os = "macos"))]
675    {
676        false
677    }
678}
679
680/// Should a FUSED whole-block path trust the device instead of asking
681/// the per-op probe? True on native Metal and on discrete wgpu adapters.
682///
683/// The probe answers "is one wide matmat faster on the GPU", and for the
684/// DiT on Metal that is a coin flip — measured 2.62 ms GPU vs 2.56 ms
685/// CPU, a 2% spread that lands on either arm run to run. But the fused
686/// block's advantage is not per-op speed, it is that the hidden state,
687/// the packs and the attention panels never leave the device: end to end
688/// the whole-block path renders a 512² Lumina step in ~5.4 s against
689/// ~8.4 s when the probe happens to pick the CPU. Gating a fusion win on
690/// a per-op tie made every second render half-speed at random.
691///
692/// On a discrete card the verdict is never in doubt — an RTX 3090 against
693/// a 256-core EPYC measured 11.5 ms vs 31 ms per wide op, four runs out
694/// of four — so the probe's sampling phase is pure cost: it alone was 10%
695/// of a 512² render (74.3 s against 66.9 s with the probe off). Integrated
696/// and mobile adapters keep probing; there the submit latency is real and
697/// can genuinely lose.
698pub fn fused_block_trusted() -> bool {
699    #[cfg(target_os = "macos")]
700    if backend() == Backend::Metal {
701        return true;
702    }
703    wgpu_graph_default()
704}
705
706/// Which arm should this GPU-eligible call take? Consult AFTER the
707/// eligibility gates (`enabled_here` / `min_rows`) so only real
708/// candidates alternate.
709/// While a class is still probing, a call whose weights are NOT yet on
710/// the card should take the GPU arm anyway: the upload is work the next
711/// step needs regardless, and the sample it produces is discarded as
712/// cold — so handing that call to the CPU arm buys nothing and costs a
713/// host GEMM. Measured on a diffusion stack, where every layer is
714/// touched once per step and therefore EVERY first-step GPU sample is
715/// cold: one projection drew the CPU arm for the whole first step, 9.8 s
716/// against the 2.8 s it costs once the weights are warm.
717pub fn weight_is_resident(model: &Arc<CmfModel>, idx: usize) -> bool {
718    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
719    {
720        return crate::gpu_wgpu::weight_is_resident(model, idx);
721    }
722    #[cfg(not(all(feature = "gpu", not(target_os = "macos"))))]
723    {
724        let _ = (model, idx);
725        true
726    }
727}
728
729pub fn probe_arm_cold_prefers_gpu(c: OpClass, weights_resident: bool) -> ProbeArm {
730    if !weights_resident && probe_deciding(c) {
731        return ProbeArm::Gpu;
732    }
733    probe_arm(c)
734}
735
736pub fn probe_arm(c: OpClass) -> ProbeArm {
737    // Every arbitrated call starts with a clean cold flag: both the
738    // sample discard in `probe_record` and the contention kill-switch
739    // read it AFTER the op, so a stale note from a previous call on
740    // this thread must not leak in.
741    PROBE_COLD.with(|f| f.set(false));
742    if !probe_on_for(c) {
743        return ProbeArm::Gpu;
744    }
745    probe_cache_load();
746    let p = &PROBES[c as usize];
747    match p.state.load(Ordering::Relaxed) {
748        1 => ProbeArm::Gpu,
749        2 => ProbeArm::Cpu,
750        _ => {
751            if p.flip.fetch_add(1, Ordering::Relaxed) % 2 == 0 {
752                ProbeArm::Gpu
753            } else {
754                ProbeArm::CpuTimed
755            }
756        }
757    }
758}
759
760/// The device arm was chosen and the device refused the work, so there
761/// is no time to record. Callers that fall through to the host MUST say
762/// so here, or the class can never decide.
763pub fn probe_note_decline(c: OpClass) {
764    let p = &PROBES[c as usize];
765    if p.state.load(Ordering::Relaxed) != 0 {
766        return;
767    }
768    let n = p.declines.fetch_add(1, Ordering::Relaxed) + 1;
769    if n >= PROBE_DECLINE_LIMIT
770        && p.state
771            .compare_exchange(0, 2, Ordering::Relaxed, Ordering::Relaxed)
772            .is_ok()
773    {
774        tracing::info!(
775            "gpu probe [{}]: device declined {n} times → cpu",
776            CLASS_NAMES[c as usize]
777        );
778    }
779}
780
781/// Record a timed arm sample; on the `PROBE_SAMPLES`-th clean sample of
782/// BOTH arms the class decides for the rest of the process.
783pub fn probe_record(c: OpClass, gpu: bool, dur: std::time::Duration) {
784    probe_record_into(
785        &PROBES[c as usize],
786        CLASS_NAMES[c as usize],
787        Some(c),
788        gpu,
789        dur,
790    )
791}
792
793/// The body of `probe_record` over ONE probe, so the decision can be
794/// driven in a test without touching the process-wide array.
795fn probe_record_into(
796    p: &Probe,
797    class_name: &str,
798    cache: Option<OpClass>,
799    gpu: bool,
800    dur: std::time::Duration,
801) {
802    if p.state.load(Ordering::Relaxed) != 0 {
803        return;
804    }
805    if gpu && PROBE_COLD.with(|f| f.replace(false)) {
806        return; // one-off cost in this call — not a steady-state sample
807    }
808    if gpu {
809        // Load-then-store rather than fetch_sub: a blind decrement at
810        // zero wraps a u32 to its maximum and mutes the arm forever.
811        // A benign race here burns one extra sample, which is free.
812        let left = p.gpu_burn.load(Ordering::Relaxed);
813        if left > 0 {
814            p.gpu_burn.store(left - 1, Ordering::Relaxed);
815            return; // warm-up: the first device sample builds its pipeline
816        }
817    }
818    let ns = dur.as_nanos().min(u64::MAX as u128) as u64;
819    if gpu {
820        p.gpu_ns.fetch_add(ns, Ordering::Relaxed);
821        p.gpu_n.fetch_add(1, Ordering::Relaxed);
822        p.gpu_min.fetch_min(ns, Ordering::Relaxed);
823    } else {
824        p.cpu_ns.fetch_add(ns, Ordering::Relaxed);
825        p.cpu_n.fetch_add(1, Ordering::Relaxed);
826        p.cpu_min.fetch_min(ns, Ordering::Relaxed);
827    }
828    let (gn, cn) = (
829        p.gpu_n.load(Ordering::Relaxed),
830        p.cpu_n.load(Ordering::Relaxed),
831    );
832    if gn >= 2 && cn >= 2 {
833        // Decide on each arm's BEST sample — the steady-state pace.
834        // Means carry one-off cold costs (mmap page-in on the CPU arm)
835        // that the cold-flag machinery cannot see.
836        let g = p.gpu_min.load(Ordering::Relaxed) as f64;
837        let cp = p.cpu_min.load(Ordering::Relaxed) as f64;
838        // Early verdict on a ≥2× gap — no reason to keep feeding the
839        // losing arm; close races take the full sample count. It was 3×,
840        // and the cost of that half-octave was measured: a DiT whose
841        // wide GEMMs run 11.4 ms on the device against 32.2 on the host
842        // (2.8×) kept ALTERNATING through the whole diffusion stack, and
843        // because the alternation counter is shared per class in call
844        // order, one projection drew the CPU arm every single time — 9.9
845        // seconds a step on a kernel that needs 0.4. Both arms are
846        // compared on their BEST sample, so a 2× gap is not noise.
847        if (gn < PROBE_SAMPLES || cn < PROBE_SAMPLES) && g < cp * 2.0 && cp < g * 2.0 {
848            return;
849        }
850        let winner = if g <= cp { 1 } else { 2 };
851        if p.state
852            .compare_exchange(0, winner, Ordering::Relaxed, Ordering::Relaxed)
853            .is_ok()
854        {
855            tracing::info!(
856                "gpu probe [{}]: gpu {:.2} ms vs cpu {:.2} ms per op → {}",
857                class_name,
858                g / 1e6,
859                cp / 1e6,
860                if winner == 1 { "gpu" } else { "cpu" },
861            );
862            if let Some(c) = cache {
863                probe_cache_store(c, winner);
864            }
865        }
866    }
867}
868
869/// Is the class still collecting samples? (Call sites use this to route
870/// cold-weight calls away from the GPU arm during probing.)
871pub fn probe_deciding(c: OpClass) -> bool {
872    probe_on_for(c) && PROBES[c as usize].state.load(Ordering::Relaxed) == 0
873}
874
875/// Probing helper: true — tensor `idx`'s quant weights are ALREADY
876/// device-resident (a clean GPU sample is possible now); false — they
877/// were not (the upload starts within the VRAM budget, so a later call
878/// finds them warm) or the tensor cannot go to the GPU at all. Keeps the
879/// probe from billing a full cold dispatch+readback to a sample it will
880/// discard anyway. The verdict needs only a couple of warm tensors, so
881/// probe-driven uploads are capped — the losing-GPU machine should not
882/// pay for uploading the whole layer stack it will never use; if the GPU
883/// wins, the rest uploads lazily on demand, in the same first-touch order.
884#[allow(unused_variables)]
885pub fn q8_resident_or_upload(model: &Arc<CmfModel>, idx: usize) -> bool {
886    static PROBE_UPLOADS: AtomicU32 = AtomicU32::new(0);
887    let may_upload = PROBE_UPLOADS.load(Ordering::Relaxed) < 4;
888    let resident = match backend() {
889        #[cfg(target_os = "macos")]
890        Backend::Metal => crate::gpu_metal::q8_resident_or_upload(model, idx, may_upload),
891        #[cfg(feature = "gpu")]
892        Backend::Wgpu => crate::gpu_wgpu::q8_resident_or_upload(model, idx, may_upload),
893        Backend::None => false,
894    };
895    if !resident && may_upload {
896        PROBE_UPLOADS.fetch_add(1, Ordering::Relaxed);
897    }
898    resident
899}
900
901/// Test hook: reset all probes to the undecided state.
902#[cfg(test)]
903pub(crate) fn probe_reset() {
904    for p in &PROBES {
905        p.state.store(0, Ordering::Relaxed);
906        p.flip.store(0, Ordering::Relaxed);
907        p.gpu_ns.store(0, Ordering::Relaxed);
908        p.gpu_n.store(0, Ordering::Relaxed);
909        p.cpu_ns.store(0, Ordering::Relaxed);
910        p.cpu_n.store(0, Ordering::Relaxed);
911    }
912}
913
914/// The probe table is process-global by design, while these unit tests reset
915/// and seed selected entries to exercise arbitration. Keep only those tests
916/// out of each other's way; production callers still probe concurrently.
917#[cfg(test)]
918static PROBE_TEST_LOCK: std::sync::Mutex<()> = std::sync::Mutex::new(());
919
920#[cfg(test)]
921fn probe_test_guard() -> std::sync::MutexGuard<'static, ()> {
922    PROBE_TEST_LOCK
923        .lock()
924        .unwrap_or_else(std::sync::PoisonError::into_inner)
925}
926
927#[cfg(test)]
928mod probe_tests {
929    use super::*;
930    use std::time::Duration;
931
932    #[test]
933    fn cpu_only_whole_operator_dispatch_inherits_and_restores_scope() {
934        let pool = crate::pool::Pool::with_spin(3, 0);
935        cpu_scope(|| {
936            let inherit = inherit_cpu_scope();
937            pool.run_rows(64, &|_, _| {
938                let _guard = inherit();
939                assert!(CPU_ONLY.get());
940            });
941        });
942        pool.run_rows(64, &|_, _| assert!(!CPU_ONLY.get()));
943    }
944
945    // One test fn: PROBES is process-global and probe_reset touches all
946    // classes — parallel test threads would race.
947    #[test]
948    fn probe_alternates_discards_cold_and_decides() {
949        let _probe_guard = probe_test_guard();
950        probe_reset();
951        // Probing: arms alternate.
952        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::Gpu));
953        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::CpuTimed));
954
955        // A cold GPU sample (upload noted) must be discarded: feed a
956        // catastrophic cold sample, then clean fast-GPU samples — GPU
957        // wins only if the cold one did not count.
958        probe_note_cold();
959        probe_record(OpClass::Ffn, true, Duration::from_secs(1000));
960        for _ in 0..PROBE_SAMPLES {
961            probe_record(OpClass::Ffn, true, Duration::from_millis(1));
962            probe_record(OpClass::Ffn, false, Duration::from_millis(4));
963        }
964        assert!(matches!(probe_arm(OpClass::Ffn), ProbeArm::Gpu));
965
966        // The reverse: a class where the CPU arm is faster decides CPU.
967        for _ in 0..PROBE_SAMPLES {
968            probe_record(OpClass::Matmat, true, Duration::from_millis(4));
969            probe_record(OpClass::Matmat, false, Duration::from_millis(1));
970        }
971        assert!(matches!(probe_arm(OpClass::Matmat), ProbeArm::Cpu));
972
973        // cpu_scope: gates off inside, restored after.
974        cpu_scope(|| CPU_ONLY.with(|c| assert!(c.get())));
975        CPU_ONLY.with(|c| assert!(!c.get()));
976        cpu_scope(|| {
977            cpu_scope(|| CPU_ONLY.with(|c| assert!(c.get())));
978            CPU_ONLY.with(|c| assert!(c.get()));
979        });
980        let _ = std::panic::catch_unwind(|| cpu_scope(|| panic!("scope test")));
981        CPU_ONLY.with(|c| assert!(!c.get()));
982        probe_reset();
983    }
984
985    #[test]
986    fn a_remembered_verdict_is_adopted_and_a_stranger_is_not() {
987        let _probe_guard = probe_test_guard();
988        // Probing is not free: on a Snapdragon 778G the deciding classes
989        // cost minutes of wall clock before the first token, every
990        // process, and reached the same verdict every time. The cache
991        // exists so that price is paid once.
992        //
993        // The key is built from THIS process's device, never a name this
994        // test sets: `probe_set_device` is first-writer-wins and on a Mac
995        // the Metal backend may already have named the silicon before the
996        // tests run — which is exactly how this test failed on CI while
997        // passing locally. GemmNt on purpose: the arbitration test never
998        // touches it, and both run in one process.
999        let mine = probe_cache_key_named("gemm-nt");
1000        let state = || {
1001            PROBES[OpClass::GemmNt as usize]
1002                .state
1003                .load(Ordering::Relaxed)
1004        };
1005
1006        // Another device's verdict is not mine, whatever it claims.
1007        probe_cache_adopt("SomeOtherGPU/Vulkan\tgemm-nt\tgpu\n");
1008        assert_eq!(state(), 0);
1009        // Neither is one from another build of this engine.
1010        let older = mine.replacen(env!("CARGO_PKG_VERSION"), "0.0.0-old", 1);
1011        assert_ne!(older, mine);
1012        probe_cache_adopt(&format!("{older}\tgpu\n"));
1013        assert_eq!(state(), 0);
1014        // Mine is.
1015        probe_cache_adopt(&format!("{mine}\tcpu\n"));
1016        assert_eq!(state(), 2);
1017
1018        PROBES[OpClass::GemmNt as usize]
1019            .state
1020            .store(0, Ordering::Relaxed);
1021    }
1022}
1023
1024/// Default row threshold: the GPU takes only larger matrices (lm_head
1025/// class). Below it, the dispatch/readback cost does not pay off on unified memory.
1026pub const GPU_MIN_ROWS: usize = 65_536;
1027
1028/// Effective threshold: `CMF_GPU_MIN_ROWS` overrides. Defaults differ
1029/// by device class: on a DISCRETE card VRAM bandwidth pays off even for
1030/// FFN/QKV-class matrices (4096), on unified memory only lm_head-class
1031/// is worth the dispatch/readback (65536). Field case behind this: a
1032/// 35B model on an RTX 4090 saw ~0 offload because every layer matrix
1033/// sat below the old universal 65536.
1034pub fn min_rows() -> usize {
1035    if let Some(v) = std::env::var("CMF_GPU_MIN_ROWS")
1036        .ok()
1037        .and_then(|v| v.parse().ok())
1038    {
1039        return v;
1040    }
1041    if discrete() { 4096 } else { GPU_MIN_ROWS }
1042}
1043
1044/// Is the active backend a discrete card (PCIe VRAM)?
1045pub fn discrete() -> bool {
1046    match backend() {
1047        #[cfg(feature = "gpu")]
1048        Backend::Wgpu => crate::gpu_wgpu::is_discrete(),
1049        #[cfg(target_os = "macos")]
1050        Backend::Metal => false, // UMA by the init() guard
1051        Backend::None => false,
1052    }
1053}
1054
1055/// A single MoE-FFN job (an expert with its own weight), executed in one
1056/// submission: (rows, cols, idx, row_scale) for gate/up/down + prescaled
1057/// inputs + the down column scale + the blending weight.
1058pub struct MoeJob<'a> {
1059    pub gate: (usize, usize, usize, &'a [f32]),
1060    pub up: (usize, usize, usize, &'a [f32]),
1061    pub down: (usize, usize, usize, &'a [f32]),
1062    pub xs_gate: Vec<f32>,
1063    pub xs_up: Vec<f32>,
1064    pub down_col: &'a [f32],
1065    pub w: f32,
1066    /// q1 trio: scales live inside the 6-byte tiles (row_scale slices
1067    /// empty, xs raw f32). Backends without a q1 kernel refuse the job.
1068    pub q1: bool,
1069    /// q4_tiled trio: scales inside the 18-byte tiles (row_scale
1070    /// slices empty, xs raw f32) — the MoE-hybrid coder class.
1071    pub q4t: bool,
1072    /// q4tp trio: same raw-xs contract, 16-byte nibble stride and the scale
1073    /// on a per-row ladder. Without this the experts of a q4tp MoE model fall
1074    /// to the CPU while every other dtype rides the device.
1075    pub q4tp: bool,
1076    /// Mixed 2-bit profile: gate/up are q2tp (8-byte chunks, zero rung),
1077    /// down stays q4tp. Set together with `q4tp`; a backend without the
1078    /// 2-bit kernel must refuse the whole job.
1079    pub gu_q2: bool,
1080    /// The reference's `swiglu_limit`; 0 disables the clamp. A backend that
1081    /// cannot apply it must REFUSE the job rather than drop it silently —
1082    /// the difference only shows on saturating activations, which is the
1083    /// hardest kind of divergence to notice.
1084    pub swiglu_limit: f32,
1085    /// `GraphAct::code` of act(gate)·up: 0 SiLU (every MoE expert), 1 exact
1086    /// GELU, 2 tanh-GELU (a Gemma dense FFN riding the single-job block).
1087    /// A backend without the activation must refuse the job.
1088    pub act: u32,
1089}
1090
1091/// A single independent batch matvec (GDN projections of one input).
1092pub struct BatchJob<'a> {
1093    pub idx: usize,
1094    pub rows: usize,
1095    pub cols: usize,
1096    pub row_scale: &'a [f32],
1097    pub xs: Vec<f32>,
1098    /// Weight layout. Was a bare `q1: bool`, which could only ever spell two
1099    /// of the four and silently sent everything else back to the CPU — the
1100    /// GDN projections of a q4t/q4tp model never reached the device at all.
1101    pub layout: BatchLayout,
1102}
1103
1104/// Which kernel a batched matvec needs. q8 carries row scales in a side
1105/// buffer; the rest embed them in the payload and differ in stride.
1106#[derive(Clone, Copy, PartialEq, Eq, Debug)]
1107pub enum BatchLayout {
1108    Q8,
1109    Q1,
1110    /// q1g: sign + scale planes, one scale per 128 (q1's raw-xs contract).
1111    Q1g,
1112    Q4t,
1113    Q4tp,
1114}
1115
1116#[derive(Clone, Copy, PartialEq, Eq)]
1117enum Backend {
1118    None,
1119    #[cfg(target_os = "macos")]
1120    Metal,
1121    #[cfg(feature = "gpu")]
1122    Wgpu,
1123}
1124
1125fn backend() -> Backend {
1126    #[cfg(feature = "gpu")]
1127    if crate::gpu_wgpu::selected() {
1128        return if crate::gpu_wgpu::enabled() {
1129            Backend::Wgpu
1130        } else {
1131            Backend::None
1132        };
1133    }
1134    #[cfg(target_os = "macos")]
1135    if crate::gpu_metal::enabled() {
1136        return Backend::Metal;
1137    }
1138    Backend::None
1139}
1140
1141/// GPU enabled and initialized on the selected backend?
1142/// Whether THIS build can bring a GPU up on THIS device: a compiled-in
1143/// backend plus a live adapter. The mobile FFI exposes it so an app can
1144/// tell "GPU off" from "GPU impossible" (a CPU-only .so ships no
1145/// backend at all). Cached after the first call.
1146pub fn backend_available() -> bool {
1147    #[cfg(target_os = "macos")]
1148    {
1149        // The Metal path is always compiled on macOS.
1150        true
1151    }
1152    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
1153    {
1154        static AVAIL: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
1155        *AVAIL.get_or_init(crate::gpu_wgpu::adapter_probe)
1156    }
1157    #[cfg(all(not(feature = "gpu"), not(target_os = "macos")))]
1158    {
1159        false
1160    }
1161}
1162
1163/// A process-wide, phase-scoped GPU gate. `cpu_scope` is thread-local and
1164/// the pool's workers do not inherit it, so a caller that wants a whole
1165/// *phase* off the device — a prompt encoder whose weights live in a part of
1166/// the file the hot loop never touches, on a machine that cannot keep both
1167/// wired — has to say so globally.
1168static GPU_PAUSED: AtomicBool = AtomicBool::new(false);
1169
1170/// Park the device for every thread until the returned guard drops.
1171pub fn pause_gpu() -> GpuPause {
1172    GPU_PAUSED.store(true, Ordering::Relaxed);
1173    GpuPause(())
1174}
1175
1176pub struct GpuPause(());
1177
1178impl Drop for GpuPause {
1179    fn drop(&mut self) {
1180        GPU_PAUSED.store(false, Ordering::Relaxed);
1181    }
1182}
1183
1184pub fn enabled() -> bool {
1185    !GPU_PAUSED.load(Ordering::Relaxed) && backend() != Backend::None
1186}
1187
1188/// Default-on condition for the wgpu whole-token graph: the wgpu
1189/// backend on a DISCRETE adapter. NOT plain `enabled()` (macOS/Metal
1190/// must not pay a per-token layer scan for a graph its backend
1191/// refuses), and NOT integrated adapters: the graph's ~300 barriered
1192/// dispatches per token are cheap on desktop immediate-mode GPUs but
1193/// tiled mobile GPUs (Adreno/Mali) drain the pipeline at every barrier
1194/// — field report: 0.2 tok/s on-graph vs 15 tok/s on the CPU. On
1195/// integrated adapters the per-op probe path arbitrates each op class
1196/// against the CPU instead; CMF_GPU_WGPU_GRAPH=1 still forces the
1197/// graph anywhere.
1198/// Is the wgpu backend active at all (any adapter)? Eligibility gate
1199/// for the whole-token graph — whether it actually RUNS is decided by
1200/// `wgpu_graph_default` (trusted on discrete) or the generation race.
1201pub fn wgpu_active() -> bool {
1202    #[cfg(feature = "gpu")]
1203    {
1204        matches!(backend(), Backend::Wgpu)
1205    }
1206    #[cfg(not(feature = "gpu"))]
1207    {
1208        false
1209    }
1210}
1211
1212/// Which GPU this thread's engine calls address. Multi-card hosts hold
1213/// one wgpu context PER card (weights, KV mirrors and scratch live
1214/// inside a context, so per-device contexts give per-device caches for
1215/// free); this thread-local says which one is current. Default: the
1216/// process pin (CMF_GPU_ADAPTER) or 0 — so single-card runs behave
1217/// exactly as they always have.
1218pub fn default_device() -> usize {
1219    static D: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
1220    *D.get_or_init(|| {
1221        std::env::var("CMF_GPU_ADAPTER")
1222            .ok()
1223            .and_then(|v| v.trim().parse::<usize>().ok())
1224            .unwrap_or(0)
1225    })
1226}
1227
1228thread_local! {
1229    static CUR_DEV: std::cell::Cell<Option<usize>> = const { std::cell::Cell::new(None) };
1230}
1231
1232/// The device this thread is pinned to.
1233pub fn current_device() -> usize {
1234    CUR_DEV.with(|c| c.get()).unwrap_or_else(default_device)
1235}
1236
1237/// Pin this thread to a device. Server slots call it once per request;
1238/// the worker pool propagates it into its threads, so a dispatch begun
1239/// on card 1 does not finish on card 0.
1240pub fn set_current_device(i: usize) {
1241    CUR_DEV.with(|c| c.set(Some(i)));
1242}
1243
1244/// Run `f` with this thread pinned to `dev`, restoring the previous pin.
1245pub fn with_device<R>(dev: usize, f: impl FnOnce() -> R) -> R {
1246    let prev = CUR_DEV.with(|c| c.replace(Some(dev)));
1247    let r = f();
1248    CUR_DEV.with(|c| c.set(prev));
1249    r
1250}
1251
1252/// How many GPUs this process can address (wgpu adapter count; 1 on
1253/// Metal, 0 without a backend).
1254pub fn device_count() -> usize {
1255    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
1256    {
1257        return crate::gpu_wgpu::adapter_count();
1258    }
1259    #[cfg(not(all(feature = "gpu", not(target_os = "macos"))))]
1260    {
1261        usize::from(backend_available())
1262    }
1263}
1264
1265/// Weight budget of the current GPU in bytes; 0 when there is none and
1266/// u64::MAX on unified memory (where the OS pages shared RAM and the
1267/// question "does the model fit the card" has no separate answer).
1268pub fn vram_budget() -> u64 {
1269    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
1270    {
1271        return crate::gpu_wgpu::device_vram_budget();
1272    }
1273    #[cfg(not(all(feature = "gpu", not(target_os = "macos"))))]
1274    {
1275        if backend_available() { u64::MAX } else { 0 }
1276    }
1277}
1278
1279/// Bytes currently accounted as resident weight buffers on the active wgpu
1280/// adapter.  This is the logical device-local weight set; physical driver
1281/// allocations are reported separately by the platform tools.
1282pub fn resident_bytes() -> u64 {
1283    #[cfg(feature = "gpu")]
1284    {
1285        if backend() == Backend::Wgpu {
1286            return crate::gpu_wgpu::resident_bytes();
1287        }
1288    }
1289    0
1290}
1291
1292/// Sealed O(1) device mirror count and logical bytes for one pipeline id.
1293/// Zero is returned when wgpu is unavailable or the sequence has not reached
1294/// an O(1) seal yet.
1295pub fn o1_device_stats(kv_id: u64) -> (usize, u64) {
1296    #[cfg(feature = "gpu")]
1297    {
1298        if backend() == Backend::Wgpu {
1299            return crate::gpu_wgpu::o1_device_stats(kv_id);
1300        }
1301    }
1302    let _ = kv_id;
1303    (0, 0)
1304}
1305
1306/// Device weight bytes uploaded so far (wgpu; 0 on other backends).
1307/// Steady-state windows must show a ZERO delta — growth mid-benchmark
1308/// means eviction/re-upload and disqualifies the number.
1309pub fn upload_bytes() -> u64 {
1310    #[cfg(feature = "gpu")]
1311    {
1312        return crate::gpu_wgpu::UPLOAD_BYTES.load(std::sync::atomic::Ordering::Relaxed);
1313    }
1314    #[cfg(not(feature = "gpu"))]
1315    0
1316}
1317
1318/// Measure a transient host-to-device upload when the wgpu backend is
1319/// compiled in. CPU-only builds keep the benchmark command available and
1320/// report no device measurement instead of referring to the gated module.
1321pub fn upload_bandwidth_probe(block: usize, rounds: usize) -> Option<f64> {
1322    #[cfg(feature = "gpu")]
1323    {
1324        return crate::gpu_wgpu::upload_bandwidth_probe(block, rounds);
1325    }
1326    let _ = (block, rounds);
1327    None
1328}
1329
1330/// Which half of the run is asking.
1331///
1332/// The phase exists because the graph is plausibly two decisions, not
1333/// one — but on the hardware measured so far it is only ever a decode
1334/// decision. On an Adreno 642L with bonsai-1.7b, from identical clean
1335/// starts and two repeats each: decode 11.6 tok/s without it and 0.72
1336/// with, while prefill is 4.2 either way. A first reading of 3.4 -> 18.0
1337/// for prefill did not survive a controlled re-run — it was a dirty
1338/// probe cache between configurations, not the graph, and the prefill
1339/// route through the graph is GDN-only in the first place, which this
1340/// dense model never takes.
1341#[derive(Clone, Copy, PartialEq, Eq, Debug)]
1342pub enum GraphPhase {
1343    Prefill,
1344    Decode,
1345}
1346
1347/// The one place that decides whether the whole-token graph runs.
1348///
1349/// `CMF_GPU_WGPU_GRAPH`: `0` off everywhere, `prefill` only for the
1350/// prompt, anything else on everywhere. Unset: desktop-class GPUs take
1351/// it for both phases; phone-class UMA takes it for PREFILL only, which
1352/// is the measurement above rather than a guess — the per-op path keeps
1353/// decode, where it is seventeen times better.
1354pub fn wgpu_graph_on(phase: GraphPhase) -> bool {
1355    match std::env::var("CMF_GPU_WGPU_GRAPH").ok().as_deref() {
1356        Some("0") => false,
1357        Some("prefill") => phase == GraphPhase::Prefill,
1358        Some(_) => true,
1359        None => {
1360            if wgpu_graph_default() {
1361                return true;
1362            }
1363            // Integrated/mobile keeps the per-op path for BOTH phases —
1364            // unchanged, because the measurement that would have bought
1365            // prefill a graph did not reproduce. `=prefill` is there for
1366            // the device where it does; the default does not guess.
1367            let _ = phase;
1368            false
1369        }
1370    }
1371}
1372
1373pub fn wgpu_graph_default() -> bool {
1374    #[cfg(feature = "gpu")]
1375    {
1376        // Discrete cards always; Apple-silicon UMA on macOS too — desktop
1377        // -class GPUs where the graph measured ~2x the CPU on the Qwen3.6
1378        // family (M4: 13.3 tok/s against 7.3). Phone-class UMA (Android/
1379        // iOS builds) keeps the per-op probe path: tiled mobile GPUs have
1380        // turned the ~300-dispatch graph into seconds per token.
1381        matches!(backend(), Backend::Wgpu)
1382            && (crate::gpu_wgpu::discrete_active()
1383                || (cfg!(target_os = "macos") && crate::gpu_wgpu::adapter_up()))
1384    }
1385    #[cfg(not(feature = "gpu"))]
1386    {
1387        false
1388    }
1389}
1390
1391/// q8_row/q8_2f matvec, rows [row0, row0+rows). `xs` — prescaled by the column scale.
1392#[allow(clippy::too_many_arguments, unused_variables)]
1393pub fn q8_matvec_range(
1394    model: &Arc<CmfModel>,
1395    idx: usize,
1396    row0: usize,
1397    row_scale: &[f32],
1398    xs: &[f32],
1399    rows: usize,
1400    cols: usize,
1401    out: &mut [f32],
1402) -> bool {
1403    match backend() {
1404        #[cfg(target_os = "macos")]
1405        Backend::Metal => {
1406            crate::gpu_metal::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
1407        }
1408        #[cfg(feature = "gpu")]
1409        Backend::Wgpu => {
1410            crate::gpu_wgpu::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
1411        }
1412        Backend::None => false,
1413    }
1414}
1415
1416/// Decode-exact short q8_2f panel for the banked MiMo head.
1417pub(crate) fn q82_short_rows(
1418    model: &Arc<CmfModel>,
1419    idx: usize,
1420    xs: &[f32],
1421    b: usize,
1422    rows: usize,
1423    cols: usize,
1424    out: &mut [f32],
1425) -> bool {
1426    #[cfg(feature = "gpu")]
1427    if enabled_here() && backend() == Backend::Wgpu {
1428        return crate::gpu_wgpu::q82_short_rows(model, idx, xs, b, rows, cols, out);
1429    }
1430    let _ = (model, idx, xs, b, rows, cols, out);
1431    false
1432}
1433
1434/// GEMM of a prefill batch: `pre` — prescaled inputs row-major [b, cols],
1435/// out — row-major [b, rows].
1436#[allow(clippy::too_many_arguments, unused_variables)]
1437/// The two-field int8 GEMM with the column field left for the device.
1438/// wgpu only — Metal's int8 kernel takes a pre-scaled activation, so the
1439/// caller keeps that path when this returns `false`.
1440#[allow(clippy::too_many_arguments)]
1441pub fn q8_matmat_2f(
1442    model: &Arc<CmfModel>,
1443    idx: usize,
1444    row_scale: &[f32],
1445    col_field: &[f32],
1446    xs: &[f32],
1447    b: usize,
1448    rows: usize,
1449    cols: usize,
1450    out: &mut [f32],
1451) -> bool {
1452    #[allow(unreachable_patterns)]
1453    match backend() {
1454        #[cfg(feature = "gpu")]
1455        Backend::Wgpu => {
1456            crate::gpu_wgpu::q8_matmat_2f(model, idx, row_scale, col_field, xs, b, rows, cols, out)
1457        }
1458        _ => false,
1459    }
1460}
1461
1462pub fn q8_matmat(
1463    model: &Arc<CmfModel>,
1464    idx: usize,
1465    row_scale: &[f32],
1466    pre: &[f32],
1467    b: usize,
1468    rows: usize,
1469    cols: usize,
1470    out: &mut [f32],
1471) -> bool {
1472    match backend() {
1473        #[cfg(target_os = "macos")]
1474        Backend::Metal => {
1475            crate::gpu_metal::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out)
1476        }
1477        #[cfg(feature = "gpu")]
1478        Backend::Wgpu => crate::gpu_wgpu::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out),
1479        Backend::None => false,
1480    }
1481}
1482
1483/// q1 matvec: raw f32 activations, tile-embedded scales. Metal only
1484/// for now (wgpu q1 WGSL is queued); false = CPU fallback.
1485#[allow(unused_variables)]
1486pub fn q1_matvec(
1487    model: &Arc<CmfModel>,
1488    idx: usize,
1489    xs: &[f32],
1490    rows: usize,
1491    cols: usize,
1492    out: &mut [f32],
1493) -> bool {
1494    match backend() {
1495        #[cfg(target_os = "macos")]
1496        Backend::Metal => crate::gpu_metal::q1_matvec(model, idx, xs, rows, cols, out),
1497        #[cfg(feature = "gpu")]
1498        Backend::Wgpu => crate::gpu_wgpu::q1_matvec(model, idx, xs, rows, cols, out),
1499        Backend::None => false,
1500    }
1501}
1502
1503/// q1g matvec (sign + scale planes, raw f32 activations); the q1 kernel's
1504/// walk and sums, so a uniform-scale repack matches `q1_matvec` bit for
1505/// bit. false = CPU fallback.
1506#[allow(unused_variables)]
1507pub fn q1g_matvec(
1508    model: &Arc<CmfModel>,
1509    idx: usize,
1510    xs: &[f32],
1511    rows: usize,
1512    cols: usize,
1513    out: &mut [f32],
1514) -> bool {
1515    match backend() {
1516        #[cfg(target_os = "macos")]
1517        Backend::Metal => crate::gpu_metal::q1g_matvec(model, idx, xs, rows, cols, out),
1518        #[cfg(feature = "gpu")]
1519        Backend::Wgpu => crate::gpu_wgpu::q1g_matvec(model, idx, xs, rows, cols, out),
1520        Backend::None => false,
1521    }
1522}
1523
1524/// Whole attention sub-block on the wgpu token graph (drop-in for
1525/// `qwen_attention`): normed hidden in, O-projection out, resident device
1526/// K/V mirror. false = refusal / not the wgpu backend → CPU path.
1527#[allow(clippy::too_many_arguments)]
1528pub fn attn_dropin(
1529    model: &Arc<CmfModel>,
1530    kv_id: u64,
1531    layer: usize,
1532    normed: &[f32],
1533    wq_idx: usize,
1534    wk_idx: usize,
1535    wv_idx: usize,
1536    wo_idx: usize,
1537    q_norm: Option<&[f32]>,
1538    k_norm: Option<&[f32]>,
1539    late_qk_norm: bool,
1540    invf: &[f32],
1541    nh: usize,
1542    nkv: usize,
1543    hd: usize,
1544    rd: usize,
1545    hidden: usize,
1546    pos: usize,
1547    cap: usize,
1548    gemma: bool,
1549    eps: f32,
1550    cpu_k: &[Vec<f32>],
1551    cpu_v: &[Vec<f32>],
1552    out: &mut [f32],
1553) -> bool {
1554    match backend() {
1555        #[cfg(feature = "gpu")]
1556        Backend::Wgpu => crate::gpu_wgpu::attn_dropin_gpu(
1557            model, kv_id, layer, normed, wq_idx, wk_idx, wv_idx, wo_idx, q_norm, k_norm,
1558            late_qk_norm, invf, nh, nkv, hd, rd, hidden, pos, cap, gemma, eps, cpu_k, cpu_v, out,
1559        ),
1560        #[allow(unused_variables)]
1561        _ => false,
1562    }
1563}
1564
1565/// Descriptor operation attached to a graph weight.  `None` is the default
1566/// for ordinary CMF files; Prism weights are admitted only when the token
1567/// graph carries this explicit transform contract.
1568#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1569pub enum GraphPrismOp {
1570    None,
1571    Forward,
1572    InverseEmbedding,
1573}
1574
1575/// One weight in the whole-token graph: tensor idx + a codec tag (0=q8_row,
1576/// 1=q1, 2=q4_tiled, 3=q1t, 4=f32) + per-row scales (q8_row only) + the raw f32
1577/// data (kind 4 only — small unquantized projections like GDN in_proj_a/b).
1578pub struct GraphW<'a> {
1579    pub idx: usize,
1580    pub kind: u8,
1581    pub row_scale: &'a [f32],
1582    pub data: &'a [f32],
1583    pub prism: GraphPrismOp,
1584    pub affine: bool,
1585}
1586
1587/// A layer's token-mixing op: standard attention or a GDN (linear-attention)
1588/// block. The surrounding norms + SwiGLU FFN are common to both.
1589pub enum GraphAttn<'a> {
1590    Full {
1591        wq: GraphW<'a>,
1592        wk: GraphW<'a>,
1593        wv: GraphW<'a>,
1594        wo: GraphW<'a>,
1595        q_norm: Option<&'a [f32]>,
1596        k_norm: Option<&'a [f32]>,
1597        /// HunYuan dense: q/k norm after RoPE (rope-kernel flag bit 32).
1598        late_qk_norm: bool,
1599        /// (bq, bk, bv) attention biases (Qwen2). None ⇒ no bias.
1600        bias: Option<(&'a [f32], &'a [f32], &'a [f32])>,
1601        /// Qwen3.5 gated attention: wq emits 2·nh·hd (q||gate per head), the
1602        /// attention output is scaled by sigmoid(gate) before the O projection.
1603        output_gate: bool,
1604        cpu_k: &'a [Vec<f32>],
1605        cpu_v: &'a [Vec<f32>],
1606        /// Absolute position of `cpu_k`/`cpu_v` row 0
1607        /// (`LayerKvCache::base`): a sliding layer that keeps only its
1608        /// tail stores rows from there on. 0 for every untrimmed layer.
1609        cpu_base: usize,
1610        /// This layer's own attention geometry, when the model's layers do
1611        /// not share one (MiMo-V2: 4/8 KV heads, 128-wide V under 192-wide
1612        /// heads, sliding windows with learned sinks, two RoPE tables).
1613        /// None = the call-wide (nkv, hd, rd, invf), V as wide as K, full
1614        /// context and a plain softmax — the historical contract, whose
1615        /// kernels and dispatch are untouched.
1616        geom: Option<GraphAttnGeom<'a>>,
1617        /// Spark-X2.5 head-wise output gate: `self_attn.g_proj`
1618        /// `[num_heads, hidden]` against the attention's normed input; head
1619        /// h's output is scaled by sigmoid(g[h]) before the O projection.
1620        /// None = no such gate (every other model).
1621        head_gate: Option<GraphW<'a>>,
1622    },
1623    Gdn {
1624        qkv: GraphW<'a>,
1625        z: GraphW<'a>,
1626        a: GraphW<'a>,
1627        b: GraphW<'a>,
1628        out: GraphW<'a>,
1629        conv1d: &'a [f32],
1630        a_log: &'a [f32],
1631        dt_bias: &'a [f32],
1632        norm: &'a [f32],
1633        nv: usize,
1634        nk: usize,
1635        dk: usize,
1636        dv: usize,
1637        kk: usize,
1638        /// CPU recurrent state `[ring (kk-1)·cdim | S nv·dk·dv]` — seeds the
1639        /// device mirror when prefill ran on the host (o1 collection, CPU
1640        /// fallback): a zero-initialized device state at decode is exactly
1641        /// the "coherent but contextless" garble.
1642        cpu_state: &'a [f32],
1643    },
1644    /// LFM2 gated short convolution: a fused (B, C, x) projection, a
1645    /// depthwise causal conv over a (kernel−1)-deep per-channel ring,
1646    /// C-gating, and an output projection. This mixer is what most of an
1647    /// LFM2 stack is (22 of the 2.6B's 30 layers), and before it had a
1648    /// graph arm the whole model fell to the per-op path — ~100 submits
1649    /// a token, 22 tok/s on an A100 for a 1.4 GB file.
1650    ShortConv {
1651        /// [3·hidden, hidden] fused input projection.
1652        inp: GraphW<'a>,
1653        /// [hidden, hidden] output projection.
1654        out: GraphW<'a>,
1655        /// [hidden · kernel] depthwise taps, `[channel][tap]`, tap
1656        /// kernel−1 multiplying the current position.
1657        taps: &'a [f32],
1658        kernel: usize,
1659        /// CPU conv ring `[channel][kernel−1]`, slot 0 newest — seeds
1660        /// the device mirror when prefill ran on the host, which for
1661        /// this mixer is always (the batch graph declines it).
1662        cpu_state: &'a [f32],
1663    },
1664}
1665
1666/// Per-layer attention geometry for the wgpu graphs (see
1667/// `GraphAttn::Full::geom`). The layer's CPU cache keeps K rows `hd` wide
1668/// and V rows zero-padded to `hd`; the device mirror stores V `dv` wide,
1669/// and a windowed layer keeps a ring of the last positions only.
1670#[derive(Clone, Copy)]
1671pub struct GraphAttnGeom<'a> {
1672    /// KV heads of this layer (divides the Q heads).
1673    pub nkv: usize,
1674    /// Q/K head width of this layer. The call-wide `hd` for every model
1675    /// but Gemma-4, whose global layers are 512 wide over 256-wide sliding
1676    /// ones (`<= 512`, a multiple of 4).
1677    pub hd: usize,
1678    /// V head width, `4 <= dv <= hd`, a multiple of 4.
1679    pub dv: usize,
1680    /// Rotary width of this layer (NeoX half-split over `[0, rd)`).
1681    pub rd: usize,
1682    /// This layer's RoPE inverse frequencies (`rd / 2` of them).
1683    pub invf: &'a [f32],
1684    /// YaRN attention-amplitude factor applied after the rotary pair
1685    /// transform. `1.0` is ordinary RoPE; Mellum's global layers use
1686    /// `1.277258872…`. This is deliberately per-layer: local and global
1687    /// layers may have different RoPE tables and factors.
1688    pub rope_scale: f32,
1689    /// Positions a query sees, its own included (MiMo-V2 SWA: 128);
1690    /// None = the whole context.
1691    pub window: Option<usize>,
1692    /// Learned per-Q-head sink logits (gpt-oss / MiMo-V2): they join the
1693    /// softmax max and denominator and carry no value row.
1694    pub sink: Option<&'a [f32]>,
1695    /// Gemma-4's scale-less V norm: every V head is RMS-normalized (no
1696    /// weight) before it is cached, as `attention::vnorm_head` does.
1697    pub v_norm: bool,
1698}
1699
1700/// Activation of a graph layer's dense FFN, `act(gate)·up`. The code is
1701/// the word the kernels read (`silu_mul_pre`'s `_c`, the fused gate+up
1702/// kernels' `_p1`): 0 keeps the historical SiLU expression untouched.
1703#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1704pub enum GraphAct {
1705    Silu,
1706    /// Exact erf GELU (HF `gelu`), erf by Abramowitz–Stegun 7.1.26 — the
1707    /// formula `inference::erf_f32` uses on the host.
1708    GeluErf,
1709    /// tanh-approximated GELU (HF `gelu_pytorch_tanh`, the Gemma family):
1710    /// `inference::gelu_tanh` term for term.
1711    GeluTanh,
1712}
1713
1714impl GraphAct {
1715    pub fn code(self) -> u32 {
1716        match self {
1717            Self::Silu => 0,
1718            Self::GeluErf => 1,
1719            Self::GeluTanh => 2,
1720        }
1721    }
1722}
1723
1724/// Per-layer weights for the whole-token wgpu graph.
1725pub struct GraphLayer<'a> {
1726    pub input_norm: &'a [f32],
1727    pub attn: GraphAttn<'a>,
1728    pub post_norm: &'a [f32],
1729    pub ffn: GraphFfn<'a>,
1730    /// Gemma sandwich norms: the token mixer's output and the FFN's output
1731    /// are RMS-normed with these weights before their residual adds.
1732    pub attn_out_norm: Option<&'a [f32]>,
1733    pub ffn_out_norm: Option<&'a [f32]>,
1734    /// Gemma-4 `layer_scalar`: the residual stream is multiplied by it at
1735    /// the end of the layer.
1736    pub layer_scale: Option<f32>,
1737}
1738
1739/// The FFN of one graph layer: a dense SwiGLU trio, or a routed MoE —
1740/// router + top-k selection + all selected experts run ON DEVICE (the
1741/// routing decision depends on the resident hidden state, so a CPU
1742/// round-trip per layer would forfeit the one-submit design).
1743pub enum GraphFfn<'a> {
1744    /// A singleton attention-only batch graph. Returns the post-attention
1745    /// residual, allowing a dynamic expert bank to own the FFN separately.
1746    AttentionOnly,
1747    Dense {
1748        gate: GraphW<'a>,
1749        up: GraphW<'a>,
1750        down: GraphW<'a>,
1751        /// act(gate)·up. The builders refuse an activation with no arm here
1752        /// (before this field the graph computed SiLU for any dense FFN).
1753        act: GraphAct,
1754    },
1755    Moe {
1756        /// Router logits weight (f32, kind 4) `[n_exp, hidden]`.
1757        router: GraphW<'a>,
1758        /// Shared-expert sigmoid gate (f32) `[1, hidden]`.
1759        shared_gate: GraphW<'a>,
1760        /// Per-expert q4_tiled directory indices `(gate, up, down)`;
1761        /// the SHARED expert rides as the LAST entry — the select
1762        /// kernel pins it with the sigmoid weight.
1763        experts: Vec<(usize, usize, usize)>,
1764        /// Routed experts (shared excluded).
1765        n_exp: usize,
1766        top_k: usize,
1767        inter: usize,
1768        norm_topk: bool,
1769        /// Expert weight layout, uniform across the layer: `false` =
1770        /// q4_tiled (18 B tiles, inline f16 scale), `true` = q4tp
1771        /// (16 B nibbles + a per-row ladder plane). The two differ only
1772        /// in where the scale comes from, so they share every kernel
1773        /// but the weight-staging block.
1774        q4tp: bool,
1775        /// `true` = the gate/up experts are `q2tp` (2-bit plane) while
1776        /// `down` stays q4tp — the mixed profile a 2-bit-class checkpoint
1777        /// converts into. Only meaningful with `q4tp: true`.
1778        gu_q2: bool,
1779        /// `true` = every expert's gate, up AND down is q8_2f (int8 body,
1780        /// f16 row scales, f16 column field; Mellum2.1's quality file).
1781        /// `q4tp` and `gu_q2` are false then. Its own kernels: each
1782        /// expert's input is multiplied by THAT expert's column field.
1783        q82: bool,
1784        /// LFM2-MoE / DeepSeek-V3 `noaux_tc` routing: per-expert sigmoid
1785        /// scores instead of a softmax, and `norm_topk` renormalises with
1786        /// the 1e-6 floor. The softmax arm is bit-identical to before.
1787        sigmoid: bool,
1788        /// Per-expert SELECTION bias: added to the score for the top-k
1789        /// choice only — the mixing weights stay unbiased (noaux_tc).
1790        bias: Option<&'a [f32]>,
1791        /// Whether a shared expert rides as the last `experts` entry.
1792        /// LFM2-MoE has none; the select kernel then leaves slot `top_k`
1793        /// unwritten and the expert loop runs `top_k` slots, not +1.
1794        has_shared: bool,
1795        /// The shared expert carries a sigmoid gate (Qwen2/3-MoE). `false`
1796        /// with `has_shared`: the shared expert enters with weight 1
1797        /// (DeepSeek-V3 / HunYuan hy_v3) and `shared_gate` is a stand-in
1798        /// the select kernels ignore.
1799        shared_gated: bool,
1800        /// Multiplier on the routed mixing weights after the optional
1801        /// renormalization (`routed_scaling_factor`); 1.0 = none.
1802        route_scale: f32,
1803    },
1804}
1805
1806/// Outcome of one whole-token graph attempt. A failed attempt after sealed
1807/// O(1) state was admitted must not fall through to the stale CPU state.
1808#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1809pub enum TokenGraphOutcome {
1810    /// No command was committed; the caller may use its ordinary path.
1811    Declined,
1812    /// The graph completed and its hidden/logits output is valid.
1813    Completed,
1814    /// Sealed O(1) state was admitted and a later graph operation failed.
1815    Failed,
1816}
1817
1818/// Whole-token decode graph on wgpu: the entire layer stack in ONE submit,
1819/// hidden resident, one readback. Updates `h` in place.
1820/// `loop_norm_at`: virtual layer indices after which `final_norm` is applied
1821/// (Looped Transformer mid-stack norm). Empty for standard models.
1822#[allow(clippy::too_many_arguments)]
1823pub fn forward_token_graph(
1824    model: &Arc<CmfModel>,
1825    kv_id: u64,
1826    layers: &[GraphLayer],
1827    // Per-layer sealed o1 (Nystrom) state; Some = replace this layer's
1828    // exact attention with the O(1) kernels. wgpu only.
1829    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
1830    o1_epoch: u64,
1831    invf: &[f32],
1832    h: &mut [f32],
1833    nh: usize,
1834    nkv: usize,
1835    hd: usize,
1836    attn_scale: f32,
1837    rd: usize,
1838    hidden: usize,
1839    inter: usize,
1840    position: usize,
1841    cap: usize,
1842    gemma: bool,
1843    eps: f32,
1844    lm_head: Option<(&GraphW, usize)>,
1845    final_norm: &[f32],
1846    logits: &mut Vec<f32>,
1847    loop_norm_at: &[usize],
1848    steps: usize,
1849    embed: Option<(&GraphW, usize, f32)>,
1850    ids_out: Option<&mut Vec<u32>>,
1851    // How many leading layers the graph ran (see the wgpu twin) — smaller
1852    // than layers.len() when the expert budget ended the device prefix.
1853    layers_run: Option<&mut usize>,
1854    // Absolute index of layers[0] in the model — the KV/state mirrors key
1855    // on it, so a layer SPAN (network split segment) shares mirrors with
1856    // a full-stack run instead of colliding at slot 0.
1857    layer_base: usize,
1858    // Read the final hidden back alongside the fused head's logits.
1859    hidden_too: bool,
1860) -> TokenGraphOutcome {
1861    match backend() {
1862        #[cfg(feature = "gpu")]
1863        Backend::Wgpu => crate::gpu_wgpu::forward_token_graph(
1864            model,
1865            kv_id,
1866            layers,
1867            o1,
1868            o1_epoch,
1869            invf,
1870            h,
1871            nh,
1872            nkv,
1873            hd,
1874            attn_scale,
1875            rd,
1876            hidden,
1877            inter,
1878            position,
1879            cap,
1880            gemma,
1881            eps,
1882            lm_head,
1883            final_norm,
1884            logits,
1885            loop_norm_at,
1886            steps,
1887            embed,
1888            ids_out,
1889            layers_run,
1890            layer_base,
1891            hidden_too,
1892        ),
1893        #[allow(unused_variables)]
1894        _ => {
1895            let _ = (
1896                attn_scale,
1897                lm_head,
1898                final_norm,
1899                logits,
1900                loop_norm_at,
1901                layers_run,
1902                layer_base,
1903                hidden_too,
1904            );
1905            TokenGraphOutcome::Declined
1906        }
1907    }
1908}
1909
1910/// Whole-token resident graph for the Embryo working model.  Unlike the
1911/// generic graph this path accepts a packed f32 model and keeps both phase
1912/// recurrent state and the anchor KV cache on the device.  `false` is an
1913/// honest capability refusal; callers must retain the CPU executor.
1914pub fn forward_embryo_graph(
1915    model: &Arc<EmbryoGraphModel>,
1916    kv_id: u64,
1917    hidden: &[f32],
1918    position: usize,
1919    logits: &mut Vec<f32>,
1920) -> bool {
1921    #[cfg(feature = "gpu")]
1922    if backend() == Backend::Wgpu {
1923        return crate::gpu_wgpu::forward_embryo_graph(model, kv_id, hidden, position, logits);
1924    }
1925    let _ = (model, kv_id, hidden, position, logits);
1926    false
1927}
1928
1929/// Speculative-verify tail for the batched graph: fold final-norm + lm_head
1930/// over every batch position and read all k logit rows back; the batch also
1931/// snapshots the GDN state per position for `gdn_spec_restore`.
1932#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1933pub enum BatchGraphOutcome {
1934    /// The graph declined before mutating persistent device state. Callers may
1935    /// safely use the existing per-position path.
1936    Declined,
1937    /// The complete batch committed and its readback succeeded.
1938    Completed,
1939    /// A batch that had admitted sealed O(1) state failed after admission.
1940    /// Falling back to CPU would mix two state machines, so the caller must
1941    /// abort and clear the sequence instead.
1942    Failed,
1943}
1944
1945pub struct SpecTail<'a> {
1946    pub lm: GraphW<'a>,
1947    pub lm_rows: usize,
1948    pub final_norm: &'a [f32],
1949    pub logits_out: &'a mut Vec<f32>,
1950}
1951
1952/// Batched prefill: k contiguous positions through the whole graph in one submit
1953/// (projections/FFN as GEMMs, attention/GDN looped over scratch). `h` is
1954/// [k·hidden] in/out; `positions` len k. wgpu only.
1955#[allow(clippy::too_many_arguments)]
1956pub fn forward_batch_graph(
1957    model: &Arc<CmfModel>,
1958    kv_id: u64,
1959    layers: &[GraphLayer],
1960    invf: &[f32],
1961    h: &mut [f32],
1962    nh: usize,
1963    nkv: usize,
1964    hd: usize,
1965    rd: usize,
1966    hidden: usize,
1967    inter: usize,
1968    positions: &[usize],
1969    cap: usize,
1970    gemma: bool,
1971    eps: f32,
1972    attn_scale: f32,
1973    k: usize,
1974    // Per-layer sealed O(1) device views. An empty slice means the ordinary
1975    // exact-KV path; otherwise it must have one entry per graph layer.
1976    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
1977    o1_epoch: u64,
1978    spec: Option<SpecTail<'_>>,
1979    // Device-prefix mode (plain prefill only): Some = when the whole stack
1980    // does not fit the weight budget, run the leading layers that do — the
1981    // same prefix rule as the token graph — leave the boundary hidden in
1982    // `h` and report the count here; the caller runs the rest on the host.
1983    // None = all layers or a decline, as before.
1984    layers_run: Option<&mut usize>,
1985) -> BatchGraphOutcome {
1986    forward_batch_graph_at(model, kv_id, 0, layers, invf, h, nh, nkv, hd, rd, hidden, inter, positions, cap, gemma, eps, attn_scale, k, o1, o1_epoch, spec, layers_run)
1987}
1988
1989thread_local! {
1990    static MIMO_ATTN_SCRATCH: std::cell::Cell<bool> = const { std::cell::Cell::new(true) };
1991}
1992
1993pub(crate) fn mimo_attention_scratch_enabled() -> bool {
1994    MIMO_ATTN_SCRATCH.with(std::cell::Cell::get)
1995}
1996
1997/// Scoped diagnostic A/B switch; unlike process environment mutations it
1998/// cannot race a model's background workers. Restores on panic as well.
1999#[doc(hidden)]
2000pub fn mimo_attention_scratch_scope<R>(enabled: bool, f: impl FnOnce() -> R) -> R {
2001    struct Restore(bool);
2002    impl Drop for Restore {
2003        fn drop(&mut self) {
2004            MIMO_ATTN_SCRATCH.with(|v| v.set(self.0));
2005        }
2006    }
2007    let _restore = Restore(MIMO_ATTN_SCRATCH.with(|v| v.replace(enabled)));
2008    f()
2009}
2010
2011/// Gemma-4's prompt on the batched wgpu graph (`CMF_G4_BATCH=0` keeps the
2012/// chunked host prefill it used before).
2013pub fn g4_batch_on() -> bool {
2014    static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
2015    *ON.get_or_init(|| std::env::var("CMF_G4_BATCH").as_deref() != Ok("0"))
2016}
2017
2018/// q8_2f MoE experts on the wgpu token and batch graphs (`CMF_MOE_Q82=0`
2019/// keeps them off the graphs: every op on its own, the 0.8.15 route).
2020pub(crate) fn moe_q82_graph_on() -> bool {
2021    static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
2022    *ON.get_or_init(|| std::env::var("CMF_MOE_Q82").as_deref() != Ok("0"))
2023}
2024
2025thread_local! {
2026    static MIMO_Q8_SHORT: std::cell::Cell<bool> = const { std::cell::Cell::new(true) };
2027}
2028
2029pub(crate) fn mimo_q8_short_enabled() -> bool {
2030    MIMO_Q8_SHORT.with(std::cell::Cell::get)
2031}
2032
2033/// Diagnostic A/B switch for row-exact short q8 graph kernels.
2034#[doc(hidden)]
2035pub fn mimo_q8_short_scope<R>(enabled: bool, f: impl FnOnce() -> R) -> R {
2036    struct Restore(bool);
2037    impl Drop for Restore {
2038        fn drop(&mut self) {
2039            MIMO_Q8_SHORT.with(|v| v.set(self.0));
2040        }
2041    }
2042    let _restore = Restore(MIMO_Q8_SHORT.with(|v| v.replace(enabled)));
2043    f()
2044}
2045
2046/// Batched graph over a span whose first absolute layer is `layer_base`.
2047#[allow(clippy::too_many_arguments)]
2048pub fn forward_batch_graph_at(
2049    model: &Arc<CmfModel>,
2050    kv_id: u64,
2051    layer_base: usize,
2052    layers: &[GraphLayer],
2053    invf: &[f32],
2054    h: &mut [f32],
2055    nh: usize,
2056    nkv: usize,
2057    hd: usize,
2058    rd: usize,
2059    hidden: usize,
2060    inter: usize,
2061    positions: &[usize],
2062    cap: usize,
2063    gemma: bool,
2064    eps: f32,
2065    attn_scale: f32,
2066    k: usize,
2067    // Per-layer sealed O(1) device views. An empty slice means the ordinary
2068    // exact-KV path; otherwise it must have one entry per graph layer.
2069    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
2070    o1_epoch: u64,
2071    spec: Option<SpecTail<'_>>,
2072    // Device-prefix mode (plain prefill only): Some = when the whole stack
2073    // does not fit the weight budget, run the leading layers that do — the
2074    // same prefix rule as the token graph — leave the boundary hidden in
2075    // `h` and report the count here; the caller runs the rest on the host.
2076    // None = all layers or a decline, as before.
2077    layers_run: Option<&mut usize>,
2078) -> BatchGraphOutcome {
2079    match backend() {
2080        #[cfg(feature = "gpu")]
2081        Backend::Wgpu => crate::gpu_wgpu::forward_batch_graph_at(
2082            model, kv_id, layer_base, layers, invf, h, nh, nkv, hd, rd, hidden, inter, positions,
2083            cap, gemma, eps, attn_scale, k, o1, o1_epoch, spec, layers_run,
2084        ),
2085        #[allow(unreachable_patterns)]
2086        _ => {
2087            let _ = (o1, o1_epoch, spec, layers_run);
2088            BatchGraphOutcome::Declined
2089        }
2090    }
2091}
2092
2093/// After a partial speculative acceptance: restore every GDN layer's device
2094/// state to the snapshot after batch position `slot`. `base_pos` is the
2095/// absolute position of the first verify row and `expected_layers` makes the
2096/// restore all-or-nothing across the model's recurrent layers. wgpu only.
2097pub fn gdn_spec_restore(kv_id: u64, slot: usize, base_pos: usize, expected_layers: usize) -> bool {
2098    #[cfg(feature = "gpu")]
2099    if backend() == Backend::Wgpu {
2100        return crate::gpu_wgpu::gdn_spec_restore(kv_id, slot, base_pos, expected_layers);
2101    }
2102    #[allow(unreachable_code)]
2103    {
2104        let _ = (kv_id, slot, base_pos, expected_layers);
2105        false
2106    }
2107}
2108
2109/// Re-point one exact-attention device mirror after a speculative round has
2110/// discarded unaccepted rows. The rows beyond `stored` remain allocated and
2111/// are overwritten by the next append; only the logical cursor moves. This
2112/// is the wgpu twin of Metal's existing mirror cursor helper and keeps the
2113/// MTP graph's speculative/device cache coherent with its real anchor.
2114pub fn graph_kv_set_stored(kv_id: u64, layer: usize, stored: usize) -> bool {
2115    #[cfg(feature = "gpu")]
2116    if backend() == Backend::Wgpu {
2117        return crate::gpu_wgpu::kv_mirror_set_stored(kv_id, layer, stored);
2118    }
2119    #[cfg(target_os = "macos")]
2120    if backend() == Backend::Metal {
2121        crate::gpu_metal::kv_mirror_set_stored(kv_id, layer, stored);
2122        return true;
2123    }
2124    false
2125}
2126
2127/// Rows the wgpu token graph's exact-attention mirror holds for one layer
2128/// (None: no wgpu mirror). Metal keeps its owner cache current per token
2129/// and reports None here.
2130pub fn graph_kv_stored(_kv_id: u64, _layer: usize) -> Option<usize> {
2131    #[cfg(feature = "gpu")]
2132    if backend() == Backend::Wgpu {
2133        return crate::gpu_wgpu::kv_mirror_stored(_kv_id, _layer);
2134    }
2135    None
2136}
2137
2138/// Does the wgpu token graph hold a device-resident recurrent state for
2139/// this layer (one the host `linear_state` has not seen)?
2140pub fn graph_state_resident(_kv_id: u64, _layer: usize) -> bool {
2141    #[cfg(feature = "gpu")]
2142    if backend() == Backend::Wgpu {
2143        return crate::gpu_wgpu::graph_state_resident(_kv_id, _layer);
2144    }
2145    false
2146}
2147
2148/// Copy rows back from the wgpu token graph's K/V mirrors in one submit:
2149/// for each `(layer, from, to)` the K and V rows `[from..to)`, position-major
2150/// (`[(to − from) × nkv × hd]` each).
2151pub fn graph_kv_read_rows(
2152    _kv_id: u64,
2153    _reqs: &[(usize, usize, usize)],
2154    _nkv: usize,
2155    _hd: usize,
2156) -> Option<Vec<(Vec<f32>, Vec<f32>)>> {
2157    #[cfg(feature = "gpu")]
2158    if backend() == Backend::Wgpu {
2159        return crate::gpu_wgpu::kv_mirror_read_rows(_kv_id, _reqs, _nkv, _hd);
2160    }
2161    None
2162}
2163
2164/// Rows `[from, to)` of one wgpu exact-attention mirror in the host
2165/// cache's layout (V zero-padded to `hd`), whatever the mirror's geometry
2166/// (narrow V, a sliding layer's ring). The third value is the first
2167/// position actually read: a ring returns zeros below it. None: no wgpu
2168/// mirror holding those rows at (nkv, hd).
2169pub fn graph_kv_pull_host(
2170    _kv_id: u64,
2171    _layer: usize,
2172    _from: usize,
2173    _to: usize,
2174    _nkv: usize,
2175    _hd: usize,
2176) -> Option<(Vec<f32>, Vec<f32>, usize)> {
2177    #[cfg(feature = "gpu")]
2178    if backend() == Backend::Wgpu {
2179        return crate::gpu_wgpu::kv_mirror_pull_host(_kv_id, _layer, _from, _to, _nkv, _hd);
2180    }
2181    None
2182}
2183
2184/// Drop the wgpu token graph's device K/V mirror for a pipeline.
2185pub fn graph_kv_reset(_kv_id: u64) {
2186    #[cfg(feature = "gpu")]
2187    if backend() == Backend::Wgpu {
2188        crate::gpu_wgpu::kv_mirror_reset(_kv_id);
2189        crate::gpu_wgpu::embryo_graph_reset(_kv_id);
2190    }
2191}
2192
2193/// Ternary (q1t) BASE matvec on the GPU — fills `out` with the base dot; the
2194/// caller adds the sparse overlay on the CPU. Metal only for now (wgpu q1t not
2195/// yet written → CPU fallback).
2196pub fn q1t_matvec(
2197    model: &Arc<CmfModel>,
2198    idx: usize,
2199    xs: &[f32],
2200    rows: usize,
2201    cols: usize,
2202    out: &mut [f32],
2203) -> bool {
2204    match backend() {
2205        #[cfg(target_os = "macos")]
2206        Backend::Metal => {
2207            if metal_q1t_enabled() {
2208                crate::gpu_metal::q1t_matvec(model, idx, xs, rows, cols, out)
2209            } else {
2210                false
2211            }
2212        }
2213        #[cfg(feature = "gpu")]
2214        Backend::Wgpu => crate::gpu_wgpu::q1t_matvec(model, idx, xs, rows, cols, out),
2215        Backend::None => false,
2216    }
2217}
2218
2219/// q4_block matvec on the GPU — wgpu only (Metal drives q4_block through the
2220/// whole-token graph, not a standalone matvec).
2221#[allow(unused_variables)]
2222pub fn q4b_matvec(
2223    model: &Arc<CmfModel>,
2224    idx: usize,
2225    xs: &[f32],
2226    rows: usize,
2227    cols: usize,
2228    out: &mut [f32],
2229) -> bool {
2230    match backend() {
2231        #[cfg(target_os = "macos")]
2232        Backend::Metal => false,
2233        #[cfg(feature = "gpu")]
2234        Backend::Wgpu => crate::gpu_wgpu::q4b_matvec(model, idx, xs, rows, cols, out),
2235        Backend::None => false,
2236    }
2237}
2238
2239/// q1t batched GEMM (prefill) — base + overlay on-device (Metal simdgroup or
2240/// wgpu register-blocked).
2241pub fn q1t_matmat(
2242    model: &Arc<CmfModel>,
2243    idx: usize,
2244    xs: &[f32],
2245    b: usize,
2246    rows: usize,
2247    cols: usize,
2248    out: &mut [f32],
2249) -> bool {
2250    match backend() {
2251        #[cfg(target_os = "macos")]
2252        // Batched prefill and single-token decode are both enabled. On the
2253        // real 14.8B Q1T model prefill PPL was within 0.3% of CPU (7.942 vs
2254        // 7.966), and the alignment-safe decode kernel reached 3.52e-6 max_rel.
2255        Backend::Metal => crate::gpu_metal::q1t_matmat(model, idx, xs, b, rows, cols, out),
2256        #[cfg(feature = "gpu")]
2257        Backend::Wgpu => crate::gpu_wgpu::q1t_matmat(model, idx, xs, b, rows, cols, out),
2258        Backend::None => false,
2259    }
2260}
2261
2262/// Native Metal Q1T switch. Enabled by default after the byte-packed Q1T
2263/// fields were changed to alignment-safe loads; keep an explicit emergency
2264/// fallback for device/driver diagnostics.
2265#[cfg(target_os = "macos")]
2266pub(crate) fn metal_q1t_enabled() -> bool {
2267    std::env::var("CMF_METAL_Q1T")
2268        .map(|v| v != "0" && !v.eq_ignore_ascii_case("off"))
2269        .unwrap_or(true)
2270}
2271
2272/// Batched q1 GEMM (prefill). wgpu only — Metal has its own block path.
2273pub fn q1_matmat(
2274    model: &Arc<CmfModel>,
2275    idx: usize,
2276    xs: &[f32],
2277    b: usize,
2278    rows: usize,
2279    cols: usize,
2280    out: &mut [f32],
2281) -> bool {
2282    match backend() {
2283        #[cfg(feature = "gpu")]
2284        Backend::Wgpu => crate::gpu_wgpu::q1_matmat(model, idx, xs, b, rows, cols, out),
2285        #[allow(unused_variables)]
2286        _ => false,
2287    }
2288}
2289
2290/// Batched q1g GEMM (prefill). wgpu only, like `q1_matmat`.
2291pub fn q1g_matmat(
2292    model: &Arc<CmfModel>,
2293    idx: usize,
2294    xs: &[f32],
2295    b: usize,
2296    rows: usize,
2297    cols: usize,
2298    out: &mut [f32],
2299) -> bool {
2300    match backend() {
2301        #[cfg(feature = "gpu")]
2302        Backend::Wgpu => crate::gpu_wgpu::q1g_matmat(model, idx, xs, b, rows, cols, out),
2303        #[allow(unused_variables)]
2304        _ => false,
2305    }
2306}
2307
2308/// Contention kill for the wide imagegen GEMM/FFN paths: one grossly
2309/// slow op under a work-proportional budget (fair-device ops are
2310/// ≤~100 ms even at 1024px) means another process owns the device —
2311/// verdicts are per-process, so CPU for the rest of this one.
2312static MM_KILL: AtomicBool = AtomicBool::new(false);
2313pub(crate) fn mm_killed() -> bool {
2314    MM_KILL.load(Ordering::Relaxed)
2315}
2316pub(crate) fn mm_kill() {
2317    MM_KILL.store(true, Ordering::Relaxed);
2318}
2319
2320/// Consecutive over-budget ops. ONE slow op is not contention: on a
2321/// 24 GB Mac running the 25.7 GB fl2va file the first ops after the
2322/// prompt encode page their weights in from the SSD and take seconds —
2323/// a field report (hololabs, HF discussion #2) had to neuter the kill
2324/// to keep the denoise on the GPU, and then measured 48 s/step where the
2325/// CPU fallback took >60. Contention is persistent; a page-in is not.
2326static MM_STRIKES: std::sync::atomic::AtomicU32 = std::sync::atomic::AtomicU32::new(0);
2327const MM_STRIKES_TO_KILL: u32 = 3;
2328/// Whether the kill is armed at all. A one-shot phase whose slowness is
2329/// expected and not contention — the video prompt encoder streaming
2330/// 12 GB off the SSD on a 24 GB Mac (HF discussion #4: users had to
2331/// gut `mm_kill` to keep the denoise loop on the GPU) — disarms it and
2332/// re-arms it when the phase is over; strikes taken meanwhile are
2333/// forgotten.
2334static MM_ARMED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(true);
2335
2336/// Disarm / re-arm the contention kill around a phase whose GEMMs are
2337/// slow for reasons that are not another process (see `MM_ARMED`).
2338pub fn mm_kill_arm(on: bool) {
2339    MM_ARMED.store(on, Ordering::Relaxed);
2340    if on {
2341        MM_STRIKES.store(0, Ordering::Relaxed);
2342    }
2343}
2344
2345/// The contention verdict for one wide op: `el` against its
2346/// work-proportional `budget`. `exempt` marks ops whose time is not
2347/// evidence — the cold probe, or a weight that was not resident before
2348/// the call and rode in with it. Kills after `MM_STRIKES_TO_KILL`
2349/// consecutive strikes; a within-budget op clears the count.
2350/// `CMF_MM_KILL=0` disables the kill entirely (the device is trusted).
2351pub(crate) fn mm_budget_check(
2352    what: &str,
2353    el: std::time::Duration,
2354    budget: std::time::Duration,
2355    exempt: bool,
2356) {
2357    if el <= budget {
2358        MM_STRIKES.store(0, Ordering::Relaxed);
2359        return;
2360    }
2361    if exempt || !MM_ARMED.load(Ordering::Relaxed) {
2362        return;
2363    }
2364    static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
2365    let on = *ON.get_or_init(|| std::env::var("CMF_MM_KILL").as_deref() != Ok("0"));
2366    let n = MM_STRIKES.fetch_add(1, Ordering::Relaxed) + 1;
2367    if !on {
2368        tracing::info!(
2369            "gpu {what} took {el:?} (budget {budget:?}) — over budget, CMF_MM_KILL=0 keeps the device"
2370        );
2371        return;
2372    }
2373    if n >= MM_STRIKES_TO_KILL {
2374        tracing::warn!(
2375            "gpu {what} took {el:?} (budget {budget:?}), {n} in a row — \
2376             device contended, CPU for the rest of the process (CMF_MM_KILL=0 to override)"
2377        );
2378        mm_kill();
2379    } else {
2380        tracing::info!(
2381            "gpu {what} took {el:?} (budget {budget:?}) — strike {n} of {MM_STRIKES_TO_KILL}"
2382        );
2383    }
2384}
2385
2386/// Fused DiT SwiGLU FFN on the device: g=X·W1ᵀ, u=X·W3ᵀ, silu(g)·u,
2387/// Causal chunk attention on the device: `b` queries against `s0 + b`
2388/// cached keys. wgpu only — Metal's chunk graph keeps attention inside
2389/// the resident block and never calls out.
2390#[allow(unused_variables, clippy::too_many_arguments)]
2391pub fn chunk_attend(
2392    q: &[f32],
2393    k: &[&[f32]],
2394    v: &[&[f32]],
2395    b: usize,
2396    s0: usize,
2397    nh: usize,
2398    nkv: usize,
2399    hd: usize,
2400    scale: f32,
2401    out: &mut [f32],
2402) -> bool {
2403    match backend() {
2404        #[cfg(feature = "gpu")]
2405        Backend::Wgpu => crate::gpu_wgpu::chunk_attend(q, k, v, b, s0, nh, nkv, hd, scale, out),
2406        #[allow(unreachable_patterns)]
2407        _ => false,
2408    }
2409}
2410
2411/// `chunk_attend` under a sliding window (`window` keys, the query's own
2412/// included). wgpu only; see `chunk_attend_windowed`.
2413#[allow(unused_variables, clippy::too_many_arguments)]
2414pub fn chunk_attend_win(
2415    q: &[f32],
2416    k: &[&[f32]],
2417    v: &[&[f32]],
2418    b: usize,
2419    s0: usize,
2420    nh: usize,
2421    nkv: usize,
2422    hd: usize,
2423    scale: f32,
2424    window: usize,
2425    out: &mut [f32],
2426) -> bool {
2427    match backend() {
2428        #[cfg(feature = "gpu")]
2429        Backend::Wgpu => {
2430            crate::gpu_wgpu::chunk_attend_win(q, k, v, b, s0, nh, nkv, hd, scale, window, out)
2431        }
2432        #[allow(unreachable_patterns)]
2433        _ => false,
2434    }
2435}
2436
2437/// Several projections of one host activation, read back in one trip:
2438/// `out` = [P0 | P1 | …], each `idxs` entry (tensor, rows). wgpu only.
2439#[allow(unused_variables)]
2440pub fn gemm_many_keep(
2441    model: &Arc<CmfModel>,
2442    idxs: &[(usize, usize)],
2443    xs: &[f32],
2444    b: usize,
2445    cols: usize,
2446    out: &mut [f32],
2447) -> bool {
2448    match backend() {
2449        #[cfg(feature = "gpu")]
2450        Backend::Wgpu => crate::gpu_wgpu::gemm_many_keep(model, idxs, xs, b, cols, out),
2451        #[allow(unreachable_patterns)]
2452        _ => false,
2453    }
2454}
2455
2456thread_local! {
2457    /// Set by the pipeline around a layer of Spark-X2.5's batched prefill:
2458    /// its int8 matrix-unit GEMMs may take the `zi_mm` tile, and the
2459    /// projections that read one activation share its upload (wgpu).
2460    static PREFILL_FAST_GEMM: Cell<bool> = const { Cell::new(false) };
2461}
2462
2463/// Restores the previous flag on drop.
2464pub struct PrefillFastGemmGuard(bool);
2465
2466impl Drop for PrefillFastGemmGuard {
2467    fn drop(&mut self) {
2468        PREFILL_FAST_GEMM.with(|c| c.set(self.0));
2469    }
2470}
2471
2472/// Let this thread's int8 matrix-unit GEMMs take the `zi_mm` tile for the
2473/// guard's lifetime (bit-identical to the 64x64 kernel; see
2474/// `gpu_wgpu::zi_gemm_route`).
2475pub fn enter_prefill_fast_gemm() -> PrefillFastGemmGuard {
2476    PrefillFastGemmGuard(PREFILL_FAST_GEMM.with(|c| c.replace(true)))
2477}
2478
2479/// Whether `enter_prefill_fast_gemm` is in force on this thread.
2480pub fn prefill_fast_gemm() -> bool {
2481    PREFILL_FAST_GEMM.with(|c| c.get())
2482}
2483
2484/// The largest finite f16. An operand the matrix-unit attention casts to
2485/// f16 must stay within it, or the cast overflows to inf.
2486pub const F16_MAX: f32 = 65504.0;
2487
2488/// max |x| over `xs`, or +inf when an entry is inf or NaN: the value the
2489/// f16 operand guards compare with `F16_MAX`. Sixteen independent lanes
2490/// and a flag, so it vectorizes (a single `fold` chain does not).
2491pub fn abs_max_or_inf(xs: &[f32]) -> f32 {
2492    let mut acc = [0f32; 16];
2493    let mut bad = [false; 16];
2494    let mut it = xs.chunks_exact(16);
2495    for c in &mut it {
2496        for ((a, f), &v) in acc.iter_mut().zip(bad.iter_mut()).zip(c) {
2497            let v = v.abs();
2498            // NaN compares false both ways: flagged, never taken.
2499            *f |= !(v < f32::INFINITY);
2500            *a = if v > *a { v } else { *a };
2501        }
2502    }
2503    let mut m = 0f32;
2504    for &v in it.remainder() {
2505        let v = v.abs();
2506        if !(v < f32::INFINITY) {
2507            return f32::INFINITY;
2508        }
2509        m = m.max(v);
2510    }
2511    if bad.iter().any(|&f| f) {
2512        return f32::INFINITY;
2513    }
2514    acc.iter().fold(m, |m, &a| m.max(a))
2515}
2516
2517/// The decode graph's device K/V mirror a prefill chunk of one layer also
2518/// writes to (wgpu): `kv_id` is the pipeline's graph id, `layer` the
2519/// virtual layer index, `limit` the cache's `max_seq_len` — the same key
2520/// and capacity ceiling the token graph uses, so the mirror the prefill
2521/// fills is the one the first decode token reads.
2522#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2523pub struct PrefillMirror {
2524    pub kv_id: u64,
2525    pub layer: usize,
2526    pub limit: usize,
2527}
2528
2529thread_local! {
2530    /// Set by the pipeline around one layer's batched attention (see
2531    /// `enter_prefill_mirror`); every other caller of the batched
2532    /// attention (MTP heads, tests) sees None and keeps the host upload.
2533    static PREFILL_MIRROR: Cell<Option<PrefillMirror>> = const { Cell::new(None) };
2534}
2535
2536/// Restores the previous target on drop.
2537pub struct PrefillMirrorGuard(Option<PrefillMirror>);
2538
2539impl Drop for PrefillMirrorGuard {
2540    fn drop(&mut self) {
2541        PREFILL_MIRROR.with(|c| c.set(self.0));
2542    }
2543}
2544
2545/// Name the device mirror the current layer's prefill chunk appends to
2546/// and attends against, for the guard's lifetime.
2547pub fn enter_prefill_mirror(t: PrefillMirror) -> PrefillMirrorGuard {
2548    PrefillMirrorGuard(PREFILL_MIRROR.with(|c| c.replace(Some(t))))
2549}
2550
2551/// The mirror `enter_prefill_mirror` named on this thread, if any.
2552pub fn prefill_mirror() -> Option<PrefillMirror> {
2553    PREFILL_MIRROR.with(|c| c.get())
2554}
2555
2556/// `chunk_attend_win` against the decode graph's device mirror instead of
2557/// an upload of the whole prefix: the host rows the mirror lacks (the
2558/// chunk's own `b`, or more after a host-only chunk) are appended first,
2559/// then the attention binds the mirror rows in place. `s0` is the chunk's
2560/// first position and `base` the position of host row 0
2561/// (`LayerKvCache::base`: past 0 on a trimmed sliding tail). `ring` is the
2562/// layer's window as the mirror geometry (Some on every sliding layer),
2563/// `window` the window the softmax masks with (0 while it masks nothing).
2564/// `operand_max` = max |x| over `q` and every K/V row the attend reads
2565/// (`abs_max_or_inf`; +inf when unknown): past `F16_MAX` the f32 kernels
2566/// run instead of the matrix units. wgpu only; false = nothing attended
2567/// (the caller uploads as before).
2568#[allow(unused_variables, clippy::too_many_arguments)]
2569pub fn chunk_attend_mirror(
2570    t: PrefillMirror,
2571    cpu_k: &[Vec<f32>],
2572    cpu_v: &[Vec<f32>],
2573    base: usize,
2574    q: &[f32],
2575    b: usize,
2576    s0: usize,
2577    nh: usize,
2578    nkv: usize,
2579    hd: usize,
2580    scale: f32,
2581    ring: Option<usize>,
2582    window: usize,
2583    operand_max: f32,
2584    out: &mut [f32],
2585) -> bool {
2586    match backend() {
2587        #[cfg(feature = "gpu")]
2588        // QKᵀ and P·V on the matrix units where the device has them (f16
2589        // operands, f32 accumulators — not bit-identical to the f32
2590        // kernels: Spark-X2.5 4B q8_2f wiki ppl 10.677 -> 10.672);
2591        // `CMF_PREFILL_ATTN_COOP=0` keeps the f32 ones (A/B).
2592        Backend::Wgpu => crate::gpu_wgpu::chunk_attend_mirror(
2593            t.kv_id,
2594            t.layer,
2595            t.limit,
2596            cpu_k,
2597            cpu_v,
2598            base,
2599            q,
2600            b,
2601            s0,
2602            nh,
2603            nkv,
2604            hd,
2605            scale,
2606            ring,
2607            window,
2608            std::env::var("CMF_PREFILL_ATTN_COOP").as_deref() != Ok("0"),
2609            operand_max,
2610            out,
2611        ),
2612        #[allow(unreachable_patterns)]
2613        _ => false,
2614    }
2615}
2616
2617/// `chunk_attend_mirror`, then the head gate (`gains`, b × nh, computed on
2618/// the host) and the O projection `wo` on the card: the attention output
2619/// never comes home. `out` = [b][hidden]. The card scans the O operand
2620/// itself, which is the host path's product bit for bit only while max
2621/// |gated output| <= 1000: the caller vouches for that (Spark-X2.5's
2622/// prefill, max |v| <= 990). wgpu only; false = nothing written to `out`
2623/// (the caller attends and projects as before).
2624#[allow(unused_variables, clippy::too_many_arguments)]
2625pub fn chunk_attend_mirror_wo(
2626    t: PrefillMirror,
2627    cpu_k: &[Vec<f32>],
2628    cpu_v: &[Vec<f32>],
2629    base: usize,
2630    q: &[f32],
2631    b: usize,
2632    s0: usize,
2633    nh: usize,
2634    nkv: usize,
2635    hd: usize,
2636    scale: f32,
2637    ring: Option<usize>,
2638    window: usize,
2639    operand_max: f32,
2640    gains: Option<&[f32]>,
2641    wo: (&Arc<CmfModel>, usize),
2642    hidden: usize,
2643    out: &mut [f32],
2644) -> bool {
2645    match backend() {
2646        #[cfg(feature = "gpu")]
2647        Backend::Wgpu => crate::gpu_wgpu::chunk_attend_mirror_wo(
2648            t.kv_id,
2649            t.layer,
2650            t.limit,
2651            cpu_k,
2652            cpu_v,
2653            base,
2654            q,
2655            b,
2656            s0,
2657            nh,
2658            nkv,
2659            hd,
2660            scale,
2661            ring,
2662            window,
2663            std::env::var("CMF_PREFILL_ATTN_COOP").as_deref() != Ok("0"),
2664            operand_max,
2665            gains,
2666            wo,
2667            hidden,
2668            out,
2669        ),
2670        #[allow(unreachable_patterns)]
2671        _ => false,
2672    }
2673}
2674
2675/// Whether the active backend's chunk attend can apply a sliding window.
2676pub fn chunk_attend_windowed() -> bool {
2677    match backend() {
2678        #[cfg(feature = "gpu")]
2679        Backend::Wgpu => true,
2680        #[allow(unreachable_patterns)]
2681        _ => false,
2682    }
2683}
2684
2685/// Fused QKV projection: one upload of the normed chunk, three GEMMs,
2686/// one readback of Q|K|V back to back. Metal has no twin yet — its
2687/// chunk graph keeps the whole layer resident and never surfaces QKV.
2688#[allow(unused_variables, clippy::too_many_arguments)]
2689pub fn q4t_qkv(
2690    model: &Arc<CmfModel>,
2691    wq: usize,
2692    wk: usize,
2693    wv: usize,
2694    xs: &[f32],
2695    b: usize,
2696    cols: usize,
2697    rq: usize,
2698    rk: usize,
2699    rv: usize,
2700    out: &mut [f32],
2701) -> bool {
2702    match backend() {
2703        #[cfg(feature = "gpu")]
2704        Backend::Wgpu => crate::gpu_wgpu::q4t_qkv(model, wq, wk, wv, xs, b, cols, rq, rk, rv, out),
2705        #[allow(unreachable_patterns)]
2706        _ => false,
2707    }
2708}
2709
2710/// y=·W2ᵀ — one command buffer, only X and Y cross the CPU boundary.
2711#[allow(unused_variables, clippy::too_many_arguments)]
2712/// SwiGLU FFN with a row-packed [gate|up] fc1 (MiniMax-H3's DiT), run
2713/// end to end on the device. wgpu only: Metal keeps the host loop until
2714/// its own packed kernel exists.
2715#[allow(clippy::too_many_arguments, unused_variables)]
2716pub fn q4tp_ffn_packed(
2717    model: &Arc<CmfModel>,
2718    w1: usize,
2719    w2: usize,
2720    xs: &[f32],
2721    b: usize,
2722    hidden: usize,
2723    inter: usize,
2724    bias: Option<&[f32]>,
2725    out: &mut [f32],
2726) -> bool {
2727    match backend() {
2728        #[cfg(feature = "gpu")]
2729        Backend::Wgpu => {
2730            crate::gpu_wgpu::ffn_packed(model, w1, w2, xs, b, hidden, inter, bias, out)
2731        }
2732        #[allow(unreachable_patterns)]
2733        _ => false,
2734    }
2735}
2736
2737pub fn q4tp_ffn(
2738    model: &Arc<CmfModel>,
2739    w1: usize,
2740    w3: usize,
2741    w2: usize,
2742    xs: &[f32],
2743    b: usize,
2744    hidden: usize,
2745    inter: usize,
2746    out: &mut [f32],
2747) -> bool {
2748    match backend() {
2749        #[cfg(target_os = "macos")]
2750        Backend::Metal => crate::gpu_metal::q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2751        #[cfg(feature = "gpu")]
2752        Backend::Wgpu => crate::gpu_wgpu::q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2753        #[allow(unreachable_patterns)]
2754        _ => false,
2755    }
2756}
2757
2758/// `q4tp_ffn` (`q4tp` = true) / `q4t_ffn` with the activation named:
2759/// SiLU takes the plain entry points (every backend), the exact GELU of
2760/// Spark-X2.5 has a wgpu arm only — other backends decline it.
2761#[allow(clippy::too_many_arguments, unused_variables)]
2762pub fn q4_ffn_act(
2763    model: &Arc<CmfModel>,
2764    w1: usize,
2765    w3: usize,
2766    w2: usize,
2767    xs: &[f32],
2768    b: usize,
2769    hidden: usize,
2770    inter: usize,
2771    q4tp: bool,
2772    act: GraphAct,
2773    out: &mut [f32],
2774) -> bool {
2775    match act {
2776        GraphAct::Silu if q4tp => q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2777        GraphAct::Silu => q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2778        GraphAct::GeluErf | GraphAct::GeluTanh => match backend() {
2779            #[cfg(feature = "gpu")]
2780            Backend::Wgpu => crate::gpu_wgpu::q4_ffn_act(
2781                model,
2782                w1,
2783                w3,
2784                w2,
2785                xs,
2786                b,
2787                hidden,
2788                inter,
2789                q4tp,
2790                act.code(),
2791                out,
2792            ),
2793            #[allow(unreachable_patterns)]
2794            _ => false,
2795        },
2796    }
2797}
2798
2799/// The LLM prefill's dense FFN for separate gate/up/down weights in any
2800/// codec with a device GEMM (int8, q4tp, or a mix of them): the panels
2801/// stay on the card between the projections. wgpu only; other backends
2802/// decline and the caller keeps its per-GEMM path.
2803#[allow(clippy::too_many_arguments, unused_variables)]
2804pub fn ffn_act_keep(
2805    model: &Arc<CmfModel>,
2806    w1: usize,
2807    w3: usize,
2808    w2: usize,
2809    xs: &[f32],
2810    b: usize,
2811    hidden: usize,
2812    inter: usize,
2813    act: GraphAct,
2814    out: &mut [f32],
2815) -> bool {
2816    match backend() {
2817        #[cfg(feature = "gpu")]
2818        Backend::Wgpu => crate::gpu_wgpu::ffn_act_keep(
2819            model,
2820            w1,
2821            w3,
2822            w2,
2823            xs,
2824            b,
2825            hidden,
2826            inter,
2827            act.code(),
2828            out,
2829        ),
2830        #[allow(unreachable_patterns)]
2831        _ => false,
2832    }
2833}
2834
2835/// Qwen Image's exact two-projection tanh-GELU FFN.  The WGPU arm keeps the
2836/// intermediate on the device; other backends decline so the caller retains
2837/// its bounded CPU path.  `bias_in` is applied before GELU and `bias_out`
2838/// after the second projection, matching the official transformer.
2839#[allow(clippy::too_many_arguments, unused_variables)]
2840pub fn q4tp_gelu_ffn(
2841    model: &Arc<CmfModel>,
2842    w_in: usize,
2843    w_out: usize,
2844    xs: &[f32],
2845    b: usize,
2846    hidden: usize,
2847    inter: usize,
2848    bias_in: &[f32],
2849    bias_out: &[f32],
2850    out: &mut [f32],
2851) -> bool {
2852    match backend() {
2853        #[cfg(feature = "gpu")]
2854        Backend::Wgpu => crate::gpu_wgpu::q4tp_gelu_ffn(
2855            model, w_in, w_out, xs, b, hidden, inter, bias_in, bias_out, out,
2856        ),
2857        #[allow(unreachable_patterns)]
2858        _ => false,
2859    }
2860}
2861
2862pub fn q4t_ffn(
2863    model: &Arc<CmfModel>,
2864    w1: usize,
2865    w3: usize,
2866    w2: usize,
2867    xs: &[f32],
2868    b: usize,
2869    hidden: usize,
2870    inter: usize,
2871    out: &mut [f32],
2872) -> bool {
2873    match backend() {
2874        #[cfg(target_os = "macos")]
2875        Backend::Metal => crate::gpu_metal::q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2876        #[cfg(feature = "gpu")]
2877        Backend::Wgpu => crate::gpu_wgpu::q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2878        #[allow(unreachable_patterns)]
2879        _ => false,
2880    }
2881}
2882
2883/// One whole modulated DiT block for `dit_block`: geometry, norm
2884/// weights, AdaLN scale/gate vectors (gates pre-tanh'd), a per-token
2885/// f32 RoPE cos/sin table, and the directory indices of the seven
2886/// q4t projections. `x` is in-out `[n, hidden]`.
2887pub struct DitBlockArgs<'a> {
2888    pub n: usize,
2889    pub hidden: usize,
2890    pub inter: usize,
2891    pub nh: usize,
2892    pub nkv: usize,
2893    pub hd: usize,
2894    pub eps: f32,
2895    pub rope_cos: &'a [f32],
2896    pub rope_sin: &'a [f32],
2897    pub norm1: &'a [f32],
2898    pub norm2: &'a [f32],
2899    pub ffn_norm1: &'a [f32],
2900    pub ffn_norm2: &'a [f32],
2901    pub norm_q: &'a [f32],
2902    pub norm_k: &'a [f32],
2903    pub s_msa: &'a [f32],
2904    pub gate_msa: &'a [f32],
2905    pub s_mlp: &'a [f32],
2906    pub gate_mlp: &'a [f32],
2907    pub wq: usize,
2908    pub wk: usize,
2909    pub wv: usize,
2910    pub wo: usize,
2911    pub w1: usize,
2912    pub w3: usize,
2913    pub w2: usize,
2914    /// The projections' layout: q4tp (ladder scales) vs plain q4_tiled.
2915    /// The recommended Lumina file is q4tp, and a backend that only
2916    /// knows q4t must decline rather than decode with the wrong reader.
2917    pub q4tp: bool,
2918    /// The hidden state is already on the device from the previous block,
2919    /// so `x` need not be uploaded.
2920    pub resident_in: bool,
2921    /// Leave the result on the device instead of reading it back. The DiT
2922    /// loop does not touch `x` between blocks, so 27 of every 28 readbacks
2923    /// were moving 19 MB across PCIe and stalling on it for nothing.
2924    pub resident_out: bool,
2925}
2926
2927/// Can the selected backend keep the DiT's hidden state on the device
2928/// between blocks? Only the wgpu whole-block path; the Metal entry takes
2929/// and returns host memory every call.
2930pub fn dit_chain_supported() -> bool {
2931    #[cfg(feature = "gpu")]
2932    {
2933        return matches!(backend(), Backend::Wgpu) && fused_dit_block_available();
2934    }
2935    #[allow(unreachable_code)]
2936    false
2937}
2938
2939/// Pull the resident hidden state back to the host. For the caller that
2940/// chained blocks and then hit one the device declined.
2941pub fn dit_state_fetch(_x: &mut [f32]) -> bool {
2942    #[cfg(feature = "gpu")]
2943    {
2944        if matches!(backend(), Backend::Wgpu) {
2945            return crate::gpu_wgpu::dit_state_fetch(_x);
2946        }
2947    }
2948    false
2949}
2950
2951/// One whole modulated DiT block on the device — norms, qkv, RoPE,
2952/// attention, residuals and the SwiGLU FFN in a single command
2953/// buffer; only `x` crosses the CPU boundary (in and out).
2954#[allow(unused_variables)]
2955/// The DiT's three projections in one submission (wgpu only; the
2956/// Metal path fuses the whole block instead). False = the caller keeps
2957/// its three separate calls.
2958#[allow(unused_variables, clippy::too_many_arguments)]
2959pub fn dit_qkv(
2960    model: &Arc<CmfModel>,
2961    wq: usize,
2962    wk: usize,
2963    wv: usize,
2964    xs: &[f32],
2965    b: usize,
2966    hidden: usize,
2967    qrows: usize,
2968    kvrows: usize,
2969    q_out: &mut [f32],
2970    k_out: &mut [f32],
2971    v_out: &mut [f32],
2972) -> bool {
2973    match backend() {
2974        #[cfg(feature = "gpu")]
2975        Backend::Wgpu => crate::gpu_wgpu::q4tp_qkv(
2976            model, wq, wk, wv, xs, b, hidden, qrows, kvrows, q_out, k_out, v_out,
2977        ),
2978        #[allow(unreachable_patterns)]
2979        _ => false,
2980    }
2981}
2982
2983/// The Qwen Image double-stream attention half.  The WGPU implementation
2984/// keeps the six Q/K/V projections, the stream join, qk-norm/RoPE, joint
2985/// attention, and both output projections on the device; the caller only
2986/// supplies the two normalized streams and receives the two projected
2987/// streams.  A backend or codec that cannot satisfy the full contract
2988/// returns `false` before changing either output, so the native host path
2989/// remains the portable fallback.
2990pub struct QwenImageAttentionArgs<'a> {
2991    pub image: &'a [f32],
2992    pub text: &'a [f32],
2993    pub image_tokens: usize,
2994    pub text_tokens: usize,
2995    pub heads: usize,
2996    pub head_dim: usize,
2997    pub image_q: usize,
2998    pub image_k: usize,
2999    pub image_v: usize,
3000    pub text_q: usize,
3001    pub text_k: usize,
3002    pub text_v: usize,
3003    pub image_out: usize,
3004    pub text_out: usize,
3005    pub image_q_norm: &'a [f32],
3006    pub image_k_norm: &'a [f32],
3007    pub text_q_norm: &'a [f32],
3008    pub text_k_norm: &'a [f32],
3009    pub image_cos: &'a [f32],
3010    pub image_sin: &'a [f32],
3011    pub text_cos: &'a [f32],
3012    pub text_sin: &'a [f32],
3013    pub image_q_bias: &'a [f32],
3014    pub image_k_bias: &'a [f32],
3015    pub image_v_bias: &'a [f32],
3016    pub text_q_bias: &'a [f32],
3017    pub text_k_bias: &'a [f32],
3018    pub text_v_bias: &'a [f32],
3019    pub image_out_bias: &'a [f32],
3020    pub text_out_bias: &'a [f32],
3021    pub image_proj: &'a mut [f32],
3022    pub text_proj: &'a mut [f32],
3023}
3024
3025/// The per-layer controls and Q4TP directory indices used by the native
3026/// Qwen block.  Keeping this descriptor separate from the stream buffers
3027/// lets a whole transformer forward reuse one explicit device state without
3028/// a global scratch slot or a hidden context label.
3029#[allow(clippy::too_many_fields)]
3030pub struct QwenImageChainBlock<'a> {
3031    pub image_mod: &'a [f32],
3032    pub text_mod: &'a [f32],
3033    pub image_q: usize,
3034    pub image_k: usize,
3035    pub image_v: usize,
3036    pub text_q: usize,
3037    pub text_k: usize,
3038    pub text_v: usize,
3039    pub image_out: usize,
3040    pub text_out: usize,
3041    pub image_q_norm: &'a [f32],
3042    pub image_k_norm: &'a [f32],
3043    pub text_q_norm: &'a [f32],
3044    pub text_k_norm: &'a [f32],
3045    pub image_q_bias: &'a [f32],
3046    pub image_k_bias: &'a [f32],
3047    pub image_v_bias: &'a [f32],
3048    pub text_q_bias: &'a [f32],
3049    pub text_k_bias: &'a [f32],
3050    pub text_v_bias: &'a [f32],
3051    pub image_out_bias: &'a [f32],
3052    pub text_out_bias: &'a [f32],
3053    pub image_attn_gate: &'a [f32],
3054    pub text_attn_gate: &'a [f32],
3055    pub image_mlp_in: usize,
3056    pub image_mlp_out: usize,
3057    pub text_mlp_in: usize,
3058    pub text_mlp_out: usize,
3059    pub image_mlp_in_bias: &'a [f32],
3060    pub image_mlp_out_bias: &'a [f32],
3061    pub text_mlp_in_bias: &'a [f32],
3062    pub text_mlp_out_bias: &'a [f32],
3063}
3064
3065/// Complete Qwen Image transformer block contract. The first norm/mod
3066/// panels are supplied by the native caller; the WGPU arm keeps both streams
3067/// resident through QKV, QK/RoPE, joint attention, output projections, both
3068/// gated residuals, and the exact tanh-GELU MLPs. A backend that cannot
3069/// satisfy the whole graph returns `false` without changing either output.
3070#[allow(clippy::too_many_fields)]
3071pub struct QwenImageBlockArgs<'a> {
3072    /// Raw stream state is read for the first gated residual and overwritten
3073    /// with the block's final state after the one readback.
3074    pub image: &'a mut [f32],
3075    pub text: &'a mut [f32],
3076    pub image_norm: &'a [f32],
3077    pub text_norm: &'a [f32],
3078    pub image_tokens: usize,
3079    pub text_tokens: usize,
3080    pub heads: usize,
3081    pub head_dim: usize,
3082    pub image_cos: &'a [f32],
3083    pub image_sin: &'a [f32],
3084    pub text_cos: &'a [f32],
3085    pub text_sin: &'a [f32],
3086    pub image_q: usize,
3087    pub image_k: usize,
3088    pub image_v: usize,
3089    pub text_q: usize,
3090    pub text_k: usize,
3091    pub text_v: usize,
3092    pub image_out: usize,
3093    pub text_out: usize,
3094    pub image_q_norm: &'a [f32],
3095    pub image_k_norm: &'a [f32],
3096    pub text_q_norm: &'a [f32],
3097    pub text_k_norm: &'a [f32],
3098    pub image_q_bias: &'a [f32],
3099    pub image_k_bias: &'a [f32],
3100    pub image_v_bias: &'a [f32],
3101    pub text_q_bias: &'a [f32],
3102    pub text_k_bias: &'a [f32],
3103    pub text_v_bias: &'a [f32],
3104    pub image_out_bias: &'a [f32],
3105    pub text_out_bias: &'a [f32],
3106    pub image_attn_gate: &'a [f32],
3107    pub text_attn_gate: &'a [f32],
3108    pub image_mlp_in: usize,
3109    pub image_mlp_out: usize,
3110    pub text_mlp_in: usize,
3111    pub text_mlp_out: usize,
3112    pub image_mlp_in_bias: &'a [f32],
3113    pub image_mlp_out_bias: &'a [f32],
3114    pub text_mlp_in_bias: &'a [f32],
3115    pub text_mlp_out_bias: &'a [f32],
3116    pub image_mlp_mod: &'a [f32],
3117    pub text_mlp_mod: &'a [f32],
3118    pub image_mlp_gate: &'a [f32],
3119    pub text_mlp_gate: &'a [f32],
3120}
3121
3122/// Explicit whole-forward Qwen state contract.  The WGPU backend uploads the
3123/// two initial streams once, encodes a bounded number of complete blocks per
3124/// submission, and reads the final state once.  `blocks` is immutable for the
3125/// call, while the two stream slices receive only the final readback.
3126pub struct QwenImageChainArgs<'a> {
3127    pub image: &'a mut [f32],
3128    pub text: &'a mut [f32],
3129    pub image_tokens: usize,
3130    pub text_tokens: usize,
3131    pub heads: usize,
3132    pub head_dim: usize,
3133    pub image_cos: &'a [f32],
3134    pub image_sin: &'a [f32],
3135    pub text_cos: &'a [f32],
3136    pub text_sin: &'a [f32],
3137    pub blocks: &'a [QwenImageChainBlock<'a>],
3138}
3139
3140#[allow(unused_variables)]
3141pub fn qwen_image_attention(
3142    model: &Arc<CmfModel>,
3143    args: &mut QwenImageAttentionArgs<'_>,
3144) -> bool {
3145    match backend() {
3146        #[cfg(feature = "gpu")]
3147        Backend::Wgpu => crate::gpu_wgpu::qwen_image_attention(model, args),
3148        #[allow(unreachable_patterns)]
3149        _ => false,
3150    }
3151}
3152
3153#[allow(unused_variables)]
3154pub fn qwen_image_block(model: &Arc<CmfModel>, args: &mut QwenImageBlockArgs<'_>) -> bool {
3155    match backend() {
3156        #[cfg(feature = "gpu")]
3157        Backend::Wgpu => crate::gpu_wgpu::qwen_image_block(model, args),
3158        #[allow(unreachable_patterns)]
3159        _ => false,
3160    }
3161}
3162
3163/// Keep all Qwen transformer blocks on the selected WGPU device, with only
3164/// bounded chunk submissions and one final readback.  Other backends decline
3165/// so the native caller can use its exact portable block loop.
3166#[allow(unused_variables)]
3167pub fn qwen_image_chain(model: &Arc<CmfModel>, args: &mut QwenImageChainArgs<'_>) -> bool {
3168    match backend() {
3169        #[cfg(feature = "gpu")]
3170        Backend::Wgpu => crate::gpu_wgpu::qwen_image_chain(model, args),
3171        #[allow(unreachable_patterns)]
3172        _ => false,
3173    }
3174}
3175
3176/// The Qwen Image second sub-block on WGPU: affine-free LayerNorm,
3177/// shift/scale modulation, Q4TP input projection, exact tanh-GELU, output
3178/// projection, bias and gated residual.  `data` is updated in place after a
3179/// single final readback.  Backends/codecs that cannot keep this chain on the
3180/// device return `false` before changing `data`, leaving the caller's
3181/// portable per-op path intact.
3182#[allow(unused_variables, clippy::too_many_arguments)]
3183pub fn qwen_image_mlp_inplace(
3184    model: &Arc<CmfModel>,
3185    w_in: usize,
3186    w_out: usize,
3187    data: &mut [f32],
3188    batch: usize,
3189    hidden: usize,
3190    inter: usize,
3191    bias_in: &[f32],
3192    bias_out: &[f32],
3193    modulation: &[f32],
3194    gate: &[f32],
3195) -> bool {
3196    match backend() {
3197        #[cfg(feature = "gpu")]
3198        Backend::Wgpu => crate::gpu_wgpu::qwen_image_mlp_inplace(
3199            model,
3200            w_in,
3201            w_out,
3202            data,
3203            batch,
3204            hidden,
3205            inter,
3206            bias_in,
3207            bias_out,
3208            modulation,
3209            gate,
3210        ),
3211        #[allow(unreachable_patterns)]
3212        _ => false,
3213    }
3214}
3215
3216/// Is a FUSED whole-block device path on offer? The batched-CFG shape
3217/// (two sequences in one tall batch) and the fused block (one sequence,
3218/// one command buffer) are alternatives, and the caller picks.
3219pub fn fused_dit_block_available() -> bool {
3220    #[cfg(target_os = "macos")]
3221    {
3222        matches!(backend(), Backend::Metal) && fused_block_trusted()
3223    }
3224    #[cfg(not(target_os = "macos"))]
3225    {
3226        false
3227    }
3228}
3229
3230pub fn dit_block(model: &Arc<CmfModel>, a: &DitBlockArgs, x: &mut [f32]) -> bool {
3231    dit_block_seg(model, a, &[a.n], x)
3232}
3233
3234/// The same block over a CONCATENATION of independent sequences:
3235/// attention per segment, everything position-wise batched. wgpu only —
3236/// the Metal path takes the single-sequence entry above.
3237pub fn dit_block_seg(
3238    model: &Arc<CmfModel>,
3239    a: &DitBlockArgs,
3240    segs: &[usize],
3241    x: &mut [f32],
3242) -> bool {
3243    match backend() {
3244        #[cfg(target_os = "macos")]
3245        Backend::Metal if segs.len() <= 1 => crate::gpu_metal::dit_block(model, a, x),
3246        // The wgpu whole-block path. What it buys is host round trips —
3247        // six a block become one — so it defaults ON where those cost
3248        // real time (a discrete card across PCIe) and OFF on unified
3249        // memory, where the per-op path shares the same pages and the
3250        // fusion measured slightly slower on an M4. `CMF_DIT_FUSED=1`
3251        // forces it anywhere, `=0` forbids it.
3252        #[cfg(feature = "gpu")]
3253        Backend::Wgpu
3254            if match std::env::var("CMF_DIT_FUSED").ok().as_deref() {
3255                Some("0") => false,
3256                Some(_) => true,
3257                None => crate::gpu_wgpu::discrete_active(),
3258            } =>
3259        {
3260            crate::gpu_wgpu::dit_block_seg(model, a, segs, x)
3261        }
3262        #[allow(unreachable_patterns)]
3263        _ => false,
3264    }
3265}
3266
3267/// One VAE resnet block for `vae_resnet`: norm/conv weights and the
3268/// channel/shape geometry. `shortcut` is the 1×1 projection (w, b, k)
3269/// when in/out channels differ.
3270pub struct VaeResnetArgs<'a> {
3271    pub groups: usize,
3272    pub ic: usize,
3273    pub oc: usize,
3274    pub h: usize,
3275    pub w: usize,
3276    pub n1w: &'a [f32],
3277    pub n1b: &'a [f32],
3278    pub c1w: &'a [f32],
3279    pub c1b: &'a [f32],
3280    pub c1k: usize,
3281    pub n2w: &'a [f32],
3282    pub n2b: &'a [f32],
3283    pub c2w: &'a [f32],
3284    pub c2b: &'a [f32],
3285    pub c2k: usize,
3286    pub shortcut: Option<(&'a [f32], &'a [f32], usize)>,
3287}
3288
3289/// One whole VAE resnet block on the device (norm+silu → conv ×2 →
3290/// shortcut → add, one command buffer).
3291#[allow(unused_variables)]
3292pub fn vae_resnet(a: &VaeResnetArgs, x: &[f32], out: &mut [f32]) -> bool {
3293    match backend() {
3294        #[cfg(target_os = "macos")]
3295        Backend::Metal => crate::gpu_metal::vae_resnet(a, x, out),
3296        _ => false,
3297    }
3298}
3299
3300/// Nearest-2× upsample fused with the following conv — the small
3301/// pre-upsample image is what crosses the CPU boundary.
3302#[allow(unused_variables, clippy::too_many_arguments)]
3303pub fn vae_upsample_conv(
3304    w: &[f32],
3305    bias: &[f32],
3306    x: &[f32],
3307    ic: usize,
3308    oc: usize,
3309    h: usize,
3310    w_img: usize,
3311    k: usize,
3312    out: &mut [f32],
3313) -> bool {
3314    match backend() {
3315        #[cfg(target_os = "macos")]
3316        Backend::Metal => crate::gpu_metal::vae_upsample_conv(w, bias, x, ic, oc, h, w_img, k, out),
3317        #[cfg(feature = "gpu")]
3318        Backend::Wgpu => crate::gpu_wgpu::vae_upsample_conv(w, bias, x, ic, oc, h, w_img, k, out),
3319        #[allow(unreachable_patterns)]
3320        _ => false,
3321    }
3322}
3323
3324/// VAE conv2d on the device (implicit GEMM — the CPU path pays for a
3325/// multi-GB im2col matrix at high resolutions).
3326#[allow(unused_variables, clippy::too_many_arguments)]
3327pub fn vae_conv2d(
3328    w: &[f32],
3329    bias: &[f32],
3330    x: &[f32],
3331    ic: usize,
3332    oc: usize,
3333    h: usize,
3334    w_img: usize,
3335    k: usize,
3336    out: &mut [f32],
3337) -> bool {
3338    match backend() {
3339        #[cfg(target_os = "macos")]
3340        Backend::Metal => crate::gpu_metal::vae_conv2d(w, bias, x, ic, oc, h, w_img, k, out),
3341        #[cfg(feature = "gpu")]
3342        Backend::Wgpu => crate::gpu_wgpu::vae_conv2d(w, bias, x, ic, oc, h, w_img, k, out),
3343        #[allow(unreachable_patterns)]
3344        _ => false,
3345    }
3346}
3347
3348/// DiT full bidirectional attention on the device (all heads:
3349/// scores GEMM → row softmax → P·V → panel unstack, one command
3350/// buffer). Head-major inputs; out is [n, nh·hd].
3351#[allow(unused_variables, clippy::too_many_arguments)]
3352/// Attention from an interleaved qkv panel, splitting into head-major
3353/// planes ON the device. wgpu only; `false` elsewhere so the caller
3354/// keeps its host repack.
3355#[allow(unused_variables)]
3356#[allow(clippy::too_many_arguments)]
3357/// qkv projection + attention with the panel never leaving the card.
3358/// wgpu only; `false` elsewhere and the caller keeps its host chain.
3359#[allow(clippy::too_many_arguments, unused_variables)]
3360pub fn dit_qkv_attention(
3361    model: &Arc<CmfModel>,
3362    qkv_idx: usize,
3363    xn: &[f32],
3364    n: usize,
3365    hidden: usize,
3366    nh: usize,
3367    hd: usize,
3368    scale: f32,
3369    nr: (&[f32], &[f32], &[f32], f32),
3370    out: &mut [f32],
3371) -> bool {
3372    match backend() {
3373        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3374        Backend::Wgpu => crate::gpu_wgpu::dit_qkv_attention(
3375            model, qkv_idx, xn, n, hidden, nh, hd, scale, nr, out,
3376        ),
3377        #[allow(unreachable_patterns)]
3378        _ => false,
3379    }
3380}
3381
3382/// The whole attention half of a DiT block on the card: qkv GEMM,
3383/// attention, output projection. Only `proj` comes home.
3384#[allow(clippy::too_many_arguments)]
3385pub fn dit_qkv_attn_out(
3386    model: &Arc<CmfModel>,
3387    qkv_idx: usize,
3388    out_idx: usize,
3389    xn: &[f32],
3390    n: usize,
3391    hidden: usize,
3392    nh: usize,
3393    hd: usize,
3394    scale: f32,
3395    nr: (&[f32], &[f32], &[f32], f32),
3396    proj: &mut [f32],
3397) -> bool {
3398    match backend() {
3399        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3400        Backend::Wgpu => crate::gpu_wgpu::dit_qkv_attn_out(
3401            model, qkv_idx, out_idx, xn, n, hidden, nh, hd, scale, nr, proj,
3402        ),
3403        #[allow(unreachable_patterns)]
3404        _ => false,
3405    }
3406}
3407
3408/// The VAE decoder's attention half on the card. Only `proj` returns.
3409#[allow(clippy::too_many_arguments)]
3410pub fn vae_qkv_attn_out(
3411    model: &Arc<CmfModel>,
3412    qkv_idx: usize,
3413    out_idx: usize,
3414    xn: &[f32],
3415    n: usize,
3416    dim: usize,
3417    nh: usize,
3418    hd: usize,
3419    scale: f32,
3420    angles: &[f32],
3421    eps: f32,
3422    qkv_bias: &[f32],
3423    proj: &mut [f32],
3424) -> bool {
3425    match backend() {
3426        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3427        Backend::Wgpu => crate::gpu_wgpu::vae_qkv_attn_out(
3428            model, qkv_idx, out_idx, xn, n, dim, nh, hd, scale, angles, eps, qkv_bias, proj,
3429        ),
3430        #[allow(unreachable_patterns)]
3431        _ => false,
3432    }
3433}
3434
3435#[allow(clippy::too_many_arguments)]
3436pub fn vae_attention_packed(
3437    qkv: &[f32],
3438    nh: usize,
3439    n: usize,
3440    hd: usize,
3441    scale: f32,
3442    angles: &[f32],
3443    eps: f32,
3444    out: &mut [f32],
3445) -> bool {
3446    vae_attention_packed_layout(qkv, nh, n, hd, scale, angles, eps, out, 1)
3447}
3448
3449#[allow(clippy::too_many_arguments)]
3450pub fn vae_attention_packed_layout(
3451    qkv: &[f32],
3452    nh: usize,
3453    n: usize,
3454    hd: usize,
3455    scale: f32,
3456    angles: &[f32],
3457    eps: f32,
3458    out: &mut [f32],
3459    layout: u32,
3460) -> bool {
3461    match backend() {
3462        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3463        Backend::Wgpu => crate::gpu_wgpu::vae_attention_packed_layout(
3464            qkv, nh, n, hd, scale, angles, eps, out, layout,
3465        ),
3466        #[allow(unreachable_patterns)]
3467        _ => false,
3468    }
3469}
3470
3471#[allow(clippy::too_many_arguments)]
3472pub fn dit_split_only(
3473    qkv: &[f32],
3474    nh: usize,
3475    n: usize,
3476    hd: usize,
3477    layout: u32,
3478    norm: Option<(&[f32], f32)>,
3479    out_q: &mut [f32],
3480) -> bool {
3481    match backend() {
3482        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3483        Backend::Wgpu => crate::gpu_wgpu::dit_split_only(qkv, nh, n, hd, layout, norm, out_q),
3484        #[allow(unreachable_patterns)]
3485        _ => false,
3486    }
3487}
3488
3489/// The backend's f32 NT GEMM: `y[n×m] = x[n×k] · wᵀ[m×k]`. Tensor
3490/// cores where the card has them. Refuses under `CMF_BAKE_GPU=0` or
3491/// strict f32, and for jobs below n·k·m = 4M, where the round trip
3492/// costs more than the arithmetic saves.
3493/// `gemm_nt_f32` whose `w` is known to change every call (an
3494/// accumulation over fresh activations, not a weight): it skips the
3495/// resident ledger and its per-call fingerprint of the whole operand.
3496pub fn gemm_nt_f32_transient(
3497    x: &[f32],
3498    w: &[f32],
3499    y: &mut [f32],
3500    n: usize,
3501    k: usize,
3502    m: usize,
3503) -> bool {
3504    match backend() {
3505        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3506        Backend::Wgpu => crate::gpu_wgpu::gemm_nt_f32_transient(x, w, y, n, k, m),
3507        #[allow(unreachable_patterns)]
3508        _ => false,
3509    }
3510}
3511
3512pub fn gemm_nt_f32(x: &[f32], w: &[f32], y: &mut [f32], n: usize, k: usize, m: usize) -> bool {
3513    match backend() {
3514        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3515        Backend::Wgpu => crate::gpu_wgpu::gemm_nt_f32(x, w, y, n, k, m),
3516        #[allow(unreachable_patterns)]
3517        _ => false,
3518    }
3519}
3520
3521/// Music-3's FFN chain resident on the device — two GEMMs and the GLU
3522/// between them with no host round trip. `false` = refused, host runs.
3523#[allow(clippy::too_many_arguments)]
3524pub fn music3_ffn(
3525    model: &std::sync::Arc<CmfModel>,
3526    idx_in: usize,
3527    idx_out: usize,
3528    h: &[f32],
3529    bias_in: &[f32],
3530    n: usize,
3531    hs: usize,
3532    inter: usize,
3533    out: &mut [f32],
3534) -> bool {
3535    match backend() {
3536        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3537        Backend::Wgpu => {
3538            crate::gpu_wgpu::music3_ffn(model, idx_in, idx_out, h, bias_in, n, hs, inter, out)
3539        }
3540        #[allow(unreachable_patterns)]
3541        _ => false,
3542    }
3543}
3544
3545/// A 1D convolution as a GEMM whose column matrix is expanded on the
3546/// device instead of being built, transposed and uploaded by the host.
3547/// `yt` comes back `[out_n x oc]`. `false` = refused, caller runs host.
3548#[allow(clippy::too_many_arguments)]
3549pub fn conv1d_gemm(
3550    x: &[f32],
3551    w: &[f32],
3552    ic: usize,
3553    oc: usize,
3554    n: usize,
3555    k: usize,
3556    pad: usize,
3557    dil: usize,
3558    out_n: usize,
3559    yt: &mut [f32],
3560) -> bool {
3561    match backend() {
3562        #[cfg(target_os = "macos")]
3563        Backend::Metal => crate::gpu_metal::conv1d_gemm(x, w, ic, oc, n, k, pad, dil, out_n, yt),
3564        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3565        Backend::Wgpu => crate::gpu_wgpu::conv1d_gemm(x, w, ic, oc, n, k, pad, dil, out_n, yt),
3566        #[allow(unreachable_patterns)]
3567        _ => false,
3568    }
3569}
3570
3571/// The convolution as a GEMM on the matrix units. `false` = refused.
3572#[allow(clippy::too_many_arguments)]
3573pub fn vae_conv2d_coop(
3574    w: &[f32],
3575    bias: Option<&[f32]>,
3576    x: &[f32],
3577    ic: usize,
3578    oc: usize,
3579    h: usize,
3580    wi: usize,
3581    k: usize,
3582    out: &mut [f32],
3583) -> bool {
3584    match backend() {
3585        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3586        Backend::Wgpu => crate::gpu_wgpu::vae_conv2d_coop(w, bias, x, ic, oc, h, wi, k, out),
3587        #[allow(unreachable_patterns)]
3588        _ => false,
3589    }
3590}
3591
3592pub fn dit_attention_packed(
3593    qkv: &[f32],
3594    nh: usize,
3595    n: usize,
3596    hd: usize,
3597    scale: f32,
3598    // (rope angles, q norm weights, k norm weights, eps) when the device
3599    // should apply qk-norm and RoPE itself; None when the host already did.
3600    nr: Option<(&[f32], &[f32], &[f32], f32)>,
3601    out: &mut [f32],
3602) -> bool {
3603    match backend() {
3604        // wgpu carries the only implementation, and it is not
3605        // platform-specific: `CMF_GPU=wgpu` on macOS runs it over Metal
3606        // like anywhere else. It used to be compiled out here on macOS,
3607        // which made the call a silent `false` — and the caller's
3608        // `assert!` turned that refusal into a panic on every
3609        // `cortiq animate` this platform ever ran.
3610        #[cfg(feature = "gpu")]
3611        Backend::Wgpu => crate::gpu_wgpu::dit_attention_packed(qkv, nh, n, hd, scale, nr, out),
3612        #[allow(unreachable_patterns)]
3613        _ => false,
3614    }
3615}
3616
3617/// Whether `dit_attention_packed` has an implementation on the backend
3618/// that is actually selected.
3619///
3620/// The caller has to know BEFORE it skips the host qk-norm: deferring
3621/// the norm to a device that then refuses leaves q/k unnormalized with
3622/// no way back. Native Metal has no packed kernel, so on macOS this is
3623/// false unless `CMF_GPU=wgpu` picked the other backend.
3624pub fn dit_attention_packed_available() -> bool {
3625    #[allow(unreachable_patterns)]
3626    match backend() {
3627        #[cfg(feature = "gpu")]
3628        Backend::Wgpu => crate::gpu_wgpu::dit_attention_packed_ready(),
3629        _ => false,
3630    }
3631}
3632
3633pub fn dit_attention(
3634    qh: &[f32],
3635    kh: &[f32],
3636    vh: &[f32],
3637    nh: usize,
3638    nkv: usize,
3639    n: usize,
3640    hd: usize,
3641    scale: f32,
3642    out: &mut [f32],
3643) -> bool {
3644    match backend() {
3645        #[cfg(target_os = "macos")]
3646        Backend::Metal => crate::gpu_metal::dit_attention(qh, kh, vh, nh, nkv, n, hd, scale, out),
3647        #[cfg(feature = "gpu")]
3648        Backend::Wgpu => crate::gpu_wgpu::dit_attention(qh, kh, vh, nh, nkv, n, hd, scale, out),
3649        #[allow(unreachable_patterns)]
3650        _ => false,
3651    }
3652}
3653
3654/// GPTQ calibration: a zeroed `cols × cols` Hessian accumulator on the
3655/// device (wgpu only), or None — the caller keeps the host fold then.
3656pub fn gram_alloc(cols: usize) -> Option<u64> {
3657    #[cfg(feature = "gpu")]
3658    if backend() == Backend::Wgpu {
3659        return crate::gpu_wgpu::gram::alloc(cols);
3660    }
3661    let _ = cols;
3662    None
3663}
3664
3665/// `H[id] += XᵀX` over `b` rows of `xs` (`[b·cols]`).
3666pub fn gram_add(id: u64, xs: &[f32], b: usize) -> bool {
3667    #[cfg(feature = "gpu")]
3668    if backend() == Backend::Wgpu {
3669        return crate::gpu_wgpu::gram::add(id, xs, b);
3670    }
3671    let _ = (id, xs, b);
3672    false
3673}
3674
3675/// `H[id] += XᵀX` over `b` rows of a device-resident f32 buffer.
3676#[cfg(feature = "gpu")]
3677pub fn gram_add_dev(id: u64, x: &wgpu::Buffer, b: usize) -> bool {
3678    if backend() == Backend::Wgpu {
3679        return crate::gpu_wgpu::gram::add_dev(id, x, b);
3680    }
3681    false
3682}
3683
3684/// The accumulated Hessian as a full symmetric f64 matrix (frees it).
3685pub fn gram_take(id: u64) -> Option<Vec<f64>> {
3686    #[cfg(feature = "gpu")]
3687    if backend() == Backend::Wgpu {
3688        return crate::gpu_wgpu::gram::take(id);
3689    }
3690    let _ = id;
3691    None
3692}
3693
3694/// GPTQ fold of the device Hessian `h_id` on the device: the upper Cholesky
3695/// factor of `(H + λ·mean(diag)·I)⁻¹` stays there under the returned id and
3696/// the Hessian is freed. None (no wgpu device, it does not fit, it does not
3697/// factor): the Hessian is left for `gram_take`.
3698pub fn gptq_fold_dev(h_id: u64, n: usize, lambda: f64) -> Option<u64> {
3699    #[cfg(feature = "gpu")]
3700    if backend() == Backend::Wgpu {
3701        return crate::gpu_wgpu::gptq_dev::fold(h_id, n, lambda);
3702    }
3703    let _ = (h_id, n, lambda);
3704    None
3705}
3706
3707/// (dead channels, raw H diagonal, damping used) of a device fold.
3708pub fn gptq_fold_info(id: u64) -> Option<(Vec<bool>, Vec<f32>, f64)> {
3709    #[cfg(feature = "gpu")]
3710    if backend() == Backend::Wgpu {
3711        return crate::gpu_wgpu::gptq_dev::info(id);
3712    }
3713    let _ = id;
3714    None
3715}
3716
3717/// A device fold's operator read back (n×n f32, upper).
3718pub fn gptq_fold_read(id: u64) -> Option<Vec<f32>> {
3719    #[cfg(feature = "gpu")]
3720    if backend() == Backend::Wgpu {
3721        return crate::gpu_wgpu::gptq_dev::read_u(id);
3722    }
3723    let _ = id;
3724    None
3725}
3726
3727/// Free a device fold.
3728pub fn gptq_fold_free(id: u64) {
3729    #[cfg(feature = "gpu")]
3730    if backend() == Backend::Wgpu {
3731        crate::gpu_wgpu::gptq_dev::free(id);
3732    }
3733    let _ = id;
3734}
3735
3736/// The q4tp GPTQ sweep on the device (see `gpu_wgpu::gptq_dev::sweep_q4tp`).
3737#[allow(clippy::too_many_arguments)]
3738pub fn gptq_sweep_q4tp_dev(
3739    id: u64,
3740    w: &[f32],
3741    rows: usize,
3742    tab: &[f32],
3743    lost: &[f32],
3744    nib: &mut [u8],
3745    codes: &mut [u32],
3746) -> bool {
3747    #[cfg(feature = "gpu")]
3748    if backend() == Backend::Wgpu {
3749        return crate::gpu_wgpu::gptq_dev::sweep_q4tp(id, w, rows, tab, lost, nib, codes);
3750    }
3751    let _ = (id, w, rows, tab, lost, nib, codes);
3752    false
3753}
3754
3755/// The q2tp GPTQ sweep ("placed" rule) on the device.
3756pub fn gptq_sweep_q2tp_dev(
3757    id: u64,
3758    w: &[f32],
3759    rows: usize,
3760    tab: &[f32],
3761    hw: &[f32],
3762    chunks: &mut [u8],
3763    codes: &mut [u32],
3764) -> bool {
3765    #[cfg(feature = "gpu")]
3766    if backend() == Backend::Wgpu {
3767        return crate::gpu_wgpu::gptq_dev::sweep_q2tp(id, w, rows, tab, hw, chunks, codes);
3768    }
3769    let _ = (id, w, rows, tab, hw, chunks, codes);
3770    false
3771}
3772
3773/// A device Hessian read back as a full symmetric f64 matrix, left on the
3774/// device.
3775pub fn gram_read(id: u64) -> Option<Vec<f64>> {
3776    #[cfg(feature = "gpu")]
3777    if backend() == Backend::Wgpu {
3778        return crate::gpu_wgpu::gram::read(id);
3779    }
3780    let _ = id;
3781    None
3782}
3783
3784/// Free every device Hessian (an aborted calibration pass).
3785pub fn gram_clear() {
3786    #[cfg(feature = "gpu")]
3787    if backend() == Backend::Wgpu {
3788        crate::gpu_wgpu::gram::clear();
3789    }
3790}
3791
3792/// Batched q4t GEMM on the device (imagegen DiT prefill shapes).
3793/// Metal: q4t_mul_mm decodes the mmap-resident tiles inside the
3794/// GEMM's K loop. wgpu (Vulkan/DX12 → NVIDIA/AMD/Intel/Adreno/Mali):
3795/// the register-blocked WGSL twin, weights cached in VRAM.
3796#[allow(unused_variables)]
3797pub fn q4tp_matmat(
3798    model: &Arc<CmfModel>,
3799    idx: usize,
3800    xs: &[f32],
3801    b: usize,
3802    rows: usize,
3803    cols: usize,
3804    out: &mut [f32],
3805) -> bool {
3806    match backend() {
3807        #[cfg(target_os = "macos")]
3808        Backend::Metal => crate::gpu_metal::q4tp_matmat(model, idx, xs, b, rows, cols, out),
3809        #[cfg(feature = "gpu")]
3810        Backend::Wgpu => crate::gpu_wgpu::q4tp_matmat(model, idx, xs, b, rows, cols, out),
3811        #[allow(unreachable_patterns)]
3812        _ => false,
3813    }
3814}
3815
3816/// The same over a two-bit weight plane. Native Metal uses the dedicated
3817/// q2tp tile; unsupported shapes return false and preserve the host fallback.
3818pub fn q2tp_matmat(
3819    model: &Arc<CmfModel>,
3820    idx: usize,
3821    xs: &[f32],
3822    b: usize,
3823    rows: usize,
3824    cols: usize,
3825    out: &mut [f32],
3826) -> bool {
3827    match backend() {
3828        #[cfg(target_os = "macos")]
3829        Backend::Metal => crate::gpu_metal::q2tp_matmat(model, idx, xs, b, rows, cols, out),
3830        #[cfg(feature = "gpu")]
3831        Backend::Wgpu => crate::gpu_wgpu::q2tp_matmat(model, idx, xs, b, rows, cols, out),
3832        #[allow(unreachable_patterns)]
3833        _ => false,
3834    }
3835}
3836
3837/// Descriptor-aware q2tp GEMM. The affine center is selected only for a
3838/// validated q2tp_affine target; the raw dtype16 payload remains unchanged.
3839pub fn q2tp_affine_matmat(
3840    model: &Arc<CmfModel>,
3841    idx: usize,
3842    xs: &[f32],
3843    b: usize,
3844    rows: usize,
3845    cols: usize,
3846    out: &mut [f32],
3847) -> bool {
3848    match backend() {
3849        #[cfg(target_os = "macos")]
3850        Backend::Metal => crate::gpu_metal::q2tp_affine_matmat(model, idx, xs, b, rows, cols, out),
3851        #[cfg(feature = "gpu")]
3852        Backend::Wgpu => crate::gpu_wgpu::q2tp_affine_matmat(model, idx, xs, b, rows, cols, out),
3853        #[allow(unreachable_patterns)]
3854        _ => false,
3855    }
3856}
3857
3858/// Binary low-rank (`blr`) product on the device: `out[b·rows] = xs[b·cols] ·
3859/// Wᵀ` through the two ±1 stages (V then U). `b = 1` is the decode GEMV.
3860/// False = not taken (no wgpu backend — Metal has no blr kernel yet — or a
3861/// shape outside the kernel's contract): the caller runs the CPU kernels.
3862pub fn blr_matmat(t: &crate::blr::BlrTensor, xs: &[f32], b: usize, out: &mut [f32]) -> bool {
3863    match backend() {
3864        #[cfg(feature = "gpu")]
3865        Backend::Wgpu => crate::gpu_wgpu::blr_matmat(t, xs, b, out),
3866        #[allow(unreachable_patterns)]
3867        _ => {
3868            let _ = (t, xs, b, out);
3869            false
3870        }
3871    }
3872}
3873
3874/// Single-token q2tp matvec through the ordinary (center=1.5) WGSL kernel.
3875pub fn q2tp_matvec(
3876    model: &Arc<CmfModel>,
3877    idx: usize,
3878    xs: &[f32],
3879    rows: usize,
3880    cols: usize,
3881    out: &mut [f32],
3882) -> bool {
3883    match backend() {
3884        #[cfg(target_os = "macos")]
3885        Backend::Metal => crate::gpu_metal::q2tp_matvec(model, idx, xs, rows, cols, out),
3886        #[cfg(feature = "gpu")]
3887        Backend::Wgpu => crate::gpu_wgpu::q2tp_matvec(model, idx, xs, rows, cols, out),
3888        #[allow(unreachable_patterns)]
3889        _ => false,
3890    }
3891}
3892
3893/// Single-token q2tp matvec with the explicit affine center=1 descriptor
3894/// operator. This is kept separate from ordinary q2tp to make accidental
3895/// center changes impossible at a call site.
3896pub fn q2tp_affine_matvec(
3897    model: &Arc<CmfModel>,
3898    idx: usize,
3899    xs: &[f32],
3900    rows: usize,
3901    cols: usize,
3902    out: &mut [f32],
3903) -> bool {
3904    match backend() {
3905        #[cfg(target_os = "macos")]
3906        Backend::Metal => crate::gpu_metal::q2tp_affine_matvec(model, idx, xs, rows, cols, out),
3907        #[cfg(feature = "gpu")]
3908        Backend::Wgpu => crate::gpu_wgpu::q2tp_affine_matvec(model, idx, xs, rows, cols, out),
3909        #[allow(unreachable_patterns)]
3910        _ => false,
3911    }
3912}
3913
3914/// Single-token q4tp matvec on the device — the lm_head class. Through the
3915/// DEDICATED matvec kernel: the batched GEMM at b=1 measured 11.73 ms
3916/// against the host's 9.51 on the release head, so the route that was
3917/// supposed to save eleven milliseconds a token lost its own probe instead.
3918pub fn q4tp_matvec(
3919    model: &Arc<CmfModel>,
3920    idx: usize,
3921    xs: &[f32],
3922    rows: usize,
3923    cols: usize,
3924    out: &mut [f32],
3925) -> bool {
3926    match backend() {
3927        #[cfg(target_os = "macos")]
3928        Backend::Metal => crate::gpu_metal::q4tp_matvec_for_test(model, idx, xs, rows, cols, out),
3929        #[cfg(feature = "gpu")]
3930        Backend::Wgpu => crate::gpu_wgpu::q4tp_matvec(model, idx, xs, rows, cols, out),
3931        #[allow(unreachable_patterns)]
3932        _ => false,
3933    }
3934}
3935
3936/// Single-token q4_tiled matvec on the device — the lm_head class (a
3937/// q4t checkpoint's head is its biggest host matvec, exactly like the
3938/// q4tp twin above). wgpu holds q4t_mv pipelines only inside the graph
3939/// encoder — the standalone arm stays an honest refusal until a
3940/// discrete-GPU q4t model reaches the bench.
3941pub fn q4t_matvec(
3942    model: &Arc<CmfModel>,
3943    idx: usize,
3944    xs: &[f32],
3945    rows: usize,
3946    cols: usize,
3947    out: &mut [f32],
3948) -> bool {
3949    match backend() {
3950        #[cfg(target_os = "macos")]
3951        Backend::Metal => crate::gpu_metal::q4t_matvec_for_test(model, idx, xs, rows, cols, out),
3952        #[allow(unreachable_patterns)]
3953        _ => false,
3954    }
3955}
3956
3957pub fn q4t_matmat(
3958    model: &Arc<CmfModel>,
3959    idx: usize,
3960    xs: &[f32],
3961    b: usize,
3962    rows: usize,
3963    cols: usize,
3964    out: &mut [f32],
3965) -> bool {
3966    match backend() {
3967        #[cfg(target_os = "macos")]
3968        Backend::Metal => crate::gpu_metal::q4t_matmat(model, idx, xs, b, rows, cols, out),
3969        #[cfg(feature = "gpu")]
3970        Backend::Wgpu => crate::gpu_wgpu::q4t_matmat(model, idx, xs, b, rows, cols, out),
3971        #[allow(unreachable_patterns)]
3972        _ => false,
3973    }
3974}
3975
3976/// Whole-block token-graph types re-exported from the Metal backend.
3977#[cfg(target_os = "macos")]
3978pub use crate::gpu_metal::{
3979    AttnDeviceParams, AttnGpuLayer, GdnGpuCfg, GdnGpuLayer, GpuMoe, GraphDims, MetalFfn,
3980    O1AttnParams, TokenGraph, kv_mirror_drop, kv_mirror_read_last, kv_mirror_take_imp,
3981};
3982
3983/// A BLOCK of consecutive q1 GDN layers in one submission (Metal only).
3984#[cfg(target_os = "macos")]
3985pub fn gdn_block(
3986    model: &Arc<CmfModel>,
3987    layers: &[GdnGpuLayer],
3988    states: &mut [&mut [f32]],
3989    cfg: &GdnGpuCfg,
3990    h: &mut [f32],
3991) -> bool {
3992    match backend() {
3993        Backend::Metal => crate::gpu_metal::gdn_block(model, layers, states, cfg, h),
3994        _ => false,
3995    }
3996}
3997
3998/// A layer's MoE-FFN in one submission (amortizing the dispatch cost).
3999#[allow(unused_variables)]
4000pub fn moe_block(model: &Arc<CmfModel>, jobs: &[MoeJob], out: &mut [f32]) -> bool {
4001    match backend() {
4002        // The Metal block applies SiLU only: any other activation is an
4003        // honest refusal (the caller keeps its host path).
4004        #[cfg(target_os = "macos")]
4005        Backend::Metal if jobs.iter().any(|j| j.act != 0) => false,
4006        #[cfg(target_os = "macos")]
4007        Backend::Metal => crate::gpu_metal::moe_block(model, jobs, out),
4008        #[cfg(feature = "gpu")]
4009        Backend::Wgpu => crate::gpu_wgpu::moe_block(model, jobs, out),
4010        Backend::None => false,
4011    }
4012}
4013
4014/// Independent matvecs of one input in a single submission (GDN projections).
4015#[allow(unused_variables)]
4016pub fn matvec_batch(model: &Arc<CmfModel>, jobs: &[BatchJob], out: &mut [&mut [f32]]) -> bool {
4017    match backend() {
4018        #[cfg(target_os = "macos")]
4019        Backend::Metal => crate::gpu_metal::matvec_batch(model, jobs, out),
4020        #[cfg(feature = "gpu")]
4021        Backend::Wgpu => crate::gpu_wgpu::matvec_batch(model, jobs, out),
4022        Backend::None => false,
4023    }
4024}
4025
4026// ── Whole-token wgpu graph race (generation granularity) ─────────────
4027// On integrated/mobile adapters the graph is neither trusted nor banned
4028// a priori — it RACES the normal path: generations alternate arms (the
4029// normal path first — known-good UX — then the graph), per-token wall
4030// times accumulate per arm, and once both arms have enough steady
4031// samples the faster one wins for the process. Arm switches happen ONLY
4032// at generation boundaries (`kv_cache.clear()` resets state), so the
4033// device KV mirror and the CPU cache never diverge mid-sequence. The
4034// single exception is the first-token bail: the very first decode token
4035// of a graph generation may be discarded and recomputed on the CPU
4036// path (the prompt KV is CPU-owned at that point, so this is safe) —
4037// a tiled mobile GPU that drains its pipeline at every barrier turns
4038// the ~300-dispatch graph into seconds per token (field report: 0.2
4039// tok/s vs 15 on the CPU), and one token is all it takes to see that.
4040static GRAPH_RACE_STATE: AtomicU8 = AtomicU8::new(0); // 0 racing, 1 graph won, 2 normal won
4041static GRAPH_RACE_FLIP: AtomicU32 = AtomicU32::new(0);
4042static GRAPH_RACE_ARM_GRAPH: AtomicU8 = AtomicU8::new(0); // this generation's arm
4043static GRAPH_RACE_TOK: AtomicU32 = AtomicU32::new(0); // token index within the generation
4044static GRAPH_NS: [AtomicU64; 2] = [AtomicU64::new(0), AtomicU64::new(0)]; // [normal, graph]
4045static GRAPH_N: [AtomicU32; 2] = [AtomicU32::new(0), AtomicU32::new(0)];
4046
4047/// Steady per-token samples per arm before the race decides.
4048const GRAPH_RACE_SAMPLES: u32 = 4;
4049
4050// A graph that cannot be built for THIS model will never build: the
4051// refusal is a property of the weights, not of the moment. Retrying it
4052// per token is not free — the builder walks every layer and asks each
4053// tensor for a graph view before giving up at layer 0 — and on an
4054// Adreno 642L that retry cost 3x: forcing the graph on a model it
4055// refuses measured 0.3 tok/s against 0.905 for the per-op path it falls
4056// back to. Remembered once, the fallback runs at its own speed.
4057//
4058// The verdict is kept PER PIPELINE (`Pipeline::graph_refused` /
4059// `mark_graph_refused`), not in a process-wide flag: several pipelines
4060// of one file share a process in `serve` (backbone slots + skill lanes
4061// loaded mid-traffic), and a refusal in one lane — or the reset a new
4062// lane used to issue — must not move another lane's running sequence
4063// between the device and the host (R4/NF-2). Callers must NOT report
4064// transient refusals (an unsealed o1 state during prefill, a softcap).
4065
4066/// Called at every generation start (fresh KV). Applies a pending
4067/// verdict and picks this generation's arm while racing.
4068pub fn graph_race_begin_generation() {
4069    // One generation has now compiled whatever this model needs; keep it
4070    // for the next process. Once per run: the blob does not grow after
4071    // the pipelines exist, and the write is megabytes against the ~200 s
4072    // of compiling it saves on the device that needed this.
4073    #[cfg(feature = "gpu")]
4074    {
4075        // Save once, at the start of the SECOND generation: the first
4076        // has dispatched, so there is something to keep, and nothing is
4077        // saved before any work (the driver compiles at first use, not
4078        // at pipeline creation — the context comes up in 1.5 s while the
4079        // compiling costs minutes).
4080        //
4081        // Flushing again on 4, 8, 16 … was tried on the theory that a
4082        // chat turn compiles shapes the first one did not. It buys
4083        // nothing: a fresh app process still spent 49.0 s, then 58.7,
4084        // then 61.3 on its first answer with the backoff in place. One
4085        // flush it is.
4086        static FLUSHED: std::sync::Once = std::sync::Once::new();
4087        static FIRST: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(true);
4088        if FIRST.swap(false, Ordering::Relaxed) {
4089            // Nothing dispatched yet.
4090        } else {
4091            FLUSHED.call_once(crate::gpu_wgpu::pipeline_cache_flush);
4092        }
4093    }
4094    GRAPH_RACE_TOK.store(0, Ordering::Relaxed);
4095    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
4096        return;
4097    }
4098    let (gn, cn) = (
4099        GRAPH_N[1].load(Ordering::Relaxed),
4100        GRAPH_N[0].load(Ordering::Relaxed),
4101    );
4102    if gn >= GRAPH_RACE_SAMPLES && cn >= GRAPH_RACE_SAMPLES {
4103        let g_avg = GRAPH_NS[1].load(Ordering::Relaxed) / gn as u64;
4104        let c_avg = GRAPH_NS[0].load(Ordering::Relaxed) / cn as u64;
4105        let verdict = if g_avg < c_avg { 1 } else { 2 };
4106        GRAPH_RACE_STATE.store(verdict, Ordering::Relaxed);
4107        tracing::info!(
4108            "wgpu graph race: graph {:.2} ms/tok vs normal {:.2} ms/tok -> {}",
4109            g_avg as f64 / 1e6,
4110            c_avg as f64 / 1e6,
4111            if verdict == 1 { "graph" } else { "normal path" }
4112        );
4113        return;
4114    }
4115    let flip = GRAPH_RACE_FLIP.fetch_add(1, Ordering::Relaxed);
4116    GRAPH_RACE_ARM_GRAPH.store((flip % 2 == 1) as u8, Ordering::Relaxed);
4117}
4118
4119/// Should this decode token try the graph? `trusted` (discrete adapter,
4120/// explicit env, or a GDN hybrid whose state lives on the device) skips
4121/// the race entirely.
4122pub fn graph_race_use_graph(trusted: bool) -> bool {
4123    if trusted {
4124        return true;
4125    }
4126    match GRAPH_RACE_STATE.load(Ordering::Relaxed) {
4127        1 => true,
4128        2 => false,
4129        _ => GRAPH_RACE_ARM_GRAPH.load(Ordering::Relaxed) == 1,
4130    }
4131}
4132
4133/// First decode token of a racing graph generation: hopeless already?
4134/// (>4x the normal path's per-token average AND over a second.) Settles
4135/// the race immediately; the caller discards the graph result and
4136/// recomputes this token on the normal path.
4137pub fn graph_race_first_token_hopeless(dur: std::time::Duration) -> bool {
4138    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
4139        return false;
4140    }
4141    let first = GRAPH_RACE_TOK.load(Ordering::Relaxed) == 0;
4142    let cn = GRAPH_N[0].load(Ordering::Relaxed);
4143    if !first || cn == 0 {
4144        return false;
4145    }
4146    let c_avg = GRAPH_NS[0].load(Ordering::Relaxed) / cn as u64;
4147    let ns = dur.as_nanos() as u64;
4148    if ns > 1_000_000_000 && ns > 4 * c_avg {
4149        GRAPH_RACE_STATE.store(2, Ordering::Relaxed);
4150        tracing::info!(
4151            "wgpu graph race: first graph token {:.0} ms vs normal {:.2} ms/tok — hopeless, normal path wins",
4152            ns as f64 / 1e6,
4153            c_avg as f64 / 1e6
4154        );
4155        return true;
4156    }
4157    false
4158}
4159
4160/// Record one decode-token wall time for the racing arm. The first
4161/// token of each generation is discarded (KV-mirror upload / cold
4162/// caches on the graph arm; cold mmap on the normal arm).
4163pub fn graph_race_record(used_graph: bool, dur: std::time::Duration) {
4164    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
4165        return;
4166    }
4167    let tok = GRAPH_RACE_TOK.fetch_add(1, Ordering::Relaxed);
4168    if tok == 0 {
4169        return;
4170    }
4171    let i = used_graph as usize;
4172    GRAPH_NS[i].fetch_add(dur.as_nanos() as u64, Ordering::Relaxed);
4173    GRAPH_N[i].fetch_add(1, Ordering::Relaxed);
4174}
4175
4176/// Bounded-cost content fingerprint for the backends' pointer-keyed device
4177/// caches: FNV over the whole slice up to 4 KiB, over 64 spread 64-byte
4178/// windows (plus the length) above. An address-keyed hit must also prove
4179/// the bytes are still the ones it uploaded — the allocator reuses heap
4180/// and mmap addresses freely, so a reloaded model or a re-dequantized
4181/// layer lands where the old bytes were — and sampling keeps that proof at
4182/// ~a microsecond even for a 126 MB matrix. Real replacements (another
4183/// model's tensor, an Adam-updated master) differ densely, so a 4 KiB
4184/// spread cannot miss them.
4185pub(crate) fn fp_bytes(data: &[u8]) -> u64 {
4186    #[inline]
4187    fn fnv(mut h: u64, bytes: &[u8]) -> u64 {
4188        let (chunks, tail) = bytes.split_at(bytes.len() & !7);
4189        for c in chunks.chunks_exact(8) {
4190            h ^= u64::from_le_bytes(c.try_into().unwrap());
4191            h = h.wrapping_mul(0x100_0000_01b3);
4192        }
4193        for &b in tail {
4194            h ^= b as u64;
4195            h = h.wrapping_mul(0x100_0000_01b3);
4196        }
4197        h
4198    }
4199    let mut h = 0xcbf2_9ce4_8422_2325u64 ^ (data.len() as u64);
4200    if data.len() <= 4096 {
4201        return fnv(h, data);
4202    }
4203    let step = (data.len() - 64) / 63;
4204    for i in 0..64 {
4205        h = fnv(h, &data[i * step..i * step + 64]);
4206    }
4207    h
4208}
4209
4210/// `fp_bytes` over an f32 slice without a bytemuck dependency (the Metal
4211/// backend builds with no GPU feature flags).
4212pub(crate) fn fp_f32(data: &[f32]) -> u64 {
4213    let bytes = unsafe { std::slice::from_raw_parts(data.as_ptr() as *const u8, data.len() * 4) };
4214    fp_bytes(bytes)
4215}
4216
4217#[cfg(test)]
4218mod fp_tests {
4219    use super::fp_bytes;
4220
4221    /// The pointer-keyed caches survive on `fp_bytes` telling two different
4222    /// tensors apart at a reused address. Its sampling must therefore see a
4223    /// change ANYWHERE — head, tail, and the stretches between windows are
4224    /// the places a cheaper hash would go blind.
4225    #[test]
4226    fn fp_bytes_sees_a_change_anywhere_in_a_sampled_slice() {
4227        let n = 1 << 20; // 1 MiB — far above the 4 KiB full-hash threshold
4228        let base: Vec<u8> = (0..n).map(|i| (i * 31 + 7) as u8).collect();
4229        let h0 = fp_bytes(&base);
4230        assert_eq!(h0, fp_bytes(&base), "fingerprint must be deterministic");
4231        // A DENSE change (every requantized/redequantized tensor is one)
4232        // must flip the fingerprint no matter how the windows fall.
4233        let mut dense = base.clone();
4234        for b in dense.iter_mut() {
4235            *b = b.wrapping_add(1);
4236        }
4237        assert_ne!(
4238            h0,
4239            fp_bytes(&dense),
4240            "a fully different tensor slipped through"
4241        );
4242        // Length participates: the same prefix at a shorter length is a
4243        // different key AND a different fingerprint.
4244        assert_ne!(h0, fp_bytes(&base[..n - 64]));
4245        // Below the threshold the hash is exact: a single flipped byte in
4246        // a norm-sized vector must be seen.
4247        let mut small = vec![3u8; 4096];
4248        let hs = fp_bytes(&small);
4249        small[2048] ^= 1;
4250        assert_ne!(hs, fp_bytes(&small), "full hash missed a one-byte change");
4251        // And the sampled windows land within bounds on awkward sizes.
4252        for n in [4097usize, 5000, 64 * 64, 1 << 16] {
4253            let v = vec![9u8; n];
4254            let _ = fp_bytes(&v); // must not panic on window math
4255        }
4256    }
4257}
4258
4259/// Hand the card back after a bake: drop its resident weights, planes and
4260/// pools so the ordinary engine (the runtime gate, a serve that follows)
4261/// starts from a clean budget. No-op off the wgpu backend.
4262pub fn bake_release() {
4263    #[cfg(feature = "gpu")]
4264    crate::gpu_wgpu::bake_release();
4265}
4266
4267/// Strict-f32 for the bake's GEMMs (phase A mask training): the mask
4268/// selects neurons by a gradient signal, and f16 operand rounding on
4269/// that signal closes the wrong ones. No-op off the wgpu backend.
4270pub fn bake_precision_strict(on: bool) {
4271    #[cfg(feature = "gpu")]
4272    crate::gpu_wgpu::bake_precision_strict(on);
4273    #[cfg(not(feature = "gpu"))]
4274    let _ = on;
4275}
4276
4277/// CMF_GRAPH_HOSTPROF=1: how a graph token's wall splits between the
4278/// host encoding the command stream and the tail the GPU still owes
4279/// after encode. Fifteen GPU-side suspects measured null while the
4280/// bench counted 17.7k allocations a token — this is the instrument
4281/// that says whether the thief was on the host all along.
4282pub fn hostprof_encode_done(t0: std::time::Instant) {
4283    use std::sync::atomic::{AtomicU64, Ordering};
4284    static ENC: AtomicU64 = AtomicU64::new(0);
4285    static N: AtomicU64 = AtomicU64::new(0);
4286    if std::env::var("CMF_GRAPH_HOSTPROF").as_deref() != Ok("1") {
4287        return;
4288    }
4289    ENC.fetch_add(t0.elapsed().as_nanos() as u64, Ordering::Relaxed);
4290    let n = N.fetch_add(1, Ordering::Relaxed) + 1;
4291    if n % 100 == 0 {
4292        eprintln!(
4293            "hostprof: encode {:.2} ms/token over {n} tokens",
4294            ENC.load(Ordering::Relaxed) as f64 / n as f64 / 1e6
4295        );
4296    }
4297}
4298
4299pub fn hostprof_total(t0: std::time::Instant) {
4300    use std::sync::atomic::{AtomicU64, Ordering};
4301    static TOT: AtomicU64 = AtomicU64::new(0);
4302    static N: AtomicU64 = AtomicU64::new(0);
4303    if std::env::var("CMF_GRAPH_HOSTPROF").as_deref() != Ok("1") {
4304        return;
4305    }
4306    TOT.fetch_add(t0.elapsed().as_nanos() as u64, Ordering::Relaxed);
4307    let n = N.fetch_add(1, Ordering::Relaxed) + 1;
4308    if n % 100 == 0 {
4309        eprintln!(
4310            "hostprof: total {:.2} ms/token over {n} tokens",
4311            TOT.load(Ordering::Relaxed) as f64 / n as f64 / 1e6
4312        );
4313    }
4314}
4315
4316/// Per-stage host-encode accumulator for the Metal token loop
4317/// (CMF_GRAPH_HOSTPROF=1). Stage 0 = GDN-run encode; everything else
4318/// falls out by subtraction from hostprof's encode total.
4319pub fn stageprof(stage: u32, dt: std::time::Duration) {
4320    use std::sync::atomic::{AtomicU64, Ordering};
4321    static NS: [AtomicU64; 4] = [
4322        AtomicU64::new(0),
4323        AtomicU64::new(0),
4324        AtomicU64::new(0),
4325        AtomicU64::new(0),
4326    ];
4327    static N: AtomicU64 = AtomicU64::new(0);
4328    if std::env::var("CMF_GRAPH_HOSTPROF").as_deref() != Ok("1") {
4329        return;
4330    }
4331    NS[stage as usize % 4].fetch_add(dt.as_nanos() as u64, Ordering::Relaxed);
4332    if stage == 1 {
4333        let n = N.fetch_add(1, Ordering::Relaxed) + 1;
4334        if n % 200 == 0 {
4335            eprintln!(
4336                "stageprof: planning {:.2} ms/tok | gdn-item {:.2} ms/tok | attn-item {:.2} ms/tok ({n} tok)",
4337                NS[1].load(Ordering::Relaxed) as f64 / n as f64 / 1e6,
4338                NS[2].load(Ordering::Relaxed) as f64 / n as f64 / 1e6,
4339                NS[3].load(Ordering::Relaxed) as f64 / n as f64 / 1e6
4340            );
4341        }
4342    }
4343}
4344
4345/// Active weight bytes dispatched so far (Metal decode path); 0 where
4346/// the backend does not count. The honest floor's numerator.
4347pub fn weight_bytes_dispatched() -> u64 {
4348    let mut total = 0u64;
4349    #[cfg(target_os = "macos")]
4350    {
4351        total += crate::gpu_metal::WEIGHT_BYTES.load(std::sync::atomic::Ordering::Relaxed);
4352    }
4353    #[cfg(feature = "gpu")]
4354    {
4355        total += crate::gpu_wgpu::WEIGHT_BYTES.load(std::sync::atomic::Ordering::Relaxed);
4356    }
4357    total
4358}
4359
4360/// The per-stage split of `weight_bytes_dispatched`:
4361/// [misc, dense-ffn, moe, attn, gdn, head].
4362pub fn weight_bytes_by() -> [u64; 6] {
4363    #[cfg(target_os = "macos")]
4364    {
4365        let mut o = [0u64; 6];
4366        for (i, a) in crate::gpu_metal::WEIGHT_BYTES_BY.iter().enumerate() {
4367            o[i] = a.load(std::sync::atomic::Ordering::Relaxed);
4368        }
4369        return o;
4370    }
4371    #[allow(unreachable_code)]
4372    [0; 6]
4373}
4374
4375#[cfg(test)]
4376mod f16_guard_tests {
4377    use super::*;
4378
4379    /// The f16 guard's maximum: the largest magnitude through the lanes and
4380    /// the remainder, +inf for an inf or a NaN anywhere.
4381    #[test]
4382    fn abs_max_or_inf_is_the_magnitude_maximum() {
4383        let mut xs: Vec<f32> = (0..37).map(|i| (i as f32 - 18.0) * 0.5).collect();
4384        assert_eq!(abs_max_or_inf(&xs), 9.0);
4385        xs[36] = -70000.0; // the remainder
4386        assert_eq!(abs_max_or_inf(&xs), 70000.0);
4387        xs[3] = f32::NAN; // a lane
4388        assert_eq!(abs_max_or_inf(&xs), f32::INFINITY);
4389        xs[3] = 0.0;
4390        xs[35] = f32::NEG_INFINITY;
4391        assert_eq!(abs_max_or_inf(&xs), f32::INFINITY);
4392        assert_eq!(abs_max_or_inf(&[]), 0.0);
4393        assert_eq!(abs_max_or_inf(&[-0.0, -1e-30]), 1e-30);
4394    }
4395}
4396
4397#[cfg(test)]
4398mod probe_warmup_tests {
4399    use super::*;
4400    use std::time::Duration;
4401
4402    fn ms(v: f64) -> Duration {
4403        Duration::from_nanos((v * 1e6) as u64)
4404    }
4405
4406    /// The bug this pins, measured on an A100: the first device call for
4407    /// a class compiles its pipeline, was timed at 117.01 ms against the
4408    /// host's 3.19, and sent `gemm-nt` to the CPU for the whole process —
4409    /// which ran a 27B bake on 2.6 cores with the card idle.
4410    #[test]
4411    fn one_cold_first_sample_does_not_lose_the_class() {
4412        let p = Probe::new();
4413        // First device sample is the pipeline build. Then the truth.
4414        probe_record_into(&p, "gemm-nt", None, true, ms(117.01));
4415        probe_record_into(&p, "gemm-nt", None, true, ms(1.1));
4416        probe_record_into(&p, "gemm-nt", None, true, ms(1.0));
4417        probe_record_into(&p, "gemm-nt", None, false, ms(3.19));
4418        probe_record_into(&p, "gemm-nt", None, false, ms(3.20));
4419        assert_eq!(
4420            p.state.load(Ordering::Relaxed),
4421            1,
4422            "the device is 3x faster once warm and must win"
4423        );
4424    }
4425
4426    /// The warm-up must not become a way to never decide, and must not
4427    /// underflow: a blind decrement at zero wraps a u32 to its maximum
4428    /// and mutes the arm for the life of the process.
4429    #[test]
4430    fn the_warmup_is_spent_once_and_never_underflows() {
4431        let p = Probe::new();
4432        for _ in 0..8 {
4433            probe_record_into(&p, "matmat", None, true, ms(10.0));
4434        }
4435        assert_eq!(p.gpu_burn.load(Ordering::Relaxed), 0, "spent, not wrapped");
4436        assert_eq!(
4437            p.gpu_n.load(Ordering::Relaxed),
4438            7,
4439            "one sample burned, the rest counted"
4440        );
4441    }
4442
4443    /// A device path that always refuses records no timing, so without
4444    /// counting the refusals the class can never reach a verdict. On an
4445    /// M4 with LFM2.5-2.6B `ffn` was still undecided after 9000 calls,
4446    /// alternating arms and paying a failed device attempt on half of
4447    /// them.
4448    #[test]
4449    fn a_class_whose_device_always_declines_settles_on_the_host() {
4450        let _probe_guard = probe_test_guard();
4451        // A class no other test in this file touches: `probe_note_decline`
4452        // works on the process-wide probes by design, and the tests in
4453        // this binary share them.
4454        let c = OpClass::MatmatWide;
4455        let p = &PROBES[c as usize];
4456        p.state.store(0, Ordering::Relaxed);
4457        p.declines.store(0, Ordering::Relaxed);
4458        for _ in 0..(PROBE_DECLINE_LIMIT - 1) {
4459            probe_note_decline(c);
4460        }
4461        assert_eq!(
4462            p.state.load(Ordering::Relaxed),
4463            0,
4464            "one short of the limit is still a question, not an answer"
4465        );
4466        probe_note_decline(c);
4467        assert_eq!(p.state.load(Ordering::Relaxed), 2, "settled on the host");
4468        assert!(matches!(probe_arm(c), ProbeArm::Cpu));
4469        p.state.store(0, Ordering::Relaxed);
4470        p.declines.store(0, Ordering::Relaxed);
4471    }
4472
4473    /// A genuinely slower device still loses — the warm-up removes an
4474    /// artefact, it does not put a thumb on the scale.
4475    #[test]
4476    fn a_slow_device_still_loses_after_the_warmup() {
4477        let p = Probe::new();
4478        for _ in 0..4 {
4479            probe_record_into(&p, "matvec", None, true, ms(40.0));
4480        }
4481        for _ in 0..4 {
4482            probe_record_into(&p, "matvec", None, false, ms(2.0));
4483        }
4484        assert_eq!(p.state.load(Ordering::Relaxed), 2, "host wins on merit");
4485    }
4486}
4487
4488/// Scratch/weight lifetime for a synchronous image-pipeline stage. Declare
4489/// this before the stage model so the model drops before cache collection.
4490pub(crate) struct ImageStageGuard {
4491    #[cfg(target_os = "macos")]
4492    metal: Option<crate::gpu_metal::ImageStageGuard>,
4493    #[cfg(feature = "gpu")]
4494    wgpu: crate::gpu_wgpu::ImageStageGuard,
4495}
4496
4497pub(crate) fn image_stage_scope() -> ImageStageGuard {
4498    ImageStageGuard {
4499        #[cfg(target_os = "macos")]
4500        metal: if matches!(backend(), Backend::Metal) {
4501            Some(crate::gpu_metal::image_stage_scope())
4502        } else {
4503            None
4504        },
4505        #[cfg(feature = "gpu")]
4506        wgpu: crate::gpu_wgpu::image_stage_scope(),
4507    }
4508}
4509
4510impl ImageStageGuard {
4511    pub(crate) fn track_model(&mut self, uid: u64) {
4512        #[cfg(target_os = "macos")]
4513        if let Some(metal) = &mut self.metal {
4514            metal.track_model(uid);
4515        }
4516        #[cfg(feature = "gpu")]
4517        self.wgpu.track_model(uid);
4518        #[cfg(not(target_os = "macos"))]
4519        let _ = uid;
4520    }
4521}
4522
4523// ════════════════════════════════════════════════════════════════════
4524// Z-Image-Turbo device contract (WP0 scaffold, plan §2.1). APPEND-ONLY.
4525//
4526// Owner of the contract: the WP1 lead. The backends implement it in their
4527// own child modules — `gpu_wgpu/zimage.rs` (WP2) and `gpu_metal/zimage.rs`
4528// (WP3) — and never edit the parent files. New fields are added only as
4529// `Option<…>` with agreed semantics; existing fields never change meaning.
4530//
4531// Convention (the same as every `gpu::*` entry): `false` = "not handled",
4532// nothing observable was changed, and the caller runs the CPU path
4533// (`zimage::ZImageDit::step_cpu` etc.), which is the bit-level reference.
4534//
4535// Sequence order everywhere is diffusers' [img rows…, cap rows…], with
4536// padded lengths n_img_p = ceil32(n_img) and n_cap_p = ceil32(L).
4537// ════════════════════════════════════════════════════════════════════
4538
4539// ───────────────────── Qwen-Image-2.1 device contract ─────────────────────
4540
4541/// Geometry of the Qwen-Image-2.1 denoiser.
4542#[derive(Clone, Copy, Debug, PartialEq)]
4543pub struct Qi21Geom {
4544    pub hidden: usize,
4545    pub nh: usize,
4546    pub hd: usize,
4547    pub inter: usize,
4548    pub in_ch: usize,
4549    pub eps: f32,
4550}
4551
4552/// One block's weights: tensor indices of `to_q, to_k, to_v, to_out.0,
4553/// gate_layer, proj (up), out (down)` and the per-head q/k norm weights.
4554pub struct Qi21BlockRef<'a> {
4555    pub w: [usize; 7],
4556    pub norm_q: &'a [f32],
4557    pub norm_k: &'a [f32],
4558}
4559
4560/// Everything the device needs to build a program and run its prefix.
4561pub struct Qi21PrefillArgs<'a> {
4562    pub model: &'a Arc<CmfModel>,
4563    pub geom: Qi21Geom,
4564    pub blocks: &'a [Qi21BlockRef<'a>],
4565    /// `img_in` [hidden, 64] and `proj_out` [64, hidden], f32.
4566    pub img_in: &'a [f32],
4567    pub proj_out: &'a [f32],
4568    pub key: u64,
4569    /// Prefix rows after `txt_in` / `img_in`, `[lp, hidden]`.
4570    pub x: &'a [f32],
4571    pub lp: usize,
4572    /// RoPE cos/sin of the prefix rows and of the target rows, `[rows, 64]`.
4573    pub rope_p: (&'a [f32], &'a [f32]),
4574    pub rope_t: (&'a [f32], &'a [f32]),
4575    /// Keys each prefix row sees (a leading run; non-decreasing).
4576    pub vis: &'a [u32],
4577    /// The t = 0 modulation `[s1|g1|s2|g2]`.
4578    pub mods0: &'a [f32],
4579    /// Target rows.
4580    pub n: usize,
4581}
4582
4583/// Build the program `a.key` and run its prefix on the device.
4584#[allow(unused_variables)]
4585pub fn qi21_prefill(a: &Qi21PrefillArgs) -> bool {
4586    match backend() {
4587        #[cfg(target_os = "macos")]
4588        Backend::Metal => crate::gpu_metal::qi21::prefill(a),
4589        #[cfg(feature = "gpu")]
4590        Backend::Wgpu => crate::gpu_wgpu::qi21::prefill(a),
4591        #[allow(unreachable_patterns)]
4592        _ => false,
4593    }
4594}
4595
4596/// One denoiser call of program `key`: `xtok [n, 64]` → `out [n, 64]`.
4597#[allow(unused_variables)]
4598pub fn qi21_step(key: u64, xtok: &[f32], mods: &[f32], fs: &[f32], out: &mut [f32]) -> bool {
4599    match backend() {
4600        #[cfg(target_os = "macos")]
4601        Backend::Metal => crate::gpu_metal::qi21::step(key, xtok, mods, fs, out),
4602        #[cfg(feature = "gpu")]
4603        Backend::Wgpu => crate::gpu_wgpu::qi21::step(key, xtok, mods, fs, out),
4604        #[allow(unreachable_patterns)]
4605        _ => false,
4606    }
4607}
4608
4609/// Drop program `key`. The wgpu module is released directly (module-local
4610/// state only), so a release never brings a device up.
4611#[allow(unused_variables)]
4612pub fn qi21_release_key(key: u64) {
4613    #[cfg(target_os = "macos")]
4614    if matches!(backend(), Backend::Metal) {
4615        crate::gpu_metal::qi21::release_key(key);
4616    }
4617    #[cfg(feature = "gpu")]
4618    crate::gpu_wgpu::qi21::release_key(key);
4619}
4620
4621/// Drop the denoiser's device state (see `qi21_release_key`), and the
4622/// resident VAE decoder's weights.
4623pub fn qi21_release() {
4624    #[cfg(target_os = "macos")]
4625    if matches!(backend(), Backend::Metal) {
4626        crate::gpu_metal::qi21::release();
4627    }
4628    #[cfg(feature = "gpu")]
4629    {
4630        crate::gpu_wgpu::qi21::release();
4631        crate::gpu_wgpu::qi21_vae::release();
4632    }
4633}
4634
4635/// One conv of the Qwen-Image-2.1 VAE decoder: host f32 weights
4636/// `[co][ci][k][k]` and bias `[co]` (k = 1 or 3, stride 1, same padding).
4637#[derive(Clone, Copy)]
4638pub struct Qi21VaeConvRef<'a> {
4639    pub w: &'a [f32],
4640    pub b: &'a [f32],
4641    pub ci: usize,
4642    pub co: usize,
4643    pub k: usize,
4644}
4645
4646/// A residual block: `conv2(φ(conv1(φ(x)))) + x` (through the 1×1
4647/// shortcut when ci ≠ co), φ = RMS_norm over channels (x/‖x‖·√C·γ), SiLU.
4648pub struct Qi21VaeResRef<'a> {
4649    pub g1: &'a [f32],
4650    pub c1: Qi21VaeConvRef<'a>,
4651    pub g2: &'a [f32],
4652    pub c2: Qi21VaeConvRef<'a>,
4653    pub shortcut: Option<Qi21VaeConvRef<'a>>,
4654}
4655
4656/// An up block: its resnets, then (all but the last block) nearest-2× +
4657/// the 3×3 conv, plus the DupUp shortcut of the block's input (`in_dim` →
4658/// `out_dim` channels, temporal factor `ft`).
4659pub struct Qi21VaeUpRef<'a> {
4660    pub resnets: Vec<Qi21VaeResRef<'a>>,
4661    pub up: Option<(Qi21VaeConvRef<'a>, usize)>,
4662    pub in_dim: usize,
4663    pub out_dim: usize,
4664}
4665
4666/// The Qwen-Image-2.1 VAE decoder (`qwen_image21_vae.rs`) for a resident
4667/// device decode.
4668pub struct Qi21VaeDecodeArgs<'a> {
4669    /// Identity of the weights: a backend caches its planes by it.
4670    pub key: u64,
4671    pub post_quant: Qi21VaeConvRef<'a>,
4672    pub conv_in: Qi21VaeConvRef<'a>,
4673    pub mid_res: [Qi21VaeResRef<'a>; 2],
4674    /// The mid attention: RMS_norm γ, `to_qkv` (1×1, 3c outputs: q, k, v),
4675    /// `proj` (1×1); single head, residual.
4676    pub attn_gamma: &'a [f32],
4677    pub attn_qkv: Qi21VaeConvRef<'a>,
4678    pub attn_proj: Qi21VaeConvRef<'a>,
4679    pub ups: Vec<Qi21VaeUpRef<'a>>,
4680    pub norm_out: &'a [f32],
4681    pub conv_out: Qi21VaeConvRef<'a>,
4682}
4683
4684/// Resident VAE decode: `z` = raw latent planes `[z_dim, h·w]` → `out`
4685/// `[out_channels, 16h·16w]` (before the clamp). `false` = not handled,
4686/// `out` untouched: the per-conv path runs.
4687#[allow(unused_variables)]
4688pub fn qi21_vae_decode(a: &Qi21VaeDecodeArgs, z: &[f32], h: usize, w: usize, out: &mut [f32]) -> bool {
4689    match backend() {
4690        #[cfg(feature = "gpu")]
4691        Backend::Wgpu => crate::gpu_wgpu::qi21_vae::decode(a, z, h, w, out),
4692        #[allow(unreachable_patterns)]
4693        _ => false,
4694    }
4695}
4696
4697/// One Z-Image transformer block's device inputs (noise refiner, context
4698/// refiner or main layer — all share this shape). Weights are tensor
4699/// indices into `model.tensors` (diffusers names under `dit.`); the codec
4700/// is whatever the container holds (F16/Bf16/Q8Row/Q8_2f/Q4TiledP…), and a
4701/// backend that cannot expand a codec declines (returns `false`).
4702/// Norm vectors are f32 host slices that live as long as the caller's
4703/// `ZImageDit`; a backend may cache them by pointer (they do not change).
4704#[derive(Clone, Copy)]
4705pub struct ZBlockRef<'a> {
4706    /// `attention.to_q/to_k/to_v/to_out.0.weight`, each [hidden, hidden].
4707    pub wq: usize,
4708    pub wk: usize,
4709    pub wv: usize,
4710    pub wo: usize,
4711    /// `feed_forward.w1` (gate) / `w3` (up) [inter, hidden], `w2` (down)
4712    /// [hidden, inter]. FFN = w2(silu(w1·x) ⊙ w3·x).
4713    pub w1: usize,
4714    pub w3: usize,
4715    pub w2: usize,
4716    /// `attention_norm1` / `attention_norm2`, [hidden] (plain-w RMSNorm).
4717    pub norm1: &'a [f32],
4718    pub norm2: &'a [f32],
4719    /// `ffn_norm1` / `ffn_norm2`, [hidden].
4720    pub ffn_norm1: &'a [f32],
4721    pub ffn_norm2: &'a [f32],
4722    /// `attention.norm_q` / `norm_k`, [hd] (per-head RMSNorm before RoPE).
4723    pub norm_q: &'a [f32],
4724    pub norm_k: &'a [f32],
4725}
4726
4727/// Z-Image geometry. Turbo: hidden 3840, nh 30 (MHA, no GQA), hd 128,
4728/// inter 10240, eps 1e-5 (all RMSNorms incl. qk-norm), final_eps 1e-6
4729/// (the affine-free final LayerNorm), patch_dim 64 (2×2×16).
4730#[derive(Clone, Copy, Debug, PartialEq)]
4731pub struct ZGeom {
4732    pub hidden: usize,
4733    pub nh: usize,
4734    pub hd: usize,
4735    pub inter: usize,
4736    pub eps: f32,
4737    pub final_eps: f32,
4738    pub patch_dim: usize,
4739}
4740
4741/// Once per (prompt, resolution). The backend uploads/caches what it needs
4742/// keyed by `key`; weight planes are keyed by the MODEL (not by `key`) and
4743/// survive across prompts until `zimage_release`.
4744pub struct ZPrepareArgs<'a> {
4745    pub model: &'a Arc<CmfModel>,
4746    pub geom: ZGeom,
4747    /// Caller-chosen identity of this (prompt, resolution) state; every
4748    /// `ZStepArgs` of the same image carries the same key.
4749    pub key: u64,
4750    /// Image tokens (H/16 · W/16), padded count ceil32(n_img), caption
4751    /// padded count ceil32(L). S = n_img_p + n_cap_p.
4752    pub n_img: usize,
4753    pub n_img_p: usize,
4754    pub n_cap_p: usize,
4755    /// The patch grid (H/16, W/16); n_img = grid.0 · grid.1. Row-major
4756    /// token order `hp·grid.1 + wp`.
4757    pub grid: (usize, usize),
4758    /// [n_cap_p, hidden], ALREADY context-refined (host or device).
4759    pub cap: &'a [f32],
4760    /// Noise-refiner RoPE: [n_img_p · hd/2] cos, sin (complex-interleaved
4761    /// pairs, hd/2 angles per token).
4762    pub rope_img: (&'a [f32], &'a [f32]),
4763    /// Main-layer RoPE: [(n_img_p + n_cap_p) · hd/2], rows ordered [img, cap].
4764    pub rope_joint: (&'a [f32], &'a [f32]),
4765    /// `all_x_embedder.2-1.weight` [hidden, 64], `.bias` [hidden],
4766    /// `x_pad_token` [hidden] (replaces rows ≥ n_img after the embed).
4767    pub x_emb_w: &'a [f32],
4768    pub x_emb_b: &'a [f32],
4769    pub x_pad: &'a [f32],
4770    /// `all_final_layer.2-1.linear.weight` [64, hidden], `.bias` [64].
4771    pub final_w: &'a [f32],
4772    pub final_b: &'a [f32],
4773    /// 2 noise-refiner blocks (image rows only) and 30 main layers.
4774    pub noise_refiner: &'a [ZBlockRef<'a>],
4775    pub layers: &'a [ZBlockRef<'a>],
4776    /// OPTIONAL (backends may ignore): the modulation of EVERY step of this
4777    /// image, [steps][(2+30)·4·hidden] in the `ZStepArgs::mods` layout, and
4778    /// [steps][hidden] final scales, so a backend can upload them once per
4779    /// image and index them by `ZStepArgs::step`. `ZStepArgs::mods` is still
4780    /// always supplied and is authoritative.
4781    pub mods_all: Option<&'a [f32]>,
4782    pub final_scale_all: Option<&'a [f32]>,
4783    /// OPTIONAL (B2): the CFG negative item. When `Some`, the backend
4784    /// prepares ONE batch-2 program under `key` — item 0 is this prompt,
4785    /// item 1 the negative — and every `ZStepArgs` of that key must carry
4786    /// `out_neg`. A backend without batch 2 returns `false` (the caller
4787    /// then prepares the two items separately or runs the CPU path).
4788    pub neg: Option<ZNegArgs<'a>>,
4789}
4790
4791/// The negative (unconditional) item of a CFG pair: its own refined
4792/// caption, padded caption length and joint RoPE table (the image ids sit
4793/// at axis-0 position L_p+1, so both tables depend on the item's L_p).
4794pub struct ZNegArgs<'a> {
4795    /// [n_cap_p, hidden], context-refined.
4796    pub cap: &'a [f32],
4797    pub n_cap_p: usize,
4798    /// [n_img_p · hd/2] cos, sin (noise refiner) of this item.
4799    pub rope_img: (&'a [f32], &'a [f32]),
4800    /// [(n_img_p + n_cap_p) · hd/2] cos, sin, rows [img, cap].
4801    pub rope_joint: (&'a [f32], &'a [f32]),
4802}
4803
4804/// Once per denoising step.
4805pub struct ZStepArgs<'a> {
4806    /// The `ZPrepareArgs::key` this step belongs to. A key the backend has
4807    /// not prepared → `false`.
4808    pub key: u64,
4809    /// Step index into the schedule (0..steps); selects the row of
4810    /// `ZPrepareArgs::mods_all` when a backend uses it.
4811    pub step: usize,
4812    /// [n_img_p, 64] patchified latent, inner order (dy·2+dx)·16+c. Rows
4813    /// ≥ n_img are copies of the last row; the backend replaces them with
4814    /// `x_pad` after the embed.
4815    pub x_tok: &'a [f32],
4816    /// Per block (noise_refiner then layers) the RAW chunks
4817    /// [scale_msa, gate_msa, scale_mlp, gate_mlp] of Linear(temb) (no SiLU
4818    /// before it), [(2+30)·4·hidden]. The backend applies (1+s) and tanh(g).
4819    pub mods: &'a [f32],
4820    /// [hidden] = 1 + Linear(SiLU(temb)) — already includes the +1.
4821    pub final_scale: &'a [f32],
4822    /// [n_img, 64]: the model output v (before the pipeline's negation),
4823    /// image rows only, patchified order.
4824    pub out: &'a mut [f32],
4825    /// [n_img, 64]: the negative item's v — required (and only valid) for
4826    /// a key prepared with `ZPrepareArgs::neg`. Both items see `x_tok`.
4827    pub out_neg: Option<&'a mut [f32]>,
4828}
4829
4830/// Prepare the per-(prompt, resolution) device state. Backends: wgpu →
4831/// `gpu_wgpu::zimage::prepare` (WP2), Metal → `gpu_metal::zimage::prepare`
4832/// (WP3).
4833#[allow(unused_variables)]
4834pub fn zimage_prepare(a: &ZPrepareArgs) -> bool {
4835    match backend() {
4836        #[cfg(target_os = "macos")]
4837        Backend::Metal => crate::gpu_metal::zimage::prepare(a),
4838        #[cfg(feature = "gpu")]
4839        Backend::Wgpu => crate::gpu_wgpu::zimage::prepare(a),
4840        #[allow(unreachable_patterns)]
4841        _ => false,
4842    }
4843}
4844
4845/// One full DiT forward on the device: x_embed → pad rows → noise refiner
4846/// ×2 → concat [img, cap] → 30 layers → final LayerNorm·scale → Linear →
4847/// image rows into `a.out`.
4848#[allow(unused_variables)]
4849pub fn zimage_step(a: &mut ZStepArgs) -> bool {
4850    match backend() {
4851        #[cfg(target_os = "macos")]
4852        Backend::Metal => crate::gpu_metal::zimage::step(a),
4853        #[cfg(feature = "gpu")]
4854        Backend::Wgpu => crate::gpu_wgpu::zimage::step(a),
4855        #[allow(unreachable_patterns)]
4856        _ => false,
4857    }
4858}
4859
4860/// OPTIONAL (B2): build the backend's weight planes for the per-step blocks
4861/// and the context refiner ahead of `zimage_prepare`, so the caller can
4862/// overlap the upload with the (CPU) text encoder. `false` = not done;
4863/// `zimage_prepare` builds whatever is missing either way.
4864#[allow(unused_variables)]
4865pub fn zimage_preload(
4866    model: &Arc<CmfModel>,
4867    geom: &ZGeom,
4868    noise_refiner: &[ZBlockRef],
4869    layers: &[ZBlockRef],
4870    context_refiner: &[ZBlockRef],
4871) -> bool {
4872    match backend() {
4873        #[cfg(target_os = "macos")]
4874        Backend::Metal => {
4875            crate::gpu_metal::zimage::preload(model, geom, noise_refiner, layers, context_refiner)
4876        }
4877        #[cfg(feature = "gpu")]
4878        Backend::Wgpu => crate::gpu_wgpu::zimage::preload(model, geom, noise_refiner, layers, context_refiner),
4879        #[allow(unreachable_patterns)]
4880        _ => false,
4881    }
4882}
4883
4884/// Persist the driver's compiled pipelines after a Z-Image generation (the
4885/// chain's kernels are built at first use, after the context came up), so
4886/// the next process skips the compile. Best-effort, no-op off wgpu.
4887pub fn zimage_flush_pipelines() {
4888    #[cfg(feature = "gpu")]
4889    if matches!(backend(), Backend::Wgpu) {
4890        crate::gpu_wgpu::pipeline_cache_flush();
4891    }
4892}
4893
4894/// OPTIONAL (B2): bring the device up and compile the Z-Image kernels, on
4895/// a helper thread at the start of a generation (the context and the
4896/// compiles cost ~1 s cold, beside the host-side loading). `false` = no
4897/// device path here.
4898pub fn zimage_warmup() -> bool {
4899    match backend() {
4900        #[cfg(target_os = "macos")]
4901        Backend::Metal => crate::gpu_metal::zimage::warmup(),
4902        #[cfg(feature = "gpu")]
4903        Backend::Wgpu => crate::gpu_wgpu::zimage::warmup(),
4904        #[allow(unreachable_patterns)]
4905        _ => false,
4906    }
4907}
4908
4909/// OPTIONAL (B2): upload the resident VAE's weights and compile its
4910/// kernels ahead of `vae_decode_chain` (the caller runs it on a helper
4911/// thread while the DiT steps keep the device busy). `false` = not done.
4912#[allow(unused_variables)]
4913pub fn vae_prewarm(a: &crate::vae::VaeChainArgs) -> bool {
4914    match backend() {
4915        #[cfg(target_os = "macos")]
4916        Backend::Metal => crate::gpu_metal::zimage::vae_prewarm(a),
4917        #[cfg(feature = "gpu")]
4918        Backend::Wgpu => crate::gpu_wgpu::zimage::vae_prewarm(a),
4919        #[allow(unreachable_patterns)]
4920        _ => false,
4921    }
4922}
4923
4924/// Drop the Z-Image DiT device state (planes, prepared programs) but keep
4925/// the VAE chain (B2: the generator frees the DiT before decoding).
4926pub fn zimage_release_dit() {
4927    #[cfg(target_os = "macos")]
4928    crate::gpu_metal::zimage::release_dit();
4929    #[cfg(feature = "gpu")]
4930    crate::gpu_wgpu::zimage::release_dit();
4931}
4932
4933/// Drop every Z-Image device resource (planes, prepared states, VAE chain
4934/// buffers): stage change or process end. Calls each compiled backend's
4935/// release directly, without `backend()`, so it never brings a device up;
4936/// the child modules' `release` must touch module-local state only.
4937pub fn zimage_release() {
4938    #[cfg(target_os = "macos")]
4939    crate::gpu_metal::zimage::release();
4940    #[cfg(feature = "gpu")]
4941    crate::gpu_wgpu::zimage::release();
4942}
4943
4944/// Optional device context refiner: the same block math with scale = 0 and
4945/// gate = 1 (unmodulated): x += norm2(attn(norm1(x))); x += ffn_norm2(ffn(
4946/// ffn_norm1(x))). `cap` is [n_cap_p, hidden] in/out (the cap_embedder
4947/// output with pad rows already = cap_pad_token); `rope_cap` is
4948/// [n_cap_p · hd/2] cos, sin. `false` = untouched, run the CPU refiner.
4949#[allow(unused_variables)]
4950pub fn zimage_refine_caption(
4951    model: &Arc<CmfModel>,
4952    geom: &ZGeom,
4953    blocks: &[ZBlockRef],
4954    rope_cap: (&[f32], &[f32]),
4955    cap: &mut [f32],
4956) -> bool {
4957    match backend() {
4958        #[cfg(target_os = "macos")]
4959        Backend::Metal => {
4960            crate::gpu_metal::zimage::refine_caption(model, geom, blocks, rope_cap, cap)
4961        }
4962        #[cfg(feature = "gpu")]
4963        Backend::Wgpu => {
4964            crate::gpu_wgpu::zimage::refine_caption(model, geom, blocks, rope_cap, cap)
4965        }
4966        #[allow(unreachable_patterns)]
4967        _ => false,
4968    }
4969}
4970
4971/// Resident Flux-VAE decode (the whole decoder on the device, one latent
4972/// upload, one RGB readback). `a` comes from `VaeDecoder::chain_args()`.
4973/// `z` is [latent_channels, h, w] ALREADY de-normalised
4974/// (z/scaling_factor + shift_factor — the conv_in input); `out` is
4975/// [3, 8h, 8w], the raw decoder output (≈[-1, 1], before x/2+0.5).
4976#[allow(unused_variables)]
4977pub fn vae_decode_chain(
4978    a: &crate::vae::VaeChainArgs,
4979    z: &[f32],
4980    h: usize,
4981    w: usize,
4982    out: &mut [f32],
4983) -> bool {
4984    match backend() {
4985        #[cfg(target_os = "macos")]
4986        Backend::Metal => crate::gpu_metal::zimage::vae_decode_chain(a, z, h, w, out),
4987        #[cfg(feature = "gpu")]
4988        Backend::Wgpu => crate::gpu_wgpu::zimage::vae_decode_chain(a, z, h, w, out),
4989        #[allow(unreachable_patterns)]
4990        _ => false,
4991    }
4992}