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
|
// 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.
// ===========================================================================
// File: CodeVersion.cpp
//
// ===========================================================================
#include "common.h"
#include "codeversion.h"
#ifdef FEATURE_CODE_VERSIONING
#include "threadsuspend.h"
#include "methoditer.h"
#include "../debug/ee/debugger.h"
#include "../debug/ee/walker.h"
#include "../debug/ee/controller.h"
#endif // FEATURE_CODE_VERSIONING
#ifndef FEATURE_CODE_VERSIONING
//
// When not using code versioning we've got a minimal implementation of
// NativeCodeVersion that simply wraps a MethodDesc* with no additional
// versioning information
//
NativeCodeVersion::NativeCodeVersion(const NativeCodeVersion & rhs) : m_pMethodDesc(rhs.m_pMethodDesc) {}
NativeCodeVersion::NativeCodeVersion(PTR_MethodDesc pMethod) : m_pMethodDesc(pMethod) {}
BOOL NativeCodeVersion::IsNull() const { return m_pMethodDesc == NULL; }
PTR_MethodDesc NativeCodeVersion::GetMethodDesc() const { return m_pMethodDesc; }
PCODE NativeCodeVersion::GetNativeCode() const { return m_pMethodDesc->GetNativeCode(); }
NativeCodeVersionId NativeCodeVersion::GetVersionId() const { return 0; }
// ReJITID NativeCodeVersion::GetILCodeVersionId() const; { return 0; }
// ILCodeVersion NativeCodeVersion::GetILCodeVersion() const { return ILCodeVersion(m_pMethodDesc); }
#ifndef DACCESS_COMPILE
BOOL NativeCodeVersion::SetNativeCodeInterlocked(PCODE pCode, PCODE pExpected) { return m_pMethodDesc->SetNativeCodeInterlocked(pCode, pExpected); }
#endif
bool NativeCodeVersion::operator==(const NativeCodeVersion & rhs) const { return m_pMethodDesc == rhs.m_pMethodDesc; }
bool NativeCodeVersion::operator!=(const NativeCodeVersion & rhs) const { return !operator==(rhs); }
#else // FEATURE_CODE_VERSIONING
// This HRESULT is only used as a private implementation detail. If it escapes through public APIS
// it is a bug. Corerror.xml has a comment in it reserving this value for our use but it doesn't
// appear in the public headers.
#define CORPROF_E_RUNTIME_SUSPEND_REQUIRED 0x80131381
#ifndef DACCESS_COMPILE
NativeCodeVersionNode::NativeCodeVersionNode(
NativeCodeVersionId id,
MethodDesc* pMethodDesc,
ReJITID parentId,
NativeCodeVersion::OptimizationTier optimizationTier)
:
m_pNativeCode(NULL),
m_pMethodDesc(pMethodDesc),
m_parentId(parentId),
m_pNextMethodDescSibling(NULL),
m_id(id),
#ifdef FEATURE_TIERED_COMPILATION
m_optTier(optimizationTier),
#endif
m_flags(0)
{}
#endif
#ifdef DEBUG
BOOL NativeCodeVersionNode::LockOwnedByCurrentThread() const
{
LIMITED_METHOD_DAC_CONTRACT;
return GetMethodDesc()->GetCodeVersionManager()->LockOwnedByCurrentThread();
}
#endif //DEBUG
PTR_MethodDesc NativeCodeVersionNode::GetMethodDesc() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_pMethodDesc;
}
PCODE NativeCodeVersionNode::GetNativeCode() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_pNativeCode;
}
ReJITID NativeCodeVersionNode::GetILVersionId() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_parentId;
}
ILCodeVersion NativeCodeVersionNode::GetILCodeVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
#ifdef DEBUG
if (GetILVersionId() != 0)
{
_ASSERTE(LockOwnedByCurrentThread());
}
#endif
PTR_MethodDesc pMD = GetMethodDesc();
return pMD->GetCodeVersionManager()->GetILCodeVersion(pMD, GetILVersionId());
}
NativeCodeVersionId NativeCodeVersionNode::GetVersionId() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_id;
}
#ifndef DACCESS_COMPILE
BOOL NativeCodeVersionNode::SetNativeCodeInterlocked(PCODE pCode, PCODE pExpected)
{
LIMITED_METHOD_CONTRACT;
return FastInterlockCompareExchangePointer(&m_pNativeCode,
(TADDR&)pCode, (TADDR&)pExpected) == (TADDR&)pExpected;
}
#endif
BOOL NativeCodeVersionNode::IsActiveChildVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return (m_flags & IsActiveChildFlag) != 0;
}
#ifndef DACCESS_COMPILE
void NativeCodeVersionNode::SetActiveChildFlag(BOOL isActive)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
if (isActive)
{
m_flags |= IsActiveChildFlag;
}
else
{
m_flags &= ~IsActiveChildFlag;
}
}
#endif
#ifdef FEATURE_TIERED_COMPILATION
NativeCodeVersion::OptimizationTier NativeCodeVersionNode::GetOptimizationTier() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_optTier;
}
#ifndef DACCESS_COMPILE
void NativeCodeVersionNode::SetOptimizationTier(NativeCodeVersion::OptimizationTier tier)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(tier >= m_optTier);
m_optTier = tier;
}
#endif
#endif // FEATURE_TIERED_COMPILATION
NativeCodeVersion::NativeCodeVersion() :
m_storageKind(StorageKind::Unknown)
{}
NativeCodeVersion::NativeCodeVersion(const NativeCodeVersion & rhs) :
m_storageKind(rhs.m_storageKind)
{
if(m_storageKind == StorageKind::Explicit)
{
m_pVersionNode = rhs.m_pVersionNode;
}
else if(m_storageKind == StorageKind::Synthetic)
{
m_synthetic = rhs.m_synthetic;
}
}
NativeCodeVersion::NativeCodeVersion(PTR_NativeCodeVersionNode pVersionNode) :
m_storageKind(pVersionNode != NULL ? StorageKind::Explicit : StorageKind::Unknown),
m_pVersionNode(pVersionNode)
{}
NativeCodeVersion::NativeCodeVersion(PTR_MethodDesc pMethod) :
m_storageKind(pMethod != NULL ? StorageKind::Synthetic : StorageKind::Unknown)
{
LIMITED_METHOD_DAC_CONTRACT;
m_synthetic.m_pMethodDesc = pMethod;
}
BOOL NativeCodeVersion::IsNull() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_storageKind == StorageKind::Unknown;
}
BOOL NativeCodeVersion::IsDefaultVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_storageKind == StorageKind::Synthetic;
}
PTR_MethodDesc NativeCodeVersion::GetMethodDesc() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetMethodDesc();
}
else
{
return m_synthetic.m_pMethodDesc;
}
}
PCODE NativeCodeVersion::GetNativeCode() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetNativeCode();
}
else
{
return GetMethodDesc()->GetNativeCode();
}
}
ReJITID NativeCodeVersion::GetILCodeVersionId() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetILVersionId();
}
else
{
return 0;
}
}
ILCodeVersion NativeCodeVersion::GetILCodeVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetILCodeVersion();
}
else
{
PTR_MethodDesc pMethod = GetMethodDesc();
return ILCodeVersion(dac_cast<PTR_Module>(pMethod->GetModule()), pMethod->GetMemberDef());
}
}
NativeCodeVersionId NativeCodeVersion::GetVersionId() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetVersionId();
}
else
{
return 0;
}
}
#ifndef DACCESS_COMPILE
BOOL NativeCodeVersion::SetNativeCodeInterlocked(PCODE pCode, PCODE pExpected)
{
LIMITED_METHOD_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->SetNativeCodeInterlocked(pCode, pExpected);
}
else
{
return GetMethodDesc()->SetNativeCodeInterlocked(pCode, pExpected);
}
}
#endif
BOOL NativeCodeVersion::IsActiveChildVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->IsActiveChildVersion();
}
else
{
MethodDescVersioningState* pMethodVersioningState = GetMethodDescVersioningState();
if (pMethodVersioningState == NULL)
{
return TRUE;
}
return pMethodVersioningState->IsDefaultVersionActiveChild();
}
}
PTR_MethodDescVersioningState NativeCodeVersion::GetMethodDescVersioningState() const
{
LIMITED_METHOD_DAC_CONTRACT;
PTR_MethodDesc pMethodDesc = GetMethodDesc();
CodeVersionManager* pCodeVersionManager = pMethodDesc->GetCodeVersionManager();
return pCodeVersionManager->GetMethodDescVersioningState(pMethodDesc);
}
#ifndef DACCESS_COMPILE
void NativeCodeVersion::SetActiveChildFlag(BOOL isActive)
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
AsNode()->SetActiveChildFlag(isActive);
}
else
{
MethodDescVersioningState* pMethodVersioningState = GetMethodDescVersioningState();
pMethodVersioningState->SetDefaultVersionActiveChildFlag(isActive);
}
}
MethodDescVersioningState* NativeCodeVersion::GetMethodDescVersioningState()
{
LIMITED_METHOD_DAC_CONTRACT;
MethodDesc* pMethodDesc = GetMethodDesc();
CodeVersionManager* pCodeVersionManager = pMethodDesc->GetCodeVersionManager();
return pCodeVersionManager->GetMethodDescVersioningState(pMethodDesc);
}
#endif
#ifdef FEATURE_TIERED_COMPILATION
NativeCodeVersion::OptimizationTier NativeCodeVersion::GetOptimizationTier() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetOptimizationTier();
}
else
{
return TieredCompilationManager::GetInitialOptimizationTier(GetMethodDesc());
}
}
#ifndef DACCESS_COMPILE
void NativeCodeVersion::SetOptimizationTier(OptimizationTier tier)
{
WRAPPER_NO_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
AsNode()->SetOptimizationTier(tier);
}
else
{
// State changes should have been made previously such that the initial tier is the new tier
_ASSERTE(TieredCompilationManager::GetInitialOptimizationTier(GetMethodDesc()) == tier);
}
}
#endif
#endif
PTR_NativeCodeVersionNode NativeCodeVersion::AsNode() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return m_pVersionNode;
}
else
{
return NULL;
}
}
#ifndef DACCESS_COMPILE
PTR_NativeCodeVersionNode NativeCodeVersion::AsNode()
{
LIMITED_METHOD_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return m_pVersionNode;
}
else
{
return NULL;
}
}
#endif
bool NativeCodeVersion::operator==(const NativeCodeVersion & rhs) const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return (rhs.m_storageKind == StorageKind::Explicit) &&
(rhs.AsNode() == AsNode());
}
else if (m_storageKind == StorageKind::Synthetic)
{
return (rhs.m_storageKind == StorageKind::Synthetic) &&
(m_synthetic.m_pMethodDesc == rhs.m_synthetic.m_pMethodDesc);
}
else
{
return rhs.m_storageKind == StorageKind::Unknown;
}
}
bool NativeCodeVersion::operator!=(const NativeCodeVersion & rhs) const
{
LIMITED_METHOD_DAC_CONTRACT;
return !operator==(rhs);
}
NativeCodeVersionCollection::NativeCodeVersionCollection(PTR_MethodDesc pMethodDescFilter, ILCodeVersion ilCodeFilter) :
m_pMethodDescFilter(pMethodDescFilter),
m_ilCodeFilter(ilCodeFilter)
{
}
NativeCodeVersionIterator NativeCodeVersionCollection::Begin()
{
LIMITED_METHOD_DAC_CONTRACT;
return NativeCodeVersionIterator(this);
}
NativeCodeVersionIterator NativeCodeVersionCollection::End()
{
LIMITED_METHOD_DAC_CONTRACT;
return NativeCodeVersionIterator(NULL);
}
NativeCodeVersionIterator::NativeCodeVersionIterator(NativeCodeVersionCollection* pNativeCodeVersionCollection) :
m_stage(IterationStage::Initial),
m_pCollection(pNativeCodeVersionCollection),
m_pLinkedListCur(dac_cast<PTR_NativeCodeVersionNode>(nullptr))
{
LIMITED_METHOD_DAC_CONTRACT;
First();
}
void NativeCodeVersionIterator::First()
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_pCollection == NULL)
{
m_stage = IterationStage::End;
}
Next();
}
void NativeCodeVersionIterator::Next()
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_stage == IterationStage::Initial)
{
ILCodeVersion ilCodeFilter = m_pCollection->m_ilCodeFilter;
m_stage = IterationStage::ImplicitCodeVersion;
if (ilCodeFilter.IsNull() || ilCodeFilter.IsDefaultVersion())
{
m_cur = NativeCodeVersion(m_pCollection->m_pMethodDescFilter);
return;
}
}
if (m_stage == IterationStage::ImplicitCodeVersion)
{
m_stage = IterationStage::LinkedList;
CodeVersionManager* pCodeVersionManager = m_pCollection->m_pMethodDescFilter->GetCodeVersionManager();
MethodDescVersioningState* pMethodDescVersioningState = pCodeVersionManager->GetMethodDescVersioningState(m_pCollection->m_pMethodDescFilter);
if (pMethodDescVersioningState == NULL)
{
m_pLinkedListCur = NULL;
}
else
{
ILCodeVersion ilCodeFilter = m_pCollection->m_ilCodeFilter;
m_pLinkedListCur = pMethodDescVersioningState->GetFirstVersionNode();
while (m_pLinkedListCur != NULL && !ilCodeFilter.IsNull() && ilCodeFilter.GetVersionId() != m_pLinkedListCur->GetILVersionId())
{
m_pLinkedListCur = m_pLinkedListCur->m_pNextMethodDescSibling;
}
}
if (m_pLinkedListCur != NULL)
{
m_cur = NativeCodeVersion(m_pLinkedListCur);
return;
}
}
if (m_stage == IterationStage::LinkedList)
{
if (m_pLinkedListCur != NULL)
{
ILCodeVersion ilCodeFilter = m_pCollection->m_ilCodeFilter;
do
{
m_pLinkedListCur = m_pLinkedListCur->m_pNextMethodDescSibling;
} while (m_pLinkedListCur != NULL && !ilCodeFilter.IsNull() && ilCodeFilter.GetVersionId() != m_pLinkedListCur->GetILVersionId());
}
if (m_pLinkedListCur != NULL)
{
m_cur = NativeCodeVersion(m_pLinkedListCur);
return;
}
else
{
m_stage = IterationStage::End;
m_cur = NativeCodeVersion();
}
}
}
const NativeCodeVersion & NativeCodeVersionIterator::Get() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_cur;
}
bool NativeCodeVersionIterator::Equal(const NativeCodeVersionIterator &i) const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_cur == i.m_cur;
}
ILCodeVersionNode::ILCodeVersionNode() :
m_pModule(dac_cast<PTR_Module>(nullptr)),
m_methodDef(0),
m_rejitId(0),
m_pNextILVersionNode(dac_cast<PTR_ILCodeVersionNode>(nullptr)),
m_rejitState(ILCodeVersion::kStateRequested),
m_pIL(),
m_jitFlags(0)
{
m_pIL.Store(dac_cast<PTR_COR_ILMETHOD>(nullptr));
}
#ifndef DACCESS_COMPILE
ILCodeVersionNode::ILCodeVersionNode(Module* pModule, mdMethodDef methodDef, ReJITID id) :
m_pModule(pModule),
m_methodDef(methodDef),
m_rejitId(id),
m_pNextILVersionNode(dac_cast<PTR_ILCodeVersionNode>(nullptr)),
m_rejitState(ILCodeVersion::kStateRequested),
m_pIL(nullptr),
m_jitFlags(0)
{}
#endif
#ifdef DEBUG
BOOL ILCodeVersionNode::LockOwnedByCurrentThread() const
{
LIMITED_METHOD_DAC_CONTRACT;
return GetModule()->GetCodeVersionManager()->LockOwnedByCurrentThread();
}
#endif //DEBUG
PTR_Module ILCodeVersionNode::GetModule() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_pModule;
}
mdMethodDef ILCodeVersionNode::GetMethodDef() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_methodDef;
}
ReJITID ILCodeVersionNode::GetVersionId() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_rejitId;
}
ILCodeVersion::RejitFlags ILCodeVersionNode::GetRejitState() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_rejitState.Load();
}
PTR_COR_ILMETHOD ILCodeVersionNode::GetIL() const
{
LIMITED_METHOD_DAC_CONTRACT;
return dac_cast<PTR_COR_ILMETHOD>(m_pIL.Load());
}
DWORD ILCodeVersionNode::GetJitFlags() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_jitFlags.Load();
}
const InstrumentedILOffsetMapping* ILCodeVersionNode::GetInstrumentedILMap() const
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return &m_instrumentedILMap;
}
PTR_ILCodeVersionNode ILCodeVersionNode::GetNextILVersionNode() const
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return m_pNextILVersionNode;
}
#ifndef DACCESS_COMPILE
void ILCodeVersionNode::SetRejitState(ILCodeVersion::RejitFlags newState)
{
LIMITED_METHOD_CONTRACT;
m_rejitState.Store(newState);
}
void ILCodeVersionNode::SetIL(COR_ILMETHOD* pIL)
{
LIMITED_METHOD_CONTRACT;
m_pIL.Store(pIL);
}
void ILCodeVersionNode::SetJitFlags(DWORD flags)
{
LIMITED_METHOD_CONTRACT;
m_jitFlags.Store(flags);
}
void ILCodeVersionNode::SetInstrumentedILMap(SIZE_T cMap, COR_IL_MAP * rgMap)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
m_instrumentedILMap.SetMappingInfo(cMap, rgMap);
}
void ILCodeVersionNode::SetNextILVersionNode(ILCodeVersionNode* pNextILVersionNode)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
m_pNextILVersionNode = pNextILVersionNode;
}
#endif
ILCodeVersion::ILCodeVersion() :
m_storageKind(StorageKind::Unknown)
{}
ILCodeVersion::ILCodeVersion(const ILCodeVersion & ilCodeVersion) :
m_storageKind(ilCodeVersion.m_storageKind)
{
if(m_storageKind == StorageKind::Explicit)
{
m_pVersionNode = ilCodeVersion.m_pVersionNode;
}
else if(m_storageKind == StorageKind::Synthetic)
{
m_synthetic = ilCodeVersion.m_synthetic;
}
}
ILCodeVersion::ILCodeVersion(PTR_ILCodeVersionNode pILCodeVersionNode) :
m_storageKind(pILCodeVersionNode != NULL ? StorageKind::Explicit : StorageKind::Unknown),
m_pVersionNode(pILCodeVersionNode)
{}
ILCodeVersion::ILCodeVersion(PTR_Module pModule, mdMethodDef methodDef) :
m_storageKind(pModule != NULL ? StorageKind::Synthetic : StorageKind::Unknown)
{
LIMITED_METHOD_DAC_CONTRACT;
m_synthetic.m_pModule = pModule;
m_synthetic.m_methodDef = methodDef;
}
bool ILCodeVersion::operator==(const ILCodeVersion & rhs) const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return (rhs.m_storageKind == StorageKind::Explicit) &&
(AsNode() == rhs.AsNode());
}
else if (m_storageKind == StorageKind::Synthetic)
{
return (rhs.m_storageKind == StorageKind::Synthetic) &&
(m_synthetic.m_pModule == rhs.m_synthetic.m_pModule) &&
(m_synthetic.m_methodDef == rhs.m_synthetic.m_methodDef);
}
else
{
return rhs.m_storageKind == StorageKind::Unknown;
}
}
BOOL ILCodeVersion::HasDefaultIL() const
{
LIMITED_METHOD_CONTRACT;
return (m_storageKind == StorageKind::Synthetic) || (AsNode()->GetIL() == NULL);
}
BOOL ILCodeVersion::IsNull() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_storageKind == StorageKind::Unknown;
}
BOOL ILCodeVersion::IsDefaultVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_storageKind == StorageKind::Synthetic;
}
PTR_Module ILCodeVersion::GetModule() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetModule();
}
else
{
return m_synthetic.m_pModule;
}
}
mdMethodDef ILCodeVersion::GetMethodDef() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetMethodDef();
}
else
{
return m_synthetic.m_methodDef;
}
}
ReJITID ILCodeVersion::GetVersionId() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetVersionId();
}
else
{
return 0;
}
}
NativeCodeVersionCollection ILCodeVersion::GetNativeCodeVersions(PTR_MethodDesc pClosedMethodDesc) const
{
LIMITED_METHOD_DAC_CONTRACT;
return NativeCodeVersionCollection(pClosedMethodDesc, *this);
}
NativeCodeVersion ILCodeVersion::GetActiveNativeCodeVersion(PTR_MethodDesc pClosedMethodDesc) const
{
LIMITED_METHOD_DAC_CONTRACT;
NativeCodeVersionCollection versions = GetNativeCodeVersions(pClosedMethodDesc);
for (NativeCodeVersionIterator cur = versions.Begin(), end = versions.End(); cur != end; cur++)
{
if (cur->IsActiveChildVersion())
{
return *cur;
}
}
return NativeCodeVersion();
}
ILCodeVersion::RejitFlags ILCodeVersion::GetRejitState() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetRejitState();
}
else
{
return ILCodeVersion::kStateActive;
}
}
PTR_COR_ILMETHOD ILCodeVersion::GetIL() const
{
CONTRACTL
{
THROWS; //GetILHeader throws
GC_NOTRIGGER;
FORBID_FAULT;
MODE_ANY;
}
CONTRACTL_END
PTR_COR_ILMETHOD pIL = NULL;
if (m_storageKind == StorageKind::Explicit)
{
pIL = AsNode()->GetIL();
}
// For the default code version we always fetch the globally stored default IL for a method
//
// In the non-default code version we assume NULL is the equivalent of explicitly requesting to
// re-use the default IL. Ideally there would be no reason to create a new version that re-uses
// the default IL (just use the default code version for that) but we do it here for compat. We've
// got some profilers that use ReJIT to create a new code version and then instead of calling
// ICorProfilerFunctionControl::SetILFunctionBody they call ICorProfilerInfo::SetILFunctionBody.
// This mutates the default IL so that it is now correct for their new code version. Of course this
// also overwrote the previous default IL so now the default code version GetIL() is out of sync
// with the jitted code. In the majority of cases we never re-read the IL after the initial
// jitting so this issue goes unnoticed.
//
// If changing the default IL after it is in use becomes more problematic in the future we would
// need to add enforcement that prevents profilers from using ICorProfilerInfo::SetILFunctionBody
// that way + coordinate with them because it is a breaking change for any profiler currently doing it.
if(pIL == NULL)
{
PTR_Module pModule = GetModule();
PTR_MethodDesc pMethodDesc = dac_cast<PTR_MethodDesc>(pModule->LookupMethodDef(GetMethodDef()));
if (pMethodDesc != NULL)
{
pIL = dac_cast<PTR_COR_ILMETHOD>(pMethodDesc->GetILHeader(TRUE));
}
}
return pIL;
}
PTR_COR_ILMETHOD ILCodeVersion::GetILNoThrow() const
{
LIMITED_METHOD_DAC_CONTRACT;
PTR_COR_ILMETHOD ret;
EX_TRY
{
ret = GetIL();
}
EX_CATCH
{
ret = NULL;
}
EX_END_CATCH(RethrowTerminalExceptions);
return ret;
}
DWORD ILCodeVersion::GetJitFlags() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetJitFlags();
}
else
{
return 0;
}
}
const InstrumentedILOffsetMapping* ILCodeVersion::GetInstrumentedILMap() const
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_storageKind == StorageKind::Explicit)
{
return AsNode()->GetInstrumentedILMap();
}
else
{
return NULL;
}
}
#ifndef DACCESS_COMPILE
void ILCodeVersion::SetRejitState(RejitFlags newState)
{
LIMITED_METHOD_CONTRACT;
AsNode()->SetRejitState(newState);
}
void ILCodeVersion::SetIL(COR_ILMETHOD* pIL)
{
LIMITED_METHOD_CONTRACT;
AsNode()->SetIL(pIL);
}
void ILCodeVersion::SetJitFlags(DWORD flags)
{
LIMITED_METHOD_CONTRACT;
AsNode()->SetJitFlags(flags);
}
void ILCodeVersion::SetInstrumentedILMap(SIZE_T cMap, COR_IL_MAP * rgMap)
{
LIMITED_METHOD_CONTRACT;
AsNode()->SetInstrumentedILMap(cMap, rgMap);
}
HRESULT ILCodeVersion::AddNativeCodeVersion(
MethodDesc* pClosedMethodDesc,
NativeCodeVersion::OptimizationTier optimizationTier,
NativeCodeVersion* pNativeCodeVersion)
{
LIMITED_METHOD_CONTRACT;
CodeVersionManager* pManager = GetModule()->GetCodeVersionManager();
HRESULT hr = pManager->AddNativeCodeVersion(*this, pClosedMethodDesc, optimizationTier, pNativeCodeVersion);
if (FAILED(hr))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
return S_OK;
}
HRESULT ILCodeVersion::GetOrCreateActiveNativeCodeVersion(MethodDesc* pClosedMethodDesc, NativeCodeVersion* pActiveNativeCodeVersion)
{
LIMITED_METHOD_CONTRACT;
HRESULT hr = S_OK;
NativeCodeVersion activeNativeChild = GetActiveNativeCodeVersion(pClosedMethodDesc);
if (activeNativeChild.IsNull())
{
NativeCodeVersion::OptimizationTier optimizationTier =
TieredCompilationManager::GetInitialOptimizationTier(pClosedMethodDesc);
if (FAILED(hr = AddNativeCodeVersion(pClosedMethodDesc, optimizationTier, &activeNativeChild)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
}
// The first added child should automatically become active
_ASSERTE(GetActiveNativeCodeVersion(pClosedMethodDesc) == activeNativeChild);
*pActiveNativeCodeVersion = activeNativeChild;
return S_OK;
}
HRESULT ILCodeVersion::SetActiveNativeCodeVersion(NativeCodeVersion activeNativeCodeVersion, BOOL fEESuspended)
{
LIMITED_METHOD_CONTRACT;
HRESULT hr = S_OK;
MethodDesc* pMethodDesc = activeNativeCodeVersion.GetMethodDesc();
NativeCodeVersion prevActiveVersion = GetActiveNativeCodeVersion(pMethodDesc);
if (prevActiveVersion == activeNativeCodeVersion)
{
//nothing to do, this version is already active
return S_OK;
}
if (!prevActiveVersion.IsNull())
{
prevActiveVersion.SetActiveChildFlag(FALSE);
}
activeNativeCodeVersion.SetActiveChildFlag(TRUE);
// If needed update the published code body for this method
CodeVersionManager* pCodeVersionManager = GetModule()->GetCodeVersionManager();
if (pCodeVersionManager->GetActiveILCodeVersion(GetModule(), GetMethodDef()) == *this)
{
if (FAILED(hr = pCodeVersionManager->PublishNativeCodeVersion(pMethodDesc, activeNativeCodeVersion, fEESuspended)))
{
return hr;
}
}
return S_OK;
}
ILCodeVersionNode* ILCodeVersion::AsNode()
{
LIMITED_METHOD_CONTRACT;
//This is dangerous - NativeCodeVersion coerces non-explicit versions to NULL but ILCodeVersion assumes the caller
//will never invoke AsNode() on a non-explicit node. Asserting for now as a minimal fix, but we should revisit this.
_ASSERTE(m_storageKind == StorageKind::Explicit);
return m_pVersionNode;
}
#endif //DACCESS_COMPILE
PTR_ILCodeVersionNode ILCodeVersion::AsNode() const
{
LIMITED_METHOD_DAC_CONTRACT;
//This is dangerous - NativeCodeVersion coerces non-explicit versions to NULL but ILCodeVersion assumes the caller
//will never invoke AsNode() on a non-explicit node. Asserting for now as a minimal fix, but we should revisit this.
_ASSERTE(m_storageKind == StorageKind::Explicit);
return m_pVersionNode;
}
ILCodeVersionCollection::ILCodeVersionCollection(PTR_Module pModule, mdMethodDef methodDef) :
m_pModule(pModule),
m_methodDef(methodDef)
{}
ILCodeVersionIterator ILCodeVersionCollection::Begin()
{
LIMITED_METHOD_DAC_CONTRACT;
return ILCodeVersionIterator(this);
}
ILCodeVersionIterator ILCodeVersionCollection::End()
{
LIMITED_METHOD_DAC_CONTRACT;
return ILCodeVersionIterator(NULL);
}
ILCodeVersionIterator::ILCodeVersionIterator(const ILCodeVersionIterator & iter) :
m_stage(iter.m_stage),
m_cur(iter.m_cur),
m_pLinkedListCur(iter.m_pLinkedListCur),
m_pCollection(iter.m_pCollection)
{}
ILCodeVersionIterator::ILCodeVersionIterator(ILCodeVersionCollection* pCollection) :
m_stage(pCollection != NULL ? IterationStage::Initial : IterationStage::End),
m_pLinkedListCur(dac_cast<PTR_ILCodeVersionNode>(nullptr)),
m_pCollection(pCollection)
{
LIMITED_METHOD_DAC_CONTRACT;
First();
}
const ILCodeVersion & ILCodeVersionIterator::Get() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_cur;
}
void ILCodeVersionIterator::First()
{
LIMITED_METHOD_DAC_CONTRACT;
Next();
}
void ILCodeVersionIterator::Next()
{
LIMITED_METHOD_DAC_CONTRACT;
if (m_stage == IterationStage::Initial)
{
m_stage = IterationStage::ImplicitCodeVersion;
m_cur = ILCodeVersion(m_pCollection->m_pModule, m_pCollection->m_methodDef);
return;
}
if (m_stage == IterationStage::ImplicitCodeVersion)
{
CodeVersionManager* pCodeVersionManager = m_pCollection->m_pModule->GetCodeVersionManager();
_ASSERTE(pCodeVersionManager->LockOwnedByCurrentThread());
PTR_ILCodeVersioningState pILCodeVersioningState = pCodeVersionManager->GetILCodeVersioningState(m_pCollection->m_pModule, m_pCollection->m_methodDef);
if (pILCodeVersioningState != NULL)
{
m_pLinkedListCur = pILCodeVersioningState->GetFirstVersionNode();
}
m_stage = IterationStage::LinkedList;
if (m_pLinkedListCur != NULL)
{
m_cur = ILCodeVersion(m_pLinkedListCur);
return;
}
}
if (m_stage == IterationStage::LinkedList)
{
if (m_pLinkedListCur != NULL)
{
m_pLinkedListCur = m_pLinkedListCur->GetNextILVersionNode();
}
if (m_pLinkedListCur != NULL)
{
m_cur = ILCodeVersion(m_pLinkedListCur);
return;
}
else
{
m_stage = IterationStage::End;
m_cur = ILCodeVersion();
return;
}
}
}
bool ILCodeVersionIterator::Equal(const ILCodeVersionIterator &i) const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_cur == i.m_cur;
}
MethodDescVersioningState::MethodDescVersioningState(PTR_MethodDesc pMethodDesc) :
m_pMethodDesc(pMethodDesc),
m_flags(IsDefaultVersionActiveChildFlag),
m_nextId(1),
m_pFirstVersionNode(dac_cast<PTR_NativeCodeVersionNode>(nullptr))
{
LIMITED_METHOD_DAC_CONTRACT;
#ifdef FEATURE_JUMPSTAMP
ZeroMemory(m_rgSavedCode, JumpStubSize);
#endif
}
PTR_MethodDesc MethodDescVersioningState::GetMethodDesc() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_pMethodDesc;
}
#ifndef DACCESS_COMPILE
NativeCodeVersionId MethodDescVersioningState::AllocateVersionId()
{
LIMITED_METHOD_CONTRACT;
return m_nextId++;
}
#endif
PTR_NativeCodeVersionNode MethodDescVersioningState::GetFirstVersionNode() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_pFirstVersionNode;
}
#ifdef FEATURE_JUMPSTAMP
MethodDescVersioningState::JumpStampFlags MethodDescVersioningState::GetJumpStampState()
{
LIMITED_METHOD_DAC_CONTRACT;
return (JumpStampFlags)(m_flags & JumpStampMask);
}
#ifndef DACCESS_COMPILE
void MethodDescVersioningState::SetJumpStampState(JumpStampFlags newState)
{
LIMITED_METHOD_CONTRACT;
m_flags = (m_flags & ~JumpStampMask) | (BYTE)newState;
}
#endif // DACCESS_COMPILE
#ifndef DACCESS_COMPILE
HRESULT MethodDescVersioningState::SyncJumpStamp(NativeCodeVersion nativeCodeVersion, BOOL fEESuspended)
{
LIMITED_METHOD_CONTRACT;
HRESULT hr = S_OK;
PCODE pCode = nativeCodeVersion.IsNull() ? NULL : nativeCodeVersion.GetNativeCode();
MethodDesc* pMethod = GetMethodDesc();
_ASSERTE(pMethod->IsVersionableWithJumpStamp());
if (!pMethod->HasNativeCode())
{
//we'll set up the jump-stamp when the default native code is created
return S_OK;
}
if (!nativeCodeVersion.IsNull() && nativeCodeVersion.IsDefaultVersion())
{
return UndoJumpStampNativeCode(fEESuspended);
}
else
{
// We don't have new code ready yet, jumpstamp back to the prestub to let us generate it the next time
// the method is called
if (pCode == NULL)
{
if (!fEESuspended)
{
return CORPROF_E_RUNTIME_SUSPEND_REQUIRED;
}
return JumpStampNativeCode();
}
// We do know the new code body, install the jump stamp now
else
{
return UpdateJumpTarget(fEESuspended, pCode);
}
}
}
#endif // DACCESS_COMPILE
//---------------------------------------------------------------------------------------
//
// Simple, thin abstraction of debugger breakpoint patching. Given an address and a
// previously procured DebuggerControllerPatch governing the code address, this decides
// whether the code address is patched. If so, it returns a pointer to the debugger's
// buffer (of what's "underneath" the int 3 patch); otherwise, it returns the code
// address itself.
//
// Arguments:
// * pbCode - Code address to return if unpatched
// * dbgpatch - DebuggerControllerPatch to test
//
// Return Value:
// Either pbCode or the debugger's patch buffer, as per description above.
//
// Assumptions:
// Caller must manually grab (and hold) the ControllerLockHolder and get the
// DebuggerControllerPatch before calling this helper.
//
// Notes:
// pbCode need not equal the code address governed by dbgpatch, but is always
// "related" (and sometimes really is equal). For example, this helper may be used
// when writing a code byte to an internal rejit buffer (e.g., in preparation for an
// eventual 64-bit interlocked write into the code stream), and thus pbCode would
// point into the internal rejit buffer whereas dbgpatch governs the corresponding
// code byte in the live code stream. This function would then be used to determine
// whether a byte should be written into the internal rejit buffer OR into the
// debugger controller's breakpoint buffer.
//
LPBYTE FirstCodeByteAddr(LPBYTE pbCode, DebuggerControllerPatch * dbgpatch)
{
LIMITED_METHOD_CONTRACT;
if (dbgpatch != NULL && dbgpatch->IsActivated())
{
// Debugger has patched the code, so return the address of the buffer
return LPBYTE(&(dbgpatch->opcode));
}
// no active patch, just return the direct code address
return pbCode;
}
#ifdef _DEBUG
#ifndef DACCESS_COMPILE
BOOL MethodDescVersioningState::CodeIsSaved()
{
LIMITED_METHOD_CONTRACT;
for (size_t i = 0; i < sizeof(m_rgSavedCode); i++)
{
if (m_rgSavedCode[i] != 0)
return TRUE;
}
return FALSE;
}
#endif //DACCESS_COMPILE
#endif //_DEBUG
//---------------------------------------------------------------------------------------
//
// Do the actual work of stamping the top of originally-jitted-code with a jmp that goes
// to the prestub. This can be called in one of three ways:
// * Case 1: By RequestReJIT against an already-jitted function, in which case the
// PCODE may be inferred by the MethodDesc, and our caller will have suspended
// the EE for us, OR
// * Case 2: By the prestub worker after jitting the original code of a function
// (i.e., the "pre-rejit" scenario). In this case, the EE is not suspended. But
// that's ok, because the PCODE has not yet been published to the MethodDesc, and
// no thread can be executing inside the originally JITted function yet.
// * Case 3: At type/method restore time for an NGEN'ed assembly. This is also the pre-rejit
// scenario because we are guaranteed to do this before the code in the module
// is executable. EE suspend is not required.
//
// Arguments:
// * pCode - Case 1 (above): will be NULL, and we can infer the PCODE from the
// MethodDesc; Case 2+3 (above, pre-rejit): will be non-NULL, and we'll need to use
// this to find the code to stamp on top of.
//
// Return Value:
// * S_OK: Either we successfully did the jmp-stamp, or a racing thread took care of
// it for us.
// * Else, HRESULT indicating failure.
//
// Assumptions:
// The caller will have suspended the EE if necessary (case 1), before this is
// called.
//
#ifndef DACCESS_COMPILE
HRESULT MethodDescVersioningState::JumpStampNativeCode(PCODE pCode /* = NULL */)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
// It may seem dangerous to be stamping jumps over code while a GC is going on,
// but we're actually safe. As we assert below, either we're holding the thread
// store lock (and thus preventing a GC) OR we're stamping code that has not yet
// been published (and will thus not be executed by managed therads or examined
// by the GC).
MODE_ANY;
}
CONTRACTL_END;
PCODE pCodePublished = GetMethodDesc()->GetNativeCode();
_ASSERTE((pCode != NULL) || (pCodePublished != NULL));
_ASSERTE(GetMethodDesc()->GetCodeVersionManager()->LockOwnedByCurrentThread());
HRESULT hr = S_OK;
// We'll jump-stamp over pCode, or if pCode is NULL, jump-stamp over the published
// code for this's MethodDesc.
LPBYTE pbCode = (LPBYTE)pCode;
if (pbCode == NULL)
{
// If caller didn't specify a pCode, just use the one that was published after
// the original JIT. (A specific pCode would be passed in the pre-rejit case,
// to jump-stamp the original code BEFORE the PCODE gets published.)
pbCode = (LPBYTE)pCodePublished;
}
_ASSERTE(pbCode != NULL);
// The debugging API may also try to write to the very top of this function (though
// with an int 3 for breakpoint purposes). Coordinate with the debugger so we know
// whether we can safely patch the actual code, or instead write to the debugger's
// buffer.
DebuggerController::ControllerLockHolder lockController;
if (GetJumpStampState() == JumpStampToPrestub)
{
// The method has already been jump stamped so nothing left to do
_ASSERTE(CodeIsSaved());
return S_OK;
}
// Remember what we're stamping our jump on top of, so we can replace it during a
// revert.
if (GetJumpStampState() == JumpStampNone)
{
for (int i = 0; i < sizeof(m_rgSavedCode); i++)
{
m_rgSavedCode[i] = *FirstCodeByteAddr(pbCode + i, DebuggerController::GetPatchTable()->GetPatch((CORDB_ADDRESS_TYPE *)(pbCode + i)));
}
}
EX_TRY
{
AllocMemTracker amt;
// This guy might throw on out-of-memory, so rely on the tracker to clean-up
Precode * pPrecode = Precode::Allocate(PRECODE_STUB, GetMethodDesc(), GetMethodDesc()->GetLoaderAllocator(), &amt);
PCODE target = pPrecode->GetEntryPoint();
#if defined(_X86_) || defined(_AMD64_)
// Normal unpatched code never starts with a jump
_ASSERTE(GetJumpStampState() == JumpStampToActiveVersion ||
*FirstCodeByteAddr(pbCode, DebuggerController::GetPatchTable()->GetPatch((CORDB_ADDRESS_TYPE *)pbCode)) != X86_INSTR_JMP_REL32);
INT64 i64OldCode = *(INT64*)pbCode;
INT64 i64NewCode = i64OldCode;
LPBYTE pbNewValue = (LPBYTE)&i64NewCode;
*pbNewValue = X86_INSTR_JMP_REL32;
INT32 UNALIGNED * pOffset = reinterpret_cast<INT32 UNALIGNED *>(&pbNewValue[1]);
// This will throw for out-of-memory, so don't write anything until
// after he succeeds
// This guy will leak/cache/reuse the jumpstub
*pOffset = rel32UsingJumpStub(reinterpret_cast<INT32 UNALIGNED *>(pbCode + 1), target, GetMethodDesc(), GetMethodDesc()->GetLoaderAllocator());
// If we have the EE suspended or the code is unpublished there won't be contention on this code
hr = UpdateJumpStampHelper(pbCode, i64OldCode, i64NewCode, FALSE);
if (FAILED(hr))
{
ThrowHR(hr);
}
//
// No failure point after this!
//
amt.SuppressRelease();
#else // _X86_ || _AMD64_
#error "Need to define a way to jump-stamp the prolog in a safe way for this platform"
#endif // _X86_ || _AMD64_
SetJumpStampState(JumpStampToPrestub);
}
EX_CATCH_HRESULT(hr);
_ASSERT(hr == S_OK || hr == E_OUTOFMEMORY);
if (SUCCEEDED(hr))
{
_ASSERTE(GetJumpStampState() == JumpStampToPrestub);
_ASSERTE(m_rgSavedCode[0] != 0); // saved code should not start with 0
}
return hr;
}
//---------------------------------------------------------------------------------------
//
// After code has been rejitted, this is called to update the jump-stamp to go from
// pointing to the prestub, to pointing to the newly rejitted code.
//
// Arguments:
// fEESuspended - TRUE if the caller keeps the EE suspended during this call
// pRejittedCode - jitted code for the updated IL this method should execute
//
// Assumptions:
// This rejit manager's table crst should be held by the caller
//
// Returns - S_OK if the jump target is updated
// CORPROF_E_RUNTIME_SUSPEND_REQUIRED if the ee isn't suspended and it
// will need to be in order to do the update safely
HRESULT MethodDescVersioningState::UpdateJumpTarget(BOOL fEESuspended, PCODE pRejittedCode)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_PREEMPTIVE;
}
CONTRACTL_END;
MethodDesc * pMD = GetMethodDesc();
_ASSERTE(pMD->GetCodeVersionManager()->LockOwnedByCurrentThread());
// It isn't safe to overwrite the original method prolog with a jmp because threads might
// be at an IP in the middle of the jump stamp already. However converting between different
// jump stamps is OK (when done atomically) because this only changes the jmp target, not
// instruction boundaries.
if (GetJumpStampState() == JumpStampNone && !fEESuspended)
{
return CORPROF_E_RUNTIME_SUSPEND_REQUIRED;
}
// Beginning of originally JITted code containing the jmp that we will redirect.
BYTE * pbCode = (BYTE*)pMD->GetNativeCode();
// Remember what we're stamping our jump on top of, so we can replace it during a
// revert.
if (GetJumpStampState() == JumpStampNone)
{
for (int i = 0; i < sizeof(m_rgSavedCode); i++)
{
m_rgSavedCode[i] = *FirstCodeByteAddr(pbCode + i, DebuggerController::GetPatchTable()->GetPatch((CORDB_ADDRESS_TYPE *)(pbCode + i)));
}
}
#if defined(_X86_) || defined(_AMD64_)
HRESULT hr = S_OK;
{
DebuggerController::ControllerLockHolder lockController;
// This will throw for out-of-memory, so don't write anything until
// after he succeeds
// This guy will leak/cache/reuse the jumpstub
INT32 offset = 0;
EX_TRY
{
offset = rel32UsingJumpStub(
reinterpret_cast<INT32 UNALIGNED *>(&pbCode[1]), // base of offset
pRejittedCode, // target of jump
pMD,
pMD->GetLoaderAllocator());
}
EX_CATCH_HRESULT(hr);
_ASSERT(hr == S_OK || hr == E_OUTOFMEMORY);
if (FAILED(hr))
{
return hr;
}
// For validation later, remember what pbCode is right now
INT64 i64OldValue = *(INT64 *)pbCode;
// Assemble the INT64 of the new code bytes to write. Start with what's there now
INT64 i64NewValue = i64OldValue;
LPBYTE pbNewValue = (LPBYTE)&i64NewValue;
// First byte becomes a rel32 jmp instruction (if it wasn't already)
*pbNewValue = X86_INSTR_JMP_REL32;
// Next 4 bytes are the jmp target (offset to jmp stub)
INT32 UNALIGNED * pnOffset = reinterpret_cast<INT32 UNALIGNED *>(&pbNewValue[1]);
*pnOffset = offset;
hr = UpdateJumpStampHelper(pbCode, i64OldValue, i64NewValue, !fEESuspended);
_ASSERTE(hr == S_OK || (hr == CORPROF_E_RUNTIME_SUSPEND_REQUIRED && !fEESuspended));
}
if (FAILED(hr))
{
return hr;
}
#else // _X86_ || _AMD64_
#error "Need to define a way to jump-stamp the prolog in a safe way for this platform"
#endif // _X86_ || _AMD64_
// State transition
SetJumpStampState(JumpStampToActiveVersion);
return S_OK;
}
//---------------------------------------------------------------------------------------
//
// Poke the JITted code to satsify a revert request (or to perform an implicit revert as
// part of a second, third, etc. rejit request). Reinstates the originally JITted code
// that had been jump-stamped over to perform a prior rejit.
//
// Arguments
// fEESuspended - TRUE if the caller keeps the EE suspended during this call
//
//
// Return Value:
// S_OK to indicate the revert succeeded,
// CORPROF_E_RUNTIME_SUSPEND_REQUIRED to indicate the jumpstamp hasn't been reverted
// and EE suspension will be needed for success
// other failure HRESULT indicating what went wrong.
//
// Assumptions:
// Caller must be holding the owning ReJitManager's table crst.
//
HRESULT MethodDescVersioningState::UndoJumpStampNativeCode(BOOL fEESuspended)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
_ASSERTE(GetMethodDesc()->GetCodeVersionManager()->LockOwnedByCurrentThread());
if (GetJumpStampState() == JumpStampNone)
{
return S_OK;
}
_ASSERTE(m_rgSavedCode[0] != 0); // saved code should not start with 0
BYTE * pbCode = (BYTE*)GetMethodDesc()->GetNativeCode();
DebuggerController::ControllerLockHolder lockController;
#if defined(_X86_) || defined(_AMD64_)
_ASSERTE(m_rgSavedCode[0] != X86_INSTR_JMP_REL32);
_ASSERTE(*FirstCodeByteAddr(pbCode, DebuggerController::GetPatchTable()->GetPatch((CORDB_ADDRESS_TYPE *)pbCode)) == X86_INSTR_JMP_REL32);
#else
#error "Need to define a way to jump-stamp the prolog in a safe way for this platform"
#endif // _X86_ || _AMD64_
// For the interlocked compare, remember what pbCode is right now
INT64 i64OldValue = *(INT64 *)pbCode;
// Assemble the INT64 of the new code bytes to write. Start with what's there now
INT64 i64NewValue = i64OldValue;
memcpy(LPBYTE(&i64NewValue), m_rgSavedCode, sizeof(m_rgSavedCode));
HRESULT hr = UpdateJumpStampHelper(pbCode, i64OldValue, i64NewValue, !fEESuspended);
_ASSERTE(hr == S_OK || (hr == CORPROF_E_RUNTIME_SUSPEND_REQUIRED && !fEESuspended));
if (hr != S_OK)
return hr;
// Transition state of this ReJitInfo to indicate the MD no longer has any jump stamp
SetJumpStampState(JumpStampNone);
return S_OK;
}
#endif
//---------------------------------------------------------------------------------------
//
// This is called to modify the jump-stamp area, the first ReJitInfo::JumpStubSize bytes
// in the method's code.
//
// Notes:
// Callers use this method in a variety of circumstances:
// a) when the code is unpublished (fContentionPossible == FALSE)
// b) when the caller has taken the ThreadStoreLock and suspended the EE
// (fContentionPossible == FALSE)
// c) when the code is published, the EE isn't suspended, and the jumpstamp
// area consists of a single 5 byte long jump instruction
// (fContentionPossible == TRUE)
// This method will attempt to alter the jump-stamp even if the caller has not prevented
// contention, but there is no guarantee it will be succesful. When the caller has prevented
// contention, then success is assured. Callers may opportunistically try without
// EE suspension, and then upgrade to EE suspension if the first attempt fails.
//
// Assumptions:
// This rejit manager's table crst should be held by the caller or fContentionPossible==FALSE
// The debugger patch table lock should be held by the caller
//
// Arguments:
// pbCode - pointer to the code where the jump stamp is placed
// i64OldValue - the bytes which should currently be at the start of the method code
// i64NewValue - the new bytes which should be written at the start of the method code
// fContentionPossible - See the Notes section above.
//
// Returns:
// S_OK => the jumpstamp has been succesfully updated.
// CORPROF_E_RUNTIME_SUSPEND_REQUIRED => the jumpstamp remains unchanged (preventing contention will be necessary)
// other failing HR => VirtualProtect failed, the jumpstamp remains unchanged
//
#ifndef DACCESS_COMPILE
HRESULT MethodDescVersioningState::UpdateJumpStampHelper(BYTE* pbCode, INT64 i64OldValue, INT64 i64NewValue, BOOL fContentionPossible)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
MethodDesc * pMD = GetMethodDesc();
_ASSERTE(pMD->GetCodeVersionManager()->LockOwnedByCurrentThread() || !fContentionPossible);
// When ReJIT is enabled, method entrypoints are always at least 8-byte aligned (see
// code:EEJitManager::allocCode), so we can do a single 64-bit interlocked operation
// to update the jump target. However, some code may have gotten compiled before
// the profiler had a chance to enable ReJIT (e.g., NGENd code, or code JITted
// before a profiler attaches). In such cases, we cannot rely on a simple
// interlocked operation, and instead must suspend the runtime to ensure we can
// safely update the jmp instruction.
//
// This method doesn't verify that the method is actually safe to rejit, we expect
// callers to do that. At the moment NGEN'ed code is safe to rejit even if
// it is unaligned, but code generated before the profiler attaches is not.
if (fContentionPossible && !(IS_ALIGNED(pbCode, sizeof(INT64))))
{
return CORPROF_E_RUNTIME_SUSPEND_REQUIRED;
}
// The debugging API may also try to write to this function (though
// with an int 3 for breakpoint purposes). Coordinate with the debugger so we know
// whether we can safely patch the actual code, or instead write to the debugger's
// buffer.
if (fContentionPossible)
{
for (CORDB_ADDRESS_TYPE* pbProbeAddr = pbCode; pbProbeAddr < pbCode + MethodDescVersioningState::JumpStubSize; pbProbeAddr++)
{
if (NULL != DebuggerController::GetPatchTable()->GetPatch(pbProbeAddr))
{
return CORPROF_E_RUNTIME_SUSPEND_REQUIRED;
}
}
}
#if defined(_X86_) || defined(_AMD64_)
DWORD oldProt;
if (!ClrVirtualProtect((LPVOID)pbCode, 8, PAGE_EXECUTE_READWRITE, &oldProt))
{
return HRESULT_FROM_WIN32(GetLastError());
}
if (fContentionPossible)
{
INT64 i64InterlockReportedOldValue = FastInterlockCompareExchangeLong((INT64 *)pbCode, i64NewValue, i64OldValue);
// Since changes to these bytes are protected by this rejitmgr's m_crstTable, we
// shouldn't have two writers conflicting.
_ASSERTE(i64InterlockReportedOldValue == i64OldValue);
}
else
{
// In this path the caller ensures:
// a) no thread will execute through the prologue area we are modifying
// b) no thread is stopped in a prologue such that it resumes in the middle of code we are modifying
// c) no thread is doing a debugger patch skip operation in which an unmodified copy of the method's
// code could be executed from a patch skip buffer.
// PERF: we might still want a faster path through here if we aren't debugging that doesn't do
// all the patch checks
for (int i = 0; i < MethodDescVersioningState::JumpStubSize; i++)
{
*FirstCodeByteAddr(pbCode + i, DebuggerController::GetPatchTable()->GetPatch(pbCode + i)) = ((BYTE*)&i64NewValue)[i];
}
}
if (oldProt != PAGE_EXECUTE_READWRITE)
{
// The CLR codebase in many locations simply ignores failures to restore the page protections
// Its true that it isn't a problem functionally, but it seems a bit sketchy?
// I am following the convention for now.
ClrVirtualProtect((LPVOID)pbCode, 8, oldProt, &oldProt);
}
FlushInstructionCache(GetCurrentProcess(), pbCode, MethodDescVersioningState::JumpStubSize);
return S_OK;
#else // _X86_ || _AMD64_
#error "Need to define a way to jump-stamp the prolog in a safe way for this platform"
#endif // _X86_ || _AMD64_
}
#endif
#endif // FEATURE_JUMPSTAMP
BOOL MethodDescVersioningState::IsDefaultVersionActiveChild() const
{
LIMITED_METHOD_DAC_CONTRACT;
return (m_flags & IsDefaultVersionActiveChildFlag) != 0;
}
#ifndef DACCESS_COMPILE
void MethodDescVersioningState::SetDefaultVersionActiveChildFlag(BOOL isActive)
{
LIMITED_METHOD_CONTRACT;
if (isActive)
{
m_flags |= IsDefaultVersionActiveChildFlag;
}
else
{
m_flags &= ~IsDefaultVersionActiveChildFlag;
}
}
void MethodDescVersioningState::LinkNativeCodeVersionNode(NativeCodeVersionNode* pNativeCodeVersionNode)
{
LIMITED_METHOD_CONTRACT;
pNativeCodeVersionNode->m_pNextMethodDescSibling = m_pFirstVersionNode;
m_pFirstVersionNode = pNativeCodeVersionNode;
}
#endif
ILCodeVersioningState::ILCodeVersioningState(PTR_Module pModule, mdMethodDef methodDef) :
m_activeVersion(ILCodeVersion(pModule,methodDef)),
m_pFirstVersionNode(dac_cast<PTR_ILCodeVersionNode>(nullptr)),
m_pModule(pModule),
m_methodDef(methodDef)
{}
ILCodeVersioningState::Key::Key() :
m_pModule(dac_cast<PTR_Module>(nullptr)),
m_methodDef(0)
{}
ILCodeVersioningState::Key::Key(PTR_Module pModule, mdMethodDef methodDef) :
m_pModule(pModule),
m_methodDef(methodDef)
{}
size_t ILCodeVersioningState::Key::Hash() const
{
LIMITED_METHOD_DAC_CONTRACT;
return (size_t)(dac_cast<TADDR>(m_pModule) ^ m_methodDef);
}
bool ILCodeVersioningState::Key::operator==(const Key & rhs) const
{
LIMITED_METHOD_DAC_CONTRACT;
return (m_pModule == rhs.m_pModule) && (m_methodDef == rhs.m_methodDef);
}
ILCodeVersioningState::Key ILCodeVersioningState::GetKey() const
{
LIMITED_METHOD_DAC_CONTRACT;
return Key(m_pModule, m_methodDef);
}
ILCodeVersion ILCodeVersioningState::GetActiveVersion() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_activeVersion;
}
PTR_ILCodeVersionNode ILCodeVersioningState::GetFirstVersionNode() const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_pFirstVersionNode;
}
#ifndef DACCESS_COMPILE
void ILCodeVersioningState::SetActiveVersion(ILCodeVersion ilActiveCodeVersion)
{
LIMITED_METHOD_CONTRACT;
m_activeVersion = ilActiveCodeVersion;
}
void ILCodeVersioningState::LinkILCodeVersionNode(ILCodeVersionNode* pILCodeVersionNode)
{
LIMITED_METHOD_CONTRACT;
pILCodeVersionNode->SetNextILVersionNode(m_pFirstVersionNode);
m_pFirstVersionNode = pILCodeVersionNode;
}
#endif
CodeVersionManager::CodeVersionManager()
{}
//---------------------------------------------------------------------------------------
//
// Called from BaseDomain::BaseDomain to do any constructor-time initialization.
// Presently, this takes care of initializing the Crst.
//
void CodeVersionManager::PreInit()
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
CAN_TAKE_LOCK;
MODE_ANY;
}
CONTRACTL_END;
#ifndef DACCESS_COMPILE
m_crstTable.Init(
CrstReJITDomainTable,
CrstFlags(CRST_UNSAFE_ANYMODE | CRST_DEBUGGER_THREAD | CRST_REENTRANCY | CRST_TAKEN_DURING_SHUTDOWN));
#endif // DACCESS_COMPILE
}
CodeVersionManager::TableLockHolder::TableLockHolder(CodeVersionManager* pCodeVersionManager) :
CrstHolder(&pCodeVersionManager->m_crstTable)
{
}
#ifndef DACCESS_COMPILE
void CodeVersionManager::EnterLock()
{
m_crstTable.Enter();
}
void CodeVersionManager::LeaveLock()
{
m_crstTable.Leave();
}
#endif
#ifdef DEBUG
BOOL CodeVersionManager::LockOwnedByCurrentThread() const
{
LIMITED_METHOD_DAC_CONTRACT;
#ifdef DACCESS_COMPILE
return TRUE;
#else
return const_cast<CrstExplicitInit &>(m_crstTable).OwnedByCurrentThread();
#endif
}
#endif
PTR_ILCodeVersioningState CodeVersionManager::GetILCodeVersioningState(PTR_Module pModule, mdMethodDef methodDef) const
{
LIMITED_METHOD_DAC_CONTRACT;
ILCodeVersioningState::Key key = ILCodeVersioningState::Key(pModule, methodDef);
return m_ilCodeVersioningStateMap.Lookup(key);
}
PTR_MethodDescVersioningState CodeVersionManager::GetMethodDescVersioningState(PTR_MethodDesc pClosedMethodDesc) const
{
LIMITED_METHOD_DAC_CONTRACT;
return m_methodDescVersioningStateMap.Lookup(pClosedMethodDesc);
}
#ifndef DACCESS_COMPILE
HRESULT CodeVersionManager::GetOrCreateILCodeVersioningState(Module* pModule, mdMethodDef methodDef, ILCodeVersioningState** ppILCodeVersioningState)
{
LIMITED_METHOD_CONTRACT;
HRESULT hr = S_OK;
ILCodeVersioningState* pILCodeVersioningState = GetILCodeVersioningState(pModule, methodDef);
if (pILCodeVersioningState == NULL)
{
pILCodeVersioningState = new (nothrow) ILCodeVersioningState(pModule, methodDef);
if (pILCodeVersioningState == NULL)
{
return E_OUTOFMEMORY;
}
EX_TRY
{
// This throws when out of memory, but remains internally
// consistent (without adding the new element)
m_ilCodeVersioningStateMap.Add(pILCodeVersioningState);
}
EX_CATCH_HRESULT(hr);
if (FAILED(hr))
{
delete pILCodeVersioningState;
return hr;
}
}
*ppILCodeVersioningState = pILCodeVersioningState;
return S_OK;
}
HRESULT CodeVersionManager::GetOrCreateMethodDescVersioningState(MethodDesc* pMethod, MethodDescVersioningState** ppMethodVersioningState)
{
LIMITED_METHOD_CONTRACT;
HRESULT hr = S_OK;
MethodDescVersioningState* pMethodVersioningState = m_methodDescVersioningStateMap.Lookup(pMethod);
if (pMethodVersioningState == NULL)
{
pMethodVersioningState = new (nothrow) MethodDescVersioningState(pMethod);
if (pMethodVersioningState == NULL)
{
return E_OUTOFMEMORY;
}
EX_TRY
{
// This throws when out of memory, but remains internally
// consistent (without adding the new element)
m_methodDescVersioningStateMap.Add(pMethodVersioningState);
}
EX_CATCH_HRESULT(hr);
if (FAILED(hr))
{
delete pMethodVersioningState;
return hr;
}
}
*ppMethodVersioningState = pMethodVersioningState;
return S_OK;
}
#endif // DACCESS_COMPILE
DWORD CodeVersionManager::GetNonDefaultILVersionCount()
{
LIMITED_METHOD_DAC_CONTRACT;
//This function is legal to call WITHOUT taking the lock
//It is used to do a quick check if work might be needed without paying the overhead
//of acquiring the lock and doing dictionary lookups
return m_ilCodeVersioningStateMap.GetCount();
}
ILCodeVersionCollection CodeVersionManager::GetILCodeVersions(PTR_MethodDesc pMethod)
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return GetILCodeVersions(dac_cast<PTR_Module>(pMethod->GetModule()), pMethod->GetMemberDef());
}
ILCodeVersionCollection CodeVersionManager::GetILCodeVersions(PTR_Module pModule, mdMethodDef methodDef)
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return ILCodeVersionCollection(pModule, methodDef);
}
ILCodeVersion CodeVersionManager::GetActiveILCodeVersion(PTR_MethodDesc pMethod)
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return GetActiveILCodeVersion(dac_cast<PTR_Module>(pMethod->GetModule()), pMethod->GetMemberDef());
}
ILCodeVersion CodeVersionManager::GetActiveILCodeVersion(PTR_Module pModule, mdMethodDef methodDef)
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
ILCodeVersioningState* pILCodeVersioningState = GetILCodeVersioningState(pModule, methodDef);
if (pILCodeVersioningState == NULL)
{
return ILCodeVersion(pModule, methodDef);
}
else
{
return pILCodeVersioningState->GetActiveVersion();
}
}
ILCodeVersion CodeVersionManager::GetILCodeVersion(PTR_MethodDesc pMethod, ReJITID rejitId)
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
#ifdef FEATURE_REJIT
ILCodeVersionCollection collection = GetILCodeVersions(pMethod);
for (ILCodeVersionIterator cur = collection.Begin(), end = collection.End(); cur != end; cur++)
{
if (cur->GetVersionId() == rejitId)
{
return *cur;
}
}
return ILCodeVersion();
#else // FEATURE_REJIT
_ASSERTE(rejitId == 0);
return ILCodeVersion(dac_cast<PTR_Module>(pMethod->GetModule()), pMethod->GetMemberDef());
#endif // FEATURE_REJIT
}
NativeCodeVersionCollection CodeVersionManager::GetNativeCodeVersions(PTR_MethodDesc pMethod) const
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
return NativeCodeVersionCollection(pMethod, ILCodeVersion());
}
NativeCodeVersion CodeVersionManager::GetNativeCodeVersion(PTR_MethodDesc pMethod, PCODE codeStartAddress) const
{
LIMITED_METHOD_DAC_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
NativeCodeVersionCollection nativeCodeVersions = GetNativeCodeVersions(pMethod);
for (NativeCodeVersionIterator cur = nativeCodeVersions.Begin(), end = nativeCodeVersions.End(); cur != end; cur++)
{
if (cur->GetNativeCode() == codeStartAddress)
{
return *cur;
}
}
return NativeCodeVersion();
}
#ifndef DACCESS_COMPILE
HRESULT CodeVersionManager::AddILCodeVersion(Module* pModule, mdMethodDef methodDef, ReJITID rejitId, ILCodeVersion* pILCodeVersion)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
ILCodeVersioningState* pILCodeVersioningState;
HRESULT hr = GetOrCreateILCodeVersioningState(pModule, methodDef, &pILCodeVersioningState);
if (FAILED(hr))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
ILCodeVersionNode* pILCodeVersionNode = new (nothrow) ILCodeVersionNode(pModule, methodDef, rejitId);
if (pILCodeVersionNode == NULL)
{
return E_OUTOFMEMORY;
}
pILCodeVersioningState->LinkILCodeVersionNode(pILCodeVersionNode);
*pILCodeVersion = ILCodeVersion(pILCodeVersionNode);
return S_OK;
}
HRESULT CodeVersionManager::SetActiveILCodeVersions(ILCodeVersion* pActiveVersions, DWORD cActiveVersions, BOOL fEESuspended, CDynArray<CodePublishError> * pErrors)
{
// If the IL version is in the shared domain we need to iterate all domains
// looking for instantiations. The domain iterator lock is bigger than
// the code version manager lock so we can't do this atomically. In one atomic
// update the bookkeeping for IL versioning will happen and then in a second
// update the active native code versions will change/code jumpstamps+precodes
// will update.
//
// Note: For all domains other than the shared AppDomain we could do this
// atomically, but for now we use the lowest common denominator for all
// domains.
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_PREEMPTIVE;
CAN_TAKE_LOCK;
PRECONDITION(CheckPointer(pActiveVersions));
PRECONDITION(CheckPointer(pErrors, NULL_OK));
}
CONTRACTL_END;
_ASSERTE(!LockOwnedByCurrentThread());
HRESULT hr = S_OK;
#if DEBUG
for (DWORD i = 0; i < cActiveVersions; i++)
{
ILCodeVersion activeVersion = pActiveVersions[i];
if (activeVersion.IsNull())
{
_ASSERTE(!"The active IL version can't be NULL");
}
}
#endif
// step 1 - mark the IL versions as being active, this ensures that
// any new method instantiations added after this point will bind to
// the correct version
{
TableLockHolder(this);
for (DWORD i = 0; i < cActiveVersions; i++)
{
ILCodeVersion activeVersion = pActiveVersions[i];
ILCodeVersioningState* pILCodeVersioningState = NULL;
if (FAILED(hr = GetOrCreateILCodeVersioningState(activeVersion.GetModule(), activeVersion.GetMethodDef(), &pILCodeVersioningState)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
pILCodeVersioningState->SetActiveVersion(activeVersion);
}
}
// step 2 - determine the set of pre-existing method instantiations
// a parallel array to activeVersions
// for each ILCodeVersion in activeVersions, this lists the set
// MethodDescs that will need to be updated
CDynArray<CDynArray<MethodDesc*>> methodDescsToUpdate;
CDynArray<CodePublishError> errorRecords;
for (DWORD i = 0; i < cActiveVersions; i++)
{
CDynArray<MethodDesc*>* pMethodDescs = methodDescsToUpdate.Append();
if (pMethodDescs == NULL)
{
return E_OUTOFMEMORY;
}
*pMethodDescs = CDynArray<MethodDesc*>();
MethodDesc* pLoadedMethodDesc = pActiveVersions[i].GetModule()->LookupMethodDef(pActiveVersions[i].GetMethodDef());
if (FAILED(hr = CodeVersionManager::EnumerateClosedMethodDescs(pLoadedMethodDesc, pMethodDescs, &errorRecords)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
}
// step 3 - update each pre-existing method instantiation
{
TableLockHolder lock(this);
for (DWORD i = 0; i < cActiveVersions; i++)
{
// Its possible the active IL version has changed if
// another caller made an update while this method wasn't
// holding the lock. We will ensure that we synchronize
// publishing to whatever version is currently active, even
// if that isn't the IL version we set above.
//
// Note: Although we attempt to handle this case gracefully
// it isn't recommended for callers to do this. Racing two calls
// that set the IL version to different results means it will be
// completely arbitrary which version wins.
ILCodeVersion requestedActiveILVersion = pActiveVersions[i];
ILCodeVersion activeILVersion = GetActiveILCodeVersion(requestedActiveILVersion.GetModule(), requestedActiveILVersion.GetMethodDef());
CDynArray<MethodDesc*> methodDescs = methodDescsToUpdate[i];
for (int j = 0; j < methodDescs.Count(); j++)
{
// Get an the active child code version for this method instantiation (it might be NULL, that is OK)
NativeCodeVersion activeNativeChild = activeILVersion.GetActiveNativeCodeVersion(methodDescs[j]);
// Publish that child version, because it is the active native child of the active IL version
// Failing to publish is non-fatal, but we do record it so the caller is aware
if (FAILED(hr = PublishNativeCodeVersion(methodDescs[j], activeNativeChild, fEESuspended)))
{
if (FAILED(hr = AddCodePublishError(activeILVersion.GetModule(), activeILVersion.GetMethodDef(), methodDescs[j], hr, &errorRecords)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
}
}
}
}
return S_OK;
}
HRESULT CodeVersionManager::AddNativeCodeVersion(
ILCodeVersion ilCodeVersion,
MethodDesc* pClosedMethodDesc,
NativeCodeVersion::OptimizationTier optimizationTier,
NativeCodeVersion* pNativeCodeVersion)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
MethodDescVersioningState* pMethodVersioningState;
HRESULT hr = GetOrCreateMethodDescVersioningState(pClosedMethodDesc, &pMethodVersioningState);
if (FAILED(hr))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
NativeCodeVersionId newId = pMethodVersioningState->AllocateVersionId();
NativeCodeVersionNode* pNativeCodeVersionNode = new (nothrow) NativeCodeVersionNode(newId, pClosedMethodDesc, ilCodeVersion.GetVersionId(), optimizationTier);
if (pNativeCodeVersionNode == NULL)
{
return E_OUTOFMEMORY;
}
pMethodVersioningState->LinkNativeCodeVersionNode(pNativeCodeVersionNode);
// the first child added is automatically considered the active one.
if (ilCodeVersion.GetActiveNativeCodeVersion(pClosedMethodDesc).IsNull())
{
pNativeCodeVersionNode->SetActiveChildFlag(TRUE);
_ASSERTE(!ilCodeVersion.GetActiveNativeCodeVersion(pClosedMethodDesc).IsNull());
// the new child shouldn't have any native code. If it did we might need to
// publish that code as part of adding the node which would require callers
// to pay attention to GC suspension and we'd need to report publishing errors
// back to them.
_ASSERTE(pNativeCodeVersionNode->GetNativeCode() == NULL);
}
*pNativeCodeVersion = NativeCodeVersion(pNativeCodeVersionNode);
return S_OK;
}
PCODE CodeVersionManager::PublishVersionableCodeIfNecessary(MethodDesc* pMethodDesc, BOOL fCanBackpatchPrestub)
{
STANDARD_VM_CONTRACT;
_ASSERTE(!LockOwnedByCurrentThread());
_ASSERTE(pMethodDesc->IsVersionable());
_ASSERTE(!pMethodDesc->IsPointingToPrestub() || !pMethodDesc->IsVersionableWithJumpStamp());
HRESULT hr = S_OK;
PCODE pCode = NULL;
NativeCodeVersion activeVersion;
{
TableLockHolder lock(this);
if (FAILED(hr = GetActiveILCodeVersion(pMethodDesc).GetOrCreateActiveNativeCodeVersion(pMethodDesc, &activeVersion)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
ReportCodePublishError(pMethodDesc->GetModule(), pMethodDesc->GetMemberDef(), pMethodDesc, hr);
return NULL;
}
}
BOOL fEESuspend = FALSE;
while (true)
{
// compile the code if needed
pCode = activeVersion.GetNativeCode();
if (pCode == NULL)
{
pCode = pMethodDesc->PrepareCode(activeVersion);
}
MethodDescBackpatchInfoTracker::ConditionalLockHolder lockHolder(pMethodDesc->MayHaveEntryPointSlotsToBackpatch());
// suspend in preparation for publishing if needed
if (fEESuspend)
{
ThreadSuspend::SuspendEE(ThreadSuspend::SUSPEND_FOR_REJIT);
}
{
TableLockHolder lock(this);
// The common case is that newActiveCode == activeCode, however we did leave the lock so there is
// possibility that the active version has changed. If it has we need to restart the compilation
// and publishing process with the new active version instead.
//
// In theory it should be legitimate to break out of this loop and run the less recent active version,
// because ultimately this is a race between one thread that is updating the version and another thread
// trying to run the current version. However for back-compat with ReJIT we need to guarantee that
// a versioning update at least as late as the profiler JitCompilationFinished callback wins the race.
NativeCodeVersion newActiveVersion;
if (FAILED(hr = GetActiveILCodeVersion(pMethodDesc).GetOrCreateActiveNativeCodeVersion(pMethodDesc, &newActiveVersion)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
ReportCodePublishError(pMethodDesc->GetModule(), pMethodDesc->GetMemberDef(), pMethodDesc, hr);
pCode = NULL;
break;
}
if (newActiveVersion != activeVersion)
{
activeVersion = newActiveVersion;
}
else
{
// if we aren't allowed to backpatch we are done
if (!fCanBackpatchPrestub)
{
break;
}
// attempt to publish the active version still under the lock
if (FAILED(hr = PublishNativeCodeVersion(pMethodDesc, activeVersion, fEESuspend)))
{
// If we need an EESuspend to publish then start over. We have to leave the lock in order to suspend,
// and when we leave the lock the active version might change again. However now we know that suspend is
// necessary.
if (hr == CORPROF_E_RUNTIME_SUSPEND_REQUIRED)
{
_ASSERTE(!fEESuspend);
fEESuspend = true;
continue; // skip RestartEE() below since SuspendEE() has not been called yet
}
else
{
ReportCodePublishError(pMethodDesc->GetModule(), pMethodDesc->GetMemberDef(), pMethodDesc, hr);
pCode = NULL;
break;
}
}
else
{
//success
break;
}
}
} // exit lock
if (fEESuspend)
{
ThreadSuspend::RestartEE(FALSE, TRUE);
}
}
// if the EE is still suspended from breaking in the middle of the loop, resume it
if (fEESuspend)
{
ThreadSuspend::RestartEE(FALSE, TRUE);
}
return pCode;
}
HRESULT CodeVersionManager::PublishNativeCodeVersion(MethodDesc* pMethod, NativeCodeVersion nativeCodeVersion, BOOL fEESuspended)
{
// TODO: This function needs to make sure it does not change the precode's target if call counting is in progress. Track
// whether call counting is currently being done for the method, and use a lock to ensure the expected precode target.
WRAPPER_NO_CONTRACT;
_ASSERTE(LockOwnedByCurrentThread());
_ASSERTE(pMethod->IsVersionable());
HRESULT hr = S_OK;
PCODE pCode = nativeCodeVersion.IsNull() ? NULL : nativeCodeVersion.GetNativeCode();
if (pMethod->IsVersionableWithoutJumpStamp())
{
EX_TRY
{
if (pCode == NULL)
{
pMethod->ResetCodeEntryPoint();
}
else
{
pMethod->SetCodeEntryPoint(pCode);
}
}
EX_CATCH_HRESULT(hr);
return hr;
}
else
{
#ifndef FEATURE_JUMPSTAMP
_ASSERTE(!"This platform doesn't support JumpStamp but this method doesn't version with Precode,"
" this method can't be updated");
return E_FAIL;
#else
MethodDescVersioningState* pVersioningState;
if (FAILED(hr = GetOrCreateMethodDescVersioningState(pMethod, &pVersioningState)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
return pVersioningState->SyncJumpStamp(nativeCodeVersion, fEESuspended);
#endif
}
}
// static
HRESULT CodeVersionManager::EnumerateClosedMethodDescs(
MethodDesc* pMD,
CDynArray<MethodDesc*> * pClosedMethodDescs,
CDynArray<CodePublishError> * pUnsupportedMethodErrors)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_PREEMPTIVE;
CAN_TAKE_LOCK;
PRECONDITION(CheckPointer(pMD, NULL_OK));
PRECONDITION(CheckPointer(pClosedMethodDescs));
PRECONDITION(CheckPointer(pUnsupportedMethodErrors));
}
CONTRACTL_END;
HRESULT hr = S_OK;
if (pMD == NULL)
{
// nothing is loaded yet so we're done for this method.
return S_OK;
}
if (!pMD->HasClassOrMethodInstantiation())
{
// We have a JITted non-generic.
MethodDesc ** ppMD = pClosedMethodDescs->Append();
if (ppMD == NULL)
{
return E_OUTOFMEMORY;
}
*ppMD = pMD;
}
if (!pMD->HasClassOrMethodInstantiation())
{
// not generic, we're done for this method
return S_OK;
}
// Ok, now the case of a generic function (or function on generic class), which
// is loaded, and may thus have compiled instantiations.
// It's impossible to get to any other kind of domain from the profiling API
Module* pModule = pMD->GetModule();
mdMethodDef methodDef = pMD->GetMemberDef();
BaseDomain * pBaseDomainFromModule = pModule->GetDomain();
_ASSERTE(pBaseDomainFromModule->IsAppDomain() ||
pBaseDomainFromModule->IsSharedDomain());
if (pBaseDomainFromModule->IsSharedDomain())
{
// Iterate through all modules loaded into the shared domain, to
// find all instantiations living in the shared domain. This will
// include orphaned code (i.e., shared code used by ADs that have
// all unloaded), which is good, because orphaned code could get
// re-adopted if a new AD is created that can use that shared code
hr = EnumerateDomainClosedMethodDescs(
NULL, // NULL means to search SharedDomain instead of an AD
pModule,
methodDef,
pClosedMethodDescs,
pUnsupportedMethodErrors);
}
else
{
// Module is unshared, so just use the module's domain to find instantiations.
hr = EnumerateDomainClosedMethodDescs(
pBaseDomainFromModule->AsAppDomain(),
pModule,
methodDef,
pClosedMethodDescs,
pUnsupportedMethodErrors);
}
if (FAILED(hr))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
// We want to iterate through all compilations of existing instantiations to
// ensure they get marked for rejit. Note: There may be zero instantiations,
// but we won't know until we try.
if (pBaseDomainFromModule->IsSharedDomain())
{
// Iterate through all real domains, to find shared instantiations.
AppDomainIterator appDomainIterator(TRUE);
while (appDomainIterator.Next())
{
AppDomain * pAppDomain = appDomainIterator.GetDomain();
hr = EnumerateDomainClosedMethodDescs(
pAppDomain,
pModule,
methodDef,
pClosedMethodDescs,
pUnsupportedMethodErrors);
if (FAILED(hr))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
}
}
return S_OK;
}
// static
HRESULT CodeVersionManager::EnumerateDomainClosedMethodDescs(
AppDomain * pAppDomainToSearch,
Module* pModuleContainingMethodDef,
mdMethodDef methodDef,
CDynArray<MethodDesc*> * pClosedMethodDescs,
CDynArray<CodePublishError> * pUnsupportedMethodErrors)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_PREEMPTIVE;
CAN_TAKE_LOCK;
PRECONDITION(CheckPointer(pAppDomainToSearch, NULL_OK));
PRECONDITION(CheckPointer(pModuleContainingMethodDef));
PRECONDITION(CheckPointer(pClosedMethodDescs));
PRECONDITION(CheckPointer(pUnsupportedMethodErrors));
}
CONTRACTL_END;
_ASSERTE(methodDef != mdTokenNil);
HRESULT hr;
BaseDomain * pDomainContainingGenericDefinition = pModuleContainingMethodDef->GetDomain();
#ifdef _DEBUG
// If the generic definition is not loaded domain-neutral, then all its
// instantiations will also be non-domain-neutral and loaded into the same
// domain as the generic definition. So the caller may only pass the
// domain containing the generic definition as pAppDomainToSearch
if (!pDomainContainingGenericDefinition->IsSharedDomain())
{
_ASSERTE(pDomainContainingGenericDefinition == pAppDomainToSearch);
}
#endif //_DEBUG
// these are the default flags which won't actually be used in shared mode other than
// asserting they were specified with their default values
AssemblyIterationFlags assemFlags = (AssemblyIterationFlags)(kIncludeLoaded | kIncludeExecution);
ModuleIterationOption moduleFlags = (ModuleIterationOption)kModIterIncludeLoaded;
if (pAppDomainToSearch != NULL)
{
assemFlags = (AssemblyIterationFlags)(kIncludeAvailableToProfilers | kIncludeExecution);
moduleFlags = (ModuleIterationOption)kModIterIncludeAvailableToProfilers;
}
LoadedMethodDescIterator it(
pAppDomainToSearch,
pModuleContainingMethodDef,
methodDef,
assemFlags,
moduleFlags);
CollectibleAssemblyHolder<DomainAssembly *> pDomainAssembly;
while (it.Next(pDomainAssembly.This()))
{
MethodDesc * pLoadedMD = it.Current();
if (!pLoadedMD->IsVersionable())
{
// For compatibility with the rejit APIs we ensure certain errors are detected and reported using their
// original HRESULTS
HRESULT errorHR = GetNonVersionableError(pLoadedMD);
if (FAILED(errorHR))
{
if (FAILED(hr = CodeVersionManager::AddCodePublishError(pModuleContainingMethodDef, methodDef, pLoadedMD, CORPROF_E_FUNCTION_IS_COLLECTIBLE, pUnsupportedMethodErrors)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
}
continue;
}
#ifdef _DEBUG
if (!pDomainContainingGenericDefinition->IsSharedDomain())
{
// Method is defined outside of the shared domain, so its instantiation must
// be defined in the AD we're iterating over (pAppDomainToSearch, which, as
// asserted above, must be the same domain as the generic's definition)
_ASSERTE(pLoadedMD->GetDomain() == pAppDomainToSearch);
}
#endif // _DEBUG
MethodDesc ** ppMD = pClosedMethodDescs->Append();
if (ppMD == NULL)
{
return E_OUTOFMEMORY;
}
*ppMD = pLoadedMD;
}
return S_OK;
}
#endif // DACCESS_COMPILE
//---------------------------------------------------------------------------------------
//
// Given the default version code for a MethodDesc that is about to published, add
// a jumpstamp pointing back to the prestub if the currently active version isn't
// the default one. This called from the PublishMethodHolder.
//
// Arguments:
// * pMD - MethodDesc to jmp-stamp
// * pCode - Top of the code that was just jitted (using original IL).
//
//
// Return value:
// * S_OK: Either we successfully did the jmp-stamp, or we didn't have to
// * Else, HRESULT indicating failure.
// Assumptions:
// The caller has not yet published pCode to the MethodDesc, so no threads can be
// executing inside pMD's code yet. Thus, we don't need to suspend the runtime while
// applying the jump-stamp like we usually do for rejit requests that are made after
// a function has been JITted.
//
#ifndef DACCESS_COMPILE
HRESULT CodeVersionManager::DoJumpStampIfNecessary(MethodDesc* pMD, PCODE pCode)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
CAN_TAKE_LOCK;
PRECONDITION(CheckPointer(pMD));
PRECONDITION(pCode != NULL);
}
CONTRACTL_END;
_ASSERTE(LockOwnedByCurrentThread());
NativeCodeVersion activeCodeVersion = GetActiveILCodeVersion(pMD).GetActiveNativeCodeVersion(pMD);
if (activeCodeVersion.IsDefaultVersion())
{
//Method not requested to be rejitted, nothing to do
return S_OK;
}
if (!pMD->IsVersionableWithJumpStamp())
{
return GetNonVersionableError(pMD);
}
#ifndef FEATURE_JUMPSTAMP
_ASSERTE(!"How did we get here? IsVersionableWithJumpStamp() should have been false above");
return S_OK;
#else
HRESULT hr;
MethodDescVersioningState* pVersioningState;
if (FAILED(hr = GetOrCreateMethodDescVersioningState(pMD, &pVersioningState)))
{
_ASSERTE(hr == E_OUTOFMEMORY);
return hr;
}
if (pVersioningState->GetJumpStampState() != MethodDescVersioningState::JumpStampNone)
{
//JumpStamp already in place
return S_OK;
}
return pVersioningState->JumpStampNativeCode(pCode);
#endif // FEATURE_JUMPSTAMP
}
#endif // DACCESS_COMPILE
#ifndef DACCESS_COMPILE
//static
void CodeVersionManager::OnAppDomainExit(AppDomain * pAppDomain)
{
LIMITED_METHOD_CONTRACT;
// This would clean up all the allocations we have done and synchronize with any threads that might
// still be using the data
_ASSERTE(!".Net Core shouldn't be doing app domain shutdown - if we start doing so this needs to be implemented");
}
#endif
// Returns true if CodeVersionManager is capable of versioning this method. There may be other reasons that the runtime elects
// not to version a method even if CodeVersionManager could support it. Use the MethodDesc::IsVersionableWith*() accessors to
// get the final determination of versioning support for a given method.
//
//static
bool CodeVersionManager::IsMethodSupported(PTR_MethodDesc pMethodDesc)
{
WRAPPER_NO_CONTRACT;
_ASSERTE(pMethodDesc != NULL);
return
// CodeVersionManager data structures don't properly handle the lifetime semantics of dynamic code at this point
!pMethodDesc->IsDynamicMethod() &&
// CodeVersionManager data structures don't properly handle the lifetime semantics of collectible code at this point
!pMethodDesc->GetLoaderAllocator()->IsCollectible() &&
// EnC has its own way of versioning
!pMethodDesc->IsEnCMethod();
}
//---------------------------------------------------------------------------------------
//
// Small helper to determine whether a given (possibly instantiated generic) MethodDesc
// is safe to rejit.
//
// Arguments:
// pMD - MethodDesc to test
// Return Value:
// S_OK iff pMD is safe to rejit
// CORPROF_E_FUNCTION_IS_COLLECTIBLE - function can't be rejitted because it is collectible
//
// static
#ifndef DACCESS_COMPILE
HRESULT CodeVersionManager::GetNonVersionableError(MethodDesc* pMD)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
CAN_TAKE_LOCK;
MODE_ANY;
}
CONTRACTL_END;
_ASSERTE(pMD != NULL);
// Weird, non-user functions were already weeded out in RequestReJIT(), and will
// also never be passed to us by the prestub worker (for the pre-rejit case).
_ASSERTE(pMD->IsIL());
// Any MethodDescs that could be collected are not currently supported. Although we
// rule out all Ref.Emit modules in RequestReJIT(), there can still exist types defined
// in a non-reflection module and instantiated into a collectible assembly
// (e.g., List<MyCollectibleStruct>). In the future we may lift this
// restriction by updating the ReJitManager when the collectible assemblies
// owning the instantiations get collected.
if (pMD->GetLoaderAllocator()->IsCollectible())
{
return CORPROF_E_FUNCTION_IS_COLLECTIBLE;
}
return S_OK;
}
#endif
//---------------------------------------------------------------------------------------
//
// Helper that inits a new CodePublishError and adds it to the pErrors array
//
// Arguments:
// * pModule - The module in the module/MethodDef identifier pair for the method which
// had an error during rejit
// * methodDef - The MethodDef in the module/MethodDef identifier pair for the method which
// had an error during rejit
// * pMD - If available, the specific method instance which had an error during rejit
// * hrStatus - HRESULT for the rejit error that occurred
// * pErrors - the list of error records that this method will append to
//
// Return Value:
// * S_OK: error was appended
// * E_OUTOFMEMORY: Not enough memory to create the new error item. The array is unchanged.
//
//static
#ifndef DACCESS_COMPILE
HRESULT CodeVersionManager::AddCodePublishError(Module* pModule, mdMethodDef methodDef, MethodDesc* pMD, HRESULT hrStatus, CDynArray<CodePublishError> * pErrors)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
if (pErrors == NULL)
{
return S_OK;
}
CodePublishError* pError = pErrors->Append();
if (pError == NULL)
{
return E_OUTOFMEMORY;
}
pError->pModule = pModule;
pError->methodDef = methodDef;
pError->pMethodDesc = pMD;
pError->hrStatus = hrStatus;
return S_OK;
}
#endif
#ifndef DACCESS_COMPILE
void CodeVersionManager::ReportCodePublishError(CodePublishError* pErrorRecord)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
CAN_TAKE_LOCK;
MODE_ANY;
}
CONTRACTL_END;
ReportCodePublishError(pErrorRecord->pModule, pErrorRecord->methodDef, pErrorRecord->pMethodDesc, pErrorRecord->hrStatus);
}
void CodeVersionManager::ReportCodePublishError(Module* pModule, mdMethodDef methodDef, MethodDesc* pMD, HRESULT hrStatus)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
CAN_TAKE_LOCK;
MODE_ANY;
}
CONTRACTL_END;
#ifdef FEATURE_REJIT
BOOL isRejitted = FALSE;
{
TableLockHolder(this);
isRejitted = !GetActiveILCodeVersion(pModule, methodDef).IsDefaultVersion();
}
// this isn't perfect, we might be activating a tiered jitting variation of a rejitted
// method for example. If it proves to be an issue we can revisit.
if (isRejitted)
{
ReJitManager::ReportReJITError(pModule, methodDef, pMD, hrStatus);
}
#endif
}
#endif // DACCESS_COMPILE
//---------------------------------------------------------------------------------------
//
// PrepareCodeConfig::SetNativeCode() calls this to determine if there's a non-default code
// version requested for a MethodDesc that has just been jitted for the first time.
// This is also called when methods are being restored in NGEN images. The sequence looks like:
// *Enter holder
// Enter code version manager lock
// DoJumpStampIfNecessary
// *Runtime code publishes/restores method
// *Exit holder
// Leave code version manager lock
// Send rejit error callbacks if needed
//
//
// #PublishCode:
// Note that the runtime needs to publish/restore the PCODE while this holder is
// on the stack, so it can happen under the code version manager's lock.
// This prevents a race with a profiler that calls
// RequestReJIT just as the method finishes compiling. In particular, the locking ensures
// atomicity between this set of steps (performed in DoJumpStampIfNecessary):
// * (1) Checking whether there is a non-default version for this MD
// * (2) If not, skip doing the jmp-stamp
// * (3) Publishing the PCODE
//
// with respect to these steps performed in RequestReJIT:
// * (a) Is PCODE published yet?
// * (b) Create non-default ILCodeVersion which the prestub will
// consult when it JITs the original IL
//
// Without this atomicity, we could get the ordering (1), (2), (a), (b), (3), resulting
// in the rejit request getting completely ignored (i.e., we file away the new ILCodeVersion
// AFTER the prestub checks for it).
//
// A similar race is possible for code being restored. In that case the restoring thread
// does:
// * (1) Check if there is a non-default ILCodeVersion for this MD
// * (2) If not, no need to jmp-stamp
// * (3) Restore the MD
// And RequestRejit does:
// * (a) [In LoadedMethodDescIterator] Is a potential MD restored yet?
// * (b) [In EnumerateDomainClosedMethodDescs] If not, don't queue it for jump-stamping
//
// Same ordering (1), (2), (a), (b), (3) results in missing both opportunities to jump
// stamp.
#if !defined(DACCESS_COMPILE) && !defined(CROSSGEN_COMPILE)
PublishMethodHolder::PublishMethodHolder(MethodDesc* pMethodDesc, PCODE pCode) :
m_pMD(NULL), m_hr(S_OK)
{
// This method can't have a contract because entering the table lock
// below increments GCNoTrigger count. Contracts always revert these changes
// at the end of the method but we need the incremented count to flow out of the
// method. The balancing decrement occurs in the destructor.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_CAN_TAKE_LOCK;
STATIC_CONTRACT_MODE_ANY;
// We come here from the PreStub and from MethodDesc::CheckRestore
// The method should be effectively restored, but we haven't yet
// cleared the unrestored bit so we can't assert pMethodDesc->IsRestored()
// We can assert:
_ASSERTE(pMethodDesc->GetMethodTable()->IsRestored());
if (pCode != NULL)
{
m_pMD = pMethodDesc;
CodeVersionManager* pCodeVersionManager = pMethodDesc->GetCodeVersionManager();
pCodeVersionManager->EnterLock();
m_hr = pCodeVersionManager->DoJumpStampIfNecessary(pMethodDesc, pCode);
}
}
PublishMethodHolder::~PublishMethodHolder()
{
// This method can't have a contract because leaving the table lock
// below decrements GCNoTrigger count. Contracts always revert these changes
// at the end of the method but we need the decremented count to flow out of the
// method. The balancing increment occurred in the constructor.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_TRIGGERS; // NOTRIGGER until we leave the lock
STATIC_CONTRACT_CAN_TAKE_LOCK;
STATIC_CONTRACT_MODE_ANY;
if (m_pMD)
{
CodeVersionManager* pCodeVersionManager = m_pMD->GetCodeVersionManager();
pCodeVersionManager->LeaveLock();
if (FAILED(m_hr))
{
pCodeVersionManager->ReportCodePublishError(m_pMD->GetModule(), m_pMD->GetMemberDef(), m_pMD, m_hr);
}
}
}
PublishMethodTableHolder::PublishMethodTableHolder(MethodTable* pMethodTable) :
m_pMethodTable(NULL)
{
// This method can't have a contract because entering the table lock
// below increments GCNoTrigger count. Contracts always revert these changes
// at the end of the method but we need the incremented count to flow out of the
// method. The balancing decrement occurs in the destructor.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_CAN_TAKE_LOCK;
STATIC_CONTRACT_MODE_ANY;
// We come here from MethodTable::SetIsRestored
// The method table should be effectively restored, but we haven't yet
// cleared the unrestored bit so we can't assert pMethodTable->IsRestored()
m_pMethodTable = pMethodTable;
CodeVersionManager* pCodeVersionManager = pMethodTable->GetModule()->GetCodeVersionManager();
pCodeVersionManager->EnterLock();
MethodTable::IntroducedMethodIterator itMethods(pMethodTable, FALSE);
for (; itMethods.IsValid(); itMethods.Next())
{
// Although the MethodTable is restored, the methods might not be.
// We need to be careful to only query portions of the MethodDesc
// that work in a partially restored state. The only methods that need
// further restoration are IL stubs (which aren't rejittable) and
// generic methods. The only generic methods directly accessible from
// the MethodTable are definitions. GetNativeCode() on generic defs
// will run succesfully and return NULL which short circuits the
// rest of the logic.
MethodDesc * pMD = itMethods.GetMethodDesc();
PCODE pCode = pMD->GetNativeCode();
if (pCode != NULL)
{
HRESULT hr = pCodeVersionManager->DoJumpStampIfNecessary(pMD, pCode);
if (FAILED(hr))
{
CodeVersionManager::AddCodePublishError(pMD->GetModule(), pMD->GetMemberDef(), pMD, hr, &m_errors);
}
}
}
}
PublishMethodTableHolder::~PublishMethodTableHolder()
{
// This method can't have a contract because leaving the table lock
// below decrements GCNoTrigger count. Contracts always revert these changes
// at the end of the method but we need the decremented count to flow out of the
// method. The balancing increment occurred in the constructor.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_TRIGGERS; // NOTRIGGER until we leave the lock
STATIC_CONTRACT_CAN_TAKE_LOCK;
STATIC_CONTRACT_MODE_ANY;
if (m_pMethodTable)
{
CodeVersionManager* pCodeVersionManager = m_pMethodTable->GetModule()->GetCodeVersionManager();
pCodeVersionManager->LeaveLock();
for (int i = 0; i < m_errors.Count(); i++)
{
pCodeVersionManager->ReportCodePublishError(&(m_errors[i]));
}
}
}
#endif // !defined(DACCESS_COMPILE) && !defined(CROSSGEN_COMPILE)
#endif // FEATURE_CODE_VERSIONING
|