[WebGPU] Implement GPUError and error scopes
[WebKit-https.git] / Source / WebCore / Modules / webgpu / WebGPUDevice.cpp
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "WebGPUDevice.h"
28
29 #if ENABLE(WEBGPU)
30
31 #include "Exception.h"
32 #include "GPUBindGroup.h"
33 #include "GPUBindGroupBinding.h"
34 #include "GPUBindGroupDescriptor.h"
35 #include "GPUBindGroupLayoutDescriptor.h"
36 #include "GPUBufferBinding.h"
37 #include "GPUBufferDescriptor.h"
38 #include "GPUCommandBuffer.h"
39 #include "GPUPipelineStageDescriptor.h"
40 #include "GPURenderPipelineDescriptor.h"
41 #include "GPUSampler.h"
42 #include "GPUSamplerDescriptor.h"
43 #include "GPUShaderModuleDescriptor.h"
44 #include "GPUTextureDescriptor.h"
45 #include "JSDOMConvertBufferSource.h"
46 #include "JSGPUOutOfMemoryError.h"
47 #include "JSGPUValidationError.h"
48 #include "JSWebGPUBuffer.h"
49 #include "Logging.h"
50 #include "WebGPUBindGroup.h"
51 #include "WebGPUBindGroupBinding.h"
52 #include "WebGPUBindGroupDescriptor.h"
53 #include "WebGPUBindGroupLayout.h"
54 #include "WebGPUBufferBinding.h"
55 #include "WebGPUCommandEncoder.h"
56 #include "WebGPUComputePipeline.h"
57 #include "WebGPUComputePipelineDescriptor.h"
58 #include "WebGPUPipelineLayout.h"
59 #include "WebGPUPipelineLayoutDescriptor.h"
60 #include "WebGPUPipelineStageDescriptor.h"
61 #include "WebGPUQueue.h"
62 #include "WebGPURenderPipeline.h"
63 #include "WebGPURenderPipelineDescriptor.h"
64 #include "WebGPUSampler.h"
65 #include "WebGPUShaderModule.h"
66 #include "WebGPUShaderModuleDescriptor.h"
67 #include "WebGPUSwapChain.h"
68 #include "WebGPUTexture.h"
69 #include <wtf/Optional.h>
70
71 namespace WebCore {
72
73 RefPtr<WebGPUDevice> WebGPUDevice::tryCreate(Ref<const WebGPUAdapter>&& adapter)
74 {
75     if (auto device = GPUDevice::tryCreate(adapter->options()))
76         return adoptRef(new WebGPUDevice(WTFMove(adapter), device.releaseNonNull()));
77     return nullptr;
78 }
79
80 WebGPUDevice::WebGPUDevice(Ref<const WebGPUAdapter>&& adapter, Ref<GPUDevice>&& device)
81     : m_adapter(WTFMove(adapter))
82     , m_device(WTFMove(device))
83 {
84 }
85
86 Ref<WebGPUBuffer> WebGPUDevice::createBuffer(const GPUBufferDescriptor& descriptor) const
87 {
88     auto buffer = m_device->tryCreateBuffer(descriptor);
89     return WebGPUBuffer::create(WTFMove(buffer));
90 }
91
92 Vector<JSC::JSValue> WebGPUDevice::createBufferMapped(JSC::ExecState& state, const GPUBufferDescriptor& descriptor) const
93 {
94     JSC::JSValue wrappedArrayBuffer = JSC::jsNull();
95
96     auto buffer = m_device->tryCreateBuffer(descriptor, true);
97     if (buffer) {
98         auto arrayBuffer = buffer->mapOnCreation();
99         wrappedArrayBuffer = toJS(&state, JSC::jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject()), arrayBuffer);
100     }
101
102     auto webBuffer = WebGPUBuffer::create(WTFMove(buffer));
103     auto wrappedWebBuffer = toJS(&state, JSC::jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject()), webBuffer);
104
105     return { wrappedWebBuffer, wrappedArrayBuffer };
106 }
107
108 Ref<WebGPUTexture> WebGPUDevice::createTexture(const GPUTextureDescriptor& descriptor) const
109 {
110     auto texture = m_device->tryCreateTexture(descriptor);
111     return WebGPUTexture::create(WTFMove(texture));
112 }
113
114 Ref<WebGPUSampler> WebGPUDevice::createSampler(const GPUSamplerDescriptor& descriptor) const
115 {
116     auto sampler = m_device->tryCreateSampler(descriptor);
117     return WebGPUSampler::create(WTFMove(sampler));
118 }
119
120 Ref<WebGPUBindGroupLayout> WebGPUDevice::createBindGroupLayout(const GPUBindGroupLayoutDescriptor& descriptor) const
121 {
122     auto layout = m_device->tryCreateBindGroupLayout(descriptor);
123     return WebGPUBindGroupLayout::create(WTFMove(layout));
124 }
125
126 Ref<WebGPUPipelineLayout> WebGPUDevice::createPipelineLayout(const WebGPUPipelineLayoutDescriptor& descriptor) const
127 {
128     auto gpuDescriptor = descriptor.tryCreateGPUPipelineLayoutDescriptor();
129     if (!gpuDescriptor)
130         return WebGPUPipelineLayout::create(nullptr);
131     
132     auto layout = m_device->createPipelineLayout(WTFMove(*gpuDescriptor));
133     return WebGPUPipelineLayout::create(WTFMove(layout));
134 }
135
136 Ref<WebGPUBindGroup> WebGPUDevice::createBindGroup(const WebGPUBindGroupDescriptor& descriptor) const
137 {
138     auto gpuDescriptor = descriptor.tryCreateGPUBindGroupDescriptor();
139     if (!gpuDescriptor)
140         return WebGPUBindGroup::create(nullptr);
141
142     auto bindGroup = GPUBindGroup::tryCreate(*gpuDescriptor);
143     return WebGPUBindGroup::create(WTFMove(bindGroup));
144 }
145
146 Ref<WebGPUShaderModule> WebGPUDevice::createShaderModule(const WebGPUShaderModuleDescriptor& descriptor) const
147 {
148     // FIXME: What can be validated here?
149     auto module = m_device->tryCreateShaderModule(GPUShaderModuleDescriptor { descriptor.code, descriptor.isWHLSL });
150     return WebGPUShaderModule::create(WTFMove(module));
151 }
152
153 Ref<WebGPURenderPipeline> WebGPUDevice::createRenderPipeline(const WebGPURenderPipelineDescriptor& descriptor) const
154 {
155     auto gpuDescriptor = descriptor.tryCreateGPURenderPipelineDescriptor();
156     if (!gpuDescriptor)
157         return WebGPURenderPipeline::create(nullptr);
158
159     auto pipeline = m_device->tryCreateRenderPipeline(*gpuDescriptor);
160     return WebGPURenderPipeline::create(WTFMove(pipeline));
161 }
162
163 Ref<WebGPUComputePipeline> WebGPUDevice::createComputePipeline(const WebGPUComputePipelineDescriptor& descriptor) const
164 {
165     auto gpuDescriptor = descriptor.tryCreateGPUComputePipelineDescriptor();
166     if (!gpuDescriptor)
167         return WebGPUComputePipeline::create(nullptr);
168
169     auto pipeline = m_device->tryCreateComputePipeline(*gpuDescriptor);
170     return WebGPUComputePipeline::create(WTFMove(pipeline));
171 }
172
173 Ref<WebGPUCommandEncoder> WebGPUDevice::createCommandEncoder() const
174 {
175     auto commandBuffer = m_device->tryCreateCommandBuffer();
176     return WebGPUCommandEncoder::create(WTFMove(commandBuffer));
177 }
178
179 Ref<WebGPUQueue> WebGPUDevice::getQueue() const
180 {
181     if (!m_queue)
182         m_queue = WebGPUQueue::create(m_device->tryGetQueue());
183
184     return makeRef(*m_queue.get());
185 }
186
187 void WebGPUDevice::pushErrorScope(GPUErrorFilter filter) const
188 {
189     m_device->pushErrorScope(filter);
190 }
191
192 void WebGPUDevice::popErrorScope(ErrorPromise&& promise) const
193 {
194     m_device->popErrorScope([promise = WTFMove(promise)] (Optional<GPUError>&& error, const String& failMessage) mutable {
195         if (failMessage.isEmpty())
196             promise.resolve(error);
197         else
198             promise.reject(Exception { OperationError, failMessage });
199     });
200 }
201
202 } // namespace WebCore
203
204 #endif // ENABLE(WEBGPU)