blob: 3088dad18fc4094e11e9f5c914a73811192eec4f [file] [log] [blame]
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001/* Copyright (c) 2021-2022 The Khronos Group Inc.
sfricke-samsung962cad92021-04-13 00:46:29 -07002 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 *
15 * Author: Spencer Fricke <s.fricke@samsung.com>
16 */
17
18#include "shader_module.h"
19
20#include <sstream>
21#include <string>
22
23#include "vk_layer_data.h"
24#include "vk_layer_utils.h"
Jeremy Gebben5d970742021-05-31 16:04:14 -060025#include "pipeline_state.h"
26#include "descriptor_sets.h"
sfricke-samsung3c5dee22021-10-14 09:58:14 -070027#include "spirv_grammar_helper.h"
sfricke-samsung962cad92021-04-13 00:46:29 -070028
29void decoration_set::merge(decoration_set const &other) {
30 if (other.flags & location_bit) location = other.location;
31 if (other.flags & component_bit) component = other.component;
32 if (other.flags & input_attachment_index_bit) input_attachment_index = other.input_attachment_index;
33 if (other.flags & descriptor_set_bit) descriptor_set = other.descriptor_set;
34 if (other.flags & binding_bit) binding = other.binding;
35 if (other.flags & builtin_bit) builtin = other.builtin;
36 flags |= other.flags;
37}
38
39void decoration_set::add(uint32_t decoration, uint32_t value) {
40 switch (decoration) {
41 case spv::DecorationLocation:
42 flags |= location_bit;
43 location = value;
44 break;
45 case spv::DecorationPatch:
46 flags |= patch_bit;
47 break;
48 case spv::DecorationRelaxedPrecision:
49 flags |= relaxed_precision_bit;
50 break;
51 case spv::DecorationBlock:
52 flags |= block_bit;
53 break;
54 case spv::DecorationBufferBlock:
55 flags |= buffer_block_bit;
56 break;
57 case spv::DecorationComponent:
58 flags |= component_bit;
59 component = value;
60 break;
61 case spv::DecorationInputAttachmentIndex:
62 flags |= input_attachment_index_bit;
63 input_attachment_index = value;
64 break;
65 case spv::DecorationDescriptorSet:
66 flags |= descriptor_set_bit;
67 descriptor_set = value;
68 break;
69 case spv::DecorationBinding:
70 flags |= binding_bit;
71 binding = value;
72 break;
73 case spv::DecorationNonWritable:
74 flags |= nonwritable_bit;
75 break;
76 case spv::DecorationBuiltIn:
77 flags |= builtin_bit;
78 builtin = value;
79 break;
Lionel Landwerlin38d2e122021-07-21 14:21:47 +030080 case spv::DecorationNonReadable:
81 flags |= nonreadable_bit;
82 break;
ziga-lunarg9e94e112021-09-27 00:21:10 +020083 case spv::DecorationPerVertexNV:
84 flags |= per_vertex_bit;
85 break;
86 case spv::DecorationPassthroughNV:
87 flags |= passthrough_bit;
88 break;
sfricke-samsung962cad92021-04-13 00:46:29 -070089 }
90}
91
92std::string shader_struct_member::GetLocationDesc(uint32_t index_used_bytes) const {
93 std::string desc = "";
94 if (array_length_hierarchy.size() > 0) {
95 desc += " index:";
96 for (const auto block_size : array_block_size) {
97 desc += "[";
98 desc += std::to_string(index_used_bytes / (block_size * size));
99 desc += "]";
100 index_used_bytes = index_used_bytes % (block_size * size);
101 }
102 }
103 const int struct_members_size = static_cast<int>(struct_members.size());
104 if (struct_members_size > 0) {
105 desc += " member:";
106 for (int i = struct_members_size - 1; i >= 0; --i) {
107 if (index_used_bytes > struct_members[i].offset) {
108 desc += std::to_string(i);
109 desc += struct_members[i].GetLocationDesc(index_used_bytes - struct_members[i].offset);
110 break;
111 }
112 }
113 } else {
114 desc += " offset:";
115 desc += std::to_string(index_used_bytes);
116 }
117 return desc;
118}
119
120static unsigned ExecutionModelToShaderStageFlagBits(unsigned mode) {
121 switch (mode) {
122 case spv::ExecutionModelVertex:
123 return VK_SHADER_STAGE_VERTEX_BIT;
124 case spv::ExecutionModelTessellationControl:
125 return VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT;
126 case spv::ExecutionModelTessellationEvaluation:
127 return VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT;
128 case spv::ExecutionModelGeometry:
129 return VK_SHADER_STAGE_GEOMETRY_BIT;
130 case spv::ExecutionModelFragment:
131 return VK_SHADER_STAGE_FRAGMENT_BIT;
132 case spv::ExecutionModelGLCompute:
133 return VK_SHADER_STAGE_COMPUTE_BIT;
134 case spv::ExecutionModelRayGenerationNV:
135 return VK_SHADER_STAGE_RAYGEN_BIT_NV;
136 case spv::ExecutionModelAnyHitNV:
137 return VK_SHADER_STAGE_ANY_HIT_BIT_NV;
138 case spv::ExecutionModelClosestHitNV:
139 return VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV;
140 case spv::ExecutionModelMissNV:
141 return VK_SHADER_STAGE_MISS_BIT_NV;
142 case spv::ExecutionModelIntersectionNV:
143 return VK_SHADER_STAGE_INTERSECTION_BIT_NV;
144 case spv::ExecutionModelCallableNV:
145 return VK_SHADER_STAGE_CALLABLE_BIT_NV;
146 case spv::ExecutionModelTaskNV:
147 return VK_SHADER_STAGE_TASK_BIT_NV;
148 case spv::ExecutionModelMeshNV:
149 return VK_SHADER_STAGE_MESH_BIT_NV;
150 default:
151 return 0;
152 }
153}
154
155// For some analyses, we need to know about all ids referenced by the static call tree of a particular entrypoint. This is
156// important for identifying the set of shader resources actually used by an entrypoint, for example.
157// Note: we only explore parts of the image which might actually contain ids we care about for the above analyses.
158// - NOT the shader input/output interfaces.
159//
160// TODO: The set of interesting opcodes here was determined by eyeballing the SPIRV spec. It might be worth
161// converting parts of this to be generated from the machine-readable spec instead.
162layer_data::unordered_set<uint32_t> SHADER_MODULE_STATE::MarkAccessibleIds(spirv_inst_iter entrypoint) const {
163 layer_data::unordered_set<uint32_t> ids;
Jeremy Gebben84b838b2021-08-23 08:41:39 -0600164 if (entrypoint == end() || !has_valid_spirv) {
165 return ids;
166 }
sfricke-samsung962cad92021-04-13 00:46:29 -0700167 layer_data::unordered_set<uint32_t> worklist;
168 worklist.insert(entrypoint.word(2));
169
170 while (!worklist.empty()) {
171 auto id_iter = worklist.begin();
172 auto id = *id_iter;
173 worklist.erase(id_iter);
174
175 auto insn = get_def(id);
176 if (insn == end()) {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600177 // ID is something we didn't collect in SpirvStaticData. that's OK -- we'll stumble across all kinds of things here
sfricke-samsung962cad92021-04-13 00:46:29 -0700178 // that we may not care about.
179 continue;
180 }
181
182 // Try to add to the output set
183 if (!ids.insert(id).second) {
184 continue; // If we already saw this id, we don't want to walk it again.
185 }
186
187 switch (insn.opcode()) {
188 case spv::OpFunction:
189 // Scan whole body of the function, enlisting anything interesting
190 while (++insn, insn.opcode() != spv::OpFunctionEnd) {
191 switch (insn.opcode()) {
192 case spv::OpLoad:
193 worklist.insert(insn.word(3)); // ptr
194 break;
195 case spv::OpStore:
196 worklist.insert(insn.word(1)); // ptr
197 break;
198 case spv::OpAccessChain:
199 case spv::OpInBoundsAccessChain:
200 worklist.insert(insn.word(3)); // base ptr
201 break;
202 case spv::OpSampledImage:
203 case spv::OpImageSampleImplicitLod:
204 case spv::OpImageSampleExplicitLod:
205 case spv::OpImageSampleDrefImplicitLod:
206 case spv::OpImageSampleDrefExplicitLod:
207 case spv::OpImageSampleProjImplicitLod:
208 case spv::OpImageSampleProjExplicitLod:
209 case spv::OpImageSampleProjDrefImplicitLod:
210 case spv::OpImageSampleProjDrefExplicitLod:
211 case spv::OpImageFetch:
212 case spv::OpImageGather:
213 case spv::OpImageDrefGather:
214 case spv::OpImageRead:
215 case spv::OpImage:
216 case spv::OpImageQueryFormat:
217 case spv::OpImageQueryOrder:
218 case spv::OpImageQuerySizeLod:
219 case spv::OpImageQuerySize:
220 case spv::OpImageQueryLod:
221 case spv::OpImageQueryLevels:
222 case spv::OpImageQuerySamples:
223 case spv::OpImageSparseSampleImplicitLod:
224 case spv::OpImageSparseSampleExplicitLod:
225 case spv::OpImageSparseSampleDrefImplicitLod:
226 case spv::OpImageSparseSampleDrefExplicitLod:
227 case spv::OpImageSparseSampleProjImplicitLod:
228 case spv::OpImageSparseSampleProjExplicitLod:
229 case spv::OpImageSparseSampleProjDrefImplicitLod:
230 case spv::OpImageSparseSampleProjDrefExplicitLod:
231 case spv::OpImageSparseFetch:
232 case spv::OpImageSparseGather:
233 case spv::OpImageSparseDrefGather:
234 case spv::OpImageTexelPointer:
235 worklist.insert(insn.word(3)); // Image or sampled image
236 break;
237 case spv::OpImageWrite:
238 worklist.insert(insn.word(1)); // Image -- different operand order to above
239 break;
240 case spv::OpFunctionCall:
241 for (uint32_t i = 3; i < insn.len(); i++) {
242 worklist.insert(insn.word(i)); // fn itself, and all args
243 }
244 break;
245
246 case spv::OpExtInst:
247 for (uint32_t i = 5; i < insn.len(); i++) {
248 worklist.insert(insn.word(i)); // Operands to ext inst
249 }
250 break;
251
252 default: {
253 if (AtomicOperation(insn.opcode())) {
254 if (insn.opcode() == spv::OpAtomicStore) {
255 worklist.insert(insn.word(1)); // ptr
256 } else {
257 worklist.insert(insn.word(3)); // ptr
258 }
259 }
260 break;
261 }
262 }
263 }
264 break;
265 }
266 }
267
268 return ids;
269}
270
Jeremy Gebben84b838b2021-08-23 08:41:39 -0600271layer_data::optional<VkPrimitiveTopology> SHADER_MODULE_STATE::GetTopology(const spirv_inst_iter &entrypoint) const {
272 layer_data::optional<VkPrimitiveTopology> result;
273
sfricke-samsung962cad92021-04-13 00:46:29 -0700274 auto entrypoint_id = entrypoint.word(2);
275 bool is_point_mode = false;
276
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600277 auto it = static_data_.execution_mode_inst.find(entrypoint_id);
278 if (it != static_data_.execution_mode_inst.end()) {
sfricke-samsung962cad92021-04-13 00:46:29 -0700279 for (auto insn : it->second) {
280 switch (insn.word(2)) {
281 case spv::ExecutionModePointMode:
282 // In tessellation shaders, PointMode is separate and trumps the tessellation topology.
283 is_point_mode = true;
284 break;
285
286 case spv::ExecutionModeOutputPoints:
Jeremy Gebben84b838b2021-08-23 08:41:39 -0600287 result.emplace(VK_PRIMITIVE_TOPOLOGY_POINT_LIST);
sfricke-samsung962cad92021-04-13 00:46:29 -0700288 break;
289
290 case spv::ExecutionModeIsolines:
291 case spv::ExecutionModeOutputLineStrip:
Ricardo Garcia122f8f02021-09-28 16:47:19 +0200292 case spv::ExecutionModeOutputLinesNV:
Jeremy Gebben84b838b2021-08-23 08:41:39 -0600293 result.emplace(VK_PRIMITIVE_TOPOLOGY_LINE_STRIP);
sfricke-samsung962cad92021-04-13 00:46:29 -0700294 break;
295
296 case spv::ExecutionModeTriangles:
297 case spv::ExecutionModeQuads:
298 case spv::ExecutionModeOutputTriangleStrip:
299 case spv::ExecutionModeOutputTrianglesNV:
Jeremy Gebben84b838b2021-08-23 08:41:39 -0600300 result.emplace(VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP);
sfricke-samsung962cad92021-04-13 00:46:29 -0700301 break;
302 }
303 }
304 }
305
Jeremy Gebben84b838b2021-08-23 08:41:39 -0600306 if (is_point_mode) {
307 result.emplace(VK_PRIMITIVE_TOPOLOGY_POINT_LIST);
308 }
309
310 return result;
sfricke-samsung962cad92021-04-13 00:46:29 -0700311}
312
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600313SHADER_MODULE_STATE::SpirvStaticData::SpirvStaticData(const SHADER_MODULE_STATE &mod) {
314 for (auto insn : mod) {
sfricke-samsung962cad92021-04-13 00:46:29 -0700315 switch (insn.opcode()) {
316 // Types
317 case spv::OpTypeVoid:
318 case spv::OpTypeBool:
319 case spv::OpTypeInt:
320 case spv::OpTypeFloat:
321 case spv::OpTypeVector:
322 case spv::OpTypeMatrix:
323 case spv::OpTypeImage:
324 case spv::OpTypeSampler:
325 case spv::OpTypeSampledImage:
326 case spv::OpTypeArray:
327 case spv::OpTypeRuntimeArray:
328 case spv::OpTypeStruct:
329 case spv::OpTypeOpaque:
330 case spv::OpTypePointer:
331 case spv::OpTypeFunction:
332 case spv::OpTypeEvent:
333 case spv::OpTypeDeviceEvent:
334 case spv::OpTypeReserveId:
335 case spv::OpTypeQueue:
336 case spv::OpTypePipe:
337 case spv::OpTypeAccelerationStructureNV:
338 case spv::OpTypeCooperativeMatrixNV:
339 def_index[insn.word(1)] = insn.offset();
340 break;
341
342 // Fixed constants
343 case spv::OpConstantTrue:
344 case spv::OpConstantFalse:
345 case spv::OpConstant:
346 case spv::OpConstantComposite:
347 case spv::OpConstantSampler:
348 case spv::OpConstantNull:
349 def_index[insn.word(2)] = insn.offset();
350 break;
351
352 // Specialization constants
353 case spv::OpSpecConstantTrue:
354 case spv::OpSpecConstantFalse:
355 case spv::OpSpecConstant:
356 case spv::OpSpecConstantComposite:
357 case spv::OpSpecConstantOp:
358 def_index[insn.word(2)] = insn.offset();
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600359 has_specialization_constants = true;
sfricke-samsung962cad92021-04-13 00:46:29 -0700360 break;
361
sfricke-samsung58b84352021-07-31 21:41:04 -0700362 // Have a result that can be a pointer
sfricke-samsung962cad92021-04-13 00:46:29 -0700363 case spv::OpVariable:
sfricke-samsung58b84352021-07-31 21:41:04 -0700364 case spv::OpAccessChain:
365 case spv::OpInBoundsAccessChain:
366 case spv::OpFunctionParameter:
367 case spv::OpImageTexelPointer:
sfricke-samsung962cad92021-04-13 00:46:29 -0700368 def_index[insn.word(2)] = insn.offset();
369 break;
370
sfricke-samsungdb3f3f82022-01-18 06:41:15 -0800371 // Will need to extract loads for SAMPLED_IMAGE and SAMPLER
372 case spv::OpSampledImage:
373 def_index[insn.word(2)] = insn.offset();
374 break;
375
sfricke-samsung962cad92021-04-13 00:46:29 -0700376 // Functions
377 case spv::OpFunction:
378 def_index[insn.word(2)] = insn.offset();
sfricke-samsung962cad92021-04-13 00:46:29 -0700379 break;
380
381 // Decorations
382 case spv::OpDecorate: {
383 auto target_id = insn.word(1);
384 decorations[target_id].add(insn.word(2), insn.len() > 3u ? insn.word(3) : 0u);
385 decoration_inst.push_back(insn);
386 if (insn.word(2) == spv::DecorationBuiltIn) {
387 builtin_decoration_list.emplace_back(insn.offset(), static_cast<spv::BuiltIn>(insn.word(3)));
Nathaniel Cesariocf69bda2021-06-22 13:23:42 -0600388 } else if (insn.word(2) == spv::DecorationSpecId) {
389 spec_const_map[insn.word(3)] = target_id;
sfricke-samsung962cad92021-04-13 00:46:29 -0700390 }
391
392 } break;
393 case spv::OpGroupDecorate: {
394 auto const &src = decorations[insn.word(1)];
395 for (auto i = 2u; i < insn.len(); i++) decorations[insn.word(i)].merge(src);
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600396 has_group_decoration = true;
397 } break;
398 case spv::OpDecorationGroup:
399 case spv::OpGroupMemberDecorate: {
400 has_group_decoration = true;
sfricke-samsung962cad92021-04-13 00:46:29 -0700401 } break;
402 case spv::OpMemberDecorate: {
403 member_decoration_inst.push_back(insn);
404 if (insn.word(3) == spv::DecorationBuiltIn) {
405 builtin_decoration_list.emplace_back(insn.offset(), static_cast<spv::BuiltIn>(insn.word(4)));
406 }
407 } break;
408
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600409 // Copy operations
410 case spv::OpCopyLogical:
411 case spv::OpCopyObject: {
412 def_index[insn.word(2)] = insn.offset();
413 break;
414 }
sfricke-samsung962cad92021-04-13 00:46:29 -0700415
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600416 // Execution Mode
417 case spv::OpExecutionMode: {
418 execution_mode_inst[insn.word(1)].push_back(insn);
419 } break;
420
421 case spv::OpLoad: {
422 def_index[insn.word(2)] = insn.offset();
423 } break;
424
425 default:
426 if (AtomicOperation(insn.opcode()) == true) {
427 // All atomics have a pointer referenced
428 spirv_inst_iter access;
429 if (insn.opcode() == spv::OpAtomicStore) {
430 access = mod.get_def(insn.word(1));
431 } else {
432 access = mod.get_def(insn.word(3));
433 def_index[insn.word(2)] = insn.offset();
434 }
435
436 atomic_instruction atomic;
437
438 auto pointer = mod.get_def(access.word(1));
439 // spirv-val should catch if not pointer
440 assert(pointer.opcode() == spv::OpTypePointer);
441 atomic.storage_class = pointer.word(2);
442
443 auto data_type = mod.get_def(pointer.word(3));
444 atomic.type = data_type.opcode();
445
446 // TODO - Should have a proper GetBitWidth like spirv-val does
447 assert(data_type.opcode() == spv::OpTypeFloat || data_type.opcode() == spv::OpTypeInt);
448 atomic.bit_width = data_type.word(2);
449
450 atomic_inst[insn.offset()] = atomic;
451 }
452 // We don't care about any other defs for now.
453 break;
454 }
455 }
456
457 entry_points = SHADER_MODULE_STATE::ProcessEntryPoints(mod);
458 multiple_entry_points = entry_points.size() > 1;
459}
460
461// static
462std::unordered_multimap<std::string, SHADER_MODULE_STATE::EntryPoint> SHADER_MODULE_STATE::ProcessEntryPoints(
463 const SHADER_MODULE_STATE &mod) {
464 std::unordered_multimap<std::string, SHADER_MODULE_STATE::EntryPoint> entry_points;
465 function_set func_set = {};
466 EntryPoint *entry_point = nullptr;
467
468 for (auto insn : mod) {
469 // offset is not 0, it means it's updated and the offset is in a Function.
470 if (func_set.offset) {
471 func_set.op_lists.emplace(insn.opcode(), insn.offset());
472 } else if (entry_point) {
473 entry_point->decorate_list.emplace(insn.opcode(), insn.offset());
474 }
475
476 switch (insn.opcode()) {
477 // Functions
478 case spv::OpFunction:
479 func_set.id = insn.word(2);
480 func_set.offset = insn.offset();
481 func_set.op_lists.clear();
482 break;
483
484 // Entry points ... add to the entrypoint table
485 case spv::OpEntryPoint: {
sfricke-samsung962cad92021-04-13 00:46:29 -0700486 // Entry points do not have an id (the id is the function id) and thus need their own table
487 auto entrypoint_name = reinterpret_cast<char const *>(&insn.word(3));
488 auto execution_model = insn.word(1);
489 auto entrypoint_stage = ExecutionModelToShaderStageFlagBits(execution_model);
490 entry_points.emplace(entrypoint_name,
491 EntryPoint{insn.offset(), static_cast<VkShaderStageFlagBits>(entrypoint_stage)});
492
493 auto range = entry_points.equal_range(entrypoint_name);
494 for (auto it = range.first; it != range.second; ++it) {
495 if (it->second.offset == insn.offset()) {
496 entry_point = &(it->second);
497 break;
498 }
499 }
500 assert(entry_point != nullptr);
501 break;
502 }
503 case spv::OpFunctionEnd: {
504 assert(entry_point != nullptr);
505 func_set.length = insn.offset() - func_set.offset;
506 entry_point->function_set_list.emplace_back(func_set);
507 break;
508 }
sfricke-samsung962cad92021-04-13 00:46:29 -0700509 }
510 }
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600511
512 SHADER_MODULE_STATE::SetPushConstantUsedInShader(mod, entry_points);
513 return entry_points;
sfricke-samsung962cad92021-04-13 00:46:29 -0700514}
515
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600516void SHADER_MODULE_STATE::PreprocessShaderBinary(const spv_target_env env) {
517 if (static_data_.has_group_decoration) {
sfricke-samsung962cad92021-04-13 00:46:29 -0700518 spvtools::Optimizer optimizer(env);
519 optimizer.RegisterPass(spvtools::CreateFlattenDecorationPass());
520 std::vector<uint32_t> optimized_binary;
521 // Run optimizer to flatten decorations only, set skip_validation so as to not re-run validator
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600522 auto result = optimizer.Run(words.data(), words.size(), &optimized_binary, spvtools::ValidatorOptions(), true);
523
sfricke-samsung962cad92021-04-13 00:46:29 -0700524 if (result) {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600525 // NOTE: We need to update words with the result from the spirv-tools optimizer.
526 // **THIS ONLY HAPPENS ON INITIALIZATION**. words should remain const for the lifetime
527 // of the SHADER_MODULE_STATE instance.
528 *const_cast<std::vector<uint32_t> *>(&words) = std::move(optimized_binary);
sfricke-samsung962cad92021-04-13 00:46:29 -0700529 }
530 }
sfricke-samsung962cad92021-04-13 00:46:29 -0700531}
532
sfricke-samsung58b84352021-07-31 21:41:04 -0700533char const *StorageClassName(unsigned sc) {
sfricke-samsung962cad92021-04-13 00:46:29 -0700534 switch (sc) {
535 case spv::StorageClassInput:
536 return "input";
537 case spv::StorageClassOutput:
538 return "output";
539 case spv::StorageClassUniformConstant:
540 return "const uniform";
541 case spv::StorageClassUniform:
542 return "uniform";
543 case spv::StorageClassWorkgroup:
544 return "workgroup local";
545 case spv::StorageClassCrossWorkgroup:
546 return "workgroup global";
547 case spv::StorageClassPrivate:
548 return "private global";
549 case spv::StorageClassFunction:
550 return "function";
551 case spv::StorageClassGeneric:
552 return "generic";
553 case spv::StorageClassAtomicCounter:
554 return "atomic counter";
555 case spv::StorageClassImage:
556 return "image";
557 case spv::StorageClassPushConstant:
558 return "push constant";
559 case spv::StorageClassStorageBuffer:
560 return "storage buffer";
561 default:
562 return "unknown";
563 }
564}
565
566void SHADER_MODULE_STATE::DescribeTypeInner(std::ostringstream &ss, unsigned type) const {
567 auto insn = get_def(type);
568 assert(insn != end());
569
570 switch (insn.opcode()) {
571 case spv::OpTypeBool:
572 ss << "bool";
573 break;
574 case spv::OpTypeInt:
575 ss << (insn.word(3) ? 's' : 'u') << "int" << insn.word(2);
576 break;
577 case spv::OpTypeFloat:
578 ss << "float" << insn.word(2);
579 break;
580 case spv::OpTypeVector:
581 ss << "vec" << insn.word(3) << " of ";
582 DescribeTypeInner(ss, insn.word(2));
583 break;
584 case spv::OpTypeMatrix:
585 ss << "mat" << insn.word(3) << " of ";
586 DescribeTypeInner(ss, insn.word(2));
587 break;
588 case spv::OpTypeArray:
589 ss << "arr[" << GetConstantValueById(insn.word(3)) << "] of ";
590 DescribeTypeInner(ss, insn.word(2));
591 break;
592 case spv::OpTypeRuntimeArray:
593 ss << "runtime arr[] of ";
594 DescribeTypeInner(ss, insn.word(2));
595 break;
596 case spv::OpTypePointer:
597 ss << "ptr to " << StorageClassName(insn.word(2)) << " ";
598 DescribeTypeInner(ss, insn.word(3));
599 break;
600 case spv::OpTypeStruct: {
601 ss << "struct of (";
602 for (unsigned i = 2; i < insn.len(); i++) {
603 DescribeTypeInner(ss, insn.word(i));
604 if (i == insn.len() - 1) {
605 ss << ")";
606 } else {
607 ss << ", ";
608 }
609 }
610 break;
611 }
612 case spv::OpTypeSampler:
613 ss << "sampler";
614 break;
615 case spv::OpTypeSampledImage:
616 ss << "sampler+";
617 DescribeTypeInner(ss, insn.word(2));
618 break;
619 case spv::OpTypeImage:
620 ss << "image(dim=" << insn.word(3) << ", sampled=" << insn.word(7) << ")";
621 break;
622 case spv::OpTypeAccelerationStructureNV:
623 ss << "accelerationStruture";
624 break;
625 default:
626 ss << "oddtype";
627 break;
628 }
629}
630
631std::string SHADER_MODULE_STATE::DescribeType(unsigned type) const {
632 std::ostringstream ss;
633 DescribeTypeInner(ss, type);
634 return ss.str();
635}
636
637const SHADER_MODULE_STATE::EntryPoint *SHADER_MODULE_STATE::FindEntrypointStruct(char const *name,
638 VkShaderStageFlagBits stageBits) const {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600639 auto range = static_data_.entry_points.equal_range(name);
sfricke-samsung962cad92021-04-13 00:46:29 -0700640 for (auto it = range.first; it != range.second; ++it) {
641 if (it->second.stage == stageBits) {
642 return &(it->second);
643 }
644 }
645 return nullptr;
646}
647
648spirv_inst_iter SHADER_MODULE_STATE::FindEntrypoint(char const *name, VkShaderStageFlagBits stageBits) const {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600649 auto range = static_data_.entry_points.equal_range(name);
sfricke-samsung962cad92021-04-13 00:46:29 -0700650 for (auto it = range.first; it != range.second; ++it) {
651 if (it->second.stage == stageBits) {
652 return at(it->second.offset);
653 }
654 }
655 return end();
656}
657
658// Because the following is legal, need the entry point
659// OpEntryPoint GLCompute %main "name_a"
660// OpEntryPoint GLCompute %main "name_b"
661bool SHADER_MODULE_STATE::FindLocalSize(const spirv_inst_iter &entrypoint, uint32_t &local_size_x, uint32_t &local_size_y,
662 uint32_t &local_size_z) const {
663 auto entrypoint_id = entrypoint.word(2);
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -0600664 auto it = static_data_.execution_mode_inst.find(entrypoint_id);
665 if (it != static_data_.execution_mode_inst.end()) {
sfricke-samsung962cad92021-04-13 00:46:29 -0700666 for (auto insn : it->second) {
667 // Future Note: For now, Vulkan doesn't have a valid mode that can makes use of OpExecutionModeId
668 // In the future if something like LocalSizeId is supported, the <id> will need to be checked also
669 assert(insn.opcode() == spv::OpExecutionMode);
670 if (insn.word(2) == spv::ExecutionModeLocalSize) {
671 local_size_x = insn.word(3);
672 local_size_y = insn.word(4);
673 local_size_z = insn.word(5);
674 return true;
675 }
676 }
677 }
678 return false;
679}
680
681// If the instruction at id is a constant or copy of a constant, returns a valid iterator pointing to that instruction.
682// Otherwise, returns src->end().
683spirv_inst_iter SHADER_MODULE_STATE::GetConstantDef(unsigned id) const {
684 auto value = get_def(id);
685
686 // If id is a copy, see where it was copied from
687 if ((end() != value) && ((value.opcode() == spv::OpCopyObject) || (value.opcode() == spv::OpCopyLogical))) {
688 id = value.word(3);
689 value = get_def(id);
690 }
691
692 if ((end() != value) && (value.opcode() == spv::OpConstant)) {
693 return value;
694 }
695 return end();
696}
697
698// Either returns the constant value described by the instruction at id, or 1
699uint32_t SHADER_MODULE_STATE::GetConstantValueById(unsigned id) const {
700 auto value = GetConstantDef(id);
701
702 if (end() == value) {
703 // TODO: Either ensure that the specialization transform is already performed on a module we're
704 // considering here, OR -- specialize on the fly now.
705 return 1;
706 }
707 return GetConstantValue(value);
708}
709
710// Returns an int32_t corresponding to the spv::Dim of the given resource, when positive, and corresponding to an unknown type, when
711// negative.
712int32_t SHADER_MODULE_STATE::GetShaderResourceDimensionality(const interface_var &resource) const {
713 auto type = get_def(resource.type_id);
714 while (true) {
715 switch (type.opcode()) {
716 case spv::OpTypeSampledImage:
717 type = get_def(type.word(2));
718 break;
719 case spv::OpTypePointer:
720 type = get_def(type.word(3));
721 break;
722 case spv::OpTypeImage:
723 return type.word(3);
724 default:
725 return -1;
726 }
727 }
728}
729
730unsigned SHADER_MODULE_STATE::GetLocationsConsumedByType(unsigned type, bool strip_array_level) const {
731 auto insn = get_def(type);
732 assert(insn != end());
733
734 switch (insn.opcode()) {
735 case spv::OpTypePointer:
736 // See through the ptr -- this is only ever at the toplevel for graphics shaders we're never actually passing
737 // pointers around.
738 return GetLocationsConsumedByType(insn.word(3), strip_array_level);
739 case spv::OpTypeArray:
740 if (strip_array_level) {
741 return GetLocationsConsumedByType(insn.word(2), false);
742 } else {
743 return GetConstantValueById(insn.word(3)) * GetLocationsConsumedByType(insn.word(2), false);
744 }
745 case spv::OpTypeMatrix:
746 // Num locations is the dimension * element size
747 return insn.word(3) * GetLocationsConsumedByType(insn.word(2), false);
748 case spv::OpTypeVector: {
749 auto scalar_type = get_def(insn.word(2));
750 auto bit_width =
751 (scalar_type.opcode() == spv::OpTypeInt || scalar_type.opcode() == spv::OpTypeFloat) ? scalar_type.word(2) : 32;
752
753 // Locations are 128-bit wide; 3- and 4-component vectors of 64 bit types require two.
754 return (bit_width * insn.word(3) + 127) / 128;
755 }
756 default:
757 // Everything else is just 1.
758 return 1;
759
760 // TODO: extend to handle 64bit scalar types, whose vectors may need multiple locations.
761 }
762}
763
764unsigned SHADER_MODULE_STATE::GetComponentsConsumedByType(unsigned type, bool strip_array_level) const {
765 auto insn = get_def(type);
766 assert(insn != end());
767
768 switch (insn.opcode()) {
769 case spv::OpTypePointer:
770 // See through the ptr -- this is only ever at the toplevel for graphics shaders we're never actually passing
771 // pointers around.
772 return GetComponentsConsumedByType(insn.word(3), strip_array_level);
773 case spv::OpTypeStruct: {
774 uint32_t sum = 0;
775 for (uint32_t i = 2; i < insn.len(); i++) { // i=2 to skip word(0) and word(1)=ID of struct
776 sum += GetComponentsConsumedByType(insn.word(i), false);
777 }
778 return sum;
779 }
780 case spv::OpTypeArray:
781 if (strip_array_level) {
782 return GetComponentsConsumedByType(insn.word(2), false);
783 } else {
784 return GetConstantValueById(insn.word(3)) * GetComponentsConsumedByType(insn.word(2), false);
785 }
786 case spv::OpTypeMatrix:
787 // Num locations is the dimension * element size
788 return insn.word(3) * GetComponentsConsumedByType(insn.word(2), false);
789 case spv::OpTypeVector: {
790 auto scalar_type = get_def(insn.word(2));
791 auto bit_width =
792 (scalar_type.opcode() == spv::OpTypeInt || scalar_type.opcode() == spv::OpTypeFloat) ? scalar_type.word(2) : 32;
793 // One component is 32-bit
794 return (bit_width * insn.word(3) + 31) / 32;
795 }
796 case spv::OpTypeFloat: {
797 auto bit_width = insn.word(2);
798 return (bit_width + 31) / 32;
799 }
800 case spv::OpTypeInt: {
801 auto bit_width = insn.word(2);
802 return (bit_width + 31) / 32;
803 }
804 case spv::OpConstant:
805 return GetComponentsConsumedByType(insn.word(1), false);
806 default:
807 return 0;
808 }
809}
810
811// characterizes a SPIR-V type appearing in an interface to a FF stage, for comparison to a VkFormat's characterization above.
812// also used for input attachments, as we statically know their format.
813unsigned SHADER_MODULE_STATE::GetFundamentalType(unsigned type) const {
814 auto insn = get_def(type);
815 assert(insn != end());
816
817 switch (insn.opcode()) {
818 case spv::OpTypeInt:
819 return insn.word(3) ? FORMAT_TYPE_SINT : FORMAT_TYPE_UINT;
820 case spv::OpTypeFloat:
821 return FORMAT_TYPE_FLOAT;
822 case spv::OpTypeVector:
823 case spv::OpTypeMatrix:
824 case spv::OpTypeArray:
825 case spv::OpTypeRuntimeArray:
826 case spv::OpTypeImage:
827 return GetFundamentalType(insn.word(2));
828 case spv::OpTypePointer:
829 return GetFundamentalType(insn.word(3));
830
831 default:
832 return 0;
833 }
834}
835
836spirv_inst_iter SHADER_MODULE_STATE::GetStructType(spirv_inst_iter def, bool is_array_of_verts) const {
837 while (true) {
838 if (def.opcode() == spv::OpTypePointer) {
839 def = get_def(def.word(3));
840 } else if (def.opcode() == spv::OpTypeArray && is_array_of_verts) {
841 def = get_def(def.word(2));
842 is_array_of_verts = false;
843 } else if (def.opcode() == spv::OpTypeStruct) {
844 return def;
845 } else {
846 return end();
847 }
848 }
849}
850
851void SHADER_MODULE_STATE::DefineStructMember(const spirv_inst_iter &it, const std::vector<uint32_t> &memberDecorate_offsets,
852 shader_struct_member &data) const {
853 const auto struct_it = GetStructType(it, false);
854 assert(struct_it != end());
855 data.size = 0;
856
857 shader_struct_member data1;
858 uint32_t i = 2;
859 uint32_t local_offset = 0;
860 std::vector<uint32_t> offsets;
861 offsets.resize(struct_it.len() - i);
862
863 // The members of struct in SPRIV_R aren't always sort, so we need to know their order.
864 for (const auto offset : memberDecorate_offsets) {
865 const auto member_decorate = at(offset);
866 if (member_decorate.word(1) != struct_it.word(1)) {
867 continue;
868 }
869
870 offsets[member_decorate.word(2)] = member_decorate.word(4);
871 }
872
873 for (const auto offset : offsets) {
874 local_offset = offset;
875 data1 = {};
876 data1.root = data.root;
877 data1.offset = local_offset;
878 auto def_member = get_def(struct_it.word(i));
879
880 // Array could be multi-dimensional
881 while (def_member.opcode() == spv::OpTypeArray) {
882 const auto len_id = def_member.word(3);
883 const auto def_len = get_def(len_id);
884 data1.array_length_hierarchy.emplace_back(def_len.word(3)); // array length
885 def_member = get_def(def_member.word(2));
886 }
887
888 if (def_member.opcode() == spv::OpTypeStruct) {
889 DefineStructMember(def_member, memberDecorate_offsets, data1);
890 } else if (def_member.opcode() == spv::OpTypePointer) {
891 if (def_member.word(2) == spv::StorageClassPhysicalStorageBuffer) {
892 // If it's a pointer with PhysicalStorageBuffer class, this member is essentially a uint64_t containing an address
893 // that "points to something."
894 data1.size = 8;
895 } else {
896 // If it's OpTypePointer. it means the member is a buffer, the type will be TypePointer, and then struct
897 DefineStructMember(def_member, memberDecorate_offsets, data1);
898 }
899 } else {
900 if (def_member.opcode() == spv::OpTypeMatrix) {
901 data1.array_length_hierarchy.emplace_back(def_member.word(3)); // matrix's columns. matrix's row is vector.
902 def_member = get_def(def_member.word(2));
903 }
904
905 if (def_member.opcode() == spv::OpTypeVector) {
906 data1.array_length_hierarchy.emplace_back(def_member.word(3)); // vector length
907 def_member = get_def(def_member.word(2));
908 }
909
910 // Get scalar type size. The value in SPRV-R is bit. It needs to translate to byte.
911 data1.size = (def_member.word(2) / 8);
912 }
913 const auto array_length_hierarchy_szie = data1.array_length_hierarchy.size();
914 if (array_length_hierarchy_szie > 0) {
915 data1.array_block_size.resize(array_length_hierarchy_szie, 1);
916
917 for (int i2 = static_cast<int>(array_length_hierarchy_szie - 1); i2 > 0; --i2) {
918 data1.array_block_size[i2 - 1] = data1.array_length_hierarchy[i2] * data1.array_block_size[i2];
919 }
920 }
921 data.struct_members.emplace_back(data1);
922 ++i;
923 }
924 uint32_t total_array_length = 1;
925 for (const auto length : data1.array_length_hierarchy) {
926 total_array_length *= length;
927 }
928 data.size = local_offset + data1.size * total_array_length;
929}
930
931static uint32_t UpdateOffset(uint32_t offset, const std::vector<uint32_t> &array_indices, const shader_struct_member &data) {
932 int array_indices_size = static_cast<int>(array_indices.size());
933 if (array_indices_size) {
934 uint32_t array_index = 0;
935 uint32_t i = 0;
936 for (const auto index : array_indices) {
937 array_index += (data.array_block_size[i] * index);
938 ++i;
939 }
940 offset += (array_index * data.size);
941 }
942 return offset;
943}
944
945static void SetUsedBytes(uint32_t offset, const std::vector<uint32_t> &array_indices, const shader_struct_member &data) {
946 int array_indices_size = static_cast<int>(array_indices.size());
947 uint32_t block_memory_size = data.size;
948 for (uint32_t i = static_cast<int>(array_indices_size); i < data.array_length_hierarchy.size(); ++i) {
949 block_memory_size *= data.array_length_hierarchy[i];
950 }
951
952 offset = UpdateOffset(offset, array_indices, data);
953
954 uint32_t end = offset + block_memory_size;
955 auto used_bytes = data.GetUsedbytes();
956 if (used_bytes->size() < end) {
957 used_bytes->resize(end, 0);
958 }
959 std::memset(used_bytes->data() + offset, true, static_cast<std::size_t>(block_memory_size));
960}
961
962void SHADER_MODULE_STATE::RunUsedArray(uint32_t offset, std::vector<uint32_t> array_indices, uint32_t access_chain_word_index,
963 spirv_inst_iter &access_chain_it, const shader_struct_member &data) const {
964 if (access_chain_word_index < access_chain_it.len()) {
965 if (data.array_length_hierarchy.size() > array_indices.size()) {
966 auto def_it = get_def(access_chain_it.word(access_chain_word_index));
967 ++access_chain_word_index;
968
969 if (def_it != end() && def_it.opcode() == spv::OpConstant) {
970 array_indices.emplace_back(def_it.word(3));
971 RunUsedArray(offset, array_indices, access_chain_word_index, access_chain_it, data);
972 } else {
973 // If it is a variable, set the all array is used.
974 if (access_chain_word_index < access_chain_it.len()) {
975 uint32_t array_length = data.array_length_hierarchy[array_indices.size()];
976 for (uint32_t i = 0; i < array_length; ++i) {
977 auto array_indices2 = array_indices;
978 array_indices2.emplace_back(i);
979 RunUsedArray(offset, array_indices2, access_chain_word_index, access_chain_it, data);
980 }
981 } else {
982 SetUsedBytes(offset, array_indices, data);
983 }
984 }
985 } else {
986 offset = UpdateOffset(offset, array_indices, data);
987 RunUsedStruct(offset, access_chain_word_index, access_chain_it, data);
988 }
989 } else {
990 SetUsedBytes(offset, array_indices, data);
991 }
992}
993
994void SHADER_MODULE_STATE::RunUsedStruct(uint32_t offset, uint32_t access_chain_word_index, spirv_inst_iter &access_chain_it,
995 const shader_struct_member &data) const {
996 std::vector<uint32_t> array_indices_emptry;
997
998 if (access_chain_word_index < access_chain_it.len()) {
999 auto strcut_member_index = GetConstantValueById(access_chain_it.word(access_chain_word_index));
1000 ++access_chain_word_index;
1001
1002 auto data1 = data.struct_members[strcut_member_index];
1003 RunUsedArray(offset + data1.offset, array_indices_emptry, access_chain_word_index, access_chain_it, data1);
1004 }
1005}
1006
1007void SHADER_MODULE_STATE::SetUsedStructMember(const uint32_t variable_id, const std::vector<function_set> &function_set_list,
1008 const shader_struct_member &data) const {
1009 for (const auto &func_set : function_set_list) {
1010 auto range = func_set.op_lists.equal_range(spv::OpAccessChain);
1011 for (auto it = range.first; it != range.second; ++it) {
1012 auto access_chain = at(it->second);
1013 if (access_chain.word(3) == variable_id) {
1014 RunUsedStruct(0, 4, access_chain, data);
1015 }
1016 }
1017 }
1018}
1019
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001020// static
1021void SHADER_MODULE_STATE::SetPushConstantUsedInShader(
1022 const SHADER_MODULE_STATE &mod, std::unordered_multimap<std::string, SHADER_MODULE_STATE::EntryPoint> &entry_points) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001023 for (auto &entrypoint : entry_points) {
1024 auto range = entrypoint.second.decorate_list.equal_range(spv::OpVariable);
1025 for (auto it = range.first; it != range.second; ++it) {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001026 const auto def_insn = mod.at(it->second);
sfricke-samsung962cad92021-04-13 00:46:29 -07001027
1028 if (def_insn.word(3) == spv::StorageClassPushConstant) {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001029 spirv_inst_iter type = mod.get_def(def_insn.word(1));
sfricke-samsung962cad92021-04-13 00:46:29 -07001030 const auto range2 = entrypoint.second.decorate_list.equal_range(spv::OpMemberDecorate);
1031 std::vector<uint32_t> offsets;
1032
1033 for (auto it2 = range2.first; it2 != range2.second; ++it2) {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001034 auto member_decorate = mod.at(it2->second);
sfricke-samsung962cad92021-04-13 00:46:29 -07001035 if (member_decorate.len() == 5 && member_decorate.word(3) == spv::DecorationOffset) {
1036 offsets.emplace_back(member_decorate.offset());
1037 }
1038 }
1039 entrypoint.second.push_constant_used_in_shader.root = &entrypoint.second.push_constant_used_in_shader;
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001040 mod.DefineStructMember(type, offsets, entrypoint.second.push_constant_used_in_shader);
1041 mod.SetUsedStructMember(def_insn.word(2), entrypoint.second.function_set_list,
1042 entrypoint.second.push_constant_used_in_shader);
sfricke-samsung962cad92021-04-13 00:46:29 -07001043 }
1044 }
1045 }
1046}
1047
1048uint32_t SHADER_MODULE_STATE::DescriptorTypeToReqs(uint32_t type_id) const {
1049 auto type = get_def(type_id);
1050
1051 while (true) {
1052 switch (type.opcode()) {
1053 case spv::OpTypeArray:
1054 case spv::OpTypeRuntimeArray:
1055 case spv::OpTypeSampledImage:
1056 type = get_def(type.word(2));
1057 break;
1058 case spv::OpTypePointer:
1059 type = get_def(type.word(3));
1060 break;
1061 case spv::OpTypeImage: {
1062 auto dim = type.word(3);
1063 auto arrayed = type.word(5);
1064 auto msaa = type.word(6);
1065
1066 uint32_t bits = 0;
1067 switch (GetFundamentalType(type.word(2))) {
1068 case FORMAT_TYPE_FLOAT:
1069 bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
1070 break;
1071 case FORMAT_TYPE_UINT:
1072 bits = DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
1073 break;
1074 case FORMAT_TYPE_SINT:
1075 bits = DESCRIPTOR_REQ_COMPONENT_TYPE_SINT;
1076 break;
1077 default:
1078 break;
1079 }
1080
1081 switch (dim) {
1082 case spv::Dim1D:
1083 bits |= arrayed ? DESCRIPTOR_REQ_VIEW_TYPE_1D_ARRAY : DESCRIPTOR_REQ_VIEW_TYPE_1D;
1084 return bits;
1085 case spv::Dim2D:
1086 bits |= msaa ? DESCRIPTOR_REQ_MULTI_SAMPLE : DESCRIPTOR_REQ_SINGLE_SAMPLE;
1087 bits |= arrayed ? DESCRIPTOR_REQ_VIEW_TYPE_2D_ARRAY : DESCRIPTOR_REQ_VIEW_TYPE_2D;
1088 return bits;
1089 case spv::Dim3D:
1090 bits |= DESCRIPTOR_REQ_VIEW_TYPE_3D;
1091 return bits;
1092 case spv::DimCube:
1093 bits |= arrayed ? DESCRIPTOR_REQ_VIEW_TYPE_CUBE_ARRAY : DESCRIPTOR_REQ_VIEW_TYPE_CUBE;
1094 return bits;
1095 case spv::DimSubpassData:
1096 bits |= msaa ? DESCRIPTOR_REQ_MULTI_SAMPLE : DESCRIPTOR_REQ_SINGLE_SAMPLE;
1097 return bits;
1098 default: // buffer, etc.
1099 return bits;
1100 }
1101 }
1102 default:
1103 return 0;
1104 }
1105 }
1106}
1107
1108// For some built-in analysis we need to know if the variable decorated with as the built-in was actually written to.
1109// This function examines instructions in the static call tree for a write to this variable.
1110bool SHADER_MODULE_STATE::IsBuiltInWritten(spirv_inst_iter builtin_instr, spirv_inst_iter entrypoint) const {
1111 auto type = builtin_instr.opcode();
1112 uint32_t target_id = builtin_instr.word(1);
1113 bool init_complete = false;
Nathaniel Cesario80c0e0f2021-10-14 13:25:54 -06001114 uint32_t target_member_offset = 0;
sfricke-samsung962cad92021-04-13 00:46:29 -07001115
1116 if (type == spv::OpMemberDecorate) {
1117 // Built-in is part of a structure -- examine instructions up to first function body to get initial IDs
1118 auto insn = entrypoint;
1119 while (!init_complete && (insn.opcode() != spv::OpFunction)) {
1120 switch (insn.opcode()) {
1121 case spv::OpTypePointer:
Nathaniel Cesario58fc2282021-08-18 12:20:40 -06001122 if (insn.word(2) == spv::StorageClassOutput) {
1123 const auto type_id = insn.word(3);
1124 if (type_id == target_id) {
1125 target_id = insn.word(1);
1126 } else {
1127 // If the output is an array, check if the element type is what we're looking for
1128 const auto type_insn = get_def(type_id);
1129 if ((type_insn.opcode() == spv::OpTypeArray) && (type_insn.word(2) == target_id)) {
1130 target_id = insn.word(1);
Nathaniel Cesario80c0e0f2021-10-14 13:25:54 -06001131 target_member_offset = 1;
Nathaniel Cesario58fc2282021-08-18 12:20:40 -06001132 }
1133 }
sfricke-samsung962cad92021-04-13 00:46:29 -07001134 }
1135 break;
1136 case spv::OpVariable:
1137 if (insn.word(1) == target_id) {
1138 target_id = insn.word(2);
1139 init_complete = true;
1140 }
1141 break;
1142 }
1143 insn++;
1144 }
1145 }
1146
1147 if (!init_complete && (type == spv::OpMemberDecorate)) return false;
1148
1149 bool found_write = false;
1150 layer_data::unordered_set<uint32_t> worklist;
1151 worklist.insert(entrypoint.word(2));
1152
1153 // Follow instructions in call graph looking for writes to target
1154 while (!worklist.empty() && !found_write) {
1155 auto id_iter = worklist.begin();
1156 auto id = *id_iter;
1157 worklist.erase(id_iter);
1158
1159 auto insn = get_def(id);
1160 if (insn == end()) {
1161 continue;
1162 }
1163
1164 if (insn.opcode() == spv::OpFunction) {
1165 // Scan body of function looking for other function calls or items in our ID chain
Nathaniel Cesario58fc2282021-08-18 12:20:40 -06001166 while (++insn, (insn.opcode() != spv::OpFunctionEnd) && !found_write) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001167 switch (insn.opcode()) {
1168 case spv::OpAccessChain:
1169 if (insn.word(3) == target_id) {
1170 if (type == spv::OpMemberDecorate) {
Nathaniel Cesario80c0e0f2021-10-14 13:25:54 -06001171 // Get the target member of the struct
1172 // NOTE: this will only work for structs and arrays of structs. Deeper levels of nesting (e.g.,
1173 // arrays of structs of structs) is not currently supported.
1174 const auto value_itr = GetConstantDef(insn.word(4 + target_member_offset));
1175 if (value_itr != end()) {
1176 auto value = GetConstantValue(value_itr);
1177 if (value == builtin_instr.word(2)) {
1178 target_id = insn.word(2);
1179 }
sfricke-samsung962cad92021-04-13 00:46:29 -07001180 }
1181 } else {
1182 target_id = insn.word(2);
1183 }
1184 }
1185 break;
1186 case spv::OpStore:
1187 if (insn.word(1) == target_id) {
1188 found_write = true;
1189 }
1190 break;
1191 case spv::OpFunctionCall:
1192 worklist.insert(insn.word(3));
1193 break;
1194 }
1195 }
1196 }
1197 }
1198 return found_write;
1199}
1200
1201// Used by the collection functions to help aid in state tracking
1202struct shader_module_used_operators {
1203 bool updated;
Lionel Landwerlinbc7401b2021-12-07 15:43:05 +02001204 std::vector<unsigned> imagread_members;
sfricke-samsung962cad92021-04-13 00:46:29 -07001205 std::vector<unsigned> imagwrite_members;
1206 std::vector<unsigned> atomic_members;
1207 std::vector<unsigned> store_members;
1208 std::vector<unsigned> atomic_store_members;
1209 std::vector<unsigned> sampler_implicitLod_dref_proj_members; // sampler Load id
1210 std::vector<unsigned> sampler_bias_offset_members; // sampler Load id
Lionel Landwerlincdbe8682021-12-08 15:10:37 +02001211 std::vector<unsigned> image_dref_members;
sfricke-samsung962cad92021-04-13 00:46:29 -07001212 std::vector<std::pair<unsigned, unsigned>> sampledImage_members; // <image,sampler> Load id
1213 layer_data::unordered_map<unsigned, unsigned> load_members;
1214 layer_data::unordered_map<unsigned, std::pair<unsigned, unsigned>> accesschain_members;
1215 layer_data::unordered_map<unsigned, unsigned> image_texel_pointer_members;
1216
1217 shader_module_used_operators() : updated(false) {}
1218
1219 bool CheckImageOperandsBiasOffset(uint32_t type) {
1220 return type & (spv::ImageOperandsBiasMask | spv::ImageOperandsConstOffsetMask | spv::ImageOperandsOffsetMask |
1221 spv::ImageOperandsConstOffsetsMask)
1222 ? true
1223 : false;
1224 }
1225
1226 void update(SHADER_MODULE_STATE const *module) {
1227 if (updated) return;
1228 updated = true;
1229
1230 for (auto insn : *module) {
1231 switch (insn.opcode()) {
1232 case spv::OpImageSampleImplicitLod:
1233 case spv::OpImageSampleProjImplicitLod:
1234 case spv::OpImageSampleProjExplicitLod:
1235 case spv::OpImageSparseSampleImplicitLod:
1236 case spv::OpImageSparseSampleProjImplicitLod:
1237 case spv::OpImageSparseSampleProjExplicitLod: {
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001238 // combined image samples are just OpLoad, but also can be separate image and sampler
1239 auto id = module->get_def(insn.word(3)); // <id> Sampled Image
1240 auto load_id = (id.opcode() == spv::OpSampledImage) ? id.word(4) : insn.word(3);
1241 sampler_implicitLod_dref_proj_members.emplace_back(load_id);
sfricke-samsung962cad92021-04-13 00:46:29 -07001242 // ImageOperands in index: 5
1243 if (insn.len() > 5 && CheckImageOperandsBiasOffset(insn.word(5))) {
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001244 sampler_bias_offset_members.emplace_back(load_id);
sfricke-samsung962cad92021-04-13 00:46:29 -07001245 }
1246 break;
1247 }
Lionel Landwerlincdbe8682021-12-08 15:10:37 +02001248 case spv::OpImageDrefGather:
1249 case spv::OpImageSparseDrefGather: {
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001250 // combined image samples are just OpLoad, but also can be separate image and sampler
1251 auto id = module->get_def(insn.word(3)); // <id> Sampled Image
1252 auto load_id = (id.opcode() == spv::OpSampledImage) ? id.word(3) : insn.word(3);
1253 image_dref_members.emplace_back(load_id);
Lionel Landwerlincdbe8682021-12-08 15:10:37 +02001254 break;
1255 }
sfricke-samsung962cad92021-04-13 00:46:29 -07001256 case spv::OpImageSampleDrefImplicitLod:
1257 case spv::OpImageSampleDrefExplicitLod:
1258 case spv::OpImageSampleProjDrefImplicitLod:
1259 case spv::OpImageSampleProjDrefExplicitLod:
1260 case spv::OpImageSparseSampleDrefImplicitLod:
1261 case spv::OpImageSparseSampleDrefExplicitLod:
1262 case spv::OpImageSparseSampleProjDrefImplicitLod:
1263 case spv::OpImageSparseSampleProjDrefExplicitLod: {
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001264 // combined image samples are just OpLoad, but also can be separate image and sampler
1265 auto id = module->get_def(insn.word(3)); // <id> Sampled Image
1266 auto sampler_load_id = (id.opcode() == spv::OpSampledImage) ? id.word(4) : insn.word(3);
1267 auto image_load_id = (id.opcode() == spv::OpSampledImage) ? id.word(3) : insn.word(3);
1268
1269 image_dref_members.emplace_back(image_load_id);
1270 sampler_implicitLod_dref_proj_members.emplace_back(sampler_load_id);
sfricke-samsung962cad92021-04-13 00:46:29 -07001271 // ImageOperands in index: 6
1272 if (insn.len() > 6 && CheckImageOperandsBiasOffset(insn.word(6))) {
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001273 sampler_bias_offset_members.emplace_back(sampler_load_id);
sfricke-samsung962cad92021-04-13 00:46:29 -07001274 }
1275 break;
1276 }
1277 case spv::OpImageSampleExplicitLod:
1278 case spv::OpImageSparseSampleExplicitLod: {
1279 // ImageOperands in index: 5
1280 if (insn.len() > 5 && CheckImageOperandsBiasOffset(insn.word(5))) {
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001281 // combined image samples are just OpLoad, but also can be separate image and sampler
1282 auto id = module->get_def(insn.word(3)); // <id> Sampled Image
1283 auto load_id = (id.opcode() == spv::OpSampledImage) ? id.word(4) : insn.word(3);
1284 sampler_bias_offset_members.emplace_back(load_id);
sfricke-samsung962cad92021-04-13 00:46:29 -07001285 }
1286 break;
1287 }
1288 case spv::OpStore: {
1289 store_members.emplace_back(insn.word(1)); // object id or AccessChain id
1290 break;
1291 }
Lionel Landwerlinbc7401b2021-12-07 15:43:05 +02001292 case spv::OpImageRead:
1293 case spv::OpImageSparseRead: {
1294 imagread_members.emplace_back(insn.word(3)); // Load id
1295 break;
1296 }
sfricke-samsung962cad92021-04-13 00:46:29 -07001297 case spv::OpImageWrite: {
1298 imagwrite_members.emplace_back(insn.word(1)); // Load id
1299 break;
1300 }
1301 case spv::OpSampledImage: {
1302 // 3: image load id, 4: sampler load id
1303 sampledImage_members.emplace_back(std::pair<unsigned, unsigned>(insn.word(3), insn.word(4)));
1304 break;
1305 }
1306 case spv::OpLoad: {
1307 // 2: Load id, 3: object id or AccessChain id
1308 load_members.emplace(insn.word(2), insn.word(3));
1309 break;
1310 }
1311 case spv::OpAccessChain: {
1312 if (insn.len() == 4) {
1313 // If it is for struct, the length is only 4.
1314 // 2: AccessChain id, 3: object id
1315 accesschain_members.emplace(insn.word(2), std::pair<unsigned, unsigned>(insn.word(3), 0));
1316 } else {
1317 // 2: AccessChain id, 3: object id, 4: object id of array index
1318 accesschain_members.emplace(insn.word(2), std::pair<unsigned, unsigned>(insn.word(3), insn.word(4)));
1319 }
1320 break;
1321 }
1322 case spv::OpImageTexelPointer: {
1323 // 2: ImageTexelPointer id, 3: object id
1324 image_texel_pointer_members.emplace(insn.word(2), insn.word(3));
1325 break;
1326 }
1327 default: {
1328 if (AtomicOperation(insn.opcode())) {
1329 if (insn.opcode() == spv::OpAtomicStore) {
1330 atomic_store_members.emplace_back(insn.word(1)); // ImageTexelPointer id
1331 } else {
1332 atomic_members.emplace_back(insn.word(3)); // ImageTexelPointer id
1333 }
1334 }
1335 break;
1336 }
1337 }
1338 }
1339 }
1340};
1341
1342static bool CheckObjectIDFromOpLoad(uint32_t object_id, const std::vector<unsigned> &operator_members,
1343 const layer_data::unordered_map<unsigned, unsigned> &load_members,
1344 const layer_data::unordered_map<unsigned, std::pair<unsigned, unsigned>> &accesschain_members) {
1345 for (auto load_id : operator_members) {
1346 if (object_id == load_id) return true;
1347 auto load_it = load_members.find(load_id);
1348 if (load_it == load_members.end()) {
1349 continue;
1350 }
1351 if (load_it->second == object_id) {
1352 return true;
1353 }
1354
1355 auto accesschain_it = accesschain_members.find(load_it->second);
1356 if (accesschain_it == accesschain_members.end()) {
1357 continue;
1358 }
1359 if (accesschain_it->second.first == object_id) {
1360 return true;
1361 }
1362 }
1363 return false;
1364}
1365
1366// Takes a OpVariable and looks at the the descriptor type it uses. This will find things such as if the variable is writable, image
1367// atomic operation, matching images to samplers, etc
1368void SHADER_MODULE_STATE::IsSpecificDescriptorType(const spirv_inst_iter &id_it, bool is_storage_buffer, bool is_check_writable,
1369 interface_var &out_interface_var,
1370 shader_module_used_operators &used_operators) const {
1371 uint32_t type_id = id_it.word(1);
1372 unsigned int id = id_it.word(2);
1373
1374 auto type = get_def(type_id);
1375
1376 // Strip off any array or ptrs. Where we remove array levels, adjust the descriptor count for each dimension.
1377 while (type.opcode() == spv::OpTypeArray || type.opcode() == spv::OpTypePointer || type.opcode() == spv::OpTypeRuntimeArray ||
1378 type.opcode() == spv::OpTypeSampledImage) {
1379 if (type.opcode() == spv::OpTypeArray || type.opcode() == spv::OpTypeRuntimeArray ||
1380 type.opcode() == spv::OpTypeSampledImage) {
1381 type = get_def(type.word(2)); // Element type
1382 } else {
1383 type = get_def(type.word(3)); // Pointer type
1384 }
1385 }
Lionel Landwerlinbc7401b2021-12-07 15:43:05 +02001386
sfricke-samsung962cad92021-04-13 00:46:29 -07001387 switch (type.opcode()) {
1388 case spv::OpTypeImage: {
1389 auto dim = type.word(3);
1390 if (dim != spv::DimSubpassData) {
1391 used_operators.update(this);
1392
Lionel Landwerlinbc7401b2021-12-07 15:43:05 +02001393 // Sampled == 2 indicates used without a sampler (a storage image)
1394 bool is_image_without_format = false;
1395 if (type.word(7) == 2) is_image_without_format = type.word(8) == spv::ImageFormatUnknown;
1396
sfricke-samsung962cad92021-04-13 00:46:29 -07001397 if (CheckObjectIDFromOpLoad(id, used_operators.imagwrite_members, used_operators.load_members,
1398 used_operators.accesschain_members)) {
1399 out_interface_var.is_writable = true;
Lionel Landwerlinbc7401b2021-12-07 15:43:05 +02001400 if (is_image_without_format) out_interface_var.is_write_without_format = true;
1401 }
1402 if (CheckObjectIDFromOpLoad(id, used_operators.imagread_members, used_operators.load_members,
1403 used_operators.accesschain_members)) {
1404 out_interface_var.is_readable = true;
1405 if (is_image_without_format) out_interface_var.is_read_without_format = true;
sfricke-samsung962cad92021-04-13 00:46:29 -07001406 }
1407 if (CheckObjectIDFromOpLoad(id, used_operators.sampler_implicitLod_dref_proj_members, used_operators.load_members,
1408 used_operators.accesschain_members)) {
1409 out_interface_var.is_sampler_implicitLod_dref_proj = true;
1410 }
1411 if (CheckObjectIDFromOpLoad(id, used_operators.sampler_bias_offset_members, used_operators.load_members,
1412 used_operators.accesschain_members)) {
1413 out_interface_var.is_sampler_bias_offset = true;
1414 }
1415 if (CheckObjectIDFromOpLoad(id, used_operators.atomic_members, used_operators.image_texel_pointer_members,
1416 used_operators.accesschain_members) ||
1417 CheckObjectIDFromOpLoad(id, used_operators.atomic_store_members, used_operators.image_texel_pointer_members,
1418 used_operators.accesschain_members)) {
1419 out_interface_var.is_atomic_operation = true;
1420 }
Lionel Landwerlincdbe8682021-12-08 15:10:37 +02001421 if (CheckObjectIDFromOpLoad(id, used_operators.image_dref_members, used_operators.load_members,
1422 used_operators.accesschain_members)) {
1423 out_interface_var.is_dref_operation = true;
1424 }
sfricke-samsung962cad92021-04-13 00:46:29 -07001425
1426 for (auto &itp_id : used_operators.sampledImage_members) {
1427 // Find if image id match.
1428 uint32_t image_index = 0;
1429 auto load_it = used_operators.load_members.find(itp_id.first);
1430 if (load_it == used_operators.load_members.end()) {
1431 continue;
1432 } else {
1433 if (load_it->second != id) {
1434 auto accesschain_it = used_operators.accesschain_members.find(load_it->second);
1435 if (accesschain_it == used_operators.accesschain_members.end()) {
1436 continue;
1437 } else {
1438 if (accesschain_it->second.first != id) {
1439 continue;
1440 }
1441
1442 const auto const_itr = GetConstantDef(accesschain_it->second.second);
1443 if (const_itr == end()) {
1444 // access chain index not a constant, skip.
1445 break;
1446 }
1447 image_index = GetConstantValue(const_itr);
1448 }
1449 }
1450 }
1451 // Find sampler's set binding.
1452 load_it = used_operators.load_members.find(itp_id.second);
1453 if (load_it == used_operators.load_members.end()) {
1454 continue;
1455 } else {
1456 uint32_t sampler_id = load_it->second;
1457 uint32_t sampler_index = 0;
1458 auto accesschain_it = used_operators.accesschain_members.find(load_it->second);
1459
1460 if (accesschain_it != used_operators.accesschain_members.end()) {
1461 const auto const_itr = GetConstantDef(accesschain_it->second.second);
1462 if (const_itr == end()) {
1463 // access chain index representing sampler index is not a constant, skip.
1464 break;
1465 }
1466 sampler_id = const_itr.offset();
1467 sampler_index = GetConstantValue(const_itr);
1468 }
1469 auto sampler_dec = get_decorations(sampler_id);
1470 if (image_index >= out_interface_var.samplers_used_by_image.size()) {
1471 out_interface_var.samplers_used_by_image.resize(image_index + 1);
1472 }
sfricke-samsungdb3f3f82022-01-18 06:41:15 -08001473
1474 // Need to check again for these properties in case not using a combined image sampler
1475 if (CheckObjectIDFromOpLoad(sampler_id, used_operators.sampler_implicitLod_dref_proj_members,
1476 used_operators.load_members, used_operators.accesschain_members)) {
1477 out_interface_var.is_sampler_implicitLod_dref_proj = true;
1478 }
1479 if (CheckObjectIDFromOpLoad(sampler_id, used_operators.sampler_bias_offset_members,
1480 used_operators.load_members, used_operators.accesschain_members)) {
1481 out_interface_var.is_sampler_bias_offset = true;
1482 }
1483
sfricke-samsung962cad92021-04-13 00:46:29 -07001484 out_interface_var.samplers_used_by_image[image_index].emplace(
Jeremy Gebben7fc88a22021-08-25 13:30:45 -06001485 SamplerUsedByImage{DescriptorSlot{sampler_dec.descriptor_set, sampler_dec.binding}, sampler_index});
sfricke-samsung962cad92021-04-13 00:46:29 -07001486 }
1487 }
1488 }
1489 return;
1490 }
1491
1492 case spv::OpTypeStruct: {
1493 layer_data::unordered_set<unsigned> nonwritable_members;
1494 if (get_decorations(type.word(1)).flags & decoration_set::buffer_block_bit) is_storage_buffer = true;
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001495 for (auto insn : static_data_.member_decoration_inst) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001496 if (insn.word(1) == type.word(1) && insn.word(3) == spv::DecorationNonWritable) {
1497 nonwritable_members.insert(insn.word(2));
1498 }
1499 }
1500
1501 // A buffer is writable if it's either flavor of storage buffer, and has any member not decorated
1502 // as nonwritable.
1503 if (is_storage_buffer && nonwritable_members.size() != type.len() - 2) {
1504 used_operators.update(this);
1505
1506 for (auto oid : used_operators.store_members) {
1507 if (id == oid) {
1508 out_interface_var.is_writable = true;
1509 return;
1510 }
1511 auto accesschain_it = used_operators.accesschain_members.find(oid);
1512 if (accesschain_it == used_operators.accesschain_members.end()) {
1513 continue;
1514 }
1515 if (accesschain_it->second.first == id) {
1516 out_interface_var.is_writable = true;
1517 return;
1518 }
1519 }
1520 if (CheckObjectIDFromOpLoad(id, used_operators.atomic_store_members, used_operators.image_texel_pointer_members,
1521 used_operators.accesschain_members)) {
1522 out_interface_var.is_writable = true;
1523 return;
1524 }
1525 }
1526 }
1527 }
1528}
1529
Jeremy Gebben7fc88a22021-08-25 13:30:45 -06001530std::vector<std::pair<DescriptorSlot, interface_var>> SHADER_MODULE_STATE::CollectInterfaceByDescriptorSlot(
Jeremy Gebben84b838b2021-08-23 08:41:39 -06001531 layer_data::unordered_set<uint32_t> const &accessible_ids) const {
Jeremy Gebben7fc88a22021-08-25 13:30:45 -06001532 std::vector<std::pair<DescriptorSlot, interface_var>> out;
sfricke-samsung962cad92021-04-13 00:46:29 -07001533 shader_module_used_operators operators;
1534
1535 for (auto id : accessible_ids) {
1536 auto insn = get_def(id);
1537 assert(insn != end());
1538
1539 if (insn.opcode() == spv::OpVariable &&
Lionel Landwerlin6a9f89c2021-12-07 15:46:46 +02001540 (insn.word(3) == spv::StorageClassUniform ||
1541 insn.word(3) == spv::StorageClassUniformConstant ||
sfricke-samsung962cad92021-04-13 00:46:29 -07001542 insn.word(3) == spv::StorageClassStorageBuffer)) {
1543 auto d = get_decorations(insn.word(2));
1544 unsigned set = d.descriptor_set;
1545 unsigned binding = d.binding;
1546
1547 interface_var v = {};
1548 v.id = insn.word(2);
1549 v.type_id = insn.word(1);
1550
1551 IsSpecificDescriptorType(insn, insn.word(3) == spv::StorageClassStorageBuffer,
1552 !(d.flags & decoration_set::nonwritable_bit), v, operators);
Jeremy Gebben84b838b2021-08-23 08:41:39 -06001553 out.emplace_back(DescriptorSlot{set, binding}, v);
sfricke-samsung962cad92021-04-13 00:46:29 -07001554 }
1555 }
1556
1557 return out;
1558}
1559
1560layer_data::unordered_set<uint32_t> SHADER_MODULE_STATE::CollectWritableOutputLocationinFS(
Jeremy Gebben84b838b2021-08-23 08:41:39 -06001561 const spirv_inst_iter &entrypoint) const {
sfricke-samsung962cad92021-04-13 00:46:29 -07001562 layer_data::unordered_set<uint32_t> location_list;
sfricke-samsung962cad92021-04-13 00:46:29 -07001563 const auto outputs = CollectInterfaceByLocation(entrypoint, spv::StorageClassOutput, false);
1564 layer_data::unordered_set<unsigned> store_members;
1565 layer_data::unordered_map<unsigned, unsigned> accesschain_members;
1566
1567 for (auto insn : *this) {
1568 switch (insn.opcode()) {
1569 case spv::OpStore:
1570 case spv::OpAtomicStore: {
1571 store_members.insert(insn.word(1)); // object id or AccessChain id
1572 break;
1573 }
1574 case spv::OpAccessChain: {
1575 // 2: AccessChain id, 3: object id
1576 if (insn.word(3)) accesschain_members.emplace(insn.word(2), insn.word(3));
1577 break;
1578 }
1579 default:
1580 break;
1581 }
1582 }
1583 if (store_members.empty()) {
1584 return location_list;
1585 }
1586 for (auto output : outputs) {
1587 auto store_it = store_members.find(output.second.id);
1588 if (store_it != store_members.end()) {
1589 location_list.insert(output.first.first);
1590 store_members.erase(store_it);
1591 continue;
1592 }
1593 store_it = store_members.begin();
1594 while (store_it != store_members.end()) {
1595 auto accesschain_it = accesschain_members.find(*store_it);
1596 if (accesschain_it == accesschain_members.end()) {
1597 ++store_it;
1598 continue;
1599 }
1600 if (accesschain_it->second == output.second.id) {
1601 location_list.insert(output.first.first);
1602 store_members.erase(store_it);
1603 accesschain_members.erase(accesschain_it);
1604 break;
1605 }
1606 ++store_it;
1607 }
1608 }
1609 return location_list;
1610}
1611
1612bool SHADER_MODULE_STATE::CollectInterfaceBlockMembers(std::map<location_t, interface_var> *out, bool is_array_of_verts,
ziga-lunarg9e94e112021-09-27 00:21:10 +02001613 uint32_t id, uint32_t type_id, bool is_patch,
1614 uint32_t /*first_location*/) const {
sfricke-samsung962cad92021-04-13 00:46:29 -07001615 // Walk down the type_id presented, trying to determine whether it's actually an interface block.
1616 auto type = GetStructType(get_def(type_id), is_array_of_verts && !is_patch);
1617 if (type == end() || !(get_decorations(type.word(1)).flags & decoration_set::block_bit)) {
1618 // This isn't an interface block.
1619 return false;
1620 }
1621
1622 layer_data::unordered_map<unsigned, unsigned> member_components;
1623 layer_data::unordered_map<unsigned, unsigned> member_relaxed_precision;
1624 layer_data::unordered_map<unsigned, unsigned> member_patch;
1625
1626 // Walk all the OpMemberDecorate for type's result id -- first pass, collect components.
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001627 for (auto insn : static_data_.member_decoration_inst) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001628 if (insn.word(1) == type.word(1)) {
1629 unsigned member_index = insn.word(2);
1630
1631 if (insn.word(3) == spv::DecorationComponent) {
1632 unsigned component = insn.word(4);
1633 member_components[member_index] = component;
1634 }
1635
1636 if (insn.word(3) == spv::DecorationRelaxedPrecision) {
1637 member_relaxed_precision[member_index] = 1;
1638 }
1639
1640 if (insn.word(3) == spv::DecorationPatch) {
1641 member_patch[member_index] = 1;
1642 }
1643 }
1644 }
1645
1646 // TODO: correctly handle location assignment from outside
1647
1648 // Second pass -- produce the output, from Location decorations
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001649 for (auto insn : static_data_.member_decoration_inst) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001650 if (insn.word(1) == type.word(1)) {
1651 unsigned member_index = insn.word(2);
1652 unsigned member_type_id = type.word(2 + member_index);
1653
1654 if (insn.word(3) == spv::DecorationLocation) {
1655 unsigned location = insn.word(4);
1656 unsigned num_locations = GetLocationsConsumedByType(member_type_id, false);
1657 auto component_it = member_components.find(member_index);
1658 unsigned component = component_it == member_components.end() ? 0 : component_it->second;
1659 bool is_relaxed_precision = member_relaxed_precision.find(member_index) != member_relaxed_precision.end();
1660 bool member_is_patch = is_patch || member_patch.count(member_index) > 0;
1661
1662 for (unsigned int offset = 0; offset < num_locations; offset++) {
1663 interface_var v = {};
1664 v.id = id;
1665 // TODO: member index in interface_var too?
1666 v.type_id = member_type_id;
1667 v.offset = offset;
1668 v.is_patch = member_is_patch;
1669 v.is_block_member = true;
1670 v.is_relaxed_precision = is_relaxed_precision;
1671 (*out)[std::make_pair(location + offset, component)] = v;
1672 }
1673 }
1674 }
1675 }
1676
1677 return true;
1678}
1679
1680std::map<location_t, interface_var> SHADER_MODULE_STATE::CollectInterfaceByLocation(spirv_inst_iter entrypoint,
1681 spv::StorageClass sinterface,
1682 bool is_array_of_verts) const {
1683 // TODO: handle index=1 dual source outputs from FS -- two vars will have the same location, and we DON'T want to clobber.
1684
1685 std::map<location_t, interface_var> out;
1686
1687 for (uint32_t iid : FindEntrypointInterfaces(entrypoint)) {
1688 auto insn = get_def(iid);
1689 assert(insn != end());
1690 assert(insn.opcode() == spv::OpVariable);
1691
ziga-lunarg9e94e112021-09-27 00:21:10 +02001692 const auto d = get_decorations(iid);
1693 bool passthrough = sinterface == spv::StorageClassOutput && insn.word(3) == spv::StorageClassInput &&
1694 (d.flags & decoration_set::passthrough_bit) != 0;
1695 if (insn.word(3) == static_cast<uint32_t>(sinterface) || passthrough) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001696 unsigned id = insn.word(2);
1697 unsigned type = insn.word(1);
1698
ziga-lunarg9e94e112021-09-27 00:21:10 +02001699 auto location = d.location;
sfricke-samsung962cad92021-04-13 00:46:29 -07001700 int builtin = d.builtin;
1701 unsigned component = d.component;
1702 bool is_patch = (d.flags & decoration_set::patch_bit) != 0;
1703 bool is_relaxed_precision = (d.flags & decoration_set::relaxed_precision_bit) != 0;
ziga-lunarg9e94e112021-09-27 00:21:10 +02001704 bool is_per_vertex = (d.flags & decoration_set::per_vertex_bit) != 0;
sfricke-samsung962cad92021-04-13 00:46:29 -07001705
1706 if (builtin != -1) {
1707 continue;
ziga-lunarg9e94e112021-09-27 00:21:10 +02001708 } else if (!CollectInterfaceBlockMembers(&out, is_array_of_verts, id, type, is_patch, location) ||
1709 location != decoration_set::kInvalidValue) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001710 // A user-defined interface variable, with a location. Where a variable occupied multiple locations, emit
1711 // one result for each.
ziga-lunarg9e94e112021-09-27 00:21:10 +02001712 unsigned num_locations = GetLocationsConsumedByType(type, (is_array_of_verts && !is_patch) || is_per_vertex);
sfricke-samsung962cad92021-04-13 00:46:29 -07001713 for (unsigned int offset = 0; offset < num_locations; offset++) {
1714 interface_var v = {};
1715 v.id = id;
1716 v.type_id = type;
1717 v.offset = offset;
1718 v.is_patch = is_patch;
1719 v.is_relaxed_precision = is_relaxed_precision;
1720 out[std::make_pair(location + offset, component)] = v;
1721 }
1722 }
1723 }
1724 }
1725
1726 return out;
1727}
1728
1729std::vector<uint32_t> SHADER_MODULE_STATE::CollectBuiltinBlockMembers(spirv_inst_iter entrypoint, uint32_t storageClass) const {
sfricke-samsung962cad92021-04-13 00:46:29 -07001730 // Find all interface variables belonging to the entrypoint and matching the storage class
sfricke-samsung0df5ee72021-07-24 23:27:16 -07001731 std::vector<uint32_t> variables;
sfricke-samsung962cad92021-04-13 00:46:29 -07001732 for (uint32_t id : FindEntrypointInterfaces(entrypoint)) {
1733 auto def = get_def(id);
1734 assert(def != end());
1735 assert(def.opcode() == spv::OpVariable);
1736
1737 if (def.word(3) == storageClass) variables.push_back(def.word(1));
1738 }
1739
1740 // Find all members belonging to the builtin block selected
1741 std::vector<uint32_t> builtin_block_members;
1742 for (auto &var : variables) {
1743 auto def = get_def(get_def(var).word(3));
1744
1745 // It could be an array of IO blocks. The element type should be the struct defining the block contents
1746 if (def.opcode() == spv::OpTypeArray) def = get_def(def.word(2));
1747
1748 // Now find all members belonging to the struct defining the IO block
1749 if (def.opcode() == spv::OpTypeStruct) {
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001750 for (auto set : static_data_.builtin_decoration_list) {
sfricke-samsung0df5ee72021-07-24 23:27:16 -07001751 auto insn = at(set.offset);
1752 if ((insn.opcode() == spv::OpMemberDecorate) && (def.word(1) == insn.word(1))) {
1753 // Start with undefined builtin for each struct member.
1754 // But only when confirmed the struct is the built-in inteface block (can only be one per shader)
1755 if (builtin_block_members.size() == 0) {
1756 builtin_block_members.resize(def.len() - 2, spv::BuiltInMax);
sfricke-samsung962cad92021-04-13 00:46:29 -07001757 }
sfricke-samsung0df5ee72021-07-24 23:27:16 -07001758 auto struct_index = insn.word(2);
1759 assert(struct_index < builtin_block_members.size());
1760 builtin_block_members[struct_index] = insn.word(4);
sfricke-samsung962cad92021-04-13 00:46:29 -07001761 }
1762 }
1763 }
1764 }
1765
1766 return builtin_block_members;
1767}
1768
1769std::vector<std::pair<uint32_t, interface_var>> SHADER_MODULE_STATE::CollectInterfaceByInputAttachmentIndex(
1770 layer_data::unordered_set<uint32_t> const &accessible_ids) const {
1771 std::vector<std::pair<uint32_t, interface_var>> out;
1772
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001773 for (auto insn : static_data_.decoration_inst) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001774 if (insn.word(2) == spv::DecorationInputAttachmentIndex) {
1775 auto attachment_index = insn.word(3);
1776 auto id = insn.word(1);
1777
1778 if (accessible_ids.count(id)) {
1779 auto def = get_def(id);
1780 assert(def != end());
1781 if (def.opcode() == spv::OpVariable && def.word(3) == spv::StorageClassUniformConstant) {
1782 auto num_locations = GetLocationsConsumedByType(def.word(1), false);
1783 for (unsigned int offset = 0; offset < num_locations; offset++) {
1784 interface_var v = {};
1785 v.id = id;
1786 v.type_id = def.word(1);
1787 v.offset = offset;
1788 out.emplace_back(attachment_index + offset, v);
1789 }
1790 }
1791 }
1792 }
1793 }
1794
1795 return out;
1796}
1797
Lionel Landwerlin5f2065a2021-07-23 11:51:28 +03001798spirv_inst_iter SHADER_MODULE_STATE::GetImageFormatInst(uint32_t id) const
Lionel Landwerlin892d6c32021-05-05 12:56:19 +03001799{
1800 do {
Lionel Landwerlin892d6c32021-05-05 12:56:19 +03001801 auto def = get_def(id);
Lionel Landwerlin5f2065a2021-07-23 11:51:28 +03001802 if (def == end())
1803 return def;
1804
Lionel Landwerlin892d6c32021-05-05 12:56:19 +03001805 switch (def.opcode()) {
1806 case spv::OpLoad:
Lionel Landwerlin892d6c32021-05-05 12:56:19 +03001807 case spv::OpAccessChain:
1808 case spv::OpCompositeConstruct:
1809 case spv::OpVariable: {
1810 id = def.word(1);
1811 break;
1812 }
1813
1814 case spv::OpTypeArray:
1815 case spv::OpTypeRuntimeArray:
1816 id = def.word(2);
1817 break;
1818
1819 case spv::OpTypePointer:
1820 id = def.word(3);
1821 break;
1822
1823 case spv::OpTypeImage:
1824 return def;
1825
1826 default:
1827 return end();
1828 }
1829 } while (true);
1830}
1831
ziga-lunarg8346fe82021-08-22 17:30:50 +02001832uint32_t SHADER_MODULE_STATE::GetNumComponentsInBaseType(const spirv_inst_iter &iter) const {
1833 const uint32_t opcode = iter.opcode();
1834 if (opcode == spv::OpTypeFloat || opcode == spv::OpTypeInt) {
1835 return 1;
1836 } else if (opcode == spv::OpTypeVector) {
1837 const uint32_t component_count = iter.word(3);
1838 return component_count;
1839 } else if (opcode == spv::OpTypeMatrix) {
1840 const auto column_type = get_def(iter.word(2));
1841 const uint32_t vector_length = GetNumComponentsInBaseType(column_type);
1842 const uint32_t column_count = iter.word(3);
1843 return vector_length * column_count;
1844 } else if (opcode == spv::OpTypeArray) {
1845 const auto element_type = get_def(iter.word(2));
1846 const uint32_t element_length = GetNumComponentsInBaseType(element_type);
1847 return element_length;
1848 } else if (opcode == spv::OpTypeStruct) {
1849 uint32_t total_size = 0;
1850 for (uint32_t i = 2; i < iter.len(); ++i) {
1851 total_size += GetNumComponentsInBaseType(get_def(iter.word(i)));
1852 }
1853 return total_size;
1854 } else if (opcode == spv::OpTypePointer) {
1855 const auto type = get_def(iter.word(3));
1856 return GetNumComponentsInBaseType(type);
1857 }
1858 return 0;
1859}
1860
ziga-lunarg2818f492021-08-12 14:30:51 +02001861std::array<uint32_t, 3> SHADER_MODULE_STATE::GetWorkgroupSize(
1862 VkPipelineShaderStageCreateInfo const *pStage, const std::unordered_map<uint32_t, std::vector<uint32_t>>& id_value_map) const {
1863 std::array<uint32_t, 3> work_group_size = {1, 1, 1};
1864
1865 uint32_t work_group_size_id = std::numeric_limits<uint32_t>::max();
1866
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001867 for (const auto &builtin : static_data_.builtin_decoration_list) {
ziga-lunarg2818f492021-08-12 14:30:51 +02001868 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1869 work_group_size_id = at(builtin.offset).word(1);
1870 break;
1871 }
1872 }
1873 for (auto insn : *this) {
1874 uint32_t opcode = insn.opcode();
1875 if (opcode == spv::OpSpecConstantComposite) { // WorkGroupSize must be a composite
1876 uint32_t result_id = insn.word(2);
1877 if (result_id == work_group_size_id) {
1878 uint32_t result_type_id = insn.word(1);
1879 auto result_type = get_def(result_type_id);
1880 if (result_type.opcode() == spv::OpTypeVector) {
1881 uint32_t component_count = result_type.word(3);
1882 for (uint32_t i = 0; i < component_count; ++i) {
1883 auto constituent = get_def(insn.word(3 + i));
Nathaniel Cesario77cd59b2021-10-11 23:52:24 -06001884 for (const auto &sc : static_data_.spec_const_map) {
ziga-lunarg2818f492021-08-12 14:30:51 +02001885 if (sc.second == constituent.word(2)) {
1886 const auto iter = id_value_map.find(sc.first);
1887 if (iter != id_value_map.cend()) {
1888 work_group_size[i] = *iter->second.begin();
1889 }
1890 break;
1891 }
1892 }
1893 }
1894 }
1895 }
1896 }
1897 }
1898
1899 return work_group_size;
1900}
1901
ziga-lunarga26b3602021-08-08 15:53:00 +02001902uint32_t SHADER_MODULE_STATE::GetTypeBitsSize(const spirv_inst_iter &iter) const {
1903 const uint32_t opcode = iter.opcode();
1904 if (opcode == spv::OpTypeFloat || opcode == spv::OpTypeInt) {
1905 return iter.word(2);
1906 } else if (opcode == spv::OpTypeVector) {
1907 const auto component_type = get_def(iter.word(2));
1908 uint32_t scalar_width = GetTypeBitsSize(component_type);
1909 uint32_t component_count = iter.word(3);
1910 return scalar_width * component_count;
1911 } else if (opcode == spv::OpTypeMatrix) {
1912 const auto column_type = get_def(iter.word(2));
1913 uint32_t vector_width = GetTypeBitsSize(column_type);
1914 uint32_t column_count = iter.word(3);
1915 return vector_width * column_count;
1916 } else if (opcode == spv::OpTypeArray) {
1917 const auto element_type = get_def(iter.word(2));
1918 uint32_t element_width = GetTypeBitsSize(element_type);
1919 const auto length_type = get_def(iter.word(3));
1920 uint32_t length = GetConstantValue(length_type);
1921 return element_width * length;
1922 } else if (opcode == spv::OpTypeStruct) {
1923 uint32_t total_size = 0;
1924 for (uint32_t i = 2; i < iter.len(); ++i) {
1925 total_size += GetTypeBitsSize(get_def(iter.word(i)));
1926 }
1927 return total_size;
ziga-lunarg8346fe82021-08-22 17:30:50 +02001928 } else if (opcode == spv::OpTypePointer) {
1929 const auto type = get_def(iter.word(3));
1930 return GetTypeBitsSize(type);
ziga-lunargef2c3172021-11-07 10:35:29 +01001931 } else if (opcode == spv::OpVariable) {
1932 const auto type = get_def(iter.word(1));
1933 return GetTypeBitsSize(type);
ziga-lunarga26b3602021-08-08 15:53:00 +02001934 }
1935 return 0;
1936}
1937
1938uint32_t SHADER_MODULE_STATE::GetTypeBytesSize(const spirv_inst_iter &iter) const { return GetTypeBitsSize(iter) / 8; }
1939
ziga-lunarg19fc6ae2021-09-09 00:05:19 +02001940// Returns the base type (float, int or unsigned int) or struct (can have multiple different base types inside)
ziga-lunarg8346fe82021-08-22 17:30:50 +02001941uint32_t SHADER_MODULE_STATE::GetBaseType(const spirv_inst_iter &iter) const {
1942 const uint32_t opcode = iter.opcode();
1943 if (opcode == spv::OpTypeFloat || opcode == spv::OpTypeInt || opcode == spv::OpTypeStruct) {
1944 return iter.word(1);
1945 } else if (opcode == spv::OpTypeVector) {
1946 const auto& component_type = get_def(iter.word(2));
1947 return GetBaseType(component_type);
1948 } else if (opcode == spv::OpTypeMatrix) {
1949 const auto& column_type = get_def(iter.word(2));
1950 return GetBaseType(column_type);
1951 } else if (opcode == spv::OpTypeArray) {
1952 const auto& element_type = get_def(iter.word(2));
1953 return GetBaseType(element_type);
1954 } else if (opcode == spv::OpTypePointer) {
1955 const auto& type = get_def(iter.word(3));
1956 return GetBaseType(type);
1957 }
1958 return 0;
1959}
1960
ziga-lunarga26b3602021-08-08 15:53:00 +02001961uint32_t SHADER_MODULE_STATE::CalcComputeSharedMemory(VkShaderStageFlagBits stage,
1962 const spirv_inst_iter &insn) const {
1963 if (stage == VK_SHADER_STAGE_COMPUTE_BIT && insn.opcode() == spv::OpVariable) {
1964 uint32_t storage_class = insn.word(3);
1965 if (storage_class == spv::StorageClassWorkgroup) { // StorageClass Workgroup is shared memory
1966 uint32_t result_type_id = insn.word(1);
1967 auto result_type = get_def(result_type_id);
1968 auto type = get_def(result_type.word(3));
1969 return GetTypeBytesSize(type);
1970 }
1971 }
1972
1973 return 0;
1974}
1975
sfricke-samsung962cad92021-04-13 00:46:29 -07001976// Assumes itr points to an OpConstant instruction
1977uint32_t GetConstantValue(const spirv_inst_iter &itr) { return itr.word(3); }
1978
1979std::vector<uint32_t> FindEntrypointInterfaces(const spirv_inst_iter &entrypoint) {
1980 assert(entrypoint.opcode() == spv::OpEntryPoint);
1981
1982 std::vector<uint32_t> interfaces;
1983 // Find the end of the entrypoint's name string. additional zero bytes follow the actual null terminator, to fill out the
1984 // rest of the word - so we only need to look at the last byte in the word to determine which word contains the terminator.
1985 uint32_t word = 3;
1986 while (entrypoint.word(word) & 0xff000000u) {
1987 ++word;
1988 }
1989 ++word;
1990
1991 for (; word < entrypoint.len(); word++) interfaces.push_back(entrypoint.word(word));
1992
1993 return interfaces;
1994}