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
|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
// =================================================================================
// Code that works with liveness and related concepts (interference, debug scope)
// =================================================================================
#include "jitpch.h"
#ifdef _MSC_VER
#pragma hdrstop
#endif
#if !defined(_TARGET_64BIT_)
#include "decomposelongs.h"
#endif
/*****************************************************************************
*
* Helper for Compiler::fgPerBlockLocalVarLiveness().
* The goal is to compute the USE and DEF sets for a basic block.
* However with the new improvement to the data flow analysis (DFA),
* we do not mark x as used in x = f(x) when there are no side effects in f(x).
* 'asgdLclVar' is set when 'tree' is part of an expression with no side-effects
* which is assigned to asgdLclVar, ie. asgdLclVar = (... tree ...)
*/
void Compiler::fgMarkUseDef(GenTreeLclVarCommon* tree, GenTree* asgdLclVar)
{
bool rhsUSEDEF = false;
unsigned lclNum;
unsigned lhsLclNum;
LclVarDsc* varDsc;
noway_assert(tree->gtOper == GT_LCL_VAR || tree->gtOper == GT_LCL_VAR_ADDR || tree->gtOper == GT_LCL_FLD ||
tree->gtOper == GT_LCL_FLD_ADDR || tree->gtOper == GT_STORE_LCL_VAR ||
tree->gtOper == GT_STORE_LCL_FLD);
if (tree->gtOper == GT_LCL_VAR || tree->gtOper == GT_LCL_VAR_ADDR || tree->gtOper == GT_STORE_LCL_VAR)
{
lclNum = tree->gtLclNum;
}
else
{
noway_assert(tree->OperIsLocalField());
lclNum = tree->gtLclFld.gtLclNum;
}
noway_assert(lclNum < lvaCount);
varDsc = lvaTable + lclNum;
// We should never encounter a reference to a lclVar that has a zero refCnt.
if (varDsc->lvRefCnt == 0 && (!varTypeIsPromotable(varDsc) || !varDsc->lvPromoted))
{
JITDUMP("Found reference to V%02u with zero refCnt.\n", lclNum);
assert(!"We should never encounter a reference to a lclVar that has a zero refCnt.");
varDsc->lvRefCnt = 1;
}
// NOTE: the analysis done below is neither necessary nor correct for LIR: it depends on
// the nodes that precede `asgdLclVar` in execution order to factor into the dataflow for the
// value being assigned to the local var, which is not necessarily the case without tree
// order. Furthermore, LIR is always traversed in an order that reflects the dataflow for the
// block.
if (asgdLclVar != nullptr)
{
assert(!compCurBB->IsLIR());
/* we have an assignment to a local var : asgdLclVar = ... tree ...
* check for x = f(x) case */
noway_assert(asgdLclVar->gtOper == GT_LCL_VAR || asgdLclVar->gtOper == GT_STORE_LCL_VAR);
noway_assert(asgdLclVar->gtFlags & GTF_VAR_DEF);
lhsLclNum = asgdLclVar->gtLclVarCommon.gtLclNum;
if ((lhsLclNum == lclNum) && ((tree->gtFlags & GTF_VAR_DEF) == 0) && (tree != asgdLclVar))
{
/* bingo - we have an x = f(x) case */
noway_assert(lvaTable[lhsLclNum].lvType != TYP_STRUCT);
asgdLclVar->gtFlags |= GTF_VAR_USEDEF;
rhsUSEDEF = true;
}
}
/* Is this a tracked variable? */
if (varDsc->lvTracked)
{
noway_assert(varDsc->lvVarIndex < lvaTrackedCount);
if ((tree->gtFlags & GTF_VAR_DEF) != 0 && (tree->gtFlags & (GTF_VAR_USEASG | GTF_VAR_USEDEF)) == 0)
{
// if (!(fgCurUseSet & bitMask)) printf("V%02u,T%02u def at %08p\n", lclNum, varDsc->lvVarIndex, tree);
VarSetOps::AddElemD(this, fgCurDefSet, varDsc->lvVarIndex);
}
else
{
// if (!(fgCurDefSet & bitMask))
// {
// printf("V%02u,T%02u use at ", lclNum, varDsc->lvVarIndex);
// printTreeID(tree);
// printf("\n");
// }
/* We have the following scenarios:
* 1. "x += something" - in this case x is flagged GTF_VAR_USEASG
* 2. "x = ... x ..." - the LHS x is flagged GTF_VAR_USEDEF,
* the RHS x is has rhsUSEDEF = true
* (both set by the code above)
*
* We should not mark an USE of x in the above cases provided the value "x" is not used
* further up in the tree. For example "while (i++)" is required to mark i as used.
*/
/* make sure we don't include USEDEF variables in the USE set
* The first test is for LSH, the second (!rhsUSEDEF) is for any var in the RHS */
if ((tree->gtFlags & (GTF_VAR_USEASG | GTF_VAR_USEDEF)) == 0)
{
/* Not a special flag - check to see if used to assign to itself */
if (rhsUSEDEF)
{
/* assign to itself - do not include it in the USE set */
if (!opts.MinOpts() && !opts.compDbgCode)
{
return;
}
}
}
/* Fall through for the "good" cases above - add the variable to the USE set */
if (!VarSetOps::IsMember(this, fgCurDefSet, varDsc->lvVarIndex))
{
VarSetOps::AddElemD(this, fgCurUseSet, varDsc->lvVarIndex);
}
// For defs, also add to the (all) def set.
if ((tree->gtFlags & GTF_VAR_DEF) != 0)
{
VarSetOps::AddElemD(this, fgCurDefSet, varDsc->lvVarIndex);
}
}
}
else if (varTypeIsStruct(varDsc))
{
noway_assert(!varDsc->lvTracked);
lvaPromotionType promotionType = lvaGetPromotionType(varDsc);
if (promotionType != PROMOTION_TYPE_NONE)
{
VARSET_TP VARSET_INIT_NOCOPY(bitMask, VarSetOps::MakeEmpty(this));
for (unsigned i = varDsc->lvFieldLclStart; i < varDsc->lvFieldLclStart + varDsc->lvFieldCnt; ++i)
{
noway_assert(lvaTable[i].lvIsStructField);
if (lvaTable[i].lvTracked)
{
noway_assert(lvaTable[i].lvVarIndex < lvaTrackedCount);
VarSetOps::AddElemD(this, bitMask, lvaTable[i].lvVarIndex);
}
}
// For pure defs (i.e. not an "update" def which is also a use), add to the (all) def set.
if ((tree->gtFlags & GTF_VAR_DEF) != 0 && (tree->gtFlags & (GTF_VAR_USEASG | GTF_VAR_USEDEF)) == 0)
{
VarSetOps::UnionD(this, fgCurDefSet, bitMask);
}
else if (!VarSetOps::IsSubset(this, bitMask, fgCurDefSet))
{
// Mark as used any struct fields that are not yet defined.
VarSetOps::UnionD(this, fgCurUseSet, bitMask);
}
}
}
}
/*****************************************************************************/
void Compiler::fgLocalVarLiveness()
{
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgLocalVarLiveness()\n");
#ifndef LEGACY_BACKEND
if (compRationalIRForm)
{
lvaTableDump();
}
#endif // !LEGACY_BACKEND
}
#endif // DEBUG
// Init liveness data structures.
fgLocalVarLivenessInit();
assert(lvaSortAgain == false); // Set to false by lvaSortOnly()
EndPhase(PHASE_LCLVARLIVENESS_INIT);
// Make sure we haven't noted any partial last uses of promoted structs.
GetPromotedStructDeathVars()->RemoveAll();
// Initialize the per-block var sets.
fgInitBlockVarSets();
fgLocalVarLivenessChanged = false;
do
{
/* Figure out use/def info for all basic blocks */
fgPerBlockLocalVarLiveness();
EndPhase(PHASE_LCLVARLIVENESS_PERBLOCK);
/* Live variable analysis. */
fgStmtRemoved = false;
fgInterBlockLocalVarLiveness();
} while (fgStmtRemoved && fgLocalVarLivenessChanged);
// If we removed any dead code we will have set 'lvaSortAgain' via decRefCnts
if (lvaSortAgain)
{
JITDUMP("In fgLocalVarLiveness, setting lvaSortAgain back to false (set during dead-code removal)\n");
lvaSortAgain = false; // We don't re-Sort because we just performed LclVar liveness.
}
EndPhase(PHASE_LCLVARLIVENESS_INTERBLOCK);
}
/*****************************************************************************/
void Compiler::fgLocalVarLivenessInit()
{
// If necessary, re-sort the variable table by ref-count...before creating any varsets using this sorting.
if (lvaSortAgain)
{
JITDUMP("In fgLocalVarLivenessInit, sorting locals\n");
lvaSortByRefCount();
assert(lvaSortAgain == false); // Set to false by lvaSortOnly()
}
#ifdef LEGACY_BACKEND // RyuJIT backend does not use interference info
for (unsigned i = 0; i < lclMAX_TRACKED; i++)
{
VarSetOps::AssignNoCopy(this, lvaVarIntf[i], VarSetOps::MakeEmpty(this));
}
/* If we're not optimizing at all, things are simple */
if (opts.MinOpts())
{
VARSET_TP VARSET_INIT_NOCOPY(allOnes, VarSetOps::MakeFull(this));
for (unsigned i = 0; i < lvaTrackedCount; i++)
{
VarSetOps::Assign(this, lvaVarIntf[i], allOnes);
}
return;
}
#endif // LEGACY_BACKEND
// We mark a lcl as must-init in a first pass of local variable
// liveness (Liveness1), then assertion prop eliminates the
// uninit-use of a variable Vk, asserting it will be init'ed to
// null. Then, in a second local-var liveness (Liveness2), the
// variable Vk is no longer live on entry to the method, since its
// uses have been replaced via constant propagation.
//
// This leads to a bug: since Vk is no longer live on entry, the
// register allocator sees Vk and an argument Vj as having
// disjoint lifetimes, and allocates them to the same register.
// But Vk is still marked "must-init", and this initialization (of
// the register) trashes the value in Vj.
//
// Therefore, initialize must-init to false for all variables in
// each liveness phase.
for (unsigned lclNum = 0; lclNum < lvaCount; ++lclNum)
{
lvaTable[lclNum].lvMustInit = false;
}
}
// Note that for the LEGACY_BACKEND this method is replaced with
// fgLegacyPerStatementLocalVarLiveness and it lives in codegenlegacy.cpp
//
#ifndef LEGACY_BACKEND
//------------------------------------------------------------------------
// fgPerNodeLocalVarLiveness:
// Set fgCurHeapUse and fgCurHeapDef when the global heap is read or updated
// Call fgMarkUseDef for any Local variables encountered
//
// Arguments:
// tree - The current node.
// asgdLclVar - Either nullptr or the assignement's left-hand-side GT_LCL_VAR.
// Used as an argument to fgMarkUseDef(); only valid for HIR blocks.
//
void Compiler::fgPerNodeLocalVarLiveness(GenTree* tree, GenTree* asgdLclVar)
{
assert(tree != nullptr);
assert(asgdLclVar == nullptr || !compCurBB->IsLIR());
switch (tree->gtOper)
{
case GT_QMARK:
case GT_COLON:
// We never should encounter a GT_QMARK or GT_COLON node
noway_assert(!"unexpected GT_QMARK/GT_COLON");
break;
case GT_LCL_VAR:
case GT_LCL_FLD:
case GT_LCL_VAR_ADDR:
case GT_LCL_FLD_ADDR:
case GT_STORE_LCL_VAR:
case GT_STORE_LCL_FLD:
fgMarkUseDef(tree->AsLclVarCommon(), asgdLclVar);
break;
case GT_CLS_VAR:
// For Volatile indirection, first mutate the global heap
// see comments in ValueNum.cpp (under case GT_CLS_VAR)
// This models Volatile reads as def-then-use of the heap.
// and allows for a CSE of a subsequent non-volatile read
if ((tree->gtFlags & GTF_FLD_VOLATILE) != 0)
{
// For any Volatile indirection, we must handle it as a
// definition of the global heap
fgCurHeapDef = true;
}
// If the GT_CLS_VAR is the lhs of an assignment, we'll handle it as a heap def, when we get to assignment.
// Otherwise, we treat it as a use here.
if (!fgCurHeapDef && (tree->gtFlags & GTF_CLS_VAR_ASG_LHS) == 0)
{
fgCurHeapUse = true;
}
break;
case GT_IND:
// For Volatile indirection, first mutate the global heap
// see comments in ValueNum.cpp (under case GT_CLS_VAR)
// This models Volatile reads as def-then-use of the heap.
// and allows for a CSE of a subsequent non-volatile read
if ((tree->gtFlags & GTF_IND_VOLATILE) != 0)
{
// For any Volatile indirection, we must handle it as a
// definition of the global heap
fgCurHeapDef = true;
}
// If the GT_IND is the lhs of an assignment, we'll handle it
// as a heap def, when we get to assignment.
// Otherwise, we treat it as a use here.
if ((tree->gtFlags & GTF_IND_ASG_LHS) == 0)
{
GenTreeLclVarCommon* dummyLclVarTree = nullptr;
bool dummyIsEntire = false;
GenTreePtr addrArg = tree->gtOp.gtOp1->gtEffectiveVal(/*commaOnly*/ true);
if (!addrArg->DefinesLocalAddr(this, /*width doesn't matter*/ 0, &dummyLclVarTree, &dummyIsEntire))
{
if (!fgCurHeapDef)
{
fgCurHeapUse = true;
}
}
else
{
// Defines a local addr
assert(dummyLclVarTree != nullptr);
fgMarkUseDef(dummyLclVarTree->AsLclVarCommon(), asgdLclVar);
}
}
break;
// These should have been morphed away to become GT_INDs:
case GT_FIELD:
case GT_INDEX:
unreached();
break;
// We'll assume these are use-then-defs of the heap.
case GT_LOCKADD:
case GT_XADD:
case GT_XCHG:
case GT_CMPXCHG:
if (!fgCurHeapDef)
{
fgCurHeapUse = true;
}
fgCurHeapDef = true;
fgCurHeapHavoc = true;
break;
case GT_MEMORYBARRIER:
// Simliar to any Volatile indirection, we must handle this as a definition of the global heap
fgCurHeapDef = true;
break;
// For now, all calls read/write the heap, the latter in its entirety. Might tighten this case later.
case GT_CALL:
{
GenTreeCall* call = tree->AsCall();
bool modHeap = true;
if (call->gtCallType == CT_HELPER)
{
CorInfoHelpFunc helpFunc = eeGetHelperNum(call->gtCallMethHnd);
if (!s_helperCallProperties.MutatesHeap(helpFunc) && !s_helperCallProperties.MayRunCctor(helpFunc))
{
modHeap = false;
}
}
if (modHeap)
{
if (!fgCurHeapDef)
{
fgCurHeapUse = true;
}
fgCurHeapDef = true;
fgCurHeapHavoc = true;
}
}
// If this is a p/invoke unmanaged call or if this is a tail-call
// and we have an unmanaged p/invoke call in the method,
// then we're going to run the p/invoke epilog.
// So we mark the FrameRoot as used by this instruction.
// This ensures that the block->bbVarUse will contain
// the FrameRoot local var if is it a tracked variable.
if ((tree->gtCall.IsUnmanaged() || (tree->gtCall.IsTailCall() && info.compCallUnmanaged)))
{
assert((!opts.ShouldUsePInvokeHelpers()) || (info.compLvFrameListRoot == BAD_VAR_NUM));
if (!opts.ShouldUsePInvokeHelpers())
{
/* Get the TCB local and mark it as used */
noway_assert(info.compLvFrameListRoot < lvaCount);
LclVarDsc* varDsc = &lvaTable[info.compLvFrameListRoot];
if (varDsc->lvTracked)
{
if (!VarSetOps::IsMember(this, fgCurDefSet, varDsc->lvVarIndex))
{
VarSetOps::AddElemD(this, fgCurUseSet, varDsc->lvVarIndex);
}
}
}
}
break;
default:
// Determine whether it defines a heap location.
if (tree->OperIsAssignment() || tree->OperIsBlkOp())
{
GenTreeLclVarCommon* dummyLclVarTree = nullptr;
if (!tree->DefinesLocal(this, &dummyLclVarTree))
{
// If it doesn't define a local, then it might update the heap.
fgCurHeapDef = true;
}
}
break;
}
}
void Compiler::fgPerStatementLocalVarLiveness(GenTree* startNode, GenTree* asgdLclVar)
{
// The startNode must be the 1st node of the statement.
assert(startNode == compCurStmt->gtStmt.gtStmtList);
// The asgdLclVar node must be either nullptr or a GT_LCL_VAR or GT_STORE_LCL_VAR
assert((asgdLclVar == nullptr) || (asgdLclVar->gtOper == GT_LCL_VAR || asgdLclVar->gtOper == GT_STORE_LCL_VAR));
// We always walk every node in statement list
for (GenTreePtr node = startNode; node != nullptr; node = node->gtNext)
{
fgPerNodeLocalVarLiveness(node, asgdLclVar);
}
}
#endif // !LEGACY_BACKEND
/*****************************************************************************/
void Compiler::fgPerBlockLocalVarLiveness()
{
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgPerBlockLocalVarLiveness()\n");
}
#endif // DEBUG
BasicBlock* block;
#if CAN_DISABLE_DFA
/* If we're not optimizing at all, things are simple */
if (opts.MinOpts())
{
unsigned lclNum;
LclVarDsc* varDsc;
VARSET_TP VARSET_INIT_NOCOPY(liveAll, VarSetOps::MakeEmpty(this));
/* We simply make everything live everywhere */
for (lclNum = 0, varDsc = lvaTable; lclNum < lvaCount; lclNum++, varDsc++)
{
if (varDsc->lvTracked)
{
VarSetOps::AddElemD(this, liveAll, varDsc->lvVarIndex);
}
}
for (block = fgFirstBB; block; block = block->bbNext)
{
// Strictly speaking, the assignments for the "Def" cases aren't necessary here.
// The empty set would do as well. Use means "use-before-def", so as long as that's
// "all", this has the right effect.
VarSetOps::Assign(this, block->bbVarUse, liveAll);
VarSetOps::Assign(this, block->bbVarDef, liveAll);
VarSetOps::Assign(this, block->bbLiveIn, liveAll);
VarSetOps::Assign(this, block->bbLiveOut, liveAll);
block->bbHeapUse = true;
block->bbHeapDef = true;
block->bbHeapLiveIn = true;
block->bbHeapLiveOut = true;
switch (block->bbJumpKind)
{
case BBJ_EHFINALLYRET:
case BBJ_THROW:
case BBJ_RETURN:
VarSetOps::AssignNoCopy(this, block->bbLiveOut, VarSetOps::MakeEmpty(this));
break;
default:
break;
}
}
return;
}
#endif // CAN_DISABLE_DFA
// Avoid allocations in the long case.
VarSetOps::AssignNoCopy(this, fgCurUseSet, VarSetOps::MakeEmpty(this));
VarSetOps::AssignNoCopy(this, fgCurDefSet, VarSetOps::MakeEmpty(this));
for (block = fgFirstBB; block; block = block->bbNext)
{
GenTreePtr stmt;
GenTreePtr tree;
GenTreePtr asgdLclVar;
VarSetOps::ClearD(this, fgCurUseSet);
VarSetOps::ClearD(this, fgCurDefSet);
fgCurHeapUse = false;
fgCurHeapDef = false;
fgCurHeapHavoc = false;
compCurBB = block;
if (!block->IsLIR())
{
for (stmt = block->FirstNonPhiDef(); stmt; stmt = stmt->gtNext)
{
noway_assert(stmt->gtOper == GT_STMT);
compCurStmt = stmt;
asgdLclVar = nullptr;
tree = stmt->gtStmt.gtStmtExpr;
noway_assert(tree);
// The following code checks if we have an assignment expression
// which may become a GTF_VAR_USEDEF - x=f(x).
// consider if LHS is local var - ignore if RHS contains SIDE_EFFECTS
if ((tree->gtOper == GT_ASG && tree->gtOp.gtOp1->gtOper == GT_LCL_VAR) ||
tree->gtOper == GT_STORE_LCL_VAR)
{
noway_assert(tree->gtOp.gtOp1);
GenTreePtr rhsNode;
if (tree->gtOper == GT_ASG)
{
noway_assert(tree->gtOp.gtOp2);
asgdLclVar = tree->gtOp.gtOp1;
rhsNode = tree->gtOp.gtOp2;
}
else
{
asgdLclVar = tree;
rhsNode = tree->gtOp.gtOp1;
}
// If this is an assignment to local var with no SIDE EFFECTS,
// set asgdLclVar so that genMarkUseDef will flag potential
// x=f(x) expressions as GTF_VAR_USEDEF.
// Reset the flag before recomputing it - it may have been set before,
// but subsequent optimizations could have removed the rhs reference.
asgdLclVar->gtFlags &= ~GTF_VAR_USEDEF;
if ((rhsNode->gtFlags & GTF_SIDE_EFFECT) == 0)
{
noway_assert(asgdLclVar->gtFlags & GTF_VAR_DEF);
}
else
{
asgdLclVar = nullptr;
}
}
#ifdef LEGACY_BACKEND
tree = fgLegacyPerStatementLocalVarLiveness(stmt->gtStmt.gtStmtList, NULL, asgdLclVar);
// We must have walked to the end of this statement.
noway_assert(!tree);
#else // !LEGACY_BACKEND
fgPerStatementLocalVarLiveness(stmt->gtStmt.gtStmtList, asgdLclVar);
#endif // !LEGACY_BACKEND
}
}
else
{
#ifdef LEGACY_BACKEND
unreached();
#else // !LEGACY_BACKEND
// NOTE: the `asgdLclVar` analysis done above is not correct for LIR: it depends
// on all of the nodes that precede `asgdLclVar` in execution order to factor into the
// dataflow for the value being assigned to the local var, which is not necessarily the
// case without tree order. As a result, we simply pass `nullptr` for `asgdLclVar`.
for (GenTree* node : LIR::AsRange(block).NonPhiNodes())
{
fgPerNodeLocalVarLiveness(node, nullptr);
}
#endif // !LEGACY_BACKEND
}
/* Get the TCB local and mark it as used */
if (block->bbJumpKind == BBJ_RETURN && info.compCallUnmanaged)
{
assert((!opts.ShouldUsePInvokeHelpers()) || (info.compLvFrameListRoot == BAD_VAR_NUM));
if (!opts.ShouldUsePInvokeHelpers())
{
noway_assert(info.compLvFrameListRoot < lvaCount);
LclVarDsc* varDsc = &lvaTable[info.compLvFrameListRoot];
if (varDsc->lvTracked)
{
if (!VarSetOps::IsMember(this, fgCurDefSet, varDsc->lvVarIndex))
{
VarSetOps::AddElemD(this, fgCurUseSet, varDsc->lvVarIndex);
}
}
}
}
#ifdef DEBUG
if (verbose)
{
VARSET_TP VARSET_INIT_NOCOPY(allVars, VarSetOps::Union(this, fgCurUseSet, fgCurDefSet));
printf("BB%02u", block->bbNum);
printf(" USE(%d)=", VarSetOps::Count(this, fgCurUseSet));
lvaDispVarSet(fgCurUseSet, allVars);
if (fgCurHeapUse)
{
printf(" + HEAP");
}
printf("\n DEF(%d)=", VarSetOps::Count(this, fgCurDefSet));
lvaDispVarSet(fgCurDefSet, allVars);
if (fgCurHeapDef)
{
printf(" + HEAP");
}
if (fgCurHeapHavoc)
{
printf("*");
}
printf("\n\n");
}
#endif // DEBUG
VarSetOps::Assign(this, block->bbVarUse, fgCurUseSet);
VarSetOps::Assign(this, block->bbVarDef, fgCurDefSet);
block->bbHeapUse = fgCurHeapUse;
block->bbHeapDef = fgCurHeapDef;
block->bbHeapHavoc = fgCurHeapHavoc;
/* also initialize the IN set, just in case we will do multiple DFAs */
VarSetOps::AssignNoCopy(this, block->bbLiveIn, VarSetOps::MakeEmpty(this));
block->bbHeapLiveIn = false;
}
}
/*****************************************************************************/
#ifdef DEBUGGING_SUPPORT
/*****************************************************************************/
// Helper functions to mark variables live over their entire scope
void Compiler::fgBeginScopeLife(VARSET_TP* inScope, VarScopeDsc* var)
{
assert(var);
LclVarDsc* lclVarDsc1 = &lvaTable[var->vsdVarNum];
if (lclVarDsc1->lvTracked)
{
VarSetOps::AddElemD(this, *inScope, lclVarDsc1->lvVarIndex);
}
}
void Compiler::fgEndScopeLife(VARSET_TP* inScope, VarScopeDsc* var)
{
assert(var);
LclVarDsc* lclVarDsc1 = &lvaTable[var->vsdVarNum];
if (lclVarDsc1->lvTracked)
{
VarSetOps::RemoveElemD(this, *inScope, lclVarDsc1->lvVarIndex);
}
}
/*****************************************************************************/
void Compiler::fgMarkInScope(BasicBlock* block, VARSET_VALARG_TP inScope)
{
#ifdef DEBUG
if (verbose)
{
printf("Scope info: block BB%02u marking in scope: ", block->bbNum);
dumpConvertedVarSet(this, inScope);
printf("\n");
}
#endif // DEBUG
/* Record which vars are artifically kept alive for debugging */
VarSetOps::Assign(this, block->bbScope, inScope);
/* Being in scope implies a use of the variable. Add the var to bbVarUse
so that redoing fgLiveVarAnalysis() will work correctly */
VarSetOps::UnionD(this, block->bbVarUse, inScope);
/* Artifically mark all vars in scope as alive */
VarSetOps::UnionD(this, block->bbLiveIn, inScope);
VarSetOps::UnionD(this, block->bbLiveOut, inScope);
}
void Compiler::fgUnmarkInScope(BasicBlock* block, VARSET_VALARG_TP unmarkScope)
{
#ifdef DEBUG
if (verbose)
{
printf("Scope info: block BB%02u UNmarking in scope: ", block->bbNum);
dumpConvertedVarSet(this, unmarkScope);
printf("\n");
}
#endif // DEBUG
assert(VarSetOps::IsSubset(this, unmarkScope, block->bbScope));
VarSetOps::DiffD(this, block->bbScope, unmarkScope);
VarSetOps::DiffD(this, block->bbVarUse, unmarkScope);
VarSetOps::DiffD(this, block->bbLiveIn, unmarkScope);
VarSetOps::DiffD(this, block->bbLiveOut, unmarkScope);
}
#ifdef DEBUG
void Compiler::fgDispDebugScopes()
{
printf("\nDebug scopes:\n");
BasicBlock* block;
for (block = fgFirstBB; block; block = block->bbNext)
{
printf("BB%02u: ", block->bbNum);
dumpConvertedVarSet(this, block->bbScope);
printf("\n");
}
}
#endif // DEBUG
/*****************************************************************************
*
* Mark variables live across their entire scope.
*/
#if FEATURE_EH_FUNCLETS
void Compiler::fgExtendDbgScopes()
{
compResetScopeLists();
#ifdef DEBUG
if (verbose)
{
printf("\nMarking vars alive over their entire scope :\n\n");
}
if (verbose)
{
compDispScopeLists();
}
#endif // DEBUG
VARSET_TP VARSET_INIT_NOCOPY(inScope, VarSetOps::MakeEmpty(this));
// Mark all tracked LocalVars live over their scope - walk the blocks
// keeping track of the current life, and assign it to the blocks.
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
// If we get to a funclet, reset the scope lists and start again, since the block
// offsets will be out of order compared to the previous block.
if (block->bbFlags & BBF_FUNCLET_BEG)
{
compResetScopeLists();
VarSetOps::ClearD(this, inScope);
}
// Process all scopes up to the current offset
if (block->bbCodeOffs != BAD_IL_OFFSET)
{
compProcessScopesUntil(block->bbCodeOffs, &inScope, &Compiler::fgBeginScopeLife, &Compiler::fgEndScopeLife);
}
// Assign the current set of variables that are in scope to the block variables tracking this.
fgMarkInScope(block, inScope);
}
#ifdef DEBUG
if (verbose)
{
fgDispDebugScopes();
}
#endif // DEBUG
}
#else // !FEATURE_EH_FUNCLETS
void Compiler::fgExtendDbgScopes()
{
compResetScopeLists();
#ifdef DEBUG
if (verbose)
{
printf("\nMarking vars alive over their entire scope :\n\n");
compDispScopeLists();
}
#endif // DEBUG
VARSET_TP VARSET_INIT_NOCOPY(inScope, VarSetOps::MakeEmpty(this));
compProcessScopesUntil(0, &inScope, &Compiler::fgBeginScopeLife, &Compiler::fgEndScopeLife);
IL_OFFSET lastEndOffs = 0;
// Mark all tracked LocalVars live over their scope - walk the blocks
// keeping track of the current life, and assign it to the blocks.
BasicBlock* block;
for (block = fgFirstBB; block; block = block->bbNext)
{
// Find scopes becoming alive. If there is a gap in the instr
// sequence, we need to process any scopes on those missing offsets.
if (block->bbCodeOffs != BAD_IL_OFFSET)
{
if (lastEndOffs != block->bbCodeOffs)
{
noway_assert(lastEndOffs < block->bbCodeOffs);
compProcessScopesUntil(block->bbCodeOffs, &inScope, &Compiler::fgBeginScopeLife,
&Compiler::fgEndScopeLife);
}
else
{
while (VarScopeDsc* varScope = compGetNextEnterScope(block->bbCodeOffs))
{
fgBeginScopeLife(&inScope, varScope);
}
}
}
// Assign the current set of variables that are in scope to the block variables tracking this.
fgMarkInScope(block, inScope);
// Find scopes going dead.
if (block->bbCodeOffsEnd != BAD_IL_OFFSET)
{
VarScopeDsc* varScope;
while ((varScope = compGetNextExitScope(block->bbCodeOffsEnd)) != nullptr)
{
fgEndScopeLife(&inScope, varScope);
}
lastEndOffs = block->bbCodeOffsEnd;
}
}
/* Everything should be out of scope by the end of the method. But if the
last BB got removed, then inScope may not be empty. */
noway_assert(VarSetOps::IsEmpty(this, inScope) || lastEndOffs < info.compILCodeSize);
}
#endif // !FEATURE_EH_FUNCLETS
/*****************************************************************************
*
* For debuggable code, we allow redundant assignments to vars
* by marking them live over their entire scope.
*/
void Compiler::fgExtendDbgLifetimes()
{
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgExtendDbgLifetimes()\n");
}
#endif // DEBUG
noway_assert(opts.compDbgCode && (info.compVarScopesCount > 0));
/*-------------------------------------------------------------------------
* Extend the lifetimes over the entire reported scope of the variable.
*/
fgExtendDbgScopes();
/*-------------------------------------------------------------------------
* Partly update liveness info so that we handle any funky BBF_INTERNAL
* blocks inserted out of sequence.
*/
#ifdef DEBUG
if (verbose && 0)
{
fgDispBBLiveness();
}
#endif
fgLiveVarAnalysis(true);
/* For compDbgCode, we prepend an empty BB which will hold the
initializations of variables which are in scope at IL offset 0 (but
not initialized by the IL code). Since they will currently be
marked as live on entry to fgFirstBB, unmark the liveness so that
the following code will know to add the initializations. */
assert(fgFirstBBisScratch());
VARSET_TP VARSET_INIT_NOCOPY(trackedArgs, VarSetOps::MakeEmpty(this));
for (unsigned argNum = 0; argNum < info.compArgsCount; argNum++)
{
LclVarDsc* argDsc = lvaTable + argNum;
if (argDsc->lvPromoted)
{
lvaPromotionType promotionType = lvaGetPromotionType(argDsc);
if (promotionType == PROMOTION_TYPE_INDEPENDENT)
{
noway_assert(argDsc->lvFieldCnt == 1); // We only handle one field here
unsigned fieldVarNum = argDsc->lvFieldLclStart;
argDsc = lvaTable + fieldVarNum;
}
}
noway_assert(argDsc->lvIsParam);
if (argDsc->lvTracked)
{
noway_assert(!VarSetOps::IsMember(this, trackedArgs, argDsc->lvVarIndex)); // Each arg should define a
// different bit.
VarSetOps::AddElemD(this, trackedArgs, argDsc->lvVarIndex);
}
}
// Don't unmark struct locals, either.
VARSET_TP VARSET_INIT_NOCOPY(noUnmarkVars, trackedArgs);
for (unsigned i = 0; i < lvaCount; i++)
{
LclVarDsc* varDsc = &lvaTable[i];
if (varTypeIsStruct(varDsc) && varDsc->lvTracked)
{
VarSetOps::AddElemD(this, noUnmarkVars, varDsc->lvVarIndex);
}
}
fgUnmarkInScope(fgFirstBB, VarSetOps::Diff(this, fgFirstBB->bbScope, noUnmarkVars));
/*-------------------------------------------------------------------------
* As we keep variables artifically alive over their entire scope,
* we need to also artificially initialize them if the scope does
* not exactly match the real lifetimes, or they will contain
* garbage until they are initialized by the IL code.
*/
VARSET_TP VARSET_INIT_NOCOPY(initVars, VarSetOps::MakeEmpty(this)); // Vars which are artificially made alive
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
VarSetOps::ClearD(this, initVars);
switch (block->bbJumpKind)
{
case BBJ_NONE:
PREFIX_ASSUME(block->bbNext != nullptr);
VarSetOps::UnionD(this, initVars, block->bbNext->bbScope);
break;
case BBJ_ALWAYS:
case BBJ_EHCATCHRET:
case BBJ_EHFILTERRET:
VarSetOps::UnionD(this, initVars, block->bbJumpDest->bbScope);
break;
case BBJ_CALLFINALLY:
if (!(block->bbFlags & BBF_RETLESS_CALL))
{
assert(block->isBBCallAlwaysPair());
PREFIX_ASSUME(block->bbNext != nullptr);
VarSetOps::UnionD(this, initVars, block->bbNext->bbScope);
}
VarSetOps::UnionD(this, initVars, block->bbJumpDest->bbScope);
break;
case BBJ_COND:
PREFIX_ASSUME(block->bbNext != nullptr);
VarSetOps::UnionD(this, initVars, block->bbNext->bbScope);
VarSetOps::UnionD(this, initVars, block->bbJumpDest->bbScope);
break;
case BBJ_SWITCH:
{
BasicBlock** jmpTab;
unsigned jmpCnt;
jmpCnt = block->bbJumpSwt->bbsCount;
jmpTab = block->bbJumpSwt->bbsDstTab;
do
{
VarSetOps::UnionD(this, initVars, (*jmpTab)->bbScope);
} while (++jmpTab, --jmpCnt);
}
break;
case BBJ_EHFINALLYRET:
case BBJ_RETURN:
break;
case BBJ_THROW:
/* We don't have to do anything as we mark
* all vars live on entry to a catch handler as
* volatile anyway
*/
break;
default:
noway_assert(!"Unexpected bbJumpKind");
break;
}
/* If the var is already live on entry to the current BB,
we would have already initialized it. So ignore bbLiveIn */
VarSetOps::DiffD(this, initVars, block->bbLiveIn);
/* Add statements initializing the vars, if there are any to initialize */
unsigned blockWeight = block->getBBWeight(this);
VARSET_ITER_INIT(this, iter, initVars, varIndex);
while (iter.NextElem(this, &varIndex))
{
/* Create initialization tree */
unsigned varNum = lvaTrackedToVarNum[varIndex];
LclVarDsc* varDsc = &lvaTable[varNum];
var_types type = varDsc->TypeGet();
// Don't extend struct lifetimes -- they aren't enregistered, anyway.
if (type == TYP_STRUCT)
{
continue;
}
// If we haven't already done this ...
if (!fgLocalVarLivenessDone)
{
// Create a "zero" node
GenTree* zero = gtNewZeroConNode(genActualType(type));
// Create initialization node
if (!block->IsLIR())
{
GenTree* varNode = gtNewLclvNode(varNum, type);
GenTree* initNode = gtNewAssignNode(varNode, zero);
// Create a statement for the initializer, sequence it, and append it to the current BB.
GenTree* initStmt = gtNewStmt(initNode);
gtSetStmtInfo(initStmt);
fgSetStmtSeq(initStmt);
fgInsertStmtNearEnd(block, initStmt);
}
else
{
GenTree* store = new (this, GT_STORE_LCL_VAR) GenTreeLclVar(GT_STORE_LCL_VAR, type, varNum, BAD_IL_OFFSET);
store->gtOp.gtOp1 = zero;
store->gtFlags |= (GTF_VAR_DEF | GTF_ASG);
LIR::Range initRange = LIR::EmptyRange();
initRange.InsertBefore(nullptr, zero, store);
#if !defined(_TARGET_64BIT_) && !defined(LEGACY_BACKEND)
DecomposeLongs::DecomposeRange(this, blockWeight, initRange);
#endif
// Naively inserting the initializer at the end of the block may add code after the block's
// terminator, in which case the inserted code will never be executed (and the IR for the
// block will be invalid). Use `LIR::InsertBeforeTerminator` to avoid this problem.
LIR::InsertBeforeTerminator(block, std::move(initRange));
}
#ifdef DEBUG
if (verbose)
{
printf("Created zero-init of V%02u in BB%02u\n", varNum, block->bbNum);
}
#endif // DEBUG
varDsc->incRefCnts(block->getBBWeight(this), this);
block->bbFlags |= BBF_CHANGED; // indicates that the contents of the block have changed.
}
/* Update liveness information so that redoing fgLiveVarAnalysis()
will work correctly if needed */
VarSetOps::AddElemD(this, block->bbVarDef, varIndex);
VarSetOps::AddElemD(this, block->bbLiveOut, varIndex);
}
}
// raMarkStkVars() reserves stack space for unused variables (which
// needs to be initialized). However, arguments don't need to be initialized.
// So just ensure that they don't have a 0 ref cnt
unsigned lclNum = 0;
for (LclVarDsc *varDsc = lvaTable; lclNum < lvaCount; lclNum++, varDsc++)
{
if (varDsc->lvRefCnt == 0 && varDsc->lvIsRegArg)
{
varDsc->lvRefCnt = 1;
}
}
#ifdef DEBUG
if (verbose)
{
printf("\nBB liveness after fgExtendDbgLifetimes():\n\n");
fgDispBBLiveness();
printf("\n");
}
#endif // DEBUG
}
/*****************************************************************************/
#endif // DEBUGGING_SUPPORT
/*****************************************************************************/
VARSET_VALRET_TP Compiler::fgGetHandlerLiveVars(BasicBlock* block)
{
noway_assert(block);
noway_assert(ehBlockHasExnFlowDsc(block));
VARSET_TP VARSET_INIT_NOCOPY(liveVars, VarSetOps::MakeEmpty(this));
EHblkDsc* HBtab = ehGetBlockExnFlowDsc(block);
do
{
/* Either we enter the filter first or the catch/finally */
if (HBtab->HasFilter())
{
VarSetOps::UnionD(this, liveVars, HBtab->ebdFilter->bbLiveIn);
#if FEATURE_EH_FUNCLETS
// The EH subsystem can trigger a stack walk after the filter
// has returned, but before invoking the handler, and the only
// IP address reported from this method will be the original
// faulting instruction, thus everything in the try body
// must report as live any variables live-out of the filter
// (which is the same as those live-in to the handler)
VarSetOps::UnionD(this, liveVars, HBtab->ebdHndBeg->bbLiveIn);
#endif // FEATURE_EH_FUNCLETS
}
else
{
VarSetOps::UnionD(this, liveVars, HBtab->ebdHndBeg->bbLiveIn);
}
/* If we have nested try's edbEnclosing will provide them */
noway_assert((HBtab->ebdEnclosingTryIndex == EHblkDsc::NO_ENCLOSING_INDEX) ||
(HBtab->ebdEnclosingTryIndex > ehGetIndex(HBtab)));
unsigned outerIndex = HBtab->ebdEnclosingTryIndex;
if (outerIndex == EHblkDsc::NO_ENCLOSING_INDEX)
{
break;
}
HBtab = ehGetDsc(outerIndex);
} while (true);
return liveVars;
}
/*****************************************************************************
*
* This is the classic algorithm for Live Variable Analysis.
* If updateInternalOnly==true, only update BBF_INTERNAL blocks.
*/
void Compiler::fgLiveVarAnalysis(bool updateInternalOnly)
{
BasicBlock* block;
bool change;
#ifdef DEBUG
VARSET_TP VARSET_INIT_NOCOPY(extraLiveOutFromFinally, VarSetOps::MakeEmpty(this));
#endif // DEBUG
bool keepAliveThis = lvaKeepAliveAndReportThis() && lvaTable[info.compThisArg].lvTracked;
/* Live Variable Analysis - Backward dataflow */
bool hasPossibleBackEdge = false;
do
{
change = false;
/* Visit all blocks and compute new data flow values */
VARSET_TP VARSET_INIT_NOCOPY(liveIn, VarSetOps::MakeEmpty(this));
VARSET_TP VARSET_INIT_NOCOPY(liveOut, VarSetOps::MakeEmpty(this));
bool heapLiveIn = false;
bool heapLiveOut = false;
for (block = fgLastBB; block; block = block->bbPrev)
{
// sometimes block numbers are not monotonically increasing which
// would cause us not to identify backedges
if (block->bbNext && block->bbNext->bbNum <= block->bbNum)
{
hasPossibleBackEdge = true;
}
if (updateInternalOnly)
{
/* Only update BBF_INTERNAL blocks as they may be
syntactically out of sequence. */
noway_assert(opts.compDbgCode && (info.compVarScopesCount > 0));
if (!(block->bbFlags & BBF_INTERNAL))
{
continue;
}
}
/* Compute the 'liveOut' set */
VarSetOps::ClearD(this, liveOut);
heapLiveOut = false;
if (block->endsWithJmpMethod(this))
{
// A JMP uses all the arguments, so mark them all
// as live at the JMP instruction
//
const LclVarDsc* varDscEndParams = lvaTable + info.compArgsCount;
for (LclVarDsc* varDsc = lvaTable; varDsc < varDscEndParams; varDsc++)
{
noway_assert(!varDsc->lvPromoted);
if (varDsc->lvTracked)
{
VarSetOps::AddElemD(this, liveOut, varDsc->lvVarIndex);
}
}
}
// Additionally, union in all the live-in tracked vars of successors.
AllSuccessorIter succsEnd = block->GetAllSuccs(this).end();
for (AllSuccessorIter succs = block->GetAllSuccs(this).begin(); succs != succsEnd; ++succs)
{
BasicBlock* succ = (*succs);
VarSetOps::UnionD(this, liveOut, succ->bbLiveIn);
heapLiveOut = heapLiveOut || (*succs)->bbHeapLiveIn;
if (succ->bbNum <= block->bbNum)
{
hasPossibleBackEdge = true;
}
}
/* For lvaKeepAliveAndReportThis methods, "this" has to be kept alive everywhere
Note that a function may end in a throw on an infinite loop (as opposed to a return).
"this" has to be alive everywhere even in such methods. */
if (keepAliveThis)
{
VarSetOps::AddElemD(this, liveOut, lvaTable[info.compThisArg].lvVarIndex);
}
/* Compute the 'liveIn' set */
VarSetOps::Assign(this, liveIn, liveOut);
VarSetOps::DiffD(this, liveIn, block->bbVarDef);
VarSetOps::UnionD(this, liveIn, block->bbVarUse);
heapLiveIn = (heapLiveOut && !block->bbHeapDef) || block->bbHeapUse;
/* Can exceptions from this block be handled (in this function)? */
if (ehBlockHasExnFlowDsc(block))
{
VARSET_TP VARSET_INIT_NOCOPY(liveVars, fgGetHandlerLiveVars(block));
VarSetOps::UnionD(this, liveIn, liveVars);
VarSetOps::UnionD(this, liveOut, liveVars);
}
/* Has there been any change in either live set? */
if (!VarSetOps::Equal(this, block->bbLiveIn, liveIn) || !VarSetOps::Equal(this, block->bbLiveOut, liveOut))
{
if (updateInternalOnly)
{
// Only "extend" liveness over BBF_INTERNAL blocks
noway_assert(block->bbFlags & BBF_INTERNAL);
if (!VarSetOps::Equal(this, VarSetOps::Intersection(this, block->bbLiveIn, liveIn), liveIn) ||
!VarSetOps::Equal(this, VarSetOps::Intersection(this, block->bbLiveOut, liveOut), liveOut))
{
#ifdef DEBUG
if (verbose)
{
printf("Scope info: block BB%02u LiveIn+ ", block->bbNum);
dumpConvertedVarSet(this, VarSetOps::Diff(this, liveIn, block->bbLiveIn));
printf(", LiveOut+ ");
dumpConvertedVarSet(this, VarSetOps::Diff(this, liveOut, block->bbLiveOut));
printf("\n");
}
#endif // DEBUG
VarSetOps::UnionD(this, block->bbLiveIn, liveIn);
VarSetOps::UnionD(this, block->bbLiveOut, liveOut);
change = true;
}
}
else
{
VarSetOps::Assign(this, block->bbLiveIn, liveIn);
VarSetOps::Assign(this, block->bbLiveOut, liveOut);
change = true;
}
}
if ((block->bbHeapLiveIn == 1) != heapLiveIn || (block->bbHeapLiveOut == 1) != heapLiveOut)
{
block->bbHeapLiveIn = heapLiveIn;
block->bbHeapLiveOut = heapLiveOut;
change = true;
}
}
// if there is no way we could have processed a block without seeing all of its predecessors
// then there is no need to iterate
if (!hasPossibleBackEdge)
{
break;
}
} while (change);
//-------------------------------------------------------------------------
#ifdef DEBUG
if (verbose && !updateInternalOnly)
{
printf("\nBB liveness after fgLiveVarAnalysis():\n\n");
fgDispBBLiveness();
}
#endif // DEBUG
}
/*****************************************************************************
*
* Mark any variables in varSet1 as interfering with any variables
* specified in varSet2.
* We ensure that the interference graph is reflective:
* (if T11 interferes with T16, then T16 interferes with T11)
* returns true if an interference was added
* This function returns true if any new interferences were added
* and returns false if no new interference were added
*/
bool Compiler::fgMarkIntf(VARSET_VALARG_TP varSet1, VARSET_VALARG_TP varSet2)
{
#ifdef LEGACY_BACKEND
/* If either set has no bits set (or we are not optimizing), take an early out */
if (VarSetOps::IsEmpty(this, varSet2) || VarSetOps::IsEmpty(this, varSet1) || opts.MinOpts())
{
return false;
}
bool addedIntf = false; // This is set to true if we add any new interferences
VarSetOps::Assign(this, fgMarkIntfUnionVS, varSet1);
VarSetOps::UnionD(this, fgMarkIntfUnionVS, varSet2);
VARSET_ITER_INIT(this, iter, fgMarkIntfUnionVS, refIndex);
while (iter.NextElem(this, &refIndex))
{
// if varSet1 has this bit set then it interferes with varSet2
if (VarSetOps::IsMember(this, varSet1, refIndex))
{
// Calculate the set of new interference to add
VARSET_TP VARSET_INIT_NOCOPY(newIntf, VarSetOps::Diff(this, varSet2, lvaVarIntf[refIndex]));
if (!VarSetOps::IsEmpty(this, newIntf))
{
addedIntf = true;
VarSetOps::UnionD(this, lvaVarIntf[refIndex], newIntf);
}
}
// if varSet2 has this bit set then it interferes with varSet1
if (VarSetOps::IsMember(this, varSet2, refIndex))
{
// Calculate the set of new interference to add
VARSET_TP VARSET_INIT_NOCOPY(newIntf, VarSetOps::Diff(this, varSet1, lvaVarIntf[refIndex]));
if (!VarSetOps::IsEmpty(this, newIntf))
{
addedIntf = true;
VarSetOps::UnionD(this, lvaVarIntf[refIndex], newIntf);
}
}
}
return addedIntf;
#else
return false;
#endif
}
/*****************************************************************************
*
* Mark any variables in varSet as interfering with each other,
* This is a specialized version of the above, when both args are the same
* We ensure that the interference graph is reflective:
* (if T11 interferes with T16, then T16 interferes with T11)
* This function returns true if any new interferences were added
* and returns false if no new interference were added
*/
bool Compiler::fgMarkIntf(VARSET_VALARG_TP varSet)
{
#ifdef LEGACY_BACKEND
/* No bits set or we are not optimizing, take an early out */
if (VarSetOps::IsEmpty(this, varSet) || opts.MinOpts())
return false;
bool addedIntf = false; // This is set to true if we add any new interferences
VARSET_ITER_INIT(this, iter, varSet, refIndex);
while (iter.NextElem(this, &refIndex))
{
// Calculate the set of new interference to add
VARSET_TP VARSET_INIT_NOCOPY(newIntf, VarSetOps::Diff(this, varSet, lvaVarIntf[refIndex]));
if (!VarSetOps::IsEmpty(this, newIntf))
{
addedIntf = true;
VarSetOps::UnionD(this, lvaVarIntf[refIndex], newIntf);
}
}
return addedIntf;
#else // !LEGACY_BACKEND
return false;
#endif // !LEGACY_BACKEND
}
/*****************************************************************************
* For updating liveset during traversal AFTER fgComputeLife has completed
*/
VARSET_VALRET_TP Compiler::fgUpdateLiveSet(VARSET_VALARG_TP liveSet, GenTreePtr tree)
{
VARSET_TP VARSET_INIT(this, newLiveSet, liveSet);
assert(fgLocalVarLivenessDone == true);
GenTreePtr lclVarTree = tree; // After the tests below, "lclVarTree" will be the local variable.
if (tree->gtOper == GT_LCL_VAR || tree->gtOper == GT_LCL_FLD || tree->gtOper == GT_REG_VAR ||
(lclVarTree = fgIsIndirOfAddrOfLocal(tree)) != nullptr)
{
VARSET_TP VARSET_INIT_NOCOPY(varBits, fgGetVarBits(lclVarTree));
if (!VarSetOps::IsEmpty(this, varBits))
{
if (tree->gtFlags & GTF_VAR_DEATH)
{
// We'd like to be able to assert the following, however if we are walking
// through a qmark/colon tree, we may encounter multiple last-use nodes.
// assert (VarSetOps::IsSubset(this, varBits, newLiveSet));
// We maintain the invariant that if the lclVarTree is a promoted struct, but the
// the lookup fails, then all the field vars (i.e., "varBits") are dying.
VARSET_TP* deadVarBits = nullptr;
if (varTypeIsStruct(lclVarTree) && GetPromotedStructDeathVars()->Lookup(lclVarTree, &deadVarBits))
{
VarSetOps::DiffD(this, newLiveSet, *deadVarBits);
}
else
{
VarSetOps::DiffD(this, newLiveSet, varBits);
}
}
else if ((tree->gtFlags & GTF_VAR_DEF) != 0 && (tree->gtFlags & GTF_VAR_USEASG) == 0)
{
assert(tree == lclVarTree); // LDOBJ case should only be a use.
// This shouldn't be in newLiveSet, unless this is debug code, in which
// case we keep vars live everywhere, OR it is address-exposed, OR this block
// is part of a try block, in which case it may be live at the handler
// Could add a check that, if it's in the newLiveSet, that it's also in
// fgGetHandlerLiveVars(compCurBB), but seems excessive
//
assert(VarSetOps::IsEmptyIntersection(this, newLiveSet, varBits) || opts.compDbgCode ||
lvaTable[tree->gtLclVarCommon.gtLclNum].lvAddrExposed ||
(compCurBB != nullptr && ehBlockHasExnFlowDsc(compCurBB)));
VarSetOps::UnionD(this, newLiveSet, varBits);
}
}
}
return newLiveSet;
}
//------------------------------------------------------------------------
// Compiler::fgComputeLifeCall: compute the changes to local var liveness
// due to a GT_CALL node.
//
// Arguments:
// life - The live set that is being computed.
// call - The call node in question.
//
void Compiler::fgComputeLifeCall(VARSET_TP& life, GenTreeCall* call)
{
assert(call != nullptr);
// If this is a tail-call and we have any unmanaged p/invoke calls in
// the method then we're going to run the p/invoke epilog
// So we mark the FrameRoot as used by this instruction.
// This ensure that this variable is kept alive at the tail-call
if (call->IsTailCall() && info.compCallUnmanaged)
{
assert((!opts.ShouldUsePInvokeHelpers()) || (info.compLvFrameListRoot == BAD_VAR_NUM));
if (!opts.ShouldUsePInvokeHelpers())
{
/* Get the TCB local and make it live */
noway_assert(info.compLvFrameListRoot < lvaCount);
LclVarDsc* frameVarDsc = &lvaTable[info.compLvFrameListRoot];
if (frameVarDsc->lvTracked)
{
VARSET_TP VARSET_INIT_NOCOPY(varBit, VarSetOps::MakeSingleton(this, frameVarDsc->lvVarIndex));
VarSetOps::AddElemD(this, life, frameVarDsc->lvVarIndex);
/* Record interference with other live variables */
fgMarkIntf(life, varBit);
}
}
}
/* GC refs cannot be enregistered accross an unmanaged call */
// TODO: we should generate the code for saving to/restoring
// from the inlined N/Direct frame instead.
/* Is this call to unmanaged code? */
if (call->IsUnmanaged())
{
/* Get the TCB local and make it live */
assert((!opts.ShouldUsePInvokeHelpers()) || (info.compLvFrameListRoot == BAD_VAR_NUM));
if (!opts.ShouldUsePInvokeHelpers())
{
noway_assert(info.compLvFrameListRoot < lvaCount);
LclVarDsc* frameVarDsc = &lvaTable[info.compLvFrameListRoot];
if (frameVarDsc->lvTracked)
{
unsigned varIndex = frameVarDsc->lvVarIndex;
noway_assert(varIndex < lvaTrackedCount);
// Is the variable already known to be alive?
//
if (VarSetOps::IsMember(this, life, varIndex))
{
// Since we may call this multiple times, clear the GTF_CALL_M_FRAME_VAR_DEATH if set.
//
call->gtCallMoreFlags &= ~GTF_CALL_M_FRAME_VAR_DEATH;
}
else
{
// The variable is just coming to life
// Since this is a backwards walk of the trees
// that makes this change in liveness a 'last-use'
//
VarSetOps::AddElemD(this, life, varIndex);
call->gtCallMoreFlags |= GTF_CALL_M_FRAME_VAR_DEATH;
}
// Record an interference with the other live variables
//
VARSET_TP VARSET_INIT_NOCOPY(varBit, VarSetOps::MakeSingleton(this, varIndex));
fgMarkIntf(life, varBit);
}
}
/* Do we have any live variables? */
if (!VarSetOps::IsEmpty(this, life))
{
// For each live variable if it is a GC-ref type, we
// mark it volatile to prevent if from being enregistered
// across the unmanaged call.
unsigned lclNum;
LclVarDsc* varDsc;
for (lclNum = 0, varDsc = lvaTable; lclNum < lvaCount; lclNum++, varDsc++)
{
/* Ignore the variable if it's not tracked */
if (!varDsc->lvTracked)
{
continue;
}
unsigned varNum = varDsc->lvVarIndex;
/* Ignore the variable if it's not live here */
if (!VarSetOps::IsMember(this, life, varDsc->lvVarIndex))
{
continue;
}
// If it is a GC-ref type then mark it DoNotEnregister.
if (varTypeIsGC(varDsc->TypeGet()))
{
lvaSetVarDoNotEnregister(lclNum DEBUGARG(DNER_LiveAcrossUnmanagedCall));
}
}
}
}
}
//------------------------------------------------------------------------
// Compiler::fgComputeLifeLocal: compute the changes to local var liveness
// due to a use or a def of a local var and
// indicates wither the use/def is a dead
// store.
//
// Arguments:
// life - The live set that is being computed.
// keepAliveVars - The currents set of variables to keep alive
// regardless of their actual lifetime.
// lclVarNode - The node that corresponds to the local var def or
// use. Only differs from `node` when targeting the
// legacy backend.
// node - The actual tree node being processed.
//
// Returns:
// `true` if the local var node corresponds to a dead store; `false`
// otherwise.
//
bool Compiler::fgComputeLifeLocal(VARSET_TP& life, VARSET_TP& keepAliveVars, GenTree* lclVarNode, GenTree* node)
{
unsigned lclNum = lclVarNode->gtLclVarCommon.gtLclNum;
noway_assert(lclNum < lvaCount);
LclVarDsc* varDsc = &lvaTable[lclNum];
unsigned varIndex;
VARSET_TP varBit;
// Is this a tracked variable?
if (varDsc->lvTracked)
{
varIndex = varDsc->lvVarIndex;
noway_assert(varIndex < lvaTrackedCount);
/* Is this a definition or use? */
if (lclVarNode->gtFlags & GTF_VAR_DEF)
{
/*
The variable is being defined here. The variable
should be marked dead from here until its closest
previous use.
IMPORTANT OBSERVATION:
For GTF_VAR_USEASG (i.e. x <op>= a) we cannot
consider it a "pure" definition because it would
kill x (which would be wrong because x is
"used" in such a construct) -> see below the case when x is live
*/
if (VarSetOps::IsMember(this, life, varIndex))
{
/* The variable is live */
if ((lclVarNode->gtFlags & GTF_VAR_USEASG) == 0)
{
/* Mark variable as dead from here to its closest use */
if (!VarSetOps::IsMember(this, keepAliveVars, varIndex))
{
VarSetOps::RemoveElemD(this, life, varIndex);
}
#ifdef DEBUG
if (verbose && 0)
{
printf("Def V%02u,T%02u at ", lclNum, varIndex);
printTreeID(lclVarNode);
printf(" life %s -> %s\n",
VarSetOps::ToString(this, VarSetOps::Union(this, life,
VarSetOps::MakeSingleton(this, varIndex))),
VarSetOps::ToString(this, life));
}
#endif // DEBUG
}
}
else
{
/* Dead assignment to the variable */
lclVarNode->gtFlags |= GTF_VAR_DEATH;
if (!opts.MinOpts())
{
// keepAliveVars always stay alive
noway_assert(!VarSetOps::IsMember(this, keepAliveVars, varIndex));
/* This is a dead store unless the variable is marked
GTF_VAR_USEASG and we are in an interior statement
that will be used (e.g. while (i++) or a GT_COMMA) */
// Do not consider this store dead if the target local variable represents
// a promoted struct field of an address exposed local or if the address
// of the variable has been exposed. Improved alias analysis could allow
// stores to these sorts of variables to be removed at the cost of compile
// time.
return !varDsc->lvAddrExposed &&
!(varDsc->lvIsStructField && lvaTable[varDsc->lvParentLcl].lvAddrExposed);
}
}
return false;
}
else // it is a use
{
// Is the variable already known to be alive?
if (VarSetOps::IsMember(this, life, varIndex))
{
// Since we may do liveness analysis multiple times, clear the GTF_VAR_DEATH if set.
lclVarNode->gtFlags &= ~GTF_VAR_DEATH;
return false;
}
#ifdef DEBUG
if (verbose && 0)
{
printf("Ref V%02u,T%02u] at ", lclNum, varIndex);
printTreeID(node);
printf(" life %s -> %s\n", VarSetOps::ToString(this, life),
VarSetOps::ToString(this, VarSetOps::Union(this, life, varBit)));
}
#endif // DEBUG
// The variable is being used, and it is not currently live.
// So the variable is just coming to life
lclVarNode->gtFlags |= GTF_VAR_DEATH;
VarSetOps::AddElemD(this, life, varIndex);
// Record interference with other live variables
fgMarkIntf(life, VarSetOps::MakeSingleton(this, varIndex));
}
}
// Note that promoted implies not tracked (i.e. only the fields are tracked).
else if (varTypeIsStruct(varDsc->lvType))
{
noway_assert(!varDsc->lvTracked);
lvaPromotionType promotionType = lvaGetPromotionType(varDsc);
if (promotionType != PROMOTION_TYPE_NONE)
{
VarSetOps::AssignNoCopy(this, varBit, VarSetOps::MakeEmpty(this));
for (unsigned i = varDsc->lvFieldLclStart; i < varDsc->lvFieldLclStart + varDsc->lvFieldCnt; ++i)
{
#if !defined(_TARGET_64BIT_) && !defined(LEGACY_BACKEND)
if (!varTypeIsLong(lvaTable[i].lvType) || !lvaTable[i].lvPromoted)
#endif // !defined(_TARGET_64BIT_) && !defined(LEGACY_BACKEND)
{
noway_assert(lvaTable[i].lvIsStructField);
}
if (lvaTable[i].lvTracked)
{
varIndex = lvaTable[i].lvVarIndex;
noway_assert(varIndex < lvaTrackedCount);
VarSetOps::AddElemD(this, varBit, varIndex);
}
}
if (node->gtFlags & GTF_VAR_DEF)
{
VarSetOps::DiffD(this, varBit, keepAliveVars);
VarSetOps::DiffD(this, life, varBit);
return false;
}
// This is a use.
// Are the variables already known to be alive?
if (VarSetOps::IsSubset(this, varBit, life))
{
node->gtFlags &= ~GTF_VAR_DEATH; // Since we may now call this multiple times, reset if live.
return false;
}
// Some variables are being used, and they are not currently live.
// So they are just coming to life, in the backwards traversal; in a forwards
// traversal, one or more are dying. Mark this.
node->gtFlags |= GTF_VAR_DEATH;
// Are all the variables becoming alive (in the backwards traversal), or just a subset?
if (!VarSetOps::IsEmptyIntersection(this, varBit, life))
{
// Only a subset of the variables are become live; we must record that subset.
// (Lack of an entry for "lclVarNode" will be considered to imply all become dead in the
// forward traversal.)
VARSET_TP* deadVarSet = new (this, CMK_bitset) VARSET_TP;
VarSetOps::AssignNoCopy(this, *deadVarSet, VarSetOps::Diff(this, varBit, life));
GetPromotedStructDeathVars()->Set(lclVarNode, deadVarSet);
}
// In any case, all the field vars are now live (in the backwards traversal).
VarSetOps::UnionD(this, life, varBit);
// Record interference with other live variables
fgMarkIntf(life, varBit);
}
}
return false;
}
/*****************************************************************************
*
* Compute the set of live variables at each node in a given statement
* or subtree of a statement moving backward from startNode to endNode
*/
#ifndef LEGACY_BACKEND
VARSET_VALRET_TP Compiler::fgComputeLife(VARSET_VALARG_TP lifeArg,
GenTreePtr startNode,
GenTreePtr endNode,
VARSET_VALARG_TP volatileVars,
bool* pStmtInfoDirty DEBUGARG(bool* treeModf))
{
GenTreePtr tree;
unsigned lclNum;
VARSET_TP VARSET_INIT(this, life, lifeArg); // lifeArg is const ref; copy to allow modification.
VARSET_TP VARSET_INIT(this, keepAliveVars, volatileVars);
#ifdef DEBUGGING_SUPPORT
VarSetOps::UnionD(this, keepAliveVars, compCurBB->bbScope); // Don't kill vars in scope
#endif
noway_assert(VarSetOps::Equal(this, VarSetOps::Intersection(this, keepAliveVars, life), keepAliveVars));
noway_assert(compCurStmt->gtOper == GT_STMT);
noway_assert(endNode || (startNode == compCurStmt->gtStmt.gtStmtExpr));
// NOTE: Live variable analysis will not work if you try
// to use the result of an assignment node directly!
for (tree = startNode; tree != endNode; tree = tree->gtPrev)
{
AGAIN:
assert(tree->OperGet() != GT_QMARK);
if (tree->gtOper == GT_CALL)
{
fgComputeLifeCall(life, tree->AsCall());
}
else if (tree->OperIsNonPhiLocal() || tree->OperIsLocalAddr())
{
bool isDeadStore = fgComputeLifeLocal(life, keepAliveVars, tree, tree);
if (isDeadStore)
{
LclVarDsc* varDsc = &lvaTable[tree->gtLclVarCommon.gtLclNum];
bool doAgain = false;
if (fgRemoveDeadStore(&tree, varDsc, life, &doAgain, pStmtInfoDirty DEBUGARG(treeModf)))
{
assert(!doAgain);
break;
}
if (doAgain)
{
goto AGAIN;
}
}
}
}
// Return the set of live variables out of this statement
return life;
}
VARSET_VALRET_TP Compiler::fgComputeLifeLIR(VARSET_VALARG_TP lifeArg, BasicBlock* block, VARSET_VALARG_TP volatileVars)
{
VARSET_TP VARSET_INIT(this, life, lifeArg); // lifeArg is const ref; copy to allow modification.
VARSET_TP VARSET_INIT(this, keepAliveVars, volatileVars);
#ifdef DEBUGGING_SUPPORT
VarSetOps::UnionD(this, keepAliveVars, block->bbScope); // Don't kill vars in scope
#endif
noway_assert(VarSetOps::Equal(this, VarSetOps::Intersection(this, keepAliveVars, life), keepAliveVars));
LIR::Range& blockRange = LIR::AsRange(block);
GenTree* firstNonPhiNode = blockRange.FirstNonPhiNode();
if (firstNonPhiNode == nullptr)
{
return life;
}
for (GenTree *node = blockRange.LastNode(), *next = nullptr, *end = firstNonPhiNode->gtPrev; node != end;
node = next)
{
next = node->gtPrev;
if (node->OperGet() == GT_CALL)
{
fgComputeLifeCall(life, node->AsCall());
}
else if (node->OperIsNonPhiLocal() || node->OperIsLocalAddr())
{
bool isDeadStore = fgComputeLifeLocal(life, keepAliveVars, node, node);
if (isDeadStore)
{
fgTryRemoveDeadLIRStore(blockRange, node, &next);
}
}
}
return life;
}
#else // LEGACY_BACKEND
#ifdef _PREFAST_
#pragma warning(push)
#pragma warning(disable : 21000) // Suppress PREFast warning about overly large function
#endif
VARSET_VALRET_TP Compiler::fgComputeLife(VARSET_VALARG_TP lifeArg,
GenTreePtr startNode,
GenTreePtr endNode,
VARSET_VALARG_TP volatileVars,
bool* pStmtInfoDirty DEBUGARG(bool* treeModf))
{
GenTreePtr tree;
unsigned lclNum;
GenTreePtr gtQMark = NULL; // current GT_QMARK node (walking the trees backwards)
GenTreePtr nextColonExit = 0; // gtQMark->gtOp.gtOp2 while walking the 'else' branch.
// gtQMark->gtOp.gtOp1 while walking the 'then' branch
VARSET_TP VARSET_INIT(this, life, lifeArg); // lifeArg is const ref; copy to allow modification.
// TBD: This used to be an initialization to VARSET_NOT_ACCEPTABLE. Try to figure out what's going on here.
VARSET_TP VARSET_INIT_NOCOPY(entryLiveSet, VarSetOps::MakeFull(this)); // liveness when we see gtQMark
VARSET_TP VARSET_INIT_NOCOPY(gtColonLiveSet, VarSetOps::MakeFull(this)); // liveness when we see gtColon
GenTreePtr gtColon = NULL;
VARSET_TP VARSET_INIT(this, keepAliveVars, volatileVars);
#ifdef DEBUGGING_SUPPORT
VarSetOps::UnionD(this, keepAliveVars, compCurBB->bbScope); /* Dont kill vars in scope */
#endif
noway_assert(VarSetOps::Equal(this, VarSetOps::Intersection(this, keepAliveVars, life), keepAliveVars));
noway_assert(compCurStmt->gtOper == GT_STMT);
noway_assert(endNode || (startNode == compCurStmt->gtStmt.gtStmtExpr));
/* NOTE: Live variable analysis will not work if you try
* to use the result of an assignment node directly */
for (tree = startNode; tree != endNode; tree = tree->gtPrev)
{
AGAIN:
/* For ?: nodes if we're done with the then branch, remember
* the liveness */
if (gtQMark && (tree == gtColon))
{
VarSetOps::Assign(this, gtColonLiveSet, life);
VarSetOps::Assign(this, gtQMark->gtQmark.gtThenLiveSet, gtColonLiveSet);
}
/* For ?: nodes if we're done with the else branch
* then set the correct life as the union of the two branches */
if (gtQMark && (tree == gtQMark->gtOp.gtOp1))
{
noway_assert(tree->gtFlags & GTF_RELOP_QMARK);
noway_assert(gtQMark->gtOp.gtOp2->gtOper == GT_COLON);
GenTreePtr thenNode = gtColon->AsColon()->ThenNode();
GenTreePtr elseNode = gtColon->AsColon()->ElseNode();
noway_assert(thenNode && elseNode);
VarSetOps::Assign(this, gtQMark->gtQmark.gtElseLiveSet, life);
/* Check if we optimized away the ?: */
if (elseNode->IsNothingNode())
{
if (thenNode->IsNothingNode())
{
/* This can only happen for VOID ?: */
noway_assert(gtColon->gtType == TYP_VOID);
#ifdef DEBUG
if (verbose)
{
printf("BB%02u - Removing dead QMark - Colon ...\n", compCurBB->bbNum);
gtDispTree(gtQMark);
printf("\n");
}
#endif // DEBUG
/* Remove the '?:' - keep the side effects in the condition */
noway_assert(tree->OperKind() & GTK_RELOP);
/* Change the node to a NOP */
gtQMark->gtBashToNOP();
#ifdef DEBUG
*treeModf = true;
#endif // DEBUG
/* Extract and keep the side effects */
if (tree->gtFlags & GTF_SIDE_EFFECT)
{
GenTreePtr sideEffList = NULL;
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 // DEBUG
fgUpdateRefCntForExtract(tree, sideEffList);
/* The NOP node becomes a GT_COMMA holding the side effect list */
gtQMark->ChangeOper(GT_COMMA);
gtQMark->gtFlags |= sideEffList->gtFlags & GTF_ALL_EFFECT;
if (sideEffList->gtOper == GT_COMMA)
{
gtQMark->gtOp.gtOp1 = sideEffList->gtOp.gtOp1;
gtQMark->gtOp.gtOp2 = sideEffList->gtOp.gtOp2;
}
else
{
gtQMark->gtOp.gtOp1 = sideEffList;
gtQMark->gtOp.gtOp2 = gtNewNothingNode();
}
}
else
{
#ifdef DEBUG
if (verbose)
{
printf("\nRemoving tree ");
printTreeID(tree);
printf(" in BB%02u as useless\n", compCurBB->bbNum);
gtDispTree(tree);
printf("\n");
}
#endif // DEBUG
fgUpdateRefCntForExtract(tree, NULL);
}
}
/* If top node without side effects remove it */
if ((gtQMark == compCurStmt->gtStmt.gtStmtExpr) && gtQMark->IsNothingNode())
{
fgRemoveStmt(compCurBB, compCurStmt);
break;
}
/* Re-link the nodes for this statement */
fgSetStmtSeq(compCurStmt);
/* Continue analysis from this node */
tree = gtQMark;
/* As the 'then' and 'else' branches are emtpy, liveness
should not have changed */
noway_assert(VarSetOps::Equal(this, life, entryLiveSet));
goto SKIP_QMARK;
}
else
{
// The 'else' branch is empty and the 'then' branch is non-empty
// so swap the two branches and reverse the condition. If one is
// non-empty, we want it to be the 'else'
GenTreePtr tmp = thenNode;
gtColon->AsColon()->ThenNode() = thenNode = elseNode;
gtColon->AsColon()->ElseNode() = elseNode = tmp;
noway_assert(tree == gtQMark->gtOp.gtOp1);
gtReverseCond(tree);
// Remember to also swap the live sets of the two branches.
VARSET_TP VARSET_INIT_NOCOPY(tmpVS, gtQMark->gtQmark.gtElseLiveSet);
VarSetOps::AssignNoCopy(this, gtQMark->gtQmark.gtElseLiveSet, gtQMark->gtQmark.gtThenLiveSet);
VarSetOps::AssignNoCopy(this, gtQMark->gtQmark.gtThenLiveSet, tmpVS);
/* Re-link the nodes for this statement */
fgSetStmtSeq(compCurStmt);
}
}
/* Variables in the two branches that are live at the split
* must interfere with each other */
fgMarkIntf(life, gtColonLiveSet);
/* The live set at the split is the union of the two branches */
VarSetOps::UnionD(this, life, gtColonLiveSet);
SKIP_QMARK:
/* We are out of the parallel branches, the rest is sequential */
gtQMark = NULL;
}
if (tree->gtOper == GT_CALL)
{
fgComputeLifeCall(life, tree->AsCall());
continue;
}
// Is this a use/def of a local variable?
// Generally, the last use information is associated with the lclVar node.
// However, for LEGACY_BACKEND, the information must be associated
// with the OBJ itself for promoted structs.
// In that case, the LDOBJ may be require an implementation that might itself allocate registers,
// so the variable(s) should stay live until the end of the LDOBJ.
// Note that for promoted structs lvTracked is false.
GenTreePtr lclVarTree = nullptr;
if (tree->gtOper == GT_OBJ)
{
// fgIsIndirOfAddrOfLocal returns nullptr if the tree is
// not an indir(addr(local)), in which case we will set lclVarTree
// back to the original tree, and not handle it as a use/def.
lclVarTree = fgIsIndirOfAddrOfLocal(tree);
if ((lclVarTree != nullptr) && lvaTable[lclVarTree->gtLclVarCommon.gtLclNum].lvTracked)
{
lclVarTree = nullptr;
}
}
if (lclVarTree == nullptr)
{
lclVarTree = tree;
}
if (lclVarTree->OperIsNonPhiLocal() || lclVarTree->OperIsLocalAddr())
{
bool isDeadStore = fgComputeLifeLocal(life, keepAliveVars, lclVarTree, tree);
if (isDeadStore)
{
LclVarDsc* varDsc = &lvaTable[lclVarTree->gtLclVarCommon.gtLclNum];
bool doAgain = false;
if (fgRemoveDeadStore(&tree, varDsc, life, &doAgain, pStmtInfoDirty DEBUGARG(treeModf)))
{
assert(!doAgain);
break;
}
if (doAgain)
{
goto AGAIN;
}
}
}
else
{
if (tree->gtOper == GT_QMARK && tree->gtOp.gtOp1)
{
/* Special cases - "? :" operators.
The trees are threaded as shown below with nodes 1 to 11 linked
by gtNext. Both GT_<cond>->gtLiveSet and GT_COLON->gtLiveSet are
the union of the liveness on entry to thenTree and elseTree.
+--------------------+
| GT_QMARK 11|
+----------+---------+
|
*
/ \
/ \
/ \
+---------------------+ +--------------------+
| GT_<cond> 3 | | GT_COLON 7 |
| w/ GTF_RELOP_QMARK | | w/ GTF_COLON_COND |
+----------+----------+ +---------+----------+
| |
* *
/ \ / \
/ \ / \
/ \ / \
2 1 thenTree 6 elseTree 10
x | |
/ * *
+----------------+ / / \ / \
|prevExpr->gtNext+------/ / \ / \
+----------------+ / \ / \
5 4 9 8
*/
noway_assert(tree->gtOp.gtOp1->OperKind() & GTK_RELOP);
noway_assert(tree->gtOp.gtOp1->gtFlags & GTF_RELOP_QMARK);
noway_assert(tree->gtOp.gtOp2->gtOper == GT_COLON);
if (gtQMark)
{
/* This is a nested QMARK sequence - we need to use recursion.
* Compute the liveness for each node of the COLON branches
* The new computation starts from the GT_QMARK node and ends
* when the COLON branch of the enclosing QMARK ends */
noway_assert(nextColonExit &&
(nextColonExit == gtQMark->gtOp.gtOp1 || nextColonExit == gtQMark->gtOp.gtOp2));
VarSetOps::AssignNoCopy(this, life, fgComputeLife(life, tree, nextColonExit, volatileVars,
pStmtInfoDirty DEBUGARG(treeModf)));
/* Continue with exit node (the last node in the enclosing colon branch) */
tree = nextColonExit;
goto AGAIN;
}
else
{
gtQMark = tree;
VarSetOps::Assign(this, entryLiveSet, life);
gtColon = gtQMark->gtOp.gtOp2;
nextColonExit = gtColon;
}
}
/* If found the GT_COLON, start the new branch with the original life */
if (gtQMark && tree == gtQMark->gtOp.gtOp2)
{
/* The node better be a COLON. */
noway_assert(tree->gtOper == GT_COLON);
VarSetOps::Assign(this, life, entryLiveSet);
nextColonExit = gtQMark->gtOp.gtOp1;
}
}
}
/* Return the set of live variables out of this statement */
return life;
}
#ifdef _PREFAST_
#pragma warning(pop)
#endif
#endif // !LEGACY_BACKEND
bool Compiler::fgTryRemoveDeadLIRStore(LIR::Range& blockRange, GenTree* node, GenTree** next)
{
assert(node != nullptr);
assert(next != nullptr);
assert(node->OperIsLocalStore() || node->OperIsLocalAddr());
GenTree* store = nullptr;
GenTree* value = nullptr;
if (node->OperIsLocalStore())
{
store = node;
value = store->gtGetOp1();
}
else if (node->OperIsLocalAddr())
{
LIR::Use addrUse;
if (!blockRange.TryGetUse(node, &addrUse) || (addrUse.User()->OperGet() != GT_STOREIND))
{
*next = node->gtPrev;
return false;
}
store = addrUse.User();
value = store->gtGetOp2();
}
bool isClosed = false;
unsigned sideEffects = 0;
LIR::ReadOnlyRange operandsRange = blockRange.GetRangeOfOperandTrees(store, &isClosed, &sideEffects);
if (!isClosed || ((sideEffects & GTF_SIDE_EFFECT) != 0) ||
(((sideEffects & GTF_ORDER_SIDEEFF) != 0) && (value->OperGet() == GT_CATCH_ARG)))
{
// If the range of the operands contains unrelated code or if it contains any side effects,
// do not remove it. Instead, just remove the store.
*next = node->gtPrev;
}
else
{
// Okay, the operands to the store form a contiguous range that has no side effects. Remove the
// range containing the operands and decrement the local var ref counts appropriately.
// Compute the next node to process. Note that we must be careful not to set the next node to
// process to a node that we are about to remove.
if (node->OperIsLocalStore())
{
assert(node == store);
*next = (operandsRange.LastNode()->gtNext == store) ? operandsRange.FirstNode()->gtPrev : node->gtPrev;
}
else
{
assert(operandsRange.Contains(node));
*next = operandsRange.FirstNode()->gtPrev;
}
blockRange.Delete(this, compCurBB, std::move(operandsRange));
}
// If the store is marked as a late argument, it is referenced by a call. Instead of removing it,
// bash it to a NOP.
if ((store->gtFlags & GTF_LATE_ARG) != 0)
{
if (store->IsLocal())
{
lvaDecRefCnts(compCurBB, store);
}
store->gtBashToNOP();
}
else
{
blockRange.Delete(this, compCurBB, store);
}
return true;
}
// fgRemoveDeadStore - remove a store to a local which has no exposed uses.
//
// pTree - GenTree** to local, including store-form local or local addr (post-rationalize)
// varDsc - var that is being stored to
// life - current live tracked vars (maintained as we walk backwards)
// doAgain - out parameter, true if we should restart the statement
// pStmtInfoDirty - should defer the cost computation to the point after the reverse walk is completed?
//
// Returns: true if we should skip the rest of the statement, false if we should continue
bool Compiler::fgRemoveDeadStore(
GenTree** pTree, LclVarDsc* varDsc, VARSET_TP life, bool* doAgain, bool* pStmtInfoDirty DEBUGARG(bool* treeModf))
{
assert(!compRationalIRForm);
// Vars should have already been checked for address exposure by this point.
assert(!varDsc->lvIsStructField || !lvaTable[varDsc->lvParentLcl].lvAddrExposed);
assert(!varDsc->lvAddrExposed);
GenTree* asgNode = nullptr;
GenTree* rhsNode = nullptr;
GenTree* addrNode = nullptr;
GenTree* const tree = *pTree;
GenTree* nextNode = tree->gtNext;
// First, characterize the lclVarTree and see if we are taking its address.
if (tree->OperIsLocalStore())
{
rhsNode = tree->gtOp.gtOp1;
asgNode = tree;
}
else if (tree->OperIsLocal())
{
if (nextNode == nullptr)
{
return false;
}
if (nextNode->OperGet() == GT_ADDR)
{
addrNode = nextNode;
nextNode = nextNode->gtNext;
}
}
else
{
assert(tree->OperIsLocalAddr());
addrNode = tree;
}
// Next, find the assignment.
if (asgNode == nullptr)
{
if (addrNode == nullptr)
{
asgNode = nextNode;
}
else if (asgNode == nullptr)
{
// This may be followed by GT_IND/assign or GT_STOREIND.
if (nextNode == nullptr)
{
return false;
}
if (nextNode->OperIsIndir())
{
// This must be a non-nullcheck form of indir, or it would not be a def.
assert(nextNode->OperGet() != GT_NULLCHECK);
if (nextNode->OperIsStore())
{
asgNode = nextNode;
if (asgNode->OperIsBlk())
{
rhsNode = asgNode->AsBlk()->Data();
}
// TODO-1stClassStructs: There should be an else clause here to handle
// the non-block forms of store ops (GT_STORE_LCL_VAR, etc.) for which
// rhsNode is op1. (This isn't really a 1stClassStructs item, but the
// above was added to catch what used to be dead block ops, and that
// made this omission apparent.)
}
else
{
asgNode = nextNode->gtNext;
}
}
}
}
if (asgNode == nullptr)
{
return false;
}
if (asgNode->OperIsAssignment())
{
rhsNode = asgNode->gtGetOp2();
}
else if (rhsNode == nullptr)
{
return false;
}
if (asgNode && (asgNode->gtFlags & GTF_ASG))
{
noway_assert(rhsNode);
noway_assert(tree->gtFlags & GTF_VAR_DEF);
if (asgNode->gtOper != GT_ASG && asgNode->gtOverflowEx())
{
// asgNode may be <op_ovf>= (with GTF_OVERFLOW). In that case, we need to keep the <op_ovf>
// Dead <OpOvf>= assignment. We change it to the right operation (taking out the assignment),
// update the flags, update order of statement, as we have changed the order of the operation
// and we start computing life again from the op_ovf node (we go backwards). Note that we
// don't need to update ref counts because we don't change them, we're only changing the
// operation.
CLANG_FORMAT_COMMENT_ANCHOR;
#ifdef DEBUG
if (verbose)
{
printf("\nChanging dead <asgop> ovf to <op> ovf...\n");
}
#endif // DEBUG
switch (asgNode->gtOper)
{
case GT_ASG_ADD:
asgNode->SetOperRaw(GT_ADD);
break;
case GT_ASG_SUB:
asgNode->SetOperRaw(GT_SUB);
break;
default:
// Only add and sub allowed, we don't have ASG_MUL and ASG_DIV for ints, and
// floats don't allow OVF forms.
noway_assert(!"Unexpected ASG_OP");
}
asgNode->gtFlags &= ~GTF_REVERSE_OPS;
if (!((asgNode->gtOp.gtOp1->gtFlags | rhsNode->gtFlags) & GTF_ASG))
{
asgNode->gtFlags &= ~GTF_ASG;
}
asgNode->gtOp.gtOp1->gtFlags &= ~(GTF_VAR_DEF | GTF_VAR_USEASG);
#ifdef DEBUG
*treeModf = true;
#endif // DEBUG
// Make sure no previous cousin subtree rooted at a common ancestor has
// asked to defer the recomputation of costs.
if (!*pStmtInfoDirty)
{
/* Update ordering, costs, FP levels, etc. */
gtSetStmtInfo(compCurStmt);
/* Re-link the nodes for this statement */
fgSetStmtSeq(compCurStmt);
// Start from the old assign node, as we have changed the order of its operands.
// No need to update liveness, as nothing has changed (the target of the asgNode
// either goes dead here, in which case the whole expression is now dead, or it
// was already live).
// TODO-Throughput: Redo this so that the graph is modified BEFORE traversing it!
// We can determine this case when we first see the asgNode
*pTree = asgNode;
*doAgain = true;
}
return false;
}
// Do not remove if this local variable represents
// a promoted struct field of an address exposed local.
if (varDsc->lvIsStructField && lvaTable[varDsc->lvParentLcl].lvAddrExposed)
{
return false;
}
// Do not remove if the address of the variable has been exposed.
if (varDsc->lvAddrExposed)
{
return false;
}
/* Test for interior statement */
if (asgNode->gtNext == nullptr)
{
/* This is a "NORMAL" statement with the
* assignment node hanging from the GT_STMT node */
noway_assert(compCurStmt->gtStmt.gtStmtExpr == asgNode);
JITDUMP("top level assign\n");
/* Check for side effects */
if (rhsNode->gtFlags & GTF_SIDE_EFFECT)
{
EXTRACT_SIDE_EFFECTS:
/* Extract the side effects */
GenTreePtr sideEffList = nullptr;
#ifdef DEBUG
if (verbose)
{
printf("BB%02u - Dead assignment has side effects...\n", compCurBB->bbNum);
gtDispTree(asgNode);
printf("\n");
}
#endif // DEBUG
if (rhsNode->TypeGet() == TYP_STRUCT)
{
// This is a block assignment. An indirection of the rhs is not considered to
// happen until the assignment, so we will extract the side effects from only
// the address.
if (rhsNode->OperIsIndir())
{
assert(rhsNode->OperGet() != GT_NULLCHECK);
rhsNode = rhsNode->AsIndir()->Addr();
}
}
gtExtractSideEffList(rhsNode, &sideEffList);
if (sideEffList)
{
noway_assert(sideEffList->gtFlags & GTF_SIDE_EFFECT);
#ifdef DEBUG
if (verbose)
{
printf("Extracted side effects list...\n");
gtDispTree(sideEffList);
printf("\n");
}
#endif // DEBUG
fgUpdateRefCntForExtract(asgNode, sideEffList);
/* Replace the assignment statement with the list of side effects */
noway_assert(sideEffList->gtOper != GT_STMT);
*pTree = compCurStmt->gtStmt.gtStmtExpr = sideEffList;
#ifdef DEBUG
*treeModf = true;
#endif // DEBUG
/* Update ordering, costs, FP levels, etc. */
gtSetStmtInfo(compCurStmt);
/* Re-link the nodes for this statement */
fgSetStmtSeq(compCurStmt);
// Since the whole statement gets replaced it is safe to
// re-thread and update order. No need to compute costs again.
*pStmtInfoDirty = false;
/* Compute the live set for the new statement */
*doAgain = true;
return false;
}
else
{
/* No side effects, most likely we forgot to reset some flags */
fgRemoveStmt(compCurBB, compCurStmt);
return true;
}
}
else
{
/* If this is GT_CATCH_ARG saved to a local var don't bother */
JITDUMP("removing stmt with no side effects\n");
if (asgNode->gtFlags & GTF_ORDER_SIDEEFF)
{
if (rhsNode->gtOper == GT_CATCH_ARG)
{
goto EXTRACT_SIDE_EFFECTS;
}
}
/* No side effects - remove the whole statement from the block->bbTreeList */
fgRemoveStmt(compCurBB, compCurStmt);
/* Since we removed it do not process the rest (i.e. RHS) of the statement
* variables in the RHS will not be marked as live, so we get the benefit of
* propagating dead variables up the chain */
return true;
}
}
else
{
/* This is an INTERIOR STATEMENT with a dead assignment - remove it */
noway_assert(!VarSetOps::IsMember(this, life, varDsc->lvVarIndex));
if (rhsNode->gtFlags & GTF_SIDE_EFFECT)
{
/* :-( we have side effects */
GenTreePtr sideEffList = nullptr;
#ifdef DEBUG
if (verbose)
{
printf("BB%02u - INTERIOR dead assignment has side effects...\n", compCurBB->bbNum);
gtDispTree(asgNode);
printf("\n");
}
#endif // DEBUG
gtExtractSideEffList(rhsNode, &sideEffList);
if (!sideEffList)
{
goto NO_SIDE_EFFECTS;
}
noway_assert(sideEffList->gtFlags & GTF_SIDE_EFFECT);
#ifdef DEBUG
if (verbose)
{
printf("Extracted side effects list from condition...\n");
gtDispTree(sideEffList);
printf("\n");
}
#endif // DEBUG
if (sideEffList->gtOper == asgNode->gtOper)
{
fgUpdateRefCntForExtract(asgNode, sideEffList);
#ifdef DEBUG
*treeModf = true;
#endif // DEBUG
asgNode->gtOp.gtOp1 = sideEffList->gtOp.gtOp1;
asgNode->gtOp.gtOp2 = sideEffList->gtOp.gtOp2;
asgNode->gtType = sideEffList->gtType;
}
else
{
fgUpdateRefCntForExtract(asgNode, sideEffList);
#ifdef DEBUG
*treeModf = true;
#endif // DEBUG
/* Change the node to a GT_COMMA holding the side effect list */
asgNode->gtBashToNOP();
asgNode->ChangeOper(GT_COMMA);
asgNode->gtFlags |= sideEffList->gtFlags & GTF_ALL_EFFECT;
if (sideEffList->gtOper == GT_COMMA)
{
asgNode->gtOp.gtOp1 = sideEffList->gtOp.gtOp1;
asgNode->gtOp.gtOp2 = sideEffList->gtOp.gtOp2;
}
else
{
asgNode->gtOp.gtOp1 = sideEffList;
asgNode->gtOp.gtOp2 = gtNewNothingNode();
}
}
}
else
{
NO_SIDE_EFFECTS:
#ifdef DEBUG
if (verbose)
{
printf("\nRemoving tree ");
printTreeID(asgNode);
printf(" in BB%02u as useless\n", compCurBB->bbNum);
gtDispTree(asgNode);
printf("\n");
}
#endif // DEBUG
/* No side effects - Remove the interior statement */
fgUpdateRefCntForExtract(asgNode, nullptr);
/* Change the assignment to a GT_NOP node */
asgNode->gtBashToNOP();
#ifdef DEBUG
*treeModf = true;
#endif // DEBUG
}
/* Re-link the nodes for this statement - Do not update ordering! */
// Do not update costs by calling gtSetStmtInfo. fgSetStmtSeq modifies
// the tree threading based on the new costs. Removing nodes could
// cause a subtree to get evaluated first (earlier second) during the
// liveness walk. Instead just set a flag that costs are dirty and
// caller has to call gtSetStmtInfo.
*pStmtInfoDirty = true;
fgSetStmtSeq(compCurStmt);
/* Continue analysis from this node */
*pTree = asgNode;
return false;
}
}
return false;
}
/*****************************************************************************
*
* Iterative data flow for live variable info and availability of range
* check index expressions.
*/
void Compiler::fgInterBlockLocalVarLiveness()
{
#ifdef DEBUG
if (verbose)
{
printf("*************** In fgInterBlockLocalVarLiveness()\n");
}
#endif
/* This global flag is set whenever we remove a statement */
fgStmtRemoved = false;
// keep track if a bbLiveIn changed due to dead store removal
fgLocalVarLivenessChanged = false;
/* Compute the IN and OUT sets for tracked variables */
fgLiveVarAnalysis();
//-------------------------------------------------------------------------
#ifdef DEBUGGING_SUPPORT
/* For debuggable code, we mark vars as live over their entire
* reported scope, so that it will be visible over the entire scope
*/
if (opts.compDbgCode && (info.compVarScopesCount > 0))
{
fgExtendDbgLifetimes();
}
#endif // DEBUGGING_SUPPORT
/*-------------------------------------------------------------------------
* Variables involved in exception-handlers and finally blocks need
* to be specially marked
*/
BasicBlock* block;
VARSET_TP VARSET_INIT_NOCOPY(exceptVars, VarSetOps::MakeEmpty(this)); // vars live on entry to a handler
VARSET_TP VARSET_INIT_NOCOPY(finallyVars, VarSetOps::MakeEmpty(this)); // vars live on exit of a 'finally' block
VARSET_TP VARSET_INIT_NOCOPY(filterVars, VarSetOps::MakeEmpty(this)); // vars live on exit from a 'filter'
for (block = fgFirstBB; block; block = block->bbNext)
{
if (block->bbCatchTyp != BBCT_NONE)
{
/* Note the set of variables live on entry to exception handler */
VarSetOps::UnionD(this, exceptVars, block->bbLiveIn);
}
if (block->bbJumpKind == BBJ_EHFILTERRET)
{
/* Get the set of live variables on exit from a 'filter' */
VarSetOps::UnionD(this, filterVars, block->bbLiveOut);
}
else if (block->bbJumpKind == BBJ_EHFINALLYRET)
{
/* Get the set of live variables on exit from a 'finally' block */
VarSetOps::UnionD(this, finallyVars, block->bbLiveOut);
}
#if FEATURE_EH_FUNCLETS
// Funclets are called and returned from, as such we can only count on the frame
// pointer being restored, and thus everything live in or live out must be on the
// stack
if (block->bbFlags & BBF_FUNCLET_BEG)
{
VarSetOps::UnionD(this, exceptVars, block->bbLiveIn);
}
if ((block->bbJumpKind == BBJ_EHFINALLYRET) || (block->bbJumpKind == BBJ_EHFILTERRET) ||
(block->bbJumpKind == BBJ_EHCATCHRET))
{
VarSetOps::UnionD(this, exceptVars, block->bbLiveOut);
}
#endif // FEATURE_EH_FUNCLETS
}
LclVarDsc* varDsc;
unsigned varNum;
for (varNum = 0, varDsc = lvaTable; varNum < lvaCount; varNum++, varDsc++)
{
/* Ignore the variable if it's not tracked */
if (!varDsc->lvTracked)
{
continue;
}
if (lvaIsFieldOfDependentlyPromotedStruct(varDsc))
{
continue;
}
/* Un-init locals may need auto-initialization. Note that the
liveness of such locals will bubble to the top (fgFirstBB)
in fgInterBlockLocalVarLiveness() */
if (!varDsc->lvIsParam && VarSetOps::IsMember(this, fgFirstBB->bbLiveIn, varDsc->lvVarIndex) &&
(info.compInitMem || varTypeIsGC(varDsc->TypeGet())))
{
varDsc->lvMustInit = true;
}
// Mark all variables that are live on entry to an exception handler
// or on exit from a filter handler or finally as DoNotEnregister */
if (VarSetOps::IsMember(this, exceptVars, varDsc->lvVarIndex) ||
VarSetOps::IsMember(this, filterVars, varDsc->lvVarIndex))
{
/* Mark the variable appropriately */
lvaSetVarDoNotEnregister(varNum DEBUGARG(DNER_LiveInOutOfHandler));
}
/* Mark all pointer variables live on exit from a 'finally'
block as either volatile for non-GC ref types or as
'explicitly initialized' (volatile and must-init) for GC-ref types */
if (VarSetOps::IsMember(this, finallyVars, varDsc->lvVarIndex))
{
lvaSetVarDoNotEnregister(varNum DEBUGARG(DNER_LiveInOutOfHandler));
/* Don't set lvMustInit unless we have a non-arg, GC pointer */
if (varDsc->lvIsParam)
{
continue;
}
if (!varTypeIsGC(varDsc->TypeGet()))
{
continue;
}
/* Mark it */
varDsc->lvMustInit = true;
}
}
/*-------------------------------------------------------------------------
* Now fill in liveness info within each basic block - Backward DataFlow
*/
// This is used in the liveness computation, as a temporary.
VarSetOps::AssignNoCopy(this, fgMarkIntfUnionVS, VarSetOps::MakeEmpty(this));
for (block = fgFirstBB; block; block = block->bbNext)
{
/* Tell everyone what block we're working on */
compCurBB = block;
/* Remember those vars live on entry to exception handlers */
/* if we are part of a try block */
VARSET_TP VARSET_INIT_NOCOPY(volatileVars, VarSetOps::MakeEmpty(this));
if (ehBlockHasExnFlowDsc(block))
{
VarSetOps::Assign(this, volatileVars, fgGetHandlerLiveVars(block));
// volatileVars is a subset of exceptVars
noway_assert(VarSetOps::IsSubset(this, volatileVars, exceptVars));
}
/* Start with the variables live on exit from the block */
VARSET_TP VARSET_INIT(this, life, block->bbLiveOut);
/* Mark any interference we might have at the end of the block */
fgMarkIntf(life);
if (!block->IsLIR())
{
/* Get the first statement in the block */
GenTreePtr firstStmt = block->FirstNonPhiDef();
if (!firstStmt)
{
continue;
}
/* Walk all the statements of the block backwards - Get the LAST stmt */
GenTreePtr nextStmt = block->bbTreeList->gtPrev;
do
{
#ifdef DEBUG
bool treeModf = false;
#endif // DEBUG
noway_assert(nextStmt);
noway_assert(nextStmt->gtOper == GT_STMT);
compCurStmt = nextStmt;
nextStmt = nextStmt->gtPrev;
/* Compute the liveness for each tree node in the statement */
bool stmtInfoDirty = false;
VarSetOps::AssignNoCopy(this, life, fgComputeLife(life, compCurStmt->gtStmt.gtStmtExpr, nullptr,
volatileVars, &stmtInfoDirty DEBUGARG(&treeModf)));
if (stmtInfoDirty)
{
gtSetStmtInfo(compCurStmt);
fgSetStmtSeq(compCurStmt);
}
#ifdef DEBUG
if (verbose && treeModf)
{
printf("\nfgComputeLife modified tree:\n");
gtDispTree(compCurStmt->gtStmt.gtStmtExpr);
printf("\n");
}
#endif // DEBUG
} while (compCurStmt != firstStmt);
}
else
{
#ifdef LEGACY_BACKEND
unreached();
#else // !LEGACY_BACKEND
VarSetOps::AssignNoCopy(this, life, fgComputeLifeLIR(life, block, volatileVars));
#endif // !LEGACY_BACKEND
}
/* Done with the current block - if we removed any statements, some
* variables may have become dead at the beginning of the block
* -> have to update bbLiveIn */
if (!VarSetOps::Equal(this, life, block->bbLiveIn))
{
/* some variables have become dead all across the block
So life should be a subset of block->bbLiveIn */
// We changed the liveIn of the block, which may affect liveOut of others,
// which may expose more dead stores.
fgLocalVarLivenessChanged = true;
noway_assert(VarSetOps::Equal(this, VarSetOps::Intersection(this, life, block->bbLiveIn), life));
/* set the new bbLiveIn */
VarSetOps::Assign(this, block->bbLiveIn, life);
/* compute the new bbLiveOut for all the predecessors of this block */
}
noway_assert(compCurBB == block);
#ifdef DEBUG
compCurBB = nullptr;
#endif
}
fgLocalVarLivenessDone = true;
}
#ifdef DEBUG
/*****************************************************************************/
void Compiler::fgDispBBLiveness(BasicBlock* block)
{
VARSET_TP VARSET_INIT_NOCOPY(allVars, VarSetOps::Union(this, block->bbLiveIn, block->bbLiveOut));
printf("BB%02u", block->bbNum);
printf(" IN (%d)=", VarSetOps::Count(this, block->bbLiveIn));
lvaDispVarSet(block->bbLiveIn, allVars);
if (block->bbHeapLiveIn)
{
printf(" + HEAP");
}
printf("\n OUT(%d)=", VarSetOps::Count(this, block->bbLiveOut));
lvaDispVarSet(block->bbLiveOut, allVars);
if (block->bbHeapLiveOut)
{
printf(" + HEAP");
}
printf("\n\n");
}
void Compiler::fgDispBBLiveness()
{
for (BasicBlock* block = fgFirstBB; block; block = block->bbNext)
{
fgDispBBLiveness(block);
}
}
#endif // DEBUG
|