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
//! Error handling for WebGPU backend using unified TorshError

#[cfg(feature = "webgpu")]
use crate::webgpu::wgpu;

use std::fmt;

pub use crate::error::{BackendError, ErrorContext, ErrorContextExt};
pub use torsh_core::error::TorshError;

/// WebGPU-specific error type
#[derive(Debug, Clone)]
pub enum WebGpuError {
    /// No WebGPU adapter found
    NoAdapterFound,
    /// WebGPU not available on this platform
    NotAvailable,
    /// Device creation failed
    DeviceCreation(String),
    /// Buffer creation failed
    BufferCreation(String),
    /// Pipeline creation failed
    PipelineCreation(String),
    /// Shader compilation failed
    ShaderCompilation(String),
    /// Compute pass execution failed
    ComputePassError(String),
    /// Buffer mapping failed
    BufferMapping(String),
    /// Memory allocation failed
    MemoryAllocation(String),
    /// Invalid buffer usage
    InvalidBufferUsage(String),
    /// Invalid workgroup size
    InvalidWorkgroupSize(String),
    /// Unsupported data type
    UnsupportedDataType(String),
    /// Resource not found
    ResourceNotFound(String),
    /// Operation timeout
    OperationTimeout(String),
    /// Device lost
    DeviceLost(String),
    /// Validation failed
    ValidationFailed(String),
    /// Unsupported feature
    UnsupportedFeature(String),
    /// Invalid shader source
    InvalidShaderSource(String),
    /// Invalid argument
    InvalidArgument(String),
    /// Runtime error
    RuntimeError(String),
    /// Initialization error
    InitializationError(String),
    /// Generic backend error
    Backend(String),
}

impl fmt::Display for WebGpuError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            WebGpuError::NoAdapterFound => write!(f, "No WebGPU adapter found"),
            WebGpuError::NotAvailable => write!(f, "WebGPU not available on this platform"),
            WebGpuError::DeviceCreation(msg) => write!(f, "Device creation failed: {}", msg),
            WebGpuError::BufferCreation(msg) => write!(f, "Buffer creation failed: {}", msg),
            WebGpuError::PipelineCreation(msg) => write!(f, "Pipeline creation failed: {}", msg),
            WebGpuError::ShaderCompilation(msg) => write!(f, "Shader compilation failed: {}", msg),
            WebGpuError::ComputePassError(msg) => {
                write!(f, "Compute pass execution failed: {}", msg)
            }
            WebGpuError::BufferMapping(msg) => write!(f, "Buffer mapping failed: {}", msg),
            WebGpuError::MemoryAllocation(msg) => write!(f, "Memory allocation failed: {}", msg),
            WebGpuError::InvalidBufferUsage(msg) => write!(f, "Invalid buffer usage: {}", msg),
            WebGpuError::InvalidWorkgroupSize(msg) => write!(f, "Invalid workgroup size: {}", msg),
            WebGpuError::UnsupportedDataType(msg) => write!(f, "Unsupported data type: {}", msg),
            WebGpuError::ResourceNotFound(msg) => write!(f, "Resource not found: {}", msg),
            WebGpuError::OperationTimeout(msg) => write!(f, "Operation timeout: {}", msg),
            WebGpuError::DeviceLost(msg) => write!(f, "Device lost: {}", msg),
            WebGpuError::ValidationFailed(msg) => write!(f, "Validation failed: {}", msg),
            WebGpuError::UnsupportedFeature(msg) => write!(f, "Unsupported feature: {}", msg),
            WebGpuError::InvalidShaderSource(msg) => write!(f, "Invalid shader source: {}", msg),
            WebGpuError::InvalidArgument(msg) => write!(f, "Invalid argument: {}", msg),
            WebGpuError::RuntimeError(msg) => write!(f, "Runtime error: {}", msg),
            WebGpuError::InitializationError(msg) => write!(f, "Initialization error: {}", msg),
            WebGpuError::Backend(msg) => write!(f, "Backend error: {}", msg),
        }
    }
}

impl std::error::Error for WebGpuError {}

impl From<WebGpuError> for TorshError {
    fn from(err: WebGpuError) -> Self {
        match err {
            WebGpuError::NoAdapterFound => {
                TorshError::BackendError("No WebGPU adapter found".to_string())
            }
            WebGpuError::NotAvailable => {
                TorshError::BackendError("WebGPU not available".to_string())
            }
            WebGpuError::DeviceCreation(msg) => {
                TorshError::BackendError(format!("Device creation failed: {}", msg))
            }
            WebGpuError::BufferCreation(msg) => {
                TorshError::AllocationError(format!("Buffer creation failed: {}", msg))
            }
            WebGpuError::PipelineCreation(msg) => {
                TorshError::ComputeError(format!("Pipeline creation failed: {}", msg))
            }
            WebGpuError::ShaderCompilation(msg) => {
                TorshError::ComputeError(format!("Shader compilation failed: {}", msg))
            }
            WebGpuError::ComputePassError(msg) => {
                TorshError::ComputeError(format!("Compute pass execution failed: {}", msg))
            }
            WebGpuError::BufferMapping(msg) => {
                TorshError::ComputeError(format!("Buffer mapping failed: {}", msg))
            }
            WebGpuError::MemoryAllocation(msg) => {
                TorshError::AllocationError(format!("Memory allocation failed: {}", msg))
            }
            WebGpuError::InvalidBufferUsage(msg) => {
                TorshError::InvalidArgument(format!("Invalid buffer usage: {}", msg))
            }
            WebGpuError::InvalidWorkgroupSize(msg) => {
                TorshError::InvalidArgument(format!("Invalid workgroup size: {}", msg))
            }
            WebGpuError::UnsupportedDataType(msg) => {
                TorshError::InvalidArgument(format!("Unsupported data type: {}", msg))
            }
            WebGpuError::ResourceNotFound(msg) => {
                TorshError::BackendError(format!("Resource not found: {}", msg))
            }
            WebGpuError::OperationTimeout(msg) => {
                TorshError::BackendError(format!("Operation timeout: {}", msg))
            }
            WebGpuError::DeviceLost(msg) => {
                TorshError::BackendError(format!("Device lost: {}", msg))
            }
            WebGpuError::ValidationFailed(msg) => {
                TorshError::InvalidArgument(format!("Validation failed: {}", msg))
            }
            WebGpuError::UnsupportedFeature(msg) => {
                TorshError::InvalidArgument(format!("Unsupported feature: {}", msg))
            }
            WebGpuError::InvalidShaderSource(msg) => {
                TorshError::ComputeError(format!("Invalid shader source: {}", msg))
            }
            WebGpuError::InvalidArgument(msg) => {
                TorshError::InvalidArgument(format!("Invalid argument: {}", msg))
            }
            WebGpuError::RuntimeError(msg) => {
                TorshError::BackendError(format!("Runtime error: {}", msg))
            }
            WebGpuError::InitializationError(msg) => {
                TorshError::BackendError(format!("Initialization error: {}", msg))
            }
            WebGpuError::Backend(msg) => {
                TorshError::BackendError(format!("Backend error: {}", msg))
            }
        }
    }
}

/// Result type for WebGPU operations
pub type WebGpuResult<T> = Result<T, WebGpuError>;

/// Validate workgroup size against device limits
pub fn validate_workgroup_size(
    workgroup_size: (u32, u32, u32),
    limits: &wgpu::Limits,
) -> WebGpuResult<()> {
    let (x, y, z) = workgroup_size;

    if x > limits.max_compute_workgroup_size_x {
        return Err(WebGpuError::InvalidWorkgroupSize(format!(
            "Workgroup size X ({}) exceeds limit ({})",
            x, limits.max_compute_workgroup_size_x
        )));
    }

    if y > limits.max_compute_workgroup_size_y {
        return Err(WebGpuError::InvalidWorkgroupSize(format!(
            "Workgroup size Y ({}) exceeds limit ({})",
            y, limits.max_compute_workgroup_size_y
        )));
    }

    if z > limits.max_compute_workgroup_size_z {
        return Err(WebGpuError::InvalidWorkgroupSize(format!(
            "Workgroup size Z ({}) exceeds limit ({})",
            z, limits.max_compute_workgroup_size_z
        )));
    }

    let total_size = x as u64 * y as u64 * z as u64;
    if total_size > limits.max_compute_invocations_per_workgroup as u64 {
        return Err(WebGpuError::InvalidWorkgroupSize(format!(
            "Total workgroup invocations ({}) exceeds limit ({})",
            total_size, limits.max_compute_invocations_per_workgroup
        )));
    }

    Ok(())
}

/// Helper functions for WebGPU-specific error creation
pub mod webgpu_errors {
    use super::*;
    use torsh_core::DType;

    /// Create a "no adapter found" error with context
    pub fn no_adapter_found_error() -> TorshError {
        let context = ErrorContext::new("adapter_enumeration")
            .with_backend("WebGPU")
            .with_details("No WebGPU adapter found");

        TorshError::BackendError(context.format())
    }

    /// Create a device creation error with context
    pub fn device_creation_error(
        message: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("device_creation")
            .with_backend("WebGPU")
            .with_details(format!("Device creation failed: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::BackendError(context.format())
    }

    /// Create a buffer creation error with context
    pub fn buffer_creation_error(
        message: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("buffer_creation")
            .with_backend("WebGPU")
            .with_details(format!("Buffer creation failed: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::AllocationError(context.format())
    }

    /// Create a pipeline creation error with context
    pub fn pipeline_creation_error(
        message: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("pipeline_creation")
            .with_backend("WebGPU")
            .with_details(format!("Pipeline creation failed: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::ComputeError(context.format())
    }

    /// Create a shader compilation error with context
    pub fn shader_compilation_error(
        message: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("shader_compilation")
            .with_backend("WebGPU")
            .with_details(format!("Shader compilation failed: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::ComputeError(context.format())
    }

    /// Create a compute pass execution error with context
    pub fn compute_pass_error(message: impl Into<String>, device_id: Option<usize>) -> TorshError {
        let mut context = ErrorContext::new("compute_pass")
            .with_backend("WebGPU")
            .with_details(format!("Compute pass execution failed: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::ComputeError(context.format())
    }

    /// Create a buffer mapping error with context
    pub fn buffer_mapping_error(
        message: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("buffer_mapping")
            .with_backend("WebGPU")
            .with_details(format!("Buffer mapping failed: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::ComputeError(context.format())
    }

    /// Create a memory allocation error with context
    pub fn memory_allocation_error(
        size: u64,
        alignment: u64,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("memory_allocation")
            .with_backend("WebGPU")
            .with_details(format!(
                "Memory allocation failed: size={}, alignment={}",
                size, alignment
            ));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::AllocationError(context.format())
    }

    /// Create an invalid buffer usage error with context
    pub fn invalid_buffer_usage_error(
        usage: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("buffer_usage_validation")
            .with_backend("WebGPU")
            .with_details(format!("Invalid buffer usage: {}", usage.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::InvalidArgument(context.format())
    }

    /// Create an invalid workgroup size error with context
    pub fn invalid_workgroup_size_error(
        size: (u32, u32, u32),
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("workgroup_size_validation")
            .with_backend("WebGPU")
            .with_details(format!("Invalid compute workgroup size: {:?}", size));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::InvalidArgument(context.format())
    }

    /// Create an unsupported data type error with context
    pub fn unsupported_datatype_error(dtype: DType, device_id: Option<usize>) -> TorshError {
        let mut context = ErrorContext::new("datatype_validation")
            .with_backend("WebGPU")
            .with_details(format!("Unsupported data type: {:?}", dtype));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::InvalidArgument(context.format())
    }

    /// Create a resource not found error with context
    pub fn resource_not_found_error(
        resource: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("resource_lookup")
            .with_backend("WebGPU")
            .with_details(format!("Resource not found: {}", resource.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::BackendError(context.format())
    }

    /// Create an operation timeout error with context
    pub fn operation_timeout_error(
        operation: impl Into<String>,
        device_id: Option<usize>,
    ) -> TorshError {
        let mut context = ErrorContext::new("operation_timeout")
            .with_backend("WebGPU")
            .with_details(format!("Operation timeout: {}", operation.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::BackendError(context.format())
    }

    /// Create a device lost error with context
    pub fn device_lost_error(message: impl Into<String>, device_id: Option<usize>) -> TorshError {
        let mut context = ErrorContext::new("device_lost")
            .with_backend("WebGPU")
            .with_details(format!("Device lost: {}", message.into()));

        if let Some(device_id) = device_id {
            context = context.with_device(format!("wgpu:{}", device_id));
        }

        TorshError::BackendError(context.format())
    }
}