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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
|
/* Copyright (c) 2015-2025 The Khronos Group Inc.
* Copyright (c) 2015-2025 Valve Corporation
* Copyright (c) 2015-2025 LunarG, Inc.
* Copyright (C) 2015-2025 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.
*/
#include "state_tracker/descriptor_sets.h"
#include <vulkan/vk_enum_string_helper.h>
#include <vulkan/vulkan_core.h>
#include <cstdint>
#include "state_tracker/image_state.h"
#include "state_tracker/buffer_state.h"
#include "state_tracker/cmd_buffer_state.h"
#include "state_tracker/ray_tracing_state.h"
#include "state_tracker/sampler_state.h"
#include "state_tracker/shader_module.h"
#include "state_tracker/state_tracker.h"
#include "containers/limits.h"
#include "utils/assert_utils.h"
static vvl::DescriptorPool::TypeCountMap GetMaxTypeCounts(const VkDescriptorPoolCreateInfo *create_info) {
vvl::DescriptorPool::TypeCountMap counts;
// Collect maximums per descriptor type.
for (uint32_t i = 0; i < create_info->poolSizeCount; ++i) {
const auto &pool_size = create_info->pPoolSizes[i];
uint32_t type = static_cast<uint32_t>(pool_size.type);
// Same descriptor types can appear several times
counts[type] += pool_size.descriptorCount;
}
return counts;
}
vvl::DescriptorPool::DescriptorPool(vvl::DeviceState &dev, const VkDescriptorPool handle,
const VkDescriptorPoolCreateInfo *pCreateInfo)
: StateObject(handle, kVulkanObjectTypeDescriptorPool),
safe_create_info(pCreateInfo),
create_info(*safe_create_info.ptr()),
maxSets(pCreateInfo->maxSets),
max_descriptor_type_count(GetMaxTypeCounts(pCreateInfo)),
available_sets_(pCreateInfo->maxSets),
available_counts_(max_descriptor_type_count),
dev_data_(dev) {}
void vvl::DescriptorPool::Allocate(const VkDescriptorSetAllocateInfo *alloc_info, const VkDescriptorSet *descriptor_sets,
const vvl::AllocateDescriptorSetsData &ds_data) {
auto guard = WriteLock();
const auto alloc_count = alloc_info->descriptorSetCount;
// Account for sets and individual descriptors allocated from pool
available_sets_ -= alloc_count;
for (auto it = ds_data.required_descriptors_by_type.begin(); it != ds_data.required_descriptors_by_type.end(); ++it) {
available_counts_[it->first] -= ds_data.required_descriptors_by_type.at(it->first);
}
const auto *variable_count_info = vku::FindStructInPNextChain<VkDescriptorSetVariableDescriptorCountAllocateInfo>(alloc_info->pNext);
const bool variable_count_valid =
variable_count_info && variable_count_info->descriptorSetCount == alloc_count;
// Create tracking object for each descriptor set; insert into global map and the pool's set.
for (uint32_t i = 0; i < alloc_count; i++) {
uint32_t variable_count = variable_count_valid ? variable_count_info->pDescriptorCounts[i] : 0;
auto new_ds = dev_data_.CreateDescriptorSet(descriptor_sets[i], this, ds_data.layout_nodes[i], variable_count);
sets_.emplace(descriptor_sets[i], new_ds.get());
dev_data_.Add(std::move(new_ds));
}
// clamp the unsigned subtraction to the range [0, last_free_count]
if (freed_count > alloc_count) {
freed_count -= alloc_count;
} else {
freed_count = 0;
}
}
void vvl::DescriptorPool::Free(uint32_t count, const VkDescriptorSet *descriptor_sets) {
auto guard = WriteLock();
// Update available descriptor sets in pool
available_sets_ += count;
// we want to track frees because we're interested in suggesting re-use
freed_count += count;
// For each freed descriptor add its resources back into the pool as available and remove from pool and device data
for (uint32_t i = 0; i < count; ++i) {
if (descriptor_sets[i] != VK_NULL_HANDLE) {
auto iter = sets_.find(descriptor_sets[i]);
ASSERT_AND_CONTINUE(iter != sets_.end());
auto *set_state = iter->second;
const auto &layout = set_state->Layout();
uint32_t type_index = 0, descriptor_count = 0;
for (uint32_t j = 0; j < layout.GetBindingCount(); ++j) {
type_index = static_cast<uint32_t>(layout.GetTypeFromIndex(j));
descriptor_count = layout.GetDescriptorCountFromIndex(j);
available_counts_[type_index] += descriptor_count;
}
dev_data_.Destroy<vvl::DescriptorSet>(iter->first);
sets_.erase(iter);
}
}
}
void vvl::DescriptorPool::Reset() {
auto guard = WriteLock();
// For every set off of this pool, clear it, remove from setMap, and free vvl::DescriptorSet
for (auto entry : sets_) {
dev_data_.Destroy<vvl::DescriptorSet>(entry.first);
}
sets_.clear();
// Reset available count for each type and available sets for this pool
available_counts_ = max_descriptor_type_count;
available_sets_ = maxSets;
}
const VulkanTypedHandle *vvl::DescriptorPool::InUse() const {
auto guard = ReadLock();
for (const auto &entry : sets_) {
const auto *ds = entry.second;
if (ds) {
return ds->InUse();
}
}
return nullptr;
}
void vvl::DescriptorPool::Destroy() {
Reset();
StateObject::Destroy();
}
// ExtendedBinding collects a VkDescriptorSetLayoutBinding and any extended
// state that comes from a different array/structure so they can stay together
// while being sorted by binding number.
struct ExtendedBinding {
ExtendedBinding(const VkDescriptorSetLayoutBinding *l, VkDescriptorBindingFlags f) : layout_binding(l), binding_flags(f) {}
const VkDescriptorSetLayoutBinding *layout_binding;
VkDescriptorBindingFlags binding_flags;
};
struct BindingNumCmp {
bool operator()(const ExtendedBinding &a, const ExtendedBinding &b) const {
return a.layout_binding->binding < b.layout_binding->binding;
}
};
vvl::DescriptorClass vvl::DescriptorTypeToClass(VkDescriptorType type) {
switch (type) {
case VK_DESCRIPTOR_TYPE_SAMPLER:
return DescriptorClass::PlainSampler;
case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
return DescriptorClass::ImageSampler;
case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
case VK_DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM:
case VK_DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM:
return DescriptorClass::Image;
case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
return DescriptorClass::TexelBuffer;
case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
return DescriptorClass::GeneralBuffer;
case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK:
return DescriptorClass::InlineUniform;
case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
return DescriptorClass::AccelerationStructure;
case VK_DESCRIPTOR_TYPE_MUTABLE_EXT:
return DescriptorClass::Mutable;
case VK_DESCRIPTOR_TYPE_PARTITIONED_ACCELERATION_STRUCTURE_NV:
case VK_DESCRIPTOR_TYPE_TENSOR_ARM:
// TODO
break;
case VK_DESCRIPTOR_TYPE_MAX_ENUM:
break;
}
return DescriptorClass::Invalid;
}
using DescriptorSet = vvl::DescriptorSet;
using DescriptorSetLayout = vvl::DescriptorSetLayout;
using DescriptorSetLayoutDef = vvl::DescriptorSetLayoutDef;
using DescriptorSetLayoutId = vvl::DescriptorSetLayoutId;
// Canonical dictionary of DescriptorSetLayoutDef (without any handle/device specific information)
vvl::DescriptorSetLayoutDict descriptor_set_layout_dict;
DescriptorSetLayoutId GetCanonicalId(const VkDescriptorSetLayoutCreateInfo *p_create_info) {
return descriptor_set_layout_dict.LookUp(DescriptorSetLayoutDef(p_create_info));
}
std::string DescriptorSetLayoutDef::DescribeDifference(uint32_t index, const DescriptorSetLayoutDef &other) const {
std::ostringstream ss;
ss << "Set " << index << " ";
auto lhs_binding_flags = GetBindingFlags();
auto rhs_binding_flags = other.GetBindingFlags();
const auto &lhs_bindings = GetBindings();
const auto &rhs_bindings = other.GetBindings();
if (GetCreateFlags() != other.GetCreateFlags()) {
ss << "VkDescriptorSetLayoutCreateFlags " << string_VkDescriptorSetLayoutCreateFlags(GetCreateFlags()) << " doesn't match "
<< string_VkDescriptorSetLayoutCreateFlags(other.GetCreateFlags());
} else if (lhs_binding_flags.size() != rhs_binding_flags.size()) {
ss << "VkDescriptorSetLayoutBindingFlagsCreateInfo::bindingCount " << lhs_binding_flags.size() << " doesn't match "
<< rhs_binding_flags.size();
} else if (lhs_binding_flags != rhs_binding_flags) {
ss << "VkDescriptorSetLayoutBindingFlagsCreateInfo::pBindingFlags (";
for (auto flag : lhs_binding_flags) {
ss << string_VkDescriptorBindingFlags(flag) << " ";
}
ss << ") doesn't match (";
for (auto flag : rhs_binding_flags) {
ss << string_VkDescriptorBindingFlags(flag) << " ";
}
ss << ")";
} else if (lhs_bindings.size() != rhs_bindings.size()) {
ss << "binding count " << lhs_bindings.size() << " doesn't match " << rhs_bindings.size();
} else {
for (uint32_t i = 0; i < lhs_bindings.size(); i++) {
const auto &l = lhs_bindings[i];
const auto &r = rhs_bindings[i];
if (l.binding != r.binding) {
ss << "VkDescriptorSetLayoutBinding::binding " << l.binding << " doesn't match " << r.binding;
break;
} else if (l.descriptorType != r.descriptorType) {
ss << "binding " << i << " descriptorType " << string_VkDescriptorType(l.descriptorType) << " doesn't match "
<< string_VkDescriptorType(r.descriptorType);
break;
} else if (l.descriptorCount != r.descriptorCount) {
ss << "binding " << i << " descriptorCount " << l.descriptorCount << " doesn't match " << r.descriptorCount;
break;
} else if (l.stageFlags != r.stageFlags) {
ss << "binding " << i << " stageFlags " << string_VkShaderStageFlags(l.stageFlags) << " doesn't match "
<< string_VkShaderStageFlags(r.stageFlags);
break;
} else if (l.pImmutableSamplers != r.pImmutableSamplers) {
ss << "binding " << i << " pImmutableSamplers " << l.pImmutableSamplers << " doesn't match "
<< r.pImmutableSamplers;
break;
} else if (l.pImmutableSamplers) {
for (uint32_t s = 0; s < l.descriptorCount; s++) {
if (l.pImmutableSamplers[s] != r.pImmutableSamplers[s]) {
ss << "binding " << i << " pImmutableSamplers[" << s << "] " << l.pImmutableSamplers[s] << " doesn't match "
<< r.pImmutableSamplers[s];
break;
}
}
} else if (GetMutableTypes(i) != other.GetMutableTypes(i)) {
// These have been sorted already so can direct compare
ss << "Mutable types doesn't match at binding " << i << "\n[" << PrintMutableTypes(i) << "]\ndoesn't match"
<< "\n[" << other.PrintMutableTypes(i) << "]";
}
}
}
ss << '\n';
return ss.str();
}
// Construct DescriptorSetLayout instance from given create info
// Proactively reserve and resize as possible, as the reallocation was visible in profiling
vvl::DescriptorSetLayoutDef::DescriptorSetLayoutDef(const VkDescriptorSetLayoutCreateInfo *p_create_info)
: flags_(p_create_info->flags),
binding_count_(0),
descriptor_count_(0),
non_inline_descriptor_count_(0),
dynamic_descriptor_count_(0),
has_immutable_samplers_(false) {
const auto *flags_create_info = vku::FindStructInPNextChain<VkDescriptorSetLayoutBindingFlagsCreateInfo>(p_create_info->pNext);
binding_type_stats_ = {0, 0};
std::set<ExtendedBinding, BindingNumCmp> sorted_bindings;
const uint32_t input_bindings_count = p_create_info->bindingCount;
// Sort the input bindings in binding number order, eliminating duplicates
for (uint32_t i = 0; i < input_bindings_count; i++) {
VkDescriptorBindingFlags flags = 0;
if (flags_create_info && flags_create_info->bindingCount == p_create_info->bindingCount) {
flags = flags_create_info->pBindingFlags[i];
}
sorted_bindings.emplace(p_create_info->pBindings + i, flags);
}
const auto *mutable_descriptor_type_create_info = vku::FindStructInPNextChain<VkMutableDescriptorTypeCreateInfoEXT>(p_create_info->pNext);
if (mutable_descriptor_type_create_info) {
mutable_types_.resize(mutable_descriptor_type_create_info->mutableDescriptorTypeListCount);
for (uint32_t i = 0; i < mutable_descriptor_type_create_info->mutableDescriptorTypeListCount; ++i) {
const auto &list = mutable_descriptor_type_create_info->pMutableDescriptorTypeLists[i];
mutable_types_[i].reserve(list.descriptorTypeCount);
for (uint32_t j = 0; j < list.descriptorTypeCount; ++j) {
mutable_types_[i].push_back(list.pDescriptorTypes[j]);
}
std::sort(mutable_types_[i].begin(), mutable_types_[i].end());
}
}
// Store the create info in the sorted order from above
uint32_t index = 0;
binding_count_ = static_cast<uint32_t>(sorted_bindings.size());
bindings_.reserve(binding_count_);
binding_flags_.reserve(binding_count_);
binding_to_index_map_.reserve(binding_count_);
for (const auto &input_binding : sorted_bindings) {
// Add to binding and map, s.t. it is robust to invalid duplication of binding_num
const auto binding_num = input_binding.layout_binding->binding;
binding_to_index_map_[binding_num] = index++;
bindings_.emplace_back(input_binding.layout_binding);
// safe_VkDescriptorSetLayoutBinding will do some extra "cleanup" logic, so want to use it
auto &binding_info = bindings_.back();
binding_flags_.emplace_back(input_binding.binding_flags);
descriptor_count_ += binding_info.descriptorCount;
if (binding_info.descriptorCount > 0) {
non_empty_bindings_.insert(binding_num);
}
non_inline_descriptor_count_ +=
(binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK) ? 1 : binding_info.descriptorCount;
if (IsDynamicDescriptor(binding_info.descriptorType)) {
dynamic_descriptor_count_ += binding_info.descriptorCount;
}
// Get stats depending on descriptor type for caching later
if (IsBufferDescriptor(binding_info.descriptorType)) {
if (IsDynamicDescriptor(binding_info.descriptorType)) {
binding_type_stats_.dynamic_buffer_count++;
} else {
binding_type_stats_.non_dynamic_buffer_count++;
}
}
has_immutable_samplers_ |= (binding_info.pImmutableSamplers != nullptr);
}
assert(bindings_.size() == binding_count_);
assert(binding_flags_.size() == binding_count_);
uint32_t global_index = 0;
global_index_range_.reserve(binding_count_);
// Vector order is finalized so build vectors of descriptors and dynamic offsets by binding index
for (uint32_t i = 0; i < binding_count_; ++i) {
auto final_index = global_index + bindings_[i].descriptorCount;
global_index_range_.emplace_back(global_index, final_index);
global_index = final_index;
}
}
size_t vvl::DescriptorSetLayoutDef::hash() const {
hash_util::HashCombiner hc;
hc << flags_;
hc.Combine(bindings_);
hc.Combine(binding_flags_);
return hc.Value();
}
//
// Return valid index or "end" i.e. binding_count_;
// The asserts in "Get" are reduced to the set where no valid answer(like null or 0) could be given
// Common code for all binding lookups.
uint32_t vvl::DescriptorSetLayoutDef::GetIndexFromBinding(uint32_t binding) const {
const auto &bi_itr = binding_to_index_map_.find(binding);
if (bi_itr != binding_to_index_map_.cend()) return bi_itr->second;
return GetBindingCount();
}
VkDescriptorSetLayoutBinding const *vvl::DescriptorSetLayoutDef::GetDescriptorSetLayoutBindingPtrFromIndex(
const uint32_t index) const {
if (index >= bindings_.size()) return nullptr;
return bindings_[index].ptr();
}
// Return descriptorCount for given index, 0 if index is unavailable
uint32_t vvl::DescriptorSetLayoutDef::GetDescriptorCountFromIndex(const uint32_t index) const {
if (index >= bindings_.size()) return 0;
return bindings_[index].descriptorCount;
}
// For the given index, return descriptorType
VkDescriptorType vvl::DescriptorSetLayoutDef::GetTypeFromIndex(const uint32_t index) const {
assert(index < bindings_.size());
if (index < bindings_.size()) return bindings_[index].descriptorType;
return VK_DESCRIPTOR_TYPE_MAX_ENUM;
}
// Return binding flags for given index, 0 if index is unavailable
VkDescriptorBindingFlags vvl::DescriptorSetLayoutDef::GetDescriptorBindingFlagsFromIndex(const uint32_t index) const {
if (index >= binding_flags_.size()) return 0;
return binding_flags_[index];
}
const vvl::IndexRange &vvl::DescriptorSetLayoutDef::GetGlobalIndexRangeFromIndex(uint32_t index) const {
const static IndexRange k_invalid_range = {0xFFFFFFFF, 0xFFFFFFFF};
if (index >= binding_flags_.size()) return k_invalid_range;
return global_index_range_[index];
}
// For the given binding, return the global index range (half open)
// As start and end are often needed in pairs, get both with a single lookup.
const vvl::IndexRange &vvl::DescriptorSetLayoutDef::GetGlobalIndexRangeFromBinding(
const uint32_t binding) const {
uint32_t index = GetIndexFromBinding(binding);
return GetGlobalIndexRangeFromIndex(index);
}
// Move to next valid binding having a non-zero binding count
uint32_t vvl::DescriptorSetLayoutDef::GetNextValidBinding(const uint32_t binding) const {
auto it = non_empty_bindings_.upper_bound(binding);
if (it != non_empty_bindings_.cend()) return *it;
return GetMaxBinding() + 1;
}
// For given index, return ptr to ImmutableSampler array
VkSampler const *vvl::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
if (index < bindings_.size()) {
return bindings_[index].pImmutableSamplers;
}
return nullptr;
}
bool vvl::DescriptorSetLayoutDef::IsTypeMutable(const VkDescriptorType type, uint32_t binding) const {
if (binding < mutable_types_.size()) {
if (mutable_types_[binding].size() > 0) {
for (const auto mutable_type : mutable_types_[binding]) {
if (type == mutable_type) {
return true;
}
}
return false;
}
}
// If mutableDescriptorTypeListCount is zero or if VkMutableDescriptorTypeCreateInfoEXT structure is not included in the pNext
// chain, the VkMutableDescriptorTypeListEXT for each element is considered to be zero or NULL for each member.
return false;
}
std::string vvl::DescriptorSetLayoutDef::PrintMutableTypes(uint32_t binding) const {
if (binding >= mutable_types_.size()) {
return "no Mutable Type list at this binding";
}
std::ostringstream ss;
const auto mutable_types = mutable_types_[binding];
if (mutable_types.empty()) {
ss << "pMutableDescriptorTypeLists is empty";
} else {
for (uint32_t i = 0; i < mutable_types.size(); i++) {
ss << string_VkDescriptorType(mutable_types[i]);
if (i + 1 != mutable_types.size()) {
ss << ", ";
}
}
}
return ss.str();
}
const std::vector<VkDescriptorType> &vvl::DescriptorSetLayoutDef::GetMutableTypes(uint32_t binding) const {
if (binding >= mutable_types_.size()) {
static const std::vector<VkDescriptorType> empty = {};
return empty;
}
return mutable_types_[binding];
}
std::string vvl::DescriptorSetLayoutDef::DescribeDescriptorBufferSizeAndOffests(VkDevice device,
VkDescriptorSetLayout layout) const {
std::ostringstream ss;
if (flags_ & VK_DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT) {
VkDeviceSize size;
DispatchGetDescriptorSetLayoutSizeEXT(device, layout, &size);
ss << "layout total size = " << size << '\n';
for (auto binding : bindings_) {
DispatchGetDescriptorSetLayoutBindingOffsetEXT(device, layout, binding.binding, &size);
ss << " binding " << binding.binding << " offset = " << size << " (" << string_VkDescriptorType(binding.descriptorType)
<< ", descriptorCount = " << binding.descriptorCount;
if (binding.pImmutableSamplers) {
ss << ", embedded sampler";
}
ss << ")\n";
}
}
return ss.str();
}
// If our layout is compatible with rh_ds_layout, return true.
bool vvl::DescriptorSetLayout::IsCompatible(DescriptorSetLayout const *rh_ds_layout) const {
return (this == rh_ds_layout) || (GetLayoutDef() == rh_ds_layout->GetLayoutDef());
}
// The DescriptorSetLayout stores the per handle data for a descriptor set layout, and references the common defintion for the
// handle invariant portion
vvl::DescriptorSetLayout::DescriptorSetLayout(VkDevice device, const VkDescriptorSetLayoutCreateInfo *pCreateInfo,
const VkDescriptorSetLayout handle)
: StateObject(handle, kVulkanObjectTypeDescriptorSetLayout), layout_id_(GetCanonicalId(pCreateInfo)) {
if (pCreateInfo->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT) {
DispatchGetDescriptorSetLayoutSizeEXT(device, handle, &layout_size_in_bytes_);
}
}
vvl::DescriptorSet::DescriptorSet(const VkDescriptorSet handle, vvl::DescriptorPool *pool_state,
const std::shared_ptr<DescriptorSetLayout const> &layout, uint32_t variable_count,
vvl::DeviceState *state_data)
: StateObject(handle, kVulkanObjectTypeDescriptorSet),
some_update_(false),
pool_state_(pool_state),
layout_(layout),
state_data_(state_data),
variable_count_(variable_count),
change_count_(0) {
// Foreach binding, create default descriptors of given type
auto binding_count = layout_->GetBindingCount();
bindings_.reserve(binding_count);
bindings_store_.resize(binding_count);
auto free_binding = bindings_store_.data();
for (uint32_t i = 0; i < binding_count; ++i) {
auto create_info = layout_->GetDescriptorSetLayoutBindingPtrFromIndex(i);
ASSERT_AND_CONTINUE(create_info);
uint32_t descriptor_count = create_info->descriptorCount;
auto flags = layout_->GetDescriptorBindingFlagsFromIndex(i);
if (flags & VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT) {
descriptor_count = variable_count;
}
auto type = layout_->GetTypeFromIndex(i);
auto descriptor_class = DescriptorTypeToClass(type);
switch (descriptor_class) {
case DescriptorClass::PlainSampler: {
auto binding = MakeBinding<SamplerBinding>(free_binding++, *create_info, descriptor_count, flags);
if (auto immutable_sampler_handles = layout_->GetImmutableSamplerPtrFromIndex(i)) {
for (uint32_t di = 0; di < descriptor_count; ++di) {
auto sampler = state_data->GetConstCastShared<vvl::Sampler>(immutable_sampler_handles[di]);
if (sampler) {
some_update_ = true; // Immutable samplers are updated at creation
binding->updated[di] = true;
binding->descriptors[di].SetImmutableSampler(std::move(sampler));
}
}
}
bindings_.push_back(std::move(binding));
break;
}
case DescriptorClass::ImageSampler: {
auto binding = MakeBinding<ImageSamplerBinding>(free_binding++, *create_info, descriptor_count, flags);
if (auto immutable_sampler_handles = layout_->GetImmutableSamplerPtrFromIndex(i)) {
for (uint32_t di = 0; di < descriptor_count; ++di) {
auto sampler = state_data->GetConstCastShared<vvl::Sampler>(immutable_sampler_handles[di]);
if (sampler) {
some_update_ = true; // Immutable samplers are updated at creation
binding->updated[di] = true;
binding->descriptors[di].SetImmutableSampler(std::move(sampler));
}
}
}
bindings_.push_back(std::move(binding));
break;
}
// ImageDescriptors
case DescriptorClass::Image: {
bindings_.push_back(MakeBinding<ImageBinding>(free_binding++, *create_info, descriptor_count, flags));
break;
}
case DescriptorClass::TexelBuffer: {
bindings_.push_back(MakeBinding<TexelBinding>(free_binding++, *create_info, descriptor_count, flags));
break;
}
case DescriptorClass::GeneralBuffer: {
auto binding = MakeBinding<BufferBinding>(free_binding++, *create_info, descriptor_count, flags);
if (IsDynamicDescriptor(type)) {
for (uint32_t di = 0; di < descriptor_count; ++di) {
dynamic_offset_idx_to_descriptor_list_.emplace_back(i, di);
}
}
bindings_.push_back(std::move(binding));
break;
}
case DescriptorClass::InlineUniform: {
bindings_.push_back(MakeBinding<InlineUniformBinding>(free_binding++, *create_info, descriptor_count, flags));
break;
}
case DescriptorClass::AccelerationStructure: {
bindings_.push_back(
MakeBinding<AccelerationStructureBinding>(free_binding++, *create_info, descriptor_count, flags));
break;
}
case DescriptorClass::Mutable: {
bindings_.push_back(MakeBinding<MutableBinding>(free_binding++, *create_info, descriptor_count, flags));
break;
}
case DescriptorClass::Invalid:
assert(false); // Bad descriptor type specified
break;
}
}
}
void vvl::DescriptorSet::LinkChildNodes() {
// Connect child node(s), which cannot safely be done in the constructor.
for (auto &binding : bindings_) {
binding->AddParent(this);
}
}
void vvl::DescriptorSet::NotifyInvalidate(const NodeList &invalid_nodes, bool unlink) {
BaseClass::NotifyInvalidate(invalid_nodes, unlink);
for (auto &binding : bindings_) {
binding->NotifyInvalidate(invalid_nodes, unlink);
}
}
uint32_t vvl::DescriptorSet::GetDynamicOffsetIndexFromBinding(uint32_t dynamic_binding) const {
const uint32_t index = layout_->GetIndexFromBinding(dynamic_binding);
if (index == bindings_.size()) { // binding not found
return vvl::kU32Max;
}
assert(IsDynamicDescriptor(bindings_[index]->type));
uint32_t dynamic_offset_index = 0;
for (uint32_t i = 0; i < index; i++) {
if (IsDynamicDescriptor(bindings_[i]->type)) {
dynamic_offset_index += bindings_[i]->count;
}
}
return dynamic_offset_index;
}
std::pair<uint32_t, uint32_t> vvl::DescriptorSet::GetBindingAndIndex(const uint32_t global_descriptor_index) const {
uint32_t current_offset = 0;
for (const auto &binding_state : bindings_) {
const uint32_t binding_index = binding_state->binding;
// maps to BuildBindingLayouts()
const uint32_t count = (binding_state->type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK) ? 1 : binding_state->count;
if ((current_offset + count) > global_descriptor_index) {
const uint32_t descriptor_index = global_descriptor_index - current_offset;
return {binding_index, descriptor_index};
}
current_offset += count; // keep searching
}
assert(false);
return {0, 0};
}
void vvl::DescriptorSet::Destroy() {
for (auto &binding : bindings_) {
binding->RemoveParent(this);
}
StateObject::Destroy();
}
// Will let things like GPU-AV know descriptor sets are updated
void vvl::DescriptorSet::NotifyUpdate() {
for (auto &item : sub_states_) {
item.second->NotifyUpdate();
}
}
// Loop through the write updates to do for a push descriptor set, ignoring dstSet
void vvl::DescriptorSet::PerformPushDescriptorsUpdate(uint32_t write_count, const VkWriteDescriptorSet *write_descs) {
assert(IsPushDescriptor());
for (uint32_t i = 0; i < write_count; i++) {
PerformWriteUpdate(write_descs[i]);
}
push_descriptor_set_writes.clear();
push_descriptor_set_writes.reserve(static_cast<std::size_t>(write_count));
for (uint32_t i = 0; i < write_count; i++) {
push_descriptor_set_writes.push_back(vku::safe_VkWriteDescriptorSet(&write_descs[i]));
}
NotifyUpdate();
}
// Perform write update in given update struct
void vvl::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet &update) {
// Perform update on a per-binding basis as consecutive updates roll over to next binding
auto descriptors_remaining = update.descriptorCount;
auto iter = FindDescriptor(update.dstBinding, update.dstArrayElement);
ASSERT_AND_RETURN(iter.IsValid());
auto &orig_binding = iter.CurrentBinding();
// Verify next consecutive binding matches type, stage flags & immutable sampler use and if AtEnd
for (uint32_t i = 0; i < descriptors_remaining; ++i, ++iter) {
if (iter.AtEnd() || !orig_binding.IsConsistent(iter.CurrentBinding())) {
break;
}
iter->WriteUpdate(*this, *state_data_, update, i, IsBindless(iter.CurrentBinding().binding_flags));
iter.updated(true);
}
if (update.descriptorCount) {
some_update_ = true;
++change_count_;
}
if (!IsPushDescriptor() && !(orig_binding.binding_flags & (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT |
VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT))) {
Invalidate(false);
}
NotifyUpdate();
}
// Perform Copy update
void vvl::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet &update, const DescriptorSet &src_set) {
auto src_iter = src_set.FindDescriptor(update.srcBinding, update.srcArrayElement);
auto dst_iter = FindDescriptor(update.dstBinding, update.dstArrayElement);
ASSERT_AND_RETURN(src_iter.IsValid() && dst_iter.IsValid());
// Update parameters all look good so perform update
for (uint32_t i = 0; i < update.descriptorCount; ++i, ++src_iter, ++dst_iter) {
auto &src = *src_iter;
auto &dst = *dst_iter;
if (src_iter.updated()) {
auto type = src_iter.CurrentBinding().type;
if (type == VK_DESCRIPTOR_TYPE_MUTABLE_EXT) {
const auto &mutable_src = static_cast<const MutableDescriptor &>(src);
type = mutable_src.ActiveType();
}
dst.CopyUpdate(*this, *state_data_, src, IsBindless(src_iter.CurrentBinding().binding_flags), type);
some_update_ = true;
++change_count_;
dst_iter.updated(true);
} else {
dst_iter.updated(false);
}
}
if (!(layout_->GetDescriptorBindingFlagsFromBinding(update.dstBinding) &
(VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT))) {
Invalidate(false);
}
NotifyUpdate();
}
// Update the drawing state for the affected descriptors.
// Set cb_state to this set and this set to cb_state.
// Add the bindings of the descriptor
// Set the layout based on the current descriptor layout (will mask subsequent layer mismatch errors)
// TODO: Modify the UpdateImageLayoutDrawState virtural functions to *only* set initial layout and not change layouts
// Prereq: This should be called for a set that has been confirmed to be active for the given cb_state, meaning it's going
// to be used in a draw by the given cb_state
void vvl::DescriptorSet::UpdateImageLayoutDrawStates(vvl::DeviceState *device_data, vvl::CommandBuffer &cb_state,
const BindingVariableMap &binding_req_map) {
// Descriptor UpdateImageLayoutDrawState only call image layout validation callbacks. If it is disabled, skip the entire loop.
if (device_data->disabled[image_layout_validation]) return;
// For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
// resources
for (const auto &binding_req_pair : binding_req_map) {
auto *binding = GetBinding(binding_req_pair.first);
ASSERT_AND_CONTINUE(binding);
// core validation doesn't handle descriptor indexing, that is only done by GPU-AV
if (ValidateBindingOnGPU(*binding, *binding_req_pair.second.variable)) {
continue;
}
switch (binding->descriptor_class) {
case DescriptorClass::Image: {
auto *image_binding = static_cast<ImageBinding *>(binding);
for (uint32_t i = 0; i < image_binding->count; ++i) {
image_binding->descriptors[i].UpdateImageLayoutDrawState(cb_state);
}
break;
}
case DescriptorClass::ImageSampler: {
auto *image_binding = static_cast<ImageSamplerBinding *>(binding);
for (uint32_t i = 0; i < image_binding->count; ++i) {
image_binding->descriptors[i].UpdateImageLayoutDrawState(cb_state);
}
break;
}
case DescriptorClass::Mutable: {
auto *mutable_binding = static_cast<MutableBinding *>(binding);
for (uint32_t i = 0; i < mutable_binding->count; ++i) {
mutable_binding->descriptors[i].UpdateImageLayoutDrawState(cb_state);
}
break;
}
default:
break;
}
}
}
// This is used to decide if we should validate the Descirptors on the CPU or GPU-AV
bool vvl::DescriptorSet::ValidateBindingOnGPU(const DescriptorBinding &binding,
const spirv::ResourceInterfaceVariable &variable) const {
// Some applications (notably Doom Eternal) might have large non-bindless descriptors attached (basically doing Descriptor
// Indexing without the extension). Trying to loop through these on the CPU will bring FPS down by over 50% so we make use of
// the post processing to detect which descriptors were actually accessed
static constexpr uint32_t max_descriptor_on_cpu = 1024;
if (GetNonInlineDescriptorCount() > max_descriptor_on_cpu) {
// If too much CPU work
return true;
} else if (IsBindless(binding.binding_flags)) {
// If flags allow descriptor to be "bindless" (can be invalid up until submit time)
return true;
} else if (variable.is_runtime_descriptor_array) {
// We don't know where OOB is on the CPU
return true;
}
return false;
}
// Helper template to change shared pointer members of a Descriptor, while
// correctly managing links to the parent DescriptorSet.
// src and dst are shared pointers.
template <typename T>
static void ReplaceStatePtr(DescriptorSet &set_state, T &dst, const T &src, bool is_bindless) {
if (dst && !is_bindless) {
dst->RemoveParent(&set_state);
}
dst = src;
// For descriptor bindings with UPDATE_AFTER_BIND or PARTIALLY_BOUND only set the object as a child, but not the descriptor as a
// parent, so that destroying the object wont invalidate the descriptor
if (dst && !is_bindless) {
dst->AddParent(&set_state);
}
}
void vvl::SamplerDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
if (!immutable_ && update.pImageInfo) {
ReplaceStatePtr(set_state, sampler_state_, dev_data.GetConstCastShared<vvl::Sampler>(update.pImageInfo[index].sampler),
is_bindless);
}
}
void vvl::SamplerDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data, const Descriptor &src,
bool is_bindless, VkDescriptorType) {
if (src.GetClass() == DescriptorClass::Mutable) {
auto &sampler_src = static_cast<const MutableDescriptor &>(src);
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, sampler_src.GetSharedSamplerState(), is_bindless);
}
return;
}
auto &sampler_src = static_cast<const SamplerDescriptor &>(src);
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, sampler_src.sampler_state_, is_bindless);
}
}
VkSampler vvl::SamplerDescriptor::GetSampler() const { return sampler_state_ ? sampler_state_->VkHandle() : VK_NULL_HANDLE; }
void vvl::SamplerDescriptor::SetImmutableSampler(std::shared_ptr<vvl::Sampler> &&state) {
sampler_state_ = std::move(state);
immutable_ = true;
}
bool vvl::SamplerDescriptor::AddParent(StateObject *state_object) {
bool result = false;
if (sampler_state_) {
result = sampler_state_->AddParent(state_object);
}
return result;
}
void vvl::SamplerDescriptor::RemoveParent(StateObject *state_object) {
if (sampler_state_) {
sampler_state_->RemoveParent(state_object);
}
}
bool vvl::SamplerDescriptor::Invalid() const { return !sampler_state_ || sampler_state_->Invalid(); }
void vvl::ImageSamplerDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
if (!update.pImageInfo) return;
const auto &image_info = update.pImageInfo[index];
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, dev_data.GetConstCastShared<vvl::Sampler>(image_info.sampler), is_bindless);
}
image_layout_ = image_info.imageLayout;
ReplaceStatePtr(set_state, image_view_state_, dev_data.GetConstCastShared<vvl::ImageView>(image_info.imageView), is_bindless);
UpdateKnownValidView(is_bindless);
}
void vvl::ImageSamplerDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data, const Descriptor &src,
bool is_bindless, VkDescriptorType src_type) {
if (src.GetClass() == DescriptorClass::Mutable) {
auto &image_src = static_cast<const MutableDescriptor &>(src);
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, image_src.GetSharedSamplerState(), is_bindless);
}
ImageDescriptor::CopyUpdate(set_state, dev_data, src, is_bindless, src_type);
return;
}
auto &image_src = static_cast<const ImageSamplerDescriptor &>(src);
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, image_src.sampler_state_, is_bindless);
}
ImageDescriptor::CopyUpdate(set_state, dev_data, src, is_bindless, src_type);
}
VkSampler vvl::ImageSamplerDescriptor::GetSampler() const { return sampler_state_ ? sampler_state_->VkHandle() : VK_NULL_HANDLE; }
void vvl::ImageSamplerDescriptor::SetImmutableSampler(std::shared_ptr<vvl::Sampler> &&state) {
sampler_state_ = std::move(state);
immutable_ = true;
}
bool vvl::ImageSamplerDescriptor::AddParent(StateObject *state_object) {
bool result = ImageDescriptor::AddParent(state_object);
if (sampler_state_) {
result |= sampler_state_->AddParent(state_object);
}
return result;
}
void vvl::ImageSamplerDescriptor::RemoveParent(StateObject *state_object) {
ImageDescriptor::RemoveParent(state_object);
if (sampler_state_) {
sampler_state_->RemoveParent(state_object);
}
}
bool vvl::ImageSamplerDescriptor::Invalid() const {
return ImageDescriptor::Invalid() || !sampler_state_ || sampler_state_->Invalid();
}
void vvl::ImageDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
if (!update.pImageInfo) return;
const auto &image_info = update.pImageInfo[index];
image_layout_ = image_info.imageLayout;
ReplaceStatePtr(set_state, image_view_state_, dev_data.GetConstCastShared<vvl::ImageView>(image_info.imageView), is_bindless);
UpdateKnownValidView(is_bindless);
}
void vvl::ImageDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data, const Descriptor &src,
bool is_bindless, VkDescriptorType src_type) {
if (src.GetClass() == DescriptorClass::Mutable) {
auto &image_src = static_cast<const MutableDescriptor &>(src);
image_layout_ = image_src.GetImageLayout();
ReplaceStatePtr(set_state, image_view_state_, image_src.GetSharedImageViewState(), is_bindless);
UpdateKnownValidView(is_bindless);
return;
}
auto &image_src = static_cast<const ImageDescriptor &>(src);
image_layout_ = image_src.image_layout_;
ReplaceStatePtr(set_state, image_view_state_, image_src.image_view_state_, is_bindless);
UpdateKnownValidView(is_bindless);
}
void vvl::ImageDescriptor::UpdateImageLayoutDrawState(vvl::CommandBuffer &cb_state) {
// Add binding for image
if (auto iv_state = GetImageViewState()) {
cb_state.TrackImageViewFirstLayout(*iv_state, image_layout_);
}
}
VkImageView vvl::ImageDescriptor::GetImageView() const {
return image_view_state_ ? image_view_state_->VkHandle() : VK_NULL_HANDLE;
}
bool vvl::ImageDescriptor::AddParent(StateObject *state_object) {
bool result = false;
if (image_view_state_) {
result = image_view_state_->AddParent(state_object);
}
return result;
}
void vvl::ImageDescriptor::RemoveParent(StateObject *state_object) {
if (image_view_state_) {
image_view_state_->RemoveParent(state_object);
}
}
void vvl::ImageDescriptor::InvalidateNode(const std::shared_ptr<StateObject> &invalid_node, bool unlink) {
if (invalid_node == image_view_state_) {
known_valid_view_ = false;
if (unlink) {
image_view_state_.reset();
}
}
}
bool vvl::ImageDescriptor::Invalid() const { return !known_valid_view_ && ComputeInvalid(); }
bool vvl::ImageDescriptor::ComputeInvalid() const { return !image_view_state_ || image_view_state_->Invalid(); }
void vvl::ImageDescriptor::UpdateKnownValidView(bool is_bindless) { known_valid_view_ = !is_bindless && !ComputeInvalid(); }
void vvl::BufferDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
const auto &buffer_info = update.pBufferInfo[index];
offset_ = buffer_info.offset;
range_ = buffer_info.range;
auto buffer_state = dev_data.GetConstCastShared<vvl::Buffer>(buffer_info.buffer);
ReplaceStatePtr(set_state, buffer_state_, buffer_state, is_bindless);
}
void vvl::BufferDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data, const Descriptor &src,
bool is_bindless, VkDescriptorType src_type) {
if (src.GetClass() == DescriptorClass::Mutable) {
const auto &buff_desc = static_cast<const MutableDescriptor &>(src);
offset_ = buff_desc.GetOffset();
range_ = buff_desc.GetRange();
ReplaceStatePtr(set_state, buffer_state_, buff_desc.GetSharedBufferState(), is_bindless);
return;
}
const auto &buff_desc = static_cast<const BufferDescriptor &>(src);
offset_ = buff_desc.offset_;
range_ = buff_desc.range_;
ReplaceStatePtr(set_state, buffer_state_, buff_desc.buffer_state_, is_bindless);
}
VkBuffer vvl::BufferDescriptor::GetBuffer() const { return buffer_state_ ? buffer_state_->VkHandle() : VK_NULL_HANDLE; }
bool vvl::BufferDescriptor::AddParent(StateObject *state_object) {
bool result = false;
if (buffer_state_) {
result = buffer_state_->AddParent(state_object);
}
return result;
}
void vvl::BufferDescriptor::RemoveParent(StateObject *state_object) {
if (buffer_state_) {
buffer_state_->RemoveParent(state_object);
}
}
bool vvl::BufferDescriptor::Invalid() const { return !buffer_state_ || buffer_state_->Invalid(); }
VkDeviceSize vvl::BufferDescriptor::GetEffectiveRange() const {
// The buffer can be null if using nullDescriptors, if that is the case, the size/range will not be accessed
if (range_ == VK_WHOLE_SIZE && buffer_state_) {
// When range is VK_WHOLE_SIZE the effective range is calculated at vkUpdateDescriptorSets is by taking the size of buffer
// minus the offset.
return buffer_state_->create_info.size - offset_;
} else {
return range_;
}
}
void vvl::TexelDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
auto buffer_view = dev_data.GetConstCastShared<vvl::BufferView>(update.pTexelBufferView[index]);
ReplaceStatePtr(set_state, buffer_view_state_, buffer_view, is_bindless);
}
void vvl::TexelDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data, const Descriptor &src,
bool is_bindless, VkDescriptorType src_type) {
if (src.GetClass() == DescriptorClass::Mutable) {
ReplaceStatePtr(set_state, buffer_view_state_, static_cast<const MutableDescriptor &>(src).GetSharedBufferViewState(),
is_bindless);
return;
}
ReplaceStatePtr(set_state, buffer_view_state_, static_cast<const TexelDescriptor &>(src).buffer_view_state_, is_bindless);
}
VkBufferView vvl::TexelDescriptor::GetBufferView() const {
return buffer_view_state_ ? buffer_view_state_->VkHandle() : VK_NULL_HANDLE;
}
bool vvl::TexelDescriptor::AddParent(StateObject *state_object) {
bool result = false;
if (buffer_view_state_) {
result = buffer_view_state_->AddParent(state_object);
}
return result;
}
void vvl::TexelDescriptor::RemoveParent(StateObject *state_object) {
if (buffer_view_state_) {
buffer_view_state_->RemoveParent(state_object);
}
}
bool vvl::TexelDescriptor::Invalid() const { return !buffer_view_state_ || buffer_view_state_->Invalid(); }
void vvl::AccelerationStructureDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
const auto *acc_info = vku::FindStructInPNextChain<VkWriteDescriptorSetAccelerationStructureKHR>(update.pNext);
const auto *acc_info_nv = vku::FindStructInPNextChain<VkWriteDescriptorSetAccelerationStructureNV>(update.pNext);
assert(acc_info || acc_info_nv);
is_khr_ = (acc_info != NULL);
if (is_khr_) {
acc_ = acc_info->pAccelerationStructures[index];
ReplaceStatePtr(set_state, acc_state_, dev_data.GetConstCastShared<vvl::AccelerationStructureKHR>(acc_), is_bindless);
} else {
acc_nv_ = acc_info_nv->pAccelerationStructures[index];
ReplaceStatePtr(set_state, acc_state_nv_, dev_data.GetConstCastShared<vvl::AccelerationStructureNV>(acc_nv_), is_bindless);
}
}
void vvl::AccelerationStructureDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const Descriptor &src, bool is_bindless, VkDescriptorType src_type) {
if (src.GetClass() == DescriptorClass::Mutable) {
auto &acc_desc = static_cast<const MutableDescriptor &>(src);
is_khr_ = acc_desc.IsAccelerationStructureKHR();
if (is_khr_) {
acc_ = acc_desc.GetAccelerationStructureKHR();
ReplaceStatePtr(set_state, acc_state_, dev_data.GetConstCastShared<vvl::AccelerationStructureKHR>(acc_), is_bindless);
} else {
acc_nv_ = acc_desc.GetAccelerationStructureNV();
ReplaceStatePtr(set_state, acc_state_nv_, dev_data.GetConstCastShared<vvl::AccelerationStructureNV>(acc_nv_),
is_bindless);
}
return;
}
auto acc_desc = static_cast<const AccelerationStructureDescriptor &>(src);
is_khr_ = acc_desc.is_khr_;
if (is_khr_) {
acc_ = acc_desc.acc_;
ReplaceStatePtr(set_state, acc_state_, dev_data.GetConstCastShared<vvl::AccelerationStructureKHR>(acc_), is_bindless);
} else {
acc_nv_ = acc_desc.acc_nv_;
ReplaceStatePtr(set_state, acc_state_nv_, dev_data.GetConstCastShared<vvl::AccelerationStructureNV>(acc_nv_), is_bindless);
}
}
bool vvl::AccelerationStructureDescriptor::AddParent(StateObject *state_object) {
bool result = false;
if (acc_state_) {
result |= acc_state_->AddParent(state_object);
}
if (acc_state_nv_) {
result |= acc_state_nv_->AddParent(state_object);
}
return result;
}
void vvl::AccelerationStructureDescriptor::RemoveParent(StateObject *state_object) {
if (acc_state_) {
acc_state_->RemoveParent(state_object);
}
if (acc_state_nv_) {
acc_state_nv_->RemoveParent(state_object);
}
}
bool vvl::AccelerationStructureDescriptor::Invalid() const {
if (is_khr_) {
return !acc_state_ || acc_state_->Invalid();
} else {
return !acc_state_nv_ || acc_state_nv_->Invalid();
}
}
vvl::MutableDescriptor::MutableDescriptor()
: Descriptor(),
buffer_size_(0),
active_descriptor_type_(VK_DESCRIPTOR_TYPE_MUTABLE_EXT),
immutable_(false),
image_layout_(VK_IMAGE_LAYOUT_UNDEFINED),
offset_(0),
range_(0),
is_khr_(false),
acc_(VK_NULL_HANDLE) {}
void vvl::MutableDescriptor::WriteUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data,
const VkWriteDescriptorSet &update, const uint32_t index, bool is_bindless) {
VkDeviceSize buffer_size = 0;
switch (DescriptorTypeToClass(update.descriptorType)) {
case DescriptorClass::PlainSampler:
if (!immutable_ && update.pImageInfo) {
ReplaceStatePtr(set_state, sampler_state_,
dev_data.GetConstCastShared<vvl::Sampler>(update.pImageInfo[index].sampler), is_bindless);
}
break;
case DescriptorClass::ImageSampler: {
if (update.pImageInfo) {
const auto &image_info = update.pImageInfo[index];
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, dev_data.GetConstCastShared<vvl::Sampler>(image_info.sampler),
is_bindless);
}
image_layout_ = image_info.imageLayout;
ReplaceStatePtr(set_state, image_view_state_, dev_data.GetConstCastShared<vvl::ImageView>(image_info.imageView),
is_bindless);
}
break;
}
case DescriptorClass::Image: {
if (update.pImageInfo) {
const auto &image_info = update.pImageInfo[index];
image_layout_ = image_info.imageLayout;
ReplaceStatePtr(set_state, image_view_state_, dev_data.GetConstCastShared<vvl::ImageView>(image_info.imageView),
is_bindless);
}
break;
}
case DescriptorClass::GeneralBuffer: {
if (update.pBufferInfo) {
const auto &buffer_info = update.pBufferInfo[index];
offset_ = buffer_info.offset;
range_ = buffer_info.range;
// can be null if using nullDescriptors
const auto buffer_state = dev_data.GetConstCastShared<vvl::Buffer>(update.pBufferInfo->buffer);
if (buffer_state) {
buffer_size = buffer_state->create_info.size;
}
ReplaceStatePtr(set_state, buffer_state_, buffer_state, is_bindless);
}
break;
}
case DescriptorClass::TexelBuffer: {
if (update.pTexelBufferView) {
// can be null if using nullDescriptors
const auto buffer_view = dev_data.GetConstCastShared<vvl::BufferView>(update.pTexelBufferView[index]);
if (buffer_view) {
buffer_size = buffer_view->buffer_state->create_info.size;
}
ReplaceStatePtr(set_state, buffer_view_state_, buffer_view, is_bindless);
}
break;
}
case DescriptorClass::AccelerationStructure: {
const auto *acc_info = vku::FindStructInPNextChain<VkWriteDescriptorSetAccelerationStructureKHR>(update.pNext);
const auto *acc_info_nv = vku::FindStructInPNextChain<VkWriteDescriptorSetAccelerationStructureNV>(update.pNext);
assert(acc_info || acc_info_nv);
is_khr_ = (acc_info != NULL);
if (is_khr_) {
acc_ = acc_info->pAccelerationStructures[index];
ReplaceStatePtr(set_state, acc_state_, dev_data.GetConstCastShared<vvl::AccelerationStructureKHR>(acc_),
is_bindless);
} else {
acc_nv_ = acc_info_nv->pAccelerationStructures[index];
ReplaceStatePtr(set_state, acc_state_nv_, dev_data.GetConstCastShared<vvl::AccelerationStructureNV>(acc_nv_),
is_bindless);
}
break;
}
case DescriptorClass::InlineUniform:
case DescriptorClass::Mutable:
case DescriptorClass::Invalid:
break;
}
SetDescriptorType(update.descriptorType, buffer_size);
}
void vvl::MutableDescriptor::CopyUpdate(DescriptorSet &set_state, const vvl::DeviceState &dev_data, const Descriptor &src,
bool is_bindless, VkDescriptorType src_type) {
VkDeviceSize buffer_size = 0;
switch (src.GetClass()) {
case DescriptorClass::PlainSampler: {
auto &sampler_src = static_cast<const SamplerDescriptor &>(src);
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, sampler_src.GetSharedSamplerState(), is_bindless);
}
break;
}
case DescriptorClass::ImageSampler: {
auto &image_src = static_cast<const ImageSamplerDescriptor &>(src);
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, image_src.GetSharedSamplerState(), is_bindless);
}
image_layout_ = image_src.GetImageLayout();
ReplaceStatePtr(set_state, image_view_state_, image_src.GetSharedImageViewState(), is_bindless);
break;
}
case DescriptorClass::Image: {
auto &image_src = static_cast<const ImageDescriptor &>(src);
image_layout_ = image_src.GetImageLayout();
ReplaceStatePtr(set_state, image_view_state_, image_src.GetSharedImageViewState(), is_bindless);
break;
}
case DescriptorClass::TexelBuffer: {
ReplaceStatePtr(set_state, buffer_view_state_, static_cast<const TexelDescriptor &>(src).GetSharedBufferViewState(),
is_bindless);
buffer_size = buffer_view_state_ ? buffer_view_state_->Size() : vvl::kU32Max;
break;
}
case DescriptorClass::GeneralBuffer: {
const auto buff_desc = static_cast<const BufferDescriptor &>(src);
offset_ = buff_desc.GetOffset();
range_ = buff_desc.GetRange();
ReplaceStatePtr(set_state, buffer_state_, buff_desc.GetSharedBufferState(), is_bindless);
buffer_size = range_;
break;
}
case DescriptorClass::AccelerationStructure: {
auto &acc_desc = static_cast<const AccelerationStructureDescriptor &>(src);
if (is_khr_) {
acc_ = acc_desc.GetAccelerationStructure();
ReplaceStatePtr(set_state, acc_state_, dev_data.GetConstCastShared<vvl::AccelerationStructureKHR>(acc_),
is_bindless);
} else {
acc_nv_ = acc_desc.GetAccelerationStructureNV();
ReplaceStatePtr(set_state, acc_state_nv_, dev_data.GetConstCastShared<vvl::AccelerationStructureNV>(acc_nv_),
is_bindless);
}
break;
}
case DescriptorClass::Mutable: {
const auto &mutable_src = static_cast<const MutableDescriptor &>(src);
auto active_class = DescriptorTypeToClass(mutable_src.ActiveType());
switch (active_class) {
case DescriptorClass::PlainSampler: {
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, mutable_src.GetSharedSamplerState(), is_bindless);
}
} break;
case DescriptorClass::ImageSampler: {
if (!immutable_) {
ReplaceStatePtr(set_state, sampler_state_, mutable_src.GetSharedSamplerState(), is_bindless);
}
image_layout_ = mutable_src.GetImageLayout();
ReplaceStatePtr(set_state, image_view_state_, mutable_src.GetSharedImageViewState(), is_bindless);
} break;
case DescriptorClass::Image: {
image_layout_ = mutable_src.GetImageLayout();
ReplaceStatePtr(set_state, image_view_state_, mutable_src.GetSharedImageViewState(), is_bindless);
} break;
case DescriptorClass::GeneralBuffer: {
offset_ = mutable_src.GetOffset();
range_ = mutable_src.GetRange();
ReplaceStatePtr(set_state, buffer_state_, mutable_src.GetSharedBufferState(), is_bindless);
} break;
case DescriptorClass::TexelBuffer: {
ReplaceStatePtr(set_state, buffer_view_state_, mutable_src.GetSharedBufferViewState(), is_bindless);
} break;
case DescriptorClass::AccelerationStructure: {
if (mutable_src.IsKHR()) {
acc_ = mutable_src.GetAccelerationStructureKHR();
ReplaceStatePtr(set_state, acc_state_, dev_data.GetConstCastShared<vvl::AccelerationStructureKHR>(acc_),
is_bindless);
} else {
acc_nv_ = mutable_src.GetAccelerationStructureNV();
ReplaceStatePtr(set_state, acc_state_nv_,
dev_data.GetConstCastShared<vvl::AccelerationStructureNV>(acc_nv_), is_bindless);
}
} break;
case DescriptorClass::InlineUniform:
case DescriptorClass::Mutable:
case DescriptorClass::Invalid:
break;
}
buffer_size = mutable_src.GetBufferSize();
break;
}
case vvl::DescriptorClass::InlineUniform:
case vvl::DescriptorClass::Invalid:
break;
}
SetDescriptorType(src_type, buffer_size);
}
void vvl::MutableDescriptor::SetDescriptorType(VkDescriptorType type, VkDeviceSize buffer_size) {
active_descriptor_type_ = type;
buffer_size_ = buffer_size;
}
VkDeviceSize vvl::MutableDescriptor::GetEffectiveRange() const {
// The buffer can be null if using nullDescriptors, if that is the case, the size/range will not be accessed
if (range_ == VK_WHOLE_SIZE && buffer_state_) {
// When range is VK_WHOLE_SIZE the effective range is calculated at vkUpdateDescriptorSets is by taking the size of buffer
// minus the offset.
return buffer_state_->create_info.size - offset_;
} else {
return range_;
}
}
void vvl::MutableDescriptor::UpdateImageLayoutDrawState(vvl::CommandBuffer &cb_state) {
const vvl::DescriptorClass active_class = ActiveClass();
if (active_class == DescriptorClass::Image || active_class == DescriptorClass::ImageSampler) {
if (image_view_state_) {
cb_state.TrackImageViewFirstLayout(*image_view_state_, image_layout_);
}
}
}
bool vvl::MutableDescriptor::AddParent(StateObject *state_object) {
bool result = false;
const vvl::DescriptorClass active_class = ActiveClass();
switch (active_class) {
case DescriptorClass::PlainSampler:
if (sampler_state_) {
result |= sampler_state_->AddParent(state_object);
}
break;
case DescriptorClass::ImageSampler:
if (sampler_state_) {
result |= sampler_state_->AddParent(state_object);
}
if (image_view_state_) {
result = image_view_state_->AddParent(state_object);
}
break;
case DescriptorClass::TexelBuffer:
if (buffer_view_state_) {
result = buffer_view_state_->AddParent(state_object);
}
break;
case DescriptorClass::Image:
if (image_view_state_) {
result = image_view_state_->AddParent(state_object);
}
break;
case DescriptorClass::GeneralBuffer:
if (buffer_state_) {
result = buffer_state_->AddParent(state_object);
}
break;
case DescriptorClass::AccelerationStructure:
if (acc_state_) {
result |= acc_state_->AddParent(state_object);
}
if (acc_state_nv_) {
result |= acc_state_nv_->AddParent(state_object);
}
break;
case DescriptorClass::InlineUniform:
case DescriptorClass::Mutable:
case DescriptorClass::Invalid:
break;
}
return result;
}
void vvl::MutableDescriptor::RemoveParent(StateObject *state_object) {
if (sampler_state_) {
sampler_state_->RemoveParent(state_object);
}
if (image_view_state_) {
image_view_state_->RemoveParent(state_object);
}
if (buffer_view_state_) {
buffer_view_state_->RemoveParent(state_object);
}
if (buffer_state_) {
buffer_state_->RemoveParent(state_object);
}
if (acc_state_) {
acc_state_->RemoveParent(state_object);
}
if (acc_state_nv_) {
acc_state_nv_->RemoveParent(state_object);
}
}
bool vvl::MutableDescriptor::Invalid() const {
switch (ActiveClass()) {
case DescriptorClass::PlainSampler:
return !sampler_state_ || sampler_state_->Destroyed();
case DescriptorClass::ImageSampler:
return !sampler_state_ || sampler_state_->Invalid() || !image_view_state_ || image_view_state_->Invalid();
case DescriptorClass::TexelBuffer:
return !buffer_view_state_ || buffer_view_state_->Invalid();
case DescriptorClass::Image:
return !image_view_state_ || image_view_state_->Invalid();
case DescriptorClass::GeneralBuffer:
return !buffer_state_ || buffer_state_->Invalid();
case DescriptorClass::AccelerationStructure:
if (is_khr_) {
return !acc_state_ || acc_state_->Invalid();
} else {
return !acc_state_nv_ || acc_state_nv_->Invalid();
}
case DescriptorClass::InlineUniform:
case DescriptorClass::Mutable:
case DescriptorClass::Invalid:
break;
}
return false;
}
std::string vvl::DslErrorSource::PrintMessage(const Logger &error_logger) const {
std::stringstream msg;
msg << "The VkDescriptorSetLayout was used to ";
if (pipeline_layout_handle_ == VK_NULL_HANDLE) {
msg << "allocate " << error_logger.FormatHandle(ds_handle_);
} else {
msg << "create " << error_logger.FormatHandle(pipeline_layout_handle_) << " at pSetLayouts[" << set_ << "]";
}
msg << "";
return msg.str();
}
|