redjs-webgpu 0.3.1

Native WebGPU for redjs over wgpu. A crate of its own so that redjs and wgpu compile in parallel.
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
use super::*;

#[derive(Clone)]
struct Range {
    offset: u64,
    size: u64,
    ab: u64,
}
#[derive(Default)]
struct Mapping {
    status: u8,
    mode: u32,
    start: u64,
    end: u64,
    epoch: u64,
    ranges: Vec<Range>,
}
pub(super) struct Buffer {
    pub raw: Arc<wgpu::Buffer>,
    pub size: u64,
    pub usage: wgpu::BufferUsages,
    pub destroyed: AtomicBool,
    pub valid: bool,
    mapping: Mutex<Mapping>,
}
// Constructed before spawning: dropping an unpolled future (thread creation
// failure or cancelled work) must not leave a native map pending forever.
struct MapCleanup {
    buffer: Arc<Buffer>,
    epoch: u64,
    armed: bool,
}
impl Drop for MapCleanup {
    fn drop(&mut self) {
        if !self.armed {
            return;
        }
        let mut m = self
            .buffer
            .mapping
            .lock()
            .unwrap_or_else(|e| e.into_inner());
        if m.epoch == self.epoch {
            m.status = 0;
            m.epoch = m.epoch.wrapping_add(1);
            self.buffer.raw.unmap();
        }
    }
}
unsafe fn get_buffer(g: *mut c_void, cf: *mut c_void) -> Result<(Arc<Client>, Arc<Buffer>), ()> {
    let h = this(g, cf, Kind::Buffer)?;
    let c = h.client.unwrap();
    let Resource::Buffer(b) = h.resource else {
        unreachable!()
    };
    Ok((c, b))
}
unsafe fn ranges_slot(g: *mut c_void) -> *mut c_void {
    states().lock().unwrap()[&(g as usize)]
        .classes
        .as_ref()
        .unwrap()
        .s_ranges as *mut c_void
}
#[redjs::host_fn]
unsafe fn create(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let h = this(g, cf, Kind::Device)?;
        let c = client(g, &h)?;
        let d = Val::new(g, cf_arg(cf, 0));
        let size = num(g, field(g, d.v, "size")?.v, 0)?;
        let bits = uint(g, field(g, d.v, "usage")?.v, 0)?;
        let Some(usage) = wgpu::BufferUsages::from_bits(bits) else {
            invalid(g, "Invalid GPUBufferUsage flags")?;
            unreachable!()
        };
        let mapped = boolean(g, field(g, d.v, "mappedAtCreation")?.v);
        let label = text(g, field(g, d.v, "label")?.v, "")?;
        let within_limits = size <= c.limits.max_buffer_size;
        if !within_limits {
            validation(g, &c, "Buffer exceeds this logical device's maxBufferSize");
        }
        let raw = Arc::new(c.checked(|| {
            c.context.device.create_buffer(&wgpu::BufferDescriptor {
                label: Some(&label),
                size: if within_limits { size } else { 0 },
                usage: if within_limits {
                    usage
                } else {
                    wgpu::BufferUsages::empty()
                },
                mapped_at_creation: mapped && within_limits,
            })
        }));
        let errors = c.take_errors();
        let valid = errors.is_empty() && within_limits;
        route_errors(g, c.id, errors);
        c.track_buffer(&raw);
        let b = Arc::new(Buffer {
            raw,
            size,
            usage,
            destroyed: AtomicBool::new(false),
            valid,
            mapping: Mutex::new(Mapping {
                status: if mapped && valid { 2 } else { 0 },
                mode: 2,
                start: 0,
                end: size,
                ..Default::default()
            }),
        });
        let o = Val::new(
            g,
            wrap(g, Kind::Buffer, Some(c.clone()), Resource::Buffer(b)),
        );
        track_buffer_object(g, &c, o.v);
        let ranges = new_array(g);
        glue::rjs_define(g, o.v, ranges_slot(g), ranges, 2);
        Ok(o.v)
    })
}
#[redjs::host_fn]
unsafe fn size(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || Ok(enc_f64(get_buffer(g, cf)?.1.size as f64)))
}
#[redjs::host_fn]
unsafe fn usage(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        Ok(enc_f64(get_buffer(g, cf)?.1.usage.bits() as f64))
    })
}
#[redjs::host_fn]
unsafe fn map_state(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let (_, b) = get_buffer(g, cf)?;
        let status = b.mapping.lock().unwrap().status;
        Ok(js_string(
            g,
            match status {
                1 => "pending",
                2 => "mapped",
                _ => "unmapped",
            },
        ))
    })
}
#[redjs::host_fn]
unsafe fn map_async(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let (c, b) = get_buffer(g, cf)?;
        let mode = uint(g, cf_arg(cf, 0), 0)?;
        let offset = num(g, cf_arg(cf, 1), 0)?;
        let size = num(g, cf_arg(cf, 2), b.size.saturating_sub(offset))?;
        let end = offset.checked_add(size);
        let native_mode = match mode {
            1 => wgpu::MapMode::Read,
            2 => wgpu::MapMode::Write,
            _ => {
                return Ok(redjs::webapi::domexception::rejected(
                    g,
                    "OperationError",
                    "Invalid GPUMapMode",
                ))
            }
        };
        let usage = if mode == 1 {
            wgpu::BufferUsages::MAP_READ
        } else {
            wgpu::BufferUsages::MAP_WRITE
        };
        if c.check().is_err()
            || !b.valid
            || b.destroyed.load(Ordering::Acquire)
            || !b.usage.contains(usage)
            || offset % 8 != 0
            || size % 4 != 0
            || end.is_none_or(|e| e > b.size)
        {
            validation(g, &c, "Invalid buffer mapping range, state, or usage");
            return Ok(redjs::webapi::domexception::rejected(
                g,
                "OperationError",
                "Invalid buffer mapping range, state, or usage",
            ));
        }
        let epoch = {
            let mut m = b.mapping.lock().unwrap();
            if m.status != 0 {
                drop(m);
                return Ok(redjs::webapi::domexception::rejected(
                    g,
                    "OperationError",
                    "GPUBuffer is already mapped or mapping",
                ));
            }
            m.epoch = m.epoch.wrapping_add(1);
            m.status = 1;
            m.mode = mode;
            m.start = offset;
            m.end = end.unwrap();
            m.epoch
        };
        let (tx, rx) = std::sync::mpsc::channel();
        checked(g, &c, || {
            b.raw
                .map_async(native_mode, offset..end.unwrap(), move |result| {
                    let _ = tx.send(result.map_err(|e| e.to_string()));
                })
        });
        let cb = b.clone();
        let cc = c.clone();
        let cleanup = MapCleanup {
            buffer: b.clone(),
            epoch,
            armed: true,
        };
        Ok(async_op(
            g,
            vec![cf_this(cf)],
            async move {
                let mut cleanup = cleanup;
                let result = (|| {
                    let deadline = std::time::Instant::now() + std::time::Duration::from_secs(30);
                    loop {
                        if cb.mapping.lock().unwrap().epoch != epoch {
                            return Err("Buffer mapping was aborted".into());
                        }
                        if let Ok(result) = rx.try_recv() {
                            result?;
                            return Ok((cb.clone(), epoch));
                        }
                        if std::time::Instant::now() >= deadline {
                            return Err("GPU buffer mapping timed out".into());
                        }
                        let _ = cc.context.device.poll(wgpu::PollType::Wait {
                            submission_index: None,
                            timeout: Some(std::time::Duration::from_millis(10)),
                        });
                        cc.check()?;
                    }
                })();
                if result.is_err() {
                    let mut m = cb.mapping.lock().unwrap();
                    if m.epoch == epoch {
                        m.status = 0;
                        m.epoch = m.epoch.wrapping_add(1);
                        cc.checked(|| cb.raw.unmap());
                    }
                }
                if result.is_ok() {
                    cleanup.armed = false;
                }
                result
            },
            |g, (b, epoch)| {
                let mut m = b.mapping.lock().unwrap();
                if m.epoch != epoch || m.status != 1 {
                    drop(m);
                    return redjs::webapi::domexception::rejected(
                        g,
                        "AbortError",
                        "Buffer mapping was aborted",
                    );
                }
                m.status = 2;
                UNDEF
            },
        ))
    })
}
#[redjs::host_fn]
unsafe fn get_range(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let (c, b) = get_buffer(g, cf)?;
        let offset = num(g, cf_arg(cf, 0), 0)?;
        let size = num(g, cf_arg(cf, 1), b.size.saturating_sub(offset))?;
        let end = offset.checked_add(size);
        let epoch = {
            let m = b.mapping.lock().unwrap();
            if m.status != 2
                || c.check().is_err()
                || b.destroyed.load(Ordering::Acquire)
                || offset % 8 != 0
                || size % 4 != 0
                || offset < m.start
                || end.is_none_or(|e| e > m.end)
                || m.ranges
                    .iter()
                    .any(|r| offset < r.offset + r.size && end.unwrap() > r.offset)
            {
                drop(m);
                return Ok(redjs::webapi::domexception::throw(
                    g,
                    "OperationError",
                    "Invalid or overlapping getMappedRange",
                ));
            }
            m.epoch
        };
        let bytes = if size == 0 {
            Vec::new()
        } else {
            match b.raw.get_mapped_range(offset..end.unwrap()) {
                Ok(view) => view.to_vec(),
                Err(e) => {
                    return Ok(redjs::webapi::domexception::throw(
                        g,
                        "OperationError",
                        &e.to_string(),
                    ))
                }
            }
        };
        let view = Val::new(g, make_u8(g, &bytes));
        let mut backing = UNDEF;
        if glue::rjs_view_buffer(g, view.v, &mut backing) != 0 {
            invalid(g, "Cannot obtain mapped ArrayBuffer")?;
        }
        let ab = Val::new(g, backing);
        glue::rjs_define(g, ab.v, ranges_slot(g), cf_this(cf), 1 | 2);
        let edges = Val::new(g, get_a(g, cf_this(cf), ranges_slot(g)));
        let n = array_len(g, edges.v);
        set_i(g, edges.v, n, ab.v);
        let mut m = b.mapping.lock().unwrap();
        if m.epoch != epoch {
            drop(m);
            glue::rjs_arraybuffer_detach(g, ab.v);
            return Ok(redjs::webapi::domexception::throw(
                g,
                "OperationError",
                "Buffer was unmapped during allocation",
            ));
        }
        m.ranges.push(Range {
            offset,
            size,
            ab: ab.v,
        });
        Ok(ab.v)
    })
}
/// Detach the JSC-owned shadow ranges before releasing the native mapping.
/// No pointer into mapped GPU memory survives an allocation or GC callback.
unsafe fn unmap_inner(g: *mut c_void, obj: u64, b: &Buffer, write: bool) {
    let (mode, ranges, was_mapped) = {
        let mut m = b.mapping.lock().unwrap();
        m.epoch = m.epoch.wrapping_add(1);
        let was_mapped = std::mem::replace(&mut m.status, 0) != 0;
        (m.mode, std::mem::take(&mut m.ranges), was_mapped)
    };
    for r in ranges {
        if write && mode == 2 && r.size != 0 && b.valid && !b.destroyed.load(Ordering::Acquire) {
            let bytes = bufferish(g, r.ab).unwrap_or(&[]);
            if bytes.len() == r.size as usize {
                if let Ok(mut view) = b.raw.get_mapped_range_mut(r.offset..r.offset + r.size) {
                    view.copy_from_slice(bytes);
                }
            }
        }
        glue::rjs_arraybuffer_detach(g, r.ab);
    }
    // wgpu treats unmapping an unmapped buffer as a validation error, fatal outside a scope.
    if b.valid && was_mapped {
        b.raw.unmap();
    }
    let edges = new_array(g);
    glue::rjs_define(g, obj, ranges_slot(g), edges, 2);
}
#[redjs::host_fn]
unsafe fn unmap(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let (_, b) = get_buffer(g, cf)?;
        unmap_inner(g, cf_this(cf), &b, true);
        Ok(UNDEF)
    })
}
#[redjs::host_fn]
unsafe fn destroy(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let (_, b) = get_buffer(g, cf)?;
        unmap_inner(g, cf_this(cf), &b, false);
        b.destroyed.store(true, Ordering::Release);
        b.raw.destroy();
        Ok(UNDEF)
    })
}
/// Copy a BufferSource after all observable conversions. Typed-array offsets
/// are in elements; DataView and ArrayBuffer offsets are in bytes.
pub(super) unsafe fn copy_source(
    g: *mut c_void,
    value: u64,
    offset: u64,
    size: Option<u64>,
) -> Result<Vec<u8>, ()> {
    let mut ta = redjs::ffi::RjsTaInfo::default();
    let mut ab = redjs::ffi::RjsAbInfo::default();
    let (ptr, len, units, detached) = if glue::rjs_typedarray_info(g, value, &mut ta) == 0 {
        (
            ta.data,
            ta.byte_length as u64,
            match ta.kind {
                4 | 5 | 13 => 2,
                6 | 7 | 8 => 4,
                9 | 10 | 11 => 8,
                _ => 1,
            },
            ta.detached != 0,
        )
    } else if glue::rjs_arraybuffer_info(g, value, &mut ab) == 0 {
        (ab.data, ab.byte_length, 1, ab.detached != 0)
    } else {
        invalid(g, "WebGPU data must be a BufferSource")?;
        unreachable!()
    };
    if ta.shared != 0 || ab.shared != 0 {
        redjs::webapi::domexception::throw(
            g,
            "NotSupportedError",
            "Shared WebGPU uploads require an atomic native copy path",
        );
        return Err(());
    }
    let Some(start) = offset.checked_mul(units) else {
        invalid(g, "BufferSource offset overflow")?;
        unreachable!()
    };
    let size = match size {
        Some(s) => s.checked_mul(units),
        None => len.checked_sub(start),
    };
    let Some(size) = size else {
        invalid(g, "BufferSource size overflow")?;
        unreachable!()
    };
    if detached || start > len || size > len - start || (ptr.is_null() && size != 0) {
        redjs::webapi::domexception::throw(
            g,
            "OperationError",
            "BufferSource range is out of bounds or detached",
        );
        return Err(());
    }
    if size == 0 {
        Ok(Vec::new())
    } else {
        Ok(
            core::slice::from_raw_parts((ptr as *const u8).add(start as usize), size as usize)
                .to_vec(),
        )
    }
}
#[redjs::host_fn]
unsafe fn write(g: *mut c_void, cf: *mut c_void) -> u64 {
    run(g, || {
        let h = this(g, cf, Kind::Queue)?;
        let c = client(g, &h)?;
        let b = owned(g, cf_arg(cf, 0), Kind::Buffer, &c)?;
        let Resource::Buffer(b) = b.resource else {
            unreachable!()
        };
        let offset = num(g, cf_arg(cf, 1), 0)?;
        let data = Val::new(g, cf_arg(cf, 2));
        let start = num(g, cf_arg(cf, 3), 0)?;
        let size = if cf_arg(cf, 4) == UNDEF {
            None
        } else {
            Some(num(g, cf_arg(cf, 4), 0)?)
        };
        let bytes = copy_source(g, data.v, start, size)?;
        if offset % 4 != 0
            || bytes.len() % 4 != 0
            || offset > b.size
            || bytes.len() as u64 > b.size - offset
            || b.destroyed.load(Ordering::Acquire)
            || b.mapping.lock().unwrap().status != 0
        {
            validation(g, &c, "Invalid writeBuffer range or buffer state");
            return Ok(UNDEF);
        }
        checked(g, &c, || {
            c.context.queue.write_buffer(&b.raw, offset, &bytes)
        });
        Ok(UNDEF)
    })
}
pub(super) unsafe fn install(g: *mut c_void) {
    class(
        g,
        Kind::Buffer,
        "GPUBuffer",
        &[
            ("mapAsync", 1, map_async),
            ("getMappedRange", 0, get_range),
            ("unmap", 0, unmap),
            ("destroy", 0, destroy),
        ],
        &[("size", size), ("usage", usage), ("mapState", map_state)],
    );
    method(g, Kind::Device, "createBuffer", 1, create);
    method(g, Kind::Queue, "writeBuffer", 3, write);
    constants(
        g,
        "GPUBufferUsage",
        &[
            ("MAP_READ", 1),
            ("MAP_WRITE", 2),
            ("COPY_SRC", 4),
            ("COPY_DST", 8),
            ("INDEX", 16),
            ("VERTEX", 32),
            ("UNIFORM", 64),
            ("STORAGE", 128),
            ("INDIRECT", 256),
            ("QUERY_RESOLVE", 512),
        ],
    );
    constants(g, "GPUMapMode", &[("READ", 1), ("WRITE", 2)]);
}

pub(super) unsafe fn release_on_device_destroy(g: *mut c_void, obj: u64) {
    if let Ok(h) = handle(g, obj, Kind::Buffer) {
        if let Resource::Buffer(b) = h.resource {
            unmap_inner(g, obj, &b, false);
            b.destroyed.store(true, Ordering::Release);
        }
    }
}