blob: e4cff921a43ca0d36402455badd31835640f01cf [file] [log] [blame]
Tony-LunarG73719992020-01-15 10:20:28 -07001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
4 * Copyright (C) 2015-2020 Google Inc.
Chris Forbes47567b72017-06-09 12:09:45 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Chris Forbes <chrisf@ijw.co.nz>
Dave Houlton51653902018-06-22 17:32:13 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Chris Forbes47567b72017-06-09 12:09:45 -070020 */
21
Petr Kraus25810d02019-08-27 17:41:15 +020022#include "shader_validation.h"
23
Chris Forbes47567b72017-06-09 12:09:45 -070024#include <cassert>
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +020025#include <chrono>
Petr Kraus25810d02019-08-27 17:41:15 +020026#include <cinttypes>
Jeff Bolzf234bf82019-11-04 14:07:15 -060027#include <cmath>
Petr Kraus25810d02019-08-27 17:41:15 +020028#include <map>
Chris Forbes47567b72017-06-09 12:09:45 -070029#include <sstream>
Petr Kraus25810d02019-08-27 17:41:15 +020030#include <string>
31#include <unordered_map>
32#include <vector>
33
Chris Forbes47567b72017-06-09 12:09:45 -070034#include <SPIRV/spirv.hpp>
35#include "vk_loader_platform.h"
36#include "vk_enum_string_helper.h"
Chris Forbes47567b72017-06-09 12:09:45 -070037#include "vk_layer_data.h"
38#include "vk_layer_extension_utils.h"
39#include "vk_layer_utils.h"
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070040#include "chassis.h"
Chris Forbes47567b72017-06-09 12:09:45 -070041#include "core_validation.h"
Petr Kraus25810d02019-08-27 17:41:15 +020042
Chris Forbes4ae55b32017-06-09 14:42:56 -070043#include "spirv-tools/libspirv.h"
Chris Forbes9a61e082017-07-24 15:35:29 -070044#include "xxhash.h"
Chris Forbes47567b72017-06-09 12:09:45 -070045
Chris Forbes8a6d8cb2019-02-14 14:33:08 -080046void decoration_set::add(uint32_t decoration, uint32_t value) {
47 switch (decoration) {
48 case spv::DecorationLocation:
49 flags |= location_bit;
50 location = value;
51 break;
52 case spv::DecorationPatch:
53 flags |= patch_bit;
54 break;
55 case spv::DecorationRelaxedPrecision:
56 flags |= relaxed_precision_bit;
57 break;
58 case spv::DecorationBlock:
59 flags |= block_bit;
60 break;
61 case spv::DecorationBufferBlock:
62 flags |= buffer_block_bit;
63 break;
64 case spv::DecorationComponent:
65 flags |= component_bit;
66 component = value;
67 break;
68 case spv::DecorationInputAttachmentIndex:
69 flags |= input_attachment_index_bit;
70 input_attachment_index = value;
71 break;
72 case spv::DecorationDescriptorSet:
73 flags |= descriptor_set_bit;
74 descriptor_set = value;
75 break;
76 case spv::DecorationBinding:
77 flags |= binding_bit;
78 binding = value;
79 break;
80 case spv::DecorationNonWritable:
81 flags |= nonwritable_bit;
82 break;
83 case spv::DecorationBuiltIn:
84 flags |= builtin_bit;
85 builtin = value;
86 break;
87 }
88}
89
Chris Forbes47567b72017-06-09 12:09:45 -070090enum FORMAT_TYPE {
91 FORMAT_TYPE_FLOAT = 1, // UNORM, SNORM, FLOAT, USCALED, SSCALED, SRGB -- anything we consider float in the shader
92 FORMAT_TYPE_SINT = 2,
93 FORMAT_TYPE_UINT = 4,
94};
95
96typedef std::pair<unsigned, unsigned> location_t;
97
Chris Forbes47567b72017-06-09 12:09:45 -070098static shader_stage_attributes shader_stage_attribs[] = {
Ari Suonpaa696b3432019-03-11 14:02:57 +020099 {"vertex shader", false, false, VK_SHADER_STAGE_VERTEX_BIT},
100 {"tessellation control shader", true, true, VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT},
101 {"tessellation evaluation shader", true, false, VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT},
102 {"geometry shader", true, false, VK_SHADER_STAGE_GEOMETRY_BIT},
103 {"fragment shader", false, false, VK_SHADER_STAGE_FRAGMENT_BIT},
Chris Forbes47567b72017-06-09 12:09:45 -0700104};
105
John Zulauf14c355b2019-06-27 16:09:37 -0600106unsigned ExecutionModelToShaderStageFlagBits(unsigned mode);
107
Chris Forbes47567b72017-06-09 12:09:45 -0700108// SPIRV utility functions
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600109void SHADER_MODULE_STATE::BuildDefIndex() {
Chris Forbes47567b72017-06-09 12:09:45 -0700110 for (auto insn : *this) {
111 switch (insn.opcode()) {
112 // Types
113 case spv::OpTypeVoid:
114 case spv::OpTypeBool:
115 case spv::OpTypeInt:
116 case spv::OpTypeFloat:
117 case spv::OpTypeVector:
118 case spv::OpTypeMatrix:
119 case spv::OpTypeImage:
120 case spv::OpTypeSampler:
121 case spv::OpTypeSampledImage:
122 case spv::OpTypeArray:
123 case spv::OpTypeRuntimeArray:
124 case spv::OpTypeStruct:
125 case spv::OpTypeOpaque:
126 case spv::OpTypePointer:
127 case spv::OpTypeFunction:
128 case spv::OpTypeEvent:
129 case spv::OpTypeDeviceEvent:
130 case spv::OpTypeReserveId:
131 case spv::OpTypeQueue:
132 case spv::OpTypePipe:
Shannon McPherson0fa28232018-11-01 11:59:02 -0600133 case spv::OpTypeAccelerationStructureNV:
Jeff Bolze4356752019-03-07 11:23:46 -0600134 case spv::OpTypeCooperativeMatrixNV:
Chris Forbes47567b72017-06-09 12:09:45 -0700135 def_index[insn.word(1)] = insn.offset();
136 break;
137
138 // Fixed constants
139 case spv::OpConstantTrue:
140 case spv::OpConstantFalse:
141 case spv::OpConstant:
142 case spv::OpConstantComposite:
143 case spv::OpConstantSampler:
144 case spv::OpConstantNull:
145 def_index[insn.word(2)] = insn.offset();
146 break;
147
148 // Specialization constants
149 case spv::OpSpecConstantTrue:
150 case spv::OpSpecConstantFalse:
151 case spv::OpSpecConstant:
152 case spv::OpSpecConstantComposite:
153 case spv::OpSpecConstantOp:
154 def_index[insn.word(2)] = insn.offset();
155 break;
156
157 // Variables
158 case spv::OpVariable:
159 def_index[insn.word(2)] = insn.offset();
160 break;
161
162 // Functions
163 case spv::OpFunction:
164 def_index[insn.word(2)] = insn.offset();
165 break;
166
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800167 // Decorations
168 case spv::OpDecorate: {
169 auto targetId = insn.word(1);
170 decorations[targetId].add(insn.word(2), insn.len() > 3u ? insn.word(3) : 0u);
171 } break;
172 case spv::OpGroupDecorate: {
173 auto const &src = decorations[insn.word(1)];
174 for (auto i = 2u; i < insn.len(); i++) decorations[insn.word(i)].merge(src);
175 } break;
176
John Zulauf14c355b2019-06-27 16:09:37 -0600177 // Entry points ... add to the entrypoint table
178 case spv::OpEntryPoint: {
179 // Entry points do not have an id (the id is the function id) and thus need their own table
180 auto entrypoint_name = (char const *)&insn.word(3);
181 auto execution_model = insn.word(1);
182 auto entrypoint_stage = ExecutionModelToShaderStageFlagBits(execution_model);
183 entry_points.emplace(entrypoint_name, EntryPoint{insn.offset(), entrypoint_stage});
184 break;
185 }
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800186
Chris Forbes47567b72017-06-09 12:09:45 -0700187 default:
188 // We don't care about any other defs for now.
189 break;
190 }
191 }
192}
193
Jeff Bolz105d6492018-09-29 15:46:44 -0500194unsigned ExecutionModelToShaderStageFlagBits(unsigned mode) {
195 switch (mode) {
196 case spv::ExecutionModelVertex:
197 return VK_SHADER_STAGE_VERTEX_BIT;
198 case spv::ExecutionModelTessellationControl:
199 return VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT;
200 case spv::ExecutionModelTessellationEvaluation:
201 return VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT;
202 case spv::ExecutionModelGeometry:
203 return VK_SHADER_STAGE_GEOMETRY_BIT;
204 case spv::ExecutionModelFragment:
205 return VK_SHADER_STAGE_FRAGMENT_BIT;
206 case spv::ExecutionModelGLCompute:
207 return VK_SHADER_STAGE_COMPUTE_BIT;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600208 case spv::ExecutionModelRayGenerationNV:
Eric Werness30127fd2018-10-31 21:01:03 -0700209 return VK_SHADER_STAGE_RAYGEN_BIT_NV;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600210 case spv::ExecutionModelAnyHitNV:
Eric Werness30127fd2018-10-31 21:01:03 -0700211 return VK_SHADER_STAGE_ANY_HIT_BIT_NV;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600212 case spv::ExecutionModelClosestHitNV:
Eric Werness30127fd2018-10-31 21:01:03 -0700213 return VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600214 case spv::ExecutionModelMissNV:
Eric Werness30127fd2018-10-31 21:01:03 -0700215 return VK_SHADER_STAGE_MISS_BIT_NV;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600216 case spv::ExecutionModelIntersectionNV:
Eric Werness30127fd2018-10-31 21:01:03 -0700217 return VK_SHADER_STAGE_INTERSECTION_BIT_NV;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600218 case spv::ExecutionModelCallableNV:
Eric Werness30127fd2018-10-31 21:01:03 -0700219 return VK_SHADER_STAGE_CALLABLE_BIT_NV;
Jeff Bolz105d6492018-09-29 15:46:44 -0500220 case spv::ExecutionModelTaskNV:
221 return VK_SHADER_STAGE_TASK_BIT_NV;
222 case spv::ExecutionModelMeshNV:
223 return VK_SHADER_STAGE_MESH_BIT_NV;
224 default:
225 return 0;
226 }
227}
228
locke-lunargd9a069d2019-09-17 01:50:19 -0600229spirv_inst_iter FindEntrypoint(SHADER_MODULE_STATE const *src, char const *name, VkShaderStageFlagBits stageBits) {
John Zulauf14c355b2019-06-27 16:09:37 -0600230 auto range = src->entry_points.equal_range(name);
231 for (auto it = range.first; it != range.second; ++it) {
232 if (it->second.stage == stageBits) {
233 return src->at(it->second.offset);
Chris Forbes47567b72017-06-09 12:09:45 -0700234 }
235 }
Chris Forbes47567b72017-06-09 12:09:45 -0700236 return src->end();
237}
238
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600239static char const *StorageClassName(unsigned sc) {
Chris Forbes47567b72017-06-09 12:09:45 -0700240 switch (sc) {
241 case spv::StorageClassInput:
242 return "input";
243 case spv::StorageClassOutput:
244 return "output";
245 case spv::StorageClassUniformConstant:
246 return "const uniform";
247 case spv::StorageClassUniform:
248 return "uniform";
249 case spv::StorageClassWorkgroup:
250 return "workgroup local";
251 case spv::StorageClassCrossWorkgroup:
252 return "workgroup global";
253 case spv::StorageClassPrivate:
254 return "private global";
255 case spv::StorageClassFunction:
256 return "function";
257 case spv::StorageClassGeneric:
258 return "generic";
259 case spv::StorageClassAtomicCounter:
260 return "atomic counter";
261 case spv::StorageClassImage:
262 return "image";
263 case spv::StorageClassPushConstant:
264 return "push constant";
Chris Forbes9f89d752018-03-07 12:57:48 -0800265 case spv::StorageClassStorageBuffer:
266 return "storage buffer";
Chris Forbes47567b72017-06-09 12:09:45 -0700267 default:
268 return "unknown";
269 }
270}
271
272// Get the value of an integral constant
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600273unsigned GetConstantValue(SHADER_MODULE_STATE const *src, unsigned id) {
Chris Forbes47567b72017-06-09 12:09:45 -0700274 auto value = src->get_def(id);
275 assert(value != src->end());
276
277 if (value.opcode() != spv::OpConstant) {
278 // TODO: Either ensure that the specialization transform is already performed on a module we're
279 // considering here, OR -- specialize on the fly now.
280 return 1;
281 }
282
283 return value.word(3);
284}
285
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600286static void DescribeTypeInner(std::ostringstream &ss, SHADER_MODULE_STATE const *src, unsigned type) {
Chris Forbes47567b72017-06-09 12:09:45 -0700287 auto insn = src->get_def(type);
288 assert(insn != src->end());
289
290 switch (insn.opcode()) {
291 case spv::OpTypeBool:
292 ss << "bool";
293 break;
294 case spv::OpTypeInt:
295 ss << (insn.word(3) ? 's' : 'u') << "int" << insn.word(2);
296 break;
297 case spv::OpTypeFloat:
298 ss << "float" << insn.word(2);
299 break;
300 case spv::OpTypeVector:
301 ss << "vec" << insn.word(3) << " of ";
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600302 DescribeTypeInner(ss, src, insn.word(2));
Chris Forbes47567b72017-06-09 12:09:45 -0700303 break;
304 case spv::OpTypeMatrix:
305 ss << "mat" << insn.word(3) << " of ";
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600306 DescribeTypeInner(ss, src, insn.word(2));
Chris Forbes47567b72017-06-09 12:09:45 -0700307 break;
308 case spv::OpTypeArray:
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600309 ss << "arr[" << GetConstantValue(src, insn.word(3)) << "] of ";
310 DescribeTypeInner(ss, src, insn.word(2));
Chris Forbes47567b72017-06-09 12:09:45 -0700311 break;
Chris Forbes062f1222018-08-21 15:34:15 -0700312 case spv::OpTypeRuntimeArray:
313 ss << "runtime arr[] of ";
314 DescribeTypeInner(ss, src, insn.word(2));
315 break;
Chris Forbes47567b72017-06-09 12:09:45 -0700316 case spv::OpTypePointer:
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600317 ss << "ptr to " << StorageClassName(insn.word(2)) << " ";
318 DescribeTypeInner(ss, src, insn.word(3));
Chris Forbes47567b72017-06-09 12:09:45 -0700319 break;
320 case spv::OpTypeStruct: {
321 ss << "struct of (";
322 for (unsigned i = 2; i < insn.len(); i++) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600323 DescribeTypeInner(ss, src, insn.word(i));
Chris Forbes47567b72017-06-09 12:09:45 -0700324 if (i == insn.len() - 1) {
325 ss << ")";
326 } else {
327 ss << ", ";
328 }
329 }
330 break;
331 }
332 case spv::OpTypeSampler:
333 ss << "sampler";
334 break;
335 case spv::OpTypeSampledImage:
336 ss << "sampler+";
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600337 DescribeTypeInner(ss, src, insn.word(2));
Chris Forbes47567b72017-06-09 12:09:45 -0700338 break;
339 case spv::OpTypeImage:
340 ss << "image(dim=" << insn.word(3) << ", sampled=" << insn.word(7) << ")";
341 break;
Shannon McPherson0fa28232018-11-01 11:59:02 -0600342 case spv::OpTypeAccelerationStructureNV:
Jeff Bolz105d6492018-09-29 15:46:44 -0500343 ss << "accelerationStruture";
344 break;
Chris Forbes47567b72017-06-09 12:09:45 -0700345 default:
346 ss << "oddtype";
347 break;
348 }
349}
350
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600351static std::string DescribeType(SHADER_MODULE_STATE const *src, unsigned type) {
Chris Forbes47567b72017-06-09 12:09:45 -0700352 std::ostringstream ss;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600353 DescribeTypeInner(ss, src, type);
Chris Forbes47567b72017-06-09 12:09:45 -0700354 return ss.str();
355}
356
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600357static bool IsNarrowNumericType(spirv_inst_iter type) {
Chris Forbes47567b72017-06-09 12:09:45 -0700358 if (type.opcode() != spv::OpTypeInt && type.opcode() != spv::OpTypeFloat) return false;
359 return type.word(2) < 64;
360}
361
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600362static bool TypesMatch(SHADER_MODULE_STATE const *a, SHADER_MODULE_STATE const *b, unsigned a_type, unsigned b_type, bool a_arrayed,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600363 bool b_arrayed, bool relaxed) {
Chris Forbes47567b72017-06-09 12:09:45 -0700364 // Walk two type trees together, and complain about differences
365 auto a_insn = a->get_def(a_type);
366 auto b_insn = b->get_def(b_type);
367 assert(a_insn != a->end());
368 assert(b_insn != b->end());
369
Chris Forbes062f1222018-08-21 15:34:15 -0700370 // Ignore runtime-sized arrays-- they cannot appear in these interfaces.
371
Chris Forbes47567b72017-06-09 12:09:45 -0700372 if (a_arrayed && a_insn.opcode() == spv::OpTypeArray) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600373 return TypesMatch(a, b, a_insn.word(2), b_type, false, b_arrayed, relaxed);
Chris Forbes47567b72017-06-09 12:09:45 -0700374 }
375
376 if (b_arrayed && b_insn.opcode() == spv::OpTypeArray) {
377 // We probably just found the extra level of arrayness in b_type: compare the type inside it to a_type
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600378 return TypesMatch(a, b, a_type, b_insn.word(2), a_arrayed, false, relaxed);
Chris Forbes47567b72017-06-09 12:09:45 -0700379 }
380
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600381 if (a_insn.opcode() == spv::OpTypeVector && relaxed && IsNarrowNumericType(b_insn)) {
382 return TypesMatch(a, b, a_insn.word(2), b_type, a_arrayed, b_arrayed, false);
Chris Forbes47567b72017-06-09 12:09:45 -0700383 }
384
385 if (a_insn.opcode() != b_insn.opcode()) {
386 return false;
387 }
388
389 if (a_insn.opcode() == spv::OpTypePointer) {
390 // Match on pointee type. storage class is expected to differ
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600391 return TypesMatch(a, b, a_insn.word(3), b_insn.word(3), a_arrayed, b_arrayed, relaxed);
Chris Forbes47567b72017-06-09 12:09:45 -0700392 }
393
394 if (a_arrayed || b_arrayed) {
395 // If we havent resolved array-of-verts by here, we're not going to.
396 return false;
397 }
398
399 switch (a_insn.opcode()) {
400 case spv::OpTypeBool:
401 return true;
402 case spv::OpTypeInt:
403 // Match on width, signedness
404 return a_insn.word(2) == b_insn.word(2) && a_insn.word(3) == b_insn.word(3);
405 case spv::OpTypeFloat:
406 // Match on width
407 return a_insn.word(2) == b_insn.word(2);
408 case spv::OpTypeVector:
409 // Match on element type, count.
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600410 if (!TypesMatch(a, b, a_insn.word(2), b_insn.word(2), a_arrayed, b_arrayed, false)) return false;
411 if (relaxed && IsNarrowNumericType(a->get_def(a_insn.word(2)))) {
Chris Forbes47567b72017-06-09 12:09:45 -0700412 return a_insn.word(3) >= b_insn.word(3);
413 } else {
414 return a_insn.word(3) == b_insn.word(3);
415 }
416 case spv::OpTypeMatrix:
417 // Match on element type, count.
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600418 return TypesMatch(a, b, a_insn.word(2), b_insn.word(2), a_arrayed, b_arrayed, false) &&
Dave Houltona9df0ce2018-02-07 10:51:23 -0700419 a_insn.word(3) == b_insn.word(3);
Chris Forbes47567b72017-06-09 12:09:45 -0700420 case spv::OpTypeArray:
421 // Match on element type, count. these all have the same layout. we don't get here if b_arrayed. This differs from
422 // vector & matrix types in that the array size is the id of a constant instruction, * not a literal within OpTypeArray
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600423 return TypesMatch(a, b, a_insn.word(2), b_insn.word(2), a_arrayed, b_arrayed, false) &&
424 GetConstantValue(a, a_insn.word(3)) == GetConstantValue(b, b_insn.word(3));
Chris Forbes47567b72017-06-09 12:09:45 -0700425 case spv::OpTypeStruct:
426 // Match on all element types
Dave Houltona9df0ce2018-02-07 10:51:23 -0700427 {
428 if (a_insn.len() != b_insn.len()) {
429 return false; // Structs cannot match if member counts differ
Chris Forbes47567b72017-06-09 12:09:45 -0700430 }
Chris Forbes47567b72017-06-09 12:09:45 -0700431
Dave Houltona9df0ce2018-02-07 10:51:23 -0700432 for (unsigned i = 2; i < a_insn.len(); i++) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600433 if (!TypesMatch(a, b, a_insn.word(i), b_insn.word(i), a_arrayed, b_arrayed, false)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -0700434 return false;
435 }
436 }
437
438 return true;
439 }
Chris Forbes47567b72017-06-09 12:09:45 -0700440 default:
441 // Remaining types are CLisms, or may not appear in the interfaces we are interested in. Just claim no match.
442 return false;
443 }
444}
445
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600446static unsigned ValueOrDefault(std::unordered_map<unsigned, unsigned> const &map, unsigned id, unsigned def) {
Chris Forbes47567b72017-06-09 12:09:45 -0700447 auto it = map.find(id);
448 if (it == map.end())
449 return def;
450 else
451 return it->second;
452}
453
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600454static unsigned GetLocationsConsumedByType(SHADER_MODULE_STATE const *src, unsigned type, bool strip_array_level) {
Chris Forbes47567b72017-06-09 12:09:45 -0700455 auto insn = src->get_def(type);
456 assert(insn != src->end());
457
458 switch (insn.opcode()) {
459 case spv::OpTypePointer:
460 // See through the ptr -- this is only ever at the toplevel for graphics shaders we're never actually passing
461 // pointers around.
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600462 return GetLocationsConsumedByType(src, insn.word(3), strip_array_level);
Chris Forbes47567b72017-06-09 12:09:45 -0700463 case spv::OpTypeArray:
464 if (strip_array_level) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600465 return GetLocationsConsumedByType(src, insn.word(2), false);
Chris Forbes47567b72017-06-09 12:09:45 -0700466 } else {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600467 return GetConstantValue(src, insn.word(3)) * GetLocationsConsumedByType(src, insn.word(2), false);
Chris Forbes47567b72017-06-09 12:09:45 -0700468 }
469 case spv::OpTypeMatrix:
470 // Num locations is the dimension * element size
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600471 return insn.word(3) * GetLocationsConsumedByType(src, insn.word(2), false);
Chris Forbes47567b72017-06-09 12:09:45 -0700472 case spv::OpTypeVector: {
473 auto scalar_type = src->get_def(insn.word(2));
474 auto bit_width =
475 (scalar_type.opcode() == spv::OpTypeInt || scalar_type.opcode() == spv::OpTypeFloat) ? scalar_type.word(2) : 32;
476
477 // Locations are 128-bit wide; 3- and 4-component vectors of 64 bit types require two.
478 return (bit_width * insn.word(3) + 127) / 128;
479 }
480 default:
481 // Everything else is just 1.
482 return 1;
483
484 // TODO: extend to handle 64bit scalar types, whose vectors may need multiple locations.
485 }
486}
487
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600488static unsigned GetComponentsConsumedByType(SHADER_MODULE_STATE const *src, unsigned type, bool strip_array_level) {
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +0200489 auto insn = src->get_def(type);
490 assert(insn != src->end());
491
492 switch (insn.opcode()) {
493 case spv::OpTypePointer:
494 // See through the ptr -- this is only ever at the toplevel for graphics shaders we're never actually passing
495 // pointers around.
496 return GetComponentsConsumedByType(src, insn.word(3), strip_array_level);
497 case spv::OpTypeStruct: {
498 uint32_t sum = 0;
499 for (uint32_t i = 2; i < insn.len(); i++) { // i=2 to skip word(0) and word(1)=ID of struct
500 sum += GetComponentsConsumedByType(src, insn.word(i), false);
501 }
502 return sum;
503 }
Jeff Bolze9ee3d82019-05-29 13:45:13 -0500504 case spv::OpTypeArray:
505 if (strip_array_level) {
506 return GetComponentsConsumedByType(src, insn.word(2), false);
507 } else {
508 return GetConstantValue(src, insn.word(3)) * GetComponentsConsumedByType(src, insn.word(2), false);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +0200509 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +0200510 case spv::OpTypeMatrix:
511 // Num locations is the dimension * element size
512 return insn.word(3) * GetComponentsConsumedByType(src, insn.word(2), false);
513 case spv::OpTypeVector: {
514 auto scalar_type = src->get_def(insn.word(2));
515 auto bit_width =
516 (scalar_type.opcode() == spv::OpTypeInt || scalar_type.opcode() == spv::OpTypeFloat) ? scalar_type.word(2) : 32;
517 // One component is 32-bit
518 return (bit_width * insn.word(3) + 31) / 32;
519 }
520 case spv::OpTypeFloat: {
521 auto bit_width = insn.word(2);
522 return (bit_width + 31) / 32;
523 }
524 case spv::OpTypeInt: {
525 auto bit_width = insn.word(2);
526 return (bit_width + 31) / 32;
527 }
528 case spv::OpConstant:
529 return GetComponentsConsumedByType(src, insn.word(1), false);
530 default:
531 return 0;
532 }
533}
534
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600535static unsigned GetLocationsConsumedByFormat(VkFormat format) {
Chris Forbes47567b72017-06-09 12:09:45 -0700536 switch (format) {
537 case VK_FORMAT_R64G64B64A64_SFLOAT:
538 case VK_FORMAT_R64G64B64A64_SINT:
539 case VK_FORMAT_R64G64B64A64_UINT:
540 case VK_FORMAT_R64G64B64_SFLOAT:
541 case VK_FORMAT_R64G64B64_SINT:
542 case VK_FORMAT_R64G64B64_UINT:
543 return 2;
544 default:
545 return 1;
546 }
547}
548
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600549static unsigned GetFormatType(VkFormat fmt) {
Dave Houltona9df0ce2018-02-07 10:51:23 -0700550 if (FormatIsSInt(fmt)) return FORMAT_TYPE_SINT;
551 if (FormatIsUInt(fmt)) return FORMAT_TYPE_UINT;
552 if (FormatIsDepthAndStencil(fmt)) return FORMAT_TYPE_FLOAT | FORMAT_TYPE_UINT;
553 if (fmt == VK_FORMAT_UNDEFINED) return 0;
Chris Forbes47567b72017-06-09 12:09:45 -0700554 // everything else -- UNORM/SNORM/FLOAT/USCALED/SSCALED is all float in the shader.
555 return FORMAT_TYPE_FLOAT;
556}
557
558// characterizes a SPIR-V type appearing in an interface to a FF stage, for comparison to a VkFormat's characterization above.
Chris Forbes062f1222018-08-21 15:34:15 -0700559// also used for input attachments, as we statically know their format.
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600560static unsigned GetFundamentalType(SHADER_MODULE_STATE const *src, unsigned type) {
Chris Forbes47567b72017-06-09 12:09:45 -0700561 auto insn = src->get_def(type);
562 assert(insn != src->end());
563
564 switch (insn.opcode()) {
565 case spv::OpTypeInt:
566 return insn.word(3) ? FORMAT_TYPE_SINT : FORMAT_TYPE_UINT;
567 case spv::OpTypeFloat:
568 return FORMAT_TYPE_FLOAT;
569 case spv::OpTypeVector:
Chris Forbes47567b72017-06-09 12:09:45 -0700570 case spv::OpTypeMatrix:
Chris Forbes47567b72017-06-09 12:09:45 -0700571 case spv::OpTypeArray:
Chris Forbes062f1222018-08-21 15:34:15 -0700572 case spv::OpTypeRuntimeArray:
573 case spv::OpTypeImage:
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600574 return GetFundamentalType(src, insn.word(2));
Chris Forbes47567b72017-06-09 12:09:45 -0700575 case spv::OpTypePointer:
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600576 return GetFundamentalType(src, insn.word(3));
Chris Forbes47567b72017-06-09 12:09:45 -0700577
578 default:
579 return 0;
580 }
581}
582
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600583static uint32_t GetShaderStageId(VkShaderStageFlagBits stage) {
Chris Forbes47567b72017-06-09 12:09:45 -0700584 uint32_t bit_pos = uint32_t(u_ffs(stage));
585 return bit_pos - 1;
586}
587
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600588static spirv_inst_iter GetStructType(SHADER_MODULE_STATE const *src, spirv_inst_iter def, bool is_array_of_verts) {
Chris Forbes47567b72017-06-09 12:09:45 -0700589 while (true) {
590 if (def.opcode() == spv::OpTypePointer) {
591 def = src->get_def(def.word(3));
592 } else if (def.opcode() == spv::OpTypeArray && is_array_of_verts) {
593 def = src->get_def(def.word(2));
594 is_array_of_verts = false;
595 } else if (def.opcode() == spv::OpTypeStruct) {
596 return def;
597 } else {
598 return src->end();
599 }
600 }
601}
602
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600603static bool CollectInterfaceBlockMembers(SHADER_MODULE_STATE const *src, std::map<location_t, interface_var> *out,
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800604 bool is_array_of_verts, uint32_t id, uint32_t type_id, bool is_patch,
605 int /*first_location*/) {
Chris Forbes47567b72017-06-09 12:09:45 -0700606 // Walk down the type_id presented, trying to determine whether it's actually an interface block.
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600607 auto type = GetStructType(src, src->get_def(type_id), is_array_of_verts && !is_patch);
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800608 if (type == src->end() || !(src->get_decorations(type.word(1)).flags & decoration_set::block_bit)) {
Chris Forbes47567b72017-06-09 12:09:45 -0700609 // This isn't an interface block.
Chris Forbesa313d772017-06-13 13:59:41 -0700610 return false;
Chris Forbes47567b72017-06-09 12:09:45 -0700611 }
612
613 std::unordered_map<unsigned, unsigned> member_components;
614 std::unordered_map<unsigned, unsigned> member_relaxed_precision;
Chris Forbesa313d772017-06-13 13:59:41 -0700615 std::unordered_map<unsigned, unsigned> member_patch;
Chris Forbes47567b72017-06-09 12:09:45 -0700616
617 // Walk all the OpMemberDecorate for type's result id -- first pass, collect components.
618 for (auto insn : *src) {
619 if (insn.opcode() == spv::OpMemberDecorate && insn.word(1) == type.word(1)) {
620 unsigned member_index = insn.word(2);
621
622 if (insn.word(3) == spv::DecorationComponent) {
623 unsigned component = insn.word(4);
624 member_components[member_index] = component;
625 }
626
627 if (insn.word(3) == spv::DecorationRelaxedPrecision) {
628 member_relaxed_precision[member_index] = 1;
629 }
Chris Forbesa313d772017-06-13 13:59:41 -0700630
631 if (insn.word(3) == spv::DecorationPatch) {
632 member_patch[member_index] = 1;
633 }
Chris Forbes47567b72017-06-09 12:09:45 -0700634 }
635 }
636
Chris Forbesa313d772017-06-13 13:59:41 -0700637 // TODO: correctly handle location assignment from outside
638
Chris Forbes47567b72017-06-09 12:09:45 -0700639 // Second pass -- produce the output, from Location decorations
640 for (auto insn : *src) {
641 if (insn.opcode() == spv::OpMemberDecorate && insn.word(1) == type.word(1)) {
642 unsigned member_index = insn.word(2);
643 unsigned member_type_id = type.word(2 + member_index);
644
645 if (insn.word(3) == spv::DecorationLocation) {
646 unsigned location = insn.word(4);
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600647 unsigned num_locations = GetLocationsConsumedByType(src, member_type_id, false);
Chris Forbes47567b72017-06-09 12:09:45 -0700648 auto component_it = member_components.find(member_index);
649 unsigned component = component_it == member_components.end() ? 0 : component_it->second;
650 bool is_relaxed_precision = member_relaxed_precision.find(member_index) != member_relaxed_precision.end();
Dave Houltona9df0ce2018-02-07 10:51:23 -0700651 bool member_is_patch = is_patch || member_patch.count(member_index) > 0;
Chris Forbes47567b72017-06-09 12:09:45 -0700652
653 for (unsigned int offset = 0; offset < num_locations; offset++) {
654 interface_var v = {};
655 v.id = id;
656 // TODO: member index in interface_var too?
657 v.type_id = member_type_id;
658 v.offset = offset;
Chris Forbesa313d772017-06-13 13:59:41 -0700659 v.is_patch = member_is_patch;
Chris Forbes47567b72017-06-09 12:09:45 -0700660 v.is_block_member = true;
661 v.is_relaxed_precision = is_relaxed_precision;
662 (*out)[std::make_pair(location + offset, component)] = v;
663 }
664 }
665 }
666 }
Chris Forbesa313d772017-06-13 13:59:41 -0700667
668 return true;
Chris Forbes47567b72017-06-09 12:09:45 -0700669}
670
Ari Suonpaa696b3432019-03-11 14:02:57 +0200671static std::vector<uint32_t> FindEntrypointInterfaces(spirv_inst_iter entrypoint) {
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800672 assert(entrypoint.opcode() == spv::OpEntryPoint);
673
Ari Suonpaa696b3432019-03-11 14:02:57 +0200674 std::vector<uint32_t> interfaces;
675 // Find the end of the entrypoint's name string. additional zero bytes follow the actual null terminator, to fill out the
676 // rest of the word - so we only need to look at the last byte in the word to determine which word contains the terminator.
677 uint32_t word = 3;
678 while (entrypoint.word(word) & 0xff000000u) {
679 ++word;
680 }
681 ++word;
682
683 for (; word < entrypoint.len(); word++) interfaces.push_back(entrypoint.word(word));
684
685 return interfaces;
686}
687
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600688static std::map<location_t, interface_var> CollectInterfaceByLocation(SHADER_MODULE_STATE const *src, spirv_inst_iter entrypoint,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600689 spv::StorageClass sinterface, bool is_array_of_verts) {
Chris Forbes47567b72017-06-09 12:09:45 -0700690 // TODO: handle index=1 dual source outputs from FS -- two vars will have the same location, and we DON'T want to clobber.
691
Chris Forbes47567b72017-06-09 12:09:45 -0700692 std::map<location_t, interface_var> out;
693
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800694 for (uint32_t iid : FindEntrypointInterfaces(entrypoint)) {
695 auto insn = src->get_def(iid);
Chris Forbes47567b72017-06-09 12:09:45 -0700696 assert(insn != src->end());
697 assert(insn.opcode() == spv::OpVariable);
698
699 if (insn.word(3) == static_cast<uint32_t>(sinterface)) {
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800700 auto d = src->get_decorations(iid);
Chris Forbes47567b72017-06-09 12:09:45 -0700701 unsigned id = insn.word(2);
702 unsigned type = insn.word(1);
703
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800704 int location = d.location;
705 int builtin = d.builtin;
706 unsigned component = d.component;
707 bool is_patch = (d.flags & decoration_set::patch_bit) != 0;
708 bool is_relaxed_precision = (d.flags & decoration_set::relaxed_precision_bit) != 0;
Chris Forbes47567b72017-06-09 12:09:45 -0700709
Dave Houltona9df0ce2018-02-07 10:51:23 -0700710 if (builtin != -1)
711 continue;
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800712 else if (!CollectInterfaceBlockMembers(src, &out, is_array_of_verts, id, type, is_patch, location)) {
Chris Forbes47567b72017-06-09 12:09:45 -0700713 // A user-defined interface variable, with a location. Where a variable occupied multiple locations, emit
714 // one result for each.
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600715 unsigned num_locations = GetLocationsConsumedByType(src, type, is_array_of_verts && !is_patch);
Chris Forbes47567b72017-06-09 12:09:45 -0700716 for (unsigned int offset = 0; offset < num_locations; offset++) {
717 interface_var v = {};
718 v.id = id;
719 v.type_id = type;
720 v.offset = offset;
721 v.is_patch = is_patch;
722 v.is_relaxed_precision = is_relaxed_precision;
723 out[std::make_pair(location + offset, component)] = v;
724 }
Chris Forbes47567b72017-06-09 12:09:45 -0700725 }
726 }
727 }
728
729 return out;
730}
731
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600732static std::vector<uint32_t> CollectBuiltinBlockMembers(SHADER_MODULE_STATE const *src, spirv_inst_iter entrypoint,
Ari Suonpaa696b3432019-03-11 14:02:57 +0200733 uint32_t storageClass) {
734 std::vector<uint32_t> variables;
735 std::vector<uint32_t> builtinStructMembers;
736 std::vector<uint32_t> builtinDecorations;
737
738 for (auto insn : *src) {
739 switch (insn.opcode()) {
740 // Find all built-in member decorations
741 case spv::OpMemberDecorate:
742 if (insn.word(3) == spv::DecorationBuiltIn) {
743 builtinStructMembers.push_back(insn.word(1));
744 }
745 break;
746 // Find all built-in decorations
747 case spv::OpDecorate:
748 switch (insn.word(2)) {
749 case spv::DecorationBlock: {
750 uint32_t blockID = insn.word(1);
751 for (auto builtInBlockID : builtinStructMembers) {
752 // Check if one of the members of the block are built-in -> the block is built-in
753 if (blockID == builtInBlockID) {
754 builtinDecorations.push_back(blockID);
755 break;
756 }
757 }
758 break;
759 }
760 case spv::DecorationBuiltIn:
761 builtinDecorations.push_back(insn.word(1));
762 break;
763 default:
764 break;
765 }
766 break;
767 default:
768 break;
769 }
770 }
771
772 // Find all interface variables belonging to the entrypoint and matching the storage class
773 for (uint32_t id : FindEntrypointInterfaces(entrypoint)) {
774 auto def = src->get_def(id);
775 assert(def != src->end());
776 assert(def.opcode() == spv::OpVariable);
777
778 if (def.word(3) == storageClass) variables.push_back(def.word(1));
779 }
780
781 // Find all members belonging to the builtin block selected
782 std::vector<uint32_t> builtinBlockMembers;
783 for (auto &var : variables) {
784 auto def = src->get_def(src->get_def(var).word(3));
785
786 // It could be an array of IO blocks. The element type should be the struct defining the block contents
787 if (def.opcode() == spv::OpTypeArray) def = src->get_def(def.word(2));
788
789 // Now find all members belonging to the struct defining the IO block
790 if (def.opcode() == spv::OpTypeStruct) {
791 for (auto builtInID : builtinDecorations) {
792 if (builtInID == def.word(1)) {
793 for (int i = 2; i < (int)def.len(); i++)
794 builtinBlockMembers.push_back(spv::BuiltInMax); // Start with undefined builtin for each struct member.
795 // These shouldn't be left after replacing.
796 for (auto insn : *src) {
797 if (insn.opcode() == spv::OpMemberDecorate && insn.word(1) == builtInID &&
798 insn.word(3) == spv::DecorationBuiltIn) {
799 auto structIndex = insn.word(2);
800 assert(structIndex < builtinBlockMembers.size());
801 builtinBlockMembers[structIndex] = insn.word(4);
802 }
803 }
804 }
805 }
806 }
807 }
808
809 return builtinBlockMembers;
810}
811
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600812static std::vector<std::pair<uint32_t, interface_var>> CollectInterfaceByInputAttachmentIndex(
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600813 SHADER_MODULE_STATE const *src, std::unordered_set<uint32_t> const &accessible_ids) {
Chris Forbes47567b72017-06-09 12:09:45 -0700814 std::vector<std::pair<uint32_t, interface_var>> out;
815
816 for (auto insn : *src) {
817 if (insn.opcode() == spv::OpDecorate) {
818 if (insn.word(2) == spv::DecorationInputAttachmentIndex) {
819 auto attachment_index = insn.word(3);
820 auto id = insn.word(1);
821
822 if (accessible_ids.count(id)) {
823 auto def = src->get_def(id);
824 assert(def != src->end());
825
826 if (def.opcode() == spv::OpVariable && insn.word(3) == spv::StorageClassUniformConstant) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600827 auto num_locations = GetLocationsConsumedByType(src, def.word(1), false);
Chris Forbes47567b72017-06-09 12:09:45 -0700828 for (unsigned int offset = 0; offset < num_locations; offset++) {
829 interface_var v = {};
830 v.id = id;
831 v.type_id = def.word(1);
832 v.offset = offset;
833 out.emplace_back(attachment_index + offset, v);
834 }
835 }
836 }
837 }
838 }
839 }
840
841 return out;
842}
843
Mark Lobodzinski3c59d972019-04-25 11:28:14 -0600844static bool IsWritableDescriptorType(SHADER_MODULE_STATE const *module, uint32_t type_id, bool is_storage_buffer) {
Chris Forbes8af24522018-03-07 11:37:45 -0800845 auto type = module->get_def(type_id);
846
847 // Strip off any array or ptrs. Where we remove array levels, adjust the descriptor count for each dimension.
Chris Forbes062f1222018-08-21 15:34:15 -0700848 while (type.opcode() == spv::OpTypeArray || type.opcode() == spv::OpTypePointer || type.opcode() == spv::OpTypeRuntimeArray) {
849 if (type.opcode() == spv::OpTypeArray || type.opcode() == spv::OpTypeRuntimeArray) {
Chris Forbes8d31e5d2018-10-08 17:19:15 -0700850 type = module->get_def(type.word(2)); // Element type
Chris Forbes8af24522018-03-07 11:37:45 -0800851 } else {
Chris Forbes8d31e5d2018-10-08 17:19:15 -0700852 type = module->get_def(type.word(3)); // Pointee type
Chris Forbes8af24522018-03-07 11:37:45 -0800853 }
854 }
855
856 switch (type.opcode()) {
857 case spv::OpTypeImage: {
858 auto dim = type.word(3);
859 auto sampled = type.word(7);
860 return sampled == 2 && dim != spv::DimSubpassData;
861 }
862
Chris Forbes8d31e5d2018-10-08 17:19:15 -0700863 case spv::OpTypeStruct: {
864 std::unordered_set<unsigned> nonwritable_members;
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800865 if (module->get_decorations(type.word(1)).flags & decoration_set::buffer_block_bit) is_storage_buffer = true;
Chris Forbes8af24522018-03-07 11:37:45 -0800866 for (auto insn : *module) {
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800867 if (insn.opcode() == spv::OpMemberDecorate && insn.word(1) == type.word(1) &&
868 insn.word(3) == spv::DecorationNonWritable) {
Chris Forbes8d31e5d2018-10-08 17:19:15 -0700869 nonwritable_members.insert(insn.word(2));
Chris Forbes8af24522018-03-07 11:37:45 -0800870 }
871 }
Chris Forbes8d31e5d2018-10-08 17:19:15 -0700872
873 // A buffer is writable if it's either flavor of storage buffer, and has any member not decorated
874 // as nonwritable.
875 return is_storage_buffer && nonwritable_members.size() != type.len() - 2;
876 }
Chris Forbes8af24522018-03-07 11:37:45 -0800877 }
878
879 return false;
880}
881
locke-lunargd9a069d2019-09-17 01:50:19 -0600882std::vector<std::pair<descriptor_slot_t, interface_var>> CollectInterfaceByDescriptorSlot(
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -0700883 SHADER_MODULE_STATE const *src, std::unordered_set<uint32_t> const &accessible_ids, bool *has_writable_descriptor) {
Chris Forbes47567b72017-06-09 12:09:45 -0700884 std::vector<std::pair<descriptor_slot_t, interface_var>> out;
885
886 for (auto id : accessible_ids) {
887 auto insn = src->get_def(id);
888 assert(insn != src->end());
889
890 if (insn.opcode() == spv::OpVariable &&
Chris Forbes9f89d752018-03-07 12:57:48 -0800891 (insn.word(3) == spv::StorageClassUniform || insn.word(3) == spv::StorageClassUniformConstant ||
892 insn.word(3) == spv::StorageClassStorageBuffer)) {
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800893 auto d = src->get_decorations(insn.word(2));
894 unsigned set = d.descriptor_set;
895 unsigned binding = d.binding;
Chris Forbes47567b72017-06-09 12:09:45 -0700896
897 interface_var v = {};
898 v.id = insn.word(2);
899 v.type_id = insn.word(1);
900 out.emplace_back(std::make_pair(set, binding), v);
Chris Forbes8af24522018-03-07 11:37:45 -0800901
Chris Forbes8a6d8cb2019-02-14 14:33:08 -0800902 if (!(d.flags & decoration_set::nonwritable_bit) &&
Chris Forbes8d31e5d2018-10-08 17:19:15 -0700903 IsWritableDescriptorType(src, insn.word(1), insn.word(3) == spv::StorageClassStorageBuffer)) {
Chris Forbes8af24522018-03-07 11:37:45 -0800904 *has_writable_descriptor = true;
905 }
Chris Forbes47567b72017-06-09 12:09:45 -0700906 }
907 }
908
909 return out;
910}
911
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -0700912bool CoreChecks::ValidateViConsistency(VkPipelineVertexInputStateCreateInfo const *vi) const {
Chris Forbes47567b72017-06-09 12:09:45 -0700913 // Walk the binding descriptions, which describe the step rate and stride of each vertex buffer. Each binding should
914 // be specified only once.
915 std::unordered_map<uint32_t, VkVertexInputBindingDescription const *> bindings;
916 bool skip = false;
917
918 for (unsigned i = 0; i < vi->vertexBindingDescriptionCount; i++) {
919 auto desc = &vi->pVertexBindingDescriptions[i];
920 auto &binding = bindings[desc->binding];
921 if (binding) {
Dave Houlton78d09922018-05-17 15:48:45 -0600922 // TODO: "VUID-VkGraphicsPipelineCreateInfo-pStages-00742" perhaps?
Mark Lobodzinski12b9be92020-01-30 15:25:55 -0700923 skip |= LogError(device, kVUID_Core_Shader_InconsistentVi, "Duplicate vertex input binding descriptions for binding %d",
924 desc->binding);
Chris Forbes47567b72017-06-09 12:09:45 -0700925 } else {
926 binding = desc;
927 }
928 }
929
930 return skip;
931}
932
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -0700933bool CoreChecks::ValidateViAgainstVsInputs(VkPipelineVertexInputStateCreateInfo const *vi, SHADER_MODULE_STATE const *vs,
934 spirv_inst_iter entrypoint) const {
Chris Forbes47567b72017-06-09 12:09:45 -0700935 bool skip = false;
936
Petr Kraus25810d02019-08-27 17:41:15 +0200937 const auto inputs = CollectInterfaceByLocation(vs, entrypoint, spv::StorageClassInput, false);
Chris Forbes47567b72017-06-09 12:09:45 -0700938
939 // Build index by location
Petr Kraus25810d02019-08-27 17:41:15 +0200940 std::map<uint32_t, const VkVertexInputAttributeDescription *> attribs;
Chris Forbes47567b72017-06-09 12:09:45 -0700941 if (vi) {
Petr Kraus25810d02019-08-27 17:41:15 +0200942 for (uint32_t i = 0; i < vi->vertexAttributeDescriptionCount; ++i) {
943 const auto num_locations = GetLocationsConsumedByFormat(vi->pVertexAttributeDescriptions[i].format);
944 for (uint32_t j = 0; j < num_locations; ++j) {
Chris Forbes47567b72017-06-09 12:09:45 -0700945 attribs[vi->pVertexAttributeDescriptions[i].location + j] = &vi->pVertexAttributeDescriptions[i];
946 }
947 }
948 }
949
Petr Kraus25810d02019-08-27 17:41:15 +0200950 struct AttribInputPair {
951 const VkVertexInputAttributeDescription *attrib = nullptr;
952 const interface_var *input = nullptr;
953 };
954 std::map<uint32_t, AttribInputPair> location_map;
955 for (const auto &attrib_it : attribs) location_map[attrib_it.first].attrib = attrib_it.second;
956 for (const auto &input_it : inputs) location_map[input_it.first.first].input = &input_it.second;
Chris Forbes47567b72017-06-09 12:09:45 -0700957
Petr Kraus25810d02019-08-27 17:41:15 +0200958 for (const auto location_it : location_map) {
959 const auto location = location_it.first;
960 const auto attrib = location_it.second.attrib;
961 const auto input = location_it.second.input;
Mark Lobodzinski7caa39c2018-07-25 15:48:34 -0600962
Petr Kraus25810d02019-08-27 17:41:15 +0200963 if (attrib && !input) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -0700964 skip |= LogPerformanceWarning(vs->vk_shader_module, kVUID_Core_Shader_OutputNotConsumed,
965 "Vertex attribute at location %" PRIu32 " not consumed by vertex shader", location);
Petr Kraus25810d02019-08-27 17:41:15 +0200966 } else if (!attrib && input) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -0700967 skip |= LogError(vs->vk_shader_module, kVUID_Core_Shader_InputNotProduced,
968 "Vertex shader consumes input at location %" PRIu32 " but not provided", location);
Petr Kraus25810d02019-08-27 17:41:15 +0200969 } else if (attrib && input) {
970 const auto attrib_type = GetFormatType(attrib->format);
971 const auto input_type = GetFundamentalType(vs, input->type_id);
Chris Forbes47567b72017-06-09 12:09:45 -0700972
973 // Type checking
974 if (!(attrib_type & input_type)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -0700975 skip |= LogError(vs->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
976 "Attribute type of `%s` at location %" PRIu32 " does not match vertex shader input type of `%s`",
977 string_VkFormat(attrib->format), location, DescribeType(vs, input->type_id).c_str());
Chris Forbes47567b72017-06-09 12:09:45 -0700978 }
Petr Kraus25810d02019-08-27 17:41:15 +0200979 } else { // !attrib && !input
980 assert(false); // at least one exists in the map
Chris Forbes47567b72017-06-09 12:09:45 -0700981 }
982 }
983
984 return skip;
985}
986
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -0700987bool CoreChecks::ValidateFsOutputsAgainstRenderPass(SHADER_MODULE_STATE const *fs, spirv_inst_iter entrypoint,
988 PIPELINE_STATE const *pipeline, uint32_t subpass_index) const {
Petr Kraus25810d02019-08-27 17:41:15 +0200989 bool skip = false;
Chris Forbes8bca1652017-07-20 11:10:09 -0700990
Petr Kraus25810d02019-08-27 17:41:15 +0200991 const auto rpci = pipeline->rp_state->createInfo.ptr();
992
Jeremy Hayes3699c7c2019-10-09 12:24:55 -0600993 struct Attachment {
994 const VkAttachmentReference2KHR *reference = nullptr;
995 const VkAttachmentDescription2KHR *attachment = nullptr;
996 const interface_var *output = nullptr;
997 };
998 std::map<uint32_t, Attachment> location_map;
999
Petr Kraus25810d02019-08-27 17:41:15 +02001000 const auto subpass = rpci->pSubpasses[subpass_index];
1001 for (uint32_t i = 0; i < subpass.colorAttachmentCount; ++i) {
Jeremy Hayes3699c7c2019-10-09 12:24:55 -06001002 auto const &reference = subpass.pColorAttachments[i];
1003 location_map[i].reference = &reference;
1004 if (reference.attachment != VK_ATTACHMENT_UNUSED &&
1005 rpci->pAttachments[reference.attachment].format != VK_FORMAT_UNDEFINED) {
1006 location_map[i].attachment = &rpci->pAttachments[reference.attachment];
Chris Forbes47567b72017-06-09 12:09:45 -07001007 }
1008 }
1009
Chris Forbes47567b72017-06-09 12:09:45 -07001010 // TODO: dual source blend index (spv::DecIndex, zero if not provided)
1011
Petr Kraus25810d02019-08-27 17:41:15 +02001012 const auto outputs = CollectInterfaceByLocation(fs, entrypoint, spv::StorageClassOutput, false);
Jeremy Hayes3699c7c2019-10-09 12:24:55 -06001013 for (const auto &output_it : outputs) {
1014 auto const location = output_it.first.first;
1015 location_map[location].output = &output_it.second;
1016 }
Chris Forbes47567b72017-06-09 12:09:45 -07001017
Petr Kraus25810d02019-08-27 17:41:15 +02001018 const bool alphaToCoverageEnabled = pipeline->graphicsPipelineCI.pMultisampleState != NULL &&
1019 pipeline->graphicsPipelineCI.pMultisampleState->alphaToCoverageEnable == VK_TRUE;
Chris Forbes47567b72017-06-09 12:09:45 -07001020
Petr Kraus25810d02019-08-27 17:41:15 +02001021 for (const auto location_it : location_map) {
Jeremy Hayes3699c7c2019-10-09 12:24:55 -06001022 const auto reference = location_it.second.reference;
1023 if (reference != nullptr && reference->attachment == VK_ATTACHMENT_UNUSED) {
1024 continue;
1025 }
1026
Petr Kraus25810d02019-08-27 17:41:15 +02001027 const auto location = location_it.first;
1028 const auto attachment = location_it.second.attachment;
1029 const auto output = location_it.second.output;
Petr Kraus25810d02019-08-27 17:41:15 +02001030 if (attachment && !output) {
1031 if (pipeline->attachments[location].colorWriteMask != 0) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001032 skip |= LogWarning(fs->vk_shader_module, kVUID_Core_Shader_InputNotProduced,
1033 "Attachment %" PRIu32
1034 " not written by fragment shader; undefined values will be written to attachment",
1035 location);
Petr Kraus25810d02019-08-27 17:41:15 +02001036 }
1037 } else if (!attachment && output) {
1038 if (!(alphaToCoverageEnabled && location == 0)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001039 skip |= LogWarning(fs->vk_shader_module, kVUID_Core_Shader_OutputNotConsumed,
1040 "fragment shader writes to output location %" PRIu32 " with no matching attachment", location);
Ari Suonpaa412b23b2019-02-26 07:56:58 +02001041 }
Petr Kraus25810d02019-08-27 17:41:15 +02001042 } else if (attachment && output) {
1043 const auto attachment_type = GetFormatType(attachment->format);
1044 const auto output_type = GetFundamentalType(fs, output->type_id);
Chris Forbes47567b72017-06-09 12:09:45 -07001045
1046 // Type checking
Petr Kraus25810d02019-08-27 17:41:15 +02001047 if (!(output_type & attachment_type)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001048 skip |=
1049 LogWarning(fs->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
1050 "Attachment %" PRIu32
1051 " of type `%s` does not match fragment shader output type of `%s`; resulting values are undefined",
1052 location, string_VkFormat(attachment->format), DescribeType(fs, output->type_id).c_str());
Chris Forbes47567b72017-06-09 12:09:45 -07001053 }
Petr Kraus25810d02019-08-27 17:41:15 +02001054 } else { // !attachment && !output
1055 assert(false); // at least one exists in the map
Chris Forbes47567b72017-06-09 12:09:45 -07001056 }
1057 }
1058
Petr Kraus25810d02019-08-27 17:41:15 +02001059 const auto output_zero = location_map.count(0) ? location_map[0].output : nullptr;
1060 bool locationZeroHasAlpha = output_zero && fs->get_def(output_zero->type_id) != fs->end() &&
1061 GetComponentsConsumedByType(fs, output_zero->type_id, false) == 4;
Ari Suonpaa412b23b2019-02-26 07:56:58 +02001062 if (alphaToCoverageEnabled && !locationZeroHasAlpha) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001063 skip |= LogError(fs->vk_shader_module, kVUID_Core_Shader_NoAlphaAtLocation0WithAlphaToCoverage,
1064 "fragment shader doesn't declare alpha output at location 0 even though alpha to coverage is enabled.");
Ari Suonpaa412b23b2019-02-26 07:56:58 +02001065 }
1066
Chris Forbes47567b72017-06-09 12:09:45 -07001067 return skip;
1068}
1069
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06001070// For PointSize analysis we need to know if the variable decorated with the PointSize built-in was actually written to.
1071// This function examines instructions in the static call tree for a write to this variable.
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06001072static bool IsPointSizeWritten(SHADER_MODULE_STATE const *src, spirv_inst_iter builtin_instr, spirv_inst_iter entrypoint) {
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06001073 auto type = builtin_instr.opcode();
1074 uint32_t target_id = builtin_instr.word(1);
1075 bool init_complete = false;
1076
1077 if (type == spv::OpMemberDecorate) {
1078 // Built-in is part of a structure -- examine instructions up to first function body to get initial IDs
1079 auto insn = entrypoint;
1080 while (!init_complete && (insn.opcode() != spv::OpFunction)) {
1081 switch (insn.opcode()) {
1082 case spv::OpTypePointer:
1083 if ((insn.word(3) == target_id) && (insn.word(2) == spv::StorageClassOutput)) {
1084 target_id = insn.word(1);
1085 }
1086 break;
1087 case spv::OpVariable:
1088 if (insn.word(1) == target_id) {
1089 target_id = insn.word(2);
1090 init_complete = true;
1091 }
1092 break;
1093 }
1094 insn++;
1095 }
1096 }
1097
Mark Lobodzinskif84b0b42018-09-11 14:54:32 -06001098 if (!init_complete && (type == spv::OpMemberDecorate)) return false;
1099
1100 bool found_write = false;
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06001101 std::unordered_set<uint32_t> worklist;
1102 worklist.insert(entrypoint.word(2));
1103
1104 // Follow instructions in call graph looking for writes to target
1105 while (!worklist.empty() && !found_write) {
1106 auto id_iter = worklist.begin();
1107 auto id = *id_iter;
1108 worklist.erase(id_iter);
1109
1110 auto insn = src->get_def(id);
1111 if (insn == src->end()) {
1112 continue;
1113 }
1114
1115 if (insn.opcode() == spv::OpFunction) {
1116 // Scan body of function looking for other function calls or items in our ID chain
1117 while (++insn, insn.opcode() != spv::OpFunctionEnd) {
1118 switch (insn.opcode()) {
1119 case spv::OpAccessChain:
1120 if (insn.word(3) == target_id) {
1121 if (type == spv::OpMemberDecorate) {
1122 auto value = GetConstantValue(src, insn.word(4));
1123 if (value == builtin_instr.word(2)) {
1124 target_id = insn.word(2);
1125 }
1126 } else {
1127 target_id = insn.word(2);
1128 }
1129 }
1130 break;
1131 case spv::OpStore:
1132 if (insn.word(1) == target_id) {
1133 found_write = true;
1134 }
1135 break;
1136 case spv::OpFunctionCall:
1137 worklist.insert(insn.word(3));
1138 break;
1139 }
1140 }
1141 }
1142 }
1143 return found_write;
1144}
1145
Chris Forbes47567b72017-06-09 12:09:45 -07001146// For some analyses, we need to know about all ids referenced by the static call tree of a particular entrypoint. This is
1147// important for identifying the set of shader resources actually used by an entrypoint, for example.
1148// Note: we only explore parts of the image which might actually contain ids we care about for the above analyses.
1149// - NOT the shader input/output interfaces.
1150//
1151// TODO: The set of interesting opcodes here was determined by eyeballing the SPIRV spec. It might be worth
1152// converting parts of this to be generated from the machine-readable spec instead.
locke-lunargd9a069d2019-09-17 01:50:19 -06001153std::unordered_set<uint32_t> MarkAccessibleIds(SHADER_MODULE_STATE const *src, spirv_inst_iter entrypoint) {
Chris Forbes47567b72017-06-09 12:09:45 -07001154 std::unordered_set<uint32_t> ids;
1155 std::unordered_set<uint32_t> worklist;
1156 worklist.insert(entrypoint.word(2));
1157
1158 while (!worklist.empty()) {
1159 auto id_iter = worklist.begin();
1160 auto id = *id_iter;
1161 worklist.erase(id_iter);
1162
1163 auto insn = src->get_def(id);
1164 if (insn == src->end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001165 // ID is something we didn't collect in BuildDefIndex. that's OK -- we'll stumble across all kinds of things here
Chris Forbes47567b72017-06-09 12:09:45 -07001166 // that we may not care about.
1167 continue;
1168 }
1169
1170 // Try to add to the output set
1171 if (!ids.insert(id).second) {
1172 continue; // If we already saw this id, we don't want to walk it again.
1173 }
1174
1175 switch (insn.opcode()) {
1176 case spv::OpFunction:
1177 // Scan whole body of the function, enlisting anything interesting
1178 while (++insn, insn.opcode() != spv::OpFunctionEnd) {
1179 switch (insn.opcode()) {
1180 case spv::OpLoad:
1181 case spv::OpAtomicLoad:
1182 case spv::OpAtomicExchange:
1183 case spv::OpAtomicCompareExchange:
1184 case spv::OpAtomicCompareExchangeWeak:
1185 case spv::OpAtomicIIncrement:
1186 case spv::OpAtomicIDecrement:
1187 case spv::OpAtomicIAdd:
1188 case spv::OpAtomicISub:
1189 case spv::OpAtomicSMin:
1190 case spv::OpAtomicUMin:
1191 case spv::OpAtomicSMax:
1192 case spv::OpAtomicUMax:
1193 case spv::OpAtomicAnd:
1194 case spv::OpAtomicOr:
1195 case spv::OpAtomicXor:
1196 worklist.insert(insn.word(3)); // ptr
1197 break;
1198 case spv::OpStore:
1199 case spv::OpAtomicStore:
1200 worklist.insert(insn.word(1)); // ptr
1201 break;
1202 case spv::OpAccessChain:
1203 case spv::OpInBoundsAccessChain:
1204 worklist.insert(insn.word(3)); // base ptr
1205 break;
1206 case spv::OpSampledImage:
1207 case spv::OpImageSampleImplicitLod:
1208 case spv::OpImageSampleExplicitLod:
1209 case spv::OpImageSampleDrefImplicitLod:
1210 case spv::OpImageSampleDrefExplicitLod:
1211 case spv::OpImageSampleProjImplicitLod:
1212 case spv::OpImageSampleProjExplicitLod:
1213 case spv::OpImageSampleProjDrefImplicitLod:
1214 case spv::OpImageSampleProjDrefExplicitLod:
1215 case spv::OpImageFetch:
1216 case spv::OpImageGather:
1217 case spv::OpImageDrefGather:
1218 case spv::OpImageRead:
1219 case spv::OpImage:
1220 case spv::OpImageQueryFormat:
1221 case spv::OpImageQueryOrder:
1222 case spv::OpImageQuerySizeLod:
1223 case spv::OpImageQuerySize:
1224 case spv::OpImageQueryLod:
1225 case spv::OpImageQueryLevels:
1226 case spv::OpImageQuerySamples:
1227 case spv::OpImageSparseSampleImplicitLod:
1228 case spv::OpImageSparseSampleExplicitLod:
1229 case spv::OpImageSparseSampleDrefImplicitLod:
1230 case spv::OpImageSparseSampleDrefExplicitLod:
1231 case spv::OpImageSparseSampleProjImplicitLod:
1232 case spv::OpImageSparseSampleProjExplicitLod:
1233 case spv::OpImageSparseSampleProjDrefImplicitLod:
1234 case spv::OpImageSparseSampleProjDrefExplicitLod:
1235 case spv::OpImageSparseFetch:
1236 case spv::OpImageSparseGather:
1237 case spv::OpImageSparseDrefGather:
1238 case spv::OpImageTexelPointer:
1239 worklist.insert(insn.word(3)); // Image or sampled image
1240 break;
1241 case spv::OpImageWrite:
1242 worklist.insert(insn.word(1)); // Image -- different operand order to above
1243 break;
1244 case spv::OpFunctionCall:
1245 for (uint32_t i = 3; i < insn.len(); i++) {
1246 worklist.insert(insn.word(i)); // fn itself, and all args
1247 }
1248 break;
1249
1250 case spv::OpExtInst:
1251 for (uint32_t i = 5; i < insn.len(); i++) {
1252 worklist.insert(insn.word(i)); // Operands to ext inst
1253 }
1254 break;
1255 }
1256 }
1257 break;
1258 }
1259 }
1260
1261 return ids;
1262}
1263
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001264bool CoreChecks::ValidatePushConstantBlockAgainstPipeline(std::vector<VkPushConstantRange> const *push_constant_ranges,
1265 SHADER_MODULE_STATE const *src, spirv_inst_iter type,
1266 VkShaderStageFlagBits stage) const {
Chris Forbes47567b72017-06-09 12:09:45 -07001267 bool skip = false;
1268
1269 // Strip off ptrs etc
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001270 type = GetStructType(src, type, false);
Chris Forbes47567b72017-06-09 12:09:45 -07001271 assert(type != src->end());
1272
1273 // Validate directly off the offsets. this isn't quite correct for arrays and matrices, but is a good first step.
1274 // TODO: arrays, matrices, weird sizes
1275 for (auto insn : *src) {
1276 if (insn.opcode() == spv::OpMemberDecorate && insn.word(1) == type.word(1)) {
1277 if (insn.word(3) == spv::DecorationOffset) {
1278 unsigned offset = insn.word(4);
1279 auto size = 4; // Bytes; TODO: calculate this based on the type
1280
1281 bool found_range = false;
1282 for (auto const &range : *push_constant_ranges) {
Jeremy Hayese883b362019-12-10 15:12:26 -07001283 if ((range.offset <= offset) && ((range.offset + range.size) >= (offset + size)) &&
1284 (range.stageFlags & stage)) {
Chris Forbes47567b72017-06-09 12:09:45 -07001285 found_range = true;
1286
Chris Forbes47567b72017-06-09 12:09:45 -07001287 break;
1288 }
1289 }
1290
1291 if (!found_range) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001292 skip |= LogError(device, kVUID_Core_Shader_PushConstantOutOfRange,
1293 "Push constant range covering variable starting at offset %u not declared in layout", offset);
Chris Forbes47567b72017-06-09 12:09:45 -07001294 }
1295 }
1296 }
1297 }
1298
1299 return skip;
1300}
1301
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001302bool CoreChecks::ValidatePushConstantUsage(std::vector<VkPushConstantRange> const *push_constant_ranges,
1303 SHADER_MODULE_STATE const *src, std::unordered_set<uint32_t> accessible_ids,
1304 VkShaderStageFlagBits stage) const {
Chris Forbes47567b72017-06-09 12:09:45 -07001305 bool skip = false;
1306
1307 for (auto id : accessible_ids) {
1308 auto def_insn = src->get_def(id);
1309 if (def_insn.opcode() == spv::OpVariable && def_insn.word(3) == spv::StorageClassPushConstant) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001310 skip |= ValidatePushConstantBlockAgainstPipeline(push_constant_ranges, src, src->get_def(def_insn.word(1)), stage);
Chris Forbes47567b72017-06-09 12:09:45 -07001311 }
1312 }
1313
1314 return skip;
1315}
1316
1317// Validate that data for each specialization entry is fully contained within the buffer.
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001318bool CoreChecks::ValidateSpecializationOffsets(VkPipelineShaderStageCreateInfo const *info) const {
Chris Forbes47567b72017-06-09 12:09:45 -07001319 bool skip = false;
1320
1321 VkSpecializationInfo const *spec = info->pSpecializationInfo;
1322
1323 if (spec) {
1324 for (auto i = 0u; i < spec->mapEntryCount; i++) {
Jeremy Hayes6c555c32019-09-09 17:14:09 -06001325 if (spec->pMapEntries[i].offset >= spec->dataSize) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001326 skip |= LogError(device, "VUID-VkSpecializationInfo-offset-00773",
1327 "Specialization entry %u (for constant id %u) references memory outside provided specialization "
1328 "data (bytes %u.." PRINTF_SIZE_T_SPECIFIER "; " PRINTF_SIZE_T_SPECIFIER " bytes provided)..",
1329 i, spec->pMapEntries[i].constantID, spec->pMapEntries[i].offset,
1330 spec->pMapEntries[i].offset + spec->dataSize - 1, spec->dataSize);
Jeremy Hayes6c555c32019-09-09 17:14:09 -06001331
1332 continue;
1333 }
Chris Forbes47567b72017-06-09 12:09:45 -07001334 if (spec->pMapEntries[i].offset + spec->pMapEntries[i].size > spec->dataSize) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001335 skip |= LogError(device, "VUID-VkSpecializationInfo-pMapEntries-00774",
1336 "Specialization entry %u (for constant id %u) references memory outside provided specialization "
1337 "data (bytes %u.." PRINTF_SIZE_T_SPECIFIER "; " PRINTF_SIZE_T_SPECIFIER " bytes provided)..",
1338 i, spec->pMapEntries[i].constantID, spec->pMapEntries[i].offset,
1339 spec->pMapEntries[i].offset + spec->pMapEntries[i].size - 1, spec->dataSize);
Chris Forbes47567b72017-06-09 12:09:45 -07001340 }
1341 }
1342 }
1343
1344 return skip;
1345}
1346
Jeff Bolz38b3ce72018-09-19 12:53:38 -05001347// TODO (jbolz): Can this return a const reference?
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06001348static std::set<uint32_t> TypeToDescriptorTypeSet(SHADER_MODULE_STATE const *module, uint32_t type_id, unsigned &descriptor_count) {
Chris Forbes47567b72017-06-09 12:09:45 -07001349 auto type = module->get_def(type_id);
Chris Forbes9f89d752018-03-07 12:57:48 -08001350 bool is_storage_buffer = false;
Chris Forbes47567b72017-06-09 12:09:45 -07001351 descriptor_count = 1;
Jeff Bolze54ae892018-09-08 12:16:29 -05001352 std::set<uint32_t> ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001353
1354 // Strip off any array or ptrs. Where we remove array levels, adjust the descriptor count for each dimension.
Jeff Bolzfdf96072018-04-10 14:32:18 -05001355 while (type.opcode() == spv::OpTypeArray || type.opcode() == spv::OpTypePointer || type.opcode() == spv::OpTypeRuntimeArray) {
1356 if (type.opcode() == spv::OpTypeRuntimeArray) {
1357 descriptor_count = 0;
1358 type = module->get_def(type.word(2));
1359 } else if (type.opcode() == spv::OpTypeArray) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001360 descriptor_count *= GetConstantValue(module, type.word(3));
Chris Forbes47567b72017-06-09 12:09:45 -07001361 type = module->get_def(type.word(2));
1362 } else {
Chris Forbes9f89d752018-03-07 12:57:48 -08001363 if (type.word(2) == spv::StorageClassStorageBuffer) {
1364 is_storage_buffer = true;
1365 }
Chris Forbes47567b72017-06-09 12:09:45 -07001366 type = module->get_def(type.word(3));
1367 }
1368 }
1369
1370 switch (type.opcode()) {
1371 case spv::OpTypeStruct: {
1372 for (auto insn : *module) {
1373 if (insn.opcode() == spv::OpDecorate && insn.word(1) == type.word(1)) {
1374 if (insn.word(2) == spv::DecorationBlock) {
Chris Forbes9f89d752018-03-07 12:57:48 -08001375 if (is_storage_buffer) {
Jeff Bolze54ae892018-09-08 12:16:29 -05001376 ret.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER);
1377 ret.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC);
1378 return ret;
Chris Forbes9f89d752018-03-07 12:57:48 -08001379 } else {
Jeff Bolze54ae892018-09-08 12:16:29 -05001380 ret.insert(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER);
1381 ret.insert(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC);
1382 ret.insert(VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT);
1383 return ret;
Chris Forbes9f89d752018-03-07 12:57:48 -08001384 }
Chris Forbes47567b72017-06-09 12:09:45 -07001385 } else if (insn.word(2) == spv::DecorationBufferBlock) {
Jeff Bolze54ae892018-09-08 12:16:29 -05001386 ret.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER);
1387 ret.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC);
1388 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001389 }
1390 }
1391 }
1392
1393 // Invalid
Jeff Bolze54ae892018-09-08 12:16:29 -05001394 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001395 }
1396
1397 case spv::OpTypeSampler:
Jeff Bolze54ae892018-09-08 12:16:29 -05001398 ret.insert(VK_DESCRIPTOR_TYPE_SAMPLER);
1399 ret.insert(VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER);
1400 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001401
Chris Forbes73c00bf2018-06-22 16:28:06 -07001402 case spv::OpTypeSampledImage: {
1403 // Slight relaxation for some GLSL historical madness: samplerBuffer doesn't really have a sampler, and a texel
1404 // buffer descriptor doesn't really provide one. Allow this slight mismatch.
1405 auto image_type = module->get_def(type.word(2));
1406 auto dim = image_type.word(3);
1407 auto sampled = image_type.word(7);
1408 if (dim == spv::DimBuffer && sampled == 1) {
Jeff Bolze54ae892018-09-08 12:16:29 -05001409 ret.insert(VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER);
1410 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001411 }
Chris Forbes73c00bf2018-06-22 16:28:06 -07001412 }
Jeff Bolze54ae892018-09-08 12:16:29 -05001413 ret.insert(VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER);
1414 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001415
1416 case spv::OpTypeImage: {
1417 // Many descriptor types backing image types-- depends on dimension and whether the image will be used with a sampler.
1418 // SPIRV for Vulkan requires that sampled be 1 or 2 -- leaving the decision to runtime is unacceptable.
1419 auto dim = type.word(3);
1420 auto sampled = type.word(7);
1421
1422 if (dim == spv::DimSubpassData) {
Jeff Bolze54ae892018-09-08 12:16:29 -05001423 ret.insert(VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT);
1424 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001425 } else if (dim == spv::DimBuffer) {
1426 if (sampled == 1) {
Jeff Bolze54ae892018-09-08 12:16:29 -05001427 ret.insert(VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER);
1428 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001429 } else {
Jeff Bolze54ae892018-09-08 12:16:29 -05001430 ret.insert(VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER);
1431 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001432 }
1433 } else if (sampled == 1) {
Jeff Bolze54ae892018-09-08 12:16:29 -05001434 ret.insert(VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE);
1435 ret.insert(VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER);
1436 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001437 } else {
Jeff Bolze54ae892018-09-08 12:16:29 -05001438 ret.insert(VK_DESCRIPTOR_TYPE_STORAGE_IMAGE);
1439 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001440 }
1441 }
Shannon McPherson0fa28232018-11-01 11:59:02 -06001442 case spv::OpTypeAccelerationStructureNV:
Eric Werness30127fd2018-10-31 21:01:03 -07001443 ret.insert(VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV);
Jeff Bolz105d6492018-09-29 15:46:44 -05001444 return ret;
Chris Forbes47567b72017-06-09 12:09:45 -07001445
1446 // We shouldn't really see any other junk types -- but if we do, they're a mismatch.
1447 default:
Jeff Bolze54ae892018-09-08 12:16:29 -05001448 return ret; // Matches nothing
Chris Forbes47567b72017-06-09 12:09:45 -07001449 }
1450}
1451
Jeff Bolze54ae892018-09-08 12:16:29 -05001452static std::string string_descriptorTypes(const std::set<uint32_t> &descriptor_types) {
Chris Forbes73c00bf2018-06-22 16:28:06 -07001453 std::stringstream ss;
Jeff Bolze54ae892018-09-08 12:16:29 -05001454 for (auto it = descriptor_types.begin(); it != descriptor_types.end(); ++it) {
1455 if (ss.tellp()) ss << ", ";
1456 ss << string_VkDescriptorType(VkDescriptorType(*it));
Chris Forbes73c00bf2018-06-22 16:28:06 -07001457 }
1458 return ss.str();
1459}
1460
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001461bool CoreChecks::RequirePropertyFlag(VkBool32 check, char const *flag, char const *structure) const {
Jeff Bolzee743412019-06-20 22:24:32 -05001462 if (!check) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001463 if (LogError(device, kVUID_Core_Shader_ExceedDeviceLimit,
1464 "Shader requires flag %s set in %s but it is not set on the device", flag, structure)) {
Jeff Bolzee743412019-06-20 22:24:32 -05001465 return true;
1466 }
1467 }
1468
1469 return false;
1470}
1471
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001472bool CoreChecks::RequireFeature(VkBool32 feature, char const *feature_name) const {
Chris Forbes47567b72017-06-09 12:09:45 -07001473 if (!feature) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001474 if (LogError(device, kVUID_Core_Shader_FeatureNotEnabled, "Shader requires %s but is not enabled on the device",
1475 feature_name)) {
Chris Forbes47567b72017-06-09 12:09:45 -07001476 return true;
1477 }
1478 }
1479
1480 return false;
1481}
1482
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001483bool CoreChecks::RequireExtension(bool extension, char const *extension_name) const {
Chris Forbes47567b72017-06-09 12:09:45 -07001484 if (!extension) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001485 if (LogError(device, kVUID_Core_Shader_FeatureNotEnabled, "Shader requires extension %s but is not enabled on the device",
1486 extension_name)) {
Chris Forbes47567b72017-06-09 12:09:45 -07001487 return true;
1488 }
1489 }
1490
1491 return false;
1492}
1493
John Zulaufac4c6e12019-07-01 16:05:58 -06001494bool CoreChecks::ValidateShaderCapabilities(SHADER_MODULE_STATE const *src, VkShaderStageFlagBits stage) const {
Chris Forbes47567b72017-06-09 12:09:45 -07001495 bool skip = false;
1496
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001497 struct FeaturePointer {
1498 // Callable object to test if this feature is enabled in the given aggregate feature struct
1499 const std::function<VkBool32(const DeviceFeatures &)> IsEnabled;
1500
1501 // Test if feature pointer is populated
1502 explicit operator bool() const { return static_cast<bool>(IsEnabled); }
1503
1504 // Default and nullptr constructor to create an empty FeaturePointer
1505 FeaturePointer() : IsEnabled(nullptr) {}
1506 FeaturePointer(std::nullptr_t ptr) : IsEnabled(nullptr) {}
1507
1508 // Constructors to populate FeaturePointer based on given pointer to member
1509 FeaturePointer(VkBool32 VkPhysicalDeviceFeatures::*ptr)
1510 : IsEnabled([=](const DeviceFeatures &features) { return features.core.*ptr; }) {}
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001511 FeaturePointer(VkBool32 VkPhysicalDeviceVulkan11Features::*ptr)
1512 : IsEnabled([=](const DeviceFeatures &features) { return features.core11.*ptr; }) {}
1513 FeaturePointer(VkBool32 VkPhysicalDeviceVulkan12Features::*ptr)
1514 : IsEnabled([=](const DeviceFeatures &features) { return features.core12.*ptr; }) {}
Brett Lawsonbebfb6f2018-10-23 16:58:50 -07001515 FeaturePointer(VkBool32 VkPhysicalDeviceTransformFeedbackFeaturesEXT::*ptr)
1516 : IsEnabled([=](const DeviceFeatures &features) { return features.transform_feedback_features.*ptr; }) {}
Jeff Bolze4356752019-03-07 11:23:46 -06001517 FeaturePointer(VkBool32 VkPhysicalDeviceCooperativeMatrixFeaturesNV::*ptr)
1518 : IsEnabled([=](const DeviceFeatures &features) { return features.cooperative_matrix_features.*ptr; }) {}
Jason Macnakc5a621d2019-06-10 12:42:50 -07001519 FeaturePointer(VkBool32 VkPhysicalDeviceComputeShaderDerivativesFeaturesNV::*ptr)
1520 : IsEnabled([=](const DeviceFeatures &features) { return features.compute_shader_derivatives_features.*ptr; }) {}
Jason Macnak325e8b52019-06-10 13:33:10 -07001521 FeaturePointer(VkBool32 VkPhysicalDeviceFragmentShaderBarycentricFeaturesNV::*ptr)
1522 : IsEnabled([=](const DeviceFeatures &features) { return features.fragment_shader_barycentric_features.*ptr; }) {}
Jason Macnakd7fddf82019-06-13 09:52:49 -07001523 FeaturePointer(VkBool32 VkPhysicalDeviceShaderImageFootprintFeaturesNV::*ptr)
1524 : IsEnabled([=](const DeviceFeatures &features) { return features.shader_image_footprint_features.*ptr; }) {}
Jeff Bolz38f6cb52019-06-30 16:26:44 -05001525 FeaturePointer(VkBool32 VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::*ptr)
1526 : IsEnabled([=](const DeviceFeatures &features) { return features.fragment_shader_interlock_features.*ptr; }) {}
Jeff Bolza38fd3b2019-07-21 11:42:11 -05001527 FeaturePointer(VkBool32 VkPhysicalDeviceShaderDemoteToHelperInvocationFeaturesEXT::*ptr)
1528 : IsEnabled([=](const DeviceFeatures &features) { return features.demote_to_helper_invocation_features.*ptr; }) {}
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001529 };
1530
Chris Forbes47567b72017-06-09 12:09:45 -07001531 struct CapabilityInfo {
1532 char const *name;
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001533 FeaturePointer feature;
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07001534 ExtEnabled DeviceExtensions::*extension;
Chris Forbes47567b72017-06-09 12:09:45 -07001535 };
1536
Chris Forbes47567b72017-06-09 12:09:45 -07001537 // clang-format off
Dave Houltoneb10ea82017-12-22 12:21:50 -07001538 static const std::unordered_multimap<uint32_t, CapabilityInfo> capabilities = {
Chris Forbes47567b72017-06-09 12:09:45 -07001539 // Capabilities always supported by a Vulkan 1.0 implementation -- no
1540 // feature bits.
1541 {spv::CapabilityMatrix, {nullptr}},
1542 {spv::CapabilityShader, {nullptr}},
1543 {spv::CapabilityInputAttachment, {nullptr}},
1544 {spv::CapabilitySampled1D, {nullptr}},
1545 {spv::CapabilityImage1D, {nullptr}},
1546 {spv::CapabilitySampledBuffer, {nullptr}},
Toni Merilehtib13a4a22019-05-21 12:58:44 +03001547 {spv::CapabilityStorageImageExtendedFormats, {nullptr}},
Chris Forbes47567b72017-06-09 12:09:45 -07001548 {spv::CapabilityImageQuery, {nullptr}},
1549 {spv::CapabilityDerivativeControl, {nullptr}},
1550
1551 // Capabilities that are optionally supported, but require a feature to
1552 // be enabled on the device
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001553 {spv::CapabilityGeometry, {"VkPhysicalDeviceFeatures::geometryShader", &VkPhysicalDeviceFeatures::geometryShader}},
1554 {spv::CapabilityTessellation, {"VkPhysicalDeviceFeatures::tessellationShader", &VkPhysicalDeviceFeatures::tessellationShader}},
1555 {spv::CapabilityFloat64, {"VkPhysicalDeviceFeatures::shaderFloat64", &VkPhysicalDeviceFeatures::shaderFloat64}},
1556 {spv::CapabilityInt64, {"VkPhysicalDeviceFeatures::shaderInt64", &VkPhysicalDeviceFeatures::shaderInt64}},
1557 {spv::CapabilityTessellationPointSize, {"VkPhysicalDeviceFeatures::shaderTessellationAndGeometryPointSize", &VkPhysicalDeviceFeatures::shaderTessellationAndGeometryPointSize}},
1558 {spv::CapabilityGeometryPointSize, {"VkPhysicalDeviceFeatures::shaderTessellationAndGeometryPointSize", &VkPhysicalDeviceFeatures::shaderTessellationAndGeometryPointSize}},
1559 {spv::CapabilityImageGatherExtended, {"VkPhysicalDeviceFeatures::shaderImageGatherExtended", &VkPhysicalDeviceFeatures::shaderImageGatherExtended}},
1560 {spv::CapabilityStorageImageMultisample, {"VkPhysicalDeviceFeatures::shaderStorageImageMultisample", &VkPhysicalDeviceFeatures::shaderStorageImageMultisample}},
1561 {spv::CapabilityUniformBufferArrayDynamicIndexing, {"VkPhysicalDeviceFeatures::shaderUniformBufferArrayDynamicIndexing", &VkPhysicalDeviceFeatures::shaderUniformBufferArrayDynamicIndexing}},
1562 {spv::CapabilitySampledImageArrayDynamicIndexing, {"VkPhysicalDeviceFeatures::shaderSampledImageArrayDynamicIndexing", &VkPhysicalDeviceFeatures::shaderSampledImageArrayDynamicIndexing}},
1563 {spv::CapabilityStorageBufferArrayDynamicIndexing, {"VkPhysicalDeviceFeatures::shaderStorageBufferArrayDynamicIndexing", &VkPhysicalDeviceFeatures::shaderStorageBufferArrayDynamicIndexing}},
1564 {spv::CapabilityStorageImageArrayDynamicIndexing, {"VkPhysicalDeviceFeatures::shaderStorageImageArrayDynamicIndexing", &VkPhysicalDeviceFeatures::shaderStorageBufferArrayDynamicIndexing}},
1565 {spv::CapabilityClipDistance, {"VkPhysicalDeviceFeatures::shaderClipDistance", &VkPhysicalDeviceFeatures::shaderClipDistance}},
1566 {spv::CapabilityCullDistance, {"VkPhysicalDeviceFeatures::shaderCullDistance", &VkPhysicalDeviceFeatures::shaderCullDistance}},
1567 {spv::CapabilityImageCubeArray, {"VkPhysicalDeviceFeatures::imageCubeArray", &VkPhysicalDeviceFeatures::imageCubeArray}},
1568 {spv::CapabilitySampleRateShading, {"VkPhysicalDeviceFeatures::sampleRateShading", &VkPhysicalDeviceFeatures::sampleRateShading}},
1569 {spv::CapabilitySparseResidency, {"VkPhysicalDeviceFeatures::shaderResourceResidency", &VkPhysicalDeviceFeatures::shaderResourceResidency}},
1570 {spv::CapabilityMinLod, {"VkPhysicalDeviceFeatures::shaderResourceMinLod", &VkPhysicalDeviceFeatures::shaderResourceMinLod}},
1571 {spv::CapabilitySampledCubeArray, {"VkPhysicalDeviceFeatures::imageCubeArray", &VkPhysicalDeviceFeatures::imageCubeArray}},
1572 {spv::CapabilityImageMSArray, {"VkPhysicalDeviceFeatures::shaderStorageImageMultisample", &VkPhysicalDeviceFeatures::shaderStorageImageMultisample}},
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001573 {spv::CapabilityInterpolationFunction, {"VkPhysicalDeviceFeatures::sampleRateShading", &VkPhysicalDeviceFeatures::sampleRateShading}},
1574 {spv::CapabilityStorageImageReadWithoutFormat, {"VkPhysicalDeviceFeatures::shaderStorageImageReadWithoutFormat", &VkPhysicalDeviceFeatures::shaderStorageImageReadWithoutFormat}},
1575 {spv::CapabilityStorageImageWriteWithoutFormat, {"VkPhysicalDeviceFeatures::shaderStorageImageWriteWithoutFormat", &VkPhysicalDeviceFeatures::shaderStorageImageWriteWithoutFormat}},
1576 {spv::CapabilityMultiViewport, {"VkPhysicalDeviceFeatures::multiViewport", &VkPhysicalDeviceFeatures::multiViewport}},
Jeff Bolzfdf96072018-04-10 14:32:18 -05001577
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001578 {spv::CapabilityShaderNonUniformEXT, {VK_EXT_DESCRIPTOR_INDEXING_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_ext_descriptor_indexing}},
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001579 {spv::CapabilityRuntimeDescriptorArrayEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::runtimeDescriptorArray", &VkPhysicalDeviceVulkan12Features::runtimeDescriptorArray}},
1580 {spv::CapabilityInputAttachmentArrayDynamicIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderInputAttachmentArrayDynamicIndexing", &VkPhysicalDeviceVulkan12Features::shaderInputAttachmentArrayDynamicIndexing}},
1581 {spv::CapabilityUniformTexelBufferArrayDynamicIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderUniformTexelBufferArrayDynamicIndexing", &VkPhysicalDeviceVulkan12Features::shaderUniformTexelBufferArrayDynamicIndexing}},
1582 {spv::CapabilityStorageTexelBufferArrayDynamicIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderStorageTexelBufferArrayDynamicIndexing", &VkPhysicalDeviceVulkan12Features::shaderStorageTexelBufferArrayDynamicIndexing}},
1583 {spv::CapabilityUniformBufferArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderUniformBufferArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderUniformBufferArrayNonUniformIndexing}},
1584 {spv::CapabilitySampledImageArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderSampledImageArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderSampledImageArrayNonUniformIndexing}},
1585 {spv::CapabilityStorageBufferArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderStorageBufferArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderStorageBufferArrayNonUniformIndexing}},
1586 {spv::CapabilityStorageImageArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderStorageImageArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderStorageImageArrayNonUniformIndexing}},
1587 {spv::CapabilityInputAttachmentArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderInputAttachmentArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderInputAttachmentArrayNonUniformIndexing}},
1588 {spv::CapabilityUniformTexelBufferArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderUniformTexelBufferArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderUniformTexelBufferArrayNonUniformIndexing}},
1589 {spv::CapabilityStorageTexelBufferArrayNonUniformIndexingEXT, {"VkPhysicalDeviceDescriptorIndexingFeatures::shaderStorageTexelBufferArrayNonUniformIndexing", &VkPhysicalDeviceVulkan12Features::shaderStorageTexelBufferArrayNonUniformIndexing}},
Chris Forbes47567b72017-06-09 12:09:45 -07001590
1591 // Capabilities that require an extension
Mike Schuchardt8ed5ea02018-07-20 18:24:17 -06001592 {spv::CapabilityDrawParameters, {VK_KHR_SHADER_DRAW_PARAMETERS_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_khr_shader_draw_parameters}},
1593 {spv::CapabilityGeometryShaderPassthroughNV, {VK_NV_GEOMETRY_SHADER_PASSTHROUGH_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_nv_geometry_shader_passthrough}},
1594 {spv::CapabilitySampleMaskOverrideCoverageNV, {VK_NV_SAMPLE_MASK_OVERRIDE_COVERAGE_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_nv_sample_mask_override_coverage}},
1595 {spv::CapabilityShaderViewportIndexLayerEXT, {VK_EXT_SHADER_VIEWPORT_INDEX_LAYER_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_ext_shader_viewport_index_layer}},
1596 {spv::CapabilityShaderViewportIndexLayerNV, {VK_NV_VIEWPORT_ARRAY2_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_nv_viewport_array2}},
1597 {spv::CapabilityShaderViewportMaskNV, {VK_NV_VIEWPORT_ARRAY2_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_nv_viewport_array2}},
1598 {spv::CapabilitySubgroupBallotKHR, {VK_EXT_SHADER_SUBGROUP_BALLOT_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_ext_shader_subgroup_ballot }},
1599 {spv::CapabilitySubgroupVoteKHR, {VK_EXT_SHADER_SUBGROUP_VOTE_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_ext_shader_subgroup_vote }},
Jason Macnakb7d091c2019-06-10 11:13:11 -07001600 {spv::CapabilityGroupNonUniformPartitionedNV, {VK_NV_SHADER_SUBGROUP_PARTITIONED_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_nv_shader_subgroup_partitioned}},
aqnuep7033c702018-09-11 18:03:29 +02001601 {spv::CapabilityInt64Atomics, {VK_KHR_SHADER_ATOMIC_INT64_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_khr_shader_atomic_int64 }},
amhaganfa0b34d2019-10-15 16:03:53 -04001602 {spv::CapabilityShaderClockKHR, {VK_KHR_SHADER_CLOCK_EXTENSION_NAME, nullptr, &DeviceExtensions::vk_khr_shader_clock }},
Alexander Galazin3bd8e342018-06-14 15:49:07 +02001603
Jason Macnakc5a621d2019-06-10 12:42:50 -07001604 {spv::CapabilityComputeDerivativeGroupQuadsNV, {"VkPhysicalDeviceComputeShaderDerivativesFeaturesNV::computeDerivativeGroupQuads", &VkPhysicalDeviceComputeShaderDerivativesFeaturesNV::computeDerivativeGroupQuads, &DeviceExtensions::vk_nv_compute_shader_derivatives}},
1605 {spv::CapabilityComputeDerivativeGroupLinearNV, {"VkPhysicalDeviceComputeShaderDerivativesFeaturesNV::computeDerivativeGroupLinear", &VkPhysicalDeviceComputeShaderDerivativesFeaturesNV::computeDerivativeGroupLinear, &DeviceExtensions::vk_nv_compute_shader_derivatives}},
Jason Macnakf7019582019-06-13 10:07:26 -07001606 {spv::CapabilityFragmentBarycentricNV, {"VkPhysicalDeviceFragmentShaderBarycentricFeaturesNV::fragmentShaderBarycentric", &VkPhysicalDeviceFragmentShaderBarycentricFeaturesNV::fragmentShaderBarycentric, &DeviceExtensions::vk_nv_fragment_shader_barycentric}},
Jason Macnakc5a621d2019-06-10 12:42:50 -07001607
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001608 {spv::CapabilityStorageBuffer8BitAccess, {"VkPhysicalDevice8BitStorageFeaturesKHR::storageBuffer8BitAccess", &VkPhysicalDeviceVulkan12Features::storageBuffer8BitAccess, &DeviceExtensions::vk_khr_8bit_storage}},
1609 {spv::CapabilityUniformAndStorageBuffer8BitAccess, {"VkPhysicalDevice8BitStorageFeaturesKHR::uniformAndStorageBuffer8BitAccess", &VkPhysicalDeviceVulkan12Features::uniformAndStorageBuffer8BitAccess, &DeviceExtensions::vk_khr_8bit_storage}},
1610 {spv::CapabilityStoragePushConstant8, {"VkPhysicalDevice8BitStorageFeaturesKHR::storagePushConstant8", &VkPhysicalDeviceVulkan12Features::storagePushConstant8, &DeviceExtensions::vk_khr_8bit_storage}},
Brett Lawsonbebfb6f2018-10-23 16:58:50 -07001611
Jason Macnakf7019582019-06-13 10:07:26 -07001612 {spv::CapabilityTransformFeedback, { "VkPhysicalDeviceTransformFeedbackFeaturesEXT::transformFeedback", &VkPhysicalDeviceTransformFeedbackFeaturesEXT::transformFeedback, &DeviceExtensions::vk_ext_transform_feedback}},
1613 {spv::CapabilityGeometryStreams, { "VkPhysicalDeviceTransformFeedbackFeaturesEXT::geometryStreams", &VkPhysicalDeviceTransformFeedbackFeaturesEXT::geometryStreams, &DeviceExtensions::vk_ext_transform_feedback}},
Jose-Emilio Munoz-Lopez1109b452018-08-21 09:44:07 +01001614
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001615 {spv::CapabilityFloat16, {"VkPhysicalDeviceFloat16Int8FeaturesKHR::shaderFloat16", &VkPhysicalDeviceVulkan12Features::shaderFloat16, &DeviceExtensions::vk_khr_shader_float16_int8}},
1616 {spv::CapabilityInt8, {"VkPhysicalDeviceFloat16Int8FeaturesKHR::shaderInt8", &VkPhysicalDeviceVulkan12Features::shaderInt8, &DeviceExtensions::vk_khr_shader_float16_int8}},
Jeff Bolze4356752019-03-07 11:23:46 -06001617
Jason Macnakd7fddf82019-06-13 09:52:49 -07001618 {spv::CapabilityImageFootprintNV, {"VkPhysicalDeviceShaderImageFootprintFeaturesNV::imageFootprint", &VkPhysicalDeviceShaderImageFootprintFeaturesNV::imageFootprint, &DeviceExtensions::vk_nv_shader_image_footprint}},
1619
Jeff Bolze4356752019-03-07 11:23:46 -06001620 {spv::CapabilityCooperativeMatrixNV, {"VkPhysicalDeviceCooperativeMatrixFeaturesNV::cooperativeMatrix", &VkPhysicalDeviceCooperativeMatrixFeaturesNV::cooperativeMatrix, &DeviceExtensions::vk_nv_cooperative_matrix}},
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00001621
Graeme Leese41e6b842019-08-02 10:49:14 +01001622 {spv::CapabilitySignedZeroInfNanPreserve, {"VkPhysicalDeviceFloatControlsPropertiesKHR::shaderSignedZeroInfNanPreserve", nullptr, &DeviceExtensions::vk_khr_shader_float_controls}},
1623 {spv::CapabilityDenormPreserve, {"VkPhysicalDeviceFloatControlsPropertiesKHR::shaderDenormPreserve", nullptr, &DeviceExtensions::vk_khr_shader_float_controls}},
1624 {spv::CapabilityDenormFlushToZero, {"VkPhysicalDeviceFloatControlsPropertiesKHR::shaderDenormFlushToZero", nullptr, &DeviceExtensions::vk_khr_shader_float_controls}},
1625 {spv::CapabilityRoundingModeRTE, {"VkPhysicalDeviceFloatControlsPropertiesKHR::shaderRoundingModeRTE", nullptr, &DeviceExtensions::vk_khr_shader_float_controls}},
1626 {spv::CapabilityRoundingModeRTZ, {"VkPhysicalDeviceFloatControlsPropertiesKHR::shaderRoundingModeRTZ", nullptr, &DeviceExtensions::vk_khr_shader_float_controls}},
Jeff Bolz38f6cb52019-06-30 16:26:44 -05001627
1628 {spv::CapabilityFragmentShaderSampleInterlockEXT, {"VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::fragmentShaderSampleInterlock", &VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::fragmentShaderSampleInterlock, &DeviceExtensions::vk_ext_fragment_shader_interlock}},
1629 {spv::CapabilityFragmentShaderPixelInterlockEXT, {"VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::fragmentShaderPixelInterlock", &VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::fragmentShaderPixelInterlock, &DeviceExtensions::vk_ext_fragment_shader_interlock}},
1630 {spv::CapabilityFragmentShaderShadingRateInterlockEXT, {"VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::fragmentShaderShadingRateInterlock", &VkPhysicalDeviceFragmentShaderInterlockFeaturesEXT::fragmentShaderShadingRateInterlock, &DeviceExtensions::vk_ext_fragment_shader_interlock}},
Jeff Bolza38fd3b2019-07-21 11:42:11 -05001631 {spv::CapabilityDemoteToHelperInvocationEXT, {"VkPhysicalDeviceShaderDemoteToHelperInvocationFeaturesEXT::shaderDemoteToHelperInvocation", &VkPhysicalDeviceShaderDemoteToHelperInvocationFeaturesEXT::shaderDemoteToHelperInvocation, &DeviceExtensions::vk_ext_shader_demote_to_helper_invocation}},
Jeff Bolz4563f2a2019-12-10 13:30:30 -06001632
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001633 {spv::CapabilityPhysicalStorageBufferAddresses, {"VkPhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddress", &VkPhysicalDeviceVulkan12Features::bufferDeviceAddress, &DeviceExtensions::vk_ext_buffer_device_address}},
Jeff Bolz4563f2a2019-12-10 13:30:30 -06001634 // Should be non-EXT token, but Android SPIRV-Headers are out of date, and the token value is the same anyway
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001635 {spv::CapabilityPhysicalStorageBufferAddressesEXT, {"VkPhysicalDeviceBufferDeviceAddressFeaturesEXT::bufferDeviceAddress", &VkPhysicalDeviceVulkan12Features::bufferDeviceAddress, &DeviceExtensions::vk_khr_buffer_device_address}},
Chris Forbes47567b72017-06-09 12:09:45 -07001636 };
1637 // clang-format on
1638
1639 for (auto insn : *src) {
1640 if (insn.opcode() == spv::OpCapability) {
Dave Houltoneb10ea82017-12-22 12:21:50 -07001641 size_t n = capabilities.count(insn.word(1));
1642 if (1 == n) { // key occurs exactly once
1643 auto it = capabilities.find(insn.word(1));
1644 if (it != capabilities.end()) {
1645 if (it->second.feature) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001646 skip |= RequireFeature(it->second.feature.IsEnabled(enabled_features), it->second.name);
Dave Houltoneb10ea82017-12-22 12:21:50 -07001647 }
1648 if (it->second.extension) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001649 skip |= RequireExtension(IsExtEnabled((device_extensions.*(it->second.extension))), it->second.name);
Dave Houltoneb10ea82017-12-22 12:21:50 -07001650 }
Chris Forbes47567b72017-06-09 12:09:45 -07001651 }
Dave Houltoneb10ea82017-12-22 12:21:50 -07001652 } else if (1 < n) { // key occurs multiple times, at least one must be enabled
1653 bool needs_feature = false, has_feature = false;
1654 bool needs_ext = false, has_ext = false;
1655 std::string feature_names = "(one of) [ ";
1656 std::string extension_names = feature_names;
1657 auto caps = capabilities.equal_range(insn.word(1));
1658 for (auto it = caps.first; it != caps.second; ++it) {
1659 if (it->second.feature) {
1660 needs_feature = true;
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001661 has_feature = has_feature || it->second.feature.IsEnabled(enabled_features);
Dave Houltoneb10ea82017-12-22 12:21:50 -07001662 feature_names += it->second.name;
1663 feature_names += " ";
1664 }
1665 if (it->second.extension) {
1666 needs_ext = true;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001667 has_ext = has_ext || device_extensions.*(it->second.extension);
Dave Houltoneb10ea82017-12-22 12:21:50 -07001668 extension_names += it->second.name;
1669 extension_names += " ";
1670 }
1671 }
1672 if (needs_feature) {
1673 feature_names += "]";
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001674 skip |= RequireFeature(has_feature, feature_names.c_str());
Dave Houltoneb10ea82017-12-22 12:21:50 -07001675 }
1676 if (needs_ext) {
1677 extension_names += "]";
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001678 skip |= RequireExtension(has_ext, extension_names.c_str());
Chris Forbes47567b72017-06-09 12:09:45 -07001679 }
Graeme Leesec82dbe02019-08-02 10:44:21 +01001680 }
1681
1682 { // Do group non-uniform checks
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001683 const VkSubgroupFeatureFlags supportedOperations = phys_dev_props_core11.subgroupSupportedOperations;
1684 const VkSubgroupFeatureFlags supportedStages = phys_dev_props_core11.subgroupSupportedStages;
Jeff Bolzee743412019-06-20 22:24:32 -05001685
1686 switch (insn.word(1)) {
1687 default:
1688 break;
1689 case spv::CapabilityGroupNonUniform:
1690 case spv::CapabilityGroupNonUniformVote:
1691 case spv::CapabilityGroupNonUniformArithmetic:
1692 case spv::CapabilityGroupNonUniformBallot:
1693 case spv::CapabilityGroupNonUniformShuffle:
1694 case spv::CapabilityGroupNonUniformShuffleRelative:
1695 case spv::CapabilityGroupNonUniformClustered:
1696 case spv::CapabilityGroupNonUniformQuad:
1697 case spv::CapabilityGroupNonUniformPartitionedNV:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001698 RequirePropertyFlag(supportedStages & stage, string_VkShaderStageFlagBits(stage),
Jeff Bolzee743412019-06-20 22:24:32 -05001699 "VkPhysicalDeviceSubgroupProperties::supportedStages");
1700 break;
1701 }
1702
1703 switch (insn.word(1)) {
1704 default:
1705 break;
1706 case spv::CapabilityGroupNonUniform:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001707 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_BASIC_BIT, "VK_SUBGROUP_FEATURE_BASIC_BIT",
Jeff Bolzee743412019-06-20 22:24:32 -05001708 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1709 break;
1710 case spv::CapabilityGroupNonUniformVote:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001711 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_VOTE_BIT, "VK_SUBGROUP_FEATURE_VOTE_BIT",
Jeff Bolzee743412019-06-20 22:24:32 -05001712 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1713 break;
1714 case spv::CapabilityGroupNonUniformArithmetic:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001715 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_ARITHMETIC_BIT,
Jeff Bolzee743412019-06-20 22:24:32 -05001716 "VK_SUBGROUP_FEATURE_ARITHMETIC_BIT",
1717 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1718 break;
1719 case spv::CapabilityGroupNonUniformBallot:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001720 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_BALLOT_BIT, "VK_SUBGROUP_FEATURE_BALLOT_BIT",
Jeff Bolzee743412019-06-20 22:24:32 -05001721 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1722 break;
1723 case spv::CapabilityGroupNonUniformShuffle:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001724 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_SHUFFLE_BIT,
Jeff Bolzee743412019-06-20 22:24:32 -05001725 "VK_SUBGROUP_FEATURE_SHUFFLE_BIT",
1726 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1727 break;
1728 case spv::CapabilityGroupNonUniformShuffleRelative:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001729 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_SHUFFLE_RELATIVE_BIT,
Jeff Bolzee743412019-06-20 22:24:32 -05001730 "VK_SUBGROUP_FEATURE_SHUFFLE_RELATIVE_BIT",
1731 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1732 break;
1733 case spv::CapabilityGroupNonUniformClustered:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001734 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_CLUSTERED_BIT,
Jeff Bolzee743412019-06-20 22:24:32 -05001735 "VK_SUBGROUP_FEATURE_CLUSTERED_BIT",
1736 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1737 break;
1738 case spv::CapabilityGroupNonUniformQuad:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001739 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_QUAD_BIT, "VK_SUBGROUP_FEATURE_QUAD_BIT",
Jeff Bolzee743412019-06-20 22:24:32 -05001740 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1741 break;
1742 case spv::CapabilityGroupNonUniformPartitionedNV:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001743 RequirePropertyFlag(supportedOperations & VK_SUBGROUP_FEATURE_PARTITIONED_BIT_NV,
Jeff Bolzee743412019-06-20 22:24:32 -05001744 "VK_SUBGROUP_FEATURE_PARTITIONED_BIT_NV",
1745 "VkPhysicalDeviceSubgroupProperties::supportedOperations");
1746 break;
1747 }
Chris Forbes47567b72017-06-09 12:09:45 -07001748 }
1749 }
1750 }
1751
Jeff Bolzee743412019-06-20 22:24:32 -05001752 return skip;
1753}
1754
John Zulaufac4c6e12019-07-01 16:05:58 -06001755bool CoreChecks::ValidateShaderStageWritableDescriptor(VkShaderStageFlagBits stage, bool has_writable_descriptor) const {
Jeff Bolzee743412019-06-20 22:24:32 -05001756 bool skip = false;
1757
Chris Forbes349b3132018-03-07 11:38:08 -08001758 if (has_writable_descriptor) {
1759 switch (stage) {
1760 case VK_SHADER_STAGE_COMPUTE_BIT:
Jeff Bolz148d94e2018-12-13 21:25:56 -06001761 case VK_SHADER_STAGE_RAYGEN_BIT_NV:
1762 case VK_SHADER_STAGE_ANY_HIT_BIT_NV:
1763 case VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV:
1764 case VK_SHADER_STAGE_MISS_BIT_NV:
1765 case VK_SHADER_STAGE_INTERSECTION_BIT_NV:
1766 case VK_SHADER_STAGE_CALLABLE_BIT_NV:
1767 case VK_SHADER_STAGE_TASK_BIT_NV:
1768 case VK_SHADER_STAGE_MESH_BIT_NV:
Chris Forbes349b3132018-03-07 11:38:08 -08001769 /* No feature requirements for writes and atomics from compute
Jeff Bolz148d94e2018-12-13 21:25:56 -06001770 * raytracing, or mesh stages */
Chris Forbes349b3132018-03-07 11:38:08 -08001771 break;
1772 case VK_SHADER_STAGE_FRAGMENT_BIT:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001773 skip |= RequireFeature(enabled_features.core.fragmentStoresAndAtomics, "fragmentStoresAndAtomics");
Chris Forbes349b3132018-03-07 11:38:08 -08001774 break;
1775 default:
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001776 skip |= RequireFeature(enabled_features.core.vertexPipelineStoresAndAtomics, "vertexPipelineStoresAndAtomics");
Chris Forbes349b3132018-03-07 11:38:08 -08001777 break;
1778 }
1779 }
1780
Chris Forbes47567b72017-06-09 12:09:45 -07001781 return skip;
1782}
1783
Jeff Bolz526f2d52019-09-18 13:18:08 -05001784bool CoreChecks::ValidateShaderStageGroupNonUniform(SHADER_MODULE_STATE const *module, VkShaderStageFlagBits stage) const {
Jeff Bolzee743412019-06-20 22:24:32 -05001785 bool skip = false;
1786
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001787 auto const subgroup_props = phys_dev_props_core11;
Jeff Bolzee743412019-06-20 22:24:32 -05001788
Jeff Bolz526f2d52019-09-18 13:18:08 -05001789 for (auto inst : *module) {
Jeff Bolzee743412019-06-20 22:24:32 -05001790 // Check the quad operations.
1791 switch (inst.opcode()) {
1792 default:
1793 break;
1794 case spv::OpGroupNonUniformQuadBroadcast:
1795 case spv::OpGroupNonUniformQuadSwap:
1796 if ((stage != VK_SHADER_STAGE_FRAGMENT_BIT) && (stage != VK_SHADER_STAGE_COMPUTE_BIT)) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001797 skip |= RequireFeature(subgroup_props.subgroupQuadOperationsInAllStages,
Jeff Bolzee743412019-06-20 22:24:32 -05001798 "VkPhysicalDeviceSubgroupProperties::quadOperationsInAllStages");
1799 }
1800 break;
1801 }
Jeff Bolz526f2d52019-09-18 13:18:08 -05001802
Piers Daniell41b8c5d2020-01-10 15:42:00 -07001803 if (!enabled_features.core12.shaderSubgroupExtendedTypes) {
Jeff Bolz526f2d52019-09-18 13:18:08 -05001804 switch (inst.opcode()) {
1805 default:
1806 break;
1807 case spv::OpGroupNonUniformAllEqual:
1808 case spv::OpGroupNonUniformBroadcast:
1809 case spv::OpGroupNonUniformBroadcastFirst:
1810 case spv::OpGroupNonUniformShuffle:
1811 case spv::OpGroupNonUniformShuffleXor:
1812 case spv::OpGroupNonUniformShuffleUp:
1813 case spv::OpGroupNonUniformShuffleDown:
1814 case spv::OpGroupNonUniformIAdd:
1815 case spv::OpGroupNonUniformFAdd:
1816 case spv::OpGroupNonUniformIMul:
1817 case spv::OpGroupNonUniformFMul:
1818 case spv::OpGroupNonUniformSMin:
1819 case spv::OpGroupNonUniformUMin:
1820 case spv::OpGroupNonUniformFMin:
1821 case spv::OpGroupNonUniformSMax:
1822 case spv::OpGroupNonUniformUMax:
1823 case spv::OpGroupNonUniformFMax:
1824 case spv::OpGroupNonUniformBitwiseAnd:
1825 case spv::OpGroupNonUniformBitwiseOr:
1826 case spv::OpGroupNonUniformBitwiseXor:
1827 case spv::OpGroupNonUniformLogicalAnd:
1828 case spv::OpGroupNonUniformLogicalOr:
1829 case spv::OpGroupNonUniformLogicalXor:
1830 case spv::OpGroupNonUniformQuadBroadcast:
1831 case spv::OpGroupNonUniformQuadSwap: {
1832 auto type = module->get_def(inst.word(1));
1833
1834 if (type.opcode() == spv::OpTypeVector) {
1835 // Get the element type
1836 type = module->get_def(type.word(2));
1837 }
1838
1839 if (type.opcode() == spv::OpTypeBool) {
1840 break;
1841 }
1842
1843 // Both OpTypeInt and OpTypeFloat the width is in the 2nd word.
1844 const uint32_t width = type.word(2);
1845
1846 if ((type.opcode() == spv::OpTypeFloat && width == 16) ||
1847 (type.opcode() == spv::OpTypeInt && (width == 8 || width == 16 || width == 64))) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07001848 skip |= RequireFeature(enabled_features.core12.shaderSubgroupExtendedTypes,
Tony-LunarGa74d3fe2019-11-22 15:43:20 -07001849 "VkPhysicalDeviceShaderSubgroupExtendedTypesFeatures::shaderSubgroupExtendedTypes");
Jeff Bolz526f2d52019-09-18 13:18:08 -05001850 }
1851 break;
1852 }
1853 }
1854 }
Jeff Bolzee743412019-06-20 22:24:32 -05001855 }
1856
1857 return skip;
1858}
1859
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06001860bool CoreChecks::ValidateShaderStageInputOutputLimits(SHADER_MODULE_STATE const *src, VkPipelineShaderStageCreateInfo const *pStage,
John Zulaufac4c6e12019-07-01 16:05:58 -06001861 const PIPELINE_STATE *pipeline, spirv_inst_iter entrypoint) const {
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001862 if (pStage->stage == VK_SHADER_STAGE_COMPUTE_BIT || pStage->stage == VK_SHADER_STAGE_ALL_GRAPHICS ||
1863 pStage->stage == VK_SHADER_STAGE_ALL) {
1864 return false;
1865 }
1866
1867 bool skip = false;
Mark Lobodzinski518eadc2019-03-09 12:07:30 -07001868 auto const &limits = phys_dev_props.limits;
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001869
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001870 std::set<uint32_t> patchIDs;
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001871 struct Variable {
1872 uint32_t baseTypePtrID;
1873 uint32_t ID;
1874 uint32_t storageClass;
1875 };
1876 std::vector<Variable> variables;
1877
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001878 uint32_t numVertices = 0;
1879
Jeff Bolzf234bf82019-11-04 14:07:15 -06001880 auto entrypointVariables = FindEntrypointInterfaces(entrypoint);
1881
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001882 for (auto insn : *src) {
1883 switch (insn.opcode()) {
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001884 // Find all Patch decorations
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001885 case spv::OpDecorate:
1886 switch (insn.word(2)) {
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001887 case spv::DecorationPatch: {
1888 patchIDs.insert(insn.word(1));
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001889 break;
1890 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001891 default:
1892 break;
1893 }
1894 break;
1895 // Find all input and output variables
1896 case spv::OpVariable: {
1897 Variable var = {};
1898 var.storageClass = insn.word(3);
Jeff Bolzf234bf82019-11-04 14:07:15 -06001899 if ((var.storageClass == spv::StorageClassInput || var.storageClass == spv::StorageClassOutput) &&
1900 // Only include variables in the entrypoint's interface
1901 find(entrypointVariables.begin(), entrypointVariables.end(), insn.word(2)) != entrypointVariables.end()) {
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001902 var.baseTypePtrID = insn.word(1);
1903 var.ID = insn.word(2);
1904 variables.push_back(var);
1905 }
1906 break;
1907 }
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001908 case spv::OpExecutionMode:
1909 if (insn.word(1) == entrypoint.word(2)) {
1910 switch (insn.word(2)) {
1911 default:
1912 break;
1913 case spv::ExecutionModeOutputVertices:
1914 numVertices = insn.word(3);
1915 break;
1916 }
1917 }
1918 break;
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001919 default:
1920 break;
1921 }
1922 }
1923
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001924 bool strip_output_array_level =
1925 (pStage->stage == VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT || pStage->stage == VK_SHADER_STAGE_MESH_BIT_NV);
1926 bool strip_input_array_level =
1927 (pStage->stage == VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT ||
1928 pStage->stage == VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT || pStage->stage == VK_SHADER_STAGE_GEOMETRY_BIT);
1929
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001930 uint32_t numCompIn = 0, numCompOut = 0;
Jeff Bolzf234bf82019-11-04 14:07:15 -06001931 int maxCompIn = 0, maxCompOut = 0;
1932
1933 auto inputs = CollectInterfaceByLocation(src, entrypoint, spv::StorageClassInput, strip_input_array_level);
1934 auto outputs = CollectInterfaceByLocation(src, entrypoint, spv::StorageClassOutput, strip_output_array_level);
1935
1936 // Find max component location used for input variables.
1937 for (auto &var : inputs) {
1938 int location = var.first.first;
1939 int component = var.first.second;
1940 interface_var &iv = var.second;
1941
1942 // Only need to look at the first location, since we use the type's whole size
1943 if (iv.offset != 0) {
1944 continue;
1945 }
1946
1947 if (iv.is_patch) {
1948 continue;
1949 }
1950
1951 int numComponents = GetComponentsConsumedByType(src, iv.type_id, strip_input_array_level);
1952 maxCompIn = std::max(maxCompIn, location * 4 + component + numComponents);
1953 }
1954
1955 // Find max component location used for output variables.
1956 for (auto &var : outputs) {
1957 int location = var.first.first;
1958 int component = var.first.second;
1959 interface_var &iv = var.second;
1960
1961 // Only need to look at the first location, since we use the type's whole size
1962 if (iv.offset != 0) {
1963 continue;
1964 }
1965
1966 if (iv.is_patch) {
1967 continue;
1968 }
1969
1970 int numComponents = GetComponentsConsumedByType(src, iv.type_id, strip_output_array_level);
1971 maxCompOut = std::max(maxCompOut, location * 4 + component + numComponents);
1972 }
1973
1974 // XXX TODO: Would be nice to rewrite this to use CollectInterfaceByLocation (or something similar),
1975 // but that doesn't include builtins.
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001976 for (auto &var : variables) {
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001977 // Check if the variable is a patch. Patches can also be members of blocks,
1978 // but if they are then the top-level arrayness has already been stripped
1979 // by the time GetComponentsConsumedByType gets to it.
1980 bool isPatch = patchIDs.find(var.ID) != patchIDs.end();
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001981
1982 if (var.storageClass == spv::StorageClassInput) {
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001983 numCompIn += GetComponentsConsumedByType(src, var.baseTypePtrID, strip_input_array_level && !isPatch);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001984 } else { // var.storageClass == spv::StorageClassOutput
Jeff Bolze9ee3d82019-05-29 13:45:13 -05001985 numCompOut += GetComponentsConsumedByType(src, var.baseTypePtrID, strip_output_array_level && !isPatch);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001986 }
1987 }
1988
1989 switch (pStage->stage) {
1990 case VK_SHADER_STAGE_VERTEX_BIT:
Mark Lobodzinski57a44272019-02-27 12:40:50 -07001991 if (numCompOut > limits.maxVertexOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001992 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
1993 "Invalid Pipeline CreateInfo State: Vertex shader exceeds "
1994 "VkPhysicalDeviceLimits::maxVertexOutputComponents of %u "
1995 "components by %u components",
1996 limits.maxVertexOutputComponents, numCompOut - limits.maxVertexOutputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02001997 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06001998 if (maxCompOut > (int)limits.maxVertexOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07001999 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2000 "Invalid Pipeline CreateInfo State: Vertex shader output variable uses location that "
2001 "exceeds component limit VkPhysicalDeviceLimits::maxVertexOutputComponents (%u)",
2002 limits.maxVertexOutputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002003 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002004 break;
2005
2006 case VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT:
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002007 if (numCompIn > limits.maxTessellationControlPerVertexInputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002008 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2009 "Invalid Pipeline CreateInfo State: Tessellation control shader exceeds "
2010 "VkPhysicalDeviceLimits::maxTessellationControlPerVertexInputComponents of %u "
2011 "components by %u components",
2012 limits.maxTessellationControlPerVertexInputComponents,
2013 numCompIn - limits.maxTessellationControlPerVertexInputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002014 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002015 if (maxCompIn > (int)limits.maxTessellationControlPerVertexInputComponents) {
2016 skip |=
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002017 LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2018 "Invalid Pipeline CreateInfo State: Tessellation control shader input variable uses location that "
2019 "exceeds component limit VkPhysicalDeviceLimits::maxTessellationControlPerVertexInputComponents (%u)",
2020 limits.maxTessellationControlPerVertexInputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002021 }
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002022 if (numCompOut > limits.maxTessellationControlPerVertexOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002023 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2024 "Invalid Pipeline CreateInfo State: Tessellation control shader exceeds "
2025 "VkPhysicalDeviceLimits::maxTessellationControlPerVertexOutputComponents of %u "
2026 "components by %u components",
2027 limits.maxTessellationControlPerVertexOutputComponents,
2028 numCompOut - limits.maxTessellationControlPerVertexOutputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002029 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002030 if (maxCompOut > (int)limits.maxTessellationControlPerVertexOutputComponents) {
2031 skip |=
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002032 LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2033 "Invalid Pipeline CreateInfo State: Tessellation control shader output variable uses location that "
2034 "exceeds component limit VkPhysicalDeviceLimits::maxTessellationControlPerVertexOutputComponents (%u)",
2035 limits.maxTessellationControlPerVertexOutputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002036 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002037 break;
2038
2039 case VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT:
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002040 if (numCompIn > limits.maxTessellationEvaluationInputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002041 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2042 "Invalid Pipeline CreateInfo State: Tessellation evaluation shader exceeds "
2043 "VkPhysicalDeviceLimits::maxTessellationEvaluationInputComponents of %u "
2044 "components by %u components",
2045 limits.maxTessellationEvaluationInputComponents,
2046 numCompIn - limits.maxTessellationEvaluationInputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002047 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002048 if (maxCompIn > (int)limits.maxTessellationEvaluationInputComponents) {
2049 skip |=
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002050 LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2051 "Invalid Pipeline CreateInfo State: Tessellation evaluation shader input variable uses location that "
2052 "exceeds component limit VkPhysicalDeviceLimits::maxTessellationEvaluationInputComponents (%u)",
2053 limits.maxTessellationEvaluationInputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002054 }
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002055 if (numCompOut > limits.maxTessellationEvaluationOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002056 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2057 "Invalid Pipeline CreateInfo State: Tessellation evaluation shader exceeds "
2058 "VkPhysicalDeviceLimits::maxTessellationEvaluationOutputComponents of %u "
2059 "components by %u components",
2060 limits.maxTessellationEvaluationOutputComponents,
2061 numCompOut - limits.maxTessellationEvaluationOutputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002062 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002063 if (maxCompOut > (int)limits.maxTessellationEvaluationOutputComponents) {
2064 skip |=
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002065 LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2066 "Invalid Pipeline CreateInfo State: Tessellation evaluation shader output variable uses location that "
2067 "exceeds component limit VkPhysicalDeviceLimits::maxTessellationEvaluationOutputComponents (%u)",
2068 limits.maxTessellationEvaluationOutputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002069 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002070 break;
2071
2072 case VK_SHADER_STAGE_GEOMETRY_BIT:
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002073 if (numCompIn > limits.maxGeometryInputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002074 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2075 "Invalid Pipeline CreateInfo State: Geometry shader exceeds "
2076 "VkPhysicalDeviceLimits::maxGeometryInputComponents of %u "
2077 "components by %u components",
2078 limits.maxGeometryInputComponents, numCompIn - limits.maxGeometryInputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002079 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002080 if (maxCompIn > (int)limits.maxGeometryInputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002081 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2082 "Invalid Pipeline CreateInfo State: Geometry shader input variable uses location that "
2083 "exceeds component limit VkPhysicalDeviceLimits::maxGeometryInputComponents (%u)",
2084 limits.maxGeometryInputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002085 }
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002086 if (numCompOut > limits.maxGeometryOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002087 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2088 "Invalid Pipeline CreateInfo State: Geometry shader exceeds "
2089 "VkPhysicalDeviceLimits::maxGeometryOutputComponents of %u "
2090 "components by %u components",
2091 limits.maxGeometryOutputComponents, numCompOut - limits.maxGeometryOutputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002092 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002093 if (maxCompOut > (int)limits.maxGeometryOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002094 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2095 "Invalid Pipeline CreateInfo State: Geometry shader output variable uses location that "
2096 "exceeds component limit VkPhysicalDeviceLimits::maxGeometryOutputComponents (%u)",
2097 limits.maxGeometryOutputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002098 }
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002099 if (numCompOut * numVertices > limits.maxGeometryTotalOutputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002100 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2101 "Invalid Pipeline CreateInfo State: Geometry shader exceeds "
2102 "VkPhysicalDeviceLimits::maxGeometryTotalOutputComponents of %u "
2103 "components by %u components",
2104 limits.maxGeometryTotalOutputComponents,
2105 numCompOut * numVertices - limits.maxGeometryTotalOutputComponents);
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002106 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002107 break;
2108
2109 case VK_SHADER_STAGE_FRAGMENT_BIT:
Mark Lobodzinski57a44272019-02-27 12:40:50 -07002110 if (numCompIn > limits.maxFragmentInputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002111 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2112 "Invalid Pipeline CreateInfo State: Fragment shader exceeds "
2113 "VkPhysicalDeviceLimits::maxFragmentInputComponents of %u "
2114 "components by %u components",
2115 limits.maxFragmentInputComponents, numCompIn - limits.maxFragmentInputComponents);
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002116 }
Jeff Bolzf234bf82019-11-04 14:07:15 -06002117 if (maxCompIn > (int)limits.maxFragmentInputComponents) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002118 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_ExceedDeviceLimit,
2119 "Invalid Pipeline CreateInfo State: Fragment shader input variable uses location that "
2120 "exceeds component limit VkPhysicalDeviceLimits::maxFragmentInputComponents (%u)",
2121 limits.maxFragmentInputComponents);
Jeff Bolzf234bf82019-11-04 14:07:15 -06002122 }
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002123 break;
2124
Jeff Bolz148d94e2018-12-13 21:25:56 -06002125 case VK_SHADER_STAGE_RAYGEN_BIT_NV:
2126 case VK_SHADER_STAGE_ANY_HIT_BIT_NV:
2127 case VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV:
2128 case VK_SHADER_STAGE_MISS_BIT_NV:
2129 case VK_SHADER_STAGE_INTERSECTION_BIT_NV:
2130 case VK_SHADER_STAGE_CALLABLE_BIT_NV:
2131 case VK_SHADER_STAGE_TASK_BIT_NV:
2132 case VK_SHADER_STAGE_MESH_BIT_NV:
2133 break;
2134
Daniel Fedai Larsenc939abc2018-08-07 10:01:58 +02002135 default:
2136 assert(false); // This should never happen
2137 }
2138 return skip;
2139}
2140
Jeff Bolze4356752019-03-07 11:23:46 -06002141// copy the specialization constant value into buf, if it is present
2142void GetSpecConstantValue(VkPipelineShaderStageCreateInfo const *pStage, uint32_t spec_id, void *buf) {
2143 VkSpecializationInfo const *spec = pStage->pSpecializationInfo;
2144
2145 if (spec && spec_id < spec->mapEntryCount) {
2146 memcpy(buf, (uint8_t *)spec->pData + spec->pMapEntries[spec_id].offset, spec->pMapEntries[spec_id].size);
2147 }
2148}
2149
2150// Fill in value with the constant or specialization constant value, if available.
2151// Returns true if the value has been accurately filled out.
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06002152static bool GetIntConstantValue(spirv_inst_iter insn, SHADER_MODULE_STATE const *src, VkPipelineShaderStageCreateInfo const *pStage,
Jeff Bolze4356752019-03-07 11:23:46 -06002153 const std::unordered_map<uint32_t, uint32_t> &id_to_spec_id, uint32_t *value) {
2154 auto type_id = src->get_def(insn.word(1));
2155 if (type_id.opcode() != spv::OpTypeInt || type_id.word(2) != 32) {
2156 return false;
2157 }
2158 switch (insn.opcode()) {
2159 case spv::OpSpecConstant:
2160 *value = insn.word(3);
2161 GetSpecConstantValue(pStage, id_to_spec_id.at(insn.word(2)), value);
2162 return true;
2163 case spv::OpConstant:
2164 *value = insn.word(3);
2165 return true;
2166 default:
2167 return false;
2168 }
2169}
2170
2171// Map SPIR-V type to VK_COMPONENT_TYPE enum
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06002172VkComponentTypeNV GetComponentType(spirv_inst_iter insn, SHADER_MODULE_STATE const *src) {
Jeff Bolze4356752019-03-07 11:23:46 -06002173 switch (insn.opcode()) {
2174 case spv::OpTypeInt:
2175 switch (insn.word(2)) {
2176 case 8:
2177 return insn.word(3) != 0 ? VK_COMPONENT_TYPE_SINT8_NV : VK_COMPONENT_TYPE_UINT8_NV;
2178 case 16:
2179 return insn.word(3) != 0 ? VK_COMPONENT_TYPE_SINT16_NV : VK_COMPONENT_TYPE_UINT16_NV;
2180 case 32:
2181 return insn.word(3) != 0 ? VK_COMPONENT_TYPE_SINT32_NV : VK_COMPONENT_TYPE_UINT32_NV;
2182 case 64:
2183 return insn.word(3) != 0 ? VK_COMPONENT_TYPE_SINT64_NV : VK_COMPONENT_TYPE_UINT64_NV;
2184 default:
2185 return VK_COMPONENT_TYPE_MAX_ENUM_NV;
2186 }
2187 case spv::OpTypeFloat:
2188 switch (insn.word(2)) {
2189 case 16:
2190 return VK_COMPONENT_TYPE_FLOAT16_NV;
2191 case 32:
2192 return VK_COMPONENT_TYPE_FLOAT32_NV;
2193 case 64:
2194 return VK_COMPONENT_TYPE_FLOAT64_NV;
2195 default:
2196 return VK_COMPONENT_TYPE_MAX_ENUM_NV;
2197 }
2198 default:
2199 return VK_COMPONENT_TYPE_MAX_ENUM_NV;
2200 }
2201}
2202
2203// Validate SPV_NV_cooperative_matrix behavior that can't be statically validated
2204// in SPIRV-Tools (e.g. due to specialization constant usage).
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06002205bool CoreChecks::ValidateCooperativeMatrix(SHADER_MODULE_STATE const *src, VkPipelineShaderStageCreateInfo const *pStage,
John Zulaufac4c6e12019-07-01 16:05:58 -06002206 const PIPELINE_STATE *pipeline) const {
Jeff Bolze4356752019-03-07 11:23:46 -06002207 bool skip = false;
2208
2209 // Map SPIR-V result ID to specialization constant id (SpecId decoration value)
2210 std::unordered_map<uint32_t, uint32_t> id_to_spec_id;
2211 // Map SPIR-V result ID to the ID of its type.
2212 std::unordered_map<uint32_t, uint32_t> id_to_type_id;
2213
2214 struct CoopMatType {
2215 uint32_t scope, rows, cols;
2216 VkComponentTypeNV component_type;
2217 bool all_constant;
2218
2219 CoopMatType() : scope(0), rows(0), cols(0), component_type(VK_COMPONENT_TYPE_MAX_ENUM_NV), all_constant(false) {}
2220
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06002221 void Init(uint32_t id, SHADER_MODULE_STATE const *src, VkPipelineShaderStageCreateInfo const *pStage,
Jeff Bolze4356752019-03-07 11:23:46 -06002222 const std::unordered_map<uint32_t, uint32_t> &id_to_spec_id) {
2223 spirv_inst_iter insn = src->get_def(id);
2224 uint32_t component_type_id = insn.word(2);
2225 uint32_t scope_id = insn.word(3);
2226 uint32_t rows_id = insn.word(4);
2227 uint32_t cols_id = insn.word(5);
2228 auto component_type_iter = src->get_def(component_type_id);
2229 auto scope_iter = src->get_def(scope_id);
2230 auto rows_iter = src->get_def(rows_id);
2231 auto cols_iter = src->get_def(cols_id);
2232
2233 all_constant = true;
2234 if (!GetIntConstantValue(scope_iter, src, pStage, id_to_spec_id, &scope)) {
2235 all_constant = false;
2236 }
2237 if (!GetIntConstantValue(rows_iter, src, pStage, id_to_spec_id, &rows)) {
2238 all_constant = false;
2239 }
2240 if (!GetIntConstantValue(cols_iter, src, pStage, id_to_spec_id, &cols)) {
2241 all_constant = false;
2242 }
2243 component_type = GetComponentType(component_type_iter, src);
2244 }
2245 };
2246
2247 bool seen_coopmat_capability = false;
2248
2249 for (auto insn : *src) {
2250 // Whitelist instructions whose result can be a cooperative matrix type, and
2251 // keep track of their types. It would be nice if SPIRV-Headers generated code
2252 // to identify which instructions have a result type and result id. Lacking that,
2253 // this whitelist is based on the set of instructions that
2254 // SPV_NV_cooperative_matrix says can be used with cooperative matrix types.
2255 switch (insn.opcode()) {
2256 case spv::OpLoad:
2257 case spv::OpCooperativeMatrixLoadNV:
2258 case spv::OpCooperativeMatrixMulAddNV:
2259 case spv::OpSNegate:
2260 case spv::OpFNegate:
2261 case spv::OpIAdd:
2262 case spv::OpFAdd:
2263 case spv::OpISub:
2264 case spv::OpFSub:
2265 case spv::OpFDiv:
2266 case spv::OpSDiv:
2267 case spv::OpUDiv:
2268 case spv::OpMatrixTimesScalar:
2269 case spv::OpConstantComposite:
2270 case spv::OpCompositeConstruct:
2271 case spv::OpConvertFToU:
2272 case spv::OpConvertFToS:
2273 case spv::OpConvertSToF:
2274 case spv::OpConvertUToF:
2275 case spv::OpUConvert:
2276 case spv::OpSConvert:
2277 case spv::OpFConvert:
2278 id_to_type_id[insn.word(2)] = insn.word(1);
2279 break;
2280 default:
2281 break;
2282 }
2283
2284 switch (insn.opcode()) {
2285 case spv::OpDecorate:
2286 if (insn.word(2) == spv::DecorationSpecId) {
2287 id_to_spec_id[insn.word(1)] = insn.word(3);
2288 }
2289 break;
2290 case spv::OpCapability:
2291 if (insn.word(1) == spv::CapabilityCooperativeMatrixNV) {
2292 seen_coopmat_capability = true;
2293
2294 if (!(pStage->stage & phys_dev_ext_props.cooperative_matrix_props.cooperativeMatrixSupportedStages)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002295 skip |= LogError(
2296 pipeline->pipeline, kVUID_Core_Shader_CooperativeMatrixSupportedStages,
2297 "OpTypeCooperativeMatrixNV used in shader stage not in cooperativeMatrixSupportedStages (= %u)",
2298 phys_dev_ext_props.cooperative_matrix_props.cooperativeMatrixSupportedStages);
Jeff Bolze4356752019-03-07 11:23:46 -06002299 }
2300 }
2301 break;
2302 case spv::OpMemoryModel:
2303 // If the capability isn't enabled, don't bother with the rest of this function.
2304 // OpMemoryModel is the first required instruction after all OpCapability instructions.
2305 if (!seen_coopmat_capability) {
2306 return skip;
2307 }
2308 break;
2309 case spv::OpTypeCooperativeMatrixNV: {
2310 CoopMatType M;
2311 M.Init(insn.word(1), src, pStage, id_to_spec_id);
2312
2313 if (M.all_constant) {
2314 // Validate that the type parameters are all supported for one of the
2315 // operands of a cooperative matrix property.
2316 bool valid = false;
2317 for (unsigned i = 0; i < cooperative_matrix_properties.size(); ++i) {
2318 if (cooperative_matrix_properties[i].AType == M.component_type &&
2319 cooperative_matrix_properties[i].MSize == M.rows && cooperative_matrix_properties[i].KSize == M.cols &&
2320 cooperative_matrix_properties[i].scope == M.scope) {
2321 valid = true;
2322 break;
2323 }
2324 if (cooperative_matrix_properties[i].BType == M.component_type &&
2325 cooperative_matrix_properties[i].KSize == M.rows && cooperative_matrix_properties[i].NSize == M.cols &&
2326 cooperative_matrix_properties[i].scope == M.scope) {
2327 valid = true;
2328 break;
2329 }
2330 if (cooperative_matrix_properties[i].CType == M.component_type &&
2331 cooperative_matrix_properties[i].MSize == M.rows && cooperative_matrix_properties[i].NSize == M.cols &&
2332 cooperative_matrix_properties[i].scope == M.scope) {
2333 valid = true;
2334 break;
2335 }
2336 if (cooperative_matrix_properties[i].DType == M.component_type &&
2337 cooperative_matrix_properties[i].MSize == M.rows && cooperative_matrix_properties[i].NSize == M.cols &&
2338 cooperative_matrix_properties[i].scope == M.scope) {
2339 valid = true;
2340 break;
2341 }
2342 }
2343 if (!valid) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002344 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_CooperativeMatrixType,
2345 "OpTypeCooperativeMatrixNV (result id = %u) operands don't match a supported matrix type",
2346 insn.word(1));
Jeff Bolze4356752019-03-07 11:23:46 -06002347 }
2348 }
2349 break;
2350 }
2351 case spv::OpCooperativeMatrixMulAddNV: {
2352 CoopMatType A, B, C, D;
2353 if (id_to_type_id.find(insn.word(2)) == id_to_type_id.end() ||
2354 id_to_type_id.find(insn.word(3)) == id_to_type_id.end() ||
2355 id_to_type_id.find(insn.word(4)) == id_to_type_id.end() ||
2356 id_to_type_id.find(insn.word(5)) == id_to_type_id.end()) {
Mike Schuchardte48dc142019-04-18 09:12:03 -07002357 // Couldn't find type of matrix
2358 assert(false);
Jeff Bolze4356752019-03-07 11:23:46 -06002359 break;
2360 }
2361 D.Init(id_to_type_id[insn.word(2)], src, pStage, id_to_spec_id);
2362 A.Init(id_to_type_id[insn.word(3)], src, pStage, id_to_spec_id);
2363 B.Init(id_to_type_id[insn.word(4)], src, pStage, id_to_spec_id);
2364 C.Init(id_to_type_id[insn.word(5)], src, pStage, id_to_spec_id);
2365
2366 if (A.all_constant && B.all_constant && C.all_constant && D.all_constant) {
2367 // Validate that the type parameters are all supported for the same
2368 // cooperative matrix property.
2369 bool valid = false;
2370 for (unsigned i = 0; i < cooperative_matrix_properties.size(); ++i) {
2371 if (cooperative_matrix_properties[i].AType == A.component_type &&
2372 cooperative_matrix_properties[i].MSize == A.rows && cooperative_matrix_properties[i].KSize == A.cols &&
2373 cooperative_matrix_properties[i].scope == A.scope &&
2374
2375 cooperative_matrix_properties[i].BType == B.component_type &&
2376 cooperative_matrix_properties[i].KSize == B.rows && cooperative_matrix_properties[i].NSize == B.cols &&
2377 cooperative_matrix_properties[i].scope == B.scope &&
2378
2379 cooperative_matrix_properties[i].CType == C.component_type &&
2380 cooperative_matrix_properties[i].MSize == C.rows && cooperative_matrix_properties[i].NSize == C.cols &&
2381 cooperative_matrix_properties[i].scope == C.scope &&
2382
2383 cooperative_matrix_properties[i].DType == D.component_type &&
2384 cooperative_matrix_properties[i].MSize == D.rows && cooperative_matrix_properties[i].NSize == D.cols &&
2385 cooperative_matrix_properties[i].scope == D.scope) {
2386 valid = true;
2387 break;
2388 }
2389 }
2390 if (!valid) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002391 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_CooperativeMatrixMulAdd,
2392 "OpCooperativeMatrixMulAddNV (result id = %u) operands don't match a supported matrix "
2393 "VkCooperativeMatrixPropertiesNV",
2394 insn.word(2));
Jeff Bolze4356752019-03-07 11:23:46 -06002395 }
2396 }
2397 break;
2398 }
2399 default:
2400 break;
2401 }
2402 }
2403
2404 return skip;
2405}
2406
John Zulaufac4c6e12019-07-01 16:05:58 -06002407bool CoreChecks::ValidateExecutionModes(SHADER_MODULE_STATE const *src, spirv_inst_iter entrypoint) const {
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002408 auto entrypoint_id = entrypoint.word(2);
2409
Attilio Provenzanof6c0e852019-04-09 11:01:18 +01002410 // The first denorm execution mode encountered, along with its bit width.
2411 // Used to check if SeparateDenormSettings is respected.
2412 std::pair<spv::ExecutionMode, uint32_t> first_denorm_execution_mode = std::make_pair(spv::ExecutionModeMax, 0);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002413
Attilio Provenzanof6c0e852019-04-09 11:01:18 +01002414 // The first rounding mode encountered, along with its bit width.
2415 // Used to check if SeparateRoundingModeSettings is respected.
2416 std::pair<spv::ExecutionMode, uint32_t> first_rounding_mode = std::make_pair(spv::ExecutionModeMax, 0);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002417
2418 bool skip = false;
2419
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002420 uint32_t verticesOut = 0;
2421 uint32_t invocations = 0;
2422
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002423 for (auto insn : *src) {
2424 if (insn.opcode() == spv::OpExecutionMode && insn.word(1) == entrypoint_id) {
2425 auto mode = insn.word(2);
2426 switch (mode) {
2427 case spv::ExecutionModeSignedZeroInfNanPreserve: {
2428 auto bit_width = insn.word(3);
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002429 if ((bit_width == 16 && !phys_dev_props_core12.shaderSignedZeroInfNanPreserveFloat16) ||
2430 (bit_width == 32 && !phys_dev_props_core12.shaderSignedZeroInfNanPreserveFloat32) ||
2431 (bit_width == 64 && !phys_dev_props_core12.shaderSignedZeroInfNanPreserveFloat64)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002432 skip |= LogError(
2433 device, kVUID_Core_Shader_FeatureNotEnabled,
2434 "Shader requires SignedZeroInfNanPreserve for bit width %d but it is not enabled on the device",
2435 bit_width);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002436 }
2437 break;
2438 }
2439
2440 case spv::ExecutionModeDenormPreserve: {
2441 auto bit_width = insn.word(3);
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002442 if ((bit_width == 16 && !phys_dev_props_core12.shaderDenormPreserveFloat16) ||
2443 (bit_width == 32 && !phys_dev_props_core12.shaderDenormPreserveFloat32) ||
2444 (bit_width == 64 && !phys_dev_props_core12.shaderDenormPreserveFloat64)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002445 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2446 "Shader requires DenormPreserve for bit width %d but it is not enabled on the device",
2447 bit_width);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002448 }
2449
Attilio Provenzanof6c0e852019-04-09 11:01:18 +01002450 if (first_denorm_execution_mode.first == spv::ExecutionModeMax) {
2451 // Register the first denorm execution mode found
2452 first_denorm_execution_mode = std::make_pair(static_cast<spv::ExecutionMode>(mode), bit_width);
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002453 } else if (first_denorm_execution_mode.first != mode && first_denorm_execution_mode.second != bit_width) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002454 switch (phys_dev_props_core12.denormBehaviorIndependence) {
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002455 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR:
2456 if (first_rounding_mode.second != 32 && bit_width != 32) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002457 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2458 "Shader uses different denorm execution modes for 16 and 64-bit but "
2459 "denormBehaviorIndependence is "
2460 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002461 }
2462 break;
2463
2464 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_ALL_KHR:
2465 break;
2466
2467 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR:
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002468 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2469 "Shader uses different denorm execution modes for different bit widths but "
2470 "denormBehaviorIndependence is "
2471 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002472 break;
2473
2474 default:
2475 break;
2476 }
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002477 }
2478 break;
2479 }
2480
2481 case spv::ExecutionModeDenormFlushToZero: {
2482 auto bit_width = insn.word(3);
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002483 if ((bit_width == 16 && !phys_dev_props_core12.shaderDenormFlushToZeroFloat16) ||
2484 (bit_width == 32 && !phys_dev_props_core12.shaderDenormFlushToZeroFloat32) ||
2485 (bit_width == 64 && !phys_dev_props_core12.shaderDenormFlushToZeroFloat64)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002486 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2487 "Shader requires DenormFlushToZero for bit width %d but it is not enabled on the device",
2488 bit_width);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002489 }
2490
Attilio Provenzanof6c0e852019-04-09 11:01:18 +01002491 if (first_denorm_execution_mode.first == spv::ExecutionModeMax) {
2492 // Register the first denorm execution mode found
2493 first_denorm_execution_mode = std::make_pair(static_cast<spv::ExecutionMode>(mode), bit_width);
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002494 } else if (first_denorm_execution_mode.first != mode && first_denorm_execution_mode.second != bit_width) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002495 switch (phys_dev_props_core12.denormBehaviorIndependence) {
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002496 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR:
2497 if (first_rounding_mode.second != 32 && bit_width != 32) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002498 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2499 "Shader uses different denorm execution modes for 16 and 64-bit but "
2500 "denormBehaviorIndependence is "
2501 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002502 }
2503 break;
2504
2505 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_ALL_KHR:
2506 break;
2507
2508 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR:
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002509 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2510 "Shader uses different denorm execution modes for different bit widths but "
2511 "denormBehaviorIndependence is "
2512 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002513 break;
2514
2515 default:
2516 break;
2517 }
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002518 }
2519 break;
2520 }
2521
2522 case spv::ExecutionModeRoundingModeRTE: {
2523 auto bit_width = insn.word(3);
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002524 if ((bit_width == 16 && !phys_dev_props_core12.shaderRoundingModeRTEFloat16) ||
2525 (bit_width == 32 && !phys_dev_props_core12.shaderRoundingModeRTEFloat32) ||
2526 (bit_width == 64 && !phys_dev_props_core12.shaderRoundingModeRTEFloat64)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002527 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2528 "Shader requires RoundingModeRTE for bit width %d but it is not enabled on the device",
2529 bit_width);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002530 }
2531
Attilio Provenzanof6c0e852019-04-09 11:01:18 +01002532 if (first_rounding_mode.first == spv::ExecutionModeMax) {
2533 // Register the first rounding mode found
2534 first_rounding_mode = std::make_pair(static_cast<spv::ExecutionMode>(mode), bit_width);
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002535 } else if (first_rounding_mode.first != mode && first_rounding_mode.second != bit_width) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002536 switch (phys_dev_props_core12.roundingModeIndependence) {
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002537 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR:
2538 if (first_rounding_mode.second != 32 && bit_width != 32) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002539 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2540 "Shader uses different rounding modes for 16 and 64-bit but "
2541 "roundingModeIndependence is "
2542 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002543 }
2544 break;
2545
2546 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_ALL_KHR:
2547 break;
2548
2549 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR:
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002550 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2551 "Shader uses different rounding modes for different bit widths but "
2552 "roundingModeIndependence is "
2553 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002554 break;
2555
2556 default:
2557 break;
2558 }
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002559 }
2560 break;
2561 }
2562
2563 case spv::ExecutionModeRoundingModeRTZ: {
2564 auto bit_width = insn.word(3);
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002565 if ((bit_width == 16 && !phys_dev_props_core12.shaderRoundingModeRTZFloat16) ||
2566 (bit_width == 32 && !phys_dev_props_core12.shaderRoundingModeRTZFloat32) ||
2567 (bit_width == 64 && !phys_dev_props_core12.shaderRoundingModeRTZFloat64)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002568 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2569 "Shader requires RoundingModeRTZ for bit width %d but it is not enabled on the device",
2570 bit_width);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002571 }
2572
Attilio Provenzanof6c0e852019-04-09 11:01:18 +01002573 if (first_rounding_mode.first == spv::ExecutionModeMax) {
2574 // Register the first rounding mode found
2575 first_rounding_mode = std::make_pair(static_cast<spv::ExecutionMode>(mode), bit_width);
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002576 } else if (first_rounding_mode.first != mode && first_rounding_mode.second != bit_width) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002577 switch (phys_dev_props_core12.roundingModeIndependence) {
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002578 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR:
2579 if (first_rounding_mode.second != 32 && bit_width != 32) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002580 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2581 "Shader uses different rounding modes for 16 and 64-bit but "
2582 "roundingModeIndependence is "
2583 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002584 }
2585 break;
2586
2587 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_ALL_KHR:
2588 break;
2589
2590 case VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR:
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002591 skip |= LogError(device, kVUID_Core_Shader_FeatureNotEnabled,
2592 "Shader uses different rounding modes for different bit widths but "
2593 "roundingModeIndependence is "
2594 "VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_NONE_KHR on the device");
Jason Ekstrande1e06de2019-08-05 11:43:43 -05002595 break;
2596
2597 default:
2598 break;
2599 }
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002600 }
2601 break;
2602 }
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002603
2604 case spv::ExecutionModeOutputVertices: {
2605 verticesOut = insn.word(3);
2606 break;
2607 }
2608
2609 case spv::ExecutionModeInvocations: {
2610 invocations = insn.word(3);
2611 break;
2612 }
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002613 }
2614 }
2615 }
2616
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002617 if (entrypoint.word(1) == spv::ExecutionModelGeometry) {
2618 if (verticesOut == 0 || verticesOut > phys_dev_props.limits.maxGeometryOutputVertices) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002619 skip |= LogError(device, "VUID-VkPipelineShaderStageCreateInfo-stage-00714",
2620 "Geometry shader entry point must have an OpExecutionMode instruction that "
2621 "specifies a maximum output vertex count that is greater than 0 and less "
2622 "than or equal to maxGeometryOutputVertices. "
2623 "OutputVertices=%d, maxGeometryOutputVertices=%d",
2624 verticesOut, phys_dev_props.limits.maxGeometryOutputVertices);
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002625 }
2626
2627 if (invocations == 0 || invocations > phys_dev_props.limits.maxGeometryShaderInvocations) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002628 skip |= LogError(device, "VUID-VkPipelineShaderStageCreateInfo-stage-00715",
2629 "Geometry shader entry point must have an OpExecutionMode instruction that "
2630 "specifies an invocation count that is greater than 0 and less "
2631 "than or equal to maxGeometryShaderInvocations. "
2632 "Invocations=%d, maxGeometryShaderInvocations=%d",
2633 invocations, phys_dev_props.limits.maxGeometryShaderInvocations);
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002634 }
2635 }
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002636 return skip;
2637}
2638
locke-lunargd9a069d2019-09-17 01:50:19 -06002639uint32_t DescriptorTypeToReqs(SHADER_MODULE_STATE const *module, uint32_t type_id) {
Chris Forbes47567b72017-06-09 12:09:45 -07002640 auto type = module->get_def(type_id);
2641
2642 while (true) {
2643 switch (type.opcode()) {
2644 case spv::OpTypeArray:
Chris Forbes062f1222018-08-21 15:34:15 -07002645 case spv::OpTypeRuntimeArray:
Chris Forbes47567b72017-06-09 12:09:45 -07002646 case spv::OpTypeSampledImage:
2647 type = module->get_def(type.word(2));
2648 break;
2649 case spv::OpTypePointer:
2650 type = module->get_def(type.word(3));
2651 break;
2652 case spv::OpTypeImage: {
2653 auto dim = type.word(3);
2654 auto arrayed = type.word(5);
2655 auto msaa = type.word(6);
2656
Chris Forbes74ba2232018-08-27 15:19:27 -07002657 uint32_t bits = 0;
2658 switch (GetFundamentalType(module, type.word(2))) {
2659 case FORMAT_TYPE_FLOAT:
2660 bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
2661 break;
2662 case FORMAT_TYPE_UINT:
2663 bits = DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
2664 break;
2665 case FORMAT_TYPE_SINT:
2666 bits = DESCRIPTOR_REQ_COMPONENT_TYPE_SINT;
2667 break;
2668 default:
2669 break;
2670 }
2671
Chris Forbes47567b72017-06-09 12:09:45 -07002672 switch (dim) {
2673 case spv::Dim1D:
Chris Forbes74ba2232018-08-27 15:19:27 -07002674 bits |= arrayed ? DESCRIPTOR_REQ_VIEW_TYPE_1D_ARRAY : DESCRIPTOR_REQ_VIEW_TYPE_1D;
2675 return bits;
Chris Forbes47567b72017-06-09 12:09:45 -07002676 case spv::Dim2D:
Chris Forbes74ba2232018-08-27 15:19:27 -07002677 bits |= msaa ? DESCRIPTOR_REQ_MULTI_SAMPLE : DESCRIPTOR_REQ_SINGLE_SAMPLE;
2678 bits |= arrayed ? DESCRIPTOR_REQ_VIEW_TYPE_2D_ARRAY : DESCRIPTOR_REQ_VIEW_TYPE_2D;
2679 return bits;
Chris Forbes47567b72017-06-09 12:09:45 -07002680 case spv::Dim3D:
Chris Forbes74ba2232018-08-27 15:19:27 -07002681 bits |= DESCRIPTOR_REQ_VIEW_TYPE_3D;
2682 return bits;
Chris Forbes47567b72017-06-09 12:09:45 -07002683 case spv::DimCube:
Chris Forbes74ba2232018-08-27 15:19:27 -07002684 bits |= arrayed ? DESCRIPTOR_REQ_VIEW_TYPE_CUBE_ARRAY : DESCRIPTOR_REQ_VIEW_TYPE_CUBE;
2685 return bits;
Chris Forbes47567b72017-06-09 12:09:45 -07002686 case spv::DimSubpassData:
Chris Forbes74ba2232018-08-27 15:19:27 -07002687 bits |= msaa ? DESCRIPTOR_REQ_MULTI_SAMPLE : DESCRIPTOR_REQ_SINGLE_SAMPLE;
2688 return bits;
Chris Forbes47567b72017-06-09 12:09:45 -07002689 default: // buffer, etc.
Chris Forbes74ba2232018-08-27 15:19:27 -07002690 return bits;
Chris Forbes47567b72017-06-09 12:09:45 -07002691 }
2692 }
2693 default:
2694 return 0;
2695 }
2696 }
2697}
2698
2699// For given pipelineLayout verify that the set_layout_node at slot.first
2700// has the requested binding at slot.second and return ptr to that binding
Mark Lobodzinskica6ebe32019-04-25 11:43:37 -06002701static VkDescriptorSetLayoutBinding const *GetDescriptorBinding(PIPELINE_LAYOUT_STATE const *pipelineLayout,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002702 descriptor_slot_t slot) {
Chris Forbes47567b72017-06-09 12:09:45 -07002703 if (!pipelineLayout) return nullptr;
2704
2705 if (slot.first >= pipelineLayout->set_layouts.size()) return nullptr;
2706
2707 return pipelineLayout->set_layouts[slot.first]->GetDescriptorSetLayoutBindingPtrFromBinding(slot.second);
2708}
2709
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06002710static bool FindLocalSize(SHADER_MODULE_STATE const *src, uint32_t &local_size_x, uint32_t &local_size_y, uint32_t &local_size_z) {
Locke1ec6d952019-04-02 11:57:21 -06002711 for (auto insn : *src) {
2712 if (insn.opcode() == spv::OpEntryPoint) {
2713 auto executionModel = insn.word(1);
2714 auto entrypointStageBits = ExecutionModelToShaderStageFlagBits(executionModel);
2715 if (entrypointStageBits == VK_SHADER_STAGE_COMPUTE_BIT) {
2716 auto entrypoint_id = insn.word(2);
2717 for (auto insn1 : *src) {
2718 if (insn1.opcode() == spv::OpExecutionMode && insn1.word(1) == entrypoint_id &&
2719 insn1.word(2) == spv::ExecutionModeLocalSize) {
2720 local_size_x = insn1.word(3);
2721 local_size_y = insn1.word(4);
2722 local_size_z = insn1.word(5);
2723 return true;
2724 }
2725 }
2726 }
2727 }
2728 }
2729 return false;
2730}
2731
locke-lunargd9a069d2019-09-17 01:50:19 -06002732void ProcessExecutionModes(SHADER_MODULE_STATE const *src, const spirv_inst_iter &entrypoint, PIPELINE_STATE *pipeline) {
Jeff Bolz105d6492018-09-29 15:46:44 -05002733 auto entrypoint_id = entrypoint.word(2);
Chris Forbes0771b672018-03-22 21:13:46 -07002734 bool is_point_mode = false;
2735
2736 for (auto insn : *src) {
2737 if (insn.opcode() == spv::OpExecutionMode && insn.word(1) == entrypoint_id) {
2738 switch (insn.word(2)) {
2739 case spv::ExecutionModePointMode:
2740 // In tessellation shaders, PointMode is separate and trumps the tessellation topology.
2741 is_point_mode = true;
2742 break;
2743
2744 case spv::ExecutionModeOutputPoints:
2745 pipeline->topology_at_rasterizer = VK_PRIMITIVE_TOPOLOGY_POINT_LIST;
2746 break;
2747
2748 case spv::ExecutionModeIsolines:
2749 case spv::ExecutionModeOutputLineStrip:
2750 pipeline->topology_at_rasterizer = VK_PRIMITIVE_TOPOLOGY_LINE_STRIP;
2751 break;
2752
2753 case spv::ExecutionModeTriangles:
2754 case spv::ExecutionModeQuads:
2755 case spv::ExecutionModeOutputTriangleStrip:
2756 pipeline->topology_at_rasterizer = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP;
2757 break;
2758 }
2759 }
2760 }
2761
2762 if (is_point_mode) pipeline->topology_at_rasterizer = VK_PRIMITIVE_TOPOLOGY_POINT_LIST;
2763}
2764
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06002765// If PointList topology is specified in the pipeline, verify that a shader geometry stage writes PointSize
2766// o If there is only a vertex shader : gl_PointSize must be written when using points
2767// o If there is a geometry or tessellation shader:
2768// - If shaderTessellationAndGeometryPointSize feature is enabled:
2769// * gl_PointSize must be written in the final geometry stage
2770// - If shaderTessellationAndGeometryPointSize feature is disabled:
2771// * gl_PointSize must NOT be written and a default of 1.0 is assumed
Mark Lobodzinski3c59d972019-04-25 11:28:14 -06002772bool CoreChecks::ValidatePointListShaderState(const PIPELINE_STATE *pipeline, SHADER_MODULE_STATE const *src,
John Zulaufac4c6e12019-07-01 16:05:58 -06002773 spirv_inst_iter entrypoint, VkShaderStageFlagBits stage) const {
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06002774 if (pipeline->topology_at_rasterizer != VK_PRIMITIVE_TOPOLOGY_POINT_LIST) {
2775 return false;
2776 }
2777
2778 bool pointsize_written = false;
2779 bool skip = false;
2780
2781 // Search for PointSize built-in decorations
2782 std::vector<uint32_t> pointsize_builtin_offsets;
2783 spirv_inst_iter insn = entrypoint;
2784 while (!pointsize_written && (insn.opcode() != spv::OpFunction)) {
2785 if (insn.opcode() == spv::OpMemberDecorate) {
2786 if (insn.word(3) == spv::DecorationBuiltIn) {
2787 if (insn.word(4) == spv::BuiltInPointSize) {
2788 pointsize_written = IsPointSizeWritten(src, insn, entrypoint);
2789 }
2790 }
2791 } else if (insn.opcode() == spv::OpDecorate) {
2792 if (insn.word(2) == spv::DecorationBuiltIn) {
2793 if (insn.word(3) == spv::BuiltInPointSize) {
2794 pointsize_written = IsPointSizeWritten(src, insn, entrypoint);
2795 }
2796 }
2797 }
2798
2799 insn++;
2800 }
2801
2802 if ((stage == VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT || stage == VK_SHADER_STAGE_GEOMETRY_BIT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06002803 !enabled_features.core.shaderTessellationAndGeometryPointSize) {
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06002804 if (pointsize_written) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002805 skip |= LogError(pipeline->pipeline, kVUID_Core_Shader_PointSizeBuiltInOverSpecified,
2806 "Pipeline topology is set to POINT_LIST and geometry or tessellation shaders write PointSize which "
2807 "is prohibited when the shaderTessellationAndGeometryPointSize feature is not enabled.");
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06002808 }
2809 } else if (!pointsize_written) {
2810 skip |=
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002811 LogError(pipeline->pipeline, kVUID_Core_Shader_MissingPointSizeBuiltIn,
2812 "Pipeline topology is set to POINT_LIST, but PointSize is not written to in the shader corresponding to %s.",
2813 string_VkShaderStageFlagBits(stage));
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06002814 }
2815 return skip;
2816}
John Zulauf14c355b2019-06-27 16:09:37 -06002817
2818bool CoreChecks::ValidatePipelineShaderStage(VkPipelineShaderStageCreateInfo const *pStage, const PIPELINE_STATE *pipeline,
2819 const PIPELINE_STATE::StageState &stage_state, const SHADER_MODULE_STATE *module,
John Zulaufac4c6e12019-07-01 16:05:58 -06002820 const spirv_inst_iter &entrypoint, bool check_point_size) const {
John Zulauf14c355b2019-06-27 16:09:37 -06002821 bool skip = false;
2822
2823 // Check the module
2824 if (!module->has_valid_spirv) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002825 skip |= LogError(device, "VUID-VkPipelineShaderStageCreateInfo-module-parameter",
2826 "%s does not contain valid spirv for stage %s.",
2827 report_data->FormatHandle(module->vk_shader_module).c_str(), string_VkShaderStageFlagBits(pStage->stage));
John Zulauf14c355b2019-06-27 16:09:37 -06002828 }
2829
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002830 // If specialization-constant values are given and specialization-constant instructions are present in the shader, the
2831 // specializations should be applied and validated.
2832 if (pStage->pSpecializationInfo != nullptr && pStage->pSpecializationInfo->mapEntryCount > 0 &&
2833 pStage->pSpecializationInfo->pMapEntries != nullptr && module->has_specialization_constants) {
2834 // Gather the specialization-constant values.
2835 auto const &specialization_info = pStage->pSpecializationInfo;
Jeremy Hayes521221d2020-01-15 16:48:49 -07002836 auto const &specialization_data = reinterpret_cast<uint8_t const *>(specialization_info->pData);
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002837 std::unordered_map<uint32_t, std::vector<uint32_t>> id_value_map;
2838 id_value_map.reserve(specialization_info->mapEntryCount);
2839 for (auto i = 0u; i < specialization_info->mapEntryCount; ++i) {
2840 auto const &map_entry = specialization_info->pMapEntries[i];
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002841
Jeremy Hayes521221d2020-01-15 16:48:49 -07002842 // Expect only scalar types.
2843 assert(map_entry.size == 1 || map_entry.size == 2 || map_entry.size == 4 || map_entry.size == 8);
2844 auto entry = id_value_map.emplace(map_entry.constantID, std::vector<uint32_t>(map_entry.size > 4 ? 2 : 1));
2845 memcpy(entry.first->second.data(), specialization_data + map_entry.offset, map_entry.size);
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002846 }
2847
2848 // Apply the specialization-constant values and revalidate the shader module.
Tony-LunarG1a9cd5a2020-02-03 15:59:57 -07002849 spv_target_env spirv_environment;
2850 if (api_version >= VK_API_VERSION_1_2)
2851 spirv_environment = SPV_ENV_VULKAN_1_2;
2852 else if (api_version >= VK_API_VERSION_1_1)
2853 spirv_environment = SPV_ENV_VULKAN_1_1;
2854 else
2855 spirv_environment = SPV_ENV_VULKAN_1_0;
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002856 spvtools::Optimizer optimizer(spirv_environment);
2857 spvtools::MessageConsumer consumer = [&skip, &module, &pStage, this](spv_message_level_t level, const char *source,
2858 const spv_position_t &position, const char *message) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002859 skip |= LogError(
2860 device, "VUID-VkPipelineShaderStageCreateInfo-module-parameter", "%s does not contain valid spirv for stage %s. %s",
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002861 report_data->FormatHandle(module->vk_shader_module).c_str(), string_VkShaderStageFlagBits(pStage->stage), message);
2862 };
2863 optimizer.SetMessageConsumer(consumer);
2864 optimizer.RegisterPass(spvtools::CreateSetSpecConstantDefaultValuePass(id_value_map));
2865 optimizer.RegisterPass(spvtools::CreateFreezeSpecConstantValuePass());
2866 std::vector<uint32_t> specialized_spirv;
2867 auto const optimized =
2868 optimizer.Run(module->words.data(), module->words.size(), &specialized_spirv, spvtools::ValidatorOptions(), true);
2869 assert(optimized == true);
2870
2871 if (optimized) {
2872 spv_context ctx = spvContextCreate(spirv_environment);
2873 spv_const_binary_t binary{specialized_spirv.data(), specialized_spirv.size()};
2874 spv_diagnostic diag = nullptr;
2875 spv_validator_options options = spvValidatorOptionsCreate();
2876 if (device_extensions.vk_khr_relaxed_block_layout) {
2877 spvValidatorOptionsSetRelaxBlockLayout(options, true);
2878 }
2879 if (device_extensions.vk_khr_uniform_buffer_standard_layout &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002880 enabled_features.core12.uniformBufferStandardLayout == VK_TRUE) {
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002881 spvValidatorOptionsSetUniformBufferStandardLayout(options, true);
2882 }
Piers Daniell41b8c5d2020-01-10 15:42:00 -07002883 if (device_extensions.vk_ext_scalar_block_layout && enabled_features.core12.scalarBlockLayout == VK_TRUE) {
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002884 spvValidatorOptionsSetScalarBlockLayout(options, true);
2885 }
2886 auto const spv_valid = spvValidateWithOptions(ctx, options, &binary, &diag);
2887 if (spv_valid != SPV_SUCCESS) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002888 skip |= LogError(device, "VUID-VkPipelineShaderStageCreateInfo-module-parameter",
2889 "After specialization was applied, %s does not contain valid spirv for stage %s.",
2890 report_data->FormatHandle(module->vk_shader_module).c_str(),
2891 string_VkShaderStageFlagBits(pStage->stage));
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06002892 }
2893
2894 spvValidatorOptionsDestroy(options);
2895 spvDiagnosticDestroy(diag);
2896 spvContextDestroy(ctx);
2897 }
2898 }
2899
John Zulauf14c355b2019-06-27 16:09:37 -06002900 // Check the entrypoint
2901 if (entrypoint == module->end()) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002902 skip |=
2903 LogError(device, "VUID-VkPipelineShaderStageCreateInfo-pName-00707", "No entrypoint found named `%s` for stage %s..",
2904 pStage->pName, string_VkShaderStageFlagBits(pStage->stage));
John Zulauf14c355b2019-06-27 16:09:37 -06002905 }
2906 if (skip) return true; // no point continuing beyond here, any analysis is just going to be garbage.
2907
2908 // Mark accessible ids
2909 auto &accessible_ids = stage_state.accessible_ids;
2910
Chris Forbes47567b72017-06-09 12:09:45 -07002911 // Validate descriptor set layout against what the entrypoint actually uses
John Zulauf14c355b2019-06-27 16:09:37 -06002912 bool has_writable_descriptor = stage_state.has_writable_descriptor;
2913 auto &descriptor_uses = stage_state.descriptor_uses;
Chris Forbes47567b72017-06-09 12:09:45 -07002914
Chris Forbes349b3132018-03-07 11:38:08 -08002915 // Validate shader capabilities against enabled device features
Jeff Bolzee743412019-06-20 22:24:32 -05002916 skip |= ValidateShaderCapabilities(module, pStage->stage);
2917 skip |= ValidateShaderStageWritableDescriptor(pStage->stage, has_writable_descriptor);
Jeff Bolze9ee3d82019-05-29 13:45:13 -05002918 skip |= ValidateShaderStageInputOutputLimits(module, pStage, pipeline, entrypoint);
Jeff Bolz526f2d52019-09-18 13:18:08 -05002919 skip |= ValidateShaderStageGroupNonUniform(module, pStage->stage);
Attilio Provenzanoc5d50102019-03-25 17:40:37 +00002920 skip |= ValidateExecutionModes(module, entrypoint);
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07002921 skip |= ValidateSpecializationOffsets(pStage);
2922 skip |= ValidatePushConstantUsage(pipeline->pipeline_layout->push_constant_ranges.get(), module, accessible_ids, pStage->stage);
Jeff Bolze54ae892018-09-08 12:16:29 -05002923 if (check_point_size && !pipeline->graphicsPipelineCI.pRasterizationState->rasterizerDiscardEnable) {
Mark Lobodzinski518eadc2019-03-09 12:07:30 -07002924 skip |= ValidatePointListShaderState(pipeline, module, entrypoint, pStage->stage);
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06002925 }
Jeff Bolze4356752019-03-07 11:23:46 -06002926 skip |= ValidateCooperativeMatrix(module, pStage, pipeline);
Chris Forbes47567b72017-06-09 12:09:45 -07002927
2928 // Validate descriptor use
2929 for (auto use : descriptor_uses) {
Chris Forbes47567b72017-06-09 12:09:45 -07002930 // Verify given pipelineLayout has requested setLayout with requested binding
Jeff Bolze7fc67b2019-10-04 12:29:31 -05002931 const auto &binding = GetDescriptorBinding(pipeline->pipeline_layout.get(), use.first);
Chris Forbes47567b72017-06-09 12:09:45 -07002932 unsigned required_descriptor_count;
Jeff Bolze54ae892018-09-08 12:16:29 -05002933 std::set<uint32_t> descriptor_types = TypeToDescriptorTypeSet(module, use.second.type_id, required_descriptor_count);
Chris Forbes47567b72017-06-09 12:09:45 -07002934
2935 if (!binding) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002936 skip |= LogError(device, kVUID_Core_Shader_MissingDescriptor,
2937 "Shader uses descriptor slot %u.%u (expected `%s`) but not declared in pipeline layout",
2938 use.first.first, use.first.second, string_descriptorTypes(descriptor_types).c_str());
Chris Forbes47567b72017-06-09 12:09:45 -07002939 } else if (~binding->stageFlags & pStage->stage) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002940 skip |= LogError(device, kVUID_Core_Shader_DescriptorNotAccessibleFromStage,
2941 "Shader uses descriptor slot %u.%u but descriptor not accessible from stage %s", use.first.first,
2942 use.first.second, string_VkShaderStageFlagBits(pStage->stage));
Jeff Bolze54ae892018-09-08 12:16:29 -05002943 } else if (descriptor_types.find(binding->descriptorType) == descriptor_types.end()) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002944 skip |= LogError(device, kVUID_Core_Shader_DescriptorTypeMismatch,
2945 "Type mismatch on descriptor slot %u.%u (expected `%s`) but descriptor of type %s", use.first.first,
2946 use.first.second, string_descriptorTypes(descriptor_types).c_str(),
2947 string_VkDescriptorType(binding->descriptorType));
Chris Forbes47567b72017-06-09 12:09:45 -07002948 } else if (binding->descriptorCount < required_descriptor_count) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002949 skip |= LogError(device, kVUID_Core_Shader_DescriptorTypeMismatch,
2950 "Shader expects at least %u descriptors for binding %u.%u but only %u provided",
2951 required_descriptor_count, use.first.first, use.first.second, binding->descriptorCount);
Chris Forbes47567b72017-06-09 12:09:45 -07002952 }
2953 }
2954
2955 // Validate use of input attachments against subpass structure
2956 if (pStage->stage == VK_SHADER_STAGE_FRAGMENT_BIT) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002957 auto input_attachment_uses = CollectInterfaceByInputAttachmentIndex(module, accessible_ids);
Chris Forbes47567b72017-06-09 12:09:45 -07002958
Petr Krause91f7a12017-12-14 20:57:36 +01002959 auto rpci = pipeline->rp_state->createInfo.ptr();
Chris Forbes47567b72017-06-09 12:09:45 -07002960 auto subpass = pipeline->graphicsPipelineCI.subpass;
2961
2962 for (auto use : input_attachment_uses) {
2963 auto input_attachments = rpci->pSubpasses[subpass].pInputAttachments;
2964 auto index = (input_attachments && use.first < rpci->pSubpasses[subpass].inputAttachmentCount)
Dave Houltona9df0ce2018-02-07 10:51:23 -07002965 ? input_attachments[use.first].attachment
2966 : VK_ATTACHMENT_UNUSED;
Chris Forbes47567b72017-06-09 12:09:45 -07002967
2968 if (index == VK_ATTACHMENT_UNUSED) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002969 skip |= LogError(device, kVUID_Core_Shader_MissingInputAttachment,
2970 "Shader consumes input attachment index %d but not provided in subpass", use.first);
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002971 } else if (!(GetFormatType(rpci->pAttachments[index].format) & GetFundamentalType(module, use.second.type_id))) {
Chris Forbes47567b72017-06-09 12:09:45 -07002972 skip |=
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07002973 LogError(device, kVUID_Core_Shader_InputAttachmentTypeMismatch,
2974 "Subpass input attachment %u format of %s does not match type used in shader `%s`", use.first,
2975 string_VkFormat(rpci->pAttachments[index].format), DescribeType(module, use.second.type_id).c_str());
Chris Forbes47567b72017-06-09 12:09:45 -07002976 }
2977 }
2978 }
Lockeaa8fdc02019-04-02 11:59:20 -06002979 if (pStage->stage == VK_SHADER_STAGE_COMPUTE_BIT) {
2980 skip |= ValidateComputeWorkGroupSizes(module);
2981 }
Chris Forbes47567b72017-06-09 12:09:45 -07002982 return skip;
2983}
2984
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07002985bool CoreChecks::ValidateInterfaceBetweenStages(SHADER_MODULE_STATE const *producer, spirv_inst_iter producer_entrypoint,
2986 shader_stage_attributes const *producer_stage, SHADER_MODULE_STATE const *consumer,
2987 spirv_inst_iter consumer_entrypoint,
2988 shader_stage_attributes const *consumer_stage) const {
Chris Forbes47567b72017-06-09 12:09:45 -07002989 bool skip = false;
2990
2991 auto outputs =
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002992 CollectInterfaceByLocation(producer, producer_entrypoint, spv::StorageClassOutput, producer_stage->arrayed_output);
2993 auto inputs = CollectInterfaceByLocation(consumer, consumer_entrypoint, spv::StorageClassInput, consumer_stage->arrayed_input);
Chris Forbes47567b72017-06-09 12:09:45 -07002994
2995 auto a_it = outputs.begin();
2996 auto b_it = inputs.begin();
2997
2998 // Maps sorted by key (location); walk them together to find mismatches
2999 while ((outputs.size() > 0 && a_it != outputs.end()) || (inputs.size() && b_it != inputs.end())) {
3000 bool a_at_end = outputs.size() == 0 || a_it == outputs.end();
3001 bool b_at_end = inputs.size() == 0 || b_it == inputs.end();
3002 auto a_first = a_at_end ? std::make_pair(0u, 0u) : a_it->first;
3003 auto b_first = b_at_end ? std::make_pair(0u, 0u) : b_it->first;
3004
3005 if (b_at_end || ((!a_at_end) && (a_first < b_first))) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003006 skip |= LogPerformanceWarning(producer->vk_shader_module, kVUID_Core_Shader_OutputNotConsumed,
3007 "%s writes to output location %u.%u which is not consumed by %s", producer_stage->name,
3008 a_first.first, a_first.second, consumer_stage->name);
Chris Forbes47567b72017-06-09 12:09:45 -07003009 a_it++;
3010 } else if (a_at_end || a_first > b_first) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003011 skip |= LogError(consumer->vk_shader_module, kVUID_Core_Shader_InputNotProduced,
3012 "%s consumes input location %u.%u which is not written by %s", consumer_stage->name, b_first.first,
3013 b_first.second, producer_stage->name);
Chris Forbes47567b72017-06-09 12:09:45 -07003014 b_it++;
3015 } else {
3016 // subtleties of arrayed interfaces:
3017 // - if is_patch, then the member is not arrayed, even though the interface may be.
3018 // - if is_block_member, then the extra array level of an arrayed interface is not
3019 // expressed in the member type -- it's expressed in the block type.
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003020 if (!TypesMatch(producer, consumer, a_it->second.type_id, b_it->second.type_id,
3021 producer_stage->arrayed_output && !a_it->second.is_patch && !a_it->second.is_block_member,
3022 consumer_stage->arrayed_input && !b_it->second.is_patch && !b_it->second.is_block_member, true)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003023 skip |= LogError(producer->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
3024 "Type mismatch on location %u.%u: '%s' vs '%s'", a_first.first, a_first.second,
3025 DescribeType(producer, a_it->second.type_id).c_str(),
3026 DescribeType(consumer, b_it->second.type_id).c_str());
Chris Forbes47567b72017-06-09 12:09:45 -07003027 }
3028 if (a_it->second.is_patch != b_it->second.is_patch) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003029 skip |= LogError(producer->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
3030 "Decoration mismatch on location %u.%u: is per-%s in %s stage but per-%s in %s stage",
3031 a_first.first, a_first.second, a_it->second.is_patch ? "patch" : "vertex", producer_stage->name,
3032 b_it->second.is_patch ? "patch" : "vertex", consumer_stage->name);
Chris Forbes47567b72017-06-09 12:09:45 -07003033 }
3034 if (a_it->second.is_relaxed_precision != b_it->second.is_relaxed_precision) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003035 skip |= LogError(producer->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
3036 "Decoration mismatch on location %u.%u: %s and %s stages differ in precision", a_first.first,
3037 a_first.second, producer_stage->name, consumer_stage->name);
Chris Forbes47567b72017-06-09 12:09:45 -07003038 }
3039 a_it++;
3040 b_it++;
3041 }
3042 }
3043
Ari Suonpaa696b3432019-03-11 14:02:57 +02003044 if (consumer_stage->stage != VK_SHADER_STAGE_FRAGMENT_BIT) {
3045 auto builtins_producer = CollectBuiltinBlockMembers(producer, producer_entrypoint, spv::StorageClassOutput);
3046 auto builtins_consumer = CollectBuiltinBlockMembers(consumer, consumer_entrypoint, spv::StorageClassInput);
3047
3048 if (!builtins_producer.empty() && !builtins_consumer.empty()) {
3049 if (builtins_producer.size() != builtins_consumer.size()) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003050 skip |= LogError(producer->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
3051 "Number of elements inside builtin block differ between stages (%s %d vs %s %d).",
3052 producer_stage->name, (int)builtins_producer.size(), consumer_stage->name,
3053 (int)builtins_consumer.size());
Ari Suonpaa696b3432019-03-11 14:02:57 +02003054 } else {
3055 auto it_producer = builtins_producer.begin();
3056 auto it_consumer = builtins_consumer.begin();
3057 while (it_producer != builtins_producer.end() && it_consumer != builtins_consumer.end()) {
3058 if (*it_producer != *it_consumer) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003059 skip |= LogError(producer->vk_shader_module, kVUID_Core_Shader_InterfaceTypeMismatch,
3060 "Builtin variable inside block doesn't match between %s and %s.", producer_stage->name,
3061 consumer_stage->name);
Ari Suonpaa696b3432019-03-11 14:02:57 +02003062 break;
3063 }
3064 it_producer++;
3065 it_consumer++;
3066 }
3067 }
3068 }
3069 }
3070
Chris Forbes47567b72017-06-09 12:09:45 -07003071 return skip;
3072}
3073
John Zulauf14c355b2019-06-27 16:09:37 -06003074static inline uint32_t DetermineFinalGeomStage(const PIPELINE_STATE *pipeline, const VkGraphicsPipelineCreateInfo *pCreateInfo) {
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06003075 uint32_t stage_mask = 0;
3076 if (pipeline->topology_at_rasterizer == VK_PRIMITIVE_TOPOLOGY_POINT_LIST) {
3077 for (uint32_t i = 0; i < pCreateInfo->stageCount; i++) {
3078 stage_mask |= pCreateInfo->pStages[i].stage;
3079 }
3080 // Determine which shader in which PointSize should be written (the final geometry stage)
Jeff Bolz105d6492018-09-29 15:46:44 -05003081 if (stage_mask & VK_SHADER_STAGE_MESH_BIT_NV) {
3082 stage_mask = VK_SHADER_STAGE_MESH_BIT_NV;
3083 } else if (stage_mask & VK_SHADER_STAGE_GEOMETRY_BIT) {
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06003084 stage_mask = VK_SHADER_STAGE_GEOMETRY_BIT;
3085 } else if (stage_mask & VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT) {
3086 stage_mask = VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT;
3087 } else if (stage_mask & VK_SHADER_STAGE_VERTEX_BIT) {
3088 stage_mask = VK_SHADER_STAGE_VERTEX_BIT;
Mark Lobodzinski2c984cc2018-07-31 09:57:46 -06003089 }
3090 }
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06003091 return stage_mask;
Mark Lobodzinski2c984cc2018-07-31 09:57:46 -06003092}
3093
Chris Forbes47567b72017-06-09 12:09:45 -07003094// Validate that the shaders used by the given pipeline and store the active_slots
3095// that are actually used by the pipeline into pPipeline->active_slots
John Zulaufac4c6e12019-07-01 16:05:58 -06003096bool CoreChecks::ValidateGraphicsPipelineShaderState(const PIPELINE_STATE *pipeline) const {
Chris Forbesa400a8a2017-07-20 13:10:24 -07003097 auto pCreateInfo = pipeline->graphicsPipelineCI.ptr();
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003098 int vertex_stage = GetShaderStageId(VK_SHADER_STAGE_VERTEX_BIT);
3099 int fragment_stage = GetShaderStageId(VK_SHADER_STAGE_FRAGMENT_BIT);
Chris Forbes47567b72017-06-09 12:09:45 -07003100
John Zulauf14c355b2019-06-27 16:09:37 -06003101 const SHADER_MODULE_STATE *shaders[32];
Chris Forbes47567b72017-06-09 12:09:45 -07003102 memset(shaders, 0, sizeof(shaders));
Jeff Bolz7e35c392018-09-04 15:30:41 -05003103 spirv_inst_iter entrypoints[32];
Chris Forbes47567b72017-06-09 12:09:45 -07003104 memset(entrypoints, 0, sizeof(entrypoints));
3105 bool skip = false;
3106
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06003107 uint32_t pointlist_stage_mask = DetermineFinalGeomStage(pipeline, pCreateInfo);
3108
Chris Forbes47567b72017-06-09 12:09:45 -07003109 for (uint32_t i = 0; i < pCreateInfo->stageCount; i++) {
3110 auto pStage = &pCreateInfo->pStages[i];
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003111 auto stage_id = GetShaderStageId(pStage->stage);
John Zulauf14c355b2019-06-27 16:09:37 -06003112 shaders[stage_id] = GetShaderModuleState(pStage->module);
3113 entrypoints[stage_id] = FindEntrypoint(shaders[stage_id], pStage->pName, pStage->stage);
3114 skip |= ValidatePipelineShaderStage(pStage, pipeline, pipeline->stage_state[i], shaders[stage_id], entrypoints[stage_id],
Mark Lobodzinski1b4a8ed2018-08-07 08:47:05 -06003115 (pointlist_stage_mask == pStage->stage));
Chris Forbes47567b72017-06-09 12:09:45 -07003116 }
3117
3118 // if the shader stages are no good individually, cross-stage validation is pointless.
3119 if (skip) return true;
3120
3121 auto vi = pCreateInfo->pVertexInputState;
3122
3123 if (vi) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07003124 skip |= ValidateViConsistency(vi);
Chris Forbes47567b72017-06-09 12:09:45 -07003125 }
3126
3127 if (shaders[vertex_stage] && shaders[vertex_stage]->has_valid_spirv) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07003128 skip |= ValidateViAgainstVsInputs(vi, shaders[vertex_stage], entrypoints[vertex_stage]);
Chris Forbes47567b72017-06-09 12:09:45 -07003129 }
3130
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003131 int producer = GetShaderStageId(VK_SHADER_STAGE_VERTEX_BIT);
3132 int consumer = GetShaderStageId(VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT);
Chris Forbes47567b72017-06-09 12:09:45 -07003133
3134 while (!shaders[producer] && producer != fragment_stage) {
3135 producer++;
3136 consumer++;
3137 }
3138
3139 for (; producer != fragment_stage && consumer <= fragment_stage; consumer++) {
3140 assert(shaders[producer]);
Chris Forbesdbb43fc2018-02-16 16:59:23 -08003141 if (shaders[consumer]) {
3142 if (shaders[consumer]->has_valid_spirv && shaders[producer]->has_valid_spirv) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07003143 skip |= ValidateInterfaceBetweenStages(shaders[producer], entrypoints[producer], &shader_stage_attribs[producer],
3144 shaders[consumer], entrypoints[consumer], &shader_stage_attribs[consumer]);
Chris Forbesdbb43fc2018-02-16 16:59:23 -08003145 }
Chris Forbes47567b72017-06-09 12:09:45 -07003146
3147 producer = consumer;
3148 }
3149 }
3150
3151 if (shaders[fragment_stage] && shaders[fragment_stage]->has_valid_spirv) {
Mark Lobodzinskid8d658e2020-01-30 15:05:51 -07003152 skip |= ValidateFsOutputsAgainstRenderPass(shaders[fragment_stage], entrypoints[fragment_stage], pipeline,
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003153 pCreateInfo->subpass);
Chris Forbes47567b72017-06-09 12:09:45 -07003154 }
3155
3156 return skip;
3157}
3158
John Zulaufac4c6e12019-07-01 16:05:58 -06003159bool CoreChecks::ValidateComputePipeline(PIPELINE_STATE *pipeline) const {
John Zulauf14c355b2019-06-27 16:09:37 -06003160 const auto &stage = *pipeline->computePipelineCI.stage.ptr();
Chris Forbes47567b72017-06-09 12:09:45 -07003161
John Zulauf14c355b2019-06-27 16:09:37 -06003162 const SHADER_MODULE_STATE *module = GetShaderModuleState(stage.module);
3163 const spirv_inst_iter entrypoint = FindEntrypoint(module, stage.pName, stage.stage);
Chris Forbes47567b72017-06-09 12:09:45 -07003164
John Zulauf14c355b2019-06-27 16:09:37 -06003165 return ValidatePipelineShaderStage(&stage, pipeline, pipeline->stage_state[0], module, entrypoint, false);
Chris Forbes47567b72017-06-09 12:09:45 -07003166}
Chris Forbes4ae55b32017-06-09 14:42:56 -07003167
John Zulaufac4c6e12019-07-01 16:05:58 -06003168bool CoreChecks::ValidateRayTracingPipelineNV(PIPELINE_STATE *pipeline) const {
John Zulaufe4474e72019-07-01 17:28:27 -06003169 bool skip = false;
Jason Macnak15f95e82019-08-21 21:52:02 -04003170
3171 if (pipeline->raytracingPipelineCI.maxRecursionDepth > phys_dev_ext_props.ray_tracing_props.maxRecursionDepth) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003172 skip |= LogError(device, "VUID-VkRayTracingPipelineCreateInfoNV-maxRecursionDepth-02412", ": %d > %d",
3173 pipeline->raytracingPipelineCI.maxRecursionDepth, phys_dev_ext_props.ray_tracing_props.maxRecursionDepth);
Jason Macnak15f95e82019-08-21 21:52:02 -04003174 }
3175
3176 const auto *stages = pipeline->raytracingPipelineCI.ptr()->pStages;
3177 const auto *groups = pipeline->raytracingPipelineCI.ptr()->pGroups;
3178
3179 uint32_t raygen_stages_found = 0;
John Zulaufe4474e72019-07-01 17:28:27 -06003180 for (uint32_t stage_index = 0; stage_index < pipeline->raytracingPipelineCI.stageCount; stage_index++) {
Jason Macnak15f95e82019-08-21 21:52:02 -04003181 const auto &stage = stages[stage_index];
Jeff Bolzfbe51582018-09-13 10:01:35 -05003182
John Zulaufe4474e72019-07-01 17:28:27 -06003183 const SHADER_MODULE_STATE *module = GetShaderModuleState(stage.module);
3184 const spirv_inst_iter entrypoint = FindEntrypoint(module, stage.pName, stage.stage);
Jeff Bolzfbe51582018-09-13 10:01:35 -05003185
John Zulaufe4474e72019-07-01 17:28:27 -06003186 skip |= ValidatePipelineShaderStage(&stage, pipeline, pipeline->stage_state[stage_index], module, entrypoint, false);
Jason Macnak15f95e82019-08-21 21:52:02 -04003187
3188 if (stage.stage == VK_SHADER_STAGE_RAYGEN_BIT_NV) {
3189 raygen_stages_found++;
3190 }
3191 }
3192 if (raygen_stages_found != 1) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003193 skip |= LogError(device, "VUID-VkRayTracingPipelineCreateInfoNV-stage-02408", " : %d raygen stages specified",
3194 raygen_stages_found);
Jason Macnak15f95e82019-08-21 21:52:02 -04003195 }
3196
3197 for (uint32_t group_index = 0; group_index < pipeline->raytracingPipelineCI.groupCount; group_index++) {
3198 const auto &group = groups[group_index];
3199
3200 if (group.type == VK_RAY_TRACING_SHADER_GROUP_TYPE_GENERAL_NV) {
3201 if (group.generalShader >= pipeline->raytracingPipelineCI.stageCount ||
3202 (stages[group.generalShader].stage != VK_SHADER_STAGE_RAYGEN_BIT_NV &&
3203 stages[group.generalShader].stage != VK_SHADER_STAGE_MISS_BIT_NV &&
3204 stages[group.generalShader].stage != VK_SHADER_STAGE_CALLABLE_BIT_NV)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003205 skip |= LogError(device, "VUID-VkRayTracingShaderGroupCreateInfoNV-type-02413", ": pGroups[%d]", group_index);
Jason Macnak15f95e82019-08-21 21:52:02 -04003206 }
3207 if (group.anyHitShader != VK_SHADER_UNUSED_NV || group.closestHitShader != VK_SHADER_UNUSED_NV ||
3208 group.intersectionShader != VK_SHADER_UNUSED_NV) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003209 skip |= LogError(device, "VUID-VkRayTracingShaderGroupCreateInfoNV-type-02414", ": pGroups[%d]", group_index);
Jason Macnak15f95e82019-08-21 21:52:02 -04003210 }
3211 } else if (group.type == VK_RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV) {
3212 if (group.intersectionShader >= pipeline->raytracingPipelineCI.stageCount ||
3213 stages[group.intersectionShader].stage != VK_SHADER_STAGE_INTERSECTION_BIT_NV) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003214 skip |= LogError(device, "VUID-VkRayTracingShaderGroupCreateInfoNV-type-02415", ": pGroups[%d]", group_index);
Jason Macnak15f95e82019-08-21 21:52:02 -04003215 }
3216 } else if (group.type == VK_RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV) {
3217 if (group.intersectionShader != VK_SHADER_UNUSED_NV) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003218 skip |= LogError(device, "VUID-VkRayTracingShaderGroupCreateInfoNV-type-02416", ": pGroups[%d]", group_index);
Jason Macnak15f95e82019-08-21 21:52:02 -04003219 }
3220 }
3221
3222 if (group.type == VK_RAY_TRACING_SHADER_GROUP_TYPE_PROCEDURAL_HIT_GROUP_NV ||
3223 group.type == VK_RAY_TRACING_SHADER_GROUP_TYPE_TRIANGLES_HIT_GROUP_NV) {
3224 if (group.anyHitShader != VK_SHADER_UNUSED_NV && (group.anyHitShader >= pipeline->raytracingPipelineCI.stageCount ||
3225 stages[group.anyHitShader].stage != VK_SHADER_STAGE_ANY_HIT_BIT_NV)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003226 skip |=
3227 LogError(device, "VUID-VkRayTracingShaderGroupCreateInfoNV-anyHitShader-02418", ": pGroups[%d]", group_index);
Jason Macnak15f95e82019-08-21 21:52:02 -04003228 }
3229 if (group.closestHitShader != VK_SHADER_UNUSED_NV &&
3230 (group.closestHitShader >= pipeline->raytracingPipelineCI.stageCount ||
3231 stages[group.closestHitShader].stage != VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003232 skip |= LogError(device, "VUID-VkRayTracingShaderGroupCreateInfoNV-closestHitShader-02417", ": pGroups[%d]",
3233 group_index);
Jason Macnak15f95e82019-08-21 21:52:02 -04003234 }
3235 }
John Zulaufe4474e72019-07-01 17:28:27 -06003236 }
3237 return skip;
Jeff Bolzfbe51582018-09-13 10:01:35 -05003238}
3239
Dave Houltona9df0ce2018-02-07 10:51:23 -07003240uint32_t ValidationCache::MakeShaderHash(VkShaderModuleCreateInfo const *smci) { return XXH32(smci->pCode, smci->codeSize, 0); }
Chris Forbes9a61e082017-07-24 15:35:29 -07003241
Dave Houltona9df0ce2018-02-07 10:51:23 -07003242static ValidationCache *GetValidationCacheInfo(VkShaderModuleCreateInfo const *pCreateInfo) {
John Zulauf25ea2432019-04-05 10:07:38 -06003243 const auto validation_cache_ci = lvl_find_in_chain<VkShaderModuleValidationCacheCreateInfoEXT>(pCreateInfo->pNext);
3244 if (validation_cache_ci) {
John Zulauf146ee802019-04-05 15:31:06 -06003245 return CastFromHandle<ValidationCache *>(validation_cache_ci->validationCache);
Chris Forbes9a61e082017-07-24 15:35:29 -07003246 }
Chris Forbes9a61e082017-07-24 15:35:29 -07003247 return nullptr;
3248}
3249
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003250bool CoreChecks::PreCallValidateCreateShaderModule(VkDevice device, const VkShaderModuleCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003251 const VkAllocationCallbacks *pAllocator, VkShaderModule *pShaderModule) const {
Chris Forbes4ae55b32017-06-09 14:42:56 -07003252 bool skip = false;
3253 spv_result_t spv_valid = SPV_SUCCESS;
Chris Forbes4ae55b32017-06-09 14:42:56 -07003254
Mark Lobodzinskib02a4852019-04-19 12:35:30 -06003255 if (disabled.shader_validation) {
Chris Forbes4ae55b32017-06-09 14:42:56 -07003256 return false;
3257 }
3258
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003259 auto have_glsl_shader = device_extensions.vk_nv_glsl_shader;
Chris Forbes4ae55b32017-06-09 14:42:56 -07003260
3261 if (!have_glsl_shader && (pCreateInfo->codeSize % 4)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003262 skip |= LogError(device, "VUID-VkShaderModuleCreateInfo-pCode-01376",
3263 "SPIR-V module not valid: Codesize must be a multiple of 4 but is " PRINTF_SIZE_T_SPECIFIER ".",
3264 pCreateInfo->codeSize);
Chris Forbes4ae55b32017-06-09 14:42:56 -07003265 } else {
Chris Forbes9a61e082017-07-24 15:35:29 -07003266 auto cache = GetValidationCacheInfo(pCreateInfo);
3267 uint32_t hash = 0;
3268 if (cache) {
3269 hash = ValidationCache::MakeShaderHash(pCreateInfo);
Dave Houltona9df0ce2018-02-07 10:51:23 -07003270 if (cache->Contains(hash)) return false;
Chris Forbes9a61e082017-07-24 15:35:29 -07003271 }
3272
Jeremy Hayesb3e4d532019-08-16 10:08:49 -06003273 // Use SPIRV-Tools validator to try and catch any issues with the module itself. If specialization constants are present,
3274 // the default values will be used during validation.
Jeremy Hayes0be25de2019-09-11 18:13:49 -06003275 spv_target_env spirv_environment = SPV_ENV_VULKAN_1_0;
Tony-LunarG034e63a2020-01-16 13:39:24 -07003276 if (api_version >= VK_API_VERSION_1_2) {
3277 spirv_environment = SPV_ENV_VULKAN_1_2;
3278 } else if (api_version >= VK_API_VERSION_1_1) {
Jesse Halla0389fc2019-09-25 16:46:21 -05003279 if (device_extensions.vk_khr_spirv_1_4) {
3280 spirv_environment = SPV_ENV_VULKAN_1_1_SPIRV_1_4;
3281 } else {
3282 spirv_environment = SPV_ENV_VULKAN_1_1;
3283 }
Jeremy Hayes0be25de2019-09-11 18:13:49 -06003284 }
Dave Houlton0ea2d012018-06-21 14:00:26 -06003285 spv_context ctx = spvContextCreate(spirv_environment);
Dave Houltona9df0ce2018-02-07 10:51:23 -07003286 spv_const_binary_t binary{pCreateInfo->pCode, pCreateInfo->codeSize / sizeof(uint32_t)};
Chris Forbes4ae55b32017-06-09 14:42:56 -07003287 spv_diagnostic diag = nullptr;
Karl Schultzfda1b382018-08-08 18:56:11 -06003288 spv_validator_options options = spvValidatorOptionsCreate();
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003289 if (device_extensions.vk_khr_relaxed_block_layout) {
Karl Schultzfda1b382018-08-08 18:56:11 -06003290 spvValidatorOptionsSetRelaxBlockLayout(options, true);
3291 }
Graeme Leese9b6a1522019-06-07 20:49:45 +01003292 if (device_extensions.vk_khr_uniform_buffer_standard_layout &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003293 enabled_features.core12.uniformBufferStandardLayout == VK_TRUE) {
Graeme Leese9b6a1522019-06-07 20:49:45 +01003294 spvValidatorOptionsSetUniformBufferStandardLayout(options, true);
3295 }
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003296 if (device_extensions.vk_ext_scalar_block_layout && enabled_features.core12.scalarBlockLayout == VK_TRUE) {
Tobias Hector6a0ece72018-12-10 12:24:05 +00003297 spvValidatorOptionsSetScalarBlockLayout(options, true);
3298 }
Karl Schultzfda1b382018-08-08 18:56:11 -06003299 spv_valid = spvValidateWithOptions(ctx, options, &binary, &diag);
Chris Forbes4ae55b32017-06-09 14:42:56 -07003300 if (spv_valid != SPV_SUCCESS) {
3301 if (!have_glsl_shader || (pCreateInfo->pCode[0] == spv::MagicNumber)) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003302 if (spv_valid == SPV_WARNING) {
3303 skip |= LogWarning(device, kVUID_Core_Shader_InconsistentSpirv, "SPIR-V module not valid: %s",
3304 diag && diag->error ? diag->error : "(no error text)");
3305 } else {
3306 skip |= LogError(device, kVUID_Core_Shader_InconsistentSpirv, "SPIR-V module not valid: %s",
3307 diag && diag->error ? diag->error : "(no error text)");
3308 }
Chris Forbes4ae55b32017-06-09 14:42:56 -07003309 }
Chris Forbes9a61e082017-07-24 15:35:29 -07003310 } else {
3311 if (cache) {
3312 cache->Insert(hash);
3313 }
Chris Forbes4ae55b32017-06-09 14:42:56 -07003314 }
3315
Karl Schultzfda1b382018-08-08 18:56:11 -06003316 spvValidatorOptionsDestroy(options);
Chris Forbes4ae55b32017-06-09 14:42:56 -07003317 spvDiagnosticDestroy(diag);
3318 spvContextDestroy(ctx);
3319 }
3320
Chris Forbes4ae55b32017-06-09 14:42:56 -07003321 return skip;
Mark Lobodzinski01734072019-02-13 17:39:15 -07003322}
3323
John Zulaufac4c6e12019-07-01 16:05:58 -06003324bool CoreChecks::ValidateComputeWorkGroupSizes(const SHADER_MODULE_STATE *shader) const {
Lockeaa8fdc02019-04-02 11:59:20 -06003325 bool skip = false;
3326 uint32_t local_size_x = 0;
3327 uint32_t local_size_y = 0;
3328 uint32_t local_size_z = 0;
3329 if (FindLocalSize(shader, local_size_x, local_size_y, local_size_z)) {
3330 if (local_size_x > phys_dev_props.limits.maxComputeWorkGroupSize[0]) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003331 skip |= LogError(shader->vk_shader_module, "UNASSIGNED-features-limits-maxComputeWorkGroupSize",
3332 "%s local_size_x (%" PRIu32 ") exceeds device limit maxComputeWorkGroupSize[0] (%" PRIu32 ").",
3333 report_data->FormatHandle(shader->vk_shader_module).c_str(), local_size_x,
3334 phys_dev_props.limits.maxComputeWorkGroupSize[0]);
Lockeaa8fdc02019-04-02 11:59:20 -06003335 }
3336 if (local_size_y > phys_dev_props.limits.maxComputeWorkGroupSize[1]) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003337 skip |= LogError(shader->vk_shader_module, "UNASSIGNED-features-limits-maxComputeWorkGroupSize",
3338 "%s local_size_y (%" PRIu32 ") exceeds device limit maxComputeWorkGroupSize[1] (%" PRIu32 ").",
3339 report_data->FormatHandle(shader->vk_shader_module).c_str(), local_size_x,
3340 phys_dev_props.limits.maxComputeWorkGroupSize[1]);
Lockeaa8fdc02019-04-02 11:59:20 -06003341 }
3342 if (local_size_z > phys_dev_props.limits.maxComputeWorkGroupSize[2]) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003343 skip |= LogError(shader->vk_shader_module, "UNASSIGNED-features-limits-maxComputeWorkGroupSize",
3344 "%s local_size_z (%" PRIu32 ") exceeds device limit maxComputeWorkGroupSize[2] (%" PRIu32 ").",
3345 report_data->FormatHandle(shader->vk_shader_module).c_str(), local_size_x,
3346 phys_dev_props.limits.maxComputeWorkGroupSize[2]);
Lockeaa8fdc02019-04-02 11:59:20 -06003347 }
3348
3349 uint32_t limit = phys_dev_props.limits.maxComputeWorkGroupInvocations;
3350 uint64_t invocations = local_size_x * local_size_y;
3351 // Prevent overflow.
3352 bool fail = false;
3353 if (invocations > UINT32_MAX || invocations > limit) {
3354 fail = true;
3355 }
3356 if (!fail) {
3357 invocations *= local_size_z;
3358 if (invocations > UINT32_MAX || invocations > limit) {
3359 fail = true;
3360 }
3361 }
3362 if (fail) {
Mark Lobodzinski12b9be92020-01-30 15:25:55 -07003363 skip |= LogError(shader->vk_shader_module, "UNASSIGNED-features-limits-maxComputeWorkGroupInvocations",
3364 "%s local_size (%" PRIu32 ", %" PRIu32 ", %" PRIu32
3365 ") exceeds device limit maxComputeWorkGroupInvocations (%" PRIu32 ").",
3366 report_data->FormatHandle(shader->vk_shader_module).c_str(), local_size_x, local_size_y, local_size_z,
3367 limit);
Lockeaa8fdc02019-04-02 11:59:20 -06003368 }
3369 }
3370 return skip;
3371}