Mangled WHLSL names don't need to allocate Strings
[WebKit-https.git] / Source / WebCore / platform / graphics / gpu / cocoa / GPUComputePipelineMetal.mm
1 /*
2  * Copyright (C) 2019 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 #import "config.h"
27 #import "GPUComputePipeline.h"
28
29 #if ENABLE(WEBGPU)
30
31 #import "GPUComputePipelineDescriptor.h"
32 #import "GPUDevice.h"
33 #import "GPUPipelineMetalConvertLayout.h"
34 #import "WHLSLPrepare.h"
35 #import <Metal/Metal.h>
36 #import <wtf/BlockObjCExceptions.h>
37 #import <wtf/text/StringConcatenate.h>
38
39 namespace WebCore {
40
41 static bool trySetMetalFunctions(MTLLibrary *computeMetalLibrary, MTLComputePipelineDescriptor *mtlDescriptor, const String& computeEntryPointName, GPUErrorScopes& errorScopes)
42 {
43     BEGIN_BLOCK_OBJC_EXCEPTIONS;
44
45     if (!computeMetalLibrary) {
46         errorScopes.generatePrefixedError("MTLLibrary for compute stage does not exist!");
47         return false;
48     }
49
50     auto function = adoptNS([computeMetalLibrary newFunctionWithName:computeEntryPointName]);
51     if (!function) {
52         errorScopes.generatePrefixedError(makeString("Cannot create compute MTLFunction '", computeEntryPointName, "'!"));
53         return false;
54     }
55
56     [mtlDescriptor setComputeFunction:function.get()];
57
58     END_BLOCK_OBJC_EXCEPTIONS;
59
60     return true;
61 }
62
63 static Optional<WHLSL::ComputeDimensions> trySetFunctions(const GPUPipelineStageDescriptor& computeStage, const GPUDevice& device, MTLComputePipelineDescriptor* mtlDescriptor, Optional<WHLSL::ComputePipelineDescriptor>& whlslDescriptor, GPUErrorScopes& errorScopes)
64 {
65     RetainPtr<MTLLibrary> computeLibrary;
66     String computeEntryPoint;
67
68     WHLSL::ComputeDimensions computeDimensions { 1, 1, 1 };
69
70     if (whlslDescriptor) {
71         // WHLSL functions are compiled to MSL first.
72         String whlslSource = computeStage.module->whlslSource();
73         ASSERT(!whlslSource.isNull());
74
75         whlslDescriptor->entryPointName = computeStage.entryPoint;
76
77         auto whlslCompileResult = WHLSL::prepare(whlslSource, *whlslDescriptor);
78         if (!whlslCompileResult) {
79             errorScopes.generatePrefixedError(makeString("WHLSL compile error: ", whlslCompileResult.error()));
80             return WTF::nullopt;
81         }
82
83         computeDimensions = whlslCompileResult->computeDimensions;
84
85         NSError *error = nil;
86
87         BEGIN_BLOCK_OBJC_EXCEPTIONS;
88         computeLibrary = adoptNS([device.platformDevice() newLibraryWithSource:whlslCompileResult->metalSource options:nil error:&error]);
89         END_BLOCK_OBJC_EXCEPTIONS;
90 #ifndef NDEBUG
91         if (!computeLibrary)
92             NSLog(@"%@", error);
93 #endif
94         ASSERT(computeLibrary);
95         // FIXME: https://bugs.webkit.org/show_bug.cgi?id=195771 Once we zero-fill variables, there should be no warnings, so we should be able to ASSERT(!error) here.
96
97         computeEntryPoint = whlslCompileResult->mangledEntryPointName.toString();
98     } else {
99         computeLibrary = computeStage.module->platformShaderModule();
100         computeEntryPoint = computeStage.entryPoint;
101     }
102
103     if (trySetMetalFunctions(computeLibrary.get(), mtlDescriptor, computeEntryPoint, errorScopes))
104         return computeDimensions;
105
106     return WTF::nullopt;
107 }
108
109 struct ConvertResult {
110     RetainPtr<MTLComputePipelineDescriptor> pipelineDescriptor;
111     WHLSL::ComputeDimensions computeDimensions;
112 };
113
114 static Optional<ConvertResult> convertComputePipelineDescriptor(const GPUComputePipelineDescriptor& descriptor, const GPUDevice& device, GPUErrorScopes& errorScopes)
115 {
116     RetainPtr<MTLComputePipelineDescriptor> mtlDescriptor;
117
118     BEGIN_BLOCK_OBJC_EXCEPTIONS;
119     mtlDescriptor = adoptNS([MTLComputePipelineDescriptor new]);
120     END_BLOCK_OBJC_EXCEPTIONS;
121
122     if (!mtlDescriptor) {
123         errorScopes.generatePrefixedError("Error creating MTLComputePipelineDescriptor!");
124         return WTF::nullopt;
125     }
126
127     const auto& computeStage = descriptor.computeStage;
128
129     bool isWhlsl = !computeStage.module->whlslSource().isNull();
130
131     Optional<WHLSL::ComputePipelineDescriptor> whlslDescriptor;
132     if (isWhlsl)
133         whlslDescriptor = WHLSL::ComputePipelineDescriptor();
134
135     if (descriptor.layout && whlslDescriptor) {
136         if (auto layout = convertLayout(*descriptor.layout))
137             whlslDescriptor->layout = WTFMove(*layout);
138         else {
139             errorScopes.generatePrefixedError("Error converting GPUPipelineLayout!");
140             return WTF::nullopt;
141         }
142     }
143
144     if (auto computeDimensions = trySetFunctions(computeStage, device, mtlDescriptor.get(), whlslDescriptor, errorScopes))
145         return {{ mtlDescriptor, *computeDimensions }};
146
147     return WTF::nullopt;
148 }
149
150 struct CreateResult {
151     RetainPtr<MTLComputePipelineState> pipelineState;
152     WHLSL::ComputeDimensions computeDimensions;
153 };
154
155 static Optional<CreateResult> tryCreateMTLComputePipelineState(const GPUDevice& device, const GPUComputePipelineDescriptor& descriptor, GPUErrorScopes& errorScopes)
156 {
157     if (!device.platformDevice()) {
158         errorScopes.generatePrefixedError("Invalid GPUDevice!");
159         return WTF::nullopt;
160     }
161
162     auto convertResult = convertComputePipelineDescriptor(descriptor, device, errorScopes);
163     if (!convertResult)
164         return WTF::nullopt;
165     ASSERT(convertResult->pipelineDescriptor);
166     auto mtlDescriptor = convertResult->pipelineDescriptor;
167
168     RetainPtr<MTLComputePipelineState> pipeline;
169
170     BEGIN_BLOCK_OBJC_EXCEPTIONS;
171
172     NSError *error = nil;
173     pipeline = adoptNS([device.platformDevice() newComputePipelineStateWithDescriptor:mtlDescriptor.get() options:MTLPipelineOptionNone reflection:nil error:&error]);
174     if (!pipeline) {
175         errorScopes.generatePrefixedError(error ? error.localizedDescription.UTF8String : "Unable to create MTLComputePipelineState!");
176         return WTF::nullopt;
177     }
178
179     END_BLOCK_OBJC_EXCEPTIONS;
180
181     return {{ pipeline, convertResult->computeDimensions }};
182 }
183
184 RefPtr<GPUComputePipeline> GPUComputePipeline::tryCreate(const GPUDevice& device, const GPUComputePipelineDescriptor& descriptor, GPUErrorScopes& errorScopes)
185 {
186     auto createResult = tryCreateMTLComputePipelineState(device, descriptor, errorScopes);
187     if (!createResult)
188         return nullptr;
189
190     return adoptRef(new GPUComputePipeline(WTFMove(createResult->pipelineState), createResult->computeDimensions, errorScopes));
191 }
192
193 GPUComputePipeline::GPUComputePipeline(RetainPtr<MTLComputePipelineState>&& pipeline, WHLSL::ComputeDimensions computeDimensions, GPUErrorScopes& errorScopes)
194     : GPUObjectBase(makeRef(errorScopes))
195     , m_platformComputePipeline(WTFMove(pipeline))
196     , m_computeDimensions(computeDimensions)
197 {
198 }
199
200 } // namespace WebCore
201
202 #endif // ENABLE(WEBGPU)