1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
|
// 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.
//
// THREADS.CPP
//
//
//
#include "common.h"
#include "tls.h"
#include "frames.h"
#include "threads.h"
#include "stackwalk.h"
#include "excep.h"
#include "comsynchronizable.h"
#include "log.h"
#include "gcheaputilities.h"
#include "mscoree.h"
#include "dbginterface.h"
#include "corprof.h" // profiling
#include "eeprofinterfaces.h"
#include "eeconfig.h"
#include "perfcounters.h"
#include "corhost.h"
#include "win32threadpool.h"
#include "jitinterface.h"
#include "eventtrace.h"
#include "comutilnative.h"
#include "finalizerthread.h"
#include "threadsuspend.h"
#include "wrappers.h"
#include "nativeoverlapped.h"
#include "mdaassistants.h"
#include "appdomain.inl"
#include "vmholder.h"
#include "exceptmacros.h"
#include "win32threadpool.h"
#ifdef FEATURE_COMINTEROP
#include "runtimecallablewrapper.h"
#include "interoputil.h"
#include "interoputil.inl"
#endif // FEATURE_COMINTEROP
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
#include "olecontexthelpers.h"
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
#ifdef FEATURE_PERFTRACING
#include "eventpipebuffermanager.h"
#endif // FEATURE_PERFTRACING
SPTR_IMPL(ThreadStore, ThreadStore, s_pThreadStore);
CONTEXT *ThreadStore::s_pOSContext = NULL;
CLREvent *ThreadStore::s_pWaitForStackCrawlEvent;
static CrstStatic s_initializeYieldProcessorNormalizedCrst;
#ifndef DACCESS_COMPILE
BOOL Thread::s_fCleanFinalizedThread = FALSE;
Volatile<LONG> Thread::s_threadPoolCompletionCountOverflow = 0;
CrstStatic g_DeadlockAwareCrst;
#if defined(_DEBUG)
BOOL MatchThreadHandleToOsId ( HANDLE h, DWORD osId )
{
#ifndef FEATURE_PAL
LIMITED_METHOD_CONTRACT;
DWORD id = GetThreadId(h);
// OS call GetThreadId may fail, and return 0. In this case we can not
// make a decision if the two match or not. Instead, we ignore this check.
return id == 0 || id == osId;
#else // !FEATURE_PAL
return TRUE;
#endif // !FEATURE_PAL
}
#endif // _DEBUG
#ifdef _DEBUG_IMPL
template<> AutoCleanupGCAssert<TRUE>::AutoCleanupGCAssert()
{
SCAN_SCOPE_BEGIN;
STATIC_CONTRACT_MODE_COOPERATIVE;
}
template<> AutoCleanupGCAssert<FALSE>::AutoCleanupGCAssert()
{
SCAN_SCOPE_BEGIN;
STATIC_CONTRACT_MODE_PREEMPTIVE;
}
template<> void GCAssert<TRUE>::BeginGCAssert()
{
SCAN_SCOPE_BEGIN;
STATIC_CONTRACT_MODE_COOPERATIVE;
}
template<> void GCAssert<FALSE>::BeginGCAssert()
{
SCAN_SCOPE_BEGIN;
STATIC_CONTRACT_MODE_PREEMPTIVE;
}
#endif
// #define NEW_TLS 1
#ifdef _DEBUG
void Thread::SetFrame(Frame *pFrame)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
DEBUG_ONLY;
MODE_COOPERATIVE;
// It only makes sense for a Thread to call SetFrame on itself.
PRECONDITION(this == GetThread());
PRECONDITION(CheckPointer(pFrame));
}
CONTRACTL_END;
if (g_pConfig->fAssertOnFailFast())
{
Frame *pWalk = m_pFrame;
BOOL fExist = FALSE;
while (pWalk != (Frame*) -1)
{
if (pWalk == pFrame)
{
fExist = TRUE;
break;
}
pWalk = pWalk->m_Next;
}
pWalk = m_pFrame;
while (fExist && pWalk != pFrame && pWalk != (Frame*)-1)
{
if (pWalk->GetVTablePtr() == ContextTransitionFrame::GetMethodFrameVPtr())
{
_ASSERTE (((ContextTransitionFrame *)pWalk)->GetReturnDomain() == m_pDomain);
}
pWalk = pWalk->m_Next;
}
}
m_pFrame = pFrame;
// If stack overrun corruptions are expected, then skip this check
// as the Frame chain may have been corrupted.
if (g_pConfig->fAssertOnFailFast() == false)
return;
Frame* espVal = (Frame*)GetCurrentSP();
while (pFrame != (Frame*) -1)
{
static Frame* stopFrame = 0;
if (pFrame == stopFrame)
_ASSERTE(!"SetFrame frame == stopFrame");
_ASSERTE(espVal < pFrame);
_ASSERTE(pFrame < m_CacheStackBase);
_ASSERTE(pFrame->GetFrameType() < Frame::TYPE_COUNT);
pFrame = pFrame->m_Next;
}
}
#endif // _DEBUG
//************************************************************************
// PRIVATE GLOBALS
//************************************************************************
extern unsigned __int64 getTimeStamp();
extern unsigned __int64 getTickFrequency();
unsigned __int64 tgetFrequency() {
static unsigned __int64 cachedFreq = (unsigned __int64) -1;
if (cachedFreq != (unsigned __int64) -1)
return cachedFreq;
else {
cachedFreq = getTickFrequency();
return cachedFreq;
}
}
#endif // #ifndef DACCESS_COMPILE
static StackWalkAction DetectHandleILStubsForDebugger_StackWalkCallback(CrawlFrame *pCF, VOID *pData)
{
WRAPPER_NO_CONTRACT;
// It suffices to wait for the first CrawlFrame with non-NULL function
MethodDesc *pMD = pCF->GetFunction();
if (pMD != NULL)
{
*(bool *)pData = pMD->IsILStub();
return SWA_ABORT;
}
return SWA_CONTINUE;
}
// This is really just a heuristic to detect if we are executing in an M2U IL stub or
// one of the marshaling methods it calls. It doesn't deal with U2M IL stubs.
// We loop through the frame chain looking for an uninitialized TransitionFrame.
// If there is one, then we are executing in an M2U IL stub or one of the methods it calls.
// On the other hand, if there is an initialized TransitionFrame, then we are not.
// Also, if there is an HMF on the stack, then we stop. This could be the case where
// an IL stub calls an FCALL which ends up in a managed method, and the debugger wants to
// stop in those cases. Some examples are COMException..ctor and custom marshalers.
//
// X86 IL stubs use InlinedCallFrame and are indistinguishable from ordinary methods with
// inlined P/Invoke when judging just from the frame chain. We use stack walk to decide
// this case.
bool Thread::DetectHandleILStubsForDebugger()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
Frame* pFrame = GetFrame();
if (pFrame != NULL)
{
while (pFrame != FRAME_TOP)
{
// Check for HMF's. See the comment at the beginning of this function.
if (pFrame->GetVTablePtr() == HelperMethodFrame::GetMethodFrameVPtr())
{
break;
}
// If there is an entry frame (i.e. U2M managed), we should break.
else if (pFrame->GetFrameType() == Frame::TYPE_ENTRY)
{
break;
}
// Check for M2U transition frames. See the comment at the beginning of this function.
else if (pFrame->GetFrameType() == Frame::TYPE_EXIT)
{
if (pFrame->GetReturnAddress() == NULL)
{
// If the return address is NULL, then the frame has not been initialized yet.
// We may see InlinedCallFrame in ordinary methods as well. Have to do
// stack walk to find out if this is really an IL stub.
bool fInILStub = false;
StackWalkFrames(&DetectHandleILStubsForDebugger_StackWalkCallback,
&fInILStub,
QUICKUNWIND,
dac_cast<PTR_Frame>(pFrame));
if (fInILStub) return true;
}
else
{
// The frame is fully initialized.
return false;
}
}
pFrame = pFrame->Next();
}
}
return false;
}
extern "C" {
#ifndef __llvm__
__declspec(thread)
#else // !__llvm__
__thread
#endif // !__llvm__
ThreadLocalInfo gCurrentThreadInfo =
{
NULL, // m_pThread
NULL, // m_pAppDomain
NULL, // m_EETlsData
};
} // extern "C"
// index into TLS Array. Definition added by compiler
EXTERN_C UINT32 _tls_index;
#ifndef DACCESS_COMPILE
BOOL SetThread(Thread* t)
{
LIMITED_METHOD_CONTRACT
gCurrentThreadInfo.m_pThread = t;
return TRUE;
}
BOOL SetAppDomain(AppDomain* ad)
{
LIMITED_METHOD_CONTRACT
gCurrentThreadInfo.m_pAppDomain = ad;
return TRUE;
}
BOOL Thread::Alert ()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
BOOL fRetVal = FALSE;
{
HANDLE handle = GetThreadHandle();
if (handle != INVALID_HANDLE_VALUE && handle != SWITCHOUT_HANDLE_VALUE)
{
fRetVal = ::QueueUserAPC(UserInterruptAPC, handle, APC_Code);
}
}
return fRetVal;
}
DWORD Thread::Join(DWORD timeout, BOOL alertable)
{
WRAPPER_NO_CONTRACT;
return JoinEx(timeout,alertable?WaitMode_Alertable:WaitMode_None);
}
DWORD Thread::JoinEx(DWORD timeout, WaitMode mode)
{
CONTRACTL {
THROWS;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
BOOL alertable = (mode & WaitMode_Alertable)?TRUE:FALSE;
Thread *pCurThread = GetThread();
_ASSERTE(pCurThread || dbgOnly_IsSpecialEEThread());
{
// We're not hosted, so WaitMode_InDeadlock is irrelevant. Clear it, so that this wait can be
// forwarded to a SynchronizationContext if needed.
mode = (WaitMode)(mode & ~WaitMode_InDeadlock);
HANDLE handle = GetThreadHandle();
if (handle == INVALID_HANDLE_VALUE || handle == SWITCHOUT_HANDLE_VALUE) {
return WAIT_FAILED;
}
if (pCurThread) {
return pCurThread->DoAppropriateWait(1, &handle, FALSE, timeout, mode);
}
else {
return WaitForSingleObjectEx(handle,timeout,alertable);
}
}
}
extern INT32 MapFromNTPriority(INT32 NTPriority);
BOOL Thread::SetThreadPriority(
int nPriority // thread priority level
)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
BOOL fRet;
{
if (GetThreadHandle() == INVALID_HANDLE_VALUE) {
// When the thread starts running, we will set the thread priority.
fRet = TRUE;
}
else
fRet = ::SetThreadPriority(GetThreadHandle(), nPriority);
}
if (fRet)
{
GCX_COOP();
THREADBASEREF pObject = (THREADBASEREF)ObjectFromHandle(m_ExposedObject);
if (pObject != NULL)
{
// TODO: managed ThreadPriority only supports up to 4.
pObject->SetPriority (MapFromNTPriority(nPriority));
}
}
return fRet;
}
int Thread::GetThreadPriority()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
int nRetVal = -1;
if (GetThreadHandle() == INVALID_HANDLE_VALUE) {
nRetVal = FALSE;
}
else
nRetVal = ::GetThreadPriority(GetThreadHandle());
return nRetVal;
}
void Thread::ChooseThreadCPUGroupAffinity()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
if (!CPUGroupInfo::CanEnableGCCPUGroups() || !CPUGroupInfo::CanEnableThreadUseAllCpuGroups())
return;
//Borrow the ThreadStore Lock here: Lock ThreadStore before distributing threads
ThreadStoreLockHolder TSLockHolder(TRUE);
// this thread already has CPU group affinity set
if (m_pAffinityMask != 0)
return;
if (GetThreadHandle() == INVALID_HANDLE_VALUE)
return;
GROUP_AFFINITY groupAffinity;
CPUGroupInfo::ChooseCPUGroupAffinity(&groupAffinity);
CPUGroupInfo::SetThreadGroupAffinity(GetThreadHandle(), &groupAffinity, NULL);
m_wCPUGroup = groupAffinity.Group;
m_pAffinityMask = groupAffinity.Mask;
}
void Thread::ClearThreadCPUGroupAffinity()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
if (!CPUGroupInfo::CanEnableGCCPUGroups() || !CPUGroupInfo::CanEnableThreadUseAllCpuGroups())
return;
ThreadStoreLockHolder TSLockHolder(TRUE);
// this thread does not have CPU group affinity set
if (m_pAffinityMask == 0)
return;
GROUP_AFFINITY groupAffinity;
groupAffinity.Group = m_wCPUGroup;
groupAffinity.Mask = m_pAffinityMask;
CPUGroupInfo::ClearCPUGroupAffinity(&groupAffinity);
m_wCPUGroup = 0;
m_pAffinityMask = 0;
}
DWORD Thread::StartThread()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
DWORD dwRetVal = (DWORD) -1;
#ifdef _DEBUG
_ASSERTE (m_Creater.IsCurrentThread());
m_Creater.Clear();
#endif
_ASSERTE (GetThreadHandle() != INVALID_HANDLE_VALUE &&
GetThreadHandle() != SWITCHOUT_HANDLE_VALUE);
dwRetVal = ::ResumeThread(GetThreadHandle());
return dwRetVal;
}
// Class static data:
LONG Thread::m_DebugWillSyncCount = -1;
LONG Thread::m_DetachCount = 0;
LONG Thread::m_ActiveDetachCount = 0;
int Thread::m_offset_counter = 0;
Volatile<LONG> Thread::m_threadsAtUnsafePlaces = 0;
//-------------------------------------------------------------------------
// Public function: SetupThreadNoThrow()
// Creates Thread for current thread if not previously created.
// Returns NULL for failure (usually due to out-of-memory.)
//-------------------------------------------------------------------------
Thread* SetupThreadNoThrow(HRESULT *pHR)
{
CONTRACTL {
NOTHROW;
SO_TOLERANT;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
HRESULT hr = S_OK;
Thread *pThread = GetThread();
if (pThread != NULL)
{
return pThread;
}
EX_TRY
{
pThread = SetupThread();
}
EX_CATCH
{
// We failed SetupThread. GET_EXCEPTION() may depend on Thread object.
if (__pException == NULL)
{
hr = E_OUTOFMEMORY;
}
else
{
hr = GET_EXCEPTION()->GetHR();
}
}
EX_END_CATCH(SwallowAllExceptions);
if (pHR)
{
*pHR = hr;
}
return pThread;
}
void DeleteThread(Thread* pThread)
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
//_ASSERTE (pThread == GetThread());
SetThread(NULL);
SetAppDomain(NULL);
if (pThread->HasThreadStateNC(Thread::TSNC_ExistInThreadStore))
{
pThread->DetachThread(FALSE);
}
else
{
#ifdef FEATURE_COMINTEROP
pThread->RevokeApartmentSpy();
#endif // FEATURE_COMINTEROP
FastInterlockOr((ULONG *)&pThread->m_State, Thread::TS_Dead);
// ~Thread() calls SafeSetThrowables which has a conditional contract
// which says that if you call it with a NULL throwable then it is
// MODE_ANY, otherwise MODE_COOPERATIVE. Scan doesn't understand that
// and assumes that we're violating the MODE_COOPERATIVE.
CONTRACT_VIOLATION(ModeViolation);
delete pThread;
}
}
void EnsurePreemptive()
{
WRAPPER_NO_CONTRACT;
Thread *pThread = GetThread();
if (pThread && pThread->PreemptiveGCDisabled())
{
pThread->EnablePreemptiveGC();
}
}
typedef StateHolder<DoNothing, EnsurePreemptive> EnsurePreemptiveModeIfException;
Thread* SetupThread(BOOL fInternal)
{
CONTRACTL {
THROWS;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
SO_TOLERANT;
}
CONTRACTL_END;
Thread* pThread;
if ((pThread = GetThread()) != NULL)
return pThread;
#ifdef FEATURE_STACK_PROBE
RetailStackProbe(ADJUST_PROBE(DEFAULT_ENTRY_PROBE_AMOUNT), NULL);
#endif //FEATURE_STACK_PROBE
CONTRACT_VIOLATION(SOToleranceViolation);
// For interop debugging, we must mark that we're in a can't-stop region
// b.c we may take Crsts here that may block the helper thread.
// We're especially fragile here b/c we don't have a Thread object yet
CantStopHolder hCantStop;
EnsurePreemptiveModeIfException ensurePreemptive;
#ifdef _DEBUG
CHECK chk;
if (g_pConfig->SuppressChecks())
{
// EnterAssert will suppress any checks
chk.EnterAssert();
}
#endif
// Normally, HasStarted is called from the thread's entrypoint to introduce it to
// the runtime. But sometimes that thread is used for DLL_THREAD_ATTACH notifications
// that call into managed code. In that case, a call to SetupThread here must
// find the correct Thread object and install it into TLS.
if (ThreadStore::s_pThreadStore->m_PendingThreadCount != 0)
{
DWORD ourOSThreadId = ::GetCurrentThreadId();
{
ThreadStoreLockHolder TSLockHolder;
_ASSERTE(pThread == NULL);
while ((pThread = ThreadStore::s_pThreadStore->GetAllThreadList(pThread, Thread::TS_Unstarted | Thread::TS_FailStarted, Thread::TS_Unstarted)) != NULL)
{
if (pThread->GetOSThreadId() == ourOSThreadId)
{
break;
}
}
if (pThread != NULL)
{
STRESS_LOG2(LF_SYNC, LL_INFO1000, "T::ST - recycling thread 0x%p (state: 0x%x)\n", pThread, pThread->m_State.Load());
}
}
// It's perfectly reasonable to not find this guy. It's just an unrelated
// thread spinning up.
if (pThread)
{
if (IsThreadPoolWorkerSpecialThread())
{
FastInterlockOr((ULONG *) &pThread->m_State, Thread::TS_TPWorkerThread);
pThread->SetBackground(TRUE);
}
else if (IsThreadPoolIOCompletionSpecialThread())
{
FastInterlockOr ((ULONG *) &pThread->m_State, Thread::TS_CompletionPortThread);
pThread->SetBackground(TRUE);
}
else if (IsTimerSpecialThread() || IsWaitSpecialThread())
{
FastInterlockOr((ULONG *) &pThread->m_State, Thread::TS_TPWorkerThread);
pThread->SetBackground(TRUE);
}
BOOL fStatus = pThread->HasStarted();
ensurePreemptive.SuppressRelease();
return fStatus ? pThread : NULL;
}
}
// First time we've seen this thread in the runtime:
pThread = new Thread();
// What state are we in here? COOP???
Holder<Thread*,DoNothing<Thread*>,DeleteThread> threadHolder(pThread);
CExecutionEngine::SetupTLSForThread(pThread);
// A host can deny a thread entering runtime by returning a NULL IHostTask.
// But we do want threads used by threadpool.
if (IsThreadPoolWorkerSpecialThread() ||
IsThreadPoolIOCompletionSpecialThread() ||
IsTimerSpecialThread() ||
IsWaitSpecialThread())
{
fInternal = TRUE;
}
if (!pThread->InitThread(fInternal) ||
!pThread->PrepareApartmentAndContext())
ThrowOutOfMemory();
// reset any unstarted bits on the thread object
FastInterlockAnd((ULONG *) &pThread->m_State, ~Thread::TS_Unstarted);
FastInterlockOr((ULONG *) &pThread->m_State, Thread::TS_LegalToJoin);
ThreadStore::AddThread(pThread);
BOOL fOK = SetThread(pThread);
_ASSERTE (fOK);
fOK = SetAppDomain(pThread->GetDomain());
_ASSERTE (fOK);
// We now have a Thread object visable to the RS. unmark special status.
hCantStop.Release();
pThread->SetupThreadForHost();
threadHolder.SuppressRelease();
FastInterlockOr((ULONG *) &pThread->m_State, Thread::TS_FullyInitialized);
#ifdef _DEBUG
pThread->AddFiberInfo(Thread::ThreadTrackInfo_Lifetime);
#endif
#ifdef DEBUGGING_SUPPORTED
//
// If we're debugging, let the debugger know that this
// thread is up and running now.
//
if (CORDebuggerAttached())
{
g_pDebugInterface->ThreadCreated(pThread);
}
else
{
LOG((LF_CORDB, LL_INFO10000, "ThreadCreated() not called due to CORDebuggerAttached() being FALSE for thread 0x%x\n", pThread->GetThreadId()));
}
#endif // DEBUGGING_SUPPORTED
#ifdef PROFILING_SUPPORTED
// If a profiler is present, then notify the profiler that a
// thread has been created.
if (!IsGCSpecialThread())
{
BEGIN_PIN_PROFILER(CORProfilerTrackThreads());
{
GCX_PREEMP();
g_profControlBlock.pProfInterface->ThreadCreated(
(ThreadID)pThread);
}
DWORD osThreadId = ::GetCurrentThreadId();
g_profControlBlock.pProfInterface->ThreadAssignedToOSThread(
(ThreadID)pThread, osThreadId);
END_PIN_PROFILER();
}
#endif // PROFILING_SUPPORTED
_ASSERTE(!pThread->IsBackground()); // doesn't matter, but worth checking
pThread->SetBackground(TRUE);
ensurePreemptive.SuppressRelease();
if (IsThreadPoolWorkerSpecialThread())
{
FastInterlockOr((ULONG *) &pThread->m_State, Thread::TS_TPWorkerThread);
}
else if (IsThreadPoolIOCompletionSpecialThread())
{
FastInterlockOr ((ULONG *) &pThread->m_State, Thread::TS_CompletionPortThread);
}
else if (IsTimerSpecialThread() || IsWaitSpecialThread())
{
FastInterlockOr((ULONG *) &pThread->m_State, Thread::TS_TPWorkerThread);
}
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
if (g_fEnableARM)
{
pThread->QueryThreadProcessorUsage();
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
#ifdef FEATURE_EVENT_TRACE
ETW::ThreadLog::FireThreadCreated(pThread);
#endif // FEATURE_EVENT_TRACE
return pThread;
}
//-------------------------------------------------------------------------
void STDMETHODCALLTYPE CorMarkThreadInThreadPool()
{
LIMITED_METHOD_CONTRACT;
BEGIN_ENTRYPOINT_VOIDRET;
END_ENTRYPOINT_VOIDRET;
// this is no longer needed after our switch to
// the Win32 threadpool.
// keeping in mscorwks for compat reasons and to keep rotor sscoree and
// mscoree consistent.
}
//-------------------------------------------------------------------------
// Public function: SetupUnstartedThread()
// This sets up a Thread object for an exposed System.Thread that
// has not been started yet. This allows us to properly enumerate all threads
// in the ThreadStore, so we can report on even unstarted threads. Clearly
// there is no physical thread to match, yet.
//
// When there is, complete the setup with code:Thread::HasStarted()
//-------------------------------------------------------------------------
Thread* SetupUnstartedThread(BOOL bRequiresTSL)
{
CONTRACTL {
THROWS;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
Thread* pThread = new Thread();
FastInterlockOr((ULONG *) &pThread->m_State,
(Thread::TS_Unstarted | Thread::TS_WeOwn));
ThreadStore::AddThread(pThread, bRequiresTSL);
return pThread;
}
//-------------------------------------------------------------------------
// Public function: DestroyThread()
// Destroys the specified Thread object, for a thread which is about to die.
//-------------------------------------------------------------------------
void DestroyThread(Thread *th)
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
_ASSERTE (th == GetThread());
_ASSERTE(g_fEEShutDown || th->m_dwLockCount == 0 || th->m_fRudeAborted);
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
if (g_fEnableARM)
{
AppDomain* pDomain = th->GetDomain();
pDomain->UpdateProcessorUsage(th->QueryThreadProcessorUsage());
FireEtwThreadTerminated((ULONGLONG)th, (ULONGLONG)pDomain, GetClrInstanceId());
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
th->FinishSOWork();
GCX_PREEMP_NO_DTOR();
if (th->IsAbortRequested()) {
// Reset trapping count.
th->UnmarkThreadForAbort(Thread::TAR_ALL);
}
// Clear any outstanding stale EH state that maybe still active on the thread.
#ifdef WIN64EXCEPTIONS
ExceptionTracker::PopTrackers((void*)-1);
#else // !WIN64EXCEPTIONS
#ifdef _TARGET_X86_
PTR_ThreadExceptionState pExState = th->GetExceptionState();
if (pExState->IsExceptionInProgress())
{
GCX_COOP();
pExState->GetCurrentExceptionTracker()->UnwindExInfo((void *)-1);
}
#else // !_TARGET_X86_
#error Unsupported platform
#endif // _TARGET_X86_
#endif // WIN64EXCEPTIONS
if (g_fEEShutDown == 0)
{
th->SetThreadState(Thread::TS_ReportDead);
th->OnThreadTerminate(FALSE);
}
#ifdef FEATURE_PERFTRACING
// Before the thread dies, mark its buffers as no longer owned
// so that they can be cleaned up after the thread dies.
EventPipeBufferList *pBufferList = th->GetEventPipeBufferList();
if(pBufferList != NULL)
{
pBufferList->SetOwnedByThread(false);
}
#endif // FEATURE_PERFTRACING
}
//-------------------------------------------------------------------------
// Public function: DetachThread()
// Marks the thread as needing to be destroyed, but doesn't destroy it yet.
//-------------------------------------------------------------------------
HRESULT Thread::DetachThread(BOOL fDLLThreadDetach)
{
// !!! Can not use contract here.
// !!! Contract depends on Thread object for GC_TRIGGERS.
// !!! At the end of this function, we call InternalSwitchOut,
// !!! and then GetThread()=NULL, and dtor of contract does not work any more.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
// @todo . We need to probe here, but can't introduce destructors etc.
BEGIN_CONTRACT_VIOLATION(SOToleranceViolation);
// Clear any outstanding stale EH state that maybe still active on the thread.
#ifdef WIN64EXCEPTIONS
ExceptionTracker::PopTrackers((void*)-1);
#else // !WIN64EXCEPTIONS
#ifdef _TARGET_X86_
PTR_ThreadExceptionState pExState = GetExceptionState();
if (pExState->IsExceptionInProgress())
{
GCX_COOP();
pExState->GetCurrentExceptionTracker()->UnwindExInfo((void *)-1);
}
#else // !_TARGET_X86_
#error Unsupported platform
#endif // _TARGET_X86_
#endif // WIN64EXCEPTIONS
#ifdef FEATURE_COMINTEROP
IErrorInfo *pErrorInfo;
// Avoid calling GetErrorInfo() if ole32 has already executed the DLL_THREAD_DETACH,
// otherwise we'll cause ole32 to re-allocate and leak its TLS data (SOleTlsData).
if (ClrTeb::GetOleReservedPtr() != NULL && GetErrorInfo(0, &pErrorInfo) == S_OK)
{
// if this is our IErrorInfo, release it now - we don't want ole32 to do it later as
// part of its DLL_THREAD_DETACH as we won't be able to handle the call at that point
if (!ComInterfaceSlotIs(pErrorInfo, 2, Unknown_ReleaseSpecial_IErrorInfo))
{
// if it's not our IErrorInfo, put it back
SetErrorInfo(0, pErrorInfo);
}
pErrorInfo->Release();
}
// Revoke our IInitializeSpy registration only if we are not in DLL_THREAD_DETACH
// (COM will do it or may have already done it automatically in that case).
if (!fDLLThreadDetach)
{
RevokeApartmentSpy();
}
#endif // FEATURE_COMINTEROP
_ASSERTE(!PreemptiveGCDisabled());
_ASSERTE(g_fEEShutDown || m_dwLockCount == 0 || m_fRudeAborted);
_ASSERTE ((m_State & Thread::TS_Detached) == 0);
_ASSERTE (this == GetThread());
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
if (g_fEnableARM && m_pDomain)
{
m_pDomain->UpdateProcessorUsage(QueryThreadProcessorUsage());
FireEtwThreadTerminated((ULONGLONG)this, (ULONGLONG)m_pDomain, GetClrInstanceId());
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
FinishSOWork();
FastInterlockIncrement(&Thread::m_DetachCount);
if (IsAbortRequested()) {
// Reset trapping count.
UnmarkThreadForAbort(Thread::TAR_ALL);
}
if (!IsBackground())
{
FastInterlockIncrement(&Thread::m_ActiveDetachCount);
ThreadStore::CheckForEEShutdown();
}
END_CONTRACT_VIOLATION;
InternalSwitchOut();
#ifdef ENABLE_CONTRACTS_DATA
m_pClrDebugState = NULL;
#endif //ENABLE_CONTRACTS_DATA
#ifdef FEATURE_PERFTRACING
// Before the thread dies, mark its buffers as no longer owned
// so that they can be cleaned up after the thread dies.
EventPipeBufferList *pBufferList = m_pEventPipeBufferList.Load();
if(pBufferList != NULL)
{
pBufferList->SetOwnedByThread(false);
}
#endif // FEATURE_PERFTRACING
FastInterlockOr((ULONG*)&m_State, (int) (Thread::TS_Detached | Thread::TS_ReportDead));
// Do not touch Thread object any more. It may be destroyed.
// These detached threads will be cleaned up by finalizer thread. But if the process uses
// little managed heap, it will be a while before GC happens, and finalizer thread starts
// working on detached thread. So we wake up finalizer thread to clean up resources.
//
// (It's possible that this is the startup thread, and startup failed, and so the finalization
// machinery isn't fully initialized. Hence this check.)
if (g_fEEStarted)
FinalizerThread::EnableFinalization();
return S_OK;
}
DWORD GetRuntimeId()
{
LIMITED_METHOD_CONTRACT;
return _tls_index;
}
//---------------------------------------------------------------------------
// Creates new Thread for reverse p-invoke calls.
//---------------------------------------------------------------------------
Thread* WINAPI CreateThreadBlockThrow()
{
WRAPPER_NO_CONTRACT;
// This is a workaround to disable our check for throwing exception in SetupThread.
// We want to throw an exception for reverse p-invoke, and our assertion may fire if
// a unmanaged caller does not setup an exception handler.
CONTRACT_VIOLATION(ThrowsViolation); // WON'T FIX - This enables catastrophic failure exception in reverse P/Invoke - the only way we can communicate an error to legacy code.
Thread* pThread = NULL;
BEGIN_ENTRYPOINT_THROWS;
if (!CanRunManagedCode())
{
// CLR is shutting down - someone's DllMain detach event may be calling back into managed code.
// It is misleading to use our COM+ exception code, since this is not a managed exception.
ULONG_PTR arg = E_PROCESS_SHUTDOWN_REENTRY;
RaiseException(EXCEPTION_EXX, 0, 1, &arg);
}
HRESULT hr = S_OK;
pThread = SetupThreadNoThrow(&hr);
if (pThread == NULL)
{
// Creating Thread failed, and we need to throw an exception to report status.
// It is misleading to use our COM+ exception code, since this is not a managed exception.
ULONG_PTR arg = hr;
RaiseException(EXCEPTION_EXX, 0, 1, &arg);
}
END_ENTRYPOINT_THROWS;
return pThread;
}
#ifdef _DEBUG
DWORD_PTR Thread::OBJREF_HASH = OBJREF_TABSIZE;
#endif
extern "C" void STDCALL JIT_PatchedCodeStart();
extern "C" void STDCALL JIT_PatchedCodeLast();
//---------------------------------------------------------------------------
// One-time initialization. Called during Dll initialization. So
// be careful what you do in here!
//---------------------------------------------------------------------------
void InitThreadManager()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
s_initializeYieldProcessorNormalizedCrst.Init(CrstLeafLock);
// All patched helpers should fit into one page.
// If you hit this assert on retail build, there is most likely problem with BBT script.
_ASSERTE_ALL_BUILDS("clr/src/VM/threads.cpp", (BYTE*)JIT_PatchedCodeLast - (BYTE*)JIT_PatchedCodeStart < (ptrdiff_t)GetOsPageSize());
// I am using virtual protect to cover the entire range that this code falls in.
//
// We could reset it to non-writeable inbetween GCs and such, but then we'd have to keep on re-writing back and forth,
// so instead we'll leave it writable from here forward.
DWORD oldProt;
if (!ClrVirtualProtect((void *)JIT_PatchedCodeStart, (BYTE*)JIT_PatchedCodeLast - (BYTE*)JIT_PatchedCodeStart,
PAGE_EXECUTE_READWRITE, &oldProt))
{
_ASSERTE(!"ClrVirtualProtect of code page failed");
COMPlusThrowWin32();
}
#ifndef FEATURE_PAL
_ASSERTE(GetThread() == NULL);
PTEB Teb = NtCurrentTeb();
BYTE** tlsArray = (BYTE**)Teb->ThreadLocalStoragePointer;
BYTE* tlsData = (BYTE*)tlsArray[_tls_index];
size_t offsetOfCurrentThreadInfo = (BYTE*)&gCurrentThreadInfo - tlsData;
_ASSERTE(offsetOfCurrentThreadInfo < 0x8000);
_ASSERTE(_tls_index < 0x10000);
// Save gCurrentThreadInfo location for debugger
g_TlsIndex = (DWORD)(_tls_index + (offsetOfCurrentThreadInfo << 16) + 0x80000000);
_ASSERTE(g_TrapReturningThreads == 0);
#endif // !FEATURE_PAL
__ClrFlsGetBlock = CExecutionEngine::GetTlsData;
IfFailThrow(Thread::CLRSetThreadStackGuarantee(Thread::STSGuarantee_Force));
ThreadStore::InitThreadStore();
// NOTE: CRST_UNSAFE_ANYMODE prevents a GC mode switch when entering this crst.
// If you remove this flag, we will switch to preemptive mode when entering
// g_DeadlockAwareCrst, which means all functions that enter it will become
// GC_TRIGGERS. (This includes all uses of CrstHolder.) So be sure
// to update the contracts if you remove this flag.
g_DeadlockAwareCrst.Init(CrstDeadlockDetection, CRST_UNSAFE_ANYMODE);
#ifdef _DEBUG
// Randomize OBJREF_HASH to handle hash collision.
Thread::OBJREF_HASH = OBJREF_TABSIZE - (DbgGetEXETimeStamp()%10);
#endif // _DEBUG
ThreadSuspend::Initialize();
}
//************************************************************************
// Thread members
//************************************************************************
#if defined(_DEBUG) && defined(TRACK_SYNC)
// One outstanding synchronization held by this thread:
struct Dbg_TrackSyncEntry
{
UINT_PTR m_caller;
AwareLock *m_pAwareLock;
BOOL Equiv (UINT_PTR caller, void *pAwareLock)
{
LIMITED_METHOD_CONTRACT;
return (m_caller == caller) && (m_pAwareLock == pAwareLock);
}
BOOL Equiv (void *pAwareLock)
{
LIMITED_METHOD_CONTRACT;
return (m_pAwareLock == pAwareLock);
}
};
// Each thread has a stack that tracks all enter and leave requests
struct Dbg_TrackSyncStack : public Dbg_TrackSync
{
enum
{
MAX_TRACK_SYNC = 20, // adjust stack depth as necessary
};
void EnterSync (UINT_PTR caller, void *pAwareLock);
void LeaveSync (UINT_PTR caller, void *pAwareLock);
Dbg_TrackSyncEntry m_Stack [MAX_TRACK_SYNC];
UINT_PTR m_StackPointer;
BOOL m_Active;
Dbg_TrackSyncStack() : m_StackPointer(0),
m_Active(TRUE)
{
LIMITED_METHOD_CONTRACT;
}
};
// ensure that registers are preserved across this call
#ifdef _MSC_VER
#pragma optimize("", off)
#endif
// A pain to do all this from ASM, but watch out for trashed registers
EXTERN_C void EnterSyncHelper (UINT_PTR caller, void *pAwareLock)
{
BEGIN_ENTRYPOINT_THROWS;
WRAPPER_NO_CONTRACT;
GetThread()->m_pTrackSync->EnterSync(caller, pAwareLock);
END_ENTRYPOINT_THROWS;
}
EXTERN_C void LeaveSyncHelper (UINT_PTR caller, void *pAwareLock)
{
BEGIN_ENTRYPOINT_THROWS;
WRAPPER_NO_CONTRACT;
GetThread()->m_pTrackSync->LeaveSync(caller, pAwareLock);
END_ENTRYPOINT_THROWS;
}
#ifdef _MSC_VER
#pragma optimize("", on)
#endif
void Dbg_TrackSyncStack::EnterSync(UINT_PTR caller, void *pAwareLock)
{
LIMITED_METHOD_CONTRACT;
STRESS_LOG4(LF_SYNC, LL_INFO100, "Dbg_TrackSyncStack::EnterSync, IP=%p, Recursion=%d, MonitorHeld=%d, HoldingThread=%p.\n",
caller,
((AwareLock*)pAwareLock)->m_Recursion,
((AwareLock*)pAwareLock)->m_MonitorHeld.LoadWithoutBarrier(),
((AwareLock*)pAwareLock)->m_HoldingThread );
if (m_Active)
{
if (m_StackPointer >= MAX_TRACK_SYNC)
{
_ASSERTE(!"Overflowed synchronization stack checking. Disabling");
m_Active = FALSE;
return;
}
}
m_Stack[m_StackPointer].m_caller = caller;
m_Stack[m_StackPointer].m_pAwareLock = (AwareLock *) pAwareLock;
m_StackPointer++;
}
void Dbg_TrackSyncStack::LeaveSync(UINT_PTR caller, void *pAwareLock)
{
WRAPPER_NO_CONTRACT;
STRESS_LOG4(LF_SYNC, LL_INFO100, "Dbg_TrackSyncStack::LeaveSync, IP=%p, Recursion=%d, MonitorHeld=%d, HoldingThread=%p.\n",
caller,
((AwareLock*)pAwareLock)->m_Recursion,
((AwareLock*)pAwareLock)->m_MonitorHeld.LoadWithoutBarrier(),
((AwareLock*)pAwareLock)->m_HoldingThread );
if (m_Active)
{
if (m_StackPointer == 0)
_ASSERTE(!"Underflow in leaving synchronization");
else
if (m_Stack[m_StackPointer - 1].Equiv(pAwareLock))
{
m_StackPointer--;
}
else
{
for (int i=m_StackPointer - 2; i>=0; i--)
{
if (m_Stack[i].Equiv(pAwareLock))
{
_ASSERTE(!"Locks are released out of order. This might be okay...");
memcpy(&m_Stack[i], &m_Stack[i+1],
sizeof(m_Stack[0]) * (m_StackPointer - i - 1));
return;
}
}
_ASSERTE(!"Trying to release a synchronization lock which isn't held");
}
}
}
#endif // TRACK_SYNC
static DWORD dwHashCodeSeed = 123456789;
#ifdef _DEBUG
void CheckADValidity(AppDomain* pDomain, DWORD ADValidityKind)
{
CONTRACTL
{
NOTHROW;
FORBID_FAULT;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
//
// Note: this apparently checks if any one of the supplied conditions is satisified, rather
// than checking that *all* of them are satisfied. One would have expected it to assert all of the
// conditions but it does not.
//
CONTRACT_VIOLATION(FaultViolation);
if (::GetAppDomain()==pDomain)
return;
if ((ADValidityKind & ADV_DEFAULTAD) &&
pDomain->IsDefaultDomain())
return;
if ((ADValidityKind & ADV_ITERATOR) &&
pDomain->IsHeldByIterator())
return;
if ((ADValidityKind & ADV_CREATING) &&
pDomain->IsBeingCreated())
return;
if ((ADValidityKind & ADV_COMPILATION) &&
pDomain->IsCompilationDomain())
return;
if ((ADValidityKind & ADV_FINALIZER) &&
IsFinalizerThread())
return;
if ((ADValidityKind & ADV_ADUTHREAD) &&
IsADUnloadHelperThread())
return;
if ((ADValidityKind & ADV_RUNNINGIN) &&
pDomain->IsRunningIn(GetThread()))
return;
if ((ADValidityKind & ADV_REFTAKER) &&
pDomain->IsHeldByRefTaker())
return;
_ASSERTE(!"Appdomain* can be invalid");
}
#endif
//--------------------------------------------------------------------
// Thread construction
//--------------------------------------------------------------------
Thread::Thread()
{
CONTRACTL {
THROWS;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
m_pFrame = FRAME_TOP;
m_pUnloadBoundaryFrame = NULL;
m_fPreemptiveGCDisabled = 0;
#ifdef _DEBUG
m_ulForbidTypeLoad = 0;
m_GCOnTransitionsOK = TRUE;
#endif
#ifdef ENABLE_CONTRACTS
m_pClrDebugState = NULL;
m_ulEnablePreemptiveGCCount = 0;
#endif
// Initialize data members related to thread statics
m_pTLBTable = NULL;
m_TLBTableSize = 0;
m_pThreadLocalBlock = NULL;
m_dwLockCount = 0;
m_dwBeginLockCount = 0;
#ifdef _DEBUG
dbg_m_cSuspendedThreads = 0;
dbg_m_cSuspendedThreadsWithoutOSLock = 0;
m_Creater.Clear();
m_dwUnbreakableLockCount = 0;
#endif
m_dwForbidSuspendThread = 0;
// Initialize lock state
m_pHead = &m_embeddedEntry;
m_embeddedEntry.pNext = m_pHead;
m_embeddedEntry.pPrev = m_pHead;
m_embeddedEntry.dwLLockID = 0;
m_embeddedEntry.dwULockID = 0;
m_embeddedEntry.wReaderLevel = 0;
m_pBlockingLock = NULL;
m_alloc_context.init();
m_thAllocContextObj = 0;
m_UserInterrupt = 0;
m_WaitEventLink.m_Next = NULL;
m_WaitEventLink.m_LinkSB.m_pNext = NULL;
m_ThreadHandle = INVALID_HANDLE_VALUE;
m_ThreadHandleForClose = INVALID_HANDLE_VALUE;
m_ThreadHandleForResume = INVALID_HANDLE_VALUE;
m_WeOwnThreadHandle = FALSE;
#ifdef _DEBUG
m_ThreadId = UNINITIALIZED_THREADID;
#endif //_DEBUG
// Initialize this variable to a very different start value for each thread
// Using linear congruential generator from Knuth Vol. 2, p. 102, line 24
dwHashCodeSeed = dwHashCodeSeed * 1566083941 + 1;
m_dwHashCodeSeed = dwHashCodeSeed;
m_hijackLock = FALSE;
m_OSThreadId = 0;
m_Priority = INVALID_THREAD_PRIORITY;
m_ExternalRefCount = 1;
m_UnmanagedRefCount = 0;
m_State = TS_Unstarted;
m_StateNC = TSNC_Unknown;
// It can't be a LongWeakHandle because we zero stuff out of the exposed
// object as it is finalized. At that point, calls to GetCurrentThread()
// had better get a new one,!
m_ExposedObject = CreateGlobalShortWeakHandle(NULL);
GlobalShortWeakHandleHolder exposedObjectHolder(m_ExposedObject);
m_StrongHndToExposedObject = CreateGlobalStrongHandle(NULL);
GlobalStrongHandleHolder strongHndToExposedObjectHolder(m_StrongHndToExposedObject);
m_LastThrownObjectHandle = NULL;
m_ltoIsUnhandled = FALSE;
m_AbortReason = NULL;
m_debuggerFilterContext = NULL;
m_debuggerCantStop = 0;
m_debuggerWord = NULL;
m_fInteropDebuggingHijacked = FALSE;
m_profilerCallbackState = 0;
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
m_dwProfilerEvacuationCounter = 0;
#endif // FEATURE_PROFAPI_ATTACH_DETACH
m_pProfilerFilterContext = NULL;
m_CacheStackBase = 0;
m_CacheStackLimit = 0;
m_CacheStackSufficientExecutionLimit = 0;
m_LastAllowableStackAddress= 0;
m_ProbeLimit = 0;
#ifdef _DEBUG
m_pCleanedStackBase = NULL;
#endif
#ifdef STACK_GUARDS_DEBUG
m_pCurrentStackGuard = NULL;
#endif
#ifdef FEATURE_HIJACK
m_ppvHJRetAddrPtr = (VOID**) 0xCCCCCCCCCCCCCCCC;
m_pvHJRetAddr = (VOID*) 0xCCCCCCCCCCCCCCCC;
#ifndef PLATFORM_UNIX
X86_ONLY(m_LastRedirectIP = 0);
X86_ONLY(m_SpinCount = 0);
#endif // PLATFORM_UNIX
#endif // FEATURE_HIJACK
#if defined(_DEBUG) && defined(TRACK_SYNC)
m_pTrackSync = new Dbg_TrackSyncStack;
NewHolder<Dbg_TrackSyncStack> trackSyncHolder(static_cast<Dbg_TrackSyncStack*>(m_pTrackSync));
#endif // TRACK_SYNC
m_RequestedStackSize = 0;
m_PreventAsync = 0;
m_PreventAbort = 0;
m_nNestedMarshalingExceptions = 0;
m_pDomain = NULL;
#ifdef FEATURE_COMINTEROP
m_fDisableComObjectEagerCleanup = false;
#endif //FEATURE_COMINTEROP
m_fHasDeadThreadBeenConsideredForGCTrigger = false;
m_Context = NULL;
m_TraceCallCount = 0;
m_ThrewControlForThread = 0;
m_OSContext = NULL;
m_ThreadTasks = (ThreadTasks)0;
m_pLoadLimiter= NULL;
m_pLoadingFile = NULL;
// The state and the tasks must be 32-bit aligned for atomicity to be guaranteed.
_ASSERTE((((size_t) &m_State) & 3) == 0);
_ASSERTE((((size_t) &m_ThreadTasks) & 3) == 0);
// Track perf counter for the logical thread object.
COUNTER_ONLY(GetPerfCounters().m_LocksAndThreads.cCurrentThreadsLogical++);
// On all callbacks, call the trap code, which we now have
// wired to cause a GC. Thus we will do a GC on all Transition Frame Transitions (and more).
if (GCStress<cfg_transition>::IsEnabled())
{
m_State = (ThreadState) (m_State | TS_GCOnTransitions);
}
//m_pSharedStaticData = NULL;
//m_pUnsharedStaticData = NULL;
//m_pStaticDataHash = NULL;
//m_pSDHCrst = NULL;
m_fSecurityStackwalk = FALSE;
m_AbortType = EEPolicy::TA_None;
m_AbortInfo = 0;
m_AbortEndTime = MAXULONGLONG;
m_RudeAbortEndTime = MAXULONGLONG;
m_AbortController = 0;
m_AbortRequestLock = 0;
m_fRudeAbortInitiated = FALSE;
m_pIOCompletionContext = NULL;
#ifdef _DEBUG
m_fRudeAborted = FALSE;
m_dwAbortPoint = 0;
#endif
m_pFiberData = NULL;
m_TaskId = INVALID_TASK_ID;
m_dwConnectionId = INVALID_CONNECTION_ID;
#ifdef _DEBUG
DWORD_PTR *ttInfo = NULL;
size_t nBytes = MaxThreadRecord *
(sizeof(FiberSwitchInfo)-sizeof(size_t)+MaxStackDepth*sizeof(size_t));
if (g_pConfig->SaveThreadInfo()) {
ttInfo = new DWORD_PTR[(nBytes/sizeof(DWORD_PTR))*ThreadTrackInfo_Max];
memset(ttInfo,0,nBytes*ThreadTrackInfo_Max);
}
for (DWORD i = 0; i < ThreadTrackInfo_Max; i ++)
{
m_FiberInfoIndex[i] = 0;
m_pFiberInfo[i] = (FiberSwitchInfo*)((DWORD_PTR)ttInfo + i*nBytes);
}
NewArrayHolder<DWORD_PTR> fiberInfoHolder(ttInfo);
#endif
m_OSContext = new CONTEXT();
NewHolder<CONTEXT> contextHolder(m_OSContext);
m_pSavedRedirectContext = NULL;
NewHolder<CONTEXT> savedRedirectContextHolder(m_pSavedRedirectContext);
#ifdef FEATURE_COMINTEROP
m_pRCWStack = new RCWStackHeader();
#endif
m_pCerPreparationState = NULL;
#ifdef _DEBUG
m_bGCStressing = FALSE;
m_bUniqueStacking = FALSE;
#endif
m_pPendingTypeLoad = NULL;
#ifdef FEATURE_PREJIT
m_pIBCInfo = NULL;
#endif
m_dwAVInRuntimeImplOkayCount = 0;
#if defined(HAVE_GCCOVER) && defined(USE_REDIRECT_FOR_GCSTRESS) && !defined(PLATFORM_UNIX) // GCCOVER
m_fPreemptiveGCDisabledForGCStress = false;
#endif
#ifdef _DEBUG
m_pHelperMethodFrameCallerList = (HelperMethodFrameCallerList*)-1;
#endif
m_dwHostTaskRefCount = 0;
m_pExceptionDuringStartup = NULL;
#ifdef HAVE_GCCOVER
m_pbDestCode = NULL;
m_pbSrcCode = NULL;
#ifdef _TARGET_X86_
m_pLastAVAddress = NULL;
#endif // _TARGET_X86_
#endif // HAVE_GCCOVER
m_fCompletionPortDrained = FALSE;
m_debuggerActivePatchSkipper = NULL;
m_dwThreadHandleBeingUsed = 0;
SetProfilerCallbacksAllowed(TRUE);
m_pCreatingThrowableForException = NULL;
#ifdef _DEBUG
m_dwDisableAbortCheckCount = 0;
#endif // _DEBUG
#ifdef WIN64EXCEPTIONS
m_dwIndexClauseForCatch = 0;
m_sfEstablisherOfActualHandlerFrame.Clear();
#endif // WIN64EXCEPTIONS
m_threadPoolCompletionCount = 0;
Thread *pThread = GetThread();
_ASSERTE(SystemDomain::System()->DefaultDomain()->GetDefaultContext());
InitContext();
_ASSERTE(m_Context);
if (pThread)
{
_ASSERTE(pThread->GetDomain() && pThread->GetDomain()->GetDefaultContext());
// Start off the new thread in the default context of
// the creating thread's appDomain. This could be changed by SetDelegate
SetKickOffDomainId(pThread->GetDomain()->GetId());
} else
SetKickOffDomainId((ADID)DefaultADID);
// Do not expose thread until it is fully constructed
g_pThinLockThreadIdDispenser->NewId(this, this->m_ThreadId);
//
// DO NOT ADD ADDITIONAL CONSTRUCTION AFTER THIS POINT.
// NewId() allows this Thread instance to be accessed via a Thread Id. Do not
// add additional construction after this point to prevent the race condition
// of accessing a partially constructed Thread via Thread Id lookup.
//
exposedObjectHolder.SuppressRelease();
strongHndToExposedObjectHolder.SuppressRelease();
#if defined(_DEBUG) && defined(TRACK_SYNC)
trackSyncHolder.SuppressRelease();
#endif
#ifdef _DEBUG
fiberInfoHolder.SuppressRelease();
#endif
contextHolder.SuppressRelease();
savedRedirectContextHolder.SuppressRelease();
managedThreadCurrentCulture = NULL;
managedThreadCurrentUICulture = NULL;
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
m_ullProcessorUsageBaseline = 0;
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
#ifdef FEATURE_COMINTEROP
m_uliInitializeSpyCookie.QuadPart = 0ul;
m_fInitializeSpyRegistered = false;
m_pLastSTACtxCookie = NULL;
#endif // FEATURE_COMINTEROP
m_fGCSpecial = FALSE;
m_wCPUGroup = 0;
m_pAffinityMask = 0;
m_pAllLoggedTypes = NULL;
#ifdef FEATURE_PERFTRACING
m_pEventPipeBufferList = NULL;
m_eventWriteInProgress = false;
#endif // FEATURE_PERFTRACING
m_HijackReturnKind = RT_Illegal;
}
//--------------------------------------------------------------------
// Failable initialization occurs here.
//--------------------------------------------------------------------
BOOL Thread::InitThread(BOOL fInternal)
{
CONTRACTL {
THROWS;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
HANDLE hDup = INVALID_HANDLE_VALUE;
BOOL ret = TRUE;
// This message actually serves a purpose (which is why it is always run)
// The Stress log is run during hijacking, when other threads can be suspended
// at arbitrary locations (including when holding a lock that NT uses to serialize
// all memory allocations). By sending a message now, we insure that the stress
// log will not allocate memory at these critical times an avoid deadlock.
STRESS_LOG2(LF_ALWAYS, LL_ALWAYS, "SetupThread managed Thread %p Thread Id = %x\n", this, GetThreadId());
if ((m_State & TS_WeOwn) == 0)
{
COUNTER_ONLY(GetPerfCounters().m_LocksAndThreads.cRecognizedThreads++);
}
else
{
COUNTER_ONLY(GetPerfCounters().m_LocksAndThreads.cCurrentThreadsPhysical++);
}
#ifndef FEATURE_PAL
// workaround: Remove this when we flow impersonation token to host.
BOOL reverted = FALSE;
HANDLE threadToken = INVALID_HANDLE_VALUE;
#endif // !FEATURE_PAL
if (m_ThreadHandle == INVALID_HANDLE_VALUE)
{
// For WinCE, all clients have the same handle for a thread. Duplication is
// not possible. We make sure we never close this handle unless we created
// the thread (TS_WeOwn).
//
// For Win32, each client has its own handle. This is achieved by duplicating
// the pseudo-handle from ::GetCurrentThread(). Unlike WinCE, this service
// returns a pseudo-handle which is only useful for duplication. In this case
// each client is responsible for closing its own (duplicated) handle.
//
// We don't bother duplicating if WeOwn, because we created the handle in the
// first place.
// Thread is created when or after the physical thread started running
HANDLE curProcess = ::GetCurrentProcess();
#ifndef FEATURE_PAL
// If we're impersonating on NT, then DuplicateHandle(GetCurrentThread()) is going to give us a handle with only
// THREAD_TERMINATE, THREAD_QUERY_INFORMATION, and THREAD_SET_INFORMATION. This doesn't include
// THREAD_SUSPEND_RESUME nor THREAD_GET_CONTEXT. We need to be able to suspend the thread, and we need to be
// able to get its context. Therefore, if we're impersonating, we revert to self, dup the handle, then
// re-impersonate before we leave this routine.
if (!RevertIfImpersonated(&reverted, &threadToken))
{
COMPlusThrowWin32();
}
class EnsureResetThreadToken
{
private:
BOOL m_NeedReset;
HANDLE m_threadToken;
public:
EnsureResetThreadToken(HANDLE threadToken, BOOL reverted)
{
m_threadToken = threadToken;
m_NeedReset = reverted;
}
~EnsureResetThreadToken()
{
UndoRevert(m_NeedReset, m_threadToken);
if (m_threadToken != INVALID_HANDLE_VALUE)
{
CloseHandle(m_threadToken);
}
}
};
EnsureResetThreadToken resetToken(threadToken, reverted);
#endif // !FEATURE_PAL
if (::DuplicateHandle(curProcess, ::GetCurrentThread(), curProcess, &hDup,
0 /*ignored*/, FALSE /*inherit*/, DUPLICATE_SAME_ACCESS))
{
_ASSERTE(hDup != INVALID_HANDLE_VALUE);
SetThreadHandle(hDup);
m_WeOwnThreadHandle = TRUE;
}
else
{
COMPlusThrowWin32();
}
}
if ((m_State & TS_WeOwn) == 0)
{
if (!AllocHandles())
{
ThrowOutOfMemory();
}
}
_ASSERTE(HasValidThreadHandle());
m_random.Init();
// Set floating point mode to round to nearest
#ifndef FEATURE_PAL
(void) _controlfp_s( NULL, _RC_NEAR, _RC_CHOP|_RC_UP|_RC_DOWN|_RC_NEAR );
m_pTEB = (struct _NT_TIB*)NtCurrentTeb();
#endif // !FEATURE_PAL
if (m_CacheStackBase == 0)
{
_ASSERTE(m_CacheStackLimit == 0);
_ASSERTE(m_LastAllowableStackAddress == 0);
_ASSERTE(m_ProbeLimit == 0);
ret = SetStackLimits(fAll);
if (ret == FALSE)
{
ThrowOutOfMemory();
}
// We commit the thread's entire stack when it enters the runtime to allow us to be reliable in low me
// situtations. See the comments in front of Thread::CommitThreadStack() for mor information.
ret = Thread::CommitThreadStack(this);
if (ret == FALSE)
{
ThrowOutOfMemory();
}
}
ret = Thread::AllocateIOCompletionContext();
if (!ret)
{
ThrowOutOfMemory();
}
_ASSERTE(ret); // every failure case for ret should throw.
return ret;
}
// Allocate all the handles. When we are kicking of a new thread, we can call
// here before the thread starts running.
BOOL Thread::AllocHandles()
{
WRAPPER_NO_CONTRACT;
_ASSERTE(!m_DebugSuspendEvent.IsValid());
_ASSERTE(!m_EventWait.IsValid());
BOOL fOK = TRUE;
EX_TRY {
// create a manual reset event for getting the thread to a safe point
m_DebugSuspendEvent.CreateManualEvent(FALSE);
m_EventWait.CreateManualEvent(TRUE);
}
EX_CATCH {
fOK = FALSE;
if (!m_DebugSuspendEvent.IsValid()) {
m_DebugSuspendEvent.CloseEvent();
}
if (!m_EventWait.IsValid()) {
m_EventWait.CloseEvent();
}
}
EX_END_CATCH(RethrowTerminalExceptions);
return fOK;
}
//--------------------------------------------------------------------
// This is the alternate path to SetupThread/InitThread. If we created
// an unstarted thread, we have SetupUnstartedThread/HasStarted.
//--------------------------------------------------------------------
BOOL Thread::HasStarted(BOOL bRequiresTSL)
{
CONTRACTL {
NOTHROW;
DISABLED(GC_NOTRIGGER);
SO_TOLERANT;
}
CONTRACTL_END;
// @todo need a probe that tolerates not having a thread setup at all
CONTRACT_VIOLATION(SOToleranceViolation);
_ASSERTE(!m_fPreemptiveGCDisabled); // can't use PreemptiveGCDisabled() here
// This is cheating a little. There is a pathway here from SetupThread, but only
// via IJW SystemDomain::RunDllMain. Normally SetupThread returns a thread in
// preemptive mode, ready for a transition. But in the IJW case, it can return a
// cooperative mode thread. RunDllMain handles this "surprise" correctly.
m_fPreemptiveGCDisabled = TRUE;
// Normally, HasStarted is called from the thread's entrypoint to introduce it to
// the runtime. But sometimes that thread is used for DLL_THREAD_ATTACH notifications
// that call into managed code. In that case, the second HasStarted call is
// redundant and should be ignored.
if (GetThread() == this)
return TRUE;
_ASSERTE(GetThread() == 0);
_ASSERTE(HasValidThreadHandle());
BOOL fKeepTLS = FALSE;
BOOL fCanCleanupCOMState = FALSE;
BOOL res = TRUE;
res = SetStackLimits(fAll);
if (res == FALSE)
{
m_pExceptionDuringStartup = Exception::GetOOMException();
goto FAILURE;
}
// We commit the thread's entire stack when it enters the runtime to allow us to be reliable in low memory
// situtations. See the comments in front of Thread::CommitThreadStack() for mor information.
res = Thread::CommitThreadStack(this);
if (res == FALSE)
{
m_pExceptionDuringStartup = Exception::GetOOMException();
goto FAILURE;
}
// If any exception happens during HasStarted, we will cache the exception in Thread::m_pExceptionDuringStartup
// which will be thrown in Thread.Start as an internal exception
EX_TRY
{
//
// Initialization must happen in the following order - hosts like SQL Server depend on this.
//
CExecutionEngine::SetupTLSForThread(this);
fCanCleanupCOMState = TRUE;
res = PrepareApartmentAndContext();
if (!res)
{
ThrowOutOfMemory();
}
InitThread(FALSE);
if (SetThread(this) == FALSE)
{
ThrowOutOfMemory();
}
if (SetAppDomain(m_pDomain) == FALSE)
{
ThrowOutOfMemory();
}
#ifdef _DEBUG
AddFiberInfo(Thread::ThreadTrackInfo_Lifetime);
#endif
SetupThreadForHost();
ThreadStore::TransferStartedThread(this, bRequiresTSL);
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
if (g_fEnableARM)
{
QueryThreadProcessorUsage();
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
#ifdef FEATURE_EVENT_TRACE
ETW::ThreadLog::FireThreadCreated(this);
#endif // FEATURE_EVENT_TRACE
}
EX_CATCH
{
if (__pException != NULL)
{
__pException.SuppressRelease();
m_pExceptionDuringStartup = __pException;
}
res = FALSE;
}
EX_END_CATCH(SwallowAllExceptions);
FAILURE:
if (res == FALSE)
{
if (m_fPreemptiveGCDisabled)
{
m_fPreemptiveGCDisabled = FALSE;
}
_ASSERTE (HasThreadState(TS_Unstarted));
SetThreadState(TS_FailStarted);
if (GetThread() != NULL && IsAbortRequested())
UnmarkThreadForAbort(TAR_ALL);
if (!fKeepTLS)
{
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
//
// Undo our call to PrepareApartmentAndContext above, so we don't leak a CoInitialize
// If we're keeping TLS, then the host's call to ExitTask will clean this up instead.
//
if (fCanCleanupCOMState)
{
// The thread pointer in TLS may not be set yet, if we had a failure before we set it.
// So we'll set it up here (we'll unset it a few lines down).
if (SetThread(this) != FALSE)
{
CleanupCOMState();
}
}
#endif
FastInterlockDecrement(&ThreadStore::s_pThreadStore->m_PendingThreadCount);
// One of the components of OtherThreadsComplete() has changed, so check whether
// we should now exit the EE.
ThreadStore::CheckForEEShutdown();
DecExternalCount(/*holdingLock*/ !bRequiresTSL);
SetThread(NULL);
SetAppDomain(NULL);
}
}
else
{
FastInterlockOr((ULONG *) &m_State, TS_FullyInitialized);
#ifdef DEBUGGING_SUPPORTED
//
// If we're debugging, let the debugger know that this
// thread is up and running now.
//
if (CORDebuggerAttached())
{
g_pDebugInterface->ThreadCreated(this);
}
else
{
LOG((LF_CORDB, LL_INFO10000, "ThreadCreated() not called due to CORDebuggerAttached() being FALSE for thread 0x%x\n", GetThreadId()));
}
#endif // DEBUGGING_SUPPORTED
#ifdef PROFILING_SUPPORTED
// If a profiler is running, let them know about the new thread.
//
// The call to IsGCSpecial is crucial to avoid a deadlock. See code:Thread::m_fGCSpecial for more
// information
if (!IsGCSpecial())
{
BEGIN_PIN_PROFILER(CORProfilerTrackThreads());
BOOL gcOnTransition = GC_ON_TRANSITIONS(FALSE); // disable GCStress 2 to avoid the profiler receiving a RuntimeThreadSuspended notification even before the ThreadCreated notification
{
GCX_PREEMP();
g_profControlBlock.pProfInterface->ThreadCreated((ThreadID) this);
}
GC_ON_TRANSITIONS(gcOnTransition);
DWORD osThreadId = ::GetCurrentThreadId();
g_profControlBlock.pProfInterface->ThreadAssignedToOSThread(
(ThreadID) this, osThreadId);
END_PIN_PROFILER();
}
#endif // PROFILING_SUPPORTED
// CoreCLR does not support user-requested thread suspension
_ASSERTE(!(m_State & TS_SuspendUnstarted));
}
return res;
}
BOOL Thread::AllocateIOCompletionContext()
{
WRAPPER_NO_CONTRACT;
PIOCompletionContext pIOC = new (nothrow) IOCompletionContext;
if(pIOC != NULL)
{
pIOC->lpOverlapped = NULL;
m_pIOCompletionContext = pIOC;
return TRUE;
}
else
{
return FALSE;
}
}
VOID Thread::FreeIOCompletionContext()
{
WRAPPER_NO_CONTRACT;
if (m_pIOCompletionContext != NULL)
{
PIOCompletionContext pIOC = (PIOCompletionContext) m_pIOCompletionContext;
delete pIOC;
m_pIOCompletionContext = NULL;
}
}
void Thread::HandleThreadStartupFailure()
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
_ASSERTE(GetThread() != NULL);
struct ProtectArgs
{
OBJECTREF pThrowable;
OBJECTREF pReason;
} args;
memset(&args, 0, sizeof(ProtectArgs));
GCPROTECT_BEGIN(args);
MethodTable *pMT = MscorlibBinder::GetException(kThreadStartException);
args.pThrowable = AllocateObject(pMT);
MethodDescCallSite exceptionCtor(METHOD__THREAD_START_EXCEPTION__EX_CTOR);
if (m_pExceptionDuringStartup)
{
args.pReason = CLRException::GetThrowableFromException(m_pExceptionDuringStartup);
Exception::Delete(m_pExceptionDuringStartup);
m_pExceptionDuringStartup = NULL;
}
ARG_SLOT args1[] = {
ObjToArgSlot(args.pThrowable),
ObjToArgSlot(args.pReason),
};
exceptionCtor.Call(args1);
GCPROTECT_END(); //Prot
RaiseTheExceptionInternalOnly(args.pThrowable, FALSE);
}
#ifndef FEATURE_PAL
BOOL RevertIfImpersonated(BOOL *bReverted, HANDLE *phToken)
{
WRAPPER_NO_CONTRACT;
BOOL bImpersonated = OpenThreadToken(GetCurrentThread(), // we are assuming that if this call fails,
TOKEN_IMPERSONATE, // we are not impersonating. There is no win32
TRUE, // api to figure this out. The only alternative
phToken); // is to use NtCurrentTeb->IsImpersonating().
if (bImpersonated)
{
*bReverted = RevertToSelf();
return *bReverted;
}
return TRUE;
}
void UndoRevert(BOOL bReverted, HANDLE hToken)
{
if (bReverted)
{
if (!SetThreadToken(NULL, hToken))
{
_ASSERT("Undo Revert -> SetThreadToken failed");
STRESS_LOG1(LF_EH, LL_INFO100, "UndoRevert/SetThreadToken failed for hToken = %d\n",hToken);
EEPOLICY_HANDLE_FATAL_ERROR(COR_E_SECURITY);
}
}
return;
}
#endif // !FEATURE_PAL
// We don't want ::CreateThread() calls scattered throughout the source. So gather
// them all here.
BOOL Thread::CreateNewThread(SIZE_T stackSize, LPTHREAD_START_ROUTINE start, void *args, LPCWSTR pName)
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
BOOL bRet;
//This assert is here to prevent a bug in the future
// CreateTask currently takes a DWORD and we will downcast
// if that interface changes to take a SIZE_T this Assert needs to be removed.
//
_ASSERTE(stackSize <= 0xFFFFFFFF);
#ifndef FEATURE_PAL
HandleHolder token;
BOOL bReverted = FALSE;
bRet = RevertIfImpersonated(&bReverted, &token);
if (bRet != TRUE)
return bRet;
#endif // !FEATURE_PAL
m_StateNC = (ThreadStateNoConcurrency)((ULONG)m_StateNC | TSNC_CLRCreatedThread);
bRet = CreateNewOSThread(stackSize, start, args);
#ifndef FEATURE_PAL
UndoRevert(bReverted, token);
SetThreadName(m_ThreadHandle, pName);
#endif // !FEATURE_PAL
return bRet;
}
// This is to avoid the 64KB/1MB aliasing problem present on Pentium 4 processors,
// which can significantly impact performance with HyperThreading enabled
DWORD WINAPI Thread::intermediateThreadProc(PVOID arg)
{
WRAPPER_NO_CONTRACT;
m_offset_counter++;
if (m_offset_counter * offset_multiplier > (int) GetOsPageSize())
m_offset_counter = 0;
(void)_alloca(m_offset_counter * offset_multiplier);
intermediateThreadParam* param = (intermediateThreadParam*)arg;
LPTHREAD_START_ROUTINE ThreadFcnPtr = param->lpThreadFunction;
PVOID args = param->lpArg;
delete param;
return ThreadFcnPtr(args);
}
HANDLE Thread::CreateUtilityThread(Thread::StackSizeBucket stackSizeBucket, LPTHREAD_START_ROUTINE start, void *args, DWORD flags, DWORD* pThreadId)
{
LIMITED_METHOD_CONTRACT;
// TODO: we should always use small stacks for most of these threads. For CLR 4, we're being conservative
// here because this is a last-minute fix.
SIZE_T stackSize;
switch (stackSizeBucket)
{
case StackSize_Small:
stackSize = 256 * 1024;
break;
case StackSize_Medium:
stackSize = 512 * 1024;
break;
default:
_ASSERTE(!"Bad stack size bucket");
case StackSize_Large:
stackSize = 1024 * 1024;
break;
}
flags |= STACK_SIZE_PARAM_IS_A_RESERVATION;
DWORD threadId;
HANDLE hThread = CreateThread(NULL, stackSize, start, args, flags, &threadId);
if (pThreadId)
*pThreadId = threadId;
return hThread;
}
BOOL Thread::GetProcessDefaultStackSize(SIZE_T* reserveSize, SIZE_T* commitSize)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
//
// Let's get the stack sizes from the PE file that started process.
//
static SIZE_T ExeSizeOfStackReserve = 0;
static SIZE_T ExeSizeOfStackCommit = 0;
static BOOL fSizesGot = FALSE;
#ifndef FEATURE_PAL
if (!fSizesGot)
{
HINSTANCE hInst = WszGetModuleHandle(NULL);
_ASSERTE(hInst); // WszGetModuleHandle should never fail on the module that started the process.
EX_TRY
{
PEDecoder pe(hInst);
pe.GetEXEStackSizes(&ExeSizeOfStackReserve, &ExeSizeOfStackCommit);
fSizesGot = TRUE;
}
EX_CATCH
{
fSizesGot = FALSE;
}
EX_END_CATCH(SwallowAllExceptions);
}
#endif // !FEATURE_PAL
if (!fSizesGot) {
//return some somewhat-reasonable numbers
if (NULL != reserveSize) *reserveSize = 256*1024;
if (NULL != commitSize) *commitSize = 256*1024;
return FALSE;
}
if (NULL != reserveSize) *reserveSize = ExeSizeOfStackReserve;
if (NULL != commitSize) *commitSize = ExeSizeOfStackCommit;
return TRUE;
}
BOOL Thread::CreateNewOSThread(SIZE_T sizeToCommitOrReserve, LPTHREAD_START_ROUTINE start, void *args)
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
DWORD ourId = 0;
HANDLE h = NULL;
DWORD dwCreationFlags = CREATE_SUSPENDED;
dwCreationFlags |= STACK_SIZE_PARAM_IS_A_RESERVATION;
#ifndef FEATURE_PAL // the PAL does its own adjustments as necessary
if (sizeToCommitOrReserve != 0 && sizeToCommitOrReserve <= GetOsPageSize())
{
// On Windows, passing a value that is <= one page size bizarrely causes the OS to use the default stack size instead of
// a minimum, which is undesirable. This adjustment fixes that issue to use a minimum stack size (typically 64 KB).
sizeToCommitOrReserve = GetOsPageSize() + 1;
}
#endif // !FEATURE_PAL
intermediateThreadParam* lpThreadArgs = new (nothrow) intermediateThreadParam;
if (lpThreadArgs == NULL)
{
return FALSE;
}
NewHolder<intermediateThreadParam> argHolder(lpThreadArgs);
// Make sure we have all our handles, in case someone tries to suspend us
// as we are starting up.
if (!AllocHandles())
{
// OS is out of handles/memory?
return FALSE;
}
lpThreadArgs->lpThreadFunction = start;
lpThreadArgs->lpArg = args;
h = ::CreateThread(NULL /*=SECURITY_ATTRIBUTES*/,
sizeToCommitOrReserve,
intermediateThreadProc,
lpThreadArgs,
dwCreationFlags,
&ourId);
if (h == NULL)
return FALSE;
argHolder.SuppressRelease();
_ASSERTE(!m_fPreemptiveGCDisabled); // leave in preemptive until HasStarted.
SetThreadHandle(h);
m_WeOwnThreadHandle = TRUE;
// Before we do the resume, we need to take note of the new ThreadId. This
// is necessary because -- before the thread starts executing at KickofThread --
// it may perform some DllMain DLL_THREAD_ATTACH notifications. These could
// call into managed code. During the consequent SetupThread, we need to
// perform the Thread::HasStarted call instead of going through the normal
// 'new thread' pathway.
_ASSERTE(GetOSThreadId() == 0);
_ASSERTE(ourId != 0);
m_OSThreadId = ourId;
FastInterlockIncrement(&ThreadStore::s_pThreadStore->m_PendingThreadCount);
#ifdef _DEBUG
m_Creater.SetToCurrentThread();
#endif
return TRUE;
}
//
// #threadDestruction
//
// General comments on thread destruction.
//
// The C++ Thread object can survive beyond the time when the Win32 thread has died.
// This is important if an exposed object has been created for this thread. The
// exposed object will survive until it is GC'ed.
//
// A client like an exposed object can place an external reference count on that
// object. We also place a reference count on it when we construct it, and we lose
// that count when the thread finishes doing useful work (OnThreadTerminate).
//
// One way OnThreadTerminate() is called is when the thread finishes doing useful
// work. This case always happens on the correct thread.
//
// The other way OnThreadTerminate() is called is during product shutdown. We do
// a "best effort" to eliminate all threads except the Main thread before shutdown
// happens. But there may be some background threads or external threads still
// running.
//
// When the final reference count disappears, we destruct. Until then, the thread
// remains in the ThreadStore, but is marked as "Dead".
//<TODO>
// @TODO cwb: for a typical shutdown, only background threads are still around.
// Should we interrupt them? What about the non-typical shutdown?</TODO>
int Thread::IncExternalCount()
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
Thread *pCurThread = GetThread();
_ASSERTE(m_ExternalRefCount > 0);
int retVal = FastInterlockIncrement((LONG*)&m_ExternalRefCount);
// If we have an exposed object and the refcount is greater than one
// we must make sure to keep a strong handle to the exposed object
// so that we keep it alive even if nobody has a reference to it.
if (pCurThread && ((*((void**)m_ExposedObject)) != NULL))
{
// The exposed object exists and needs a strong handle so check
// to see if it has one.
// Only a managed thread can setup StrongHnd.
if ((*((void**)m_StrongHndToExposedObject)) == NULL)
{
GCX_COOP();
// Store the object in the strong handle.
StoreObjectInHandle(m_StrongHndToExposedObject, ObjectFromHandle(m_ExposedObject));
}
}
return retVal;
}
int Thread::DecExternalCount(BOOL holdingLock)
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
// Note that it's possible to get here with a NULL current thread (during
// shutdown of the thread manager).
Thread *pCurThread = GetThread();
_ASSERTE (pCurThread == NULL || IsAtProcessExit()
|| (!holdingLock && !ThreadStore::HoldingThreadStore(pCurThread))
|| (holdingLock && ThreadStore::HoldingThreadStore(pCurThread)));
BOOL ToggleGC = FALSE;
BOOL SelfDelete = FALSE;
int retVal;
// Must synchronize count and exposed object handle manipulation. We use the
// thread lock for this, which implies that we must be in pre-emptive mode
// to begin with and avoid any activity that would invoke a GC (this
// acquires the thread store lock).
if (pCurThread)
{
// TODO: we would prefer to use a GC Holder here, however it is hard
// to get the case where we're deleting this thread correct given
// the current macros. We want to supress the release of the holder
// here which puts us in Preemptive mode, and also the switch to
// Cooperative mode below, but since both holders will be named
// the same thing (due to the generic nature of the macro) we can
// not use GCX_*_SUPRESS_RELEASE() for 2 holders in the same scope
// b/c they will both apply simply to the most narrowly scoped
// holder.
ToggleGC = pCurThread->PreemptiveGCDisabled();
if (ToggleGC)
{
pCurThread->EnablePreemptiveGC();
}
}
GCX_ASSERT_PREEMP();
ThreadStoreLockHolder tsLock(!holdingLock);
_ASSERTE(m_ExternalRefCount >= 1);
_ASSERTE(!holdingLock ||
ThreadStore::s_pThreadStore->m_Crst.GetEnterCount() > 0 ||
IsAtProcessExit());
retVal = FastInterlockDecrement((LONG*)&m_ExternalRefCount);
if (retVal == 0)
{
HANDLE h = GetThreadHandle();
if (h == INVALID_HANDLE_VALUE)
{
h = m_ThreadHandleForClose;
m_ThreadHandleForClose = INVALID_HANDLE_VALUE;
}
// Can not assert like this. We have already removed the Unstarted bit.
//_ASSERTE (IsUnstarted() || h != INVALID_HANDLE_VALUE);
if (h != INVALID_HANDLE_VALUE && m_WeOwnThreadHandle)
{
::CloseHandle(h);
SetThreadHandle(INVALID_HANDLE_VALUE);
}
// Switch back to cooperative mode to manipulate the thread.
if (pCurThread)
{
// TODO: we would prefer to use GCX_COOP here, see comment above.
pCurThread->DisablePreemptiveGC();
}
GCX_ASSERT_COOP();
// during process detach the thread might still be in the thread list
// if it hasn't seen its DLL_THREAD_DETACH yet. Use the following
// tweak to decide if the thread has terminated yet.
if (!HasValidThreadHandle())
{
SelfDelete = this == pCurThread;
m_ExceptionState.FreeAllStackTraces();
if (SelfDelete) {
SetThread(NULL);
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Lifetime);
#endif
}
delete this;
}
tsLock.Release();
// It only makes sense to restore the GC mode if we didn't just destroy
// our own thread object.
if (pCurThread && !SelfDelete && !ToggleGC)
{
pCurThread->EnablePreemptiveGC();
}
// Cannot use this here b/c it creates a holder named the same as GCX_ASSERT_COOP
// in the same scope above...
//
// GCX_ASSERT_PREEMP()
return retVal;
}
else if (pCurThread == NULL)
{
// We're in shutdown, too late to be worrying about having a strong
// handle to the exposed thread object, we've already performed our
// final GC.
tsLock.Release();
return retVal;
}
else
{
// Check to see if the external ref count reaches exactly one. If this
// is the case and we have an exposed object then it is that exposed object
// that is holding a reference to us. To make sure that we are not the
// ones keeping the exposed object alive we need to remove the strong
// reference we have to it.
if ((retVal == 1) && ((*((void**)m_StrongHndToExposedObject)) != NULL))
{
// Switch back to cooperative mode to manipulate the object.
// Don't want to switch back to COOP until we let go of the lock
// however we are allowed to call StoreObjectInHandle here in preemptive
// mode because we are setting the value to NULL.
CONTRACT_VIOLATION(ModeViolation);
// Clear the handle and leave the lock.
// We do not have to to DisablePreemptiveGC here, because
// we just want to put NULL into a handle.
StoreObjectInHandle(m_StrongHndToExposedObject, NULL);
tsLock.Release();
// Switch back to the initial GC mode.
if (ToggleGC)
{
pCurThread->DisablePreemptiveGC();
}
GCX_ASSERT_COOP();
return retVal;
}
}
tsLock.Release();
// Switch back to the initial GC mode.
if (ToggleGC)
{
pCurThread->DisablePreemptiveGC();
}
return retVal;
}
//--------------------------------------------------------------------
// Destruction. This occurs after the associated native thread
// has died.
//--------------------------------------------------------------------
Thread::~Thread()
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
// TODO: enable this
//_ASSERTE(GetThread() != this);
_ASSERTE(m_ThrewControlForThread == 0);
// AbortRequest is coupled with TrapReturningThread.
// We should have unmarked the thread for abort.
// !!! Can not assert here. If a thread has no managed code on stack
// !!! we leave the g_TrapReturningThread set so that the thread will be
// !!! aborted if it enters managed code.
//_ASSERTE(!IsAbortRequested());
// We should not have the Thread marked for abort. But if we have
// we need to unmark it so that g_TrapReturningThreads is decremented.
if (IsAbortRequested())
{
UnmarkThreadForAbort(TAR_ALL);
}
#if defined(_DEBUG) && defined(TRACK_SYNC)
_ASSERTE(IsAtProcessExit() || ((Dbg_TrackSyncStack *) m_pTrackSync)->m_StackPointer == 0);
delete m_pTrackSync;
#endif // TRACK_SYNC
_ASSERTE(IsDead() || IsUnstarted() || IsAtProcessExit());
if (m_WaitEventLink.m_Next != NULL && !IsAtProcessExit())
{
WaitEventLink *walk = &m_WaitEventLink;
while (walk->m_Next) {
ThreadQueue::RemoveThread(this, (SyncBlock*)((DWORD_PTR)walk->m_Next->m_WaitSB & ~1));
StoreEventToEventStore (walk->m_Next->m_EventWait);
}
m_WaitEventLink.m_Next = NULL;
}
if (m_StateNC & TSNC_ExistInThreadStore) {
BOOL ret;
ret = ThreadStore::RemoveThread(this);
_ASSERTE(ret);
}
#ifdef _DEBUG
m_pFrame = (Frame *)POISONC;
#endif
// Update Perfmon counters.
COUNTER_ONLY(GetPerfCounters().m_LocksAndThreads.cCurrentThreadsLogical--);
// Current recognized threads are non-runtime threads that are alive and ran under the
// runtime. Check whether this Thread was one of them.
if ((m_State & TS_WeOwn) == 0)
{
COUNTER_ONLY(GetPerfCounters().m_LocksAndThreads.cRecognizedThreads--);
}
else
{
COUNTER_ONLY(GetPerfCounters().m_LocksAndThreads.cCurrentThreadsPhysical--);
}
// Normally we shouldn't get here with a valid thread handle; however if SetupThread
// failed (due to an OOM for example) then we need to CloseHandle the thread
// handle if we own it.
if (m_WeOwnThreadHandle && (GetThreadHandle() != INVALID_HANDLE_VALUE))
{
CloseHandle(GetThreadHandle());
}
if (m_DebugSuspendEvent.IsValid())
{
m_DebugSuspendEvent.CloseEvent();
}
if (m_EventWait.IsValid())
{
m_EventWait.CloseEvent();
}
FreeIOCompletionContext();
if (m_OSContext)
delete m_OSContext;
if (GetSavedRedirectContext())
{
delete GetSavedRedirectContext();
SetSavedRedirectContext(NULL);
}
#ifdef FEATURE_COMINTEROP
if (m_pRCWStack)
delete m_pRCWStack;
#endif
if (m_pExceptionDuringStartup)
{
Exception::Delete (m_pExceptionDuringStartup);
}
ClearContext();
if (!IsAtProcessExit())
{
// Destroy any handles that we're using to hold onto exception objects
SafeSetThrowables(NULL);
DestroyShortWeakHandle(m_ExposedObject);
DestroyStrongHandle(m_StrongHndToExposedObject);
}
g_pThinLockThreadIdDispenser->DisposeId(GetThreadId());
//Ensure DeleteThreadStaticData was executed
_ASSERTE(m_pThreadLocalBlock == NULL);
_ASSERTE(m_pTLBTable == NULL);
_ASSERTE(m_TLBTableSize == 0);
#ifdef FEATURE_PREJIT
if (m_pIBCInfo) {
delete m_pIBCInfo;
}
#endif
#ifdef _DEBUG
if (m_pFiberInfo != NULL) {
delete [] (DWORD_PTR*)m_pFiberInfo[0];
}
#endif
#ifdef FEATURE_EVENT_TRACE
// Destruct the thread local type cache for allocation sampling
if(m_pAllLoggedTypes) {
ETW::TypeSystemLog::DeleteTypeHashNoLock(&m_pAllLoggedTypes);
}
#endif // FEATURE_EVENT_TRACE
// Wait for another thread to leave its loop in DeadlockAwareLock::TryBeginEnterLock
CrstHolder lock(&g_DeadlockAwareCrst);
}
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
void Thread::BaseCoUninitialize()
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_SO_INTOLERANT;
STATIC_CONTRACT_MODE_PREEMPTIVE;
_ASSERTE(GetThread() == this);
BEGIN_SO_TOLERANT_CODE(this);
// BEGIN_SO_TOLERANT_CODE wraps a __try/__except around this call, so if the OS were to allow
// an exception to leak through to us, we'll catch it.
::CoUninitialize();
END_SO_TOLERANT_CODE;
}// BaseCoUninitialize
#ifdef FEATURE_COMINTEROP
void Thread::BaseWinRTUninitialize()
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_SO_INTOLERANT;
STATIC_CONTRACT_MODE_PREEMPTIVE;
_ASSERTE(WinRTSupported());
_ASSERTE(GetThread() == this);
_ASSERTE(IsWinRTInitialized());
BEGIN_SO_TOLERANT_CODE(this);
RoUninitialize();
END_SO_TOLERANT_CODE;
}
#endif // FEATURE_COMINTEROP
void Thread::CoUninitialize()
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
// Running threads might have performed a CoInitialize which must
// now be balanced.
BOOL needsUninitialize = IsCoInitialized()
#ifdef FEATURE_COMINTEROP
|| IsWinRTInitialized()
#endif // FEATURE_COMINTEROP
;
if (!IsAtProcessExit() && needsUninitialize)
{
GCX_PREEMP();
CONTRACT_VIOLATION(ThrowsViolation);
if (IsCoInitialized())
{
BaseCoUninitialize();
FastInterlockAnd((ULONG *)&m_State, ~TS_CoInitialized);
}
#ifdef FEATURE_COMINTEROP
if (IsWinRTInitialized())
{
_ASSERTE(WinRTSupported());
BaseWinRTUninitialize();
ResetWinRTInitialized();
}
#endif // FEATURE_COMNITEROP
}
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
void Thread::CleanupDetachedThreads()
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
_ASSERTE(!ThreadStore::HoldingThreadStore());
ThreadStoreLockHolder threadStoreLockHolder;
Thread *thread = ThreadStore::GetAllThreadList(NULL, 0, 0);
STRESS_LOG0(LF_SYNC, LL_INFO1000, "T::CDT called\n");
while (thread != NULL)
{
Thread *next = ThreadStore::GetAllThreadList(thread, 0, 0);
if (thread->IsDetached() && thread->m_UnmanagedRefCount == 0)
{
STRESS_LOG1(LF_SYNC, LL_INFO1000, "T::CDT - detaching thread 0x%p\n", thread);
// Unmark that the thread is detached while we have the
// thread store lock. This will ensure that no other
// thread will race in here and try to delete it, too.
FastInterlockAnd((ULONG*)&(thread->m_State), ~TS_Detached);
FastInterlockDecrement(&m_DetachCount);
if (!thread->IsBackground())
FastInterlockDecrement(&m_ActiveDetachCount);
// If the debugger is attached, then we need to unlock the
// thread store before calling OnThreadTerminate. That
// way, we won't be holding the thread store lock if we
// need to block sending a detach thread event.
BOOL debuggerAttached =
#ifdef DEBUGGING_SUPPORTED
CORDebuggerAttached();
#else // !DEBUGGING_SUPPORTED
FALSE;
#endif // !DEBUGGING_SUPPORTED
if (debuggerAttached)
ThreadStore::UnlockThreadStore();
thread->OnThreadTerminate(debuggerAttached ? FALSE : TRUE);
#ifdef DEBUGGING_SUPPORTED
if (debuggerAttached)
{
ThreadSuspend::LockThreadStore(ThreadSuspend::SUSPEND_OTHER);
// We remember the next Thread in the thread store
// list before deleting the current one. But we can't
// use that Thread pointer now that we release the
// thread store lock in the middle of the loop. We
// have to start from the beginning of the list every
// time. If two threads T1 and T2 race into
// CleanupDetachedThreads, then T1 will grab the first
// Thread on the list marked for deletion and release
// the lock. T2 will grab the second one on the
// list. T2 may complete destruction of its Thread,
// then T1 might re-acquire the thread store lock and
// try to use the next Thread in the thread store. But
// T2 just deleted that next Thread.
thread = ThreadStore::GetAllThreadList(NULL, 0, 0);
}
else
#endif // DEBUGGING_SUPPORTED
{
thread = next;
}
}
else if (thread->HasThreadState(TS_Finalized))
{
STRESS_LOG1(LF_SYNC, LL_INFO1000, "T::CDT - finalized thread 0x%p\n", thread);
thread->ResetThreadState(TS_Finalized);
// We have finalized the managed Thread object. Now it is time to clean up the unmanaged part
thread->DecExternalCount(TRUE);
thread = next;
}
else
{
thread = next;
}
}
s_fCleanFinalizedThread = FALSE;
}
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
void Thread::CleanupCOMState()
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
#ifdef FEATURE_COMINTEROP
if (GetFinalApartment() == Thread::AS_InSTA)
ReleaseRCWsInCachesNoThrow(GetCurrentCtxCookie());
#endif // FEATURE_COMINTEROP
// Running threads might have performed a CoInitialize which must
// now be balanced. However only the thread that called COInitialize can
// call CoUninitialize.
BOOL needsUninitialize = IsCoInitialized()
#ifdef FEATURE_COMINTEROP
|| IsWinRTInitialized()
#endif // FEATURE_COMINTEROP
;
if (needsUninitialize)
{
GCX_PREEMP();
CONTRACT_VIOLATION(ThrowsViolation);
if (IsCoInitialized())
{
BaseCoUninitialize();
ResetCoInitialized();
}
#ifdef FEATURE_COMINTEROP
if (IsWinRTInitialized())
{
_ASSERTE(WinRTSupported());
BaseWinRTUninitialize();
ResetWinRTInitialized();
}
#endif // FEATURE_COMINTEROP
}
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
// See general comments on thread destruction (code:#threadDestruction) above.
void Thread::OnThreadTerminate(BOOL holdingLock)
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
// #ReportDeadOnThreadTerminate
// Caller should have put the TS_ReportDead bit on by now.
// We don't want any windows after the exit event but before the thread is marked dead.
// If a debugger attached during such a window (or even took a dump at the exit event),
// then it may not realize the thread is dead.
// So ensure we mark the thread as dead before we send the tool notifications.
// The TS_ReportDead bit will cause the debugger to view this as TS_Dead.
_ASSERTE(HasThreadState(TS_ReportDead));
// Should not use OSThreadId:
// OSThreadId may change for the current thread is the thread is blocked and rescheduled
// by host.
Thread *pCurrentThread = GetThread();
DWORD CurrentThreadID = pCurrentThread?pCurrentThread->GetThreadId():0;
DWORD ThisThreadID = GetThreadId();
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
// If the currently running thread is the thread that died and it is an STA thread, then we
// need to release all the RCW's in the current context. However, we cannot do this if we
// are in the middle of process detach.
if (!IsAtProcessExit() && this == GetThread())
{
CleanupCOMState();
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
if (g_fEEShutDown != 0)
{
// We have started shutdown. Not safe to touch CLR state.
return;
}
// We took a count during construction, and we rely on the count being
// non-zero as we terminate the thread here.
_ASSERTE(m_ExternalRefCount > 0);
// The thread is no longer running. It's important that we zero any general OBJECTHANDLE's
// on this Thread object. That's because we need the managed Thread object to be subject to
// GC and yet any HANDLE is opaque to the GC when it comes to collecting cycles. If e.g. the
// Thread's AbortReason (which is an arbitrary object) contains transitively a reference back
// to the Thread, then we have an uncollectible cycle. When the thread is executing, nothing
// can be collected anyway. But now that we stop running the cycle concerns us.
//
// It's important that we only use OBJECTHANDLE's that are retrievable while the thread is
// still running. That's what allows us to zero them here with impunity:
{
// No handles to clean up in the m_ExceptionState
_ASSERTE(!m_ExceptionState.IsExceptionInProgress());
GCX_COOP();
// Destroy the LastThrown handle (and anything that violates the above assert).
SafeSetThrowables(NULL);
// Cleaning up the AbortReason is tricky, since the handle is only valid if the ADID is valid
// ...and we can only perform this operation if other threads aren't racing to update these
// values on our thread asynchronously.
ClearAbortReason();
// Free all structures related to thread statics for this thread
DeleteThreadStaticData();
}
if (GCHeapUtilities::IsGCHeapInitialized())
{
// Guaranteed to NOT be a shutdown case, because we tear down the heap before
// we tear down any threads during shutdown.
if (ThisThreadID == CurrentThreadID)
{
GCX_COOP();
GCHeapUtilities::GetGCHeap()->FixAllocContext(&m_alloc_context, false, NULL, NULL);
m_alloc_context.init();
}
}
// We switch a thread to dead when it has finished doing useful work. But it
// remains in the thread store so long as someone keeps it alive. An exposed
// object will do this (it releases the refcount in its finalizer). If the
// thread is never released, we have another look during product shutdown and
// account for the unreleased refcount of the uncollected exposed object:
if (IsDead())
{
GCX_COOP();
_ASSERTE(IsAtProcessExit());
ClearContext();
if (m_ExposedObject != NULL)
DecExternalCount(holdingLock); // may destruct now
}
else
{
#ifdef DEBUGGING_SUPPORTED
//
// If we're debugging, let the debugger know that this thread is
// gone.
//
// There is a race here where the debugger could have attached after
// we checked (and thus didn't release the lock). In this case,
// we can't call out to the debugger or we risk a deadlock.
//
if (!holdingLock && CORDebuggerAttached())
{
g_pDebugInterface->DetachThread(this);
}
#endif // DEBUGGING_SUPPORTED
#ifdef PROFILING_SUPPORTED
// If a profiler is present, then notify the profiler of thread destroy
{
BEGIN_PIN_PROFILER(CORProfilerTrackThreads());
GCX_PREEMP();
g_profControlBlock.pProfInterface->ThreadDestroyed((ThreadID) this);
END_PIN_PROFILER();
}
#endif // PROFILING_SUPPORTED
if (!holdingLock)
{
LOG((LF_SYNC, INFO3, "OnThreadTerminate obtain lock\n"));
ThreadSuspend::LockThreadStore(ThreadSuspend::SUSPEND_OTHER);
}
if (GCHeapUtilities::IsGCHeapInitialized() && ThisThreadID != CurrentThreadID)
{
// We must be holding the ThreadStore lock in order to clean up alloc context.
// We should never call FixAllocContext during GC.
GCHeapUtilities::GetGCHeap()->FixAllocContext(&m_alloc_context, false, NULL, NULL);
m_alloc_context.init();
}
FastInterlockOr((ULONG *) &m_State, TS_Dead);
ThreadStore::s_pThreadStore->m_DeadThreadCount++;
ThreadStore::s_pThreadStore->IncrementDeadThreadCountForGCTrigger();
if (IsUnstarted())
ThreadStore::s_pThreadStore->m_UnstartedThreadCount--;
else
{
if (IsBackground())
ThreadStore::s_pThreadStore->m_BackgroundThreadCount--;
}
FastInterlockAnd((ULONG *) &m_State, ~(TS_Unstarted | TS_Background));
//
// If this thread was told to trip for debugging between the
// sending of the detach event above and the locking of the
// thread store lock, then remove the flag and decrement the
// global trap returning threads count.
//
if (!IsAtProcessExit())
{
// A thread can't die during a GCPending, because the thread store's
// lock is held by the GC thread.
if (m_State & TS_DebugSuspendPending)
UnmarkForSuspension(~TS_DebugSuspendPending);
// CoreCLR does not support user-requested thread suspension
_ASSERTE(!(m_State & TS_UserSuspendPending));
if (CurrentThreadID == ThisThreadID && IsAbortRequested())
{
UnmarkThreadForAbort(Thread::TAR_ALL);
}
}
if (GetThreadHandle() != INVALID_HANDLE_VALUE)
{
if (m_ThreadHandleForClose == INVALID_HANDLE_VALUE)
{
m_ThreadHandleForClose = GetThreadHandle();
}
SetThreadHandle (INVALID_HANDLE_VALUE);
}
m_OSThreadId = 0;
// If nobody else is holding onto the thread, we may destruct it here:
ULONG oldCount = DecExternalCount(TRUE);
// If we are shutting down the process, we only have one thread active in the
// system. So we can disregard all the reasons that hold this thread alive --
// TLS is about to be reclaimed anyway.
if (IsAtProcessExit())
while (oldCount > 0)
{
oldCount = DecExternalCount(TRUE);
}
// ASSUME THAT THE THREAD IS DELETED, FROM HERE ON
_ASSERTE(ThreadStore::s_pThreadStore->m_ThreadCount >= 0);
_ASSERTE(ThreadStore::s_pThreadStore->m_BackgroundThreadCount >= 0);
_ASSERTE(ThreadStore::s_pThreadStore->m_ThreadCount >=
ThreadStore::s_pThreadStore->m_BackgroundThreadCount);
_ASSERTE(ThreadStore::s_pThreadStore->m_ThreadCount >=
ThreadStore::s_pThreadStore->m_UnstartedThreadCount);
_ASSERTE(ThreadStore::s_pThreadStore->m_ThreadCount >=
ThreadStore::s_pThreadStore->m_DeadThreadCount);
// One of the components of OtherThreadsComplete() has changed, so check whether
// we should now exit the EE.
ThreadStore::CheckForEEShutdown();
if (ThisThreadID == CurrentThreadID)
{
// NULL out the thread block in the tls. We can't do this if we aren't on the
// right thread. But this will only happen during a shutdown. And we've made
// a "best effort" to reduce to a single thread before we begin the shutdown.
SetThread(NULL);
SetAppDomain(NULL);
}
if (!holdingLock)
{
LOG((LF_SYNC, INFO3, "OnThreadTerminate releasing lock\n"));
ThreadSuspend::UnlockThreadStore(ThisThreadID == CurrentThreadID);
}
}
}
// Helper functions to check for duplicate handles. we only do this check if
// a waitfor multiple fails.
int __cdecl compareHandles( const void *arg1, const void *arg2 )
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
HANDLE h1 = *(HANDLE*)arg1;
HANDLE h2 = *(HANDLE*)arg2;
return (h1 == h2) ? 0 : ((h1 < h2) ? -1 : 1);
}
BOOL CheckForDuplicateHandles(int countHandles, HANDLE *handles)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
qsort(handles,countHandles,sizeof(HANDLE),compareHandles);
for (int i=1; i < countHandles; i++)
{
if (handles[i-1] == handles[i])
return TRUE;
}
return FALSE;
}
//--------------------------------------------------------------------
// Based on whether this thread has a message pump, do the appropriate
// style of Wait.
//--------------------------------------------------------------------
DWORD Thread::DoAppropriateWait(int countHandles, HANDLE *handles, BOOL waitAll,
DWORD millis, WaitMode mode, PendingSync *syncState)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
INDEBUG(BOOL alertable = (mode & WaitMode_Alertable) != 0;);
_ASSERTE(alertable || syncState == 0);
struct Param
{
Thread *pThis;
int countHandles;
HANDLE *handles;
BOOL waitAll;
DWORD millis;
WaitMode mode;
DWORD dwRet;
} param;
param.pThis = this;
param.countHandles = countHandles;
param.handles = handles;
param.waitAll = waitAll;
param.millis = millis;
param.mode = mode;
param.dwRet = (DWORD) -1;
EE_TRY_FOR_FINALLY(Param *, pParam, ¶m) {
pParam->dwRet = pParam->pThis->DoAppropriateWaitWorker(pParam->countHandles, pParam->handles, pParam->waitAll, pParam->millis, pParam->mode);
}
EE_FINALLY {
if (syncState) {
if (!GOT_EXCEPTION() &&
param.dwRet >= WAIT_OBJECT_0 && param.dwRet < (DWORD)(WAIT_OBJECT_0 + countHandles)) {
// This thread has been removed from syncblk waiting list by the signalling thread
syncState->Restore(FALSE);
}
else
syncState->Restore(TRUE);
}
_ASSERTE (param.dwRet != WAIT_IO_COMPLETION);
}
EE_END_FINALLY;
return(param.dwRet);
}
DWORD Thread::DoAppropriateWait(AppropriateWaitFunc func, void *args,
DWORD millis, WaitMode mode,
PendingSync *syncState)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
INDEBUG(BOOL alertable = (mode & WaitMode_Alertable) != 0;);
_ASSERTE(alertable || syncState == 0);
struct Param
{
Thread *pThis;
AppropriateWaitFunc func;
void *args;
DWORD millis;
WaitMode mode;
DWORD dwRet;
} param;
param.pThis = this;
param.func = func;
param.args = args;
param.millis = millis;
param.mode = mode;
param.dwRet = (DWORD) -1;
EE_TRY_FOR_FINALLY(Param *, pParam, ¶m) {
pParam->dwRet = pParam->pThis->DoAppropriateWaitWorker(pParam->func, pParam->args, pParam->millis, pParam->mode);
}
EE_FINALLY {
if (syncState) {
if (!GOT_EXCEPTION() && WAIT_OBJECT_0 == param.dwRet) {
// This thread has been removed from syncblk waiting list by the signalling thread
syncState->Restore(FALSE);
}
else
syncState->Restore(TRUE);
}
_ASSERTE (WAIT_IO_COMPLETION != param.dwRet);
}
EE_END_FINALLY;
return(param.dwRet);
}
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
//--------------------------------------------------------------------
// helper to do message wait
//--------------------------------------------------------------------
DWORD MsgWaitHelper(int numWaiters, HANDLE* phEvent, BOOL bWaitAll, DWORD millis, BOOL bAlertable)
{
STATIC_CONTRACT_THROWS;
// The true contract for GC trigger should be the following. But this puts a very strong restriction
// on contract for functions that call EnablePreemptiveGC.
//if (GetThread() && !ThreadStore::HoldingThreadStore(GetThread())) {GC_TRIGGERS;} else {GC_NOTRIGGER;}
STATIC_CONTRACT_SO_INTOLERANT;
STATIC_CONTRACT_GC_TRIGGERS;
DWORD flags = 0;
DWORD dwReturn=WAIT_ABANDONED;
Thread* pThread = GetThread();
// If pThread is NULL, we'd better shut down.
if (pThread == NULL)
_ASSERTE (g_fEEShutDown);
DWORD lastError = 0;
BEGIN_SO_TOLERANT_CODE(pThread);
// If we're going to pump, we cannot use WAIT_ALL. That's because the wait would
// only be satisfied if a message arrives while the handles are signalled. If we
// want true WAIT_ALL, we need to fire up a different thread in the MTA and wait
// on his result. This isn't implemented yet.
//
// A change was added to WaitHandleNative::CorWaitMultipleNative to disable WaitAll
// in an STA with more than one handle.
if (bWaitAll)
{
if (numWaiters == 1)
bWaitAll = FALSE;
// The check that's supposed to prevent this condition from occuring, in WaitHandleNative::CorWaitMultipleNative,
// is unfortunately behind FEATURE_COMINTEROP instead of FEATURE_COMINTEROP_APARTMENT_SUPPORT.
// So on CoreCLR (where FEATURE_COMINTEROP is not currently defined) we can actually reach this point.
// We can't fix this, because it's a breaking change, so we just won't assert here.
// The result is that WaitAll on an STA thread in CoreCLR will behave stragely, as described above.
}
if (bWaitAll)
flags |= COWAIT_WAITALL;
if (bAlertable)
flags |= COWAIT_ALERTABLE;
HRESULT hr = S_OK;
hr = CoWaitForMultipleHandles(flags, millis, numWaiters, phEvent, &dwReturn);
if (hr == RPC_S_CALLPENDING)
{
dwReturn = WAIT_TIMEOUT;
}
else if (FAILED(hr))
{
// The service behaves differently on an STA vs. MTA in how much
// error information it propagates back, and in which form. We currently
// only get here in the STA case, so bias this logic that way.
dwReturn = WAIT_FAILED;
}
else
{
dwReturn += WAIT_OBJECT_0; // success -- bias back
}
lastError = ::GetLastError();
END_SO_TOLERANT_CODE;
// END_SO_TOLERANT_CODE overwrites lasterror. Let's reset it.
::SetLastError(lastError);
return dwReturn;
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
DWORD WaitForMultipleObjectsEx_SO_TOLERANT (DWORD nCount, HANDLE *lpHandles, BOOL bWaitAll,DWORD dwMilliseconds, BOOL bAlertable)
{
STATIC_CONTRACT_SO_INTOLERANT;
DWORD dwRet = WAIT_FAILED;
DWORD lastError = 0;
BEGIN_SO_TOLERANT_CODE (GetThread ());
dwRet = ::WaitForMultipleObjectsEx (nCount, lpHandles, bWaitAll, dwMilliseconds, bAlertable);
lastError = ::GetLastError();
END_SO_TOLERANT_CODE;
// END_SO_TOLERANT_CODE overwrites lasterror. Let's reset it.
::SetLastError(lastError);
return dwRet;
}
//--------------------------------------------------------------------
// Do appropriate wait based on apartment state (STA or MTA)
DWORD Thread::DoAppropriateAptStateWait(int numWaiters, HANDLE* pHandles, BOOL bWaitAll,
DWORD timeout, WaitMode mode)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
SO_INTOLERANT;
}
CONTRACTL_END;
BOOL alertable = (mode & WaitMode_Alertable) != 0;
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
if (alertable && !GetDomain()->MustForceTrivialWaitOperations())
{
ApartmentState as = GetFinalApartment();
if (AS_InMTA != as)
{
return MsgWaitHelper(numWaiters, pHandles, bWaitAll, timeout, alertable);
}
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
return WaitForMultipleObjectsEx_SO_TOLERANT(numWaiters, pHandles, bWaitAll, timeout, alertable);
}
// A helper called by our two flavors of DoAppropriateWaitWorker
void Thread::DoAppropriateWaitWorkerAlertableHelper(WaitMode mode)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
// If thread abort is prevented, we do not want this thread to see thread abort and thread interrupt exception.
if (IsAbortPrevented())
{
return;
}
// A word about ordering for Interrupt. If someone tries to interrupt a thread
// that's in the interruptible state, we queue an APC. But if they try to interrupt
// a thread that's not in the interruptible state, we just record that fact. So
// we have to set TS_Interruptible before we test to see whether someone wants to
// interrupt us or else we have a race condition that causes us to skip the APC.
FastInterlockOr((ULONG *) &m_State, TS_Interruptible);
if (HasThreadStateNC(TSNC_InRestoringSyncBlock))
{
// The thread is restoring SyncBlock for Object.Wait.
ResetThreadStateNC(TSNC_InRestoringSyncBlock);
}
else
{
HandleThreadInterrupt((mode & WaitMode_ADUnload) != 0);
// Safe to clear the interrupted state, no APC could have fired since we
// reset m_UserInterrupt (which inhibits our APC callback from doing
// anything).
FastInterlockAnd((ULONG *) &m_State, ~TS_Interrupted);
}
}
void MarkOSAlertableWait()
{
LIMITED_METHOD_CONTRACT;
GetThread()->SetThreadStateNC (Thread::TSNC_OSAlertableWait);
}
void UnMarkOSAlertableWait()
{
LIMITED_METHOD_CONTRACT;
GetThread()->ResetThreadStateNC (Thread::TSNC_OSAlertableWait);
}
//--------------------------------------------------------------------
// Based on whether this thread has a message pump, do the appropriate
// style of Wait.
//--------------------------------------------------------------------
DWORD Thread::DoAppropriateWaitWorker(int countHandles, HANDLE *handles, BOOL waitAll,
DWORD millis, WaitMode mode)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
DWORD ret = 0;
BOOL alertable = (mode & WaitMode_Alertable) != 0;
// Waits from SynchronizationContext.WaitHelper are always just WaitMode_IgnoreSyncCtx.
// So if we defer to a sync ctx, we will lose any extra bits. We must therefore not
// defer to a sync ctx if doing any non-default wait.
// If you're doing a default wait, but want to ignore sync ctx, specify WaitMode_IgnoreSyncCtx
// which will make mode != WaitMode_Alertable.
BOOL ignoreSyncCtx = (mode != WaitMode_Alertable);
if (GetDomain()->MustForceTrivialWaitOperations())
ignoreSyncCtx = TRUE;
// Unless the ignoreSyncCtx flag is set, first check to see if there is a synchronization
// context on the current thread and if there is, dispatch to it to do the wait.
// If the wait is non alertable we cannot forward the call to the sync context
// since fundamental parts of the system (such as the GC) rely on non alertable
// waits not running any managed code. Also if we are past the point in shutdown were we
// are allowed to run managed code then we can't forward the call to the sync context.
if (!ignoreSyncCtx && alertable && CanRunManagedCode(LoaderLockCheck::None)
&& !HasThreadStateNC(Thread::TSNC_BlockedForShutdown))
{
GCX_COOP();
BOOL fSyncCtxPresent = FALSE;
OBJECTREF SyncCtxObj = NULL;
GCPROTECT_BEGIN(SyncCtxObj)
{
GetSynchronizationContext(&SyncCtxObj);
if (SyncCtxObj != NULL)
{
SYNCHRONIZATIONCONTEXTREF syncRef = (SYNCHRONIZATIONCONTEXTREF)SyncCtxObj;
if (syncRef->IsWaitNotificationRequired())
{
fSyncCtxPresent = TRUE;
ret = DoSyncContextWait(&SyncCtxObj, countHandles, handles, waitAll, millis);
}
}
}
GCPROTECT_END();
if (fSyncCtxPresent)
return ret;
}
// Before going to pre-emptive mode the thread needs to be flagged as waiting for
// the debugger. This used to be accomplished by the TS_Interruptible flag but that
// doesn't work reliably, see DevDiv Bugs 699245. Some methods call in here already in
// COOP mode so we set the bit before the transition. For the calls that are already
// in pre-emptive mode those are still buggy. This is only a partial fix.
BOOL isCoop = PreemptiveGCDisabled();
ThreadStateNCStackHolder tsNC(isCoop && alertable, TSNC_DebuggerSleepWaitJoin);
GCX_PREEMP();
if (alertable)
{
DoAppropriateWaitWorkerAlertableHelper(mode);
}
StateHolder<MarkOSAlertableWait,UnMarkOSAlertableWait> OSAlertableWait(alertable);
ThreadStateHolder tsh(alertable, TS_Interruptible | TS_Interrupted);
ULONGLONG dwStart = 0, dwEnd;
retry:
if (millis != INFINITE)
{
dwStart = CLRGetTickCount64();
}
ret = DoAppropriateAptStateWait(countHandles, handles, waitAll, millis, mode);
if (ret == WAIT_IO_COMPLETION)
{
_ASSERTE (alertable);
if (m_State & TS_Interrupted)
{
HandleThreadInterrupt(mode & WaitMode_ADUnload);
}
// We could be woken by some spurious APC or an EE APC queued to
// interrupt us. In the latter case the TS_Interrupted bit will be set
// in the thread state bits. Otherwise we just go back to sleep again.
if (millis != INFINITE)
{
dwEnd = CLRGetTickCount64();
if (dwEnd >= dwStart + millis)
{
ret = WAIT_TIMEOUT;
goto WaitCompleted;
}
else
{
millis -= (DWORD)(dwEnd - dwStart);
}
}
goto retry;
}
_ASSERTE((ret >= WAIT_OBJECT_0 && ret < (WAIT_OBJECT_0 + (DWORD)countHandles)) ||
(ret >= WAIT_ABANDONED && ret < (WAIT_ABANDONED + (DWORD)countHandles)) ||
(ret == WAIT_TIMEOUT) || (ret == WAIT_FAILED));
// countHandles is used as an unsigned -- it should never be negative.
_ASSERTE(countHandles >= 0);
// We support precisely one WAIT_FAILED case, where we attempt to wait on a
// thread handle and the thread is in the process of dying we might get a
// invalid handle substatus. Turn this into a successful wait.
// There are three cases to consider:
// 1) Only waiting on one handle: return success right away.
// 2) Waiting for all handles to be signalled: retry the wait without the
// affected handle.
// 3) Waiting for one of multiple handles to be signalled: return with the
// first handle that is either signalled or has become invalid.
if (ret == WAIT_FAILED)
{
DWORD errorCode = ::GetLastError();
if (errorCode == ERROR_INVALID_PARAMETER)
{
if (CheckForDuplicateHandles(countHandles, handles))
COMPlusThrow(kDuplicateWaitObjectException);
else
COMPlusThrowHR(HRESULT_FROM_WIN32(errorCode));
}
else if (errorCode == ERROR_ACCESS_DENIED)
{
// A Win32 ACL could prevent us from waiting on the handle.
COMPlusThrow(kUnauthorizedAccessException);
}
else if (errorCode == ERROR_NOT_ENOUGH_MEMORY)
{
ThrowOutOfMemory();
}
#ifdef FEATURE_PAL
else if (errorCode == ERROR_NOT_SUPPORTED)
{
// "Wait for any" and "wait for all" operations on multiple wait handles are not supported when a cross-process sync
// object is included in the array
COMPlusThrow(kPlatformNotSupportedException, W("PlatformNotSupported_NamedSyncObjectWaitAnyWaitAll"));
}
#endif
else if (errorCode != ERROR_INVALID_HANDLE)
{
ThrowWin32(errorCode);
}
if (countHandles == 1)
ret = WAIT_OBJECT_0;
else if (waitAll)
{
// Probe all handles with a timeout of zero. When we find one that's
// invalid, move it out of the list and retry the wait.
for (int i = 0; i < countHandles; i++)
{
// WaitForSingleObject won't pump memssage; we already probe enough space
// before calling this function and we don't want to fail here, so we don't
// do a transition to tolerant code here
DWORD subRet = WaitForSingleObject (handles[i], 0);
if (subRet != WAIT_FAILED)
continue;
_ASSERTE(::GetLastError() == ERROR_INVALID_HANDLE);
if ((countHandles - i - 1) > 0)
memmove(&handles[i], &handles[i+1], (countHandles - i - 1) * sizeof(HANDLE));
countHandles--;
break;
}
// Compute the new timeout value by assume that the timeout
// is not large enough for more than one wrap
dwEnd = CLRGetTickCount64();
if (millis != INFINITE)
{
if (dwEnd >= dwStart + millis)
{
ret = WAIT_TIMEOUT;
goto WaitCompleted;
}
else
{
millis -= (DWORD)(dwEnd - dwStart);
}
}
goto retry;
}
else
{
// Probe all handles with a timeout as zero, succeed with the first
// handle that doesn't timeout.
ret = WAIT_OBJECT_0;
int i;
for (i = 0; i < countHandles; i++)
{
TryAgain:
// WaitForSingleObject won't pump memssage; we already probe enough space
// before calling this function and we don't want to fail here, so we don't
// do a transition to tolerant code here
DWORD subRet = WaitForSingleObject (handles[i], 0);
if ((subRet == WAIT_OBJECT_0) || (subRet == WAIT_FAILED))
break;
if (subRet == WAIT_ABANDONED)
{
ret = (ret - WAIT_OBJECT_0) + WAIT_ABANDONED;
break;
}
// If we get alerted it just masks the real state of the current
// handle, so retry the wait.
if (subRet == WAIT_IO_COMPLETION)
goto TryAgain;
_ASSERTE(subRet == WAIT_TIMEOUT);
ret++;
}
}
}
WaitCompleted:
_ASSERTE((ret != WAIT_TIMEOUT) || (millis != INFINITE));
return ret;
}
DWORD Thread::DoAppropriateWaitWorker(AppropriateWaitFunc func, void *args,
DWORD millis, WaitMode mode)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
BOOL alertable = (mode & WaitMode_Alertable)!=0;
// Before going to pre-emptive mode the thread needs to be flagged as waiting for
// the debugger. This used to be accomplished by the TS_Interruptible flag but that
// doesn't work reliably, see DevDiv Bugs 699245. Some methods call in here already in
// COOP mode so we set the bit before the transition. For the calls that are already
// in pre-emptive mode those are still buggy. This is only a partial fix.
BOOL isCoop = PreemptiveGCDisabled();
ThreadStateNCStackHolder tsNC(isCoop && alertable, TSNC_DebuggerSleepWaitJoin);
GCX_PREEMP();
// <TODO>
// @TODO cwb: we don't know whether a thread has a message pump or
// how to pump its messages, currently.
// @TODO cwb: WinCE isn't going to support Thread.Interrupt() correctly until
// we get alertable waits on that platform.</TODO>
DWORD ret;
if(alertable)
{
DoAppropriateWaitWorkerAlertableHelper(mode);
}
DWORD option;
if (alertable)
{
option = WAIT_ALERTABLE;
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
ApartmentState as = GetFinalApartment();
if ((AS_InMTA != as) && !GetDomain()->MustForceTrivialWaitOperations())
{
option |= WAIT_MSGPUMP;
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
}
else
{
option = 0;
}
ThreadStateHolder tsh(alertable, TS_Interruptible | TS_Interrupted);
ULONGLONG dwStart = 0;
ULONGLONG dwEnd;
retry:
if (millis != INFINITE)
{
dwStart = CLRGetTickCount64();
}
ret = func(args, millis, option);
if (ret == WAIT_IO_COMPLETION)
{
_ASSERTE (alertable);
if ((m_State & TS_Interrupted))
{
HandleThreadInterrupt(mode & WaitMode_ADUnload);
}
if (millis != INFINITE)
{
dwEnd = CLRGetTickCount64();
if (dwEnd >= dwStart + millis)
{
ret = WAIT_TIMEOUT;
goto WaitCompleted;
}
else
{
millis -= (DWORD)(dwEnd - dwStart);
}
}
goto retry;
}
WaitCompleted:
_ASSERTE(ret == WAIT_OBJECT_0 ||
ret == WAIT_ABANDONED ||
ret == WAIT_TIMEOUT ||
ret == WAIT_FAILED);
_ASSERTE((ret != WAIT_TIMEOUT) || (millis != INFINITE));
return ret;
}
#ifndef FEATURE_PAL
//--------------------------------------------------------------------
// Only one style of wait for DoSignalAndWait since we don't support this on STA Threads
//--------------------------------------------------------------------
DWORD Thread::DoSignalAndWait(HANDLE *handles, DWORD millis, BOOL alertable, PendingSync *syncState)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
_ASSERTE(alertable || syncState == 0);
struct Param
{
Thread *pThis;
HANDLE *handles;
DWORD millis;
BOOL alertable;
DWORD dwRet;
} param;
param.pThis = this;
param.handles = handles;
param.millis = millis;
param.alertable = alertable;
param.dwRet = (DWORD) -1;
EE_TRY_FOR_FINALLY(Param *, pParam, ¶m) {
pParam->dwRet = pParam->pThis->DoSignalAndWaitWorker(pParam->handles, pParam->millis, pParam->alertable);
}
EE_FINALLY {
if (syncState) {
if (!GOT_EXCEPTION() && WAIT_OBJECT_0 == param.dwRet) {
// This thread has been removed from syncblk waiting list by the signalling thread
syncState->Restore(FALSE);
}
else
syncState->Restore(TRUE);
}
_ASSERTE (WAIT_IO_COMPLETION != param.dwRet);
}
EE_END_FINALLY;
return(param.dwRet);
}
DWORD Thread::DoSignalAndWaitWorker(HANDLE* pHandles, DWORD millis,BOOL alertable)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
DWORD ret = 0;
GCX_PREEMP();
if(alertable)
{
DoAppropriateWaitWorkerAlertableHelper(WaitMode_None);
}
StateHolder<MarkOSAlertableWait,UnMarkOSAlertableWait> OSAlertableWait(alertable);
ThreadStateHolder tsh(alertable, TS_Interruptible | TS_Interrupted);
ULONGLONG dwStart = 0, dwEnd;
if (INFINITE != millis)
{
dwStart = CLRGetTickCount64();
}
ret = SignalObjectAndWait(pHandles[0], pHandles[1], millis, alertable);
retry:
if (WAIT_IO_COMPLETION == ret)
{
_ASSERTE (alertable);
// We could be woken by some spurious APC or an EE APC queued to
// interrupt us. In the latter case the TS_Interrupted bit will be set
// in the thread state bits. Otherwise we just go back to sleep again.
if ((m_State & TS_Interrupted))
{
HandleThreadInterrupt(FALSE);
}
if (INFINITE != millis)
{
dwEnd = CLRGetTickCount64();
if (dwStart + millis <= dwEnd)
{
ret = WAIT_TIMEOUT;
goto WaitCompleted;
}
else
{
millis -= (DWORD)(dwEnd - dwStart);
}
dwStart = CLRGetTickCount64();
}
//Retry case we don't want to signal again so only do the wait...
ret = WaitForSingleObjectEx(pHandles[1],millis,TRUE);
goto retry;
}
if (WAIT_FAILED == ret)
{
DWORD errorCode = ::GetLastError();
//If the handle to signal is a mutex and
// the calling thread is not the owner, errorCode is ERROR_NOT_OWNER
switch(errorCode)
{
case ERROR_INVALID_HANDLE:
case ERROR_NOT_OWNER:
case ERROR_ACCESS_DENIED:
COMPlusThrowWin32();
break;
case ERROR_TOO_MANY_POSTS:
ret = ERROR_TOO_MANY_POSTS;
break;
default:
CONSISTENCY_CHECK_MSGF(0, ("This errorCode is not understood '(%d)''\n", errorCode));
COMPlusThrowWin32();
break;
}
}
WaitCompleted:
//Check that the return state is valid
_ASSERTE(WAIT_OBJECT_0 == ret ||
WAIT_ABANDONED == ret ||
WAIT_TIMEOUT == ret ||
WAIT_FAILED == ret ||
ERROR_TOO_MANY_POSTS == ret);
//Wrong to time out if the wait was infinite
_ASSERTE((WAIT_TIMEOUT != ret) || (INFINITE != millis));
return ret;
}
#endif // !FEATURE_PAL
DWORD Thread::DoSyncContextWait(OBJECTREF *pSyncCtxObj, int countHandles, HANDLE *handles, BOOL waitAll, DWORD millis)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
PRECONDITION(CheckPointer(handles));
PRECONDITION(IsProtectedByGCFrame (pSyncCtxObj));
}
CONTRACTL_END;
MethodDescCallSite invokeWaitMethodHelper(METHOD__SYNCHRONIZATION_CONTEXT__INVOKE_WAIT_METHOD_HELPER);
BASEARRAYREF handleArrayObj = (BASEARRAYREF)AllocatePrimitiveArray(ELEMENT_TYPE_I, countHandles);
memcpyNoGCRefs(handleArrayObj->GetDataPtr(), handles, countHandles * sizeof(HANDLE));
ARG_SLOT args[6] =
{
ObjToArgSlot(*pSyncCtxObj),
ObjToArgSlot(handleArrayObj),
BoolToArgSlot(waitAll),
(ARG_SLOT)millis,
};
// Needed by TriggerGCForMDAInternal to avoid infinite recursion
ThreadStateNCStackHolder holder(TRUE, TSNC_InsideSyncContextWait);
return invokeWaitMethodHelper.Call_RetI4(args);
}
// Called out of SyncBlock::Wait() to block this thread until the Notify occurs.
BOOL Thread::Block(INT32 timeOut, PendingSync *syncState)
{
WRAPPER_NO_CONTRACT;
_ASSERTE(this == GetThread());
// Before calling Block, the SyncBlock queued us onto it's list of waiting threads.
// However, before calling Block the SyncBlock temporarily left the synchronized
// region. This allowed threads to enter the region and call Notify, in which
// case we may have been signalled before we entered the Wait. So we aren't in the
// m_WaitSB list any longer. Not a problem: the following Wait will return
// immediately. But it means we cannot enforce the following assertion:
// _ASSERTE(m_WaitSB != NULL);
return (Wait(syncState->m_WaitEventLink->m_Next->m_EventWait, timeOut, syncState) != WAIT_OBJECT_0);
}
// Return whether or not a timeout occurred. TRUE=>we waited successfully
DWORD Thread::Wait(HANDLE *objs, int cntObjs, INT32 timeOut, PendingSync *syncInfo)
{
WRAPPER_NO_CONTRACT;
DWORD dwResult;
DWORD dwTimeOut32;
_ASSERTE(timeOut >= 0 || timeOut == INFINITE_TIMEOUT);
dwTimeOut32 = (timeOut == INFINITE_TIMEOUT
? INFINITE
: (DWORD) timeOut);
dwResult = DoAppropriateWait(cntObjs, objs, FALSE /*=waitAll*/, dwTimeOut32,
WaitMode_Alertable /*alertable*/,
syncInfo);
// Either we succeeded in the wait, or we timed out
_ASSERTE((dwResult >= WAIT_OBJECT_0 && dwResult < (DWORD)(WAIT_OBJECT_0 + cntObjs)) ||
(dwResult == WAIT_TIMEOUT));
return dwResult;
}
// Return whether or not a timeout occurred. TRUE=>we waited successfully
DWORD Thread::Wait(CLREvent *pEvent, INT32 timeOut, PendingSync *syncInfo)
{
WRAPPER_NO_CONTRACT;
DWORD dwResult;
DWORD dwTimeOut32;
_ASSERTE(timeOut >= 0 || timeOut == INFINITE_TIMEOUT);
dwTimeOut32 = (timeOut == INFINITE_TIMEOUT
? INFINITE
: (DWORD) timeOut);
dwResult = pEvent->Wait(dwTimeOut32, TRUE /*alertable*/, syncInfo);
// Either we succeeded in the wait, or we timed out
_ASSERTE((dwResult == WAIT_OBJECT_0) ||
(dwResult == WAIT_TIMEOUT));
return dwResult;
}
void Thread::Wake(SyncBlock *psb)
{
WRAPPER_NO_CONTRACT;
CLREvent* hEvent = NULL;
WaitEventLink *walk = &m_WaitEventLink;
while (walk->m_Next) {
if (walk->m_Next->m_WaitSB == psb) {
hEvent = walk->m_Next->m_EventWait;
// We are guaranteed that only one thread can change walk->m_Next->m_WaitSB
// since the thread is helding the syncblock.
walk->m_Next->m_WaitSB = (SyncBlock*)((DWORD_PTR)walk->m_Next->m_WaitSB | 1);
break;
}
#ifdef _DEBUG
else if ((SyncBlock*)((DWORD_PTR)walk->m_Next & ~1) == psb) {
_ASSERTE (!"Can not wake a thread on the same SyncBlock more than once");
}
#endif
}
PREFIX_ASSUME (hEvent != NULL);
hEvent->Set();
}
#define WAIT_INTERRUPT_THREADABORT 0x1
#define WAIT_INTERRUPT_INTERRUPT 0x2
#define WAIT_INTERRUPT_OTHEREXCEPTION 0x4
// When we restore
DWORD EnterMonitorForRestore(SyncBlock *pSB)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
DWORD state = 0;
EX_TRY
{
pSB->EnterMonitor();
}
EX_CATCH
{
// Assume it is a normal exception unless proven.
state = WAIT_INTERRUPT_OTHEREXCEPTION;
Thread *pThread = GetThread();
if (pThread->IsAbortInitiated())
{
state = WAIT_INTERRUPT_THREADABORT;
}
else if (__pException != NULL)
{
if (__pException->GetHR() == COR_E_THREADINTERRUPTED)
{
state = WAIT_INTERRUPT_INTERRUPT;
}
}
}
EX_END_CATCH(SwallowAllExceptions);
return state;
}
// This is the service that backs us out of a wait that we interrupted. We must
// re-enter the monitor to the same extent the SyncBlock would, if we returned
// through it (instead of throwing through it). And we need to cancel the wait,
// if it didn't get notified away while we are processing the interrupt.
void PendingSync::Restore(BOOL bRemoveFromSB)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
_ASSERTE(m_EnterCount);
Thread *pCurThread = GetThread();
_ASSERTE (pCurThread == m_OwnerThread);
WaitEventLink *pRealWaitEventLink = m_WaitEventLink->m_Next;
pRealWaitEventLink->m_RefCount --;
if (pRealWaitEventLink->m_RefCount == 0)
{
if (bRemoveFromSB) {
ThreadQueue::RemoveThread(pCurThread, pRealWaitEventLink->m_WaitSB);
}
if (pRealWaitEventLink->m_EventWait != &pCurThread->m_EventWait) {
// Put the event back to the pool.
StoreEventToEventStore(pRealWaitEventLink->m_EventWait);
}
// Remove from the link.
m_WaitEventLink->m_Next = m_WaitEventLink->m_Next->m_Next;
}
// Someone up the stack is responsible for keeping the syncblock alive by protecting
// the object that owns it. But this relies on assertions that EnterMonitor is only
// called in cooperative mode. Even though we are safe in preemptive, do the
// switch.
GCX_COOP_THREAD_EXISTS(pCurThread);
// We need to make sure that EnterMonitor succeeds. We may have code like
// lock (a)
// {
// a.Wait
// }
// We need to make sure that the finally from lock is excuted with the lock owned.
DWORD state = 0;
SyncBlock *psb = (SyncBlock*)((DWORD_PTR)pRealWaitEventLink->m_WaitSB & ~1);
for (LONG i=0; i < m_EnterCount;)
{
if ((state & (WAIT_INTERRUPT_THREADABORT | WAIT_INTERRUPT_INTERRUPT)) != 0)
{
// If the thread has been interrupted by Thread.Interrupt or Thread.Abort,
// disable the check at the beginning of DoAppropriateWait
pCurThread->SetThreadStateNC(Thread::TSNC_InRestoringSyncBlock);
}
DWORD result = EnterMonitorForRestore(psb);
if (result == 0)
{
i++;
}
else
{
// We block the thread until the thread acquires the lock.
// This is to make sure that when catch/finally is executed, the thread has the lock.
// We do not want thread to run its catch/finally if the lock is not taken.
state |= result;
// If the thread is being rudely aborted, and the thread has
// no Cer on stack, we will not run managed code to release the
// lock, so we can terminate the loop.
if (pCurThread->IsRudeAbortInitiated() &&
!pCurThread->IsExecutingWithinCer())
{
break;
}
}
}
pCurThread->ResetThreadStateNC(Thread::TSNC_InRestoringSyncBlock);
if ((state & WAIT_INTERRUPT_THREADABORT) != 0)
{
pCurThread->HandleThreadAbort();
}
else if ((state & WAIT_INTERRUPT_INTERRUPT) != 0)
{
COMPlusThrow(kThreadInterruptedException);
}
}
// This is the callback from the OS, when we queue an APC to interrupt a waiting thread.
// The callback occurs on the thread we wish to interrupt. It is a STATIC method.
void WINAPI Thread::UserInterruptAPC(ULONG_PTR data)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
_ASSERTE(data == APC_Code);
Thread *pCurThread = GetThread();
if (pCurThread)
{
// We should only take action if an interrupt is currently being
// requested (our synchronization does not guarantee that we won't fire
// spuriously). It's safe to check the m_UserInterrupt field and then
// set TS_Interrupted in a non-atomic fashion because m_UserInterrupt is
// only cleared in this thread's context (though it may be set from any
// context).
if (pCurThread->IsUserInterrupted())
{
// Set bit to indicate this routine was called (as opposed to other
// generic APCs).
FastInterlockOr((ULONG *) &pCurThread->m_State, TS_Interrupted);
}
}
}
// This is the workhorse for Thread.Interrupt().
void Thread::UserInterrupt(ThreadInterruptMode mode)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
FastInterlockOr((DWORD*)&m_UserInterrupt, mode);
if (HasValidThreadHandle() &&
HasThreadState (TS_Interruptible))
{
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Abort);
#endif
Alert();
}
}
// Implementation of Thread.Sleep().
void Thread::UserSleep(INT32 time)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
INCONTRACT(_ASSERTE(!GetThread()->GCNoTrigger()));
DWORD res;
// Before going to pre-emptive mode the thread needs to be flagged as waiting for
// the debugger. This used to be accomplished by the TS_Interruptible flag but that
// doesn't work reliably, see DevDiv Bugs 699245.
ThreadStateNCStackHolder tsNC(TRUE, TSNC_DebuggerSleepWaitJoin);
GCX_PREEMP();
// A word about ordering for Interrupt. If someone tries to interrupt a thread
// that's in the interruptible state, we queue an APC. But if they try to interrupt
// a thread that's not in the interruptible state, we just record that fact. So
// we have to set TS_Interruptible before we test to see whether someone wants to
// interrupt us or else we have a race condition that causes us to skip the APC.
FastInterlockOr((ULONG *) &m_State, TS_Interruptible);
// If someone has interrupted us, we should not enter the wait.
if (IsUserInterrupted())
{
HandleThreadInterrupt(FALSE);
}
ThreadStateHolder tsh(TRUE, TS_Interruptible | TS_Interrupted);
FastInterlockAnd((ULONG *) &m_State, ~TS_Interrupted);
DWORD dwTime = (DWORD)time;
retry:
ULONGLONG start = CLRGetTickCount64();
res = ClrSleepEx (dwTime, TRUE);
if (res == WAIT_IO_COMPLETION)
{
// We could be woken by some spurious APC or an EE APC queued to
// interrupt us. In the latter case the TS_Interrupted bit will be set
// in the thread state bits. Otherwise we just go back to sleep again.
if ((m_State & TS_Interrupted))
{
HandleThreadInterrupt(FALSE);
}
if (dwTime == INFINITE)
{
goto retry;
}
else
{
ULONGLONG actDuration = CLRGetTickCount64() - start;
if (dwTime > actDuration)
{
dwTime -= (DWORD)actDuration;
goto retry;
}
else
{
res = WAIT_TIMEOUT;
}
}
}
_ASSERTE(res == WAIT_TIMEOUT || res == WAIT_OBJECT_0);
}
// Correspondence between an EE Thread and an exposed System.Thread:
OBJECTREF Thread::GetExposedObject()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
TRIGGERSGC();
Thread *pCurThread = GetThread();
_ASSERTE (!(pCurThread == NULL || IsAtProcessExit()));
_ASSERTE(pCurThread->PreemptiveGCDisabled());
if (ObjectFromHandle(m_ExposedObject) == NULL)
{
// Allocate the exposed thread object.
THREADBASEREF attempt = (THREADBASEREF) AllocateObject(g_pThreadClass);
GCPROTECT_BEGIN(attempt);
// The exposed object keeps us alive until it is GC'ed. This
// doesn't mean the physical thread continues to run, of course.
// We have to set this outside of the ThreadStore lock, because this might trigger a GC.
attempt->SetInternal(this);
BOOL fNeedThreadStore = (! ThreadStore::HoldingThreadStore(pCurThread));
// Take a lock to make sure that only one thread creates the object.
ThreadStoreLockHolder tsHolder(fNeedThreadStore);
// Check to see if another thread has not already created the exposed object.
if (ObjectFromHandle(m_ExposedObject) == NULL)
{
// Keep a weak reference to the exposed object.
StoreObjectInHandle(m_ExposedObject, (OBJECTREF) attempt);
ObjectInHandleHolder exposedHolder(m_ExposedObject);
// Increase the external ref count. We can't call IncExternalCount because we
// already hold the thread lock and IncExternalCount won't be able to take it.
ULONG retVal = FastInterlockIncrement ((LONG*)&m_ExternalRefCount);
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Lifetime);
#endif
// Check to see if we need to store a strong pointer to the object.
if (retVal > 1)
StoreObjectInHandle(m_StrongHndToExposedObject, (OBJECTREF) attempt);
ObjectInHandleHolder strongHolder(m_StrongHndToExposedObject);
attempt->SetManagedThreadId(GetThreadId());
// Note that we are NOT calling the constructor on the Thread. That's
// because this is an internal create where we don't want a Start
// address. And we don't want to expose such a constructor for our
// customers to accidentally call. The following is in lieu of a true
// constructor:
attempt->InitExisting();
exposedHolder.SuppressRelease();
strongHolder.SuppressRelease();
}
else
{
attempt->ClearInternal();
}
GCPROTECT_END();
}
return ObjectFromHandle(m_ExposedObject);
}
// We only set non NULL exposed objects for unstarted threads that haven't exited
// their constructor yet. So there are no race conditions.
void Thread::SetExposedObject(OBJECTREF exposed)
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
if (exposed != NULL)
{
_ASSERTE (GetThread() != this);
_ASSERTE(IsUnstarted());
_ASSERTE(ObjectFromHandle(m_ExposedObject) == NULL);
// The exposed object keeps us alive until it is GC'ed. This doesn't mean the
// physical thread continues to run, of course.
StoreObjectInHandle(m_ExposedObject, exposed);
// This makes sure the contexts on the backing thread
// and the managed thread start off in sync with each other.
// BEWARE: the IncExternalCount call below may cause GC to happen.
// IncExternalCount will store exposed in m_StrongHndToExposedObject which is in default domain.
// If the creating thread is killed before the target thread is killed in Thread.Start, Thread object
// will be kept alive forever.
// Instead, IncExternalCount should be called after the target thread has been started in Thread.Start.
// IncExternalCount();
}
else
{
// Simply set both of the handles to NULL. The GC of the old exposed thread
// object will take care of decrementing the external ref count.
StoreObjectInHandle(m_ExposedObject, NULL);
StoreObjectInHandle(m_StrongHndToExposedObject, NULL);
}
}
void Thread::SetLastThrownObject(OBJECTREF throwable, BOOL isUnhandled)
{
CONTRACTL
{
if ((throwable == NULL) || CLRException::IsPreallocatedExceptionObject(throwable)) NOTHROW; else THROWS; // From CreateHandle
GC_NOTRIGGER;
if (throwable == NULL) MODE_ANY; else MODE_COOPERATIVE;
SO_TOLERANT;
}
CONTRACTL_END;
STRESS_LOG_COND1(LF_EH, LL_INFO100, OBJECTREFToObject(throwable) != NULL, "in Thread::SetLastThrownObject: obj = %p\n", OBJECTREFToObject(throwable));
// you can't have a NULL unhandled exception
_ASSERTE(!(throwable == NULL && isUnhandled));
if (m_LastThrownObjectHandle != NULL)
{
// We'll somtimes use a handle for a preallocated exception object. We should never, ever destroy one of
// these handles... they'll be destroyed when the Runtime shuts down.
if (!CLRException::IsPreallocatedExceptionHandle(m_LastThrownObjectHandle))
{
DestroyHandle(m_LastThrownObjectHandle);
}
m_LastThrownObjectHandle = NULL; // Make sure to set this to NULL here just in case we throw trying to make
// a new handle below.
}
if (throwable != NULL)
{
_ASSERTE(this == GetThread());
// Non-compliant exceptions are always wrapped.
// The use of the ExceptionNative:: helper here (rather than the global ::IsException helper)
// is hokey, but we need a GC_NOTRIGGER version and it's only for an ASSERT.
_ASSERTE(IsException(throwable->GetMethodTable()));
// If we're tracking one of the preallocated exception objects, then just use the global handle that
// matches it rather than creating a new one.
if (CLRException::IsPreallocatedExceptionObject(throwable))
{
m_LastThrownObjectHandle = CLRException::GetPreallocatedHandleForObject(throwable);
}
else
{
BEGIN_SO_INTOLERANT_CODE(GetThread());
{
m_LastThrownObjectHandle = GetDomain()->CreateHandle(throwable);
}
END_SO_INTOLERANT_CODE;
}
_ASSERTE(m_LastThrownObjectHandle != NULL);
m_ltoIsUnhandled = isUnhandled;
}
else
{
m_ltoIsUnhandled = FALSE;
}
}
void Thread::SetSOForLastThrownObject()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE;
SO_TOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
// If we are saving stack overflow exception, we can just null out the current handle.
// The current domain is going to be unloaded or the process is going to be killed, so
// we will not leak a handle.
m_LastThrownObjectHandle = CLRException::GetPreallocatedStackOverflowExceptionHandle();
}
//
// This is a nice wrapper for SetLastThrownObject which catches any exceptions caused by not being able to create
// the handle for the throwable, and setting the last thrown object to the preallocated out of memory exception
// instead.
//
OBJECTREF Thread::SafeSetLastThrownObject(OBJECTREF throwable)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
if (throwable == NULL) MODE_ANY; else MODE_COOPERATIVE;
SO_TOLERANT;
}
CONTRACTL_END;
// We return the original throwable if nothing goes wrong.
OBJECTREF ret = throwable;
EX_TRY
{
// Try to set the throwable.
SetLastThrownObject(throwable);
}
EX_CATCH
{
// If it didn't work, then set the last thrown object to the preallocated OOM exception, and return that
// object instead of the original throwable.
ret = CLRException::GetPreallocatedOutOfMemoryException();
SetLastThrownObject(ret);
}
EX_END_CATCH(SwallowAllExceptions);
return ret;
}
//
// This is a nice wrapper for SetThrowable and SetLastThrownObject, which catches any exceptions caused by not
// being able to create the handle for the throwable, and sets the throwable to the preallocated out of memory
// exception instead. It also updates the last thrown object, which is always updated when the throwable is
// updated.
//
OBJECTREF Thread::SafeSetThrowables(OBJECTREF throwable DEBUG_ARG(ThreadExceptionState::SetThrowableErrorChecking stecFlags),
BOOL isUnhandled)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
if (throwable == NULL) MODE_ANY; else MODE_COOPERATIVE;
SO_TOLERANT;
}
CONTRACTL_END;
// We return the original throwable if nothing goes wrong.
OBJECTREF ret = throwable;
EX_TRY
{
// Try to set the throwable.
SetThrowable(throwable DEBUG_ARG(stecFlags));
// Now, if the last thrown object is different, go ahead and update it. This makes sure that we re-throw
// the right object when we rethrow.
if (LastThrownObject() != throwable)
{
SetLastThrownObject(throwable);
}
if (isUnhandled)
{
MarkLastThrownObjectUnhandled();
}
}
EX_CATCH
{
// If either set didn't work, then set both throwables to the preallocated OOM exception, and return that
// object instead of the original throwable.
ret = CLRException::GetPreallocatedOutOfMemoryException();
// Neither of these will throw because we're setting with a preallocated exception.
SetThrowable(ret DEBUG_ARG(stecFlags));
SetLastThrownObject(ret, isUnhandled);
}
EX_END_CATCH(SwallowAllExceptions);
return ret;
}
// This method will sync the managed exception state to be in sync with the topmost active exception
// for a given thread
void Thread::SyncManagedExceptionState(bool fIsDebuggerThread)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
{
GCX_COOP();
// Syncup the LastThrownObject on the managed thread
SafeUpdateLastThrownObject();
}
#ifdef FEATURE_CORRUPTING_EXCEPTIONS
// Since the catch clause has successfully executed and we are exiting it, reset the corruption severity
// in the ThreadExceptionState for the last active exception. This will ensure that when the next exception
// gets thrown/raised, EH tracker wont pick up an invalid value.
if (!fIsDebuggerThread)
{
CEHelper::ResetLastActiveCorruptionSeverityPostCatchHandler(this);
}
#endif // FEATURE_CORRUPTING_EXCEPTIONS
}
void Thread::SetLastThrownObjectHandle(OBJECTHANDLE h)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE;
SO_TOLERANT;
}
CONTRACTL_END;
if (m_LastThrownObjectHandle != NULL &&
!CLRException::IsPreallocatedExceptionHandle(m_LastThrownObjectHandle))
{
DestroyHandle(m_LastThrownObjectHandle);
}
m_LastThrownObjectHandle = h;
}
//
// Create a duplicate handle of the current throwable and set the last thrown object to that. This ensures that the
// last thrown object and the current throwable have handles that are in the same app domain.
//
void Thread::SafeUpdateLastThrownObject(void)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE;
SO_INTOLERANT;
}
CONTRACTL_END;
OBJECTHANDLE hThrowable = GetThrowableAsHandle();
if (hThrowable != NULL)
{
EX_TRY
{
IGCHandleManager *pHandleTable = GCHandleUtilities::GetGCHandleManager();
// Creating a duplicate handle here ensures that the AD of the last thrown object
// matches the domain of the current throwable.
OBJECTHANDLE duplicateHandle = pHandleTable->CreateDuplicateHandle(hThrowable);
SetLastThrownObjectHandle(duplicateHandle);
}
EX_CATCH
{
// If we can't create a duplicate handle, we set both throwables to the preallocated OOM exception.
SafeSetThrowables(CLRException::GetPreallocatedOutOfMemoryException());
}
EX_END_CATCH(SwallowAllExceptions);
}
}
// Background threads must be counted, because the EE should shut down when the
// last non-background thread terminates. But we only count running ones.
void Thread::SetBackground(BOOL isBack, BOOL bRequiresTSL)
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
// booleanize IsBackground() which just returns bits
if (isBack == !!IsBackground())
return;
LOG((LF_SYNC, INFO3, "SetBackground obtain lock\n"));
ThreadStoreLockHolder TSLockHolder(FALSE);
if (bRequiresTSL)
{
TSLockHolder.Acquire();
}
if (IsDead())
{
// This can only happen in a race condition, where the correct thing to do
// is ignore it. If it happens without the race condition, we throw an
// exception.
}
else
if (isBack)
{
if (!IsBackground())
{
FastInterlockOr((ULONG *) &m_State, TS_Background);
// unstarted threads don't contribute to the background count
if (!IsUnstarted())
ThreadStore::s_pThreadStore->m_BackgroundThreadCount++;
// If we put the main thread into a wait, until only background threads exist,
// then we make that
// main thread a background thread. This cleanly handles the case where it
// may or may not be one as it enters the wait.
// One of the components of OtherThreadsComplete() has changed, so check whether
// we should now exit the EE.
ThreadStore::CheckForEEShutdown();
}
}
else
{
if (IsBackground())
{
FastInterlockAnd((ULONG *) &m_State, ~TS_Background);
// unstarted threads don't contribute to the background count
if (!IsUnstarted())
ThreadStore::s_pThreadStore->m_BackgroundThreadCount--;
_ASSERTE(ThreadStore::s_pThreadStore->m_BackgroundThreadCount >= 0);
_ASSERTE(ThreadStore::s_pThreadStore->m_BackgroundThreadCount <=
ThreadStore::s_pThreadStore->m_ThreadCount);
}
}
if (bRequiresTSL)
{
TSLockHolder.Release();
}
}
#ifdef FEATURE_COMINTEROP
class ApartmentSpyImpl : public IUnknownCommon<IInitializeSpy>
{
public:
HRESULT STDMETHODCALLTYPE PreInitialize(DWORD dwCoInit, DWORD dwCurThreadAptRefs)
{
LIMITED_METHOD_CONTRACT;
return S_OK;
}
HRESULT STDMETHODCALLTYPE PostInitialize(HRESULT hrCoInit, DWORD dwCoInit, DWORD dwNewThreadAptRefs)
{
LIMITED_METHOD_CONTRACT;
return hrCoInit; // this HRESULT will be returned from CoInitialize(Ex)
}
HRESULT STDMETHODCALLTYPE PreUninitialize(DWORD dwCurThreadAptRefs)
{
// Don't assume that Thread exists and do not create it.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_PREEMPTIVE;
HRESULT hr = S_OK;
if (dwCurThreadAptRefs == 1 && !g_fEEShutDown)
{
// This is the last CoUninitialize on this thread and the CLR is still running. If it's an STA
// we take the opportunity to perform COM/WinRT cleanup now, when the apartment is still alive.
Thread *pThread = GetThreadNULLOk();
if (pThread != NULL)
{
BEGIN_EXTERNAL_ENTRYPOINT(&hr)
{
if (pThread->GetFinalApartment() == Thread::AS_InSTA)
{
// This will release RCWs and purge the WinRT factory cache on all AppDomains. It
// will also synchronize with the finalizer thread which ensures that the RCWs
// that were already in the global RCW cleanup list will be cleaned up as well.
//
ReleaseRCWsInCachesNoThrow(GetCurrentCtxCookie());
}
}
END_EXTERNAL_ENTRYPOINT;
}
}
return hr;
}
HRESULT STDMETHODCALLTYPE PostUninitialize(DWORD dwNewThreadAptRefs)
{
LIMITED_METHOD_CONTRACT;
return S_OK;
}
};
#endif // FEATURE_COMINTEROP
// When the thread starts running, make sure it is running in the correct apartment
// and context.
BOOL Thread::PrepareApartmentAndContext()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
m_OSThreadId = ::GetCurrentThreadId();
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
// Be very careful in here because we haven't set up e.g. TLS yet.
if (m_State & (TS_InSTA | TS_InMTA))
{
// Make sure TS_InSTA and TS_InMTA aren't both set.
_ASSERTE(!((m_State & TS_InSTA) && (m_State & TS_InMTA)));
// Determine the apartment state to set based on the requested state.
ApartmentState aState = m_State & TS_InSTA ? AS_InSTA : AS_InMTA;
// Clear the requested apartment state from the thread. This is requested since
// the thread might actually be a fiber that has already been initialized to
// a different apartment state than the requested one. If we didn't clear
// the requested apartment state, then we could end up with both TS_InSTA and
// TS_InMTA set at the same time.
FastInterlockAnd ((ULONG *) &m_State, ~TS_InSTA & ~TS_InMTA);
// Attempt to set the requested apartment state.
SetApartment(aState, FALSE);
}
// In the case where we own the thread and we have switched it to a different
// starting context, it is the responsibility of the caller (KickOffThread())
// to notice that the context changed, and to adjust the delegate that it will
// dispatch on, as appropriate.
#endif //FEATURE_COMINTEROP_APARTMENT_SUPPORT
#ifdef FEATURE_COMINTEROP
// Our IInitializeSpy will be registered in AppX always, in classic processes
// only if the internal config switch is on.
if (AppX::IsAppXProcess() || g_pConfig->EnableRCWCleanupOnSTAShutdown())
{
NewHolder<ApartmentSpyImpl> pSpyImpl = new ApartmentSpyImpl();
IfFailThrow(CoRegisterInitializeSpy(pSpyImpl, &m_uliInitializeSpyCookie));
pSpyImpl.SuppressRelease();
m_fInitializeSpyRegistered = true;
}
#endif // FEATURE_COMINTEROP
return TRUE;
}
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
// TS_InSTA (0x00004000) -> AS_InSTA (0)
// TS_InMTA (0x00008000) -> AS_InMTA (1)
#define TS_TO_AS(ts) \
(Thread::ApartmentState)((((DWORD)ts) >> 14) - 1) \
// Retrieve the apartment state of the current thread. There are three possible
// states: thread hosts an STA, thread is part of the MTA or thread state is
// undecided. The last state may indicate that the apartment has not been set at
// all (nobody has called CoInitializeEx) or that the EE does not know the
// current state (EE has not called CoInitializeEx).
Thread::ApartmentState Thread::GetApartment()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
ApartmentState as = AS_Unknown;
ThreadState maskedTs = (ThreadState)(((DWORD)m_State) & (TS_InSTA|TS_InMTA));
if (maskedTs)
{
_ASSERTE((maskedTs == TS_InSTA) || (maskedTs == TS_InMTA));
static_assert_no_msg(TS_TO_AS(TS_InSTA) == AS_InSTA);
static_assert_no_msg(TS_TO_AS(TS_InMTA) == AS_InMTA);
as = TS_TO_AS(maskedTs);
}
if (
#ifdef MDA_SUPPORTED
(NULL == MDA_GET_ASSISTANT(InvalidApartmentStateChange)) &&
#endif
(as != AS_Unknown))
{
return as;
}
return GetApartmentRare(as);
}
Thread::ApartmentState Thread::GetApartmentRare(Thread::ApartmentState as)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
if (this == GetThread())
{
THDTYPE type;
HRESULT hr = S_OK;
#ifdef MDA_SUPPORTED
MdaInvalidApartmentStateChange* pProbe = MDA_GET_ASSISTANT(InvalidApartmentStateChange);
if (pProbe)
{
// Without notifications from OLE32, we cannot know when the apartment state of a
// thread changes. But we have cached this fact and depend on it for all our
// blocking and COM Interop behavior to work correctly. Using the CDH, log that it
// is not changing underneath us, on those platforms where it is relatively cheap for
// us to do so.
if (as != AS_Unknown)
{
hr = GetCurrentThreadTypeNT5(&type);
if (hr == S_OK)
{
if (type == THDTYPE_PROCESSMESSAGES && as == AS_InMTA)
{
pProbe->ReportViolation(this, as, FALSE);
}
else if (type == THDTYPE_BLOCKMESSAGES && as == AS_InSTA)
{
pProbe->ReportViolation(this, as, FALSE);
}
}
}
}
#endif
if (as == AS_Unknown)
{
hr = GetCurrentThreadTypeNT5(&type);
if (hr == S_OK)
{
as = (type == THDTYPE_PROCESSMESSAGES) ? AS_InSTA : AS_InMTA;
// If we get back THDTYPE_PROCESSMESSAGES, we are guaranteed to
// be an STA thread. If not, we are an MTA thread, however
// we can't know if the thread has been explicitly set to MTA
// (via a call to CoInitializeEx) or if it has been implicitly
// made MTA (if it hasn't been CoInitializeEx'd but CoInitialize
// has already been called on some other thread in the process.
if (as == AS_InSTA)
FastInterlockOr((ULONG *) &m_State, AS_InSTA);
}
}
}
return as;
}
// Retrieve the explicit apartment state of the current thread. There are three possible
// states: thread hosts an STA, thread is part of the MTA or thread state is
// undecided. The last state may indicate that the apartment has not been set at
// all (nobody has called CoInitializeEx), the EE does not know the
// current state (EE has not called CoInitializeEx), or the thread is implicitly in
// the MTA.
Thread::ApartmentState Thread::GetExplicitApartment()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
_ASSERTE(!((m_State & TS_InSTA) && (m_State & TS_InMTA)));
// Initialize m_State by calling GetApartment.
GetApartment();
ApartmentState as = (m_State & TS_InSTA) ? AS_InSTA :
(m_State & TS_InMTA) ? AS_InMTA :
AS_Unknown;
return as;
}
Thread::ApartmentState Thread::GetFinalApartment()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
SO_TOLERANT;
}
CONTRACTL_END;
_ASSERTE(this == GetThread());
ApartmentState as = AS_Unknown;
if (g_fEEShutDown)
{
// On shutdown, do not use cached value. Someone might have called
// CoUninitialize.
FastInterlockAnd ((ULONG *) &m_State, ~TS_InSTA & ~TS_InMTA);
}
as = GetApartment();
if (as == AS_Unknown)
{
// On Win2k and above, GetApartment will only return AS_Unknown if CoInitialize
// hasn't been called in the process. In that case we can simply assume MTA. However we
// cannot cache this value in the Thread because if a CoInitialize does occur, then the
// thread state might change.
as = AS_InMTA;
}
return as;
}
// when we get apartment tear-down notification,
// we want reset the apartment state we cache on the thread
VOID Thread::ResetApartment()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// reset the TS_InSTA bit and TS_InMTA bit
ThreadState t_State = (ThreadState)(~(TS_InSTA | TS_InMTA));
FastInterlockAnd((ULONG *) &m_State, t_State);
}
// Attempt to set current thread's apartment state. The actual apartment state
// achieved is returned and may differ from the input state if someone managed
// to call CoInitializeEx on this thread first (note that calls to SetApartment
// made before the thread has started are guaranteed to succeed).
// The fFireMDAOnMismatch indicates if we should fire the apartment state probe
// on an apartment state mismatch.
Thread::ApartmentState Thread::SetApartment(ApartmentState state, BOOL fFireMDAOnMismatch)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_ANY;
INJECT_FAULT(COMPlusThrowOM(););
}
CONTRACTL_END;
// Reset any bits that request for CoInitialize
ResetRequiresCoInitialize();
// Setting the state to AS_Unknown indicates we should CoUninitialize
// the thread.
if (state == AS_Unknown)
{
BOOL needUninitialize = (m_State & TS_CoInitialized)
#ifdef FEATURE_COMINTEROP
|| IsWinRTInitialized()
#endif // FEATURE_COMINTEROP
;
if (needUninitialize)
{
GCX_PREEMP();
// If we haven't CoInitialized the thread, then we don't have anything to do.
if (m_State & TS_CoInitialized)
{
// We should never be attempting to CoUninitialize another thread than
// the currently running thread.
_ASSERTE(m_OSThreadId == ::GetCurrentThreadId());
// CoUninitialize the thread and reset the STA/MTA/CoInitialized state bits.
::CoUninitialize();
ThreadState uninitialized = static_cast<ThreadState>(TS_InSTA | TS_InMTA | TS_CoInitialized);
FastInterlockAnd((ULONG *) &m_State, ~uninitialized);
}
#ifdef FEATURE_COMINTEROP
if (IsWinRTInitialized())
{
_ASSERTE(WinRTSupported());
BaseWinRTUninitialize();
ResetWinRTInitialized();
}
#endif // FEATURE_COMINTEROP
}
return GetApartment();
}
// Call GetApartment to initialize the current apartment state.
//
// Important note: For Win2k and above this can return AS_InMTA even if the current
// thread has never been CoInitialized. Because of this we MUST NOT look at the
// return value of GetApartment here. We can however look at the m_State flags
// since these will only be set to TS_InMTA if we know for a fact the the
// current thread has explicitly been made MTA (via a call to CoInitializeEx).
GetApartment();
// If the current thread is STA, then it is impossible to change it to
// MTA.
if (m_State & TS_InSTA)
{
#ifdef MDA_SUPPORTED
if (state == AS_InMTA && fFireMDAOnMismatch)
{
MDA_TRIGGER_ASSISTANT(InvalidApartmentStateChange, ReportViolation(this, state, TRUE));
}
#endif
return AS_InSTA;
}
// If the current thread is EXPLICITLY MTA, then it is impossible to change it to
// STA.
if (m_State & TS_InMTA)
{
#ifdef MDA_SUPPORTED
if (state == AS_InSTA && fFireMDAOnMismatch)
{
MDA_TRIGGER_ASSISTANT(InvalidApartmentStateChange, ReportViolation(this, state, TRUE));
}
#endif
return AS_InMTA;
}
// If the thread isn't even started yet, we mark the state bits without
// calling CoInitializeEx (since we're obviously not in the correct thread
// context yet). We'll retry this call when the thread is started.
// Don't use the TS_Unstarted state bit to check for this, it's cleared far
// too late in the day for us. Instead check whether we're in the correct
// thread context.
if (m_OSThreadId != ::GetCurrentThreadId())
{
FastInterlockOr((ULONG *) &m_State, (state == AS_InSTA) ? TS_InSTA : TS_InMTA);
return state;
}
HRESULT hr;
{
GCX_PREEMP();
// Attempt to set apartment by calling CoInitializeEx. This may fail if
// another caller (outside EE) beat us to it.
//
// Important note: When calling CoInitializeEx(COINIT_MULTITHREADED) on a
// thread that has never been CoInitialized, the return value will always
// be S_OK, even if another thread in the process has already been
// CoInitialized to MTA. However if the current thread has already been
// CoInitialized to MTA, then S_FALSE will be returned.
hr = ::CoInitializeEx(NULL, (state == AS_InSTA) ?
COINIT_APARTMENTTHREADED : COINIT_MULTITHREADED);
}
if (SUCCEEDED(hr))
{
ThreadState t_State = (state == AS_InSTA) ? TS_InSTA : TS_InMTA;
if (hr == S_OK)
{
// The thread has never been CoInitialized.
t_State = (ThreadState)(t_State | TS_CoInitialized);
}
else
{
_ASSERTE(hr == S_FALSE);
// If the thread has already been CoInitialized to the proper mode, then
// we don't want to leave an outstanding CoInit so we CoUninit.
{
GCX_PREEMP();
::CoUninitialize();
}
}
// We succeeded in setting the apartment state to the requested state.
FastInterlockOr((ULONG *) &m_State, t_State);
}
else if (hr == RPC_E_CHANGED_MODE)
{
// We didn't manage to enforce the requested apartment state, but at least
// we can work out what the state is now. No need to actually do the CoInit --
// obviously someone else already took care of that.
FastInterlockOr((ULONG *) &m_State, ((state == AS_InSTA) ? TS_InMTA : TS_InSTA));
#ifdef MDA_SUPPORTED
if (fFireMDAOnMismatch)
{
// Report via the customer debug helper that we failed to set the apartment type
// to the specified type.
MDA_TRIGGER_ASSISTANT(InvalidApartmentStateChange, ReportViolation(this, state, TRUE));
}
#endif
}
else if (hr == E_OUTOFMEMORY)
{
COMPlusThrowOM();
}
else
{
_ASSERTE(!"Unexpected HRESULT returned from CoInitializeEx!");
}
#ifdef FEATURE_COMINTEROP
// If WinRT is supported on this OS, also initialize it at the same time. Since WinRT sits on top of COM
// we need to make sure that it is initialized in the same threading mode as we just started COM itself
// with (or that we detected COM had already been started with).
if (WinRTSupported() && !IsWinRTInitialized())
{
GCX_PREEMP();
BOOL isSTA = m_State & TS_InSTA;
_ASSERTE(isSTA || (m_State & TS_InMTA));
HRESULT hrWinRT = RoInitialize(isSTA ? RO_INIT_SINGLETHREADED : RO_INIT_MULTITHREADED);
if (SUCCEEDED(hrWinRT))
{
if (hrWinRT == S_OK)
{
SetThreadStateNC(TSNC_WinRTInitialized);
}
else
{
_ASSERTE(hrWinRT == S_FALSE);
// If the thread has already been initialized, back it out. We may not
// always be able to call RoUninitialize on shutdown so if there's
// a way to avoid having to, we should take advantage of that.
RoUninitialize();
}
}
else if (hrWinRT == E_OUTOFMEMORY)
{
COMPlusThrowOM();
}
else
{
// We don't check for RPC_E_CHANGEDMODE, since we're using the mode that was read in by
// initializing COM above. COM and WinRT need to always be in the same mode, so we should never
// see that return code at this point.
_ASSERTE(!"Unexpected HRESULT From RoInitialize");
}
}
// Since we've just called CoInitialize, COM has effectively been started up.
// To ensure the CLR is aware of this, we need to call EnsureComStarted.
EnsureComStarted(FALSE);
#endif // FEATURE_COMINTEROP
return GetApartment();
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
//----------------------------------------------------------------------------
//
// ThreadStore Implementation
//
//----------------------------------------------------------------------------
ThreadStore::ThreadStore()
: m_Crst(CrstThreadStore, (CrstFlags) (CRST_UNSAFE_ANYMODE | CRST_DEBUGGER_THREAD)),
m_ThreadCount(0),
m_MaxThreadCount(0),
m_UnstartedThreadCount(0),
m_BackgroundThreadCount(0),
m_PendingThreadCount(0),
m_DeadThreadCount(0),
m_DeadThreadCountForGCTrigger(0),
m_TriggerGCForDeadThreads(false),
m_GuidCreated(FALSE),
m_HoldingThread(0)
{
CONTRACTL {
THROWS;
GC_NOTRIGGER;
}
CONTRACTL_END;
m_TerminationEvent.CreateManualEvent(FALSE);
_ASSERTE(m_TerminationEvent.IsValid());
}
void ThreadStore::InitThreadStore()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
s_pThreadStore = new ThreadStore;
g_pThinLockThreadIdDispenser = new IdDispenser();
ThreadSuspend::g_pGCSuspendEvent = new CLREvent();
ThreadSuspend::g_pGCSuspendEvent->CreateManualEvent(FALSE);
#ifdef _DEBUG
Thread::MaxThreadRecord = EEConfig::GetConfigDWORD_DontUse_(CLRConfig::INTERNAL_MaxThreadRecord,Thread::MaxThreadRecord);
Thread::MaxStackDepth = EEConfig::GetConfigDWORD_DontUse_(CLRConfig::INTERNAL_MaxStackDepth,Thread::MaxStackDepth);
if (Thread::MaxStackDepth > 100) {
Thread::MaxStackDepth = 100;
}
#endif
s_pWaitForStackCrawlEvent = new CLREvent();
s_pWaitForStackCrawlEvent->CreateManualEvent(FALSE);
s_DeadThreadCountThresholdForGCTrigger =
static_cast<LONG>(CLRConfig::GetConfigValue(CLRConfig::INTERNAL_Thread_DeadThreadCountThresholdForGCTrigger));
if (s_DeadThreadCountThresholdForGCTrigger < 0)
{
s_DeadThreadCountThresholdForGCTrigger = 0;
}
s_DeadThreadGCTriggerPeriodMilliseconds =
CLRConfig::GetConfigValue(CLRConfig::INTERNAL_Thread_DeadThreadGCTriggerPeriodMilliseconds);
s_DeadThreadGenerationCounts = nullptr;
}
// Enter and leave the critical section around the thread store. Clients should
// use LockThreadStore and UnlockThreadStore because ThreadStore lock has
// additional semantics well beyond a normal lock.
DEBUG_NOINLINE void ThreadStore::Enter()
{
WRAPPER_NO_CONTRACT;
ANNOTATION_SPECIAL_HOLDER_CALLER_NEEDS_DYNAMIC_CONTRACT;
CHECK_ONE_STORE();
m_Crst.Enter();
// Threadstore needs special shutdown handling.
if (g_fSuspendOnShutdown)
{
m_Crst.ReleaseAndBlockForShutdownIfNotSpecialThread();
}
}
DEBUG_NOINLINE void ThreadStore::Leave()
{
WRAPPER_NO_CONTRACT;
ANNOTATION_SPECIAL_HOLDER_CALLER_NEEDS_DYNAMIC_CONTRACT;
CHECK_ONE_STORE();
m_Crst.Leave();
}
void ThreadStore::LockThreadStore()
{
WRAPPER_NO_CONTRACT;
// The actual implementation is in ThreadSuspend class since it is coupled
// with thread suspension logic
ThreadSuspend::LockThreadStore(ThreadSuspend::SUSPEND_OTHER);
}
void ThreadStore::UnlockThreadStore()
{
WRAPPER_NO_CONTRACT;
// The actual implementation is in ThreadSuspend class since it is coupled
// with thread suspension logic
ThreadSuspend::UnlockThreadStore(FALSE, ThreadSuspend::SUSPEND_OTHER);
}
// AddThread adds 'newThread' to m_ThreadList
void ThreadStore::AddThread(Thread *newThread, BOOL bRequiresTSL)
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
LOG((LF_SYNC, INFO3, "AddThread obtain lock\n"));
ThreadStoreLockHolder TSLockHolder(FALSE);
if (bRequiresTSL)
{
TSLockHolder.Acquire();
}
s_pThreadStore->m_ThreadList.InsertTail(newThread);
s_pThreadStore->m_ThreadCount++;
if (s_pThreadStore->m_MaxThreadCount < s_pThreadStore->m_ThreadCount)
s_pThreadStore->m_MaxThreadCount = s_pThreadStore->m_ThreadCount;
if (newThread->IsUnstarted())
s_pThreadStore->m_UnstartedThreadCount++;
newThread->SetThreadStateNC(Thread::TSNC_ExistInThreadStore);
_ASSERTE(!newThread->IsBackground());
_ASSERTE(!newThread->IsDead());
if (bRequiresTSL)
{
TSLockHolder.Release();
}
}
// this function is just desgined to avoid deadlocks during abnormal process termination, and should not be used for any other purpose
BOOL ThreadStore::CanAcquireLock()
{
WRAPPER_NO_CONTRACT;
{
return (s_pThreadStore->m_Crst.m_criticalsection.LockCount == -1 || (size_t)s_pThreadStore->m_Crst.m_criticalsection.OwningThread == (size_t)GetCurrentThreadId());
}
}
// Whenever one of the components of OtherThreadsComplete() has changed in the
// correct direction, see whether we can now shutdown the EE because only background
// threads are running.
void ThreadStore::CheckForEEShutdown()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
if (g_fWeControlLifetime &&
s_pThreadStore->OtherThreadsComplete())
{
BOOL bRet;
bRet = s_pThreadStore->m_TerminationEvent.Set();
_ASSERTE(bRet);
}
}
BOOL ThreadStore::RemoveThread(Thread *target)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
BOOL found;
Thread *ret;
#if 0 // This assert is not valid when failing to create background GC thread.
// Main GC thread holds the TS lock.
_ASSERTE (ThreadStore::HoldingThreadStore());
#endif
_ASSERTE(s_pThreadStore->m_Crst.GetEnterCount() > 0 ||
IsAtProcessExit());
_ASSERTE(s_pThreadStore->DbgFindThread(target));
ret = s_pThreadStore->m_ThreadList.FindAndRemove(target);
_ASSERTE(ret && ret == target);
found = (ret != NULL);
if (found)
{
target->ResetThreadStateNC(Thread::TSNC_ExistInThreadStore);
s_pThreadStore->m_ThreadCount--;
if (target->IsDead())
{
s_pThreadStore->m_DeadThreadCount--;
s_pThreadStore->DecrementDeadThreadCountForGCTrigger();
}
// Unstarted threads are not in the Background count:
if (target->IsUnstarted())
s_pThreadStore->m_UnstartedThreadCount--;
else
if (target->IsBackground())
s_pThreadStore->m_BackgroundThreadCount--;
FastInterlockExchangeAdd(
&Thread::s_threadPoolCompletionCountOverflow,
target->m_threadPoolCompletionCount);
_ASSERTE(s_pThreadStore->m_ThreadCount >= 0);
_ASSERTE(s_pThreadStore->m_BackgroundThreadCount >= 0);
_ASSERTE(s_pThreadStore->m_ThreadCount >=
s_pThreadStore->m_BackgroundThreadCount);
_ASSERTE(s_pThreadStore->m_ThreadCount >=
s_pThreadStore->m_UnstartedThreadCount);
_ASSERTE(s_pThreadStore->m_ThreadCount >=
s_pThreadStore->m_DeadThreadCount);
// One of the components of OtherThreadsComplete() has changed, so check whether
// we should now exit the EE.
CheckForEEShutdown();
}
return found;
}
// When a thread is created as unstarted. Later it may get started, in which case
// someone calls Thread::HasStarted() on that physical thread. This completes
// the Setup and calls here.
void ThreadStore::TransferStartedThread(Thread *thread, BOOL bRequiresTSL)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
_ASSERTE(GetThread() == thread);
LOG((LF_SYNC, INFO3, "TransferUnstartedThread obtain lock\n"));
ThreadStoreLockHolder TSLockHolder(FALSE);
if (bRequiresTSL)
{
TSLockHolder.Acquire();
}
_ASSERTE(s_pThreadStore->DbgFindThread(thread));
_ASSERTE(thread->HasValidThreadHandle());
_ASSERTE(thread->m_State & Thread::TS_WeOwn);
_ASSERTE(thread->IsUnstarted());
_ASSERTE(!thread->IsDead());
if (thread->m_State & Thread::TS_AbortRequested)
{
PAL_CPP_THROW(EEException *, new EEException(COR_E_THREADABORTED));
}
// Of course, m_ThreadCount is already correct since it includes started and
// unstarted threads.
s_pThreadStore->m_UnstartedThreadCount--;
// We only count background threads that have been started
if (thread->IsBackground())
s_pThreadStore->m_BackgroundThreadCount++;
_ASSERTE(s_pThreadStore->m_PendingThreadCount > 0);
FastInterlockDecrement(&s_pThreadStore->m_PendingThreadCount);
// As soon as we erase this bit, the thread becomes eligible for suspension,
// stopping, interruption, etc.
FastInterlockAnd((ULONG *) &thread->m_State, ~Thread::TS_Unstarted);
FastInterlockOr((ULONG *) &thread->m_State, Thread::TS_LegalToJoin);
// release ThreadStore Crst to avoid Crst Violation when calling HandleThreadAbort later
if (bRequiresTSL)
{
TSLockHolder.Release();
}
// One of the components of OtherThreadsComplete() has changed, so check whether
// we should now exit the EE.
CheckForEEShutdown();
}
LONG ThreadStore::s_DeadThreadCountThresholdForGCTrigger = 0;
DWORD ThreadStore::s_DeadThreadGCTriggerPeriodMilliseconds = 0;
SIZE_T *ThreadStore::s_DeadThreadGenerationCounts = nullptr;
void ThreadStore::IncrementDeadThreadCountForGCTrigger()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// Although all increments and decrements are usually done inside a lock, that is not sufficient to synchronize with a
// background GC thread resetting this value, hence the interlocked operation. Ignore overflow; overflow would likely never
// occur, the count is treated as unsigned, and nothing bad would happen if it were to overflow.
SIZE_T count = static_cast<SIZE_T>(FastInterlockIncrement(&m_DeadThreadCountForGCTrigger));
SIZE_T countThreshold = static_cast<SIZE_T>(s_DeadThreadCountThresholdForGCTrigger);
if (count < countThreshold || countThreshold == 0)
{
return;
}
IGCHeap *gcHeap = GCHeapUtilities::GetGCHeap();
if (gcHeap == nullptr)
{
return;
}
SIZE_T gcLastMilliseconds = gcHeap->GetLastGCStartTime(gcHeap->GetMaxGeneration());
SIZE_T gcNowMilliseconds = gcHeap->GetNow();
if (gcNowMilliseconds - gcLastMilliseconds < s_DeadThreadGCTriggerPeriodMilliseconds)
{
return;
}
if (!g_fEEStarted) // required for FinalizerThread::EnableFinalization() below
{
return;
}
// The GC is triggered on the finalizer thread since it's not safe to trigger it on DLL_THREAD_DETACH.
// TriggerGCForDeadThreadsIfNecessary() will determine which generation of GC to trigger, and may not actually trigger a GC.
// If a GC is triggered, since there would be a delay before the dead thread count is updated, clear the count and wait for
// it to reach the threshold again. If a GC would not be triggered, the count is still cleared here to prevent waking up the
// finalizer thread to do the work in TriggerGCForDeadThreadsIfNecessary() for every dead thread.
m_DeadThreadCountForGCTrigger = 0;
m_TriggerGCForDeadThreads = true;
FinalizerThread::EnableFinalization();
}
void ThreadStore::DecrementDeadThreadCountForGCTrigger()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// Although all increments and decrements are usually done inside a lock, that is not sufficient to synchronize with a
// background GC thread resetting this value, hence the interlocked operation.
if (FastInterlockDecrement(&m_DeadThreadCountForGCTrigger) < 0)
{
m_DeadThreadCountForGCTrigger = 0;
}
}
void ThreadStore::OnMaxGenerationGCStarted()
{
LIMITED_METHOD_CONTRACT;
// A dead thread may contribute to triggering a GC at most once. After a max-generation GC occurs, if some dead thread
// objects are still reachable due to references to the thread objects, they will not contribute to triggering a GC again.
// Synchronize the store with increment/decrement operations occurring on different threads, and make the change visible to
// other threads in order to prevent unnecessary GC triggers.
FastInterlockExchange(&m_DeadThreadCountForGCTrigger, 0);
}
bool ThreadStore::ShouldTriggerGCForDeadThreads()
{
LIMITED_METHOD_CONTRACT;
return m_TriggerGCForDeadThreads;
}
void ThreadStore::TriggerGCForDeadThreadsIfNecessary()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
if (!m_TriggerGCForDeadThreads)
{
return;
}
m_TriggerGCForDeadThreads = false;
if (g_fEEShutDown)
{
// Not safe to touch CLR state
return;
}
unsigned gcGenerationToTrigger = 0;
IGCHeap *gcHeap = GCHeapUtilities::GetGCHeap();
_ASSERTE(gcHeap != nullptr);
SIZE_T generationCountThreshold = static_cast<SIZE_T>(s_DeadThreadCountThresholdForGCTrigger) / 2;
unsigned maxGeneration = gcHeap->GetMaxGeneration();
if (!s_DeadThreadGenerationCounts)
{
// initialize this field on first use with an entry for every table.
s_DeadThreadGenerationCounts = new (nothrow) SIZE_T[maxGeneration + 1];
if (!s_DeadThreadGenerationCounts)
{
return;
}
}
memset(s_DeadThreadGenerationCounts, 0, sizeof(SIZE_T) * (maxGeneration + 1));
{
ThreadStoreLockHolder threadStoreLockHolder;
GCX_COOP();
// Determine the generation for which to trigger a GC. Iterate over all dead threads that have not yet been considered
// for triggering a GC and see how many are in which generations.
for (Thread *thread = ThreadStore::GetAllThreadList(NULL, Thread::TS_Dead, Thread::TS_Dead);
thread != nullptr;
thread = ThreadStore::GetAllThreadList(thread, Thread::TS_Dead, Thread::TS_Dead))
{
if (thread->HasDeadThreadBeenConsideredForGCTrigger())
{
continue;
}
Object *exposedObject = OBJECTREFToObject(thread->GetExposedObjectRaw());
if (exposedObject == nullptr)
{
continue;
}
unsigned exposedObjectGeneration = gcHeap->WhichGeneration(exposedObject);
SIZE_T newDeadThreadGenerationCount = ++s_DeadThreadGenerationCounts[exposedObjectGeneration];
if (exposedObjectGeneration > gcGenerationToTrigger && newDeadThreadGenerationCount >= generationCountThreshold)
{
gcGenerationToTrigger = exposedObjectGeneration;
if (gcGenerationToTrigger >= maxGeneration)
{
break;
}
}
}
// Make sure that enough time has elapsed since the last GC of the desired generation. We don't want to trigger GCs
// based on this heuristic too often. Give it some time to let the memory pressure trigger GCs automatically, and only
// if it doesn't in the given time, this heuristic may kick in to trigger a GC.
SIZE_T gcLastMilliseconds = gcHeap->GetLastGCStartTime(gcGenerationToTrigger);
SIZE_T gcNowMilliseconds = gcHeap->GetNow();
if (gcNowMilliseconds - gcLastMilliseconds < s_DeadThreadGCTriggerPeriodMilliseconds)
{
return;
}
// For threads whose exposed objects are in the generation of GC that will be triggered or in a lower GC generation,
// mark them as having contributed to a GC trigger to prevent redundant GC triggers
for (Thread *thread = ThreadStore::GetAllThreadList(NULL, Thread::TS_Dead, Thread::TS_Dead);
thread != nullptr;
thread = ThreadStore::GetAllThreadList(thread, Thread::TS_Dead, Thread::TS_Dead))
{
if (thread->HasDeadThreadBeenConsideredForGCTrigger())
{
continue;
}
Object *exposedObject = OBJECTREFToObject(thread->GetExposedObjectRaw());
if (exposedObject == nullptr)
{
continue;
}
if (gcGenerationToTrigger < maxGeneration &&
gcHeap->WhichGeneration(exposedObject) > gcGenerationToTrigger)
{
continue;
}
thread->SetHasDeadThreadBeenConsideredForGCTrigger();
}
} // ThreadStoreLockHolder, GCX_COOP()
GCHeapUtilities::GetGCHeap()->GarbageCollect(gcGenerationToTrigger, FALSE, collection_non_blocking);
}
#endif // #ifndef DACCESS_COMPILE
// Access the list of threads. You must be inside a critical section, otherwise
// the "cursor" thread might disappear underneath you. Pass in NULL for the
// cursor to begin at the start of the list.
Thread *ThreadStore::GetAllThreadList(Thread *cursor, ULONG mask, ULONG bits)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
SUPPORTS_DAC;
#ifndef DACCESS_COMPILE
_ASSERTE((s_pThreadStore->m_Crst.GetEnterCount() > 0) || IsAtProcessExit());
#endif
while (TRUE)
{
cursor = (cursor
? s_pThreadStore->m_ThreadList.GetNext(cursor)
: s_pThreadStore->m_ThreadList.GetHead());
if (cursor == NULL)
break;
if ((cursor->m_State & mask) == bits)
return cursor;
}
return NULL;
}
// Iterate over the threads that have been started
Thread *ThreadStore::GetThreadList(Thread *cursor)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
SUPPORTS_DAC;
return GetAllThreadList(cursor, (Thread::TS_Unstarted | Thread::TS_Dead), 0);
}
//---------------------------------------------------------------------------------------
//
// Grab a consistent snapshot of the thread's state, for reporting purposes only.
//
// Return Value:
// the current state of the thread
//
Thread::ThreadState Thread::GetSnapshotState()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
SUPPORTS_DAC;
}
CONTRACTL_END;
ThreadState res = m_State;
if (res & TS_ReportDead)
{
res = (ThreadState) (res | TS_Dead);
}
return res;
}
#ifndef DACCESS_COMPILE
BOOL CLREventWaitWithTry(CLREventBase *pEvent, DWORD timeout, BOOL fAlertable, DWORD *pStatus)
{
CONTRACTL
{
NOTHROW;
WRAPPER(GC_TRIGGERS);
}
CONTRACTL_END;
BOOL fLoop = TRUE;
EX_TRY
{
*pStatus = pEvent->Wait(timeout, fAlertable);
fLoop = FALSE;
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions);
return fLoop;
}
// We shut down the EE only when all the non-background threads have terminated
// (unless this is an exceptional termination). So the main thread calls here to
// wait before tearing down the EE.
void ThreadStore::WaitForOtherThreads()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
CHECK_ONE_STORE();
Thread *pCurThread = GetThread();
// Regardless of whether the main thread is a background thread or not, force
// it to be one. This simplifies our rules for counting non-background threads.
pCurThread->SetBackground(TRUE);
LOG((LF_SYNC, INFO3, "WaitForOtherThreads obtain lock\n"));
ThreadStoreLockHolder TSLockHolder(TRUE);
if (!OtherThreadsComplete())
{
TSLockHolder.Release();
FastInterlockOr((ULONG *) &pCurThread->m_State, Thread::TS_ReportDead);
DWORD ret = WAIT_OBJECT_0;
while (CLREventWaitWithTry(&m_TerminationEvent, INFINITE, TRUE, &ret))
{
}
_ASSERTE(ret == WAIT_OBJECT_0);
}
}
// Every EE process can lazily create a GUID that uniquely identifies it (for
// purposes of remoting).
const GUID &ThreadStore::GetUniqueEEId()
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
if (!m_GuidCreated)
{
ThreadStoreLockHolder TSLockHolder(TRUE);
if (!m_GuidCreated)
{
HRESULT hr = ::CoCreateGuid(&m_EEGuid);
_ASSERTE(SUCCEEDED(hr));
if (SUCCEEDED(hr))
m_GuidCreated = TRUE;
}
if (!m_GuidCreated)
return IID_NULL;
}
return m_EEGuid;
}
#ifdef _DEBUG
BOOL ThreadStore::DbgFindThread(Thread *target)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
CHECK_ONE_STORE();
// Cache the current change stamp for g_TrapReturningThreads
LONG chgStamp = g_trtChgStamp;
STRESS_LOG3(LF_STORE, LL_INFO100, "ThreadStore::DbgFindThread - [thread=%p]. trt=%d. chgStamp=%d\n", GetThread(), g_TrapReturningThreads.Load(), chgStamp);
#if 0 // g_TrapReturningThreads debug code.
int iRetry = 0;
Retry:
#endif // g_TrapReturningThreads debug code.
BOOL found = FALSE;
Thread *cur = NULL;
LONG cnt = 0;
LONG cntBack = 0;
LONG cntUnstart = 0;
LONG cntDead = 0;
LONG cntReturn = 0;
while ((cur = GetAllThreadList(cur, 0, 0)) != NULL)
{
cnt++;
if (cur->IsDead())
cntDead++;
// Unstarted threads do not contribute to the count of background threads
if (cur->IsUnstarted())
cntUnstart++;
else
if (cur->IsBackground())
cntBack++;
if (cur == target)
found = TRUE;
// Note that (DebugSuspendPending | SuspendPending) implies a count of 2.
// We don't count GCPending because a single trap is held for the entire
// GC, instead of counting each interesting thread.
if (cur->m_State & Thread::TS_DebugSuspendPending)
cntReturn++;
// CoreCLR does not support user-requested thread suspension
_ASSERTE(!(cur->m_State & Thread::TS_UserSuspendPending));
if (cur->m_TraceCallCount > 0)
cntReturn++;
if (cur->IsAbortRequested())
cntReturn++;
}
_ASSERTE(cnt == m_ThreadCount);
_ASSERTE(cntUnstart == m_UnstartedThreadCount);
_ASSERTE(cntBack == m_BackgroundThreadCount);
_ASSERTE(cntDead == m_DeadThreadCount);
_ASSERTE(0 <= m_PendingThreadCount);
#if 0 // g_TrapReturningThreads debug code.
if (cntReturn != g_TrapReturningThreads /*&& !g_fEEShutDown*/)
{ // If count is off, try again, to account for multiple threads.
if (iRetry < 4)
{
// printf("Retry %d. cntReturn:%d, gReturn:%d\n", iRetry, cntReturn, g_TrapReturningThreads);
++iRetry;
goto Retry;
}
printf("cnt:%d, Un:%d, Back:%d, Dead:%d, cntReturn:%d, TrapReturn:%d, eeShutdown:%d, threadShutdown:%d\n",
cnt,cntUnstart,cntBack,cntDead,cntReturn,g_TrapReturningThreads, g_fEEShutDown, Thread::IsAtProcessExit());
LOG((LF_CORDB, LL_INFO1000,
"SUSPEND: cnt:%d, Un:%d, Back:%d, Dead:%d, cntReturn:%d, TrapReturn:%d, eeShutdown:%d, threadShutdown:%d\n",
cnt,cntUnstart,cntBack,cntDead,cntReturn,g_TrapReturningThreads, g_fEEShutDown, Thread::IsAtProcessExit()) );
//_ASSERTE(cntReturn + 2 >= g_TrapReturningThreads);
}
if (iRetry > 0 && iRetry < 4)
{
printf("%d retries to re-sync counted TrapReturn with global TrapReturn.\n", iRetry);
}
#endif // g_TrapReturningThreads debug code.
STRESS_LOG4(LF_STORE, LL_INFO100, "ThreadStore::DbgFindThread - [thread=%p]. trt=%d. chg=%d. cnt=%d\n", GetThread(), g_TrapReturningThreads.Load(), g_trtChgStamp.Load(), cntReturn);
// Because of race conditions and the fact that the GC places its
// own count, I can't assert this precisely. But I do want to be
// sure that this count isn't wandering ever higher -- with a
// nasty impact on the performance of GC mode changes and method
// call chaining!
//
// We don't bother asserting this during process exit, because
// during a shutdown we will quietly terminate threads that are
// being waited on. (If we aren't shutting down, we carefully
// decrement our counts and alert anyone waiting for us to
// return).
//
// Note: we don't actually assert this if
// ThreadStore::TrapReturningThreads() updated g_TrapReturningThreads
// between the beginning of this function and the moment of the assert.
// *** The order of evaluation in the if condition is important ***
_ASSERTE(
(g_trtChgInFlight != 0 || (cntReturn + 2 >= g_TrapReturningThreads) || chgStamp != g_trtChgStamp) ||
g_fEEShutDown);
return found;
}
#endif // _DEBUG
void Thread::HandleThreadInterrupt (BOOL fWaitForADUnload)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_SO_TOLERANT;
// If we're waiting for shutdown, we don't want to abort/interrupt this thread
if (HasThreadStateNC(Thread::TSNC_BlockedForShutdown))
return;
BEGIN_SO_INTOLERANT_CODE(this);
if ((m_UserInterrupt & TI_Abort) != 0)
{
// If the thread is waiting for AD unload to finish, and the thread is interrupted,
// we can start aborting.
HandleThreadAbort(fWaitForADUnload);
}
if ((m_UserInterrupt & TI_Interrupt) != 0)
{
ResetThreadState ((ThreadState)(TS_Interrupted | TS_Interruptible));
FastInterlockAnd ((DWORD*)&m_UserInterrupt, ~TI_Interrupt);
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Abort);
#endif
COMPlusThrow(kThreadInterruptedException);
}
END_SO_INTOLERANT_CODE;
}
#ifdef _DEBUG
#define MAXSTACKBYTES (2 * GetOsPageSize())
void CleanStackForFastGCStress ()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
PVOID StackLimit = ClrTeb::GetStackLimit();
size_t nBytes = (size_t)&nBytes - (size_t)StackLimit;
nBytes &= ~sizeof (size_t);
if (nBytes > MAXSTACKBYTES) {
nBytes = MAXSTACKBYTES;
}
size_t* buffer = (size_t*) _alloca (nBytes);
memset(buffer, 0, nBytes);
GetThread()->m_pCleanedStackBase = &nBytes;
}
void Thread::ObjectRefFlush(Thread* thread)
{
BEGIN_PRESERVE_LAST_ERROR;
// The constructor and destructor of AutoCleanupSONotMainlineHolder (allocated by SO_NOT_MAINLINE_FUNCTION below)
// may trash the last error, so we need to save and restore last error here. Also, we need to add a scope here
// because we can't let the destructor run after we call SetLastError().
{
// this is debug only code, so no need to validate
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_ENTRY_POINT;
_ASSERTE(thread->PreemptiveGCDisabled()); // Should have been in managed code
memset(thread->dangerousObjRefs, 0, sizeof(thread->dangerousObjRefs));
thread->m_allObjRefEntriesBad = FALSE;
CLEANSTACKFORFASTGCSTRESS ();
}
END_PRESERVE_LAST_ERROR;
}
#endif
#if defined(STRESS_HEAP)
PtrHashMap *g_pUniqueStackMap = NULL;
Crst *g_pUniqueStackCrst = NULL;
#define UniqueStackDepth 8
BOOL StackCompare (UPTR val1, UPTR val2)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
size_t *p1 = (size_t *)(val1 << 1);
size_t *p2 = (size_t *)val2;
if (p1[0] != p2[0]) {
return FALSE;
}
size_t nElem = p1[0];
if (nElem >= UniqueStackDepth) {
nElem = UniqueStackDepth;
}
p1 ++;
p2 ++;
for (size_t n = 0; n < nElem; n ++) {
if (p1[n] != p2[n]) {
return FALSE;
}
}
return TRUE;
}
void UniqueStackSetupMap()
{
WRAPPER_NO_CONTRACT;
if (g_pUniqueStackCrst == NULL)
{
Crst *Attempt = new Crst (
CrstUniqueStack,
CrstFlags(CRST_REENTRANCY | CRST_UNSAFE_ANYMODE));
if (FastInterlockCompareExchangePointer(&g_pUniqueStackCrst,
Attempt,
NULL) != NULL)
{
// We lost the race
delete Attempt;
}
}
// Now we have a Crst we can use to synchronize the remainder of the init.
if (g_pUniqueStackMap == NULL)
{
CrstHolder ch(g_pUniqueStackCrst);
if (g_pUniqueStackMap == NULL)
{
PtrHashMap *map = new (SystemDomain::GetGlobalLoaderAllocator()->GetLowFrequencyHeap()) PtrHashMap ();
LockOwner lock = {g_pUniqueStackCrst, IsOwnerOfCrst};
map->Init (256, StackCompare, TRUE, &lock);
g_pUniqueStackMap = map;
}
}
}
BOOL StartUniqueStackMapHelper()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
BOOL fOK = TRUE;
EX_TRY
{
if (g_pUniqueStackMap == NULL)
{
UniqueStackSetupMap();
}
}
EX_CATCH
{
fOK = FALSE;
}
EX_END_CATCH(SwallowAllExceptions);
return fOK;
}
BOOL StartUniqueStackMap ()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
return StartUniqueStackMapHelper();
}
#ifndef FEATURE_PAL
size_t UpdateStackHash(size_t hash, size_t retAddr)
{
return ((hash << 3) + hash) ^ retAddr;
}
/***********************************************************************/
size_t getStackHash(size_t* stackTrace, size_t* stackTop, size_t* stackStop, size_t stackBase, size_t stackLimit)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// return a hash of every return address found between 'stackTop' (the lowest address)
// and 'stackStop' (the highest address)
size_t hash = 0;
int idx = 0;
#ifdef _TARGET_X86_
static size_t moduleBase = (size_t) -1;
static size_t moduleTop = (size_t) -1;
if (moduleTop == (size_t) -1)
{
MEMORY_BASIC_INFORMATION mbi;
if (ClrVirtualQuery(getStackHash, &mbi, sizeof(mbi)))
{
moduleBase = (size_t)mbi.AllocationBase;
moduleTop = (size_t)mbi.BaseAddress + mbi.RegionSize;
}
else
{
// way bad error, probably just assert and exit
_ASSERTE (!"ClrVirtualQuery failed");
moduleBase = 0;
moduleTop = 0;
}
}
while (stackTop < stackStop)
{
// Clean out things that point to stack, as those can't be return addresses
if (*stackTop > moduleBase && *stackTop < moduleTop)
{
TADDR dummy;
if (isRetAddr((TADDR)*stackTop, &dummy))
{
hash = UpdateStackHash(hash, *stackTop);
// If there is no jitted code on the stack, then just use the
// top 16 frames as the context.
idx++;
if (idx <= UniqueStackDepth)
{
stackTrace [idx] = *stackTop;
}
}
}
stackTop++;
}
#else // _TARGET_X86_
CONTEXT ctx;
ClrCaptureContext(&ctx);
UINT_PTR uControlPc = (UINT_PTR)GetIP(&ctx);
UINT_PTR uImageBase;
UINT_PTR uPrevControlPc = uControlPc;
for (;;)
{
RtlLookupFunctionEntry(uControlPc,
ARM_ONLY((DWORD*))(&uImageBase),
NULL
);
if (((UINT_PTR)g_pMSCorEE) != uImageBase)
{
break;
}
uControlPc = Thread::VirtualUnwindCallFrame(&ctx);
UINT_PTR uRetAddrForHash = uControlPc;
if (uPrevControlPc == uControlPc)
{
// This is a special case when we fail to acquire the loader lock
// in RtlLookupFunctionEntry(), which then returns false. The end
// result is that we cannot go any further on the stack and
// we will loop infinitely (because the owner of the loader lock
// is blocked on us).
hash = 0;
break;
}
else
{
uPrevControlPc = uControlPc;
}
hash = UpdateStackHash(hash, uRetAddrForHash);
// If there is no jitted code on the stack, then just use the
// top 16 frames as the context.
idx++;
if (idx <= UniqueStackDepth)
{
stackTrace [idx] = uRetAddrForHash;
}
}
#endif // _TARGET_X86_
stackTrace [0] = idx;
return(hash);
}
void UniqueStackHelper(size_t stackTraceHash, size_t *stackTrace)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
EX_TRY {
size_t nElem = stackTrace[0];
if (nElem >= UniqueStackDepth) {
nElem = UniqueStackDepth;
}
AllocMemHolder<size_t> stackTraceInMap = SystemDomain::GetGlobalLoaderAllocator()->GetLowFrequencyHeap()->AllocMem(S_SIZE_T(sizeof(size_t *)) * (S_SIZE_T(nElem) + S_SIZE_T(1)));
memcpy (stackTraceInMap, stackTrace, sizeof(size_t *) * (nElem + 1));
g_pUniqueStackMap->InsertValue(stackTraceHash, stackTraceInMap);
stackTraceInMap.SuppressRelease();
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions);
}
/***********************************************************************/
/* returns true if this stack has not been seen before, useful for
running tests only once per stack trace. */
BOOL Thread::UniqueStack(void* stackStart)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_NOT_MAINLINE;
}
CONTRACTL_END;
// If we where not told where to start, start at the caller of UniqueStack
if (stackStart == 0)
{
stackStart = &stackStart;
}
if (g_pUniqueStackMap == NULL)
{
if (!StartUniqueStackMap ())
{
// We fail to initialize unique stack map due to OOM.
// Let's say the stack is unique.
return TRUE;
}
}
size_t stackTrace[UniqueStackDepth+1] = {0};
// stackTraceHash represents a hash of entire stack at the time we make the call,
// We insure at least GC per unique stackTrace. What information is contained in
// 'stackTrace' is somewhat arbitrary. We choose it to mean all functions live
// on the stack up to the first jitted function.
size_t stackTraceHash;
Thread* pThread = GetThread();
void* stopPoint = pThread->m_CacheStackBase;
#ifdef _TARGET_X86_
// Find the stop point (most jitted function)
Frame* pFrame = pThread->GetFrame();
for(;;)
{
// skip GC frames
if (pFrame == 0 || pFrame == (Frame*) -1)
break;
pFrame->GetFunction(); // This insures that helper frames are inited
if (pFrame->GetReturnAddress() != 0)
{
stopPoint = pFrame;
break;
}
pFrame = pFrame->Next();
}
#endif // _TARGET_X86_
// Get hash of all return addresses between here an the top most jitted function
stackTraceHash = getStackHash (stackTrace, (size_t*) stackStart, (size_t*) stopPoint,
size_t(pThread->m_CacheStackBase), size_t(pThread->m_CacheStackLimit));
if (stackTraceHash == 0 ||
g_pUniqueStackMap->LookupValue (stackTraceHash, stackTrace) != (LPVOID)INVALIDENTRY)
{
return FALSE;
}
BOOL fUnique = FALSE;
{
CrstHolder ch(g_pUniqueStackCrst);
#ifdef _DEBUG
if (GetThread ())
GetThread ()->m_bUniqueStacking = TRUE;
#endif
if (g_pUniqueStackMap->LookupValue (stackTraceHash, stackTrace) != (LPVOID)INVALIDENTRY)
{
fUnique = FALSE;
}
else
{
fUnique = TRUE;
FAULT_NOT_FATAL();
UniqueStackHelper(stackTraceHash, stackTrace);
}
#ifdef _DEBUG
if (GetThread ())
GetThread ()->m_bUniqueStacking = FALSE;
#endif
}
#ifdef _DEBUG
static int fCheckStack = -1;
if (fCheckStack == -1)
{
fCheckStack = CLRConfig::GetConfigValue(CLRConfig::INTERNAL_FastGCCheckStack);
}
if (fCheckStack && pThread->m_pCleanedStackBase > stackTrace
&& pThread->m_pCleanedStackBase - stackTrace > (int) MAXSTACKBYTES)
{
_ASSERTE (!"Garbage on stack");
}
#endif
return fUnique;
}
#else // !FEATURE_PAL
BOOL Thread::UniqueStack(void* stackStart)
{
return FALSE;
}
#endif // !FEATURE_PAL
#endif // STRESS_HEAP
/*
* GetStackLowerBound
*
* Returns the lower bound of the stack space. Note -- the practical bound is some number of pages greater than
* this value -- those pages are reserved for a stack overflow exception processing.
*
* Parameters:
* None
*
* Returns:
* address of the lower bound of the threads's stack.
*/
void * Thread::GetStackLowerBound()
{
// Called during fiber switch. Can not have non-static contract.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_SO_TOLERANT;
#ifndef FEATURE_PAL
MEMORY_BASIC_INFORMATION lowerBoundMemInfo;
SIZE_T dwRes;
dwRes = ClrVirtualQuery((const void *)&lowerBoundMemInfo, &lowerBoundMemInfo, sizeof(MEMORY_BASIC_INFORMATION));
if (sizeof(MEMORY_BASIC_INFORMATION) == dwRes)
{
return (void *)(lowerBoundMemInfo.AllocationBase);
}
else
{
return NULL;
}
#else // !FEATURE_PAL
return PAL_GetStackLimit();
#endif // !FEATURE_PAL
}
/*
* GetStackUpperBound
*
* Return the upper bound of the thread's stack space.
*
* Parameters:
* None
*
* Returns:
* address of the base of the threads's stack.
*/
void *Thread::GetStackUpperBound()
{
// Called during fiber switch. Can not have non-static contract.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_SO_TOLERANT;
return ClrTeb::GetStackBase();
}
BOOL Thread::SetStackLimits(SetStackLimitScope scope)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
if (scope == fAll)
{
m_CacheStackBase = GetStackUpperBound();
m_CacheStackLimit = GetStackLowerBound();
if (m_CacheStackLimit == NULL)
{
_ASSERTE(!"Failed to set stack limits");
return FALSE;
}
// Compute the limit used by EnsureSufficientExecutionStack and cache it on the thread. This minimum stack size should
// be sufficient to allow a typical non-recursive call chain to execute, including potential exception handling and
// garbage collection. Used for probing for available stack space through RuntimeImports.EnsureSufficientExecutionStack,
// among other things.
#ifdef BIT64
const UINT_PTR MinExecutionStackSize = 128 * 1024;
#else // !BIT64
const UINT_PTR MinExecutionStackSize = 64 * 1024;
#endif // BIT64
_ASSERTE(m_CacheStackBase >= m_CacheStackLimit);
if ((reinterpret_cast<UINT_PTR>(m_CacheStackBase) - reinterpret_cast<UINT_PTR>(m_CacheStackLimit)) >
MinExecutionStackSize)
{
m_CacheStackSufficientExecutionLimit = reinterpret_cast<UINT_PTR>(m_CacheStackLimit) + MinExecutionStackSize;
}
else
{
m_CacheStackSufficientExecutionLimit = reinterpret_cast<UINT_PTR>(m_CacheStackBase);
}
}
// Ensure that we've setup the stack guarantee properly before we cache the stack limits
// as they depend upon the stack guarantee.
if (FAILED(CLRSetThreadStackGuarantee()))
return FALSE;
// Cache the last stack addresses that we are allowed to touch. We throw a stack overflow
// if we cross that line. Note that we ignore any subsequent calls to STSG for Whidbey until
// we see an exception and recache the values. We use the LastAllowableAddresses to
// determine if we've taken a hard SO and the ProbeLimits on the probes themselves.
m_LastAllowableStackAddress = GetLastNormalStackAddress();
if (g_pConfig->ProbeForStackOverflow())
{
m_ProbeLimit = m_LastAllowableStackAddress;
}
else
{
// If we have stack probing disabled, set the probeLimit to 0 so that all probes will pass. This
// way we don't have to do an extra check in the probe code.
m_ProbeLimit = 0;
}
return TRUE;
}
//---------------------------------------------------------------------------------------------
// Routines we use to managed a thread's stack, for fiber switching or stack overflow purposes.
//---------------------------------------------------------------------------------------------
HRESULT Thread::CLRSetThreadStackGuarantee(SetThreadStackGuaranteeScope fScope)
{
CONTRACTL
{
WRAPPER(NOTHROW);
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
#ifndef FEATURE_PAL
// TODO: we need to measure what the stack usage needs are at the limits in the hosted scenario for host callbacks
if (Thread::IsSetThreadStackGuaranteeInUse(fScope))
{
// <TODO> Tune this as needed </TODO>
ULONG uGuardSize = SIZEOF_DEFAULT_STACK_GUARANTEE;
int EXTRA_PAGES = 0;
#if defined(_WIN64)
// Free Build EH Stack Stats:
// --------------------------------
// currently the maximum stack usage we'll face while handling a SO includes:
// 4.3k for the OS (kernel32!RaiseException, Rtl EH dispatch code, RtlUnwindEx [second pass])
// 1.2k for the CLR EH setup (NakedThrowHelper*)
// 4.5k for other heavy CLR stack creations (2x CONTEXT, 1x REGDISPLAY)
// ~1.0k for other misc CLR stack allocations
// -----
// 11.0k --> ~2.75 pages for CLR SO EH dispatch
//
// -plus we might need some more for debugger EH dispatch, Watson, etc...
// -also need to take into account that we can lose up to 1 page of the guard region
// -additionally, we need to provide some region to hosts to allow for lock aquisition in a hosted scenario
//
EXTRA_PAGES = 3;
INDEBUG(EXTRA_PAGES += 1);
int ThreadGuardPages = CLRConfig::GetConfigValue(CLRConfig::EXTERNAL_ThreadGuardPages);
if (ThreadGuardPages == 0)
{
uGuardSize += (EXTRA_PAGES * GetOsPageSize());
}
else
{
uGuardSize += (ThreadGuardPages * GetOsPageSize());
}
#else // _WIN64
#ifdef _DEBUG
uGuardSize += (1 * GetOsPageSize()); // one extra page for debug infrastructure
#endif // _DEBUG
#endif // _WIN64
LOG((LF_EH, LL_INFO10000, "STACKOVERFLOW: setting thread stack guarantee to 0x%x\n", uGuardSize));
if (!::SetThreadStackGuarantee(&uGuardSize))
{
return HRESULT_FROM_GetLastErrorNA();
}
}
#endif // !FEATURE_PAL
return S_OK;
}
/*
* GetLastNormalStackAddress
*
* GetLastNormalStackAddress returns the last stack address before the guard
* region of a thread. This is the last address that one could write to before
* a stack overflow occurs.
*
* Parameters:
* StackLimit - the base of the stack allocation
*
* Returns:
* Address of the first page of the guard region.
*/
UINT_PTR Thread::GetLastNormalStackAddress(UINT_PTR StackLimit)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
UINT_PTR cbStackGuarantee = GetStackGuarantee();
// Here we take the "hard guard region size", the "stack guarantee" and the "fault page" and add them
// all together. Note that the "fault page" is the reason for the extra GetOsPageSize() below. The OS
// will guarantee us a certain amount of stack remaining after a stack overflow. This is called the
// "stack guarantee". But to do this, it has to fault on the page before that region as the app is
// allowed to fault at the very end of that page. So, as a result, the last normal stack address is
// one page sooner.
return StackLimit + (cbStackGuarantee
#ifndef FEATURE_PAL
+ GetOsPageSize()
#endif // !FEATURE_PAL
+ HARD_GUARD_REGION_SIZE);
}
#ifdef _DEBUG
static void DebugLogMBIFlags(UINT uState, UINT uProtect)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
#ifndef FEATURE_PAL
#define LOG_FLAG(flags, name) \
if (flags & name) \
{ \
LOG((LF_EH, LL_INFO1000, "" #name " ")); \
} \
if (uState)
{
LOG((LF_EH, LL_INFO1000, "State: "));
LOG_FLAG(uState, MEM_COMMIT);
LOG_FLAG(uState, MEM_RESERVE);
LOG_FLAG(uState, MEM_DECOMMIT);
LOG_FLAG(uState, MEM_RELEASE);
LOG_FLAG(uState, MEM_FREE);
LOG_FLAG(uState, MEM_PRIVATE);
LOG_FLAG(uState, MEM_MAPPED);
LOG_FLAG(uState, MEM_RESET);
LOG_FLAG(uState, MEM_TOP_DOWN);
LOG_FLAG(uState, MEM_WRITE_WATCH);
LOG_FLAG(uState, MEM_PHYSICAL);
LOG_FLAG(uState, MEM_LARGE_PAGES);
LOG_FLAG(uState, MEM_4MB_PAGES);
}
if (uProtect)
{
LOG((LF_EH, LL_INFO1000, "Protect: "));
LOG_FLAG(uProtect, PAGE_NOACCESS);
LOG_FLAG(uProtect, PAGE_READONLY);
LOG_FLAG(uProtect, PAGE_READWRITE);
LOG_FLAG(uProtect, PAGE_WRITECOPY);
LOG_FLAG(uProtect, PAGE_EXECUTE);
LOG_FLAG(uProtect, PAGE_EXECUTE_READ);
LOG_FLAG(uProtect, PAGE_EXECUTE_READWRITE);
LOG_FLAG(uProtect, PAGE_EXECUTE_WRITECOPY);
LOG_FLAG(uProtect, PAGE_GUARD);
LOG_FLAG(uProtect, PAGE_NOCACHE);
LOG_FLAG(uProtect, PAGE_WRITECOMBINE);
}
#undef LOG_FLAG
#endif // !FEATURE_PAL
}
static void DebugLogStackRegionMBIs(UINT_PTR uLowAddress, UINT_PTR uHighAddress)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_INTOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
MEMORY_BASIC_INFORMATION meminfo;
UINT_PTR uStartOfThisRegion = uLowAddress;
LOG((LF_EH, LL_INFO1000, "----------------------------------------------------------------------\n"));
while (uStartOfThisRegion < uHighAddress)
{
SIZE_T res = ClrVirtualQuery((const void *)uStartOfThisRegion, &meminfo, sizeof(meminfo));
if (sizeof(meminfo) != res)
{
LOG((LF_EH, LL_INFO1000, "VirtualQuery failed on %p\n", uStartOfThisRegion));
break;
}
UINT_PTR uStartOfNextRegion = uStartOfThisRegion + meminfo.RegionSize;
if (uStartOfNextRegion > uHighAddress)
{
uStartOfNextRegion = uHighAddress;
}
UINT_PTR uRegionSize = uStartOfNextRegion - uStartOfThisRegion;
LOG((LF_EH, LL_INFO1000, "0x%p -> 0x%p (%d pg) ", uStartOfThisRegion, uStartOfNextRegion - 1, uRegionSize / GetOsPageSize()));
DebugLogMBIFlags(meminfo.State, meminfo.Protect);
LOG((LF_EH, LL_INFO1000, "\n"));
uStartOfThisRegion = uStartOfNextRegion;
}
LOG((LF_EH, LL_INFO1000, "----------------------------------------------------------------------\n"));
}
// static
void Thread::DebugLogStackMBIs()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_INTOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
Thread* pThread = GetThread(); // N.B. this can be NULL!
UINT_PTR uStackLimit = (UINT_PTR)GetStackLowerBound();
UINT_PTR uStackBase = (UINT_PTR)GetStackUpperBound();
if (pThread)
{
uStackLimit = (UINT_PTR)pThread->GetCachedStackLimit();
uStackBase = (UINT_PTR)pThread->GetCachedStackBase();
}
else
{
uStackLimit = (UINT_PTR)GetStackLowerBound();
uStackBase = (UINT_PTR)GetStackUpperBound();
}
UINT_PTR uStackSize = uStackBase - uStackLimit;
LOG((LF_EH, LL_INFO1000, "----------------------------------------------------------------------\n"));
LOG((LF_EH, LL_INFO1000, "Stack Snapshot 0x%p -> 0x%p (%d pg)\n", uStackLimit, uStackBase, uStackSize / GetOsPageSize()));
if (pThread)
{
LOG((LF_EH, LL_INFO1000, "Last normal addr: 0x%p\n", pThread->GetLastNormalStackAddress()));
}
DebugLogStackRegionMBIs(uStackLimit, uStackBase);
}
#endif // _DEBUG
//
// IsSPBeyondLimit
//
// Determines if the stack pointer is beyond the stack limit, in which case
// we can assume we've taken a hard SO.
//
// Parameters: none
//
// Returns: bool indicating if SP is beyond the limit or not
//
BOOL Thread::IsSPBeyondLimit()
{
WRAPPER_NO_CONTRACT;
// Reset the stack limits if necessary.
// @todo . Add a vectored handler for X86 so that we reset the stack limits
// there, as anything that supports SetThreadStackGuarantee will support vectored handlers.
// Then we can always assume during EH processing that our stack limits are good and we
// don't have to call ResetStackLimits.
ResetStackLimits();
char *approxSP = (char *)GetCurrentSP();
if (approxSP < (char *)(GetLastAllowableStackAddress()))
{
return TRUE;
}
return FALSE;
}
__declspec(noinline) void AllocateSomeStack(){
LIMITED_METHOD_CONTRACT;
#ifdef _TARGET_X86_
const size_t size = 0x200;
#else //_TARGET_X86_
const size_t size = 0x400;
#endif //_TARGET_X86_
INT8* mem = (INT8*)_alloca(size);
// Actually touch the memory we just allocated so the compiler can't
// optimize it away completely.
// NOTE: this assumes the stack grows down (towards 0).
VolatileStore<INT8>(mem, 0);
}
/*
* CommitThreadStack
*
* Commit the thread's entire stack. A thread's stack is usually only reserved memory, not committed. The OS will
* commit more pages as the thread's stack grows. But, if the system is low on memory and disk space, its possible
* that the OS will not have enough memory to grow the stack. That causes a stack overflow exception at very random
* times, and the CLR can't handle that.
*
* Parameters:
* The Thread object for this thread, if there is one. NULL otherwise.
*
* Returns:
* TRUE if the function succeeded, FALSE otherwise.
*/
/*static*/
BOOL Thread::CommitThreadStack(Thread* pThreadOptional)
{
return TRUE;
}
#ifndef FEATURE_PAL
// static // private
BOOL Thread::DoesRegionContainGuardPage(UINT_PTR uLowAddress, UINT_PTR uHighAddress)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
SIZE_T dwRes;
MEMORY_BASIC_INFORMATION meminfo;
UINT_PTR uStartOfCurrentRegion = uLowAddress;
while (uStartOfCurrentRegion < uHighAddress)
{
#undef VirtualQuery
// This code can run below YieldTask, which means that it must not call back into the host.
// The reason is that YieldTask is invoked by the host, and the host needs not be reentrant.
dwRes = VirtualQuery((const void *)uStartOfCurrentRegion, &meminfo, sizeof(meminfo));
#define VirtualQuery(lpAddress, lpBuffer, dwLength) Dont_Use_VirtualQuery(lpAddress, lpBuffer, dwLength)
// If the query fails then assume we have no guard page.
if (sizeof(meminfo) != dwRes)
{
return FALSE;
}
if (meminfo.Protect & PAGE_GUARD)
{
return TRUE;
}
uStartOfCurrentRegion += meminfo.RegionSize;
}
return FALSE;
}
#endif // !FEATURE_PAL
/*
* DetermineIfGuardPagePresent
*
* DetermineIfGuardPagePresent returns TRUE if the thread's stack contains a proper guard page. This function makes
* a physical check of the stack, rather than relying on whether or not the CLR is currently processing a stack
* overflow exception.
*
* It seems reasonable to want to check just the 3rd page for !MEM_COMMIT or PAGE_GUARD, but that's no good in a
* world where a) one can extend the guard region arbitrarily with SetThreadStackGuarantee(), b) a thread's stack
* could be pre-committed, and c) another lib might reset the guard page very high up on the stack, much as we
* do. In that world, we have to do VirtualQuery from the lower bound up until we find a region with PAGE_GUARD on
* it. If we've never SO'd, then that's two calls to VirtualQuery.
*
* Parameters:
* None
*
* Returns:
* TRUE if the thread has a guard page, FALSE otherwise.
*/
BOOL Thread::DetermineIfGuardPagePresent()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
#ifndef FEATURE_PAL
BOOL bStackGuarded = FALSE;
UINT_PTR uStackBase = (UINT_PTR)GetCachedStackBase();
UINT_PTR uStackLimit = (UINT_PTR)GetCachedStackLimit();
// Note: we start our queries after the hard guard page (one page up from the base of the stack.) We know the
// very last region of the stack is never the guard page (its always the uncomitted "hard" guard page) so there's
// no need to waste a query on it.
bStackGuarded = DoesRegionContainGuardPage(uStackLimit + HARD_GUARD_REGION_SIZE,
uStackBase);
LOG((LF_EH, LL_INFO10000, "Thread::DetermineIfGuardPagePresent: stack guard page: %s\n", bStackGuarded ? "PRESENT" : "MISSING"));
return bStackGuarded;
#else // !FEATURE_PAL
return TRUE;
#endif // !FEATURE_PAL
}
/*
* GetLastNormalStackAddress
*
* GetLastNormalStackAddress returns the last stack address before the guard
* region of this thread. This is the last address that one could write to
* before a stack overflow occurs.
*
* Parameters:
* None
*
* Returns:
* Address of the first page of the guard region.
*/
UINT_PTR Thread::GetLastNormalStackAddress()
{
WRAPPER_NO_CONTRACT;
return GetLastNormalStackAddress((UINT_PTR)m_CacheStackLimit);
}
#ifdef FEATURE_STACK_PROBE
/*
* CanResetStackTo
*
* Given a target stack pointer, this function will tell us whether or not we could restore the guard page if we
* unwound the stack that far.
*
* Parameters:
* stackPointer -- stack pointer that we want to try to reset the thread's stack up to.
*
* Returns:
* TRUE if there's enough room to reset the stack, false otherwise.
*/
BOOL Thread::CanResetStackTo(LPCVOID stackPointer)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
// How much space between the given stack pointer and the first guard page?
//
// This must be signed since the stack pointer might be in the guard region,
// which is at a lower address than GetLastNormalStackAddress will return.
INT_PTR iStackSpaceLeft = (INT_PTR)stackPointer - GetLastNormalStackAddress();
// We need to have enough space to call back into the EE from the handler, so we use the twice the entry point amount.
// We need enough to do work and enough that partway through that work we won't probe and COMPlusThrowSO.
const INT_PTR iStackSizeThreshold = (ADJUST_PROBE(DEFAULT_ENTRY_PROBE_AMOUNT * 2) * GetOsPageSize());
if (iStackSpaceLeft > iStackSizeThreshold)
{
return TRUE;
}
else
{
return FALSE;
}
}
/*
* IsStackSpaceAvailable
*
* Given a number of stack pages, this function will tell us whether or not we have that much space
* before the top of the stack. If we are in the guard region we must be already handling an SO,
* so we report how much space is left in the guard region
*
* Parameters:
* numPages -- the number of pages that we need. This can be a fractional amount.
*
* Returns:
* TRUE if there's that many pages of stack available
*/
BOOL Thread::IsStackSpaceAvailable(float numPages)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
// How much space between the current stack pointer and the first guard page?
//
// This must be signed since the stack pointer might be in the guard region,
// which is at a lower address than GetLastNormalStackAddress will return.
float iStackSpaceLeft = static_cast<float>((INT_PTR)GetCurrentSP() - (INT_PTR)GetLastNormalStackAddress());
// If we have access to the stack guarantee (either in the guard region or we've tripped the guard page), then
// use that.
if ((iStackSpaceLeft/GetOsPageSize()) < numPages && !DetermineIfGuardPagePresent())
{
UINT_PTR stackGuarantee = GetStackGuarantee();
// GetLastNormalStackAddress actually returns the 2nd to last stack page on the stack. We'll add that to our available
// amount of stack, in addition to any sort of stack guarantee we might have.
//
// All these values are OS supplied, and will never overflow. (If they do, that means the stack is on the order
// over GB, which isn't possible.
iStackSpaceLeft += stackGuarantee + GetOsPageSize();
}
if ((iStackSpaceLeft/GetOsPageSize()) < numPages)
{
return FALSE;
}
return TRUE;
}
#endif // FEATURE_STACK_PROBE
/*
* GetStackGuarantee
*
* Returns the amount of stack guaranteed after an SO but before the OS rips the process.
*
* Parameters:
* none
*
* Returns:
* The stack guarantee in OS pages.
*/
UINT_PTR Thread::GetStackGuarantee()
{
WRAPPER_NO_CONTRACT;
#ifndef FEATURE_PAL
// There is a new API available on new OS's called SetThreadStackGuarantee. It allows you to change the size of
// the guard region on a per-thread basis. If we're running on an OS that supports the API, then we must query
// it to see if someone has changed the size of the guard region for this thread.
if (!IsSetThreadStackGuaranteeInUse())
{
return SIZEOF_DEFAULT_STACK_GUARANTEE;
}
ULONG cbNewStackGuarantee = 0;
// Passing in a value of 0 means that we're querying, and the value is changed with the new guard region
// size.
if (::SetThreadStackGuarantee(&cbNewStackGuarantee) &&
(cbNewStackGuarantee != 0))
{
return cbNewStackGuarantee;
}
#endif // FEATURE_PAL
return SIZEOF_DEFAULT_STACK_GUARANTEE;
}
#ifndef FEATURE_PAL
//
// MarkPageAsGuard
//
// Given a page base address, try to turn it into a guard page and then requery to determine success.
//
// static // private
BOOL Thread::MarkPageAsGuard(UINT_PTR uGuardPageBase)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
DWORD flOldProtect;
ClrVirtualProtect((LPVOID)uGuardPageBase, 1,
(PAGE_READWRITE | PAGE_GUARD), &flOldProtect);
// Intentionally ignore return value -- if it failed, we'll find out below
// and keep moving up the stack until we either succeed or we hit the guard
// region. If we don't succeed before we hit the guard region, we'll end up
// with a fatal error.
// Now, make sure the guard page is really there. If its not, then VirtualProtect most likely failed
// because our stack had grown onto the page we were trying to protect by the time we made it into
// VirtualProtect. So try the next page down.
MEMORY_BASIC_INFORMATION meminfo;
SIZE_T dwRes;
dwRes = ClrVirtualQuery((const void *)uGuardPageBase, &meminfo, sizeof(meminfo));
return ((sizeof(meminfo) == dwRes) && (meminfo.Protect & PAGE_GUARD));
}
/*
* RestoreGuardPage
*
* RestoreGuardPage will replace the guard page on this thread's stack. The assumption is that it was removed by
* the OS due to a stack overflow exception. This function requires that you know that you have enough stack space
* to restore the guard page, so make sure you know what you're doing when you decide to call this.
*
* Parameters:
* None
*
* Returns:
* Nothing
*/
VOID Thread::RestoreGuardPage()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
CANNOT_TAKE_LOCK;
}
CONTRACTL_END;
// Need a hard SO probe here.
CONTRACT_VIOLATION(SOToleranceViolation);
BOOL bStackGuarded = DetermineIfGuardPagePresent();
// If the guard page is still there, then just return.
if (bStackGuarded)
{
LOG((LF_EH, LL_INFO100, "Thread::RestoreGuardPage: no need to restore... guard page is already there.\n"));
return;
}
UINT_PTR approxStackPointer;
UINT_PTR guardPageBase;
UINT_PTR guardRegionThreshold;
BOOL pageMissing;
if (!bStackGuarded)
{
// The normal guard page is the 3rd page from the base. The first page is the "hard" guard, the second one is
// reserve, and the 3rd one is marked as a guard page. However, since there is now an API (on some platforms)
// to change the size of the guard region, we'll just go ahead and protect the next page down from where we are
// now. The guard page will get pushed forward again, just like normal, until the next stack overflow.
approxStackPointer = (UINT_PTR)GetCurrentSP();
guardPageBase = (UINT_PTR)ALIGN_DOWN(approxStackPointer, GetOsPageSize()) - GetOsPageSize();
// OS uses soft guard page to update the stack info in TEB. If our guard page is not beyond the current stack, the TEB
// will not be updated, and then OS's check of stack during exception will fail.
if (approxStackPointer >= guardPageBase)
{
guardPageBase -= GetOsPageSize();
}
// If we're currently "too close" to the page we want to mark as a guard then the call to VirtualProtect to set
// PAGE_GUARD will fail, but it won't return an error. Therefore, we protect the page, then query it to make
// sure it worked. If it didn't, we try the next page down. We'll either find a page to protect, or run into
// the guard region and rip the process down with EEPOLICY_HANDLE_FATAL_ERROR below.
guardRegionThreshold = GetLastNormalStackAddress();
pageMissing = TRUE;
while (pageMissing)
{
LOG((LF_EH, LL_INFO10000,
"Thread::RestoreGuardPage: restoring guard page @ 0x%p, approxStackPointer=0x%p, "
"last normal stack address=0x%p\n",
guardPageBase, approxStackPointer, guardRegionThreshold));
// Make sure we set the guard page above the guard region.
if (guardPageBase < guardRegionThreshold)
{
goto lFatalError;
}
if (MarkPageAsGuard(guardPageBase))
{
// The current GuardPage should be beyond the current SP.
_ASSERTE (guardPageBase < approxStackPointer);
pageMissing = FALSE;
}
else
{
guardPageBase -= GetOsPageSize();
}
}
}
FinishSOWork();
//GetAppDomain()->EnableADUnloadWorker(EEPolicy::ADU_Rude);
INDEBUG(DebugLogStackMBIs());
return;
lFatalError:
STRESS_LOG2(LF_EH, LL_ALWAYS,
"Thread::RestoreGuardPage: too close to the guard region (0x%p) to restore guard page @0x%p\n",
guardRegionThreshold, guardPageBase);
_ASSERTE(!"Too close to the guard page to reset it!");
EEPOLICY_HANDLE_FATAL_ERROR(COR_E_STACKOVERFLOW);
}
#endif // !FEATURE_PAL
#endif // #ifndef DACCESS_COMPILE
//
// InitRegDisplay: initializes a REGDISPLAY for a thread. If validContext
// is false, pRD is filled from the current context of the thread. The
// thread's current context is also filled in pctx. If validContext is true,
// pctx should point to a valid context and pRD is filled from that.
//
bool Thread::InitRegDisplay(const PREGDISPLAY pRD, PT_CONTEXT pctx, bool validContext)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
if (!validContext)
{
if (GetFilterContext()!= NULL)
{
pctx = GetFilterContext();
}
else
{
#ifdef DACCESS_COMPILE
DacNotImpl();
#else
pctx->ContextFlags = CONTEXT_FULL;
_ASSERTE(this != GetThread()); // do not call GetThreadContext on the active thread
BOOL ret = EEGetThreadContext(this, pctx);
if (!ret)
{
SetIP(pctx, 0);
#ifdef _TARGET_X86_
pRD->ControlPC = pctx->Eip;
pRD->PCTAddr = (TADDR)&(pctx->Eip);
#elif defined(_TARGET_AMD64_)
// nothing more to do here, on Win64 setting the IP to 0 is enough.
#elif defined(_TARGET_ARM_)
// nothing more to do here, on Win64 setting the IP to 0 is enough.
#else
PORTABILITY_ASSERT("NYI for platform Thread::InitRegDisplay");
#endif
return false;
}
#endif // DACCESS_COMPILE
}
}
FillRegDisplay( pRD, pctx );
return true;
}
void Thread::FillRegDisplay(const PREGDISPLAY pRD, PT_CONTEXT pctx)
{
WRAPPER_NO_CONTRACT;
SUPPORTS_DAC;
::FillRegDisplay(pRD, pctx);
#if defined(DEBUG_REGDISPLAY) && !defined(_TARGET_X86_)
CONSISTENCY_CHECK(!pRD->_pThread || pRD->_pThread == this);
pRD->_pThread = this;
CheckRegDisplaySP(pRD);
#endif // defined(DEBUG_REGDISPLAY) && !defined(_TARGET_X86_)
}
#ifdef DEBUG_REGDISPLAY
void CheckRegDisplaySP (REGDISPLAY *pRD)
{
if (pRD->SP && pRD->_pThread)
{
#ifndef NO_FIXED_STACK_LIMIT
_ASSERTE(PTR_VOID(pRD->SP) >= pRD->_pThread->GetCachedStackLimit());
#endif // NO_FIXED_STACK_LIMIT
_ASSERTE(PTR_VOID(pRD->SP) < pRD->_pThread->GetCachedStackBase());
}
}
#endif // DEBUG_REGDISPLAY
// Trip Functions
// ==============
// When a thread reaches a safe place, it will rendezvous back with us, via one of
// the following trip functions:
void CommonTripThread()
{
#ifndef DACCESS_COMPILE
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
Thread *thread = GetThread();
thread->HandleThreadAbort ();
if (thread->IsYieldRequested())
{
__SwitchToThread(0, CALLER_LIMITS_SPINNING);
}
if (thread->CatchAtSafePoint())
{
_ASSERTE(!ThreadStore::HoldingThreadStore(thread));
#ifdef FEATURE_HIJACK
thread->UnhijackThread();
#endif // FEATURE_HIJACK
// Trap
thread->PulseGCMode();
}
#else
DacNotImpl();
#endif // #ifndef DACCESS_COMPILE
}
#ifndef DACCESS_COMPILE
void Thread::SetFilterContext(CONTEXT *pContext)
{
// SetFilterContext is like pushing a Frame onto the Frame chain.
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE; // Absolutely must be in coop to coordinate w/ Runtime suspension.
PRECONDITION(GetThread() == this); // must be on current thread.
} CONTRACTL_END;
m_debuggerFilterContext = pContext;
}
#endif // #ifndef DACCESS_COMPILE
T_CONTEXT *Thread::GetFilterContext(void)
{
LIMITED_METHOD_DAC_CONTRACT;
return m_debuggerFilterContext;
}
#ifndef DACCESS_COMPILE
// @todo - eventually complete remove the CantStop count on the thread and use
// the one in the PreDef block. For now, we increment both our thread counter,
// and the FLS counter. Eventually we can remove our thread counter and only use
// the FLS counter.
void Thread::SetDebugCantStop(bool fCantStop)
{
LIMITED_METHOD_CONTRACT;
if (fCantStop)
{
IncCantStopCount();
m_debuggerCantStop++;
}
else
{
DecCantStopCount();
m_debuggerCantStop--;
}
}
// @todo - remove this, we only read this from oop.
bool Thread::GetDebugCantStop(void)
{
LIMITED_METHOD_CONTRACT;
return m_debuggerCantStop != 0;
}
//-----------------------------------------------------------------------------
// Call w/a wrapper.
// We've already transitioned AppDomains here. This just places a 1st-pass filter to sniff
// for catch-handler found callbacks for the debugger.
//-----------------------------------------------------------------------------
void MakeADCallDebuggerWrapper(
FPAPPDOMAINCALLBACK fpCallback,
CtxTransitionBaseArgs * args,
ContextTransitionFrame* pFrame)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_ANY;
BYTE * pCatcherStackAddr = (BYTE*) pFrame;
struct Param : NotifyOfCHFFilterWrapperParam
{
FPAPPDOMAINCALLBACK fpCallback;
CtxTransitionBaseArgs *args;
} param;
param.pFrame = pCatcherStackAddr;
param.fpCallback = fpCallback;
param.args = args;
PAL_TRY(Param *, pParam, ¶m)
{
pParam->fpCallback(pParam->args);
}
PAL_EXCEPT_FILTER(AppDomainTransitionExceptionFilter)
{
// Should never reach here b/c handler should always continue search.
_ASSERTE(false);
}
PAL_ENDTRY
}
// Invoke a callback in another appdomain.
// Caller should have checked that we're actually transitioning domains here.
void MakeCallWithAppDomainTransition(
ADID TargetDomain,
FPAPPDOMAINCALLBACK fpCallback,
CtxTransitionBaseArgs * args)
{
DEBUG_ASSURE_NO_RETURN_BEGIN(MAKECALL)
Thread* _ctx_trans_pThread = GetThread();
TESTHOOKCALL(EnteringAppDomain((TargetDomain.m_dwId)));
AppDomainFromIDHolder pTargetDomain(TargetDomain, TRUE);
pTargetDomain.ThrowIfUnloaded();
_ASSERTE(_ctx_trans_pThread != NULL);
_ASSERTE(_ctx_trans_pThread->GetDomain()->GetId()!= TargetDomain);
bool _ctx_trans_fRaiseNeeded = false;
Exception* _ctx_trans_pTargetDomainException=NULL; \
FrameWithCookie<ContextTransitionFrame> _ctx_trans_Frame;
ContextTransitionFrame* _ctx_trans_pFrame = &_ctx_trans_Frame;
_ctx_trans_pThread->EnterContextRestricted(
pTargetDomain->GetDefaultContext(),
_ctx_trans_pFrame);
pTargetDomain.Release();
args->pCtxFrame = _ctx_trans_pFrame;
TESTHOOKCALL(EnteredAppDomain((TargetDomain.m_dwId)));
/* work around unreachable code warning */
EX_TRY
{
// Invoke the callback
if (CORDebuggerAttached())
{
// If a debugger is attached, do it through a wrapper that will sniff for CHF callbacks.
MakeADCallDebuggerWrapper(fpCallback, args, GET_CTX_TRANSITION_FRAME());
}
else
{
// If no debugger is attached, call directly.
fpCallback(args);
}
}
EX_CATCH
{
LOG((LF_EH|LF_APPDOMAIN, LL_INFO1000, "ENTER_DOMAIN(%s, %s, %d): exception in flight\n",
__FUNCTION__, __FILE__, __LINE__));
_ctx_trans_pTargetDomainException=EXTRACT_EXCEPTION();
_ctx_trans_fRaiseNeeded = true;
}
/* SwallowAllExceptions is fine because we don't get to this point */
/* unless fRaiseNeeded = true or no exception was thrown */
EX_END_CATCH(SwallowAllExceptions);
TESTHOOKCALL(LeavingAppDomain((TargetDomain.m_dwId)));
if (_ctx_trans_fRaiseNeeded)
{
LOG((LF_EH, LL_INFO1000, "RaiseCrossContextException(%s, %s, %d)\n",
__FUNCTION__, __FILE__, __LINE__));
_ctx_trans_pThread->RaiseCrossContextException(_ctx_trans_pTargetDomainException,_ctx_trans_pFrame);
}
LOG((LF_APPDOMAIN, LL_INFO1000, "LEAVE_DOMAIN(%s, %s, %d)\n",
__FUNCTION__, __FILE__, __LINE__));
_ctx_trans_pThread->ReturnToContext(_ctx_trans_pFrame);
#ifdef FEATURE_TESTHOOKS
TESTHOOKCALL(LeftAppDomain(TargetDomain.m_dwId));
#endif
DEBUG_ASSURE_NO_RETURN_END(MAKECALL)
}
void Thread::InitContext()
{
CONTRACTL {
THROWS;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
// this should only be called when initializing a thread
_ASSERTE(m_Context == NULL);
_ASSERTE(m_pDomain == NULL);
GCX_COOP_NO_THREAD_BROKEN();
m_Context = SystemDomain::System()->DefaultDomain()->GetDefaultContext();
m_pDomain = m_Context->GetDomain();
_ASSERTE(m_pDomain);
m_pDomain->ThreadEnter(this, NULL);
}
void Thread::ClearContext()
{
CONTRACTL {
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
}
CONTRACTL_END;
// if one is null, both must be
_ASSERTE(m_pDomain && m_Context || ! (m_pDomain && m_Context));
if (!m_pDomain)
return;
m_pDomain->ThreadExit(this, NULL);
// must set exposed context to null first otherwise object verification
// checks will fail AV when m_Context is null
m_pDomain = NULL;
#ifdef FEATURE_COMINTEROP
m_fDisableComObjectEagerCleanup = false;
#endif //FEATURE_COMINTEROP
m_Context = NULL;
}
void Thread::DoContextCallBack(ADID appDomain, Context *pContext, Context::ADCallBackFcnType pTarget, LPVOID args)
{
//Do not deference pContext if it's not from the current appdomain
#ifdef _DEBUG
TADDR espVal = (TADDR)GetCurrentSP();
LOG((LF_APPDOMAIN, LL_INFO100, "Thread::DoADCallBack Calling %p at esp %p in [%d]\n",
pTarget, espVal, appDomain.m_dwId));
#endif
_ASSERTE(GetThread()->GetContext() != pContext);
Thread* pThread = GetThread();
// Get the default context for the current domain as well as for the
// destination domain.
AppDomain* pCurrDomain = pThread->GetContext()->GetDomain();
Context* pCurrDefCtx = pCurrDomain->GetDefaultContext();
BOOL bDefaultTargetCtx=FALSE;
{
AppDomainFromIDHolder ad(appDomain, TRUE);
ad.ThrowIfUnloaded();
bDefaultTargetCtx=(ad->GetDefaultContext()==pContext);
}
if (pCurrDefCtx == pThread->GetContext() && bDefaultTargetCtx)
{
ENTER_DOMAIN_ID(appDomain);
(pTarget)(args);
END_DOMAIN_TRANSITION;
}
else
{
UNREACHABLE();
}
LOG((LF_APPDOMAIN, LL_INFO100, "Thread::DoADCallBack Done at esp %p\n", espVal));
}
void Thread::DoADCallBack(AppDomain* pDomain , Context::ADCallBackFcnType pTarget, LPVOID args, DWORD dwADV,
BOOL fSetupEHAtTransition /* = TRUE */)
{
#ifdef _DEBUG
TADDR espVal = (TADDR)GetCurrentSP();
LOG((LF_APPDOMAIN, LL_INFO100, "Thread::DoADCallBack Calling %p at esp %p in [%d]\n",
pTarget, espVal, pDomain->GetId().m_dwId));
#endif
Thread* pThread = GetThread();
// Get the default context for the current domain as well as for the
// destination domain.
AppDomain* pCurrDomain = pThread->GetContext()->GetDomain();
if (pCurrDomain!=pDomain)
{
// use the target domain's default context as the target context
// so that the actual call to a transparent proxy would enter the object into the correct context.
BOOL fThrow = FALSE;
#ifdef FEATURE_PAL
// FEATURE_PAL must setup EH at AD transition - the option to omit the setup
// is only for regular Windows builds.
_ASSERTE(fSetupEHAtTransition);
#endif // FEATURE_PAL
LOG((LF_APPDOMAIN, LL_INFO10, "Thread::DoADCallBack - performing AD transition with%s EH at transition boundary.\n",
(fSetupEHAtTransition == FALSE)?"out":""));
if (fSetupEHAtTransition)
{
ENTER_DOMAIN_PTR(pDomain,dwADV)
{
(pTarget)(args);
// unloadBoundary is cleared by ReturnToContext, so get it now.
Frame* unloadBoundaryFrame = pThread->GetUnloadBoundaryFrame();
fThrow = pThread->ShouldChangeAbortToUnload(GET_CTX_TRANSITION_FRAME(), unloadBoundaryFrame);
}
END_DOMAIN_TRANSITION;
}
#ifndef FEATURE_PAL
else
{
ENTER_DOMAIN_PTR_NO_EH_AT_TRANSITION(pDomain,dwADV)
{
(pTarget)(args);
// unloadBoundary is cleared by ReturnToContext, so get it now.
Frame* unloadBoundaryFrame = pThread->GetUnloadBoundaryFrame();
fThrow = pThread->ShouldChangeAbortToUnload(GET_CTX_TRANSITION_FRAME(), unloadBoundaryFrame);
}
END_DOMAIN_TRANSITION_NO_EH_AT_TRANSITION;
}
#endif // !FEATURE_PAL
// if someone caught the abort before it got back out to the AD transition (like DispatchEx_xxx does)
// then need to turn the abort into an unload, as they're gonna keep seeing it anyway
if (fThrow)
{
LOG((LF_APPDOMAIN, LL_INFO10, "Thread::DoADCallBack turning abort into unload\n"));
COMPlusThrow(kAppDomainUnloadedException, W("Remoting_AppDomainUnloaded_ThreadUnwound"));
}
}
else
{
UNREACHABLE();
}
LOG((LF_APPDOMAIN, LL_INFO100, "Thread::DoADCallBack Done at esp %p\n", espVal));
}
void Thread::DoADCallBack(ADID appDomainID , Context::ADCallBackFcnType pTarget, LPVOID args, BOOL fSetupEHAtTransition /* = TRUE */)
{
#ifdef _DEBUG
TADDR espVal = (TADDR)GetCurrentSP();
LOG((LF_APPDOMAIN, LL_INFO100, "Thread::DoADCallBack Calling %p at esp %p in [%d]\n",
pTarget, espVal, appDomainID.m_dwId));
#endif
Thread* pThread = GetThread();
// Get the default context for the current domain as well as for the
// destination domain.
AppDomain* pCurrDomain = pThread->GetContext()->GetDomain();
if (pCurrDomain->GetId()!=appDomainID)
{
// use the target domain's default context as the target context
// so that the actual call to a transparent proxy would enter the object into the correct context.
BOOL fThrow = FALSE;
#ifdef FEATURE_PAL
// FEATURE_PAL must setup EH at AD transition - the option to omit the setup
// is only for regular Windows builds.
_ASSERTE(fSetupEHAtTransition);
#endif // FEATURE_PAL
LOG((LF_APPDOMAIN, LL_INFO10, "Thread::DoADCallBack - performing AD transition with%s EH at transition boundary.\n",
(fSetupEHAtTransition == FALSE)?"out":""));
if (fSetupEHAtTransition)
{
ENTER_DOMAIN_ID(appDomainID)
{
(pTarget)(args);
// unloadBoundary is cleared by ReturnToContext, so get it now.
Frame* unloadBoundaryFrame = pThread->GetUnloadBoundaryFrame();
fThrow = pThread->ShouldChangeAbortToUnload(GET_CTX_TRANSITION_FRAME(), unloadBoundaryFrame);
}
END_DOMAIN_TRANSITION;
}
#ifndef FEATURE_PAL
else
{
ENTER_DOMAIN_ID_NO_EH_AT_TRANSITION(appDomainID)
{
(pTarget)(args);
// unloadBoundary is cleared by ReturnToContext, so get it now.
Frame* unloadBoundaryFrame = pThread->GetUnloadBoundaryFrame();
fThrow = pThread->ShouldChangeAbortToUnload(GET_CTX_TRANSITION_FRAME(), unloadBoundaryFrame);
}
END_DOMAIN_TRANSITION_NO_EH_AT_TRANSITION;
}
#endif // !FEATURE_PAL
// if someone caught the abort before it got back out to the AD transition (like DispatchEx_xxx does)
// then need to turn the abort into an unload, as they're gonna keep seeing it anyway
if (fThrow)
{
LOG((LF_APPDOMAIN, LL_INFO10, "Thread::DoADCallBack turning abort into unload\n"));
COMPlusThrow(kAppDomainUnloadedException, W("Remoting_AppDomainUnloaded_ThreadUnwound"));
}
}
else
{
UNREACHABLE();
}
LOG((LF_APPDOMAIN, LL_INFO100, "Thread::DoADCallBack Done at esp %p\n", espVal));
}
void Thread::EnterContextRestricted(Context *pContext, ContextTransitionFrame *pFrame)
{
CONTRACTL {
THROWS;
MODE_COOPERATIVE;
GC_NOTRIGGER;
}
CONTRACTL_END;
_ASSERTE(GetThread() == this);
_ASSERTE(pContext); // should never enter a null context
_ASSERTE(m_Context); // should always have a current context
AppDomain *pPrevDomain = m_pDomain;
AppDomain *pDomain = pContext->GetDomain();
// and it should always have an AD set
_ASSERTE(pDomain);
if (m_pDomain != pDomain && !pDomain->CanThreadEnter(this))
{
pFrame->SetReturnContext(NULL);
COMPlusThrow(kAppDomainUnloadedException);
}
pFrame->SetReturnContext(m_Context);
pFrame->SetReturnExecutionContext(NULL);
if (pPrevDomain != pDomain)
{
pFrame->SetLockCount(m_dwBeginLockCount);
m_dwBeginLockCount = m_dwLockCount;
}
if (m_Context == pContext) {
_ASSERTE(m_Context->GetDomain() == pContext->GetDomain());
return;
}
LOG((LF_APPDOMAIN, LL_INFO1000, "%sThread::EnterContext from (%p) [%d] (count %d)\n",
FinalizerThread::IsCurrentThreadFinalizer() ? "FT: " : "",
m_Context, m_Context->GetDomain()->GetId().m_dwId,
m_Context->GetDomain()->GetThreadEnterCount()));
LOG((LF_APPDOMAIN, LL_INFO1000, " into (%p) [%d] (count %d)\n", pContext,
pContext->GetDomain()->GetId().m_dwId,
pContext->GetDomain()->GetThreadEnterCount()));
#ifdef _DEBUG_ADUNLOAD
printf("Thread::EnterContext %x from (%8.8x) [%d]\n", GetThreadId(), m_Context,
m_Context ? m_Context->GetDomain()->GetId() : -1);
printf(" into (%8.8x) [%d] %S\n", pContext,
pContext->GetDomain()->GetId());
#endif
CantStopHolder hCantStop;
bool fChangedDomains = m_pDomain != pDomain;
if (fChangedDomains)
{
#ifdef FEATURE_STACK_PROBE
if (pDomain == SystemDomain::System()->DefaultDomain() &&
GetEEPolicy()->GetActionOnFailure(FAIL_StackOverflow) == eRudeUnloadAppDomain)
{
// Make sure default domain does not see SO.
// probe for our entry point amount and throw if not enough stack
RetailStackProbe(ADJUST_PROBE(DEFAULT_ENTRY_PROBE_AMOUNT*2), this);
}
#endif
_ASSERTE(pFrame);
STRESS_LOG1(LF_APPDOMAIN, LL_INFO100000, "Entering into ADID=%d\n", pDomain->GetId().m_dwId);
//
// Store the last thrown object in the ContextTransitionFrame before we null it out
// to prevent it from leaking into the domain we are transitionning into.
//
pFrame->SetLastThrownObjectInParentContext(LastThrownObject());
SafeSetLastThrownObject(NULL);
}
m_Context = pContext;
pFrame->Push();
#ifdef _DEBUG_ADUNLOAD
printf("Thread::EnterContext %x,%8.8x push? %d current frame is %8.8x\n", GetThreadId(), this, 1, GetFrame());
#endif
if (fChangedDomains)
{
pDomain->ThreadEnter(this, pFrame);
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
if (g_fEnableARM)
{
// Update previous AppDomain's count of processor usage by threads executing within it.
pPrevDomain->UpdateProcessorUsage(QueryThreadProcessorUsage());
FireEtwThreadDomainEnter((ULONGLONG)this, (ULONGLONG)pDomain, GetClrInstanceId());
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
// NULL out the Thread's pointer to the current ThreadLocalBlock. On the next
// access to thread static data, the Thread's pointer to the current ThreadLocalBlock
// will be updated correctly.
m_pThreadLocalBlock = NULL;
m_pDomain = pDomain;
SetAppDomain(m_pDomain);
}
}
// main difference between EnterContext and ReturnToContext is that are allowed to return
// into a domain that is unloading but cannot enter a domain that is unloading
void Thread::ReturnToContext(ContextTransitionFrame *pFrame)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
_ASSERTE(GetThread() == this);
Context *pReturnContext = pFrame->GetReturnContext();
_ASSERTE(pReturnContext);
ADID pADOnStack;
AppDomain *pReturnDomain = pReturnContext->GetDomain();
AppDomain* pCurrentDomain = m_pDomain;
bool fChangedDomains = m_pDomain != pReturnDomain;
if (fChangedDomains)
{
if (HasLockInCurrentDomain())
{
if (GetAppDomain()->IsDefaultDomain() || // We should never orphan a lock in default domain.
!IsRudeAbort()) // If rudeabort, managed backout may not be run.
{
// One would like to assert that this case never occurs, but
// a rude abort can easily leave unreachable locked objects,
// which we have to allow.
STRESS_LOG2(LF_SYNC, LL_INFO1000, "Locks are orphaned while exiting a domain (enter: %d, exit: %d)\n", m_dwBeginLockCount, m_dwLockCount);
#ifdef _DEBUG
STRESS_LOG0 (LF_APPDOMAIN, LL_INFO10, "Thread::ReturnToContext Lock not released\n");
#endif
}
AppDomain *pFromDomain = GetAppDomain();
// There is a race when EE Thread for a new thread is allocated in the place of the old EE Thread.
// The lock accounting will get confused if there are orphaned locks. Set the flag that allows us to relax few asserts.
SetThreadStateNC(TSNC_UnbalancedLocks);
pFromDomain->SetOrphanedLocks();
if (!pFromDomain->IsDefaultDomain())
{
// If a Thread orphaned a lock, we don't want a host to recycle the Thread object,
// since the lock count is reset when the thread leaves this domain.
SetThreadStateNC(TSNC_CannotRecycle);
}
// It is a disaster if a lock leaks in default domain. We can never unload default domain.
// _ASSERTE (!pFromDomain->IsDefaultDomain());
EPolicyAction action = GetEEPolicy()->GetActionOnFailure(FAIL_OrphanedLock);
switch (action)
{
case eUnloadAppDomain:
if (!pFromDomain->IsDefaultDomain())
{
pFromDomain->EnableADUnloadWorker(EEPolicy::ADU_Safe);
}
break;
case eRudeUnloadAppDomain:
if (!pFromDomain->IsDefaultDomain())
{
pFromDomain->EnableADUnloadWorker(EEPolicy::ADU_Rude);
}
break;
case eExitProcess:
case eFastExitProcess:
case eRudeExitProcess:
case eDisableRuntime:
GetEEPolicy()->HandleExitProcessFromEscalation(action,HOST_E_EXITPROCESS_ADUNLOAD);
break;
default:
break;
}
}
m_dwLockCount = m_dwBeginLockCount;
m_dwBeginLockCount = pFrame->GetLockCount();
}
if (m_Context == pReturnContext)
{
_ASSERTE(m_Context->GetDomain() == pReturnContext->GetDomain());
return;
}
GCX_COOP();
LOG((LF_APPDOMAIN, LL_INFO1000, "%sThread::ReturnToContext from (%p) [%d] (count %d)\n",
FinalizerThread::IsCurrentThreadFinalizer() ? "FT: " : "",
m_Context, m_Context->GetDomain()->GetId().m_dwId,
m_Context->GetDomain()->GetThreadEnterCount()));
LOG((LF_APPDOMAIN, LL_INFO1000, " into (%p) [%d] (count %d)\n", pReturnContext,
pReturnContext->GetDomain()->GetId().m_dwId,
pReturnContext->GetDomain()->GetThreadEnterCount()));
#ifdef _DEBUG_ADUNLOAD
printf("Thread::ReturnToContext %x from (%p) [%d]\n", GetThreadId(), m_Context,
m_Context->GetDomain()->GetId(),
printf(" into (%p) [%d]\n", pReturnContext,
pReturnContext->GetDomain()->GetId(),
m_Context->GetDomain()->GetThreadEnterCount());
#endif
CantStopHolder hCantStop;
m_Context = pReturnContext;
if (fChangedDomains)
{
STRESS_LOG2(LF_APPDOMAIN, LL_INFO100000, "Returning from %d to %d\n", pADOnStack.m_dwId, pReturnContext->GetDomain()->GetId().m_dwId);
_ASSERTE(pADOnStack == m_pDomain->GetId());
_ASSERTE(pFrame);
//_ASSERTE(!fLinkFrame || pThread->GetFrame() == pFrame);
FlushIBCInfo();
// NULL out the Thread's pointer to the current ThreadLocalBlock. On the next
// access to thread static data, the Thread's pointer to the current ThreadLocalBlock
// will be updated correctly.
m_pThreadLocalBlock = NULL;
m_pDomain = pReturnDomain;
SetAppDomain(pReturnDomain);
if (pFrame == m_pUnloadBoundaryFrame)
{
m_pUnloadBoundaryFrame = NULL;
if (IsAbortRequested())
{
EEResetAbort(TAR_ADUnload);
}
ResetBeginAbortedForADUnload();
}
// Restore the last thrown object to what it was before the AD transition. Note that if
// an exception was thrown out of the AD we transitionned into, it will be raised in
// RaiseCrossContextException and the EH system will store it as the last thrown
// object if it gets handled by an EX_CATCH.
SafeSetLastThrownObject(pFrame->GetLastThrownObjectInParentContext());
}
pFrame->Pop();
if (fChangedDomains)
{
// Do this last so that thread is not labeled as out of the domain until all cleanup is done.
ADID adid=pCurrentDomain->GetId();
pCurrentDomain->ThreadExit(this, pFrame);
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
if (g_fEnableARM)
{
// Update the old AppDomain's count of processor usage by threads executing within it.
pCurrentDomain->UpdateProcessorUsage(QueryThreadProcessorUsage());
FireEtwThreadDomainEnter((ULONGLONG)this, (ULONGLONG)pReturnDomain, GetClrInstanceId());
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
}
if (fChangedDomains && IsAbortRequested() && HasLockInCurrentDomain())
{
EPolicyAction action = GetEEPolicy()->GetActionOnFailure(FAIL_CriticalResource);
// It is a disaster if a lock leaks in default domain. We can never unload default domain.
// _ASSERTE (action == eThrowException || !pReturnDomain->IsDefaultDomain());
switch (action)
{
case eUnloadAppDomain:
if (!pReturnDomain->IsDefaultDomain())
{
pReturnDomain->EnableADUnloadWorker(EEPolicy::ADU_Safe);
}
break;
case eRudeUnloadAppDomain:
if (!pReturnDomain->IsDefaultDomain())
{
pReturnDomain->EnableADUnloadWorker(EEPolicy::ADU_Rude);
}
break;
case eExitProcess:
case eFastExitProcess:
case eRudeExitProcess:
case eDisableRuntime:
GetEEPolicy()->HandleExitProcessFromEscalation(action,HOST_E_EXITPROCESS_ADUNLOAD);
break;
default:
break;
}
}
#ifdef _DEBUG_ADUNLOAD
printf("Thread::ReturnToContext %x,%8.8x pop? %d current frame is %8.8x\n", GetThreadId(), this, 1, GetFrame());
#endif
return;
}
void Thread::ReturnToContextAndThrow(ContextTransitionFrame* pFrame, EEException* pEx, BOOL* pContextSwitched)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
PRECONDITION(CheckPointer(pContextSwitched));
}
CONTRACTL_END;
#ifdef FEATURE_TESTHOOKS
ADID adid=GetAppDomain()->GetId();
#endif
ReturnToContext(pFrame);
*pContextSwitched=TRUE;
#ifdef FEATURE_TESTHOOKS
TESTHOOKCALL(LeftAppDomain(adid.m_dwId));
#endif
COMPlusThrow(CLRException::GetThrowableFromException(pEx));
}
void Thread::ReturnToContextAndOOM(ContextTransitionFrame* pFrame)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
#ifdef FEATURE_TESTHOOKS
ADID adid=GetAppDomain()->GetId();
#endif
ReturnToContext(pFrame);
#ifdef FEATURE_TESTHOOKS
TESTHOOKCALL(LeftAppDomain(adid.m_dwId));
#endif
COMPlusThrowOM();
}
void DECLSPEC_NORETURN Thread::RaiseCrossContextException(Exception* pExOrig, ContextTransitionFrame* pFrame)
{
CONTRACTL
{
THROWS;
WRAPPER(GC_TRIGGERS);
}
CONTRACTL_END;
// pEx is NULL means that the exception is CLRLastThrownObjectException
CLRLastThrownObjectException lastThrown;
Exception* pException = pExOrig ? pExOrig : &lastThrown;
COMPlusThrow(CLRException::GetThrowableFromException(pException));
}
struct FindADCallbackType {
AppDomain *pSearchDomain;
AppDomain *pPrevDomain;
Frame *pFrame;
int count;
enum TargetTransition
{fFirstTransitionInto, fMostRecentTransitionInto}
fTargetTransition;
FindADCallbackType() : pSearchDomain(NULL), pPrevDomain(NULL), pFrame(NULL)
{
LIMITED_METHOD_CONTRACT;
}
};
StackWalkAction StackWalkCallback_FindAD(CrawlFrame* pCF, void* data)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
FindADCallbackType *pData = (FindADCallbackType *)data;
Frame *pFrame = pCF->GetFrame();
if (!pFrame)
return SWA_CONTINUE;
AppDomain *pReturnDomain = pFrame->GetReturnDomain();
if (!pReturnDomain || pReturnDomain == pData->pPrevDomain)
return SWA_CONTINUE;
LOG((LF_APPDOMAIN, LL_INFO100, "StackWalkCallback_FindAD transition frame %8.8x into AD [%d]\n",
pFrame, pReturnDomain->GetId().m_dwId));
if (pData->pPrevDomain == pData->pSearchDomain) {
++pData->count;
// this is a transition into the domain we are unloading, so save it in case it is the first
pData->pFrame = pFrame;
if (pData->fTargetTransition == FindADCallbackType::fMostRecentTransitionInto)
return SWA_ABORT; // only need to find last transition, so bail now
}
pData->pPrevDomain = pReturnDomain;
return SWA_CONTINUE;
}
// This determines if a thread is running in the given domain at any point on the stack
Frame *Thread::IsRunningIn(AppDomain *pDomain, int *count)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
FindADCallbackType fct;
fct.pSearchDomain = pDomain;
if (!fct.pSearchDomain)
return FALSE;
// set prev to current so if are currently running in the target domain,
// we will detect the transition
fct.pPrevDomain = m_pDomain;
fct.fTargetTransition = FindADCallbackType::fMostRecentTransitionInto;
fct.count = 0;
// when this returns, if there is a transition into the AD, it will be in pFirstFrame
StackWalkAction res;
res = StackWalkFrames(StackWalkCallback_FindAD, (void*) &fct, ALLOW_ASYNC_STACK_WALK);
if (count)
*count = fct.count;
return fct.pFrame;
}
// This finds the very first frame on the stack where the thread transitioned into the given domain
Frame *Thread::GetFirstTransitionInto(AppDomain *pDomain, int *count)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
FindADCallbackType fct;
fct.pSearchDomain = pDomain;
// set prev to current so if are currently running in the target domain,
// we will detect the transition
fct.pPrevDomain = m_pDomain;
fct.fTargetTransition = FindADCallbackType::fFirstTransitionInto;
fct.count = 0;
// when this returns, if there is a transition into the AD, it will be in pFirstFrame
StackWalkAction res;
res = StackWalkFrames(StackWalkCallback_FindAD, (void*) &fct, ALLOW_ASYNC_STACK_WALK);
if (count)
*count = fct.count;
return fct.pFrame;
}
// Get outermost (oldest) AppDomain for this thread (not counting the default
// domain every one starts in).
AppDomain *Thread::GetInitialDomain()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
AppDomain *pDomain = m_pDomain;
AppDomain *pPrevDomain = NULL;
Frame *pFrame = GetFrame();
while (pFrame != FRAME_TOP)
{
if (pFrame->GetVTablePtr() == ContextTransitionFrame::GetMethodFrameVPtr())
{
if (pPrevDomain)
pDomain = pPrevDomain;
pPrevDomain = pFrame->GetReturnDomain();
}
pFrame = pFrame->Next();
}
return pDomain;
}
#ifndef DACCESS_COMPILE
void Thread::SetUnloadBoundaryFrame(Frame *pFrame)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE((this == GetThread() && PreemptiveGCDisabled()) ||
ThreadStore::HoldingThreadStore());
if ((ULONG_PTR)m_pUnloadBoundaryFrame < (ULONG_PTR)pFrame)
{
m_pUnloadBoundaryFrame = pFrame;
}
if (pFrame == NULL)
{
ResetBeginAbortedForADUnload();
}
}
void Thread::ResetUnloadBoundaryFrame()
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(this == GetThread() && PreemptiveGCDisabled());
m_pUnloadBoundaryFrame=NULL;
ResetBeginAbortedForADUnload();
}
#endif
BOOL Thread::ShouldChangeAbortToUnload(Frame *pFrame, Frame *pUnloadBoundaryFrame)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
if (! pUnloadBoundaryFrame)
pUnloadBoundaryFrame = GetUnloadBoundaryFrame();
// turn the abort request into an AD unloaded exception when go past the boundary.
if (pFrame != pUnloadBoundaryFrame)
return FALSE;
// Only time have an unloadboundaryframe is when have specifically marked that thread for aborting
// during unload processing, so this won't trigger UnloadedException if have simply thrown a ThreadAbort
// past an AD transition frame
_ASSERTE (IsAbortRequested());
EEResetAbort(TAR_ADUnload);
if (m_AbortType == EEPolicy::TA_None)
{
return TRUE;
}
else
{
return FALSE;
}
}
BOOL Thread::HaveExtraWorkForFinalizer()
{
LIMITED_METHOD_CONTRACT;
return m_ThreadTasks
|| OverlappedDataObject::CleanupNeededFromGC()
|| ThreadpoolMgr::HaveTimerInfosToFlush()
|| ExecutionManager::IsCacheCleanupRequired()
|| Thread::CleanupNeededForFinalizedThread()
|| (m_DetachCount > 0)
|| AppDomain::HasWorkForFinalizerThread()
|| SystemDomain::System()->RequireAppDomainCleanup()
|| ThreadStore::s_pThreadStore->ShouldTriggerGCForDeadThreads();
}
void Thread::DoExtraWorkForFinalizer()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
_ASSERTE(GetThread() == this);
_ASSERTE(this == FinalizerThread::GetFinalizerThread());
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
if (RequiresCoInitialize())
{
SetApartment(AS_InMTA, FALSE);
}
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT
if (AppDomain::HasWorkForFinalizerThread())
{
AppDomain::ProcessUnloadDomainEventOnFinalizeThread();
}
if (RequireSyncBlockCleanup())
{
#ifndef FEATURE_PAL
InteropSyncBlockInfo::FlushStandbyList();
#endif // !FEATURE_PAL
#ifdef FEATURE_COMINTEROP
RCW::FlushStandbyList();
#endif // FEATURE_COMINTEROP
SyncBlockCache::GetSyncBlockCache()->CleanupSyncBlocks();
}
if (SystemDomain::System()->RequireAppDomainCleanup())
{
SystemDomain::System()->ProcessDelayedUnloadDomains();
}
if(m_DetachCount > 0 || Thread::CleanupNeededForFinalizedThread())
{
Thread::CleanupDetachedThreads();
}
if(ExecutionManager::IsCacheCleanupRequired() && GCHeapUtilities::GetGCHeap()->GetCondemnedGeneration()>=1)
{
ExecutionManager::ClearCaches();
}
OverlappedDataObject::RequestCleanupFromGC();
// If there were any TimerInfos waiting to be released, they'll get flushed now
ThreadpoolMgr::FlushQueueOfTimerInfos();
ThreadStore::s_pThreadStore->TriggerGCForDeadThreadsIfNecessary();
}
// HELPERS FOR THE BASE OF A MANAGED THREAD, INCLUDING AD TRANSITION SUPPORT
// We have numerous places where we start up a managed thread. This includes several places in the
// ThreadPool, the 'new Thread(...).Start()' case, and the Finalizer. Try to factor the code so our
// base exception handling behavior is consistent across those places. The resulting code is convoluted,
// but it's better than the prior situation of each thread being on a different plan.
// We need Middle & Outer methods for the usual problem of combining C++ & SEH.
/* The effect of all this is that we get:
Base of thread -- OS unhandled exception filter that we hook
SEH handler from DispatchOuter
C++ handler from DispatchMiddle
And if there is an AppDomain transition before we call back to user code, we additionally get:
AppDomain transition -- contains its own handlers to terminate the first pass
and marshal the exception.
SEH handler from DispatchOuter
C++ handler from DispatchMiddle
Regardless of whether or not there is an AppDomain transition, we then have:
User code that obviously can throw.
So if we don't have an AD transition, or we take a fault before we successfully transition the
AppDomain, then the base-most DispatchOuter/Middle will deal with the exception. This may
involve swallowing exceptions or it may involve Watson & debugger attach. It will always
involve notifications to any AppDomain.UnhandledException event listeners.
But if we did transition the AppDomain, then any Watson, debugger attach and UnhandledException
events will occur in that AppDomain in the initial first pass. So we get a good debugging
experience and we get notifications to the host that show which AppDomain is allowing exceptions
to go unhandled (so perhaps it can be unloaded or otherwise dealt with).
The trick is that if the exception goes unhandled at the process level, we would normally try
to fire AppDomain events and display the faulting exception on the console from two more
places. These are the base-most DispatchOuter/Middle pair and the hook of the OS unhandled
exception handler at the base of the thread.
This is redundant and messy. (There's no concern with getting a 2nd Watson because we only
do one of these per process anyway). The solution for the base-most DispatchOuter/Middle is
to use the ManagedThreadCallState.flags to control whether the exception has already been
dealt with or not. These flags cause the ThreadBaseRedirectingFilter to either do normal
"base of the thread" exception handling, or to ignore the exception because it has already
been reported in the AppDomain we transitioned to.
But turning off the reporting in the OS unhandled exception filter is harder. We don't want
to flip a bit on the Thread to disable this, unless we can be sure we are only disabling
something we already reported, and that this thread will never recover from that situation and
start executing code again. Here's the normal nightmare scenario with SEH:
1) exception of type A is thrown
2) All the filters in the 1st pass say they don't want an A
3) The exception gets all the way out and is considered unhandled. We report this "fact".
4) Imagine we then set a bit that says this thread shouldn't report unhandled exceptions.
5) The 2nd pass starts.
6) Inside a finally, someone throws an exception of type B.
7) A new 1st pass starts from the point of the throw, with a type B.
8) Now a filter says "Yes, I will swallow exception B."
9) We no longer have an unhandled exception, and execution continues merrily.
This is an unavoidable consequence of the 2-pass model. If you report unhandled exceptions
in the 1st pass (for good debugging), you might find that this was premature and you don't
have an unhandled exception when you get to the 2nd pass.
But it would not be optimal if in step 4 we set a bit that says we should suppress normal
notifications and reporting on this thread, believing that the process will terminate.
The solution is to recognize that the base OS unhandled exception filter runs in two modes.
In the first mode, it operates as today and serves as our backstop. In the second mode
it is fully redundant with the handlers pushed after the AppDomain transition, which are
completely containing the exception to the AD that it occurred in (for purposes of reporting).
So we just need a flag on the thread that says whether or not that set of handlers are pushed
and functioning. That flag enables / disables the base exception reporting and is called
TSNC_AppDomainContainUnhandled
*/
enum ManagedThreadCallStateFlags
{
MTCSF_NormalBase,
MTCSF_ContainToAppDomain,
MTCSF_SuppressDuplicate,
};
struct ManagedThreadCallState
{
ADID pAppDomainId;
AppDomain* pUnsafeAppDomain;
BOOL bDomainIsAsID;
Context::ADCallBackFcnType pTarget;
LPVOID args;
UnhandledExceptionLocation filterType;
ManagedThreadCallStateFlags flags;
BOOL IsAppDomainEqual(AppDomain* pApp)
{
LIMITED_METHOD_CONTRACT;
return bDomainIsAsID?(pApp->GetId()==pAppDomainId):(pUnsafeAppDomain==pApp);
}
ManagedThreadCallState(ADID AppDomainId,Context::ADCallBackFcnType Target,LPVOID Args,
UnhandledExceptionLocation FilterType, ManagedThreadCallStateFlags Flags):
pAppDomainId(AppDomainId),
pUnsafeAppDomain(NULL),
bDomainIsAsID(TRUE),
pTarget(Target),
args(Args),
filterType(FilterType),
flags(Flags)
{
LIMITED_METHOD_CONTRACT;
};
protected:
ManagedThreadCallState(AppDomain* AppDomain,Context::ADCallBackFcnType Target,LPVOID Args,
UnhandledExceptionLocation FilterType, ManagedThreadCallStateFlags Flags):
pAppDomainId(ADID(0)),
pUnsafeAppDomain(AppDomain),
bDomainIsAsID(FALSE),
pTarget(Target),
args(Args),
filterType(FilterType),
flags(Flags)
{
LIMITED_METHOD_CONTRACT;
};
void InitForFinalizer(AppDomain* AppDomain,Context::ADCallBackFcnType Target,LPVOID Args)
{
LIMITED_METHOD_CONTRACT;
filterType=FinalizerThread;
pUnsafeAppDomain=AppDomain;
pTarget=Target;
args=Args;
};
friend void ManagedThreadBase_NoADTransition(Context::ADCallBackFcnType pTarget,
UnhandledExceptionLocation filterType);
friend void ManagedThreadBase::FinalizerAppDomain(AppDomain* pAppDomain,
Context::ADCallBackFcnType pTarget,
LPVOID args,
ManagedThreadCallState *pTurnAround);
};
// The following static helpers are outside of the ManagedThreadBase struct because I
// don't want to change threads.h whenever I change the mechanism for how unhandled
// exceptions works. The ManagedThreadBase struct is for the public exposure of the
// API only.
static void ManagedThreadBase_DispatchOuter(ManagedThreadCallState *pCallState);
// Here's the tricky part. *IF and only IF* we took an AppDomain transition at the base, then we
// now want to push another complete set of handlers above us. The reason is that we want the
// Watson report and the unhandled exception event to occur in the target AppDomain. If we don't
// do this apparently redundant push of handlers, then we will marshal back the exception to the
// handlers on the Default AppDomain side. This will erase all the important exception state by
// unwinding (catch and rethrow) in DoADCallBack. And it will cause all unhandled exceptions to
// be reported from the Default AppDomain, which is annoying to any AppDomain.UnhandledException
// event listeners.
//
// So why not skip the handlers that are in the Default AppDomain and just push the ones after the
// transition? Well, transitioning out of the Default AppDomain into the target AppDomain could
// fail. We need handlers pushed for that case. And in that case it's perfectly reasonable to
// report the problem as occurring in the Default AppDomain, which is what the base handlers will
// do.
static void ManagedThreadBase_DispatchInCorrectAD(LPVOID args)
{
CONTRACTL
{
GC_TRIGGERS;
THROWS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
ManagedThreadCallState *pCallState = (ManagedThreadCallState *) args;
// Ensure we aren't going to infinitely recurse.
_ASSERTE(pCallState->IsAppDomainEqual(GetThread()->GetDomain()));
// And then go round one more time. But this time we want to ensure that the filter contains
// any exceptions that aren't swallowed. These must be treated as unhandled, rather than
// propagated through the AppDomain boundary in search of an outer handler. Otherwise we
// will not get correct Watson behavior.
pCallState->flags = MTCSF_ContainToAppDomain;
ManagedThreadBase_DispatchOuter(pCallState);
pCallState->flags = MTCSF_NormalBase;
}
static void ManagedThreadBase_DispatchInner(ManagedThreadCallState *pCallState)
{
CONTRACTL
{
GC_TRIGGERS;
THROWS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
Thread *pThread = GetThread();
if (!pCallState->IsAppDomainEqual(pThread->GetDomain()))
{
// On Win7 and later, AppDomain transitions at the threadbase will *not* have EH setup at transition boundary.
// This implies that an unhandled exception from the base domain (i.e. AD in which the thread starts) will
// not return to DefDomain but will continue to go up the stack with the thread still being in base domain.
// We have a holder in ENTER_DOMAIN_*_NO_EH_AT_TRANSITION macro (ReturnToPreviousAppDomainHolder) that will
// revert AD context at threadbase if an unwind is triggered after the exception has gone unhandled.
//
// This also implies that there will be no exception object marshalling (and it may not be required after all)
// as well and once the holder reverts the AD context, the LastThrownObject in Thread will be set to NULL.
#ifndef FEATURE_PAL
BOOL fSetupEHAtTransition = !(RunningOnWin7());
#else // !FEATURE_PAL
BOOL fSetupEHAtTransition = TRUE;
#endif // !FEATURE_PAL
if (pCallState->bDomainIsAsID)
pThread->DoADCallBack(pCallState->pAppDomainId,
ManagedThreadBase_DispatchInCorrectAD,
pCallState, fSetupEHAtTransition);
else
pThread->DoADCallBack(pCallState->pUnsafeAppDomain,
ManagedThreadBase_DispatchInCorrectAD,
pCallState, ADV_FINALIZER, fSetupEHAtTransition);
}
else
{
// Since no AppDomain transition is necessary, we need no additional handlers pushed
// *AFTER* the transition. We now have adequate handlers below us. Go ahead and
// dispatch the call.
(*pCallState->pTarget) (pCallState->args);
}
}
static void ManagedThreadBase_DispatchMiddle(ManagedThreadCallState *pCallState)
{
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_MODE_COOPERATIVE;
STATIC_CONTRACT_SO_TOLERANT;
// We have the probe outside the EX_TRY below since corresponding EX_CATCH
// also invokes SO_INTOLERANT code.
BEGIN_SO_INTOLERANT_CODE(GetThread());
EX_TRY_CPP_ONLY
{
// During an unwind, we have some cleanup:
//
// 1) We should no longer suppress any unhandled exception reporting at the base
// of the thread, because any handler that contained the exception to the AppDomain
// where it occurred is now being removed from the stack.
//
// 2) We need to unwind the Frame chain. We cannot do it when we get to the __except clause
// because at this point we are in the 2nd phase and the stack has been popped. Any
// stack crawling from another thread will see a frame chain in a popped region of stack.
// Nor can we pop it in a filter, since this would destroy all the stack-walking information
// we need to perform the 2nd pass. So doing it in a C++ destructor will ensure it happens
// during the 2nd pass but before the stack is actually popped.
class Cleanup
{
Frame *m_pEntryFrame;
Thread *m_pThread;
public:
Cleanup(Thread* pThread)
{
m_pThread = pThread;
m_pEntryFrame = pThread->m_pFrame;
}
~Cleanup()
{
GCX_COOP();
m_pThread->SetFrame(m_pEntryFrame);
m_pThread->ResetThreadStateNC(Thread::TSNC_AppDomainContainUnhandled);
}
};
Cleanup cleanup(GetThread());
ManagedThreadBase_DispatchInner(pCallState);
}
EX_CATCH_CPP_ONLY
{
GCX_COOP();
Exception *pException = GET_EXCEPTION();
// RudeThreadAbort is a pre-allocated instance of ThreadAbort. So the following is sufficient.
// For Whidbey, by default only swallow certain exceptions. If reverting back to Everett's
// behavior (swallowing all unhandled exception), then swallow all unhandled exception.
//
if (SwallowUnhandledExceptions() ||
IsExceptionOfType(kThreadAbortException, pException) ||
IsExceptionOfType(kAppDomainUnloadedException, pException))
{
// Do nothing to swallow the exception
}
else
{
// Setting up the unwind_and_continue_handler ensures that C++ exceptions do not leak out.
// An example is when Thread1 in Default AppDomain creates AppDomain2, enters it, creates
// another thread T2 and T2 throws OOM exception (that goes unhandled). At the transition
// boundary, END_DOMAIN_TRANSITION will catch it and invoke RaiseCrossContextException
// that will rethrow the OOM as a C++ exception.
//
// Without unwind_and_continue_handler below, the exception will fly up the stack to
// this point, where it will be rethrown and thus leak out.
INSTALL_UNWIND_AND_CONTINUE_HANDLER;
EX_RETHROW;
UNINSTALL_UNWIND_AND_CONTINUE_HANDLER;
}
}
EX_END_CATCH(SwallowAllExceptions);
END_SO_INTOLERANT_CODE;
}
/*
typedef struct Param
{
ManagedThreadCallState * m_pCallState;
Frame * m_pFrame;
Param(ManagedThreadCallState * pCallState, Frame * pFrame): m_pCallState(pCallState), m_pFrame(pFrame) {}
} TryParam;
*/
typedef struct Param: public NotifyOfCHFFilterWrapperParam
{
ManagedThreadCallState * m_pCallState;
Param(ManagedThreadCallState * pCallState): m_pCallState(pCallState) {}
} TryParam;
// Dispatch to the appropriate filter, based on the active CallState.
static LONG ThreadBaseRedirectingFilter(PEXCEPTION_POINTERS pExceptionInfo, LPVOID pParam)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_ANY;
LONG (*ptrFilter) (PEXCEPTION_POINTERS, PVOID);
TryParam * pRealParam = reinterpret_cast<TryParam *>(pParam);
ManagedThreadCallState * _pCallState = pRealParam->m_pCallState;
ManagedThreadCallStateFlags flags = _pCallState->flags;
if (flags == MTCSF_SuppressDuplicate)
{
LOG((LF_EH, LL_INFO100, "ThreadBaseRedirectingFilter: setting TSNC_AppDomainContainUnhandled\n"));
GetThread()->SetThreadStateNC(Thread::TSNC_AppDomainContainUnhandled);
return EXCEPTION_CONTINUE_SEARCH;
}
LONG ret = -1;
BEGIN_SO_INTOLERANT_CODE_NO_THROW_CHECK_THREAD(return EXCEPTION_CONTINUE_SEARCH;);
// This will invoke the swallowing filter. If that returns EXCEPTION_CONTINUE_SEARCH,
// it will trigger unhandled exception processing.
ptrFilter = ThreadBaseExceptionAppDomainFilter;
// WARNING - ptrFilter may not return
// This occurs when the debugger decides to intercept an exception and catch it in a frame closer
// to the leaf than the one executing this filter
ret = (*ptrFilter) (pExceptionInfo, _pCallState);
// Although EXCEPTION_EXECUTE_HANDLER can also be returned in cases corresponding to
// unhandled exceptions, all of those cases have already notified the debugger of an unhandled
// exception which prevents a second notification indicating the exception was caught
if (ret == EXCEPTION_EXECUTE_HANDLER)
{
// WARNING - NotifyOfCHFFilterWrapper may not return
// This occurs when the debugger decides to intercept an exception and catch it in a frame closer
// to the leaf than the one executing this filter
NotifyOfCHFFilterWrapper(pExceptionInfo, pRealParam);
}
// If we are containing unhandled exceptions to the AppDomain we transitioned into, and the
// exception is coming out, then this exception is going unhandled. We have already done
// Watson and managed events, so suppress all filters below us. Otherwise we are swallowing
// it and returning out of the AppDomain.
if (flags == MTCSF_ContainToAppDomain)
{
if(ret == EXCEPTION_CONTINUE_SEARCH)
{
_pCallState->flags = MTCSF_SuppressDuplicate;
}
else if(ret == EXCEPTION_EXECUTE_HANDLER)
{
_pCallState->flags = MTCSF_NormalBase;
}
// else if( EXCEPTION_CONTINUE_EXECUTION ) do nothing
}
// Get the reference to the current thread..
Thread *pCurThread = GetThread();
_ASSERTE(pCurThread);
if (flags == MTCSF_ContainToAppDomain)
{
if (((ManagedThreadCallState *) _pCallState)->flags == MTCSF_SuppressDuplicate)
{
// Set the flag that we have done unhandled exception processing
// for this managed thread that started in a non-default domain
LOG((LF_EH, LL_INFO100, "ThreadBaseRedirectingFilter: setting TSNC_AppDomainContainUnhandled\n"));
pCurThread->SetThreadStateNC(Thread::TSNC_AppDomainContainUnhandled);
}
}
else
{
_ASSERTE(flags == MTCSF_NormalBase);
if(!IsSingleAppDomain())
{
// This assert shouldnt be hit in CoreCLR since:
//
// 1) It has no concept of managed entry point that is invoked by the shim. You can
// only run managed code via hosting APIs that will run code in non-default domains.
//
// 2) Managed threads cannot be created in DefaultDomain since no user code executes
// in default domain.
//
// So, if this is hit, something is not right!
_ASSERTE(!"How come a managed thread in CoreCLR has suffered unhandled exception in DefaultDomain?");
}
LOG((LF_EH, LL_INFO100, "ThreadBaseRedirectingFilter: setting TSNC_ProcessedUnhandledException\n"));
//
// In the default domain, when an exception goes unhandled on a managed thread whose threadbase is in the VM (e.g. explicitly spawned threads,
// ThreadPool threads, finalizer thread, etc), CLR can end up in the unhandled exception processing path twice.
//
// The first attempt to perform UE processing happens at the managed thread base (via this function). When it completes,
// we will set TSNC_ProcessedUnhandledException state against the thread to indicate that we have perform the unhandled exception processing.
//
// On the desktop CLR, after the first attempt, we will return back to the OS with EXCEPTION_CONTINUE_SEARCH as unhandled exceptions cannot be swallowed. When the exception reaches
// the native threadbase in the OS kernel, the OS will invoke the UEF registered for the process. This can result in CLR's UEF (COMUnhandledExceptionFilter)
// getting invoked that will attempt to perform UE processing yet again for the same thread. To avoid this duplicate processing, we check the presence of
// TSNC_ProcessedUnhandledException state on the thread and if present, we simply return back to the OS.
//
// On desktop CoreCLR, we will only do UE processing once (at the managed threadbase) since no thread is created in default domain - all are created and executed in non-default domain.
// As a result, we go via completely different codepath that prevents duplication of UE processing from happening, especially since desktop CoreCLR is targetted for SL and SL
// always passes us a flag to swallow unhandled exceptions.
//
// On CoreSys CoreCLR, the host can ask CoreCLR to run all code in the default domain. As a result, when we return from the first attempt to perform UE
// processing, the call could return back with EXCEPTION_EXECUTE_HANDLER since, like desktop CoreCLR is instructed by SL host to swallow all unhandled exceptions,
// CoreSys CoreCLR can also be instructed by its Phone host to swallow all unhandled exceptions. As a result, the exception dispatch will never continue to go upstack
// to the native threadbase in the OS kernel and thus, there will never be a second attempt to perform UE processing. Hence, we dont, and shouldnt, need to set
// TSNC_ProcessedUnhandledException state against the thread if we are in SingleAppDomain mode and have been asked to swallow the exception.
//
// If we continue to set TSNC_ProcessedUnhandledException and a ThreadPool Thread A has an exception go unhandled, we will swallow it correctly for the first time.
// The next time Thread A has an exception go unhandled, our UEF will see TSNC_ProcessedUnhandledException set and assume (incorrectly) UE processing has happened and
// will fail to honor the host policy (e.g. swallow unhandled exception). Thus, the 2nd unhandled exception may end up crashing the app when it should not.
//
if (IsSingleAppDomain() && (ret != EXCEPTION_EXECUTE_HANDLER))
{
// Since we have already done unhandled exception processing for it, we dont want it
// to happen again if our UEF gets invoked upon returning back to the OS.
//
// Set the flag to indicate so.
pCurThread->SetThreadStateNC(Thread::TSNC_ProcessedUnhandledException);
}
}
END_SO_INTOLERANT_CODE;
return ret;
}
static void ManagedThreadBase_DispatchOuter(ManagedThreadCallState *pCallState)
{
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_MODE_COOPERATIVE;
// HasStarted() must have already been performed by our caller
_ASSERTE(GetThread() != NULL);
Thread *pThread = GetThread();
#ifdef WIN64EXCEPTIONS
Frame *pFrame = pThread->m_pFrame;
#endif // WIN64EXCEPTIONS
// The sole purpose of having this frame is to tell the debugger that we have a catch handler here
// which may swallow managed exceptions. The debugger needs this in order to send a
// CatchHandlerFound (CHF) notification.
FrameWithCookie<DebuggerU2MCatchHandlerFrame> catchFrame;
TryParam param(pCallState);
param.pFrame = &catchFrame;
struct TryArgs
{
TryParam *pTryParam;
Thread *pThread;
BOOL *pfHadException;
#ifdef WIN64EXCEPTIONS
Frame *pFrame;
#endif // WIN64EXCEPTIONS
}args;
args.pTryParam = ¶m;
args.pThread = pThread;
BOOL fHadException = TRUE;
args.pfHadException = &fHadException;
#ifdef WIN64EXCEPTIONS
args.pFrame = pFrame;
#endif // WIN64EXCEPTIONS
PAL_TRY(TryArgs *, pArgs, &args)
{
PAL_TRY(TryParam *, pParam, pArgs->pTryParam)
{
ManagedThreadBase_DispatchMiddle(pParam->m_pCallState);
}
PAL_EXCEPT_FILTER(ThreadBaseRedirectingFilter)
{
// Note: one of our C++ exceptions will never reach this filter because they're always caught by
// the EX_CATCH in ManagedThreadBase_DispatchMiddle().
//
// If eCLRDeterminedPolicy, we only swallow for TA, RTA, and ADU exception.
// For eHostDeterminedPolicy, we will swallow all the managed exception.
#ifdef WIN64EXCEPTIONS
// this must be done after the second pass has run, it does not
// reference anything on the stack, so it is safe to run in an
// SEH __except clause as well as a C++ catch clause.
ExceptionTracker::PopTrackers(pArgs->pFrame);
#endif // WIN64EXCEPTIONS
// Fortunately, ThreadAbortExceptions are always
if (pArgs->pThread->IsAbortRequested())
pArgs->pThread->EEResetAbort(Thread::TAR_Thread);
}
PAL_ENDTRY;
*(pArgs->pfHadException) = FALSE;
}
PAL_FINALLY
{
// If we had a breakpoint exception that has gone unhandled,
// then switch to the correct AD context. Its fine to do this
// here because:
//
// 1) We are in an unwind (this is a C++ destructor).
// 2) SetFrame (below) does validation to be in the correct AD context. Thus,
// this should be done before that.
if (fHadException && (GetCurrentExceptionCode() == STATUS_BREAKPOINT))
{
ReturnToPreviousAppDomain();
}
catchFrame.Pop();
}
PAL_ENDTRY;
}
// For the implementation, there are three variants of work possible:
// 1. Establish the base of a managed thread, and switch to the correct AppDomain.
static void ManagedThreadBase_FullTransitionWithAD(ADID pAppDomain,
Context::ADCallBackFcnType pTarget,
LPVOID args,
UnhandledExceptionLocation filterType)
{
CONTRACTL
{
GC_TRIGGERS;
THROWS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
ManagedThreadCallState CallState(pAppDomain, pTarget, args, filterType, MTCSF_NormalBase);
ManagedThreadBase_DispatchOuter(&CallState);
}
// 2. Establish the base of a managed thread, but the AppDomain transition must be
// deferred until later.
void ManagedThreadBase_NoADTransition(Context::ADCallBackFcnType pTarget,
UnhandledExceptionLocation filterType)
{
CONTRACTL
{
GC_TRIGGERS;
THROWS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
AppDomain *pAppDomain = GetAppDomain();
ManagedThreadCallState CallState(pAppDomain, pTarget, NULL, filterType, MTCSF_NormalBase);
// self-describing, to create a pTurnAround data for eventual delivery to a subsequent AppDomain
// transition.
CallState.args = &CallState;
ManagedThreadBase_DispatchOuter(&CallState);
}
// And here are the various exposed entrypoints for base thread behavior
// The 'new Thread(...).Start()' case from COMSynchronizable kickoff thread worker
void ManagedThreadBase::KickOff(ADID pAppDomain, Context::ADCallBackFcnType pTarget, LPVOID args)
{
WRAPPER_NO_CONTRACT;
ManagedThreadBase_FullTransitionWithAD(pAppDomain, pTarget, args, ManagedThread);
}
// The IOCompletion, QueueUserWorkItem, AddTimer, RegisterWaitForSingleObject cases in the ThreadPool
void ManagedThreadBase::ThreadPool(ADID pAppDomain, Context::ADCallBackFcnType pTarget, LPVOID args)
{
WRAPPER_NO_CONTRACT;
ManagedThreadBase_FullTransitionWithAD(pAppDomain, pTarget, args, ThreadPoolThread);
}
// The Finalizer thread establishes exception handling at its base, but defers all the AppDomain
// transitions.
void ManagedThreadBase::FinalizerBase(Context::ADCallBackFcnType pTarget)
{
WRAPPER_NO_CONTRACT;
ManagedThreadBase_NoADTransition(pTarget, FinalizerThread);
}
void ManagedThreadBase::FinalizerAppDomain(AppDomain *pAppDomain,
Context::ADCallBackFcnType pTarget,
LPVOID args,
ManagedThreadCallState *pTurnAround)
{
WRAPPER_NO_CONTRACT;
pTurnAround->InitForFinalizer(pAppDomain,pTarget,args);
_ASSERTE(pTurnAround->flags == MTCSF_NormalBase);
ManagedThreadBase_DispatchInner(pTurnAround);
}
//+----------------------------------------------------------------------------
//
// Method: Thread::GetStaticFieldAddress private
//
// Synopsis: Get the address of the field relative to the current thread.
// If an address has not been assigned yet then create one.
//
//+----------------------------------------------------------------------------
LPVOID Thread::GetStaticFieldAddress(FieldDesc *pFD)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
_ASSERTE(pFD != NULL);
_ASSERTE(pFD->IsThreadStatic());
_ASSERTE(!pFD->IsRVA());
// for static field the MethodTable is exact even for generic classes
MethodTable *pMT = pFD->GetEnclosingMethodTable();
// We need to make sure that the class has been allocated, however
// we should not call the class constructor
ThreadStatics::GetTLM(pMT)->EnsureClassAllocated(pMT);
PTR_BYTE base = NULL;
if (pFD->GetFieldType() == ELEMENT_TYPE_CLASS ||
pFD->GetFieldType() == ELEMENT_TYPE_VALUETYPE)
{
base = pMT->GetGCThreadStaticsBasePointer();
}
else
{
base = pMT->GetNonGCThreadStaticsBasePointer();
}
_ASSERTE(base != NULL);
DWORD offset = pFD->GetOffset();
_ASSERTE(offset <= FIELD_OFFSET_LAST_REAL_OFFSET);
LPVOID result = (LPVOID)((PTR_BYTE)base + (DWORD)offset);
// For value classes, the handle points at an OBJECTREF
// which holds the boxed value class, so derefernce and unbox.
if (pFD->GetFieldType() == ELEMENT_TYPE_VALUETYPE)
{
OBJECTREF obj = ObjectToOBJECTREF(*(Object**) result);
result = obj->GetData();
}
return result;
}
#endif // #ifndef DACCESS_COMPILE
//+----------------------------------------------------------------------------
//
// Method: Thread::GetStaticFieldAddrNoCreate private
//
// Synopsis: Get the address of the field relative to the thread.
// If an address has not been assigned, return NULL.
// No creating is allowed.
//
//+----------------------------------------------------------------------------
TADDR Thread::GetStaticFieldAddrNoCreate(FieldDesc *pFD, PTR_AppDomain pDomain)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SUPPORTS_DAC;
}
CONTRACTL_END;
_ASSERTE(pFD != NULL);
_ASSERTE(pFD->IsThreadStatic());
// for static field the MethodTable is exact even for generic classes
PTR_MethodTable pMT = pFD->GetEnclosingMethodTable();
PTR_BYTE base = NULL;
if (pFD->GetFieldType() == ELEMENT_TYPE_CLASS ||
pFD->GetFieldType() == ELEMENT_TYPE_VALUETYPE)
{
base = pMT->GetGCThreadStaticsBasePointer(dac_cast<PTR_Thread>(this), pDomain);
}
else
{
base = pMT->GetNonGCThreadStaticsBasePointer(dac_cast<PTR_Thread>(this), pDomain);
}
if (base == NULL)
return NULL;
DWORD offset = pFD->GetOffset();
_ASSERTE(offset <= FIELD_OFFSET_LAST_REAL_OFFSET);
TADDR result = dac_cast<TADDR>(base) + (DWORD)offset;
// For value classes, the handle points at an OBJECTREF
// which holds the boxed value class, so derefernce and unbox.
if (pFD->IsByValue())
{
_ASSERTE(result != NULL);
PTR_Object obj = *PTR_UNCHECKED_OBJECTREF(result);
if (obj == NULL)
return NULL;
result = dac_cast<TADDR>(obj->GetData());
}
return result;
}
#ifndef DACCESS_COMPILE
//
// NotifyFrameChainOfExceptionUnwind
// -----------------------------------------------------------
// This method will walk the Frame chain from pStartFrame to
// the last frame that is below pvLimitSP and will call each
// frame's ExceptionUnwind method. It will return the first
// Frame that is above pvLimitSP.
//
Frame * Thread::NotifyFrameChainOfExceptionUnwind(Frame* pStartFrame, LPVOID pvLimitSP)
{
CONTRACTL
{
NOTHROW;
DISABLED(GC_TRIGGERS); // due to UnwindFrameChain from NOTRIGGER areas
MODE_COOPERATIVE;
PRECONDITION(CheckPointer(pStartFrame));
PRECONDITION(CheckPointer(pvLimitSP));
}
CONTRACTL_END;
Frame * pFrame;
#ifdef _DEBUG
//
// assert that the specified Thread's Frame chain actually
// contains the start Frame.
//
pFrame = m_pFrame;
while ((pFrame != pStartFrame) &&
(pFrame != FRAME_TOP))
{
pFrame = pFrame->Next();
}
CONSISTENCY_CHECK_MSG(pFrame == pStartFrame, "pStartFrame is not on pThread's Frame chain!");
#endif // _DEBUG
pFrame = pStartFrame;
while (pFrame < pvLimitSP)
{
CONSISTENCY_CHECK(pFrame != PTR_NULL);
CONSISTENCY_CHECK((pFrame) > static_cast<Frame *>((LPVOID)GetCurrentSP()));
pFrame->ExceptionUnwind();
pFrame = pFrame->Next();
}
// return the frame after the last one notified of the unwind
return pFrame;
}
//+----------------------------------------------------------------------------
//
// Method: Thread::DeleteThreadStaticData private
//
// Synopsis: Delete the static data for each appdomain that this thread
// visited.
//
//
//+----------------------------------------------------------------------------
void Thread::DeleteThreadStaticData()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// Deallocate the memory used by the table of ThreadLocalBlocks
if (m_pTLBTable != NULL)
{
for (SIZE_T i = 0; i < m_TLBTableSize; ++i)
{
ThreadLocalBlock * pTLB = m_pTLBTable[i];
if (pTLB != NULL)
{
m_pTLBTable[i] = NULL;
pTLB->FreeTable();
delete pTLB;
}
}
delete m_pTLBTable;
m_pTLBTable = NULL;
}
m_pThreadLocalBlock = NULL;
m_TLBTableSize = 0;
}
//+----------------------------------------------------------------------------
//
// Method: Thread::DeleteThreadStaticData protected
//
// Synopsis: Delete the static data for the given appdomain. This is called
// when the appdomain unloads.
//
//
//+----------------------------------------------------------------------------
void Thread::DeleteThreadStaticData(AppDomain *pDomain)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// Look up the AppDomain index
SIZE_T index = pDomain->GetIndex().m_dwIndex;
ThreadLocalBlock * pTLB = NULL;
// NULL out the pointer to the ThreadLocalBlock
if (index < m_TLBTableSize)
{
pTLB = m_pTLBTable[index];
m_pTLBTable[index] = NULL;
}
if (pTLB != NULL)
{
// Since the AppDomain is being unloaded anyway, all the memory used by
// the TLB will be reclaimed, so we don't really have to call FreeTable()
pTLB->FreeTable();
delete pTLB;
}
}
void Thread::InitCultureAccessors()
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
}
CONTRACTL_END;
OBJECTREF *pCurrentCulture = NULL;
Thread *pThread = GetThread();
GCX_COOP();
if (managedThreadCurrentCulture == NULL) {
managedThreadCurrentCulture = MscorlibBinder::GetField(FIELD__THREAD__CULTURE);
pCurrentCulture = (OBJECTREF*)pThread->GetStaticFieldAddress(managedThreadCurrentCulture);
}
if (managedThreadCurrentUICulture == NULL) {
managedThreadCurrentUICulture = MscorlibBinder::GetField(FIELD__THREAD__UI_CULTURE);
pCurrentCulture = (OBJECTREF*)pThread->GetStaticFieldAddress(managedThreadCurrentUICulture);
}
}
ARG_SLOT Thread::CallPropertyGet(BinderMethodID id, OBJECTREF pObject)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
if (!pObject) {
return 0;
}
ARG_SLOT retVal;
GCPROTECT_BEGIN(pObject);
MethodDescCallSite propGet(id, &pObject);
// Set up the Stack.
ARG_SLOT pNewArgs = ObjToArgSlot(pObject);
// Make the actual call.
retVal = propGet.Call_RetArgSlot(&pNewArgs);
GCPROTECT_END();
return retVal;
}
ARG_SLOT Thread::CallPropertySet(BinderMethodID id, OBJECTREF pObject, OBJECTREF pValue)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
if (!pObject) {
return 0;
}
ARG_SLOT retVal;
GCPROTECT_BEGIN(pObject);
GCPROTECT_BEGIN(pValue);
MethodDescCallSite propSet(id, &pObject);
// Set up the Stack.
ARG_SLOT pNewArgs[] = {
ObjToArgSlot(pObject),
ObjToArgSlot(pValue)
};
// Make the actual call.
retVal = propSet.Call_RetArgSlot(pNewArgs);
GCPROTECT_END();
GCPROTECT_END();
return retVal;
}
OBJECTREF Thread::GetCulture(BOOL bUICulture)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
FieldDesc * pFD;
_ASSERTE(PreemptiveGCDisabled());
// This is the case when we're building mscorlib and haven't yet created
// the system assembly.
if (SystemDomain::System()->SystemAssembly()==NULL || g_fForbidEnterEE) {
return NULL;
}
// Get the actual thread culture.
OBJECTREF pCurThreadObject = GetExposedObject();
_ASSERTE(pCurThreadObject!=NULL);
THREADBASEREF pThreadBase = (THREADBASEREF)(pCurThreadObject);
OBJECTREF pCurrentCulture = bUICulture ? pThreadBase->GetCurrentUICulture() : pThreadBase->GetCurrentUserCulture();
if (pCurrentCulture==NULL) {
GCPROTECT_BEGIN(pThreadBase);
if (bUICulture) {
// Call the Getter for the CurrentUICulture. This will cause it to populate the field.
ARG_SLOT retVal = CallPropertyGet(METHOD__THREAD__GET_UI_CULTURE,
(OBJECTREF)pThreadBase);
pCurrentCulture = ArgSlotToObj(retVal);
} else {
//This is faster than calling the property, because this is what the call does anyway.
pFD = MscorlibBinder::GetField(FIELD__CULTURE_INFO__CURRENT_CULTURE);
_ASSERTE(pFD);
pFD->CheckRunClassInitThrowing();
pCurrentCulture = pFD->GetStaticOBJECTREF();
_ASSERTE(pCurrentCulture!=NULL);
}
GCPROTECT_END();
}
return pCurrentCulture;
}
// copy culture name into szBuffer and return length
int Thread::GetParentCultureName(__out_ecount(length) LPWSTR szBuffer, int length, BOOL bUICulture)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
// This is the case when we're building mscorlib and haven't yet created
// the system assembly.
if (SystemDomain::System()->SystemAssembly()==NULL) {
const WCHAR *tempName = W("en");
INT32 tempLength = (INT32)wcslen(tempName);
_ASSERTE(length>=tempLength);
memcpy(szBuffer, tempName, tempLength*sizeof(WCHAR));
return tempLength;
}
ARG_SLOT Result = 0;
INT32 retVal=0;
WCHAR *buffer=NULL;
INT32 bufferLength=0;
STRINGREF cultureName = NULL;
GCX_COOP();
struct _gc {
OBJECTREF pCurrentCulture;
OBJECTREF pParentCulture;
} gc;
ZeroMemory(&gc, sizeof(gc));
GCPROTECT_BEGIN(gc);
gc.pCurrentCulture = GetCulture(bUICulture);
if (gc.pCurrentCulture != NULL) {
Result = CallPropertyGet(METHOD__CULTURE_INFO__GET_PARENT, gc.pCurrentCulture);
}
if (Result) {
gc.pParentCulture = (OBJECTREF)(ArgSlotToObj(Result));
if (gc.pParentCulture != NULL)
{
Result = 0;
Result = CallPropertyGet(METHOD__CULTURE_INFO__GET_NAME, gc.pParentCulture);
}
}
GCPROTECT_END();
if (Result==0) {
return 0;
}
// Extract the data out of the String.
cultureName = (STRINGREF)(ArgSlotToObj(Result));
cultureName->RefInterpretGetStringValuesDangerousForGC((WCHAR**)&buffer, &bufferLength);
if (bufferLength<length) {
memcpy(szBuffer, buffer, bufferLength * sizeof (WCHAR));
szBuffer[bufferLength]=0;
retVal = bufferLength;
}
return retVal;
}
// copy culture name into szBuffer and return length
int Thread::GetCultureName(__out_ecount(length) LPWSTR szBuffer, int length, BOOL bUICulture)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
// This is the case when we're building mscorlib and haven't yet created
// the system assembly.
if (SystemDomain::System()->SystemAssembly()==NULL || g_fForbidEnterEE) {
const WCHAR *tempName = W("en-US");
INT32 tempLength = (INT32)wcslen(tempName);
_ASSERTE(length>=tempLength);
memcpy(szBuffer, tempName, tempLength*sizeof(WCHAR));
return tempLength;
}
ARG_SLOT Result = 0;
INT32 retVal=0;
WCHAR *buffer=NULL;
INT32 bufferLength=0;
STRINGREF cultureName = NULL;
GCX_COOP ();
OBJECTREF pCurrentCulture = NULL;
GCPROTECT_BEGIN(pCurrentCulture)
{
pCurrentCulture = GetCulture(bUICulture);
if (pCurrentCulture != NULL)
Result = CallPropertyGet(METHOD__CULTURE_INFO__GET_NAME, pCurrentCulture);
}
GCPROTECT_END();
if (Result==0) {
return 0;
}
// Extract the data out of the String.
cultureName = (STRINGREF)(ArgSlotToObj(Result));
cultureName->RefInterpretGetStringValuesDangerousForGC((WCHAR**)&buffer, &bufferLength);
if (bufferLength<length) {
memcpy(szBuffer, buffer, bufferLength * sizeof (WCHAR));
szBuffer[bufferLength]=0;
retVal = bufferLength;
}
return retVal;
}
LCID GetThreadCultureIdNoThrow(Thread *pThread, BOOL bUICulture)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
LCID Result = LCID(-1);
EX_TRY
{
Result = pThread->GetCultureId(bUICulture);
}
EX_CATCH
{
}
EX_END_CATCH (SwallowAllExceptions);
return (INT32)Result;
}
// Return a language identifier.
LCID Thread::GetCultureId(BOOL bUICulture)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
// This is the case when we're building mscorlib and haven't yet created
// the system assembly.
if (SystemDomain::System()->SystemAssembly()==NULL || g_fForbidEnterEE) {
return (LCID) -1;
}
LCID Result = (LCID) -1;
#ifdef FEATURE_USE_LCID
GCX_COOP();
OBJECTREF pCurrentCulture = NULL;
GCPROTECT_BEGIN(pCurrentCulture)
{
pCurrentCulture = GetCulture(bUICulture);
if (pCurrentCulture != NULL)
Result = (LCID)CallPropertyGet(METHOD__CULTURE_INFO__GET_ID, pCurrentCulture);
}
GCPROTECT_END();
#endif
return Result;
}
void Thread::SetCultureId(LCID lcid, BOOL bUICulture)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
GCX_COOP();
OBJECTREF CultureObj = NULL;
GCPROTECT_BEGIN(CultureObj)
{
// Convert the LCID into a CultureInfo.
GetCultureInfoForLCID(lcid, &CultureObj);
// Set the newly created culture as the thread's culture.
SetCulture(&CultureObj, bUICulture);
}
GCPROTECT_END();
}
void Thread::SetCulture(OBJECTREF *CultureObj, BOOL bUICulture)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE;
}
CONTRACTL_END;
// Retrieve the exposed thread object.
OBJECTREF pCurThreadObject = GetExposedObject();
_ASSERTE(pCurThreadObject!=NULL);
// Set the culture property on the thread.
THREADBASEREF pThreadBase = (THREADBASEREF)(pCurThreadObject);
CallPropertySet(bUICulture
? METHOD__THREAD__SET_UI_CULTURE
: METHOD__THREAD__SET_CULTURE,
(OBJECTREF)pThreadBase, *CultureObj);
}
void Thread::SetHasPromotedBytes ()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
m_fPromoted = TRUE;
_ASSERTE(GCHeapUtilities::IsGCInProgress() && IsGCThread ());
if (!m_fPreemptiveGCDisabled)
{
if (FRAME_TOP == GetFrame())
m_fPromoted = FALSE;
}
}
BOOL ThreadStore::HoldingThreadStore(Thread *pThread)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
if (pThread)
{
return (pThread == s_pThreadStore->m_HoldingThread);
}
else
{
return (s_pThreadStore->m_holderthreadid.IsCurrentThread());
}
}
#ifdef _DEBUG
int Thread::MaxThreadRecord = 20;
int Thread::MaxStackDepth = 20;
const int Thread::MaxThreadTrackInfo = Thread::ThreadTrackInfo_Max;
void Thread::AddFiberInfo(DWORD type)
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_MODE_ANY;
STATIC_CONTRACT_SO_TOLERANT;
#ifndef FEATURE_PAL
if (m_pFiberInfo[0] == NULL) {
return;
}
DWORD mask = g_pConfig->SaveThreadInfoMask();
if ((mask & type) == 0)
{
return;
}
int slot = -1;
while (type != 0)
{
type >>= 1;
slot ++;
}
_ASSERTE (slot < ThreadTrackInfo_Max);
// use try to force ebp frame.
PAL_TRY_NAKED {
ULONG index = FastInterlockIncrement((LONG*)&m_FiberInfoIndex[slot])-1;
index %= MaxThreadRecord;
size_t unitBytes = sizeof(FiberSwitchInfo)-sizeof(size_t)+MaxStackDepth*sizeof(size_t);
FiberSwitchInfo *pInfo = (FiberSwitchInfo*)((char*)m_pFiberInfo[slot] + index*unitBytes);
pInfo->timeStamp = getTimeStamp();
pInfo->threadID = GetCurrentThreadId();
#ifdef FEATURE_HIJACK
// We can't crawl the stack of a thread that currently has a hijack pending
// (since the hijack routine won't be recognized by any code manager). So we
// undo any hijack, the EE will re-attempt it later.
// Stack crawl happens on the current thread, which may not be 'this' thread.
Thread* pCurrentThread = GetThread();
if (pCurrentThread != NULL && (pCurrentThread->m_State & TS_Hijacked))
{
pCurrentThread->UnhijackThread();
}
#endif
int count = UtilCaptureStackBackTrace (2,MaxStackDepth,(PVOID*)pInfo->callStack,NULL);
while (count < MaxStackDepth) {
pInfo->callStack[count++] = 0;
}
}
PAL_EXCEPT_NAKED (EXCEPTION_EXECUTE_HANDLER)
{
}
PAL_ENDTRY_NAKED;
#endif // !FEATURE_PAL
}
#endif // _DEBUG
HRESULT Thread::SwitchIn(HANDLE threadHandle)
{
// can't have dynamic contracts because this method is going to mess with TLS
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_MODE_ANY;
//can't do heap allocation in this method
CantAllocHolder caHolder;
// !!! Can not use the following line, since it uses an object which .dctor calls
// !!! FLS_SETVALUE, and a new FLS is created after SwitchOut.
// CANNOTTHROWCOMPLUSEXCEPTION();
// Case Cookie to thread object and add to tls
#ifdef _DEBUG
Thread *pThread = GetThread();
// If this is hit, we need to understand.
// Sometimes we see the assert but the memory does not match the assert.
if (pThread) {
DebugBreak();
}
//_ASSERT(GetThread() == NULL);
#endif
if (GetThread() != NULL) {
return HOST_E_INVALIDOPERATION;
}
CExecutionEngine::SwitchIn();
// !!! no contract for this class.
// !!! We have not switched in tls block.
class EnsureTlsData
{
private:
Thread *m_pThread;
BOOL m_fNeedReset;
public:
EnsureTlsData(Thread* pThread){m_pThread = pThread; m_fNeedReset = TRUE;}
~EnsureTlsData()
{
if (m_fNeedReset)
{
SetThread(NULL);
SetAppDomain(NULL);
CExecutionEngine::SwitchOut();
}
}
void SuppressRelease()
{
m_fNeedReset = FALSE;
}
};
EnsureTlsData ensure(this);
if (SetThread(this))
{
Thread *pThread = GetThread();
if (!pThread)
return E_OUTOFMEMORY;
// !!! make sure that we switchin TLS so that FLS is available for Contract etc.
// We redundantly keep the domain in its own TLS slot, for faster access from
// stubs
if (!SetAppDomain(m_pDomainAtTaskSwitch))
{
return E_OUTOFMEMORY;
}
CANNOTTHROWCOMPLUSEXCEPTION();
#if 0
// We switch out a fiber only if the fiber is in preemptive gc mode.
_ASSERTE (!PreemptiveGCDisabled());
#endif
// We have to be switched in on the same fiber
_ASSERTE (GetCachedStackBase() == GetStackUpperBound());
if (m_pFiberData)
{
// only set the m_OSThreadId to bad food in Fiber mode
m_OSThreadId = ::GetCurrentThreadId();
#ifdef PROFILING_SUPPORTED
// If a profiler is present, then notify the profiler that a
// thread has been created.
{
BEGIN_PIN_PROFILER(CORProfilerTrackThreads());
g_profControlBlock.pProfInterface->ThreadAssignedToOSThread(
(ThreadID)this, m_OSThreadId);
END_PIN_PROFILER();
}
#endif // PROFILING_SUPPORTED
}
SetThreadHandle(threadHandle);
#ifndef FEATURE_PAL
m_pTEB = (struct _NT_TIB*)NtCurrentTeb();
#endif // !FEATURE_PAL
#if 0
if (g_TrapReturningThreads && m_fPreemptiveGCDisabled && this != ThreadSuspend::GetSuspensionThread()) {
WorkingOnThreadContextHolder workingOnThreadContext(this);
if (workingOnThreadContext.Acquired())
{
HandledJITCase(TRUE);
}
}
#endif
#ifdef _DEBUG
// For debugging purpose, we save callstack during task switch. On Win64, the callstack
// is done within OS loader lock, and obtaining managed callstack may cause fiber switch.
SetThreadStateNC(TSNC_InTaskSwitch);
AddFiberInfo(ThreadTrackInfo_Schedule);
ResetThreadStateNC(TSNC_InTaskSwitch);
#endif
ensure.SuppressRelease();
return S_OK;
}
else
{
return E_FAIL;
}
}
HRESULT Thread::SwitchOut()
{
LIMITED_METHOD_CONTRACT;
return E_NOTIMPL;
}
void Thread::InternalSwitchOut()
{
INDEBUG( BOOL fNoTLS = (CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
MODE_ANY;
}
CONTRACTL_END;
{
// Can't do heap allocation in this method.
// We need to scope this holder because its destructor accesses FLS.
CantAllocHolder caHolder;
// !!! Can not use the following line, since it uses an object which .dctor calls
// !!! FLS_SETVALUE, and a new FLS is created after SwitchOut.
// CANNOTTHROWCOMPLUSEXCEPTION();
_ASSERTE(GetThread() == this);
_ASSERTE (!fNoTLS ||
(CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
#if 0
// workaround wwl: for SQL reschedule
#ifndef _DEBUG
if (PreemptiveGCDisabled)
{
DebugBreak();
}
#endif
_ASSERTE(!PreemptiveGCDisabled());
#endif
// Can not assert here. If a mutex is orphaned, the thread will have ThreadAffinity.
//_ASSERTE(!HasThreadAffinity());
_ASSERTE (!fNoTLS ||
(CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
#ifdef _DEBUG
// For debugging purpose, we save callstack during task switch. On Win64, the callstack
// is done within OS loader lock, and obtaining managed callstack may cause fiber switch.
SetThreadStateNC(TSNC_InTaskSwitch);
AddFiberInfo(ThreadTrackInfo_Schedule);
ResetThreadStateNC(TSNC_InTaskSwitch);
#endif
_ASSERTE (!fNoTLS ||
(CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
m_pDomainAtTaskSwitch = GetAppDomain();
if (m_pFiberData)
{
// only set the m_OSThreadId to bad food in Fiber mode
m_OSThreadId = SWITCHED_OUT_FIBER_OSID;
#ifdef PROFILING_SUPPORTED
// If a profiler is present, then notify the profiler that a
// thread has been created.
{
BEGIN_PIN_PROFILER(CORProfilerTrackThreads());
g_profControlBlock.pProfInterface->ThreadAssignedToOSThread(
(ThreadID)this, m_OSThreadId);
END_PIN_PROFILER();
}
#endif // PROFILING_SUPPORTED
}
_ASSERTE (!fNoTLS ||
(CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
HANDLE hThread = GetThreadHandle();
SetThreadHandle (SWITCHOUT_HANDLE_VALUE);
while (m_dwThreadHandleBeingUsed > 0)
{
// Another thread is using the handle now.
#undef Sleep
// We can not call __SwitchToThread since we can not go back to host.
::Sleep(10);
#define Sleep(a) Dont_Use_Sleep(a)
}
if (m_WeOwnThreadHandle && m_ThreadHandleForClose == INVALID_HANDLE_VALUE)
{
m_ThreadHandleForClose = hThread;
}
// The host is getting control of this thread, so if we were trying
// to yield this thread, we can stop those attempts now.
ResetThreadState(TS_YieldRequested);
_ASSERTE (!fNoTLS ||
(CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
}
CExecutionEngine::SwitchOut();
// We need to make sure that TLS are touched last here.
// Contract uses TLS.
SetThread(NULL);
SetAppDomain(NULL);
_ASSERTE (!fNoTLS ||
(CExecutionEngine::CheckThreadStateNoCreate(0) == NULL));
}
LONG Thread::GetTotalThreadPoolCompletionCount()
{
CONTRACTL
{
NOTHROW;
MODE_ANY;
}
CONTRACTL_END;
LONG total;
if (g_fEEStarted) //make sure we actually have a thread store
{
// make sure up-to-date thread-local counts are visible to us
::FlushProcessWriteBuffers();
// enumerate all threads, summing their local counts.
ThreadStoreLockHolder tsl;
total = s_threadPoolCompletionCountOverflow.Load();
Thread *pThread = NULL;
while ((pThread = ThreadStore::GetAllThreadList(pThread, 0, 0)) != NULL)
{
total += pThread->m_threadPoolCompletionCount;
}
}
else
{
total = s_threadPoolCompletionCountOverflow.Load();
}
return total;
}
INT32 Thread::ResetManagedThreadObject(INT32 nPriority)
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
GCX_COOP();
return ResetManagedThreadObjectInCoopMode(nPriority);
}
INT32 Thread::ResetManagedThreadObjectInCoopMode(INT32 nPriority)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE;
SO_TOLERANT;
}
CONTRACTL_END;
THREADBASEREF pObject = (THREADBASEREF)ObjectFromHandle(m_ExposedObject);
if (pObject != NULL)
{
pObject->ResetCulture();
pObject->ResetName();
nPriority = pObject->GetPriority();
}
return nPriority;
}
void Thread::FullResetThread()
{
CONTRACTL {
NOTHROW;
GC_TRIGGERS;
}
CONTRACTL_END;
GCX_COOP();
// We need to put this thread in COOPERATIVE GC first to solve race between AppDomain::Unload
// and Thread::Reset. AppDomain::Unload does a full GC to collect all roots in one AppDomain.
// ThreadStaticData used to be coupled with a managed array of objects in the managed Thread
// object, however this is no longer the case.
// TODO: Do we still need to put this thread into COOP mode?
GCX_FORBID();
DeleteThreadStaticData();
m_alloc_context.alloc_bytes = 0;
m_fPromoted = FALSE;
}
BOOL Thread::IsRealThreadPoolResetNeeded()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE;
SO_TOLERANT;
}
CONTRACTL_END;
if(!IsBackground())
return TRUE;
THREADBASEREF pObject = (THREADBASEREF)ObjectFromHandle(m_ExposedObject);
if(pObject != NULL)
{
INT32 nPriority = pObject->GetPriority();
if(nPriority != ThreadNative::PRIORITY_NORMAL)
return TRUE;
}
return FALSE;
}
void Thread::InternalReset(BOOL fFull, BOOL fNotFinalizerThread, BOOL fThreadObjectResetNeeded, BOOL fResetAbort)
{
CONTRACTL {
NOTHROW;
if(!fNotFinalizerThread || fThreadObjectResetNeeded) {GC_TRIGGERS;SO_INTOLERANT;} else {GC_NOTRIGGER;SO_TOLERANT;}
}
CONTRACTL_END;
_ASSERTE (this == GetThread());
FinishSOWork();
INT32 nPriority = ThreadNative::PRIORITY_NORMAL;
if (!fNotFinalizerThread && this == FinalizerThread::GetFinalizerThread())
{
nPriority = ThreadNative::PRIORITY_HIGHEST;
}
if(fThreadObjectResetNeeded)
{
nPriority = ResetManagedThreadObject(nPriority);
}
if (fFull)
{
FullResetThread();
}
//m_MarshalAlloc.Collapse(NULL);
if (fResetAbort && IsAbortRequested()) {
UnmarkThreadForAbort(TAR_ALL);
}
if (fResetAbort && IsAborted())
ClearAborted();
if (IsThreadPoolThread() && fThreadObjectResetNeeded)
{
SetBackground(TRUE);
if (nPriority != ThreadNative::PRIORITY_NORMAL)
{
SetThreadPriority(THREAD_PRIORITY_NORMAL);
}
}
else if (!fNotFinalizerThread && this == FinalizerThread::GetFinalizerThread())
{
SetBackground(TRUE);
if (nPriority != ThreadNative::PRIORITY_HIGHEST)
{
SetThreadPriority(THREAD_PRIORITY_HIGHEST);
}
}
}
HRESULT Thread::Reset(BOOL fFull)
{
// !!! Can not use non-static contract here.
// !!! Contract depends on Thread object for GC_TRIGGERS.
// !!! At the end of this function, we call InternalSwitchOut,
// !!! and then GetThread()=NULL, and dtor of contract does not work any more.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_ENTRY_POINT;
if ( !g_fEEStarted)
return(E_FAIL);
HRESULT hr = S_OK;
BEGIN_SO_INTOLERANT_CODE_NOPROBE;
#ifdef _DEBUG
_ASSERTE (GetThread() == this);
#ifdef _TARGET_X86_
_ASSERTE (GetExceptionState()->GetContextRecord() == NULL);
#endif
#endif
if (GetThread() != this)
{
IfFailGo(E_UNEXPECTED);
}
if (HasThreadState(Thread::TS_YieldRequested))
{
ResetThreadState(Thread::TS_YieldRequested);
}
_ASSERTE (!PreemptiveGCDisabled());
_ASSERTE (m_pFrame == FRAME_TOP);
// A host should not recycle a CLRTask if the task is created by us through CreateNewThread.
// We need to make Thread.Join work for this case.
if ((m_StateNC & (TSNC_CLRCreatedThread | TSNC_CannotRecycle)) != 0)
{
// Todo: wwl better returning code.
IfFailGo(E_UNEXPECTED);
}
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
if (IsCoInitialized())
{
// The current thread has done CoInitialize
IfFailGo(E_UNEXPECTED);
}
#endif
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Lifetime);
#endif
SetThreadState(TS_TaskReset);
if (IsAbortRequested())
{
EEResetAbort(Thread::TAR_ALL);
}
InternalReset(fFull);
if (PreemptiveGCDisabled())
{
EnablePreemptiveGC();
}
{
#ifdef WIN64EXCEPTIONS
ExceptionTracker::PopTrackers((void*)-1);
#endif // WIN64EXCEPTIONS
ResetThreadStateNC(TSNC_UnbalancedLocks);
m_dwLockCount = 0;
InternalSwitchOut();
m_OSThreadId = SWITCHED_OUT_FIBER_OSID;
}
ErrExit:
END_SO_INTOLERANT_CODE_NOPROBE;
#ifdef ENABLE_CONTRACTS_DATA
// Decouple our cache from the Task.
// Next time, the thread may be run on a different thread.
if (SUCCEEDED(hr))
{
m_pClrDebugState = NULL;
}
#endif
return hr;
}
HRESULT Thread::ExitTask ()
{
// !!! Can not use contract here.
// !!! Contract depends on Thread object for GC_TRIGGERS.
// !!! At the end of this function, we call InternalSwitchOut,
// !!! and then GetThread()=NULL, and dtor of contract does not work any more.
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_ENTRY_POINT;
if ( !g_fEEStarted)
return(E_FAIL);
HRESULT hr = S_OK;
// <TODO> We need to probe here, but can't introduce destructors etc.</TODO>
BEGIN_CONTRACT_VIOLATION(SOToleranceViolation);
//OnThreadTerminate(FALSE);
_ASSERTE (this == GetThread());
_ASSERTE (!PreemptiveGCDisabled());
// Can not assert the following. SQL may call ExitTask after addref and abort a task.
//_ASSERTE (m_UnmanagedRefCount == 0);
if (this != GetThread())
IfFailGo(HOST_E_INVALIDOPERATION);
if (HasThreadState(Thread::TS_YieldRequested))
{
ResetThreadState(Thread::TS_YieldRequested);
}
#ifdef FEATURE_COMINTEROP_APARTMENT_SUPPORT
if (IsCoInitialized())
{
// This thread has used ole32. We need to balance CoInitialize call on this thread.
// We also need to free any COM objects created on this thread.
// If we don't do this work, ole32 is going to do the same during its DLL_THREAD_DETACH,
// and may re-enter CLR.
CleanupCOMState();
}
#endif
m_OSThreadId = SWITCHED_OUT_FIBER_OSID;
hr = DetachThread(FALSE);
// !!! Do not touch any field of Thread object. The Thread object is subject to delete
// !!! after DetachThread call.
ErrExit:;
END_CONTRACT_VIOLATION;
return hr;
}
HRESULT Thread::Abort ()
{
CONTRACTL
{
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
SO_TOLERANT;
}
CONTRACTL_END;
BEGIN_SO_INTOLERANT_CODE_NO_THROW_CHECK_THREAD(return COR_E_STACKOVERFLOW;);
EX_TRY
{
UserAbort(TAR_Thread, EEPolicy::TA_Safe, INFINITE, Thread::UAC_Host);
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions);
END_SO_INTOLERANT_CODE;
return S_OK;
}
HRESULT Thread::RudeAbort()
{
CONTRACTL
{
NOTHROW;
if (GetThread()) {GC_TRIGGERS;} else {DISABLED(GC_NOTRIGGER);}
SO_TOLERANT;
}
CONTRACTL_END;
BEGIN_SO_INTOLERANT_CODE_NO_THROW_CHECK_THREAD(return COR_E_STACKOVERFLOW);
EX_TRY
{
UserAbort(TAR_Thread, EEPolicy::TA_Rude, INFINITE, Thread::UAC_Host);
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions);
END_SO_INTOLERANT_CODE;
return S_OK;
}
HRESULT Thread::NeedsPriorityScheduling(BOOL *pbNeedsPriorityScheduling)
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
}
CONTRACTL_END;
*pbNeedsPriorityScheduling = (m_fPreemptiveGCDisabled ||
(g_fEEStarted && this == FinalizerThread::GetFinalizerThread()));
return S_OK;
}
HRESULT Thread::LocksHeld(SIZE_T *pLockCount)
{
LIMITED_METHOD_CONTRACT;
*pLockCount = m_dwLockCount;
return S_OK;
}
HRESULT Thread::SetTaskIdentifier(TASKID asked)
{
LIMITED_METHOD_CONTRACT;
// @todo: Should be check for uniqueness?
m_TaskId = asked;
return S_OK;
}
HRESULT Thread::BeginPreventAsyncAbort()
{
WRAPPER_NO_CONTRACT;
#ifdef _DEBUG
int count =
#endif
FastInterlockIncrement((LONG*)&m_PreventAbort);
#ifdef _DEBUG
ASSERT(count > 0);
AddFiberInfo(ThreadTrackInfo_Abort);
FastInterlockIncrement((LONG*)&m_dwDisableAbortCheckCount);
#endif
return S_OK;
}
HRESULT Thread::EndPreventAsyncAbort()
{
WRAPPER_NO_CONTRACT;
#ifdef _DEBUG
int count =
#endif
FastInterlockDecrement((LONG*)&m_PreventAbort);
#ifdef _DEBUG
ASSERT(count >= 0);
AddFiberInfo(ThreadTrackInfo_Abort);
FastInterlockDecrement((LONG*)&m_dwDisableAbortCheckCount);
#endif
return S_OK;
}
ULONG Thread::AddRef()
{
WRAPPER_NO_CONTRACT;
_ASSERTE(m_ExternalRefCount > 0);
_ASSERTE (m_UnmanagedRefCount != (DWORD) -1);
ULONG ref = FastInterlockIncrement((LONG*)&m_UnmanagedRefCount);
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Lifetime);
#endif
return ref;
}
ULONG Thread::Release()
{
WRAPPER_NO_CONTRACT;
SUPPORTS_DAC_HOST_ONLY;
_ASSERTE (m_ExternalRefCount > 0);
_ASSERTE (m_UnmanagedRefCount > 0);
ULONG ref = FastInterlockDecrement((LONG*)&m_UnmanagedRefCount);
#ifdef _DEBUG
AddFiberInfo(ThreadTrackInfo_Lifetime);
#endif
return ref;
}
HRESULT Thread::QueryInterface(REFIID riid, void **ppUnk)
{
LIMITED_METHOD_CONTRACT;
return E_NOINTERFACE;
}
void Thread::SetupThreadForHost()
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
SO_TOLERANT;
}
CONTRACTL_END;
_ASSERTE (GetThread() == this);
CONTRACT_VIOLATION(SOToleranceViolation);
}
ETaskType GetCurrentTaskType()
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_SO_TOLERANT;
ETaskType TaskType = TT_UNKNOWN;
size_t type = (size_t)ClrFlsGetValue (TlsIdx_ThreadType);
if (type & ThreadType_DbgHelper)
{
TaskType = TT_DEBUGGERHELPER;
}
else if (type & ThreadType_GC)
{
TaskType = TT_GC;
}
else if (type & ThreadType_Finalizer)
{
TaskType = TT_FINALIZER;
}
else if (type & ThreadType_Timer)
{
TaskType = TT_THREADPOOL_TIMER;
}
else if (type & ThreadType_Gate)
{
TaskType = TT_THREADPOOL_GATE;
}
else if (type & ThreadType_Wait)
{
TaskType = TT_THREADPOOL_WAIT;
}
else if (type & ThreadType_ADUnloadHelper)
{
TaskType = TT_ADUNLOAD;
}
else if (type & ThreadType_Threadpool_IOCompletion)
{
TaskType = TT_THREADPOOL_IOCOMPLETION;
}
else if (type & ThreadType_Threadpool_Worker)
{
TaskType = TT_THREADPOOL_WORKER;
}
else
{
Thread *pThread = GetThread();
if (pThread)
{
TaskType = TT_USER;
}
}
return TaskType;
}
DeadlockAwareLock::DeadlockAwareLock(const char *description)
: m_pHoldingThread(NULL)
#ifdef _DEBUG
, m_description(description)
#endif
{
LIMITED_METHOD_CONTRACT;
}
DeadlockAwareLock::~DeadlockAwareLock()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
CAN_TAKE_LOCK;
}
CONTRACTL_END;
// Wait for another thread to leave its loop in DeadlockAwareLock::TryBeginEnterLock
CrstHolder lock(&g_DeadlockAwareCrst);
}
CHECK DeadlockAwareLock::CheckDeadlock(Thread *pThread)
{
CONTRACTL
{
PRECONDITION(g_DeadlockAwareCrst.OwnedByCurrentThread());
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
// Note that this check is recursive in order to produce descriptive check failure messages.
Thread *pHoldingThread = m_pHoldingThread.Load();
if (pThread == pHoldingThread)
{
CHECK_FAILF(("Lock %p (%s) is held by thread %d", this, m_description, pThread));
}
if (pHoldingThread != NULL)
{
DeadlockAwareLock *pBlockingLock = pHoldingThread->m_pBlockingLock.Load();
if (pBlockingLock != NULL)
{
CHECK_MSGF(pBlockingLock->CheckDeadlock(pThread),
("Deadlock: Lock %p (%s) is held by thread %d", this, m_description, pHoldingThread));
}
}
CHECK_OK;
}
BOOL DeadlockAwareLock::CanEnterLock()
{
Thread * pThread = GetThread();
CONSISTENCY_CHECK_MSG(pThread != NULL,
"Cannot do deadlock detection on non-EE thread");
CONSISTENCY_CHECK_MSG(pThread->m_pBlockingLock.Load() == NULL,
"Cannot block on two locks at once");
{
CrstHolder lock(&g_DeadlockAwareCrst);
// Look for deadlocks
DeadlockAwareLock *pLock = this;
while (TRUE)
{
Thread * holdingThread = pLock->m_pHoldingThread;
if (holdingThread == pThread)
{
// Deadlock!
return FALSE;
}
if (holdingThread == NULL)
{
// Lock is unheld
break;
}
pLock = holdingThread->m_pBlockingLock;
if (pLock == NULL)
{
// Thread is running free
break;
}
}
return TRUE;
}
}
BOOL DeadlockAwareLock::TryBeginEnterLock()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
Thread * pThread = GetThread();
CONSISTENCY_CHECK_MSG(pThread != NULL,
"Cannot do deadlock detection on non-EE thread");
CONSISTENCY_CHECK_MSG(pThread->m_pBlockingLock.Load() == NULL,
"Cannot block on two locks at once");
{
CrstHolder lock(&g_DeadlockAwareCrst);
// Look for deadlocks
DeadlockAwareLock *pLock = this;
while (TRUE)
{
Thread * holdingThread = pLock->m_pHoldingThread;
if (holdingThread == pThread)
{
// Deadlock!
return FALSE;
}
if (holdingThread == NULL)
{
// Lock is unheld
break;
}
pLock = holdingThread->m_pBlockingLock;
if (pLock == NULL)
{
// Thread is running free
break;
}
}
pThread->m_pBlockingLock = this;
}
return TRUE;
};
void DeadlockAwareLock::BeginEnterLock()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
Thread * pThread = GetThread();
CONSISTENCY_CHECK_MSG(pThread != NULL,
"Cannot do deadlock detection on non-EE thread");
CONSISTENCY_CHECK_MSG(pThread->m_pBlockingLock.Load() == NULL,
"Cannot block on two locks at once");
{
CrstHolder lock(&g_DeadlockAwareCrst);
// Look for deadlock loop
CONSISTENCY_CHECK_MSG(CheckDeadlock(pThread), "Deadlock detected!");
pThread->m_pBlockingLock = this;
}
};
void DeadlockAwareLock::EndEnterLock()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
Thread * pThread = GetThread();
CONSISTENCY_CHECK(m_pHoldingThread.Load() == NULL || m_pHoldingThread.Load() == pThread);
CONSISTENCY_CHECK(pThread->m_pBlockingLock.Load() == this);
// No need to take a lock when going from blocking to holding. This
// transition implies the lack of a deadlock that other threads can see.
// (If they would see a deadlock after the transition, they would see
// one before as well.)
m_pHoldingThread = pThread;
}
void DeadlockAwareLock::LeaveLock()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
}
CONTRACTL_END;
CONSISTENCY_CHECK(m_pHoldingThread == GetThread());
CONSISTENCY_CHECK(GetThread()->m_pBlockingLock.Load() == NULL);
m_pHoldingThread = NULL;
}
#ifdef _DEBUG
// Normally, any thread we operate on has a Thread block in its TLS. But there are
// a few special threads we don't normally execute managed code on.
//
// There is a scenario where we run managed code on such a thread, which is when the
// DLL_THREAD_ATTACH notification of an (IJW?) module calls into managed code. This
// is incredibly dangerous. If a GC is provoked, the system may have trouble performing
// the GC because its threads aren't available yet.
static DWORD SpecialEEThreads[10];
static LONG cnt_SpecialEEThreads = 0;
void dbgOnly_IdentifySpecialEEThread()
{
WRAPPER_NO_CONTRACT;
LONG ourCount = FastInterlockIncrement(&cnt_SpecialEEThreads);
_ASSERTE(ourCount < (LONG) NumItems(SpecialEEThreads));
SpecialEEThreads[ourCount-1] = ::GetCurrentThreadId();
}
BOOL dbgOnly_IsSpecialEEThread()
{
WRAPPER_NO_CONTRACT;
DWORD ourId = ::GetCurrentThreadId();
for (LONG i=0; i<cnt_SpecialEEThreads; i++)
if (ourId == SpecialEEThreads[i])
return TRUE;
// If we have an EE thread doing helper thread duty, then it is temporarily
// 'special' too.
#ifdef DEBUGGING_SUPPORTED
if (g_pDebugInterface)
{
//<TODO>We probably should use Thread::GetThreadId</TODO>
DWORD helperID = g_pDebugInterface->GetHelperThreadID();
if (helperID == ourId)
return TRUE;
}
#endif
//<TODO>Clean this up</TODO>
if (GetThread() == NULL)
return TRUE;
return FALSE;
}
#endif // _DEBUG
// There is an MDA which can detect illegal reentrancy into the CLR. For instance, if you call managed
// code from a native vectored exception handler, this might cause a reverse PInvoke to occur. But if the
// exception was triggered from code that was executing in cooperative GC mode, we now have GC holes and
// general corruption.
#ifdef MDA_SUPPORTED
NOINLINE BOOL HasIllegalReentrancyRare()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
ENTRY_POINT;
MODE_ANY;
}
CONTRACTL_END;
Thread *pThread = GetThread();
if (pThread == NULL || !pThread->PreemptiveGCDisabled())
return FALSE;
BEGIN_ENTRYPOINT_VOIDRET;
MDA_TRIGGER_ASSISTANT(Reentrancy, ReportViolation());
END_ENTRYPOINT_VOIDRET;
return TRUE;
}
#endif
// Actually fire the Reentrancy probe, if warranted.
BOOL HasIllegalReentrancy()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
ENTRY_POINT;
MODE_ANY;
}
CONTRACTL_END;
#ifdef MDA_SUPPORTED
if (NULL == MDA_GET_ASSISTANT(Reentrancy))
return FALSE;
return HasIllegalReentrancyRare();
#else
return FALSE;
#endif // MDA_SUPPORTED
}
#endif // #ifndef DACCESS_COMPILE
#ifdef DACCESS_COMPILE
void
STATIC_DATA::EnumMemoryRegions(CLRDataEnumMemoryFlags flags)
{
WRAPPER_NO_CONTRACT;
DAC_ENUM_STHIS(STATIC_DATA);
}
void
Thread::EnumMemoryRegions(CLRDataEnumMemoryFlags flags)
{
WRAPPER_NO_CONTRACT;
DAC_ENUM_VTHIS();
if (flags != CLRDATA_ENUM_MEM_MINI && flags != CLRDATA_ENUM_MEM_TRIAGE)
{
if (m_pDomain.IsValid())
{
m_pDomain->EnumMemoryRegions(flags, true);
}
if (m_Context.IsValid())
{
m_Context->EnumMemoryRegions(flags);
}
}
if (m_debuggerFilterContext.IsValid())
{
m_debuggerFilterContext.EnumMem();
}
OBJECTHANDLE_EnumMemoryRegions(m_LastThrownObjectHandle);
m_ExceptionState.EnumChainMemoryRegions(flags);
// Like the old thread static implementation, we only enumerate
// the current TLB. Should we be enumerating all of the TLBs?
if (m_pThreadLocalBlock.IsValid())
m_pThreadLocalBlock->EnumMemoryRegions(flags);
if (flags != CLRDATA_ENUM_MEM_MINI && flags != CLRDATA_ENUM_MEM_TRIAGE)
{
//
// Allow all of the frames on the stack to enumerate
// their memory.
//
PTR_Frame frame = m_pFrame;
while (frame.IsValid() &&
frame.GetAddr() != dac_cast<TADDR>(FRAME_TOP))
{
frame->EnumMemoryRegions(flags);
frame = frame->m_Next;
}
}
//
// Try and do a stack trace and save information
// for each part of the stack. This is very vulnerable
// to memory problems so ignore all exceptions here.
//
CATCH_ALL_EXCEPT_RETHROW_COR_E_OPERATIONCANCELLED
(
EnumMemoryRegionsWorker(flags);
);
}
void
Thread::EnumMemoryRegionsWorker(CLRDataEnumMemoryFlags flags)
{
WRAPPER_NO_CONTRACT;
if (IsUnstarted())
{
return;
}
T_CONTEXT context;
BOOL DacGetThreadContext(Thread* thread, T_CONTEXT* context);
REGDISPLAY regDisp;
StackFrameIterator frameIter;
TADDR previousSP = 0; //start at zero; this allows first check to always succeed.
TADDR currentSP;
// Init value. The Limit itself is not legal, so move one target pointer size to the smallest-magnitude
// legal address.
currentSP = dac_cast<TADDR>(m_CacheStackLimit) + sizeof(TADDR);
if (GetFilterContext())
{
context = *GetFilterContext();
}
else
{
DacGetThreadContext(this, &context);
}
FillRegDisplay(®Disp, &context);
frameIter.Init(this, NULL, ®Disp, 0);
while (frameIter.IsValid())
{
//
// There are identical stack pointer checking semantics in code:ClrDataAccess::EnumMemWalkStackHelper
// You ***MUST*** maintain identical semantics for both checks!
//
// Before we continue, we should check to be sure we have a valid
// stack pointer. This is to prevent stacks that are not walked
// properly due to
// a) stack corruption bugs
// b) bad stack walks
// from continuing on indefinitely.
//
// We will force SP to strictly increase.
// this check can only happen for real stack frames (i.e. not for explicit frames that don't update the RegDisplay)
// for ia64, SP may be equal, but in this case BSP must strictly decrease.
// We will force SP to be properly aligned.
// We will force SP to be in the correct range.
//
if (frameIter.GetFrameState() == StackFrameIterator::SFITER_FRAMELESS_METHOD)
{
// This check cannot be applied to explicit frames; they may not move the SP at all.
// Also, a single function can push several on the stack at a time with no guarantees about
// ordering so we can't check that the addresses of the explicit frames are monotonically increasing.
// There is the potential that the walk will not terminate if a set of explicit frames reference
// each other circularly. While we could choose a limit for the number of explicit frames allowed
// in a row like the total stack size/pointer size, we have no known problems with this scenario.
// Thus for now we ignore it.
currentSP = (TADDR)GetRegdisplaySP(®Disp);
if (currentSP <= previousSP)
{
_ASSERTE(!"Target stack has been corrupted, SP for current frame must be larger than previous frame.");
break;
}
}
// On windows desktop, the stack pointer should be a multiple
// of pointer-size-aligned in the target address space
if (currentSP % sizeof(TADDR) != 0)
{
_ASSERTE(!"Target stack has been corrupted, SP must be aligned.");
break;
}
if (!IsAddressInStack(currentSP))
{
_ASSERTE(!"Target stack has been corrupted, SP must in in the stack range.");
break;
}
// Enumerate the code around the call site to help debugger stack walking heuristics
PCODE callEnd = GetControlPC(®Disp);
DacEnumCodeForStackwalk(callEnd);
if (flags != CLRDATA_ENUM_MEM_MINI && flags != CLRDATA_ENUM_MEM_TRIAGE)
{
if (frameIter.m_crawl.GetAppDomain())
{
frameIter.m_crawl.GetAppDomain()->EnumMemoryRegions(flags, true);
}
}
// To stackwalk through funceval frames, we need to be sure to preserve the
// DebuggerModule's m_pRuntimeDomainFile. This is the only case that doesn't use the current
// vmDomainFile in code:DacDbiInterfaceImpl::EnumerateInternalFrames. The following
// code mimics that function.
// Allow failure, since we want to continue attempting to walk the stack regardless of the outcome.
EX_TRY
{
if ((frameIter.GetFrameState() == StackFrameIterator::SFITER_FRAME_FUNCTION) ||
(frameIter.GetFrameState() == StackFrameIterator::SFITER_SKIPPED_FRAME_FUNCTION))
{
Frame * pFrame = frameIter.m_crawl.GetFrame();
g_pDebugInterface->EnumMemoryRegionsIfFuncEvalFrame(flags, pFrame);
}
}
EX_CATCH_RETHROW_ONLY_COR_E_OPERATIONCANCELLED
MethodDesc* pMD = frameIter.m_crawl.GetFunction();
if (pMD != NULL)
{
pMD->EnumMemoryRegions(flags);
#if defined(WIN64EXCEPTIONS) && defined(FEATURE_PREJIT)
// Enumerate unwind info
// Note that we don't do this based on the MethodDesc because in theory there isn't a 1:1 correspondence
// between MethodDesc and code (and so unwind info, and even debug info). Eg., EnC creates new versions
// of the code, but the MethodDesc always points at the latest version (which isn't necessarily
// the one on the stack). In practice this is unlikely to be a problem since wanting a minidump
// and making EnC edits are usually mutually exclusive.
if (frameIter.m_crawl.IsFrameless())
{
frameIter.m_crawl.GetJitManager()->EnumMemoryRegionsForMethodUnwindInfo(flags, frameIter.m_crawl.GetCodeInfo());
}
#endif // defined(WIN64EXCEPTIONS) && defined(FEATURE_PREJIT)
}
previousSP = currentSP;
if (frameIter.Next() != SWA_CONTINUE)
{
break;
}
}
}
void
ThreadStore::EnumMemoryRegions(CLRDataEnumMemoryFlags flags)
{
SUPPORTS_DAC;
WRAPPER_NO_CONTRACT;
// This will write out the context of the s_pThreadStore. ie
// just the pointer
//
s_pThreadStore.EnumMem();
if (s_pThreadStore.IsValid())
{
// write out the whole ThreadStore structure
DacEnumHostDPtrMem(s_pThreadStore);
// The thread list may be corrupt, so just
// ignore exceptions during enumeration.
EX_TRY
{
Thread* thread = s_pThreadStore->m_ThreadList.GetHead();
LONG dwNumThreads = s_pThreadStore->m_ThreadCount;
for (LONG i = 0; (i < dwNumThreads) && (thread != NULL); i++)
{
// Even if this thread is totally broken and we can't enum it, struggle on.
// If we do not, we will leave this loop and not enum stack memory for any further threads.
CATCH_ALL_EXCEPT_RETHROW_COR_E_OPERATIONCANCELLED(
thread->EnumMemoryRegions(flags);
);
thread = s_pThreadStore->m_ThreadList.GetNext(thread);
}
}
EX_CATCH_RETHROW_ONLY_COR_E_OPERATIONCANCELLED
}
}
#endif // #ifdef DACCESS_COMPILE
#ifdef FEATURE_APPDOMAIN_RESOURCE_MONITORING
// For the purposes of tracking resource usage we implement a simple cpu resource usage counter on each
// thread. Every time QueryThreadProcessorUsage() is invoked it returns the amount of cpu time (a combination
// of user and kernel mode time) used since the last call to QueryThreadProcessorUsage(). The result is in 100
// nanosecond units.
ULONGLONG Thread::QueryThreadProcessorUsage()
{
LIMITED_METHOD_CONTRACT;
// Get current values for the amount of kernel and user time used by this thread over its entire lifetime.
FILETIME sCreationTime, sExitTime, sKernelTime, sUserTime;
HANDLE hThread = GetThreadHandle();
BOOL fResult = GetThreadTimes(hThread,
&sCreationTime,
&sExitTime,
&sKernelTime,
&sUserTime);
if (!fResult)
{
#ifdef _DEBUG
ULONG error = GetLastError();
printf("GetThreadTimes failed: %d; handle is %p\n", error, hThread);
_ASSERTE(FALSE);
#endif
return 0;
}
// Combine the user and kernel times into a single value (FILETIME is just a structure representing an
// unsigned int64 in two 32-bit pieces).
_ASSERTE(sizeof(FILETIME) == sizeof(UINT64));
ULONGLONG ullCurrentUsage = *(ULONGLONG*)&sKernelTime + *(ULONGLONG*)&sUserTime;
// Store the current processor usage as the new baseline, and retrieve the previous usage.
ULONGLONG ullPreviousUsage = VolatileLoad(&m_ullProcessorUsageBaseline);
if (ullPreviousUsage >= ullCurrentUsage ||
ullPreviousUsage != (ULONGLONG)InterlockedCompareExchange64(
(LONGLONG*)&m_ullProcessorUsageBaseline,
(LONGLONG)ullCurrentUsage,
(LONGLONG)ullPreviousUsage))
{
// another thread beat us to it, and already reported this usage.
return 0;
}
// The result is the difference between this value and the previous usage value.
return ullCurrentUsage - ullPreviousUsage;
}
#endif // FEATURE_APPDOMAIN_RESOURCE_MONITORING
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// YieldProcessorNormalized
// Defaults are for when InitializeYieldProcessorNormalized has not yet been called or when no measurement is done, and are
// tuned for Skylake processors
int g_yieldsPerNormalizedYield = 1; // current value is for Skylake processors, this would be 9 for pre-Skylake
int g_optimalMaxNormalizedYieldsPerSpinIteration = 7;
static Volatile<bool> s_isYieldProcessorNormalizedInitialized = false;
void InitializeYieldProcessorNormalized()
{
LIMITED_METHOD_CONTRACT;
CrstHolder lock(&s_initializeYieldProcessorNormalizedCrst);
if (s_isYieldProcessorNormalizedInitialized)
{
return;
}
// Intel pre-Skylake processor: measured typically 14-17 cycles per yield
// Intel post-Skylake processor: measured typically 125-150 cycles per yield
const int MeasureDurationMs = 10;
const int MaxYieldsPerNormalizedYield = 10; // measured typically 8-9 on pre-Skylake
const int MinNsPerNormalizedYield = 37; // measured typically 37-46 on post-Skylake
const int NsPerOptimialMaxSpinIterationDuration = 272; // approx. 900 cycles, measured 281 on pre-Skylake, 263 on post-Skylake
const int NsPerSecond = 1000 * 1000 * 1000;
LARGE_INTEGER li;
if (!QueryPerformanceFrequency(&li) || (ULONGLONG)li.QuadPart < 1000 / MeasureDurationMs)
{
// High precision clock not available or clock resolution is too low, resort to defaults
s_isYieldProcessorNormalizedInitialized = true;
return;
}
ULONGLONG ticksPerSecond = li.QuadPart;
// Measure the nanosecond delay per yield
ULONGLONG measureDurationTicks = ticksPerSecond / (1000 / MeasureDurationMs);
unsigned int yieldCount = 0;
QueryPerformanceCounter(&li);
ULONGLONG startTicks = li.QuadPart;
ULONGLONG elapsedTicks;
do
{
// On some systems, querying the high performance counter has relatively significant overhead. Do enough yields to mask
// the timing overhead. Assuming one yield has a delay of MinNsPerNormalizedYield, 1000 yields would have a delay in the
// low microsecond range.
for (int i = 0; i < 1000; ++i)
{
YieldProcessor();
}
yieldCount += 1000;
QueryPerformanceCounter(&li);
ULONGLONG nowTicks = li.QuadPart;
elapsedTicks = nowTicks - startTicks;
} while (elapsedTicks < measureDurationTicks);
double nsPerYield = (double)elapsedTicks * NsPerSecond / ((double)yieldCount * ticksPerSecond);
if (nsPerYield < 1)
{
nsPerYield = 1;
}
// Calculate the number of yields required to span the duration of a normalized yield
int yieldsPerNormalizedYield = (int)(MinNsPerNormalizedYield / nsPerYield + 0.5);
if (yieldsPerNormalizedYield < 1)
{
yieldsPerNormalizedYield = 1;
}
else if (yieldsPerNormalizedYield > MaxYieldsPerNormalizedYield)
{
yieldsPerNormalizedYield = MaxYieldsPerNormalizedYield;
}
// Calculate the maximum number of yields that would be optimal for a late spin iteration. Typically, we would not want to
// spend excessive amounts of time (thousands of cycles) doing only YieldProcessor, as SwitchToThread/Sleep would do a
// better job of allowing other work to run.
int optimalMaxNormalizedYieldsPerSpinIteration =
(int)(NsPerOptimialMaxSpinIterationDuration / (yieldsPerNormalizedYield * nsPerYield) + 0.5);
if (optimalMaxNormalizedYieldsPerSpinIteration < 1)
{
optimalMaxNormalizedYieldsPerSpinIteration = 1;
}
g_yieldsPerNormalizedYield = yieldsPerNormalizedYield;
g_optimalMaxNormalizedYieldsPerSpinIteration = optimalMaxNormalizedYieldsPerSpinIteration;
s_isYieldProcessorNormalizedInitialized = true;
}
void EnsureYieldProcessorNormalizedInitialized()
{
WRAPPER_NO_CONTRACT;
if (!s_isYieldProcessorNormalizedInitialized)
{
InitializeYieldProcessorNormalized();
}
}
|