-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
promotion.cpp
3031 lines (2667 loc) · 99.6 KB
/
promotion.cpp
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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#include "jitpch.h"
#include "promotion.h"
#include "jitstd/algorithm.h"
//------------------------------------------------------------------------
// PhysicalPromotion: Promote structs based on primitive access patterns.
//
// Returns:
// Suitable phase status.
//
PhaseStatus Compiler::PhysicalPromotion()
{
if (!opts.OptEnabled(CLFLG_STRUCTPROMOTE))
{
return PhaseStatus::MODIFIED_NOTHING;
}
if (fgNoStructPromotion)
{
return PhaseStatus::MODIFIED_NOTHING;
}
if ((JitConfig.JitEnablePhysicalPromotion() == 0) && !compStressCompile(STRESS_PHYSICAL_PROMOTION, 25))
{
return PhaseStatus::MODIFIED_NOTHING;
}
#ifdef DEBUG
static ConfigMethodRange s_range;
s_range.EnsureInit(JitConfig.JitEnablePhysicalPromotionRange());
if (!s_range.Contains(info.compMethodHash()))
{
return PhaseStatus::MODIFIED_NOTHING;
}
#endif
Promotion prom(this);
return prom.Run();
}
// Represents an access into a struct local.
struct Access
{
ClassLayout* Layout;
unsigned Offset;
var_types AccessType;
// Number of times we saw the access.
unsigned Count = 0;
// Number of times this is stored from the result of a call. This includes
// being passed as the retbuf. These stores cannot be decomposed and are
// handled via readback.
unsigned CountStoredFromCall = 0;
// Number of times this is passed as a call arg. We insert writebacks
// before these.
unsigned CountCallArgs = 0;
weight_t CountWtd = 0;
weight_t CountStoredFromCallWtd = 0;
weight_t CountCallArgsWtd = 0;
#ifdef DEBUG
// Number of times this access is the source of a store.
unsigned CountStoreSource = 0;
// Number of times this access is the destination of a store.
unsigned CountStoreDestination = 0;
unsigned CountReturns = 0;
// Number of times this is stored by being passed as the retbuf.
// These stores need a readback
unsigned CountPassedAsRetbuf = 0;
weight_t CountStoreSourceWtd = 0;
weight_t CountStoreDestinationWtd = 0;
weight_t CountReturnsWtd = 0;
weight_t CountPassedAsRetbufWtd = 0;
#endif
Access(unsigned offset, var_types accessType, ClassLayout* layout)
: Layout(layout), Offset(offset), AccessType(accessType)
{
}
unsigned GetAccessSize() const
{
return AccessType == TYP_STRUCT ? Layout->GetSize() : genTypeSize(AccessType);
}
bool Overlaps(unsigned otherStart, unsigned otherSize) const
{
unsigned end = Offset + GetAccessSize();
if (end <= otherStart)
{
return false;
}
unsigned otherEnd = otherStart + otherSize;
if (otherEnd <= Offset)
{
return false;
}
return true;
}
};
enum class AccessKindFlags : uint32_t
{
None = 0,
IsCallArg = 1,
IsStoredFromCall = 2,
IsCallRetBuf = 4,
#ifdef DEBUG
IsStoreSource = 8,
IsStoreDestination = 16,
IsReturned = 32,
#endif
};
inline constexpr AccessKindFlags operator~(AccessKindFlags a)
{
return (AccessKindFlags)(~(uint32_t)a);
}
inline constexpr AccessKindFlags operator|(AccessKindFlags a, AccessKindFlags b)
{
return (AccessKindFlags)((uint32_t)a | (uint32_t)b);
}
inline constexpr AccessKindFlags operator&(AccessKindFlags a, AccessKindFlags b)
{
return (AccessKindFlags)((uint32_t)a & (uint32_t)b);
}
inline AccessKindFlags& operator|=(AccessKindFlags& a, AccessKindFlags b)
{
return a = (AccessKindFlags)((uint32_t)a | (uint32_t)b);
}
inline AccessKindFlags& operator&=(AccessKindFlags& a, AccessKindFlags b)
{
return a = (AccessKindFlags)((uint32_t)a & (uint32_t)b);
}
//------------------------------------------------------------------------
// OverlappingReplacements:
// Find replacements that overlap the specified [offset..offset+size) interval.
//
// Parameters:
// offset - Starting offset of interval
// size - Size of interval
// firstReplacement - [out] The first replacement that overlaps
// endReplacement - [out, optional] One past the last replacement that overlaps
//
// Returns:
// True if any replacement overlaps; otherwise false.
//
bool AggregateInfo::OverlappingReplacements(unsigned offset,
unsigned size,
Replacement** firstReplacement,
Replacement** endReplacement)
{
size_t firstIndex = Promotion::BinarySearch<Replacement, &Replacement::Offset>(Replacements, offset);
if ((ssize_t)firstIndex < 0)
{
firstIndex = ~firstIndex;
if (firstIndex > 0)
{
Replacement& lastRepBefore = Replacements[firstIndex - 1];
if ((lastRepBefore.Offset + genTypeSize(lastRepBefore.AccessType)) > offset)
{
// Overlap with last entry starting before offs.
firstIndex--;
}
else if (firstIndex >= Replacements.size())
{
// Starts after last replacement ends.
return false;
}
}
const Replacement& first = Replacements[firstIndex];
if (first.Offset >= (offset + size))
{
// First candidate starts after this ends.
return false;
}
}
assert((firstIndex < Replacements.size()) && Replacements[firstIndex].Overlaps(offset, size));
*firstReplacement = &Replacements[firstIndex];
if (endReplacement != nullptr)
{
size_t lastIndex = Promotion::BinarySearch<Replacement, &Replacement::Offset>(Replacements, offset + size);
if ((ssize_t)lastIndex < 0)
{
lastIndex = ~lastIndex;
}
// Since we verified above that there is an overlapping replacement
// we know that lastIndex exists and is the next one that does not
// overlap.
assert(lastIndex > 0);
*endReplacement = Replacements.data() + lastIndex;
}
return true;
}
//------------------------------------------------------------------------
// AggregateInfoMap::AggregateInfoMap:
// Construct a map that maps locals to AggregateInfo.
//
// Parameters:
// allocator - The allocator
// numLocals - Number of locals to support in the map
//
AggregateInfoMap::AggregateInfoMap(CompAllocator allocator, unsigned numLocals)
: m_aggregates(allocator), m_numLocals(numLocals)
{
m_lclNumToAggregateIndex = new (allocator) unsigned[numLocals];
for (unsigned i = 0; i < numLocals; i++)
{
m_lclNumToAggregateIndex[i] = UINT_MAX;
}
}
//------------------------------------------------------------------------
// AggregateInfoMap::Add:
// Add information about a physically promoted aggregate to the map.
//
// Parameters:
// agg - The entry to add
//
void AggregateInfoMap::Add(AggregateInfo* agg)
{
assert(agg->LclNum < m_numLocals);
assert(m_lclNumToAggregateIndex[agg->LclNum] == UINT_MAX);
m_lclNumToAggregateIndex[agg->LclNum] = static_cast<unsigned>(m_aggregates.size());
m_aggregates.push_back(agg);
}
//------------------------------------------------------------------------
// AggregateInfoMap::Lookup:
// Lookup the promotion information for a local.
//
// Parameters:
// lclNum - The local number
//
// Returns:
// Pointer to the aggregate information, or nullptr if the local is not
// physically promoted.
//
AggregateInfo* AggregateInfoMap::Lookup(unsigned lclNum)
{
assert(lclNum < m_numLocals);
unsigned index = m_lclNumToAggregateIndex[lclNum];
if (index == UINT_MAX)
{
return nullptr;
}
assert(m_aggregates.size() > index);
return m_aggregates[index];
}
struct PrimitiveAccess
{
unsigned Count = 0;
weight_t CountWtd = 0;
unsigned Offset;
var_types AccessType;
PrimitiveAccess(unsigned offset, var_types accessType) : Offset(offset), AccessType(accessType)
{
}
};
// Tracks all the accesses into one particular struct local.
class LocalUses
{
jitstd::vector<Access> m_accesses;
jitstd::vector<PrimitiveAccess> m_inducedAccesses;
public:
LocalUses(Compiler* comp)
: m_accesses(comp->getAllocator(CMK_Promotion)), m_inducedAccesses(comp->getAllocator(CMK_Promotion))
{
}
//------------------------------------------------------------------------
// RecordAccess:
// Record an access into this local with the specified offset and access type.
//
// Parameters:
// offs - The offset being accessed
// accessType - The type of the access
// accessLayout - The layout of the access, for accessType == TYP_STRUCT
// flags - Flags classifying the access
// weight - Weight of the block containing the access
//
void RecordAccess(
unsigned offs, var_types accessType, ClassLayout* accessLayout, AccessKindFlags flags, weight_t weight)
{
Access* access = nullptr;
size_t index = 0;
if (m_accesses.size() > 0)
{
index = Promotion::BinarySearch<Access, &Access::Offset>(m_accesses, offs);
if ((ssize_t)index >= 0)
{
do
{
Access& candidateAccess = m_accesses[index];
if ((candidateAccess.AccessType == accessType) && (candidateAccess.Layout == accessLayout))
{
access = &candidateAccess;
break;
}
index++;
} while (index < m_accesses.size() && m_accesses[index].Offset == offs);
}
else
{
index = ~index;
}
}
if (access == nullptr)
{
access = &*m_accesses.insert(m_accesses.begin() + index, Access(offs, accessType, accessLayout));
}
access->Count++;
access->CountWtd += weight;
if ((flags & AccessKindFlags::IsCallArg) != AccessKindFlags::None)
{
access->CountCallArgs++;
access->CountCallArgsWtd += weight;
}
if ((flags & (AccessKindFlags::IsStoredFromCall | AccessKindFlags::IsCallRetBuf)) != AccessKindFlags::None)
{
access->CountStoredFromCall++;
access->CountStoredFromCallWtd += weight;
}
#ifdef DEBUG
if ((flags & AccessKindFlags::IsCallRetBuf) != AccessKindFlags::None)
{
access->CountPassedAsRetbuf++;
access->CountPassedAsRetbufWtd += weight;
}
if ((flags & AccessKindFlags::IsStoreSource) != AccessKindFlags::None)
{
access->CountStoreSource++;
access->CountStoreSourceWtd += weight;
}
if ((flags & AccessKindFlags::IsStoreDestination) != AccessKindFlags::None)
{
access->CountStoreDestination++;
access->CountStoreDestinationWtd += weight;
}
if ((flags & AccessKindFlags::IsReturned) != AccessKindFlags::None)
{
access->CountReturns++;
access->CountReturnsWtd += weight;
}
#endif
}
//------------------------------------------------------------------------
// RecordInducedAccess:
// Record an induced access into this local with the specified offset and access type.
//
// Parameters:
// offs - The offset being accessed
// accessType - The type of the access
// weight - Weight of the block containing the access
//
// Remarks:
// Induced accesses are accesses that are induced by physical promotion
// due to store decompositon. They are always of primitive type.
//
void RecordInducedAccess(unsigned offs, var_types accessType, weight_t weight)
{
PrimitiveAccess* access = nullptr;
size_t index = 0;
if (m_inducedAccesses.size() > 0)
{
index = Promotion::BinarySearch<PrimitiveAccess, &PrimitiveAccess::Offset>(m_inducedAccesses, offs);
if ((ssize_t)index >= 0)
{
do
{
PrimitiveAccess& candidateAccess = m_inducedAccesses[index];
if (candidateAccess.AccessType == accessType)
{
access = &candidateAccess;
break;
}
index++;
} while (index < m_inducedAccesses.size() && m_inducedAccesses[index].Offset == offs);
}
else
{
index = ~index;
}
}
if (access == nullptr)
{
access = &*m_inducedAccesses.insert(m_inducedAccesses.begin() + index, PrimitiveAccess(offs, accessType));
}
access->Count++;
access->CountWtd += weight;
}
//------------------------------------------------------------------------
// PickPromotions:
// Pick specific replacements to make for this struct local after a set
// of accesses have been recorded.
//
// Parameters:
// comp - Compiler instance
// lclNum - Local num for this struct local
// aggregates - Map to add aggregate information into if promotion was done
//
// Returns:
// Number of promotions picked. If above 0, an entry was added to aggregates.
//
int PickPromotions(Compiler* comp, unsigned lclNum, AggregateInfoMap& aggregates)
{
if (m_accesses.size() <= 0)
{
return 0;
}
JITDUMP("Picking promotions for V%02u\n", lclNum);
AggregateInfo* agg = nullptr;
int numReps = 0;
for (size_t i = 0; i < m_accesses.size(); i++)
{
const Access& access = m_accesses[i];
if (access.AccessType == TYP_STRUCT)
{
continue;
}
if (!EvaluateReplacement(comp, lclNum, access, 0, 0))
{
continue;
}
if (agg == nullptr)
{
agg = new (comp, CMK_Promotion) AggregateInfo(comp->getAllocator(CMK_Promotion), lclNum);
aggregates.Add(agg);
}
agg->Replacements.push_back(Replacement(access.Offset, access.AccessType));
numReps++;
if (agg->Replacements.size() >= PHYSICAL_PROMOTION_MAX_PROMOTIONS_PER_STRUCT)
{
JITDUMP(" Promoted %zu fields in V%02u; will not promote more\n", agg->Replacements.size(),
agg->LclNum);
break;
}
}
JITDUMP("\n");
return numReps;
}
//------------------------------------------------------------------------
// PickInducedPromotions:
// Pick additional promotions to make based on the fact that some
// accesses will be induced by store decomposition.
//
// Parameters:
// comp - Compiler instance
// lclNum - Local num for this struct local
// aggregates - Map for aggregate information
//
// Returns:
// Number of new promotions.
//
int PickInducedPromotions(Compiler* comp, unsigned lclNum, AggregateInfoMap& aggregates)
{
if (m_inducedAccesses.size() <= 0)
{
return 0;
}
AggregateInfo* agg = aggregates.Lookup(lclNum);
if ((agg != nullptr) && (agg->Replacements.size() >= PHYSICAL_PROMOTION_MAX_PROMOTIONS_PER_STRUCT))
{
return 0;
}
int numReps = 0;
JITDUMP("Picking induced promotions for V%02u\n", lclNum);
for (PrimitiveAccess& inducedAccess : m_inducedAccesses)
{
bool overlapsOtherInducedAccess = false;
for (PrimitiveAccess& otherInducedAccess : m_inducedAccesses)
{
if (&otherInducedAccess == &inducedAccess)
{
continue;
}
if (inducedAccess.Offset + genTypeSize(inducedAccess.AccessType) <= otherInducedAccess.Offset)
{
break;
}
if (otherInducedAccess.Offset + genTypeSize(otherInducedAccess.AccessType) <= inducedAccess.Offset)
{
continue;
}
overlapsOtherInducedAccess = true;
break;
}
if (overlapsOtherInducedAccess)
{
continue;
}
Access* access = FindAccess(inducedAccess.Offset, inducedAccess.AccessType);
if (access == nullptr)
{
Access fakeAccess(inducedAccess.Offset, inducedAccess.AccessType, nullptr);
if (!EvaluateReplacement(comp, lclNum, fakeAccess, inducedAccess.Count, inducedAccess.CountWtd))
{
continue;
}
}
else
{
if (!EvaluateReplacement(comp, lclNum, *access, inducedAccess.Count, inducedAccess.CountWtd))
{
continue;
}
}
if (agg == nullptr)
{
agg = new (comp, CMK_Promotion) AggregateInfo(comp->getAllocator(CMK_Promotion), lclNum);
aggregates.Add(agg);
}
size_t insertionIndex;
if (agg->Replacements.size() > 0)
{
#ifdef DEBUG
Replacement* overlapRep;
assert(!agg->OverlappingReplacements(inducedAccess.Offset, genTypeSize(inducedAccess.AccessType),
&overlapRep, nullptr));
#endif
insertionIndex =
Promotion::BinarySearch<Replacement, &Replacement::Offset>(agg->Replacements, inducedAccess.Offset);
assert((ssize_t)insertionIndex < 0);
insertionIndex = ~insertionIndex;
}
else
{
insertionIndex = 0;
}
agg->Replacements.insert(agg->Replacements.begin() + insertionIndex,
Replacement(inducedAccess.Offset, inducedAccess.AccessType));
numReps++;
if (agg->Replacements.size() >= PHYSICAL_PROMOTION_MAX_PROMOTIONS_PER_STRUCT)
{
JITDUMP(" Promoted %zu fields in V%02u; will not promote more\n", agg->Replacements.size());
break;
}
}
return numReps;
}
//------------------------------------------------------------------------
// EvaluateReplacement:
// Evaluate legality and profitability of a single replacement candidate.
//
// Parameters:
// comp - Compiler instance
// lclNum - Local num for this struct local
// access - Access information for the candidate.
// inducedCountWtd - Additional weighted count due to induced accesses.
//
// Returns:
// True if we should promote this access and create a replacement; otherwise false.
//
bool EvaluateReplacement(
Compiler* comp, unsigned lclNum, const Access& access, unsigned inducedCount, weight_t inducedCountWtd)
{
// Verify that this replacement has proper GC ness compared to the
// layout. While reinterpreting GC fields to integers can be considered
// UB, there are scenarios where it can happen safely:
//
// * The user code could have guarded the access with a dynamic check
// that it doesn't contain a GC pointer, so that the access is actually
// in dead code. This happens e.g. in span functions in SPC.
//
// * For byrefs, reinterpreting as an integer could be ok in a
// restricted scope due to pinning.
//
// In theory we could allow these promotions in the restricted scope,
// but currently physical promotion works on a function-wide basis.
LclVarDsc* lcl = comp->lvaGetDesc(lclNum);
ClassLayout* layout = lcl->GetLayout();
if (layout->IntersectsGCPtr(access.Offset, genTypeSize(access.AccessType)))
{
if (((access.Offset % TARGET_POINTER_SIZE) != 0) ||
(layout->GetGCPtrType(access.Offset / TARGET_POINTER_SIZE) != access.AccessType))
{
return false;
}
}
else
{
if (varTypeIsGC(access.AccessType))
{
return false;
}
}
unsigned countOverlappedCallArg = 0;
unsigned countOverlappedStoredFromCall = 0;
weight_t countOverlappedCallArgWtd = 0;
weight_t countOverlappedStoredFromCallWtd = 0;
bool overlap = false;
for (const Access& otherAccess : m_accesses)
{
if (&otherAccess == &access)
{
continue;
}
if (!otherAccess.Overlaps(access.Offset, genTypeSize(access.AccessType)))
{
continue;
}
if (otherAccess.AccessType != TYP_STRUCT)
{
return false;
}
countOverlappedCallArg += otherAccess.CountCallArgs;
countOverlappedStoredFromCall += otherAccess.CountStoredFromCall;
countOverlappedCallArgWtd += otherAccess.CountCallArgsWtd;
countOverlappedStoredFromCallWtd += otherAccess.CountStoredFromCallWtd;
}
// We cost any normal access (which is a struct load or store) without promotion at 3 cycles.
const weight_t COST_STRUCT_ACCESS_CYCLES = 3;
// And at 4 bytes size
const weight_t COST_STRUCT_ACCESS_SIZE = 4;
weight_t costWithout = 0;
weight_t sizeWithout = 0;
costWithout += (access.CountWtd + inducedCountWtd) * COST_STRUCT_ACCESS_CYCLES;
sizeWithout += (access.Count + inducedCount) * COST_STRUCT_ACCESS_SIZE;
weight_t costWith = 0;
weight_t sizeWith = 0;
// For promoted accesses we expect these to turn into reg-reg movs (and in many cases be fully contained in the
// parent).
// We cost these at 0.5 cycles.
const weight_t COST_REG_ACCESS_CYCLES = 0.5;
// And 2 byte size
const weight_t COST_REG_ACCESS_SIZE = 2;
costWith += (access.CountWtd + inducedCountWtd) * COST_REG_ACCESS_CYCLES;
sizeWith += (access.Count + inducedCount) * COST_REG_ACCESS_SIZE;
// Now look at the overlapping struct uses that promotion will make more expensive.
unsigned countReadBacks = 0;
weight_t countReadBacksWtd = 0;
// For parameters or OSR locals we always need one read back.
if (lcl->lvIsParam || lcl->lvIsOSRLocal)
{
countReadBacks++;
countReadBacksWtd += comp->fgFirstBB->getBBWeight(comp);
}
// If the struct is stored from a call (either due to a multireg
// return or by being passed as the retbuffer) then we need a readback
// after.
//
// In the future we could allow multireg returns without a readback by
// a sort of forward substitution optimization in the backend.
countReadBacksWtd += countOverlappedStoredFromCallWtd;
countReadBacks += countOverlappedStoredFromCall;
// A readback turns into a stack load.
costWith += countReadBacksWtd * COST_STRUCT_ACCESS_CYCLES;
sizeWith += countReadBacks * COST_STRUCT_ACCESS_SIZE;
// Write backs with TYP_REFs when the base local is an implicit byref
// involves checked write barriers, so they are very expensive. We cost that at 10 cycles.
const weight_t COST_WRITEBARRIER_CYCLES = 10;
const weight_t COST_WRITEBARRIER_SIZE = 10;
// TODO-CQ: This should be adjusted once we type implicit byrefs as TYP_I_IMPL.
// Otherwise we cost it like a store to stack at 3 cycles.
weight_t writeBackCost = comp->lvaIsImplicitByRefLocal(lclNum) && (access.AccessType == TYP_REF)
? COST_WRITEBARRIER_CYCLES
: COST_STRUCT_ACCESS_CYCLES;
weight_t writeBackSize = comp->lvaIsImplicitByRefLocal(lclNum) && (access.AccessType == TYP_REF)
? COST_WRITEBARRIER_SIZE
: COST_STRUCT_ACCESS_SIZE;
// We write back before an overlapping struct use passed as an arg.
// TODO-CQ: A store-forwarding optimization in lowering could get rid
// of these copies; however, it requires lowering to be able to prove
// that not writing the fields into the struct local is ok.
//
// Note: Technically we also introduce writebacks before returns that
// we could account for, however the returns we see during physical
// promotion are only for structs returned in registers and in most
// cases the writeback introduced means we can eliminate an earlier
// "natural" writeback, balancing out the cost.
// Thus _not_ accounting for these is a CQ improvements.
// (Additionally, if it weren't we could teach the backend some
// store-forwarding/forward sub to make the write backs "free".)
weight_t countWriteBacksWtd = countOverlappedCallArgWtd;
unsigned countWriteBacks = countOverlappedCallArg;
costWith += countWriteBacksWtd * writeBackCost;
sizeWith += countWriteBacks * writeBackSize;
// Overlapping stores are decomposable so we don't cost them as
// being more expensive than their unpromoted counterparts (i.e. we
// don't consider them at all). However, we should do something more
// clever here, since:
// * We may still end up writing the full remainder as part of the
// decomposed store, in which case all the field writes are just
// added code size/perf cost.
// * Even if we don't, decomposing a single struct write into many
// field writes is not necessarily profitable (e.g. 16 byte field
// stores vs 1 XMM load/store).
//
// TODO-CQ: This ends up being a combinatorial optimization problem. We
// need to take a more "whole-struct" view here and look at sets of
// fields we are promoting together, evaluating all of them at once in
// comparison with the covering struct uses. This will also allow us to
// give a bonus to promoting remainders that may not have scalar uses
// but will allow fully decomposing stores away.
weight_t cycleImprovementPerInvoc = (costWithout - costWith) / comp->fgFirstBB->getBBWeight(comp);
weight_t sizeImprovement = sizeWithout - sizeWith;
JITDUMP(" Evaluating access %s @ %03u\n", varTypeName(access.AccessType), access.Offset);
JITDUMP(" Single write-back cost: " FMT_WT "\n", writeBackCost);
JITDUMP(" Write backs: " FMT_WT "\n", countWriteBacksWtd);
JITDUMP(" Read backs: " FMT_WT "\n", countReadBacksWtd);
JITDUMP(" Estimated cycle improvement: " FMT_WT " cycles per invocation\n", cycleImprovementPerInvoc);
JITDUMP(" Estimated size improvement: " FMT_WT " bytes\n", sizeImprovement);
// We allow X bytes of code size regressions for every cycle of
// estimated improvement. Note that generally both estimates agree on
// whether promotion is an improvement or regression, so this is really
// only for rare cases where we have many call arg uses in rarely
// executed blocks.
const weight_t ALLOWED_SIZE_REGRESSION_PER_CYCLE_IMPROVEMENT = 2;
if ((cycleImprovementPerInvoc > 0) &&
((cycleImprovementPerInvoc * ALLOWED_SIZE_REGRESSION_PER_CYCLE_IMPROVEMENT) >= -sizeImprovement))
{
JITDUMP(" Promoting replacement (cycle improvement)\n\n");
return true;
}
// Similarly, even for a cycle-wise regression, if we see a large size
// wise improvement we may want to promote. The main case is where all
// uses are in blocks with bbWeight=0, but we still estimate a
// size-wise improvement.
const weight_t ALLOWED_CYCLE_REGRESSION_PER_SIZE_IMPROVEMENT = 0.01;
if ((sizeImprovement > 0) &&
((sizeImprovement * ALLOWED_CYCLE_REGRESSION_PER_SIZE_IMPROVEMENT) >= -cycleImprovementPerInvoc))
{
JITDUMP(" Promoting replacement (size improvement)\n\n");
return true;
}
#ifdef DEBUG
if (comp->compStressCompile(Compiler::STRESS_PHYSICAL_PROMOTION_COST, 25))
{
JITDUMP(" Promoting replacement (stress)\n\n");
return true;
}
#endif
JITDUMP(" Disqualifying replacement\n\n");
return false;
}
//------------------------------------------------------------------------
// ClearInducedAccesses:
// Clear the stored induced access metrics.
//
void ClearInducedAccesses()
{
m_inducedAccesses.clear();
}
#ifdef DEBUG
//------------------------------------------------------------------------
// DumpAccesses:
// Dump the stored access metrics for a specified local.
//
// Parameters:
// lclNum - The local
//
void DumpAccesses(unsigned lclNum)
{
if (m_accesses.size() <= 0)
{
return;
}
printf("Accesses for V%02u\n", lclNum);
for (Access& access : m_accesses)
{
if (access.AccessType == TYP_STRUCT)
{
printf(" [%03u..%03u) as %s\n", access.Offset, access.Offset + access.Layout->GetSize(),
access.Layout->GetClassName());
}
else
{
printf(" %s @ %03u\n", varTypeName(access.AccessType), access.Offset);
}
printf(" #: (%u, " FMT_WT ")\n", access.Count, access.CountWtd);
printf(" # store source: (%u, " FMT_WT ")\n", access.CountStoreSource,
access.CountStoreSourceWtd);
printf(" # store destination: (%u, " FMT_WT ")\n", access.CountStoreDestination,
access.CountStoreDestinationWtd);
printf(" # as call arg: (%u, " FMT_WT ")\n", access.CountCallArgs,
access.CountCallArgsWtd);
printf(" # as retbuf: (%u, " FMT_WT ")\n", access.CountPassedAsRetbuf,
access.CountPassedAsRetbufWtd);
printf(" # as returned value: (%u, " FMT_WT ")\n\n", access.CountReturns,
access.CountReturnsWtd);
}
}
//------------------------------------------------------------------------
// DumpInducedAccesses:
// Dump induced accesses for a specified struct local.
//
// Parameters:
// lclNum - The local
//
void DumpInducedAccesses(unsigned lclNum)
{
if (m_inducedAccesses.size() <= 0)
{
return;
}
printf("Induced accesses for V%02u\n", lclNum);
for (PrimitiveAccess& access : m_inducedAccesses)
{
printf(" %s @ %03u\n", varTypeName(access.AccessType), access.Offset);
printf(" #: (%u, " FMT_WT ")\n", access.Count, access.CountWtd);
}
}
#endif
private:
//------------------------------------------------------------------------
// FindAccess:
// Find access metrics information for the specified offset and access type.
//
// Parameters:
// offs - The offset
// accessType - Access type
//
// Returns:
// Pointer to a matching access, or nullptr if no match was found.
//
Access* FindAccess(unsigned offs, var_types accessType)
{
if (m_accesses.size() <= 0)
{
return nullptr;
}
size_t index = Promotion::BinarySearch<Access, &Access::Offset>(m_accesses, offs);
if ((ssize_t)index < 0)
{
return nullptr;
}
do
{
Access& candidateAccess = m_accesses[index];
if (candidateAccess.AccessType == accessType)
{
return &candidateAccess;
}
index++;
} while ((index < m_accesses.size()) && (m_accesses[index].Offset == offs));
return nullptr;
}
};
// Struct used to save all struct stores involving physical promotion candidates.
// These stores can induce new field accesses as part of store decomposition.
struct CandidateStore
{
GenTreeLclVarCommon* Store;
BasicBlock* Block;
};
// Visitor that records information about uses of struct locals.
class LocalsUseVisitor : public GenTreeVisitor<LocalsUseVisitor>
{
Promotion* m_prom;
LocalUses** m_uses;
BasicBlock* m_curBB = nullptr;
ArrayStack<CandidateStore> m_candidateStores;
public:
enum
{
DoPreOrder = true,
ComputeStack = true,
};
LocalsUseVisitor(Promotion* prom)
: GenTreeVisitor(prom->m_compiler)
, m_prom(prom)
, m_candidateStores(prom->m_compiler->getAllocator(CMK_Promotion))
{
m_uses = new (prom->m_compiler, CMK_Promotion) LocalUses*[prom->m_compiler->lvaCount]{};
}
//------------------------------------------------------------------------
// SetBB:
// Set current BB we are visiting. Used to get BB weights for access costing.
//
// Parameters:
// bb - The current basic block.
//
void SetBB(BasicBlock* bb)
{
m_curBB = bb;
}
//------------------------------------------------------------------------
// PreOrderVisit:
// Visit a node in preorder and add its use information to the metrics.
//
// Parameters:
// use - The use edge
// user - The user
//
// Returns:
// Visitor result