torsh-backend 0.1.2

Backend abstraction layer for ToRSh
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
//! CUDA buffer implementation

use crate::cuda::cuda_sys_compat as cuda_sys;
use crate::cuda::device::CudaDevice;
use crate::cuda::error::{CudaError, CudaResult};
use crate::cuda::memory::{CudaAllocation, SendSyncPtr};
use crate::cuda::stream::CudaStream;
#[allow(unused_imports)]
use crate::{Buffer, BufferError};
use std::ffi::c_void;
use std::sync::Arc;
use torsh_core::DType;

/// Device pointer type alias using our thread-safe wrapper
pub type BufferDevicePtr<T> = SendSyncPtr<T>;

/// CUDA buffer implementation
#[derive(Debug, Clone)]
pub struct CudaBuffer<T> {
    allocation: CudaAllocation,
    length: usize,
    dtype: DType,
    device: Arc<CudaDevice>,
    _phantom: std::marker::PhantomData<T>,
}

impl<T: Clone + Send + Sync + 'static> CudaBuffer<T> {
    /// Create new CUDA buffer
    pub fn new(device: Arc<CudaDevice>, length: usize, dtype: DType) -> CudaResult<Self> {
        let size = length * std::mem::size_of::<T>();
        let allocation = device.memory_manager().allocate(size)?;

        Ok(Self {
            allocation,
            length,
            dtype,
            device,
            _phantom: std::marker::PhantomData,
        })
    }

    /// Create buffer from existing allocation
    pub fn from_allocation(
        device: Arc<CudaDevice>,
        allocation: CudaAllocation,
        length: usize,
        dtype: DType,
    ) -> Self {
        Self {
            allocation,
            length,
            dtype,
            device,
            _phantom: std::marker::PhantomData,
        }
    }

    /// Get device pointer as typed SendSyncPtr
    pub fn device_ptr(&self) -> BufferDevicePtr<T> {
        // Cast the u8 pointer to T pointer
        SendSyncPtr::new(self.allocation.as_ptr() as *mut T)
    }

    /// Get raw device pointer
    pub fn raw_ptr(&self) -> *mut u8 {
        self.allocation.as_ptr()
    }

    /// Copy data from host to device
    pub fn copy_from_host(&mut self, data: &[T]) -> CudaResult<()> {
        if data.len() != self.length {
            return Err(CudaError::Memory {
                message: format!(
                    "Data length mismatch: expected {}, got {}",
                    self.length,
                    data.len()
                ),
            });
        }

        unsafe {
            let result = cuda_sys::cudaMemcpy(
                self.allocation.as_ptr() as *mut c_void,
                data.as_ptr() as *const c_void,
                data.len() * std::mem::size_of::<T>(),
                cuda_sys::cudaMemcpyKind_cudaMemcpyHostToDevice,
            );

            if result != crate::cuda::cudaSuccess {
                return Err(CudaError::Memory {
                    message: format!("Host-to-device copy failed: {:?}", result),
                });
            }
        }

        Ok(())
    }

    /// Copy data from host to device asynchronously
    pub fn copy_from_host_async(&mut self, data: &[T], stream: &CudaStream) -> CudaResult<()> {
        if data.len() != self.length {
            return Err(CudaError::Memory {
                message: format!(
                    "Data length mismatch: expected {}, got {}",
                    self.length,
                    data.len()
                ),
            });
        }

        unsafe {
            let result = cuda_sys::cudaMemcpyAsync(
                self.allocation.as_ptr() as *mut c_void,
                data.as_ptr() as *const c_void,
                data.len() * std::mem::size_of::<T>(),
                cuda_sys::cudaMemcpyKind_cudaMemcpyHostToDevice,
                stream.stream(),
            );

            if result != crate::cuda::cudaSuccess {
                return Err(CudaError::Memory {
                    message: format!("Async host-to-device copy failed: {:?}", result),
                });
            }
        }

        Ok(())
    }

    /// Copy data from device to host
    pub fn copy_to_host(&self, data: &mut [T]) -> CudaResult<()> {
        if data.len() != self.length {
            return Err(CudaError::Memory {
                message: format!(
                    "Data length mismatch: expected {}, got {}",
                    self.length,
                    data.len()
                ),
            });
        }

        unsafe {
            let result = cuda_sys::cudaMemcpy(
                data.as_mut_ptr() as *mut c_void,
                self.allocation.as_ptr() as *const c_void,
                data.len() * std::mem::size_of::<T>(),
                cuda_sys::cudaMemcpyKind_cudaMemcpyDeviceToHost,
            );

            if result != crate::cuda::cudaSuccess {
                return Err(CudaError::Memory {
                    message: format!("Device-to-host copy failed: {:?}", result),
                });
            }
        }

        Ok(())
    }

    /// Copy data from device to host asynchronously
    pub fn copy_to_host_async(&self, data: &mut [T], stream: &CudaStream) -> CudaResult<()> {
        if data.len() != self.length {
            return Err(CudaError::Memory {
                message: format!(
                    "Data length mismatch: expected {}, got {}",
                    self.length,
                    data.len()
                ),
            });
        }

        unsafe {
            let result = cuda_sys::cudaMemcpyAsync(
                data.as_mut_ptr() as *mut c_void,
                self.allocation.as_ptr() as *const c_void,
                data.len() * std::mem::size_of::<T>(),
                cuda_sys::cudaMemcpyKind_cudaMemcpyDeviceToHost,
                stream.stream(),
            );

            if result != crate::cuda::cudaSuccess {
                return Err(CudaError::Memory {
                    message: format!("Async device-to-host copy failed: {:?}", result),
                });
            }
        }

        Ok(())
    }

    /// Copy from another CUDA buffer
    pub fn copy_from_buffer(&mut self, src: &CudaBuffer<T>) -> CudaResult<()> {
        if self.length != src.length {
            return Err(CudaError::Memory {
                message: format!(
                    "Buffer length mismatch: expected {}, got {}",
                    self.length, src.length
                ),
            });
        }

        unsafe {
            let result = cuda_sys::cudaMemcpy(
                self.allocation.as_ptr() as *mut c_void,
                src.allocation.as_ptr() as *const c_void,
                self.length * std::mem::size_of::<T>(),
                cuda_sys::cudaMemcpyKind_cudaMemcpyDeviceToDevice,
            );

            if result != crate::cuda::cudaSuccess {
                return Err(CudaError::Memory {
                    message: format!("Device-to-device copy failed: {:?}", result),
                });
            }
        }

        Ok(())
    }

    /// Copy from another CUDA buffer (alias for copy_from_buffer)
    pub fn copy_from(&mut self, src: &CudaBuffer<T>) -> CudaResult<()> {
        self.copy_from_buffer(src)
    }

    /// Copy from another CUDA buffer asynchronously
    pub fn copy_from_buffer_async(
        &mut self,
        src: &CudaBuffer<T>,
        stream: &CudaStream,
    ) -> CudaResult<()> {
        if self.length != src.length {
            return Err(CudaError::Memory {
                message: format!(
                    "Buffer length mismatch: expected {}, got {}",
                    self.length, src.length
                ),
            });
        }

        unsafe {
            let result = cuda_sys::cudaMemcpyAsync(
                self.allocation.as_ptr() as *mut c_void,
                src.allocation.as_ptr() as *const c_void,
                self.length * std::mem::size_of::<T>(),
                cuda_sys::cudaMemcpyKind_cudaMemcpyDeviceToDevice,
                stream.stream(),
            );

            if result != crate::cuda::cudaSuccess {
                return Err(CudaError::Memory {
                    message: format!("Async device-to-device copy failed: {:?}", result),
                });
            }
        }

        Ok(())
    }

    /// Fill buffer with value
    pub fn fill(&mut self, value: T) -> CudaResult<()>
    where
        T: Copy,
    {
        // For now, use host-side fill and copy
        let data = vec![value; self.length];
        self.copy_from_host(&data)
    }

    /// Get buffer size in bytes
    pub fn size_bytes(&self) -> usize {
        self.allocation.size()
    }

    /// Get element count
    pub fn len(&self) -> usize {
        self.length
    }

    /// Check if buffer is empty
    pub fn is_empty(&self) -> bool {
        self.length == 0
    }

    /// Get data type
    pub fn dtype(&self) -> DType {
        self.dtype
    }

    /// Get device
    pub fn device(&self) -> &Arc<CudaDevice> {
        &self.device
    }
}

// TODO: Implement Buffer trait when it's defined in the codebase
// Currently Buffer is a struct, not a trait, so this implementation is commented out
/*
impl<T: Clone + Send + Sync + 'static> Buffer<T> for CudaBuffer<T> {
    fn len(&self) -> usize {
        self.length
    }

    fn is_empty(&self) -> bool {
        self.length == 0
    }

    fn capacity(&self) -> usize {
        self.allocation.size() / std::mem::size_of::<T>()
    }

    fn dtype(&self) -> DType {
        self.dtype
    }

    fn device_type(&self) -> crate::DeviceType {
        self.device.device_type()
    }

    fn clone_empty(&self, length: usize) -> Result<Box<dyn Buffer<T>>, BufferError> {
        let buffer =
            CudaBuffer::new(Arc::clone(&self.device), length, self.dtype).map_err(|e| {
                BufferError::AllocationFailed {
                    message: e.to_string(),
                }
            })?;

        Ok(Box::new(buffer))
    }

    fn copy_from_slice(&mut self, data: &[T]) -> Result<(), BufferError> {
        self.copy_from_host(data)
            .map_err(|e| BufferError::CopyFailed {
                message: e.to_string(),
            })
    }

    fn copy_to_slice(&self, data: &mut [T]) -> Result<(), BufferError> {
        self.copy_to_host(data)
            .map_err(|e| BufferError::CopyFailed {
                message: e.to_string(),
            })
    }

    fn copy_from_buffer(&mut self, src: &dyn Buffer<T>) -> Result<(), BufferError> {
        if let Some(cuda_src) = src.as_any().downcast_ref::<CudaBuffer<T>>() {
            self.copy_from_buffer(cuda_src)
                .map_err(|e| BufferError::CopyFailed {
                    message: e.to_string(),
                })
        } else {
            // Cross-device copy via host memory
            let mut temp = vec![T::default(); src.len()];
            src.copy_to_slice(&mut temp)?;
            self.copy_from_slice(&temp)
        }
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}
*/

impl<T> Drop for CudaBuffer<T> {
    fn drop(&mut self) {
        // Memory will be returned to pool automatically when allocation is dropped
        if let Err(e) = self
            .device
            .memory_manager()
            .deallocate(self.allocation.clone())
        {
            tracing::warn!("Failed to deallocate CUDA buffer: {}", e);
        }
    }
}

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

    #[test]
    fn test_cuda_buffer_creation() {
        if crate::is_available() {
            let device = Arc::new(CudaDevice::new(0).expect("Arc should succeed"));
            let buffer = CudaBuffer::<f32>::new(device, 1024, DType::F32);

            assert!(buffer.is_ok());
            let buffer = buffer.expect("operation should succeed");
            assert_eq!(buffer.len(), 1024);
            assert_eq!(buffer.dtype(), DType::F32);
        }
    }

    #[test]
    fn test_host_device_copy() {
        if crate::is_available() {
            let device = Arc::new(CudaDevice::new(0).expect("Arc should succeed"));
            let mut buffer = CudaBuffer::<f32>::new(device, 4, DType::F32)
                .expect("construction with valid parameters should succeed");

            let host_data = vec![1.0, 2.0, 3.0, 4.0];
            buffer
                .copy_from_host(&host_data)
                .expect("copy from host memory should succeed");

            let mut result = vec![0.0; 4];
            buffer
                .copy_to_host(&mut result)
                .expect("copy to host memory should succeed");

            assert_eq!(host_data, result);
        }
    }

    #[test]
    fn test_buffer_copy() {
        if crate::is_available() {
            let device = Arc::new(CudaDevice::new(0).expect("Arc should succeed"));
            let mut src = CudaBuffer::<f32>::new(Arc::clone(&device), 4, DType::F32)
                .expect("operation should succeed");
            let mut dst = CudaBuffer::<f32>::new(Arc::clone(&device), 4, DType::F32)
                .expect("operation should succeed");

            let host_data = vec![1.0, 2.0, 3.0, 4.0];
            src.copy_from_host(&host_data)
                .expect("copy from host memory should succeed");
            dst.copy_from_buffer(&src)
                .expect("buffer copy should succeed");

            let mut result = vec![0.0; 4];
            dst.copy_to_host(&mut result)
                .expect("copy to host memory should succeed");

            assert_eq!(host_data, result);
        }
    }
}