forked from KhronosGroup/Vulkan-ValidationLayers
-
Notifications
You must be signed in to change notification settings - Fork 1
/
stateless_validation.h
1741 lines (1544 loc) · 110 KB
/
stateless_validation.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2015-2021 The Khronos Group Inc.
* Copyright (c) 2015-2021 Valve Corporation
* Copyright (c) 2015-2021 LunarG, Inc.
* Copyright (C) 2015-2021 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Author: Dustin Graves <[email protected]>
* Author: Mark Lobodzinski <[email protected]>
*/
#pragma once
#include "parameter_name.h"
#include "vk_typemap_helper.h"
#include "sync_utils.h"
// Suppress unused warning on Linux
#if defined(__GNUC__)
#define DECORATE_UNUSED __attribute__((unused))
#else
#define DECORATE_UNUSED
#endif
static const char DECORATE_UNUSED *kVUID_PVError_RequiredParameter = "UNASSIGNED-GeneralParameterError-RequiredParameter";
static const char DECORATE_UNUSED *kVUID_PVError_UnrecognizedValue = "UNASSIGNED-GeneralParameterError-UnrecognizedValue";
static const char DECORATE_UNUSED *kVUID_PVError_ExtensionNotEnabled = "UNASSIGNED-GeneralParameterError-ExtensionNotEnabled";
static const char DECORATE_UNUSED *kVUID_PVError_ApiVersionViolation = "UNASSIGNED-API-Version-Violation";
// static const char DECORATE_UNUSED *kVUID_PVError_InvalidStructPNext = "UNASSIGNED-GeneralParameterError-InvalidStructPNext";
// static const char DECORATE_UNUSED *kVUID_PVError_NONE = "UNASSIGNED-GeneralParameterError-Info";
// static const char DECORATE_UNUSED *kVUID_PVError_InvalidUsage = "UNASSIGNED-GeneralParameterError-InvalidUsage";
// static const char DECORATE_UNUSED *kVUID_PVError_InvalidStructSType = "UNASSIGNED-GeneralParameterError-InvalidStructSType";
// static const char DECORATE_UNUSED *kVUID_PVError_ReservedParameter = "UNASSIGNED-GeneralParameterError-ReservedParameter";
// static const char DECORATE_UNUSED *kVUID_PVError_DeviceLimit = "UNASSIGNED-GeneralParameterError-DeviceLimit";
// static const char DECORATE_UNUSED *kVUID_PVError_FailureCode = "UNASSIGNED-GeneralParameterError-FailureCode";
// static const char DECORATE_UNUSED *kVUID_PVError_DeviceFeature = "UNASSIGNED-GeneralParameterError-DeviceFeature";
extern const uint32_t GeneratedVulkanHeaderVersion;
extern const VkQueryPipelineStatisticFlags AllVkQueryPipelineStatisticFlagBits;
extern const VkColorComponentFlags AllVkColorComponentFlagBits;
extern const VkShaderStageFlags AllVkShaderStageFlagBits;
extern const VkQueryControlFlags AllVkQueryControlFlagBits;
extern const VkImageUsageFlags AllVkImageUsageFlagBits;
extern const VkSampleCountFlags AllVkSampleCountFlagBits;
extern const VkBuildAccelerationStructureFlagsNV AllVkBuildAccelerationStructureFlagBitsNV;
extern const VkGeometryFlagsKHR AllVkGeometryFlagBitsKHR;
extern const std::vector<VkGeometryTypeKHR> AllVkGeometryTypeKHREnums;
extern const std::vector<VkCompareOp> AllVkCompareOpEnums;
extern const std::vector<VkStencilOp> AllVkStencilOpEnums;
extern const std::vector<VkBlendFactor> AllVkBlendFactorEnums;
extern const std::vector<VkBlendOp> AllVkBlendOpEnums;
extern const std::vector<VkLogicOp> AllVkLogicOpEnums;
extern const std::vector<VkBorderColor> AllVkBorderColorEnums;
extern const std::vector<VkImageLayout> AllVkImageLayoutEnums;
extern const std::vector<VkFormat> AllVkFormatEnums;
extern const std::vector<VkVertexInputRate> AllVkVertexInputRateEnums;
extern const std::vector<VkPrimitiveTopology> AllVkPrimitiveTopologyEnums;
extern const std::vector<VkIndexType> AllVkIndexTypeEnums;
extern std::vector<std::pair<uint32_t, uint32_t>> custom_stype_info;
// String returned by string_VkStructureType for an unrecognized type.
const std::string UnsupportedStructureTypeString = "Unhandled VkStructureType";
// String returned by string_VkResult for an unrecognized type.
const std::string UnsupportedResultString = "Unhandled VkResult";
// The base value used when computing the offset for an enumeration token value that is added by an extension.
// When validating enumeration tokens, any value >= to this value is considered to be provided by an extension.
// See Appendix C.10 "Assigning Extension Token Values" from the Vulkan specification
const uint32_t ExtEnumBaseValue = 1000000000;
// The value of all VK_xxx_MAX_ENUM tokens
const uint32_t MaxEnumValue = 0x7FFFFFFF;
class StatelessValidation : public ValidationObject {
public:
VkPhysicalDeviceLimits device_limits = {};
safe_VkPhysicalDeviceFeatures2 physical_device_features2;
void *device_createinfo_pnext;
const VkPhysicalDeviceFeatures &physical_device_features = physical_device_features2.features;
layer_data::unordered_map<VkPhysicalDevice, VkPhysicalDeviceProperties *> physical_device_properties_map;
layer_data::unordered_map<VkPhysicalDevice, layer_data::unordered_set<std::string>> device_extensions_enumerated{};
// Override chassis read/write locks for this validation object
// This override takes a deferred lock. i.e. it is not acquired.
read_lock_guard_t read_lock() override;
write_lock_guard_t write_lock() override;
// Device extension properties -- storing properties gathered from VkPhysicalDeviceProperties2::pNext chain
struct DeviceExtensionProperties {
VkPhysicalDeviceShadingRateImagePropertiesNV shading_rate_image_props;
VkPhysicalDeviceMeshShaderPropertiesNV mesh_shader_props;
VkPhysicalDeviceRayTracingPropertiesNV ray_tracing_propsNV;
VkPhysicalDeviceRayTracingPipelinePropertiesKHR ray_tracing_propsKHR;
VkPhysicalDeviceAccelerationStructurePropertiesKHR acc_structure_props;
VkPhysicalDeviceTransformFeedbackPropertiesEXT transform_feedback_props;
VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT vertex_attribute_divisor_props;
};
DeviceExtensionProperties phys_dev_ext_props = {};
struct SubpassesUsageStates {
layer_data::unordered_set<uint32_t> subpasses_using_color_attachment;
layer_data::unordered_set<uint32_t> subpasses_using_depthstencil_attachment;
};
// Though this validation object is predominantly statless, the Framebuffer checks are greatly simplified by creating and
// updating a map of the renderpass usage states, and these accesses need thread protection. Use a mutex separate from the
// parent object's to maintain that functionality.
mutable std::mutex renderpass_map_mutex;
layer_data::unordered_map<VkRenderPass, SubpassesUsageStates> renderpasses_states;
// Constructor for stateles validation tracking
StatelessValidation() : device_createinfo_pnext(nullptr) { container_type = LayerObjectTypeParameterValidation; }
~StatelessValidation() {
if (device_createinfo_pnext) {
FreePnextChain(device_createinfo_pnext);
}
}
/**
* Validate a minimum value.
*
* Verify that the specified value is greater than the specified lower bound.
*
* @param api_name Name of API call being validated.
* @param parameter_name Name of parameter being validated.
* @param value Value to validate.
* @param lower_bound Lower bound value to use for validation.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool ValidateGreaterThan(const T value, const T lower_bound, const ParameterName ¶meter_name, const std::string &vuid,
const char *api_name) const {
bool skip_call = false;
if (value <= lower_bound) {
std::ostringstream ss;
ss << api_name << ": parameter " << parameter_name.get_name() << " (= " << value << ") is not greater than "
<< lower_bound;
skip_call |= LogError(device, vuid, "%s", ss.str().c_str());
}
return skip_call;
}
template <typename T>
bool ValidateGreaterThanZero(const T value, const ParameterName ¶meter_name, const std::string &vuid,
const char *api_name) const {
return ValidateGreaterThan(value, T{0}, parameter_name, vuid, api_name);
}
/**
* Validate a required pointer.
*
* Verify that a required pointer is not NULL.
*
* @param apiName Name of API call being validated.
* @param parameterName Name of parameter being validated.
* @param value Pointer to validate.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_required_pointer(const char *apiName, const ParameterName ¶meterName, const void *value,
const std::string &vuid) const {
bool skip_call = false;
if (value == nullptr) {
skip_call |=
LogError(device, vuid, "%s: required parameter %s specified as NULL.", apiName, parameterName.get_name().c_str());
}
return skip_call;
}
/**
* Validate array count and pointer to array.
*
* Verify that required count and array parameters are not 0 or NULL. If the
* count parameter is not optional, verify that it is not 0. If the array
* parameter is NULL, and it is not optional, verify that count is 0.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param count Number of elements in the array.
* @param array Array to validate.
* @param countRequired The 'count' parameter may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T1, typename T2>
bool validate_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName, T1 count,
const T2 *array, bool countRequired, bool arrayRequired, const char *count_required_vuid,
const char *array_required_vuid) const {
bool skip_call = false;
// Count parameters not tagged as optional cannot be 0
if (countRequired && (count == 0)) {
skip_call |= LogError(device, count_required_vuid, "%s: parameter %s must be greater than 0.", apiName,
countName.get_name().c_str());
}
// Array parameters not tagged as optional cannot be NULL, unless the count is 0
if (arrayRequired && (count != 0) && (*array == nullptr)) {
skip_call |= LogError(device, array_required_vuid, "%s: required parameter %s specified as NULL.", apiName,
arrayName.get_name().c_str());
}
return skip_call;
}
/**
* Validate pointer to array count and pointer to array.
*
* Verify that required count and array parameters are not NULL. If count
* is not NULL and its value is not optional, verify that it is not 0. If the
* array parameter is NULL, and it is not optional, verify that count is 0.
* The array parameter will typically be optional for this case (where count is
* a pointer), allowing the caller to retrieve the available count.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param count Pointer to the number of elements in the array.
* @param array Array to validate.
* @param countPtrRequired The 'count' parameter may not be NULL when true.
* @param countValueRequired The '*count' value may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @param count_required_vuid The VUID for the '*count' parameter.
* @param array_required_vuid The VUID for the 'array' parameter.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T1, typename T2>
bool validate_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName, const T1 *count,
const T2 *array, bool countPtrRequired, bool countValueRequired, bool arrayRequired,
const char *count_required_vuid, const char *array_required_vuid) const {
bool skip_call = false;
if (count == nullptr) {
if (countPtrRequired) {
skip_call |= LogError(device, kVUID_PVError_RequiredParameter, "%s: required parameter %s specified as NULL",
apiName, countName.get_name().c_str());
}
} else {
skip_call |= validate_array(apiName, countName, arrayName, *array ? (*count) : 0, &array, countValueRequired,
arrayRequired, count_required_vuid, array_required_vuid);
}
return skip_call;
}
/**
* Validate a pointer to a Vulkan structure.
*
* Verify that a required pointer to a structure is not NULL. If the pointer is
* not NULL, verify that each structure's sType field is set to the correct
* VkStructureType value.
*
* @param apiName Name of API call being validated.
* @param parameterName Name of struct parameter being validated.
* @param sTypeName Name of expected VkStructureType value.
* @param value Pointer to the struct to validate.
* @param sType VkStructureType for structure validation.
* @param required The parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_struct_type(const char *apiName, const ParameterName ¶meterName, const char *sTypeName, const T *value,
VkStructureType sType, bool required, const char *struct_vuid, const char *stype_vuid) const {
bool skip_call = false;
if (value == nullptr) {
if (required) {
skip_call |= LogError(device, struct_vuid, "%s: required parameter %s specified as NULL", apiName,
parameterName.get_name().c_str());
}
} else if (value->sType != sType) {
skip_call |= LogError(device, stype_vuid, "%s: parameter %s->sType must be %s.", apiName,
parameterName.get_name().c_str(), sTypeName);
}
return skip_call;
}
/**
* Validate an array of Vulkan structures
*
* Verify that required count and array parameters are not 0 or NULL. If
* the array contains 1 or more structures, verify that each structure's
* sType field is set to the correct VkStructureType value.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param sTypeName Name of expected VkStructureType value.
* @param count Number of elements in the array.
* @param array Array to validate.
* @param sType VkStructureType for structure validation.
* @param countRequired The 'count' parameter may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_struct_type_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName,
const char *sTypeName, uint32_t count, const T *array, VkStructureType sType,
bool countRequired, bool arrayRequired, const char *stype_vuid, const char *param_vuid,
const char *count_required_vuid) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(apiName, countName, arrayName, count, &array, countRequired, arrayRequired,
count_required_vuid, param_vuid);
} else {
// Verify that all structs in the array have the correct type
for (uint32_t i = 0; i < count; ++i) {
if (array[i].sType != sType) {
skip_call |= LogError(device, stype_vuid, "%s: parameter %s[%d].sType must be %s", apiName,
arrayName.get_name().c_str(), i, sTypeName);
}
}
}
return skip_call;
}
/**
* Validate an pointer type array of Vulkan structures
*
* Verify that required count and array parameters are not 0 or NULL. If
* the array contains 1 or more structures, verify that each structure's
* sType field is set to the correct VkStructureType value.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param sTypeName Name of expected VkStructureType value.
* @param count Number of elements in the array.
* @param array Array to validate.
* @param sType VkStructureType for structure validation.
* @param countRequired The 'count' parameter may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_struct_pointer_type_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName,
const char *sTypeName, uint32_t count, const T *array, VkStructureType sType,
bool countRequired, bool arrayRequired, const char *stype_vuid, const char *param_vuid,
const char *count_required_vuid) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(apiName, countName, arrayName, count, &array, countRequired, arrayRequired,
count_required_vuid, param_vuid);
} else {
// Verify that all structs in the array have the correct type
for (uint32_t i = 0; i < count; ++i) {
if (array[i]->sType != sType) {
skip_call |= LogError(device, stype_vuid, "%s: parameter %s[%d]->sType must be %s", apiName,
arrayName.get_name().c_str(), i, sTypeName);
}
}
}
return skip_call;
}
/**
* Validate an array of Vulkan structures.
*
* Verify that required count and array parameters are not NULL. If count
* is not NULL and its value is not optional, verify that it is not 0.
* If the array contains 1 or more structures, verify that each structure's
* sType field is set to the correct VkStructureType value.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param sTypeName Name of expected VkStructureType value.
* @param count Pointer to the number of elements in the array.
* @param array Array to validate.
* @param sType VkStructureType for structure validation.
* @param countPtrRequired The 'count' parameter may not be NULL when true.
* @param countValueRequired The '*count' value may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_struct_type_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName,
const char *sTypeName, uint32_t *count, const T *array, VkStructureType sType,
bool countPtrRequired, bool countValueRequired, bool arrayRequired, const char *stype_vuid,
const char *param_vuid, const char *count_required_vuid) const {
bool skip_call = false;
if (count == nullptr) {
if (countPtrRequired) {
skip_call |= LogError(device, kVUID_PVError_RequiredParameter, "%s: required parameter %s specified as NULL",
apiName, countName.get_name().c_str());
}
} else {
skip_call |= validate_struct_type_array(apiName, countName, arrayName, sTypeName, (*count), array, sType,
countValueRequired && (array != nullptr), arrayRequired, stype_vuid, param_vuid,
count_required_vuid);
}
return skip_call;
}
/**
* Validate a Vulkan handle.
*
* Verify that the specified handle is not VK_NULL_HANDLE.
*
* @param api_name Name of API call being validated.
* @param parameter_name Name of struct parameter being validated.
* @param value Handle to validate.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_required_handle(const char *api_name, const ParameterName ¶meter_name, T value) const {
bool skip_call = false;
if (value == VK_NULL_HANDLE) {
skip_call |= LogError(device, kVUID_PVError_RequiredParameter, "%s: required parameter %s specified as VK_NULL_HANDLE",
api_name, parameter_name.get_name().c_str());
}
return skip_call;
}
/**
* Validate an array of Vulkan handles.
*
* Verify that required count and array parameters are not NULL. If count
* is not NULL and its value is not optional, verify that it is not 0.
* If the array contains 1 or more handles, verify that no handle is set to
* VK_NULL_HANDLE.
*
* @note This function is only intended to validate arrays of handles when none
* of the handles are allowed to be VK_NULL_HANDLE. For arrays of handles
* that are allowed to contain VK_NULL_HANDLE, use validate_array() instead.
*
* @param api_name Name of API call being validated.
* @param count_name Name of count parameter.
* @param array_name Name of array parameter.
* @param count Number of elements in the array.
* @param array Array to validate.
* @param count_required The 'count' parameter may not be 0 when true.
* @param array_required The 'array' parameter may not be NULL when true.
* @param count_required_vuid The VUID for the '*count' parameter.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_handle_array(const char *api_name, const ParameterName &count_name, const ParameterName &array_name,
uint32_t count, const T *array, bool count_required, bool array_required,
const char *count_required_vuid) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(api_name, count_name, array_name, count, &array, count_required, array_required,
count_required_vuid, kVUIDUndefined);
} else {
// Verify that no handles in the array are VK_NULL_HANDLE
for (uint32_t i = 0; i < count; ++i) {
if (array[i] == VK_NULL_HANDLE) {
skip_call |= LogError(device, kVUID_PVError_RequiredParameter,
"%s: required parameter %s[%d] specified as VK_NULL_HANDLE", api_name,
array_name.get_name().c_str(), i);
}
}
}
return skip_call;
}
/**
* Validate string array count and content.
*
* Verify that required count and array parameters are not 0 or NULL. If the
* count parameter is not optional, verify that it is not 0. If the array
* parameter is NULL, and it is not optional, verify that count is 0. If the
* array parameter is not NULL, verify that none of the strings are NULL.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param count Number of strings in the array.
* @param array Array of strings to validate.
* @param countRequired The 'count' parameter may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_string_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName, uint32_t count,
const char *const *array, bool countRequired, bool arrayRequired, const char *count_required_vuid,
const char *array_required_vuid) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(apiName, countName, arrayName, count, &array, countRequired, arrayRequired,
count_required_vuid, array_required_vuid);
} else {
// Verify that strings in the array are not NULL
for (uint32_t i = 0; i < count; ++i) {
if (array[i] == nullptr) {
skip_call |= LogError(device, array_required_vuid, "%s: required parameter %s[%d] specified as NULL", apiName,
arrayName.get_name().c_str(), i);
}
}
}
return skip_call;
}
// Forward declarations
bool CheckPromotedApiAgainstVulkanVersion(VkInstance instance, const char *api_name, const uint32_t promoted_version) const;
bool CheckPromotedApiAgainstVulkanVersion(VkPhysicalDevice pdev, const char *api_name, const uint32_t promoted_version) const;
bool SupportedByPdev(const VkPhysicalDevice physical_device, const std::string ext_name) const;
bool ValidatePnextStructContents(const char *api_name, const ParameterName ¶meter_name, const VkBaseOutStructure *header,
const char *pnext_vuid) const;
/**
* Validate a structure's pNext member.
*
* Verify that the specified pNext value points to the head of a list of
* allowed extension structures. If no extension structures are allowed,
* verify that pNext is null.
*
* @param api_name Name of API call being validated.
* @param parameter_name Name of parameter being validated.
* @param allowed_struct_names Names of allowed structs.
* @param next Pointer to validate.
* @param allowed_type_count Total number of allowed structure types.
* @param allowed_types Array of structure types allowed for pNext.
* @param header_version Version of header defining the pNext validation rules.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_struct_pnext(const char *api_name, const ParameterName ¶meter_name, const char *allowed_struct_names,
const void *next, size_t allowed_type_count, const VkStructureType *allowed_types,
uint32_t header_version, const char *pnext_vuid, const char *stype_vuid) const {
bool skip_call = false;
if (next != nullptr) {
layer_data::unordered_set<const void *> cycle_check;
layer_data::unordered_set<VkStructureType, layer_data::hash<int>> unique_stype_check;
const char *disclaimer =
"This error is based on the Valid Usage documentation for version %d of the Vulkan header. It is possible that "
"you are using a struct from a private extension or an extension that was added to a later version of the Vulkan "
"header, in which case the use of %s is undefined and may not work correctly with validation enabled";
if ((allowed_type_count == 0) && (custom_stype_info.size() == 0)) {
std::string message = "%s: value of %s must be NULL. ";
message += disclaimer;
skip_call |= LogError(device, pnext_vuid, message.c_str(), api_name, parameter_name.get_name().c_str(),
header_version, parameter_name.get_name().c_str());
} else {
const VkStructureType *start = allowed_types;
const VkStructureType *end = allowed_types + allowed_type_count;
const VkBaseOutStructure *current = reinterpret_cast<const VkBaseOutStructure *>(next);
while (current != nullptr) {
if (((strncmp(api_name, "vkCreateInstance", strlen(api_name)) != 0) ||
(current->sType != VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO)) &&
((strncmp(api_name, "vkCreateDevice", strlen(api_name)) != 0) ||
(current->sType != VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO))) {
std::string type_name = string_VkStructureType(current->sType);
if (unique_stype_check.find(current->sType) != unique_stype_check.end() &&
!IsDuplicatePnext(current->sType)) {
// stype_vuid will only be null if there are no listed pNext and will hit disclaimer check
std::string message = "%s: %s chain contains duplicate structure types: %s appears multiple times.";
skip_call |= LogError(device, stype_vuid, message.c_str(), api_name, parameter_name.get_name().c_str(),
type_name.c_str());
} else {
unique_stype_check.insert(current->sType);
}
// Search custom stype list -- if sType found, skip this entirely
bool custom = false;
for (const auto &item : custom_stype_info) {
if (item.first == current->sType) {
custom = true;
break;
}
}
if (!custom) {
if (std::find(start, end, current->sType) == end) {
if (type_name.compare(UnsupportedStructureTypeString) == 0) {
std::string message =
"%s: %s chain includes a structure with unknown VkStructureType (%d); Allowed structures "
"are [%s]. ";
message += disclaimer;
skip_call |= LogError(device, pnext_vuid, message.c_str(), api_name,
parameter_name.get_name().c_str(), current->sType, allowed_struct_names,
header_version, parameter_name.get_name().c_str());
} else {
std::string message =
"%s: %s chain includes a structure with unexpected VkStructureType %s; Allowed structures "
"are [%s]. ";
message += disclaimer;
skip_call |= LogError(device, pnext_vuid, message.c_str(), api_name,
parameter_name.get_name().c_str(), type_name.c_str(),
allowed_struct_names, header_version, parameter_name.get_name().c_str());
}
}
skip_call |= ValidatePnextStructContents(api_name, parameter_name, current, pnext_vuid);
}
}
current = reinterpret_cast<const VkBaseOutStructure *>(current->pNext);
}
}
}
return skip_call;
}
/**
* Validate a VkBool32 value.
*
* Generate an error if a VkBool32 value is neither VK_TRUE nor VK_FALSE.
*
* @param apiName Name of API call being validated.
* @param parameterName Name of parameter being validated.
* @param value Boolean value to validate.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_bool32(const char *apiName, const ParameterName ¶meterName, VkBool32 value) const {
bool skip_call = false;
if ((value != VK_TRUE) && (value != VK_FALSE)) {
skip_call |= LogError(device, kVUID_PVError_UnrecognizedValue,
"%s: value of %s (%d) is neither VK_TRUE nor VK_FALSE. Applications MUST not pass any other "
"values than VK_TRUE or VK_FALSE into a Vulkan implementation where a VkBool32 is expected.",
apiName, parameterName.get_name().c_str(), value);
}
return skip_call;
}
/**
* Validate an array of VkBool32 values.
*
* Generate an error if any VkBool32 value in an array is neither VK_TRUE nor VK_FALSE.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param count Number of values in the array.
* @param array Array of VkBool32 values to validate.
* @param countRequired The 'count' parameter may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_bool32_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName, uint32_t count,
const VkBool32 *array, bool countRequired, bool arrayRequired) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(apiName, countName, arrayName, count, &array, countRequired, arrayRequired, kVUIDUndefined,
kVUIDUndefined);
} else {
for (uint32_t i = 0; i < count; ++i) {
if ((array[i] != VK_TRUE) && (array[i] != VK_FALSE)) {
skip_call |=
LogError(device, kVUID_PVError_UnrecognizedValue,
"%s: value of %s[%d] (%d) is neither VK_TRUE nor VK_FALSE. Applications MUST not pass any other "
"values than VK_TRUE or VK_FALSE into a Vulkan implementation where a VkBool32 is expected.",
apiName, arrayName.get_name().c_str(), i, array[i]);
}
}
}
return skip_call;
}
/**
* Validate a Vulkan enumeration value.
*
* Generate a warning if an enumeration token value does not fall within the core enumeration
* begin and end token values, and was not added to the enumeration by an extension. Extension
* provided enumerations use the equation specified in Appendix C.10 of the Vulkan specification,
* with 1,000,000,000 as the base token value.
*
* @note This function does not expect to process enumerations defining bitmask flag bits.
*
* @param apiName Name of API call being validated.
* @param parameterName Name of parameter being validated.
* @param enumName Name of the enumeration being validated.
* @param valid_values The list of valid values for the enumeration.
* @param value Enumeration value to validate.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_ranged_enum(const char *apiName, const ParameterName ¶meterName, const char *enumName,
const std::vector<T> &valid_values, T value, const char *vuid) const {
bool skip = false;
if (std::find(valid_values.begin(), valid_values.end(), value) == valid_values.end()) {
skip |=
LogError(device, vuid,
"%s: value of %s (%d) does not fall within the begin..end range of the core %s enumeration tokens and is "
"not an extension added token.",
apiName, parameterName.get_name().c_str(), value, enumName);
}
return skip;
}
/**
* Validate an array of Vulkan enumeration value.
*
* Process all enumeration token values in the specified array and generate a warning if a value
* does not fall within the core enumeration begin and end token values, and was not added to
* the enumeration by an extension. Extension provided enumerations use the equation specified
* in Appendix C.10 of the Vulkan specification, with 1,000,000,000 as the base token value.
*
* @note This function does not expect to process enumerations defining bitmask flag bits.
*
* @param apiName Name of API call being validated.
* @param countName Name of count parameter.
* @param arrayName Name of array parameter.
* @param enumName Name of the enumeration being validated.
* @param valid_values The list of valid values for the enumeration.
* @param count Number of enumeration values in the array.
* @param array Array of enumeration values to validate.
* @param countRequired The 'count' parameter may not be 0 when true.
* @param arrayRequired The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
template <typename T>
bool validate_ranged_enum_array(const char *apiName, const ParameterName &countName, const ParameterName &arrayName,
const char *enumName, const std::vector<T> &valid_values, uint32_t count, const T *array,
bool countRequired, bool arrayRequired) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(apiName, countName, arrayName, count, &array, countRequired, arrayRequired, kVUIDUndefined,
kVUIDUndefined);
} else {
for (uint32_t i = 0; i < count; ++i) {
if (std::find(valid_values.begin(), valid_values.end(), array[i]) == valid_values.end()) {
skip_call |= LogError(device, kVUID_PVError_UnrecognizedValue,
"%s: value of %s[%d] (%d) does not fall within the begin..end range of the core %s "
"enumeration tokens and is not an extension added token",
apiName, arrayName.get_name().c_str(), i, array[i], enumName);
}
}
}
return skip_call;
}
/**
* Verify that a reserved VkFlags value is zero.
*
* Verify that the specified value is zero, to check VkFlags values that are reserved for
* future use.
*
* @param api_name Name of API call being validated.
* @param parameter_name Name of parameter being validated.
* @param value Value to validate.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_reserved_flags(const char *api_name, const ParameterName ¶meter_name, VkFlags value, const char *vuid) const {
bool skip_call = false;
if (value != 0) {
skip_call |= LogError(device, vuid, "%s: parameter %s must be 0.", api_name, parameter_name.get_name().c_str());
}
return skip_call;
}
enum FlagType { kRequiredFlags, kOptionalFlags, kRequiredSingleBit, kOptionalSingleBit };
// helper to implement validation of both 32 bit and 64 bit flags.
template <typename FlagTypedef>
bool validate_flags_impl(const char *api_name, const ParameterName ¶meter_name, const char *flag_bits_name,
FlagTypedef all_flags, FlagTypedef value, const FlagType flag_type, const char *vuid,
const char *flags_zero_vuid = nullptr) const {
bool skip_call = false;
if ((value & ~all_flags) != 0) {
skip_call |= LogError(device, vuid, "%s: value of %s contains flag bits that are not recognized members of %s",
api_name, parameter_name.get_name().c_str(), flag_bits_name);
}
const bool required = flag_type == kRequiredFlags || flag_type == kRequiredSingleBit;
const char *zero_vuid = flag_type == kRequiredFlags ? flags_zero_vuid : vuid;
if (required && value == 0) {
skip_call |= LogError(device, zero_vuid, "%s: value of %s must not be 0.", api_name, parameter_name.get_name().c_str());
}
const auto HasMaxOneBitSet = [](const FlagTypedef f) {
// Decrement flips bits from right upto first 1.
// Rest stays same, and if there was any other 1s &ded together they would be non-zero. QED
return f == 0 || !(f & (f - 1));
};
const bool is_bits_type = flag_type == kRequiredSingleBit || flag_type == kOptionalSingleBit;
if (is_bits_type && !HasMaxOneBitSet(value)) {
skip_call |=
LogError(device, vuid, "%s: value of %s contains multiple members of %s when only a single value is allowed",
api_name, parameter_name.get_name().c_str(), flag_bits_name);
}
return skip_call;
}
/**
* Validate a 32 bit Vulkan bitmask value.
*
* Generate a warning if a value with a VkFlags derived type does not contain valid flag bits
* for that type.
*
* @param api_name Name of API call being validated.
* @param parameter_name Name of parameter being validated.
* @param flag_bits_name Name of the VkFlags type being validated.
* @param all_flags A bit mask combining all valid flag bits for the VkFlags type being validated.
* @param value VkFlags value to validate.
* @param flag_type The type of flag, like optional, or single bit.
* @param vuid VUID used for flag that is outside defined bits (or has more than one bit for Bits type).
* @param flags_zero_vuid VUID used for non-optional Flags that are zero.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_flags(const char *api_name, const ParameterName ¶meter_name, const char *flag_bits_name, VkFlags all_flags,
VkFlags value, const FlagType flag_type, const char *vuid, const char *flags_zero_vuid = nullptr) const {
return validate_flags_impl<VkFlags>(api_name, parameter_name, flag_bits_name, all_flags, value, flag_type, vuid,
flags_zero_vuid);
}
/**
* Validate a 64 bit Vulkan bitmask value.
*
* Generate a warning if a value with a VkFlags64 derived type does not contain valid flag bits
* for that type.
*
* @param api_name Name of API call being validated.
* @param parameter_name Name of parameter being validated.
* @param flag_bits_name Name of the VkFlags64 type being validated.
* @param all_flags A bit mask combining all valid flag bits for the VkFlags64 type being validated.
* @param value VkFlags64 value to validate.
* @param flag_type The type of flag, like optional, or single bit.
* @param vuid VUID used for flag that is outside defined bits (or has more than one bit for Bits type).
* @param flags_zero_vuid VUID used for non-optional Flags that are zero.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_flags(const char *api_name, const ParameterName ¶meter_name, const char *flag_bits_name, VkFlags64 all_flags,
VkFlags64 value, const FlagType flag_type, const char *vuid, const char *flags_zero_vuid = nullptr) const {
return validate_flags_impl<VkFlags64>(api_name, parameter_name, flag_bits_name, all_flags, value, flag_type, vuid,
flags_zero_vuid);
}
/**
* Validate an array of Vulkan bitmask values.
*
* Generate a warning if a value with a VkFlags derived type does not contain valid flag bits
* for that type.
*
* @param api_name Name of API call being validated.
* @param count_name Name of parameter being validated.
* @param array_name Name of parameter being validated.
* @param flag_bits_name Name of the VkFlags type being validated.
* @param all_flags A bitmask combining all valid flag bits for the VkFlags type being validated.
* @param count Number of VkFlags values in the array.
* @param array Array of VkFlags value to validate.
* @param count_required The 'count' parameter may not be 0 when true.
* @param array_required The 'array' parameter may not be NULL when true.
* @return Boolean value indicating that the call should be skipped.
*/
bool validate_flags_array(const char *api_name, const ParameterName &count_name, const ParameterName &array_name,
const char *flag_bits_name, VkFlags all_flags, uint32_t count, const VkFlags *array,
bool count_required, bool array_required) const {
bool skip_call = false;
if ((count == 0) || (array == nullptr)) {
skip_call |= validate_array(api_name, count_name, array_name, count, &array, count_required, array_required,
kVUIDUndefined, kVUIDUndefined);
} else {
// Verify that all VkFlags values in the array
for (uint32_t i = 0; i < count; ++i) {
if (array[i] == 0) {
// Current XML registry logic for validity generation uses the array parameter's optional tag to determine if
// elements in the array are allowed be 0
if (array_required) {
skip_call |= LogError(device, kVUID_PVError_RequiredParameter, "%s: value of %s[%d] must not be 0",
api_name, array_name.get_name().c_str(), i);
}
} else if ((array[i] & (~all_flags)) != 0) {
skip_call |= LogError(device, kVUID_PVError_UnrecognizedValue,
"%s: value of %s[%d] contains flag bits that are not recognized members of %s", api_name,
array_name.get_name().c_str(), i, flag_bits_name);
}
}
}
return skip_call;
}
template <typename ExtensionState>
bool validate_extension_reqs(const ExtensionState &extensions, const char *vuid, const char *extension_type,
const char *extension_name) const {
bool skip = false;
if (!extension_name) {
return skip; // Robust to invalid char *
}
auto info = ExtensionState::get_info(extension_name);
if (!info.state) {
return skip; // Unknown extensions cannot be checked so report OK
}
// Check against the required list in the info
std::vector<const char *> missing;
for (const auto &req : info.requirements) {
if (!(extensions.*(req.enabled))) {
missing.push_back(req.name);
}
}
// Report any missing requirements
if (missing.size()) {
std::string missing_joined_list = string_join(", ", missing);
skip |= LogError(instance, vuid, "Missing extension%s required by the %s extension %s: %s.",
((missing.size() > 1) ? "s" : ""), extension_type, extension_name, missing_joined_list.c_str());
}
return skip;
}
enum RenderPassCreateVersion { RENDER_PASS_VERSION_1 = 0, RENDER_PASS_VERSION_2 = 1 };
template <typename RenderPassCreateInfoGeneric>
bool ValidateSubpassGraphicsFlags(const debug_report_data *report_data, const RenderPassCreateInfoGeneric *pCreateInfo,
uint32_t dependency_index, uint32_t subpass, VkPipelineStageFlags2KHR stages,
const char *vuid, const char *target, const char *func_name) const {
bool skip = false;
// make sure we consider all of the expanded and un-expanded graphics bits to be valid
const auto kExcludeStages = VK_PIPELINE_STAGE_2_ALL_TRANSFER_BIT_KHR | VK_PIPELINE_STAGE_2_COPY_BIT_KHR |
VK_PIPELINE_STAGE_2_RESOLVE_BIT_KHR | VK_PIPELINE_STAGE_2_BLIT_BIT_KHR |
VK_PIPELINE_STAGE_2_CLEAR_BIT_KHR;
const auto kMetaGraphicsStages = VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR | VK_PIPELINE_STAGE_2_VERTEX_INPUT_BIT_KHR |
VK_PIPELINE_STAGE_2_PRE_RASTERIZATION_SHADERS_BIT_KHR;
const auto kGraphicsStages =
(sync_utils::ExpandPipelineStages(VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT, VK_QUEUE_GRAPHICS_BIT) | kMetaGraphicsStages) &
~kExcludeStages;
const auto IsPipeline = [pCreateInfo](uint32_t subpass, const VkPipelineBindPoint stage) {
if (subpass == VK_SUBPASS_EXTERNAL || subpass >= pCreateInfo->subpassCount)
return false;
else
return pCreateInfo->pSubpasses[subpass].pipelineBindPoint == stage;
};
const bool is_all_graphics_stages = (stages & ~kGraphicsStages) == 0;
if (IsPipeline(subpass, VK_PIPELINE_BIND_POINT_GRAPHICS) && !is_all_graphics_stages) {
skip |= LogError(VkRenderPass(0), vuid,
"%s: Dependency pDependencies[%" PRIu32
"] specifies a %sStageMask that contains stages (%s) that are not part "
"of the Graphics pipeline, as specified by the %sSubpass (= %" PRIu32 ") in pipelineBindPoint.",
func_name, dependency_index, target,
sync_utils::StringPipelineStageFlags(stages & ~kGraphicsStages).c_str(), target, subpass);
}
return skip;
};
template <typename RenderPassCreateInfoGeneric>
bool CreateRenderPassGeneric(VkDevice device, const RenderPassCreateInfoGeneric *pCreateInfo,
const VkAllocationCallbacks *pAllocator, VkRenderPass *pRenderPass,
RenderPassCreateVersion rp_version) const {
bool skip = false;
uint32_t max_color_attachments = device_limits.maxColorAttachments;
bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
const char *func_name = (use_rp2) ? "vkCreateRenderPass2" : "vkCreateRenderPass";
const char *vuid;
VkBool32 separate_depth_stencil_layouts = false;
const auto *vulkan_12_features = LvlFindInChain<VkPhysicalDeviceVulkan12Features>(device_createinfo_pnext);
if (vulkan_12_features) {
separate_depth_stencil_layouts = vulkan_12_features->separateDepthStencilLayouts;
} else {
const auto *separate_depth_stencil_layouts_features =
LvlFindInChain<VkPhysicalDeviceSeparateDepthStencilLayoutsFeatures>(device_createinfo_pnext);
if (separate_depth_stencil_layouts_features)
separate_depth_stencil_layouts = separate_depth_stencil_layouts_features->separateDepthStencilLayouts;
}
for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
const auto *attachment_description_stencil_layout =
(use_rp2) ? LvlFindInChain<VkAttachmentDescriptionStencilLayout>(
reinterpret_cast<VkAttachmentDescription2 const *>(&pCreateInfo->pAttachments[i])->pNext)
: 0;