Clean up some includes to make the build a bit faster: DOMPromise
[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 "DOMWindow.h"
32 #include "Document.h"
33 #include "EventNames.h"
34 #include "Exception.h"
35 #include "GPUBindGroup.h"
36 #include "GPUBindGroupBinding.h"
37 #include "GPUBindGroupDescriptor.h"
38 #include "GPUBindGroupLayoutDescriptor.h"
39 #include "GPUBufferBinding.h"
40 #include "GPUBufferDescriptor.h"
41 #include "GPUCommandBuffer.h"
42 #include "GPUComputePipeline.h"
43 #include "GPUComputePipelineDescriptor.h"
44 #include "GPUProgrammableStageDescriptor.h"
45 #include "GPURenderPipeline.h"
46 #include "GPURenderPipelineDescriptor.h"
47 #include "GPUSampler.h"
48 #include "GPUSamplerDescriptor.h"
49 #include "GPUShaderModuleDescriptor.h"
50 #include "GPUTextureDescriptor.h"
51 #include "GPUUncapturedErrorEvent.h"
52 #include "InspectorInstrumentation.h"
53 #include "JSDOMConvertBufferSource.h"
54 #include "JSDOMPromiseDeferred.h"
55 #include "JSGPUOutOfMemoryError.h"
56 #include "JSGPUValidationError.h"
57 #include "JSWebGPUBuffer.h"
58 #include "Logging.h"
59 #include "WebGPUBindGroup.h"
60 #include "WebGPUBindGroupBinding.h"
61 #include "WebGPUBindGroupDescriptor.h"
62 #include "WebGPUBindGroupLayout.h"
63 #include "WebGPUBufferBinding.h"
64 #include "WebGPUCommandEncoder.h"
65 #include "WebGPUComputePipeline.h"
66 #include "WebGPUComputePipelineDescriptor.h"
67 #include "WebGPUPipeline.h"
68 #include "WebGPUPipelineLayout.h"
69 #include "WebGPUPipelineLayoutDescriptor.h"
70 #include "WebGPUProgrammableStageDescriptor.h"
71 #include "WebGPUQueue.h"
72 #include "WebGPURenderPipeline.h"
73 #include "WebGPURenderPipelineDescriptor.h"
74 #include "WebGPUSampler.h"
75 #include "WebGPUShaderModule.h"
76 #include "WebGPUShaderModuleDescriptor.h"
77 #include "WebGPUSwapChain.h"
78 #include "WebGPUTexture.h"
79 #include <JavaScriptCore/ConsoleMessage.h>
80 #include <memory>
81 #include <wtf/HashSet.h>
82 #include <wtf/IsoMallocInlines.h>
83 #include <wtf/Lock.h>
84 #include <wtf/MainThread.h>
85 #include <wtf/NeverDestroyed.h>
86 #include <wtf/Optional.h>
87 #include <wtf/Ref.h>
88 #include <wtf/RefPtr.h>
89 #include <wtf/Variant.h>
90 #include <wtf/Vector.h>
91 #include <wtf/text/WTFString.h>
92
93 namespace WebCore {
94
95 WTF_MAKE_ISO_ALLOCATED_IMPL(WebGPUDevice);
96
97 RefPtr<WebGPUDevice> WebGPUDevice::tryCreate(ScriptExecutionContext& context, Ref<const WebGPUAdapter>&& adapter)
98 {
99     if (auto device = GPUDevice::tryCreate(adapter->options()))
100         return adoptRef(new WebGPUDevice(context, WTFMove(adapter), device.releaseNonNull()));
101     return nullptr;
102 }
103
104 HashSet<WebGPUDevice*>& WebGPUDevice::instances(const LockHolder&)
105 {
106     static NeverDestroyed<HashSet<WebGPUDevice*>> instances;
107     return instances;
108 }
109
110 Lock& WebGPUDevice::instancesMutex()
111 {
112     static LazyNeverDestroyed<Lock> mutex;
113     static std::once_flag initializeMutex;
114     std::call_once(initializeMutex, [] {
115         mutex.construct();
116     });
117     return mutex.get();
118 }
119
120 WebGPUDevice::WebGPUDevice(ScriptExecutionContext& context, Ref<const WebGPUAdapter>&& adapter, Ref<GPUDevice>&& device)
121     : m_scriptExecutionContext(context)
122     , m_adapter(WTFMove(adapter))
123     , m_device(WTFMove(device))
124     , m_errorScopes(GPUErrorScopes::create([this, weakThis = makeWeakPtr(this)] (GPUError&& error) {
125         if (weakThis)
126             dispatchUncapturedError(WTFMove(error));
127     }))
128 {
129     ASSERT(m_scriptExecutionContext.isDocument());
130
131     {
132         LockHolder lock(instancesMutex());
133         instances(lock).add(this);
134     }
135 }
136
137 WebGPUDevice::~WebGPUDevice()
138 {
139     InspectorInstrumentation::willDestroyWebGPUDevice(*this);
140
141     {
142         LockHolder lock(WebGPUPipeline::instancesMutex());
143         for (auto& entry : WebGPUPipeline::instances(lock)) {
144             if (entry.value == this) {
145                 // Don't remove any WebGPUPipeline from the instances list, as they may still exist.
146                 // Only remove the association with a WebGPU device.
147                 entry.value = nullptr;
148             }
149         }
150     }
151
152     {
153         LockHolder lock(instancesMutex());
154         ASSERT(instances(lock).contains(this));
155         instances(lock).remove(this);
156     }
157 }
158
159 Ref<WebGPUBuffer> WebGPUDevice::createBuffer(const GPUBufferDescriptor& descriptor) const
160 {
161     m_errorScopes->setErrorPrefix("GPUDevice.createBuffer(): ");
162
163     auto buffer = m_device->tryCreateBuffer(descriptor, GPUBufferMappedOption::NotMapped, m_errorScopes);
164     return WebGPUBuffer::create(WTFMove(buffer), m_errorScopes);
165 }
166
167 Vector<JSC::JSValue> WebGPUDevice::createBufferMapped(JSC::ExecState& state, const GPUBufferDescriptor& descriptor) const
168 {
169     m_errorScopes->setErrorPrefix("GPUDevice.createBufferMapped(): ");
170
171     JSC::JSValue wrappedArrayBuffer = JSC::jsNull();
172
173     auto buffer = m_device->tryCreateBuffer(descriptor, GPUBufferMappedOption::IsMapped, m_errorScopes);
174     if (buffer) {
175         auto arrayBuffer = buffer->mapOnCreation();
176         wrappedArrayBuffer = toJS(&state, JSC::jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject()), arrayBuffer);
177     }
178
179     auto webBuffer = WebGPUBuffer::create(WTFMove(buffer), m_errorScopes);
180     auto wrappedWebBuffer = toJS(&state, JSC::jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject()), webBuffer);
181
182     return { wrappedWebBuffer, wrappedArrayBuffer };
183 }
184
185 Ref<WebGPUTexture> WebGPUDevice::createTexture(const GPUTextureDescriptor& descriptor) const
186 {
187     auto texture = m_device->tryCreateTexture(descriptor);
188     return WebGPUTexture::create(WTFMove(texture));
189 }
190
191 Ref<WebGPUSampler> WebGPUDevice::createSampler(const GPUSamplerDescriptor& descriptor) const
192 {
193     auto sampler = m_device->tryCreateSampler(descriptor);
194     return WebGPUSampler::create(WTFMove(sampler));
195 }
196
197 Ref<WebGPUBindGroupLayout> WebGPUDevice::createBindGroupLayout(const GPUBindGroupLayoutDescriptor& descriptor) const
198 {
199     auto layout = m_device->tryCreateBindGroupLayout(descriptor);
200     return WebGPUBindGroupLayout::create(WTFMove(layout));
201 }
202
203 Ref<WebGPUPipelineLayout> WebGPUDevice::createPipelineLayout(const WebGPUPipelineLayoutDescriptor& descriptor) const
204 {
205     auto gpuDescriptor = descriptor.tryCreateGPUPipelineLayoutDescriptor();
206     if (!gpuDescriptor)
207         return WebGPUPipelineLayout::create(nullptr);
208     
209     auto layout = m_device->createPipelineLayout(WTFMove(*gpuDescriptor));
210     return WebGPUPipelineLayout::create(WTFMove(layout));
211 }
212
213 Ref<WebGPUBindGroup> WebGPUDevice::createBindGroup(const WebGPUBindGroupDescriptor& descriptor) const
214 {
215     auto gpuDescriptor = descriptor.tryCreateGPUBindGroupDescriptor();
216     if (!gpuDescriptor)
217         return WebGPUBindGroup::create(nullptr);
218
219     auto bindGroup = m_device->tryCreateBindGroup(*gpuDescriptor, m_errorScopes);
220     return WebGPUBindGroup::create(WTFMove(bindGroup));
221 }
222
223 Ref<WebGPUShaderModule> WebGPUDevice::createShaderModule(const WebGPUShaderModuleDescriptor& descriptor) const
224 {
225     // FIXME: What can be validated here?
226     auto module = m_device->tryCreateShaderModule(GPUShaderModuleDescriptor { descriptor.code });
227     return WebGPUShaderModule::create(WTFMove(module), descriptor.code);
228 }
229
230 Ref<WebGPURenderPipeline> WebGPUDevice::createRenderPipeline(const WebGPURenderPipelineDescriptor& descriptor)
231 {
232     m_errorScopes->setErrorPrefix("GPUDevice.createRenderPipeline(): ");
233
234     auto gpuDescriptor = descriptor.tryCreateGPURenderPipelineDescriptor(m_errorScopes);
235     if (!gpuDescriptor)
236         return WebGPURenderPipeline::create(*this, nullptr, m_errorScopes, WTF::nullopt, WTF::nullopt);
237
238     auto gpuPipeline = m_device->tryCreateRenderPipeline(*gpuDescriptor, m_errorScopes);
239
240     WebGPUPipeline::ShaderData vertexShader = { descriptor.vertexStage.module, descriptor.vertexStage.entryPoint };
241
242     Optional<WebGPUPipeline::ShaderData> fragmentShader;
243     if (descriptor.fragmentStage)
244         fragmentShader = { { descriptor.fragmentStage.value().module, descriptor.fragmentStage.value().entryPoint } };
245
246     auto webGPUPipeline = WebGPURenderPipeline::create(*this, WTFMove(gpuPipeline), m_errorScopes, vertexShader, fragmentShader);
247     if (webGPUPipeline->isValid())
248         InspectorInstrumentation::didCreateWebGPUPipeline(*this, webGPUPipeline.get());
249     return webGPUPipeline;
250 }
251
252 Ref<WebGPUComputePipeline> WebGPUDevice::createComputePipeline(const WebGPUComputePipelineDescriptor& descriptor)
253 {
254     m_errorScopes->setErrorPrefix("GPUDevice.createComputePipeline(): ");
255
256     auto gpuDescriptor = descriptor.tryCreateGPUComputePipelineDescriptor(m_errorScopes);
257     if (!gpuDescriptor)
258         return WebGPUComputePipeline::create(*this, nullptr, m_errorScopes, WTF::nullopt);
259
260     auto gpuPipeline = m_device->tryCreateComputePipeline(*gpuDescriptor, m_errorScopes);
261
262     WebGPUPipeline::ShaderData computeShader = { descriptor.computeStage.module, descriptor.computeStage.entryPoint };
263
264     auto webGPUPipeline = WebGPUComputePipeline::create(*this, WTFMove(gpuPipeline), m_errorScopes, computeShader);
265     if (webGPUPipeline->isValid())
266         InspectorInstrumentation::didCreateWebGPUPipeline(*this, webGPUPipeline.get());
267     return webGPUPipeline;
268 }
269
270 Ref<WebGPUCommandEncoder> WebGPUDevice::createCommandEncoder() const
271 {
272     auto commandBuffer = m_device->tryCreateCommandBuffer();
273     return WebGPUCommandEncoder::create(WTFMove(commandBuffer));
274 }
275
276 Ref<WebGPUQueue> WebGPUDevice::getQueue() const
277 {
278     if (!m_queue)
279         m_queue = WebGPUQueue::create(m_device->tryGetQueue());
280
281     return makeRef(*m_queue.get());
282 }
283
284 void WebGPUDevice::popErrorScope(ErrorPromise&& promise)
285 {
286     String failMessage;
287     Optional<GPUError> error = m_errorScopes->popErrorScope(failMessage);
288     if (failMessage.isEmpty())
289         promise.resolve(error);
290     else
291         promise.reject(Exception { OperationError, "GPUDevice::popErrorScope(): " + failMessage });
292 }
293
294 // Errors reported via the validation error event should also appear in the console as warnings.
295 static void printValidationErrorToConsole(GPUError& error, ScriptExecutionContext& context)
296 {
297     if (!WTF::holds_alternative<RefPtr<GPUValidationError>>(error))
298         return;
299
300     auto validationError = WTF::get<RefPtr<GPUValidationError>>(error);
301     if (!validationError)
302         return;
303
304     auto message = validationError->message();
305     auto consoleMessage = makeUnique<Inspector::ConsoleMessage>(MessageSource::Rendering, MessageType::Log, MessageLevel::Warning, message);
306
307     downcast<Document>(context).addConsoleMessage(WTFMove(consoleMessage));
308 }
309
310 void WebGPUDevice::dispatchUncapturedError(GPUError&& error)
311 {
312     printValidationErrorToConsole(error, m_scriptExecutionContext);
313
314     callOnMainThread([error = WTFMove(error), this, protectedThis = makeRef(*this)] () mutable {
315         dispatchEvent(GPUUncapturedErrorEvent::create(eventNames().uncapturederrorEvent, WTFMove(error)));
316     });
317 }
318
319 } // namespace WebCore
320
321 #endif // ENABLE(WEBGPU)