| Flutter Impeller |

runtime_stage_data.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "impeller/compiler/runtime_stage_data.h"
6
7 #include <array>
8 #include <cstdint>
9 #include <memory>
10 #include <optional>
11
12 #include "fml/backtrace.h"
13 #include "impeller/core/runtime_types.h"
14 #include "inja/inja.hpp"
15
16 #include "impeller/base/validation.h"
17 #include "impeller/runtime_stage/runtime_stage_flatbuffers.h"
18 #include "runtime_stage_types_flatbuffers.h"
19
20 namespace impeller {
21 namespace compiler {
22
23 RuntimeStageData::RuntimeStageData() = default;
24
25 RuntimeStageData::~RuntimeStageData() = default;
26
27 void RuntimeStageData::AddShader(const std::shared_ptr<Shader>& data) {
28 FML_DCHECK(data);
29 FML_DCHECK(data_.find(data->backend) == data_.end());
30 data_[data->backend] = data;
31 }
32
33 static std::optional<fb::Stage> ToStage(spv::ExecutionModel stage) {
34 switch (stage) {
35 case spv::ExecutionModel::ExecutionModelVertex:
36 return fb::Stage::kVertex;
37 case spv::ExecutionModel::ExecutionModelFragment:
38 return fb::Stage::kFragment;
39 case spv::ExecutionModel::ExecutionModelGLCompute:
40 return fb::Stage::kCompute;
41 default:
42 return std::nullopt;
43 }
44 FML_UNREACHABLE();
45 }
46
47 static std::optional<fb::Stage> ToJsonStage(spv::ExecutionModel stage) {
48 switch (stage) {
49 case spv::ExecutionModel::ExecutionModelVertex:
50 return fb::Stage::kVertex;
51 case spv::ExecutionModel::ExecutionModelFragment:
52 return fb::Stage::kFragment;
53 case spv::ExecutionModel::ExecutionModelGLCompute:
54 return fb::Stage::kCompute;
55 default:
56 return std::nullopt;
57 }
58 FML_UNREACHABLE();
59 }
60
61 static std::optional<fb::UniformDataType> ToUniformType(
62 spirv_cross::SPIRType::BaseType type) {
63 switch (type) {
64 case spirv_cross::SPIRType::Float:
65 return fb::UniformDataType::kFloat;
66 case spirv_cross::SPIRType::SampledImage:
67 return fb::UniformDataType::kSampledImage;
68 case spirv_cross::SPIRType::Struct:
69 return fb::UniformDataType::kStruct;
70 case spirv_cross::SPIRType::Boolean:
71 case spirv_cross::SPIRType::SByte:
72 case spirv_cross::SPIRType::UByte:
73 case spirv_cross::SPIRType::Short:
74 case spirv_cross::SPIRType::UShort:
75 case spirv_cross::SPIRType::Int:
76 case spirv_cross::SPIRType::UInt:
77 case spirv_cross::SPIRType::Int64:
78 case spirv_cross::SPIRType::UInt64:
79 case spirv_cross::SPIRType::Half:
80 case spirv_cross::SPIRType::Double:
81 case spirv_cross::SPIRType::AccelerationStructure:
82 case spirv_cross::SPIRType::AtomicCounter:
83 case spirv_cross::SPIRType::Char:
84 case spirv_cross::SPIRType::ControlPointArray:
85 case spirv_cross::SPIRType::Image:
86 case spirv_cross::SPIRType::Interpolant:
87 case spirv_cross::SPIRType::RayQuery:
88 case spirv_cross::SPIRType::Sampler:
89 case spirv_cross::SPIRType::Unknown:
90 case spirv_cross::SPIRType::Void:
91 return std::nullopt;
92 }
93 FML_UNREACHABLE();
94 }
95 static std::optional<fb::InputDataType> ToInputType(
96 spirv_cross::SPIRType::BaseType type) {
97 switch (type) {
98 case spirv_cross::SPIRType::Boolean:
99 return fb::InputDataType::kBoolean;
100 case spirv_cross::SPIRType::SByte:
101 return fb::InputDataType::kSignedByte;
102 case spirv_cross::SPIRType::UByte:
103 return fb::InputDataType::kUnsignedByte;
104 case spirv_cross::SPIRType::Short:
105 return fb::InputDataType::kSignedShort;
106 case spirv_cross::SPIRType::UShort:
107 return fb::InputDataType::kUnsignedShort;
108 case spirv_cross::SPIRType::Int:
109 return fb::InputDataType::kSignedInt;
110 case spirv_cross::SPIRType::UInt:
111 return fb::InputDataType::kUnsignedInt;
112 case spirv_cross::SPIRType::Int64:
113 return fb::InputDataType::kSignedInt64;
114 case spirv_cross::SPIRType::UInt64:
115 return fb::InputDataType::kUnsignedInt64;
116 case spirv_cross::SPIRType::Float:
117 return fb::InputDataType::kFloat;
118 case spirv_cross::SPIRType::Double:
119 return fb::InputDataType::kDouble;
120 case spirv_cross::SPIRType::Unknown:
121 case spirv_cross::SPIRType::Void:
122 case spirv_cross::SPIRType::Half:
123 case spirv_cross::SPIRType::AtomicCounter:
124 case spirv_cross::SPIRType::Struct:
125 case spirv_cross::SPIRType::Image:
126 case spirv_cross::SPIRType::SampledImage:
127 case spirv_cross::SPIRType::Sampler:
128 case spirv_cross::SPIRType::AccelerationStructure:
129 case spirv_cross::SPIRType::RayQuery:
130 case spirv_cross::SPIRType::ControlPointArray:
131 case spirv_cross::SPIRType::Interpolant:
132 case spirv_cross::SPIRType::Char:
133 return std::nullopt;
134 }
135 FML_UNREACHABLE();
136 }
137
138 static std::optional<uint32_t> ToJsonType(
139 spirv_cross::SPIRType::BaseType type) {
140 switch (type) {
141 case spirv_cross::SPIRType::Boolean:
142 return 0; // fb::UniformDataType::kBoolean;
143 case spirv_cross::SPIRType::SByte:
144 return 1; // fb::UniformDataType::kSignedByte;
145 case spirv_cross::SPIRType::UByte:
146 return 2; // fb::UniformDataType::kUnsignedByte;
147 case spirv_cross::SPIRType::Short:
148 return 3; // fb::UniformDataType::kSignedShort;
149 case spirv_cross::SPIRType::UShort:
150 return 4; // fb::UniformDataType::kUnsignedShort;
151 case spirv_cross::SPIRType::Int:
152 return 5; // fb::UniformDataType::kSignedInt;
153 case spirv_cross::SPIRType::UInt:
154 return 6; // fb::UniformDataType::kUnsignedInt;
155 case spirv_cross::SPIRType::Int64:
156 return 7; // fb::UniformDataType::kSignedInt64;
157 case spirv_cross::SPIRType::UInt64:
158 return 8; // fb::UniformDataType::kUnsignedInt64;
159 case spirv_cross::SPIRType::Half:
160 return 9; // b::UniformDataType::kHalfFloat;
161 case spirv_cross::SPIRType::Float:
162 return 10; // fb::UniformDataType::kFloat;
163 case spirv_cross::SPIRType::Double:
164 return 11; // fb::UniformDataType::kDouble;
165 case spirv_cross::SPIRType::SampledImage:
166 return 12; // fb::UniformDataType::kSampledImage;
167 case spirv_cross::SPIRType::Struct:
168 return 13;
169 case spirv_cross::SPIRType::AccelerationStructure:
170 case spirv_cross::SPIRType::AtomicCounter:
171 case spirv_cross::SPIRType::Char:
172 case spirv_cross::SPIRType::ControlPointArray:
173 case spirv_cross::SPIRType::Image:
174 case spirv_cross::SPIRType::Interpolant:
175 case spirv_cross::SPIRType::RayQuery:
176 case spirv_cross::SPIRType::Sampler:
177 case spirv_cross::SPIRType::Unknown:
178 case spirv_cross::SPIRType::Void:
179 return std::nullopt;
180 }
181 FML_UNREACHABLE();
182 }
183
184 static const char* kStageKey = "stage";
185 static const char* kTargetPlatformKey = "target_platform";
186 static const char* kEntrypointKey = "entrypoint";
187 static const char* kUniformsKey = "uniforms";
188 static const char* kShaderKey = "shader";
189 static const char* kUniformNameKey = "name";
190 static const char* kUniformLocationKey = "location";
191 static const char* kUniformTypeKey = "type";
192 static const char* kUniformRowsKey = "rows";
193 static const char* kUniformColumnsKey = "columns";
194 static const char* kUniformBitWidthKey = "bit_width";
195 static const char* kUniformArrayElementsKey = "array_elements";
196
197 static std::string RuntimeStageBackendToString(RuntimeStageBackend backend) {
198 switch (backend) {
199 case RuntimeStageBackend::kSkSL:
200 return "sksl";
201 case RuntimeStageBackend::kMetal:
202 return "metal";
203 case RuntimeStageBackend::kOpenGLES:
204 return "opengles";
205 case RuntimeStageBackend::kVulkan:
206 return "vulkan";
207 }
208 }
209
210 std::shared_ptr<fml::Mapping> RuntimeStageData::CreateJsonMapping() const {
211 // Runtime Stage Data JSON format
212 // {
213 // "sksl": {
214 // "stage": 0,
215 // "entrypoint": "",
216 // "shader": "",
217 // "uniforms": [
218 // {
219 // "name": "..",
220 // "location": 0,
221 // "type": 0,
222 // "rows": 0,
223 // "columns": 0,
224 // "bit_width": 0,
225 // "array_elements": 0,
226 // }
227 // ]
228 // },
229 // "metal": ...
230 // },
231 nlohmann::json root;
232
233 for (const auto& kvp : data_) {
234 nlohmann::json platform_object;
235
236 const auto stage = ToJsonStage(kvp.second->stage);
237 if (!stage.has_value()) {
238 VALIDATION_LOG << "Invalid runtime stage.";
239 return nullptr;
240 }
241 platform_object[kStageKey] = static_cast<uint32_t>(stage.value());
242 platform_object[kEntrypointKey] = kvp.second->entrypoint;
243
244 if (kvp.second->shader->GetSize() > 0u) {
245 std::string shader(
246 reinterpret_cast<const char*>(kvp.second->shader->GetMapping()),
247 kvp.second->shader->GetSize());
248 platform_object[kShaderKey] = shader.c_str();
249 }
250
251 auto& uniforms = platform_object[kUniformsKey] = nlohmann::json::array_t{};
252 for (const auto& uniform : kvp.second->uniforms) {
253 nlohmann::json uniform_object;
254 uniform_object[kUniformNameKey] = uniform.name.c_str();
255 uniform_object[kUniformLocationKey] = uniform.location;
256 uniform_object[kUniformRowsKey] = uniform.rows;
257 uniform_object[kUniformColumnsKey] = uniform.columns;
258
259 auto uniform_type = ToJsonType(uniform.type);
260 if (!uniform_type.has_value()) {
261 VALIDATION_LOG << "Invalid uniform type for runtime stage.";
262 return nullptr;
263 }
264
265 uniform_object[kUniformTypeKey] = uniform_type.value();
266 uniform_object[kUniformBitWidthKey] = uniform.bit_width;
267 uniform_object[kUniformArrayElementsKey] =
268 uniform.array_elements.value_or(0);
269
270 uniforms.push_back(uniform_object);
271 }
272
273 root[RuntimeStageBackendToString(kvp.first)] = platform_object;
274 }
275
276 auto json_string = std::make_shared<std::string>(root.dump(2u));
277
278 return std::make_shared<fml::NonOwnedMapping>(
279 reinterpret_cast<const uint8_t*>(json_string->data()),
280 json_string->size(), [json_string](auto, auto) {});
281 }
282
283 std::unique_ptr<fb::RuntimeStageT> RuntimeStageData::CreateStageFlatbuffer(
284 impeller::RuntimeStageBackend backend) const {
285 auto kvp = data_.find(backend);
286 if (kvp == data_.end()) {
287 return nullptr;
288 }
289
290 auto runtime_stage = std::make_unique<fb::RuntimeStageT>();
291 runtime_stage->entrypoint = kvp->second->entrypoint;
292 const auto stage = ToStage(kvp->second->stage);
293 if (!stage.has_value()) {
294 VALIDATION_LOG << "Invalid runtime stage.";
295 return nullptr;
296 }
297 runtime_stage->stage = stage.value();
298 if (!kvp->second->shader) {
299 VALIDATION_LOG << "No shader specified for runtime stage.";
300 return nullptr;
301 }
302 if (kvp->second->shader->GetSize() > 0u) {
303 runtime_stage->shader = {
304 kvp->second->shader->GetMapping(),
305 kvp->second->shader->GetMapping() + kvp->second->shader->GetSize()};
306 }
307 for (const auto& uniform : kvp->second->uniforms) {
308 auto desc = std::make_unique<fb::UniformDescriptionT>();
309
310 desc->name = uniform.name;
311 if (desc->name.empty()) {
312 VALIDATION_LOG << "Uniform name cannot be empty.";
313 return nullptr;
314 }
315 desc->location = uniform.location;
316 desc->rows = uniform.rows;
317 desc->columns = uniform.columns;
318 auto uniform_type = ToUniformType(uniform.type);
319 if (!uniform_type.has_value()) {
320 VALIDATION_LOG << "Invalid uniform type for runtime stage.";
321 return nullptr;
322 }
323 desc->type = uniform_type.value();
324 desc->bit_width = uniform.bit_width;
325 if (uniform.array_elements.has_value()) {
326 desc->array_elements = uniform.array_elements.value();
327 }
328
329 for (const auto& byte_type : uniform.struct_layout) {
330 desc->struct_layout.push_back(static_cast<fb::StructByteType>(byte_type));
331 }
332 desc->struct_float_count = uniform.struct_float_count;
333
334 runtime_stage->uniforms.emplace_back(std::move(desc));
335 }
336
337 for (const auto& input : kvp->second->inputs) {
338 auto desc = std::make_unique<fb::StageInputT>();
339
340 desc->name = input.name;
341
342 if (desc->name.empty()) {
343 VALIDATION_LOG << "Stage input name cannot be empty.";
344 return nullptr;
345 }
346 desc->location = input.location;
347 desc->set = input.set;
348 desc->binding = input.binding;
349 auto input_type = ToInputType(input.type);
350 if (!input_type.has_value()) {
351 VALIDATION_LOG << "Invalid uniform type for runtime stage.";
352 return nullptr;
353 }
354 desc->type = input_type.value();
355 desc->bit_width = input.bit_width;
356 desc->vec_size = input.vec_size;
357 desc->columns = input.columns;
358 desc->offset = input.offset;
359
360 runtime_stage->inputs.emplace_back(std::move(desc));
361 }
362
363 return runtime_stage;
364 }
365
366 std::unique_ptr<fb::RuntimeStagesT>
367 RuntimeStageData::CreateMultiStageFlatbuffer() const {
368 // The high level object API is used here for writing to the buffer. This is
369 // just a convenience.
370 auto runtime_stages = std::make_unique<fb::RuntimeStagesT>();
371
372 for (const auto& kvp : data_) {
373 auto runtime_stage = CreateStageFlatbuffer(kvp.first);
374 switch (kvp.first) {
375 case RuntimeStageBackend::kSkSL:
376 runtime_stages->sksl = std::move(runtime_stage);
377 break;
378 case RuntimeStageBackend::kMetal:
379 runtime_stages->metal = std::move(runtime_stage);
380 break;
381 case RuntimeStageBackend::kOpenGLES:
382 runtime_stages->opengles = std::move(runtime_stage);
383 break;
384 case RuntimeStageBackend::kVulkan:
385 runtime_stages->vulkan = std::move(runtime_stage);
386 break;
387 }
388 }
389 return runtime_stages;
390 }
391
392 std::shared_ptr<fml::Mapping> RuntimeStageData::CreateMapping() const {
393 auto runtime_stages = CreateMultiStageFlatbuffer();
394 if (!runtime_stages) {
395 return nullptr;
396 }
397
398 auto builder = std::make_shared<flatbuffers::FlatBufferBuilder>();
399 builder->Finish(fb::RuntimeStages::Pack(*builder.get(), runtime_stages.get()),
400 fb::RuntimeStagesIdentifier());
401 return std::make_shared<fml::NonOwnedMapping>(builder->GetBufferPointer(),
402 builder->GetSize(),
403 [builder](auto, auto) {});
404 }
405
406 } // namespace compiler
407 } // namespace impeller
impeller::compiler::ToInputType
static std::optional< fb::InputDataType > ToInputType(spirv_cross::SPIRType::BaseType type)
Definition: runtime_stage_data.cc:95
impeller::kFloat
@ kFloat
Definition: runtime_types.h:23
runtime_stage_data.h
impeller::compiler::RuntimeStageData::~RuntimeStageData
~RuntimeStageData()
impeller::compiler::RuntimeStageData::CreateJsonMapping
std::shared_ptr< fml::Mapping > CreateJsonMapping() const
Definition: runtime_stage_data.cc:210
impeller::RuntimeStageBackend::kVulkan
@ kVulkan
impeller::compiler::kUniformBitWidthKey
static const char * kUniformBitWidthKey
Definition: runtime_stage_data.cc:194
data
std::shared_ptr< const fml::Mapping > data
Definition: texture_gles.cc:63
impeller::kSampledImage
@ kSampledImage
Definition: runtime_types.h:24
impeller::compiler::kEntrypointKey
static const char * kEntrypointKey
Definition: runtime_stage_data.cc:186
impeller::compiler::kTargetPlatformKey
static const char * kTargetPlatformKey
Definition: runtime_stage_data.cc:185
impeller::compiler::RuntimeStageData::AddShader
void AddShader(const std::shared_ptr< Shader > &data)
Definition: runtime_stage_data.cc:27
validation.h
impeller::compiler::RuntimeStageData::CreateStageFlatbuffer
std::unique_ptr< fb::RuntimeStageT > CreateStageFlatbuffer(impeller::RuntimeStageBackend backend) const
Definition: runtime_stage_data.cc:283
runtime_types.h
impeller::RuntimeStageBackend::kOpenGLES
@ kOpenGLES
impeller::compiler::RuntimeStageData::CreateMapping
std::shared_ptr< fml::Mapping > CreateMapping() const
Definition: runtime_stage_data.cc:392
impeller::compiler::kUniformNameKey
static const char * kUniformNameKey
Definition: runtime_stage_data.cc:189
impeller::compiler::kUniformColumnsKey
static const char * kUniformColumnsKey
Definition: runtime_stage_data.cc:193
impeller::compiler::kShaderKey
static const char * kShaderKey
Definition: runtime_stage_data.cc:188
impeller::RuntimeStageBackend
RuntimeStageBackend
Definition: runtime_types.h:15
impeller::compiler::kUniformTypeKey
static const char * kUniformTypeKey
Definition: runtime_stage_data.cc:191
impeller::compiler::kStageKey
static const char * kStageKey
Definition: runtime_stage_data.cc:184
impeller::compiler::ToStage
static std::optional< fb::Stage > ToStage(spv::ExecutionModel stage)
Definition: runtime_stage_data.cc:33
type
GLenum type
Definition: blit_command_gles.cc:127
impeller::compiler::kUniformArrayElementsKey
static const char * kUniformArrayElementsKey
Definition: runtime_stage_data.cc:195
impeller::kStruct
@ kStruct
Definition: runtime_types.h:25
impeller::compiler::ToJsonType
static std::optional< uint32_t > ToJsonType(spirv_cross::SPIRType::BaseType type)
Definition: runtime_stage_data.cc:138
impeller::compiler::RuntimeStageBackendToString
static std::string RuntimeStageBackendToString(RuntimeStageBackend backend)
Definition: runtime_stage_data.cc:197
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:91
impeller::compiler::kUniformLocationKey
static const char * kUniformLocationKey
Definition: runtime_stage_data.cc:190
impeller::RuntimeStageBackend::kSkSL
@ kSkSL
impeller::compiler::kUniformsKey
static const char * kUniformsKey
Definition: runtime_stage_data.cc:187
impeller::compiler::kUniformRowsKey
static const char * kUniformRowsKey
Definition: runtime_stage_data.cc:192
impeller::compiler::RuntimeStageData::RuntimeStageData
RuntimeStageData()
impeller::compiler::ToUniformType
static std::optional< fb::UniformDataType > ToUniformType(spirv_cross::SPIRType::BaseType type)
Definition: runtime_stage_data.cc:61
impeller::compiler::RuntimeStageData::CreateMultiStageFlatbuffer
std::unique_ptr< fb::RuntimeStagesT > CreateMultiStageFlatbuffer() const
Definition: runtime_stage_data.cc:367
impeller::RuntimeStageBackend::kMetal
@ kMetal
impeller::compiler::ToJsonStage
static std::optional< fb::Stage > ToJsonStage(spv::ExecutionModel stage)
Definition: runtime_stage_data.cc:47
impeller
Definition: allocation.cc:12