primal-barracuda 0.4.0

barraCuda — BARrier-free Rust Abstracted Cross-platform Unified Dimensional Algebra. Vendor-agnostic GPU compute via WGSL.
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
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Grouped `Conv2D` - Convolution with channel groups (Pure WGSL)
//!
//! Divides input/output channels into groups, reducing parameters
//! Used in `ResNeXt`, `ShuffleNet`, `MobileNet` architectures
//!
//! **Deep Debt Principles**:
//! - Pure WGSL implementation (no CPU code)
//! - Safe Rust wrapper (no unsafe code)
//! - Hardware-agnostic via WebGPU
//! - Complete implementation (production-ready)

use crate::device::{DeviceCapabilities, WorkloadType};
use crate::error::{BarracudaError, Result};
use crate::tensor::Tensor;

/// Grouped 2D Convolution
pub struct GroupedConv2D {
    input: Tensor,
    kernel: Tensor,
    bias: Option<Tensor>,
    stride: usize,
    padding: usize,
    groups: usize,
}

impl GroupedConv2D {
    /// Create grouped 2D convolution (channels split into independent groups).
    ///
    /// # Errors
    ///
    /// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
    /// readback fails (e.g. device lost or out of memory).
    pub fn new(
        input: Tensor,
        kernel: Tensor,
        stride: usize,
        padding: usize,
        groups: usize,
        bias: Option<Tensor>,
    ) -> Result<Self> {
        let input_shape = input.shape();
        if input_shape.len() != 4 {
            return Err(BarracudaError::invalid_op(
                "grouped_conv2d",
                "input must be 4D [batch, channels, height, width]",
            ));
        }

        let kernel_shape = kernel.shape();
        if kernel_shape.len() != 4 {
            return Err(BarracudaError::invalid_op(
                "grouped_conv2d",
                "kernel must be 4D [out_channels, in_channels_per_group, kernel_h, kernel_w]",
            ));
        }

        let _ = input_shape[0];
        let in_channels = input_shape[1];
        let in_height = input_shape[2];
        let in_width = input_shape[3];

        let out_channels = kernel_shape[0];
        let in_per_group = kernel_shape[1];
        let kernel_size = kernel_shape[2]; // Assuming square kernel

        if !in_channels.is_multiple_of(groups) {
            return Err(BarracudaError::invalid_op(
                "grouped_conv2d",
                "in_channels must be divisible by groups",
            ));
        }

        if !out_channels.is_multiple_of(groups) {
            return Err(BarracudaError::invalid_op(
                "grouped_conv2d",
                "out_channels must be divisible by groups",
            ));
        }

        if in_channels / groups != in_per_group {
            return Err(BarracudaError::invalid_op(
                "grouped_conv2d",
                "kernel in_channels_per_group must match in_channels / groups",
            ));
        }

        if let Some(ref bias_tensor) = bias {
            let bias_size = bias_tensor.shape().iter().product::<usize>();
            if bias_size != out_channels {
                return Err(BarracudaError::invalid_op(
                    "grouped_conv2d",
                    "bias must have out_channels elements",
                ));
            }
        }

        let _ = (
            (in_height + 2 * padding - kernel_size) / stride + 1,
            (in_width + 2 * padding - kernel_size) / stride + 1,
        );

        Ok(Self {
            input,
            kernel,
            bias,
            stride,
            padding,
            groups,
        })
    }

    fn wgsl_shader() -> &'static str {
        {
            static SHADER: std::sync::LazyLock<String> = std::sync::LazyLock::new(|| {
                include_str!("../shaders/conv/grouped_conv2d_f64.wgsl").to_string()
            });
            SHADER.as_str()
        }
    }

    /// Execute grouped convolution.
    ///
    /// # Errors
    ///
    /// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
    /// readback fails (e.g. device lost or out of memory).
    pub fn execute(self) -> Result<Tensor> {
        let device = self.input.device();
        let input_shape = self.input.shape();
        let batch_size = input_shape[0];
        let in_channels = input_shape[1];
        let in_height = input_shape[2];
        let in_width = input_shape[3];

        let kernel_shape = self.kernel.shape();
        let out_channels = kernel_shape[0];
        let in_per_group = kernel_shape[1];
        let kernel_size = kernel_shape[2];

        let out_height = (in_height + 2 * self.padding - kernel_size) / self.stride + 1;
        let out_width = (in_width + 2 * self.padding - kernel_size) / self.stride + 1;
        let out_per_group = out_channels / self.groups;

        let output_size = batch_size * out_channels * out_height * out_width;
        let output_buffer = device.create_buffer_f32(output_size)?;

        // Create bias buffer - use tensor buffer directly or create zero buffer
        let zero_bias;
        let bias_buffer: &wgpu::Buffer = if let Some(ref bias_tensor) = self.bias {
            bias_tensor.buffer()
        } else {
            // Create zero-initialized buffer for bias
            let zeros = vec![0.0f32; out_channels];
            zero_bias = device
                .device
                .create_buffer_init(&wgpu::util::BufferInitDescriptor {
                    label: Some("GroupedConv2D Bias Zeros"),
                    contents: bytemuck::cast_slice(&zeros),
                    usage: wgpu::BufferUsages::STORAGE | wgpu::BufferUsages::COPY_DST,
                });
            &zero_bias
        };

        // Create uniform buffer
        #[repr(C)]
        #[derive(Copy, Clone, bytemuck::Pod, bytemuck::Zeroable)]
        struct Params {
            batch_size: u32,
            in_channels: u32,
            out_channels: u32,
            in_height: u32,
            in_width: u32,
            out_height: u32,
            out_width: u32,
            kernel_size: u32,
            stride: u32,
            padding: u32,
            groups: u32,
            in_per_group: u32,
            out_per_group: u32,
            _pad1: u32,
            _pad2: u32,
            _pad3: u32,
        }

        let params = Params {
            batch_size: batch_size as u32,
            in_channels: in_channels as u32,
            out_channels: out_channels as u32,
            in_height: in_height as u32,
            in_width: in_width as u32,
            out_height: out_height as u32,
            out_width: out_width as u32,
            kernel_size: kernel_size as u32,
            stride: self.stride as u32,
            padding: self.padding as u32,
            groups: self.groups as u32,
            in_per_group: in_per_group as u32,
            out_per_group: out_per_group as u32,
            _pad1: 0,
            _pad2: 0,
            _pad3: 0,
        };

        let params_buffer = device
            .device
            .create_buffer_init(&wgpu::util::BufferInitDescriptor {
                label: Some("GroupedConv2D Params"),
                contents: bytemuck::cast_slice(&[params]),
                usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST,
            });

        // Compile shader
        let shader_module =
            device.compile_shader(Self::wgsl_shader(), Some("GroupedConv2D Shader"));

        // Create bind group layout
        let bind_group_layout =
            device
                .device
                .create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor {
                    label: Some("GroupedConv2D Bind Group Layout"),
                    entries: &[
                        wgpu::BindGroupLayoutEntry {
                            binding: 0,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Uniform,
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 1,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: true },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 2,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: true },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 3,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: true },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 4,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: false },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                    ],
                });

        // Create bind group
        let bind_group = device.device.create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("GroupedConv2D Bind Group"),
            layout: &bind_group_layout,
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: params_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: self.input.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: self.kernel.buffer().as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: bias_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 4,
                    resource: output_buffer.as_entire_binding(),
                },
            ],
        });

        // Create pipeline layout
        let pipeline_layout =
            device
                .device
                .create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
                    label: Some("GroupedConv2D Pipeline Layout"),
                    bind_group_layouts: &[&bind_group_layout],
                    immediate_size: 0,
                });

        // Create pipeline
        let pipeline = device
            .device
            .create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
                label: Some("GroupedConv2D Pipeline"),
                layout: Some(&pipeline_layout),
                module: &shader_module,
                entry_point: Some("main"),
                cache: None,
                compilation_options: Default::default(),
            });

        // Encode and execute
        let mut encoder = device.create_encoder_guarded(&wgpu::CommandEncoderDescriptor {
            label: Some("GroupedConv2D Encoder"),
        });

        {
            let mut pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
                label: Some("GroupedConv2D Pass"),
                timestamp_writes: None,
            });

            pass.set_pipeline(&pipeline);
            pass.set_bind_group(0, Some(&bind_group), &[]);

            // Deep Debt Evolution: Capability-based dispatch
            let caps = DeviceCapabilities::from_device(device);
            let optimal_wg_size = caps.optimal_workgroup_size(WorkloadType::Convolution);
            let spatial_size = (out_height * out_width) as u32;
            let workgroups_x = spatial_size.div_ceil(optimal_wg_size);
            let workgroups_y = (out_channels as u32).div_ceil(optimal_wg_size);
            let workgroups_z = batch_size as u32;
            pass.dispatch_workgroups(workgroups_x, workgroups_y, workgroups_z);
        }

        device.submit_commands(Some(encoder.finish()));

        Ok(Tensor::from_buffer(
            output_buffer,
            vec![batch_size, out_channels, out_height, out_width],
            device.clone(),
        ))
    }
}

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

    #[tokio::test]
    async fn test_grouped_conv2d_basic() {
        let device = crate::device::test_pool::get_test_device().await;
        let batch_size = 1;
        let in_channels = 8;
        let in_height = 32;
        let in_width = 32;
        let out_channels = 16;
        let kernel_size = 3;
        let groups = 2;

        let input = Tensor::from_vec_on(
            vec![1.0; batch_size * in_channels * in_height * in_width],
            vec![batch_size, in_channels, in_height, in_width],
            device.clone(),
        )
        .await
        .unwrap();

        let in_per_group = in_channels / groups;
        let kernel = Tensor::from_vec_on(
            vec![0.1; out_channels * in_per_group * kernel_size * kernel_size],
            vec![out_channels, in_per_group, kernel_size, kernel_size],
            device.clone(),
        )
        .await
        .unwrap();

        let bias = Tensor::from_vec_on(vec![0.0; out_channels], vec![out_channels], device.clone())
            .await
            .unwrap();

        let conv = GroupedConv2D::new(input, kernel, 1, 1, groups, Some(bias)).unwrap();
        let output = conv.execute().unwrap();

        assert_eq!(output.shape().len(), 4);
    }

    #[tokio::test]
    async fn test_grouped_conv2d_no_bias() {
        let device = crate::device::test_pool::get_test_device().await;
        let batch_size = 1;
        let in_channels = 4;
        let in_height = 16;
        let in_width = 16;
        let out_channels = 8;
        let kernel_size = 3;
        let groups = 2;

        let input = Tensor::from_vec_on(
            vec![1.0; batch_size * in_channels * in_height * in_width],
            vec![batch_size, in_channels, in_height, in_width],
            device.clone(),
        )
        .await
        .unwrap();

        let in_per_group = in_channels / groups;
        let kernel = Tensor::from_vec_on(
            vec![0.1; out_channels * in_per_group * kernel_size * kernel_size],
            vec![out_channels, in_per_group, kernel_size, kernel_size],
            device.clone(),
        )
        .await
        .unwrap();

        let conv = GroupedConv2D::new(input, kernel, 1, 1, groups, None).unwrap();
        let output = conv.execute().unwrap();

        assert_eq!(output.shape().len(), 4);
    }
}