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
|
// 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.
//
//
// ---------------------------------------------------------------------------
// EEPolicy.cpp
// ---------------------------------------------------------------------------
#include "common.h"
#include "eepolicy.h"
#include "corhost.h"
#include "dbginterface.h"
#include "eemessagebox.h"
#include "eventreporter.h"
#include "finalizerthread.h"
#include "threadsuspend.h"
#include "typestring.h"
#ifndef FEATURE_PAL
#include "dwreport.h"
#endif // !FEATURE_PAL
#include "eventtrace.h"
#undef ExitProcess
BYTE g_EEPolicyInstance[sizeof(EEPolicy)];
void InitEEPolicy()
{
WRAPPER_NO_CONTRACT;
new (g_EEPolicyInstance) EEPolicy();
}
EEPolicy::EEPolicy ()
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
int n;
for (n = 0; n < MaxClrOperation; n++) {
m_Timeout[n] = INFINITE;
m_ActionOnTimeout[n] = eNoAction;
m_DefaultAction[n] = eNoAction;
}
m_Timeout[OPR_ProcessExit] = 40000;
m_ActionOnTimeout[OPR_ProcessExit] = eRudeExitProcess;
m_ActionOnTimeout[OPR_ThreadAbort] = eAbortThread;
m_ActionOnTimeout[OPR_ThreadRudeAbortInNonCriticalRegion] = eRudeAbortThread;
m_ActionOnTimeout[OPR_ThreadRudeAbortInCriticalRegion] = eRudeAbortThread;
m_DefaultAction[OPR_ThreadAbort] = eAbortThread;
m_DefaultAction[OPR_ThreadRudeAbortInNonCriticalRegion] = eRudeAbortThread;
m_DefaultAction[OPR_ThreadRudeAbortInCriticalRegion] = eRudeAbortThread;
m_DefaultAction[OPR_AppDomainUnload] = eUnloadAppDomain;
m_DefaultAction[OPR_AppDomainRudeUnload] = eRudeUnloadAppDomain;
m_DefaultAction[OPR_ProcessExit] = eExitProcess;
m_DefaultAction[OPR_FinalizerRun] = eNoAction;
for (n = 0; n < MaxClrFailure; n++) {
m_ActionOnFailure[n] = eNoAction;
}
m_ActionOnFailure[FAIL_CriticalResource] = eThrowException;
m_ActionOnFailure[FAIL_NonCriticalResource] = eThrowException;
m_ActionOnFailure[FAIL_OrphanedLock] = eNoAction;
m_ActionOnFailure[FAIL_FatalRuntime] = eRudeExitProcess;
// For CoreCLR, initialize the default action for AV processing to all
// all kind of code to catch AV exception. If the host wants, they can
// specify a different action for this.
m_ActionOnFailure[FAIL_AccessViolation] = eNoAction;
m_ActionOnFailure[FAIL_StackOverflow] = eRudeExitProcess;
m_ActionOnFailure[FAIL_CodeContract] = eThrowException;
m_unhandledExceptionPolicy = eRuntimeDeterminedPolicy;
}
BOOL EEPolicy::IsValidActionForOperation(EClrOperation operation, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
switch (operation) {
case OPR_ThreadAbort:
return action >= eAbortThread &&
action < MaxPolicyAction;
case OPR_ThreadRudeAbortInNonCriticalRegion:
case OPR_ThreadRudeAbortInCriticalRegion:
return action >= eRudeAbortThread && action != eUnloadAppDomain &&
action < MaxPolicyAction;
case OPR_AppDomainUnload:
return action >= eUnloadAppDomain &&
action < MaxPolicyAction;
case OPR_AppDomainRudeUnload:
return action >= eRudeUnloadAppDomain &&
action < MaxPolicyAction;
case OPR_ProcessExit:
return action >= eExitProcess &&
action < MaxPolicyAction;
case OPR_FinalizerRun:
return action == eNoAction ||
(action >= eAbortThread &&
action < MaxPolicyAction);
default:
_ASSERT (!"Do not know valid action for this operation");
break;
}
return FALSE;
}
BOOL EEPolicy::IsValidActionForTimeout(EClrOperation operation, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
switch (operation) {
case OPR_ThreadAbort:
return action > eAbortThread &&
action < MaxPolicyAction;
case OPR_ThreadRudeAbortInNonCriticalRegion:
case OPR_ThreadRudeAbortInCriticalRegion:
return action > eRudeUnloadAppDomain &&
action < MaxPolicyAction;
case OPR_AppDomainUnload:
return action > eUnloadAppDomain &&
action < MaxPolicyAction;
case OPR_AppDomainRudeUnload:
return action > eRudeUnloadAppDomain &&
action < MaxPolicyAction;
case OPR_ProcessExit:
return action > eExitProcess &&
action < MaxPolicyAction;
case OPR_FinalizerRun:
return action == eNoAction ||
(action >= eAbortThread &&
action < MaxPolicyAction);
default:
_ASSERT (!"Do not know valid action for this operation");
break;
}
return FALSE;
}
BOOL EEPolicy::IsValidActionForFailure(EClrFailure failure, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
switch (failure) {
case FAIL_NonCriticalResource:
return action >= eThrowException &&
action < MaxPolicyAction;
case FAIL_CriticalResource:
return action >= eThrowException &&
action < MaxPolicyAction;
case FAIL_FatalRuntime:
return action >= eRudeExitProcess &&
action < MaxPolicyAction;
case FAIL_OrphanedLock:
return action >= eUnloadAppDomain &&
action < MaxPolicyAction;
case FAIL_AccessViolation:
// Allowed actions on failure are:
//
// eNoAction or eRudeExitProcess.
return ((action == eNoAction) || (action == eRudeExitProcess));
case FAIL_StackOverflow:
return action >= eRudeUnloadAppDomain &&
action < MaxPolicyAction;
case FAIL_CodeContract:
return action >= eThrowException &&
action <= eExitProcess;
default:
_ASSERTE (!"Do not know valid action for this failure");
break;
}
return FALSE;
}
HRESULT EEPolicy::SetTimeout(EClrOperation operation, DWORD timeout)
{
CONTRACTL
{
MODE_ANY;
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
if (static_cast<UINT>(operation) < MaxClrOperation)
{
m_Timeout[operation] = timeout;
if (operation == OPR_FinalizerRun &&
g_fEEStarted)
{
FastInterlockOr((DWORD*)&g_FinalizerWaiterStatus, FWS_WaitInterrupt);
FinalizerThread::SignalFinalizationDone(FALSE);
}
return S_OK;
}
else
{
return E_INVALIDARG;
}
}
HRESULT EEPolicy::SetActionOnTimeout(EClrOperation operation, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
if (static_cast<UINT>(operation) < MaxClrOperation &&
IsValidActionForTimeout(operation, action))
{
m_ActionOnTimeout[operation] = action;
return S_OK;
}
else
{
return E_INVALIDARG;
}
}
EPolicyAction EEPolicy::GetFinalAction(EPolicyAction action, Thread *pThread)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(static_cast<UINT>(action) < MaxPolicyAction);
if (action < eAbortThread || action > eFastExitProcess)
{
return action;
}
while(TRUE)
{
// Look at default action. If the default action is more severe,
// use the default action instead.
EPolicyAction defaultAction = action;
switch (action)
{
case eAbortThread:
defaultAction = m_DefaultAction[OPR_ThreadAbort];
break;
case eRudeAbortThread:
if (pThread && !pThread->HasLockInCurrentDomain())
{
defaultAction = m_DefaultAction[OPR_ThreadRudeAbortInNonCriticalRegion];
}
else
{
defaultAction = m_DefaultAction[OPR_ThreadRudeAbortInCriticalRegion];
}
break;
case eUnloadAppDomain:
defaultAction = m_DefaultAction[OPR_AppDomainUnload];
break;
case eRudeUnloadAppDomain:
defaultAction = m_DefaultAction[OPR_AppDomainRudeUnload];
break;
case eExitProcess:
case eFastExitProcess:
defaultAction = m_DefaultAction[OPR_ProcessExit];
if (defaultAction < action)
{
defaultAction = action;
}
break;
default:
break;
}
_ASSERTE(static_cast<UINT>(defaultAction) < MaxPolicyAction);
if (defaultAction == action)
{
return action;
}
_ASSERTE(defaultAction > action);
action = defaultAction;
}
}
// Allow setting timeout and action in one call.
// If we decide to have atomical operation on Policy, we can use lock here
// while SetTimeout and SetActionOnTimeout can not.
HRESULT EEPolicy::SetTimeoutAndAction(EClrOperation operation, DWORD timeout, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
if (static_cast<UINT>(operation) < MaxClrOperation &&
IsValidActionForTimeout(operation, action))
{
m_ActionOnTimeout[operation] = action;
m_Timeout[operation] = timeout;
if (operation == OPR_FinalizerRun &&
g_fEEStarted)
{
FastInterlockOr((DWORD*)&g_FinalizerWaiterStatus, FWS_WaitInterrupt);
FinalizerThread::SignalFinalizationDone(FALSE);
}
return S_OK;
}
else
{
return E_INVALIDARG;
}
}
HRESULT EEPolicy::SetDefaultAction(EClrOperation operation, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
if (static_cast<UINT>(operation) < MaxClrOperation &&
IsValidActionForOperation(operation, action))
{
m_DefaultAction[operation] = action;
return S_OK;
}
else
{
return E_INVALIDARG;
}
}
HRESULT EEPolicy::SetActionOnFailure(EClrFailure failure, EPolicyAction action)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
}
CONTRACTL_END;
if (static_cast<UINT>(failure) < MaxClrFailure &&
IsValidActionForFailure(failure, action))
{
m_ActionOnFailure[failure] = action;
return S_OK;
}
else
{
return E_INVALIDARG;
}
}
EPolicyAction EEPolicy::GetActionOnFailureNoHostNotification(EClrFailure failure)
{
CONTRACTL
{
SO_TOLERANT;
MODE_ANY;
GC_NOTRIGGER;
NOTHROW;
}CONTRACTL_END;
_ASSERTE (failure < MaxClrFailure);
if (failure == FAIL_StackOverflow)
{
return m_ActionOnFailure[failure];
}
return GetFinalAction(m_ActionOnFailure[failure], GetThread());
}
EPolicyAction EEPolicy::GetActionOnFailure(EClrFailure failure)
{
CONTRACTL
{
SO_TOLERANT;
MODE_ANY;
GC_NOTRIGGER;
NOTHROW;
}CONTRACTL_END;
_ASSERTE(static_cast<UINT>(failure) < MaxClrFailure);
if (failure == FAIL_StackOverflow)
{
return m_ActionOnFailure[failure];
}
EPolicyAction finalAction = GetActionOnFailureNoHostNotification(failure);
return finalAction;
}
void EEPolicy::NotifyHostOnTimeout(EClrOperation operation, EPolicyAction action)
{
CONTRACTL
{
THROWS;
GC_NOTRIGGER;
MODE_ANY;
SO_TOLERANT;
}
CONTRACTL_END;
}
void EEPolicy::NotifyHostOnDefaultAction(EClrOperation operation, EPolicyAction action)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
SO_TOLERANT;
}
CONTRACTL_END;
}
void SafeExitProcess(UINT exitCode, BOOL fAbort = FALSE, ShutdownCompleteAction sca = SCA_ExitProcessWhenShutdownComplete)
{
// The process is shutting down. No need to check SO contract.
SO_NOT_MAINLINE_FUNCTION;
STRESS_LOG2(LF_SYNC, LL_INFO10, "SafeExitProcess: exitCode = %d, fAbort = %d\n", exitCode, fAbort);
CONTRACTL
{
DISABLED(GC_TRIGGERS);
NOTHROW;
}
CONTRACTL_END;
// The runtime must be in the appropriate thread mode when we exit, so that we
// aren't surprised by the thread mode when our DLL_PROCESS_DETACH occurs, or when
// other DLLs call Release() on us in their detach [dangerous!], etc.
GCX_PREEMP_NO_DTOR();
FastInterlockExchange((LONG*)&g_fForbidEnterEE, TRUE);
ProcessEventForHost(Event_ClrDisabled, NULL);
// Note that for free and retail builds StressLog must also be enabled
if (g_pConfig && g_pConfig->StressLog())
{
if (CLRConfig::GetConfigValue(CLRConfig::UNSUPPORTED_BreakOnBadExit))
{
// Workaround for aspnet
PathString wszFilename;
bool bShouldAssert = true;
if (WszGetModuleFileName(NULL, wszFilename))
{
wszFilename.LowerCase();
if (wcsstr(wszFilename, W("aspnet_compiler")))
{
bShouldAssert = false;
}
}
unsigned goodExit = CLRConfig::GetConfigValue(CLRConfig::UNSUPPORTED_SuccessExit);
if (bShouldAssert && exitCode != goodExit)
{
_ASSERTE(!"Bad Exit value");
FAULT_NOT_FATAL(); // if we OOM we can simply give up
SetErrorMode(0); // Insure that we actually cause the messsage box to pop.
EEMessageBoxCatastrophic(IDS_EE_ERRORMESSAGETEMPLATE, IDS_EE_ERRORTITLE, exitCode, W("BreakOnBadExit: returning bad exit code"));
}
}
}
// If we call ExitProcess, other threads will be torn down
// so we don't get to debug their state. Stop this!
#ifdef _DEBUG
if (_DbgBreakCount)
_ASSERTE(!"In SafeExitProcess: An assert was hit on some other thread");
#endif
// Turn off exception processing, because if some other random DLL has a
// fault in DLL_PROCESS_DETACH, we could get called for exception handling.
// Since we've turned off part of the runtime, we can't, for instance,
// properly execute the GC that handling an exception might trigger.
g_fNoExceptions = true;
LOG((LF_EH, LL_INFO10, "SafeExitProcess: turning off exceptions\n"));
if (sca == SCA_ExitProcessWhenShutdownComplete)
{
// disabled because if we fault in this code path we will trigger our
// Watson code via EntryPointFilter which is THROWS (see Dev11 317016)
CONTRACT_VIOLATION(ThrowsViolation);
#ifdef FEATURE_PAL
if (fAbort)
{
TerminateProcess(GetCurrentProcess(), exitCode);
}
#endif
EEPolicy::ExitProcessViaShim(exitCode);
}
}
// This is a helper to exit the process after coordinating with the shim. It is used by
// SafeExitProcess above, as well as from CorHost2::ExitProcess when we know that we must
// exit the process without doing further work to shutdown this runtime. This first attempts
// to call back to the Shim to shutdown any other runtimes within the process.
//
// IMPORTANT NOTE: exercise extreme caution when adding new calls to this method. It is highly
// likely that you want to call SafeExitProcess, or EEPolicy::HandleExitProcess instead of this.
// This function only exists to factor some common code out of the methods mentioned above.
//static
void EEPolicy::ExitProcessViaShim(UINT exitCode)
{
LIMITED_METHOD_CONTRACT;
// We must call back to the Shim in order to exit the process, as this may be just one
// runtime in a process with many. We need to give the other runtimes a chance to exit
// cleanly. If we can't make the call, or if the call fails for some reason, then we
// simply exit the process here, which is rude to the others, but the best we can do.
ExitProcess(exitCode);
}
//---------------------------------------------------------------------------------------
// DisableRuntime disables this runtime, suspending all managed execution and preventing
// threads from entering the runtime. This will cause the caller to block forever as well
// unless sca is SCA_ReturnWhenShutdownComplete.
//---------------------------------------------------------------------------------------
void DisableRuntime(ShutdownCompleteAction sca)
{
CONTRACTL
{
DISABLED(GC_TRIGGERS);
NOTHROW;
}
CONTRACTL_END;
FastInterlockExchange((LONG*)&g_fForbidEnterEE, TRUE);
if (!g_fSuspendOnShutdown)
{
if (!IsGCThread())
{
if (ThreadStore::HoldingThreadStore(GetThread()))
{
ThreadSuspend::UnlockThreadStore();
}
ThreadSuspend::SuspendEE(ThreadSuspend::SUSPEND_FOR_SHUTDOWN);
}
if (!g_fSuspendOnShutdown)
{
ThreadStore::TrapReturningThreads(TRUE);
g_fSuspendOnShutdown = TRUE;
ClrFlsSetThreadType(ThreadType_Shutdown);
}
// Don't restart runtime. CLR is disabled.
}
GCX_PREEMP_NO_DTOR();
ProcessEventForHost(Event_ClrDisabled, NULL);
ClrFlsClearThreadType(ThreadType_Shutdown);
if (g_pDebugInterface != NULL)
{
g_pDebugInterface->DisableDebugger();
}
if (sca == SCA_ExitProcessWhenShutdownComplete)
{
__SwitchToThread(INFINITE, CALLER_LIMITS_SPINNING);
_ASSERTE (!"Should not reach here");
SafeExitProcess(0);
}
}
//---------------------------------------------------------------------------------------
// HandleExitProcessHelper is used to shutdown the runtime as specified by the given
// action, then to exit the process. Note, however, that the process will not exit if
// sca is SCA_ReturnWhenShutdownComplete. In that case, this method will simply return after
// performing the shutdown actions.
//---------------------------------------------------------------------------------------
// If g_fFastExitProcess is 0, normal shutdown
// If g_fFastExitProcess is 1, fast shutdown. Only doing log.
// If g_fFastExitProcess is 2, do not run EEShutDown.
DWORD g_fFastExitProcess = 0;
extern void STDMETHODCALLTYPE EEShutDown(BOOL fIsDllUnloading);
static void HandleExitProcessHelper(EPolicyAction action, UINT exitCode, ShutdownCompleteAction sca)
{
WRAPPER_NO_CONTRACT;
switch (action) {
case eFastExitProcess:
g_fFastExitProcess = 1;
case eExitProcess:
if (g_fEEStarted)
{
EEShutDown(FALSE);
}
if (exitCode == 0)
{
exitCode = GetLatchedExitCode();
}
SafeExitProcess(exitCode, FALSE, sca);
break;
case eRudeExitProcess:
g_fFastExitProcess = 2;
SafeExitProcess(exitCode, TRUE, sca);
break;
case eDisableRuntime:
DisableRuntime(sca);
break;
default:
_ASSERTE (!"Invalid policy");
break;
}
}
EPolicyAction EEPolicy::DetermineResourceConstraintAction(Thread *pThread)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
MODE_ANY;
}
CONTRACTL_END;
EPolicyAction action;
if (pThread->HasLockInCurrentDomain()) {
action = GetEEPolicy()->GetActionOnFailure(FAIL_CriticalResource);
}
else
action = GetEEPolicy()->GetActionOnFailure(FAIL_NonCriticalResource);
AppDomain *pDomain = GetAppDomain();
// If it is default domain, we can not unload the appdomain
if (pDomain == SystemDomain::System()->DefaultDomain() &&
(action == eUnloadAppDomain || action == eRudeUnloadAppDomain))
{
action = eThrowException;
}
// If the current thread is AD unload helper thread, it should not block itself.
else if (pThread->HasThreadStateNC(Thread::TSNC_ADUnloadHelper) &&
action < eExitProcess)
{
action = eThrowException;
}
return action;
}
void EEPolicy::PerformADUnloadAction(EPolicyAction action, BOOL haveStack, BOOL forStackOverflow)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_COOPERATIVE;
STRESS_LOG0(LF_EH, LL_INFO100, "In EEPolicy::PerformADUnloadAction\n");
Thread *pThread = GetThread();
AppDomain *pDomain = GetAppDomain();
if (!IsFinalizerThread())
{
int count = 0;
Frame *pFrame = pThread->GetFirstTransitionInto(GetAppDomain(), &count);
{
pThread->SetUnloadBoundaryFrame(pFrame);
}
}
pDomain->EnableADUnloadWorker(action==eUnloadAppDomain? ADU_Safe : ADU_Rude);
// Can't perform a join when we are handling a true SO. We need to enable the unload woker but let the thread continue running
// through EH processing so that we can recover the stack and reset the guard page.
if (haveStack)
{
pThread->SetAbortRequest(action==eUnloadAppDomain? EEPolicy::TA_V1Compatible : EEPolicy::TA_Rude);
if (forStackOverflow)
{
OBJECTREF exceptObj = CLRException::GetPreallocatedRudeThreadAbortException();
pThread->SetAbortInitiated();
RaiseTheExceptionInternalOnly(exceptObj, FALSE, TRUE);
}
OBJECTREF exceptObj = CLRException::GetPreallocatedThreadAbortException();
pThread->SetAbortInitiated();
RaiseTheExceptionInternalOnly(exceptObj, FALSE, FALSE);
}
}
void EEPolicy::PerformResourceConstraintAction(Thread *pThread, EPolicyAction action, UINT exitCode, BOOL haveStack)
{
WRAPPER_NO_CONTRACT;
_ASSERTE(GetAppDomain() != NULL);
switch (action) {
case eThrowException:
// Caller is going to rethrow.
return;
break;
case eAbortThread:
pThread->UserAbort(Thread::TAR_Thread, TA_Safe, GetEEPolicy()->GetTimeout(OPR_ThreadAbort), Thread::UAC_Normal);
break;
case eRudeAbortThread:
pThread->UserAbort(Thread::TAR_Thread, TA_Rude, GetEEPolicy()->GetTimeout(OPR_ThreadAbort), Thread::UAC_Normal);
break;
case eUnloadAppDomain:
case eRudeUnloadAppDomain:
{
GCX_ASSERT_COOP();
PerformADUnloadAction(action,haveStack);
}
break;
case eExitProcess:
case eFastExitProcess:
case eRudeExitProcess:
case eDisableRuntime:
HandleExitProcessFromEscalation(action, exitCode);
break;
default:
_ASSERTE (!"Invalid policy");
break;
}
}
void EEPolicy::HandleOutOfMemory()
{
WRAPPER_NO_CONTRACT;
_ASSERTE (g_pOutOfMemoryExceptionClass);
Thread *pThread = GetThread();
_ASSERTE (pThread);
EPolicyAction action = DetermineResourceConstraintAction(pThread);
// Check if we are executing in the context of a Constrained Execution Region.
if (action != eThrowException && Thread::IsExecutingWithinCer())
{
// Hitting OOM in a CER region should throw the OOM without regard to the escalation policy
// since the CER author has declared they are hardened against such failures. That's
// the whole point of CERs, to denote regions where code knows exactly how to deal with
// failures in an attempt to minimize the need for rollback or recycling.
return;
}
PerformResourceConstraintAction(pThread, action, HOST_E_EXITPROCESS_OUTOFMEMORY, TRUE);
}
#ifdef FEATURE_STACK_PROBE
//---------------------------------------------------------------------------------------
//
// IsSOTolerant - Is the current thread in SO Tolerant region?
//
// Arguments:
// pLimitFrame: the limit of search for frames
//
// Return Value:
// TRUE if in SO tolerant region.
// FALSE if in SO intolerant region.
//
// Note:
// We walk our frame chain to decide. If HelperMethodFrame is seen first, we are in tolerant
// region. If EnterSOIntolerantCodeFrame is seen first, we are in intolerant region.
//
BOOL Thread::IsSOTolerant(void * pLimitFrame)
{
LIMITED_METHOD_CONTRACT;
Frame *pFrame = GetFrame();
void* pSOIntolerantMarker = ClrFlsGetValue(TlsIdx_SOIntolerantTransitionHandler);
if (pSOIntolerantMarker == FRAME_TOP)
{
// We have not set a marker for intolerant transition yet.
return TRUE;
}
while (pFrame != FRAME_TOP && pFrame < pLimitFrame)
{
Frame::ETransitionType type = pFrame->GetTransitionType();
if (pFrame > pSOIntolerantMarker)
{
return FALSE;
}
else if (type == Frame::TT_M2U || type == Frame::TT_InternalCall ||
// We can not call HelperMethodFrame::GetFunction on SO since the call
// may need to call into host. This is why we check for TT_InternalCall first.
pFrame->GetFunction() != NULL)
{
return TRUE;
}
pFrame = pFrame->Next();
}
if (pFrame == FRAME_TOP)
// We walked to the end of chain, but the thread has one IntolerantMarker on stack decided from
// the check above while loop.
return FALSE;
else
return TRUE;
}
#endif
//---------------------------------------------------------------------------------------
//
// EEPolicy::HandleStackOverflow - Handle stack overflow according to policy
//
// Arguments:
// detector:
// pLimitFrame: the limit of search for frames in order to decide if in SO tolerant
//
// Return Value:
// None.
//
// How is stack overflow handled?
// If stack overflows in non-hosted case, we terminate the process.
// For hosted case with escalation policy
// 1. If stack overflows in managed code, or in VM before switching to SO intolerant region, and the GC mode is Cooperative
// the domain is rudely unloaded, or the process is terminated if the current domain is default domain.
// a. This action is done through BEGIN_SO_TOLERANT_CODE if there is one.
// b. If there is not this macro on the stack, we mark the domain being unload requested, and when the thread
// dies or is recycled, we finish the AD unload.
// 2. If stack overflows in SO tolerant region, but the GC mode is Preemptive, the process is killed in vector handler, or our
// managed exception handler (COMPlusFrameHandler or ProcessCLRException).
// 3. If stack overflows in SO intolerant region, the process is killed as soon as the exception is seen by our vector handler, or
// our managed exception handler.
//
// If SO Probing code is disabled (by FEATURE_STACK_PROBE not defined) then the process
// is terminated if there is StackOverflow as all clr code will be considered SO Intolerant.
void EEPolicy::HandleStackOverflow(StackOverflowDetector detector, void * pLimitFrame)
{
WRAPPER_NO_CONTRACT;
STRESS_LOG0(LF_EH, LL_INFO100, "In EEPolicy::HandleStackOverflow\n");
Thread *pThread = GetThread();
if (pThread == NULL)
{
//_ASSERTE (detector != SOD_ManagedFrameHandler);
// ProcessSOEventForHost(NULL, FALSE);
// For security reason, it is not safe to continue execution if stack overflow happens
// unless a host tells us to do something different.
// EEPolicy::HandleFatalStackOverflow(NULL);
return;
}
#ifdef FEATURE_STACK_PROBE
// We only process SO once at
// 1. VectoredExceptionHandler if SO in mscorwks
// 2. managed exception handler
// 3. SO_Tolerant transition handler
if (pThread->HasThreadStateNC(Thread::TSNC_SOWorkNeeded) &&
detector != SOD_UnmanagedFrameHandler)
{
return;
}
#endif
#ifdef FEATURE_STACK_PROBE
BOOL fInSoTolerant = pThread->IsSOTolerant(pLimitFrame);
#else
BOOL fInSoTolerant = false;
#endif
EXCEPTION_POINTERS exceptionInfo;
GetCurrentExceptionPointers(&exceptionInfo);
_ASSERTE(exceptionInfo.ExceptionRecord);
#ifdef FEATURE_STACK_PROBE
DWORD exceptionCode = exceptionInfo.ExceptionRecord->ExceptionCode;
AppDomain *pCurrentDomain = ::GetAppDomain();
BOOL fInDefaultDomain = (pCurrentDomain == SystemDomain::System()->DefaultDomain());
BOOL fInCLR = IsIPInModule(g_pMSCorEE, (PCODE)GetIP(exceptionInfo.ContextRecord));
if (exceptionCode == EXCEPTION_SOFTSO)
{
// Our probe detects a thread does not have enough stack. But we have not trashed the process
// state yet.
fInSoTolerant = TRUE;
}
else
{
_ASSERTE (exceptionCode == STATUS_STACK_OVERFLOW);
switch (detector)
{
case SOD_ManagedFrameHandler:
if (!pThread->PreemptiveGCDisabled() && !fInCLR && fInSoTolerant)
{
// Managed exception handler detects SO, but the thread is in preemptive GC mode,
// and the IP is outside CLR. This means we are inside a PINVOKE call.
fInSoTolerant = FALSE;
}
break;
case SOD_UnmanagedFrameHandler:
break;
case SOD_SOIntolerantTransitor:
fInSoTolerant = FALSE;
break;
case SOD_SOTolerantTransitor:
if (!fInCLR)
{
// If SO happens outside of CLR, and it is not detected by managed frame handler,
// it is fatal
fInSoTolerant = FALSE;
}
break;
default:
_ASSERTE(!"should not get here");
}
if (fInDefaultDomain)
{
// StackOverflow in default domain is fatal
fInSoTolerant = FALSE;
}
}
#endif // FEATURE_STACK_PROBE
ProcessSOEventForHost(&exceptionInfo, fInSoTolerant);
#ifdef FEATURE_STACK_PROBE
if (!CLRHosted() || GetEEPolicy()->GetActionOnFailure(FAIL_StackOverflow) != eRudeUnloadAppDomain)
{
// For security reason, it is not safe to continue execution if stack overflow happens
// unless a host tells us to do something different.
EEPolicy::HandleFatalStackOverflow(&exceptionInfo);
}
#endif
if (!fInSoTolerant)
{
EEPolicy::HandleFatalStackOverflow(&exceptionInfo);
}
#ifdef FEATURE_STACK_PROBE
else
{
// EnableADUnloadWorker is SO_Intolerant.
// But here we know that if we have only one page, we will only update states of the Domain.
CONTRACT_VIOLATION(SOToleranceViolation);
// Mark the current domain requested for rude unload
if (!fInDefaultDomain)
{
pCurrentDomain->EnableADUnloadWorker(ADU_Rude, FALSE);
}
pThread->PrepareThreadForSOWork();
pThread->MarkThreadForAbort(
(Thread::ThreadAbortRequester)(Thread::TAR_Thread|Thread::TAR_StackOverflow),
EEPolicy::TA_Rude);
pThread->SetSOWorkNeeded();
}
#endif
}
// We provide WatsonLastChance with a SO exception record. The ExceptionAddress is set to 0
// here. This ExceptionPointers struct is handed off to the debugger as is. A copy of this struct
// is made before invoking Watson and the ExceptionAddress is set by inspecting the stack. Note
// that the ExceptionContext member is unused and so it's ok to set it to NULL.
static EXCEPTION_RECORD g_SOExceptionRecord = {
STATUS_STACK_OVERFLOW, // ExceptionCode
0, // ExceptionFlags
NULL, // ExceptionRecord
0, // ExceptionAddress
0, // NumberOfParameters
{} }; // ExceptionInformation
EXCEPTION_POINTERS g_SOExceptionPointers = {&g_SOExceptionRecord, NULL};
#ifdef FEATURE_STACK_PROBE
// This function may be called on a thread before debugger is notified of the thread, like in
// ManagedThreadBase_DispatchMiddle. Currently we can not notify managed debugger, because
// RS requires that notification is sent first.
void EEPolicy::HandleSoftStackOverflow(BOOL fSkipDebugger)
{
WRAPPER_NO_CONTRACT;
// If we trigger a SO while handling the soft stack overflow,
// we'll rip the process
BEGIN_SO_INTOLERANT_CODE_NOPROBE;
AppDomain *pCurrentDomain = ::GetAppDomain();
if (GetEEPolicy()->GetActionOnFailure(FAIL_StackOverflow) != eRudeUnloadAppDomain ||
pCurrentDomain == SystemDomain::System()->DefaultDomain())
{
// We may not be able to build a context on stack
ProcessSOEventForHost(NULL, FALSE);
EEPolicy::HandleFatalStackOverflow(&g_SOExceptionPointers, fSkipDebugger);
}
//else if (pCurrentDomain == SystemDomain::System()->DefaultDomain())
//{
// We hit soft SO in Default domain, but default domain can not be unloaded.
// Soft SO can happen in default domain, eg. GetResourceString, or EnsureGrantSetSerialized.
// So the caller is going to throw a managed exception.
// RaiseException(EXCEPTION_SOFTSO, 0, 0, NULL);
//}
else
{
Thread* pThread = GetThread();
if (pThread && pThread->PreemptiveGCDisabled())
{
// Mark the current domain requested for rude unload
GCX_ASSERT_COOP();
EEPolicy::PerformADUnloadAction(eRudeUnloadAppDomain, TRUE, TRUE);
}
// We are leaving VM boundary, either entering managed code, or entering
// non-VM unmanaged code.
// We should not throw internal C++ exception. Instead we throw an exception
// with EXCEPTION_SOFTSO code.
RaiseException(EXCEPTION_SOFTSO, 0, 0, NULL);
}
END_SO_INTOLERANT_CODE_NOPROBE;
}
void EEPolicy::HandleStackOverflowAfterCatch()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
SO_TOLERANT;
MODE_ANY;
}
CONTRACTL_END;
#ifdef STACK_GUARDS_DEBUG
BaseStackGuard::RestoreCurrentGuard(FALSE);
#endif
Thread *pThread = GetThread();
pThread->RestoreGuardPage();
pThread->FinishSOWork();
}
#endif
//---------------------------------------------------------------------------------------
// HandleExitProcess is used to shutdown the runtime, based on policy previously set,
// then to exit the process. Note, however, that the process will not exit if
// sca is SCA_ReturnWhenShutdownComplete. In that case, this method will simply return after
// performing the shutdown actions.
//---------------------------------------------------------------------------------------
void EEPolicy::HandleExitProcess(ShutdownCompleteAction sca)
{
WRAPPER_NO_CONTRACT;
STRESS_LOG0(LF_EH, LL_INFO100, "In EEPolicy::HandleExitProcess\n");
EPolicyAction action = GetEEPolicy()->GetDefaultAction(OPR_ProcessExit, NULL);
GetEEPolicy()->NotifyHostOnDefaultAction(OPR_ProcessExit,action);
HandleExitProcessHelper(action, 0, sca);
}
StackWalkAction LogCallstackForLogCallback(
CrawlFrame *pCF, //
VOID* pData // Caller's private data
)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
SO_INTOLERANT;
MODE_ANY;
}
CONTRACTL_END;
SmallStackSString *pWordAt = ((SmallStackSString*)pData);
MethodDesc *pMD = pCF->GetFunction();
_ASSERTE(pMD != NULL);
StackSString str;
str = *pWordAt;
TypeString::AppendMethodInternal(str, pMD, TypeString::FormatNamespace|TypeString::FormatFullInst|TypeString::FormatSignature);
PrintToStdErrW(str.GetUnicode());
PrintToStdErrA("\n");
return SWA_CONTINUE;
}
//---------------------------------------------------------------------------------------
//
// A worker to save managed stack trace.
//
// Arguments:
// None
//
// Return Value:
// None
//
inline void LogCallstackForLogWorker()
{
Thread* pThread = GetThread();
_ASSERTE (pThread);
SmallStackSString WordAt;
if (!WordAt.LoadResource(CCompRC::Optional, IDS_ER_WORDAT))
{
WordAt.Set(W(" at"));
}
else
{
WordAt.Insert(WordAt.Begin(), W(" "));
}
WordAt += W(" ");
pThread->StackWalkFrames(&LogCallstackForLogCallback, &WordAt, QUICKUNWIND | FUNCTIONSONLY);
}
//---------------------------------------------------------------------------------------
//
// Generate an EventLog entry for unhandled exception.
//
// Arguments:
// pExceptionInfo - Exception information
//
// Return Value:
// None
//
inline void DoLogForFailFastException(LPCWSTR pszMessage, PEXCEPTION_POINTERS pExceptionInfo, LPCWSTR errorSource, LPCWSTR argExceptionString)
{
WRAPPER_NO_CONTRACT;
Thread *pThread = GetThread();
EX_TRY
{
if (errorSource == NULL)
{
PrintToStdErrA("FailFast:");
}
else
{
PrintToStdErrW((WCHAR*)errorSource);
}
PrintToStdErrA("\n");
PrintToStdErrW((WCHAR*)pszMessage);
PrintToStdErrA("\n");
if (pThread && errorSource == NULL)
{
PrintToStdErrA("\n");
LogCallstackForLogWorker();
if (argExceptionString != NULL) {
PrintToStdErrA("\n");
PrintToStdErrA("Exception details:");
PrintToStdErrA("\n");
PrintToStdErrW((WCHAR*)argExceptionString);
PrintToStdErrA("\n");
}
}
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions)
}
//
// Log an error to the event log if possible, then throw up a dialog box.
//
void EEPolicy::LogFatalError(UINT exitCode, UINT_PTR address, LPCWSTR pszMessage, PEXCEPTION_POINTERS pExceptionInfo, LPCWSTR errorSource, LPCWSTR argExceptionString)
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_ANY;
_ASSERTE(pExceptionInfo != NULL);
// Log FailFast exception to StdErr
if (exitCode == (UINT)COR_E_FAILFAST)
{
DoLogForFailFastException(pszMessage, pExceptionInfo, errorSource, argExceptionString);
}
if(ETW_EVENT_ENABLED(MICROSOFT_WINDOWS_DOTNETRUNTIME_PRIVATE_PROVIDER_Context, FailFast))
{
// Fire an ETW FailFast event
FireEtwFailFast(pszMessage,
(const PVOID)address,
((pExceptionInfo && pExceptionInfo->ExceptionRecord) ? pExceptionInfo->ExceptionRecord->ExceptionCode : 0),
exitCode,
GetClrInstanceId());
}
#ifndef FEATURE_PAL
// Write an event log entry. We do allocate some resources here (spread between the stack and maybe the heap for longer
// messages), so it's possible for the event write to fail. If needs be we can use a more elaborate scheme here in the future
// (maybe trying multiple approaches and backing off on failure, falling back on a limited size static buffer as a last
// resort). In all likelihood the Win32 event reporting mechanism requires resources though, so it's not clear how much
// effort we should put into this without knowing the benefit we'd receive.
EX_TRY
{
if (ShouldLogInEventLog())
{
// If the exit code is COR_E_FAILFAST then the fatal error was raised by managed code and the address argument points to a
// unicode message buffer rather than a faulting EIP.
EventReporter::EventReporterType failureType = EventReporter::ERT_UnmanagedFailFast;
if (exitCode == (UINT)COR_E_FAILFAST)
failureType = EventReporter::ERT_ManagedFailFast;
else if (exitCode == (UINT)COR_E_CODECONTRACTFAILED)
failureType = EventReporter::ERT_CodeContractFailed;
EventReporter reporter(failureType);
StackSString s(argExceptionString);
if ((exitCode == (UINT)COR_E_FAILFAST) || (exitCode == (UINT)COR_E_CODECONTRACTFAILED) || (exitCode == (UINT)CLR_E_GC_OOM))
{
if (pszMessage)
{
reporter.AddDescription((WCHAR*)pszMessage);
}
if (argExceptionString)
{
reporter.AddFailFastStackTrace(s);
}
if (exitCode != (UINT)CLR_E_GC_OOM)
LogCallstackForEventReporter(reporter);
}
else
{
// Fetch the localized Fatal Execution Engine Error text or fall back on a hardcoded variant if things get dire.
InlineSString<80> ssMessage;
InlineSString<80> ssErrorFormat;
if(!ssErrorFormat.LoadResource(CCompRC::Optional, IDS_ER_UNMANAGEDFAILFASTMSG ))
ssErrorFormat.Set(W("at IP %1 (%2) with exit code %3."));
SmallStackSString addressString;
addressString.Printf(W("%p"), pExceptionInfo? (UINT_PTR)pExceptionInfo->ExceptionRecord->ExceptionAddress : address);
// We should always have the reference to the runtime's instance
_ASSERTE(g_pMSCorEE != NULL);
// Setup the string to contain the runtime's base address. Thus, when customers report FEEE with just
// the event log entry containing this string, we can use the absolute and base addresses to determine
// where the fault happened inside the runtime.
SmallStackSString runtimeBaseAddressString;
runtimeBaseAddressString.Printf(W("%p"), g_pMSCorEE);
SmallStackSString exitCodeString;
exitCodeString.Printf(W("%x"), exitCode);
// Format the string
ssMessage.FormatMessage(FORMAT_MESSAGE_FROM_STRING, (LPCWSTR)ssErrorFormat, 0, 0, addressString, runtimeBaseAddressString,
exitCodeString);
reporter.AddDescription(ssMessage);
}
reporter.Report();
}
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions)
#endif // !FEATURE_PAL
#ifdef _DEBUG
// If we're native-only (Win32) debugging this process, we'd love to break now.
// However, we should not do this because a managed debugger attached to a
// SxS runtime also appears to be a native debugger. Unfortunately, the managed
// debugger won't handle any native event from another runtime, which means this
// breakpoint would go unhandled and terminate the process. Instead, we will let
// the process continue so at least the fatal error is logged rather than abrupt
// termination.
//
// This behavior can still be overridden if the right config value is set.
if (IsDebuggerPresent())
{
bool fBreak = (CLRConfig::GetConfigValue(CLRConfig::INTERNAL_DbgOOBinFEEE) != 0);
if (fBreak)
{
DebugBreak();
}
}
#endif // _DEBUG
// We're here logging a fatal error. If the policy is to then do anything other than
// disable the runtime (ie, if the policy is to terminate the runtime), we should give
// Watson an opportunity to capture an error report.
// Presumably, hosts that are sophisticated enough to disable the runtime are also cognizant
// of how they want to handle fatal errors in the runtime, including whether they want
// to capture Watson information (for which they are responsible).
if (GetEEPolicy()->GetActionOnFailureNoHostNotification(FAIL_FatalRuntime) != eDisableRuntime)
{
#ifdef DEBUGGING_SUPPORTED
//Give a managed debugger a chance if this fatal error is on a managed thread.
Thread *pThread = GetThread();
if (pThread)
{
GCX_COOP();
OBJECTHANDLE ohException = NULL;
if (exitCode == (UINT)COR_E_STACKOVERFLOW)
{
// If we're going down because of stack overflow, go ahead and use the preallocated SO exception.
ohException = CLRException::GetPreallocatedStackOverflowExceptionHandle();
}
else
{
// Though we would like to remove the usage of ExecutionEngineException in any manner,
// we cannot. Its okay to use it in the case below since the process is terminating
// and this will serve as an exception object for debugger.
ohException = CLRException::GetPreallocatedExecutionEngineExceptionHandle();
}
// Preallocated exception handles can be null if FailFast is invoked before LoadBaseSystemClasses
// (in SystemDomain::Init) finished. See Dev10 Bug 677432 for the detail.
if (ohException != NULL)
{
// for fail-fast, if there's a LTO available then use that as the inner exception object
// for the FEEE we'll be reporting. this can help the Watson back-end to generate better
// buckets for apps that call Environment.FailFast() and supply an exception object.
OBJECTREF lto = pThread->LastThrownObject();
if (exitCode == static_cast<UINT>(COR_E_FAILFAST) && lto != NULL)
{
EXCEPTIONREF curEx = (EXCEPTIONREF)ObjectFromHandle(ohException);
curEx->SetInnerException(lto);
}
pThread->SetLastThrownObject(ObjectFromHandle(ohException), TRUE);
}
// If a managed debugger is already attached, and if that debugger is thinking it might be inclined to
// try to intercept this excepiton, then tell it that's not possible.
if (pThread->IsExceptionInProgress())
{
pThread->GetExceptionState()->GetFlags()->SetDebuggerInterceptNotPossible();
}
}
if (EXCEPTION_CONTINUE_EXECUTION == WatsonLastChance(pThread, pExceptionInfo, TypeOfReportedError::FatalError))
{
LOG((LF_EH, LL_INFO100, "EEPolicy::LogFatalError: debugger ==> EXCEPTION_CONTINUE_EXECUTION\n"));
_ASSERTE(!"Debugger should not have returned ContinueExecution");
}
#endif // DEBUGGING_SUPPORTED
}
}
void DisplayStackOverflowException()
{
LIMITED_METHOD_CONTRACT;
PrintToStdErrA("\n");
PrintToStdErrA("Process is terminating due to StackOverflowException.\n");
}
void DECLSPEC_NORETURN EEPolicy::HandleFatalStackOverflow(EXCEPTION_POINTERS *pExceptionInfo, BOOL fSkipDebugger)
{
// This is fatal error. We do not care about SO mode any more.
// All of the code from here on out is robust to any failures in any API's that are called.
CONTRACT_VIOLATION(GCViolation | ModeViolation | SOToleranceViolation | FaultNotFatal | TakesLockViolation);
WRAPPER_NO_CONTRACT;
STRESS_LOG0(LF_EH, LL_INFO100, "In EEPolicy::HandleFatalStackOverflow\n");
DisplayStackOverflowException();
if(ETW_EVENT_ENABLED(MICROSOFT_WINDOWS_DOTNETRUNTIME_PRIVATE_PROVIDER_Context, FailFast))
{
// Fire an ETW FailFast event
FireEtwFailFast(W("StackOverflowException"),
(const PVOID)((pExceptionInfo && pExceptionInfo->ContextRecord) ? GetIP(pExceptionInfo->ContextRecord) : 0),
((pExceptionInfo && pExceptionInfo->ExceptionRecord) ? pExceptionInfo->ExceptionRecord->ExceptionCode : 0),
COR_E_STACKOVERFLOW,
GetClrInstanceId());
}
if (!fSkipDebugger)
{
Thread *pThread = GetThread();
BOOL fTreatAsNativeUnhandledException = FALSE;
if (pThread)
{
GCX_COOP();
// If we had a SO before preallocated exception objects are initialized, we will AV here. This can happen
// during the initialization of SystemDomain during EEStartup. Thus, setup the SO throwable only if its not
// NULL.
//
// When WatsonLastChance (WLC) is invoked below, it treats this case as UnhandledException. If there is no
// managed exception object available, we should treat this case as NativeUnhandledException. This aligns
// well with the fact that there cannot be a managed debugger attached at this point that will require
// LastChanceManagedException notification to be delivered. Also, this is the same as how
// we treat an unhandled exception as NativeUnhandled when throwable is not available.
OBJECTHANDLE ohSO = CLRException::GetPreallocatedStackOverflowExceptionHandle();
if (ohSO != NULL)
{
pThread->SafeSetThrowables(ObjectFromHandle(ohSO)
DEBUG_ARG(ThreadExceptionState::STEC_CurrentTrackerEqualNullOkHackForFatalStackOverflow),
TRUE);
}
else
{
// We dont have a throwable - treat this as native unhandled exception
fTreatAsNativeUnhandledException = TRUE;
}
}
FrameWithCookie<FaultingExceptionFrame> fef;
#if defined(WIN64EXCEPTIONS)
*((&fef)->GetGSCookiePtr()) = GetProcessGSCookie();
#endif // WIN64EXCEPTIONS
if (pExceptionInfo && pExceptionInfo->ContextRecord)
{
GCX_COOP();
fef.InitAndLink(pExceptionInfo->ContextRecord);
}
#ifndef FEATURE_PAL
if (IsWatsonEnabled() && (g_pDebugInterface != NULL))
{
_ASSERTE(pExceptionInfo != NULL);
ResetWatsonBucketsParams param;
param.m_pThread = pThread;
param.pExceptionRecord = pExceptionInfo->ExceptionRecord;
g_pDebugInterface->RequestFavor(ResetWatsonBucketsFavorWorker, reinterpret_cast<void *>(¶m));
}
#endif // !FEATURE_PAL
WatsonLastChance(pThread, pExceptionInfo,
(fTreatAsNativeUnhandledException == FALSE)? TypeOfReportedError::UnhandledException: TypeOfReportedError::NativeThreadUnhandledException);
}
TerminateProcess(GetCurrentProcess(), COR_E_STACKOVERFLOW);
UNREACHABLE();
}
void DECLSPEC_NORETURN EEPolicy::HandleFatalError(UINT exitCode, UINT_PTR address, LPCWSTR pszMessage /* = NULL */, PEXCEPTION_POINTERS pExceptionInfo /* = NULL */, LPCWSTR errorSource /* = NULL */, LPCWSTR argExceptionString /* = NULL */)
{
WRAPPER_NO_CONTRACT;
// All of the code from here on out is robust to any failures in any API's that are called.
FAULT_NOT_FATAL();
EXCEPTION_RECORD exceptionRecord;
EXCEPTION_POINTERS exceptionPointers;
CONTEXT context;
if (pExceptionInfo == NULL)
{
ZeroMemory(&exceptionPointers, sizeof(exceptionPointers));
ZeroMemory(&exceptionRecord, sizeof(exceptionRecord));
ZeroMemory(&context, sizeof(context));
context.ContextFlags = CONTEXT_CONTROL;
ClrCaptureContext(&context);
exceptionRecord.ExceptionCode = exitCode;
exceptionRecord.ExceptionAddress = reinterpret_cast< PVOID >(address);
exceptionPointers.ExceptionRecord = &exceptionRecord;
exceptionPointers.ContextRecord = &context;
pExceptionInfo = &exceptionPointers;
}
// All of the code from here on out is allowed to trigger a GC, even if we're in a no-trigger region. We're
// ripping the process down due to a fatal error... our invariants are already gone.
{
// This is fatal error. We do not care about SO mode any more.
// All of the code from here on out is robust to any failures in any API's that are called.
CONTRACT_VIOLATION(GCViolation | ModeViolation | SOToleranceViolation | FaultNotFatal | TakesLockViolation);
// ThreadStore lock needs to be released before continuing with the FatalError handling should
// because debugger is going to take CrstDebuggerMutex, whose lock level is higher than that of
// CrstThreadStore. It should be safe to release the lock since execution will not be resumed
// after fatal errors.
if (ThreadStore::HoldingThreadStore(GetThread()))
{
ThreadSuspend::UnlockThreadStore();
}
g_fFastExitProcess = 2;
STRESS_LOG0(LF_CORDB,LL_INFO100, "D::HFE: About to call LogFatalError\n");
switch (GetEEPolicy()->GetActionOnFailure(FAIL_FatalRuntime))
{
case eRudeExitProcess:
LogFatalError(exitCode, address, pszMessage, pExceptionInfo, errorSource, argExceptionString);
SafeExitProcess(exitCode, TRUE);
break;
case eDisableRuntime:
LogFatalError(exitCode, address, pszMessage, pExceptionInfo, errorSource, argExceptionString);
DisableRuntime(SCA_ExitProcessWhenShutdownComplete);
break;
default:
_ASSERTE(!"Invalid action for FAIL_FatalRuntime");
break;
}
}
UNREACHABLE();
}
void EEPolicy::HandleExitProcessFromEscalation(EPolicyAction action, UINT exitCode)
{
WRAPPER_NO_CONTRACT;
CONTRACT_VIOLATION(GCViolation);
_ASSERTE (action >= eExitProcess);
// If policy for ExitProcess is not default action, i.e. ExitProcess, we will use it.
// Otherwise overwrite it with passing arg action;
EPolicyAction todo = GetEEPolicy()->GetDefaultAction(OPR_ProcessExit, NULL);
if (todo == eExitProcess)
{
todo = action;
}
GetEEPolicy()->NotifyHostOnDefaultAction(OPR_ProcessExit,todo);
HandleExitProcessHelper(todo, exitCode, SCA_ExitProcessWhenShutdownComplete);
}
void EEPolicy::HandleCodeContractFailure(LPCWSTR pMessage, LPCWSTR pCondition, LPCWSTR pInnerExceptionAsString)
{
WRAPPER_NO_CONTRACT;
EEPolicy* pPolicy = GetEEPolicy();
// GetActionOnFailure will notify the host for us.
EPolicyAction action = pPolicy->GetActionOnFailure(FAIL_CodeContract);
Thread* pThread = GetThread();
AppDomain* pCurrentDomain = ::GetAppDomain();
switch(action) {
case eThrowException:
// Let managed code throw a ContractException (it's easier to pass the right parameters to the constructor).
break;
case eAbortThread:
pThread->UserAbort(Thread::TAR_Thread, TA_Safe, GetEEPolicy()->GetTimeout(OPR_ThreadAbort), Thread::UAC_Normal);
break;
case eRudeAbortThread:
pThread->UserAbort(Thread::TAR_Thread, TA_Rude, GetEEPolicy()->GetTimeout(OPR_ThreadAbort), Thread::UAC_Normal);
break;
case eUnloadAppDomain:
// Register an appdomain unload, which starts on a separate thread.
IfFailThrow(AppDomain::UnloadById(pCurrentDomain->GetId(), FALSE));
// Don't continue execution on this thread.
pThread->UserAbort(Thread::TAR_Thread, TA_Safe, GetEEPolicy()->GetTimeout(OPR_ThreadAbort), Thread::UAC_Normal);
break;
case eRudeUnloadAppDomain:
pCurrentDomain->SetRudeUnload();
// Register an appdomain unload, which starts on a separate thread.
IfFailThrow(AppDomain::UnloadById(pCurrentDomain->GetId(), FALSE));
// Don't continue execution on this thread.
pThread->UserAbort(Thread::TAR_Thread, TA_Rude, GetEEPolicy()->GetTimeout(OPR_ThreadAbort), Thread::UAC_Normal);
break;
case eExitProcess: // Merged w/ default case
default:
_ASSERTE(action == eExitProcess);
// Since we have no exception object, make sure
// UE tracker is clean so that RetrieveManagedBucketParameters
// does not take any bucket details.
#ifndef FEATURE_PAL
pThread->GetExceptionState()->GetUEWatsonBucketTracker()->ClearWatsonBucketDetails();
#endif // !FEATURE_PAL
pPolicy->HandleFatalError(COR_E_CODECONTRACTFAILED, NULL, pMessage);
break;
}
}
|