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
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
//! WebGPU buffer management for ToRSh

#[cfg(feature = "webgpu")]
#[allow(unused_imports)]
use bytemuck;
#[cfg(feature = "webgpu")]
#[allow(unused_imports)]
use wgpu;

use crate::webgpu::{WebGpuDevice, WebGpuError, WebGpuResult};
use crate::{BufferDescriptor, BufferHandle, BufferUsage, MemoryLocation};
use parking_lot::RwLock;
use std::collections::HashMap;
use std::sync::Arc;

/// WebGPU buffer wrapper
#[derive(Debug, Clone)]
pub struct WebGpuBuffer {
    buffer: Arc<wgpu::Buffer>,
    device: Arc<WebGpuDevice>,
    descriptor: BufferDescriptor,
    handle: BufferHandle,
    usage: wgpu::BufferUsages,
    size: u64,
    // Mapping state tracking
    mapping_state: Arc<RwLock<MappingState>>,
}

/// Buffer mapping state
#[derive(Debug, Clone, PartialEq)]
pub enum MappingState {
    Unmapped,
    MappingPending,
    MappedRead,
    MappedWrite,
}

impl WebGpuBuffer {
    /// Create a new WebGPU buffer
    pub fn new(
        device: Arc<WebGpuDevice>,
        descriptor: BufferDescriptor,
        handle: BufferHandle,
    ) -> WebGpuResult<Self> {
        let usage = Self::convert_buffer_usage(&descriptor.usage)?;

        let wgpu_descriptor = wgpu::BufferDescriptor {
            label: Some("WebGPU Buffer"),
            size: descriptor.size as u64,
            usage,
            mapped_at_creation: false,
        };

        let buffer = Arc::new(device.create_buffer(&wgpu_descriptor));
        let size = descriptor.size as u64;

        Ok(Self {
            buffer,
            device,
            descriptor,
            handle,
            usage,
            size,
            mapping_state: Arc::new(RwLock::new(MappingState::Unmapped)),
        })
    }

    /// Create a buffer with initial data
    pub fn with_data<T: bytemuck::Pod>(
        device: Arc<WebGpuDevice>,
        descriptor: BufferDescriptor,
        handle: BufferHandle,
        data: &[T],
    ) -> WebGpuResult<Self> {
        let usage = Self::convert_buffer_usage(&descriptor.usage)?;

        let wgpu_descriptor = wgpu::BufferDescriptor {
            label: Some("WebGPU Buffer"),
            size: descriptor.size as u64,
            usage,
            mapped_at_creation: true,
        };

        let buffer = Arc::new(device.create_buffer(&wgpu_descriptor));

        // Copy initial data
        let data_bytes = bytemuck::cast_slice(data);
        if data_bytes.len() > descriptor.size {
            return Err(WebGpuError::InvalidBufferUsage(format!(
                "Data size {} exceeds buffer size {}",
                data_bytes.len(),
                descriptor.size
            )));
        }

        buffer
            .slice(..)
            .get_mapped_range_mut()
            .slice(..data_bytes.len())
            .copy_from_slice(data_bytes);
        buffer.unmap();
        let size = descriptor.size as u64;

        Ok(Self {
            buffer,
            device,
            descriptor,
            handle,
            usage,
            size,
            mapping_state: Arc::new(RwLock::new(MappingState::Unmapped)),
        })
    }

    /// Get the underlying wgpu buffer
    pub fn wgpu_buffer(&self) -> &wgpu::Buffer {
        &*self.buffer
    }

    /// Consume the WebGpu buffer and return the inner wgpu buffer
    pub fn into_wgpu_buffer(self) -> wgpu::Buffer {
        Arc::try_unwrap(self.buffer.clone()).unwrap_or_else(|arc| (*arc).clone())
    }

    /// Get buffer slice
    pub fn slice<S: std::ops::RangeBounds<wgpu::BufferAddress>>(
        &self,
        bounds: S,
    ) -> wgpu::BufferSlice<'_> {
        self.buffer.slice(bounds)
    }

    /// Map buffer for reading
    pub async fn map_read(&self, offset: u64, size: Option<u64>) -> WebGpuResult<()> {
        if !self.usage.contains(wgpu::BufferUsages::MAP_READ) {
            return Err(WebGpuError::InvalidBufferUsage(
                "Buffer does not support MAP_READ".to_string(),
            ));
        }

        {
            let mut state = self.mapping_state.write();
            if *state != MappingState::Unmapped {
                return Err(WebGpuError::InvalidBufferUsage(format!(
                    "Buffer is already mapped: {:?}",
                    *state
                )));
            }
            *state = MappingState::MappingPending;
        }

        let actual_size = size.unwrap_or(self.size - offset);
        let slice = self.buffer.slice(offset..offset + actual_size);

        // Use the newer wgpu API that requires a callback
        slice.map_async(wgpu::MapMode::Read, |_result| {
            // Callback is handled by wgpu internally
        });

        // Wait for the mapping to complete
        let _ = self.device.device().poll(wgpu::PollType::Wait {
            submission_index: None,
            timeout: None,
        });

        // Check if mapping succeeded by trying to get mapped data
        *self.mapping_state.write() = MappingState::MappedRead;
        Ok(())
    }

    /// Map buffer for writing
    pub async fn map_write(&self, offset: u64, size: Option<u64>) -> WebGpuResult<()> {
        if !self.usage.contains(wgpu::BufferUsages::MAP_WRITE) {
            return Err(WebGpuError::InvalidBufferUsage(
                "Buffer does not support MAP_WRITE".to_string(),
            ));
        }

        {
            let mut state = self.mapping_state.write();
            if *state != MappingState::Unmapped {
                return Err(WebGpuError::InvalidBufferUsage(format!(
                    "Buffer is already mapped: {:?}",
                    *state
                )));
            }
            *state = MappingState::MappingPending;
        }

        let actual_size = size.unwrap_or(self.size - offset);
        let slice = self.buffer.slice(offset..offset + actual_size);

        // Use the newer wgpu API that requires a callback
        slice.map_async(wgpu::MapMode::Write, |_result| {
            // Callback is handled by wgpu internally
        });

        // Wait for the mapping to complete
        let _ = self.device.device().poll(wgpu::PollType::Wait {
            submission_index: None,
            timeout: None,
        });

        // Check if mapping succeeded by trying to get mapped data
        *self.mapping_state.write() = MappingState::MappedWrite;
        Ok(())
    }

    /// Get mapped range for reading
    pub fn mapped_range(&self, offset: u64, size: Option<u64>) -> WebGpuResult<wgpu::BufferView> {
        let state = self.mapping_state.read();
        if *state != MappingState::MappedRead {
            return Err(WebGpuError::InvalidBufferUsage(format!(
                "Buffer is not mapped for reading: {:?}",
                *state
            )));
        }

        let actual_size = size.unwrap_or(self.size - offset);
        let slice = self.buffer.slice(offset..offset + actual_size);
        Ok(slice.get_mapped_range())
    }

    /// Get mapped range for writing
    pub fn mapped_range_mut(
        &self,
        offset: u64,
        size: Option<u64>,
    ) -> WebGpuResult<wgpu::BufferViewMut> {
        let state = self.mapping_state.read();
        if *state != MappingState::MappedWrite {
            return Err(WebGpuError::InvalidBufferUsage(format!(
                "Buffer is not mapped for writing: {:?}",
                *state
            )));
        }

        let actual_size = size.unwrap_or(self.size - offset);
        let slice = self.buffer.slice(offset..offset + actual_size);
        Ok(slice.get_mapped_range_mut())
    }

    /// Unmap the buffer
    pub fn unmap(&self) {
        let mut state = self.mapping_state.write();
        if *state != MappingState::Unmapped {
            self.buffer.unmap();
            *state = MappingState::Unmapped;
        }
    }

    /// Check if buffer is currently mapped
    pub fn is_mapped(&self) -> bool {
        *self.mapping_state.read() != MappingState::Unmapped
    }

    /// Get mapping state
    pub fn mapping_state(&self) -> MappingState {
        self.mapping_state.read().clone()
    }

    /// Write data to buffer (creates temporary staging buffer if needed)
    pub async fn write_data<T: bytemuck::Pod>(&self, offset: u64, data: &[T]) -> WebGpuResult<()> {
        let data_bytes = bytemuck::cast_slice(data);

        if self.usage.contains(wgpu::BufferUsages::MAP_WRITE) {
            // Direct mapping approach
            self.map_write(offset, Some(data_bytes.len() as u64))
                .await?;
            {
                let mut mapped = self.mapped_range_mut(offset, Some(data_bytes.len() as u64))?;
                mapped.copy_from_slice(data_bytes);
            }
            self.unmap();
        } else if self.usage.contains(wgpu::BufferUsages::COPY_DST) {
            // Queue write approach
            self.device
                .queue()
                .write_buffer(&self.buffer, offset, data_bytes);
        } else {
            return Err(WebGpuError::InvalidBufferUsage(
                "Buffer does not support writing".to_string(),
            ));
        }

        Ok(())
    }

    /// Read data from buffer
    pub async fn read_data<T: bytemuck::Pod>(
        &self,
        offset: u64,
        count: usize,
    ) -> WebGpuResult<Vec<T>> {
        if !self.usage.contains(wgpu::BufferUsages::MAP_READ) {
            return Err(WebGpuError::InvalidBufferUsage(
                "Buffer does not support MAP_READ".to_string(),
            ));
        }

        let size = (count * std::mem::size_of::<T>()) as u64;
        self.map_read(offset, Some(size)).await?;

        let result = {
            let mapped = self.mapped_range(offset, Some(size))?;
            let data_slice: &[T] = bytemuck::cast_slice(&mapped);
            data_slice.to_vec()
        };

        self.unmap();
        Ok(result)
    }

    /// Copy data from another buffer
    pub fn copy_from_buffer(
        &self,
        encoder: &mut wgpu::CommandEncoder,
        src: &WebGpuBuffer,
        src_offset: u64,
        dst_offset: u64,
        size: u64,
    ) -> WebGpuResult<()> {
        if !src.usage.contains(wgpu::BufferUsages::COPY_SRC) {
            return Err(WebGpuError::InvalidBufferUsage(
                "Source buffer does not support COPY_SRC".to_string(),
            ));
        }

        if !self.usage.contains(wgpu::BufferUsages::COPY_DST) {
            return Err(WebGpuError::InvalidBufferUsage(
                "Destination buffer does not support COPY_DST".to_string(),
            ));
        }

        encoder.copy_buffer_to_buffer(&src.buffer, src_offset, &self.buffer, dst_offset, size);

        Ok(())
    }

    /// Convert BufferUsage to wgpu::BufferUsages
    fn convert_buffer_usage(usage: &BufferUsage) -> WebGpuResult<wgpu::BufferUsages> {
        let mut wgpu_usage = wgpu::BufferUsages::empty();

        if usage.contains(BufferUsage::STORAGE) {
            wgpu_usage |= wgpu::BufferUsages::STORAGE;
        }
        if usage.contains(BufferUsage::UNIFORM) {
            wgpu_usage |= wgpu::BufferUsages::UNIFORM;
        }
        if usage.contains(BufferUsage::VERTEX) {
            wgpu_usage |= wgpu::BufferUsages::VERTEX;
        }
        if usage.contains(BufferUsage::INDEX) {
            wgpu_usage |= wgpu::BufferUsages::INDEX;
        }
        if usage.contains(BufferUsage::COPY_SRC) {
            wgpu_usage |= wgpu::BufferUsages::COPY_SRC;
        }
        if usage.contains(BufferUsage::COPY_DST) {
            wgpu_usage |= wgpu::BufferUsages::COPY_DST;
        }
        if usage.contains(BufferUsage::MAP_READ) {
            wgpu_usage |= wgpu::BufferUsages::MAP_READ;
        }
        if usage.contains(BufferUsage::MAP_WRITE) {
            wgpu_usage |= wgpu::BufferUsages::MAP_WRITE;
        }

        if wgpu_usage.is_empty() {
            wgpu_usage = wgpu::BufferUsages::STORAGE
                | wgpu::BufferUsages::COPY_SRC
                | wgpu::BufferUsages::COPY_DST;
        }

        Ok(wgpu_usage)
    }
}

// Note: Buffer trait implementation temporarily disabled due to compilation issues
// TODO: Implement proper buffer trait when available
impl WebGpuBuffer {
    pub fn handle(&self) -> BufferHandle {
        self.handle.clone()
    }

    pub fn size(&self) -> u64 {
        self.size
    }

    pub fn usage(&self) -> BufferUsage {
        self.descriptor.usage
    }

    pub fn memory_location(&self) -> MemoryLocation {
        MemoryLocation::Device
    }

    pub fn descriptor(&self) -> &BufferDescriptor {
        &self.descriptor
    }
}

impl Drop for WebGpuBuffer {
    fn drop(&mut self) {
        // Ensure buffer is unmapped before dropping
        self.unmap();

        // Track deallocation
        self.device.track_buffer_deallocation(self.size);
    }
}

/// WebGPU buffer pool for efficient buffer reuse
#[derive(Debug)]
pub struct WebGpuBufferPool {
    device: Arc<WebGpuDevice>,
    pools: RwLock<HashMap<(u64, wgpu::BufferUsages), Vec<wgpu::Buffer>>>,
    next_handle: parking_lot::Mutex<u64>,
}

impl WebGpuBufferPool {
    /// Create a new buffer pool
    pub fn new(device: Arc<WebGpuDevice>) -> Self {
        Self {
            device,
            pools: RwLock::new(HashMap::new()),
            next_handle: parking_lot::Mutex::new(1),
        }
    }

    /// Get or create a buffer from the pool
    pub fn get_buffer(&self, descriptor: BufferDescriptor) -> WebGpuResult<WebGpuBuffer> {
        let usage = WebGpuBuffer::convert_buffer_usage(&descriptor.usage)?;
        let key = (descriptor.size as u64, usage);

        // Try to get from pool first
        {
            let mut pools = self.pools.write();
            if let Some(buffers) = pools.get_mut(&key) {
                if let Some(buffer) = buffers.pop() {
                    let handle = BufferHandle::WebGpu {
                        buffer_ptr: *self.next_handle.lock() as u64,
                        size: descriptor.size,
                    };
                    *self.next_handle.lock() += 1;

                    let size = descriptor.size as u64;
                    return Ok(WebGpuBuffer {
                        buffer: Arc::new(buffer),
                        device: Arc::clone(&self.device),
                        descriptor,
                        handle,
                        usage,
                        size,
                        mapping_state: Arc::new(RwLock::new(MappingState::Unmapped)),
                    });
                }
            }
        }

        // Create new buffer if none available in pool
        let handle = BufferHandle::WebGpu {
            buffer_ptr: *self.next_handle.lock() as u64,
            size: descriptor.size,
        };
        *self.next_handle.lock() += 1;

        WebGpuBuffer::new(Arc::clone(&self.device), descriptor, handle)
    }

    /// Return a buffer to the pool
    pub fn return_buffer(&self, buffer: WebGpuBuffer) {
        let key = (buffer.size, buffer.usage);
        let mut pools = self.pools.write();
        pools
            .entry(key)
            .or_insert_with(Vec::new)
            .push(buffer.into_wgpu_buffer());
    }

    /// Clear all buffers from pool
    pub fn clear(&self) {
        self.pools.write().clear();
    }

    /// Get pool statistics
    pub fn stats(&self) -> HashMap<(u64, wgpu::BufferUsages), usize> {
        let pools = self.pools.read();
        pools.iter().map(|(k, v)| (*k, v.len())).collect()
    }
}

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

    #[tokio::test]
    async fn test_buffer_creation() {
        if cfg!(feature = "webgpu") && crate::webgpu::is_available() {
            if let Ok(device) = WebGpuDevice::from_best_adapter(0).await {
                let device = Arc::new(device);

                let descriptor = BufferDescriptor {
                    size: 1024,
                    usage: BufferUsage::STORAGE | BufferUsage::COPY_SRC | BufferUsage::COPY_DST,
                    location: MemoryLocation::Device,
                    dtype: None,
                    shape: None,
                    initial_data: None,
                    alignment: None,
                    zero_init: false,
                };

                let handle = BufferHandle::WebGpu {
                    buffer_ptr: 1,
                    size: 1024,
                };
                let buffer = WebGpuBuffer::new(device, descriptor, handle);

                assert!(buffer.is_ok());
                if let Ok(buffer) = buffer {
                    assert_eq!(buffer.size(), 1024);
                    assert_eq!(buffer.handle().id(), 1);
                    assert!(!buffer.is_mapped());
                }
            }
        }
    }

    #[test]
    fn test_buffer_usage_conversion() {
        let usage = BufferUsage::STORAGE | BufferUsage::UNIFORM | BufferUsage::COPY_SRC;
        let wgpu_usage =
            WebGpuBuffer::convert_buffer_usage(&usage).expect("Web Gpu Buffer should succeed");

        assert!(wgpu_usage.contains(wgpu::BufferUsages::STORAGE));
        assert!(wgpu_usage.contains(wgpu::BufferUsages::UNIFORM));
        assert!(wgpu_usage.contains(wgpu::BufferUsages::COPY_SRC));
        assert!(!wgpu_usage.contains(wgpu::BufferUsages::MAP_READ));
    }

    #[test]
    fn test_mapping_state() {
        assert_eq!(MappingState::Unmapped, MappingState::Unmapped);
        assert_ne!(MappingState::Unmapped, MappingState::MappedRead);

        let state = MappingState::MappingPending;
        assert_eq!(format!("{:?}", state), "MappingPending");
    }

    #[tokio::test]
    async fn test_buffer_pool() {
        if cfg!(feature = "webgpu") && crate::webgpu::is_available() {
            if let Ok(device) = WebGpuDevice::from_best_adapter(0).await {
                let device = Arc::new(device);
                let pool = WebGpuBufferPool::new(device);

                let descriptor = BufferDescriptor {
                    size: 512,
                    usage: BufferUsage::STORAGE,
                    location: MemoryLocation::Device,
                    dtype: None,
                    shape: None,
                    initial_data: None,
                    alignment: None,
                    zero_init: false,
                };

                // Get buffer from pool (will create new)
                let buffer1 = pool.get_buffer(descriptor.clone());
                assert!(buffer1.is_ok());

                // Return to pool and get again (should reuse)
                if let Ok(buffer1) = buffer1 {
                    let handle1 = buffer1.handle();
                    pool.return_buffer(buffer1);

                    let buffer2 = pool.get_buffer(descriptor);
                    if let Ok(buffer2) = buffer2 {
                        // Handles will be different but buffer should be reused
                        assert_ne!(buffer2.handle(), handle1);
                        assert_eq!(buffer2.size(), 512);
                    }
                }
            }
        }
    }
}