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
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
18921
18922
18923
18924
18925
18926
18927
18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015
20016
20017
20018
20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
20069
20070
20071
20072
20073
20074
20075
20076
20077
20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
20088
20089
20090
20091
20092
20093
20094
20095
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
20151
20152
20153
20154
20155
20156
20157
20158
20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
20213
20214
20215
20216
20217
20218
20219
20220
20221
20222
20223
20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
20292
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
20491
20492
20493
20494
20495
20496
20497
20498
20499
20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
20632
20633
20634
20635
20636
20637
20638
20639
20640
20641
20642
20643
20644
20645
20646
20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
20813
20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
20825
20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
20864
20865
20866
20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
21240
21241
21242
21243
21244
21245
21246
21247
21248
21249
21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
21375
21376
21377
21378
21379
21380
21381
21382
21383
21384
21385
21386
21387
21388
21389
21390
21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
21443
21444
21445
21446
21447
21448
21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
21511
21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
21633
21634
21635
21636
21637
21638
21639
21640
21641
21642
21643
21644
21645
21646
21647
21648
21649
21650
21651
21652
21653
21654
21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
21721
21722
21723
21724
21725
21726
21727
21728
21729
21730
21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
21777
21778
21779
21780
21781
21782
21783
21784
21785
21786
21787
21788
21789
21790
21791
21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
21872
21873
21874
21875
21876
21877
21878
21879
21880
21881
21882
21883
21884
21885
21886
21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
21919
21920
21921
21922
21923
21924
21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
21945
21946
21947
21948
21949
21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
21966
21967
21968
21969
21970
21971
21972
21973
21974
21975
21976
21977
21978
21979
21980
21981
21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
22058
22059
22060
22061
22062
22063
22064
22065
22066
22067
22068
22069
22070
22071
22072
22073
22074
22075
22076
22077
22078
22079
22080
22081
22082
22083
22084
22085
22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
22128
22129
22130
22131
22132
22133
22134
22135
22136
22137
22138
22139
22140
22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
22190
22191
22192
22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
22259
22260
22261
22262
22263
22264
22265
22266
22267
22268
22269
22270
22271
22272
22273
22274
22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
22287
22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
22327
22328
22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367
22368
22369
22370
22371
22372
22373
22374
22375
22376
22377
22378
22379
22380
22381
22382
22383
22384
22385
22386
22387
22388
22389
22390
22391
22392
22393
22394
22395
22396
22397
22398
22399
22400
22401
22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
22447
22448
22449
22450
22451
22452
22453
22454
22455
22456
22457
22458
22459
22460
22461
22462
22463
22464
22465
22466
22467
22468
22469
22470
22471
22472
22473
22474
22475
22476
22477
22478
22479
22480
22481
22482
22483
22484
22485
22486
22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
22497
22498
22499
22500
22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
22544
22545
22546
22547
22548
22549
22550
22551
22552
22553
22554
22555
22556
22557
22558
22559
22560
22561
22562
22563
22564
22565
22566
22567
22568
22569
22570
22571
22572
22573
22574
22575
22576
22577
22578
22579
22580
22581
22582
22583
22584
22585
22586
22587
22588
22589
22590
22591
22592
22593
22594
22595
22596
22597
22598
22599
22600
22601
22602
22603
22604
22605
22606
|
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX FlowGraph XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
#include "jitpch.h"
#ifdef _MSC_VER
#pragma hdrstop
#endif
#include "allocacheck.h" // for alloca
/*****************************************************************************/
void Compiler::fgInit()
{
impInit();
/* Initialization for fgWalkTreePre() and fgWalkTreePost() */
fgFirstBBScratch = nullptr;
#ifdef DEBUG
fgInlinedCount = 0;
#endif // DEBUG
/* We haven't yet computed the bbPreds lists */
fgComputePredsDone = false;
/* We haven't yet computed the bbCheapPreds lists */
fgCheapPredsValid = false;
/* We haven't yet computed the edge weight */
fgEdgeWeightsComputed = false;
fgHaveValidEdgeWeights = false;
fgSlopUsedInEdgeWeights = false;
fgRangeUsedInEdgeWeights = true;
fgNeedsUpdateFlowGraph = false;
fgCalledWeight = BB_ZERO_WEIGHT;
/* We haven't yet computed the dominator sets */
fgDomsComputed = false;
#ifdef DEBUG
fgReachabilitySetsValid = false;
#endif // DEBUG
/* We don't know yet which loops will always execute calls */
fgLoopCallMarked = false;
/* We haven't created GC Poll blocks yet. */
fgGCPollsCreated = false;
/* Initialize the basic block list */
fgFirstBB = NULL;
fgLastBB = NULL;
fgFirstColdBlock = NULL;
#if FEATURE_EH_FUNCLETS
fgFirstFuncletBB = NULL;
fgFuncletsCreated = false;
#endif // FEATURE_EH_FUNCLETS
fgBBcount = 0;
#ifdef DEBUG
fgBBcountAtCodegen = 0;
#endif // DEBUG
fgBBNumMax = 0;
fgEdgeCount = 0;
fgDomBBcount = 0;
fgBBVarSetsInited = false;
fgReturnCount = 0;
// Initialize BlockSet data.
fgCurBBEpoch = 0;
fgCurBBEpochSize = 0;
fgBBSetCountInSizeTUnits = 0;
genReturnBB = NULL;
/* We haven't reached the global morphing phase */
fgGlobalMorph = false;
fgExpandInline = false;
fgModified = false;
#ifdef DEBUG
fgSafeBasicBlockCreation = true;
#endif // DEBUG
fgLocalVarLivenessDone = false;
/* Statement list is not threaded yet */
fgStmtListThreaded = false;
// Initialize the logic for adding code. This is used to insert code such
// as the code that raises an exception when an array range check fails.
fgAddCodeList = 0;
fgAddCodeModf = false;
for (int i = 0; i < ACK_COUNT; i++)
{
fgExcptnTargetCache[i] = NULL;
}
/* Keep track of the max count of pointer arguments */
fgPtrArgCntCur = 0;
fgPtrArgCntMax = 0;
/* This global flag is set whenever we remove a statement */
fgStmtRemoved = false;
/* This global flag is set whenever we add a throw block for a RngChk */
fgRngChkThrowAdded = false; /* reset flag for fgIsCodeAdded() */
fgIncrCount = 0;
/* We will record a list of all BBJ_RETURN blocks here */
fgReturnBlocks = NULL;
/* This is set by fgComputeReachability */
fgEnterBlks = BlockSetOps::UninitVal();
#ifdef DEBUG
fgEnterBlksSetValid = false;
#endif // DEBUG
#if !FEATURE_EH_FUNCLETS
ehMaxHndNestingCount = 0;
#endif // !FEATURE_EH_FUNCLETS
/* Init the fgBigOffsetMorphingTemps to be BAD_VAR_NUM. */
for (int i = 0; i < TYP_COUNT; i++)
{
fgBigOffsetMorphingTemps[i] = BAD_VAR_NUM;
}
fgNoStructPromotion = false;
fgNoStructParamPromotion = false;
optValnumCSE_phase = false; // referenced in fgMorphSmpOp()
#ifdef DEBUG
fgNormalizeEHDone = false;
#endif // DEBUG
#ifdef DEBUG
if (!compIsForInlining())
{
static ConfigDWORD fJitNoStructPromotion;
if ((fJitNoStructPromotion.val(CLRConfig::INTERNAL_JitNoStructPromotion) & 1) == 1)
{
fgNoStructPromotion = true;
}
if ((fJitNoStructPromotion.val(CLRConfig::INTERNAL_JitNoStructPromotion) & 2) == 2)
{
fgNoStructParamPromotion = true;
}
}
#endif // DEBUG
if (!compIsForInlining())
{
m_promotedStructDeathVars = NULL;
}
#ifdef FEATURE_SIMD
fgPreviousCandidateSIMDFieldAsgStmt = nullptr;
#endif
}
bool Compiler::fgHaveProfileData()
{
if (compIsForInlining() || compIsForImportOnly())
return false;
return (fgProfileBuffer != NULL);
}
bool Compiler::fgGetProfileWeightForBasicBlock(IL_OFFSET offset, unsigned* weightWB)
{
noway_assert(weightWB != NULL);
unsigned weight = 0;
#ifdef DEBUG
unsigned hashSeed = fgStressBBProf();
if (hashSeed != 0)
{
unsigned hash = (info.compMethodHash() * hashSeed) ^ (offset * 1027);
// We need to especially stress the procedure splitting codepath. Therefore
// one third the time we should return a weight of zero.
// Otherwise we should return some random weight (usually between 0 and 288).
// The below gives a weight of zero, 44% of the time
if (hash % 3 == 0)
{
weight = 0;
}
else if (hash % 11 == 0)
{
weight = (hash % 23) * (hash % 29) * (hash % 31);
}
else
{
weight = (hash % 17) * (hash % 19);
}
// The first block is never given a weight of zero
if ((offset == 0) && (weight == 0))
{
weight = 1 + (hash % 5);
}
*weightWB = weight;
return true;
}
#endif // DEBUG
if (fgHaveProfileData() == false)
{
return false;
}
noway_assert(!compIsForInlining());
for (unsigned i = 0; i < fgProfileBufferCount; i++)
{
if (fgProfileBuffer[i].ILOffset == offset)
{
weight = fgProfileBuffer[i].ExecutionCount;
*weightWB = weight;
return true;
}
}
*weightWB = 0;
return true;
}
void Compiler::fgInstrumentMethod()
{
noway_assert(!compIsForInlining());
// Count the number of basic blocks in the method
int countOfBlocks = 0;
BasicBlock* block;
for (block = fgFirstBB; block; block = block->bbNext)
{
if (!(block->bbFlags & BBF_IMPORTED) || (block->bbFlags & BBF_INTERNAL))
{
continue;
}
countOfBlocks++;
}
// Allocate the profile buffer
ICorJitInfo::ProfileBuffer* bbProfileBuffer;
HRESULT res = info.compCompHnd->allocBBProfileBuffer(countOfBlocks, &bbProfileBuffer);
ICorJitInfo::ProfileBuffer *bbProfileBufferStart = bbProfileBuffer;
GenTreePtr stmt;
if (!SUCCEEDED(res))
{
// The E_NOTIMPL status is returned when we are profiling a generic method from a different assembly
if (res == E_NOTIMPL)
{
// In such cases we still want to add the method entry callback node
GenTreeArgList* args = gtNewArgList(gtNewIconEmbMethHndNode(info.compMethodHnd));
GenTreePtr call = gtNewHelperCallNode(CORINFO_HELP_BBT_FCN_ENTER, TYP_VOID, 0, args);
stmt = gtNewStmt(call);
}
else
{
noway_assert(!"Error: failed to allocate bbProfileBuffer");
return;
}
}
else
{
// Assign a buffer entry for each basic block
for (block = fgFirstBB; block; block = block->bbNext)
{
if (!(block->bbFlags & BBF_IMPORTED) || (block->bbFlags & BBF_INTERNAL))
{
continue;
}
bbProfileBuffer->ILOffset = block->bbCodeOffs;
GenTreePtr addr;
GenTreePtr value;
value = gtNewOperNode(GT_IND, TYP_INT,
gtNewIconEmbHndNode((void*) &bbProfileBuffer->ExecutionCount, NULL, GTF_ICON_BBC_PTR));
value = gtNewOperNode(GT_ADD, TYP_INT, value, gtNewIconNode(1));
addr = gtNewOperNode(GT_IND, TYP_INT,
gtNewIconEmbHndNode((void*) &bbProfileBuffer->ExecutionCount, NULL, GTF_ICON_BBC_PTR));
addr = gtNewAssignNode(addr, value);
fgInsertStmtAtBeg(block, addr);
countOfBlocks--;
bbProfileBuffer++;
}
noway_assert(countOfBlocks == 0);
// Add the method entry callback node
GenTreeArgList* args = gtNewArgList( gtNewIconEmbMethHndNode(info.compMethodHnd));
GenTreePtr call = gtNewHelperCallNode(CORINFO_HELP_BBT_FCN_ENTER, TYP_VOID, 0, args);
GenTreePtr handle = gtNewIconEmbHndNode((void*) &bbProfileBufferStart->ExecutionCount, NULL, GTF_ICON_BBC_PTR);
GenTreePtr value = gtNewOperNode(GT_IND, TYP_INT, handle);
GenTreePtr relop = gtNewOperNode(GT_NE, TYP_INT, value, gtNewIconNode(0, TYP_INT));
relop->gtFlags |= GTF_RELOP_QMARK;
GenTreePtr colon = new (this, GT_COLON) GenTreeColon(TYP_VOID, gtNewNothingNode(), call);
GenTreePtr cond = gtNewQmarkNode(TYP_VOID, relop, colon);
stmt = gtNewStmt(cond);
}
fgEnsureFirstBBisScratch();
fgInsertStmtAtEnd(fgFirstBB, stmt);
}
/*****************************************************************************
*
* Create a basic block and append it to the current BB list.
*/
BasicBlock * Compiler::fgNewBasicBlock(BBjumpKinds jumpKind)
{
// This method must not be called after the exception table has been
// constructed, because it doesn't not provide support for patching
// the exception table.
noway_assert(compHndBBtabCount == 0);
BasicBlock* block;
/* Allocate the block descriptor */
block = bbNewBasicBlock(jumpKind);
noway_assert(block->bbJumpKind == jumpKind);
/* Append the block to the end of the global basic block list */
if (fgFirstBB)
{
fgLastBB->setNext(block);
}
else
{
fgFirstBB = block;
block->bbPrev = nullptr;
}
fgLastBB = block;
return block;
}
/*****************************************************************************
*
* Ensures that fgFirstBB is a scratch BasicBlock that we have added.
* This can be used to add initialization code (without worrying
* about other blocks jumping to it).
*
* Callers have to be careful that they do not mess up the order of things
* added to fgEnsureFirstBBisScratch in a way as to change semantics.
*/
void Compiler::fgEnsureFirstBBisScratch()
{
// Have we already allocated a scratch block?
if (fgFirstBBisScratch())
return;
assert(fgFirstBBScratch == nullptr);
BasicBlock* block = bbNewBasicBlock(BBJ_NONE);
if (fgFirstBB != NULL)
{
// If we have profile data the new block will inherit fgFirstBlock's weight
if (fgFirstBB->bbFlags & BBF_PROF_WEIGHT)
{
block->inheritWeight(fgFirstBB);
}
fgInsertBBbefore(fgFirstBB, block);
}
else
{
noway_assert(fgLastBB == NULL);
fgFirstBB = block;
fgLastBB = block;
}
noway_assert(fgLastBB != NULL);
block->bbFlags |= (BBF_INTERNAL | BBF_IMPORTED);
fgFirstBBScratch = fgFirstBB;
#ifdef DEBUG
if (verbose)
{
printf("New scratch BB%02u\n", block->bbNum);
}
#endif
}
bool Compiler::fgFirstBBisScratch()
{
if (fgFirstBBScratch != nullptr)
{
assert(fgFirstBBScratch == fgFirstBB);
assert(fgFirstBBScratch->bbFlags & BBF_INTERNAL);
assert(fgFirstBBScratch->countOfInEdges() == 1);
// Normally, the first scratch block is a fall-through block. However, if the block after it was an empty
// BBJ_ALWAYS block, it might get removed, and the code that removes it will make the first scratch block
// a BBJ_ALWAYS block.
assert((fgFirstBBScratch->bbJumpKind == BBJ_NONE) ||
(fgFirstBBScratch->bbJumpKind == BBJ_ALWAYS));
return true;
}
else
{
return false;
}
}
bool Compiler::fgBBisScratch(BasicBlock* block)
{
return fgFirstBBisScratch() && (block == fgFirstBB);
}
#ifdef DEBUG
// Check to see if block contains a statement but don't spend more than a certain
// budget doing this per method compiled.
// If the budget is exceeded, return 'answerOnBoundExceeded' as the answer.
/* static */
bool Compiler::fgBlockContainsStatementBounded(BasicBlock* block, GenTree* stmt, bool answerOnBoundExceeded /*= true*/)
{
const __int64 maxLinks = 1000000000;
assert(stmt->gtOper == GT_STMT);
__int64 *numTraversed = &GetTlsCompiler()->compNumStatementLinksTraversed;
if (*numTraversed > maxLinks)
return answerOnBoundExceeded;
GenTree* curr = block->firstStmt();
do
{
(*numTraversed)++;
if (curr == stmt)
break;
curr = curr->gtNext;
}
while (curr);
return curr != NULL;
}
#endif // DEBUG
//------------------------------------------------------------------------
// fgInsertStmtAtBeg: Insert the given tree or statement at the start of the given basic block.
//
// Arguments:
// block - The block into which 'stmt' will be inserted.
// stmt - The statement to be inserted.
//
// Return Value:
// Returns the new (potentially) GT_STMT node.
//
// Notes:
// If 'stmt' is not already a statement, a new statement is created from it.
// We always insert phi statements at the beginning.
// In other cases, if there are any phi assignments and/or an assignment of
// the GT_CATCH_ARG, we insert after those.
GenTreePtr Compiler::fgInsertStmtAtBeg(BasicBlock* block,
GenTreePtr stmt)
{
if (stmt->gtOper != GT_STMT)
{
stmt = gtNewStmt(stmt);
}
GenTreePtr list = block->firstStmt();
if (!stmt->IsPhiDefnStmt())
{
GenTreePtr insertBeforeStmt = block->FirstNonPhiDefOrCatchArgAsg();
if (insertBeforeStmt != nullptr)
{
return fgInsertStmtBefore(block, insertBeforeStmt, stmt);
}
else if (list != nullptr)
{
return fgInsertStmtAtEnd(block, stmt);
}
// Otherwise, we will simply insert at the beginning, below.
}
/* The new tree will now be the first one of the block */
block->bbTreeList = stmt;
stmt->gtNext = list;
/* Are there any statements in the block? */
if (list)
{
GenTreePtr last;
/* There is at least one statement already */
last = list->gtPrev;
noway_assert(last && last->gtNext == nullptr);
/* Insert the statement in front of the first one */
list->gtPrev = stmt;
stmt->gtPrev = last;
}
else
{
/* The block was completely empty */
stmt->gtPrev = stmt;
}
return stmt;
}
/*****************************************************************************
*
* Insert the given tree or statement at the end of the given basic block.
* Returns the (potentially) new GT_STMT node.
* If the block can be a conditional block, use fgInsertStmtNearEnd.
*/
GenTreeStmt* Compiler::fgInsertStmtAtEnd(BasicBlock* block,
GenTreePtr node)
{
GenTreePtr list = block->firstStmt();
GenTreeStmt* stmt;
if (node->gtOper != GT_STMT)
{
stmt = gtNewStmt(node);
}
else
{
stmt = node->AsStmt();
}
assert(stmt->gtNext == nullptr); // We don't set it, and it needs to be this after the insert
if (list)
{
GenTreePtr last;
/* There is at least one statement already */
last = list->gtPrev;
noway_assert(last && last->gtNext == nullptr);
/* Append the statement after the last one */
last->gtNext = stmt;
stmt->gtPrev = last;
list->gtPrev = stmt;
}
else
{
/* The block is completely empty */
block->bbTreeList = stmt;
stmt->gtPrev = stmt;
}
return stmt;
}
/*****************************************************************************
*
* Insert the given tree or statement at the end of the given basic block, but before
* the GT_JTRUE, if present.
* Returns the (potentially) new GT_STMT node.
*/
GenTreeStmt* Compiler::fgInsertStmtNearEnd(BasicBlock* block, GenTreePtr node)
{
GenTreeStmt* stmt;
if ((block->bbJumpKind == BBJ_COND) ||
(block->bbJumpKind == BBJ_SWITCH) ||
(block->bbJumpKind == BBJ_RETURN))
{
if (node->gtOper != GT_STMT)
{
stmt = gtNewStmt(node);
}
else
{
stmt = node->AsStmt();
}
GenTreeStmt* first = block->firstStmt(); noway_assert(first);
GenTreeStmt* last = block->lastStmt(); noway_assert(last && last->gtNext == NULL);
GenTreePtr after = last->gtPrev;
#if DEBUG
if (block->bbJumpKind == BBJ_COND)
{
noway_assert(last->gtStmtExpr->gtOper == GT_JTRUE);
}
else if (block->bbJumpKind == BBJ_RETURN)
{
noway_assert((last->gtStmtExpr->gtOper == GT_RETURN) ||
(last->gtStmtExpr->gtOper == GT_JMP) ||
// BBJ_RETURN blocks in functions returning void do not get a GT_RETURN node if they
// have a .tail prefix (even if canTailCall returns false for these calls)
// code:Compiler::impImportBlockCode (search for the RET: label)
// Ditto for real tail calls (all code after them has been removed)
((last->gtStmtExpr->gtOper == GT_CALL) &&
((info.compRetType == TYP_VOID) || last->gtStmtExpr->AsCall()->IsTailCall()))
);
}
else
{
noway_assert(block->bbJumpKind == BBJ_SWITCH);
noway_assert(last->gtStmtExpr->gtOper == GT_SWITCH);
}
#endif // DEBUG
/* Append 'stmt' before 'last' */
stmt->gtNext = last;
last->gtPrev = stmt;
if (first == last)
{
/* There is only one stmt in the block */
block->bbTreeList = stmt;
stmt->gtPrev = last;
}
else
{
noway_assert(after && (after->gtNext == last));
/* Append 'stmt' after 'after' */
after->gtNext = stmt;
stmt->gtPrev = after;
}
return stmt;
}
else
{
return fgInsertStmtAtEnd(block, node);
}
}
/*****************************************************************************
*
* Insert the given statement "stmt" after GT_STMT node "insertionPoint".
* Returns the newly inserted GT_STMT node.
* Note that the gtPrev list of statment nodes is circular, but the gtNext list is not.
*/
GenTreePtr Compiler::fgInsertStmtAfter(BasicBlock* block,
GenTreePtr insertionPoint,
GenTreePtr stmt)
{
assert(block->bbTreeList != nullptr);
noway_assert(insertionPoint->gtOper == GT_STMT);
noway_assert(stmt->gtOper == GT_STMT);
assert(fgBlockContainsStatementBounded(block, insertionPoint));
assert(!fgBlockContainsStatementBounded(block, stmt, false));
if (insertionPoint->gtNext == nullptr)
{
// Ok, we want to insert after the last statement of the block.
stmt->gtNext = nullptr;
stmt->gtPrev = insertionPoint;
insertionPoint->gtNext = stmt;
// Update the backward link of the first statement of the block
// to point to the new last statement.
assert(block->bbTreeList->gtPrev == insertionPoint);
block->bbTreeList->gtPrev = stmt;
}
else
{
stmt->gtNext = insertionPoint->gtNext;
stmt->gtPrev = insertionPoint;
insertionPoint->gtNext->gtPrev = stmt;
insertionPoint->gtNext = stmt;
}
return stmt;
}
// Insert the given tree or statement before GT_STMT node "insertionPoint".
// Returns the newly inserted GT_STMT node.
GenTreePtr Compiler::fgInsertStmtBefore(BasicBlock* block,
GenTreePtr insertionPoint,
GenTreePtr stmt)
{
assert(block->bbTreeList != nullptr);
noway_assert(insertionPoint->gtOper == GT_STMT);
noway_assert(stmt->gtOper == GT_STMT);
assert(fgBlockContainsStatementBounded(block, insertionPoint));
assert(!fgBlockContainsStatementBounded(block, stmt, false));
if (insertionPoint == block->bbTreeList)
{
// We're inserting before the first statement in the block.
GenTreePtr list = block->bbTreeList;
GenTreePtr last = list->gtPrev;
stmt->gtNext = list;
stmt->gtPrev = last;
block->bbTreeList = stmt;
list->gtPrev = stmt;
}
else
{
stmt->gtNext = insertionPoint;
stmt->gtPrev = insertionPoint->gtPrev;
insertionPoint->gtPrev->gtNext = stmt;
insertionPoint->gtPrev = stmt;
}
return stmt;
}
/*****************************************************************************
*
* Insert the list of statements stmtList after the stmtAfter in block.
* Return the last statement stmtList.
*/
GenTreePtr Compiler::fgInsertStmtListAfter(BasicBlock * block, // the block where stmtAfter is in.
GenTreePtr stmtAfter, // the statement where stmtList should be inserted after.
GenTreePtr stmtList)
{
// Currently we can handle when stmtAfter and stmtList are non-NULL. This makes everything easy.
noway_assert(stmtAfter && stmtAfter->gtOper == GT_STMT);
noway_assert(stmtList && stmtList->gtOper == GT_STMT);
GenTreePtr stmtLast = stmtList->gtPrev; // Last statement in a non-empty list, circular in the gtPrev list.
noway_assert(stmtLast);
noway_assert(stmtLast->gtNext == NULL);
GenTreePtr stmtNext = stmtAfter->gtNext;
if (!stmtNext)
{
stmtAfter->gtNext = stmtList;
stmtList->gtPrev = stmtAfter;
block->bbTreeList->gtPrev = stmtLast;
goto _Done;
}
stmtAfter->gtNext = stmtList;
stmtList->gtPrev = stmtAfter;
stmtLast->gtNext = stmtNext;
stmtNext->gtPrev = stmtLast;
_Done:
noway_assert(block->bbTreeList == NULL ||
block->bbTreeList->gtPrev->gtNext == NULL);
return stmtLast;
}
/*
Removes a block from the return block list
*/
void Compiler::fgRemoveReturnBlock(BasicBlock* block)
{
if (fgReturnBlocks == nullptr)
return;
if (fgReturnBlocks->block == block)
{
// It's the 1st entry, assign new head of list.
fgReturnBlocks = fgReturnBlocks->next;
return;
}
for (BasicBlockList* retBlocks = fgReturnBlocks; retBlocks->next != nullptr; retBlocks = retBlocks->next)
{
if (retBlocks->next->block == block)
{
// Found it; splice it out.
retBlocks->next = retBlocks->next->next;
return;
}
}
}
//------------------------------------------------------------------------
// fgReplaceStmt: Replaces the top-level tree of 'stmt' with newTree
//
// Arguments:
// stmt - the statement whose tree we're replacing
// newTree - the new top-level tree for 'stmt'
//
// Return Value:
// None.
//
// Operation:
// This method has two main modes of operation:
// a) In case we're in Tree Order or we're replacing a top-level statement
// we first append the replacing statement ahead of the statement to replace
// and then remove the latter from the CFG.
// b) If we're replacing an embedded statement (and this naturally assumes we're
// in linear order), we proceed to do that in-place, i.e. replace the expression
// inside the statement to replace with the expression contained in the
// replacing node.
//
// Assumptions:
// This method will "fixup" any embedded statements from the old tree
// to the new. However, this will only work if the node which follows the
// embedded statement is preserved. This will be true if the newTree
// reuses the constituent nodes of the old tree (e.g. in the case where a
// node is replaced by a helper call with the original arguments to the node,
// but will not be true for arbitrary tree replacement.)
//
// Notes:
// This is currently only used in FGOrderLinear.
// TODO-Cleanup: This should probably simply replace the tree so that the information
// (such as IL offsets) is preserved, but currently it creates a new statement.
void Compiler::fgReplaceStmt(BasicBlock* block, GenTreeStmt* stmt, GenTreePtr newTree)
{
// fgNewStmtFromTree will sequence the nodes in newTree. Thus, if we are in FGOrderLinear,
// we will need to fixup any embedded statements after this call.
GenTreeStmt* newStmt = fgNewStmtFromTree(newTree, block);
if (stmt->gtStmtIsTopLevel() || fgOrder == FGOrderTree)
{
assert(stmt->gtStmtIsTopLevel());
fgInsertStmtAfter(block, stmt, newStmt);
// Remove the old statement now we've inserted the new one.
fgRemoveStmt(block, stmt, false);
if (fgOrder == FGOrderLinear)
{
// Because we are now in linear mode, we may have an embedded statement in the execution
// stream. It is too complex to try to sequence the new tree in an ad-hoc fashion,
// but we can't use the normal sequencing without bypassing the embedded statements.
// So, we fix them up now that we're done with the new tree.
// We preserve the order of the embedded statement relative to its gtNext.
// This is because the new tree may have a different order for its args than the
// block node did, and statements become embedded because they need to be ordered
// BEFORE something (not after).
// TODO-Cleanup: Consider finding an alternate approach to this - it seems risky
for (GenTreeStmt* embeddedStmt = newStmt->gtNextStmt;
embeddedStmt != nullptr && embeddedStmt->gtStmtIsEmbedded();
embeddedStmt = embeddedStmt->gtNextStmt)
{
GenTreePtr firstEmbeddedNode = embeddedStmt->gtStmtList;
GenTreePtr lastEmbeddedNode = embeddedStmt->gtStmtExpr;
GenTreePtr nextNode = lastEmbeddedNode->gtNext;
GenTreePtr prevNode = nextNode->gtPrev;
assert(nextNode != nullptr);
if (prevNode == nullptr)
{
// We've reordered the nodes such that the embedded statement is now first.
// Extract it.
firstEmbeddedNode->gtPrev = nullptr;
lastEmbeddedNode->gtNext = nullptr;
fgRemoveStmt(block, embeddedStmt);
fgInsertStmtBefore(block, stmt, embeddedStmt);
embeddedStmt->gtFlags |= GTF_STMT_TOP_LEVEL;
}
else
{
prevNode->gtNext = firstEmbeddedNode;
firstEmbeddedNode->gtPrev = prevNode;
nextNode->gtPrev = lastEmbeddedNode;
lastEmbeddedNode->gtNext = nextNode;
}
}
}
}
else
{
assert(fgOrder == FGOrderLinear);
GenTreePtr stmtExpr = stmt->gtStmtExpr;
GenTreePtr stmtList = stmt->gtStmtList;
// First, proceed to wire the first node in
// execution order
if (stmtList->gtPrev != nullptr)
{
stmtList->gtPrev->gtNext = newStmt->gtStmtList;
}
newStmt->gtStmtList->gtPrev = stmtList->gtPrev;
// Now, in order to wire the last execution order node
// in a statement, in case it's embedded, we have a special case
// since it *cannot* be null, its gtNext is connected to the
// 'resuming' next node in the containing statement.
// For this, we have to search for the last node in the
// newly created statement and wire it in accordingly to the
// rule just mentioned.
assert(newStmt->gtStmtExpr->gtNext == nullptr);
if (stmtExpr->gtNext != nullptr)
{
stmtExpr->gtNext->gtPrev = newStmt->gtStmtExpr;
}
newStmt->gtStmtExpr->gtNext = stmtExpr->gtNext;
stmt->gtStmtExpr = newStmt->gtStmtExpr;
stmt->gtStmtList = newStmt->gtStmtList;
#ifdef DEBUG
fgDebugCheckNodeLinks(compCurBB, stmt);
#endif // DEBUG
}
}
//------------------------------------------------------------------------
// fgGetPredForBlock: Find and return the predecessor edge corresponding to a given predecessor block.
//
// Arguments:
// block -- The block with the predecessor list to operate on.
// blockPred -- The predecessor block to find in the predecessor list.
//
// Return Value:
// The flowList edge corresponding to "blockPred". If "blockPred" is not in the predecessor list of "block",
// then returns nullptr.
//
// Assumptions:
// -- This only works on the full predecessor lists, not the cheap preds lists.
flowList* Compiler::fgGetPredForBlock(BasicBlock* block,
BasicBlock* blockPred)
{
noway_assert(block);
noway_assert(blockPred);
assert(!fgCheapPredsValid);
flowList* pred;
for (pred = block->bbPreds; pred != nullptr; pred = pred->flNext)
{
if (blockPred == pred->flBlock)
{
return pred;
}
}
return nullptr;
}
//------------------------------------------------------------------------
// fgGetPredForBlock: Find and return the predecessor edge corresponding to a given predecessor block.
// Also returns the address of the pointer that points to this edge, to make it possible to remove this edge from the
// predecessor list without doing another linear search over the edge list.
//
// Arguments:
// block -- The block with the predecessor list to operate on.
// blockPred -- The predecessor block to find in the predecessor list.
// ptrToPred -- Out parameter: set to the address of the pointer that points to the returned predecessor edge.
//
// Return Value:
// The flowList edge corresponding to "blockPred". If "blockPred" is not in the predecessor list of "block",
// then returns nullptr.
//
// Assumptions:
// -- This only works on the full predecessor lists, not the cheap preds lists.
flowList* Compiler::fgGetPredForBlock(BasicBlock* block,
BasicBlock* blockPred,
flowList*** ptrToPred)
{
assert(block);
assert(blockPred);
assert(ptrToPred);
assert(!fgCheapPredsValid);
flowList** predPrevAddr;
flowList* pred;
for (predPrevAddr = &block->bbPreds, pred = *predPrevAddr; pred != nullptr; predPrevAddr = &pred->flNext, pred = *predPrevAddr)
{
if (blockPred == pred->flBlock)
{
*ptrToPred = predPrevAddr;
return pred;
}
}
*ptrToPred = nullptr;
return nullptr;
}
//------------------------------------------------------------------------
// fgSpliceOutPred: Removes a predecessor edge for a block from the predecessor list.
//
// Arguments:
// block -- The block with the predecessor list to operate on.
// blockPred -- The predecessor block to remove from the predecessor list. It must be a predecessor of "block".
//
// Return Value:
// The flowList edge that was removed.
//
// Assumptions:
// -- "blockPred" must be a predecessor block of "block".
// -- This simply splices out the flowList object. It doesn't update block ref counts, handle duplicate counts, etc.
// For that, use fgRemoveRefPred() or fgRemoveAllRefPred().
// -- This only works on the full predecessor lists, not the cheap preds lists.
//
// Notes:
// -- This must walk the predecessor list to find the block in question. If the predecessor edge
// is found using fgGetPredForBlock(), consider using the version that hands back the predecessor pointer
// address instead, to avoid this search.
// -- Marks fgModified = true, since the flow graph has changed.
flowList* Compiler::fgSpliceOutPred(BasicBlock* block,
BasicBlock* blockPred)
{
assert(!fgCheapPredsValid);
noway_assert(block->bbPreds);
flowList* oldEdge = nullptr;
// Is this the first block in the pred list?
if (blockPred == block->bbPreds->flBlock)
{
oldEdge = block->bbPreds;
block->bbPreds = block->bbPreds->flNext;
}
else
{
flowList* pred;
for (pred = block->bbPreds;
(pred->flNext != nullptr) && (blockPred != pred->flNext->flBlock);
pred = pred->flNext)
{
// empty
}
oldEdge = pred->flNext;
if (oldEdge == nullptr)
{
noway_assert(!"Should always find the blockPred");
}
pred->flNext = pred->flNext->flNext;
}
// Any changes to the flow graph invalidate the dominator sets.
fgModified = true;
return oldEdge;
}
//------------------------------------------------------------------------
// fgAddRefPred: Increment block->bbRefs by one and add "blockPred" to the predecessor list of "block".
//
// Arguments:
// block -- A block to operate on.
// blockPred -- The predecessor block to add to the predecessor list.
// oldEdge -- Optional (default: nullptr). If non-nullptr, and a new edge is created (and the dup count
// of an existing edge is not just incremented), the edge weights are copied from this edge.
// initializingPreds -- Optional (default: false). Only set to "true" when the initial preds computation is happening.
//
// Return Value:
// The flow edge representing the predecessor.
//
// Assumptions:
// -- This only works on the full predecessor lists, not the cheap preds lists.
//
// Notes:
// -- block->bbRefs is incremented by one to account for the reduction in incoming edges.
// -- block->bbRefs is adjusted even if preds haven't been computed. If preds haven't been computed,
// the preds themselves aren't touched.
// -- fgModified is set if a new flow edge is created (but not if an existing flow edge dup count is incremented),
// indicating that the flow graph shape has changed.
flowList* Compiler::fgAddRefPred(BasicBlock* block,
BasicBlock* blockPred,
flowList* oldEdge /* = nullptr */,
bool initializingPreds /* = false */)
{
assert(block != nullptr);
assert(blockPred != nullptr);
block->bbRefs++;
if (!fgComputePredsDone && !initializingPreds)
{
// Why is someone trying to update the preds list when the preds haven't been created?
// Ignore them! This can happen when fgMorph is called before the preds list is created.
return nullptr;
}
assert(!fgCheapPredsValid);
flowList* flow = fgGetPredForBlock(block, blockPred);
if (flow)
{
noway_assert(flow->flDupCount > 0);
flow->flDupCount++;
}
else
{
flow = new (this, CMK_FlowList) flowList();
#if MEASURE_BLOCK_SIZE
genFlowNodeCnt += 1;
genFlowNodeSize += sizeof(flowList);
#endif // MEASURE_BLOCK_SIZE
// Any changes to the flow graph invalidate the dominator sets.
fgModified = true;
// Keep the predecessor list in lowest to highest bbNum order
// This allows us to discover the loops in optFindNaturalLoops
// from innermost to outermost.
// TODO-Throughput: This search is quadratic if you have many jumps
// to the same target. We need to either not bother sorting for
// debuggable code, or sort in optFindNaturalLoops, or better, make
// the code in optFindNaturalLoops not depend on order.
flowList** listp= &block->bbPreds;
while (*listp && ((*listp)->flBlock->bbNum < blockPred->bbNum))
{
listp = & (*listp)->flNext;
}
flow->flNext = *listp;
*listp = flow;
flow->flBlock = blockPred;
flow->flDupCount = 1;
if (fgHaveValidEdgeWeights)
{
// We are creating an edge from blockPred to block
// and we have already computed the edge weights, so
// we will try to setup this new edge with valid edge weights.
//
if (oldEdge != nullptr)
{
// If our caller has given us the old edge weights
// then we will use them.
//
flow->flEdgeWeightMin = oldEdge->flEdgeWeightMin;
flow->flEdgeWeightMax = oldEdge->flEdgeWeightMax;
}
else
{
// Set the max edge weight to be the minimum of block's or blockPred's weight
//
flow->flEdgeWeightMax = min(block->bbWeight, blockPred->bbWeight);
// If we are inserting a conditional block the minimum weight is zero,
// otherwise it is the same as the edge's max weight.
if (blockPred->NumSucc() > 1)
{
flow->flEdgeWeightMin = BB_ZERO_WEIGHT;
}
else
{
flow->flEdgeWeightMin = flow->flEdgeWeightMax;
}
}
}
else
{
flow->flEdgeWeightMin = BB_ZERO_WEIGHT;
flow->flEdgeWeightMax = BB_MAX_WEIGHT;
}
}
return flow;
}
//------------------------------------------------------------------------
// fgRemoveRefPred: Decrements the reference count of a predecessor edge from "blockPred" to "block",
// removing the edge if it is no longer necessary.
//
// Arguments:
// block -- A block to operate on.
// blockPred -- The predecessor block to remove from the predecessor list. It must be a predecessor of "block".
//
// Return Value:
// If the flow edge was removed (the predecessor has a "dup count" of 1),
// returns the flow graph edge that was removed. This means "blockPred" is no longer a predecessor of "block".
// Otherwise, returns nullptr. This means that "blockPred" is still a predecessor of "block" (because "blockPred"
// is a switch with multiple cases jumping to "block", or a BBJ_COND with both conditional and fall-through
// paths leading to "block").
//
// Assumptions:
// -- "blockPred" must be a predecessor block of "block".
// -- This only works on the full predecessor lists, not the cheap preds lists.
//
// Notes:
// -- block->bbRefs is decremented by one to account for the reduction in incoming edges.
// -- block->bbRefs is adjusted even if preds haven't been computed. If preds haven't been computed,
// the preds themselves aren't touched.
// -- fgModified is set if a flow edge is removed (but not if an existing flow edge dup count is decremented),
// indicating that the flow graph shape has changed.
flowList* Compiler::fgRemoveRefPred(BasicBlock* block,
BasicBlock* blockPred)
{
noway_assert(block != nullptr);
noway_assert(blockPred != nullptr);
noway_assert(block->countOfInEdges() > 0);
block->bbRefs--;
// Do nothing if we haven't calculated the predecessor list yet.
// Yes, this does happen.
// For example the predecessor lists haven't been created yet when we do fgMorph.
// But fgMorph calls fgFoldConditional, which in turn calls fgRemoveRefPred.
if (!fgComputePredsDone)
{
return nullptr;
}
assert(!fgCheapPredsValid);
flowList** ptrToPred;
flowList* pred = fgGetPredForBlock(block, blockPred, &ptrToPred);
noway_assert(pred);
noway_assert(pred->flDupCount > 0);
pred->flDupCount--;
if (pred->flDupCount == 0)
{
// Splice out the predecessor edge since it's no longer necessary.
*ptrToPred = pred->flNext;
// Any changes to the flow graph invalidate the dominator sets.
fgModified = true;
return pred;
}
else
{
return nullptr;
}
}
//------------------------------------------------------------------------
// fgRemoveAllRefPreds: Removes a predecessor edge from one block to another, no matter what the "dup count" is.
//
// Arguments:
// block -- A block to operate on.
// blockPred -- The predecessor block to remove from the predecessor list. It must be a predecessor of "block".
//
// Return Value:
// Returns the flow graph edge that was removed. The dup count on the edge is no longer valid.
//
// Assumptions:
// -- "blockPred" must be a predecessor block of "block".
// -- This only works on the full predecessor lists, not the cheap preds lists.
//
// Notes:
// block->bbRefs is decremented to account for the reduction in incoming edges.
flowList* Compiler::fgRemoveAllRefPreds(BasicBlock* block,
BasicBlock* blockPred)
{
assert(block != nullptr);
assert(blockPred != nullptr);
assert(fgComputePredsDone);
assert(!fgCheapPredsValid);
assert(block->countOfInEdges() > 0);
flowList** ptrToPred;
flowList* pred = fgGetPredForBlock(block, blockPred, &ptrToPred);
assert(pred != nullptr);
assert(pred->flDupCount > 0);
assert(block->bbRefs >= pred->flDupCount);
block->bbRefs -= pred->flDupCount;
// Now splice out the predecessor edge.
*ptrToPred = pred->flNext;
// Any changes to the flow graph invalidate the dominator sets.
fgModified = true;
return pred;
}
//------------------------------------------------------------------------
// fgRemoveAllRefPreds: Remove a predecessor edge, given the address of a pointer to it in the
// predecessor list, no matter what the "dup count" is.
//
// Arguments:
// block -- A block with the predecessor list to operate on.
// ptrToPred -- The address of a pointer to the predecessor to remove.
//
// Return Value:
// The removed predecessor edge. The dup count on the edge is no longer valid.
//
// Assumptions:
// -- The predecessor edge must be in the predecessor list for "block".
// -- This only works on the full predecessor lists, not the cheap preds lists.
//
// Notes:
// block->bbRefs is decremented by the dup count of the predecessor edge, to account for the reduction in incoming edges.
flowList* Compiler::fgRemoveAllRefPreds(BasicBlock* block,
flowList** ptrToPred)
{
assert(block != nullptr);
assert(ptrToPred != nullptr);
assert(fgComputePredsDone);
assert(!fgCheapPredsValid);
assert(block->countOfInEdges() > 0);
flowList* pred = *ptrToPred;
assert(pred != nullptr);
assert(pred->flDupCount > 0);
assert(block->bbRefs >= pred->flDupCount);
block->bbRefs -= pred->flDupCount;
// Now splice out the predecessor edge.
*ptrToPred = pred->flNext;
// Any changes to the flow graph invalidate the dominator sets.
fgModified = true;
return pred;
}
/*
Removes all the appearances of block as predecessor of others
*/
void Compiler::fgRemoveBlockAsPred(BasicBlock* block)
{
assert(!fgCheapPredsValid);
PREFIX_ASSUME(block != nullptr);
BasicBlock* bNext;
switch (block->bbJumpKind)
{
case BBJ_CALLFINALLY:
if (!(block->bbFlags & BBF_RETLESS_CALL))
{
assert(block->isBBCallAlwaysPair());
/* The block after the BBJ_CALLFINALLY block is not reachable */
bNext = block->bbNext;
/* bNext is an unreachable BBJ_ALWAYS block */
noway_assert(bNext->bbJumpKind == BBJ_ALWAYS);
while (bNext->countOfInEdges() > 0)
{
fgRemoveRefPred(bNext, bNext->bbPreds->flBlock);
}
}
__fallthrough;
case BBJ_COND:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
/* Update the predecessor list for 'block->bbJumpDest' and 'block->bbNext' */
fgRemoveRefPred(block->bbJumpDest, block);
if (block->bbJumpKind != BBJ_COND)
break;
/* If BBJ_COND fall through */
__fallthrough;
case BBJ_NONE:
/* Update the predecessor list for 'block->bbNext' */
fgRemoveRefPred(block->bbNext, block);
break;
case BBJ_EHFILTERRET:
block->bbJumpDest->bbRefs++; // To compensate the bbRefs-- inside fgRemoveRefPred
fgRemoveRefPred(block->bbJumpDest, block);
break;
case BBJ_EHFINALLYRET:
{
/* Remove block as the predecessor of the bbNext of all
BBJ_CALLFINALLY blocks calling this finally. No need
to look for BBJ_CALLFINALLY for fault handlers. */
unsigned hndIndex = block->getHndIndex();
EHblkDsc* ehDsc = ehGetDsc(hndIndex);
if (ehDsc->HasFinallyHandler())
{
BasicBlock* begBlk;
BasicBlock* endBlk;
ehGetCallFinallyBlockRange(hndIndex, &begBlk, &endBlk);
BasicBlock* finBeg = ehDsc->ebdHndBeg;
for (BasicBlock* bcall = begBlk; bcall != endBlk; bcall = bcall->bbNext)
{
if ((bcall->bbFlags & BBF_REMOVED) ||
bcall->bbJumpKind != BBJ_CALLFINALLY ||
bcall->bbJumpDest != finBeg)
{
continue;
}
assert(bcall->isBBCallAlwaysPair());
fgRemoveRefPred(bcall->bbNext, block);
}
}
}
break;
case BBJ_THROW:
case BBJ_RETURN:
break;
case BBJ_SWITCH:
{
unsigned jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpTab = block->bbJumpSwt->bbsDstTab;
do
{
fgRemoveRefPred(*jumpTab, block);
}
while (++jumpTab, --jumpCnt);
break;
}
default:
noway_assert(!"Block doesn't have a valid bbJumpKind!!!!");
break;
}
}
/*****************************************************************************
* fgChangeSwitchBlock:
*
* We have a BBJ_SWITCH jump at 'oldSwitchBlock' and we want to move this
* switch jump over to 'newSwitchBlock'. All of the blocks that are jumped
* to from jumpTab[] need to have their predecessor lists updated by removing
* the 'oldSwitchBlock' and adding 'newSwitchBlock'.
*/
void Compiler::fgChangeSwitchBlock(BasicBlock* oldSwitchBlock,
BasicBlock* newSwitchBlock)
{
noway_assert(oldSwitchBlock != nullptr);
noway_assert(newSwitchBlock != nullptr);
noway_assert(oldSwitchBlock->bbJumpKind == BBJ_SWITCH);
unsigned jumpCnt = oldSwitchBlock->bbJumpSwt->bbsCount;
BasicBlock** jumpTab = oldSwitchBlock->bbJumpSwt->bbsDstTab;
unsigned i;
// Walk the switch's jump table, updating the predecessor for each branch.
for (i = 0; i < jumpCnt; i++)
{
BasicBlock* bJump = jumpTab[i];
noway_assert(bJump != nullptr);
// Note that if there are duplicate branch targets in the switch jump table,
// fgRemoveRefPred()/fgAddRefPred() will do the right thing: the second and
// subsequent duplicates will simply subtract from and add to the duplicate
// count (respectively).
//
// Remove the old edge [oldSwitchBlock => bJump]
//
fgRemoveRefPred(bJump, oldSwitchBlock);
//
// Create the new edge [newSwitchBlock => bJump]
//
fgAddRefPred(bJump, newSwitchBlock);
}
if (m_switchDescMap != nullptr)
{
SwitchUniqueSuccSet uniqueSuccSet;
// If already computed and cached the unique descriptors for the old block, let's
// update those for the new block.
if (m_switchDescMap->Lookup(oldSwitchBlock, &uniqueSuccSet))
{
m_switchDescMap->Set(newSwitchBlock, uniqueSuccSet);
}
else
{
fgInvalidateSwitchDescMapEntry(newSwitchBlock);
}
fgInvalidateSwitchDescMapEntry(oldSwitchBlock);
}
}
/*****************************************************************************
* fgReplaceSwitchJumpTarget:
*
* We have a BBJ_SWITCH at 'blockSwitch' and we want to replace all entries
* in the jumpTab[] such that so that jumps that previously went to
* 'oldTarget' now go to 'newTarget'.
* We also must update the predecessor lists for 'oldTarget' and 'newPred'.
*/
void Compiler::fgReplaceSwitchJumpTarget(BasicBlock* blockSwitch,
BasicBlock* newTarget,
BasicBlock* oldTarget)
{
noway_assert(blockSwitch != nullptr);
noway_assert(newTarget != nullptr);
noway_assert(oldTarget != nullptr);
noway_assert(blockSwitch->bbJumpKind == BBJ_SWITCH);
// For the jump targets values that match oldTarget of our BBJ_SWITCH
// replace predecessor 'blockSwitch' with 'newTarget'
//
unsigned jumpCnt = blockSwitch->bbJumpSwt->bbsCount;
BasicBlock** jumpTab = blockSwitch->bbJumpSwt->bbsDstTab;
unsigned i = 0;
// Walk the switch's jump table looking for blocks to update the preds for
while (i < jumpCnt)
{
if (jumpTab[i] == oldTarget) // We will update when jumpTab[i] matches
{
// Remove the old edge [oldTarget from blockSwitch]
//
fgRemoveAllRefPreds(oldTarget, blockSwitch);
//
// Change the jumpTab entry to branch to the new location
//
jumpTab[i] = newTarget;
//
// Create the new edge [newTarget from blockSwitch]
//
flowList* newEdge = fgAddRefPred(newTarget, blockSwitch);
// Now set the correct value of newEdge->flDupCount
// and replace any other jumps in jumpTab[] that go to oldTarget.
//
i++;
while (i < jumpCnt)
{
if (jumpTab[i] == oldTarget)
{
//
// We also must update this entry in the jumpTab
//
jumpTab[i] = newTarget;
newTarget->bbRefs++;
//
// Increment the flDupCount
//
newEdge->flDupCount++;
}
i++; // Check the next entry in jumpTab[]
}
// Maintain, if necessary, the set of unique targets of "block."
UpdateSwitchTableTarget(blockSwitch, oldTarget, newTarget);
// Make sure the new target has the proper bits set for being a branch target.
newTarget->bbFlags |= BBF_HAS_LABEL | BBF_JMP_TARGET;
return; // We have replaced the jumps to oldTarget with newTarget
}
i++; // Check the next entry in jumpTab[] for a match
}
noway_assert(!"Did not find oldTarget in jumpTab[]");
}
//------------------------------------------------------------------------
// Compiler::fgReplaceJumpTarget: For a given block, replace the target 'oldTarget' with 'newTarget'.
//
// Arguments:
// block - the block in which a jump target will be replaced.
// newTarget - the new branch target of the block.
// oldTarget - the old branch target of the block.
//
// Notes:
// 1. Only branches are changed: BBJ_ALWAYS, the non-fallthrough path of BBJ_COND, BBJ_SWITCH, etc.
// We ignore other block types.
// 2. Only the first target found is updated. If there are multiple ways for a block
// to reach 'oldTarget' (e.g., multiple arms of a switch), only the first one found is changed.
// 3. The predecessor lists are not changed.
// 4. The switch table "unique successor" cache is invalidated.
//
// This function is most useful early, before the full predecessor lists have been computed.
//
void Compiler::fgReplaceJumpTarget(BasicBlock* block,
BasicBlock* newTarget,
BasicBlock* oldTarget)
{
assert(block != nullptr);
switch (block->bbJumpKind)
{
case BBJ_CALLFINALLY:
case BBJ_COND:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
case BBJ_EHFILTERRET:
case BBJ_LEAVE: // This function will be called before import, so we still have BBJ_LEAVE
if (block->bbJumpDest == oldTarget)
{
block->bbJumpDest = newTarget;
}
break;
case BBJ_NONE:
case BBJ_EHFINALLYRET:
case BBJ_THROW:
case BBJ_RETURN:
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpTab; jumpTab = block->bbJumpSwt->bbsDstTab;
for (unsigned i = 0; i < jumpCnt; i++)
{
if (jumpTab[i] == oldTarget)
{
jumpTab[i] = newTarget;
break;
}
}
break;
default:
assert(!"Block doesn't have a valid bbJumpKind!!!!");
unreached();
break;
}
}
/*****************************************************************************
* Updates the predecessor list for 'block' by replacing 'oldPred' with 'newPred'.
* Note that a block can only appear once in the preds list (for normal preds, not
* cheap preds): if a predecessor has multiple ways to get to this block, then
* flDupCount will be >1, but the block will still appear exactly once. Thus, this
* function assumes that all branches from the predecessor (practically, that all
* switch cases that target this block) are changed to branch from the new predecessor,
* with the same dup count.
*
* Note that the block bbRefs is not changed, since 'block' has the same number of
* references as before, just from a different predecessor block.
*/
void Compiler::fgReplacePred(BasicBlock* block,
BasicBlock* oldPred,
BasicBlock* newPred)
{
noway_assert(block != nullptr);
noway_assert(oldPred != nullptr);
noway_assert(newPred != nullptr);
assert(!fgCheapPredsValid);
flowList* pred;
for (pred = block->bbPreds; pred != nullptr; pred = pred->flNext)
{
if (oldPred == pred->flBlock)
{
pred->flBlock = newPred;
break;
}
}
}
/*****************************************************************************
*
* Returns true if block b1 dominates block b2.
*/
bool Compiler::fgDominate(BasicBlock* b1, BasicBlock* b2)
{
noway_assert(fgDomsComputed);
assert(!fgCheapPredsValid);
//
// If the fgModified flag is false then we made some modifications to
// the flow graph, like adding a new block or changing a conditional branch
// into an unconditional branch.
//
// We can continue to use the dominator and reachable information to
// unmark loops as long as we haven't renumbered the blocks or we aren't
// asking for information about a new block
//
if (b2->bbNum > fgDomBBcount)
{
if (b1 == b2)
return true;
for (flowList* pred = b2->bbPreds; pred != NULL; pred = pred->flNext)
{
if (!fgDominate(b1, pred->flBlock))
return false;
}
return b2->bbPreds != NULL;
}
if (b1->bbNum > fgDomBBcount)
{
// if b1 is a loop preheader and Succ is its only successor, then all predecessors of
// Succ either are b1 itself or are dominated by Succ. Under these conditions, b1
// dominates b2 if and only if Succ dominates b2 (or if b2 == b1, but we already tested
// for this case)
if (b1->bbFlags & BBF_LOOP_PREHEADER)
{
noway_assert(b1->bbFlags & BBF_INTERNAL);
noway_assert(b1->bbJumpKind == BBJ_NONE);
return fgDominate(b1->bbNext, b2);
}
// unknown dominators; err on the safe side and return false
return false;
}
/* Check if b1 dominates b2 */
unsigned numA = b1->bbNum; noway_assert(numA <= fgDomBBcount);
unsigned numB = b2->bbNum; noway_assert(numB <= fgDomBBcount);
// What we want to ask here is basically if A is in the middle of the path from B to the root (the entry node)
// in the dominator tree. Turns out that can be translated as:
//
// A dom B <-> preorder(A) <= preorder(B) && postorder(A) >= postorder(B)
//
// where the equality holds when you ask if A dominates itself.
bool treeDom =
fgDomTreePreOrder[numA] <= fgDomTreePreOrder[numB] &&
fgDomTreePostOrder[numA] >= fgDomTreePostOrder[numB];
return treeDom;
}
/*****************************************************************************
*
* Returns true if block b1 can reach block b2.
*/
bool Compiler::fgReachable(BasicBlock* b1, BasicBlock* b2)
{
noway_assert(fgDomsComputed);
assert(!fgCheapPredsValid);
//
// If the fgModified flag is false then we made some modifications to
// the flow graph, like adding a new block or changing a conditional branch
// into an unconditional branch.
//
// We can continue to use the dominator and reachable information to
// unmark loops as long as we haven't renumbered the blocks or we aren't
// asking for information about a new block
//
if (b2->bbNum > fgDomBBcount)
{
if (b1 == b2)
return true;
for (flowList* pred = b2->bbPreds; pred != NULL; pred = pred->flNext)
{
if (fgReachable(b1, pred->flBlock))
return true;
}
return false;
}
if (b1->bbNum > fgDomBBcount)
{
noway_assert(b1->bbJumpKind == BBJ_NONE || b1->bbJumpKind == BBJ_ALWAYS || b1->bbJumpKind == BBJ_COND);
if (b1->bbFallsThrough() && fgReachable(b1->bbNext, b2))
return true;
if (b1->bbJumpKind == BBJ_ALWAYS || b1->bbJumpKind == BBJ_COND)
return fgReachable(b1->bbJumpDest, b2);
return false;
}
/* Check if b1 can reach b2 */
assert(fgReachabilitySetsValid);
assert(BasicBlockBitSetTraits::GetSize(this) == fgDomBBcount + 1);
return BlockSetOps::IsMember(this, b2->bbReach, b1->bbNum);
}
/*****************************************************************************
* Update changed flow graph information.
*
* If the flow graph has changed, we need to recompute various information if we want to use
* it again.
*/
void Compiler::fgUpdateChangedFlowGraph()
{
// We need to clear this so we don't hit an assert calling fgRenumberBlocks().
fgDomsComputed = false;
JITDUMP("\nRenumbering the basic blocks for fgUpdateChangeFlowGraph\n");
fgRenumberBlocks();
fgComputePreds();
fgComputeEnterBlocksSet();
fgComputeReachabilitySets();
fgComputeDoms();
}
/*****************************************************************************
* Compute the bbReach sets.
*
* This can be called to recompute the bbReach sets after the flow graph changes, such as when the
* number of BasicBlocks change (and thus, the BlockSet epoch changes).
*
* Finally, this also sets the BBF_GC_SAFE_POINT flag on blocks.
*
* Assumes the predecessor lists are correct.
*
* TODO-Throughput: This algorithm consumes O(n^2) because we're using dense bitsets to
* represent reachability. While this yields O(1) time queries, it bloats the memory usage
* for large code. We can do better if we try to approach reachability by
* computing the strongly connected components of the flow graph. That way we only need
* linear memory to label every block with its SCC.
*/
void Compiler::fgComputeReachabilitySets()
{
assert(fgComputePredsDone);
assert(!fgCheapPredsValid);
#ifdef DEBUG
fgReachabilitySetsValid = false;
#endif // DEBUG
BasicBlock* block;
for (block = fgFirstBB; block != nullptr; block = block->bbNext)
{
// Initialize the per-block bbReach sets. (Note that we can't just call BlockSetOps::ClearD()
// when re-running this computation, because if the epoch changes, the size and representation of the
// sets might change).
block->bbReach = BlockSetOps::MakeEmpty(this);
/* Mark block as reaching itself */
BlockSetOps::AddElemD(this, block->bbReach, block->bbNum);
}
/* Find the reachable blocks */
// Also, set BBF_GC_SAFE_POINT.
bool change;
BlockSet BLOCKSET_INIT_NOCOPY(newReach, BlockSetOps::MakeEmpty(this));
do
{
change = false;
for (block = fgFirstBB; block != nullptr; block = block->bbNext)
{
BlockSetOps::Assign(this, newReach, block->bbReach);
bool predGcSafe = (block->bbPreds != nullptr); // Do all of our predecessor blocks have a GC safe bit?
for (flowList* pred = block->bbPreds; pred != nullptr; pred = pred->flNext)
{
BasicBlock* predBlock = pred->flBlock;
/* Union the predecessor's reachability set into newReach */
BlockSetOps::UnionD(this, newReach, predBlock->bbReach);
if (!(predBlock->bbFlags & BBF_GC_SAFE_POINT))
{
predGcSafe = false;
}
}
if (predGcSafe)
{
block->bbFlags |= BBF_GC_SAFE_POINT;
}
if (!BlockSetOps::Equal(this, newReach, block->bbReach))
{
BlockSetOps::Assign(this, block->bbReach, newReach);
change = true;
}
}
}
while (change);
#ifdef DEBUG
if (verbose)
{
printf("\nAfter computing reachability sets:\n");
fgDispReach();
}
fgReachabilitySetsValid = true;
#endif // DEBUG
}
/*****************************************************************************
* Compute the entry blocks set.
*
* Initialize fgEnterBlks to the set of blocks for which we don't have explicit control
* flow edges. These are the entry basic block and each of the EH handler blocks.
* For ARM, also include the BBJ_ALWAYS block of a BBJ_CALLFINALLY/BBJ_ALWAYS pair,
* to avoid creating "retless" calls, since we need the BBJ_ALWAYS for the purpose
* of unwinding, even if the call doesn't return (due to an explicit throw, for example).
*/
void Compiler::fgComputeEnterBlocksSet()
{
#ifdef DEBUG
fgEnterBlksSetValid = false;
#endif // DEBUG
fgEnterBlks = BlockSetOps::MakeEmpty(this);
/* Now set the entry basic block */
BlockSetOps::AddElemD(this, fgEnterBlks, fgFirstBB->bbNum);
assert(fgFirstBB->bbNum == 1);
if (compHndBBtabCount > 0)
{
/* Also 'or' in the handler basic blocks */
EHblkDsc* HBtab;
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
if (HBtab->HasFilter())
{
BlockSetOps::AddElemD(this, fgEnterBlks, HBtab->ebdFilter->bbNum);
}
BlockSetOps::AddElemD(this, fgEnterBlks, HBtab->ebdHndBeg->bbNum);
}
}
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// TODO-ARM-Cleanup: The ARM code here to prevent creating retless calls by adding the BBJ_ALWAYS
// to the enter blocks is a bit of a compromise, because sometimes the blocks are already reachable,
// and it messes up DFS ordering to have them marked as enter block. We should prevent the
// creation of retless calls some other way.
for (BasicBlock* block = fgFirstBB; block != nullptr; block = block->bbNext)
{
if (block->bbJumpKind == BBJ_CALLFINALLY)
{
assert(block->isBBCallAlwaysPair());
// Don't remove the BBJ_ALWAYS block that is only here for the unwinder. It might be dead
// if the finally is no-return, so mark it as an entry point.
BlockSetOps::AddElemD(this, fgEnterBlks, block->bbNext->bbNum);
}
}
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
#ifdef DEBUG
if (verbose)
{
printf("Enter blocks: ");
BLOCKSET_ITER_INIT(this, iter, fgEnterBlks, bbNum);
while (iter.NextElem(this, &bbNum))
{
printf("BB%02u ", bbNum);
}
printf("\n");
}
#endif // DEBUG
#ifdef DEBUG
fgEnterBlksSetValid = true;
#endif // DEBUG
}
/*****************************************************************************
* Remove unreachable blocks.
*
* Return true if any unreachable blocks were removed.
*/
bool Compiler::fgRemoveUnreachableBlocks()
{
assert(!fgCheapPredsValid);
assert(fgReachabilitySetsValid);
bool hasLoops = false;
bool hasUnreachableBlocks = false;
BasicBlock* block;
/* Record unreachable blocks */
for (block = fgFirstBB;
block != NULL;
block = block->bbNext)
{
/* Internal throw blocks are also reachable */
if (fgIsThrowHlpBlk(block))
{
goto SKIP_BLOCK;
}
else if (block == genReturnBB)
{
// Don't remove statements for the genReturnBB block, as we might have special hookups there.
// For example, <BUGNUM> in VSW 364383, </BUGNUM>
// the profiler hookup needs to have the "void GT_RETURN" statement
// to properly set the info.compProfilerCallback flag.
goto SKIP_BLOCK;
}
else
{
// If any of the entry blocks can reach this block, then we skip it.
if (!BlockSetOps::IsEmptyIntersection(this, fgEnterBlks, block->bbReach))
{
goto SKIP_BLOCK;
}
}
// Remove all the code for the block
fgUnreachableBlock(block);
// Make sure that the block was marked as removed */
noway_assert(block->bbFlags & BBF_REMOVED);
// Some blocks mark the end of trys and catches
// and can't be removed. We convert these into
// empty blocks of type BBJ_THROW
if (block->bbFlags & BBF_DONT_REMOVE)
{
bool bIsBBCallAlwaysPair = block->isBBCallAlwaysPair();
/* Unmark the block as removed, */
/* clear BBF_INTERNAL as well and set BBJ_IMPORTED */
block->bbFlags &= ~(BBF_REMOVED | BBF_INTERNAL | BBF_NEEDS_GCPOLL);
block->bbFlags |= BBF_IMPORTED;
block->bbJumpKind = BBJ_THROW;
block->bbSetRunRarely();
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// If this is a <BBJ_CALLFINALLY, BBJ_ALWAYS> pair, we have to clear BBF_FINALLY_TARGET flag on
// the target node (of BBJ_ALWAYS) since BBJ_CALLFINALLY node is getting converted to a BBJ_THROW.
if (bIsBBCallAlwaysPair)
{
noway_assert(block->bbNext->bbJumpKind == BBJ_ALWAYS);
fgClearFinallyTargetBit(block->bbNext->bbJumpDest);
}
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
}
else
{
/* We have to call fgRemoveBlock next */
hasUnreachableBlocks = true;
}
continue;
SKIP_BLOCK:;
//if (block->isRunRarely())
// continue;
if (block->bbJumpKind == BBJ_RETURN)
continue;
/* Set BBF_LOOP_HEAD if we have backwards branches to this block */
unsigned blockNum = block->bbNum;
for (flowList* pred = block->bbPreds; pred != nullptr; pred = pred->flNext)
{
BasicBlock* predBlock = pred->flBlock;
if (blockNum <= predBlock->bbNum)
{
if (predBlock->bbJumpKind == BBJ_CALLFINALLY)
continue;
/* If block can reach predBlock then we have a loop head */
if (BlockSetOps::IsMember(this, predBlock->bbReach, blockNum))
{
hasLoops = true;
/* Set the BBF_LOOP_HEAD flag */
block->bbFlags |= BBF_LOOP_HEAD;
break;
}
}
}
}
fgHasLoops = hasLoops;
if (hasUnreachableBlocks)
{
// Now remove the unreachable blocks
for (block = fgFirstBB;
block != NULL;
block = block->bbNext)
{
// If we mark the block with BBF_REMOVED then
// we need to call fgRemovedBlock() on it
if (block->bbFlags & BBF_REMOVED)
{
fgRemoveBlock(block, true);
// When we have a BBJ_CALLFINALLY, BBJ_ALWAYS pair; fgRemoveBlock will remove
// both blocks, so we must advance 1 extra place in the block list
//
if (block->isBBCallAlwaysPair())
{
block = block->bbNext;
}
}
}
}
return hasUnreachableBlocks;
}
/*****************************************************************************
*
* Function called to compute the dominator and reachable sets.
*
* Assumes the predecessor lists are computed and correct.
*/
void Compiler::fgComputeReachability()
{
#ifdef DEBUG
if (verbose)
printf("*************** In fgComputeReachability\n");
fgVerifyHandlerTab();
// Make sure that the predecessor lists are accurate
assert(fgComputePredsDone);
fgDebugCheckBBlist();
#endif // DEBUG
/* Create a list of all BBJ_RETURN blocks. The head of the list is 'fgReturnBlocks'. */
fgReturnBlocks = nullptr;
for (BasicBlock* block = fgFirstBB; block != nullptr; block = block->bbNext)
{
// If this is a BBJ_RETURN block, add it to our list of all BBJ_RETURN blocks. This list is only
// used to find return blocks.
if (block->bbJumpKind == BBJ_RETURN)
{
fgReturnBlocks = new(this, CMK_Reachability) BasicBlockList(block, fgReturnBlocks);
}
}
// Compute reachability and then delete blocks determined to be unreachable. If we delete blocks, we
// need to loop, as that might have caused more blocks to become unreachable. This can happen in the
// case where a call to a finally is unreachable and deleted (maybe the call to the finally is
// preceded by a throw or an infinite loop), making the blocks following the finally unreachable.
// However, all EH entry blocks are considered global entry blocks, causing the blocks following the
// call to the finally to stay rooted, until a second round of reachability is done.
// The dominator algorithm expects that all blocks can be reached from the fgEnterBlks set.
unsigned passNum = 1;
bool changed;
do
{
// Just to be paranoid, avoid infinite loops; fall back to minopts.
if (passNum > 10)
{
noway_assert(!"Too many unreachable block removal loops");
}
/* Walk the flow graph, reassign block numbers to keep them in ascending order */
JITDUMP("\nRenumbering the basic blocks for fgComputeReachability pass #%u\n", passNum);
passNum++;
fgRenumberBlocks();
//
// Compute fgEnterBlks
//
fgComputeEnterBlocksSet();
//
// Compute bbReach
//
fgComputeReachabilitySets();
//
// Use reachability information to delete unreachable blocks.
// Also, determine if the flow graph has loops and set 'fgHasLoops' accordingly.
// Set the BBF_LOOP_HEAD flag on the block target of backwards branches.
//
changed = fgRemoveUnreachableBlocks();
} while (changed);
#ifdef DEBUG
if (verbose)
{
printf("\nAfter computing reachability:\n");
fgDispBasicBlocks(verboseTrees);
printf("\n");
}
fgVerifyHandlerTab();
fgDebugCheckBBlist(true);
#endif // DEBUG
//
// Now, compute the dominators
//
fgComputeDoms();
}
/** In order to be able to compute dominance, we need to first get a DFS reverse post order sort on the basic flow graph
* for the dominance algorithm to operate correctly. The reason why we need the DFS sort is because
* we will build the dominance sets using the partial order induced by the DFS sorting. With this
* precondition not holding true, the algorithm doesn't work properly.
*/
void Compiler::fgDfsInvPostOrder()
{
// NOTE: This algorithm only pays attention to the actual blocks. It ignores the imaginary entry block.
// visited : Once we run the DFS post order sort recursive algorithm, we mark the nodes we visited to avoid
// backtracking.
BlockSet BLOCKSET_INIT_NOCOPY(visited, BlockSetOps::MakeEmpty(this));
// We begin by figuring out which basic blocks don't have incoming edges and mark them as
// start nodes. Later on we run the recursive algorithm for each node that we
// mark in this step.
BlockSet_ValRet_T startNodes = fgDomFindStartNodes();
// Make sure fgEnterBlks are still there in startNodes, even if they participate in a loop (i.e., there is
// an incoming edge into the block).
assert(fgEnterBlksSetValid);
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
//
// BlockSetOps::UnionD(this, startNodes, fgEnterBlks);
//
// This causes problems on ARM, because we for BBJ_CALLFINALLY/BBJ_ALWAYS pairs, we add the BBJ_ALWAYS
// to the enter blocks set to prevent flow graph optimizations from removing it and creating retless call finallies
// (BBF_RETLESS_CALL). This leads to an incorrect DFS ordering in some cases, because we start the recursive walk
// from the BBJ_ALWAYS, which is reachable from other blocks. A better solution would be to change ARM to avoid
// creating retless calls in a different way, not by adding BBJ_ALWAYS to fgEnterBlks.
//
// So, let us make sure at least fgFirstBB is still there, even if it participates in a loop.
BlockSetOps::AddElemD(this, startNodes, 1);
assert(fgFirstBB->bbNum == 1);
#else
BlockSetOps::UnionD(this, startNodes, fgEnterBlks);
#endif
assert(BlockSetOps::IsMember(this, startNodes, fgFirstBB->bbNum));
// Call the recursive helper.
unsigned postIndex = 1;
for (BasicBlock* block = fgFirstBB; block != nullptr; block = block->bbNext)
{
// If the block has no predecessors, and we haven't already visited it (because it's in fgEnterBlks but also
// reachable from the first block), go ahead and traverse starting from this block.
if (BlockSetOps::IsMember(this, startNodes, block->bbNum) &&
!BlockSetOps::IsMember(this, visited, block->bbNum))
{
fgDfsInvPostOrderHelper(block, visited, &postIndex);
}
}
// After the DFS reverse postorder is completed, we must have visited all the basic blocks.
noway_assert(postIndex == fgBBcount + 1);
noway_assert(fgBBNumMax == fgBBcount);
#ifdef DEBUG
if (verbose)
{
printf("\nAfter doing a post order traversal of the BB graph, this is the ordering:\n");
for (unsigned i = 1; i <= fgBBNumMax; ++i)
{
printf("%02u -> BB%02u\n", i, fgBBInvPostOrder[i]->bbNum);
}
printf("\n");
}
#endif // DEBUG
}
BlockSet_ValRet_T Compiler::fgDomFindStartNodes()
{
unsigned j;
BasicBlock* block;
// startNodes :: A set that represents which basic blocks in the flow graph don't have incoming edges.
// We begin assuming everything is a start block and remove any block that is being referenced by another in its successor list.
BlockSet BLOCKSET_INIT_NOCOPY(startNodes, BlockSetOps::MakeFull(this));
for (block = fgFirstBB; block != nullptr; block = block->bbNext)
{
unsigned cSucc = block->NumSucc(this);
for (j = 0; j < cSucc; ++j)
{
BasicBlock* succ = block->GetSucc(j, this);
BlockSetOps::RemoveElemD(this, startNodes, succ->bbNum);
}
}
#ifdef DEBUG
if (verbose)
{
printf("\nDominator computation start blocks (those blocks with no incoming edges):\n");
BLOCKSET_ITER_INIT(this, iter, startNodes, bbNum);
while (iter.NextElem(this, &bbNum))
{
printf("BB%02u ", bbNum);
}
printf("\n");
}
#endif // DEBUG
return startNodes;
}
/** A simple DFS traversal of the flow graph.
* It computes both preorder and postorder numbering.
*/
void Compiler::fgDfsInvPostOrderHelper(BasicBlock* block, BlockSet& visited, unsigned* count)
{
// Assume we haven't visited this node yet (callers ensure this).
assert(!BlockSetOps::IsMember(this, visited, block->bbNum));
// Flag the node we just visited to avoid backtracking.
BlockSetOps::AddElemD(this, visited, block->bbNum);
unsigned cSucc = block->NumSucc(this);
for (unsigned j = 0; j < cSucc; ++j)
{
BasicBlock* succ = block->GetSucc(j, this);
// If this is a node we haven't seen before, go ahead and recurse
if (!BlockSetOps::IsMember(this, visited, succ->bbNum))
{
fgDfsInvPostOrderHelper(succ, visited, count);
}
}
unsigned invCount = fgBBcount - *count + 1;
assert(1 <= invCount && invCount <= fgBBNumMax);
fgBBInvPostOrder[invCount] = block;
block->bbDfsNum = invCount;
++(*count);
}
void Compiler::fgComputeDoms()
{
assert(!fgCheapPredsValid);
#ifdef DEBUG
if (verbose)
printf("*************** In fgComputeDoms\n");
fgVerifyHandlerTab();
// Make sure that the predecessor lists are accurate.
// Also check that the blocks are properly, densely numbered (so calling fgRenumberBlocks is not necessary).
fgDebugCheckBBlist(true);
// Assert things related to the BlockSet epoch.
assert(fgBBcount == fgBBNumMax);
assert(BasicBlockBitSetTraits::GetSize(this) == fgBBNumMax + 1);
#endif // DEBUG
BlockSet BLOCKSET_INIT_NOCOPY(processedBlks, BlockSetOps::MakeEmpty(this));
fgBBInvPostOrder = new(this, CMK_DominatorMemory) BasicBlock*[fgBBNumMax + 1];
memset(fgBBInvPostOrder, 0, sizeof(BasicBlock*) * (fgBBNumMax + 1));
fgDfsInvPostOrder();
noway_assert(fgBBInvPostOrder[0] == nullptr);
// flRoot and bbRoot represent an imaginary unique entry point in the flow graph.
// All the orphaned EH blocks and fgFirstBB will temporarily have its predecessors list
// (with bbRoot as the only basic block in it) set as flRoot.
// Later on, we clear their predecessors and let them to be nullptr again.
// Since we number basic blocks starting at one, the imaginary entry block is conveniently numbered as zero.
flowList flRoot;
BasicBlock bbRoot;
bbRoot.bbPreds = nullptr;
bbRoot.bbNum = 0;
bbRoot.bbIDom = &bbRoot;
bbRoot.bbDfsNum = 0;
flRoot.flNext = 0;
flRoot.flBlock = &bbRoot;
fgBBInvPostOrder[0] = &bbRoot;
// Mark both bbRoot and fgFirstBB processed
BlockSetOps::AddElemD(this, processedBlks, 0); // bbRoot == block #0
BlockSetOps::AddElemD(this, processedBlks, 1); // fgFirstBB == block #1
assert(fgFirstBB->bbNum == 1);
// Special case fgFirstBB to say its IDom is bbRoot.
fgFirstBB->bbIDom = &bbRoot;
BasicBlock* block = nullptr;
for (block = fgFirstBB->bbNext; block != nullptr; block = block->bbNext)
{
// If any basic block has no predecessors then we flag it as processed and temporarily
// mark its precedessor list to be flRoot. This makes the flowgraph connected,
// a precondition that is needed by the dominance algorithm to operate properly.
if (block->bbPreds == nullptr)
{
block->bbPreds = &flRoot;
block->bbIDom = &bbRoot;
BlockSetOps::AddElemD(this, processedBlks, block->bbNum);
}
else
{
block->bbIDom = nullptr;
}
}
// Mark the EH blocks as entry blocks and also flag them as processed.
if (compHndBBtabCount > 0)
{
EHblkDsc* HBtab;
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
if (HBtab->HasFilter())
{
HBtab->ebdFilter->bbIDom = &bbRoot;
BlockSetOps::AddElemD(this, processedBlks, HBtab->ebdFilter->bbNum);
}
HBtab->ebdHndBeg->bbIDom = &bbRoot;
BlockSetOps::AddElemD(this, processedBlks, HBtab->ebdHndBeg->bbNum);
}
}
// Now proceed to compute the immediate dominators for each basic block.
bool changed = true;
while (changed)
{
changed = false;
for (unsigned i = 1; i <= fgBBNumMax; ++i) // Process each actual block; don't process the imaginary predecessor block.
{
flowList* first = nullptr;
BasicBlock* newidom = nullptr;
block = fgBBInvPostOrder[i];
// If we have a block that has bbRoot as its bbIDom
// it means we flag it as processed and as an entry block so
// in this case we're all set.
if (block->bbIDom == &bbRoot)
continue;
// Pick up the first processed predecesor of the current block.
for (first = block->bbPreds; first != nullptr; first = first->flNext)
{
if (BlockSetOps::IsMember(this, processedBlks, first->flBlock->bbNum))
{
break;
}
}
noway_assert(first != nullptr);
// We assume the first processed predecessor will be the
// immediate dominator and then compute the forward flow analysis.
newidom = first->flBlock;
for (flowList* p = block->bbPreds; p != nullptr; p = p->flNext)
{
if (p->flBlock == first->flBlock)
{
continue;
}
if (p->flBlock->bbIDom != nullptr)
{
// fgIntersectDom is basically the set intersection between
// the dominance sets of the new IDom and the current predecessor
// Since the nodes are ordered in DFS inverse post order and
// IDom induces a tree, fgIntersectDom actually computes
// the lowest common ancestor in the dominator tree.
newidom = fgIntersectDom(p->flBlock, newidom);
}
}
// If the Immediate dominator changed, assign the new one
// to the current working basic block.
if (block->bbIDom != newidom)
{
noway_assert(newidom != nullptr);
block->bbIDom = newidom;
changed = true;
}
BlockSetOps::AddElemD(this, processedBlks, block->bbNum);
}
}
// As stated before, once we have computed immediate dominance we need to clear
// all the basic blocks whose predecessor list was set to flRoot. This
// reverts that and leaves the blocks the same as before.
for (block = fgFirstBB; block != nullptr; block = block->bbNext)
{
if (block->bbPreds == &flRoot)
{
block->bbPreds = nullptr;
}
}
#ifdef DEBUG
if (verbose)
{
fgDispDoms();
}
#endif
fgBuildDomTree();
fgModified = false;
fgDomBBcount = fgBBcount;
assert(fgBBcount == fgBBNumMax);
assert(BasicBlockBitSetTraits::GetSize(this) == fgDomBBcount + 1);
fgDomsComputed = true;
}
void Compiler::fgBuildDomTree()
{
unsigned i;
BasicBlock* block;
#ifdef DEBUG
if (verbose)
{
printf("\nInside fgBuildDomTree\n");
}
#endif // DEBUG
// domTree :: The dominance tree represented using adjacency lists. We use BasicBlockList to represent edges. Indexed by basic block number.
unsigned bbArraySize = fgBBNumMax + 1;
BasicBlockList** domTree = new(this, CMK_DominatorMemory) BasicBlockList*[bbArraySize];
fgDomTreePreOrder = new(this, CMK_DominatorMemory) unsigned[bbArraySize];
fgDomTreePostOrder = new(this, CMK_DominatorMemory) unsigned[bbArraySize];
// Initialize all the data structures.
for (i = 0; i < bbArraySize; ++i)
{
domTree[i] = nullptr;
fgDomTreePreOrder[i] = fgDomTreePostOrder[i] = 0;
}
// Build the dominance tree.
for (block = fgFirstBB; block != nullptr; block = block->bbNext)
{
// If the immediate dominator is not the imaginary root (bbRoot)
// we proceed to append this block to the children of the dominator node.
if (block->bbIDom->bbNum != 0)
{
int bbNum = block->bbIDom->bbNum;
domTree[bbNum] = new(this, CMK_DominatorMemory) BasicBlockList(block, domTree[bbNum]);
}
else
{
// This means this block had bbRoot set as its IDom. We clear it out
// and convert the tree back to a forest.
block->bbIDom = nullptr;
}
}
#ifdef DEBUG
if (verbose)
{
printf("\nAfter computing the Dominance Tree:\n");
fgDispDomTree(domTree);
}
#endif // DEBUG
// Get the bitset that represents the roots of the dominance tree.
// Something to note here is that the dominance tree has been converted from a forest to a tree
// by using the bbRoot trick on fgComputeDoms. The reason we have a forest instead of a real tree
// is because we treat the EH blocks as entry nodes so the real dominance tree is not necessarily connected.
BlockSet_ValRet_T domTreeEntryNodes = fgDomTreeEntryNodes(domTree);
// The preorder and postorder numbers.
// We start from 1 to match the bbNum ordering.
unsigned preNum = 1;
unsigned postNum = 1;
// There will be nodes in the dominance tree that will not be reachable:
// the catch blocks that return since they don't have any predecessor.
// For that matter we'll keep track of how many nodes we can
// reach and assert at the end that we visited all of them.
unsigned domTreeReachable = fgBBcount;
// Once we have the dominance tree computed, we need to traverse it
// to get the preorder and postorder numbers for each node. The purpose of
// this is to achieve O(1) queries for of the form A dominates B.
for (i = 1; i <= fgBBNumMax; ++i)
{
if (BlockSetOps::IsMember(this, domTreeEntryNodes, i))
{
if (domTree[i] == nullptr)
{
// If this is an entry node but there's no children on this
// node, it means it's unreachable so we decrement the reachable
// counter.
--domTreeReachable;
}
else
{
// Otherwise, we do a DFS on the tree.
fgTraverseDomTree(i, domTree, &preNum, &postNum);
}
}
}
noway_assert(preNum == domTreeReachable + 1);
noway_assert(postNum == domTreeReachable + 1);
// Once we have all the reachable nodes numbered, we proceed to
// assign numbers to the non-reachable ones, just assign incrementing
// values. We must reach fgBBcount at the end.
for (i = 1; i <= fgBBNumMax; ++i)
{
if (BlockSetOps::IsMember(this, domTreeEntryNodes, i))
{
if (domTree[i] == nullptr)
{
fgDomTreePreOrder[i] = preNum++;
fgDomTreePostOrder[i] = postNum++;
}
}
}
noway_assert(preNum == fgBBNumMax + 1);
noway_assert(postNum == fgBBNumMax + 1);
#ifdef DEBUG
if (verbose)
{
printf("\nAfter traversing the dominance tree:\n");
printf("PreOrder:\n");
for (i = 1; i <= fgBBNumMax; ++i)
{
printf("BB%02u : %02u\n", i, fgDomTreePreOrder[i]);
}
printf("PostOrder:\n");
for (i = 1; i <= fgBBNumMax; ++i)
{
printf("BB%02u : %02u\n", i, fgDomTreePostOrder[i]);
}
assert(fgDomTreePreOrder[0] == 0); // Unused first element
assert(fgDomTreePostOrder[0] == 0); // Unused first element
}
#endif // DEBUG
}
BlockSet_ValRet_T Compiler::fgDomTreeEntryNodes(BasicBlockList** domTree)
{
// domTreeEntryNodes :: Set that represents which basic blocks are roots of the dominator forest.
BlockSet BLOCKSET_INIT_NOCOPY(domTreeEntryNodes, BlockSetOps::MakeFull(this));
// First of all we need to find all the roots of the dominance forest.
for (unsigned i = 1; i <= fgBBNumMax; ++i)
{
for (BasicBlockList* current = domTree[i]; current != nullptr; current = current->next)
{
BlockSetOps::RemoveElemD(this, domTreeEntryNodes, current->block->bbNum);
}
}
return domTreeEntryNodes;
}
#ifdef DEBUG
void Compiler::fgDispDomTree(BasicBlockList** domTree)
{
for (unsigned i = 1; i <= fgBBNumMax; ++i)
{
if (domTree[i] != nullptr)
{
printf("BB%02u : ", i);
for (BasicBlockList* current = domTree[i]; current != nullptr; current = current->next)
{
assert(current->block);
printf("BB%02u ", current->block->bbNum);
}
printf("\n");
}
}
printf("\n");
}
#endif // DEBUG
void Compiler::fgTraverseDomTree(unsigned bbNum,
BasicBlockList** domTree,
unsigned* preNum,
unsigned* postNum)
{
noway_assert(bbNum <= fgBBNumMax);
// If the block preorder number is not zero it means we already visited
// that node, so we skip it.
if (fgDomTreePreOrder[bbNum] == 0)
{
// If this is the first time we visit this node, both preorder and postnumber
// values must be zero.
noway_assert(fgDomTreePostOrder[bbNum] == 0);
fgDomTreePreOrder[bbNum] = (*preNum)++;
for (BasicBlockList* current = domTree[bbNum]; current != nullptr; current = current->next)
{
fgTraverseDomTree(current->block->bbNum, domTree, preNum, postNum);
}
fgDomTreePostOrder[bbNum] = (*postNum)++;
}
}
// This code finds the lowest common ancestor in the
// dominator tree between two basic blocks. The LCA in the Dominance tree
// represents the closest dominator between the two basic blocks. Used to
// adjust the IDom value in fgComputDoms.
BasicBlock* Compiler::fgIntersectDom(BasicBlock* a, BasicBlock* b)
{
BasicBlock* finger1 = a;
BasicBlock* finger2 = b;
while (finger1 != finger2)
{
while (finger1->bbDfsNum > finger2->bbDfsNum)
{
finger1 = finger1->bbIDom;
}
while (finger2->bbDfsNum > finger1->bbDfsNum)
{
finger2 = finger2->bbIDom;
}
}
return finger1;
}
// Return a BlockSet containing all the blocks that dominate 'block'.
BlockSet_ValRet_T Compiler::fgGetDominatorSet(BasicBlock* block)
{
assert(block != nullptr);
BlockSet BLOCKSET_INIT_NOCOPY(domSet, BlockSetOps::MakeEmpty(this));
do
{
BlockSetOps::AddElemD(this, domSet, block->bbNum);
if (block == block->bbIDom)
{
break; // We found a cycle in the IDom list, so we're done.
}
block = block->bbIDom;
}
while (block != nullptr);
return domSet;
}
/*****************************************************************************
*
* fgComputeCheapPreds: Function called to compute the BasicBlock::bbCheapPreds lists.
*
* No other block data is changed (e.g., bbRefs, bbFlags).
*
* The cheap preds lists are similar to the normal (bbPreds) predecessor lists, but are cheaper to
* compute and store, as follows:
* 1. A flow edge is typed BasicBlockList, which only has a block pointer and 'next' pointer. It doesn't
* have weights or a dup count.
* 2. The preds list for a block is not sorted by block number.
* 3. The predecessors of the block following a BBJ_CALLFINALLY (the corresponding BBJ_ALWAYS,
* for normal, non-retless calls to the finally) are not computed.
* 4. The cheap preds lists will contain duplicates if a single switch table has multiple branches
* to the same block. Thus, we don't spend the time looking for duplicates for every edge we insert.
*/
void Compiler::fgComputeCheapPreds()
{
noway_assert(!fgComputePredsDone); // We can't do this if we've got the full preds.
noway_assert(fgFirstBB != nullptr);
BasicBlock* block;
#ifdef DEBUG
if (verbose)
{
printf("\n*************** In fgComputeCheapPreds()\n");
fgDispBasicBlocks();
printf("\n");
}
#endif // DEBUG
// Clear out the cheap preds lists.
fgRemovePreds();
for (block = fgFirstBB; block != nullptr; block = block->bbNext)
{
switch (block->bbJumpKind)
{
case BBJ_COND:
fgAddCheapPred(block->bbJumpDest, block);
fgAddCheapPred(block->bbNext, block);
break;
case BBJ_CALLFINALLY:
case BBJ_LEAVE: // If fgComputeCheapPreds is called before all blocks are imported, BBJ_LEAVE blocks are still in the BB list.
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
fgAddCheapPred(block->bbJumpDest, block);
break;
case BBJ_NONE:
fgAddCheapPred(block->bbNext, block);
break;
case BBJ_EHFILTERRET:
// Connect end of filter to catch handler.
// In a well-formed program, this cannot be null. Tolerate here, so that we can call
// fgComputeCheapPreds before fgImport on an ill-formed program; the problem will be detected in fgImport.
if (block->bbJumpDest != nullptr)
{
fgAddCheapPred(block->bbJumpDest, block);
}
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpTab; jumpTab = block->bbJumpSwt->bbsDstTab;
do
{
fgAddCheapPred(*jumpTab, block);
}
while (++jumpTab, --jumpCnt);
break;
case BBJ_EHFINALLYRET: // It's expensive to compute the preds for this case, so we don't for the cheap preds.
case BBJ_THROW:
case BBJ_RETURN:
break;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
}
fgCheapPredsValid = true;
#ifdef DEBUG
if (verbose)
{
printf("\n*************** After fgComputeCheapPreds()\n");
fgDispBasicBlocks();
printf("\n");
}
#endif
}
/*****************************************************************************
* Add 'blockPred' to the cheap predecessor list of 'block'.
*/
void Compiler::fgAddCheapPred(BasicBlock* block,
BasicBlock* blockPred)
{
assert(!fgComputePredsDone);
assert(block != nullptr);
assert(blockPred != nullptr);
block->bbCheapPreds = new (this, CMK_FlowList) BasicBlockList(blockPred, block->bbCheapPreds);
#if MEASURE_BLOCK_SIZE
genFlowNodeCnt += 1;
genFlowNodeSize += sizeof(BasicBlockList);
#endif // MEASURE_BLOCK_SIZE
}
/*****************************************************************************
* Remove 'blockPred' from the cheap predecessor list of 'block'.
* If there are duplicate edges, only remove one of them.
*/
void Compiler::fgRemoveCheapPred(BasicBlock* block,
BasicBlock* blockPred)
{
assert(!fgComputePredsDone);
assert(fgCheapPredsValid);
flowList* oldEdge = NULL;
assert(block != nullptr);
assert(blockPred != nullptr);
assert(block->bbCheapPreds != nullptr);
/* Is this the first block in the pred list? */
if (blockPred == block->bbCheapPreds->block)
{
block->bbCheapPreds = block->bbCheapPreds->next;
}
else
{
BasicBlockList* pred;
for (pred = block->bbCheapPreds;
pred->next != nullptr;
pred = pred->next)
{
if (blockPred == pred->next->block)
break;
}
noway_assert(pred->next != nullptr); // we better have found it!
pred->next = pred->next->next; // splice it out
}
}
void Compiler::fgRemovePreds()
{
C_ASSERT(offsetof(BasicBlock, bbPreds) == offsetof(BasicBlock, bbCheapPreds)); // bbPreds and bbCheapPreds are at the same place in a union,
C_ASSERT(sizeof( ((BasicBlock*)0)->bbPreds ) == sizeof( ((BasicBlock*)0)->bbCheapPreds )); // and are the same size. So, this function removes both.
for (BasicBlock* block = fgFirstBB; block != nullptr; block = block->bbNext)
{
block->bbPreds = nullptr;
}
fgComputePredsDone = false;
fgCheapPredsValid = false;
}
/*****************************************************************************
*
* Function called to compute the bbPreds lists.
*/
void Compiler::fgComputePreds()
{
noway_assert(fgFirstBB);
BasicBlock* block;
#ifdef DEBUG
if (verbose)
{
printf("\n*************** In fgComputePreds()\n");
fgDispBasicBlocks();
printf("\n");
}
#endif // DEBUG
// reset the refs count for each basic block
for (block = fgFirstBB; block; block = block->bbNext)
{
block->bbRefs = 0;
}
/* the first block is always reachable! */
fgFirstBB->bbRefs = 1;
/* Treat the initial block as a jump target */
fgFirstBB->bbFlags |= BBF_JMP_TARGET | BBF_HAS_LABEL;
fgRemovePreds();
for (block = fgFirstBB; block; block = block->bbNext)
{
switch (block->bbJumpKind)
{
case BBJ_CALLFINALLY:
if (!(block->bbFlags & BBF_RETLESS_CALL))
{
assert(block->isBBCallAlwaysPair());
/* Mark the next block as being a jump target,
since the call target will return there */
PREFIX_ASSUME(block->bbNext != NULL);
block->bbNext->bbFlags |= (BBF_JMP_TARGET | BBF_HAS_LABEL);
}
__fallthrough;
case BBJ_LEAVE: // Sometimes fgComputePreds is called before all blocks are imported, so BBJ_LEAVE
// blocks are still in the BB list.
case BBJ_COND:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
/* Mark the jump dest block as being a jump target */
block->bbJumpDest->bbFlags |= BBF_JMP_TARGET | BBF_HAS_LABEL;
fgAddRefPred(block->bbJumpDest, block, nullptr, true);
/* Is the next block reachable? */
if (block->bbJumpKind != BBJ_COND)
break;
noway_assert(block->bbNext);
/* Fall through, the next block is also reachable */
__fallthrough;
case BBJ_NONE:
fgAddRefPred(block->bbNext, block, nullptr, true);
break;
case BBJ_EHFILTERRET:
// Connect end of filter to catch handler.
// In a well-formed program, this cannot be null. Tolerate here, so that we can call
// fgComputePreds before fgImport on an ill-formed program; the problem will be detected in fgImport.
if (block->bbJumpDest != NULL)
{
fgAddRefPred(block->bbJumpDest, block, nullptr, true);
}
break;
case BBJ_EHFINALLYRET:
{
/* Connect the end of the finally to the successor of
the call to this finally */
if (!block->hasHndIndex())
NO_WAY("endfinally outside a finally/fault block.");
unsigned hndIndex = block->getHndIndex();
EHblkDsc* ehDsc = ehGetDsc(hndIndex);
if (!ehDsc->HasFinallyOrFaultHandler())
NO_WAY("endfinally outside a finally/fault block.");
if (ehDsc->HasFinallyHandler())
{
// Find all BBJ_CALLFINALLY that branched to this finally handler.
BasicBlock* begBlk;
BasicBlock* endBlk;
ehGetCallFinallyBlockRange(hndIndex, &begBlk, &endBlk);
BasicBlock* finBeg = ehDsc->ebdHndBeg;
for (BasicBlock* bcall = begBlk; bcall != endBlk; bcall = bcall->bbNext)
{
if (bcall->bbJumpKind != BBJ_CALLFINALLY || bcall->bbJumpDest != finBeg)
continue;
noway_assert(bcall->isBBCallAlwaysPair());
fgAddRefPred(bcall->bbNext, block, nullptr, true);
}
}
}
break;
case BBJ_THROW:
case BBJ_RETURN:
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpTab; jumpTab = block->bbJumpSwt->bbsDstTab;
do
{
/* Mark the target block as being a jump target */
(*jumpTab)->bbFlags |= BBF_JMP_TARGET | BBF_HAS_LABEL;
fgAddRefPred(*jumpTab, block, nullptr, true);
}
while (++jumpTab, --jumpCnt);
break;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
}
for (unsigned EHnum = 0; EHnum < compHndBBtabCount; EHnum++)
{
EHblkDsc* ehDsc = ehGetDsc(EHnum);
if (ehDsc->HasFilter())
{
ehDsc->ebdFilter->bbFlags |= BBF_JMP_TARGET | BBF_HAS_LABEL;
}
ehDsc->ebdHndBeg->bbFlags |= BBF_JMP_TARGET | BBF_HAS_LABEL;
}
fgModified = false;
fgComputePredsDone = true;
#ifdef DEBUG
if (verbose)
{
printf("\n*************** After fgComputePreds()\n");
fgDispBasicBlocks();
printf("\n");
}
#endif
}
unsigned Compiler::fgNSuccsOfFinallyRet(BasicBlock* block)
{
BasicBlock* bb;
unsigned res;
fgSuccOfFinallyRetWork(block, ~0, &bb, &res);
return res;
}
BasicBlock* Compiler::fgSuccOfFinallyRet(BasicBlock* block, unsigned i)
{
BasicBlock* bb;
unsigned res;
fgSuccOfFinallyRetWork(block, i, &bb, &res);
return bb;
}
void Compiler::fgSuccOfFinallyRetWork(BasicBlock* block, unsigned i, BasicBlock** bres, unsigned* nres)
{
assert(block->hasHndIndex()); // Otherwise, endfinally outside a finally/fault block?
unsigned hndIndex = block->getHndIndex();
EHblkDsc* ehDsc = ehGetDsc(hndIndex);
assert(ehDsc->HasFinallyOrFaultHandler()); // Otherwise, endfinally outside a finally/fault block.
*bres = NULL;
unsigned succNum = 0;
if (ehDsc->HasFinallyHandler())
{
BasicBlock* begBlk;
BasicBlock* endBlk;
ehGetCallFinallyBlockRange(hndIndex, &begBlk, &endBlk);
BasicBlock* finBeg = ehDsc->ebdHndBeg;
for (BasicBlock* bcall = begBlk; bcall != endBlk; bcall = bcall->bbNext)
{
if (bcall->bbJumpKind != BBJ_CALLFINALLY || bcall->bbJumpDest != finBeg)
continue;
assert(bcall->isBBCallAlwaysPair());
if (succNum == i)
{
*bres = bcall->bbNext;
return;
}
succNum++;
}
}
assert(i == ~0u || ehDsc->HasFaultHandler()); // Should reach here only for fault blocks.
if (i == ~0u)
{
*nres = succNum;
}
}
Compiler::SwitchUniqueSuccSet Compiler::GetDescriptorForSwitch(BasicBlock* switchBlk)
{
assert(switchBlk->bbJumpKind == BBJ_SWITCH);
BlockToSwitchDescMap* switchMap = GetSwitchDescMap();
SwitchUniqueSuccSet res;
if (switchMap->Lookup(switchBlk, &res))
{
return res;
}
else
{
// We must compute the descriptor. Find which are dups, by creating a bit set with the unique successors.
// We create a temporary bitset of blocks to compute the unique set of successor blocks,
// since adding a block's number twice leaves just one "copy" in the bitset. Note that
// we specifically don't use the BlockSet type, because doing so would require making a
// call to EnsureBasicBlockEpoch() to make sure the epoch is up-to-date. However, that
// can create a new epoch, thus invalidating all existing BlockSet objects, such as
// reachability information stored in the blocks. To avoid that, we just use a local BitVec.
BitVecTraits blockVecTraits(fgBBNumMax + 1, this);
BitVec BITVEC_INIT_NOCOPY(uniqueSuccBlocks, BitVecOps::MakeEmpty(&blockVecTraits));
BasicBlock** jumpTable = switchBlk->bbJumpSwt->bbsDstTab;
unsigned jumpCount = switchBlk->bbJumpSwt->bbsCount;
for (unsigned i = 0; i < jumpCount; i++)
{
BasicBlock* targ = jumpTable[i];
BitVecOps::AddElemD(&blockVecTraits, uniqueSuccBlocks, targ->bbNum);
}
// Now we have a set of unique successors.
unsigned numNonDups = BitVecOps::Count(&blockVecTraits, uniqueSuccBlocks);
typedef BasicBlock* BasicBlockPtr;
BasicBlockPtr* nonDups = new (getAllocator()) BasicBlockPtr[numNonDups];
unsigned nonDupInd = 0;
// At this point, all unique targets are in "uniqueSuccBlocks". As we encounter each,
// add to nonDups, remove from "uniqueSuccBlocks".
for (unsigned i = 0; i < jumpCount; i++)
{
BasicBlock* targ = jumpTable[i];
if (BitVecOps::IsMember(&blockVecTraits, uniqueSuccBlocks, targ->bbNum))
{
nonDups[nonDupInd] = targ;
nonDupInd++;
BitVecOps::RemoveElemD(&blockVecTraits, uniqueSuccBlocks, targ->bbNum);
}
}
assert(nonDupInd == numNonDups);
assert(BitVecOps::Count(&blockVecTraits, uniqueSuccBlocks) == 0);
res.numDistinctSuccs = numNonDups;
res.nonDuplicates = nonDups;
switchMap->Set(switchBlk, res);
return res;
}
}
void Compiler::SwitchUniqueSuccSet::UpdateTarget(IAllocator* alloc, BasicBlock* switchBlk, BasicBlock* from, BasicBlock* to)
{
assert(switchBlk->bbJumpKind == BBJ_SWITCH); // Precondition.
unsigned jmpTabCnt = switchBlk->bbJumpSwt->bbsCount;
BasicBlock** jmpTab = switchBlk->bbJumpSwt->bbsDstTab;
// Is "from" still in the switch table (because it had more than one entry before?)
bool fromStillPresent = false;
for (unsigned i = 0; i < jmpTabCnt; i++)
{
if (jmpTab[i] == from)
{
fromStillPresent = true; break;
}
}
// Is "to" already in "this"?
bool toAlreadyPresent = false;
for (unsigned i = 0; i < numDistinctSuccs; i++)
{
if (nonDuplicates[i] == to)
{
toAlreadyPresent = true; break;
}
}
// Four cases:
// If "from" is still present, and "to" is already present, do nothing
// If "from" is still present, and "to" is not, must reallocate to add an entry.
// If "from" is not still present, and "to" is not present, write "to" where "from" was.
// If "from" is not still present, but "to" is present, remove "from".
if (fromStillPresent && toAlreadyPresent)
{
return;
}
else if (fromStillPresent && !toAlreadyPresent)
{
// reallocate to add an entry
typedef BasicBlock* BasicBlockPtr;
BasicBlockPtr* newNonDups = new (alloc) BasicBlockPtr[numDistinctSuccs+1];
memcpy(newNonDups, nonDuplicates, numDistinctSuccs*sizeof(BasicBlock*));
newNonDups[numDistinctSuccs] = to;
numDistinctSuccs++;
nonDuplicates = newNonDups;
}
else if (!fromStillPresent && !toAlreadyPresent)
{
// write "to" where "from" was
#ifdef DEBUG
bool foundFrom = false;
#endif // DEBUG
for (unsigned i = 0; i < numDistinctSuccs; i++)
{
if (nonDuplicates[i] == from)
{
nonDuplicates[i] = to;
#ifdef DEBUG
foundFrom = true;
#endif // DEBUG
break;
}
}
assert(foundFrom);
}
else
{
assert(!fromStillPresent && toAlreadyPresent);
// remove "from".
#ifdef DEBUG
bool foundFrom = false;
#endif // DEBUG
for (unsigned i = 0; i < numDistinctSuccs; i++)
{
if (nonDuplicates[i] == from)
{
nonDuplicates[i] = nonDuplicates[numDistinctSuccs-1];
numDistinctSuccs--;
#ifdef DEBUG
foundFrom = true;
#endif // DEBUG
break;
}
}
assert(foundFrom);
}
}
/*****************************************************************************
*
* Simple utility function to remove an entry for a block in the switch desc
* map. So it can be called from other phases.
*
*/
void Compiler::fgInvalidateSwitchDescMapEntry(BasicBlock* block)
{
// Check if map has no entries yet.
if (m_switchDescMap != nullptr)
{
m_switchDescMap->Remove(block);
}
}
void Compiler::UpdateSwitchTableTarget(BasicBlock* switchBlk, BasicBlock* from, BasicBlock* to)
{
if (m_switchDescMap == NULL)
return; // No mappings, nothing to do.
// Otherwise...
BlockToSwitchDescMap* switchMap = GetSwitchDescMap();
SwitchUniqueSuccSet* res = switchMap->LookupPointer(switchBlk);
if (res != nullptr)
{
// If no result, nothing to do. Otherwise, update it.
res->UpdateTarget(getAllocator(), switchBlk, from, to);
}
}
/*****************************************************************************
* For a block that is in a handler region, find the first block of the most-nested
* handler containing the block.
*/
BasicBlock* Compiler::fgFirstBlockOfHandler(BasicBlock* block)
{
assert(block->hasHndIndex());
return ehGetDsc(block->getHndIndex())->ebdHndBeg;
}
/*****************************************************************************
*
* Function called to find back edges and return blocks and mark them as needing GC Polls. This marks all
* blocks.
*/
void Compiler::fgMarkGCPollBlocks()
{
if (GCPOLL_NONE == opts.compGCPollType)
return;
#ifdef DEBUG
/* Check that the flowgraph data (bbNum, bbRefs, bbPreds) is up-to-date */
fgDebugCheckBBlist();
#endif
BasicBlock* block;
//Return blocks always need GC polls. In addition, all back edges (including those from switch
//statements) need GC polls. The poll is on the block with the outgoing back edge (or ret), rather than
//on the destination or on the edge itself.
for (block = fgFirstBB; block; block = block->bbNext)
{
bool blockNeedsPoll = false;
switch (block->bbJumpKind)
{
case BBJ_COND:
case BBJ_ALWAYS:
blockNeedsPoll = (block->bbJumpDest->bbNum <= block->bbNum);
break;
case BBJ_RETURN:
blockNeedsPoll = true;
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpTab; jumpTab = block->bbJumpSwt->bbsDstTab;
do
{
if ((*jumpTab)->bbNum <= block->bbNum)
{
blockNeedsPoll = true;
break;
}
}
while (++jumpTab, --jumpCnt);
break;
default:
break;
}
if (blockNeedsPoll)
{
block->bbFlags |= BBF_NEEDS_GCPOLL;
}
}
}
void Compiler::fgInitBlockVarSets()
{
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
block->InitVarSets(this);
}
// QMarks are much like blocks, and need their VarSets initialized.
assert(!compIsForInlining());
for (unsigned i = 0; i < compQMarks->Size(); i++)
{
GenTreePtr qmark = compQMarks->Get(i);
// Perhaps the gtOper of a QMark node was changed to something else since it was created and put on this list.
// So can't hurt to check.
if (qmark->OperGet() == GT_QMARK)
{
VarSetOps::AssignAllowUninitRhs(this, qmark->gtQmark.gtThenLiveSet, VarSetOps::UninitVal());
VarSetOps::AssignAllowUninitRhs(this, qmark->gtQmark.gtElseLiveSet, VarSetOps::UninitVal());
}
}
fgBBVarSetsInited = true;
}
/*****************************************************************************
*
* The following does the final pass on BBF_NEEDS_GCPOLL and then actually creates the GC Polls.
*/
void Compiler::fgCreateGCPolls()
{
if (GCPOLL_NONE == opts.compGCPollType)
return;
bool createdPollBlocks = false;
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgCreateGCPolls() for %s\n",
info.compFullName);
}
#endif // DEBUG
if (!(opts.MinOpts() || opts.compDbgCode))
{
// Remove polls from well formed loops with a constant upper bound.
for (unsigned lnum = 0; lnum < optLoopCount; ++lnum)
{
// Look for constant counted loops that run for a short duration. This logic is very similar to
// what's in code:Compiler::optUnrollLoops, since they have similar constraints. However, this
// logic is much more permissive since we're not doing a complex transformation.
/* TODO-Cleanup:
* I feel bad cloning so much logic from optUnrollLoops
*/
// Filter out loops not meeting the obvious preconditions.
//
if (optLoopTable[lnum].lpFlags & LPFLG_REMOVED)
continue;
if (!(optLoopTable[lnum].lpFlags & LPFLG_CONST))
continue;
BasicBlock* head = optLoopTable[lnum].lpHead;
BasicBlock* bottom = optLoopTable[lnum].lpBottom;
// Loops dominated by GC_SAFE_POINT won't have this set.
if (!(bottom->bbFlags & BBF_NEEDS_GCPOLL))
continue;
/* Get the loop data:
- initial constant
- limit constant
- iterator
- iterator increment
- increment operation type (i.e. ASG_ADD, ASG_SUB, etc...)
- loop test type (i.e. GT_GE, GT_LT, etc...)
*/
int lbeg = optLoopTable[lnum].lpConstInit;
int llim = optLoopTable[lnum].lpConstLimit();
genTreeOps testOper = optLoopTable[lnum].lpTestOper();
int lvar = optLoopTable[lnum].lpIterVar();
int iterInc = optLoopTable[lnum].lpIterConst();
genTreeOps iterOper = optLoopTable[lnum].lpIterOper();
var_types iterOperType = optLoopTable[lnum].lpIterOperType();
bool unsTest = (optLoopTable[lnum].lpTestTree->gtFlags & GTF_UNSIGNED) != 0;
if (lvaTable[lvar].lvAddrExposed) // Can't reason about the value of the iteration variable.
continue;
unsigned totalIter;
/* Find the number of iterations - the function returns false if not a constant number */
if (!optComputeLoopRep(lbeg, llim,
iterInc, iterOper, iterOperType,
testOper, unsTest,
// The value here doesn't matter for this variation of the optimization
true,
&totalIter))
{
#ifdef DEBUG
if (verbose)
{
printf( "Could not compute loop iterations for loop from BB%02u to BB%02u",
head->bbNum, bottom->bbNum );
}
#endif // DEBUG
(void)head; //suppress gcc error.
continue;
}
/* Forget it if there are too many repetitions or not a constant loop */
static const unsigned ITER_LIMIT = 256;
if (totalIter > ITER_LIMIT)
continue;
//It is safe to elminate the poll from this loop.
bottom->bbFlags &= ~BBF_NEEDS_GCPOLL;
#ifdef DEBUG
if (verbose)
{
printf( "Removing poll in block BB%02u because it forms a bounded counted loop\n",
bottom->bbNum );
}
#endif // DEBUG
}
}
// Final chance to optimize the polls. Move all polls in loops from the bottom of the loop up to the
// loop head. Also eliminate all epilog polls in non-leaf methods. This only works if we have dominator
// information.
if (fgDomsComputed)
{
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
if (!(block->bbFlags & BBF_NEEDS_GCPOLL))
continue;
if (block->bbJumpKind == BBJ_COND ||
block->bbJumpKind == BBJ_ALWAYS)
{
//make sure that this is loop-like
if (!fgReachable(block->bbJumpDest, block))
{
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
#ifdef DEBUG
if (verbose)
printf("Removing poll in block BB%02u because it is not loop\n", block->bbNum);
#endif // DEBUG
continue;
}
}
else if (!(block->bbJumpKind == BBJ_RETURN ||
block->bbJumpKind == BBJ_SWITCH))
{
noway_assert(!"GC Poll on a block that has no control transfer.");
#ifdef DEBUG
if (verbose)
printf("Removing poll in block BB%02u because it is not a jump\n", block->bbNum);
#endif // DEBUG
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
continue;
}
// Because of block compaction, it's possible to end up with a block that is both poll and safe.
// Clean those up now.
if (block->bbFlags & BBF_GC_SAFE_POINT)
{
#ifdef DEBUG
if (verbose)
printf("Removing poll in return block BB%02u because it is GC Safe\n", block->bbNum);
#endif // DEBUG
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
continue;
}
if (block->bbJumpKind == BBJ_RETURN)
{
if (!optReachWithoutCall(fgFirstBB, block))
{
//check to see if there is a call along the path between the first block and the return
//block.
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
#ifdef DEBUG
if (verbose)
{
printf("Removing poll in return block BB%02u because it dominated by a call\n", block->bbNum);
}
#endif // DEBUG
continue;
}
}
}
}
noway_assert(!fgGCPollsCreated);
BasicBlock* block;
fgGCPollsCreated = true;
// Walk through the blocks and hunt for a block that has BBF_NEEDS_GCPOLL
for (block = fgFirstBB; block; block = block->bbNext)
{
// Because of block compaction, it's possible to end up with a block that is both poll and safe.
// And if !fgDomsComputed, we won't have cleared them, so skip them now
if (!(block->bbFlags & BBF_NEEDS_GCPOLL) || (block->bbFlags & BBF_GC_SAFE_POINT))
continue;
// This block needs a poll. We either just insert a callout or we split the block and inline part of
// the test. This depends on the value of opts.compGCPollType.
// If we're doing GCPOLL_CALL, just insert a GT_CALL node before the last node in the block.
#ifdef DEBUG
switch (block->bbJumpKind)
{
case BBJ_RETURN:
case BBJ_ALWAYS:
case BBJ_COND:
case BBJ_SWITCH:
break;
default:
noway_assert(!"Unknown block type for BBF_NEEDS_GCPOLL");
}
#endif // DEBUG
noway_assert(opts.compGCPollType);
GCPollType pollType = opts.compGCPollType;
//pollType is set to either CALL or INLINE at this point. Below is the list of places where we
//can't or don't want to emit an inline check. Check all of those. If after all of that we still
//have INLINE, then emit an inline check.
if (opts.MinOpts() || opts.compDbgCode)
{
#ifdef DEBUG
if (verbose)
{
printf( "Selecting CALL poll in block BB%02u because of debug/minopts\n", block->bbNum );
}
#endif // DEBUG
// Don't split blocks and create inlined polls unless we're optimizing.
pollType = GCPOLL_CALL;
}
else if (genReturnBB == block)
{
#ifdef DEBUG
if (verbose)
{
printf("Selecting CALL poll in block BB%02u because it is the single return block\n", block->bbNum);
}
#endif // DEBUG
//we don't want to split the single return block
pollType = GCPOLL_CALL;
}
else if (BBJ_SWITCH == block->bbJumpKind)
{
#ifdef DEBUG
if (verbose)
{
printf("Selecting CALL poll in block BB%02u because it is a loop formed by a SWITCH\n", block->bbNum);
}
#endif // DEBUG
// I don't want to deal with all the outgoing edges of a switch block.
pollType = GCPOLL_CALL;
}
// TODO-Cleanup: potentially don't split if we're in an EH region.
createdPollBlocks |= fgCreateGCPoll(pollType, block);
}
// If we split a block to create a GC Poll, then rerun fgReorderBlocks to push the rarely run blocks out
// past the epilog. We should never split blocks unless we're optimizing.
if (createdPollBlocks)
{
noway_assert(!opts.MinOpts() && !opts.compDbgCode);
fgReorderBlocks();
}
}
/*****************************************************************************
*
* Actually create a GCPoll in the given block. Returns true if it created
* a basic block.
*/
bool Compiler::fgCreateGCPoll(GCPollType pollType, BasicBlock* block)
{
assert(!(block->bbFlags & BBF_GC_SAFE_POINT));
bool createdPollBlocks;
void* addrTrap;
void* pAddrOfCaptureThreadGlobal;
addrTrap = info.compCompHnd->getAddrOfCaptureThreadGlobal(&pAddrOfCaptureThreadGlobal);
// I never want to split blocks if we've got two indirections here.
// This is a size trade-off assuming the VM has ENABLE_FAST_GCPOLL_HELPER.
// So don't do it when that is off
#ifdef ENABLE_FAST_GCPOLL_HELPER
if (pAddrOfCaptureThreadGlobal != NULL)
{
pollType = GCPOLL_CALL;
}
#endif // ENABLE_FAST_GCPOLL_HELPER
if (GCPOLL_CALL == pollType)
{
createdPollBlocks = false;
GenTreePtr tree = gtNewHelperCallNode(CORINFO_HELP_POLL_GC, TYP_VOID);
#if GTF_CALL_REG_SAVE
tree->gtCall.gtCallMoreFlags |= GTF_CALL_REG_SAVE;
#endif //GTF_CALL_REG_SAVE
// for BBJ_ALWAYS I don't need to insert it before the condition. Just append it.
if (block->bbJumpKind == BBJ_ALWAYS)
{
fgInsertStmtAtEnd(block, tree);
}
else
{
GenTreeStmt* newStmt = fgInsertStmtNearEnd(block, tree);
// For DDB156656, we need to associate the GC Poll with the IL offset (and therefore sequence
// point) of the tree before which we inserted the poll. One example of when this is a
// problem:
// if (...) { //1
// ...
// } //2
// else { //3
// ...
// }
// (gcpoll) //4
// return. //5
//
// If we take the if statement at 1, we encounter a jump at 2. This jumps over the else
// and lands at 4. 4 is where we inserted the gcpoll. However, that is associated with
// the sequence point a 3. Therefore, the debugger displays the wrong source line at the
// gc poll location.
//
// More formally, if control flow targets an instruction, that instruction must be the
// start of a new sequence point.
if (newStmt->gtNext)
{
// Is it possible for gtNext to be NULL?
noway_assert(newStmt->gtNext->gtOper == GT_STMT);
newStmt->gtStmtILoffsx = newStmt->gtNextStmt->gtStmtILoffsx;
}
}
block->bbFlags |= BBF_GC_SAFE_POINT;
#ifdef DEBUG
if (verbose)
{
printf("*** creating GC Poll in block BB%02u\n", block->bbNum);
gtDispTreeList(block->bbTreeList);
}
#endif // DEBUG
}
else
{
createdPollBlocks = true;
// if we're doing GCPOLL_INLINE, then:
// 1) Create two new blocks: Poll and Bottom. The original block is called Top.
// I want to create:
// top -> poll -> bottom (lexically)
// so that we jump over poll to get to bottom.
BasicBlock* top = block;
BasicBlock* poll = fgNewBBafter(BBJ_NONE, top, true);
BasicBlock* bottom = fgNewBBafter(top->bbJumpKind, poll, true);
BBjumpKinds oldJumpKind = top->bbJumpKind;
// Update block flags
unsigned originalFlags;
originalFlags = top->bbFlags | BBF_GC_SAFE_POINT;
// Unlike Fei's inliner from puclr, I'm allowed to split loops.
// And we keep a few other flags...
noway_assert((originalFlags & (BBF_SPLIT_NONEXIST
& ~(BBF_LOOP_HEAD | BBF_LOOP_CALL0 | BBF_LOOP_CALL1))) == 0);
top->bbFlags = originalFlags & (~BBF_SPLIT_LOST | BBF_GC_SAFE_POINT);
bottom->bbFlags |= originalFlags & (BBF_SPLIT_GAINED | BBF_IMPORTED | BBF_GC_SAFE_POINT);
bottom->inheritWeight(top);
poll->bbFlags |= originalFlags & (BBF_SPLIT_GAINED | BBF_IMPORTED | BBF_GC_SAFE_POINT);
// 9) Mark Poll as rarely run.
poll->bbSetRunRarely();
// 5) Bottom gets all the outgoing edges and inherited flags of Original.
bottom->bbJumpDest = top->bbJumpDest;
// 2) Add a GC_CALL node to Poll.
GenTreePtr tree = gtNewHelperCallNode(CORINFO_HELP_POLL_GC, TYP_VOID);
#if GTF_CALL_REG_SAVE
tree->gtCall.gtCallMoreFlags |= GTF_CALL_REG_SAVE;
#endif //GTF_CALL_REG_SAVE
fgInsertStmtAtEnd(poll, tree);
// 3) Remove the last statement from Top and add it to Bottom.
if (oldJumpKind != BBJ_ALWAYS)
{
// if I'm always jumping to the target, then this is not a condition that needs moving.
GenTreeStmt* stmt = top->firstStmt();
while (stmt->gtNext)
{
stmt = stmt->gtNextStmt;
}
fgRemoveStmt(top, stmt);
fgInsertStmtAtEnd(bottom, stmt);
}
// for BBJ_ALWAYS blocks, bottom is an empty block.
// 4) Create a GT_EQ node that checks against g_TrapReturningThreads. True jumps to Bottom,
// false falls through to poll. Add this to the end of Top. Top is now BBJ_COND. Bottom is
// now a jump target
#ifdef ENABLE_FAST_GCPOLL_HELPER
// Prefer the fast gc poll helepr over the double indirection
noway_assert(pAddrOfCaptureThreadGlobal == nullptr);
#endif
GenTreePtr trap;
if (pAddrOfCaptureThreadGlobal != nullptr)
{
trap = gtNewOperNode(GT_IND, TYP_I_IMPL, gtNewIconHandleNode((size_t)pAddrOfCaptureThreadGlobal, GTF_ICON_PTR_HDL));
}
else
{
trap = gtNewIconHandleNode((size_t)addrTrap, GTF_ICON_PTR_HDL);
}
GenTreePtr trapRelop = gtNewOperNode(GT_EQ, TYP_INT,
//lhs [g_TrapReturningThreads]
gtNewOperNode(GT_IND, TYP_INT, trap),
//rhs 0
gtNewIconNode(0, TYP_INT)
);
trapRelop->gtFlags |= GTF_RELOP_JMP_USED | GTF_DONT_CSE; //Treat reading g_TrapReturningThreads as volatile.
GenTreePtr trapCheck = gtNewOperNode(GT_JTRUE, TYP_VOID, trapRelop);
fgInsertStmtAtEnd(top, trapCheck);
top->bbJumpDest = bottom;
top->bbJumpKind = BBJ_COND;
bottom->bbFlags |= BBF_JMP_TARGET;
// 7) Bottom has Top and Poll as its predecessors. Poll has just Top as a predecessor.
fgAddRefPred(bottom, poll);
fgAddRefPred(bottom, top);
fgAddRefPred(poll, top);
// 8) Replace Top with Bottom in the predecessor list of all outgoing edges from Bottom (1 for
// jumps, 2 for conditional branches, N for switches).
switch (oldJumpKind)
{
case BBJ_RETURN:
// no successors
break;
case BBJ_COND:
// replace predecessor in the fall through block.
noway_assert(bottom->bbNext);
fgReplacePred(bottom->bbNext, top, bottom);
// fall through for the jump target
__fallthrough;
case BBJ_ALWAYS:
fgReplacePred(bottom->bbJumpDest, top, bottom);
break;
case BBJ_SWITCH:
NO_WAY("SWITCH should be a call rather than an inlined poll.");
break;
default:
NO_WAY("Unknown block type for updating predecessor lists.");
}
top->bbFlags &= ~BBF_NEEDS_GCPOLL;
noway_assert(!(poll->bbFlags & BBF_NEEDS_GCPOLL));
noway_assert(!(bottom->bbFlags & BBF_NEEDS_GCPOLL));
if (compCurBB == top)
{
compCurBB = bottom;
}
#ifdef DEBUG
if (verbose)
{
printf("*** creating inlined GC Poll in top block BB%02u\n", top->bbNum);
gtDispTreeList(top->bbTreeList);
printf(" poll block is BB%02u\n", poll->bbNum);
gtDispTreeList(poll->bbTreeList);
printf(" bottom block is BB%02u\n", bottom->bbNum);
gtDispTreeList(bottom->bbTreeList);
}
#endif // DEBUG
}
return createdPollBlocks;
}
/*****************************************************************************
*
* The following helps find a basic block given its PC offset.
*/
void Compiler::fgInitBBLookup()
{
BasicBlock** dscBBptr;
BasicBlock* tmpBBdesc;
/* Allocate the basic block table */
dscBBptr = fgBBs = new (this, CMK_BasicBlock) BasicBlock*[fgBBcount];
/* Walk all the basic blocks, filling in the table */
for (tmpBBdesc = fgFirstBB; tmpBBdesc; tmpBBdesc = tmpBBdesc->bbNext)
{
*dscBBptr++ = tmpBBdesc;
}
noway_assert(dscBBptr == fgBBs + fgBBcount);
}
BasicBlock* Compiler::fgLookupBB(unsigned addr)
{
unsigned lo;
unsigned hi;
/* Do a binary search */
for (lo = 0, hi = fgBBcount - 1;;)
{
AGAIN:;
if (lo > hi)
break;
unsigned mid = (lo + hi) / 2;
BasicBlock* dsc = fgBBs[mid];
// We introduce internal blocks for BBJ_CALLFINALLY. Skip over these.
while (dsc->bbFlags & BBF_INTERNAL)
{
dsc = dsc->bbNext;
mid++;
// We skipped over too many, Set hi back to the original mid - 1
if (mid > hi)
{
mid = (lo + hi) / 2;
hi = mid - 1;
goto AGAIN;
}
}
unsigned pos = dsc->bbCodeOffs;
if (pos < addr)
{
if ((lo == hi) && (lo == (fgBBcount - 1)))
{
noway_assert(addr == dsc->bbCodeOffsEnd);
return NULL; // NULL means the end of method
}
lo = mid + 1;
continue;
}
if (pos > addr)
{
hi = mid - 1;
continue;
}
return dsc;
}
#ifdef DEBUG
printf("ERROR: Couldn't find basic block at offset %04X\n", addr);
#endif // DEBUG
NO_WAY("fgLookupBB failed.");
}
/*****************************************************************************
*
* The 'jump target' array uses the following flags to indicate what kind
* of label is present.
*/
#define JT_NONE 0x00 // This IL offset is never used
#define JT_ADDR 0x01 // merely make sure this is an OK address
#define JT_JUMP 0x02 // 'normal' jump target
#define JT_MULTI 0x04 // target of multiple jumps
inline
void Compiler::fgMarkJumpTarget(BYTE* jumpTarget, unsigned offs)
{
/* Make sure we set JT_MULTI if target of multiple jumps */
noway_assert(JT_MULTI == JT_JUMP << 1);
jumpTarget[offs] |= (jumpTarget[offs] & JT_JUMP) << 1 | JT_JUMP;
}
/*****************************************************************************
*
* Walk the instrs and for any jumps we find set the appropriate entry
* in the 'jumpTarget' table.
* Also sets lvAddrExposed and lvArgWrite in lvaTable[]
*/
#ifdef _PREFAST_
#pragma warning(push)
#pragma warning(disable:21000) // Suppress PREFast warning about overly large function
#endif
//Helpers to track stack transitions for conditional heuristics in fgFindJumpTargets
const unsigned fgStackSlotInvalid = UINT_MAX;
const unsigned fgStackSlotUnknown = 0;
const unsigned fgStackSlotConstant = 1;
const unsigned fgStackSlotArrayLen = 2;
const unsigned fgStackSlotFirstArg = 3;
class fgStack
{
public:
fgStack() : depth(0)
{
slot0 = fgStackSlotInvalid;
slot1 = fgStackSlotInvalid;
}
//Removes everything from the stack.
inline void clear() { depth = 0; }
inline void pushUnknown() { push(fgStackSlotUnknown); }
inline void pushConstant() { push(fgStackSlotConstant); }
inline void pushArrayLen() { push(fgStackSlotArrayLen); }
inline void pushArgument(unsigned arg) { push(fgStackSlotFirstArg + arg); }
inline unsigned getSlot0() { assert(depth >= 1); return slot0; }
inline unsigned getSlot1() { assert(depth >= 2); return slot1; }
inline static bool isConstant(unsigned value) { return value == fgStackSlotConstant;}
inline static bool isArrayLen(unsigned value) { return value == fgStackSlotArrayLen;}
inline static bool isArgument(unsigned value) { return value >= fgStackSlotFirstArg;}
inline static unsigned slotTypeToArgNum(unsigned value) { return value - fgStackSlotFirstArg; }
inline bool isStackTwoDeep() { return depth == 2; }
inline bool isStackOneDeep() { return depth == 1; }
private:
inline void push(unsigned type)
{
switch (depth)
{
case 0:
++depth;
slot0 = type;
break;
case 1:
++depth;
__fallthrough;
case 2:
slot1 = slot0;
slot0 = type;
}
}
unsigned slot0;
unsigned slot1;
unsigned depth;
};
void Compiler::fgFindJumpTargets(const BYTE * codeAddr,
IL_OFFSET codeSize,
BYTE * jumpTarget)
{
const BYTE * codeBegp = codeAddr;
const BYTE * codeEndp = codeAddr + codeSize;
unsigned varNum;
bool seenJump = false;
OPCODE opcode;
const char * inlineFailReason = NULL;
var_types varType = DUMMY_INIT(TYP_UNDEF); // TYP_ type
typeInfo ti; // Verifier type.
#ifndef DEBUG
CodeSeqSM LocalSm;
#endif
CodeSeqSM * pSm = NULL;
SM_OPCODE smOpcode = DUMMY_INIT((SM_OPCODE)0);
unsigned ldStCount = 0; //Number of load/store instructions.
// Keep track of constants and args on the stack.
fgStack pushedStack;
// compIsMethodForLRSampling and compIsForInlining() can't both be true.
noway_assert(!compIsMethodForLRSampling || !compIsForInlining());
// Determine whether to start the state machine to estimate the size of the
// native code for this method.
bool useSm = false;
if (compIsMethodForLRSampling)
{
// Linear regression sampling requires the estimated native code size.
useSm = true;
}
else if ((codeSize > ALWAYS_INLINE_SIZE) &&
!(info.compFlags & CORINFO_FLG_FORCEINLINE))
{
// The size of the native code for this method matters for inlining
// decisions.
if (compIsForInlining())
{
// This method is being compiled as an inline candidate and will be
// rejected if its native code is too large.
useSm = true;
}
else if ((opts.eeFlags & CORJIT_FLG_PREJIT) &&
(codeSize <= impInlineSize))
{
// This method isn't an inline candidate yet, but it's small enough
// to be considered for one in the future. Keep track of the
// estimated native code size; it will be used elsewhere later.
useSm = true;
}
}
if (useSm)
{
#ifdef DEBUG
pSm = &fgCodeSeqSm;
#else
pSm = &LocalSm;
#endif
pSm->Start(this);
}
#ifdef FEATURE_LEGACYNETCF
// NetCF had some strict restrictions on inlining. Specifically they
// would only inline methods that fit a specific pattern of loading
// arguments inorder, starting with zero, with no skipping, but not
// needing to load all of them. Then a 'body' section that could do
// anything besides control flow. And a final ending ret opcode.
// Lastly they did not allow starg or ldarga.
// These simplifications allowed them to skip past the ldargs, when
// inlining, and just use the caller's EE stack as the callee's EE
// stack, after optionally popping a few 'arguments' from the end.
//
// stateNetCFQuirks is a simple state machine to track that state
// and allow us to match those restrictions.
// State -1 means we're not tracking (no quirks mode)
// State 0 though 0x0000FFFF tracks what the *next* ldarg should be
// to match the pattern
// State 0x00010000 and above means we are in the 'body' section and
// thus no more ldarg's are allowed.
int stateNetCFQuirks = -1;
if (compIsForInlining() && (opts.eeFlags & CORJIT_FLG_NETCF_QUIRKS))
{
stateNetCFQuirks = 0;
}
#endif // FEATURE_LEGACYNETCF
while (codeAddr < codeEndp)
{
unsigned sz;
opcode = (OPCODE) getU1LittleEndian(codeAddr);
codeAddr += sizeof(__int8);
opts.instrCount++;
DECODE_OPCODE:
/* Get the size of additional parameters */
if (opcode >= CEE_COUNT)
BADCODE3("Illegal opcode", ": %02X", (int) opcode);
#ifdef FEATURE_LEGACYNETCF
// If this is the first non-ldarg, then transition states
if ((0 == (stateNetCFQuirks & 0x10000)) &&
((opcode < CEE_LDARG_0) || (opcode > CEE_LDARG_3)) &&
(opcode != CEE_LDARG_S) && (opcode != CEE_LDARG) && (opcode != CEE_PREFIX1))
{
// Maximum number of arguments is 2^16 - 1
// so this value will never line up with any ldarg
stateNetCFQuirks = 0x10000;
}
#endif // FEATURE_LEGACYNETCF
if ((opcode >= CEE_LDARG_0 && opcode <= CEE_STLOC_S) ||
(opcode >= CEE_LDARG && opcode <= CEE_STLOC))
{
opts.lvRefCount++;
++ldStCount;
}
//Check the rest of the LD/ST ranges
else if (opcode >= CEE_LDNULL && opcode <= CEE_LDC_R8)
{
pushedStack.pushConstant();
++ldStCount;
}
else if ((opcode >= CEE_LDIND_I1 && opcode <= CEE_STIND_R8)
|| (opcode >= CEE_LDFLD && opcode <= CEE_STOBJ)
|| (opcode >= CEE_LDELEMA && opcode <= CEE_STELEM))
//Don't count LDOBJ or LDSTR. The former isn't exactly a load and the latter has issues with
//interning.
{
++ldStCount;
}
else if (opcode == CEE_POP)
{
++ldStCount;
}
sz = opcodeSizes[opcode];
if (pSm)
{
smOpcode = CodeSeqSM::MapToSMOpcode(opcode);
}
switch (opcode)
{
signed jmpDist;
unsigned jmpAddr;
// For CEE_SWITCH
unsigned jmpBase;
unsigned jmpCnt;
case CEE_PREFIX1:
if (codeAddr >= codeEndp)
goto TOO_FAR;
opcode = (OPCODE) (256+getU1LittleEndian(codeAddr));
codeAddr += sizeof(__int8);
goto DECODE_OPCODE;
case CEE_PREFIX2:
case CEE_PREFIX3:
case CEE_PREFIX4:
case CEE_PREFIX5:
case CEE_PREFIX6:
case CEE_PREFIX7:
case CEE_PREFIXREF:
BADCODE3("Illegal opcode", ": %02X", (int) opcode);
case CEE_CALL:
case CEE_CALLVIRT:
//If the method has a call followed by a ret, assume that it is
//a wrapper method.
if (compIsForInlining())
{
//There has to be code after the call, otherwise the inlinee is unverifiable.
noway_assert(codeAddr < codeEndp - sz);
if ((OPCODE) getU1LittleEndian(codeAddr + sz) == CEE_RET)
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlLooksLikeWrapperMethod);
#ifdef DEBUG
//printf("CALL->RET pattern found in %s\n", info.compFullName);
#endif
}
}
break;
/* Check for an unconditional jump opcode */
case CEE_LEAVE:
case CEE_LEAVE_S:
case CEE_BR:
case CEE_BR_S:
/* Check for a conditional jump opcode */
case CEE_BRFALSE:
case CEE_BRFALSE_S:
case CEE_BRTRUE:
case CEE_BRTRUE_S:
case CEE_BEQ:
case CEE_BEQ_S:
case CEE_BGE:
case CEE_BGE_S:
case CEE_BGE_UN:
case CEE_BGE_UN_S:
case CEE_BGT:
case CEE_BGT_S:
case CEE_BGT_UN:
case CEE_BGT_UN_S:
case CEE_BLE:
case CEE_BLE_S:
case CEE_BLE_UN:
case CEE_BLE_UN_S:
case CEE_BLT:
case CEE_BLT_S:
case CEE_BLT_UN:
case CEE_BLT_UN_S:
case CEE_BNE_UN:
case CEE_BNE_UN_S:
seenJump = true;
if (codeAddr > codeEndp - sz)
goto TOO_FAR;
#ifdef FEATURE_LEGACYNETCF
if (stateNetCFQuirks >= 0)
{
inlineFailReason = "Windows Phone OS 7 compatibility - Inlinee contains control flow.";
goto InlineNever;
}
#endif // FEATURE_LEGACYNETCF
/* Compute the target address of the jump */
jmpDist = (sz==1) ? getI1LittleEndian(codeAddr)
: getI4LittleEndian(codeAddr);
if (compIsForInlining() && jmpDist == 0 && (opcode == CEE_LEAVE || opcode == CEE_LEAVE_S
|| opcode == CEE_BR || opcode == CEE_BR_S))
break; /* NOP */
jmpAddr = (IL_OFFSET)(codeAddr - codeBegp) + sz + jmpDist;
/* Make sure the target address is reasonable */
if (jmpAddr >= codeSize)
{
BADCODE3("code jumps to outer space",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
}
/* Finally, set the 'jump target' flag */
fgMarkJumpTarget(jumpTarget, jmpAddr);
if (compIsForInlining() && opcode != CEE_BR_S && opcode != CEE_BR)
goto INL_HANDLE_COMPARE;
break;
case CEE_SWITCH:
seenJump = true;
if (compIsForInlining())
{
#ifdef FEATURE_LEGACYNETCF
if (stateNetCFQuirks >= 0)
{
inlineFailReason = "Windows Phone OS 7 compatibility - Inlinee contains control flow.";
goto InlineNever;
}
#endif // FEATURE_LEGACYNETCF
inlineFailReason = "Inlinee contains SWITCH instruction.";
goto InlineFailed;
}
// Make sure we don't go past the end reading the number of cases
if (codeAddr > codeEndp - sizeof(DWORD))
goto TOO_FAR;
// Read the number of cases
jmpCnt = getU4LittleEndian(codeAddr);
codeAddr += sizeof(DWORD);
if (jmpCnt > codeSize / sizeof(DWORD))
goto TOO_FAR;
// Find the end of the switch table
jmpBase = (unsigned)((codeAddr - codeBegp) + jmpCnt*sizeof(DWORD));
/* Make sure we have room for the switch table */
if (jmpBase >= codeSize)
goto TOO_FAR;
// jmpBase is also the target of the default case, so mark it
fgMarkJumpTarget(jumpTarget, jmpBase);
/* Process all the entries in the jump table */
while (jmpCnt)
{
jmpAddr = jmpBase + getI4LittleEndian(codeAddr);
codeAddr += 4;
if (jmpAddr >= codeSize)
BADCODE3("jump target out of range",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
fgMarkJumpTarget(jumpTarget, jmpAddr);
jmpCnt--;
}
/* We've now consumed the entire switch opcode */
goto _SkipCodeAddrAdjustment;
case CEE_UNALIGNED:
case CEE_CONSTRAINED:
case CEE_READONLY:
case CEE_VOLATILE:
case CEE_TAILCALL:
if (codeAddr >= codeEndp)
goto TOO_FAR;
#ifdef FEATURE_LEGACYNETCF
if (stateNetCFQuirks >= 0)
{
inlineFailReason = "Windows Phone OS 7 compatibility - Inlinee contains prefix.";
goto InlineNever;
}
#endif // FEATURE_LEGACYNETCF
break;
case CEE_STARG:
case CEE_STARG_S: goto ARG_WRITE;
case CEE_LDARGA:
case CEE_LDARGA_S:
case CEE_LDLOCA:
case CEE_LDLOCA_S: goto ADDR_TAKEN;
// Other opcodes that we know inliner won't handle.
case CEE_THROW:
#ifdef FEATURE_LEGACYNETCF
if (stateNetCFQuirks >= 0)
{
inlineFailReason = "Windows Phone OS 7 compatibility - Inlinee contains throw.";
goto InlineNever;
}
#endif // FEATURE_LEGACYNETCF
if (seenJump)
break;
case CEE_ISINST:
case CEE_CASTCLASS:
case CEE_SIZEOF:
case CEE_LDTOKEN:
case CEE_UNBOX:
//Needs weight value in SMWeights.cpp
case CEE_UNBOX_ANY:
break;
case CEE_JMP:
#if !defined(_TARGET_X86_) && !defined(_TARGET_ARM_)
if (!compIsForInlining())
{
// We transform this into a set of ldarg's + tail call and
// thus may push more onto the stack than originally thought.
// This doesn't interfere with verification because CEE_JMP
// is never verifiable, and there's nothing unsafe you can
// do with a an IL stack overflow if the JIT is expecting it.
info.compMaxStack = max(info.compMaxStack, info.compILargsCount);
break;
}
#endif // !_TARGET_X86_ && !_TARGET_ARM_
// If we are inlining, we need to fail for a CEE_JMP opcode, just like
// the list of other opcodes (for all platforms).
__fallthrough;
// CEE_CALLI should not be inlined because the JIT cannot generate an inlined call frame. If the call target
// is a no-marshal CALLI P/Invoke we end up calling the IL stub. We don't NGEN these stubs, so we'll have to
// JIT an IL stub for a trivial func. It's almost certainly a better choice to leave out the inline candidate
// so we can generate an inlined call frame. It might be nice to call getCallInfo to figure out what kind of
// call we have here.
case CEE_CALLI:
//Needs weight value in SMWeights.cpp
case CEE_LOCALLOC:
case CEE_CPBLK:
case CEE_MKREFANY:
case CEE_RETHROW:
//Consider making this only for not force inline.
if (compIsForInlining())
{
#ifdef DEBUG
inlineFailReason = (char*)compAllocator->nraAlloc(128);
sprintf((char*)inlineFailReason, "Unsupported opcode for inlining: %s\n",
opcodeNames[opcode]);
#else
inlineFailReason = "Unsupported opcode for inlining.";
#endif
goto InlineFailed;
}
break;
case CEE_LDARG_0:
varNum = 0; goto ARG_PUSH;
case CEE_LDARG_1:
varNum = 1; goto ARG_PUSH;
case CEE_LDARG_2:
varNum = 2; goto ARG_PUSH;
case CEE_LDARG_3:
varNum = 3; goto ARG_PUSH;
case CEE_LDARG_S:
case CEE_LDARG:
if (codeAddr > codeEndp - sz)
goto TOO_FAR;
varNum = (sz == sizeof(BYTE)) ? getU1LittleEndian(codeAddr)
: getU2LittleEndian(codeAddr);
goto ARG_PUSH;
case CEE_LDLEN:
if (compIsForInlining())
pushedStack.pushArrayLen();
break;
case CEE_CEQ:
case CEE_CGT:
case CEE_CGT_UN:
case CEE_CLT:
case CEE_CLT_UN:
if (compIsForInlining())
goto INL_HANDLE_COMPARE;
break;
default:
break;
INL_HANDLE_COMPARE:
noway_assert(compIsForInlining());
//We're looking at a comparison. There are several cases that we would like to recognize for
//inlining:
// Static cases
// - An incoming argument is compared against a constant
// - An incoming argument is compared against an array length
//
// Dynamic cases
// - An incoming argument which is a constant is used in a comparison.
{
if (!pushedStack.isStackTwoDeep())
{
//The stack only has to be 1 deep for BRTRUE/FALSE
if (pushedStack.isStackOneDeep())
{
if (opcode == CEE_BRFALSE || opcode == CEE_BRFALSE_S ||
opcode == CEE_BRTRUE || opcode == CEE_BRTRUE_S)
{
unsigned slot0 = pushedStack.getSlot0();
if (fgStack::isArgument(slot0))
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlArgFeedsConstantTest);
//Check for the double whammy of an incoming constant argument feeding a
//constant test.
varNum = fgStack::slotTypeToArgNum(slot0);
if (impInlineInfo->inlArgInfo[varNum].argNode->OperIsConst())
{
compInlineeHints = (InlInlineHints)(compInlineeHints
| InlIncomingConstFeedsCond);
}
}
}
}
break;
}
unsigned slot0 = pushedStack.getSlot0();
unsigned slot1 = pushedStack.getSlot1();
//Arg feeds constant test.
if ((fgStack::isConstant(slot0) && fgStack::isArgument(slot1))
||(fgStack::isConstant(slot1) && fgStack::isArgument(slot0)))
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlArgFeedsConstantTest);
}
//Arg feeds range check
if ((fgStack::isArrayLen(slot0) && fgStack::isArgument(slot1))
||(fgStack::isArrayLen(slot1) && fgStack::isArgument(slot0)))
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlArgFeedsRngChk);
}
//Check for an incoming arg that's a constant.
if (fgStack::isArgument(slot0))
{
varNum = fgStack::slotTypeToArgNum(slot0);
if (impInlineInfo->inlArgInfo[varNum].argNode->OperIsConst())
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlIncomingConstFeedsCond);
}
}
if (fgStack::isArgument(slot1))
{
varNum = fgStack::slotTypeToArgNum(slot1);
if (impInlineInfo->inlArgInfo[varNum].argNode->OperIsConst())
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlIncomingConstFeedsCond);
}
}
}
break;
ARG_PUSH:
if (compIsForInlining())
{
pushedStack.pushArgument(varNum);
#ifdef FEATURE_LEGACYNETCF
if (stateNetCFQuirks >= 0)
{
unsigned expectedVarNum = (unsigned)stateNetCFQuirks;
stateNetCFQuirks++;
if (varNum != expectedVarNum)
{
inlineFailReason = "Windows Phone OS 7 compatibility - out of order ldarg.";
goto InlineNever;
}
}
#endif // FEATURE_LEGACYNETCF
}
break;
ADDR_TAKEN:
#ifdef FEATURE_LEGACYNETCF
if (stateNetCFQuirks >= 0)
{
inlineFailReason = "Windows Phone OS 7 compatibility - address taken.";
goto InlineNever;
}
#endif // FEATURE_LEGACYNETCF
noway_assert(sz == sizeof(BYTE) || sz == sizeof(WORD));
if (codeAddr > codeEndp - sz)
goto TOO_FAR;
varNum = (sz == sizeof(BYTE)) ? getU1LittleEndian(codeAddr)
: getU2LittleEndian(codeAddr);
if (compIsForInlining())
{
if (opcode == CEE_LDLOCA ||
opcode == CEE_LDLOCA_S)
{
varType = impInlineInfo->lclVarInfo[varNum + impInlineInfo->argCnt].lclTypeInfo;
ti = impInlineInfo->lclVarInfo[varNum + impInlineInfo->argCnt].lclVerTypeInfo;
impInlineInfo->lclVarInfo[varNum + impInlineInfo->argCnt].lclHasLdlocaOp = true;
}
else
{
noway_assert(opcode == CEE_LDARGA || opcode == CEE_LDARGA_S);
varType = impInlineInfo->lclVarInfo[varNum].lclTypeInfo;
ti = impInlineInfo->lclVarInfo[varNum].lclVerTypeInfo;
impInlineInfo->inlArgInfo[varNum].argHasLdargaOp = true;
pushedStack.pushArgument(varNum);
}
}
else
{
if (opcode == CEE_LDLOCA || opcode == CEE_LDLOCA_S)
{
if (varNum >= info.compMethodInfo->locals.numArgs)
BADCODE("bad local number");
varNum += info.compArgsCount;
}
else
{
noway_assert(opcode == CEE_LDARGA || opcode == CEE_LDARGA_S);
if (varNum >= info.compILargsCount)
BADCODE("bad argument number");
varNum = compMapILargNum(varNum); // account for possible hidden param
}
if (pSm)
{
varType = (var_types)lvaTable[varNum].lvType;
ti = lvaTable[varNum].lvVerTypeInfo;
}
if (lvaTable[varNum].TypeGet() != TYP_STRUCT && // We will put structs in the stack anyway
// And changing the addrTaken of a local
// requires an extra pass in the morpher
// so we won't apply this optimization
// to structs.
codeAddr < codeEndp - sz && // This is not the last instruction
impILConsumesAddr(codeAddr + sz, impTokenLookupContextHandle, info.compScopeHnd) &&
opts.compDbgCode == false) // Debug code spills for every IL instruction, and therefore
// it will split statements, so we will need the address.
// Note that this optimization is based in that we know
// what trees we will generate for this ldfld, and we
// require that we won't need the address of this local
// at all
{
// We can skip the addrtaken, as next IL instruction consumes
// the address. For debuggable code we mark this bit so we
// can have asserts in the rest of the jit
#ifdef DEBUG
noway_assert(varNum < lvaTableCnt);
lvaTable[varNum].lvSafeAddrTaken = 1;
#endif
}
else
{
noway_assert(varNum < lvaTableCnt);
lvaTable[varNum].lvHasLdAddrOp = 1;
if (!info.compIsStatic &&
varNum == 0)
{
// Addr taken on "this" pointer is significant,
// go ahead to mark it as permanently addr-exposed here.
lvaSetVarAddrExposed(0);
// This may be conservative, but probably not very.
}
}
} // compIsForInlining()
if (pSm &&
ti.IsValueClass() &&
varType != TYP_STRUCT)
{
#ifdef DEBUG
if (verbose)
printf("Loading address of normed V%02u at IL offset [0x%x]\n", varNum, codeAddr-codeBegp-1);
#endif
if (smOpcode == SM_LDARGA_S)
smOpcode = SM_LDARGA_S_NORMED;
else if (smOpcode == SM_LDLOCA_S)
smOpcode = SM_LDLOCA_S_NORMED;
}
break;
ARG_WRITE:
if (compIsForInlining())
{
#ifdef DEBUG
if (verbose)
{
printf("\n\nInline expansion aborted due to opcode at offset [%02u] which writes to an argument\n",
codeAddr-codeBegp-1);
}
#endif
/* The inliner keeps the args as trees and clones them. Storing the arguments breaks that
* simplification. To allow this, flag the argument as written to and spill it before
* inlining. That way the STARG in the inlinee is trivial. */
inlineFailReason = "Inlinee writes to an argument.";
goto InlineNever;
}
else
{
noway_assert(sz == sizeof(BYTE) || sz == sizeof(WORD));
if (codeAddr > codeEndp - sz)
goto TOO_FAR;
varNum = (sz == sizeof(BYTE)) ? getU1LittleEndian(codeAddr)
: getU2LittleEndian(codeAddr);
varNum = compMapILargNum(varNum); // account for possible hidden param
// This check is only intended to prevent an AV. Bad varNum values will later
// be handled properly by the verifier.
if (varNum < lvaTableCnt)
lvaTable[varNum].lvArgWrite = 1;
}
break;
}
/* Skip any operands this opcode may have */
codeAddr += sz;
_SkipCodeAddrAdjustment:
;
if (pSm)
{
noway_assert(smOpcode<SM_COUNT);
noway_assert(smOpcode != SM_PREFIX_N);
#ifdef DEBUG
++pSm->instrCount;
#endif
pSm->Run(smOpcode DEBUGARG(0));
}
}
if (codeAddr != codeEndp)
{
TOO_FAR:
BADCODE3("Code ends in the middle of an opcode, or there is a branch past the end of the method",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
}
//If this function is mostly loads and stores, we should try harder to inline it. You can't just use
//the percentage test because if the method has 8 instructions and 6 are loads, it's only 75% loads.
//This allows for CALL, RET, and one more non-ld/st instruction.
if ((opts.instrCount - ldStCount) < 4 || ((double)ldStCount/(double)opts.instrCount) > .90)
{
compInlineeHints = (InlInlineHints)(compInlineeHints | InlMethodMostlyLdSt);
}
if (pSm)
{
pSm->End();
noway_assert(pSm->NativeSize != NATIVE_SIZE_INVALID);
compNativeSizeEstimate = pSm->NativeSize;
#ifdef DEBUG
if (verbose)
{
printf("\n\ncompNativeSizeEstimate=%d\n", compNativeSizeEstimate);
}
#endif
if (compIsForInlining())
{
// If the inlining decision was obvious from the size of the IL,
// it should have been made earlier.
noway_assert(codeSize > ALWAYS_INLINE_SIZE && codeSize <= impInlineSize);
// Make an inlining decision based on the estimated native size.
int callsiteNativeSizeEstimate = impEstimateCallsiteNativeSize(&impInlineInfo->inlineCandidateInfo->methInfo);
JitInlineResult result = impCanInlineNative(callsiteNativeSizeEstimate,
compNativeSizeEstimate,
compInlineeHints,
impInlineInfo);
if (dontInline(result.result()))
{
#ifdef DEBUG
if (verbose)
{
printf("\n\nInline expansion aborted because impCanInlineNative returns %s\n",
(result.result()==INLINE_NEVER)?"INLINE_NEVER":"INLINE_FAIL");
}
#endif
compSetInlineResult(result);
return;
}
}
}
if (!compIsForInlining() && // None of the local vars in the inlinee should have address taken or been written to.
// Therefore we should NOT need to enter this "if" statement.
!info.compIsStatic)
{
//If we're verifying, then we can't do this. This flag makes the method unverifiable from the
//Importer's point of view.
if (!tiVerificationNeeded && compStressCompile(STRESS_GENERIC_VARN, 15))
lvaTable[info.compThisArg].lvArgWrite = true;
if (lvaTable[info.compThisArg].lvAddrExposed || lvaTable[info.compThisArg].lvArgWrite)
{
// If there is a "ldarga 0" or "starg 0", grab and use the temp.
lvaArg0Var = lvaGrabTemp(false DEBUGARG("Address-exposed, or written, this pointer"));
noway_assert(lvaArg0Var > (unsigned)info.compThisArg);
lvaTable[lvaArg0Var].lvType = lvaTable[info.compThisArg].TypeGet();
lvaTable[lvaArg0Var].lvAddrExposed = lvaTable[info.compThisArg].lvAddrExposed;
lvaTable[lvaArg0Var].lvDoNotEnregister = lvaTable[info.compThisArg].lvDoNotEnregister;
#ifdef DEBUG
lvaTable[lvaArg0Var].lvVMNeedsStackAddr = lvaTable[info.compThisArg].lvVMNeedsStackAddr;
lvaTable[lvaArg0Var].lvLiveInOutOfHndlr = lvaTable[info.compThisArg].lvLiveInOutOfHndlr;
lvaTable[lvaArg0Var].lvLclFieldExpr = lvaTable[info.compThisArg].lvLclFieldExpr;
lvaTable[lvaArg0Var].lvLiveAcrossUCall = lvaTable[info.compThisArg].lvLiveAcrossUCall;
#endif
lvaTable[lvaArg0Var].lvArgWrite = lvaTable[info.compThisArg].lvArgWrite;
lvaTable[lvaArg0Var].lvVerTypeInfo = lvaTable[info.compThisArg].lvVerTypeInfo;
// Clear the TI_FLAG_THIS_PTR in the original 'this' pointer.
noway_assert(lvaTable[lvaArg0Var].lvVerTypeInfo.IsThisPtr());
lvaTable[info.compThisArg].lvVerTypeInfo.ClearThisPtr();
lvaTable[info.compThisArg].lvAddrExposed = false;
lvaTable[info.compThisArg].lvArgWrite = false;
}
}
return;
CorInfoInline failResult;
InlineNever:
failResult = INLINE_NEVER;
goto Report;
InlineFailed:
failResult = INLINE_FAIL;
Report:
#ifdef DEBUG
if (verbose)
{
impCurOpcName = opcodeNames[opcode];
printf("\n\nInline expansion aborted due to opcode [%02u] OP_%s in method %s\n",
codeAddr-codeBegp-1, impCurOpcName, info.compFullName);
}
#endif
noway_assert(compIsForInlining());
noway_assert(impInlineInfo->fncHandle == info.compMethodHnd);
compSetInlineResult(JitInlineResult(failResult, impInlineInfo->inlineCandidateInfo->ilCallerHandle,
info.compMethodHnd, inlineFailReason));
return;
}
#ifdef _PREFAST_
#pragma warning(pop)
#endif
/*****************************************************************************
*
* Finally link up the bbJumpDest of the blocks together
*/
void Compiler::fgMarkBackwardJump(BasicBlock * startBlock, BasicBlock * endBlock)
{
noway_assert(startBlock->bbNum <= endBlock->bbNum);
for (BasicBlock * block = startBlock;
block != endBlock->bbNext;
block = block->bbNext)
{
if ((block->bbFlags & BBF_BACKWARD_JUMP) == 0)
block->bbFlags |= BBF_BACKWARD_JUMP;
}
}
/*****************************************************************************
*
* Finally link up the bbJumpDest of the blocks together
*/
void Compiler::fgLinkBasicBlocks()
{
/* Create the basic block lookup tables */
fgInitBBLookup();
/* First block is always reachable */
fgFirstBB->bbRefs = 1;
/* Walk all the basic blocks, filling in the target addresses */
for (BasicBlock * curBBdesc = fgFirstBB;
curBBdesc;
curBBdesc = curBBdesc->bbNext)
{
switch (curBBdesc->bbJumpKind)
{
case BBJ_COND:
case BBJ_ALWAYS:
case BBJ_LEAVE:
curBBdesc->bbJumpDest = fgLookupBB(curBBdesc->bbJumpOffs);
curBBdesc->bbJumpDest->bbRefs++;
if (curBBdesc->bbJumpDest->bbNum <= curBBdesc->bbNum)
{
fgMarkBackwardJump(curBBdesc->bbJumpDest, curBBdesc);
}
/* Is the next block reachable? */
if (curBBdesc->bbJumpKind == BBJ_ALWAYS ||
curBBdesc->bbJumpKind == BBJ_LEAVE)
break;
if (!curBBdesc->bbNext)
BADCODE("Fall thru the end of a method");
// Fall through, the next block is also reachable
case BBJ_NONE:
curBBdesc->bbNext->bbRefs++;
break;
case BBJ_EHFINALLYRET:
case BBJ_EHFILTERRET:
case BBJ_THROW:
case BBJ_RETURN:
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = curBBdesc->bbJumpSwt->bbsCount;
BasicBlock * * jumpPtr; jumpPtr = curBBdesc->bbJumpSwt->bbsDstTab;
do
{
*jumpPtr = fgLookupBB((unsigned)*(size_t*)jumpPtr);
(*jumpPtr)->bbRefs++;
if ((*jumpPtr)->bbNum <= curBBdesc->bbNum)
{
fgMarkBackwardJump(*jumpPtr, curBBdesc);
}
}
while (++jumpPtr, --jumpCnt);
/* Default case of CEE_SWITCH (next block), is at end of jumpTab[] */
noway_assert(*(jumpPtr-1) == curBBdesc->bbNext);
break;
case BBJ_CALLFINALLY: // BBJ_CALLFINALLY and BBJ_EHCATCHRET don't appear until later
case BBJ_EHCATCHRET:
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
}
}
/*****************************************************************************
*
* Walk the instrs to create the basic blocks.
*/
void Compiler::fgMakeBasicBlocks(const BYTE * codeAddr,
IL_OFFSET codeSize,
BYTE * jumpTarget)
{
const BYTE * codeBegp = codeAddr;
const BYTE * codeEndp = codeAddr + codeSize;
bool tailCall = false;
unsigned curBBoffs;
BasicBlock * curBBdesc;
/* Clear the beginning offset for the first BB */
curBBoffs = 0;
#ifdef DEBUGGING_SUPPORT
if (opts.compDbgCode && (info.compVarScopesCount > 0))
{
compResetScopeLists();
// Ignore scopes beginning at offset 0
while (compGetNextEnterScope(0)) { /* do nothing */ }
while (compGetNextExitScope(0)) { /* do nothing */ }
}
#endif
BBjumpKinds jmpKind;
do
{
OPCODE opcode;
unsigned sz;
unsigned jmpAddr = DUMMY_INIT(BAD_IL_OFFSET);
unsigned bbFlags = 0;
BBswtDesc * swtDsc = 0;
unsigned nxtBBoffs;
opcode = (OPCODE) getU1LittleEndian(codeAddr);
codeAddr += sizeof(__int8);
jmpKind = BBJ_NONE;
DECODE_OPCODE:
/* Get the size of additional parameters */
noway_assert(opcode < CEE_COUNT);
sz = opcodeSizes[opcode];
switch (opcode)
{
signed jmpDist;
case CEE_PREFIX1:
if (jumpTarget[codeAddr - codeBegp] != JT_NONE)
BADCODE3("jump target between prefix 0xFE and opcode",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
opcode = (OPCODE) (256+getU1LittleEndian(codeAddr));
codeAddr += sizeof(__int8);
goto DECODE_OPCODE;
/* Check to see if we have a jump/return opcode */
case CEE_BRFALSE:
case CEE_BRFALSE_S:
case CEE_BRTRUE:
case CEE_BRTRUE_S:
case CEE_BEQ:
case CEE_BEQ_S:
case CEE_BGE:
case CEE_BGE_S:
case CEE_BGE_UN:
case CEE_BGE_UN_S:
case CEE_BGT:
case CEE_BGT_S:
case CEE_BGT_UN:
case CEE_BGT_UN_S:
case CEE_BLE:
case CEE_BLE_S:
case CEE_BLE_UN:
case CEE_BLE_UN_S:
case CEE_BLT:
case CEE_BLT_S:
case CEE_BLT_UN:
case CEE_BLT_UN_S:
case CEE_BNE_UN:
case CEE_BNE_UN_S:
jmpKind = BBJ_COND;
goto JMP;
case CEE_LEAVE:
case CEE_LEAVE_S:
// We need to check if we are jumping out of a finally-protected try.
jmpKind = BBJ_LEAVE;
goto JMP;
case CEE_BR:
case CEE_BR_S:
jmpKind = BBJ_ALWAYS;
goto JMP;
JMP:
/* Compute the target address of the jump */
jmpDist = (sz==1) ? getI1LittleEndian(codeAddr)
: getI4LittleEndian(codeAddr);
if (compIsForInlining() && jmpDist == 0 && (opcode == CEE_BR || opcode == CEE_BR_S))
continue; /* NOP */
jmpAddr = (IL_OFFSET)(codeAddr - codeBegp) + sz + jmpDist;
break;
case CEE_SWITCH:
{
unsigned jmpBase;
unsigned jmpCnt; // # of switch cases (excluding defualt)
BasicBlock * * jmpTab;
BasicBlock * * jmpPtr;
/* Allocate the switch descriptor */
swtDsc = new (this, CMK_BasicBlock) BBswtDesc;
/* Read the number of entries in the table */
jmpCnt = getU4LittleEndian(codeAddr); codeAddr += 4;
/* Compute the base offset for the opcode */
jmpBase = (IL_OFFSET)((codeAddr - codeBegp) + jmpCnt*sizeof(DWORD));
/* Allocate the jump table */
jmpPtr = jmpTab = new (this, CMK_BasicBlock) BasicBlock*[jmpCnt+1];
/* Fill in the jump table */
for (unsigned count = jmpCnt; count; count--)
{
jmpDist = getI4LittleEndian(codeAddr);
codeAddr += 4;
//store the offset in the pointer. We change these in fgLinkBasicBlocks().
*jmpPtr++ = (BasicBlock*)(size_t)(jmpBase + jmpDist);
}
/* Append the default label to the target table */
*jmpPtr++ = (BasicBlock*)(size_t)jmpBase;
/* Make sure we found the right number of labels */
noway_assert(jmpPtr == jmpTab + jmpCnt + 1);
/* Compute the size of the switch opcode operands */
sz = sizeof(DWORD) + jmpCnt*sizeof(DWORD);
/* Fill in the remaining fields of the switch descriptor */
swtDsc->bbsCount = jmpCnt + 1;
swtDsc->bbsDstTab = jmpTab;
/* This is definitely a jump */
jmpKind = BBJ_SWITCH;
fgHasSwitch = true;
#ifndef LEGACY_BACKEND
if (opts.compProcedureSplitting)
{
// TODO-CQ: We might need to create a switch table; we won't know for sure until much later. However, switch tables
// don't work with hot/cold splitting, currently. The switch table data needs a relocation such that if the base
// (the first block after the prolog) and target of the switch branch are put in different sections, the difference
// stored in the table is updated. However, our relocation implementation doesn't support three different pointers
// (relocation address, base, and target). So, we need to change our switch table implementation to be more like
// JIT64: put the table in the code section, in the same hot/cold section as the switch jump itself (maybe
// immediately after the switch jump), and make the "base" address be also in that section, probably the
// address after the switch jump.
opts.compProcedureSplitting = false;
JITDUMP("Turning off procedure splitting for this method, as it might need switch tables; implementation limitation.\n");
}
#endif // !LEGACY_BACKEND
}
goto GOT_ENDP;
case CEE_ENDFILTER:
bbFlags |= BBF_DONT_REMOVE;
jmpKind = BBJ_EHFILTERRET;
break;
case CEE_ENDFINALLY:
jmpKind = BBJ_EHFINALLYRET;
break;
case CEE_READONLY:
case CEE_CONSTRAINED:
case CEE_TAILCALL:
case CEE_VOLATILE:
case CEE_UNALIGNED:
// fgFindJumpTargets should have ruled out this possibility
// (i.e. a prefix opcodes as last intruction in a block)
noway_assert(codeAddr < codeEndp);
if (jumpTarget[codeAddr - codeBegp] != JT_NONE)
BADCODE3("jump target between prefix and an opcode",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
break;
case CEE_CALL:
case CEE_CALLVIRT:
case CEE_CALLI:
{
if (compIsForInlining() || // Ignore tail call in the inlinee. Period.
(!tailCall &&
!compTailCallStress()) // A new BB with BBJ_RETURN would have been created
// after a tailcall statement.
// We need to keep this invariant if we want to stress the tailcall.
// That way, the potential (tail)call statement is always the last
// statement in the block.
// Otherwise, we will assert at the following line in fgMorphCall()
// noway_assert(fgMorphStmt->gtNext == NULL);
)
{
// Neither .tailcall prefix, no tailcall stress. So move on.
break;
}
// Make sure the code sequence is legal for the tail call.
// If so, mark this BB as having a BBJ_RETURN.
if (codeAddr >= codeEndp - sz) {
BADCODE3("No code found after the call instruction",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
}
if (tailCall)
{
bool isCallPopAndRet = false;
if (!impIsTailCallILPattern(tailCall, opcode, codeAddr+sz, codeEndp, &isCallPopAndRet))
{
#ifdef _TARGET_AMD64_
BADCODE3("tail call not followed by ret or pop+ret",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
#else
BADCODE3("tail call not followed by ret",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
#endif //_TARGET_AMD64_
}
#ifdef _TARGET_AMD64_
if (isCallPopAndRet)
{
// By breaking here, we let pop and ret opcodes to be
// imported after tail call. If tail prefix is honored,
// stmts corresponding to pop and ret will be removed
// in fgMorphCall().
break;
}
#endif //_TARGET_AMD64_
}
else
{
OPCODE nextOpcode = (OPCODE) getU1LittleEndian(codeAddr + sz);
if (nextOpcode != CEE_RET)
{
noway_assert(compTailCallStress());
// Next OPCODE is not a CEE_RET, bail the attempt to stress the tailcall.
// (I.e. We will not make a new BB after the "call" statement.)
break;
}
}
}
/* For tail call, we just call CORINFO_HELP_TAILCALL, and it jumps to the
target. So we don't need an epilog - just like CORINFO_HELP_THROW.
Make the block BBJ_RETURN, but we will change it to BBJ_THROW
if the tailness of the call is satisfied.
NOTE : The next instruction is guaranteed to be a CEE_RET
and it will create another BasicBlock. But there may be an
jump directly to that CEE_RET. If we want to avoid creating
an unnecessary block, we need to check if the CEE_RETURN is
the target of a jump.
*/
// fall-through
case CEE_JMP:
/* These are equivalent to a return from the current method
But instead of directly returning to the caller we jump and
execute something else in between */
case CEE_RET:
jmpKind = BBJ_RETURN;
break;
case CEE_THROW:
case CEE_RETHROW:
jmpKind = BBJ_THROW;
break;
#ifdef DEBUG
// make certain we did not forget any flow of control instructions
// by checking the 'ctrl' field in opcode.def. First filter out all
// non-ctrl instructions
# define BREAK(name) case name: break;
# define NEXT(name) case name: break;
# define CALL(name)
# define THROW(name)
# undef RETURN // undef contract RETURN macro
# define RETURN(name)
# define META(name)
# define BRANCH(name)
# define COND_BRANCH(name)
# define PHI(name)
# define OPDEF(name,string,pop,push,oprType,opcType,l,s1,s2,ctrl) ctrl(name)
# include "opcode.def"
# undef OPDEF
# undef PHI
# undef BREAK
# undef CALL
# undef NEXT
# undef THROW
# undef RETURN
# undef META
# undef BRANCH
# undef COND_BRANCH
// These ctrl-flow opcodes don't need any special handling
case CEE_NEWOBJ: // CTRL_CALL
break;
// what's left are forgotten instructions
default:
BADCODE("Unrecognized control Opcode");
break;
#else // !DEBUG
default:
break;
#endif // !DEBUG
}
/* Jump over the operand */
codeAddr += sz;
GOT_ENDP:
tailCall = (opcode == CEE_TAILCALL);
/* Make sure a jump target isn't in the middle of our opcode */
if (sz)
{
IL_OFFSET offs = (IL_OFFSET)(codeAddr - codeBegp) - sz; // offset of the operand
for (unsigned i=0; i<sz; i++, offs++)
{
if (jumpTarget[offs] != JT_NONE)
BADCODE3("jump into the middle of an opcode",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
}
}
/* Compute the offset of the next opcode */
nxtBBoffs = (IL_OFFSET)(codeAddr - codeBegp);
#ifdef DEBUGGING_SUPPORT
bool foundScope = false;
if (opts.compDbgCode && (info.compVarScopesCount > 0))
{
while (compGetNextEnterScope(nxtBBoffs)) foundScope = true;
while (compGetNextExitScope(nxtBBoffs)) foundScope = true;
}
#endif
/* Do we have a jump? */
if (jmpKind == BBJ_NONE)
{
/* No jump; make sure we don't fall off the end of the function */
if (codeAddr == codeEndp)
BADCODE3("missing return opcode",
" at offset %04X", (IL_OFFSET)(codeAddr - codeBegp));
/* If a label follows this opcode, we'll have to make a new BB */
bool makeBlock = (jumpTarget[nxtBBoffs] != JT_NONE);
#ifdef DEBUGGING_SUPPORT
if (!makeBlock && foundScope)
{
makeBlock = true;
#ifdef DEBUG
if (verbose)
printf("Splitting at BBoffs = %04u\n", nxtBBoffs);
#endif // DEBUG
}
#endif // DEBUGGING_SUPPORT
if (!makeBlock)
continue;
}
/* We need to create a new basic block */
curBBdesc = fgNewBasicBlock(jmpKind);
curBBdesc->bbFlags |= bbFlags;
curBBdesc->bbRefs = 0;
curBBdesc->bbCodeOffs = curBBoffs;
curBBdesc->bbCodeOffsEnd = nxtBBoffs;
unsigned profileWeight;
if (fgGetProfileWeightForBasicBlock(curBBoffs, &profileWeight))
{
curBBdesc->setBBProfileWeight(profileWeight);
if (profileWeight == 0)
{
curBBdesc->bbSetRunRarely();
}
else
{
// Note that bbNewBasicBlock (called from fgNewBasicBlock) may have
// already marked the block as rarely run. In that case (and when we know
// that the block profile weight is non-zero) we want to unmark that.
curBBdesc->bbFlags &= ~BBF_RUN_RARELY;
}
}
switch (jmpKind)
{
case BBJ_SWITCH:
curBBdesc->bbJumpSwt = swtDsc;
break;
case BBJ_COND:
case BBJ_ALWAYS:
case BBJ_LEAVE:
noway_assert(jmpAddr != DUMMY_INIT(BAD_IL_OFFSET));
curBBdesc->bbJumpOffs = jmpAddr;
break;
#ifdef FEATURE_LEGACYNETCF
case BBJ_EHFILTERRET:
if (opts.eeFlags & CORJIT_FLG_NETCF_QUIRKS)
{
// NetCF incorrectly allowed sequence of endfilter instructions at the end of the filter. Ignore the redundant endfilter instructions.
while (codeAddr + 1 < codeEndp && getU1LittleEndian(codeAddr) == CEE_PREFIX1 && getU1LittleEndian(codeAddr+1) == (CEE_ENDFILTER & 0xFF))
codeAddr += 2;
nxtBBoffs = (IL_OFFSET)(codeAddr - codeBegp);
}
break;
#endif
default:
break;
}
DBEXEC(verbose, curBBdesc->dspBlockHeader(this, false, false, false));
/* Remember where the next BB will start */
curBBoffs = nxtBBoffs;
}
while (codeAddr < codeEndp);
noway_assert(codeAddr == codeEndp);
/* Finally link up the bbJumpDest of the blocks together */
fgLinkBasicBlocks();
}
/*****************************************************************************
*
* Main entry point to discover the basic blocks for the current function.
*/
void Compiler::fgFindBasicBlocks()
{
#ifdef DEBUG
if (verbose)
printf("*************** In fgFindBasicBlocks() for %s\n",
info.compFullName);
#endif
/* Allocate the 'jump target' vector
*
* We need one extra byte as we mark
* jumpTarget[info.compILCodeSize] with JT_ADDR
* when we need to add a dummy block
* to record the end of a try or handler region.
*/
BYTE* jumpTarget = new (this, CMK_Unknown) BYTE[info.compILCodeSize+1];
memset(jumpTarget, JT_NONE, info.compILCodeSize+1);
noway_assert(JT_NONE == 0);
/* Walk the instrs to find all jump targets */
fgFindJumpTargets(info.compCode, info.compILCodeSize, jumpTarget);
if (compDonotInline())
return;
unsigned XTnum;
/* Are there any exception handlers? */
if (info.compXcptnsCount > 0)
{
noway_assert(!compIsForInlining());
/* Check and mark all the exception handlers */
for (XTnum = 0; XTnum < info.compXcptnsCount; XTnum++)
{
DWORD tmpOffset;
CORINFO_EH_CLAUSE clause;
info.compCompHnd->getEHinfo(info.compMethodHnd, XTnum, &clause);
noway_assert(clause.HandlerLength !=(unsigned) -1);
if (clause.TryLength <= 0)
BADCODE("try block length <=0");
/* Mark the 'try' block extent and the handler itself */
if (clause.TryOffset > info.compILCodeSize)
BADCODE("try offset is > codesize");
if (jumpTarget[clause.TryOffset ] == JT_NONE)
jumpTarget[clause.TryOffset ] = JT_ADDR;
tmpOffset = clause.TryOffset + clause.TryLength;
if (tmpOffset > info.compILCodeSize)
BADCODE("try end is > codesize");
if (jumpTarget[tmpOffset ] == JT_NONE)
jumpTarget[tmpOffset ] = JT_ADDR;
if (clause.HandlerOffset > info.compILCodeSize)
BADCODE("handler offset > codesize");
if (jumpTarget[clause.HandlerOffset ] == JT_NONE)
jumpTarget[clause.HandlerOffset ] = JT_ADDR;
tmpOffset = clause.HandlerOffset + clause.HandlerLength;
if (tmpOffset > info.compILCodeSize)
BADCODE("handler end > codesize");
if (jumpTarget[tmpOffset ] == JT_NONE)
jumpTarget[tmpOffset ] = JT_ADDR;
if (clause.Flags & CORINFO_EH_CLAUSE_FILTER)
{
if (clause.FilterOffset > info.compILCodeSize)
BADCODE("filter offset > codesize");
if (jumpTarget[clause.FilterOffset ] == JT_NONE)
jumpTarget[clause.FilterOffset ] = JT_ADDR;
}
}
}
#ifdef DEBUG
if (verbose)
{
bool anyJumpTargets = false;
printf("Jump targets:\n");
for (unsigned i = 0; i < info.compILCodeSize + 1; i++)
{
if (jumpTarget[i] == JT_NONE)
continue;
anyJumpTargets = true;
printf(" IL_%04x", i);
if (jumpTarget[i] & JT_ADDR)
{
printf(" addr");
}
if (jumpTarget[i] & JT_MULTI)
{
printf(" multi");
}
printf("\n");
}
if (!anyJumpTargets)
{
printf(" none\n");
}
}
#endif // DEBUG
/* Now create the basic blocks */
fgMakeBasicBlocks(info.compCode, info.compILCodeSize, jumpTarget);
if (compIsForInlining())
{
noway_assert(info.compXcptnsCount == 0);
compHndBBtab = impInlineInfo->InlinerCompiler->compHndBBtab;
compHndBBtabAllocCount = impInlineInfo->InlinerCompiler->compHndBBtabAllocCount; // we probably only use the table, not add to it.
compHndBBtabCount = impInlineInfo->InlinerCompiler->compHndBBtabCount;
info.compXcptnsCount = impInlineInfo->InlinerCompiler->info.compXcptnsCount;
if (info.compRetNativeType != TYP_VOID &&
fgMoreThanOneReturnBlock())
{
// The lifetime of this var might expand multiple BBs. So it is a long lifetime compiler temp.
lvaInlineeReturnSpillTemp = lvaGrabTemp(false DEBUGARG("Inline candidate multiple BBJ_RETURN spill temp"));
lvaTable[lvaInlineeReturnSpillTemp].lvType = info.compRetNativeType;
}
return;
}
/* Mark all blocks within 'try' blocks as such */
if (info.compXcptnsCount == 0)
return;
if (info.compXcptnsCount > MAX_XCPTN_INDEX)
IMPL_LIMITATION("too many exception clauses");
/* Allocate the exception handler table */
fgAllocEHTable();
/* Assume we don't need to sort the EH table (such that nested try/catch
* appear before their try or handler parent). The EH verifier will notice
* when we do need to sort it.
*/
fgNeedToSortEHTable = false;
verInitEHTree(info.compXcptnsCount);
EHNodeDsc* initRoot = ehnNext; // remember the original root since
// it may get modified during insertion
// Annotate BBs with exception handling information required for generating correct eh code
// as well as checking for correct IL
EHblkDsc * HBtab;
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
CORINFO_EH_CLAUSE clause;
info.compCompHnd->getEHinfo(info.compMethodHnd, XTnum, &clause);
noway_assert(clause.HandlerLength != (unsigned)-1); // @DEPRECATED
#ifdef DEBUG
if (verbose)
{
dispIncomingEHClause(XTnum, clause);
}
#endif // DEBUG
IL_OFFSET tryBegOff = clause.TryOffset;
IL_OFFSET tryEndOff = tryBegOff + clause.TryLength;
IL_OFFSET filterBegOff = 0;
IL_OFFSET hndBegOff = clause.HandlerOffset;
IL_OFFSET hndEndOff = hndBegOff + clause.HandlerLength;
if (clause.Flags & CORINFO_EH_CLAUSE_FILTER)
{
filterBegOff = clause.FilterOffset;
}
if (tryEndOff > info.compILCodeSize)
BADCODE3("end of try block beyond end of method for try",
" at offset %04X",tryBegOff);
if (hndEndOff > info.compILCodeSize)
BADCODE3("end of hnd block beyond end of method for try",
" at offset %04X",tryBegOff);
HBtab->ebdTryBegOffset = tryBegOff;
HBtab->ebdTryEndOffset = tryEndOff;
HBtab->ebdFilterBegOffset = filterBegOff;
HBtab->ebdHndBegOffset = hndBegOff;
HBtab->ebdHndEndOffset = hndEndOff;
/* Convert the various addresses to basic blocks */
BasicBlock * tryBegBB = fgLookupBB(tryBegOff);
BasicBlock * tryEndBB = fgLookupBB(tryEndOff); // note: this can be NULL if the try region is at the end of the function
BasicBlock * hndBegBB = fgLookupBB(hndBegOff);
BasicBlock * hndEndBB = NULL;
BasicBlock * filtBB = NULL;
BasicBlock * block;
//
// Assert that the try/hnd beginning blocks are set up correctly
//
if (tryBegBB == NULL)
{
BADCODE("Try Clause is invalid");
}
if (hndBegBB == NULL)
{
BADCODE("Handler Clause is invalid");
}
tryBegBB->bbFlags |= BBF_HAS_LABEL;
hndBegBB->bbFlags |= BBF_HAS_LABEL | BBF_JMP_TARGET;
#if HANDLER_ENTRY_MUST_BE_IN_HOT_SECTION
// This will change the block weight from 0 to 1
// and clear the rarely run flag
hndBegBB->makeBlockHot();
#else
hndBegBB->bbSetRunRarely(); // handler entry points are rarely executed
#endif
if (hndEndOff < info.compILCodeSize)
{
hndEndBB = fgLookupBB(hndEndOff);
}
if (clause.Flags & CORINFO_EH_CLAUSE_FILTER)
{
filtBB = HBtab->ebdFilter = fgLookupBB(clause.FilterOffset);
filtBB->bbCatchTyp = BBCT_FILTER;
filtBB->bbFlags |= BBF_HAS_LABEL | BBF_JMP_TARGET;
hndBegBB->bbCatchTyp = BBCT_FILTER_HANDLER;
#if HANDLER_ENTRY_MUST_BE_IN_HOT_SECTION
// This will change the block weight from 0 to 1
// and clear the rarely run flag
filtBB->makeBlockHot();
#else
filtBB->bbSetRunRarely(); // filter entry points are rarely executed
#endif
// Mark all BBs that belong to the filter with the XTnum of the corresponding handler
for (block = filtBB; /**/; block = block->bbNext)
{
if (block == NULL)
{
BADCODE3("Missing endfilter for filter",
" at offset %04X", filtBB->bbCodeOffs);
return;
}
// Still inside the filter
block->setHndIndex(XTnum);
if (block->bbJumpKind == BBJ_EHFILTERRET)
{
// Mark catch handler as successor.
block->bbJumpDest = hndBegBB;
assert(block->bbJumpDest->bbCatchTyp == BBCT_FILTER_HANDLER);
break;
}
}
if (!block->bbNext || block->bbNext != hndBegBB)
BADCODE3("Filter does not immediately precede handler for filter",
" at offset %04X", filtBB->bbCodeOffs);
}
else
{
HBtab->ebdTyp = clause.ClassToken;
/* Set bbCatchTyp as appropriate */
if (clause.Flags & CORINFO_EH_CLAUSE_FINALLY)
{
hndBegBB->bbCatchTyp = BBCT_FINALLY;
}
else
{
if (clause.Flags & CORINFO_EH_CLAUSE_FAULT)
{
hndBegBB->bbCatchTyp = BBCT_FAULT;
}
else
{
hndBegBB->bbCatchTyp = clause.ClassToken;
// These values should be non-zero value that will
// not collide with real tokens for bbCatchTyp
if (clause.ClassToken == 0)
BADCODE("Exception catch type is Null");
noway_assert(clause.ClassToken != BBCT_FAULT);
noway_assert(clause.ClassToken != BBCT_FINALLY);
noway_assert(clause.ClassToken != BBCT_FILTER);
noway_assert(clause.ClassToken != BBCT_FILTER_HANDLER);
}
}
}
/* Mark the initial block and last blocks in the 'try' region */
tryBegBB->bbFlags |= BBF_TRY_BEG | BBF_HAS_LABEL;
/* Prevent future optimizations of removing the first block */
/* of a TRY block and the first block of an exception handler */
tryBegBB->bbFlags |= BBF_DONT_REMOVE;
hndBegBB->bbFlags |= BBF_DONT_REMOVE;
hndBegBB->bbRefs++; // The first block of a handler gets an extra, "artificial" reference count.
if (clause.Flags & CORINFO_EH_CLAUSE_FILTER)
{
filtBB->bbFlags |= BBF_DONT_REMOVE;
filtBB->bbRefs++; // The first block of a filter gets an extra, "artificial" reference count.
}
tryBegBB->bbFlags |= BBF_DONT_REMOVE;
hndBegBB->bbFlags |= BBF_DONT_REMOVE;
//
// Store the info to the table of EH block handlers
//
HBtab->ebdHandlerType = ToEHHandlerType(clause.Flags);
HBtab->ebdTryBeg = tryBegBB;
HBtab->ebdTryLast = (tryEndBB == nullptr) ? fgLastBB : tryEndBB->bbPrev;
HBtab->ebdHndBeg = hndBegBB;
HBtab->ebdHndLast = (hndEndBB == nullptr) ? fgLastBB : hndEndBB->bbPrev;
//
// Assert that all of our try/hnd blocks are setup correctly.
//
if (HBtab->ebdTryLast == nullptr)
{
BADCODE("Try Clause is invalid");
}
if (HBtab->ebdHndLast == nullptr)
{
BADCODE("Handler Clause is invalid");
}
//
// Verify that it's legal
//
verInsertEhNode(&clause, HBtab);
} // end foreach handler table entry
fgSortEHTable();
// Next, set things related to nesting that depend on the sorting being complete.
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
/* Mark all blocks in the finally/fault or catch clause */
BasicBlock * tryBegBB = HBtab->ebdTryBeg;
BasicBlock * hndBegBB = HBtab->ebdHndBeg;
IL_OFFSET tryBegOff = HBtab->ebdTryBegOffset;
IL_OFFSET tryEndOff = HBtab->ebdTryEndOffset;
IL_OFFSET hndBegOff = HBtab->ebdHndBegOffset;
IL_OFFSET hndEndOff = HBtab->ebdHndEndOffset;
BasicBlock * block;
for (block = hndBegBB;
block && (block->bbCodeOffs < hndEndOff);
block = block->bbNext)
{
if (!block->hasHndIndex())
block->setHndIndex(XTnum);
// All blocks in a catch handler or filter are rarely run, except the entry
if ((block != hndBegBB) && (hndBegBB->bbCatchTyp != BBCT_FINALLY))
block->bbSetRunRarely();
}
/* Mark all blocks within the covered range of the try */
for (block = tryBegBB;
block && (block->bbCodeOffs < tryEndOff);
block = block->bbNext)
{
/* Mark this BB as belonging to a 'try' block */
if (!block->hasTryIndex())
block->setTryIndex(XTnum);
#ifdef DEBUG
/* Note: the BB can't span the 'try' block */
if (!(block->bbFlags & BBF_INTERNAL))
{
noway_assert(tryBegOff <= block->bbCodeOffs);
noway_assert(tryEndOff >= block->bbCodeOffsEnd ||
tryEndOff == tryBegOff );
}
#endif
}
/* Init ebdHandlerNestingLevel of current clause, and bump up value for all
* enclosed clauses (which have to be before it in the table).
* Innermost try-finally blocks must precede outermost
* try-finally blocks.
*/
#if !FEATURE_EH_FUNCLETS
HBtab->ebdHandlerNestingLevel = 0;
#endif // !FEATURE_EH_FUNCLETS
HBtab->ebdEnclosingTryIndex = EHblkDsc::NO_ENCLOSING_INDEX;
HBtab->ebdEnclosingHndIndex = EHblkDsc::NO_ENCLOSING_INDEX;
noway_assert(XTnum < compHndBBtabCount);
noway_assert(XTnum == ehGetIndex(HBtab));
for (EHblkDsc * xtab = compHndBBtab; xtab < HBtab; xtab++)
{
#if !FEATURE_EH_FUNCLETS
if (jitIsBetween(xtab->ebdHndBegOffs(), hndBegOff, hndEndOff))
{
xtab->ebdHandlerNestingLevel++;
}
#endif // !FEATURE_EH_FUNCLETS
/* If we haven't recorded an enclosing try index for xtab then see
* if this EH region should be recorded. We check if the
* first offset in the xtab lies within our region. If so,
* the last offset also must lie within the region, due to
* nesting rules. verInsertEhNode(), below, will check for proper nesting.
*/
if (xtab->ebdEnclosingTryIndex == EHblkDsc::NO_ENCLOSING_INDEX)
{
bool begBetween = jitIsBetween(xtab->ebdTryBegOffs(), tryBegOff, tryEndOff);
if (begBetween)
{
// Record the enclosing scope link
xtab->ebdEnclosingTryIndex = (unsigned short)XTnum;
}
}
/* Do the same for the enclosing handler index.
*/
if (xtab->ebdEnclosingHndIndex == EHblkDsc::NO_ENCLOSING_INDEX)
{
bool begBetween = jitIsBetween(xtab->ebdTryBegOffs(), hndBegOff, hndEndOff);
if (begBetween)
{
// Record the enclosing scope link
xtab->ebdEnclosingHndIndex = (unsigned short)XTnum;
}
}
}
} // end foreach handler table entry
#if !FEATURE_EH_FUNCLETS
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
if (ehMaxHndNestingCount <= HBtab->ebdHandlerNestingLevel)
ehMaxHndNestingCount = HBtab->ebdHandlerNestingLevel + 1;
}
#endif // !FEATURE_EH_FUNCLETS
#ifndef DEBUG
if (tiVerificationNeeded)
#endif
{
// always run these checks for a debug build
verCheckNestingLevel(initRoot);
}
// fgNormalizeEH assumes that this test has been passed. And Ssa assumes that fgNormalizeEHTable
// has been run. So do this unless we're in minOpts mode (and always in debug).
#ifndef DEBUG
if (tiVerificationNeeded || !opts.MinOpts())
#endif
{
fgCheckBasicBlockControlFlow();
}
#ifdef DEBUG
if (verbose)
{
JITDUMP("*************** After fgFindBasicBlocks() has created the EH table\n");
fgDispHandlerTab();
}
// We can't verify the handler table until all the IL legality checks have been done (above), since bad IL
// (such as illegal nesting of regions) will trigger asserts here.
fgVerifyHandlerTab();
#endif
fgNormalizeEH();
}
/*****************************************************************************
* Check control flow constraints for well formed IL. Bail if any of the constraints
* are violated.
*/
void Compiler::fgCheckBasicBlockControlFlow()
{
assert(!fgNormalizeEHDone); // These rules aren't quite correct after EH normalization has introduced new blocks
EHblkDsc *HBtab;
for (BasicBlock* blk = fgFirstBB; blk; blk = blk->bbNext)
{
if (blk->bbFlags & BBF_INTERNAL)
continue;
switch (blk->bbJumpKind)
{
case BBJ_NONE: // block flows into the next one (no jump)
fgControlFlowPermitted(blk,blk->bbNext);
break;
case BBJ_ALWAYS: // block does unconditional jump to target
fgControlFlowPermitted(blk,blk->bbJumpDest);
break;
case BBJ_COND: // block conditionally jumps to the target
fgControlFlowPermitted(blk,blk->bbNext);
fgControlFlowPermitted(blk,blk->bbJumpDest);
break;
case BBJ_RETURN: // block ends with 'ret'
if (blk->hasTryIndex() || blk->hasHndIndex())
{
BADCODE3("Return from a protected block",
". Before offset %04X", blk->bbCodeOffsEnd);
}
break;
case BBJ_EHFINALLYRET:
case BBJ_EHFILTERRET:
if (!blk->hasHndIndex()) // must be part of a handler
{
BADCODE3("Missing handler",
". Before offset %04X", blk->bbCodeOffsEnd);
}
HBtab = ehGetDsc(blk->getHndIndex());
// Endfilter allowed only in a filter block
if (blk->bbJumpKind == BBJ_EHFILTERRET)
{
if (!HBtab->HasFilter())
{
BADCODE("Unexpected endfilter");
}
}
// endfinally allowed only in a finally/fault block
else if (!HBtab->HasFinallyOrFaultHandler())
{
BADCODE("Unexpected endfinally");
}
// The handler block should be the innermost block
// Exception blocks are listed, innermost first.
if (blk->hasTryIndex() && (blk->getTryIndex() < blk->getHndIndex()))
{
BADCODE("endfinally / endfilter in nested try block");
}
break;
case BBJ_THROW: // block ends with 'throw'
/* throw is permitted from every BB, so nothing to check */
/* importer makes sure that rethrow is done from a catch */
break;
case BBJ_LEAVE: // block always jumps to the target, maybe out of guarded
// region. Used temporarily until importing
fgControlFlowPermitted(blk, blk->bbJumpDest,TRUE);
break;
case BBJ_SWITCH: // block ends with a switch statement
BBswtDesc* swtDesc;
swtDesc = blk->bbJumpSwt;
assert (swtDesc);
unsigned i;
for (i=0; i<swtDesc->bbsCount; i++)
{
fgControlFlowPermitted(blk,swtDesc->bbsDstTab[i]);
}
break;
case BBJ_EHCATCHRET: // block ends with a leave out of a catch (only #if FEATURE_EH_FUNCLETS)
case BBJ_CALLFINALLY: // block always calls the target finally
default:
noway_assert(!"Unexpected bbJumpKind"); // these blocks don't get created until importing
break;
}
}
}
/****************************************************************************
* Check that the leave from the block is legal.
* Consider removing this check here if we can do it cheaply during importing
*/
void Compiler::fgControlFlowPermitted(BasicBlock* blkSrc,
BasicBlock* blkDest,
BOOL isLeave)
{
assert(!fgNormalizeEHDone); // These rules aren't quite correct after EH normalization has introduced new blocks
unsigned srcHndBeg, destHndBeg;
unsigned srcHndEnd, destHndEnd;
bool srcInFilter, destInFilter;
bool srcInCatch = false;
EHblkDsc* srcHndTab;
srcHndTab = ehInitHndRange(blkSrc, &srcHndBeg, &srcHndEnd, &srcInFilter);
ehInitHndRange(blkDest, &destHndBeg, &destHndEnd, &destInFilter);
/* Impose the rules for leaving or jumping from handler blocks */
if (blkSrc->hasHndIndex())
{
srcInCatch = srcHndTab->HasCatchHandler() && srcHndTab->InHndRegionILRange(blkSrc);
/* Are we jumping within the same handler index? */
if (BasicBlock::sameHndRegion(blkSrc, blkDest))
{
/* Do we have a filter clause? */
if (srcHndTab->HasFilter())
{
/* filters and catch handlers share same eh index */
/* we need to check for control flow between them. */
if (srcInFilter != destInFilter)
{
if (!jitIsBetween(blkDest->bbCodeOffs, srcHndBeg, srcHndEnd))
BADCODE3("Illegal control flow between filter and handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
}
else
{
/* The handler indexes of blkSrc and blkDest are different */
if (isLeave)
{
/* Any leave instructions must not enter the dest handler from outside*/
if (!jitIsBetween(srcHndBeg, destHndBeg, destHndEnd))
BADCODE3("Illegal use of leave to enter handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
else
{
/* We must use a leave to exit a handler */
BADCODE3("Illegal control flow out of a handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
/* Do we have a filter clause? */
if (srcHndTab->HasFilter())
{
/* It is ok to leave from the handler block of a filter, */
/* but not from the filter block of a filter */
if (srcInFilter != destInFilter)
{
BADCODE3("Illegal to leave a filter handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
/* We should never leave a finally handler */
if (srcHndTab->HasFinallyHandler())
{
BADCODE3("Illegal to leave a finally handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
/* We should never leave a fault handler */
if (srcHndTab->HasFaultHandler())
{
BADCODE3("Illegal to leave a fault handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
}
else if (blkDest->hasHndIndex())
{
/* blkSrc was not inside a handler, but blkDst is inside a handler */
BADCODE3("Illegal control flow into a handler",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
/* Are we jumping from a catch handler into the corresponding try? */
/* VB uses this for "on error goto " */
if (isLeave && srcInCatch)
{
// inspect all handlers containing the jump source
bool bValidJumpToTry = false; // are we jumping in a valid way from a catch to the corresponding try?
bool bCatchHandlerOnly = true; // false if we are jumping out of a non-catch handler
EHblkDsc* ehTableEnd;
EHblkDsc* ehDsc;
for (ehDsc = compHndBBtab, ehTableEnd = compHndBBtab + compHndBBtabCount; bCatchHandlerOnly && ehDsc < ehTableEnd; ehDsc++)
{
if (ehDsc->InHndRegionILRange(blkSrc))
{
if (ehDsc->HasCatchHandler())
{
if (ehDsc->InTryRegionILRange(blkDest))
{
// If we already considered the jump for a different try/catch,
// we would have two overlapping try regions with two overlapping catch
// regions, which is illegal.
noway_assert(!bValidJumpToTry);
// Allowed if it is the first instruction of an inner try
// (and all trys in between)
//
// try {
// ..
// _tryAgain:
// ..
// try {
// _tryNestedInner:
// ..
// try {
// _tryNestedIllegal:
// ..
// } catch {
// ..
// }
// ..
// } catch {
// ..
// }
// ..
// } catch {
// ..
// leave _tryAgain // Allowed
// ..
// leave _tryNestedInner // Allowed
// ..
// leave _tryNestedIllegal // Not Allowed
// ..
// }
//
// Note: The leave is allowed also from catches nested inside the catch shown above.
/* The common case where leave is to the corresponding try */
if (ehDsc->ebdIsSameTry(this, blkDest->getTryIndex()) ||
/* Also allowed is a leave to the start of a try which starts in the handler's try */
fgFlowToFirstBlockOfInnerTry(ehDsc->ebdTryBeg, blkDest, false))
{
bValidJumpToTry = true;
}
}
}
else
{
// We are jumping from a handler which is not a catch handler.
// If it's a handler, but not a catch handler, it must be either a finally or fault
if (!ehDsc->HasFinallyOrFaultHandler())
{
BADCODE3("Handlers must be catch, finally, or fault",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
// Are we jumping out of this handler?
if (!ehDsc->InHndRegionILRange(blkDest))
bCatchHandlerOnly = false;
}
}
else if (ehDsc->InFilterRegionILRange(blkSrc))
{
// Are we jumping out of a filter?
if (!ehDsc->InFilterRegionILRange(blkDest))
bCatchHandlerOnly = false;
}
}
if (bCatchHandlerOnly)
{
if (bValidJumpToTry)
return;
else
{
// FALL THROUGH
// This is either the case of a leave to outside the try/catch,
// or a leave to a try not nested in this try/catch.
// The first case is allowed, the second one will be checked
// later when we check the try block rules (it is illegal if we
// jump to the middle of the destination try).
}
}
else
{
BADCODE3("illegal leave to exit a finally, fault or filter",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
/* Check all the try block rules */
IL_OFFSET srcTryBeg;
IL_OFFSET srcTryEnd;
IL_OFFSET destTryBeg;
IL_OFFSET destTryEnd;
ehInitTryRange(blkSrc, &srcTryBeg, &srcTryEnd);
ehInitTryRange(blkDest, &destTryBeg, &destTryEnd);
/* Are we jumping between try indexes? */
if (!BasicBlock::sameTryRegion(blkSrc, blkDest))
{
// Are we exiting from an inner to outer try?
if (jitIsBetween(srcTryBeg, destTryBeg, destTryEnd) &&
jitIsBetween(srcTryEnd-1, destTryBeg, destTryEnd) )
{
if (!isLeave)
{
BADCODE3("exit from try block without a leave",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
else if (jitIsBetween(destTryBeg, srcTryBeg, srcTryEnd))
{
// check that the dest Try is first instruction of an inner try
if (!fgFlowToFirstBlockOfInnerTry(blkSrc, blkDest, false))
{
BADCODE3("control flow into middle of try",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
else // there is no nesting relationship between src and dest
{
if (isLeave)
{
// check that the dest Try is first instruction of an inner try sibling
if (!fgFlowToFirstBlockOfInnerTry(blkSrc, blkDest, true))
{
BADCODE3("illegal leave into middle of try",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
else
{
BADCODE3("illegal control flow in to/out of try block",
". Before offset %04X", blkSrc->bbCodeOffsEnd);
}
}
}
}
/*****************************************************************************
* Check that blkDest is the first block of an inner try or a sibling
* with no intervening trys in between
*/
bool Compiler::fgFlowToFirstBlockOfInnerTry(BasicBlock* blkSrc,
BasicBlock* blkDest,
bool sibling)
{
assert(!fgNormalizeEHDone); // These rules aren't quite correct after EH normalization has introduced new blocks
noway_assert(blkDest->hasTryIndex());
unsigned XTnum = blkDest->getTryIndex();
unsigned lastXTnum = blkSrc->hasTryIndex() ? blkSrc->getTryIndex()
: compHndBBtabCount;
noway_assert(XTnum < compHndBBtabCount);
noway_assert(lastXTnum <= compHndBBtabCount);
EHblkDsc* HBtab = ehGetDsc(XTnum);
// check that we are not jumping into middle of try
if (HBtab->ebdTryBeg != blkDest)
{
return false;
}
if (sibling)
{
noway_assert(!BasicBlock::sameTryRegion(blkSrc, blkDest));
// find the l.u.b of the two try ranges
// Set lastXTnum to the l.u.b.
HBtab = ehGetDsc(lastXTnum);
for (lastXTnum++, HBtab++;
lastXTnum < compHndBBtabCount;
lastXTnum++, HBtab++)
{
if (jitIsBetweenInclusive(blkDest->bbNum,
HBtab->ebdTryBeg->bbNum,
HBtab->ebdTryLast->bbNum))
{
break;
}
}
}
// now check there are no intervening trys between dest and l.u.b
// (it is ok to have intervening trys as long as they all start at
// the same code offset)
HBtab = ehGetDsc(XTnum);
for (XTnum++, HBtab++;
XTnum < lastXTnum;
XTnum++, HBtab++)
{
if (HBtab->ebdTryBeg->bbNum < blkDest->bbNum && blkDest->bbNum <= HBtab->ebdTryLast->bbNum)
{
return false;
}
}
return true;
}
/*****************************************************************************
* Returns the handler nesting level of the block.
* *pFinallyNesting is set to the nesting level of the inner-most
* finally-protected try the block is in.
*/
unsigned Compiler::fgGetNestingLevel(BasicBlock * block,
unsigned * pFinallyNesting)
{
unsigned curNesting = 0; // How many handlers is the block in
unsigned tryFin = (unsigned)-1; // curNesting when we see innermost finally-protected try
unsigned XTnum;
EHblkDsc * HBtab;
/* We find the block's handler nesting level by walking over the
complete exception table and find enclosing clauses. */
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++, HBtab++)
{
noway_assert(HBtab->ebdTryBeg && HBtab->ebdHndBeg);
if (HBtab->HasFinallyHandler() &&
(tryFin == (unsigned)-1) &&
bbInTryRegions(XTnum, block))
{
tryFin = curNesting;
}
else if (bbInHandlerRegions(XTnum, block))
{
curNesting++;
}
}
if (tryFin == (unsigned)-1)
tryFin = curNesting;
if (pFinallyNesting)
*pFinallyNesting = curNesting - tryFin;
return curNesting;
}
/*****************************************************************************
*
* Import the basic blocks of the procedure.
*/
void Compiler::fgImport()
{
fgHasPostfix = false;
impImport(fgFirstBB);
if (!(opts.eeFlags & CORJIT_FLG_SKIP_VERIFICATION))
{
CorInfoMethodRuntimeFlags verFlag;
verFlag = tiIsVerifiableCode ? CORINFO_FLG_VERIFIABLE
: CORINFO_FLG_UNVERIFIABLE;
info.compCompHnd->setMethodAttribs(info.compMethodHnd, verFlag);
}
}
/*****************************************************************************
* This function returns true if tree is a node with a call
* that unconditionally throws an exception
*/
bool Compiler::fgIsThrow(GenTreePtr tree)
{
if ((tree->gtOper != GT_CALL ) ||
(tree->gtCall.gtCallType != CT_HELPER) )
{
return false;
}
// TODO-Throughput: Replace all these calls to eeFindHelper() with a table based lookup
if ((tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_OVERFLOW) ) ||
(tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_VERIFICATION)) ||
(tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_RNGCHKFAIL) ) ||
(tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_THROWDIVZERO)) ||
#ifndef RYUJIT_CTPBUILD
(tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_THROWNULLREF)) ||
#endif
(tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_THROW) ) ||
(tree->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_RETHROW) ) )
{
noway_assert(tree->gtFlags & GTF_CALL);
noway_assert(tree->gtFlags & GTF_EXCEPT);
return true;
}
// TODO-CQ: there are a bunch of managed methods in [mscorlib]System.ThrowHelper
// that would be nice to recognize.
return false;
}
/*****************************************************************************
* This function returns true for blocks that are in different hot-cold regions.
* It returns false when the blocks are both in the same regions
*/
bool Compiler::fgInDifferentRegions(BasicBlock *blk1, BasicBlock *blk2)
{
noway_assert(blk1 != NULL);
noway_assert(blk2 != NULL);
if (fgFirstColdBlock == NULL)
{
return false;
}
// If one block is Hot and the other is Cold then we are in different regions
return ((blk1->bbFlags & BBF_COLD)!= (blk2->bbFlags & BBF_COLD));
}
/*****************************************************************************
* This function returns true if tree is a GT_COMMA node with a call
* that unconditionally throws an exception
*/
bool Compiler::fgIsCommaThrow(GenTreePtr tree,
bool forFolding /* = false */)
{
// Instead of always folding comma throws,
// with stress enabled we only fold half the time
if (forFolding && compStressCompile(STRESS_FOLD, 50))
{
return false; /* Don't fold */
}
/* Check for cast of a GT_COMMA with a throw overflow */
if ((tree->gtOper == GT_COMMA) &&
(tree->gtFlags & GTF_CALL) &&
(tree->gtFlags & GTF_EXCEPT))
{
return (fgIsThrow(tree->gtOp.gtOp1));
}
return false;
}
GenTreePtr Compiler::fgIsIndirOfAddrOfLocal(GenTreePtr tree)
{
GenTreePtr res = nullptr;
if (tree->OperGet() == GT_LDOBJ || tree->OperIsIndir())
{
GenTreePtr addr = tree->gtOp.gtOp1;
// Post rationalization, we can have Indir(Lea(..) trees. Therefore to recognize
// Indir of addr of a local, skip over Lea in Indir(Lea(base, index, scale, offset))
// to get to base variable.
if (addr->OperGet() == GT_LEA)
{
// We use this method in backward dataflow after liveness computation - fgInterBlockLocalVarLiveness().
// Therefore it is critical that we don't miss 'uses' of any local. It may seem this method overlooks
// if the index part of the LEA has indir( someAddrOperator ( lclVar ) ) to search for a use but it's
// covered by the fact we're traversing the expression in execution order and we also visit the index.
GenTreeAddrMode* lea = addr->AsAddrMode();
GenTreePtr base = lea->Base();
if (base != nullptr)
{
if (base->OperGet() == GT_IND)
{
return fgIsIndirOfAddrOfLocal(base);
}
// else use base as addr
addr = base;
}
}
if (addr->OperGet() == GT_ADDR)
{
GenTreePtr lclvar = addr->gtOp.gtOp1;
if (lclvar->OperGet() == GT_LCL_VAR)
{
res = lclvar;
}
}
else if (addr->OperGet() == GT_LCL_VAR_ADDR)
{
res = addr;
}
}
return res;
}
GenTreePtr Compiler::fgGetStaticsCCtorHelper(CORINFO_CLASS_HANDLE cls, CorInfoHelpFunc helper)
{
bool bNeedClassID = true;
unsigned callFlags = 0;
var_types type = TYP_BYREF;
// This is sort of ugly, as we have knowledge of what the helper is returning.
// We need the return type.
switch (helper)
{
case CORINFO_HELP_GETSHARED_GCSTATIC_BASE_NOCTOR:
bNeedClassID = false;
__fallthrough;
case CORINFO_HELP_GETSHARED_GCTHREADSTATIC_BASE_NOCTOR:
callFlags |= GTF_CALL_HOISTABLE;
__fallthrough;
case CORINFO_HELP_GETSHARED_GCSTATIC_BASE:
case CORINFO_HELP_GETSHARED_GCSTATIC_BASE_DYNAMICCLASS:
case CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE_DYNAMICCLASS:
case CORINFO_HELP_GETSHARED_GCTHREADSTATIC_BASE:
case CORINFO_HELP_GETSHARED_GCTHREADSTATIC_BASE_DYNAMICCLASS:
// type = TYP_BYREF;
break;
case CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE_NOCTOR:
bNeedClassID = false;
__fallthrough;
case CORINFO_HELP_GETSHARED_NONGCTHREADSTATIC_BASE_NOCTOR:
callFlags |= GTF_CALL_HOISTABLE;
__fallthrough;
case CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE:
case CORINFO_HELP_GETSHARED_NONGCTHREADSTATIC_BASE:
case CORINFO_HELP_GETSHARED_NONGCTHREADSTATIC_BASE_DYNAMICCLASS:
case CORINFO_HELP_CLASSINIT_SHARED_DYNAMICCLASS:
type = TYP_I_IMPL;
break;
default:
assert(!"unknown shared statics helper");
break;
}
GenTreeArgList* argList = NULL;
GenTreePtr opModuleIDArg;
GenTreePtr opClassIDArg;
// Get the class ID
unsigned clsID;
size_t moduleID;
void* pclsID;
void* pmoduleID;
clsID = info.compCompHnd->getClassDomainID(cls, &pclsID);
moduleID = info.compCompHnd->getClassModuleIdForStatics(cls, NULL, &pmoduleID);
if (!(callFlags & GTF_CALL_HOISTABLE))
{
if (info.compCompHnd->getClassAttribs(cls) & CORINFO_FLG_BEFOREFIELDINIT)
{
callFlags |= GTF_CALL_HOISTABLE;
}
}
if (pmoduleID)
{
opModuleIDArg = gtNewIconHandleNode((size_t) pmoduleID, GTF_ICON_CIDMID_HDL);
opModuleIDArg = gtNewOperNode(GT_IND, TYP_I_IMPL, opModuleIDArg);
opModuleIDArg->gtFlags |= GTF_IND_INVARIANT;
}
else
{
opModuleIDArg = gtNewIconNode((size_t)moduleID, TYP_I_IMPL);
}
if (bNeedClassID)
{
if (pclsID)
{
opClassIDArg = gtNewIconHandleNode((size_t) pclsID, GTF_ICON_CIDMID_HDL);
opClassIDArg = gtNewOperNode(GT_IND, TYP_INT, opClassIDArg);
opClassIDArg->gtFlags |= GTF_IND_INVARIANT;
}
else
{
opClassIDArg = gtNewIconNode(clsID, TYP_INT);
}
// call the helper to get the base
argList = gtNewArgList(opModuleIDArg, opClassIDArg);
}
else
{
argList = gtNewArgList(opModuleIDArg);
}
if (!s_helperCallProperties.NoThrow(helper))
{
callFlags |= GTF_EXCEPT;
}
return gtNewHelperCallNode(helper, type, callFlags, argList);
}
GenTreePtr Compiler::fgGetSharedCCtor(CORINFO_CLASS_HANDLE cls)
{
#ifdef FEATURE_READYTORUN_COMPILER
if (opts.IsReadyToRun())
{
CORINFO_RESOLVED_TOKEN resolvedToken;
ZeroMemory(&resolvedToken, sizeof(resolvedToken));
resolvedToken.hClass = cls;
return impReadyToRunHelperToTree(&resolvedToken, CORINFO_HELP_READYTORUN_STATIC_BASE, TYP_BYREF);
}
#endif
// Call the shared non gc static helper, as its the fastest
return fgGetStaticsCCtorHelper(cls, info.compCompHnd->getSharedCCtorHelper(cls));
}
//
// Returns true unless the address expression could
// never represent a NULL
//
bool Compiler::fgAddrCouldBeNull(GenTreePtr addr)
{
if (addr->gtOper == GT_ADDR)
{
if (addr->gtOp.gtOp1->gtOper == GT_CNS_INT)
{
GenTreePtr cns1Tree = addr->gtOp.gtOp1;
if (!cns1Tree->IsIconHandle())
{
// Indirection of some random constant...
// It is safest just to return true
return true;
}
}
else if (addr->gtOp.gtOp1->OperIsLocalAddr())
{
return false;
}
return false; // we can't have a null address
}
else if (addr->gtOper == GT_ADD)
{
if (addr->gtOp.gtOp1->gtOper == GT_CNS_INT)
{
GenTreePtr cns1Tree = addr->gtOp.gtOp1;
if (!cns1Tree->IsIconHandle())
{
if (!fgIsBigOffset(cns1Tree->gtIntCon.gtIconVal))
{
// Op1 was an ordinary small constant
return fgAddrCouldBeNull(addr->gtOp.gtOp2);
}
}
else // Op1 was a handle represented as a constant
{
// Is Op2 also a constant?
if (addr->gtOp.gtOp2->gtOper == GT_CNS_INT)
{
GenTreePtr cns2Tree = addr->gtOp.gtOp2;
// Is this an addition of a handle and constant
if (!cns2Tree->IsIconHandle())
{
if (!fgIsBigOffset(cns2Tree->gtIntCon.gtIconVal))
{
// Op2 was an ordinary small constant
return false; // we can't have a null address
}
}
}
}
}
else
{
// Op1 is not a constant
// What about Op2?
if (addr->gtOp.gtOp2->gtOper == GT_CNS_INT)
{
GenTreePtr cns2Tree = addr->gtOp.gtOp2;
// Is this an addition of a small constant
if (!cns2Tree->IsIconHandle())
{
if (!fgIsBigOffset(cns2Tree->gtIntCon.gtIconVal))
{
// Op2 was an ordinary small constant
return fgAddrCouldBeNull(addr->gtOp.gtOp1);
}
}
}
}
}
return true; // default result: addr could be null
}
/*****************************************************************************
* Optimize the call to the delegate constructor.
*/
GenTreePtr Compiler::fgOptimizeDelegateConstructor(GenTreePtr call, CORINFO_CONTEXT_HANDLE * ExactContextHnd)
{
noway_assert(call->gtOper == GT_CALL);
noway_assert(call->gtCall.gtCallType == CT_USER_FUNC);
CORINFO_METHOD_HANDLE methHnd = call->gtCall.gtCallMethHnd;
CORINFO_CLASS_HANDLE clsHnd = info.compCompHnd->getMethodClass(methHnd);
GenTreePtr targetMethod = call->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp1;
noway_assert(targetMethod->TypeGet() == TYP_I_IMPL);
genTreeOps oper = targetMethod->OperGet();
if (oper == GT_FTN_ADDR || oper == GT_CALL || oper == GT_QMARK)
{
CORINFO_METHOD_HANDLE targetMethodHnd = NULL;
GenTreePtr qmarkNode = NULL;
if (oper == GT_FTN_ADDR)
{
targetMethodHnd = targetMethod->gtFptrVal.gtFptrMethod;
}
else if (oper == GT_CALL && targetMethod->gtCall.gtCallMethHnd == eeFindHelper(CORINFO_HELP_VIRTUAL_FUNC_PTR))
{
GenTreePtr handleNode = targetMethod->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp2->gtOp.gtOp1;
if (handleNode->OperGet() == GT_CNS_INT)
{
// it's a ldvirtftn case, fetch the methodhandle off the helper for ldvirtftn. It's the 3rd arg
targetMethodHnd = CORINFO_METHOD_HANDLE(handleNode->gtIntCon.gtCompileTimeHandle);
}
//Sometimes the argument to this is the result of a generic dictionary lookup, which shows
//up as a GT_QMARK.
else if (handleNode->OperGet() == GT_QMARK)
{
qmarkNode = handleNode;
}
}
//Sometimes we don't call CORINFO_HELP_VIRTUAL_FUNC_PTR but instead just call
//CORINFO_HELP_RUNTIMEHANDLE_METHOD directly.
else if (oper == GT_QMARK)
{
qmarkNode = targetMethod;
}
if (qmarkNode)
{
noway_assert(qmarkNode->OperGet() == GT_QMARK);
//The argument is actually a generic dictionary lookup. For delegate creation it looks
//like:
//GT_QMARK
// GT_COLON
// op1 -> call
// Arg 1 -> token (has compile time handle)
// op2 -> lclvar
//
//
//In this case I can find the token (which is a method handle) and that is the compile time
//handle.
noway_assert(qmarkNode->gtOp.gtOp2->OperGet() == GT_COLON);
noway_assert(qmarkNode->gtOp.gtOp2->gtOp.gtOp1->OperGet() == GT_CALL);
GenTreePtr runtimeLookupCall = qmarkNode->gtOp.gtOp2->gtOp.gtOp1;
//This could be any of CORINFO_HELP_RUNTIMEHANDLE_(METHOD|CLASS)(_LOG?)
GenTreePtr tokenNode = runtimeLookupCall->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp1;
noway_assert(tokenNode->OperGet() == GT_CNS_INT);
targetMethodHnd = CORINFO_METHOD_HANDLE(tokenNode->gtIntCon.gtCompileTimeHandle);
}
#ifdef FEATURE_READYTORUN_COMPILER
if (opts.IsReadyToRun())
{
// ReadyToRun has this optimization for a non-virtual function pointers only for now.
if (oper == GT_FTN_ADDR)
{
// The first argument of the helper is delegate this pointer
GenTreeArgList* helperArgs = gtNewArgList(call->gtCall.gtCallObjp);
// The second argument of the helper is the target object pointers
helperArgs->gtOp.gtOp2 = gtNewArgList(call->gtCall.gtCallArgs->gtOp.gtOp1);
call = gtNewHelperCallNode(CORINFO_HELP_READYTORUN_DELEGATE_CTOR, TYP_VOID, GTF_EXCEPT, helperArgs);
call->gtCall.gtEntryPoint = targetMethod->gtFptrVal.gtDelegateCtor;
}
}
else
#endif
if (targetMethodHnd != NULL)
{
CORINFO_METHOD_HANDLE alternateCtor = NULL;
DelegateCtorArgs ctorData;
ctorData.pMethod = info.compMethodHnd;
ctorData.pArg3 = NULL;
ctorData.pArg4 = NULL;
ctorData.pArg5 = NULL;
alternateCtor = info.compCompHnd->GetDelegateCtor(methHnd, clsHnd, targetMethodHnd, &ctorData);
if (alternateCtor != methHnd)
{
// we erase any inline info that may have been set for generics has it is not needed here,
// and in fact it will pass the wrong info to the inliner code
* ExactContextHnd = 0;
call->gtCall.gtCallMethHnd = alternateCtor;
noway_assert(call->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp2 == NULL);
if (ctorData.pArg3)
{
call->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp2 =
gtNewArgList(gtNewIconHandleNode(size_t(ctorData.pArg3), GTF_ICON_FTN_ADDR));
if (ctorData.pArg4)
{
call->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp2->gtOp.gtOp2 =
gtNewArgList(gtNewIconHandleNode(size_t(ctorData.pArg4), GTF_ICON_FTN_ADDR));
if (ctorData.pArg5)
{
call->gtCall.gtCallArgs->gtOp.gtOp2->gtOp.gtOp2->gtOp.gtOp2->gtOp.gtOp2 =
gtNewArgList(gtNewIconHandleNode(size_t(ctorData.pArg5), GTF_ICON_FTN_ADDR));
}
}
}
}
}
}
return call;
}
bool Compiler::fgCastNeeded(GenTreePtr tree, var_types toType)
{
//
// If tree is a relop and we need an 4-byte integer
// then we never need to insert a cast
//
if ((tree->OperKind() & GTK_RELOP) && (genActualType(toType) == TYP_INT))
return false;
var_types fromType;
//
// Is the tree as GT_CAST or a GT_CALL ?
//
if (tree->OperGet() == GT_CAST)
{
fromType = tree->CastToType();
}
else if (tree->OperGet() == GT_CALL)
{
fromType = (var_types) tree->gtCall.gtReturnType;
}
else
{
fromType = tree->TypeGet();
}
//
// If both types are the same then an additional cast is not necessary
//
if (toType == fromType)
return false;
//
// If the sign-ness of the two types are different then a cast is necessary
//
if (varTypeIsUnsigned(toType) != varTypeIsUnsigned(fromType))
return true;
//
// If the from type is the same size or smaller then an additional cast is not necessary
//
if (genTypeSize(toType) >= genTypeSize(fromType))
return false;
//
// Looks like we will need the cast
//
return true;
}
// If assigning to a local var, add a cast if the target is
// marked as NormalizedOnStore. Returns true if any change was made
GenTreePtr Compiler::fgDoNormalizeOnStore(GenTreePtr tree)
{
//
// Only normalize the stores in the global morph phase
//
if (fgGlobalMorph)
{
noway_assert(tree->OperGet()==GT_ASG);
GenTreePtr op1 = tree->gtOp.gtOp1;
GenTreePtr op2 = tree->gtOp.gtOp2;
if (op1->gtOper == GT_LCL_VAR && genActualType(op1->TypeGet()) == TYP_INT)
{
// Small-typed arguments and aliased locals are normalized on load.
// Other small-typed locals are normalized on store.
// If it is an assignment to one of the latter, insert the cast on RHS
unsigned varNum = op1->gtLclVarCommon.gtLclNum;
LclVarDsc * varDsc = &lvaTable[varNum];
if (varDsc->lvNormalizeOnStore())
{
noway_assert(op1->gtType <= TYP_INT);
op1->gtType = TYP_INT;
if (fgCastNeeded(op2, varDsc->TypeGet()))
{
op2 = gtNewCastNode(TYP_INT, op2, varDsc->TypeGet());
tree->gtOp.gtOp2 = op2;
// Propagate GTF_COLON_COND
op2->gtFlags|=(tree->gtFlags & GTF_COLON_COND);
}
}
}
}
return tree;
}
/*****************************************************************************
*
* Mark whether the edge "srcBB -> dstBB" forms a loop that will always
* execute a call or not.
*/
inline
void Compiler::fgLoopCallTest(BasicBlock *srcBB,
BasicBlock *dstBB)
{
/* Bail if this is not a backward edge */
if (srcBB->bbNum < dstBB->bbNum)
return;
/* Unless we already know that there is a loop without a call here ... */
if (!(dstBB->bbFlags & BBF_LOOP_CALL0))
{
/* Check whether there is a loop path that doesn't call */
if (optReachWithoutCall(dstBB, srcBB))
{
dstBB->bbFlags |= BBF_LOOP_CALL0;
dstBB->bbFlags &= ~BBF_LOOP_CALL1;
}
else
dstBB->bbFlags |= BBF_LOOP_CALL1;
}
//if this loop will always call, then we can omit the GC Poll
if ((GCPOLL_NONE != opts.compGCPollType) && (dstBB->bbFlags & BBF_LOOP_CALL1))
{
srcBB->bbFlags &= ~BBF_NEEDS_GCPOLL;
}
}
/*****************************************************************************
*
* Mark which loops are guaranteed to execute a call.
*/
void Compiler::fgLoopCallMark()
{
BasicBlock * block;
/* If we've already marked all the block, bail */
if (fgLoopCallMarked)
return;
fgLoopCallMarked = true;
/* Walk the blocks, looking for backward edges */
for (block = fgFirstBB; block; block = block->bbNext)
{
switch (block->bbJumpKind)
{
case BBJ_COND:
case BBJ_CALLFINALLY:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
fgLoopCallTest(block, block->bbJumpDest);
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock * * jumpPtr; jumpPtr = block->bbJumpSwt->bbsDstTab;
do
{
fgLoopCallTest(block, *jumpPtr);
}
while (++jumpPtr, --jumpCnt);
break;
default:
break;
}
}
}
/*****************************************************************************
*
* Note the fact that the given block is a loop header.
*/
inline
void Compiler::fgMarkLoopHead(BasicBlock *block)
{
#ifdef DEBUG
if (verbose)
printf("fgMarkLoopHead: Checking loop head block BB%02u: ", block->bbNum);
#endif
/* Have we decided to generate fully interruptible code already? */
if (genInterruptible)
{
#ifdef DEBUG
if (verbose)
printf("method is already fully interruptible\n");
#endif
return;
}
/* Is the loop head block known to execute a method call? */
if (block->bbFlags & BBF_GC_SAFE_POINT)
{
#ifdef DEBUG
if (verbose)
printf("this block will execute a call\n");
#endif
// single block loops that contain GC safe points don't need polls.
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
return;
}
/* Are dominator sets available? */
if (fgDomsComputed)
{
/* Make sure that we know which loops will always execute calls */
if (!fgLoopCallMarked)
fgLoopCallMark();
/* Will every trip through our loop execute a call? */
if (block->bbFlags & BBF_LOOP_CALL1)
{
#ifdef DEBUG
if (verbose)
printf("this block dominates a block that will execute a call\n");
#endif
return;
}
}
/*
* We have to make this method fully interruptible since we can not
* ensure that this loop will execute a call every time it loops.
*
* We'll also need to generate a full register map for this method.
*/
assert(!codeGen->isGCTypeFixed());
if (!compCanEncodePtrArgCntMax())
{
#ifdef DEBUG
if (verbose)
printf("a callsite with more than 1023 pushed args exists\n");
#endif
return;
}
#ifdef DEBUG
if (verbose)
printf("no guaranteed callsite exits, marking method as fully interruptible\n");
#endif
//only enable fully interruptible code for if we're hijacking.
if (GCPOLL_NONE == opts.compGCPollType)
{
genInterruptible = true;
}
}
GenTreePtr Compiler::fgGetCritSectOfStaticMethod()
{
noway_assert(!compIsForInlining());
noway_assert(info.compIsStatic); // This method should only be called for static methods.
GenTreePtr tree = NULL;
CORINFO_LOOKUP_KIND kind = info.compCompHnd->getLocationOfThisType(info.compMethodHnd);
if (!kind.needsRuntimeLookup)
{
void * critSect = 0, **pCrit = 0;
critSect = info.compCompHnd->getMethodSync(info.compMethodHnd, (void**) &pCrit);
noway_assert((!critSect) != (!pCrit));
tree = gtNewIconEmbHndNode(critSect, pCrit, GTF_ICON_METHOD_HDL);
}
else
{
// Collectible types requires that for shared generic code, if we use the generic context paramter
// that we report it. (This is a conservative approach, we could detect some cases particularly when the
// context parameter is this that we don't need the eager reporting logic.)
lvaGenericsContextUsed = true;
switch (kind.runtimeLookupKind)
{
case CORINFO_LOOKUP_THISOBJ :
{
noway_assert(!"Should never get this for static method.");
break;
}
case CORINFO_LOOKUP_CLASSPARAM :
{
// In this case, the hidden param is the class handle.
tree = gtNewLclvNode(info.compTypeCtxtArg, TYP_I_IMPL);
break;
}
case CORINFO_LOOKUP_METHODPARAM :
{
// In this case, the hidden param is the method handle.
tree = gtNewLclvNode(info.compTypeCtxtArg, TYP_I_IMPL);
// Call helper CORINFO_HELP_GETCLASSFROMMETHODPARAM to get the class handle
// from the method handle.
tree = gtNewHelperCallNode(CORINFO_HELP_GETCLASSFROMMETHODPARAM,
TYP_I_IMPL, 0,
gtNewArgList(tree));
break;
}
default:
{
noway_assert(!"Unknown LOOKUP_KIND");
break;
}
}
noway_assert(tree); // tree should now contain the CORINFO_CLASS_HANDLE for the exact class.
// Given the class handle, get the pointer to the Monitor.
tree = gtNewHelperCallNode(CORINFO_HELP_GETSYNCFROMCLASSHANDLE,
TYP_I_IMPL, 0,
gtNewArgList(tree));
}
noway_assert(tree);
return tree;
}
#if !defined(_TARGET_X86_)
/*****************************************************************************
*
* Add monitor enter/exit calls for synchronized methods, and a try/fault
* to ensure the 'exit' is called if the 'enter' was successful. On x86, we
* generate monitor enter/exit calls and tell the VM the code location of
* these calls. When an exception occurs between those locations, the VM
* automatically releases the lock. For non-x86 platforms, the JIT is
* responsible for creating a try/finally to protect the monitor enter/exit,
* and the VM doesn't need to know anything special about the method during
* exception processing -- it's just a normal try/finally.
*
* We generate the following code:
*
* void Foo()
* {
* unsigned byte acquired = 0;
* try {
* JIT_MonEnterWorker(<lock object>, &acquired);
*
* *** all the preexisting user code goes here ***
*
* JIT_MonExitWorker(<lock object>, &acquired);
* } fault {
* JIT_MonExitWorker(<lock object>, &acquired);
* }
* L_return:
* ret
* }
*
* If the lock is actually acquired, then the 'acquired' variable is set to 1
* by the helper call. During normal exit, the finally is called, 'acquired'
* is 1, and the lock is released. If an exception occurs before the lock is
* acquired, but within the 'try' (extremely unlikely, but possible), 'acquired'
* will be 0, and the monitor exit call will quickly return without attempting
* to release the lock. Otherwise, 'acquired' will be 1, and the lock will be
* released during exception processing.
*
* For synchronized methods, we generate a single return block.
* We can do this without creating additional "step" blocks because "ret" blocks
* must occur at the top-level (of the original code), not nested within any EH
* constructs. From the CLI spec, 12.4.2.8.2.3 "ret": "Shall not be enclosed in any
* protected block, filter, or handler." Also, 3.57: "The ret instruction cannot be
* used to transfer control out of a try, filter, catch, or finally block. From within
* a try or catch, use the leave instruction with a destination of a ret instruction
* that is outside all enclosing exception blocks."
*
* In addition, we can add a "fault" at the end of a method and be guaranteed that no
* control falls through. From the CLI spec, section 12.4 "Control flow": "Control is not
* permitted to simply fall through the end of a method. All paths shall terminate with one
* of these instructions: ret, throw, jmp, or (tail. followed by call, calli, or callvirt)."
*
* We only need to worry about "ret" and "throw", as the CLI spec prevents any other
* alternatives. Section 15.4.3.3 "Implementation information" states about exiting
* synchronized methods: "Exiting a synchronized method using a tail. call shall be
* implemented as though the tail. had not been specified." Section 3.37 "jmp" states:
* "The jmp instruction cannot be used to transferred control out of a try, filter,
* catch, fault or finally block; or out of a synchronized region." And, "throw" will
* be handled naturally; no additional work is required.
*/
void Compiler::fgAddSyncMethodEnterExit()
{
if ((info.compFlags & CORINFO_FLG_SYNCH) == 0)
return;
// We need to do this transformation before funclets are created.
assert(!fgFuncletsCreated);
// Assume we don't need to update the bbPreds lists.
assert(!fgComputePredsDone);
#if !FEATURE_EH
// If we don't support EH, we can't add the EH needed by synchronized methods.
// Of course, we could simply ignore adding the EH constructs, since we don't
// support exceptions being thrown in this mode, but we would still need to add
// the monitor enter/exit, and that doesn't seem worth it for this minor case.
// By the time EH is working, we can just enable the whole thing.
NYI("No support for synchronized methods");
#endif // !FEATURE_EH
// Create a scratch first BB where we can put the new variable initialization.
// Don't put the scratch BB in the protected region.
fgEnsureFirstBBisScratch();
// Create a block for the start of the try region, where the monitor enter call
// will go.
assert(fgFirstBB->bbFallsThrough());
BasicBlock* tryBegBB = fgNewBBafter(BBJ_NONE, fgFirstBB, false);
BasicBlock* tryLastBB = fgLastBB;
// Create a block for the fault.
assert(!tryLastBB->bbFallsThrough());
BasicBlock* faultBB = fgNewBBafter(BBJ_EHFINALLYRET, tryLastBB, false);
assert(tryLastBB->bbNext == faultBB);
assert(faultBB->bbNext == NULL);
assert(faultBB == fgLastBB);
{ // Scope the EH region creation
// Add the new EH region at the end, since it is the least nested,
// and thus should be last.
EHblkDsc * newEntry;
unsigned XTnew = compHndBBtabCount;
newEntry = fgAddEHTableEntry(XTnew);
// Initialize the new entry
newEntry->ebdHandlerType = EH_HANDLER_FAULT;
newEntry->ebdTryBeg = tryBegBB;
newEntry->ebdTryLast = tryLastBB;
newEntry->ebdHndBeg = faultBB;
newEntry->ebdHndLast = faultBB;
newEntry->ebdTyp = 0; // unused for fault
newEntry->ebdEnclosingTryIndex = EHblkDsc::NO_ENCLOSING_INDEX;
newEntry->ebdEnclosingHndIndex = EHblkDsc::NO_ENCLOSING_INDEX;
newEntry->ebdTryBegOffset = tryBegBB->bbCodeOffs;
newEntry->ebdTryEndOffset = tryLastBB->bbCodeOffsEnd;
newEntry->ebdFilterBegOffset = 0;
newEntry->ebdHndBegOffset = 0; // handler doesn't correspond to any IL
newEntry->ebdHndEndOffset = 0; // handler doesn't correspond to any IL
// Set some flags on the new region. This is the same as when we set up
// EH regions in fgFindBasicBlocks(). Note that the try has no enclosing
// handler, and the fault has no enclosing try.
tryBegBB->bbFlags |= BBF_HAS_LABEL | BBF_DONT_REMOVE | BBF_TRY_BEG | BBF_IMPORTED;
faultBB->bbFlags |= BBF_HAS_LABEL | BBF_DONT_REMOVE | BBF_IMPORTED;
faultBB->bbCatchTyp = BBCT_FAULT;
tryBegBB->setTryIndex(XTnew);
tryBegBB->clearHndIndex();
faultBB->clearTryIndex();
faultBB->setHndIndex(XTnew);
// Walk the user code blocks and set all blocks that don't already have a try handler
// to point to the new try handler.
BasicBlock * tmpBB;
for (tmpBB = tryBegBB->bbNext; tmpBB != faultBB; tmpBB = tmpBB->bbNext)
{
if (!tmpBB->hasTryIndex())
{
tmpBB->setTryIndex(XTnew);
}
}
// Walk the EH table. Make every EH entry that doesn't already have an enclosing
// try index mark this new entry as their enclosing try index.
unsigned XTnum;
EHblkDsc * HBtab;
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < XTnew;
XTnum++ , HBtab++)
{
if (HBtab->ebdEnclosingTryIndex == EHblkDsc::NO_ENCLOSING_INDEX)
{
HBtab->ebdEnclosingTryIndex = (unsigned short)XTnew; // This EH region wasn't previously nested, but now it is.
}
}
#ifdef DEBUG
if (verbose)
{
JITDUMP("Synchronized method - created additional EH descriptor EH#%u for try/fault wrapping monitor enter/exit\n",
XTnew);
fgDispBasicBlocks();
fgDispHandlerTab();
}
fgVerifyHandlerTab();
#endif // DEBUG
}
// Create a 'monitor acquired' boolean (actually, an unsigned byte: 1 = acquired, 0 = not acquired).
var_types typeMonAcquired = TYP_UBYTE;
this->lvaMonAcquired = lvaGrabTemp(true DEBUGARG("Synchronized method monitor acquired boolean"));
lvaTable[lvaMonAcquired].lvType = typeMonAcquired;
{ // Scope the variables of the variable initialization
// Initialize the 'acquired' boolean.
GenTreePtr zero = gtNewZeroConNode(genActualType(typeMonAcquired));
GenTreePtr varNode = gtNewLclvNode(lvaMonAcquired, typeMonAcquired);
GenTreePtr initNode = gtNewAssignNode(varNode, zero);
fgInsertStmtAtEnd(fgFirstBB, initNode);
#ifdef DEBUG
if (verbose)
{
printf("\nSynchronized method - Add 'acquired' initialization in first block BB%02u [%08p]\n", fgFirstBB, dspPtr(fgFirstBB));
gtDispTree(initNode);
printf("\n");
}
#endif
}
// Make a copy of the 'this' pointer to be used in the handler so it does not inhibit enregistration
// of all uses of the variable.
unsigned lvaCopyThis = 0;
if (!info.compIsStatic)
{
lvaCopyThis = lvaGrabTemp(true DEBUGARG("Synchronized method monitor acquired boolean"));
lvaTable[lvaCopyThis].lvType = TYP_REF;
GenTreePtr thisNode = gtNewLclvNode(info.compThisArg, TYP_REF);
GenTreePtr copyNode = gtNewLclvNode(lvaCopyThis, TYP_REF);
GenTreePtr initNode = gtNewAssignNode(copyNode, thisNode);
fgInsertStmtAtEnd(tryBegBB, initNode);
}
fgCreateMonitorTree(lvaMonAcquired, info.compThisArg, tryBegBB, true /*enter*/);
// exceptional case
fgCreateMonitorTree(lvaMonAcquired, lvaCopyThis, faultBB, false /*exit*/);
// non-exceptional cases
for (BasicBlock* block = fgFirstBB; block != nullptr; block = block->bbNext)
{
if (block->bbJumpKind == BBJ_RETURN)
{
fgCreateMonitorTree(lvaMonAcquired, info.compThisArg, block, false /*exit*/);
}
}
}
// fgCreateMonitorTree: Create tree to execute a monitor enter or exit operation for synchronized methods
// lvaMonAcquired: lvaNum of boolean variable that tracks if monitor has been acquired.
// lvaThisVar: lvaNum of variable being used as 'this' pointer, may not be the original one. Is only used for nonstatic methods
// block: block to insert the tree in. It is inserted at the end or in the case of a return, immediately before the GT_RETURN
// enter: whether to create a monitor enter or exit
GenTree* Compiler::fgCreateMonitorTree(unsigned lvaMonAcquired, unsigned lvaThisVar, BasicBlock* block, bool enter)
{
// Insert the expression "enter/exitCrit(this, &acquired)" or "enter/exitCrit(handle, &acquired)"
var_types typeMonAcquired = TYP_UBYTE;
GenTreePtr varNode = gtNewLclvNode(lvaMonAcquired, typeMonAcquired);
GenTreePtr varAddrNode = gtNewOperNode(GT_ADDR, TYP_BYREF, varNode);
GenTreePtr tree;
if (info.compIsStatic)
{
tree = fgGetCritSectOfStaticMethod();
tree = gtNewHelperCallNode(enter ? CORINFO_HELP_MON_ENTER_STATIC : CORINFO_HELP_MON_EXIT_STATIC,
TYP_VOID, 0,
gtNewArgList(tree, varAddrNode));
}
else
{
tree = gtNewLclvNode(lvaThisVar, TYP_REF);
tree = gtNewHelperCallNode(enter ? CORINFO_HELP_MON_ENTER : CORINFO_HELP_MON_EXIT,
TYP_VOID, 0,
gtNewArgList(tree, varAddrNode));
}
#ifdef DEBUG
if (verbose)
{
printf("\nSynchronized method - Add monitor %s call to block BB%02u [%08p]\n", enter?"enter":"exit", block, dspPtr(block));
gtDispTree(tree);
printf("\n");
}
#endif
if (block->bbJumpKind == BBJ_RETURN &&
block->lastStmt()->gtStmtExpr->gtOper == GT_RETURN)
{
GenTree* retNode = block->lastStmt()->gtStmtExpr;
GenTree* retExpr = retNode->gtOp.gtOp1;
if (retExpr)
{
// have to insert this immediately before the GT_RETURN so we transform:
// ret(...) ->
// ret(comma(comma(tmp=...,call mon_exit), tmp)
//
//
// Before morph stage, it is possible to have a case of GT_RETURN(TYP_LONG, op1) where op1's type is
// TYP_STRUCT (of 8-bytes) and op1 is call node. See the big comment block in impReturnInstruction()
// for details for the case where info.compRetType is not the same as info.compRetNativeType. For
// this reason pass compMethodInfo->args.retTypeClass which is guaranteed to be a valid class handle
// if the return type is a value class. Note that fgInsertCommFormTemp() in turn uses this class handle
// if the type of op1 is TYP_STRUCT to perform lvaSetStruct() on the new temp that is created, which
// in turn passes it to VM to know the size of value type.
GenTree* temp = fgInsertCommaFormTemp(&retNode->gtOp.gtOp1, info.compMethodInfo->args.retTypeClass);
GenTree* lclVar = retNode->gtOp.gtOp1->gtOp.gtOp2;
retNode->gtOp.gtOp1->gtOp.gtOp2 = gtNewOperNode(GT_COMMA, retExpr->TypeGet(), tree, lclVar);
}
else
{
fgInsertStmtAtEnd(block, tree);
}
}
else
{
fgInsertStmtAtEnd(block, tree);
}
return tree;
}
// Convert a BBJ_RETURN block in a synchronized method to a BBJ_ALWAYS.
// We've previously added a 'try' block around the original program code using fgAddSyncMethodEnterExit().
// Thus, we put BBJ_RETURN blocks inside a 'try'. In IL this is illegal. Instead, we would
// see a 'leave' inside a 'try' that would get transformed into BBJ_CALLFINALLY/BBJ_ALWAYS blocks
// during importing, and the BBJ_ALWAYS would point at an outer block with the BBJ_RETURN.
// Here, we mimic some of the logic of importing a LEAVE to get the same effect for synchronized methods.
void Compiler::fgConvertSyncReturnToLeave(BasicBlock* block)
{
assert(!fgFuncletsCreated);
assert(info.compFlags & CORINFO_FLG_SYNCH);
assert(genReturnBB != nullptr);
assert(genReturnBB != block);
assert(fgReturnCount <= 1); // We have a single return for synchronized methods
assert(block->bbJumpKind == BBJ_RETURN);
assert((block->bbFlags & BBF_HAS_JMP) == 0);
assert(block->hasTryIndex());
assert(!block->hasHndIndex());
assert(compHndBBtabCount >= 1);
unsigned tryIndex = block->getTryIndex();
assert(tryIndex == compHndBBtabCount - 1); // The BBJ_RETURN must be at the top-level before we inserted the try/finally, which must be the last EH region.
EHblkDsc* ehDsc = ehGetDsc(tryIndex);
assert(ehDsc->ebdEnclosingTryIndex == EHblkDsc::NO_ENCLOSING_INDEX); // There are no enclosing regions of the BBJ_RETURN block
assert(ehDsc->ebdEnclosingHndIndex == EHblkDsc::NO_ENCLOSING_INDEX);
// Convert the BBJ_RETURN to BBJ_ALWAYS, jumping to genReturnBB.
block->bbJumpKind = BBJ_ALWAYS;
block->bbJumpDest = genReturnBB;
block->bbJumpDest->bbRefs++;
#ifdef DEBUG
if (verbose)
{
printf("Synchronized method - convert block BB%02u to BBJ_ALWAYS [targets BB%02u]\n",
block->bbNum, block->bbJumpDest->bbNum);
}
#endif
}
#endif // !_TARGET_X86_
/*****************************************************************************
*
* Return 'true' if there is more than one BBJ_RETURN block.
*/
bool Compiler::fgMoreThanOneReturnBlock()
{
unsigned retCnt = 0;
for (BasicBlock * block = fgFirstBB; block; block = block->bbNext)
{
if (block->bbJumpKind == BBJ_RETURN)
{
retCnt++;
if (retCnt > 1)
{
return true;
}
}
}
return false;
}
/*****************************************************************************
*
* Add any internal blocks/trees we may need
*/
void Compiler::fgAddInternal()
{
noway_assert(!compIsForInlining());
/*
<BUGNUM> VSW441487 </BUGNUM>
The "this" pointer is implicitly used in the following cases:
1. Locking of synchronized methods
2. Dictionary access of shared generics code
3. If a method has "catch(FooException<T>)", the EH code accesses "this" to determine T.
4. Initializing the type from generic methods which require precise cctor semantics
5. Verifier does special handling of "this" in the .ctor
However, we might overwrite it with a "starg 0".
In this case, we will redirect all "ldarg(a)/starg(a) 0" to a temp lvaTable[lvaArg0Var]
*/
if (!info.compIsStatic)
{
if (lvaArg0Var != info.compThisArg)
{
// When we're using the general encoder, we mark compThisArg address-taken to ensure that it is not
// enregistered (since the decoder always reports a stack location for "this" for generics
// context vars).
bool lva0CopiedForGenericsCtxt;
#ifndef JIT32_GCENCODER
lva0CopiedForGenericsCtxt = ((info.compMethodInfo->options & CORINFO_GENERICS_CTXT_FROM_THIS) != 0);
#else // JIT32_GCENCODER
lva0CopiedForGenericsCtxt = false;
#endif // JIT32_GCENCODER
noway_assert(lva0CopiedForGenericsCtxt || !lvaTable[info.compThisArg].lvAddrExposed);
noway_assert(!lvaTable[info.compThisArg].lvArgWrite);
noway_assert(lvaTable[lvaArg0Var].lvAddrExposed || lvaTable[lvaArg0Var].lvArgWrite || lva0CopiedForGenericsCtxt);
var_types thisType = lvaTable[info.compThisArg].TypeGet();
// Now assign the original input "this" to the temp
GenTreePtr tree;
tree = gtNewLclvNode(lvaArg0Var, thisType);
tree = gtNewAssignNode(tree, // dst
gtNewLclvNode(info.compThisArg, thisType) // src
);
/* Create a new basic block and stick the assignment in it */
fgEnsureFirstBBisScratch();
fgInsertStmtAtEnd(fgFirstBB, tree);
#ifdef DEBUG
if (verbose)
{
printf("\nCopy \"this\" to lvaArg0Var in first basic block [%08p]\n", dspPtr(fgFirstBB));
gtDispTree(tree);
printf("\n");
}
#endif
}
}
// Grab a temp for the security object.
// (Note: opts.compDbgEnC currently also causes the security object to be generated. See Compiler::compCompile)
if (opts.compNeedSecurityCheck)
{
noway_assert(lvaSecurityObject == BAD_VAR_NUM);
lvaSecurityObject = lvaGrabTempWithImplicitUse(false DEBUGARG("security check"));
lvaTable[lvaSecurityObject].lvType = TYP_REF;
}
/* Assume we will generate a single shared return sequence */
// This is the node for the oneReturn statement.
// It could be as simple as a CallNode if we only have
// only one callout. It will be a comma tree of CallNodes
// if we have multiple callouts.
//
GenTreePtr oneReturnStmtNode = NULL;
ULONG returnWeight = 0;
bool oneReturn;
bool allProfWeight;
//
// We will generate just one epilog (return block)
// when we are asked to generate enter/leave callbacks
// or for methods calling into unmanaged code
// or for synchronized methods.
//
if ( compIsProfilerHookNeeded() ||
#if INLINE_NDIRECT
(info.compCallUnmanaged != 0) ||
#endif
((info.compFlags & CORINFO_FLG_SYNCH) != 0))
{
// We will generate only one return block
// We will transform the BBJ_RETURN blocks
// into jumps to the one return block
//
oneReturn = true;
allProfWeight = false;
}
else
{
//
// We are allowed to have multiple individual exits
// However we can still decide to have a single return
//
oneReturn = false;
allProfWeight = true;
// Count the BBJ_RETURN blocks and set the returnWeight to the
// sum of all these blocks.
//
fgReturnCount = 0;
for (BasicBlock * block = fgFirstBB; block; block = block->bbNext)
{
if (block->bbJumpKind == BBJ_RETURN)
{
//
// returnCount is the count of BBJ_RETURN blocks in this method
//
fgReturnCount++;
//
// If all BBJ_RETURN blocks have a valid profiled weights
// then allProfWeight will be true, else it is false
//
if ((block->bbFlags & BBF_PROF_WEIGHT) == 0)
{
allProfWeight = false;
}
//
// returnWeight is the sum of the weights of all BBJ_RETURN blocks
returnWeight += block->bbWeight;
}
}
//
// If we only have one (or zero) return blocks then
// we do not need a special one return block
//
if (fgReturnCount > 1)
{
//
// should we generate a single return block?
//
if (fgReturnCount > 4)
{
// Our epilog encoding only supports up to 4 epilogs
// TODO-CQ: support >4 return points for ARM/AMD64, which presumably support any number of epilogs?
//
oneReturn = true;
}
else if (compCodeOpt() == SMALL_CODE)
{
// For the Small_Code case we always generate a
// single return block when we have multiple
// return points
//
oneReturn = true;
}
}
}
#if !defined(_TARGET_X86_)
// Add the synchronized method enter/exit calls and try/finally protection. Note
// that this must happen before the one BBJ_RETURN block is created below, so the
// BBJ_RETURN block gets placed at the top-level, not within an EH region. (Otherwise,
// we'd have to be really careful when creating the synchronized method try/finally
// not to include the BBJ_RETURN block.)
fgAddSyncMethodEnterExit();
#endif // !_TARGET_X86_
if (oneReturn)
{
genReturnBB = fgNewBBinRegion(BBJ_RETURN);
genReturnBB->bbRefs = 1; // bbRefs gets update later, for now it should be 1
fgReturnCount++;
if (allProfWeight)
{
//
// if we have profile data for all BBJ_RETURN blocks
// then we can set BBF_PROF_WEIGHT for genReturnBB
//
genReturnBB->bbFlags |= BBF_PROF_WEIGHT;
}
else
{
//
// We can't rely upon the calculated returnWeight unless
// all of the BBJ_RETURN blocks had valid profile weights
// So we will use the weight of the first block instead
//
returnWeight = fgFirstBB->bbWeight;
}
//
// Set the weight of the oneReturn block
//
genReturnBB->bbWeight = min(returnWeight, BB_MAX_WEIGHT);
if (returnWeight == 0)
{
//
// If necessary set the Run Rarely flag
//
genReturnBB->bbFlags |= BBF_RUN_RARELY;
}
else
{
// Make sure that the RunRarely flag is clear
// because fgNewBBinRegion will set it to true
//
genReturnBB->bbFlags &= ~BBF_RUN_RARELY;
}
genReturnBB->bbFlags |= (BBF_INTERNAL | BBF_DONT_REMOVE);
noway_assert(genReturnBB->bbNext == NULL);
#ifdef DEBUG
if (verbose)
printf("\n genReturnBB [BB%02u] created\n", genReturnBB->bbNum);
#endif
}
else
{
//
// We don't have a oneReturn block for this method
//
genReturnBB = NULL;
}
// If there is a return value, then create a temp for it. Real returns will store the value in there and
// it'll be reloaded by the single return.
if (genReturnBB && (info.compRetType != TYP_VOID && info.compRetNativeType != TYP_STRUCT))
{
genReturnLocal = lvaGrabTemp(true DEBUGARG("Single return block return value"));
lvaTable[genReturnLocal].lvType = genActualType(info.compRetNativeType);
if (varTypeIsFloating(lvaTable[genReturnLocal].lvType))
{
this->compFloatingPointUsed = true;
}
if (!varTypeIsFloating(info.compRetType))
lvaTable[genReturnLocal].setPrefReg(REG_INTRET, this);
#ifdef REG_FLOATRET
else
lvaTable[genReturnLocal].setPrefReg(REG_FLOATRET, this);
#endif
#ifdef DEBUG
// This temporary should not be converted to a double in stress mode,
// because we introduce assigns to it after the stress conversion
lvaTable[genReturnLocal].lvKeepType = 1;
#endif
}
else
{
genReturnLocal = BAD_VAR_NUM;
}
#if INLINE_NDIRECT
if (info.compCallUnmanaged != 0)
{
info.compLvFrameListRoot = lvaGrabTemp(false DEBUGARG("Pinvoke FrameListRoot"));
lvaInlinedPInvokeFrameVar = lvaGrabTempWithImplicitUse(false DEBUGARG("Pinvoke FrameVar"));
LclVarDsc * varDsc = &lvaTable[lvaInlinedPInvokeFrameVar];
varDsc->addPrefReg(RBM_PINVOKE_TCB, this);
varDsc->lvType = TYP_BLK;
// Make room for the inlined frame.
varDsc->lvExactSize = eeGetEEInfo()->inlinedCallFrameInfo.size;
#if FEATURE_FIXED_OUT_ARGS
// Grab and reserve space for TCB, Frame regs used in PInvoke epilog to pop the inlined frame.
// See genPInvokeMethodEpilog() for use of the grabbed var.
if (compJmpOpUsed)
{
lvaPInvokeFrameRegSaveVar = lvaGrabTempWithImplicitUse(false DEBUGARG("PInvokeFrameRegSave Var"));
varDsc = &lvaTable[lvaPInvokeFrameRegSaveVar];
varDsc->lvType = TYP_BLK;
varDsc->lvExactSize = 2 * REGSIZE_BYTES;
}
#endif
}
#endif
// Do we need to insert a "JustMyCode" callback?
CORINFO_JUST_MY_CODE_HANDLE *pDbgHandle = NULL;
CORINFO_JUST_MY_CODE_HANDLE dbgHandle = NULL;
if (opts.compDbgCode && !(opts.eeFlags & CORJIT_FLG_IL_STUB))
{
dbgHandle = info.compCompHnd->getJustMyCodeHandle(info.compMethodHnd, &pDbgHandle);
}
#ifdef _TARGET_ARM64_
// TODO-ARM64-NYI: don't do just-my-code
dbgHandle = nullptr;
pDbgHandle = nullptr;
#endif // _TARGET_ARM64_
noway_assert(!dbgHandle || !pDbgHandle);
if (dbgHandle || pDbgHandle)
{
GenTreePtr guardCheckVal = gtNewOperNode(GT_IND, TYP_INT,
gtNewIconEmbHndNode(dbgHandle, pDbgHandle, GTF_ICON_TOKEN_HDL));
GenTreePtr guardCheckCond = gtNewOperNode(GT_EQ, TYP_INT,
guardCheckVal, gtNewZeroConNode(TYP_INT));
guardCheckCond->gtFlags |= GTF_RELOP_QMARK;
// Create the callback which will yield the final answer
GenTreePtr callback = gtNewHelperCallNode(CORINFO_HELP_DBG_IS_JUST_MY_CODE, TYP_VOID);
callback = new (this, GT_COLON) GenTreeColon(TYP_VOID, gtNewNothingNode(), callback);
// Stick the conditional call at the start of the method
fgEnsureFirstBBisScratch();
fgInsertStmtAtEnd(fgFirstBB, gtNewQmarkNode(TYP_VOID, guardCheckCond, callback));
}
/* Do we need to call out for security ? */
if (tiSecurityCalloutNeeded)
{
// We must have grabbed this local.
noway_assert(opts.compNeedSecurityCheck);
noway_assert(lvaSecurityObject != BAD_VAR_NUM);
GenTreePtr tree;
/* Insert the expression "call JIT_Security_Prolog(MethodHnd, &SecurityObject)" */
tree = gtNewIconEmbMethHndNode(info.compMethodHnd);
tree = gtNewHelperCallNode(info.compCompHnd->getSecurityPrologHelper(info.compMethodHnd),
TYP_VOID,
0,
gtNewArgList(tree,
gtNewOperNode(GT_ADDR,
TYP_BYREF,
gtNewLclvNode(lvaSecurityObject, TYP_REF))));
/* Create a new basic block and stick the call in it */
fgEnsureFirstBBisScratch();
fgInsertStmtAtEnd(fgFirstBB, tree);
#ifdef DEBUG
if (verbose)
{
printf("\ntiSecurityCalloutNeeded - Add call JIT_Security_Prolog(%08p) statement ", dspPtr(info.compMethodHnd));
printTreeID(tree);
printf(" in first basic block [%08p]\n", dspPtr(fgFirstBB));
gtDispTree(tree);
printf("\n");
}
#endif
}
#if defined(_TARGET_X86_)
/* Is this a 'synchronized' method? */
if (info.compFlags & CORINFO_FLG_SYNCH)
{
GenTreePtr tree = NULL;
/* Insert the expression "enterCrit(this)" or "enterCrit(handle)" */
if (info.compIsStatic)
{
tree = fgGetCritSectOfStaticMethod();
tree = gtNewHelperCallNode(CORINFO_HELP_MON_ENTER_STATIC,
TYP_VOID, 0,
gtNewArgList(tree));
}
else
{
noway_assert(lvaTable[info.compThisArg].lvType == TYP_REF);
tree = gtNewLclvNode(info.compThisArg, TYP_REF);
tree = gtNewHelperCallNode(CORINFO_HELP_MON_ENTER,
TYP_VOID, 0,
gtNewArgList(tree));
}
/* Create a new basic block and stick the call in it */
fgEnsureFirstBBisScratch();
fgInsertStmtAtEnd(fgFirstBB, tree);
#ifdef DEBUG
if (verbose)
{
printf("\nSynchronized method - Add enterCrit statement in first basic block [%08p]\n", dspPtr(fgFirstBB));
gtDispTree(tree);
printf("\n");
}
#endif
/* We must be generating a single exit point for this to work */
noway_assert(oneReturn);
noway_assert(genReturnBB);
/* Create the expression "exitCrit(this)" or "exitCrit(handle)" */
if (info.compIsStatic)
{
tree = fgGetCritSectOfStaticMethod();
tree = gtNewHelperCallNode(CORINFO_HELP_MON_EXIT_STATIC,
TYP_VOID, 0,
gtNewArgList(tree));
}
else
{
tree = gtNewLclvNode(info.compThisArg, TYP_REF);
tree = gtNewHelperCallNode(CORINFO_HELP_MON_EXIT,
TYP_VOID, 0,
gtNewArgList(tree));
}
/* Add the exitCrit expression to the oneReturnStmtNode */
if (oneReturnStmtNode != NULL)
{
//
// We add the newly created "tree" to op1, so we can evaluate the last added
// expression first.
//
oneReturnStmtNode = gtNewOperNode(GT_COMMA,
TYP_VOID,
tree,
oneReturnStmtNode);
}
else
{
oneReturnStmtNode = tree;
}
#ifdef DEBUG
if (verbose)
{
printf("\nSynchronized method - Add exit expression ");
printTreeID(tree);
printf(" to oneReturnStmtNode ");
printTreeID(oneReturnStmtNode);
printf("\nCurrent oneReturnStmtNode is\n");
gtDispTree(oneReturnStmtNode);
printf("\n");
}
#endif
// Reset cookies used to track start and end of the protected region in synchronized methods
syncStartEmitCookie = NULL;
syncEndEmitCookie = NULL;
}
#endif // _TARGET_X86_
/* Do we need to do runtime call out to check the security? */
if (tiRuntimeCalloutNeeded)
{
GenTreePtr tree;
/* Insert the expression "call verificationRuntimeCheck(MethodHnd)" */
tree = gtNewIconEmbMethHndNode(info.compMethodHnd);
tree = gtNewHelperCallNode(CORINFO_HELP_VERIFICATION_RUNTIME_CHECK,
TYP_VOID, 0,
gtNewArgList(tree));
/* Create a new basic block and stick the call in it */
fgEnsureFirstBBisScratch();
fgInsertStmtAtEnd(fgFirstBB, tree);
#ifdef DEBUG
if (verbose)
{
printf("\ntiRuntimeCalloutNeeded - Call verificationRuntimeCheck(%08p) statement in first basic block [%08p]\n", dspPtr(info.compMethodHnd), dspPtr(fgFirstBB));
gtDispTree(tree);
printf("\n");
}
#endif
}
//
// Add 'return' expression to the return block if we made it as "oneReturn" before.
//
if (oneReturn)
{
GenTreePtr tree;
//
// Make the 'return' expression.
//
// spill any value that is currently in the oneReturnStmtNode
if (oneReturnStmtNode != NULL)
{
fgInsertStmtAtEnd(genReturnBB, oneReturnStmtNode);
oneReturnStmtNode = NULL;
}
//make sure to reload the return value as part of the return (it is saved by the "real return").
if (genReturnLocal != BAD_VAR_NUM)
{
noway_assert(info.compRetType != TYP_VOID && info.compRetNativeType != TYP_STRUCT);
GenTreePtr retTemp = gtNewLclvNode(genReturnLocal, lvaTable[genReturnLocal].TypeGet());
//make sure copy prop ignores this node (make sure it always does a reload from the temp).
retTemp->gtFlags |= GTF_DONT_CSE;
tree = gtNewOperNode(GT_RETURN, retTemp->gtType, retTemp);
}
else
{
noway_assert(info.compRetType == TYP_VOID || info.compRetType == TYP_STRUCT);
// return void
tree = new (this, GT_RETURN) GenTreeOp(GT_RETURN, TYP_VOID );
}
/* Add 'return' expression to the return block */
noway_assert(genReturnBB);
fgInsertStmtAtEnd(genReturnBB, tree);
#ifdef DEBUG
if (verbose)
{
printf("\noneReturn statement tree ");
printTreeID(tree);
printf(" added to genReturnBB [%08p]\n", dspPtr(genReturnBB));
gtDispTree(tree);
printf("\n");
}
#endif
}
#ifdef DEBUG
if (verbose)
{
printf("\n*************** After fgAddInternal()\n");
fgDispBasicBlocks();
fgDispHandlerTab();
}
#endif
}
/*****************************************************************************
*
* Create a new statement from tree and wire the links up.
*/
GenTreeStmt* Compiler::fgNewStmtFromTree(GenTreePtr tree, BasicBlock* block, IL_OFFSETX offs)
{
GenTreeStmt* stmt = gtNewStmt(tree, offs);
gtSetStmtInfo(stmt);
fgSetStmtSeq(stmt);
#if DEBUG
if (block != nullptr)
{
fgDebugCheckNodeLinks(block, stmt);
}
#endif
return stmt;
}
GenTreeStmt* Compiler::fgNewStmtFromTree(GenTreePtr tree)
{
return fgNewStmtFromTree(tree, nullptr, BAD_IL_OFFSET);
}
GenTreeStmt* Compiler::fgNewStmtFromTree(GenTreePtr tree, BasicBlock* block)
{
return fgNewStmtFromTree(tree, block, BAD_IL_OFFSET);
}
GenTreeStmt* Compiler::fgNewStmtFromTree(GenTreePtr tree, IL_OFFSETX offs)
{
return fgNewStmtFromTree(tree, nullptr, offs);
}
//------------------------------------------------------------------------
// fgFindBlockILOffset: Given a block, find the IL offset corresponding to the first statement
// in the block with a legal IL offset. Skip any leading statements that have BAD_IL_OFFSET.
// If no statement has an initialized statement offset (including the case where there are
// no statements in the block), then return BAD_IL_OFFSET. This function is used when
// blocks are split or modified, and we want to maintain the IL offset as much as possible
// to preserve good debugging behavior.
//
// Arguments:
// block - The block to check.
//
// Return Value:
// The first good IL offset of a statement in the block, or BAD_IL_OFFSET if such an IL offset
// cannot be found.
//
// If we are not built with DEBUGGING_SUPPORT or DEBUG, then always report BAD_IL_OFFSET,
// since in that case statements don't contain an IL offset. The effect will be that split
// blocks will lose their IL offset information.
IL_OFFSET Compiler::fgFindBlockILOffset(BasicBlock* block)
{
#if defined(DEBUGGING_SUPPORT) || defined(DEBUG)
for (GenTree* stmt = block->bbTreeList; stmt != nullptr; stmt = stmt->gtNext)
{
assert(stmt->IsStatement());
if (stmt->gtStmt.gtStmtILoffsx != BAD_IL_OFFSET)
{
return jitGetILoffs(stmt->gtStmt.gtStmtILoffsx);
}
}
#endif // defined(DEBUGGING_SUPPORT) || defined(DEBUG)
return BAD_IL_OFFSET;
}
//------------------------------------------------------------------------------
// fgSplitBlockAtEnd - split the given block into two blocks.
// All code in the block stays in the original block.
// Control falls through from original to new block, and
// the new block is returned.
//------------------------------------------------------------------------------
BasicBlock* Compiler::fgSplitBlockAtEnd(BasicBlock* curr)
{
// We'd like to use fgNewBBafter(), but we need to update the preds list before linking in the new block.
// (We need the successors of 'curr' to be correct when we do this.)
BasicBlock* newBlock = bbNewBasicBlock(curr->bbJumpKind);
// Start the new block with no refs. When we set the preds below, this will get updated correctly.
newBlock->bbRefs = 0;
// For each successor of the original block, set the new block as their predecessor.
// Note we are using the "rational" version of the successor iterator that does not hide the finallyret arcs.
// Without these arcs, a block 'b' may not be a member of succs(preds(b))
if (curr->bbJumpKind != BBJ_SWITCH)
{
unsigned numSuccs = curr->NumSucc(this);
for (unsigned i = 0; i < numSuccs; i++)
{
BasicBlock* succ = curr->GetSucc(i, this);
if (succ != newBlock)
{
JITDUMP("BB%02u previous predecessor was BB%02u, now is BB%02u\n", succ->bbNum, curr->bbNum, newBlock->bbNum);
fgReplacePred(succ, curr, newBlock);
}
}
newBlock->bbJumpDest = curr->bbJumpDest;
curr->bbJumpDest = nullptr;
}
else
{
// In the case of a switch statement there's more complicated logic in order to wire up the predecessor lists
// but fortunately there's an existing method that implements this functionality.
newBlock->bbJumpSwt = curr->bbJumpSwt;
fgChangeSwitchBlock(curr, newBlock);
curr->bbJumpSwt = nullptr;
}
newBlock->inheritWeight(curr);
// Set the new block's flags. Note that the new block isn't BBF_INTERNAL unless the old block is.
newBlock->bbFlags = curr->bbFlags;
// Remove flags that the new block can't have.
newBlock->bbFlags &= ~(BBF_TRY_BEG | BBF_LOOP_HEAD | BBF_LOOP_CALL0 | BBF_LOOP_CALL1 | BBF_HAS_LABEL | BBF_JMP_TARGET |
BBF_FUNCLET_BEG | BBF_LOOP_PREHEADER | BBF_KEEP_BBJ_ALWAYS);
// Remove the GC safe bit on the new block. It seems clear that if we split 'curr' at the end,
// such that all the code is left in 'curr', and 'newBlock' just gets the control flow, then
// both 'curr' and 'newBlock' could accurately retain an existing GC safe bit. However, callers
// use this function to split blocks in the middle, or at the beginning, and they don't seem to
// be careful about updating this flag appropriately. So, removing the GC safe bit is simply
// conservative: some functions might end up being fully interruptible that could be partially
// interruptible if we exercised more care here.
newBlock->bbFlags &= ~BBF_GC_SAFE_POINT;
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
newBlock->bbFlags &= ~(BBF_FINALLY_TARGET);
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// The new block has no code, so we leave bbCodeOffs/bbCodeOffsEnd set to BAD_IL_OFFSET. If a caller
// puts code in the block, then it needs to update these.
// Insert the new block in the block list after the 'curr' block.
fgInsertBBafter(curr, newBlock);
fgExtendEHRegionAfter(curr); // The new block is in the same EH region as the old block.
// Remove flags from the old block that are no longer possible.
curr->bbFlags &= ~(BBF_HAS_JMP | BBF_RETLESS_CALL);
// Default to fallthru, and add the arc for that.
curr->bbJumpKind = BBJ_NONE;
fgAddRefPred(newBlock, curr);
return newBlock;
}
//------------------------------------------------------------------------------
// fgSplitBlockAfterStatement - Split the given block, with all code after
// the given statement going into the second block.
//------------------------------------------------------------------------------
BasicBlock* Compiler::fgSplitBlockAfterStatement(BasicBlock* curr, GenTree* stmt)
{
BasicBlock* newBlock = fgSplitBlockAtEnd(curr);
if (stmt)
{
newBlock->bbTreeList = stmt->gtNext;
if (newBlock->bbTreeList)
{
newBlock->bbTreeList->gtPrev = curr->bbTreeList->gtPrev;
}
curr->bbTreeList->gtPrev = stmt;
stmt->gtNext = NULL;
// Update the IL offsets of the blocks to match the split.
assert(newBlock->bbCodeOffs == BAD_IL_OFFSET);
assert(newBlock->bbCodeOffsEnd == BAD_IL_OFFSET);
// curr->bbCodeOffs remains the same
newBlock->bbCodeOffsEnd = curr->bbCodeOffsEnd;
IL_OFFSET splitPointILOffset = fgFindBlockILOffset(newBlock);
curr->bbCodeOffsEnd = splitPointILOffset;
newBlock->bbCodeOffs = splitPointILOffset;
}
else
{
assert(curr->bbTreeList == nullptr); // if no tree was given then it better be an empty block
}
return newBlock;
}
//------------------------------------------------------------------------------
// fgSplitBlockAtBeginning - Split the given block into two blocks.
// Control falls through from original to new block,
// and the new block is returned.
// All code in the original block goes into the new block
//------------------------------------------------------------------------------
BasicBlock* Compiler::fgSplitBlockAtBeginning(BasicBlock* curr)
{
BasicBlock* newBlock = fgSplitBlockAtEnd(curr);
newBlock->bbTreeList = curr->bbTreeList;
curr->bbTreeList = NULL;
// The new block now has all the code, and the old block has none. Update the
// IL offsets for the block to reflect this.
newBlock->bbCodeOffs = curr->bbCodeOffs;
newBlock->bbCodeOffsEnd = curr->bbCodeOffsEnd;
curr->bbCodeOffs = BAD_IL_OFFSET;
curr->bbCodeOffsEnd = BAD_IL_OFFSET;
return newBlock;
}
//------------------------------------------------------------------------
// fgSplitEdge: Splits the edge between a block 'curr' and its successor 'succ' by creating a new block
// that replaces 'succ' as a successor of 'curr', and which branches unconditionally
// to (or falls through to) 'succ'. Note that for a BBJ_COND block 'curr',
// 'succ' might be the fall-through path or the branch path from 'curr'.
//
// Arguments:
// curr - A block which branches conditionally to 'succ'
// succ - The target block
//
// Return Value:
// Returns a new block, that is a successor of 'curr' and which branches unconditionally to 'succ'
//
// Assumptions:
// 'curr' must have a bbJumpKind of BBJ_COND or BBJ_SWITCH
//
// Notes:
// The returned block is empty.
BasicBlock* Compiler::fgSplitEdge(BasicBlock* curr, BasicBlock* succ)
{
assert(curr->bbJumpKind == BBJ_COND || curr->bbJumpKind == BBJ_SWITCH);
assert(fgGetPredForBlock(succ, curr) != nullptr);
BasicBlock* newBlock;
if (succ == curr->bbNext)
{
// The successor is the fall-through path of a BBJ_COND, or
// an immediately following block of a BBJ_SWITCH (which has
// no fall-through path). For this case, simply insert a new
// fall-through block after 'curr'.
newBlock = fgNewBBafter(BBJ_NONE, curr, true /*extendRegion*/);
}
else
{
newBlock = fgNewBBinRegion(BBJ_ALWAYS, curr, curr->isRunRarely());
// The new block always jumps to 'succ'
newBlock->bbJumpDest = succ;
}
newBlock->bbFlags |= (curr->bbFlags & succ->bbFlags & (BBF_BACKWARD_JUMP));
JITDUMP("Splitting edge from BB%02u to BB%02u; adding BB%02u\n", curr->bbNum, succ->bbNum, newBlock->bbNum);
if (curr->bbJumpKind == BBJ_COND)
{
fgReplacePred(succ, curr, newBlock);
if (curr->bbJumpDest == succ)
{
// Now 'curr' jumps to newBlock
curr->bbJumpDest = newBlock;
newBlock->bbFlags |= BBF_JMP_TARGET;
}
fgAddRefPred(newBlock, curr);
}
else
{
assert(curr->bbJumpKind == BBJ_SWITCH);
// newBlock replaces 'succ' in the switch.
fgReplaceSwitchJumpTarget(curr, newBlock, succ);
// And 'succ' has 'newBlock' as a new predecessor.
fgAddRefPred(succ, newBlock);
}
// This isn't accurate, but it is complex to compute a reasonable number so just assume that we take the
// branch 50% of the time.
newBlock->inheritWeightPercentage(curr, 50);
// The bbLiveIn and bbLiveOut are both equal to the bbLiveIn of 'succ'
if (fgLocalVarLivenessDone)
{
VarSetOps::Assign(this, newBlock->bbLiveIn, succ->bbLiveIn);
VarSetOps::Assign(this, newBlock->bbLiveOut, succ->bbLiveIn);
}
return newBlock;
}
#if FEATURE_STACK_FP_X87
/*****************************************************************************/
/*****************************************************************************/
void Compiler::fgComputeFPlvls(GenTreePtr tree)
{
genTreeOps oper;
unsigned kind;
bool isflt;
unsigned savFPstkLevel;
noway_assert(tree);
noway_assert(tree->gtOper != GT_STMT);
/* Figure out what kind of a node we have */
oper = tree->OperGet();
kind = tree->OperKind();
isflt = varTypeIsFloating(tree->TypeGet()) ? 1 : 0;
/* Is this a constant or leaf node? */
if (kind & (GTK_CONST|GTK_LEAF))
{
codeGen->genFPstkLevel += isflt;
goto DONE;
}
/* Is it a 'simple' unary/binary operator? */
if (kind & GTK_SMPOP)
{
GenTreePtr op1 = tree->gtOp.gtOp1;
GenTreePtr op2 = tree->gtGetOp2();
/* Check for some special cases */
switch (oper)
{
case GT_IND:
fgComputeFPlvls(op1);
/* Indirect loads of FP values push a new value on the FP stack */
codeGen->genFPstkLevel += isflt;
goto DONE;
case GT_CAST:
fgComputeFPlvls(op1);
/* Casts between non-FP and FP push on / pop from the FP stack */
if (varTypeIsFloating(op1->TypeGet()))
{
if (isflt == false)
codeGen->genFPstkLevel--;
}
else
{
if (isflt != false)
codeGen->genFPstkLevel++;
}
goto DONE;
case GT_LIST: /* GT_LIST presumably part of an argument list */
case GT_COMMA: /* Comma tosses the result of the left operand */
savFPstkLevel = codeGen->genFPstkLevel;
fgComputeFPlvls(op1);
codeGen->genFPstkLevel = savFPstkLevel;
if (op2)
fgComputeFPlvls(op2);
goto DONE;
default:
break;
}
if (!op1)
{
if (!op2)
goto DONE;
fgComputeFPlvls(op2);
goto DONE;
}
if (!op2)
{
fgComputeFPlvls(op1);
if (oper == GT_ADDR)
{
/* If the operand was floating point pop the value from the stack */
if (varTypeIsFloating(op1->TypeGet()))
{
noway_assert(codeGen->genFPstkLevel);
codeGen->genFPstkLevel--;
}
}
// This is a special case to handle the following
// optimization: conv.i4(round.d(d)) -> round.i(d)
if (oper==GT_MATH && tree->gtMath.gtMathFN==CORINFO_INTRINSIC_Round &&
tree->TypeGet()==TYP_INT)
{
codeGen->genFPstkLevel--;
}
goto DONE;
}
/* FP assignments need a bit special handling */
if (isflt && (kind & GTK_ASGOP))
{
/* The target of the assignment won't get pushed */
if (tree->gtFlags & GTF_REVERSE_OPS)
{
fgComputeFPlvls(op2);
fgComputeFPlvls(op1);
op1->gtFPlvl--;
codeGen->genFPstkLevel--;
}
else
{
fgComputeFPlvls(op1);
op1->gtFPlvl--;
codeGen->genFPstkLevel--;
fgComputeFPlvls(op2);
}
codeGen->genFPstkLevel--;
goto DONE;
}
/* Here we have a binary operator; visit operands in proper order */
if (tree->gtFlags & GTF_REVERSE_OPS)
{
fgComputeFPlvls(op2);
fgComputeFPlvls(op1);
}
else
{
fgComputeFPlvls(op1);
fgComputeFPlvls(op2);
}
/*
Binary FP operators pop 2 operands and produce 1 result;
assignments consume 1 value and don't produce any.
*/
if (isflt)
codeGen->genFPstkLevel--;
/* Float compares remove both operands from the FP stack */
if (kind & GTK_RELOP)
{
if (varTypeIsFloating(op1->TypeGet()))
codeGen->genFPstkLevel -= 2;
}
goto DONE;
}
/* See what kind of a special operator we have here */
switch (oper)
{
case GT_FIELD:
fgComputeFPlvls(tree->gtField.gtFldObj);
codeGen->genFPstkLevel += isflt;
break;
case GT_CALL:
if (tree->gtCall.gtCallObjp)
fgComputeFPlvls(tree->gtCall.gtCallObjp);
if (tree->gtCall.gtCallArgs)
{
savFPstkLevel = codeGen->genFPstkLevel;
fgComputeFPlvls(tree->gtCall.gtCallArgs);
codeGen->genFPstkLevel = savFPstkLevel;
}
if (tree->gtCall.gtCallLateArgs)
{
savFPstkLevel = codeGen->genFPstkLevel;
fgComputeFPlvls(tree->gtCall.gtCallLateArgs);
codeGen->genFPstkLevel = savFPstkLevel;
}
codeGen->genFPstkLevel += isflt;
break;
case GT_ARR_ELEM:
fgComputeFPlvls(tree->gtArrElem.gtArrObj);
unsigned dim;
for (dim = 0; dim < tree->gtArrElem.gtArrRank; dim++)
fgComputeFPlvls(tree->gtArrElem.gtArrInds[dim]);
/* Loads of FP values push a new value on the FP stack */
codeGen->genFPstkLevel += isflt;
break;
case GT_CMPXCHG:
//Evaluate the trees left to right
fgComputeFPlvls(tree->gtCmpXchg.gtOpLocation);
fgComputeFPlvls(tree->gtCmpXchg.gtOpValue);
fgComputeFPlvls(tree->gtCmpXchg.gtOpComparand);
noway_assert(!isflt);
break;
case GT_ARR_BOUNDS_CHECK:
fgComputeFPlvls(tree->gtBoundsChk.gtArrLen);
fgComputeFPlvls(tree->gtBoundsChk.gtIndex);
noway_assert(!isflt);
break;
#ifdef DEBUG
default:
noway_assert(!"Unhandled special operator in fgComputeFPlvls()");
break;
#endif
}
DONE:
noway_assert((unsigned char)codeGen->genFPstkLevel == codeGen->genFPstkLevel);
tree->gtFPlvl = (unsigned char)codeGen->genFPstkLevel;
}
#endif // FEATURE_STACK_FP_X87
/*****************************************************************************/
/*****************************************************************************/
void Compiler::fgFindOperOrder()
{
#ifdef DEBUG
if (verbose)
printf("*************** In fgFindOperOrder()\n");
#endif
BasicBlock* block;
GenTreeStmt* stmt;
/* Walk the basic blocks and for each statement determine
* the evaluation order, cost, FP levels, etc... */
for (block = fgFirstBB; block; block = block->bbNext)
{
compCurBB = block;
for (stmt = block->firstStmt(); stmt; stmt = stmt->gtNextStmt)
{
/* Recursively process the statement */
gtSetStmtInfo(stmt);
}
}
}
/*****************************************************************************/
void Compiler::fgSimpleLowering()
{
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
// Walk the statement trees in this basic block, converting ArrLength nodes.
compCurBB = block; // Used in fgRngChkTarget.
#if JIT_FEATURE_SSA_SKIP_DEFS
for (GenTreeStmt* stmt = block->FirstNonPhiDef(); stmt; stmt = stmt->gtNextStmt)
#else
for (GenTreeStmt* stmt = block->firstStmt(); stmt; stmt = stmt->gtNextStmt)
#endif
{
for (GenTreePtr tree = stmt->gtStmtList; tree; tree = tree->gtNext)
{
if (tree->gtOper == GT_ARR_LENGTH)
{
GenTreeArrLen* arrLen = tree->AsArrLen();
GenTreePtr arr = arrLen->gtArrLen.ArrRef();
GenTreePtr add;
GenTreePtr con;
/* Create the expression "*(array_addr + ArrLenOffs)" */
noway_assert(arr->gtNext == tree);
noway_assert(arrLen->ArrLenOffset() == offsetof(CORINFO_Array, length) ||
arrLen->ArrLenOffset() == offsetof(CORINFO_String, stringLen));
if ((arr->gtOper == GT_CNS_INT) &&
(arr->gtIntCon.gtIconVal == 0))
{
// If the array is NULL, then we should get a NULL reference
// exception when computing its length. We need to maintain
// an invariant where there is no sum of two constants node, so
// let's simply return an indirection of NULL.
add = arr;
}
else
{
con = gtNewIconNode(arrLen->ArrLenOffset(), TYP_I_IMPL);
con->gtRsvdRegs = 0;
con->gtCopyFPlvl(arr);
add = gtNewOperNode(GT_ADD, TYP_REF, arr, con);
add->gtRsvdRegs = arr->gtRsvdRegs;
add->gtCopyFPlvl(arr);
add->CopyCosts(arr);
arr->gtNext = con;
con->gtPrev = arr;
con->gtNext = add;
add->gtPrev = con;
add->gtNext = tree;
tree->gtPrev = add;
}
// Change to a GT_IND.
tree->ChangeOperUnchecked(GT_IND);
tree->gtOp.gtOp1 = add;
}
else if (tree->OperGet() == GT_ARR_BOUNDS_CHECK
#ifdef FEATURE_SIMD
|| tree->OperGet() == GT_SIMD_CHK
#endif // FEATURE_SIMD
)
{
// Add in a call to an error routine.
fgSetRngChkTarget(tree, false);
}
}
}
}
#ifdef DEBUG
if (verbose && fgRngChkThrowAdded)
{
printf("\nAfter fgSimpleLowering() added some RngChk throw blocks");
fgDispBasicBlocks();
fgDispHandlerTab();
printf("\n");
}
#endif
}
/*****************************************************************************
*/
void Compiler::fgUpdateRefCntForClone(BasicBlock* addedToBlock,
GenTreePtr clonedTree)
{
assert(clonedTree->gtOper != GT_STMT);
if (lvaLocalVarRefCounted)
{
compCurBB = addedToBlock;
fgWalkTreePre(&clonedTree, Compiler::lvaIncRefCntsCB, (void *)this, true);
}
}
/*****************************************************************************
*/
void Compiler::fgUpdateRefCntForExtract(GenTreePtr wholeTree,
GenTreePtr keptTree)
{
if (lvaLocalVarRefCounted)
{
/* Update the refCnts of removed lcl vars - The problem is that
* we have to consider back the side effects trees so we first
* increment all refCnts for side effects then decrement everything
* in the statement
*/
if (keptTree)
{
fgWalkTreePre(&keptTree, Compiler::lvaIncRefCntsCB, (void *)this, true);
}
fgWalkTreePre( &wholeTree, Compiler::lvaDecRefCntsCB, (void *)this, true);
}
}
VARSET_VALRET_TP Compiler::fgGetVarBits(GenTreePtr tree)
{
VARSET_TP VARSET_INIT_NOCOPY(varBits, VarSetOps::MakeEmpty(this));
assert(tree->gtOper == GT_LCL_VAR ||
tree->gtOper == GT_LCL_FLD ||
tree->gtOper == GT_REG_VAR);
unsigned int lclNum = tree->gtLclVarCommon.gtLclNum;
LclVarDsc* varDsc = lvaTable + lclNum;
if (varDsc->lvTracked)
{
VarSetOps::AddElemD(this, varBits, varDsc->lvVarIndex);
}
else if (varDsc->lvType == TYP_STRUCT && varDsc->lvPromoted)
{
for (unsigned i = varDsc->lvFieldLclStart;
i < varDsc->lvFieldLclStart + varDsc->lvFieldCnt;
++i)
{
noway_assert(lvaTable[i].lvIsStructField);
if (lvaTable[i].lvTracked)
{
unsigned varIndex = lvaTable[i].lvVarIndex;
noway_assert(varIndex < lvaTrackedCount);
VarSetOps::AddElemD(this, varBits, varIndex);
}
}
}
return varBits;
}
/*****************************************************************************
*
* Find and remove any basic blocks that are useless (e.g. they have not been
* imported because they are not reachable, or they have been optimized away).
*/
void Compiler::fgRemoveEmptyBlocks()
{
BasicBlock* cur;
BasicBlock* nxt;
/* If we remove any blocks, we'll have to do additional work */
unsigned removedBlks = 0;
for (cur = fgFirstBB; cur != nullptr; cur = nxt)
{
/* Get hold of the next block (in case we delete 'cur') */
nxt = cur->bbNext;
/* Should this block be removed? */
if (!(cur->bbFlags & BBF_IMPORTED))
{
noway_assert(cur->isEmpty());
if (ehCanDeleteEmptyBlock(cur))
{
/* Mark the block as removed */
cur->bbFlags |= BBF_REMOVED;
/* Remember that we've removed a block from the list */
removedBlks++;
#ifdef DEBUG
if (verbose)
{
printf("BB%02u was not imported, marked as removed (%d)\n",
cur->bbNum, removedBlks);
}
#endif // DEBUG
/* Drop the block from the list */
fgUnlinkBlock(cur);
}
else
{
// We were prevented from deleting this block by EH normalization. Mark the block as imported.
cur->bbFlags |= BBF_IMPORTED;
}
}
}
/* If no blocks were removed, we're done */
if (removedBlks == 0)
return;
/* Update all references in the exception handler table.
* Mark the new blocks as non-removable.
*
* We may have made the entire try block unreachable.
* Check for this case and remove the entry from the EH table.
*/
unsigned XTnum;
EHblkDsc* HBtab;
INDEBUG(unsigned delCnt = 0;)
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
AGAIN:
/* If the beginning of the try block was not imported, we
* need to remove the entry from the EH table. */
if (HBtab->ebdTryBeg->bbFlags & BBF_REMOVED)
{
noway_assert(!(HBtab->ebdTryBeg->bbFlags & BBF_IMPORTED));
#ifdef DEBUG
if (verbose)
{
printf("Beginning of try block (BB%02u) not imported "
"- remove index #%u from the EH table\n",
HBtab->ebdTryBeg->bbNum,
XTnum + delCnt);
}
delCnt++;
#endif // DEBUG
fgRemoveEHTableEntry(XTnum);
if (XTnum < compHndBBtabCount)
{
// There are more entries left to process, so do more. Note that
// HBtab now points to the next entry, that we copied down to the
// current slot. XTnum also stays the same.
goto AGAIN;
}
break; // no more entries (we deleted the last one), so exit the loop
}
/* At this point we know we have a valid try block */
#ifdef DEBUG
assert(HBtab->ebdTryBeg->bbFlags & BBF_IMPORTED);
assert(HBtab->ebdTryBeg->bbFlags & BBF_DONT_REMOVE);
assert(HBtab->ebdHndBeg->bbFlags & BBF_IMPORTED);
assert(HBtab->ebdHndBeg->bbFlags & BBF_DONT_REMOVE);
if (HBtab->HasFilter())
{
assert(HBtab->ebdFilter->bbFlags & BBF_IMPORTED);
assert(HBtab->ebdFilter->bbFlags & BBF_DONT_REMOVE);
}
#endif // DEBUG
fgSkipRmvdBlocks(HBtab);
} /* end of the for loop over XTnum */
// Renumber the basic blocks
JITDUMP("\nRenumbering the basic blocks for fgRemoveEmptyBlocks\n");
fgRenumberBlocks();
#ifdef DEBUG
fgVerifyHandlerTab();
#endif // DEBUG
}
/*****************************************************************************
* fgRemoveLinearOrderDependencies --
*
* Remove stmt dependencies before removing the stmt itself.
*
* If called on a top level statement,
*
* All the first level (in a breadth-first order) embedded statements now become top
* level statements. In a comma world, it is analogous to retaining the exprs
* within the commas of a statement.
*
* If called on an embedded statement,
*
* Then the statement rooting the embedded statement's next links are
* correctly updated to point to any nested embedded statement nodes or
* the sibling embedded nodes and their prev links are updated to the
* rooting statement. Also the nodes of the embedded statement on which
* we are called are dropped from the list.
*
* Assumptions:
* "stmt" should be detached from the bbTreeList after the call.
*
*/
void Compiler::fgRemoveLinearOrderDependencies(GenTreePtr tree)
{
assert(fgOrder == FGOrderLinear);
GenTreeStmt* stmt = tree->AsStmt();
// No embedded statements.
if (stmt->gtStmtIsTopLevel() &&
(stmt->gtNext == nullptr || stmt->gtNextStmt->gtStmtIsTopLevel()))
{
return;
}
// stmt is last embedded statement, assume we have a tree order: prevStmt->stmt->nextStmt.
// We are dropping "stmt". So fix the next link for "prevStmt" and prev link for "nextStmt".
if (stmt->gtStmtIsEmbedded() &&
(stmt->gtNext == nullptr || stmt->gtNextStmt->gtStmtIsTopLevel()))
{
if (stmt->gtStmtList->gtPrev)
{
stmt->gtStmtList->gtPrev->gtNext = stmt->gtStmtExpr->gtNext;
}
if (stmt->gtStmtExpr->gtNext)
{
stmt->gtStmtExpr->gtNext->gtPrev = stmt->gtStmtList->gtPrev;
}
return;
}
//
// Walk the tree list, and define current statement as
// the immediate statement (embedded or top) in which
// the tree resides.
//
// Initially, next = stmt, cur is empty.
//
// While walking the tree list, we expect to see:
// 1. next stmt's list
// 2. or current stmt's expr
//
// If current stmt's expr is seen, pop to previous
// next and call it current.
// If next stmt's list is seen, then next becomes current.
//
ArrayStack<GenTreePtr> stack(this);
// Consider this example:
//
// In stmt order:
// (top (stmt (emb2, emb3) ) ) where "top" embeds "stmt" and "stmt"
// nests "emb2" and "emb3". Now we are removing "stmt."
//
// In the end we should obtain:
// (top (emb2, emb3) ). Callers should fix bbTreeList. We only fix tree order.
//
// So in tree order:
// BEFORE: top:t1 -> stmt:t1 -> emb2:t1 -> stmt:t2 -> emb3:t1 -> stmt:t3 -> top:t2
// AFTER : top:t1 -> emb2:t1 -> emb3:t1 -> top:t2
//
GenTreePtr lastNestEmbedNode = stmt->gtStmtList->gtPrev; // In the example, top:t1.
GenTreePtr next = stmt;
GenTreePtr node = stmt->gtStmtList;
while (node != stmt->gtStmtExpr->gtNext)
{
// We are encountering a new stmt. Push it into the stack. It is now current.
if (next != nullptr && node == next->gtStmt.gtStmtList)
{
stack.Push(next);
next = next->gtNext;
// Since stack height is 2, we are entering the next level embedded statement
// from stmt's level which is 1. Reminder: stmt is being removed.
//
// If stmt is top level, all level 2 stmts will become top level.
// So don't fix their prev next links.
if (stmt->gtStmtIsEmbedded() && stack.Height() == 2)
{
//
// Two cases:
// Case 1 (Initial case -- we are discovering the first embedded stmt):
// Before:
// topList -> stmtList -> emb2List -> emb2Expr -> ... -> stmtExpr -> topExpr
// Currently: "node" is emb2List and "lastNestEmbedNode" is topList. We started the iteration from stmtList.
// After:
// topList -> emb2List -> emb2Expr -> ... -> stmtExpr -> topExpr.
//
// Case 2 (We already discovered an embedded stmt):
// Before:
// ... -> emb2List -> emb2Expr -> stmtNode -> stmtNode -> emb3List -> emb3Expr -> stmtNode -> ... -> stmtExpr
// Currently, "node" is emb3List and "lastNestEmbedNode" is emb2Expr.
// After:
// ... -> emb2List -> emb2Expr -> -> emb3List -> emb3Expr -> stmtNode -> ... -> stmtExpr
//
// Drop stmtNodes that occur between emb2Expr and emb3List.
if (lastNestEmbedNode)
{
lastNestEmbedNode->gtNext = node;
}
node->gtPrev = lastNestEmbedNode;
}
}
GenTreePtr cur = stack.Top();
if (node == cur->gtStmt.gtStmtExpr)
{
// A stmt goes out of being current.
stack.Pop();
// Keep track of the last nested embedded stmt node. In the example, record emb2Expr or emb3Expr.
if (stack.Height() == 1)
{
lastNestEmbedNode = node;
}
// Are we called on a top level statement?
if (stmt->gtStmtIsTopLevel() && stack.Height() == 1)
{
// We are just done visiting the last node of a first level embedded stmt.
// Before:
// stmtList -> emb2List -> emb2Expr -> stmtNode -> stmtNode -> emb3List -> emb3Expr -> stmtNode -> ... -> stmtExpr
// "stmt" is top level.
//
// Currently, "node" is emb2Expr and "lastNestEmbedNode" is "don't care".
//
// After:
// node = stmtNode -> stmtNode -> emb3List -> emb3Expr -> stmtNode -> ... -> stmtExpr
// nullptr <- emb2List -> emb2Expr -> nullptr
//
// stmtList -> emb2List -> emb2Expr -> ...
// This is inconsistent for stmt, as there is no first level embedded statement now, but since callers
// are supposed to remove stmt, we don't care.
//
// Advance node to next, so we don't set node->next to nullptr below.
node = node->gtNext;
noway_assert(cur->gtStmt.gtStmtIsEmbedded());
// This embedded stmt is now top level since the original top level stmt
// is going to be removed.
cur->gtFlags |= GTF_STMT_TOP_LEVEL;
cur->gtStmt.gtStmtList->gtPrev = nullptr;
cur->gtStmt.gtStmtExpr->gtNext = nullptr;
// Don't bother updating stmt's pointers, as we are removing it.
continue;
}
}
node = node->gtNext;
}
// Are we called on an embedded stmt?
if (stmt->gtStmtIsEmbedded())
{
//
// Before:
// ... -> emb2List -> emb2Expr -> stmtNode -> stmtNode -> emb3List -> emb3Expr -> stmtNode -> ... -> stmtExpr -> topNode
//
// Currently, "node" is topNode (i.e., stmtExpr->gtNext) and "lastNestEmbedNode" is emb3Expr.
//
// After:
// ... -> emb2List -> emb2Expr -> -> emb3List -> emb3Expr -> -> topNode
//
if (node)
{
node->gtPrev = lastNestEmbedNode;
}
if (lastNestEmbedNode)
{
lastNestEmbedNode->gtNext = node;
}
}
}
/*****************************************************************************
*
* Remove a useless statement from a basic block.
* The default is to decrement ref counts of included vars
*
*/
void Compiler::fgRemoveStmt(BasicBlock* block,
GenTreePtr node,
// whether to decrement ref counts for tracked vars in statement
bool updateRefCount)
{
noway_assert(node);
GenTreeStmt* tree = block->firstStmt();
GenTreeStmt* stmt = node->AsStmt();
#ifdef DEBUG
if (verbose && stmt->gtStmtExpr->gtOper != GT_NOP) // Don't print if it is a GT_NOP. Too much noise from the inliner.
{
printf("\nRemoving statement ");
printTreeID(stmt);
printf(" in BB%02u as useless:\n", block->bbNum);
gtDispTree(stmt);
}
#endif // DEBUG
if (opts.compDbgCode &&
stmt->gtPrev != stmt &&
stmt->gtStmtILoffsx != BAD_IL_OFFSET)
{
/* TODO: For debuggable code, should we remove significant
statement boundaries. Or should we leave a GT_NO_OP in its place? */
}
if (fgOrder == FGOrderLinear)
{
fgRemoveLinearOrderDependencies(stmt);
}
/* Is it the first statement in the list? */
GenTreeStmt* firstStmt = block->firstStmt();
if (firstStmt == stmt)
{
if (firstStmt->gtNext == nullptr)
{
assert(firstStmt == block->lastStmt());
/* this is the only statement - basic block becomes empty */
block->bbTreeList = nullptr;
}
else
{
block->bbTreeList = tree->gtNext;
block->bbTreeList->gtPrev = tree->gtPrev;
}
goto DONE;
}
/* Is it the last statement in the list? */
if (stmt == block->lastStmt())
{
stmt->gtPrev->gtNext = nullptr;
block->bbTreeList->gtPrev = stmt->gtPrev;
goto DONE;
}
tree = stmt->gtPrevStmt;
noway_assert(tree);
tree->gtNext = stmt->gtNext;
stmt->gtNext->gtPrev = tree;
DONE:
fgStmtRemoved = true;
if (optValnumCSE_phase)
{
optValnumCSE_UnmarkCSEs(stmt->gtStmtExpr, nullptr);
}
else
{
if (updateRefCount)
{
if (fgStmtListThreaded)
{
fgWalkTreePre(&stmt->gtStmtExpr,
Compiler::lvaDecRefCntsCB,
(void*) this,
true);
}
}
}
#ifdef DEBUG
if (verbose)
{
if (block->bbTreeList == 0)
{
printf("\nBB%02u becomes empty", block->bbNum);
}
printf("\n");
}
#endif // DEBUG
}
/******************************************************************************/
// Returns true if the operator is involved in control-flow
// TODO-Cleanup: Move this into genTreeKinds in genTree.h
inline
bool OperIsControlFlow(genTreeOps oper)
{
switch (oper)
{
case GT_JTRUE:
case GT_SWITCH:
case GT_LABEL:
case GT_CALL:
case GT_JMP:
case GT_RETURN:
case GT_RETFILT:
#if !FEATURE_EH_FUNCLETS
case GT_END_LFIN:
#endif // !FEATURE_EH_FUNCLETS
return true;
default:
return false;
}
}
/******************************************************************************
* Tries to throw away a stmt. The statement can be anywhere in block->bbTreeList.
* Returns true if it did remove the statement.
*/
bool Compiler::fgCheckRemoveStmt(BasicBlock* block, GenTreePtr node)
{
if (opts.compDbgCode)
return false;
GenTreeStmt* stmt = node->AsStmt();
GenTreePtr tree = stmt->gtStmtExpr;
genTreeOps oper = tree->OperGet();
if (OperIsControlFlow(oper) || oper == GT_NO_OP)
return false;
// TODO: Use a recursive version of gtNodeHasSideEffects()
if (tree->gtFlags & GTF_SIDE_EFFECT)
return false;
fgRemoveStmt(block, stmt);
return true;
}
/****************************************************************************************************
*
*
*/
bool Compiler::fgCanCompactBlocks(BasicBlock* block, BasicBlock* bNext)
{
if ((block == NULL) || (bNext == NULL))
return false;
noway_assert(block->bbNext == bNext);
if (block->bbJumpKind != BBJ_NONE)
return false;
// If the next block has multiple incoming edges, we can still compact if the first block is empty.
// However, not if it is the beginning of a handler.
if (bNext->countOfInEdges() != 1 &&
(!block->isEmpty() || (block->bbFlags & BBF_FUNCLET_BEG) || (block->bbCatchTyp != BBCT_NONE)))
return false;
if (bNext->bbFlags & BBF_DONT_REMOVE)
return false;
// Don't compact the first block if it was specially created as a scratch block.
if (fgBBisScratch(block))
return false;
#if defined(_TARGET_ARM_)
// We can't compact a finally target block, as we need to generate special code for such blocks during code generation
if ((bNext->bbFlags & BBF_FINALLY_TARGET) != 0)
return false;
#endif
// We don't want to compact blocks that are in different Hot/Cold regions
//
if (fgInDifferentRegions(block, bNext))
{
return false;
}
// We cannot compact two blocks in different EH regions.
//
if (fgCanRelocateEHRegions)
{
if (!BasicBlock::sameEHRegion(block, bNext))
{
return false;
}
}
// if there is a switch predecessor don't bother because we'd have to update the uniquesuccs as well
// (if they are valid)
for (flowList* pred = bNext->bbPreds; pred; pred = pred->flNext)
{
if (pred->flBlock->bbJumpKind == BBJ_SWITCH)
return false;
}
return true;
}
/*****************************************************************************************************
*
* Function called to compact two given blocks in the flowgraph
* Assumes that all necessary checks have been performed,
* i.e. fgCanCompactBlocks returns true.
*
* Uses for this function - whenever we change links, insert blocks,...
* It will keep the flowgraph data in synch - bbNum, bbRefs, bbPreds
*/
void Compiler::fgCompactBlocks(BasicBlock* block, BasicBlock* bNext)
{
noway_assert(block != NULL);
noway_assert((block->bbFlags & BBF_REMOVED) == 0);
noway_assert(block->bbJumpKind == BBJ_NONE);
noway_assert(bNext == block->bbNext);
noway_assert(bNext != NULL);
noway_assert((bNext->bbFlags & BBF_REMOVED) == 0);
noway_assert(bNext->countOfInEdges() == 1 || block->isEmpty());
noway_assert(bNext->bbPreds);
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
noway_assert((bNext->bbFlags & BBF_FINALLY_TARGET) == 0);
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// Make sure the second block is not the start of a TRY block or an exception handler
noway_assert(bNext->bbCatchTyp == BBCT_NONE);
noway_assert((bNext->bbFlags & BBF_TRY_BEG) == 0);
noway_assert((bNext->bbFlags & BBF_DONT_REMOVE) == 0);
/* both or none must have an exception handler */
noway_assert(block->hasTryIndex() == bNext->hasTryIndex());
#ifdef DEBUG
if (verbose)
{
printf("\nCompacting blocks BB%02u and BB%02u:\n", block->bbNum, bNext->bbNum);
}
#endif
if (bNext->countOfInEdges() > 1)
{
JITDUMP("Second block has multiple incoming edges\n");
assert(block->isEmpty());
block->bbFlags |= BBF_JMP_TARGET;
for (flowList* pred = bNext->bbPreds; pred; pred = pred->flNext)
{
fgReplaceJumpTarget(pred->flBlock, block, bNext);
if (pred->flBlock != block)
{
fgAddRefPred(block, pred->flBlock);
}
}
bNext->bbPreds = nullptr;
}
else
{
noway_assert(bNext->bbPreds->flNext == nullptr);
noway_assert(bNext->bbPreds->flBlock == block);
}
/* Start compacting - move all the statements in the second block to the first block */
// First move any phi definitions of the second block after the phi defs of the first.
// TODO-CQ: This may be the wrong thing to do. If we're compacting blocks, it's because a
// control-flow choice was constant-folded away. So probably phi's need to go away,
// as well, in favor of one of the incoming branches. Or at least be modified.
GenTreePtr blkNonPhi1 = block->FirstNonPhiDef();
GenTreePtr bNextNonPhi1 = bNext->FirstNonPhiDef();
GenTreePtr blkFirst = block->firstStmt();
GenTreePtr bNextFirst = bNext->firstStmt();
// Does the second have any phis?
if (bNextFirst != NULL && bNextFirst != bNextNonPhi1)
{
GenTreePtr bNextLast = bNextFirst->gtPrev;
assert(bNextLast->gtNext == NULL);
// Does "blk" have phis?
if (blkNonPhi1 != blkFirst)
{
// Yes, has phis.
// Insert after the last phi of "block."
// First, bNextPhis after last phi of block.
GenTreePtr blkLastPhi;
if (blkNonPhi1 != NULL)
{
blkLastPhi = blkNonPhi1->gtPrev;
}
else
{
blkLastPhi = blkFirst->gtPrev;
}
blkLastPhi->gtNext = bNextFirst;
bNextFirst->gtPrev = blkLastPhi;
// Now, rest of "block" after last phi of "bNext".
GenTreePtr bNextLastPhi = NULL;
if (bNextNonPhi1 != NULL)
{
bNextLastPhi = bNextNonPhi1->gtPrev;
}
else
{
bNextLastPhi = bNextFirst->gtPrev;
}
bNextLastPhi->gtNext = blkNonPhi1;
if (blkNonPhi1 != NULL)
{
blkNonPhi1->gtPrev = bNextLastPhi;
}
else
{
// block has no non phis, so make the last statement be the last added phi.
blkFirst->gtPrev = bNextLastPhi;
}
// Now update the bbTreeList of "bNext".
bNext->bbTreeList = bNextNonPhi1;
if (bNextNonPhi1 != NULL)
{
bNextNonPhi1->gtPrev = bNextLast;
}
}
else
{
if (blkFirst != NULL) // If "block" has no statements, fusion will work fine...
{
// First, bNextPhis at start of block.
GenTreePtr blkLast = blkFirst->gtPrev;
block->bbTreeList = bNextFirst;
// Now, rest of "block" (if it exists) after last phi of "bNext".
GenTreePtr bNextLastPhi = NULL;
if (bNextNonPhi1 != NULL)
{
// There is a first non phi, so the last phi is before it.
bNextLastPhi = bNextNonPhi1->gtPrev;
}
else
{
// All the statements are phi defns, so the last one is the prev of the first.
bNextLastPhi = bNextFirst->gtPrev;
}
bNextFirst->gtPrev = blkLast;
bNextLastPhi->gtNext = blkFirst;
blkFirst->gtPrev = bNextLastPhi;
// Now update the bbTreeList of "bNext"
bNext->bbTreeList = bNextNonPhi1;
if (bNextNonPhi1 != NULL)
{
bNextNonPhi1->gtPrev = bNextLast;
}
}
}
}
// Now proceed with the updated bbTreeLists.
GenTreePtr stmtList1 = block->firstStmt();
GenTreePtr stmtList2 = bNext->firstStmt();
/* the block may have an empty list */
if (stmtList1)
{
GenTreePtr stmtLast1 = block->lastStmt();
/* The second block may be a GOTO statement or something with an empty bbTreeList */
if (stmtList2)
{
GenTreePtr stmtLast2 = bNext->lastStmt();
/* append list2 to list 1 */
stmtLast1->gtNext = stmtList2;
stmtList2->gtPrev = stmtLast1;
stmtList1->gtPrev = stmtLast2;
}
}
else
{
/* block was formerly empty and now has bNext's statements */
block->bbTreeList = stmtList2;
}
// Note we could update the local variable weights here by
// calling lvaMarkLocalVars, with the block and weight adjustment.
// If either block or bNext has a profile weight
// or if both block and bNext have non-zero weights
// then we select the highest weight block.
if ((block->bbFlags & BBF_PROF_WEIGHT) ||
(bNext->bbFlags & BBF_PROF_WEIGHT) ||
(block->bbWeight && bNext->bbWeight) )
{
// We are keeping block so update its fields
// when bNext has a greater weight
if (block->bbWeight < bNext->bbWeight)
{
block->bbWeight = bNext->bbWeight;
block->bbFlags |= (bNext->bbFlags & BBF_PROF_WEIGHT); // Set the profile weight flag (if necessary)
if (block->bbWeight != 0)
{
block->bbFlags &= ~BBF_RUN_RARELY; // Clear any RarelyRun flag
}
}
}
// otherwise if either block has a zero weight we select the zero weight
else
{
noway_assert((block->bbWeight == BB_ZERO_WEIGHT) || (bNext->bbWeight == BB_ZERO_WEIGHT));
block->bbWeight = BB_ZERO_WEIGHT;
block->bbFlags |= BBF_RUN_RARELY; // Set the RarelyRun flag
}
/* set the right links */
block->bbJumpKind = bNext->bbJumpKind;
VarSetOps::AssignAllowUninitRhs(this, block->bbLiveOut, bNext->bbLiveOut);
// Update the beginning and ending IL offsets (bbCodeOffs and bbCodeOffsEnd).
// Set the beginning IL offset to the minimum, and the ending offset to the maximum, of the respective blocks.
// If one block has an unknown offset, we take the other block.
// We are merging into 'block', so if its values are correct, just leave them alone.
// TODO: we should probably base this on the statements within.
if (block->bbCodeOffs == BAD_IL_OFFSET)
{
block->bbCodeOffs = bNext->bbCodeOffs; // If they are both BAD_IL_OFFSET, this doesn't change anything.
}
else if (bNext->bbCodeOffs != BAD_IL_OFFSET)
{
// The are both valid offsets; compare them.
if (block->bbCodeOffs > bNext->bbCodeOffs)
{
block->bbCodeOffs = bNext->bbCodeOffs;
}
}
if (block->bbCodeOffsEnd == BAD_IL_OFFSET)
{
block->bbCodeOffsEnd = bNext->bbCodeOffsEnd; // If they are both BAD_IL_OFFSET, this doesn't change anything.
}
else if (bNext->bbCodeOffsEnd != BAD_IL_OFFSET)
{
// The are both valid offsets; compare them.
if (block->bbCodeOffsEnd < bNext->bbCodeOffsEnd)
{
block->bbCodeOffsEnd = bNext->bbCodeOffsEnd;
}
}
if (((block->bbFlags & BBF_INTERNAL) != 0) &&
((bNext->bbFlags & BBF_INTERNAL) == 0) )
{
// If 'block' is an internal block and 'bNext' isn't, then adjust the flags set on 'block'.
block->bbFlags &= ~BBF_INTERNAL; // Clear the BBF_INTERNAL flag
block->bbFlags |= BBF_IMPORTED; // Set the BBF_IMPORTED flag
}
/* Update the flags for block with those found in bNext */
block->bbFlags |= (bNext->bbFlags & BBF_COMPACT_UPD);
/* mark bNext as removed */
bNext->bbFlags |= BBF_REMOVED;
/* Unlink bNext and update all the marker pointers if necessary */
fgUnlinkRange(block->bbNext, bNext);
// If bNext was the last block of a try or handler, update the EH table.
ehUpdateForDeletedBlock(bNext);
/* If we're collapsing a block created after the dominators are
computed, rename the block and reuse dominator information from
the other block */
if (fgDomsComputed && block->bbNum > fgDomBBcount)
{
BlockSetOps::Assign(this, block->bbReach, bNext->bbReach);
BlockSetOps::ClearD(this, bNext->bbReach);
block->bbIDom = bNext->bbIDom;
bNext->bbIDom = nullptr;
// In this case, there's no need to update the preorder and postorder numbering
// since we're changing the bbNum, this makes the basic block all set.
block->bbNum = bNext->bbNum;
}
/* Set the jump targets */
switch (bNext->bbJumpKind)
{
case BBJ_CALLFINALLY:
// Propagate RETLESS property
block->bbFlags |= (bNext->bbFlags & BBF_RETLESS_CALL);
__fallthrough;
case BBJ_COND:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
block->bbJumpDest = bNext->bbJumpDest;
/* Update the predecessor list for 'bNext->bbJumpDest' */
fgReplacePred(bNext->bbJumpDest, bNext, block);
/* Update the predecessor list for 'bNext->bbNext' if it is different than 'bNext->bbJumpDest' */
if (bNext->bbJumpKind == BBJ_COND && bNext->bbJumpDest != bNext->bbNext)
{
fgReplacePred(bNext->bbNext, bNext, block);
}
break;
case BBJ_NONE:
/* Update the predecessor list for 'bNext->bbNext' */
fgReplacePred(bNext->bbNext, bNext, block);
break;
case BBJ_EHFILTERRET:
fgReplacePred(bNext->bbJumpDest, bNext, block);
break;
case BBJ_EHFINALLYRET:
{
unsigned hndIndex = block->getHndIndex();
EHblkDsc* ehDsc = ehGetDsc(hndIndex);
if (ehDsc->HasFinallyHandler()) // No need to do this for fault handlers
{
BasicBlock* begBlk;
BasicBlock* endBlk;
ehGetCallFinallyBlockRange(hndIndex, &begBlk, &endBlk);
BasicBlock* finBeg = ehDsc->ebdHndBeg;
for (BasicBlock* bcall = begBlk; bcall != endBlk; bcall = bcall->bbNext)
{
if (bcall->bbJumpKind != BBJ_CALLFINALLY || bcall->bbJumpDest != finBeg)
continue;
noway_assert(bcall->isBBCallAlwaysPair());
fgReplacePred(bcall->bbNext, bNext, block);
}
}
}
break;
case BBJ_THROW:
case BBJ_RETURN:
/* no jumps or fall through blocks to set here */
break;
case BBJ_SWITCH:
block->bbJumpSwt = bNext->bbJumpSwt;
// We are moving the switch jump from bNext to block. Examine the jump targets
// of the BBJ_SWITCH at bNext and replace the predecessor to 'bNext' with ones to 'block'
fgChangeSwitchBlock(bNext, block);
break;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
fgUpdateLoopsAfterCompacting(block, bNext);
#if DEBUG
if (verbose && 0)
{
printf("\nAfter compacting:\n");
fgDispBasicBlocks(false);
}
#endif
#if DEBUG
static ConfigDWORD fSlowDebugChecksEnabled;
if (fSlowDebugChecksEnabled.val(CLRConfig::INTERNAL_JitSlowDebugChecksEnabled) != 0)
{
// Make sure that the predecessor lists are accurate
fgDebugCheckBBlist();
}
#endif // DEBUG
}
void Compiler::fgUpdateLoopsAfterCompacting(BasicBlock * block, BasicBlock* bNext)
{
/* Check if the removed block is not part the loop table */
noway_assert(bNext);
for (unsigned loopNum = 0; loopNum < optLoopCount; loopNum++)
{
/* Some loops may have been already removed by
* loop unrolling or conditional folding */
if (optLoopTable[loopNum].lpFlags & LPFLG_REMOVED)
continue;
/* Check the loop head (i.e. the block preceding the loop) */
if (optLoopTable[loopNum].lpHead == bNext)
{
optLoopTable[loopNum].lpHead = block;
}
/* Check the loop bottom */
if (optLoopTable[loopNum].lpBottom == bNext)
{
optLoopTable[loopNum].lpBottom = block;
}
/* Check the loop exit */
if (optLoopTable[loopNum].lpExit == bNext)
{
noway_assert(optLoopTable[loopNum].lpExitCnt == 1);
optLoopTable[loopNum].lpExit = block;
}
/* Check the loop entry */
if (optLoopTable[loopNum].lpEntry == bNext)
{
optLoopTable[loopNum].lpEntry = block;
}
}
}
/*****************************************************************************************************
*
* Function called to remove a block when it is unreachable.
*
* This function cannot remove the first block.
*/
void Compiler::fgUnreachableBlock(BasicBlock* block)
{
// genReturnBB should never be removed, as we might have special hookups there.
// Therefore, we should never come here to remove the statements in the genReturnBB block.
// For example, <BUGNUM> in VSW 364383, </BUGNUM>
// the profiler hookup needs to have the "void GT_RETURN" statement
// to properly set the info.compProfilerCallback flag.
noway_assert(block != genReturnBB);
if (block->bbFlags & BBF_REMOVED)
return;
/* Removing an unreachable block */
#ifdef DEBUG
if (verbose)
{
printf("\nRemoving unreachable BB%02u\n", block->bbNum);
}
#endif // DEBUG
noway_assert(block->bbPrev != nullptr); // Can use this function to remove the first block
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
assert(!block->bbPrev->isBBCallAlwaysPair()); // can't remove the BBJ_ALWAYS of a BBJ_CALLFINALLY / BBJ_ALWAYS pair
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
/* First walk the statement trees in this basic block and delete each stmt */
/* Make the block publicly available */
compCurBB = block;
#if JIT_FEATURE_SSA_SKIP_DEFS
// TODO-Cleanup: I'm not sure why this happens -- if the block is unreachable, why does it have phis?
// Anyway, remove any phis.
GenTreePtr firstNonPhi = block->FirstNonPhiDef();
if (block->bbTreeList != firstNonPhi)
{
if (firstNonPhi != NULL)
{
firstNonPhi->gtPrev = block->lastStmt();
}
block->bbTreeList = firstNonPhi;
}
#endif // JIT_FEATURE_SSA_SKIP_DEFS
for (GenTreeStmt* stmt = block->firstStmt(); stmt; stmt = stmt->gtNextStmt)
{
fgRemoveStmt(block, stmt);
}
noway_assert(block->bbTreeList == 0);
/* Next update the loop table and bbWeights */
optUpdateLoopsBeforeRemoveBlock(block);
/* Mark the block as removed */
block->bbFlags |= BBF_REMOVED;
/* update bbRefs and bbPreds for the blocks reached by this block */
fgRemoveBlockAsPred(block);
}
/*****************************************************************************************************
*
* Function called to remove or morph a GT_JTRUE statement when we jump to the same
* block when both the condition is true or false.
*/
void Compiler::fgRemoveJTrue(BasicBlock *block)
{
noway_assert(block->bbJumpKind == BBJ_COND && block->bbJumpDest == block->bbNext);
flowList* flow = fgGetPredForBlock(block->bbNext, block);
noway_assert(flow->flDupCount==2);
// Change the BBJ_COND to BBJ_NONE, and adjust the refCount and dupCount.
block->bbJumpKind = BBJ_NONE;
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
--block->bbNext->bbRefs;
--flow->flDupCount;
#ifdef DEBUG
block->bbJumpDest = NULL;
if (verbose)
printf("Block BB%02u becoming a BBJ_NONE to BB%02u (jump target is the same whether the condition is true or false)\n",
block->bbNum, block->bbNext->bbNum);
#endif
/* Remove the block jump condition */
GenTreeStmt* test = block->lastTopLevelStmt();
GenTree* tree = test->gtStmtExpr;
noway_assert(tree->gtOper == GT_JTRUE);
GenTree* sideEffList = NULL;
if (tree->gtFlags & GTF_SIDE_EFFECT)
{
if (compRationalIRForm)
{
// if we are in rational form don't try to extract the side effects
// because gtExtractSideEffList will create new comma nodes
// (which we would have to rationalize) and fgMorphBlockStmt can't
// handle embedded statements.
// Instead just transform the JTRUE into a NEG which has the effect of
// evaluating the side-effecting tree and perform a benign operation on it.
tree->SetOper(GT_NEG);
tree->gtType = TYP_I_IMPL;
}
else
{
gtExtractSideEffList(tree, &sideEffList);
if (sideEffList)
{
noway_assert(sideEffList->gtFlags & GTF_SIDE_EFFECT);
#ifdef DEBUG
if (verbose)
{
printf("Extracted side effects list from condition...\n");
gtDispTree(sideEffList); printf("\n");
}
#endif
}
}
}
// Delete the cond test or replace it with the side effect tree
if (sideEffList == NULL)
{
if (!compRationalIRForm || (tree->gtFlags & GTF_SIDE_EFFECT) == 0)
fgRemoveStmt(block, test);
}
else
{
test->gtStmtExpr = sideEffList;
fgMorphBlockStmt(block, test DEBUGARG("fgRemoveJTrue"));
}
}
/*****************************************************************************************************
*
* Function to return the last basic block in the main part of the function. With funclets, it is
* the block immediately before the first funclet.
* An inclusive end of the main method.
*/
BasicBlock* Compiler::fgLastBBInMainFunction()
{
#if FEATURE_EH_FUNCLETS
if (fgFirstFuncletBB != NULL)
{
return fgFirstFuncletBB->bbPrev;
}
#endif // FEATURE_EH_FUNCLETS
assert(fgLastBB->bbNext == NULL);
return fgLastBB;
}
/*****************************************************************************************************
*
* Function to return the first basic block after the main part of the function. With funclets, it is
* the block of the first funclet. Otherwise it is NULL if there are no funclets (fgLastBB->bbNext).
* This is equivalent to fgLastBBInMainFunction()->bbNext
* An exclusive end of the main method.
*/
BasicBlock* Compiler::fgEndBBAfterMainFunction()
{
#if FEATURE_EH_FUNCLETS
if (fgFirstFuncletBB != NULL)
{
return fgFirstFuncletBB;
}
#endif // FEATURE_EH_FUNCLETS
assert(fgLastBB->bbNext == NULL);
return NULL;
}
// Removes the block from the bbPrev/bbNext chain
// Updates fgFirstBB and fgLastBB if necessary
// Does not update fgFirstFuncletBB or fgFirstColdBlock (fgUnlinkRange does)
void Compiler::fgUnlinkBlock(BasicBlock* block)
{
if (block->bbPrev)
{
block->bbPrev->bbNext = block->bbNext;
if (block->bbNext)
{
block->bbNext->bbPrev = block->bbPrev;
}
else
{
fgLastBB = block->bbPrev;
}
}
else
{
assert(block == fgFirstBB);
assert(block != fgLastBB);
assert((fgFirstBBScratch == nullptr) || (fgFirstBBScratch == fgFirstBB));
fgFirstBB = block->bbNext;
fgFirstBB->bbPrev = nullptr;
if (fgFirstBBScratch != nullptr)
{
#ifdef DEBUG
// We had created an initial scratch BB, but now we're deleting it.
if (verbose)
{
printf("Unlinking scratch BB%02u\n", block->bbNum);
}
#endif // DEBUG
fgFirstBBScratch = nullptr;
}
}
}
/*****************************************************************************************************
*
* Function called to unlink basic block range [bBeg .. bEnd] from the basic block list.
*
* 'bBeg' can't be the first block.
*/
void Compiler::fgUnlinkRange(BasicBlock* bBeg,
BasicBlock* bEnd)
{
assert(bBeg != nullptr);
assert(bEnd != nullptr);
BasicBlock* bPrev = bBeg->bbPrev;
assert(bPrev != nullptr); // Can't unlink a range starting with the first block
bPrev->setNext(bEnd->bbNext);
/* If we removed the last block in the method then update fgLastBB */
if (fgLastBB == bEnd)
{
fgLastBB = bPrev;
noway_assert(fgLastBB->bbNext == NULL);
}
// If bEnd was the first Cold basic block update fgFirstColdBlock
if (fgFirstColdBlock == bEnd)
{
fgFirstColdBlock = bPrev->bbNext;
}
#if FEATURE_EH_FUNCLETS
#ifdef DEBUG
// You can't unlink a range that includes the first funclet block. A range certainly
// can't cross the non-funclet/funclet region. And you can't unlink the first block
// of the first funclet with this, either. (If that's necessary, it could be allowed
// by updating fgFirstFuncletBB to bEnd->bbNext.)
for (BasicBlock* tempBB = bBeg; tempBB != bEnd->bbNext; tempBB = tempBB->bbNext)
{
assert(tempBB != fgFirstFuncletBB);
}
#endif // DEBUG
#endif // FEATURE_EH_FUNCLETS
}
/*****************************************************************************************************
*
* Function called to remove a basic block
*/
void Compiler::fgRemoveBlock(BasicBlock* block,
bool unreachable)
{
BasicBlock* bPrev = block->bbPrev;
/* The block has to be either unreachable or empty */
PREFIX_ASSUME(block != NULL);
JITDUMP("fgRemoveBlock BB%02u\n", block->bbNum);
// If we've cached any mappings from switch blocks to SwitchDesc's (which contain only the
// *unique* successors of the switch block), invalidate that cache, since an entry in one of
// the SwitchDescs might be removed.
InvalidateUniqueSwitchSuccMap();
noway_assert((block == fgFirstBB) || (bPrev && (bPrev->bbNext == block)));
noway_assert(!(block->bbFlags & BBF_DONT_REMOVE));
// Should never remove a genReturnBB, as we might have special hookups there.
noway_assert(block != genReturnBB);
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// Don't remove a finally target
assert(!(block->bbFlags & BBF_FINALLY_TARGET));
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
if (unreachable)
{
PREFIX_ASSUME(bPrev != NULL);
fgUnreachableBlock(block);
/* If this is the last basic block update fgLastBB */
if (block == fgLastBB)
{
fgLastBB = bPrev;
}
#if FEATURE_EH_FUNCLETS
// If block was the fgFirstFuncletBB then set fgFirstFuncletBB to block->bbNext
if (block == fgFirstFuncletBB)
{
fgFirstFuncletBB = block->bbNext;
}
#endif // FEATURE_EH_FUNCLETS
if (bPrev->bbJumpKind == BBJ_CALLFINALLY)
{
// bPrev CALL becomes RETLESS as the BBJ_ALWAYS block is unreachable
bPrev->bbFlags |= BBF_RETLESS_CALL;
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
NO_WAY("No retless call finally blocks; need unwind target instead");
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
}
else if (bPrev->bbJumpKind == BBJ_ALWAYS &&
bPrev->bbJumpDest == block->bbNext &&
!(bPrev->bbFlags & BBF_KEEP_BBJ_ALWAYS) &&
(block != fgFirstColdBlock) &&
(block->bbNext != fgFirstColdBlock))
{
// previous block is a BBJ_ALWAYS to the next block: change to BBJ_NONE.
// Note that we don't do it if bPrev follows a BBJ_CALLFINALLY block (BBF_KEEP_BBJ_ALWAYS),
// because that would violate our invariant that BBJ_CALLFINALLY blocks are followed by
// BBJ_ALWAYS blocks.
bPrev->bbJumpKind = BBJ_NONE;
bPrev->bbFlags &= ~BBF_NEEDS_GCPOLL;
}
// If this is the first Cold basic block update fgFirstColdBlock
if (block == fgFirstColdBlock)
{
fgFirstColdBlock = block->bbNext;
}
/* Unlink this block from the bbNext chain */
fgUnlinkBlock(block);
/* At this point the bbPreds and bbRefs had better be zero */
noway_assert((block->bbRefs == 0) && (block->bbPreds == nullptr));
/* A BBJ_CALLFINALLY is usually paired with a BBJ_ALWAYS.
* If we delete such a BBJ_CALLFINALLY we also delete the BBJ_ALWAYS
*/
if (block->isBBCallAlwaysPair())
{
BasicBlock* leaveBlk = block->bbNext;
noway_assert(leaveBlk->bbJumpKind == BBJ_ALWAYS);
leaveBlk->bbFlags &= ~BBF_DONT_REMOVE;
leaveBlk->bbRefs = 0;
leaveBlk->bbPreds = nullptr;
fgRemoveBlock(leaveBlk, true);
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
fgClearFinallyTargetBit(leaveBlk->bbJumpDest);
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
}
else if (block->bbJumpKind == BBJ_RETURN)
{
fgRemoveReturnBlock(block);
}
}
else // block is empty
{
noway_assert(block->isEmpty());
/* The block cannot follow a non-retless BBJ_CALLFINALLY (because we don't know who may jump to it) */
noway_assert((bPrev == nullptr) || !bPrev->isBBCallAlwaysPair());
/* This cannot be the last basic block */
noway_assert(block != fgLastBB);
#ifdef DEBUG
if (verbose)
{
printf("Removing empty BB%02u\n", block->bbNum);
}
#endif // DEBUG
/* Some extra checks for the empty case */
#ifdef DEBUG
switch (block->bbJumpKind)
{
case BBJ_NONE:
break;
case BBJ_ALWAYS:
/* Do not remove a block that jumps to itself - used for while (true){} */
noway_assert(block->bbJumpDest != block);
/* Empty GOTO can be removed iff bPrev is BBJ_NONE */
noway_assert(bPrev && bPrev->bbJumpKind == BBJ_NONE);
break;
default:
noway_assert(!"Empty block of this type cannot be removed!");
break;
}
#endif // DEBUG
noway_assert(block->bbJumpKind == BBJ_NONE || block->bbJumpKind == BBJ_ALWAYS);
/* Who is the "real" successor of this block? */
BasicBlock* succBlock;
if (block->bbJumpKind == BBJ_ALWAYS)
{
succBlock = block->bbJumpDest;
}
else
{
succBlock = block->bbNext;
}
bool skipUnmarkLoop = false;
// If block is the backedge for a loop and succBlock precedes block
// then the succBlock becomes the new LOOP HEAD
// NOTE: there's an assumption here that the blocks are numbered in increasing bbNext order.
// NOTE 2: if fgDomsComputed is false, then we can't check reachability. However, if this is
// the case, then the loop structures probably are also invalid, and shouldn't be used. This
// can be the case late in compilation (such as Lower), where remnants of earlier created
// structures exist, but haven't been maintained.
if (block->isLoopHead() && (succBlock->bbNum <= block->bbNum))
{
succBlock->bbFlags |= BBF_LOOP_HEAD;
if (fgDomsComputed && fgReachable(succBlock, block))
{
/* Mark all the reachable blocks between 'succBlock' and 'block', excluding 'block' */
optMarkLoopBlocks(succBlock, block, true);
}
}
else if (succBlock->isLoopHead() && bPrev && (succBlock->bbNum <= bPrev->bbNum))
{
skipUnmarkLoop = true;
}
noway_assert(succBlock);
// If this is the first Cold basic block update fgFirstColdBlock
if (block == fgFirstColdBlock)
{
fgFirstColdBlock = block->bbNext;
}
#if FEATURE_EH_FUNCLETS
// Update fgFirstFuncletBB if necessary
if (block == fgFirstFuncletBB)
{
fgFirstFuncletBB = block->bbNext;
}
#endif // FEATURE_EH_FUNCLETS
/* First update the loop table and bbWeights */
optUpdateLoopsBeforeRemoveBlock(block, skipUnmarkLoop);
/* Remove the block */
if (bPrev == NULL)
{
/* special case if this is the first BB */
noway_assert(block == fgFirstBB);
/* Must be a fall through to next block */
noway_assert(block->bbJumpKind == BBJ_NONE);
/* old block no longer gets the extra ref count for being the first block */
block->bbRefs--;
succBlock->bbRefs++;
/* Set the new firstBB */
fgUnlinkBlock(block);
/* Always treat the initial block as a jump target */
fgFirstBB->bbFlags |= BBF_JMP_TARGET | BBF_HAS_LABEL;
}
else
{
fgUnlinkBlock(block);
}
/* mark the block as removed and set the change flag */
block->bbFlags |= BBF_REMOVED;
/* Update bbRefs and bbPreds.
* All blocks jumping to 'block' now jump to 'succBlock'.
* First, remove 'block' from the predecessor list of succBlock.
*/
fgRemoveRefPred(succBlock, block);
for (flowList* pred = block->bbPreds; pred; pred = pred->flNext)
{
BasicBlock* predBlock = pred->flBlock;
/* Are we changing a loop backedge into a forward jump? */
if ( block->isLoopHead() &&
(predBlock->bbNum >= block->bbNum) &&
(predBlock->bbNum <= succBlock->bbNum) )
{
/* First update the loop table and bbWeights */
optUpdateLoopsBeforeRemoveBlock(predBlock);
}
/* If predBlock is a new predecessor, then add it to succBlock's
predecessor's list. */
if (predBlock->bbJumpKind != BBJ_SWITCH)
{
// Even if the pred is not a switch, we could have a conditional branch
// to the fallthrough, so duplicate there could be preds
for (unsigned i=0; i<pred->flDupCount; i++)
fgAddRefPred(succBlock, predBlock);
}
/* change all jumps to the removed block */
switch (predBlock->bbJumpKind)
{
default:
noway_assert(!"Unexpected bbJumpKind in fgRemoveBlock()");
break;
case BBJ_NONE:
noway_assert(predBlock == bPrev);
PREFIX_ASSUME(bPrev != NULL);
/* In the case of BBJ_ALWAYS we have to change the type of its predecessor */
if (block->bbJumpKind == BBJ_ALWAYS)
{
/* bPrev now becomes a BBJ_ALWAYS */
bPrev->bbJumpKind = BBJ_ALWAYS;
bPrev->bbJumpDest = succBlock;
}
break;
case BBJ_COND:
/* The links for the direct predecessor case have already been updated above */
if (predBlock->bbJumpDest != block)
{
succBlock->bbFlags |= BBF_HAS_LABEL | BBF_JMP_TARGET;
break;
}
/* Check if both side of the BBJ_COND now jump to the same block */
if (predBlock->bbNext == succBlock)
{
// Make sure we are replacing "block" with "succBlock" in predBlock->bbJumpDest.
noway_assert(predBlock->bbJumpDest == block);
predBlock->bbJumpDest = succBlock;
fgRemoveJTrue(predBlock);
break;
}
/* Fall through for the jump case */
__fallthrough;
case BBJ_CALLFINALLY:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
noway_assert(predBlock->bbJumpDest == block);
predBlock->bbJumpDest = succBlock;
succBlock->bbFlags |= BBF_HAS_LABEL | BBF_JMP_TARGET;
break;
case BBJ_SWITCH:
// Change any jumps from 'predBlock' (a BBJ_SWITCH) to 'block' to jump to 'succBlock'
//
// For the jump targets of 'predBlock' (a BBJ_SWITCH) that jump to 'block'
// remove the old predecessor at 'block' from 'predBlock' and
// add the new predecessor at 'succBlock' from 'predBlock'
//
fgReplaceSwitchJumpTarget(predBlock, succBlock, block);
break;
}
}
}
if (bPrev != NULL)
{
switch (bPrev->bbJumpKind)
{
case BBJ_CALLFINALLY:
// If prev is a BBJ_CALLFINALLY it better be marked as RETLESS
noway_assert(bPrev->bbFlags & BBF_RETLESS_CALL);
break;
case BBJ_ALWAYS:
// Check for branch to next block. Just make sure the BBJ_ALWAYS block is not
// part of a BBJ_CALLFINALLY/BBJ_ALWAYS pair. We do this here and don't rely on fgUpdateFlowGraph
// because we can be called by ComputeDominators and it expects it to remove this jump to
// the next block. This is the safest fix. We should remove all this BBJ_CALLFINALLY/BBJ_ALWAYS
// pairing.
if ((bPrev->bbJumpDest == bPrev->bbNext) &&
!fgInDifferentRegions(bPrev, bPrev->bbJumpDest)) // We don't remove a branch from Hot -> Cold
{
if ((bPrev == fgFirstBB) || !bPrev->bbPrev->isBBCallAlwaysPair())
{
// It's safe to change the jump type
bPrev->bbJumpKind = BBJ_NONE;
bPrev->bbFlags &= ~BBF_NEEDS_GCPOLL;
}
}
break;
case BBJ_COND:
/* Check for branch to next block */
if (bPrev->bbJumpDest == bPrev->bbNext)
{
fgRemoveJTrue(bPrev);
}
break;
default:
break;
}
ehUpdateForDeletedBlock(block);
}
}
/*****************************************************************************
*
* Function called to connect to block that previously had a fall through
*/
BasicBlock* Compiler::fgConnectFallThrough(BasicBlock* bSrc,
BasicBlock* bDst)
{
BasicBlock* jmpBlk = NULL;
/* If bSrc is non-NULL */
if (bSrc != NULL)
{
/* If bSrc falls through to a block that is not bDst, we will insert a jump to bDst */
if (bSrc->bbFallsThrough() && (bSrc->bbNext != bDst))
{
switch (bSrc->bbJumpKind)
{
case BBJ_NONE:
bSrc->bbJumpKind = BBJ_ALWAYS;
bSrc->bbJumpDest = bDst;
bSrc->bbJumpDest->bbFlags |= (BBF_JMP_TARGET | BBF_HAS_LABEL);
#ifdef DEBUG
if (verbose)
{
printf("Block BB%02u ended with a BBJ_NONE, Changed to an unconditional jump to BB%02u\n",
bSrc->bbNum, bSrc->bbJumpDest->bbNum);
}
#endif
break;
case BBJ_CALLFINALLY:
case BBJ_COND:
// Add a new block after bSrc which jumps to 'bDst'
jmpBlk = fgNewBBafter(BBJ_ALWAYS, bSrc, true);
if (fgComputePredsDone)
{
fgAddRefPred(jmpBlk, bSrc, fgGetPredForBlock(bDst, bSrc));
}
// When adding a new jmpBlk we will set the bbWeight and bbFlags
//
if (fgHaveValidEdgeWeights)
{
noway_assert(fgComputePredsDone);
flowList* newEdge = fgGetPredForBlock(jmpBlk, bSrc);
jmpBlk->bbWeight = (newEdge->flEdgeWeightMin + newEdge->flEdgeWeightMax) / 2;
if (bSrc->bbWeight == 0)
{
jmpBlk->bbWeight = 0;
}
if (jmpBlk->bbWeight == 0)
{
jmpBlk->bbFlags |= BBF_RUN_RARELY;
}
BasicBlock::weight_t weightDiff = (newEdge->flEdgeWeightMax - newEdge->flEdgeWeightMin);
BasicBlock::weight_t slop = BasicBlock::GetSlopFraction(bSrc, bDst);
//
// If the [min/max] values for our edge weight is within the slop factor
// then we will set the BBF_PROF_WEIGHT flag for the block
//
if (weightDiff <= slop)
{
jmpBlk->bbFlags |= BBF_PROF_WEIGHT;
}
}
else
{
// We set the bbWeight to the smaller of bSrc->bbWeight or bDst->bbWeight
if (bSrc->bbWeight < bDst->bbWeight)
{
jmpBlk->bbWeight = bSrc->bbWeight;
jmpBlk->bbFlags |= (bSrc->bbFlags & BBF_RUN_RARELY);
}
else
{
jmpBlk->bbWeight = bDst->bbWeight;
jmpBlk->bbFlags |= (bDst->bbFlags & BBF_RUN_RARELY);
}
}
jmpBlk->bbJumpDest = bDst;
jmpBlk->bbJumpDest->bbFlags |= (BBF_JMP_TARGET | BBF_HAS_LABEL);
if (fgComputePredsDone)
{
fgReplacePred(bDst, bSrc, jmpBlk);
}
else
{
jmpBlk->bbFlags |= BBF_IMPORTED;
}
#ifdef DEBUG
if (verbose)
{
printf("Added an unconditional jump to BB%02u after block BB%02u\n",
jmpBlk->bbJumpDest->bbNum, bSrc->bbNum);
}
#endif // DEBUG
break;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
}
else
{
// If bSrc is an unconditional branch to the next block
// then change it to a BBJ_NONE block
//
if ( (bSrc->bbJumpKind == BBJ_ALWAYS) &&
!(bSrc->bbFlags & BBF_KEEP_BBJ_ALWAYS) &&
(bSrc->bbJumpDest == bSrc->bbNext))
{
bSrc->bbJumpKind = BBJ_NONE;
bSrc->bbFlags &= ~BBF_NEEDS_GCPOLL;
#ifdef DEBUG
if (verbose)
{
printf("Changed an unconditional jump from BB%02u to the next block BB%02u into a BBJ_NONE block\n",
bSrc->bbNum, bSrc->bbNext->bbNum);
}
#endif // DEBUG
}
}
}
return jmpBlk;
}
/*****************************************************************************
Walk the flow graph, reassign block numbers to keep them in ascending order.
Returns 'true' if any renumbering was actually done, OR if we change the
maximum number of assigned basic blocks (this can happen if we do inlining,
create a new, high-numbered block, then that block goes away. We go to
renumber the blocks, none of them actually change number, but we shrink the
maximum assigned block number. This affects the block set epoch).
*/
bool Compiler::fgRenumberBlocks()
{
// If we renumber the blocks the dominator information will be out-of-date
if (fgDomsComputed)
{
noway_assert(!"Can't call Compiler::fgRenumberBlocks() when fgDomsComputed==true");
}
#ifdef DEBUG
if (verbose)
{
printf("\n*************** Before renumbering the basic blocks\n");
fgDispBasicBlocks();
fgDispHandlerTab();
}
#endif // DEBUG
bool renumbered = false;
bool newMaxBBNum = false;
BasicBlock* block;
unsigned numStart = 1 + (compIsForInlining() ? impInlineInfo->InlinerCompiler->fgBBNumMax : 0);
unsigned num;
for (block = fgFirstBB , num = numStart;
block != NULL;
block = block->bbNext, num++)
{
noway_assert((block->bbFlags & BBF_REMOVED) == 0);
if (block->bbNum != num)
{
renumbered = true;
#ifdef DEBUG
if (verbose)
{
printf("Renumber BB%02u to BB%02u\n", block->bbNum, num);
}
#endif // DEBUG
block->bbNum = num;
}
if (block->bbNext == NULL)
{
fgLastBB = block;
fgBBcount = num - numStart + 1;
if (compIsForInlining())
{
if (impInlineInfo->InlinerCompiler->fgBBNumMax != num)
{
impInlineInfo->InlinerCompiler->fgBBNumMax = num;
newMaxBBNum = true;
}
}
else
{
if (fgBBNumMax != num)
{
fgBBNumMax = num;
newMaxBBNum = true;
}
}
}
}
#ifdef DEBUG
if (verbose)
{
printf("\n*************** After renumbering the basic blocks\n");
if (renumbered)
{
fgDispBasicBlocks();
fgDispHandlerTab();
}
else
{
printf("=============== No blocks renumbered!\n");
}
}
#endif // DEBUG
// Now update the BlockSet epoch, which depends on the block numbers.
// If any blocks have been renumbered then create a new BlockSet epoch.
// Even if we have not renumbered any blocks, we might still need to force
// a new BlockSet epoch, for one of several reasons. If there are any new
// blocks with higher numbers than the former maximum numbered block, then we
// need a new epoch with a new size matching the new largest numbered block.
// Also, if the number of blocks is different from the last time we set the
// BlockSet epoch, then we need a new epoch. This wouldn't happen if we
// renumbered blocks after every block addition/deletion, but it might be
// the case that we can change the number of blocks, then set the BlockSet
// epoch without renumbering, then change the number of blocks again, then
// renumber.
if (renumbered || newMaxBBNum)
{
NewBasicBlockEpoch();
// The key in the unique switch successor map is dependent on the block number, so invalidate that cache.
InvalidateUniqueSwitchSuccMap();
}
else
{
EnsureBasicBlockEpoch();
}
// Tell our caller if any blocks actually were renumbered.
return renumbered || newMaxBBNum;
}
/*****************************************************************************
*
* Is the BasicBlock bJump a forward branch?
* Optionally bSrc can be supplied to indicate that
* bJump must be forward with respect to bSrc
*/
bool Compiler::fgIsForwardBranch(BasicBlock* bJump, BasicBlock* bSrc /* = NULL */)
{
bool result = false;
if ((bJump->bbJumpKind == BBJ_COND) ||
(bJump->bbJumpKind == BBJ_ALWAYS) )
{
BasicBlock* bDest = bJump->bbJumpDest;
BasicBlock* bTemp = (bSrc == NULL) ? bJump : bSrc;
while (true)
{
bTemp = bTemp->bbNext;
if (bTemp == NULL)
break;
if (bTemp == bDest)
{
result = true;
break;
}
}
}
return result;
}
/*****************************************************************************
*
* Function called to expand the set of rarely run blocks
*/
bool Compiler::fgExpandRarelyRunBlocks()
{
bool result = false;
#ifdef DEBUG
if (verbose)
printf("\n*************** In fgExpandRarelyRunBlocks()\n");
const char* reason = NULL;
#endif
// We expand the number of rarely run blocks by observing
// that a block that falls into or jumps to a rarely run block,
// must itself be rarely run and when we have a conditional
// jump in which both branches go to rarely run blocks then
// the block must itself be rarely run
BasicBlock* block;
BasicBlock* bPrev;
for (bPrev = fgFirstBB, block = bPrev->bbNext;
block != NULL;
bPrev = block, block = block->bbNext)
{
if (bPrev->isRunRarely())
continue;
/* bPrev is known to be a normal block here */
switch (bPrev->bbJumpKind)
{
case BBJ_ALWAYS:
/* Is the jump target rarely run? */
if (bPrev->bbJumpDest->isRunRarely())
{
INDEBUG(reason = "Unconditional jump to a rarely run block";)
goto NEW_RARELY_RUN;
}
break;
case BBJ_CALLFINALLY:
// Check for a BBJ_CALLFINALLY followed by a rarely run paired BBJ_ALWAYS
//
if (bPrev->isBBCallAlwaysPair())
{
/* Is the next block rarely run? */
if (block->isRunRarely())
{
INDEBUG(reason = "Call of finally followed by a rarely run block";)
goto NEW_RARELY_RUN;
}
}
break;
case BBJ_NONE:
/* is fall through target rarely run? */
if (block->isRunRarely())
{
INDEBUG(reason = "Falling into a rarely run block";)
goto NEW_RARELY_RUN;
}
break;
case BBJ_COND:
if (!block->isRunRarely())
continue;
/* If both targets of the BBJ_COND are run rarely then don't reorder */
if (bPrev->bbJumpDest->isRunRarely())
{
/* bPrev should also be marked as run rarely */
if (!bPrev->isRunRarely())
{
INDEBUG(reason = "Both sides of a conditional jump are rarely run";)
NEW_RARELY_RUN:
/* If the weight of the block was obtained from a profile run,
than it's more accurate than our static analysis */
if (bPrev->bbFlags & BBF_PROF_WEIGHT)
{
continue;
}
result = true;
#ifdef DEBUG
assert(reason != NULL);
if (verbose)
{
printf("%s, marking BB%02u as rarely run\n", reason, bPrev->bbNum);
}
#endif // DEBUG
/* Must not have previously been marked */
noway_assert(!bPrev->isRunRarely());
/* Mark bPrev as a new rarely run block */
bPrev->bbSetRunRarely();
BasicBlock* bPrevPrev = NULL;
BasicBlock* tmpbb;
if ((bPrev->bbFlags & BBF_KEEP_BBJ_ALWAYS) != 0)
{
// If we've got a BBJ_CALLFINALLY/BBJ_ALWAYS pair, treat the BBJ_CALLFINALLY as an additional predecessor for the BBJ_ALWAYS block
tmpbb = bPrev->bbPrev;
noway_assert(tmpbb != NULL);
#if FEATURE_EH_FUNCLETS
noway_assert(tmpbb->isBBCallAlwaysPair());
bPrevPrev = tmpbb;
#else
if (tmpbb->bbJumpKind == BBJ_CALLFINALLY)
{
bPrevPrev = tmpbb;
}
#endif
}
/* Now go back to it's earliest predecessor to see */
/* if it too should now be marked as rarely run */
flowList* pred = bPrev->bbPreds;
if ((pred != NULL) || (bPrevPrev != NULL))
{
// bPrevPrev will be set to the lexically
// earliest predecessor of bPrev.
while (pred != NULL)
{
if (bPrevPrev == NULL)
{
// Initially we select the first block in the bbPreds list
bPrevPrev = pred->flBlock;
continue;
}
// Walk the flow graph lexically forward from pred->flBlock
// if we find (block == bPrevPrev) then
// pred->flBlock is an earlier predecessor.
for (tmpbb = pred->flBlock;
tmpbb != NULL;
tmpbb = tmpbb->bbNext)
{
if (tmpbb == bPrevPrev)
{
/* We found an ealier predecessor */
bPrevPrev = pred->flBlock;
break;
}
else if (tmpbb == bPrev)
{
// We have reached bPrev so stop walking
// as this cannot be an earlier predecessor
break;
}
}
// Onto the next predecessor
pred = pred->flNext;
}
// Walk the flow graph forward from bPrevPrev
// if we don't find (tmpbb == bPrev) then our candidate
// bPrevPrev is lexically after bPrev and we do not
// want to select it as our new block
for (tmpbb = bPrevPrev;
tmpbb != NULL;
tmpbb = tmpbb->bbNext)
{
if (tmpbb == bPrev)
{
// Set up block back to the lexically
// earliest predecessor of pPrev
block = bPrevPrev;
}
}
}
}
break;
default:
break;
}
}
}
// Now iterate over every block to see if we can prove that a block is rarely run
// (i.e. when all predecessors to the block are rarely run)
//
for (bPrev = fgFirstBB, block = bPrev->bbNext;
block != NULL;
bPrev = block, block = block->bbNext)
{
// If block is not run rarely, then check to make sure that it has
// at least one non-rarely run block.
if (!block->isRunRarely())
{
bool rare = true;
/* Make sure that block has at least one normal predecessor */
for (flowList* pred = block->bbPreds;
pred != NULL;
pred = pred->flNext)
{
/* Find the fall through predecessor, if any */
if (!pred->flBlock->isRunRarely())
{
rare = false;
break;
}
}
if (rare)
{
// If 'block' is the start of a handler or filter then we cannot make it
// rarely run because we may have an exceptional edge that
// branches here.
//
if (bbIsHandlerBeg(block))
{
rare = false;
}
}
if (rare)
{
block->bbSetRunRarely();
result = true;
#ifdef DEBUG
if (verbose)
{
printf("All branches to BB%02u are from rarely run blocks, marking as rarely run\n",
block->bbNum);
}
#endif // DEBUG
// When marking a BBJ_CALLFINALLY as rarely run we also mark
// the BBJ_ALWAYS that comes after it as rarely run
//
if (block->isBBCallAlwaysPair())
{
BasicBlock* bNext = block->bbNext;
PREFIX_ASSUME(bNext != NULL);
bNext->bbSetRunRarely();
#ifdef DEBUG
if (verbose)
{
printf("Also marking the BBJ_ALWAYS at BB%02u as rarely run\n",
bNext->bbNum);
}
#endif // DEBUG
}
}
}
/* COMPACT blocks if possible */
if (bPrev->bbJumpKind == BBJ_NONE)
{
if (fgCanCompactBlocks(bPrev, block))
{
fgCompactBlocks(bPrev, block);
block = bPrev;
continue;
}
}
//
// if bPrev->bbWeight is not based upon profile data we can adjust
// the weights of bPrev and block
//
else if ( bPrev->isBBCallAlwaysPair() && // we must have a BBJ_CALLFINALLY and BBK_ALWAYS pair
(bPrev->bbWeight != block->bbWeight) && // the weights are currently different
((bPrev->bbFlags & BBF_PROF_WEIGHT) == 0)) // and the BBJ_CALLFINALLY block is not using profiled weights
{
if (block->isRunRarely())
{
bPrev->bbWeight = block->bbWeight; // the BBJ_CALLFINALLY block now has the same weight as the BBJ_ALWAYS block
bPrev->bbFlags |= BBF_RUN_RARELY; // and is now rarely run
#ifdef DEBUG
if (verbose)
{
printf("Marking the BBJ_CALLFINALLY block at BB%02u as rarely run because BB%02u is rarely run\n",
bPrev->bbNum, block->bbNum);
}
#endif // DEBUG
}
else if (bPrev->isRunRarely())
{
block->bbWeight = bPrev->bbWeight; // the BBJ_ALWAYS block now has the same weight as the BBJ_CALLFINALLY block
block->bbFlags |= BBF_RUN_RARELY; // and is now rarely run
#ifdef DEBUG
if (verbose)
{
printf("Marking the BBJ_ALWAYS block at BB%02u as rarely run because BB%02u is rarely run\n",
block->bbNum, bPrev->bbNum);
}
#endif // DEBUG
}
else // Both blocks are hot, bPrev is known not to be using profiled weight
{
bPrev->bbWeight = block->bbWeight; // the BBJ_CALLFINALLY block now has the same weight as the BBJ_ALWAYS block
}
noway_assert(block->bbWeight == bPrev->bbWeight);
}
}
return result;
}
/*****************************************************************************
*
* Returns true if it is allowable (based upon the EH regions)
* to place block bAfter immediately after bBefore. It is allowable
* if the 'bBefore' and 'bAfter' blocks are in the exact same EH region.
*/
bool Compiler::fgEhAllowsMoveBlock(BasicBlock* bBefore,
BasicBlock* bAfter)
{
return BasicBlock::sameEHRegion(bBefore, bAfter);
}
/*****************************************************************************
*
* Function called to move the range of blocks [bStart .. bEnd].
* The blocks are placed immediately after the insertAfterBlk.
* fgFirstFuncletBB is not updated; that is the responsibility of the caller, if necessary.
*/
void Compiler::fgMoveBlocksAfter(BasicBlock* bStart, BasicBlock* bEnd, BasicBlock* insertAfterBlk)
{
/* We have decided to insert the block(s) after 'insertAfterBlk' */
#ifdef DEBUG
if (verbose)
{
printf("Relocated block%s [BB%02u..BB%02u] inserted after BB%02u%s\n",
(bStart == bEnd) ? "" : "s",
bStart->bbNum, bEnd->bbNum,
insertAfterBlk->bbNum,
(insertAfterBlk->bbNext == NULL) ? " at the end of method" : "");
}
#endif // DEBUG
/* relink [bStart .. bEnd] into the flow graph */
bEnd->bbNext = insertAfterBlk->bbNext;
if (insertAfterBlk->bbNext)
insertAfterBlk->bbNext->bbPrev = bEnd;
insertAfterBlk->setNext(bStart);
/* If insertAfterBlk was fgLastBB then update fgLastBB */
if (insertAfterBlk == fgLastBB)
{
fgLastBB = bEnd;
noway_assert(fgLastBB->bbNext == NULL);
}
}
/*****************************************************************************
*
* Function called to relocate a single range to the end of the method.
* Only an entire consecutive region can be moved and it will be kept together.
* Except for the first block, the range cannot have any blocks that jump into or out of the region.
* When successful we return the bLast block which is the last block that we relocated.
* When unsuccessful we return NULL.
=============================================================
NOTE: This function can invalidate all pointers into the EH table, as well as change the size of the EH table!
=============================================================
*/
BasicBlock* Compiler::fgRelocateEHRange(unsigned regionIndex, FG_RELOCATE_TYPE relocateType)
{
INDEBUG(const char* reason = "None";)
unsigned XTnum;
EHblkDsc* HBtab;
BasicBlock* bStart = NULL;
BasicBlock* bMiddle = NULL;
BasicBlock* bLast = NULL;
BasicBlock* bPrev = NULL;
// Figure out the range of blocks we're going to move
#if FEATURE_EH_FUNCLETS
// We don't support moving try regions... yet?
noway_assert(relocateType == FG_RELOCATE_HANDLER);
#endif // FEATURE_EH_FUNCLETS
HBtab = ehGetDsc(regionIndex);
if (relocateType == FG_RELOCATE_TRY)
{
bStart = HBtab->ebdTryBeg;
bLast = HBtab->ebdTryLast;
}
else if (relocateType == FG_RELOCATE_HANDLER)
{
if (HBtab->HasFilter())
{
// The filter and handler funclets must be moved together, and remain contiguous.
bStart = HBtab->ebdFilter;
bMiddle = HBtab->ebdHndBeg;
bLast = HBtab->ebdHndLast;
}
else
{
bStart = HBtab->ebdHndBeg;
bLast = HBtab->ebdHndLast;
}
}
// Our range must contain either all rarely run blocks or all non-rarely run blocks
bool inTheRange = false;
bool validRange = false;
BasicBlock* block;
noway_assert(bStart != NULL && bLast != NULL);
if (bStart == fgFirstBB)
{
INDEBUG(reason = "can not relocate first block";)
goto FAILURE;
}
#if !FEATURE_EH_FUNCLETS
// In the funclets case, we still need to set some information on the handler blocks
if (bLast->bbNext == NULL)
{
INDEBUG(reason = "region is already at the end of the method";)
goto FAILURE;
}
#endif // !FEATURE_EH_FUNCLETS
// Walk the block list for this purpose:
// 1. Verify that all the blocks in the range are either all rarely run or not rarely run.
// When creating funclets, we ignore the run rarely flag, as we need to be able to move any blocks
// in the range.
#if !FEATURE_EH_FUNCLETS
bool isRare;
isRare = bStart->isRunRarely();
#endif // !FEATURE_EH_FUNCLETS
block = fgFirstBB;
while (true)
{
if (block == bStart)
{
noway_assert(inTheRange == false);
inTheRange = true;
}
else if (block == bLast->bbNext)
{
noway_assert(inTheRange == true);
inTheRange = false;
break; // we found the end, so we're done
}
if (inTheRange)
{
#if !FEATURE_EH_FUNCLETS
// Unless all blocks are (not) run rarely we must return false.
if (isRare != block->isRunRarely())
{
INDEBUG(reason = "this region contains both rarely run and non-rarely run blocks";)
goto FAILURE;
}
#endif // !FEATURE_EH_FUNCLETS
validRange = true;
}
if (block == NULL)
break;
block = block->bbNext;
}
// Ensure that bStart .. bLast defined a valid range
noway_assert((validRange == true) && (inTheRange == false));
bPrev = bStart->bbPrev;
noway_assert(bPrev != nullptr); // Can't move a range that includes the first block of the function.
JITDUMP("Relocating %s range BB%02u..BB%02u (EH#%u) to end of BBlist\n",
(relocateType == FG_RELOCATE_TRY) ? "try" : "handler",
bStart->bbNum,
bLast->bbNum,
regionIndex);
#ifdef DEBUG
if (verbose)
{
fgDispBasicBlocks();
fgDispHandlerTab();
}
if (!FEATURE_EH_FUNCLETS)
{
// This is really expensive, and quickly becomes O(n^n) with funclets
// so only do it once after we've created them (see fgCreateFunclets)
if (expensiveDebugCheckLevel >= 2)
{
fgDebugCheckBBlist();
}
}
#endif // DEBUG
#if FEATURE_EH_FUNCLETS
bStart->bbFlags |= BBF_FUNCLET_BEG; // Mark the start block of the funclet
if (bMiddle != NULL)
{
bMiddle->bbFlags |= BBF_FUNCLET_BEG; // Also mark the start block of a filter handler as a funclet
}
#endif // FEATURE_EH_FUNCLETS
BasicBlock* bNext;
bNext = bLast->bbNext;
/* Temporarily unlink [bStart .. bLast] from the flow graph */
fgUnlinkRange(bStart, bLast);
BasicBlock* insertAfterBlk;
insertAfterBlk = fgLastBB;
#if FEATURE_EH_FUNCLETS
// There are several cases we need to consider when moving an EH range.
// If moving a range X, we must consider its relationship to every other EH
// range A in the table. Note that each entry in the table represents both
// a protected region and a handler region (possibly including a filter region
// that must live before and adjacent to the handler region), so we must
// consider try and handler regions independently. These are the cases:
// 1. A is completely contained within X (where "completely contained" means
// that the 'begin' and 'last' parts of A are strictly between the 'begin'
// and 'end' parts of X, and aren't equal to either, for example, they don't
// share 'last' blocks). In this case, when we move X, A moves with it, and
// the EH table doesn't need to change.
// 2. X is completely contained within A. In this case, X gets extracted from A,
// and the range of A shrinks, but because A is strictly within X, the EH
// table doesn't need to change.
// 3. A and X have exactly the same range. In this case, A is moving with X and
// the EH table doesn't need to change.
// 4. A and X share the 'last' block. There are two sub-cases:
// (a) A is a larger range than X (such that the beginning of A precedes the
// beginning of X): in this case, we are moving the tail of A. We set the
// 'last' block of A to the the block preceding the beginning block of X.
// (b) A is a smaller range than X. Thus, we are moving the entirety of A along
// with X. In this case, nothing in the EH record for A needs to change.
// 5. A and X share the 'beginning' block (but aren't the same range, as in #3).
// This can never happen here, because we are only moving handler ranges (we don't
// move try ranges), and handler regions cannot start at the beginning of a try
// range or handler range and be a subset.
//
// Note that A and X must properly nest for the table to be well-formed. For example,
// the beginning of A can't be strictly within the range of X (that is, the beginning
// of A isn't shared with the beginning of X) and the end of A outside the range.
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
if (XTnum != regionIndex) // we don't need to update our 'last' pointer
{
if (HBtab->ebdTryLast == bLast)
{
// If we moved a set of blocks that were at the end of
// a different try region then we may need to update ebdTryLast
for (block = HBtab->ebdTryBeg; block != NULL; block = block->bbNext)
{
if (block == bPrev)
{
// We were contained within it, so shrink its region by
// setting its 'last'
fgSetTryEnd(HBtab, bPrev);
break;
}
else if (block == HBtab->ebdTryLast->bbNext)
{
// bPrev does not come after the TryBeg, thus we are larger, and
// it is moving with us.
break;
}
}
}
if (HBtab->ebdHndLast == bLast)
{
// If we moved a set of blocks that were at the end of
// a different handler region then we must update ebdHndLast
for (block = HBtab->ebdHndBeg; block != NULL; block = block->bbNext)
{
if (block == bPrev)
{
fgSetHndEnd(HBtab, bPrev);
break;
}
else if (block == HBtab->ebdHndLast->bbNext)
{
// bPrev does not come after the HndBeg
break;
}
}
}
}
} // end exception table iteration
// Insert the block(s) we are moving after fgLastBlock
fgMoveBlocksAfter(bStart, bLast, insertAfterBlk);
if (fgFirstFuncletBB == nullptr) // The funclet region isn't set yet
{
fgFirstFuncletBB = bStart;
}
else
{
assert(fgFirstFuncletBB != insertAfterBlk->bbNext); // We insert at the end, not at the beginning, of the funclet region.
}
// These asserts assume we aren't moving try regions (which we might need to do). Only
// try regions can have fall through into or out of the region.
noway_assert(!bPrev->bbFallsThrough()); // There can be no fall through into a filter or handler region
noway_assert(!bLast->bbFallsThrough()); // There can be no fall through out of a handler region
#ifdef DEBUG
if (verbose)
{
printf("Create funclets: moved region\n");
fgDispHandlerTab();
}
// We have to wait to do this until we've created all the additional regions
// Because this relies on ebdEnclosingTryIndex and ebdEnclosingHndIndex
if (!FEATURE_EH_FUNCLETS)
{
// This is really expensive, and quickly becomes O(n^n) with funclets
// so only do it once after we've created them (see fgCreateFunclets)
if (expensiveDebugCheckLevel >= 2)
{
fgDebugCheckBBlist();
}
}
#endif // DEBUG
#else // FEATURE_EH_FUNCLETS
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
if (XTnum == regionIndex)
{
// Don't update our handler's Last info
continue;
}
if (HBtab->ebdTryLast == bLast)
{
// If we moved a set of blocks that were at the end of
// a different try region then we may need to update ebdTryLast
for (block = HBtab->ebdTryBeg; block != NULL; block = block->bbNext)
{
if (block == bPrev)
{
fgSetTryEnd(HBtab, bPrev);
break;
}
else if (block == HBtab->ebdTryLast->bbNext)
{
// bPrev does not come after the TryBeg
break;
}
}
}
if (HBtab->ebdHndLast == bLast)
{
// If we moved a set of blocks that were at the end of
// a different handler region then we must update ebdHndLast
for (block = HBtab->ebdHndBeg; block != NULL; block = block->bbNext)
{
if (block == bPrev)
{
fgSetHndEnd(HBtab, bPrev);
break;
}
else if (block == HBtab->ebdHndLast->bbNext)
{
// bPrev does not come after the HndBeg
break;
}
}
}
} // end exception table iteration
// We have decided to insert the block(s) after fgLastBlock
fgMoveBlocksAfter(bStart, bLast, insertAfterBlk);
// If bPrev falls through, we will insert a jump to block
fgConnectFallThrough(bPrev, bStart);
// If bLast falls through, we will insert a jump to bNext
fgConnectFallThrough(bLast, bNext);
#endif // FEATURE_EH_FUNCLETS
goto DONE;
FAILURE:
#ifdef DEBUG
if (verbose)
{
printf("*************** Failed fgRelocateEHRange(BB%02u..BB%02u) because %s\n", bStart->bbNum, bLast->bbNum, reason);
}
#endif // DEBUG
bLast = NULL;
DONE:
return bLast;
}
#if FEATURE_EH_FUNCLETS
#if defined(_TARGET_ARM_)
/*****************************************************************************
* We just removed a BBJ_CALLFINALLY/BBJ_ALWAYS pair. If this was the only such pair
* targeting the BBJ_ALWAYS target, then we need to clear the BBF_FINALLY_TARGET bit
* so that target can also be removed. 'block' is the finally target. Since we just
* removed the BBJ_ALWAYS, it better have the BBF_FINALLY_TARGET bit set.
*/
void Compiler::fgClearFinallyTargetBit(BasicBlock* block)
{
assert((block->bbFlags & BBF_FINALLY_TARGET) != 0);
for (flowList* pred = block->bbPreds; pred; pred = pred->flNext)
{
if (pred->flBlock->bbJumpKind == BBJ_ALWAYS &&
pred->flBlock->bbJumpDest == block)
{
BasicBlock* pPrev = pred->flBlock->bbPrev;
if (pPrev != NULL)
{
if (pPrev->bbJumpKind == BBJ_CALLFINALLY)
{
// We found a BBJ_CALLFINALLY / BBJ_ALWAYS that still points to this finally target
return;
}
}
}
}
// Didn't find any BBJ_CALLFINALLY / BBJ_ALWAYS that still points here, so clear the bit
block->bbFlags &= ~BBF_FINALLY_TARGET;
}
#endif // defined(_TARGET_ARM_)
/*****************************************************************************
* Is this an intra-handler control flow edge?
*
* 'block' is the head block of a funclet/handler region, or .
* 'predBlock' is a predecessor block of 'block' in the predecessor list.
*
* 'predBlock' can legally only be one of three things:
* 1. in the same handler region (e.g., the source of a back-edge of a loop from
* 'predBlock' to 'block'), including in nested regions within the handler,
* 2. if 'block' begins a handler that is a filter-handler, 'predBlock' must be in the 'filter' region,
* 3. for other handlers, 'predBlock' must be in the 'try' region corresponding to handler (or any
* region nested in the 'try' region).
*
* Note that on AMD64/ARM64, the BBJ_CALLFINALLY block that calls a finally handler is not
* within the corresponding 'try' region: it is placed in the corresponding 'try' region's
* parent (which might be the main function body). This is how it is represented to the VM
* (with a special "cloned finally" EH table entry).
*
* Return 'true' for case #1, and 'false' otherwise.
*/
bool Compiler::fgIsIntraHandlerPred(BasicBlock* predBlock, BasicBlock* block)
{
// Some simple preconditions (as stated above)
assert(!fgFuncletsCreated);
assert(fgGetPredForBlock(block, predBlock) != NULL);
assert(block->hasHndIndex());
EHblkDsc* xtab = ehGetDsc(block->getHndIndex());
#if FEATURE_EH_CALLFINALLY_THUNKS
if (xtab->HasFinallyHandler())
{
assert((xtab->ebdHndBeg == block) || // The normal case
((xtab->ebdHndBeg->bbNext == block) && (xtab->ebdHndBeg->bbFlags & BBF_INTERNAL))); // After we've already inserted a header block, and we're trying to decide how to split up the predecessor edges.
if (predBlock->bbJumpKind == BBJ_CALLFINALLY)
{
assert(predBlock->bbJumpDest == block);
// A BBJ_CALLFINALLY predecessor of the handler can only come from the corresponding try,
// not from any EH clauses nested in this handler. However, we represent the BBJ_CALLFINALLY
// as being in the 'try' region's parent EH region, which might be the main function body.
unsigned tryIndex = xtab->ebdEnclosingTryIndex;
if (tryIndex == EHblkDsc::NO_ENCLOSING_INDEX)
{
assert(!predBlock->hasTryIndex());
}
else
{
assert(predBlock->hasTryIndex());
assert(tryIndex == predBlock->getTryIndex());
assert(ehGetDsc(tryIndex)->InTryRegionBBRange(predBlock));
}
return false;
}
}
#endif // FEATURE_EH_CALLFINALLY_THUNKS
assert(predBlock->hasHndIndex() || predBlock->hasTryIndex());
// We could search the try region looking for predBlock by using bbInTryRegions
// but that does a lexical search for the block, and then assumes funclets
// have been created and does a lexical search of all funclets that were pulled
// out of the parent try region.
// First, funclets haven't been created yet, and even if they had been, we shouldn't
// have any funclet directly branching to another funclet (they have to return first).
// So we can safely use CheckIsTryRegion instead of bbInTryRegions.
// Second, I believe the depth of any EH graph will on average be smaller than the
// breadth of the blocks within a try body. Thus it is faster to get our answer by
// looping outward over the region graph. However, I have added asserts, as a
// precaution, to ensure both algorithms agree. The asserts also check that the only
// way to reach the head of a funclet is from the corresponding try body or from
// within the funclet (and *not* any nested funclets).
if (predBlock->hasTryIndex())
{
// Because the EH clauses are listed inside-out, any nested trys will be at a
// lower index than the current try and if there's no enclosing try, tryIndex
// will terminate at NO_ENCLOSING_INDEX
unsigned tryIndex = predBlock->getTryIndex();
while (tryIndex < block->getHndIndex())
{
tryIndex = ehGetEnclosingTryIndex(tryIndex);
}
// tryIndex should enclose predBlock
assert((tryIndex == EHblkDsc::NO_ENCLOSING_INDEX) || ehGetDsc(tryIndex)->InTryRegionBBRange(predBlock));
// At this point tryIndex is either block's handler's corresponding try body
// or some outer try region that contains both predBlock & block or
// NO_ENCLOSING_REGION (because there was no try body that encloses both).
if (tryIndex == block->getHndIndex())
{
assert(xtab->InTryRegionBBRange(predBlock));
assert(!xtab->InHndRegionBBRange(predBlock));
return false;
}
// tryIndex should enclose block (and predBlock as previously asserted)
assert((tryIndex == EHblkDsc::NO_ENCLOSING_INDEX) || ehGetDsc(tryIndex)->InTryRegionBBRange(block));
}
if (xtab->HasFilter())
{
// The block is a handler. Check if the pred block is from its filter. We only need to
// check the end filter flag, as there is only a single filter for any handler, and we
// already know predBlock is a predecessor of block.
if (predBlock->bbJumpKind == BBJ_EHFILTERRET)
{
assert(!xtab->InHndRegionBBRange(predBlock));
return false;
}
}
// It is not in our try region (or filter), so it must be within this handler (or try bodies
// within this handler)
assert(!xtab->InTryRegionBBRange(predBlock));
assert(xtab->InHndRegionBBRange(predBlock));
return true;
}
/*****************************************************************************
* Does this block, first block of a handler region, have any predecessor edges
* that are not from its corresponding try region?
*/
bool Compiler::fgAnyIntraHandlerPreds(BasicBlock* block)
{
assert(block->hasHndIndex());
assert(fgFirstBlockOfHandler(block) == block); // this block is the first block of a handler
flowList* pred;
for (pred = block->bbPreds; pred; pred = pred->flNext)
{
BasicBlock* predBlock = pred->flBlock;
if (fgIsIntraHandlerPred(predBlock, block))
{
// We have a predecessor that is not from our try region
return true;
}
}
return false;
}
/*****************************************************************************
* Introduce a new head block of the handler for the prolog to be put in, ahead
* of the current handler head 'block'.
* Note that this code has some similarities to fgCreateLoopPreHeader().
*/
void Compiler::fgInsertFuncletPrologBlock(BasicBlock* block)
{
#ifdef DEBUG
if (verbose)
printf("\nCreating funclet prolog header for BB%02u\n", block->bbNum);
#endif
assert(block->hasHndIndex());
assert(fgFirstBlockOfHandler(block) == block); // this block is the first block of a handler
/* Allocate a new basic block */
BasicBlock* newHead = bbNewBasicBlock(BBJ_NONE);
// In fgComputePreds() we set the BBF_JMP_TARGET and BBF_HAS_LABEL for all of the handler entry points
//
newHead->bbFlags |= (BBF_INTERNAL | BBF_JMP_TARGET | BBF_HAS_LABEL);
newHead->inheritWeight(block);
newHead->bbRefs = 0;
fgInsertBBbefore(block, newHead); // insert the new block in the block list
fgExtendEHRegionBefore(block); // Update the EH table to make the prolog block the first block in the block's EH block.
// fgExtendEHRegionBefore mucks with the bbRefs without updating the pred list, which we will
// do below for this block. So, undo that change.
assert(newHead->bbRefs > 0);
newHead->bbRefs--;
block->bbRefs++;
// Distribute the pred list between newHead and block. Incoming edges coming from outside
// the handler go to the prolog. Edges coming from with the handler are back-edges, and
// go to the existing 'block'.
for (flowList* pred = block->bbPreds; pred; pred = pred->flNext)
{
BasicBlock* predBlock = pred->flBlock;
if (!fgIsIntraHandlerPred(predBlock, block))
{
// It's a jump from outside the handler; add it to the newHead preds list and remove
// it from the block preds list.
switch (predBlock->bbJumpKind)
{
case BBJ_CALLFINALLY:
noway_assert(predBlock->bbJumpDest == block);
predBlock->bbJumpDest = newHead;
fgRemoveRefPred(block, predBlock);
fgAddRefPred(newHead, predBlock);
break;
default:
// The only way into the handler is via a BBJ_CALLFINALLY (to a finally handler), or
// via exception handling.
noway_assert(false);
break;
}
}
}
assert(NULL == fgGetPredForBlock(block, newHead));
fgAddRefPred(block, newHead);
assert((newHead->bbFlags & (BBF_INTERNAL|BBF_JMP_TARGET|BBF_HAS_LABEL)) == (BBF_INTERNAL|BBF_JMP_TARGET|BBF_HAS_LABEL));
}
/*****************************************************************************
*
* Every funclet will have a prolog. That prolog will be inserted as the first instructions
* in the first block of the funclet. If the prolog is also the head block of a loop, we
* would end up with the prolog instructions being executed more than once.
* Check for this by searching the predecessor list for loops, and create a new prolog header
* block when needed. We detect a loop by looking for any predecessor that isn't in the
* handler's try region, since the only way to get into a handler is via that try region.
*/
void Compiler::fgCreateFuncletPrologBlocks()
{
noway_assert(fgComputePredsDone);
noway_assert(!fgDomsComputed); // this function doesn't maintain the dom sets
assert(!fgFuncletsCreated);
bool prologBlocksCreated = false;
EHblkDsc* HBtabEnd;
EHblkDsc* HBtab;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
BasicBlock* head = HBtab->ebdHndBeg;
if (fgAnyIntraHandlerPreds(head))
{
// We need to create a new block in which to place the prolog, and split the existing
// head block predecessor edges into those that should point to the prolog, and those
// that shouldn't.
//
// It's arguable that we should just always do this, and not only when we "need to",
// so there aren't two different code paths. However, it's unlikely to be necessary
// for catch handlers because they have an incoming argument (the exception object)
// that needs to get stored or saved, so back-arcs won't normally go to the head. It's
// possible when writing in IL to generate a legal loop (e.g., push an Exception object
// on the stack before jumping back to the catch head), but C# probably won't. This will
// most commonly only be needed for finallys with a do/while loop at the top of the
// finally.
//
// Note that we don't check filters. This might be a bug, but filters always have a filter
// object live on entry, so it's at least unlikely (illegal?) that a loop edge targets the
// filter head.
fgInsertFuncletPrologBlock(head);
prologBlocksCreated = true;
}
}
if (prologBlocksCreated)
{
// If we've modified the graph, reset the 'modified' flag, since the dominators haven't
// been computed.
fgModified = false;
#if DEBUG
if (verbose)
{
JITDUMP("\nAfter fgCreateFuncletPrologBlocks()");
fgDispBasicBlocks();
fgDispHandlerTab();
}
fgVerifyHandlerTab();
fgDebugCheckBBlist();
#endif // DEBUG
}
}
/*****************************************************************************
*
* Function to create funclets out of all EH catch/finally/fault blocks.
* We only move filter and handler blocks, not try blocks.
*/
void Compiler::fgCreateFunclets()
{
assert(!fgFuncletsCreated);
#ifdef DEBUG
if (verbose)
printf("*************** In fgCreateFunclets()\n");
#endif
fgCreateFuncletPrologBlocks();
unsigned XTnum;
EHblkDsc* HBtab;
const unsigned int funcCnt = ehFuncletCount() + 1;
if (!FitsIn<unsigned short>(funcCnt))
{
IMPL_LIMITATION("Too many funclets");
}
FuncInfoDsc* funcInfo = new (this, CMK_BasicBlock) FuncInfoDsc[funcCnt];
unsigned short funcIdx;
// Setup the root FuncInfoDsc and prepare to start associating
// FuncInfoDsc's with their corresponding EH region
memset(funcInfo, 0, funcCnt * sizeof(FuncInfoDsc));
assert(funcInfo[0].funKind == FUNC_ROOT);
funcIdx = 1;
// Because we iterate from the top to the bottom of the compHndBBtab array, we are iterating
// from most nested (innermost) to least nested (outermost) EH region. It would be reasonable
// to iterate in the opposite order, but the order of funclets shouldn't matter.
//
// We move every handler region to the end of the function: each handler will become a funclet.
//
// Note that fgRelocateEHRange() can add new entries to the EH table. However, they will always
// be added *after* the current index, so our iteration here is not invalidated.
// It *can* invalidate the compHndBBtab pointer itself, though, if it gets reallocated!
for (XTnum = 0;
XTnum < compHndBBtabCount;
XTnum++)
{
HBtab = ehGetDsc(XTnum); // must re-compute this every loop, since fgRelocateEHRange changes the table
if (HBtab->HasFilter())
{
assert(funcIdx < funcCnt);
funcInfo[funcIdx].funKind = FUNC_FILTER;
funcInfo[funcIdx].funEHIndex = (unsigned short)XTnum;
funcIdx++;
}
assert(funcIdx < funcCnt);
funcInfo[funcIdx].funKind = FUNC_HANDLER;
funcInfo[funcIdx].funEHIndex = (unsigned short)XTnum;
HBtab->ebdFuncIndex = funcIdx;
funcIdx++;
fgRelocateEHRange(XTnum, FG_RELOCATE_HANDLER);
}
// We better have populated all of them by now
assert(funcIdx == funcCnt);
// Publish
compCurrFuncIdx = 0;
compFuncInfos = funcInfo;
compFuncInfoCount = (unsigned short)funcCnt;
fgFuncletsCreated = true;
#if DEBUG
if (verbose)
{
JITDUMP("\nAfter fgCreateFunclets()");
fgDispBasicBlocks();
fgDispHandlerTab();
}
fgVerifyHandlerTab();
fgDebugCheckBBlist();
#endif // DEBUG
}
#else // !FEATURE_EH_FUNCLETS
/*****************************************************************************
*
* Function called to relocate any and all EH regions.
* Only entire consecutive EH regions will be moved and they will be kept together.
* Except for the first block, the range can not have any blocks that jump into or out of the region.
*/
bool Compiler::fgRelocateEHRegions()
{
bool result = false; // Our return value
#ifdef DEBUG
if (verbose)
printf("*************** In fgRelocateEHRegions()\n");
#endif
if (fgCanRelocateEHRegions)
{
unsigned XTnum;
EHblkDsc* HBtab;
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
// Nested EH regions cannot be moved.
// Also we don't want to relocate an EH region that has a filter
if ((HBtab->ebdHandlerNestingLevel == 0) && !HBtab->HasFilter())
{
bool movedTry = false;
#if DEBUG
bool movedHnd = false;
#endif // DEBUG
// Only try to move the outermost try region
if (HBtab->ebdEnclosingTryIndex == EHblkDsc::NO_ENCLOSING_INDEX)
{
// Move the entire try region if it can be moved
if (HBtab->ebdTryBeg->isRunRarely())
{
BasicBlock* bTryLastBB = fgRelocateEHRange(XTnum, FG_RELOCATE_TRY);
if (bTryLastBB != NULL)
{
result = true;
movedTry = true;
}
}
#if DEBUG
if (verbose && movedTry)
{
printf("\nAfter relocating an EH try region");
fgDispBasicBlocks();
fgDispHandlerTab();
// Make sure that the predecessor lists are accurate
if (expensiveDebugCheckLevel >= 2)
{
fgDebugCheckBBlist();
}
}
#endif // DEBUG
}
// Currently it is not good to move the rarely run handler regions to the end of the method
// because fgDetermineFirstColdBlock() must put the start of any handler region in the hot section.
#if 0
// Now try to move the entire handler region if it can be moved.
// Don't try to move a finally handler unless we already moved the try region.
if (HBtab->ebdHndBeg->isRunRarely() &&
!HBtab->ebdHndBeg->hasTryIndex() &&
(movedTry || !HBtab->HasFinallyHandler()))
{
BasicBlock* bHndLastBB = fgRelocateEHRange(XTnum, FG_RELOCATE_HANDLER);
if (bHndLastBB != NULL)
{
result = true;
movedHnd = true;
}
}
#endif // 0
#if DEBUG
if (verbose && movedHnd)
{
printf("\nAfter relocating an EH handler region");
fgDispBasicBlocks();
fgDispHandlerTab();
// Make sure that the predecessor lists are accurate
if (expensiveDebugCheckLevel >= 2)
{
fgDebugCheckBBlist();
}
}
#endif // DEBUG
}
}
}
#if DEBUG
fgVerifyHandlerTab();
if (verbose && result)
{
printf("\nAfter fgRelocateEHRegions()");
fgDispBasicBlocks();
fgDispHandlerTab();
// Make sure that the predecessor lists are accurate
fgDebugCheckBBlist();
}
#endif // DEBUG
return result;
}
#endif // !FEATURE_EH_FUNCLETS
bool flowList::setEdgeWeightMinChecked(BasicBlock::weight_t newWeight,
BasicBlock::weight_t slop,
bool* wbUsedSlop)
{
bool result = false;
if ((newWeight <= flEdgeWeightMax) && (newWeight >= flEdgeWeightMin))
{
flEdgeWeightMin = newWeight;
result = true;
}
else if (slop > 0)
{
// We allow for a small amount of inaccuracy in block weight counts.
if (flEdgeWeightMax < newWeight)
{
// We have already determined that this edge's weight
// is less than newWeight, so we just allow for the slop
if (newWeight <= (flEdgeWeightMax + slop))
{
result = true;
if (flEdgeWeightMax != 0)
{
// We will raise flEdgeWeightMin and Max towards newWeight
flEdgeWeightMin = flEdgeWeightMax;
flEdgeWeightMax = newWeight;
}
if (wbUsedSlop != NULL)
{
*wbUsedSlop = true;
}
}
}
else
{
assert(flEdgeWeightMin > newWeight);
// We have already determined that this edge's weight
// is more than newWeight, so we just allow for the slop
if ((newWeight + slop) >= flEdgeWeightMin)
{
result = true;
assert(flEdgeWeightMax != 0);
// We will lower flEdgeWeightMin towards newWeight
flEdgeWeightMin = newWeight;
if (wbUsedSlop != NULL)
{
*wbUsedSlop = true;
}
}
}
// If we are returning true then we should have adjusted the range so that
// the newWeight is in new range [Min..Max] or fgEdjeWeightMax is zero.
// Also we should have set wbUsedSlop to true.
if (result == true)
{
assert( (flEdgeWeightMax == 0) ||
((newWeight <= flEdgeWeightMax) && (newWeight >= flEdgeWeightMin)));
if (wbUsedSlop != NULL)
{
assert(*wbUsedSlop == true);
}
}
}
#if DEBUG
if (result == false)
{
result = false; // break here
}
#endif // DEBUG
return result;
}
bool flowList::setEdgeWeightMaxChecked(BasicBlock::weight_t newWeight,
BasicBlock::weight_t slop,
bool* wbUsedSlop)
{
bool result = false;
if ((newWeight >= flEdgeWeightMin) && (newWeight <= flEdgeWeightMax))
{
flEdgeWeightMax = newWeight;
result = true;
}
else if (slop > 0)
{
// We allow for a small amount of inaccuracy in block weight counts.
if (flEdgeWeightMax < newWeight)
{
// We have already determined that this edge's weight
// is less than newWeight, so we just allow for the slop
if (newWeight <= (flEdgeWeightMax + slop))
{
result = true;
if (flEdgeWeightMax != 0)
{
// We will allow this to raise flEdgeWeightMax towards newWeight
flEdgeWeightMax = newWeight;
}
if (wbUsedSlop != NULL)
{
*wbUsedSlop = true;
}
}
}
else
{
assert(flEdgeWeightMin > newWeight);
// We have already determined that this edge's weight
// is more than newWeight, so we just allow for the slop
if ((newWeight + slop) >= flEdgeWeightMin)
{
result = true;
assert(flEdgeWeightMax != 0);
// We will allow this to lower flEdgeWeightMin and Max towards newWeight
flEdgeWeightMax = flEdgeWeightMin;
flEdgeWeightMin = newWeight;
if (wbUsedSlop != NULL)
{
*wbUsedSlop = true;
}
}
}
// If we are returning true then we should have adjusted the range so that
// the newWeight is in new range [Min..Max] or fgEdjeWeightMax is zero
// Also we should have set wbUsedSlop to true, unless it is NULL
if (result == true)
{
assert( (flEdgeWeightMax == 0) ||
((newWeight <= flEdgeWeightMax) && (newWeight >= flEdgeWeightMin)));
assert((wbUsedSlop == NULL) || (*wbUsedSlop == true));
}
}
#if DEBUG
if (result == false)
{
result = false; // break here
}
#endif // DEBUG
return result;
}
#ifdef DEBUG
void Compiler::fgPrintEdgeWeights()
{
BasicBlock* bSrc;
BasicBlock* bDst;
flowList* edge;
// Print out all of the edge weights
for (bDst = fgFirstBB; bDst != NULL; bDst = bDst->bbNext)
{
if (bDst->bbPreds != NULL)
{
printf(" Edge weights into BB%02u :", bDst->bbNum);
for (edge = bDst->bbPreds; edge != NULL; edge = edge->flNext)
{
bSrc = edge->flBlock;
// This is the control flow edge (bSrc -> bDst)
printf("BB%02u ", bSrc->bbNum);
if (edge->flEdgeWeightMin < BB_MAX_WEIGHT)
{
printf("(%s", refCntWtd2str(edge->flEdgeWeightMin));
}
else
{
printf("(MAX");
}
if (edge->flEdgeWeightMin != edge->flEdgeWeightMax)
{
if (edge->flEdgeWeightMax < BB_MAX_WEIGHT)
{
printf("..%s", refCntWtd2str(edge->flEdgeWeightMax));
}
else
{
printf("..MAX");
}
}
printf(")");
if (edge->flNext != NULL)
{
printf(", ");
}
}
printf("\n");
}
}
}
#endif // DEBUG
// return true if there is a possibility that the method has a loop (a backedge is present)
bool Compiler::fgMightHaveLoop()
{
// Don't use a BlockSet for this temporary bitset of blocks: we don't want to have to call EnsureBasicBlockEpoch()
// and potentially change the block epoch.
BitVecTraits blockVecTraits(fgBBNumMax + 1, this);
BitVec BLOCKSET_INIT_NOCOPY(blocksSeen, BitVecOps::MakeEmpty(&blockVecTraits));
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
BitVecOps::AddElemD(&blockVecTraits, blocksSeen, block->bbNum);
AllSuccessorIter succsEnd = block->GetAllSuccs(this).end();
for (AllSuccessorIter succs = block->GetAllSuccs(this).begin(); succs != succsEnd; ++succs)
{
BasicBlock* succ = (*succs);
if (BitVecOps::IsMember(&blockVecTraits, blocksSeen, succ->bbNum))
return true;
}
}
return false;
}
void Compiler::fgComputeEdgeWeights()
{
#ifdef DEBUG
if (verbose)
printf("*************** In fgComputeEdgeWeights()\n");
#endif // DEBUG
if (fgIsUsingProfileWeights() == false)
{
#ifdef DEBUG
if (verbose)
{
printf("fgComputeEdgeWeights() we do not have any profile data so we are not using the edge weights\n");
}
#endif // DEBUG
fgHaveValidEdgeWeights = false;
fgCalledWeight = BB_UNITY_WEIGHT;
}
#if DEBUG
if (verbose)
{
fgDispBasicBlocks();
printf("\n");
}
#endif // DEBUG
BasicBlock* bSrc;
BasicBlock* bDst;
flowList* edge;
unsigned iterations = 0;
unsigned goodEdgeCountCurrent = 0;
unsigned goodEdgeCountPrevious = 0;
bool inconsistentProfileData = false;
bool hasIncompleteEdgeWeights = false;
unsigned numEdges = 0;
bool usedSlop = false;
bool changed;
bool modified;
BasicBlock::weight_t returnWeight;
BasicBlock::weight_t slop;
// If we have any blocks that did not have profile derived weight
// we will try to fix their weight up here
//
modified = false;
do // while (changed)
{
changed = false;
returnWeight = 0;
iterations++;
for (bDst = fgFirstBB; bDst != NULL; bDst = bDst->bbNext)
{
if (((bDst->bbFlags & BBF_PROF_WEIGHT) == 0) && (bDst->bbPreds != NULL))
{
BasicBlock* bOnlyNext;
// This block does not have a profile derived weight
//
BasicBlock::weight_t newWeight = BB_MAX_WEIGHT;
if (bDst->countOfInEdges() == 1)
{
// Only one block flows into bDst
bSrc = bDst->bbPreds->flBlock;
// Does this block flow into only one other block
if (bSrc->bbJumpKind == BBJ_NONE)
{
bOnlyNext = bSrc->bbNext;
}
else if (bSrc->bbJumpKind == BBJ_ALWAYS)
{
bOnlyNext = bSrc->bbJumpDest;
}
else
{
bOnlyNext = NULL;
}
if ((bOnlyNext == bDst) && ((bSrc->bbFlags & BBF_PROF_WEIGHT) != 0))
{
// We know the exact weight of bDst
newWeight = bSrc->bbWeight;
}
}
// Does this block flow into only one other block
if (bDst->bbJumpKind == BBJ_NONE)
{
bOnlyNext = bDst->bbNext;
}
else if (bDst->bbJumpKind == BBJ_ALWAYS)
{
bOnlyNext = bDst->bbJumpDest;
}
else
{
bOnlyNext = NULL;
}
if ((bOnlyNext != NULL) && (bOnlyNext->bbPreds != NULL))
{
// Does only one block flow into bOnlyNext
if (bOnlyNext->countOfInEdges() == 1)
{
noway_assert(bOnlyNext->bbPreds->flBlock == bDst);
// We know the exact weight of bDst
newWeight = bOnlyNext->bbWeight;
}
}
if ((newWeight != BB_MAX_WEIGHT) && (bDst->bbWeight != newWeight))
{
changed = true;
modified = true;
bDst->bbWeight = newWeight;
if (newWeight == 0)
{
bDst->bbFlags |= BBF_RUN_RARELY;
}
else
{
bDst->bbFlags &= ~BBF_RUN_RARELY;
}
}
}
// Sum up the weights of all of the return blocks and throw blocks
// This is used when we have a back-edge into block 1
//
if (((bDst->bbFlags & BBF_PROF_WEIGHT) != 0) &&
((bDst->bbJumpKind == BBJ_RETURN) || (bDst->bbJumpKind == BBJ_THROW)))
{
returnWeight += bDst->bbWeight;
}
}
}
// Generally when we synthesize profile estimates we do it in a way where this algorithm will converge
// but downstream opts that remove conditional branches may create a situation where this is not the case.
// For instance a loop that becomes unreachable creates a sort of 'ring oscillator' (See test b539509)
while (changed && iterations < 10);
#if DEBUG
if (verbose && modified)
{
printf("fgComputeEdgeWeights() adjusted the weight of some blocks\n");
fgDispBasicBlocks();
printf("\n");
}
#endif
// When we are not using profile data we have already setup fgCalledWeight
// only set it here if we are using profile data
//
if (fgIsUsingProfileWeights())
{
// If the first block has one ref then it's weight is the fgCalledWeight
// otherwise we have backedge's into the first block so instead
// we use the sum of the return block weights.
// If the profile data has a 0 for the returnWeoght
// then just use the first block weight rather than the 0
//
if ((fgFirstBB->countOfInEdges() == 1) || (returnWeight == 0))
{
fgCalledWeight = fgFirstBB->bbWeight;
}
else
{
fgCalledWeight = returnWeight;
}
}
// Now we will compute the initial flEdgeWeightMin and flEdgeWeightMax values
for (bDst = fgFirstBB; bDst != NULL; bDst = bDst->bbNext)
{
BasicBlock::weight_t bDstWeight = bDst->bbWeight;
// We subtract out the called count so that bDstWeight is
// the sum of all edges that go into this block from this method.
//
if (bDst == fgFirstBB)
{
bDstWeight -= fgCalledWeight;
}
for (edge = bDst->bbPreds; edge != NULL; edge = edge->flNext)
{
bool assignOK = true;
bSrc = edge->flBlock;
// We are processing the control flow edge (bSrc -> bDst)
numEdges++;
//
// If the bSrc or bDst blocks do not have exact profile weights
// then we must reset any values that they currently have
//
if (((bSrc->bbFlags & BBF_PROF_WEIGHT) == 0) ||
((bDst->bbFlags & BBF_PROF_WEIGHT) == 0))
{
edge->flEdgeWeightMin = BB_ZERO_WEIGHT;
edge->flEdgeWeightMax = BB_MAX_WEIGHT;
}
slop = BasicBlock::GetSlopFraction(bSrc, bDst) + 1;
switch (bSrc->bbJumpKind)
{
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
case BBJ_NONE:
case BBJ_CALLFINALLY:
// We know the exact edge weight
assignOK &= edge->setEdgeWeightMinChecked(bSrc->bbWeight, slop, &usedSlop);
assignOK &= edge->setEdgeWeightMaxChecked(bSrc->bbWeight, slop, &usedSlop);
break;
case BBJ_COND:
case BBJ_SWITCH:
case BBJ_EHFINALLYRET:
case BBJ_EHFILTERRET:
if (edge->flEdgeWeightMax > bSrc->bbWeight)
{
// The maximum edge weight to block can't be greater than the weight of bSrc
assignOK &= edge->setEdgeWeightMaxChecked(bSrc->bbWeight, slop, &usedSlop);
}
break;
default:
// We should never have an edge that starts from one of these jump kinds
noway_assert(!"Unexpected bbJumpKind");
break;
}
// The maximum edge weight to block can't be greater than the weight of bDst
if (edge->flEdgeWeightMax > bDstWeight)
{
assignOK &= edge->setEdgeWeightMaxChecked(bDstWeight, slop, &usedSlop);
}
if (!assignOK)
{
// Here we have inconsistent profile data
inconsistentProfileData = true;
// No point in continuing
goto EARLY_EXIT;
}
}
}
fgEdgeCount = numEdges;
iterations = 0;
do
{
iterations++;
goodEdgeCountPrevious = goodEdgeCountCurrent;
goodEdgeCountCurrent = 0;
hasIncompleteEdgeWeights = false;
for (bDst = fgFirstBB; bDst != NULL; bDst = bDst->bbNext)
{
for (edge = bDst->bbPreds; edge != NULL; edge = edge->flNext)
{
bool assignOK = true;
// We are processing the control flow edge (bSrc -> bDst)
bSrc = edge->flBlock;
slop = BasicBlock::GetSlopFraction(bSrc, bDst) + 1;
if (bSrc->bbJumpKind == BBJ_COND)
{
int diff;
flowList* otherEdge;
if (bSrc->bbNext == bDst)
{
otherEdge = fgGetPredForBlock(bSrc->bbJumpDest, bSrc);
}
else
{
otherEdge = fgGetPredForBlock(bSrc->bbNext, bSrc);
}
noway_assert(edge->flEdgeWeightMin <= edge->flEdgeWeightMax);
noway_assert(otherEdge->flEdgeWeightMin <= otherEdge->flEdgeWeightMax);
// Adjust edge->flEdgeWeightMin up or adjust otherEdge->flEdgeWeightMax down
diff = ((int) bSrc->bbWeight) - ((int) edge->flEdgeWeightMin + (int) otherEdge->flEdgeWeightMax);
if (diff > 0)
{
assignOK &= edge->setEdgeWeightMinChecked(edge->flEdgeWeightMin + diff, slop, &usedSlop);
}
else if (diff < 0)
{
assignOK &= otherEdge->setEdgeWeightMaxChecked(otherEdge->flEdgeWeightMax + diff, slop, &usedSlop);
}
// Adjust otherEdge->flEdgeWeightMin up or adjust edge->flEdgeWeightMax down
diff = ((int) bSrc->bbWeight) - ((int) otherEdge->flEdgeWeightMin + (int) edge->flEdgeWeightMax);
if (diff > 0)
{
assignOK &= otherEdge->setEdgeWeightMinChecked(otherEdge->flEdgeWeightMin + diff, slop, &usedSlop);
}
else if (diff < 0)
{
assignOK &= edge->setEdgeWeightMaxChecked(edge->flEdgeWeightMax + diff, slop, &usedSlop);
}
if (!assignOK)
{
// Here we have inconsistent profile data
inconsistentProfileData = true;
// No point in continuing
goto EARLY_EXIT;
}
#ifdef DEBUG
// Now edge->flEdgeWeightMin and otherEdge->flEdgeWeightMax) should add up to bSrc->bbWeight
diff = ((int) bSrc->bbWeight) - ((int) edge->flEdgeWeightMin + (int) otherEdge->flEdgeWeightMax);
noway_assert((-((int) slop) <= diff) && (diff <= ((int) slop)));
// Now otherEdge->flEdgeWeightMin and edge->flEdgeWeightMax) should add up to bSrc->bbWeight
diff = ((int) bSrc->bbWeight) - ((int) otherEdge->flEdgeWeightMin + (int) edge->flEdgeWeightMax);
noway_assert((-((int) slop) <= diff) && (diff <= ((int) slop)));
#endif // DEBUG
}
}
}
for (bDst = fgFirstBB; bDst != NULL; bDst = bDst->bbNext)
{
BasicBlock::weight_t bDstWeight = bDst->bbWeight;
if (bDstWeight == BB_MAX_WEIGHT)
{
inconsistentProfileData = true;
// No point in continuing
goto EARLY_EXIT;
}
else
{
// We subtract out the called count so that bDstWeight is
// the sum of all edges that go into this block from this method.
//
if (bDst == fgFirstBB)
{
bDstWeight -= fgCalledWeight;
}
UINT64 minEdgeWeightSum = 0;
UINT64 maxEdgeWeightSum = 0;
// Calculate the sums of the minimum and maximum edge weights
for (edge = bDst->bbPreds; edge != NULL; edge = edge->flNext)
{
// We are processing the control flow edge (bSrc -> bDst)
bSrc = edge->flBlock;
maxEdgeWeightSum += edge->flEdgeWeightMax;
minEdgeWeightSum += edge->flEdgeWeightMin;
}
// maxEdgeWeightSum is the sum of all flEdgeWeightMax values into bDst
// minEdgeWeightSum is the sum of all flEdgeWeightMin values into bDst
for (edge = bDst->bbPreds; edge != NULL; edge = edge->flNext)
{
bool assignOK = true;
// We are processing the control flow edge (bSrc -> bDst)
bSrc = edge->flBlock;
slop = BasicBlock::GetSlopFraction(bSrc, bDst) + 1;
// otherMaxEdgesWeightSum is the sum of all of the other edges flEdgeWeightMax values
// This can be used to compute a lower bound for our minimum edge weight
noway_assert(maxEdgeWeightSum >= edge->flEdgeWeightMax);
UINT64 otherMaxEdgesWeightSum = maxEdgeWeightSum - edge->flEdgeWeightMax;
// otherMinEdgesWeightSum is the sum of all of the other edges flEdgeWeightMin values
// This can be used to compute an upper bound for our maximum edge weight
noway_assert(minEdgeWeightSum >= edge->flEdgeWeightMin);
UINT64 otherMinEdgesWeightSum = minEdgeWeightSum - edge->flEdgeWeightMin;
if (bDstWeight >= otherMaxEdgesWeightSum)
{
// minWeightCalc is our minWeight when every other path to bDst takes it's flEdgeWeightMax value
BasicBlock::weight_t minWeightCalc = (BasicBlock::weight_t)(bDstWeight - otherMaxEdgesWeightSum);
if (minWeightCalc > edge->flEdgeWeightMin)
{
assignOK &= edge->setEdgeWeightMinChecked(minWeightCalc, slop, &usedSlop);
}
}
if (bDstWeight >= otherMinEdgesWeightSum)
{
// maxWeightCalc is our maxWeight when every other path to bDst takes it's flEdgeWeightMin value
BasicBlock::weight_t maxWeightCalc = (BasicBlock::weight_t)(bDstWeight - otherMinEdgesWeightSum);
if (maxWeightCalc < edge->flEdgeWeightMax)
{
assignOK &= edge->setEdgeWeightMaxChecked(maxWeightCalc, slop, &usedSlop);
}
}
if (!assignOK)
{
// Here we have inconsistent profile data
inconsistentProfileData = true;
// No point in continuing
goto EARLY_EXIT;
}
// When flEdgeWeightMin equals flEdgeWeightMax we have a "good" edge weight
if (edge->flEdgeWeightMin == edge->flEdgeWeightMax)
{
// Count how many "good" edge weights we have
// Each time through we should have more "good" weights
// We exit the while loop when no longer find any new "good" edges
goodEdgeCountCurrent++;
}
else
{
// Remember that we have seen at least one "Bad" edge weight
// so that we will repeat the while loop again
hasIncompleteEdgeWeights = true;
}
}
}
}
if (inconsistentProfileData)
{
hasIncompleteEdgeWeights = true;
break;
}
if (numEdges == goodEdgeCountCurrent)
{
noway_assert(hasIncompleteEdgeWeights == false);
break;
}
} while (hasIncompleteEdgeWeights && (goodEdgeCountCurrent > goodEdgeCountPrevious) && (iterations < 8));
EARLY_EXIT:;
#ifdef DEBUG
if (verbose)
{
if (inconsistentProfileData)
{
printf("fgComputeEdgeWeights() found inconsistent profile data, not using the edge weights\n");
}
else
{
if (hasIncompleteEdgeWeights)
{
printf("fgComputeEdgeWeights() was able to compute exact edge weights for %3d of the %3d edges, using %d passes.\n",
goodEdgeCountCurrent, numEdges, iterations);
}
else
{
printf("fgComputeEdgeWeights() was able to compute exact edge weights for all of the %3d edges, using %d passes.\n",
numEdges, iterations);
}
fgPrintEdgeWeights();
}
}
#endif // DEBUG
fgSlopUsedInEdgeWeights = usedSlop;
fgRangeUsedInEdgeWeights = false;
// See if any edge weight are expressed in [min..max] form
for (bDst = fgFirstBB; bDst != NULL; bDst = bDst->bbNext)
{
if (bDst->bbPreds != NULL)
{
for (edge = bDst->bbPreds; edge != NULL; edge = edge->flNext)
{
bSrc = edge->flBlock;
// This is the control flow edge (bSrc -> bDst)
if (edge->flEdgeWeightMin != edge->flEdgeWeightMax)
{
fgRangeUsedInEdgeWeights = true;
break;
}
}
if (fgRangeUsedInEdgeWeights)
{
break;
}
}
}
fgHaveValidEdgeWeights = !inconsistentProfileData;
fgEdgeWeightsComputed = true;
}
// fgOptimizeBranchToEmptyUnconditional:
// optimize a jump to an empty block which ends in an unconditional branch.
// Args:
// block: source block
// bDest: destination
// Returns: true if we changed the code
//
bool Compiler::fgOptimizeBranchToEmptyUnconditional(BasicBlock* block, BasicBlock* bDest)
{
bool optimizeJump = true;
assert(bDest->isEmpty());
assert(bDest->bbJumpKind == BBJ_ALWAYS);
// We do not optimize jumps between two different try regions.
// However jumping to a block that is not in any try region is OK
//
if (bDest->hasTryIndex() && !BasicBlock::sameTryRegion(block, bDest))
{
optimizeJump = false;
}
// Don't optimize a jump to a removed block
if (bDest->bbJumpDest->bbFlags & BBF_REMOVED)
{
optimizeJump = false;
}
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// Don't optimize a jump to a finally target. For BB1->BB2->BB3, where
// BB2 is a finally target, if we changed BB1 to jump directly to BB3,
// it would skip the finally target. BB1 might be a BBJ_ALWAYS block part
// of a BBJ_CALLFINALLY/BBJ_ALWAYS pair, so changing the finally target
// would change the unwind behavior.
if (bDest->bbFlags & BBF_FINALLY_TARGET)
{
optimizeJump = false;
}
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// Must optimize jump if bDest has been removed
//
if (bDest->bbFlags & BBF_REMOVED)
{
optimizeJump = true;
}
// If we are optimizing using real profile weights
// then don't optimize a conditional jump to an unconditional jump
// until after we have computed the edge weights
//
if (fgIsUsingProfileWeights() && !fgEdgeWeightsComputed)
{
fgNeedsUpdateFlowGraph = true;
optimizeJump = false;
}
if (optimizeJump)
{
#ifdef DEBUG
if (verbose)
{
printf("\nOptimizing a jump to an unconditional jump (BB%02u -> BB%02u -> BB%02u)\n",
block->bbNum, bDest->bbNum, bDest->bbJumpDest->bbNum);
}
#endif // DEBUG
//
// When we optimize a branch to branch we need to update the profile weight
// of bDest by subtracting out the block/edge weight of the path that is being optimized.
//
if (fgHaveValidEdgeWeights && ((bDest->bbFlags & BBF_PROF_WEIGHT) != 0))
{
flowList* edge1 = fgGetPredForBlock(bDest, block);
noway_assert(edge1 != NULL);
BasicBlock::weight_t edgeWeight;
if (edge1->flEdgeWeightMin != edge1->flEdgeWeightMax)
{
//
// We only have an estimate for the edge weight
//
edgeWeight = (edge1->flEdgeWeightMin + edge1->flEdgeWeightMax) / 2;
//
// Clear the profile weight flag
//
bDest->bbFlags &= ~BBF_PROF_WEIGHT;
}
else
{
//
// We only have the exact edge weight
//
edgeWeight = edge1->flEdgeWeightMin;
}
//
// Update the bDest->bbWeight
//
if (bDest->bbWeight > edgeWeight)
{
bDest->bbWeight -= edgeWeight;
}
else
{
bDest->bbWeight = BB_ZERO_WEIGHT;
bDest->bbFlags |= BBF_RUN_RARELY; // Set the RarelyRun flag
}
flowList* edge2 = fgGetPredForBlock(bDest->bbJumpDest, bDest);
if (edge2 != NULL)
{
//
// Update the edge2 min/max weights
//
if (edge2->flEdgeWeightMin > edge1->flEdgeWeightMin)
{
edge2->flEdgeWeightMin -= edge1->flEdgeWeightMin;
}
else
{
edge2->flEdgeWeightMin = BB_ZERO_WEIGHT;
}
if (edge2->flEdgeWeightMax > edge1->flEdgeWeightMin)
{
edge2->flEdgeWeightMax -= edge1->flEdgeWeightMin;
}
else
{
edge2->flEdgeWeightMax = BB_ZERO_WEIGHT;
}
}
}
// Optimize the JUMP to empty unconditional JUMP to go to the new target
block->bbJumpDest = bDest->bbJumpDest;
fgAddRefPred(bDest->bbJumpDest, block, fgRemoveRefPred(bDest, block));
return true;
}
return false;
}
// fgOptimizeEmptyBlock:
// Does flow optimization of an empty block (can remove it in some cases)
//
// Args:
// block: an empty block
// Returns: true if we changed the code
bool Compiler::fgOptimizeEmptyBlock(BasicBlock* block)
{
assert(block->isEmpty());
BasicBlock* bPrev = block->bbPrev;
switch (block->bbJumpKind)
{
case BBJ_COND:
case BBJ_SWITCH:
case BBJ_THROW:
/* can never happen */
noway_assert(!"Conditional, switch, or throw block with empty body!");
break;
case BBJ_CALLFINALLY:
case BBJ_RETURN:
case BBJ_EHCATCHRET:
case BBJ_EHFINALLYRET:
case BBJ_EHFILTERRET:
/* leave them as is */
/* some compilers generate multiple returns and put all of them at the end -
* to solve that we need the predecessor list */
break;
case BBJ_ALWAYS:
// A GOTO cannot be to the next block since that
// should have been fixed by the optimization above
// An exception is made for a jump from Hot to Cold
noway_assert(block->bbJumpDest != block->bbNext ||
((bPrev != nullptr) && bPrev->isBBCallAlwaysPair()) ||
fgInDifferentRegions(block, block->bbNext));
/* Cannot remove the first BB */
if (!bPrev)
break;
/* Do not remove a block that jumps to itself - used for while (true){} */
if (block->bbJumpDest == block)
break;
/* Empty GOTO can be removed iff bPrev is BBJ_NONE */
if (bPrev->bbJumpKind != BBJ_NONE)
break;
// can't allow fall through into cold code
if (block->bbNext == fgFirstColdBlock)
break;
/* Can fall through since this is similar with removing
* a BBJ_NONE block, only the successor is different */
__fallthrough;
case BBJ_NONE:
/* special case if this is the first BB */
if (!bPrev)
{
assert (block == fgFirstBB);
}
else
{
/* If this block follows a BBJ_CALLFINALLY do not remove it
* (because we don't know who may jump to it) */
if (bPrev->bbJumpKind == BBJ_CALLFINALLY)
break;
}
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
/* Don't remove finally targets */
if (block->bbFlags & BBF_FINALLY_TARGET)
break;
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
#if FEATURE_EH_FUNCLETS
/* Don't remove an empty block that is in a different EH region
* from its successor block, if the block is the target of a
* catch return. It is required that the return address of a
* catch be in the correct EH region, for re-raise of thread
* abort exceptions to work. Insert a NOP in the empty block
* to ensure we generate code for the block, if we keep it.
*/
{
BasicBlock* succBlock;
if (block->bbJumpKind == BBJ_ALWAYS)
{
succBlock = block->bbJumpDest;
}
else
{
succBlock = block->bbNext;
}
if ((succBlock != NULL) &&
!BasicBlock::sameEHRegion(block, succBlock))
{
// The empty block and the block that follows it are in different
// EH regions. Is this a case where they can't be merged?
bool okToMerge = true; // assume it's ok
for (flowList* pred = block->bbPreds; pred; pred = pred->flNext)
{
if (pred->flBlock->bbJumpKind == BBJ_EHCATCHRET)
{
assert(pred->flBlock->bbJumpDest == block);
okToMerge = false; // we can't get rid of the empty block
break;
}
}
if (!okToMerge)
{
// Insert a NOP in the empty block to ensure we generate code
// for the catchret target in the right EH region.
GenTreePtr nopStmt =
fgInsertStmtAtEnd(block, new (this, GT_NO_OP) GenTree(GT_NO_OP, TYP_VOID));
fgSetStmtSeq(nopStmt);
gtSetStmtInfo(nopStmt);
#ifdef DEBUG
if (verbose)
{
printf("\nKeeping empty block BB%02u - it is the target of a catch return\n",
block->bbNum);
}
#endif // DEBUG
break; // go to the next block
}
}
}
#endif // FEATURE_EH_FUNCLETS
if (!ehCanDeleteEmptyBlock(block))
{
// We're not allowed to remove this block due to reasons related to the EH table.
break;
}
/* special case if this is the last BB */
if (block == fgLastBB)
{
if (!bPrev)
break;
fgLastBB = bPrev;
}
/* Remove the block */
compCurBB = block;
fgRemoveBlock(block, false);
return true;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
return false;
}
// fgOptimizeSwitchBranches:
// Does flow optimization for a switch - bypasses jumps to empty unconditional branches,
// and transforms degenerate switch cases like those with 1 or 2 targets
//
// Args:
// block: BasicBlock that contains the switch
// Returns: true if we changed the code
//
bool Compiler::fgOptimizeSwitchBranches(BasicBlock* block)
{
assert(block->bbJumpKind == BBJ_SWITCH);
unsigned jmpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jmpTab = block->bbJumpSwt->bbsDstTab;
BasicBlock* bNewDest; // the new jump target for the current switch case
BasicBlock* bDest;
bool returnvalue = false;
do
{
REPEAT_SWITCH:;
bDest = *jmpTab;
bNewDest = bDest;
// Do we have a JUMP to an empty unconditional JUMP block?
if (bDest->isEmpty() &&
(bDest->bbJumpKind == BBJ_ALWAYS) &&
(bDest != bDest->bbJumpDest)) // special case for self jumps
{
bool optimizeJump = true;
// We do not optimize jumps between two different try regions.
// However jumping to a block that is not in any try region is OK
//
if (bDest->hasTryIndex() && !BasicBlock::sameTryRegion(block, bDest))
{
optimizeJump = false;
}
// If we are optimize using real profile weights
// then don't optimize a switch jump to an unconditional jump
// until after we have computed the edge weights
//
if (fgIsUsingProfileWeights() && !fgEdgeWeightsComputed)
{
fgNeedsUpdateFlowGraph = true;
optimizeJump = false;
}
if (optimizeJump)
{
bNewDest = bDest->bbJumpDest;
#ifdef DEBUG
if (verbose)
{
printf("\nOptimizing a switch jump to an empty block with an unconditional jump (BB%02u -> BB%02u -> BB%02u)\n",
block->bbNum, bDest->bbNum, bNewDest->bbNum);
}
#endif // DEBUG
}
}
if (bNewDest != bDest)
{
//
// When we optimize a branch to branch we need to update the profile weight
// of bDest by subtracting out the block/edge weight of the path that is being optimized.
//
if (fgIsUsingProfileWeights() && ((bDest->bbFlags & BBF_PROF_WEIGHT) != 0))
{
if (fgHaveValidEdgeWeights)
{
flowList* edge = fgGetPredForBlock(bDest, block);
BasicBlock::weight_t branchThroughWeight = edge->flEdgeWeightMin;
if (bDest->bbWeight > branchThroughWeight)
{
bDest->bbWeight -= branchThroughWeight;
}
else
{
bDest->bbWeight = BB_ZERO_WEIGHT;
bDest->bbFlags |= BBF_RUN_RARELY;
}
}
}
// Update the switch jump table
*jmpTab = bNewDest;
// Maintain, if necessary, the set of unique targets of "block."
UpdateSwitchTableTarget(block, bDest, bNewDest);
fgAddRefPred(bNewDest, block, fgRemoveRefPred(bDest, block));
// we optimized a Switch label - goto REPEAT_SWITCH to follow this new jump
returnvalue = true;
goto REPEAT_SWITCH;
}
}
while (++jmpTab, --jmpCnt);
GenTreeStmt* switchStmt = block->lastTopLevelStmt();
GenTreePtr switchTree = switchStmt->gtStmtExpr;
// If this is a Lowered switch, it must have no embedded statements, because we pulled
// out any embedded statements when we cloned the switch value.
if (switchTree->gtOper == GT_SWITCH_TABLE)
{
noway_assert(fgOrder == FGOrderLinear);
assert(switchStmt->AsStmt()->gtStmtIsTopLevel() &&
(switchStmt->gtNext == nullptr));
}
else
{
noway_assert(switchTree->gtOper == GT_SWITCH);
}
noway_assert(switchTree->gtType == TYP_VOID);
// At this point all of the case jump targets have been updated such
// that none of them go to block that is an empty unconditional block
//
jmpTab = block->bbJumpSwt->bbsDstTab;
jmpCnt = block->bbJumpSwt->bbsCount;
// Now check for two trivial switch jumps.
//
if (block->NumSucc(this) == 1)
{
// Use BBJ_ALWAYS for a switch with only a default clause, or with only one unique successor.
BasicBlock* uniqueSucc = jmpTab[0];
#ifdef DEBUG
if (verbose)
{
printf("\nRemoving a switch jump with a single target (BB%02u)\n",
block->bbNum);
printf("BEFORE:\n");
}
#endif // DEBUG
/* check for SIDE_EFFECTS */
if (switchTree->gtFlags & GTF_SIDE_EFFECT)
{
/* Extract the side effects from the conditional */
GenTreePtr sideEffList = NULL;
gtExtractSideEffList(switchTree, &sideEffList);
if (sideEffList == NULL)
goto NO_SWITCH_SIDE_EFFECT;
noway_assert(sideEffList->gtFlags & GTF_SIDE_EFFECT);
#ifdef DEBUG
if (verbose)
{
printf("\nSwitch expression has side effects! Extracting side effects...\n");
gtDispTree(switchTree); printf("\n");
gtDispTree(sideEffList); printf("\n");
}
#endif // DEBUG
/* Replace the conditional statement with the list of side effects */
noway_assert(sideEffList->gtOper != GT_STMT);
noway_assert(sideEffList->gtOper != GT_SWITCH);
switchStmt->gtStmtExpr = sideEffList;
if (fgStmtListThreaded)
{
/* Update the lclvar ref counts */
compCurBB = block;
fgUpdateRefCntForExtract(switchTree, sideEffList);
/* Update ordering, costs, FP levels, etc. */
gtSetStmtInfo(switchStmt);
/* Re-link the nodes for this statement */
fgSetStmtSeq(switchStmt);
}
}
else
{
NO_SWITCH_SIDE_EFFECT:
/* conditional has NO side effect - remove it */
fgRemoveStmt(block, switchStmt);
}
// Change the switch jump into a BBJ_ALWAYS
block->bbJumpDest = block->bbJumpSwt->bbsDstTab[0];
block->bbJumpKind = BBJ_ALWAYS;
if (jmpCnt > 1)
{
for (unsigned i = 1; i < jmpCnt; ++i)
{
(void) fgRemoveRefPred(jmpTab[i], block);
}
}
return true;
}
else if (block->bbJumpSwt->bbsCount == 2 &&
block->bbJumpSwt->bbsDstTab[1] == block->bbNext)
{
/* Use a BBJ_COND(switchVal==0) for a switch with only one
significant clause besides the default clause, if the
default clause is bbNext */
GenTree* switchVal = switchTree->gtOp.gtOp1;
noway_assert(genActualTypeIsIntOrI(switchVal->TypeGet()));
// Change the GT_SWITCH(switchVal) into GT_JTRUE(GT_EQ(switchVal==0)).
// Also mark the node as GTF_DONT_CSE as further down JIT is not capable of handling it.
// For example CSE could determine that the expression rooted at GT_EQ is a candidate cse and
// replace it with a COMMA node. In such a case we will end up with GT_JTRUE node pointing to
// a COMMA node which results in noway asserts in fgMorphSmpOp(), optAssertionGen() and rpPredictTreeRegUse().
// For the same reason fgMorphSmpOp() marks GT_JTRUE nodes with RELOP children as GTF_DONT_CSE.
#ifdef DEBUG
if (verbose)
{
printf("\nConverting a switch (BB%02u) with only one significant clause besides a default target to a conditional branch\n",
block->bbNum);
}
#endif // DEBUG
switchTree->ChangeOper(GT_JTRUE);
GenTree* zeroConstNode = gtNewZeroConNode(genActualType(switchVal->TypeGet()));
GenTree* condNode = gtNewOperNode(GT_EQ, TYP_INT,
switchVal,
zeroConstNode);
switchTree->gtOp.gtOp1 = condNode;
switchTree->gtOp.gtOp1->gtFlags |= (GTF_RELOP_JMP_USED | GTF_DONT_CSE);
// Re-link the nodes for this statement.
// We know that this is safe for the Lowered form, because we will have eliminated any embedded trees
// when we cloned the switch condition (it is also asserted above).
fgSetStmtSeq(switchStmt);
block->bbJumpDest = block->bbJumpSwt->bbsDstTab[0];
block->bbJumpKind = BBJ_COND;
return true;
}
return returnvalue;
}
// fgBlockEndFavorsTailDuplication:
// Heuristic function that returns true if this block ends in a statement that looks favorable
// for tail-duplicating its successor (such as assigning a constant to a local).
// Args:
// block: BasicBlock we are considering duplicating the successor of
// Returns:
// true if it seems like a good idea
//
bool Compiler::fgBlockEndFavorsTailDuplication(BasicBlock *block)
{
if (block->isRunRarely())
return false;
if (!block->lastTopLevelStmt())
return false;
else
{
// Tail duplication tends to pay off when the last statement
// is an assignment of a constant, arraylength, or a relop.
// This is because these statements produce information about values
// that would otherwise be lost at the upcoming merge point.
GenTreeStmt* lastStmt = block->lastTopLevelStmt();
GenTree* tree = lastStmt->gtStmtExpr;
if (tree->gtOper != GT_ASG)
return false;
GenTree* op2 = tree->gtOp.gtOp2;
if (op2->gtOper != GT_ARR_LENGTH
&& !op2->OperIsConst()
&& ((op2->OperKind() & GTK_RELOP) == 0))
{
return false;
}
}
return true;
}
// fgBlockIsGoodTailDuplicationCandidate:
// Heuristic function that examines a block (presumably one that is a merge point) to determine
// if it should be duplicated.
// args:
// target - the tail block (candidate for duplication)
// returns:
// true if this block seems like a good candidate for duplication
//
bool Compiler::fgBlockIsGoodTailDuplicationCandidate(BasicBlock *target)
{
GenTreeStmt* stmt = target->FirstNonPhiDef();
// Here we are looking for blocks with a single statement feeding a conditional branch.
// These blocks are small, and when duplicated onto the tail of blocks that end in
// assignments, there is a high probability of the branch completely going away.
// This is by no means the only kind of tail that it is beneficial to duplicate,
// just the only one we recognize for now.
if (stmt != target->lastStmt())
return false;
if (target->bbJumpKind != BBJ_COND)
return false;
GenTree* tree = stmt->gtStmtExpr;
if (tree->gtOper != GT_JTRUE)
return false;
// must be some kind of relational operator
GenTree* cond = tree->gtOp.gtOp1;
if (!(cond->OperKind() & GTK_RELOP))
return false;
// op1 must be some combinations of casts of local or constant
GenTree* op1 = cond->gtOp.gtOp1;
while (op1->gtOper == GT_CAST)
op1 = op1->gtOp.gtOp1;
if (!op1->IsLocal() && !op1->OperIsConst())
return false;
// op2 must be some combinations of casts of local or constant
GenTree* op2 = cond->gtOp.gtOp2;
while (op2->gtOper == GT_CAST)
op2 = op2->gtOp.gtOp1;
if (!op2->IsLocal() && !op2->OperIsConst())
return false;
return true;
}
// fgOptimizeUncondBranchToSimpleCond:
// For a block which has an unconditional branch, look to see if its target block
// is a good candidate for tail duplication, and if so do that duplication.
//
// Args:
// block - block with uncond branch
// target - block which is target of first block
//
// returns: true if changes were made
bool Compiler::fgOptimizeUncondBranchToSimpleCond(BasicBlock* block, BasicBlock* target)
{
assert(block->bbJumpKind == BBJ_ALWAYS);
assert(block->bbJumpDest == target);
// TODO-Review: OK if they are in the same region?
if (compHndBBtabCount > 0)
return false;
if (!fgBlockIsGoodTailDuplicationCandidate(target))
return false;
if (!fgBlockEndFavorsTailDuplication(block))
return false;
GenTreeStmt* stmt = target->FirstNonPhiDef();
// Duplicate the target block at the end of this block
GenTree* cloned = gtCloneExpr(stmt->gtStmtExpr);
noway_assert(cloned);
GenTree *jmpStmt = gtNewStmt(cloned);
block->bbJumpKind = BBJ_COND;
block->bbJumpDest = target->bbJumpDest;
fgAddRefPred(block->bbJumpDest, block);
fgRemoveRefPred(target, block);
// add an unconditional block after this block to jump to the target block's fallthrough block
BasicBlock *next = fgNewBBafter(BBJ_ALWAYS, block, true);
next->bbFlags = block->bbFlags | BBF_INTERNAL;
next->bbFlags &= ~(BBF_TRY_BEG | BBF_LOOP_HEAD | BBF_LOOP_CALL0 | BBF_LOOP_CALL1 | BBF_HAS_LABEL | BBF_JMP_TARGET |
BBF_FUNCLET_BEG | BBF_LOOP_PREHEADER | BBF_KEEP_BBJ_ALWAYS);
next->bbJumpDest = target->bbNext;
target->bbNext->bbFlags |= BBF_JMP_TARGET;
fgAddRefPred(next, block);
fgAddRefPred(next->bbJumpDest, next);
#ifdef DEBUG
if (verbose)
{
printf("fgOptimizeUncondBranchToSimpleCond(from BB%02u to cond BB%02u), created new uncond BB%02u\n",
block->bbNum, target->bbNum, next->bbNum);
}
#endif // DEBUG
if (fgStmtListThreaded)
{
gtSetStmtInfo(jmpStmt);
}
fgInsertStmtAtEnd(block, jmpStmt);
return true;
}
// fgOptimizeBranchToNext:
// Optimize a block which has a branch to the following block
// Args:
// block - block with a branch
// bNext - block which is both next and the target of the first block
// bPrev - block which is prior to the first block
//
// returns: true if changes were made
//
bool Compiler::fgOptimizeBranchToNext(BasicBlock* block, BasicBlock* bNext, BasicBlock* bPrev)
{
assert(block->bbJumpKind == BBJ_COND || block->bbJumpKind == BBJ_ALWAYS);
assert(block->bbJumpDest == bNext);
assert(block->bbNext = bNext);
assert(block->bbPrev == bPrev);
if (block->bbJumpKind == BBJ_ALWAYS)
{
// We can't remove it if it is a branch from hot => cold
if (!fgInDifferentRegions(block, bNext))
{
// We can't remove if it is marked as BBF_KEEP_BBJ_ALWAYS
if (!(block->bbFlags & BBF_KEEP_BBJ_ALWAYS))
{
// We can't remove if the BBJ_ALWAYS is part of a BBJ_CALLFINALLY pair
if ( (bPrev == nullptr) || !bPrev->isBBCallAlwaysPair() )
{
/* the unconditional jump is to the next BB */
block->bbJumpKind = BBJ_NONE;
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
return true;
#ifdef DEBUG
if (verbose)
{
printf("\nRemoving unconditional jump to next block (BB%02u -> BB%02u) (converted BB%02u to fall-through)\n",
block->bbNum, bNext->bbNum, block->bbNum);
}
#endif // DEBUG
}
}
}
}
else
{
/* remove the conditional statement at the end of block */
noway_assert(block->bbJumpKind == BBJ_COND);
noway_assert(block->bbTreeList);
GenTreeStmt* cond = block->lastTopLevelStmt();
noway_assert(cond->gtStmtExpr->gtOper == GT_JTRUE);
#ifdef DEBUG
if (verbose)
{
printf("\nRemoving conditional jump to next block (BB%02u -> BB%02u)\n",
block->bbNum, bNext->bbNum);
}
#endif // DEBUG
/* check for SIDE_EFFECTS */
if (cond->gtStmtExpr->gtFlags & GTF_SIDE_EFFECT)
{
if (compRationalIRForm)
{
// Extracting side-effects won't work in rationalized form.
// Instead just transform the JTRUE into a NEG which has the effect of
// evaluating the side-effecting tree and perform a benign operation on it.
// TODO-CQ: [TFS:1121057] We should be able to simply remove the jump node,
// and change gtStmtExpr to its op1.
cond->gtStmtExpr->SetOper(GT_NEG);
cond->gtStmtExpr->gtType = TYP_I_IMPL;
}
else
{
/* Extract the side effects from the conditional */
GenTreePtr sideEffList = NULL;
gtExtractSideEffList(cond->gtStmtExpr, &sideEffList);
if (sideEffList == NULL)
{
compCurBB = block;
fgRemoveStmt(block, cond);
}
else
{
noway_assert(sideEffList->gtFlags & GTF_SIDE_EFFECT);
#ifdef DEBUG
if (verbose)
{
printf("\nConditional has side effects! Extracting side effects...\n");
gtDispTree(cond); printf("\n");
gtDispTree(sideEffList); printf("\n");
}
#endif // DEBUG
/* Replace the conditional statement with the list of side effects */
noway_assert(sideEffList->gtOper != GT_STMT);
noway_assert(sideEffList->gtOper != GT_JTRUE);
cond->gtStmtExpr = sideEffList;
if (fgStmtListThreaded)
{
/* Update the lclvar ref counts */
compCurBB = block;
fgUpdateRefCntForExtract(cond->gtStmtExpr, sideEffList);
/* Update ordering, costs, FP levels, etc. */
gtSetStmtInfo(cond);
/* Re-link the nodes for this statement */
fgSetStmtSeq(cond);
}
}
}
}
else
{
compCurBB = block;
/* conditional has NO side effect - remove it */
fgRemoveStmt(block, cond);
}
/* Conditional is gone - simply fall into the next block */
block->bbJumpKind = BBJ_NONE;
block->bbFlags &= ~BBF_NEEDS_GCPOLL;
/* Update bbRefs and bbNum - Conditional predecessors to the same
* block are counted twice so we have to remove one of them */
noway_assert(bNext->countOfInEdges() > 1);
fgRemoveRefPred(bNext, block);
return true;
}
return false;
}
/*****************************************************************************
*
* Function called to optimize an unconditional branch that branches
* to a conditional branch.
* Currently we require that the conditional branch jump back to the
* block that follows the unconditional branch.
*
* We can improve the code execution and layout by concatenating a copy
* of the conditional branch block at the end of the conditional branch
* and reversing the sense of the branch.
*
* This is only done when the amount of code to be copied is smaller than
* our calculated threshold in maxDupCostSz.
*
*/
bool Compiler::fgOptimizeBranch(BasicBlock* bJump)
{
if (opts.MinOpts())
return false;
if (bJump->bbJumpKind != BBJ_ALWAYS)
return false;
if (bJump->bbFlags & BBF_KEEP_BBJ_ALWAYS)
return false;
// Don't hoist a conditional branch into the scratch block; we'd prefer it stay
// either BBJ_NONE or BBJ_ALWAYS.
if (fgBBisScratch(bJump))
return false;
BasicBlock* bDest = bJump->bbJumpDest;
if (bDest->bbJumpKind != BBJ_COND)
return false;
if (bDest->bbJumpDest != bJump->bbNext)
return false;
// do not jump into another try region
BasicBlock* bDestNext = bDest->bbNext;
if (bDestNext->hasTryIndex() && !BasicBlock::sameTryRegion(bJump, bDestNext))
return false;
GenTreeStmt* stmt;
unsigned estDupCostSz = 0;
for (stmt = bDest->firstStmt(); stmt; stmt = stmt->gtNextStmt)
{
GenTreePtr expr = stmt->gtStmtExpr;
/* We call gtPrepareCost to measure the cost of duplicating this tree */
gtPrepareCost(expr);
estDupCostSz += expr->gtCostSz;
}
bool allProfileWeightsAreValid = false;
BasicBlock::weight_t weightJump = bJump->bbWeight;
BasicBlock::weight_t weightDest = bDest->bbWeight;
BasicBlock::weight_t weightNext = bJump->bbNext->bbWeight;
bool rareJump = bJump->isRunRarely();
bool rareDest = bDest->isRunRarely();
bool rareNext = bJump->bbNext->isRunRarely();
// If we have profile data then we calculate the number of time
// the loop will iterate into loopIterations
if (fgIsUsingProfileWeights())
{
// Only rely upon the profile weight when all three of these blocks
// have either good profile weights or are rarelyRun
//
if ((bJump->bbFlags & (BBF_PROF_WEIGHT | BBF_RUN_RARELY)) &&
(bDest->bbFlags & (BBF_PROF_WEIGHT | BBF_RUN_RARELY)) &&
(bJump->bbNext->bbFlags & (BBF_PROF_WEIGHT | BBF_RUN_RARELY)))
{
allProfileWeightsAreValid = true;
if ((weightJump * 100) < weightDest)
{
rareJump = true;
}
if ((weightNext * 100) < weightDest)
{
rareNext = true;
}
if (((weightDest * 100) < weightJump) &&
((weightDest * 100) < weightNext))
{
rareDest = true;
}
}
}
unsigned maxDupCostSz = 6;
//
// Branches between the hot and rarely run regions
// should be minimized. So we allow a larger size
//
if (rareDest != rareJump)
{
maxDupCostSz += 6;
}
if (rareDest != rareNext)
{
maxDupCostSz += 6;
}
//
// We we are ngen-ing:
// If the uncondional branch is a rarely run block then
// we are willing to have more code expansion since we
// won't be running code from this page
//
if (opts.eeFlags & CORJIT_FLG_PREJIT)
{
if (rareJump)
{
maxDupCostSz *= 2;
}
}
// If the compare has too high cost then we don't want to dup
bool costIsTooHigh = (estDupCostSz > maxDupCostSz);
#ifdef DEBUG
if (verbose)
{
printf("\nDuplication of the conditional block BB%02u (always branch from BB%02u) %s, because the cost of duplication (%i) is %s than %i,"
" validProfileWeights = %s\n",
bDest->bbNum,
bJump->bbNum,
costIsTooHigh ? "not done" : "performed",
estDupCostSz,
costIsTooHigh ? "greater" : "less or equal",
maxDupCostSz,
allProfileWeightsAreValid ? "true" : "false");
}
#endif // DEBUG
if (costIsTooHigh)
{
return false;
}
/* Looks good - duplicate the conditional block */
GenTree* newStmtList = NULL; // new stmt list to be added to bJump
GenTree* newStmtLast = NULL;
bool cloneExprFailed = false;
/* Visit all the statements in bDest */
for (GenTree* curStmt = bDest->bbTreeList; curStmt; curStmt = curStmt->gtNext)
{
/* Clone/substitute the expression */
stmt = gtCloneExpr(curStmt)->AsStmt();
// cloneExpr doesn't handle everything
if (stmt == NULL)
{
cloneExprFailed = true;
break;
}
/* Append the expression to our list */
if (newStmtList != NULL)
{
newStmtLast->gtNext = stmt;
}
else
{
newStmtList = stmt;
}
stmt->gtPrev = newStmtLast;
newStmtLast = stmt;
}
if (cloneExprFailed)
return false;
noway_assert(newStmtLast != NULL);
noway_assert(stmt != NULL);
noway_assert(stmt->gtOper == GT_STMT);
if ((newStmtLast == NULL) || (stmt == NULL) || (stmt->gtOper != GT_STMT))
return false;
/* Get to the condition node from the statement tree */
GenTreePtr condTree = stmt->gtStmtExpr;
noway_assert(condTree->gtOper == GT_JTRUE);
if (condTree->gtOper != GT_JTRUE)
return false;
//
// Set condTree to the operand to the GT_JTRUE
//
condTree = condTree->gtOp.gtOp1;
//
// This condTree has to be a RelOp comparison
//
if (condTree->OperIsCompare() == false)
return false;
// Bump up the ref-counts of any variables in 'stmt'
fgUpdateRefCntForClone(bJump, stmt->gtStmtExpr);
//
// Find the last statement in the bJump block
//
GenTreeStmt* lastStmt = NULL;
for (stmt = bJump->firstStmt(); stmt; stmt = stmt->gtNextStmt)
{
lastStmt = stmt;
}
stmt = bJump->firstStmt();
/* Join the two linked lists */
newStmtLast->gtNext = NULL;
if (lastStmt != NULL)
{
stmt->gtPrev = newStmtLast;
lastStmt->gtNext = newStmtList;
newStmtList->gtPrev = lastStmt;
}
else
{
bJump->bbTreeList = newStmtList;
newStmtList->gtPrev = newStmtLast;
}
//
// Reverse the sense of the compare
//
gtReverseCond(condTree);
bJump->bbJumpKind = BBJ_COND;
bJump->bbJumpDest = bDest->bbNext;
/* Mark the jump dest block as being a jump target */
bJump->bbJumpDest->bbFlags |= BBF_JMP_TARGET|BBF_HAS_LABEL;
/* Update bbRefs and bbPreds */
// bJump now falls through into the next block
//
fgAddRefPred(bJump->bbNext, bJump);
// bJump no longer jumps to bDest
//
fgRemoveRefPred(bDest, bJump);
// bJump now jumps to bDest->bbNext
//
fgAddRefPred(bDest->bbNext, bJump);
if (weightJump > 0)
{
if (allProfileWeightsAreValid)
{
if (weightDest > weightJump)
{
bDest->bbWeight = (weightDest - weightJump);
}
else if (!bDest->isRunRarely())
{
bDest->bbWeight = BB_UNITY_WEIGHT;
}
}
else
{
BasicBlock::weight_t newWeightDest = 0;
BasicBlock::weight_t unloopWeightDest = 0;
if (weightDest > weightJump)
{
newWeightDest = (weightDest - weightJump);
}
if (weightDest >= (BB_LOOP_WEIGHT*BB_UNITY_WEIGHT)/2)
{
newWeightDest = (weightDest*2) / (BB_LOOP_WEIGHT*BB_UNITY_WEIGHT);
}
if ((newWeightDest > 0) || (unloopWeightDest > 0))
{
bDest->bbWeight = Max(newWeightDest, unloopWeightDest);
}
}
}
#if DEBUG
if (verbose)
{
printf("\nAfter this change in fgOptimizeBranch");
fgDispBasicBlocks(verboseTrees);
printf("\n");
}
#endif // DEBUG
return true;
}
/*****************************************************************************
*
* Function called to optimize switch statements
*/
bool Compiler::fgOptimizeSwitchJumps()
{
bool result = false; // Our return value
#if 0
// TODO-CQ: Add switch jump optimizations?
if (!fgHasSwitch)
return false;
if (!fgHaveValidEdgeWeights)
return false;
for (BasicBlock* bSrc = fgFirstBB; bSrc != NULL; bSrc = bSrc->bbNext)
{
if (bSrc->bbJumpKind == BBJ_SWITCH)
{
unsigned jumpCnt; jumpCnt = bSrc->bbJumpSwt->bbsCount;
BasicBlock** jumpTab; jumpTab = bSrc->bbJumpSwt->bbsDstTab;
do
{
BasicBlock* bDst = *jumpTab;
flowList* edgeToDst = fgGetPredForBlock(bDst, bSrc);
double outRatio = (double) edgeToDst->flEdgeWeightMin / (double) bSrc->bbWeight;
if (outRatio >= 0.60)
{
// straighten switch here...
}
}
while (++jumpTab, --jumpCnt);
}
}
#endif
return result;
}
#ifdef _PREFAST_
#pragma warning(push)
#pragma warning(disable:21000) // Suppress PREFast warning about overly large function
#endif
/*****************************************************************************
*
* Function called to reorder the flowgraph of BasicBlocks such that any
* rarely run blocks are placed at the end of the block list.
* If we have profile information we also use that information to reverse
* all conditional jumps that would benefit.
*/
void Compiler::fgReorderBlocks()
{
noway_assert(opts.compDbgCode == false);
#if FEATURE_EH_FUNCLETS
assert(fgFuncletsCreated);
#endif // FEATURE_EH_FUNCLETS
// We can't relocate anything if we only have one block
if (fgFirstBB->bbNext == NULL)
{
return;
}
bool newRarelyRun = false;
bool movedBlocks = false;
bool optimizedSwitches = false;
// First let us expand the set of run rarely blocks
newRarelyRun |= fgExpandRarelyRunBlocks();
#if !FEATURE_EH_FUNCLETS
movedBlocks |= fgRelocateEHRegions();
#endif // !FEATURE_EH_FUNCLETS
//
// If we are using profile weights we can change some
// switch jumps into conditional test and jump
//
if (fgIsUsingProfileWeights())
{
//
// Note that this is currently not yet implemented
//
optimizedSwitches = fgOptimizeSwitchJumps();
if (optimizedSwitches)
{
fgUpdateFlowGraph();
}
}
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgReorderBlocks()\n");
printf("\nInitial BasicBlocks");
fgDispBasicBlocks(verboseTrees);
printf("\n");
}
#endif // DEBUG
BasicBlock* bNext;
BasicBlock* bPrev;
BasicBlock* block;
unsigned XTnum;
EHblkDsc* HBtab;
// Iterate over every block, remembering our previous block in bPrev
for (bPrev = fgFirstBB, block = bPrev->bbNext;
block != NULL;
bPrev = block, block = block->bbNext)
{
//
// Consider relocating the rarely run blocks such that they are at the end of the method.
// We also consider reversing conditional branches so that they become a not taken forwards branch.
//
// If block is marked with a BBF_KEEP_BBJ_ALWAYS flag then we don't move the block
if ((block->bbFlags & BBF_KEEP_BBJ_ALWAYS) != 0)
continue;
// Finally and handlers blocks are to be kept contiguous.
// TODO-CQ: Allow reordering within the handler region
if (block->hasHndIndex() == true)
continue;
bool reorderBlock = true; // This is set to false if we decide not to reorder 'block'
bool isRare = block->isRunRarely();
BasicBlock* bDest = NULL;
bool forwardBranch = false;
bool backwardBranch = false;
// Setup bDest
if ((bPrev->bbJumpKind == BBJ_COND) || (bPrev->bbJumpKind == BBJ_ALWAYS))
{
bDest = bPrev->bbJumpDest;
forwardBranch = fgIsForwardBranch(bPrev);
backwardBranch = !forwardBranch;
}
// We will look for bPrev as a non rarely run block followed by block as a rarely run block
//
if (bPrev->isRunRarely())
{
reorderBlock = false;
}
// If the weights of the bPrev, block and bDest were all obtained from a profile run
// then we can use them to decide if it is useful to reverse this conditional branch
BasicBlock::weight_t profHotWeight = -1;
if ((bPrev->bbFlags & BBF_PROF_WEIGHT) &&
(block->bbFlags & BBF_PROF_WEIGHT) &&
((bDest == NULL) || (bDest->bbFlags & BBF_PROF_WEIGHT)))
{
//
// All blocks have profile information
//
if (forwardBranch)
{
if (bPrev->bbJumpKind == BBJ_ALWAYS)
{
// We can pull up the blocks that the unconditional jump branches to
// if the weight of bDest is greater or equal to the weight of block
// also the weight of bDest can't be zero.
//
if ((bDest->bbWeight < block->bbWeight) || (bDest->bbWeight == 0))
{
reorderBlock = false;
}
else
{
//
// If this remains true then we will try to pull up bDest to succeed bPrev
//
bool moveDestUp = true;
if (fgHaveValidEdgeWeights)
{
//
// The edge bPrev -> bDest must have a higher minimum weight
// than every other edge into bDest
//
flowList* edgeFromPrev = fgGetPredForBlock(bDest, bPrev);
noway_assert(edgeFromPrev != NULL);
// Examine all of the other edges into bDest
for (flowList* edge = bDest->bbPreds; edge != NULL; edge = edge->flNext)
{
if (edge != edgeFromPrev)
{
if (edge->flEdgeWeightMax >= edgeFromPrev->flEdgeWeightMin)
{
moveDestUp = false;
break;
}
}
}
}
else
{
//
// The block bPrev must have a higher weight
// than every other block that goes into bDest
//
// Examine all of the other edges into bDest
for (flowList* edge = bDest->bbPreds; edge != NULL; edge = edge->flNext)
{
BasicBlock* bTemp = edge->flBlock;
if ((bTemp != bPrev) && (bTemp->bbWeight >= bPrev->bbWeight))
{
moveDestUp = false;
break;
}
}
}
// Are we still good to move bDest up to bPrev?
if (moveDestUp)
{
//
// We will consider all blocks that have less weight than profHotWeight to be
// uncommonly run blocks as compared with the hot path of bPrev taken-jump to bDest
//
profHotWeight = bDest->bbWeight - 1;
}
else
{
if (block->isRunRarely())
{
// We will move any rarely run blocks blocks
profHotWeight = 0;
}
else
{
// We will move all blocks that have a weight less or equal to our fall through block
profHotWeight = block->bbWeight + 1;
}
// But we won't try to connect with bDest
bDest = NULL;
}
}
}
else // (bPrev->bbJumpKind == BBJ_COND)
{
noway_assert(bPrev->bbJumpKind == BBJ_COND);
//
// We will reverse branch if the taken-jump to bDest ratio (i.e. 'takenRatio')
// is more than 51%
//
// We will setup profHotWeight to be maximum bbWeight that a block
// could have for us not to want to reverse the conditional branch
//
// We will consider all blocks that have less weight than profHotWeight to be
// uncommonly run blocks as compared with the hot path of bPrev taken-jump to bDest
//
if (fgHaveValidEdgeWeights)
{
// We have valid edge weights, however even with valid edge weights
// we may have a minimum and maximum range for each edges value
//
// We will check that the min weight of the bPrev to bDest edge
// is more than twice the max weight of the bPrev to block edge.
//
// bPrev --> [BB04, weight 31]
// | \
// edgeToBlock -------------> O \
// [min=8,max=10] V \
// block --> [BB05, weight 10] \
// \
// edgeToDest ----------------------------> O
// [min=21,max=23] |
// V
// bDest ---------------> [BB08, weight 21]
//
flowList* edgeToDest = fgGetPredForBlock(bDest, bPrev);
flowList* edgeToBlock = fgGetPredForBlock(block, bPrev);
noway_assert(edgeToDest != NULL);
noway_assert(edgeToBlock != NULL);
//
// Calculate the taken ratio
// A takenRation of 0.10 means taken 10% of the time, not taken 90% of the time
// A takenRation of 0.50 means taken 50% of the time, not taken 50% of the time
// A takenRation of 0.90 means taken 90% of the time, not taken 10% of the time
//
double takenCount = ((double) edgeToDest->flEdgeWeightMin + (double) edgeToDest->flEdgeWeightMax) / 2.0;
double notTakenCount = ((double) edgeToBlock->flEdgeWeightMin + (double) edgeToBlock->flEdgeWeightMax) / 2.0;
double totalCount = takenCount + notTakenCount;
double takenRatio = takenCount / totalCount;
// If the takenRatio is greater or equal to 51% then we will reverse the branch
if (takenRatio < 0.51)
{
reorderBlock = false;
}
else
{
// set profHotWeight
profHotWeight = (edgeToBlock->flEdgeWeightMin + edgeToBlock->flEdgeWeightMax)/2 - 1;
}
}
else
{
// We don't have valid edge weight so we will be more conservative
// We could have bPrev, block or bDest as part of a loop and thus have extra weight
//
// We will do two checks:
// 1. Check that the weight of bDest is at least two times more than block
// 2. Check that the weight of bPrev is at least three times more than block
//
// bPrev --> [BB04, weight 31]
// | \
// V \
// block --> [BB05, weight 10] \
// \
// |
// V
// bDest ---------------> [BB08, weight 21]
//
// For this case weightDest is calculated as (21+1)/2 or 11
// and weightPrev is calculated as (31+2)/3 also 11
//
// Generally both weightDest and weightPrev should calculate
// the same value unless bPrev or bDest are part of a loop
//
BasicBlock::weight_t weightDest = bDest->isMaxBBWeight() ? bDest->bbWeight : (bDest->bbWeight+1) / 2;
BasicBlock::weight_t weightPrev = bPrev->isMaxBBWeight() ? bPrev->bbWeight : (bPrev->bbWeight+2) / 3;
// select the lower of weightDest and weightPrev
profHotWeight = (weightDest < weightPrev) ? weightDest : weightPrev;
// if the weight of block is greater (or equal) to profHotWeight then we don't reverse the cond
if (block->bbWeight >= profHotWeight)
{
reorderBlock = false;
}
}
}
}
else // not a forwardBranch
{
if (bPrev->bbFallsThrough())
{
goto CHECK_FOR_RARE;
}
// Here we should pull up the highest weight block remaining
// and place it here since bPrev does not fall through.
BasicBlock::weight_t highestWeight = 0;
BasicBlock* candidateBlock = NULL;
BasicBlock* lastNonFallThroughBlock = bPrev;
BasicBlock* bTmp = bPrev->bbNext;
while (bTmp != NULL)
{
// Don't try to split a Call/Always pair
//
if (bTmp->isBBCallAlwaysPair())
{
// Move bTmp forward
bTmp = bTmp->bbNext;
}
//
// Check for loop exit condition
//
if (bTmp == NULL)
break;
//
// if its weight is the highest one we've seen and
// the EH regions allow for us to place bTmp after bPrev
//
if ((bTmp->bbWeight > highestWeight) && fgEhAllowsMoveBlock(bPrev, bTmp))
{
// When we have a current candidateBlock that is a conditional (or unconditional) jump
// to bTmp (which is a higher weighted block) then it is better to keep out current
// candidateBlock and have it fall into bTmp
//
if ((candidateBlock == NULL) ||
((candidateBlock->bbJumpKind != BBJ_COND) && (candidateBlock->bbJumpKind != BBJ_ALWAYS)) ||
(candidateBlock->bbJumpDest != bTmp))
{
// otherwise we have a new candidateBlock
//
highestWeight = bTmp->bbWeight;
candidateBlock = lastNonFallThroughBlock->bbNext;
}
}
if ((bTmp->bbFallsThrough() == false) || (bTmp->bbWeight == 0))
{
lastNonFallThroughBlock = bTmp;
}
bTmp = bTmp->bbNext;
}
// If we didn't find a suitable block then skip this
if (highestWeight == 0)
{
reorderBlock = false;
}
else
{
noway_assert(candidateBlock != NULL);
// If the candidateBlock is the same a block then skip this
if (candidateBlock == block)
{
reorderBlock = false;
}
else
{
// Set bDest to the block that we want to come after bPrev
bDest = candidateBlock;
// set profHotWeight
profHotWeight = highestWeight-1;
}
}
}
}
else // we don't have good profile info (or we are falling through)
{
CHECK_FOR_RARE:;
/* We only want to reorder when we have a rarely run */
/* block right after a normal block, */
/* (bPrev is known to be a normal block at this point) */
if (!isRare)
{
reorderBlock = false;
}
else
{
/* If the jump target bDest is also a rarely run block then we don't want to do the reversal */
if (bDest && bDest->isRunRarely())
{
reorderBlock = false; /* Both block and bDest are rarely run */
}
else
{
// We will move any rarely run blocks blocks
profHotWeight = 0;
}
}
}
if (reorderBlock == false)
{
//
// Check for an unconditional branch to a conditional branch
// which also branches back to our next block
//
if (fgOptimizeBranch(bPrev))
{
noway_assert(bPrev->bbJumpKind == BBJ_COND);
}
continue;
}
// Now we need to determine which blocks should be moved
//
// We consider one of two choices:
//
// 1. Moving the fall-through blocks (or rarely run blocks) down to
// later in the method and hopefully connecting the jump dest block
// so that it becomes the fall through block
//
// And when bDest in not NULL, we also consider:
//
// 2. Moving the bDest block (or blocks) up to bPrev
// so that it could be used as a fall through block
//
// We will prefer option #1 if we are able to connect the jump dest
// block as the fall though block otherwise will we try to use option #2
//
//
// Consider option #1: relocating blocks starting at 'block'
// to later in flowgraph
//
// We set bStart to the first block that will be relocated
// and bEnd to the last block that will be relocated
BasicBlock* bStart = block;
BasicBlock* bEnd = bStart;
bNext = bEnd->bbNext;
bool connected_bDest = false;
if ((backwardBranch && !isRare) ||
((block->bbFlags & BBF_DONT_REMOVE) != 0)) // Don't choose option #1 when block is the start of a try region
{
bStart = NULL;
bEnd = NULL;
}
else
{
while (true)
{
// Don't try to split a Call/Always pair
//
if (bEnd->isBBCallAlwaysPair())
{
// Move bEnd and bNext forward
bEnd = bNext;
bNext = bNext->bbNext;
}
//
// Check for loop exit condition
//
if (bNext == NULL)
break;
#if FEATURE_EH_FUNCLETS
// Check if we've reached the funclets region, at the end of the function
if (fgFirstFuncletBB == bEnd->bbNext)
break;
#endif // FEATURE_EH_FUNCLETS
if (bNext == bDest)
{
connected_bDest = true;
break;
}
// All the blocks must have the same try index
// and must not have the BBF_DONT_REMOVE flag set
if ( !BasicBlock::sameTryRegion(bStart, bNext) ||
((bNext->bbFlags & BBF_DONT_REMOVE) != 0) )
{
// exit the loop, bEnd is now set to the
// last block that we want to relocate
break;
}
// If we are relocating rarely run blocks..
if (isRare)
{
// ... then all blocks must be rarely run
if (!bNext->isRunRarely())
{
// exit the loop, bEnd is now set to the
// last block that we want to relocate
break;
}
}
else
{
// If we are moving blocks that are hot then all
// of the blocks moved must be less than profHotWeight */
if (bNext->bbWeight >= profHotWeight)
{
// exit the loop, bEnd is now set to the
// last block that we would relocate
break;
}
}
// Move bEnd and bNext forward
bEnd = bNext;
bNext = bNext->bbNext;
}
// Set connected_bDest to true if moving blocks [bStart .. bEnd]
// connects with the the jump dest of bPrev (i.e bDest) and
// thus allows bPrev fall through instead of jump.
if (bNext == bDest)
{
connected_bDest = true;
}
}
// Now consider option #2: Moving the jump dest block (or blocks)
// up to bPrev
//
// The variables bStart2, bEnd2 and bPrev2 are used for option #2
//
// We will setup bStart2 to the first block that will be relocated
// and bEnd2 to the last block that will be relocated
// and bPrev2 to be the lexical pred of bDest
//
// If after this calculation bStart2 is NULL we cannot use option #2,
// otherwise bStart2, bEnd2 and bPrev2 are all non-NULL and we will use option #2
BasicBlock* bStart2 = NULL;
BasicBlock* bEnd2 = NULL;
BasicBlock* bPrev2 = NULL;
// If option #1 didn't connect bDest and bDest isn't NULL
if ((connected_bDest == false) &&
(bDest != NULL) &&
// The jump target cannot be moved if it has the BBF_DONT_REMOVE flag set
((bDest->bbFlags & BBF_DONT_REMOVE) == 0))
{
// We will consider option #2: relocating blocks starting at 'bDest' to succeed bPrev
//
// setup bPrev2 to be the lexical pred of bDest
bPrev2 = block;
while (bPrev2 != NULL)
{
if (bPrev2->bbNext == bDest)
break;
bPrev2 = bPrev2->bbNext;
}
if ((bPrev2 != NULL) && fgEhAllowsMoveBlock(bPrev, bDest))
{
// We have decided that relocating bDest to be after bPrev is best
// Set bStart2 to the first block that will be relocated
// and bEnd2 to the last block that will be relocated
//
// Assigning to bStart2 selects option #2
//
bStart2 = bDest;
bEnd2 = bStart2;
bNext = bEnd2->bbNext;
while (true)
{
// Don't try to split a Call/Always pair
//
if (bEnd2->isBBCallAlwaysPair())
{
noway_assert(bNext->bbJumpKind == BBJ_ALWAYS);
// Move bEnd2 and bNext forward
bEnd2 = bNext;
bNext = bNext->bbNext;
}
// Check for the Loop exit conditions
if (bNext == NULL)
break;
if (bEnd2->bbFallsThrough() == false)
break;
// If we are relocating rarely run blocks..
// All the blocks must have the same try index,
// and must not have the BBF_DONT_REMOVE flag set
if ( !BasicBlock::sameTryRegion(bStart2, bNext) ||
((bNext->bbFlags & BBF_DONT_REMOVE) != 0) )
{
// exit the loop, bEnd2 is now set to the
// last block that we want to relocate
break;
}
if (isRare)
{
/* ... then all blocks must not be rarely run */
if (bNext->isRunRarely())
{
// exit the loop, bEnd2 is now set to the
// last block that we want to relocate
break;
}
}
else
{
// If we are relocating hot blocks
// all blocks moved must be greater than profHotWeight
if (bNext->bbWeight <= profHotWeight)
{
// exit the loop, bEnd2 is now set to the
// last block that we want to relocate
break;
}
}
// Move bEnd2 and bNext forward
bEnd2 = bNext;
bNext = bNext->bbNext;
}
}
}
// If we are using option #1 then ...
if (bStart2 == NULL)
{
// Don't use option #1 for a backwards branch
if (bStart == NULL)
continue;
// .... Don't move a set of blocks that are already at the end of the main method
if (bEnd == fgLastBBInMainFunction())
continue;
}
#ifdef DEBUG
if (verbose)
{
if (bDest != NULL)
{
if (bPrev->bbJumpKind == BBJ_COND)
{
printf("Decided to reverse conditional branch at block BB%02u branch to BB%02u ", bPrev->bbNum, bDest->bbNum);
}
else if (bPrev->bbJumpKind == BBJ_ALWAYS)
{
printf("Decided to straighten unconditional branch at block BB%02u branch to BB%02u ", bPrev->bbNum, bDest->bbNum);
}
else
{
printf("Decided to place hot code after BB%02u, placed BB%02u after this block ", bPrev->bbNum, bDest->bbNum);
}
if (profHotWeight > 0)
{
printf("because of IBC profile data\n");
}
else
{
if (bPrev->bbFallsThrough())
{
printf("since it falls into a rarely run block\n");
}
else
{
printf("since it is succeeded by a rarely run block\n");
}
}
}
else
{
printf("Decided to relocate block(s) after block BB%02u since they are %s block(s)\n",
bPrev->bbNum, block->isRunRarely() ? "rarely run" : "uncommonly run");
}
}
#endif // DEBUG
// We will set insertAfterBlk to the block the precedes our insertion range
// We will set bStartPrev to be the block that precedes the set of blocks that we are moving
BasicBlock* insertAfterBlk;
BasicBlock* bStartPrev;
if (bStart2 != NULL)
{
// Option #2: relocating blocks starting at 'bDest' to follow bPrev
// Update bStart and bEnd so that we can use these two for all later operations
bStart = bStart2;
bEnd = bEnd2;
// Set bStartPrev to be the block that comes before bStart
bStartPrev = bPrev2;
// We will move [bStart..bEnd] to immediately after bPrev
insertAfterBlk = bPrev;
}
else
{
// option #1: Moving the fall-through blocks (or rarely run blocks) down to later in the method
// Set bStartPrev to be the block that come before bStart
bStartPrev = bPrev;
// We will move [bStart..bEnd] but we will pick the insert location later
insertAfterBlk = NULL;
}
// We are going to move [bStart..bEnd] so they can't be NULL
noway_assert(bStart != NULL);
noway_assert(bEnd != NULL);
// bEnd can't be a BBJ_CALLFINALLY unless it is a RETLESS call
noway_assert((bEnd->bbJumpKind != BBJ_CALLFINALLY) || (bEnd->bbFlags & BBF_RETLESS_CALL));
// bStartPrev must be set to the block that precedes bStart
noway_assert(bStartPrev->bbNext == bStart);
// Since we will be unlinking [bStart..bEnd],
// we need to compute and remember if bStart is in each of
// the try and handler regions
//
bool* fStartIsInTry = NULL;
bool* fStartIsInHnd = NULL;
if (compHndBBtabCount > 0)
{
fStartIsInTry = new (this, CMK_Unknown) bool[compHndBBtabCount];
fStartIsInHnd = new (this, CMK_Unknown) bool[compHndBBtabCount];
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
fStartIsInTry[XTnum] = HBtab->InTryRegionBBRange(bStart);
fStartIsInHnd[XTnum] = HBtab->InHndRegionBBRange(bStart);
}
}
/* Temporarily unlink [bStart..bEnd] from the flow graph */
fgUnlinkRange(bStart, bEnd);
if (insertAfterBlk == NULL)
{
// Find new location for the unlinked block(s)
// Set insertAfterBlk to the block which will precede the insertion point
if (!bStart->hasTryIndex() && isRare)
{
// We'll just insert the blocks at the end of the method. If the method
// has funclets, we will insert at the end of the main method but before
// any of the funclets. Note that we create funclets before we call
// fgReorderBlocks().
insertAfterBlk = fgLastBBInMainFunction();
noway_assert(insertAfterBlk != bPrev);
}
else
{
BasicBlock* startBlk;
BasicBlock* lastBlk;
EHblkDsc* ehDsc = ehInitTryBlockRange(bStart, &startBlk, &lastBlk);
BasicBlock* endBlk;
/* Setup startBlk and endBlk as the range to search */
if (ehDsc != nullptr)
{
endBlk = lastBlk->bbNext;
/*
Multiple (nested) try regions might start from the same BB.
For example,
try3 try2 try1
|--- |--- |--- BB01
| | | BB02
| | |--- BB03
| | BB04
| |------------ BB05
| BB06
|------------------- BB07
Now if we want to insert in try2 region, we will start with startBlk=BB01.
The following loop will allow us to start from startBlk==BB04.
*/
while (!BasicBlock::sameTryRegion(startBlk, bStart) && (startBlk != endBlk))
{
startBlk = startBlk->bbNext;
}
// startBlk cannot equal endBlk as it must come before endBlk
if (startBlk == endBlk)
goto CANNOT_MOVE;
// we also can't start searching the try region at bStart
if (startBlk == bStart)
{
// if bEnd is the last block in the method or
// or if bEnd->bbNext is in a different try region
// then we cannot move the blocks
//
if ((bEnd->bbNext == NULL) || !BasicBlock::sameTryRegion(startBlk, bEnd->bbNext))
goto CANNOT_MOVE;
startBlk = bEnd->bbNext;
// Check that the new startBlk still comes before endBlk
// startBlk cannot equal endBlk as it must come before endBlk
if (startBlk == endBlk)
goto CANNOT_MOVE;
BasicBlock* tmpBlk = startBlk;
while ((tmpBlk != endBlk) && (tmpBlk != NULL))
{
tmpBlk = tmpBlk->bbNext;
}
// when tmpBlk is NULL that means startBlk is after endBlk
// so there is no way to move bStart..bEnd within the try region
if (tmpBlk == NULL)
goto CANNOT_MOVE;
}
}
else
{
noway_assert(isRare == false);
/* We'll search through the entire main method */
startBlk = fgFirstBB;
endBlk = fgEndBBAfterMainFunction();
}
// Calculate nearBlk and jumpBlk and then call fgFindInsertPoint()
// to find our insertion block
//
{
// If the set of blocks that we are moving ends with a BBJ_ALWAYS to
// another [rarely run] block that comes after bPrev (forward branch)
// then we can set up nearBlk to eliminate this jump sometimes
//
BasicBlock* nearBlk = NULL;
BasicBlock* jumpBlk = NULL;
if ((bEnd->bbJumpKind == BBJ_ALWAYS) &&
(!isRare || bEnd->bbJumpDest->isRunRarely()) &&
fgIsForwardBranch(bEnd, bPrev))
{
// Set nearBlk to be the block in [startBlk..endBlk]
// such that nearBlk->bbNext == bEnd->JumpDest
// if no such block exists then set nearBlk to NULL
nearBlk = startBlk;
jumpBlk = bEnd;
do
{
// We do not want to set nearBlk to bPrev
// since then we will not move [bStart..bEnd]
//
if (nearBlk != bPrev)
{
// Check if nearBlk satisfies our requirement
if (nearBlk->bbNext == bEnd->bbJumpDest)
break;
}
// Did we reach the endBlk?
if (nearBlk == endBlk)
{
nearBlk = NULL;
break;
}
// advance nearBlk to the next block
nearBlk = nearBlk->bbNext;
} while (nearBlk != NULL);
}
// if nearBlk is NULL then we set nearBlk to be the
// first block that we want to insert after.
if (nearBlk == NULL)
{
if (bDest != NULL)
{
// we want to insert after bDest
nearBlk = bDest;
}
else
{
// we want to insert after bPrev
nearBlk = bPrev;
}
}
/* Set insertAfterBlk to the block which we will insert after. */
insertAfterBlk = fgFindInsertPoint(bStart->bbTryIndex,
true, // Insert in the try region.
startBlk, endBlk,
nearBlk, jumpBlk,
bStart->bbWeight == BB_ZERO_WEIGHT);
}
/* See if insertAfterBlk is the same as where we started, */
/* or if we could not find any insertion point */
if ((insertAfterBlk == bPrev) ||
(insertAfterBlk == NULL))
{
CANNOT_MOVE:;
/* We couldn't move the blocks, so put everything back */
/* relink [bStart .. bEnd] into the flow graph */
bPrev->setNext(bStart);
if (bEnd->bbNext)
bEnd->bbNext->bbPrev = bEnd;
#ifdef DEBUG
if (verbose)
{
if (bStart != bEnd)
{
printf("Could not relocate blocks (BB%02u .. BB%02u)\n",
bStart->bbNum, bEnd->bbNum);
}
else
{
printf("Could not relocate block BB%02u\n",
bStart->bbNum);
}
}
#endif // DEBUG
continue;
}
}
}
noway_assert(insertAfterBlk != NULL);
noway_assert(bStartPrev != NULL);
noway_assert(bStartPrev != insertAfterBlk);
#ifdef DEBUG
movedBlocks = true;
if (verbose)
{
const char * msg;
if (bStart2 != NULL)
{
msg = "hot";
}
else
{
if (isRare)
{
msg = "rarely run";
}
else
{
msg = "uncommon";
}
}
printf("Relocated %s ", msg);
if (bStart != bEnd)
{
printf("blocks (BB%02u .. BB%02u)",
bStart->bbNum, bEnd->bbNum);
}
else
{
printf("block BB%02u",
bStart->bbNum);
}
if (bPrev->bbJumpKind == BBJ_COND)
{
printf(" by reversing conditional jump at BB%02u\n", bPrev->bbNum);
}
else
{
printf("\n", bPrev->bbNum);
}
}
#endif // DEBUG
if (bPrev->bbJumpKind == BBJ_COND)
{
/* Reverse the bPrev jump condition */
GenTree* condTest = bPrev->lastStmt();
condTest = condTest->gtStmt.gtStmtExpr;
noway_assert(condTest->gtOper == GT_JTRUE);
condTest->gtOp.gtOp1 = gtReverseCond(condTest->gtOp.gtOp1);
if (bStart2 == NULL)
{
/* Set the new jump dest for bPrev to the rarely run or uncommon block(s) */
bPrev->bbJumpDest = bStart;
bStart->bbFlags |= (BBF_JMP_TARGET | BBF_HAS_LABEL);
}
else
{
noway_assert(insertAfterBlk == bPrev);
noway_assert(insertAfterBlk->bbNext == block);
/* Set the new jump dest for bPrev to the rarely run or uncommon block(s) */
bPrev->bbJumpDest = block;
block->bbFlags |= (BBF_JMP_TARGET | BBF_HAS_LABEL);
}
}
// If we are moving blocks that are at the end of a try or handler
// we will need to shorten ebdTryLast or ebdHndLast
//
ehUpdateLastBlocks(bEnd, bStartPrev);
// If we are moving blocks into the end of a try region or handler region
// we will need to extend ebdTryLast or ebdHndLast so the blocks that we
// are moving are part of this try or handler region.
//
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
// Are we moving blocks to the end of a try region?
if (HBtab->ebdTryLast == insertAfterBlk)
{
if (fStartIsInTry[XTnum])
{
// bStart..bEnd is in the try, so extend the try region
fgSetTryEnd(HBtab, bEnd);
}
}
// Are we moving blocks to the end of a handler region?
if (HBtab->ebdHndLast == insertAfterBlk)
{
if (fStartIsInHnd[XTnum])
{
// bStart..bEnd is in the handler, so extend the handler region
fgSetHndEnd(HBtab, bEnd);
}
}
}
/* We have decided to insert the block(s) after 'insertAfterBlk' */
fgMoveBlocksAfter(bStart, bEnd, insertAfterBlk);
if (bDest)
{
/* We may need to insert an unconditional branch after bPrev to bDest */
fgConnectFallThrough(bPrev, bDest);
}
else
{
/* If bPrev falls through, we must insert a jump to block */
fgConnectFallThrough(bPrev, block);
}
BasicBlock* bSkip = bEnd->bbNext;
/* If bEnd falls through, we must insert a jump to bNext */
fgConnectFallThrough(bEnd, bNext);
if (bStart2 == NULL)
{
/* If insertAfterBlk falls through, we are forced to */
/* add a jump around the block(s) we just inserted */
fgConnectFallThrough(insertAfterBlk, bSkip);
}
else
{
/* We may need to insert an unconditional branch after bPrev2 to bStart */
fgConnectFallThrough(bPrev2, bStart);
}
#if DEBUG
if (verbose)
{
printf("\nAfter this change in fgReorderBlocks");
fgDispBasicBlocks(verboseTrees);
printf("\n");
}
fgVerifyHandlerTab();
// Make sure that the predecessor lists are accurate
if (expensiveDebugCheckLevel >= 2)
{
fgDebugCheckBBlist();
}
#endif // DEBUG
// Set our iteration point 'block' to be the new bPrev->bbNext
// It will be used as the next bPrev
block = bPrev->bbNext;
} // end of for loop(bPrev,block)
bool changed = movedBlocks || newRarelyRun || optimizedSwitches;
if (changed)
{
fgNeedsUpdateFlowGraph = true;
#if DEBUG
// Make sure that the predecessor lists are accurate
if (expensiveDebugCheckLevel >= 2)
{
fgDebugCheckBBlist();
}
#endif // DEBUG
}
}
#ifdef _PREFAST_
#pragma warning(pop)
#endif
/*-------------------------------------------------------------------------
*
* Walk the basic blocks list to determine the first block to place in the
* cold section. This would be the first of a series of rarely executed blocks
* such that no succeeding blocks are in a try region or an exception handler
* or are rarely executed.
*/
void Compiler::fgDetermineFirstColdBlock()
{
#ifdef DEBUG
if (verbose)
printf("\n*************** In fgDetermineFirstColdBlock()\n");
#endif // DEBUG
// Since we may need to create a new transistion block
// we assert that it is OK to create new blocks.
//
assert(fgSafeBasicBlockCreation);
fgFirstColdBlock = NULL;
#if FEATURE_STACK_FP_X87
if (compMayHaveTransitionBlocks)
{
opts.compProcedureSplitting = false;
// See comment above declaration of compMayHaveTransitionBlocks for comments on this
JITDUMP("Turning off procedure splitting for this method, as it may end up having FP transition blocks\n");
}
#endif // FEATURE_STACK_FP_X87
if (!opts.compProcedureSplitting)
{
JITDUMP("No procedure splitting will be done for this method\n");
return;
}
#ifdef DEBUG
if ((compHndBBtabCount > 0) && !opts.compProcedureSplittingEH)
{
JITDUMP("No procedure splitting will be done for this method with EH (by request)\n");
return;
}
#endif // DEBUG
#if FEATURE_EH_FUNCLETS
// TODO-CQ: handle hot/cold splitting in functions with EH (including synchronized methods
// that create EH in methods without explicit EH clauses).
if (compHndBBtabCount > 0)
{
JITDUMP("No procedure splitting will be done for this method with EH (implementation limitation)\n");
return;
}
#endif // FEATURE_EH_FUNCLETS
BasicBlock* firstColdBlock = NULL;
BasicBlock* prevToFirstColdBlock = NULL;
BasicBlock* block;
BasicBlock* lblk;
for (lblk = NULL, block = fgFirstBB;
block != NULL;
lblk = block, block = block->bbNext)
{
bool blockMustBeInHotSection = false;
#if HANDLER_ENTRY_MUST_BE_IN_HOT_SECTION
if (bbIsHandlerBeg(block))
{
blockMustBeInHotSection = true;
}
#endif // HANDLER_ENTRY_MUST_BE_IN_HOT_SECTION
// Do we have a candidate for the first cold block?
if (firstColdBlock != NULL)
{
// We have a candidate for first cold block
// Is this a hot block?
if (blockMustBeInHotSection || (block->isRunRarely() == false))
{
// We have to restart the search for the first cold block
firstColdBlock = NULL;
prevToFirstColdBlock = NULL;
}
}
else // (firstColdBlock == NULL)
{
// We don't have a candidate for first cold block
// Is this a cold block?
if (!blockMustBeInHotSection && (block->isRunRarely() == true))
{
//
// If the last block that was hot was a BBJ_COND
// then we will have to add an unconditional jump
// so the code size for block needs be large
// enough to make it worth our while
//
if ((lblk == NULL) ||
(lblk->bbJumpKind != BBJ_COND) ||
(fgGetCodeEstimate(block) >= 8) )
{
// This block is now a candidate for first cold block
// Also remember the predecessor to this block
firstColdBlock = block;
prevToFirstColdBlock = lblk;
}
}
}
}
if (firstColdBlock == fgFirstBB)
{
// If the first block is Cold then we can't move any blocks
// into the cold section
firstColdBlock = NULL;
}
if (firstColdBlock != NULL)
{
noway_assert(prevToFirstColdBlock != NULL);
if (prevToFirstColdBlock == NULL)
return; // To keep Prefast happy
// If we only have one cold block
// then it may not be worth it to move it
// into the Cold section as a jump to the
// Cold section is 5 bytes in size.
//
if (firstColdBlock->bbNext == NULL)
{
// If the size of the cold block is 7 or less
// then we will keep it in the Hot section.
//
if (fgGetCodeEstimate(firstColdBlock) < 8)
{
firstColdBlock = NULL;
goto EXIT;
}
}
// When the last Hot block fall through into the Cold section
// we may need to add a jump
//
if (prevToFirstColdBlock->bbFallsThrough())
{
switch (prevToFirstColdBlock->bbJumpKind)
{
default:
noway_assert(!"Unhandled jumpkind in fgDetermineFirstColdBlock()");
case BBJ_CALLFINALLY:
// A BBJ_CALLFINALLY that falls through is always followed
// by an empty BBJ_ALWAYS.
//
assert(prevToFirstColdBlock->isBBCallAlwaysPair());
firstColdBlock = firstColdBlock->bbNext; // Note that this assignment could make firstColdBlock == nullptr
break;
case BBJ_COND:
//
// This is a slightly more complicated case, because we will
// probably need to insert a block to jump to the cold section.
//
if (firstColdBlock->isEmpty() &&
(firstColdBlock->bbJumpKind == BBJ_ALWAYS))
{
// We can just use this block as the transitionBlock
firstColdBlock = firstColdBlock->bbNext;
// Note that this assignment could make firstColdBlock == NULL
}
else
{
BasicBlock* transitionBlock = fgNewBBafter(BBJ_ALWAYS, prevToFirstColdBlock, true);
transitionBlock->bbJumpDest = firstColdBlock;
transitionBlock->inheritWeight(firstColdBlock);
noway_assert(fgComputePredsDone);
// Update the predecessor list for firstColdBlock
fgReplacePred(firstColdBlock, prevToFirstColdBlock, transitionBlock);
// Add prevToFirstColdBlock as a predecessor for transitionBlock
fgAddRefPred(transitionBlock, prevToFirstColdBlock);
}
break;
case BBJ_NONE:
// If the block preceding the first cold block is BBJ_NONE,
// convert it to BBJ_ALWAYS to force an explicit jump.
prevToFirstColdBlock->bbJumpDest = firstColdBlock;
prevToFirstColdBlock->bbJumpKind = BBJ_ALWAYS;
break;
}
}
}
if (firstColdBlock != NULL)
{
firstColdBlock->bbFlags |= BBF_JMP_TARGET;
for (block = firstColdBlock; block; block = block->bbNext)
{
block->bbFlags |= BBF_COLD;
}
}
EXIT:;
#ifdef DEBUG
if (verbose)
{
if (firstColdBlock)
{
printf("fgFirstColdBlock is BB%02u.\n", firstColdBlock->bbNum);
}
else
{
printf("fgFirstColdBlock is NULL.\n");
}
fgDispBasicBlocks();
}
fgVerifyHandlerTab();
#endif // DEBUG
fgFirstColdBlock = firstColdBlock;
}
#ifdef _PREFAST_
#pragma warning(push)
#pragma warning(disable:21000) // Suppress PREFast warning about overly large function
#endif
/*****************************************************************************
*
* Function called to "comb" the basic block list.
* Removes any empty blocks, unreachable blocks and redundant jumps.
* Most of those appear after dead store removal and folding of conditionals.
*
* Returns: true if the flowgraph has been modified
*
* It also compacts basic blocks
* (consecutive basic blocks that should in fact be one).
*
* NOTE:
* Debuggable code and Min Optimization JIT also introduces basic blocks
* but we do not optimize those!
*/
bool Compiler::fgUpdateFlowGraph(bool doTailDuplication)
{
#ifdef DEBUG
if (verbose)
printf("\n*************** In fgUpdateFlowGraph()");
#endif // DEBUG
/* This should never be called for debuggable code */
noway_assert(!opts.MinOpts() && !opts.compDbgCode);
#ifdef DEBUG
if (verbose)
{
printf("\nBefore updating the flow graph:\n");
fgDispBasicBlocks(verboseTrees);
printf("\n");
}
#endif // DEBUG
/* Walk all the basic blocks - look for unconditional jumps, empty blocks, blocks to compact, etc...
*
* OBSERVATION:
* Once a block is removed the predecessors are not accurate (assuming they were at the beginning)
* For now we will only use the information in bbRefs because it is easier to be updated
*/
bool modified = false;
bool change;
do
{
change = false;
BasicBlock* block; // the current block
BasicBlock* bPrev = NULL; // the previous non-worthless block
BasicBlock* bNext; // the successor of the current block
BasicBlock* bDest; // the jump target of the current block
for (block = fgFirstBB;
block != NULL;
block = block->bbNext)
{
/* Some blocks may be already marked removed by other optimizations
* (e.g worthless loop removal), without being explicitly removed
* from the list.
*/
if (block->bbFlags & BBF_REMOVED)
{
if (bPrev)
{
bPrev->setNext(block->bbNext);
}
else
{
/* WEIRD first basic block is removed - should have an assert here */
noway_assert(!"First basic block marked as BBF_REMOVED???");
fgFirstBB = block->bbNext;
}
continue;
}
/* We jump to the REPEAT label if we performed a change involving the current block
* This is in case there are other optimizations that can show up
* (e.g. - compact 3 blocks in a row)
* If nothing happens, we then finish the iteration and move to the next block
*/
REPEAT:;
bNext = block->bbNext;
bDest = NULL;
if (block->bbJumpKind == BBJ_ALWAYS)
{
bDest = block->bbJumpDest;
if (doTailDuplication && fgOptimizeUncondBranchToSimpleCond(block, bDest))
{
change = true;
modified = true;
bDest = block->bbJumpDest;
bNext = block->bbNext;
}
}
// Remove JUMPS to the following block
// and optimize any JUMPS to JUMPS
if (block->bbJumpKind == BBJ_COND ||
block->bbJumpKind == BBJ_ALWAYS )
{
bDest = block->bbJumpDest;
if (bDest == bNext)
{
if (fgOptimizeBranchToNext(block, bNext, bPrev))
{
change = true;
modified = true;
bDest = NULL;
}
}
}
if (bDest != NULL)
{
// Do we have a JUMP to an empty unconditional JUMP block?
if (bDest->isEmpty() &&
(bDest->bbJumpKind == BBJ_ALWAYS) &&
(bDest != bDest->bbJumpDest)) // special case for self jumps
{
if (fgOptimizeBranchToEmptyUnconditional(block, bDest))
{
change = true;
modified = true;
goto REPEAT;
}
}
// Check for a conditional branch that just skips over an empty BBJ_ALWAYS block
if ((block->bbJumpKind == BBJ_COND) && // block is a BBJ_COND block
(bNext != NULL) && // block is not the last block
(bNext->bbRefs == 1) && // No other block jumps to bNext
(bNext->bbNext == bDest) && // The block after bNext is the BBJ_COND jump dest
(bNext->bbJumpKind == BBJ_ALWAYS) && // The next block is a BBJ_ALWAYS block
bNext->isEmpty() && // and it is an an empty block
(bNext != bNext->bbJumpDest) && // special case for self jumps
(bDest != fgFirstColdBlock))
{
bool optimizeJump = true;
// We do not optimize jumps between two different try regions.
// However jumping to a block that is not in any try region is OK
//
if (bDest->hasTryIndex() && !BasicBlock::sameTryRegion(block, bDest))
{
optimizeJump = false;
}
// Also consider bNext's try region
//
if (bNext->hasTryIndex() && !BasicBlock::sameTryRegion(block, bNext))
{
optimizeJump = false;
}
// If we are optimizing using real profile weights
// then don't optimize a conditional jump to an unconditional jump
// until after we have computed the edge weights
//
if (fgIsUsingProfileWeights())
{
// if block and bdest are in different hot/cold regions we can't do this this optimization
// because we can't allow fall-through into the cold region.
if (!fgEdgeWeightsComputed || fgInDifferentRegions(block, bDest))
{
fgNeedsUpdateFlowGraph = true;
optimizeJump = false;
}
}
if (optimizeJump)
{
#ifdef DEBUG
if (verbose)
{
printf("\nReversing a conditional jump around an unconditional jump (BB%02u -> BB%02u -> BB%02u)\n",
block->bbNum, bDest->bbNum, bNext->bbJumpDest->bbNum);
}
#endif // DEBUG
/* Reverse the jump condition */
GenTreePtr test = block->lastTopLevelStmt();
test = test->gtStmt.gtStmtExpr;
noway_assert(test->gtOper == GT_JTRUE);
test->gtOp.gtOp1 = gtReverseCond(test->gtOp.gtOp1);
// Optimize the Conditional JUMP to go to the new target
block->bbJumpDest = bNext->bbJumpDest;
fgAddRefPred(bNext->bbJumpDest, block, fgRemoveRefPred(bNext->bbJumpDest, bNext));
/*
Unlink bNext from the BasicBlock list; note that we can
do this even though other blocks could jump to it - the
reason is that elsewhere in this function we always
redirect jumps to jumps to jump to the final label,
so even if another block jumps to bNext it won't matter
once we're done since any such jump will be redirected
to the final target by the time we're done here.
*/
fgRemoveRefPred(bNext, block);
fgUnlinkBlock(bNext);
/* Mark the block as removed */
bNext->bbFlags |= BBF_REMOVED;
// If this is the first Cold basic block update fgFirstColdBlock
if (bNext == fgFirstColdBlock)
{
fgFirstColdBlock = bNext->bbNext;
}
//
// If we removed the end of a try region or handler region
// we will need to update ebdTryLast or ebdHndLast.
//
EHblkDsc* HBtab;
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
if ((HBtab->ebdTryLast == bNext) ||
(HBtab->ebdHndLast == bNext))
{
fgSkipRmvdBlocks(HBtab);
}
}
// we optimized this JUMP - goto REPEAT to catch similar cases
change = true;
modified = true;
#ifdef DEBUG
if (verbose)
{
printf("\nAfter reversing the jump:\n");
fgDispBasicBlocks(verboseTrees);
}
#endif // DEBUG
/*
For a rare special case we cannot jump to REPEAT
as jumping to REPEAT will cause us to delete 'block'
because it currently appears to be unreachable. As
it is a self loop that only has a single bbRef (itself)
However since the unlinked bNext has additional bbRefs
(that we will later connect to 'block'), it is not really
unreachable.
*/
if ((bNext->bbRefs > 0) && (bNext->bbJumpDest == block) && (block->bbRefs == 1))
continue;
goto REPEAT;
}
}
}
//
// Update the switch jump table such that it follows jumps to jumps:
//
if (block->bbJumpKind == BBJ_SWITCH)
{
if (fgOptimizeSwitchBranches(block))
{
change = true;
modified = true;
goto REPEAT;
}
}
noway_assert(!(block->bbFlags & BBF_REMOVED));
/* COMPACT blocks if possible */
if (fgCanCompactBlocks(block, bNext))
{
fgCompactBlocks(block, bNext);
/* we compacted two blocks - goto REPEAT to catch similar cases */
change = true;
modified = true;
goto REPEAT;
}
/* Remove unreachable or empty blocks - do not consider blocks marked BBF_DONT_REMOVE or genReturnBB block
* These include first and last block of a TRY, exception handlers and RANGE_CHECK_FAIL THROW blocks */
if ((block->bbFlags & BBF_DONT_REMOVE) == BBF_DONT_REMOVE ||
block == genReturnBB
)
{
bPrev = block;
continue;
}
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// Don't remove the BBJ_ALWAYS block of a BBJ_CALLFINALLY/BBJ_ALWAYS pair.
if (block->countOfInEdges() == 0 && bPrev->bbJumpKind == BBJ_CALLFINALLY)
{
assert(bPrev->isBBCallAlwaysPair());
noway_assert(!(bPrev->bbFlags & BBF_RETLESS_CALL));
noway_assert(block->bbJumpKind == BBJ_ALWAYS);
bPrev = block;
continue;
}
#endif // FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
noway_assert(!block->bbCatchTyp);
noway_assert(!(block->bbFlags & BBF_TRY_BEG));
/* Remove unreachable blocks
*
* We'll look for blocks that have countOfInEdges() = 0 (blocks may become
* unreachable due to a BBJ_ALWAYS introduced by conditional folding for example)
*/
if (block->countOfInEdges() == 0)
{
/* no references -> unreachable - remove it */
/* For now do not update the bbNum, do it at the end */
fgRemoveBlock(block, true);
change = true;
modified = true;
/* we removed the current block - the rest of the optimizations won't have a target
* continue with the next one */
continue;
}
else if (block->countOfInEdges() == 1)
{
switch (block->bbJumpKind)
{
case BBJ_COND:
case BBJ_ALWAYS:
if (block->bbJumpDest == block)
{
fgRemoveBlock(block, true);
change = true;
modified = true;
/* we removed the current block - the rest of the optimizations
* won't have a target so continue with the next block */
continue;
}
break;
default:
break;
}
}
noway_assert(!(block->bbFlags & BBF_REMOVED));
/* Remove EMPTY blocks */
if (block->isEmpty())
{
assert(bPrev == block->bbPrev);
if (fgOptimizeEmptyBlock(block))
{
change = true;
modified = true;
}
/* Have we removed the block? */
if (block->bbFlags & BBF_REMOVED)
{
/* block was removed - no change to bPrev */
continue;
}
}
/* Set the predecessor of the last reachable block
* If we removed the current block, the predecessor remains unchanged
* otherwise, since the current block is ok, it becomes the predecessor */
noway_assert(!(block->bbFlags & BBF_REMOVED));
bPrev = block;
}
}
while (change);
fgNeedsUpdateFlowGraph = false;
#ifdef DEBUG
if (verbose && modified)
{
printf("\nAfter updating the flow graph:\n");
fgDispBasicBlocks(verboseTrees);
fgDispHandlerTab();
}
fgVerifyHandlerTab();
// Make sure that the predecessor lists are accurate
fgDebugCheckBBlist();
fgDebugCheckUpdate();
#endif // DEBUG
return modified;
}
#ifdef _PREFAST_
#pragma warning(pop)
#endif
/*****************************************************************************
* Check that the flow graph is really updated
*/
#ifdef DEBUG
void Compiler::fgDebugCheckUpdate()
{
if (!compStressCompile(STRESS_CHK_FLOW_UPDATE, 30))
return;
/* We check for these conditions:
* no unreachable blocks -> no blocks have countOfInEdges() = 0
* no empty blocks -> no blocks have bbTreeList = 0
* no un-imported blocks -> no blocks have BBF_IMPORTED not set (this is
* kind of redundand with the above, but to make sure)
* no un-compacted blocks -> BBJ_NONE followed by block with no jumps to it (countOfInEdges() = 1)
*/
BasicBlock* prev;
BasicBlock* block;
for (prev = NULL , block = fgFirstBB;
block != NULL;
prev = block, block = block->bbNext)
{
/* no unreachable blocks */
if ((block->countOfInEdges() == 0) &&
!(block->bbFlags & BBF_DONT_REMOVE)
#if FEATURE_EH_FUNCLETS && defined(_TARGET_ARM_)
// With funclets, we never get rid of the BBJ_ALWAYS part of a BBJ_CALLFINALLY/BBJ_ALWAYS pair,
// even if we can prove that the finally block never returns.
&& (prev == NULL || block->bbJumpKind != BBJ_ALWAYS || !prev->isBBCallAlwaysPair())
#endif // FEATURE_EH_FUNCLETS
)
{
noway_assert(!"Unreachable block not removed!");
}
/* no empty blocks */
if (block->isEmpty() &&
!(block->bbFlags & BBF_DONT_REMOVE))
{
switch (block->bbJumpKind)
{
case BBJ_CALLFINALLY:
case BBJ_EHFINALLYRET:
case BBJ_EHFILTERRET:
case BBJ_RETURN:
/* for BBJ_ALWAYS is probably just a GOTO, but will have to be treated */
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
/* These jump kinds are allowed to have empty tree lists */
break;
default:
/* it may be the case that the block had more than one reference to it
* so we couldn't remove it */
if (block->countOfInEdges() == 0)
noway_assert(!"Empty block not removed!");
break;
}
}
/* no un-imported blocks */
if (!(block->bbFlags & BBF_IMPORTED))
{
/* internal blocks do not count */
if (!(block->bbFlags & BBF_INTERNAL))
noway_assert(!"Non IMPORTED block not removed!");
}
bool prevIsCallAlwaysPair = ((prev != NULL) && prev->isBBCallAlwaysPair());
// Check for an unnecessary jumps to the next block
bool doAssertOnJumpToNextBlock = false; // unless we have a BBJ_COND or BBJ_ALWAYS we can not assert
if (block->bbJumpKind == BBJ_COND)
{
// A conditional branch should never jump to the next block
// as it can be folded into a BBJ_NONE;
doAssertOnJumpToNextBlock = true;
}
else if (block->bbJumpKind == BBJ_ALWAYS)
{
// Generally we will want to assert if a BBJ_ALWAYS branches to the next block
doAssertOnJumpToNextBlock = true;
// If the BBF_KEEP_BBJ_ALWAYS flag is set we allow it to jump to the next block
if (block->bbFlags & BBF_KEEP_BBJ_ALWAYS)
{
doAssertOnJumpToNextBlock = false;
}
// A call/always pair is also allowed to jump to the next block
if (prevIsCallAlwaysPair)
{
doAssertOnJumpToNextBlock = false;
}
// We are allowed to have a branch from a hot 'block' to a cold 'bbNext'
//
if ((block->bbNext != NULL) && fgInDifferentRegions(block, block->bbNext))
{
doAssertOnJumpToNextBlock = false;
}
}
if (doAssertOnJumpToNextBlock)
{
if (block->bbJumpDest == block->bbNext)
{
noway_assert(!"Unnecessary jump to the next block!");
}
}
/* Make sure BBF_KEEP_BBJ_ALWAYS is set correctly */
if ((block->bbJumpKind == BBJ_ALWAYS) && prevIsCallAlwaysPair)
{
noway_assert(block->bbFlags & BBF_KEEP_BBJ_ALWAYS);
}
/* For a BBJ_CALLFINALLY block we make sure that we are followed by */
/* an BBJ_ALWAYS block with BBF_INTERNAL set */
/* or that it's a BBF_RETLESS_CALL */
if (block->bbJumpKind == BBJ_CALLFINALLY)
{
assert((block->bbFlags & BBF_RETLESS_CALL) || block->isBBCallAlwaysPair());
}
/* no un-compacted blocks */
if (fgCanCompactBlocks(block, block->bbNext))
{
noway_assert(!"Found un-compacted blocks!");
}
}
}
#endif // DEBUG
/*****************************************************************************
* We've inserted a new block before 'block' that should be part of the same EH region as 'block'.
* Update the EH table to make this so. Also, set the new block to have the right EH region data
* (copy the bbTryIndex, bbHndIndex, and bbCatchTyp from 'block' to the new predecessor, and clear
* 'bbCatchTyp' from 'block').
*/
void Compiler::fgExtendEHRegionBefore(BasicBlock* block)
{
assert(block->bbPrev != nullptr);
BasicBlock* bPrev = block->bbPrev;
bPrev->copyEHRegion(block);
// The first block (and only the first block) of a handler has bbCatchTyp set
bPrev->bbCatchTyp = block->bbCatchTyp;
block->bbCatchTyp = BBCT_NONE;
EHblkDsc* HBtab;
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
/* Multiple pointers in EHblkDsc can point to same block. We can not early out after the first match. */
if (HBtab->ebdTryBeg == block)
{
#ifdef DEBUG
if (verbose)
{
printf("EH#%u: New first block of try: BB%02u\n", ehGetIndex(HBtab), bPrev->bbNum);
}
#endif // DEBUG
HBtab->ebdTryBeg = bPrev;
bPrev->bbFlags |= BBF_TRY_BEG | BBF_DONT_REMOVE | BBF_HAS_LABEL;
// clear the TryBeg flag unless it begins another try region
if (!bbIsTryBeg(block))
{
block->bbFlags &= ~BBF_TRY_BEG;
}
}
if (HBtab->ebdHndBeg == block)
{
#ifdef DEBUG
if (verbose)
{
printf("EH#%u: New first block of handler: BB%02u\n", ehGetIndex(HBtab), bPrev->bbNum);
}
#endif // DEBUG
// The first block of a handler has an artificial extra refcount. Transfer that to the new block.
assert(block->bbRefs > 0);
block->bbRefs--;
HBtab->ebdHndBeg = bPrev;
bPrev->bbFlags |= BBF_DONT_REMOVE | BBF_HAS_LABEL;
bPrev->bbRefs++;
// If this is a handler for a filter, the last block of the filter will end with
// a BBJ_EJFILTERRET block that has a bbJumpDest that jumps to the first block of
// it's handler. So we need to update it to keep things in sync.
//
if (HBtab->HasFilter())
{
BasicBlock* bFilterLast = HBtab->BBFilterLast();
assert(bFilterLast != nullptr);
assert(bFilterLast->bbJumpKind == BBJ_EHFILTERRET);
assert(bFilterLast->bbJumpDest == block);
#ifdef DEBUG
if (verbose)
{
printf("EH#%u: Updating bbJumpDest for filter ret block: BB%02u => BB%02u\n",
ehGetIndex(HBtab), bFilterLast->bbNum, bPrev->bbNum);
}
#endif // DEBUG
// Change the bbJumpDest for bFilterLast from the old first 'block' to the new first 'bPrev'
bFilterLast->bbJumpDest = bPrev;
}
}
if (HBtab->HasFilter() && (HBtab->ebdFilter == block))
{
#ifdef DEBUG
if (verbose)
{
printf("EH#%u: New first block of filter: BB%02u\n", ehGetIndex(HBtab), bPrev->bbNum);
}
#endif // DEBUG
// The first block of a filter has an artificial extra refcount. Transfer that to the new block.
assert(block->bbRefs > 0);
block->bbRefs--;
HBtab->ebdFilter = bPrev;
bPrev->bbFlags |= BBF_DONT_REMOVE | BBF_HAS_LABEL;
bPrev->bbRefs++;
}
}
}
/*****************************************************************************
* We've inserted a new block after 'block' that should be part of the same EH region as 'block'.
* Update the EH table to make this so. Also, set the new block to have the right EH region data.
*/
void Compiler::fgExtendEHRegionAfter(BasicBlock* block)
{
BasicBlock* newBlk = block->bbNext;
assert(newBlk != nullptr);
newBlk->copyEHRegion(block);
newBlk->bbCatchTyp = BBCT_NONE; // Only the first block of a catch has this set, and 'newBlk' can't be the first block of a catch.
// TODO-Throughput: if the block is not in an EH region, then we don't need to walk the EH table looking for 'last' block pointers to update.
ehUpdateLastBlocks(block, newBlk);
}
/*****************************************************************************
*
* Insert a BasicBlock before the given block.
*/
BasicBlock* Compiler::fgNewBBbefore(BBjumpKinds jumpKind,
BasicBlock* block,
bool extendRegion)
{
// Create a new BasicBlock and chain it in
BasicBlock* newBlk = bbNewBasicBlock(jumpKind);
newBlk->bbFlags |= BBF_INTERNAL;
fgInsertBBbefore(block, newBlk);
newBlk->bbRefs = 0;
if (newBlk->bbFallsThrough() && block->isRunRarely())
{
newBlk->bbSetRunRarely();
}
if (extendRegion)
{
fgExtendEHRegionBefore(block);
}
else
{
// When extendRegion is false the caller is responsible for setting these two values
newBlk->setTryIndex(MAX_XCPTN_INDEX); // Note: this is still a legal index, just unlikely
newBlk->setHndIndex(MAX_XCPTN_INDEX); // Note: this is still a legal index, just unlikely
}
// We assume that if the block we are inserting before is in the cold region, then this new
// block will also be in the cold region.
newBlk->bbFlags |= (block->bbFlags & BBF_COLD);
return newBlk;
}
/*****************************************************************************
*
* Insert a BasicBlock after the given block.
*/
BasicBlock* Compiler::fgNewBBafter(BBjumpKinds jumpKind,
BasicBlock* block,
bool extendRegion)
{
// Create a new BasicBlock and chain it in
BasicBlock* newBlk = bbNewBasicBlock(jumpKind);
newBlk->bbFlags |= BBF_INTERNAL;
fgInsertBBafter(block, newBlk);
newBlk->bbRefs = 0;
if (block->bbFallsThrough() && block->isRunRarely())
{
newBlk->bbSetRunRarely();
}
if (extendRegion)
{
fgExtendEHRegionAfter(block);
}
else
{
// When extendRegion is false the caller is responsible for setting these two values
newBlk->setTryIndex(MAX_XCPTN_INDEX); // Note: this is still a legal index, just unlikely
newBlk->setHndIndex(MAX_XCPTN_INDEX); // Note: this is still a legal index, just unlikely
}
// If the new block is in the cold region (because the block we are inserting after
// is in the cold region), mark it as such.
newBlk->bbFlags |= (block->bbFlags & BBF_COLD);
return newBlk;
}
/*****************************************************************************
* Inserts basic block before existing basic block.
*
* If insertBeforeBlk is in the funclet region, then newBlk will be in the funclet region.
* (If insertBeforeBlk is the first block of the funclet region, then 'newBlk' will be the
* new first block of the funclet region.)
*/
void Compiler::fgInsertBBbefore(BasicBlock* insertBeforeBlk,
BasicBlock* newBlk)
{
if (insertBeforeBlk->bbPrev)
{
fgInsertBBafter(insertBeforeBlk->bbPrev, newBlk);
}
else
{
newBlk->setNext(fgFirstBB);
fgFirstBB = newBlk;
newBlk->bbPrev = nullptr;
}
#if FEATURE_EH_FUNCLETS
/* Update fgFirstFuncletBB if insertBeforeBlk is the first block of the funclet region. */
if (fgFirstFuncletBB == insertBeforeBlk)
{
fgFirstFuncletBB = newBlk;
}
#endif // FEATURE_EH_FUNCLETS
}
/*****************************************************************************
* Inserts basic block after existing basic block.
*
* If insertBeforeBlk is in the funclet region, then newBlk will be in the funclet region.
* (It can't be used to insert a block as the first block of the funclet region).
*/
void Compiler::fgInsertBBafter(BasicBlock* insertAfterBlk,
BasicBlock* newBlk)
{
newBlk->bbNext = insertAfterBlk->bbNext;
if (insertAfterBlk->bbNext)
insertAfterBlk->bbNext->bbPrev = newBlk;
insertAfterBlk->bbNext = newBlk;
newBlk->bbPrev = insertAfterBlk;
if (fgLastBB == insertAfterBlk)
{
fgLastBB = newBlk;
assert(fgLastBB->bbNext == NULL);
}
}
// We have two edges (bAlt => bCur) and (bCur => bNext).
//
// Returns true if the weight of (bAlt => bCur)
// is greater than the weight of (bCur => bNext).
// We compare the edge weights if we have valid edge weights
// otherwise we compare blocks weights.
//
bool Compiler::fgIsBetterFallThrough(BasicBlock* bCur, BasicBlock* bAlt)
{
// bCur can't be NULL and must be a fall through bbJumpKind
noway_assert(bCur != NULL);
noway_assert(bCur->bbFallsThrough());
noway_assert(bAlt != NULL);
// We only handle the cases when bAlt is a BBJ_ALWAYS or a BBJ_COND
if ((bAlt->bbJumpKind != BBJ_ALWAYS) &&
(bAlt->bbJumpKind != BBJ_COND))
{
return false;
}
// if bAlt doesn't jump to bCur it can't be a better fall through than bCur
if (bAlt->bbJumpDest != bCur)
return false;
// Currently bNext is the fall through for bCur
BasicBlock* bNext = bCur->bbNext;
noway_assert(bNext != NULL);
// We will set result to true if bAlt is a better fall through than bCur
bool result;
if (fgHaveValidEdgeWeights)
{
// We will compare the edge weight for our two choices
flowList* edgeFromAlt = fgGetPredForBlock(bCur, bAlt);
flowList* edgeFromCur = fgGetPredForBlock(bNext, bCur);
noway_assert(edgeFromCur != NULL);
noway_assert(edgeFromAlt != NULL);
result = (edgeFromAlt->flEdgeWeightMin > edgeFromCur->flEdgeWeightMax);
}
else
{
if (bAlt->bbJumpKind == BBJ_ALWAYS)
{
// Our result is true if bAlt's weight is more than bCur's weight
result = (bAlt->bbWeight > bCur->bbWeight);
}
else
{
noway_assert(bAlt->bbJumpKind == BBJ_COND);
// Our result is true if bAlt's weight is more than twice bCur's weight
result = (bAlt->bbWeight > (2*bCur->bbWeight));
}
}
return result;
}
//------------------------------------------------------------------------
// fgCheckEHCanInsertAfterBlock: Determine if a block can be inserted after
// 'blk' and legally be put in the EH region specified by 'regionIndex'. This
// can be true if the most nested region the block is in is already 'regionIndex',
// as we'll just extend the most nested region (and any region ending at the same block).
// It can also be true if it is the end of (a set of) EH regions, such that
// inserting the block and properly extending some EH regions (if necessary)
// puts the block in the correct region. We only consider the case of extending
// an EH region after 'blk' (that is, to include 'blk' and the newly insert block);
// we don't consider inserting a block as the the first block of an EH region following 'blk'.
//
// Consider this example:
//
// try3 try2 try1
// |--- | | BB01
// | |--- | BB02
// | | |--- BB03
// | | | BB04
// | |--- |--- BB05
// | BB06
// |----------------- BB07
//
// Passing BB05 and try1/try2/try3 as the region to insert into (as well as putInTryRegion==true)
// will all return 'true'. Here are the cases:
// 1. Insert into try1: the most nested EH region BB05 is in is already try1, so we can insert after
// it and extend try1 (and try2).
// 2. Insert into try2: we can extend try2, but leave try1 alone.
// 3. Insert into try3: we can leave try1 and try2 alone, and put the new block just in try3. Note that
// in this case, after we "loop outwards" in the EH nesting, we get to a place where we're in the middle
// of the try3 region, not at the end of it.
// In all cases, it is possible to put a block after BB05 and put it in any of these three 'try' regions legally.
//
// Filters are ignored; if 'blk' is in a filter, the answer will be false.
//
// Arguments:
// blk - the BasicBlock we are checking to see if we can insert after.
// regionIndex - the EH region we want to insert a block into. regionIndex is
// in the range [0..compHndBBtabCount]; 0 means "main method".
// putInTryRegion - 'true' if the new block should be inserted in the 'try' region of 'regionIndex'.
// For regionIndex 0 (the "main method"), this should be 'true'.
//
// Return Value:
// 'true' if a block can be inserted after 'blk' and put in EH region 'regionIndex', else 'false'.
//
bool Compiler::fgCheckEHCanInsertAfterBlock(BasicBlock* blk, unsigned regionIndex, bool putInTryRegion)
{
assert(blk != nullptr);
assert(regionIndex <= compHndBBtabCount);
if (regionIndex == 0)
{
assert(putInTryRegion);
}
bool inTryRegion;
unsigned nestedRegionIndex = ehGetMostNestedRegionIndex(blk, &inTryRegion);
bool insertOK = true;
for (;;)
{
if (nestedRegionIndex == regionIndex)
{
// This block is in the region we want to be in. We can insert here if it's the right type of region.
// (If we want to be in the 'try' region, but the block is in the handler region, then inserting a
// new block after 'blk' can't put it in the 'try' region, and vice-versa, since we only consider
// extending regions after, not prepending to regions.)
// This check will be 'true' if we are trying to put something in the main function (as putInTryRegion
// must be 'true' if regionIndex is zero, and inTryRegion will also be 'true' if nestedRegionIndex is zero).
insertOK = (putInTryRegion == inTryRegion);
break;
}
else if (nestedRegionIndex == 0)
{
// The block is in the main function, but we want to put something in a nested region. We can't do that.
insertOK = false;
break;
}
assert(nestedRegionIndex > 0);
EHblkDsc* ehDsc = ehGetDsc(nestedRegionIndex - 1); // ehGetDsc uses [0..compHndBBtabCount) form.
if (inTryRegion)
{
if (blk != ehDsc->ebdTryLast)
{
// Not the last block? Then it must be somewhere else within the try region, so we can't insert here.
insertOK = false;
break; // exit the 'for' loop
}
}
else
{
// We ignore filters.
if (blk != ehDsc->ebdHndLast)
{
// Not the last block? Then it must be somewhere else within the handler region, so we can't insert here.
insertOK = false;
break; // exit the 'for' loop
}
}
// Things look good for this region; check the enclosing regions, if any.
nestedRegionIndex = ehGetEnclosingRegionIndex(nestedRegionIndex - 1, &inTryRegion); // ehGetEnclosingRegionIndex uses [0..compHndBBtabCount) form.
// Convert to [0..compHndBBtabCount] form.
nestedRegionIndex = (nestedRegionIndex == EHblkDsc::NO_ENCLOSING_INDEX) ? 0 : nestedRegionIndex + 1;
} // end of for(;;)
return insertOK;
}
//------------------------------------------------------------------------
// Finds the block closest to endBlk in the range [startBlk..endBlk) after which a block can be
// inserted easily. Note that endBlk cannot be returned; its predecessor is the last block that can
// be returned. The new block will be put in an EH region described by the arguments regionIndex,
// putInTryRegion, startBlk, and endBlk (explained below), so it must be legal to place to put the
// new block after the insertion location block, give it the specified EH region index, and not break
// EH nesting rules. This function is careful to choose a block in the correct EH region. However,
// it assumes that the new block can ALWAYS be placed at the end (just before endBlk). That means
// that the caller must ensure that is true.
//
// Below are the possible cases for the arguments to this method:
// 1. putInTryRegion == true and regionIndex > 0:
// Search in the try region indicated by regionIndex.
// 2. putInTryRegion == false and regionIndex > 0:
// a. If startBlk is the first block of a filter and endBlk is the block after the end of the
// filter (that is, the startBlk and endBlk match a filter bounds exactly), then choose a
// location within this filter region. (Note that, due to IL rules, filters do not have any
// EH nested within them.) Otherwise, filters are skipped.
// b. Else, search in the handler region indicated by regionIndex.
// 3. regionIndex = 0:
// Search in the entire main method, excluding all EH regions. In this case, putInTryRegion must be true.
//
// This method makes sure to find an insertion point which would not cause the inserted block to
// be put inside any inner try/filter/handler regions.
//
// The actual insertion occurs after the returned block. Note that the returned insertion point might
// be the last block of a more nested EH region, because the new block will be inserted after the insertion
// point, and will not extend the more nested EH region. For example:
//
// try3 try2 try1
// |--- | | BB01
// | |--- | BB02
// | | |--- BB03
// | | | BB04
// | |--- |--- BB05
// | BB06
// |----------------- BB07
//
// for regionIndex==try3, putInTryRegion==true, we might return BB05, even though BB05 will have a try index
// for try1 (the most nested 'try' region the block is in). That's because when we insert after BB05, the new
// block will be in the correct, desired EH region, since try1 and try2 regions will not be extended to include
// the inserted block. Furthermore, for regionIndex==try2, putInTryRegion==true, we can also return BB05. In this
// case, when the new block is inserted, the try1 region remains the same, but we need extend region 'try2' to
// include the inserted block. (We also need to check all parent regions as well, just in case any parent regions
// also end on the same block, in which case we would also need to extend the parent regions. This is standard
// procedure when inserting a block at the end of an EH region.)
//
// If nearBlk is non-nullptr then we return the closest block after nearBlk that will work best.
//
// We try to find a block in the appropriate region that is not a fallthrough block, so we can insert after it
// without the need to insert a jump around the inserted block.
//
// Note that regionIndex is numbered the same as BasicBlock::bbTryIndex and BasicBlock::bbHndIndex, that is, "0" is
// "main method" and otherwise is +1 from normal, so we can call, e.g., ehGetDsc(tryIndex - 1).
//
// Arguments:
// regionIndex - the region index where the new block will be inserted. Zero means entire method;
// non-zero means either a "try" or a "handler" region, depending on what putInTryRegion says.
// putInTryRegion - 'true' to put the block in the 'try' region corresponding to 'regionIndex', 'false'
// to put the block in the handler region. Should be 'true' if regionIndex==0.
// startBlk - start block of range to search.
// endBlk - end block of range to search (don't include this block in the range). Can be nullptr to indicate
// the end of the function.
// nearBlk - If non-nullptr, try to find an insertion location closely after this block. If nullptr, we insert
// at the best location found towards the end of the acceptable block range.
// jumpBlk - When nearBlk is set, this can be set to the block which jumps to bNext->bbNext (TODO: need to review this?)
// runRarely - true if the block being inserted is expected to be rarely run. This helps determine
// the best place to put the new block, by putting in a place that has the same 'rarely run' characteristic.
//
// Return Value:
// A block with the desired characteristics, so the new block will be inserted after this one.
// If there is no suitable location, return nullptr. This should basically never happen.
BasicBlock* Compiler::fgFindInsertPoint(unsigned regionIndex,
bool putInTryRegion,
BasicBlock* startBlk,
BasicBlock* endBlk,
BasicBlock* nearBlk,
BasicBlock* jumpBlk,
bool runRarely)
{
noway_assert(startBlk != nullptr);
noway_assert(startBlk != endBlk);
noway_assert((regionIndex == 0 && putInTryRegion) || // Search in the main method
(putInTryRegion && regionIndex > 0 && startBlk->bbTryIndex == regionIndex) || // Search in the specified try region
(!putInTryRegion && regionIndex > 0 && startBlk->bbHndIndex == regionIndex)); // Search in the specified handler region
#ifdef DEBUG
// Assert that startBlk precedes endBlk in the block list.
// We don't want to use bbNum to assert this condition, as we cannot depend on the block numbers being
// sequential at all times.
for (BasicBlock* b = startBlk; b != endBlk; b = b->bbNext)
{
assert(b != nullptr); // We reached the end of the block list, but never found endBlk.
}
#endif // DEBUG
JITDUMP("fgFindInsertPoint(regionIndex=%u, putInTryRegion=%s, startBlk=BB%02u, endBlk=BB%02u, nearBlk=BB%02u, jumpBlk=BB%02u, runRarely=%s)\n",
regionIndex,
dspBool(putInTryRegion),
startBlk->bbNum,
(endBlk == nullptr) ? 0 : endBlk->bbNum,
(nearBlk == nullptr) ? 0 : nearBlk->bbNum,
(jumpBlk == nullptr) ? 0 : jumpBlk->bbNum,
dspBool(runRarely));
bool reachedNear = false; // Have we reached 'nearBlk' in our search? If not, we'll keep searching.
bool inFilter = false; // Are we in a filter region that we need to skip?
BasicBlock* bestBlk = nullptr; // Set to the best insertion point we've found so far that meets all the EH requirements.
BasicBlock* goodBlk = nullptr; // Set to an acceptable insertion point that we'll use if we don't find a 'best' option.
BasicBlock* blk;
if (nearBlk != nullptr)
{
// Does the nearBlk precede the startBlk?
for (blk = nearBlk; blk != nullptr; blk = blk->bbNext)
{
if (blk == startBlk)
{
reachedNear = true;
break;
}
else if (blk == endBlk)
{
break;
}
}
}
for (blk = startBlk; blk != endBlk; blk = blk->bbNext)
{
// The only way (blk == nullptr) could be true is if the caller passed an endBlk that preceded startBlk in the
// block list, or if endBlk isn't in the block list at all. In DEBUG, we'll instead hit the similar well-formedness
// assert earlier in this function.
noway_assert(blk != nullptr);
if (blk == nearBlk)
{
reachedNear = true;
}
if (blk->bbCatchTyp == BBCT_FILTER)
{
// Record the fact that we entered a filter region, so we don't insert into filters...
// Unless the caller actually wanted the block inserted in this exact filter region.
// Detect this by the fact that startBlk and endBlk point to the filter begin and end.
if (putInTryRegion ||
(blk != startBlk) ||
(startBlk != ehGetDsc(regionIndex - 1)->ebdFilter) ||
(endBlk != ehGetDsc(regionIndex - 1)->ebdHndBeg))
{
inFilter = true;
}
}
else if (blk->bbCatchTyp == BBCT_FILTER_HANDLER)
{
// Record the fact that we exited a filter region.
inFilter = false;
}
// Don't insert a block inside this filter region.
if (inFilter)
continue;
// Note that the new block will be inserted AFTER "blk". We check to make sure that doing so
// would put the block in the correct EH region. We make an assumption here that you can
// ALWAYS insert the new block before "endBlk" (that is, at the end of the search range)
// and be in the correct EH region. This is must be guaranteed by the caller (as it is by
// fgNewBBinRegion(), which passes the search range as an exact EH region block range).
// Because of this assumption, we only check the EH information for blocks before the last block.
if (blk->bbNext != endBlk)
{
// We are in the middle of the search range. We can't insert the new block in
// an inner try or handler region. We can, however, set the insertion
// point to the last block of an EH try/handler region, if the enclosing
// region is the region we wish to insert in. (Since multiple regions can
// end at the same block, we need to search outwards, checking that the
// block is the last block of every EH region out to the region we want
// to insert in.) This is especially useful for putting a call-to-finally
// block on AMD64 immediately after its corresponding 'try' block, so in the
// common case, we'll just fall through to it. For example:
//
// BB01
// BB02 -- first block of try
// BB03
// BB04 -- last block of try
// BB05 -- first block of finally
// BB06
// BB07 -- last block of handler
// BB08
//
// Assume there is only one try/finally, so BB01 and BB08 are in the "main function".
// For AMD64 call-to-finally, we'll want to insert the BBJ_CALLFINALLY in
// the main function, immediately after BB04. This allows us to do that.
if (!fgCheckEHCanInsertAfterBlock(blk, regionIndex, putInTryRegion))
{
// Can't insert here.
continue;
}
}
// Look for an insert location:
// 1. We want blocks that don't end with a fall through,
// 2. Also, when blk equals nearBlk we may want to insert here.
if (!blk->bbFallsThrough() || (blk == nearBlk))
{
bool updateBestBlk = true; // We will probably update the bestBlk
// If blk falls through then we must decide whether to use the nearBlk
// hint
if (blk->bbFallsThrough())
{
noway_assert(blk == nearBlk);
if (jumpBlk != nullptr)
{
updateBestBlk = fgIsBetterFallThrough(blk, jumpBlk);
}
else
{
updateBestBlk = false;
}
}
// If we already have a best block, see if the 'runRarely' flags influences
// our choice. If we want a runRarely insertion point, and the existing best
// block is run rarely but the current block isn't run rarely, then don't
// update the best block.
// TODO-CQ: We should also handle the reverse case, where runRarely is false (we
// want a non-rarely-run block), but bestBlock->isRunRarely() is true. In that
// case, we should update the block, also. Probably what we want is:
// (bestBlk->isRunRarely() != runRarely) && (blk->isRunRarely() == runRarely)
if (updateBestBlk &&
(bestBlk != nullptr) &&
runRarely &&
bestBlk->isRunRarely() &&
!blk->isRunRarely())
{
updateBestBlk = false;
}
if (updateBestBlk)
{
// We found a 'best' insertion location, so save it away.
bestBlk = blk;
// If we've reached nearBlk, we've satisfied all the criteria,
// so we're done.
if (reachedNear)
goto DONE;
// If we haven't reached nearBlk, keep looking for a 'best' location, just
// in case we'll find one at or after nearBlk. If no nearBlk was specified,
// we prefer inserting towards the end of the given range, so keep looking
// for more acceptable insertion locations.
}
}
// No need to update goodBlk after we have set bestBlk, but we could still find a better
// bestBlk, so keep looking.
if (bestBlk != nullptr)
continue;
// Set the current block as a "good enough" insertion point, if it meets certain criteria.
// We'll return this block if we don't find a "best" block in the search range. The block
// can't be a BBJ_CALLFINALLY of a BBJ_CALLFINALLY/BBJ_ALWAYS pair (since we don't want
// to insert anything between these two blocks). Otherwise, we can use it. However,
// if we'd previously chosen a BBJ_COND block, then we'd prefer the "good" block to be
// something else. We keep updating it until we've reached the 'nearBlk', to push it as
// close to endBlk as possible.
if (!blk->isBBCallAlwaysPair())
{
if (goodBlk == nullptr)
{
goodBlk = blk;
}
else if ((goodBlk->bbJumpKind == BBJ_COND) ||
(blk->bbJumpKind != BBJ_COND))
{
if ((blk == nearBlk) || !reachedNear)
{
goodBlk = blk;
}
}
}
}
// If we didn't find a non-fall_through block, then insert at the last good block.
if (bestBlk == nullptr)
{
bestBlk = goodBlk;
}
DONE:;
return bestBlk;
}
//------------------------------------------------------------------------
// Creates a new BasicBlock and inserts it in a specific EH region, given by 'tryIndex', 'hndIndex', and 'putInFilter'.
//
// If 'putInFilter' it true, then the block is inserted in the filter region given by 'hndIndex'. In this case, tryIndex
// must be a less nested EH region (that is, tryIndex > hndIndex).
//
// Otherwise, the block is inserted in either the try region or the handler region, depending on which one is the inner region.
// In other words, if the try region indicated by tryIndex is nested in the handler region indicated by hndIndex,
// then the new BB will be created in the try region. Vice versa.
//
// Note that tryIndex and hndIndex are numbered the same as BasicBlock::bbTryIndex and BasicBlock::bbHndIndex, that is, "0" is
// "main method" and otherwise is +1 from normal, so we can call, e.g., ehGetDsc(tryIndex - 1).
//
// To be more specific, this function will create a new BB in one of the following 5 regions (if putInFilter is false):
// 1. When tryIndex = 0 and hndIndex = 0:
// The new BB will be created in the method region.
// 2. When tryIndex != 0 and hndIndex = 0:
// The new BB will be created in the try region indicated by tryIndex.
// 3. When tryIndex == 0 and hndIndex != 0:
// The new BB will be created in the handler region indicated by hndIndex.
// 4. When tryIndex != 0 and hndIndex != 0 and tryIndex < hndIndex:
// In this case, the try region is nested inside the handler region. Therefore, the new BB will be created
// in the try region indicated by tryIndex.
// 5. When tryIndex != 0 and hndIndex != 0 and tryIndex > hndIndex:
// In this case, the handler region is nested inside the try region. Therefore, the new BB will be created
// in the handler region indicated by hndIndex.
//
// Note that if tryIndex != 0 and hndIndex != 0 then tryIndex must not be equal to hndIndex (this makes sense because
// if they are equal, you are asking to put the new block in both the try and handler, which is impossible).
//
// The BasicBlock will not be inserted inside an EH region that is more nested than the requested tryIndex/hndIndex
// region (so the function is careful to skip more nested EH regions when searching for a place to put the new block).
//
// This function cannot be used to insert a block as the first block of any region. It always inserts a block after
// an existing block in the given region.
//
// If nearBlk is nullptr, or the block is run rarely, then the new block is assumed to be run rarely.
//
// Arguments:
// jumpKind - the jump kind of the new block to create.
// tryIndex - the try region to insert the new block in, described above. This must be a number in the range [0..compHndBBtabCount].
// hndIndex - the handler region to insert the new block in, described above. This must be a number in the range [0..compHndBBtabCount].
// nearBlk - insert the new block closely after this block, if possible. If nullptr, put the new block anywhere in the requested region.
// putInFilter - put the new block in the filter region given by hndIndex, as described above.
// runRarely - 'true' if the new block is run rarely.
// insertAtEnd - 'true' if the block should be inserted at the end of the region. Note: this is currently only implemented when
// inserting into the main function (not into any EH region).
//
// Return Value:
// The new block.
BasicBlock* Compiler::fgNewBBinRegion(BBjumpKinds jumpKind,
unsigned tryIndex,
unsigned hndIndex,
BasicBlock* nearBlk,
bool putInFilter /* = false */,
bool runRarely /* = false */,
bool insertAtEnd /* = false */)
{
assert(tryIndex <= compHndBBtabCount);
assert(hndIndex <= compHndBBtabCount);
/* afterBlk is the block which will precede the newBB */
BasicBlock* afterBlk;
// start and end limit for inserting the block
BasicBlock* startBlk = nullptr;
BasicBlock* endBlk = nullptr;
bool putInTryRegion = true;
unsigned regionIndex = 0;
// First, figure out which region (the "try" region or the "handler" region) to put the newBB in.
if ((tryIndex == 0) && (hndIndex == 0))
{
assert(!putInFilter);
endBlk = fgEndBBAfterMainFunction(); // don't put new BB in funclet region
if (insertAtEnd || (nearBlk == nullptr))
{
/* We'll just insert the block at the end of the method, before the funclets */
afterBlk = fgLastBBInMainFunction();
goto _FoundAfterBlk;
}
else
{
// We'll search through the entire method
startBlk = fgFirstBB;
}
noway_assert(regionIndex == 0);
}
else
{
noway_assert(tryIndex > 0 || hndIndex > 0);
PREFIX_ASSUME(tryIndex <= compHndBBtabCount);
PREFIX_ASSUME(hndIndex <= compHndBBtabCount);
// Decide which region to put in, the "try" region or the "handler" region.
if (tryIndex == 0)
{
noway_assert(hndIndex > 0);
putInTryRegion = false;
}
else if (hndIndex == 0)
{
noway_assert(tryIndex > 0);
noway_assert(putInTryRegion);
assert(!putInFilter);
}
else
{
noway_assert(tryIndex > 0 && hndIndex > 0 && tryIndex != hndIndex);
putInTryRegion = (tryIndex < hndIndex);
}
if (putInTryRegion)
{
// Try region is the inner region.
// In other words, try region must be nested inside the handler region.
noway_assert(hndIndex == 0 || bbInHandlerRegions(hndIndex - 1, ehGetDsc(tryIndex - 1)->ebdTryBeg));
assert(!putInFilter);
}
else
{
// Handler region is the inner region.
// In other words, handler region must be nested inside the try region.
noway_assert(tryIndex == 0 || bbInTryRegions(tryIndex - 1, ehGetDsc(hndIndex - 1)->ebdHndBeg));
}
// Figure out the start and end block range to search for an insertion location. Pick the beginning and
// ending blocks of the target EH region (the 'endBlk' is one past the last block of the EH region, to make
// loop iteration easier). Note that, after funclets have been created (for FEATURE_EH_FUNCLETS),
// this linear block range will not include blocks of handlers for try/handler clauses nested within
// this EH region, as those blocks have been extracted as funclets. That is ok, though, because we don't
// want to insert a block in any nested EH region.
if (putInTryRegion)
{
// We will put the newBB in the try region.
EHblkDsc* ehDsc = ehGetDsc(tryIndex - 1);
startBlk = ehDsc->ebdTryBeg;
endBlk = ehDsc->ebdTryLast->bbNext;
regionIndex = tryIndex;
}
else if (putInFilter)
{
// We will put the newBB in the filter region.
EHblkDsc* ehDsc = ehGetDsc(hndIndex - 1);
startBlk = ehDsc->ebdFilter;
endBlk = ehDsc->ebdHndBeg;
regionIndex = hndIndex;
}
else
{
// We will put the newBB in the handler region.
EHblkDsc* ehDsc = ehGetDsc(hndIndex - 1);
startBlk = ehDsc->ebdHndBeg;
endBlk = ehDsc->ebdHndLast->bbNext;
regionIndex = hndIndex;
}
noway_assert(regionIndex > 0);
}
// Now find the insertion point.
afterBlk = fgFindInsertPoint(regionIndex,
putInTryRegion,
startBlk, endBlk,
nearBlk, nullptr,
runRarely);
_FoundAfterBlk:;
/* We have decided to insert the block after 'afterBlk'. */
noway_assert(afterBlk != nullptr);
JITDUMP("fgNewBBinRegion(jumpKind=%u, tryIndex=%u, hndIndex=%u, putInFilter=%s, runRarely=%s, insertAtEnd=%s): inserting after BB%02u\n",
jumpKind,
tryIndex,
hndIndex,
dspBool(putInFilter),
dspBool(runRarely),
dspBool(insertAtEnd),
afterBlk->bbNum);
return fgNewBBinRegionWorker(jumpKind, afterBlk, regionIndex, putInTryRegion);
}
//------------------------------------------------------------------------
// Creates a new BasicBlock and inserts it in the same EH region as 'srcBlk'.
//
// See the implementation of fgNewBBinRegion() used by this one for more notes.
//
// Arguments:
// jumpKind - the jump kind of the new block to create.
// srcBlk - insert the new block in the same EH region as this block, and closely after it if possible.
//
// Return Value:
// The new block.
BasicBlock* Compiler::fgNewBBinRegion(BBjumpKinds jumpKind,
BasicBlock* srcBlk,
bool runRarely /* = false */,
bool insertAtEnd /* = false */)
{
assert(srcBlk != nullptr);
const unsigned tryIndex = srcBlk->bbTryIndex;
const unsigned hndIndex = srcBlk->bbHndIndex;
bool putInFilter = false;
// Check to see if we need to put the new block in a filter. We do if srcBlk is in a filter.
// This can only be true if there is a handler index, and the handler region is more nested than the
// try region (if any). This is because no EH regions can be nested within a filter.
if (BasicBlock::ehIndexMaybeMoreNested(hndIndex, tryIndex))
{
assert(hndIndex != 0); // If hndIndex is more nested, we must be in some handler!
putInFilter = ehGetDsc(hndIndex - 1)->InFilterRegionBBRange(srcBlk);
}
return fgNewBBinRegion(jumpKind, tryIndex, hndIndex, srcBlk, putInFilter, runRarely, insertAtEnd);
}
//------------------------------------------------------------------------
// Creates a new BasicBlock and inserts it at the end of the function.
//
// See the implementation of fgNewBBinRegion() used by this one for more notes.
//
// Arguments:
// jumpKind - the jump kind of the new block to create.
//
// Return Value:
// The new block.
BasicBlock* Compiler::fgNewBBinRegion(BBjumpKinds jumpKind)
{
return fgNewBBinRegion(jumpKind, 0, 0, nullptr, /* putInFilter */ false, /* runRarely */ false, /* insertAtEnd */ true);
}
//------------------------------------------------------------------------
// Creates a new BasicBlock, and inserts it after 'afterBlk'.
//
// The block cannot be inserted into a more nested try/handler region than that specified by 'regionIndex'.
// (It is given exactly 'regionIndex'.) Thus, the parameters must be passed to ensure proper EH nesting
// rules are followed.
//
// Arguments:
// jumpKind - the jump kind of the new block to create.
// afterBlk - insert the new block after this one.
// regionIndex - the block will be put in this EH region.
// putInTryRegion - If true, put the new block in the 'try' region corresponding to 'regionIndex', and
// set its handler index to the most nested handler region enclosing that 'try' region.
// Otherwise, put the block in the handler region specified by 'regionIndex', and set its 'try'
// index to the most nested 'try' region enclosing that handler region.
//
// Return Value:
// The new block.
BasicBlock* Compiler::fgNewBBinRegionWorker(BBjumpKinds jumpKind,
BasicBlock* afterBlk,
unsigned regionIndex,
bool putInTryRegion)
{
/* Insert the new block */
BasicBlock* afterBlkNext = afterBlk->bbNext;
(void)afterBlkNext; //prevent "unused variable" error from GCC
BasicBlock* newBlk = fgNewBBafter(jumpKind, afterBlk, false);
if (putInTryRegion)
{
noway_assert(regionIndex <= MAX_XCPTN_INDEX);
newBlk->bbTryIndex = (unsigned short)regionIndex;
newBlk->bbHndIndex = bbFindInnermostHandlerRegionContainingTryRegion(regionIndex);
}
else
{
newBlk->bbTryIndex = bbFindInnermostTryRegionContainingHandlerRegion(regionIndex);
noway_assert(regionIndex <= MAX_XCPTN_INDEX);
newBlk->bbHndIndex = (unsigned short)regionIndex;
}
// We're going to compare for equal try regions (to handle the case of 'mutually protect'
// regions). We need to save off the current try region, otherwise we might change it
// before it gets compared later, thereby making future comparisons fail.
BasicBlock* newTryBeg;
BasicBlock* newTryLast;
(void)ehInitTryBlockRange(newBlk, &newTryBeg, &newTryLast);
unsigned XTnum;
EHblkDsc* HBtab;
for (XTnum = 0, HBtab = compHndBBtab;
XTnum < compHndBBtabCount;
XTnum++ , HBtab++)
{
// Is afterBlk at the end of a try region?
if (HBtab->ebdTryLast == afterBlk)
{
noway_assert(afterBlkNext == newBlk->bbNext);
bool extendTryRegion = false;
if (newBlk->hasTryIndex())
{
// We're adding a block after the last block of some try region. Do
// we extend the try region to include the block, or not?
// If the try region is exactly the same as the try region
// associated with the new block (based on the block's try index,
// which represents the innermost try the block is a part of), then
// we extend it.
// If the try region is a "parent" try region -- an enclosing try region
// that has the same last block as the new block's try region -- then
// we also extend. For example:
// try { // 1
// ...
// try { // 2
// ...
// } /* 2 */ } /* 1 */
// This example is meant to indicate that both try regions 1 and 2 end at
// the same block, and we're extending 2. Thus, we must also extend 1. If we
// only extended 2, we would break proper nesting. (Dev11 bug 137967)
extendTryRegion = HBtab->ebdIsSameTry(newTryBeg, newTryLast) ||
bbInTryRegions(XTnum, newBlk);
}
// Does newBlk extend this try region?
if (extendTryRegion)
{
// Yes, newBlk extends this try region
// newBlk is the now the new try last block
fgSetTryEnd(HBtab, newBlk);
}
}
// Is afterBlk at the end of a handler region?
if (HBtab->ebdHndLast == afterBlk)
{
noway_assert(afterBlkNext == newBlk->bbNext);
// Does newBlk extend this handler region?
bool extendHndRegion = false;
if (newBlk->hasHndIndex())
{
// We're adding a block after the last block of some handler region. Do
// we extend the handler region to include the block, or not?
// If the handler region is exactly the same as the handler region
// associated with the new block (based on the block's handler index,
// which represents the innermost handler the block is a part of), then
// we extend it.
// If the handler region is a "parent" handler region -- an enclosing
// handler region that has the same last block as the new block's handler
// region -- then we also extend. For example:
// catch { // 1
// ...
// catch { // 2
// ...
// } /* 2 */ } /* 1 */
// This example is meant to indicate that both handler regions 1 and 2 end at
// the same block, and we're extending 2. Thus, we must also extend 1. If we
// only extended 2, we would break proper nesting. (Dev11 bug 372051)
extendHndRegion = bbInHandlerRegions(XTnum, newBlk);
}
if (extendHndRegion)
{
// Yes, newBlk extends this handler region
// newBlk is now the last block of the handler.
fgSetHndEnd(HBtab, newBlk);
}
}
}
/* If afterBlk falls through, we insert a jump around newBlk */
fgConnectFallThrough(afterBlk, newBlk->bbNext);
#ifdef DEBUG
fgVerifyHandlerTab();
#endif
return newBlk;
}
/*****************************************************************************
*/
/* static */
unsigned Compiler::acdHelper(addCodeKind codeKind)
{
switch (codeKind)
{
case ACK_RNGCHK_FAIL: return CORINFO_HELP_RNGCHKFAIL;
case ACK_DIV_BY_ZERO: return CORINFO_HELP_THROWDIVZERO;
case ACK_ARITH_EXCPN: return CORINFO_HELP_OVERFLOW;
default: assert(!"Bad codeKind"); return 0;
}
}
/*****************************************************************************
*
* Find/create an added code entry associated with the given block and with
* the given kind.
*/
BasicBlock* Compiler::fgAddCodeRef(BasicBlock* srcBlk,
unsigned refData,
addCodeKind kind,
unsigned stkDepth)
{
/* For debuggable code, genJumpToThrowHlpBlk() will generate the 'throw'
code inline. It has to be kept consistent with fgAddCodeRef() */
if (opts.compDbgCode)
return NULL;
const static
BBjumpKinds jumpKinds[] =
{
BBJ_NONE, // ACK_NONE
BBJ_THROW, // ACK_RNGCHK_FAIL
BBJ_ALWAYS, // ACK_PAUSE_EXEC
BBJ_THROW, // ACK_DIV_BY_ZERO
BBJ_THROW, // ACK_ARITH_EXCP, ACK_OVERFLOW
};
noway_assert(sizeof(jumpKinds) == ACK_COUNT); // sanity check
/* First look for an existing entry that matches what we're looking for */
AddCodeDsc* add = fgFindExcptnTarget(kind, refData);
if (add) // found it
{
#ifdef _TARGET_X86_
// If different range checks happen at different stack levels,
// they can't all jump to the same "call @rngChkFailed" AND have
// frameless methods, as the rngChkFailed may need to unwind the
// stack, and we have to be able to report the stack level.
//
// The following check forces most methods that reference an
// array element in a parameter list to have an EBP frame,
// this restriction could be removed with more careful code
// generation for BBJ_THROW (i.e. range check failed).
//
if (add->acdStkLvl != stkDepth)
{
codeGen->setFrameRequired(true);
}
#endif // _TARGET_X86_
goto DONE;
}
/* We have to allocate a new entry and prepend it to the list */
add = new (this, CMK_Unknown) AddCodeDsc;
add->acdData = refData;
add->acdKind = kind;
add->acdStkLvl = (unsigned short)stkDepth;
noway_assert(add->acdStkLvl == stkDepth);
add->acdNext = fgAddCodeList;
fgAddCodeList = add;
/* Create the target basic block */
BasicBlock* newBlk;
newBlk =
add->acdDstBlk = fgNewBBinRegion(jumpKinds[kind], srcBlk, /* runRarely */ true, /* insertAtEnd */ true);
add->acdDstBlk->bbFlags |= BBF_JMP_TARGET|BBF_HAS_LABEL;
#ifdef DEBUG
if (verbose)
{
const char* msgWhere = "";
if (!srcBlk->hasTryIndex() && !srcBlk->hasHndIndex())
{
msgWhere = "non-EH region";
}
else if (!srcBlk->hasTryIndex())
{
msgWhere = "handler";
}
else if (!srcBlk->hasHndIndex())
{
msgWhere = "try";
}
else if (srcBlk->getTryIndex() < srcBlk->getHndIndex())
{
msgWhere = "try";
}
else
{
msgWhere = "handler";
}
const char* msg = "";
if (kind == ACK_RNGCHK_FAIL)
{
msg = " for RNGCHK_FAIL";
}
else if (kind == ACK_PAUSE_EXEC)
{
msg = " for PAUSE_EXEC";
}
else if (kind == ACK_DIV_BY_ZERO)
{
msg = " for DIV_BY_ZERO";
}
else if (kind == ACK_OVERFLOW)
{
msg = " for OVERFLOW";
}
printf("\nfgAddCodeRef -"
" Add BB in %s%s, new block BB%02u [%08p], stkDepth is %d\n",
msgWhere, msg, add->acdDstBlk->bbNum, dspPtr(add->acdDstBlk), stkDepth);
}
#endif // DEBUG
#ifdef DEBUG
newBlk->bbTgtStkDepth = stkDepth;
#endif // DEBUG
/* Mark the block as added by the compiler and not removable by future flow
graph optimizations. Note that no bbJumpDest points to these blocks. */
newBlk->bbFlags |= BBF_IMPORTED;
newBlk->bbFlags |= BBF_DONT_REMOVE;
/* Remember that we're adding a new basic block */
fgAddCodeModf = true;
fgRngChkThrowAdded = true;
/* Now figure out what code to insert */
GenTreeCall* tree;
int helper;
switch (kind)
{
case ACK_RNGCHK_FAIL: helper = CORINFO_HELP_RNGCHKFAIL;
goto ADD_HELPER_CALL;
case ACK_DIV_BY_ZERO: helper = CORINFO_HELP_THROWDIVZERO;
goto ADD_HELPER_CALL;
case ACK_ARITH_EXCPN: helper = CORINFO_HELP_OVERFLOW;
noway_assert(ACK_OVERFLOW == ACK_ARITH_EXCPN);
goto ADD_HELPER_CALL;
ADD_HELPER_CALL:;
/* Add the appropriate helper call */
tree = gtNewHelperCallNode(helper, TYP_VOID, GTF_EXCEPT);
// There are no args here but fgMorphArgs has side effects
// such as setting the outgoing arg area (which is necessary
// on AMD if there are any calls).
tree = fgMorphArgs(tree);
break;
// case ACK_PAUSE_EXEC:
// noway_assert(!"add code to pause exec");
default:
noway_assert(!"unexpected code addition kind");
return NULL;
}
/* Store the tree in the new basic block */
fgInsertStmtAtEnd(newBlk, fgNewStmtFromTree(tree));
DONE:;
return add->acdDstBlk;
}
/*****************************************************************************
* Finds the block to jump to, to throw a given kind of exception
* We maintain a cache of one AddCodeDsc for each kind, to make searching fast.
* Note : Each block uses the same (maybe shared) block as the jump target for
* a given type of exception
*/
Compiler::AddCodeDsc* Compiler::fgFindExcptnTarget(addCodeKind kind,
unsigned refData)
{
if (!(fgExcptnTargetCache[kind] && // Try the cached value first
fgExcptnTargetCache[kind]->acdData == refData))
{
// Too bad, have to search for the jump target for the exception
AddCodeDsc* add = NULL;
for (add = fgAddCodeList; add != NULL; add = add->acdNext)
{
if (add->acdData == refData && add->acdKind == kind)
break;
}
fgExcptnTargetCache[kind] = add; // Cache it
}
return fgExcptnTargetCache[kind];
}
/*****************************************************************************
*
* The given basic block contains an array range check; return the label this
* range check is to jump to upon failure.
*/
BasicBlock* Compiler::fgRngChkTarget(BasicBlock* block, unsigned stkDepth)
{
#ifdef DEBUG
if (verbose)
{
printf("*** Computing fgRngChkTarget for block BB%02u to stkDepth %d\n", block->bbNum, stkDepth);
gtDispTree(compCurStmt);
}
#endif // DEBUG
/* We attach the target label to the containing try block (if any) */
noway_assert(!compIsForInlining());
return fgAddCodeRef(block, bbThrowIndex(block), ACK_RNGCHK_FAIL, stkDepth);
}
// Sequences the tree.
// prevTree is what gtPrev of the first node in execution order gets set to.
// Returns the first node (execution order) in the sequenced tree.
GenTree* Compiler::fgSetTreeSeq(GenTree* tree, GenTree* prevTree)
{
GenTree list;
if (prevTree == nullptr)
{
prevTree = &list;
}
fgTreeSeqLst = prevTree;
fgTreeSeqNum = 0;
fgTreeSeqBeg = nullptr;
fgSetTreeSeqHelper(tree);
GenTree* result = prevTree->gtNext;
if (prevTree == &list)
{
list.gtNext->gtPrev = nullptr;
}
return result;
}
/*****************************************************************************
*
* Assigns sequence numbers to the given tree and its sub-operands, and
* threads all the nodes together via the 'gtNext' and 'gtPrev' fields.
* Uses 'global' - fgTreeSeqLst
*/
void Compiler::fgSetTreeSeqHelper(GenTreePtr tree)
{
genTreeOps oper;
unsigned kind;
noway_assert(tree);
assert(!IsUninitialized(tree));
noway_assert(tree->gtOper != GT_STMT);
/* Figure out what kind of a node we have */
oper = tree->OperGet();
kind = tree->OperKind();
/* Is this a leaf/constant node? */
if (kind & (GTK_CONST|GTK_LEAF))
{
fgSetTreeSeqFinish(tree);
return;
}
/* Is it a 'simple' unary/binary operator? */
if (kind & GTK_SMPOP)
{
GenTreePtr op1 = tree->gtOp.gtOp1;
GenTreePtr op2 = tree->gtGetOp2();
// Special handling for GT_LIST
if (tree->OperGet() == GT_LIST)
{
if (tree->gtOp.gtOp2 != nullptr
&& tree->gtOp.gtOp2->gtOper != GT_LIST)
{
// This is a special kind of GT_LIST that only occurs under initBlk and copyBlk.
// It is used as a pair, where op1 is the dst and op2 is the src (value or location)
// The use must appear before the def because of the case where a local is cpblk'ed to itself.
// If it were otherwise, upstream stores to the local would appear to be dead.
assert(tree->gtOp.gtOp1->gtOper != GT_LIST);
fgSetTreeSeqHelper(tree->gtOp.gtOp2);
fgSetTreeSeqHelper(tree->gtOp.gtOp1);
fgSetTreeSeqFinish(tree);
return;
}
// First, handle the list items, which will be linked in forward order.
// As we go, we will link the GT_LIST nodes in reverse order - we will number
// them and update fgTreeSeqList in a subsequent traversal.
GenTreePtr nextList = tree;
GenTreePtr list = nullptr;
while(nextList != nullptr && nextList->OperGet() == GT_LIST)
{
list = nextList;
GenTreePtr listItem = list->gtOp.gtOp1;
fgSetTreeSeqHelper(listItem);
nextList = list->gtOp.gtOp2;
if (nextList != nullptr)
{
nextList->gtNext = list;
}
list->gtPrev = nextList;
}
// Next, handle the GT_LIST nodes.
// Note that fgSetTreeSeqFinish() sets the gtNext to null, so we need to capture the nextList
// before we call that method.
nextList = list;
do
{
assert(list != nullptr);
list = nextList;
nextList = list->gtNext;
fgSetTreeSeqFinish(list);
} while (list != tree);
return;
}
/* Special handling for AddrMode */
if (tree->OperIsAddrMode())
{
bool reverse = ((tree->gtFlags & GTF_REVERSE_OPS) != 0);
if (reverse)
{
assert(op1 != NULL && op2 != NULL);
fgSetTreeSeqHelper(op2);
}
if (op1 != NULL)
{
fgSetTreeSeqHelper(op1);
}
if (!reverse && op2 != NULL)
{
fgSetTreeSeqHelper(op2);
}
fgSetTreeSeqFinish(tree);
return;
}
/* Handle the case of an LDOBJ with a field list */
GenTreePtr lclVarTree;
if ((oper == GT_LDOBJ) &&
tree->gtLdObj.gtFldTreeList != NULL &&
impIsAddressInLocal(tree->gtOp.gtOp1, &lclVarTree))
{
GenTreePtr* fldTreeList = tree->gtLdObj.gtFldTreeList;
unsigned fieldCount = lvaTable[lclVarTree->gtLclVarCommon.gtLclNum].lvFieldCnt;
for (unsigned i = 0; i < fieldCount; i++)
{
if (fldTreeList[i] != NULL)
{
fgSetTreeSeqHelper(fldTreeList[i]);
}
}
}
/* Check for a nilary operator */
if (op1 == NULL)
{
noway_assert(op2 == NULL);
fgSetTreeSeqFinish(tree);
return;
}
/* Is this a unary operator?
* Although UNARY GT_IND has a special structure */
if (oper == GT_IND)
{
/* Visit the indirection first - op2 may point to the
* jump Label for array-index-out-of-range */
fgSetTreeSeqHelper(op1);
fgSetTreeSeqFinish(tree);
return;
}
/* Now this is REALLY a unary operator */
if (!op2)
{
/* Visit the (only) operand and we're done */
fgSetTreeSeqHelper(op1);
fgSetTreeSeqFinish(tree);
return;
}
/*
For "real" ?: operators, we make sure the order is
as follows:
condition
1st operand
GT_COLON
2nd operand
GT_QMARK
*/
if (oper == GT_QMARK)
{
noway_assert((tree->gtFlags & GTF_REVERSE_OPS) == 0);
fgSetTreeSeqHelper(op1);
// Here, for the colon, the sequence does not actually represent "order of evaluation":
// one or the other of the branches is executed, not both. Still, to make debugging checks
// work, we want the sequence to match the order in which we'll generate code, which means
// "else" clause then "then" clause.
fgSetTreeSeqHelper(op2->AsColon()->ElseNode());
fgSetTreeSeqHelper(op2);
fgSetTreeSeqHelper(op2->AsColon()->ThenNode());
fgSetTreeSeqFinish(tree);
return;
}
if (oper == GT_COLON)
{
fgSetTreeSeqFinish(tree);
return;
}
/* This is a binary operator */
if (tree->gtFlags & GTF_REVERSE_OPS)
{
fgSetTreeSeqHelper(op2);
fgSetTreeSeqHelper(op1);
}
else
{
fgSetTreeSeqHelper(op1);
fgSetTreeSeqHelper(op2);
}
fgSetTreeSeqFinish(tree);
return;
}
/* See what kind of a special operator we have here */
switch (oper)
{
case GT_FIELD:
noway_assert(tree->gtField.gtFldObj == NULL);
break;
case GT_CALL:
/* We'll evaluate the 'this' argument value first */
if (tree->gtCall.gtCallObjp)
{
fgSetTreeSeqHelper(tree->gtCall.gtCallObjp);
}
/* We'll evaluate the arguments next, left to right
* NOTE: setListOrder needs cleanup - eliminate the #ifdef afterwards */
if (tree->gtCall.gtCallArgs)
{
fgSetTreeSeqHelper(tree->gtCall.gtCallArgs);
}
/* Evaluate the temp register arguments list
* This is a "hidden" list and its only purpose is to
* extend the life of temps until we make the call */
if (tree->gtCall.gtCallLateArgs)
{
fgSetTreeSeqHelper(tree->gtCall.gtCallLateArgs);
}
if ((tree->gtCall.gtCallType == CT_INDIRECT) && (tree->gtCall.gtCallCookie != NULL))
{
fgSetTreeSeqHelper(tree->gtCall.gtCallCookie);
}
if (tree->gtCall.gtCallType == CT_INDIRECT)
{
fgSetTreeSeqHelper(tree->gtCall.gtCallAddr);
}
if (tree->gtCall.gtControlExpr)
{
fgSetTreeSeqHelper(tree->gtCall.gtControlExpr);
}
break;
case GT_ARR_ELEM:
fgSetTreeSeqHelper(tree->gtArrElem.gtArrObj);
unsigned dim;
for (dim = 0; dim < tree->gtArrElem.gtArrRank; dim++)
{
fgSetTreeSeqHelper(tree->gtArrElem.gtArrInds[dim]);
}
break;
case GT_ARR_OFFSET:
fgSetTreeSeqHelper(tree->gtArrOffs.gtOffset);
fgSetTreeSeqHelper(tree->gtArrOffs.gtIndex);
fgSetTreeSeqHelper(tree->gtArrOffs.gtArrObj);
break;
case GT_CMPXCHG:
//Evaluate the trees left to right
fgSetTreeSeqHelper(tree->gtCmpXchg.gtOpLocation);
fgSetTreeSeqHelper(tree->gtCmpXchg.gtOpValue);
fgSetTreeSeqHelper(tree->gtCmpXchg.gtOpComparand);
break;
case GT_ARR_BOUNDS_CHECK:
#ifdef FEATURE_SIMD
case GT_SIMD_CHK:
#endif // FEATURE_SIMD
//Evaluate the trees left to right
fgSetTreeSeqHelper(tree->gtBoundsChk.gtArrLen);
fgSetTreeSeqHelper(tree->gtBoundsChk.gtIndex);
break;
default:
#ifdef DEBUG
gtDispTree(tree);
noway_assert(!"unexpected operator");
#endif // DEBUG
break;
}
fgSetTreeSeqFinish(tree);
}
void
Compiler::fgSetTreeSeqFinish(GenTreePtr tree)
{
/* Append to the node list */
++fgTreeSeqNum;
#ifdef DEBUG
tree->gtSeqNum = fgTreeSeqNum;
if (verbose & 0)
{
printf("SetTreeOrder: ");
printTreeID(fgTreeSeqLst);
printf(" followed by ");
printTreeID(tree);
printf("\n");
}
#endif // DEBUG
fgTreeSeqLst->gtNext = tree;
tree->gtNext = nullptr;
tree->gtPrev = fgTreeSeqLst;
fgTreeSeqLst = tree;
/* Remember the very first node */
if (!fgTreeSeqBeg)
{
fgTreeSeqBeg = tree;
assert(tree->gtSeqNum == 1);
}
}
/*****************************************************************************
*
* Figure out the order in which operators should be evaluated, along with
* other information (such as the register sets trashed by each subtree).
* Also finds blocks that need GC polls and inserts them as needed.
*/
void Compiler::fgSetBlockOrder()
{
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgSetBlockOrder()\n");
}
#endif // DEBUG
/* Walk the basic blocks to assign sequence numbers */
#ifdef DEBUG
BasicBlock::s_nMaxTrees = 0;
#endif
/* If we don't compute the doms, then we never mark blocks as loops. */
if (fgDomsComputed)
{
for (BasicBlock * block = fgFirstBB; block; block = block->bbNext)
{
/* If this block is a loop header, mark it appropriately */
if (block->isLoopHead())
fgMarkLoopHead(block);
}
}
//only enable fully interruptible code for if we're hijacking.
else if (GCPOLL_NONE == opts.compGCPollType)
{
/* If we don't have the dominators, use an abbreviated test for fully interruptible. If there are
* any back edges, check the source and destination blocks to see if they're GC Safe. If not, then
* go fully interruptible. */
/* XXX Mon 1/21/2008
* Wouldn't it be nice to have a block iterator that can do this loop?
*/
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
//true if the edge is forward, or if it is a back edge and either the source and dest are GC safe.
#define EDGE_IS_GC_SAFE(src, dst) (((src)->bbNum < (dst)->bbNum) || (((src)->bbFlags | (dst)->bbFlags) & BBF_GC_SAFE_POINT))
bool partiallyInterruptible = true;
switch (block->bbJumpKind)
{
case BBJ_COND:
case BBJ_ALWAYS:
partiallyInterruptible = EDGE_IS_GC_SAFE(block, block->bbJumpDest);
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpPtr; jumpPtr = block->bbJumpSwt->bbsDstTab;
do
{
partiallyInterruptible &= EDGE_IS_GC_SAFE(block, *jumpPtr);
}
while (++jumpPtr, --jumpCnt);
break;
default:
break;
}
if (!partiallyInterruptible)
{
// DDB 204533:
// The GC encoding for fully interruptible methods does not
// support more than 1023 pushed arguments, so we can't set
// genInterruptible here when we have 1024 or more pushed args
//
if (compCanEncodePtrArgCntMax())
{
genInterruptible = true;
}
break;
}
#undef EDGE_IS_GC_SAFE
}
}
if (!fgGCPollsCreated)
{
fgCreateGCPolls();
}
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
#ifndef JIT32_GCENCODER
if (block->endsWithTailCallOrJmp(this, true) &&
!(block->bbFlags & BBF_GC_SAFE_POINT) &&
optReachWithoutCall(fgFirstBB, block))
{
// We have a tail call that is reachable without making any other
// 'normal' call that would have counted as a GC Poll. If we were
// using polls, all return blocks meeting this criteria would have
// already added polls and then marked as being GC safe
// (BBF_GC_SAFE_POINT). Thus we can only reach here when *NOT*
// using GC polls, but instead relying on the JIT to generate
// fully-interruptible code.
noway_assert(GCPOLL_NONE == opts.compGCPollType);
// This tail call might combine with other tail calls to form a
// loop. Thus we need to either add a poll, or make the method
// fully interruptible. I chose the later because that's what
// JIT64 does.
genInterruptible = true;
}
#endif // !JIT32_GCENCODER
fgSetBlockOrder(block);
}
/* Remember that now the tree list is threaded */
fgStmtListThreaded = true;
#ifdef DEBUG
if (verbose)
{
printf("The biggest BB has %4u tree nodes\n", BasicBlock::s_nMaxTrees);
}
fgDebugCheckLinks();
#endif // DEBUG
}
/*****************************************************************************/
void Compiler::fgSetStmtSeq(GenTreePtr tree)
{
GenTree list; // helper node that we use to start the StmtList
// It's located in front of the first node in the list
noway_assert(tree->gtOper == GT_STMT);
noway_assert(tree->gtNext == nullptr || tree->gtNext->gtFlags & GTF_STMT_TOP_LEVEL);
/* Assign numbers and next/prev links for this tree */
fgTreeSeqNum = 0;
fgTreeSeqLst = &list;
fgTreeSeqBeg = NULL;
fgSetTreeSeqHelper(tree->gtStmt.gtStmtExpr);
/* Record the address of the first node */
tree->gtStmt.gtStmtList = fgTreeSeqBeg;
#ifdef DEBUG
if (list.gtNext->gtPrev != &list)
{
printf("&list ");
printTreeID(&list);
printf(" != list.next->prev ");
printTreeID(list.gtNext->gtPrev);
printf("\n");
goto BAD_LIST;
}
GenTreePtr temp;
GenTreePtr last;
for (temp = list.gtNext, last = &list; temp; last = temp, temp = temp->gtNext)
{
if (temp->gtPrev != last)
{
printTreeID(temp);
printf("->gtPrev = ");
printTreeID(temp->gtPrev);
printf(", but last = ");
printTreeID(last);
printf("\n");
BAD_LIST:;
printf("\n");
gtDispTree(tree->gtStmt.gtStmtExpr);
printf("\n");
for (GenTreePtr bad = &list; bad; bad = bad->gtNext)
{
printf(" entry at ");
printTreeID(bad);
printf(" (prev=");
printTreeID(bad->gtPrev);
printf(",next=)");
printTreeID(bad->gtNext);
printf("\n");
}
printf("\n");
noway_assert(!"Badly linked tree");
break;
}
}
#endif // DEBUG
/* Fix the first node's 'prev' link */
noway_assert(list.gtNext->gtPrev == &list);
list.gtNext->gtPrev = NULL;
/* Keep track of the highest # of tree nodes */
#ifdef DEBUG
if (BasicBlock::s_nMaxTrees < fgTreeSeqNum)
{
BasicBlock::s_nMaxTrees = fgTreeSeqNum;
}
#endif // DEBUG
}
/*****************************************************************************/
void Compiler::fgSetBlockOrder(BasicBlock* block)
{
GenTreePtr tree;
tree = block->bbTreeList;
if (!tree)
return;
for (;;)
{
fgSetStmtSeq(tree);
/* Are there any more trees in this basic block? */
if (tree->gtNext == nullptr)
{
/* last statement in the tree list */
noway_assert(block->lastStmt() == tree);
break;
}
#ifdef DEBUG
if (block->bbTreeList == tree)
{
/* first statement in the list */
noway_assert(tree->gtPrev->gtNext == nullptr);
}
else
{
noway_assert(tree->gtPrev->gtNext == tree);
}
noway_assert(tree->gtNext->gtPrev == tree);
#endif // DEBUG
tree = tree->gtNext;
}
}
/*****************************************************************************
*
* For GT_INITBLK and GT_COPYBLK, the tree looks like this :
* tree->gtOp
* / \
* / \.
* GT_LIST [size/clsHnd]
* / \
* / \
* [dest] [val/src]
*
* ie. they are ternary operators. However we use nested binary trees so that
* GTF_REVERSE_OPS will be set just like for other binary operators. As the
* operands need to end up in specific registers to issue the "rep stos" or
* the "rep movs" instruction, if we don't allow the order of evaluation of
* the 3 operands to be mixed, we may generate really bad code.
*
* eg. For "rep stos", [val] has to be in EAX. Then if [size]
* has a division, we will have to spill [val] from EAX. It will be better to
* evaluate [size] and the evaluate [val] into EAX.
*
* This function stores the operands in the order to be evaluated
* into opsPtr[]. The regsPtr[] contains reg0,reg1,reg2 in the correspondingly
* switched order.
*/
void Compiler::fgOrderBlockOps(GenTreePtr tree,
regMaskTP reg0,
regMaskTP reg1,
regMaskTP reg2,
GenTreePtr* opsPtr, // OUT
regMaskTP* regsPtr) // OUT
{
assert(tree->OperIsBlkOp());
assert(tree->gtOp.gtOp1 && tree->gtOp.gtOp1->IsList());
assert(tree->gtOp.gtOp1->gtOp.gtOp1 && tree->gtOp.gtOp1->gtOp.gtOp2);
assert(tree->gtOp.gtOp2);
GenTreePtr ops[3] =
{
tree->gtOp.gtOp1->gtOp.gtOp1, // Dest address
tree->gtOp.gtOp1->gtOp.gtOp2, // Val / Src address
tree->gtOp.gtOp2 // Size of block
};
regMaskTP regs[3] = { reg0, reg1, reg2 };
static int blockOpsOrder[4][3] =
// tree->gtFlags | tree->gtOp.gtOp1->gtFlags
{ // ---------------------+----------------------------
{ 0, 1, 2 }, // - | -
{ 2, 0, 1 }, // GTF_REVERSE_OPS | -
{ 1, 0, 2 }, // - | GTF_REVERSE_OPS
{ 2, 1, 0 } // GTF_REVERSE_OPS | GTF_REVERSE_OPS
};
int orderNum = ((tree->gtFlags & GTF_REVERSE_OPS) != 0) * 1 +
((tree->gtOp.gtOp1->gtFlags & GTF_REVERSE_OPS) != 0) * 2;
assert(orderNum < 4);
int* order = blockOpsOrder[orderNum];
PREFIX_ASSUME(order != NULL);
// Fill in the OUT arrays according to the order we have selected
opsPtr[0] = ops[ order[0] ];
opsPtr[1] = ops[ order[1] ];
opsPtr[2] = ops[ order[2] ];
regsPtr[0] = regs[ order[0] ];
regsPtr[1] = regs[ order[1] ];
regsPtr[2] = regs[ order[2] ];
}
//------------------------------------------------------------------------
// fgFindTopLevelStmtBackwards: Find the nearest top-level statement to 'stmt', walking the gtPrev links.
// The nearest one might be 'stmt' itself.
//
// Arguments:
// stmt - The statment to start the search with.
//
// Return Value:
// The nearest top-level statement, walking backwards.
//
// Assumptions:
// We will find one!
/* static */
GenTreeStmt* Compiler::fgFindTopLevelStmtBackwards(GenTreeStmt* stmt)
{
while (!stmt->gtStmtIsTopLevel())
{
stmt = stmt->gtPrev->AsStmt();
}
return stmt;
}
//------------------------------------------------------------------------
// fgGetFirstNode: Get the first node in the tree, in execution order
//
// Arguments:
// tree - The top node of the tree of interest
//
// Return Value:
// The first node in execution order, that belongs to tree.
//
// Assumptions:
// 'tree' must either be a leaf, or all of its constituent nodes must be contiguous
// in execution order.
// TODO-Cleanup: Add a debug-only method that verifies this.
/* static */
GenTreePtr Compiler::fgGetFirstNode(GenTreePtr tree)
{
GenTreePtr child = tree;
while (child->NumChildren() > 0)
{
if (child->OperIsBinary() && ((child->gtFlags & GTF_REVERSE_OPS) != 0))
{
child = child->GetChild(1);
}
else
{
child = child->GetChild(0);
}
}
return child;
}
//------------------------------------------------------------------------
// fgSnipNode: Remove a single tree node (and not its children, if any) from the execution order.
//
// Arguments:
// 'stmt' - The statement which currently contains 'node'
// 'node' - The tree node to be removed
//
// Return Value:
// None.
//
// Assumptions:
// 'stmt' must be non-null.
//
// Notes:
// The node may be any node in the statement, including the first or last node in the statement.
// This is similar to fgDeleteTreeFromList(), but it removes just a single node, not a whole tree.
void Compiler::fgSnipNode(GenTreeStmt* stmt, GenTreePtr node)
{
assert(stmt != nullptr);
assert(node != nullptr);
assert(stmt->gtOper == GT_STMT);
assert(node->gtOper != GT_STMT);
assert(fgTreeIsInStmt(node, stmt));
GenTreePtr prevNode = node->gtPrev;
GenTreePtr nextNode = node->gtNext;
if (prevNode != nullptr)
{
prevNode->gtNext = nextNode;
}
else
{
// The node is the first in the statement in execution order.
assert(stmt->gtStmtList == node);
}
// Note that the node may be first but also have a prevNode (if it is embedded)
if (stmt->gtStmtList == node)
{
stmt->gtStmtList = nextNode;
}
if (nextNode != nullptr)
{
nextNode->gtPrev = prevNode;
}
else
{
// The node is the last in the statement in execution order.
assert(stmt->gtStmtExpr == node);
stmt->gtStmtExpr = prevNode;
}
}
//------------------------------------------------------------------------
// fgSnipInnerNode: Remove a single tree node (and not its children, if any) from the execution order.
//
// Arguments:
// 'node' - The tree node to be removed
//
// Return Value:
// None.
//
// Assumptions:
// The node may not be the first or last node in the statement. In those cases, fgSnipNode() must be used,
// which gets passed the parent GT_STMT node and can update gtStmtList and gtStmtExpr, respectively.
/* static */
void Compiler::fgSnipInnerNode(GenTreePtr node)
{
assert(node != nullptr);
assert(node->gtOper != GT_STMT);
GenTreePtr prevNode = node->gtPrev;
GenTreePtr nextNode = node->gtNext;
assert(prevNode != nullptr);
assert(nextNode != nullptr);
prevNode->gtNext = nextNode;
nextNode->gtPrev = prevNode;
}
//------------------------------------------------------------------------
// fgDeleteTreeFromList: Remove an entire tree from the execution order.
//
// Arguments:
// 'stmt' - The statement which currently contains 'tree'
// 'tree' - The tree to be removed
//
// Return Value:
// None.
//
// Assumptions:
// 'tree' is in the execution order list for 'stmt'
//
// Notes:
// This is similar to fgSnipNode(), but it removes a whole tree, not just a single node.
void Compiler::fgDeleteTreeFromList(GenTreeStmt* stmt, GenTreePtr tree)
{
assert(stmt != nullptr);
assert(tree != nullptr);
assert(stmt->gtOper == GT_STMT);
assert(tree->gtOper != GT_STMT);
assert(fgTreeIsInStmt(tree, stmt));
GenTreePtr firstNode = fgGetFirstNode(tree);
GenTreePtr prevNode = firstNode->gtPrev;
GenTreePtr nextNode = tree->gtNext;
if (prevNode != nullptr)
{
prevNode->gtNext = nextNode;
}
else
{
// The first node in the tree is the first in the statement in execution order.
assert(stmt->gtStmtList == firstNode);
stmt->gtStmtList = nextNode;
}
if (nextNode != nullptr)
{
nextNode->gtPrev = prevNode;
}
else
{
// The last node in the tree is the last in the statement in execution order.
assert(stmt->gtStmtExpr == tree);
stmt->gtStmtExpr = prevNode;
}
}
//------------------------------------------------------------------------
// fgTreeIsInStmt: return 'true' if 'tree' is in the execution order list of statment 'stmt'.
// This works for a single node or an entire tree, assuming a well-formed tree, where the entire
// tree's set of nodes are in the statement execution order list.
//
/* static */
bool Compiler::fgTreeIsInStmt(GenTree* tree, GenTreeStmt* stmt)
{
assert(tree != nullptr);
assert(stmt != nullptr);
assert(tree->gtOper != GT_STMT);
assert(stmt->gtOper == GT_STMT);
for (GenTree* curr = stmt->gtStmtList; curr != nullptr; curr = curr->gtNext)
{
if (tree == curr)
return true;
}
return false;
}
//------------------------------------------------------------------------
// fgInsertTreeInListAfter: Insert 'tree' in the execution order list before 'insertionPoint'.
// 'stmt' is required, so we can insert before the first node in the statement.
// Assumes that 'tree' and its children are disjoint from 'insertionPoint', and none of them are in 'stmt'.
//
/* static */
void Compiler::fgInsertTreeInListBefore(GenTree* tree, GenTree* insertionPoint, GenTreeStmt* stmt)
{
assert(tree != nullptr);
assert(insertionPoint != nullptr);
assert(stmt != nullptr);
assert(tree->gtOper != GT_STMT);
assert(insertionPoint->gtOper != GT_STMT);
assert(fgTreeIsInStmt(insertionPoint, stmt));
assert(!fgTreeIsInStmt(tree, stmt));
GenTree* beforeTree = insertionPoint->gtPrev;
insertionPoint->gtPrev = tree;
tree->gtNext = insertionPoint;
GenTree* first = fgGetFirstNode(tree);
first->gtPrev = beforeTree;
if (beforeTree != nullptr)
{
beforeTree->gtNext = first;
}
else
{
assert(stmt->gtStmtList == insertionPoint);
stmt->gtStmtList = first;
}
}
//------------------------------------------------------------------------
// fgInsertTreeInListAfter: Insert tree in execution order list after 'insertionPoint'.
// 'stmt' is required, so we can insert after the last node in the statement.
// Assumes that 'tree' and its children are disjoint from 'insertionPoint', and none of them are in 'stmt'.
//
/* static */
void Compiler::fgInsertTreeInListAfter(GenTree* tree, GenTree* insertionPoint, GenTreeStmt* stmt)
{
assert(tree != nullptr);
assert(insertionPoint != nullptr);
assert(stmt != nullptr);
assert(tree->gtOper != GT_STMT);
assert(insertionPoint->gtOper != GT_STMT);
assert(fgTreeIsInStmt(insertionPoint, stmt));
assert(!fgTreeIsInStmt(tree, stmt));
GenTree* afterTree = insertionPoint->gtNext;
GenTree* first = fgGetFirstNode(tree);
insertionPoint->gtNext = first;
first->gtPrev = insertionPoint;
tree->gtNext = afterTree;
if (afterTree != nullptr)
{
afterTree->gtPrev = tree;
}
else
{
assert(stmt->gtStmtExpr == insertionPoint);
stmt->gtStmtExpr = tree;
}
}
//------------------------------------------------------------------------
// fgInsertTreeBeforeAsEmbedded: Insert a tree before 'insertionPoint' as an embedded statement under 'stmt'.
//
GenTreeStmt* Compiler::fgInsertTreeBeforeAsEmbedded(GenTree* tree, GenTree* insertionPoint, GenTreeStmt* stmt, BasicBlock* block)
{
assert(tree->gtOper != GT_STMT);
assert(insertionPoint->gtOper != GT_STMT);
assert(stmt != nullptr);
assert(stmt->gtOper == GT_STMT);
assert(fgTreeIsInStmt(insertionPoint, stmt));
assert(!fgTreeIsInStmt(tree, stmt));
gtSetEvalOrder(tree);
fgSetTreeSeq(tree);
fgInsertTreeInListBefore(tree, insertionPoint, stmt);
// While inserting a statement as embedded, the parent specified has to be a top-level statement
// since we could be inserting it ahead of an already existing embedded statment
// in execution order.
GenTreeStmt* topStmt = fgFindTopLevelStmtBackwards(stmt);
GenTreeStmt* result = fgMakeEmbeddedStmt(block, tree, topStmt);
DBEXEC(true, fgDebugCheckNodeLinks(block, result));
return result;
}
//------------------------------------------------------------------------
// fgInsertTreeAfterAsEmbedded: Insert a tree after 'insertionPoint' as an embedded statement under 'stmt'.
// If it is inserted after all nodes in the given tree, just make it a new statement.
GenTreeStmt* Compiler::fgInsertTreeAfterAsEmbedded(GenTree* tree, GenTree* insertionPoint, GenTreeStmt* stmt, BasicBlock* block)
{
assert(tree->gtOper != GT_STMT);
assert(insertionPoint->gtOper != GT_STMT);
assert(stmt != nullptr);
assert(stmt->gtOper == GT_STMT);
assert(fgTreeIsInStmt(insertionPoint, stmt));
assert(!fgTreeIsInStmt(tree, stmt));
GenTreeStmt* result;
if (insertionPoint->gtNext == nullptr)
{
// We're just going to make it a new top-level statement, not an embedded statement,
// since we're inserting it at the end of the statement list's execution order.
// we better have been given the right stmt
assert(insertionPoint == stmt->gtStmtExpr);
// this sets the sequence
result = fgNewStmtFromTree(tree, block);
// Skip all the embedded statements within 'stmt' (which immediately follow 'stmt' in the statement list).
// Insert after the last such embedded statement.
GenTreeStmt* stmtAfter = stmt;
while ((stmtAfter->gtNext != nullptr) && stmtAfter->gtNextStmt->gtStmtIsEmbedded())
{
stmtAfter = stmtAfter->gtNextStmt;
}
fgInsertStmtAfter(block, stmtAfter, result);
}
else
{
gtSetEvalOrder(tree);
fgSetTreeSeq(tree);
fgInsertTreeInListAfter(tree, insertionPoint, stmt);
result = fgMakeEmbeddedStmt(block, tree, stmt);
}
DBEXEC(true, fgDebugCheckNodeLinks(block, result));
return result;
}
// Examine the bbTreeList and return the estimated code size for this block
unsigned Compiler::fgGetCodeEstimate(BasicBlock* block)
{
unsigned costSz = 0; // estimate of blocks code size cost
switch (block->bbJumpKind)
{
case BBJ_NONE:
costSz = 0;
break;
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
case BBJ_LEAVE:
case BBJ_COND:
costSz = 2;
break;
case BBJ_CALLFINALLY:
costSz = 5;
break;
case BBJ_SWITCH:
costSz = 10;
break;
case BBJ_THROW:
costSz = 1; // We place a int3 after the code for a throw block
break;
case BBJ_EHFINALLYRET:
case BBJ_EHFILTERRET:
costSz = 1;
break;
case BBJ_RETURN: // return from method
costSz = 3;
break;
default:
noway_assert(!"Bad bbJumpKind");
break;
}
#if JIT_FEATURE_SSA_SKIP_DEFS
GenTreePtr tree = block->FirstNonPhiDef();
#else
GenTreePtr tree = block->bbTreeList;
#endif
if (tree)
{
do
{
noway_assert(tree->gtOper == GT_STMT);
if (tree->gtCostSz < MAX_COST)
{
costSz += tree->gtCostSz;
}
else
{
// We could walk the tree to find out the real gtCostSz,
// but just using MAX_COST for this trees code size works OK
costSz += tree->gtCostSz;
}
tree = tree->gtNext;
}
while (tree);
}
return costSz;
}
#if XML_FLOWGRAPHS
struct escapeMapping_t
{
char ch;
const char* sub;
};
static escapeMapping_t s_EscapeFileMapping[] =
{
{':', "="},
{'<', "["},
{'>', "]"},
{';', "~semi~"},
{'|', "~bar~"},
{'&', "~amp~"},
{'"', "~quot~"},
{'*', "~star~"},
{0, 0}
};
static escapeMapping_t s_EscapeXmlMapping[] =
{
{'<', "<"},
{'>', ">"},
{'&', "&"},
{'"', """},
{0, 0}
};
const char* Compiler::fgProcessEscapes(const char* nameIn, escapeMapping_t* map)
{
const char* nameOut = nameIn;
unsigned lengthOut;
unsigned index;
bool match;
bool subsitutionRequired;
const char* pChar;
lengthOut = 1;
subsitutionRequired = false;
pChar = nameIn;
while (*pChar != '\0')
{
match = false;
index = 0;
while (map[index].ch != 0)
{
if (*pChar == map[index].ch)
{
match = true;
break;
}
index++;
}
if (match)
{
subsitutionRequired = true;
lengthOut += (unsigned)strlen(map[index].sub);
}
else
{
lengthOut += 1;
}
pChar++;
}
if (subsitutionRequired)
{
char* newName = (char*) compGetMemA(lengthOut, CMK_DebugOnly);
char* pDest;
pDest = newName;
pChar = nameIn;
while (*pChar != '\0')
{
match = false;
index = 0;
while (map[index].ch != 0)
{
if (*pChar == map[index].ch)
{
match = true;
break;
}
index++;
}
if (match)
{
strcpy(pDest, map[index].sub);
pDest += strlen(map[index].sub);
}
else
{
*pDest++ = *pChar;
}
pChar++;
}
*pDest++ = '\0';
nameOut = (const char*) newName;
}
return nameOut;
}
static void fprintfDouble(FILE* fgxFile, double value)
{
assert(value >= 0.0);
if ((value >= 0.010) || (value == 0.0))
{
fprintf(fgxFile, "\"%7.3f\"", value);
}
else if (value >= 0.00010)
{
fprintf(fgxFile, "\"%7.5f\"", value);
}
else
{
fprintf(fgxFile, "\"%7E\"", value);
}
}
/*****************************************************************************/
FILE* Compiler::fgOpenXmlFlowGraphFile(bool* wbDontClose)
{
FILE* fgxFile;
LPCWSTR pattern = NULL;
LPCWSTR filename = NULL;
LPCWSTR pathname = NULL;
const char* escapedString;
bool createDuplicateFgxFiles = true;
#ifdef DEBUG
if (opts.eeFlags & CORJIT_FLG_PREJIT)
{
static ConfigString sNgenDumpFg;
pattern = sNgenDumpFg.val(CLRConfig::INTERNAL_NgenDumpFg);
static ConfigString sNgenDumpFgFile;
filename = sNgenDumpFgFile.val(CLRConfig::INTERNAL_NgenDumpFgFile);
static ConfigString sNgenDumpFgDir;
pathname = sNgenDumpFgDir.val(CLRConfig::INTERNAL_NgenDumpFgDir);
}
else
{
static ConfigString sJitDumpFg;
pattern = sJitDumpFg.val(CLRConfig::INTERNAL_JitDumpFg);
static ConfigString sJitDumpFgFile;
filename = sJitDumpFgFile.val(CLRConfig::INTERNAL_JitDumpFgFile);
static ConfigString sJitDumpFgDir;
pathname = sJitDumpFgDir.val(CLRConfig::INTERNAL_JitDumpFgDir);
}
#endif // DEBUG
if (fgBBcount <= 1)
return NULL;
if (pattern == NULL)
return NULL;
if (wcslen(pattern) == 0)
return NULL;
if (*pattern != W('*'))
{
bool hasColon = (wcschr(pattern, W(':')) != 0);
if (hasColon)
{
const char* className = info.compClassName;
if (*pattern == W('*'))
{
pattern++;
}
else
{
while ((*pattern != W(':')) && (*pattern != W('*')))
{
if (*pattern != *className)
return NULL;
pattern++;
className++;
}
if (*pattern == W('*'))
{
pattern++;
}
else
{
if (*className != 0)
return NULL;
}
}
if (*pattern != W(':'))
return NULL;
pattern++;
}
const char* methodName = info.compMethodName;
if (*pattern == W('*'))
{
pattern++;
}
else
{
while ((*pattern != 0) && (*pattern != W('*')))
{
if (*pattern != *methodName)
return NULL;
pattern++;
methodName++;
}
if (*pattern == W('*'))
{
pattern++;
}
else
{
if (*methodName != 0)
return NULL;
}
}
if (*pattern != 0)
return NULL;
}
if (filename == NULL)
{
filename = W("default");
}
if (wcscmp(filename, W("profiled")) == 0)
{
if ((fgFirstBB->bbFlags & BBF_PROF_WEIGHT) != 0)
{
createDuplicateFgxFiles = true;
goto ONE_FILE_PER_METHOD;
}
else
{
return NULL;
}
}
if (wcscmp(filename, W("hot")) == 0)
{
if (info.compMethodInfo->regionKind == CORINFO_REGION_HOT)
{
createDuplicateFgxFiles = true;
goto ONE_FILE_PER_METHOD;
}
else
{
return NULL;
}
}
else if (wcscmp(filename, W("cold")) == 0)
{
if (info.compMethodInfo->regionKind == CORINFO_REGION_COLD)
{
createDuplicateFgxFiles = true;
goto ONE_FILE_PER_METHOD;
}
else
{
return NULL;
}
}
else if (wcscmp(filename, W("jit")) == 0)
{
if (info.compMethodInfo->regionKind == CORINFO_REGION_JIT)
{
createDuplicateFgxFiles = true;
goto ONE_FILE_PER_METHOD;
}
else
{
return NULL;
}
}
else if (wcscmp(filename, W("all")) == 0)
{
createDuplicateFgxFiles = true;
ONE_FILE_PER_METHOD:;
escapedString = fgProcessEscapes(info.compFullName, s_EscapeFileMapping);
size_t wCharCount = strlen(escapedString) + strlen("~999") + strlen(".fgx") + 1;
if (pathname != NULL)
{
wCharCount += wcslen(pathname) + 1;
}
filename = (LPCWSTR) alloca(wCharCount * sizeof(WCHAR));
if (pathname != NULL)
{
swprintf_s((LPWSTR)filename, wCharCount, W("%s\\%S.fgx"), pathname, escapedString);
}
else
{
swprintf_s((LPWSTR)filename, wCharCount, W("%S.fgx"), escapedString);
}
fgxFile = _wfopen(filename, W("r")); // Check if this file already exists
if (fgxFile != NULL)
{
// For Generic methods we will have both hot and cold versions
if (createDuplicateFgxFiles == false)
{
fclose(fgxFile);
return NULL;
}
// Yes, this filename already exists, so create a different one by appending ~2, ~3, etc...
for (int i = 2; i < 1000; i++)
{
fclose(fgxFile);
if (pathname != NULL)
{
swprintf_s((LPWSTR)filename, wCharCount, W("%s\\%S~%d.fgx"), pathname, escapedString, i);
}
else
{
swprintf_s((LPWSTR)filename, wCharCount, W("%S~%d.fgx"), escapedString, i);
}
fgxFile = _wfopen(filename, W("r")); // Check if this file exists
if (fgxFile == NULL)
break;
}
// If we have already created 1000 files with this name then just fail
if (fgxFile != NULL)
{
fclose(fgxFile);
return NULL;
}
}
fgxFile = _wfopen(filename, W("a+"));
*wbDontClose = false;
}
else if (wcscmp(filename, W("stdout")) == 0)
{
fgxFile = stdout;
*wbDontClose = true;
}
else if (wcscmp(filename, W("stderr")) == 0)
{
fgxFile = stderr;
*wbDontClose = true;
}
else
{
LPCWSTR origFilename = filename;
size_t wCharCount = wcslen(origFilename) + strlen(".fgx") + 1;
if (pathname != NULL)
{
wCharCount += wcslen(pathname) + 1;
}
filename = (LPCWSTR) alloca(wCharCount * sizeof(WCHAR));
if (pathname != NULL)
{
swprintf_s((LPWSTR)filename, wCharCount, W("%s\\%s.fgx"), pathname, origFilename);
}
else
{
swprintf_s((LPWSTR)filename, wCharCount, W("%s.fgx"), origFilename);
}
fgxFile = _wfopen(filename, W("a+"));
*wbDontClose = false;
}
return fgxFile;
}
/*****************************************************************************/
bool Compiler::fgDumpXmlFlowGraph()
{
bool result = false;
bool dontClose = false;
FILE* fgxFile = fgOpenXmlFlowGraphFile(&dontClose);
if (fgxFile == NULL)
{
return false;
}
bool validWeights = fgHaveValidEdgeWeights;
unsigned calledCount = max(fgCalledWeight, BB_UNITY_WEIGHT) / BB_UNITY_WEIGHT;
double weightDivisor = (double) (calledCount * BB_UNITY_WEIGHT);
const char* escapedString;
const char* regionString = "NONE";
if (info.compMethodInfo->regionKind == CORINFO_REGION_HOT)
{
regionString="HOT";
}
else if (info.compMethodInfo->regionKind == CORINFO_REGION_COLD)
{
regionString="COLD";
}
else if (info.compMethodInfo->regionKind == CORINFO_REGION_JIT)
{
regionString="JIT";
}
fprintf(fgxFile, "<method");
escapedString = fgProcessEscapes(info.compFullName, s_EscapeXmlMapping);
fprintf(fgxFile, "\n name=\"%s\"", escapedString);
escapedString = fgProcessEscapes(info.compClassName, s_EscapeXmlMapping);
fprintf(fgxFile, "\n className=\"%s\"", escapedString);
escapedString = fgProcessEscapes(info.compMethodName, s_EscapeXmlMapping);
fprintf(fgxFile, "\n methodName=\"%s\"", escapedString);
fprintf(fgxFile, "\n ngenRegion=\"%s\"", regionString);
fprintf(fgxFile, "\n bytesOfIL=\"%d\"", info.compILCodeSize);
fprintf(fgxFile, "\n localVarCount=\"%d\"", lvaCount);
if (fgHaveProfileData())
{
fprintf(fgxFile, "\n calledCount=\"%d\"", calledCount);
fprintf(fgxFile, "\n profileData=\"true\"");
}
if (compHndBBtabCount > 0)
{
fprintf(fgxFile, "\n hasEHRegions=\"true\"");
}
if (fgHasLoops)
{
fprintf(fgxFile, "\n hasLoops=\"true\"");
}
if (validWeights)
{
fprintf(fgxFile, "\n validEdgeWeights=\"true\"");
if (!fgSlopUsedInEdgeWeights && !fgRangeUsedInEdgeWeights)
{
fprintf(fgxFile, "\n exactEdgeWeights=\"true\"");
}
}
if (fgFirstColdBlock != NULL)
{
fprintf(fgxFile, "\n firstColdBlock=\"%d\"", fgFirstColdBlock->bbNum);
}
fprintf(fgxFile, ">");
fprintf(fgxFile, "\n <blocks");
fprintf(fgxFile, "\n blockCount=\"%d\"", fgBBcount);
fprintf(fgxFile, ">");
static const char* kindImage[] = { "EHFINALLYRET", "EHFILTERRET", "EHCATCHRET",
"THROW", "RETURN", "NONE", "ALWAYS", "LEAVE",
"CALLFINALLY", "COND", "SWITCH" };
BasicBlock* block;
unsigned blockOrdinal;
for (block = fgFirstBB , blockOrdinal = 1;
block != NULL;
block = block->bbNext, blockOrdinal++)
{
fprintf(fgxFile,"\n <block");
fprintf(fgxFile,"\n id=\"%d\"", block->bbNum);
fprintf(fgxFile,"\n ordinal=\"%d\"", blockOrdinal);
fprintf(fgxFile,"\n jumpKind=\"%s\"", kindImage[block->bbJumpKind]);
if (block->hasTryIndex())
{
fprintf(fgxFile,"\n inTry=\"%s\"", "true");
}
if (block->hasHndIndex())
{
fprintf(fgxFile,"\n inHandler=\"%s\"", "true");
}
if (((fgFirstBB->bbFlags & BBF_PROF_WEIGHT) != 0) &&
((block->bbFlags & BBF_COLD) == 0) )
{
fprintf(fgxFile,"\n hot=\"true\"");
}
if (block->bbFlags & (BBF_HAS_NEWOBJ | BBF_HAS_NEWARRAY))
{
fprintf(fgxFile,"\n callsNew=\"true\"");
}
if (block->bbFlags & BBF_LOOP_HEAD)
{
fprintf(fgxFile,"\n loopHead=\"true\"");
}
fprintf(fgxFile,"\n weight=");
fprintfDouble(fgxFile, ((double) block->bbWeight) / weightDivisor);
fprintf(fgxFile,"\n codeEstimate=\"%d\"", fgGetCodeEstimate(block));
fprintf(fgxFile,"\n startOffset=\"%d\"", block->bbCodeOffs);
fprintf(fgxFile,"\n endOffset=\"%d\"", block->bbCodeOffsEnd);
fprintf(fgxFile, ">");
fprintf(fgxFile,"\n </block>");
}
fprintf(fgxFile, "\n </blocks>");
unsigned edgeNum = 1;
fprintf(fgxFile, "\n <edges");
fprintf(fgxFile, "\n edgeCount=\"%d\"", fgEdgeCount);
fprintf(fgxFile, ">");
BasicBlock* bTarget;
for (bTarget = fgFirstBB; bTarget != NULL; bTarget = bTarget->bbNext)
{
double targetWeightDivisor;
if (bTarget->bbWeight == BB_ZERO_WEIGHT)
{
targetWeightDivisor = 1.0;
}
else
{
targetWeightDivisor = (double) bTarget->bbWeight;
}
flowList* edge;
for (edge = bTarget->bbPreds; edge != NULL; edge = edge->flNext, edgeNum++)
{
BasicBlock* bSource = edge->flBlock;
double sourceWeightDivisor;
if (bSource->bbWeight == BB_ZERO_WEIGHT)
{
sourceWeightDivisor = 1.0;
}
else
{
sourceWeightDivisor = (double) bSource->bbWeight;
}
fprintf(fgxFile,"\n <edge");
fprintf(fgxFile,"\n id=\"%d\"", edgeNum);
fprintf(fgxFile,"\n source=\"%d\"", bSource->bbNum);
fprintf(fgxFile,"\n target=\"%d\"", bTarget->bbNum);
if (bSource->bbJumpKind == BBJ_SWITCH)
{
if (edge->flDupCount >= 2)
{
fprintf(fgxFile,"\n switchCases=\"%d\"", edge->flDupCount);
}
if (bSource->bbJumpSwt->getDefault() == bTarget)
{
fprintf(fgxFile,"\n switchDefault=\"true\"");
}
}
if (validWeights)
{
unsigned edgeWeight = (edge->flEdgeWeightMin + edge->flEdgeWeightMax) / 2;
fprintf(fgxFile,"\n weight=");
fprintfDouble(fgxFile, ((double) edgeWeight) / weightDivisor);
if (edge->flEdgeWeightMin != edge->flEdgeWeightMax)
{
fprintf(fgxFile,"\n minWeight=");
fprintfDouble(fgxFile, ((double) edge->flEdgeWeightMin) / weightDivisor);
fprintf(fgxFile,"\n maxWeight=");
fprintfDouble(fgxFile, ((double) edge->flEdgeWeightMax) / weightDivisor);
}
if (edgeWeight > 0)
{
if (edgeWeight < bSource->bbWeight)
{
fprintf(fgxFile,"\n out=");
fprintfDouble(fgxFile, ((double) edgeWeight) / sourceWeightDivisor );
}
if (edgeWeight < bTarget->bbWeight)
{
fprintf(fgxFile,"\n in=");
fprintfDouble(fgxFile, ((double) edgeWeight) / targetWeightDivisor);
}
}
}
fprintf(fgxFile, ">");
fprintf(fgxFile,"\n </edge>");
}
}
fprintf(fgxFile, "\n </edges>");
fprintf(fgxFile, "\n</method>\n");
if (dontClose)
{
// fgxFile is stdout or stderr
fprintf(fgxFile, "\n");
}
else
{
fclose(fgxFile);
}
return result;
}
#endif // XML_FLOWGRAPHS
/*****************************************************************************/
#ifdef DEBUG
void Compiler::fgDispReach()
{
printf("------------------------------------------------\n");
printf("BBnum Reachable by \n");
printf("------------------------------------------------\n");
for (BasicBlock* block = fgFirstBB; block != nullptr; block = block->bbNext)
{
printf("BB%02u : ", block->bbNum);
BLOCKSET_ITER_INIT(this, iter, block->bbReach, bbNum);
while (iter.NextElem(this, &bbNum))
{
printf("BB%02u ", bbNum);
}
printf("\n");
}
}
void Compiler::fgDispDoms()
{
// Don't bother printing this when we have a large number of BasicBlocks in the method
if (fgBBcount > 256)
{
return;
}
printf("------------------------------------------------\n");
printf("BBnum Dominated by\n");
printf("------------------------------------------------\n");
for (unsigned i = 1; i <= fgBBNumMax; ++i)
{
BasicBlock* current = fgBBInvPostOrder[i];
printf("BB%02u: ", current->bbNum);
while (current != current->bbIDom)
{
printf("BB%02u ", current->bbNum);
current = current->bbIDom;
}
printf("\n");
}
}
/*****************************************************************************/
void Compiler::fgTableDispBasicBlock(BasicBlock* block,
int ibcColWidth /* = 0 */)
{
unsigned flags = block->bbFlags;
unsigned bbNumMax = compIsForInlining() ? impInlineInfo->InlinerCompiler->fgBBNumMax : fgBBNumMax;
int maxBlockNumWidth = CountDigits(bbNumMax);
maxBlockNumWidth = max(maxBlockNumWidth, 2);
int blockNumWidth = CountDigits(block->bbNum);
blockNumWidth = max(blockNumWidth, 2);
int blockNumPadding = maxBlockNumWidth - blockNumWidth;
printf("BB%02u%*s [%08p] %2u",
block->bbNum,
blockNumPadding, "",
dspPtr(block),
block->bbRefs);
//
// Display EH 'try' region index
//
if (block->hasTryIndex())
{
printf(" %2u", block->getTryIndex());
}
else
{
printf(" ");
}
//
// Display EH handler region index
//
if (block->hasHndIndex())
{
printf(" %2u", block->getHndIndex());
}
else
{
printf(" ");
}
printf(" ");
//
// Display block predecessor list
//
unsigned charCnt;
if (fgCheapPredsValid)
{
charCnt = block->dspCheapPreds();
}
else
{
charCnt = block->dspPreds();
}
if (charCnt < 19)
{
printf("%*s", 19 - charCnt, "");
}
printf(" ");
//
// Display block weight
//
if (block->isMaxBBWeight())
{
printf(" MAX ");
}
else
{
printf("%6s", refCntWtd2str(block->getBBWeight(this)));
}
//
// Display optional IBC weight column.
// Note that iColWidth includes one character for a leading space, if there is an IBC column.
//
if (ibcColWidth > 0)
{
if (block->bbFlags & BBF_PROF_WEIGHT)
{
printf("%*u", ibcColWidth, block->bbWeight);
}
else
{
// No IBC data. Just print spaces to align the column.
printf("%*s", ibcColWidth, "");
}
}
printf(" ");
//
// Display block IL range
//
block->dspBlockILRange();
//
// Display block branch target
//
if (flags & BBF_REMOVED)
{
printf( "[removed] ");
}
else
{
switch (block->bbJumpKind)
{
case BBJ_COND:
printf("-> BB%02u%*s ( cond )", block->bbJumpDest->bbNum, maxBlockNumWidth - max(CountDigits(block->bbJumpDest->bbNum), 2), "");
break;
case BBJ_CALLFINALLY:
printf("-> BB%02u%*s (callf )", block->bbJumpDest->bbNum, maxBlockNumWidth - max(CountDigits(block->bbJumpDest->bbNum), 2), "");
break;
case BBJ_ALWAYS:
if (flags & BBF_KEEP_BBJ_ALWAYS)
{
printf("-> BB%02u%*s (ALWAYS)", block->bbJumpDest->bbNum, maxBlockNumWidth - max(CountDigits(block->bbJumpDest->bbNum), 2), "");
}
else
{
printf("-> BB%02u%*s (always)", block->bbJumpDest->bbNum, maxBlockNumWidth - max(CountDigits(block->bbJumpDest->bbNum), 2), "");
}
break;
case BBJ_LEAVE:
printf("-> BB%02u%*s (leave )", block->bbJumpDest->bbNum, maxBlockNumWidth - max(CountDigits(block->bbJumpDest->bbNum), 2), "");
break;
case BBJ_EHFINALLYRET:
printf( "%*s (finret)", maxBlockNumWidth - 2, "");
break;
case BBJ_EHFILTERRET:
printf( "%*s (fltret)", maxBlockNumWidth - 2, "");
break;
case BBJ_EHCATCHRET:
printf("-> BB%02u%*s ( cret )", block->bbJumpDest->bbNum, maxBlockNumWidth - max(CountDigits(block->bbJumpDest->bbNum), 2), "");
break;
case BBJ_THROW:
printf( "%*s (throw )", maxBlockNumWidth - 2, "");
break;
case BBJ_RETURN:
printf( "%*s (return)", maxBlockNumWidth - 2, "");
break;
default:
printf( "%*s ", maxBlockNumWidth - 2, "");
break;
case BBJ_SWITCH:
printf("->");
unsigned jumpCnt;
jumpCnt = block->bbJumpSwt->bbsCount;
BasicBlock** jumpTab;
jumpTab = block->bbJumpSwt->bbsDstTab;
int switchWidth;
switchWidth = 0;
do
{
printf("%cBB%02u",
(jumpTab == block->bbJumpSwt->bbsDstTab) ? ' ' : ',',
(*jumpTab)->bbNum);
switchWidth += 1 /* space/comma */ + 2 /* BB */ + max(CountDigits((*jumpTab)->bbNum), 2);
}
while (++jumpTab, --jumpCnt);
if (switchWidth < 7)
{
printf("%*s", 8 - switchWidth, "");
}
printf(" (switch)");
break;
}
}
printf(" ");
//
// Display block EH region and type, including nesting indicator
//
if (block->hasTryIndex())
{
printf("T%d ", block->getTryIndex());
}
else
{
printf(" ");
}
if (block->hasHndIndex())
{
printf("H%d ", block->getHndIndex());
}
else
{
printf(" ");
}
if (flags & BBF_FUNCLET_BEG)
{
printf("F ");
}
else
{
printf(" ");
}
int cnt = 0;
switch (block->bbCatchTyp)
{
case BBCT_NONE: break;
case BBCT_FAULT: printf("fault "); cnt += 6; break;
case BBCT_FINALLY: printf("finally "); cnt += 8; break;
case BBCT_FILTER: printf("filter "); cnt += 7; break;
case BBCT_FILTER_HANDLER: printf("filtHnd "); cnt += 8; break;
default: printf("catch "); cnt += 6; break;
}
if (block->bbCatchTyp != BBCT_NONE)
{
cnt += 2;
printf("{ ");
/* brace matching editor workaround to compensate for the preceding line: } */
}
if (flags & BBF_TRY_BEG)
{
// Output a brace for every try region that this block opens
EHblkDsc* HBtab;
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
if (HBtab->ebdTryBeg == block)
{
cnt += 6;
printf("try { ");
/* brace matching editor workaround to compensate for the preceding line: } */
}
}
}
EHblkDsc* HBtab;
EHblkDsc* HBtabEnd;
for (HBtab = compHndBBtab, HBtabEnd = compHndBBtab + compHndBBtabCount;
HBtab < HBtabEnd;
HBtab++)
{
if (HBtab->ebdTryLast == block)
{
cnt += 2;
/* brace matching editor workaround to compensate for the following line: { */
printf("} ");
}
if (HBtab->ebdHndLast == block)
{
cnt += 2;
/* brace matching editor workaround to compensate for the following line: { */
printf("} ");
}
if (HBtab->HasFilter() && block->bbNext == HBtab->ebdHndBeg)
{
cnt += 2;
/* brace matching editor workaround to compensate for the following line: { */
printf("} ");
}
}
while (cnt < 12)
{
cnt++;
printf(" ");
}
//
// Display block flags
//
block->dspFlags();
printf("\n");
}
/****************************************************************************
Dump blocks from firstBlock to lastBlock.
*/
void Compiler::fgDispBasicBlocks(BasicBlock* firstBlock,
BasicBlock* lastBlock,
bool dumpTrees)
{
BasicBlock* block;
int padWidth = 0;
#ifdef _TARGET_AMD64_
padWidth = 8;
#endif // _TARGET_AMD64_
// If any block has IBC data, we add an "IBC weight" column just before the 'IL range' column. This column is as wide as necessary to accommodate
// all the various IBC weights. It's at least 4 characters wide, to accommodate the "IBC" title and leading space.
int ibcColWidth = 0;
for (block = firstBlock; block != nullptr; block = block->bbNext)
{
if (block->bbFlags & BBF_PROF_WEIGHT)
{
int thisIbcWidth = CountDigits(block->bbWeight);
ibcColWidth = max(ibcColWidth, thisIbcWidth);
}
if (block == lastBlock)
break;
}
if (ibcColWidth > 0)
{
ibcColWidth = max(ibcColWidth, 3) + 1; // + 1 for the leading space
}
unsigned bbNumMax = compIsForInlining() ? impInlineInfo->InlinerCompiler->fgBBNumMax : fgBBNumMax;
int maxBlockNumWidth = CountDigits(bbNumMax);
maxBlockNumWidth = max(maxBlockNumWidth, 2);
padWidth += maxBlockNumWidth - 2; // Account for functions with a large number of blocks.
printf("\n");
printf("------%*s------------------------------------%*s-----------------------%*s----------------------------------------\n",
padWidth, "------------",
ibcColWidth, "------------",
maxBlockNumWidth, "----");
printf("BBnum %*sdescAddr ref try hnd %s weight %*s%s [IL range] [jump]%*s [EH region] [flags]\n",
padWidth, "",
fgCheapPredsValid ? "cheap preds" :
(fgComputePredsDone ? "preds "
: " "),
((ibcColWidth > 0) ? ibcColWidth - 3 : 0), "", // Subtract 3 for the width of "IBC", printed next.
((ibcColWidth > 0) ? "IBC"
: ""),
maxBlockNumWidth, ""
);
printf("------%*s------------------------------------%*s-----------------------%*s----------------------------------------\n",
padWidth, "------------",
ibcColWidth, "------------",
maxBlockNumWidth, "----");
for (block = firstBlock;
block;
block = block->bbNext)
{
// First, do some checking on the bbPrev links
if (block->bbPrev)
{
if (block->bbPrev->bbNext != block)
{
printf("bad prev link\n");
}
}
else if (block != fgFirstBB)
{
printf("bad prev link!\n");
}
if (block == fgFirstColdBlock)
{
printf("~~~~~~%*s~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%*s~~~~~~~~~~~~~~~~~~~~~~~%*s~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n",
padWidth, "~~~~~~~~~~~~",
ibcColWidth, "~~~~~~~~~~~~",
maxBlockNumWidth, "~~~~");
}
#if FEATURE_EH_FUNCLETS
if (block == fgFirstFuncletBB)
{
printf("++++++%*s++++++++++++++++++++++++++++++++++++%*s+++++++++++++++++++++++%*s++++++++++++++++++++++++++++++++++++++++ funclets follow\n",
padWidth, "++++++++++++",
ibcColWidth, "++++++++++++",
maxBlockNumWidth, "++++");
}
#endif // FEATURE_EH_FUNCLETS
fgTableDispBasicBlock(block, ibcColWidth);
if (block == lastBlock)
break;
}
printf("------%*s------------------------------------%*s-----------------------%*s----------------------------------------\n",
padWidth, "------------",
ibcColWidth, "------------",
maxBlockNumWidth, "----");
if (dumpTrees)
{
fgDumpTrees(firstBlock, lastBlock);
}
}
/*****************************************************************************/
void Compiler::fgDispBasicBlocks(bool dumpTrees)
{
fgDispBasicBlocks(fgFirstBB, NULL, dumpTrees);
}
/*****************************************************************************/
// Increment the stmtNum and dump the tree using gtDispTree
//
void Compiler::fgDumpStmtTree(GenTreePtr stmt, unsigned blkNum)
{
compCurStmtNum++; // Increment the current stmtNum
printf("\n***** BB%02u, stmt %d (%s)\n", blkNum, compCurStmtNum,
stmt->gtFlags & GTF_STMT_TOP_LEVEL ? "top level" : "embedded");
if (fgOrder == FGOrderLinear || opts.compDbgInfo)
{
gtDispTree(stmt);
}
else
{
gtDispTree(stmt->gtStmt.gtStmtExpr);
}
}
/*****************************************************************************/
// Walk the BasicBlock list calling fgDumpTree once per Stmt
//
void Compiler::fgDumpTrees(BasicBlock* firstBlock,
BasicBlock* lastBlock)
{
compCurStmtNum = 0; // Reset the current stmtNum
/* Walk the basic blocks */
// Note that typically we have already called fgDispBasicBlocks()
// so we don't need to print the preds and succs again here
//
for (BasicBlock* block = firstBlock; block; block = block->bbNext)
{
printf("\n------------ ");
block->dspBlockHeader(this);
for (GenTreeStmt* stmt = block->firstStmt(); stmt; stmt = stmt->gtNextStmt)
{
fgDumpStmtTree(stmt, block->bbNum);
if (stmt == block->bbTreeList)
{
block->bbStmtNum = compCurStmtNum; // Set the block->bbStmtNum
}
}
if (block == lastBlock)
break;
}
printf("\n-------------------------------------------------------------------------------------------------------------------\n");
}
/*****************************************************************************
* Try to create as many candidates for GTF_MUL_64RSLT as possible.
* We convert 'intOp1*intOp2' into 'int(long(nop(intOp1))*long(intOp2))'.
*/
/* static */
Compiler::fgWalkResult Compiler::fgStress64RsltMulCB(GenTreePtr* pTree, fgWalkData* data)
{
GenTreePtr tree = *pTree;
if (tree->gtOper != GT_MUL || tree->gtType != TYP_INT || (tree->gtOverflow()))
return WALK_CONTINUE;
GenTreePtr op1 = tree->gtOp.gtOp1;
GenTreePtr op2 = tree->gtOp.gtOp2;
Compiler* pComp = data->compiler;
op1 = pComp->gtNewCastNode(TYP_LONG, op1, TYP_LONG);
op2 = pComp->gtNewCastNode(TYP_LONG, op2, TYP_LONG);
GenTreePtr newMulNode = pComp->gtNewLargeOperNode(GT_MUL, TYP_LONG, op1, op2);
newMulNode = pComp->gtNewOperNode(GT_NOP, TYP_LONG, newMulNode); // To ensure optNarrowTree() doesn't fold back to the original tree
tree->ChangeOper(GT_CAST);
tree->gtCast.CastOp() = newMulNode;
tree->CastToType() = TYP_INT;
return WALK_SKIP_SUBTREES;
}
void Compiler::fgStress64RsltMul()
{
if (!compStressCompile(STRESS_64RSLT_MUL, 20))
return;
fgWalkAllTreesPre(fgStress64RsltMulCB, (void*)this);
}
// This variable is used to generate "traversal labels": one-time constants with which
// we label basic blocks that are members of the basic block list, in order to have a
// fast, high-probability test for membership in that list. Type is "volatile" because
// it's incremented with an atomic operation, which wants a volatile type; "long" so that
// wrap-around to 0 (which I think has the highest probability of accidental collision) is
// postponed a *long* time.
static volatile int bbTraverseLabel = 1;
/*****************************************************************************
*
* A DEBUG routine to check the consistency of the flowgraph,
* i.e. bbNum, bbRefs, bbPreds have to be up to date.
*
*****************************************************************************/
void Compiler::fgDebugCheckBBlist(bool checkBBNum /* = false */,
bool checkBBRefs /* = true */)
{
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgDebugCheckBBlist\n");
}
#endif // DEBUG
fgDebugCheckBlockLinks();
if (fgBBcount > 10000 && expensiveDebugCheckLevel < 1)
{
// The basic block checks are too expensive if there are too many blocks,
// so give up unless we've been told to try hard.
return;
}
DWORD startTickCount = GetTickCount();
BasicBlock* block;
BasicBlock* prevBlock;
BasicBlock* blockPred;
flowList* pred;
unsigned blockRefs;
#if FEATURE_EH_FUNCLETS
bool reachedFirstFunclet = false;
if (fgFuncletsCreated)
{
//
// Make sure that fgFirstFuncletBB is accurate.
// It should be the first basic block in a handler region.
//
if (fgFirstFuncletBB != nullptr)
{
assert(fgFirstFuncletBB->hasHndIndex() == true);
assert(fgFirstFuncletBB->bbFlags & BBF_FUNCLET_BEG);
}
}
#endif // FEATURE_EH_FUNCLETS
/* Check bbNum, bbRefs and bbPreds */
// First, pick a traversal stamp, and label all the blocks with it.
unsigned curTraversalStamp = unsigned(InterlockedIncrement((LONG*)&bbTraverseLabel));
for (block = fgFirstBB; block; block = block->bbNext)
{
block->bbTraversalStamp = curTraversalStamp;
}
for (prevBlock = nullptr, block = fgFirstBB;
block;
prevBlock = block, block = block->bbNext)
{
blockRefs = 0;
/* First basic block has countOfInEdges() >= 1 */
if (block == fgFirstBB)
{
noway_assert(block->countOfInEdges() >= 1);
blockRefs = 1;
}
if (checkBBNum)
{
// Check that bbNum is sequential
noway_assert(block->bbNext == NULL || (block->bbNum + 1 == block->bbNext->bbNum));
}
// If the block is a BBJ_COND, a BBJ_SWITCH or a
// lowered GT_SWITCH_TABLE node then make sure it
// ends with a GT_JTRUE or a GT_SWITCH
if (block->bbJumpKind == BBJ_COND)
{
noway_assert(block->lastStmt()->gtNext == NULL &&
block->lastTopLevelStmt()->gtStmtExpr->gtOper == GT_JTRUE);
}
else if (block->bbJumpKind == BBJ_SWITCH)
{
#ifndef LEGACY_BACKEND
noway_assert(block->lastStmt()->gtNext == NULL &&
(block->lastTopLevelStmt()->gtStmtExpr->gtOper == GT_SWITCH ||
block->lastTopLevelStmt()->gtStmtExpr->gtOper == GT_SWITCH_TABLE));
#else // LEGACY_BACKEND
noway_assert(block->lastStmt()->gtNext == NULL &&
block->lastTopLevelStmt()->gtStmtExpr->gtOper == GT_SWITCH);
#endif // LEGACY_BACKEND
}
else if (!( block->bbJumpKind == BBJ_ALWAYS
|| block->bbJumpKind == BBJ_RETURN))
{
//this block cannot have a poll
noway_assert(!(block->bbFlags & BBF_NEEDS_GCPOLL));
}
if (block->bbCatchTyp == BBCT_FILTER)
{
if (!fgCheapPredsValid) // Don't check cheap preds
{
// A filter has no predecessors
noway_assert(block->bbPreds == NULL);
}
}
#if FEATURE_EH_FUNCLETS
if (fgFuncletsCreated)
{
//
// There should be no handler blocks until
// we get to the fgFirstFuncletBB block,
// then every block should be a handler block
//
if (!reachedFirstFunclet)
{
if (block == fgFirstFuncletBB)
{
assert(block->hasHndIndex() == true);
reachedFirstFunclet = true;
}
else
{
assert(block->hasHndIndex() == false);
}
}
else // reachedFirstFunclet
{
assert(block->hasHndIndex() == true);
}
}
#endif // FEATURE_EH_FUNCLETS
// Don't check cheap preds.
for (pred = (fgCheapPredsValid ? nullptr : block->bbPreds); pred != nullptr; blockRefs += pred->flDupCount, pred = pred->flNext)
{
assert(fgComputePredsDone); // If this isn't set, why do we have a preds list?
/* make sure this pred is part of the BB list */
blockPred = pred->flBlock;
noway_assert(blockPred->bbTraversalStamp == curTraversalStamp);
EHblkDsc* ehTryDsc = ehGetBlockTryDsc(block);
if (ehTryDsc != nullptr)
{
// You can jump to the start of a try
if (ehTryDsc->ebdTryBeg == block)
goto CHECK_HND;
// You can jump within the same try region
if (bbInTryRegions(block->getTryIndex(), blockPred))
goto CHECK_HND;
// The catch block can jump back into the middle of the try
if (bbInCatchHandlerRegions(block, blockPred))
goto CHECK_HND;
// The end of a finally region is a BBJ_EHFINALLYRET block (during importing, BBJ_LEAVE) which
// is marked as "returning" to the BBJ_ALWAYS block following the BBJ_CALLFINALLY
// block that does a local call to the finally. This BBJ_ALWAYS is within
// the try region protected by the finally (for x86, ARM), but that's ok.
if (prevBlock->bbJumpKind == BBJ_CALLFINALLY &&
block->bbJumpKind == BBJ_ALWAYS &&
blockPred->bbJumpKind == BBJ_EHFINALLYRET)
goto CHECK_HND;
printf("Jump into the middle of try region: BB%02u branches to BB%02u\n", blockPred->bbNum, block->bbNum);
noway_assert(!"Jump into middle of try region");
}
CHECK_HND:;
EHblkDsc* ehHndDsc = ehGetBlockHndDsc(block);
if (ehHndDsc != nullptr)
{
// You can do a BBJ_EHFINALLYRET or BBJ_EHFILTERRET into a handler region
if ( (blockPred->bbJumpKind == BBJ_EHFINALLYRET)
|| (blockPred->bbJumpKind == BBJ_EHFILTERRET))
goto CHECK_JUMP;
// Our try block can call our finally block
if ((block->bbCatchTyp == BBCT_FINALLY) &&
(blockPred->bbJumpKind == BBJ_CALLFINALLY) &&
ehCallFinallyInCorrectRegion(blockPred, block->getHndIndex()))
{
goto CHECK_JUMP;
}
// You can jump within the same handler region
if (bbInHandlerRegions(block->getHndIndex(), blockPred))
goto CHECK_JUMP;
// A filter can jump to the start of the filter handler
if (ehHndDsc->HasFilter())
goto CHECK_JUMP;
printf("Jump into the middle of handler region: BB%02u branches to BB%02u\n", blockPred->bbNum, block->bbNum);
noway_assert(!"Jump into the middle of handler region");
}
CHECK_JUMP:;
switch (blockPred->bbJumpKind)
{
case BBJ_COND:
noway_assert(blockPred->bbNext == block || blockPred->bbJumpDest == block);
break;
case BBJ_NONE:
noway_assert(blockPred->bbNext == block);
break;
case BBJ_CALLFINALLY:
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
case BBJ_EHFILTERRET:
noway_assert(blockPred->bbJumpDest == block);
break;
case BBJ_EHFINALLYRET:
{
// If the current block is a successor to a BBJ_EHFINALLYRET (return from finally),
// then the lexically previous block should be a call to the same finally.
// Verify all of that.
unsigned hndIndex = blockPred->getHndIndex();
EHblkDsc* ehDsc = ehGetDsc(hndIndex);
BasicBlock* finBeg = ehDsc->ebdHndBeg;
// Because there is no bbPrev, we have to search for the lexically previous
// block. We can shorten the search by only looking in places where it is legal
// to have a call to the finally.
BasicBlock* begBlk;
BasicBlock* endBlk;
ehGetCallFinallyBlockRange(hndIndex, &begBlk, &endBlk);
for (BasicBlock* bcall = begBlk; bcall != endBlk; bcall = bcall->bbNext)
{
if (bcall->bbJumpKind != BBJ_CALLFINALLY || bcall->bbJumpDest != finBeg)
continue;
if (block == bcall->bbNext)
goto PRED_OK;
}
#if FEATURE_EH_FUNCLETS
if (fgFuncletsCreated)
{
// There is no easy way to search just the funclets that were pulled out of
// the corresponding try body, so instead we search all the funclets, and if
// we find a potential 'hit' we check if the funclet we're looking at is
// from the correct try region.
for (BasicBlock* bcall = fgFirstFuncletBB; bcall; bcall = bcall->bbNext)
{
if (bcall->bbJumpKind != BBJ_CALLFINALLY || bcall->bbJumpDest != finBeg)
continue;
if (block != bcall->bbNext)
continue;
if (ehCallFinallyInCorrectRegion(bcall, hndIndex))
goto PRED_OK;
}
}
#endif // FEATURE_EH_FUNCLETS
noway_assert(!"BBJ_EHFINALLYRET predecessor of block that doesn't follow a BBJ_CALLFINALLY!");
}
break;
case BBJ_THROW:
case BBJ_RETURN:
noway_assert(!"THROW and RETURN block cannot be in the predecessor list!");
break;
case BBJ_SWITCH:
unsigned jumpCnt; jumpCnt = blockPred->bbJumpSwt->bbsCount;
BasicBlock** jumpTab; jumpTab = blockPred->bbJumpSwt->bbsDstTab;
do
{
if (block == *jumpTab)
{
goto PRED_OK;
}
}
while (++jumpTab, --jumpCnt);
noway_assert(!"SWITCH in the predecessor list with no jump label to BLOCK!");
break;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
PRED_OK:;
}
/* Check the bbRefs */
noway_assert(!checkBBRefs || block->bbRefs == blockRefs);
/* Check that BBF_HAS_HANDLER is valid bbTryIndex */
if (block->hasTryIndex())
{
noway_assert(block->getTryIndex() < compHndBBtabCount);
}
/* Check if BBF_RUN_RARELY is set that we have bbWeight of zero */
if (block->isRunRarely())
{
noway_assert(block->bbWeight == BB_ZERO_WEIGHT);
}
else
{
noway_assert(block->bbWeight > BB_ZERO_WEIGHT);
}
}
// Make sure the one return BB is not changed.
if (genReturnBB)
{
noway_assert(genReturnBB->bbTreeList);
noway_assert(genReturnBB->bbTreeList->gtOper == GT_STMT);
noway_assert(genReturnBB->bbTreeList->gtType == TYP_VOID);
}
// The general encoder/decoder (currently) only reports "this" as a generics context as a stack location,
// so we mark info.compThisArg as lvAddrTaken to ensure that it is not enregistered. Otherwise, it should
// not be address-taken. This variable determines if the address-taken-ness of "thisArg" is "OK".
bool copiedForGenericsCtxt;
#ifndef JIT32_GCENCODER
copiedForGenericsCtxt = ((info.compMethodInfo->options & CORINFO_GENERICS_CTXT_FROM_THIS) != 0);
#else // JIT32_GCENCODER
copiedForGenericsCtxt = FALSE;
#endif // JIT32_GCENCODER
// This if only in support of the noway_asserts it contains.
if (info.compIsStatic)
{
// For static method, should have never grabbed the temp.
noway_assert(lvaArg0Var == BAD_VAR_NUM);
}
else
{
// For instance method:
assert(info.compThisArg != BAD_VAR_NUM);
bool compThisArgAddrExposedOK = !lvaTable[info.compThisArg].lvAddrExposed;
#ifndef JIT32_GCENCODER
compThisArgAddrExposedOK = compThisArgAddrExposedOK || copiedForGenericsCtxt;
#endif // !JIT32_GCENCODER
noway_assert(compThisArgAddrExposedOK && // should never expose the address of arg 0 or
!lvaTable[info.compThisArg].lvArgWrite && // write to arg 0.
( // In addition,
lvaArg0Var == info.compThisArg || // lvArg0Var should remain 0 if arg0 is not written to or address-exposed.
lvaArg0Var != info.compThisArg &&
(lvaTable[lvaArg0Var].lvAddrExposed || lvaTable[lvaArg0Var].lvArgWrite || copiedForGenericsCtxt)
));
}
}
/*****************************************************************************
*
* A DEBUG routine to check the that the exception flags are correctly set.
*
****************************************************************************/
void Compiler::fgDebugCheckFlags(GenTreePtr tree)
{
noway_assert(tree->gtOper != GT_STMT);
genTreeOps oper = tree->OperGet();
unsigned kind = tree->OperKind();
unsigned treeFlags = tree->gtFlags & GTF_ALL_EFFECT;
unsigned chkFlags = 0;
/* Is this a leaf node? */
if (kind & GTK_LEAF)
{
switch (oper)
{
case GT_CLS_VAR:
chkFlags |= GTF_GLOB_REF;
break;
case GT_CATCH_ARG:
chkFlags |= GTF_ORDER_SIDEEFF;
break;
default:
break;
}
}
/* Is it a 'simple' unary/binary operator? */
else if (kind & GTK_SMPOP)
{
GenTreePtr op1 = tree->gtOp.gtOp1;
GenTreePtr op2 = tree->gtGetOp2();
// During GS work, we make shadow copies for params.
// In gsParamsToShadows(), we create a shadow var of TYP_INT for every small type param.
// Then in gsReplaceShadowParams(), we change the gtLclNum to the shadow var.
// We also change the types of the local var tree and the assignment tree to TYP_INT if necessary.
// However, since we don't morph the tree at this late stage. Manually propagating
// TYP_INT up to the GT_ASG tree is only correct if we don't need to propagate the TYP_INT back up.
// The following checks will ensure this.
// Is the left child of "tree" a GT_ASG?,
if (op1 && op1->gtOper == GT_ASG)
{
assert(tree->gtType == TYP_VOID || // If parent is a TYP_VOID, we don't no need to propagate TYP_INT up. We are fine.
tree->gtOper == GT_COMMA); // (or) If GT_ASG is the left child of a GT_COMMA, the type of the GT_COMMA node will
} // be determined by its right child. So we don't need to propagate TYP_INT up either. We are fine.
// Is the right child of "tree" a GT_ASG?,
if (op2 && op2->gtOper == GT_ASG)
{
assert(tree->gtType == TYP_VOID); // If parent is a TYP_VOID, we don't no need to propagate TYP_INT up. We are fine.
}
switch (oper)
{
case GT_QMARK:
if (op1->OperIsCompare())
{
noway_assert(op1->gtFlags & GTF_DONT_CSE);
}
else
{
noway_assert( (op1->gtOper == GT_CNS_INT) &&
((op1->gtIntCon.gtIconVal == 0) || (op1->gtIntCon.gtIconVal == 1)) );
}
break;
default:
break;
}
/* Recursively check the subtrees */
if (op1) fgDebugCheckFlags(op1);
if (op2) fgDebugCheckFlags(op2);
if (op1) chkFlags |= (op1->gtFlags & GTF_ALL_EFFECT);
if (op2) chkFlags |= (op2->gtFlags & GTF_ALL_EFFECT);
// We reuse the value of GTF_REVERSE_OPS for a GT_IND-specific flag,
// so exempt that (unary) operator.
if (tree->OperGet() != GT_IND && tree->gtFlags & GTF_REVERSE_OPS)
{
/* Must have two operands if GTF_REVERSE is set */
noway_assert(op1 && op2);
/* Make sure that the order of side effects has not been swapped. */
/* However CSE may introduce an assignment after the reverse flag
was set and thus GTF_ASG cannot be considered here. */
/* For a GT_ASG(GT_IND(x), y) we are interested in the side effects of x */
GenTreePtr op1p;
if ((kind & GTK_ASGOP) && (op1->gtOper == GT_IND))
{
op1p = op1->gtOp.gtOp1;
}
else
{
op1p = op1;
}
/* This isn't true any more with the sticky GTF_REVERSE */
/*
// if op1p has side effects, then op2 cannot have side effects
if (op1p->gtFlags & (GTF_SIDE_EFFECT & ~GTF_ASG))
{
if (op2->gtFlags & (GTF_SIDE_EFFECT & ~GTF_ASG))
gtDispTree(tree);
noway_assert(!(op2->gtFlags & (GTF_SIDE_EFFECT & ~GTF_ASG)));
}
*/
}
if (kind & GTK_ASGOP)
{
chkFlags |= GTF_ASG;
}
/* Note that it is OK for treeFlags not to have a GTF_EXCEPT,
AssertionProp's non-Null may have cleared it */
if (tree->OperMayThrow())
{
chkFlags |= (treeFlags & GTF_EXCEPT);
}
if (oper == GT_ADDR &&
(op1->OperIsLocal() ||
op1->gtOper == GT_CLS_VAR ||
(op1->gtOper == GT_IND && op1->gtOp.gtOp1->gtOper == GT_CLS_VAR_ADDR)))
{
/* &aliasedVar doesn't need GTF_GLOB_REF, though alisasedVar does.
Similarly for clsVar */
treeFlags |= GTF_GLOB_REF;
}
}
/* See what kind of a special operator we have here */
else switch (tree->OperGet())
{
case GT_CALL:
GenTreePtr args;
GenTreePtr argx;
GenTreeCall* call;
call = tree->AsCall();
chkFlags |= GTF_CALL;
if ((treeFlags & GTF_EXCEPT) && !(chkFlags & GTF_EXCEPT))
{
switch (eeGetHelperNum(tree->gtCall.gtCallMethHnd))
{
// Is this a helper call that can throw an exception ?
case CORINFO_HELP_LDIV:
case CORINFO_HELP_LMOD:
case CORINFO_HELP_METHOD_ACCESS_CHECK:
case CORINFO_HELP_FIELD_ACCESS_CHECK:
case CORINFO_HELP_CLASS_ACCESS_CHECK:
case CORINFO_HELP_DELEGATE_SECURITY_CHECK:
chkFlags |= GTF_EXCEPT;
break;
default:
break;
}
}
if (call->gtCallObjp)
{
fgDebugCheckFlags(call->gtCallObjp);
chkFlags |= (call->gtCallObjp->gtFlags & GTF_SIDE_EFFECT);
if (call->gtCallObjp->gtFlags & GTF_ASG)
{
treeFlags |= GTF_ASG;
}
}
for (args = call->gtCallArgs; args; args = args->gtOp.gtOp2)
{
argx = args->gtOp.gtOp1;
fgDebugCheckFlags(argx);
chkFlags |= (argx->gtFlags & GTF_SIDE_EFFECT);
if (argx->gtFlags & GTF_ASG)
{
treeFlags |= GTF_ASG;
}
}
for (args = call->gtCallLateArgs; args; args = args->gtOp.gtOp2)
{
argx = args->gtOp.gtOp1;
fgDebugCheckFlags(argx);
chkFlags |= (argx->gtFlags & GTF_SIDE_EFFECT);
if (argx->gtFlags & GTF_ASG)
{
treeFlags |= GTF_ASG;
}
}
if ((call->gtCallType == CT_INDIRECT) && (call->gtCallCookie != NULL))
{
fgDebugCheckFlags(call->gtCallCookie);
chkFlags |= (call->gtCallCookie->gtFlags & GTF_SIDE_EFFECT);
}
if (call->gtCallType == CT_INDIRECT)
{
fgDebugCheckFlags(call->gtCallAddr);
chkFlags |= (call->gtCallAddr->gtFlags & GTF_SIDE_EFFECT);
}
if (call->IsUnmanaged() &&
(call->gtCallMoreFlags & GTF_CALL_M_UNMGD_THISCALL))
{
if (call->gtCallArgs->gtOp.gtOp1->OperGet() == GT_NOP)
{
noway_assert(call->gtCallLateArgs->gtOp.gtOp1->TypeGet() == TYP_I_IMPL ||
call->gtCallLateArgs->gtOp.gtOp1->TypeGet() == TYP_BYREF);
}
else
{
noway_assert(call->gtCallArgs->gtOp.gtOp1->TypeGet() == TYP_I_IMPL ||
call->gtCallArgs->gtOp.gtOp1->TypeGet() == TYP_BYREF);
}
}
break;
case GT_ARR_ELEM:
GenTreePtr arrObj;
unsigned dim;
arrObj = tree->gtArrElem.gtArrObj;
fgDebugCheckFlags(arrObj);
chkFlags |= (arrObj->gtFlags & GTF_ALL_EFFECT);
for (dim = 0; dim < tree->gtArrElem.gtArrRank; dim++)
{
fgDebugCheckFlags(tree->gtArrElem.gtArrInds[dim]);
chkFlags |= tree->gtArrElem.gtArrInds[dim]->gtFlags & GTF_ALL_EFFECT;
}
break;
case GT_ARR_OFFSET:
fgDebugCheckFlags(tree->gtArrOffs.gtOffset);
chkFlags |= (tree->gtArrOffs.gtOffset->gtFlags & GTF_ALL_EFFECT);
fgDebugCheckFlags(tree->gtArrOffs.gtIndex);
chkFlags |= (tree->gtArrOffs.gtIndex->gtFlags & GTF_ALL_EFFECT);
fgDebugCheckFlags(tree->gtArrOffs.gtArrObj);
chkFlags |= (tree->gtArrOffs.gtArrObj->gtFlags & GTF_ALL_EFFECT);
break;
default:
break;
}
if (chkFlags & ~treeFlags)
{
// Print the tree so we can see it in the log.
printf("Missing flags on tree [%X]: ", tree);
GenTree::gtDispFlags(chkFlags & ~treeFlags);
printf("\n");
gtDispTree(tree);
noway_assert(!"Missing flags on tree");
// Print the tree again so we can see it right after we hook up the debugger.
printf("Missing flags on tree [%X]: ", tree);
GenTree::gtDispFlags(chkFlags & ~treeFlags);
printf("\n");
gtDispTree(tree);
}
else if (treeFlags & ~chkFlags)
{
#if 0
// TODO-Cleanup:
/* The tree has extra flags set. However, this will happen if we
replace a subtree with something, but don't clear the flags up
the tree. Can't flag this unless we start clearing flags above.
Note: we need this working for GTF_CALL and CSEs, so I'm enabling
it for calls.
*/
if (tree->OperGet() != GT_CALL && (treeFlags & GTF_CALL) && !(chkFlags & GTF_CALL))
{
// Print the tree so we can see it in the log.
printf("Extra GTF_CALL flags on parent tree [%X]: ", tree);
GenTree::gtDispFlags(treeFlags & ~chkFlags);
printf("\n");
gtDispTree(tree);
noway_assert(!"Extra flags on tree");
// Print the tree again so we can see it right after we hook up the debugger.
printf("Extra GTF_CALL flags on parent tree [%X]: ", tree);
GenTree::gtDispFlags(treeFlags & ~chkFlags);
printf("\n");
gtDispTree(tree);
}
#endif // 0
}
}
// DEBUG routine to check correctness of the internal gtNext, gtPrev threading of a statement.
// This threading is only valid when fgStmtListThreaded is true.
// This calls an alternate method for FGOrderLinear.
void Compiler::fgDebugCheckNodeLinks(BasicBlock* block, GenTree* node)
{
GenTreeStmt* stmt = node->AsStmt();
assert(fgStmtListThreaded);
if (fgOrder == FGOrderLinear)
{
fgDebugCheckLinearNodeLinks(block, stmt);
return;
}
noway_assert(stmt->gtStmtList);
// The first node's gtPrev must be nullptr (the gtPrev list is not circular).
// The last node's gtNext must be nullptr (the gtNext list is not circular). This is tested if the loop below terminates.
assert(stmt->gtStmtList->gtPrev == nullptr);
for (GenTreePtr tree = stmt->gtStmtList;
tree != nullptr;
tree = tree->gtNext)
{
if (tree->gtPrev)
{
noway_assert(tree->gtPrev->gtNext == tree);
}
else
{
noway_assert(tree == stmt->gtStmtList);
}
if (tree->gtNext)
{
noway_assert(tree->gtNext->gtPrev == tree);
}
else
{
noway_assert(tree == stmt->gtStmtExpr);
}
/* Cross-check gtPrev,gtNext with gtOp for simple trees */
GenTreePtr expectedPrevTree = NULL;
if (tree->OperIsLeaf())
{
if (tree->gtOper == GT_CATCH_ARG)
{
// The GT_CATCH_ARG should always have GTF_ORDER_SIDEEFF set
noway_assert(tree->gtFlags & GTF_ORDER_SIDEEFF);
// The GT_CATCH_ARG has to be the first thing evaluated
#if JIT_FEATURE_SSA_SKIP_DEFS
noway_assert(stmt == block->FirstNonPhiDef());
#else
noway_assert(stmt == block->bbTreeList);
#endif
noway_assert(stmt->gtStmtList->gtOper == GT_CATCH_ARG);
// The root of the tree should have GTF_ORDER_SIDEEFF set
noway_assert(stmt->gtStmtExpr->gtFlags & GTF_ORDER_SIDEEFF);
}
}
if (tree->OperIsUnary() && tree->gtOp.gtOp1)
{
GenTreePtr lclVarTree;
expectedPrevTree = tree->gtOp.gtOp1;
if ((tree->gtOper == GT_LDOBJ) &&
(tree->gtLdObj.gtFldTreeList != NULL) &&
impIsAddressInLocal(tree->gtOp.gtOp1, &lclVarTree))
{
GenTreePtr* fldTreeList = tree->gtLdObj.gtFldTreeList;
GenTreePtr prev = NULL;
unsigned fieldCount = lvaTable[lclVarTree->gtLclVarCommon.gtLclNum].lvFieldCnt;
for (unsigned i = 0; i < fieldCount; i++)
{
if (fldTreeList[i] != NULL)
{
if (prev != NULL)
{
noway_assert(fldTreeList[i]->gtPrev == prev);
}
prev = fldTreeList[i];
}
}
noway_assert(lclVarTree->gtPrev == prev);
}
}
else if (tree->OperIsBinary() && tree->gtOp.gtOp1)
{
switch (tree->gtOper)
{
case GT_QMARK:
expectedPrevTree = tree->gtOp.gtOp2->AsColon()->ThenNode(); // "then" operand of the GT_COLON (generated second).
break;
case GT_COLON:
expectedPrevTree = tree->AsColon()->ElseNode(); // "else" branch result (generated first).
break;
case GT_INITBLK:
case GT_COPYBLK:
case GT_COPYOBJ:
// the first child is a GT_LIST, where has op1 is the dst and op2 is the src.
// The read has to occur before the write so make sure REVERSE_OPS is set.
assert(tree->gtOp.gtOp1->gtFlags & GTF_REVERSE_OPS);
__fallthrough;
default:
if (tree->gtOp.gtOp2)
{
if (tree->gtFlags & GTF_REVERSE_OPS)
{
expectedPrevTree = tree->gtOp.gtOp1;
}
else
{
expectedPrevTree = tree->gtOp.gtOp2;
}
}
else
{
expectedPrevTree = tree->gtOp.gtOp1;
}
break;
}
}
noway_assert(expectedPrevTree == NULL || // No expectations about the prev node
tree->gtPrev == expectedPrevTree); // The "normal" case
}
}
//------------------------------------------------------------------------
// fgDebugCheckLinearTree: Counts the nodes in a tree by doing a tree traversal,
// and validates that GT_CATCH_ARG causes GTF_ORDER_SIDEEFF to be set on
// itself and its containing statement.
//
// Arguments:
// block - The block containing 'tree'
// stmt - The statement containing 'tree'
// tree - The tree to be checked
// printNodes - In case DebugCheckLinearNodeLinks detects a problem, we re-run
// printing the tree order traversal node by node for debugging purposes.
// Return Value:
// Returns the count of nodes in the tree.
//
// Notes:
// This is called by fgDebugCheckLinearNodeLinks(), which uses the node
// count from the tree walk to validate against the node count from a
// linear traversal.
unsigned Compiler::fgDebugCheckLinearTree(BasicBlock* block,
GenTreePtr stmt,
GenTreePtr tree,
bool printNodes)
{
if (printNodes)
{
DISPNODE(tree);
}
unsigned nodeCount = 1;
if (tree->OperIsLeaf())
{
if (tree->gtOper == GT_CATCH_ARG)
{
// The GT_CATCH_ARG should always have GTF_ORDER_SIDEEFF set
noway_assert(tree->gtFlags & GTF_ORDER_SIDEEFF);
// The GT_CATCH_ARG has to be the first thing evaluated
#if JIT_FEATURE_SSA_SKIP_DEFS
noway_assert(stmt == block->FirstNonPhiDef());
#else
noway_assert(stmt == block->bbTreeList);
#endif
noway_assert(stmt->gtStmt.gtStmtList->gtOper == GT_CATCH_ARG);
// The root of the tree should have GTF_ORDER_SIDEEFF set
noway_assert(stmt->gtStmt.gtStmtExpr->gtFlags & GTF_ORDER_SIDEEFF);
}
}
else
{
// Do per-node checks
// Visit children
unsigned childCount = tree->NumChildren();
for (unsigned i = 0;
i < childCount;
i++)
{
GenTreePtr child = tree->GetChild(i);
nodeCount += fgDebugCheckLinearTree(block, stmt, child, printNodes);
}
}
return nodeCount;
}
//------------------------------------------------------------------------
// fgDebugCheckLinearNodeLinks: DEBUG routine to check correctness of the internal
// gtNext, gtPrev threading of a statement.
//
// Arguments:
// block - The block containing 'topLevelStmt'
// topLevelStmt - The statement to be checked
// printNodes - 'true' if we are to print the nodes while we check them.
//
// Return Value:
// None.
//
// Notes:
// This function is the called by fgDebugCheckNodeLinks when fgOrder == FGOrderLinear,
// and is only valid when fgStmtListThreaded is true and fgOrder == FGOrderLinear.
// It compares the number of nodes encountered in tree-walking 'topLevelStmt' and all
// of its embedded statements, against the number of nodes in a linear traversal.
void Compiler::fgDebugCheckLinearNodeLinks(BasicBlock* block,
GenTreePtr topLevelStmt,
bool printNodes)
{
assert(fgStmtListThreaded);
assert(fgOrder == FGOrderLinear);
assert(topLevelStmt->gtOper == GT_STMT);
// TODO-Cleanup: This is generally called for statements in order, so we'll skip the embedded ones.
// Consider whether we should do some alternate checking in that case (e.g. just validate
// the list is correct OR validate the corresponding top-level statement, which we probably
// just finished doing, OR fix all callees to check whether it's top-level before calling this).
if ((topLevelStmt->gtFlags & GTF_STMT_TOP_LEVEL) == 0)
return;
// We're first going to traverse the statements in linear order, counting the nodes and ensuring that
// the links are consistent.
// We should be able to reach all the nodes by starting with topLevelStmt->gtStmt.gtStmtList.
unsigned linearNodeCount = 0;
if (printNodes)
{
JITDUMP("\nChecking linear order first:\n");
}
noway_assert(topLevelStmt->gtStmt.gtStmtList);
// The first node's gtPrev must be nullptr (the gtPrev list is not circular).
// The last node's gtNext must be nullptr (the gtNext list is not circular). This is tested if the loop below terminates.
noway_assert(topLevelStmt->gtStmt.gtStmtList->gtPrev == nullptr);
for (GenTreePtr tree = topLevelStmt->gtStmt.gtStmtList;
tree != nullptr;
tree = tree->gtNext)
{
if (printNodes)
{
DISPNODE(tree);
}
linearNodeCount++;
if (tree->gtPrev)
{
noway_assert(tree->gtPrev->gtNext == tree);
}
else
{
// Because the embedded trees are fully contained within the topLevelStmt, the last node
// we encounter must be the top-level node of the top-level statement.
noway_assert(tree == topLevelStmt->gtStmt.gtStmtList);
}
if (tree->gtNext)
{
noway_assert(tree->gtNext->gtPrev == tree);
}
else
{
noway_assert(tree == topLevelStmt->gtStmt.gtStmtExpr);
}
}
// Next, we're going to traverse the statements in tree order, ensuring that we encounter the right
// number of nodes.
// Stop when we reach the next top-level statement (or nullptr)
unsigned treeNodeCount = 0;
GenTreeStmt* stmt = topLevelStmt->AsStmt();
if (printNodes)
{
JITDUMP("\nNow checking tree-ordering:\n");
}
do
{
treeNodeCount += fgDebugCheckLinearTree(block, stmt, stmt->gtStmtExpr, printNodes);
stmt = stmt->gtNextStmt;
}
while (stmt != nullptr && (stmt->gtFlags & GTF_STMT_TOP_LEVEL) == 0);
if (treeNodeCount != linearNodeCount)
{
if (!printNodes)
{
JITDUMP("Tree order vs linear order counts differed!\n");
fgDebugCheckLinearNodeLinks(block, topLevelStmt, true);
}
}
assert (treeNodeCount == linearNodeCount);
}
//------------------------------------------------------------------------
// fgStmtContainsNode:
// Debugging method to check whether a tree is inside the given
// statement.
//
// Arguments:
// stmt - The statement whose tree is presumably contained inside
// tree - GenTree to be checked.
//
// Return Value:
// True in case 'tree' is contained inside statement 'stmt'
//
bool Compiler::fgStmtContainsNode(GenTreeStmt* stmt, GenTree* tree)
{
GenTree* first = stmt->gtStmtList;
for (GenTree* actual = first;
actual != nullptr;
actual = actual->gtNext)
{
if (actual == tree)
return true;
}
return false;
}
/*****************************************************************************
*
* A DEBUG routine to check the correctness of the links between GT_STMT nodes
* and ordinary nodes within a statement.
*
****************************************************************************/
void Compiler::fgDebugCheckLinks(bool morphTrees)
{
// This used to be only on for stress, and there was a comment stating that
// it was "quite an expensive operation" but I did not find that to be true.
// Set DO_SANITY_DEBUG_CHECKS to false to revert to that behavior.
const bool DO_SANITY_DEBUG_CHECKS = true;
if (!DO_SANITY_DEBUG_CHECKS &&
!compStressCompile(STRESS_CHK_FLOW_UPDATE, 30))
{
return;
}
fgDebugCheckBlockLinks();
/* For each basic block check the bbTreeList links */
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
PROCESS_BLOCK_AGAIN:;
for (GenTreeStmt* stmt = block->firstStmt(); stmt; stmt = stmt->gtNextStmt)
{
/* Verify that bbTreeList is threaded correctly */
/* Note that for the GT_STMT list, the gtPrev list is circular. The gtNext list is not: gtNext of the last GT_STMT in a block is nullptr. */
noway_assert(stmt->gtPrev);
if (stmt == block->bbTreeList)
{
noway_assert(stmt->gtPrev->gtNext == nullptr);
}
else
{
noway_assert(stmt->gtPrev->gtNext == stmt);
}
if (stmt->gtNext)
{
noway_assert(stmt->gtNext->gtPrev == stmt);
}
else
{
noway_assert(block->lastStmt() == stmt);
}
/* For each statement check that the exception flags are properly set */
noway_assert(stmt->gtStmtExpr);
if (verbose && 0)
{
gtDispTree(stmt->gtStmtExpr);
}
fgDebugCheckFlags(stmt->gtStmtExpr);
// Not only will this stress fgMorphBlockStmt(), but we also get all the checks
// done by fgMorphTree()
if (morphTrees)
{
// If 'stmt' is removed from the block, restart
if (fgMorphBlockStmt(block, stmt DEBUGARG("test morphing")))
{
goto PROCESS_BLOCK_AGAIN;
}
}
/* For each GT_STMT node check that the nodes are threaded correcly - gtStmtList */
if (fgStmtListThreaded)
{
fgDebugCheckNodeLinks(block, stmt);
}
}
}
}
// ensure that bbNext and bbPrev are consistent
void Compiler::fgDebugCheckBlockLinks()
{
assert(fgFirstBB->bbPrev == nullptr);
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
if (block->bbNext)
{
assert(block->bbNext->bbPrev == block);
}
else
{
assert(block == fgLastBB);
}
if (block->bbPrev)
{
assert(block->bbPrev->bbNext == block);
}
else
{
assert(block == fgFirstBB);
}
// If this is a switch, check that the tables are consistent.
// Note that we don't call GetSwitchDescMap(), because it has the side-effect
// of allocating it if it is not present.
if (block->bbJumpKind == BBJ_SWITCH && m_switchDescMap != nullptr)
{
SwitchUniqueSuccSet uniqueSuccSet;
if (m_switchDescMap->Lookup(block, &uniqueSuccSet))
{
// Create a set with all the successors. Don't use BlockSet, so we don't need to worry
// about the BlockSet epoch.
BitVecTraits bitVecTraits(fgBBNumMax + 1, this);
BitVec BITVEC_INIT_NOCOPY(succBlocks, BitVecOps::MakeEmpty(&bitVecTraits));
BasicBlock** jumpTable = block->bbJumpSwt->bbsDstTab;
unsigned jumpCount = block->bbJumpSwt->bbsCount;
for (unsigned i = 0; i < jumpCount; i++)
{
BitVecOps::AddElemD(&bitVecTraits, succBlocks, jumpTable[i]->bbNum);
}
// Now we should have a set of unique successors that matches what's in the switchMap.
// First, check the number of entries, then make sure all the blocks in uniqueSuccSet
// are in the BlockSet.
unsigned count = BitVecOps::Count(&bitVecTraits, succBlocks);
assert(uniqueSuccSet.numDistinctSuccs == count);
for (unsigned i = 0; i < uniqueSuccSet.numDistinctSuccs; i++)
{
assert(BitVecOps::IsMember(&bitVecTraits, succBlocks, uniqueSuccSet.nonDuplicates[i]->bbNum));
}
}
}
}
}
/*****************************************************************************/
#endif // DEBUG
/*****************************************************************************/
//------------------------------------------------------------------------
// fgNodeContainsEmbeddedStatement:
// Predicate that verifies whether the given tree has an embedded statement
// in it.
//
// Arguments:
// tree - GenTree to be checked.
// topLevel - The top-level statement where 'tree' lives.
//
// Assumptions:
// The given 'tree' must be contained inside 'topLevel' (i.e. is a descendant
// of topLevel.gtStmtExpr
//
// Return Value:
// True in case 'tree' contains an embedded statement.
//
bool Compiler::fgNodeContainsEmbeddedStatement(GenTree* tree, GenTreeStmt* topLevel)
{
assert(fgStmtContainsNode(topLevel, tree));
for (GenTree* actual = fgGetFirstNode(tree);
actual != tree;
actual = actual->gtNext)
{
for (GenTree* curStmt = topLevel->gtNext;
curStmt != nullptr && curStmt->gtStmt.gtStmtIsEmbedded();
curStmt = curStmt->gtNext)
{
if (curStmt->gtStmt.gtStmtList == actual)
return true;
}
}
return false;
}
//------------------------------------------------------------------------
// fgRemoveContainedEmbeddedStatements:
// If a tree contains a subtree, recursively remove all embedded
// statements "contained" in the subtree.
//
// Arguments:
// tree - GenTree to be checked.
// stmt - The statement where 'tree' lives.
// block - block where "topLevel" lives.
//
// Assumptions:
// The given 'tree' must be contained inside 'stmt' (i.e. is a descendant
// of stmt.gtStmtExpr and 'stmt' is in 'block'
//
// Return Value:
// None, but all embedded statements that the tree depends on are removed.
//
void Compiler::fgRemoveContainedEmbeddedStatements(GenTreePtr tree, GenTreeStmt* stmt, BasicBlock* block)
{
assert(fgStmtContainsNode(stmt, tree));
GenTreePtr embCursor = stmt->gtNext;
// Get the first node that will be evaluated in the subtree,
// "tree" will be the last node to be evaluated.
for (GenTree* child = fgGetFirstNode(tree); child != tree; child = child->gtNext)
{
// Now check each following stmt to see if "tree"
// is actually the first node in its stmt list.
for (GenTreePtr cur = embCursor;
cur != nullptr && cur->gtStmt.gtStmtIsEmbedded();
cur = cur->gtNext)
{
if (cur->gtStmt.gtStmtList == child)
{
fgRemoveContainedEmbeddedStatements(cur->gtStmt.gtStmtExpr, cur->AsStmt(), block);
fgRemoveStmt(block, cur);
embCursor = cur->gtNext;
break;
}
}
}
}
/*****************************************************************************
* Check if we have a recursion loop or if the recursion is too deep while doing the inlining.
* Return true if a recursion loop is found or if the inlining recursion is too deep.
*/
bool Compiler::fgIsUnboundedInlineRecursion(inlExpPtr expLst,
BYTE* ilCode)
{
const DWORD MAX_INLINING_RECURSION_DEPTH = 20;
DWORD count = 0;
for (; expLst; expLst = expLst->ixlNext)
{
// Hard limit just to catch pathological cases
count++;
if ((expLst->ixlCode == ilCode) || (count > MAX_INLINING_RECURSION_DEPTH))
return true;
}
return false;
}
/*****************************************************************************
*
* Inlining phase
*/
void Compiler::fgInline()
{
if (!opts.OptEnabled(CLFLG_INLINING))
return;
#ifdef DEBUG
if (verbose)
printf("*************** In fgInline()\n");
#endif // DEBUG
BasicBlock* block = fgFirstBB;
noway_assert(block);
do
{
/* Make the current basic block address available globally */
compCurBB = block;
GenTreeStmt* stmt;
GenTreePtr expr;
for (stmt = block->firstStmt();
stmt != nullptr;
stmt = stmt->gtNextStmt)
{
expr = stmt->gtStmtExpr;
// See if we can expand the inline candidate.
if ((expr->gtOper == GT_CALL) && ((expr->gtFlags & GTF_CALL_INLINE_CANDIDATE) != 0))
{
fgMorphStmt = stmt;
fgMorphCallInline(expr);
if (stmt->gtStmtExpr->IsNothingNode())
{
fgRemoveStmt(block, stmt);
continue;
}
}
// See if we need to replace the return value place holder.
fgWalkTreePre(&stmt->gtStmtExpr,
fgUpdateInlineReturnExpressionPlaceHolder,
(void *) this);
// See if stmt is of the form GT_COMMA(call, nop)
// If yes, we can get rid of GT_COMMA.
if (expr->OperGet() == GT_COMMA &&
expr->gtOp.gtOp1->OperGet() == GT_CALL &&
expr->gtOp.gtOp2->OperGet() == GT_NOP)
{
stmt->gtStmtExpr = expr->gtOp.gtOp1;
}
}
block = block->bbNext;
} while (block);
#ifdef DEBUG
// Check that we should not have any inline candidate or return value place holder left.
block = fgFirstBB;
noway_assert(block);
do
{
GenTreeStmt* stmt;
for (stmt = block->firstStmt();
stmt;
stmt = stmt->gtNextStmt)
{
// Call Compiler::fgDebugCheckInlineCandidates on each node
fgWalkTreePre(&stmt->gtStmtExpr, fgDebugCheckInlineCandidates);
}
block = block->bbNext;
} while (block);
fgVerifyHandlerTab();
if (verbose)
{
printf("*************** After fgInline()\n");
fgDispBasicBlocks(true);
fgDispHandlerTab();
}
#endif // DEBUG
}
#ifdef _TARGET_ARM_
/*********************************************************************************
*
* tree - The node which needs to be converted to a struct pointer.
*
* Return the pointer by either __replacing__ the tree node with a suitable pointer
* type or __without replacing__ and just returning a subtree or by __modifying__
* a subtree.
*/
GenTreePtr Compiler::fgGetStructAsStructPtr(GenTreePtr tree)
{
noway_assert(tree->gtOper == GT_LCL_VAR ||
tree->gtOper == GT_FIELD ||
tree->gtOper == GT_IND ||
tree->gtOper == GT_LDOBJ ||
// tree->gtOper == GT_CALL || cannot get address of call.
// tree->gtOper == GT_MKREFANY || inlining should've been aborted due to mkrefany opcode.
// tree->gtOper == GT_RET_EXPR || cannot happen after fgUpdateInlineReturnExpressionPlaceHolder
tree->gtOper == GT_COMMA);
switch (tree->OperGet())
{
case GT_LDOBJ:
case GT_IND:
return tree->gtOp.gtOp1;
case GT_COMMA:
tree->gtOp.gtOp2 = fgGetStructAsStructPtr(tree->gtOp.gtOp2);
tree->gtType = TYP_BYREF;
return tree;
default:
return gtNewOperNode(GT_ADDR, TYP_BYREF, tree);
}
}
/***************************************************************************************************
* child - The inlinee of the retExpr node.
* retClsHnd - The HFA class handle of the type of the inlinee.
*
* Assign the inlinee to a tmp, if it is a call, just assign it to a lclVar, else we can
* use a copyblock to do the assignment.
*/
GenTreePtr Compiler::fgAssignHfaInlineeToVar(GenTreePtr child, CORINFO_CLASS_HANDLE retClsHnd)
{
assert(child->gtOper != GT_RET_EXPR && child->gtOper != GT_MKREFANY);
unsigned tmpNum = lvaGrabTemp(false DEBUGARG("RetBuf for HFA inline return candidates."));
lvaSetStruct(tmpNum, retClsHnd, false);
GenTreePtr dst = gtNewLclvNode(tmpNum, TYP_STRUCT);
// If we have a call, we'd like it to be: V00 = call(), but first check if
// we have a ", , , call()" -- this is very defensive as we may never get
// an inlinee that is made of commas. If the inlinee is not a call, then
// we use a copy block to do the assignment.
GenTreePtr src = child;
GenTreePtr lastComma = NULL;
while (src->gtOper == GT_COMMA)
{
lastComma = src;
src = src->gtOp.gtOp2;
}
GenTreePtr newInlinee = NULL;
if (src->gtOper == GT_CALL)
{
// If inlinee was just a call, new inlinee is v05 = call()
newInlinee = gtNewAssignNode(dst, src);
// If inlinee was comma, but a deeper call, new inlinee is (, , , v05 = call())
if (child->gtOper == GT_COMMA)
{
lastComma->gtOp.gtOp2 = newInlinee;
newInlinee = child;
}
}
else
{
// Inlinee is not a call, so just create a copy block to the tmp.
src = child;
GenTreePtr dstAddr = fgGetStructAsStructPtr(dst);
GenTreePtr srcAddr = fgGetStructAsStructPtr(src);
newInlinee = gtNewCpObjNode(dstAddr, srcAddr, retClsHnd, false);
}
GenTreePtr production = gtNewLclvNode(tmpNum, TYP_STRUCT);
return gtNewOperNode(GT_COMMA, TYP_STRUCT, newInlinee, production);
}
/***************************************************************************************************
* tree - The tree pointer that has one of its child nodes as retExpr.
* child - The inlinee child.
* retClsHnd - The HFA class handle of the type of the inlinee.
*
* V04 = call() assignments are okay as we codegen it. Everything else needs to be a copy block or
* would need a temp. For example, a cast(ldobj) will then be, cast(v05 = ldobj, v05); But it is
* a very rare (or impossible) scenario that we'd have a retExpr transform into a ldobj other than
* a lclVar/call. So it is not worthwhile to do pattern matching optimizations like addr(ldobj(op1))
* can just be op1.
*/
void Compiler::fgAttachHfaInlineeToAsg(GenTreePtr tree, GenTreePtr child, CORINFO_CLASS_HANDLE retClsHnd)
{
// We are okay to have:
// 1. V02 = call();
// 2. copyBlk(dstAddr, srcAddr);
assert(tree->gtOper == GT_ASG);
// We have an assignment, we codegen only V05 = call().
if (child->gtOper == GT_CALL && tree->gtOp.gtOp1->gtOper == GT_LCL_VAR)
{
return;
}
GenTreePtr dstAddr = fgGetStructAsStructPtr(tree->gtOp.gtOp1);
GenTreePtr srcAddr = fgGetStructAsStructPtr((child->gtOper == GT_CALL)
? fgAssignHfaInlineeToVar(child, retClsHnd) // Assign to a variable if it is a call.
: child); // Just get the address, if not a call.
tree->CopyFrom(gtNewCpObjNode(dstAddr, srcAddr, retClsHnd, false), this);
}
#endif // _TARGET_ARM_
/*****************************************************************************
* Callback to replace the inline return expression place holder (GT_RET_EXPR)
*/
/* static */
Compiler::fgWalkResult Compiler::fgUpdateInlineReturnExpressionPlaceHolder(GenTreePtr* pTree,
fgWalkData* data)
{
GenTreePtr tree = *pTree;
Compiler* comp = data->compiler;
if (tree->gtOper == GT_RET_EXPR)
{
#ifdef _TARGET_ARM_
// We are going to copy the tree from the inlinee, so save the handle now.
CORINFO_CLASS_HANDLE retClsHnd = (tree->TypeGet() == TYP_STRUCT)
? tree->gtRetExpr.gtRetClsHnd
: NO_CLASS_HANDLE;
#endif // _TARGET_ARM_
do
{
// Obtained the expanded inline candidate
GenTreePtr inlineCandidate;
inlineCandidate = tree->gtRetExpr.gtInlineCandidate;
// If the inlineCandidate node is a leaf, we can just overwrite "tree" with it.
// But if it's not, we have to make sure to do a deep copy before overwriting it.
if (inlineCandidate->OperIsLeaf())
{
tree->CopyFrom(inlineCandidate, comp);
}
else
{
tree->CopyFrom(comp->gtCloneExpr(inlineCandidate), comp);
#ifdef DEBUG
comp->CopyTestDataToCloneTree(inlineCandidate, tree);
#endif // DEBUG
}
#ifdef DEBUG
if (false && comp->verbose)
{
printf("\nAfter updating the return expression place holder ");
printTreeID(tree);
printf(" for call ");
printTreeID(inlineCandidate);
printf(":\n");
comp->gtDispTree(tree);
}
#endif // DEBUG
}
while (tree->gtOper == GT_RET_EXPR);
#ifdef _TARGET_ARM_
if (retClsHnd != NO_CLASS_HANDLE && comp->IsHfa(retClsHnd))
{
GenTreePtr parent = data->parent;
// See assert below, we only look one level above for an asg parent.
if (parent->gtOper == GT_ASG)
{
// Either lhs is a call V05 = call(); or lhs is addr, and asg becomes a copyBlk.
comp->fgAttachHfaInlineeToAsg(parent, tree, retClsHnd);
}
else
{
// Just assign the inlinee to a variable to keep it simple.
tree->CopyFrom(comp->fgAssignHfaInlineeToVar(tree, retClsHnd), comp);
}
}
#endif // _TARGET_ARM_
}
#if defined(DEBUG) && defined(_TARGET_ARM_)
// Make sure we don't have a tree like so: V05 = (, , , retExpr);
// Since we only look one level above for the parent for '=' and
// do not check if there is a series of COMMAs. See above.
// Importer and FlowGraph will not generate such a tree, so just
// leaving an assert in here. This can be fixed by looking ahead
// when we visit GT_ASG similar to fgAttachHfaInlineeToAsg.
else if (tree->gtOper == GT_ASG &&
tree->gtOp.gtOp2->gtOper == GT_COMMA)
{
GenTreePtr comma;
for (comma = tree->gtOp.gtOp2;
comma->gtOper == GT_COMMA;
comma = comma->gtOp.gtOp2)
{
// empty
}
noway_assert(comma->gtType != TYP_STRUCT ||
comma->gtOper != GT_RET_EXPR ||
!comp->IsHfa(comma->gtRetExpr.gtRetClsHnd));
}
#endif // defined(DEBUG) && defined(_TARGET_ARM_)
return WALK_CONTINUE;
}
#ifdef DEBUG
/*****************************************************************************
* Callback to make sure there is no more GT_RET_EXPR and GTF_CALL_INLINE_CANDIDATE nodes.
*/
/* static */
Compiler::fgWalkResult Compiler::fgDebugCheckInlineCandidates(GenTreePtr* pTree,
fgWalkData* data)
{
GenTreePtr tree = *pTree;
if (tree->gtOper == GT_CALL)
{
assert((tree->gtFlags & GTF_CALL_INLINE_CANDIDATE) == 0);
}
else
{
assert(tree->gtOper != GT_RET_EXPR);
}
return WALK_CONTINUE;
}
#endif // DEBUG
JitInlineResult Compiler::fgInvokeInlineeCompiler(GenTreeCall* call)
{
noway_assert(call->gtOper == GT_CALL);
noway_assert((call->gtFlags & GTF_CALL_INLINE_CANDIDATE) != 0);
noway_assert(opts.OptEnabled(CLFLG_INLINING));
// This is the InlineInfo struct representing a method to be inlined.
InlineInfo inlineInfo = {0};
CORINFO_METHOD_HANDLE fncHandle = call->gtCallMethHnd;
inlineInfo.fncHandle = fncHandle;
inlineInfo.iciCall = call;
inlineInfo.iciStmt = fgMorphStmt;
inlineInfo.iciBlock = compCurBB;
inlineInfo.thisDereferencedFirst = false;
inlineInfo.retExpr = NULL;
#ifdef FEATURE_SIMD
inlineInfo.hasSIMDTypeArgLocalOrReturn = false;
#endif // FEATURE_SIMD
InlineCandidateInfo* inlineCandidateInfo = call->gtInlineCandidateInfo;
noway_assert(inlineCandidateInfo);
// Store the link to inlineCandidateInfo into inlineInfo
inlineInfo.inlineCandidateInfo = inlineCandidateInfo;
if (fgIsUnboundedInlineRecursion(inlineInfo.iciStmt->gtStmt.gtInlineExpList, inlineCandidateInfo->methInfo.ILCode))
{
#ifdef DEBUG
if (verbose)
{
printf("Recursive or deep inline recursion detected. Will not expand this INLINECANDIDATE \n");
}
#endif // DEBUG
return JitInlineResult(INLINE_FAIL, inlineCandidateInfo->ilCallerHandle, fncHandle,
"Recursive or deep inline recursion detected. "
"Will not expand this INLINECANDIDATE");
}
// Set the trap to catch all errors (including recoverable ones from the EE)
struct Param
{
Compiler* pThis;
GenTree* call;
CORINFO_METHOD_HANDLE fncHandle;
InlineCandidateInfo* inlineCandidateInfo;
InlineInfo* inlineInfo;
JitInlineResult result;
} param = {0};
param.pThis = this;
param.call = call;
param.fncHandle = fncHandle;
param.inlineCandidateInfo = inlineCandidateInfo;
param.inlineInfo = &inlineInfo;
setErrorTrap(info.compCompHnd, Param*, pParam, ¶m)
{
// Init the local var info of the inlinee
pParam->result = pParam->pThis->impInlineInitVars(pParam->inlineInfo);
if (!dontInline(pParam->result))
{
/* Clear the temp table */
memset(pParam->inlineInfo->lclTmpNum, -1, sizeof(pParam->inlineInfo->lclTmpNum));
//
// Prepare the call to jitNativeCode
//
pParam->inlineInfo->InlinerCompiler = pParam->pThis;
if (pParam->pThis->impInlineInfo == NULL)
{
pParam->inlineInfo->InlineRoot = pParam->pThis;
}
else
{
pParam->inlineInfo->InlineRoot = pParam->pThis->impInlineInfo->InlineRoot;
}
pParam->inlineInfo->argCnt = pParam->inlineCandidateInfo->methInfo.args.totalILArgs();
pParam->inlineInfo->tokenLookupContextHandle = pParam->inlineCandidateInfo->exactContextHnd;
JITLOG_THIS(pParam->pThis,
(LL_INFO100000,
INLINER_INFO "inlineInfo.tokenLookupContextHandle for %s set to 0x%p:\n",
pParam->pThis->eeGetMethodFullName(pParam->fncHandle),
pParam->pThis->dspPtr(pParam->inlineInfo->tokenLookupContextHandle)));
unsigned compileFlagsForInlinee = (pParam->pThis->opts.eeFlags & ~CORJIT_FLG_LOST_WHEN_INLINING)
| CORJIT_FLG_SKIP_VERIFICATION;
#ifdef DEBUG
if (pParam->pThis->verbose)
{
printf("\nInvoking compiler for the inlinee method %s :\n",
pParam->pThis->eeGetMethodFullName(pParam->fncHandle));
}
#endif // DEBUG
int result = jitNativeCode(pParam->fncHandle,
pParam->inlineCandidateInfo->methInfo.scope,
pParam->pThis->info.compCompHnd,
&pParam->inlineCandidateInfo->methInfo,
(void**)pParam->inlineInfo,
NULL,
compileFlagsForInlinee,
pParam->inlineInfo);
if (result != CORJIT_OK)
{
pParam->result = JitInlineResult(INLINE_FAIL,
pParam->inlineInfo->inlineCandidateInfo->ilCallerHandle,
pParam->fncHandle,
"Inlining failed due to an error during invoking the compiler for the inlinee");
}
}
}
impErrorTrap()
{
#ifdef DEBUG
if (verbose)
{
printf("\nInlining failed due to an exception during invoking the compiler for the inlinee method %s.\n",
eeGetMethodFullName(fncHandle));
}
#endif // DEBUG
inlineInfo.inlineResult = JitInlineResult(INLINE_FAIL,
inlineInfo.inlineCandidateInfo->ilCallerHandle,
fncHandle, "Inlining failed due to an exception during invoking the compiler for the inlinee");
}
endErrorTrap();
JitInlineResult result = param.result;
if (dontInline(result))
{
#if defined(DEBUG) || MEASURE_INLINING
++Compiler::jitInlineInitVarsFailureCount;
#endif // defined(DEBUG) || MEASURE_INLINING
goto Exit;
}
#ifdef DEBUG
if (0 && verbose)
{
printf("\nDone invoking compiler for the inlinee method %s\n",
eeGetMethodFullName(fncHandle));
}
#endif // DEBUG
if (dontInline(inlineInfo.inlineResult))
{
result = inlineInfo.inlineResult;
goto Exit;
}
// If there is non-NULL return, but we haven't set the pInlineInfo->retExpr,
// That means we haven't imported any BB that contains CEE_RET opcode.
// (This could happen for example for a BBJ_THROW block fall through a BBJ_RETURN block which
// causes the BBJ_RETURN block not to be imported at all.)
// Fail the inlining attempt
if (inlineCandidateInfo->fncRetType != TYP_VOID && inlineInfo.retExpr == NULL)
{
#ifdef DEBUG
if (verbose)
{
printf("\nInlining failed because pInlineInfo->retExpr is not set in the inlinee method %s.\n",
eeGetMethodFullName(fncHandle));
}
#endif // DEBUG
result = JitInlineResult(INLINE_NEVER, inlineCandidateInfo->ilCallerHandle, fncHandle,
"Inlining failed because inlinee did not contain a return expression.");
goto Exit;
}
if (inlineCandidateInfo->initClassResult & CORINFO_INITCLASS_SPECULATIVE)
{
// we defer the call to initClass() until inlining is completed in case it fails. If inlining succeeds,
// we will call initClass().
if (!(info.compCompHnd->initClass(NULL /* field */, fncHandle /* method */,
inlineCandidateInfo->exactContextHnd /* context */) & CORINFO_INITCLASS_INITIALIZED))
{
JITLOG((LL_INFO100000, INLINER_FAILED "Could not complete class init side effect: "
"%s called by %s\n",
eeGetMethodFullName(fncHandle), info.compFullName));
result = JitInlineResult(INLINE_NEVER, inlineCandidateInfo->ilCallerHandle, fncHandle,
"Failed class init side-effect");
goto Exit;
}
}
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// The inlining attempt cannot be failed starting from this point.
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// We've successfully obtain the list of inlinee's basic blocks.
// Let's insert it to inliner's basic block list.
fgInsertInlineeBlocks(&inlineInfo);
#ifdef DEBUG
++fgInlinedCount;
static ConfigDWORD fJitPrintInlinedMethods;
if (verbose ||
fJitPrintInlinedMethods.val(CLRConfig::EXTERNAL_JitPrintInlinedMethods) == 1)
{
printf("Successfully inlined %s (%d IL bytes) into %s\n",
eeGetMethodFullName(fncHandle),
inlineCandidateInfo->methInfo.ILCodeSize,
info.compFullName);
}
if (verbose)
{
printf("--------------------------------------------------------------------------------------------\n");
}
#endif // DEBUG
#if defined(DEBUG)
impInlinedCodeSize += inlineCandidateInfo->methInfo.ILCodeSize;
#endif
result = JitInlineResult(INLINE_PASS, inlineCandidateInfo->ilCallerHandle, fncHandle, NULL);
Exit:
result.report(info.compCompHnd);
return result;
}
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// The inlining attempt cannot be failed starting from this point.
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
void Compiler::fgInsertInlineeBlocks(InlineInfo* pInlineInfo)
{
GenTreePtr iciCall = pInlineInfo->iciCall;
GenTreePtr iciStmt = pInlineInfo->iciStmt;
BasicBlock* iciBlock = pInlineInfo->iciBlock;
BasicBlock* block;
// We can write better assert here. For example, we can check that
// iciBlock contains iciStmt, which in turn contains iciCall.
noway_assert(iciBlock->bbTreeList != NULL);
noway_assert(iciStmt->gtStmt.gtStmtExpr != NULL);
noway_assert(iciCall->gtOper == GT_CALL);
#ifdef DEBUG
GenTreePtr currentDumpStmt = NULL;
if (verbose)
{
printf("\n\n----------- Statements (and blocks) added due to the inlining of call ");
printTreeID(iciCall);
printf(" -----------\n");
// gtDispTree(iciStmt);
}
#endif // DEBUG
#if defined(DEBUG) || MEASURE_INLINING
if (iciStmt->gtNext == NULL)
{
++Compiler::jitIciStmtIsTheLastInBB;
}
if (InlineeCompiler->fgBBcount == 1)
{
++Compiler::jitInlineeContainsOnlyOneBB;
}
#endif // defined(DEBUG) || MEASURE_INLINING
//
// Obtain an inlExpLst struct and update the gtInlineExpList field in the inlinee's statements
//
inlExpLst* expDsc;
expDsc = new (this, CMK_Inlining) inlExpLst;
expDsc->ixlCode = pInlineInfo->inlineCandidateInfo->methInfo.ILCode;
expDsc->ixlNext = iciStmt->gtStmt.gtInlineExpList;
for (block = InlineeCompiler->fgFirstBB;
block;
block = block->bbNext)
{
for (GenTreeStmt* stmt = block->firstStmt();
stmt;
stmt = stmt->gtNextStmt)
{
stmt->gtInlineExpList = expDsc;
}
}
//
// Prepend statements.
//
GenTreePtr stmtAfter;
stmtAfter = fgInlinePrependStatements(pInlineInfo);
#ifdef DEBUG
if (verbose)
{
currentDumpStmt = stmtAfter;
printf("\nInlinee method body:");
}
#endif // DEBUG
if (InlineeCompiler->fgBBcount == 1)
{
// When fgBBCount is 1 we will always have a non-NULL fgFirstBB
//
PREFAST_ASSUME(InlineeCompiler->fgFirstBB != NULL);
// DDB 91389: Don't throw away the (only) inlinee block
// when its return type is not BBJ_RETURN.
// In other words, we need its BBJ_ to perform the right thing.
if (InlineeCompiler->fgFirstBB->bbJumpKind == BBJ_RETURN)
{
// Inlinee contains just one BB. So just insert its statement list to topBlock.
if (InlineeCompiler->fgFirstBB->bbTreeList)
{
stmtAfter = fgInsertStmtListAfter(iciBlock,
stmtAfter,
InlineeCompiler->fgFirstBB->bbTreeList);
}
#ifdef DEBUG
if (verbose)
{
noway_assert(currentDumpStmt);
if (currentDumpStmt != stmtAfter)
{
do
{
currentDumpStmt = currentDumpStmt->gtNext;
printf("\n");
noway_assert(currentDumpStmt->gtOper == GT_STMT);
gtDispTree(currentDumpStmt);
printf("\n");
} while (currentDumpStmt != stmtAfter);
}
}
#endif // DEBUG
goto _Done;
}
}
//
// ======= Inserting inlinee's basic blocks ===============
//
BasicBlock* topBlock;
BasicBlock* bottomBlock;
topBlock = iciBlock;
bottomBlock = fgNewBBafter(topBlock->bbJumpKind, topBlock, true);
bottomBlock->bbRefs = 1;
bottomBlock->bbJumpDest = topBlock->bbJumpDest;
bottomBlock->inheritWeight(topBlock);
topBlock->bbJumpKind = BBJ_NONE;
// Update block flags
unsigned originalFlags;
originalFlags = topBlock->bbFlags;
noway_assert((originalFlags & BBF_SPLIT_NONEXIST) == 0);
topBlock->bbFlags &= ~(BBF_SPLIT_LOST);
bottomBlock->bbFlags |= originalFlags & BBF_SPLIT_GAINED;
//
// Split statements between topBlock and bottomBlock
//
GenTreePtr topBlock_Begin;
GenTreePtr topBlock_End;
GenTreePtr bottomBlock_Begin;
GenTreePtr bottomBlock_End;
topBlock_Begin = NULL;
topBlock_End = NULL;
bottomBlock_Begin = NULL;
bottomBlock_End = NULL;
//
// First figure out bottomBlock_Begin
//
bottomBlock_Begin = stmtAfter->gtNext;
if (topBlock->bbTreeList == NULL)
{
// topBlock is empty before the split.
// In this case, both topBlock and bottomBlock should be empty
noway_assert(bottomBlock_Begin == NULL);
topBlock->bbTreeList = NULL;
bottomBlock->bbTreeList = NULL;
}
else if (topBlock->bbTreeList == bottomBlock_Begin)
{
noway_assert(bottomBlock_Begin);
// topBlock contains at least one statement before the split.
// And the split is before the first statement.
// In this case, topBlock should be empty, and everything else should be moved to the bottonBlock.
bottomBlock->bbTreeList = topBlock->bbTreeList;
topBlock->bbTreeList = NULL;
}
else if (bottomBlock_Begin == NULL)
{
noway_assert(topBlock->bbTreeList);
// topBlock contains at least one statement before the split.
// And the split is at the end of the topBlock.
// In this case, everything should be kept in the topBlock, and the bottomBlock should be empty
bottomBlock->bbTreeList = NULL;
}
else
{
noway_assert(topBlock->bbTreeList);
noway_assert(bottomBlock_Begin);
// This is the normal case where both blocks should contain at least one statement.
topBlock_Begin = topBlock->bbTreeList;
noway_assert(topBlock_Begin);
topBlock_End = bottomBlock_Begin->gtPrev;
noway_assert(topBlock_End);
bottomBlock_End = topBlock->lastStmt();
noway_assert(bottomBlock_End);
// Break the linkage between 2 blocks.
topBlock_End->gtNext = NULL;
// Fix up all the pointers.
topBlock->bbTreeList = topBlock_Begin;
topBlock->bbTreeList->gtPrev = topBlock_End;
bottomBlock->bbTreeList = bottomBlock_Begin;
bottomBlock->bbTreeList->gtPrev = bottomBlock_End;
}
//
// Set the try and handler index and fix the jump types of inlinee's blocks.
//
bool inheritWeight;
inheritWeight = true; // The firstBB does inherit the weight from the iciBlock
for (block = InlineeCompiler->fgFirstBB;
block != NULL;
block = block->bbNext)
{
noway_assert(!block->hasTryIndex());
noway_assert(!block->hasHndIndex());
block->copyEHRegion(iciBlock);
block->bbFlags |= iciBlock->bbFlags & BBF_BACKWARD_JUMP;
if (iciStmt->gtStmt.gtStmtILoffsx != BAD_IL_OFFSET)
{
block->bbCodeOffs = jitGetILoffs(iciStmt->gtStmt.gtStmtILoffsx);
block->bbCodeOffsEnd = block->bbCodeOffs + 1; // TODO: is code size of 1 some magic number for inlining?
}
else
{
block->bbCodeOffs = 0; // TODO: why not BAD_IL_OFFSET?
block->bbCodeOffsEnd = 0;
block->bbFlags |= BBF_INTERNAL;
}
if (block->bbJumpKind == BBJ_RETURN)
{
inheritWeight = true; // A return block does inherit the weight from the iciBlock
noway_assert((block->bbFlags & BBF_HAS_JMP) == 0);
if (block->bbNext)
{
block->bbJumpKind = BBJ_ALWAYS;
block->bbJumpDest = bottomBlock;
#ifdef DEBUG
if (verbose)
{
printf("\nConvert bbJumpKind of BB%02u to BBJ_ALWAYS to bottomBlock BB%02u\n",
block->bbNum, bottomBlock->bbNum);
}
#endif // DEBUG
}
else
{
#ifdef DEBUG
if (verbose)
{
printf("\nConvert bbJumpKind of BB%02u to BBJ_NONE\n", block->bbNum);
}
#endif // DEBUG
block->bbJumpKind = BBJ_NONE;
}
}
if (inheritWeight)
{
block->inheritWeight(iciBlock);
inheritWeight = false;
}
else
{
block->modifyBBWeight(iciBlock->bbWeight / 2);
}
}
// Insert inlinee's blocks into inliner's block list.
topBlock->setNext(InlineeCompiler->fgFirstBB);
InlineeCompiler->fgLastBB->setNext(bottomBlock);
//
// Add inlinee's block count to inliner's.
//
fgBBcount += InlineeCompiler->fgBBcount;
#ifdef DEBUG
if (verbose)
{
fgDispBasicBlocks(InlineeCompiler->fgFirstBB, InlineeCompiler->fgLastBB, true);
}
#endif // DEBUG
_Done:
//
// At this point, we have successully inserted inlinee's code.
//
//
// Copy out some flags
//
compLongUsed |= InlineeCompiler->compLongUsed;
compFloatingPointUsed |= InlineeCompiler->compFloatingPointUsed;
compLocallocUsed |= InlineeCompiler->compLocallocUsed;
compQmarkUsed |= InlineeCompiler->compQmarkUsed;
compUnsafeCastUsed |= InlineeCompiler->compUnsafeCastUsed;
compNeedsGSSecurityCookie |= InlineeCompiler->compNeedsGSSecurityCookie;
compGSReorderStackLayout |= InlineeCompiler->compGSReorderStackLayout;
// If there is non-NULL return, replace the GT_CALL with its return value expression,
// so later it will be picked up by the GT_RET_EXPR node.
if ((pInlineInfo->inlineCandidateInfo->fncRetType != TYP_VOID) || (iciCall->gtCall.gtReturnType == TYP_STRUCT))
{
noway_assert(pInlineInfo->retExpr);
iciCall->CopyFrom(pInlineInfo->retExpr, this);
#ifdef DEBUG
if (verbose)
{
printf("\nReturn expression for inlinee ");
printTreeID(iciCall);
printf(" :\n");
gtDispTree(iciCall);
}
#endif // DEBUG
}
//
// Detach the GT_CALL node from the original statement by hanging a "nothing" node under it,
// so that fgMorphStmts can remove the statment once we return from here.
//
iciStmt->gtStmt.gtStmtExpr = gtNewNothingNode();
}
// Prepend the statements that are needed before the inlined call.
// Return the last statement that is prepended.
GenTreePtr Compiler::fgInlinePrependStatements(InlineInfo* inlineInfo)
{
BasicBlock* block = inlineInfo->iciBlock;
GenTreePtr callStmt = inlineInfo->iciStmt;
noway_assert(callStmt->gtOper == GT_STMT);
IL_OFFSETX callILOffset = callStmt->gtStmt.gtStmtILoffsx;
GenTreePtr afterStmt = callStmt; // afterStmt is the place where the new statements should be inserted after.
GenTreePtr newStmt;
GenTreePtr call = inlineInfo->iciCall;
noway_assert(call->gtOper == GT_CALL);
#ifdef DEBUG
if (0 && verbose)
{
printf("\nfgInlinePrependStatements for iciCall= ");
printTreeID(call);
printf(":\n");
}
#endif
// Prepend statements for any initialization / side effects
InlArgInfo* inlArgInfo = inlineInfo->inlArgInfo;
InlLclVarInfo* lclVarInfo = inlineInfo->lclVarInfo;
GenTreePtr tree;
// Create the null check statement (but not appending it to the statement list yet) for the 'this' pointer if necessary.
// The NULL check should be done after "argument setup statements".
// The only reason we move it here is for calling "impInlineFetchArg(0,..." to reserve a temp
// for the "this" pointer.
// Note: Here we no longer do the optimization that was done by thisDereferencedFirst in the old inliner.
// However the assetionProp logic will remove any unecessary null checks that we may have added
//
GenTreePtr nullcheck = NULL;
if (call->gtFlags & GTF_CALL_NULLCHECK && !inlineInfo->thisDereferencedFirst)
{
// Call impInlineFetchArg to "reserve" a temp for the "this" pointer.
nullcheck = gtNewOperNode(GT_IND, TYP_INT,
impInlineFetchArg(0, inlArgInfo, lclVarInfo));
nullcheck->gtFlags |= GTF_EXCEPT;
// The NULL-check statement will be inserted to the statement list after those statements
// that assign arguments to temps and before the actual body of the inlinee method.
}
/* Treat arguments that had to be assigned to temps */
if (inlineInfo->argCnt)
{
#ifdef DEBUG
if (verbose)
{
printf("\nArguments setup:\n");
}
#endif // DEBUG
for (unsigned argNum = 0; argNum < inlineInfo->argCnt; argNum++)
{
if (inlArgInfo[argNum].argHasTmp)
{
noway_assert(inlArgInfo[argNum].argIsUsed);
/* argBashTmpNode is non-NULL iff the argument's value was
referenced exactly once by the original IL. This offers an
oppportunity to avoid an intermediate temp and just insert
the original argument tree.
However, if the temp node has been cloned somewhere while
importing (e.g. when handling isinst or dup), or if the IL
took the address of the argument, then argBashTmpNode will
be set (because the value was only explicitly retrieved
once) but the optimization cannot be applied.
*/
GenTreePtr argSingleUseNode = inlArgInfo[argNum].argBashTmpNode;
if (argSingleUseNode &&
!(argSingleUseNode->gtFlags & GTF_VAR_CLONED) &&
!inlArgInfo[argNum].argHasLdargaOp)
{
/* Change the temp in-place to the actual argument */
argSingleUseNode->CopyFrom(inlArgInfo[argNum].argNode, this);
continue;
}
else
{
/* Create the temp assignment for this argument */
CORINFO_CLASS_HANDLE structType = DUMMY_INIT(0);
if (lclVarInfo[argNum].lclTypeInfo == TYP_STRUCT)
{
if (inlArgInfo[argNum].argNode->gtOper == GT_LDOBJ)
{
structType = inlArgInfo[argNum].argNode->gtLdObj.gtClass;
}
else if (inlArgInfo[argNum].argNode->gtOper == GT_MKREFANY)
{
structType = lclVarInfo[argNum].lclVerTypeInfo.GetClassHandle();
}
else
{
noway_assert(!"Unknown struct type");
}
}
// Unsafe value cls check is not needed for argTmpNum here since in-linee compiler instance would have
// iterated over these and marked them accordingly.
impAssignTempGen(inlArgInfo[argNum].argTmpNum,
inlArgInfo[argNum].argNode,
structType,
(unsigned)CHECK_SPILL_NONE,
& afterStmt,
callILOffset,
block);
#ifdef DEBUG
if (verbose)
{
gtDispTree(afterStmt);
}
#endif // DEBUG
}
}
else if (inlArgInfo[argNum].argIsByRefToStructLocal)
{
// Do nothing.
}
else
{
/* The argument is either not used or a const or lcl var */
noway_assert(!inlArgInfo[argNum].argIsUsed ||
inlArgInfo[argNum].argIsInvariant ||
inlArgInfo[argNum].argIsLclVar );
/* Make sure we didnt change argNode's along the way, or else
subsequent uses of the arg would have worked with the bashed value */
if (inlArgInfo[argNum].argIsInvariant)
{
assert(inlArgInfo[argNum].argNode->OperIsConst() ||
inlArgInfo[argNum].argNode->gtOper == GT_ADDR);
}
noway_assert((inlArgInfo[argNum].argIsLclVar == 0) ==
(inlArgInfo[argNum].argNode->gtOper != GT_LCL_VAR || (inlArgInfo[argNum].argNode->gtFlags & GTF_GLOB_REF)));
/* If the argument has side effects, append it */
if (inlArgInfo[argNum].argHasSideEff)
{
noway_assert(inlArgInfo[argNum].argIsUsed == false);
if (inlArgInfo[argNum].argNode->gtOper == GT_LDOBJ ||
inlArgInfo[argNum].argNode->gtOper == GT_MKREFANY)
{
// Don't put GT_LDOBJ node under a GT_COMMA.
// Codegen can't deal with it.
// Just hang the address here in case there are side-effect.
newStmt = gtNewStmt(gtUnusedValNode(inlArgInfo[argNum].argNode->gtOp.gtOp1), callILOffset);
}
else
{
newStmt = gtNewStmt(gtUnusedValNode(inlArgInfo[argNum].argNode), callILOffset);
}
afterStmt = fgInsertStmtAfter(block, afterStmt, newStmt);
#ifdef DEBUG
if (verbose)
{
gtDispTree(afterStmt);
}
#endif // DEBUG
}
}
}
}
// Add the CCTOR check if asked for.
// Note: We no longer do the optimization that is done before by staticAccessedFirstUsingHelper in the old inliner.
// Therefore we might prepend redundant call to HELPER.CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE
// before the inlined method body, even if a static field of this type was accessed in the inlinee
// using a helper before any other observable side-effect.
if (inlineInfo->inlineCandidateInfo->initClassResult & CORINFO_INITCLASS_USE_HELPER)
{
CORINFO_CONTEXT_HANDLE exactContext = inlineInfo->inlineCandidateInfo->exactContextHnd;
CORINFO_CLASS_HANDLE exactClass;
if (((SIZE_T)exactContext & CORINFO_CONTEXTFLAGS_MASK) == CORINFO_CONTEXTFLAGS_CLASS)
{
exactClass = CORINFO_CLASS_HANDLE((SIZE_T)exactContext & ~CORINFO_CONTEXTFLAGS_MASK);
}
else
{
exactClass = info.compCompHnd->getMethodClass(CORINFO_METHOD_HANDLE((SIZE_T)exactContext & ~CORINFO_CONTEXTFLAGS_MASK));
}
tree = fgGetSharedCCtor(exactClass);
newStmt = gtNewStmt(tree, callILOffset);
afterStmt = fgInsertStmtAfter(block, afterStmt, newStmt);
}
// Insert the nullcheck statement now.
if (nullcheck)
{
newStmt = gtNewStmt(nullcheck, callILOffset);
afterStmt = fgInsertStmtAfter(block, afterStmt, newStmt);
}
//
// Now zero-init inlinee locals
//
CORINFO_METHOD_INFO* InlineeMethodInfo = InlineeCompiler->info.compMethodInfo;
unsigned lclCnt = InlineeMethodInfo->locals.numArgs;
// Does callee contain any zero-init local?
if ((lclCnt != 0) &&
(InlineeMethodInfo->options & CORINFO_OPT_INIT_LOCALS) != 0)
{
#ifdef DEBUG
if (verbose)
{
printf("\nZero init inlinee locals:\n");
}
#endif // DEBUG
for (unsigned lclNum = 0; lclNum < lclCnt; lclNum++)
{
unsigned tmpNum = inlineInfo->lclTmpNum[lclNum];
// Is the local used at all?
if (tmpNum != BAD_VAR_NUM)
{
var_types lclTyp = (var_types)lvaTable[tmpNum].lvType;
noway_assert(lclTyp == lclVarInfo[lclNum + inlineInfo->argCnt].lclTypeInfo);
if (lclTyp != TYP_STRUCT)
{
// Unsafe value cls check is not needed here since in-linee compiler instance would have
// iterated over locals and marked accordingly.
impAssignTempGen(tmpNum,
gtNewZeroConNode(genActualType(lclTyp)),
NO_CLASS_HANDLE,
(unsigned)CHECK_SPILL_NONE,
& afterStmt,
callILOffset,
block);
}
else
{
CORINFO_CLASS_HANDLE structType = lclVarInfo[lclNum + inlineInfo->argCnt].lclVerTypeInfo.GetClassHandle();
tree = gtNewOperNode(GT_ADDR, TYP_BYREF,
gtNewLclvNode(tmpNum, TYP_STRUCT));
tree = gtNewBlkOpNode(GT_INITBLK,
tree, // Dest
gtNewIconNode(0), // Value
gtNewIconNode(info.compCompHnd->getClassSize(structType)), // Size
false); // volatil
newStmt = gtNewStmt(tree, callILOffset);
afterStmt = fgInsertStmtAfter(block, afterStmt, newStmt);
}
#ifdef DEBUG
if (verbose)
{
gtDispTree(afterStmt);
}
#endif // DEBUG
}
}
}
return afterStmt;
}
/*****************************************************************************/
/*static*/
Compiler::fgWalkResult Compiler::fgChkThrowCB(GenTreePtr* pTree,
fgWalkData* data)
{
GenTreePtr tree = *pTree;
// If this tree doesn't have the EXCEPT flag set, then there is no
// way any of the child nodes could throw, so we can stop recursing.
if (!(tree->gtFlags & GTF_EXCEPT))
{
return Compiler::WALK_SKIP_SUBTREES;
}
switch (tree->gtOper)
{
case GT_MUL:
case GT_ADD:
case GT_SUB:
case GT_ASG_ADD:
case GT_ASG_SUB:
case GT_CAST:
if (tree->gtOverflow())
return Compiler::WALK_ABORT;
break;
case GT_INDEX:
if (tree->gtFlags & GTF_INX_RNGCHK)
return Compiler::WALK_ABORT;
break;
case GT_ARR_BOUNDS_CHECK:
return Compiler::WALK_ABORT;
default:
break;
}
return Compiler::WALK_CONTINUE;
}
/*****************************************************************************/
/*static*/
Compiler::fgWalkResult Compiler::fgChkLocAllocCB(GenTreePtr* pTree,
fgWalkData* data)
{
GenTreePtr tree = *pTree;
if (tree->gtOper == GT_LCLHEAP)
return Compiler::WALK_ABORT;
return Compiler::WALK_CONTINUE;
}
/*****************************************************************************/
/*static*/
Compiler::fgWalkResult Compiler::fgChkQmarkCB(GenTreePtr* pTree,
fgWalkData* data)
{
GenTreePtr tree = *pTree;
if (tree->gtOper == GT_QMARK)
return Compiler::WALK_ABORT;
return Compiler::WALK_CONTINUE;
}
void Compiler::fgLclFldAssign(unsigned lclNum)
{
assert(var_types(lvaTable[lclNum].lvType) == TYP_STRUCT);
if (lvaTable[lclNum].lvPromoted && lvaTable[lclNum].lvFieldCnt > 1)
{
lvaSetVarDoNotEnregister(lclNum DEBUG_ARG(DNER_LocalField));
}
}
|