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 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
|
/* 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.
* Copyright (c) 2025 Arm Limited.
* Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
*
* 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 <cassert>
#include <cinttypes>
#include <cstdint>
#include <memory>
#include <spirv/unified1/spirv.hpp>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
#include <vulkan/vk_enum_string_helper.h>
#include <vulkan/utility/vk_format_utils.h>
#include <vulkan/vulkan_core.h>
#include "core_checks/cc_vuid_maps.h"
#include "core_validation.h"
#include "generated/spirv_grammar_helper.h"
#include "generated/spirv_validation_helper.h"
#include "state_tracker/shader_instruction.h"
#include "state_tracker/shader_module.h"
#include "state_tracker/shader_stage_state.h"
#include "state_tracker/pipeline_state.h"
#include "utils/shader_utils.h"
#include "utils/hash_util.h"
#include "chassis/chassis_modification_state.h"
#include "state_tracker/descriptor_sets.h"
#include "state_tracker/descriptor_set_layouts.h"
#include "state_tracker/render_pass_state.h"
#include "spirv-tools/optimizer.hpp"
#include "containers/limits.h"
#include "containers/container_utils.h"
#include "utils/math_utils.h"
// Validate use of input attachments against subpass structure
bool CoreChecks::ValidateShaderInputAttachment(const spirv::Module& module_state, const ShaderStageState& stage_state,
const vvl::Pipeline& pipeline, const spirv::ResourceInterfaceVariable& variable,
const Location& loc) const {
bool skip = false;
assert(variable.is_input_attachment);
const auto &rp_state = pipeline.RenderPassState();
// Dynamic Rendering guards this with VUID 06061
if (!rp_state || rp_state->UsesDynamicRendering()) {
return skip;
}
const auto rpci = rp_state->create_info.ptr();
const uint32_t subpass = pipeline.Subpass();
const auto subpass_description = rpci->pSubpasses[subpass];
const auto input_attachments = subpass_description.pInputAttachments;
auto print_index = [variable](uint32_t i) {
std::stringstream ss;
ss << variable.DescribeDescriptor() << " has an InputAttachmentIndex of "
<< variable.decorations.input_attachment_index_start;
if (variable.IsArray()) {
ss << ", plus " << (i - variable.decorations.input_attachment_index_start) << " from indexing into the array,";
}
return ss.str();
};
for (const auto i : variable.input_attachment_index_read) {
// offsets by the InputAttachmentIndex decoration
const uint32_t input_attachment_index = variable.decorations.input_attachment_index_start + i;
// Same error, but provide more useful message 'how' VK_ATTACHMENT_UNUSED is derived
if (!input_attachments) {
const LogObjectList objlist(module_state.handle(), pipeline.Handle(), rp_state->Handle());
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-renderPass-06038", objlist, loc,
"%s but pSubpasses[%" PRIu32 "].pInputAttachments is NULL.",
print_index(input_attachment_index).c_str(), subpass);
} else if (input_attachment_index >= subpass_description.inputAttachmentCount) {
const LogObjectList objlist(module_state.handle(), pipeline.Handle(), rp_state->Handle());
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-renderPass-06038", objlist, loc,
"%s but that is not less than the pSubpasses[%" PRIu32 "].inputAttachmentCount (%" PRIu32 ").",
print_index(input_attachment_index).c_str(), subpass, subpass_description.inputAttachmentCount);
} else if (input_attachments[input_attachment_index].attachment == VK_ATTACHMENT_UNUSED) {
const LogObjectList objlist(module_state.handle(), pipeline.Handle(), rp_state->Handle());
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-renderPass-06038", objlist, loc,
"%s but pSubpasses[%" PRIu32 "].pInputAttachments[%" PRIu32 "].attachment is VK_ATTACHMENT_UNUSED.",
print_index(input_attachment_index).c_str(), subpass, input_attachment_index);
}
}
return skip;
}
bool CoreChecks::ValidatePushConstantUsage(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const vvl::Pipeline *pipeline, const ShaderStageState &stage_state,
const Location &loc) const {
bool skip = false;
// TODO - Workaround for https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/5911
if (module_state.static_data_.has_specialization_constants) {
return skip;
}
const VkShaderStageFlagBits stage = entrypoint.stage;
const auto push_constant_variable = entrypoint.push_constant_variable;
if (!push_constant_variable) {
return skip;
}
PushConstantRangesId shader_object_push_constant_ranges_id;
std::vector<VkPushConstantRange> const *push_constant_ranges;
std::string stage_vuid;
std::string range_vuid;
if (pipeline) {
push_constant_ranges = pipeline->PipelineLayoutState()->push_constant_ranges_layout.get();
switch (pipeline->GetCreateInfoSType()) {
case VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO:
stage_vuid = "VUID-VkGraphicsPipelineCreateInfo-layout-07987";
range_vuid = "VUID-VkGraphicsPipelineCreateInfo-layout-10069";
break;
case VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO:
stage_vuid = "VUID-VkComputePipelineCreateInfo-layout-07987";
range_vuid = "VUID-VkComputePipelineCreateInfo-layout-10069";
break;
case VK_STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_KHR:
stage_vuid = "VUID-VkRayTracingPipelineCreateInfoKHR-layout-07987";
range_vuid = "VUID-VkRayTracingPipelineCreateInfoKHR-layout-10069";
break;
case VK_STRUCTURE_TYPE_RAY_TRACING_PIPELINE_CREATE_INFO_NV:
stage_vuid = "VUID-VkRayTracingPipelineCreateInfoNV-layout-07987";
range_vuid = "VUID-VkRayTracingPipelineCreateInfoNV-layout-10069";
break;
default:
assert(false);
break;
}
} else {
shader_object_push_constant_ranges_id = GetCanonicalId(stage_state.shader_object_create_info->pushConstantRangeCount,
stage_state.shader_object_create_info->pPushConstantRanges);
push_constant_ranges = shader_object_push_constant_ranges_id.get();
stage_vuid = "VUID-VkShaderCreateInfoEXT-codeType-10064";
range_vuid = "VUID-VkShaderCreateInfoEXT-codeType-10065";
}
bool found_stage = false;
for (auto const &range : *push_constant_ranges) {
if (range.stageFlags & stage) {
found_stage = true;
const uint32_t range_end = range.offset + range.size;
const uint32_t push_constant_end = push_constant_variable->offset + push_constant_variable->size;
// spec: "If a push constant block is declared in a shader"
// Is checked regardless if element in Block is not statically used
if ((push_constant_variable->offset < range.offset) | (push_constant_end > range_end)) {
LogObjectList objlist(module_state.handle());
if (pipeline) {
objlist.add(pipeline->PipelineLayoutState()->Handle());
}
skip |= LogError(range_vuid, objlist, loc,
"SPIR-V (%s) has a push constant buffer Block with range [%" PRIu32 ", %" PRIu32
"] which outside the VkPushConstantRange of [%" PRIu32 ", %" PRIu32 "].",
string_VkShaderStageFlags(stage).c_str(), push_constant_variable->offset, push_constant_end,
range.offset, range_end);
break;
}
}
}
if (!found_stage) {
LogObjectList objlist(module_state.handle());
std::string msg = "";
if (pipeline) {
objlist.add(pipeline->PipelineLayoutState()->Handle());
msg = FormatHandle(pipeline->PipelineLayoutState()->Handle());
} else {
msg = "VkShaderCreateInfoEXT::pPushConstantRanges";
}
skip |= LogError(stage_vuid, objlist, loc, "SPIR-V (%s) Push constant are used, but %s doesn't set %s.",
string_VkShaderStageFlags(stage).c_str(), msg.c_str(), string_VkShaderStageFlags(stage).c_str());
}
return skip;
}
static void TypeToDescriptorTypeSet(const spirv::Module &module_state, uint32_t type_id, uint32_t data_type_id, vvl::unordered_set<uint32_t> &descriptor_type_set) {
const spirv::Instruction *type = module_state.FindDef(type_id);
assert(type->Opcode() == spv::OpTypePointer || type->Opcode() == spv::OpTypeUntypedPointerKHR);
bool is_storage_buffer = type->StorageClass() == spv::StorageClassStorageBuffer;
if (data_type_id != 0) type = module_state.FindDef(data_type_id);
// Strip off any array or ptrs. Where we remove array levels, adjust the descriptor count for each dimension.
while (type->IsArray() || type->Opcode() == spv::OpTypePointer) {
if (type->Opcode() == spv::OpTypeRuntimeArray) {
type = module_state.FindDef(type->Word(2));
} else if (type->Opcode() == spv::OpTypeArray) {
type = module_state.FindDef(type->Word(2));
} else {
if (type->StorageClass() == spv::StorageClassStorageBuffer) {
is_storage_buffer = true;
}
type = module_state.FindDef(type->Word(3));
}
}
switch (type->Opcode()) {
case spv::OpTypeStruct: {
for (const spirv::Instruction *insn : module_state.static_data_.decoration_inst) {
if (insn->Word(1) == type->ResultId()) {
if (insn->Word(2) == spv::DecorationBlock) {
if (is_storage_buffer) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER);
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC);
} else {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER);
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC);
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK);
}
} else if (insn->Word(2) == spv::DecorationBufferBlock) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER);
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC);
}
break;
}
}
return;
}
case spv::OpTypeSampler:
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_SAMPLER);
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER);
return;
case spv::OpTypeSampledImage: {
// Slight relaxation for some GLSL historical madness: samplerBuffer doesn't really have a sampler, and a texel
// buffer descriptor doesn't really provide one. Allow this slight mismatch.
const spirv::Instruction *image_type = module_state.FindDef(type->Word(2));
auto dim = image_type->Word(3);
auto sampled = image_type->Word(7);
if (dim == spv::DimBuffer && sampled == 1) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER);
} else {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER);
}
return;
}
case spv::OpTypeImage: {
// Many descriptor types backing image types-- depends on dimension and whether the image will be used with a sampler.
// SPIRV for Vulkan requires that sampled be 1 or 2 -- leaving the decision to runtime is unacceptable.
auto dim = type->Word(3);
auto sampled = type->Word(7);
if (dim == spv::DimSubpassData) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT);
} else if (dim == spv::DimBuffer) {
if (sampled == 1) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER);
} else {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER);
}
} else if (sampled == 1) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE);
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER);
} else {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_STORAGE_IMAGE);
}
return;
}
// The OpType are alias, but the Descriptor Types are different
case spv::OpTypeAccelerationStructureKHR:
if (module_state.HasCapability(spv::CapabilityRayTracingNV)) {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV);
} else {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR);
}
return;
case spv::OpTypeTensorARM: {
descriptor_type_set.insert(VK_DESCRIPTOR_TYPE_TENSOR_ARM);
return;
}
default:
// We shouldn't really see any other junk types -- but if we do, they're a mismatch.
return; // Matches nothing
}
}
static std::string string_DescriptorTypeSet(const vvl::unordered_set<uint32_t> &descriptor_type_set) {
std::stringstream ss;
for (auto it = descriptor_type_set.begin(); it != descriptor_type_set.end(); ++it) {
if (ss.tellp()) ss << " or ";
ss << string_VkDescriptorType(VkDescriptorType(*it));
}
return ss.str();
}
// Map SPIR-V type to VK_COMPONENT_TYPE enum
VkComponentTypeKHR GetComponentType(const spirv::Instruction *insn, bool is_signed_int) {
if (insn->Opcode() == spv::OpTypeInt) {
switch (insn->Word(2)) {
case 8:
return is_signed_int ? VK_COMPONENT_TYPE_SINT8_KHR : VK_COMPONENT_TYPE_UINT8_KHR;
case 16:
return is_signed_int ? VK_COMPONENT_TYPE_SINT16_KHR : VK_COMPONENT_TYPE_UINT16_KHR;
case 32:
return is_signed_int ? VK_COMPONENT_TYPE_SINT32_KHR : VK_COMPONENT_TYPE_UINT32_KHR;
case 64:
return is_signed_int ? VK_COMPONENT_TYPE_SINT64_KHR : VK_COMPONENT_TYPE_UINT64_KHR;
default:
return VK_COMPONENT_TYPE_MAX_ENUM_KHR;
}
} else if (insn->Opcode() == spv::OpTypeFloat) {
switch (insn->Word(2)) {
case 8: {
assert(insn->Length() > 3); // all float8 have an encoding
const uint32_t encoding = insn->Word(3);
if (encoding == spv::FPEncodingFloat8E4M3EXT) {
return VK_COMPONENT_TYPE_FLOAT8_E4M3_EXT;
} else if (encoding == spv::FPEncodingFloat8E5M2EXT) {
return VK_COMPONENT_TYPE_FLOAT8_E5M2_EXT;
} else {
assert(false); // New float8 encoding
}
} break;
case 16: {
if (insn->Length() > 3) {
const uint32_t encoding = insn->Word(3);
if (encoding == spv::FPEncodingBFloat16KHR) {
return VK_COMPONENT_TYPE_BFLOAT16_KHR;
} else {
assert(false); // New float16 encoding
}
} else {
return VK_COMPONENT_TYPE_FLOAT16_KHR;
}
} break;
case 32:
return VK_COMPONENT_TYPE_FLOAT32_KHR;
case 64:
return VK_COMPONENT_TYPE_FLOAT64_KHR;
default:
return VK_COMPONENT_TYPE_MAX_ENUM_KHR;
}
}
return VK_COMPONENT_TYPE_MAX_ENUM_KHR;
}
static bool IsSignedIntEnum(const VkComponentTypeKHR component_type) {
switch (component_type) {
case VK_COMPONENT_TYPE_SINT8_KHR:
case VK_COMPONENT_TYPE_SINT16_KHR:
case VK_COMPONENT_TYPE_SINT32_KHR:
case VK_COMPONENT_TYPE_SINT64_KHR:
return true;
default:
return false;
}
}
// Validate SPV_KHR_cooperative_matrix (and SPV_NV_cooperative_matrix) behavior that can't be statically validated in SPIRV-Tools
// (e.g. due to specialization constant usage).
bool CoreChecks::ValidateCooperativeMatrix(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const ShaderStageState &stage_state, const spirv::LocalSize &local_size,
const Location &loc) const {
bool skip = false;
const uint64_t workgroup_size = local_size.x * local_size.y * local_size.z;
uint32_t effective_subgroup_size = phys_dev_props_core11.subgroupSize;
if (const auto *required_subgroup_size_ci =
vku::FindStructInPNextChain<VkPipelineShaderStageRequiredSubgroupSizeCreateInfo>(stage_state.GetPNext())) {
effective_subgroup_size = required_subgroup_size_ci->requiredSubgroupSize;
}
const auto &IsSignedIntType = [&module_state](const uint32_t type_id) {
const spirv::Instruction *type = module_state.FindDef(type_id);
if (type->Opcode() == spv::OpTypeCooperativeMatrixKHR || type->Opcode() == spv::OpTypeCooperativeMatrixNV) {
type = module_state.FindDef(type->Word(2));
}
return type->Opcode() == spv::OpTypeInt && type->Word(3) != 0;
};
struct CoopMatType {
VkScopeKHR scope;
uint32_t rows;
uint32_t cols;
VkComponentTypeKHR component_type;
uint32_t use;
bool all_constant;
CoopMatType(uint32_t id, const spirv::Module &module_state, bool is_signed_int) {
const spirv::Instruction *insn = module_state.FindDef(id);
const spirv::Instruction *component_type_insn = module_state.FindDef(insn->Word(2));
const spirv::Instruction *scope_insn = module_state.FindDef(insn->Word(3));
const spirv::Instruction *rows_insn = module_state.FindDef(insn->Word(4));
const spirv::Instruction *cols_insn = module_state.FindDef(insn->Word(5));
all_constant = true;
uint32_t tmp_scope = 0;
if (!module_state.GetInt32IfConstant(*scope_insn, &tmp_scope)) {
all_constant = false;
}
scope = VkScopeKHR(tmp_scope);
if (!module_state.GetInt32IfConstant(*rows_insn, &rows)) {
all_constant = false;
}
if (!module_state.GetInt32IfConstant(*cols_insn, &cols)) {
all_constant = false;
}
component_type = GetComponentType(component_type_insn, is_signed_int);
if (insn->Opcode() == spv::OpTypeCooperativeMatrixKHR) {
const spirv::Instruction *use_insn = module_state.FindDef(insn->Word(6));
if (!module_state.GetInt32IfConstant(*use_insn, &use)) {
all_constant = false;
}
}
}
std::string Describe() {
std::ostringstream ss;
ss << "rows: " << rows << ", cols: " << cols << ", scope: " << string_VkScopeKHR(scope)
<< ", type: " << string_VkComponentTypeKHR(component_type) << ", use: " << use;
return ss.str();
}
};
if (module_state.HasCapability(spv::CapabilityCooperativeMatrixKHR)) {
if (!(entrypoint.stage & phys_dev_ext_props.cooperative_matrix_props_khr.cooperativeMatrixSupportedStages)) {
skip |=
LogError("VUID-RuntimeSpirv-cooperativeMatrixSupportedStages-08985", module_state.handle(), loc,
"SPIR-V contains OpTypeCooperativeMatrixKHR used in shader stage %s but is not in "
"cooperativeMatrixSupportedStages (%s)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkShaderStageFlags(phys_dev_ext_props.cooperative_matrix_props_khr.cooperativeMatrixSupportedStages)
.c_str());
}
} else if (module_state.HasCapability(spv::CapabilityCooperativeMatrixNV)) {
if (!(entrypoint.stage & phys_dev_ext_props.cooperative_matrix_props.cooperativeMatrixSupportedStages)) {
skip |= LogError(
"VUID-RuntimeSpirv-OpTypeCooperativeMatrixNV-06322", module_state.handle(), loc,
"SPIR-V contains OpTypeCooperativeMatrixNV used in shader stage %s but is not in cooperativeMatrixSupportedStages "
"(%s)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkShaderStageFlags(phys_dev_ext_props.cooperative_matrix_props.cooperativeMatrixSupportedStages).c_str());
}
} else {
return skip; // If the capability isn't enabled, don't bother with the rest of this function.
}
if (!module_state.static_data_.cooperative_matrix_inst.empty() && api_version < VK_API_VERSION_1_3) {
bool has_full_subgroups = false;
if (stage_state.pipeline_create_info) {
has_full_subgroups =
stage_state.pipeline_create_info->flags & VK_PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT;
} else {
has_full_subgroups = stage_state.shader_object_create_info->flags & VK_SHADER_CREATE_REQUIRE_FULL_SUBGROUPS_BIT_EXT;
}
if (!has_full_subgroups) {
const char *vuid = stage_state.HasPipeline() ? "VUID-RuntimeSpirv-OpTypeCooperativeMatrixKHR-10770"
: "VUID-RuntimeSpirv-OpTypeCooperativeMatrixKHR-10771";
skip |= LogError(vuid, module_state.handle(), loc,
"SPIR-V (%s) contains SPV_KHR_cooperative_matrix which requires SPIR-V 1.6 (Vulkan 1.3). In order to "
"use it with older versions, you need to use %s (which requires VK_EXT_subgroup_size_control).",
string_VkShaderStageFlagBits(entrypoint.stage),
stage_state.HasPipeline() ? "VK_PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT"
: "VK_SHADER_CREATE_REQUIRE_FULL_SUBGROUPS_BIT_EXT");
}
}
// Map SPIR-V result ID to the ID of its type.
// TODO - Should have more robust way in ModuleState to find the type
vvl::unordered_map<uint32_t, uint32_t> id_to_type_id;
for (const spirv::Instruction &insn : module_state.GetInstructions()) {
if (OpcodeHasType(insn.Opcode()) && OpcodeHasResult(insn.Opcode())) {
id_to_type_id[insn.Word(2)] = insn.Word(1);
}
}
auto print_properties = [this]() {
std::ostringstream ss;
for (uint32_t i = 0; i < device_state->cooperative_matrix_properties_khr.size(); ++i) {
const auto &prop = device_state->cooperative_matrix_properties_khr[i];
ss << "[" << i << "] MSize = " << prop.MSize << " | NSize = " << prop.NSize << " | KSize = " << prop.KSize
<< " | AType = " << string_VkComponentTypeKHR(prop.AType) << " | BType = " << string_VkComponentTypeKHR(prop.BType)
<< " | CType = " << string_VkComponentTypeKHR(prop.CType)
<< " | ResultType = " << string_VkComponentTypeKHR(prop.ResultType) << " | scope = " << string_VkScopeKHR(prop.scope)
<< '\n';
}
return ss.str();
};
auto print_flexible_properties = [this]() {
std::ostringstream ss;
for (uint32_t i = 0; i < device_state->cooperative_matrix_flexible_dimensions_properties.size(); ++i) {
const auto &prop = device_state->cooperative_matrix_flexible_dimensions_properties[i];
ss << "[" << i << "] MGranularity = " << prop.MGranularity << " | NGranularity = " << prop.NGranularity
<< " | KGranularity = " << prop.KGranularity << " | AType = " << string_VkComponentTypeKHR(prop.AType)
<< " | BType = " << string_VkComponentTypeKHR(prop.BType) << " | CType = " << string_VkComponentTypeKHR(prop.CType)
<< " | ResultType = " << string_VkComponentTypeKHR(prop.ResultType) << " | scope = " << string_VkScopeKHR(prop.scope)
<< " | workgroupInvocations = " << prop.workgroupInvocations << '\n';
}
return ss.str();
};
for (const spirv::Instruction *cooperative_matrix_inst : module_state.static_data_.cooperative_matrix_inst) {
const spirv::Instruction &insn = *cooperative_matrix_inst;
switch (insn.Opcode()) {
case spv::OpTypeCooperativeMatrixKHR: {
CoopMatType m(insn.ResultId(), module_state, IsSignedIntType(insn.Word(2)));
if ((entrypoint.stage & VK_SHADER_STAGE_COMPUTE_BIT) != 0) {
if (SafeModulo(local_size.x, effective_subgroup_size) != 0) {
const auto vuid_string = m.scope == VK_SCOPE_SUBGROUP_KHR
? "VUID-VkPipelineShaderStageCreateInfo-module-08987"
: "VUID-VkPipelineShaderStageCreateInfo-module-10169";
skip |= LogError(vuid_string, module_state.handle(), loc,
"SPIR-V (compute stage) Local workgroup size in the X dimension (%" PRIu32
") is not a multiple of subgroupSize (%" PRIu32 ").",
local_size.x, effective_subgroup_size);
}
if (m.scope == VK_SCOPE_WORKGROUP_KHR) {
if (workgroup_size >
phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixWorkgroupScopeMaxWorkgroupSize) {
skip |= LogError(
"VUID-VkPipelineShaderStageCreateInfo-module-10169", module_state.handle(), loc,
"SPIR-V (compute stage) Total local workgroup size (%" PRIu64
") is larger than cooperativeMatrixWorkgroupScopeMaxWorkgroupSize (%" PRIu32 ").",
workgroup_size,
phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixWorkgroupScopeMaxWorkgroupSize);
}
}
}
if (!m.all_constant) {
break;
}
if (m.scope == VK_SCOPE_WORKGROUP_KHR && !enabled_features.cooperativeMatrixWorkgroupScope) {
skip |= LogError("VUID-RuntimeSpirv-cooperativeMatrixWorkgroupScope-10164", module_state.handle(), loc,
"SPIR-V (compute stage) Cooperative matrix uses workgroup scope but "
"cooperativeMatrixWorkgroupScope is not enabled.");
}
// Validate that the type parameters are all supported for one of the
// operands of a cooperative matrix khr property.
bool valid = false;
for (uint32_t i = 0; i < device_state->cooperative_matrix_properties_khr.size(); ++i) {
const auto &property = device_state->cooperative_matrix_properties_khr[i];
if (property.AType == m.component_type && property.MSize == m.rows && property.KSize == m.cols &&
property.scope == m.scope && m.use == spv::CooperativeMatrixUseMatrixAKHR) {
valid = true;
break;
}
if (property.BType == m.component_type && property.KSize == m.rows && property.NSize == m.cols &&
property.scope == m.scope && m.use == spv::CooperativeMatrixUseMatrixBKHR) {
valid = true;
break;
}
if (property.CType == m.component_type && property.MSize == m.rows && property.NSize == m.cols &&
property.scope == m.scope && m.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR) {
valid = true;
break;
}
if (property.ResultType == m.component_type && property.MSize == m.rows && property.NSize == m.cols &&
property.scope == m.scope && m.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR) {
valid = true;
break;
}
}
if (enabled_features.cooperativeMatrixFlexibleDimensions) {
for (uint32_t i = 0; i < device_state->cooperative_matrix_flexible_dimensions_properties.size(); ++i) {
const auto &property = device_state->cooperative_matrix_flexible_dimensions_properties[i];
if (property.scope == VK_SCOPE_WORKGROUP_KHR && workgroup_size != property.workgroupInvocations) {
continue;
}
if (property.AType == m.component_type && SafeModulo(m.rows, property.MGranularity) == 0 &&
SafeModulo(m.cols, property.KGranularity) == 0 && property.scope == m.scope &&
m.use == spv::CooperativeMatrixUseMatrixAKHR) {
valid = true;
break;
}
if (property.BType == m.component_type && SafeModulo(m.rows, property.KGranularity) == 0 &&
SafeModulo(m.cols, property.NGranularity) == 0 && property.scope == m.scope &&
m.use == spv::CooperativeMatrixUseMatrixBKHR) {
valid = true;
break;
}
if (property.CType == m.component_type && SafeModulo(m.rows, property.MGranularity) == 0 &&
SafeModulo(m.cols, property.NGranularity) == 0 && property.scope == m.scope &&
m.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR) {
valid = true;
break;
}
if (property.ResultType == m.component_type && SafeModulo(m.rows, property.MGranularity) == 0 &&
SafeModulo(m.cols, property.NGranularity) == 0 && property.scope == m.scope &&
m.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR) {
valid = true;
break;
}
}
}
if (!valid) {
if (!enabled_features.cooperativeMatrixFlexibleDimensions) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeMatrixKHR-10163", module_state.handle(), loc,
"SPIR-V (%s) has\n%s (%s)\nbut doesn't match any VkCooperativeMatrixPropertiesKHR\n%s.",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Describe().c_str(),
m.Describe().c_str(), print_properties().c_str());
} else {
skip |= LogError("VUID-RuntimeSpirv-cooperativeMatrixFlexibleDimensions-10165", module_state.handle(), loc,
"SPIR-V (%s) has\n%s (%s)\nbut doesn't match any VkCooperativeMatrixPropertiesKHR or "
"VkCooperativeMatrixFlexibleDimensionsPropertiesNV\n%s\n%s.",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Describe().c_str(),
m.Describe().c_str(), print_properties().c_str(), print_flexible_properties().c_str());
}
}
if (IsExtEnabled(extensions.vk_nv_cooperative_matrix2)) {
if (m.rows > phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixFlexibleDimensionsMaxDimension ||
m.cols > phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixFlexibleDimensionsMaxDimension) {
skip |= LogError(
"VUID-RuntimeSpirv-cooperativeMatrixFlexibleDimensionsMaxDimension-10167", module_state.handle(), loc,
"SPIR-V (%s) has\n%s (%s)\nbut number of rows or columns is greater than "
"cooperativeMatrixFlexibleDimensionsMaxDimension (%" PRIu32 ").",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Describe().c_str(), m.Describe().c_str(),
phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixFlexibleDimensionsMaxDimension);
}
}
break;
}
case spv::OpCooperativeMatrixMulAddKHR: {
const uint32_t flags = insn.Length() > 6 ? insn.Word(6) : 0u;
CoopMatType r(id_to_type_id[insn.Word(2)], module_state,
(flags & spv::CooperativeMatrixOperandsMatrixResultSignedComponentsKHRMask));
CoopMatType a(id_to_type_id[insn.Word(3)], module_state,
(flags & spv::CooperativeMatrixOperandsMatrixASignedComponentsKHRMask));
CoopMatType b(id_to_type_id[insn.Word(4)], module_state,
(flags & spv::CooperativeMatrixOperandsMatrixBSignedComponentsKHRMask));
CoopMatType c(id_to_type_id[insn.Word(5)], module_state,
(flags & spv::CooperativeMatrixOperandsMatrixCSignedComponentsKHRMask));
if (a.all_constant && b.all_constant && c.all_constant && r.all_constant) {
// Validate that the type parameters are all supported for the same
// cooperative matrix property.
bool found_matching_prop = false;
for (uint32_t i = 0; i < device_state->cooperative_matrix_properties_khr.size(); ++i) {
const auto &property = device_state->cooperative_matrix_properties_khr[i];
bool valid = true;
valid &= property.AType == a.component_type && property.MSize == a.rows && property.KSize == a.cols &&
property.scope == a.scope && a.use == spv::CooperativeMatrixUseMatrixAKHR;
valid &= property.BType == b.component_type && property.KSize == b.rows && property.NSize == b.cols &&
property.scope == b.scope && b.use == spv::CooperativeMatrixUseMatrixBKHR;
valid &= property.CType == c.component_type && property.MSize == c.rows && property.NSize == c.cols &&
property.scope == c.scope && c.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR;
valid &= property.ResultType == r.component_type && property.MSize == r.rows && property.NSize == r.cols &&
property.scope == r.scope && r.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR;
valid &= !IsSignedIntEnum(property.AType) ||
(flags & spv::CooperativeMatrixOperandsMatrixASignedComponentsKHRMask);
valid &= !IsSignedIntEnum(property.BType) ||
(flags & spv::CooperativeMatrixOperandsMatrixBSignedComponentsKHRMask);
valid &= !IsSignedIntEnum(property.CType) ||
(flags & spv::CooperativeMatrixOperandsMatrixCSignedComponentsKHRMask);
valid &= !IsSignedIntEnum(property.ResultType) ||
(flags & spv::CooperativeMatrixOperandsMatrixResultSignedComponentsKHRMask);
valid &= property.saturatingAccumulation ==
!!(flags & spv::CooperativeMatrixOperandsSaturatingAccumulationKHRMask);
if (valid) {
found_matching_prop = true;
break;
}
}
bool found_matching_flexible_prop = false;
if (enabled_features.cooperativeMatrixFlexibleDimensions) {
for (uint32_t i = 0; i < device_state->cooperative_matrix_flexible_dimensions_properties.size(); ++i) {
const auto &property = device_state->cooperative_matrix_flexible_dimensions_properties[i];
bool valid = true;
valid &= property.AType == a.component_type && SafeModulo(a.rows, property.MGranularity) == 0 &&
SafeModulo(a.cols, property.KGranularity) == 0 && property.scope == a.scope &&
a.use == spv::CooperativeMatrixUseMatrixAKHR;
valid &= property.BType == b.component_type && SafeModulo(b.rows, property.KGranularity) == 0 &&
SafeModulo(b.cols, property.NGranularity) == 0 && property.scope == b.scope &&
b.use == spv::CooperativeMatrixUseMatrixBKHR;
valid &= property.CType == c.component_type && SafeModulo(c.rows, property.MGranularity) == 0 &&
SafeModulo(c.cols, property.NGranularity) == 0 && property.scope == c.scope &&
c.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR;
valid &= property.ResultType == r.component_type && SafeModulo(r.rows, property.MGranularity) == 0 &&
SafeModulo(r.cols, property.NGranularity) == 0 && property.scope == r.scope &&
r.use == spv::CooperativeMatrixUseMatrixAccumulatorKHR;
valid &= !IsSignedIntEnum(property.AType) ||
(flags & spv::CooperativeMatrixOperandsMatrixASignedComponentsKHRMask);
valid &= !IsSignedIntEnum(property.BType) ||
(flags & spv::CooperativeMatrixOperandsMatrixBSignedComponentsKHRMask);
valid &= !IsSignedIntEnum(property.CType) ||
(flags & spv::CooperativeMatrixOperandsMatrixCSignedComponentsKHRMask);
valid &= !IsSignedIntEnum(property.ResultType) ||
(flags & spv::CooperativeMatrixOperandsMatrixResultSignedComponentsKHRMask);
valid &= property.saturatingAccumulation ==
!!(flags & spv::CooperativeMatrixOperandsSaturatingAccumulationKHRMask);
valid &= property.scope != VK_SCOPE_WORKGROUP_KHR || workgroup_size == property.workgroupInvocations;
if (valid) {
found_matching_flexible_prop = true;
break;
}
}
}
if (!found_matching_prop && !found_matching_flexible_prop) {
if (!enabled_features.cooperativeMatrixFlexibleDimensions) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeMatrixMulAddKHR-10060", module_state.handle(), loc,
"SPIR-V (%s) instruction\n%s\ndoesn't match a supported matrix "
"VkCooperativeMatrixPropertiesKHR\n%s\n%s\n%s\n%s\n%s\n",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Describe().c_str(),
a.Describe().c_str(), b.Describe().c_str(), c.Describe().c_str(), r.Describe().c_str(),
print_properties().c_str());
} else {
skip |=
LogError("VUID-RuntimeSpirv-cooperativeMatrixFlexibleDimensions-10166", module_state.handle(), loc,
"SPIR-V (%s) instruction\n%s\ndoesn't match a supported matrix "
"VkCooperativeMatrixPropertiesKHR or "
"VkPhysicalDeviceCooperativeMatrix2PropertiesNV\n%s\n%s\n%s\n%s\n%s\n%s\n",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Describe().c_str(),
a.Describe().c_str(), b.Describe().c_str(), c.Describe().c_str(), r.Describe().c_str(),
print_properties().c_str(), print_flexible_properties().c_str());
}
}
}
break;
}
case spv::OpTypeCooperativeMatrixNV: {
CoopMatType m(insn.ResultId(), module_state, IsSignedIntType(insn.Word(2)));
if (!m.all_constant) {
break;
}
// Validate that the type parameters are all supported for one of the
// operands of a cooperative matrix property.
bool valid = false;
for (uint32_t i = 0; i < device_state->cooperative_matrix_properties_nv.size(); ++i) {
const auto &property = device_state->cooperative_matrix_properties_nv[i];
if (property.AType == m.component_type && property.MSize == m.rows && property.KSize == m.cols &&
property.scope == m.scope) {
valid = true;
break;
}
if (property.BType == m.component_type && property.KSize == m.rows && property.NSize == m.cols &&
property.scope == m.scope) {
valid = true;
break;
}
if (property.CType == m.component_type && property.MSize == m.rows && property.NSize == m.cols &&
property.scope == m.scope) {
valid = true;
break;
}
if (property.DType == m.component_type && property.MSize == m.rows && property.NSize == m.cols &&
property.scope == m.scope) {
valid = true;
break;
}
}
if (!valid) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeMatrixNV-06316", module_state.handle(), loc,
"SPIR-V (%s) has an OpTypeCooperativeMatrixNV (result id = %" PRIu32
") operand that don't match a supported matrix type (%s).",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Word(1), m.Describe().c_str());
}
break;
}
case spv::OpCooperativeMatrixMulAddNV: {
CoopMatType d(id_to_type_id[insn.Word(2)], module_state, IsSignedIntType(id_to_type_id[insn.Word(2)]));
CoopMatType a(id_to_type_id[insn.Word(3)], module_state, IsSignedIntType(id_to_type_id[insn.Word(3)]));
CoopMatType b(id_to_type_id[insn.Word(4)], module_state, IsSignedIntType(id_to_type_id[insn.Word(4)]));
CoopMatType c(id_to_type_id[insn.Word(5)], module_state, IsSignedIntType(id_to_type_id[insn.Word(5)]));
if (a.all_constant && b.all_constant && c.all_constant && d.all_constant) {
// Validate that the type parameters are all supported for the same
// cooperative matrix property.
bool valid_a = false;
bool valid_b = false;
bool valid_c = false;
bool valid_d = false;
for (uint32_t i = 0; i < device_state->cooperative_matrix_properties_nv.size(); ++i) {
const auto &property = device_state->cooperative_matrix_properties_nv[i];
valid_a |= property.AType == a.component_type && property.MSize == a.rows && property.KSize == a.cols &&
property.scope == a.scope;
valid_b |= property.BType == b.component_type && property.KSize == b.rows && property.NSize == b.cols &&
property.scope == b.scope;
valid_c |= property.CType == c.component_type && property.MSize == c.rows && property.NSize == c.cols &&
property.scope == c.scope;
valid_d |= property.DType == d.component_type && property.MSize == d.rows && property.NSize == d.cols &&
property.scope == d.scope;
if (valid_a && valid_b && valid_c && valid_d) {
break;
}
}
if (!valid_a) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeMatrixMulAddNV-10059", module_state.handle(), loc,
"SPIR-V (%s) OpCooperativeMatrixMulAddNV (result id = %" PRIu32
") operands don't match a supported matrix "
"VkCooperativeMatrixPropertiesNV for A type (%s).",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Word(2), a.Describe().c_str());
} else if (!valid_b) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeMatrixMulAddNV-10059", module_state.handle(), loc,
"SPIR-V (%s) OpCooperativeMatrixMulAddNV (result id = %" PRIu32
") operands don't match a supported matrix "
"VkCooperativeMatrixPropertiesNV for B type (%s).",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Word(2), b.Describe().c_str());
} else if (!valid_c) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeMatrixMulAddNV-10059", module_state.handle(), loc,
"SPIR-V (%s) OpCooperativeMatrixMulAddNV (result id = %" PRIu32
") operands don't match a supported matrix "
"VkCooperativeMatrixPropertiesNV for C type (%s).",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Word(2), c.Describe().c_str());
} else if (!valid_d) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeMatrixMulAddNV-10059", module_state.handle(), loc,
"SPIR-V (%s) OpCooperativeMatrixMulAddNV (result id = %" PRIu32
") operands don't match a supported matrix "
"VkCooperativeMatrixPropertiesNV for D type (%s).",
string_VkShaderStageFlagBits(entrypoint.stage), insn.Word(2), d.Describe().c_str());
}
}
break;
}
default:
break;
}
}
return skip;
}
bool CoreChecks::ValidateCooperativeVector(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const Location &loc) const {
bool skip = false;
struct CoopVecType {
VkComponentTypeKHR component_type;
uint32_t component_count;
bool all_constant;
CoopVecType(uint32_t id, const spirv::Module &module_state, bool is_signed) {
const spirv::Instruction *insn = module_state.FindDef(id);
const spirv::Instruction *component_type_insn = module_state.FindDef(insn->Word(2));
const spirv::Instruction *component_count_insn = module_state.FindDef(insn->Word(3));
all_constant = true;
if (!module_state.GetInt32IfConstant(*component_count_insn, &component_count)) {
all_constant = false;
}
component_type = GetComponentType(component_type_insn, is_signed);
}
std::string Describe() {
std::ostringstream ss;
ss << "component count: " << component_count << ", type: " << string_VkComponentTypeKHR(component_type);
return ss.str();
}
};
if (module_state.HasCapability(spv::CapabilityCooperativeVectorNV) ||
module_state.HasCapability(spv::CapabilityCooperativeVectorTrainingNV)) {
if (!(entrypoint.stage & phys_dev_ext_props.cooperative_vector_props_nv.cooperativeVectorSupportedStages)) {
skip |= LogError(
"VUID-RuntimeSpirv-cooperativeVectorSupportedStages-10091", module_state.handle(), loc,
"SPIR-V contains cooperative vector capability used in shader stage %s but is not in "
"cooperativeVectorSupportedStages (%s)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkShaderStageFlags(phys_dev_ext_props.cooperative_vector_props_nv.cooperativeVectorSupportedStages).c_str());
}
} else {
return skip;
}
vvl::unordered_map<uint32_t, uint32_t> id_to_type_id;
for (const spirv::Instruction &insn : module_state.GetInstructions()) {
if (OpcodeHasType(insn.Opcode()) && OpcodeHasResult(insn.Opcode())) {
id_to_type_id[insn.Word(2)] = insn.Word(1);
}
}
for (const spirv::Instruction *cooperative_vector_inst : module_state.static_data_.cooperative_vector_inst) {
const spirv::Instruction &insn = *cooperative_vector_inst;
switch (insn.Opcode()) {
case spv::OpTypeCooperativeVectorNV: {
// SPIR-V integer types are not strictly signed or unsigned. Allow this type to
// match against either signed or unsigned types in the device properties.
CoopVecType m_signed(insn.Word(1), module_state, true);
CoopVecType m_unsigned(insn.Word(1), module_state, false);
if (!m_signed.all_constant) {
break;
}
if (m_signed.component_count > phys_dev_ext_props.cooperative_vector_props_nv.maxCooperativeVectorComponents) {
skip |= LogError("VUID-RuntimeSpirv-maxCooperativeVectorComponents-10094", module_state.handle(), loc,
"SPIR-V (%s) component count (%d) is greater than maxCooperativeVectorComponents (%d)",
string_VkShaderStageFlagBits(entrypoint.stage), m_signed.component_count,
phys_dev_ext_props.cooperative_vector_props_nv.maxCooperativeVectorComponents);
}
bool found = false;
for (uint32_t i = 0; i < device_state->cooperative_vector_properties_nv.size(); ++i) {
const auto &property = device_state->cooperative_vector_properties_nv[i];
if (m_signed.component_type == property.inputType || m_signed.component_type == property.resultType ||
m_unsigned.component_type == property.inputType || m_unsigned.component_type == property.resultType) {
found = true;
break;
}
}
if (!found) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeCooperativeVector-10095", module_state.handle(), loc,
"SPIR-V (%s) contains unsupported cooperative vector component type (%s)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)m_signed.component_type));
}
break;
}
case spv::OpCooperativeVectorLoadNV:
case spv::OpCooperativeVectorStoreNV: {
// Nothing we can validate outside of GPUAV
break;
}
case spv::OpCooperativeVectorMatrixMulNV:
case spv::OpCooperativeVectorMatrixMulAddNV: {
uint32_t matrix_operands = 0;
if (insn.Opcode() == spv::OpCooperativeVectorMatrixMulAddNV) {
if (insn.Length() > 16) {
matrix_operands = insn.Word(16);
}
} else {
if (insn.Length() > 13) {
matrix_operands = insn.Word(13);
}
}
bool result_is_signed = matrix_operands & spv::CooperativeMatrixOperandsMatrixResultSignedComponentsKHRMask;
bool input_is_signed = matrix_operands & spv::CooperativeMatrixOperandsMatrixBSignedComponentsKHRMask;
CoopVecType result(id_to_type_id[insn.Word(2)], module_state, result_is_signed);
CoopVecType input(id_to_type_id[insn.Word(3)], module_state, input_is_signed);
uint32_t result_type = result.component_type;
uint32_t input_type = input.component_type;
uint32_t biasOffset = insn.Opcode() == spv::OpCooperativeVectorMatrixMulAddNV ? 3 : 0;
bool all_constant = true;
uint32_t input_interpretation{};
uint32_t matrix_interpretation{};
uint32_t bias_interpretation{};
bool transpose{};
if (!module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(4)), &input_interpretation)) {
all_constant = false;
}
if (!module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(7)), &matrix_interpretation)) {
all_constant = false;
}
if (insn.Opcode() == spv::OpCooperativeVectorMatrixMulAddNV) {
if (!module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(10)), &bias_interpretation)) {
all_constant = false;
}
}
if (!module_state.GetBoolIfConstant(*module_state.FindDef(insn.Word(11 + biasOffset)), &transpose)) {
all_constant = false;
}
if (!all_constant) {
break;
}
bool found = false;
for (uint32_t i = 0; i < device_state->cooperative_vector_properties_nv.size(); ++i) {
const auto &property = device_state->cooperative_vector_properties_nv[i];
if (property.inputType == input_type && property.inputInterpretation == input_interpretation &&
property.matrixInterpretation == matrix_interpretation &&
(insn.Opcode() == spv::OpCooperativeVectorMatrixMulNV ||
property.biasInterpretation == bias_interpretation) &&
property.resultType == result_type && (!transpose || property.transpose)) {
found = true;
break;
}
}
if (!found) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorMatrixMulNV-10089", module_state.handle(), loc,
"SPIR-V (%s) contains unsupported cooperative vector matrix mul with "
"result component type (%s), input component type (%s), input interpretation (%s), "
"matrix interpretation (%s), bias interpretation (%s), transpose (%d)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)result_type),
string_VkComponentTypeKHR((VkComponentTypeKHR)input_type),
string_VkComponentTypeKHR((VkComponentTypeKHR)input_interpretation),
string_VkComponentTypeKHR((VkComponentTypeKHR)matrix_interpretation),
(insn.Opcode() == spv::OpCooperativeVectorMatrixMulNV
? "None"
: string_VkComponentTypeKHR((VkComponentTypeKHR)bias_interpretation)),
transpose);
}
uint32_t memory_layout{};
if (module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(10 + biasOffset)), &memory_layout)) {
if ((matrix_interpretation == VK_COMPONENT_TYPE_FLOAT_E4M3_NV ||
matrix_interpretation == VK_COMPONENT_TYPE_FLOAT_E5M2_NV) &&
!(memory_layout == VK_COOPERATIVE_VECTOR_MATRIX_LAYOUT_INFERENCING_OPTIMAL_NV ||
memory_layout == VK_COOPERATIVE_VECTOR_MATRIX_LAYOUT_TRAINING_OPTIMAL_NV)) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorMatrixMulNV-10090", module_state.handle(), loc,
"SPIR-V (%s) contains unsupported cooperative vector matrix mul with "
"matrix_interpretation (%s) and memory layout (%s)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)matrix_interpretation),
string_VkCooperativeVectorMatrixLayoutNV((VkCooperativeVectorMatrixLayoutNV)memory_layout));
}
}
break;
}
case spv::OpCooperativeVectorReduceSumAccumulateNV: {
CoopVecType v(id_to_type_id[insn.Word(3)], module_state, false);
switch (v.component_type) {
case VK_COMPONENT_TYPE_FLOAT16_KHR:
if (!phys_dev_ext_props.cooperative_vector_props_nv.cooperativeVectorTrainingFloat16Accumulation) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorReduceSumAccumulateNV-10092",
module_state.handle(), loc,
"SPIR-V (%s) Component type is FLOAT16 but "
"cooperativeVectorTrainingFloat16Accumulation not supported",
string_VkShaderStageFlagBits(entrypoint.stage));
}
break;
case VK_COMPONENT_TYPE_FLOAT32_KHR:
if (!phys_dev_ext_props.cooperative_vector_props_nv.cooperativeVectorTrainingFloat32Accumulation) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorReduceSumAccumulateNV-10092",
module_state.handle(), loc,
"SPIR-V (%s) Component type is FLOAT32 but "
"cooperativeVectorTrainingFloat32Accumulation not supported",
string_VkShaderStageFlagBits(entrypoint.stage));
}
break;
default:
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorReduceSumAccumulateNV-10092", module_state.handle(), loc,
"SPIR-V (%s) Unsupported component type (%s)", string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)v.component_type));
break;
}
const spirv::Instruction *ptr_type = module_state.FindDef(id_to_type_id[insn.Word(1)]);
if (ptr_type->StorageClass() != spv::StorageClassStorageBuffer &&
ptr_type->StorageClass() != spv::StorageClassPhysicalStorageBuffer) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorReduceSumAccumulateNV-10092", module_state.handle(), loc,
"SPIR-V (%s) Unsupported pointer storage class (%s)",
string_VkShaderStageFlagBits(entrypoint.stage), string_SpvStorageClass(ptr_type->StorageClass()));
}
break;
}
case spv::OpCooperativeVectorOuterProductAccumulateNV: {
uint32_t matrix_interpretation{};
if (module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(6)), &matrix_interpretation)) {
switch (matrix_interpretation) {
case VK_COMPONENT_TYPE_FLOAT16_KHR:
if (!phys_dev_ext_props.cooperative_vector_props_nv.cooperativeVectorTrainingFloat16Accumulation) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093",
module_state.handle(), loc,
"SPIR-V (%s) Matrix interpretation is FLOAT16 but "
"cooperativeVectorTrainingFloat16Accumulation not supported",
string_VkShaderStageFlagBits(entrypoint.stage));
}
break;
case VK_COMPONENT_TYPE_FLOAT32_KHR:
if (!phys_dev_ext_props.cooperative_vector_props_nv.cooperativeVectorTrainingFloat32Accumulation) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093",
module_state.handle(), loc,
"SPIR-V (%s) Matrix interpretation is FLOAT32 but "
"cooperativeVectorTrainingFloat32Accumulation not supported",
string_VkShaderStageFlagBits(entrypoint.stage));
}
break;
default:
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093",
module_state.handle(), loc, "SPIR-V (%s) Unsupported Matrix interpretation (%s)",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)matrix_interpretation));
break;
}
}
CoopVecType a(id_to_type_id[insn.Word(3)], module_state, false);
CoopVecType b(id_to_type_id[insn.Word(4)], module_state, false);
if (a.component_type != VK_COMPONENT_TYPE_FLOAT16_KHR) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093", module_state.handle(),
loc, "SPIR-V (%s) Component type of A (%s) must be FLOAT16",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)a.component_type));
}
if (b.component_type != VK_COMPONENT_TYPE_FLOAT16_KHR) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093", module_state.handle(),
loc, "SPIR-V (%s) Component type of B (%s) must be FLOAT16",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkComponentTypeKHR((VkComponentTypeKHR)b.component_type));
}
uint32_t memory_layout{};
if (module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(5)), &memory_layout)) {
if (memory_layout != VK_COOPERATIVE_VECTOR_MATRIX_LAYOUT_TRAINING_OPTIMAL_NV) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093", module_state.handle(),
loc, "SPIR-V (%s) Memory layout (%s) must be TRAINING_OPTIMAL",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkCooperativeVectorMatrixLayoutNV((VkCooperativeVectorMatrixLayoutNV)memory_layout));
}
}
const spirv::Instruction *ptr_type = module_state.FindDef(id_to_type_id[insn.Word(1)]);
if (ptr_type->StorageClass() != spv::StorageClassStorageBuffer &&
ptr_type->StorageClass() != spv::StorageClassPhysicalStorageBuffer) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorOuterProductAccumulateNV-10093", module_state.handle(), loc,
"SPIR-V (%s) Unsupported pointer storage class (%s)",
string_VkShaderStageFlagBits(entrypoint.stage), string_SpvStorageClass(ptr_type->StorageClass()));
}
break;
}
default:
assert(false); // unexpected instruction
break;
}
}
return skip;
}
bool CoreChecks::ValidateShader64BitIndexing(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const ShaderStageState &stage_state, const vvl::Pipeline *pipeline,
const Location &loc) const {
bool skip = false;
if (pipeline && (pipeline->create_flags & VK_PIPELINE_CREATE_2_64_BIT_INDEXING_BIT_EXT)) {
return skip;
}
if (stage_state.shader_object_create_info &&
(stage_state.shader_object_create_info->flags & VK_SHADER_CREATE_64_BIT_INDEXING_BIT_EXT)) {
return skip;
}
if (entrypoint.execution_mode.Has(spirv::ExecutionModeSet::shader_64bit_indexing)) {
return skip;
}
auto const &check = [&](uint32_t value_id) -> bool {
auto value_insn = module_state.FindDef(value_id);
auto type_insn = module_state.FindDef(value_insn->Word(1));
return type_insn->Word(2) != 32;
};
for (const spirv::Instruction *cooperative_vector_inst : module_state.static_data_.cooperative_vector_inst) {
const spirv::Instruction &insn = *cooperative_vector_inst;
switch (insn.Opcode()) {
case spv::OpCooperativeVectorMatrixMulNV:
case spv::OpCooperativeVectorMatrixMulAddNV: {
uint32_t matrix_offset_id = insn.Word(6);
if (check(matrix_offset_id)) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorMatrixMulAddNV-11808", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit matrix offset\n%s\n", string_VkShaderStageFlagBits(entrypoint.stage),
module_state.DescribeInstruction(insn).c_str());
}
if (insn.Opcode() == spv::OpCooperativeVectorMatrixMulAddNV) {
uint32_t bias_offset_id = insn.Word(9);
if (check(bias_offset_id)) {
skip |= LogError("VUID-RuntimeSpirv-OpCooperativeVectorMatrixMulAddNV-11808", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit bias offset\n%s\n",
string_VkShaderStageFlagBits(entrypoint.stage),
module_state.DescribeInstruction(insn).c_str());
}
}
break;
}
case spv::OpCooperativeVectorLoadNV: {
if (check(insn.Word(4))) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorLoadNV-11809", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit load offset\n%s\n", string_VkShaderStageFlagBits(entrypoint.stage),
module_state.DescribeInstruction(insn).c_str());
}
break;
}
case spv::OpCooperativeVectorStoreNV: {
if (check(insn.Word(2))) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorLoadNV-11809", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit store offset\n%s\n", string_VkShaderStageFlagBits(entrypoint.stage),
module_state.DescribeInstruction(insn).c_str());
}
break;
}
case spv::OpCooperativeVectorReduceSumAccumulateNV: {
if (check(insn.Word(2))) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorLoadNV-11809", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit reducesum offset\n%s\n",
string_VkShaderStageFlagBits(entrypoint.stage), module_state.DescribeInstruction(insn).c_str());
}
break;
}
case spv::OpCooperativeVectorOuterProductAccumulateNV: {
if (check(insn.Word(2))) {
skip |=
LogError("VUID-RuntimeSpirv-OpCooperativeVectorLoadNV-11809", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit outerproduct offset\n%s\n",
string_VkShaderStageFlagBits(entrypoint.stage), module_state.DescribeInstruction(insn).c_str());
}
break;
}
default:
break;
}
}
for (const spirv::Instruction *array_length_inst : module_state.static_data_.array_length_inst) {
const spirv::Instruction &insn = *array_length_inst;
if (check(insn.Word(1))) {
skip |= LogError("VUID-RuntimeSpirv-OpArrayLength-11807", module_state.handle(), loc,
"SPIR-V (%s) contains 64-bit array length return type\n%s\n",
string_VkShaderStageFlagBits(entrypoint.stage), module_state.DescribeInstruction(insn).c_str());
}
}
return skip;
}
bool CoreChecks::ValidateSubpassCustomeResolve(const spirv::Module &module_state, VkShaderStageFlagBits stage,
const vvl::Pipeline &pipeline, const Location &loc) const {
bool skip = false;
// If the pipeline's subpass description contains flag VK_SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_EXT,
// then the fragment shader must not enable the SPIRV SampleRateShading capability.
if (stage == VK_SHADER_STAGE_FRAGMENT_BIT && module_state.HasCapability(spv::CapabilitySampleRateShading)) {
const auto &rp_state = pipeline.RenderPassState();
if (!rp_state || rp_state->UsesDynamicRendering()) {
return skip;
}
const VkSubpassDescriptionFlags subpass_flags = rp_state->create_info.pSubpasses[pipeline.Subpass()].flags;
if ((subpass_flags & VK_SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_EXT) != 0) {
const LogObjectList objlist(module_state.handle(), rp_state->Handle());
skip |= LogError("VUID-RuntimeSpirv-SampleRateShading-06378", objlist, loc,
"SPIR-V (Fragment stage) enables SampleRateShading capability "
"and the subpass flags includes VK_SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_EXT.");
}
}
return skip;
}
bool CoreChecks::ValidateShaderExecutionModes(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
VkShaderStageFlagBits stage, const vvl::Pipeline *pipeline,
const Location &loc) const {
bool skip = false;
if (entrypoint.stage == VK_SHADER_STAGE_GEOMETRY_BIT) {
const uint32_t vertices_out = entrypoint.execution_mode.output_vertices;
const uint32_t invocations = entrypoint.execution_mode.invocations;
if (vertices_out != spirv::kInvalidValue &&
(vertices_out == 0 || vertices_out > phys_dev_props.limits.maxGeometryOutputVertices)) {
const char *vuid =
pipeline ? "VUID-VkPipelineShaderStageCreateInfo-stage-00714" : "VUID-VkShaderCreateInfoEXT-pCode-08454";
skip |= LogError(vuid, module_state.handle(), loc,
"SPIR-V (Geometry stage) entry point must have an OpExecutionMode instruction that "
"specifies a maximum output vertex count that is greater than 0 and less "
"than or equal to maxGeometryOutputVertices.\n"
"OutputVertices = %" PRIu32 "\nmaxGeometryOutputVertices = %" PRIu32 "\n",
vertices_out, phys_dev_props.limits.maxGeometryOutputVertices);
}
if (invocations == 0 || invocations > phys_dev_props.limits.maxGeometryShaderInvocations) {
const char *vuid =
pipeline ? "VUID-VkPipelineShaderStageCreateInfo-stage-00715" : "VUID-VkShaderCreateInfoEXT-pCode-08455";
skip |= LogError(vuid, module_state.handle(), loc,
"SPIR-V (Geometry stage) entry point must have an OpExecutionMode instruction that "
"specifies an invocation count that is greater than 0 and less "
"than or equal to maxGeometryShaderInvocations.\n"
"Invocations = %" PRIu32 "\nmaxGeometryShaderInvocations = %" PRIu32 "\n",
invocations, phys_dev_props.limits.maxGeometryShaderInvocations);
}
} else if (entrypoint.stage == VK_SHADER_STAGE_FRAGMENT_BIT &&
entrypoint.execution_mode.Has(spirv::ExecutionModeSet::early_fragment_test_bit)) {
if (pipeline) {
const auto *ds_state = pipeline->DepthStencilState();
if ((ds_state &&
(ds_state->flags &
(VK_PIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_DEPTH_ACCESS_BIT_EXT |
VK_PIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_STENCIL_ACCESS_BIT_EXT)) != 0)) {
skip |= LogError(
"VUID-VkGraphicsPipelineCreateInfo-flags-06591", module_state.handle(), loc,
"SPIR-V (Fragment stage) enables early fragment tests, but VkPipelineDepthStencilStateCreateInfo::flags == "
"%s.",
string_VkPipelineDepthStencilStateCreateFlags(ds_state->flags).c_str());
}
}
}
return skip;
}
bool CoreChecks::ValidatePointSizeShaderState(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const vvl::Pipeline &pipeline, VkShaderStageFlagBits stage,
const Location &loc) const {
bool skip = false;
// vkspec.html#primsrast-points describes which is the final stage that needs to check for points
//
// Vertex - Need to read input topology in pipeline
// Geo/Tess - Need to know the feature bit is on
// Mesh - are checked in spirv-val as they don't require any runtime information
if (!IsValueIn(stage,
{VK_SHADER_STAGE_VERTEX_BIT, VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT, VK_SHADER_STAGE_GEOMETRY_BIT})) {
return skip;
}
const bool output_points = entrypoint.execution_mode.Has(spirv::ExecutionModeSet::output_points_bit);
const bool point_mode = entrypoint.execution_mode.Has(spirv::ExecutionModeSet::point_mode_bit);
const bool maintenance5 = enabled_features.maintenance5;
if (stage == VK_SHADER_STAGE_GEOMETRY_BIT && output_points) {
if (enabled_features.shaderTessellationAndGeometryPointSize && !entrypoint.written_builtin_point_size &&
entrypoint.emit_vertex_geometry && !maintenance5) {
skip |= LogError(
"VUID-VkGraphicsPipelineCreateInfo-shaderTessellationAndGeometryPointSize-08776", module_state.handle(), loc,
"SPIR-V (Geometry stage) PointSize is not written, but shaderTessellationAndGeometryPointSize was enabled.");
} else if (!enabled_features.shaderTessellationAndGeometryPointSize && entrypoint.written_builtin_point_size) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-Geometry-07726", module_state.handle(), loc,
"SPIR-V (Geometry stage) PointSize is written to, but shaderTessellationAndGeometryPointSize was not "
"enabled (gl_PointSize must NOT be written and a default of 1.0 is assumed).");
}
} else if (stage == VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT &&
((pipeline.create_info_shaders & VK_SHADER_STAGE_GEOMETRY_BIT) == 0) && point_mode) {
if (enabled_features.shaderTessellationAndGeometryPointSize && !entrypoint.written_builtin_point_size && !maintenance5) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-TessellationEvaluation-07723", module_state.handle(), loc,
"SPIR-V (Tessellation Evaluation stage) PointSize is not written, but "
"shaderTessellationAndGeometryPointSize was enabled.");
} else if (!enabled_features.shaderTessellationAndGeometryPointSize && entrypoint.written_builtin_point_size) {
skip |=
LogError("VUID-VkGraphicsPipelineCreateInfo-TessellationEvaluation-07724", module_state.handle(), loc,
"SPIR-V (Tessellation Evaluation stage) PointSize is written to, shaderTessellationAndGeometryPointSize "
"was not enabled (gl_PointSize must NOT be written and a default of 1.0 is assumed).");
}
} else if (stage == VK_SHADER_STAGE_VERTEX_BIT &&
((pipeline.create_info_shaders & (VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT | VK_SHADER_STAGE_GEOMETRY_BIT)) ==
0)) {
if (!entrypoint.written_builtin_point_size && IsPointTopology(pipeline.topology_at_rasterizer) && !maintenance5) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-topology-08773", module_state.handle(), loc,
"SPIR-V (Vertex) PointSize is not written to, but Pipeline topology is set to "
"VK_PRIMITIVE_TOPOLOGY_POINT_LIST.");
}
}
return skip;
}
bool CoreChecks::ValidatePrimitiveRateShaderState(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const vvl::Pipeline &pipeline, VkShaderStageFlagBits stage,
const Location &loc) const {
bool skip = false;
const auto viewport_state = pipeline.ViewportState();
if (!phys_dev_ext_props.fragment_shading_rate_props.primitiveFragmentShadingRateWithMultipleViewports &&
(pipeline.pipeline_type == VK_PIPELINE_BIND_POINT_GRAPHICS) && viewport_state) {
if (!pipeline.IsDynamic(CB_DYNAMIC_STATE_VIEWPORT_WITH_COUNT) && viewport_state->viewportCount > 1 &&
entrypoint.written_builtin_primitive_shading_rate_khr) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-primitiveFragmentShadingRateWithMultipleViewports-04503",
module_state.handle(), loc,
"SPIR-V (%s) statically writes to PrimitiveShadingRateKHR built-in, but "
"multiple viewports "
"are used and the primitiveFragmentShadingRateWithMultipleViewports limit is not supported.",
string_VkShaderStageFlagBits(stage));
}
if (entrypoint.written_builtin_primitive_shading_rate_khr && entrypoint.written_builtin_viewport_index) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-primitiveFragmentShadingRateWithMultipleViewports-04504",
module_state.handle(), loc,
"SPIR-V (%s) statically writes to both PrimitiveShadingRateKHR and "
"ViewportIndex built-ins, "
"but the primitiveFragmentShadingRateWithMultipleViewports limit is not supported.",
string_VkShaderStageFlagBits(stage));
}
if (entrypoint.written_builtin_primitive_shading_rate_khr && entrypoint.written_builtin_viewport_mask_nv) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-primitiveFragmentShadingRateWithMultipleViewports-04505",
module_state.handle(), loc,
"SPIR-V (%s) statically writes to both PrimitiveShadingRateKHR and "
"ViewportMaskNV built-ins, "
"but the primitiveFragmentShadingRateWithMultipleViewports limit is not supported.",
string_VkShaderStageFlagBits(stage));
}
}
return skip;
}
bool CoreChecks::ValidateWorkgroupSharedMemory(const spirv::Module &module_state, VkShaderStageFlagBits stage,
uint32_t total_workgroup_shared_memory, const Location &loc) const {
bool skip = false;
switch (stage) {
case VK_SHADER_STAGE_COMPUTE_BIT: {
if (total_workgroup_shared_memory > phys_dev_props.limits.maxComputeSharedMemorySize) {
skip |= LogError("VUID-RuntimeSpirv-Workgroup-06530", module_state.handle(), loc,
"SPIR-V uses %" PRIu32
" bytes of shared memory, which is more than maxComputeSharedMemorySize (%" PRIu32 ").",
total_workgroup_shared_memory, phys_dev_props.limits.maxComputeSharedMemorySize);
}
if (enabled_features.cooperativeMatrixWorkgroupScope) {
for (auto &cooperative_matrix_inst : module_state.static_data_.cooperative_matrix_inst) {
if (cooperative_matrix_inst->Opcode() != spv::OpTypeCooperativeMatrixKHR) {
continue;
}
auto scope = module_state.GetAnyConstantDef(cooperative_matrix_inst->Word(3));
if (!scope || scope->GetConstantValue() != VK_SCOPE_WORKGROUP_KHR) {
continue;
}
if (total_workgroup_shared_memory >
phys_dev_props.limits.maxComputeSharedMemorySize -
phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixWorkgroupScopeReservedSharedMemory) {
skip |= LogError(
"VUID-RuntimeSpirv-maxComputeSharedMemorySize-10168", module_state.handle(), loc,
"SPIR-V uses %" PRIu32
" bytes of shared memory, which is more than maxComputeSharedMemorySize (%" PRIu32
") minus "
"cooperativeMatrixWorkgroupScopeReservedSharedMemory (%" PRIu32 ").",
total_workgroup_shared_memory, phys_dev_props.limits.maxComputeSharedMemorySize,
phys_dev_ext_props.cooperative_matrix_props2_nv.cooperativeMatrixWorkgroupScopeReservedSharedMemory);
break;
}
}
}
break;
}
case VK_SHADER_STAGE_MESH_BIT_EXT: {
if (total_workgroup_shared_memory > phys_dev_ext_props.mesh_shader_props_ext.maxMeshSharedMemorySize) {
skip |= LogError("VUID-RuntimeSpirv-maxMeshSharedMemorySize-08754", module_state.handle(), loc,
"SPIR-V uses %" PRIu32
" bytes of shared memory, which is more than maxMeshSharedMemorySize (%" PRIu32 ").",
total_workgroup_shared_memory, phys_dev_ext_props.mesh_shader_props_ext.maxMeshSharedMemorySize);
}
break;
}
case VK_SHADER_STAGE_TASK_BIT_EXT: {
if (total_workgroup_shared_memory > phys_dev_ext_props.mesh_shader_props_ext.maxTaskSharedMemorySize) {
skip |= LogError("VUID-RuntimeSpirv-maxTaskSharedMemorySize-08759", module_state.handle(), loc,
"SPIR-V uses %" PRIu32
" bytes of shared memory, which is more than maxTaskSharedMemorySize (%" PRIu32 ").",
total_workgroup_shared_memory, phys_dev_ext_props.mesh_shader_props_ext.maxTaskSharedMemorySize);
}
break;
}
default:
assert(false); // other stages should not have called this function
break;
}
return skip;
}
bool CoreChecks::ValidateShaderInterfaceVariable(const spirv::Module &module_state,
const spirv::ResourceInterfaceVariable &variable,
vvl::unordered_set<uint32_t> &descriptor_type_set, const Location &loc) const {
bool skip = false;
if ((variable.is_storage_image || variable.is_storage_texel_buffer || variable.is_storage_buffer) &&
!variable.decorations.Has(spirv::DecorationSet::nonwritable_bit)) {
// If the variable is a struct, all members must contain NonWritable
if (!variable.type_struct_info ||
!variable.type_struct_info->decorations.AllMemberHave(spirv::DecorationSet::nonwritable_bit)) {
switch (variable.stage) {
case VK_SHADER_STAGE_FRAGMENT_BIT:
if (!enabled_features.fragmentStoresAndAtomics) {
skip |=
LogError("VUID-RuntimeSpirv-NonWritable-06340", module_state.handle(), loc,
"SPIR-V (VK_SHADER_STAGE_FRAGMENT_BIT) uses descriptor %s (type %s) which is not "
"marked with NonWritable, but fragmentStoresAndAtomics was not enabled.",
variable.DescribeDescriptor().c_str(), string_DescriptorTypeSet(descriptor_type_set).c_str());
}
break;
case VK_SHADER_STAGE_VERTEX_BIT:
case VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT:
case VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT:
case VK_SHADER_STAGE_GEOMETRY_BIT:
if (!enabled_features.vertexPipelineStoresAndAtomics) {
skip |= LogError("VUID-RuntimeSpirv-NonWritable-06341", module_state.handle(), loc,
"SPIR-V (%s) uses descriptor %s (type %s) which is not marked with NonWritable, but "
"vertexPipelineStoresAndAtomics was not enabled.",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(),
string_DescriptorTypeSet(descriptor_type_set).c_str());
}
break;
default:
// No feature requirements for writes and atomics for other stages
break;
}
}
}
if (!variable.decorations.Has(spirv::DecorationSet::input_attachment_bit) && variable.info.image_dim == spv::DimSubpassData) {
if (variable.IsArray()) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeImage-09644", module_state.handle(), loc,
"the variable is an array of OpTypeImage with Dim::SubpassData, but it is missing the "
"InputAttachmentIndex decoration.\n%s\n",
variable.base_type.Describe().c_str());
} else if (!enabled_features.dynamicRenderingLocalRead) {
skip |= LogError("VUID-RuntimeSpirv-None-09558", module_state.handle(), loc,
"the variable is a OpTypeImage with Dim::SubpassData, but it is missing the "
"InputAttachmentIndex decoration (dynamicRenderingLocalRead was not enabled).\n%s\n",
variable.base_type.Describe().c_str());
}
}
if (variable.is_uniform_buffer && variable.type_struct_info && variable.type_struct_info->has_runtime_array &&
!enabled_features.shaderUniformBufferUnsizedArray) {
skip |= LogError("VUID-RuntimeSpirv-shaderUniformBufferUnsizedArray-11806", module_state.handle(), loc,
"SPIR-V (%s) uses descriptor %s which is an uniform buffer with a runtime array, but "
"shaderUniformBufferUnsizedArray was not enabled.",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str());
}
return skip;
}
bool CoreChecks::ValidateShaderInterfaceVariableDSL(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const ShaderStageState &stage_state,
const spirv::ResourceInterfaceVariable &variable,
vvl::unordered_set<uint32_t> &descriptor_type_set, const Location &loc) const {
bool skip = false;
if (!stage_state.descriptor_set_layouts) {
return skip;
}
LogObjectList objlist(module_state.handle());
const VkDescriptorSetLayoutBinding *binding = nullptr;
const vvl::DescriptorSetLayout *descriptor_set_layout = stage_state.descriptor_set_layouts->FindFromVariable(variable);
if (descriptor_set_layout) {
objlist.add(descriptor_set_layout->Handle());
binding = descriptor_set_layout->GetDescriptorSetLayoutBindingPtrFromBinding(variable.decorations.binding);
}
if (binding) {
skip |= ValidateShaderYcbcrSampler(module_state, entrypoint, *descriptor_set_layout, *binding, variable, objlist, loc);
}
auto print_dsl_info = [&stage_state, &variable]() {
std::stringstream ss;
const bool has_pipeline = stage_state.shader_object_create_info == nullptr;
if (has_pipeline) {
ss << "VkPipelineLayoutCreateInfo::pSetLayouts[" << variable.decorations.set << "]";
} else {
ss << "VkShaderCreateInfoEXT::pSetLayouts[" << variable.decorations.set << "]";
}
return ss.str();
};
if (!binding) {
skip |= LogError(GetSpirvInterfaceVariableVUID(loc, vvl::SpirvInterfaceVariableError::ShaderStage_07988), objlist, loc,
"SPIR-V (%s) uses descriptor %s (type %s) but was not declared in the %s.",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(),
string_DescriptorTypeSet(descriptor_type_set).c_str(), print_dsl_info().c_str());
} else if (~binding->stageFlags & variable.stage) {
skip |=
LogError(GetSpirvInterfaceVariableVUID(loc, vvl::SpirvInterfaceVariableError::ShaderStage_07988), objlist, loc,
"SPIR-V (%s) uses descriptor %s (type %s) but the VkDescriptorSetLayoutBinding::stageFlags was %s. (from %s)",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(),
string_DescriptorTypeSet(descriptor_type_set).c_str(), string_VkShaderStageFlags(binding->stageFlags).c_str(),
print_dsl_info().c_str());
} else if ((binding->descriptorType != VK_DESCRIPTOR_TYPE_MUTABLE_EXT) &&
(descriptor_type_set.find(binding->descriptorType) == descriptor_type_set.end())) {
skip |= LogError(GetSpirvInterfaceVariableVUID(loc, vvl::SpirvInterfaceVariableError::Mutable_07990), objlist, loc,
"SPIR-V (%s) uses descriptor %s of type %s but expected %s. (from %s)",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(),
string_VkDescriptorType(binding->descriptorType), string_DescriptorTypeSet(descriptor_type_set).c_str(),
print_dsl_info().c_str());
} else if (binding->descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK && variable.IsArray()) {
skip |=
LogError(GetSpirvInterfaceVariableVUID(loc, vvl::SpirvInterfaceVariableError::Inline_10391), objlist, loc,
"SPIR-V (%s) uses descriptor %s as VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, but it is an array of descriptor. "
"(from %s)",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(), print_dsl_info().c_str());
} else if (variable.IsRuntimeArray() && binding->descriptorCount == 0) {
skip |=
LogError(GetSpirvInterfaceVariableVUID(loc, vvl::SpirvInterfaceVariableError::DescriptorCount_07991), objlist, loc,
"SPIR-V (%s) uses a runtime descriptor array %s with a VkDescriptorSetLayoutBinding::descriptorCount of 0 "
"but requires at least 1 descriptor. (from %s)",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(), print_dsl_info().c_str());
} else if (!variable.IsRuntimeArray() && binding->descriptorCount < variable.array_length) {
skip |= LogError(GetSpirvInterfaceVariableVUID(loc, vvl::SpirvInterfaceVariableError::DescriptorCount_07991), objlist, loc,
"SPIR-V (%s) uses descriptor %s with a VkDescriptorSetLayoutBinding::descriptorCount of %" PRIu32
", but requires at least %" PRIu32 " in the SPIR-V. (from %s)",
string_VkShaderStageFlagBits(variable.stage), variable.DescribeDescriptor().c_str(),
binding->descriptorCount, variable.array_length, print_dsl_info().c_str());
}
return skip;
}
// "friends don't let friends validate YCbCr in SPIR-V" ~Spencer
bool CoreChecks::ValidateShaderYcbcrSampler(const spirv::Module& module_state, const spirv::EntryPoint& entrypoint,
const vvl::DescriptorSetLayout& descriptor_set_layout,
const VkDescriptorSetLayoutBinding& binding,
const spirv::ResourceInterfaceVariable& variable, const LogObjectList& objlist,
const Location& loc) const {
bool skip = false;
// pImmutableSamplers can have non-YCbCr samplers (but can't mix between YCbCr/Non-YCbCr)
//
// IsAccessed() will prevent things like textureSize() from be marked as a false positive.
// Note that for YCbCr, OpImageQueryLod will query the sampler, but OpImageQuerySize only queries
// the image and therefor can still be used with YCbCr.
const bool possible_ycbcr = binding.pImmutableSamplers && descriptor_set_layout.HasYcbcrSamplers() &&
(variable.IsImage() && variable.IsImageAccessed());
if (!possible_ycbcr) {
return skip;
}
// YCbCr is only allowed for Combined Image Samplers (error is caught before)
if (!variable.is_type_sampled_image) {
return skip;
}
// The sampler state might have been destroyed, we need to get the safe struct we saved
const uint32_t index = descriptor_set_layout.GetIndexFromBinding(binding.binding);
const std::vector<vku::safe_VkSamplerCreateInfo> &sampler_create_infos =
descriptor_set_layout.GetImmutableSamplerCreateInfosFromIndex(index);
for (uint32_t i = 0; i < sampler_create_infos.size(); i++) {
auto *conversion_info = vku::FindStructInPNextChain<VkSamplerYcbcrConversionInfo>(sampler_create_infos[i].pNext);
if (!conversion_info || conversion_info->conversion == VK_NULL_HANDLE) {
continue;
}
if (!variable.info.image_insn.is_sampler_sampled) {
skip |= LogError("VUID-RuntimeSpirv-OpTypeSampledImage-12206", objlist, loc,
"%s points to pImmutableSamplers[%" PRIu32
"] (%s) that was created with a VkSamplerYcbcrConversion, but was accessed in the SPIR-V "
"with a non OpImage*Sample* instruction.\nNon-sampled operations (like texelFetch) can't be used "
"because it doesn't contain the sampler YCbCr conversion information for the driver.",
variable.DescribeDescriptor().c_str(), i, FormatHandle(conversion_info->conversion).c_str());
break; // only need to report a single descriptor
} else if (variable.info.image_insn.is_sampler_offset) {
skip |= LogError("VUID-RuntimeSpirv-ConstOffset-10718", objlist, loc,
"%s points to pImmutableSamplers[%" PRIu32
"] (%s) that was created with a VkSamplerYcbcrConversion, but was accessed in the SPIR-V "
"with ConstOffset/Offset image operands.",
variable.DescribeDescriptor().c_str(), i, FormatHandle(conversion_info->conversion).c_str());
break; // only need to report a single descriptor
}
if (!variable.all_constant_integral_expressions) {
std::stringstream ss;
ss << variable.DescribeDescriptor()
<< " is an COMBINED_SAMPLED_IMAGE tied to an array of YCbCr samplers and it trying to be accessed with a "
"non-constant index value.\nRegardless if it is uniform or not, you can't dynamically index into an array of "
"YCbCr samplers "
"in your shader and you need a constant value.\nThis is because the driver's compiler needs to know the exact "
"YCbCr sampler/image being used in order to inject special instructions into the final shader.\nOne possible "
"workaround is to use Specialization Constant to decide the index at pipeline/shaderObject creation time.";
skip |= LogError("VUID-RuntimeSpirv-None-12205", objlist, loc, "%s", ss.str().c_str());
// only need to report a single descriptor
// If we hook up to print the ShaderDebugInfo, might be worth it to print all of them
break;
}
}
return skip;
}
bool CoreChecks::ValidateTransformFeedbackPipeline(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const vvl::Pipeline &pipeline, const Location &loc) const {
bool skip = false;
const bool is_xfb_execution_mode = entrypoint.execution_mode.Has(spirv::ExecutionModeSet::xfb_bit);
if (is_xfb_execution_mode) {
if ((pipeline.create_info_shaders & (VK_SHADER_STAGE_MESH_BIT_EXT | VK_SHADER_STAGE_TASK_BIT_EXT)) != 0) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-None-02322", module_state.handle(), loc,
"SPIR-V has OpExecutionMode of Xfb and using mesh shaders (%s).",
string_VkShaderStageFlags(pipeline.create_info_shaders).c_str());
}
if (pipeline.pre_raster_state) {
if (entrypoint.stage != pipeline.pre_raster_state->last_stage) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-pStages-02318", module_state.handle(), loc,
"SPIR-V has OpExecutionMode of Xfb in %s, but %s is the last last pre-rasterization shader stage.",
string_VkShaderStageFlagBits(entrypoint.stage),
string_VkShaderStageFlagBits(pipeline.pre_raster_state->last_stage));
}
if ((pipeline.create_flags & VK_PIPELINE_CREATE_2_INDIRECT_BINDABLE_BIT_EXT) != 0) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-flags-11001", module_state.handle(), loc,
"SPIR-V has OpExecutionMode of Xfb but this pipeline is being created with "
"VK_PIPELINE_CREATE_2_INDIRECT_BINDABLE_BIT_EXT.");
}
}
}
if (pipeline.pre_raster_state && (pipeline.create_info_shaders & VK_SHADER_STAGE_GEOMETRY_BIT) != 0 &&
module_state.HasCapability(spv::CapabilityGeometryStreams) && !enabled_features.geometryStreams) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-geometryStreams-02321", module_state.handle(), loc,
"SPIR-V uses GeometryStreams capability, but "
"VkPhysicalDeviceTransformFeedbackFeaturesEXT::geometryStreams is not enabled.");
}
return skip;
}
bool CoreChecks::ValidateImageWrite(const spirv::Module &module_state, const Location &loc) const {
bool skip = false;
for (const auto &[insn, load_id] : module_state.static_data_.image_write_load_id_map) {
// guaranteed by spirv-val to be an OpTypeImage
const uint32_t image = module_state.GetTypeId(load_id);
const spirv::Instruction *image_def = module_state.FindDef(image);
const uint32_t image_format = image_def->Word(8);
// If format is 'Unknown' then need to wait until a descriptor is bound to it
if (image_format != spv::ImageFormatUnknown) {
const VkFormat compatible_format = CompatibleSpirvImageFormat(image_format);
if (compatible_format != VK_FORMAT_UNDEFINED) {
const uint32_t format_component_count = vkuFormatComponentCount(compatible_format);
const uint32_t texel_component_count = module_state.GetTexelComponentCount(*insn);
if (texel_component_count < format_component_count) {
skip |= LogError("VUID-RuntimeSpirv-OpImageWrite-07112", module_state.handle(), loc,
"SPIR-V OpImageWrite Texel operand only contains %" PRIu32
" components, but the OpImage format mapping to %s has %" PRIu32 " components.\n%s\n%s\n",
texel_component_count, string_VkFormat(compatible_format), format_component_count,
module_state.DescribeInstruction(*insn).c_str(),
module_state.DescribeInstruction(*image_def).c_str());
}
}
}
}
return skip;
}
static const std::string GetShaderTileImageCapabilitiesString(const spirv::Module &module_state) {
struct SpvCapabilityWithString {
const spv::Capability cap;
const std::string cap_string;
};
// Shader tile image capabilities
static const std::array<SpvCapabilityWithString, 3> shader_tile_image_capabilities = {
{{spv::CapabilityTileImageColorReadAccessEXT, "TileImageColorReadAccessEXT"},
{spv::CapabilityTileImageDepthReadAccessEXT, "TileImageDepthReadAccessEXT"},
{spv::CapabilityTileImageStencilReadAccessEXT, "TileImageStencilReadAccessEXT"}}};
std::stringstream ss_capabilities;
for (auto spv_capability : shader_tile_image_capabilities) {
if (module_state.HasCapability(spv_capability.cap)) {
if (ss_capabilities.tellp()) ss_capabilities << ", ";
ss_capabilities << spv_capability.cap_string;
}
}
return ss_capabilities.str();
}
bool CoreChecks::ValidateShaderTileImage(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const vvl::Pipeline &pipeline, const Location &loc) const {
bool skip = false;
const bool using_tile_image_capability = module_state.HasCapability(spv::CapabilityTileImageColorReadAccessEXT) ||
module_state.HasCapability(spv::CapabilityTileImageDepthReadAccessEXT) ||
module_state.HasCapability(spv::CapabilityTileImageStencilReadAccessEXT);
if (!using_tile_image_capability) {
// None of the capabilities exist.
return skip;
}
auto rp = pipeline.GraphicsCreateInfo().renderPass;
if (rp != VK_NULL_HANDLE) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-renderPass-08710", module_state.handle(), loc,
"SPIR-V (Fragment stage) is using capabilities (%s), but renderpass (%s) is not VK_NULL_HANDLE.",
GetShaderTileImageCapabilitiesString(module_state).c_str(), FormatHandle(rp).c_str());
}
const bool mode_early_fragment_test = entrypoint.execution_mode.Has(spirv::ExecutionModeSet::early_fragment_test_bit);
if (module_state.static_data_.has_shader_tile_image_depth_read) {
const auto *ds_state = pipeline.DepthStencilState();
const bool write_enabled =
!pipeline.IsDynamic(CB_DYNAMIC_STATE_DEPTH_WRITE_ENABLE) && (ds_state && ds_state->depthWriteEnable);
if (mode_early_fragment_test && write_enabled) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-pStages-08711", module_state.handle(), loc,
"SPIR-V (Fragment stage) contains OpDepthAttachmentReadEXT, and depthWriteEnable is not false.");
}
}
if (module_state.static_data_.has_shader_tile_image_stencil_read) {
const auto *ds_state = pipeline.DepthStencilState();
const bool is_write_mask_set = !pipeline.IsDynamic(CB_DYNAMIC_STATE_STENCIL_WRITE_MASK) &&
(ds_state && (ds_state->front.writeMask != 0 || ds_state->back.writeMask != 0));
if (mode_early_fragment_test && is_write_mask_set) {
skip |= LogError(
"VUID-VkGraphicsPipelineCreateInfo-pStages-08712", module_state.handle(), loc,
"SPIR-V (Fragment stage) contains OpStencilAttachmentReadEXT, and stencil write mask is not equal to 0 for "
"both front(%" PRIu32 ") and back (%" PRIu32 ").",
ds_state->front.writeMask, ds_state->back.writeMask);
}
}
bool using_tile_image_op = module_state.static_data_.has_shader_tile_image_depth_read ||
module_state.static_data_.has_shader_tile_image_stencil_read ||
module_state.static_data_.has_shader_tile_image_color_read;
const auto *ms_state = pipeline.MultisampleState();
if (using_tile_image_op && ms_state && ms_state->sampleShadingEnable && (ms_state->minSampleShading != 1.0)) {
skip |= LogError("VUID-RuntimeSpirv-minSampleShading-08732", module_state.handle(), loc,
"minSampleShading (%f) is not equal to 1.0.", ms_state->minSampleShading);
}
return skip;
}
// Validate the VkPipelineShaderStageCreateInfo from the various pipeline types or a Shader Object
bool CoreChecks::ValidateShaderStage(const ShaderStageState &stage_state, const vvl::Pipeline *pipeline,
const Location &loc) const {
bool skip = false;
const VkShaderStageFlagBits stage = stage_state.GetStage();
// First validate all things that don't require valid SPIR-V
// this is found when using VK_EXT_shader_module_identifier
skip |= ValidateSpecializations(stage_state.GetSpecializationInfo(), loc.dot(Field::pSpecializationInfo));
if (pipeline) {
skip |= ValidateShaderStageMaxResources(stage, *pipeline, loc);
if (const auto *pipeline_robustness_info =
vku::FindStructInPNextChain<VkPipelineRobustnessCreateInfo>(stage_state.GetPNext())) {
skip |= ValidatePipelineRobustnessCreateInfo(*pipeline, *pipeline_robustness_info, loc);
}
}
// Skip if VK_VALIDATION_FEATURE_DISABLE_SHADERS_EXT is set
// Both the validation and running spirv-opt on the spec constants really makes this function slow
// See https://github.com/KhronosGroup/Vulkan-ValidationLayers/pull/10566 for more info
if (disabled[shader_validation]) {
return skip;
}
if ((pipeline && pipeline->uses_shader_module_id) || !stage_state.spirv_state) {
return skip; // these edge cases should be validated already
}
if (!stage_state.spirv_state->valid_spirv) {
return skip; // checked elsewhere
}
if (!stage_state.entrypoint) {
const char *vuid = pipeline ? "VUID-VkPipelineShaderStageCreateInfo-pName-00707" : "VUID-VkShaderCreateInfoEXT-pName-08440";
std::stringstream err;
err << "\"" << stage_state.GetPName() << "\" entry point not found for stage " << string_VkShaderStageFlagBits(stage)
<< ".";
if (stage_state.spirv_state->static_data_.entry_points.size() == 1) {
auto entry_point = stage_state.spirv_state->static_data_.entry_points[0];
if (entry_point) {
if (entry_point->stage != stage) {
err << " (Seems like you accidently created your SPIR-V with "
<< string_VkShaderStageFlagBits(entry_point->stage) << " so the entry point is not matching up)";
} else {
err << " (The only entry point found was \"" << entry_point->name << "\" for "
<< string_VkShaderStageFlagBits(entry_point->stage) << ")";
if (entry_point->name == "main") {
err << "\nSome shading languages will let you name the main function something else, but when "
"compiled to SPIR-V, it will keep it as 'main' to match defaults found in other shading langauges "
"such "
"as GLSL. It is also valid in a single SPIR-V binary to have 'main' for two different stages.";
}
}
}
} else {
err << " The following entry points were found in the SPIR-V module:\n";
for (const auto &entry_point : stage_state.spirv_state->static_data_.entry_points) {
if (!entry_point) continue;
err << "\"" << entry_point->name << "\"\t(" << string_VkShaderStageFlagBits(entry_point->stage) << ")\n";
}
}
return LogError(vuid, device, loc.dot(Field::pName), "%s", err.str().c_str());
}
std::shared_ptr<const spirv::Module> module_state_ptr = stage_state.spirv_state;
std::shared_ptr<const spirv::EntryPoint> entrypoint_ptr = stage_state.entrypoint;
// If specialization-constant instructions are present in the shader, the specializations should be applied.
// If spirv_const_fold is turned off, the default spec constants values are used
if (module_state_ptr->static_data_.has_specialization_constants && global_settings.spirv_const_fold) {
// setup the call back if the optimizer fails
spvtools::Optimizer optimizer(spirv_environment);
spvtools::MessageConsumer consumer = [&skip, &module_state_ptr, &stage, loc, this](
spv_message_level_t level, const char *source, const spv_position_t &position,
const char *message) {
skip |= LogError("VUID-VkPipelineShaderStageCreateInfo-module-parameter", device, loc,
"%s failed in spirv-opt because it does not contain valid spirv for stage %s. %s",
FormatHandle(module_state_ptr->handle()).c_str(), string_VkShaderStageFlagBits(stage), message);
};
optimizer.SetMessageConsumer(consumer);
// The app might be using the default spec constant values, but if they pass values at runtime to the pipeline then need to
// use those values to apply to the spec constants
auto const &specialization_info = stage_state.GetSpecializationInfo();
if (specialization_info != nullptr && specialization_info->mapEntryCount > 0 &&
specialization_info->pMapEntries != nullptr) {
// Gather the specialization-constant values.
auto const &specialization_data = reinterpret_cast<uint8_t const *>(specialization_info->pData);
std::unordered_map<uint32_t, std::vector<uint32_t>> id_value_map; // note: this must be std:: to work with spvtools
id_value_map.reserve(specialization_info->mapEntryCount);
// spirv-val makes sure every OpSpecConstant has a OpDecoration.
for (const auto &[result_id, spec_id] : module_state_ptr->static_data_.id_to_spec_id) {
VkSpecializationMapEntry map_entry = {spirv::kInvalidValue, 0, 0};
for (uint32_t i = 0; i < specialization_info->mapEntryCount; i++) {
if (specialization_info->pMapEntries[i].constantID == spec_id) {
map_entry = specialization_info->pMapEntries[i];
break;
}
}
// "If a constantID value is not a specialization constant ID used in the shader, that map entry does not affect the
// behavior of the pipeline."
if (map_entry.constantID == spirv::kInvalidValue) {
continue;
}
uint32_t spec_const_size = spirv::kInvalidValue;
const spirv::Instruction *def_insn = module_state_ptr->FindDef(result_id);
const spirv::Instruction *type_insn = module_state_ptr->FindDef(def_insn->Word(1));
// Specialization constants can only be of type bool, scalar integer, or scalar floating point
switch (type_insn->Opcode()) {
case spv::OpTypeBool:
// "If the specialization constant is of type boolean, size must be the byte size of VkBool32"
spec_const_size = sizeof(VkBool32);
break;
case spv::OpTypeInt:
case spv::OpTypeFloat:
spec_const_size = type_insn->Word(2) / 8;
break;
default:
// spirv-val should catch if SpecId is not used on a
// OpSpecConstantTrue/OpSpecConstantFalse/OpSpecConstant and OpSpecConstant is validated to be a
// OpTypeInt or OpTypeFloat
break;
}
if (map_entry.size != spec_const_size) {
std::stringstream name;
if (module_state_ptr->handle() != NullVulkanTypedHandle) {
name << "shader module " << FormatHandle(module_state_ptr->handle());
} else {
name << "shader object";
}
skip |= LogError("VUID-VkSpecializationMapEntry-constantID-00776", device, loc,
"specialization constant (ID = %" PRIu32 ", entry = %" PRIu32
") has invalid size %zu in %s. Expected size is %" PRIu32 " from shader definition.",
map_entry.constantID, spec_id, map_entry.size,
FormatHandle(module_state_ptr->handle()).c_str(), spec_const_size);
}
if ((map_entry.offset + map_entry.size) <= specialization_info->dataSize) {
// Allocate enough room for ceil(map_entry.size / 4) to store entries
std::vector<uint32_t> entry_data((map_entry.size + 4 - 1) / 4, 0);
uint8_t *out_p = reinterpret_cast<uint8_t *>(entry_data.data());
const uint8_t *const start_in_p = specialization_data + map_entry.offset;
const uint8_t *const end_in_p = start_in_p + map_entry.size;
std::copy(start_in_p, end_in_p, out_p);
id_value_map.emplace(map_entry.constantID, std::move(entry_data));
}
}
// This pass takes the runtime spec const values and applies it into the SPIR-V
// will turn a spec constant like
// OpSpecConstant %uint 1
// to a use the value passed in instead (for example if the value is 32) so now it looks like
// OpSpecConstant %uint 32
optimizer.RegisterPass(spvtools::CreateSetSpecConstantDefaultValuePass(id_value_map));
}
// This pass will turn OpSpecConstant into a OpConstant (also OpSpecConstantTrue/OpSpecConstantFalse)
optimizer.RegisterPass(spvtools::CreateFreezeSpecConstantValuePass());
// Using the new frozen OpConstant all OpSpecConstantComposite can be resolved turning them into OpConstantComposite
// This is need incase a shdaer looks like:
//
// layout(constant_id = 0) const uint x = 64;
// shared uint arr[x > 64 ? 64 : x];
//
// this will generate branch/switch statements that we want to leverage spirv-opt to apply to make parsing easier
optimizer.RegisterPass(spvtools::CreateFoldSpecConstantOpAndCompositePass());
// Apply the specialization-constant values and revalidate the shader module is valid.
// Example of the SPIR-V Optimization occuring (https://godbolt.org/z/Y7WYczEq4)
std::vector<uint32_t> specialized_spirv;
auto const optimized = optimizer.Run(module_state_ptr->words_.data(), module_state_ptr->words_.size(), &specialized_spirv,
spirv_val_options, true);
if (optimized) {
spv_context ctx = spvContextCreate(spirv_environment);
spv_const_binary_t binary{specialized_spirv.data(), specialized_spirv.size()};
spv_diagnostic diag = nullptr;
auto const spv_valid = spvValidateWithOptions(ctx, spirv_val_options, &binary, &diag);
if (spv_valid != SPV_SUCCESS) {
const char *vuid = pipeline ? "VUID-VkPipelineShaderStageCreateInfo-pSpecializationInfo-06849"
: "VUID-VkShaderCreateInfoEXT-pCode-08460";
std::string name = pipeline ? FormatHandle(module_state_ptr->handle()) : "shader object";
skip |= LogError(vuid, device, loc,
"After specialization was applied, %s produces a spirv-val error (stage %s):\n%s\nCommand to "
"reproduce:\n\t%s\n",
name.c_str(), string_VkShaderStageFlagBits(stage),
diag && diag->error ? diag->error : "(no error text)", spirv_val_command.c_str());
}
// There is only 3 real ways to handle spec constants
// 1. Store a new copy of spirv::Module in the pipeline/shaderObject and do nothing during vkCreateShaderModule.
// For things using spec const, this will save parsing twice,
// but for things not using spec constant, it is wasted memory to store and wasted time to parse twice.
// 2. Do the 3 spirv-opt passes internally, the first 2 are easy, but CreateFoldSpecConstantOpAndCompositePass is harder
// There are a lot of cases to get correct, but if we have this, then we just have the mapping internally.
// 3. [what we do] Realize most things don't really care about the spec constants, but those that do, have all been
// (hopefully) funneled into the this ValidateShaderStage function below.
// So now all the checks below can assume things are OpConstant. The 2 main drawbacks are:
// one, this is not obvious what is going on here at first
// two, the new optimized spirv::Module IDs will not match the old one, for error messages that is fine, because we
// should just be using ShaderDebugInfo anyway.
//
// Side note, according to https://github.com/KhronosGroup/Vulkan-Docs/issues/1671 anything labeled as "static use"
// (such as if an input is used or not) don't have to be checked post spec constants freezing since the device compiler
// is not guaranteed to run things such as dead-code elimination.
module_state_ptr =
std::make_shared<spirv::Module>(vvl::make_span<const uint32_t>(specialized_spirv.data(), specialized_spirv.size()));
entrypoint_ptr = module_state_ptr->FindEntrypoint(entrypoint_ptr->name.c_str(), entrypoint_ptr->stage);
assert(entrypoint_ptr); // spirv-opt won't change Entrypoint Name/stage
spvDiagnosticDestroy(diag);
spvContextDestroy(ctx);
} else {
// Should never get here, but better then asserting
const char *vuid = pipeline ? "VUID-VkPipelineShaderStageCreateInfo-pSpecializationInfo-06849"
: "VUID-VkShaderCreateInfoEXT-pCode-08460";
skip |= LogError(vuid, device, loc,
"%s shader (stage %s) attempted to apply specialization constants with spirv-opt but failed.",
FormatHandle(module_state_ptr->handle()).c_str(), string_VkShaderStageFlagBits(stage));
return skip;
}
if (skip) {
return skip; // if spec constants have errors, can produce false positives later
}
}
const spirv::Module &module_state = *module_state_ptr;
const spirv::EntryPoint &entrypoint = *entrypoint_ptr;
spirv::LocalSize local_size = module_state.FindLocalSize(entrypoint);
skip |= ValidateImageWrite(module_state, loc);
skip |= ValidateShaderExecutionModes(module_state, entrypoint, stage, pipeline, loc);
skip |= ValidateBuiltinLimits(module_state, entrypoint, pipeline, loc);
skip |= ValidatePushConstantUsage(module_state, entrypoint, pipeline, stage_state, loc);
if (enabled_features.cooperativeMatrix) {
skip |= ValidateCooperativeMatrix(module_state, entrypoint, stage_state, local_size, loc);
}
if (enabled_features.cooperativeVector) {
skip |= ValidateCooperativeVector(module_state, entrypoint, loc);
}
skip |= ValidateShader64BitIndexing(module_state, entrypoint, stage_state, pipeline, loc);
if (pipeline) {
if (enabled_features.transformFeedback) {
skip |= ValidateTransformFeedbackPipeline(module_state, entrypoint, *pipeline, loc);
}
if (enabled_features.primitiveFragmentShadingRate) {
skip |= ValidatePrimitiveRateShaderState(module_state, entrypoint, *pipeline, stage, loc);
}
if (enabled_features.customResolve || IsExtEnabled(extensions.vk_qcom_render_pass_shader_resolve)) {
skip |= ValidateSubpassCustomeResolve(module_state, stage, *pipeline, loc);
}
skip |= ValidatePointSizeShaderState(module_state, entrypoint, *pipeline, stage, loc);
skip |= ValidatePrimitiveTopology(module_state, entrypoint, *pipeline, loc);
if (stage == VK_SHADER_STAGE_FRAGMENT_BIT) {
if (IsExtEnabled(extensions.vk_ext_shader_tile_image)) {
skip |= ValidateShaderTileImage(module_state, entrypoint, *pipeline, loc);
}
if (pipeline->GraphicsCreateInfo().renderPass == VK_NULL_HANDLE &&
module_state.HasCapability(spv::CapabilityInputAttachment) && !enabled_features.dynamicRenderingLocalRead) {
skip |= LogError("VUID-VkGraphicsPipelineCreateInfo-renderPass-06061", device, loc,
"is being created with fragment shader with InputAttachment capability, but renderPass is "
"VK_NULL_HANDLE. (It is only possbile to use input attachments with dynamic rendering if the "
"dynamicRenderingLocalRead feature is enabled)");
}
}
}
uint32_t total_workgroup_shared_memory = 0;
if (stage == VK_SHADER_STAGE_COMPUTE_BIT || stage == VK_SHADER_STAGE_TASK_BIT_EXT || stage == VK_SHADER_STAGE_MESH_BIT_EXT) {
// Only stages this matters to calculate
total_workgroup_shared_memory = module_state.CalculateWorkgroupSharedMemory();
bool fail = false;
const uint32_t limit = phys_dev_props.limits.maxComputeWorkGroupInvocations;
uint64_t invocations = static_cast<uint64_t>(local_size.x) * static_cast<uint64_t>(local_size.y);
// Prevent overflow.
if (invocations > limit) {
fail = true;
}
invocations *= local_size.z;
if (invocations > limit) {
fail = true;
}
if (fail && stage == VK_SHADER_STAGE_COMPUTE_BIT) {
skip |= LogError("VUID-RuntimeSpirv-x-06432", module_state.handle(), loc,
"SPIR-V LocalSize (%s) exceeds device limit maxComputeWorkGroupInvocations (%" PRIu32 ").",
local_size.ToString().c_str(), phys_dev_props.limits.maxComputeWorkGroupInvocations);
}
skip |= ValidateRequiredSubgroupSize(module_state, stage_state, invocations, local_size, loc);
skip |= ValidateWorkgroupSharedMemory(module_state, stage, total_workgroup_shared_memory, loc);
}
for (const auto &variable : entrypoint.resource_interface_variables) {
vvl::unordered_set<uint32_t> descriptor_type_set;
TypeToDescriptorTypeSet(module_state, variable.type_id, variable.data_type_id, descriptor_type_set);
skip |= ValidateShaderInterfaceVariable(module_state, variable, descriptor_type_set, loc);
if (stage_state.descriptor_set_layouts) {
skip |= ValidateShaderInterfaceVariableDSL(module_state, entrypoint, stage_state, variable, descriptor_type_set, loc);
}
if (pipeline) {
if (variable.decorations.Has(spirv::DecorationSet::input_attachment_bit)) {
skip |= ValidateShaderInputAttachment(module_state, stage_state, *pipeline, variable, loc);
}
}
}
if (stage == VK_SHADER_STAGE_COMPUTE_BIT) {
skip |= ValidateComputeWorkGroupSizes(module_state, entrypoint, stage_state, local_size, loc);
} else if (stage == VK_SHADER_STAGE_TASK_BIT_EXT || stage == VK_SHADER_STAGE_MESH_BIT_EXT) {
skip |= ValidateTaskMeshWorkGroupSizes(module_state, entrypoint, local_size, loc);
if (stage == VK_SHADER_STAGE_TASK_BIT_EXT) {
skip |= ValidateEmitMeshTasksSize(module_state, entrypoint, loc);
} else if (stage == VK_SHADER_STAGE_MESH_BIT_EXT) {
const uint32_t total_task_payload_memory =
entrypoint.task_payload_variable ? entrypoint.task_payload_variable->size : 0;
skip |= ValidateMeshMemorySize(module_state, total_workgroup_shared_memory, total_task_payload_memory, loc);
}
}
return skip;
}
uint32_t CoreChecks::CalcShaderStageCount(const vvl::Pipeline &pipeline, VkShaderStageFlagBits stageBit) const {
uint32_t total = 0;
for (const auto &stage_ci : pipeline.shader_stages_ci) {
if (stage_ci.stage == stageBit) {
total++;
}
}
if (pipeline.ray_tracing_library_ci) {
for (uint32_t i = 0; i < pipeline.ray_tracing_library_ci->libraryCount; ++i) {
auto library_pipeline = Get<vvl::Pipeline>(pipeline.ray_tracing_library_ci->pLibraries[i]);
if (!library_pipeline) continue;
total += CalcShaderStageCount(*library_pipeline, stageBit);
}
}
return total;
}
bool CoreChecks::GroupHasValidIndex(const vvl::Pipeline &pipeline, uint32_t group, uint32_t stage) const {
if (group == VK_SHADER_UNUSED_KHR) {
return true;
}
const auto num_stages = static_cast<uint32_t>(pipeline.shader_stages_ci.size());
if (group < num_stages) {
return (pipeline.shader_stages_ci[group].stage & stage) != 0;
}
group -= num_stages;
// Search libraries
if (pipeline.ray_tracing_library_ci) {
for (uint32_t i = 0; i < pipeline.ray_tracing_library_ci->libraryCount; ++i) {
auto library_pipeline = Get<vvl::Pipeline>(pipeline.ray_tracing_library_ci->pLibraries[i]);
if (!library_pipeline) {
continue;
}
const uint32_t stage_count = static_cast<uint32_t>(library_pipeline->shader_stages_ci.size());
if (group < stage_count) {
return (library_pipeline->shader_stages_ci[group].stage & stage) != 0;
}
group -= stage_count;
}
}
// group index too large
return false;
}
// This is done in PreCallRecord to help with the interaction with GPU-AV
// See diagram on https://github.com/KhronosGroup/Vulkan-ValidationLayers/pull/6230
void CoreChecks::PreCallRecordCreateShaderModule(VkDevice device, const VkShaderModuleCreateInfo *pCreateInfo,
const VkAllocationCallbacks *pAllocator, VkShaderModule *pShaderModule,
const RecordObject &record_obj, chassis::CreateShaderModule &chassis_state) {
// Normally would validate in PreCallValidate, but need a non-const function to update chassis_state
// This is on the stack, we don't have to worry about threading hazards and this could be moved and used const_cast
chassis_state.skip |=
stateless_spirv_validator.Validate(*chassis_state.module_state, chassis_state.stateless_data, record_obj.location);
}
void CoreChecks::PreCallRecordCreateShadersEXT(VkDevice device, uint32_t createInfoCount, const VkShaderCreateInfoEXT *pCreateInfos,
const VkAllocationCallbacks *pAllocator, VkShaderEXT *pShaders,
const RecordObject &record_obj, chassis::ShaderObject &chassis_state) {
// For ShaderObjects, to validate most things we need to first parse the SPIR-V.
// We use to parse both at PreCallValidate and PreCallRecord which was wasteful.
// We now parse it at PreCallRecord (so we can store it) and then just do the validation here
chassis_state.skip = ValidateCreateShadersSpirv(createInfoCount, pCreateInfos, record_obj.location, chassis_state);
}
bool CoreChecks::RunSpirvValidation(spv_const_binary_t &binary, const Location &loc, ValidationCache *cache) const {
bool skip = false;
if (global_settings.debug_disable_spirv_val) {
return skip;
}
uint32_t hash = 0;
if (cache) {
hash = hash_util::Hash32((void *)binary.code, binary.wordCount * sizeof(uint32_t));
if (cache->Contains(hash)) {
return skip;
}
}
// Use SPIRV-Tools validator to try and catch any issues with the module itself. If specialization constants are present,
// the default values will be used during validation.
spv_context ctx = spvContextCreate(spirv_environment);
spv_diagnostic diag = nullptr;
const spv_result_t spv_valid = spvValidateWithOptions(ctx, spirv_val_options, &binary, &diag);
if (spv_valid != SPV_SUCCESS) {
const char *error_message = diag && diag->error ? diag->error : "(no error text)";
// Umbrella VUID if we can't find one in spirv-val
const char *vuid = loc.function == Func::vkCreateShadersEXT ? "VUID-VkShaderCreateInfoEXT-pCode-08737"
: "VUID-VkShaderModuleCreateInfo-pCode-08737";
// We want to search inside the spirv-val error message to see if there is VUID in it as it allows people to silence just
// that VUID and not the whole spirv-val check
char *spirv_val_vuid = nullptr;
if (diag && diag->error) {
// Note: Will always start with "[VUID-xxx-00000]" if there is one
if (std::strncmp(error_message, "[VUID", 5) == 0) {
const char *bracket_end = std::strchr(error_message, ']');
if (bracket_end) {
const size_t vuid_len = bracket_end - error_message - 1;
spirv_val_vuid = new char[vuid_len + 1]; // +1 for null-terminator
std::strncpy(spirv_val_vuid, error_message + 1, vuid_len);
spirv_val_vuid[vuid_len] = '\0';
// Remove VUID from error message now
error_message = bracket_end + 2;
}
vuid = spirv_val_vuid;
}
}
if (spv_valid == SPV_WARNING) {
skip |= LogWarning(vuid, device, loc.dot(Field::pCode),
"(spirv-val produced a warning):\n%s\nCommand to reproduce:\n\t%s\n", error_message,
spirv_val_command.c_str());
} else {
skip |=
LogError(vuid, device, loc.dot(Field::pCode), "(spirv-val produced an error):\n%s\nCommand to reproduce:\n\t%s\n",
error_message, spirv_val_command.c_str());
}
if (spirv_val_vuid) {
delete[] spirv_val_vuid;
}
} else if (cache) {
// No point to cache anything that is not valid, or it will get suppressed on the next run
cache->Insert(hash);
}
spvDiagnosticDestroy(diag);
spvContextDestroy(ctx);
return skip;
}
bool CoreChecks::ValidateShaderModuleCreateInfo(const VkShaderModuleCreateInfo &create_info,
const Location &create_info_loc) const {
bool skip = false;
if (disabled[shader_validation]) {
return skip; // VK_VALIDATION_FEATURE_DISABLE_SHADERS_EXT
} else if (!create_info.pCode) {
return skip; // will be caught elsewhere
}
// This extension is meant for tooling, but still valid to be used, if used, we need to detect if GLSL
if (IsExtEnabled(extensions.vk_nv_glsl_shader)) {
if (strncmp((char *)create_info.pCode, "#version", 8) == 0) {
return skip; // incoming GLSL
}
}
const uint32_t first_dword = create_info.pCode[0];
if (SafeModulo(create_info.codeSize, 4) != 0) {
skip |=
LogError("VUID-VkShaderModuleCreateInfo-codeSize-08735", device, create_info_loc.dot(Field::codeSize),
"(%zu) must be a multiple of 4. You might have forget to multiply by sizeof(uint32_t).", create_info.codeSize);
} else if (first_dword != spv::MagicNumber) {
skip |= LogError("VUID-VkShaderModuleCreateInfo-pCode-08738", device, create_info_loc.dot(Field::pCode),
"doesn't point to a SPIR-V module. The first dword (0x%" PRIx32
") is not the SPIR-V MagicNumber (0x07230203).",
first_dword);
} else {
// if pCode is garbage, don't pass along to spirv-val
const auto validation_cache_ci = vku::FindStructInPNextChain<VkShaderModuleValidationCacheCreateInfoEXT>(create_info.pNext);
ValidationCache *cache =
validation_cache_ci ? CastFromHandle<ValidationCache *>(validation_cache_ci->validationCache) : nullptr;
// If app isn't using a shader validation cache, use the default one from CoreChecks
if (!cache) {
cache = CastFromHandle<ValidationCache *>(core_validation_cache);
}
spv_const_binary_t binary{create_info.pCode, create_info.codeSize / sizeof(uint32_t)};
skip |= RunSpirvValidation(binary, create_info_loc, cache);
}
return skip;
}
bool CoreChecks::PreCallValidateCreateShaderModule(VkDevice device, const VkShaderModuleCreateInfo *pCreateInfo,
const VkAllocationCallbacks *pAllocator, VkShaderModule *pShaderModule,
const ErrorObject &error_obj) const {
return ValidateShaderModuleCreateInfo(*pCreateInfo, error_obj.location.dot(Field::pCreateInfo));
}
bool CoreChecks::PreCallValidateGetShaderModuleIdentifierEXT(VkDevice device, VkShaderModule shaderModule,
VkShaderModuleIdentifierEXT *pIdentifier,
const ErrorObject &error_obj) const {
bool skip = false;
if (!(enabled_features.shaderModuleIdentifier)) {
skip |= LogError("VUID-vkGetShaderModuleIdentifierEXT-shaderModuleIdentifier-06884", shaderModule, error_obj.location,
"the shaderModuleIdentifier feature was not enabled.");
}
return skip;
}
bool CoreChecks::PreCallValidateGetShaderModuleCreateInfoIdentifierEXT(VkDevice device, const VkShaderModuleCreateInfo *pCreateInfo,
VkShaderModuleIdentifierEXT *pIdentifier,
const ErrorObject &error_obj) const {
bool skip = false;
if (!(enabled_features.shaderModuleIdentifier)) {
skip |= LogError("VUID-vkGetShaderModuleCreateInfoIdentifierEXT-shaderModuleIdentifier-06885", device, error_obj.location,
"the shaderModuleIdentifier feature was not enabled.");
}
return skip;
}
bool CoreChecks::ValidateRequiredSubgroupSize(const spirv::Module &module_state, const ShaderStageState &stage_state,
uint64_t invocations, const spirv::LocalSize &local_size, const Location &loc) const {
bool skip = false;
const auto *required_subgroup_size_ci =
vku::FindStructInPNextChain<VkPipelineShaderStageRequiredSubgroupSizeCreateInfo>(stage_state.GetPNext());
if (!required_subgroup_size_ci) return skip;
const Location pNext_loc = loc.pNext(Struct::VkPipelineShaderStageRequiredSubgroupSizeCreateInfo);
const uint32_t required_subgroup_size = required_subgroup_size_ci->requiredSubgroupSize;
if (!enabled_features.subgroupSizeControl) {
skip |= LogError("VUID-VkPipelineShaderStageCreateInfo-pNext-02755", module_state.handle(), pNext_loc,
"the subgroupSizeControl feature was not enabled");
}
if ((phys_dev_props_core13.requiredSubgroupSizeStages & stage_state.GetStage()) == 0) {
skip |=
LogError("VUID-VkPipelineShaderStageCreateInfo-pNext-02755", module_state.handle(), loc,
"SPIR-V (%s) is not in requiredSubgroupSizeStages (%s).", string_VkShaderStageFlagBits(stage_state.GetStage()),
string_VkShaderStageFlags(phys_dev_props_core13.requiredSubgroupSizeStages).c_str());
}
if ((invocations > required_subgroup_size * phys_dev_props_core13.maxComputeWorkgroupSubgroups)) {
skip |= LogError("VUID-VkPipelineShaderStageCreateInfo-pNext-02756", module_state.handle(), loc,
"SPIR-V Local workgroup size (%s) is greater than requiredSubgroupSize (%" PRIu32
") * maxComputeWorkgroupSubgroups (%" PRIu32 ").",
local_size.ToString().c_str(), required_subgroup_size, phys_dev_props_core13.maxComputeWorkgroupSubgroups);
}
if (stage_state.pipeline_create_info &&
(stage_state.pipeline_create_info->flags & VK_PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT) > 0) {
if (SafeModulo(local_size.x, required_subgroup_size) != 0) {
skip |= LogError("VUID-VkPipelineShaderStageCreateInfo-pNext-02757", module_state.handle(), loc,
"SPIR-V Local workgroup size x (%" PRIu32
") is not a multiple of "
"requiredSubgroupSize (%" PRIu32 ").",
local_size.x, required_subgroup_size);
}
}
if (!IsPowerOfTwo(required_subgroup_size)) {
skip |= LogError("VUID-VkPipelineShaderStageRequiredSubgroupSizeCreateInfo-requiredSubgroupSize-02760",
module_state.handle(), pNext_loc.dot(Field::requiredSubgroupSizeStages),
"(%" PRIu32 ") is not a power of 2.", required_subgroup_size);
}
if (required_subgroup_size < phys_dev_props_core13.minSubgroupSize) {
skip |=
LogError("VUID-VkPipelineShaderStageRequiredSubgroupSizeCreateInfo-requiredSubgroupSize-02761", module_state.handle(),
pNext_loc.dot(Field::requiredSubgroupSizeStages), "(%" PRIu32 ") is less than minSubgroupSize (%" PRIu32 ").",
required_subgroup_size, phys_dev_props_core13.minSubgroupSize);
}
if (required_subgroup_size > phys_dev_props_core13.maxSubgroupSize) {
skip |= LogError("VUID-VkPipelineShaderStageRequiredSubgroupSizeCreateInfo-requiredSubgroupSize-02762",
module_state.handle(), pNext_loc.dot(Field::requiredSubgroupSizeStages),
"(%" PRIu32 ") is greater than maxSubgroupSize (%" PRIu32 ").", required_subgroup_size,
phys_dev_props_core13.maxSubgroupSize);
}
return skip;
}
bool CoreChecks::ValidateComputeWorkGroupSizes(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const ShaderStageState &stage_state, const spirv::LocalSize &local_size,
const Location &loc) const {
bool skip = false;
if (local_size.x == 0) {
return skip;
}
if (local_size.x > phys_dev_props.limits.maxComputeWorkGroupSize[0]) {
skip |= LogError("VUID-RuntimeSpirv-x-06429", module_state.handle(), loc,
"SPIR-V LocalSize X (%" PRIu32 ") exceeds device limit maxComputeWorkGroupSize[0] (%" PRIu32 ").",
local_size.x, phys_dev_props.limits.maxComputeWorkGroupSize[0]);
}
if (local_size.y > phys_dev_props.limits.maxComputeWorkGroupSize[1]) {
skip |= LogError("VUID-RuntimeSpirv-y-06430", module_state.handle(), loc,
"SPIR-V LocalSize Y (%" PRIu32 ") exceeds device limit maxComputeWorkGroupSize[1] (%" PRIu32 ").",
local_size.y, phys_dev_props.limits.maxComputeWorkGroupSize[1]);
}
if (local_size.z > phys_dev_props.limits.maxComputeWorkGroupSize[2]) {
skip |= LogError("VUID-RuntimeSpirv-z-06431", module_state.handle(), loc,
"SPIR-V LocalSize Z (%" PRIu32 ") exceeds device limit maxComputeWorkGroupSize[2] (%" PRIu32 ").",
local_size.z, phys_dev_props.limits.maxComputeWorkGroupSize[2]);
}
if (stage_state.pipeline_create_info) {
const auto subgroup_flags = VK_PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT |
VK_PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT;
if ((stage_state.pipeline_create_info->flags & subgroup_flags) == subgroup_flags) {
if (SafeModulo(local_size.x, phys_dev_props_core13.maxSubgroupSize) != 0) {
skip |= LogError(
"VUID-VkPipelineShaderStageCreateInfo-flags-02758", module_state.handle(), loc.dot(Field::flags),
"(%s), but local workgroup size X dimension (%" PRIu32
") is not a multiple of VkPhysicalDeviceSubgroupSizeControlPropertiesEXT::maxSubgroupSize (%" PRIu32 ").",
string_VkPipelineShaderStageCreateFlags(stage_state.pipeline_create_info->flags).c_str(), local_size.x,
phys_dev_props_core13.maxSubgroupSize);
}
} else if ((stage_state.pipeline_create_info->flags & VK_PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT) &&
(stage_state.pipeline_create_info->flags & VK_PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT) ==
0) {
if (!vku::FindStructInPNextChain<VkPipelineShaderStageRequiredSubgroupSizeCreateInfo>(stage_state.GetPNext())) {
if (SafeModulo(local_size.x, phys_dev_props_core11.subgroupSize) != 0) {
skip |=
LogError("VUID-VkPipelineShaderStageCreateInfo-flags-02759", module_state.handle(), loc.dot(Field::flags),
"(%s), but local workgroup size X dimension (%" PRIu32
") is not a multiple of VkPhysicalDeviceVulkan11Properties::subgroupSize (%" PRIu32 ").",
string_VkPipelineShaderStageCreateFlags(stage_state.pipeline_create_info->flags).c_str(),
local_size.x, phys_dev_props_core11.subgroupSize);
}
}
}
} else {
const bool varying = stage_state.shader_object_create_info->flags & VK_SHADER_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT_EXT;
const bool full = stage_state.shader_object_create_info->flags & VK_SHADER_CREATE_REQUIRE_FULL_SUBGROUPS_BIT_EXT;
const auto *required_subgroup_size =
vku::FindStructInPNextChain<VkShaderRequiredSubgroupSizeCreateInfoEXT>(stage_state.GetPNext());
if (varying && full) {
if (SafeModulo(local_size.x, phys_dev_props_core13.maxSubgroupSize) != 0) {
skip |= LogError(
"VUID-VkShaderCreateInfoEXT-flags-08416", module_state.handle(), loc.dot(Field::flags),
"(%s) but local workgroup size X dimension (%" PRIu32
") is not a multiple of VkPhysicalDeviceSubgroupSizeControlPropertiesEXT::maxSubgroupSize (%" PRIu32 ").",
string_VkPipelineShaderStageCreateFlags(stage_state.shader_object_create_info->flags).c_str(), local_size.x,
phys_dev_props_core13.maxSubgroupSize);
}
} else if (full && !varying) {
if (!required_subgroup_size && SafeModulo(local_size.x, phys_dev_props_core11.subgroupSize) != 0) {
skip |= LogError("VUID-VkShaderCreateInfoEXT-flags-08417", module_state.handle(), loc.dot(Field::flags),
"(%s), but local workgroup size X dimension (%" PRIu32
") is not a multiple of VkPhysicalDeviceVulkan11Properties::subgroupSize (%" PRIu32 ").",
string_VkPipelineShaderStageCreateFlags(stage_state.shader_object_create_info->flags).c_str(),
local_size.x, phys_dev_props_core11.subgroupSize);
}
}
}
return skip;
}
bool CoreChecks::ValidateTaskMeshWorkGroupSizes(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const spirv::LocalSize &local_size, const Location &loc) const {
bool skip = false;
if (local_size.x == 0) {
return skip;
}
spirv::LocalSize max_local_size;
uint32_t max_workgroup_size = 0;
const char *x_vuid;
const char *y_vuid;
const char *z_vuid;
const char *workgroup_size_vuid;
switch (entrypoint.execution_model) {
case spv::ExecutionModelTaskEXT: {
x_vuid = "VUID-RuntimeSpirv-TaskEXT-07291";
y_vuid = "VUID-RuntimeSpirv-TaskEXT-07292";
z_vuid = "VUID-RuntimeSpirv-TaskEXT-07293";
workgroup_size_vuid = "VUID-RuntimeSpirv-TaskEXT-07294";
max_local_size.x = phys_dev_ext_props.mesh_shader_props_ext.maxTaskWorkGroupSize[0];
max_local_size.y = phys_dev_ext_props.mesh_shader_props_ext.maxTaskWorkGroupSize[1];
max_local_size.z = phys_dev_ext_props.mesh_shader_props_ext.maxTaskWorkGroupSize[2];
max_workgroup_size = phys_dev_ext_props.mesh_shader_props_ext.maxTaskWorkGroupInvocations;
break;
}
case spv::ExecutionModelMeshEXT: {
x_vuid = "VUID-RuntimeSpirv-MeshEXT-07295";
y_vuid = "VUID-RuntimeSpirv-MeshEXT-07296";
z_vuid = "VUID-RuntimeSpirv-MeshEXT-07297";
workgroup_size_vuid = "VUID-RuntimeSpirv-MeshEXT-07298";
max_local_size.x = phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupSize[0];
max_local_size.y = phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupSize[1];
max_local_size.z = phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupSize[2];
max_workgroup_size = phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupInvocations;
break;
}
// skip for spv::ExecutionModelTaskNV and spv::ExecutionModelMeshNV case
default: {
// must match one of the above case
return skip;
}
}
if (local_size.x > max_local_size.x) {
skip |= LogError(x_vuid, module_state.handle(), loc,
"SPIR-V (%s) local workgroup size X dimension (%" PRIu32
") must be less than or equal to the max workgroup size (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), local_size.x, max_local_size.x);
}
if (local_size.y > max_local_size.y) {
skip |= LogError(y_vuid, module_state.handle(), loc,
"SPIR-V (%s) local workgroup size Y dimension (%" PRIu32
") must be less than or equal to the max workgroup size (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), local_size.y, max_local_size.y);
}
if (local_size.z > max_local_size.z) {
skip |= LogError(z_vuid, module_state.handle(), loc,
"SPIR-V (%s) local workgroup size Z dimension (%" PRIu32
") must be less than or equal to the max workgroup size (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), local_size.z, max_local_size.z);
}
uint64_t invocations = static_cast<uint64_t>(local_size.x) * static_cast<uint64_t>(local_size.y);
// Prevent overflow.
bool fail = false;
if (invocations > vvl::kU32Max || invocations > max_workgroup_size) {
fail = true;
}
if (!fail) {
invocations *= local_size.z;
if (invocations > vvl::kU32Max || invocations > max_workgroup_size) {
fail = true;
}
}
if (fail) {
skip |= LogError(workgroup_size_vuid, module_state.handle(), loc,
"SPIR-V (%s) total invocation size of %" PRIu64
" (%s) must be less than or equal to max workgroup invocations (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), invocations, local_size.ToString().c_str(),
max_workgroup_size);
}
return skip;
}
bool CoreChecks::ValidateEmitMeshTasksSize(const spirv::Module &module_state, const spirv::EntryPoint &entrypoint,
const Location &loc) const {
bool skip = false;
for (const spirv::Instruction &insn : module_state.static_data_.instructions) {
if (insn.Opcode() == spv::OpEmitMeshTasksEXT) {
uint32_t x, y, z;
bool found_x = module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(1)), &x);
bool found_y = module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(2)), &y);
bool found_z = module_state.GetInt32IfConstant(*module_state.FindDef(insn.Word(3)), &z);
if (found_x && x > phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupCount[0]) {
skip |= LogError("VUID-RuntimeSpirv-TaskEXT-07299", module_state.handle(), loc,
"SPIR-V (%s) is emitting %" PRIu32
" mesh work groups in X dimension, which is greater than max mesh "
"workgroup count (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), x,
phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupCount[0]);
}
if (found_y && y > phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupCount[1]) {
skip |= LogError("VUID-RuntimeSpirv-TaskEXT-07300", module_state.handle(), loc,
"SPIR-V (%s) is emitting %" PRIu32
" mesh work groups in Y dimension, which is greater than max mesh "
"workgroup count (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), y,
phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupCount[1]);
}
if (found_z && z > phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupCount[2]) {
skip |= LogError("VUID-RuntimeSpirv-TaskEXT-07301", module_state.handle(), loc,
"SPIR-V (%s) is emitting %" PRIu32
" mesh work groups in Z dimension, which is greater than max mesh "
"workgroup count (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), z,
phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupCount[2]);
}
if (found_x && found_y && found_z) {
uint64_t invocations = static_cast<uint64_t>(x) * static_cast<uint64_t>(y);
// Prevent overflow.
bool fail = false;
if (invocations > phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupTotalCount) {
fail = true;
}
if (!fail) {
invocations *= z;
if (invocations > vvl::kU32Max ||
invocations > phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupTotalCount) {
fail = true;
}
}
if (fail) {
skip |=
LogError("VUID-RuntimeSpirv-TaskEXT-07302", module_state.handle(), loc,
"SPIR-V (%s) is emitting %" PRIu32 " x %" PRIu32 " x %" PRIu32 " mesh work groups (total %" PRIu32
"), which is greater than max mesh "
"workgroup total count (%" PRIu32 ").",
string_SpvExecutionModel(entrypoint.execution_model), x, y, z, x * y * z,
phys_dev_ext_props.mesh_shader_props_ext.maxMeshWorkGroupTotalCount);
}
}
}
}
return skip;
}
bool CoreChecks::ValidateMeshMemorySize(const spirv::Module &module_state, uint32_t total_workgroup_shared_memory,
uint32_t total_task_payload_memory, const Location &loc) const {
bool skip = false;
if (total_task_payload_memory + total_workgroup_shared_memory >
phys_dev_ext_props.mesh_shader_props_ext.maxMeshPayloadAndSharedMemorySize) {
// If task payload memory size is 0 and only shared memory is already over the limit then the more appropriate VUID 08754
// was already reported
if (total_task_payload_memory > 0) {
skip |= LogError(
"VUID-RuntimeSpirv-maxMeshPayloadAndSharedMemorySize-08755", module_state.handle(), loc,
"SPIR-V uses %" PRIu32 " bytes of task payload memory and %" PRIu32 " bytes of shared memory (combined %" PRIu32
" bytes), which is more than maxMeshPayloadAndSharedMemorySize (%" PRIu32 ").",
total_task_payload_memory, total_workgroup_shared_memory, total_task_payload_memory + total_workgroup_shared_memory,
phys_dev_ext_props.mesh_shader_props_ext.maxMeshPayloadAndSharedMemorySize);
}
}
return skip;
}
bool CoreChecks::ValidateTaskPayload(const spirv::Module &task_state, const spirv::EntryPoint &mesh_entrypoint,
const Location &loc) const {
bool skip = false;
uint32_t task_payload_size = 0;
uint32_t mesh_payload_size = 0;
if (task_state.static_data_.emit_mesh_tasks_inst.size() > 1) {
// If there are multiple OpEmitMeshTasksEXT we will need GPU-AV to know which was actually called
return skip;
}
if (!task_state.static_data_.emit_mesh_tasks_inst.empty()) {
const auto emit_mesh_task = task_state.static_data_.emit_mesh_tasks_inst.front();
// Payload is optional
if (emit_mesh_task->Length() == 5) {
if (task_state.static_data_.has_specialization_constants) {
// There is a chance this is not resolvable here to match exact size
return skip;
}
const auto *payload_variable = task_state.FindDef(emit_mesh_task->Word(4));
const spirv::Instruction *type = task_state.GetVariablePointerType(*payload_variable);
task_payload_size = task_state.GetTypeBytesSize(type);
}
}
if (mesh_entrypoint.task_payload_variable) {
mesh_payload_size = mesh_entrypoint.task_payload_variable->size;
}
// If task and mesh are both set and just matter of trying to resolve spec constant values, skip possibly reporting false
// positives
if (mesh_payload_size == spirv::kInvalidValue && task_payload_size != 0) {
return skip;
}
// It is valid to have the Task use the payload, but the mesh to ignore it
if (mesh_payload_size != 0 && task_payload_size != mesh_payload_size) {
std::stringstream ss;
ss << "The Mesh Shader has a TaskPayloadWorkgroupEXT variable, but the Task Shader ";
if (task_payload_size == 0) {
ss << "never sets a TaskPayloadWorkgroupEXT variable in the call to OpEmitMeshTasksEXT";
} else {
ss << "sets a TaskPayloadWorkgroupEXT variable that is " << task_payload_size << " bytes but needs to match the "
<< mesh_payload_size << " bytes payload in the Mesh Shader.";
}
skip |= LogError("VUID-RuntimeSpirv-MeshEXT-10883", device, loc, "%s", ss.str().c_str());
}
return skip;
}
bool CoreChecks::ValidateDataGraphPipelineShaderModuleSpirv(VkDevice device, const VkDataGraphPipelineCreateInfoARM& create_info, const Location& create_info_loc, const VkDataGraphPipelineShaderModuleCreateInfoARM& dg_shader_ci, const vvl::Pipeline& pipeline) const {
bool skip = false;
if (pipeline.stage_states.size() == 0) {
// no ShaderModule defined
return skip;
}
const auto &stage_state = pipeline.stage_states[0];
ASSERT_AND_RETURN_SKIP(stage_state.spirv_state.get());
const spirv::Module &module_spirv = *stage_state.spirv_state.get();
const Location dg_shader_ci_loc = create_info_loc.pNext(Struct::VkDataGraphPipelineShaderModuleCreateInfoARM);
// location where the VkShaderModule was defined: VkDataGraphPipelineShaderModuleCreateInfoARM or VkShaderModuleCreateInfo?
const Location module_loc =
(dg_shader_ci.module) ? dg_shader_ci_loc.dot(Field::module) : create_info_loc.pNext(Struct::VkShaderModuleCreateInfo);
if (!enabled_features.dataGraphSpecializationConstants && module_spirv.static_data_.has_specialization_constants) {
skip |=
LogError("VUID-VkDataGraphPipelineShaderModuleCreateInfoARM-dataGraphSpecializationConstants-09849", device, module_loc,
"contains OpSpec* instruction(s), but the dataGraphSpecializationConstants feature is not enabled.");
}
std::shared_ptr<spirv::EntryPoint> entry_point = nullptr;
for (auto &ep : module_spirv.static_data_.entry_points) {
if (!ep->is_data_graph) {
continue;
}
if (ep->name.compare(dg_shader_ci.pName) == 0) {
entry_point = ep;
break;
}
}
if (!entry_point) {
std::stringstream wrong_names;
for (const auto &ep : module_spirv.static_data_.entry_points) {
if (!wrong_names.str().empty()) {
wrong_names << ", ";
}
wrong_names << ep->name;
}
skip |= LogError("VUID-VkDataGraphPipelineShaderModuleCreateInfoARM-pName-09872", device,
dg_shader_ci_loc.dot(Field::pName), " is '%s' but names in OpGraphEntryPointARM instructions are: '%s'",
dg_shader_ci.pName, wrong_names.str().c_str());
// from here on we must have the correct entrypoint
return skip;
}
std::vector<std::pair<uint32_t, uint32_t>> tensor_bindings;
for (const auto &variable : entry_point->resource_interface_variables) {
vvl::unordered_set<uint32_t> descriptor_type_set;
TypeToDescriptorTypeSet(module_spirv, variable.type_id, variable.data_type_id, descriptor_type_set);
skip |= ValidateShaderInterfaceVariable(module_spirv, variable, descriptor_type_set, module_loc);
skip |=
ValidateShaderInterfaceVariableDSL(module_spirv, *entry_point, stage_state, variable, descriptor_type_set, module_loc);
if (variable.is_storage_tensor) {
tensor_bindings.push_back({variable.decorations.set, variable.decorations.binding});
// the input/output tensors must have rank and shape, i.e. exactly 5 words
auto nWords = variable.base_type.Length();
if (nWords < 5) {
skip |= LogError("VUID-RuntimeSpirv-pNext-09919", module_spirv.handle(), module_loc,
"'%s' defines a tensor without a shape.", variable.base_type.Describe().c_str());
}
}
}
std::unordered_set<uint32_t> graph_tensor_ids;
std::unordered_map<uint32_t, uint32_t> graph_constant_map;
for (auto &instruction : module_spirv.GetInstructions()) {
if (instruction.Opcode() == spv::OpTypeTensorARM) {
graph_tensor_ids.insert(instruction.Word(1));
}
if (instruction.Opcode() == spv::OpGraphConstantARM) {
graph_constant_map[instruction.Word(3)] = instruction.Word(1);
}
}
for (uint32_t j = 0; j < dg_shader_ci.constantCount; j++) {
auto &constant = dg_shader_ci.pConstants[j];
const Location constant_loc = dg_shader_ci_loc.dot(Field::pConstants, j);
if (graph_constant_map.find(constant.id) == graph_constant_map.end()) {
std::stringstream const_ids;
for (auto &c : graph_constant_map) {
if (!const_ids.str().empty()) {
const_ids << ", ";
}
const_ids << c.first;
}
skip |= LogError(
"VUID-VkDataGraphPipelineShaderModuleCreateInfoARM-id-09774", device, constant_loc.dot(Field::id),
"(%" PRIu32 ") does not match any of the GraphConstantIDs ([%s]) used by OpGraphConstantARM instructions in module",
constant.id, const_ids.str().c_str());
} else {
if (std::find(graph_tensor_ids.begin(), graph_tensor_ids.end(), graph_constant_map[constant.id]) !=
graph_tensor_ids.end()) {
auto *tensor_desc = vku::FindStructInPNextChain<VkTensorDescriptionARM>(constant.pNext);
if (!tensor_desc) {
skip |=
LogError("VUID-VkDataGraphPipelineConstantARM-id-09850", device, constant_loc,
"(%" PRIu32
") is a graph constant of tensor type, but there is no VkTensorDescriptionARM in the pNext chain",
constant.id);
} else if ((tensor_desc->usage & VK_TENSOR_USAGE_DATA_GRAPH_BIT_ARM) == 0) {
skip |= LogError(
"VUID-VkDataGraphPipelineConstantARM-id-09850", device, constant_loc.dot(Field::id),
"(%" PRIu32
") is a graph constant of tensor type but its matching VkTensorDescriptionARM has an invalid usage (%s)",
constant.id, string_VkTensorUsageFlagsARM(tensor_desc->usage).c_str());
}
}
}
}
for (uint32_t j = 0; j < create_info.resourceInfoCount; j++) {
auto resource = create_info.pResourceInfos[j];
auto resource_loc = create_info_loc.dot(Field::pResourceInfos, j);
std::pair<uint32_t, uint32_t> resource_binding = {resource.descriptorSet, resource.binding};
auto tensor_binding = std::find(tensor_bindings.begin(), tensor_bindings.end(), resource_binding);
if (tensor_binding != tensor_bindings.end()) {
auto *tensor_desc = vku::FindStructInPNextChain<VkTensorDescriptionARM>(resource.pNext);
if (!tensor_desc) {
skip |= LogError("VUID-VkDataGraphPipelineResourceInfoARM-descriptorSet-09851", device, resource_loc,
"(descriptorSet %" PRIu32 ", binding %" PRIu32
") identifies a tensor or array of tensor resources, but the pNext chain doesn't include a "
"VkTensorDescriptionARM structure",
resource.descriptorSet, resource.binding);
} else if ((tensor_desc->usage & VK_TENSOR_USAGE_DATA_GRAPH_BIT_ARM) == 0) {
skip |=
LogError("VUID-VkDataGraphPipelineResourceInfoARM-descriptorSet-09851", device,
resource_loc.pNext(Struct::VkTensorDescriptionARM).dot(Field::usage),
"(%s) invalid for tensor resource with (descriptorSet %" PRIu32 ", binding %" PRIu32 ")",
string_VkTensorUsageFlagsARM(tensor_desc->usage).c_str(), resource.descriptorSet, resource.binding);
}
}
}
return skip;
}
|