1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
|
/*
Copyright 2017-2018 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "spirv_reflect.h"
#include <assert.h>
#include <stdbool.h>
#include <string.h>
#if defined(WIN32)
#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>
#else
#include <stdlib.h>
#endif
#if defined(SPIRV_REFLECT_ENABLE_ASSERTS)
#define SPV_REFLECT_ASSERT(COND) \
assert(COND);
#else
#define SPV_REFLECT_ASSERT(COND)
#endif
// Temporary enums until these make it into SPIR-V/Vulkan
// clang-format off
enum {
SpvReflectOpDecorateId = 332,
SpvReflectOpDecorateStringGOOGLE = 5632,
SpvReflectOpMemberDecorateStringGOOGLE = 5633,
SpvReflectDecorationHlslCounterBufferGOOGLE = 5634,
SpvReflectDecorationHlslSemanticGOOGLE = 5635
};
// clang-format on
// clang-format off
enum {
SPIRV_STARTING_WORD_INDEX = 5,
SPIRV_WORD_SIZE = sizeof(uint32_t),
SPIRV_BYTE_WIDTH = 8,
SPIRV_MINIMUM_FILE_SIZE = SPIRV_STARTING_WORD_INDEX * SPIRV_WORD_SIZE,
SPIRV_DATA_ALIGNMENT = 4 * SPIRV_WORD_SIZE, // 16
SPIRV_ACCESS_CHAIN_INDEX_OFFSET = 4,
};
// clang-format on
// clang-format off
enum {
INVALID_VALUE = 0xFFFFFFFF,
};
// clang-format on
// clang-format off
enum {
MAX_NODE_NAME_LENGTH = 1024,
};
// clang-format on
// clang-format off
enum {
IMAGE_SAMPLED = 1,
IMAGE_STORAGE = 2
};
// clang-format on
// clang-format off
typedef struct ArrayTraits {
uint32_t element_type_id;
uint32_t length_id;
} ArrayTraits;
// clang-format on
// clang-format off
typedef struct ImageTraits {
uint32_t sampled_type_id;
SpvDim dim;
uint32_t depth;
uint32_t arrayed;
uint32_t ms;
uint32_t sampled;
SpvImageFormat image_format;
} ImageTraits;
// clang-format on
// clang-format off
typedef struct NumberDecoration {
uint32_t word_offset;
uint32_t value;
} NumberDecoration;
// clang-format on
// clang-format off
typedef struct StringDecoration {
uint32_t word_offset;
const char* value;
} StringDecoration;
// clang-format on
// clang-format off
typedef struct Decorations {
bool is_block;
bool is_buffer_block;
bool is_row_major;
bool is_column_major;
bool is_built_in;
bool is_noperspective;
bool is_flat;
bool is_non_writable;
NumberDecoration set;
NumberDecoration binding;
NumberDecoration input_attachment_index;
NumberDecoration location;
NumberDecoration offset;
NumberDecoration uav_counter_buffer;
StringDecoration semantic;
uint32_t array_stride;
uint32_t matrix_stride;
SpvBuiltIn built_in;
} Decorations;
// clang-format on
// clang-format off
typedef struct Node {
uint32_t result_id;
SpvOp op;
uint32_t result_type_id;
uint32_t type_id;
SpvStorageClass storage_class;
uint32_t word_offset;
uint32_t word_count;
bool is_type;
ArrayTraits array_traits;
ImageTraits image_traits;
uint32_t image_type_id;
const char* name;
Decorations decorations;
uint32_t member_count;
const char** member_names;
Decorations* member_decorations;
} Node;
// clang-format on
// clang-format off
typedef struct String {
uint32_t result_id;
const char* string;
} String;
// clang-format on
// clang-format off
typedef struct Function {
uint32_t id;
uint32_t callee_count;
uint32_t* callees;
struct Function** callee_ptrs;
uint32_t accessed_ptr_count;
uint32_t* accessed_ptrs;
} Function;
// clang-format on
// clang-format off
typedef struct AccessChain {
uint32_t result_id;
uint32_t result_type_id;
//
// Pointing to the base of a composite object.
// Generally the id of descriptor block variable
uint32_t base_id;
//
// From spec:
// The first index in Indexes will select the
// top-level member/element/component/element
// of the base composite
uint32_t index_count;
uint32_t* indexes;
} AccessChain;
// clang-format on
// clang-format off
typedef struct Parser {
size_t spirv_word_count;
uint32_t* spirv_code;
uint32_t string_count;
String* strings;
SpvSourceLanguage source_language;
uint32_t source_language_version;
uint32_t source_file_id;
const char* source_embedded;
size_t node_count;
Node* nodes;
uint32_t entry_point_count;
uint32_t function_count;
Function* functions;
uint32_t access_chain_count;
AccessChain* access_chains;
uint32_t type_count;
uint32_t descriptor_count;
uint32_t push_constant_count;
} Parser;
// clang-format on
static uint32_t Max(uint32_t a, uint32_t b)
{
return a > b ? a : b;
}
static uint32_t RoundUp(uint32_t value, uint32_t multiple)
{
assert(multiple && ((multiple & (multiple - 1)) == 0));
return (value + multiple - 1) & ~(multiple - 1);
}
#define IsNull(ptr) \
(ptr == NULL)
#define IsNotNull(ptr) \
(ptr != NULL)
#define SafeFree(ptr) \
{ \
if (ptr != NULL) { \
free((void*)ptr); \
ptr = NULL; \
} \
}
static int SortCompareUint32(const void* a, const void* b)
{
const uint32_t* p_a = (const uint32_t*)a;
const uint32_t* p_b = (const uint32_t*)b;
return (int)*p_a - (int)*p_b;
}
//
// De-duplicates a sorted array and returns the new size.
//
// Note: The array doesn't actually need to be sorted, just
// arranged into "runs" so that all the entries with one
// value are adjacent.
//
static size_t DedupSortedUint32(uint32_t* arr, size_t size)
{
if (size == 0) {
return 0;
}
size_t dedup_idx = 0;
for (size_t i = 0; i < size; ++i) {
if (arr[dedup_idx] != arr[i]) {
++dedup_idx;
arr[dedup_idx] = arr[i];
}
}
return dedup_idx+1;
}
static bool SearchSortedUint32(const uint32_t* arr, size_t size, uint32_t target)
{
size_t lo = 0;
size_t hi = size;
while (lo < hi) {
size_t mid = (hi - lo) / 2 + lo;
if (arr[mid] == target) {
return true;
} else if (arr[mid] < target) {
lo = mid+1;
} else {
hi = mid;
}
}
return false;
}
static SpvReflectResult IntersectSortedUint32(
const uint32_t* p_arr0,
size_t arr0_size,
const uint32_t* p_arr1,
size_t arr1_size,
uint32_t** pp_res,
size_t* res_size
)
{
*res_size = 0;
const uint32_t* arr0_end = p_arr0 + arr0_size;
const uint32_t* arr1_end = p_arr1 + arr1_size;
const uint32_t* idx0 = p_arr0;
const uint32_t* idx1 = p_arr1;
while (idx0 != arr0_end && idx1 != arr1_end) {
if (*idx0 < *idx1) {
++idx0;
} else if (*idx0 > *idx1) {
++idx1;
} else {
++*res_size;
++idx0;
++idx1;
}
}
*pp_res = NULL;
if (*res_size > 0) {
*pp_res = (uint32_t*)calloc(*res_size, sizeof(**pp_res));
if (IsNull(*pp_res)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
uint32_t* idxr = *pp_res;
idx0 = p_arr0;
idx1 = p_arr1;
while (idx0 != arr0_end && idx1 != arr1_end) {
if (*idx0 < *idx1) {
++idx0;
} else if (*idx0 > *idx1) {
++idx1;
} else {
*(idxr++) = *idx0;
++idx0;
++idx1;
}
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static bool InRange(const Parser* p_parser, uint32_t index)
{
bool in_range = false;
if (IsNotNull(p_parser)) {
in_range = (index < p_parser->spirv_word_count);
}
return in_range;
}
static SpvReflectResult ReadU32(Parser* p_parser, uint32_t word_offset, uint32_t* p_value)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
assert(InRange(p_parser, word_offset));
SpvReflectResult result = SPV_REFLECT_RESULT_ERROR_SPIRV_UNEXPECTED_EOF;
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && InRange(p_parser, word_offset)) {
*p_value = *(p_parser->spirv_code + word_offset);
result = SPV_REFLECT_RESULT_SUCCESS;
}
return result;
}
#define CHECKED_READU32(parser, word_offset, value) \
{ \
SpvReflectResult checked_readu32_result = ReadU32(parser, \
word_offset, (uint32_t*)&(value)); \
if (checked_readu32_result != SPV_REFLECT_RESULT_SUCCESS) { \
return checked_readu32_result; \
} \
}
#define CHECKED_READU32_CAST(parser, word_offset, cast_to_type, value) \
{ \
uint32_t checked_readu32_cast_u32 = UINT32_MAX; \
SpvReflectResult checked_readu32_cast_result = ReadU32(parser, \
word_offset, \
(uint32_t*)&(checked_readu32_cast_u32)); \
if (checked_readu32_cast_result != SPV_REFLECT_RESULT_SUCCESS) { \
return checked_readu32_cast_result; \
} \
value = (cast_to_type)checked_readu32_cast_u32; \
}
#define IF_READU32(result, parser, word_offset, value) \
if ((result) == SPV_REFLECT_RESULT_SUCCESS) { \
result = ReadU32(parser, word_offset, (uint32_t*)&(value)); \
}
#define IF_READU32_CAST(result, parser, word_offset, cast_to_type, value) \
if ((result) == SPV_REFLECT_RESULT_SUCCESS) { \
uint32_t if_readu32_cast_u32 = UINT32_MAX; \
result = ReadU32(parser, word_offset, &if_readu32_cast_u32); \
if ((result) == SPV_REFLECT_RESULT_SUCCESS) { \
value = (cast_to_type)if_readu32_cast_u32; \
} \
}
static SpvReflectResult ReadStr(
Parser* p_parser,
uint32_t word_offset,
uint32_t word_index,
uint32_t word_count,
uint32_t* p_buf_size,
char* p_buf
)
{
uint32_t limit = (word_offset + word_count);
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
assert(InRange(p_parser, limit));
SpvReflectResult result = SPV_REFLECT_RESULT_ERROR_SPIRV_UNEXPECTED_EOF;
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && InRange(p_parser, limit)) {
const char* c_str = (const char*)(p_parser->spirv_code + word_offset + word_index);
uint32_t n = word_count * SPIRV_WORD_SIZE;
uint32_t length_with_terminator = 0;
for (uint32_t i = 0; i < n; ++i) {
char c = *(c_str + i);
if (c == 0) {
length_with_terminator = i + 1;
break;
}
}
if (length_with_terminator > 0) {
result = SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
if (IsNotNull(p_buf_size) && IsNotNull(p_buf)) {
result = SPV_REFLECT_RESULT_ERROR_RANGE_EXCEEDED;
if (length_with_terminator <= *p_buf_size) {
memset(p_buf, 0, *p_buf_size);
memcpy(p_buf, c_str, length_with_terminator);
result = SPV_REFLECT_RESULT_SUCCESS;
}
}
else {
if (IsNotNull(p_buf_size)) {
*p_buf_size = length_with_terminator;
result = SPV_REFLECT_RESULT_SUCCESS;
}
}
}
}
return result;
}
static SpvReflectDecorationFlags ApplyDecorations(const Decorations* p_decoration_fields)
{
SpvReflectDecorationFlags decorations = SPV_REFLECT_DECORATION_NONE;
if (p_decoration_fields->is_block) {
decorations |= SPV_REFLECT_DECORATION_BLOCK;
}
if (p_decoration_fields->is_buffer_block) {
decorations |= SPV_REFLECT_DECORATION_BUFFER_BLOCK;
}
if (p_decoration_fields->is_row_major) {
decorations |= SPV_REFLECT_DECORATION_ROW_MAJOR;
}
if (p_decoration_fields->is_column_major) {
decorations |= SPV_REFLECT_DECORATION_COLUMN_MAJOR;
}
if (p_decoration_fields->is_built_in) {
decorations |= SPV_REFLECT_DECORATION_BUILT_IN;
}
if (p_decoration_fields->is_noperspective) {
decorations |= SPV_REFLECT_DECORATION_NOPERSPECTIVE;
}
if (p_decoration_fields->is_flat) {
decorations |= SPV_REFLECT_DECORATION_FLAT;
}
if (p_decoration_fields->is_non_writable) {
decorations |= SPV_REFLECT_DECORATION_NON_WRITABLE;
}
return decorations;
}
static void ApplyNumericTraits(const SpvReflectTypeDescription* p_type, SpvReflectNumericTraits* p_numeric_traits)
{
memcpy(p_numeric_traits, &p_type->traits.numeric, sizeof(p_type->traits.numeric));
}
static void ApplyArrayTraits(const SpvReflectTypeDescription* p_type, SpvReflectArrayTraits* p_array_traits)
{
memcpy(p_array_traits, &p_type->traits.array, sizeof(p_type->traits.array));
}
static Node* FindNode(Parser* p_parser, uint32_t result_id)
{
Node* p_node = NULL;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_elem = &(p_parser->nodes[i]);
if (p_elem->result_id == result_id) {
p_node = p_elem;
break;
}
}
return p_node;
}
static SpvReflectTypeDescription* FindType(SpvReflectShaderModule* p_module, uint32_t type_id)
{
SpvReflectTypeDescription* p_type = NULL;
for (size_t i = 0; i < p_module->_internal->type_description_count; ++i) {
SpvReflectTypeDescription* p_elem = &(p_module->_internal->type_descriptions[i]);
if (p_elem->id == type_id) {
p_type = p_elem;
break;
}
}
return p_type;
}
static SpvReflectResult CreateParser(size_t size, void* p_code, Parser* p_parser)
{
if (p_code == NULL) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (size < SPIRV_MINIMUM_FILE_SIZE) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_CODE_SIZE;
}
if ((size % 4) != 0) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_CODE_SIZE;
}
p_parser->spirv_word_count = size / SPIRV_WORD_SIZE;
p_parser->spirv_code = (uint32_t*)p_code;
if (p_parser->spirv_code[0] != SpvMagicNumber) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_MAGIC_NUMBER;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static void DestroyParser(Parser* p_parser)
{
if (!IsNull(p_parser->nodes)) {
// Free nodes
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (IsNotNull(p_node->member_names)) {
SafeFree(p_node->member_names);
}
if (IsNotNull(p_node->member_decorations)) {
SafeFree(p_node->member_decorations);
}
}
// Free functions
for (size_t i = 0; i < p_parser->function_count; ++i) {
SafeFree(p_parser->functions[i].callees);
SafeFree(p_parser->functions[i].callee_ptrs);
SafeFree(p_parser->functions[i].accessed_ptrs);
}
// Free access chains
for (uint32_t i = 0; i < p_parser->access_chain_count; ++i) {
SafeFree(p_parser->access_chains[i].indexes);
}
SafeFree(p_parser->nodes);
SafeFree(p_parser->strings);
SafeFree(p_parser->source_embedded);
SafeFree(p_parser->functions);
SafeFree(p_parser->access_chains);
p_parser->node_count = 0;
}
}
static SpvReflectResult ParseNodes(Parser* p_parser)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
uint32_t* p_spirv = p_parser->spirv_code;
uint32_t spirv_word_index = SPIRV_STARTING_WORD_INDEX;
// Count nodes
uint32_t node_count = 0;
while (spirv_word_index < p_parser->spirv_word_count) {
uint32_t word = p_spirv[spirv_word_index];
SpvOp op = (SpvOp)(word & 0xFFFF);
uint32_t node_word_count = (word >> 16) & 0xFFFF;
if (node_word_count == 0) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_INSTRUCTION;
}
if (op == SpvOpAccessChain) {
++(p_parser->access_chain_count);
}
spirv_word_index += node_word_count;
++node_count;
}
if (node_count == 0) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_UNEXPECTED_EOF;
}
// Allocate nodes
p_parser->node_count = node_count;
p_parser->nodes = (Node*)calloc(p_parser->node_count, sizeof(*(p_parser->nodes)));
if (IsNull(p_parser->nodes)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
// Mark all nodes with an invalid state
for (uint32_t i = 0; i < node_count; ++i) {
p_parser->nodes[i].op = (SpvOp)INVALID_VALUE;
p_parser->nodes[i].storage_class = (SpvStorageClass)INVALID_VALUE;
p_parser->nodes[i].decorations.set.value = (uint32_t)INVALID_VALUE;
p_parser->nodes[i].decorations.binding.value = (uint32_t)INVALID_VALUE;
p_parser->nodes[i].decorations.location.value = (uint32_t)INVALID_VALUE;
p_parser->nodes[i].decorations.offset.value = (uint32_t)INVALID_VALUE;
p_parser->nodes[i].decorations.uav_counter_buffer.value = (uint32_t)INVALID_VALUE;
p_parser->nodes[i].decorations.built_in = (SpvBuiltIn)INVALID_VALUE;
}
// Mark source file id node
p_parser->source_file_id = (uint32_t)INVALID_VALUE;
p_parser->source_embedded = NULL;
// Function node
uint32_t function_node = (uint32_t)INVALID_VALUE;
// Allocate access chain
if (p_parser->access_chain_count > 0) {
p_parser->access_chains = (AccessChain*)calloc(p_parser->access_chain_count, sizeof(*(p_parser->access_chains)));
if (IsNull(p_parser->access_chains)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
// Parse nodes
uint32_t node_index = 0;
uint32_t access_chain_index = 0;
spirv_word_index = SPIRV_STARTING_WORD_INDEX;
while (spirv_word_index < p_parser->spirv_word_count) {
uint32_t word = p_spirv[spirv_word_index];
SpvOp op = (SpvOp)(word & 0xFFFF);
uint32_t node_word_count = (word >> 16) & 0xFFFF;
Node* p_node = &(p_parser->nodes[node_index]);
p_node->op = op;
p_node->word_offset = spirv_word_index;
p_node->word_count = node_word_count;
switch (p_node->op) {
default: break;
case SpvOpString: {
++(p_parser->string_count);
}
break;
case SpvOpSource: {
CHECKED_READU32_CAST(p_parser, p_node->word_offset + 1, SpvSourceLanguage, p_parser->source_language);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_parser->source_language_version);
if (p_node->word_count >= 4) {
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_parser->source_file_id);
}
if (p_node->word_count >= 5) {
const char* p_source = (const char*)(p_parser->spirv_code + p_node->word_offset + 4);
const size_t source_len = strlen(p_source);
char* p_source_temp = (char*)calloc(source_len + 1, sizeof(char*));
if (IsNull(p_source_temp)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
#ifdef _WIN32
strcpy_s(p_source_temp, source_len + 1, p_source);
#else
strcpy(p_source_temp, p_source);
#endif
p_parser->source_embedded = p_source_temp;
}
}
break;
case SpvOpSourceContinued: {
const char* p_source = (const char*)(p_parser->spirv_code + p_node->word_offset + 1);
const size_t source_len = strlen(p_source);
const size_t embedded_source_len = strlen(p_parser->source_embedded);
char* p_continued_source = (char*)calloc(source_len + embedded_source_len + 1, sizeof(char*));
if (IsNull(p_continued_source)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
#ifdef _WIN32
strcpy_s(p_continued_source, embedded_source_len + 1, p_parser->source_embedded);
strcat_s(p_continued_source, source_len + 1, p_source);
#else
strcpy(p_continued_source, p_parser->source_embedded);
strcat(p_continued_source, p_source);
#endif
SafeFree(p_parser->source_embedded);
p_parser->source_embedded = p_continued_source;
}
break;
case SpvOpEntryPoint: {
++(p_parser->entry_point_count);
}
break;
case SpvOpName:
case SpvOpMemberName:
{
uint32_t member_offset = (p_node->op == SpvOpMemberName) ? 1 : 0;
uint32_t name_start = p_node->word_offset + member_offset + 2;
p_node->name = (const char*)(p_parser->spirv_code + name_start);
}
break;
case SpvOpTypeStruct:
{
p_node->member_count = p_node->word_count - 2;
} // Fall through
case SpvOpTypeVoid:
case SpvOpTypeBool:
case SpvOpTypeInt:
case SpvOpTypeFloat:
case SpvOpTypeVector:
case SpvOpTypeMatrix:
case SpvOpTypeSampler:
case SpvOpTypeOpaque:
case SpvOpTypeFunction:
case SpvOpTypeEvent:
case SpvOpTypeDeviceEvent:
case SpvOpTypeReserveId:
case SpvOpTypeQueue:
case SpvOpTypePipe:
case SpvOpTypeAccelerationStructureKHR:
case SpvOpTypeRayQueryKHR:
{
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
p_node->is_type = true;
}
break;
case SpvOpTypeImage: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->image_traits.sampled_type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_node->image_traits.dim);
CHECKED_READU32(p_parser, p_node->word_offset + 4, p_node->image_traits.depth);
CHECKED_READU32(p_parser, p_node->word_offset + 5, p_node->image_traits.arrayed);
CHECKED_READU32(p_parser, p_node->word_offset + 6, p_node->image_traits.ms);
CHECKED_READU32(p_parser, p_node->word_offset + 7, p_node->image_traits.sampled);
CHECKED_READU32(p_parser, p_node->word_offset + 8, p_node->image_traits.image_format);
p_node->is_type = true;
}
break;
case SpvOpTypeSampledImage: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->image_type_id);
p_node->is_type = true;
}
break;
case SpvOpTypeArray: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->array_traits.element_type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_node->array_traits.length_id);
p_node->is_type = true;
}
break;
case SpvOpTypeRuntimeArray: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->array_traits.element_type_id);
p_node->is_type = true;
}
break;
case SpvOpTypePointer: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->storage_class);
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_node->type_id);
p_node->is_type = true;
}
break;
case SpvOpTypeForwardPointer:
{
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->storage_class);
p_node->is_type = true;
}
break;
case SpvOpConstantTrue:
case SpvOpConstantFalse:
case SpvOpConstant:
case SpvOpConstantComposite:
case SpvOpConstantSampler:
case SpvOpConstantNull: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->result_id);
}
break;
case SpvOpSpecConstantTrue:
case SpvOpSpecConstantFalse:
case SpvOpSpecConstant:
case SpvOpSpecConstantComposite:
case SpvOpSpecConstantOp: {
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->result_id);
}
break;
case SpvOpVariable:
{
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_node->storage_class);
}
break;
case SpvOpLoad:
{
// Only load enough so OpDecorate can reference the node, skip the remaining operands.
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_node->result_type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->result_id);
}
break;
case SpvOpAccessChain:
{
AccessChain* p_access_chain = &(p_parser->access_chains[access_chain_index]);
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_access_chain->result_type_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_access_chain->result_id);
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_access_chain->base_id);
//
// SPIRV_ACCESS_CHAIN_INDEX_OFFSET (4) is the number of words up until the first index:
// [Node, Result Type Id, Result Id, Base Id, <Indexes>]
//
p_access_chain->index_count = (node_word_count - SPIRV_ACCESS_CHAIN_INDEX_OFFSET);
if (p_access_chain->index_count > 0) {
p_access_chain->indexes = (uint32_t*)calloc(p_access_chain->index_count, sizeof(*(p_access_chain->indexes)));
if (IsNull( p_access_chain->indexes)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
// Parse any index values for access chain
for (uint32_t index_index = 0; index_index < p_access_chain->index_count; ++index_index) {
// Read index id
uint32_t index_id = 0;
CHECKED_READU32(p_parser, p_node->word_offset + SPIRV_ACCESS_CHAIN_INDEX_OFFSET + index_index, index_id);
// Find OpConstant node that contains index value
Node* p_index_value_node = FindNode(p_parser, index_id);
if ((p_index_value_node != NULL) && (p_index_value_node->op == SpvOpConstant)) {
// Read index value
uint32_t index_value = UINT32_MAX;
CHECKED_READU32(p_parser, p_index_value_node->word_offset + 3, index_value);
assert(index_value != UINT32_MAX);
// Write index value to array
p_access_chain->indexes[index_index] = index_value;
}
}
}
++access_chain_index;
}
break;
case SpvOpFunction:
{
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_node->result_id);
// Count function definitions, not function declarations. To determine
// the difference, set an in-function variable, and then if an OpLabel
// is reached before the end of the function increment the function
// count.
function_node = node_index;
}
break;
case SpvOpLabel:
{
if (function_node != (uint32_t)INVALID_VALUE) {
Node* p_func_node = &(p_parser->nodes[function_node]);
CHECKED_READU32(p_parser, p_func_node->word_offset + 2, p_func_node->result_id);
++(p_parser->function_count);
}
} // Fall through
case SpvOpFunctionEnd:
{
function_node = (uint32_t)INVALID_VALUE;
}
break;
}
if (p_node->is_type) {
++(p_parser->type_count);
}
spirv_word_index += node_word_count;
++node_index;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseStrings(Parser* p_parser)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
assert(IsNotNull(p_parser->nodes));
// Early out
if (p_parser->string_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && IsNotNull(p_parser->nodes)) {
// Allocate string storage
p_parser->strings = (String*)calloc(p_parser->string_count, sizeof(*(p_parser->strings)));
uint32_t string_index = 0;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (p_node->op != SpvOpString) {
continue;
}
// Paranoid check against string count
assert(string_index < p_parser->string_count);
if (string_index >= p_parser->string_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
// Result id
String* p_string = &(p_parser->strings[string_index]);
CHECKED_READU32(p_parser, p_node->word_offset + 1, p_string->result_id);
// String
uint32_t string_start = p_node->word_offset + 2;
p_string->string = (const char*)(p_parser->spirv_code + string_start);
// Increment string index
++string_index;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseSource(Parser* p_parser, SpvReflectShaderModule* p_module)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code)) {
// Source file
if (IsNotNull(p_parser->strings)) {
for (uint32_t i = 0; i < p_parser->string_count; ++i) {
String* p_string = &(p_parser->strings[i]);
if (p_string->result_id == p_parser->source_file_id) {
p_module->source_file = p_string->string;
break;
}
}
}
//Source code
if (IsNotNull(p_parser->source_embedded))
{
const size_t source_len = strlen(p_parser->source_embedded);
char* p_source = (char*)calloc(source_len + 1, sizeof(char*));
if (IsNull(p_source)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
#ifdef _WIN32
strcpy_s(p_source, source_len + 1, p_parser->source_embedded);
#else
strcpy(p_source, p_parser->source_embedded);
#endif
p_module->source_source = p_source;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseFunction(Parser* p_parser, Node* p_func_node, Function* p_func, size_t first_label_index)
{
p_func->id = p_func_node->result_id;
p_func->callee_count = 0;
p_func->accessed_ptr_count = 0;
for (size_t i = first_label_index; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (p_node->op == SpvOpFunctionEnd) {
break;
}
switch (p_node->op) {
case SpvOpFunctionCall: {
++(p_func->callee_count);
}
break;
case SpvOpLoad:
case SpvOpAccessChain:
case SpvOpInBoundsAccessChain:
case SpvOpPtrAccessChain:
case SpvOpArrayLength:
case SpvOpGenericPtrMemSemantics:
case SpvOpInBoundsPtrAccessChain:
case SpvOpStore:
{
++(p_func->accessed_ptr_count);
}
break;
case SpvOpCopyMemory:
case SpvOpCopyMemorySized:
{
p_func->accessed_ptr_count += 2;
}
break;
default: break;
}
}
if (p_func->callee_count > 0) {
p_func->callees = (uint32_t*)calloc(p_func->callee_count,
sizeof(*(p_func->callees)));
if (IsNull(p_func->callees)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
if (p_func->accessed_ptr_count > 0) {
p_func->accessed_ptrs = (uint32_t*)calloc(p_func->accessed_ptr_count,
sizeof(*(p_func->accessed_ptrs)));
if (IsNull(p_func->accessed_ptrs)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
p_func->callee_count = 0;
p_func->accessed_ptr_count = 0;
for (size_t i = first_label_index; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (p_node->op == SpvOpFunctionEnd) {
break;
}
switch (p_node->op) {
case SpvOpFunctionCall: {
CHECKED_READU32(p_parser, p_node->word_offset + 3,
p_func->callees[p_func->callee_count]);
(++p_func->callee_count);
}
break;
case SpvOpLoad:
case SpvOpAccessChain:
case SpvOpInBoundsAccessChain:
case SpvOpPtrAccessChain:
case SpvOpArrayLength:
case SpvOpGenericPtrMemSemantics:
case SpvOpInBoundsPtrAccessChain:
{
CHECKED_READU32(p_parser, p_node->word_offset + 3,
p_func->accessed_ptrs[p_func->accessed_ptr_count]);
(++p_func->accessed_ptr_count);
}
break;
case SpvOpStore:
{
CHECKED_READU32(p_parser, p_node->word_offset + 2,
p_func->accessed_ptrs[p_func->accessed_ptr_count]);
(++p_func->accessed_ptr_count);
}
break;
case SpvOpCopyMemory:
case SpvOpCopyMemorySized:
{
CHECKED_READU32(p_parser, p_node->word_offset + 2,
p_func->accessed_ptrs[p_func->accessed_ptr_count]);
(++p_func->accessed_ptr_count);
CHECKED_READU32(p_parser, p_node->word_offset + 3,
p_func->accessed_ptrs[p_func->accessed_ptr_count]);
(++p_func->accessed_ptr_count);
}
break;
default: break;
}
}
if (p_func->callee_count > 0) {
qsort(p_func->callees, p_func->callee_count,
sizeof(*(p_func->callees)), SortCompareUint32);
}
p_func->callee_count = (uint32_t)DedupSortedUint32(p_func->callees,
p_func->callee_count);
if (p_func->accessed_ptr_count > 0) {
qsort(p_func->accessed_ptrs, p_func->accessed_ptr_count,
sizeof(*(p_func->accessed_ptrs)), SortCompareUint32);
}
p_func->accessed_ptr_count = (uint32_t)DedupSortedUint32(p_func->accessed_ptrs,
p_func->accessed_ptr_count);
return SPV_REFLECT_RESULT_SUCCESS;
}
static int SortCompareFunctions(const void* a, const void* b)
{
const Function* af = (const Function*)a;
const Function* bf = (const Function*)b;
return (int)af->id - (int)bf->id;
}
static SpvReflectResult ParseFunctions(Parser* p_parser)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
assert(IsNotNull(p_parser->nodes));
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && IsNotNull(p_parser->nodes)) {
if (p_parser->function_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
p_parser->functions = (Function*)calloc(p_parser->function_count,
sizeof(*(p_parser->functions)));
if (IsNull(p_parser->functions)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
size_t function_index = 0;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (p_node->op != SpvOpFunction) {
continue;
}
// Skip over function declarations that aren't definitions
bool func_definition = false;
// Intentionally reuse i to avoid iterating over these nodes more than
// once
for (; i < p_parser->node_count; ++i) {
if (p_parser->nodes[i].op == SpvOpLabel) {
func_definition = true;
break;
}
if (p_parser->nodes[i].op == SpvOpFunctionEnd) {
break;
}
}
if (!func_definition) {
continue;
}
Function* p_function = &(p_parser->functions[function_index]);
SpvReflectResult result = ParseFunction(p_parser, p_node, p_function, i);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
++function_index;
}
qsort(p_parser->functions, p_parser->function_count,
sizeof(*(p_parser->functions)), SortCompareFunctions);
// Once they're sorted, link the functions with pointers to improve graph
// traversal efficiency
for (size_t i = 0; i < p_parser->function_count; ++i) {
Function* p_func = &(p_parser->functions[i]);
if (p_func->callee_count == 0) {
continue;
}
p_func->callee_ptrs = (Function**)calloc(p_func->callee_count,
sizeof(*(p_func->callee_ptrs)));
for (size_t j = 0, k = 0; j < p_func->callee_count; ++j) {
while (p_parser->functions[k].id != p_func->callees[j]) {
++k;
if (k >= p_parser->function_count) {
// Invalid called function ID somewhere
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
}
p_func->callee_ptrs[j] = &(p_parser->functions[k]);
}
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseMemberCounts(Parser* p_parser)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
assert(IsNotNull(p_parser->nodes));
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && IsNotNull(p_parser->nodes)) {
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if ((p_node->op != SpvOpMemberName) && (p_node->op != SpvOpMemberDecorate)) {
continue;
}
uint32_t target_id = 0;
uint32_t member_index = (uint32_t)INVALID_VALUE;
CHECKED_READU32(p_parser, p_node->word_offset + 1, target_id);
CHECKED_READU32(p_parser, p_node->word_offset + 2, member_index);
Node* p_target_node = FindNode(p_parser, target_id);
// Not all nodes get parsed, so FindNode returning NULL is expected.
if (IsNull(p_target_node)) {
continue;
}
if (member_index == INVALID_VALUE) {
return SPV_REFLECT_RESULT_ERROR_RANGE_EXCEEDED;
}
p_target_node->member_count = Max(p_target_node->member_count, member_index + 1);
}
for (uint32_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (p_node->member_count == 0) {
continue;
}
p_node->member_names = (const char **)calloc(p_node->member_count, sizeof(*(p_node->member_names)));
if (IsNull(p_node->member_names)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
p_node->member_decorations = (Decorations*)calloc(p_node->member_count, sizeof(*(p_node->member_decorations)));
if (IsNull(p_node->member_decorations)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseNames(Parser* p_parser)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->spirv_code));
assert(IsNotNull(p_parser->nodes));
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && IsNotNull(p_parser->nodes)) {
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if ((p_node->op != SpvOpName) && (p_node->op != SpvOpMemberName)) {
continue;
}
uint32_t target_id = 0;
CHECKED_READU32(p_parser, p_node->word_offset + 1, target_id);
Node* p_target_node = FindNode(p_parser, target_id);
// Not all nodes get parsed, so FindNode returning NULL is expected.
if (IsNull(p_target_node)) {
continue;
}
const char** pp_target_name = &(p_target_node->name);
if (p_node->op == SpvOpMemberName) {
uint32_t member_index = UINT32_MAX;
CHECKED_READU32(p_parser, p_node->word_offset + 2, member_index);
pp_target_name = &(p_target_node->member_names[member_index]);
}
*pp_target_name = p_node->name;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseDecorations(Parser* p_parser)
{
for (uint32_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (((uint32_t)p_node->op != (uint32_t)SpvOpDecorate) &&
((uint32_t)p_node->op != (uint32_t)SpvOpMemberDecorate) &&
((uint32_t)p_node->op != (uint32_t)SpvReflectOpDecorateId) &&
((uint32_t)p_node->op != (uint32_t)SpvReflectOpDecorateStringGOOGLE) &&
((uint32_t)p_node->op != (uint32_t)SpvReflectOpMemberDecorateStringGOOGLE))
{
continue;
}
// Need to adjust the read offset if this is a member decoration
uint32_t member_offset = 0;
if (p_node->op == SpvOpMemberDecorate) {
member_offset = 1;
}
// Get decoration
uint32_t decoration = (uint32_t)INVALID_VALUE;
CHECKED_READU32(p_parser, p_node->word_offset + member_offset + 2, decoration);
// Filter out the decoration that do not affect reflection, otherwise
// there will be random crashes because the nodes aren't found.
bool skip = false;
switch (decoration) {
default: {
skip = true;
}
break;
case SpvDecorationBlock:
case SpvDecorationBufferBlock:
case SpvDecorationColMajor:
case SpvDecorationRowMajor:
case SpvDecorationArrayStride:
case SpvDecorationMatrixStride:
case SpvDecorationBuiltIn:
case SpvDecorationNoPerspective:
case SpvDecorationFlat:
case SpvDecorationNonWritable:
case SpvDecorationLocation:
case SpvDecorationBinding:
case SpvDecorationDescriptorSet:
case SpvDecorationOffset:
case SpvDecorationInputAttachmentIndex:
case SpvReflectDecorationHlslCounterBufferGOOGLE:
case SpvReflectDecorationHlslSemanticGOOGLE: {
skip = false;
}
break;
}
if (skip) {
continue;
}
// Find target target node
uint32_t target_id = 0;
CHECKED_READU32(p_parser, p_node->word_offset + 1, target_id);
Node* p_target_node = FindNode(p_parser, target_id);
if (IsNull(p_target_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Get decorations
Decorations* p_target_decorations = &(p_target_node->decorations);
// Update pointer if this is a member member decoration
if (p_node->op == SpvOpMemberDecorate) {
uint32_t member_index = (uint32_t)INVALID_VALUE;
CHECKED_READU32(p_parser, p_node->word_offset + 2, member_index);
p_target_decorations = &(p_target_node->member_decorations[member_index]);
}
switch (decoration) {
default: break;
case SpvDecorationBlock: {
p_target_decorations->is_block = true;
}
break;
case SpvDecorationBufferBlock: {
p_target_decorations->is_buffer_block = true;
}
break;
case SpvDecorationColMajor: {
p_target_decorations->is_column_major = true;
}
break;
case SpvDecorationRowMajor: {
p_target_decorations->is_row_major = true;
}
break;
case SpvDecorationArrayStride: {
uint32_t word_offset = p_node->word_offset + member_offset + 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->array_stride);
}
break;
case SpvDecorationMatrixStride: {
uint32_t word_offset = p_node->word_offset + member_offset + 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->matrix_stride);
}
break;
case SpvDecorationBuiltIn: {
p_target_decorations->is_built_in = true;
uint32_t word_offset = p_node->word_offset + member_offset + 3;
CHECKED_READU32_CAST(p_parser, word_offset, SpvBuiltIn, p_target_decorations->built_in);
}
break;
case SpvDecorationNoPerspective: {
p_target_decorations->is_noperspective = true;
}
break;
case SpvDecorationFlat: {
p_target_decorations->is_flat = true;
}
break;
case SpvDecorationNonWritable: {
p_target_decorations->is_non_writable = true;
}
break;
case SpvDecorationLocation: {
uint32_t word_offset = p_node->word_offset + member_offset + 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->location.value);
p_target_decorations->location.word_offset = word_offset;
}
break;
case SpvDecorationBinding: {
uint32_t word_offset = p_node->word_offset + member_offset+ 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->binding.value);
p_target_decorations->binding.word_offset = word_offset;
}
break;
case SpvDecorationDescriptorSet: {
uint32_t word_offset = p_node->word_offset + member_offset+ 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->set.value);
p_target_decorations->set.word_offset = word_offset;
}
break;
case SpvDecorationOffset: {
uint32_t word_offset = p_node->word_offset + member_offset+ 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->offset.value);
p_target_decorations->offset.word_offset = word_offset;
}
break;
case SpvDecorationInputAttachmentIndex: {
uint32_t word_offset = p_node->word_offset + member_offset+ 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->input_attachment_index.value);
p_target_decorations->input_attachment_index.word_offset = word_offset;
}
break;
case SpvReflectDecorationHlslCounterBufferGOOGLE: {
uint32_t word_offset = p_node->word_offset + member_offset+ 3;
CHECKED_READU32(p_parser, word_offset, p_target_decorations->uav_counter_buffer.value);
p_target_decorations->uav_counter_buffer.word_offset = word_offset;
}
break;
case SpvReflectDecorationHlslSemanticGOOGLE: {
uint32_t word_offset = p_node->word_offset + member_offset + 3;
p_target_decorations->semantic.value = (const char*)(p_parser->spirv_code + word_offset);
p_target_decorations->semantic.word_offset = word_offset;
}
break;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult EnumerateAllUniforms(
SpvReflectShaderModule* p_module,
size_t* p_uniform_count,
uint32_t** pp_uniforms
)
{
*p_uniform_count = p_module->descriptor_binding_count;
if (*p_uniform_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
*pp_uniforms = (uint32_t*)calloc(*p_uniform_count, sizeof(**pp_uniforms));
if (IsNull(*pp_uniforms)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
for (size_t i = 0; i < *p_uniform_count; ++i) {
(*pp_uniforms)[i] = p_module->descriptor_bindings[i].spirv_id;
}
qsort(*pp_uniforms, *p_uniform_count, sizeof(**pp_uniforms),
SortCompareUint32);
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseType(
Parser* p_parser,
Node* p_node,
Decorations* p_struct_member_decorations,
SpvReflectShaderModule* p_module,
SpvReflectTypeDescription* p_type
)
{
SpvReflectResult result = SPV_REFLECT_RESULT_SUCCESS;
if (p_node->member_count > 0) {
p_type->member_count = p_node->member_count;
p_type->members = (SpvReflectTypeDescription*)calloc(p_type->member_count, sizeof(*(p_type->members)));
if (IsNotNull(p_type->members)) {
// Mark all members types with an invalid state
for (size_t i = 0; i < p_type->members->member_count; ++i) {
SpvReflectTypeDescription* p_member_type = &(p_type->members[i]);
p_member_type->id = (uint32_t)INVALID_VALUE;
p_member_type->op = (SpvOp)INVALID_VALUE;
p_member_type->storage_class = (SpvStorageClass)INVALID_VALUE;
}
}
else {
result = SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
// Since the parse descends on type information, these will get overwritten
// if not guarded against assignment. Only assign if the id is invalid.
if (p_type->id == INVALID_VALUE) {
p_type->id = p_node->result_id;
p_type->op = p_node->op;
p_type->decoration_flags = 0;
}
// Top level types need to pick up decorations from all types below it.
// Issue and fix here: https://github.com/chaoticbob/SPIRV-Reflect/issues/64
p_type->decoration_flags = ApplyDecorations(&p_node->decorations);
switch (p_node->op) {
default: break;
case SpvOpTypeVoid:
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_VOID;
break;
case SpvOpTypeBool:
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_BOOL;
break;
case SpvOpTypeInt: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_INT;
IF_READU32(result, p_parser, p_node->word_offset + 2, p_type->traits.numeric.scalar.width);
IF_READU32(result, p_parser, p_node->word_offset + 3, p_type->traits.numeric.scalar.signedness);
}
break;
case SpvOpTypeFloat: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_FLOAT;
IF_READU32(result, p_parser, p_node->word_offset + 2, p_type->traits.numeric.scalar.width);
}
break;
case SpvOpTypeVector: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_VECTOR;
uint32_t component_type_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + 2, component_type_id);
IF_READU32(result, p_parser, p_node->word_offset + 3, p_type->traits.numeric.vector.component_count);
// Parse component type
Node* p_next_node = FindNode(p_parser, component_type_id);
if (IsNotNull(p_next_node)) {
result = ParseType(p_parser, p_next_node, NULL, p_module, p_type);
}
else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
}
break;
case SpvOpTypeMatrix: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_MATRIX;
uint32_t column_type_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + 2, column_type_id);
IF_READU32(result, p_parser, p_node->word_offset + 3, p_type->traits.numeric.matrix.column_count);
Node* p_next_node = FindNode(p_parser, column_type_id);
if (IsNotNull(p_next_node)) {
result = ParseType(p_parser, p_next_node, NULL, p_module, p_type);
}
else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
p_type->traits.numeric.matrix.row_count = p_type->traits.numeric.vector.component_count;
p_type->traits.numeric.matrix.stride = p_node->decorations.matrix_stride;
// NOTE: Matrix stride is decorated using OpMemberDecoreate - not OpDecoreate.
if (IsNotNull(p_struct_member_decorations)) {
p_type->traits.numeric.matrix.stride = p_struct_member_decorations->matrix_stride;
}
}
break;
case SpvOpTypeImage: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_EXTERNAL_IMAGE;
IF_READU32_CAST(result, p_parser, p_node->word_offset + 3, SpvDim, p_type->traits.image.dim);
IF_READU32(result, p_parser, p_node->word_offset + 4, p_type->traits.image.depth);
IF_READU32(result, p_parser, p_node->word_offset + 5, p_type->traits.image.arrayed);
IF_READU32(result, p_parser, p_node->word_offset + 6, p_type->traits.image.ms);
IF_READU32(result, p_parser, p_node->word_offset + 7, p_type->traits.image.sampled);
IF_READU32_CAST(result, p_parser, p_node->word_offset + 8, SpvImageFormat, p_type->traits.image.image_format);
}
break;
case SpvOpTypeSampler: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_EXTERNAL_SAMPLER;
}
break;
case SpvOpTypeSampledImage: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_EXTERNAL_SAMPLED_IMAGE;
uint32_t image_type_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + 2, image_type_id);
Node* p_next_node = FindNode(p_parser, image_type_id);
if (IsNotNull(p_next_node)) {
result = ParseType(p_parser, p_next_node, NULL, p_module, p_type);
}
else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
}
break;
case SpvOpTypeArray: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_ARRAY;
if (result == SPV_REFLECT_RESULT_SUCCESS) {
uint32_t element_type_id = (uint32_t)INVALID_VALUE;
uint32_t length_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + 2, element_type_id);
IF_READU32(result, p_parser, p_node->word_offset + 3, length_id);
// NOTE: Array stride is decorated using OpDecorate instead of
// OpMemberDecorate, even if the array is apart of a struct.
p_type->traits.array.stride = p_node->decorations.array_stride;
// Get length for current dimension
Node* p_length_node = FindNode(p_parser, length_id);
if (IsNotNull(p_length_node)) {
if (p_length_node->op == SpvOpSpecConstant ||
p_length_node->op == SpvOpSpecConstantOp) {
p_type->traits.array.dims[p_type->traits.array.dims_count] = 0xFFFFFFFF;
p_type->traits.array.dims_count += 1;
} else {
uint32_t length = 0;
IF_READU32(result, p_parser, p_length_node->word_offset + 3, length);
if (result == SPV_REFLECT_RESULT_SUCCESS) {
// Write the array dim and increment the count and offset
p_type->traits.array.dims[p_type->traits.array.dims_count] = length;
p_type->traits.array.dims_count += 1;
} else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
}
// Parse next dimension or element type
Node* p_next_node = FindNode(p_parser, element_type_id);
if (IsNotNull(p_next_node)) {
result = ParseType(p_parser, p_next_node, NULL, p_module, p_type);
}
}
else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
}
}
break;
case SpvOpTypeRuntimeArray: {
uint32_t element_type_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + 2, element_type_id);
// Parse next dimension or element type
Node* p_next_node = FindNode(p_parser, element_type_id);
if (IsNotNull(p_next_node)) {
result = ParseType(p_parser, p_next_node, NULL, p_module, p_type);
}
else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
}
break;
case SpvOpTypeStruct: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_STRUCT;
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_EXTERNAL_BLOCK;
uint32_t word_index = 2;
uint32_t member_index = 0;
for (; word_index < p_node->word_count; ++word_index, ++member_index) {
uint32_t member_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + word_index, member_id);
// Find member node
Node* p_member_node = FindNode(p_parser, member_id);
if (IsNull(p_member_node)) {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
break;
}
// Member decorations
Decorations* p_member_decorations = &p_node->member_decorations[member_index];
assert(member_index < p_type->member_count);
// Parse member type
SpvReflectTypeDescription* p_member_type = &(p_type->members[member_index]);
p_member_type->id = member_id;
p_member_type->op = p_member_node->op;
result = ParseType(p_parser, p_member_node, p_member_decorations, p_module, p_member_type);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
break;
}
// This looks wrong
//p_member_type->type_name = p_member_node->name;
p_member_type->struct_member_name = p_node->member_names[member_index];
}
}
break;
case SpvOpTypeOpaque: break;
case SpvOpTypePointer: {
IF_READU32_CAST(result, p_parser, p_node->word_offset + 2, SpvStorageClass, p_type->storage_class);
uint32_t type_id = (uint32_t)INVALID_VALUE;
IF_READU32(result, p_parser, p_node->word_offset + 3, type_id);
// Parse type
Node* p_next_node = FindNode(p_parser, type_id);
if (IsNotNull(p_next_node)) {
result = ParseType(p_parser, p_next_node, NULL, p_module, p_type);
}
else {
result = SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
SPV_REFLECT_ASSERT(false);
}
}
break;
case SpvOpTypeAccelerationStructureKHR: {
p_type->type_flags |= SPV_REFLECT_TYPE_FLAG_EXTERNAL_ACCELERATION_STRUCTURE;
}
break;
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
// Names get assigned on the way down. Guard against names
// get overwritten on the way up.
if (IsNull(p_type->type_name)) {
p_type->type_name = p_node->name;
}
}
}
return result;
}
static SpvReflectResult ParseTypes(Parser* p_parser, SpvReflectShaderModule* p_module)
{
if (p_parser->type_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
p_module->_internal->type_description_count = p_parser->type_count;
p_module->_internal->type_descriptions = (SpvReflectTypeDescription*)calloc(p_module->_internal->type_description_count,
sizeof(*(p_module->_internal->type_descriptions)));
if (IsNull(p_module->_internal->type_descriptions)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
// Mark all types with an invalid state
for (size_t i = 0; i < p_module->_internal->type_description_count; ++i) {
SpvReflectTypeDescription* p_type = &(p_module->_internal->type_descriptions[i]);
p_type->id = (uint32_t)INVALID_VALUE;
p_type->op = (SpvOp)INVALID_VALUE;
p_type->storage_class = (SpvStorageClass)INVALID_VALUE;
}
size_t type_index = 0;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (! p_node->is_type) {
continue;
}
SpvReflectTypeDescription* p_type = &(p_module->_internal->type_descriptions[type_index]);
SpvReflectResult result = ParseType(p_parser, p_node, NULL, p_module, p_type);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
++type_index;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static int SortCompareDescriptorBinding(const void* a, const void* b)
{
const SpvReflectDescriptorBinding* p_elem_a = (const SpvReflectDescriptorBinding*)a;
const SpvReflectDescriptorBinding* p_elem_b = (const SpvReflectDescriptorBinding*)b;
int value = (int)(p_elem_a->binding) - (int)(p_elem_b->binding);
if (value == 0) {
// use spirv-id as a tiebreaker to ensure a stable ordering, as they're guaranteed
// unique.
assert(p_elem_a->spirv_id != p_elem_b->spirv_id);
value = (int)(p_elem_a->spirv_id) - (int)(p_elem_b->spirv_id);
}
return value;
}
static SpvReflectResult ParseDescriptorBindings(Parser* p_parser, SpvReflectShaderModule* p_module)
{
p_module->descriptor_binding_count = 0;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if ((p_node->op != SpvOpVariable) ||
((p_node->storage_class != SpvStorageClassUniform) &&
(p_node->storage_class != SpvStorageClassStorageBuffer) &&
(p_node->storage_class != SpvStorageClassUniformConstant)))
{
continue;
}
if ((p_node->decorations.set.value == INVALID_VALUE) || (p_node->decorations.binding.value == INVALID_VALUE)) {
continue;
}
p_module->descriptor_binding_count += 1;
}
if (p_module->descriptor_binding_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
p_module->descriptor_bindings = (SpvReflectDescriptorBinding*)calloc(p_module->descriptor_binding_count, sizeof(*(p_module->descriptor_bindings)));
if (IsNull(p_module->descriptor_bindings)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
// Mark all types with an invalid state
for (uint32_t descriptor_index = 0; descriptor_index < p_module->descriptor_binding_count; ++descriptor_index) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[descriptor_index]);
p_descriptor->binding = (uint32_t)INVALID_VALUE;
p_descriptor->input_attachment_index = (uint32_t)INVALID_VALUE;
p_descriptor->set = (uint32_t)INVALID_VALUE;
p_descriptor->descriptor_type = (SpvReflectDescriptorType)INVALID_VALUE;
p_descriptor->uav_counter_id = (uint32_t)INVALID_VALUE;
}
size_t descriptor_index = 0;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if ((p_node->op != SpvOpVariable) ||
((p_node->storage_class != SpvStorageClassUniform) &&
(p_node->storage_class != SpvStorageClassStorageBuffer) &&
(p_node->storage_class != SpvStorageClassUniformConstant)))
{
continue;
}
if ((p_node->decorations.set.value == INVALID_VALUE) || (p_node->decorations.binding.value == INVALID_VALUE)) {
continue;
}
SpvReflectTypeDescription* p_type = FindType(p_module, p_node->type_id);
if (IsNull(p_type)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// If the type is a pointer, resolve it. We need to retain the storage class
// from the pointer so that we can use it to deduce deescriptor types.
SpvStorageClass pointer_storage_class = SpvStorageClassMax;
if (p_type->op == SpvOpTypePointer) {
pointer_storage_class = p_type->storage_class;
// Find the type's node
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Should be the resolved type
p_type = FindType(p_module, p_type_node->type_id);
if (IsNull(p_type)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
}
SpvReflectDescriptorBinding* p_descriptor = &p_module->descriptor_bindings[descriptor_index];
p_descriptor->spirv_id = p_node->result_id;
p_descriptor->name = p_node->name;
p_descriptor->binding = p_node->decorations.binding.value;
p_descriptor->input_attachment_index = p_node->decorations.input_attachment_index.value;
p_descriptor->set = p_node->decorations.set.value;
p_descriptor->count = 1;
p_descriptor->uav_counter_id = p_node->decorations.uav_counter_buffer.value;
p_descriptor->type_description = p_type;
// If this is in the StorageBuffer storage class, it's for sure a storage
// buffer descriptor. We need to handle this case earlier because in SPIR-V
// there are two ways to indicate a storage buffer:
// 1) Uniform storage class + BufferBlock decoration, or
// 2) StorageBuffer storage class + Buffer decoration.
// The 1) way is deprecated since SPIR-V v1.3. But the Buffer decoration is
// also used together with Uniform storage class to mean uniform buffer..
// We'll handle the pre-v1.3 cases in ParseDescriptorType().
if (pointer_storage_class == SpvStorageClassStorageBuffer) {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER;
}
// Copy image traits
if ((p_type->type_flags & SPV_REFLECT_TYPE_FLAG_EXTERNAL_MASK) == SPV_REFLECT_TYPE_FLAG_EXTERNAL_IMAGE) {
memcpy(&p_descriptor->image, &p_type->traits.image, sizeof(p_descriptor->image));
}
// This is a workaround for: https://github.com/KhronosGroup/glslang/issues/1096
{
const uint32_t resource_mask = SPV_REFLECT_TYPE_FLAG_EXTERNAL_SAMPLED_IMAGE | SPV_REFLECT_TYPE_FLAG_EXTERNAL_IMAGE;
if ((p_type->type_flags & resource_mask) == resource_mask) {
memcpy(&p_descriptor->image, &p_type->traits.image, sizeof(p_descriptor->image));
}
}
// Copy array traits
if (p_type->traits.array.dims_count > 0) {
p_descriptor->array.dims_count = p_type->traits.array.dims_count;
for (uint32_t dim_index = 0; dim_index < p_type->traits.array.dims_count; ++dim_index) {
uint32_t dim_value = p_type->traits.array.dims[dim_index];
p_descriptor->array.dims[dim_index] = dim_value;
p_descriptor->count *= dim_value;
}
}
// Count
p_descriptor->word_offset.binding = p_node->decorations.binding.word_offset;
p_descriptor->word_offset.set = p_node->decorations.set.word_offset;
++descriptor_index;
}
if (p_module->descriptor_binding_count > 0) {
qsort(p_module->descriptor_bindings,
p_module->descriptor_binding_count,
sizeof(*(p_module->descriptor_bindings)),
SortCompareDescriptorBinding);
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseDescriptorType(SpvReflectShaderModule* p_module)
{
if (p_module->descriptor_binding_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
for (uint32_t descriptor_index = 0; descriptor_index < p_module->descriptor_binding_count; ++descriptor_index) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[descriptor_index]);
SpvReflectTypeDescription* p_type = p_descriptor->type_description;
if ((int)p_descriptor->descriptor_type == (int)INVALID_VALUE) {
switch (p_type->type_flags & SPV_REFLECT_TYPE_FLAG_EXTERNAL_MASK) {
default: assert(false && "unknown type flag"); break;
case SPV_REFLECT_TYPE_FLAG_EXTERNAL_IMAGE: {
if (p_descriptor->image.dim == SpvDimBuffer) {
switch (p_descriptor->image.sampled) {
default: assert(false && "unknown texel buffer sampled value"); break;
case IMAGE_SAMPLED: p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER; break;
case IMAGE_STORAGE: p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER; break;
}
}
else if(p_descriptor->image.dim == SpvDimSubpassData) {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_INPUT_ATTACHMENT;
}
else {
switch (p_descriptor->image.sampled) {
default: assert(false && "unknown image sampled value"); break;
case IMAGE_SAMPLED: p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_SAMPLED_IMAGE; break;
case IMAGE_STORAGE: p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_IMAGE; break;
}
}
}
break;
case SPV_REFLECT_TYPE_FLAG_EXTERNAL_SAMPLER: {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_SAMPLER;
}
break;
case (SPV_REFLECT_TYPE_FLAG_EXTERNAL_SAMPLED_IMAGE | SPV_REFLECT_TYPE_FLAG_EXTERNAL_IMAGE): {
// This is a workaround for: https://github.com/KhronosGroup/glslang/issues/1096
if (p_descriptor->image.dim == SpvDimBuffer) {
switch (p_descriptor->image.sampled) {
default: assert(false && "unknown texel buffer sampled value"); break;
case IMAGE_SAMPLED: p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER; break;
case IMAGE_STORAGE: p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER; break;
}
}
else {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
}
}
break;
case SPV_REFLECT_TYPE_FLAG_EXTERNAL_BLOCK: {
if (p_type->decoration_flags & SPV_REFLECT_DECORATION_BLOCK) {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
}
else if (p_type->decoration_flags & SPV_REFLECT_DECORATION_BUFFER_BLOCK) {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER;
}
else {
assert(false && "unknown struct");
}
}
break;
case SPV_REFLECT_TYPE_FLAG_EXTERNAL_ACCELERATION_STRUCTURE: {
p_descriptor->descriptor_type = SPV_REFLECT_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR;
}
break;
}
}
switch (p_descriptor->descriptor_type) {
case SPV_REFLECT_DESCRIPTOR_TYPE_SAMPLER : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_SAMPLER; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER : p_descriptor->resource_type = (SpvReflectResourceType)(SPV_REFLECT_RESOURCE_FLAG_SAMPLER | SPV_REFLECT_RESOURCE_FLAG_SRV); break;
case SPV_REFLECT_DESCRIPTOR_TYPE_SAMPLED_IMAGE : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_SRV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_IMAGE : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_UAV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_SRV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_UAV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_BUFFER : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_CBV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_CBV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_UAV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_UAV; break;
case SPV_REFLECT_DESCRIPTOR_TYPE_INPUT_ATTACHMENT : break;
case SPV_REFLECT_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR : p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_SRV; break;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseUAVCounterBindings(SpvReflectShaderModule* p_module)
{
char name[MAX_NODE_NAME_LENGTH];
const char* k_count_tag = "@count";
for (uint32_t descriptor_index = 0; descriptor_index < p_module->descriptor_binding_count; ++descriptor_index) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[descriptor_index]);
if (p_descriptor->descriptor_type != SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER) {
continue;
}
SpvReflectDescriptorBinding* p_counter_descriptor = NULL;
// Use UAV counter buffer id if present...
if (p_descriptor->uav_counter_id != UINT32_MAX) {
for (uint32_t counter_descriptor_index = 0; counter_descriptor_index < p_module->descriptor_binding_count; ++counter_descriptor_index) {
SpvReflectDescriptorBinding* p_test_counter_descriptor = &(p_module->descriptor_bindings[counter_descriptor_index]);
if (p_test_counter_descriptor->descriptor_type != SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER) {
continue;
}
if (p_descriptor->uav_counter_id == p_test_counter_descriptor->spirv_id) {
p_counter_descriptor = p_test_counter_descriptor;
break;
}
}
}
// ...otherwise use old @count convention.
else {
const size_t descriptor_name_length = p_descriptor->name? strlen(p_descriptor->name): 0;
memset(name, 0, MAX_NODE_NAME_LENGTH);
memcpy(name, p_descriptor->name, descriptor_name_length);
#if defined(_WIN32)
strcat_s(name, MAX_NODE_NAME_LENGTH, k_count_tag);
#else
strcat(name, k_count_tag);
#endif
for (uint32_t counter_descriptor_index = 0; counter_descriptor_index < p_module->descriptor_binding_count; ++counter_descriptor_index) {
SpvReflectDescriptorBinding* p_test_counter_descriptor = &(p_module->descriptor_bindings[counter_descriptor_index]);
if (p_test_counter_descriptor->descriptor_type != SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER) {
continue;
}
if (p_test_counter_descriptor->name && strcmp(name, p_test_counter_descriptor->name) == 0) {
p_counter_descriptor = p_test_counter_descriptor;
break;
}
}
}
if (p_counter_descriptor != NULL) {
p_descriptor->uav_counter_binding = p_counter_descriptor;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseDescriptorBlockVariable(
Parser* p_parser,
SpvReflectShaderModule* p_module,
SpvReflectTypeDescription* p_type,
SpvReflectBlockVariable* p_var
)
{
bool has_non_writable = false;
if (IsNotNull(p_type->members) && (p_type->member_count > 0)) {
p_var->member_count = p_type->member_count;
p_var->members = (SpvReflectBlockVariable*)calloc(p_var->member_count, sizeof(*p_var->members));
if (IsNull(p_var->members)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Resolve to element type if current type is array or run time array
if (p_type_node->op == SpvOpTypeArray) {
while (p_type_node->op == SpvOpTypeArray) {
p_type_node = FindNode(p_parser, p_type_node->array_traits.element_type_id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
}
}
else if(p_type_node->op == SpvOpTypeRuntimeArray) {
// Element type description
p_type = FindType(p_module, p_type_node->array_traits.element_type_id);
if (IsNull(p_type)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Element type node
p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
}
// Parse members
for (uint32_t member_index = 0; member_index < p_type->member_count; ++member_index) {
SpvReflectTypeDescription* p_member_type = &p_type->members[member_index];
SpvReflectBlockVariable* p_member_var = &p_var->members[member_index];
bool is_struct = (p_member_type->type_flags & SPV_REFLECT_TYPE_FLAG_STRUCT) == SPV_REFLECT_TYPE_FLAG_STRUCT;
if (is_struct) {
SpvReflectResult result = ParseDescriptorBlockVariable(p_parser, p_module, p_member_type, p_member_var);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
p_member_var->name = p_type_node->member_names[member_index];
p_member_var->offset = p_type_node->member_decorations[member_index].offset.value;
p_member_var->decoration_flags = ApplyDecorations(&p_type_node->member_decorations[member_index]);
p_member_var->flags |= SPV_REFLECT_VARIABLE_FLAGS_UNUSED;
if (!has_non_writable && (p_member_var->decoration_flags & SPV_REFLECT_DECORATION_NON_WRITABLE)) {
has_non_writable = true;
}
ApplyNumericTraits(p_member_type, &p_member_var->numeric);
if (p_member_type->op == SpvOpTypeArray) {
ApplyArrayTraits(p_member_type, &p_member_var->array);
}
p_member_var->type_description = p_member_type;
}
}
p_var->name = p_type->type_name;
p_var->type_description = p_type;
if (has_non_writable) {
p_var->decoration_flags |= SPV_REFLECT_DECORATION_NON_WRITABLE;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseDescriptorBlockVariableSizes(
Parser* p_parser,
SpvReflectShaderModule* p_module,
bool is_parent_root,
bool is_parent_aos,
bool is_parent_rta,
SpvReflectBlockVariable* p_var
)
{
if (p_var->member_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
// Absolute offsets
for (uint32_t member_index = 0; member_index < p_var->member_count; ++member_index) {
SpvReflectBlockVariable* p_member_var = &p_var->members[member_index];
if (is_parent_root) {
p_member_var->absolute_offset = p_member_var->offset;
}
else {
p_member_var->absolute_offset = is_parent_aos ? 0 : p_member_var->offset + p_var->absolute_offset;
}
}
// Size
for (uint32_t member_index = 0; member_index < p_var->member_count; ++member_index) {
SpvReflectBlockVariable* p_member_var = &p_var->members[member_index];
SpvReflectTypeDescription* p_member_type = p_member_var->type_description;
switch (p_member_type->op) {
case SpvOpTypeBool: {
p_member_var->size = SPIRV_WORD_SIZE;
}
break;
case SpvOpTypeInt:
case SpvOpTypeFloat: {
p_member_var->size = p_member_type->traits.numeric.scalar.width / SPIRV_BYTE_WIDTH;
}
break;
case SpvOpTypeVector: {
uint32_t size = p_member_type->traits.numeric.vector.component_count *
(p_member_type->traits.numeric.scalar.width / SPIRV_BYTE_WIDTH);
p_member_var->size = size;
}
break;
case SpvOpTypeMatrix: {
if (p_member_var->decoration_flags & SPV_REFLECT_DECORATION_COLUMN_MAJOR) {
p_member_var->size = p_member_var->numeric.matrix.column_count * p_member_var->numeric.matrix.stride;
}
else if (p_member_var->decoration_flags & SPV_REFLECT_DECORATION_ROW_MAJOR) {
p_member_var->size = p_member_var->numeric.matrix.row_count * p_member_var->numeric.matrix.stride;
}
}
break;
case SpvOpTypeArray: {
// If array of structs, parse members first...
bool is_struct = (p_member_type->type_flags & SPV_REFLECT_TYPE_FLAG_STRUCT) == SPV_REFLECT_TYPE_FLAG_STRUCT;
if (is_struct) {
SpvReflectResult result = ParseDescriptorBlockVariableSizes(p_parser, p_module, false, true, is_parent_rta, p_member_var);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
// ...then array
uint32_t element_count = (p_member_var->array.dims_count > 0 ? 1 : 0);
for (uint32_t i = 0; i < p_member_var->array.dims_count; ++i) {
element_count *= p_member_var->array.dims[i];
}
p_member_var->size = element_count * p_member_var->array.stride;
}
break;
case SpvOpTypeRuntimeArray: {
bool is_struct = (p_member_type->type_flags & SPV_REFLECT_TYPE_FLAG_STRUCT) == SPV_REFLECT_TYPE_FLAG_STRUCT;
if (is_struct) {
SpvReflectResult result = ParseDescriptorBlockVariableSizes(p_parser, p_module, false, true, true, p_member_var);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
}
break;
case SpvOpTypeStruct: {
SpvReflectResult result = ParseDescriptorBlockVariableSizes(p_parser, p_module, false, is_parent_aos, is_parent_rta, p_member_var);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
break;
default:
break;
}
}
// Parse padded size using offset difference for all member except for the last entry...
for (uint32_t member_index = 0; member_index < (p_var->member_count - 1); ++member_index) {
SpvReflectBlockVariable* p_member_var = &p_var->members[member_index];
SpvReflectBlockVariable* p_next_member_var = &p_var->members[member_index + 1];
p_member_var->padded_size = p_next_member_var->offset - p_member_var->offset;
if (p_member_var->size > p_member_var->padded_size) {
p_member_var->size = p_member_var->padded_size;
}
if (is_parent_rta) {
p_member_var->padded_size = p_member_var->size;
}
}
// ...last entry just gets rounded up to near multiple of SPIRV_DATA_ALIGNMENT, which is 16 and
// subtract the offset.
if (p_var->member_count > 0) {
SpvReflectBlockVariable* p_member_var = &p_var->members[p_var->member_count - 1];
p_member_var->padded_size = RoundUp(p_member_var->offset + p_member_var->size, SPIRV_DATA_ALIGNMENT) - p_member_var->offset;
if (p_member_var->size > p_member_var->padded_size) {
p_member_var->size = p_member_var->padded_size;
}
if (is_parent_rta) {
p_member_var->padded_size = p_member_var->size;
}
}
// @TODO validate this with assertion
p_var->size = p_var->members[p_var->member_count - 1].offset +
p_var->members[p_var->member_count - 1].padded_size;
p_var->padded_size = p_var->size;
return SPV_REFLECT_RESULT_SUCCESS;
}
static void MarkSelfAndAllMemberVarsAsUsed(SpvReflectBlockVariable* p_var)
{
// Clear the current variable's USED flag
p_var->flags &= ~SPV_REFLECT_VARIABLE_FLAGS_UNUSED;
SpvOp op_type = p_var->type_description->op;
switch (op_type) {
default: break;
case SpvOpTypeArray: {
}
break;
case SpvOpTypeStruct: {
for (uint32_t i = 0; i < p_var->member_count; ++i) {
SpvReflectBlockVariable* p_member_var = &p_var->members[i];
MarkSelfAndAllMemberVarsAsUsed(p_member_var);
}
}
break;
}
}
static SpvReflectResult ParseDescriptorBlockVariableUsage(
Parser* p_parser,
SpvReflectShaderModule* p_module,
AccessChain* p_access_chain,
uint32_t index_index,
SpvOp override_op_type,
SpvReflectBlockVariable* p_var
)
{
(void)p_parser;
(void)p_access_chain;
(void)p_var;
// Clear the current variable's UNUSED flag
p_var->flags &= ~SPV_REFLECT_VARIABLE_FLAGS_UNUSED;
// Parsing arrays requires overriding the op type for
// for the lowest dim's element type.
SpvOp op_type = p_var->type_description->op;
if (override_op_type != (SpvOp)INVALID_VALUE) {
op_type = override_op_type;
}
switch (op_type) {
default: break;
case SpvOpTypeArray: {
// Parse through array's type hierarchy to find the actual/non-array element type
SpvReflectTypeDescription* p_type = p_var->type_description;
while ((p_type->op == SpvOpTypeArray) && (index_index < p_access_chain->index_count)) {
// Find the array element type id
Node* p_node = FindNode(p_parser, p_type->id);
if (p_node == NULL) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
uint32_t element_type_id = p_node->array_traits.element_type_id;
// Get the array element type
p_type = FindType(p_module, element_type_id);
if (p_type == NULL) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Next access chain index
index_index += 1;
}
// Only continue parsing if there's remaining indices in the access
// chain. If the end of the access chain has been reach then all
// remaining variables (including those in struct hierarchies)
// are considered USED.
//
// See: https://github.com/KhronosGroup/SPIRV-Reflect/issues/78
//
if (index_index < p_access_chain->index_count) {
// Parse current var again with a type override and advanced index index
SpvReflectResult result = ParseDescriptorBlockVariableUsage(
p_parser,
p_module,
p_access_chain,
index_index,
p_type->op,
p_var);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
else {
// Clear UNUSED flag for remaining variables
MarkSelfAndAllMemberVarsAsUsed(p_var);
}
}
break;
case SpvOpTypeStruct: {
assert(p_var->member_count > 0);
if (p_var->member_count == 0) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_UNEXPECTED_BLOCK_DATA;
}
// Get member variable at the access's chain current index
uint32_t index = p_access_chain->indexes[index_index];
if (index >= p_var->member_count) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_BLOCK_MEMBER_REFERENCE;
}
SpvReflectBlockVariable* p_member_var = &p_var->members[index];
// Next access chain index
index_index += 1;
// Only continue parsing if there's remaining indices in the access
// chain. If the end of the access chain has been reach then all
// remaining variables (including those in struct hierarchies)
// are considered USED.
//
// See: https://github.com/KhronosGroup/SPIRV-Reflect/issues/78
//
if (index_index < p_access_chain->index_count) {
SpvReflectResult result = ParseDescriptorBlockVariableUsage(
p_parser,
p_module,
p_access_chain,
index_index,
(SpvOp)INVALID_VALUE,
p_member_var);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
else {
// Clear UNUSED flag for remaining variables
MarkSelfAndAllMemberVarsAsUsed(p_member_var);
}
//SpvReflectBlockVariable* p_member_var = &p_var->members[index];
//if (index_index < p_access_chain->index_count) {
// SpvReflectResult result = ParseDescriptorBlockVariableUsage(
// p_parser,
// p_module,
// p_access_chain,
// index_index + 1,
// (SpvOp)INVALID_VALUE,
// p_member_var);
// if (result != SPV_REFLECT_RESULT_SUCCESS) {
// return result;
// }
//}
}
break;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseDescriptorBlocks(Parser* p_parser, SpvReflectShaderModule* p_module)
{
if (p_module->descriptor_binding_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
for (uint32_t descriptor_index = 0; descriptor_index < p_module->descriptor_binding_count; ++descriptor_index) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[descriptor_index]);
SpvReflectTypeDescription* p_type = p_descriptor->type_description;
if ((p_descriptor->descriptor_type != SPV_REFLECT_DESCRIPTOR_TYPE_UNIFORM_BUFFER) &&
(p_descriptor->descriptor_type != SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER) )
{
continue;
}
// Mark UNUSED
p_descriptor->block.flags |= SPV_REFLECT_VARIABLE_FLAGS_UNUSED;
// Parse descriptor block
SpvReflectResult result = ParseDescriptorBlockVariable(p_parser, p_module, p_type, &p_descriptor->block);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
for (uint32_t access_chain_index = 0; access_chain_index < p_parser->access_chain_count; ++access_chain_index) {
AccessChain* p_access_chain = &(p_parser->access_chains[access_chain_index]);
// Skip any access chains that aren't touching this descriptor block
if (p_descriptor->spirv_id != p_access_chain->base_id) {
continue;
}
result = ParseDescriptorBlockVariableUsage(
p_parser,
p_module,
p_access_chain,
0,
(SpvOp)INVALID_VALUE,
&p_descriptor->block);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
p_descriptor->block.name = p_descriptor->name;
bool is_parent_rta = (p_descriptor->descriptor_type == SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER);
result = ParseDescriptorBlockVariableSizes(p_parser, p_module, true, false, is_parent_rta, &p_descriptor->block);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
if (is_parent_rta) {
p_descriptor->block.size = 0;
p_descriptor->block.padded_size = 0;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseFormat(
const SpvReflectTypeDescription* p_type,
SpvReflectFormat* p_format
)
{
SpvReflectResult result = SPV_REFLECT_RESULT_ERROR_INTERNAL_ERROR;
bool signedness = (p_type->traits.numeric.scalar.signedness != 0);
uint32_t bit_width = p_type->traits.numeric.scalar.width;
if (p_type->type_flags & SPV_REFLECT_TYPE_FLAG_VECTOR) {
uint32_t component_count = p_type->traits.numeric.vector.component_count;
if (p_type->type_flags & SPV_REFLECT_TYPE_FLAG_FLOAT) {
switch (bit_width) {
case 32: {
switch (component_count) {
case 2: *p_format = SPV_REFLECT_FORMAT_R32G32_SFLOAT; break;
case 3: *p_format = SPV_REFLECT_FORMAT_R32G32B32_SFLOAT; break;
case 4: *p_format = SPV_REFLECT_FORMAT_R32G32B32A32_SFLOAT; break;
}
}
case 64: {
switch (component_count) {
case 2: *p_format = SPV_REFLECT_FORMAT_R64G64_SFLOAT; break;
case 3: *p_format = SPV_REFLECT_FORMAT_R64G64B64_SFLOAT; break;
case 4: *p_format = SPV_REFLECT_FORMAT_R64G64B64A64_SFLOAT; break;
}
}
}
result = SPV_REFLECT_RESULT_SUCCESS;
}
else if (p_type->type_flags & (SPV_REFLECT_TYPE_FLAG_INT | SPV_REFLECT_TYPE_FLAG_BOOL)) {
switch (bit_width) {
case 32: {
switch (component_count) {
case 2: *p_format = signedness ? SPV_REFLECT_FORMAT_R32G32_SINT : SPV_REFLECT_FORMAT_R32G32_UINT; break;
case 3: *p_format = signedness ? SPV_REFLECT_FORMAT_R32G32B32_SINT : SPV_REFLECT_FORMAT_R32G32B32_UINT; break;
case 4: *p_format = signedness ? SPV_REFLECT_FORMAT_R32G32B32A32_SINT : SPV_REFLECT_FORMAT_R32G32B32A32_UINT; break;
}
}
case 64: {
switch (component_count) {
case 2: *p_format = signedness ? SPV_REFLECT_FORMAT_R64G64_SINT : SPV_REFLECT_FORMAT_R64G64_UINT; break;
case 3: *p_format = signedness ? SPV_REFLECT_FORMAT_R64G64B64_SINT : SPV_REFLECT_FORMAT_R64G64B64_UINT; break;
case 4: *p_format = signedness ? SPV_REFLECT_FORMAT_R64G64B64A64_SINT : SPV_REFLECT_FORMAT_R64G64B64A64_UINT; break;
}
}
}
result = SPV_REFLECT_RESULT_SUCCESS;
}
}
else if (p_type->type_flags & SPV_REFLECT_TYPE_FLAG_FLOAT) {
switch(bit_width) {
case 32:
*p_format = SPV_REFLECT_FORMAT_R32_SFLOAT;
break;
case 64:
*p_format = SPV_REFLECT_FORMAT_R64_SFLOAT;
break;
}
result = SPV_REFLECT_RESULT_SUCCESS;
}
else if (p_type->type_flags & (SPV_REFLECT_TYPE_FLAG_INT | SPV_REFLECT_TYPE_FLAG_BOOL)) {
switch(bit_width) {
case 32:
*p_format = signedness ? SPV_REFLECT_FORMAT_R32_SINT : SPV_REFLECT_FORMAT_R32_UINT; break;
break;
case 64:
*p_format = signedness ? SPV_REFLECT_FORMAT_R64_SINT : SPV_REFLECT_FORMAT_R64_UINT; break;
}
result = SPV_REFLECT_RESULT_SUCCESS;
}
else if (p_type->type_flags & SPV_REFLECT_TYPE_FLAG_STRUCT) {
*p_format = SPV_REFLECT_FORMAT_UNDEFINED;
result = SPV_REFLECT_RESULT_SUCCESS;
}
return result;
}
static SpvReflectResult ParseInterfaceVariable(
Parser* p_parser,
const Decorations* p_type_node_decorations,
SpvReflectShaderModule* p_module,
SpvReflectTypeDescription* p_type,
SpvReflectInterfaceVariable* p_var,
bool* p_has_built_in
)
{
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
if (p_type->member_count > 0) {
p_var->member_count = p_type->member_count;
p_var->members = (SpvReflectInterfaceVariable*)calloc(p_var->member_count, sizeof(*p_var->members));
if (IsNull(p_var->members)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
for (uint32_t member_index = 0; member_index < p_type_node->member_count; ++member_index) {
Decorations* p_member_decorations = &p_type_node->member_decorations[member_index];
SpvReflectTypeDescription* p_member_type = &p_type->members[member_index];
SpvReflectInterfaceVariable* p_member_var = &p_var->members[member_index];
SpvReflectResult result = ParseInterfaceVariable(p_parser, p_member_decorations, p_module, p_member_type, p_member_var, p_has_built_in);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
SPV_REFLECT_ASSERT(false);
return result;
}
}
}
p_var->name = p_type_node->name;
p_var->decoration_flags = ApplyDecorations(p_type_node_decorations);
p_var->built_in = p_type_node_decorations->built_in;
ApplyNumericTraits(p_type, &p_var->numeric);
if (p_type->op == SpvOpTypeArray) {
ApplyArrayTraits(p_type, &p_var->array);
}
p_var->type_description = p_type;
*p_has_built_in |= p_type_node_decorations->is_built_in;
// Only parse format for interface variables that are input or output
if ((p_var->storage_class == SpvStorageClassInput) || (p_var->storage_class == SpvStorageClassOutput)) {
SpvReflectResult result = ParseFormat(p_var->type_description, &p_var->format);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
SPV_REFLECT_ASSERT(false);
return result;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseInterfaceVariables(
Parser* p_parser,
SpvReflectShaderModule* p_module,
SpvReflectEntryPoint* p_entry,
uint32_t interface_variable_count,
uint32_t* p_interface_variable_ids
)
{
if (interface_variable_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
p_entry->interface_variable_count = interface_variable_count;
p_entry->input_variable_count = 0;
p_entry->output_variable_count = 0;
for (size_t i = 0; i < interface_variable_count; ++i) {
uint32_t var_result_id = *(p_interface_variable_ids + i);
Node* p_node = FindNode(p_parser, var_result_id);
if (IsNull(p_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
if (p_node->storage_class == SpvStorageClassInput) {
p_entry->input_variable_count += 1;
}
else if (p_node->storage_class == SpvStorageClassOutput) {
p_entry->output_variable_count += 1;
}
}
if (p_entry->input_variable_count > 0) {
p_entry->input_variables = (SpvReflectInterfaceVariable**)calloc(p_entry->input_variable_count, sizeof(*(p_entry->input_variables)));
if (IsNull(p_entry->input_variables)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
if (p_entry->output_variable_count > 0) {
p_entry->output_variables = (SpvReflectInterfaceVariable**)calloc(p_entry->output_variable_count, sizeof(*(p_entry->output_variables)));
if (IsNull(p_entry->output_variables)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
if (p_entry->interface_variable_count > 0) {
p_entry->interface_variables = (SpvReflectInterfaceVariable*)calloc(p_entry->interface_variable_count, sizeof(*(p_entry->interface_variables)));
if (IsNull(p_entry->interface_variables)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
size_t input_index = 0;
size_t output_index = 0;
for (size_t i = 0; i < interface_variable_count; ++i) {
uint32_t var_result_id = *(p_interface_variable_ids + i);
Node* p_node = FindNode(p_parser, var_result_id);
if (IsNull(p_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
SpvReflectTypeDescription* p_type = FindType(p_module, p_node->type_id);
if (IsNull(p_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// If the type is a pointer, resolve it
if (p_type->op == SpvOpTypePointer) {
// Find the type's node
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Should be the resolved type
p_type = FindType(p_module, p_type_node->type_id);
if (IsNull(p_type)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
}
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
SpvReflectInterfaceVariable* p_var = &(p_entry->interface_variables[i]);
p_var->storage_class = p_node->storage_class;
bool has_built_in = p_node->decorations.is_built_in;
SpvReflectResult result = ParseInterfaceVariable(
p_parser,
&p_type_node->decorations,
p_module,
p_type,
p_var,
&has_built_in);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
SPV_REFLECT_ASSERT(false);
return result;
}
// Input and output variables
if (p_var->storage_class == SpvStorageClassInput) {
p_entry->input_variables[input_index] = p_var;
++input_index;
}
else if (p_node->storage_class == SpvStorageClassOutput) {
p_entry->output_variables[output_index] = p_var;
++output_index;
}
// SPIR-V result id
p_var->spirv_id = p_node->result_id;
// Name
p_var->name = p_node->name;
// Semantic
p_var->semantic = p_node->decorations.semantic.value;
// Decorate with built-in if any member is built-in
if (has_built_in) {
p_var->decoration_flags |= SPV_REFLECT_DECORATION_BUILT_IN;
}
// Location is decorated on OpVariable node, not the type node.
p_var->location = p_node->decorations.location.value;
p_var->word_offset.location = p_node->decorations.location.word_offset;
// Built in
if (p_node->decorations.is_built_in) {
p_var->built_in = p_node->decorations.built_in;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult EnumerateAllPushConstants(
SpvReflectShaderModule* p_module,
size_t* p_push_constant_count,
uint32_t** p_push_constants
)
{
*p_push_constant_count = p_module->push_constant_block_count;
if (*p_push_constant_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
*p_push_constants = (uint32_t*)calloc(*p_push_constant_count, sizeof(**p_push_constants));
if (IsNull(*p_push_constants)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
for (size_t i = 0; i < *p_push_constant_count; ++i) {
(*p_push_constants)[i] = p_module->push_constant_blocks[i].spirv_id;
}
qsort(*p_push_constants, *p_push_constant_count, sizeof(**p_push_constants),
SortCompareUint32);
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult TraverseCallGraph(
Parser* p_parser,
Function* p_func,
size_t* p_func_count,
uint32_t* p_func_ids,
uint32_t depth
)
{
if (depth > p_parser->function_count) {
// Vulkan does not permit recursion (Vulkan spec Appendix A):
// "Recursion: The static function-call graph for an entry point must not
// contain cycles."
return SPV_REFLECT_RESULT_ERROR_SPIRV_RECURSION;
}
if (IsNotNull(p_func_ids)) {
p_func_ids[(*p_func_count)++] = p_func->id;
} else {
++*p_func_count;
}
for (size_t i = 0; i < p_func->callee_count; ++i) {
SpvReflectResult result = TraverseCallGraph(
p_parser, p_func->callee_ptrs[i], p_func_count, p_func_ids, depth + 1);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseStaticallyUsedResources(
Parser* p_parser,
SpvReflectShaderModule* p_module,
SpvReflectEntryPoint* p_entry,
size_t uniform_count,
uint32_t* uniforms,
size_t push_constant_count,
uint32_t* push_constants
)
{
// Find function with the right id
Function* p_func = NULL;
for (size_t i = 0; i < p_parser->function_count; ++i) {
if (p_parser->functions[i].id == p_entry->id) {
p_func = &(p_parser->functions[i]);
break;
}
}
if (p_func == NULL) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
size_t called_function_count = 0;
SpvReflectResult result = TraverseCallGraph(
p_parser,
p_func,
&called_function_count,
NULL,
0);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
uint32_t* p_called_functions = NULL;
if (called_function_count > 0) {
p_called_functions = (uint32_t*)calloc(called_function_count, sizeof(*p_called_functions));
if (IsNull(p_called_functions)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
called_function_count = 0;
result = TraverseCallGraph(
p_parser,
p_func,
&called_function_count,
p_called_functions,
0);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
if (called_function_count > 0) {
qsort(
p_called_functions,
called_function_count,
sizeof(*p_called_functions),
SortCompareUint32);
}
called_function_count = DedupSortedUint32(p_called_functions, called_function_count);
uint32_t used_variable_count = 0;
for (size_t i = 0, j = 0; i < called_function_count; ++i) {
// No need to bounds check j because a missing ID issue would have been
// found during TraverseCallGraph
while (p_parser->functions[j].id != p_called_functions[i]) {
++j;
}
used_variable_count += p_parser->functions[j].accessed_ptr_count;
}
uint32_t* used_variables = NULL;
if (used_variable_count > 0) {
used_variables = (uint32_t*)calloc(used_variable_count,
sizeof(*used_variables));
if (IsNull(used_variables)) {
SafeFree(p_called_functions);
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
used_variable_count = 0;
for (size_t i = 0, j = 0; i < called_function_count; ++i) {
while (p_parser->functions[j].id != p_called_functions[i]) {
++j;
}
memcpy(&used_variables[used_variable_count],
p_parser->functions[j].accessed_ptrs,
p_parser->functions[j].accessed_ptr_count * sizeof(*used_variables));
used_variable_count += p_parser->functions[j].accessed_ptr_count;
}
SafeFree(p_called_functions);
if (used_variable_count > 0) {
qsort(used_variables, used_variable_count, sizeof(*used_variables),
SortCompareUint32);
}
used_variable_count = (uint32_t)DedupSortedUint32(used_variables,
used_variable_count);
// Do set intersection to find the used uniform and push constants
size_t used_uniform_count = 0;
//
SpvReflectResult result0 = IntersectSortedUint32(
used_variables,
used_variable_count,
uniforms,
uniform_count,
&p_entry->used_uniforms,
&used_uniform_count);
size_t used_push_constant_count = 0;
//
SpvReflectResult result1 = IntersectSortedUint32(
used_variables,
used_variable_count,
push_constants,
push_constant_count,
&p_entry->used_push_constants,
&used_push_constant_count);
for (uint32_t j = 0; j < p_module->descriptor_binding_count; ++j) {
SpvReflectDescriptorBinding* p_binding = &p_module->descriptor_bindings[j];
bool found = SearchSortedUint32(
used_variables,
used_variable_count,
p_binding->spirv_id);
if (found) {
p_binding->accessed = 1;
}
}
SafeFree(used_variables);
if (result0 != SPV_REFLECT_RESULT_SUCCESS) {
return result0;
}
if (result1 != SPV_REFLECT_RESULT_SUCCESS) {
return result1;
}
p_entry->used_uniform_count = (uint32_t)used_uniform_count;
p_entry->used_push_constant_count = (uint32_t)used_push_constant_count;
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseEntryPoints(Parser* p_parser, SpvReflectShaderModule* p_module)
{
if (p_parser->entry_point_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
p_module->entry_point_count = p_parser->entry_point_count;
p_module->entry_points = (SpvReflectEntryPoint*)calloc(p_module->entry_point_count,
sizeof(*(p_module->entry_points)));
if (IsNull(p_module->entry_points)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
SpvReflectResult result;
size_t uniform_count = 0;
uint32_t* uniforms = NULL;
if ((result = EnumerateAllUniforms(p_module, &uniform_count, &uniforms)) !=
SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
size_t push_constant_count = 0;
uint32_t* push_constants = NULL;
if ((result = EnumerateAllPushConstants(p_module, &push_constant_count, &push_constants)) !=
SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
size_t entry_point_index = 0;
for (size_t i = 0; entry_point_index < p_parser->entry_point_count && i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if (p_node->op != SpvOpEntryPoint) {
continue;
}
SpvReflectEntryPoint* p_entry_point = &(p_module->entry_points[entry_point_index]);
CHECKED_READU32_CAST(p_parser, p_node->word_offset + 1, SpvExecutionModel, p_entry_point->spirv_execution_model);
CHECKED_READU32(p_parser, p_node->word_offset + 2, p_entry_point->id);
switch (p_entry_point->spirv_execution_model) {
default: break;
case SpvExecutionModelVertex : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_VERTEX_BIT; break;
case SpvExecutionModelTessellationControl : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_TESSELLATION_CONTROL_BIT; break;
case SpvExecutionModelTessellationEvaluation : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_TESSELLATION_EVALUATION_BIT; break;
case SpvExecutionModelGeometry : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_GEOMETRY_BIT; break;
case SpvExecutionModelFragment : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_FRAGMENT_BIT; break;
case SpvExecutionModelGLCompute : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_COMPUTE_BIT; break;
case SpvExecutionModelTaskNV : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_TASK_BIT_NV; break;
case SpvExecutionModelMeshNV : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_MESH_BIT_NV; break;
case SpvExecutionModelRayGenerationKHR : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_RAYGEN_BIT_KHR; break;
case SpvExecutionModelIntersectionKHR : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_INTERSECTION_BIT_KHR; break;
case SpvExecutionModelAnyHitKHR : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_ANY_HIT_BIT_KHR; break;
case SpvExecutionModelClosestHitKHR : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_CLOSEST_HIT_BIT_KHR; break;
case SpvExecutionModelMissKHR : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_MISS_BIT_KHR; break;
case SpvExecutionModelCallableKHR : p_entry_point->shader_stage = SPV_REFLECT_SHADER_STAGE_CALLABLE_BIT_KHR; break;
}
++entry_point_index;
// Name length is required to calculate next operand
uint32_t name_start_word_offset = 3;
uint32_t name_length_with_terminator = 0;
result = ReadStr(p_parser, p_node->word_offset + name_start_word_offset, 0, p_node->word_count, &name_length_with_terminator, NULL);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
p_entry_point->name = (const char*)(p_parser->spirv_code + p_node->word_offset + name_start_word_offset);
uint32_t name_word_count = RoundUp(name_length_with_terminator, SPIRV_WORD_SIZE) / SPIRV_WORD_SIZE;
uint32_t interface_variable_count = (p_node->word_count - (name_start_word_offset + name_word_count));
uint32_t* p_interface_variables = NULL;
if (interface_variable_count > 0) {
p_interface_variables = (uint32_t*)calloc(interface_variable_count, sizeof(*(p_interface_variables)));
if (IsNull(p_interface_variables)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
for (uint32_t var_index = 0; var_index < interface_variable_count; ++var_index) {
uint32_t var_result_id = (uint32_t)INVALID_VALUE;
uint32_t offset = name_start_word_offset + name_word_count + var_index;
CHECKED_READU32(p_parser, p_node->word_offset + offset, var_result_id);
p_interface_variables[var_index] = var_result_id;
}
result = ParseInterfaceVariables(
p_parser,
p_module,
p_entry_point,
interface_variable_count,
p_interface_variables);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
SafeFree(p_interface_variables);
result = ParseStaticallyUsedResources(
p_parser,
p_module,
p_entry_point,
uniform_count,
uniforms,
push_constant_count,
push_constants);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
}
SafeFree(uniforms);
SafeFree(push_constants);
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseExecutionModes(Parser* p_parser, SpvReflectShaderModule* p_module)
{
assert(IsNotNull(p_parser));
assert(IsNotNull(p_parser->nodes));
assert(IsNotNull(p_module));
if (IsNotNull(p_parser) && IsNotNull(p_parser->spirv_code) && IsNotNull(p_parser->nodes)) {
for (size_t node_idx = 0; node_idx < p_parser->node_count; ++node_idx) {
Node* p_node = &(p_parser->nodes[node_idx]);
if (p_node->op != SpvOpExecutionMode) {
continue;
}
// Read entry point id
uint32_t entry_point_id = 0;
CHECKED_READU32(p_parser, p_node->word_offset + 1, entry_point_id);
// Find entry point
SpvReflectEntryPoint* p_entry_point = NULL;
for (size_t entry_point_idx = 0; entry_point_idx < p_module->entry_point_count; ++entry_point_idx) {
if (p_module->entry_points[entry_point_idx].id == entry_point_id) {
p_entry_point = &p_module->entry_points[entry_point_idx];
break;
}
}
// Bail if entry point is null
if (IsNull(p_entry_point)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ENTRY_POINT;
}
// Read execution mode
uint32_t execution_mode = (uint32_t)INVALID_VALUE;
CHECKED_READU32(p_parser, p_node->word_offset + 2, execution_mode);
// Parse execution mode
switch (execution_mode) {
default: {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_EXECUTION_MODE;
}
break;
case SpvExecutionModeInvocations:
case SpvExecutionModeSpacingEqual:
case SpvExecutionModeSpacingFractionalEven:
case SpvExecutionModeSpacingFractionalOdd:
case SpvExecutionModeVertexOrderCw:
case SpvExecutionModeVertexOrderCcw:
case SpvExecutionModePixelCenterInteger:
case SpvExecutionModeOriginUpperLeft:
case SpvExecutionModeOriginLowerLeft:
case SpvExecutionModeEarlyFragmentTests:
case SpvExecutionModePointMode:
case SpvExecutionModeXfb:
case SpvExecutionModeDepthReplacing:
case SpvExecutionModeDepthGreater:
case SpvExecutionModeDepthLess:
case SpvExecutionModeDepthUnchanged:
break;
case SpvExecutionModeLocalSize: {
CHECKED_READU32(p_parser, p_node->word_offset + 3, p_entry_point->local_size.x);
CHECKED_READU32(p_parser, p_node->word_offset + 4, p_entry_point->local_size.y);
CHECKED_READU32(p_parser, p_node->word_offset + 5, p_entry_point->local_size.z);
}
break;
case SpvExecutionModeLocalSizeHint:
case SpvExecutionModeInputPoints:
case SpvExecutionModeInputLines:
case SpvExecutionModeInputLinesAdjacency:
case SpvExecutionModeTriangles:
case SpvExecutionModeInputTrianglesAdjacency:
case SpvExecutionModeQuads:
case SpvExecutionModeIsolines:
case SpvExecutionModeOutputVertices:
case SpvExecutionModeOutputPoints:
case SpvExecutionModeOutputLineStrip:
case SpvExecutionModeOutputTriangleStrip:
case SpvExecutionModeVecTypeHint:
case SpvExecutionModeContractionOff:
case SpvExecutionModeInitializer:
case SpvExecutionModeFinalizer:
case SpvExecutionModeSubgroupSize:
case SpvExecutionModeSubgroupsPerWorkgroup:
case SpvExecutionModeSubgroupsPerWorkgroupId:
case SpvExecutionModeLocalSizeId:
case SpvExecutionModeLocalSizeHintId:
case SpvExecutionModePostDepthCoverage:
case SpvExecutionModeStencilRefReplacingEXT:
case SpvExecutionModeOutputPrimitivesNV:
case SpvExecutionModeOutputTrianglesNV:
break;
}
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParsePushConstantBlocks(Parser* p_parser, SpvReflectShaderModule* p_module)
{
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if ((p_node->op != SpvOpVariable) || (p_node->storage_class != SpvStorageClassPushConstant)) {
continue;
}
p_module->push_constant_block_count += 1;
}
if (p_module->push_constant_block_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
p_module->push_constant_blocks = (SpvReflectBlockVariable*)calloc(p_module->push_constant_block_count, sizeof(*p_module->push_constant_blocks));
if (IsNull(p_module->push_constant_blocks)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
uint32_t push_constant_index = 0;
for (size_t i = 0; i < p_parser->node_count; ++i) {
Node* p_node = &(p_parser->nodes[i]);
if ((p_node->op != SpvOpVariable) || (p_node->storage_class != SpvStorageClassPushConstant)) {
continue;
}
SpvReflectTypeDescription* p_type = FindType(p_module, p_node->type_id);
if (IsNull(p_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// If the type is a pointer, resolve it
if (p_type->op == SpvOpTypePointer) {
// Find the type's node
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
// Should be the resolved type
p_type = FindType(p_module, p_type_node->type_id);
if (IsNull(p_type)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
}
Node* p_type_node = FindNode(p_parser, p_type->id);
if (IsNull(p_type_node)) {
return SPV_REFLECT_RESULT_ERROR_SPIRV_INVALID_ID_REFERENCE;
}
SpvReflectBlockVariable* p_push_constant = &p_module->push_constant_blocks[push_constant_index];
p_push_constant->spirv_id = p_node->result_id;
SpvReflectResult result = ParseDescriptorBlockVariable(p_parser, p_module, p_type, p_push_constant);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
result = ParseDescriptorBlockVariableSizes(p_parser, p_module, true, false, false, p_push_constant);
if (result != SPV_REFLECT_RESULT_SUCCESS) {
return result;
}
++push_constant_index;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static int SortCompareDescriptorSet(const void* a, const void* b)
{
const SpvReflectDescriptorSet* p_elem_a = (const SpvReflectDescriptorSet*)a;
const SpvReflectDescriptorSet* p_elem_b = (const SpvReflectDescriptorSet*)b;
int value = (int)(p_elem_a->set) - (int)(p_elem_b->set);
// We should never see duplicate descriptor set numbers in a shader; if so, a tiebreaker
// would be needed here.
assert(value != 0);
return value;
}
static SpvReflectResult ParseEntrypointDescriptorSets(SpvReflectShaderModule* p_module) {
// Update the entry point's sets
for (uint32_t i = 0; i < p_module->entry_point_count; ++i) {
SpvReflectEntryPoint* p_entry = &p_module->entry_points[i];
for (uint32_t j = 0; j < p_entry->descriptor_set_count; ++j) {
SafeFree(p_entry->descriptor_sets[j].bindings);
}
SafeFree(p_entry->descriptor_sets);
p_entry->descriptor_set_count = 0;
for (uint32_t j = 0; j < p_module->descriptor_set_count; ++j) {
const SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[j];
for (uint32_t k = 0; k < p_set->binding_count; ++k) {
bool found = SearchSortedUint32(
p_entry->used_uniforms,
p_entry->used_uniform_count,
p_set->bindings[k]->spirv_id);
if (found) {
++p_entry->descriptor_set_count;
break;
}
}
}
p_entry->descriptor_sets = NULL;
if (p_entry->descriptor_set_count > 0) {
p_entry->descriptor_sets = (SpvReflectDescriptorSet*)calloc(p_entry->descriptor_set_count,
sizeof(*p_entry->descriptor_sets));
if (IsNull(p_entry->descriptor_sets)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
}
p_entry->descriptor_set_count = 0;
for (uint32_t j = 0; j < p_module->descriptor_set_count; ++j) {
const SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[j];
uint32_t count = 0;
for (uint32_t k = 0; k < p_set->binding_count; ++k) {
bool found = SearchSortedUint32(
p_entry->used_uniforms,
p_entry->used_uniform_count,
p_set->bindings[k]->spirv_id);
if (found) {
++count;
}
}
if (count == 0) {
continue;
}
SpvReflectDescriptorSet* p_entry_set = &p_entry->descriptor_sets[
p_entry->descriptor_set_count++];
p_entry_set->set = p_set->set;
p_entry_set->bindings = (SpvReflectDescriptorBinding**)calloc(count,
sizeof(*p_entry_set->bindings));
if (IsNull(p_entry_set->bindings)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
for (uint32_t k = 0; k < p_set->binding_count; ++k) {
bool found = SearchSortedUint32(
p_entry->used_uniforms,
p_entry->used_uniform_count,
p_set->bindings[k]->spirv_id);
if (found) {
p_entry_set->bindings[p_entry_set->binding_count++] = p_set->bindings[k];
}
}
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult ParseDescriptorSets(SpvReflectShaderModule* p_module)
{
// Count the descriptors in each set
for (uint32_t i = 0; i < p_module->descriptor_binding_count; ++i) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[i]);
// Look for a target set using the descriptor's set number
SpvReflectDescriptorSet* p_target_set = NULL;
for (uint32_t j = 0; j < SPV_REFLECT_MAX_DESCRIPTOR_SETS; ++j) {
SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[j];
if (p_set->set == p_descriptor->set) {
p_target_set = p_set;
break;
}
}
// If a target set isn't found, find the first available one.
if (IsNull(p_target_set)) {
for (uint32_t j = 0; j < SPV_REFLECT_MAX_DESCRIPTOR_SETS; ++j) {
SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[j];
if (p_set->set == (uint32_t)INVALID_VALUE) {
p_target_set = p_set;
p_target_set->set = p_descriptor->set;
break;
}
}
}
if (IsNull(p_target_set)) {
return SPV_REFLECT_RESULT_ERROR_INTERNAL_ERROR;
}
p_target_set->binding_count += 1;
}
// Count the descriptor sets
for (uint32_t i = 0; i < SPV_REFLECT_MAX_DESCRIPTOR_SETS; ++i) {
const SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[i];
if (p_set->set != (uint32_t)INVALID_VALUE) {
p_module->descriptor_set_count += 1;
}
}
// Sort the descriptor sets based on numbers
if (p_module->descriptor_set_count > 0) {
qsort(p_module->descriptor_sets,
p_module->descriptor_set_count,
sizeof(*(p_module->descriptor_sets)),
SortCompareDescriptorSet);
}
// Build descriptor pointer array
for (uint32_t i = 0; i <p_module->descriptor_set_count; ++i) {
SpvReflectDescriptorSet* p_set = &(p_module->descriptor_sets[i]);
p_set->bindings = (SpvReflectDescriptorBinding **)calloc(p_set->binding_count, sizeof(*(p_set->bindings)));
uint32_t descriptor_index = 0;
for (uint32_t j = 0; j < p_module->descriptor_binding_count; ++j) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[j]);
if (p_descriptor->set == p_set->set) {
assert(descriptor_index < p_set->binding_count);
p_set->bindings[descriptor_index] = p_descriptor;
++descriptor_index;
}
}
}
return ParseEntrypointDescriptorSets(p_module);
}
static SpvReflectResult DisambiguateStorageBufferSrvUav(SpvReflectShaderModule* p_module)
{
if (p_module->descriptor_binding_count == 0) {
return SPV_REFLECT_RESULT_SUCCESS;
}
for (uint32_t descriptor_index = 0; descriptor_index < p_module->descriptor_binding_count; ++descriptor_index) {
SpvReflectDescriptorBinding* p_descriptor = &(p_module->descriptor_bindings[descriptor_index]);
// Skip everything that isn't a STORAGE_BUFFER descriptor
if (p_descriptor->descriptor_type != SPV_REFLECT_DESCRIPTOR_TYPE_STORAGE_BUFFER) {
continue;
}
//
// Vulkan doesn't disambiguate between SRVs and UAVs so they
// come back as STORAGE_BUFFER. The block parsing process will
// mark a block as non-writable should any member of the block
// or its descendants are non-writable.
//
if (p_descriptor->block.decoration_flags & SPV_REFLECT_DECORATION_NON_WRITABLE) {
p_descriptor->resource_type = SPV_REFLECT_RESOURCE_FLAG_SRV;
}
}
return SPV_REFLECT_RESULT_SUCCESS;
}
static SpvReflectResult SynchronizeDescriptorSets(SpvReflectShaderModule* p_module)
{
// Free and reset all descriptor set numbers
for (uint32_t i = 0; i < SPV_REFLECT_MAX_DESCRIPTOR_SETS; ++i) {
SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[i];
SafeFree(p_set->bindings);
p_set->binding_count = 0;
p_set->set = (uint32_t)INVALID_VALUE;
}
// Set descriptor set count to zero
p_module->descriptor_set_count = 0;
SpvReflectResult result = ParseDescriptorSets(p_module);
return result;
}
SpvReflectResult spvReflectGetShaderModule(
size_t size,
const void* p_code,
SpvReflectShaderModule* p_module
)
{
return spvReflectCreateShaderModule(size, p_code, p_module);
}
SpvReflectResult spvReflectCreateShaderModule(
size_t size,
const void* p_code,
SpvReflectShaderModule* p_module
)
{
// Initialize all module fields to zero
memset(p_module, 0, sizeof(*p_module));
// Allocate module internals
#ifdef __cplusplus
p_module->_internal = (SpvReflectShaderModule::Internal*)calloc(1, sizeof(*(p_module->_internal)));
#else
p_module->_internal = calloc(1, sizeof(*(p_module->_internal)));
#endif
if (IsNull(p_module->_internal)) {
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
// Allocate SPIR-V code storage
p_module->_internal->spirv_size = size;
p_module->_internal->spirv_code = (uint32_t*)calloc(1, p_module->_internal->spirv_size);
p_module->_internal->spirv_word_count = (uint32_t)(size / SPIRV_WORD_SIZE);
if (IsNull(p_module->_internal->spirv_code)) {
SafeFree(p_module->_internal);
return SPV_REFLECT_RESULT_ERROR_ALLOC_FAILED;
}
memcpy(p_module->_internal->spirv_code, p_code, size);
Parser parser = { 0 };
SpvReflectResult result = CreateParser(p_module->_internal->spirv_size,
p_module->_internal->spirv_code,
&parser);
// Generator
{
const uint32_t* p_ptr = (const uint32_t*)p_module->_internal->spirv_code;
p_module->generator = (SpvReflectGenerator)((*(p_ptr + 2) & 0xFFFF0000) >> 16);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseNodes(&parser);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseStrings(&parser);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseSource(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseFunctions(&parser);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseMemberCounts(&parser);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseNames(&parser);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseDecorations(&parser);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
// Start of reflection data parsing
if (result == SPV_REFLECT_RESULT_SUCCESS) {
p_module->source_language = parser.source_language;
p_module->source_language_version = parser.source_language_version;
// Zero out descriptor set data
p_module->descriptor_set_count = 0;
memset(p_module->descriptor_sets, 0, SPV_REFLECT_MAX_DESCRIPTOR_SETS * sizeof(*p_module->descriptor_sets));
// Initialize descriptor set numbers
for (uint32_t set_number = 0; set_number < SPV_REFLECT_MAX_DESCRIPTOR_SETS; ++set_number) {
p_module->descriptor_sets[set_number].set = (uint32_t)INVALID_VALUE;
}
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseTypes(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseDescriptorBindings(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseDescriptorType(p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseUAVCounterBindings(p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseDescriptorBlocks(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParsePushConstantBlocks(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseEntryPoints(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS && p_module->entry_point_count > 0) {
SpvReflectEntryPoint* p_entry = &(p_module->entry_points[0]);
p_module->entry_point_name = p_entry->name;
p_module->entry_point_id = p_entry->id;
p_module->spirv_execution_model = p_entry->spirv_execution_model;
p_module->shader_stage = p_entry->shader_stage;
p_module->input_variable_count = p_entry->input_variable_count;
p_module->input_variables = p_entry->input_variables;
p_module->output_variable_count = p_entry->output_variable_count;
p_module->output_variables = p_entry->output_variables;
p_module->interface_variable_count = p_entry->interface_variable_count;
p_module->interface_variables = p_entry->interface_variables;
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = DisambiguateStorageBufferSrvUav(p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = SynchronizeDescriptorSets(p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
if (result == SPV_REFLECT_RESULT_SUCCESS) {
result = ParseExecutionModes(&parser, p_module);
SPV_REFLECT_ASSERT(result == SPV_REFLECT_RESULT_SUCCESS);
}
// Destroy module if parse was not successful
if (result != SPV_REFLECT_RESULT_SUCCESS) {
spvReflectDestroyShaderModule(p_module);
}
DestroyParser(&parser);
return result;
}
static void SafeFreeTypes(SpvReflectTypeDescription* p_type)
{
if (IsNull(p_type)) {
return;
}
if (IsNotNull(p_type->members)) {
for (size_t i = 0; i < p_type->member_count; ++i) {
SpvReflectTypeDescription* p_member = &p_type->members[i];
SafeFreeTypes(p_member);
}
SafeFree(p_type->members);
p_type->members = NULL;
}
}
static void SafeFreeBlockVariables(SpvReflectBlockVariable* p_block)
{
if (IsNull(p_block)) {
return;
}
if (IsNotNull(p_block->members)) {
for (size_t i = 0; i < p_block->member_count; ++i) {
SpvReflectBlockVariable* p_member = &p_block->members[i];
SafeFreeBlockVariables(p_member);
}
SafeFree(p_block->members);
p_block->members = NULL;
}
}
static void SafeFreeInterfaceVariable(SpvReflectInterfaceVariable* p_interface)
{
if (IsNull(p_interface)) {
return;
}
if (IsNotNull(p_interface->members)) {
for (size_t i = 0; i < p_interface->member_count; ++i) {
SpvReflectInterfaceVariable* p_member = &p_interface->members[i];
SafeFreeInterfaceVariable(p_member);
}
SafeFree(p_interface->members);
p_interface->members = NULL;
}
}
void spvReflectDestroyShaderModule(SpvReflectShaderModule* p_module)
{
if (IsNull(p_module->_internal)) {
return;
}
SafeFree(p_module->source_source);
// Descriptor set bindings
for (size_t i = 0; i < p_module->descriptor_set_count; ++i) {
SpvReflectDescriptorSet* p_set = &p_module->descriptor_sets[i];
free(p_set->bindings);
}
// Descriptor binding blocks
for (size_t i = 0; i < p_module->descriptor_binding_count; ++i) {
SpvReflectDescriptorBinding* p_descriptor = &p_module->descriptor_bindings[i];
SafeFreeBlockVariables(&p_descriptor->block);
}
SafeFree(p_module->descriptor_bindings);
// Entry points
for (size_t i = 0; i < p_module->entry_point_count; ++i) {
SpvReflectEntryPoint* p_entry = &p_module->entry_points[i];
for (size_t j = 0; j < p_entry->interface_variable_count; j++) {
SafeFreeInterfaceVariable(&p_entry->interface_variables[j]);
}
for (uint32_t j = 0; j < p_entry->descriptor_set_count; ++j) {
SafeFree(p_entry->descriptor_sets[j].bindings);
}
SafeFree(p_entry->descriptor_sets);
SafeFree(p_entry->input_variables);
SafeFree(p_entry->output_variables);
SafeFree(p_entry->interface_variables);
SafeFree(p_entry->used_uniforms);
SafeFree(p_entry->used_push_constants);
}
SafeFree(p_module->entry_points);
// Push constants
for (size_t i = 0; i < p_module->push_constant_block_count; ++i) {
SafeFreeBlockVariables(&p_module->push_constant_blocks[i]);
}
SafeFree(p_module->push_constant_blocks);
// Type infos
for (size_t i = 0; i < p_module->_internal->type_description_count; ++i) {
SpvReflectTypeDescription* p_type = &p_module->_internal->type_descriptions[i];
if (IsNotNull(p_type->members)) {
SafeFreeTypes(p_type);
}
SafeFree(p_type->members);
}
SafeFree(p_module->_internal->type_descriptions);
// Free SPIR-V code
SafeFree(p_module->_internal->spirv_code);
// Free internal
SafeFree(p_module->_internal);
}
uint32_t spvReflectGetCodeSize(const SpvReflectShaderModule* p_module)
{
if (IsNull(p_module)) {
return 0;
}
return (uint32_t)(p_module->_internal->spirv_size);
}
const uint32_t* spvReflectGetCode(const SpvReflectShaderModule* p_module)
{
if (IsNull(p_module)) {
return NULL;
}
return p_module->_internal->spirv_code;
}
const SpvReflectEntryPoint* spvReflectGetEntryPoint(
const SpvReflectShaderModule* p_module,
const char* entry_point
) {
if (IsNull(p_module) || IsNull(entry_point)) {
return NULL;
}
for (uint32_t i = 0; i < p_module->entry_point_count; ++i) {
if (strcmp(p_module->entry_points[i].name, entry_point) == 0) {
return &p_module->entry_points[i];
}
}
return NULL;
}
SpvReflectResult spvReflectEnumerateDescriptorBindings(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectDescriptorBinding** pp_bindings
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNotNull(pp_bindings)) {
if (*p_count != p_module->descriptor_binding_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectDescriptorBinding* p_bindings = (SpvReflectDescriptorBinding*)&p_module->descriptor_bindings[index];
pp_bindings[index] = p_bindings;
}
}
else {
*p_count = p_module->descriptor_binding_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateEntryPointDescriptorBindings(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t* p_count,
SpvReflectDescriptorBinding** pp_bindings
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
uint32_t count = 0;
for (uint32_t i = 0; i < p_module->descriptor_binding_count; ++i) {
bool found = SearchSortedUint32(
p_entry->used_uniforms,
p_entry->used_uniform_count,
p_module->descriptor_bindings[i].spirv_id);
if (found) {
if (IsNotNull(pp_bindings)) {
if (count >= *p_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
pp_bindings[count++] = (SpvReflectDescriptorBinding*)&p_module->descriptor_bindings[i];
} else {
++count;
}
}
}
if (IsNotNull(pp_bindings)) {
if (count != *p_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
} else {
*p_count = count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateDescriptorSets(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectDescriptorSet** pp_sets
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNotNull(pp_sets)) {
if (*p_count != p_module->descriptor_set_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectDescriptorSet* p_set = (SpvReflectDescriptorSet*)&p_module->descriptor_sets[index];
pp_sets[index] = p_set;
}
}
else {
*p_count = p_module->descriptor_set_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateEntryPointDescriptorSets(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t* p_count,
SpvReflectDescriptorSet** pp_sets
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
if (IsNotNull(pp_sets)) {
if (*p_count != p_entry->descriptor_set_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectDescriptorSet* p_set = (SpvReflectDescriptorSet*)&p_entry->descriptor_sets[index];
pp_sets[index] = p_set;
}
}
else {
*p_count = p_entry->descriptor_set_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateInterfaceVariables(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectInterfaceVariable** pp_variables
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNotNull(pp_variables)) {
if (*p_count != p_module->interface_variable_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectInterfaceVariable* p_var = &p_module->interface_variables[index];
pp_variables[index] = p_var;
}
}
else {
*p_count = p_module->interface_variable_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateEntryPointInterfaceVariables(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t* p_count,
SpvReflectInterfaceVariable** pp_variables
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
if (IsNotNull(pp_variables)) {
if (*p_count != p_entry->interface_variable_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectInterfaceVariable* p_var = &p_entry->interface_variables[index];
pp_variables[index] = p_var;
}
}
else {
*p_count = p_entry->interface_variable_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateInputVariables(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectInterfaceVariable** pp_variables
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNotNull(pp_variables)) {
if (*p_count != p_module->input_variable_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectInterfaceVariable* p_var = p_module->input_variables[index];
pp_variables[index] = p_var;
}
}
else {
*p_count = p_module->input_variable_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateEntryPointInputVariables(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t* p_count,
SpvReflectInterfaceVariable** pp_variables
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
if (IsNotNull(pp_variables)) {
if (*p_count != p_entry->input_variable_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectInterfaceVariable* p_var = p_entry->input_variables[index];
pp_variables[index] = p_var;
}
}
else {
*p_count = p_entry->input_variable_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateOutputVariables(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectInterfaceVariable** pp_variables
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNotNull(pp_variables)) {
if (*p_count != p_module->output_variable_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectInterfaceVariable* p_var = p_module->output_variables[index];
pp_variables[index] = p_var;
}
}
else {
*p_count = p_module->output_variable_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumerateEntryPointOutputVariables(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t* p_count,
SpvReflectInterfaceVariable** pp_variables
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
if (IsNotNull(pp_variables)) {
if (*p_count != p_entry->output_variable_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectInterfaceVariable* p_var = p_entry->output_variables[index];
pp_variables[index] = p_var;
}
}
else {
*p_count = p_entry->output_variable_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumeratePushConstantBlocks(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectBlockVariable** pp_blocks
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (pp_blocks != NULL) {
if (*p_count != p_module->push_constant_block_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
for (uint32_t index = 0; index < *p_count; ++index) {
SpvReflectBlockVariable* p_push_constant_blocks = (SpvReflectBlockVariable*)&p_module->push_constant_blocks[index];
pp_blocks[index] = p_push_constant_blocks;
}
}
else {
*p_count = p_module->push_constant_block_count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectEnumeratePushConstants(
const SpvReflectShaderModule* p_module,
uint32_t* p_count,
SpvReflectBlockVariable** pp_blocks
)
{
return spvReflectEnumeratePushConstantBlocks(p_module, p_count, pp_blocks);
}
SpvReflectResult spvReflectEnumerateEntryPointPushConstantBlocks(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t* p_count,
SpvReflectBlockVariable** pp_blocks
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_count)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
uint32_t count = 0;
for (uint32_t i = 0; i < p_module->push_constant_block_count; ++i) {
bool found = SearchSortedUint32(p_entry->used_push_constants,
p_entry->used_push_constant_count,
p_module->push_constant_blocks[i].spirv_id);
if (found) {
if (IsNotNull(pp_blocks)) {
if (count >= *p_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
pp_blocks[count++] = (SpvReflectBlockVariable*)&p_module->push_constant_blocks[i];
} else {
++count;
}
}
}
if (IsNotNull(pp_blocks)) {
if (count != *p_count) {
return SPV_REFLECT_RESULT_ERROR_COUNT_MISMATCH;
}
} else {
*p_count = count;
}
return SPV_REFLECT_RESULT_SUCCESS;
}
const SpvReflectDescriptorBinding* spvReflectGetDescriptorBinding(
const SpvReflectShaderModule* p_module,
uint32_t binding_number,
uint32_t set_number,
SpvReflectResult* p_result
)
{
const SpvReflectDescriptorBinding* p_descriptor = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->descriptor_binding_count; ++index) {
const SpvReflectDescriptorBinding* p_potential = &p_module->descriptor_bindings[index];
if ((p_potential->binding == binding_number) && (p_potential->set == set_number)) {
p_descriptor = p_potential;
break;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_descriptor)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_descriptor;
}
const SpvReflectDescriptorBinding* spvReflectGetEntryPointDescriptorBinding(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t binding_number,
uint32_t set_number,
SpvReflectResult* p_result
)
{
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectDescriptorBinding* p_descriptor = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->descriptor_binding_count; ++index) {
const SpvReflectDescriptorBinding* p_potential = &p_module->descriptor_bindings[index];
bool found = SearchSortedUint32(
p_entry->used_uniforms,
p_entry->used_uniform_count,
p_potential->spirv_id);
if ((p_potential->binding == binding_number) && (p_potential->set == set_number) && found) {
p_descriptor = p_potential;
break;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_descriptor)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_descriptor;
}
const SpvReflectDescriptorSet* spvReflectGetDescriptorSet(
const SpvReflectShaderModule* p_module,
uint32_t set_number,
SpvReflectResult* p_result
)
{
const SpvReflectDescriptorSet* p_set = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->descriptor_set_count; ++index) {
const SpvReflectDescriptorSet* p_potential = &p_module->descriptor_sets[index];
if (p_potential->set == set_number) {
p_set = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_set)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_set;
}
const SpvReflectDescriptorSet* spvReflectGetEntryPointDescriptorSet(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t set_number,
SpvReflectResult* p_result)
{
const SpvReflectDescriptorSet* p_set = NULL;
if (IsNotNull(p_module)) {
const SpvReflectEntryPoint* p_entry = spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
for (uint32_t index = 0; index < p_entry->descriptor_set_count; ++index) {
const SpvReflectDescriptorSet* p_potential = &p_entry->descriptor_sets[index];
if (p_potential->set == set_number) {
p_set = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_set)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_set;
}
const SpvReflectInterfaceVariable* spvReflectGetInputVariableByLocation(
const SpvReflectShaderModule* p_module,
uint32_t location,
SpvReflectResult* p_result
)
{
if (location == INVALID_VALUE) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->input_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_module->input_variables[index];
if (p_potential->location == location) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetInputVariable(
const SpvReflectShaderModule* p_module,
uint32_t location,
SpvReflectResult* p_result
)
{
return spvReflectGetInputVariableByLocation(p_module, location, p_result);
}
const SpvReflectInterfaceVariable* spvReflectGetEntryPointInputVariableByLocation(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t location,
SpvReflectResult* p_result
)
{
if (location == INVALID_VALUE) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
for (uint32_t index = 0; index < p_entry->input_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_entry->input_variables[index];
if (p_potential->location == location) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetInputVariableBySemantic(
const SpvReflectShaderModule* p_module,
const char* semantic,
SpvReflectResult* p_result
)
{
if (IsNull(semantic)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
return NULL;
}
if (semantic[0] == '\0') {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->input_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_module->input_variables[index];
if (p_potential->semantic != NULL && strcmp(p_potential->semantic, semantic) == 0) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetEntryPointInputVariableBySemantic(
const SpvReflectShaderModule* p_module,
const char* entry_point,
const char* semantic,
SpvReflectResult* p_result
)
{
if (IsNull(semantic)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
return NULL;
}
if (semantic[0] == '\0') {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
const SpvReflectEntryPoint* p_entry = spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
for (uint32_t index = 0; index < p_entry->input_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_entry->input_variables[index];
if (p_potential->semantic != NULL && strcmp(p_potential->semantic, semantic) == 0) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetOutputVariableByLocation(
const SpvReflectShaderModule* p_module,
uint32_t location,
SpvReflectResult* p_result
)
{
if (location == INVALID_VALUE) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->output_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_module->output_variables[index];
if (p_potential->location == location) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetOutputVariable(
const SpvReflectShaderModule* p_module,
uint32_t location,
SpvReflectResult* p_result
)
{
return spvReflectGetOutputVariableByLocation(p_module, location, p_result);
}
const SpvReflectInterfaceVariable* spvReflectGetEntryPointOutputVariableByLocation(
const SpvReflectShaderModule* p_module,
const char* entry_point,
uint32_t location,
SpvReflectResult* p_result
)
{
if (location == INVALID_VALUE) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
const SpvReflectEntryPoint* p_entry = spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
for (uint32_t index = 0; index < p_entry->output_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_entry->output_variables[index];
if (p_potential->location == location) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetOutputVariableBySemantic(
const SpvReflectShaderModule* p_module,
const char* semantic,
SpvReflectResult* p_result
)
{
if (IsNull(semantic)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
return NULL;
}
if (semantic[0] == '\0') {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
for (uint32_t index = 0; index < p_module->output_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_module->output_variables[index];
if (p_potential->semantic != NULL && strcmp(p_potential->semantic, semantic) == 0) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectInterfaceVariable* spvReflectGetEntryPointOutputVariableBySemantic(
const SpvReflectShaderModule* p_module,
const char* entry_point,
const char* semantic,
SpvReflectResult* p_result)
{
if (IsNull(semantic)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
return NULL;
}
if (semantic[0] == '\0') {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
const SpvReflectInterfaceVariable* p_var = NULL;
if (IsNotNull(p_module)) {
const SpvReflectEntryPoint* p_entry = spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
for (uint32_t index = 0; index < p_entry->output_variable_count; ++index) {
const SpvReflectInterfaceVariable* p_potential = p_entry->output_variables[index];
if (p_potential->semantic != NULL && strcmp(p_potential->semantic, semantic) == 0) {
p_var = p_potential;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_var)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_var;
}
const SpvReflectBlockVariable* spvReflectGetPushConstantBlock(
const SpvReflectShaderModule* p_module,
uint32_t index,
SpvReflectResult* p_result
)
{
const SpvReflectBlockVariable* p_push_constant = NULL;
if (IsNotNull(p_module)) {
if (index < p_module->push_constant_block_count) {
p_push_constant = &p_module->push_constant_blocks[index];
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_push_constant)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_push_constant;
}
const SpvReflectBlockVariable* spvReflectGetPushConstant(
const SpvReflectShaderModule* p_module,
uint32_t index,
SpvReflectResult* p_result
)
{
return spvReflectGetPushConstantBlock(p_module, index, p_result);
}
const SpvReflectBlockVariable* spvReflectGetEntryPointPushConstantBlock(
const SpvReflectShaderModule* p_module,
const char* entry_point,
SpvReflectResult* p_result)
{
const SpvReflectBlockVariable* p_push_constant = NULL;
if (IsNotNull(p_module)) {
const SpvReflectEntryPoint* p_entry =
spvReflectGetEntryPoint(p_module, entry_point);
if (IsNull(p_entry)) {
if (IsNotNull(p_result)) {
*p_result = SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
return NULL;
}
for (uint32_t i = 0; i < p_module->push_constant_block_count; ++i) {
bool found = SearchSortedUint32(
p_entry->used_push_constants,
p_entry->used_push_constant_count,
p_module->push_constant_blocks[i].spirv_id);
if (found) {
p_push_constant = &p_module->push_constant_blocks[i];
break;
}
}
}
if (IsNotNull(p_result)) {
*p_result = IsNotNull(p_push_constant)
? SPV_REFLECT_RESULT_SUCCESS
: (IsNull(p_module) ? SPV_REFLECT_RESULT_ERROR_NULL_POINTER
: SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
}
return p_push_constant;
}
SpvReflectResult spvReflectChangeDescriptorBindingNumbers(
SpvReflectShaderModule* p_module,
const SpvReflectDescriptorBinding* p_binding,
uint32_t new_binding_number,
uint32_t new_set_binding
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_binding)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
SpvReflectDescriptorBinding* p_target_descriptor = NULL;
for (uint32_t index = 0; index < p_module->descriptor_binding_count; ++index) {
if(&p_module->descriptor_bindings[index] == p_binding) {
p_target_descriptor = &p_module->descriptor_bindings[index];
break;
}
}
if (IsNotNull(p_target_descriptor)) {
if (p_target_descriptor->word_offset.binding > (p_module->_internal->spirv_word_count - 1)) {
return SPV_REFLECT_RESULT_ERROR_RANGE_EXCEEDED;
}
// Binding number
if (new_binding_number != (uint32_t)SPV_REFLECT_BINDING_NUMBER_DONT_CHANGE) {
uint32_t* p_code = p_module->_internal->spirv_code + p_target_descriptor->word_offset.binding;
*p_code = new_binding_number;
p_target_descriptor->binding = new_binding_number;
}
// Set number
if (new_set_binding != (uint32_t)SPV_REFLECT_SET_NUMBER_DONT_CHANGE) {
uint32_t* p_code = p_module->_internal->spirv_code + p_target_descriptor->word_offset.set;
*p_code = new_set_binding;
p_target_descriptor->set = new_set_binding;
}
}
SpvReflectResult result = SPV_REFLECT_RESULT_SUCCESS;
if (new_set_binding != (uint32_t)SPV_REFLECT_SET_NUMBER_DONT_CHANGE) {
result = SynchronizeDescriptorSets(p_module);
}
return result;
}
SpvReflectResult spvReflectChangeDescriptorBindingNumber(
SpvReflectShaderModule* p_module,
const SpvReflectDescriptorBinding* p_descriptor_binding,
uint32_t new_binding_number,
uint32_t optional_new_set_number
)
{
return spvReflectChangeDescriptorBindingNumbers(
p_module,p_descriptor_binding,
new_binding_number,
optional_new_set_number);
}
SpvReflectResult spvReflectChangeDescriptorSetNumber(
SpvReflectShaderModule* p_module,
const SpvReflectDescriptorSet* p_set,
uint32_t new_set_number
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_set)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
SpvReflectDescriptorSet* p_target_set = NULL;
for (uint32_t index = 0; index < SPV_REFLECT_MAX_DESCRIPTOR_SETS; ++index) {
// The descriptor sets for specific entry points might not be in this set,
// so just match on set index.
if (p_module->descriptor_sets[index].set == p_set->set) {
p_target_set = (SpvReflectDescriptorSet*)p_set;
break;
}
}
SpvReflectResult result = SPV_REFLECT_RESULT_SUCCESS;
if (IsNotNull(p_target_set) && new_set_number != (uint32_t)SPV_REFLECT_SET_NUMBER_DONT_CHANGE) {
for (uint32_t index = 0; index < p_target_set->binding_count; ++index) {
SpvReflectDescriptorBinding* p_descriptor = p_target_set->bindings[index];
if (p_descriptor->word_offset.set > (p_module->_internal->spirv_word_count - 1)) {
return SPV_REFLECT_RESULT_ERROR_RANGE_EXCEEDED;
}
uint32_t* p_code = p_module->_internal->spirv_code + p_descriptor->word_offset.set;
*p_code = new_set_number;
p_descriptor->set = new_set_number;
}
result = SynchronizeDescriptorSets(p_module);
}
return result;
}
static SpvReflectResult ChangeVariableLocation(
SpvReflectShaderModule* p_module,
SpvReflectInterfaceVariable* p_variable,
uint32_t new_location
)
{
if (p_variable->word_offset.location > (p_module->_internal->spirv_word_count - 1)) {
return SPV_REFLECT_RESULT_ERROR_RANGE_EXCEEDED;
}
uint32_t* p_code = p_module->_internal->spirv_code + p_variable->word_offset.location;
*p_code = new_location;
p_variable->location = new_location;
return SPV_REFLECT_RESULT_SUCCESS;
}
SpvReflectResult spvReflectChangeInputVariableLocation(
SpvReflectShaderModule* p_module,
const SpvReflectInterfaceVariable* p_input_variable,
uint32_t new_location
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_input_variable)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
for (uint32_t index = 0; index < p_module->input_variable_count; ++index) {
if(p_module->input_variables[index] == p_input_variable) {
return ChangeVariableLocation(p_module, p_module->input_variables[index], new_location);
}
}
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
SpvReflectResult spvReflectChangeOutputVariableLocation(
SpvReflectShaderModule* p_module,
const SpvReflectInterfaceVariable* p_output_variable,
uint32_t new_location
)
{
if (IsNull(p_module)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
if (IsNull(p_output_variable)) {
return SPV_REFLECT_RESULT_ERROR_NULL_POINTER;
}
for (uint32_t index = 0; index < p_module->output_variable_count; ++index) {
if(p_module->output_variables[index] == p_output_variable) {
return ChangeVariableLocation(p_module, p_module->output_variables[index], new_location);
}
}
return SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND;
}
const char* spvReflectSourceLanguage(SpvSourceLanguage source_lang)
{
switch (source_lang) {
case SpvSourceLanguageUnknown : return "Unknown";
case SpvSourceLanguageESSL : return "ESSL";
case SpvSourceLanguageGLSL : return "GLSL";
case SpvSourceLanguageOpenCL_C : return "OpenCL_C";
case SpvSourceLanguageOpenCL_CPP : return "OpenCL_CPP";
case SpvSourceLanguageHLSL : return "HLSL";
case SpvSourceLanguageMax:
break;
}
return "";
}
|