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