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    Q4t,
1111    Q4tp,
1112}
1113
1114#[derive(Clone, Copy, PartialEq, Eq)]
1115enum Backend {
1116    None,
1117    #[cfg(target_os = "macos")]
1118    Metal,
1119    #[cfg(feature = "gpu")]
1120    Wgpu,
1121}
1122
1123fn backend() -> Backend {
1124    #[cfg(feature = "gpu")]
1125    if crate::gpu_wgpu::selected() {
1126        return if crate::gpu_wgpu::enabled() {
1127            Backend::Wgpu
1128        } else {
1129            Backend::None
1130        };
1131    }
1132    #[cfg(target_os = "macos")]
1133    if crate::gpu_metal::enabled() {
1134        return Backend::Metal;
1135    }
1136    Backend::None
1137}
1138
1139/// GPU enabled and initialized on the selected backend?
1140/// Whether THIS build can bring a GPU up on THIS device: a compiled-in
1141/// backend plus a live adapter. The mobile FFI exposes it so an app can
1142/// tell "GPU off" from "GPU impossible" (a CPU-only .so ships no
1143/// backend at all). Cached after the first call.
1144pub fn backend_available() -> bool {
1145    #[cfg(target_os = "macos")]
1146    {
1147        // The Metal path is always compiled on macOS.
1148        true
1149    }
1150    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
1151    {
1152        static AVAIL: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
1153        *AVAIL.get_or_init(crate::gpu_wgpu::adapter_probe)
1154    }
1155    #[cfg(all(not(feature = "gpu"), not(target_os = "macos")))]
1156    {
1157        false
1158    }
1159}
1160
1161/// A process-wide, phase-scoped GPU gate. `cpu_scope` is thread-local and
1162/// the pool's workers do not inherit it, so a caller that wants a whole
1163/// *phase* off the device — a prompt encoder whose weights live in a part of
1164/// the file the hot loop never touches, on a machine that cannot keep both
1165/// wired — has to say so globally.
1166static GPU_PAUSED: AtomicBool = AtomicBool::new(false);
1167
1168/// Park the device for every thread until the returned guard drops.
1169pub fn pause_gpu() -> GpuPause {
1170    GPU_PAUSED.store(true, Ordering::Relaxed);
1171    GpuPause(())
1172}
1173
1174pub struct GpuPause(());
1175
1176impl Drop for GpuPause {
1177    fn drop(&mut self) {
1178        GPU_PAUSED.store(false, Ordering::Relaxed);
1179    }
1180}
1181
1182pub fn enabled() -> bool {
1183    !GPU_PAUSED.load(Ordering::Relaxed) && backend() != Backend::None
1184}
1185
1186/// Default-on condition for the wgpu whole-token graph: the wgpu
1187/// backend on a DISCRETE adapter. NOT plain `enabled()` (macOS/Metal
1188/// must not pay a per-token layer scan for a graph its backend
1189/// refuses), and NOT integrated adapters: the graph's ~300 barriered
1190/// dispatches per token are cheap on desktop immediate-mode GPUs but
1191/// tiled mobile GPUs (Adreno/Mali) drain the pipeline at every barrier
1192/// — field report: 0.2 tok/s on-graph vs 15 tok/s on the CPU. On
1193/// integrated adapters the per-op probe path arbitrates each op class
1194/// against the CPU instead; CMF_GPU_WGPU_GRAPH=1 still forces the
1195/// graph anywhere.
1196/// Is the wgpu backend active at all (any adapter)? Eligibility gate
1197/// for the whole-token graph — whether it actually RUNS is decided by
1198/// `wgpu_graph_default` (trusted on discrete) or the generation race.
1199pub fn wgpu_active() -> bool {
1200    #[cfg(feature = "gpu")]
1201    {
1202        matches!(backend(), Backend::Wgpu)
1203    }
1204    #[cfg(not(feature = "gpu"))]
1205    {
1206        false
1207    }
1208}
1209
1210/// Which GPU this thread's engine calls address. Multi-card hosts hold
1211/// one wgpu context PER card (weights, KV mirrors and scratch live
1212/// inside a context, so per-device contexts give per-device caches for
1213/// free); this thread-local says which one is current. Default: the
1214/// process pin (CMF_GPU_ADAPTER) or 0 — so single-card runs behave
1215/// exactly as they always have.
1216pub fn default_device() -> usize {
1217    static D: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
1218    *D.get_or_init(|| {
1219        std::env::var("CMF_GPU_ADAPTER")
1220            .ok()
1221            .and_then(|v| v.trim().parse::<usize>().ok())
1222            .unwrap_or(0)
1223    })
1224}
1225
1226thread_local! {
1227    static CUR_DEV: std::cell::Cell<Option<usize>> = const { std::cell::Cell::new(None) };
1228}
1229
1230/// The device this thread is pinned to.
1231pub fn current_device() -> usize {
1232    CUR_DEV.with(|c| c.get()).unwrap_or_else(default_device)
1233}
1234
1235/// Pin this thread to a device. Server slots call it once per request;
1236/// the worker pool propagates it into its threads, so a dispatch begun
1237/// on card 1 does not finish on card 0.
1238pub fn set_current_device(i: usize) {
1239    CUR_DEV.with(|c| c.set(Some(i)));
1240}
1241
1242/// Run `f` with this thread pinned to `dev`, restoring the previous pin.
1243pub fn with_device<R>(dev: usize, f: impl FnOnce() -> R) -> R {
1244    let prev = CUR_DEV.with(|c| c.replace(Some(dev)));
1245    let r = f();
1246    CUR_DEV.with(|c| c.set(prev));
1247    r
1248}
1249
1250/// How many GPUs this process can address (wgpu adapter count; 1 on
1251/// Metal, 0 without a backend).
1252pub fn device_count() -> usize {
1253    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
1254    {
1255        return crate::gpu_wgpu::adapter_count();
1256    }
1257    #[cfg(not(all(feature = "gpu", not(target_os = "macos"))))]
1258    {
1259        usize::from(backend_available())
1260    }
1261}
1262
1263/// Weight budget of the current GPU in bytes; 0 when there is none and
1264/// u64::MAX on unified memory (where the OS pages shared RAM and the
1265/// question "does the model fit the card" has no separate answer).
1266pub fn vram_budget() -> u64 {
1267    #[cfg(all(feature = "gpu", not(target_os = "macos")))]
1268    {
1269        return crate::gpu_wgpu::device_vram_budget();
1270    }
1271    #[cfg(not(all(feature = "gpu", not(target_os = "macos"))))]
1272    {
1273        if backend_available() { u64::MAX } else { 0 }
1274    }
1275}
1276
1277/// Bytes currently accounted as resident weight buffers on the active wgpu
1278/// adapter.  This is the logical device-local weight set; physical driver
1279/// allocations are reported separately by the platform tools.
1280pub fn resident_bytes() -> u64 {
1281    #[cfg(feature = "gpu")]
1282    {
1283        if backend() == Backend::Wgpu {
1284            return crate::gpu_wgpu::resident_bytes();
1285        }
1286    }
1287    0
1288}
1289
1290/// Sealed O(1) device mirror count and logical bytes for one pipeline id.
1291/// Zero is returned when wgpu is unavailable or the sequence has not reached
1292/// an O(1) seal yet.
1293pub fn o1_device_stats(kv_id: u64) -> (usize, u64) {
1294    #[cfg(feature = "gpu")]
1295    {
1296        if backend() == Backend::Wgpu {
1297            return crate::gpu_wgpu::o1_device_stats(kv_id);
1298        }
1299    }
1300    let _ = kv_id;
1301    (0, 0)
1302}
1303
1304/// Device weight bytes uploaded so far (wgpu; 0 on other backends).
1305/// Steady-state windows must show a ZERO delta — growth mid-benchmark
1306/// means eviction/re-upload and disqualifies the number.
1307pub fn upload_bytes() -> u64 {
1308    #[cfg(feature = "gpu")]
1309    {
1310        return crate::gpu_wgpu::UPLOAD_BYTES.load(std::sync::atomic::Ordering::Relaxed);
1311    }
1312    #[cfg(not(feature = "gpu"))]
1313    0
1314}
1315
1316/// Measure a transient host-to-device upload when the wgpu backend is
1317/// compiled in. CPU-only builds keep the benchmark command available and
1318/// report no device measurement instead of referring to the gated module.
1319pub fn upload_bandwidth_probe(block: usize, rounds: usize) -> Option<f64> {
1320    #[cfg(feature = "gpu")]
1321    {
1322        return crate::gpu_wgpu::upload_bandwidth_probe(block, rounds);
1323    }
1324    let _ = (block, rounds);
1325    None
1326}
1327
1328/// Which half of the run is asking.
1329///
1330/// The phase exists because the graph is plausibly two decisions, not
1331/// one — but on the hardware measured so far it is only ever a decode
1332/// decision. On an Adreno 642L with bonsai-1.7b, from identical clean
1333/// starts and two repeats each: decode 11.6 tok/s without it and 0.72
1334/// with, while prefill is 4.2 either way. A first reading of 3.4 -> 18.0
1335/// for prefill did not survive a controlled re-run — it was a dirty
1336/// probe cache between configurations, not the graph, and the prefill
1337/// route through the graph is GDN-only in the first place, which this
1338/// dense model never takes.
1339#[derive(Clone, Copy, PartialEq, Eq, Debug)]
1340pub enum GraphPhase {
1341    Prefill,
1342    Decode,
1343}
1344
1345/// The one place that decides whether the whole-token graph runs.
1346///
1347/// `CMF_GPU_WGPU_GRAPH`: `0` off everywhere, `prefill` only for the
1348/// prompt, anything else on everywhere. Unset: desktop-class GPUs take
1349/// it for both phases; phone-class UMA takes it for PREFILL only, which
1350/// is the measurement above rather than a guess — the per-op path keeps
1351/// decode, where it is seventeen times better.
1352pub fn wgpu_graph_on(phase: GraphPhase) -> bool {
1353    match std::env::var("CMF_GPU_WGPU_GRAPH").ok().as_deref() {
1354        Some("0") => false,
1355        Some("prefill") => phase == GraphPhase::Prefill,
1356        Some(_) => true,
1357        None => {
1358            if wgpu_graph_default() {
1359                return true;
1360            }
1361            // Integrated/mobile keeps the per-op path for BOTH phases —
1362            // unchanged, because the measurement that would have bought
1363            // prefill a graph did not reproduce. `=prefill` is there for
1364            // the device where it does; the default does not guess.
1365            let _ = phase;
1366            false
1367        }
1368    }
1369}
1370
1371pub fn wgpu_graph_default() -> bool {
1372    #[cfg(feature = "gpu")]
1373    {
1374        // Discrete cards always; Apple-silicon UMA on macOS too — desktop
1375        // -class GPUs where the graph measured ~2x the CPU on the Qwen3.6
1376        // family (M4: 13.3 tok/s against 7.3). Phone-class UMA (Android/
1377        // iOS builds) keeps the per-op probe path: tiled mobile GPUs have
1378        // turned the ~300-dispatch graph into seconds per token.
1379        matches!(backend(), Backend::Wgpu)
1380            && (crate::gpu_wgpu::discrete_active()
1381                || (cfg!(target_os = "macos") && crate::gpu_wgpu::adapter_up()))
1382    }
1383    #[cfg(not(feature = "gpu"))]
1384    {
1385        false
1386    }
1387}
1388
1389/// q8_row/q8_2f matvec, rows [row0, row0+rows). `xs` — prescaled by the column scale.
1390#[allow(clippy::too_many_arguments, unused_variables)]
1391pub fn q8_matvec_range(
1392    model: &Arc<CmfModel>,
1393    idx: usize,
1394    row0: usize,
1395    row_scale: &[f32],
1396    xs: &[f32],
1397    rows: usize,
1398    cols: usize,
1399    out: &mut [f32],
1400) -> bool {
1401    match backend() {
1402        #[cfg(target_os = "macos")]
1403        Backend::Metal => {
1404            crate::gpu_metal::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
1405        }
1406        #[cfg(feature = "gpu")]
1407        Backend::Wgpu => {
1408            crate::gpu_wgpu::q8_matvec_range(model, idx, row0, row_scale, xs, rows, cols, out)
1409        }
1410        Backend::None => false,
1411    }
1412}
1413
1414/// Decode-exact short q8_2f panel for the banked MiMo head.
1415pub(crate) fn q82_short_rows(
1416    model: &Arc<CmfModel>,
1417    idx: usize,
1418    xs: &[f32],
1419    b: usize,
1420    rows: usize,
1421    cols: usize,
1422    out: &mut [f32],
1423) -> bool {
1424    #[cfg(feature = "gpu")]
1425    if enabled_here() && backend() == Backend::Wgpu {
1426        return crate::gpu_wgpu::q82_short_rows(model, idx, xs, b, rows, cols, out);
1427    }
1428    let _ = (model, idx, xs, b, rows, cols, out);
1429    false
1430}
1431
1432/// GEMM of a prefill batch: `pre` — prescaled inputs row-major [b, cols],
1433/// out — row-major [b, rows].
1434#[allow(clippy::too_many_arguments, unused_variables)]
1435/// The two-field int8 GEMM with the column field left for the device.
1436/// wgpu only — Metal's int8 kernel takes a pre-scaled activation, so the
1437/// caller keeps that path when this returns `false`.
1438#[allow(clippy::too_many_arguments)]
1439pub fn q8_matmat_2f(
1440    model: &Arc<CmfModel>,
1441    idx: usize,
1442    row_scale: &[f32],
1443    col_field: &[f32],
1444    xs: &[f32],
1445    b: usize,
1446    rows: usize,
1447    cols: usize,
1448    out: &mut [f32],
1449) -> bool {
1450    #[allow(unreachable_patterns)]
1451    match backend() {
1452        #[cfg(feature = "gpu")]
1453        Backend::Wgpu => {
1454            crate::gpu_wgpu::q8_matmat_2f(model, idx, row_scale, col_field, xs, b, rows, cols, out)
1455        }
1456        _ => false,
1457    }
1458}
1459
1460pub fn q8_matmat(
1461    model: &Arc<CmfModel>,
1462    idx: usize,
1463    row_scale: &[f32],
1464    pre: &[f32],
1465    b: usize,
1466    rows: usize,
1467    cols: usize,
1468    out: &mut [f32],
1469) -> bool {
1470    match backend() {
1471        #[cfg(target_os = "macos")]
1472        Backend::Metal => {
1473            crate::gpu_metal::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out)
1474        }
1475        #[cfg(feature = "gpu")]
1476        Backend::Wgpu => crate::gpu_wgpu::q8_matmat(model, idx, row_scale, pre, b, rows, cols, out),
1477        Backend::None => false,
1478    }
1479}
1480
1481/// q1 matvec: raw f32 activations, tile-embedded scales. Metal only
1482/// for now (wgpu q1 WGSL is queued); false = CPU fallback.
1483#[allow(unused_variables)]
1484pub fn q1_matvec(
1485    model: &Arc<CmfModel>,
1486    idx: usize,
1487    xs: &[f32],
1488    rows: usize,
1489    cols: usize,
1490    out: &mut [f32],
1491) -> bool {
1492    match backend() {
1493        #[cfg(target_os = "macos")]
1494        Backend::Metal => crate::gpu_metal::q1_matvec(model, idx, xs, rows, cols, out),
1495        #[cfg(feature = "gpu")]
1496        Backend::Wgpu => crate::gpu_wgpu::q1_matvec(model, idx, xs, rows, cols, out),
1497        Backend::None => false,
1498    }
1499}
1500
1501/// Whole attention sub-block on the wgpu token graph (drop-in for
1502/// `qwen_attention`): normed hidden in, O-projection out, resident device
1503/// K/V mirror. false = refusal / not the wgpu backend → CPU path.
1504#[allow(clippy::too_many_arguments)]
1505pub fn attn_dropin(
1506    model: &Arc<CmfModel>,
1507    kv_id: u64,
1508    layer: usize,
1509    normed: &[f32],
1510    wq_idx: usize,
1511    wk_idx: usize,
1512    wv_idx: usize,
1513    wo_idx: usize,
1514    q_norm: Option<&[f32]>,
1515    k_norm: Option<&[f32]>,
1516    late_qk_norm: bool,
1517    invf: &[f32],
1518    nh: usize,
1519    nkv: usize,
1520    hd: usize,
1521    rd: usize,
1522    hidden: usize,
1523    pos: usize,
1524    cap: usize,
1525    gemma: bool,
1526    eps: f32,
1527    cpu_k: &[Vec<f32>],
1528    cpu_v: &[Vec<f32>],
1529    out: &mut [f32],
1530) -> bool {
1531    match backend() {
1532        #[cfg(feature = "gpu")]
1533        Backend::Wgpu => crate::gpu_wgpu::attn_dropin_gpu(
1534            model, kv_id, layer, normed, wq_idx, wk_idx, wv_idx, wo_idx, q_norm, k_norm,
1535            late_qk_norm, invf, nh, nkv, hd, rd, hidden, pos, cap, gemma, eps, cpu_k, cpu_v, out,
1536        ),
1537        #[allow(unused_variables)]
1538        _ => false,
1539    }
1540}
1541
1542/// Descriptor operation attached to a graph weight.  `None` is the default
1543/// for ordinary CMF files; Prism weights are admitted only when the token
1544/// graph carries this explicit transform contract.
1545#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1546pub enum GraphPrismOp {
1547    None,
1548    Forward,
1549    InverseEmbedding,
1550}
1551
1552/// One weight in the whole-token graph: tensor idx + a codec tag (0=q8_row,
1553/// 1=q1, 2=q4_tiled, 3=q1t, 4=f32) + per-row scales (q8_row only) + the raw f32
1554/// data (kind 4 only — small unquantized projections like GDN in_proj_a/b).
1555pub struct GraphW<'a> {
1556    pub idx: usize,
1557    pub kind: u8,
1558    pub row_scale: &'a [f32],
1559    pub data: &'a [f32],
1560    pub prism: GraphPrismOp,
1561    pub affine: bool,
1562}
1563
1564/// A layer's token-mixing op: standard attention or a GDN (linear-attention)
1565/// block. The surrounding norms + SwiGLU FFN are common to both.
1566pub enum GraphAttn<'a> {
1567    Full {
1568        wq: GraphW<'a>,
1569        wk: GraphW<'a>,
1570        wv: GraphW<'a>,
1571        wo: GraphW<'a>,
1572        q_norm: Option<&'a [f32]>,
1573        k_norm: Option<&'a [f32]>,
1574        /// HunYuan dense: q/k norm after RoPE (rope-kernel flag bit 32).
1575        late_qk_norm: bool,
1576        /// (bq, bk, bv) attention biases (Qwen2). None ⇒ no bias.
1577        bias: Option<(&'a [f32], &'a [f32], &'a [f32])>,
1578        /// Qwen3.5 gated attention: wq emits 2·nh·hd (q||gate per head), the
1579        /// attention output is scaled by sigmoid(gate) before the O projection.
1580        output_gate: bool,
1581        cpu_k: &'a [Vec<f32>],
1582        cpu_v: &'a [Vec<f32>],
1583        /// Absolute position of `cpu_k`/`cpu_v` row 0
1584        /// (`LayerKvCache::base`): a sliding layer that keeps only its
1585        /// tail stores rows from there on. 0 for every untrimmed layer.
1586        cpu_base: usize,
1587        /// This layer's own attention geometry, when the model's layers do
1588        /// not share one (MiMo-V2: 4/8 KV heads, 128-wide V under 192-wide
1589        /// heads, sliding windows with learned sinks, two RoPE tables).
1590        /// None = the call-wide (nkv, hd, rd, invf), V as wide as K, full
1591        /// context and a plain softmax — the historical contract, whose
1592        /// kernels and dispatch are untouched.
1593        geom: Option<GraphAttnGeom<'a>>,
1594        /// Spark-X2.5 head-wise output gate: `self_attn.g_proj`
1595        /// `[num_heads, hidden]` against the attention's normed input; head
1596        /// h's output is scaled by sigmoid(g[h]) before the O projection.
1597        /// None = no such gate (every other model).
1598        head_gate: Option<GraphW<'a>>,
1599    },
1600    Gdn {
1601        qkv: GraphW<'a>,
1602        z: GraphW<'a>,
1603        a: GraphW<'a>,
1604        b: GraphW<'a>,
1605        out: GraphW<'a>,
1606        conv1d: &'a [f32],
1607        a_log: &'a [f32],
1608        dt_bias: &'a [f32],
1609        norm: &'a [f32],
1610        nv: usize,
1611        nk: usize,
1612        dk: usize,
1613        dv: usize,
1614        kk: usize,
1615        /// CPU recurrent state `[ring (kk-1)·cdim | S nv·dk·dv]` — seeds the
1616        /// device mirror when prefill ran on the host (o1 collection, CPU
1617        /// fallback): a zero-initialized device state at decode is exactly
1618        /// the "coherent but contextless" garble.
1619        cpu_state: &'a [f32],
1620    },
1621    /// LFM2 gated short convolution: a fused (B, C, x) projection, a
1622    /// depthwise causal conv over a (kernel−1)-deep per-channel ring,
1623    /// C-gating, and an output projection. This mixer is what most of an
1624    /// LFM2 stack is (22 of the 2.6B's 30 layers), and before it had a
1625    /// graph arm the whole model fell to the per-op path — ~100 submits
1626    /// a token, 22 tok/s on an A100 for a 1.4 GB file.
1627    ShortConv {
1628        /// [3·hidden, hidden] fused input projection.
1629        inp: GraphW<'a>,
1630        /// [hidden, hidden] output projection.
1631        out: GraphW<'a>,
1632        /// [hidden · kernel] depthwise taps, `[channel][tap]`, tap
1633        /// kernel−1 multiplying the current position.
1634        taps: &'a [f32],
1635        kernel: usize,
1636        /// CPU conv ring `[channel][kernel−1]`, slot 0 newest — seeds
1637        /// the device mirror when prefill ran on the host, which for
1638        /// this mixer is always (the batch graph declines it).
1639        cpu_state: &'a [f32],
1640    },
1641}
1642
1643/// Per-layer attention geometry for the wgpu graphs (see
1644/// `GraphAttn::Full::geom`). The layer's CPU cache keeps K rows `hd` wide
1645/// and V rows zero-padded to `hd`; the device mirror stores V `dv` wide,
1646/// and a windowed layer keeps a ring of the last positions only.
1647#[derive(Clone, Copy)]
1648pub struct GraphAttnGeom<'a> {
1649    /// KV heads of this layer (divides the Q heads).
1650    pub nkv: usize,
1651    /// Q/K head width of this layer. The call-wide `hd` for every model
1652    /// but Gemma-4, whose global layers are 512 wide over 256-wide sliding
1653    /// ones (`<= 512`, a multiple of 4).
1654    pub hd: usize,
1655    /// V head width, `4 <= dv <= hd`, a multiple of 4.
1656    pub dv: usize,
1657    /// Rotary width of this layer (NeoX half-split over `[0, rd)`).
1658    pub rd: usize,
1659    /// This layer's RoPE inverse frequencies (`rd / 2` of them).
1660    pub invf: &'a [f32],
1661    /// YaRN attention-amplitude factor applied after the rotary pair
1662    /// transform. `1.0` is ordinary RoPE; Mellum's global layers use
1663    /// `1.277258872…`. This is deliberately per-layer: local and global
1664    /// layers may have different RoPE tables and factors.
1665    pub rope_scale: f32,
1666    /// Positions a query sees, its own included (MiMo-V2 SWA: 128);
1667    /// None = the whole context.
1668    pub window: Option<usize>,
1669    /// Learned per-Q-head sink logits (gpt-oss / MiMo-V2): they join the
1670    /// softmax max and denominator and carry no value row.
1671    pub sink: Option<&'a [f32]>,
1672    /// Gemma-4's scale-less V norm: every V head is RMS-normalized (no
1673    /// weight) before it is cached, as `attention::vnorm_head` does.
1674    pub v_norm: bool,
1675}
1676
1677/// Activation of a graph layer's dense FFN, `act(gate)·up`. The code is
1678/// the word the kernels read (`silu_mul_pre`'s `_c`, the fused gate+up
1679/// kernels' `_p1`): 0 keeps the historical SiLU expression untouched.
1680#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1681pub enum GraphAct {
1682    Silu,
1683    /// Exact erf GELU (HF `gelu`), erf by Abramowitz–Stegun 7.1.26 — the
1684    /// formula `inference::erf_f32` uses on the host.
1685    GeluErf,
1686    /// tanh-approximated GELU (HF `gelu_pytorch_tanh`, the Gemma family):
1687    /// `inference::gelu_tanh` term for term.
1688    GeluTanh,
1689}
1690
1691impl GraphAct {
1692    pub fn code(self) -> u32 {
1693        match self {
1694            Self::Silu => 0,
1695            Self::GeluErf => 1,
1696            Self::GeluTanh => 2,
1697        }
1698    }
1699}
1700
1701/// Per-layer weights for the whole-token wgpu graph.
1702pub struct GraphLayer<'a> {
1703    pub input_norm: &'a [f32],
1704    pub attn: GraphAttn<'a>,
1705    pub post_norm: &'a [f32],
1706    pub ffn: GraphFfn<'a>,
1707    /// Gemma sandwich norms: the token mixer's output and the FFN's output
1708    /// are RMS-normed with these weights before their residual adds.
1709    pub attn_out_norm: Option<&'a [f32]>,
1710    pub ffn_out_norm: Option<&'a [f32]>,
1711    /// Gemma-4 `layer_scalar`: the residual stream is multiplied by it at
1712    /// the end of the layer.
1713    pub layer_scale: Option<f32>,
1714}
1715
1716/// The FFN of one graph layer: a dense SwiGLU trio, or a routed MoE —
1717/// router + top-k selection + all selected experts run ON DEVICE (the
1718/// routing decision depends on the resident hidden state, so a CPU
1719/// round-trip per layer would forfeit the one-submit design).
1720pub enum GraphFfn<'a> {
1721    /// A singleton attention-only batch graph. Returns the post-attention
1722    /// residual, allowing a dynamic expert bank to own the FFN separately.
1723    AttentionOnly,
1724    Dense {
1725        gate: GraphW<'a>,
1726        up: GraphW<'a>,
1727        down: GraphW<'a>,
1728        /// act(gate)·up. The builders refuse an activation with no arm here
1729        /// (before this field the graph computed SiLU for any dense FFN).
1730        act: GraphAct,
1731    },
1732    Moe {
1733        /// Router logits weight (f32, kind 4) `[n_exp, hidden]`.
1734        router: GraphW<'a>,
1735        /// Shared-expert sigmoid gate (f32) `[1, hidden]`.
1736        shared_gate: GraphW<'a>,
1737        /// Per-expert q4_tiled directory indices `(gate, up, down)`;
1738        /// the SHARED expert rides as the LAST entry — the select
1739        /// kernel pins it with the sigmoid weight.
1740        experts: Vec<(usize, usize, usize)>,
1741        /// Routed experts (shared excluded).
1742        n_exp: usize,
1743        top_k: usize,
1744        inter: usize,
1745        norm_topk: bool,
1746        /// Expert weight layout, uniform across the layer: `false` =
1747        /// q4_tiled (18 B tiles, inline f16 scale), `true` = q4tp
1748        /// (16 B nibbles + a per-row ladder plane). The two differ only
1749        /// in where the scale comes from, so they share every kernel
1750        /// but the weight-staging block.
1751        q4tp: bool,
1752        /// `true` = the gate/up experts are `q2tp` (2-bit plane) while
1753        /// `down` stays q4tp — the mixed profile a 2-bit-class checkpoint
1754        /// converts into. Only meaningful with `q4tp: true`.
1755        gu_q2: bool,
1756        /// `true` = every expert's gate, up AND down is q8_2f (int8 body,
1757        /// f16 row scales, f16 column field; Mellum2.1's quality file).
1758        /// `q4tp` and `gu_q2` are false then. Its own kernels: each
1759        /// expert's input is multiplied by THAT expert's column field.
1760        q82: bool,
1761        /// LFM2-MoE / DeepSeek-V3 `noaux_tc` routing: per-expert sigmoid
1762        /// scores instead of a softmax, and `norm_topk` renormalises with
1763        /// the 1e-6 floor. The softmax arm is bit-identical to before.
1764        sigmoid: bool,
1765        /// Per-expert SELECTION bias: added to the score for the top-k
1766        /// choice only — the mixing weights stay unbiased (noaux_tc).
1767        bias: Option<&'a [f32]>,
1768        /// Whether a shared expert rides as the last `experts` entry.
1769        /// LFM2-MoE has none; the select kernel then leaves slot `top_k`
1770        /// unwritten and the expert loop runs `top_k` slots, not +1.
1771        has_shared: bool,
1772        /// The shared expert carries a sigmoid gate (Qwen2/3-MoE). `false`
1773        /// with `has_shared`: the shared expert enters with weight 1
1774        /// (DeepSeek-V3 / HunYuan hy_v3) and `shared_gate` is a stand-in
1775        /// the select kernels ignore.
1776        shared_gated: bool,
1777        /// Multiplier on the routed mixing weights after the optional
1778        /// renormalization (`routed_scaling_factor`); 1.0 = none.
1779        route_scale: f32,
1780    },
1781}
1782
1783/// Outcome of one whole-token graph attempt. A failed attempt after sealed
1784/// O(1) state was admitted must not fall through to the stale CPU state.
1785#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1786pub enum TokenGraphOutcome {
1787    /// No command was committed; the caller may use its ordinary path.
1788    Declined,
1789    /// The graph completed and its hidden/logits output is valid.
1790    Completed,
1791    /// Sealed O(1) state was admitted and a later graph operation failed.
1792    Failed,
1793}
1794
1795/// Whole-token decode graph on wgpu: the entire layer stack in ONE submit,
1796/// hidden resident, one readback. Updates `h` in place.
1797/// `loop_norm_at`: virtual layer indices after which `final_norm` is applied
1798/// (Looped Transformer mid-stack norm). Empty for standard models.
1799#[allow(clippy::too_many_arguments)]
1800pub fn forward_token_graph(
1801    model: &Arc<CmfModel>,
1802    kv_id: u64,
1803    layers: &[GraphLayer],
1804    // Per-layer sealed o1 (Nystrom) state; Some = replace this layer's
1805    // exact attention with the O(1) kernels. wgpu only.
1806    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
1807    o1_epoch: u64,
1808    invf: &[f32],
1809    h: &mut [f32],
1810    nh: usize,
1811    nkv: usize,
1812    hd: usize,
1813    attn_scale: f32,
1814    rd: usize,
1815    hidden: usize,
1816    inter: usize,
1817    position: usize,
1818    cap: usize,
1819    gemma: bool,
1820    eps: f32,
1821    lm_head: Option<(&GraphW, usize)>,
1822    final_norm: &[f32],
1823    logits: &mut Vec<f32>,
1824    loop_norm_at: &[usize],
1825    steps: usize,
1826    embed: Option<(&GraphW, usize, f32)>,
1827    ids_out: Option<&mut Vec<u32>>,
1828    // How many leading layers the graph ran (see the wgpu twin) — smaller
1829    // than layers.len() when the expert budget ended the device prefix.
1830    layers_run: Option<&mut usize>,
1831    // Absolute index of layers[0] in the model — the KV/state mirrors key
1832    // on it, so a layer SPAN (network split segment) shares mirrors with
1833    // a full-stack run instead of colliding at slot 0.
1834    layer_base: usize,
1835    // Read the final hidden back alongside the fused head's logits.
1836    hidden_too: bool,
1837) -> TokenGraphOutcome {
1838    match backend() {
1839        #[cfg(feature = "gpu")]
1840        Backend::Wgpu => crate::gpu_wgpu::forward_token_graph(
1841            model,
1842            kv_id,
1843            layers,
1844            o1,
1845            o1_epoch,
1846            invf,
1847            h,
1848            nh,
1849            nkv,
1850            hd,
1851            attn_scale,
1852            rd,
1853            hidden,
1854            inter,
1855            position,
1856            cap,
1857            gemma,
1858            eps,
1859            lm_head,
1860            final_norm,
1861            logits,
1862            loop_norm_at,
1863            steps,
1864            embed,
1865            ids_out,
1866            layers_run,
1867            layer_base,
1868            hidden_too,
1869        ),
1870        #[allow(unused_variables)]
1871        _ => {
1872            let _ = (
1873                attn_scale,
1874                lm_head,
1875                final_norm,
1876                logits,
1877                loop_norm_at,
1878                layers_run,
1879                layer_base,
1880                hidden_too,
1881            );
1882            TokenGraphOutcome::Declined
1883        }
1884    }
1885}
1886
1887/// Whole-token resident graph for the Embryo working model.  Unlike the
1888/// generic graph this path accepts a packed f32 model and keeps both phase
1889/// recurrent state and the anchor KV cache on the device.  `false` is an
1890/// honest capability refusal; callers must retain the CPU executor.
1891pub fn forward_embryo_graph(
1892    model: &Arc<EmbryoGraphModel>,
1893    kv_id: u64,
1894    hidden: &[f32],
1895    position: usize,
1896    logits: &mut Vec<f32>,
1897) -> bool {
1898    #[cfg(feature = "gpu")]
1899    if backend() == Backend::Wgpu {
1900        return crate::gpu_wgpu::forward_embryo_graph(model, kv_id, hidden, position, logits);
1901    }
1902    let _ = (model, kv_id, hidden, position, logits);
1903    false
1904}
1905
1906/// Speculative-verify tail for the batched graph: fold final-norm + lm_head
1907/// over every batch position and read all k logit rows back; the batch also
1908/// snapshots the GDN state per position for `gdn_spec_restore`.
1909#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1910pub enum BatchGraphOutcome {
1911    /// The graph declined before mutating persistent device state. Callers may
1912    /// safely use the existing per-position path.
1913    Declined,
1914    /// The complete batch committed and its readback succeeded.
1915    Completed,
1916    /// A batch that had admitted sealed O(1) state failed after admission.
1917    /// Falling back to CPU would mix two state machines, so the caller must
1918    /// abort and clear the sequence instead.
1919    Failed,
1920}
1921
1922pub struct SpecTail<'a> {
1923    pub lm: GraphW<'a>,
1924    pub lm_rows: usize,
1925    pub final_norm: &'a [f32],
1926    pub logits_out: &'a mut Vec<f32>,
1927}
1928
1929/// Batched prefill: k contiguous positions through the whole graph in one submit
1930/// (projections/FFN as GEMMs, attention/GDN looped over scratch). `h` is
1931/// [k·hidden] in/out; `positions` len k. wgpu only.
1932#[allow(clippy::too_many_arguments)]
1933pub fn forward_batch_graph(
1934    model: &Arc<CmfModel>,
1935    kv_id: u64,
1936    layers: &[GraphLayer],
1937    invf: &[f32],
1938    h: &mut [f32],
1939    nh: usize,
1940    nkv: usize,
1941    hd: usize,
1942    rd: usize,
1943    hidden: usize,
1944    inter: usize,
1945    positions: &[usize],
1946    cap: usize,
1947    gemma: bool,
1948    eps: f32,
1949    attn_scale: f32,
1950    k: usize,
1951    // Per-layer sealed O(1) device views. An empty slice means the ordinary
1952    // exact-KV path; otherwise it must have one entry per graph layer.
1953    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
1954    o1_epoch: u64,
1955    spec: Option<SpecTail<'_>>,
1956    // Device-prefix mode (plain prefill only): Some = when the whole stack
1957    // does not fit the weight budget, run the leading layers that do — the
1958    // same prefix rule as the token graph — leave the boundary hidden in
1959    // `h` and report the count here; the caller runs the rest on the host.
1960    // None = all layers or a decline, as before.
1961    layers_run: Option<&mut usize>,
1962) -> BatchGraphOutcome {
1963    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)
1964}
1965
1966thread_local! {
1967    static MIMO_ATTN_SCRATCH: std::cell::Cell<bool> = const { std::cell::Cell::new(true) };
1968}
1969
1970pub(crate) fn mimo_attention_scratch_enabled() -> bool {
1971    MIMO_ATTN_SCRATCH.with(std::cell::Cell::get)
1972}
1973
1974/// Scoped diagnostic A/B switch; unlike process environment mutations it
1975/// cannot race a model's background workers. Restores on panic as well.
1976#[doc(hidden)]
1977pub fn mimo_attention_scratch_scope<R>(enabled: bool, f: impl FnOnce() -> R) -> R {
1978    struct Restore(bool);
1979    impl Drop for Restore {
1980        fn drop(&mut self) {
1981            MIMO_ATTN_SCRATCH.with(|v| v.set(self.0));
1982        }
1983    }
1984    let _restore = Restore(MIMO_ATTN_SCRATCH.with(|v| v.replace(enabled)));
1985    f()
1986}
1987
1988/// Gemma-4's prompt on the batched wgpu graph (`CMF_G4_BATCH=0` keeps the
1989/// chunked host prefill it used before).
1990pub fn g4_batch_on() -> bool {
1991    static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
1992    *ON.get_or_init(|| std::env::var("CMF_G4_BATCH").as_deref() != Ok("0"))
1993}
1994
1995/// q8_2f MoE experts on the wgpu token and batch graphs (`CMF_MOE_Q82=0`
1996/// keeps them off the graphs: every op on its own, the 0.8.15 route).
1997pub(crate) fn moe_q82_graph_on() -> bool {
1998    static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
1999    *ON.get_or_init(|| std::env::var("CMF_MOE_Q82").as_deref() != Ok("0"))
2000}
2001
2002thread_local! {
2003    static MIMO_Q8_SHORT: std::cell::Cell<bool> = const { std::cell::Cell::new(true) };
2004}
2005
2006pub(crate) fn mimo_q8_short_enabled() -> bool {
2007    MIMO_Q8_SHORT.with(std::cell::Cell::get)
2008}
2009
2010/// Diagnostic A/B switch for row-exact short q8 graph kernels.
2011#[doc(hidden)]
2012pub fn mimo_q8_short_scope<R>(enabled: bool, f: impl FnOnce() -> R) -> R {
2013    struct Restore(bool);
2014    impl Drop for Restore {
2015        fn drop(&mut self) {
2016            MIMO_Q8_SHORT.with(|v| v.set(self.0));
2017        }
2018    }
2019    let _restore = Restore(MIMO_Q8_SHORT.with(|v| v.replace(enabled)));
2020    f()
2021}
2022
2023/// Batched graph over a span whose first absolute layer is `layer_base`.
2024#[allow(clippy::too_many_arguments)]
2025pub fn forward_batch_graph_at(
2026    model: &Arc<CmfModel>,
2027    kv_id: u64,
2028    layer_base: usize,
2029    layers: &[GraphLayer],
2030    invf: &[f32],
2031    h: &mut [f32],
2032    nh: usize,
2033    nkv: usize,
2034    hd: usize,
2035    rd: usize,
2036    hidden: usize,
2037    inter: usize,
2038    positions: &[usize],
2039    cap: usize,
2040    gemma: bool,
2041    eps: f32,
2042    attn_scale: f32,
2043    k: usize,
2044    // Per-layer sealed O(1) device views. An empty slice means the ordinary
2045    // exact-KV path; otherwise it must have one entry per graph layer.
2046    o1: &[Option<Vec<crate::nystrom::O1DeviceView<'_>>>],
2047    o1_epoch: u64,
2048    spec: Option<SpecTail<'_>>,
2049    // Device-prefix mode (plain prefill only): Some = when the whole stack
2050    // does not fit the weight budget, run the leading layers that do — the
2051    // same prefix rule as the token graph — leave the boundary hidden in
2052    // `h` and report the count here; the caller runs the rest on the host.
2053    // None = all layers or a decline, as before.
2054    layers_run: Option<&mut usize>,
2055) -> BatchGraphOutcome {
2056    match backend() {
2057        #[cfg(feature = "gpu")]
2058        Backend::Wgpu => crate::gpu_wgpu::forward_batch_graph_at(
2059            model, kv_id, layer_base, layers, invf, h, nh, nkv, hd, rd, hidden, inter, positions,
2060            cap, gemma, eps, attn_scale, k, o1, o1_epoch, spec, layers_run,
2061        ),
2062        #[allow(unreachable_patterns)]
2063        _ => {
2064            let _ = (o1, o1_epoch, spec, layers_run);
2065            BatchGraphOutcome::Declined
2066        }
2067    }
2068}
2069
2070/// After a partial speculative acceptance: restore every GDN layer's device
2071/// state to the snapshot after batch position `slot`. `base_pos` is the
2072/// absolute position of the first verify row and `expected_layers` makes the
2073/// restore all-or-nothing across the model's recurrent layers. wgpu only.
2074pub fn gdn_spec_restore(kv_id: u64, slot: usize, base_pos: usize, expected_layers: usize) -> bool {
2075    #[cfg(feature = "gpu")]
2076    if backend() == Backend::Wgpu {
2077        return crate::gpu_wgpu::gdn_spec_restore(kv_id, slot, base_pos, expected_layers);
2078    }
2079    #[allow(unreachable_code)]
2080    {
2081        let _ = (kv_id, slot, base_pos, expected_layers);
2082        false
2083    }
2084}
2085
2086/// Re-point one exact-attention device mirror after a speculative round has
2087/// discarded unaccepted rows. The rows beyond `stored` remain allocated and
2088/// are overwritten by the next append; only the logical cursor moves. This
2089/// is the wgpu twin of Metal's existing mirror cursor helper and keeps the
2090/// MTP graph's speculative/device cache coherent with its real anchor.
2091pub fn graph_kv_set_stored(kv_id: u64, layer: usize, stored: usize) -> bool {
2092    #[cfg(feature = "gpu")]
2093    if backend() == Backend::Wgpu {
2094        return crate::gpu_wgpu::kv_mirror_set_stored(kv_id, layer, stored);
2095    }
2096    #[cfg(target_os = "macos")]
2097    if backend() == Backend::Metal {
2098        crate::gpu_metal::kv_mirror_set_stored(kv_id, layer, stored);
2099        return true;
2100    }
2101    false
2102}
2103
2104/// Rows the wgpu token graph's exact-attention mirror holds for one layer
2105/// (None: no wgpu mirror). Metal keeps its owner cache current per token
2106/// and reports None here.
2107pub fn graph_kv_stored(_kv_id: u64, _layer: usize) -> Option<usize> {
2108    #[cfg(feature = "gpu")]
2109    if backend() == Backend::Wgpu {
2110        return crate::gpu_wgpu::kv_mirror_stored(_kv_id, _layer);
2111    }
2112    None
2113}
2114
2115/// Does the wgpu token graph hold a device-resident recurrent state for
2116/// this layer (one the host `linear_state` has not seen)?
2117pub fn graph_state_resident(_kv_id: u64, _layer: usize) -> bool {
2118    #[cfg(feature = "gpu")]
2119    if backend() == Backend::Wgpu {
2120        return crate::gpu_wgpu::graph_state_resident(_kv_id, _layer);
2121    }
2122    false
2123}
2124
2125/// Copy rows back from the wgpu token graph's K/V mirrors in one submit:
2126/// for each `(layer, from, to)` the K and V rows `[from..to)`, position-major
2127/// (`[(to − from) × nkv × hd]` each).
2128pub fn graph_kv_read_rows(
2129    _kv_id: u64,
2130    _reqs: &[(usize, usize, usize)],
2131    _nkv: usize,
2132    _hd: usize,
2133) -> Option<Vec<(Vec<f32>, Vec<f32>)>> {
2134    #[cfg(feature = "gpu")]
2135    if backend() == Backend::Wgpu {
2136        return crate::gpu_wgpu::kv_mirror_read_rows(_kv_id, _reqs, _nkv, _hd);
2137    }
2138    None
2139}
2140
2141/// Rows `[from, to)` of one wgpu exact-attention mirror in the host
2142/// cache's layout (V zero-padded to `hd`), whatever the mirror's geometry
2143/// (narrow V, a sliding layer's ring). The third value is the first
2144/// position actually read: a ring returns zeros below it. None: no wgpu
2145/// mirror holding those rows at (nkv, hd).
2146pub fn graph_kv_pull_host(
2147    _kv_id: u64,
2148    _layer: usize,
2149    _from: usize,
2150    _to: usize,
2151    _nkv: usize,
2152    _hd: usize,
2153) -> Option<(Vec<f32>, Vec<f32>, usize)> {
2154    #[cfg(feature = "gpu")]
2155    if backend() == Backend::Wgpu {
2156        return crate::gpu_wgpu::kv_mirror_pull_host(_kv_id, _layer, _from, _to, _nkv, _hd);
2157    }
2158    None
2159}
2160
2161/// Drop the wgpu token graph's device K/V mirror for a pipeline.
2162pub fn graph_kv_reset(_kv_id: u64) {
2163    #[cfg(feature = "gpu")]
2164    if backend() == Backend::Wgpu {
2165        crate::gpu_wgpu::kv_mirror_reset(_kv_id);
2166        crate::gpu_wgpu::embryo_graph_reset(_kv_id);
2167    }
2168}
2169
2170/// Ternary (q1t) BASE matvec on the GPU — fills `out` with the base dot; the
2171/// caller adds the sparse overlay on the CPU. Metal only for now (wgpu q1t not
2172/// yet written → CPU fallback).
2173pub fn q1t_matvec(
2174    model: &Arc<CmfModel>,
2175    idx: usize,
2176    xs: &[f32],
2177    rows: usize,
2178    cols: usize,
2179    out: &mut [f32],
2180) -> bool {
2181    match backend() {
2182        #[cfg(target_os = "macos")]
2183        Backend::Metal => {
2184            if metal_q1t_enabled() {
2185                crate::gpu_metal::q1t_matvec(model, idx, xs, rows, cols, out)
2186            } else {
2187                false
2188            }
2189        }
2190        #[cfg(feature = "gpu")]
2191        Backend::Wgpu => crate::gpu_wgpu::q1t_matvec(model, idx, xs, rows, cols, out),
2192        Backend::None => false,
2193    }
2194}
2195
2196/// q4_block matvec on the GPU — wgpu only (Metal drives q4_block through the
2197/// whole-token graph, not a standalone matvec).
2198#[allow(unused_variables)]
2199pub fn q4b_matvec(
2200    model: &Arc<CmfModel>,
2201    idx: usize,
2202    xs: &[f32],
2203    rows: usize,
2204    cols: usize,
2205    out: &mut [f32],
2206) -> bool {
2207    match backend() {
2208        #[cfg(target_os = "macos")]
2209        Backend::Metal => false,
2210        #[cfg(feature = "gpu")]
2211        Backend::Wgpu => crate::gpu_wgpu::q4b_matvec(model, idx, xs, rows, cols, out),
2212        Backend::None => false,
2213    }
2214}
2215
2216/// q1t batched GEMM (prefill) — base + overlay on-device (Metal simdgroup or
2217/// wgpu register-blocked).
2218pub fn q1t_matmat(
2219    model: &Arc<CmfModel>,
2220    idx: usize,
2221    xs: &[f32],
2222    b: usize,
2223    rows: usize,
2224    cols: usize,
2225    out: &mut [f32],
2226) -> bool {
2227    match backend() {
2228        #[cfg(target_os = "macos")]
2229        // Batched prefill and single-token decode are both enabled. On the
2230        // real 14.8B Q1T model prefill PPL was within 0.3% of CPU (7.942 vs
2231        // 7.966), and the alignment-safe decode kernel reached 3.52e-6 max_rel.
2232        Backend::Metal => crate::gpu_metal::q1t_matmat(model, idx, xs, b, rows, cols, out),
2233        #[cfg(feature = "gpu")]
2234        Backend::Wgpu => crate::gpu_wgpu::q1t_matmat(model, idx, xs, b, rows, cols, out),
2235        Backend::None => false,
2236    }
2237}
2238
2239/// Native Metal Q1T switch. Enabled by default after the byte-packed Q1T
2240/// fields were changed to alignment-safe loads; keep an explicit emergency
2241/// fallback for device/driver diagnostics.
2242#[cfg(target_os = "macos")]
2243pub(crate) fn metal_q1t_enabled() -> bool {
2244    std::env::var("CMF_METAL_Q1T")
2245        .map(|v| v != "0" && !v.eq_ignore_ascii_case("off"))
2246        .unwrap_or(true)
2247}
2248
2249/// Batched q1 GEMM (prefill). wgpu only — Metal has its own block path.
2250pub fn q1_matmat(
2251    model: &Arc<CmfModel>,
2252    idx: usize,
2253    xs: &[f32],
2254    b: usize,
2255    rows: usize,
2256    cols: usize,
2257    out: &mut [f32],
2258) -> bool {
2259    match backend() {
2260        #[cfg(feature = "gpu")]
2261        Backend::Wgpu => crate::gpu_wgpu::q1_matmat(model, idx, xs, b, rows, cols, out),
2262        #[allow(unused_variables)]
2263        _ => false,
2264    }
2265}
2266
2267/// Contention kill for the wide imagegen GEMM/FFN paths: one grossly
2268/// slow op under a work-proportional budget (fair-device ops are
2269/// ≤~100 ms even at 1024px) means another process owns the device —
2270/// verdicts are per-process, so CPU for the rest of this one.
2271static MM_KILL: AtomicBool = AtomicBool::new(false);
2272pub(crate) fn mm_killed() -> bool {
2273    MM_KILL.load(Ordering::Relaxed)
2274}
2275pub(crate) fn mm_kill() {
2276    MM_KILL.store(true, Ordering::Relaxed);
2277}
2278
2279/// Consecutive over-budget ops. ONE slow op is not contention: on a
2280/// 24 GB Mac running the 25.7 GB fl2va file the first ops after the
2281/// prompt encode page their weights in from the SSD and take seconds —
2282/// a field report (hololabs, HF discussion #2) had to neuter the kill
2283/// to keep the denoise on the GPU, and then measured 48 s/step where the
2284/// CPU fallback took >60. Contention is persistent; a page-in is not.
2285static MM_STRIKES: std::sync::atomic::AtomicU32 = std::sync::atomic::AtomicU32::new(0);
2286const MM_STRIKES_TO_KILL: u32 = 3;
2287/// Whether the kill is armed at all. A one-shot phase whose slowness is
2288/// expected and not contention — the video prompt encoder streaming
2289/// 12 GB off the SSD on a 24 GB Mac (HF discussion #4: users had to
2290/// gut `mm_kill` to keep the denoise loop on the GPU) — disarms it and
2291/// re-arms it when the phase is over; strikes taken meanwhile are
2292/// forgotten.
2293static MM_ARMED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(true);
2294
2295/// Disarm / re-arm the contention kill around a phase whose GEMMs are
2296/// slow for reasons that are not another process (see `MM_ARMED`).
2297pub fn mm_kill_arm(on: bool) {
2298    MM_ARMED.store(on, Ordering::Relaxed);
2299    if on {
2300        MM_STRIKES.store(0, Ordering::Relaxed);
2301    }
2302}
2303
2304/// The contention verdict for one wide op: `el` against its
2305/// work-proportional `budget`. `exempt` marks ops whose time is not
2306/// evidence — the cold probe, or a weight that was not resident before
2307/// the call and rode in with it. Kills after `MM_STRIKES_TO_KILL`
2308/// consecutive strikes; a within-budget op clears the count.
2309/// `CMF_MM_KILL=0` disables the kill entirely (the device is trusted).
2310pub(crate) fn mm_budget_check(
2311    what: &str,
2312    el: std::time::Duration,
2313    budget: std::time::Duration,
2314    exempt: bool,
2315) {
2316    if el <= budget {
2317        MM_STRIKES.store(0, Ordering::Relaxed);
2318        return;
2319    }
2320    if exempt || !MM_ARMED.load(Ordering::Relaxed) {
2321        return;
2322    }
2323    static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
2324    let on = *ON.get_or_init(|| std::env::var("CMF_MM_KILL").as_deref() != Ok("0"));
2325    let n = MM_STRIKES.fetch_add(1, Ordering::Relaxed) + 1;
2326    if !on {
2327        tracing::info!(
2328            "gpu {what} took {el:?} (budget {budget:?}) — over budget, CMF_MM_KILL=0 keeps the device"
2329        );
2330        return;
2331    }
2332    if n >= MM_STRIKES_TO_KILL {
2333        tracing::warn!(
2334            "gpu {what} took {el:?} (budget {budget:?}), {n} in a row — \
2335             device contended, CPU for the rest of the process (CMF_MM_KILL=0 to override)"
2336        );
2337        mm_kill();
2338    } else {
2339        tracing::info!(
2340            "gpu {what} took {el:?} (budget {budget:?}) — strike {n} of {MM_STRIKES_TO_KILL}"
2341        );
2342    }
2343}
2344
2345/// Fused DiT SwiGLU FFN on the device: g=X·W1ᵀ, u=X·W3ᵀ, silu(g)·u,
2346/// Causal chunk attention on the device: `b` queries against `s0 + b`
2347/// cached keys. wgpu only — Metal's chunk graph keeps attention inside
2348/// the resident block and never calls out.
2349#[allow(unused_variables, clippy::too_many_arguments)]
2350pub fn chunk_attend(
2351    q: &[f32],
2352    k: &[&[f32]],
2353    v: &[&[f32]],
2354    b: usize,
2355    s0: usize,
2356    nh: usize,
2357    nkv: usize,
2358    hd: usize,
2359    scale: f32,
2360    out: &mut [f32],
2361) -> bool {
2362    match backend() {
2363        #[cfg(feature = "gpu")]
2364        Backend::Wgpu => crate::gpu_wgpu::chunk_attend(q, k, v, b, s0, nh, nkv, hd, scale, out),
2365        #[allow(unreachable_patterns)]
2366        _ => false,
2367    }
2368}
2369
2370/// `chunk_attend` under a sliding window (`window` keys, the query's own
2371/// included). wgpu only; see `chunk_attend_windowed`.
2372#[allow(unused_variables, clippy::too_many_arguments)]
2373pub fn chunk_attend_win(
2374    q: &[f32],
2375    k: &[&[f32]],
2376    v: &[&[f32]],
2377    b: usize,
2378    s0: usize,
2379    nh: usize,
2380    nkv: usize,
2381    hd: usize,
2382    scale: f32,
2383    window: usize,
2384    out: &mut [f32],
2385) -> bool {
2386    match backend() {
2387        #[cfg(feature = "gpu")]
2388        Backend::Wgpu => {
2389            crate::gpu_wgpu::chunk_attend_win(q, k, v, b, s0, nh, nkv, hd, scale, window, out)
2390        }
2391        #[allow(unreachable_patterns)]
2392        _ => false,
2393    }
2394}
2395
2396/// Several projections of one host activation, read back in one trip:
2397/// `out` = [P0 | P1 | …], each `idxs` entry (tensor, rows). wgpu only.
2398#[allow(unused_variables)]
2399pub fn gemm_many_keep(
2400    model: &Arc<CmfModel>,
2401    idxs: &[(usize, usize)],
2402    xs: &[f32],
2403    b: usize,
2404    cols: usize,
2405    out: &mut [f32],
2406) -> bool {
2407    match backend() {
2408        #[cfg(feature = "gpu")]
2409        Backend::Wgpu => crate::gpu_wgpu::gemm_many_keep(model, idxs, xs, b, cols, out),
2410        #[allow(unreachable_patterns)]
2411        _ => false,
2412    }
2413}
2414
2415thread_local! {
2416    /// Set by the pipeline around a layer of Spark-X2.5's batched prefill:
2417    /// its int8 matrix-unit GEMMs may take the `zi_mm` tile, and the
2418    /// projections that read one activation share its upload (wgpu).
2419    static PREFILL_FAST_GEMM: Cell<bool> = const { Cell::new(false) };
2420}
2421
2422/// Restores the previous flag on drop.
2423pub struct PrefillFastGemmGuard(bool);
2424
2425impl Drop for PrefillFastGemmGuard {
2426    fn drop(&mut self) {
2427        PREFILL_FAST_GEMM.with(|c| c.set(self.0));
2428    }
2429}
2430
2431/// Let this thread's int8 matrix-unit GEMMs take the `zi_mm` tile for the
2432/// guard's lifetime (bit-identical to the 64x64 kernel; see
2433/// `gpu_wgpu::zi_gemm_route`).
2434pub fn enter_prefill_fast_gemm() -> PrefillFastGemmGuard {
2435    PrefillFastGemmGuard(PREFILL_FAST_GEMM.with(|c| c.replace(true)))
2436}
2437
2438/// Whether `enter_prefill_fast_gemm` is in force on this thread.
2439pub fn prefill_fast_gemm() -> bool {
2440    PREFILL_FAST_GEMM.with(|c| c.get())
2441}
2442
2443/// The largest finite f16. An operand the matrix-unit attention casts to
2444/// f16 must stay within it, or the cast overflows to inf.
2445pub const F16_MAX: f32 = 65504.0;
2446
2447/// max |x| over `xs`, or +inf when an entry is inf or NaN: the value the
2448/// f16 operand guards compare with `F16_MAX`. Sixteen independent lanes
2449/// and a flag, so it vectorizes (a single `fold` chain does not).
2450pub fn abs_max_or_inf(xs: &[f32]) -> f32 {
2451    let mut acc = [0f32; 16];
2452    let mut bad = [false; 16];
2453    let mut it = xs.chunks_exact(16);
2454    for c in &mut it {
2455        for ((a, f), &v) in acc.iter_mut().zip(bad.iter_mut()).zip(c) {
2456            let v = v.abs();
2457            // NaN compares false both ways: flagged, never taken.
2458            *f |= !(v < f32::INFINITY);
2459            *a = if v > *a { v } else { *a };
2460        }
2461    }
2462    let mut m = 0f32;
2463    for &v in it.remainder() {
2464        let v = v.abs();
2465        if !(v < f32::INFINITY) {
2466            return f32::INFINITY;
2467        }
2468        m = m.max(v);
2469    }
2470    if bad.iter().any(|&f| f) {
2471        return f32::INFINITY;
2472    }
2473    acc.iter().fold(m, |m, &a| m.max(a))
2474}
2475
2476/// The decode graph's device K/V mirror a prefill chunk of one layer also
2477/// writes to (wgpu): `kv_id` is the pipeline's graph id, `layer` the
2478/// virtual layer index, `limit` the cache's `max_seq_len` — the same key
2479/// and capacity ceiling the token graph uses, so the mirror the prefill
2480/// fills is the one the first decode token reads.
2481#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2482pub struct PrefillMirror {
2483    pub kv_id: u64,
2484    pub layer: usize,
2485    pub limit: usize,
2486}
2487
2488thread_local! {
2489    /// Set by the pipeline around one layer's batched attention (see
2490    /// `enter_prefill_mirror`); every other caller of the batched
2491    /// attention (MTP heads, tests) sees None and keeps the host upload.
2492    static PREFILL_MIRROR: Cell<Option<PrefillMirror>> = const { Cell::new(None) };
2493}
2494
2495/// Restores the previous target on drop.
2496pub struct PrefillMirrorGuard(Option<PrefillMirror>);
2497
2498impl Drop for PrefillMirrorGuard {
2499    fn drop(&mut self) {
2500        PREFILL_MIRROR.with(|c| c.set(self.0));
2501    }
2502}
2503
2504/// Name the device mirror the current layer's prefill chunk appends to
2505/// and attends against, for the guard's lifetime.
2506pub fn enter_prefill_mirror(t: PrefillMirror) -> PrefillMirrorGuard {
2507    PrefillMirrorGuard(PREFILL_MIRROR.with(|c| c.replace(Some(t))))
2508}
2509
2510/// The mirror `enter_prefill_mirror` named on this thread, if any.
2511pub fn prefill_mirror() -> Option<PrefillMirror> {
2512    PREFILL_MIRROR.with(|c| c.get())
2513}
2514
2515/// `chunk_attend_win` against the decode graph's device mirror instead of
2516/// an upload of the whole prefix: the host rows the mirror lacks (the
2517/// chunk's own `b`, or more after a host-only chunk) are appended first,
2518/// then the attention binds the mirror rows in place. `s0` is the chunk's
2519/// first position and `base` the position of host row 0
2520/// (`LayerKvCache::base`: past 0 on a trimmed sliding tail). `ring` is the
2521/// layer's window as the mirror geometry (Some on every sliding layer),
2522/// `window` the window the softmax masks with (0 while it masks nothing).
2523/// `operand_max` = max |x| over `q` and every K/V row the attend reads
2524/// (`abs_max_or_inf`; +inf when unknown): past `F16_MAX` the f32 kernels
2525/// run instead of the matrix units. wgpu only; false = nothing attended
2526/// (the caller uploads as before).
2527#[allow(unused_variables, clippy::too_many_arguments)]
2528pub fn chunk_attend_mirror(
2529    t: PrefillMirror,
2530    cpu_k: &[Vec<f32>],
2531    cpu_v: &[Vec<f32>],
2532    base: usize,
2533    q: &[f32],
2534    b: usize,
2535    s0: usize,
2536    nh: usize,
2537    nkv: usize,
2538    hd: usize,
2539    scale: f32,
2540    ring: Option<usize>,
2541    window: usize,
2542    operand_max: f32,
2543    out: &mut [f32],
2544) -> bool {
2545    match backend() {
2546        #[cfg(feature = "gpu")]
2547        // QKᵀ and P·V on the matrix units where the device has them (f16
2548        // operands, f32 accumulators — not bit-identical to the f32
2549        // kernels: Spark-X2.5 4B q8_2f wiki ppl 10.677 -> 10.672);
2550        // `CMF_PREFILL_ATTN_COOP=0` keeps the f32 ones (A/B).
2551        Backend::Wgpu => crate::gpu_wgpu::chunk_attend_mirror(
2552            t.kv_id,
2553            t.layer,
2554            t.limit,
2555            cpu_k,
2556            cpu_v,
2557            base,
2558            q,
2559            b,
2560            s0,
2561            nh,
2562            nkv,
2563            hd,
2564            scale,
2565            ring,
2566            window,
2567            std::env::var("CMF_PREFILL_ATTN_COOP").as_deref() != Ok("0"),
2568            operand_max,
2569            out,
2570        ),
2571        #[allow(unreachable_patterns)]
2572        _ => false,
2573    }
2574}
2575
2576/// `chunk_attend_mirror`, then the head gate (`gains`, b × nh, computed on
2577/// the host) and the O projection `wo` on the card: the attention output
2578/// never comes home. `out` = [b][hidden]. The card scans the O operand
2579/// itself, which is the host path's product bit for bit only while max
2580/// |gated output| <= 1000: the caller vouches for that (Spark-X2.5's
2581/// prefill, max |v| <= 990). wgpu only; false = nothing written to `out`
2582/// (the caller attends and projects as before).
2583#[allow(unused_variables, clippy::too_many_arguments)]
2584pub fn chunk_attend_mirror_wo(
2585    t: PrefillMirror,
2586    cpu_k: &[Vec<f32>],
2587    cpu_v: &[Vec<f32>],
2588    base: usize,
2589    q: &[f32],
2590    b: usize,
2591    s0: usize,
2592    nh: usize,
2593    nkv: usize,
2594    hd: usize,
2595    scale: f32,
2596    ring: Option<usize>,
2597    window: usize,
2598    operand_max: f32,
2599    gains: Option<&[f32]>,
2600    wo: (&Arc<CmfModel>, usize),
2601    hidden: usize,
2602    out: &mut [f32],
2603) -> bool {
2604    match backend() {
2605        #[cfg(feature = "gpu")]
2606        Backend::Wgpu => crate::gpu_wgpu::chunk_attend_mirror_wo(
2607            t.kv_id,
2608            t.layer,
2609            t.limit,
2610            cpu_k,
2611            cpu_v,
2612            base,
2613            q,
2614            b,
2615            s0,
2616            nh,
2617            nkv,
2618            hd,
2619            scale,
2620            ring,
2621            window,
2622            std::env::var("CMF_PREFILL_ATTN_COOP").as_deref() != Ok("0"),
2623            operand_max,
2624            gains,
2625            wo,
2626            hidden,
2627            out,
2628        ),
2629        #[allow(unreachable_patterns)]
2630        _ => false,
2631    }
2632}
2633
2634/// Whether the active backend's chunk attend can apply a sliding window.
2635pub fn chunk_attend_windowed() -> bool {
2636    match backend() {
2637        #[cfg(feature = "gpu")]
2638        Backend::Wgpu => true,
2639        #[allow(unreachable_patterns)]
2640        _ => false,
2641    }
2642}
2643
2644/// Fused QKV projection: one upload of the normed chunk, three GEMMs,
2645/// one readback of Q|K|V back to back. Metal has no twin yet — its
2646/// chunk graph keeps the whole layer resident and never surfaces QKV.
2647#[allow(unused_variables, clippy::too_many_arguments)]
2648pub fn q4t_qkv(
2649    model: &Arc<CmfModel>,
2650    wq: usize,
2651    wk: usize,
2652    wv: usize,
2653    xs: &[f32],
2654    b: usize,
2655    cols: usize,
2656    rq: usize,
2657    rk: usize,
2658    rv: usize,
2659    out: &mut [f32],
2660) -> bool {
2661    match backend() {
2662        #[cfg(feature = "gpu")]
2663        Backend::Wgpu => crate::gpu_wgpu::q4t_qkv(model, wq, wk, wv, xs, b, cols, rq, rk, rv, out),
2664        #[allow(unreachable_patterns)]
2665        _ => false,
2666    }
2667}
2668
2669/// y=·W2ᵀ — one command buffer, only X and Y cross the CPU boundary.
2670#[allow(unused_variables, clippy::too_many_arguments)]
2671/// SwiGLU FFN with a row-packed [gate|up] fc1 (MiniMax-H3's DiT), run
2672/// end to end on the device. wgpu only: Metal keeps the host loop until
2673/// its own packed kernel exists.
2674#[allow(clippy::too_many_arguments, unused_variables)]
2675pub fn q4tp_ffn_packed(
2676    model: &Arc<CmfModel>,
2677    w1: usize,
2678    w2: usize,
2679    xs: &[f32],
2680    b: usize,
2681    hidden: usize,
2682    inter: usize,
2683    bias: Option<&[f32]>,
2684    out: &mut [f32],
2685) -> bool {
2686    match backend() {
2687        #[cfg(feature = "gpu")]
2688        Backend::Wgpu => {
2689            crate::gpu_wgpu::ffn_packed(model, w1, w2, xs, b, hidden, inter, bias, out)
2690        }
2691        #[allow(unreachable_patterns)]
2692        _ => false,
2693    }
2694}
2695
2696pub fn q4tp_ffn(
2697    model: &Arc<CmfModel>,
2698    w1: usize,
2699    w3: usize,
2700    w2: usize,
2701    xs: &[f32],
2702    b: usize,
2703    hidden: usize,
2704    inter: usize,
2705    out: &mut [f32],
2706) -> bool {
2707    match backend() {
2708        #[cfg(target_os = "macos")]
2709        Backend::Metal => crate::gpu_metal::q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2710        #[cfg(feature = "gpu")]
2711        Backend::Wgpu => crate::gpu_wgpu::q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2712        #[allow(unreachable_patterns)]
2713        _ => false,
2714    }
2715}
2716
2717/// `q4tp_ffn` (`q4tp` = true) / `q4t_ffn` with the activation named:
2718/// SiLU takes the plain entry points (every backend), the exact GELU of
2719/// Spark-X2.5 has a wgpu arm only — other backends decline it.
2720#[allow(clippy::too_many_arguments, unused_variables)]
2721pub fn q4_ffn_act(
2722    model: &Arc<CmfModel>,
2723    w1: usize,
2724    w3: usize,
2725    w2: usize,
2726    xs: &[f32],
2727    b: usize,
2728    hidden: usize,
2729    inter: usize,
2730    q4tp: bool,
2731    act: GraphAct,
2732    out: &mut [f32],
2733) -> bool {
2734    match act {
2735        GraphAct::Silu if q4tp => q4tp_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2736        GraphAct::Silu => q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2737        GraphAct::GeluErf | GraphAct::GeluTanh => match backend() {
2738            #[cfg(feature = "gpu")]
2739            Backend::Wgpu => crate::gpu_wgpu::q4_ffn_act(
2740                model,
2741                w1,
2742                w3,
2743                w2,
2744                xs,
2745                b,
2746                hidden,
2747                inter,
2748                q4tp,
2749                act.code(),
2750                out,
2751            ),
2752            #[allow(unreachable_patterns)]
2753            _ => false,
2754        },
2755    }
2756}
2757
2758/// The LLM prefill's dense FFN for separate gate/up/down weights in any
2759/// codec with a device GEMM (int8, q4tp, or a mix of them): the panels
2760/// stay on the card between the projections. wgpu only; other backends
2761/// decline and the caller keeps its per-GEMM path.
2762#[allow(clippy::too_many_arguments, unused_variables)]
2763pub fn ffn_act_keep(
2764    model: &Arc<CmfModel>,
2765    w1: usize,
2766    w3: usize,
2767    w2: usize,
2768    xs: &[f32],
2769    b: usize,
2770    hidden: usize,
2771    inter: usize,
2772    act: GraphAct,
2773    out: &mut [f32],
2774) -> bool {
2775    match backend() {
2776        #[cfg(feature = "gpu")]
2777        Backend::Wgpu => crate::gpu_wgpu::ffn_act_keep(
2778            model,
2779            w1,
2780            w3,
2781            w2,
2782            xs,
2783            b,
2784            hidden,
2785            inter,
2786            act.code(),
2787            out,
2788        ),
2789        #[allow(unreachable_patterns)]
2790        _ => false,
2791    }
2792}
2793
2794/// Qwen Image's exact two-projection tanh-GELU FFN.  The WGPU arm keeps the
2795/// intermediate on the device; other backends decline so the caller retains
2796/// its bounded CPU path.  `bias_in` is applied before GELU and `bias_out`
2797/// after the second projection, matching the official transformer.
2798#[allow(clippy::too_many_arguments, unused_variables)]
2799pub fn q4tp_gelu_ffn(
2800    model: &Arc<CmfModel>,
2801    w_in: usize,
2802    w_out: usize,
2803    xs: &[f32],
2804    b: usize,
2805    hidden: usize,
2806    inter: usize,
2807    bias_in: &[f32],
2808    bias_out: &[f32],
2809    out: &mut [f32],
2810) -> bool {
2811    match backend() {
2812        #[cfg(feature = "gpu")]
2813        Backend::Wgpu => crate::gpu_wgpu::q4tp_gelu_ffn(
2814            model, w_in, w_out, xs, b, hidden, inter, bias_in, bias_out, out,
2815        ),
2816        #[allow(unreachable_patterns)]
2817        _ => false,
2818    }
2819}
2820
2821pub fn q4t_ffn(
2822    model: &Arc<CmfModel>,
2823    w1: usize,
2824    w3: usize,
2825    w2: usize,
2826    xs: &[f32],
2827    b: usize,
2828    hidden: usize,
2829    inter: usize,
2830    out: &mut [f32],
2831) -> bool {
2832    match backend() {
2833        #[cfg(target_os = "macos")]
2834        Backend::Metal => crate::gpu_metal::q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2835        #[cfg(feature = "gpu")]
2836        Backend::Wgpu => crate::gpu_wgpu::q4t_ffn(model, w1, w3, w2, xs, b, hidden, inter, out),
2837        #[allow(unreachable_patterns)]
2838        _ => false,
2839    }
2840}
2841
2842/// One whole modulated DiT block for `dit_block`: geometry, norm
2843/// weights, AdaLN scale/gate vectors (gates pre-tanh'd), a per-token
2844/// f32 RoPE cos/sin table, and the directory indices of the seven
2845/// q4t projections. `x` is in-out `[n, hidden]`.
2846pub struct DitBlockArgs<'a> {
2847    pub n: usize,
2848    pub hidden: usize,
2849    pub inter: usize,
2850    pub nh: usize,
2851    pub nkv: usize,
2852    pub hd: usize,
2853    pub eps: f32,
2854    pub rope_cos: &'a [f32],
2855    pub rope_sin: &'a [f32],
2856    pub norm1: &'a [f32],
2857    pub norm2: &'a [f32],
2858    pub ffn_norm1: &'a [f32],
2859    pub ffn_norm2: &'a [f32],
2860    pub norm_q: &'a [f32],
2861    pub norm_k: &'a [f32],
2862    pub s_msa: &'a [f32],
2863    pub gate_msa: &'a [f32],
2864    pub s_mlp: &'a [f32],
2865    pub gate_mlp: &'a [f32],
2866    pub wq: usize,
2867    pub wk: usize,
2868    pub wv: usize,
2869    pub wo: usize,
2870    pub w1: usize,
2871    pub w3: usize,
2872    pub w2: usize,
2873    /// The projections' layout: q4tp (ladder scales) vs plain q4_tiled.
2874    /// The recommended Lumina file is q4tp, and a backend that only
2875    /// knows q4t must decline rather than decode with the wrong reader.
2876    pub q4tp: bool,
2877    /// The hidden state is already on the device from the previous block,
2878    /// so `x` need not be uploaded.
2879    pub resident_in: bool,
2880    /// Leave the result on the device instead of reading it back. The DiT
2881    /// loop does not touch `x` between blocks, so 27 of every 28 readbacks
2882    /// were moving 19 MB across PCIe and stalling on it for nothing.
2883    pub resident_out: bool,
2884}
2885
2886/// Can the selected backend keep the DiT's hidden state on the device
2887/// between blocks? Only the wgpu whole-block path; the Metal entry takes
2888/// and returns host memory every call.
2889pub fn dit_chain_supported() -> bool {
2890    #[cfg(feature = "gpu")]
2891    {
2892        return matches!(backend(), Backend::Wgpu) && fused_dit_block_available();
2893    }
2894    #[allow(unreachable_code)]
2895    false
2896}
2897
2898/// Pull the resident hidden state back to the host. For the caller that
2899/// chained blocks and then hit one the device declined.
2900pub fn dit_state_fetch(_x: &mut [f32]) -> bool {
2901    #[cfg(feature = "gpu")]
2902    {
2903        if matches!(backend(), Backend::Wgpu) {
2904            return crate::gpu_wgpu::dit_state_fetch(_x);
2905        }
2906    }
2907    false
2908}
2909
2910/// One whole modulated DiT block on the device — norms, qkv, RoPE,
2911/// attention, residuals and the SwiGLU FFN in a single command
2912/// buffer; only `x` crosses the CPU boundary (in and out).
2913#[allow(unused_variables)]
2914/// The DiT's three projections in one submission (wgpu only; the
2915/// Metal path fuses the whole block instead). False = the caller keeps
2916/// its three separate calls.
2917#[allow(unused_variables, clippy::too_many_arguments)]
2918pub fn dit_qkv(
2919    model: &Arc<CmfModel>,
2920    wq: usize,
2921    wk: usize,
2922    wv: usize,
2923    xs: &[f32],
2924    b: usize,
2925    hidden: usize,
2926    qrows: usize,
2927    kvrows: usize,
2928    q_out: &mut [f32],
2929    k_out: &mut [f32],
2930    v_out: &mut [f32],
2931) -> bool {
2932    match backend() {
2933        #[cfg(feature = "gpu")]
2934        Backend::Wgpu => crate::gpu_wgpu::q4tp_qkv(
2935            model, wq, wk, wv, xs, b, hidden, qrows, kvrows, q_out, k_out, v_out,
2936        ),
2937        #[allow(unreachable_patterns)]
2938        _ => false,
2939    }
2940}
2941
2942/// The Qwen Image double-stream attention half.  The WGPU implementation
2943/// keeps the six Q/K/V projections, the stream join, qk-norm/RoPE, joint
2944/// attention, and both output projections on the device; the caller only
2945/// supplies the two normalized streams and receives the two projected
2946/// streams.  A backend or codec that cannot satisfy the full contract
2947/// returns `false` before changing either output, so the native host path
2948/// remains the portable fallback.
2949pub struct QwenImageAttentionArgs<'a> {
2950    pub image: &'a [f32],
2951    pub text: &'a [f32],
2952    pub image_tokens: usize,
2953    pub text_tokens: usize,
2954    pub heads: usize,
2955    pub head_dim: usize,
2956    pub image_q: usize,
2957    pub image_k: usize,
2958    pub image_v: usize,
2959    pub text_q: usize,
2960    pub text_k: usize,
2961    pub text_v: usize,
2962    pub image_out: usize,
2963    pub text_out: usize,
2964    pub image_q_norm: &'a [f32],
2965    pub image_k_norm: &'a [f32],
2966    pub text_q_norm: &'a [f32],
2967    pub text_k_norm: &'a [f32],
2968    pub image_cos: &'a [f32],
2969    pub image_sin: &'a [f32],
2970    pub text_cos: &'a [f32],
2971    pub text_sin: &'a [f32],
2972    pub image_q_bias: &'a [f32],
2973    pub image_k_bias: &'a [f32],
2974    pub image_v_bias: &'a [f32],
2975    pub text_q_bias: &'a [f32],
2976    pub text_k_bias: &'a [f32],
2977    pub text_v_bias: &'a [f32],
2978    pub image_out_bias: &'a [f32],
2979    pub text_out_bias: &'a [f32],
2980    pub image_proj: &'a mut [f32],
2981    pub text_proj: &'a mut [f32],
2982}
2983
2984/// The per-layer controls and Q4TP directory indices used by the native
2985/// Qwen block.  Keeping this descriptor separate from the stream buffers
2986/// lets a whole transformer forward reuse one explicit device state without
2987/// a global scratch slot or a hidden context label.
2988#[allow(clippy::too_many_fields)]
2989pub struct QwenImageChainBlock<'a> {
2990    pub image_mod: &'a [f32],
2991    pub text_mod: &'a [f32],
2992    pub image_q: usize,
2993    pub image_k: usize,
2994    pub image_v: usize,
2995    pub text_q: usize,
2996    pub text_k: usize,
2997    pub text_v: usize,
2998    pub image_out: usize,
2999    pub text_out: usize,
3000    pub image_q_norm: &'a [f32],
3001    pub image_k_norm: &'a [f32],
3002    pub text_q_norm: &'a [f32],
3003    pub text_k_norm: &'a [f32],
3004    pub image_q_bias: &'a [f32],
3005    pub image_k_bias: &'a [f32],
3006    pub image_v_bias: &'a [f32],
3007    pub text_q_bias: &'a [f32],
3008    pub text_k_bias: &'a [f32],
3009    pub text_v_bias: &'a [f32],
3010    pub image_out_bias: &'a [f32],
3011    pub text_out_bias: &'a [f32],
3012    pub image_attn_gate: &'a [f32],
3013    pub text_attn_gate: &'a [f32],
3014    pub image_mlp_in: usize,
3015    pub image_mlp_out: usize,
3016    pub text_mlp_in: usize,
3017    pub text_mlp_out: usize,
3018    pub image_mlp_in_bias: &'a [f32],
3019    pub image_mlp_out_bias: &'a [f32],
3020    pub text_mlp_in_bias: &'a [f32],
3021    pub text_mlp_out_bias: &'a [f32],
3022}
3023
3024/// Complete Qwen Image transformer block contract. The first norm/mod
3025/// panels are supplied by the native caller; the WGPU arm keeps both streams
3026/// resident through QKV, QK/RoPE, joint attention, output projections, both
3027/// gated residuals, and the exact tanh-GELU MLPs. A backend that cannot
3028/// satisfy the whole graph returns `false` without changing either output.
3029#[allow(clippy::too_many_fields)]
3030pub struct QwenImageBlockArgs<'a> {
3031    /// Raw stream state is read for the first gated residual and overwritten
3032    /// with the block's final state after the one readback.
3033    pub image: &'a mut [f32],
3034    pub text: &'a mut [f32],
3035    pub image_norm: &'a [f32],
3036    pub text_norm: &'a [f32],
3037    pub image_tokens: usize,
3038    pub text_tokens: usize,
3039    pub heads: usize,
3040    pub head_dim: usize,
3041    pub image_cos: &'a [f32],
3042    pub image_sin: &'a [f32],
3043    pub text_cos: &'a [f32],
3044    pub text_sin: &'a [f32],
3045    pub image_q: usize,
3046    pub image_k: usize,
3047    pub image_v: usize,
3048    pub text_q: usize,
3049    pub text_k: usize,
3050    pub text_v: usize,
3051    pub image_out: usize,
3052    pub text_out: usize,
3053    pub image_q_norm: &'a [f32],
3054    pub image_k_norm: &'a [f32],
3055    pub text_q_norm: &'a [f32],
3056    pub text_k_norm: &'a [f32],
3057    pub image_q_bias: &'a [f32],
3058    pub image_k_bias: &'a [f32],
3059    pub image_v_bias: &'a [f32],
3060    pub text_q_bias: &'a [f32],
3061    pub text_k_bias: &'a [f32],
3062    pub text_v_bias: &'a [f32],
3063    pub image_out_bias: &'a [f32],
3064    pub text_out_bias: &'a [f32],
3065    pub image_attn_gate: &'a [f32],
3066    pub text_attn_gate: &'a [f32],
3067    pub image_mlp_in: usize,
3068    pub image_mlp_out: usize,
3069    pub text_mlp_in: usize,
3070    pub text_mlp_out: usize,
3071    pub image_mlp_in_bias: &'a [f32],
3072    pub image_mlp_out_bias: &'a [f32],
3073    pub text_mlp_in_bias: &'a [f32],
3074    pub text_mlp_out_bias: &'a [f32],
3075    pub image_mlp_mod: &'a [f32],
3076    pub text_mlp_mod: &'a [f32],
3077    pub image_mlp_gate: &'a [f32],
3078    pub text_mlp_gate: &'a [f32],
3079}
3080
3081/// Explicit whole-forward Qwen state contract.  The WGPU backend uploads the
3082/// two initial streams once, encodes a bounded number of complete blocks per
3083/// submission, and reads the final state once.  `blocks` is immutable for the
3084/// call, while the two stream slices receive only the final readback.
3085pub struct QwenImageChainArgs<'a> {
3086    pub image: &'a mut [f32],
3087    pub text: &'a mut [f32],
3088    pub image_tokens: usize,
3089    pub text_tokens: usize,
3090    pub heads: usize,
3091    pub head_dim: usize,
3092    pub image_cos: &'a [f32],
3093    pub image_sin: &'a [f32],
3094    pub text_cos: &'a [f32],
3095    pub text_sin: &'a [f32],
3096    pub blocks: &'a [QwenImageChainBlock<'a>],
3097}
3098
3099#[allow(unused_variables)]
3100pub fn qwen_image_attention(
3101    model: &Arc<CmfModel>,
3102    args: &mut QwenImageAttentionArgs<'_>,
3103) -> bool {
3104    match backend() {
3105        #[cfg(feature = "gpu")]
3106        Backend::Wgpu => crate::gpu_wgpu::qwen_image_attention(model, args),
3107        #[allow(unreachable_patterns)]
3108        _ => false,
3109    }
3110}
3111
3112#[allow(unused_variables)]
3113pub fn qwen_image_block(model: &Arc<CmfModel>, args: &mut QwenImageBlockArgs<'_>) -> bool {
3114    match backend() {
3115        #[cfg(feature = "gpu")]
3116        Backend::Wgpu => crate::gpu_wgpu::qwen_image_block(model, args),
3117        #[allow(unreachable_patterns)]
3118        _ => false,
3119    }
3120}
3121
3122/// Keep all Qwen transformer blocks on the selected WGPU device, with only
3123/// bounded chunk submissions and one final readback.  Other backends decline
3124/// so the native caller can use its exact portable block loop.
3125#[allow(unused_variables)]
3126pub fn qwen_image_chain(model: &Arc<CmfModel>, args: &mut QwenImageChainArgs<'_>) -> bool {
3127    match backend() {
3128        #[cfg(feature = "gpu")]
3129        Backend::Wgpu => crate::gpu_wgpu::qwen_image_chain(model, args),
3130        #[allow(unreachable_patterns)]
3131        _ => false,
3132    }
3133}
3134
3135/// The Qwen Image second sub-block on WGPU: affine-free LayerNorm,
3136/// shift/scale modulation, Q4TP input projection, exact tanh-GELU, output
3137/// projection, bias and gated residual.  `data` is updated in place after a
3138/// single final readback.  Backends/codecs that cannot keep this chain on the
3139/// device return `false` before changing `data`, leaving the caller's
3140/// portable per-op path intact.
3141#[allow(unused_variables, clippy::too_many_arguments)]
3142pub fn qwen_image_mlp_inplace(
3143    model: &Arc<CmfModel>,
3144    w_in: usize,
3145    w_out: usize,
3146    data: &mut [f32],
3147    batch: usize,
3148    hidden: usize,
3149    inter: usize,
3150    bias_in: &[f32],
3151    bias_out: &[f32],
3152    modulation: &[f32],
3153    gate: &[f32],
3154) -> bool {
3155    match backend() {
3156        #[cfg(feature = "gpu")]
3157        Backend::Wgpu => crate::gpu_wgpu::qwen_image_mlp_inplace(
3158            model,
3159            w_in,
3160            w_out,
3161            data,
3162            batch,
3163            hidden,
3164            inter,
3165            bias_in,
3166            bias_out,
3167            modulation,
3168            gate,
3169        ),
3170        #[allow(unreachable_patterns)]
3171        _ => false,
3172    }
3173}
3174
3175/// Is a FUSED whole-block device path on offer? The batched-CFG shape
3176/// (two sequences in one tall batch) and the fused block (one sequence,
3177/// one command buffer) are alternatives, and the caller picks.
3178pub fn fused_dit_block_available() -> bool {
3179    #[cfg(target_os = "macos")]
3180    {
3181        matches!(backend(), Backend::Metal) && fused_block_trusted()
3182    }
3183    #[cfg(not(target_os = "macos"))]
3184    {
3185        false
3186    }
3187}
3188
3189pub fn dit_block(model: &Arc<CmfModel>, a: &DitBlockArgs, x: &mut [f32]) -> bool {
3190    dit_block_seg(model, a, &[a.n], x)
3191}
3192
3193/// The same block over a CONCATENATION of independent sequences:
3194/// attention per segment, everything position-wise batched. wgpu only —
3195/// the Metal path takes the single-sequence entry above.
3196pub fn dit_block_seg(
3197    model: &Arc<CmfModel>,
3198    a: &DitBlockArgs,
3199    segs: &[usize],
3200    x: &mut [f32],
3201) -> bool {
3202    match backend() {
3203        #[cfg(target_os = "macos")]
3204        Backend::Metal if segs.len() <= 1 => crate::gpu_metal::dit_block(model, a, x),
3205        // The wgpu whole-block path. What it buys is host round trips —
3206        // six a block become one — so it defaults ON where those cost
3207        // real time (a discrete card across PCIe) and OFF on unified
3208        // memory, where the per-op path shares the same pages and the
3209        // fusion measured slightly slower on an M4. `CMF_DIT_FUSED=1`
3210        // forces it anywhere, `=0` forbids it.
3211        #[cfg(feature = "gpu")]
3212        Backend::Wgpu
3213            if match std::env::var("CMF_DIT_FUSED").ok().as_deref() {
3214                Some("0") => false,
3215                Some(_) => true,
3216                None => crate::gpu_wgpu::discrete_active(),
3217            } =>
3218        {
3219            crate::gpu_wgpu::dit_block_seg(model, a, segs, x)
3220        }
3221        #[allow(unreachable_patterns)]
3222        _ => false,
3223    }
3224}
3225
3226/// One VAE resnet block for `vae_resnet`: norm/conv weights and the
3227/// channel/shape geometry. `shortcut` is the 1×1 projection (w, b, k)
3228/// when in/out channels differ.
3229pub struct VaeResnetArgs<'a> {
3230    pub groups: usize,
3231    pub ic: usize,
3232    pub oc: usize,
3233    pub h: usize,
3234    pub w: usize,
3235    pub n1w: &'a [f32],
3236    pub n1b: &'a [f32],
3237    pub c1w: &'a [f32],
3238    pub c1b: &'a [f32],
3239    pub c1k: usize,
3240    pub n2w: &'a [f32],
3241    pub n2b: &'a [f32],
3242    pub c2w: &'a [f32],
3243    pub c2b: &'a [f32],
3244    pub c2k: usize,
3245    pub shortcut: Option<(&'a [f32], &'a [f32], usize)>,
3246}
3247
3248/// One whole VAE resnet block on the device (norm+silu → conv ×2 →
3249/// shortcut → add, one command buffer).
3250#[allow(unused_variables)]
3251pub fn vae_resnet(a: &VaeResnetArgs, x: &[f32], out: &mut [f32]) -> bool {
3252    match backend() {
3253        #[cfg(target_os = "macos")]
3254        Backend::Metal => crate::gpu_metal::vae_resnet(a, x, out),
3255        _ => false,
3256    }
3257}
3258
3259/// Nearest-2× upsample fused with the following conv — the small
3260/// pre-upsample image is what crosses the CPU boundary.
3261#[allow(unused_variables, clippy::too_many_arguments)]
3262pub fn vae_upsample_conv(
3263    w: &[f32],
3264    bias: &[f32],
3265    x: &[f32],
3266    ic: usize,
3267    oc: usize,
3268    h: usize,
3269    w_img: usize,
3270    k: usize,
3271    out: &mut [f32],
3272) -> bool {
3273    match backend() {
3274        #[cfg(target_os = "macos")]
3275        Backend::Metal => crate::gpu_metal::vae_upsample_conv(w, bias, x, ic, oc, h, w_img, k, out),
3276        #[cfg(feature = "gpu")]
3277        Backend::Wgpu => crate::gpu_wgpu::vae_upsample_conv(w, bias, x, ic, oc, h, w_img, k, out),
3278        #[allow(unreachable_patterns)]
3279        _ => false,
3280    }
3281}
3282
3283/// VAE conv2d on the device (implicit GEMM — the CPU path pays for a
3284/// multi-GB im2col matrix at high resolutions).
3285#[allow(unused_variables, clippy::too_many_arguments)]
3286pub fn vae_conv2d(
3287    w: &[f32],
3288    bias: &[f32],
3289    x: &[f32],
3290    ic: usize,
3291    oc: usize,
3292    h: usize,
3293    w_img: usize,
3294    k: usize,
3295    out: &mut [f32],
3296) -> bool {
3297    match backend() {
3298        #[cfg(target_os = "macos")]
3299        Backend::Metal => crate::gpu_metal::vae_conv2d(w, bias, x, ic, oc, h, w_img, k, out),
3300        #[cfg(feature = "gpu")]
3301        Backend::Wgpu => crate::gpu_wgpu::vae_conv2d(w, bias, x, ic, oc, h, w_img, k, out),
3302        #[allow(unreachable_patterns)]
3303        _ => false,
3304    }
3305}
3306
3307/// DiT full bidirectional attention on the device (all heads:
3308/// scores GEMM → row softmax → P·V → panel unstack, one command
3309/// buffer). Head-major inputs; out is [n, nh·hd].
3310#[allow(unused_variables, clippy::too_many_arguments)]
3311/// Attention from an interleaved qkv panel, splitting into head-major
3312/// planes ON the device. wgpu only; `false` elsewhere so the caller
3313/// keeps its host repack.
3314#[allow(unused_variables)]
3315#[allow(clippy::too_many_arguments)]
3316/// qkv projection + attention with the panel never leaving the card.
3317/// wgpu only; `false` elsewhere and the caller keeps its host chain.
3318#[allow(clippy::too_many_arguments, unused_variables)]
3319pub fn dit_qkv_attention(
3320    model: &Arc<CmfModel>,
3321    qkv_idx: usize,
3322    xn: &[f32],
3323    n: usize,
3324    hidden: usize,
3325    nh: usize,
3326    hd: usize,
3327    scale: f32,
3328    nr: (&[f32], &[f32], &[f32], f32),
3329    out: &mut [f32],
3330) -> bool {
3331    match backend() {
3332        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3333        Backend::Wgpu => crate::gpu_wgpu::dit_qkv_attention(
3334            model, qkv_idx, xn, n, hidden, nh, hd, scale, nr, out,
3335        ),
3336        #[allow(unreachable_patterns)]
3337        _ => false,
3338    }
3339}
3340
3341/// The whole attention half of a DiT block on the card: qkv GEMM,
3342/// attention, output projection. Only `proj` comes home.
3343#[allow(clippy::too_many_arguments)]
3344pub fn dit_qkv_attn_out(
3345    model: &Arc<CmfModel>,
3346    qkv_idx: usize,
3347    out_idx: usize,
3348    xn: &[f32],
3349    n: usize,
3350    hidden: usize,
3351    nh: usize,
3352    hd: usize,
3353    scale: f32,
3354    nr: (&[f32], &[f32], &[f32], f32),
3355    proj: &mut [f32],
3356) -> bool {
3357    match backend() {
3358        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3359        Backend::Wgpu => crate::gpu_wgpu::dit_qkv_attn_out(
3360            model, qkv_idx, out_idx, xn, n, hidden, nh, hd, scale, nr, proj,
3361        ),
3362        #[allow(unreachable_patterns)]
3363        _ => false,
3364    }
3365}
3366
3367/// The VAE decoder's attention half on the card. Only `proj` returns.
3368#[allow(clippy::too_many_arguments)]
3369pub fn vae_qkv_attn_out(
3370    model: &Arc<CmfModel>,
3371    qkv_idx: usize,
3372    out_idx: usize,
3373    xn: &[f32],
3374    n: usize,
3375    dim: usize,
3376    nh: usize,
3377    hd: usize,
3378    scale: f32,
3379    angles: &[f32],
3380    eps: f32,
3381    qkv_bias: &[f32],
3382    proj: &mut [f32],
3383) -> bool {
3384    match backend() {
3385        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3386        Backend::Wgpu => crate::gpu_wgpu::vae_qkv_attn_out(
3387            model, qkv_idx, out_idx, xn, n, dim, nh, hd, scale, angles, eps, qkv_bias, proj,
3388        ),
3389        #[allow(unreachable_patterns)]
3390        _ => false,
3391    }
3392}
3393
3394#[allow(clippy::too_many_arguments)]
3395pub fn vae_attention_packed(
3396    qkv: &[f32],
3397    nh: usize,
3398    n: usize,
3399    hd: usize,
3400    scale: f32,
3401    angles: &[f32],
3402    eps: f32,
3403    out: &mut [f32],
3404) -> bool {
3405    vae_attention_packed_layout(qkv, nh, n, hd, scale, angles, eps, out, 1)
3406}
3407
3408#[allow(clippy::too_many_arguments)]
3409pub fn vae_attention_packed_layout(
3410    qkv: &[f32],
3411    nh: usize,
3412    n: usize,
3413    hd: usize,
3414    scale: f32,
3415    angles: &[f32],
3416    eps: f32,
3417    out: &mut [f32],
3418    layout: u32,
3419) -> bool {
3420    match backend() {
3421        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3422        Backend::Wgpu => crate::gpu_wgpu::vae_attention_packed_layout(
3423            qkv, nh, n, hd, scale, angles, eps, out, layout,
3424        ),
3425        #[allow(unreachable_patterns)]
3426        _ => false,
3427    }
3428}
3429
3430#[allow(clippy::too_many_arguments)]
3431pub fn dit_split_only(
3432    qkv: &[f32],
3433    nh: usize,
3434    n: usize,
3435    hd: usize,
3436    layout: u32,
3437    norm: Option<(&[f32], f32)>,
3438    out_q: &mut [f32],
3439) -> bool {
3440    match backend() {
3441        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3442        Backend::Wgpu => crate::gpu_wgpu::dit_split_only(qkv, nh, n, hd, layout, norm, out_q),
3443        #[allow(unreachable_patterns)]
3444        _ => false,
3445    }
3446}
3447
3448/// The backend's f32 NT GEMM: `y[n×m] = x[n×k] · wᵀ[m×k]`. Tensor
3449/// cores where the card has them. Refuses under `CMF_BAKE_GPU=0` or
3450/// strict f32, and for jobs below n·k·m = 4M, where the round trip
3451/// costs more than the arithmetic saves.
3452/// `gemm_nt_f32` whose `w` is known to change every call (an
3453/// accumulation over fresh activations, not a weight): it skips the
3454/// resident ledger and its per-call fingerprint of the whole operand.
3455pub fn gemm_nt_f32_transient(
3456    x: &[f32],
3457    w: &[f32],
3458    y: &mut [f32],
3459    n: usize,
3460    k: usize,
3461    m: usize,
3462) -> bool {
3463    match backend() {
3464        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3465        Backend::Wgpu => crate::gpu_wgpu::gemm_nt_f32_transient(x, w, y, n, k, m),
3466        #[allow(unreachable_patterns)]
3467        _ => false,
3468    }
3469}
3470
3471pub fn gemm_nt_f32(x: &[f32], w: &[f32], y: &mut [f32], n: usize, k: usize, m: usize) -> bool {
3472    match backend() {
3473        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3474        Backend::Wgpu => crate::gpu_wgpu::gemm_nt_f32(x, w, y, n, k, m),
3475        #[allow(unreachable_patterns)]
3476        _ => false,
3477    }
3478}
3479
3480/// Music-3's FFN chain resident on the device — two GEMMs and the GLU
3481/// between them with no host round trip. `false` = refused, host runs.
3482#[allow(clippy::too_many_arguments)]
3483pub fn music3_ffn(
3484    model: &std::sync::Arc<CmfModel>,
3485    idx_in: usize,
3486    idx_out: usize,
3487    h: &[f32],
3488    bias_in: &[f32],
3489    n: usize,
3490    hs: usize,
3491    inter: usize,
3492    out: &mut [f32],
3493) -> bool {
3494    match backend() {
3495        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3496        Backend::Wgpu => {
3497            crate::gpu_wgpu::music3_ffn(model, idx_in, idx_out, h, bias_in, n, hs, inter, out)
3498        }
3499        #[allow(unreachable_patterns)]
3500        _ => false,
3501    }
3502}
3503
3504/// A 1D convolution as a GEMM whose column matrix is expanded on the
3505/// device instead of being built, transposed and uploaded by the host.
3506/// `yt` comes back `[out_n x oc]`. `false` = refused, caller runs host.
3507#[allow(clippy::too_many_arguments)]
3508pub fn conv1d_gemm(
3509    x: &[f32],
3510    w: &[f32],
3511    ic: usize,
3512    oc: usize,
3513    n: usize,
3514    k: usize,
3515    pad: usize,
3516    dil: usize,
3517    out_n: usize,
3518    yt: &mut [f32],
3519) -> bool {
3520    match backend() {
3521        #[cfg(target_os = "macos")]
3522        Backend::Metal => crate::gpu_metal::conv1d_gemm(x, w, ic, oc, n, k, pad, dil, out_n, yt),
3523        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3524        Backend::Wgpu => crate::gpu_wgpu::conv1d_gemm(x, w, ic, oc, n, k, pad, dil, out_n, yt),
3525        #[allow(unreachable_patterns)]
3526        _ => false,
3527    }
3528}
3529
3530/// The convolution as a GEMM on the matrix units. `false` = refused.
3531#[allow(clippy::too_many_arguments)]
3532pub fn vae_conv2d_coop(
3533    w: &[f32],
3534    bias: Option<&[f32]>,
3535    x: &[f32],
3536    ic: usize,
3537    oc: usize,
3538    h: usize,
3539    wi: usize,
3540    k: usize,
3541    out: &mut [f32],
3542) -> bool {
3543    match backend() {
3544        #[cfg(all(feature = "gpu", not(target_os = "macos")))]
3545        Backend::Wgpu => crate::gpu_wgpu::vae_conv2d_coop(w, bias, x, ic, oc, h, wi, k, out),
3546        #[allow(unreachable_patterns)]
3547        _ => false,
3548    }
3549}
3550
3551pub fn dit_attention_packed(
3552    qkv: &[f32],
3553    nh: usize,
3554    n: usize,
3555    hd: usize,
3556    scale: f32,
3557    // (rope angles, q norm weights, k norm weights, eps) when the device
3558    // should apply qk-norm and RoPE itself; None when the host already did.
3559    nr: Option<(&[f32], &[f32], &[f32], f32)>,
3560    out: &mut [f32],
3561) -> bool {
3562    match backend() {
3563        // wgpu carries the only implementation, and it is not
3564        // platform-specific: `CMF_GPU=wgpu` on macOS runs it over Metal
3565        // like anywhere else. It used to be compiled out here on macOS,
3566        // which made the call a silent `false` — and the caller's
3567        // `assert!` turned that refusal into a panic on every
3568        // `cortiq animate` this platform ever ran.
3569        #[cfg(feature = "gpu")]
3570        Backend::Wgpu => crate::gpu_wgpu::dit_attention_packed(qkv, nh, n, hd, scale, nr, out),
3571        #[allow(unreachable_patterns)]
3572        _ => false,
3573    }
3574}
3575
3576/// Whether `dit_attention_packed` has an implementation on the backend
3577/// that is actually selected.
3578///
3579/// The caller has to know BEFORE it skips the host qk-norm: deferring
3580/// the norm to a device that then refuses leaves q/k unnormalized with
3581/// no way back. Native Metal has no packed kernel, so on macOS this is
3582/// false unless `CMF_GPU=wgpu` picked the other backend.
3583pub fn dit_attention_packed_available() -> bool {
3584    #[allow(unreachable_patterns)]
3585    match backend() {
3586        #[cfg(feature = "gpu")]
3587        Backend::Wgpu => crate::gpu_wgpu::dit_attention_packed_ready(),
3588        _ => false,
3589    }
3590}
3591
3592pub fn dit_attention(
3593    qh: &[f32],
3594    kh: &[f32],
3595    vh: &[f32],
3596    nh: usize,
3597    nkv: usize,
3598    n: usize,
3599    hd: usize,
3600    scale: f32,
3601    out: &mut [f32],
3602) -> bool {
3603    match backend() {
3604        #[cfg(target_os = "macos")]
3605        Backend::Metal => crate::gpu_metal::dit_attention(qh, kh, vh, nh, nkv, n, hd, scale, out),
3606        #[cfg(feature = "gpu")]
3607        Backend::Wgpu => crate::gpu_wgpu::dit_attention(qh, kh, vh, nh, nkv, n, hd, scale, out),
3608        #[allow(unreachable_patterns)]
3609        _ => false,
3610    }
3611}
3612
3613/// Batched q4t GEMM on the device (imagegen DiT prefill shapes).
3614/// Metal: q4t_mul_mm decodes the mmap-resident tiles inside the
3615/// GEMM's K loop. wgpu (Vulkan/DX12 → NVIDIA/AMD/Intel/Adreno/Mali):
3616/// the register-blocked WGSL twin, weights cached in VRAM.
3617#[allow(unused_variables)]
3618pub fn q4tp_matmat(
3619    model: &Arc<CmfModel>,
3620    idx: usize,
3621    xs: &[f32],
3622    b: usize,
3623    rows: usize,
3624    cols: usize,
3625    out: &mut [f32],
3626) -> bool {
3627    match backend() {
3628        #[cfg(target_os = "macos")]
3629        Backend::Metal => crate::gpu_metal::q4tp_matmat(model, idx, xs, b, rows, cols, out),
3630        #[cfg(feature = "gpu")]
3631        Backend::Wgpu => crate::gpu_wgpu::q4tp_matmat(model, idx, xs, b, rows, cols, out),
3632        #[allow(unreachable_patterns)]
3633        _ => false,
3634    }
3635}
3636
3637/// The same over a two-bit weight plane. Native Metal uses the dedicated
3638/// q2tp tile; unsupported shapes return false and preserve the host fallback.
3639pub fn q2tp_matmat(
3640    model: &Arc<CmfModel>,
3641    idx: usize,
3642    xs: &[f32],
3643    b: usize,
3644    rows: usize,
3645    cols: usize,
3646    out: &mut [f32],
3647) -> bool {
3648    match backend() {
3649        #[cfg(target_os = "macos")]
3650        Backend::Metal => crate::gpu_metal::q2tp_matmat(model, idx, xs, b, rows, cols, out),
3651        #[cfg(feature = "gpu")]
3652        Backend::Wgpu => crate::gpu_wgpu::q2tp_matmat(model, idx, xs, b, rows, cols, out),
3653        #[allow(unreachable_patterns)]
3654        _ => false,
3655    }
3656}
3657
3658/// Descriptor-aware q2tp GEMM. The affine center is selected only for a
3659/// validated q2tp_affine target; the raw dtype16 payload remains unchanged.
3660pub fn q2tp_affine_matmat(
3661    model: &Arc<CmfModel>,
3662    idx: usize,
3663    xs: &[f32],
3664    b: usize,
3665    rows: usize,
3666    cols: usize,
3667    out: &mut [f32],
3668) -> bool {
3669    match backend() {
3670        #[cfg(target_os = "macos")]
3671        Backend::Metal => crate::gpu_metal::q2tp_affine_matmat(model, idx, xs, b, rows, cols, out),
3672        #[cfg(feature = "gpu")]
3673        Backend::Wgpu => crate::gpu_wgpu::q2tp_affine_matmat(model, idx, xs, b, rows, cols, out),
3674        #[allow(unreachable_patterns)]
3675        _ => false,
3676    }
3677}
3678
3679/// Single-token q2tp matvec through the ordinary (center=1.5) WGSL kernel.
3680pub fn q2tp_matvec(
3681    model: &Arc<CmfModel>,
3682    idx: usize,
3683    xs: &[f32],
3684    rows: usize,
3685    cols: usize,
3686    out: &mut [f32],
3687) -> bool {
3688    match backend() {
3689        #[cfg(target_os = "macos")]
3690        Backend::Metal => crate::gpu_metal::q2tp_matvec(model, idx, xs, rows, cols, out),
3691        #[cfg(feature = "gpu")]
3692        Backend::Wgpu => crate::gpu_wgpu::q2tp_matvec(model, idx, xs, rows, cols, out),
3693        #[allow(unreachable_patterns)]
3694        _ => false,
3695    }
3696}
3697
3698/// Single-token q2tp matvec with the explicit affine center=1 descriptor
3699/// operator. This is kept separate from ordinary q2tp to make accidental
3700/// center changes impossible at a call site.
3701pub fn q2tp_affine_matvec(
3702    model: &Arc<CmfModel>,
3703    idx: usize,
3704    xs: &[f32],
3705    rows: usize,
3706    cols: usize,
3707    out: &mut [f32],
3708) -> bool {
3709    match backend() {
3710        #[cfg(target_os = "macos")]
3711        Backend::Metal => crate::gpu_metal::q2tp_affine_matvec(model, idx, xs, rows, cols, out),
3712        #[cfg(feature = "gpu")]
3713        Backend::Wgpu => crate::gpu_wgpu::q2tp_affine_matvec(model, idx, xs, rows, cols, out),
3714        #[allow(unreachable_patterns)]
3715        _ => false,
3716    }
3717}
3718
3719/// Single-token q4tp matvec on the device — the lm_head class. Through the
3720/// DEDICATED matvec kernel: the batched GEMM at b=1 measured 11.73 ms
3721/// against the host's 9.51 on the release head, so the route that was
3722/// supposed to save eleven milliseconds a token lost its own probe instead.
3723pub fn q4tp_matvec(
3724    model: &Arc<CmfModel>,
3725    idx: usize,
3726    xs: &[f32],
3727    rows: usize,
3728    cols: usize,
3729    out: &mut [f32],
3730) -> bool {
3731    match backend() {
3732        #[cfg(target_os = "macos")]
3733        Backend::Metal => crate::gpu_metal::q4tp_matvec_for_test(model, idx, xs, rows, cols, out),
3734        #[cfg(feature = "gpu")]
3735        Backend::Wgpu => crate::gpu_wgpu::q4tp_matvec(model, idx, xs, rows, cols, out),
3736        #[allow(unreachable_patterns)]
3737        _ => false,
3738    }
3739}
3740
3741/// Single-token q4_tiled matvec on the device — the lm_head class (a
3742/// q4t checkpoint's head is its biggest host matvec, exactly like the
3743/// q4tp twin above). wgpu holds q4t_mv pipelines only inside the graph
3744/// encoder — the standalone arm stays an honest refusal until a
3745/// discrete-GPU q4t model reaches the bench.
3746pub fn q4t_matvec(
3747    model: &Arc<CmfModel>,
3748    idx: usize,
3749    xs: &[f32],
3750    rows: usize,
3751    cols: usize,
3752    out: &mut [f32],
3753) -> bool {
3754    match backend() {
3755        #[cfg(target_os = "macos")]
3756        Backend::Metal => crate::gpu_metal::q4t_matvec_for_test(model, idx, xs, rows, cols, out),
3757        #[allow(unreachable_patterns)]
3758        _ => false,
3759    }
3760}
3761
3762pub fn q4t_matmat(
3763    model: &Arc<CmfModel>,
3764    idx: usize,
3765    xs: &[f32],
3766    b: usize,
3767    rows: usize,
3768    cols: usize,
3769    out: &mut [f32],
3770) -> bool {
3771    match backend() {
3772        #[cfg(target_os = "macos")]
3773        Backend::Metal => crate::gpu_metal::q4t_matmat(model, idx, xs, b, rows, cols, out),
3774        #[cfg(feature = "gpu")]
3775        Backend::Wgpu => crate::gpu_wgpu::q4t_matmat(model, idx, xs, b, rows, cols, out),
3776        #[allow(unreachable_patterns)]
3777        _ => false,
3778    }
3779}
3780
3781/// Whole-block token-graph types re-exported from the Metal backend.
3782#[cfg(target_os = "macos")]
3783pub use crate::gpu_metal::{
3784    AttnDeviceParams, AttnGpuLayer, GdnGpuCfg, GdnGpuLayer, GpuMoe, GraphDims, MetalFfn,
3785    O1AttnParams, TokenGraph, kv_mirror_drop, kv_mirror_read_last, kv_mirror_take_imp,
3786};
3787
3788/// A BLOCK of consecutive q1 GDN layers in one submission (Metal only).
3789#[cfg(target_os = "macos")]
3790pub fn gdn_block(
3791    model: &Arc<CmfModel>,
3792    layers: &[GdnGpuLayer],
3793    states: &mut [&mut [f32]],
3794    cfg: &GdnGpuCfg,
3795    h: &mut [f32],
3796) -> bool {
3797    match backend() {
3798        Backend::Metal => crate::gpu_metal::gdn_block(model, layers, states, cfg, h),
3799        _ => false,
3800    }
3801}
3802
3803/// A layer's MoE-FFN in one submission (amortizing the dispatch cost).
3804#[allow(unused_variables)]
3805pub fn moe_block(model: &Arc<CmfModel>, jobs: &[MoeJob], out: &mut [f32]) -> bool {
3806    match backend() {
3807        // The Metal block applies SiLU only: any other activation is an
3808        // honest refusal (the caller keeps its host path).
3809        #[cfg(target_os = "macos")]
3810        Backend::Metal if jobs.iter().any(|j| j.act != 0) => false,
3811        #[cfg(target_os = "macos")]
3812        Backend::Metal => crate::gpu_metal::moe_block(model, jobs, out),
3813        #[cfg(feature = "gpu")]
3814        Backend::Wgpu => crate::gpu_wgpu::moe_block(model, jobs, out),
3815        Backend::None => false,
3816    }
3817}
3818
3819/// Independent matvecs of one input in a single submission (GDN projections).
3820#[allow(unused_variables)]
3821pub fn matvec_batch(model: &Arc<CmfModel>, jobs: &[BatchJob], out: &mut [&mut [f32]]) -> bool {
3822    match backend() {
3823        #[cfg(target_os = "macos")]
3824        Backend::Metal => crate::gpu_metal::matvec_batch(model, jobs, out),
3825        #[cfg(feature = "gpu")]
3826        Backend::Wgpu => crate::gpu_wgpu::matvec_batch(model, jobs, out),
3827        Backend::None => false,
3828    }
3829}
3830
3831// ── Whole-token wgpu graph race (generation granularity) ─────────────
3832// On integrated/mobile adapters the graph is neither trusted nor banned
3833// a priori — it RACES the normal path: generations alternate arms (the
3834// normal path first — known-good UX — then the graph), per-token wall
3835// times accumulate per arm, and once both arms have enough steady
3836// samples the faster one wins for the process. Arm switches happen ONLY
3837// at generation boundaries (`kv_cache.clear()` resets state), so the
3838// device KV mirror and the CPU cache never diverge mid-sequence. The
3839// single exception is the first-token bail: the very first decode token
3840// of a graph generation may be discarded and recomputed on the CPU
3841// path (the prompt KV is CPU-owned at that point, so this is safe) —
3842// a tiled mobile GPU that drains its pipeline at every barrier turns
3843// the ~300-dispatch graph into seconds per token (field report: 0.2
3844// tok/s vs 15 on the CPU), and one token is all it takes to see that.
3845static GRAPH_RACE_STATE: AtomicU8 = AtomicU8::new(0); // 0 racing, 1 graph won, 2 normal won
3846static GRAPH_RACE_FLIP: AtomicU32 = AtomicU32::new(0);
3847static GRAPH_RACE_ARM_GRAPH: AtomicU8 = AtomicU8::new(0); // this generation's arm
3848static GRAPH_RACE_TOK: AtomicU32 = AtomicU32::new(0); // token index within the generation
3849static GRAPH_NS: [AtomicU64; 2] = [AtomicU64::new(0), AtomicU64::new(0)]; // [normal, graph]
3850static GRAPH_N: [AtomicU32; 2] = [AtomicU32::new(0), AtomicU32::new(0)];
3851
3852/// Steady per-token samples per arm before the race decides.
3853const GRAPH_RACE_SAMPLES: u32 = 4;
3854
3855// A graph that cannot be built for THIS model will never build: the
3856// refusal is a property of the weights, not of the moment. Retrying it
3857// per token is not free — the builder walks every layer and asks each
3858// tensor for a graph view before giving up at layer 0 — and on an
3859// Adreno 642L that retry cost 3x: forcing the graph on a model it
3860// refuses measured 0.3 tok/s against 0.905 for the per-op path it falls
3861// back to. Remembered once, the fallback runs at its own speed.
3862//
3863// The verdict is kept PER PIPELINE (`Pipeline::graph_refused` /
3864// `mark_graph_refused`), not in a process-wide flag: several pipelines
3865// of one file share a process in `serve` (backbone slots + skill lanes
3866// loaded mid-traffic), and a refusal in one lane — or the reset a new
3867// lane used to issue — must not move another lane's running sequence
3868// between the device and the host (R4/NF-2). Callers must NOT report
3869// transient refusals (an unsealed o1 state during prefill, a softcap).
3870
3871/// Called at every generation start (fresh KV). Applies a pending
3872/// verdict and picks this generation's arm while racing.
3873pub fn graph_race_begin_generation() {
3874    // One generation has now compiled whatever this model needs; keep it
3875    // for the next process. Once per run: the blob does not grow after
3876    // the pipelines exist, and the write is megabytes against the ~200 s
3877    // of compiling it saves on the device that needed this.
3878    #[cfg(feature = "gpu")]
3879    {
3880        // Save once, at the start of the SECOND generation: the first
3881        // has dispatched, so there is something to keep, and nothing is
3882        // saved before any work (the driver compiles at first use, not
3883        // at pipeline creation — the context comes up in 1.5 s while the
3884        // compiling costs minutes).
3885        //
3886        // Flushing again on 4, 8, 16 … was tried on the theory that a
3887        // chat turn compiles shapes the first one did not. It buys
3888        // nothing: a fresh app process still spent 49.0 s, then 58.7,
3889        // then 61.3 on its first answer with the backoff in place. One
3890        // flush it is.
3891        static FLUSHED: std::sync::Once = std::sync::Once::new();
3892        static FIRST: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(true);
3893        if FIRST.swap(false, Ordering::Relaxed) {
3894            // Nothing dispatched yet.
3895        } else {
3896            FLUSHED.call_once(crate::gpu_wgpu::pipeline_cache_flush);
3897        }
3898    }
3899    GRAPH_RACE_TOK.store(0, Ordering::Relaxed);
3900    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
3901        return;
3902    }
3903    let (gn, cn) = (
3904        GRAPH_N[1].load(Ordering::Relaxed),
3905        GRAPH_N[0].load(Ordering::Relaxed),
3906    );
3907    if gn >= GRAPH_RACE_SAMPLES && cn >= GRAPH_RACE_SAMPLES {
3908        let g_avg = GRAPH_NS[1].load(Ordering::Relaxed) / gn as u64;
3909        let c_avg = GRAPH_NS[0].load(Ordering::Relaxed) / cn as u64;
3910        let verdict = if g_avg < c_avg { 1 } else { 2 };
3911        GRAPH_RACE_STATE.store(verdict, Ordering::Relaxed);
3912        tracing::info!(
3913            "wgpu graph race: graph {:.2} ms/tok vs normal {:.2} ms/tok -> {}",
3914            g_avg as f64 / 1e6,
3915            c_avg as f64 / 1e6,
3916            if verdict == 1 { "graph" } else { "normal path" }
3917        );
3918        return;
3919    }
3920    let flip = GRAPH_RACE_FLIP.fetch_add(1, Ordering::Relaxed);
3921    GRAPH_RACE_ARM_GRAPH.store((flip % 2 == 1) as u8, Ordering::Relaxed);
3922}
3923
3924/// Should this decode token try the graph? `trusted` (discrete adapter,
3925/// explicit env, or a GDN hybrid whose state lives on the device) skips
3926/// the race entirely.
3927pub fn graph_race_use_graph(trusted: bool) -> bool {
3928    if trusted {
3929        return true;
3930    }
3931    match GRAPH_RACE_STATE.load(Ordering::Relaxed) {
3932        1 => true,
3933        2 => false,
3934        _ => GRAPH_RACE_ARM_GRAPH.load(Ordering::Relaxed) == 1,
3935    }
3936}
3937
3938/// First decode token of a racing graph generation: hopeless already?
3939/// (>4x the normal path's per-token average AND over a second.) Settles
3940/// the race immediately; the caller discards the graph result and
3941/// recomputes this token on the normal path.
3942pub fn graph_race_first_token_hopeless(dur: std::time::Duration) -> bool {
3943    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
3944        return false;
3945    }
3946    let first = GRAPH_RACE_TOK.load(Ordering::Relaxed) == 0;
3947    let cn = GRAPH_N[0].load(Ordering::Relaxed);
3948    if !first || cn == 0 {
3949        return false;
3950    }
3951    let c_avg = GRAPH_NS[0].load(Ordering::Relaxed) / cn as u64;
3952    let ns = dur.as_nanos() as u64;
3953    if ns > 1_000_000_000 && ns > 4 * c_avg {
3954        GRAPH_RACE_STATE.store(2, Ordering::Relaxed);
3955        tracing::info!(
3956            "wgpu graph race: first graph token {:.0} ms vs normal {:.2} ms/tok — hopeless, normal path wins",
3957            ns as f64 / 1e6,
3958            c_avg as f64 / 1e6
3959        );
3960        return true;
3961    }
3962    false
3963}
3964
3965/// Record one decode-token wall time for the racing arm. The first
3966/// token of each generation is discarded (KV-mirror upload / cold
3967/// caches on the graph arm; cold mmap on the normal arm).
3968pub fn graph_race_record(used_graph: bool, dur: std::time::Duration) {
3969    if GRAPH_RACE_STATE.load(Ordering::Relaxed) != 0 {
3970        return;
3971    }
3972    let tok = GRAPH_RACE_TOK.fetch_add(1, Ordering::Relaxed);
3973    if tok == 0 {
3974        return;
3975    }
3976    let i = used_graph as usize;
3977    GRAPH_NS[i].fetch_add(dur.as_nanos() as u64, Ordering::Relaxed);
3978    GRAPH_N[i].fetch_add(1, Ordering::Relaxed);
3979}
3980
3981/// Bounded-cost content fingerprint for the backends' pointer-keyed device
3982/// caches: FNV over the whole slice up to 4 KiB, over 64 spread 64-byte
3983/// windows (plus the length) above. An address-keyed hit must also prove
3984/// the bytes are still the ones it uploaded — the allocator reuses heap
3985/// and mmap addresses freely, so a reloaded model or a re-dequantized
3986/// layer lands where the old bytes were — and sampling keeps that proof at
3987/// ~a microsecond even for a 126 MB matrix. Real replacements (another
3988/// model's tensor, an Adam-updated master) differ densely, so a 4 KiB
3989/// spread cannot miss them.
3990pub(crate) fn fp_bytes(data: &[u8]) -> u64 {
3991    #[inline]
3992    fn fnv(mut h: u64, bytes: &[u8]) -> u64 {
3993        let (chunks, tail) = bytes.split_at(bytes.len() & !7);
3994        for c in chunks.chunks_exact(8) {
3995            h ^= u64::from_le_bytes(c.try_into().unwrap());
3996            h = h.wrapping_mul(0x100_0000_01b3);
3997        }
3998        for &b in tail {
3999            h ^= b as u64;
4000            h = h.wrapping_mul(0x100_0000_01b3);
4001        }
4002        h
4003    }
4004    let mut h = 0xcbf2_9ce4_8422_2325u64 ^ (data.len() as u64);
4005    if data.len() <= 4096 {
4006        return fnv(h, data);
4007    }
4008    let step = (data.len() - 64) / 63;
4009    for i in 0..64 {
4010        h = fnv(h, &data[i * step..i * step + 64]);
4011    }
4012    h
4013}
4014
4015/// `fp_bytes` over an f32 slice without a bytemuck dependency (the Metal
4016/// backend builds with no GPU feature flags).
4017pub(crate) fn fp_f32(data: &[f32]) -> u64 {
4018    let bytes = unsafe { std::slice::from_raw_parts(data.as_ptr() as *const u8, data.len() * 4) };
4019    fp_bytes(bytes)
4020}
4021
4022#[cfg(test)]
4023mod fp_tests {
4024    use super::fp_bytes;
4025
4026    /// The pointer-keyed caches survive on `fp_bytes` telling two different
4027    /// tensors apart at a reused address. Its sampling must therefore see a
4028    /// change ANYWHERE — head, tail, and the stretches between windows are
4029    /// the places a cheaper hash would go blind.
4030    #[test]
4031    fn fp_bytes_sees_a_change_anywhere_in_a_sampled_slice() {
4032        let n = 1 << 20; // 1 MiB — far above the 4 KiB full-hash threshold
4033        let base: Vec<u8> = (0..n).map(|i| (i * 31 + 7) as u8).collect();
4034        let h0 = fp_bytes(&base);
4035        assert_eq!(h0, fp_bytes(&base), "fingerprint must be deterministic");
4036        // A DENSE change (every requantized/redequantized tensor is one)
4037        // must flip the fingerprint no matter how the windows fall.
4038        let mut dense = base.clone();
4039        for b in dense.iter_mut() {
4040            *b = b.wrapping_add(1);
4041        }
4042        assert_ne!(
4043            h0,
4044            fp_bytes(&dense),
4045            "a fully different tensor slipped through"
4046        );
4047        // Length participates: the same prefix at a shorter length is a
4048        // different key AND a different fingerprint.
4049        assert_ne!(h0, fp_bytes(&base[..n - 64]));
4050        // Below the threshold the hash is exact: a single flipped byte in
4051        // a norm-sized vector must be seen.
4052        let mut small = vec![3u8; 4096];
4053        let hs = fp_bytes(&small);
4054        small[2048] ^= 1;
4055        assert_ne!(hs, fp_bytes(&small), "full hash missed a one-byte change");
4056        // And the sampled windows land within bounds on awkward sizes.
4057        for n in [4097usize, 5000, 64 * 64, 1 << 16] {
4058            let v = vec![9u8; n];
4059            let _ = fp_bytes(&v); // must not panic on window math
4060        }
4061    }
4062}
4063
4064/// Hand the card back after a bake: drop its resident weights, planes and
4065/// pools so the ordinary engine (the runtime gate, a serve that follows)
4066/// starts from a clean budget. No-op off the wgpu backend.
4067pub fn bake_release() {
4068    #[cfg(feature = "gpu")]
4069    crate::gpu_wgpu::bake_release();
4070}
4071
4072/// Strict-f32 for the bake's GEMMs (phase A mask training): the mask
4073/// selects neurons by a gradient signal, and f16 operand rounding on
4074/// that signal closes the wrong ones. No-op off the wgpu backend.
4075pub fn bake_precision_strict(on: bool) {
4076    #[cfg(feature = "gpu")]
4077    crate::gpu_wgpu::bake_precision_strict(on);
4078    #[cfg(not(feature = "gpu"))]
4079    let _ = on;
4080}
4081
4082/// CMF_GRAPH_HOSTPROF=1: how a graph token's wall splits between the
4083/// host encoding the command stream and the tail the GPU still owes
4084/// after encode. Fifteen GPU-side suspects measured null while the
4085/// bench counted 17.7k allocations a token — this is the instrument
4086/// that says whether the thief was on the host all along.
4087pub fn hostprof_encode_done(t0: std::time::Instant) {
4088    use std::sync::atomic::{AtomicU64, Ordering};
4089    static ENC: AtomicU64 = AtomicU64::new(0);
4090    static N: AtomicU64 = AtomicU64::new(0);
4091    if std::env::var("CMF_GRAPH_HOSTPROF").as_deref() != Ok("1") {
4092        return;
4093    }
4094    ENC.fetch_add(t0.elapsed().as_nanos() as u64, Ordering::Relaxed);
4095    let n = N.fetch_add(1, Ordering::Relaxed) + 1;
4096    if n % 100 == 0 {
4097        eprintln!(
4098            "hostprof: encode {:.2} ms/token over {n} tokens",
4099            ENC.load(Ordering::Relaxed) as f64 / n as f64 / 1e6
4100        );
4101    }
4102}
4103
4104pub fn hostprof_total(t0: std::time::Instant) {
4105    use std::sync::atomic::{AtomicU64, Ordering};
4106    static TOT: AtomicU64 = AtomicU64::new(0);
4107    static N: AtomicU64 = AtomicU64::new(0);
4108    if std::env::var("CMF_GRAPH_HOSTPROF").as_deref() != Ok("1") {
4109        return;
4110    }
4111    TOT.fetch_add(t0.elapsed().as_nanos() as u64, Ordering::Relaxed);
4112    let n = N.fetch_add(1, Ordering::Relaxed) + 1;
4113    if n % 100 == 0 {
4114        eprintln!(
4115            "hostprof: total {:.2} ms/token over {n} tokens",
4116            TOT.load(Ordering::Relaxed) as f64 / n as f64 / 1e6
4117        );
4118    }
4119}
4120
4121/// Per-stage host-encode accumulator for the Metal token loop
4122/// (CMF_GRAPH_HOSTPROF=1). Stage 0 = GDN-run encode; everything else
4123/// falls out by subtraction from hostprof's encode total.
4124pub fn stageprof(stage: u32, dt: std::time::Duration) {
4125    use std::sync::atomic::{AtomicU64, Ordering};
4126    static NS: [AtomicU64; 4] = [
4127        AtomicU64::new(0),
4128        AtomicU64::new(0),
4129        AtomicU64::new(0),
4130        AtomicU64::new(0),
4131    ];
4132    static N: AtomicU64 = AtomicU64::new(0);
4133    if std::env::var("CMF_GRAPH_HOSTPROF").as_deref() != Ok("1") {
4134        return;
4135    }
4136    NS[stage as usize % 4].fetch_add(dt.as_nanos() as u64, Ordering::Relaxed);
4137    if stage == 1 {
4138        let n = N.fetch_add(1, Ordering::Relaxed) + 1;
4139        if n % 200 == 0 {
4140            eprintln!(
4141                "stageprof: planning {:.2} ms/tok | gdn-item {:.2} ms/tok | attn-item {:.2} ms/tok ({n} tok)",
4142                NS[1].load(Ordering::Relaxed) as f64 / n as f64 / 1e6,
4143                NS[2].load(Ordering::Relaxed) as f64 / n as f64 / 1e6,
4144                NS[3].load(Ordering::Relaxed) as f64 / n as f64 / 1e6
4145            );
4146        }
4147    }
4148}
4149
4150/// Active weight bytes dispatched so far (Metal decode path); 0 where
4151/// the backend does not count. The honest floor's numerator.
4152pub fn weight_bytes_dispatched() -> u64 {
4153    let mut total = 0u64;
4154    #[cfg(target_os = "macos")]
4155    {
4156        total += crate::gpu_metal::WEIGHT_BYTES.load(std::sync::atomic::Ordering::Relaxed);
4157    }
4158    #[cfg(feature = "gpu")]
4159    {
4160        total += crate::gpu_wgpu::WEIGHT_BYTES.load(std::sync::atomic::Ordering::Relaxed);
4161    }
4162    total
4163}
4164
4165/// The per-stage split of `weight_bytes_dispatched`:
4166/// [misc, dense-ffn, moe, attn, gdn, head].
4167pub fn weight_bytes_by() -> [u64; 6] {
4168    #[cfg(target_os = "macos")]
4169    {
4170        let mut o = [0u64; 6];
4171        for (i, a) in crate::gpu_metal::WEIGHT_BYTES_BY.iter().enumerate() {
4172            o[i] = a.load(std::sync::atomic::Ordering::Relaxed);
4173        }
4174        return o;
4175    }
4176    #[allow(unreachable_code)]
4177    [0; 6]
4178}
4179
4180#[cfg(test)]
4181mod f16_guard_tests {
4182    use super::*;
4183
4184    /// The f16 guard's maximum: the largest magnitude through the lanes and
4185    /// the remainder, +inf for an inf or a NaN anywhere.
4186    #[test]
4187    fn abs_max_or_inf_is_the_magnitude_maximum() {
4188        let mut xs: Vec<f32> = (0..37).map(|i| (i as f32 - 18.0) * 0.5).collect();
4189        assert_eq!(abs_max_or_inf(&xs), 9.0);
4190        xs[36] = -70000.0; // the remainder
4191        assert_eq!(abs_max_or_inf(&xs), 70000.0);
4192        xs[3] = f32::NAN; // a lane
4193        assert_eq!(abs_max_or_inf(&xs), f32::INFINITY);
4194        xs[3] = 0.0;
4195        xs[35] = f32::NEG_INFINITY;
4196        assert_eq!(abs_max_or_inf(&xs), f32::INFINITY);
4197        assert_eq!(abs_max_or_inf(&[]), 0.0);
4198        assert_eq!(abs_max_or_inf(&[-0.0, -1e-30]), 1e-30);
4199    }
4200}
4201
4202#[cfg(test)]
4203mod probe_warmup_tests {
4204    use super::*;
4205    use std::time::Duration;
4206
4207    fn ms(v: f64) -> Duration {
4208        Duration::from_nanos((v * 1e6) as u64)
4209    }
4210
4211    /// The bug this pins, measured on an A100: the first device call for
4212    /// a class compiles its pipeline, was timed at 117.01 ms against the
4213    /// host's 3.19, and sent `gemm-nt` to the CPU for the whole process —
4214    /// which ran a 27B bake on 2.6 cores with the card idle.
4215    #[test]
4216    fn one_cold_first_sample_does_not_lose_the_class() {
4217        let p = Probe::new();
4218        // First device sample is the pipeline build. Then the truth.
4219        probe_record_into(&p, "gemm-nt", None, true, ms(117.01));
4220        probe_record_into(&p, "gemm-nt", None, true, ms(1.1));
4221        probe_record_into(&p, "gemm-nt", None, true, ms(1.0));
4222        probe_record_into(&p, "gemm-nt", None, false, ms(3.19));
4223        probe_record_into(&p, "gemm-nt", None, false, ms(3.20));
4224        assert_eq!(
4225            p.state.load(Ordering::Relaxed),
4226            1,
4227            "the device is 3x faster once warm and must win"
4228        );
4229    }
4230
4231    /// The warm-up must not become a way to never decide, and must not
4232    /// underflow: a blind decrement at zero wraps a u32 to its maximum
4233    /// and mutes the arm for the life of the process.
4234    #[test]
4235    fn the_warmup_is_spent_once_and_never_underflows() {
4236        let p = Probe::new();
4237        for _ in 0..8 {
4238            probe_record_into(&p, "matmat", None, true, ms(10.0));
4239        }
4240        assert_eq!(p.gpu_burn.load(Ordering::Relaxed), 0, "spent, not wrapped");
4241        assert_eq!(
4242            p.gpu_n.load(Ordering::Relaxed),
4243            7,
4244            "one sample burned, the rest counted"
4245        );
4246    }
4247
4248    /// A device path that always refuses records no timing, so without
4249    /// counting the refusals the class can never reach a verdict. On an
4250    /// M4 with LFM2.5-2.6B `ffn` was still undecided after 9000 calls,
4251    /// alternating arms and paying a failed device attempt on half of
4252    /// them.
4253    #[test]
4254    fn a_class_whose_device_always_declines_settles_on_the_host() {
4255        let _probe_guard = probe_test_guard();
4256        // A class no other test in this file touches: `probe_note_decline`
4257        // works on the process-wide probes by design, and the tests in
4258        // this binary share them.
4259        let c = OpClass::MatmatWide;
4260        let p = &PROBES[c as usize];
4261        p.state.store(0, Ordering::Relaxed);
4262        p.declines.store(0, Ordering::Relaxed);
4263        for _ in 0..(PROBE_DECLINE_LIMIT - 1) {
4264            probe_note_decline(c);
4265        }
4266        assert_eq!(
4267            p.state.load(Ordering::Relaxed),
4268            0,
4269            "one short of the limit is still a question, not an answer"
4270        );
4271        probe_note_decline(c);
4272        assert_eq!(p.state.load(Ordering::Relaxed), 2, "settled on the host");
4273        assert!(matches!(probe_arm(c), ProbeArm::Cpu));
4274        p.state.store(0, Ordering::Relaxed);
4275        p.declines.store(0, Ordering::Relaxed);
4276    }
4277
4278    /// A genuinely slower device still loses — the warm-up removes an
4279    /// artefact, it does not put a thumb on the scale.
4280    #[test]
4281    fn a_slow_device_still_loses_after_the_warmup() {
4282        let p = Probe::new();
4283        for _ in 0..4 {
4284            probe_record_into(&p, "matvec", None, true, ms(40.0));
4285        }
4286        for _ in 0..4 {
4287            probe_record_into(&p, "matvec", None, false, ms(2.0));
4288        }
4289        assert_eq!(p.state.load(Ordering::Relaxed), 2, "host wins on merit");
4290    }
4291}
4292
4293/// Scratch/weight lifetime for a synchronous image-pipeline stage. Declare
4294/// this before the stage model so the model drops before cache collection.
4295pub(crate) struct ImageStageGuard {
4296    #[cfg(target_os = "macos")]
4297    metal: Option<crate::gpu_metal::ImageStageGuard>,
4298    #[cfg(feature = "gpu")]
4299    wgpu: crate::gpu_wgpu::ImageStageGuard,
4300}
4301
4302pub(crate) fn image_stage_scope() -> ImageStageGuard {
4303    ImageStageGuard {
4304        #[cfg(target_os = "macos")]
4305        metal: if matches!(backend(), Backend::Metal) {
4306            Some(crate::gpu_metal::image_stage_scope())
4307        } else {
4308            None
4309        },
4310        #[cfg(feature = "gpu")]
4311        wgpu: crate::gpu_wgpu::image_stage_scope(),
4312    }
4313}
4314
4315impl ImageStageGuard {
4316    pub(crate) fn track_model(&mut self, uid: u64) {
4317        #[cfg(target_os = "macos")]
4318        if let Some(metal) = &mut self.metal {
4319            metal.track_model(uid);
4320        }
4321        #[cfg(feature = "gpu")]
4322        self.wgpu.track_model(uid);
4323        #[cfg(not(target_os = "macos"))]
4324        let _ = uid;
4325    }
4326}
4327
4328// ════════════════════════════════════════════════════════════════════
4329// Z-Image-Turbo device contract (WP0 scaffold, plan §2.1). APPEND-ONLY.
4330//
4331// Owner of the contract: the WP1 lead. The backends implement it in their
4332// own child modules — `gpu_wgpu/zimage.rs` (WP2) and `gpu_metal/zimage.rs`
4333// (WP3) — and never edit the parent files. New fields are added only as
4334// `Option<…>` with agreed semantics; existing fields never change meaning.
4335//
4336// Convention (the same as every `gpu::*` entry): `false` = "not handled",
4337// nothing observable was changed, and the caller runs the CPU path
4338// (`zimage::ZImageDit::step_cpu` etc.), which is the bit-level reference.
4339//
4340// Sequence order everywhere is diffusers' [img rows…, cap rows…], with
4341// padded lengths n_img_p = ceil32(n_img) and n_cap_p = ceil32(L).
4342// ════════════════════════════════════════════════════════════════════
4343
4344// ───────────────────── Qwen-Image-2.1 device contract ─────────────────────
4345
4346/// Geometry of the Qwen-Image-2.1 denoiser.
4347#[derive(Clone, Copy, Debug, PartialEq)]
4348pub struct Qi21Geom {
4349    pub hidden: usize,
4350    pub nh: usize,
4351    pub hd: usize,
4352    pub inter: usize,
4353    pub in_ch: usize,
4354    pub eps: f32,
4355}
4356
4357/// One block's weights: tensor indices of `to_q, to_k, to_v, to_out.0,
4358/// gate_layer, proj (up), out (down)` and the per-head q/k norm weights.
4359pub struct Qi21BlockRef<'a> {
4360    pub w: [usize; 7],
4361    pub norm_q: &'a [f32],
4362    pub norm_k: &'a [f32],
4363}
4364
4365/// Everything the device needs to build a program and run its prefix.
4366pub struct Qi21PrefillArgs<'a> {
4367    pub model: &'a Arc<CmfModel>,
4368    pub geom: Qi21Geom,
4369    pub blocks: &'a [Qi21BlockRef<'a>],
4370    /// `img_in` [hidden, 64] and `proj_out` [64, hidden], f32.
4371    pub img_in: &'a [f32],
4372    pub proj_out: &'a [f32],
4373    pub key: u64,
4374    /// Prefix rows after `txt_in` / `img_in`, `[lp, hidden]`.
4375    pub x: &'a [f32],
4376    pub lp: usize,
4377    /// RoPE cos/sin of the prefix rows and of the target rows, `[rows, 64]`.
4378    pub rope_p: (&'a [f32], &'a [f32]),
4379    pub rope_t: (&'a [f32], &'a [f32]),
4380    /// Keys each prefix row sees (a leading run; non-decreasing).
4381    pub vis: &'a [u32],
4382    /// The t = 0 modulation `[s1|g1|s2|g2]`.
4383    pub mods0: &'a [f32],
4384    /// Target rows.
4385    pub n: usize,
4386}
4387
4388/// Build the program `a.key` and run its prefix on the device.
4389#[allow(unused_variables)]
4390pub fn qi21_prefill(a: &Qi21PrefillArgs) -> bool {
4391    match backend() {
4392        #[cfg(target_os = "macos")]
4393        Backend::Metal => crate::gpu_metal::qi21::prefill(a),
4394        #[cfg(feature = "gpu")]
4395        Backend::Wgpu => crate::gpu_wgpu::qi21::prefill(a),
4396        #[allow(unreachable_patterns)]
4397        _ => false,
4398    }
4399}
4400
4401/// One denoiser call of program `key`: `xtok [n, 64]` → `out [n, 64]`.
4402#[allow(unused_variables)]
4403pub fn qi21_step(key: u64, xtok: &[f32], mods: &[f32], fs: &[f32], out: &mut [f32]) -> bool {
4404    match backend() {
4405        #[cfg(target_os = "macos")]
4406        Backend::Metal => crate::gpu_metal::qi21::step(key, xtok, mods, fs, out),
4407        #[cfg(feature = "gpu")]
4408        Backend::Wgpu => crate::gpu_wgpu::qi21::step(key, xtok, mods, fs, out),
4409        #[allow(unreachable_patterns)]
4410        _ => false,
4411    }
4412}
4413
4414/// Drop program `key`. The wgpu module is released directly (module-local
4415/// state only), so a release never brings a device up.
4416#[allow(unused_variables)]
4417pub fn qi21_release_key(key: u64) {
4418    #[cfg(target_os = "macos")]
4419    if matches!(backend(), Backend::Metal) {
4420        crate::gpu_metal::qi21::release_key(key);
4421    }
4422    #[cfg(feature = "gpu")]
4423    crate::gpu_wgpu::qi21::release_key(key);
4424}
4425
4426/// Drop the denoiser's device state (see `qi21_release_key`), and the
4427/// resident VAE decoder's weights.
4428pub fn qi21_release() {
4429    #[cfg(target_os = "macos")]
4430    if matches!(backend(), Backend::Metal) {
4431        crate::gpu_metal::qi21::release();
4432    }
4433    #[cfg(feature = "gpu")]
4434    {
4435        crate::gpu_wgpu::qi21::release();
4436        crate::gpu_wgpu::qi21_vae::release();
4437    }
4438}
4439
4440/// One conv of the Qwen-Image-2.1 VAE decoder: host f32 weights
4441/// `[co][ci][k][k]` and bias `[co]` (k = 1 or 3, stride 1, same padding).
4442#[derive(Clone, Copy)]
4443pub struct Qi21VaeConvRef<'a> {
4444    pub w: &'a [f32],
4445    pub b: &'a [f32],
4446    pub ci: usize,
4447    pub co: usize,
4448    pub k: usize,
4449}
4450
4451/// A residual block: `conv2(φ(conv1(φ(x)))) + x` (through the 1×1
4452/// shortcut when ci ≠ co), φ = RMS_norm over channels (x/‖x‖·√C·γ), SiLU.
4453pub struct Qi21VaeResRef<'a> {
4454    pub g1: &'a [f32],
4455    pub c1: Qi21VaeConvRef<'a>,
4456    pub g2: &'a [f32],
4457    pub c2: Qi21VaeConvRef<'a>,
4458    pub shortcut: Option<Qi21VaeConvRef<'a>>,
4459}
4460
4461/// An up block: its resnets, then (all but the last block) nearest-2× +
4462/// the 3×3 conv, plus the DupUp shortcut of the block's input (`in_dim` →
4463/// `out_dim` channels, temporal factor `ft`).
4464pub struct Qi21VaeUpRef<'a> {
4465    pub resnets: Vec<Qi21VaeResRef<'a>>,
4466    pub up: Option<(Qi21VaeConvRef<'a>, usize)>,
4467    pub in_dim: usize,
4468    pub out_dim: usize,
4469}
4470
4471/// The Qwen-Image-2.1 VAE decoder (`qwen_image21_vae.rs`) for a resident
4472/// device decode.
4473pub struct Qi21VaeDecodeArgs<'a> {
4474    /// Identity of the weights: a backend caches its planes by it.
4475    pub key: u64,
4476    pub post_quant: Qi21VaeConvRef<'a>,
4477    pub conv_in: Qi21VaeConvRef<'a>,
4478    pub mid_res: [Qi21VaeResRef<'a>; 2],
4479    /// The mid attention: RMS_norm γ, `to_qkv` (1×1, 3c outputs: q, k, v),
4480    /// `proj` (1×1); single head, residual.
4481    pub attn_gamma: &'a [f32],
4482    pub attn_qkv: Qi21VaeConvRef<'a>,
4483    pub attn_proj: Qi21VaeConvRef<'a>,
4484    pub ups: Vec<Qi21VaeUpRef<'a>>,
4485    pub norm_out: &'a [f32],
4486    pub conv_out: Qi21VaeConvRef<'a>,
4487}
4488
4489/// Resident VAE decode: `z` = raw latent planes `[z_dim, h·w]` → `out`
4490/// `[out_channels, 16h·16w]` (before the clamp). `false` = not handled,
4491/// `out` untouched: the per-conv path runs.
4492#[allow(unused_variables)]
4493pub fn qi21_vae_decode(a: &Qi21VaeDecodeArgs, z: &[f32], h: usize, w: usize, out: &mut [f32]) -> bool {
4494    match backend() {
4495        #[cfg(feature = "gpu")]
4496        Backend::Wgpu => crate::gpu_wgpu::qi21_vae::decode(a, z, h, w, out),
4497        #[allow(unreachable_patterns)]
4498        _ => false,
4499    }
4500}
4501
4502/// One Z-Image transformer block's device inputs (noise refiner, context
4503/// refiner or main layer — all share this shape). Weights are tensor
4504/// indices into `model.tensors` (diffusers names under `dit.`); the codec
4505/// is whatever the container holds (F16/Bf16/Q8Row/Q8_2f/Q4TiledP…), and a
4506/// backend that cannot expand a codec declines (returns `false`).
4507/// Norm vectors are f32 host slices that live as long as the caller's
4508/// `ZImageDit`; a backend may cache them by pointer (they do not change).
4509#[derive(Clone, Copy)]
4510pub struct ZBlockRef<'a> {
4511    /// `attention.to_q/to_k/to_v/to_out.0.weight`, each [hidden, hidden].
4512    pub wq: usize,
4513    pub wk: usize,
4514    pub wv: usize,
4515    pub wo: usize,
4516    /// `feed_forward.w1` (gate) / `w3` (up) [inter, hidden], `w2` (down)
4517    /// [hidden, inter]. FFN = w2(silu(w1·x) ⊙ w3·x).
4518    pub w1: usize,
4519    pub w3: usize,
4520    pub w2: usize,
4521    /// `attention_norm1` / `attention_norm2`, [hidden] (plain-w RMSNorm).
4522    pub norm1: &'a [f32],
4523    pub norm2: &'a [f32],
4524    /// `ffn_norm1` / `ffn_norm2`, [hidden].
4525    pub ffn_norm1: &'a [f32],
4526    pub ffn_norm2: &'a [f32],
4527    /// `attention.norm_q` / `norm_k`, [hd] (per-head RMSNorm before RoPE).
4528    pub norm_q: &'a [f32],
4529    pub norm_k: &'a [f32],
4530}
4531
4532/// Z-Image geometry. Turbo: hidden 3840, nh 30 (MHA, no GQA), hd 128,
4533/// inter 10240, eps 1e-5 (all RMSNorms incl. qk-norm), final_eps 1e-6
4534/// (the affine-free final LayerNorm), patch_dim 64 (2×2×16).
4535#[derive(Clone, Copy, Debug, PartialEq)]
4536pub struct ZGeom {
4537    pub hidden: usize,
4538    pub nh: usize,
4539    pub hd: usize,
4540    pub inter: usize,
4541    pub eps: f32,
4542    pub final_eps: f32,
4543    pub patch_dim: usize,
4544}
4545
4546/// Once per (prompt, resolution). The backend uploads/caches what it needs
4547/// keyed by `key`; weight planes are keyed by the MODEL (not by `key`) and
4548/// survive across prompts until `zimage_release`.
4549pub struct ZPrepareArgs<'a> {
4550    pub model: &'a Arc<CmfModel>,
4551    pub geom: ZGeom,
4552    /// Caller-chosen identity of this (prompt, resolution) state; every
4553    /// `ZStepArgs` of the same image carries the same key.
4554    pub key: u64,
4555    /// Image tokens (H/16 · W/16), padded count ceil32(n_img), caption
4556    /// padded count ceil32(L). S = n_img_p + n_cap_p.
4557    pub n_img: usize,
4558    pub n_img_p: usize,
4559    pub n_cap_p: usize,
4560    /// The patch grid (H/16, W/16); n_img = grid.0 · grid.1. Row-major
4561    /// token order `hp·grid.1 + wp`.
4562    pub grid: (usize, usize),
4563    /// [n_cap_p, hidden], ALREADY context-refined (host or device).
4564    pub cap: &'a [f32],
4565    /// Noise-refiner RoPE: [n_img_p · hd/2] cos, sin (complex-interleaved
4566    /// pairs, hd/2 angles per token).
4567    pub rope_img: (&'a [f32], &'a [f32]),
4568    /// Main-layer RoPE: [(n_img_p + n_cap_p) · hd/2], rows ordered [img, cap].
4569    pub rope_joint: (&'a [f32], &'a [f32]),
4570    /// `all_x_embedder.2-1.weight` [hidden, 64], `.bias` [hidden],
4571    /// `x_pad_token` [hidden] (replaces rows ≥ n_img after the embed).
4572    pub x_emb_w: &'a [f32],
4573    pub x_emb_b: &'a [f32],
4574    pub x_pad: &'a [f32],
4575    /// `all_final_layer.2-1.linear.weight` [64, hidden], `.bias` [64].
4576    pub final_w: &'a [f32],
4577    pub final_b: &'a [f32],
4578    /// 2 noise-refiner blocks (image rows only) and 30 main layers.
4579    pub noise_refiner: &'a [ZBlockRef<'a>],
4580    pub layers: &'a [ZBlockRef<'a>],
4581    /// OPTIONAL (backends may ignore): the modulation of EVERY step of this
4582    /// image, [steps][(2+30)·4·hidden] in the `ZStepArgs::mods` layout, and
4583    /// [steps][hidden] final scales, so a backend can upload them once per
4584    /// image and index them by `ZStepArgs::step`. `ZStepArgs::mods` is still
4585    /// always supplied and is authoritative.
4586    pub mods_all: Option<&'a [f32]>,
4587    pub final_scale_all: Option<&'a [f32]>,
4588    /// OPTIONAL (B2): the CFG negative item. When `Some`, the backend
4589    /// prepares ONE batch-2 program under `key` — item 0 is this prompt,
4590    /// item 1 the negative — and every `ZStepArgs` of that key must carry
4591    /// `out_neg`. A backend without batch 2 returns `false` (the caller
4592    /// then prepares the two items separately or runs the CPU path).
4593    pub neg: Option<ZNegArgs<'a>>,
4594}
4595
4596/// The negative (unconditional) item of a CFG pair: its own refined
4597/// caption, padded caption length and joint RoPE table (the image ids sit
4598/// at axis-0 position L_p+1, so both tables depend on the item's L_p).
4599pub struct ZNegArgs<'a> {
4600    /// [n_cap_p, hidden], context-refined.
4601    pub cap: &'a [f32],
4602    pub n_cap_p: usize,
4603    /// [n_img_p · hd/2] cos, sin (noise refiner) of this item.
4604    pub rope_img: (&'a [f32], &'a [f32]),
4605    /// [(n_img_p + n_cap_p) · hd/2] cos, sin, rows [img, cap].
4606    pub rope_joint: (&'a [f32], &'a [f32]),
4607}
4608
4609/// Once per denoising step.
4610pub struct ZStepArgs<'a> {
4611    /// The `ZPrepareArgs::key` this step belongs to. A key the backend has
4612    /// not prepared → `false`.
4613    pub key: u64,
4614    /// Step index into the schedule (0..steps); selects the row of
4615    /// `ZPrepareArgs::mods_all` when a backend uses it.
4616    pub step: usize,
4617    /// [n_img_p, 64] patchified latent, inner order (dy·2+dx)·16+c. Rows
4618    /// ≥ n_img are copies of the last row; the backend replaces them with
4619    /// `x_pad` after the embed.
4620    pub x_tok: &'a [f32],
4621    /// Per block (noise_refiner then layers) the RAW chunks
4622    /// [scale_msa, gate_msa, scale_mlp, gate_mlp] of Linear(temb) (no SiLU
4623    /// before it), [(2+30)·4·hidden]. The backend applies (1+s) and tanh(g).
4624    pub mods: &'a [f32],
4625    /// [hidden] = 1 + Linear(SiLU(temb)) — already includes the +1.
4626    pub final_scale: &'a [f32],
4627    /// [n_img, 64]: the model output v (before the pipeline's negation),
4628    /// image rows only, patchified order.
4629    pub out: &'a mut [f32],
4630    /// [n_img, 64]: the negative item's v — required (and only valid) for
4631    /// a key prepared with `ZPrepareArgs::neg`. Both items see `x_tok`.
4632    pub out_neg: Option<&'a mut [f32]>,
4633}
4634
4635/// Prepare the per-(prompt, resolution) device state. Backends: wgpu →
4636/// `gpu_wgpu::zimage::prepare` (WP2), Metal → `gpu_metal::zimage::prepare`
4637/// (WP3).
4638#[allow(unused_variables)]
4639pub fn zimage_prepare(a: &ZPrepareArgs) -> bool {
4640    match backend() {
4641        #[cfg(target_os = "macos")]
4642        Backend::Metal => crate::gpu_metal::zimage::prepare(a),
4643        #[cfg(feature = "gpu")]
4644        Backend::Wgpu => crate::gpu_wgpu::zimage::prepare(a),
4645        #[allow(unreachable_patterns)]
4646        _ => false,
4647    }
4648}
4649
4650/// One full DiT forward on the device: x_embed → pad rows → noise refiner
4651/// ×2 → concat [img, cap] → 30 layers → final LayerNorm·scale → Linear →
4652/// image rows into `a.out`.
4653#[allow(unused_variables)]
4654pub fn zimage_step(a: &mut ZStepArgs) -> bool {
4655    match backend() {
4656        #[cfg(target_os = "macos")]
4657        Backend::Metal => crate::gpu_metal::zimage::step(a),
4658        #[cfg(feature = "gpu")]
4659        Backend::Wgpu => crate::gpu_wgpu::zimage::step(a),
4660        #[allow(unreachable_patterns)]
4661        _ => false,
4662    }
4663}
4664
4665/// OPTIONAL (B2): build the backend's weight planes for the per-step blocks
4666/// and the context refiner ahead of `zimage_prepare`, so the caller can
4667/// overlap the upload with the (CPU) text encoder. `false` = not done;
4668/// `zimage_prepare` builds whatever is missing either way.
4669#[allow(unused_variables)]
4670pub fn zimage_preload(
4671    model: &Arc<CmfModel>,
4672    geom: &ZGeom,
4673    noise_refiner: &[ZBlockRef],
4674    layers: &[ZBlockRef],
4675    context_refiner: &[ZBlockRef],
4676) -> bool {
4677    match backend() {
4678        #[cfg(target_os = "macos")]
4679        Backend::Metal => {
4680            crate::gpu_metal::zimage::preload(model, geom, noise_refiner, layers, context_refiner)
4681        }
4682        #[cfg(feature = "gpu")]
4683        Backend::Wgpu => crate::gpu_wgpu::zimage::preload(model, geom, noise_refiner, layers, context_refiner),
4684        #[allow(unreachable_patterns)]
4685        _ => false,
4686    }
4687}
4688
4689/// Persist the driver's compiled pipelines after a Z-Image generation (the
4690/// chain's kernels are built at first use, after the context came up), so
4691/// the next process skips the compile. Best-effort, no-op off wgpu.
4692pub fn zimage_flush_pipelines() {
4693    #[cfg(feature = "gpu")]
4694    if matches!(backend(), Backend::Wgpu) {
4695        crate::gpu_wgpu::pipeline_cache_flush();
4696    }
4697}
4698
4699/// OPTIONAL (B2): bring the device up and compile the Z-Image kernels, on
4700/// a helper thread at the start of a generation (the context and the
4701/// compiles cost ~1 s cold, beside the host-side loading). `false` = no
4702/// device path here.
4703pub fn zimage_warmup() -> bool {
4704    match backend() {
4705        #[cfg(target_os = "macos")]
4706        Backend::Metal => crate::gpu_metal::zimage::warmup(),
4707        #[cfg(feature = "gpu")]
4708        Backend::Wgpu => crate::gpu_wgpu::zimage::warmup(),
4709        #[allow(unreachable_patterns)]
4710        _ => false,
4711    }
4712}
4713
4714/// OPTIONAL (B2): upload the resident VAE's weights and compile its
4715/// kernels ahead of `vae_decode_chain` (the caller runs it on a helper
4716/// thread while the DiT steps keep the device busy). `false` = not done.
4717#[allow(unused_variables)]
4718pub fn vae_prewarm(a: &crate::vae::VaeChainArgs) -> bool {
4719    match backend() {
4720        #[cfg(target_os = "macos")]
4721        Backend::Metal => crate::gpu_metal::zimage::vae_prewarm(a),
4722        #[cfg(feature = "gpu")]
4723        Backend::Wgpu => crate::gpu_wgpu::zimage::vae_prewarm(a),
4724        #[allow(unreachable_patterns)]
4725        _ => false,
4726    }
4727}
4728
4729/// Drop the Z-Image DiT device state (planes, prepared programs) but keep
4730/// the VAE chain (B2: the generator frees the DiT before decoding).
4731pub fn zimage_release_dit() {
4732    #[cfg(target_os = "macos")]
4733    crate::gpu_metal::zimage::release_dit();
4734    #[cfg(feature = "gpu")]
4735    crate::gpu_wgpu::zimage::release_dit();
4736}
4737
4738/// Drop every Z-Image device resource (planes, prepared states, VAE chain
4739/// buffers): stage change or process end. Calls each compiled backend's
4740/// release directly, without `backend()`, so it never brings a device up;
4741/// the child modules' `release` must touch module-local state only.
4742pub fn zimage_release() {
4743    #[cfg(target_os = "macos")]
4744    crate::gpu_metal::zimage::release();
4745    #[cfg(feature = "gpu")]
4746    crate::gpu_wgpu::zimage::release();
4747}
4748
4749/// Optional device context refiner: the same block math with scale = 0 and
4750/// gate = 1 (unmodulated): x += norm2(attn(norm1(x))); x += ffn_norm2(ffn(
4751/// ffn_norm1(x))). `cap` is [n_cap_p, hidden] in/out (the cap_embedder
4752/// output with pad rows already = cap_pad_token); `rope_cap` is
4753/// [n_cap_p · hd/2] cos, sin. `false` = untouched, run the CPU refiner.
4754#[allow(unused_variables)]
4755pub fn zimage_refine_caption(
4756    model: &Arc<CmfModel>,
4757    geom: &ZGeom,
4758    blocks: &[ZBlockRef],
4759    rope_cap: (&[f32], &[f32]),
4760    cap: &mut [f32],
4761) -> bool {
4762    match backend() {
4763        #[cfg(target_os = "macos")]
4764        Backend::Metal => {
4765            crate::gpu_metal::zimage::refine_caption(model, geom, blocks, rope_cap, cap)
4766        }
4767        #[cfg(feature = "gpu")]
4768        Backend::Wgpu => {
4769            crate::gpu_wgpu::zimage::refine_caption(model, geom, blocks, rope_cap, cap)
4770        }
4771        #[allow(unreachable_patterns)]
4772        _ => false,
4773    }
4774}
4775
4776/// Resident Flux-VAE decode (the whole decoder on the device, one latent
4777/// upload, one RGB readback). `a` comes from `VaeDecoder::chain_args()`.
4778/// `z` is [latent_channels, h, w] ALREADY de-normalised
4779/// (z/scaling_factor + shift_factor — the conv_in input); `out` is
4780/// [3, 8h, 8w], the raw decoder output (≈[-1, 1], before x/2+0.5).
4781#[allow(unused_variables)]
4782pub fn vae_decode_chain(
4783    a: &crate::vae::VaeChainArgs,
4784    z: &[f32],
4785    h: usize,
4786    w: usize,
4787    out: &mut [f32],
4788) -> bool {
4789    match backend() {
4790        #[cfg(target_os = "macos")]
4791        Backend::Metal => crate::gpu_metal::zimage::vae_decode_chain(a, z, h, w, out),
4792        #[cfg(feature = "gpu")]
4793        Backend::Wgpu => crate::gpu_wgpu::zimage::vae_decode_chain(a, z, h, w, out),
4794        #[allow(unreachable_patterns)]
4795        _ => false,
4796    }
4797}