torsh-core 0.1.2

Core types and traits for ToRSh deep learning framework
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
//! ARM NEON SIMD optimizations for ToRSh core operations
//!
//! This module provides optimized implementations of common operations using
//! ARM NEON SIMD instructions for improved performance on ARM64 platforms.
//!
//! # SciRS2 POLICY COMPLIANCE
//!
//! ## Recommended Usage (NEW CODE)
//! For new code, prefer using scirs2-core SIMD operations which provide:
//! - Memory-aligned operations for 2-4x better performance
//! - Cross-platform consistency (ARM64, x86_64)
//! - Automatic hardware detection and fallback
//!
//! ```ignore
//! use torsh_core::simd::*;  // scirs2-core aligned SIMD
//! let result = simd_add_aligned_f32(aligned_a.as_slice(), aligned_b.as_slice())?;
//! ```
//!
//! ## Legacy Usage (EXISTING CODE)
//! This module maintains ARM-specific SIMD for backward compatibility
//! and specialized use cases. Use these when:
//! - Working with legacy ToRSh code
//! - Need ARM-specific optimizations
//! - Memory alignment cannot be guaranteed
//!
//! ```ignore
//! use torsh_core::simd_arm::ArmSimdOps;
//! unsafe { ArmSimdOps::add_f32_neon(&a, &b, &mut result)?; }
//! ```

#[cfg(target_arch = "aarch64")]
use std::arch::aarch64::*;

use crate::error::{Result, TorshError};

/// ARM NEON optimized operations
pub struct ArmSimdOps;

#[cfg(target_arch = "aarch64")]
impl ArmSimdOps {
    /// Check if NEON is available at runtime
    pub fn is_neon_available() -> bool {
        std::arch::is_aarch64_feature_detected!("neon")
    }

    /// Check if Advanced SIMD is available
    pub fn is_asimd_available() -> bool {
        std::arch::is_aarch64_feature_detected!("asimd")
    }

    /// Check if FP16 arithmetic is supported
    pub fn is_fp16_available() -> bool {
        std::arch::is_aarch64_feature_detected!("fp16")
    }

    /// Check if dot product instructions are supported
    pub fn is_dotprod_available() -> bool {
        std::arch::is_aarch64_feature_detected!("dotprod")
    }

    /// Vectorized addition of f32 arrays using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn add_f32_neon(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        if a.len() != b.len() || a.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "add_f32_neon",
            ));
        }

        let len = a.len();
        let simd_len = len & !3; // Process 4 elements at a time

        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();
        let result_ptr = result.as_mut_ptr();

        // Process 4 f32 elements at a time using NEON
        for i in (0..simd_len).step_by(4) {
            let va = vld1q_f32(a_ptr.add(i));
            let vb = vld1q_f32(b_ptr.add(i));
            let vresult = vaddq_f32(va, vb);
            vst1q_f32(result_ptr.add(i), vresult);
        }

        // Handle remaining elements
        for i in simd_len..len {
            result[i] = a[i] + b[i];
        }

        Ok(())
    }

    /// Vectorized subtraction of f32 arrays using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn sub_f32_neon(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        if a.len() != b.len() || a.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let len = a.len();
        let simd_len = len & !3;

        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();
        let result_ptr = result.as_mut_ptr();

        for i in (0..simd_len).step_by(4) {
            let va = vld1q_f32(a_ptr.add(i));
            let vb = vld1q_f32(b_ptr.add(i));
            let vresult = vsubq_f32(va, vb);
            vst1q_f32(result_ptr.add(i), vresult);
        }

        for i in simd_len..len {
            result[i] = a[i] - b[i];
        }

        Ok(())
    }

    /// Vectorized multiplication of f32 arrays using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn mul_f32_neon(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        if a.len() != b.len() || a.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let len = a.len();
        let simd_len = len & !3;

        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();
        let result_ptr = result.as_mut_ptr();

        for i in (0..simd_len).step_by(4) {
            let va = vld1q_f32(a_ptr.add(i));
            let vb = vld1q_f32(b_ptr.add(i));
            let vresult = vmulq_f32(va, vb);
            vst1q_f32(result_ptr.add(i), vresult);
        }

        for i in simd_len..len {
            result[i] = a[i] * b[i];
        }

        Ok(())
    }

    /// Vectorized fused multiply-add operation using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn fma_f32_neon(a: &[f32], b: &[f32], c: &[f32], result: &mut [f32]) -> Result<()> {
        if a.len() != b.len() || a.len() != c.len() || a.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let len = a.len();
        let simd_len = len & !3;

        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();
        let c_ptr = c.as_ptr();
        let result_ptr = result.as_mut_ptr();

        for i in (0..simd_len).step_by(4) {
            let va = vld1q_f32(a_ptr.add(i));
            let vb = vld1q_f32(b_ptr.add(i));
            let vc = vld1q_f32(c_ptr.add(i));
            let vresult = vfmaq_f32(vc, va, vb); // c + a * b
            vst1q_f32(result_ptr.add(i), vresult);
        }

        for i in simd_len..len {
            result[i] = a[i] * b[i] + c[i];
        }

        Ok(())
    }

    /// Vectorized dot product using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn dot_product_f32_neon(a: &[f32], b: &[f32]) -> Result<f32> {
        if a.len() != b.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let len = a.len();
        let simd_len = len & !3;

        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();

        let mut sum_vec = vdupq_n_f32(0.0);

        // SIMD accumulation
        for i in (0..simd_len).step_by(4) {
            let va = vld1q_f32(a_ptr.add(i));
            let vb = vld1q_f32(b_ptr.add(i));
            let vmul = vmulq_f32(va, vb);
            sum_vec = vaddq_f32(sum_vec, vmul);
        }

        // Horizontal sum of the vector
        let sum_pair = vadd_f32(vget_low_f32(sum_vec), vget_high_f32(sum_vec));
        let sum_scalar = vpadd_f32(sum_pair, sum_pair);
        let mut result = vget_lane_f32(sum_scalar, 0);

        // Handle remaining elements
        for i in simd_len..len {
            result += a[i] * b[i];
        }

        Ok(result)
    }

    /// Optimized dot product for small vectors
    /// Note: dotprod instructions are currently unstable, using manual implementation
    #[target_feature(enable = "neon")]
    pub unsafe fn dot_product_i8_dotprod(a: &[i8], b: &[i8]) -> Result<i32> {
        if a.len() != b.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let len = a.len();
        let simd_len = len & !15; // Process 16 elements at a time

        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();

        let mut sum_vec = vdupq_n_s32(0);

        // SIMD accumulation using manual multiply-accumulate
        // TODO: Re-enable vdotq_s32 when it becomes stable
        for i in (0..simd_len).step_by(16) {
            // Load 16 i8 values and process in groups of 4
            for j in 0..4 {
                let offset = i + j * 4;
                if offset < len {
                    // Load 4 i8 values and convert to i32
                    let a_vals = [
                        *a_ptr.add(offset) as i32,
                        *a_ptr.add(offset + 1) as i32,
                        *a_ptr.add(offset + 2) as i32,
                        *a_ptr.add(offset + 3) as i32,
                    ];
                    let b_vals = [
                        *b_ptr.add(offset) as i32,
                        *b_ptr.add(offset + 1) as i32,
                        *b_ptr.add(offset + 2) as i32,
                        *b_ptr.add(offset + 3) as i32,
                    ];

                    let va = vld1q_s32(a_vals.as_ptr());
                    let vb = vld1q_s32(b_vals.as_ptr());
                    sum_vec = vmlaq_s32(sum_vec, va, vb);
                }
            }
        }

        // Horizontal sum
        let sum_pair = vadd_s32(vget_low_s32(sum_vec), vget_high_s32(sum_vec));
        let sum_scalar = vpadd_s32(sum_pair, sum_pair);
        let mut result = vget_lane_s32(sum_scalar, 0);

        // Handle remaining elements
        for i in simd_len..len {
            result += a[i] as i32 * b[i] as i32;
        }

        Ok(result)
    }

    /// Vectorized sum reduction using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn sum_f32_neon(data: &[f32]) -> f32 {
        let len = data.len();
        let simd_len = len & !3;
        let data_ptr = data.as_ptr();

        let mut sum_vec = vdupq_n_f32(0.0);

        // SIMD accumulation
        for i in (0..simd_len).step_by(4) {
            let vdata = vld1q_f32(data_ptr.add(i));
            sum_vec = vaddq_f32(sum_vec, vdata);
        }

        // Horizontal sum
        let sum_pair = vadd_f32(vget_low_f32(sum_vec), vget_high_f32(sum_vec));
        let sum_scalar = vpadd_f32(sum_pair, sum_pair);
        let mut result = vget_lane_f32(sum_scalar, 0);

        // Handle remaining elements
        #[allow(clippy::needless_range_loop)] // Indexing is clearer for accumulation
        for i in simd_len..len {
            result += data[i];
        }

        result
    }

    /// Vectorized ReLU activation using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn relu_f32_neon(data: &[f32], result: &mut [f32]) -> Result<()> {
        if data.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let len = data.len();
        let simd_len = len & !3;

        let data_ptr = data.as_ptr();
        let result_ptr = result.as_mut_ptr();
        let zero_vec = vdupq_n_f32(0.0);

        for i in (0..simd_len).step_by(4) {
            let vdata = vld1q_f32(data_ptr.add(i));
            let vresult = vmaxq_f32(vdata, zero_vec);
            vst1q_f32(result_ptr.add(i), vresult);
        }

        for i in simd_len..len {
            result[i] = data[i].max(0.0);
        }

        Ok(())
    }

    /// Vectorized matrix multiplication for small matrices using NEON
    #[target_feature(enable = "neon")]
    pub unsafe fn matmul_f32_4x4_neon(
        a: &[f32; 16],
        b: &[f32; 16],
        result: &mut [f32; 16],
    ) -> Result<()> {
        // Load matrix A rows
        let a_row0 = vld1q_f32(a.as_ptr());
        let a_row1 = vld1q_f32(a.as_ptr().add(4));
        let a_row2 = vld1q_f32(a.as_ptr().add(8));
        let a_row3 = vld1q_f32(a.as_ptr().add(12));

        // Load matrix B columns (transposed for efficient access)
        let b_col0_arr = [b[0], b[4], b[8], b[12]];
        let b_col1_arr = [b[1], b[5], b[9], b[13]];
        let b_col2_arr = [b[2], b[6], b[10], b[14]];
        let b_col3_arr = [b[3], b[7], b[11], b[15]];

        let b_col0 = vld1q_f32(b_col0_arr.as_ptr());
        let b_col1 = vld1q_f32(b_col1_arr.as_ptr());
        let b_col2 = vld1q_f32(b_col2_arr.as_ptr());
        let b_col3 = vld1q_f32(b_col3_arr.as_ptr());

        // Compute result matrix
        let a_rows = [a_row0, a_row1, a_row2, a_row3];
        let b_cols = [b_col0, b_col1, b_col2, b_col3];

        for i in 0..4 {
            for j in 0..4 {
                let dot = vmulq_f32(a_rows[i], b_cols[j]);
                let sum_pair = vadd_f32(vget_low_f32(dot), vget_high_f32(dot));
                let sum_scalar = vpadd_f32(sum_pair, sum_pair);
                let final_sum = vget_lane_f32(sum_scalar, 0);
                result[i * 4 + j] = final_sum;
            }
        }

        Ok(())
    }

    // Note: f16 NEON operations require unstable Rust features
    // Commented out until f16 support is stabilized
    // #[cfg(feature = "fp16")]
    // #[target_feature(enable = "neon", enable = "fp16")]
    // pub unsafe fn add_f16_neon(a: &[f16], b: &[f16], result: &mut [f16]) -> Result<()> {
    //     if a.len() != b.len() || a.len() != result.len() {
    //         return Err(TorshError::dimension_error_with_context(
    //             "Array lengths must match",
    //             "simd_operation",
    //         ));
    //     }
    //
    //     let len = a.len();
    //     let simd_len = len & !7; // Process 8 f16 elements at a time
    //
    //     let a_ptr = a.as_ptr() as *const __fp16;
    //     let b_ptr = b.as_ptr() as *const __fp16;
    //     let result_ptr = result.as_mut_ptr() as *mut __fp16;
    //
    //     for i in (0..simd_len).step_by(8) {
    //         let va = vld1q_f16(a_ptr.add(i));
    //         let vb = vld1q_f16(b_ptr.add(i));
    //         let vresult = vaddq_f16(va, vb);
    //         vst1q_f16(result_ptr.add(i), vresult);
    //     }
    //
    //     // Handle remaining elements (fallback to scalar)
    //     for i in simd_len..len {
    //         result[i] = a[i] + b[i];
    //     }
    //
    //     Ok(())
    // }

    /// Optimized memcpy using NEON for large data transfers
    #[target_feature(enable = "neon")]
    pub unsafe fn memcpy_neon(src: &[u8], dest: &mut [u8]) -> Result<()> {
        if src.len() != dest.len() {
            return Err(TorshError::dimension_error_with_context(
                "Source and destination lengths must match",
                "memcpy_neon",
            ));
        }

        let len = src.len();
        let simd_len = len & !31; // Process 32 bytes at a time

        let src_ptr = src.as_ptr();
        let dest_ptr = dest.as_mut_ptr();

        // NEON optimized copy for large blocks
        for i in (0..simd_len).step_by(32) {
            let v0 = vld1q_u8(src_ptr.add(i));
            let v1 = vld1q_u8(src_ptr.add(i + 16));
            vst1q_u8(dest_ptr.add(i), v0);
            vst1q_u8(dest_ptr.add(i + 16), v1);
        }

        // Handle remaining bytes
        dest[simd_len..len].copy_from_slice(&src[simd_len..len]);

        Ok(())
    }
}

/// Safe wrapper functions for ARM SIMD operations
impl ArmSimdOps {
    /// Safe wrapper for NEON f32 addition
    pub fn add_f32_safe(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        #[cfg(target_arch = "aarch64")]
        {
            if Self::is_neon_available() {
                unsafe { Self::add_f32_neon(a, b, result) }
            } else {
                Self::add_f32_scalar(a, b, result)
            }
        }
        #[cfg(not(target_arch = "aarch64"))]
        {
            Self::add_f32_scalar(a, b, result)
        }
    }

    /// Safe wrapper for NEON f32 multiplication
    pub fn mul_f32_safe(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        #[cfg(target_arch = "aarch64")]
        {
            if Self::is_neon_available() {
                unsafe { Self::mul_f32_neon(a, b, result) }
            } else {
                Self::mul_f32_scalar(a, b, result)
            }
        }
        #[cfg(not(target_arch = "aarch64"))]
        {
            Self::mul_f32_scalar(a, b, result)
        }
    }

    /// Safe wrapper for NEON dot product
    pub fn dot_product_f32_safe(a: &[f32], b: &[f32]) -> Result<f32> {
        #[cfg(target_arch = "aarch64")]
        {
            if Self::is_neon_available() {
                unsafe { Self::dot_product_f32_neon(a, b) }
            } else {
                Self::dot_product_f32_scalar(a, b)
            }
        }
        #[cfg(not(target_arch = "aarch64"))]
        {
            Self::dot_product_f32_scalar(a, b)
        }
    }

    /// Scalar fallback for f32 addition
    fn add_f32_scalar(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        if a.len() != b.len() || a.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        for i in 0..a.len() {
            result[i] = a[i] + b[i];
        }

        Ok(())
    }

    /// Scalar fallback for f32 multiplication
    fn mul_f32_scalar(a: &[f32], b: &[f32], result: &mut [f32]) -> Result<()> {
        if a.len() != b.len() || a.len() != result.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        for i in 0..a.len() {
            result[i] = a[i] * b[i];
        }

        Ok(())
    }

    /// Scalar fallback for f32 dot product
    fn dot_product_f32_scalar(a: &[f32], b: &[f32]) -> Result<f32> {
        if a.len() != b.len() {
            return Err(TorshError::dimension_error_with_context(
                "Array lengths must match",
                "simd_operation",
            ));
        }

        let mut result = 0.0;
        for i in 0..a.len() {
            result += a[i] * b[i];
        }

        Ok(result)
    }
}

#[cfg(not(target_arch = "aarch64"))]
impl ArmSimdOps {
    /// Stub implementation for non-ARM platforms
    pub fn is_neon_available() -> bool {
        false
    }
    pub fn is_asimd_available() -> bool {
        false
    }
    pub fn is_fp16_available() -> bool {
        false
    }
    pub fn is_dotprod_available() -> bool {
        false
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_neon_availability() {
        #[cfg(target_arch = "aarch64")]
        {
            // Test availability checks - these should not panic
            let _ = ArmSimdOps::is_neon_available();
            let _ = ArmSimdOps::is_asimd_available();
            let _ = ArmSimdOps::is_fp16_available();
            let _ = ArmSimdOps::is_dotprod_available();
        }
    }

    #[test]
    fn test_safe_operations() {
        let a = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0];
        let b = vec![2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0];
        let mut result = vec![0.0; 8];

        // Test addition
        ArmSimdOps::add_f32_safe(&a, &b, &mut result).expect("add_f32_safe should succeed");
        let expected_add = vec![3.0, 5.0, 7.0, 9.0, 11.0, 13.0, 15.0, 17.0];
        assert_eq!(result, expected_add);

        // Test multiplication
        ArmSimdOps::mul_f32_safe(&a, &b, &mut result).expect("mul_f32_safe should succeed");
        let expected_mul = vec![2.0, 6.0, 12.0, 20.0, 30.0, 42.0, 56.0, 72.0];
        assert_eq!(result, expected_mul);

        // Test dot product
        let dot_result =
            ArmSimdOps::dot_product_f32_safe(&a, &b).expect("dot_product_f32_safe should succeed");
        let expected_dot = 240.0; // 1*2 + 2*3 + 3*4 + 4*5 + 5*6 + 6*7 + 7*8 + 8*9
        assert_eq!(dot_result, expected_dot);
    }

    #[test]
    fn test_error_handling() {
        let a = vec![1.0, 2.0, 3.0];
        let b = vec![1.0, 2.0];
        let mut result = vec![0.0; 3];

        // Test mismatched lengths
        assert!(ArmSimdOps::add_f32_safe(&a, &b, &mut result).is_err());
        assert!(ArmSimdOps::dot_product_f32_safe(&a, &b).is_err());
    }
}