archmage 0.9.21

//! Tests for the incant! macro.
//!
//! Tests cover:
//! - Entry point mode (summons tokens)
//! - Passthrough mode (uses existing token)
//! - Scalar fallback
//! - Cross-architecture compilation

// incant! generates _v3/_v4 for x86_64, _neon for aarch64, _wasm128 for wasm32.
// On i686 (target_arch = "x86") none of these exist.
#![cfg(any(
    target_arch = "x86_64",
    target_arch = "aarch64",
    target_arch = "wasm32"
))]

use archmage::{IntoConcreteToken, ScalarToken, SimdToken};

// =============================================================================
// Test helper functions with required suffixes
// =============================================================================

// Scalar implementation - always available
fn sum_scalar(_token: ScalarToken, data: &[f32]) -> f32 {
    data.iter().sum()
}

// x86 implementations
#[cfg(target_arch = "x86_64")]
fn sum_v3(_token: archmage::X64V3Token, data: &[f32]) -> f32 {
    // In real code, use SIMD. For tests, just verify dispatch works.
    data.iter().sum::<f32>() * 1.0 // Multiply by 1.0 to distinguish from scalar
}

#[cfg(all(target_arch = "x86_64", feature = "avx512"))]
fn sum_v4(_token: archmage::X64V4Token, data: &[f32]) -> f32 {
    data.iter().sum::<f32>() * 1.0
}

// ARM implementation
#[cfg(target_arch = "aarch64")]
fn sum_neon(_token: archmage::NeonToken, data: &[f32]) -> f32 {
    data.iter().sum::<f32>() * 1.0
}

// WASM implementation
#[cfg(target_arch = "wasm32")]
fn sum_wasm128(_token: archmage::Wasm128Token, data: &[f32]) -> f32 {
    data.iter().sum::<f32>() * 1.0
}

// =============================================================================
// V1/V2 tier variants — test lower-tier dispatch
// =============================================================================

// V1 (SSE2 baseline — always available on x86_64)
#[cfg(target_arch = "x86_64")]
fn add_one_v1(_token: archmage::X64V1Token, data: &[f32]) -> Vec<f32> {
    data.iter().map(|x| x + 1.0).collect()
}

// V2 (SSE4.2 — available on almost all x86_64 CPUs since 2008)
#[cfg(target_arch = "x86_64")]
fn add_one_v2(_token: archmage::X64V2Token, data: &[f32]) -> Vec<f32> {
    data.iter().map(|x| x + 1.0).collect()
}

fn add_one_scalar(_token: ScalarToken, data: &[f32]) -> Vec<f32> {
    data.iter().map(|x| x + 1.0).collect()
}

// =============================================================================
// Entry point mode tests
// =============================================================================

mod entry_point_tests {
    use super::*;
    use archmage::incant;

    /// Public API using incant! for dispatch
    pub fn sum_api(data: &[f32]) -> f32 {
        incant!(sum(data))
    }

    #[test]
    fn entry_point_dispatches() {
        let data = [1.0f32, 2.0, 3.0, 4.0];
        let result = sum_api(&data);
        assert_eq!(result, 10.0);
    }

    #[test]
    fn entry_point_with_empty_data() {
        let data: [f32; 0] = [];
        let result = sum_api(&data);
        assert_eq!(result, 0.0);
    }

    #[test]
    fn entry_point_with_large_data() {
        let data: Vec<f32> = (0..1000).map(|i| i as f32).collect();
        let result = sum_api(&data);
        let expected: f32 = (0..1000).map(|i| i as f32).sum();
        assert_eq!(result, expected);
    }
}

// =============================================================================
// V1/V2 dispatch tests — verify lower tiers work with incant!
// =============================================================================

mod v1_v2_dispatch_tests {
    use super::*;
    use archmage::incant;

    /// incant! with explicit [v1, scalar] dispatches to _v1 on x86_64.
    /// V1 is the x86_64 baseline (SSE2) — always available.
    pub fn add_one_v1_api(data: &[f32]) -> Vec<f32> {
        incant!(add_one(data), [v1, scalar])
    }

    #[test]
    fn v1_dispatch_works() {
        let data = [1.0f32, 2.0, 3.0];
        let result = add_one_v1_api(&data);
        assert_eq!(result, vec![2.0, 3.0, 4.0]);
    }

    /// incant! with explicit [v2, v1, scalar] tries V2 first, falls back to V1.
    pub fn add_one_v2_api(data: &[f32]) -> Vec<f32> {
        incant!(add_one(data), [v2, v1, scalar])
    }

    #[test]
    fn v2_dispatch_works() {
        let data = [10.0f32, 20.0];
        let result = add_one_v2_api(&data);
        assert_eq!(result, vec![11.0, 21.0]);
    }

    /// Verify V1 is always reached on x86_64 (it's baseline).
    #[cfg(target_arch = "x86_64")]
    #[test]
    fn v1_always_available_on_x86_64() {
        assert!(
            archmage::X64V1Token::summon().is_some(),
            "V1 is x86_64 baseline — must always be Some"
        );
    }

    /// Verify V2 dispatch still falls through correctly when
    /// only scalar is available (non-x86_64).
    #[cfg(not(target_arch = "x86_64"))]
    #[test]
    fn v1_v2_fall_through_to_scalar_on_non_x86() {
        let data = [5.0f32];
        let result = add_one_v1_api(&data);
        assert_eq!(result, vec![6.0]);
        let result = add_one_v2_api(&data);
        assert_eq!(result, vec![6.0]);
    }
}

// =============================================================================
// Passthrough mode tests
// =============================================================================

mod passthrough_tests {
    use super::*;
    use archmage::incant;

    /// Inner function called via passthrough
    fn inner_sum<T: IntoConcreteToken>(token: T, data: &[f32]) -> f32 {
        incant!(sum(data) with token)
    }

    #[test]
    fn passthrough_with_scalar_token() {
        let token = ScalarToken;
        let data = [1.0f32, 2.0, 3.0, 4.0];
        let result = inner_sum(token, &data);
        assert_eq!(result, 10.0);
    }

    #[cfg(target_arch = "x86_64")]
    #[test]
    fn passthrough_with_x64v3_token() {
        if let Some(token) = archmage::X64V3Token::summon() {
            let data = [1.0f32, 2.0, 3.0, 4.0];
            let result = inner_sum(token, &data);
            assert_eq!(result, 10.0);
        }
    }

    #[cfg(all(target_arch = "x86_64", feature = "avx512"))]
    #[test]
    fn passthrough_with_x64v4_token() {
        if let Some(token) = archmage::X64V4Token::summon() {
            let data = [1.0f32, 2.0, 3.0, 4.0];
            let result = inner_sum(token, &data);
            assert_eq!(result, 10.0);
        }
    }
}

// =============================================================================
// Scalar fallback tests
// =============================================================================

mod scalar_fallback_tests {
    use super::*;
    use archmage::incant;

    // All variants must exist for incant! to work.
    // The scalar variant is the fallback when no SIMD is available.
    fn double_scalar(_token: ScalarToken, x: i32) -> i32 {
        x * 2
    }

    #[cfg(target_arch = "x86_64")]
    fn double_v3(_token: archmage::X64V3Token, x: i32) -> i32 {
        x * 2
    }

    #[cfg(all(target_arch = "x86_64", feature = "avx512"))]
    fn double_v4(_token: archmage::X64V4Token, x: i32) -> i32 {
        x * 2
    }

    #[cfg(target_arch = "aarch64")]
    fn double_neon(_token: archmage::NeonToken, x: i32) -> i32 {
        x * 2
    }

    #[cfg(target_arch = "wasm32")]
    fn double_wasm128(_token: archmage::Wasm128Token, x: i32) -> i32 {
        x * 2
    }

    pub fn double_api(x: i32) -> i32 {
        incant!(double(x))
    }

    #[test]
    fn works_with_all_variants() {
        let result = double_api(21);
        assert_eq!(result, 42);
    }

    #[test]
    fn scalar_token_always_available() {
        // ScalarToken itself is always available
        assert!(ScalarToken::summon().is_some());
        assert_eq!(ScalarToken::compiled_with(), Some(true));
    }
}

// =============================================================================
// Multiple arguments tests
// =============================================================================

mod multi_arg_tests {
    use super::*;
    use archmage::incant;

    fn dot_scalar(_token: ScalarToken, a: &[f32], b: &[f32]) -> f32 {
        a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
    }

    #[cfg(target_arch = "x86_64")]
    fn dot_v3(_token: archmage::X64V3Token, a: &[f32], b: &[f32]) -> f32 {
        a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
    }

    #[cfg(all(target_arch = "x86_64", feature = "avx512"))]
    fn dot_v4(_token: archmage::X64V4Token, a: &[f32], b: &[f32]) -> f32 {
        a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
    }

    #[cfg(target_arch = "aarch64")]
    fn dot_neon(_token: archmage::NeonToken, a: &[f32], b: &[f32]) -> f32 {
        a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
    }

    #[cfg(target_arch = "wasm32")]
    fn dot_wasm128(_token: archmage::Wasm128Token, a: &[f32], b: &[f32]) -> f32 {
        a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
    }

    pub fn dot_api(a: &[f32], b: &[f32]) -> f32 {
        incant!(dot(a, b))
    }

    #[test]
    fn multiple_arguments() {
        let a = [1.0f32, 2.0, 3.0, 4.0];
        let b = [4.0f32, 3.0, 2.0, 1.0];
        let result = dot_api(&a, &b);
        // 1*4 + 2*3 + 3*2 + 4*1 = 4 + 6 + 6 + 4 = 20
        assert_eq!(result, 20.0);
    }
}

// =============================================================================
// Return type tests
// =============================================================================

mod return_type_tests {
    use super::*;
    use archmage::incant;

    fn make_array_scalar(_token: ScalarToken, val: f32) -> [f32; 4] {
        [val, val, val, val]
    }

    #[cfg(target_arch = "x86_64")]
    fn make_array_v3(_token: archmage::X64V3Token, val: f32) -> [f32; 4] {
        [val, val, val, val]
    }

    #[cfg(all(target_arch = "x86_64", feature = "avx512"))]
    fn make_array_v4(_token: archmage::X64V4Token, val: f32) -> [f32; 4] {
        [val, val, val, val]
    }

    #[cfg(target_arch = "aarch64")]
    fn make_array_neon(_token: archmage::NeonToken, val: f32) -> [f32; 4] {
        [val, val, val, val]
    }

    #[cfg(target_arch = "wasm32")]
    fn make_array_wasm128(_token: archmage::Wasm128Token, val: f32) -> [f32; 4] {
        [val, val, val, val]
    }

    pub fn make_array_api(val: f32) -> [f32; 4] {
        incant!(make_array(val))
    }

    #[test]
    fn returns_array() {
        let result = make_array_api(3.125);
        assert_eq!(result, [3.125, 3.125, 3.125, 3.125]);
    }
}

// =============================================================================
// simd_route! alias tests
// =============================================================================

mod alias_tests {
    use super::*;
    use archmage::simd_route;

    fn add_scalar(_token: ScalarToken, a: i32, b: i32) -> i32 {
        a + b
    }

    #[cfg(target_arch = "x86_64")]
    fn add_v3(_token: archmage::X64V3Token, a: i32, b: i32) -> i32 {
        a + b
    }

    #[cfg(all(target_arch = "x86_64", feature = "avx512"))]
    fn add_v4(_token: archmage::X64V4Token, a: i32, b: i32) -> i32 {
        a + b
    }

    #[cfg(target_arch = "aarch64")]
    fn add_neon(_token: archmage::NeonToken, a: i32, b: i32) -> i32 {
        a + b
    }

    #[cfg(target_arch = "wasm32")]
    fn add_wasm128(_token: archmage::Wasm128Token, a: i32, b: i32) -> i32 {
        a + b
    }

    pub fn add_api(a: i32, b: i32) -> i32 {
        simd_route!(add(a, b))
    }

    #[test]
    fn simd_route_alias_works() {
        let result = add_api(20, 22);
        assert_eq!(result, 42);
    }
}

// =============================================================================
// IntoConcreteToken direct usage tests
// =============================================================================

// =============================================================================
// Module path tests (incant! with module::func syntax)
// =============================================================================

mod simd_impls {
    use archmage::ScalarToken;

    pub fn triple_scalar(_token: ScalarToken, x: i32) -> i32 {
        x * 3
    }

    #[cfg(target_arch = "x86_64")]
    pub fn triple_v3(_token: archmage::X64V3Token, x: i32) -> i32 {
        x * 3
    }

    #[cfg(all(target_arch = "x86_64", feature = "avx512"))]
    pub fn triple_v4(_token: archmage::X64V4Token, x: i32) -> i32 {
        x * 3
    }

    #[cfg(target_arch = "aarch64")]
    pub fn triple_neon(_token: archmage::NeonToken, x: i32) -> i32 {
        x * 3
    }

    #[cfg(target_arch = "wasm32")]
    pub fn triple_wasm128(_token: archmage::Wasm128Token, x: i32) -> i32 {
        x * 3
    }
}

mod module_path_tests {
    use archmage::incant;

    pub fn triple_api(x: i32) -> i32 {
        incant!(super::simd_impls::triple(x))
    }

    #[test]
    fn module_path_entry_point() {
        let result = triple_api(7);
        assert_eq!(result, 21);
    }

    #[test]
    fn module_path_passthrough() {
        use archmage::{IntoConcreteToken, ScalarToken};
        fn inner<T: IntoConcreteToken>(token: T, x: i32) -> i32 {
            incant!(super::simd_impls::triple(x) with token)
        }
        let result = inner(ScalarToken, 14);
        assert_eq!(result, 42);
    }
}

// =============================================================================
// IntoConcreteToken direct usage tests
// =============================================================================

mod into_concrete_token_tests {
    use super::*;

    /// Manual dispatch using IntoConcreteToken (what incant! generates)
    fn manual_dispatch<T: IntoConcreteToken>(token: T, data: &[f32]) -> f32 {
        #[cfg(any(target_arch = "x86_64", target_arch = "x86"))]
        {
            #[cfg(feature = "avx512")]
            if let Some(t) = token.as_x64v4() {
                return super::sum_v4(t, data);
            }
            if let Some(t) = token.as_x64v3() {
                return super::sum_v3(t, data);
            }
        }

        #[cfg(target_arch = "aarch64")]
        if let Some(t) = token.as_neon() {
            return super::sum_neon(t, data);
        }

        #[cfg(target_arch = "wasm32")]
        if let Some(t) = token.as_wasm128() {
            return super::sum_wasm128(t, data);
        }

        if let Some(t) = token.as_scalar() {
            return super::sum_scalar(t, data);
        }

        unreachable!()
    }

    #[test]
    fn manual_dispatch_scalar() {
        let data = [1.0f32, 2.0, 3.0, 4.0];
        let result = manual_dispatch(ScalarToken, &data);
        assert_eq!(result, 10.0);
    }

    #[cfg(target_arch = "x86_64")]
    #[test]
    fn manual_dispatch_x64v3() {
        if let Some(token) = archmage::X64V3Token::summon() {
            let data = [1.0f32, 2.0, 3.0, 4.0];
            let result = manual_dispatch(token, &data);
            assert_eq!(result, 10.0);
        }
    }
}

// =============================================================================
// `default` tier — tokenless fallback
// =============================================================================

mod default_tier_tests {
    use archmage::prelude::*;

    // -- Entry-point mode with default --

    fn entry_default(x: f32) -> f32 {
        x * 99.0
    }

    #[arcane]
    fn entry_v3(_: X64V3Token, x: f32) -> f32 {
        x * 30.0
    }

    fn entry_dispatch(x: f32) -> f32 {
        incant!(entry(x), [v3, default])
    }

    #[test]
    fn entry_point_default_dispatches() {
        let result = entry_dispatch(1.0);
        #[cfg(target_arch = "x86_64")]
        if X64V3Token::summon().is_some() {
            assert_eq!(result, 30.0);
        } else {
            assert_eq!(result, 99.0);
        }
        #[cfg(not(target_arch = "x86_64"))]
        assert_eq!(result, 99.0);
    }

    // -- Entry-point mode, default only (no other tiers) --

    fn default_only_default(x: f32) -> f32 {
        x + 42.0
    }

    fn default_only_dispatch(x: f32) -> f32 {
        incant!(default_only(x), [default])
    }

    #[test]
    fn default_only_works() {
        assert_eq!(default_only_dispatch(1.0), 43.0);
    }

    // -- Entry-point with multiple args --

    fn multi_arg_default(a: f32, b: f32, c: f32) -> f32 {
        a + b + c
    }

    #[arcane]
    fn multi_arg_v3(_: X64V3Token, a: f32, b: f32, c: f32) -> f32 {
        (a + b + c) * 100.0
    }

    fn multi_arg_dispatch(a: f32, b: f32, c: f32) -> f32 {
        incant!(multi_arg(a, b, c), [v3, default])
    }

    #[test]
    fn default_with_multiple_args() {
        let result = multi_arg_dispatch(1.0, 2.0, 3.0);
        #[cfg(target_arch = "x86_64")]
        if X64V3Token::summon().is_some() {
            assert_eq!(result, 600.0);
        } else {
            assert_eq!(result, 6.0);
        }
        #[cfg(not(target_arch = "x86_64"))]
        assert_eq!(result, 6.0);
    }

    // -- Passthrough mode with default --

    fn passthrough_default(x: f32) -> f32 {
        x * 77.0
    }

    #[arcane]
    fn passthrough_v3(_: X64V3Token, x: f32) -> f32 {
        x * 33.0
    }

    fn passthrough_dispatch<T: IntoConcreteToken>(token: T, x: f32) -> f32 {
        incant!(passthrough(x) with token, [v3, default])
    }

    #[test]
    fn passthrough_default_with_scalar() {
        let result = passthrough_dispatch(ScalarToken, 1.0);
        // ScalarToken doesn't match v3, falls through to default (tokenless)
        assert_eq!(result, 77.0);
    }

    #[cfg(target_arch = "x86_64")]
    #[test]
    fn passthrough_default_with_v3() {
        if let Some(token) = X64V3Token::summon() {
            let result = passthrough_dispatch(token, 1.0);
            assert_eq!(result, 33.0);
        }
    }

    // -- Verify default is called without token (tokenless) --

    // This function takes NO token. If incant! tried to pass one, it wouldn't compile.
    fn no_token_default(x: f32) -> f32 {
        x
    }

    fn no_token_dispatch(x: f32) -> f32 {
        incant!(no_token(x), [default])
    }

    #[test]
    fn default_is_truly_tokenless() {
        assert_eq!(no_token_dispatch(42.0), 42.0);
    }
}