oxifft-codegen-impl 0.3.1

Internal codelet generation logic for OxiFFT (not a proc-macro; used by oxifft-codegen and benchmarks)
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
//! Tests for multi-transform codelet generation.

use super::*;

// ── Config construction ──────────────────────────────────────────────────────

#[test]
fn test_multi_transform_config_valid_avx2_f32() {
    let config = MultiTransformConfig {
        size: 4,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    assert_eq!(config.size, 4);
    assert_eq!(config.v, 8);
    assert_eq!(config.isa, SimdIsa::Avx2);
    assert_eq!(config.precision, Precision::F32);
}

#[test]
fn test_multi_transform_config_valid_sse2_f64() {
    let config = MultiTransformConfig {
        size: 2,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F64,
    };
    assert_eq!(config.size, 2);
    assert_eq!(config.v, 4);
    assert_eq!(config.isa, SimdIsa::Sse2);
    assert_eq!(config.precision, Precision::F64);
}

// ── ISA helpers ──────────────────────────────────────────────────────────────

#[test]
fn test_isa_lanes_f32() {
    assert_eq!(SimdIsa::Sse2.lanes_f32(), 4);
    assert_eq!(SimdIsa::Avx2.lanes_f32(), 8);
    assert_eq!(SimdIsa::Scalar.lanes_f32(), 1);
}

#[test]
fn test_isa_lanes_f64() {
    assert_eq!(SimdIsa::Sse2.lanes_f64(), 2);
    assert_eq!(SimdIsa::Avx2.lanes_f64(), 4);
    assert_eq!(SimdIsa::Scalar.lanes_f64(), 1);
}

#[test]
fn test_isa_ident_str() {
    assert_eq!(SimdIsa::Sse2.ident_str(), "sse2");
    assert_eq!(SimdIsa::Avx2.ident_str(), "avx2");
    assert_eq!(SimdIsa::Scalar.ident_str(), "scalar");
}

// ── TokenStream generation ───────────────────────────────────────────────────

#[test]
fn test_generate_produces_nonempty_token_stream() {
    let config = MultiTransformConfig {
        size: 4,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("should generate");
    assert!(!ts.is_empty(), "TokenStream must not be empty");
}

#[test]
fn test_generate_function_name_avx2_f32_size4() {
    let config = MultiTransformConfig {
        size: 4,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("should generate");
    let s = ts.to_string();
    assert!(
        s.contains("notw_4_v8_avx2_f32"),
        "function name must match naming convention; got: {}",
        &s[..s.len().min(200)]
    );
}

#[test]
fn test_generate_function_name_sse2_f32_size2() {
    let config = MultiTransformConfig {
        size: 2,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("should generate");
    let s = ts.to_string();
    assert!(
        s.contains("notw_2_v4_sse2_f32"),
        "function name must match naming convention"
    );
}

#[test]
fn test_generate_function_name_avx2_f64_size8() {
    let config = MultiTransformConfig {
        size: 8,
        v: 4,
        isa: SimdIsa::Avx2,
        precision: Precision::F64,
    };
    let ts = generate_multi_transform(&config).expect("should generate");
    let s = ts.to_string();
    assert!(
        s.contains("notw_8_v4_avx2_f64"),
        "function name must match naming convention"
    );
}

#[test]
fn test_generate_unsupported_size_returns_error() {
    let config = MultiTransformConfig {
        size: 3,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F32,
    };
    let result = generate_multi_transform(&config);
    assert!(result.is_err(), "size 3 is unsupported and must return Err");
}

#[test]
fn test_generate_zero_v_returns_error() {
    let config = MultiTransformConfig {
        size: 4,
        v: 0,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let result = generate_multi_transform(&config);
    assert!(result.is_err(), "v=0 is invalid and must return Err");
}

// ── Generated source contains expected keywords ───────────────────────────────

#[test]
fn test_generate_contains_unsafe_fn() {
    let config = MultiTransformConfig {
        size: 4,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("should generate");
    let s = ts.to_string();
    assert!(
        s.contains("unsafe"),
        "generated function must be marked unsafe"
    );
    assert!(s.contains("fn"), "must contain fn keyword");
}

#[test]
fn test_generate_size2_contains_butterfly_ops() {
    let config = MultiTransformConfig {
        size: 2,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F64,
    };
    let ts = generate_multi_transform(&config).expect("should generate");
    let s = ts.to_string();
    // Size-2 butterfly uses + and - on the two halves.
    assert!(
        s.contains('+') || s.contains("add"),
        "size-2 butterfly must contain addition"
    );
}

// ── SIMD-specific: SSE2 f32 SIMD multi-transform ─────────────────────────────

/// Test that SSE2+f32+size2 generates SIMD intrinsic code (not scalar).
#[test]
fn test_generate_sse2_f32_size2_contains_simd_intrinsics() {
    let config = MultiTransformConfig {
        size: 2,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("SSE2 f32 size-2 should generate");
    let s = ts.to_string();
    // The generated code should contain SIMD intrinsic references
    assert!(
        s.contains("_mm_loadu_ps") || s.contains("notw_2_v4_sse2_f32_soa"),
        "SSE2 f32 size-2 must contain SIMD load intrinsic or SoA function: got prefix: {}",
        &s[..s.len().min(300)]
    );
}

/// Test that SSE2+f32+size4 generates SIMD intrinsic code.
#[test]
fn test_generate_sse2_f32_size4_contains_simd_intrinsics() {
    let config = MultiTransformConfig {
        size: 4,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("SSE2 f32 size-4 should generate");
    let s = ts.to_string();
    assert!(
        s.contains("_mm_loadu_ps") || s.contains("notw_4_v4_sse2_f32_soa"),
        "SSE2 f32 size-4 must reference SIMD intrinsics or SoA fn"
    );
}

/// Test that AVX2+f32+size2 generates SIMD intrinsic code.
#[test]
fn test_generate_avx2_f32_size2_contains_simd_intrinsics() {
    let config = MultiTransformConfig {
        size: 2,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("AVX2 f32 size-2 should generate");
    let s = ts.to_string();
    assert!(
        s.contains("_mm256_loadu_ps") || s.contains("notw_2_v8_avx2_f32_soa"),
        "AVX2 f32 size-2 must reference 256-bit SIMD intrinsics or SoA fn"
    );
}

/// Test that AVX2+f32+size4 generates SIMD intrinsic code.
#[test]
fn test_generate_avx2_f32_size4_contains_simd_intrinsics() {
    let config = MultiTransformConfig {
        size: 4,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("AVX2 f32 size-4 should generate");
    let s = ts.to_string();
    assert!(
        s.contains("_mm256_loadu_ps") || s.contains("notw_4_v8_avx2_f32_soa"),
        "AVX2 f32 size-4 must reference 256-bit SIMD intrinsics or SoA fn"
    );
}

/// Test that AVX2+f32+size8 generates SIMD intrinsic code.
#[test]
fn test_generate_avx2_f32_size8_contains_simd_intrinsics() {
    let config = MultiTransformConfig {
        size: 8,
        v: 8,
        isa: SimdIsa::Avx2,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("AVX2 f32 size-8 should generate");
    let s = ts.to_string();
    assert!(
        s.contains("_mm256_loadu_ps") || s.contains("notw_8_v8_avx2_f32_soa"),
        "AVX2 f32 size-8 must reference 256-bit SIMD intrinsics or SoA fn"
    );
}

/// Test that f64 combos do NOT accidentally generate SIMD intrinsics (scalar only).
#[test]
fn test_generate_sse2_f64_is_scalar_fallback() {
    let config = MultiTransformConfig {
        size: 2,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F64,
    };
    let ts = generate_multi_transform(&config).expect("SSE2 f64 should generate scalar fallback");
    let s = ts.to_string();
    // Must still have the outer function name
    assert!(
        s.contains("notw_2_v4_sse2_f64"),
        "must have correct fn name"
    );
}

// ── proc-macro parse path ────────────────────────────────────────────────────

#[test]
fn test_generate_from_macro_avx2_f32_size4() {
    let input: proc_macro2::TokenStream = "size = 4, v = 8, isa = avx2, ty = f32"
        .parse()
        .expect("valid token stream");
    let result = generate_from_macro(input);
    assert!(
        result.is_ok(),
        "macro parse should succeed: {:?}",
        result.err()
    );
    let ts = result.expect("TokenStream");
    let s = ts.to_string();
    assert!(
        s.contains("notw_4_v8_avx2_f32"),
        "generated name must be correct"
    );
}

#[test]
fn test_generate_from_macro_sse2_f64_size2() {
    let input: proc_macro2::TokenStream = "size = 2, v = 4, isa = sse2, ty = f64"
        .parse()
        .expect("valid token stream");
    let result = generate_from_macro(input);
    assert!(result.is_ok(), "macro parse should succeed");
    let ts = result.expect("TokenStream");
    let s = ts.to_string();
    assert!(
        s.contains("notw_2_v4_sse2_f64"),
        "generated name must be correct"
    );
}

#[test]
fn test_generate_from_macro_scalar_f32_size8() {
    let input: proc_macro2::TokenStream = "size = 8, v = 1, isa = scalar, ty = f32"
        .parse()
        .expect("valid token stream");
    let result = generate_from_macro(input);
    assert!(result.is_ok(), "scalar ISA should succeed");
    let ts = result.expect("TokenStream");
    let s = ts.to_string();
    assert!(
        s.contains("notw_8_v1_scalar_f32"),
        "generated name must match"
    );
}

#[test]
fn test_generate_from_macro_missing_size_returns_error() {
    let input: proc_macro2::TokenStream = "v = 8, isa = avx2, ty = f32"
        .parse()
        .expect("valid token stream");
    let result = generate_from_macro(input);
    assert!(result.is_err(), "missing size must return error");
}

#[test]
fn test_generate_from_macro_unknown_isa_returns_error() {
    let input: proc_macro2::TokenStream = "size = 4, v = 8, isa = avx512, ty = f32"
        .parse()
        .expect("valid token stream");
    let result = generate_from_macro(input);
    assert!(result.is_err(), "unknown isa must return error");
}

#[test]
fn test_generate_from_macro_unknown_ty_returns_error() {
    let input: proc_macro2::TokenStream = "size = 4, v = 8, isa = avx2, ty = f16"
        .parse()
        .expect("valid token stream");
    let result = generate_from_macro(input);
    assert!(result.is_err(), "unknown ty must return error");
}

// ── v=1 edge case (scalar single-transform mode) ─────────────────────────────

#[test]
fn test_generate_v1_scalar_f32_size4() {
    let config = MultiTransformConfig {
        size: 4,
        v: 1,
        isa: SimdIsa::Scalar,
        precision: Precision::F32,
    };
    let ts = generate_multi_transform(&config).expect("v=1 should succeed");
    let s = ts.to_string();
    assert!(
        s.contains("notw_4_v1_scalar_f32"),
        "v=1 name must be correct"
    );
}

// ── All valid (size, ISA) combos smoke-test ───────────────────────────────────

#[test]
fn test_all_supported_sizes_generate_successfully() {
    for &size in &[2_usize, 4, 8] {
        for &(isa, v) in &[
            (SimdIsa::Sse2, 4_usize),
            (SimdIsa::Avx2, 8),
            (SimdIsa::Scalar, 1),
        ] {
            for &prec in &[Precision::F32, Precision::F64] {
                let config = MultiTransformConfig {
                    size,
                    v,
                    isa,
                    precision: prec,
                };
                let result = generate_multi_transform(&config);
                assert!(
                    result.is_ok(),
                    "size={size} isa={isa:?} v={v} prec={prec:?} should succeed"
                );
                let s = result.expect("TokenStream").to_string();
                let expected_name = format!(
                    "notw_{}_v{}_{}_{}",
                    size,
                    v,
                    isa.ident_str(),
                    prec.type_str()
                );
                assert!(
                    s.contains(&expected_name),
                    "expected name '{expected_name}' in generated code"
                );
            }
        }
    }
}

/// Test that the SIMD-enabled combos generate more code than purely scalar.
///
/// SSE2 f32 and AVX2 f32 emit the outer `AoS` function PLUS the inner `SoA` SIMD
/// function. Scalar or f64 emit only the outer `AoS` function. The SIMD tokens
/// should therefore be strictly longer.
#[test]
fn test_simd_generates_more_code_than_scalar() {
    // SSE2 f32 size-2 (SIMD path)
    let simd_config = MultiTransformConfig {
        size: 2,
        v: 4,
        isa: SimdIsa::Sse2,
        precision: Precision::F32,
    };
    let simd_ts = generate_multi_transform(&simd_config).expect("SSE2 f32 should generate");
    let simd_len = simd_ts.to_string().len();

    // Scalar f32 size-2 (no SIMD)
    let scalar_config = MultiTransformConfig {
        size: 2,
        v: 1,
        isa: SimdIsa::Scalar,
        precision: Precision::F32,
    };
    let scalar_ts = generate_multi_transform(&scalar_config).expect("scalar f32 should generate");
    let scalar_len = scalar_ts.to_string().len();

    assert!(
        simd_len > scalar_len,
        "SIMD code ({simd_len} chars) should be longer than scalar ({scalar_len} chars)"
    );
}