numr 0.5.2

High-performance numerical computing with multi-backend GPU acceleration (CPU/CUDA/WebGPU)
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
//! Cache-aware tiled matmul algorithm
//!
//! Implements BLIS-style 3-level blocking with:
//! - Thread-local packing buffers (no allocation on hot path)
//! - Beta=0/1 microkernel (no separate zero pass over output)
//! - Optimized pack_b with bulk copies for full NR blocks

use super::packing::{pack_a_f32, pack_a_f64, pack_b_f32, pack_b_f64};
use super::scalar::{microkernel_edge_f32, microkernel_edge_f64};
use super::{KC, MC, MR, NC};
use super::{
    call_microkernel_2x_f32, call_microkernel_2x_f64, call_microkernel_f32, call_microkernel_f64,
};
use crate::runtime::cpu::kernels::simd::SimdLevel;
use std::cell::RefCell;

// ---------------------------------------------------------------------------
// Thread-local packing buffers (avoids heap allocation on every matmul call)
// ---------------------------------------------------------------------------

thread_local! {
    static PACK_F32: RefCell<(Vec<f32>, Vec<f32>)> = const { RefCell::new((Vec::new(), Vec::new())) };
    static PACK_F64: RefCell<(Vec<f64>, Vec<f64>)> = const { RefCell::new((Vec::new(), Vec::new())) };
}

/// Ensure packing buffers have sufficient capacity, then call `f` with them.
fn with_pack_f32<R>(f: impl FnOnce(&mut [f32], &mut [f32]) -> R) -> R {
    PACK_F32.with(|cell| {
        let mut bufs = cell.borrow_mut();
        let a_need = MC * KC;
        let b_need = KC * NC;
        if bufs.0.len() < a_need {
            bufs.0.resize(a_need, 0.0);
        }
        if bufs.1.len() < b_need {
            bufs.1.resize(b_need, 0.0);
        }
        let (ref mut pack_a, ref mut pack_b) = *bufs;
        f(&mut pack_a[..a_need], &mut pack_b[..b_need])
    })
}

fn with_pack_f64<R>(f: impl FnOnce(&mut [f64], &mut [f64]) -> R) -> R {
    PACK_F64.with(|cell| {
        let mut bufs = cell.borrow_mut();
        let a_need = MC * KC;
        let b_need = KC * NC;
        if bufs.0.len() < a_need {
            bufs.0.resize(a_need, 0.0);
        }
        if bufs.1.len() < b_need {
            bufs.1.resize(b_need, 0.0);
        }
        let (ref mut pack_a, ref mut pack_b) = *bufs;
        f(&mut pack_a[..a_need], &mut pack_b[..b_need])
    })
}

// ---------------------------------------------------------------------------
// Public API
// ---------------------------------------------------------------------------

/// Tiled matmul: C = A @ B (f32)
///
/// No separate zero pass - microkernels use beta=0 on first K-block.
#[allow(clippy::too_many_arguments)]
pub unsafe fn matmul_tiled_f32<const NR: usize>(
    a: *const f32,
    b: *const f32,
    c: *mut f32,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
) {
    with_pack_f32(|packed_a, packed_b| {
        tiled_loop_f32::<NR>(a, b, c, m, n, k, lda, ldb, ldc, level, packed_a, packed_b);
    });
}

/// Tiled matmul with bias: C = A @ B + bias (f32)
#[allow(clippy::too_many_arguments)]
pub unsafe fn matmul_bias_tiled_f32<const NR: usize>(
    a: *const f32,
    b: *const f32,
    bias: *const f32,
    c: *mut f32,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
) {
    // Bias needs C pre-initialized before accumulation
    let bias_slice = std::slice::from_raw_parts(bias, n);
    for i in 0..m {
        let c_row = std::slice::from_raw_parts_mut(c.add(i * ldc), n);
        c_row.copy_from_slice(bias_slice);
    }

    with_pack_f32(|packed_a, packed_b| {
        // All K-blocks use beta=1 since C has bias values
        tiled_loop_f32_beta1::<NR>(a, b, c, m, n, k, lda, ldb, ldc, level, packed_a, packed_b);
    });
}

/// Tiled matmul: C = A @ B (f64)
#[allow(clippy::too_many_arguments)]
pub unsafe fn matmul_tiled_f64<const NR: usize>(
    a: *const f64,
    b: *const f64,
    c: *mut f64,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
) {
    with_pack_f64(|packed_a, packed_b| {
        tiled_loop_f64::<NR>(a, b, c, m, n, k, lda, ldb, ldc, level, packed_a, packed_b);
    });
}

/// Tiled matmul with bias: C = A @ B + bias (f64)
#[allow(clippy::too_many_arguments)]
pub unsafe fn matmul_bias_tiled_f64<const NR: usize>(
    a: *const f64,
    b: *const f64,
    bias: *const f64,
    c: *mut f64,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
) {
    let bias_slice = std::slice::from_raw_parts(bias, n);
    for i in 0..m {
        let c_row = std::slice::from_raw_parts_mut(c.add(i * ldc), n);
        c_row.copy_from_slice(bias_slice);
    }

    with_pack_f64(|packed_a, packed_b| {
        tiled_loop_f64_beta1::<NR>(a, b, c, m, n, k, lda, ldb, ldc, level, packed_a, packed_b);
    });
}

// ---------------------------------------------------------------------------
// Core tiled loops
// ---------------------------------------------------------------------------

/// Core tiled loop for f32 with beta=0 on first K-block
#[allow(clippy::too_many_arguments)]
unsafe fn tiled_loop_f32<const NR: usize>(
    a: *const f32,
    b: *const f32,
    c: *mut f32,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
    packed_a: &mut [f32],
    packed_b: &mut [f32],
) {
    for jc in (0..n).step_by(NC) {
        let nc = (n - jc).min(NC);

        for pc in (0..k).step_by(KC) {
            let kc = (k - pc).min(KC);
            let first_k = pc == 0;

            pack_b_f32::<NR>(b.add(pc * ldb + jc), packed_b.as_mut_ptr(), nc, kc, ldb);

            for ic in (0..m).step_by(MC) {
                let mc = (m - ic).min(MC);

                pack_a_f32(a.add(ic * lda + pc), packed_a.as_mut_ptr(), mc, kc, lda);

                microkernel_loop_f32::<NR>(
                    packed_a, packed_b, c, ic, jc, mc, nc, kc, ldc, level, first_k,
                );
            }
        }
    }
}

/// Core tiled loop for f32 always using beta=1 (for bias variant)
#[allow(clippy::too_many_arguments)]
unsafe fn tiled_loop_f32_beta1<const NR: usize>(
    a: *const f32,
    b: *const f32,
    c: *mut f32,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
    packed_a: &mut [f32],
    packed_b: &mut [f32],
) {
    for jc in (0..n).step_by(NC) {
        let nc = (n - jc).min(NC);

        for pc in (0..k).step_by(KC) {
            let kc = (k - pc).min(KC);

            pack_b_f32::<NR>(b.add(pc * ldb + jc), packed_b.as_mut_ptr(), nc, kc, ldb);

            for ic in (0..m).step_by(MC) {
                let mc = (m - ic).min(MC);

                pack_a_f32(a.add(ic * lda + pc), packed_a.as_mut_ptr(), mc, kc, lda);

                microkernel_loop_f32::<NR>(
                    packed_a, packed_b, c, ic, jc, mc, nc, kc, ldc, level, false,
                );
            }
        }
    }
}

/// Inner microkernel dispatch loop for f32
///
/// NR is the double-width (e.g. 32 for AVX-512). Uses the 2x microkernel for
/// full blocks and falls back to single-width or edge for remainders.
///
#[allow(clippy::too_many_arguments)]
#[inline]
unsafe fn microkernel_loop_f32<const NR: usize>(
    packed_a: &[f32],
    packed_b: &[f32],
    c: *mut f32,
    ic: usize,
    jc: usize,
    mc: usize,
    nc: usize,
    kc: usize,
    ldc: usize,
    level: SimdLevel,
    first_k: bool,
) {
    let nr_half = NR / 2;

    for jr in (0..nc).step_by(NR) {
        let nr_actual = (nc - jr).min(NR);

        for ir in (0..mc).step_by(MR) {
            let mr_actual = (mc - ir).min(MR);

            if mr_actual == MR && nr_actual == NR {
                call_microkernel_2x_f32(
                    packed_a.as_ptr().add(ir * kc),
                    packed_b.as_ptr().add(jr * kc),
                    c.add((ic + ir) * ldc + jc + jr),
                    kc,
                    ldc,
                    level,
                    first_k,
                );
            } else if mr_actual == MR && nr_actual == nr_half {
                // Half block
                call_microkernel_f32(
                    packed_a.as_ptr().add(ir * kc),
                    packed_b.as_ptr().add(jr * kc),
                    c.add((ic + ir) * ldc + jc + jr),
                    kc,
                    ldc,
                    level,
                    first_k,
                );
            } else {
                microkernel_edge_f32(
                    packed_a.as_ptr().add(ir * kc),
                    packed_b.as_ptr().add(jr * kc),
                    c.add((ic + ir) * ldc + jc + jr),
                    mr_actual,
                    nr_actual,
                    kc,
                    ldc,
                    first_k,
                );
            }
        }
    }
}

/// Core tiled loop for f64 with beta=0 on first K-block
#[allow(clippy::too_many_arguments)]
unsafe fn tiled_loop_f64<const NR: usize>(
    a: *const f64,
    b: *const f64,
    c: *mut f64,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
    packed_a: &mut [f64],
    packed_b: &mut [f64],
) {
    for jc in (0..n).step_by(NC) {
        let nc = (n - jc).min(NC);

        for pc in (0..k).step_by(KC) {
            let kc = (k - pc).min(KC);
            let first_k = pc == 0;

            pack_b_f64::<NR>(b.add(pc * ldb + jc), packed_b.as_mut_ptr(), nc, kc, ldb);

            for ic in (0..m).step_by(MC) {
                let mc = (m - ic).min(MC);

                pack_a_f64(a.add(ic * lda + pc), packed_a.as_mut_ptr(), mc, kc, lda);

                microkernel_loop_f64::<NR>(
                    packed_a, packed_b, c, ic, jc, mc, nc, kc, ldc, level, first_k,
                );
            }
        }
    }
}

/// Core tiled loop for f64 always using beta=1 (for bias variant)
#[allow(clippy::too_many_arguments)]
unsafe fn tiled_loop_f64_beta1<const NR: usize>(
    a: *const f64,
    b: *const f64,
    c: *mut f64,
    m: usize,
    n: usize,
    k: usize,
    lda: usize,
    ldb: usize,
    ldc: usize,
    level: SimdLevel,
    packed_a: &mut [f64],
    packed_b: &mut [f64],
) {
    for jc in (0..n).step_by(NC) {
        let nc = (n - jc).min(NC);

        for pc in (0..k).step_by(KC) {
            let kc = (k - pc).min(KC);

            pack_b_f64::<NR>(b.add(pc * ldb + jc), packed_b.as_mut_ptr(), nc, kc, ldb);

            for ic in (0..m).step_by(MC) {
                let mc = (m - ic).min(MC);

                pack_a_f64(a.add(ic * lda + pc), packed_a.as_mut_ptr(), mc, kc, lda);

                microkernel_loop_f64::<NR>(
                    packed_a, packed_b, c, ic, jc, mc, nc, kc, ldc, level, false,
                );
            }
        }
    }
}

/// Inner microkernel dispatch loop for f64
#[allow(clippy::too_many_arguments)]
#[inline]
unsafe fn microkernel_loop_f64<const NR: usize>(
    packed_a: &[f64],
    packed_b: &[f64],
    c: *mut f64,
    ic: usize,
    jc: usize,
    mc: usize,
    nc: usize,
    kc: usize,
    ldc: usize,
    level: SimdLevel,
    first_k: bool,
) {
    let nr_half = NR / 2;

    for jr in (0..nc).step_by(NR) {
        let nr_actual = (nc - jr).min(NR);

        for ir in (0..mc).step_by(MR) {
            let mr_actual = (mc - ir).min(MR);

            if mr_actual == MR && nr_actual == NR {
                call_microkernel_2x_f64(
                    packed_a.as_ptr().add(ir * kc),
                    packed_b.as_ptr().add(jr * kc),
                    c.add((ic + ir) * ldc + jc + jr),
                    kc,
                    ldc,
                    level,
                    first_k,
                );
            } else if mr_actual == MR && nr_actual == nr_half {
                call_microkernel_f64(
                    packed_a.as_ptr().add(ir * kc),
                    packed_b.as_ptr().add(jr * kc),
                    c.add((ic + ir) * ldc + jc + jr),
                    kc,
                    ldc,
                    level,
                    first_k,
                );
            } else {
                microkernel_edge_f64(
                    packed_a.as_ptr().add(ir * kc),
                    packed_b.as_ptr().add(jr * kc),
                    c.add((ic + ir) * ldc + jc + jr),
                    mr_actual,
                    nr_actual,
                    kc,
                    ldc,
                    first_k,
                );
            }
        }
    }
}