xnn 0.2.0

A lightweight ML framework with GPU-first architecture
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
//! Matrix multiplication kernel.

use core::any::TypeId;
use core::marker::PhantomData;

use alloc::string::String;
use alloc::vec::Vec;
use alloc::{format, vec};

use bytemuck::{Pod, Zeroable};

use crate::element::FloatElement;
use crate::kernel::{Kernel, MAX_WORKGROUPS};
use crate::{Buffer, Context};

/// Maximum batch dimensions supported.
const MAX_BATCH_RANK: usize = 6;

/// Block size for register tiling (each thread computes BM×BN elements).
const BLOCK_SIZE: u32 = 4;

/// Workgroup dimensions.
const WG_SIZE: u32 = 16;

/// Output tile size (`WG_SIZE * BLOCK_SIZE`).
const TILE_SIZE: u32 = WG_SIZE * BLOCK_SIZE;

/// K-dimension tile size.
const TILE_K: u32 = 16;

/// Padded tile sizes to avoid shared memory bank conflicts.
const TILE_SIZE_PAD: u32 = TILE_SIZE + 1;
const TILE_K_PAD: u32 = TILE_K + 1;

/// Matmul parameters passed to shader as uniform.
#[repr(C)]
#[derive(Debug, Clone, Copy, Pod, Zeroable)]
struct Params {
    m: u32,
    k: u32,
    n: u32,
    batch_size: u32,
    batch_rank: u32,
    transpose_a: u32,
    transpose_b: u32,
    _pad: u32,
    batch_dims: [[u32; 4]; 2],
    a_batch_strides: [[u32; 4]; 2],
    b_batch_strides: [[u32; 4]; 2],
    a_matrix_stride: u32,
    b_matrix_stride: u32,
    c_matrix_stride: u32,
    _pad2: u32,
}

/// Batched matrix multiplication kernel: `C = A × B`.
pub(crate) struct Matmul<T>(PhantomData<T>);

impl<T: FloatElement> Kernel for Matmul<T> {
    const LABEL: &'static str = "matmul";
    type Output = T;

    #[allow(clippy::too_many_lines)]
    fn wgsl() -> String {
        let ty = T::wgsl_type();
        let as_size = TILE_SIZE * TILE_K_PAD;
        let bs_size = TILE_K * TILE_SIZE_PAD;

        format!(
            r"
                const TILE: u32 = {TILE_SIZE}u;
                const TILE_K: u32 = {TILE_K}u;
                const TILE_PAD: u32 = {TILE_SIZE_PAD}u;
                const TILE_K_PAD: u32 = {TILE_K_PAD}u;
                const WG: u32 = {WG_SIZE}u;
                const BLK: u32 = {BLOCK_SIZE}u;
                const MAX_BATCH: u32 = {MAX_BATCH_RANK}u;

                struct Params {{
                    m: u32,
                    k: u32,
                    n: u32,
                    batch_size: u32,
                    batch_rank: u32,
                    transpose_a: u32,
                    transpose_b: u32,
                    _pad: u32,
                    batch_dims: array<vec4<u32>, 2>,
                    a_batch_strides: array<vec4<u32>, 2>,
                    b_batch_strides: array<vec4<u32>, 2>,
                    a_matrix_stride: u32,
                    b_matrix_stride: u32,
                    c_matrix_stride: u32,
                    _pad2: u32,
                }}

                @group(0) @binding(0) var<storage, read> a: array<{ty}>;
                @group(0) @binding(1) var<storage, read> b: array<{ty}>;
                @group(0) @binding(2) var<storage, read_write> c: array<{ty}>;
                @group(0) @binding(3) var<uniform> params: Params;

                var<workgroup> As: array<{ty}, {as_size}>;
                var<workgroup> Bs: array<{ty}, {bs_size}>;

                fn get_batch_dim(idx: u32) -> u32 {{
                    return params.batch_dims[idx / 4u][idx % 4u];
                }}

                fn get_a_batch_stride(idx: u32) -> u32 {{
                    return params.a_batch_strides[idx / 4u][idx % 4u];
                }}

                fn get_b_batch_stride(idx: u32) -> u32 {{
                    return params.b_batch_strides[idx / 4u][idx % 4u];
                }}

                fn compute_batch_offset(batch_idx: u32, is_a: bool) -> u32 {{
                    var offset = 0u;
                    var remaining = batch_idx;

                    for (var i = 0u; i < params.batch_rank; i++) {{
                        var prod = 1u;
                        for (var j = i + 1u; j < params.batch_rank; j++) {{
                            prod *= get_batch_dim(j);
                        }}
                        let coord = remaining / prod;
                        remaining = remaining % prod;

                        if is_a {{
                            offset += coord * get_a_batch_stride(i);
                        }} else {{
                            offset += coord * get_b_batch_stride(i);
                        }}
                    }}

                    return offset;
                }}

                @compute @workgroup_size({WG_SIZE}, {WG_SIZE})
                fn main(
                    @builtin(local_invocation_id) lid: vec3<u32>,
                    @builtin(workgroup_id) wid: vec3<u32>
                ) {{
                    let M = params.m;
                    let K = params.k;
                    let N = params.n;

                    let batch_idx = wid.z;
                    if batch_idx >= params.batch_size {{
                        return;
                    }}

                    let a_batch_offset = compute_batch_offset(batch_idx, true) * params.a_matrix_stride;
                    let b_batch_offset = compute_batch_offset(batch_idx, false) * params.b_matrix_stride;
                    let c_batch_offset = batch_idx * params.c_matrix_stride;

                    let lr = lid.x;
                    let lc = lid.y;
                    let thread_id = lr * WG + lc;

                    let tile_row = wid.x * TILE;
                    let tile_col = wid.y * TILE;
                    let c_row = tile_row + lr * BLK;
                    let c_col = tile_col + lc * BLK;

                    var acc00: {ty} = 0.0; var acc01: {ty} = 0.0; var acc02: {ty} = 0.0; var acc03: {ty} = 0.0;
                    var acc10: {ty} = 0.0; var acc11: {ty} = 0.0; var acc12: {ty} = 0.0; var acc13: {ty} = 0.0;
                    var acc20: {ty} = 0.0; var acc21: {ty} = 0.0; var acc22: {ty} = 0.0; var acc23: {ty} = 0.0;
                    var acc30: {ty} = 0.0; var acc31: {ty} = 0.0; var acc32: {ty} = 0.0; var acc33: {ty} = 0.0;

                    let num_k_tiles = (K + TILE_K - 1u) / TILE_K;

                    let a_rows = select(M, K, params.transpose_a != 0u);
                    let a_cols = select(K, M, params.transpose_a != 0u);
                    let b_rows = select(K, N, params.transpose_b != 0u);
                    let b_cols = select(N, K, params.transpose_b != 0u);

                    for (var kt: u32 = 0u; kt < num_k_tiles; kt++) {{
                        let k_start = kt * TILE_K;

                        for (var i: u32 = 0u; i < 4u; i++) {{
                            let a_idx = thread_id * 4u + i;
                            let local_row = a_idx / TILE_K;
                            let local_kcol = a_idx % TILE_K;

                            let g_row = tile_row + local_row;
                            let g_kcol = k_start + local_kcol;

                            var val: {ty} = 0.0;
                            if g_row < M && g_kcol < K {{
                                let orig_row = select(g_row, g_kcol, params.transpose_a != 0u);
                                let orig_col = select(g_kcol, g_row, params.transpose_a != 0u);
                                val = a[a_batch_offset + orig_row * a_cols + orig_col];
                            }}
                            As[local_row * TILE_K_PAD + local_kcol] = val;
                        }}

                        for (var i: u32 = 0u; i < 4u; i++) {{
                            let b_idx = thread_id * 4u + i;
                            let local_krow = b_idx / TILE;
                            let local_col = b_idx % TILE;

                            let g_krow = k_start + local_krow;
                            let g_col = tile_col + local_col;

                            var val: {ty} = 0.0;
                            if g_krow < K && g_col < N {{
                                let orig_row = select(g_krow, g_col, params.transpose_b != 0u);
                                let orig_col = select(g_col, g_krow, params.transpose_b != 0u);
                                val = b[b_batch_offset + orig_row * b_cols + orig_col];
                            }}
                            Bs[local_krow * TILE_PAD + local_col] = val;
                        }}

                        workgroupBarrier();

                        for (var kk: u32 = 0u; kk < TILE_K; kk++) {{
                            let a0 = As[(lr * BLK) * TILE_K_PAD + kk];
                            let a1 = As[(lr * BLK + 1u) * TILE_K_PAD + kk];
                            let a2 = As[(lr * BLK + 2u) * TILE_K_PAD + kk];
                            let a3 = As[(lr * BLK + 3u) * TILE_K_PAD + kk];
                            let b0 = Bs[kk * TILE_PAD + lc * BLK];
                            let b1 = Bs[kk * TILE_PAD + lc * BLK + 1u];
                            let b2 = Bs[kk * TILE_PAD + lc * BLK + 2u];
                            let b3 = Bs[kk * TILE_PAD + lc * BLK + 3u];

                            acc00 += a0 * b0; acc01 += a0 * b1; acc02 += a0 * b2; acc03 += a0 * b3;
                            acc10 += a1 * b0; acc11 += a1 * b1; acc12 += a1 * b2; acc13 += a1 * b3;
                            acc20 += a2 * b0; acc21 += a2 * b1; acc22 += a2 * b2; acc23 += a2 * b3;
                            acc30 += a3 * b0; acc31 += a3 * b1; acc32 += a3 * b2; acc33 += a3 * b3;
                        }}

                        workgroupBarrier();
                    }}

                    if c_row < M && c_col < N {{ c[c_batch_offset + c_row * N + c_col] = acc00; }}
                    if c_row < M && c_col + 1u < N {{ c[c_batch_offset + c_row * N + c_col + 1u] = acc01; }}
                    if c_row < M && c_col + 2u < N {{ c[c_batch_offset + c_row * N + c_col + 2u] = acc02; }}
                    if c_row < M && c_col + 3u < N {{ c[c_batch_offset + c_row * N + c_col + 3u] = acc03; }}

                    if c_row + 1u < M && c_col < N {{ c[c_batch_offset + (c_row + 1u) * N + c_col] = acc10; }}
                    if c_row + 1u < M && c_col + 1u < N {{ c[c_batch_offset + (c_row + 1u) * N + c_col + 1u] = acc11; }}
                    if c_row + 1u < M && c_col + 2u < N {{ c[c_batch_offset + (c_row + 1u) * N + c_col + 2u] = acc12; }}
                    if c_row + 1u < M && c_col + 3u < N {{ c[c_batch_offset + (c_row + 1u) * N + c_col + 3u] = acc13; }}

                    if c_row + 2u < M && c_col < N {{ c[c_batch_offset + (c_row + 2u) * N + c_col] = acc20; }}
                    if c_row + 2u < M && c_col + 1u < N {{ c[c_batch_offset + (c_row + 2u) * N + c_col + 1u] = acc21; }}
                    if c_row + 2u < M && c_col + 2u < N {{ c[c_batch_offset + (c_row + 2u) * N + c_col + 2u] = acc22; }}
                    if c_row + 2u < M && c_col + 3u < N {{ c[c_batch_offset + (c_row + 2u) * N + c_col + 3u] = acc23; }}

                    if c_row + 3u < M && c_col < N {{ c[c_batch_offset + (c_row + 3u) * N + c_col] = acc30; }}
                    if c_row + 3u < M && c_col + 1u < N {{ c[c_batch_offset + (c_row + 3u) * N + c_col + 1u] = acc31; }}
                    if c_row + 3u < M && c_col + 2u < N {{ c[c_batch_offset + (c_row + 3u) * N + c_col + 2u] = acc32; }}
                    if c_row + 3u < M && c_col + 3u < N {{ c[c_batch_offset + (c_row + 3u) * N + c_col + 3u] = acc33; }}
                }}
            "
        )
    }
}

/// Batched matrix multiplication: `C = A × B`.
///
/// # Panics
///
/// - Batch rank exceeds maximum supported
/// - Matrix dimensions exceed workgroup limits
/// - Output buffer too small
#[allow(clippy::too_many_lines)]
pub(crate) fn execute<T: FloatElement>(
    ctx: &Context,
    a: &Buffer<T>,
    b: &Buffer<T>,
    c: &Buffer<T>,
    a_dims: &[usize],
    b_dims: &[usize],
    c_dims: &[usize],
    transpose_a: bool,
    transpose_b: bool,
) {
    let rank = a_dims.len();
    let batch_rank = rank.saturating_sub(2);

    assert!(batch_rank <= MAX_BATCH_RANK, "batch rank exceeds maximum");

    let (a_rows, a_cols) = matrix_dims(a_dims);
    let (b_rows, b_cols) = matrix_dims(b_dims);

    let (m, k) = if transpose_a {
        (a_cols, a_rows)
    } else {
        (a_rows, a_cols)
    };
    let n = if transpose_b { b_rows } else { b_cols };

    if m == 0 || k == 0 || n == 0 {
        return;
    }

    let batch_size: usize = c_dims[..batch_rank].iter().product::<usize>().max(1);
    let out_len = batch_size * m * n;

    assert!(
        c.byte_size() >= (out_len * T::NATIVE_SIZE) as u64,
        "output buffer too small"
    );

    let m_tiles = u32::try_from(m)
        .expect("m dimension exceeds max size")
        .div_ceil(TILE_SIZE);
    let n_tiles = u32::try_from(n)
        .expect("n dimension exceeds max size")
        .div_ceil(TILE_SIZE);

    assert!(
        m_tiles <= MAX_WORKGROUPS && n_tiles <= MAX_WORKGROUPS,
        "matrix dimensions exceed workgroup limits"
    );

    let (a_batch_strides, b_batch_strides) = if batch_rank > 0 {
        compute_batch_strides(
            &a_dims[..batch_rank],
            &b_dims[..batch_rank],
            &c_dims[..batch_rank],
        )
    } else {
        (vec![0; MAX_BATCH_RANK], vec![0; MAX_BATCH_RANK])
    };

    let to_u32 = |x: usize| u32::try_from(x).expect("dimension exceeds max size");

    let mut batch_dims_arr = [[0u32; 4]; 2];
    let mut a_strides_arr = [[0u32; 4]; 2];
    let mut b_strides_arr = [[0u32; 4]; 2];

    fill_packed(
        &mut batch_dims_arr,
        c_dims[..batch_rank].iter().map(|&d| to_u32(d)),
    );
    fill_packed(
        &mut a_strides_arr,
        a_batch_strides.iter().map(|&s| to_u32(s)),
    );
    fill_packed(
        &mut b_strides_arr,
        b_batch_strides.iter().map(|&s| to_u32(s)),
    );

    let params = Params {
        m: to_u32(m),
        k: to_u32(k),
        n: to_u32(n),
        batch_size: to_u32(batch_size),
        batch_rank: to_u32(batch_rank),
        transpose_a: u32::from(transpose_a),
        transpose_b: u32::from(transpose_b),
        _pad: 0,
        batch_dims: batch_dims_arr,
        a_batch_strides: a_strides_arr,
        b_batch_strides: b_strides_arr,
        a_matrix_stride: to_u32(a_rows * a_cols),
        b_matrix_stride: to_u32(b_rows * b_cols),
        c_matrix_stride: to_u32(m * n),
        _pad2: 0,
    };

    let batch_size = params.batch_size;
    if batch_size == 0 {
        return;
    }

    let pipeline = ctx.get_or_create_pipeline(
        TypeId::of::<Matmul<T>>(),
        Matmul::<T>::wgsl,
        Matmul::<T>::LABEL,
    );

    let create_bind_group = |params_buf: &wgpu::Buffer| {
        ctx.device().create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some(Matmul::<T>::LABEL),
            layout: &pipeline.get_bind_group_layout(0),
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: a.inner().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: b.inner().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: c.inner().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: params_buf.as_entire_binding(),
                },
            ],
        })
    };

    let mut encoder = ctx
        .device()
        .create_command_encoder(&wgpu::CommandEncoderDescriptor {
            label: Some(Matmul::<T>::LABEL),
        });

    if batch_size <= MAX_WORKGROUPS {
        let params_buffer = ctx.create_uniform_buffer(&params);
        let bind_group = create_bind_group(&params_buffer);

        let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
            label: Some(Matmul::<T>::LABEL),
            ..Default::default()
        });
        pass.set_pipeline(&pipeline);
        pass.set_bind_group(0, &bind_group, &[]);
        pass.dispatch_workgroups(m_tiles, n_tiles, batch_size);
    } else {
        let num_dispatches = batch_size.div_ceil(MAX_WORKGROUPS);

        for i in 0..num_dispatches {
            let batch_count = (batch_size - i * MAX_WORKGROUPS).min(MAX_WORKGROUPS);

            let mut dispatch_params = params;
            dispatch_params.batch_size = batch_count;

            let params_buffer = ctx.create_uniform_buffer(&dispatch_params);
            let bind_group = create_bind_group(&params_buffer);

            let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
                label: Some(Matmul::<T>::LABEL),
                ..Default::default()
            });
            pass.set_pipeline(&pipeline);
            pass.set_bind_group(0, &bind_group, &[]);
            pass.dispatch_workgroups(m_tiles, n_tiles, batch_count);
        }
    }

    ctx.queue().submit(Some(encoder.finish()));
}

/// Extracts matrix dimensions (rows, cols) from tensor shape.
fn matrix_dims(dims: &[usize]) -> (usize, usize) {
    match dims.len() {
        0 => (1, 1),
        1 => (1, dims[0]),
        _ => (dims[dims.len() - 2], dims[dims.len() - 1]),
    }
}

/// Fills packed array from iterator.
fn fill_packed(arr: &mut [[u32; 4]; 2], iter: impl Iterator<Item = u32>) {
    for (i, v) in iter.enumerate() {
        arr[i / 4][i % 4] = v;
    }
}

fn compute_batch_strides(
    a_batch: &[usize],
    b_batch: &[usize],
    out_batch: &[usize],
) -> (Vec<usize>, Vec<usize>) {
    let batch_rank = out_batch.len();
    let a_strides = compute_contiguous_strides(a_batch);
    let b_strides = compute_contiguous_strides(b_batch);

    let mut a_broadcast = vec![0; batch_rank];
    let mut b_broadcast = vec![0; batch_rank];

    let a_offset = batch_rank.saturating_sub(a_batch.len());
    let b_offset = batch_rank.saturating_sub(b_batch.len());

    for (i, &out_dim) in out_batch.iter().enumerate() {
        if i >= a_offset && a_batch[i - a_offset] == out_dim {
            a_broadcast[i] = a_strides[i - a_offset];
        }
        if i >= b_offset && b_batch[i - b_offset] == out_dim {
            b_broadcast[i] = b_strides[i - b_offset];
        }
    }

    (a_broadcast, b_broadcast)
}

fn compute_contiguous_strides(dims: &[usize]) -> Vec<usize> {
    let mut strides = vec![1; dims.len()];
    for i in (0..dims.len().saturating_sub(1)).rev() {
        strides[i] = strides[i + 1] * dims[i + 1];
    }
    strides
}