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
|
// 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.
/*
* GCHELPERS.CPP
*
* GC Allocation and Write Barrier Helpers
*
*
*/
#include "common.h"
#include "object.h"
#include "threads.h"
#include "eetwain.h"
#include "eeconfig.h"
#include "gcheaputilities.h"
#include "corhost.h"
#include "threads.h"
#include "fieldmarshaler.h"
#include "interoputil.h"
#include "dynamicmethod.h"
#include "stubhelpers.h"
#include "eventtrace.h"
#include "excep.h"
#include "gchelpers.inl"
#include "eeprofinterfaces.inl"
#ifdef FEATURE_COMINTEROP
#include "runtimecallablewrapper.h"
#endif // FEATURE_COMINTEROP
#include "rcwwalker.h"
//========================================================================
//
// ALLOCATION HELPERS
//
//========================================================================
#define ProfileTrackArrayAlloc(orObject) \
OBJECTREF objref = ObjectToOBJECTREF((Object*)orObject);\
GCPROTECT_BEGIN(objref);\
ProfilerObjectAllocatedCallback(objref, (ClassID) orObject->GetTypeHandle().AsPtr());\
GCPROTECT_END();\
orObject = (ArrayBase *) OBJECTREFToObject(objref);
inline gc_alloc_context* GetThreadAllocContext()
{
WRAPPER_NO_CONTRACT;
assert(GCHeapUtilities::UseAllocationContexts());
return & GetThread()->m_alloc_context;
}
// Checks to see if the given allocation size exceeds the
// largest object size allowed - if it does, it throws
// an OutOfMemoryException with a message indicating that
// the OOM was not from memory pressure but from an object
// being too large.
inline void CheckObjectSize(size_t alloc_size)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
} CONTRACTL_END;
size_t max_object_size;
#ifdef BIT64
if (g_pConfig->GetGCAllowVeryLargeObjects())
{
max_object_size = (INT64_MAX - 7 - min_obj_size);
}
else
#endif // BIT64
{
max_object_size = (INT32_MAX - 7 - min_obj_size);
}
if (alloc_size >= max_object_size)
{
if (g_pConfig->IsGCBreakOnOOMEnabled())
{
DebugBreak();
}
ThrowOutOfMemoryDimensionsExceeded();
}
}
// There are only three ways to get into allocate an object.
// * Call optimized helpers that were generated on the fly. This is how JIT compiled code does most
// allocations, however they fall back code:Alloc, when for all but the most common code paths. These
// helpers are NOT used if profiler has asked to track GC allocation (see code:TrackAllocations)
// * Call code:Alloc - When the jit helpers fall back, or we do allocations within the runtime code
// itself, we ultimately call here.
// * Call code:AllocLHeap - Used very rarely to force allocation to be on the large object heap.
//
// While this is a choke point into allocating an object, it is primitive (it does not want to know about
// MethodTable and thus does not initialize that poitner. It also does not know if the object is finalizable
// or contains pointers. Thus we quickly wrap this function in more user-friendly ones that know about
// MethodTables etc. (see code:FastAllocatePrimitiveArray code:AllocateArrayEx code:AllocateObject)
//
// You can get an exhaustive list of code sites that allocate GC objects by finding all calls to
// code:ProfilerObjectAllocatedCallback (since the profiler has to hook them all).
inline Object* Alloc(size_t size, BOOL bFinalize, BOOL bContainsPointers )
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
_ASSERTE(!NingenEnabled() && "You cannot allocate managed objects inside the ngen compilation process.");
#ifdef _DEBUG
if (g_pConfig->ShouldInjectFault(INJECTFAULT_GCHEAP))
{
char *a = new char;
delete a;
}
#endif
DWORD flags = ((bContainsPointers ? GC_ALLOC_CONTAINS_REF : 0) |
(bFinalize ? GC_ALLOC_FINALIZE : 0));
Object *retVal = NULL;
CheckObjectSize(size);
// We don't want to throw an SO during the GC, so make sure we have plenty
// of stack before calling in.
INTERIOR_STACK_PROBE_FOR(GetThread(), static_cast<unsigned>(DEFAULT_ENTRY_PROBE_AMOUNT * 1.5));
if (GCHeapUtilities::UseAllocationContexts())
retVal = GCHeapUtilities::GetGCHeap()->Alloc(GetThreadAllocContext(), size, flags);
else
retVal = GCHeapUtilities::GetGCHeap()->Alloc(size, flags);
if (!retVal)
{
ThrowOutOfMemory();
}
END_INTERIOR_STACK_PROBE;
return retVal;
}
#ifdef FEATURE_64BIT_ALIGNMENT
// Helper for allocating 8-byte aligned objects (on platforms where this doesn't happen naturally, e.g. 32-bit
// platforms).
inline Object* AllocAlign8(size_t size, BOOL bFinalize, BOOL bContainsPointers, BOOL bAlignBias)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
DWORD flags = ((bContainsPointers ? GC_ALLOC_CONTAINS_REF : 0) |
(bFinalize ? GC_ALLOC_FINALIZE : 0) |
(bAlignBias ? GC_ALLOC_ALIGN8_BIAS : 0));
Object *retVal = NULL;
CheckObjectSize(size);
// We don't want to throw an SO during the GC, so make sure we have plenty
// of stack before calling in.
INTERIOR_STACK_PROBE_FOR(GetThread(), static_cast<unsigned>(DEFAULT_ENTRY_PROBE_AMOUNT * 1.5));
if (GCHeapUtilities::UseAllocationContexts())
retVal = GCHeapUtilities::GetGCHeap()->AllocAlign8(GetThreadAllocContext(), size, flags);
else
retVal = GCHeapUtilities::GetGCHeap()->AllocAlign8(size, flags);
if (!retVal)
{
ThrowOutOfMemory();
}
END_INTERIOR_STACK_PROBE;
return retVal;
}
#endif // FEATURE_64BIT_ALIGNMENT
// This is one of three ways of allocating an object (see code:Alloc for more). This variation is used in the
// rare circumstance when you want to allocate an object on the large object heap but the object is not big
// enough to naturally go there.
//
// One (and only?) example of where this is needed is 8 byte aligning of arrays of doubles. See
// code:EEConfig.GetDoubleArrayToLargeObjectHeapThreshold and code:CORINFO_HELP_NEWARR_1_ALIGN8 for more.
inline Object* AllocLHeap(size_t size, BOOL bFinalize, BOOL bContainsPointers )
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative (don't assume large heap doesn't compact!)
} CONTRACTL_END;
_ASSERTE(!NingenEnabled() && "You cannot allocate managed objects inside the ngen compilation process.");
#ifdef _DEBUG
if (g_pConfig->ShouldInjectFault(INJECTFAULT_GCHEAP))
{
char *a = new char;
delete a;
}
#endif
DWORD flags = ((bContainsPointers ? GC_ALLOC_CONTAINS_REF : 0) |
(bFinalize ? GC_ALLOC_FINALIZE : 0));
Object *retVal = NULL;
CheckObjectSize(size);
// We don't want to throw an SO during the GC, so make sure we have plenty
// of stack before calling in.
INTERIOR_STACK_PROBE_FOR(GetThread(), static_cast<unsigned>(DEFAULT_ENTRY_PROBE_AMOUNT * 1.5));
retVal = GCHeapUtilities::GetGCHeap()->AllocLHeap(size, flags);
if (!retVal)
{
ThrowOutOfMemory();
}
END_INTERIOR_STACK_PROBE;
return retVal;
}
#ifdef _LOGALLOC
int g_iNumAllocs = 0;
bool ToLogOrNotToLog(size_t size, const char *typeName)
{
WRAPPER_NO_CONTRACT;
g_iNumAllocs++;
if (g_iNumAllocs > g_pConfig->AllocNumThreshold())
return true;
if (size > (size_t)g_pConfig->AllocSizeThreshold())
return true;
if (g_pConfig->ShouldLogAlloc(typeName))
return true;
return false;
}
// READ THIS!!!!!
// this function is called on managed allocation path with unprotected Object*
// as a result LogAlloc cannot call anything that would toggle the GC mode else
// you'll introduce several GC holes!
inline void LogAlloc(size_t size, MethodTable *pMT, Object* object)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_COOPERATIVE;
}
CONTRACTL_END;
#ifdef LOGGING
if (LoggingOn(LF_GCALLOC, LL_INFO10))
{
LogSpewAlways("Allocated %5d bytes for %s_TYPE" FMT_ADDR FMT_CLASS "\n",
size,
pMT->IsValueType() ? "VAL" : "REF",
DBG_ADDR(object),
DBG_CLASS_NAME_MT(pMT));
if (LoggingOn(LF_GCALLOC, LL_INFO1000000) ||
(LoggingOn(LF_GCALLOC, LL_INFO100) &&
ToLogOrNotToLog(size, DBG_CLASS_NAME_MT(pMT))))
{
void LogStackTrace();
LogStackTrace();
}
}
#endif
}
#else
#define LogAlloc(size, pMT, object)
#endif
inline SIZE_T MaxArrayLength(SIZE_T componentSize)
{
// Impose limits on maximum array length in each dimension to allow efficient
// implementation of advanced range check elimination in future. We have to allow
// higher limit for array of bytes (or one byte structs) for backward compatibility.
// Keep in sync with Array.MaxArrayLength in BCL.
return (componentSize == 1) ? 0X7FFFFFC7 : 0X7FEFFFFF;
}
OBJECTREF AllocateValueSzArray(TypeHandle elementType, INT32 length)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
return AllocateArrayEx(elementType.MakeSZArray(), &length, 1);
}
void ThrowOutOfMemoryDimensionsExceeded()
{
CONTRACTL {
THROWS;
} CONTRACTL_END;
#ifdef _WIN64
EX_THROW(EEMessageException, (kOutOfMemoryException, IDS_EE_ARRAY_DIMENSIONS_EXCEEDED));
#else
ThrowOutOfMemory();
#endif
}
//
// Handles arrays of arbitrary dimensions
//
// If dwNumArgs is set to greater than 1 for a SZARRAY this function will recursively
// allocate sub-arrays and fill them in.
//
// For arrays with lower bounds, pBounds is <lower bound 1>, <count 1>, <lower bound 2>, ...
OBJECTREF AllocateArrayEx(TypeHandle arrayType, INT32 *pArgs, DWORD dwNumArgs, BOOL bAllocateInLargeHeap
DEBUG_ARG(BOOL bDontSetAppDomain))
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
PRECONDITION(CheckPointer(pArgs));
PRECONDITION(dwNumArgs > 0);
} CONTRACTL_END;
ArrayBase * orArray = NULL;
#ifdef _DEBUG
if (g_pConfig->ShouldInjectFault(INJECTFAULT_GCHEAP))
{
char *a = new char;
delete a;
}
#endif
ArrayTypeDesc* arrayDesc = arrayType.AsArray();
MethodTable* pArrayMT = arrayDesc->GetMethodTable();
_ASSERTE(pArrayMT->CheckInstanceActivated());
PREFIX_ASSUME(pArrayMT != NULL);
CorElementType kind = arrayType.GetInternalCorElementType();
_ASSERTE(kind == ELEMENT_TYPE_ARRAY || kind == ELEMENT_TYPE_SZARRAY);
CorElementType elemType = arrayDesc->GetTypeParam().GetInternalCorElementType();
// Disallow the creation of void[,] (a multi-dim array of System.Void)
if (elemType == ELEMENT_TYPE_VOID)
COMPlusThrow(kArgumentException);
// Calculate the total number of elements in the array
UINT32 cElements;
// IBC Log MethodTable access
g_IBCLogger.LogMethodTableAccess(pArrayMT);
SetTypeHandleOnThreadForAlloc(arrayType);
SIZE_T componentSize = pArrayMT->GetComponentSize();
bool maxArrayDimensionLengthOverflow = false;
bool providedLowerBounds = false;
if (kind == ELEMENT_TYPE_ARRAY)
{
unsigned rank = arrayDesc->GetRank();
_ASSERTE(dwNumArgs == rank || dwNumArgs == 2*rank);
// Morph a ARRAY rank 1 with 0 lower bound into an SZARRAY
if (rank == 1 && (dwNumArgs == 1 || pArgs[0] == 0))
{ // lower bound is zero
// This recursive call doesn't go any farther, because the dwNumArgs will be 1,
// so don't bother with stack probe.
TypeHandle szArrayType = ClassLoader::LoadArrayTypeThrowing(arrayDesc->GetArrayElementTypeHandle(), ELEMENT_TYPE_SZARRAY, 1);
return AllocateArrayEx(szArrayType, &pArgs[dwNumArgs - 1], 1, bAllocateInLargeHeap DEBUG_ARG(bDontSetAppDomain));
}
providedLowerBounds = (dwNumArgs == 2*rank);
S_UINT32 safeTotalElements = S_UINT32(1);
for (unsigned i = 0; i < dwNumArgs; i++)
{
int lowerBound = 0;
if (providedLowerBounds)
{
lowerBound = pArgs[i];
i++;
}
int length = pArgs[i];
if (length < 0)
COMPlusThrow(kOverflowException);
if ((SIZE_T)length > MaxArrayLength(componentSize))
maxArrayDimensionLengthOverflow = true;
if ((length > 0) && (lowerBound + (length - 1) < lowerBound))
COMPlusThrow(kArgumentOutOfRangeException, W("ArgumentOutOfRange_ArrayLBAndLength"));
safeTotalElements = safeTotalElements * S_UINT32(length);
if (safeTotalElements.IsOverflow())
ThrowOutOfMemoryDimensionsExceeded();
}
cElements = safeTotalElements.Value();
}
else
{
int length = pArgs[0];
if (length < 0)
COMPlusThrow(kOverflowException);
if ((SIZE_T)length > MaxArrayLength(componentSize))
maxArrayDimensionLengthOverflow = true;
cElements = length;
}
// Throw this exception only after everything else was validated for backward compatibility.
if (maxArrayDimensionLengthOverflow)
ThrowOutOfMemoryDimensionsExceeded();
// Allocate the space from the GC heap
S_SIZE_T safeTotalSize = S_SIZE_T(cElements) * S_SIZE_T(componentSize) + S_SIZE_T(pArrayMT->GetBaseSize());
if (safeTotalSize.IsOverflow())
ThrowOutOfMemoryDimensionsExceeded();
size_t totalSize = safeTotalSize.Value();
#ifdef FEATURE_DOUBLE_ALIGNMENT_HINT
if ((elemType == ELEMENT_TYPE_R8) &&
(cElements >= g_pConfig->GetDoubleArrayToLargeObjectHeapThreshold()))
{
STRESS_LOG2(LF_GC, LL_INFO10, "Allocating double MD array of size %d and length %d to large object heap\n", totalSize, cElements);
bAllocateInLargeHeap = TRUE;
}
#endif
if (bAllocateInLargeHeap)
{
orArray = (ArrayBase *) AllocLHeap(totalSize, FALSE, pArrayMT->ContainsPointers());
orArray->SetMethodTableForLargeObject(pArrayMT);
}
else
{
#ifdef FEATURE_64BIT_ALIGNMENT
MethodTable *pElementMT = arrayDesc->GetTypeParam().GetMethodTable();
if (pElementMT->RequiresAlign8() && pElementMT->IsValueType())
{
// This platform requires that certain fields are 8-byte aligned (and the runtime doesn't provide
// this guarantee implicitly, e.g. on 32-bit platforms). Since it's the array payload, not the
// header that requires alignment we need to be careful. However it just so happens that all the
// cases we care about (single and multi-dim arrays of value types) have an even number of DWORDs
// in their headers so the alignment requirements for the header and the payload are the same.
_ASSERTE(((pArrayMT->GetBaseSize() - SIZEOF_OBJHEADER) & 7) == 0);
orArray = (ArrayBase *) AllocAlign8(totalSize, FALSE, pArrayMT->ContainsPointers(), FALSE);
}
else
#endif
{
orArray = (ArrayBase *) Alloc(totalSize, FALSE, pArrayMT->ContainsPointers());
}
orArray->SetMethodTable(pArrayMT);
}
// Initialize Object
orArray->m_NumComponents = cElements;
if (bAllocateInLargeHeap ||
(totalSize >= LARGE_OBJECT_SIZE))
{
GCHeapUtilities::GetGCHeap()->PublishObject((BYTE*)orArray);
}
#ifdef _LOGALLOC
LogAlloc(totalSize, pArrayMT, orArray);
#endif // _LOGALLOC
#ifdef _DEBUG
// Ensure the typehandle has been interned prior to allocation.
// This is important for OOM reliability.
OBJECTREF objref = ObjectToOBJECTREF((Object *) orArray);
GCPROTECT_BEGIN(objref);
orArray->GetTypeHandle();
GCPROTECT_END();
orArray = (ArrayBase *) OBJECTREFToObject(objref);
#endif
#if CHECK_APP_DOMAIN_LEAKS
if (!bDontSetAppDomain && g_pConfig->AppDomainLeaks())
orArray->SetAppDomain();
#endif
if (kind == ELEMENT_TYPE_ARRAY)
{
INT32 *pCountsPtr = (INT32 *) orArray->GetBoundsPtr();
INT32 *pLowerBoundsPtr = (INT32 *) orArray->GetLowerBoundsPtr();
for (unsigned i = 0; i < dwNumArgs; i++)
{
if (providedLowerBounds)
*pLowerBoundsPtr++ = pArgs[i++]; // if not stated, lower bound becomes 0
*pCountsPtr++ = pArgs[i];
}
}
// Notify the profiler of the allocation
// do this after initializing bounds so callback has size information
if (TrackAllocations())
{
ProfileTrackArrayAlloc(orArray);
}
#ifdef FEATURE_EVENT_TRACE
// Send ETW event for allocation
if(ETW::TypeSystemLog::IsHeapAllocEventEnabled())
{
ETW::TypeSystemLog::SendObjectAllocatedEvent(orArray);
}
#endif // FEATURE_EVENT_TRACE
if (kind != ELEMENT_TYPE_ARRAY)
{
// Handle allocating multiple jagged array dimensions at once
if (dwNumArgs > 1)
{
PTRARRAYREF outerArray = (PTRARRAYREF) ObjectToOBJECTREF((Object *) orArray);
GCPROTECT_BEGIN(outerArray);
// Turn off GC stress, it is of little value here
{
GCStressPolicy::InhibitHolder iholder;
// Allocate dwProvidedBounds arrays
if (!arrayDesc->GetArrayElementTypeHandle().IsArray())
{
orArray = NULL;
}
else
{
// Since we're about to *really* recurse, probe for stack.
// @todo: is the default amount really correct?
_ASSERTE(GetThread());
INTERIOR_STACK_PROBE(GetThread());
TypeHandle subArrayType = arrayDesc->GetArrayElementTypeHandle();
for (UINT32 i = 0; i < cElements; i++)
{
OBJECTREF obj = AllocateArrayEx(subArrayType, &pArgs[1], dwNumArgs-1, bAllocateInLargeHeap DEBUG_ARG(bDontSetAppDomain));
outerArray->SetAt(i, obj);
}
iholder.Release();
END_INTERIOR_STACK_PROBE
orArray = (ArrayBase *) OBJECTREFToObject(outerArray);
}
} // GcStressPolicy::~InhibitHolder()
GCPROTECT_END();
}
}
return ObjectToOBJECTREF((Object *) orArray);
}
/*
* Allocates a single dimensional array of primitive types.
*/
OBJECTREF AllocatePrimitiveArray(CorElementType type, DWORD cElements, BOOL bAllocateInLargeHeap)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
INJECT_FAULT(COMPlusThrowOM());
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
}
CONTRACTL_END
// Allocating simple primite arrays is done in various places as internal storage.
// Because this is unlikely to result in any bad recursions, we will override the type limit
// here rather forever chase down all the callers.
OVERRIDE_TYPE_LOAD_LEVEL_LIMIT(CLASS_LOADED);
_ASSERTE(CorTypeInfo::IsPrimitiveType(type));
// Fetch the proper array type
if (g_pPredefinedArrayTypes[type] == NULL)
{
TypeHandle elemType = TypeHandle(MscorlibBinder::GetElementType(type));
TypeHandle typHnd = ClassLoader::LoadArrayTypeThrowing(elemType, ELEMENT_TYPE_SZARRAY, 0);
g_pPredefinedArrayTypes[type] = typHnd.AsArray();
}
return FastAllocatePrimitiveArray(g_pPredefinedArrayTypes[type]->GetMethodTable(), cElements, bAllocateInLargeHeap);
}
/*
* Allocates a single dimensional array of primitive types.
*/
OBJECTREF FastAllocatePrimitiveArray(MethodTable* pMT, DWORD cElements, BOOL bAllocateInLargeHeap)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
PRECONDITION(pMT->CheckInstanceActivated());
} CONTRACTL_END;
#ifdef _DEBUG
if (g_pConfig->ShouldInjectFault(INJECTFAULT_GCHEAP))
{
char *a = new char;
delete a;
}
#endif
_ASSERTE(pMT && pMT->IsArray());
_ASSERTE(pMT->IsRestored_NoLogging());
_ASSERTE(CorTypeInfo::IsPrimitiveType(pMT->GetArrayElementType()) &&
g_pPredefinedArrayTypes[pMT->GetArrayElementType()] != NULL);
g_IBCLogger.LogMethodTableAccess(pMT);
SetTypeHandleOnThreadForAlloc(TypeHandle(pMT));
SIZE_T componentSize = pMT->GetComponentSize();
if (cElements > MaxArrayLength(componentSize))
ThrowOutOfMemory();
S_SIZE_T safeTotalSize = S_SIZE_T(cElements) * S_SIZE_T(componentSize) + S_SIZE_T(pMT->GetBaseSize());
if (safeTotalSize.IsOverflow())
ThrowOutOfMemory();
size_t totalSize = safeTotalSize.Value();
BOOL bPublish = bAllocateInLargeHeap;
ArrayBase* orObject;
if (bAllocateInLargeHeap)
{
orObject = (ArrayBase*) AllocLHeap(totalSize, FALSE, FALSE);
}
else
{
ArrayTypeDesc *pArrayR8TypeDesc = g_pPredefinedArrayTypes[ELEMENT_TYPE_R8];
if (DATA_ALIGNMENT < sizeof(double) && pArrayR8TypeDesc != NULL && pMT == pArrayR8TypeDesc->GetMethodTable() && totalSize < LARGE_OBJECT_SIZE - MIN_OBJECT_SIZE)
{
// Creation of an array of doubles, not in the large object heap.
// We want to align the doubles to 8 byte boundaries, but the GC gives us pointers aligned
// to 4 bytes only (on 32 bit platforms). To align, we ask for 12 bytes more to fill with a
// dummy object.
// If the GC gives us a 8 byte aligned address, we use it for the array and place the dummy
// object after the array, otherwise we put the dummy object first, shifting the base of
// the array to an 8 byte aligned address.
// Note: on 64 bit platforms, the GC always returns 8 byte aligned addresses, and we don't
// execute this code because DATA_ALIGNMENT < sizeof(double) is false.
_ASSERTE(DATA_ALIGNMENT == sizeof(double)/2);
_ASSERTE((MIN_OBJECT_SIZE % sizeof(double)) == DATA_ALIGNMENT); // used to change alignment
_ASSERTE(pMT->GetComponentSize() == sizeof(double));
_ASSERTE(g_pObjectClass->GetBaseSize() == MIN_OBJECT_SIZE);
_ASSERTE(totalSize < totalSize + MIN_OBJECT_SIZE);
orObject = (ArrayBase*) Alloc(totalSize + MIN_OBJECT_SIZE, FALSE, FALSE);
Object *orDummyObject;
if((size_t)orObject % sizeof(double))
{
orDummyObject = orObject;
orObject = (ArrayBase*) ((size_t)orObject + MIN_OBJECT_SIZE);
}
else
{
orDummyObject = (Object*) ((size_t)orObject + totalSize);
}
_ASSERTE(((size_t)orObject % sizeof(double)) == 0);
orDummyObject->SetMethodTable(g_pObjectClass);
}
else
{
orObject = (ArrayBase*) Alloc(totalSize, FALSE, FALSE);
bPublish = (totalSize >= LARGE_OBJECT_SIZE);
}
}
// Initialize Object
orObject->SetMethodTable( pMT );
_ASSERTE(orObject->GetMethodTable() != NULL);
orObject->m_NumComponents = cElements;
if (bPublish)
{
GCHeapUtilities::GetGCHeap()->PublishObject((BYTE*)orObject);
}
// Notify the profiler of the allocation
if (TrackAllocations())
{
OBJECTREF objref = ObjectToOBJECTREF((Object*)orObject);
GCPROTECT_BEGIN(objref);
ProfilerObjectAllocatedCallback(objref, (ClassID) orObject->GetTypeHandle().AsPtr());
GCPROTECT_END();
orObject = (ArrayBase *) OBJECTREFToObject(objref);
}
#ifdef FEATURE_EVENT_TRACE
// Send ETW event for allocation
if(ETW::TypeSystemLog::IsHeapAllocEventEnabled())
{
ETW::TypeSystemLog::SendObjectAllocatedEvent(orObject);
}
#endif // FEATURE_EVENT_TRACE
// IBC Log MethodTable access
g_IBCLogger.LogMethodTableAccess(pMT);
LogAlloc(totalSize, pMT, orObject);
#if CHECK_APP_DOMAIN_LEAKS
if (g_pConfig->AppDomainLeaks())
orObject->SetAppDomain();
#endif
return( ObjectToOBJECTREF((Object*)orObject) );
}
//
// Allocate an array which is the same size as pRef. However, do not zero out the array.
//
OBJECTREF DupArrayForCloning(BASEARRAYREF pRef, BOOL bAllocateInLargeHeap)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
ArrayTypeDesc arrayType(pRef->GetMethodTable(), pRef->GetArrayElementTypeHandle());
unsigned rank = arrayType.GetRank();
DWORD numArgs = rank*2;
INT32* args = (INT32*) _alloca(sizeof(INT32)*numArgs);
if (arrayType.GetInternalCorElementType() == ELEMENT_TYPE_ARRAY)
{
const INT32* bounds = pRef->GetBoundsPtr();
const INT32* lowerBounds = pRef->GetLowerBoundsPtr();
for(unsigned int i=0; i < rank; i++)
{
args[2*i] = lowerBounds[i];
args[2*i+1] = bounds[i];
}
}
else
{
numArgs = 1;
args[0] = pRef->GetNumComponents();
}
return AllocateArrayEx(TypeHandle(&arrayType), args, numArgs, bAllocateInLargeHeap DEBUG_ARG(FALSE));
}
#if defined(_TARGET_X86_)
// The fast version always allocates in the normal heap
OBJECTREF AllocatePrimitiveArray(CorElementType type, DWORD cElements)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
#ifdef _DEBUG
// fastPrimitiveArrayAllocator is called by VM and managed code. If called from managed code, we
// make sure that the thread is in SOTolerantState.
#ifdef FEATURE_STACK_PROBE
Thread::DisableSOCheckInHCALL disableSOCheckInHCALL;
#endif // FEATURE_STACK_PROBE
#endif // _DEBUG
return OBJECTREF( HCCALL2(fastPrimitiveArrayAllocator, type, cElements) );
}
// The fast version always allocates in the normal heap
OBJECTREF AllocateObjectArray(DWORD cElements, TypeHandle ElementType)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
OVERRIDE_TYPE_LOAD_LEVEL_LIMIT(CLASS_LOADED);
// We must call this here to ensure the typehandle for this object is
// interned before the object is allocated. As soon as the object is allocated,
// the profiler could do a heapwalk and it expects to find an interned
// typehandle for every object in the heap.
TypeHandle ArrayType = ClassLoader::LoadArrayTypeThrowing(ElementType);
#ifdef _DEBUG
// fastObjectArrayAllocator is called by VM and managed code. If called from managed code, we
// make sure that the thread is in SOTolerantState.
#ifdef FEATURE_STACK_PROBE
Thread::DisableSOCheckInHCALL disableSOCheckInHCALL;
#endif // FEATURE_STACK_PROBE
#endif // _DEBUG
return OBJECTREF( HCCALL2(fastObjectArrayAllocator, ArrayType.AsPtr(), cElements));
}
STRINGREF AllocateString( DWORD cchStringLength )
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
#ifdef _DEBUG
// fastStringAllocator is called by VM and managed code. If called from managed code, we
// make sure that the thread is in SOTolerantState.
#ifdef FEATURE_STACK_PROBE
Thread::DisableSOCheckInHCALL disableSOCheckInHCALL;
#endif // FEATURE_STACK_PROBE
#endif // _DEBUG
return STRINGREF(HCCALL1(fastStringAllocator, cchStringLength));
}
#endif
//
// Helper for parts of the EE which are allocating arrays
//
OBJECTREF AllocateObjectArray(DWORD cElements, TypeHandle elementType, BOOL bAllocateInLargeHeap)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
OVERRIDE_TYPE_LOAD_LEVEL_LIMIT(CLASS_LOADED);
// The object array class is loaded at startup.
_ASSERTE(g_pPredefinedArrayTypes[ELEMENT_TYPE_OBJECT] != NULL);
#ifdef _DEBUG
ArrayTypeDesc arrayType(g_pPredefinedArrayTypes[ELEMENT_TYPE_OBJECT]->GetMethodTable(), elementType);
_ASSERTE(arrayType.GetRank() == 1);
_ASSERTE(arrayType.GetInternalCorElementType() == ELEMENT_TYPE_SZARRAY);
#endif //_DEBUG
return AllocateArrayEx(ClassLoader::LoadArrayTypeThrowing(elementType),
(INT32 *)(&cElements),
1,
bAllocateInLargeHeap
DEBUG_ARG(FALSE));
}
STRINGREF SlowAllocateString( DWORD cchStringLength )
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
} CONTRACTL_END;
StringObject *orObject = NULL;
#ifdef _DEBUG
if (g_pConfig->ShouldInjectFault(INJECTFAULT_GCHEAP))
{
char *a = new char;
delete a;
}
#endif
// Limit the maximum string size to <2GB to mitigate risk of security issues caused by 32-bit integer
// overflows in buffer size calculations.
if (cchStringLength > 0x3FFFFFDF)
ThrowOutOfMemory();
SIZE_T ObjectSize = PtrAlign(StringObject::GetSize(cchStringLength));
_ASSERTE(ObjectSize > cchStringLength);
SetTypeHandleOnThreadForAlloc(TypeHandle(g_pStringClass));
orObject = (StringObject *)Alloc( ObjectSize, FALSE, FALSE );
// Object is zero-init already
_ASSERTE( orObject->HasEmptySyncBlockInfo() );
// Initialize Object
//<TODO>@TODO need to build a LARGE g_pStringMethodTable before</TODO>
orObject->SetMethodTable( g_pStringClass );
orObject->SetStringLength( cchStringLength );
if (ObjectSize >= LARGE_OBJECT_SIZE)
{
GCHeapUtilities::GetGCHeap()->PublishObject((BYTE*)orObject);
}
// Notify the profiler of the allocation
if (TrackAllocations())
{
OBJECTREF objref = ObjectToOBJECTREF((Object*)orObject);
GCPROTECT_BEGIN(objref);
ProfilerObjectAllocatedCallback(objref, (ClassID) orObject->GetTypeHandle().AsPtr());
GCPROTECT_END();
orObject = (StringObject *) OBJECTREFToObject(objref);
}
#ifdef FEATURE_EVENT_TRACE
// Send ETW event for allocation
if(ETW::TypeSystemLog::IsHeapAllocEventEnabled())
{
ETW::TypeSystemLog::SendObjectAllocatedEvent(orObject);
}
#endif // FEATURE_EVENT_TRACE
LogAlloc(ObjectSize, g_pStringClass, orObject);
#if CHECK_APP_DOMAIN_LEAKS
if (g_pConfig->AppDomainLeaks())
orObject->SetAppDomain();
#endif
return( ObjectToSTRINGREF(orObject) );
}
#ifdef FEATURE_COMINTEROP_UNMANAGED_ACTIVATION
// OBJECTREF AllocateComClassObject(ComClassFactory* pComClsFac)
void AllocateComClassObject(ComClassFactory* pComClsFac, OBJECTREF* ppRefClass)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref (out param) without pinning it => cooperative
PRECONDITION(CheckPointer(pComClsFac));
PRECONDITION(CheckPointer(ppRefClass));
} CONTRACTL_END;
// Create a COM+ Class object.
MethodTable *pMT = g_pRuntimeTypeClass;
_ASSERTE(pMT != NULL);
*ppRefClass= AllocateObject(pMT);
if (*ppRefClass != NULL)
{
SyncBlock* pSyncBlock = (*((REFLECTCLASSBASEREF*) ppRefClass))->GetSyncBlock();
// <TODO> This needs to support a COM version of ReflectClass. Right now we
// still work as we used to <darylo> </TODO>
MethodTable* pComMT = g_pBaseCOMObject;
_ASSERTE(pComMT != NULL);
// class for ComObject
(*((REFLECTCLASSBASEREF*) ppRefClass))->SetType(TypeHandle(pComMT));
pSyncBlock->GetInteropInfo()->SetComClassFactory(pComClsFac);
}
}
#endif // FEATURE_COMINTEROP_UNMANAGED_ACTIVATION
// AllocateObject will throw OutOfMemoryException so don't need to check
// for NULL return value from it.
OBJECTREF AllocateObject(MethodTable *pMT
#ifdef FEATURE_COMINTEROP
, bool fHandleCom
#endif
)
{
CONTRACTL {
THROWS;
GC_TRIGGERS;
MODE_COOPERATIVE; // returns an objref without pinning it => cooperative
PRECONDITION(CheckPointer(pMT));
PRECONDITION(pMT->CheckInstanceActivated());
} CONTRACTL_END;
Object *orObject = NULL;
// use unchecked oref here to avoid triggering assert in Validate that the AD is
// not set becuase it isn't until near the end of the fcn at which point we can allow
// the check.
_UNCHECKED_OBJECTREF oref;
g_IBCLogger.LogMethodTableAccess(pMT);
SetTypeHandleOnThreadForAlloc(TypeHandle(pMT));
#ifdef FEATURE_COMINTEROP
#ifdef FEATURE_COMINTEROP_UNMANAGED_ACTIVATION
if (fHandleCom && pMT->IsComObjectType() && !pMT->IsWinRTObjectType())
{
// Create a instance of __ComObject here is not allowed as we don't know what COM object to create
if (pMT == g_pBaseCOMObject)
COMPlusThrow(kInvalidComObjectException, IDS_EE_NO_BACKING_CLASS_FACTORY);
oref = OBJECTREF_TO_UNCHECKED_OBJECTREF(AllocateComObject_ForManaged(pMT));
}
else
#endif // FEATURE_COMINTEROP_UNMANAGED_ACTIVATION
#endif // FEATURE_COMINTEROP
{
DWORD baseSize = pMT->GetBaseSize();
#ifdef FEATURE_64BIT_ALIGNMENT
if (pMT->RequiresAlign8())
{
// The last argument to the allocation, indicates whether the alignment should be "biased". This
// means that the object is allocated so that its header lies exactly between two 8-byte
// boundaries. This is required in cases where we need to mis-align the header in order to align
// the actual payload. Currently this is false for classes (where we apply padding to ensure the
// first field is aligned relative to the header) and true for boxed value types (where we can't
// do the same padding without introducing more complexity in type layout and unboxing stubs).
_ASSERTE(sizeof(Object) == 4);
orObject = (Object *) AllocAlign8(baseSize,
pMT->HasFinalizer(),
pMT->ContainsPointers(),
pMT->IsValueType());
}
else
#endif // FEATURE_64BIT_ALIGNMENT
{
orObject = (Object *) Alloc(baseSize,
pMT->HasFinalizer(),
pMT->ContainsPointers());
}
// verify zero'd memory (at least for sync block)
_ASSERTE( orObject->HasEmptySyncBlockInfo() );
if ((baseSize >= LARGE_OBJECT_SIZE))
{
orObject->SetMethodTableForLargeObject(pMT);
GCHeapUtilities::GetGCHeap()->PublishObject((BYTE*)orObject);
}
else
{
orObject->SetMethodTable(pMT);
}
#if CHECK_APP_DOMAIN_LEAKS
if (g_pConfig->AppDomainLeaks())
orObject->SetAppDomain();
else
#endif
if (pMT->HasFinalizer())
orObject->SetAppDomain();
// Notify the profiler of the allocation
if (TrackAllocations())
{
OBJECTREF objref = ObjectToOBJECTREF((Object*)orObject);
GCPROTECT_BEGIN(objref);
ProfilerObjectAllocatedCallback(objref, (ClassID) orObject->GetTypeHandle().AsPtr());
GCPROTECT_END();
orObject = (Object *) OBJECTREFToObject(objref);
}
#ifdef FEATURE_EVENT_TRACE
// Send ETW event for allocation
if(ETW::TypeSystemLog::IsHeapAllocEventEnabled())
{
ETW::TypeSystemLog::SendObjectAllocatedEvent(orObject);
}
#endif // FEATURE_EVENT_TRACE
LogAlloc(pMT->GetBaseSize(), pMT, orObject);
oref = OBJECTREF_TO_UNCHECKED_OBJECTREF(orObject);
}
return UNCHECKED_OBJECTREF_TO_OBJECTREF(oref);
}
//========================================================================
//
// WRITE BARRIER HELPERS
//
//========================================================================
#define card_byte(addr) (((size_t)(addr)) >> card_byte_shift)
#define card_bit(addr) (1 << ((((size_t)(addr)) >> (card_byte_shift - 3)) & 7))
#ifdef FEATURE_MANUALLY_MANAGED_CARD_BUNDLES
#define card_bundle_byte(addr) (((size_t)(addr)) >> card_bundle_byte_shift)
static void SetCardBundleByte(BYTE* addr)
{
BYTE* cbByte = (BYTE *)VolatileLoadWithoutBarrier(&g_card_bundle_table) + card_bundle_byte(addr);
if (*cbByte != 0xFF)
{
*cbByte = 0xFF;
}
}
#endif
#ifdef FEATURE_USE_ASM_GC_WRITE_BARRIERS
// implemented in assembly
// extern "C" HCIMPL2_RAW(VOID, JIT_CheckedWriteBarrier, Object **dst, Object *refUNSAFE)
// extern "C" HCIMPL2_RAW(VOID, JIT_WriteBarrier, Object **dst, Object *refUNSAFE)
#else // FEATURE_USE_ASM_GC_WRITE_BARRIERS
// NOTE: non-ASM write barriers only work with Workstation GC.
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
static UINT64 CheckedBarrierCount = 0;
static UINT64 CheckedBarrierRetBufCount = 0;
static UINT64 CheckedBarrierByrefArgCount = 0;
static UINT64 CheckedBarrierByrefOtherLocalCount = 0;
static UINT64 CheckedBarrierAddrOfLocalCount = 0;
static UINT64 UncheckedBarrierCount = 0;
static UINT64 CheckedAfterHeapFilter = 0;
static UINT64 CheckedAfterRefInEphemFilter = 0;
static UINT64 CheckedAfterAlreadyDirtyFilter = 0;
static UINT64 CheckedDestInEphem = 0;
static UINT64 UncheckedAfterRefInEphemFilter = 0;
static UINT64 UncheckedAfterAlreadyDirtyFilter = 0;
static UINT64 UncheckedDestInEphem = 0;
const unsigned BarrierCountPrintInterval = 1000000;
static unsigned CheckedBarrierInterval = BarrierCountPrintInterval;
static unsigned UncheckedBarrierInterval = BarrierCountPrintInterval;
void IncCheckedBarrierCount()
{
++CheckedBarrierCount;
if (--CheckedBarrierInterval == 0)
{
CheckedBarrierInterval = BarrierCountPrintInterval;
printf("GC write barrier counts: checked = %lld, unchecked = %lld, total = %lld.\n",
CheckedBarrierCount, UncheckedBarrierCount, (CheckedBarrierCount + UncheckedBarrierCount));
printf(" [Checked: %lld after heap check, %lld after ephem check, %lld after already dirty check.]\n",
CheckedAfterHeapFilter, CheckedAfterRefInEphemFilter, CheckedAfterAlreadyDirtyFilter);
printf(" [Unchecked: %lld after ephem check, %lld after already dirty check.]\n",
UncheckedAfterRefInEphemFilter, UncheckedAfterAlreadyDirtyFilter);
printf(" [Dest in ephem: checked = %lld, unchecked = %lld.]\n",
CheckedDestInEphem, UncheckedDestInEphem);
printf(" [Checked: %lld are stores to fields of ret buff, %lld via byref args,\n",
CheckedBarrierRetBufCount, CheckedBarrierByrefArgCount);
printf(" %lld via other locals, %lld via addr of local.]\n",
CheckedBarrierByrefOtherLocalCount, CheckedBarrierAddrOfLocalCount);
}
}
void IncUncheckedBarrierCount()
{
++UncheckedBarrierCount;
if (--UncheckedBarrierInterval == 0)
{
printf("GC write barrier counts: checked = %lld, unchecked = %lld, total = %lld.\n",
CheckedBarrierCount, UncheckedBarrierCount, (CheckedBarrierCount + UncheckedBarrierCount));
UncheckedBarrierInterval = BarrierCountPrintInterval;
}
}
#endif // FEATURE_COUNT_GC_WRITE_BARRIERS
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
// (We ignore the advice below on using a _RAW macro for this performance diagnostic mode, which need not function properly in
// all situations...)
extern "C" HCIMPL3(VOID, JIT_CheckedWriteBarrier, Object **dst, Object *ref, CheckedWriteBarrierKinds kind)
#else
// This function is a JIT helper, but it must NOT use HCIMPL2 because it
// modifies Thread state that will not be restored if an exception occurs
// inside of memset. A normal EH unwind will not occur.
extern "C" HCIMPL2_RAW(VOID, JIT_CheckedWriteBarrier, Object **dst, Object *ref)
#endif
{
// Must use static contract here, because if an AV occurs, a normal EH
// unwind will not occur, and destructors will not run.
STATIC_CONTRACT_MODE_COOPERATIVE;
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_NOTRIGGER;
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
IncCheckedBarrierCount();
switch (kind)
{
case CWBKind_RetBuf:
CheckedBarrierRetBufCount++;
break;
case CWBKind_ByRefArg:
CheckedBarrierByrefArgCount++;
break;
case CWBKind_OtherByRefLocal:
CheckedBarrierByrefOtherLocalCount++;
break;
case CWBKind_AddrOfLocal:
CheckedBarrierAddrOfLocalCount++;
break;
case CWBKind_Unclassified:
break;
default:
// It should be some member of the enumeration.
_ASSERTE_ALL_BUILDS(__FILE__, false);
break;
}
#endif // FEATURE_COUNT_GC_WRITE_BARRIERS
// no HELPER_METHOD_FRAME because we are MODE_COOPERATIVE, GC_NOTRIGGER
*dst = ref;
// if the dst is outside of the heap (unboxed value classes) then we
// simply exit
if (((BYTE*)dst < g_lowest_address) || ((BYTE*)dst >= g_highest_address))
return;
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
CheckedAfterHeapFilter++;
#endif
#ifdef WRITE_BARRIER_CHECK
updateGCShadow(dst, ref); // support debugging write barrier
#endif
#ifdef FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
if (GCHeapUtilities::SoftwareWriteWatchIsEnabled())
{
GCHeapUtilities::SoftwareWriteWatchSetDirty(dst, sizeof(*dst));
}
#endif // FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
if((BYTE*) dst >= g_ephemeral_low && (BYTE*) dst < g_ephemeral_high)
{
CheckedDestInEphem++;
}
#endif
if((BYTE*) ref >= g_ephemeral_low && (BYTE*) ref < g_ephemeral_high)
{
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
CheckedAfterRefInEphemFilter++;
#endif
// VolatileLoadWithoutBarrier() is used here to prevent fetch of g_card_table from being reordered
// with g_lowest/highest_address check above. See comment in code:gc_heap::grow_brick_card_tables.
BYTE* pCardByte = (BYTE *)VolatileLoadWithoutBarrier(&g_card_table) + card_byte((BYTE *)dst);
if(*pCardByte != 0xFF)
{
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
CheckedAfterAlreadyDirtyFilter++;
#endif
*pCardByte = 0xFF;
#ifdef FEATURE_MANUALLY_MANAGED_CARD_BUNDLES
SetCardBundleByte((BYTE*)dst);
#endif
}
}
}
HCIMPLEND_RAW
// This function is a JIT helper, but it must NOT use HCIMPL2 because it
// modifies Thread state that will not be restored if an exception occurs
// inside of memset. A normal EH unwind will not occur.
extern "C" HCIMPL2_RAW(VOID, JIT_WriteBarrier, Object **dst, Object *ref)
{
// Must use static contract here, because if an AV occurs, a normal EH
// unwind will not occur, and destructors will not run.
STATIC_CONTRACT_MODE_COOPERATIVE;
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_NOTRIGGER;
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
IncUncheckedBarrierCount();
#endif
// no HELPER_METHOD_FRAME because we are MODE_COOPERATIVE, GC_NOTRIGGER
*dst = ref;
// If the store above succeeded, "dst" should be in the heap.
assert(GCHeapUtilities::GetGCHeap()->IsHeapPointer((void*)dst));
#ifdef WRITE_BARRIER_CHECK
updateGCShadow(dst, ref); // support debugging write barrier
#endif
#ifdef FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
if (GCHeapUtilities::SoftwareWriteWatchIsEnabled())
{
GCHeapUtilities::SoftwareWriteWatchSetDirty(dst, sizeof(*dst));
}
#endif // FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
if((BYTE*) dst >= g_ephemeral_low && (BYTE*) dst < g_ephemeral_high)
{
UncheckedDestInEphem++;
}
#endif
if((BYTE*) ref >= g_ephemeral_low && (BYTE*) ref < g_ephemeral_high)
{
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
UncheckedAfterRefInEphemFilter++;
#endif
BYTE* pCardByte = (BYTE *)VolatileLoadWithoutBarrier(&g_card_table) + card_byte((BYTE *)dst);
if(*pCardByte != 0xFF)
{
#ifdef FEATURE_COUNT_GC_WRITE_BARRIERS
UncheckedAfterAlreadyDirtyFilter++;
#endif
*pCardByte = 0xFF;
#ifdef FEATURE_MANUALLY_MANAGED_CARD_BUNDLES
SetCardBundleByte((BYTE*)dst);
#endif
}
}
}
HCIMPLEND_RAW
#endif // FEATURE_USE_ASM_GC_WRITE_BARRIERS
extern "C" HCIMPL2_RAW(VOID, JIT_WriteBarrierEnsureNonHeapTarget, Object **dst, Object *ref)
{
// Must use static contract here, because if an AV occurs, a normal EH
// unwind will not occur, and destructors will not run.
STATIC_CONTRACT_MODE_COOPERATIVE;
STATIC_CONTRACT_THROWS;
STATIC_CONTRACT_GC_NOTRIGGER;
assert(!GCHeapUtilities::GetGCHeap()->IsHeapPointer((void*)dst));
// no HELPER_METHOD_FRAME because we are MODE_COOPERATIVE, GC_NOTRIGGER
*dst = ref;
}
HCIMPLEND_RAW
// This function sets the card table with the granularity of 1 byte, to avoid ghost updates
// that could occur if multiple threads were trying to set different bits in the same card.
#include <optsmallperfcritical.h>
void ErectWriteBarrier(OBJECTREF *dst, OBJECTREF ref)
{
STATIC_CONTRACT_MODE_COOPERATIVE;
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_SO_TOLERANT;
// if the dst is outside of the heap (unboxed value classes) then we
// simply exit
if (((BYTE*)dst < g_lowest_address) || ((BYTE*)dst >= g_highest_address))
return;
#ifdef WRITE_BARRIER_CHECK
updateGCShadow((Object**) dst, OBJECTREFToObject(ref)); // support debugging write barrier
#endif
#ifdef FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
if (GCHeapUtilities::SoftwareWriteWatchIsEnabled())
{
GCHeapUtilities::SoftwareWriteWatchSetDirty(dst, sizeof(*dst));
}
#endif // FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
if ((BYTE*) OBJECTREFToObject(ref) >= g_ephemeral_low && (BYTE*) OBJECTREFToObject(ref) < g_ephemeral_high)
{
// VolatileLoadWithoutBarrier() is used here to prevent fetch of g_card_table from being reordered
// with g_lowest/highest_address check above. See comment in code:gc_heap::grow_brick_card_tables.
BYTE* pCardByte = (BYTE *)VolatileLoadWithoutBarrier(&g_card_table) + card_byte((BYTE *)dst);
if (*pCardByte != 0xFF)
{
*pCardByte = 0xFF;
#ifdef FEATURE_MANUALLY_MANAGED_CARD_BUNDLES
SetCardBundleByte((BYTE*)dst);
#endif
}
}
}
#include <optdefault.h>
void ErectWriteBarrierForMT(MethodTable **dst, MethodTable *ref)
{
STATIC_CONTRACT_MODE_COOPERATIVE;
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_SO_TOLERANT;
*dst = ref;
#ifdef WRITE_BARRIER_CHECK
updateGCShadow((Object **)dst, (Object *)ref); // support debugging write barrier, updateGCShadow only cares that these are pointers
#endif
if (ref->Collectible())
{
#ifdef FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
if (GCHeapUtilities::SoftwareWriteWatchIsEnabled())
{
GCHeapUtilities::SoftwareWriteWatchSetDirty(dst, sizeof(*dst));
}
#endif // FEATURE_USE_SOFTWARE_WRITE_WATCH_FOR_GC_HEAP
BYTE *refObject = *(BYTE **)((MethodTable*)ref)->GetLoaderAllocatorObjectHandle();
if((BYTE*) refObject >= g_ephemeral_low && (BYTE*) refObject < g_ephemeral_high)
{
// See comment above
BYTE* pCardByte = (BYTE *)VolatileLoadWithoutBarrier(&g_card_table) + card_byte((BYTE *)dst);
if( !((*pCardByte) & card_bit((BYTE *)dst)) )
{
*pCardByte = 0xFF;
#ifdef FEATURE_MANUALLY_MANAGED_CARD_BUNDLES
SetCardBundleByte((BYTE*)dst);
#endif
}
}
}
}
//----------------------------------------------------------------------------
//
// Write Barrier Support for bulk copy ("Clone") operations
//
// StartPoint is the target bulk copy start point
// len is the length of the bulk copy (in bytes)
//
//
// Performance Note:
//
// This is implemented somewhat "conservatively", that is we
// assume that all the contents of the bulk copy are object
// references. If they are not, and the value lies in the
// ephemeral range, we will set false positives in the card table.
//
// We could use the pointer maps and do this more accurately if necessary
#if defined(_MSC_VER) && defined(_TARGET_X86_)
#pragma optimize("y", on) // Small critical routines, don't put in EBP frame
#endif //_MSC_VER && _TARGET_X86_
void
SetCardsAfterBulkCopy(Object **start, size_t len)
{
// If the size is smaller than a pointer, no write barrier is required.
if (len >= sizeof(uintptr_t))
{
InlinedSetCardsAfterBulkCopyHelper(start, len);
}
}
#if defined(_MSC_VER) && defined(_TARGET_X86_)
#pragma optimize("", on) // Go back to command line default optimizations
#endif //_MSC_VER && _TARGET_X86_
|