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
|
// 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.
// ===========================================================================
#include "common.h"
#include "finalizerthread.h"
#include "threadsuspend.h"
#ifdef FEATURE_COMINTEROP
#include "runtimecallablewrapper.h"
#endif
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
#include "profattach.h"
#endif // FEATURE_PROFAPI_ATTACH_DETACH
BOOL FinalizerThread::fRunFinalizersOnUnload = FALSE;
BOOL FinalizerThread::fQuitFinalizer = FALSE;
#if defined(__linux__) && defined(FEATURE_EVENT_TRACE)
#define LINUX_HEAP_DUMP_TIME_OUT 10000
extern bool s_forcedGCInProgress;
ULONGLONG FinalizerThread::LastHeapDumpTime = 0;
Volatile<BOOL> g_TriggerHeapDump = FALSE;
#endif // __linux__
AppDomain * FinalizerThread::UnloadingAppDomain;
CLREvent * FinalizerThread::hEventFinalizer = NULL;
CLREvent * FinalizerThread::hEventFinalizerDone = NULL;
CLREvent * FinalizerThread::hEventShutDownToFinalizer = NULL;
CLREvent * FinalizerThread::hEventFinalizerToShutDown = NULL;
HANDLE FinalizerThread::MHandles[kHandleCount];
BOOL FinalizerThread::IsCurrentThreadFinalizer()
{
LIMITED_METHOD_CONTRACT;
return GetThread() == g_pFinalizerThread;
}
void FinalizerThread::EnableFinalization()
{
WRAPPER_NO_CONTRACT;
hEventFinalizer->Set();
}
BOOL FinalizerThread::HaveExtraWorkForFinalizer()
{
WRAPPER_NO_CONTRACT;
return GetFinalizerThread()->HaveExtraWorkForFinalizer();
}
// This helper is here to avoid EH goo associated with DefineFullyQualifiedNameForStack being
// invoked when logging is off.
__declspec(noinline)
void LogFinalization(Object* obj)
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_MODE_ANY;
#ifdef FEATURE_EVENT_TRACE
ETW::GCLog::SendFinalizeObjectEvent(obj->GetMethodTable(), obj);
#endif // FEATURE_EVENT_TRACE
}
void CallFinalizer(Object* obj)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_COOPERATIVE;
MethodTable *pMT = obj->GetMethodTable();
STRESS_LOG2(LF_GC, LL_INFO1000, "Finalizing object %p MT %pT\n", obj, pMT);
LOG((LF_GC, LL_INFO1000, "Finalizing " LOG_OBJECT_CLASS(obj)));
_ASSERTE(GetThread()->PreemptiveGCDisabled());
// if we don't have a class, we can't call the finalizer
// if the object has been marked run as finalizer run don't call either
if (pMT)
{
if (!((obj->GetHeader()->GetBits()) & BIT_SBLK_FINALIZER_RUN))
{
_ASSERTE(obj->GetMethodTable() == pMT);
_ASSERTE(pMT->HasFinalizer() || pMT->IsTransparentProxy());
LogFinalization(obj);
MethodTable::CallFinalizer(obj);
}
else
{
//reset the bit so the object can be put on the list
//with RegisterForFinalization
obj->GetHeader()->ClrBit (BIT_SBLK_FINALIZER_RUN);
}
}
}
struct FinalizeAllObjects_Args {
OBJECTREF fobj;
int bitToCheck;
};
void FinalizerThread::FinalizeAllObjects_Wrapper(void *ptr)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_COOPERATIVE;
FinalizeAllObjects_Args *args = (FinalizeAllObjects_Args *) ptr;
_ASSERTE(args->fobj);
Object *fobj = OBJECTREFToObject(args->fobj);
args->fobj = NULL; // don't want to do this guy again, if we take an exception here:
args->fobj = ObjectToOBJECTREF(FinalizeAllObjects(fobj, args->bitToCheck));
}
// The following is inadequate when we have multiple Finalizer threads in some future release.
// Instead, we will have to store this in TLS or pass it through the call tree of finalization.
// It is used to tie together the base exception handling and the AppDomain transition exception
// handling for this thread.
static struct ManagedThreadCallState *pThreadTurnAround;
Object * FinalizerThread::DoOneFinalization(Object* fobj, Thread* pThread,int bitToCheck,bool *pbTerminate)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_COOPERATIVE;
bool fTerminate=false;
Object *pReturnObject = NULL;
AppDomain* targetAppDomain = fobj->GetAppDomain();
AppDomain* currentDomain = pThread->GetDomain();
if (! targetAppDomain || ! targetAppDomain->CanThreadEnter(pThread))
{
// if can't get into domain to finalize it, then it must be agile so finalize in current domain
targetAppDomain = currentDomain;
#if CHECK_APP_DOMAIN_LEAKS
{
// object must be agile if can't get into it's domain
if (g_pConfig->AppDomainLeaks() && !fobj->TrySetAppDomainAgile(FALSE))
_ASSERTE(!"Found non-agile GC object which should have been finalized during app domain unload.");
}
#endif
}
if (targetAppDomain == currentDomain)
{
if (!targetAppDomain->IsRudeUnload() ||
fobj->GetMethodTable()->HasCriticalFinalizer())
{
class ResetFinalizerStartTime
{
public:
ResetFinalizerStartTime()
{
if (CLRHosted())
{
g_ObjFinalizeStartTime = CLRGetTickCount64();
}
}
~ResetFinalizerStartTime()
{
if (g_ObjFinalizeStartTime)
{
g_ObjFinalizeStartTime = 0;
}
}
};
{
ThreadLocaleHolder localeHolder;
{
ResetFinalizerStartTime resetTime;
CallFinalizer(fobj);
}
}
pThread->InternalReset(FALSE);
}
}
else
{
if (! targetAppDomain->GetDefaultContext())
{
// Can no longer enter domain becuase the handle containing the context has been
// destroyed so just bail. Should only get this if are at the stage of nuking the
// handles in the domain if it's still open.
_ASSERTE(targetAppDomain->IsUnloading() && targetAppDomain->ShouldHaveFinalization());
}
else if (!currentDomain->IsDefaultDomain())
{
// this means we are in some other domain, so need to return back out through the DoADCallback
// and handle the object from there in another domain.
pReturnObject = fobj;
fTerminate = true;
}
else
{
// otherwise call back to ourselves to process as many as we can in that other domain
FinalizeAllObjects_Args args;
args.fobj = ObjectToOBJECTREF(fobj);
args.bitToCheck = bitToCheck;
GCPROTECT_BEGIN(args.fobj);
{
ThreadLocaleHolder localeHolder;
_ASSERTE(pThreadTurnAround != NULL);
ManagedThreadBase::FinalizerAppDomain(targetAppDomain,
FinalizeAllObjects_Wrapper,
&args,
pThreadTurnAround);
}
pThread->InternalReset(FALSE);
// process the object we got back or be done if we got back null
pReturnObject = OBJECTREFToObject(args.fobj);
GCPROTECT_END();
}
}
*pbTerminate = fTerminate;
return pReturnObject;
}
Object * FinalizerThread::FinalizeAllObjects(Object* fobj, int bitToCheck)
{
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_TRIGGERS;
STATIC_CONTRACT_MODE_COOPERATIVE;
FireEtwGCFinalizersBegin_V1(GetClrInstanceId());
unsigned int fcount = 0;
bool fTerminate = false;
if (fobj == NULL)
{
if (AppDomain::HasWorkForFinalizerThread())
{
return NULL;
}
fobj = GCHeapUtilities::GetGCHeap()->GetNextFinalizable();
}
Thread *pThread = GetThread();
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
ULONGLONG ui64TimestampLastCheckedProfAttachEventMs = 0;
#endif //FEATURE_PROFAPI_ATTACH_DETACH
// Finalize everyone
while (fobj)
{
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
// Don't let an overloaded finalizer queue starve out
// an attaching profiler. In between running finalizers,
// check the profiler attach event without blocking.
ProcessProfilerAttachIfNecessary(&ui64TimestampLastCheckedProfAttachEventMs);
#endif // FEATURE_PROFAPI_ATTACH_DETACH
if (fobj->GetHeader()->GetBits() & bitToCheck)
{
if (AppDomain::HasWorkForFinalizerThread())
{
return NULL;
}
fobj = GCHeapUtilities::GetGCHeap()->GetNextFinalizable();
}
else
{
fcount++;
fobj = DoOneFinalization(fobj, pThread, bitToCheck,&fTerminate);
if (fTerminate)
{
break;
}
if (fobj == NULL)
{
if (AppDomain::HasWorkForFinalizerThread())
{
return NULL;
}
fobj = GCHeapUtilities::GetGCHeap()->GetNextFinalizable();
}
}
}
FireEtwGCFinalizersEnd_V1(fcount, GetClrInstanceId());
return fobj;
}
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
// ----------------------------------------------------------------------------
// ProcessProfilerAttachIfNecessary
//
// Description:
// This is called to peek at the Profiler Attach Event in between finalizers to check
// if it's signaled. If it is, this calls
// code:ProfilingAPIAttachDetach::ProcessSignaledAttachEvent to deal with it.
//
//
// Arguments:
// * pui64TimestampLastCheckedEventMs: [in / out] This keeps track of how often the
// Profiler Attach Event is checked, so it's not checked too often during a
// tight loop (in particular, the loop in code:SVR::FinalizeAllObjects which
// executes all finalizer routines in the queue). This argument has the
// following possible values:
// * [in] (pui64TimestampLastCheckedEventMs) == NULL: Means the arg is not used, so
// just check the event and ignore this argument
// * [in] (*pui64TimestampLastCheckedEventMs) == 0: Arg is uninitialized. Just
// initialize it with the current tick count and return without checking the
// event (as the event was probably just checked before entering the loop
// that called this function).
// * [in] (*pui64TimestampLastCheckedEventMs) != 0: Arg is initialized to the
// approximate tick count of when the event was last checked. If it's time
// to check the event again, do so and update this parameter on [out] with
// the current timestamp. Otherwise, do nothing and return.
//
// Notes:
// * The Profiler Attach Event is also checked in the main WaitForMultipleObjects in
// WaitForFinalizerEvent
//
// static
void FinalizerThread::ProcessProfilerAttachIfNecessary(ULONGLONG * pui64TimestampLastCheckedEventMs)
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_MODE_ANY;
if (MHandles[kProfilingAPIAttach] == NULL)
{
return;
}
if (pui64TimestampLastCheckedEventMs != NULL)
{
if (*pui64TimestampLastCheckedEventMs == 0)
{
// Just initialize timestamp and leave
*pui64TimestampLastCheckedEventMs = CLRGetTickCount64();
return;
}
static DWORD dwMsBetweenCheckingProfAPIAttachEvent = 0;
if (dwMsBetweenCheckingProfAPIAttachEvent == 0)
{
// First time through, initialize with how long to wait between checking the
// event.
dwMsBetweenCheckingProfAPIAttachEvent = CLRConfig::GetConfigValue(
CLRConfig::EXTERNAL_MsBetweenAttachCheck);
}
ULONGLONG ui64TimestampNowMs = CLRGetTickCount64();
_ASSERTE(ui64TimestampNowMs >= (*pui64TimestampLastCheckedEventMs));
if (ui64TimestampNowMs - (*pui64TimestampLastCheckedEventMs) <
dwMsBetweenCheckingProfAPIAttachEvent)
{
// Too soon, go home
return;
}
// Otherwise, update the timestamp and wait on the finalizer event below
*pui64TimestampLastCheckedEventMs = ui64TimestampNowMs;
}
// Check the attach event without waiting; only if it's signaled right now will we
// process the event.
if (WaitForSingleObject(MHandles[kProfilingAPIAttach], 0) != WAIT_OBJECT_0)
{
// Any return value that indicates we can't verify the attach event is signaled
// right now means we should just forget about it and immediately return to
// whatever we were doing
return;
}
// Event is signaled; process it by spawning a new thread to do the work
ProfilingAPIAttachDetach::ProcessSignaledAttachEvent();
}
#endif // FEATURE_PROFAPI_ATTACH_DETACH
void FinalizerThread::WaitForFinalizerEvent (CLREvent *event)
{
// Non-host environment
// We don't want kLowMemoryNotification to starve out kFinalizer
// (as the latter may help correct the former), and we don't want either
// to starve out kProfilingAPIAttach, as we want decent responsiveness
// to a user trying to attach a profiler. So check in this order:
// kProfilingAPIAttach alone (0 wait)
// kFinalizer alone (2s wait)
// all events together (infinite wait)
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
// NULL means check attach event now, and don't worry about how long it was since
// the last time the event was checked.
ProcessProfilerAttachIfNecessary(NULL);
#endif // FEATURE_PROFAPI_ATTACH_DETACH
//give a chance to the finalizer event (2s)
switch (event->Wait(2000, FALSE))
{
case (WAIT_OBJECT_0):
return;
case (WAIT_ABANDONED):
return;
case (WAIT_TIMEOUT):
break;
}
MHandles[kFinalizer] = event->GetHandleUNHOSTED();
while (1)
{
// WaitForMultipleObjects will wait on the event handles in MHandles
// starting at this offset
UINT uiEventIndexOffsetForWait = 0;
// WaitForMultipleObjects will wait on this number of event handles
DWORD cEventsForWait = kHandleCount;
// #MHandleTypeValues:
// WaitForMultipleObjects will now wait on a subset of the events in the
// MHandles array. At this point kFinalizer should have a non-NULL entry
// in the array. Wait on the following events:
//
// * kLowMemoryNotification (if it's non-NULL && g_fEEStarted)
// * kFinalizer (always)
// * kProfilingAPIAttach (if it's non-NULL)
//
// The enum code:MHandleType values become important here, as
// WaitForMultipleObjects needs to wait on a contiguous set of non-NULL
// entries in MHandles, so we'll assert the values are contiguous as we
// expect.
_ASSERTE(kLowMemoryNotification == 0);
_ASSERTE((kFinalizer == 1) && (MHandles[1] != NULL));
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
_ASSERTE(kProfilingAPIAttach == 2);
#endif //FEATURE_PROFAPI_ATTACH_DETACH
// Exclude the low-memory notification event from the wait if the event
// handle is NULL or the EE isn't fully started up yet.
if ((MHandles[kLowMemoryNotification] == NULL) || !g_fEEStarted)
{
uiEventIndexOffsetForWait = kLowMemoryNotification + 1;
cEventsForWait--;
}
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
// Exclude kProfilingAPIAttach if it's NULL
if (MHandles[kProfilingAPIAttach] == NULL)
{
cEventsForWait--;
}
#endif //FEATURE_PROFAPI_ATTACH_DETACH
switch (WaitForMultipleObjectsEx(
cEventsForWait, // # objects to wait on
&(MHandles[uiEventIndexOffsetForWait]), // array of objects to wait on
FALSE, // bWaitAll == FALSE, so wait for first signal
#if defined(__linux__) && defined(FEATURE_EVENT_TRACE)
LINUX_HEAP_DUMP_TIME_OUT,
#else
INFINITE, // timeout
#endif
FALSE) // alertable
// Adjust the returned array index for the offset we used, so the return
// value is relative to entire MHandles array
+ uiEventIndexOffsetForWait)
{
case (WAIT_OBJECT_0 + kLowMemoryNotification):
//short on memory GC immediately
GetFinalizerThread()->DisablePreemptiveGC();
GCHeapUtilities::GetGCHeap()->GarbageCollect(0, true);
GetFinalizerThread()->EnablePreemptiveGC();
//wait only on the event for 2s
switch (event->Wait(2000, FALSE))
{
case (WAIT_OBJECT_0):
return;
case (WAIT_ABANDONED):
return;
case (WAIT_TIMEOUT):
break;
}
break;
case (WAIT_OBJECT_0 + kFinalizer):
return;
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
case (WAIT_OBJECT_0 + kProfilingAPIAttach):
// Spawn thread to perform the profiler attach, then resume our wait
ProfilingAPIAttachDetach::ProcessSignaledAttachEvent();
break;
#endif // FEATURE_PROFAPI_ATTACH_DETACH
#if defined(__linux__) && defined(FEATURE_EVENT_TRACE)
case (WAIT_TIMEOUT + kLowMemoryNotification):
case (WAIT_TIMEOUT + kFinalizer):
if (g_TriggerHeapDump)
{
return;
}
break;
#endif
default:
//what's wrong?
_ASSERTE (!"Bad return code from WaitForMultipleObjects");
return;
}
}
}
static BOOL s_FinalizerThreadOK = FALSE;
VOID FinalizerThread::FinalizerThreadWorker(void *args)
{
// TODO: The following line should be removed after contract violation is fixed.
// See bug 27409
SCAN_IGNORE_THROW;
SCAN_IGNORE_TRIGGER;
// This is used to stitch together the exception handling at the base of our thread with
// any eventual transitions into different AppDomains for finalization.
_ASSERTE(args != NULL);
pThreadTurnAround = (ManagedThreadCallState *) args;
BOOL bPriorityBoosted = FALSE;
while (!fQuitFinalizer)
{
// Wait for work to do...
_ASSERTE(GetFinalizerThread()->PreemptiveGCDisabled());
#ifdef _DEBUG
if (g_pConfig->FastGCStressLevel())
{
GetFinalizerThread()->m_GCOnTransitionsOK = FALSE;
}
#endif
GetFinalizerThread()->EnablePreemptiveGC();
#ifdef _DEBUG
if (g_pConfig->FastGCStressLevel())
{
GetFinalizerThread()->m_GCOnTransitionsOK = TRUE;
}
#endif
#if 0
// Setting the event here, instead of at the bottom of the loop, could
// cause us to skip draining the Q, if the request is made as soon as
// the app starts running.
SignalFinalizationDone(TRUE);
#endif //0
WaitForFinalizerEvent (hEventFinalizer);
#if defined(__linux__) && defined(FEATURE_EVENT_TRACE)
if (g_TriggerHeapDump && (CLRGetTickCount64() > (LastHeapDumpTime + LINUX_HEAP_DUMP_TIME_OUT)))
{
s_forcedGCInProgress = true;
GetFinalizerThread()->DisablePreemptiveGC();
GCHeapUtilities::GetGCHeap()->GarbageCollect(2, false, collection_blocking);
GetFinalizerThread()->EnablePreemptiveGC();
s_forcedGCInProgress = false;
LastHeapDumpTime = CLRGetTickCount64();
g_TriggerHeapDump = FALSE;
}
#endif
if (!bPriorityBoosted)
{
if (GetFinalizerThread()->SetThreadPriority(THREAD_PRIORITY_HIGHEST))
bPriorityBoosted = TRUE;
}
GetFinalizerThread()->DisablePreemptiveGC();
// TODO: The following call causes 12 more classes loaded.
//if (!fNameSet) {
// fNameSet = TRUE;
// GetFinalizerThread()->SetName(L"FinalizerThread");
//}
#ifdef _DEBUG
// <TODO> workaround. make finalization very lazy for gcstress 3 or 4.
// only do finalization if the system is quiescent</TODO>
if (g_pConfig->GetGCStressLevel() > 1)
{
size_t last_gc_count;
DWORD dwSwitchCount = 0;
do
{
last_gc_count = GCHeapUtilities::GetGCHeap()->CollectionCount(0);
GetFinalizerThread()->m_GCOnTransitionsOK = FALSE;
GetFinalizerThread()->EnablePreemptiveGC();
__SwitchToThread (0, ++dwSwitchCount);
GetFinalizerThread()->DisablePreemptiveGC();
// If no GCs happended, then we assume we are quiescent
GetFinalizerThread()->m_GCOnTransitionsOK = TRUE;
} while (GCHeapUtilities::GetGCHeap()->CollectionCount(0) - last_gc_count > 0);
}
#endif //_DEBUG
// we might want to do some extra work on the finalizer thread
// check and do it
if (GetFinalizerThread()->HaveExtraWorkForFinalizer())
{
GetFinalizerThread()->DoExtraWorkForFinalizer();
}
LOG((LF_GC, LL_INFO100, "***** Calling Finalizers\n"));
// We may mark the finalizer thread for abort. If so the abort request is for previous finalizer method, not for next one.
if (GetFinalizerThread()->IsAbortRequested())
{
GetFinalizerThread()->EEResetAbort(Thread::TAR_ALL);
}
FastInterlockExchange ((LONG*)&g_FinalizerIsRunning, TRUE);
AppDomain::EnableADUnloadWorkerForFinalizer();
do
{
FinalizeAllObjects(NULL, 0);
_ASSERTE(GetFinalizerThread()->GetDomain()->IsDefaultDomain());
if (AppDomain::HasWorkForFinalizerThread())
{
AppDomain::ProcessUnloadDomainEventOnFinalizeThread();
}
else if (UnloadingAppDomain == NULL)
break;
else if (!GCHeapUtilities::GetGCHeap()->FinalizeAppDomain(UnloadingAppDomain, !!fRunFinalizersOnUnload))
{
break;
}
// Now schedule any objects from an unloading app domain for finalization
// on the next pass (even if they are reachable.)
// Note that it may take several passes to complete the unload, if new objects are created during
// finalization.
}
while(TRUE);
if (UnloadingAppDomain != NULL)
{
SyncBlockCache::GetSyncBlockCache()->CleanupSyncBlocksInAppDomain(UnloadingAppDomain);
{
// Before we continue with AD unloading, mark the stage as
// FINALIZED under the SystemDomain lock so that this portion
// of unloading may be serialized with other parts of the CLR
// that require the AD stage to be < FINALIZED, in particular
// ETW's AD enumeration code used during its rundown events.
SystemDomain::LockHolder lh;
UnloadingAppDomain->SetFinalized(); // All finalizers have run except for FinalizableAndAgile objects
}
UnloadingAppDomain = NULL;
}
FastInterlockExchange ((LONG*)&g_FinalizerIsRunning, FALSE);
// We may still have the finalizer thread for abort. If so the abort request is for previous finalizer method, not for next one.
if (GetFinalizerThread()->IsAbortRequested())
{
GetFinalizerThread()->EEResetAbort(Thread::TAR_ALL);
}
// Increment the loop count. This is currently used by the AddMemoryPressure heuristic to see
// if finalizers have run since the last time it triggered GC.
FastInterlockIncrement((LONG *)&g_FinalizerLoopCount);
// Anyone waiting to drain the Q can now wake up. Note that there is a
// race in that another thread starting a drain, as we leave a drain, may
// consider itself satisfied by the drain that just completed. This is
// acceptable.
SignalFinalizationDone(TRUE);
}
}
// During shutdown, finalize all objects that haven't been run yet... whether reachable or not.
void FinalizerThread::FinalizeObjectsOnShutdown(LPVOID args)
{
WRAPPER_NO_CONTRACT;
// This is used to stitch together the exception handling at the base of our thread with
// any eventual transitions into different AppDomains for finalization.
_ASSERTE(args != NULL);
pThreadTurnAround = (ManagedThreadCallState *) args;
FinalizeAllObjects(NULL, BIT_SBLK_FINALIZER_RUN);
}
DWORD WINAPI FinalizerThread::FinalizerThreadStart(void *args)
{
ClrFlsSetThreadType (ThreadType_Finalizer);
ASSERT(args == 0);
ASSERT(hEventFinalizer->IsValid());
// TODO: The following line should be removed after contract violation is fixed.
// See bug 27409
SCAN_IGNORE_THROW;
SCAN_IGNORE_TRIGGER;
LOG((LF_GC, LL_INFO10, "Finalizer thread starting...\n"));
_ASSERTE(GetFinalizerThread()->GetDomain()->IsDefaultDomain());
#if defined(FEATURE_COMINTEROP_APARTMENT_SUPPORT) && !defined(FEATURE_COMINTEROP)
// Make sure the finalizer thread is set to MTA to avoid hitting
// DevDiv Bugs 180773 - [Stress Failure] AV at CoreCLR!SafeQueryInterfaceHelper
GetFinalizerThread()->SetApartment(Thread::AS_InMTA, FALSE);
#endif // FEATURE_COMINTEROP_APARTMENT_SUPPORT && !FEATURE_COMINTEROP
s_FinalizerThreadOK = GetFinalizerThread()->HasStarted();
_ASSERTE(s_FinalizerThreadOK);
_ASSERTE(GetThread() == GetFinalizerThread());
// finalizer should always park in default domain
if (s_FinalizerThreadOK)
{
INSTALL_UNHANDLED_MANAGED_EXCEPTION_TRAP;
#ifdef _DEBUG // The only purpose of this try/finally is to trigger an assertion
EE_TRY_FOR_FINALLY(void *, unused, NULL)
{
#endif
GetFinalizerThread()->SetBackground(TRUE);
EnsureYieldProcessorNormalizedInitialized();
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
// Add the Profiler Attach Event to the array of event handles that the
// finalizer thread waits on. If the process is not enabled for profiler
// attach (e.g., running memory- or sync-hosted, or there is some other error
// that causes the Profiler Attach Event not to be created), then this just
// adds NULL in the slot where the Profiler Attach Event handle would go. In
// this case, WaitForFinalizerEvent will know to ignore that handle when it
// waits.
//
// Calling ProfilingAPIAttachDetach::GetAttachEvent induces lazy
// initialization of the profiling API attach/detach support objects,
// including the event itself and its security descriptor. So switch to
// preemptive mode during these OS calls
GetFinalizerThread()->EnablePreemptiveGC();
MHandles[kProfilingAPIAttach] = ::ProfilingAPIAttachDetach::GetAttachEvent();
GetFinalizerThread()->DisablePreemptiveGC();
#endif // FEATURE_PROFAPI_ATTACH_DETACH
while (!fQuitFinalizer)
{
// This will apply any policy for swallowing exceptions during normal
// processing, without allowing the finalizer thread to disappear on us.
ManagedThreadBase::FinalizerBase(FinalizerThreadWorker);
// If we came out on an exception, then we probably lost the signal that
// there are objects in the queue ready to finalize. The safest thing is
// to reenable finalization.
if (!fQuitFinalizer)
EnableFinalization();
}
// Tell shutdown thread we are done with finalizing dead objects.
hEventFinalizerToShutDown->Set();
// Wait for shutdown thread to signal us.
GetFinalizerThread()->EnablePreemptiveGC();
hEventShutDownToFinalizer->Wait(INFINITE,FALSE);
GetFinalizerThread()->DisablePreemptiveGC();
AppDomain::RaiseExitProcessEvent();
hEventFinalizerToShutDown->Set();
// Phase 1 ends.
// Now wait for Phase 2 signal.
// Wait for shutdown thread to signal us.
GetFinalizerThread()->EnablePreemptiveGC();
hEventShutDownToFinalizer->Wait(INFINITE,FALSE);
GetFinalizerThread()->DisablePreemptiveGC();
// We have been asked to quit, so must be shutting down
_ASSERTE(g_fEEShutDown);
_ASSERTE(GetFinalizerThread()->PreemptiveGCDisabled());
if (CLRConfig::GetConfigValue(CLRConfig::EXTERNAL_FinalizeOnShutdown) != 0)
{
// Finalize all registered objects during shutdown, even they are still reachable.
GCHeapUtilities::GetGCHeap()->SetFinalizeQueueForShutdown(FALSE);
// This will apply any policy for swallowing exceptions during normal
// processing, without allowing the finalizer thread to disappear on us.
ManagedThreadBase::FinalizerBase(FinalizeObjectsOnShutdown);
}
_ASSERTE(GetFinalizerThread()->GetDomain()->IsDefaultDomain());
// we might want to do some extra work on the finalizer thread
// check and do it
if (GetFinalizerThread()->HaveExtraWorkForFinalizer())
{
GetFinalizerThread()->DoExtraWorkForFinalizer();
}
hEventFinalizerToShutDown->Set();
// Wait for shutdown thread to signal us.
GetFinalizerThread()->EnablePreemptiveGC();
hEventShutDownToFinalizer->Wait(INFINITE,FALSE);
GetFinalizerThread()->DisablePreemptiveGC();
#ifdef FEATURE_COMINTEROP
// Do extra cleanup for part 1 of shutdown.
// If we hang here (bug 87809) shutdown thread will
// timeout on us and will proceed normally
//
// We cannot call CoEEShutDownCOM, since the BEGIN_EXTERNAL_ENTRYPOINT
// will turn our call into a NOP. We can no longer execute managed
// code for an external caller.
InnerCoEEShutDownCOM();
#endif // FEATURE_COMINTEROP
hEventFinalizerToShutDown->Set();
#ifdef _DEBUG // The only purpose of this try/finally is to trigger an assertion
}
EE_FINALLY
{
// We can have exception to reach here if policy tells us to
// let exception go on finalizer thread.
//
if (GOT_EXCEPTION() && SwallowUnhandledExceptions())
_ASSERTE(!"Exception in the finalizer thread!");
}
EE_END_FINALLY;
#endif
UNINSTALL_UNHANDLED_MANAGED_EXCEPTION_TRAP;
}
// finalizer should always park in default domain
_ASSERTE(GetThread()->GetDomain()->IsDefaultDomain());
LOG((LF_GC, LL_INFO10, "Finalizer thread done."));
// Enable pre-emptive GC before we leave so that anybody trying to suspend
// us will not end up waiting forever. Don't do a DestroyThread because this
// will happen soon when we tear down the thread store.
GetFinalizerThread()->EnablePreemptiveGC();
// We do not want to tear Finalizer thread,
// since doing so will cause OLE32 to CoUninitialize.
while (1)
{
PAL_TRY(void *, unused, NULL)
{
__SwitchToThread(INFINITE, CALLER_LIMITS_SPINNING);
}
PAL_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
{
}
PAL_ENDTRY
}
return 0;
}
void FinalizerThread::FinalizerThreadCreate()
{
CONTRACTL{
THROWS;
GC_TRIGGERS;
MODE_ANY;
} CONTRACTL_END;
#ifndef FEATURE_PAL
MHandles[kLowMemoryNotification] =
CreateMemoryResourceNotification(LowMemoryResourceNotification);
#endif // FEATURE_PAL
hEventFinalizerDone = new CLREvent();
hEventFinalizerDone->CreateManualEvent(FALSE);
hEventFinalizer = new CLREvent();
hEventFinalizer->CreateAutoEvent(FALSE);
hEventFinalizerToShutDown = new CLREvent();
hEventFinalizerToShutDown->CreateAutoEvent(FALSE);
hEventShutDownToFinalizer = new CLREvent();
hEventShutDownToFinalizer->CreateAutoEvent(FALSE);
_ASSERTE(g_pFinalizerThread == 0);
g_pFinalizerThread = SetupUnstartedThread();
// We don't want the thread block disappearing under us -- even if the
// actual thread terminates.
GetFinalizerThread()->IncExternalCount();
if (GetFinalizerThread()->CreateNewThread(0, &FinalizerThreadStart, NULL, W("Finalizer")) )
{
DWORD dwRet = GetFinalizerThread()->StartThread();
// When running under a user mode native debugger there is a race
// between the moment we've created the thread (in CreateNewThread) and
// the moment we resume it (in StartThread); the debugger may receive
// the "ct" (create thread) notification, and it will attempt to
// suspend/resume all threads in the process. Now imagine the debugger
// resumes this thread first, and only later does it try to resume the
// newly created thread (the finalizer thread). In these conditions our
// call to ResumeThread may come before the debugger's call to ResumeThread
// actually causing dwRet to equal 2.
// We cannot use IsDebuggerPresent() in the condition below because the
// debugger may have been detached between the time it got the notification
// and the moment we execute the test below.
_ASSERTE(dwRet == 1 || dwRet == 2);
}
}
void FinalizerThread::SignalFinalizationDone(BOOL fFinalizer)
{
WRAPPER_NO_CONTRACT;
if (fFinalizer)
{
FastInterlockAnd((DWORD*)&g_FinalizerWaiterStatus, ~FWS_WaitInterrupt);
}
hEventFinalizerDone->Set();
}
// Wait for the finalizer thread to complete one pass.
void FinalizerThread::FinalizerThreadWait(DWORD timeout)
{
ASSERT(hEventFinalizerDone->IsValid());
ASSERT(hEventFinalizer->IsValid());
ASSERT(GetFinalizerThread());
// Can't call this from within a finalized method.
if (!IsCurrentThreadFinalizer())
{
#ifdef FEATURE_COMINTEROP
// To help combat finalizer thread starvation, we check to see if there are any wrappers
// scheduled to be cleaned up for our context. If so, we'll do them here to avoid making
// the finalizer thread do a transition.
if (g_pRCWCleanupList != NULL)
g_pRCWCleanupList->CleanupWrappersInCurrentCtxThread();
#endif // FEATURE_COMINTEROP
GCX_PREEMP();
Thread *pThread = GetThread();
BOOL fADUnloadHelper = (pThread && pThread->HasThreadStateNC(Thread::TSNC_ADUnloadHelper));
ULONGLONG startTime = CLRGetTickCount64();
ULONGLONG endTime;
if (timeout == INFINITE)
{
endTime = MAXULONGLONG;
}
else
{
endTime = timeout + startTime;
}
while (TRUE)
{
hEventFinalizerDone->Reset();
EnableFinalization();
//----------------------------------------------------
// Do appropriate wait and pump messages if necessary
//----------------------------------------------------
//WaitForSingleObject(hEventFinalizerDone, INFINITE);
if (fADUnloadHelper)
{
timeout = GetEEPolicy()->GetTimeout(OPR_FinalizerRun);
}
DWORD status = hEventFinalizerDone->Wait(timeout,TRUE);
if (status != WAIT_TIMEOUT && !(g_FinalizerWaiterStatus & FWS_WaitInterrupt))
{
return;
}
if (!fADUnloadHelper)
{
// recalculate timeout
if (timeout != INFINITE)
{
ULONGLONG curTime = CLRGetTickCount64();
if (curTime >= endTime)
{
return;
}
else
{
timeout = (DWORD)(endTime - curTime);
}
}
}
else
{
if (status == WAIT_TIMEOUT)
{
ULONGLONG finalizeStartTime = GetObjFinalizeStartTime();
if (finalizeStartTime || AppDomain::HasWorkForFinalizerThread())
{
if (CLRGetTickCount64() >= finalizeStartTime+timeout)
{
GCX_COOP();
FinalizerThreadAbortOnTimeout();
}
}
}
if (endTime != MAXULONGLONG)
{
ULONGLONG curTime = CLRGetTickCount64();
if (curTime >= endTime)
{
return;
}
}
}
}
}
}
#ifdef _DEBUG
#define FINALIZER_WAIT_TIMEOUT 250
#else
#define FINALIZER_WAIT_TIMEOUT 200
#endif
#define FINALIZER_TOTAL_WAIT 2000
static BOOL s_fRaiseExitProcessEvent = FALSE;
static DWORD dwBreakOnFinalizeTimeOut = (DWORD) -1;
static ULONGLONG ShutdownEnd;
BOOL FinalizerThread::FinalizerThreadWatchDog()
{
Thread *pThread = GetThread();
if (dwBreakOnFinalizeTimeOut == (DWORD) -1) {
dwBreakOnFinalizeTimeOut = CLRConfig::GetConfigValue(CLRConfig::UNSUPPORTED_BreakOnFinalizeTimeOut);
}
// Do not wait for FinalizerThread if the current one is FinalizerThread.
if (pThread == GetFinalizerThread())
return TRUE;
// If finalizer thread is gone, just return.
if (GetFinalizerThread()->Join (0, FALSE) != WAIT_TIMEOUT)
return TRUE;
// *** This is the first call ShutDown -> Finalizer to Finilize dead objects ***
if ((g_fEEShutDown & ShutDown_Finalize1) &&
!(g_fEEShutDown & ShutDown_Finalize2)) {
ShutdownEnd = CLRGetTickCount64() + GetEEPolicy()->GetTimeout(OPR_ProcessExit);
// Wait for the finalizer...
LOG((LF_GC, LL_INFO10, "Signalling finalizer to quit..."));
fQuitFinalizer = TRUE;
hEventFinalizerDone->Reset();
EnableFinalization();
LOG((LF_GC, LL_INFO10, "Waiting for finalizer to quit..."));
if (pThread)
{
pThread->EnablePreemptiveGC();
}
BOOL fTimeOut = FinalizerThreadWatchDogHelper();
if (!fTimeOut) {
hEventShutDownToFinalizer->Set();
// Wait for finalizer thread to finish raising ExitProcess Event.
s_fRaiseExitProcessEvent = TRUE;
fTimeOut = FinalizerThreadWatchDogHelper();
s_fRaiseExitProcessEvent = FALSE;
}
if (pThread)
{
pThread->DisablePreemptiveGC();
}
// Can not call ExitProcess here if we are in a hosting environment.
// The host does not expect that we terminate the process.
//if (fTimeOut)
//{
//::ExitProcess (GetLatchedExitCode());
//}
return !fTimeOut;
}
// *** This is the second call ShutDown -> Finalizer to ***
// suspend the Runtime and Finilize live objects
if ( g_fEEShutDown & ShutDown_Finalize2 &&
!(g_fEEShutDown & ShutDown_COM) ) {
#ifdef BACKGROUND_GC
gc_heap::gc_can_use_concurrent = FALSE;
if (pGenGCHeap->settings.concurrent)
pGenGCHeap->background_gc_wait();
#endif //BACKGROUND_GC
_ASSERTE((g_fEEShutDown & ShutDown_Finalize1) || g_fFastExitProcess);
if (CLRConfig::GetConfigValue(CLRConfig::EXTERNAL_FinalizeOnShutdown) != 0)
{
// When running finalizers on shutdown (including for reachable objects), suspend threads for shutdown before
// running finalizers, so that the reachable objects will not be used after they are finalized.
ThreadSuspend::SuspendEE(ThreadSuspend::SUSPEND_FOR_SHUTDOWN);
g_fSuspendOnShutdown = TRUE;
// Do not balance the trap returning threads.
// We are shutting down CLR. Only Finalizer/Shutdown threads can
// return from DisablePreemptiveGC.
ThreadStore::TrapReturningThreads(TRUE);
ThreadSuspend::RestartEE(FALSE, TRUE);
}
if (g_fFastExitProcess)
{
return TRUE;
}
// !!! Before we wake up Finalizer thread, we need to enable preemptive gc on the
// !!! shutdown thread. Otherwise we may see a deadlock during debug test.
if (pThread)
{
pThread->EnablePreemptiveGC();
}
GCHeapUtilities::GetGCHeap()->SetFinalizeRunOnShutdown(true);
// Wait for finalizer thread to finish finalizing all objects.
hEventShutDownToFinalizer->Set();
BOOL fTimeOut = FinalizerThreadWatchDogHelper();
if (!fTimeOut) {
GCHeapUtilities::GetGCHeap()->SetFinalizeRunOnShutdown(false);
}
// Can not call ExitProcess here if we are in a hosting environment.
// The host does not expect that we terminate the process.
//if (fTimeOut) {
// ::ExitProcess (GetLatchedExitCode());
//}
if (pThread)
{
pThread->DisablePreemptiveGC();
}
return !fTimeOut;
}
// *** This is the third call ShutDown -> Finalizer ***
// to do additional cleanup
if (g_fEEShutDown & ShutDown_COM) {
_ASSERTE (g_fEEShutDown & (ShutDown_Finalize2 | ShutDown_Finalize1));
if (pThread)
{
pThread->EnablePreemptiveGC();
}
GCHeapUtilities::GetGCHeap()->SetFinalizeRunOnShutdown(true);
hEventShutDownToFinalizer->Set();
DWORD status = WAIT_OBJECT_0;
while (CLREventWaitWithTry(hEventFinalizerToShutDown, FINALIZER_WAIT_TIMEOUT, TRUE, &status))
{
}
BOOL fTimeOut = (status == WAIT_TIMEOUT) ? TRUE : FALSE;
if (fTimeOut)
{
if (dwBreakOnFinalizeTimeOut) {
LOG((LF_GC, LL_INFO10, "Finalizer took too long to clean up COM IP's.\n"));
DebugBreak();
}
}
if (pThread)
{
pThread->DisablePreemptiveGC();
}
return !fTimeOut;
}
_ASSERTE(!"Should never reach this point");
return FALSE;
}
BOOL FinalizerThread::FinalizerThreadWatchDogHelper()
{
// Since our thread is blocking waiting for the finalizer thread, we must be in preemptive GC
// so that we don't in turn block the finalizer on us in a GC.
Thread *pCurrentThread;
pCurrentThread = GetThread();
_ASSERTE (pCurrentThread == NULL || !pCurrentThread->PreemptiveGCDisabled());
// We're monitoring the finalizer thread.
Thread *pThread = GetFinalizerThread();
_ASSERTE(pThread != pCurrentThread);
ULONGLONG dwBeginTickCount = CLRGetTickCount64();
size_t prevCount;
size_t curCount;
BOOL fTimeOut = FALSE;
DWORD nTry = 0;
DWORD maxTotalWait = (DWORD)(ShutdownEnd - dwBeginTickCount);
DWORD totalWaitTimeout;
totalWaitTimeout = GetEEPolicy()->GetTimeout(OPR_FinalizerRun);
if (totalWaitTimeout == (DWORD)-1)
{
totalWaitTimeout = FINALIZER_TOTAL_WAIT;
}
if (s_fRaiseExitProcessEvent)
{
DWORD tmp = maxTotalWait/20; // Normally we assume 2 seconds timeout if total timeout is 40 seconds.
if (tmp > totalWaitTimeout)
{
totalWaitTimeout = tmp;
}
prevCount = MAXLONG;
}
else
{
prevCount = GCHeapUtilities::GetGCHeap()->GetNumberOfFinalizable();
}
DWORD maxTry = (DWORD)(totalWaitTimeout*1.0/FINALIZER_WAIT_TIMEOUT + 0.5);
BOOL bAlertable = TRUE; //(g_fEEShutDown & ShutDown_Finalize2) ? FALSE:TRUE;
if (dwBreakOnFinalizeTimeOut == (DWORD) -1) {
dwBreakOnFinalizeTimeOut = CLRConfig::GetConfigValue(CLRConfig::UNSUPPORTED_BreakOnFinalizeTimeOut);
}
DWORD dwTimeout = FINALIZER_WAIT_TIMEOUT;
// This used to set the dwTimeout to infinite, but this can cause a hang when shutting down
// if a finalizer tries to take a lock that another suspended managed thread already has.
// This results in the hang because the other managed thread is never going to be resumed
// because we're in shutdown. So we make a compromise here - make the timeout for every
// iteration 10 times longer and make the total wait infinite - so if things hang we will
// eventually shutdown but we also give things a chance to finish if they're running slower
// because of the profiler.
#ifdef PROFILING_SUPPORTED
if (CORProfilerPresent())
{
dwTimeout *= 10;
maxTotalWait = INFINITE;
}
#endif // PROFILING_SUPPORTED
// This change was added late in Windows Phone 8, so we want to keep it minimal.
// We should consider refactoring this later, as we've got a lot of dead code here now on CoreCLR.
dwTimeout = INFINITE;
maxTotalWait = INFINITE;
while (1) {
struct Param
{
DWORD status;
DWORD dwTimeout;
BOOL bAlertable;
} param;
param.status = 0;
param.dwTimeout = dwTimeout;
param.bAlertable = bAlertable;
PAL_TRY(Param *, pParam, ¶m)
{
pParam->status = hEventFinalizerToShutDown->Wait(pParam->dwTimeout, pParam->bAlertable);
}
PAL_EXCEPT (EXCEPTION_EXECUTE_HANDLER)
{
param.status = WAIT_TIMEOUT;
}
PAL_ENDTRY
if (param.status != WAIT_TIMEOUT) {
break;
}
nTry ++;
// ExitProcessEventCount is incremental
// FinalizableObjects is decremental
if (s_fRaiseExitProcessEvent)
{
curCount = MAXLONG - GetProcessedExitProcessEventCount();
}
else
{
curCount = GCHeapUtilities::GetGCHeap()->GetNumberOfFinalizable();
}
if ((prevCount <= curCount)
&& !GCHeapUtilities::GetGCHeap()->ShouldRestartFinalizerWatchDog()
&& (pThread == NULL || !(pThread->m_State & (Thread::TS_UserSuspendPending | Thread::TS_DebugSuspendPending)))){
if (nTry == maxTry) {
if (!s_fRaiseExitProcessEvent) {
LOG((LF_GC, LL_INFO10, "Finalizer took too long on one object.\n"));
}
else
LOG((LF_GC, LL_INFO10, "Finalizer took too long to process ExitProcess event.\n"));
fTimeOut = TRUE;
if (dwBreakOnFinalizeTimeOut != 2) {
break;
}
}
}
else
{
nTry = 0;
prevCount = curCount;
}
ULONGLONG dwCurTickCount = CLRGetTickCount64();
if (pThread && pThread->m_State & (Thread::TS_UserSuspendPending | Thread::TS_DebugSuspendPending)) {
// CoreCLR does not support user-requested thread suspension
_ASSERTE(!(pThread->m_State & Thread::TS_UserSuspendPending));
dwBeginTickCount = dwCurTickCount;
}
if (dwCurTickCount - dwBeginTickCount >= maxTotalWait)
{
LOG((LF_GC, LL_INFO10, "Finalizer took too long on shutdown.\n"));
fTimeOut = TRUE;
if (dwBreakOnFinalizeTimeOut != 2) {
break;
}
}
}
if (fTimeOut)
{
if (dwBreakOnFinalizeTimeOut){
DebugBreak();
}
}
return fTimeOut;
}
|