gemmkit 0.1.0

A clean, extensible, high-performance GEMM (general matrix multiply) engine
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
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
//! Property-based tests for the safe public GEMM API: oracle accuracy, run-to-run
//! determinism, serial == parallel, the `beta == 0` overwrite, broadcast inputs, batched
//! GEMM, and the documented panic guarantees. Never mutates a tuning knob or env var; see
//! `props_common` for the shared strategies and accuracy bars
#![cfg(all(not(miri), not(target_family = "wasm")))]

// Shared proptest strategies, oracle references, and accuracy gates
mod props_common;

use gemmkit::{MatMut, MatRef, Parallelism, Workspace, gemm, gemm_batched, gemm_with};
use props_common::*;
use proptest::prelude::*;
use std::panic::AssertUnwindSafe;

// P1/P2/P3/P5: random oracle, checking run-to-run bit determinism plus Frobenius error against
// the f64 reference

#[allow(clippy::too_many_arguments)]
fn oracle_float<T: Elem>(
    m: usize,
    k: usize,
    n: usize,
    la: PLayout,
    lb: PLayout,
    lc: PLayout,
    al: f64,
    be: f64,
    p: Parallelism,
    seed: u64,
) {
    let a = Mat::<T>::rand(m, k, seed);
    let b = Mat::<T>::rand(k, n, seed ^ 0xB000);
    let c0 = Mat::<T>::rand(m, n, seed ^ 0xC000);
    let (abuf, rsa, csa) = build_view(&a, la);
    let (bbuf, rsb, csb) = build_view(&b, lb);
    let (cbase, rsc, csc) = build_view(&c0, lc);
    let (alpha, beta) = (T::from_f64(al), T::from_f64(be));
    let cref = reference(&a, &b, &c0, al, be);

    let mut c1 = cbase.clone();
    let mut c2 = cbase.clone();
    gemm(
        alpha,
        MatRef::new(&abuf, m, k, rsa, csa),
        MatRef::new(&bbuf, k, n, rsb, csb),
        beta,
        MatMut::new(&mut c1, m, n, rsc, csc),
        p,
    );
    gemm(
        alpha,
        MatRef::new(&abuf, m, k, rsa, csa),
        MatRef::new(&bbuf, k, n, rsb, csb),
        beta,
        MatMut::new(&mut c2, m, n, rsc, csc),
        p,
    );
    assert!(
        bits_identical(&c1, &c2),
        "run-to-run non-determinism {m}x{k}x{n} par={p:?}"
    );
    let ctx = format!("oracle {m}x{k}x{n} a={al} b={be} par={p:?}");
    assert_accurate(
        &c1,
        rsc,
        csc,
        m,
        n,
        &cref,
        &a,
        &b,
        k,
        be.abs() * frob_norm(&c0),
        &ctx,
    );
}

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(160), ..ProptestConfig::default() })]

    #[test]
    fn prop_oracle_f32(
        m in dim(), k in kdim_pos(), n in dim(),
        la in layout(), lb in layout(), lc in layout(),
        al in coeff(), be in coeff(), p in par(), seed in any::<u64>(),
    ) {
        oracle_float::<f32>(m, k, n, la, lb, lc, al, be, p, seed);
    }

    #[test]
    fn prop_oracle_f64(
        m in dim(), k in kdim_pos(), n in dim(),
        la in layout(), lb in layout(), lc in layout(),
        al in coeff(), be in coeff(), p in par(), seed in any::<u64>(),
    ) {
        oracle_float::<f64>(m, k, n, la, lb, lc, al, be, p, seed);
    }
}

#[cfg(feature = "half")]
proptest! {
    #![proptest_config(ProptestConfig { cases: cases(80), ..ProptestConfig::default() })]

    #[test]
    fn prop_oracle_f16(
        m in dim(), k in kdim_pos(), n in dim(),
        la in layout(), lb in layout(), lc in layout(),
        al in coeff(), be in coeff(), p in par(), seed in any::<u64>(),
    ) {
        oracle_float::<gemmkit::f16>(m, k, n, la, lb, lc, al, be, p, seed);
    }

    #[test]
    fn prop_oracle_bf16(
        m in dim(), k in kdim_pos(), n in dim(),
        la in layout(), lb in layout(), lc in layout(),
        al in coeff(), be in coeff(), p in par(), seed in any::<u64>(),
    ) {
        oracle_float::<gemmkit::bf16>(m, k, n, la, lb, lc, al, be, p, seed);
    }
}

// P4: full-range i8 -> i32, checked exactly against the wrapping-i32 reference

#[cfg(feature = "int8")]
fn fill_i32(n: usize, seed: u64) -> Vec<i32> {
    let mut s = seed | 1;
    (0..n)
        .map(|_| {
            s ^= s << 13;
            s ^= s >> 7;
            s ^= s << 17;
            (s >> 24) as i32
        })
        .collect()
}

#[cfg(feature = "int8")]
fn i8_coeff() -> impl Strategy<Value = i32> {
    proptest::sample::select(&[0i32, 1, -1, 3, -2, 100_000][..])
}

#[cfg(feature = "int8")]
fn i8_par() -> impl Strategy<Value = Parallelism> {
    proptest::sample::select(&[Parallelism::Serial, Parallelism::Rayon(0)][..])
}

#[cfg(feature = "int8")]
proptest! {
    #![proptest_config(ProptestConfig { cases: cases(112), ..ProptestConfig::default() })]

    #[test]
    fn prop_oracle_i8(
        m in dim(), k in kdim(), n in dim(),
        la in layout(), lb in layout(), lc in layout(),
        alpha in i8_coeff(), beta in i8_coeff(), p in i8_par(), seed in any::<u64>(),
    ) {
        let a = fill_i8(m * k, seed);
        let b = fill_i8(k * n, seed ^ 0xB);
        let c0 = fill_i32(m * n, seed ^ 0xC);
        let cref = ref_i8_wrapping(&a, &b, &c0, m, k, n, alpha, beta);

        let (abuf, rsa, csa) = build_view_rowmajor(&a, m, k, 0i8, la);
        let (bbuf, rsb, csb) = build_view_rowmajor(&b, k, n, 0i8, lb);
        let (mut cbuf, rsc, csc) = build_view_rowmajor(&c0, m, n, 0i32, lc);

        gemmkit::gemm_i8(
            alpha,
            MatRef::new(&abuf, m, k, rsa, csa),
            MatRef::new(&bbuf, k, n, rsb, csb),
            beta,
            MatMut::new(&mut cbuf, m, n, rsc, csc),
            p,
        );
        for i in 0..m {
            for j in 0..n {
                let got = cbuf[(i as isize * rsc + j as isize * csc) as usize];
                prop_assert_eq!(
                    got, cref[i * n + j],
                    "i8 mismatch at ({},{}) {}x{}x{} a={} b={}", i, j, m, k, n, alpha, beta
                );
            }
        }
    }
}

// P5: complex (c32/c64), with conj(A)/conj(B) variants, checking run-to-run bit determinism plus
// Frobenius error at the 16*k*eps complex tolerance

#[cfg(feature = "complex")]
#[allow(clippy::too_many_arguments)]
fn oracle_cplx<T: CElem>(
    m: usize,
    k: usize,
    n: usize,
    ca: bool,
    cb: bool,
    ar: f64,
    ai: f64,
    br: f64,
    bi: f64,
    p: Parallelism,
    seed: u64,
) {
    let (alpha, beta) = (T::of(ar, ai), T::of(br, bi));
    let a = rand_cplx::<T>(m * k, seed);
    let b = rand_cplx::<T>(k * n, seed ^ 0xB);
    let c0 = rand_cplx::<T>(m * n, seed ^ 0xC);
    let cref = ref_cplx(&a, &b, &c0, m, k, n, alpha, beta, ca, cb);

    let mut c1 = c0.clone();
    let mut c2 = c0.clone();
    gemmkit::gemm_cplx(
        alpha,
        MatRef::from_col_major(&a, m, k),
        ca,
        MatRef::from_col_major(&b, k, n),
        cb,
        beta,
        MatMut::from_col_major(&mut c1, m, n),
        p,
    );
    gemmkit::gemm_cplx(
        alpha,
        MatRef::from_col_major(&a, m, k),
        ca,
        MatRef::from_col_major(&b, k, n),
        cb,
        beta,
        MatMut::from_col_major(&mut c2, m, n),
        p,
    );
    assert!(
        cplx_bits_identical(&c1, &c2),
        "cplx run-to-run non-determinism {m}x{k}x{n} ca={ca} cb={cb} par={p:?}"
    );
    assert_cplx_accurate(&c1, m, n, &cref, k, &format!("cplx oracle {m}x{k}x{n}"));
}

#[cfg(feature = "complex")]
proptest! {
    #![proptest_config(ProptestConfig { cases: cases(80), ..ProptestConfig::default() })]

    #[test]
    fn prop_oracle_c32(
        m in dim(), k in kdim_pos(), n in dim(),
        ca in any::<bool>(), cb in any::<bool>(),
        ar in coeff(), ai in coeff(), br in coeff(), bi in coeff(),
        p in par(), seed in any::<u64>(),
    ) {
        oracle_cplx::<gemmkit::c32>(m, k, n, ca, cb, ar, ai, br, bi, p, seed);
    }

    #[test]
    fn prop_oracle_c64(
        m in dim(), k in kdim_pos(), n in dim(),
        ca in any::<bool>(), cb in any::<bool>(),
        ar in coeff(), ai in coeff(), br in coeff(), bi in coeff(),
        p in par(), seed in any::<u64>(),
    ) {
        oracle_cplx::<gemmkit::c64>(m, k, n, ca, cb, ar, ai, br, bi, p, seed);
    }
}

// P6: serial == parallel, bit-identical (dims weighted large so Rayon actually splits the work)

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(48), ..ProptestConfig::default() })]

    // Float addition is not associative, so this bit-identity holds only because every thread
    // count currently reduces in the same order, an implementation property rather than a
    // promised contract (see the same caveat on parallel_equals_serial_mixed in
    // tests/correctness/mixed.rs). Kept as the strongest net against an accidental
    // reduction-order regression; relax to determinism + tolerance if blocking ever becomes
    // parallelism-dependent (e.g. split-K)
    #[test]
    fn prop_serial_equals_parallel(
        m in 48usize..=200, n in 48usize..=200, k in 32usize..=160,
        t in proptest::sample::select(&[2usize, 4, 8][..]),
        al in coeff(), be in coeff(), seed in any::<u64>(),
    ) {
        let a = Mat::<f32>::rand(m, k, seed);
        let b = Mat::<f32>::rand(k, n, seed ^ 0xB);
        let c0 = Mat::<f32>::rand(m, n, seed ^ 0xC);
        let (abuf, rsa, csa) = build_view(&a, PLayout::Col { pad: 0 });
        let (bbuf, rsb, csb) = build_view(&b, PLayout::Col { pad: 0 });
        let (cbase, rsc, csc) = build_view(&c0, PLayout::Col { pad: 0 });
        let (alpha, beta) = (al as f32, be as f32);

        let mut c_ser = cbase.clone();
        gemm(
            alpha,
            MatRef::new(&abuf, m, k, rsa, csa),
            MatRef::new(&bbuf, k, n, rsb, csb),
            beta,
            MatMut::new(&mut c_ser, m, n, rsc, csc),
            Parallelism::Serial,
        );
        let mut c_par = cbase.clone();
        gemm(
            alpha,
            MatRef::new(&abuf, m, k, rsa, csa),
            MatRef::new(&bbuf, k, n, rsb, csb),
            beta,
            MatMut::new(&mut c_par, m, n, rsc, csc),
            Parallelism::Rayon(t),
        );
        prop_assert!(
            bits_identical(&c_ser, &c_par),
            "serial != parallel({}) for {}x{}x{}", t, m, k, n
        );
    }
}

// P7: beta == 0 must overwrite C, never read it (a NaN-seeded C proves it)

fn beta_zero_overwrites<T: Elem>(
    m: usize,
    k: usize,
    n: usize,
    la: PLayout,
    lc: PLayout,
    al: f64,
    seed: u64,
) {
    let a = Mat::<T>::rand(m, k, seed);
    let b = Mat::<T>::rand(k, n, seed ^ 0xB);
    // Reference C0 is zeroed (beta = 0 means it contributes nothing), mirroring
    // beta_zero_does_not_read_c in tests/correctness/float.rs
    let zero_c0 = Mat {
        v: vec![T::from_f64(0.0); m * n],
        rows: m,
        cols: n,
    };
    let cref = reference(&a, &b, &zero_c0, al, 0.0);
    let (abuf, rsa, csa) = build_view(&a, la);
    let (bbuf, rsb, csb) = build_view(&b, PLayout::Col { pad: 0 });
    // The actual C is seeded all-NaN, in whichever layout `lc` picks: if gemm ever read it,
    // the NaN would propagate into the output and fail assert_accurate's finiteness check
    let nan = Mat {
        v: vec![T::from_f64(f64::NAN); m * n],
        rows: m,
        cols: n,
    };
    let (mut cbuf, rsc, csc) = build_view(&nan, lc);
    gemm(
        T::from_f64(al),
        MatRef::new(&abuf, m, k, rsa, csa),
        MatRef::new(&bbuf, k, n, rsb, csb),
        T::from_f64(0.0),
        MatMut::new(&mut cbuf, m, n, rsc, csc),
        Parallelism::Serial,
    );
    assert_accurate(&cbuf, rsc, csc, m, n, &cref, &a, &b, k, 0.0, "beta=0 NaN C");
}

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(64), ..ProptestConfig::default() })]

    #[test]
    fn prop_beta_zero_overwrites_f32(
        m in dim(), k in kdim(), n in dim(),
        la in layout(), lc in layout(), al in coeff(), seed in any::<u64>(),
    ) {
        beta_zero_overwrites::<f32>(m, k, n, la, lc, al, seed);
    }

    #[test]
    fn prop_beta_zero_overwrites_f64(
        m in dim(), k in kdim(), n in dim(),
        la in layout(), lc in layout(), al in coeff(), seed in any::<u64>(),
    ) {
        beta_zero_overwrites::<f64>(m, k, n, la, lc, al, seed);
    }
}

#[cfg(feature = "half")]
proptest! {
    #![proptest_config(ProptestConfig { cases: cases(48), ..ProptestConfig::default() })]

    #[test]
    fn prop_beta_zero_overwrites_f16(
        m in dim(), k in kdim(), n in dim(),
        la in layout(), lc in layout(), al in coeff(), seed in any::<u64>(),
    ) {
        beta_zero_overwrites::<gemmkit::f16>(m, k, n, la, lc, al, seed);
    }

    #[test]
    fn prop_beta_zero_overwrites_bf16(
        m in dim(), k in kdim(), n in dim(),
        la in layout(), lc in layout(), al in coeff(), seed in any::<u64>(),
    ) {
        beta_zero_overwrites::<gemmkit::bf16>(m, k, n, la, lc, al, seed);
    }
}

// P8: batched GEMM reproduces a loop of single gemm(Serial) calls, bit-identical

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(96), ..ProptestConfig::default() })]

    #[test]
    fn prop_batched_matches_loop(
        batch in 0usize..=4,
        m in 1usize..=48, k in 0usize..=48, n in 1usize..=48,
        a_pad in 0usize..=7, b_pad in 0usize..=7, c_pad in 0usize..=7,
        broadcast in proptest::sample::select(&[0u8, 1, 2][..]), // 0=none, 1=A, 2=B
        al in coeff(), be in coeff(),
        p in proptest::sample::select(&[Parallelism::Serial, Parallelism::Rayon(0)][..]),
        seed in any::<u64>(),
    ) {
        let (alpha, beta) = (al as f32, be as f32);
        // Column-major element extents
        let (ea, eb, ec) = (m * k, k * n, m * n);
        // A batch stride of 0 broadcasts a single A across the batch, likewise for B; gemm_batched
        // allows this for either read-only operand, but never for C
        let (a_bs, b_bs) = match broadcast {
            1 => (0isize, (eb + b_pad) as isize),
            2 => ((ea + a_pad) as isize, 0isize),
            _ => ((ea + a_pad) as isize, (eb + b_pad) as isize),
        };
        let c_bs = (ec + c_pad) as isize; // must clear the element extent so C stays disjoint
        let a_slots = if a_bs == 0 { 1 } else { batch };
        let b_slots = if b_bs == 0 { 1 } else { batch };
        let a = rand_vec::<f32>(a_slots.max(1) * (ea + a_pad), seed);
        let b = rand_vec::<f32>(b_slots.max(1) * (eb + b_pad), seed ^ 0xB);
        let c0 = rand_vec::<f32>(batch.max(1) * (ec + c_pad), seed ^ 0xC);

        let a_at = |bi: usize| (bi as isize * a_bs) as usize;
        let b_at = |bi: usize| (bi as isize * b_bs) as usize;
        let c_at = |bi: usize| (bi as isize * c_bs) as usize;

        // Reference: an independent single gemm(Serial) per element, on that element's own window
        let mut c_ref = c0.clone();
        for bi in 0..batch {
            let (ao, bo, co) = (a_at(bi), b_at(bi), c_at(bi));
            gemm(
                alpha,
                MatRef::from_col_major(&a[ao..ao + ea], m, k),
                MatRef::from_col_major(&b[bo..bo + eb], k, n),
                beta,
                MatMut::from_col_major(&mut c_ref[co..co + ec], m, n),
                Parallelism::Serial,
            );
        }

        let mut c_bat = c0.clone();
        gemm_batched(
            batch,
            alpha,
            MatRef::new(&a, m, k, 1, m as isize),
            a_bs,
            MatRef::new(&b, k, n, 1, k as isize),
            b_bs,
            beta,
            MatMut::new(&mut c_bat, m, n, 1, m as isize),
            c_bs,
            p,
        );
        prop_assert!(
            bits_identical(&c_ref, &c_bat),
            "batched != gemm() loop batch={} {}x{}x{} bcast={} par={:?}", batch, m, k, n, broadcast, p
        );
    }
}

// P9: broadcast inputs (rs = 0 on A, or cs = 0 on B) drive the full pipeline

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(64), ..ProptestConfig::default() })]

    #[test]
    fn prop_broadcast_inputs(
        m in dim(), k in kdim_pos(), n in dim(),
        which in any::<bool>(), lc in layout(), al in coeff(), be in coeff(),
        p in par(), seed in any::<u64>(),
    ) {
        // The reference gets the fully materialized (broadcast) operand, but gemm itself gets a
        // compact buffer with a zero stride: legal for a read-only A or B, never for C
        let c0 = Mat::<f32>::rand(m, n, seed ^ 0xC);
        let (cbase, rsc, csc) = build_view(&c0, lc);
        let (alpha, beta) = (al as f32, be as f32);

        let (a, b, abuf, rsa, csa, bbuf, rsb, csb) = if which {
            // Broadcast A: every row is the same k-length `base`, driven with rs = 0
            let base = rand_vec::<f32>(k, seed);
            let full_a = Mat { v: (0..m).flat_map(|_| base.clone()).collect(), rows: m, cols: k };
            let b = Mat::<f32>::rand(k, n, seed ^ 0xB);
            let (bbuf, rsb, csb) = build_view(&b, PLayout::Col { pad: 0 });
            (full_a, b, base, 0isize, 1isize, bbuf, rsb, csb)
        } else {
            // Broadcast B: every column is the same k-length `base`, driven with cs = 0
            let a = Mat::<f32>::rand(m, k, seed);
            let base = rand_vec::<f32>(k, seed ^ 0xB);
            let full_b = Mat { v: (0..k).flat_map(|p2| core::iter::repeat_n(base[p2], n)).collect(), rows: k, cols: n };
            let (abuf, rsa, csa) = build_view(&a, PLayout::Col { pad: 0 });
            (a, full_b, abuf, rsa, csa, base, 1isize, 0isize)
        };

        let cref = reference(&a, &b, &c0, al, be);
        let mut cbuf = cbase.clone();
        gemm(
            alpha,
            MatRef::new(&abuf, m, k, rsa, csa),
            MatRef::new(&bbuf, k, n, rsb, csb),
            beta,
            MatMut::new(&mut cbuf, m, n, rsc, csc),
            p,
        );
        assert_accurate(&cbuf, rsc, csc, m, n, &cref, &a, &b, k, be.abs() * frob_norm(&c0), "broadcast");
    }
}

// P11: cross-library oracle, gemmkit vs the `gemm` crate (column-major, beta = 0, serial)

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(64), ..ProptestConfig::default() })]

    #[test]
    fn prop_matches_gemm_crate(
        m in 1usize..=64, k in 1usize..=64, n in 1usize..=64, seed in any::<u64>(),
    ) {
        let a = Mat::<f32>::rand(m, k, seed);
        let b = Mat::<f32>::rand(k, n, seed ^ 0xB);
        // Column-major buffers, the gemm crate's orientation; beta = 0 so it never reads c_gemm
        let (abuf, _, _) = build_view(&a, PLayout::Col { pad: 0 });
        let (bbuf, _, _) = build_view(&b, PLayout::Col { pad: 0 });
        let mut c_kit = vec![0.0f32; m * n];
        let mut c_gemm = vec![0.0f32; m * n];
        gemm(
            1.0f32,
            MatRef::from_col_major(&abuf, m, k),
            MatRef::from_col_major(&bbuf, k, n),
            0.0f32,
            MatMut::from_col_major(&mut c_kit, m, n),
            Parallelism::Serial,
        );
        // SAFETY: abuf/bbuf/c_gemm are distinct, in-bounds column-major buffers, and
        // read_dst=false means c_gemm need not be initialized
        unsafe {
            gemm::gemm(
                m, n, k,
                c_gemm.as_mut_ptr(), m as isize, 1, false,
                abuf.as_ptr(), m as isize, 1,
                bbuf.as_ptr(), k as isize, 1,
                0.0f32, 1.0f32, false, false, false,
                gemm::Parallelism::None,
            );
        }
        // Reindex the gemm crate's column-major output into a row-major f64 reference
        let mut cref = vec![0.0f64; m * n];
        for i in 0..m {
            for j in 0..n {
                cref[i * n + j] = c_gemm[i + j * m] as f64;
            }
        }
        assert_accurate(&c_kit, 1, m as isize, m, n, &cref, &a, &b, k, 0.0, "vs gemm crate");
    }
}

// P10: safe-API panic guarantees, adversarially. Each class below must panic with its
// documented message, checked via catch_unwind + downcast rather than std::panic::set_hook,
// which is process-global and would race the other tests running concurrently in this binary

/// The panic payload's message, or `None` if `f` returned normally. `AssertUnwindSafe` because
/// the `&mut` C buffers `f` closes over are not themselves `UnwindSafe`
fn catch_msg<F: FnOnce()>(f: F) -> Option<String> {
    match std::panic::catch_unwind(AssertUnwindSafe(f)) {
        Ok(()) => None,
        Err(e) => Some(
            e.downcast_ref::<&str>()
                .map(|s| s.to_string())
                .or_else(|| e.downcast_ref::<String>().cloned())
                .unwrap_or_default(),
        ),
    }
}

fn assert_panics_with<F: FnOnce()>(f: F, needle: &str, ctx: &str) {
    match catch_msg(f) {
        None => panic!("{ctx}: expected a panic containing {needle:?}, but the call returned"),
        Some(msg) => assert!(
            msg.contains(needle),
            "{ctx}: panic message {msg:?} does not contain {needle:?}"
        ),
    }
}

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(48), ..ProptestConfig::default() })]

    // Shape mismatch: A.cols != B.rows
    #[test]
    fn prop_panic_shape_mismatch(m in 1usize..=8, k in 1usize..=8, n in 1usize..=8, d in 1usize..=4) {
        let a = vec![0.0f32; m * k];
        let b = vec![0.0f32; (k + d) * n]; // B.rows = k + d != A.cols = k
        let mut c = vec![0.0f32; m * n];
        assert_panics_with(
            || gemm(
                1.0,
                MatRef::from_row_major(&a, m, k),
                MatRef::from_row_major(&b, k + d, n),
                0.0,
                MatMut::from_row_major(&mut c, m, n),
                Parallelism::Serial,
            ),
            "B.rows",
            "shape mismatch",
        );
    }

    // A's slice is too small for the m x k row-major view it claims
    #[test]
    fn prop_panic_undersized(m in 2usize..=8, k in 2usize..=8, n in 1usize..=8, short in 1usize..=3) {
        let full = m * k;
        let a = vec![0.0f32; full.saturating_sub(short).max(1)];
        let b = vec![0.0f32; k * n];
        let mut c = vec![0.0f32; m * n];
        assert_panics_with(
            || gemm(
                1.0,
                MatRef::new(&a, m, k, k as isize, 1),
                MatRef::from_row_major(&b, k, n),
                0.0,
                MatMut::from_row_major(&mut c, m, n),
                Parallelism::Serial,
            ),
            "needs",
            "undersized A",
        );
    }

    // rsc = 0 collapses every distinct C row onto the same memory: self-aliasing
    #[test]
    fn prop_panic_self_aliasing_c(m in 2usize..=8, k in 1usize..=8, n in 2usize..=8, p in par()) {
        let a = vec![0.0f32; m * k];
        let b = vec![0.0f32; k * n];
        let mut c = vec![0.0f32; n]; // only 1 row's worth of backing
        assert_panics_with(
            || gemm(
                1.0,
                MatRef::from_row_major(&a, m, k),
                MatRef::from_row_major(&b, k, n),
                0.0,
                MatMut::new(&mut c, m, n, 0, 1),
                p,
            ),
            "aliases itself",
            "self-aliasing C",
        );
    }

    // A negative stride on a safe view is never allowed (use the unchecked API instead)
    #[test]
    fn prop_panic_negative_stride(m in 2usize..=8, k in 2usize..=8, n in 1usize..=8) {
        let a = vec![0.0f32; m * k];
        let b = vec![0.0f32; k * n];
        let mut c = vec![0.0f32; m * n];
        assert_panics_with(
            || gemm(
                1.0,
                MatRef::new(&a, m, k, -(k as isize), 1), // negative rs
                MatRef::from_row_major(&b, k, n),
                0.0,
                MatMut::from_row_major(&mut c, m, n),
                Parallelism::Serial,
            ),
            "negative strides or is too large",
            "negative stride",
        );
    }

    // Extent overflow at the addressing boundary: when (rows-1)*rs overflows isize, extent()
    // returns None and the view panics "too large to address"; when it fits but the resulting
    // need exceeds the 1-element slice, it panics "needs" instead. Both branches are reachable
    // here (small rows with a huge rs hits "needs"; large rows hits "too large"), and the
    // generator below works out which one a given (rows, rs_pow) pair lands on
    #[test]
    fn prop_panic_extent_overflow(
        rows in proptest::sample::select(&[2usize, 3, (1usize << (isize::BITS / 2 + 1)) + 1][..]),
        rs_pow in (isize::BITS / 2)..=(isize::BITS / 2 + 2),
    ) {
        let rs = 1isize << rs_pow;
        let a = vec![0.0f32; 1];
        let b = vec![0.0f32; 1];
        let mut c = vec![0.0f32; 1];
        // Mirrors extent(): (rows-1)*rs overflowing isize is what selects the "too large" branch
        let overflows = isize::try_from(rows)
            .ok()
            .and_then(|r| r.checked_sub(1))
            .and_then(|r| r.checked_mul(rs))
            .is_none();
        let needle = if overflows { "too large to address" } else { "needs" };
        assert_panics_with(
            || gemm(
                1.0,
                MatRef::new(&a, rows, 1, rs, 1),
                MatRef::from_row_major(&b, 1, 1),
                0.0,
                MatMut::new(&mut c, rows, 1, rs, 1),
                Parallelism::Serial,
            ),
            needle,
            "extent overflow",
        );
    }
}

// Batched-validation panics: the adversarial sibling of P10, for gemm_batched

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(48), ..ProptestConfig::default() })]

    // check_batched_view rejects a negative batch stride outright
    #[test]
    fn prop_batched_panic_negative_batch_stride(batch in 2usize..=4, m in 1usize..=6, k in 1usize..=6, n in 1usize..=6) {
        let a = rand_vec::<f32>(batch * m * k, 1);
        let b = rand_vec::<f32>(batch * k * n, 2);
        let mut c = rand_vec::<f32>(batch * m * n, 3);
        assert_panics_with(
            || gemm_batched(
                batch, 1.0,
                MatRef::new(&a, m, k, 1, m as isize), -((m * k) as isize),
                MatRef::new(&b, k, n, 1, k as isize), (k * n) as isize,
                0.0,
                MatMut::new(&mut c, m, n, 1, m as isize), (m * n) as isize,
                Parallelism::Serial,
            ),
            "non-negative",
            "batched negative batch stride",
        );
    }

    // C batch stride set below the element extent, so consecutive elements would overlap
    #[test]
    fn prop_batched_panic_overlapping_c(batch in 2usize..=4, m in 2usize..=6, n in 2usize..=6, deficit in 1usize..=3) {
        let a = rand_vec::<f32>(batch * m * m, 1);
        let b = rand_vec::<f32>(batch * m * n, 2);
        let mut c = vec![0.0f32; batch * m * n];
        let bad = (m * n).saturating_sub(deficit).max(1) as isize;
        assert_panics_with(
            || gemm_batched(
                batch, 1.0,
                MatRef::new(&a, m, m, 1, m as isize), (m * m) as isize,
                MatRef::new(&b, m, n, 1, m as isize), (m * n) as isize,
                0.0,
                MatMut::new(&mut c, m, n, 1, m as isize), bad, // below the element extent m*n
                Parallelism::Serial,
            ),
            "stay disjoint",
            "batched overlapping C",
        );
    }

    // Per-element A.cols != B.rows
    #[test]
    fn prop_batched_panic_shape_mismatch(batch in 1usize..=4, m in 1usize..=6, k in 1usize..=6, n in 1usize..=6, d in 1usize..=3) {
        let a = rand_vec::<f32>(batch * m * k, 1);
        let b = rand_vec::<f32>(batch * (k + d) * n, 2);
        let mut c = rand_vec::<f32>(batch * m * n, 3);
        assert_panics_with(
            || gemm_batched(
                batch, 1.0,
                MatRef::new(&a, m, k, 1, m as isize), (m * k) as isize,
                MatRef::new(&b, k + d, n, 1, (k + d) as isize), ((k + d) * n) as isize,
                0.0,
                MatMut::new(&mut c, m, n, 1, m as isize), (m * n) as isize,
                Parallelism::Serial,
            ),
            "!= B.rows",
            "batched shape mismatch",
        );
    }
}

// A sequence of random-shaped gemm_with() calls threaded through 1 grown-only Workspace, each
// step checked bit-for-bit against a fresh pool-allocating gemm() on the same inputs

proptest! {
    #![proptest_config(ProptestConfig { cases: cases(48), ..ProptestConfig::default() })]

    #[test]
    fn prop_workspace_reuse_stateful(
        ops in prop::collection::vec(
            (dim(), kdim(), dim(), layout(), coeff(), coeff(), par(), any::<u64>()),
            1..=6,
        ),
    ) {
        let mut ws = Workspace::new();
        for (i, (m, k, n, lc, al, be, p, seed)) in ops.into_iter().enumerate() {
            let a = Mat::<f32>::rand(m, k, seed);
            let b = Mat::<f32>::rand(k, n, seed ^ 0xB);
            let c0 = Mat::<f32>::rand(m, n, seed ^ 0xC);
            let (abuf, rsa, csa) = build_view(&a, PLayout::Col { pad: 0 });
            let (bbuf, rsb, csb) = build_view(&b, PLayout::Col { pad: 0 });
            let (cbase, rsc, csc) = build_view(&c0, lc);
            let (alpha, beta) = (al as f32, be as f32);

            let mut c_pool = cbase.clone();
            gemm(
                alpha,
                MatRef::new(&abuf, m, k, rsa, csa),
                MatRef::new(&bbuf, k, n, rsb, csb),
                beta,
                MatMut::new(&mut c_pool, m, n, rsc, csc),
                p,
            );
            let mut c_ws = cbase.clone();
            gemm_with(
                &mut ws,
                alpha,
                MatRef::new(&abuf, m, k, rsa, csa),
                MatRef::new(&bbuf, k, n, rsb, csb),
                beta,
                MatMut::new(&mut c_ws, m, n, rsc, csc),
                p,
            );
            prop_assert!(
                bits_identical(&c_pool, &c_ws),
                "workspace-reuse step {} diverged {}x{}x{}", i, m, k, n
            );
        }
    }
}

/// Regression: on the mixed-precision (f16/bf16) path the depth panel spans the whole `k`, and a
/// broadcast (zero-stride) operand passes shape/bounds validation regardless of how large `k`
/// logically is. Pack sizing must therefore fail closed rather than silently wrap into an
/// undersized workspace that the pack then writes past. `k = isize::MAX` overflows the pack
/// element-count product for every tile geometry, so the "too large" guard fires on every ISA;
/// the narrower band where the element count fits `usize` but the element-to-byte conversion
/// overflows is covered tile-independently by the `workspace::region_bytes` unit tests instead,
/// since an end-to-end `k` landing in that band is tile-size-dependent (a smaller tile would just
/// request a huge-but-representable allocation: a safe OOM abort, not this checked panic)
#[cfg(feature = "half")]
#[test]
fn mixed_huge_k_fails_closed() {
    use gemmkit::{bf16, f16};

    let huge = isize::MAX as usize;
    {
        let a = vec![f16::from_f32(1.0); 100];
        let b = vec![f16::from_f32(1.0); 100];
        let mut c = vec![f16::from_f32(0.0); 100 * 100];
        assert_panics_with(
            || {
                gemm(
                    f16::from_f32(1.0),
                    MatRef::new(&a, 100, huge, 1, 0),
                    MatRef::new(&b, huge, 100, 0, 1),
                    f16::from_f32(0.0),
                    MatMut::from_row_major(&mut c, 100, 100),
                    Parallelism::Serial,
                )
            },
            "too large",
            "f16 huge-k",
        );

        let a = vec![bf16::from_f32(1.0); 100];
        let b = vec![bf16::from_f32(1.0); 100];
        let mut c = vec![bf16::from_f32(0.0); 100 * 100];
        assert_panics_with(
            || {
                gemm(
                    bf16::from_f32(1.0),
                    MatRef::new(&a, 100, huge, 1, 0),
                    MatRef::new(&b, huge, 100, 0, 1),
                    bf16::from_f32(0.0),
                    MatMut::from_row_major(&mut c, 100, 100),
                    Parallelism::Serial,
                )
            },
            "too large",
            "bf16 huge-k",
        );
    }
}