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 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
|
/* 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.
* Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
* Modifications Copyright (C) 2022 RasterGrid Kft.
*
* 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/cmd_buffer_state.h"
#include <vulkan/vulkan_core.h>
#include <vulkan/utility/vk_format_utils.h>
#include "error_message/error_location.h"
#include "state_tracker/descriptor_sets.h"
#include "state_tracker/last_bound_state.h"
#include "state_tracker/render_pass_state.h"
#include "state_tracker/pipeline_state.h"
#include "state_tracker/buffer_state.h"
#include "state_tracker/image_state.h"
#include "state_tracker/queue_state.h"
#include "utils/assert_utils.h"
using RangeGenerator = subresource_adapter::RangeGenerator;
static ShaderObjectStage inline ConvertToShaderObjectStage(VkShaderStageFlagBits stage) {
if (stage == VK_SHADER_STAGE_VERTEX_BIT) return ShaderObjectStage::VERTEX;
if (stage == VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT) return ShaderObjectStage::TESSELLATION_CONTROL;
if (stage == VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT) return ShaderObjectStage::TESSELLATION_EVALUATION;
if (stage == VK_SHADER_STAGE_GEOMETRY_BIT) return ShaderObjectStage::GEOMETRY;
if (stage == VK_SHADER_STAGE_FRAGMENT_BIT) return ShaderObjectStage::FRAGMENT;
if (stage == VK_SHADER_STAGE_COMPUTE_BIT) return ShaderObjectStage::COMPUTE;
if (stage == VK_SHADER_STAGE_TASK_BIT_EXT) return ShaderObjectStage::TASK;
if (stage == VK_SHADER_STAGE_MESH_BIT_EXT) return ShaderObjectStage::MESH;
assert(false);
return ShaderObjectStage::LAST;
}
// For Traditional RenderPasses, the index is simply the index into the VkRenderPassCreateInfo::pAttachments,
// but for dynamic rendering, there is no "standard" way to map the index, instead we have our own custom indexing and it is not
// obvious at all to the user where it came from
std::string AttachmentInfo::Describe(AttachmentSource source, uint32_t index) const {
std::ostringstream ss;
auto type_string = [](Type type) {
switch (type) {
case Type::Input:
return "Input";
case Type::Color:
return "Color";
case Type::ColorResolve:
return "Color Resolve";
case Type::DepthStencil:
return "Depth Stencil";
case Type::Depth:
return "Depth";
case Type::DepthResolve:
return "Depth Resolve";
case Type::Stencil:
return "Stencil";
case Type::StencilResolve:
return "Stencil Resolve";
case Type::FragmentDensityMap:
return "Fragment Density Map";
case Type::FragmentShadingRate:
return "Fragment Shading Rate";
default:
break;
}
return "Unknown Type";
};
if (source == AttachmentSource::DynamicRendering) {
ss << "VkRenderingInfo::";
if (type == Type::Color) {
ss << "pColorAttachments[" << index << "].imageView";
} else if (type == Type::ColorResolve) {
// This assumes the caller calculated the correct index with GetDynamicRenderingColorResolveAttachmentIndex
ss << "pColorAttachments[" << index << "].resolveImageView";
} else if (type == Type::Depth) {
ss << "pDepthAttachment.imageView";
} else if (type == Type::DepthResolve) {
ss << "pStencilAttachment.resolveImageView";
} else if (type == Type::Stencil) {
ss << "pDepthAttachment.imageView";
} else if (type == Type::StencilResolve) {
ss << "pStencilAttachment.resolveImageView";
} else if (type == Type::FragmentDensityMap) {
ss << "pNext<VkRenderingFragmentDensityMapAttachmentInfoEXT>.imageView";
} else if (type == Type::FragmentShadingRate) {
ss << "pNext<VkRenderingFragmentShadingRateAttachmentInfoKHR>.imageView";
}
} else {
ss << "VkRenderPassCreateInfo::pAttachments[" << index << "] (" << type_string(type) << ")";
}
return ss.str();
}
#ifdef VK_USE_PLATFORM_METAL_EXT
static bool GetMetalExport(const VkEventCreateInfo *info) {
bool retval = false;
auto export_metal_object_info = vku::FindStructInPNextChain<VkExportMetalObjectCreateInfoEXT>(info->pNext);
while (export_metal_object_info) {
if (export_metal_object_info->exportObjectType == VK_EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT) {
retval = true;
break;
}
export_metal_object_info = vku::FindStructInPNextChain<VkExportMetalObjectCreateInfoEXT>(export_metal_object_info->pNext);
}
return retval;
}
#endif // VK_USE_PLATFORM_METAL_EXT
namespace vvl {
Event::Event(VkEvent handle, const VkEventCreateInfo *create_info)
: StateObject(handle, kVulkanObjectTypeEvent),
flags(create_info->flags)
#ifdef VK_USE_PLATFORM_METAL_EXT
,
metal_event_export(GetMetalExport(create_info))
#endif // VK_USE_PLATFORM_METAL_EXT
{
}
CommandPool::CommandPool(DeviceState &dev, VkCommandPool handle, const VkCommandPoolCreateInfo *create_info, VkQueueFlags flags)
: StateObject(handle, kVulkanObjectTypeCommandPool),
dev_data(dev),
createFlags(create_info->flags),
queueFamilyIndex(create_info->queueFamilyIndex),
queue_flags(flags),
unprotected((create_info->flags & VK_COMMAND_POOL_CREATE_PROTECTED_BIT) == 0) {}
void CommandPool::Allocate(const VkCommandBufferAllocateInfo *allocate_info, const VkCommandBuffer *command_buffers) {
for (uint32_t i = 0; i < allocate_info->commandBufferCount; i++) {
auto new_cb = dev_data.CreateCmdBufferState(command_buffers[i], allocate_info, this);
commandBuffers.emplace(command_buffers[i], new_cb.get());
dev_data.Add(std::move(new_cb));
}
}
void CommandPool::Free(uint32_t count, const VkCommandBuffer *command_buffers) {
for (uint32_t i = 0; i < count; i++) {
auto iter = commandBuffers.find(command_buffers[i]);
if (iter != commandBuffers.end()) {
dev_data.Destroy<CommandBuffer>(iter->first);
commandBuffers.erase(iter);
}
}
}
void CommandPool::Reset(const Location &loc) {
for (auto &entry : commandBuffers) {
auto guard = entry.second->WriteLock();
entry.second->Reset(loc);
}
}
void CommandPool::Destroy() {
for (auto &entry : commandBuffers) {
dev_data.Destroy<CommandBuffer>(entry.first);
}
commandBuffers.clear();
StateObject::Destroy();
}
void CommandBuffer::SetActiveSubpass(uint32_t subpass) {
active_subpass_ = subpass;
// Always reset stored rasterization samples count
active_subpass_sample_count_ = std::nullopt;
}
CommandBuffer::CommandBuffer(DeviceState &dev, VkCommandBuffer handle, const VkCommandBufferAllocateInfo *allocate_info,
const vvl::CommandPool *pool)
: RefcountedStateObject(handle, kVulkanObjectTypeCommandBuffer),
allocate_info(*allocate_info),
command_pool(pool),
dev_data(dev),
unprotected(pool->unprotected),
lastBound({{{*this, VK_PIPELINE_BIND_POINT_GRAPHICS},
{*this, VK_PIPELINE_BIND_POINT_COMPUTE},
{*this, VK_PIPELINE_BIND_POINT_RAY_TRACING_KHR}}}) {
ResetCBState();
}
// Get the image viewstate for a given framebuffer attachment
vvl::ImageView *CommandBuffer::GetActiveAttachmentImageViewState(uint32_t index) {
assert(!active_attachments.empty() && index != VK_ATTACHMENT_UNUSED && (index < active_attachments.size()));
return active_attachments[index].image_view;
}
// Get the image viewstate for a given framebuffer attachment
const vvl::ImageView *CommandBuffer::GetActiveAttachmentImageViewState(uint32_t index) const {
if (active_attachments.empty() || index == VK_ATTACHMENT_UNUSED || (index >= active_attachments.size())) {
return nullptr;
}
return active_attachments[index].image_view;
}
void CommandBuffer::AddChild(std::shared_ptr<StateObject> &child_node) {
assert(child_node);
if (child_node->AddParent(this)) {
object_bindings.insert(child_node);
}
}
void CommandBuffer::RemoveChild(std::shared_ptr<StateObject> &child_node) {
assert(child_node);
child_node->RemoveParent(this);
object_bindings.erase(child_node);
}
// Reset the command buffer state
// Maintain the createInfo and set state to CB_NEW, but clear all other state
void CommandBuffer::ResetCBState() {
// Remove object bindings
for (const auto &obj : object_bindings) {
obj->RemoveParent(this);
}
object_bindings.clear();
broken_bindings.clear();
begin_info_flags = 0;
has_inheritance = false;
has_render_pass_instance = false;
suspends_render_pass_instance = false;
resumes_render_pass_instance = false;
state = CbState::New;
command_count = 0;
submit_count = 0;
image_layout_change_count = 1; // Start at 1. 0 is insert value for validation cache versions, s.t. new == dirty
dynamic_state_status.cb.reset();
dynamic_state_status.pipeline.reset();
dynamic_state_status.history.reset();
dynamic_state_status.rtx_stack_size_cb = false;
dynamic_state_status.rtx_stack_size_pipeline = false;
CBDynamicFlags all;
dynamic_state_value.reset(all.set());
memset(&invalidated_state_pipe, 0, sizeof(VkPipeline) * CB_DYNAMIC_STATE_STATUS_NUM);
dirty_static_state = false;
active_render_pass = nullptr;
sample_locations_begin_info = nullptr;
attachment_source = AttachmentSource::Empty;
active_attachments.clear();
active_subpasses.clear();
active_color_attachments_index.clear();
has_render_pass_striped = false;
striped_count = 0;
active_subpass_contents = VK_SUBPASS_CONTENTS_INLINE;
SetActiveSubpass(0);
rendering_attachments.Reset();
waited_events.clear();
events.clear();
write_events_before_wait.clear();
active_queries.clear();
started_queries.clear();
render_pass_queries.clear();
image_layout_registry.clear();
aliased_image_layout_map.clear();
current_vertex_buffer_binding_info.clear();
primary_command_buffer = VK_NULL_HANDLE;
linked_command_buffers.clear();
for (auto &item : lastBound) {
item.Reset();
}
active_framebuffer = VK_NULL_HANDLE;
index_buffer_binding.reset();
// Clean up video specific states
bound_video_session = nullptr;
bound_video_session_parameters = nullptr;
bound_video_picture_resources.clear();
video_encode_quality_level.reset();
video_session_updates.clear();
// Clean up the label data
label_stack_depth_ = 0;
label_commands_.clear();
push_constant_ranges_layout.reset();
transform_feedback_active = false;
transform_feedback_buffers_bound = 0;
// Clean up the label data
dev_data.debug_report->ResetCmdDebugUtilsLabel(VkHandle());
}
void CommandBuffer::Reset(const Location &loc) {
ResetCBState();
// Remove reverse command buffer links.
Invalidate(true);
for (auto &item : sub_states_) {
item.second->Reset(loc);
}
}
void CommandBuffer::Destroy() {
// Remove the cb debug labels
dev_data.debug_report->EraseCmdDebugUtilsLabel(VkHandle());
{
auto guard = WriteLock();
ResetCBState();
}
for (auto &item : sub_states_) {
item.second->Destroy();
}
sub_states_.clear();
StateObject::Destroy();
}
void CommandBuffer::NotifyInvalidate(const StateObject::NodeList &invalid_nodes, bool unlink) {
{
auto guard = WriteLock();
assert(!invalid_nodes.empty());
// Save all of the vulkan handles between the command buffer and the now invalid node
LogObjectList log_list;
for (auto &obj : invalid_nodes) {
log_list.add(obj->Handle());
}
bool found_invalid = false;
for (auto &obj : invalid_nodes) {
// Only record a broken binding if one of the nodes in the invalid chain is still
// being tracked by the command buffer. This is to try to avoid race conditions
// caused by separate CommandBuffer and StateObject::parent_nodes locking.
if (object_bindings.erase(obj)) {
obj->RemoveParent(this);
found_invalid = true;
}
switch (obj->Type()) {
case kVulkanObjectTypeCommandBuffer:
if (unlink) {
linked_command_buffers.erase(static_cast<CommandBuffer *>(obj.get()));
}
break;
case kVulkanObjectTypeImage:
if (unlink) {
image_layout_registry.erase(obj->Handle().Cast<VkImage>());
}
break;
default:
break;
}
}
if (found_invalid) {
if (state == CbState::Recording) {
state = CbState::InvalidIncomplete;
} else if (state == CbState::Recorded) {
state = CbState::InvalidComplete;
}
broken_bindings.emplace(invalid_nodes[0]->Handle(), log_list);
}
}
for (auto &item : sub_states_) {
item.second->NotifyInvalidate(invalid_nodes, unlink);
}
StateObject::NotifyInvalidate(invalid_nodes, unlink);
}
// The const variant only need the image as it is the key for the map
std::shared_ptr<const CommandBufferImageLayoutMap> CommandBuffer::GetImageLayoutMap(VkImage image) const {
auto it = image_layout_registry.find(image);
if (it == image_layout_registry.cend()) {
return nullptr;
}
return it->second;
}
// The non-const variant only needs the image state, as the factory requires it to construct a new entry
std::shared_ptr<CommandBufferImageLayoutMap> CommandBuffer::GetOrCreateImageLayoutMap(const vvl::Image &image_state) {
// Make sure we don't create a nullptr keyed entry for a zombie Image
if (image_state.Destroyed() || !image_state.layout_map) {
return nullptr;
}
auto iter = image_layout_registry.find(image_state.VkHandle());
if (iter != image_layout_registry.end() && iter->second && image_state.GetId() == iter->second->image_id) {
return iter->second;
}
std::shared_ptr<CommandBufferImageLayoutMap> image_layout_map;
if (image_state.CanAlias()) {
// Aliasing images need to share the same local layout map.
// Since they use the same global layout state, use it as a key
// for the local state. We don't need a lock on the global range
// map to do a lookup based on its pointer.
const auto *p_global_layout_map = image_state.layout_map.get();
auto alias_iter = aliased_image_layout_map.find(p_global_layout_map);
if (alias_iter != aliased_image_layout_map.end()) {
image_layout_map = alias_iter->second;
} else {
image_layout_map = std::make_shared<CommandBufferImageLayoutMap>(image_state.subresource_encoder.SubresourceCount(),
image_state.GetId());
// Save the local layout map for the next aliased image.
// The global layout map pointer is only used as a key into the local lookup
// table so it doesn't need to be locked.
aliased_image_layout_map.emplace(p_global_layout_map, image_layout_map);
}
} else {
image_layout_map =
std::make_shared<CommandBufferImageLayoutMap>(image_state.subresource_encoder.SubresourceCount(), image_state.GetId());
}
if (iter != image_layout_registry.end()) {
// overwrite the stale entry
iter->second = image_layout_map;
} else {
// add a new entry
image_layout_registry.insert({image_state.VkHandle(), image_layout_map});
}
return image_layout_map;
}
void CommandBuffer::RecordBeginQuery(const QueryObject &query_obj, const Location &loc) {
active_queries.insert(query_obj);
started_queries.insert(query_obj);
updated_queries.insert(query_obj);
if (query_obj.inside_render_pass) {
render_pass_queries.insert(query_obj);
}
for (auto &item : sub_states_) {
item.second->RecordBeginQuery(query_obj, loc);
}
}
void CommandBuffer::RecordEndQuery(const QueryObject &query_obj, const Location &loc) {
active_queries.erase(query_obj);
updated_queries.insert(query_obj);
if (query_obj.inside_render_pass) {
render_pass_queries.erase(query_obj);
}
for (auto &item : sub_states_) {
item.second->RecordEndQuery(query_obj, loc);
}
}
bool CommandBuffer::UpdatesQuery(const QueryObject &query_obj) const {
// Clear out the perf_pass from the caller because it isn't known when the command buffer is recorded.
auto key = query_obj;
key.perf_pass = 0;
for (auto *sub_cb : linked_command_buffers) {
if (sub_cb->updated_queries.find(key) != sub_cb->updated_queries.end()) {
return true;
}
}
return updated_queries.find(key) != updated_queries.end();
}
void CommandBuffer::RecordEndQueries(VkQueryPool queryPool, uint32_t firstQuery, uint32_t queryCount) {
for (uint32_t slot = firstQuery; slot < (firstQuery + queryCount); slot++) {
QueryObject query_obj = {queryPool, slot};
active_queries.erase(query_obj);
updated_queries.insert(query_obj);
}
for (auto &item : sub_states_) {
item.second->RecordEndQueries(queryPool, firstQuery, queryCount);
}
}
void CommandBuffer::RecordWriteTimestamp(VkQueryPool queryPool, uint32_t slot, const Location &loc) {
command_count++;
if (dev_data.disabled[query_validation]) {
return;
}
if (!dev_data.disabled[command_buffer_state]) {
auto pool_state = dev_data.Get<vvl::QueryPool>(queryPool);
AddChild(pool_state);
}
QueryObject query_obj = {queryPool, slot};
for (auto &item : sub_states_) {
item.second->RecordWriteTimestamp(query_obj, loc);
}
// Acts like an end query
active_queries.erase(query_obj);
updated_queries.insert(query_obj);
if (query_obj.inside_render_pass) {
render_pass_queries.erase(query_obj);
}
}
void CommandBuffer::RecordResetQueryPool(VkQueryPool queryPool, uint32_t firstQuery, uint32_t queryCount, const Location &loc) {
command_count++;
if (dev_data.disabled[query_validation]) {
return;
}
auto pool_state = dev_data.Get<QueryPool>(queryPool);
ASSERT_AND_RETURN(pool_state);
if (!dev_data.disabled[command_buffer_state]) {
AddChild(pool_state);
}
for (uint32_t slot = firstQuery; slot < (firstQuery + queryCount); slot++) {
QueryObject query_obj = {queryPool, slot};
updated_queries.insert(query_obj);
}
const bool is_perf_query = pool_state->create_info.queryType == VK_QUERY_TYPE_PERFORMANCE_QUERY_KHR;
for (auto &item : sub_states_) {
item.second->RecordResetQueryPool(queryPool, firstQuery, queryCount, is_perf_query, loc);
}
}
void CommandBuffer::RecordCopyQueryPoolResults(VkQueryPool queryPool, VkBuffer dstBuffer, uint32_t firstQuery, uint32_t queryCount,
VkDeviceSize dstOffset, VkDeviceSize stride, VkQueryResultFlags flags,
const Location &loc) {
command_count++;
if (dev_data.disabled[query_validation]) {
return;
}
auto buffer_state = dev_data.Get<Buffer>(dstBuffer);
auto pool_state = dev_data.Get<QueryPool>(queryPool);
ASSERT_AND_RETURN(buffer_state && pool_state);
if (!dev_data.disabled[command_buffer_state]) {
AddChild(buffer_state);
AddChild(pool_state);
}
for (auto &item : sub_states_) {
item.second->RecordCopyQueryPoolResults(*pool_state, *buffer_state, firstQuery, queryCount, dstOffset, stride, flags, loc);
}
}
void CommandBuffer::RecordWriteAccelerationStructuresProperties(VkQueryPool queryPool, uint32_t firstQuery,
uint32_t accelerationStructureCount, const Location &loc) {
command_count++;
if (dev_data.disabled[query_validation]) {
return;
}
if (!dev_data.disabled[command_buffer_state]) {
auto pool_state = dev_data.Get<QueryPool>(queryPool);
AddChild(pool_state);
}
for (auto &item : sub_states_) {
item.second->RecordWriteAccelerationStructuresProperties(queryPool, firstQuery, accelerationStructureCount, loc);
}
// Same idea as RecordEndQueries
for (uint32_t slot = firstQuery; slot < (firstQuery + accelerationStructureCount); slot++) {
QueryObject query_obj = {queryPool, slot};
active_queries.erase(query_obj);
updated_queries.insert(query_obj);
}
}
void CommandBuffer::UpdateSubpassAttachments() {
ASSERT_AND_RETURN(active_render_pass);
const auto &subpass = active_render_pass->create_info.pSubpasses[GetActiveSubpass()];
assert(active_subpasses.size() == active_attachments.size());
for (uint32_t index = 0; index < subpass.inputAttachmentCount; ++index) {
const uint32_t attachment_index = subpass.pInputAttachments[index].attachment;
if (attachment_index != VK_ATTACHMENT_UNUSED) {
active_attachments[attachment_index].type = AttachmentInfo::Type::Input;
active_subpasses[attachment_index].used = true;
active_subpasses[attachment_index].usage = VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
active_subpasses[attachment_index].layout = subpass.pInputAttachments[index].layout;
active_subpasses[attachment_index].aspectMask = subpass.pInputAttachments[index].aspectMask;
}
}
for (uint32_t index = 0; index < subpass.colorAttachmentCount; ++index) {
const uint32_t attachment_index = subpass.pColorAttachments[index].attachment;
if (attachment_index != VK_ATTACHMENT_UNUSED) {
active_attachments[attachment_index].type = AttachmentInfo::Type::Color;
active_attachments[attachment_index].color_index = index;
active_color_attachments_index.insert(index);
active_subpasses[attachment_index].used = true;
active_subpasses[attachment_index].usage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
active_subpasses[attachment_index].layout = subpass.pColorAttachments[index].layout;
active_subpasses[attachment_index].aspectMask = subpass.pColorAttachments[index].aspectMask;
}
if (subpass.pResolveAttachments) {
const uint32_t attachment_index2 = subpass.pResolveAttachments[index].attachment;
if (attachment_index2 != VK_ATTACHMENT_UNUSED) {
active_attachments[attachment_index2].type = AttachmentInfo::Type::ColorResolve;
active_subpasses[attachment_index2].used = true;
active_subpasses[attachment_index2].usage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
active_subpasses[attachment_index2].layout = subpass.pResolveAttachments[index].layout;
active_subpasses[attachment_index2].aspectMask = subpass.pResolveAttachments[index].aspectMask;
}
}
}
if (subpass.pDepthStencilAttachment) {
const uint32_t attachment_index = subpass.pDepthStencilAttachment->attachment;
if (attachment_index != VK_ATTACHMENT_UNUSED) {
active_attachments[attachment_index].type = AttachmentInfo::Type::DepthStencil;
active_subpasses[attachment_index].used = true;
active_subpasses[attachment_index].usage = VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
active_subpasses[attachment_index].layout = subpass.pDepthStencilAttachment->layout;
active_subpasses[attachment_index].aspectMask = subpass.pDepthStencilAttachment->aspectMask;
}
}
if (auto rdm_ci =
vku::FindStructInPNextChain<VkRenderPassFragmentDensityMapCreateInfoEXT>(active_render_pass->create_info.pNext)) {
const uint32_t attachment_index = rdm_ci->fragmentDensityMapAttachment.attachment;
if (attachment_index != VK_ATTACHMENT_UNUSED) {
active_attachments[attachment_index].type = AttachmentInfo::Type::FragmentDensityMap;
active_subpasses[attachment_index].used = true;
active_subpasses[attachment_index].usage = VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT;
active_subpasses[attachment_index].layout = rdm_ci->fragmentDensityMapAttachment.layout;
active_subpasses[attachment_index].aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
}
}
if (auto rdr_attachment_ci = vku::FindStructInPNextChain<VkFragmentShadingRateAttachmentInfoKHR>(subpass.pNext)) {
if (rdr_attachment_ci->pFragmentShadingRateAttachment) {
const uint32_t attachment_index = rdr_attachment_ci->pFragmentShadingRateAttachment->attachment;
if (attachment_index != VK_ATTACHMENT_UNUSED) {
active_attachments[attachment_index].type = AttachmentInfo::Type::FragmentShadingRate;
active_subpasses[attachment_index].used = true;
active_subpasses[attachment_index].usage = VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR;
active_subpasses[attachment_index].layout = rdr_attachment_ci->pFragmentShadingRateAttachment->layout;
active_subpasses[attachment_index].aspectMask = rdr_attachment_ci->pFragmentShadingRateAttachment->aspectMask;
}
}
}
}
// For non Dynamic Renderpass we update the attachments
void CommandBuffer::UpdateAttachmentsView(const VkRenderPassBeginInfo *pRenderPassBegin) {
const bool imageless = (active_framebuffer->create_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0;
const VkRenderPassAttachmentBeginInfo *attachment_info_struct = nullptr;
if (pRenderPassBegin) attachment_info_struct = vku::FindStructInPNextChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
for (uint32_t i = 0; i < active_attachments.size(); ++i) {
if (imageless) {
if (attachment_info_struct && i < attachment_info_struct->attachmentCount) {
active_attachments[i].image_view = dev_data.Get<vvl::ImageView>(attachment_info_struct->pAttachments[i]).get();
}
} else {
active_attachments[i].image_view = active_framebuffer->attachments_view_state[i].get();
}
}
// While updating the subpass we will set the active_attachments type
UpdateSubpassAttachments();
}
void CommandBuffer::RecordBeginRenderPass(const VkRenderPassBeginInfo &render_pass_begin,
const VkSubpassBeginInfo &subpass_begin_info, const Location &loc) {
command_count++;
active_framebuffer = dev_data.Get<vvl::Framebuffer>(render_pass_begin.framebuffer);
active_render_pass = dev_data.Get<vvl::RenderPass>(render_pass_begin.renderPass);
render_area = render_pass_begin.renderArea;
SetActiveSubpass(0);
active_subpass_contents = subpass_begin_info.contents;
render_pass_queries.clear();
// Connect this RP to cmdBuffer
if (!dev_data.disabled[command_buffer_state]) {
AddChild(active_render_pass);
}
sample_locations_begin_info = vku::FindStructInPNextChain<VkRenderPassSampleLocationsBeginInfoEXT>(render_pass_begin.pNext);
if (auto rp_striped_begin = vku::FindStructInPNextChain<VkRenderPassStripeBeginInfoARM>(render_pass_begin.pNext)) {
has_render_pass_striped = true;
striped_count += rp_striped_begin->stripeInfoCount;
}
// Spec states that after BeginRenderPass all resources should be rebound
if (active_render_pass->has_multiview_enabled) {
UnbindResources();
}
auto chained_device_group_struct = vku::FindStructInPNextChain<VkDeviceGroupRenderPassBeginInfo>(render_pass_begin.pNext);
render_pass_device_mask = chained_device_group_struct ? chained_device_group_struct->deviceMask : initial_device_mask;
attachment_source = AttachmentSource::RenderPass;
active_subpasses.clear();
active_attachments.clear();
if (active_framebuffer) {
active_subpasses.resize(active_framebuffer->create_info.attachmentCount);
active_attachments.resize(active_framebuffer->create_info.attachmentCount);
UpdateAttachmentsView(&render_pass_begin);
// Connect this framebuffer and its children to this cmdBuffer
AddChild(active_framebuffer);
}
for (auto &item : sub_states_) {
item.second->RecordBeginRenderPass(render_pass_begin, subpass_begin_info, loc);
}
}
void CommandBuffer::RecordNextSubpass(const VkSubpassBeginInfo &subpass_begin_info, const VkSubpassEndInfo *subpass_end_info,
const Location &loc) {
command_count++;
SetActiveSubpass(GetActiveSubpass() + 1);
active_subpass_contents = subpass_begin_info.contents;
ASSERT_AND_RETURN(active_render_pass);
if (active_framebuffer) {
active_subpasses.clear();
active_subpasses.resize(active_framebuffer->create_info.attachmentCount);
if (GetActiveSubpass() < active_render_pass->create_info.subpassCount) {
UpdateSubpassAttachments();
}
}
// Spec states that after NextSubpass all resources should be rebound
if (active_render_pass->has_multiview_enabled) {
UnbindResources();
}
for (auto &item : sub_states_) {
item.second->RecordNextSubpass(subpass_begin_info, subpass_end_info, loc);
}
}
void CommandBuffer::RecordEndRenderPass(const VkSubpassEndInfo *subpass_end_info, const Location &loc) {
// Call first so SubState can use render pass object before we destroy it
for (auto &item : sub_states_) {
item.second->RecordEndRenderPass(subpass_end_info, loc);
}
command_count++;
active_render_pass = nullptr;
attachment_source = AttachmentSource::Empty;
active_attachments.clear();
active_subpasses.clear();
active_color_attachments_index.clear();
SetActiveSubpass(0);
active_framebuffer = VK_NULL_HANDLE;
sample_locations_begin_info = nullptr;
}
void CommandBuffer::RecordBeginRendering(const VkRenderingInfo &rendering_info, const Location &loc) {
command_count++;
active_render_pass = std::make_shared<vvl::RenderPass>(&rendering_info, true);
render_area = rendering_info.renderArea;
render_pass_queries.clear();
rendering_attachments.Reset();
rendering_attachments.color_locations.resize(rendering_info.colorAttachmentCount);
rendering_attachments.color_indexes.resize(rendering_info.colorAttachmentCount);
auto chained_device_group_struct = vku::FindStructInPNextChain<VkDeviceGroupRenderPassBeginInfo>(rendering_info.pNext);
render_pass_device_mask = chained_device_group_struct ? chained_device_group_struct->deviceMask : initial_device_mask;
auto rp_striped_begin = vku::FindStructInPNextChain<VkRenderPassStripeBeginInfoARM>(rendering_info.pNext);
if (rp_striped_begin) {
has_render_pass_striped = true;
striped_count += rp_striped_begin->stripeInfoCount;
}
active_subpass_contents = ((rendering_info.flags & VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT)
? VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS
: VK_SUBPASS_CONTENTS_INLINE);
// Handle flags for dynamic rendering
if (!has_render_pass_instance && rendering_info.flags & VK_RENDERING_RESUMING_BIT) {
resumes_render_pass_instance = true;
}
suspends_render_pass_instance = (rendering_info.flags & VK_RENDERING_SUSPENDING_BIT) > 0;
has_render_pass_instance = true;
attachment_source = AttachmentSource::DynamicRendering;
active_attachments.clear();
// add 2 for the Depth and Stencil
// multiple by 2 because every attachment might have a resolve
// add 1 for FragmentDensityMap (doesn't need a resolve)
uint32_t attachment_count = ((rendering_info.colorAttachmentCount + 2) * 2) + 1;
// Currently reserve the maximum possible size for |active_attachments| so when looping, we NEED to check for null
active_attachments.resize(attachment_count);
for (uint32_t i = 0; i < rendering_info.colorAttachmentCount; ++i) {
// Default from spec
rendering_attachments.color_locations[i] = i;
rendering_attachments.color_indexes[i] = i;
if (rendering_info.pColorAttachments[i].imageView != VK_NULL_HANDLE) {
auto &color_attachment = active_attachments[GetDynamicRenderingColorAttachmentIndex(i)];
color_attachment.image_view = dev_data.Get<vvl::ImageView>(rendering_info.pColorAttachments[i].imageView).get();
color_attachment.type = AttachmentInfo::Type::Color;
color_attachment.color_index = i;
active_color_attachments_index.insert(i);
if (rendering_info.pColorAttachments[i].resolveMode != VK_RESOLVE_MODE_NONE &&
rendering_info.pColorAttachments[i].resolveImageView != VK_NULL_HANDLE) {
auto &resolve_attachment = active_attachments[GetDynamicRenderingColorResolveAttachmentIndex(i)];
resolve_attachment.image_view = dev_data.Get<vvl::ImageView>(rendering_info.pColorAttachments[i].imageView).get();
resolve_attachment.type = AttachmentInfo::Type::ColorResolve;
}
}
}
if (rendering_info.pDepthAttachment && rendering_info.pDepthAttachment->imageView != VK_NULL_HANDLE) {
auto &depth_attachment = active_attachments[GetDynamicRenderingAttachmentIndex(AttachmentInfo::Type::Depth)];
depth_attachment.image_view = dev_data.Get<vvl::ImageView>(rendering_info.pDepthAttachment->imageView).get();
depth_attachment.type = AttachmentInfo::Type::Depth;
if (rendering_info.pDepthAttachment->resolveMode != VK_RESOLVE_MODE_NONE &&
rendering_info.pDepthAttachment->resolveImageView != VK_NULL_HANDLE) {
auto &resolve_attachment = active_attachments[GetDynamicRenderingAttachmentIndex(AttachmentInfo::Type::DepthResolve)];
resolve_attachment.image_view = dev_data.Get<vvl::ImageView>(rendering_info.pDepthAttachment->imageView).get();
resolve_attachment.type = AttachmentInfo::Type::DepthResolve;
}
}
if (rendering_info.pStencilAttachment && rendering_info.pStencilAttachment->imageView != VK_NULL_HANDLE) {
auto &stencil_attachment = active_attachments[GetDynamicRenderingAttachmentIndex(AttachmentInfo::Type::Stencil)];
stencil_attachment.image_view = dev_data.Get<vvl::ImageView>(rendering_info.pStencilAttachment->imageView).get();
stencil_attachment.type = AttachmentInfo::Type::Stencil;
if (rendering_info.pStencilAttachment->resolveMode != VK_RESOLVE_MODE_NONE &&
rendering_info.pStencilAttachment->resolveImageView != VK_NULL_HANDLE) {
auto &resolve_attachment = active_attachments[GetDynamicRenderingAttachmentIndex(AttachmentInfo::Type::StencilResolve)];
resolve_attachment.image_view = dev_data.Get<vvl::ImageView>(rendering_info.pStencilAttachment->imageView).get();
resolve_attachment.type = AttachmentInfo::Type::StencilResolve;
}
}
if (auto fragment_density_map_info =
vku::FindStructInPNextChain<VkRenderingFragmentDensityMapAttachmentInfoEXT>(rendering_info.pNext)) {
auto &fdm_attachment = active_attachments[GetDynamicRenderingAttachmentIndex(AttachmentInfo::Type::FragmentDensityMap)];
fdm_attachment.image_view = dev_data.Get<vvl::ImageView>(fragment_density_map_info->imageView).get();
fdm_attachment.type = AttachmentInfo::Type::FragmentDensityMap;
}
for (auto &item : sub_states_) {
item.second->RecordBeginRendering(rendering_info, loc);
}
}
void CommandBuffer::RecordEndRendering(const VkRenderingEndInfoEXT *pRenderingEndInfo) {
// Call first so SubState can use render pass object before we destroy it
for (auto &item : sub_states_) {
item.second->RecordEndRendering(pRenderingEndInfo);
}
command_count++;
active_render_pass = nullptr;
active_color_attachments_index.clear();
}
void CommandBuffer::RecordBeginVideoCoding(const VkVideoBeginCodingInfoKHR &begin_info, const Location &loc) {
command_count++;
bound_video_session = dev_data.Get<vvl::VideoSession>(begin_info.videoSession);
ASSERT_AND_RETURN(bound_video_session);
bound_video_session_parameters = dev_data.Get<vvl::VideoSessionParameters>(begin_info.videoSessionParameters);
// Connect this video session to cmdBuffer
if (!dev_data.disabled[command_buffer_state]) {
AddChild(bound_video_session);
}
if (bound_video_session_parameters) {
// Connect this video session parameters object to cmdBuffer
if (!dev_data.disabled[command_buffer_state]) {
AddChild(bound_video_session_parameters);
}
}
// Need to record substate first
for (auto &item : sub_states_) {
item.second->RecordBeginVideoCoding(*bound_video_session, begin_info, loc);
}
if (bound_video_session->IsEncode()) {
video_encode_rate_control_state = VideoEncodeRateControlState(bound_video_session->GetCodecOp(), &begin_info);
video_encode_quality_level.reset();
}
if (begin_info.referenceSlotCount > 0) {
size_t deactivated_slot_count = 0;
for (uint32_t i = 0; i < begin_info.referenceSlotCount; ++i) {
// Initialize the set of bound video picture resources
if (begin_info.pReferenceSlots[i].pPictureResource != nullptr) {
int32_t slot_index = begin_info.pReferenceSlots[i].slotIndex;
vvl::VideoPictureResource res(dev_data, *begin_info.pReferenceSlots[i].pPictureResource);
bound_video_picture_resources.emplace(std::make_pair(res, slot_index));
}
if (begin_info.pReferenceSlots[i].slotIndex >= 0 && begin_info.pReferenceSlots[i].pPictureResource == nullptr) {
deactivated_slot_count++;
}
}
if (deactivated_slot_count > 0) {
std::vector<int32_t> deactivated_slots{};
deactivated_slots.reserve(deactivated_slot_count);
for (uint32_t i = 0; i < begin_info.referenceSlotCount; ++i) {
if (begin_info.pReferenceSlots[i].slotIndex >= 0 && begin_info.pReferenceSlots[i].pPictureResource == nullptr) {
deactivated_slots.emplace_back(begin_info.pReferenceSlots[i].slotIndex);
}
}
// Enqueue submission time DPB slot deactivation
video_session_updates[bound_video_session->VkHandle()].emplace_back(
[deactivated_slots](const vvl::VideoSession *vs_state, vvl::VideoSessionDeviceState &dev_state, bool do_validate) {
for (const auto &slot_index : deactivated_slots) {
dev_state.Deactivate(slot_index);
}
return false;
});
}
}
}
void CommandBuffer::RecordEndVideoCoding() {
command_count++;
bound_video_session = nullptr;
bound_video_session_parameters = nullptr;
bound_video_picture_resources.clear();
video_encode_quality_level.reset();
}
void CommandBuffer::RecordControlVideoCoding(const VkVideoCodingControlInfoKHR &control_info, const Location &loc) {
command_count++;
if (!bound_video_session) {
return;
}
// Need to record substate first
for (auto &item : sub_states_) {
item.second->RecordControlVideoCoding(*bound_video_session, control_info, loc);
}
if (control_info.flags & VK_VIDEO_CODING_CONTROL_RESET_BIT_KHR) {
// Remove DPB slot index association for bound video picture resources
for (auto &binding : bound_video_picture_resources) {
binding.second = -1;
}
// Enqueue submission time video session state reset/initialization
video_session_updates[bound_video_session->VkHandle()].emplace_back(
[](const vvl::VideoSession *vs_state, vvl::VideoSessionDeviceState &dev_state, bool do_validate) {
dev_state.Reset();
return false;
});
}
if (bound_video_session->IsEncode() && control_info.flags & VK_VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR) {
auto state = VideoEncodeRateControlState(bound_video_session->GetCodecOp(), &control_info);
if (state) {
video_encode_rate_control_state = state;
// Enqueue rate control specific device state changes
video_session_updates[bound_video_session->VkHandle()].emplace_back(
[state](const vvl::VideoSession *vs_state, vvl::VideoSessionDeviceState &dev_state, bool do_validate) {
dev_state.SetRateControlState(state);
return false;
});
}
}
if (bound_video_session->IsEncode() && control_info.flags & VK_VIDEO_CODING_CONTROL_ENCODE_QUALITY_LEVEL_BIT_KHR) {
auto quality_level_info = vku::FindStructInPNextChain<VkVideoEncodeQualityLevelInfoKHR>(control_info.pNext);
if (quality_level_info != nullptr) {
uint32_t quality_level = quality_level_info->qualityLevel;
video_encode_quality_level = quality_level;
// Enqueue encode quality level device state change
video_session_updates[bound_video_session->VkHandle()].emplace_back(
[quality_level](const vvl::VideoSession *vs_state, vvl::VideoSessionDeviceState &dev_state, bool do_validate) {
dev_state.SetEncodeQualityLevel(quality_level);
return false;
});
}
}
}
void vvl::CommandBuffer::RecordVideoInlineQueries(const VkVideoInlineQueryInfoKHR &query_info) {
for (auto &item : sub_states_) {
item.second->RecordVideoInlineQueries(query_info);
}
for (uint32_t i = 0; i < query_info.queryCount; i++) {
updated_queries.insert(QueryObject(query_info.queryPool, query_info.firstQuery + i));
}
}
void CommandBuffer::RecordDecodeVideo(const VkVideoDecodeInfoKHR &decode_info, const Location &loc) {
command_count++;
if (!bound_video_session) {
return;
}
// Need to record substate first
for (auto &item : sub_states_) {
item.second->RecordDecodeVideo(*bound_video_session, decode_info, loc);
}
if (decode_info.pSetupReferenceSlot && decode_info.pSetupReferenceSlot->pPictureResource) {
vvl::VideoReferenceSlot setup_slot(dev_data, *bound_video_session->profile, *decode_info.pSetupReferenceSlot);
// Update bound video picture resource DPB slot index association
bound_video_picture_resources[setup_slot.resource] = setup_slot.index;
// Enqueue submission time reference slot setup or invalidation
bool reference_setup_requested = bound_video_session->ReferenceSetupRequested(decode_info);
video_session_updates[bound_video_session->VkHandle()].emplace_back(
[setup_slot, reference_setup_requested](const vvl::VideoSession *vs_state, vvl::VideoSessionDeviceState &dev_state,
bool do_validate) {
if (reference_setup_requested) {
dev_state.Activate(setup_slot.index, setup_slot.picture_id, setup_slot.resource);
} else {
dev_state.Invalidate(setup_slot.index, setup_slot.picture_id);
}
return false;
});
}
// Update active query indices
for (auto &query : active_queries) {
uint32_t op_count = bound_video_session->GetVideoDecodeOperationCount(&decode_info);
query.active_query_index += op_count;
}
// Update inline queries
if (bound_video_session->create_info.flags & VK_VIDEO_SESSION_CREATE_INLINE_QUERIES_BIT_KHR) {
const auto inline_query_info = vku::FindStructInPNextChain<VkVideoInlineQueryInfoKHR>(decode_info.pNext);
if (inline_query_info != nullptr && inline_query_info->queryPool != VK_NULL_HANDLE) {
RecordVideoInlineQueries(*inline_query_info);
}
}
}
void vvl::CommandBuffer::RecordEncodeVideo(const VkVideoEncodeInfoKHR &encode_info, const Location &loc) {
command_count++;
if (!bound_video_session) {
return;
}
// Need to record substate first
for (auto &item : sub_states_) {
item.second->RecordEncodeVideo(*bound_video_session, encode_info, loc);
}
if (encode_info.pSetupReferenceSlot && encode_info.pSetupReferenceSlot->pPictureResource) {
vvl::VideoReferenceSlot setup_slot(dev_data, *bound_video_session->profile, *encode_info.pSetupReferenceSlot);
// Update bound video picture resource DPB slot index association
bound_video_picture_resources[setup_slot.resource] = setup_slot.index;
// Enqueue submission time reference slot setup or invalidation
bool reference_setup_requested = bound_video_session->ReferenceSetupRequested(encode_info);
video_session_updates[bound_video_session->VkHandle()].emplace_back(
[setup_slot, reference_setup_requested](const vvl::VideoSession *vs_state, vvl::VideoSessionDeviceState &dev_state,
bool do_validate) {
if (reference_setup_requested) {
dev_state.Activate(setup_slot.index, setup_slot.picture_id, setup_slot.resource);
} else {
dev_state.Invalidate(setup_slot.index, setup_slot.picture_id);
}
return false;
});
}
// Update active query indices
for (auto &query : active_queries) {
uint32_t op_count = bound_video_session->GetVideoEncodeOperationCount(&encode_info);
query.active_query_index += op_count;
}
// Update inline queries
if (bound_video_session->create_info.flags & VK_VIDEO_SESSION_CREATE_INLINE_QUERIES_BIT_KHR) {
const auto inline_query_info = vku::FindStructInPNextChain<VkVideoInlineQueryInfoKHR>(encode_info.pNext);
if (inline_query_info != nullptr && inline_query_info->queryPool != VK_NULL_HANDLE) {
RecordVideoInlineQueries(*inline_query_info);
}
}
}
void CommandBuffer::Begin(const VkCommandBufferBeginInfo *pBeginInfo) {
if (CbState::Recorded == state || CbState::InvalidComplete == state) {
Location loc(Func::vkBeginCommandBuffer);
Reset(loc);
}
// Set updated state here in case implicit reset occurs above
state = CbState::Recording;
ASSERT_AND_RETURN(pBeginInfo);
begin_info_flags = pBeginInfo->flags;
if (pBeginInfo->pInheritanceInfo && IsSecondary()) {
// pInheritanceInfo could be valid, but ignored, if in a primary command buffer
has_inheritance = true;
inheritance_info.initialize(pBeginInfo->pInheritanceInfo);
// If we are a secondary command-buffer and inheriting. Update the items we should inherit.
if (begin_info_flags & VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT) {
if (inheritance_info.renderPass) {
active_render_pass = dev_data.Get<vvl::RenderPass>(inheritance_info.renderPass);
SetActiveSubpass(inheritance_info.subpass);
if (inheritance_info.framebuffer) {
active_framebuffer = dev_data.Get<vvl::Framebuffer>(inheritance_info.framebuffer);
attachment_source = AttachmentSource::Inheritance;
active_subpasses.clear();
active_attachments.clear();
if (active_framebuffer) {
active_subpasses.resize(active_framebuffer->create_info.attachmentCount);
active_attachments.resize(active_framebuffer->create_info.attachmentCount);
UpdateAttachmentsView(nullptr);
// Connect this framebuffer and its children to this cmdBuffer
if (!dev_data.disabled[command_buffer_state]) {
AddChild(active_framebuffer);
}
}
}
} else {
auto inheritance_rendering_info =
vku::FindStructInPNextChain<VkCommandBufferInheritanceRenderingInfo>(pBeginInfo->pInheritanceInfo->pNext);
if (inheritance_rendering_info) {
active_render_pass = std::make_shared<vvl::RenderPass>(inheritance_rendering_info);
}
}
}
}
auto chained_device_group_struct = vku::FindStructInPNextChain<VkDeviceGroupCommandBufferBeginInfo>(pBeginInfo->pNext);
if (chained_device_group_struct) {
initial_device_mask = chained_device_group_struct->deviceMask;
} else {
initial_device_mask = (1 << dev_data.physical_device_count) - 1;
}
performance_lock_acquired = dev_data.performance_lock_acquired;
updated_queries.clear();
for (auto &item : sub_states_) {
item.second->Begin(*pBeginInfo);
}
}
void CommandBuffer::End(VkResult result) {
if (result == VK_SUCCESS) {
state = CbState::Recorded;
}
for (auto &item : sub_states_) {
item.second->End();
}
}
void CommandBuffer::RecordExecuteCommands(vvl::span<const VkCommandBuffer> secondary_command_buffers, const Location &loc) {
command_count++;
uint32_t cmd_index = 0;
for (const VkCommandBuffer sub_command_buffer : secondary_command_buffers) {
auto secondary_cb_state = dev_data.GetWrite<CommandBuffer>(sub_command_buffer);
ASSERT_AND_RETURN(secondary_cb_state);
if (!(secondary_cb_state->begin_info_flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT)) {
if (begin_info_flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
// TODO: Because this is a state change, clearing the VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT needs to be moved
// from the validation step to the recording step
begin_info_flags &= ~VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT;
}
}
// Propagate inital layout and current layout state to the primary cmd buffer
// NOTE: The update/population of the image_layout_map is done in CoreChecks, but for other classes derived from
// Device these maps will be empty, so leaving the propagation in the the state tracker should be a no-op
// for those other classes.
for (const auto &[image, secondary_cb_layout_map] : secondary_cb_state->image_layout_registry) {
const auto image_state = dev_data.Get<vvl::Image>(image);
if (!image_state || image_state->Destroyed() || !secondary_cb_layout_map ||
image_state->GetId() != secondary_cb_layout_map->image_id) {
continue;
}
if (auto cb_layout_map = GetOrCreateImageLayoutMap(*image_state)) {
struct Updater {
void update(ImageLayoutState &dst, const ImageLayoutState &src) const {
if (src.current_layout != kInvalidLayout && src.current_layout != dst.current_layout) {
dst.current_layout = src.current_layout;
}
}
std::optional<ImageLayoutState> insert(const ImageLayoutState &src) const {
return std::optional<ImageLayoutState>(vvl::in_place, src);
}
};
sparse_container::splice(*cb_layout_map, *secondary_cb_layout_map, Updater());
}
}
secondary_cb_state->primary_command_buffer = VkHandle();
linked_command_buffers.insert(secondary_cb_state.get());
AddChild(secondary_cb_state);
for (auto &event : secondary_cb_state->events) {
events.push_back(event);
}
// Handle secondary command buffer updates for dynamic rendering
if (!has_render_pass_instance) {
resumes_render_pass_instance = secondary_cb_state->resumes_render_pass_instance;
}
if (!secondary_cb_state->active_render_pass) {
suspends_render_pass_instance = secondary_cb_state->suspends_render_pass_instance;
has_render_pass_instance |= secondary_cb_state->has_render_pass_instance;
}
label_stack_depth_ += secondary_cb_state->label_stack_depth_;
label_commands_.insert(label_commands_.end(), secondary_cb_state->label_commands_.begin(),
secondary_cb_state->label_commands_.end());
for (auto &item : sub_states_) {
item.second->RecordExecuteCommand(*secondary_cb_state, cmd_index, loc);
}
cmd_index++;
}
}
void CommandBuffer::PushDescriptorSetState(VkPipelineBindPoint pipelineBindPoint,
std::shared_ptr<const vvl::PipelineLayout> pipeline_layout, uint32_t set,
uint32_t descriptorWriteCount, const VkWriteDescriptorSet *pDescriptorWrites,
const Location &loc) {
// Short circuit invalid updates
if ((set >= pipeline_layout->set_layouts.size()) || !pipeline_layout->set_layouts[set] ||
!pipeline_layout->set_layouts[set]->IsPushDescriptor()) {
return;
}
// We need a descriptor set to update the bindings with, compatible with the passed layout
const auto &dsl = pipeline_layout->set_layouts[set];
auto &last_bound = lastBound[ConvertToVvlBindPoint(pipelineBindPoint)];
auto &push_descriptor_set = last_bound.push_descriptor_set;
// If we are disturbing the current push_desriptor_set clear it
if (!push_descriptor_set || !last_bound.IsBoundSetCompatible(set, *pipeline_layout)) {
last_bound.UnbindAndResetPushDescriptorSet(dev_data.CreatePushDescriptorSet(dsl));
}
UpdateLastBoundDescriptorSets(pipelineBindPoint, pipeline_layout, set, 1, nullptr, push_descriptor_set, 0, nullptr, loc);
// Now that we have either the new or extant push_descriptor set ... do the write updates against it
push_descriptor_set->PerformPushDescriptorsUpdate(descriptorWriteCount, pDescriptorWrites);
}
// Generic function to handle state update for all CmdDraw* type functions
void CommandBuffer::RecordDraw(const Location &loc) {
command_count++;
LastBound &last_bound = lastBound[vvl::BindPointGraphics];
for (auto &item : sub_states_) {
item.second->RecordActionCommand(last_bound, loc);
}
}
// Generic function to handle state update for all CmdDispatch* type functions
void CommandBuffer::RecordDispatch(const Location &loc) {
command_count++;
LastBound &last_bound = lastBound[vvl::BindPointCompute];
for (auto &item : sub_states_) {
item.second->RecordActionCommand(last_bound, loc);
}
}
// Generic function to handle state update for all CmdTraceRay* type functions
void CommandBuffer::RecordTraceRay(const Location &loc) {
command_count++;
LastBound &last_bound = lastBound[vvl::BindPointRayTracing];
for (auto &item : sub_states_) {
item.second->RecordActionCommand(last_bound, loc);
}
}
void CommandBuffer::RecordBindPipeline(VkPipelineBindPoint bind_point, vvl::Pipeline &pipeline) {
BindLastBoundPipeline(ConvertToVvlBindPoint(bind_point), &pipeline);
for (auto &item : sub_states_) {
item.second->RecordBindPipeline(bind_point, pipeline);
}
if (bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
dynamic_state_status.pipeline.reset();
// Make a copy and then xor the new change
// This gives us which state has been invalidated, allows us to save time for most cases where nothing changes
CBDynamicFlags invalidated_state = dynamic_state_status.cb;
// Spec: "[dynamic state] made invalid by another pipeline bind with that state specified as static"
// So unset the bitmask for the command buffer lifetime tracking
dynamic_state_status.cb &= pipeline.dynamic_state;
invalidated_state ^= dynamic_state_status.cb;
if (invalidated_state.any()) {
// Reset dynamic state values
dynamic_state_value.reset(invalidated_state);
for (int index = 1; index < CB_DYNAMIC_STATE_STATUS_NUM; ++index) {
CBDynamicState status = static_cast<CBDynamicState>(index);
if (invalidated_state[status]) {
invalidated_state_pipe[index] = pipeline.VkHandle();
}
}
}
if (!pipeline.IsDynamic(CB_DYNAMIC_STATE_VERTEX_INPUT_EXT) &&
!pipeline.IsDynamic(CB_DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE) && pipeline.vertex_input_state) {
for (const auto &[binding_index, binding_state] : pipeline.vertex_input_state->bindings) {
current_vertex_buffer_binding_info[binding_index].stride = binding_state.desc.stride;
}
}
if (!dev_data.enabled_features.variableMultisampleRate) {
if (const auto *multisample_state = pipeline.MultisampleState(); multisample_state) {
if (const auto &render_pass = active_render_pass) {
const uint32_t subpass = GetActiveSubpass();
// if render pass uses no attachment, all bound pipelines in the same subpass must have the same
// pMultisampleState->rasterizationSamples. To check that, record pMultisampleState->rasterizationSamples of the
// first bound pipeline.
if (render_pass->UsesNoAttachment(subpass)) {
if (std::optional<VkSampleCountFlagBits> subpass_rasterization_samples =
GetActiveSubpassRasterizationSampleCount();
!subpass_rasterization_samples) {
SetActiveSubpassRasterizationSampleCount(multisample_state->rasterizationSamples);
}
}
}
}
}
} else if (bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_KHR) {
dynamic_state_status.rtx_stack_size_pipeline = false;
if (!pipeline.IsDynamic(CB_DYNAMIC_STATE_RAY_TRACING_PIPELINE_STACK_SIZE_KHR)) {
dynamic_state_status.rtx_stack_size_cb = false; // invalidated
}
}
dirty_static_state = false;
}
// Helper for descriptor set (and buffer) updates.
static bool PushDescriptorCleanup(LastBound &last_bound, uint32_t set_idx) {
// All uses are from loops over ds_slots, but just in case..
assert(set_idx < last_bound.ds_slots.size());
auto descriptor_set = last_bound.ds_slots[set_idx].ds_state.get();
if (descriptor_set && descriptor_set->IsPushDescriptor()) {
assert(descriptor_set == last_bound.push_descriptor_set.get());
last_bound.push_descriptor_set = nullptr;
return true;
}
return true;
}
// Update pipeline_layout bind points applying the "Pipeline Layout Compatibility" rules.
// One of pDescriptorSets or push_descriptor_set should be nullptr, indicating whether this
// is called for CmdBindDescriptorSets or CmdPushDescriptorSet.
void CommandBuffer::UpdateLastBoundDescriptorSets(VkPipelineBindPoint pipeline_bind_point,
std::shared_ptr<const vvl::PipelineLayout> pipeline_layout, uint32_t first_set,
uint32_t set_count, const VkDescriptorSet *pDescriptorSets,
std::shared_ptr<vvl::DescriptorSet> &push_descriptor_set,
uint32_t dynamic_offset_count, const uint32_t *p_dynamic_offsets,
const Location &loc) {
ASSERT_AND_RETURN((pDescriptorSets == nullptr) ^ (push_descriptor_set == nullptr));
uint32_t required_size = first_set + set_count;
const uint32_t last_binding_index = required_size - 1;
ASSERT_AND_RETURN(last_binding_index < pipeline_layout->set_compat_ids.size());
auto &last_bound = lastBound[ConvertToVvlBindPoint(pipeline_bind_point)];
last_bound.desc_set_pipeline_layout = pipeline_layout;
last_bound.desc_set_bound_command = loc.function;
auto &pipe_compat_ids = pipeline_layout->set_compat_ids;
// Resize binding arrays
if (last_binding_index >= last_bound.ds_slots.size()) {
last_bound.ds_slots.resize(required_size);
}
const uint32_t current_size = static_cast<uint32_t>(last_bound.ds_slots.size());
// Clean up the "disturbed" before and after the range to be set
if (required_size < current_size) {
if (last_bound.ds_slots[last_binding_index].compat_id_for_set != pipe_compat_ids[last_binding_index]) {
// We're disturbing those after last, we'll shrink below, but first need to check for and cleanup the push_descriptor
for (auto set_idx = required_size; set_idx < current_size; ++set_idx) {
if (PushDescriptorCleanup(last_bound, set_idx)) {
break;
}
}
} else {
// We're not disturbing past last, so leave the upper binding data alone.
required_size = current_size;
}
}
// We resize if we need more set entries or if those past "last" are disturbed
if (required_size != current_size) {
last_bound.ds_slots.resize(required_size);
}
// For any previously bound sets, need to set them to "invalid" if they were disturbed by this update
for (uint32_t set_idx = 0; set_idx < first_set; ++set_idx) {
auto &ds_slot = last_bound.ds_slots[set_idx];
if (ds_slot.compat_id_for_set != pipe_compat_ids[set_idx]) {
PushDescriptorCleanup(last_bound, set_idx);
ds_slot.Reset();
ds_slot.compat_id_for_set = pipe_compat_ids[set_idx];
}
}
// Now update the bound sets with the input sets
const uint32_t *input_dynamic_offsets = p_dynamic_offsets; // "read" pointer for dynamic offset data
for (uint32_t input_idx = 0; input_idx < set_count; input_idx++) {
auto set_idx = input_idx + first_set; // set_idx is index within layout, input_idx is index within input descriptor sets
auto &ds_slot = last_bound.ds_slots[set_idx];
auto descriptor_set =
push_descriptor_set ? push_descriptor_set : dev_data.Get<vvl::DescriptorSet>(pDescriptorSets[input_idx]);
ds_slot.Reset();
// Record binding (or push)
if (descriptor_set != last_bound.push_descriptor_set) {
// Only cleanup the push descriptors if they aren't the currently used set.
PushDescriptorCleanup(last_bound, set_idx);
}
ds_slot.ds_state = descriptor_set;
ds_slot.compat_id_for_set = pipe_compat_ids[set_idx]; // compat ids are canonical *per* set index
if (descriptor_set) {
auto set_dynamic_descriptor_count = descriptor_set->GetDynamicDescriptorCount();
// TODO: Add logic for tracking push_descriptor offsets (here or in caller)
if (set_dynamic_descriptor_count && input_dynamic_offsets) {
const uint32_t *end_offset = input_dynamic_offsets + set_dynamic_descriptor_count;
ds_slot.dynamic_offsets = std::vector<uint32_t>(input_dynamic_offsets, end_offset);
input_dynamic_offsets = end_offset;
assert(input_dynamic_offsets <= (p_dynamic_offsets + dynamic_offset_count));
} else {
ds_slot.dynamic_offsets.clear();
}
}
}
for (auto &item : sub_states_) {
item.second->UpdateLastBoundDescriptorSets(pipeline_bind_point, loc);
}
}
void CommandBuffer::UpdateLastBoundDescriptorBuffers(VkPipelineBindPoint pipeline_bind_point,
std::shared_ptr<const vvl::PipelineLayout> pipeline_layout, uint32_t first_set,
uint32_t set_count, const uint32_t *buffer_indicies,
const VkDeviceSize *buffer_offsets) {
uint32_t required_size = first_set + set_count;
const uint32_t last_binding_index = required_size - 1;
assert(last_binding_index < pipeline_layout->set_compat_ids.size());
auto &last_bound = lastBound[ConvertToVvlBindPoint(pipeline_bind_point)];
last_bound.desc_set_pipeline_layout = pipeline_layout;
auto &pipe_compat_ids = pipeline_layout->set_compat_ids;
// Resize binding arrays
if (last_binding_index >= last_bound.ds_slots.size()) {
last_bound.ds_slots.resize(required_size);
}
const uint32_t current_size = static_cast<uint32_t>(last_bound.ds_slots.size());
// Clean up the "disturbed" before and after the range to be set
if (required_size < current_size) {
if (last_bound.ds_slots[last_binding_index].compat_id_for_set != pipe_compat_ids[last_binding_index]) {
// We're disturbing those after last, we'll shrink below, but first need to check for and cleanup the push_descriptor
for (auto set_idx = required_size; set_idx < current_size; ++set_idx) {
if (PushDescriptorCleanup(last_bound, set_idx)) {
break;
}
}
} else {
// We're not disturbing past last, so leave the upper binding data alone.
required_size = current_size;
}
}
// We resize if we need more set entries or if those past "last" are disturbed
if (required_size != current_size) {
last_bound.ds_slots.resize(required_size);
}
// For any previously bound sets, need to set them to "invalid" if they were disturbed by this update
for (uint32_t set_idx = 0; set_idx < first_set; ++set_idx) {
PushDescriptorCleanup(last_bound, set_idx);
last_bound.ds_slots[set_idx].Reset();
}
// Now update the bound sets with the input sets
for (uint32_t input_idx = 0; input_idx < set_count; input_idx++) {
auto set_idx = input_idx + first_set; // set_idx is index within layout, input_idx is index within input descriptor sets
auto &ds_slot = last_bound.ds_slots[set_idx];
ds_slot.Reset();
// Record binding
ds_slot.descriptor_buffer_binding = {buffer_indicies[input_idx], buffer_offsets[input_idx]};
ds_slot.compat_id_for_set = pipe_compat_ids[set_idx]; // compat ids are canonical *per* set index
}
}
// Set image layout for given subresource range
void CommandBuffer::SetImageLayout(const vvl::Image &image_state, const VkImageSubresourceRange &normalized_subresource_range,
VkImageLayout layout, VkImageLayout expected_layout) {
if (auto image_layout_map = GetOrCreateImageLayoutMap(image_state)) {
if (image_state.subresource_encoder.InRange(normalized_subresource_range)) {
RangeGenerator range_gen(image_state.subresource_encoder, normalized_subresource_range);
if (UpdateCurrentLayout(*image_layout_map, std::move(range_gen), layout, expected_layout,
normalized_subresource_range.aspectMask)) {
image_layout_change_count++; // Change the version of this data to force revalidation
}
}
}
}
void CommandBuffer::TrackImageViewFirstLayout(const vvl::ImageView &view_state, VkImageLayout layout) {
if (dev_data.disabled[image_layout_validation]) {
return;
}
vvl::Image *image_state = view_state.image_state.get();
auto image_layout_map = (image_state && !image_state->Destroyed()) ? GetOrCreateImageLayoutMap(*image_state) : nullptr;
if (image_layout_map) {
RangeGenerator range_gen(view_state.range_generator);
TrackFirstLayout(*image_layout_map, std::move(range_gen), layout, view_state.normalized_subresource_range.aspectMask);
}
}
void CommandBuffer::TrackImageFirstLayout(const vvl::Image &image_state, const VkImageSubresourceRange &subresource_range,
int32_t depth_offset, uint32_t depth_extent,
VkImageLayout layout) {
if (auto image_layout_map = GetOrCreateImageLayoutMap(image_state)) {
VkImageSubresourceRange normalized_subresource_range = image_state.NormalizeSubresourceRange(subresource_range);
if (dev_data.extensions.vk_khr_maintenance9 && image_state.create_info.imageType == VK_IMAGE_TYPE_3D &&
(image_state.create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) != 0 && depth_extent != 0) {
normalized_subresource_range.baseArrayLayer = (uint32_t)depth_offset;
normalized_subresource_range.layerCount = depth_extent;
}
if (image_state.subresource_encoder.InRange(normalized_subresource_range)) {
RangeGenerator range_gen(image_state.subresource_encoder, normalized_subresource_range);
TrackFirstLayout(*image_layout_map, std::move(range_gen), layout, normalized_subresource_range.aspectMask);
}
}
}
// Set image layout for all slices of an image view
void CommandBuffer::SetImageViewLayout(const vvl::ImageView &view_state, VkImageLayout layout, VkImageLayout layoutStencil) {
const vvl::Image *image_state = view_state.image_state.get();
VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
SetImageLayout(*image_state, sub_range, layout);
sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
SetImageLayout(*image_state, sub_range, layoutStencil);
} else {
// If layoutStencil is kInvalidLayout (meaning no separate depth/stencil layout), image view format has both depth and
// stencil aspects, and subresource has only one of aspect out of depth or stencil, then the missing aspect will also be
// transitioned and thus must be included explicitly
if (const VkFormat format = view_state.create_info.format; vkuFormatIsDepthAndStencil(format)) {
if (layoutStencil == kInvalidLayout &&
(sub_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
sub_range.aspectMask |= VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
}
}
SetImageLayout(*image_state, sub_range, layout);
}
}
void CommandBuffer::RecordStateCmd(CBDynamicState state) {
command_count++;
RecordDynamicState(state);
vvl::Pipeline *pipeline = GetLastBoundGraphics().pipeline_state;
if (pipeline && !pipeline->IsDynamic(state)) {
dirty_static_state = true;
}
}
void CommandBuffer::RecordDynamicState(CBDynamicState state) {
dynamic_state_status.cb.set(state);
dynamic_state_status.pipeline.set(state);
dynamic_state_status.history.set(state);
}
void CommandBuffer::RecordSetViewport(uint32_t first_viewport, uint32_t viewport_count, const VkViewport *viewports) {
RecordStateCmd(CB_DYNAMIC_STATE_VIEWPORT);
if (dynamic_state_value.viewports.size() < first_viewport + viewport_count) {
dynamic_state_value.viewports.resize(first_viewport + viewport_count);
}
for (size_t i = 0; i < viewport_count; ++i) {
dynamic_state_value.viewports[first_viewport + i] = viewports[i];
}
for (auto &item : sub_states_) {
item.second->RecordSetViewport(first_viewport, viewport_count);
}
}
void CommandBuffer::RecordSetViewportWithCount(uint32_t viewport_count, const VkViewport *viewports) {
RecordStateCmd(CB_DYNAMIC_STATE_VIEWPORT_WITH_COUNT);
dynamic_state_value.viewport_count = viewport_count;
dynamic_state_value.viewports.resize(viewport_count);
for (size_t i = 0; i < viewport_count; ++i) {
dynamic_state_value.viewports[i] = viewports[i];
}
for (auto &item : sub_states_) {
item.second->RecordSetViewportWithCount(viewport_count);
}
}
void CommandBuffer::RecordSetScissor(uint32_t first_scissor, uint32_t scissor_count) {
RecordStateCmd(CB_DYNAMIC_STATE_SCISSOR);
for (auto &item : sub_states_) {
item.second->RecordSetScissor(first_scissor, scissor_count);
}
}
void CommandBuffer::RecordSetScissorWithCount(uint32_t scissor_count) {
RecordStateCmd(CB_DYNAMIC_STATE_SCISSOR_WITH_COUNT);
dynamic_state_value.scissor_count = scissor_count;
for (auto &item : sub_states_) {
item.second->RecordSetScissorWithCount(scissor_count);
}
}
void CommandBuffer::RecordSetDepthCompareOp(VkCompareOp depth_compare_op) {
RecordStateCmd(CB_DYNAMIC_STATE_DEPTH_COMPARE_OP);
for (auto &item : sub_states_) {
item.second->RecordSetDepthCompareOp(depth_compare_op);
}
}
void CommandBuffer::RecordSetDepthTestEnable(VkBool32 depth_test_enable) {
RecordStateCmd(CB_DYNAMIC_STATE_DEPTH_TEST_ENABLE);
dynamic_state_value.depth_test_enable = depth_test_enable;
for (auto &item : sub_states_) {
item.second->RecordSetDepthTestEnable(depth_test_enable);
}
}
void CommandBuffer::RecordCopyBuffer(vvl::Buffer &src_buffer_state, vvl::Buffer &dst_buffer_state, uint32_t region_count,
const VkBufferCopy *regions, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyBuffer(src_buffer_state, dst_buffer_state, region_count, regions, loc);
}
}
void CommandBuffer::RecordCopyBuffer2(vvl::Buffer &src_buffer_state, vvl::Buffer &dst_buffer_state, uint32_t region_count,
const VkBufferCopy2 *regions, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyBuffer2(src_buffer_state, dst_buffer_state, region_count, regions, loc);
}
}
void CommandBuffer::RecordCopyImage(vvl::Image &src_image_state, vvl::Image &dst_image_state, VkImageLayout src_image_layout,
VkImageLayout dst_image_layout, uint32_t region_count, const VkImageCopy *regions,
const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyImage(src_image_state, dst_image_state, src_image_layout, dst_image_layout, region_count, regions,
loc);
}
}
void CommandBuffer::RecordCopyImage2(vvl::Image &src_image_state, vvl::Image &dst_image_state, VkImageLayout src_image_layout,
VkImageLayout dst_image_layout, uint32_t region_count, const VkImageCopy2 *regions,
const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyImage2(src_image_state, dst_image_state, src_image_layout, dst_image_layout, region_count, regions,
loc);
}
}
void CommandBuffer::RecordCopyBufferToImage(vvl::Buffer &src_buffer_state, vvl::Image &dst_image_state,
VkImageLayout dst_image_layout, uint32_t region_count, const VkBufferImageCopy *regions,
const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyBufferToImage(src_buffer_state, dst_image_state, dst_image_layout, region_count, regions, loc);
}
}
void CommandBuffer::RecordCopyBufferToImage2(vvl::Buffer &src_buffer_state, vvl::Image &dst_image_state,
VkImageLayout dst_image_layout, uint32_t region_count,
const VkBufferImageCopy2 *regions, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyBufferToImage2(src_buffer_state, dst_image_state, dst_image_layout, region_count, regions, loc);
}
}
void CommandBuffer::RecordCopyImageToBuffer(vvl::Image &src_image_state, vvl::Buffer &dst_buffer_state,
VkImageLayout src_image_layout, uint32_t region_count, const VkBufferImageCopy *regions,
const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyImageToBuffer(src_image_state, dst_buffer_state, src_image_layout, region_count, regions, loc);
}
}
void CommandBuffer::RecordCopyImageToBuffer2(vvl::Image &src_image_state, vvl::Buffer &dst_buffer_state,
VkImageLayout src_image_layout, uint32_t region_count,
const VkBufferImageCopy2 *regions, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordCopyImageToBuffer2(src_image_state, dst_buffer_state, src_image_layout, region_count, regions, loc);
}
}
void CommandBuffer::RecordBlitImage(vvl::Image &src_image_state, vvl::Image &dst_image_state, VkImageLayout src_image_layout,
VkImageLayout dst_image_layout, uint32_t region_count, const VkImageBlit *regions,
const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordBlitImage(src_image_state, dst_image_state, src_image_layout, dst_image_layout, region_count, regions,
loc);
}
}
void CommandBuffer::RecordBlitImage2(vvl::Image &src_image_state, vvl::Image &dst_image_state, VkImageLayout src_image_layout,
VkImageLayout dst_image_layout, uint32_t region_count, const VkImageBlit2 *regions,
const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordBlitImage2(src_image_state, dst_image_state, src_image_layout, dst_image_layout, region_count, regions,
loc);
}
}
void CommandBuffer::RecordResolveImage(vvl::Image &src_image_state, vvl::Image &dst_image_state, uint32_t region_count,
const VkImageResolve *regions, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordResolveImage(src_image_state, dst_image_state, region_count, regions, loc);
}
}
void CommandBuffer::RecordResolveImage2(vvl::Image &src_image_state, vvl::Image &dst_image_state, uint32_t region_count,
const VkImageResolve2 *regions, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordResolveImage2(src_image_state, dst_image_state, region_count, regions, loc);
}
}
void CommandBuffer::RecordClearColorImage(vvl::Image &image_state, VkImageLayout image_layout,
const VkClearColorValue *color_values, uint32_t range_count,
const VkImageSubresourceRange *ranges, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordClearColorImage(image_state, image_layout, color_values, range_count, ranges, loc);
}
}
void CommandBuffer::RecordClearDepthStencilImage(vvl::Image &image_state, VkImageLayout image_layout,
const VkClearDepthStencilValue *depth_stencil_values, uint32_t range_count,
const VkImageSubresourceRange *ranges, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordClearDepthStencilImage(image_state, image_layout, depth_stencil_values, range_count, ranges, loc);
}
}
void CommandBuffer::RecordClearAttachments(uint32_t attachment_count, const VkClearAttachment *pAttachments, uint32_t rect_count,
const VkClearRect *pRects, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordClearAttachments(attachment_count, pAttachments, rect_count, pRects, loc);
}
}
void CommandBuffer::RecordFillBuffer(vvl::Buffer &buffer_state, VkDeviceSize offset, VkDeviceSize size, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordFillBuffer(buffer_state, offset, size, loc);
}
}
void CommandBuffer::RecordUpdateBuffer(vvl::Buffer &buffer_state, VkDeviceSize offset, VkDeviceSize size, const Location &loc) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordUpdateBuffer(buffer_state, offset, size, loc);
}
}
void CommandBuffer::RecordSetEvent(VkEvent event, VkPipelineStageFlags2 stage_mask, const VkDependencyInfo *dependency_info) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordSetEvent(event, stage_mask, dependency_info);
}
if (!dev_data.disabled[command_buffer_state]) {
if (auto event_state = dev_data.Get<vvl::Event>(event)) {
AddChild(event_state);
}
}
events.push_back(event);
if (!waited_events.count(event)) {
write_events_before_wait.push_back(event);
}
}
void CommandBuffer::RecordResetEvent(VkEvent event, VkPipelineStageFlags2 stage_mask) {
command_count++;
for (auto &item : sub_states_) {
item.second->RecordResetEvent(event, stage_mask);
}
if (!dev_data.disabled[command_buffer_state]) {
if (auto event_state = dev_data.Get<vvl::Event>(event)) {
AddChild(event_state);
}
}
events.push_back(event);
if (!waited_events.count(event)) {
write_events_before_wait.push_back(event);
}
}
void CommandBuffer::RecordWaitEvents(uint32_t eventCount, const VkEvent *pEvents, VkPipelineStageFlags2 src_stage_mask,
const VkDependencyInfo *dependency_info, const Location &loc) {
for (auto &item : sub_states_) {
item.second->RecordWaitEvents(eventCount, pEvents, src_stage_mask, dependency_info, loc);
}
for (uint32_t i = 0; i < eventCount; ++i) {
const VkEvent event_hanle = pEvents[i];
if (!dev_data.disabled[command_buffer_state]) {
if (auto event_state = dev_data.Get<vvl::Event>(event_hanle)) {
AddChild(event_state);
}
}
waited_events.insert(event_hanle);
events.push_back(event_hanle);
}
}
void CommandBuffer::RecordBarrierObjects(uint32_t buffer_barrier_count, const VkBufferMemoryBarrier *buffer_barriers,
uint32_t image_barrier_count, const VkImageMemoryBarrier *image_barriers,
VkPipelineStageFlags src_stage_mask, VkPipelineStageFlags dst_stage_mask,
const Location &loc) {
if (!dev_data.disabled[command_buffer_state]) {
for (uint32_t i = 0; i < buffer_barrier_count; i++) {
if (auto buffer_state = dev_data.Get<vvl::Buffer>(buffer_barriers[i].buffer)) {
AddChild(buffer_state);
}
}
for (uint32_t i = 0; i < image_barrier_count; i++) {
if (auto image_state = dev_data.Get<vvl::Image>(image_barriers[i].image)) {
AddChild(image_state);
}
}
}
for (auto &item : sub_states_) {
item.second->RecordBarriers(buffer_barrier_count, buffer_barriers, image_barrier_count, image_barriers, src_stage_mask,
dst_stage_mask, loc);
}
}
void CommandBuffer::RecordBarrierObjects(const VkDependencyInfo &dep_info, const Location &loc) {
if (!dev_data.disabled[command_buffer_state]) {
for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
if (auto buffer_state = dev_data.Get<vvl::Buffer>(dep_info.pBufferMemoryBarriers[i].buffer)) {
AddChild(buffer_state);
}
}
for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
if (auto image_state = dev_data.Get<vvl::Image>(dep_info.pImageMemoryBarriers[i].image)) {
AddChild(image_state);
}
}
}
// TODO - When moving here, these were not in CoreCheck, need to understand if we want SetEvents or not to validate the same
// things as WaitEvent/PipelineBarriers
if (loc.function != vvl::Func::vkCmdSetEvent2 && loc.function != vvl::Func::vkCmdSetEvent2KHR) {
for (auto &item : sub_states_) {
item.second->RecordBarriers2(dep_info, loc);
}
}
}
void CommandBuffer::RecordPushConstants(const vvl::PipelineLayout &pipeline_layout_state, VkShaderStageFlags stage_flags,
uint32_t offset, uint32_t size, const void *values) {
// Discussed in details in https://github.com/KhronosGroup/Vulkan-Docs/issues/1081
// Internal discussion and CTS were written to prove that this is not called after an incompatible vkCmdBindPipeline
// "Binding a pipeline with a layout that is not compatible with the push constant layout does not disturb the push constant
// values"
//
// vkCmdBindDescriptorSet has nothing to do with push constants and don't need to call this after neither
//
// Part of this assumes apps at draw/dispatch/traceRays/etc time will have it properly compatible or else other VU will be
// triggered
if (push_constant_ranges_layout != pipeline_layout_state.push_constant_ranges_layout) {
push_constant_ranges_layout = pipeline_layout_state.push_constant_ranges_layout;
for (auto &item : sub_states_) {
item.second->ClearPushConstants();
}
}
for (auto &item : sub_states_) {
item.second->RecordPushConstants(pipeline_layout_state.VkHandle(), stage_flags, offset, size, values);
}
}
void CommandBuffer::RecordBeginConditionalRendering() {
command_count++;
conditional_rendering_active = true;
conditional_rendering_inside_render_pass = active_render_pass != nullptr;
conditional_rendering_subpass = GetActiveSubpass();
}
void CommandBuffer::RecordEndConditionalRendering() {
command_count++;
conditional_rendering_active = false;
conditional_rendering_inside_render_pass = false;
conditional_rendering_subpass = 0;
}
void CommandBuffer::RecordSetRenderingInputAttachmentIndices(const VkRenderingInputAttachmentIndexInfo *pLocationInfo) {
command_count++;
rendering_attachments.set_color_indexes = true;
rendering_attachments.color_indexes.resize(pLocationInfo->colorAttachmentCount);
for (uint32_t i = 0; i < pLocationInfo->colorAttachmentCount; ++i) {
rendering_attachments.color_indexes[i] =
pLocationInfo->pColorAttachmentInputIndices ? pLocationInfo->pColorAttachmentInputIndices[i] : i;
}
rendering_attachments.depth_index = pLocationInfo->pDepthInputAttachmentIndex;
rendering_attachments.stencil_index = pLocationInfo->pStencilInputAttachmentIndex;
}
void CommandBuffer::SubmitTimeValidate(Queue &queue_state, uint32_t perf_submit_pass, const Location &loc) {
for (const auto &it : video_session_updates) {
auto video_session_state = dev_data.Get<vvl::VideoSession>(it.first);
auto device_state = video_session_state->DeviceStateWrite();
for (const auto &function : it.second) {
function(video_session_state.get(), *device_state, /*do_validate*/ false);
}
}
for (auto &item : sub_states_) {
item.second->Submit(queue_state, perf_submit_pass, loc);
}
}
uint32_t CommandBuffer::GetDynamicRenderingColorAttachmentCount() const {
if (active_render_pass) {
if (active_render_pass->use_dynamic_rendering_inherited) {
return active_render_pass->inheritance_rendering_info.colorAttachmentCount;
}
if (active_render_pass->use_dynamic_rendering) {
return active_render_pass->dynamic_rendering_begin_rendering_info.colorAttachmentCount;
}
}
return 0;
}
uint32_t CommandBuffer::GetDynamicRenderingAttachmentIndex(AttachmentInfo::Type type) const {
// The first indexes are the color attachments, multiply by 2 as each has a resolve attachment index
const uint32_t color_offset = 2 * GetDynamicRenderingColorAttachmentCount();
switch (type) {
case AttachmentInfo::Type::Depth:
return color_offset;
case AttachmentInfo::Type::DepthResolve:
return color_offset + 1;
case AttachmentInfo::Type::Stencil:
return color_offset + 2;
case AttachmentInfo::Type::StencilResolve:
return color_offset + 3;
case AttachmentInfo::Type::FragmentDensityMap:
return color_offset + 4;
default:
assert(false);
}
return 0;
}
bool CommandBuffer::HasValidDepthAttachment() const {
if (active_render_pass) {
if (active_render_pass->use_dynamic_rendering_inherited) {
return active_render_pass->inheritance_rendering_info.depthAttachmentFormat != VK_FORMAT_UNDEFINED;
} else if (active_render_pass->use_dynamic_rendering) {
return active_render_pass->dynamic_rendering_begin_rendering_info.pDepthAttachment != nullptr;
} else {
return active_render_pass->UsesDepthStencilAttachment(GetActiveSubpass());
}
}
return false;
}
bool CommandBuffer::HasExternalFormatResolveAttachment() const {
if (active_render_pass && active_render_pass->use_dynamic_rendering &&
active_render_pass->dynamic_rendering_begin_rendering_info.colorAttachmentCount > 0) {
return active_render_pass->dynamic_rendering_begin_rendering_info.pColorAttachments->resolveMode ==
VK_RESOLVE_MODE_EXTERNAL_FORMAT_DOWNSAMPLE_BIT_ANDROID;
}
return false;
}
void CommandBuffer::BindShader(VkShaderStageFlagBits shader_stage, vvl::ShaderObject *shader_object_state) {
auto &last_bound_state = lastBound[ConvertStageToVvlBindPoint(shader_stage)];
const auto stage_index = static_cast<uint32_t>(ConvertToShaderObjectStage(shader_stage));
last_bound_state.shader_object_bound[stage_index] = true;
last_bound_state.shader_object_states[stage_index] = shader_object_state;
}
// Only called for Graphics and during Multiview
// "When multiview is enabled, at the beginning of each subpass all non-render pass state is undefined."
void CommandBuffer::UnbindResources() {
// Vertex and index buffers
index_buffer_binding.reset();
current_vertex_buffer_binding_info.clear();
// Push constants
push_constant_ranges_layout.reset();
// Reset status of graphics cb to force rebinding of all resources
dynamic_state_status.cb.reset();
dynamic_state_status.pipeline.reset();
dynamic_state_status.history.reset();
// Pipeline and descriptor sets
lastBound[vvl::BindPointGraphics].Reset();
}
LogObjectList CommandBuffer::GetObjectList(VkShaderStageFlagBits stage) const {
LogObjectList objlist(handle_);
const auto &last_bound = lastBound[ConvertStageToVvlBindPoint(stage)];
const auto *pipeline_state = last_bound.pipeline_state;
if (pipeline_state) {
objlist.add(pipeline_state->Handle());
} else if (VkShaderEXT shader = last_bound.GetShader(ConvertToShaderObjectStage(stage))) {
objlist.add(shader);
}
return objlist;
}
LogObjectList CommandBuffer::GetObjectList(VkPipelineBindPoint pipeline_bind_point) const {
LogObjectList objlist(handle_);
const auto &last_bound = lastBound[ConvertToVvlBindPoint(pipeline_bind_point)];
const auto *pipeline_state = last_bound.pipeline_state;
if (pipeline_state) {
objlist.add(pipeline_state->Handle());
} else if (pipeline_bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::COMPUTE)) {
objlist.add(shader);
}
} else if (pipeline_bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
// If using non-compute, need to check all graphics stages
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::VERTEX)) {
objlist.add(shader);
}
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::TESSELLATION_CONTROL)) {
objlist.add(shader);
}
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::TESSELLATION_EVALUATION)) {
objlist.add(shader);
}
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::GEOMETRY)) {
objlist.add(shader);
}
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::FRAGMENT)) {
objlist.add(shader);
}
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::MESH)) {
objlist.add(shader);
}
if (VkShaderEXT shader = last_bound.GetShader(ShaderObjectStage::TASK)) {
objlist.add(shader);
}
}
// If using dynamic rendering, will just not add anything
if (pipeline_bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS && active_render_pass) {
objlist.add(active_render_pass->Handle());
}
return objlist;
}
void CommandBuffer::BeginLabel(const char *label_name) {
++label_stack_depth_;
label_commands_.emplace_back(LabelCommand{true, label_name});
}
void CommandBuffer::EndLabel() {
--label_stack_depth_;
label_commands_.emplace_back(LabelCommand{false, std::string()});
}
void CommandBuffer::ReplayLabelCommands(const vvl::span<const LabelCommand> &label_commands,
std::vector<std::string> &label_stack) {
for (const LabelCommand &command : label_commands) {
if (command.begin) {
label_stack.emplace_back(command.label_name.empty() ? "(empty label)" : command.label_name);
} else if (!label_stack.empty()) {
// The above condition is needed for several reasons. On the primary command buffer level
// the labels are not necessary balanced. And if the empty stack is detected in the context
// where it is an error, then it will be reported by the core validation, but we still need
// a safety check.
label_stack.pop_back();
}
}
}
std::string CommandBuffer::GetDebugRegionName(const std::vector<LabelCommand> &label_commands, uint32_t label_command_index,
const std::vector<std::string> &initial_label_stack) {
if (label_command_index >= label_commands.size()) {
// Can happen due to core validation error when in-use command buffer was re-recorded.
// It's a bug if this happens in a valid vulkan program.
return {};
}
auto label_commands_to_replay = vvl::make_span(label_commands.data(), label_command_index + 1);
auto label_stack = initial_label_stack;
vvl::CommandBuffer::ReplayLabelCommands(label_commands_to_replay, label_stack);
// Build up complete debug region name from all enclosing regions
std::string debug_region;
for (const std::string &label_name : label_stack) {
if (!debug_region.empty()) {
debug_region += "::";
}
debug_region += label_name;
}
return debug_region;
}
std::string CommandBuffer::DescribeInvalidatedState(CBDynamicState dynamic_state) const {
std::stringstream ss;
if (dynamic_state_status.history[dynamic_state] && !dynamic_state_status.cb[dynamic_state]) {
ss << " (There was a call to vkCmdBindPipeline";
if (auto pipeline = dev_data.Get<vvl::Pipeline>(invalidated_state_pipe[dynamic_state])) {
ss << " with " << dev_data.FormatHandle(*pipeline);
}
ss << " that didn't have " << DynamicStateToString(dynamic_state) << " and invalidated the prior "
<< DescribeDynamicStateCommand(dynamic_state) << " call)";
}
return ss.str();
}
VulkanTypedHandle CommandBufferSubState::Handle() const { return base.Handle(); }
VkCommandBuffer CommandBufferSubState::VkHandle() const { return base.VkHandle(); }
} // namespace vvl
|