1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
|
// 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 "jitpch.h"
#ifdef _MSC_VER
#pragma hdrstop
#endif
#include "inlinepolicy.h"
// Lookup table for inline description strings
static const char* InlineDescriptions[] = {
#define INLINE_OBSERVATION(name, type, description, impact, target) description,
#include "inline.def"
#undef INLINE_OBSERVATION
};
// Lookup table for inline targets
static const InlineTarget InlineTargets[] = {
#define INLINE_OBSERVATION(name, type, description, impact, target) InlineTarget::target,
#include "inline.def"
#undef INLINE_OBSERVATION
};
// Lookup table for inline impacts
static const InlineImpact InlineImpacts[] = {
#define INLINE_OBSERVATION(name, type, description, impact, target) InlineImpact::impact,
#include "inline.def"
#undef INLINE_OBSERVATION
};
#ifdef DEBUG
//------------------------------------------------------------------------
// InlIsValidObservation: run a validity check on an inline observation
//
// Arguments:
// obs - the observation in question
//
// Return Value:
// true if the observation is valid
bool InlIsValidObservation(InlineObservation obs)
{
return ((obs > InlineObservation::CALLEE_UNUSED_INITIAL) && (obs < InlineObservation::CALLEE_UNUSED_FINAL));
}
#endif // DEBUG
//------------------------------------------------------------------------
// InlGetObservationString: get a string describing this inline observation
//
// Arguments:
// obs - the observation in question
//
// Return Value:
// string describing the observation
const char* InlGetObservationString(InlineObservation obs)
{
assert(InlIsValidObservation(obs));
return InlineDescriptions[static_cast<int>(obs)];
}
//------------------------------------------------------------------------
// InlGetTarget: get the target of an inline observation
//
// Arguments:
// obs - the observation in question
//
// Return Value:
// enum describing the target
InlineTarget InlGetTarget(InlineObservation obs)
{
assert(InlIsValidObservation(obs));
return InlineTargets[static_cast<int>(obs)];
}
//------------------------------------------------------------------------
// InlGetTargetString: get a string describing the target of an inline observation
//
// Arguments:
// obs - the observation in question
//
// Return Value:
// string describing the target
const char* InlGetTargetString(InlineObservation obs)
{
InlineTarget t = InlGetTarget(obs);
switch (t)
{
case InlineTarget::CALLER:
return "caller";
case InlineTarget::CALLEE:
return "callee";
case InlineTarget::CALLSITE:
return "call site";
default:
return "unexpected target";
}
}
//------------------------------------------------------------------------
// InlGetImpact: get the impact of an inline observation
//
// Arguments:
// obs - the observation in question
//
// Return Value:
// enum value describing the impact
InlineImpact InlGetImpact(InlineObservation obs)
{
assert(InlIsValidObservation(obs));
return InlineImpacts[static_cast<int>(obs)];
}
//------------------------------------------------------------------------
// InlGetImpactString: get a string describing the impact of an inline observation
//
// Arguments:
// obs - the observation in question
//
// Return Value:
// string describing the impact
const char* InlGetImpactString(InlineObservation obs)
{
InlineImpact i = InlGetImpact(obs);
switch (i)
{
case InlineImpact::FATAL:
return "correctness -- fatal";
case InlineImpact::FUNDAMENTAL:
return "correctness -- fundamental limitation";
case InlineImpact::LIMITATION:
return "correctness -- jit limitation";
case InlineImpact::PERFORMANCE:
return "performance";
case InlineImpact::INFORMATION:
return "information";
default:
return "unexpected impact";
}
}
//------------------------------------------------------------------------
// InlGetCorInfoInlineDecision: translate decision into a CorInfoInline
//
// Arguments:
// d - the decision in question
//
// Return Value:
// CorInfoInline value representing the decision
CorInfoInline InlGetCorInfoInlineDecision(InlineDecision d)
{
switch (d)
{
case InlineDecision::SUCCESS:
return INLINE_PASS;
case InlineDecision::FAILURE:
return INLINE_FAIL;
case InlineDecision::NEVER:
return INLINE_NEVER;
default:
assert(!"Unexpected InlineDecision");
unreached();
}
}
//------------------------------------------------------------------------
// InlGetDecisionString: get a string representing this decision
//
// Arguments:
// d - the decision in question
//
// Return Value:
// string representing the decision
const char* InlGetDecisionString(InlineDecision d)
{
switch (d)
{
case InlineDecision::SUCCESS:
return "success";
case InlineDecision::FAILURE:
return "failed this call site";
case InlineDecision::NEVER:
return "failed this callee";
case InlineDecision::CANDIDATE:
return "candidate";
case InlineDecision::UNDECIDED:
return "undecided";
default:
assert(!"Unexpected InlineDecision");
unreached();
}
}
//------------------------------------------------------------------------
// InlDecisionIsFailure: check if this decision describes a failing inline
//
// Arguments:
// d - the decision in question
//
// Return Value:
// true if the inline is definitely a failure
bool InlDecisionIsFailure(InlineDecision d)
{
switch (d)
{
case InlineDecision::SUCCESS:
case InlineDecision::UNDECIDED:
case InlineDecision::CANDIDATE:
return false;
case InlineDecision::FAILURE:
case InlineDecision::NEVER:
return true;
default:
assert(!"Unexpected InlineDecision");
unreached();
}
}
//------------------------------------------------------------------------
// InlDecisionIsSuccess: check if this decision describes a sucessful inline
//
// Arguments:
// d - the decision in question
//
// Return Value:
// true if the inline is definitely a success
bool InlDecisionIsSuccess(InlineDecision d)
{
switch (d)
{
case InlineDecision::SUCCESS:
return true;
case InlineDecision::FAILURE:
case InlineDecision::NEVER:
case InlineDecision::UNDECIDED:
case InlineDecision::CANDIDATE:
return false;
default:
assert(!"Unexpected InlineDecision");
unreached();
}
}
//------------------------------------------------------------------------
// InlDecisionIsNever: check if this decision describes a never inline
//
// Arguments:
// d - the decision in question
//
// Return Value:
// true if the inline is a never inline case
bool InlDecisionIsNever(InlineDecision d)
{
switch (d)
{
case InlineDecision::NEVER:
return true;
case InlineDecision::FAILURE:
case InlineDecision::SUCCESS:
case InlineDecision::UNDECIDED:
case InlineDecision::CANDIDATE:
return false;
default:
assert(!"Unexpected InlineDecision");
unreached();
}
}
//------------------------------------------------------------------------
// InlDecisionIsCandidate: check if this decision describes a viable candidate
//
// Arguments:
// d - the decision in question
//
// Return Value:
// true if this inline still might happen
bool InlDecisionIsCandidate(InlineDecision d)
{
return !InlDecisionIsFailure(d);
}
//------------------------------------------------------------------------
// InlDecisionIsDecided: check if this decision has been made
//
// Arguments:
// d - the decision in question
//
// Return Value:
// true if this inline has been decided one way or another
bool InlDecisionIsDecided(InlineDecision d)
{
switch (d)
{
case InlineDecision::NEVER:
case InlineDecision::FAILURE:
case InlineDecision::SUCCESS:
return true;
case InlineDecision::UNDECIDED:
case InlineDecision::CANDIDATE:
return false;
default:
assert(!"Unexpected InlineDecision");
unreached();
}
}
//------------------------------------------------------------------------
// InlineContext: default constructor
InlineContext::InlineContext(InlineStrategy* strategy)
: m_InlineStrategy(strategy)
, m_Parent(nullptr)
, m_Child(nullptr)
, m_Sibling(nullptr)
, m_Code(nullptr)
, m_ILSize(0)
, m_Offset(BAD_IL_OFFSET)
, m_Observation(InlineObservation::CALLEE_UNUSED_INITIAL)
, m_CodeSizeEstimate(0)
, m_Success(true)
, m_Devirtualized(false)
, m_Guarded(false)
, m_Unboxed(false)
#if defined(DEBUG) || defined(INLINE_DATA)
, m_Policy(nullptr)
, m_Callee(nullptr)
, m_TreeID(0)
, m_Ordinal(0)
#endif // defined(DEBUG) || defined(INLINE_DATA)
{
// Empty
}
#if defined(DEBUG) || defined(INLINE_DATA)
//------------------------------------------------------------------------
// Dump: Dump an InlineContext entry and all descendants to jitstdout
//
// Arguments:
// indent - indentation level for this node
void InlineContext::Dump(unsigned indent)
{
// Handle fact that siblings are in reverse order.
if (m_Sibling != nullptr)
{
m_Sibling->Dump(indent);
}
// We may not know callee name in some of the failing cases
Compiler* compiler = m_InlineStrategy->GetCompiler();
const char* calleeName = nullptr;
if (m_Callee == nullptr)
{
assert(!m_Success);
calleeName = "<unknown>";
}
else
{
#if defined(DEBUG)
calleeName = compiler->eeGetMethodFullName(m_Callee);
#else
calleeName = "callee";
#endif // defined(DEBUG)
}
mdMethodDef calleeToken = compiler->info.compCompHnd->getMethodDefFromMethod(m_Callee);
// Dump this node
if (m_Parent == nullptr)
{
// Root method
printf("Inlines into %08X %s\n", calleeToken, calleeName);
}
else
{
// Inline attempt.
const char* inlineReason = InlGetObservationString(m_Observation);
const char* inlineResult = m_Success ? "" : "FAILED: ";
const char* devirtualized = m_Devirtualized ? " devirt" : "";
const char* guarded = m_Guarded ? " guarded" : "";
const char* unboxed = m_Unboxed ? " unboxed" : "";
if (m_Offset == BAD_IL_OFFSET)
{
printf("%*s[%u IL=???? TR=%06u %08X] [%s%s%s%s%s] %s\n", indent, "", m_Ordinal, m_TreeID, calleeToken,
inlineResult, inlineReason, guarded, devirtualized, unboxed, calleeName);
}
else
{
IL_OFFSET offset = jitGetILoffs(m_Offset);
printf("%*s[%u IL=%04d TR=%06u %08X] [%s%s%s%s%s] %s\n", indent, "", m_Ordinal, offset, m_TreeID,
calleeToken, inlineResult, inlineReason, guarded, devirtualized, unboxed, calleeName);
}
}
// Recurse to first child
if (m_Child != nullptr)
{
m_Child->Dump(indent + 2);
}
}
//------------------------------------------------------------------------
// DumpData: Dump a successful InlineContext entry, detailed data, and
// any successful descendant inlines
//
// Arguments:
// indent - indentation level for this node
void InlineContext::DumpData(unsigned indent)
{
// Handle fact that siblings are in reverse order.
if (m_Sibling != nullptr)
{
m_Sibling->DumpData(indent);
}
Compiler* compiler = m_InlineStrategy->GetCompiler();
#if defined(DEBUG)
const char* calleeName = compiler->eeGetMethodFullName(m_Callee);
#else
const char* calleeName = "callee";
#endif // defined(DEBUG)
if (m_Parent == nullptr)
{
// Root method... cons up a policy so we can display the name
InlinePolicy* policy = InlinePolicy::GetPolicy(compiler, true);
printf("\nInlines [%u] into \"%s\" [%s]\n", m_InlineStrategy->GetInlineCount(), calleeName, policy->GetName());
}
else if (m_Success)
{
const char* inlineReason = InlGetObservationString(m_Observation);
printf("%*s%u,\"%s\",\"%s\",", indent, "", m_Ordinal, inlineReason, calleeName);
m_Policy->DumpData(jitstdout);
printf("\n");
}
// Recurse to first child
if (m_Child != nullptr)
{
m_Child->DumpData(indent + 2);
}
}
//------------------------------------------------------------------------
// DumpXml: Dump an InlineContext entry and all descendants in xml format
//
// Arguments:
// file - file for output
// indent - indentation level for this node
void InlineContext::DumpXml(FILE* file, unsigned indent)
{
// Handle fact that siblings are in reverse order.
if (m_Sibling != nullptr)
{
m_Sibling->DumpXml(file, indent);
}
// Optionally suppress failing inline records
if ((JitConfig.JitInlineDumpXml() == 3) && !m_Success)
{
return;
}
const bool isRoot = m_Parent == nullptr;
const bool hasChild = m_Child != nullptr;
const char* inlineType = m_Success ? "Inline" : "FailedInline";
unsigned newIndent = indent;
if (!isRoot)
{
Compiler* compiler = m_InlineStrategy->GetCompiler();
mdMethodDef calleeToken = compiler->info.compCompHnd->getMethodDefFromMethod(m_Callee);
unsigned calleeHash = compiler->info.compCompHnd->getMethodHash(m_Callee);
const char* inlineReason = InlGetObservationString(m_Observation);
int offset = -1;
if (m_Offset != BAD_IL_OFFSET)
{
offset = (int)jitGetILoffs(m_Offset);
}
fprintf(file, "%*s<%s>\n", indent, "", inlineType);
fprintf(file, "%*s<Token>%u</Token>\n", indent + 2, "", calleeToken);
fprintf(file, "%*s<Hash>%u</Hash>\n", indent + 2, "", calleeHash);
fprintf(file, "%*s<Offset>%u</Offset>\n", indent + 2, "", offset);
fprintf(file, "%*s<Reason>%s</Reason>\n", indent + 2, "", inlineReason);
// Optionally, dump data about the inline
const int dumpDataSetting = JitConfig.JitInlineDumpData();
// JitInlineDumpData=1 -- dump data plus deltas for last inline only
if ((dumpDataSetting == 1) && (this == m_InlineStrategy->GetLastContext()))
{
fprintf(file, "%*s<Data>", indent + 2, "");
m_InlineStrategy->DumpDataContents(file);
fprintf(file, "</Data>\n");
}
// JitInlineDumpData=2 -- dump data for all inlines, no deltas
if ((dumpDataSetting == 2) && (m_Policy != nullptr))
{
fprintf(file, "%*s<Data>", indent + 2, "");
m_Policy->DumpData(file);
fprintf(file, "</Data>\n");
}
newIndent = indent + 2;
}
// Handle children
if (hasChild)
{
fprintf(file, "%*s<Inlines>\n", newIndent, "");
m_Child->DumpXml(file, newIndent + 2);
fprintf(file, "%*s</Inlines>\n", newIndent, "");
}
else
{
fprintf(file, "%*s<Inlines />\n", newIndent, "");
}
// Close out
if (!isRoot)
{
fprintf(file, "%*s</%s>\n", indent, "", inlineType);
}
}
#endif // defined(DEBUG) || defined(INLINE_DATA)
//------------------------------------------------------------------------
// InlineResult: Construct an InlineResult to evaluate a particular call
// for inlining.
//
// Arguments:
// compiler - the compiler instance examining a call for inlining
// call - the call in question
// stmt - statement containing the call (if known)
// description - string describing the context of the decision
InlineResult::InlineResult(Compiler* compiler, GenTreeCall* call, GenTreeStmt* stmt, const char* description)
: m_RootCompiler(nullptr)
, m_Policy(nullptr)
, m_Call(call)
, m_InlineContext(nullptr)
, m_Caller(nullptr)
, m_Callee(nullptr)
, m_Description(description)
, m_Reported(false)
{
// Set the compiler instance
m_RootCompiler = compiler->impInlineRoot();
// Set the policy
const bool isPrejitRoot = false;
m_Policy = InlinePolicy::GetPolicy(m_RootCompiler, isPrejitRoot);
// Pass along some optional information to the policy.
if (stmt != nullptr)
{
m_InlineContext = stmt->gtInlineContext;
m_Policy->NoteContext(m_InlineContext);
#if defined(DEBUG) || defined(INLINE_DATA)
m_Policy->NoteOffset(call->gtRawILOffset);
#else
m_Policy->NoteOffset(stmt->gtStmtILoffsx);
#endif // defined(DEBUG) || defined(INLINE_DATA)
}
// Get method handle for caller. Note we use the
// handle for the "immediate" caller here.
m_Caller = compiler->info.compMethodHnd;
// Get method handle for callee, if known
if (m_Call->gtCall.gtCallType == CT_USER_FUNC)
{
m_Callee = m_Call->gtCall.gtCallMethHnd;
}
}
//------------------------------------------------------------------------
// InlineResult: Construct an InlineResult to evaluate a particular
// method as a possible inline candidate, while prejtting.
//
// Arguments:
// compiler - the compiler instance doing the prejitting
// method - the method in question
// description - string describing the context of the decision
//
// Notes:
// Used only during prejitting to try and pre-identify methods that
// cannot be inlined, to help subsequent jit throughput.
//
// We use the inlCallee member to track the method since logically
// it is the callee here.
InlineResult::InlineResult(Compiler* compiler, CORINFO_METHOD_HANDLE method, const char* description)
: m_RootCompiler(nullptr)
, m_Policy(nullptr)
, m_Call(nullptr)
, m_InlineContext(nullptr)
, m_Caller(nullptr)
, m_Callee(method)
, m_Description(description)
, m_Reported(false)
{
// Set the compiler instance
m_RootCompiler = compiler->impInlineRoot();
// Set the policy
const bool isPrejitRoot = true;
m_Policy = InlinePolicy::GetPolicy(m_RootCompiler, isPrejitRoot);
}
//------------------------------------------------------------------------
// Report: Dump, log, and report information about an inline decision.
//
// Notes:
// Called (automatically via the InlineResult dtor) when the
// inliner is done evaluating a candidate.
//
// Dumps state of the inline candidate, and if a decision was
// reached, sends it to the log and reports the decision back to the
// EE. Optionally update the method attribute to NOINLINE if
// observation and policy warrant.
//
// All this can be suppressed if desired by calling setReported()
// before the InlineResult goes out of scope.
void InlineResult::Report()
{
#ifdef DEBUG
// If this is a failure of a specific inline candidate and we haven't captured
// a failing observation yet, do so now.
if (IsFailure() && (m_Call != nullptr))
{
// compiler should have revoked candidacy on the call by now
assert((m_Call->gtFlags & GTF_CALL_INLINE_CANDIDATE) == 0);
if (m_Call->gtInlineObservation == InlineObservation::CALLEE_UNUSED_INITIAL)
{
m_Call->gtInlineObservation = m_Policy->GetObservation();
}
}
#endif // DEBUG
// If we weren't actually inlining, user may have suppressed
// reporting via setReported(). If so, do nothing.
if (m_Reported)
{
return;
}
m_Reported = true;
#ifdef DEBUG
const char* callee = nullptr;
const bool showInlines = (JitConfig.JitPrintInlinedMethods() == 1);
// Optionally dump the result
if (VERBOSE || showInlines)
{
const char* format = "INLINER: during '%s' result '%s' reason '%s' for '%s' calling '%s'\n";
const char* caller = (m_Caller == nullptr) ? "n/a" : m_RootCompiler->eeGetMethodFullName(m_Caller);
callee = (m_Callee == nullptr) ? "n/a" : m_RootCompiler->eeGetMethodFullName(m_Callee);
JITDUMP(format, m_Description, ResultString(), ReasonString(), caller, callee);
}
#endif // DEBUG
// Was the result NEVER? If so we might want to propagate this to
// the runtime.
if (IsNever() && m_Policy->PropagateNeverToRuntime())
{
// If we know the callee, and if the observation that got us
// to this Never inline state is something *other* than
// IS_NOINLINE, then we've uncovered a reason why this method
// can't ever be inlined. Update the callee method attributes
// so that future inline attempts for this callee fail faster.
InlineObservation obs = m_Policy->GetObservation();
if ((m_Callee != nullptr) && (obs != InlineObservation::CALLEE_IS_NOINLINE))
{
#ifdef DEBUG
const char* obsString = InlGetObservationString(obs);
if (VERBOSE)
{
JITDUMP("\nINLINER: Marking %s as NOINLINE because of %s\n", callee, obsString);
}
if (showInlines)
{
printf("Marking %s as NOINLINE because of %s\n", callee, obsString);
}
#endif // DEBUG
COMP_HANDLE comp = m_RootCompiler->info.compCompHnd;
comp->setMethodAttribs(m_Callee, CORINFO_FLG_BAD_INLINEE);
}
}
if (IsDecided())
{
const char* format = "INLINER: during '%s' result '%s' reason '%s'\n";
JITLOG_THIS(m_RootCompiler, (LL_INFO100000, format, m_Description, ResultString(), ReasonString()));
COMP_HANDLE comp = m_RootCompiler->info.compCompHnd;
comp->reportInliningDecision(m_Caller, m_Callee, Result(), ReasonString());
}
}
//------------------------------------------------------------------------
// InlineStrategy construtor
//
// Arguments
// compiler - root compiler instance
InlineStrategy::InlineStrategy(Compiler* compiler)
: m_Compiler(compiler)
, m_RootContext(nullptr)
, m_LastSuccessfulPolicy(nullptr)
, m_LastContext(nullptr)
, m_PrejitRootDecision(InlineDecision::UNDECIDED)
, m_CallCount(0)
, m_CandidateCount(0)
, m_AlwaysCandidateCount(0)
, m_ForceCandidateCount(0)
, m_DiscretionaryCandidateCount(0)
, m_UnprofitableCandidateCount(0)
, m_ImportCount(0)
, m_InlineCount(0)
, m_MaxInlineSize(DEFAULT_MAX_INLINE_SIZE)
, m_MaxInlineDepth(DEFAULT_MAX_INLINE_DEPTH)
, m_InitialTimeBudget(0)
, m_InitialTimeEstimate(0)
, m_CurrentTimeBudget(0)
, m_CurrentTimeEstimate(0)
, m_InitialSizeEstimate(0)
, m_CurrentSizeEstimate(0)
, m_HasForceViaDiscretionary(false)
#if defined(DEBUG) || defined(INLINE_DATA)
, m_MethodXmlFilePosition(0)
, m_Random(nullptr)
#endif // defined(DEBUG) || defined(INLINE_DATA)
{
// Verify compiler is a root compiler instance
assert(m_Compiler->impInlineRoot() == m_Compiler);
#ifdef DEBUG
// Possibly modify the max inline size.
//
// Default value of JitInlineSize is the same as our default.
// So normally this next line does not change the size.
m_MaxInlineSize = JitConfig.JitInlineSize();
// Up the max size under stress
if (m_Compiler->compInlineStress())
{
m_MaxInlineSize *= 10;
}
// But don't overdo it
if (m_MaxInlineSize > IMPLEMENTATION_MAX_INLINE_SIZE)
{
m_MaxInlineSize = IMPLEMENTATION_MAX_INLINE_SIZE;
}
// Verify: not too small, not too big.
assert(m_MaxInlineSize >= ALWAYS_INLINE_SIZE);
assert(m_MaxInlineSize <= IMPLEMENTATION_MAX_INLINE_SIZE);
// Possibly modify the max inline depth
//
// Default value of JitInlineDepth is the same as our default.
// So normally this next line does not change the size.
m_MaxInlineDepth = JitConfig.JitInlineDepth();
// But don't overdo it
if (m_MaxInlineDepth > IMPLEMENTATION_MAX_INLINE_DEPTH)
{
m_MaxInlineDepth = IMPLEMENTATION_MAX_INLINE_DEPTH;
}
#endif // DEBUG
}
//------------------------------------------------------------------------
// GetRootContext: get the InlineContext for the root method
//
// Return Value:
// Root context; describes the method being jitted.
//
// Note:
// Also initializes the jit time estimate and budget.
InlineContext* InlineStrategy::GetRootContext()
{
if (m_RootContext == nullptr)
{
// Allocate on first demand.
m_RootContext = NewRoot();
// Estimate how long the jit will take if there's no inlining
// done to this method.
m_InitialTimeEstimate = EstimateTime(m_RootContext);
m_CurrentTimeEstimate = m_InitialTimeEstimate;
// Set the initial budget for inlining. Note this is
// deliberately set very high and is intended to catch
// only pathological runaway inline cases.
m_InitialTimeBudget = BUDGET * m_InitialTimeEstimate;
m_CurrentTimeBudget = m_InitialTimeBudget;
// Estimate the code size if there's no inlining
m_InitialSizeEstimate = EstimateSize(m_RootContext);
m_CurrentSizeEstimate = m_InitialSizeEstimate;
// Sanity check
assert(m_CurrentTimeEstimate > 0);
assert(m_CurrentSizeEstimate > 0);
// Cache as the "last" context created
m_LastContext = m_RootContext;
}
return m_RootContext;
}
//------------------------------------------------------------------------
// NoteAttempt: do bookkeeping for an inline attempt
//
// Arguments:
// result -- InlineResult for successful inline candidate
void InlineStrategy::NoteAttempt(InlineResult* result)
{
assert(result->IsCandidate());
InlineObservation obs = result->GetObservation();
if (obs == InlineObservation::CALLEE_BELOW_ALWAYS_INLINE_SIZE)
{
m_AlwaysCandidateCount++;
}
else if (obs == InlineObservation::CALLEE_IS_FORCE_INLINE)
{
m_ForceCandidateCount++;
}
else
{
m_DiscretionaryCandidateCount++;
}
}
//------------------------------------------------------------------------
// DumpCsvHeader: dump header for csv inline stats
//
// Argument:
// fp -- file for dump output
void InlineStrategy::DumpCsvHeader(FILE* fp)
{
fprintf(fp, "\"InlineCalls\",");
fprintf(fp, "\"InlineCandidates\",");
fprintf(fp, "\"InlineAlways\",");
fprintf(fp, "\"InlineForce\",");
fprintf(fp, "\"InlineDiscretionary\",");
fprintf(fp, "\"InlineUnprofitable\",");
fprintf(fp, "\"InlineEarlyFail\",");
fprintf(fp, "\"InlineImport\",");
fprintf(fp, "\"InlineLateFail\",");
fprintf(fp, "\"InlineSuccess\",");
}
//------------------------------------------------------------------------
// DumpCsvData: dump data for csv inline stats
//
// Argument:
// fp -- file for dump output
void InlineStrategy::DumpCsvData(FILE* fp)
{
fprintf(fp, "%u,", m_CallCount);
fprintf(fp, "%u,", m_CandidateCount);
fprintf(fp, "%u,", m_AlwaysCandidateCount);
fprintf(fp, "%u,", m_ForceCandidateCount);
fprintf(fp, "%u,", m_DiscretionaryCandidateCount);
fprintf(fp, "%u,", m_UnprofitableCandidateCount);
// Early failures are cases where candates are rejected between
// the time the jit invokes the inlinee compiler and the time it
// starts to import the inlinee IL.
//
// So they are "cheaper" that late failures.
unsigned profitableCandidateCount = m_DiscretionaryCandidateCount - m_UnprofitableCandidateCount;
unsigned earlyFailCount =
m_CandidateCount - m_AlwaysCandidateCount - m_ForceCandidateCount - profitableCandidateCount;
fprintf(fp, "%u,", earlyFailCount);
unsigned lateFailCount = m_ImportCount - m_InlineCount;
fprintf(fp, "%u,", m_ImportCount);
fprintf(fp, "%u,", lateFailCount);
fprintf(fp, "%u,", m_InlineCount);
}
//------------------------------------------------------------------------
// EstimateTime: estimate impact of this inline on the method jit time
//
// Arguments:
// context - context describing this inline
//
// Return Value:
// Nominal estimate of jit time.
int InlineStrategy::EstimateTime(InlineContext* context)
{
// Simple linear models based on observations
// show time is fairly well predicted by IL size.
unsigned ilSize = context->GetILSize();
// Prediction varies for root and inlines.
if (context == m_RootContext)
{
return EstimateRootTime(ilSize);
}
else
{
return EstimateInlineTime(ilSize);
}
}
//------------------------------------------------------------------------
// EstimteRootTime: estimate jit time for method of this size with
// no inlining.
//
// Arguments:
// ilSize - size of the method's IL
//
// Return Value:
// Nominal estimate of jit time.
//
// Notes:
// Based on observational data. Time is nominally microseconds.
int InlineStrategy::EstimateRootTime(unsigned ilSize)
{
return 60 + 3 * ilSize;
}
//------------------------------------------------------------------------
// EstimteInlineTime: estimate time impact on jitting for an inline
// of this size.
//
// Arguments:
// ilSize - size of the method's IL
//
// Return Value:
// Nominal increase in jit time.
//
// Notes:
// Based on observational data. Time is nominally microseconds.
// Small inlines will make the jit a bit faster.
int InlineStrategy::EstimateInlineTime(unsigned ilSize)
{
return -14 + 2 * ilSize;
}
//------------------------------------------------------------------------
// EstimateSize: estimate impact of this inline on the method size
//
// Arguments:
// context - context describing this inline
//
// Return Value:
// Nominal estimate of method size (bytes * 10)
int InlineStrategy::EstimateSize(InlineContext* context)
{
// Prediction varies for root and inlines.
if (context == m_RootContext)
{
// Simple linear models based on observations show root method
// native code size is fairly well predicted by IL size.
//
// Model below is for x64 on windows.
unsigned ilSize = context->GetILSize();
int estimate = (1312 + 228 * ilSize) / 10;
return estimate;
}
else
{
// Use context's code size estimate.
return context->GetCodeSizeEstimate();
}
}
//------------------------------------------------------------------------
// NoteOutcome: do bookkeeping for an inline
//
// Arguments:
// context - context for the inlie
void InlineStrategy::NoteOutcome(InlineContext* context)
{
// Note we can't generally count up failures here -- we only
// create contexts for failures in debug modes, and even then
// we may not get them all.
if (context->IsSuccess())
{
m_InlineCount++;
#if defined(DEBUG) || defined(INLINE_DATA)
// Keep track of the inline targeted for data collection or,
// if we don't have one (yet), the last successful inline.
bool updateLast = (m_LastSuccessfulPolicy == nullptr) || !m_LastSuccessfulPolicy->IsDataCollectionTarget();
if (updateLast)
{
m_LastContext = context;
m_LastSuccessfulPolicy = context->m_Policy;
}
else
{
// We only expect one inline to be a data collection
// target.
assert(!context->m_Policy->IsDataCollectionTarget());
}
#endif // defined(DEBUG) || defined(INLINE_DATA)
// Budget update.
//
// If callee is a force inline, increase budget, provided all
// parent contexts are likewise force inlines.
//
// If callee is discretionary or has a discretionary ancestor,
// increase expense.
InlineContext* currentContext = context;
bool isForceInline = false;
while (currentContext != m_RootContext)
{
InlineObservation observation = currentContext->GetObservation();
if (observation != InlineObservation::CALLEE_IS_FORCE_INLINE)
{
if (isForceInline)
{
// Interesting case where discretionary inlines pull
// in a force inline...
m_HasForceViaDiscretionary = true;
}
isForceInline = false;
break;
}
isForceInline = true;
currentContext = currentContext->GetParent();
}
int timeDelta = EstimateTime(context);
if (isForceInline)
{
// Update budget since this inline was forced. Only allow
// budget to increase.
if (timeDelta > 0)
{
m_CurrentTimeBudget += timeDelta;
}
}
// Update time estimate.
m_CurrentTimeEstimate += timeDelta;
// Update size estimate.
//
// Sometimes estimates don't make sense. Don't let the method
// size go negative.
int sizeDelta = EstimateSize(context);
if (m_CurrentSizeEstimate + sizeDelta <= 0)
{
sizeDelta = 0;
}
// Update the code size estimate.
m_CurrentSizeEstimate += sizeDelta;
}
}
//------------------------------------------------------------------------
// BudgetCheck: return true if as inline of this size would exceed the
// jit time budget for this method
//
// Arguments:
// ilSize - size of the method's IL
//
// Return Value:
// true if the inline would go over budget
bool InlineStrategy::BudgetCheck(unsigned ilSize)
{
int timeDelta = EstimateInlineTime(ilSize);
return (timeDelta + m_CurrentTimeEstimate > m_CurrentTimeBudget);
}
//------------------------------------------------------------------------
// NewRoot: construct an InlineContext for the root method
//
// Return Value:
// InlineContext for use as the root context
//
// Notes:
// We leave m_Code as nullptr here (rather than the IL buffer
// address of the root method) to preserve existing behavior, which
// is to allow one recursive inline.
InlineContext* InlineStrategy::NewRoot()
{
InlineContext* rootContext = new (m_Compiler, CMK_Inlining) InlineContext(this);
rootContext->m_ILSize = m_Compiler->info.compILCodeSize;
#if defined(DEBUG) || defined(INLINE_DATA)
rootContext->m_Callee = m_Compiler->info.compMethodHnd;
#endif // defined(DEBUG) || defined(INLINE_DATA)
return rootContext;
}
//------------------------------------------------------------------------
// NewSuccess: construct an InlineContext for a successful inline
// and link it into the context tree
//
// Arguments:
// inlineInfo - information about this inline
//
// Return Value:
// A new InlineContext for statements brought into the method by
// this inline.
InlineContext* InlineStrategy::NewSuccess(InlineInfo* inlineInfo)
{
InlineContext* calleeContext = new (m_Compiler, CMK_Inlining) InlineContext(this);
GenTreeStmt* stmt = inlineInfo->iciStmt;
BYTE* calleeIL = inlineInfo->inlineCandidateInfo->methInfo.ILCode;
unsigned calleeILSize = inlineInfo->inlineCandidateInfo->methInfo.ILCodeSize;
InlineContext* parentContext = stmt->gtInlineContext;
GenTreeCall* originalCall = inlineInfo->inlineResult->GetCall();
noway_assert(parentContext != nullptr);
calleeContext->m_Code = calleeIL;
calleeContext->m_ILSize = calleeILSize;
calleeContext->m_Parent = parentContext;
// Push on front here will put siblings in reverse lexical
// order which we undo in the dumper
calleeContext->m_Sibling = parentContext->m_Child;
parentContext->m_Child = calleeContext;
calleeContext->m_Child = nullptr;
calleeContext->m_Offset = stmt->gtStmtILoffsx;
calleeContext->m_Observation = inlineInfo->inlineResult->GetObservation();
calleeContext->m_Success = true;
calleeContext->m_Devirtualized = originalCall->IsDevirtualized();
calleeContext->m_Guarded = originalCall->IsGuarded();
calleeContext->m_Unboxed = originalCall->IsUnboxed();
#if defined(DEBUG) || defined(INLINE_DATA)
InlinePolicy* policy = inlineInfo->inlineResult->GetPolicy();
calleeContext->m_Policy = policy;
calleeContext->m_CodeSizeEstimate = policy->CodeSizeEstimate();
calleeContext->m_Callee = inlineInfo->fncHandle;
// +1 here since we set this before calling NoteOutcome.
calleeContext->m_Ordinal = m_InlineCount + 1;
// Update offset with more accurate info
calleeContext->m_Offset = originalCall->gtRawILOffset;
#endif // defined(DEBUG) || defined(INLINE_DATA)
#if defined(DEBUG)
calleeContext->m_TreeID = originalCall->gtTreeID;
#endif // defined(DEBUG)
NoteOutcome(calleeContext);
return calleeContext;
}
#if defined(DEBUG) || defined(INLINE_DATA)
//------------------------------------------------------------------------
// NewFailure: construct an InlineContext for a failing inline
// and link it into the context tree
//
// Arguments:
// stmt - statement containing the attempted inline
// inlineResult - inlineResult for the attempt
//
// Return Value:
// A new InlineContext for diagnostic purposes
InlineContext* InlineStrategy::NewFailure(GenTreeStmt* stmt, InlineResult* inlineResult)
{
// Check for a parent context first. We should now have a parent
// context for all statements.
InlineContext* parentContext = stmt->gtInlineContext;
assert(parentContext != nullptr);
InlineContext* failedContext = new (m_Compiler, CMK_Inlining) InlineContext(this);
GenTreeCall* originalCall = inlineResult->GetCall();
// Pushing the new context on the front of the parent child list
// will put siblings in reverse lexical order which we undo in the
// dumper.
failedContext->m_Parent = parentContext;
failedContext->m_Sibling = parentContext->m_Child;
parentContext->m_Child = failedContext;
failedContext->m_Child = nullptr;
failedContext->m_Offset = stmt->gtStmtILoffsx;
failedContext->m_Observation = inlineResult->GetObservation();
failedContext->m_Callee = inlineResult->GetCallee();
failedContext->m_Success = false;
failedContext->m_Devirtualized = originalCall->IsDevirtualized();
failedContext->m_Guarded = originalCall->IsGuarded();
failedContext->m_Unboxed = originalCall->IsUnboxed();
assert(InlIsValidObservation(failedContext->m_Observation));
#if defined(DEBUG) || defined(INLINE_DATA)
// Update offset with more accurate info
failedContext->m_Offset = originalCall->gtRawILOffset;
#endif // #if defined(DEBUG) || defined(INLINE_DATA)
#if defined(DEBUG)
failedContext->m_TreeID = originalCall->gtTreeID;
#endif // defined(DEBUG)
NoteOutcome(failedContext);
return failedContext;
}
//------------------------------------------------------------------------
// Dump: dump description of inline behavior
//
// Arguments:
// showBudget - also dump final budget values
void InlineStrategy::Dump(bool showBudget)
{
m_RootContext->Dump();
if (!showBudget)
{
return;
}
printf("Budget: initialTime=%d, finalTime=%d, initialBudget=%d, currentBudget=%d\n", m_InitialTimeEstimate,
m_CurrentTimeEstimate, m_InitialTimeBudget, m_CurrentTimeBudget);
if (m_CurrentTimeBudget > m_InitialTimeBudget)
{
printf("Budget: increased by %d because of force inlines\n", m_CurrentTimeBudget - m_InitialTimeBudget);
}
if (m_CurrentTimeEstimate > m_CurrentTimeBudget)
{
printf("Budget: went over budget by %d\n", m_CurrentTimeEstimate - m_CurrentTimeBudget);
}
if (m_HasForceViaDiscretionary)
{
printf("Budget: discretionary inline caused a force inline\n");
}
printf("Budget: initialSize=%d, finalSize=%d\n", m_InitialSizeEstimate, m_CurrentSizeEstimate);
}
// Static to track emission of the inline data header
bool InlineStrategy::s_HasDumpedDataHeader = false;
//------------------------------------------------------------------------
// DumpData: dump data about the last successful inline into this method
// in a format suitable for automated analysis.
void InlineStrategy::DumpData()
{
// Is dumping enabled? If not, nothing to do.
if (JitConfig.JitInlineDumpData() == 0)
{
return;
}
// If we're also dumping inline XML, we'll let it dump the data.
if (JitConfig.JitInlineDumpXml() != 0)
{
return;
}
// Don't dump anything if limiting is on and we didn't reach
// the limit while inlining.
//
// This serves to filter out duplicate data.
const int limit = JitConfig.JitInlineLimit();
if ((limit >= 0) && (m_InlineCount < static_cast<unsigned>(limit)))
{
return;
}
// Dump header, if not already dumped
if (!s_HasDumpedDataHeader)
{
DumpDataHeader(stderr);
s_HasDumpedDataHeader = true;
}
// Dump contents
DumpDataContents(stderr);
fprintf(stderr, "\n");
}
//------------------------------------------------------------------------
// DumpDataEnsurePolicyIsSet: ensure m_LastSuccessfulPolicy describes the
// inline policy in effect.
//
// Notes:
// Needed for methods that don't have any successful inlines.
void InlineStrategy::DumpDataEnsurePolicyIsSet()
{
// Cache references to compiler substructures.
const Compiler::Info& info = m_Compiler->info;
const Compiler::Options& opts = m_Compiler->opts;
// If there weren't any successful inlines, we won't have a
// successful policy, so fake one up.
if (m_LastSuccessfulPolicy == nullptr)
{
const bool isPrejitRoot = opts.jitFlags->IsSet(JitFlags::JIT_FLAG_PREJIT);
m_LastSuccessfulPolicy = InlinePolicy::GetPolicy(m_Compiler, isPrejitRoot);
// Add in a bit of data....
const bool isForceInline = (info.compFlags & CORINFO_FLG_FORCEINLINE) != 0;
m_LastSuccessfulPolicy->NoteBool(InlineObservation::CALLEE_IS_FORCE_INLINE, isForceInline);
m_LastSuccessfulPolicy->NoteInt(InlineObservation::CALLEE_IL_CODE_SIZE, info.compMethodInfo->ILCodeSize);
}
}
//------------------------------------------------------------------------
// DumpDataHeader: dump header for inline data.
//
// Arguments:
// file - file for data output
void InlineStrategy::DumpDataHeader(FILE* file)
{
DumpDataEnsurePolicyIsSet();
const int limit = JitConfig.JitInlineLimit();
fprintf(file, "*** Inline Data: Policy=%s JitInlineLimit=%d ***\n", m_LastSuccessfulPolicy->GetName(), limit);
DumpDataSchema(file);
fprintf(file, "\n");
}
//------------------------------------------------------------------------
// DumpSchema: dump schema for inline data.
//
// Arguments:
// file - file for data output
void InlineStrategy::DumpDataSchema(FILE* file)
{
DumpDataEnsurePolicyIsSet();
fprintf(file, "Method,Version,HotSize,ColdSize,JitTime,SizeEstimate,TimeEstimate,");
m_LastSuccessfulPolicy->DumpSchema(file);
}
//------------------------------------------------------------------------
// DumpDataContents: dump contents of inline data
//
// Arguments:
// file - file for data output
void InlineStrategy::DumpDataContents(FILE* file)
{
DumpDataEnsurePolicyIsSet();
// Cache references to compiler substructures.
const Compiler::Info& info = m_Compiler->info;
const Compiler::Options& opts = m_Compiler->opts;
// We'd really like the method identifier to be unique and
// durable across crossgen invocations. Not clear how to
// accomplish this, so we'll use the token for now.
//
// Post processing will have to filter out all data from
// methods where the root entry appears multiple times.
mdMethodDef currentMethodToken = info.compCompHnd->getMethodDefFromMethod(info.compMethodHnd);
// Convert time spent jitting into microseconds
unsigned microsecondsSpentJitting = 0;
unsigned __int64 compCycles = m_Compiler->getInlineCycleCount();
if (compCycles > 0)
{
double countsPerSec = CycleTimer::CyclesPerSecond();
double counts = (double)compCycles;
microsecondsSpentJitting = (unsigned)((counts / countsPerSec) * 1000 * 1000);
}
fprintf(file, "%08X,%u,%u,%u,%u,%d,%d,", currentMethodToken, m_InlineCount, info.compTotalHotCodeSize,
info.compTotalColdCodeSize, microsecondsSpentJitting, m_CurrentSizeEstimate / 10, m_CurrentTimeEstimate);
m_LastSuccessfulPolicy->DumpData(file);
}
// Static to track emission of the xml data header
// and lock to prevent interleaved file writes
bool InlineStrategy::s_HasDumpedXmlHeader = false;
CritSecObject InlineStrategy::s_XmlWriterLock;
//------------------------------------------------------------------------
// DumpXml: dump xml-formatted version of the inline tree.
//
// Arguments
// file - file for data output
// indent - indent level of this element
void InlineStrategy::DumpXml(FILE* file, unsigned indent)
{
if (JitConfig.JitInlineDumpXml() == 0)
{
return;
}
// Lock to prevent interleaving of trees.
CritSecHolder writeLock(s_XmlWriterLock);
// Dump header
if (!s_HasDumpedXmlHeader)
{
DumpDataEnsurePolicyIsSet();
fprintf(file, "<?xml version=\"1.0\"?>\n");
fprintf(file, "<InlineForest>\n");
fprintf(file, "<Policy>%s</Policy>\n", m_LastSuccessfulPolicy->GetName());
const int dumpDataSetting = JitConfig.JitInlineDumpData();
if (dumpDataSetting != 0)
{
fprintf(file, "<DataSchema>");
if (dumpDataSetting == 1)
{
// JitInlineDumpData=1 -- dump schema for data plus deltas
DumpDataSchema(file);
}
else if (dumpDataSetting == 2)
{
// JitInlineDumpData=2 -- dump schema for data only
m_LastSuccessfulPolicy->DumpSchema(file);
}
fprintf(file, "</DataSchema>\n");
}
fprintf(file, "<Methods>\n");
s_HasDumpedXmlHeader = true;
}
// If we're dumping "minimal" Xml, and we didn't do
// any inlines into this method, then there's nothing
// to emit here.
if ((m_InlineCount == 0) && (JitConfig.JitInlineDumpXml() >= 2))
{
return;
}
// Cache references to compiler substructures.
const Compiler::Info& info = m_Compiler->info;
const Compiler::Options& opts = m_Compiler->opts;
const bool isPrejitRoot = opts.jitFlags->IsSet(JitFlags::JIT_FLAG_PREJIT);
const bool isForceInline = (info.compFlags & CORINFO_FLG_FORCEINLINE) != 0;
// We'd really like the method identifier to be unique and
// durable across crossgen invocations. Not clear how to
// accomplish this, so we'll use the token for now.
//
// Post processing will have to filter out all data from
// methods where the root entry appears multiple times.
mdMethodDef currentMethodToken = info.compCompHnd->getMethodDefFromMethod(info.compMethodHnd);
unsigned hash = info.compMethodHash();
// Convert time spent jitting into microseconds
unsigned microsecondsSpentJitting = 0;
unsigned __int64 compCycles = m_Compiler->getInlineCycleCount();
if (compCycles > 0)
{
double countsPerSec = CycleTimer::CyclesPerSecond();
double counts = (double)compCycles;
microsecondsSpentJitting = (unsigned)((counts / countsPerSec) * 1000 * 1000);
}
// Get method name just for root method, to make it a bit easier
// to search for things in the inline xml.
const char* methodName = info.compCompHnd->getMethodName(info.compMethodHnd, nullptr);
// Cheap xml quoting for values. Only < and & are troublemakers,
// but change > for symmetry.
//
// Ok to truncate name, just ensure it's null terminated.
char buf[64];
strncpy(buf, methodName, sizeof(buf));
buf[sizeof(buf) - 1] = 0;
for (int i = 0; i < _countof(buf); i++)
{
switch (buf[i])
{
case '<':
buf[i] = '[';
break;
case '>':
buf[i] = ']';
break;
case '&':
buf[i] = '#';
break;
default:
break;
}
}
fprintf(file, "%*s<Method>\n", indent, "");
fprintf(file, "%*s<Token>%u</Token>\n", indent + 2, "", currentMethodToken);
fprintf(file, "%*s<Hash>%u</Hash>\n", indent + 2, "", hash);
fprintf(file, "%*s<Name>%s</Name>\n", indent + 2, "", buf);
fprintf(file, "%*s<InlineCount>%u</InlineCount>\n", indent + 2, "", m_InlineCount);
fprintf(file, "%*s<HotSize>%u</HotSize>\n", indent + 2, "", info.compTotalHotCodeSize);
fprintf(file, "%*s<ColdSize>%u</ColdSize>\n", indent + 2, "", info.compTotalColdCodeSize);
fprintf(file, "%*s<JitTime>%u</JitTime>\n", indent + 2, "", microsecondsSpentJitting);
fprintf(file, "%*s<SizeEstimate>%u</SizeEstimate>\n", indent + 2, "", m_CurrentSizeEstimate / 10);
fprintf(file, "%*s<TimeEstimate>%u</TimeEstimate>\n", indent + 2, "", m_CurrentTimeEstimate);
// For prejit roots also propagate out the assessment of the root method
if (isPrejitRoot)
{
fprintf(file, "%*s<PrejitDecision>%s</PrejitDecision>\n", indent + 2, "",
InlGetDecisionString(m_PrejitRootDecision));
fprintf(file, "%*s<PrejitObservation>%s</PrejitObservation>\n", indent + 2, "",
InlGetObservationString(m_PrejitRootObservation));
}
// Root context will be null if we're not optimizing the method.
//
// Note there are cases of this in mscorlib even in release builds,
// eg Task.NotifyDebuggerOfWaitCompletion.
//
// For such methods there aren't any inlines.
if (m_RootContext != nullptr)
{
m_RootContext->DumpXml(file, indent + 2);
}
else
{
fprintf(file, "%*s<Inlines/>\n", indent + 2, "");
}
fprintf(file, "%*s</Method>\n", indent, "");
}
//------------------------------------------------------------------------
// FinalizeXml: finalize the xml-formatted version of the inline tree.
//
// Arguments
// file - file for data output
void InlineStrategy::FinalizeXml(FILE* file)
{
// If we dumped the header, dump a footer
if (s_HasDumpedXmlHeader)
{
fprintf(file, "</Methods>\n");
fprintf(file, "</InlineForest>\n");
fflush(file);
// Workaroud compShutdown getting called twice.
s_HasDumpedXmlHeader = false;
}
// Finalize reading inline xml
ReplayPolicy::FinalizeXml();
}
//------------------------------------------------------------------------
// GetRandom: setup or access random state
//
// Return Value:
// New or pre-existing random state.
//
// Notes:
// Random state is kept per jit compilation request. Seed is partially
// specified externally (via stress or policy setting) and partially
// specified internally via method hash.
CLRRandom* InlineStrategy::GetRandom()
{
if (m_Random == nullptr)
{
int externalSeed = 0;
#ifdef DEBUG
if (m_Compiler->compRandomInlineStress())
{
externalSeed = getJitStressLevel();
}
#endif // DEBUG
int randomPolicyFlag = JitConfig.JitInlinePolicyRandom();
if (randomPolicyFlag != 0)
{
externalSeed = randomPolicyFlag;
}
int internalSeed = m_Compiler->info.compMethodHash();
assert(externalSeed != 0);
assert(internalSeed != 0);
int seed = externalSeed ^ internalSeed;
m_Random = new (m_Compiler, CMK_Inlining) CLRRandom();
m_Random->Init(seed);
}
return m_Random;
}
#endif // defined(DEBUG) || defined(INLINE_DATA)
//------------------------------------------------------------------------
// IsNoInline: allow strategy to disable inlining in a method
//
// Arguments:
// info -- compiler interface from the EE
// method -- handle for the root method
//
// Notes:
// Only will return true in debug or special release builds.
// Expects JitNoInlineRange to be set to the hashes of methods
// where inlining is disabled.
bool InlineStrategy::IsNoInline(ICorJitInfo* info, CORINFO_METHOD_HANDLE method)
{
#if defined(DEBUG) || defined(INLINE_DATA)
static ConfigMethodRange range;
const wchar_t* noInlineRange = JitConfig.JitNoInlineRange();
if (noInlineRange == nullptr)
{
return false;
}
// If we have a config string we have at least one entry. Count
// number of spaces in our config string to see if there are
// more. Number of ranges we need is 2x that value.
unsigned entryCount = 1;
for (const wchar_t* p = noInlineRange; *p != 0; p++)
{
if (*p == L' ')
{
entryCount++;
}
}
range.EnsureInit(noInlineRange, 2 * entryCount);
assert(!range.Error());
return range.Contains(info, method);
#else
return false;
#endif // defined(DEBUG) || defined(INLINE_DATA)
}
|