onnx-runtime-ep-cpu 0.1.0-dev.4

CPU execution provider for the ORT 2.0 runtime
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
//! `com.microsoft::LinearAttention` — gated delta-rule linear attention
//! (Gated DeltaNet, as used by Qwen3-Next / Qwen3.5) with a per-head recurrent
//! state matrix.
//!
//! Faithful CPU port of ONNX Runtime's contrib kernel
//! (`contrib_ops/cpu/bert/linear_attention.cc`), verified to fp32 epsilon
//! against ORT 1.26 (see `tests/qwen35_ort_parity.rs`).
//!
//! ## Contract
//!
//! Inputs (packed, channels-last):
//!
//! * `query` — `[B, T, H_q · d_k]` (already L2-normalized and scaled by the
//!   producer for Qwen3.5).
//! * `key` — `[B, T, n_k · d_k]` (already L2-normalized).
//! * `value` — `[B, T, H_kv · d_v]`.
//! * `past_state` — optional `[B, H_kv, d_k, d_v]`; zeros when absent.
//! * `decay` — optional log-decay gate `g`, `[B, T, H_kv]` (per head) or
//!   `[B, T, H_kv · d_k]` (per key dim). The step decay is `exp(g)`.
//! * `beta` — optional gate, `[B, T, H_kv]` (per head) or `[B, T, 1]`.
//!
//! Outputs:
//!
//! * `output` — `[B, T, max(H_q, H_kv) · d_v]`.
//! * `present_state` — `[B, H_kv, d_k, d_v]`.
//!
//! `update_rule` selects which gates participate:
//!
//! | rule          | decay | delta (retrieval + beta) |
//! |---------------|:-----:|:------------------------:|
//! | `linear`      |   —   |            —             |
//! | `gated`       |   ✓   |            —             |
//! | `delta`       |   —   |            ✓             |
//! | `gated_delta` |   ✓   |            ✓             |
//!
//! Per timestep `t`, per kv-head `h` (state `S` is `[d_k, d_v]`, row-major
//! `S[i·d_v + j]`):
//!
//! ```text
//! decay:      S        *= exp(g_t)                       (gated / gated_delta)
//! retrieval:  r[j]      = Σ_i S[i, j] · k_t[i]           (delta / gated_delta)
//! delta:      d[j]      = beta_t · (v_t[j] − r[j])
//!             S[i, j]  += k_t[i] · d[j]
//! linear:     S[i, j]  += k_t[i] · v_t[j]                (linear / gated)
//! readout:    o_t[j]    = scale · Σ_i q_t[i] · S[i, j]   (uses the updated S)
//! ```
//!
//! `scale` defaults to `1 / sqrt(d_k)` when the attribute is `0`. GQA is
//! supported in both directions: when `H_q ≥ H_kv` several query heads share a
//! kv state (`heads_per_group = H_q / H_kv`); when `H_q < H_kv` (inverse GQA)
//! several kv states map to one query head. `n_k` (key head count) may be
//! smaller than `H_kv`, in which case several kv heads share a key head.
//!
//! Compute is in `f32` (ORT's CPU kernel is `float`-only); `f16`/`bf16` inputs
//! are widened and outputs narrowed so the kernel stays dtype-parameterized
//! (RULES.md §2) without changing the arithmetic.

use onnx_runtime_ep_api::{EpError, Kernel, KernelFactory, Result, TensorMut, TensorView};
use onnx_runtime_ir::Node;

use super::check_arity;
use crate::dtype::{
    output_direct_write_eligible, slice_byte_range, to_dense_f32_widen, write_dense_f32_narrow,
};

#[derive(Clone, Copy, PartialEq, Eq)]
enum UpdateRule {
    Linear,
    Gated,
    Delta,
    GatedDelta,
}

impl UpdateRule {
    fn needs_decay(self) -> bool {
        matches!(self, UpdateRule::Gated | UpdateRule::GatedDelta)
    }
    fn needs_delta(self) -> bool {
        matches!(self, UpdateRule::Delta | UpdateRule::GatedDelta)
    }
}

pub struct LinearAttentionKernel {
    q_num_heads: usize,
    kv_num_heads: usize,
    update_rule: UpdateRule,
    /// `None` => resolve to `1 / sqrt(d_k)` at execute time.
    scale: Option<f32>,
}

pub struct LinearAttentionFactory;

impl KernelFactory for LinearAttentionFactory {
    fn create(&self, node: &Node, _input_shapes: &[Vec<usize>]) -> Result<Box<dyn Kernel>> {
        let read_heads = |name: &str| -> Result<usize> {
            node.attr(name)
                .and_then(|a| a.as_int())
                .and_then(|v| usize::try_from(v).ok())
                .filter(|&v| v > 0)
                .ok_or_else(|| {
                    EpError::KernelFailed(format!(
                        "LinearAttention: `{name}` must be a positive integer"
                    ))
                })
        };
        let q_num_heads = read_heads("q_num_heads")?;
        let kv_num_heads = read_heads("kv_num_heads")?;

        let update_rule = match node.attr("update_rule").and_then(|a| a.as_str()) {
            Some("linear") => UpdateRule::Linear,
            Some("gated") => UpdateRule::Gated,
            Some("delta") => UpdateRule::Delta,
            None | Some("gated_delta") => UpdateRule::GatedDelta,
            Some(other) => {
                return Err(EpError::KernelFailed(format!(
                    "LinearAttention: update_rule must be one of linear, gated, delta, \
                     gated_delta; got {other:?}"
                )));
            }
        };

        // ORT resolves a `0` (or missing) scale attribute to `1 / sqrt(d_k)`.
        let scale = match node.attr("scale").and_then(|a| a.as_float()) {
            Some(s) if s != 0.0 => Some(s),
            _ => None,
        };

        Ok(Box::new(LinearAttentionKernel {
            q_num_heads,
            kv_num_heads,
            update_rule,
            scale,
        }))
    }
}

impl Kernel for LinearAttentionKernel {
    fn execute(&self, inputs: &[TensorView], outputs: &mut [TensorMut]) -> Result<()> {
        // query, key, value required; past_state, decay, beta optional.
        check_arity("LinearAttention", inputs, outputs, 3, 6, 1)?;

        let q_shape = inputs[0].shape;
        let k_shape = inputs[1].shape;
        let v_shape = inputs[2].shape;
        if q_shape.len() != 3 || k_shape.len() != 3 || v_shape.len() != 3 {
            return Err(EpError::KernelFailed(format!(
                "LinearAttention: query/key/value must be rank 3 [B, T, H·D], got {q_shape:?}, \
                 {k_shape:?}, {v_shape:?}"
            )));
        }
        let (batch, seq, q_hidden) = (q_shape[0], q_shape[1], q_shape[2]);
        if k_shape[0] != batch || v_shape[0] != batch || k_shape[1] != seq || v_shape[1] != seq {
            return Err(EpError::KernelFailed(format!(
                "LinearAttention: query/key/value batch and sequence dims must agree; got \
                 {q_shape:?}, {k_shape:?}, {v_shape:?}"
            )));
        }

        let q_num_heads = self.q_num_heads;
        let kv_num_heads = self.kv_num_heads;
        if !q_hidden.is_multiple_of(q_num_heads) {
            return Err(EpError::KernelFailed(format!(
                "LinearAttention: query hidden {q_hidden} not divisible by q_num_heads {q_num_heads}"
            )));
        }
        let d_k = q_hidden / q_num_heads;
        if d_k == 0 || !k_shape[2].is_multiple_of(d_k) {
            return Err(EpError::KernelFailed(format!(
                "LinearAttention: key hidden {} not divisible by d_k {d_k}",
                k_shape[2]
            )));
        }
        let n_k_heads = k_shape[2] / d_k;
        if !v_shape[2].is_multiple_of(kv_num_heads) {
            return Err(EpError::KernelFailed(format!(
                "LinearAttention: value hidden {} not divisible by kv_num_heads {kv_num_heads}",
                v_shape[2]
            )));
        }
        let d_v = v_shape[2] / kv_num_heads;

        // Head mapping (mirrors ORT). Standard GQA: H_q >= H_kv. Inverse GQA:
        // H_q < H_kv (heads_per_group = 0 signals the inverse mapping).
        let heads_per_group = if q_num_heads >= kv_num_heads {
            if !q_num_heads.is_multiple_of(kv_num_heads) {
                return Err(EpError::KernelFailed(format!(
                    "LinearAttention: q_num_heads {q_num_heads} must be a multiple of kv_num_heads \
                     {kv_num_heads}"
                )));
            }
            q_num_heads / kv_num_heads
        } else {
            if !kv_num_heads.is_multiple_of(q_num_heads) {
                return Err(EpError::KernelFailed(format!(
                    "LinearAttention: kv_num_heads {kv_num_heads} must be a multiple of \
                     q_num_heads {q_num_heads} (inverse GQA)"
                )));
            }
            0
        };
        if !kv_num_heads.is_multiple_of(n_k_heads) {
            return Err(EpError::KernelFailed(format!(
                "LinearAttention: kv_num_heads {kv_num_heads} must be a multiple of n_k_heads \
                 {n_k_heads}"
            )));
        }
        let kv_per_k_head = kv_num_heads / n_k_heads;

        let scale = self.scale.unwrap_or_else(|| 1.0 / (d_k as f32).sqrt());

        let needs_decay = self.update_rule.needs_decay();
        let needs_delta = self.update_rule.needs_delta();

        // Resolve optional inputs. ONNX omits trailing optionals by shortening
        // the input list; the model always supplies all six.
        let past_state = inputs.get(3);
        let decay = inputs.get(4);
        let beta = inputs.get(5);

        if needs_decay && decay.is_none() {
            return Err(EpError::KernelFailed(
                "LinearAttention: decay input is required for update_rule=gated/gated_delta".into(),
            ));
        }
        if needs_delta && beta.is_none() {
            return Err(EpError::KernelFailed(
                "LinearAttention: beta input is required for update_rule=delta/gated_delta".into(),
            ));
        }

        // decay layout: per-head (last dim H_kv) or per-key-dim (H_kv · d_k).
        let (decay_data, decay_per_key_dim) = match decay {
            Some(view) if needs_decay => {
                let s = view.shape;
                if s.len() != 3 || s[0] != batch || s[1] != seq {
                    return Err(EpError::KernelFailed(format!(
                        "LinearAttention: decay must be [B={batch}, T={seq}, ...], got {s:?}"
                    )));
                }
                let per_key = if s[2] == kv_num_heads * d_k {
                    true
                } else if s[2] == kv_num_heads {
                    false
                } else {
                    return Err(EpError::KernelFailed(format!(
                        "LinearAttention: decay last dim must be H_kv={kv_num_heads} or \
                         H_kv·d_k={}, got {}",
                        kv_num_heads * d_k,
                        s[2]
                    )));
                };
                (Some(to_dense_f32_widen("LinearAttention", view)?), per_key)
            }
            _ => (None, false),
        };

        // beta layout: per-head (last dim H_kv) or shared (last dim 1).
        let (beta_data, beta_per_head) = match beta {
            Some(view) if needs_delta => {
                let s = view.shape;
                if s.len() != 3 || s[0] != batch || s[1] != seq {
                    return Err(EpError::KernelFailed(format!(
                        "LinearAttention: beta must be [B={batch}, T={seq}, ...], got {s:?}"
                    )));
                }
                let per_head = if s[2] == kv_num_heads {
                    true
                } else if s[2] == 1 {
                    false
                } else {
                    return Err(EpError::KernelFailed(format!(
                        "LinearAttention: beta last dim must be H_kv={kv_num_heads} or 1, got {}",
                        s[2]
                    )));
                };
                (Some(to_dense_f32_widen("LinearAttention", view)?), per_head)
            }
            _ => (None, false),
        };

        let q = to_dense_f32_widen("LinearAttention", &inputs[0])?;
        let k = to_dense_f32_widen("LinearAttention", &inputs[1])?;
        let v = to_dense_f32_widen("LinearAttention", &inputs[2])?;

        let state_per_head = d_k * d_v;
        let total_state = batch * kv_num_heads * state_per_head;
        let state_init = if let Some(view) = past_state {
            let s = view.shape;
            if s.len() != 4 || s[0] != batch || s[1] != kv_num_heads || s[2] != d_k || s[3] != d_v {
                return Err(EpError::KernelFailed(format!(
                    "LinearAttention: past_state must be [B={batch}, H_kv={kv_num_heads}, \
                     d_k={d_k}, d_v={d_v}], got {s:?}"
                )));
            }
            Some(to_dense_f32_widen("LinearAttention", view)?)
        } else {
            None
        };

        let output_hidden = q_num_heads.max(kv_num_heads) * d_v;
        let (primary_output, present_outputs) = outputs.split_at_mut(1);
        let output_len = batch * seq * output_hidden;

        // In-place-aliasing guard (see `dtype::output_direct_write_eligible`):
        // the present state and the primary output are written directly into
        // their executor buffers, but a persistent DeviceIoBinding may bind an
        // input (q/k/v/decay/beta/past_state) onto either one. `readout` reads q
        // and the live state while writing each output row, every timestep reads
        // k/v/decay/beta, and copying past_state into a present buffer that
        // aliases it is copy-`nonoverlapping` UB. So take a direct path only when
        // the target byte range is disjoint from every widened input; otherwise
        // compute into an owned buffer and copy out at the end. A `Cow::Owned`
        // widen is a fresh buffer that never overlaps.
        let input_ranges: Vec<_> = [
            Some(&*q),
            Some(&*k),
            Some(&*v),
            decay_data.as_deref(),
            beta_data.as_deref(),
            state_init.as_deref(),
        ]
        .into_iter()
        .flatten()
        .map(slice_byte_range)
        .collect();

        // Working recurrent state. When the present output is a non-aliasing
        // native contiguous f32 buffer, use it directly and copy the past state
        // in once, avoiding a per-layer ~1 MiB allocation plus a second
        // full-state copy on Qwen3.5. If it would alias an input (e.g. an
        // in-place present==past_state binding), fall back to an owned buffer so
        // the copy and the in-place updates stay sound.
        let mut owned_state;
        let (state, state_is_direct): (&mut [f32], bool) =
            if present_outputs.first_mut().is_some_and(|present| {
                output_direct_write_eligible(present, total_state, &input_ranges)
            }) {
                let present = present_outputs.first_mut().unwrap();
                // SAFETY: the guard proved a host-accessible contiguous Float32
                // buffer of exactly `total_state` elements that does not alias any
                // input, so the copy below and the in-place updates cannot corrupt a
                // live input.
                let state = unsafe {
                    std::slice::from_raw_parts_mut(present.data_ptr_mut::<f32>(), total_state)
                };
                if let Some(initial) = state_init.as_deref() {
                    state.copy_from_slice(initial);
                } else {
                    state.fill(0.0);
                }
                (state, true)
            } else {
                owned_state = state_init
                    .map(|initial| initial.into_owned())
                    .unwrap_or_else(|| vec![0.0f32; total_state]);
                (&mut owned_state, false)
            };

        // The primary output must additionally not alias the working state,
        // which `readout` reads while each output row is written.
        let direct_output = {
            let mut ranges = input_ranges;
            ranges.push(slice_byte_range(state));
            output_direct_write_eligible(&mut primary_output[0], output_len, &ranges)
        };
        let mut owned_output;
        let output: &mut [f32] = if direct_output {
            // SAFETY: the guard proved a host-accessible contiguous Float32
            // buffer of exactly `output_len` elements disjoint from every input
            // and the working state.
            unsafe {
                std::slice::from_raw_parts_mut(primary_output[0].data_ptr_mut::<f32>(), output_len)
            }
        } else {
            owned_output = vec![0.0f32; output_len];
            &mut owned_output
        };

        let params = HeadParams {
            seq,
            d_k,
            d_v,
            q_num_heads,
            kv_num_heads,
            n_k_heads,
            heads_per_group,
            output_hidden,
            scale,
            needs_decay,
            decay_per_key_dim,
            needs_delta,
            beta_per_head,
        };

        let mut retrieved = vec![0.0f32; d_v];
        for b in 0..batch {
            for h_kv in 0..kv_num_heads {
                let h_k = h_kv / kv_per_k_head;
                let s_off = (b * kv_num_heads + h_kv) * state_per_head;
                process_head(
                    &mut state[s_off..s_off + state_per_head],
                    &q,
                    &k,
                    &v,
                    decay_data.as_deref(),
                    beta_data.as_deref(),
                    output,
                    &mut retrieved,
                    b,
                    h_kv,
                    h_k,
                    &params,
                );
            }
        }

        if !direct_output {
            write_dense_f32_narrow("LinearAttention", &mut primary_output[0], output)?;
        }
        if !state_is_direct && let Some(present) = present_outputs.first_mut() {
            write_dense_f32_narrow("LinearAttention", present, state)?;
        }
        Ok(())
    }
}

/// Immutable per-invocation dimensions/flags shared by every head task.
struct HeadParams {
    seq: usize,
    d_k: usize,
    d_v: usize,
    q_num_heads: usize,
    kv_num_heads: usize,
    n_k_heads: usize,
    heads_per_group: usize,
    output_hidden: usize,
    scale: f32,
    needs_decay: bool,
    decay_per_key_dim: bool,
    needs_delta: bool,
    beta_per_head: bool,
}

/// Process one `(batch, kv_head)` pair across all timesteps, updating `state`
/// in place and writing the corresponding query-head output rows. The step
/// order (decay → retrieval → delta/linear update → readout) matches ORT so the
/// arithmetic is bit-comparable.
#[allow(clippy::too_many_arguments)]
fn process_head(
    state: &mut [f32],
    q: &[f32],
    k: &[f32],
    v: &[f32],
    decay: Option<&[f32]>,
    beta: Option<&[f32]>,
    output: &mut [f32],
    retrieved: &mut [f32],
    batch_idx: usize,
    h_kv: usize,
    h_k: usize,
    p: &HeadParams,
) {
    let d_k = p.d_k;
    let d_v = p.d_v;
    debug_assert_eq!(retrieved.len(), d_v);

    for t in 0..p.seq {
        let row = batch_idx * p.seq + t;
        let kt = &k[row * (p.n_k_heads * d_k) + h_k * d_k..][..d_k];
        let vt = &v[row * (p.kv_num_heads * d_v) + h_kv * d_v..][..d_v];

        // ---- Step 1: decay S *= exp(g_t) ----
        if p.needs_decay {
            let decay = decay.expect("decay presence validated");
            if p.decay_per_key_dim {
                let gt = &decay[row * (p.kv_num_heads * d_k) + h_kv * d_k..][..d_k];
                for (i, &g) in gt.iter().enumerate() {
                    let exp_g = g.exp();
                    let s_row = &mut state[i * d_v..i * d_v + d_v];
                    for s in s_row.iter_mut() {
                        *s *= exp_g;
                    }
                }
            } else {
                let exp_g = decay[row * p.kv_num_heads + h_kv].exp();
                for s in state.iter_mut() {
                    *s *= exp_g;
                }
            }
        }

        if p.needs_delta {
            // ---- Step 2: retrieval r = Sáµ€ k_t (over d_k) ----
            retrieved.fill(0.0);
            for (i, &ki) in kt.iter().enumerate() {
                let s_row = &state[i * d_v..(i + 1) * d_v];
                for (r, &s) in retrieved.iter_mut().zip(s_row) {
                    *r += s * ki;
                }
            }
            // ---- Step 3: delta update  S += k_t ⊗ (beta·(v_t − r)) ----
            let bt = if p.beta_per_head {
                beta.expect("beta presence validated")[row * p.kv_num_heads + h_kv]
            } else {
                beta.expect("beta presence validated")[row]
            };
            for (r, &vv) in retrieved.iter_mut().zip(vt.iter()) {
                *r = bt * (vv - *r);
            }
            for i in 0..d_k {
                let ki = kt[i];
                let s_row = &mut state[i * d_v..i * d_v + d_v];
                for (s, &d) in s_row.iter_mut().zip(retrieved.iter()) {
                    *s += ki * d;
                }
            }
        } else {
            // ---- linear / gated: S += k_t ⊗ v_t ----
            for i in 0..d_k {
                let ki = kt[i];
                let s_row = &mut state[i * d_v..i * d_v + d_v];
                for (s, &vv) in s_row.iter_mut().zip(vt.iter()) {
                    *s += ki * vv;
                }
            }
        }

        // ---- Step 4: readout o_t = scale · q_tᵀ S (updated S) ----
        if p.heads_per_group > 0 {
            for g in 0..p.heads_per_group {
                let h_q = h_kv * p.heads_per_group + g;
                readout(q, output, state, row, h_q, h_kv, p);
            }
        } else {
            // Inverse GQA: this kv head's query head, output slot is h_kv.
            let h_q = h_kv * p.q_num_heads / p.kv_num_heads;
            readout(q, output, state, row, h_q, h_kv, p);
        }
    }
}

/// One query-head readout `o[j] = scale · Σ_i q[i]·S[i, j]`. `out_head` is the
/// output head slot: the query head for standard GQA, the kv head for inverse.
#[inline]
fn readout(
    q: &[f32],
    output: &mut [f32],
    state: &[f32],
    row: usize,
    h_q: usize,
    h_kv: usize,
    p: &HeadParams,
) {
    let d_k = p.d_k;
    let d_v = p.d_v;
    let out_head = if p.heads_per_group > 0 { h_q } else { h_kv };
    let qt = &q[row * (p.q_num_heads * d_k) + h_q * d_k..][..d_k];
    let ot = &mut output[row * p.output_hidden + out_head * d_v..][..d_v];
    ot.fill(0.0);
    for (i, &qi) in qt.iter().enumerate() {
        let s_row = &state[i * d_v..(i + 1) * d_v];
        for (o, &s) in ot.iter_mut().zip(s_row) {
            *o += qi * s;
        }
    }
    for o in ot {
        *o *= p.scale;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::kernels::testutil::Owned;
    use onnx_runtime_ir::{Attribute, Node, NodeId};

    fn kernel(h: i64, scale: f32) -> Box<dyn Kernel> {
        let mut node = Node::new(NodeId(0), "LinearAttention", vec![], vec![]);
        node.domain = "com.microsoft".to_string();
        node.attributes
            .insert("q_num_heads".to_string(), Attribute::Int(h));
        node.attributes
            .insert("kv_num_heads".to_string(), Attribute::Int(h));
        node.attributes.insert(
            "update_rule".to_string(),
            Attribute::String(b"gated_delta".to_vec()),
        );
        node.attributes
            .insert("scale".to_string(), Attribute::Float(scale));
        LinearAttentionFactory.create(&node, &[]).unwrap()
    }

    fn assert_close(got: &[f32], want: &[f32], tag: &str) {
        assert_eq!(got.len(), want.len(), "{tag} length");
        for (i, (&a, &b)) in got.iter().zip(want).enumerate() {
            let diff = (a - b).abs();
            let rel = diff / b.abs().max(1e-6);
            assert!(
                diff <= 1e-4 || rel <= 1e-3,
                "{tag}[{i}]: got {a}, want {b} (abs {diff}, rel {rel})"
            );
        }
    }

    /// Independent hand-computed single-step, single-head gated-delta reference.
    #[test]
    fn hand_computed_single_step_recurrence() {
        // d_k = d_v = 2, one head, one timestep. state = [[1,0],[0,1]].
        let q = Owned::f32(&[1, 1, 2], &[1.0, 2.0]);
        let k = Owned::f32(&[1, 1, 2], &[0.5, -0.5]);
        let v = Owned::f32(&[1, 1, 2], &[3.0, 4.0]);
        let st = Owned::f32(&[1, 1, 2, 2], &[1.0, 0.0, 0.0, 1.0]);
        let g_log = Owned::f32(&[1, 1, 1], &[-0.5]); // decay = exp(-0.5)
        let beta = Owned::f32(&[1, 1, 1], &[0.25]);
        let mut out = Owned::zeros_f32(&[1, 1, 2]);
        let mut present = Owned::zeros_f32(&[1, 1, 2, 2]);
        let ins = [
            q.view(),
            k.view(),
            v.view(),
            st.view(),
            g_log.view(),
            beta.view(),
        ];
        let mut outs = [out.view_mut(), present.view_mut()];
        kernel(1, 1.0).execute(&ins, &mut outs).unwrap();

        // Reference computed by hand:
        let decay = (-0.5f32).exp();
        // S after decay: [[decay,0],[0,decay]]
        let mut s = [[decay, 0.0f32], [0.0, decay]];
        let kk = [0.5f32, -0.5];
        let vv = [3.0f32, 4.0];
        // retrieval r[j] = sum_i S[i][j]*k[i]
        let r = [
            s[0][0] * kk[0] + s[1][0] * kk[1],
            s[0][1] * kk[0] + s[1][1] * kk[1],
        ];
        let bt = 0.25f32;
        let d = [bt * (vv[0] - r[0]), bt * (vv[1] - r[1])];
        for i in 0..2 {
            for j in 0..2 {
                s[i][j] += kk[i] * d[j];
            }
        }
        let qq = [1.0f32, 2.0];
        let o_ref = [
            qq[0] * s[0][0] + qq[1] * s[1][0],
            qq[0] * s[0][1] + qq[1] * s[1][1],
        ];
        let present_ref = [s[0][0], s[0][1], s[1][0], s[1][1]];
        assert_close(&out.to_f32(), &o_ref, "hand out");
        assert_close(&present.to_f32(), &present_ref, "hand present");
    }

    #[test]
    fn scale_zero_resolves_to_inv_sqrt_dk() {
        // scale attribute 0.0 -> 1/sqrt(d_k). Verify by comparing to explicit.
        let mut node = Node::new(NodeId(0), "LinearAttention", vec![], vec![]);
        node.domain = "com.microsoft".to_string();
        node.attributes
            .insert("q_num_heads".to_string(), Attribute::Int(1));
        node.attributes
            .insert("kv_num_heads".to_string(), Attribute::Int(1));
        node.attributes.insert(
            "update_rule".to_string(),
            Attribute::String(b"gated_delta".to_vec()),
        );
        node.attributes
            .insert("scale".to_string(), Attribute::Float(0.0));
        let k0 = LinearAttentionFactory.create(&node, &[]).unwrap();

        let q = Owned::f32(&[1, 1, 4], &[1.0, 2.0, 3.0, 4.0]);
        let k = Owned::f32(&[1, 1, 4], &[0.1, 0.2, 0.3, 0.4]);
        let v = Owned::f32(&[1, 1, 2], &[1.0, -1.0]);
        let st = Owned::f32(&[1, 1, 4, 2], &[0.0; 8]);
        let gd = Owned::f32(&[1, 1, 1], &[-0.1]);
        let bd = Owned::f32(&[1, 1, 1], &[0.5]);
        let mut o0 = Owned::zeros_f32(&[1, 1, 2]);
        let mut p0 = Owned::zeros_f32(&[1, 1, 4, 2]);
        let ins = [
            q.view(),
            k.view(),
            v.view(),
            st.view(),
            gd.view(),
            bd.view(),
        ];
        let mut outs = [o0.view_mut(), p0.view_mut()];
        k0.execute(&ins, &mut outs).unwrap();

        // Same with explicit scale = 1/sqrt(4) = 0.5.
        let mut oe = Owned::zeros_f32(&[1, 1, 2]);
        let mut pe = Owned::zeros_f32(&[1, 1, 4, 2]);
        let ins2 = [
            q.view(),
            k.view(),
            v.view(),
            st.view(),
            gd.view(),
            bd.view(),
        ];
        let mut outs2 = [oe.view_mut(), pe.view_mut()];
        kernel(1, 0.5).execute(&ins2, &mut outs2).unwrap();
        assert_close(&o0.to_f32(), &oe.to_f32(), "scale0 vs explicit");
    }

    #[test]
    fn rejects_missing_beta_for_gated_delta() {
        let k = kernel(1, 1.0);
        let q = Owned::f32(&[1, 1, 2], &[1.0, 2.0]);
        let kk = Owned::f32(&[1, 1, 2], &[0.5, -0.5]);
        let v = Owned::f32(&[1, 1, 2], &[3.0, 4.0]);
        let st = Owned::f32(&[1, 1, 2, 2], &[1.0, 0.0, 0.0, 1.0]);
        let gd = Owned::f32(&[1, 1, 1], &[-0.5]);
        let mut out = Owned::zeros_f32(&[1, 1, 2]);
        let mut present = Owned::zeros_f32(&[1, 1, 2, 2]);
        // Only 5 inputs -> beta missing.
        let ins = [q.view(), kk.view(), v.view(), st.view(), gd.view()];
        let mut outs = [out.view_mut(), present.view_mut()];
        assert!(k.execute(&ins, &mut outs).is_err());
    }

    /// Persistent DeviceIoBindings may alias an input buffer onto an output
    /// buffer. The direct-write decode path must stay correct when the primary
    /// output aliases `v` or when `present_state` aliases `past_state` (the
    /// latter would otherwise be copy-`nonoverlapping` UB). Both aliased runs
    /// must reproduce the disjoint-binding result (the owned-buffer fallback
    /// fires on the detected overlap).
    #[test]
    fn aliased_bindings_match_disjoint_result() {
        use onnx_runtime_ep_api::{DevicePtr, DevicePtrMut};
        use onnx_runtime_ir::{DataType, DeviceId, compute_contiguous_strides};

        // d_k = d_v = 2, one head, one decode step, non-zero incoming state.
        let q_vals = [1.0f32, 2.0];
        let k_vals = [0.5f32, -0.5];
        let v_vals = [3.0f32, 4.0];
        let st_vals = [1.0f32, 0.0, 0.0, 1.0];
        let g_vals = [-0.5f32];
        let beta_vals = [0.25f32];

        let owned_q = || Owned::f32(&[1, 1, 2], &q_vals);
        let owned_k = || Owned::f32(&[1, 1, 2], &k_vals);
        let owned_v = || Owned::f32(&[1, 1, 2], &v_vals);
        let owned_st = || Owned::f32(&[1, 1, 2, 2], &st_vals);
        let owned_g = || Owned::f32(&[1, 1, 1], &g_vals);
        let owned_beta = || Owned::f32(&[1, 1, 1], &beta_vals);

        // Disjoint reference.
        let (o_ref, present_ref) = {
            let (q, kk, v, st, gd, bd) = (
                owned_q(),
                owned_k(),
                owned_v(),
                owned_st(),
                owned_g(),
                owned_beta(),
            );
            let mut out = Owned::zeros_f32(&[1, 1, 2]);
            let mut present = Owned::zeros_f32(&[1, 1, 2, 2]);
            kernel(1, 1.0)
                .execute(
                    &[
                        q.view(),
                        kk.view(),
                        v.view(),
                        st.view(),
                        gd.view(),
                        bd.view(),
                    ],
                    &mut [out.view_mut(), present.view_mut()],
                )
                .unwrap();
            (out.to_f32(), present.to_f32())
        };

        let f32c = DataType::Float32;
        let cpu = DeviceId::cpu();

        // Alias 1: present_state output shares past_state input's buffer.
        {
            let mut shared_state = st_vals.to_vec();
            let state_ptr = shared_state.as_ptr() as *const std::ffi::c_void;
            let present_ptr = shared_state.as_mut_ptr() as *mut std::ffi::c_void;
            let sshape = [1usize, 1, 2, 2];
            let sstrides = compute_contiguous_strides(&sshape);
            let (q, kk, v, gd, bd) = (owned_q(), owned_k(), owned_v(), owned_g(), owned_beta());
            let mut out = Owned::zeros_f32(&[1, 1, 2]);
            let state_view = TensorView::new(DevicePtr(state_ptr), f32c, &sshape, &sstrides, cpu);
            let present_mut =
                TensorMut::new(DevicePtrMut(present_ptr), f32c, &sshape, &sstrides, cpu);
            kernel(1, 1.0)
                .execute(
                    &[
                        q.view(),
                        kk.view(),
                        v.view(),
                        state_view,
                        gd.view(),
                        bd.view(),
                    ],
                    &mut [out.view_mut(), present_mut],
                )
                .unwrap();
            assert_close(&out.to_f32(), &o_ref, "present-aliases-state out");
            assert_close(&shared_state, &present_ref, "present-aliases-state present");
        }

        // Alias 2: primary output shares v input's buffer (same [1,1,2] shape).
        {
            let mut shared_v = v_vals.to_vec();
            let v_ptr = shared_v.as_ptr() as *const std::ffi::c_void;
            let out_ptr = shared_v.as_mut_ptr() as *mut std::ffi::c_void;
            let vshape = [1usize, 1, 2];
            let vstrides = compute_contiguous_strides(&vshape);
            let (q, kk, st, gd, bd) = (owned_q(), owned_k(), owned_st(), owned_g(), owned_beta());
            let mut present = Owned::zeros_f32(&[1, 1, 2, 2]);
            let v_view = TensorView::new(DevicePtr(v_ptr), f32c, &vshape, &vstrides, cpu);
            let out_mut = TensorMut::new(DevicePtrMut(out_ptr), f32c, &vshape, &vstrides, cpu);
            kernel(1, 1.0)
                .execute(
                    &[q.view(), kk.view(), v_view, st.view(), gd.view(), bd.view()],
                    &mut [out_mut, present.view_mut()],
                )
                .unwrap();
            assert_close(&shared_v, &o_ref, "out-aliases-v out");
            assert_close(&present.to_f32(), &present_ref, "out-aliases-v present");
        }
    }
}