Hash :
f8fc8ac3
Author :
Date :
2024-08-05T11:50:11
Vulkan: Remove dependency on ContextVk for CommandBufferHelper Following on the changes in [1], this makes the `CommandBufferHelperCommon` and `OutsideRenderPassCommandBufferHelper` interfaces independent of `ContextVk` state. Any dependency is made explicit. In addition, interfaces that are not specific to GLES context are also updated. [1]: Commit (bcf814fda5 Vulkan: Constrain the dependency on ContextVk in BufferHelper) Bug: angleproject:8544 Change-Id: I7d90ad915e8c14187ab5584453b9e8802bd91e2b Signed-off-by: Gowtham Tammana <g.tammana@samsung.com> Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/5319147 Reviewed-by: Charlie Lao <cclao@google.com> Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org> Commit-Queue: Shahbaz Youssefi <syoussefi@chromium.org>
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
//
// Copyright 2018 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// vk_cache_utils.h:
// Contains the classes for the Pipeline State Object cache as well as the RenderPass cache.
// Also contains the structures for the packed descriptions for the RenderPass and Pipeline.
//
#ifndef LIBANGLE_RENDERER_VULKAN_VK_CACHE_UTILS_H_
#define LIBANGLE_RENDERER_VULKAN_VK_CACHE_UTILS_H_
#include "common/Color.h"
#include "common/FixedVector.h"
#include "common/SimpleMutex.h"
#include "common/WorkerThread.h"
#include "libANGLE/Uniform.h"
#include "libANGLE/renderer/vulkan/ShaderInterfaceVariableInfoMap.h"
#include "libANGLE/renderer/vulkan/vk_resource.h"
#include "libANGLE/renderer/vulkan/vk_utils.h"
namespace gl
{
class ProgramExecutable;
} // namespace gl
namespace rx
{
class ShaderInterfaceVariableInfoMap;
class UpdateDescriptorSetsBuilder;
// Some descriptor set and pipeline layout constants.
//
// The set/binding assignment is done as following:
//
// - Set 0 contains uniform blocks created to encompass default uniforms. 1 binding is used per
// pipeline stage. Additionally, transform feedback buffers are bound from binding 2 and up.
// For internal shaders, set 0 is used for all the needed resources.
// - Set 1 contains all textures (including texture buffers).
// - Set 2 contains all other shader resources, such as uniform and storage blocks, atomic counter
// buffers, images and image buffers.
enum class DescriptorSetIndex : uint32_t
{
Internal = 0, // Internal shaders
UniformsAndXfb = Internal, // Uniforms set index
Texture = 1, // Textures set index
ShaderResource = 2, // Other shader resources set index
InvalidEnum = 3,
EnumCount = InvalidEnum,
};
namespace vk
{
class BufferHelper;
class DynamicDescriptorPool;
class SamplerHelper;
enum class ImageLayout;
class PipelineCacheAccess;
class RenderPassCommandBufferHelper;
class PackedClearValuesArray;
class AttachmentOpsArray;
using RefCountedDescriptorSetLayout = AtomicRefCounted<DescriptorSetLayout>;
using RefCountedPipelineLayout = AtomicRefCounted<PipelineLayout>;
using RefCountedSamplerYcbcrConversion = RefCounted<SamplerYcbcrConversion>;
// Packed Vk resource descriptions.
// Most Vk types use many more bits than required to represent the underlying data.
// Since ANGLE wants to cache things like RenderPasses and Pipeline State Objects using
// hashing (and also needs to check equality) we can optimize these operations by
// using fewer bits. Hence the packed types.
//
// One implementation note: these types could potentially be improved by using even
// fewer bits. For example, boolean values could be represented by a single bit instead
// of a uint8_t. However at the current time there are concerns about the portability
// of bitfield operators, and complexity issues with using bit mask operations. This is
// something we will likely want to investigate as the Vulkan implementation progresses.
//
// Second implementation note: the struct packing is also a bit fragile, and some of the
// packing requirements depend on using alignas and field ordering to get the result of
// packing nicely into the desired space. This is something we could also potentially fix
// with a redesign to use bitfields or bit mask operations.
// Enable struct padding warnings for the code below since it is used in caches.
ANGLE_ENABLE_STRUCT_PADDING_WARNINGS
enum class ResourceAccess
{
Unused = 0x0,
ReadOnly = 0x1,
WriteOnly = 0x2,
ReadWrite = ReadOnly | WriteOnly,
};
inline void UpdateAccess(ResourceAccess *oldAccess, ResourceAccess newAccess)
{
*oldAccess = static_cast<ResourceAccess>(ToUnderlying(newAccess) | ToUnderlying(*oldAccess));
}
inline bool HasResourceWriteAccess(ResourceAccess access)
{
return (ToUnderlying(access) & ToUnderlying(ResourceAccess::WriteOnly)) != 0;
}
enum class RenderPassLoadOp
{
Load = VK_ATTACHMENT_LOAD_OP_LOAD,
Clear = VK_ATTACHMENT_LOAD_OP_CLEAR,
DontCare = VK_ATTACHMENT_LOAD_OP_DONT_CARE,
None,
};
enum class RenderPassStoreOp
{
Store = VK_ATTACHMENT_STORE_OP_STORE,
DontCare = VK_ATTACHMENT_STORE_OP_DONT_CARE,
None,
};
// There can be a maximum of IMPLEMENTATION_MAX_DRAW_BUFFERS color and resolve attachments, plus -
// - one depth/stencil attachment
// - one depth/stencil resolve attachment
// - one fragment shading rate attachment
constexpr size_t kMaxFramebufferAttachments = gl::IMPLEMENTATION_MAX_DRAW_BUFFERS * 2 + 3;
template <typename T>
using FramebufferAttachmentArray = std::array<T, kMaxFramebufferAttachments>;
template <typename T>
using FramebufferAttachmentsVector = angle::FixedVector<T, kMaxFramebufferAttachments>;
using FramebufferAttachmentMask = angle::BitSet<kMaxFramebufferAttachments>;
constexpr size_t kMaxFramebufferNonResolveAttachments = gl::IMPLEMENTATION_MAX_DRAW_BUFFERS + 1;
template <typename T>
using FramebufferNonResolveAttachmentArray = std::array<T, kMaxFramebufferNonResolveAttachments>;
using FramebufferNonResolveAttachmentMask = angle::BitSet16<kMaxFramebufferNonResolveAttachments>;
class PackedAttachmentIndex;
class alignas(4) RenderPassDesc final
{
public:
RenderPassDesc();
~RenderPassDesc();
RenderPassDesc(const RenderPassDesc &other);
RenderPassDesc &operator=(const RenderPassDesc &other);
// Set format for an enabled GL color attachment.
void packColorAttachment(size_t colorIndexGL, angle::FormatID formatID);
// Mark a GL color attachment index as disabled.
void packColorAttachmentGap(size_t colorIndexGL);
// The caller must pack the depth/stencil attachment last, which is packed right after the color
// attachments (including gaps), i.e. with an index starting from |colorAttachmentRange()|.
void packDepthStencilAttachment(angle::FormatID angleFormatID);
void updateDepthStencilAccess(ResourceAccess access);
// Indicate that a color attachment should have a corresponding resolve attachment.
void packColorResolveAttachment(size_t colorIndexGL);
// Indicate that a YUV texture is attached to the resolve attachment.
void packYUVResolveAttachment(size_t colorIndexGL);
// Remove the resolve attachment. Used when optimizing blit through resolve attachment to
// temporarily pack a resolve attachment and then remove it.
void removeColorResolveAttachment(size_t colorIndexGL);
// Indicate that a color attachment should take its data from the resolve attachment initially.
void packColorUnresolveAttachment(size_t colorIndexGL);
void removeColorUnresolveAttachment(size_t colorIndexGL);
// Indicate that a depth/stencil attachment should have a corresponding resolve attachment.
void packDepthResolveAttachment();
void packStencilResolveAttachment();
// Indicate that a depth/stencil attachment should take its data from the resolve attachment
// initially.
void packDepthUnresolveAttachment();
void packStencilUnresolveAttachment();
void removeDepthStencilUnresolveAttachment();
PackedAttachmentIndex getPackedColorAttachmentIndex(size_t colorIndexGL);
void setWriteControlMode(gl::SrgbWriteControlMode mode);
size_t hash() const;
// Color attachments are in [0, colorAttachmentRange()), with possible gaps.
size_t colorAttachmentRange() const { return mColorAttachmentRange; }
size_t depthStencilAttachmentIndex() const { return colorAttachmentRange(); }
bool isColorAttachmentEnabled(size_t colorIndexGL) const;
bool hasYUVResolveAttachment() const { return mIsYUVResolve; }
bool hasDepthStencilAttachment() const;
gl::DrawBufferMask getColorResolveAttachmentMask() const { return mColorResolveAttachmentMask; }
bool hasColorResolveAttachment(size_t colorIndexGL) const
{
return mColorResolveAttachmentMask.test(colorIndexGL);
}
gl::DrawBufferMask getColorUnresolveAttachmentMask() const
{
return mColorUnresolveAttachmentMask;
}
bool hasColorUnresolveAttachment(size_t colorIndexGL) const
{
return mColorUnresolveAttachmentMask.test(colorIndexGL);
}
bool hasDepthStencilResolveAttachment() const { return mResolveDepth || mResolveStencil; }
bool hasDepthResolveAttachment() const { return mResolveDepth; }
bool hasStencilResolveAttachment() const { return mResolveStencil; }
bool hasDepthStencilUnresolveAttachment() const { return mUnresolveDepth || mUnresolveStencil; }
bool hasDepthUnresolveAttachment() const { return mUnresolveDepth; }
bool hasStencilUnresolveAttachment() const { return mUnresolveStencil; }
gl::SrgbWriteControlMode getSRGBWriteControlMode() const
{
return static_cast<gl::SrgbWriteControlMode>(mSrgbWriteControl);
}
bool isLegacyDitherEnabled() const { return mLegacyDitherEnabled; }
void setLegacyDither(bool enabled);
// Get the number of clearable attachments in the Vulkan render pass, i.e. after removing
// disabled color attachments.
size_t clearableAttachmentCount() const;
// Get the total number of attachments in the Vulkan render pass, i.e. after removing disabled
// color attachments.
size_t attachmentCount() const;
void setSamples(GLint samples) { mSamples = static_cast<uint8_t>(samples); }
uint8_t samples() const { return mSamples; }
void setViewCount(GLsizei viewCount) { mViewCount = static_cast<uint8_t>(viewCount); }
uint8_t viewCount() const { return mViewCount; }
void setFramebufferFetchMode(bool hasFramebufferFetch)
{
mHasFramebufferFetch = hasFramebufferFetch;
}
bool hasFramebufferFetch() const { return mHasFramebufferFetch; }
void updateRenderToTexture(bool isRenderToTexture) { mIsRenderToTexture = isRenderToTexture; }
bool isRenderToTexture() const { return mIsRenderToTexture; }
void setFragmentShadingAttachment(bool value) { mHasFragmentShadingAttachment = value; }
bool hasFragmentShadingAttachment() const { return mHasFragmentShadingAttachment; }
angle::FormatID operator[](size_t index) const
{
ASSERT(index < gl::IMPLEMENTATION_MAX_DRAW_BUFFERS + 1);
return static_cast<angle::FormatID>(mAttachmentFormats[index]);
}
// Start a render pass with a render pass object.
void beginRenderPass(Context *context,
PrimaryCommandBuffer *primary,
const RenderPass &renderPass,
VkFramebuffer framebuffer,
const gl::Rectangle &renderArea,
VkSubpassContents subpassContents,
PackedClearValuesArray &clearValues,
const VkRenderPassAttachmentBeginInfo *attachmentBeginInfo) const;
// Start a render pass with dynamic rendering.
void beginRendering(Context *context,
PrimaryCommandBuffer *primary,
const gl::Rectangle &renderArea,
VkSubpassContents subpassContents,
const FramebufferAttachmentsVector<VkImageView> &attachmentViews,
const AttachmentOpsArray &ops,
PackedClearValuesArray &clearValues,
uint32_t layerCount) const;
void populateRenderingInheritanceInfo(
Renderer *renderer,
VkCommandBufferInheritanceRenderingInfo *infoOut,
gl::DrawBuffersArray<VkFormat> *colorFormatStorageOut) const;
// Calculate perf counters for a dynamic rendering render pass instance. For render pass
// objects, the perf counters are updated when creating the render pass, where access to
// ContextVk is available.
void updatePerfCounters(Context *context,
const FramebufferAttachmentsVector<VkImageView> &attachmentViews,
const AttachmentOpsArray &ops,
angle::VulkanPerfCounters *countersOut);
private:
uint8_t mSamples;
uint8_t mColorAttachmentRange;
// Multiview
uint8_t mViewCount;
// sRGB
uint8_t mSrgbWriteControl : 1;
// Framebuffer fetch
uint8_t mHasFramebufferFetch : 1;
// Depth/stencil resolve
uint8_t mResolveDepth : 1;
uint8_t mResolveStencil : 1;
// Multisampled render to texture
uint8_t mIsRenderToTexture : 1;
uint8_t mUnresolveDepth : 1;
uint8_t mUnresolveStencil : 1;
// Dithering state when using VK_EXT_legacy_dithering
uint8_t mLegacyDitherEnabled : 1;
// external_format_resolve
uint8_t mIsYUVResolve : 1;
// Foveated rendering
uint8_t mHasFragmentShadingAttachment : 1;
// Available space for expansion.
uint8_t mPadding2 : 6;
// Whether each color attachment has a corresponding resolve attachment. Color resolve
// attachments can be used to optimize resolve through glBlitFramebuffer() as well as support
// GL_EXT_multisampled_render_to_texture and GL_EXT_multisampled_render_to_texture2.
gl::DrawBufferMask mColorResolveAttachmentMask;
// Whether each color attachment with a corresponding resolve attachment should be initialized
// with said resolve attachment in an initial subpass. This is an optimization to avoid
// loadOp=LOAD on the implicit multisampled image used with multisampled-render-to-texture
// render targets. This operation is referred to as "unresolve".
//
// Unused when VK_EXT_multisampled_render_to_single_sampled is available.
gl::DrawBufferMask mColorUnresolveAttachmentMask;
// Color attachment formats are stored with their GL attachment indices. The depth/stencil
// attachment formats follow the last enabled color attachment. When creating a render pass,
// the disabled attachments are removed and the resulting attachments are packed.
//
// The attachment indices provided as input to various functions in this file are thus GL
// attachment indices. These indices are marked as such, e.g. colorIndexGL. The render pass
// (and corresponding framebuffer object) lists the packed attachments, with the corresponding
// indices marked with Vk, e.g. colorIndexVk. The subpass attachment references create the
// link between the two index spaces. The subpass declares attachment references with GL
// indices (which corresponds to the location decoration of shader outputs). The attachment
// references then contain the Vulkan indices or VK_ATTACHMENT_UNUSED.
//
// For example, if GL uses color attachments 0 and 3, then there are two render pass
// attachments (indexed 0 and 1) and 4 subpass attachments:
//
// - Subpass attachment 0 -> Renderpass attachment 0
// - Subpass attachment 1 -> VK_ATTACHMENT_UNUSED
// - Subpass attachment 2 -> VK_ATTACHMENT_UNUSED
// - Subpass attachment 3 -> Renderpass attachment 1
//
// The resolve attachments are packed after the non-resolve attachments. They use the same
// formats, so they are not specified in this array.
FramebufferNonResolveAttachmentArray<uint8_t> mAttachmentFormats;
};
bool operator==(const RenderPassDesc &lhs, const RenderPassDesc &rhs);
constexpr size_t kRenderPassDescSize = sizeof(RenderPassDesc);
static_assert(kRenderPassDescSize == 16, "Size check failed");
enum class GraphicsPipelineSubset
{
Complete, // Including all subsets
VertexInput,
Shaders,
FragmentOutput,
};
enum class CacheLookUpFeedback
{
None,
Hit,
Miss,
LinkedDrawHit,
LinkedDrawMiss,
WarmUpHit,
WarmUpMiss,
UtilsHit,
UtilsMiss,
};
struct PackedAttachmentOpsDesc final
{
// RenderPassLoadOp is in range [0, 3], and RenderPassStoreOp is in range [0, 2].
uint16_t loadOp : 2;
uint16_t storeOp : 2;
uint16_t stencilLoadOp : 2;
uint16_t stencilStoreOp : 2;
// If a corresponding resolve attachment exists, storeOp may already be DONT_CARE, and it's
// unclear whether the attachment was invalidated or not. This information is passed along here
// so that the resolve attachment's storeOp can be set to DONT_CARE if the attachment is
// invalidated, and if possible removed from the list of resolve attachments altogether. Note
// that the latter may not be possible if the render pass has multiple subpasses due to Vulkan
// render pass compatibility rules (not an issue with dynamic rendering).
uint16_t isInvalidated : 1;
uint16_t isStencilInvalidated : 1;
uint16_t padding1 : 6;
// Layouts take values from ImageLayout, so they are small. Layouts that are possible here are
// placed at the beginning of that enum.
uint16_t initialLayout : 5;
uint16_t finalLayout : 5;
uint16_t finalResolveLayout : 5;
uint16_t padding2 : 1;
};
static_assert(sizeof(PackedAttachmentOpsDesc) == 4, "Size check failed");
class AttachmentOpsArray final
{
public:
AttachmentOpsArray();
~AttachmentOpsArray();
AttachmentOpsArray(const AttachmentOpsArray &other);
AttachmentOpsArray &operator=(const AttachmentOpsArray &other);
const PackedAttachmentOpsDesc &operator[](PackedAttachmentIndex index) const;
PackedAttachmentOpsDesc &operator[](PackedAttachmentIndex index);
// Initialize an attachment op with all load and store operations.
void initWithLoadStore(PackedAttachmentIndex index,
ImageLayout initialLayout,
ImageLayout finalLayout);
void setLayouts(PackedAttachmentIndex index,
ImageLayout initialLayout,
ImageLayout finalLayout);
void setOps(PackedAttachmentIndex index, RenderPassLoadOp loadOp, RenderPassStoreOp storeOp);
void setStencilOps(PackedAttachmentIndex index,
RenderPassLoadOp loadOp,
RenderPassStoreOp storeOp);
void setClearOp(PackedAttachmentIndex index);
void setClearStencilOp(PackedAttachmentIndex index);
size_t hash() const;
private:
gl::AttachmentArray<PackedAttachmentOpsDesc> mOps;
};
bool operator==(const AttachmentOpsArray &lhs, const AttachmentOpsArray &rhs);
static_assert(sizeof(AttachmentOpsArray) == 40, "Size check failed");
struct PackedAttribDesc final
{
uint8_t format;
uint8_t divisor;
// Desktop drivers support
uint16_t offset : kAttributeOffsetMaxBits;
uint16_t compressed : 1;
};
constexpr size_t kPackedAttribDescSize = sizeof(PackedAttribDesc);
static_assert(kPackedAttribDescSize == 4, "Size mismatch");
struct PackedVertexInputAttributes final
{
PackedAttribDesc attribs[gl::MAX_VERTEX_ATTRIBS];
// Component type of the corresponding input in the program. Used to adjust the format if
// necessary. Takes values from gl::ComponentType.
uint32_t shaderAttribComponentType;
// Although technically stride can be any value in ES 2.0, in practice supporting stride
// greater than MAX_USHORT should not be that helpful. Note that stride limits are
// introduced in ES 3.1.
// Dynamic in VK_EXT_extended_dynamic_state
uint16_t strides[gl::MAX_VERTEX_ATTRIBS];
};
constexpr size_t kPackedVertexInputAttributesSize = sizeof(PackedVertexInputAttributes);
static_assert(kPackedVertexInputAttributesSize == 100, "Size mismatch");
struct PackedInputAssemblyState final
{
struct
{
uint32_t topology : 4;
// Dynamic in VK_EXT_extended_dynamic_state2
uint32_t primitiveRestartEnable : 1; // ds2
// Whether dynamic state for vertex stride from VK_EXT_extended_dynamic_state can be used
// for. Used by GraphicsPipelineDesc::hash() to exclude |vertexStrides| from the hash
uint32_t useVertexInputBindingStrideDynamicState : 1;
// Whether dynamic state for vertex input state from VK_EXT_vertex_input_dynamic_state can
// be used by GraphicsPipelineDesc::hash() to exclude |PackedVertexInputAttributes| from the
// hash
uint32_t useVertexInputDynamicState : 1;
// Whether the pipeline is robust (vertex input copy)
uint32_t isRobustContext : 1;
// Whether the pipeline needs access to protected content (vertex input copy)
uint32_t isProtectedContext : 1;
// Which attributes are actually active in the program and should affect the pipeline.
uint32_t programActiveAttributeLocations : gl::MAX_VERTEX_ATTRIBS;
uint32_t padding : 23 - gl::MAX_VERTEX_ATTRIBS;
} bits;
};
constexpr size_t kPackedInputAssemblyStateSize = sizeof(PackedInputAssemblyState);
static_assert(kPackedInputAssemblyStateSize == 4, "Size mismatch");
struct PackedStencilOpState final
{
uint8_t fail : 4;
uint8_t pass : 4;
uint8_t depthFail : 4;
uint8_t compare : 4;
};
constexpr size_t kPackedStencilOpSize = sizeof(PackedStencilOpState);
static_assert(kPackedStencilOpSize == 2, "Size check failed");
struct PackedPreRasterizationAndFragmentStates final
{
struct
{
// Affecting VkPipelineViewportStateCreateInfo
uint32_t viewportNegativeOneToOne : 1;
// Affecting VkPipelineRasterizationStateCreateInfo
uint32_t depthClampEnable : 1;
uint32_t polygonMode : 2;
// Dynamic in VK_EXT_extended_dynamic_state
uint32_t cullMode : 4;
uint32_t frontFace : 4;
// Dynamic in VK_EXT_extended_dynamic_state2
uint32_t rasterizerDiscardEnable : 1;
uint32_t depthBiasEnable : 1;
// Affecting VkPipelineTessellationStateCreateInfo
uint32_t patchVertices : 6;
// Affecting VkPipelineDepthStencilStateCreateInfo
uint32_t depthBoundsTest : 1;
// Dynamic in VK_EXT_extended_dynamic_state
uint32_t depthTest : 1;
uint32_t depthWrite : 1;
uint32_t stencilTest : 1;
uint32_t nonZeroStencilWriteMaskWorkaround : 1;
// Dynamic in VK_EXT_extended_dynamic_state2
uint32_t depthCompareOp : 4;
// Affecting specialization constants
uint32_t surfaceRotation : 1;
// Whether the pipeline is robust (shader stages copy)
uint32_t isRobustContext : 1;
// Whether the pipeline needs access to protected content (shader stages copy)
uint32_t isProtectedContext : 1;
} bits;
// Affecting specialization constants
static_assert(gl::IMPLEMENTATION_MAX_DRAW_BUFFERS <= 8,
"2 bits per draw buffer is needed for dither emulation");
uint16_t emulatedDitherControl;
uint16_t padding;
// Affecting VkPipelineDepthStencilStateCreateInfo
// Dynamic in VK_EXT_extended_dynamic_state
PackedStencilOpState front;
PackedStencilOpState back;
};
constexpr size_t kPackedPreRasterizationAndFragmentStatesSize =
sizeof(PackedPreRasterizationAndFragmentStates);
static_assert(kPackedPreRasterizationAndFragmentStatesSize == 12, "Size check failed");
struct PackedMultisampleAndSubpassState final
{
struct
{
// Affecting VkPipelineMultisampleStateCreateInfo
// Note: Only up to 16xMSAA is supported in the Vulkan backend.
uint16_t sampleMask;
// Stored as minus one so sample count 16 can fit in 4 bits.
uint16_t rasterizationSamplesMinusOne : 4;
uint16_t sampleShadingEnable : 1;
uint16_t alphaToCoverageEnable : 1;
uint16_t alphaToOneEnable : 1;
// The subpass index affects both the shader stages and the fragment output similarly to
// multisampled state, so they are grouped together.
// Note: Currently only 2 subpasses possible.
uint16_t subpass : 1;
// 8-bit normalized instead of float to align the struct.
uint16_t minSampleShading : 8;
} bits;
};
constexpr size_t kPackedMultisampleAndSubpassStateSize = sizeof(PackedMultisampleAndSubpassState);
static_assert(kPackedMultisampleAndSubpassStateSize == 4, "Size check failed");
struct PackedColorBlendAttachmentState final
{
uint16_t srcColorBlendFactor : 5;
uint16_t dstColorBlendFactor : 5;
uint16_t colorBlendOp : 6;
uint16_t srcAlphaBlendFactor : 5;
uint16_t dstAlphaBlendFactor : 5;
uint16_t alphaBlendOp : 6;
};
constexpr size_t kPackedColorBlendAttachmentStateSize = sizeof(PackedColorBlendAttachmentState);
static_assert(kPackedColorBlendAttachmentStateSize == 4, "Size check failed");
struct PackedColorBlendState final
{
uint8_t colorWriteMaskBits[gl::IMPLEMENTATION_MAX_DRAW_BUFFERS / 2];
PackedColorBlendAttachmentState attachments[gl::IMPLEMENTATION_MAX_DRAW_BUFFERS];
};
constexpr size_t kPackedColorBlendStateSize = sizeof(PackedColorBlendState);
static_assert(kPackedColorBlendStateSize == 36, "Size check failed");
struct PackedBlendMaskAndLogicOpState final
{
struct
{
uint32_t blendEnableMask : 8;
uint32_t logicOpEnable : 1;
// Dynamic in VK_EXT_extended_dynamic_state2
uint32_t logicOp : 4;
// Whether the pipeline needs access to protected content (fragment output copy)
uint32_t isProtectedContext : 1;
// Output that is present in the framebuffer but is never written to in the shader. Used by
// GL_ANGLE_robust_fragment_shader_output which defines the behavior in this case (which is
// to mask these outputs)
uint32_t missingOutputsMask : gl::IMPLEMENTATION_MAX_DRAW_BUFFERS;
uint32_t padding : 18 - gl::IMPLEMENTATION_MAX_DRAW_BUFFERS;
} bits;
};
constexpr size_t kPackedBlendMaskAndLogicOpStateSize = sizeof(PackedBlendMaskAndLogicOpState);
static_assert(kPackedBlendMaskAndLogicOpStateSize == 4, "Size check failed");
// The vertex input subset of the pipeline.
struct PipelineVertexInputState final
{
PackedInputAssemblyState inputAssembly;
PackedVertexInputAttributes vertex;
};
// The pre-rasterization and fragment shader subsets of the pipeline. This is excluding
// multisampled and render pass states which are shared with fragment output.
struct PipelineShadersState final
{
PackedPreRasterizationAndFragmentStates shaders;
};
// Multisampled and render pass states.
struct PipelineSharedNonVertexInputState final
{
PackedMultisampleAndSubpassState multisample;
RenderPassDesc renderPass;
};
// The fragment output subset of the pipeline. This is excluding multisampled and render pass
// states which are shared with the shader subsets.
struct PipelineFragmentOutputState final
{
PackedColorBlendState blend;
PackedBlendMaskAndLogicOpState blendMaskAndLogic;
};
constexpr size_t kGraphicsPipelineVertexInputStateSize =
kPackedVertexInputAttributesSize + kPackedInputAssemblyStateSize;
constexpr size_t kGraphicsPipelineShadersStateSize = kPackedPreRasterizationAndFragmentStatesSize;
constexpr size_t kGraphicsPipelineSharedNonVertexInputStateSize =
kPackedMultisampleAndSubpassStateSize + kRenderPassDescSize;
constexpr size_t kGraphicsPipelineFragmentOutputStateSize =
kPackedColorBlendStateSize + kPackedBlendMaskAndLogicOpStateSize;
constexpr size_t kGraphicsPipelineDescSumOfSizes =
kGraphicsPipelineVertexInputStateSize + kGraphicsPipelineShadersStateSize +
kGraphicsPipelineSharedNonVertexInputStateSize + kGraphicsPipelineFragmentOutputStateSize;
// Number of dirty bits in the dirty bit set.
constexpr size_t kGraphicsPipelineDirtyBitBytes = 4;
constexpr static size_t kNumGraphicsPipelineDirtyBits =
kGraphicsPipelineDescSumOfSizes / kGraphicsPipelineDirtyBitBytes;
static_assert(kNumGraphicsPipelineDirtyBits <= 64, "Too many pipeline dirty bits");
// Set of dirty bits. Each bit represents kGraphicsPipelineDirtyBitBytes in the desc.
using GraphicsPipelineTransitionBits = angle::BitSet<kNumGraphicsPipelineDirtyBits>;
GraphicsPipelineTransitionBits GetGraphicsPipelineTransitionBitsMask(GraphicsPipelineSubset subset);
// Disable padding warnings for a few helper structs that aggregate Vulkan state objects. These are
// not used as hash keys, they just simplify passing them around to functions.
ANGLE_DISABLE_STRUCT_PADDING_WARNINGS
struct GraphicsPipelineVertexInputVulkanStructs
{
VkPipelineVertexInputStateCreateInfo vertexInputState = {};
VkPipelineInputAssemblyStateCreateInfo inputAssemblyState = {};
VkPipelineVertexInputDivisorStateCreateInfoEXT divisorState = {};
// Support storage
gl::AttribArray<VkVertexInputBindingDescription> bindingDescs;
gl::AttribArray<VkVertexInputAttributeDescription> attributeDescs;
gl::AttribArray<VkVertexInputBindingDivisorDescriptionEXT> divisorDesc;
};
struct GraphicsPipelineShadersVulkanStructs
{
VkPipelineViewportStateCreateInfo viewportState = {};
VkPipelineRasterizationStateCreateInfo rasterState = {};
VkPipelineDepthStencilStateCreateInfo depthStencilState = {};
VkPipelineTessellationStateCreateInfo tessellationState = {};
VkPipelineTessellationDomainOriginStateCreateInfo domainOriginState = {};
VkPipelineViewportDepthClipControlCreateInfoEXT depthClipControl = {};
VkPipelineRasterizationLineStateCreateInfoEXT rasterLineState = {};
VkPipelineRasterizationProvokingVertexStateCreateInfoEXT provokingVertexState = {};
VkPipelineRasterizationStateStreamCreateInfoEXT rasterStreamState = {};
VkSpecializationInfo specializationInfo = {};
// Support storage
angle::FixedVector<VkPipelineShaderStageCreateInfo, 5> shaderStages;
SpecializationConstantMap<VkSpecializationMapEntry> specializationEntries;
};
struct GraphicsPipelineSharedNonVertexInputVulkanStructs
{
VkPipelineMultisampleStateCreateInfo multisampleState = {};
// Support storage
uint32_t sampleMask;
};
struct GraphicsPipelineFragmentOutputVulkanStructs
{
VkPipelineColorBlendStateCreateInfo blendState = {};
// Support storage
gl::DrawBuffersArray<VkPipelineColorBlendAttachmentState> blendAttachmentState;
};
ANGLE_ENABLE_STRUCT_PADDING_WARNINGS
using GraphicsPipelineDynamicStateList = angle::FixedVector<VkDynamicState, 23>;
enum class PipelineRobustness
{
NonRobust,
Robust,
};
enum class PipelineProtectedAccess
{
Unprotected,
Protected,
};
// State changes are applied through the update methods. Each update method can also have a
// sibling method that applies the update without marking a state transition. The non-transition
// update methods are used for internal shader pipelines. Not every non-transition update method
// is implemented yet as not every state is used in internal shaders.
class GraphicsPipelineDesc final
{
public:
// Use aligned allocation and free so we can use the alignas keyword.
void *operator new(std::size_t size);
void operator delete(void *ptr);
GraphicsPipelineDesc();
~GraphicsPipelineDesc();
GraphicsPipelineDesc(const GraphicsPipelineDesc &other);
GraphicsPipelineDesc &operator=(const GraphicsPipelineDesc &other);
size_t hash(GraphicsPipelineSubset subset) const;
bool keyEqual(const GraphicsPipelineDesc &other, GraphicsPipelineSubset subset) const;
void initDefaults(const Context *context,
GraphicsPipelineSubset subset,
PipelineRobustness contextRobustness,
PipelineProtectedAccess contextProtectedAccess);
// For custom comparisons.
template <typename T>
const T *getPtr() const
{
return reinterpret_cast<const T *>(this);
}
VkResult initializePipeline(Context *context,
PipelineCacheAccess *pipelineCache,
GraphicsPipelineSubset subset,
const RenderPass &compatibleRenderPass,
const PipelineLayout &pipelineLayout,
const ShaderModuleMap &shaders,
const SpecializationConstants &specConsts,
Pipeline *pipelineOut,
CacheLookUpFeedback *feedbackOut) const;
// Vertex input state. For ES 3.1 this should be separated into binding and attribute.
void updateVertexInput(ContextVk *contextVk,
GraphicsPipelineTransitionBits *transition,
uint32_t attribIndex,
GLuint stride,
GLuint divisor,
angle::FormatID format,
bool compressed,
GLuint relativeOffset);
void setVertexShaderComponentTypes(gl::AttributesMask activeAttribLocations,
gl::ComponentTypeMask componentTypeMask);
void updateVertexShaderComponentTypes(GraphicsPipelineTransitionBits *transition,
gl::AttributesMask activeAttribLocations,
gl::ComponentTypeMask componentTypeMask);
// Input assembly info
void setTopology(gl::PrimitiveMode drawMode);
void updateTopology(GraphicsPipelineTransitionBits *transition, gl::PrimitiveMode drawMode);
void updatePrimitiveRestartEnabled(GraphicsPipelineTransitionBits *transition,
bool primitiveRestartEnabled);
// Viewport states
void updateDepthClipControl(GraphicsPipelineTransitionBits *transition, bool negativeOneToOne);
// Raster states
void updatePolygonMode(GraphicsPipelineTransitionBits *transition, gl::PolygonMode polygonMode);
void updateCullMode(GraphicsPipelineTransitionBits *transition,
const gl::RasterizerState &rasterState);
void updateFrontFace(GraphicsPipelineTransitionBits *transition,
const gl::RasterizerState &rasterState,
bool invertFrontFace);
void updateRasterizerDiscardEnabled(GraphicsPipelineTransitionBits *transition,
bool rasterizerDiscardEnabled);
// Multisample states
uint32_t getRasterizationSamples() const;
void setRasterizationSamples(uint32_t rasterizationSamples);
void updateRasterizationSamples(GraphicsPipelineTransitionBits *transition,
uint32_t rasterizationSamples);
void updateAlphaToCoverageEnable(GraphicsPipelineTransitionBits *transition, bool enable);
void updateAlphaToOneEnable(GraphicsPipelineTransitionBits *transition, bool enable);
void updateSampleMask(GraphicsPipelineTransitionBits *transition,
uint32_t maskNumber,
uint32_t mask);
void updateSampleShading(GraphicsPipelineTransitionBits *transition, bool enable, float value);
// RenderPass description.
const RenderPassDesc &getRenderPassDesc() const { return mSharedNonVertexInput.renderPass; }
void setRenderPassDesc(const RenderPassDesc &renderPassDesc);
void updateRenderPassDesc(GraphicsPipelineTransitionBits *transition,
const RenderPassDesc &renderPassDesc);
void setRenderPassSampleCount(GLint samples);
void setRenderPassFramebufferFetchMode(bool hasFramebufferFetch);
bool getRenderPassFramebufferFetchMode() const
{
return mSharedNonVertexInput.renderPass.hasFramebufferFetch();
}
void setRenderPassFoveation(bool isFoveated);
bool getRenderPassFoveation() const
{
return mSharedNonVertexInput.renderPass.hasFragmentShadingAttachment();
}
void setRenderPassColorAttachmentFormat(size_t colorIndexGL, angle::FormatID formatID);
// Blend states
void setSingleBlend(uint32_t colorIndexGL,
bool enabled,
VkBlendOp op,
VkBlendFactor srcFactor,
VkBlendFactor dstFactor);
void updateBlendEnabled(GraphicsPipelineTransitionBits *transition,
gl::DrawBufferMask blendEnabledMask);
void updateBlendFuncs(GraphicsPipelineTransitionBits *transition,
const gl::BlendStateExt &blendStateExt,
gl::DrawBufferMask attachmentMask);
void updateBlendEquations(GraphicsPipelineTransitionBits *transition,
const gl::BlendStateExt &blendStateExt,
gl::DrawBufferMask attachmentMask);
void resetBlendFuncsAndEquations(GraphicsPipelineTransitionBits *transition,
const gl::BlendStateExt &blendStateExt,
gl::DrawBufferMask previousAttachmentsMask,
gl::DrawBufferMask newAttachmentsMask);
void setColorWriteMasks(gl::BlendStateExt::ColorMaskStorage::Type colorMasks,
const gl::DrawBufferMask &alphaMask,
const gl::DrawBufferMask &enabledDrawBuffers);
void setSingleColorWriteMask(uint32_t colorIndexGL, VkColorComponentFlags colorComponentFlags);
void updateColorWriteMasks(GraphicsPipelineTransitionBits *transition,
gl::BlendStateExt::ColorMaskStorage::Type colorMasks,
const gl::DrawBufferMask &alphaMask,
const gl::DrawBufferMask &enabledDrawBuffers);
void updateMissingOutputsMask(GraphicsPipelineTransitionBits *transition,
gl::DrawBufferMask missingOutputsMask);
// Logic op
void updateLogicOpEnabled(GraphicsPipelineTransitionBits *transition, bool enable);
void updateLogicOp(GraphicsPipelineTransitionBits *transition, VkLogicOp logicOp);
// Depth/stencil states.
void setDepthTestEnabled(bool enabled);
void setDepthWriteEnabled(bool enabled);
void setDepthFunc(VkCompareOp op);
void setDepthClampEnabled(bool enabled);
void setStencilTestEnabled(bool enabled);
void setStencilFrontFuncs(VkCompareOp compareOp);
void setStencilBackFuncs(VkCompareOp compareOp);
void setStencilFrontOps(VkStencilOp failOp, VkStencilOp passOp, VkStencilOp depthFailOp);
void setStencilBackOps(VkStencilOp failOp, VkStencilOp passOp, VkStencilOp depthFailOp);
void setStencilFrontWriteMask(uint8_t mask);
void setStencilBackWriteMask(uint8_t mask);
void updateDepthTestEnabled(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState,
const gl::Framebuffer *drawFramebuffer);
void updateDepthFunc(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState);
void updateDepthClampEnabled(GraphicsPipelineTransitionBits *transition, bool enabled);
void updateDepthWriteEnabled(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState,
const gl::Framebuffer *drawFramebuffer);
void updateStencilTestEnabled(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState,
const gl::Framebuffer *drawFramebuffer);
void updateStencilFrontFuncs(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState);
void updateStencilBackFuncs(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState);
void updateStencilFrontOps(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState);
void updateStencilBackOps(GraphicsPipelineTransitionBits *transition,
const gl::DepthStencilState &depthStencilState);
// Depth offset.
void updatePolygonOffsetEnabled(GraphicsPipelineTransitionBits *transition, bool enabled);
// Tessellation
void updatePatchVertices(GraphicsPipelineTransitionBits *transition, GLuint value);
// Subpass
void resetSubpass(GraphicsPipelineTransitionBits *transition);
void nextSubpass(GraphicsPipelineTransitionBits *transition);
void setSubpass(uint32_t subpass);
uint32_t getSubpass() const;
void updateSurfaceRotation(GraphicsPipelineTransitionBits *transition,
bool isRotatedAspectRatio);
bool getSurfaceRotation() const { return mShaders.shaders.bits.surfaceRotation; }
void updateEmulatedDitherControl(GraphicsPipelineTransitionBits *transition, uint16_t value);
uint32_t getEmulatedDitherControl() const { return mShaders.shaders.emulatedDitherControl; }
bool isLegacyDitherEnabled() const
{
return mSharedNonVertexInput.renderPass.isLegacyDitherEnabled();
}
void updateNonZeroStencilWriteMaskWorkaround(GraphicsPipelineTransitionBits *transition,
bool enabled);
void setSupportsDynamicStateForTest(bool supports)
{
mVertexInput.inputAssembly.bits.useVertexInputBindingStrideDynamicState = supports;
mShaders.shaders.bits.nonZeroStencilWriteMaskWorkaround = false;
}
static VkFormat getPipelineVertexInputStateFormat(Context *context,
angle::FormatID formatID,
bool compressed,
const gl::ComponentType programAttribType,
uint32_t attribIndex);
// Helpers to dump the state
const PipelineVertexInputState &getVertexInputStateForLog() const { return mVertexInput; }
const PipelineShadersState &getShadersStateForLog() const { return mShaders; }
const PipelineSharedNonVertexInputState &getSharedNonVertexInputStateForLog() const
{
return mSharedNonVertexInput;
}
const PipelineFragmentOutputState &getFragmentOutputStateForLog() const
{
return mFragmentOutput;
}
private:
void updateSubpass(GraphicsPipelineTransitionBits *transition, uint32_t subpass);
const void *getPipelineSubsetMemory(GraphicsPipelineSubset subset, size_t *sizeOut) const;
void initializePipelineVertexInputState(
Context *context,
GraphicsPipelineVertexInputVulkanStructs *stateOut,
GraphicsPipelineDynamicStateList *dynamicStateListOut) const;
void initializePipelineShadersState(
Context *context,
const ShaderModuleMap &shaders,
const SpecializationConstants &specConsts,
GraphicsPipelineShadersVulkanStructs *stateOut,
GraphicsPipelineDynamicStateList *dynamicStateListOut) const;
void initializePipelineSharedNonVertexInputState(
Context *context,
GraphicsPipelineSharedNonVertexInputVulkanStructs *stateOut,
GraphicsPipelineDynamicStateList *dynamicStateListOut) const;
void initializePipelineFragmentOutputState(
Context *context,
GraphicsPipelineFragmentOutputVulkanStructs *stateOut,
GraphicsPipelineDynamicStateList *dynamicStateListOut) const;
PipelineShadersState mShaders;
PipelineSharedNonVertexInputState mSharedNonVertexInput;
PipelineFragmentOutputState mFragmentOutput;
PipelineVertexInputState mVertexInput;
};
// Verify the packed pipeline description has no gaps in the packing.
// This is not guaranteed by the spec, but is validated by a compile-time check.
// No gaps or padding at the end ensures that hashing and memcmp checks will not run
// into uninitialized memory regions.
constexpr size_t kGraphicsPipelineDescSize = sizeof(GraphicsPipelineDesc);
static_assert(kGraphicsPipelineDescSize == kGraphicsPipelineDescSumOfSizes, "Size mismatch");
// Values are based on data recorded here -> https://anglebug.com/42267114#comment5
constexpr size_t kDefaultDescriptorSetLayoutBindingsCount = 8;
constexpr size_t kDefaultImmutableSamplerBindingsCount = 1;
using DescriptorSetLayoutBindingVector =
angle::FastVector<VkDescriptorSetLayoutBinding, kDefaultDescriptorSetLayoutBindingsCount>;
// A packed description of a descriptor set layout. Use similarly to RenderPassDesc and
// GraphicsPipelineDesc. Currently we only need to differentiate layouts based on sampler and ubo
// usage. In the future we could generalize this.
class DescriptorSetLayoutDesc final
{
public:
DescriptorSetLayoutDesc();
~DescriptorSetLayoutDesc();
DescriptorSetLayoutDesc(const DescriptorSetLayoutDesc &other);
DescriptorSetLayoutDesc &operator=(const DescriptorSetLayoutDesc &other);
size_t hash() const;
bool operator==(const DescriptorSetLayoutDesc &other) const;
void addBinding(uint32_t bindingIndex,
VkDescriptorType descriptorType,
uint32_t count,
VkShaderStageFlags stages,
const Sampler *immutableSampler);
void unpackBindings(DescriptorSetLayoutBindingVector *bindings) const;
bool empty() const { return mDescriptorSetLayoutBindings.empty(); }
private:
// There is a small risk of an issue if the sampler cache is evicted but not the descriptor
// cache we would have an invalid handle here. Thus propose follow-up work:
// TODO: https://issuetracker.google.com/issues/159156775: Have immutable sampler use serial
union PackedDescriptorSetBinding
{
static constexpr uint8_t kInvalidType = 255;
struct
{
uint8_t type; // Stores a packed VkDescriptorType descriptorType.
uint8_t stages; // Stores a packed VkShaderStageFlags.
uint16_t count : 15; // Stores a packed uint32_t descriptorCount
uint16_t hasImmutableSampler : 1; // Whether this binding has an immutable sampler
};
uint32_t value;
bool operator==(const PackedDescriptorSetBinding &other) const
{
return value == other.value;
}
};
// 1x 32bit
static_assert(sizeof(PackedDescriptorSetBinding) == 4, "Unexpected size");
angle::FastVector<VkSampler, kDefaultImmutableSamplerBindingsCount> mImmutableSamplers;
angle::FastVector<PackedDescriptorSetBinding, kDefaultDescriptorSetLayoutBindingsCount>
mDescriptorSetLayoutBindings;
#if !defined(ANGLE_IS_64_BIT_CPU)
ANGLE_MAYBE_UNUSED_PRIVATE_FIELD uint32_t mPadding = 0;
#endif
};
// The following are for caching descriptor set layouts. Limited to max three descriptor set
// layouts. This can be extended in the future.
constexpr size_t kMaxDescriptorSetLayouts = ToUnderlying(DescriptorSetIndex::EnumCount);
union PackedPushConstantRange
{
struct
{
uint8_t offset;
uint8_t size;
uint16_t stageMask;
};
uint32_t value;
bool operator==(const PackedPushConstantRange &other) const { return value == other.value; }
};
static_assert(sizeof(PackedPushConstantRange) == sizeof(uint32_t), "Unexpected Size");
template <typename T>
using DescriptorSetArray = angle::PackedEnumMap<DescriptorSetIndex, T>;
using DescriptorSetLayoutPointerArray =
DescriptorSetArray<AtomicBindingPointer<DescriptorSetLayout>>;
class PipelineLayoutDesc final
{
public:
PipelineLayoutDesc();
~PipelineLayoutDesc();
PipelineLayoutDesc(const PipelineLayoutDesc &other);
PipelineLayoutDesc &operator=(const PipelineLayoutDesc &rhs);
size_t hash() const;
bool operator==(const PipelineLayoutDesc &other) const;
void updateDescriptorSetLayout(DescriptorSetIndex setIndex,
const DescriptorSetLayoutDesc &desc);
void updatePushConstantRange(VkShaderStageFlags stageMask, uint32_t offset, uint32_t size);
const PackedPushConstantRange &getPushConstantRange() const { return mPushConstantRange; }
private:
DescriptorSetArray<DescriptorSetLayoutDesc> mDescriptorSetLayouts;
PackedPushConstantRange mPushConstantRange;
ANGLE_MAYBE_UNUSED_PRIVATE_FIELD uint32_t mPadding;
// Verify the arrays are properly packed.
static_assert(sizeof(decltype(mDescriptorSetLayouts)) ==
(sizeof(DescriptorSetLayoutDesc) * kMaxDescriptorSetLayouts),
"Unexpected size");
};
// Verify the structure is properly packed.
static_assert(sizeof(PipelineLayoutDesc) == sizeof(DescriptorSetArray<DescriptorSetLayoutDesc>) +
sizeof(PackedPushConstantRange) + sizeof(uint32_t),
"Unexpected Size");
enum class YcbcrLinearFilterSupport
{
Unsupported,
Supported,
};
class YcbcrConversionDesc final
{
public:
YcbcrConversionDesc();
~YcbcrConversionDesc();
YcbcrConversionDesc(const YcbcrConversionDesc &other);
YcbcrConversionDesc &operator=(const YcbcrConversionDesc &other);
size_t hash() const;
bool operator==(const YcbcrConversionDesc &other) const;
bool valid() const { return mExternalOrVkFormat != 0; }
void reset();
void update(Renderer *renderer,
uint64_t externalFormat,
VkSamplerYcbcrModelConversion conversionModel,
VkSamplerYcbcrRange colorRange,
VkChromaLocation xChromaOffset,
VkChromaLocation yChromaOffset,
VkFilter chromaFilter,
VkComponentMapping components,
angle::FormatID intendedFormatID,
YcbcrLinearFilterSupport linearFilterSupported);
VkFilter getChromaFilter() const { return static_cast<VkFilter>(mChromaFilter); }
bool updateChromaFilter(Renderer *renderer, VkFilter filter);
void updateConversionModel(VkSamplerYcbcrModelConversion conversionModel);
uint64_t getExternalFormat() const { return mIsExternalFormat ? mExternalOrVkFormat : 0; }
angle::Result init(Context *context, SamplerYcbcrConversion *conversionOut) const;
private:
// If the sampler needs to convert the image content (e.g. from YUV to RGB) then
// mExternalOrVkFormat will be non-zero. The value is either the external format
// as returned by vkGetAndroidHardwareBufferPropertiesANDROID or a YUV VkFormat.
// For VkSamplerYcbcrConversion, mExternalOrVkFormat along with mIsExternalFormat,
// mConversionModel and mColorRange works as a Serial() used elsewhere in ANGLE.
uint64_t mExternalOrVkFormat;
// 1 bit to identify if external format is used
uint32_t mIsExternalFormat : 1;
// 3 bits to identify conversion model
uint32_t mConversionModel : 3;
// 1 bit to identify color component range
uint32_t mColorRange : 1;
// 1 bit to identify x chroma location
uint32_t mXChromaOffset : 1;
// 1 bit to identify y chroma location
uint32_t mYChromaOffset : 1;
// 1 bit to identify chroma filtering
uint32_t mChromaFilter : 1;
// 3 bit to identify R component swizzle
uint32_t mRSwizzle : 3;
// 3 bit to identify G component swizzle
uint32_t mGSwizzle : 3;
// 3 bit to identify B component swizzle
uint32_t mBSwizzle : 3;
// 3 bit to identify A component swizzle
uint32_t mASwizzle : 3;
// 1 bit for whether linear filtering is supported (independent of whether currently enabled)
uint32_t mLinearFilterSupported : 1;
uint32_t mPadding : 11;
uint32_t mReserved;
};
static_assert(sizeof(YcbcrConversionDesc) == 16, "Unexpected YcbcrConversionDesc size");
// Packed sampler description for the sampler cache.
class SamplerDesc final
{
public:
SamplerDesc();
SamplerDesc(ContextVk *contextVk,
const gl::SamplerState &samplerState,
bool stencilMode,
const YcbcrConversionDesc *ycbcrConversionDesc,
angle::FormatID intendedFormatID);
~SamplerDesc();
SamplerDesc(const SamplerDesc &other);
SamplerDesc &operator=(const SamplerDesc &rhs);
void update(ContextVk *contextVk,
const gl::SamplerState &samplerState,
bool stencilMode,
const YcbcrConversionDesc *ycbcrConversionDesc,
angle::FormatID intendedFormatID);
void reset();
angle::Result init(ContextVk *contextVk, Sampler *sampler) const;
size_t hash() const;
bool operator==(const SamplerDesc &other) const;
private:
// 32*4 bits for floating point data.
// Note: anisotropy enabled is implicitly determined by maxAnisotropy and caps.
float mMipLodBias;
float mMaxAnisotropy;
float mMinLod;
float mMaxLod;
// 16*8 bits to uniquely identify a YCbCr conversion sampler.
YcbcrConversionDesc mYcbcrConversionDesc;
// 16 bits for modes + states.
// 1 bit per filter (only 2 possible values in GL: linear/nearest)
uint16_t mMagFilter : 1;
uint16_t mMinFilter : 1;
uint16_t mMipmapMode : 1;
// 3 bits per address mode (5 possible values)
uint16_t mAddressModeU : 3;
uint16_t mAddressModeV : 3;
uint16_t mAddressModeW : 3;
// 1 bit for compare enabled (2 possible values)
uint16_t mCompareEnabled : 1;
// 3 bits for compare op. (8 possible values)
uint16_t mCompareOp : 3;
// Values from angle::ColorGeneric::Type. Float is 0 and others are 1.
uint16_t mBorderColorType : 1;
uint16_t mPadding : 15;
// 16*8 bits for BorderColor
angle::ColorF mBorderColor;
// 32 bits reserved for future use.
uint32_t mReserved;
};
static_assert(sizeof(SamplerDesc) == 56, "Unexpected SamplerDesc size");
// Disable warnings about struct padding.
ANGLE_DISABLE_STRUCT_PADDING_WARNINGS
class PipelineHelper;
struct GraphicsPipelineTransition
{
GraphicsPipelineTransition();
GraphicsPipelineTransition(const GraphicsPipelineTransition &other);
GraphicsPipelineTransition(GraphicsPipelineTransitionBits bits,
const GraphicsPipelineDesc *desc,
PipelineHelper *pipeline);
GraphicsPipelineTransitionBits bits;
const GraphicsPipelineDesc *desc;
PipelineHelper *target;
};
ANGLE_INLINE GraphicsPipelineTransition::GraphicsPipelineTransition() = default;
ANGLE_INLINE GraphicsPipelineTransition::GraphicsPipelineTransition(
const GraphicsPipelineTransition &other) = default;
ANGLE_INLINE GraphicsPipelineTransition::GraphicsPipelineTransition(
GraphicsPipelineTransitionBits bits,
const GraphicsPipelineDesc *desc,
PipelineHelper *pipeline)
: bits(bits), desc(desc), target(pipeline)
{}
ANGLE_INLINE bool GraphicsPipelineTransitionMatch(GraphicsPipelineTransitionBits bitsA,
GraphicsPipelineTransitionBits bitsB,
const GraphicsPipelineDesc &descA,
const GraphicsPipelineDesc &descB)
{
if (bitsA != bitsB)
return false;
// We currently mask over 4 bytes of the pipeline description with each dirty bit.
// We could consider using 8 bytes and a mask of 32 bits. This would make some parts
// of the code faster. The for loop below would scan over twice as many bits per iteration.
// But there may be more collisions between the same dirty bit masks leading to different
// transitions. Thus there may be additional cost when applications use many transitions.
// We should revisit this in the future and investigate using different bit widths.
static_assert(sizeof(uint32_t) == kGraphicsPipelineDirtyBitBytes, "Size mismatch");
const uint32_t *rawPtrA = descA.getPtr<uint32_t>();
const uint32_t *rawPtrB = descB.getPtr<uint32_t>();
for (size_t dirtyBit : bitsA)
{
if (rawPtrA[dirtyBit] != rawPtrB[dirtyBit])
return false;
}
return true;
}
// A class that encapsulates the vk::PipelineCache and associated mutex. The mutex may be nullptr
// if synchronization is not necessary.
class PipelineCacheAccess
{
public:
PipelineCacheAccess() = default;
~PipelineCacheAccess() = default;
void init(const vk::PipelineCache *pipelineCache, angle::SimpleMutex *mutex)
{
mPipelineCache = pipelineCache;
mMutex = mutex;
}
VkResult createGraphicsPipeline(vk::Context *context,
const VkGraphicsPipelineCreateInfo &createInfo,
vk::Pipeline *pipelineOut);
VkResult createComputePipeline(vk::Context *context,
const VkComputePipelineCreateInfo &createInfo,
vk::Pipeline *pipelineOut);
void merge(Renderer *renderer, const vk::PipelineCache &pipelineCache);
bool isThreadSafe() const { return mMutex != nullptr; }
private:
std::unique_lock<angle::SimpleMutex> getLock();
const vk::PipelineCache *mPipelineCache = nullptr;
angle::SimpleMutex *mMutex;
};
// Monolithic pipeline creation tasks are created as soon as a pipeline is created out of libraries.
// However, they are not immediately posted to the worker queue to allow pacing. One each use of a
// pipeline, an attempt is made to post the task.
class CreateMonolithicPipelineTask : public Context, public angle::Closure
{
public:
CreateMonolithicPipelineTask(Renderer *renderer,
const PipelineCacheAccess &pipelineCache,
const PipelineLayout &pipelineLayout,
const ShaderModuleMap &shaders,
const SpecializationConstants &specConsts,
const GraphicsPipelineDesc &desc);
// The compatible render pass is set only when the task is ready to run. This is because the
// render pass cache may have been cleared since the task was created (e.g. to accomodate
// framebuffer fetch). Such render pass cache clears ensure there are no active tasks, so it's
// safe to hold on to this pointer for the brief period between task post and completion.
//
// Not applicable to dynamic rendering.
const RenderPassDesc &getRenderPassDesc() const { return mDesc.getRenderPassDesc(); }
void setCompatibleRenderPass(const RenderPass *compatibleRenderPass);
void operator()() override;
VkResult getResult() const { return mResult; }
Pipeline &getPipeline() { return mPipeline; }
CacheLookUpFeedback getFeedback() const { return mFeedback; }
void handleError(VkResult result,
const char *file,
const char *function,
unsigned int line) override;
private:
// Input to pipeline creation
PipelineCacheAccess mPipelineCache;
const RenderPass *mCompatibleRenderPass;
const PipelineLayout &mPipelineLayout;
const ShaderModuleMap &mShaders;
SpecializationConstants mSpecConsts;
GraphicsPipelineDesc mDesc;
// Results
VkResult mResult;
Pipeline mPipeline;
CacheLookUpFeedback mFeedback;
};
class WaitableMonolithicPipelineCreationTask
{
public:
~WaitableMonolithicPipelineCreationTask();
void setTask(std::shared_ptr<CreateMonolithicPipelineTask> &&task) { mTask = std::move(task); }
void setRenderPass(const RenderPass *compatibleRenderPass)
{
mTask->setCompatibleRenderPass(compatibleRenderPass);
}
void onSchedule(const std::shared_ptr<angle::WaitableEvent> &waitableEvent)
{
mWaitableEvent = waitableEvent;
}
void reset()
{
mWaitableEvent.reset();
mTask.reset();
}
bool isValid() const { return mTask.get() != nullptr; }
bool isPosted() const { return mWaitableEvent.get() != nullptr; }
bool isReady() { return mWaitableEvent->isReady(); }
void wait() { return mWaitableEvent->wait(); }
std::shared_ptr<CreateMonolithicPipelineTask> getTask() const { return mTask; }
private:
std::shared_ptr<angle::WaitableEvent> mWaitableEvent;
std::shared_ptr<CreateMonolithicPipelineTask> mTask;
};
class PipelineHelper final : public Resource
{
public:
PipelineHelper();
~PipelineHelper() override;
inline explicit PipelineHelper(Pipeline &&pipeline, CacheLookUpFeedback feedback);
PipelineHelper &operator=(PipelineHelper &&other);
void destroy(VkDevice device);
void release(Context *context);
bool valid() const { return mPipeline.valid(); }
const Pipeline &getPipeline() const { return mPipeline; }
// Get the pipeline. If there is a monolithic pipeline creation task pending, scheduling it is
// attempted. If that task is done, the pipeline is replaced with the results and the old
// pipeline released.
angle::Result getPreferredPipeline(ContextVk *contextVk, const Pipeline **pipelineOut);
ANGLE_INLINE bool findTransition(GraphicsPipelineTransitionBits bits,
const GraphicsPipelineDesc &desc,
PipelineHelper **pipelineOut) const
{
// Search could be improved using sorting or hashing.
for (const GraphicsPipelineTransition &transition : mTransitions)
{
if (GraphicsPipelineTransitionMatch(transition.bits, bits, *transition.desc, desc))
{
*pipelineOut = transition.target;
return true;
}
}
return false;
}
void addTransition(GraphicsPipelineTransitionBits bits,
const GraphicsPipelineDesc *desc,
PipelineHelper *pipeline);
const std::vector<GraphicsPipelineTransition> getTransitions() const { return mTransitions; }
void setComputePipeline(Pipeline &&pipeline, CacheLookUpFeedback feedback)
{
ASSERT(!mPipeline.valid());
mPipeline = std::move(pipeline);
ASSERT(mCacheLookUpFeedback == CacheLookUpFeedback::None);
mCacheLookUpFeedback = feedback;
}
CacheLookUpFeedback getCacheLookUpFeedback() const { return mCacheLookUpFeedback; }
void setLinkedLibraryReferences(vk::PipelineHelper *shadersPipeline);
void retainInRenderPass(RenderPassCommandBufferHelper *renderPassCommands);
void setMonolithicPipelineCreationTask(std::shared_ptr<CreateMonolithicPipelineTask> &&task)
{
mMonolithicPipelineCreationTask.setTask(std::move(task));
}
private:
void reset();
std::vector<GraphicsPipelineTransition> mTransitions;
Pipeline mPipeline;
CacheLookUpFeedback mCacheLookUpFeedback = CacheLookUpFeedback::None;
CacheLookUpFeedback mMonolithicCacheLookUpFeedback = CacheLookUpFeedback::None;
// The list of pipeline helpers that were referenced when creating a linked pipeline. These
// pipelines must be kept alive, so their serial is updated at the same time as this object.
// Not necessary for vertex input and fragment output as they stay alive until context's
// destruction.
PipelineHelper *mLinkedShaders = nullptr;
// If pipeline libraries are used and monolithic pipelines are created in parallel, this is the
// temporary library created (previously in |mPipeline|) that is now replaced by the monolithic
// one. It is not immediately garbage collected when replaced, because there is currently a bug
// with that. http://anglebug.com/42266335
Pipeline mLinkedPipelineToRelease;
// An async task to create a monolithic pipeline. Only used if the pipeline was originally
// created as a linked library. The |getPipeline()| call will attempt to schedule this task
// through the share group, which manages and paces these tasks. Once the task results are
// ready, |mPipeline| is released and replaced by the result of this task.
WaitableMonolithicPipelineCreationTask mMonolithicPipelineCreationTask;
};
class FramebufferHelper : public Resource
{
public:
FramebufferHelper();
~FramebufferHelper() override;
FramebufferHelper(FramebufferHelper &&other);
FramebufferHelper &operator=(FramebufferHelper &&other);
angle::Result init(Context *context, const VkFramebufferCreateInfo &createInfo);
void destroy(Renderer *renderer);
void release(ContextVk *contextVk);
bool valid() { return mFramebuffer.valid(); }
const Framebuffer &getFramebuffer() const
{
ASSERT(mFramebuffer.valid());
return mFramebuffer;
}
Framebuffer &getFramebuffer()
{
ASSERT(mFramebuffer.valid());
return mFramebuffer;
}
private:
// Vulkan object.
Framebuffer mFramebuffer;
};
ANGLE_INLINE PipelineHelper::PipelineHelper(Pipeline &&pipeline, CacheLookUpFeedback feedback)
: mPipeline(std::move(pipeline)), mCacheLookUpFeedback(feedback)
{}
ANGLE_INLINE PipelineHelper &PipelineHelper::operator=(PipelineHelper &&other)
{
ASSERT(!mPipeline.valid());
std::swap(mPipeline, other.mPipeline);
mCacheLookUpFeedback = other.mCacheLookUpFeedback;
return *this;
}
struct ImageSubresourceRange
{
// GL max is 1000 (fits in 10 bits).
uint32_t level : 10;
// Max 31 levels (2 ** 5 - 1). Can store levelCount-1 if we need to save another bit.
uint32_t levelCount : 5;
// Implementation max is 2048 (11 bits).
uint32_t layer : 12;
// One of vk::LayerMode values. If 0, it means all layers. Otherwise it's the count of layers
// which is usually 1, except for multiview in which case it can be up to
// gl::IMPLEMENTATION_MAX_2D_ARRAY_TEXTURE_LAYERS.
uint32_t layerMode : 3;
// Values from vk::SrgbDecodeMode. Unused with draw views.
uint32_t srgbDecodeMode : 1;
// For read views: Values from gl::SrgbOverride, either Default or SRGB.
// For draw views: Values from gl::SrgbWriteControlMode.
uint32_t srgbMode : 1;
static_assert(gl::IMPLEMENTATION_MAX_TEXTURE_LEVELS < (1 << 5),
"Not enough bits for level count");
static_assert(gl::IMPLEMENTATION_MAX_2D_ARRAY_TEXTURE_LAYERS <= (1 << 12),
"Not enough bits for layer index");
static_assert(gl::IMPLEMENTATION_ANGLE_MULTIVIEW_MAX_VIEWS <= (1 << 3),
"Not enough bits for layer count");
};
static_assert(sizeof(ImageSubresourceRange) == sizeof(uint32_t), "Size mismatch");
inline bool operator==(const ImageSubresourceRange &a, const ImageSubresourceRange &b)
{
return a.level == b.level && a.levelCount == b.levelCount && a.layer == b.layer &&
a.layerMode == b.layerMode && a.srgbDecodeMode == b.srgbDecodeMode &&
a.srgbMode == b.srgbMode;
}
constexpr ImageSubresourceRange kInvalidImageSubresourceRange = {0, 0, 0, 0, 0, 0};
struct ImageOrBufferViewSubresourceSerial
{
ImageOrBufferViewSerial viewSerial;
ImageSubresourceRange subresource;
};
inline bool operator==(const ImageOrBufferViewSubresourceSerial &a,
const ImageOrBufferViewSubresourceSerial &b)
{
return a.viewSerial == b.viewSerial && a.subresource == b.subresource;
}
constexpr ImageOrBufferViewSubresourceSerial kInvalidImageOrBufferViewSubresourceSerial = {
kInvalidImageOrBufferViewSerial, kInvalidImageSubresourceRange};
// Always starts with array element zero, with descriptorCount descriptors.
struct WriteDescriptorDesc
{
uint8_t binding; // Redundant: determined by the containing WriteDesc array.
uint8_t descriptorCount; // Number of array elements in this descriptor write.
uint8_t descriptorType; // Packed VkDescriptorType.
uint8_t descriptorInfoIndex; // Base index into an array of DescriptorInfoDescs.
};
static_assert(sizeof(WriteDescriptorDesc) == 4, "Size mismatch");
struct DescriptorInfoDesc
{
uint32_t samplerOrBufferSerial;
uint32_t imageViewSerialOrOffset;
uint32_t imageLayoutOrRange; // Packed VkImageLayout
uint32_t imageSubresourceRange;
};
static_assert(sizeof(DescriptorInfoDesc) == 16, "Size mismatch");
// Generic description of a descriptor set. Used as a key when indexing descriptor set caches. The
// key storage is an angle:FixedVector. Beyond a certain fixed size we'll end up using heap memory
// to store keys. Currently we specialize the structure for three use cases: uniforms, textures,
// and other shader resources. Because of the way the specialization works we can't currently cache
// programs that use some types of resources.
static constexpr size_t kFastDescriptorSetDescLimit = 8;
struct DescriptorDescHandles
{
VkBuffer buffer;
VkSampler sampler;
VkImageView imageView;
VkBufferView bufferView;
};
class WriteDescriptorDescs
{
public:
void reset()
{
mDescs.clear();
mDynamicDescriptorSetCount = 0;
mCurrentInfoIndex = 0;
}
void updateShaderBuffers(const ShaderInterfaceVariableInfoMap &variableInfoMap,
const std::vector<gl::InterfaceBlock> &blocks,
VkDescriptorType descriptorType);
void updateAtomicCounters(const ShaderInterfaceVariableInfoMap &variableInfoMap,
const std::vector<gl::AtomicCounterBuffer> &atomicCounterBuffers);
void updateImages(const gl::ProgramExecutable &executable,
const ShaderInterfaceVariableInfoMap &variableInfoMap);
void updateInputAttachments(const gl::ProgramExecutable &executable,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
FramebufferVk *framebufferVk);
void updateExecutableActiveTextures(const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::ProgramExecutable &executable);
void updateDefaultUniform(gl::ShaderBitSet shaderTypes,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::ProgramExecutable &executable);
void updateTransformFeedbackWrite(const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::ProgramExecutable &executable);
void updateDynamicDescriptorsCount();
size_t size() const { return mDescs.size(); }
bool empty() const { return mDescs.size() == 0; }
const WriteDescriptorDesc &operator[](uint32_t bindingIndex) const
{
return mDescs[bindingIndex];
}
size_t getTotalDescriptorCount() const { return mCurrentInfoIndex; }
size_t getDynamicDescriptorSetCount() const { return mDynamicDescriptorSetCount; }
void streamOut(std::ostream &os) const;
private:
bool hasWriteDescAtIndex(uint32_t bindingIndex) const
{
return bindingIndex < mDescs.size() && mDescs[bindingIndex].descriptorCount > 0;
}
void incrementDescriptorCount(uint32_t bindingIndex, uint32_t count)
{
// Validate we have no subsequent writes.
ASSERT(hasWriteDescAtIndex(bindingIndex));
mDescs[bindingIndex].descriptorCount += count;
}
void updateWriteDesc(uint32_t bindingIndex,
VkDescriptorType descriptorType,
uint32_t descriptorCount);
// After a preliminary minimum size, use heap memory.
angle::FastMap<WriteDescriptorDesc, kFastDescriptorSetDescLimit> mDescs;
size_t mDynamicDescriptorSetCount = 0;
uint32_t mCurrentInfoIndex = 0;
};
class DescriptorSetDesc
{
public:
DescriptorSetDesc() = default;
~DescriptorSetDesc() = default;
DescriptorSetDesc(const DescriptorSetDesc &other) : mDescriptorInfos(other.mDescriptorInfos) {}
DescriptorSetDesc &operator=(const DescriptorSetDesc &other)
{
mDescriptorInfos = other.mDescriptorInfos;
return *this;
}
size_t hash() const;
void resize(size_t count) { mDescriptorInfos.resize(count); }
size_t getKeySizeBytes() const { return mDescriptorInfos.size() * sizeof(DescriptorInfoDesc); }
bool operator==(const DescriptorSetDesc &other) const
{
return mDescriptorInfos.size() == other.mDescriptorInfos.size() &&
memcmp(mDescriptorInfos.data(), other.mDescriptorInfos.data(),
mDescriptorInfos.size() * sizeof(DescriptorInfoDesc)) == 0;
}
DescriptorInfoDesc &getInfoDesc(uint32_t infoDescIndex)
{
return mDescriptorInfos[infoDescIndex];
}
void updateDescriptorSet(Renderer *renderer,
const WriteDescriptorDescs &writeDescriptorDescs,
UpdateDescriptorSetsBuilder *updateBuilder,
const DescriptorDescHandles *handles,
VkDescriptorSet descriptorSet) const;
void streamOut(std::ostream &os) const;
private:
// After a preliminary minimum size, use heap memory.
angle::FastVector<DescriptorInfoDesc, kFastDescriptorSetDescLimit> mDescriptorInfos;
};
class DescriptorPoolHelper;
using RefCountedDescriptorPoolHelper = RefCounted<DescriptorPoolHelper>;
// SharedDescriptorSetCacheKey.
// Because DescriptorSet must associate with a pool, we need to define a structure that wraps both.
struct DescriptorSetDescAndPool
{
DescriptorSetDesc mDesc;
DynamicDescriptorPool *mPool;
};
using DescriptorSetAndPoolPointer = std::unique_ptr<DescriptorSetDescAndPool>;
using SharedDescriptorSetCacheKey = std::shared_ptr<DescriptorSetAndPoolPointer>;
ANGLE_INLINE const SharedDescriptorSetCacheKey
CreateSharedDescriptorSetCacheKey(const DescriptorSetDesc &desc, DynamicDescriptorPool *pool)
{
DescriptorSetAndPoolPointer DescriptorAndPoolPointer =
std::make_unique<DescriptorSetDescAndPool>(DescriptorSetDescAndPool{desc, pool});
return std::make_shared<DescriptorSetAndPoolPointer>(std::move(DescriptorAndPoolPointer));
}
constexpr VkDescriptorType kStorageBufferDescriptorType = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
// Manages a descriptor set desc with a few helper routines and also stores object handles.
class DescriptorSetDescBuilder final
{
public:
DescriptorSetDescBuilder();
DescriptorSetDescBuilder(size_t descriptorCount);
~DescriptorSetDescBuilder();
DescriptorSetDescBuilder(const DescriptorSetDescBuilder &other);
DescriptorSetDescBuilder &operator=(const DescriptorSetDescBuilder &other);
const DescriptorSetDesc &getDesc() const { return mDesc; }
void resize(size_t descriptorCount)
{
mDesc.resize(descriptorCount);
mHandles.resize(descriptorCount);
mDynamicOffsets.resize(descriptorCount);
}
// Specific helpers for uniforms/xfb descriptors.
void updateUniformBuffer(uint32_t shaderIndex,
const WriteDescriptorDescs &writeDescriptorDescs,
const BufferHelper &bufferHelper,
VkDeviceSize bufferRange);
void updateTransformFeedbackBuffer(const Context *context,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const WriteDescriptorDescs &writeDescriptorDescs,
uint32_t xfbBufferIndex,
const BufferHelper &bufferHelper,
VkDeviceSize bufferOffset,
VkDeviceSize bufferRange);
void updateUniformsAndXfb(Context *context,
const gl::ProgramExecutable &executable,
const WriteDescriptorDescs &writeDescriptorDescs,
const BufferHelper *currentUniformBuffer,
const BufferHelper &emptyBuffer,
bool activeUnpaused,
TransformFeedbackVk *transformFeedbackVk);
// Specific helpers for shader resource descriptors.
template <typename CommandBufferT>
void updateOneShaderBuffer(CommandBufferT *commandBufferHelper,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::BufferVector &buffers,
const gl::InterfaceBlock &block,
uint32_t bufferIndex,
VkDescriptorType descriptorType,
VkDeviceSize maxBoundBufferRange,
const BufferHelper &emptyBuffer,
const WriteDescriptorDescs &writeDescriptorDescs,
const GLbitfield memoryBarrierBits);
template <typename CommandBufferT>
void updateShaderBuffers(CommandBufferT *commandBufferHelper,
const gl::ProgramExecutable &executable,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::BufferVector &buffers,
const std::vector<gl::InterfaceBlock> &blocks,
VkDescriptorType descriptorType,
VkDeviceSize maxBoundBufferRange,
const BufferHelper &emptyBuffer,
const WriteDescriptorDescs &writeDescriptorDescs,
const GLbitfield memoryBarrierBits);
template <typename CommandBufferT>
void updateAtomicCounters(CommandBufferT *commandBufferHelper,
const gl::ProgramExecutable &executable,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::BufferVector &buffers,
const std::vector<gl::AtomicCounterBuffer> &atomicCounterBuffers,
const VkDeviceSize requiredOffsetAlignment,
const BufferHelper &emptyBuffer,
const WriteDescriptorDescs &writeDescriptorDescs);
angle::Result updateImages(Context *context,
const gl::ProgramExecutable &executable,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const gl::ActiveTextureArray<TextureVk *> &activeImages,
const std::vector<gl::ImageUnit> &imageUnits,
const WriteDescriptorDescs &writeDescriptorDescs);
angle::Result updateInputAttachments(vk::Context *context,
const gl::ProgramExecutable &executable,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
FramebufferVk *framebufferVk,
const WriteDescriptorDescs &writeDescriptorDescs);
// Specific helpers for image descriptors.
void updatePreCacheActiveTextures(const gl::ActiveTextureMask &activeTextures,
const gl::ActiveTextureArray<TextureVk *> &textures,
const gl::SamplerBindingVector &samplers);
angle::Result updateFullActiveTextures(Context *context,
const ShaderInterfaceVariableInfoMap &variableInfoMap,
const WriteDescriptorDescs &writeDescriptorDescs,
const gl::ProgramExecutable &executable,
const gl::ActiveTextureArray<TextureVk *> &textures,
const gl::SamplerBindingVector &samplers,
PipelineType pipelineType,
const SharedDescriptorSetCacheKey &sharedCacheKey);
void updateDescriptorSet(Renderer *renderer,
const WriteDescriptorDescs &writeDescriptorDescs,
UpdateDescriptorSetsBuilder *updateBuilder,
VkDescriptorSet descriptorSet) const;
const uint32_t *getDynamicOffsets() const { return mDynamicOffsets.data(); }
size_t getDynamicOffsetsSize() const { return mDynamicOffsets.size(); }
private:
void setEmptyBuffer(uint32_t infoDescIndex,
VkDescriptorType descriptorType,
const BufferHelper &emptyBuffer);
DescriptorSetDesc mDesc;
angle::FastVector<DescriptorDescHandles, kFastDescriptorSetDescLimit> mHandles;
angle::FastVector<uint32_t, kFastDescriptorSetDescLimit> mDynamicOffsets;
};
// Specialized update for textures.
void UpdatePreCacheActiveTextures(const gl::ProgramExecutable &executable,
const std::vector<gl::SamplerBinding> &samplerBindings,
const gl::ActiveTextureMask &activeTextures,
const gl::ActiveTextureArray<TextureVk *> &textures,
const gl::SamplerBindingVector &samplers,
DescriptorSetDesc *desc);
// In the FramebufferDesc object:
// - Depth/stencil serial is at index 0
// - Color serials are at indices [1, gl::IMPLEMENTATION_MAX_DRAW_BUFFERS]
// - Depth/stencil resolve attachment is at index gl::IMPLEMENTATION_MAX_DRAW_BUFFERS+1
// - Resolve attachments are at indices [gl::IMPLEMENTATION_MAX_DRAW_BUFFERS+2,
// gl::IMPLEMENTATION_MAX_DRAW_BUFFERS*2+1]
// Fragment shading rate attachment serial is at index
// (gl::IMPLEMENTATION_MAX_DRAW_BUFFERS*2+1)+1
constexpr size_t kFramebufferDescDepthStencilIndex = 0;
constexpr size_t kFramebufferDescColorIndexOffset = kFramebufferDescDepthStencilIndex + 1;
constexpr size_t kFramebufferDescDepthStencilResolveIndexOffset =
kFramebufferDescColorIndexOffset + gl::IMPLEMENTATION_MAX_DRAW_BUFFERS;
constexpr size_t kFramebufferDescColorResolveIndexOffset =
kFramebufferDescDepthStencilResolveIndexOffset + 1;
constexpr size_t kFramebufferDescFragmentShadingRateAttachmentIndexOffset =
kFramebufferDescColorResolveIndexOffset + gl::IMPLEMENTATION_MAX_DRAW_BUFFERS;
// Enable struct padding warnings for the code below since it is used in caches.
ANGLE_ENABLE_STRUCT_PADDING_WARNINGS
class FramebufferDesc
{
public:
FramebufferDesc();
~FramebufferDesc();
FramebufferDesc(const FramebufferDesc &other);
FramebufferDesc &operator=(const FramebufferDesc &other);
void updateColor(uint32_t index, ImageOrBufferViewSubresourceSerial serial);
void updateColorResolve(uint32_t index, ImageOrBufferViewSubresourceSerial serial);
void updateUnresolveMask(FramebufferNonResolveAttachmentMask unresolveMask);
void updateDepthStencil(ImageOrBufferViewSubresourceSerial serial);
void updateDepthStencilResolve(ImageOrBufferViewSubresourceSerial serial);
ANGLE_INLINE void setWriteControlMode(gl::SrgbWriteControlMode mode)
{
mSrgbWriteControlMode = static_cast<uint16_t>(mode);
}
void updateIsMultiview(bool isMultiview) { mIsMultiview = isMultiview; }
size_t hash() const;
bool operator==(const FramebufferDesc &other) const;
uint32_t attachmentCount() const;
ImageOrBufferViewSubresourceSerial getColorImageViewSerial(uint32_t index)
{
ASSERT(kFramebufferDescColorIndexOffset + index < mSerials.size());
return mSerials[kFramebufferDescColorIndexOffset + index];
}
FramebufferNonResolveAttachmentMask getUnresolveAttachmentMask() const;
ANGLE_INLINE gl::SrgbWriteControlMode getWriteControlMode() const
{
return (mSrgbWriteControlMode == 1) ? gl::SrgbWriteControlMode::Linear
: gl::SrgbWriteControlMode::Default;
}
void updateLayerCount(uint32_t layerCount);
uint32_t getLayerCount() const { return mLayerCount; }
void setFramebufferFetchMode(bool hasFramebufferFetch);
bool hasFramebufferFetch() const { return mHasFramebufferFetch; }
bool isMultiview() const { return mIsMultiview; }
void updateRenderToTexture(bool isRenderToTexture);
void updateFragmentShadingRate(ImageOrBufferViewSubresourceSerial serial);
bool hasFragmentShadingRateAttachment() const;
private:
void reset();
void update(uint32_t index, ImageOrBufferViewSubresourceSerial serial);
// Note: this is an exclusive index. If there is one index it will be "1".
// Maximum value is 18
uint16_t mMaxIndex : 5;
// Whether the render pass has input attachments or not.
uint16_t mHasFramebufferFetch : 1;
static_assert(gl::IMPLEMENTATION_MAX_FRAMEBUFFER_LAYERS < (1 << 9) - 1,
"Not enough bits for mLayerCount");
uint16_t mLayerCount : 9;
uint16_t mSrgbWriteControlMode : 1;
// If the render pass contains an initial subpass to unresolve a number of attachments, the
// subpass description is derived from the following mask, specifying which attachments need
// to be unresolved. Includes both color and depth/stencil attachments.
uint16_t mUnresolveAttachmentMask : kMaxFramebufferNonResolveAttachments;
// Whether this is a multisampled-render-to-single-sampled framebuffer. Only used when using
// VK_EXT_multisampled_render_to_single_sampled. Only one bit is used and the rest is padding.
uint16_t mIsRenderToTexture : 15 - kMaxFramebufferNonResolveAttachments;
uint16_t mIsMultiview : 1;
FramebufferAttachmentArray<ImageOrBufferViewSubresourceSerial> mSerials;
};
constexpr size_t kFramebufferDescSize = sizeof(FramebufferDesc);
static_assert(kFramebufferDescSize == 156, "Size check failed");
// Disable warnings about struct padding.
ANGLE_DISABLE_STRUCT_PADDING_WARNINGS
// SharedFramebufferCacheKey
using FramebufferDescPointer = std::unique_ptr<FramebufferDesc>;
using SharedFramebufferCacheKey = std::shared_ptr<FramebufferDescPointer>;
ANGLE_INLINE const SharedFramebufferCacheKey
CreateSharedFramebufferCacheKey(const FramebufferDesc &desc)
{
FramebufferDescPointer framebufferDescPointer = std::make_unique<FramebufferDesc>(desc);
return std::make_shared<FramebufferDescPointer>(std::move(framebufferDescPointer));
}
// The SamplerHelper allows a Sampler to be coupled with a serial.
// Must be included before we declare SamplerCache.
class SamplerHelper final : angle::NonCopyable
{
public:
SamplerHelper(ContextVk *contextVk);
~SamplerHelper();
explicit SamplerHelper(SamplerHelper &&samplerHelper);
SamplerHelper &operator=(SamplerHelper &&rhs);
bool valid() const { return mSampler.valid(); }
const Sampler &get() const { return mSampler; }
Sampler &get() { return mSampler; }
SamplerSerial getSamplerSerial() const { return mSamplerSerial; }
private:
Sampler mSampler;
SamplerSerial mSamplerSerial;
};
using RefCountedSampler = RefCounted<SamplerHelper>;
using SamplerBinding = BindingPointer<SamplerHelper>;
class RenderPassHelper final : angle::NonCopyable
{
public:
RenderPassHelper();
~RenderPassHelper();
RenderPassHelper(RenderPassHelper &&other);
RenderPassHelper &operator=(RenderPassHelper &&other);
void destroy(VkDevice device);
void release(ContextVk *contextVk);
const RenderPass &getRenderPass() const;
RenderPass &getRenderPass();
const RenderPassPerfCounters &getPerfCounters() const;
RenderPassPerfCounters &getPerfCounters();
private:
RenderPass mRenderPass;
RenderPassPerfCounters mPerfCounters;
};
// Helper class manages the lifetime of various cache objects so that the cache entry can be
// destroyed when one of the components becomes invalid.
template <class SharedCacheKeyT>
class SharedCacheKeyManager
{
public:
SharedCacheKeyManager() = default;
~SharedCacheKeyManager() { ASSERT(empty()); }
// Store the pointer to the cache key and retains it
void addKey(const SharedCacheKeyT &key);
// Iterate over the descriptor array and release the descriptor and cache.
void releaseKeys(ContextVk *contextVk);
void releaseKeys(Renderer *renderer);
// Iterate over the descriptor array and destroy the descriptor and cache.
void destroyKeys(Renderer *renderer);
void clear();
// The following APIs are expected to be used for assertion only
bool containsKey(const SharedCacheKeyT &key) const;
bool empty() const { return mSharedCacheKeys.empty(); }
void assertAllEntriesDestroyed();
private:
// Tracks an array of cache keys with refcounting. Note this owns one refcount of
// SharedCacheKeyT object.
std::vector<SharedCacheKeyT> mSharedCacheKeys;
};
using FramebufferCacheManager = SharedCacheKeyManager<SharedFramebufferCacheKey>;
using DescriptorSetCacheManager = SharedCacheKeyManager<SharedDescriptorSetCacheKey>;
} // namespace vk
} // namespace rx
// Introduce std::hash for the above classes.
namespace std
{
template <>
struct hash<rx::vk::RenderPassDesc>
{
size_t operator()(const rx::vk::RenderPassDesc &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::AttachmentOpsArray>
{
size_t operator()(const rx::vk::AttachmentOpsArray &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::DescriptorSetLayoutDesc>
{
size_t operator()(const rx::vk::DescriptorSetLayoutDesc &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::PipelineLayoutDesc>
{
size_t operator()(const rx::vk::PipelineLayoutDesc &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::ImageSubresourceRange>
{
size_t operator()(const rx::vk::ImageSubresourceRange &key) const
{
return *reinterpret_cast<const uint32_t *>(&key);
}
};
template <>
struct hash<rx::vk::DescriptorSetDesc>
{
size_t operator()(const rx::vk::DescriptorSetDesc &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::FramebufferDesc>
{
size_t operator()(const rx::vk::FramebufferDesc &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::YcbcrConversionDesc>
{
size_t operator()(const rx::vk::YcbcrConversionDesc &key) const { return key.hash(); }
};
template <>
struct hash<rx::vk::SamplerDesc>
{
size_t operator()(const rx::vk::SamplerDesc &key) const { return key.hash(); }
};
// See Resource Serial types defined in vk_utils.h.
#define ANGLE_HASH_VK_SERIAL(Type) \
template <> \
struct hash<rx::vk::Type##Serial> \
{ \
size_t operator()(const rx::vk::Type##Serial &key) const \
{ \
return key.getValue(); \
} \
};
ANGLE_VK_SERIAL_OP(ANGLE_HASH_VK_SERIAL)
} // namespace std
namespace rx
{
// Cache types for various Vulkan objects
enum class VulkanCacheType
{
CompatibleRenderPass,
RenderPassWithOps,
GraphicsPipeline,
PipelineLayout,
Sampler,
SamplerYcbcrConversion,
DescriptorSetLayout,
DriverUniformsDescriptors,
TextureDescriptors,
UniformsAndXfbDescriptors,
ShaderResourcesDescriptors,
Framebuffer,
DescriptorMetaCache,
EnumCount
};
// Base class for all caches. Provides cache hit and miss counters.
class CacheStats final : angle::NonCopyable
{
public:
CacheStats() { reset(); }
~CacheStats() {}
CacheStats(const CacheStats &rhs)
: mHitCount(rhs.mHitCount), mMissCount(rhs.mMissCount), mSize(rhs.mSize)
{}
CacheStats &operator=(const CacheStats &rhs)
{
mHitCount = rhs.mHitCount;
mMissCount = rhs.mMissCount;
mSize = rhs.mSize;
return *this;
}
ANGLE_INLINE void hit() { mHitCount++; }
ANGLE_INLINE void miss() { mMissCount++; }
ANGLE_INLINE void incrementSize() { mSize++; }
ANGLE_INLINE void decrementSize() { mSize--; }
ANGLE_INLINE void missAndIncrementSize()
{
mMissCount++;
mSize++;
}
ANGLE_INLINE void accumulate(const CacheStats &stats)
{
mHitCount += stats.mHitCount;
mMissCount += stats.mMissCount;
mSize += stats.mSize;
}
uint32_t getHitCount() const { return mHitCount; }
uint32_t getMissCount() const { return mMissCount; }
ANGLE_INLINE double getHitRatio() const
{
if (mHitCount + mMissCount == 0)
{
return 0;
}
else
{
return static_cast<double>(mHitCount) / (mHitCount + mMissCount);
}
}
ANGLE_INLINE uint32_t getSize() const { return mSize; }
ANGLE_INLINE void setSize(uint32_t size) { mSize = size; }
void reset()
{
mHitCount = 0;
mMissCount = 0;
mSize = 0;
}
void resetHitAndMissCount()
{
mHitCount = 0;
mMissCount = 0;
}
void accumulateCacheStats(VulkanCacheType cacheType, const CacheStats &cacheStats)
{
mHitCount += cacheStats.getHitCount();
mMissCount += cacheStats.getMissCount();
}
private:
uint32_t mHitCount;
uint32_t mMissCount;
uint32_t mSize;
};
template <VulkanCacheType CacheType>
class HasCacheStats : angle::NonCopyable
{
public:
template <typename Accumulator>
void accumulateCacheStats(Accumulator *accum)
{
accum->accumulateCacheStats(CacheType, mCacheStats);
mCacheStats.reset();
}
void getCacheStats(CacheStats *accum) const { accum->accumulate(mCacheStats); }
protected:
HasCacheStats() = default;
virtual ~HasCacheStats() = default;
CacheStats mCacheStats;
};
using VulkanCacheStats = angle::PackedEnumMap<VulkanCacheType, CacheStats>;
// FramebufferVk Cache
class FramebufferCache final : angle::NonCopyable
{
public:
FramebufferCache() = default;
~FramebufferCache() { ASSERT(mPayload.empty()); }
void destroy(vk::Renderer *renderer);
bool get(ContextVk *contextVk, const vk::FramebufferDesc &desc, vk::Framebuffer &framebuffer);
void insert(ContextVk *contextVk,
const vk::FramebufferDesc &desc,
vk::FramebufferHelper &&framebufferHelper);
void erase(ContextVk *contextVk, const vk::FramebufferDesc &desc);
size_t getSize() const { return mPayload.size(); }
bool empty() const { return mPayload.empty(); }
private:
angle::HashMap<vk::FramebufferDesc, vk::FramebufferHelper> mPayload;
CacheStats mCacheStats;
};
// TODO(jmadill): Add cache trimming/eviction.
class RenderPassCache final : angle::NonCopyable
{
public:
RenderPassCache();
~RenderPassCache();
void destroy(ContextVk *contextVk);
void clear(ContextVk *contextVk);
ANGLE_INLINE angle::Result getCompatibleRenderPass(ContextVk *contextVk,
const vk::RenderPassDesc &desc,
const vk::RenderPass **renderPassOut)
{
auto outerIt = mPayload.find(desc);
if (outerIt != mPayload.end())
{
InnerCache &innerCache = outerIt->second;
ASSERT(!innerCache.empty());
// Find the first element and return it.
*renderPassOut = &innerCache.begin()->second.getRenderPass();
mCompatibleRenderPassCacheStats.hit();
return angle::Result::Continue;
}
mCompatibleRenderPassCacheStats.missAndIncrementSize();
return addCompatibleRenderPass(contextVk, desc, renderPassOut);
}
angle::Result getRenderPassWithOps(ContextVk *contextVk,
const vk::RenderPassDesc &desc,
const vk::AttachmentOpsArray &attachmentOps,
const vk::RenderPass **renderPassOut);
static void InitializeOpsForCompatibleRenderPass(const vk::RenderPassDesc &desc,
vk::AttachmentOpsArray *opsOut);
static angle::Result MakeRenderPass(vk::Context *context,
const vk::RenderPassDesc &desc,
const vk::AttachmentOpsArray &ops,
vk::RenderPass *renderPass,
vk::RenderPassPerfCounters *renderPassCounters);
private:
angle::Result getRenderPassWithOpsImpl(ContextVk *contextVk,
const vk::RenderPassDesc &desc,
const vk::AttachmentOpsArray &attachmentOps,
bool updatePerfCounters,
const vk::RenderPass **renderPassOut);
angle::Result addCompatibleRenderPass(ContextVk *contextVk,
const vk::RenderPassDesc &desc,
const vk::RenderPass **renderPassOut);
// Use a two-layer caching scheme. The top level matches the "compatible" RenderPass elements.
// The second layer caches the attachment load/store ops and initial/final layout.
// Switch to `std::unordered_map` to retain pointer stability.
using InnerCache = std::unordered_map<vk::AttachmentOpsArray, vk::RenderPassHelper>;
using OuterCache = std::unordered_map<vk::RenderPassDesc, InnerCache>;
OuterCache mPayload;
CacheStats mCompatibleRenderPassCacheStats;
CacheStats mRenderPassWithOpsCacheStats;
};
enum class PipelineSource
{
// Pipeline created when warming up the program's pipeline cache
WarmUp,
// Monolithic pipeline created at draw time
Draw,
// Pipeline created at draw time by linking partial pipeline libraries
DrawLinked,
// Pipeline created for UtilsVk
Utils,
};
struct GraphicsPipelineDescCompleteHash
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &key) const
{
return key.hash(vk::GraphicsPipelineSubset::Complete);
}
};
struct GraphicsPipelineDescVertexInputHash
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &key) const
{
return key.hash(vk::GraphicsPipelineSubset::VertexInput);
}
};
struct GraphicsPipelineDescShadersHash
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &key) const
{
return key.hash(vk::GraphicsPipelineSubset::Shaders);
}
};
struct GraphicsPipelineDescFragmentOutputHash
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &key) const
{
return key.hash(vk::GraphicsPipelineSubset::FragmentOutput);
}
};
struct GraphicsPipelineDescCompleteKeyEqual
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &first,
const rx::vk::GraphicsPipelineDesc &second) const
{
return first.keyEqual(second, vk::GraphicsPipelineSubset::Complete);
}
};
struct GraphicsPipelineDescVertexInputKeyEqual
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &first,
const rx::vk::GraphicsPipelineDesc &second) const
{
return first.keyEqual(second, vk::GraphicsPipelineSubset::VertexInput);
}
};
struct GraphicsPipelineDescShadersKeyEqual
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &first,
const rx::vk::GraphicsPipelineDesc &second) const
{
return first.keyEqual(second, vk::GraphicsPipelineSubset::Shaders);
}
};
struct GraphicsPipelineDescFragmentOutputKeyEqual
{
size_t operator()(const rx::vk::GraphicsPipelineDesc &first,
const rx::vk::GraphicsPipelineDesc &second) const
{
return first.keyEqual(second, vk::GraphicsPipelineSubset::FragmentOutput);
}
};
// Derive the KeyEqual and GraphicsPipelineSubset enum from the Hash struct
template <typename Hash>
struct GraphicsPipelineCacheTypeHelper
{
using KeyEqual = GraphicsPipelineDescCompleteKeyEqual;
static constexpr vk::GraphicsPipelineSubset kSubset = vk::GraphicsPipelineSubset::Complete;
};
template <>
struct GraphicsPipelineCacheTypeHelper<GraphicsPipelineDescVertexInputHash>
{
using KeyEqual = GraphicsPipelineDescVertexInputKeyEqual;
static constexpr vk::GraphicsPipelineSubset kSubset = vk::GraphicsPipelineSubset::VertexInput;
};
template <>
struct GraphicsPipelineCacheTypeHelper<GraphicsPipelineDescShadersHash>
{
using KeyEqual = GraphicsPipelineDescShadersKeyEqual;
static constexpr vk::GraphicsPipelineSubset kSubset = vk::GraphicsPipelineSubset::Shaders;
};
template <>
struct GraphicsPipelineCacheTypeHelper<GraphicsPipelineDescFragmentOutputHash>
{
using KeyEqual = GraphicsPipelineDescFragmentOutputKeyEqual;
static constexpr vk::GraphicsPipelineSubset kSubset =
vk::GraphicsPipelineSubset::FragmentOutput;
};
// TODO(jmadill): Add cache trimming/eviction.
template <typename Hash>
class GraphicsPipelineCache final : public HasCacheStats<VulkanCacheType::GraphicsPipeline>
{
public:
GraphicsPipelineCache() = default;
~GraphicsPipelineCache() override { ASSERT(mPayload.empty()); }
void destroy(vk::Context *context);
void release(vk::Context *context);
void populate(const vk::GraphicsPipelineDesc &desc,
vk::Pipeline &&pipeline,
vk::PipelineHelper **pipelineHelperOut);
// Get a pipeline from the cache, if it exists
ANGLE_INLINE bool getPipeline(const vk::GraphicsPipelineDesc &desc,
const vk::GraphicsPipelineDesc **descPtrOut,
vk::PipelineHelper **pipelineOut)
{
auto item = mPayload.find(desc);
if (item == mPayload.end())
{
return false;
}
*descPtrOut = &item->first;
*pipelineOut = &item->second;
mCacheStats.hit();
return true;
}
angle::Result createPipeline(vk::Context *context,
vk::PipelineCacheAccess *pipelineCache,
const vk::RenderPass &compatibleRenderPass,
const vk::PipelineLayout &pipelineLayout,
const vk::ShaderModuleMap &shaders,
const vk::SpecializationConstants &specConsts,
PipelineSource source,
const vk::GraphicsPipelineDesc &desc,
const vk::GraphicsPipelineDesc **descPtrOut,
vk::PipelineHelper **pipelineOut);
angle::Result linkLibraries(vk::Context *context,
vk::PipelineCacheAccess *pipelineCache,
const vk::GraphicsPipelineDesc &desc,
const vk::PipelineLayout &pipelineLayout,
vk::PipelineHelper *vertexInputPipeline,
vk::PipelineHelper *shadersPipeline,
vk::PipelineHelper *fragmentOutputPipeline,
const vk::GraphicsPipelineDesc **descPtrOut,
vk::PipelineHelper **pipelineOut);
// Helper for VulkanPipelineCachePerf that resets the object without destroying any object.
void reset() { mPayload.clear(); }
private:
void addToCache(PipelineSource source,
const vk::GraphicsPipelineDesc &desc,
vk::Pipeline &&pipeline,
vk::CacheLookUpFeedback feedback,
const vk::GraphicsPipelineDesc **descPtrOut,
vk::PipelineHelper **pipelineOut);
using KeyEqual = typename GraphicsPipelineCacheTypeHelper<Hash>::KeyEqual;
std::unordered_map<vk::GraphicsPipelineDesc, vk::PipelineHelper, Hash, KeyEqual> mPayload;
};
using CompleteGraphicsPipelineCache = GraphicsPipelineCache<GraphicsPipelineDescCompleteHash>;
using VertexInputGraphicsPipelineCache = GraphicsPipelineCache<GraphicsPipelineDescVertexInputHash>;
using ShadersGraphicsPipelineCache = GraphicsPipelineCache<GraphicsPipelineDescShadersHash>;
using FragmentOutputGraphicsPipelineCache =
GraphicsPipelineCache<GraphicsPipelineDescFragmentOutputHash>;
class DescriptorSetLayoutCache final : angle::NonCopyable
{
public:
DescriptorSetLayoutCache();
~DescriptorSetLayoutCache();
void destroy(vk::Renderer *renderer);
angle::Result getDescriptorSetLayout(
vk::Context *context,
const vk::DescriptorSetLayoutDesc &desc,
vk::AtomicBindingPointer<vk::DescriptorSetLayout> *descriptorSetLayoutOut);
// Helpers for white box tests
size_t getCacheHitCount() const { return mCacheStats.getHitCount(); }
size_t getCacheMissCount() const { return mCacheStats.getMissCount(); }
private:
mutable angle::SimpleMutex mMutex;
std::unordered_map<vk::DescriptorSetLayoutDesc, vk::RefCountedDescriptorSetLayout> mPayload;
CacheStats mCacheStats;
};
class PipelineLayoutCache final : public HasCacheStats<VulkanCacheType::PipelineLayout>
{
public:
PipelineLayoutCache();
~PipelineLayoutCache() override;
void destroy(vk::Renderer *renderer);
angle::Result getPipelineLayout(
vk::Context *context,
const vk::PipelineLayoutDesc &desc,
const vk::DescriptorSetLayoutPointerArray &descriptorSetLayouts,
vk::AtomicBindingPointer<vk::PipelineLayout> *pipelineLayoutOut);
private:
mutable angle::SimpleMutex mMutex;
std::unordered_map<vk::PipelineLayoutDesc, vk::RefCountedPipelineLayout> mPayload;
};
class SamplerCache final : public HasCacheStats<VulkanCacheType::Sampler>
{
public:
SamplerCache();
~SamplerCache() override;
void destroy(vk::Renderer *renderer);
angle::Result getSampler(ContextVk *contextVk,
const vk::SamplerDesc &desc,
vk::SamplerBinding *samplerOut);
private:
std::unordered_map<vk::SamplerDesc, vk::RefCountedSampler> mPayload;
};
// YuvConversion Cache
class SamplerYcbcrConversionCache final
: public HasCacheStats<VulkanCacheType::SamplerYcbcrConversion>
{
public:
SamplerYcbcrConversionCache();
~SamplerYcbcrConversionCache() override;
void destroy(vk::Renderer *renderer);
angle::Result getSamplerYcbcrConversion(vk::Context *context,
const vk::YcbcrConversionDesc &ycbcrConversionDesc,
VkSamplerYcbcrConversion *vkSamplerYcbcrConversionOut);
private:
using SamplerYcbcrConversionMap =
std::unordered_map<vk::YcbcrConversionDesc, vk::SamplerYcbcrConversion>;
SamplerYcbcrConversionMap mExternalFormatPayload;
SamplerYcbcrConversionMap mVkFormatPayload;
};
// Descriptor Set Cache
class DescriptorSetCache final : angle::NonCopyable
{
public:
DescriptorSetCache() = default;
~DescriptorSetCache() { ASSERT(mPayload.empty()); }
DescriptorSetCache(DescriptorSetCache &&other) : DescriptorSetCache()
{
*this = std::move(other);
}
DescriptorSetCache &operator=(DescriptorSetCache &&other)
{
std::swap(mPayload, other.mPayload);
return *this;
}
void resetCache() { mPayload.clear(); }
ANGLE_INLINE bool getDescriptorSet(const vk::DescriptorSetDesc &desc,
VkDescriptorSet *descriptorSetOut,
vk::RefCountedDescriptorPoolHelper **poolOut)
{
auto iter = mPayload.find(desc);
if (iter != mPayload.end())
{
*descriptorSetOut = iter->second->getDescriptorSet();
*poolOut = iter->second->getPool();
return true;
}
return false;
}
ANGLE_INLINE void insertDescriptorSet(const vk::DescriptorSetDesc &desc,
VkDescriptorSet descriptorSet,
vk::RefCountedDescriptorPoolHelper *pool)
{
mPayload.emplace(desc, std::make_unique<dsCacheEntry>(descriptorSet, pool));
}
ANGLE_INLINE void eraseDescriptorSet(const vk::DescriptorSetDesc &desc)
{
mPayload.erase(desc);
}
ANGLE_INLINE size_t getTotalCacheSize() const { return mPayload.size(); }
size_t getTotalCacheKeySizeBytes() const
{
size_t totalSize = 0;
for (const auto &iter : mPayload)
{
const vk::DescriptorSetDesc &desc = iter.first;
totalSize += desc.getKeySizeBytes();
}
return totalSize;
}
bool empty() const { return mPayload.empty(); }
private:
class dsCacheEntry
{
public:
dsCacheEntry(VkDescriptorSet descriptorSet, vk::RefCountedDescriptorPoolHelper *pool)
: mDescriptorSet(descriptorSet), mPool(pool)
{}
VkDescriptorSet getDescriptorSet() const { return mDescriptorSet; }
vk::RefCountedDescriptorPoolHelper *getPool() const { return mPool; }
private:
VkDescriptorSet mDescriptorSet;
// Weak pointer to the pool this descriptorSet allocated from. The RefCount is tracking if
// this pool is bound as the current pool in any ProgramExecutableVk or not, so we should
// not add refcount from the cache.
vk::RefCountedDescriptorPoolHelper *mPool;
};
angle::HashMap<vk::DescriptorSetDesc, std::unique_ptr<dsCacheEntry>> mPayload;
};
// There is 1 default uniform binding used per stage.
constexpr uint32_t kReservedPerStageDefaultUniformBindingCount = 1;
class UpdateDescriptorSetsBuilder final : angle::NonCopyable
{
public:
UpdateDescriptorSetsBuilder();
~UpdateDescriptorSetsBuilder();
VkDescriptorBufferInfo *allocDescriptorBufferInfos(size_t count);
VkDescriptorImageInfo *allocDescriptorImageInfos(size_t count);
VkWriteDescriptorSet *allocWriteDescriptorSets(size_t count);
VkBufferView *allocBufferViews(size_t count);
VkDescriptorBufferInfo &allocDescriptorBufferInfo() { return *allocDescriptorBufferInfos(1); }
VkDescriptorImageInfo &allocDescriptorImageInfo() { return *allocDescriptorImageInfos(1); }
VkWriteDescriptorSet &allocWriteDescriptorSet() { return *allocWriteDescriptorSets(1); }
VkBufferView &allocBufferView() { return *allocBufferViews(1); }
// Returns the number of written descriptor sets.
uint32_t flushDescriptorSetUpdates(VkDevice device);
private:
template <typename T, const T *VkWriteDescriptorSet::*pInfo>
T *allocDescriptorInfos(std::vector<T> *descriptorVector, size_t count);
template <typename T, const T *VkWriteDescriptorSet::*pInfo>
void growDescriptorCapacity(std::vector<T> *descriptorVector, size_t newSize);
std::vector<VkDescriptorBufferInfo> mDescriptorBufferInfos;
std::vector<VkDescriptorImageInfo> mDescriptorImageInfos;
std::vector<VkWriteDescriptorSet> mWriteDescriptorSets;
std::vector<VkBufferView> mBufferViews;
};
} // namespace rx
#endif // LIBANGLE_RENDERER_VULKAN_VK_CACHE_UTILS_H_