tenflowers-core 0.1.1

Core tensor operations and execution engine for TenfloweRS
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
use crate::ops::binary::{AddOp, BinaryOp, DivOp, MulOp, PReLUOp, PowOp, SubOp};
#[cfg(feature = "gpu")]
use crate::ops::hybrid_scheduler::{HybridWorkScheduler, WorkItem, WorkType};

// Re-export WorkPriority for public API
#[cfg(feature = "gpu")]
pub use crate::ops::hybrid_scheduler::WorkPriority;
#[cfg(test)]
use crate::tensor::TensorStorage;
/// Async binary operations with CPU-GPU overlap using hybrid scheduler
use crate::{Device, Result, Tensor, TensorError};

#[cfg(not(feature = "gpu"))]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum WorkPriority {
    Low = 0,
    Normal = 1,
    High = 2,
    Critical = 3,
}

use crate::device::async_execution::AsyncExecutor;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll};

#[cfg(feature = "gpu")]
use crate::gpu::multi_stream_executor::MultiStreamGpuExecutor;

/// Async binary operation future
pub struct AsyncBinaryOpFuture<T> {
    inner: Pin<Box<dyn Future<Output = Result<Tensor<T>>> + Send>>,
}

impl<T> Future for AsyncBinaryOpFuture<T> {
    type Output = Result<Tensor<T>>;

    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        self.inner.as_mut().poll(cx)
    }
}

/// Async binary operation executor with CPU-GPU overlap
pub struct AsyncBinaryOperationExecutor {
    #[cfg(feature = "gpu")]
    hybrid_scheduler: Option<Arc<HybridWorkScheduler>>,
    #[cfg(not(feature = "gpu"))]
    cpu_executor: Arc<AsyncExecutor>,
}

impl AsyncBinaryOperationExecutor {
    /// Create a new async binary operation executor
    #[cfg(feature = "gpu")]
    pub fn new(device_id: usize) -> Result<Self> {
        // Create CPU executor
        let cpu_executor = Arc::new(AsyncExecutor::new(Device::Cpu));

        // Create GPU executor
        let gpu_ctx = crate::device::context::get_gpu_context(device_id)?;
        let gpu_executor = Arc::new(MultiStreamGpuExecutor::new(
            gpu_ctx.device.clone(),
            gpu_ctx.queue.clone(),
        ));

        // Create hybrid scheduler
        let hybrid_scheduler = Arc::new(HybridWorkScheduler::new(cpu_executor, gpu_executor));

        Ok(Self {
            hybrid_scheduler: Some(hybrid_scheduler),
        })
    }

    /// Create a new async binary operation executor (CPU-only)
    #[cfg(not(feature = "gpu"))]
    pub fn new(_device_id: usize) -> Result<Self> {
        let cpu_executor = Arc::new(AsyncExecutor::new(Device::Cpu));
        Ok(Self { cpu_executor })
    }

    /// Execute an async binary operation with CPU-GPU overlap
    pub fn execute_async<T, Op>(
        &self,
        a: &Tensor<T>,
        b: &Tensor<T>,
        op: Op,
    ) -> AsyncBinaryOpFuture<T>
    where
        T: Clone
            + Default
            + scirs2_core::num_traits::Zero
            + Send
            + Sync
            + 'static
            + bytemuck::Pod
            + bytemuck::Zeroable,
        Op: BinaryOp<T> + Send + Sync + 'static,
    {
        #[cfg(feature = "gpu")]
        {
            if let Some(ref scheduler) = self.hybrid_scheduler {
                // Create work item for the operation
                let input_size = a.shape().elements() + b.shape().elements();
                let dtype = std::any::type_name::<T>();

                let work_item = scheduler.create_binary_op_work(
                    op.name(),
                    input_size,
                    dtype,
                    crate::ops::hybrid_scheduler::WorkPriority::Normal,
                );

                // Clone tensors and operation for async execution
                let a_clone = a.clone();
                let b_clone = b.clone();
                let scheduler_clone = Arc::clone(scheduler);

                let future = async move {
                    // Submit work to hybrid scheduler
                    let work_future = scheduler_clone.submit_work(work_item);

                    // Execute the actual operation concurrently
                    let result = std::thread::spawn(move || {
                        crate::ops::binary::binary_op(&a_clone, &b_clone, op)
                    })
                    .join();

                    // Wait for scheduler to complete
                    work_future.await?;

                    // Return the result
                    result.map_err(|e| {
                        TensorError::compute_error_simple(format!(
                            "Async execution failed: {:?}",
                            e
                        ))
                    })?
                };

                return AsyncBinaryOpFuture {
                    inner: Box::pin(future),
                };
            }
        }

        // Fallback to CPU-only execution
        let a_clone = a.clone();
        let b_clone = b.clone();
        let future = async move {
            std::thread::spawn(move || crate::ops::binary::binary_op(&a_clone, &b_clone, op))
                .join()
                .map_err(|e| {
                    TensorError::compute_error_simple(format!("Async execution failed: {e:?}"))
                })?
        };

        AsyncBinaryOpFuture {
            inner: Box::pin(future),
        }
    }

    /// Execute an async binary operation with custom priority
    pub fn execute_async_with_priority<T, Op>(
        &self,
        a: &Tensor<T>,
        b: &Tensor<T>,
        op: Op,
        _priority: WorkPriority,
    ) -> AsyncBinaryOpFuture<T>
    where
        T: Clone
            + Default
            + scirs2_core::num_traits::Zero
            + Send
            + Sync
            + 'static
            + bytemuck::Pod
            + bytemuck::Zeroable,
        Op: BinaryOp<T> + Send + Sync + 'static,
    {
        // Create work item with custom priority
        let _input_size = a.shape().elements() + b.shape().elements();
        let _dtype = std::any::type_name::<T>();

        #[cfg(feature = "gpu")]
        {
            if let Some(ref scheduler) = self.hybrid_scheduler {
                let work_item =
                    scheduler.create_binary_op_work(op.name(), _input_size, _dtype, _priority);

                // Clone tensors and operation for async execution
                let a_clone = a.clone();
                let b_clone = b.clone();
                let scheduler_clone = Arc::clone(scheduler);

                let future = async move {
                    // Submit work to hybrid scheduler with custom priority
                    let work_future = scheduler_clone.submit_work(work_item);

                    // Execute the actual operation concurrently
                    let result = std::thread::spawn(move || {
                        crate::ops::binary::binary_op(&a_clone, &b_clone, op)
                    })
                    .join();

                    // Wait for scheduler to complete
                    work_future.await?;

                    // Return the result
                    result.map_err(|e| {
                        TensorError::compute_error_simple(format!(
                            "Async execution failed: {:?}",
                            e
                        ))
                    })?
                };

                return AsyncBinaryOpFuture {
                    inner: Box::pin(future),
                };
            }
        }

        // Fallback to CPU-only execution
        let a_clone = a.clone();
        let b_clone = b.clone();
        let future = async move {
            std::thread::spawn(move || crate::ops::binary::binary_op(&a_clone, &b_clone, op))
                .join()
                .map_err(|e| {
                    TensorError::compute_error_simple(format!("Async execution failed: {e:?}"))
                })?
        };

        AsyncBinaryOpFuture {
            inner: Box::pin(future),
        }
    }

    /// Execute multiple binary operations concurrently with CPU-GPU overlap
    pub async fn execute_batch_async<T, Op>(
        &self,
        operations: Vec<(&Tensor<T>, &Tensor<T>, Op)>,
    ) -> Result<Vec<Tensor<T>>>
    where
        T: Clone
            + Default
            + scirs2_core::num_traits::Zero
            + Send
            + Sync
            + 'static
            + bytemuck::Pod
            + bytemuck::Zeroable,
        Op: BinaryOp<T> + Send + Sync + Clone + 'static,
    {
        let mut futures = Vec::new();

        for (a, b, op) in operations {
            let future = self.execute_async(a, b, op);
            futures.push(future);
        }

        // Execute all operations concurrently
        let mut results = Vec::new();
        for future in futures {
            results.push(future.await?);
        }

        Ok(results)
    }

    /// Synchronize all pending operations
    pub fn synchronize(&self) {
        #[cfg(feature = "gpu")]
        {
            if let Some(ref scheduler) = self.hybrid_scheduler {
                scheduler.synchronize_all();
            }
        }
    }

    /// Check if executor is idle
    pub fn is_idle(&self) -> bool {
        #[cfg(feature = "gpu")]
        {
            if let Some(ref scheduler) = self.hybrid_scheduler {
                return scheduler.is_idle();
            }
        }

        #[cfg(not(feature = "gpu"))]
        {
            self.cpu_executor.queue_length() == 0
        }

        #[cfg(feature = "gpu")]
        true
    }
}

/// Global async binary operation executor
static GLOBAL_ASYNC_EXECUTOR: std::sync::OnceLock<AsyncBinaryOperationExecutor> =
    std::sync::OnceLock::new();

/// Get the global async binary operation executor
pub fn global_async_executor() -> &'static AsyncBinaryOperationExecutor {
    GLOBAL_ASYNC_EXECUTOR.get_or_init(|| {
        AsyncBinaryOperationExecutor::new(0).unwrap_or_else(|_| {
            // Fallback to CPU-only if GPU initialization fails
            #[cfg(not(feature = "gpu"))]
            {
                AsyncBinaryOperationExecutor::new(0)
                    .expect("CPU-only async binary executor initialization must succeed")
            }
            #[cfg(feature = "gpu")]
            {
                // Create a fallback CPU-only executor
                AsyncBinaryOperationExecutor {
                    hybrid_scheduler: None,
                }
            }
        })
    })
}

/// Async binary operation functions using the global executor
/// Async add operation
pub async fn add_async<T>(a: &Tensor<T>, b: &Tensor<T>) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Add<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor().execute_async(a, b, AddOp).await
}

/// Async sub operation
pub async fn sub_async<T>(a: &Tensor<T>, b: &Tensor<T>) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Sub<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor().execute_async(a, b, SubOp).await
}

/// Async mul operation
pub async fn mul_async<T>(a: &Tensor<T>, b: &Tensor<T>) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Mul<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor().execute_async(a, b, MulOp).await
}

/// Async div operation
pub async fn div_async<T>(a: &Tensor<T>, b: &Tensor<T>) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Div<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor().execute_async(a, b, DivOp).await
}

/// Async pow operation
pub async fn pow_async<T>(a: &Tensor<T>, b: &Tensor<T>) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + scirs2_core::num_traits::Float
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor().execute_async(a, b, PowOp).await
}

/// Async PReLU operation
pub async fn prelu_async<T>(a: &Tensor<T>, b: &Tensor<T>) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + scirs2_core::num_traits::Float
        + PartialOrd
        + std::ops::Mul<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor().execute_async(a, b, PReLUOp).await
}

/// Async add operation with priority
pub async fn add_async_priority<T>(
    a: &Tensor<T>,
    b: &Tensor<T>,
    priority: WorkPriority,
) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Add<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor()
        .execute_async_with_priority(a, b, AddOp, priority)
        .await
}

/// Async mul operation with priority
pub async fn mul_async_priority<T>(
    a: &Tensor<T>,
    b: &Tensor<T>,
    priority: WorkPriority,
) -> Result<Tensor<T>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Mul<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    global_async_executor()
        .execute_async_with_priority(a, b, MulOp, priority)
        .await
}

/// Batch processing for multiple operations
pub async fn batch_add_async<T>(operations: Vec<(&Tensor<T>, &Tensor<T>)>) -> Result<Vec<Tensor<T>>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Add<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    let ops: Vec<_> = operations.into_iter().map(|(a, b)| (a, b, AddOp)).collect();
    global_async_executor().execute_batch_async(ops).await
}

/// Batch processing for multiple multiplication operations
pub async fn batch_mul_async<T>(operations: Vec<(&Tensor<T>, &Tensor<T>)>) -> Result<Vec<Tensor<T>>>
where
    T: Clone
        + Default
        + scirs2_core::num_traits::Zero
        + std::ops::Mul<Output = T>
        + Send
        + Sync
        + 'static
        + bytemuck::Pod
        + bytemuck::Zeroable,
{
    let ops: Vec<_> = operations.into_iter().map(|(a, b)| (a, b, MulOp)).collect();
    global_async_executor().execute_batch_async(ops).await
}

/// Synchronize all async operations
pub fn synchronize_async_operations() {
    global_async_executor().synchronize();
}

/// Check if async operations are idle
pub fn is_async_operations_idle() -> bool {
    global_async_executor().is_idle()
}

#[cfg(test)]
#[allow(irrefutable_let_patterns)] // Pattern matching on TensorStorage is irrefutable when GPU feature is disabled
mod tests {
    use super::*;
    use crate::Tensor;

    #[test]
    fn test_async_executor_creation() {
        let executor = AsyncBinaryOperationExecutor::new(0).expect("test: new should succeed");

        // Test that executor starts idle
        assert!(executor.is_idle());
    }

    #[test]
    fn test_sync_fallback() {
        let a = Tensor::<f32>::from_vec(vec![1.0, 2.0, 3.0], &[3])
            .expect("test: from_vec should succeed");
        let b = Tensor::<f32>::from_vec(vec![4.0, 5.0, 6.0], &[3])
            .expect("test: from_vec should succeed");

        // Test that sync operations still work
        let result = crate::ops::add(&a, &b).expect("test: add should succeed");
        let expected = vec![5.0, 7.0, 9.0];

        if let TensorStorage::Cpu(arr) = &result.storage {
            assert_eq!(
                arr.as_slice().expect("tensor should be contiguous"),
                &expected
            );
        }
    }

    #[test]
    fn test_work_priority_ordering() {
        let high = self::WorkPriority::High;
        let normal = self::WorkPriority::Normal;
        let low = self::WorkPriority::Low;

        assert!(high > normal);
        assert!(normal > low);
    }
}