dawn-rs 0.1.2

Rust wrapper for the Dawn API
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
#include <cstdint>
#include <cstring>
#include <memory>
#include <vector>

#include "dawn/dawn_proc.h"
#include "dawn/native/DawnNative.h"
#include "dawn/wire/client/webgpu.h"
#include "dawn/wire/WireClient.h"
#include "dawn/wire/WireServer.h"

// This shim intentionally does not implement any wire protocol encoding/decoding.
// Dawn's generated wire runtime handles command (de)serialization internally.
// The shim only bridges serializer callbacks, proc-table setup, and HandleCommands routing.

extern "C" {

struct DawnRsWireSerializerCallbacks {
    void* userdata;
    void (*on_flush)(void* userdata, const uint8_t* data, size_t size);
    void (*on_error)(void* userdata, const char* message, size_t message_len);
    size_t max_allocation_size;
};

struct DawnRsWireHandle {
    uint32_t id;
    uint32_t generation;
};

struct DawnRsWireReservedInstance {
    void* instance;
    DawnRsWireHandle handle;
};

struct DawnRsWireReservedSurface {
    void* surface;
    DawnRsWireHandle instance_handle;
    DawnRsWireHandle handle;
};

struct DawnRsWireReservedTexture {
    void* texture;
    DawnRsWireHandle handle;
    DawnRsWireHandle device_handle;
};

}  // extern "C"

namespace {

class SerializerBridge final : public dawn::wire::CommandSerializer {
  public:
    explicit SerializerBridge(const DawnRsWireSerializerCallbacks& callbacks)
        : callbacks_(callbacks) {}
    ~SerializerBridge() override = default;

    size_t GetMaximumAllocationSize() const override {
        if (callbacks_.max_allocation_size == 0) {
            // WireClient/WireServer internally use Dawn's ChunkedCommandSerializer.
            // This value controls when large commands are emitted as chunked commands.
            return 64 * 1024;
        }
        return callbacks_.max_allocation_size;
    }

    void* GetCmdSpace(size_t size) override {
        const size_t old_size = buffer_.size();
        buffer_.resize(old_size + size);
        return buffer_.data() + old_size;
    }

    bool Flush() override {
        if (!callbacks_.on_flush) {
            return false;
        }
        if (buffer_.empty()) {
            return true;
        }
        callbacks_.on_flush(callbacks_.userdata, buffer_.data(), buffer_.size());
        buffer_.clear();
        return true;
    }

    void OnSerializeError() override { EmitError("wire serializer error"); }

  private:
    void EmitError(const char* message) {
        if (!callbacks_.on_error) {
            return;
        }
        callbacks_.on_error(callbacks_.userdata, message, std::strlen(message));
    }

    DawnRsWireSerializerCallbacks callbacks_;
    std::vector<uint8_t> buffer_;
};

struct DawnRsWireClient {
    std::unique_ptr<SerializerBridge> serializer;
    std::unique_ptr<dawn::wire::WireClient> wire;
};

struct DawnRsWireServer {
    std::unique_ptr<SerializerBridge> serializer;
    std::unique_ptr<dawn::wire::WireServer> wire;
    std::vector<WGPUTexture> retained_injected_textures;
};
// The wire server lifecycle (construction + Inject* + HandleCommands) is currently exposed
// through C++ dawn::wire APIs, so we keep this control plane in C++.

// dawnProcSetProcs stores a pointer, so the table must outlive the call site.
static DawnProcTable gWireClientProcs = {};
static bool gWireClientProcsInitialized = false;

#include "wire_client_proc_table_autogen.inc"

}  // namespace

extern "C" {

DawnRsWireClient* dawn_rs_wire_client_create(const DawnRsWireSerializerCallbacks* callbacks) {
    if (!callbacks) {
        return nullptr;
    }
    auto out = std::make_unique<DawnRsWireClient>();
    out->serializer = std::make_unique<SerializerBridge>(*callbacks);
    dawn::wire::WireClientDescriptor desc = {};
    desc.serializer = out->serializer.get();
    out->wire = std::make_unique<dawn::wire::WireClient>(desc);
    return out.release();
}

void dawn_rs_wire_client_destroy(DawnRsWireClient* client) {
    delete client;
}

bool dawn_rs_wire_client_handle_commands(DawnRsWireClient* client,
                                         const uint8_t* data,
                                         size_t size) {
    if (!client || (size > 0 && !data)) {
        return false;
    }
    return client->wire->HandleCommands(reinterpret_cast<const volatile char*>(data), size) !=
           nullptr;
}

bool dawn_rs_wire_client_flush(DawnRsWireClient* client) {
    if (!client) {
        return false;
    }
    return client->serializer->Flush();
}

void dawn_rs_wire_client_disconnect(DawnRsWireClient* client) {
    if (!client) {
        return;
    }
    client->wire->Disconnect();
}

DawnRsWireReservedInstance dawn_rs_wire_client_reserve_instance(DawnRsWireClient* client) {
    DawnRsWireReservedInstance out = {};
    if (!client) {
        return out;
    }
    dawn::wire::ReservedInstance reserved = client->wire->ReserveInstance(nullptr);
    out.instance = reserved.instance;
    out.handle.id = reserved.handle.id;
    out.handle.generation = reserved.handle.generation;
    return out;
}

DawnRsWireReservedSurface dawn_rs_wire_client_reserve_surface(DawnRsWireClient* client,
                                                              void* instance) {
    DawnRsWireReservedSurface out = {};
    if (!client || !instance) {
        return out;
    }
    WGPUSurfaceCapabilities caps = {};
    dawn::wire::ReservedSurface reserved =
        client->wire->ReserveSurface(reinterpret_cast<WGPUInstance>(instance), &caps);
    out.surface = reserved.surface;
    out.instance_handle.id = reserved.instanceHandle.id;
    out.instance_handle.generation = reserved.instanceHandle.generation;
    out.handle.id = reserved.handle.id;
    out.handle.generation = reserved.handle.generation;
    return out;
}

DawnRsWireHandle dawn_rs_wire_client_get_device_handle(DawnRsWireClient* client, void* device) {
    DawnRsWireHandle out = {};
    if (!client || !device) {
        return out;
    }
    dawn::wire::Handle h = client->wire->GetWireHandle(reinterpret_cast<WGPUDevice>(device));
    out.id = h.id;
    out.generation = h.generation;
    return out;
}

DawnRsWireReservedTexture dawn_rs_wire_client_reserve_texture_2d(DawnRsWireClient* client,
                                                                  void* device,
                                                                  uint32_t width,
                                                                  uint32_t height,
                                                                  uint32_t format,
                                                                  uint64_t usage) {
    DawnRsWireReservedTexture out = {};
    if (!client || !device || width == 0 || height == 0) {
        return out;
    }
    WGPUExtent3D size = {};
    size.width = width;
    size.height = height;
    size.depthOrArrayLayers = 1;
    WGPUTextureDescriptor desc = {};
    desc.dimension = WGPUTextureDimension_2D;
    desc.format = static_cast<WGPUTextureFormat>(format);
    desc.size = size;
    desc.mipLevelCount = 1;
    desc.sampleCount = 1;
    desc.usage = static_cast<WGPUTextureUsage>(usage);
    dawn::wire::ReservedTexture reserved =
        client->wire->ReserveTexture(reinterpret_cast<WGPUDevice>(device), &desc);
    out.texture = reserved.texture;
    out.handle.id = reserved.handle.id;
    out.handle.generation = reserved.handle.generation;
    out.device_handle.id = reserved.deviceHandle.id;
    out.device_handle.generation = reserved.deviceHandle.generation;
    return out;
}

DawnRsWireServer* dawn_rs_wire_server_create_native(const DawnRsWireSerializerCallbacks* callbacks,
                                                    bool use_spontaneous_callbacks) {
    if (!callbacks) {
        return nullptr;
    }
    auto out = std::make_unique<DawnRsWireServer>();
    out->serializer = std::make_unique<SerializerBridge>(*callbacks);

    dawn::wire::WireServerDescriptor desc = {};
    desc.procs = &dawn::native::GetProcs();
    desc.serializer = out->serializer.get();
    desc.useSpontaneousCallbacks = use_spontaneous_callbacks;
    out->wire = std::make_unique<dawn::wire::WireServer>(desc);
    return out.release();
}

void dawn_rs_wire_server_destroy(DawnRsWireServer* server) {
    if (server) {
        const DawnProcTable& procs = dawn::native::GetProcs();
        for (WGPUTexture texture : server->retained_injected_textures) {
            if (texture) {
                procs.textureRelease(texture);
            }
        }
        server->retained_injected_textures.clear();
    }
    delete server;
}

bool dawn_rs_wire_server_handle_commands(DawnRsWireServer* server,
                                         const uint8_t* data,
                                         size_t size) {
    if (!server || (size > 0 && !data)) {
        return false;
    }
    return server->wire->HandleCommands(reinterpret_cast<const volatile char*>(data), size) !=
           nullptr;
}

bool dawn_rs_wire_server_flush(DawnRsWireServer* server) {
    if (!server) {
        return false;
    }
    return server->serializer->Flush();
}

bool dawn_rs_wire_server_inject_instance(DawnRsWireServer* server,
                                         void* instance,
                                         DawnRsWireHandle handle) {
    if (!server || !instance) {
        return false;
    }
    dawn::wire::Handle h = {};
    h.id = handle.id;
    h.generation = handle.generation;
    return server->wire->InjectInstance(reinterpret_cast<WGPUInstance>(instance), h);
}

bool dawn_rs_wire_server_inject_surface(DawnRsWireServer* server,
                                        void* surface,
                                        DawnRsWireHandle handle,
                                        DawnRsWireHandle instance_handle) {
    if (!server || !surface) {
        return false;
    }
    dawn::wire::Handle h = {};
    h.id = handle.id;
    h.generation = handle.generation;
    dawn::wire::Handle instance_h = {};
    instance_h.id = instance_handle.id;
    instance_h.generation = instance_handle.generation;
    return server->wire->InjectSurface(reinterpret_cast<WGPUSurface>(surface), h, instance_h);
}

bool dawn_rs_wire_server_inject_texture(DawnRsWireServer* server,
                                        void* texture,
                                        DawnRsWireHandle handle,
                                        DawnRsWireHandle device_handle) {
    if (!server || !texture) {
        return false;
    }
    dawn::wire::Handle h = {};
    h.id = handle.id;
    h.generation = handle.generation;
    dawn::wire::Handle device_h = {};
    device_h.id = device_handle.id;
    device_h.generation = device_handle.generation;
    return server->wire->InjectTexture(reinterpret_cast<WGPUTexture>(texture), h, device_h);
}

bool dawn_rs_wire_server_inject_buffer(DawnRsWireServer* server,
                                       void* buffer,
                                       DawnRsWireHandle handle,
                                       DawnRsWireHandle device_handle) {
    if (!server || !buffer) {
        return false;
    }
    dawn::wire::Handle h = {};
    h.id = handle.id;
    h.generation = handle.generation;
    dawn::wire::Handle device_h = {};
    device_h.id = device_handle.id;
    device_h.generation = device_handle.generation;
    return server->wire->InjectBuffer(reinterpret_cast<WGPUBuffer>(buffer), h, device_h);
}

void* dawn_rs_wire_server_get_device(DawnRsWireServer* server, DawnRsWireHandle handle) {
    if (!server) {
        return nullptr;
    }
    return reinterpret_cast<void*>(server->wire->GetDevice(handle.id, handle.generation));
}

namespace {
bool DawnRsInjectImportedSharedTexture(DawnRsWireServer* server,
                                       WGPUDevice device,
                                       WGPUSharedTextureMemoryDescriptor* shared_desc,
                                       uint32_t width,
                                       uint32_t height,
                                       uint32_t format,
                                       uint64_t usage,
                                       DawnRsWireHandle texture_handle,
                                       DawnRsWireHandle device_handle) {
    const DawnProcTable& procs = dawn::native::GetProcs();
    WGPUSharedTextureMemory shared = procs.deviceImportSharedTextureMemory(device, shared_desc);
    if (!shared) {
        return false;
    }
    WGPUExtent3D size = {};
    size.width = width;
    size.height = height;
    size.depthOrArrayLayers = 1;
    WGPUTextureDescriptor tex_desc = {};
    tex_desc.dimension = WGPUTextureDimension_2D;
    tex_desc.format = static_cast<WGPUTextureFormat>(format);
    tex_desc.size = size;
    tex_desc.mipLevelCount = 1;
    tex_desc.sampleCount = 1;
    tex_desc.usage = static_cast<WGPUTextureUsage>(usage) | WGPUTextureUsage_CopySrc;
    WGPUTexture shared_texture = procs.sharedTextureMemoryCreateTexture(shared, &tex_desc);
    if (!shared_texture) {
        procs.sharedTextureMemoryRelease(shared);
        return false;
    }
    WGPUSharedTextureMemoryBeginAccessDescriptor begin_access = {};
    begin_access.concurrentRead = false;
    begin_access.initialized = true;
    if (procs.sharedTextureMemoryBeginAccess(shared, shared_texture, &begin_access) !=
        WGPUStatus_Success) {
        procs.textureRelease(shared_texture);
        procs.sharedTextureMemoryRelease(shared);
        return false;
    }

    WGPUTextureDescriptor local_desc = tex_desc;
    local_desc.usage = static_cast<WGPUTextureUsage>(usage) | WGPUTextureUsage_CopyDst;
    WGPUTexture texture = procs.deviceCreateTexture(device, &local_desc);
    if (!texture) {
        WGPUSharedTextureMemoryEndAccessState end_access = {};
        procs.sharedTextureMemoryEndAccess(shared, shared_texture, &end_access);
        procs.sharedTextureMemoryEndAccessStateFreeMembers(end_access);
        procs.textureRelease(shared_texture);
        procs.sharedTextureMemoryRelease(shared);
        return false;
    }
    WGPUCommandEncoder encoder = procs.deviceCreateCommandEncoder(device, nullptr);
    if (!encoder) {
        WGPUSharedTextureMemoryEndAccessState end_access = {};
        procs.sharedTextureMemoryEndAccess(shared, shared_texture, &end_access);
        procs.sharedTextureMemoryEndAccessStateFreeMembers(end_access);
        procs.textureRelease(shared_texture);
        procs.textureRelease(texture);
        procs.sharedTextureMemoryRelease(shared);
        return false;
    }
    WGPUTexelCopyTextureInfo src = {};
    src.texture = shared_texture;
    src.mipLevel = 0;
    src.origin = {0, 0, 0};
    src.aspect = WGPUTextureAspect_All;
    WGPUTexelCopyTextureInfo dst = {};
    dst.texture = texture;
    dst.mipLevel = 0;
    dst.origin = {0, 0, 0};
    dst.aspect = WGPUTextureAspect_All;
    procs.commandEncoderCopyTextureToTexture(encoder, &src, &dst, &size);
    WGPUCommandBuffer command = procs.commandEncoderFinish(encoder, nullptr);
    procs.commandEncoderRelease(encoder);
    if (!command) {
        WGPUSharedTextureMemoryEndAccessState end_access = {};
        procs.sharedTextureMemoryEndAccess(shared, shared_texture, &end_access);
        procs.sharedTextureMemoryEndAccessStateFreeMembers(end_access);
        procs.textureRelease(shared_texture);
        procs.textureRelease(texture);
        procs.sharedTextureMemoryRelease(shared);
        return false;
    }
    WGPUQueue queue = procs.deviceGetQueue(device);
    procs.queueSubmit(queue, 1, &command);
    procs.commandBufferRelease(command);
    WGPUSharedTextureMemoryEndAccessState end_access = {};
    procs.sharedTextureMemoryEndAccess(shared, shared_texture, &end_access);
    procs.sharedTextureMemoryEndAccessStateFreeMembers(end_access);
    procs.textureRelease(shared_texture);
    procs.sharedTextureMemoryRelease(shared);

    dawn::wire::Handle tex_h = {};
    tex_h.id = texture_handle.id;
    tex_h.generation = texture_handle.generation;
    dawn::wire::Handle dev_h = {};
    dev_h.id = device_handle.id;
    dev_h.generation = device_handle.generation;
    const bool ok = server->wire->InjectTexture(texture, tex_h, dev_h);
    if (ok) {
        server->retained_injected_textures.push_back(texture);
    } else {
        procs.textureRelease(texture);
    }
    return ok;
}
}  // namespace

bool dawn_rs_wire_server_inject_iosurface_texture(DawnRsWireServer* server,
                                                   void* io_surface,
                                                   uint32_t width,
                                                   uint32_t height,
                                                   uint32_t format,
                                                   uint64_t usage,
                                                   DawnRsWireHandle texture_handle,
                                                   DawnRsWireHandle device_handle) {
    if (!server || !io_surface || width == 0 || height == 0) {
        return false;
    }
    WGPUDevice device = server->wire->GetDevice(device_handle.id, device_handle.generation);
    if (!device) {
        return false;
    }
    WGPUSharedTextureMemoryDescriptor shared_desc = {};
    WGPUSharedTextureMemoryIOSurfaceDescriptor ios_desc = {};
    ios_desc.chain.sType = WGPUSType_SharedTextureMemoryIOSurfaceDescriptor;
    ios_desc.ioSurface = io_surface;
    ios_desc.allowStorageBinding = false;
    shared_desc.nextInChain = &ios_desc.chain;
    return DawnRsInjectImportedSharedTexture(server, device, &shared_desc, width, height,
                                             format, usage,
                                             texture_handle, device_handle);
}

bool dawn_rs_wire_server_inject_dxgi_texture(DawnRsWireServer* server,
                                             void* shared_handle,
                                             bool use_keyed_mutex,
                                             uint32_t width,
                                             uint32_t height,
                                             uint32_t format,
                                             uint64_t usage,
                                             DawnRsWireHandle texture_handle,
                                             DawnRsWireHandle device_handle) {
    if (!server || !shared_handle || width == 0 || height == 0) {
        return false;
    }
    WGPUDevice device = server->wire->GetDevice(device_handle.id, device_handle.generation);
    if (!device) {
        return false;
    }
    WGPUSharedTextureMemoryDescriptor shared_desc = {};
    WGPUSharedTextureMemoryDXGISharedHandleDescriptor dxgi_desc = {};
    dxgi_desc.chain.sType = WGPUSType_SharedTextureMemoryDXGISharedHandleDescriptor;
    dxgi_desc.handle = shared_handle;
    dxgi_desc.useKeyedMutex = use_keyed_mutex;
    shared_desc.nextInChain = &dxgi_desc.chain;
    return DawnRsInjectImportedSharedTexture(server, device, &shared_desc, width, height,
                                             format, usage,
                                             texture_handle, device_handle);
}

bool dawn_rs_wire_server_inject_dmabuf_texture(DawnRsWireServer* server,
                                               int fd,
                                               uint32_t drm_format,
                                               uint64_t drm_modifier,
                                               uint32_t stride,
                                               uint64_t offset,
                                               uint32_t width,
                                               uint32_t height,
                                               uint32_t format,
                                               uint64_t usage,
                                               DawnRsWireHandle texture_handle,
                                               DawnRsWireHandle device_handle) {
    if (!server || fd < 0 || width == 0 || height == 0) {
        return false;
    }
    WGPUDevice device = server->wire->GetDevice(device_handle.id, device_handle.generation);
    if (!device) {
        return false;
    }
    WGPUSharedTextureMemoryDmaBufPlane plane = {};
    plane.fd = fd;
    plane.offset = offset;
    plane.stride = stride;
    WGPUSharedTextureMemoryDescriptor shared_desc = {};
    WGPUSharedTextureMemoryDmaBufDescriptor dma_desc = {};
    dma_desc.chain.sType = WGPUSType_SharedTextureMemoryDmaBufDescriptor;
    dma_desc.size.width = width;
    dma_desc.size.height = height;
    dma_desc.size.depthOrArrayLayers = 1;
    dma_desc.drmFormat = drm_format;
    dma_desc.drmModifier = drm_modifier;
    dma_desc.planeCount = 1;
    dma_desc.planes = &plane;
    shared_desc.nextInChain = &dma_desc.chain;
    return DawnRsInjectImportedSharedTexture(server, device, &shared_desc, width, height,
                                             format, usage,
                                             texture_handle, device_handle);
}

void dawn_rs_wire_set_client_procs() {
    if (!gWireClientProcsInitialized) {
        gWireClientProcs = DawnRsBuildWireClientProcTableFromCAPI();
        gWireClientProcsInitialized = true;
    }
    dawnProcSetProcs(&gWireClientProcs);
}

void dawn_rs_wire_set_native_procs() {
    const DawnProcTable& procs = dawn::native::GetProcs();
    dawnProcSetProcs(&procs);
}

void dawn_rs_wire_clear_procs() {
    dawnProcSetProcs(nullptr);
}

}  // extern "C"